diff --git a/.azure-pipelines/BranchProtectionForPrivateRepo.yml b/.azure-pipelines/BranchProtectionForPrivateRepo.yml index 7c913b101274..a826a8ecf271 100644 --- a/.azure-pipelines/BranchProtectionForPrivateRepo.yml +++ b/.azure-pipelines/BranchProtectionForPrivateRepo.yml @@ -2,7 +2,7 @@ jobs: - job: "BranchProtectionForPrivateRepo" pool: vmImage: 'Ubuntu 16.04' - condition: and(variables['PRIVATE'], eq(variables['System.PullRequest.TargetBranch'], 'master')) + condition: and(variables['PRIVATE'], eq(variables['System.PullRequest.TargetBranch'], 'main')) steps: - script: '>&2 echo "the branch is protected"' failOnStderr: true diff --git a/.azure-pipelines/PrettierCheck.yml b/.azure-pipelines/PrettierCheck.yml deleted file mode 100644 index 6880699cf0c2..000000000000 --- a/.azure-pipelines/PrettierCheck.yml +++ /dev/null @@ -1,14 +0,0 @@ -jobs: -- job: "PrettierCheck" - variables: - NODE_OPTIONS: '--max-old-space-size=8192' - pool: - vmImage: 'Ubuntu 18.04' - continueOnError: true - steps: - - task: Npm@1 - displayName: 'npm install' - inputs: - verbose: false - - script: 'npm run prettier-check' - displayName: 'Run Prettier Check' \ No newline at end of file diff --git a/.azure-pipelines/SDKAutomation.yml b/.azure-pipelines/SDKAutomation.yml deleted file mode 100644 index 982a0fd77d77..000000000000 --- a/.azure-pipelines/SDKAutomation.yml +++ /dev/null @@ -1,94 +0,0 @@ -trigger: - batch: false - branches: - include: - - master - -pr: - autoCancel: false - -variables: - IMAGE: azopenapi.azurecr.io/openapi/sdk-automation:prod - REGISTRY_ENDPOINT: azopenapi-registry - -jobs: -- job: "SDKAutomation" - displayName: SDK - pool: - vmImage: 'Ubuntu 18.04' - timeoutInMinutes: 180 - - variables: - NODE_OPTIONS: '--max-old-space-size=8192' - SPEC_REPO: $(Build.Repository.Name) - PR_NUMBER: $(System.PullRequest.PullRequestNumber) - BUILD_ID: $(Build.BuildId) - strategy: - matrix: - Net: - SDK_REPO_NAME: azure-sdk-for-net - Java: - SDK_REPO_NAME: azure-sdk-for-java - JavaScript: - SDK_REPO_NAME: azure-sdk-for-js - Python: - SDK_REPO_NAME: azure-sdk-for-python - PythonT2: - SDK_REPO_NAME: azure-sdk-for-python-track2 - Cliextension: - SDK_REPO_NAME: azure-cli-extensions - Go: - SDK_REPO_NAME: azure-sdk-for-go - Trenton: - SDK_REPO_NAME: azure-sdk-for-trenton - Schema: - SDK_REPO_NAME: azure-resource-manager-schemas - steps: - - checkout: none - - script: | - curl \ - -s https://api.github.com/repos/$(Build.Repository.Name)/commits/$(Build.SourceVersion)/pulls \ - -H "Accept: application/vnd.github.groot-preview+json" \ - | python3 -c "import sys,json; a=json.load(sys.stdin); print(f'##vso[task.setvariable variable=PR_NUMBER]{a[0][\"number\"]}' if len(a)>0 and a[0][\"base\"][\"ref\"]=='master' else '##vso[task.logissue type=error]Last commit $(Build.SourceVersion) doesnot have a related PR')" - displayName: Get PR_NUMBER - condition: in(variables['Build.Reason'], 'IndividualCI', 'Manual') - - task: Docker@2 - displayName: Login into ACR - inputs: - command: login - containerRegistry: $(REGISTRY_ENDPOINT) - - script: | - docker pull $IMAGE - docker tag $IMAGE sdk-automation:latest - displayName: Pull SDK Automation Image - - script: | - docker run \ - -e BLOB_PROXY_PREFIX \ - -e BLOB_STORAGE_PREFIX \ - -e BLOB_STORAGE_IS_PUBLIC \ - -e BLOB_DOWNLOAD_COMMAND \ - -e BLOB_STORAGE_NAME \ - -e BLOB_STORAGE_KEY \ - -e GITHUB_COMMENT_AUTHOR_NAME \ - -e GITHUBAPP_ID \ - -e GITHUBAPP_PRIVATE_KEY \ - -e NODE_OPTIONS \ - -e SPEC_REPO \ - -e PR_NUMBER \ - -e SDK_REPO_NAME \ - -e AZURE_DEVOPS_EXT_PAT \ - -e BUILD_ID \ - sdk-automation:latest npm start - condition: or(ne(variables['SDK_REPO_NAME'], 'azure-resource-manager-schemas'), endsWith(variables['SPEC_REPO'], '/azure-rest-api-specs')) - env: - BLOB_STORAGE_NAME: $(blob-storage-name) - BLOB_STORAGE_KEY: $(blob-storage-key) - BLOB_STORAGE_PREFIX: $(blob-storage-prefix) - BLOB_PROXY_PREFIX: $(blob-proxy-prefix) - BLOB_STORAGE_IS_PUBLIC: $(blob-is-public) - BLOB_DOWNLOAD_COMMAND: $(blob-download-command) - GITHUB_COMMENT_AUTHOR_NAME: $(github-comment-author-name) - GITHUBAPP_ID: $(githubapp-id) - GITHUBAPP_PRIVATE_KEY: $(githubapp-private-key) - AZURE_DEVOPS_EXT_PAT: $(azure-devops-ext-pat) - displayName: SDK Automation diff --git a/.azure-pipelines/ShouldSendPRToMain.yml b/.azure-pipelines/ShouldSendPRToMain.yml new file mode 100644 index 000000000000..d139949faeb0 --- /dev/null +++ b/.azure-pipelines/ShouldSendPRToMain.yml @@ -0,0 +1,8 @@ +jobs: + - job: "ShouldSendPRToMain" + pool: + vmImage: 'Ubuntu 16.04' + condition: eq(variables['System.PullRequest.TargetBranch'], 'master') + steps: + - script: '>&2 echo "##vso[task.logissue type=error]Please edit the pull request to targeting new default branch main"' + failOnStderr: true diff --git a/.azure-pipelines/Spellcheck.yml b/.azure-pipelines/Spellcheck.yml deleted file mode 100644 index 4adb4fc0c266..000000000000 --- a/.azure-pipelines/Spellcheck.yml +++ /dev/null @@ -1,14 +0,0 @@ -jobs: -- job: "Spellcheck" - variables: - NODE_OPTIONS: '--max-old-space-size=8192' - pool: - vmImage: 'Ubuntu 16.04' - continueOnError: true - steps: - - task: Npm@1 - displayName: 'npm install' - inputs: - verbose: false - - script: 'npm run spellcheck' - displayName: 'Run cSpell' \ No newline at end of file diff --git a/.azure-pipelines/Syntax.yml b/.azure-pipelines/Syntax.yml deleted file mode 100644 index dfa882935203..000000000000 --- a/.azure-pipelines/Syntax.yml +++ /dev/null @@ -1,20 +0,0 @@ -jobs: -- job: "Syntax" - pool: - vmImage: 'Ubuntu 16.04' - steps: - - script: | - echo TRAVIS: $(TRAVIS) - echo TRAVIS_BRANCH: $(TRAVIS_BRANCH) - echo TRAVIS_REPO_SLUG: $(TRAVIS_REPO_SLUG) - echo TRAVIS_PULL_REQUEST: $(TRAVIS_PULL_REQUEST) - echo TRAVIS_PULL_REQUEST_SLUG: $(TRAVIS_PULL_REQUEST_SLUG) - echo TRAVIS_PULL_REQUEST_SHA: $(TRAVIS_PULL_REQUEST_SHA) - echo PR_ONLY: $(PR_ONLY) - displayName: "Info" - - task: Npm@1 - displayName: 'npm install' - inputs: - verbose: false - - script: 'npm test -- test/syntax.js' - displayName: 'Syntax validation' \ No newline at end of file diff --git a/.azure-pipelines/azure-pipelines-data-container.yml b/.azure-pipelines/azure-pipelines-data-container.yml index ea76cc6346d7..78a12603fcf6 100644 --- a/.azure-pipelines/azure-pipelines-data-container.yml +++ b/.azure-pipelines/azure-pipelines-data-container.yml @@ -3,7 +3,7 @@ schedules: displayName: Daily build branches: include: - - master + - main always: true pool: diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index fdc860dfdab7..0e3d5a7e270d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,16 +2,16 @@ ### Changelog -Please ensure to add changelog with this PR by answering the following questions. - 1. What's the purpose of the update? - - [ ] new service onboarding - - [ ] new API version - - [ ] update existing version for new feature +Add a changelog entry for this PR by answering the following questions: + 1. What's the purpose of the update? + - [ ] new service onboarding + - [ ] new API version + - [ ] update existing version for new feature - [ ] update existing version to fix swagger quality issue in s360 - - [ ] Other, please clarify - 2. When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet. - 3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet. - 4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published. + - [ ] Other, please clarify + 2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month. + 3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. + 4. If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the swagger is published. - [ ] SDK of .NET (need service team to ensure code readiness) - [ ] SDK of Python - [ ] SDK of Java @@ -20,7 +20,7 @@ Please ensure to add changelog with this PR by answering the following questions - [ ] PowerShell - [ ] CLI - [ ] Terraform - - [ ] No, no need to refresh for updates in this PR + - [ ] No refresh required for updates in this PR ### Contribution checklist: - [ ] I commit to follow the [Breaking Change Policy](http://aka.ms/bcforapi) of "no breaking changes" @@ -29,24 +29,32 @@ Please ensure to add changelog with this PR by answering the following questions If any further question about AME onboarding or validation tools, please view the [FAQ](https://aka.ms/faqinprreview). -### ARM API Review Checklist -- [ ] Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review. +### ARM API Review Checklist + +> **Applicability**: :warning: +> +> If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review. +> - Change to data plane APIs +> - Adding new properties +> - All removals + +Otherwise your PR may be subject to ARM review requirements. Complete the following: +- [ ] Check this box if any of the following apply to the PR so that label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest. + - Adding a new service - Adding new API(s) - Adding a new API version - - [ ] Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently. - - Adding a new service + -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit (including refactoring) and then push new changes, including version updates, in separate commits. -- [ ] Please ensure you've reviewed following [guidelines](https://aka.ms/rpguidelines) including [ARM resource provider contract](https://github.com/Azure/azure-resource-manager-rpc) and [REST guidelines](https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md). Estimated time (4 hours). This is required before you can request review from ARM API Review board. +- [ ] Ensure you've reviewed following [guidelines](https://aka.ms/rpguidelines) including [ARM resource provider contract](https://github.com/Azure/azure-resource-manager-rpc) and [REST guidelines](https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md). Estimated time (4 hours). This is required before you can request review from ARM API Review board. - [ ] If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (*RP Manifest Approvers* team under Azure Resource Manager service) from IcM and reach out to them. ### Breaking Change Review Checklist -If there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the [Breaking Change Policy](http://aka.ms/bcforapi). - -- [ ] Removing API(s) in stable version -- [ ] Removing properties in stable version -- [ ] Removing API version(s) in stable version -- [ ] Updating API in stable or public preview version with Breaking Change Validation errors +If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the [Breaking Change Policy](http://aka.ms/bcforapi). +- [ ] Removing API(s) in a stable version +- [ ] Removing properties in a stable version +- [ ] Removing API version(s) in a stable version +- [ ] Updating API in a stable or public preview version with Breaking Change Validation errors - [ ] Updating API(s) in public preview over 1 year (refer to [Retirement of Previews](https://dev.azure.com/msazure/AzureWiki/_wiki/wikis/AzureWiki.wiki/37683/Retirement-of-Previews)) **Action**: to initiate an evaluation of the breaking change, create a new intake using the [template for breaking changes](https://aka.ms/Breakingchangetemplate). Addition details on the process and office hours are on the [Breaking change Wiki](https://dev.azure.com/msazure/AzureWiki/_wiki/wikis/AzureWiki.wiki/37684/Breaking-Changes). diff --git a/.github/comment.yml b/.github/comment.yml index f52e39452a82..c7c59bc9409d 100644 --- a/.github/comment.yml +++ b/.github/comment.yml @@ -6,7 +6,7 @@ booleanFilterExpression: "!(ARMSignedOff||ARMChangesRequested||Approved-OkToMerge||WaitForARMRevisit)" onCheckedLabels: - WaitForARMFeedback - onCheckedComments: "Hi, @${PRAuthor} your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @${PRAssignee} " + onCheckedComments: "Hi, @${PRAuthor} your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com)." - rule: type: label diff --git a/.github/issue_assignment.yml b/.github/issue_assignment.yml index db9ce6dfd4a2..f794ce633f5c 100644 --- a/.github/issue_assignment.yml +++ b/.github/issue_assignment.yml @@ -2,7 +2,6 @@ - rule: booleanFilterExpression: "needs-triage" assignees: - - PhoenixHe-msft - raych1 - akning-ms - leni-msft diff --git a/.github/pull_request_assignment.yml b/.github/pull_request_assignment.yml index b6481d867be4..4e2b968803f0 100644 --- a/.github/pull_request_assignment.yml +++ b/.github/pull_request_assignment.yml @@ -128,12 +128,6 @@ reviewers: - fengzhou-msft -- rule: - paths: - - "specification/@(containerservice|containerinstance)/**" - reviewers: - - PhoenixHe-msft - - rule: paths: - "specification/mixedreality/**" @@ -141,24 +135,12 @@ reviewers: - leni-msft -- rule: - paths: - - "specification/portal/**" - reviewers: - - PhoenixHe-msft - - rule: paths: - "specification/web/**" reviewers: - weidongxu-microsoft -- rule: - paths: - - "specification/testbase/**" - reviewers: - - PhoenixHe-msft - - rule: paths: - "specification/servicelinker/**" @@ -188,7 +170,6 @@ - ".azure-pipelines-preproduction/**" reviewers: - akning-ms - - PhoenixHe-msft - raych1 - zhenglaizhang @@ -197,7 +178,6 @@ paths: - "**" reviewers: - - PhoenixHe-msft - lirenhe - weidongxu-microsoft - ArcturusZhang @@ -208,3 +188,6 @@ - jianyexi - zhenglaizhang - chunyu3 + - changlong-liu + - msyyc + - qwordy diff --git a/CODEOWNERS b/CODEOWNERS index 6c01da6ca27e..b9c15db2b517 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -8,7 +8,7 @@ /specification/authorization/ @darshanhs90 @stankovski /specification/automation/ @vrdmr /specification/azsadmin/ @deathly809 -/specification/batch/ @matthchr @xingwu1 +/specification/batch/ @paterasMSFT @dpwatrous /specification/batchai/ @alexanderyukhanov /specification/billing/ @wilcobmsft @asarkar84 /specification/cdn/ @csmengwan @injyzarif @prakharsharma10 @@ -62,7 +62,7 @@ /specification/relay/ @sethmanheim @v-ajnava /specification/resources/ @Azure/arm-template-deployments @rajshah11 @vivsriaus /specification/scheduler/ @pinwang81 -/specification/search/data-plane/ @brjohnstmsft @arv100kri @bleroy @heaths @AlexGhiondea @Mohit-Chakraborty +/specification/search/data-plane/ @brjohnstmsft @arv100kri @bleroy @AlexGhiondea @Mohit-Chakraborty /specification/search/resource-manager/ @abhi1509 @tjacobhi /specification/serialconsole/ @amitchat @craigw @asinn826 /specification/service-map/ @daveirwin1 diff --git a/arm-compute/quickstart-templates/aliases.json b/arm-compute/quickstart-templates/aliases.json index 5d5b1214d514..4c2100de1db4 100644 --- a/arm-compute/quickstart-templates/aliases.json +++ b/arm-compute/quickstart-templates/aliases.json @@ -15,18 +15,18 @@ "sku": "7.5", "version": "latest" }, - "CoreOS": { - "publisher": "CoreOS", - "offer": "CoreOS", - "sku": "Stable", - "version": "latest" - }, "Debian": { "publisher": "Debian", "offer": "debian-10", "sku": "10", "version": "latest" }, + "Flatcar": { + "publisher": "kinvolk", + "offer": "flatcar-container-linux-free", + "sku": "stable", + "version": "latest" + }, "openSUSE-Leap": { "publisher": "SUSE", "offer": "openSUSE-Leap", diff --git a/azure-pipelines.yml b/azure-pipelines.yml index 4a4db2fa538b..96faf6d58c8a 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -19,7 +19,4 @@ variables: jobs: - template: .azure-pipelines/BranchProtectionForPrivateRepo.yml -- template: .azure-pipelines/Syntax.yml -- template: .azure-pipelines/NetworkValidation.yml -- template: .azure-pipelines/Spellcheck.yml -- template: .azure-pipelines/PrettierCheck.yml +- template: .azure-pipelines/ShouldSendPRToMain.yml \ No newline at end of file diff --git a/cSpell.json b/cSpell.json index 8c55c0f311b5..9a95be8b2983 100644 --- a/cSpell.json +++ b/cSpell.json @@ -39,7 +39,7 @@ "softwareTerms", "typescript" ], - "overrides": [ + "overrides": [ { "filename": "**/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/databox.json", "words": [ @@ -70,6 +70,12 @@ "Tera" ] }, + { + "filename": "**/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/databox.json", + "words": [ + "Tera" + ] + }, { "filename": "**/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/Rules.json", "words": [ @@ -762,6 +768,14 @@ "Fpushpins" ] }, + { + "filename": "**/specification/maps/data-plane/Render/preview/1.0/render.json", + "words": [ + "Chttp", + "Fcontoso", + "Fpushpins" + ] + }, { "filename": "**/specification/communication/data-plane/Chat/preview/2020-09-21-preview2/communicationserviceschat.json", "words": [ diff --git a/custom-words.txt b/custom-words.txt index 21d328170955..cfe6420bea89 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -46,6 +46,7 @@ affinitized AFRINIC agentpool aggregatedcost +Agri AHUB AIAPI Akamai @@ -55,6 +56,7 @@ alertrule alertrules alertsmanagement alertstate +alibaba Alexa Algo allowlist @@ -137,6 +139,7 @@ asciifolding Asns aspnet assessmentprojects +Associable Asturian asyncinfo asyncoperation @@ -290,6 +293,7 @@ BYOK BYOL BYOS bzip +byoa cacerts calculatebaseline canadacentral @@ -552,6 +556,11 @@ dewpoint dhcp diagnosticcontext diarization +DICOM +Dicom +dicom +dicomservice +dicomservices digitaltwins DIMM Directline @@ -566,6 +575,7 @@ diskoperations Distcp Distro dllpath +DMSDB DMTS Dnat dnsname @@ -681,6 +691,10 @@ featurized Featurizer feedbacktype FHIR +fhirdestination +fhirdestinations +fhirservice +fhirservices filegroup filepath fileserver @@ -701,6 +715,7 @@ FPGA fqdn FQDNs Français +freebsd freeflow frontdoor fsaction @@ -790,6 +805,7 @@ Haag haase Había hadoop +HADR hana hanaonazure Hani @@ -826,6 +842,7 @@ hotpatching HSLA HSMs Hubspot +Hugepages hybridconnection hybriddata hybriddatamanager @@ -849,6 +866,7 @@ IDRG IKEV ilearner iloveyou +illumos IMAGEBUILDER Imagelist imagelists @@ -886,6 +904,8 @@ INVALIDARG IOPS IOSMAM iotcentral +iotconnector +iotconnectors iotdps iothub iothubprovisioningservices @@ -908,6 +928,7 @@ isdirectory isfolder ishostingenvironmentnameavailable ishostnameavailable +isIdentityCertExprired isnullable isochrone isordered @@ -931,6 +952,7 @@ jobschedule jobscheduler jobschedules johnc +JOHNDEERE johnsmith JSONLD Jtoken @@ -1060,6 +1082,7 @@ machinelearningcompute machinelearningexperimentation machinelearningservices machinewithhints +madvise Magadan Magento maintenancewindows @@ -1090,6 +1113,7 @@ maxmemory maxpagesize maxresults MAXSIZE +maxzoom mbaldwin Mbps MCAS @@ -1107,6 +1131,7 @@ Metastores Metric's metricdefinitions metricmetadata +metricname metricnames metricnamespace metricsadvisor @@ -1124,11 +1149,14 @@ minidump minimalmetadata ministamps Minkowski +mipsle +minzoom mixedreality Mkdirs mktorest ML's mlapi +mlFlowTrackingUri mnist modelmanagement modifiedtime @@ -1205,8 +1233,11 @@ nchar ndjson ndvi NDVI +ndwi +NDWI Neighbourhood netapp +netbsd netdev Netdev netezza @@ -1215,6 +1246,7 @@ Netfilter networkruleset networkrulesets networkstatus +networktraversal networkwatcher newpassword newrelapp @@ -1260,6 +1292,7 @@ nsxt ntext ntfs ntlm +numa numrecords nvarchar Nynorsk @@ -1288,6 +1321,7 @@ onpremises oobe Oozie openapi +openbsd opencode opencontainers openid @@ -1358,6 +1392,7 @@ phraselist phraselists Pids pipelineruns +piqd PITR pixelated pkcs @@ -1427,6 +1462,7 @@ provisioningservices provisioningState Psec PSNR +pstn ptrdname publicipaddresses publicpreview @@ -1467,6 +1503,7 @@ RAGZRS randint Rankable rasterize +rasterized ratelimit ravbhatnagar rawwebsockets @@ -1586,6 +1623,7 @@ rhel RIRs rmem Rmem +rmpl Rolledback Rollforward rollouts @@ -1593,6 +1631,7 @@ rolloverdetails rootfs rosettanetprocessconfigurations rotatediskencryptionkey +rotationpolicy routable routingendpointhealth rpki @@ -1691,6 +1730,7 @@ sfhealthid sfpkg shamir_share shapefile +shapefiles sharded sharedkey sharename @@ -1743,6 +1783,8 @@ southcentralus southeastasia southindia sparkconf +sparkconfiguration +sparkconfigurations sparkr sparql SPDX @@ -1804,6 +1846,7 @@ streamingendpoint streamingjobs streamingservice subcause +subcode subcomponent subcomponents subdir @@ -1904,8 +1947,12 @@ textanalytics TFIDF Tful Tfvc +tilejson tileset tilesets +timeasc +timedesc +timedout timeframe timegrain timeseries @@ -1966,6 +2013,7 @@ Undeleting unencrypted unexamined unhide +unhold Unigrams uniqueidentifier uniquestring @@ -2108,6 +2156,8 @@ Walser WANAs WANs WASB +wasm +Wasm watchlist Watchlist watchlists @@ -2199,6 +2249,7 @@ Unparented scanrulesets Ruleset Rulesets +Ruleproperties XLSB Miti DOCM @@ -2207,3 +2258,4 @@ PPTM XLSM DOCM multislot +Tebibytes diff --git a/documentation/ci-fix.md b/documentation/ci-fix.md index 5380826c32c4..6b6cf99fd4d0 100644 --- a/documentation/ci-fix.md +++ b/documentation/ci-fix.md @@ -49,18 +49,29 @@ Or you can run it in [OpenAPI Hub](https://portal.azure-devex-tools.com/tools/st Refer to [Semantic and Model Violations Reference](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/Semantic-and-Model-Violations-Reference.md) for detailed description of validations and how-to-fix guidance. ## Breaking Change Check +- An API contract is identified by its api-version value. Once published, no changes to this API contract are allowed. This applies regardless of whether the API contract is for private preview, public preview, or GA (stable). + - The same-version breaking change linter rules check for changes to an existing api-version swagger. +- When introducing a new API contract (preview or not), the new API contract must be backwards compatible with the previous GA’s API contract. + - However, during a (private or public) preview cycle, a new preview API contract does not have to be backwards compatible with the previous preview API contract although it must still be backwards compatible with the latest GA API contract. + - The cross version breaking change linter rules checks for this by comparing the new swagger with the latest GA swagger. If there is no latest GA swagger, then the latest preview if it > 1 year old. If nether a GA or preview > 1 year old exists, then the swagger is considered good. +### adding label on PR automatically +The breaking change check has two types of violations: one is breaking change in the same version but not breaking change in a new version, the other is breaking change even in a new version. +For the former, a label 'NewApiVersionRequired' will be added automatically; For the latter , a label 'BreakingChangeReviewRequired' will be added automatically. Adding each label will trigger a github comment with guildance on how to fix. + +### run locally run oad locally (the breaking change is reported by oad tool): ``` -npm install -g oad +npm install -g @azure/oad oad compare ``` Please see [readme](https://github.com/Azure/openapi-diff/blob/master/README.md) for how to install or run tool in details. Or you can run it in [OpenAPI Hub](https://portal.azure-devex-tools.com/tools/diff). -Refer to [Oad Docs](https://github.com/Azure/openapi-diff/tree/master/docs) for detailed description of all oad rules and how-to-fix guidance. +Refer to [Oad Docs](https://github.com/Azure/openapi-diff/tree/master/docs) for detailed description of all oad rules. -## Linter Validation +## Linter Diff Validation +The lint diff validation is to run linter against the currect spec and the spec before current PR , the final result is the differece set between the result running against current specs and the result running against the specs before current PR. ### Run linter locally: #### Prerequisites: @@ -75,7 +86,6 @@ autorest --validation --azure-validator --use=@microsoft.azure/classic-openapi-v autorest --validation --azure-validator --use=@microsoft.azure/classic-openapi-validator@latest --use=@microsoft.azure/openapi-validator@latest [--tag=] ``` -### Document Please see [readme](https://github.com/Azure/azure-openapi-validator/blob/master/README.md) for how to install or run tool in details. Or you can run it in [OpenAPI Hub](https://portal.azure-devex-tools.com/tools/linter). Refer to [openapi-authoring-automated-guidelines](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/openapi-authoring-automated-guidelines.md) for detailed description of all lint rules and how-to-fix guidance. diff --git a/documentation/openapi-authoring-automated-guidelines.md b/documentation/openapi-authoring-automated-guidelines.md index 039bfe8cc913..69305028536d 100644 --- a/documentation/openapi-authoring-automated-guidelines.md +++ b/documentation/openapi-authoring-automated-guidelines.md @@ -46,8 +46,6 @@ We request OpenAPI(Swagger) spec authoring be assigned to engineers who have an | [R3030](#R3030) | [PathResourceProviderMatchNamespace](#R3030) | ARM OpenAPI(swagger) specs | | [R2016](#r2016) | [PatchBodyParametersSchema](#r2016) | ARM and Data plane OpenAPI(swagger) specs | | [R2062](#r2062) | [XmsResourceInPutResponse](#r2062) | ARM OpenAPI(swagger) specs | -| [R3027](#r3027) | [TrackedResourceListByResourceGroup](#r3027) | ARM OpenAPI(swagger) specs | -| [R3028](#r3028) | [TrackedResourceListBySubscription](#r3028) | ARM OpenAPI(swagger) specs | | [R3011](#r3011) | [DescriptionMustNotBeNodeName](#r3011) | ARM and Data plane OpenAPI(swagger) specs | | [R2020](#r2020) | [RequiredPropertiesMissingInResourceModel](#r2020) | ARM OpenAPI(swagger) specs | | [R3020](#r3020) | [PathResourceProviderNamePascalCase](#r3020) | ARM OpenAPI(swagger) specs | @@ -71,6 +69,8 @@ We request OpenAPI(Swagger) spec authoring be assigned to engineers who have an | [R3017](#r3017) | [GuidUsage](#r3017) | ARM and Data plane OpenAPI(swagger) specs | | [R2057](#r2057) | [InvalidSkuModel](#r2057) | ARM OpenAPI(swagger) specs | | [R3010](#r3010) | [TrackedResourceListByImmediateParent](#r3010) | ARM OpenAPI(swagger) specs | +| [R3027](#r3027) | [TrackedResourceListByResourceGroup](#r3027) | ARM OpenAPI(swagger) specs | +| [R3028](#r3028) | [TrackedResourceListBySubscription](#r3028) | ARM OpenAPI(swagger) specs | | [R2004](#r2004) | [NonApplicationJsonType](#r2004) | ARM OpenAPI(swagger) specs | | [R4014](#r4014) | [AllResourcesMustHaveGetOperation](#r4014) | ARM OpenAPI(swagger) specs | ### SDK Violations @@ -116,7 +116,7 @@ We request OpenAPI(Swagger) spec authoring be assigned to engineers who have an | [R4034](#r4034) | [AzureResourceTagsSchemaValidation](#r4034) | ARM OpenAPI(swagger) specs | | [R4035](#r4035) | [PrivateEndpointResourceSchemaValidation](#r4035) | ARM OpenAPI(swagger) specs | | [R4036](#r4036) | [ImplementPrivateEndpointAPIs](#r4036) | ARM OpenAPI(swagger) specs | - +| [R4037](#r4037) | [MissingTypeObject](#r4037) | ARM and Data plan OpenAPI(swagger) specs | #### SDK Warnings | Id | Rule Name | Applies to | @@ -237,15 +237,19 @@ For more capitalization guidance, see: [https://msdn.microsoft.com/en-us/library * fooBarBaz * resourceKey * resourceApiKey +* publicIPAddress +* enableSsl **Bad Examples**: The following would be invalid: * PascalCase * UpperCamelCase * resourceAPIKey +* enableSSL **Bad Examples**: The following violate these guidelines but would not be caught by automation: * alllowercase - If there are multiple words, please capitalize starting with the second word * miXeDcApItAlIzAtIoN - Please capitalize the first letter of each word (and not seemingly random letters) +* resourceAPIkey - Automation would incorrectly recognize "Ikey" as a word and not flag the property name Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) @@ -292,7 +296,7 @@ If the resource pointed by the rule is not a tracked resource, this warning may Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) ### R3027 TrackedResourceListByResourceGroup -**Category** : ARM Error +**Category** : ARM Warning **Applies to** : ARM OpenAPI(swagger) specs @@ -313,7 +317,7 @@ If the resource pointed by the rule is not a tracked resource or the operation t Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) ### R3028 TrackedResourceListBySubscription -**Category** : ARM Error +**Category** : ARM Warning **Applies to** : ARM OpenAPI(swagger) specs @@ -1595,7 +1599,8 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Output Message**: A '{0}' operation '{1}' with x-ms-long-running-operation extension must have a valid terminal success status code {2}. -**Description**: The allowed response status codes for a long DELETE operation are "200", "204". The allowed response status codes for a POST operation are "200", "201" ,"202", & "204". The allowed response status codes for a PUT operation are "200" & "201". +**Description**: For ARM spec, the allowed response status codes for a long DELETE operation are "200" & "204"; the allowed response status codes for a POST operation are "200", "201" ,"202", & "204"; the allowed response status codes for a PUT/PATCH operation are "200" & "201". + For Data plane spec, the allowed response status codes for a long DELETE operation are "200","202", & "204"; the allowed response status codes for a POST operation are "200", "201" ,"202", & "204"; the allowed response status codes for a PUT/PATCH operation are "200","201", & "202". **Why the rule is important**: This will ensure that the DELETE/POST/PUT operations are designed correctly.Please refer [here](./swagger-extensions.md#x-ms-long-running-operation) for further details. @@ -1907,7 +1912,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul In case of LRO Post operation with return schema, it MAY be ambiguous for the SDK to understand automatically what the return schema is modeling. To avoid any confusion that would lead SDK to incorrectly instantiate the return type, service team needs to explain if the return schema is modeling a result from a "Location" header, or from an "Azure-AsyncOperation" header. -More details on LRO operation could be found [here](https://github.com/Azure/adx-documentation-pr/blob/master/sdks/LRO/LRO_AzureSDK.md) +More details on LRO operation could be found [here](https://github.com/Azure/autorest/blob/master/docs/extensions/readme.md#x-ms-long-running-operation) **How to fix the violation**: For a Post LRO operation, add "x-ms-long-running-operation-options" extension with "final-state-via" property. ``` json @@ -3459,4 +3464,51 @@ GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{ **How to fix the violation**: Please add the missing private endpoint API path and operation to the swagger. -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) \ No newline at end of file +Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) + + +### R4037 MissingTypeObject + +**Category** : SDK Error + +**Applies to** : ARM and Data plane OpenAPI(swagger) specs + +**Output Message** : The schema '{json path}' is considered an object but without a 'type:object', please add the missing 'type:object'. + +**Description**: The rule should apply to any schema with "properties" or "additionalProperties". It is to ensure a schema with "properties" or "additionalProperties" must have explicit "type:object" statement, which means a schema is an object. + +**CreatedAt**: May 24, 2021 + +**LastModifiedAt**: May 24, 2021 + +**Why this rule is important**: The semantics of with and without "type:object" are different. With “type:object” means “it has to be an object”. Without “type: object” means “it could be any type”. Azure SDK Track 2 generator will honor the difference, and generate different SDK codes. +A free-form object would like: + +**How to fix the violation**: +Just add the missing 'type:object'. + +The following would be valid: + +```json + "foo": { + "type":"object", + "properties": { + "a" : { + "type":"string" + } + ... + } + } +``` +The following would be invalid by default (unless you do it on purpose , then a suppression is required): + +```json + "foo": { + "properties": { + "a" : { + "type":"string" + } + ... + } +``` +Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) diff --git a/documentation/samplefiles/readme.go.md b/documentation/samplefiles/readme.go.md index 2bef6f16af36..f755026a6888 100644 --- a/documentation/samplefiles/readme.go.md +++ b/documentation/samplefiles/readme.go.md @@ -2,25 +2,10 @@ These settings apply only when `--go` is specified on the command line. -```yaml $(go) -go: - license-header: MICROSOFT_MIT_NO_VERSION - namespace: [[ServiceName]] - clear-output-folder: true -``` - -### Go multi-api - -``` yaml $(go) && $(multiapi) -batch: - - tag: package-[[Version]][[-ReleaseState]] -``` - -### Tag: package-[[Version]][[-ReleaseState]] and go - -These settings apply only when `--tag=package-[[Version]][[-ReleaseState]] --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -```yaml $(tag) == 'package-[[Version]][[-ReleaseState]]' && $(go) -output-folder: $(go-sdk-folder)/services[[/ReleaseState]]/$(namespace)/mgmt/[[Version]]/$(namespace) +```yaml $(go) && $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/[[ServiceName]]/arm[[ServiceName]] +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) ``` diff --git a/documentation/samplefiles/samplereadme.md b/documentation/samplefiles/samplereadme.md index bce1228cf02e..87547f82a67b 100644 --- a/documentation/samplefiles/samplereadme.md +++ b/documentation/samplefiles/samplereadme.md @@ -51,7 +51,7 @@ This is not used by Autorest itself. swagger-to-sdk: - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - - repo: azure-sdk-for-go + - repo: azure-sdk-for-go-track2 - repo: azure-sdk-for-js - repo: azure-resource-manager-schemas - repo: azure-cli-extensions diff --git a/documentation/sdkautomation/README.md b/documentation/sdkautomation/README.md index a425d04862c5..3d47e9c1745e 100644 --- a/documentation/sdkautomation/README.md +++ b/documentation/sdkautomation/README.md @@ -34,7 +34,7 @@ If the configured language is not found here, generation for this readme.md will 7. Launch __initScript__ defined in [SwaggerToSdkConfig](#swaggertosdkconfig). All the script's working directory is root folder of cloned SDK repository. -8. Calculate __PR diff__ and related `readme.md`. If __generationCallMode__ is __one-for-all-configs__ then run ___one pass for the rest steps___, else (__one-per-configs__) ___loop the rest steps___ with each `readme.md`. +8. Calculate __PR diff__ and related `readme.md`. If __generationCallMode__ is __one-for-all-configs__ then run ___one pass for the rest steps___, else (__one-per-config__) ___loop the rest steps___ with each `readme.md`. 9. Launch __generateScript__ defined in [SwaggerToSdkConfig](#swaggertosdkconfig) with [generateInput.json](#generateinput). The script should produce [generateOutput.json](#generateoutput) if __parseGenerateOutput__ is true. If dryRun is set to true then first run of __generateScript__ will be used to collect package information , then loop each package info and checkout package related branch and launch __generateScript__ with package related readmeMd and dryRun set to false. @@ -250,7 +250,7 @@ Output file for generate script. "full": "To install something...", "lite": "dotnet something" }, - "result": "success" + "result": "succeeded" } ] } @@ -329,4 +329,4 @@ See [./InstallInstructionScriptOutput.json](https://github.com/Azure/azure-rest- } } } -``` \ No newline at end of file +``` diff --git a/package-lock.json b/package-lock.json index c112b7c88c93..dd8689cf81f3 100644 --- a/package-lock.json +++ b/package-lock.json @@ -25,82 +25,6 @@ "yargs": "^15.3.1" } }, - "@azure/oad": { - "version": "0.8.2", - "resolved": "https://registry.npmjs.org/@azure/oad/-/oad-0.8.2.tgz", - "integrity": "sha512-cYEdLqBesAJ0m1MAnKkHWzaCK9i1tNWgbMXF1J2xK+S9H0kVGJ6UL8+aJlBa0kq24rcJfqcSdjOfr51B4XXZJw==", - "dev": true, - "requires": { - "@ts-common/fs": "^0.2.0", - "@ts-common/iterator": "^0.3.6", - "@ts-common/json": "^0.3.1", - "@ts-common/json-parser": "^0.9.0", - "@ts-common/source-map": "^0.5.0", - "@ts-common/string-map": "^0.3.0", - "autorest": "^2.0.4407", - "glob": "^7.1.3", - "js-yaml": "^3.13.1", - "json-pointer": "^0.6.0", - "json-refs": "^3.0.13", - "request": "^2.88.0", - "source-map": "^0.7.3", - "tslib": "^1.9.3", - "winston": "^2.3.0", - "yargs": "^13.2.2" - }, - "dependencies": { - "cliui": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/cliui/-/cliui-5.0.0.tgz", - "integrity": "sha512-PYeGSEmmHM6zvoef2w8TPzlrnNpXIjTipYK780YswmIP9vjxmd6Y2a3CB2Ks6/AU8NHjZugXvo8w3oWM2qnwXA==", - "dev": true, - "requires": { - "string-width": "^3.1.0", - "strip-ansi": "^5.2.0", - "wrap-ansi": "^5.1.0" - } - }, - "wrap-ansi": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-5.1.0.tgz", - "integrity": "sha512-QC1/iN/2/RPVJ5jYK8BGttj5z83LmSKmvbvrXPNCLZSEb32KKVDJDl/MOt2N01qU2H/FkzEa9PKto1BqDjtd7Q==", - "dev": true, - "requires": { - "ansi-styles": "^3.2.0", - "string-width": "^3.0.0", - "strip-ansi": "^5.0.0" - } - }, - "yargs": { - "version": "13.3.2", - "resolved": "https://registry.npmjs.org/yargs/-/yargs-13.3.2.tgz", - "integrity": "sha512-AX3Zw5iPruN5ie6xGRIDgqkT+ZhnRlZMLMHAs8tg7nRruy2Nb+i5o9bwghAogtM08q1dpr2LVoS8KSTMYpWXUw==", - "dev": true, - "requires": { - "cliui": "^5.0.0", - "find-up": "^3.0.0", - "get-caller-file": "^2.0.1", - "require-directory": "^2.1.1", - "require-main-filename": "^2.0.0", - "set-blocking": "^2.0.0", - "string-width": "^3.0.0", - "which-module": "^2.0.0", - "y18n": "^4.0.0", - "yargs-parser": "^13.1.2" - } - }, - "yargs-parser": { - "version": "13.1.2", - "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-13.1.2.tgz", - "integrity": "sha512-3lbsNRf/j+A4QuSZfDRA7HRSfWrzO0YjqTJd5kjAq37Zep1CEgaYmrH9Q3GwPiB9cHyd1Y1UwggGhJGoxipbzg==", - "dev": true, - "requires": { - "camelcase": "^5.0.0", - "decamelize": "^1.2.0" - } - } - } - }, "@azure/openapi-markdown": { "version": "0.9.2", "resolved": "https://registry.npmjs.org/@azure/openapi-markdown/-/openapi-markdown-0.9.2.tgz", @@ -130,6026 +54,1401 @@ } } }, - "@azure/rest-api-specs-scripts": { - "version": "0.14.0", - "resolved": "https://registry.npmjs.org/@azure/rest-api-specs-scripts/-/rest-api-specs-scripts-0.14.0.tgz", - "integrity": "sha512-5V2KidA4lEx2ARpEw3fCJ04sQJfUfSM28pOVbTqVy3RvOhVHnG4LUfw/CgzCz1OzmxBuwt2hFJWORHxAxKgLSw==", - "dev": true, - "requires": { - "@azure/avocado": "^0.4.1", - "@azure/oad": "^0.8.1", - "@azure/swagger-validation-common": "^0.1.2", - "@octokit/rest": "^16.42.0", - "@ts-common/string-map": "^0.3.0", - "commonmark": "0.27.0", - "fs-extra": "^7.0.1", - "glob": "^7.1.3", - "js-yaml": "^3.13.1", - "oav": "^0.22.9", - "request": "^2.88.0" - }, - "dependencies": { - "@azure/avocado": { - "version": "0.4.10", - "resolved": "https://registry.npmjs.org/@azure/avocado/-/avocado-0.4.10.tgz", - "integrity": "sha512-0zPM0gE/QkQEGZkqyFW2+UgmbhvR1D0MzEucVg1fbVIXpHktVzo0O95bEm6jrg07XrCO3yj9eZmOwTDqotnp9A==", - "dev": true, - "requires": { - "@azure/openapi-markdown": "^0.9.1", - "@ts-common/async-iterator": "^0.2.2", - "@ts-common/commonmark-to-markdown": "^1.2.0", - "@ts-common/fs": "^0.2.0", - "@ts-common/iterator": "^0.3.6", - "@ts-common/json": "^0.3.1", - "@ts-common/json-parser": "^0.8.0", - "@ts-common/string-map": "^0.3.0", - "commonmark": "^0.29.0", - "js-yaml": "^3.13.1", - "node-object-hash": "^1.4.2" - }, - "dependencies": { - "commonmark": { - "version": "0.29.2", - "resolved": "https://registry.npmjs.org/commonmark/-/commonmark-0.29.2.tgz", - "integrity": "sha512-spe43MvEIaPpHss1T7z4yQaFQfLGmMu+yvCwv6xqhELIwkG/ZGgDpxOPzKxnuYzYT2c+aziCCc8m2rBVLA7jUA==", - "dev": true, - "requires": { - "entities": "~2.0", - "mdurl": "~1.0.1", - "minimist": ">=1.2.2", - "string.prototype.repeat": "^0.2.0" - } - } - } - }, - "@azure/swagger-validation-common": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/@azure/swagger-validation-common/-/swagger-validation-common-0.1.2.tgz", - "integrity": "sha512-QjmSpAliTzc77WTCnm3+zS2qVGv5U9/2h2y1ICZKQp5+0JSMcy3dPbS9WiKKkpsGQ2b1BJbDugJqKVg6a+8AeA==", - "dev": true - }, - "@ts-common/json-parser": { - "version": "0.8.0", - "resolved": "https://registry.npmjs.org/@ts-common/json-parser/-/json-parser-0.8.0.tgz", - "integrity": "sha512-mlScUHhZiyUH9Am1zGv4r5ce8SM5OkBz9UpnzQrSK8PDHsgnHVHAukMUKxyvqWB9V2JemTXcbnQkjnrBH02QIQ==", - "dev": true, - "requires": { - "@ts-common/add-position": "0.0.2", - "@ts-common/iterator": "^0.3.5", - "@ts-common/json": "^0.3.1", - "@ts-common/source-map": "^0.5.0", - "@ts-common/string-map": "^0.3.0", - "tslib": "^1.9.3" - } - }, - "commonmark": { - "version": "0.27.0", - "resolved": "https://registry.npmjs.org/commonmark/-/commonmark-0.27.0.tgz", - "integrity": "sha1-2GwmK5YoIelIPGnFR7xYhAwEezQ=", - "dev": true, - "requires": { - "entities": "~ 1.1.1", - "mdurl": "~ 1.0.1", - "minimist": "~ 1.2.0", - "string.prototype.repeat": "^0.2.0" - }, - "dependencies": { - "entities": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/entities/-/entities-1.1.2.tgz", - "integrity": "sha512-f2LZMYl1Fzu7YSBKg+RoROelpOaNrcGmE9AZubeDfrCEia483oW4MI4VyFd5VNHIgQ/7qm1I0wUHK1eJnn2y2w==", - "dev": true - } - } - }, - "entities": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/entities/-/entities-2.0.3.tgz", - "integrity": "sha512-MyoZ0jgnLvB2X3Lg5HqpFmn1kybDiIfEQmKzTb5apr51Rb+T3KdmMiqa70T+bhGnyv7bQ6WMj2QMHpGMmlrUYQ==", - "dev": true - } - } - }, "@azure/swagger-validation-common": { "version": "0.0.5", "resolved": "https://registry.npmjs.org/@azure/swagger-validation-common/-/swagger-validation-common-0.0.5.tgz", "integrity": "sha512-oc6OHLdoLlOpO5GjMcOFETEhJi45CI3MVIhvVY/yqyGw9AtaqOYw5HzO3wTuYgYFeGS4v9iqFah0SNLZrpk3Sg==", "dev": true }, - "@babel/code-frame": { - "version": "7.10.4", - "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.10.4.tgz", - "integrity": "sha512-vG6SvB6oYEhvgisZNFRmRCUkLz11c7rp+tbNTynGqc6mS1d5ATd/sGyV6W0KZZnXRKMTzZDRgQT3Ou9jhpAfUg==", + "@ts-common/add-position": { + "version": "0.0.2", + "resolved": "https://registry.npmjs.org/@ts-common/add-position/-/add-position-0.0.2.tgz", + "integrity": "sha512-ENfIN5410jyxqXbQZXmj1ifFPjnhXOuJdQjglDXhLR8vyD74PTUz277BN9Voua2DKeOjlAnyBK7ml1ciMsBqhw==", "dev": true, "requires": { - "@babel/highlight": "^7.10.4" + "@ts-common/iterator": "^0.3.5" } }, - "@babel/core": { - "version": "7.12.9", - "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.12.9.tgz", - "integrity": "sha512-gTXYh3M5wb7FRXQy+FErKFAv90BnlOuNn1QkCK2lREoPAjrQCO49+HVSrFoe5uakFAF5eenS75KbO2vQiLrTMQ==", + "@ts-common/async-iterator": { + "version": "0.2.3", + "resolved": "https://registry.npmjs.org/@ts-common/async-iterator/-/async-iterator-0.2.3.tgz", + "integrity": "sha512-szLdrutwQxBCIECaO2RTFcUPFj+9QVk4xKAj+APgeeLoEs67tNjXFgvfU0kOfF04qTHlPNPqcutSqxMHqzG3qA==", "dev": true, "requires": { - "@babel/code-frame": "^7.10.4", - "@babel/generator": "^7.12.5", - "@babel/helper-module-transforms": "^7.12.1", - "@babel/helpers": "^7.12.5", - "@babel/parser": "^7.12.7", - "@babel/template": "^7.12.7", - "@babel/traverse": "^7.12.9", - "@babel/types": "^7.12.7", - "convert-source-map": "^1.7.0", - "debug": "^4.1.0", - "gensync": "^1.0.0-beta.1", - "json5": "^2.1.2", - "lodash": "^4.17.19", - "resolve": "^1.3.2", - "semver": "^5.4.1", - "source-map": "^0.5.0" - }, - "dependencies": { - "debug": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", - "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", - "dev": true, - "requires": { - "ms": "2.1.2" - } - }, - "resolve": { - "version": "1.19.0", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.19.0.tgz", - "integrity": "sha512-rArEXAgsBG4UgRGcynxWIWKFvh/XZCcS8UJdHhwy91zwAvCZIbcs+vAbflgBnNjYMs/i/i+/Ux6IZhML1yPvxg==", - "dev": true, - "requires": { - "is-core-module": "^2.1.0", - "path-parse": "^1.0.6" - } - }, - "source-map": { - "version": "0.5.7", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.5.7.tgz", - "integrity": "sha1-igOdLRAh0i0eoUyA2OpGi6LvP8w=", - "dev": true - } + "@ts-common/iterator": "^0.3.6", + "tslib": "^1.10.0" } }, - "@babel/generator": { - "version": "7.12.5", - "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.12.5.tgz", - "integrity": "sha512-m16TQQJ8hPt7E+OS/XVQg/7U184MLXtvuGbCdA7na61vha+ImkyyNM/9DDA0unYCVZn3ZOhng+qz48/KBOT96A==", + "@ts-common/commonmark-to-markdown": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/@ts-common/commonmark-to-markdown/-/commonmark-to-markdown-1.2.0.tgz", + "integrity": "sha1-Gy257ada2oNjbwcopc3sic0D08M=", "dev": true, "requires": { - "@babel/types": "^7.12.5", - "jsesc": "^2.5.1", - "source-map": "^0.5.0" + "@ts-common/iterator": "^0.3.0", + "@types/commonmark": "^0.27.3", + "commonmark": "^0.28.1", + "front-matter": "^3.0.1" }, "dependencies": { - "source-map": { - "version": "0.5.7", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.5.7.tgz", - "integrity": "sha1-igOdLRAh0i0eoUyA2OpGi6LvP8w=", - "dev": true + "commonmark": { + "version": "0.28.1", + "resolved": "https://registry.npmjs.org/commonmark/-/commonmark-0.28.1.tgz", + "integrity": "sha1-Buq41SM4uDn6Gi11rwCF7tGxvq4=", + "dev": true, + "requires": { + "entities": "~ 1.1.1", + "mdurl": "~ 1.0.1", + "minimist": "~ 1.2.0", + "string.prototype.repeat": "^0.2.0" + } } } }, - "@babel/helper-function-name": { - "version": "7.10.4", - "resolved": "https://registry.npmjs.org/@babel/helper-function-name/-/helper-function-name-7.10.4.tgz", - "integrity": "sha512-YdaSyz1n8gY44EmN7x44zBn9zQ1Ry2Y+3GTA+3vH6Mizke1Vw0aWDM66FOYEPw8//qKkmqOckrGgTYa+6sceqQ==", + "@ts-common/fs": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/@ts-common/fs/-/fs-0.2.0.tgz", + "integrity": "sha1-FMvf3smooaVjKNr1Ztm8k7iJgrk=", "dev": true, "requires": { - "@babel/helper-get-function-arity": "^7.10.4", - "@babel/template": "^7.10.4", - "@babel/types": "^7.10.4" + "@ts-common/async-iterator": "^0.2.0", + "@types/node": "^10.12.18", + "tslib": "^1.9.3" } }, - "@babel/helper-get-function-arity": { - "version": "7.10.4", - "resolved": "https://registry.npmjs.org/@babel/helper-get-function-arity/-/helper-get-function-arity-7.10.4.tgz", - "integrity": "sha512-EkN3YDB+SRDgiIUnNgcmiD361ti+AVbL3f3Henf6dqqUyr5dMsorno0lJWJuLhDhkI5sYEpgj6y9kB8AOU1I2A==", - "dev": true, - "requires": { - "@babel/types": "^7.10.4" - } + "@ts-common/iterator": { + "version": "0.3.6", + "resolved": "https://registry.npmjs.org/@ts-common/iterator/-/iterator-0.3.6.tgz", + "integrity": "sha1-/6FLXYkTxIMKXSMdPssHXQLKfm0=", + "dev": true }, - "@babel/helper-member-expression-to-functions": { - "version": "7.12.7", - "resolved": "https://registry.npmjs.org/@babel/helper-member-expression-to-functions/-/helper-member-expression-to-functions-7.12.7.tgz", - "integrity": "sha512-DCsuPyeWxeHgh1Dus7APn7iza42i/qXqiFPWyBDdOFtvS581JQePsc1F/nD+fHrcswhLlRc2UpYS1NwERxZhHw==", + "@ts-common/json": { + "version": "0.3.1", + "resolved": "https://registry.npmjs.org/@ts-common/json/-/json-0.3.1.tgz", + "integrity": "sha512-vaplNdZPdeWr4p+hLJGdn08UMTSgYQrlRtxrAS0fAWyMlmFalBm/XRhHnohgiflRaj2jxl7ZxihjNlC/LZ/1YQ==", "dev": true, "requires": { - "@babel/types": "^7.12.7" + "@ts-common/iterator": "^0.3.1", + "@ts-common/string-map": "^0.3.0" } }, - "@babel/helper-module-imports": { - "version": "7.12.5", - "resolved": "https://registry.npmjs.org/@babel/helper-module-imports/-/helper-module-imports-7.12.5.tgz", - "integrity": "sha512-SR713Ogqg6++uexFRORf/+nPXMmWIn80TALu0uaFb+iQIUoR7bOC7zBWyzBs5b3tBBJXuyD0cRu1F15GyzjOWA==", + "@ts-common/json-parser": { + "version": "0.9.0", + "resolved": "https://registry.npmjs.org/@ts-common/json-parser/-/json-parser-0.9.0.tgz", + "integrity": "sha512-how0z/Ak7Bay+feIYfJFVV8UMw8Ky2Czoo5XwN7QigCOlN4HyW6wSNup4zrZ7t6NUB0002tW/+IOKCH2lAVJOg==", "dev": true, "requires": { - "@babel/types": "^7.12.5" + "@ts-common/add-position": "0.0.2", + "@ts-common/iterator": "^0.3.5", + "@ts-common/json": "^0.3.1", + "@ts-common/source-map": "^0.5.0", + "@ts-common/string-map": "^0.3.0", + "tslib": "^1.9.3" } }, - "@babel/helper-module-transforms": { - "version": "7.12.1", - "resolved": "https://registry.npmjs.org/@babel/helper-module-transforms/-/helper-module-transforms-7.12.1.tgz", - "integrity": "sha512-QQzehgFAZ2bbISiCpmVGfiGux8YVFXQ0abBic2Envhej22DVXV9nCFaS5hIQbkyo1AdGb+gNME2TSh3hYJVV/w==", - "dev": true, - "requires": { - "@babel/helper-module-imports": "^7.12.1", - "@babel/helper-replace-supers": "^7.12.1", - "@babel/helper-simple-access": "^7.12.1", - "@babel/helper-split-export-declaration": "^7.11.0", - "@babel/helper-validator-identifier": "^7.10.4", - "@babel/template": "^7.10.4", - "@babel/traverse": "^7.12.1", - "@babel/types": "^7.12.1", - "lodash": "^4.17.19" - } + "@ts-common/property-set": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/@ts-common/property-set/-/property-set-0.1.0.tgz", + "integrity": "sha512-Mw/CPiksQI/Tvp8/bmne6ZYmOcgHuMOrflairbzdpfgMz7lrINFu8PyDQw6yTnIASeZR4yW0xljb66gCE4Jj0w==", + "dev": true }, - "@babel/helper-optimise-call-expression": { - "version": "7.12.7", - "resolved": "https://registry.npmjs.org/@babel/helper-optimise-call-expression/-/helper-optimise-call-expression-7.12.7.tgz", - "integrity": "sha512-I5xc9oSJ2h59OwyUqjv95HRyzxj53DAubUERgQMrpcCEYQyToeHA+NEcUEsVWB4j53RDeskeBJ0SgRAYHDBckw==", + "@ts-common/source-map": { + "version": "0.5.0", + "resolved": "https://registry.npmjs.org/@ts-common/source-map/-/source-map-0.5.0.tgz", + "integrity": "sha512-aKFWvuN5uALt+hUtkPA4gHjtloDy2qHW1FB1r758KCTI0h0lP3dNJGcfwg7NnmD0qKQiZAY/J73/NYrbuTfT3A==", "dev": true, "requires": { - "@babel/types": "^7.12.7" + "@ts-common/iterator": "^0.3.0", + "@ts-common/json": "^0.3.0", + "@ts-common/property-set": "^0.1.0", + "@ts-common/string-map": "^0.3.0" } }, - "@babel/helper-replace-supers": { - "version": "7.12.5", - "resolved": "https://registry.npmjs.org/@babel/helper-replace-supers/-/helper-replace-supers-7.12.5.tgz", - "integrity": "sha512-5YILoed0ZyIpF4gKcpZitEnXEJ9UoDRki1Ey6xz46rxOzfNMAhVIJMoune1hmPVxh40LRv1+oafz7UsWX+vyWA==", + "@ts-common/string-map": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/@ts-common/string-map/-/string-map-0.3.0.tgz", + "integrity": "sha512-tikHtQPV/R48VAnlolyl1FIHciror68LXyruelvYf+lRE6ysjIGB2iNyw7wN6aDcUs2wN/CD6fF8Ye7lVIWNTQ==", "dev": true, "requires": { - "@babel/helper-member-expression-to-functions": "^7.12.1", - "@babel/helper-optimise-call-expression": "^7.10.4", - "@babel/traverse": "^7.12.5", - "@babel/types": "^7.12.5" + "@ts-common/iterator": "^0.3.0" } }, - "@babel/helper-simple-access": { - "version": "7.12.1", - "resolved": "https://registry.npmjs.org/@babel/helper-simple-access/-/helper-simple-access-7.12.1.tgz", - "integrity": "sha512-OxBp7pMrjVewSSC8fXDFrHrBcJATOOFssZwv16F3/6Xtc138GHybBfPbm9kfiqQHKhYQrlamWILwlDCeyMFEaA==", + "@ts-common/virtual-fs": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/@ts-common/virtual-fs/-/virtual-fs-0.3.0.tgz", + "integrity": "sha512-ryoXw52FTLhiexoNBA/hcAlW8gxPhrKEuZODgpCiF0wswNJdg/j+rCb9k1VppJdeIJ30b0Wg+2vPsrOrdnYTIw==", "dev": true, "requires": { - "@babel/types": "^7.12.1" + "@ts-common/fs": "^0.2.0", + "@ts-common/iterator": "^0.3.0", + "@types/async-retry": "^1.4.1", + "@types/node-fetch": "^2.5.5", + "async-retry": "^1.3.1", + "node-fetch": "^2.6.0" } }, - "@babel/helper-split-export-declaration": { - "version": "7.11.0", - "resolved": "https://registry.npmjs.org/@babel/helper-split-export-declaration/-/helper-split-export-declaration-7.11.0.tgz", - "integrity": "sha512-74Vejvp6mHkGE+m+k5vHY93FX2cAtrw1zXrZXRlG4l410Nm9PxfEiVTn1PjDPV5SnmieiueY4AFg2xqhNFuuZg==", - "dev": true, - "requires": { - "@babel/types": "^7.11.0" - } + "@tsconfig/node10": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/@tsconfig/node10/-/node10-1.0.8.tgz", + "integrity": "sha512-6XFfSQmMgq0CFLY1MslA/CPUfhIL919M1rMsa5lP2P097N2Wd1sSX0tx1u4olM16fLNhtHZpRhedZJphNJqmZg==", + "dev": true }, - "@babel/helper-validator-identifier": { - "version": "7.10.4", - "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.10.4.tgz", - "integrity": "sha512-3U9y+43hz7ZM+rzG24Qe2mufW5KhvFg/NhnNph+i9mgCtdTCtMJuI1TMkrIUiK7Ix4PYlRF9I5dhqaLYA/ADXw==", + "@tsconfig/node12": { + "version": "1.0.9", + "resolved": "https://registry.npmjs.org/@tsconfig/node12/-/node12-1.0.9.tgz", + "integrity": "sha512-/yBMcem+fbvhSREH+s14YJi18sp7J9jpuhYByADT2rypfajMZZN4WQ6zBGgBKp53NKmqI36wFYDb3yaMPurITw==", "dev": true }, - "@babel/helpers": { - "version": "7.12.5", - "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.12.5.tgz", - "integrity": "sha512-lgKGMQlKqA8meJqKsW6rUnc4MdUk35Ln0ATDqdM1a/UpARODdI4j5Y5lVfUScnSNkJcdCRAaWkspykNoFg9sJA==", - "dev": true, - "requires": { - "@babel/template": "^7.10.4", - "@babel/traverse": "^7.12.5", - "@babel/types": "^7.12.5" - } + "@tsconfig/node14": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/@tsconfig/node14/-/node14-1.0.1.tgz", + "integrity": "sha512-509r2+yARFfHHE7T6Puu2jjkoycftovhXRqW328PDXTVGKihlb1P8Z9mMZH04ebyajfRY7dedfGynlrFHJUQCg==", + "dev": true }, - "@babel/highlight": { - "version": "7.10.4", - "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.10.4.tgz", - "integrity": "sha512-i6rgnR/YgPEQzZZnbTHHuZdlE8qyoBNalD6F+q4vAFlcMEcqmkoG+mPqJYJCo63qPf74+Y1UZsl3l6f7/RIkmA==", + "@tsconfig/node16": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/@tsconfig/node16/-/node16-1.0.2.tgz", + "integrity": "sha512-eZxlbI8GZscaGS7kkc/trHTT5xgrjH3/1n2JDwusC9iahPKWMRvRjJSAN5mCXviuTGQ/lHnhvv8Q1YTpnfz9gA==", + "dev": true + }, + "@types/async-retry": { + "version": "1.4.2", + "resolved": "https://registry.npmjs.org/@types/async-retry/-/async-retry-1.4.2.tgz", + "integrity": "sha512-GUDuJURF0YiJZ+CBjNQA0+vbP/VHlJbB0sFqkzsV7EcOPRfurVonXpXKAt3w8qIjM1TEzpz6hc6POocPvHOS3w==", "dev": true, "requires": { - "@babel/helper-validator-identifier": "^7.10.4", - "chalk": "^2.0.0", - "js-tokens": "^4.0.0" + "@types/retry": "*" } }, - "@babel/parser": { - "version": "7.12.7", - "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.12.7.tgz", - "integrity": "sha512-oWR02Ubp4xTLCAqPRiNIuMVgNO5Aif/xpXtabhzW2HWUD47XJsAB4Zd/Rg30+XeQA3juXigV7hlquOTmwqLiwg==", + "@types/commonmark": { + "version": "0.27.4", + "resolved": "https://registry.npmjs.org/@types/commonmark/-/commonmark-0.27.4.tgz", + "integrity": "sha512-7koSjp08QxKoS1/+3T15+kD7+vqOUvZRHvM8PutF3Xsk5aAEkdlIGRsHJ3/XsC3izoqTwBdRW/vH7rzCKkIicA==", "dev": true }, - "@babel/template": { - "version": "7.12.7", - "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.12.7.tgz", - "integrity": "sha512-GkDzmHS6GV7ZeXfJZ0tLRBhZcMcY0/Lnb+eEbXDBfCAcZCjrZKe6p3J4we/D24O9Y8enxWAg1cWwof59yLh2ow==", - "dev": true, - "requires": { - "@babel/code-frame": "^7.10.4", - "@babel/parser": "^7.12.7", - "@babel/types": "^7.12.7" - } + "@types/js-yaml": { + "version": "3.12.1", + "resolved": "https://registry.npmjs.org/@types/js-yaml/-/js-yaml-3.12.1.tgz", + "integrity": "sha512-SGGAhXLHDx+PK4YLNcNGa6goPf9XRWQNAUUbffkwVGGXIxmDKWyGGL4inzq2sPmExu431Ekb9aEMn9BkPqEYFA==", + "dev": true }, - "@babel/traverse": { - "version": "7.12.9", - "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.12.9.tgz", - "integrity": "sha512-iX9ajqnLdoU1s1nHt36JDI9KG4k+vmI8WgjK5d+aDTwQbL2fUnzedNedssA645Ede3PM2ma1n8Q4h2ohwXgMXw==", - "dev": true, - "requires": { - "@babel/code-frame": "^7.10.4", - "@babel/generator": "^7.12.5", - "@babel/helper-function-name": "^7.10.4", - "@babel/helper-split-export-declaration": "^7.11.0", - "@babel/parser": "^7.12.7", - "@babel/types": "^7.12.7", - "debug": "^4.1.0", - "globals": "^11.1.0", - "lodash": "^4.17.19" - }, - "dependencies": { - "debug": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", - "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", - "dev": true, - "requires": { - "ms": "2.1.2" - } - } - } + "@types/mocha": { + "version": "9.0.0", + "resolved": "https://registry.npmjs.org/@types/mocha/-/mocha-9.0.0.tgz", + "integrity": "sha512-scN0hAWyLVAvLR9AyW7HoFF5sJZglyBsbPuHO4fv7JRvfmPBMfp1ozWqOf/e4wwPNxezBZXRfWzMb6iFLgEVRA==", + "dev": true }, - "@babel/types": { - "version": "7.12.7", - "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.12.7.tgz", - "integrity": "sha512-MNyI92qZq6jrQkXvtIiykvl4WtoRrVV9MPn+ZfsoEENjiWcBQ3ZSHrkxnJWgWtLX3XXqX5hrSQ+X69wkmesXuQ==", - "dev": true, - "requires": { - "@babel/helper-validator-identifier": "^7.10.4", - "lodash": "^4.17.19", - "to-fast-properties": "^2.0.0" - } + "@types/node": { + "version": "10.14.16", + "resolved": "https://registry.npmjs.org/@types/node/-/node-10.14.16.tgz", + "integrity": "sha512-/opXIbfn0P+VLt+N8DE4l8Mn8rbhiJgabU96ZJ0p9mxOkIks5gh6RUnpHak7Yh0SFkyjO/ODbxsQQPV2bpMmyA==", + "dev": true }, - "@dabh/diagnostics": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/@dabh/diagnostics/-/diagnostics-2.0.2.tgz", - "integrity": "sha512-+A1YivoVDNNVCdfozHSR8v/jyuuLTMXwjWuxPFlFlUapXoGc+Gj9mDlTDDfrwl7rXCl2tNZ0kE8sIBO6YOn96Q==", + "@types/node-fetch": { + "version": "2.5.7", + "resolved": "https://registry.npmjs.org/@types/node-fetch/-/node-fetch-2.5.7.tgz", + "integrity": "sha512-o2WVNf5UhWRkxlf6eq+jMZDu7kjgpgJfl4xVNlvryc95O/6F2ld8ztKX+qu+Rjyet93WAWm5LjeX9H5FGkODvw==", "dev": true, "requires": { - "colorspace": "1.1.x", - "enabled": "2.0.x", - "kuler": "^2.0.0" + "@types/node": "*", + "form-data": "^3.0.0" } }, - "@istanbuljs/load-nyc-config": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/@istanbuljs/load-nyc-config/-/load-nyc-config-1.1.0.tgz", - "integrity": "sha512-VjeHSlIzpv/NyD3N0YuHfXOPDIixcA1q2ZV98wsMqcYlPmv2n3Yb2lYP9XMElnaFVXg5A7YLTeLu6V84uQDjmQ==", - "dev": true, - "requires": { - "camelcase": "^5.3.1", - "find-up": "^4.1.0", - "get-package-type": "^0.1.0", - "js-yaml": "^3.13.1", - "resolve-from": "^5.0.0" - }, - "dependencies": { - "find-up": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-4.1.0.tgz", - "integrity": "sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw==", - "dev": true, - "requires": { - "locate-path": "^5.0.0", - "path-exists": "^4.0.0" - } - }, - "locate-path": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-5.0.0.tgz", - "integrity": "sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g==", - "dev": true, - "requires": { - "p-locate": "^4.1.0" - } - }, - "p-locate": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-4.1.0.tgz", - "integrity": "sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A==", - "dev": true, - "requires": { - "p-limit": "^2.2.0" - } - }, - "path-exists": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", - "integrity": "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==", - "dev": true - } - } + "@types/prettier": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/@types/prettier/-/prettier-2.3.0.tgz", + "integrity": "sha512-hkc1DATxFLQo4VxPDpMH1gCkPpBbpOoJ/4nhuXw4n63/0R6bCpQECj4+K226UJ4JO/eJQz+1mC2I7JsWanAdQw==", + "dev": true }, - "@istanbuljs/schema": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/@istanbuljs/schema/-/schema-0.1.2.tgz", - "integrity": "sha512-tsAQNx32a8CoFhjhijUIhI4kccIAgmGhy8LZMZgGfmXcpMbPRUqn5LWmgRttILi6yeGmBJd2xsPkFMs0PzgPCw==", + "@types/retry": { + "version": "0.12.0", + "resolved": "https://registry.npmjs.org/@types/retry/-/retry-0.12.0.tgz", + "integrity": "sha512-wWKOClTTiizcZhXnPY4wikVAwmdYHp8q6DmC+EJUzAMsycb7HB32Kh9RN4+0gExjmPmZSAQjgURXIGATPegAvA==", "dev": true }, - "@microsoft.azure/autorest-extension-base": { - "version": "1.0.13", - "resolved": "https://registry.npmjs.org/@microsoft.azure/autorest-extension-base/-/autorest-extension-base-1.0.13.tgz", - "integrity": "sha1-/VobUj8CzK3525vK8Jez/5mSgeY=", - "dev": true, - "requires": { - "vscode-jsonrpc": "^3.5.0" - } + "ansi-colors": { + "version": "3.2.3", + "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-3.2.3.tgz", + "integrity": "sha512-LEHHyuhlPY3TmuUYMh2oz89lTShfvgbmzaBcxve9t/9Wuy7Dwf4yoAKcND7KFT1HAQfqZ12qtc+DUrBMeKF9nw==", + "dev": true }, - "@mrmlnc/readdir-enhanced": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/@mrmlnc/readdir-enhanced/-/readdir-enhanced-2.2.1.tgz", - "integrity": "sha512-bPHp6Ji8b41szTOcaP63VlnbbO5Ny6dwAATtY6JTjh5N2OLrb5Qk/Th5cRkRQhkWCt+EJsYrNB0MiL+Gpn6e3g==", + "ansi-regex": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.0.tgz", + "integrity": "sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg==", + "dev": true + }, + "ansi-styles": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", + "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", "dev": true, "requires": { - "call-me-maybe": "^1.0.1", - "glob-to-regexp": "^0.3.0" + "color-convert": "^1.9.0" } }, - "@nodelib/fs.stat": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-1.1.3.tgz", - "integrity": "sha512-shAmDyaQC4H92APFoIaVDHCx5bStIocgvbwQyxPRrbUY20V1EYTbSDchWbuwlMG3V17cprZhA6+78JfB+3DTPw==", + "arg": { + "version": "4.1.3", + "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz", + "integrity": "sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA==", "dev": true }, - "@octokit/auth-token": { - "version": "2.4.4", - "resolved": "https://registry.npmjs.org/@octokit/auth-token/-/auth-token-2.4.4.tgz", - "integrity": "sha512-LNfGu3Ro9uFAYh10MUZVaT7X2CnNm2C8IDQmabx+3DygYIQjs9FwzFAHN/0t6mu5HEPhxcb1XOuxdpY82vCg2Q==", + "argparse": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", + "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", "dev": true, "requires": { - "@octokit/types": "^6.0.0" + "sprintf-js": "~1.0.2" } }, - "@octokit/endpoint": { - "version": "6.0.10", - "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-6.0.10.tgz", - "integrity": "sha512-9+Xef8nT7OKZglfkOMm7IL6VwxXUQyR7DUSU0LH/F7VNqs8vyd7es5pTfz9E7DwUIx7R3pGscxu1EBhYljyu7Q==", + "async-retry": { + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/async-retry/-/async-retry-1.3.1.tgz", + "integrity": "sha512-aiieFW/7h3hY0Bq5d+ktDBejxuwR78vRu9hDUdR8rNhSaQ29VzPL4AoIRG7D/c7tdenwOcKvgPM6tIxB3cB6HA==", "dev": true, "requires": { - "@octokit/types": "^6.0.0", - "is-plain-object": "^5.0.0", - "universal-user-agent": "^6.0.0" - }, - "dependencies": { - "universal-user-agent": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/universal-user-agent/-/universal-user-agent-6.0.0.tgz", - "integrity": "sha512-isyNax3wXoKaulPDZWHQqbmIx1k2tb9fb3GGDBRxCscfYV2Ch7WxPArBsFEG8s/safwXTT7H4QGhaIkTp9447w==", - "dev": true - } + "retry": "0.12.0" } }, - "@octokit/openapi-types": { - "version": "1.2.2", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-1.2.2.tgz", - "integrity": "sha512-vrKDLd/Rq4IE16oT+jJkDBx0r29NFkdkU8GwqVSP4RajsAvP23CMGtFhVK0pedUhAiMvG1bGnFcTC/xCKaKgmw==", + "asynckit": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", + "integrity": "sha1-x57Zf380y48robyXkLzDZkdLS3k=", "dev": true }, - "@octokit/plugin-paginate-rest": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/@octokit/plugin-paginate-rest/-/plugin-paginate-rest-1.1.2.tgz", - "integrity": "sha512-jbsSoi5Q1pj63sC16XIUboklNw+8tL9VOnJsWycWYR78TKss5PVpIPb1TUUcMQ+bBh7cY579cVAWmf5qG+dw+Q==", + "balanced-match": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.0.tgz", + "integrity": "sha1-ibTRmasr7kneFk6gK4nORi1xt2c=", + "dev": true + }, + "brace-expansion": { + "version": "1.1.11", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", + "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", "dev": true, "requires": { - "@octokit/types": "^2.0.1" - }, - "dependencies": { - "@octokit/types": { - "version": "2.16.2", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-2.16.2.tgz", - "integrity": "sha512-O75k56TYvJ8WpAakWwYRN8Bgu60KrmX0z1KqFp1kNiFNkgW+JW+9EBKZ+S33PU6SLvbihqd+3drvPxKK68Ee8Q==", - "dev": true, - "requires": { - "@types/node": ">= 8" - } - } + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" } }, - "@octokit/plugin-request-log": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/@octokit/plugin-request-log/-/plugin-request-log-1.0.2.tgz", - "integrity": "sha512-oTJSNAmBqyDR41uSMunLQKMX0jmEXbwD1fpz8FG27lScV3RhtGfBa1/BBLym+PxcC16IBlF7KH9vP1BUYxA+Eg==", + "browser-stdout": { + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/browser-stdout/-/browser-stdout-1.3.1.tgz", + "integrity": "sha512-qhAVI1+Av2X7qelOfAIYwXONood6XlZE/fXaBSmW/T5SzLAmCgzi+eiWE7fUvbHaeNBQH13UftjpXxsfLkMpgw==", + "dev": true + }, + "buffer-from": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.1.tgz", + "integrity": "sha512-MQcXEUbCKtEo7bhqEs6560Hyd4XaovZlO/k9V3hjVUF/zwW7KBVdSK4gIt/bzwS9MbR5qob+F5jusZsb0YQK2A==", + "dev": true + }, + "call-me-maybe": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/call-me-maybe/-/call-me-maybe-1.0.1.tgz", + "integrity": "sha1-JtII6onje1y95gJQoV8DHBak1ms=", + "dev": true + }, + "camelcase": { + "version": "5.3.1", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-5.3.1.tgz", + "integrity": "sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg==", "dev": true }, - "@octokit/plugin-rest-endpoint-methods": { - "version": "2.4.0", - "resolved": "https://registry.npmjs.org/@octokit/plugin-rest-endpoint-methods/-/plugin-rest-endpoint-methods-2.4.0.tgz", - "integrity": "sha512-EZi/AWhtkdfAYi01obpX0DF7U6b1VRr30QNQ5xSFPITMdLSfhcBqjamE3F+sKcxPbD7eZuMHu3Qkk2V+JGxBDQ==", + "chalk": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", + "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", "dev": true, "requires": { - "@octokit/types": "^2.0.1", - "deprecation": "^2.3.1" + "ansi-styles": "^3.2.1", + "escape-string-regexp": "^1.0.5", + "supports-color": "^5.3.0" }, "dependencies": { - "@octokit/types": { - "version": "2.16.2", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-2.16.2.tgz", - "integrity": "sha512-O75k56TYvJ8WpAakWwYRN8Bgu60KrmX0z1KqFp1kNiFNkgW+JW+9EBKZ+S33PU6SLvbihqd+3drvPxKK68Ee8Q==", + "has-flag": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", + "integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0=", + "dev": true + }, + "supports-color": { + "version": "5.5.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", + "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", "dev": true, "requires": { - "@types/node": ">= 8" + "has-flag": "^3.0.0" } } } }, - "@octokit/request": { - "version": "5.4.11", - "resolved": "https://registry.npmjs.org/@octokit/request/-/request-5.4.11.tgz", - "integrity": "sha512-vskebNjuz4oTdPIv+9cQjHvjk8vjrMv2fOmSo6zr7IIaFHeVsJlG/C07MXiSS/+g/qU1GHjkPG1XW3faz57EoQ==", + "cliui": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/cliui/-/cliui-6.0.0.tgz", + "integrity": "sha512-t6wbgtoCXvAzst7QgXxJYqPt0usEfbgQdftEPbLL/cvv6HPE5VgvqCuAIDR0NgU52ds6rFwqrgakNLrHEjCbrQ==", "dev": true, "requires": { - "@octokit/endpoint": "^6.0.1", - "@octokit/request-error": "^2.0.0", - "@octokit/types": "^6.0.0", - "deprecation": "^2.0.0", - "is-plain-object": "^5.0.0", - "node-fetch": "^2.6.1", - "once": "^1.4.0", - "universal-user-agent": "^6.0.0" + "string-width": "^4.2.0", + "strip-ansi": "^6.0.0", + "wrap-ansi": "^6.2.0" }, "dependencies": { - "@octokit/request-error": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-2.0.4.tgz", - "integrity": "sha512-LjkSiTbsxIErBiRh5wSZvpZqT4t0/c9+4dOe0PII+6jXR+oj/h66s7E4a/MghV7iT8W9ffoQ5Skoxzs96+gBPA==", + "ansi-regex": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz", + "integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==", + "dev": true + }, + "emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "dev": true + }, + "is-fullwidth-code-point": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", + "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "dev": true + }, + "string-width": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.0.tgz", + "integrity": "sha512-zUz5JD+tgqtuDjMhwIg5uFVV3dtqZ9yQJlZVfq4I01/K5Paj5UHj7VyrQOJvzawSVlKpObApbfD0Ed6yJc+1eg==", "dev": true, "requires": { - "@octokit/types": "^6.0.0", - "deprecation": "^2.0.0", - "once": "^1.4.0" + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.0" } }, - "universal-user-agent": { + "strip-ansi": { "version": "6.0.0", - "resolved": "https://registry.npmjs.org/universal-user-agent/-/universal-user-agent-6.0.0.tgz", - "integrity": "sha512-isyNax3wXoKaulPDZWHQqbmIx1k2tb9fb3GGDBRxCscfYV2Ch7WxPArBsFEG8s/safwXTT7H4QGhaIkTp9447w==", - "dev": true - } - } - }, - "@octokit/request-error": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-1.2.1.tgz", - "integrity": "sha512-+6yDyk1EES6WK+l3viRDElw96MvwfJxCt45GvmjDUKWjYIb3PJZQkq3i46TwGwoPD4h8NmTrENmtyA1FwbmhRA==", - "dev": true, - "requires": { - "@octokit/types": "^2.0.0", - "deprecation": "^2.0.0", - "once": "^1.4.0" - }, - "dependencies": { - "@octokit/types": { - "version": "2.16.2", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-2.16.2.tgz", - "integrity": "sha512-O75k56TYvJ8WpAakWwYRN8Bgu60KrmX0z1KqFp1kNiFNkgW+JW+9EBKZ+S33PU6SLvbihqd+3drvPxKK68Ee8Q==", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.0.tgz", + "integrity": "sha512-AuvKTrTfQNYNIctbR1K/YGTR1756GycPsg7b9bdV9Duqur4gv6aKqHXah67Z8ImS7WEz5QVcOtlfW2rZEugt6w==", "dev": true, "requires": { - "@types/node": ">= 8" + "ansi-regex": "^5.0.0" } } } }, - "@octokit/rest": { - "version": "16.43.2", - "resolved": "https://registry.npmjs.org/@octokit/rest/-/rest-16.43.2.tgz", - "integrity": "sha512-ngDBevLbBTFfrHZeiS7SAMAZ6ssuVmXuya+F/7RaVvlysgGa1JKJkKWY+jV6TCJYcW0OALfJ7nTIGXcBXzycfQ==", - "dev": true, - "requires": { - "@octokit/auth-token": "^2.4.0", - "@octokit/plugin-paginate-rest": "^1.1.1", - "@octokit/plugin-request-log": "^1.0.0", - "@octokit/plugin-rest-endpoint-methods": "2.4.0", - "@octokit/request": "^5.2.0", - "@octokit/request-error": "^1.0.2", - "atob-lite": "^2.0.0", - "before-after-hook": "^2.0.0", - "btoa-lite": "^1.0.0", - "deprecation": "^2.0.0", - "lodash.get": "^4.4.2", - "lodash.set": "^4.3.2", - "lodash.uniq": "^4.5.0", - "octokit-pagination-methods": "^1.1.0", - "once": "^1.4.0", - "universal-user-agent": "^4.0.0" - } + "code-point-at": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/code-point-at/-/code-point-at-1.1.0.tgz", + "integrity": "sha1-DQcLTQQ6W+ozovGkDi7bPZpMz3c=", + "dev": true }, - "@octokit/types": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-6.0.1.tgz", - "integrity": "sha512-H/DnTKC+U09en2GFLH/MfAPNDaYb1isieD4Hx4NLpEt/I1PgtZP/8a+Ehc/j9GHuVF/UvGtOVD8AF9XXvws53w==", + "color-convert": { + "version": "1.9.3", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", + "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", "dev": true, "requires": { - "@octokit/openapi-types": "^1.2.0", - "@types/node": ">= 8" + "color-name": "1.1.3" } }, - "@ts-common/add-position": { - "version": "0.0.2", - "resolved": "https://registry.npmjs.org/@ts-common/add-position/-/add-position-0.0.2.tgz", - "integrity": "sha512-ENfIN5410jyxqXbQZXmj1ifFPjnhXOuJdQjglDXhLR8vyD74PTUz277BN9Voua2DKeOjlAnyBK7ml1ciMsBqhw==", - "dev": true, - "requires": { - "@ts-common/iterator": "^0.3.5" - } + "color-name": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", + "integrity": "sha1-p9BVi9icQveV3UIyj3QIMcpTvCU=", + "dev": true }, - "@ts-common/async-iterator": { - "version": "0.2.3", - "resolved": "https://registry.npmjs.org/@ts-common/async-iterator/-/async-iterator-0.2.3.tgz", - "integrity": "sha512-szLdrutwQxBCIECaO2RTFcUPFj+9QVk4xKAj+APgeeLoEs67tNjXFgvfU0kOfF04qTHlPNPqcutSqxMHqzG3qA==", + "combined-stream": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", + "integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==", "dev": true, "requires": { - "@ts-common/iterator": "^0.3.6", - "tslib": "^1.10.0" + "delayed-stream": "~1.0.0" } }, - "@ts-common/commonmark-to-markdown": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/@ts-common/commonmark-to-markdown/-/commonmark-to-markdown-1.2.0.tgz", - "integrity": "sha1-Gy257ada2oNjbwcopc3sic0D08M=", + "commonmark": { + "version": "0.29.2", + "resolved": "https://registry.npmjs.org/commonmark/-/commonmark-0.29.2.tgz", + "integrity": "sha512-spe43MvEIaPpHss1T7z4yQaFQfLGmMu+yvCwv6xqhELIwkG/ZGgDpxOPzKxnuYzYT2c+aziCCc8m2rBVLA7jUA==", "dev": true, "requires": { - "@ts-common/iterator": "^0.3.0", - "@types/commonmark": "^0.27.3", - "commonmark": "^0.28.1", - "front-matter": "^3.0.1" + "entities": "~2.0", + "mdurl": "~1.0.1", + "minimist": ">=1.2.2", + "string.prototype.repeat": "^0.2.0" }, "dependencies": { - "commonmark": { - "version": "0.28.1", - "resolved": "https://registry.npmjs.org/commonmark/-/commonmark-0.28.1.tgz", - "integrity": "sha1-Buq41SM4uDn6Gi11rwCF7tGxvq4=", - "dev": true, - "requires": { - "entities": "~ 1.1.1", - "mdurl": "~ 1.0.1", - "minimist": "~ 1.2.0", - "string.prototype.repeat": "^0.2.0" - } - } - } - }, - "@ts-common/fs": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/@ts-common/fs/-/fs-0.2.0.tgz", - "integrity": "sha1-FMvf3smooaVjKNr1Ztm8k7iJgrk=", - "dev": true, - "requires": { - "@ts-common/async-iterator": "^0.2.0", - "@types/node": "^10.12.18", - "tslib": "^1.9.3" + "entities": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/entities/-/entities-2.0.3.tgz", + "integrity": "sha512-MyoZ0jgnLvB2X3Lg5HqpFmn1kybDiIfEQmKzTb5apr51Rb+T3KdmMiqa70T+bhGnyv7bQ6WMj2QMHpGMmlrUYQ==", + "dev": true + } } }, - "@ts-common/iterator": { - "version": "0.3.6", - "resolved": "https://registry.npmjs.org/@ts-common/iterator/-/iterator-0.3.6.tgz", - "integrity": "sha1-/6FLXYkTxIMKXSMdPssHXQLKfm0=", + "concat-map": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", + "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=", "dev": true }, - "@ts-common/json": { - "version": "0.3.1", - "resolved": "https://registry.npmjs.org/@ts-common/json/-/json-0.3.1.tgz", - "integrity": "sha512-vaplNdZPdeWr4p+hLJGdn08UMTSgYQrlRtxrAS0fAWyMlmFalBm/XRhHnohgiflRaj2jxl7ZxihjNlC/LZ/1YQ==", - "dev": true, - "requires": { - "@ts-common/iterator": "^0.3.1", - "@ts-common/string-map": "^0.3.0" - } - }, - "@ts-common/json-parser": { - "version": "0.9.0", - "resolved": "https://registry.npmjs.org/@ts-common/json-parser/-/json-parser-0.9.0.tgz", - "integrity": "sha512-how0z/Ak7Bay+feIYfJFVV8UMw8Ky2Czoo5XwN7QigCOlN4HyW6wSNup4zrZ7t6NUB0002tW/+IOKCH2lAVJOg==", - "dev": true, - "requires": { - "@ts-common/add-position": "0.0.2", - "@ts-common/iterator": "^0.3.5", - "@ts-common/json": "^0.3.1", - "@ts-common/source-map": "^0.5.0", - "@ts-common/string-map": "^0.3.0", - "tslib": "^1.9.3" - } - }, - "@ts-common/property-set": { - "version": "0.1.0", - "resolved": "https://registry.npmjs.org/@ts-common/property-set/-/property-set-0.1.0.tgz", - "integrity": "sha512-Mw/CPiksQI/Tvp8/bmne6ZYmOcgHuMOrflairbzdpfgMz7lrINFu8PyDQw6yTnIASeZR4yW0xljb66gCE4Jj0w==", + "create-require": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/create-require/-/create-require-1.1.1.tgz", + "integrity": "sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==", "dev": true }, - "@ts-common/source-map": { - "version": "0.5.0", - "resolved": "https://registry.npmjs.org/@ts-common/source-map/-/source-map-0.5.0.tgz", - "integrity": "sha512-aKFWvuN5uALt+hUtkPA4gHjtloDy2qHW1FB1r758KCTI0h0lP3dNJGcfwg7NnmD0qKQiZAY/J73/NYrbuTfT3A==", - "dev": true, - "requires": { - "@ts-common/iterator": "^0.3.0", - "@ts-common/json": "^0.3.0", - "@ts-common/property-set": "^0.1.0", - "@ts-common/string-map": "^0.3.0" - } - }, - "@ts-common/string-map": { - "version": "0.3.0", - "resolved": "https://registry.npmjs.org/@ts-common/string-map/-/string-map-0.3.0.tgz", - "integrity": "sha512-tikHtQPV/R48VAnlolyl1FIHciror68LXyruelvYf+lRE6ysjIGB2iNyw7wN6aDcUs2wN/CD6fF8Ye7lVIWNTQ==", - "dev": true, - "requires": { - "@ts-common/iterator": "^0.3.0" - } - }, - "@ts-common/virtual-fs": { - "version": "0.3.0", - "resolved": "https://registry.npmjs.org/@ts-common/virtual-fs/-/virtual-fs-0.3.0.tgz", - "integrity": "sha512-ryoXw52FTLhiexoNBA/hcAlW8gxPhrKEuZODgpCiF0wswNJdg/j+rCb9k1VppJdeIJ30b0Wg+2vPsrOrdnYTIw==", + "cross-spawn": { + "version": "6.0.5", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-6.0.5.tgz", + "integrity": "sha512-eTVLrBSt7fjbDygz805pMnstIs2VTBNkRm0qxZd+M7A5XDdxVRWO5MxGBXZhjY4cqLYLdtrGqRf8mBPmzwSpWQ==", "dev": true, "requires": { - "@ts-common/fs": "^0.2.0", - "@ts-common/iterator": "^0.3.0", - "@types/async-retry": "^1.4.1", - "@types/node-fetch": "^2.5.5", - "async-retry": "^1.3.1", - "node-fetch": "^2.6.0" + "nice-try": "^1.0.4", + "path-key": "^2.0.1", + "semver": "^5.5.0", + "shebang-command": "^1.2.0", + "which": "^1.2.9" } }, - "@types/async-retry": { - "version": "1.4.2", - "resolved": "https://registry.npmjs.org/@types/async-retry/-/async-retry-1.4.2.tgz", - "integrity": "sha512-GUDuJURF0YiJZ+CBjNQA0+vbP/VHlJbB0sFqkzsV7EcOPRfurVonXpXKAt3w8qIjM1TEzpz6hc6POocPvHOS3w==", + "debug": { + "version": "3.2.6", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.6.tgz", + "integrity": "sha512-mel+jf7nrtEl5Pn1Qx46zARXKDpBbvzezse7p7LqINmdoIk8PYP5SySaxEmYv6TZ0JyEKA1hsCId6DIhgITtWQ==", "dev": true, "requires": { - "@types/retry": "*" + "ms": "^2.1.1" } }, - "@types/commonmark": { - "version": "0.27.4", - "resolved": "https://registry.npmjs.org/@types/commonmark/-/commonmark-0.27.4.tgz", - "integrity": "sha512-7koSjp08QxKoS1/+3T15+kD7+vqOUvZRHvM8PutF3Xsk5aAEkdlIGRsHJ3/XsC3izoqTwBdRW/vH7rzCKkIicA==", + "decamelize": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/decamelize/-/decamelize-1.2.0.tgz", + "integrity": "sha1-9lNNFRSCabIDUue+4m9QH5oZEpA=", "dev": true }, - "@types/glob": { - "version": "7.1.3", - "resolved": "https://registry.npmjs.org/@types/glob/-/glob-7.1.3.tgz", - "integrity": "sha512-SEYeGAIQIQX8NN6LDKprLjbrd5dARM5EXsd8GI/A5l0apYI1fGMWgPHSe4ZKL4eozlAyI+doUE9XbYS4xCkQ1w==", + "define-properties": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.1.3.tgz", + "integrity": "sha512-3MqfYKj2lLzdMSf8ZIZE/V+Zuy+BgD6f164e8K2w7dgnpKArBDerGYpM46IYYcjnkdPNMjPk9A6VFB8+3SKlXQ==", "dev": true, "requires": { - "@types/minimatch": "*", - "@types/node": "*" + "object-keys": "^1.0.12" } }, - "@types/js-yaml": { - "version": "3.12.1", - "resolved": "https://registry.npmjs.org/@types/js-yaml/-/js-yaml-3.12.1.tgz", - "integrity": "sha512-SGGAhXLHDx+PK4YLNcNGa6goPf9XRWQNAUUbffkwVGGXIxmDKWyGGL4inzq2sPmExu431Ekb9aEMn9BkPqEYFA==", + "delayed-stream": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", + "integrity": "sha1-3zrhmayt+31ECqrgsp4icrJOxhk=", "dev": true }, - "@types/jsonpath": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/@types/jsonpath/-/jsonpath-0.2.0.tgz", - "integrity": "sha512-v7qlPA0VpKUlEdhghbDqRoKMxFB3h3Ch688TApBJ6v+XLDdvWCGLJIYiPKGZnS6MAOie+IorCfNYVHOPIHSWwQ==", + "diff": { + "version": "3.5.0", + "resolved": "https://registry.npmjs.org/diff/-/diff-3.5.0.tgz", + "integrity": "sha512-A46qtFgd+g7pDZinpnwiRJtxbC1hpgf0uzP3iG89scHk0AUC7A1TGxf5OiiOUv/JMZR8GOt8hL900hV0bOy5xA==", "dev": true }, - "@types/minimatch": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/@types/minimatch/-/minimatch-3.0.3.tgz", - "integrity": "sha512-tHq6qdbT9U1IRSGf14CL0pUlULksvY9OZ+5eEgl1N7t+OA3tGvNpxJCzuKQlsNgCVwbAs670L1vcVQi8j9HjnA==", + "emoji-regex": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-7.0.3.tgz", + "integrity": "sha512-CwBLREIQ7LvYFB0WyRvwhq5N5qPhc6PMjD6bYggFlI5YyDgl+0vxq5VHbMOFqLg7hfWzmu8T5Z1QofhmTIhItA==", "dev": true }, - "@types/mocha": { - "version": "5.2.7", - "resolved": "https://registry.npmjs.org/@types/mocha/-/mocha-5.2.7.tgz", - "integrity": "sha1-MV1XDMtWxTRS/4Y4c432BybVtuo=", - "dev": true + "end-of-stream": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/end-of-stream/-/end-of-stream-1.4.1.tgz", + "integrity": "sha512-1MkrZNvWTKCaigbn+W15elq2BB/L22nqrSY5DKlo3X6+vclJm8Bb5djXJBmEX6fS3+zCh/F4VBK5Z2KxJt4s2Q==", + "dev": true, + "requires": { + "once": "^1.4.0" + } }, - "@types/node": { - "version": "10.14.16", - "resolved": "https://registry.npmjs.org/@types/node/-/node-10.14.16.tgz", - "integrity": "sha512-/opXIbfn0P+VLt+N8DE4l8Mn8rbhiJgabU96ZJ0p9mxOkIks5gh6RUnpHak7Yh0SFkyjO/ODbxsQQPV2bpMmyA==", + "entities": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/entities/-/entities-1.1.2.tgz", + "integrity": "sha512-f2LZMYl1Fzu7YSBKg+RoROelpOaNrcGmE9AZubeDfrCEia483oW4MI4VyFd5VNHIgQ/7qm1I0wUHK1eJnn2y2w==", "dev": true }, - "@types/node-fetch": { - "version": "2.5.7", - "resolved": "https://registry.npmjs.org/@types/node-fetch/-/node-fetch-2.5.7.tgz", - "integrity": "sha512-o2WVNf5UhWRkxlf6eq+jMZDu7kjgpgJfl4xVNlvryc95O/6F2ld8ztKX+qu+Rjyet93WAWm5LjeX9H5FGkODvw==", + "es-abstract": { + "version": "1.13.0", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.13.0.tgz", + "integrity": "sha512-vDZfg/ykNxQVwup/8E1BZhVzFfBxs9NqMzGcvIJrqg5k2/5Za2bWo40dK2J1pgLngZ7c+Shh8lwYtLGyrwPutg==", "dev": true, "requires": { - "@types/node": "*", - "form-data": "^3.0.0" + "es-to-primitive": "^1.2.0", + "function-bind": "^1.1.1", + "has": "^1.0.3", + "is-callable": "^1.1.4", + "is-regex": "^1.0.4", + "object-keys": "^1.0.12" } }, - "@types/prettier": { - "version": "1.18.3", - "resolved": "https://registry.npmjs.org/@types/prettier/-/prettier-1.18.3.tgz", - "integrity": "sha512-48rnerQdcZ26odp+HOvDGX8IcUkYOCuMc2BodWYTe956MqkHlOGAG4oFQ83cjZ0a4GAgj7mb4GUClxYd2Hlodg==", - "dev": true + "es-to-primitive": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.0.tgz", + "integrity": "sha512-qZryBOJjV//LaxLTV6UC//WewneB3LcXOL9NP++ozKVXsIIIpm/2c13UDiD9Jp2eThsecw9m3jPqDwTyobcdbg==", + "dev": true, + "requires": { + "is-callable": "^1.1.4", + "is-date-object": "^1.0.1", + "is-symbol": "^1.0.2" + } }, - "@types/retry": { - "version": "0.12.0", - "resolved": "https://registry.npmjs.org/@types/retry/-/retry-0.12.0.tgz", - "integrity": "sha512-wWKOClTTiizcZhXnPY4wikVAwmdYHp8q6DmC+EJUzAMsycb7HB32Kh9RN4+0gExjmPmZSAQjgURXIGATPegAvA==", + "escape-string-regexp": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", + "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=", "dev": true }, - "abab": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/abab/-/abab-2.0.5.tgz", - "integrity": "sha512-9IK9EadsbHo6jLWIpxpR6pL0sazTXV6+SQv25ZB+F7Bj9mJNaOc4nCRabwd5M/JwmUa8idz6Eci6eKfJryPs6Q==", + "esprima": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz", + "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==", "dev": true }, - "abbrev": { - "version": "1.0.9", - "resolved": "https://registry.npmjs.org/abbrev/-/abbrev-1.0.9.tgz", - "integrity": "sha1-kbR5JYinc4wl813W9jdSovh3YTU=", - "dev": true + "execa": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/execa/-/execa-1.0.0.tgz", + "integrity": "sha512-adbxcyWV46qiHyvSp50TKt05tB4tK3HcmF7/nxfAdhnox83seTDbwnaqKO4sXRy7roHAIFqJP/Rw/AuEbX61LA==", + "dev": true, + "requires": { + "cross-spawn": "^6.0.0", + "get-stream": "^4.0.0", + "is-stream": "^1.1.0", + "npm-run-path": "^2.0.0", + "p-finally": "^1.0.0", + "signal-exit": "^3.0.0", + "strip-eof": "^1.0.0" + } }, - "acorn": { - "version": "5.7.4", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-5.7.4.tgz", - "integrity": "sha512-1D++VG7BhrtvQpNbBzovKNc1FLGGEE/oGe7b9xJm/RFHMBeUaUGpluV9RLjZa47YFdPcDAenEYuq9pQPcMdLJg==", - "dev": true + "find-up": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-3.0.0.tgz", + "integrity": "sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg==", + "dev": true, + "requires": { + "locate-path": "^3.0.0" + } }, - "acorn-globals": { - "version": "4.3.4", - "resolved": "https://registry.npmjs.org/acorn-globals/-/acorn-globals-4.3.4.tgz", - "integrity": "sha512-clfQEh21R+D0leSbUdWf3OcfqyaCSAQ8Ryq00bofSekfr9W8u1jyYZo6ir0xu9Gtcf7BjcHJpnbZH7JOCpP60A==", + "flat": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/flat/-/flat-4.1.0.tgz", + "integrity": "sha512-Px/TiLIznH7gEDlPXcUD4KnBusa6kR6ayRUVcnEAbreRIuhkqow/mun59BuRXwoYk7ZQOLW1ZM05ilIvK38hFw==", "dev": true, "requires": { - "acorn": "^6.0.1", - "acorn-walk": "^6.0.1" + "is-buffer": "~2.0.3" }, "dependencies": { - "acorn": { - "version": "6.4.2", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-6.4.2.tgz", - "integrity": "sha512-XtGIhXwF8YM8bJhGxG5kXgjkEuNGLTkoYqVE+KMR+aspr4KGYmKYg7yUe3KghyQ9yheNwLnjmzh/7+gfDBmHCQ==", + "is-buffer": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/is-buffer/-/is-buffer-2.0.3.tgz", + "integrity": "sha512-U15Q7MXTuZlrbymiz95PJpZxu8IlipAp4dtS3wOdgPXx3mqBnslrWU14kxfHB+Py/+2PVKSr37dMAgM2A4uArw==", "dev": true } } }, - "acorn-walk": { - "version": "6.2.0", - "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-6.2.0.tgz", - "integrity": "sha512-7evsyfH1cLOCdAzZAd43Cic04yKydNx0cF+7tiA19p1XnLLPU4dpCQOqpjqwokFe//vS0QqfqqjCS2JkiIs0cA==", - "dev": true - }, - "aggregate-error": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/aggregate-error/-/aggregate-error-3.1.0.tgz", - "integrity": "sha512-4I7Td01quW/RpocfNayFdFVk1qSuoh0E7JrbRJ16nH01HhKFQ88INq9Sd+nd72zqRySlr9BmDA8xlEJ6vJMrYA==", + "form-data": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/form-data/-/form-data-3.0.0.tgz", + "integrity": "sha512-CKMFDglpbMi6PyN+brwB9Q/GOw0eAnsrEZDgcsH5Krhz5Od/haKHAX0NmQfha2zPPz0JpWzA7GJHGSnvCRLWsg==", "dev": true, "requires": { - "clean-stack": "^2.0.0", - "indent-string": "^4.0.0" + "asynckit": "^0.4.0", + "combined-stream": "^1.0.8", + "mime-types": "^2.1.12" } }, - "ajv": { - "version": "6.12.6", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", - "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "format-util": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/format-util/-/format-util-1.0.3.tgz", + "integrity": "sha1-Ay3KShFiYqEsQ/TD7IVmQWxbLZU=", + "dev": true + }, + "front-matter": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/front-matter/-/front-matter-3.0.2.tgz", + "integrity": "sha512-iBGZaWyzqgsrPGsqrXZP6N4hp5FzSKDi18nfAoYpgz3qK5sAwFv/ojmn3VS60SOgLvq6CtojNqy0y6ZNz05IzQ==", "dev": true, "requires": { - "fast-deep-equal": "^3.1.1", - "fast-json-stable-stringify": "^2.0.0", - "json-schema-traverse": "^0.4.1", - "uri-js": "^4.2.2" + "js-yaml": "^3.13.1" } }, - "amdefine": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/amdefine/-/amdefine-1.0.1.tgz", - "integrity": "sha1-SlKCrBZHKek2Gbz9OtFR+BfOkfU=", - "dev": true, - "optional": true + "fs.realpath": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", + "integrity": "sha1-FQStJSMVjKpA20onh8sBQRmU6k8=", + "dev": true }, - "ansi-colors": { - "version": "3.2.3", - "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-3.2.3.tgz", - "integrity": "sha512-LEHHyuhlPY3TmuUYMh2oz89lTShfvgbmzaBcxve9t/9Wuy7Dwf4yoAKcND7KFT1HAQfqZ12qtc+DUrBMeKF9nw==", + "function-bind": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz", + "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==", "dev": true }, - "ansi-regex": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.0.tgz", - "integrity": "sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg==", + "get-caller-file": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz", + "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==", "dev": true }, - "ansi-styles": { - "version": "3.2.1", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", - "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", + "get-stream": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-4.1.0.tgz", + "integrity": "sha512-GMat4EJ5161kIy2HevLlr4luNjBgvmj413KaQA7jt4V8B4RDsfpHk7WQ9GVqfYyyx8OS/L66Kox+rJRNklLK7w==", "dev": true, "requires": { - "color-convert": "^1.9.0" + "pump": "^3.0.0" } }, - "append-transform": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/append-transform/-/append-transform-2.0.0.tgz", - "integrity": "sha512-7yeyCEurROLQJFv5Xj4lEGTy0borxepjFv1g22oAdqFu//SrAlDl1O1Nxx15SH1RoliUml6p8dwJW9jvZughhg==", + "growl": { + "version": "1.10.5", + "resolved": "https://registry.npmjs.org/growl/-/growl-1.10.5.tgz", + "integrity": "sha512-qBr4OuELkhPenW6goKVXiv47US3clb3/IbuWF9KNKEijAy9oeHxU9IgzjvJhHkUzhaj7rOUD7+YGWqUjLp5oSA==", + "dev": true + }, + "has": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz", + "integrity": "sha512-f2dvO0VU6Oej7RkWJGrehjbzMAjFp5/VKPp5tTpWIV4JHHZK1/BxbFRtf/siA2SWTe09caDmVtYYzWEIbBS4zw==", "dev": true, "requires": { - "default-require-extensions": "^3.0.0" + "function-bind": "^1.1.1" } }, - "archy": { + "has-symbols": { "version": "1.0.0", - "resolved": "https://registry.npmjs.org/archy/-/archy-1.0.0.tgz", - "integrity": "sha1-+cjBN1fMHde8N5rHeyxipcKGjEA=", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.0.tgz", + "integrity": "sha1-uhqPGvKg/DllD1yFA2dwQSIGO0Q=", "dev": true }, - "arg": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.1.tgz", - "integrity": "sha512-SlmP3fEA88MBv0PypnXZ8ZfJhwmDeIE3SP71j37AiXQBXYosPV0x6uISAaHYSlSVhmHOVkomen0tbGk6Anlebw==", + "he": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/he/-/he-1.2.0.tgz", + "integrity": "sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw==", "dev": true }, - "argparse": { - "version": "1.0.10", - "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", - "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", + "inflight": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", + "integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=", "dev": true, "requires": { - "sprintf-js": "~1.0.2" + "once": "^1.3.0", + "wrappy": "1" } }, - "arr-diff": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/arr-diff/-/arr-diff-4.0.0.tgz", - "integrity": "sha1-1kYQdP6/7HHn4VI1dhoyml3HxSA=", + "inherits": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", "dev": true }, - "arr-flatten": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/arr-flatten/-/arr-flatten-1.1.0.tgz", - "integrity": "sha512-L3hKV5R/p5o81R7O02IGnwpDmkp6E982XhtbuwSe3O4qOtMMMtodicASA1Cny2U+aCXcNpml+m4dPsvsJ3jatg==", + "is-callable": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.1.4.tgz", + "integrity": "sha512-r5p9sxJjYnArLjObpjA4xu5EKI3CuKHkJXMhT7kwbpUyIFD1n5PMAsoPvWnvtZiNz7LjkYDRZhd7FlI0eMijEA==", "dev": true }, - "arr-union": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/arr-union/-/arr-union-3.1.0.tgz", - "integrity": "sha1-45sJrqne+Gao8gbiiK9jkZuuOcQ=", + "is-date-object": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.0.1.tgz", + "integrity": "sha1-mqIOtq7rv/d/vTPnTKAbM1gdOhY=", "dev": true }, - "array-equal": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/array-equal/-/array-equal-1.0.0.tgz", - "integrity": "sha1-jCpe8kcv2ep0KwTHenUJO6J1fJM=", + "is-fullwidth-code-point": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", + "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=", "dev": true }, - "array-union": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/array-union/-/array-union-1.0.2.tgz", - "integrity": "sha1-mjRBDk9OPaI96jdb5b5w8kd47Dk=", + "is-regex": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.0.4.tgz", + "integrity": "sha1-VRdIm1RwkbCTDglWVM7SXul+lJE=", "dev": true, "requires": { - "array-uniq": "^1.0.1" + "has": "^1.0.1" } }, - "array-uniq": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/array-uniq/-/array-uniq-1.0.3.tgz", - "integrity": "sha1-r2rId6Jcx/dOBYiUdThY39sk/bY=", - "dev": true - }, - "array-unique": { - "version": "0.3.2", - "resolved": "https://registry.npmjs.org/array-unique/-/array-unique-0.3.2.tgz", - "integrity": "sha1-qJS3XUvE9s1nnvMkSp/Y9Gri1Cg=", + "is-stream": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-1.1.0.tgz", + "integrity": "sha1-EtSj3U5o4Lec6428hBc66A2RykQ=", "dev": true }, - "asn1": { - "version": "0.2.4", - "resolved": "https://registry.npmjs.org/asn1/-/asn1-0.2.4.tgz", - "integrity": "sha512-jxwzQpLQjSmWXgwaCZE9Nz+glAG01yF1QnWgbhGwHI5A6FRIEY6IVqtHhIepHqI7/kyEyQEagBC5mBEFlIYvdg==", + "is-symbol": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/is-symbol/-/is-symbol-1.0.2.tgz", + "integrity": "sha512-HS8bZ9ox60yCJLH9snBpIwv9pYUAkcuLhSA1oero1UB5y9aiQpRA8y2ex945AOtCZL1lJDeIk3G5LthswI46Lw==", "dev": true, "requires": { - "safer-buffer": "~2.1.0" + "has-symbols": "^1.0.0" } }, - "assert-plus": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/assert-plus/-/assert-plus-1.0.0.tgz", - "integrity": "sha1-8S4PPF13sLHN2RRpQuTpbB5N1SU=", - "dev": true - }, - "assign-symbols": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/assign-symbols/-/assign-symbols-1.0.0.tgz", - "integrity": "sha1-WWZ/QfrdTyDMvCu5a41Pf3jsA2c=", - "dev": true - }, - "async": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/async/-/async-1.0.0.tgz", - "integrity": "sha1-+PwEyjoTeErenhZBr5hXjPvWR6k=", - "dev": true - }, - "async-limiter": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/async-limiter/-/async-limiter-1.0.1.tgz", - "integrity": "sha512-csOlWGAcRFJaI6m+F2WKdnMKr4HhdhFVBk0H/QbJFMCr+uO2kwohwXQPxw/9OCxp05r5ghVBFSyioixx3gfkNQ==", + "isexe": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", + "integrity": "sha1-6PvzdNxVb/iUehDcsFctYz8s+hA=", "dev": true }, - "async-retry": { - "version": "1.3.1", - "resolved": "https://registry.npmjs.org/async-retry/-/async-retry-1.3.1.tgz", - "integrity": "sha512-aiieFW/7h3hY0Bq5d+ktDBejxuwR78vRu9hDUdR8rNhSaQ29VzPL4AoIRG7D/c7tdenwOcKvgPM6tIxB3cB6HA==", + "js-yaml": { + "version": "3.13.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.13.1.tgz", + "integrity": "sha512-YfbcO7jXDdyj0DGxYVSlSeQNHbD7XPWvrVWeVUujrQEoZzWJIRrCPoyk6kL6IAjAG2IolMK4T0hNUe0HOUs5Jw==", "dev": true, "requires": { - "retry": "0.12.0" + "argparse": "^1.0.7", + "esprima": "^4.0.0" } }, - "asynckit": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", - "integrity": "sha1-x57Zf380y48robyXkLzDZkdLS3k=", - "dev": true + "json-schema-ref-parser": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/json-schema-ref-parser/-/json-schema-ref-parser-6.1.0.tgz", + "integrity": "sha1-MK80rqtb7gQx2oBdrA6yG1dL9j0=", + "dev": true, + "requires": { + "call-me-maybe": "^1.0.1", + "js-yaml": "^3.12.1", + "ono": "^4.0.11" + } }, - "atob": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/atob/-/atob-2.1.2.tgz", - "integrity": "sha512-Wm6ukoaOGJi/73p/cl2GvLjTI5JM1k/O14isD73YML8StrH/7/lRFgmg8nICZgD3bZZvjwCGxtMOD3wWNAu8cg==", - "dev": true + "locate-path": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-3.0.0.tgz", + "integrity": "sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A==", + "dev": true, + "requires": { + "p-locate": "^3.0.0", + "path-exists": "^3.0.0" + } }, - "atob-lite": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/atob-lite/-/atob-lite-2.0.0.tgz", - "integrity": "sha1-D+9a1G8b16hQLGVyfwNn1e5D1pY=", + "lodash": { + "version": "4.17.21", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", + "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", "dev": true }, - "autorest": { - "version": "2.0.4413", - "resolved": "https://registry.npmjs.org/autorest/-/autorest-2.0.4413.tgz", - "integrity": "sha512-Ttx/O6Yag5q8fpJDvllgf/joLuVPBySkbAqDF7+9jAmscCPQplYjA9H/N12bwkhh+6YR3ugWZHQq3NTN33hkAg==", - "dev": true + "log-symbols": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/log-symbols/-/log-symbols-2.2.0.tgz", + "integrity": "sha512-VeIAFslyIerEJLXHziedo2basKbMKtTw3vfn5IzG0XTjhAVEJyNHnL2p7vc+wBDSdQuUpNw3M2u6xb9QsAY5Eg==", + "dev": true, + "requires": { + "chalk": "^2.0.1" + } }, - "aws-sign2": { - "version": "0.7.0", - "resolved": "https://registry.npmjs.org/aws-sign2/-/aws-sign2-0.7.0.tgz", - "integrity": "sha1-tG6JCTSpWR8tL2+G1+ap8bP+dqg=", + "make-error": { + "version": "1.3.6", + "resolved": "https://registry.npmjs.org/make-error/-/make-error-1.3.6.tgz", + "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==", "dev": true }, - "aws4": { - "version": "1.11.0", - "resolved": "https://registry.npmjs.org/aws4/-/aws4-1.11.0.tgz", - "integrity": "sha512-xh1Rl34h6Fi1DC2WWKfxUTVqRsNnr6LsKz2+hfwDxQJWmrx8+c7ylaqBMcHfl1U1r2dsifOvKX3LQuLNZ+XSvA==", - "dev": true + "map-age-cleaner": { + "version": "0.1.3", + "resolved": "https://registry.npmjs.org/map-age-cleaner/-/map-age-cleaner-0.1.3.tgz", + "integrity": "sha512-bJzx6nMoP6PDLPBFmg7+xRKeFZvFboMrGlxmNj9ClvX53KrmvM5bXFXEWjbz4cz1AFn+jWJ9z/DJSz7hrs0w3w==", + "dev": true, + "requires": { + "p-defer": "^1.0.0" + } }, - "balanced-match": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.0.tgz", - "integrity": "sha1-ibTRmasr7kneFk6gK4nORi1xt2c=", + "mdurl": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-1.0.1.tgz", + "integrity": "sha1-/oWy7HWlkDfyrf7BAP1sYBdhFS4=", "dev": true }, - "base": { - "version": "0.11.2", - "resolved": "https://registry.npmjs.org/base/-/base-0.11.2.tgz", - "integrity": "sha512-5T6P4xPgpp0YDFvSWwEZ4NoE3aM4QBQXDzmVbraCkFj8zHM+mba8SyqB5DbZWyR7mYHo6Y7BdQo3MoA4m0TeQg==", + "mem": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/mem/-/mem-4.3.0.tgz", + "integrity": "sha512-qX2bG48pTqYRVmDB37rn/6PT7LcR8T7oAX3bf99u1Tt1nzxYfxkgqDwUwolPlXweM0XzBOBFzSx4kfp7KP1s/w==", "dev": true, "requires": { - "cache-base": "^1.0.1", - "class-utils": "^0.3.5", - "component-emitter": "^1.2.1", - "define-property": "^1.0.0", - "isobject": "^3.0.1", - "mixin-deep": "^1.2.0", - "pascalcase": "^0.1.1" - }, - "dependencies": { - "define-property": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/define-property/-/define-property-1.0.0.tgz", - "integrity": "sha1-dp66rz9KY6rTr56NMEybvnm/sOY=", - "dev": true, - "requires": { - "is-descriptor": "^1.0.0" - } - }, - "is-accessor-descriptor": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-accessor-descriptor/-/is-accessor-descriptor-1.0.0.tgz", - "integrity": "sha512-m5hnHTkcVsPfqx3AKlyttIPb7J+XykHvJP2B9bZDjlhLIoEq4XoK64Vg7boZlVWYK6LUY94dYPEE7Lh0ZkZKcQ==", - "dev": true, - "requires": { - "kind-of": "^6.0.0" - } - }, - "is-data-descriptor": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-data-descriptor/-/is-data-descriptor-1.0.0.tgz", - "integrity": "sha512-jbRXy1FmtAoCjQkVmIVYwuuqDFUbaOeDjmed1tOGPrsMhtJA4rD9tkgA0F1qJ3gRFRXcHYVkdeaP50Q5rE/jLQ==", - "dev": true, - "requires": { - "kind-of": "^6.0.0" - } - }, - "is-descriptor": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/is-descriptor/-/is-descriptor-1.0.2.tgz", - "integrity": "sha512-2eis5WqQGV7peooDyLmNEPUrps9+SXX5c9pL3xEB+4e9HnGuDa7mB7kHxHw4CbqS9k1T2hOH3miL8n8WtiYVtg==", - "dev": true, - "requires": { - "is-accessor-descriptor": "^1.0.0", - "is-data-descriptor": "^1.0.0", - "kind-of": "^6.0.2" - } - } + "map-age-cleaner": "^0.1.1", + "mimic-fn": "^2.0.0", + "p-is-promise": "^2.0.0" } }, - "bcrypt-pbkdf": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/bcrypt-pbkdf/-/bcrypt-pbkdf-1.0.2.tgz", - "integrity": "sha1-pDAdOJtqQ/m2f/PKEaP2Y342Dp4=", + "mime-db": { + "version": "1.44.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.44.0.tgz", + "integrity": "sha512-/NOTfLrsPBVeH7YtFPgsVWveuL+4SjjYxaQ1xtM1KMFj7HdxlBlxeyNLzhyJVx7r4rZGJAZ/6lkKCitSc/Nmpg==", + "dev": true + }, + "mime-types": { + "version": "2.1.27", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.27.tgz", + "integrity": "sha512-JIhqnCasI9yD+SsmkquHBxTSEuZdQX5BuQnS2Vc7puQQQ+8yiP5AY5uWhpdv4YL4VM5c6iliiYWPgJ/nJQLp7w==", "dev": true, "requires": { - "tweetnacl": "^0.14.3" + "mime-db": "1.44.0" } }, - "before-after-hook": { + "mimic-fn": { "version": "2.1.0", - "resolved": "https://registry.npmjs.org/before-after-hook/-/before-after-hook-2.1.0.tgz", - "integrity": "sha512-IWIbu7pMqyw3EAJHzzHbWa85b6oud/yfKYg5rqB5hNE8CeMi3nX+2C2sj0HswfblST86hpVEOAb9x34NZd6P7A==", + "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz", + "integrity": "sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==", "dev": true }, - "brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "minimatch": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz", + "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==", "dev": true, "requires": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" + "brace-expansion": "^1.1.7" } }, - "braces": { - "version": "2.3.2", - "resolved": "https://registry.npmjs.org/braces/-/braces-2.3.2.tgz", - "integrity": "sha512-aNdbnj9P8PjdXU4ybaWLK2IF3jc/EoDYbC7AazW6to3TRsfXxscC9UXOB5iDiEQrkyIbWp2SLQda4+QAa7nc3w==", + "minimist": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz", + "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==", + "dev": true + }, + "mkdirp": { + "version": "0.5.1", + "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.1.tgz", + "integrity": "sha1-MAV0OOrGz3+MR2fzhkjWaX11yQM=", "dev": true, "requires": { - "arr-flatten": "^1.1.0", - "array-unique": "^0.3.2", - "extend-shallow": "^2.0.1", - "fill-range": "^4.0.0", - "isobject": "^3.0.1", - "repeat-element": "^1.1.2", - "snapdragon": "^0.8.1", - "snapdragon-node": "^2.0.1", - "split-string": "^3.0.2", - "to-regex": "^3.0.1" + "minimist": "0.0.8" }, "dependencies": { - "extend-shallow": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz", - "integrity": "sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=", - "dev": true, - "requires": { - "is-extendable": "^0.1.0" - } + "minimist": { + "version": "0.0.8", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-0.0.8.tgz", + "integrity": "sha1-hX/Kv8M5fSYluCKCYuhqp6ARsF0=", + "dev": true } } }, - "browser-process-hrtime": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/browser-process-hrtime/-/browser-process-hrtime-1.0.0.tgz", - "integrity": "sha512-9o5UecI3GhkpM6DrXr69PblIuWxPKk9Y0jHBRhdocZ2y7YECBFCsHm79Pr3OyR2AvjhDkabFJaDJMYRazHgsow==", - "dev": true - }, - "browser-stdout": { - "version": "1.3.1", - "resolved": "https://registry.npmjs.org/browser-stdout/-/browser-stdout-1.3.1.tgz", - "integrity": "sha512-qhAVI1+Av2X7qelOfAIYwXONood6XlZE/fXaBSmW/T5SzLAmCgzi+eiWE7fUvbHaeNBQH13UftjpXxsfLkMpgw==", - "dev": true - }, - "btoa-lite": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/btoa-lite/-/btoa-lite-1.0.0.tgz", - "integrity": "sha1-M3dm2hWAEhD92VbCLpxokaudAzc=", - "dev": true - }, - "buffer-from": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.1.tgz", - "integrity": "sha512-MQcXEUbCKtEo7bhqEs6560Hyd4XaovZlO/k9V3hjVUF/zwW7KBVdSK4gIt/bzwS9MbR5qob+F5jusZsb0YQK2A==", - "dev": true - }, - "cache-base": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/cache-base/-/cache-base-1.0.1.tgz", - "integrity": "sha512-AKcdTnFSWATd5/GCPRxr2ChwIJ85CeyrEyjRHlKxQ56d4XJMGym0uAiKn0xbLOGOl3+yRpOTi484dVCEc5AUzQ==", - "dev": true, - "requires": { - "collection-visit": "^1.0.0", - "component-emitter": "^1.2.1", - "get-value": "^2.0.6", - "has-value": "^1.0.0", - "isobject": "^3.0.1", - "set-value": "^2.0.0", - "to-object-path": "^0.3.0", - "union-value": "^1.0.0", - "unset-value": "^1.0.0" - } - }, - "caching-transform": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/caching-transform/-/caching-transform-4.0.0.tgz", - "integrity": "sha512-kpqOvwXnjjN44D89K5ccQC+RUrsy7jB/XLlRrx0D7/2HNcTPqzsb6XgYoErwko6QsV184CA2YgS1fxDiiDZMWA==", - "dev": true, - "requires": { - "hasha": "^5.0.0", - "make-dir": "^3.0.0", - "package-hash": "^4.0.0", - "write-file-atomic": "^3.0.0" - } - }, - "call-me-maybe": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/call-me-maybe/-/call-me-maybe-1.0.1.tgz", - "integrity": "sha1-JtII6onje1y95gJQoV8DHBak1ms=", - "dev": true - }, - "camelcase": { - "version": "5.3.1", - "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-5.3.1.tgz", - "integrity": "sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg==", - "dev": true - }, - "caseless": { - "version": "0.12.0", - "resolved": "https://registry.npmjs.org/caseless/-/caseless-0.12.0.tgz", - "integrity": "sha1-G2gcIf+EAzyCZUMJBolCDRhxUdw=", - "dev": true - }, - "chalk": { - "version": "2.4.2", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", - "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", - "dev": true, - "requires": { - "ansi-styles": "^3.2.1", - "escape-string-regexp": "^1.0.5", - "supports-color": "^5.3.0" - }, - "dependencies": { - "has-flag": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", - "integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0=", - "dev": true - }, - "supports-color": { - "version": "5.5.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", - "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", - "dev": true, - "requires": { - "has-flag": "^3.0.0" - } - } - } - }, - "class-utils": { - "version": "0.3.6", - "resolved": "https://registry.npmjs.org/class-utils/-/class-utils-0.3.6.tgz", - "integrity": "sha512-qOhPa/Fj7s6TY8H8esGu5QNpMMQxz79h+urzrNYN6mn+9BnxlDGf5QZ+XeCDsxSjPqsSR56XOZOJmpeurnLMeg==", - "dev": true, - "requires": { - "arr-union": "^3.1.0", - "define-property": "^0.2.5", - "isobject": "^3.0.0", - "static-extend": "^0.1.1" - }, - "dependencies": { - "define-property": { - "version": "0.2.5", - "resolved": "https://registry.npmjs.org/define-property/-/define-property-0.2.5.tgz", - "integrity": "sha1-w1se+RjsPJkPmlvFe+BKrOxcgRY=", - "dev": true, - "requires": { - "is-descriptor": "^0.1.0" - } - } - } - }, - "clean-stack": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/clean-stack/-/clean-stack-2.2.0.tgz", - "integrity": "sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A==", - "dev": true - }, - "cliui": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/cliui/-/cliui-6.0.0.tgz", - "integrity": "sha512-t6wbgtoCXvAzst7QgXxJYqPt0usEfbgQdftEPbLL/cvv6HPE5VgvqCuAIDR0NgU52ds6rFwqrgakNLrHEjCbrQ==", - "dev": true, - "requires": { - "string-width": "^4.2.0", - "strip-ansi": "^6.0.0", - "wrap-ansi": "^6.2.0" - }, - "dependencies": { - "ansi-regex": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz", - "integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==", - "dev": true - }, - "emoji-regex": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", - "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", - "dev": true - }, - "is-fullwidth-code-point": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", - "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", - "dev": true - }, - "string-width": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.0.tgz", - "integrity": "sha512-zUz5JD+tgqtuDjMhwIg5uFVV3dtqZ9yQJlZVfq4I01/K5Paj5UHj7VyrQOJvzawSVlKpObApbfD0Ed6yJc+1eg==", - "dev": true, - "requires": { - "emoji-regex": "^8.0.0", - "is-fullwidth-code-point": "^3.0.0", - "strip-ansi": "^6.0.0" - } - }, - "strip-ansi": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.0.tgz", - "integrity": "sha512-AuvKTrTfQNYNIctbR1K/YGTR1756GycPsg7b9bdV9Duqur4gv6aKqHXah67Z8ImS7WEz5QVcOtlfW2rZEugt6w==", - "dev": true, - "requires": { - "ansi-regex": "^5.0.0" - } - } - } - }, - "clone-deep": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/clone-deep/-/clone-deep-4.0.1.tgz", - "integrity": "sha512-neHB9xuzh/wk0dIHweyAXv2aPGZIVk3pLMe+/RNzINf17fe0OG96QroktYAUm7SM1PBnzTabaLboqqxDyMU+SQ==", - "dev": true, - "requires": { - "is-plain-object": "^2.0.4", - "kind-of": "^6.0.2", - "shallow-clone": "^3.0.0" - }, - "dependencies": { - "is-plain-object": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-2.0.4.tgz", - "integrity": "sha512-h5PpgXkWitc38BBMYawTYMWJHFZJVnBquFE57xFpjB8pJFiF6gZ+bU+WyI/yqXiFR5mdLsgYNaPe8uao6Uv9Og==", - "dev": true, - "requires": { - "isobject": "^3.0.1" - } - } - } - }, - "code-point-at": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/code-point-at/-/code-point-at-1.1.0.tgz", - "integrity": "sha1-DQcLTQQ6W+ozovGkDi7bPZpMz3c=", - "dev": true - }, - "collection-visit": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/collection-visit/-/collection-visit-1.0.0.tgz", - "integrity": "sha1-S8A3PBZLwykbTTaMgpzxqApZ3KA=", - "dev": true, - "requires": { - "map-visit": "^1.0.0", - "object-visit": "^1.0.0" - } - }, - "color": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/color/-/color-3.0.0.tgz", - "integrity": "sha512-jCpd5+s0s0t7p3pHQKpnJ0TpQKKdleP71LWcA0aqiljpiuAkOSUFN/dyH8ZwF0hRmFlrIuRhufds1QyEP9EB+w==", - "dev": true, - "requires": { - "color-convert": "^1.9.1", - "color-string": "^1.5.2" - } - }, - "color-convert": { - "version": "1.9.3", - "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", - "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", - "dev": true, - "requires": { - "color-name": "1.1.3" - } - }, - "color-name": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", - "integrity": "sha1-p9BVi9icQveV3UIyj3QIMcpTvCU=", - "dev": true - }, - "color-string": { - "version": "1.5.4", - "resolved": "https://registry.npmjs.org/color-string/-/color-string-1.5.4.tgz", - "integrity": "sha512-57yF5yt8Xa3czSEW1jfQDE79Idk0+AkN/4KWad6tbdxUmAs3MvjxlWSWD4deYytcRfoZ9nhKyFl1kj5tBvidbw==", - "dev": true, - "requires": { - "color-name": "^1.0.0", - "simple-swizzle": "^0.2.2" - } - }, - "colors": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/colors/-/colors-1.0.3.tgz", - "integrity": "sha1-BDP0TYCWgP3rYO0mDxsMJi6CpAs=", - "dev": true - }, - "colorspace": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/colorspace/-/colorspace-1.1.2.tgz", - "integrity": "sha512-vt+OoIP2d76xLhjwbBaucYlNSpPsrJWPlBTtwCpQKIu6/CSMutyzX93O/Do0qzpH3YoHEes8YEFXyZ797rEhzQ==", - "dev": true, - "requires": { - "color": "3.0.x", - "text-hex": "1.0.x" - } - }, - "combined-stream": { - "version": "1.0.8", - "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", - "integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==", - "dev": true, - "requires": { - "delayed-stream": "~1.0.0" - } - }, - "commander": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/commander/-/commander-4.1.1.tgz", - "integrity": "sha512-NOKm8xhkzAjzFx8B2v5OAHT+u5pRQc2UCa2Vq9jYL/31o2wi9mxBA7LIFs3sV5VSC49z6pEhfbMULvShKj26WA==", - "dev": true - }, - "comment-json": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/comment-json/-/comment-json-1.1.3.tgz", - "integrity": "sha1-aYbDMw/uDEyeAMI5jNYa+l2PI54=", - "dev": true, - "requires": { - "json-parser": "^1.0.0" - } - }, - "commondir": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/commondir/-/commondir-1.0.1.tgz", - "integrity": "sha1-3dgA2gxmEnOTzKWVDqloo6rxJTs=", - "dev": true - }, - "commonmark": { - "version": "0.29.2", - "resolved": "https://registry.npmjs.org/commonmark/-/commonmark-0.29.2.tgz", - "integrity": "sha512-spe43MvEIaPpHss1T7z4yQaFQfLGmMu+yvCwv6xqhELIwkG/ZGgDpxOPzKxnuYzYT2c+aziCCc8m2rBVLA7jUA==", - "dev": true, - "requires": { - "entities": "~2.0", - "mdurl": "~1.0.1", - "minimist": ">=1.2.2", - "string.prototype.repeat": "^0.2.0" - }, - "dependencies": { - "entities": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/entities/-/entities-2.0.3.tgz", - "integrity": "sha512-MyoZ0jgnLvB2X3Lg5HqpFmn1kybDiIfEQmKzTb5apr51Rb+T3KdmMiqa70T+bhGnyv7bQ6WMj2QMHpGMmlrUYQ==", - "dev": true - } - } - }, - "component-emitter": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/component-emitter/-/component-emitter-1.3.0.tgz", - "integrity": "sha512-Rd3se6QB+sO1TwqZjscQrurpEPIfO0/yYnSin6Q/rD3mOutHvUrCAhJub3r90uNb+SESBuE0QYoB90YdfatsRg==", - "dev": true - }, - "concat-map": { - "version": "0.0.1", - "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", - "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=", - "dev": true - }, - "configstore": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/configstore/-/configstore-5.0.0.tgz", - "integrity": "sha512-eE/hvMs7qw7DlcB5JPRnthmrITuHMmACUJAp89v6PT6iOqzoLS7HRWhBtuHMlhNHo2AhUSA/3Dh1bKNJHcublQ==", - "dev": true, - "requires": { - "dot-prop": "^5.1.0", - "graceful-fs": "^4.1.2", - "make-dir": "^3.0.0", - "unique-string": "^2.0.0", - "write-file-atomic": "^3.0.0", - "xdg-basedir": "^4.0.0" - } - }, - "convert-source-map": { - "version": "1.7.0", - "resolved": "https://registry.npmjs.org/convert-source-map/-/convert-source-map-1.7.0.tgz", - "integrity": "sha512-4FJkXzKXEDB1snCFZlLP4gpC3JILicCpGbzG9f9G7tGqGCzETQ2hWPrcinA9oU4wtf2biUaEH5065UnMeR33oA==", - "dev": true, - "requires": { - "safe-buffer": "~5.1.1" - } - }, - "cookiejar": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/cookiejar/-/cookiejar-2.1.2.tgz", - "integrity": "sha512-Mw+adcfzPxcPeI+0WlvRrr/3lGVO0bD75SxX6811cxSh1Wbxx7xZBGK1eVtDf6si8rg2lhnUjsVLMFMfbRIuwA==", - "dev": true - }, - "copy-descriptor": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/copy-descriptor/-/copy-descriptor-0.1.1.tgz", - "integrity": "sha1-Z29us8OZl8LuGsOpJP1hJHSPV40=", - "dev": true - }, - "core-js": { - "version": "2.6.12", - "resolved": "https://registry.npmjs.org/core-js/-/core-js-2.6.12.tgz", - "integrity": "sha512-Kb2wC0fvsWfQrgk8HU5lW6U/Lcs8+9aaYcy4ZFc6DDlo4nZ7n70dEgE5rtR0oG6ufKDUnrwfWL1mXR5ljDatrQ==", - "dev": true - }, - "core-util-is": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz", - "integrity": "sha1-tf1UIgqivFq1eqtxQMlAdUUDwac=", - "dev": true - }, - "cross-spawn": { - "version": "6.0.5", - "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-6.0.5.tgz", - "integrity": "sha512-eTVLrBSt7fjbDygz805pMnstIs2VTBNkRm0qxZd+M7A5XDdxVRWO5MxGBXZhjY4cqLYLdtrGqRf8mBPmzwSpWQ==", - "dev": true, - "requires": { - "nice-try": "^1.0.4", - "path-key": "^2.0.1", - "semver": "^5.5.0", - "shebang-command": "^1.2.0", - "which": "^1.2.9" - } - }, - "crypto-random-string": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/crypto-random-string/-/crypto-random-string-2.0.0.tgz", - "integrity": "sha512-v1plID3y9r/lPhviJ1wrXpLeyUIGAZ2SHNYTEapm7/8A9nLPoyvVp3RK/EPFqn5kEznyWgYZNsRtYYIWbuG8KA==", - "dev": true - }, - "cspell": { - "version": "4.0.30", - "resolved": "https://registry.npmjs.org/cspell/-/cspell-4.0.30.tgz", - "integrity": "sha512-dazX00rCgRSL8TAphqFSw7D9p3QdBGh09J8/bFH+hLpz01Yry/XzXjDiyKPlAXFkeFH5Sikgq0Cy/t3cHaLBeQ==", - "dev": true, - "requires": { - "chalk": "^2.4.2", - "commander": "^2.20.0", - "comment-json": "^1.1.3", - "cspell-glob": "^0.1.11", - "cspell-lib": "^4.1.0", - "fs-extra": "^8.1.0", - "gensequence": "^2.1.2", - "get-stdin": "^7.0.0", - "glob": "^7.1.4", - "minimatch": "^3.0.4" - }, - "dependencies": { - "commander": { - "version": "2.20.0", - "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.0.tgz", - "integrity": "sha512-7j2y+40w61zy6YC2iRNpUe/NwhNyoXrYpHMrSunaMG64nRnaf96zO/KMQR4OyN/UnE5KLyEBnKHd4aG3rskjpQ==", - "dev": true - }, - "fs-extra": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-8.1.0.tgz", - "integrity": "sha512-yhlQgA6mnOJUKOsRUFsgJdQCvkKhcz8tlZG5HBQfReYZy46OwLcY+Zia0mtdHsOo9y/hP+CxMN0TU9QxoOtG4g==", - "dev": true, - "requires": { - "graceful-fs": "^4.2.0", - "jsonfile": "^4.0.0", - "universalify": "^0.1.0" - } - } - } - }, - "cspell-dict-companies": { - "version": "1.0.15", - "resolved": "https://registry.npmjs.org/cspell-dict-companies/-/cspell-dict-companies-1.0.15.tgz", - "integrity": "sha512-IS3rnqkkZhgyKVsure5g+88q3PyLpgZw3xRB3Fo2W30NgoNW2Zpbh4/H6NR839f94IX2/qUvM/zanQy0B7ogMQ==", - "dev": true, - "requires": { - "configstore": "^5.0.0" - } - }, - "cspell-dict-cpp": { - "version": "1.1.23", - "resolved": "https://registry.npmjs.org/cspell-dict-cpp/-/cspell-dict-cpp-1.1.23.tgz", - "integrity": "sha512-vR24jdt3oCE51sfrTPEmzlw1JVltKNkUnS/1kjeauY5VAQjx04Q1XOBPHJHmTNRXdmcX/MvNFR8z3qbpC2pbMA==", - "dev": true, - "requires": { - "configstore": "^5.0.0" - } - }, - "cspell-dict-django": { - "version": "1.0.12", - "resolved": "https://registry.npmjs.org/cspell-dict-django/-/cspell-dict-django-1.0.12.tgz", - "integrity": "sha512-ChBzWNltlqIs7FSYjQV6qTdkxt4VFQJm2XGlfIoNUZ1kwrOpzVdEUuVpRhWtj9NVB6AJqJxWjm/HzVvMYEY2cg==", - "dev": true, - "requires": { - "configstore": "^5.0.0" - } - }, - "cspell-dict-elixir": { - "version": "1.0.10", - "resolved": "https://registry.npmjs.org/cspell-dict-elixir/-/cspell-dict-elixir-1.0.10.tgz", - "integrity": "sha512-Z+9K1ZHGo5XnbS2AZ5DG2bpEA9wJ4BdsTa69VIqPgZ6vEfVLqeMidk70FF0Y/DY49+Qyg3ngY0WyE5Je/Romzw==", - "dev": true, - "requires": { - "configstore": "^5.0.0" - } - }, - "cspell-dict-en-gb": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/cspell-dict-en-gb/-/cspell-dict-en-gb-1.1.11.tgz", - "integrity": "sha512-UnmAeMDzf/YeXuI85BIaQzpArXlt+m+I9S9uy88nvUfq6goOfUFN8Axh0idDtqsFNoaMS5TgSzvjP7DgMXArYg==", - "dev": true, - "requires": { - "configstore": "^5.0.0" - } - }, - "cspell-dict-en_us": { - "version": "1.2.18", - "resolved": "https://registry.npmjs.org/cspell-dict-en_us/-/cspell-dict-en_us-1.2.18.tgz", - "integrity": "sha512-P2TRblBVd9KOfwjvI5mxzEXMGBvvTIfqcKSQ+0RbpwC2S4ImW9k++LYxy9LtfSRmdSGjHbejYYtsrgvId1KcoA==", - "dev": true, - "requires": { - "configstore": "^5.0.0" - } - }, - "cspell-dict-fullstack": { - "version": "1.0.18", - "resolved": "https://registry.npmjs.org/cspell-dict-fullstack/-/cspell-dict-fullstack-1.0.18.tgz", - "integrity": "sha512-vEVf+ppML1PP9vdfkXnydABIYNyDORVN28sniBo0ILLhqFjCJvs1SNQuZxWhak5sgSZ9z4xiHU9TqCEUqhf1jw==", - "dev": true, - "requires": { - "configstore": "^5.0.0" - } - }, - "cspell-dict-golang": { - "version": "1.1.12", - "resolved": "https://registry.npmjs.org/cspell-dict-golang/-/cspell-dict-golang-1.1.12.tgz", - "integrity": "sha512-G3D5CIJfwPdzpgM/N5d/9hImG637GHn3FUkPzC3Kz1QN2G6JTwTAYPnsKybvLE80U9PUwrylZTZBM+cRZSWPzQ==", - "dev": true, - "requires": { - "configstore": "^5.0.0" - } - }, - "cspell-dict-haskell": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/cspell-dict-haskell/-/cspell-dict-haskell-1.0.2.tgz", - "integrity": "sha512-d+pFdRUGZjusiXRqWW05pZqeFKsR5Nvrp/8qlowp/mwNFRBoMzrrAHnP7DZrfo/zHHpzCR3SnmT0ImnCv2MDcQ==", - "dev": true, - "requires": { - "configstore": "^5.0.0" - } - }, - "cspell-dict-html-symbol-entities": { - "version": "1.0.11", - "resolved": "https://registry.npmjs.org/cspell-dict-html-symbol-entities/-/cspell-dict-html-symbol-entities-1.0.11.tgz", - "integrity": "sha512-8uqZOa+8jDg/FH1LPfwfgOWT/0+3CXPWoWf4t+SjEhNVRoih2HVweQZCwVr+CsmEHgVON8Tem3OWwz+e1zJwNA==", - "dev": true, - "requires": { - "configstore": "^5.0.0" - } - }, - "cspell-dict-java": { - "version": "1.0.10", - "resolved": "https://registry.npmjs.org/cspell-dict-java/-/cspell-dict-java-1.0.10.tgz", - "integrity": "sha512-GKgJ+HSii7Xp+LT0Gajy4ipcQgapwsM3fmmZS6pZBZMoodJ0BRzga6QZrBuJSHVhSBV4rFIPJwI4oBGYZCGSpQ==", - "dev": true, - "requires": { - "configstore": "^5.0.0" - } - }, - "cspell-dict-latex": { - "version": "1.0.11", - "resolved": "https://registry.npmjs.org/cspell-dict-latex/-/cspell-dict-latex-1.0.11.tgz", - "integrity": "sha512-z/mejOvZAHIL76wnk7i/RT1v1IkSCYlk1l8pLW8l/KA76MCdNAB5xA6zfyBCftbhEOBJA9Fx60JU2T2aba4isg==", - "dev": true, - "requires": { - "configstore": "^5.0.0" - } - }, - "cspell-dict-lorem-ipsum": { - "version": "1.0.10", - "resolved": "https://registry.npmjs.org/cspell-dict-lorem-ipsum/-/cspell-dict-lorem-ipsum-1.0.10.tgz", - "integrity": "sha512-UlboQ3xH+D3l+hemLO4J5yz8EM60SH91f1dJIy2s94AeePZXtwYh1hTFM5dEsXI2CAQkfTu3ZdPWflLsInPfrA==", - "dev": true, - "requires": { - "configstore": "^5.0.0" - } - }, - "cspell-dict-php": { - "version": "1.0.11", - "resolved": "https://registry.npmjs.org/cspell-dict-php/-/cspell-dict-php-1.0.11.tgz", - "integrity": "sha512-0aC8PWVqEVg5II9+U9DBcUv6k9x1DpclH7l5cbvoiR8u69O/LnVlnSol1nSdzAwBhC6fWQ9mfOiMyDIHNZ2GfA==", - "dev": true, - "requires": { - "configstore": "^5.0.0" - } - }, - "cspell-dict-powershell": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/cspell-dict-powershell/-/cspell-dict-powershell-1.0.3.tgz", - "integrity": "sha512-YHVe8NkjtZmBvdclXev7dkoTODxweiq8H/Z8N0H5jc8pW1IJGBIXIFxlk1AjRW3bS19D5OZIx13J8ims6i5s8w==", - "dev": true, - "requires": { - "configstore": "^5.0.0" - } - }, - "cspell-dict-python": { - "version": "1.0.14", - "resolved": "https://registry.npmjs.org/cspell-dict-python/-/cspell-dict-python-1.0.14.tgz", - "integrity": "sha512-w8kevjvayndKkZqY4yt877UzGXUNTG6gB0zoeOCVxnAFFqTexVvmJ9Johc+eOdqd+dnUu6gF8XfX4ZdX5J+Rxw==", - "dev": true, - "requires": { - "configstore": "^5.0.0" - } - }, - "cspell-dict-rust": { - "version": "1.0.10", - "resolved": "https://registry.npmjs.org/cspell-dict-rust/-/cspell-dict-rust-1.0.10.tgz", - "integrity": "sha512-iwWMVqOMnkTtb2Z50pGs+x9HM6ghqVotVguqgeJUVD62gqjHMHOTXAw/p7e8VFMXEPfVJeCZg3KGT3Ut6b+8Zg==", - "dev": true, - "requires": { - "configstore": "^5.0.0" - } - }, - "cspell-dict-scala": { - "version": "1.0.9", - "resolved": "https://registry.npmjs.org/cspell-dict-scala/-/cspell-dict-scala-1.0.9.tgz", - "integrity": "sha512-wWMjYe4OLFqeQpHYqBoAlXCwEgANu4DuJIg8Vg9Ig8arzobWX9uzmSwsicyGKtCjyno99/MIHAhksTTr7ccMzQ==", - "dev": true, - "requires": { - "configstore": "^5.0.0" - } - }, - "cspell-glob": { - "version": "0.1.11", - "resolved": "https://registry.npmjs.org/cspell-glob/-/cspell-glob-0.1.11.tgz", - "integrity": "sha512-1s9539g+AB+V0gX4TPfCvhwWYso/fKlWQIX5w31BuqLjV6e8542x9vpdO/GS7aq1y1vec4ocx0B9I/d1SGFDSg==", - "dev": true, - "requires": { - "micromatch": "^4.0.2" - }, - "dependencies": { - "braces": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz", - "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", - "dev": true, - "requires": { - "fill-range": "^7.0.1" - } - }, - "fill-range": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", - "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", - "dev": true, - "requires": { - "to-regex-range": "^5.0.1" - } - }, - "is-number": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", - "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", - "dev": true - }, - "micromatch": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.2.tgz", - "integrity": "sha512-y7FpHSbMUMoyPbYUSzO6PaZ6FyRnQOpHuKwbo1G+Knck95XVU4QAiKdGEnj5wwoS7PlOgthX/09u5iFJ+aYf5Q==", - "dev": true, - "requires": { - "braces": "^3.0.1", - "picomatch": "^2.0.5" - } - }, - "to-regex-range": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", - "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", - "dev": true, - "requires": { - "is-number": "^7.0.0" - } - } - } - }, - "cspell-io": { - "version": "4.0.18", - "resolved": "https://registry.npmjs.org/cspell-io/-/cspell-io-4.0.18.tgz", - "integrity": "sha512-gE3C9bzE8+1W0ThLZ5xeYY5/xqbvUTtnEdsSGQ4VStNyAzcMTzfvWDTtL478z4luAiOxiyNPtQ4clWLGAugSJQ==", - "dev": true, - "requires": { - "iconv-lite": "^0.4.24", - "iterable-to-stream": "^1.0.1" - } - }, - "cspell-lib": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/cspell-lib/-/cspell-lib-4.1.0.tgz", - "integrity": "sha512-2ems0LpIONO51TIQRSiLvECR8RLT8dE2kcEtJS1TVAbh3VQMB2KnAWLLcbBCgqqmCRnYZ/hDrRScd5ZJ+9uZxQ==", - "dev": true, - "requires": { - "comment-json": "^1.1.3", - "configstore": "^5.0.0", - "cspell-dict-companies": "^1.0.12", - "cspell-dict-cpp": "^1.1.21", - "cspell-dict-django": "^1.0.12", - "cspell-dict-elixir": "^1.0.10", - "cspell-dict-en-gb": "^1.1.11", - "cspell-dict-en_us": "^1.2.18", - "cspell-dict-fullstack": "^1.0.15", - "cspell-dict-golang": "^1.1.12", - "cspell-dict-haskell": "^1.0.2", - "cspell-dict-html-symbol-entities": "^1.0.11", - "cspell-dict-java": "^1.0.10", - "cspell-dict-latex": "^1.0.11", - "cspell-dict-lorem-ipsum": "^1.0.10", - "cspell-dict-php": "^1.0.11", - "cspell-dict-powershell": "^1.0.2", - "cspell-dict-python": "^1.0.14", - "cspell-dict-rust": "^1.0.10", - "cspell-dict-scala": "^1.0.9", - "cspell-io": "^4.0.18", - "cspell-trie-lib": "^4.1.0", - "cspell-util-bundle": "^4.0.5", - "fs-extra": "^8.1.0", - "gensequence": "^2.1.2", - "vscode-uri": "^2.0.3" - }, - "dependencies": { - "fs-extra": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-8.1.0.tgz", - "integrity": "sha512-yhlQgA6mnOJUKOsRUFsgJdQCvkKhcz8tlZG5HBQfReYZy46OwLcY+Zia0mtdHsOo9y/hP+CxMN0TU9QxoOtG4g==", - "dev": true, - "requires": { - "graceful-fs": "^4.2.0", - "jsonfile": "^4.0.0", - "universalify": "^0.1.0" - } - } - } - }, - "cspell-trie-lib": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/cspell-trie-lib/-/cspell-trie-lib-4.1.0.tgz", - "integrity": "sha512-R7omOBBhiz1yu0Wp1an1Vcv+upNREQEel8c4XcUp3kJFpQIP39T4KQc4+oJ4D1g5To3flB0567vVuLAY9orMdg==", - "dev": true, - "requires": { - "gensequence": "^2.1.2", - "js-xxhash": "^1.0.1" - } - }, - "cspell-util-bundle": { - "version": "4.0.5", - "resolved": "https://registry.npmjs.org/cspell-util-bundle/-/cspell-util-bundle-4.0.5.tgz", - "integrity": "sha512-luu/xIjoTRt82eJJxf77fhgjU6XJve+CfoTyfejOj7niYDRvoZkt0rTSHPgTI6MADjaZxlCLleSihEgqidt5WQ==", - "dev": true - }, - "cssom": { - "version": "0.3.8", - "resolved": "https://registry.npmjs.org/cssom/-/cssom-0.3.8.tgz", - "integrity": "sha512-b0tGHbfegbhPJpxpiBPU2sCkigAqtM9O121le6bbOlgyV+NyGyCmVfJ6QW9eRjz8CpNfWEOYBIMIGRYkLwsIYg==", - "dev": true - }, - "cssstyle": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/cssstyle/-/cssstyle-1.4.0.tgz", - "integrity": "sha512-GBrLZYZ4X4x6/QEoBnIrqb8B/f5l4+8me2dkom/j1Gtbxy0kBv6OGzKuAsGM75bkGwGAFkt56Iwg28S3XTZgSA==", - "dev": true, - "requires": { - "cssom": "0.3.x" - } - }, - "cycle": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/cycle/-/cycle-1.0.3.tgz", - "integrity": "sha1-IegLK+hYD5i0aPN5QwZisEbDStI=", - "dev": true - }, - "dashdash": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/dashdash/-/dashdash-1.14.1.tgz", - "integrity": "sha1-hTz6D3y+L+1d4gMmuN1YEDX24vA=", - "dev": true, - "requires": { - "assert-plus": "^1.0.0" - } - }, - "data-urls": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/data-urls/-/data-urls-1.1.0.tgz", - "integrity": "sha512-YTWYI9se1P55u58gL5GkQHW4P6VJBJ5iBT+B5a7i2Tjadhv52paJG0qHX4A0OR6/t52odI64KP2YvFpkDOi3eQ==", - "dev": true, - "requires": { - "abab": "^2.0.0", - "whatwg-mimetype": "^2.2.0", - "whatwg-url": "^7.0.0" - }, - "dependencies": { - "whatwg-url": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-7.1.0.tgz", - "integrity": "sha512-WUu7Rg1DroM7oQvGWfOiAK21n74Gg+T4elXEQYkOhtyLeWiJFoOGLXPKI/9gzIie9CtwVLm8wtw6YJdKyxSjeg==", - "dev": true, - "requires": { - "lodash.sortby": "^4.7.0", - "tr46": "^1.0.1", - "webidl-conversions": "^4.0.2" - } - } - } - }, - "debug": { - "version": "3.2.6", - "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.6.tgz", - "integrity": "sha512-mel+jf7nrtEl5Pn1Qx46zARXKDpBbvzezse7p7LqINmdoIk8PYP5SySaxEmYv6TZ0JyEKA1hsCId6DIhgITtWQ==", - "dev": true, - "requires": { - "ms": "^2.1.1" - } - }, - "decamelize": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/decamelize/-/decamelize-1.2.0.tgz", - "integrity": "sha1-9lNNFRSCabIDUue+4m9QH5oZEpA=", - "dev": true - }, - "decode-uri-component": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/decode-uri-component/-/decode-uri-component-0.2.0.tgz", - "integrity": "sha1-6zkTMzRYd1y4TNGh+uBiEGu4dUU=", - "dev": true - }, - "deep-is": { - "version": "0.1.3", - "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.3.tgz", - "integrity": "sha1-s2nW+128E+7PUk+RsHD+7cNXzzQ=", - "dev": true - }, - "default-require-extensions": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/default-require-extensions/-/default-require-extensions-3.0.0.tgz", - "integrity": "sha512-ek6DpXq/SCpvjhpFsLFRVtIxJCRw6fUR42lYMVZuUMK7n8eMz4Uh5clckdBjEpLhn/gEBZo7hDJnJcwdKLKQjg==", - "dev": true, - "requires": { - "strip-bom": "^4.0.0" - } - }, - "define-properties": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.1.3.tgz", - "integrity": "sha512-3MqfYKj2lLzdMSf8ZIZE/V+Zuy+BgD6f164e8K2w7dgnpKArBDerGYpM46IYYcjnkdPNMjPk9A6VFB8+3SKlXQ==", - "dev": true, - "requires": { - "object-keys": "^1.0.12" - } - }, - "define-property": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/define-property/-/define-property-2.0.2.tgz", - "integrity": "sha512-jwK2UV4cnPpbcG7+VRARKTZPUWowwXA8bzH5NP6ud0oeAxyYPuGZUAC7hMugpCdz4BeSZl2Dl9k66CHJ/46ZYQ==", - "dev": true, - "requires": { - "is-descriptor": "^1.0.2", - "isobject": "^3.0.1" - }, - "dependencies": { - "is-accessor-descriptor": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-accessor-descriptor/-/is-accessor-descriptor-1.0.0.tgz", - "integrity": "sha512-m5hnHTkcVsPfqx3AKlyttIPb7J+XykHvJP2B9bZDjlhLIoEq4XoK64Vg7boZlVWYK6LUY94dYPEE7Lh0ZkZKcQ==", - "dev": true, - "requires": { - "kind-of": "^6.0.0" - } - }, - "is-data-descriptor": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-data-descriptor/-/is-data-descriptor-1.0.0.tgz", - "integrity": "sha512-jbRXy1FmtAoCjQkVmIVYwuuqDFUbaOeDjmed1tOGPrsMhtJA4rD9tkgA0F1qJ3gRFRXcHYVkdeaP50Q5rE/jLQ==", - "dev": true, - "requires": { - "kind-of": "^6.0.0" - } - }, - "is-descriptor": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/is-descriptor/-/is-descriptor-1.0.2.tgz", - "integrity": "sha512-2eis5WqQGV7peooDyLmNEPUrps9+SXX5c9pL3xEB+4e9HnGuDa7mB7kHxHw4CbqS9k1T2hOH3miL8n8WtiYVtg==", - "dev": true, - "requires": { - "is-accessor-descriptor": "^1.0.0", - "is-data-descriptor": "^1.0.0", - "kind-of": "^6.0.2" - } - } - } - }, - "delayed-stream": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", - "integrity": "sha1-3zrhmayt+31ECqrgsp4icrJOxhk=", - "dev": true - }, - "deprecation": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/deprecation/-/deprecation-2.3.1.tgz", - "integrity": "sha512-xmHIy4F3scKVwMsQ4WnVaS8bHOx0DmVwRywosKhaILI0ywMDWPtBSku2HNxRvF7jtwDRsoEwYQSfbxj8b7RlJQ==", - "dev": true - }, - "diff": { - "version": "3.5.0", - "resolved": "https://registry.npmjs.org/diff/-/diff-3.5.0.tgz", - "integrity": "sha512-A46qtFgd+g7pDZinpnwiRJtxbC1hpgf0uzP3iG89scHk0AUC7A1TGxf5OiiOUv/JMZR8GOt8hL900hV0bOy5xA==", - "dev": true - }, - "dir-glob": { - "version": "2.2.2", - "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-2.2.2.tgz", - "integrity": "sha512-f9LBi5QWzIW3I6e//uxZoLBlUt9kcp66qo0sSCxL6YZKc75R1c4MFCoe/LaZiBGmgujvQdxc5Bn3QhfyvK5Hsw==", - "dev": true, - "requires": { - "path-type": "^3.0.0" - } - }, - "domexception": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/domexception/-/domexception-1.0.1.tgz", - "integrity": "sha512-raigMkn7CJNNo6Ihro1fzG7wr3fHuYVytzquZKX5n0yizGsTcYgzdIUwj1X9pK0VvjeihV+XiclP+DjwbsSKug==", - "dev": true, - "requires": { - "webidl-conversions": "^4.0.2" - } - }, - "dot-prop": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/dot-prop/-/dot-prop-5.2.0.tgz", - "integrity": "sha512-uEUyaDKoSQ1M4Oq8l45hSE26SnTxL6snNnqvK/VWx5wJhmff5z0FUVJDKDanor/6w3kzE3i7XZOk+7wC0EXr1A==", - "dev": true, - "requires": { - "is-obj": "^2.0.0" - } - }, - "drange": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/drange/-/drange-1.1.1.tgz", - "integrity": "sha512-pYxfDYpued//QpnLIm4Avk7rsNtAtQkUES2cwAYSvD/wd2pKD71gN2Ebj3e7klzXwjocvE8c5vx/1fxwpqmSxA==", - "dev": true - }, - "duplexer": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/duplexer/-/duplexer-0.1.2.tgz", - "integrity": "sha512-jtD6YG370ZCIi/9GTaJKQxWTZD045+4R4hTk/x1UyoqadyJ9x9CgSi1RlVDQF8U2sxLLSnFkCaMihqljHIWgMg==", - "dev": true - }, - "ecc-jsbn": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/ecc-jsbn/-/ecc-jsbn-0.1.2.tgz", - "integrity": "sha1-OoOpBOVDUyh4dMVkt1SThoSamMk=", - "dev": true, - "requires": { - "jsbn": "~0.1.0", - "safer-buffer": "^2.1.0" - } - }, - "emoji-regex": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-7.0.3.tgz", - "integrity": "sha512-CwBLREIQ7LvYFB0WyRvwhq5N5qPhc6PMjD6bYggFlI5YyDgl+0vxq5VHbMOFqLg7hfWzmu8T5Z1QofhmTIhItA==", - "dev": true - }, - "enabled": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/enabled/-/enabled-2.0.0.tgz", - "integrity": "sha512-AKrN98kuwOzMIdAizXGI86UFBoo26CL21UM763y1h/GMSJ4/OHU9k2YlsmBpyScFo/wbLzWQJBMCW4+IO3/+OQ==", - "dev": true - }, - "end-of-stream": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/end-of-stream/-/end-of-stream-1.4.1.tgz", - "integrity": "sha512-1MkrZNvWTKCaigbn+W15elq2BB/L22nqrSY5DKlo3X6+vclJm8Bb5djXJBmEX6fS3+zCh/F4VBK5Z2KxJt4s2Q==", - "dev": true, - "requires": { - "once": "^1.4.0" - } - }, - "entities": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/entities/-/entities-1.1.2.tgz", - "integrity": "sha512-f2LZMYl1Fzu7YSBKg+RoROelpOaNrcGmE9AZubeDfrCEia483oW4MI4VyFd5VNHIgQ/7qm1I0wUHK1eJnn2y2w==", - "dev": true - }, - "es-abstract": { - "version": "1.13.0", - "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.13.0.tgz", - "integrity": "sha512-vDZfg/ykNxQVwup/8E1BZhVzFfBxs9NqMzGcvIJrqg5k2/5Za2bWo40dK2J1pgLngZ7c+Shh8lwYtLGyrwPutg==", - "dev": true, - "requires": { - "es-to-primitive": "^1.2.0", - "function-bind": "^1.1.1", - "has": "^1.0.3", - "is-callable": "^1.1.4", - "is-regex": "^1.0.4", - "object-keys": "^1.0.12" - } - }, - "es-to-primitive": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.0.tgz", - "integrity": "sha512-qZryBOJjV//LaxLTV6UC//WewneB3LcXOL9NP++ozKVXsIIIpm/2c13UDiD9Jp2eThsecw9m3jPqDwTyobcdbg==", - "dev": true, - "requires": { - "is-callable": "^1.1.4", - "is-date-object": "^1.0.1", - "is-symbol": "^1.0.2" - } - }, - "es6-error": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/es6-error/-/es6-error-4.1.1.tgz", - "integrity": "sha512-Um/+FxMr9CISWh0bi5Zv0iOD+4cFh5qLeks1qhAopKVAJw3drgKbKySikp7wGhDL0HPeaja0P5ULZrxLkniUVg==", - "dev": true - }, - "escape-string-regexp": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", - "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=", - "dev": true - }, - "escodegen": { - "version": "1.14.3", - "resolved": "https://registry.npmjs.org/escodegen/-/escodegen-1.14.3.tgz", - "integrity": "sha512-qFcX0XJkdg+PB3xjZZG/wKSuT1PnQWx57+TVSjIMmILd2yC/6ByYElPwJnslDsuWuSAp4AwJGumarAAmJch5Kw==", - "dev": true, - "requires": { - "esprima": "^4.0.1", - "estraverse": "^4.2.0", - "esutils": "^2.0.2", - "optionator": "^0.8.1", - "source-map": "~0.6.1" - }, - "dependencies": { - "source-map": { - "version": "0.6.1", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", - "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", - "dev": true, - "optional": true - } - } - }, - "esprima": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz", - "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==", - "dev": true - }, - "estraverse": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.3.0.tgz", - "integrity": "sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw==", - "dev": true - }, - "esutils": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz", - "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==", - "dev": true - }, - "execa": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/execa/-/execa-1.0.0.tgz", - "integrity": "sha512-adbxcyWV46qiHyvSp50TKt05tB4tK3HcmF7/nxfAdhnox83seTDbwnaqKO4sXRy7roHAIFqJP/Rw/AuEbX61LA==", - "dev": true, - "requires": { - "cross-spawn": "^6.0.0", - "get-stream": "^4.0.0", - "is-stream": "^1.1.0", - "npm-run-path": "^2.0.0", - "p-finally": "^1.0.0", - "signal-exit": "^3.0.0", - "strip-eof": "^1.0.0" - } - }, - "expand-brackets": { - "version": "2.1.4", - "resolved": "https://registry.npmjs.org/expand-brackets/-/expand-brackets-2.1.4.tgz", - "integrity": "sha1-t3c14xXOMPa27/D4OwQVGiJEliI=", - "dev": true, - "requires": { - "debug": "^2.3.3", - "define-property": "^0.2.5", - "extend-shallow": "^2.0.1", - "posix-character-classes": "^0.1.0", - "regex-not": "^1.0.0", - "snapdragon": "^0.8.1", - "to-regex": "^3.0.1" - }, - "dependencies": { - "debug": { - "version": "2.6.9", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", - "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", - "dev": true, - "requires": { - "ms": "2.0.0" - } - }, - "define-property": { - "version": "0.2.5", - "resolved": "https://registry.npmjs.org/define-property/-/define-property-0.2.5.tgz", - "integrity": "sha1-w1se+RjsPJkPmlvFe+BKrOxcgRY=", - "dev": true, - "requires": { - "is-descriptor": "^0.1.0" - } - }, - "extend-shallow": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz", - "integrity": "sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=", - "dev": true, - "requires": { - "is-extendable": "^0.1.0" - } - }, - "ms": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", - "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=", - "dev": true - } - } - }, - "extend": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz", - "integrity": "sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==", - "dev": true - }, - "extend-shallow": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-3.0.2.tgz", - "integrity": "sha1-Jqcarwc7OfshJxcnRhMcJwQCjbg=", - "dev": true, - "requires": { - "assign-symbols": "^1.0.0", - "is-extendable": "^1.0.1" - }, - "dependencies": { - "is-extendable": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/is-extendable/-/is-extendable-1.0.1.tgz", - "integrity": "sha512-arnXMxT1hhoKo9k1LZdmlNyJdDDfy2v0fXjFlmok4+i8ul/6WlbVge9bhM74OpNPQPMGUToDtz+KXa1PneJxOA==", - "dev": true, - "requires": { - "is-plain-object": "^2.0.4" - } - }, - "is-plain-object": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-2.0.4.tgz", - "integrity": "sha512-h5PpgXkWitc38BBMYawTYMWJHFZJVnBquFE57xFpjB8pJFiF6gZ+bU+WyI/yqXiFR5mdLsgYNaPe8uao6Uv9Og==", - "dev": true, - "requires": { - "isobject": "^3.0.1" - } - } - } - }, - "extglob": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/extglob/-/extglob-2.0.4.tgz", - "integrity": "sha512-Nmb6QXkELsuBr24CJSkilo6UHHgbekK5UiZgfE6UHD3Eb27YC6oD+bhcT+tJ6cl8dmsgdQxnWlcry8ksBIBLpw==", - "dev": true, - "requires": { - "array-unique": "^0.3.2", - "define-property": "^1.0.0", - "expand-brackets": "^2.1.4", - "extend-shallow": "^2.0.1", - "fragment-cache": "^0.2.1", - "regex-not": "^1.0.0", - "snapdragon": "^0.8.1", - "to-regex": "^3.0.1" - }, - "dependencies": { - "define-property": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/define-property/-/define-property-1.0.0.tgz", - "integrity": "sha1-dp66rz9KY6rTr56NMEybvnm/sOY=", - "dev": true, - "requires": { - "is-descriptor": "^1.0.0" - } - }, - "extend-shallow": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz", - "integrity": "sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=", - "dev": true, - "requires": { - "is-extendable": "^0.1.0" - } - }, - "is-accessor-descriptor": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-accessor-descriptor/-/is-accessor-descriptor-1.0.0.tgz", - "integrity": "sha512-m5hnHTkcVsPfqx3AKlyttIPb7J+XykHvJP2B9bZDjlhLIoEq4XoK64Vg7boZlVWYK6LUY94dYPEE7Lh0ZkZKcQ==", - "dev": true, - "requires": { - "kind-of": "^6.0.0" - } - }, - "is-data-descriptor": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-data-descriptor/-/is-data-descriptor-1.0.0.tgz", - "integrity": "sha512-jbRXy1FmtAoCjQkVmIVYwuuqDFUbaOeDjmed1tOGPrsMhtJA4rD9tkgA0F1qJ3gRFRXcHYVkdeaP50Q5rE/jLQ==", - "dev": true, - "requires": { - "kind-of": "^6.0.0" - } - }, - "is-descriptor": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/is-descriptor/-/is-descriptor-1.0.2.tgz", - "integrity": "sha512-2eis5WqQGV7peooDyLmNEPUrps9+SXX5c9pL3xEB+4e9HnGuDa7mB7kHxHw4CbqS9k1T2hOH3miL8n8WtiYVtg==", - "dev": true, - "requires": { - "is-accessor-descriptor": "^1.0.0", - "is-data-descriptor": "^1.0.0", - "kind-of": "^6.0.2" - } - } - } - }, - "extsprintf": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/extsprintf/-/extsprintf-1.3.0.tgz", - "integrity": "sha1-lpGEQOMEGnpBT4xS48V06zw+HgU=", - "dev": true - }, - "eyes": { - "version": "0.1.8", - "resolved": "https://registry.npmjs.org/eyes/-/eyes-0.1.8.tgz", - "integrity": "sha1-Ys8SAjTGg3hdkCNIqADvPgzCC8A=", - "dev": true - }, - "faker": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/faker/-/faker-4.1.0.tgz", - "integrity": "sha1-HkW7vsxndLPBlfrSg1EJxtdIzD8=", - "dev": true - }, - "fast-deep-equal": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", - "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", - "dev": true - }, - "fast-glob": { - "version": "2.2.7", - "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-2.2.7.tgz", - "integrity": "sha512-g1KuQwHOZAmOZMuBtHdxDtju+T2RT8jgCC9aANsbpdiDDTSnjgfuVsIBNKbUeJI3oKMRExcfNDtJl4OhbffMsw==", - "dev": true, - "requires": { - "@mrmlnc/readdir-enhanced": "^2.2.1", - "@nodelib/fs.stat": "^1.1.2", - "glob-parent": "^3.1.0", - "is-glob": "^4.0.0", - "merge2": "^1.2.3", - "micromatch": "^3.1.10" - } - }, - "fast-json-stable-stringify": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", - "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", - "dev": true - }, - "fast-levenshtein": { - "version": "2.0.6", - "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz", - "integrity": "sha1-PYpcZog6FqMMqGQ+hR8Zuqd5eRc=", - "dev": true - }, - "fast-safe-stringify": { - "version": "2.0.7", - "resolved": "https://registry.npmjs.org/fast-safe-stringify/-/fast-safe-stringify-2.0.7.tgz", - "integrity": "sha512-Utm6CdzT+6xsDk2m8S6uL8VHxNwI6Jub+e9NYTcAms28T84pTa25GJQV9j0CY0N1rM8hK4x6grpF2BQf+2qwVA==", - "dev": true - }, - "fecha": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/fecha/-/fecha-4.2.0.tgz", - "integrity": "sha512-aN3pcx/DSmtyoovUudctc8+6Hl4T+hI9GBBHLjA76jdZl7+b1sgh5g4k+u/GL3dTy1/pnYzKp69FpJ0OicE3Wg==", - "dev": true - }, - "fill-range": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-4.0.0.tgz", - "integrity": "sha1-1USBHUKPmOsGpj3EAtJAPDKMOPc=", - "dev": true, - "requires": { - "extend-shallow": "^2.0.1", - "is-number": "^3.0.0", - "repeat-string": "^1.6.1", - "to-regex-range": "^2.1.0" - }, - "dependencies": { - "extend-shallow": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz", - "integrity": "sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=", - "dev": true, - "requires": { - "is-extendable": "^0.1.0" - } - } - } - }, - "find-cache-dir": { - "version": "3.3.1", - "resolved": "https://registry.npmjs.org/find-cache-dir/-/find-cache-dir-3.3.1.tgz", - "integrity": "sha512-t2GDMt3oGC/v+BMwzmllWDuJF/xcDtE5j/fCGbqDD7OLuJkj0cfh1YSA5VKPvwMeLFLNDBkwOKZ2X85jGLVftQ==", - "dev": true, - "requires": { - "commondir": "^1.0.1", - "make-dir": "^3.0.2", - "pkg-dir": "^4.1.0" - }, - "dependencies": { - "make-dir": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-3.1.0.tgz", - "integrity": "sha512-g3FeP20LNwhALb/6Cz6Dd4F2ngze0jz7tbzrD2wAV+o9FeNHe4rL+yK2md0J/fiSf1sa1ADhXqi5+oVwOM/eGw==", - "dev": true, - "requires": { - "semver": "^6.0.0" - } - }, - "semver": { - "version": "6.3.0", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz", - "integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==", - "dev": true - } - } - }, - "find-up": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-3.0.0.tgz", - "integrity": "sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg==", - "dev": true, - "requires": { - "locate-path": "^3.0.0" - } - }, - "flat": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/flat/-/flat-4.1.0.tgz", - "integrity": "sha512-Px/TiLIznH7gEDlPXcUD4KnBusa6kR6ayRUVcnEAbreRIuhkqow/mun59BuRXwoYk7ZQOLW1ZM05ilIvK38hFw==", - "dev": true, - "requires": { - "is-buffer": "~2.0.3" - }, - "dependencies": { - "is-buffer": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/is-buffer/-/is-buffer-2.0.3.tgz", - "integrity": "sha512-U15Q7MXTuZlrbymiz95PJpZxu8IlipAp4dtS3wOdgPXx3mqBnslrWU14kxfHB+Py/+2PVKSr37dMAgM2A4uArw==", - "dev": true - } - } - }, - "fn.name": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/fn.name/-/fn.name-1.1.0.tgz", - "integrity": "sha512-GRnmB5gPyJpAhTQdSZTSp9uaPSvl09KoYcMQtsB9rQoOmzs9dH6ffeccH+Z+cv6P68Hu5bC6JjRh4Ah/mHSNRw==", - "dev": true - }, - "for-in": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/for-in/-/for-in-1.0.2.tgz", - "integrity": "sha1-gQaNKVqBQuwKxybG4iAMMPttXoA=", - "dev": true - }, - "foreach": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/foreach/-/foreach-2.0.5.tgz", - "integrity": "sha1-C+4AUBiusmDQo6865ljdATbsG5k=", - "dev": true - }, - "foreground-child": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/foreground-child/-/foreground-child-2.0.0.tgz", - "integrity": "sha512-dCIq9FpEcyQyXKCkyzmlPTFNgrCzPudOe+mhvJU5zAtlBnGVy2yKxtfsxK2tQBThwq225jcvBjpw1Gr40uzZCA==", - "dev": true, - "requires": { - "cross-spawn": "^7.0.0", - "signal-exit": "^3.0.2" - }, - "dependencies": { - "cross-spawn": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", - "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", - "dev": true, - "requires": { - "path-key": "^3.1.0", - "shebang-command": "^2.0.0", - "which": "^2.0.1" - } - }, - "path-key": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", - "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", - "dev": true - }, - "shebang-command": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", - "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", - "dev": true, - "requires": { - "shebang-regex": "^3.0.0" - } - }, - "shebang-regex": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", - "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", - "dev": true - }, - "which": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", - "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", - "dev": true, - "requires": { - "isexe": "^2.0.0" - } - } - } - }, - "forever-agent": { - "version": "0.6.1", - "resolved": "https://registry.npmjs.org/forever-agent/-/forever-agent-0.6.1.tgz", - "integrity": "sha1-+8cfDEGt6zf5bFd60e1C2P2sypE=", - "dev": true - }, - "form-data": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/form-data/-/form-data-3.0.0.tgz", - "integrity": "sha512-CKMFDglpbMi6PyN+brwB9Q/GOw0eAnsrEZDgcsH5Krhz5Od/haKHAX0NmQfha2zPPz0JpWzA7GJHGSnvCRLWsg==", - "dev": true, - "requires": { - "asynckit": "^0.4.0", - "combined-stream": "^1.0.8", - "mime-types": "^2.1.12" - } - }, - "format-util": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/format-util/-/format-util-1.0.3.tgz", - "integrity": "sha1-Ay3KShFiYqEsQ/TD7IVmQWxbLZU=", - "dev": true - }, - "formidable": { - "version": "1.2.2", - "resolved": "https://registry.npmjs.org/formidable/-/formidable-1.2.2.tgz", - "integrity": "sha512-V8gLm+41I/8kguQ4/o1D3RIHRmhYFG4pnNyonvua+40rqcEmT4+V71yaZ3B457xbbgCsCfjSPi65u/W6vK1U5Q==", - "dev": true - }, - "fragment-cache": { - "version": "0.2.1", - "resolved": "https://registry.npmjs.org/fragment-cache/-/fragment-cache-0.2.1.tgz", - "integrity": "sha1-QpD60n8T6Jvn8zeZxrxaCr//DRk=", - "dev": true, - "requires": { - "map-cache": "^0.2.2" - } - }, - "fromentries": { - "version": "1.3.2", - "resolved": "https://registry.npmjs.org/fromentries/-/fromentries-1.3.2.tgz", - "integrity": "sha512-cHEpEQHUg0f8XdtZCc2ZAhrHzKzT0MrFUTcvx+hfxYu7rGMDc5SKoXFh+n4YigxsHXRzc6OrCshdR1bWH6HHyg==", - "dev": true - }, - "front-matter": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/front-matter/-/front-matter-3.0.2.tgz", - "integrity": "sha512-iBGZaWyzqgsrPGsqrXZP6N4hp5FzSKDi18nfAoYpgz3qK5sAwFv/ojmn3VS60SOgLvq6CtojNqy0y6ZNz05IzQ==", - "dev": true, - "requires": { - "js-yaml": "^3.13.1" - } - }, - "fs-extra": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-7.0.1.tgz", - "integrity": "sha512-YJDaCJZEnBmcbw13fvdAM9AwNOJwOzrE4pqMqBq5nFiEqXUqHwlK4B+3pUw6JNvfSPtX05xFHtYy/1ni01eGCw==", - "dev": true, - "requires": { - "graceful-fs": "^4.1.2", - "jsonfile": "^4.0.0", - "universalify": "^0.1.0" - } - }, - "fs.realpath": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", - "integrity": "sha1-FQStJSMVjKpA20onh8sBQRmU6k8=", - "dev": true - }, - "function-bind": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz", - "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==", - "dev": true - }, - "gensequence": { - "version": "2.1.3", - "resolved": "https://registry.npmjs.org/gensequence/-/gensequence-2.1.3.tgz", - "integrity": "sha512-qa/2k1YSyh6TGVtIMtmwv1tXfq7lkhR8pMtOExfZGuwyaqplMhUxyO/Wrw9fV+37B38WE6egpjSMcwyzlNOoHA==", - "dev": true - }, - "gensync": { - "version": "1.0.0-beta.2", - "resolved": "https://registry.npmjs.org/gensync/-/gensync-1.0.0-beta.2.tgz", - "integrity": "sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg==", - "dev": true - }, - "get-caller-file": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz", - "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==", - "dev": true - }, - "get-package-type": { - "version": "0.1.0", - "resolved": "https://registry.npmjs.org/get-package-type/-/get-package-type-0.1.0.tgz", - "integrity": "sha512-pjzuKtY64GYfWizNAJ0fr9VqttZkNiK2iS430LtIHzjBEr6bX8Am2zm4sW4Ro5wjWW5cAlRL1qAMTcXbjNAO2Q==", - "dev": true - }, - "get-stdin": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/get-stdin/-/get-stdin-7.0.0.tgz", - "integrity": "sha512-zRKcywvrXlXsA0v0i9Io4KDRaAw7+a1ZpjRwl9Wox8PFlVCCHra7E9c4kqXCoCM9nR5tBkaTTZRBoCm60bFqTQ==", - "dev": true - }, - "get-stream": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-4.1.0.tgz", - "integrity": "sha512-GMat4EJ5161kIy2HevLlr4luNjBgvmj413KaQA7jt4V8B4RDsfpHk7WQ9GVqfYyyx8OS/L66Kox+rJRNklLK7w==", - "dev": true, - "requires": { - "pump": "^3.0.0" - } - }, - "get-value": { - "version": "2.0.6", - "resolved": "https://registry.npmjs.org/get-value/-/get-value-2.0.6.tgz", - "integrity": "sha1-3BXKHGcjh8p2vTesCjlbogQqLCg=", - "dev": true - }, - "getpass": { - "version": "0.1.7", - "resolved": "https://registry.npmjs.org/getpass/-/getpass-0.1.7.tgz", - "integrity": "sha1-Xv+OPmhNVprkyysSgmBOi6YhSfo=", - "dev": true, - "requires": { - "assert-plus": "^1.0.0" - } - }, - "glob": { - "version": "7.1.4", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.4.tgz", - "integrity": "sha512-hkLPepehmnKk41pUGm3sYxoFs/umurYfYJCerbXEyFIWcAzvpipAgVkBqqT9RBKMGjnq6kMuyYwha6csxbiM1A==", - "dev": true, - "requires": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^3.0.4", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" - } - }, - "glob-parent": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-3.1.0.tgz", - "integrity": "sha1-nmr2KZ2NO9K9QEMIMr0RPfkGxa4=", - "dev": true, - "requires": { - "is-glob": "^3.1.0", - "path-dirname": "^1.0.0" - }, - "dependencies": { - "is-glob": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-3.1.0.tgz", - "integrity": "sha1-e6WuJCF4BKxwcHuWkiVnSGzD6Eo=", - "dev": true, - "requires": { - "is-extglob": "^2.1.0" - } - } - } - }, - "glob-to-regexp": { - "version": "0.3.0", - "resolved": "https://registry.npmjs.org/glob-to-regexp/-/glob-to-regexp-0.3.0.tgz", - "integrity": "sha1-jFoUlNIGbFcMw7/kSWF1rMTVAqs=", - "dev": true - }, - "globals": { - "version": "11.12.0", - "resolved": "https://registry.npmjs.org/globals/-/globals-11.12.0.tgz", - "integrity": "sha512-WOBp/EEGUiIsJSp7wcv/y6MO+lV9UoncWqxuFfm8eBwzWNgyfBd6Gz+IeKQ9jCmyhoH99g15M3T+QaVHFjizVA==", - "dev": true - }, - "globby": { - "version": "9.2.0", - "resolved": "https://registry.npmjs.org/globby/-/globby-9.2.0.tgz", - "integrity": "sha512-ollPHROa5mcxDEkwg6bPt3QbEf4pDQSNtd6JPL1YvOvAo/7/0VAm9TccUeoTmarjPw4pfUthSCqcyfNB1I3ZSg==", - "dev": true, - "requires": { - "@types/glob": "^7.1.1", - "array-union": "^1.0.2", - "dir-glob": "^2.2.2", - "fast-glob": "^2.2.6", - "glob": "^7.1.3", - "ignore": "^4.0.3", - "pify": "^4.0.1", - "slash": "^2.0.0" - }, - "dependencies": { - "slash": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/slash/-/slash-2.0.0.tgz", - "integrity": "sha512-ZYKh3Wh2z1PpEXWr0MpSBZ0V6mZHAQfYevttO11c51CaWjGTaadiKZ+wVt1PbMlDV5qhMFslpZCemhwOK7C89A==", - "dev": true - } - } - }, - "graceful-fs": { - "version": "4.2.2", - "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.2.tgz", - "integrity": "sha512-IItsdsea19BoLC7ELy13q1iJFNmd7ofZH5+X/pJr90/nRoPEX0DJo1dHDbgtYWOhJhcCgMDTOw84RZ72q6lB+Q==", - "dev": true - }, - "graphlib": { - "version": "2.1.8", - "resolved": "https://registry.npmjs.org/graphlib/-/graphlib-2.1.8.tgz", - "integrity": "sha512-jcLLfkpoVGmH7/InMC/1hIvOPSUh38oJtGhvrOFGzioE1DZ+0YW16RgmOJhHiuWTvGiJQ9Z1Ik43JvkRPRvE+A==", - "dev": true, - "requires": { - "lodash": "^4.17.15" - } - }, - "growl": { - "version": "1.10.5", - "resolved": "https://registry.npmjs.org/growl/-/growl-1.10.5.tgz", - "integrity": "sha512-qBr4OuELkhPenW6goKVXiv47US3clb3/IbuWF9KNKEijAy9oeHxU9IgzjvJhHkUzhaj7rOUD7+YGWqUjLp5oSA==", - "dev": true - }, - "handlebars": { - "version": "4.7.7", - "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.7.tgz", - "integrity": "sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA==", - "dev": true, - "requires": { - "minimist": "^1.2.5", - "neo-async": "^2.6.0", - "source-map": "^0.6.1", - "uglify-js": "^3.1.4", - "wordwrap": "^1.0.0" - }, - "dependencies": { - "source-map": { - "version": "0.6.1", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", - "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", - "dev": true - } - } - }, - "har-schema": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/har-schema/-/har-schema-2.0.0.tgz", - "integrity": "sha1-qUwiJOvKwEeCoNkDVSHyRzW37JI=", - "dev": true - }, - "har-validator": { - "version": "5.1.5", - "resolved": "https://registry.npmjs.org/har-validator/-/har-validator-5.1.5.tgz", - "integrity": "sha512-nmT2T0lljbxdQZfspsno9hgrG3Uir6Ks5afism62poxqBM6sDnMEuPmzTq8XN0OEwqKLLdh1jQI3qyE66Nzb3w==", - "dev": true, - "requires": { - "ajv": "^6.12.3", - "har-schema": "^2.0.0" - } - }, - "has": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz", - "integrity": "sha512-f2dvO0VU6Oej7RkWJGrehjbzMAjFp5/VKPp5tTpWIV4JHHZK1/BxbFRtf/siA2SWTe09caDmVtYYzWEIbBS4zw==", - "dev": true, - "requires": { - "function-bind": "^1.1.1" - } - }, - "has-flag": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-1.0.0.tgz", - "integrity": "sha1-nZ55MWXOAXoA8AQYxD+UKnsdEfo=", - "dev": true - }, - "has-symbols": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.0.tgz", - "integrity": "sha1-uhqPGvKg/DllD1yFA2dwQSIGO0Q=", - "dev": true - }, - "has-value": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/has-value/-/has-value-1.0.0.tgz", - "integrity": "sha1-GLKB2lhbHFxR3vJMkw7SmgvmsXc=", - "dev": true, - "requires": { - "get-value": "^2.0.6", - "has-values": "^1.0.0", - "isobject": "^3.0.0" - } - }, - "has-values": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/has-values/-/has-values-1.0.0.tgz", - "integrity": "sha1-lbC2P+whRmGab+V/51Yo1aOe/k8=", - "dev": true, - "requires": { - "is-number": "^3.0.0", - "kind-of": "^4.0.0" - }, - "dependencies": { - "kind-of": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-4.0.0.tgz", - "integrity": "sha1-IIE989cSkosgc3hpGkUGb65y3Vc=", - "dev": true, - "requires": { - "is-buffer": "^1.1.5" - } - } - } - }, - "hasha": { - "version": "5.2.2", - "resolved": "https://registry.npmjs.org/hasha/-/hasha-5.2.2.tgz", - "integrity": "sha512-Hrp5vIK/xr5SkeN2onO32H0MgNZ0f17HRNH39WfL0SYUNOTZ5Lz1TJ8Pajo/87dYGEFlLMm7mIc/k/s6Bvz9HQ==", - "dev": true, - "requires": { - "is-stream": "^2.0.0", - "type-fest": "^0.8.0" - }, - "dependencies": { - "is-stream": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.0.tgz", - "integrity": "sha512-XCoy+WlUr7d1+Z8GgSuXmpuUFC9fOhRXglJMx+dwLKTkL44Cjd4W1Z5P+BQZpr+cR93aGP4S/s7Ftw6Nd/kiEw==", - "dev": true - } - } - }, - "he": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/he/-/he-1.2.0.tgz", - "integrity": "sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw==", - "dev": true - }, - "html-encoding-sniffer": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/html-encoding-sniffer/-/html-encoding-sniffer-1.0.2.tgz", - "integrity": "sha512-71lZziiDnsuabfdYiUeWdCVyKuqwWi23L8YeIgV9jSSZHCtb6wB1BKWooH7L3tn4/FuZJMVWyNaIDr4RGmaSYw==", - "dev": true, - "requires": { - "whatwg-encoding": "^1.0.1" - } - }, - "html-escaper": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/html-escaper/-/html-escaper-2.0.2.tgz", - "integrity": "sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg==", - "dev": true - }, - "http-signature": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/http-signature/-/http-signature-1.2.0.tgz", - "integrity": "sha1-muzZJRFHcvPZW2WmCruPfBj7rOE=", - "dev": true, - "requires": { - "assert-plus": "^1.0.0", - "jsprim": "^1.2.2", - "sshpk": "^1.7.0" - } - }, - "iconv-lite": { - "version": "0.4.24", - "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", - "integrity": "sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==", - "dev": true, - "requires": { - "safer-buffer": ">= 2.1.2 < 3" - } - }, - "ignore": { - "version": "4.0.6", - "resolved": "https://registry.npmjs.org/ignore/-/ignore-4.0.6.tgz", - "integrity": "sha512-cyFDKrqc/YdcWFniJhzI42+AzS+gNwmUzOSFcRCQYwySuBBBy/KjuxWLZ/FHEH6Moq1NizMOBWyTcv8O4OZIMg==", - "dev": true - }, - "imurmurhash": { - "version": "0.1.4", - "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", - "integrity": "sha1-khi5srkoojixPcT7a21XbyMUU+o=", - "dev": true - }, - "indent-string": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/indent-string/-/indent-string-4.0.0.tgz", - "integrity": "sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg==", - "dev": true - }, - "inflight": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", - "integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=", - "dev": true, - "requires": { - "once": "^1.3.0", - "wrappy": "1" - } - }, - "inherits": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", - "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", - "dev": true - }, - "is-accessor-descriptor": { - "version": "0.1.6", - "resolved": "https://registry.npmjs.org/is-accessor-descriptor/-/is-accessor-descriptor-0.1.6.tgz", - "integrity": "sha1-qeEss66Nh2cn7u84Q/igiXtcmNY=", - "dev": true, - "requires": { - "kind-of": "^3.0.2" - }, - "dependencies": { - "kind-of": { - "version": "3.2.2", - "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-3.2.2.tgz", - "integrity": "sha1-MeohpzS6ubuw8yRm2JOupR5KPGQ=", - "dev": true, - "requires": { - "is-buffer": "^1.1.5" - } - } - } - }, - "is-arrayish": { - "version": "0.3.2", - "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.3.2.tgz", - "integrity": "sha512-eVRqCvVlZbuw3GrM63ovNSNAeA1K16kaR/LRY/92w0zxQ5/1YzwblUX652i4Xs9RwAGjW9d9y6X88t8OaAJfWQ==", - "dev": true - }, - "is-buffer": { - "version": "1.1.6", - "resolved": "https://registry.npmjs.org/is-buffer/-/is-buffer-1.1.6.tgz", - "integrity": "sha512-NcdALwpXkTm5Zvvbk7owOUSvVvBKDgKP5/ewfXEznmQFfs4ZRmanOeKBTjRVjka3QFoN6XJ+9F3USqfHqTaU5w==", - "dev": true - }, - "is-callable": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.1.4.tgz", - "integrity": "sha512-r5p9sxJjYnArLjObpjA4xu5EKI3CuKHkJXMhT7kwbpUyIFD1n5PMAsoPvWnvtZiNz7LjkYDRZhd7FlI0eMijEA==", - "dev": true - }, - "is-core-module": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.2.0.tgz", - "integrity": "sha512-XRAfAdyyY5F5cOXn7hYQDqh2Xmii+DEfIcQGxK/uNwMHhIkPWO0g8msXcbzLe+MpGoR951MlqM/2iIlU4vKDdQ==", - "dev": true, - "requires": { - "has": "^1.0.3" - } - }, - "is-data-descriptor": { - "version": "0.1.4", - "resolved": "https://registry.npmjs.org/is-data-descriptor/-/is-data-descriptor-0.1.4.tgz", - "integrity": "sha1-C17mSDiOLIYCgueT8YVv7D8wG1Y=", - "dev": true, - "requires": { - "kind-of": "^3.0.2" - }, - "dependencies": { - "kind-of": { - "version": "3.2.2", - "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-3.2.2.tgz", - "integrity": "sha1-MeohpzS6ubuw8yRm2JOupR5KPGQ=", - "dev": true, - "requires": { - "is-buffer": "^1.1.5" - } - } - } - }, - "is-date-object": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.0.1.tgz", - "integrity": "sha1-mqIOtq7rv/d/vTPnTKAbM1gdOhY=", - "dev": true - }, - "is-descriptor": { - "version": "0.1.6", - "resolved": "https://registry.npmjs.org/is-descriptor/-/is-descriptor-0.1.6.tgz", - "integrity": "sha512-avDYr0SB3DwO9zsMov0gKCESFYqCnE4hq/4z3TdUlukEy5t9C0YRq7HLrsN52NAcqXKaepeCD0n+B0arnVG3Hg==", - "dev": true, - "requires": { - "is-accessor-descriptor": "^0.1.6", - "is-data-descriptor": "^0.1.4", - "kind-of": "^5.0.0" - }, - "dependencies": { - "kind-of": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-5.1.0.tgz", - "integrity": "sha512-NGEErnH6F2vUuXDh+OlbcKW7/wOcfdRHaZ7VWtqCztfHri/++YKmP51OdWeGPuqCOba6kk2OTe5d02VmTB80Pw==", - "dev": true - } - } - }, - "is-extendable": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/is-extendable/-/is-extendable-0.1.1.tgz", - "integrity": "sha1-YrEQ4omkcUGOPsNqYX1HLjAd/Ik=", - "dev": true - }, - "is-extglob": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", - "integrity": "sha1-qIwCU1eR8C7TfHahueqXc8gz+MI=", - "dev": true - }, - "is-fullwidth-code-point": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", - "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=", - "dev": true - }, - "is-glob": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.1.tgz", - "integrity": "sha512-5G0tKtBTFImOqDnLB2hG6Bp2qcKEFduo4tZu9MT/H6NQv/ghhy30o55ufafxJ/LdH79LLs2Kfrn85TLKyA7BUg==", - "dev": true, - "requires": { - "is-extglob": "^2.1.1" - } - }, - "is-number": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-number/-/is-number-3.0.0.tgz", - "integrity": "sha1-JP1iAaR4LPUFYcgQJ2r8fRLXEZU=", - "dev": true, - "requires": { - "kind-of": "^3.0.2" - }, - "dependencies": { - "kind-of": { - "version": "3.2.2", - "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-3.2.2.tgz", - "integrity": "sha1-MeohpzS6ubuw8yRm2JOupR5KPGQ=", - "dev": true, - "requires": { - "is-buffer": "^1.1.5" - } - } - } - }, - "is-obj": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/is-obj/-/is-obj-2.0.0.tgz", - "integrity": "sha512-drqDG3cbczxxEJRoOXcOjtdp1J/lyp1mNn0xaznRs8+muBhgQcrnbspox5X5fOw0HnMnbfDzvnEMEtqDEJEo8w==", - "dev": true - }, - "is-plain-object": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-5.0.0.tgz", - "integrity": "sha512-VRSzKkbMm5jMDoKLbltAkFQ5Qr7VDiTFGXxYFXXowVj387GeGNOCsOH6Msy00SGZ3Fp84b1Naa1psqgcCIEP5Q==", - "dev": true - }, - "is-regex": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.0.4.tgz", - "integrity": "sha1-VRdIm1RwkbCTDglWVM7SXul+lJE=", - "dev": true, - "requires": { - "has": "^1.0.1" - } - }, - "is-stream": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-1.1.0.tgz", - "integrity": "sha1-EtSj3U5o4Lec6428hBc66A2RykQ=", - "dev": true - }, - "is-symbol": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/is-symbol/-/is-symbol-1.0.2.tgz", - "integrity": "sha512-HS8bZ9ox60yCJLH9snBpIwv9pYUAkcuLhSA1oero1UB5y9aiQpRA8y2ex945AOtCZL1lJDeIk3G5LthswI46Lw==", - "dev": true, - "requires": { - "has-symbols": "^1.0.0" - } - }, - "is-typedarray": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-typedarray/-/is-typedarray-1.0.0.tgz", - "integrity": "sha1-5HnICFjfDBsR3dppQPlgEfzaSpo=", - "dev": true - }, - "is-windows": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/is-windows/-/is-windows-1.0.2.tgz", - "integrity": "sha512-eXK1UInq2bPmjyX6e3VHIzMLobc4J94i4AWn+Hpq3OU5KkrRC96OAcR3PRJ/pGu6m8TRnBHP9dkXQVsT/COVIA==", - "dev": true - }, - "isarray": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", - "integrity": "sha1-u5NdSFgsuhaMBoNJV6VKPgcSTxE=", - "dev": true - }, - "isexe": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", - "integrity": "sha1-6PvzdNxVb/iUehDcsFctYz8s+hA=", - "dev": true - }, - "isobject": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz", - "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8=", - "dev": true - }, - "isstream": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/isstream/-/isstream-0.1.2.tgz", - "integrity": "sha1-R+Y/evVa+m+S4VAOaQ64uFKcCZo=", - "dev": true - }, - "istanbul": { - "version": "0.4.5", - "resolved": "https://registry.npmjs.org/istanbul/-/istanbul-0.4.5.tgz", - "integrity": "sha1-ZcfXPUxNqE1POsMQuRj7C4Azczs=", - "dev": true, - "requires": { - "abbrev": "1.0.x", - "async": "1.x", - "escodegen": "1.8.x", - "esprima": "2.7.x", - "glob": "^5.0.15", - "handlebars": "^4.0.1", - "js-yaml": "3.x", - "mkdirp": "0.5.x", - "nopt": "3.x", - "once": "1.x", - "resolve": "1.1.x", - "supports-color": "^3.1.0", - "which": "^1.1.1", - "wordwrap": "^1.0.0" - }, - "dependencies": { - "escodegen": { - "version": "1.8.1", - "resolved": "https://registry.npmjs.org/escodegen/-/escodegen-1.8.1.tgz", - "integrity": "sha1-WltTr0aTEQvrsIZ6o0MN07cKEBg=", - "dev": true, - "requires": { - "esprima": "^2.7.1", - "estraverse": "^1.9.1", - "esutils": "^2.0.2", - "optionator": "^0.8.1", - "source-map": "~0.2.0" - } - }, - "esprima": { - "version": "2.7.3", - "resolved": "https://registry.npmjs.org/esprima/-/esprima-2.7.3.tgz", - "integrity": "sha1-luO3DVd59q1JzQMmc9HDEnZ7pYE=", - "dev": true - }, - "estraverse": { - "version": "1.9.3", - "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-1.9.3.tgz", - "integrity": "sha1-r2fy3JIlgkFZUJJgkaQAXSnJu0Q=", - "dev": true - }, - "glob": { - "version": "5.0.15", - "resolved": "https://registry.npmjs.org/glob/-/glob-5.0.15.tgz", - "integrity": "sha1-G8k2ueAvSmA/zCIuz3Yz0wuLk7E=", - "dev": true, - "requires": { - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "2 || 3", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" - } - }, - "source-map": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.2.0.tgz", - "integrity": "sha1-2rc/vPwrqBm03gO9b26qSBZLP50=", - "dev": true, - "optional": true, - "requires": { - "amdefine": ">=0.0.4" - } - } - } - }, - "istanbul-lib-coverage": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/istanbul-lib-coverage/-/istanbul-lib-coverage-3.0.0.tgz", - "integrity": "sha512-UiUIqxMgRDET6eR+o5HbfRYP1l0hqkWOs7vNxC/mggutCMUIhWMm8gAHb8tHlyfD3/l6rlgNA5cKdDzEAf6hEg==", - "dev": true - }, - "istanbul-lib-hook": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/istanbul-lib-hook/-/istanbul-lib-hook-3.0.0.tgz", - "integrity": "sha512-Pt/uge1Q9s+5VAZ+pCo16TYMWPBIl+oaNIjgLQxcX0itS6ueeaA+pEfThZpH8WxhFgCiEb8sAJY6MdUKgiIWaQ==", - "dev": true, - "requires": { - "append-transform": "^2.0.0" - } - }, - "istanbul-lib-instrument": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/istanbul-lib-instrument/-/istanbul-lib-instrument-4.0.3.tgz", - "integrity": "sha512-BXgQl9kf4WTCPCCpmFGoJkz/+uhvm7h7PFKUYxh7qarQd3ER33vHG//qaE8eN25l07YqZPpHXU9I09l/RD5aGQ==", - "dev": true, - "requires": { - "@babel/core": "^7.7.5", - "@istanbuljs/schema": "^0.1.2", - "istanbul-lib-coverage": "^3.0.0", - "semver": "^6.3.0" - }, - "dependencies": { - "semver": { - "version": "6.3.0", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz", - "integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==", - "dev": true - } - } - }, - "istanbul-lib-processinfo": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/istanbul-lib-processinfo/-/istanbul-lib-processinfo-2.0.2.tgz", - "integrity": "sha512-kOwpa7z9hme+IBPZMzQ5vdQj8srYgAtaRqeI48NGmAQ+/5yKiHLV0QbYqQpxsdEF0+w14SoB8YbnHKcXE2KnYw==", - "dev": true, - "requires": { - "archy": "^1.0.0", - "cross-spawn": "^7.0.0", - "istanbul-lib-coverage": "^3.0.0-alpha.1", - "make-dir": "^3.0.0", - "p-map": "^3.0.0", - "rimraf": "^3.0.0", - "uuid": "^3.3.3" - }, - "dependencies": { - "cross-spawn": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", - "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", - "dev": true, - "requires": { - "path-key": "^3.1.0", - "shebang-command": "^2.0.0", - "which": "^2.0.1" - } - }, - "path-key": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", - "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", - "dev": true - }, - "shebang-command": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", - "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", - "dev": true, - "requires": { - "shebang-regex": "^3.0.0" - } - }, - "shebang-regex": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", - "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", - "dev": true - }, - "which": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", - "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", - "dev": true, - "requires": { - "isexe": "^2.0.0" - } - } - } - }, - "istanbul-lib-report": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/istanbul-lib-report/-/istanbul-lib-report-3.0.0.tgz", - "integrity": "sha512-wcdi+uAKzfiGT2abPpKZ0hSU1rGQjUQnLvtY5MpQ7QCTahD3VODhcu4wcfY1YtkGaDD5yuydOLINXsfbus9ROw==", - "dev": true, - "requires": { - "istanbul-lib-coverage": "^3.0.0", - "make-dir": "^3.0.0", - "supports-color": "^7.1.0" - }, - "dependencies": { - "has-flag": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", - "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", - "dev": true - }, - "supports-color": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", - "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", - "dev": true, - "requires": { - "has-flag": "^4.0.0" - } - } - } - }, - "istanbul-lib-source-maps": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/istanbul-lib-source-maps/-/istanbul-lib-source-maps-4.0.0.tgz", - "integrity": "sha512-c16LpFRkR8vQXyHZ5nLpY35JZtzj1PQY1iZmesUbf1FZHbIupcWfjgOXBY9YHkLEQ6puz1u4Dgj6qmU/DisrZg==", - "dev": true, - "requires": { - "debug": "^4.1.1", - "istanbul-lib-coverage": "^3.0.0", - "source-map": "^0.6.1" - }, - "dependencies": { - "debug": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", - "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", - "dev": true, - "requires": { - "ms": "2.1.2" - } - }, - "source-map": { - "version": "0.6.1", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", - "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", - "dev": true - } - } - }, - "istanbul-reports": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/istanbul-reports/-/istanbul-reports-3.0.2.tgz", - "integrity": "sha512-9tZvz7AiR3PEDNGiV9vIouQ/EAcqMXFmkcA1CDFTwOB98OZVDL0PH9glHotf5Ugp6GCOTypfzGWI/OqjWNCRUw==", - "dev": true, - "requires": { - "html-escaper": "^2.0.0", - "istanbul-lib-report": "^3.0.0" - } - }, - "iterable-to-stream": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/iterable-to-stream/-/iterable-to-stream-1.0.1.tgz", - "integrity": "sha512-O62gD5ADMUGtJoOoM9U6LQ7i4byPXUNoHJ6mqsmkQJcom331ZJGDApWgDESWyBMEHEJRjtHozgIiTzYo9RU4UA==", - "dev": true - }, - "js-base64": { - "version": "2.6.4", - "resolved": "https://registry.npmjs.org/js-base64/-/js-base64-2.6.4.tgz", - "integrity": "sha512-pZe//GGmwJndub7ZghVHz7vjb2LgC1m8B07Au3eYqeqv9emhESByMXxaEgkUkEqJe87oBbSniGYoQNIBklc7IQ==", - "dev": true - }, - "js-tokens": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", - "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", - "dev": true - }, - "js-xxhash": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/js-xxhash/-/js-xxhash-1.0.4.tgz", - "integrity": "sha512-S/6Oo7ruxx5k8m4qlMnbpwQdJjRsvvfcIhIk1dA9c5y5GNhYHKYKu9krEK3QgBax6CxJuf4gRL2opgLkdzWIKg==", - "dev": true - }, - "js-yaml": { - "version": "3.13.1", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.13.1.tgz", - "integrity": "sha512-YfbcO7jXDdyj0DGxYVSlSeQNHbD7XPWvrVWeVUujrQEoZzWJIRrCPoyk6kL6IAjAG2IolMK4T0hNUe0HOUs5Jw==", - "dev": true, - "requires": { - "argparse": "^1.0.7", - "esprima": "^4.0.0" - } - }, - "jsbn": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/jsbn/-/jsbn-0.1.1.tgz", - "integrity": "sha1-peZUwuWi3rXyAdls77yoDA7y9RM=", - "dev": true - }, - "jsdom": { - "version": "11.12.0", - "resolved": "https://registry.npmjs.org/jsdom/-/jsdom-11.12.0.tgz", - "integrity": "sha512-y8Px43oyiBM13Zc1z780FrfNLJCXTL40EWlty/LXUtcjykRBNgLlCjWXpfSPBl2iv+N7koQN+dvqszHZgT/Fjw==", - "dev": true, - "requires": { - "abab": "^2.0.0", - "acorn": "^5.5.3", - "acorn-globals": "^4.1.0", - "array-equal": "^1.0.0", - "cssom": ">= 0.3.2 < 0.4.0", - "cssstyle": "^1.0.0", - "data-urls": "^1.0.0", - "domexception": "^1.0.1", - "escodegen": "^1.9.1", - "html-encoding-sniffer": "^1.0.2", - "left-pad": "^1.3.0", - "nwsapi": "^2.0.7", - "parse5": "4.0.0", - "pn": "^1.1.0", - "request": "^2.87.0", - "request-promise-native": "^1.0.5", - "sax": "^1.2.4", - "symbol-tree": "^3.2.2", - "tough-cookie": "^2.3.4", - "w3c-hr-time": "^1.0.1", - "webidl-conversions": "^4.0.2", - "whatwg-encoding": "^1.0.3", - "whatwg-mimetype": "^2.1.0", - "whatwg-url": "^6.4.1", - "ws": "^5.2.0", - "xml-name-validator": "^3.0.0" - } - }, - "jsesc": { - "version": "2.5.2", - "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-2.5.2.tgz", - "integrity": "sha512-OYu7XEzjkCQ3C5Ps3QIZsQfNpqoJyZZA99wd9aWd05NCtC5pWOkShK2mkL6HXQR6/Cy2lbNdPlZBpuQHXE63gA==", - "dev": true - }, - "json-parser": { - "version": "1.1.5", - "resolved": "https://registry.npmjs.org/json-parser/-/json-parser-1.1.5.tgz", - "integrity": "sha1-5i7FJh0aal/CDoEqMgdAxtkAVnc=", - "dev": true, - "requires": { - "esprima": "^2.7.0" - }, - "dependencies": { - "esprima": { - "version": "2.7.3", - "resolved": "https://registry.npmjs.org/esprima/-/esprima-2.7.3.tgz", - "integrity": "sha1-luO3DVd59q1JzQMmc9HDEnZ7pYE=", - "dev": true - } - } - }, - "json-pointer": { - "version": "0.6.1", - "resolved": "https://registry.npmjs.org/json-pointer/-/json-pointer-0.6.1.tgz", - "integrity": "sha512-3OvjqKdCBvH41DLpV4iSt6v2XhZXV1bPB4OROuknvUXI7ZQNofieCPkmE26stEJ9zdQuvIxDHCuYhfgxFAAs+Q==", - "dev": true, - "requires": { - "foreach": "^2.0.4" - } - }, - "json-refs": { - "version": "3.0.15", - "resolved": "https://registry.npmjs.org/json-refs/-/json-refs-3.0.15.tgz", - "integrity": "sha512-0vOQd9eLNBL18EGl5yYaO44GhixmImes2wiYn9Z3sag3QnehWrYWlB9AFtMxCL2Bj3fyxgDYkxGFEU/chlYssw==", - "dev": true, - "requires": { - "commander": "~4.1.1", - "graphlib": "^2.1.8", - "js-yaml": "^3.13.1", - "lodash": "^4.17.15", - "native-promise-only": "^0.8.1", - "path-loader": "^1.0.10", - "slash": "^3.0.0", - "uri-js": "^4.2.2" - } - }, - "json-schema": { - "version": "0.2.3", - "resolved": "https://registry.npmjs.org/json-schema/-/json-schema-0.2.3.tgz", - "integrity": "sha1-tIDIkuWaLwWVTOcnvT8qTogvnhM=", - "dev": true - }, - "json-schema-faker": { - "version": "0.5.0-rcv.32", - "resolved": "https://registry.npmjs.org/json-schema-faker/-/json-schema-faker-0.5.0-rcv.32.tgz", - "integrity": "sha512-buGuuOhzxrf9FWGFybiGNiflGODIC5doU0r23+3MAOyjMR9/KsKolHANSbQnM4N+mmw/dbv9byT3oKZ1wp8v2A==", - "dev": true, - "requires": { - "json-schema-ref-parser": "^6.1.0", - "jsonpath-plus": "^3.0.0", - "randexp": "^0.5.3" - } - }, - "json-schema-ref-parser": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/json-schema-ref-parser/-/json-schema-ref-parser-6.1.0.tgz", - "integrity": "sha1-MK80rqtb7gQx2oBdrA6yG1dL9j0=", - "dev": true, - "requires": { - "call-me-maybe": "^1.0.1", - "js-yaml": "^3.12.1", - "ono": "^4.0.11" - } - }, - "json-schema-traverse": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", - "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", - "dev": true - }, - "json-stringify-safe": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/json-stringify-safe/-/json-stringify-safe-5.0.1.tgz", - "integrity": "sha1-Epai1Y/UXxmg9s4B1lcB4sc1tus=", - "dev": true - }, - "json5": { - "version": "2.1.3", - "resolved": "https://registry.npmjs.org/json5/-/json5-2.1.3.tgz", - "integrity": "sha512-KXPvOm8K9IJKFM0bmdn8QXh7udDh1g/giieX0NLCaMnb4hEiVFqnop2ImTXCc5e0/oHz3LTqmHGtExn5hfMkOA==", - "dev": true, - "requires": { - "minimist": "^1.2.5" - } - }, - "jsonfile": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz", - "integrity": "sha1-h3Gq4HmbZAdrdmQPygWPnBDjPss=", - "dev": true, - "requires": { - "graceful-fs": "^4.1.6" - } - }, - "jsonpath": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/jsonpath/-/jsonpath-1.0.2.tgz", - "integrity": "sha512-rmzlgFZiQPc6q4HDyK8s9Qb4oxBnI5sF61y/Co5PV0lc3q2bIuRsNdueVbhoSHdKM4fxeimphOAtfz47yjCfeA==", - "dev": true, - "requires": { - "esprima": "1.2.2", - "static-eval": "2.0.2", - "underscore": "^1.12.1" - }, - "dependencies": { - "esprima": { - "version": "1.2.2", - "resolved": "https://registry.npmjs.org/esprima/-/esprima-1.2.2.tgz", - "integrity": "sha1-dqD9Zvz+FU/SkmZ9wmQBl1CxZXs=", - "dev": true - } - } - }, - "jsonpath-plus": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/jsonpath-plus/-/jsonpath-plus-3.0.0.tgz", - "integrity": "sha512-WQwgWEBgn+SJU1tlDa/GiY5/ngRpa9yrSj8n4BYPHcwoxTDaMEaYCHMOn42hIHHDd3CrUoRr3+HpsK0hCKoxzA==", - "dev": true - }, - "jsonschema": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/jsonschema/-/jsonschema-1.2.4.tgz", - "integrity": "sha512-lz1nOH69GbsVHeVgEdvyavc/33oymY1AZwtePMiMj4HZPMbP5OIKK3zT9INMWjwua/V4Z4yq7wSlBbSG+g4AEw==", - "dev": true - }, - "jsonschema-draft4": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/jsonschema-draft4/-/jsonschema-draft4-1.0.0.tgz", - "integrity": "sha1-8K8gBQVPDwrefqIRhhS2ncUS2GU=", - "dev": true - }, - "jsprim": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/jsprim/-/jsprim-1.4.1.tgz", - "integrity": "sha1-MT5mvB5cwG5Di8G3SZwuXFastqI=", - "dev": true, - "requires": { - "assert-plus": "1.0.0", - "extsprintf": "1.3.0", - "json-schema": "0.2.3", - "verror": "1.10.0" - } - }, - "kind-of": { - "version": "6.0.3", - "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.3.tgz", - "integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==", - "dev": true - }, - "kuler": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/kuler/-/kuler-2.0.0.tgz", - "integrity": "sha512-Xq9nH7KlWZmXAtodXDDRE7vs6DU1gTU8zYDHDiWLSip45Egwq3plLHzPn27NgvzL2r1LMPC1vdqh98sQxtqj4A==", - "dev": true - }, - "left-pad": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/left-pad/-/left-pad-1.3.0.tgz", - "integrity": "sha512-XI5MPzVNApjAyhQzphX8BkmKsKUxD4LdyK24iZeQGinBN9yTQT3bFlCBy/aVx2HrNcqQGsdot8ghrjyrvMCoEA==", - "dev": true - }, - "levn": { - "version": "0.3.0", - "resolved": "https://registry.npmjs.org/levn/-/levn-0.3.0.tgz", - "integrity": "sha1-OwmSTt+fCDwEkP3UwLxEIeBHZO4=", - "dev": true, - "requires": { - "prelude-ls": "~1.1.2", - "type-check": "~0.3.2" - } - }, - "linq": { - "version": "3.2.3", - "resolved": "https://registry.npmjs.org/linq/-/linq-3.2.3.tgz", - "integrity": "sha512-OI48ncDVi29Hc4g5+hPd58AkI8YtLUFkZWWvvyC+w1+j8PsDi28tLZnbv3+8PvxSiJUEQDihkQjrIrPkFzEFqQ==", - "dev": true - }, - "locate-path": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-3.0.0.tgz", - "integrity": "sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A==", - "dev": true, - "requires": { - "p-locate": "^3.0.0", - "path-exists": "^3.0.0" - } - }, - "lodash": { - "version": "4.17.21", - "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", - "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", - "dev": true - }, - "lodash.flattendeep": { - "version": "4.4.0", - "resolved": "https://registry.npmjs.org/lodash.flattendeep/-/lodash.flattendeep-4.4.0.tgz", - "integrity": "sha1-+wMJF/hqMTTlvJvsDWngAT3f7bI=", - "dev": true - }, - "lodash.get": { - "version": "4.4.2", - "resolved": "https://registry.npmjs.org/lodash.get/-/lodash.get-4.4.2.tgz", - "integrity": "sha1-LRd/ZS+jHpObRDjVNBSZ36OCXpk=", - "dev": true - }, - "lodash.isequal": { - "version": "4.5.0", - "resolved": "https://registry.npmjs.org/lodash.isequal/-/lodash.isequal-4.5.0.tgz", - "integrity": "sha1-QVxEePK8wwEgwizhDtMib30+GOA=", - "dev": true - }, - "lodash.set": { - "version": "4.3.2", - "resolved": "https://registry.npmjs.org/lodash.set/-/lodash.set-4.3.2.tgz", - "integrity": "sha1-2HV7HagH3eJIFrDWqEvqGnYjCyM=", - "dev": true - }, - "lodash.sortby": { - "version": "4.7.0", - "resolved": "https://registry.npmjs.org/lodash.sortby/-/lodash.sortby-4.7.0.tgz", - "integrity": "sha1-7dFMgk4sycHgsKG0K7UhBRakJDg=", - "dev": true - }, - "lodash.uniq": { - "version": "4.5.0", - "resolved": "https://registry.npmjs.org/lodash.uniq/-/lodash.uniq-4.5.0.tgz", - "integrity": "sha1-0CJTc662Uq3BvILklFM5qEJ1R3M=", - "dev": true - }, - "log-symbols": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/log-symbols/-/log-symbols-2.2.0.tgz", - "integrity": "sha512-VeIAFslyIerEJLXHziedo2basKbMKtTw3vfn5IzG0XTjhAVEJyNHnL2p7vc+wBDSdQuUpNw3M2u6xb9QsAY5Eg==", - "dev": true, - "requires": { - "chalk": "^2.0.1" - } - }, - "logform": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/logform/-/logform-2.2.0.tgz", - "integrity": "sha512-N0qPlqfypFx7UHNn4B3lzS/b0uLqt2hmuoa+PpuXNYgozdJYAyauF5Ky0BWVjrxDlMWiT3qN4zPq3vVAfZy7Yg==", - "dev": true, - "requires": { - "colors": "^1.2.1", - "fast-safe-stringify": "^2.0.4", - "fecha": "^4.2.0", - "ms": "^2.1.1", - "triple-beam": "^1.3.0" - }, - "dependencies": { - "colors": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/colors/-/colors-1.4.0.tgz", - "integrity": "sha512-a+UqTh4kgZg/SlGvfbzDHpgRu7AAQOmmqRHJnxhRZICKFUT91brVhNNt58CMWU9PsBbv3PDCZUHbVxuDiH2mtA==", - "dev": true - } - } - }, - "macos-release": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/macos-release/-/macos-release-2.4.1.tgz", - "integrity": "sha512-H/QHeBIN1fIGJX517pvK8IEK53yQOW7YcEI55oYtgjDdoCQQz7eJS94qt5kNrscReEyuD/JcdFCm2XBEcGOITg==", - "dev": true - }, - "make-dir": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-3.0.0.tgz", - "integrity": "sha512-grNJDhb8b1Jm1qeqW5R/O63wUo4UXo2v2HMic6YT9i/HBlF93S8jkMgH7yugvY9ABDShH4VZMn8I+U8+fCNegw==", - "dev": true, - "requires": { - "semver": "^6.0.0" - }, - "dependencies": { - "semver": { - "version": "6.3.0", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz", - "integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==", - "dev": true - } - } - }, - "make-error": { - "version": "1.3.5", - "resolved": "https://registry.npmjs.org/make-error/-/make-error-1.3.5.tgz", - "integrity": "sha512-c3sIjNUow0+8swNwVpqoH4YCShKNFkMaw6oH1mNS2haDZQqkeZFlHS3dhoeEbKKmJB4vXpJucU6oH75aDYeE9g==", - "dev": true - }, - "map-age-cleaner": { - "version": "0.1.3", - "resolved": "https://registry.npmjs.org/map-age-cleaner/-/map-age-cleaner-0.1.3.tgz", - "integrity": "sha512-bJzx6nMoP6PDLPBFmg7+xRKeFZvFboMrGlxmNj9ClvX53KrmvM5bXFXEWjbz4cz1AFn+jWJ9z/DJSz7hrs0w3w==", - "dev": true, - "requires": { - "p-defer": "^1.0.0" - } - }, - "map-cache": { - "version": "0.2.2", - "resolved": "https://registry.npmjs.org/map-cache/-/map-cache-0.2.2.tgz", - "integrity": "sha1-wyq9C9ZSXZsFFkW7TyasXcmKDb8=", - "dev": true - }, - "map-visit": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/map-visit/-/map-visit-1.0.0.tgz", - "integrity": "sha1-7Nyo8TFE5mDxtb1B8S80edmN+48=", - "dev": true, - "requires": { - "object-visit": "^1.0.0" - } - }, - "md5-file": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/md5-file/-/md5-file-4.0.0.tgz", - "integrity": "sha512-UC0qFwyAjn4YdPpKaDNw6gNxRf7Mcx7jC1UGCY4boCzgvU2Aoc1mOGzTtrjjLKhM5ivsnhoKpQVxKPp+1j1qwg==", - "dev": true - }, - "mdurl": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-1.0.1.tgz", - "integrity": "sha1-/oWy7HWlkDfyrf7BAP1sYBdhFS4=", - "dev": true - }, - "mem": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/mem/-/mem-4.3.0.tgz", - "integrity": "sha512-qX2bG48pTqYRVmDB37rn/6PT7LcR8T7oAX3bf99u1Tt1nzxYfxkgqDwUwolPlXweM0XzBOBFzSx4kfp7KP1s/w==", - "dev": true, - "requires": { - "map-age-cleaner": "^0.1.1", - "mimic-fn": "^2.0.0", - "p-is-promise": "^2.0.0" - } - }, - "merge2": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", - "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", - "dev": true - }, - "methods": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/methods/-/methods-1.1.2.tgz", - "integrity": "sha1-VSmk1nZUE07cxSZmVoNbD4Ua/O4=", - "dev": true - }, - "micromatch": { - "version": "3.1.10", - "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-3.1.10.tgz", - "integrity": "sha512-MWikgl9n9M3w+bpsY3He8L+w9eF9338xRl8IAO5viDizwSzziFEyUzo2xrrloB64ADbTf8uA8vRqqttDTOmccg==", - "dev": true, - "requires": { - "arr-diff": "^4.0.0", - "array-unique": "^0.3.2", - "braces": "^2.3.1", - "define-property": "^2.0.2", - "extend-shallow": "^3.0.2", - "extglob": "^2.0.4", - "fragment-cache": "^0.2.1", - "kind-of": "^6.0.2", - "nanomatch": "^1.2.9", - "object.pick": "^1.3.0", - "regex-not": "^1.0.0", - "snapdragon": "^0.8.1", - "to-regex": "^3.0.2" - } - }, - "mime": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/mime/-/mime-1.6.0.tgz", - "integrity": "sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg==", - "dev": true - }, - "mime-db": { - "version": "1.44.0", - "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.44.0.tgz", - "integrity": "sha512-/NOTfLrsPBVeH7YtFPgsVWveuL+4SjjYxaQ1xtM1KMFj7HdxlBlxeyNLzhyJVx7r4rZGJAZ/6lkKCitSc/Nmpg==", - "dev": true - }, - "mime-types": { - "version": "2.1.27", - "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.27.tgz", - "integrity": "sha512-JIhqnCasI9yD+SsmkquHBxTSEuZdQX5BuQnS2Vc7puQQQ+8yiP5AY5uWhpdv4YL4VM5c6iliiYWPgJ/nJQLp7w==", - "dev": true, - "requires": { - "mime-db": "1.44.0" - } - }, - "mimic-fn": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz", - "integrity": "sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==", - "dev": true - }, - "minimatch": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz", - "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==", - "dev": true, - "requires": { - "brace-expansion": "^1.1.7" - } - }, - "minimist": { - "version": "1.2.5", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz", - "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==", - "dev": true - }, - "mixin-deep": { - "version": "1.3.2", - "resolved": "https://registry.npmjs.org/mixin-deep/-/mixin-deep-1.3.2.tgz", - "integrity": "sha512-WRoDn//mXBiJ1H40rqa3vH0toePwSsGb45iInWlTySa+Uu4k3tYUSxa2v1KqAiLtvlrSzaExqS1gtk96A9zvEA==", - "dev": true, - "requires": { - "for-in": "^1.0.2", - "is-extendable": "^1.0.1" - }, - "dependencies": { - "is-extendable": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/is-extendable/-/is-extendable-1.0.1.tgz", - "integrity": "sha512-arnXMxT1hhoKo9k1LZdmlNyJdDDfy2v0fXjFlmok4+i8ul/6WlbVge9bhM74OpNPQPMGUToDtz+KXa1PneJxOA==", - "dev": true, - "requires": { - "is-plain-object": "^2.0.4" - } - }, - "is-plain-object": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-2.0.4.tgz", - "integrity": "sha512-h5PpgXkWitc38BBMYawTYMWJHFZJVnBquFE57xFpjB8pJFiF6gZ+bU+WyI/yqXiFR5mdLsgYNaPe8uao6Uv9Og==", - "dev": true, - "requires": { - "isobject": "^3.0.1" - } - } - } - }, - "mkdirp": { - "version": "0.5.1", - "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.1.tgz", - "integrity": "sha1-MAV0OOrGz3+MR2fzhkjWaX11yQM=", - "dev": true, - "requires": { - "minimist": "0.0.8" - }, - "dependencies": { - "minimist": { - "version": "0.0.8", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-0.0.8.tgz", - "integrity": "sha1-hX/Kv8M5fSYluCKCYuhqp6ARsF0=", - "dev": true - } - } - }, - "mocha": { - "version": "6.2.0", - "resolved": "https://registry.npmjs.org/mocha/-/mocha-6.2.0.tgz", - "integrity": "sha512-qwfFgY+7EKAAUAdv7VYMZQknI7YJSGesxHyhn6qD52DV8UcSZs5XwCifcZGMVIE4a5fbmhvbotxC0DLQ0oKohQ==", - "dev": true, - "requires": { - "ansi-colors": "3.2.3", - "browser-stdout": "1.3.1", - "debug": "3.2.6", - "diff": "3.5.0", - "escape-string-regexp": "1.0.5", - "find-up": "3.0.0", - "glob": "7.1.3", - "growl": "1.10.5", - "he": "1.2.0", - "js-yaml": "3.13.1", - "log-symbols": "2.2.0", - "minimatch": "3.0.4", - "mkdirp": "0.5.1", - "ms": "2.1.1", - "node-environment-flags": "1.0.5", - "object.assign": "4.1.0", - "strip-json-comments": "2.0.1", - "supports-color": "6.0.0", - "which": "1.3.1", - "wide-align": "1.1.3", - "yargs": "13.2.2", - "yargs-parser": "13.0.0", - "yargs-unparser": "1.5.0" - }, - "dependencies": { - "ansi-regex": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-3.0.0.tgz", - "integrity": "sha1-7QMXwyIGT3lGbAKWa922Bas32Zg=", - "dev": true - }, - "cliui": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/cliui/-/cliui-4.1.0.tgz", - "integrity": "sha512-4FG+RSG9DL7uEwRUZXZn3SS34DiDPfzP0VOiEwtUWlE+AR2EIg+hSyvrIgUUfhdgR/UkAeW2QHgeP+hWrXs7jQ==", - "dev": true, - "requires": { - "string-width": "^2.1.1", - "strip-ansi": "^4.0.0", - "wrap-ansi": "^2.0.0" - }, - "dependencies": { - "string-width": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-2.1.1.tgz", - "integrity": "sha512-nOqH59deCq9SRHlxq1Aw85Jnt4w6KvLKqWVik6oA9ZklXLNIOlqg4F2yrT1MVaTjAqvVwdfeZ7w7aCvJD7ugkw==", - "dev": true, - "requires": { - "is-fullwidth-code-point": "^2.0.0", - "strip-ansi": "^4.0.0" - } - } - } - }, - "glob": { - "version": "7.1.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.3.tgz", - "integrity": "sha512-vcfuiIxogLV4DlGBHIUOwI0IbrJ8HWPc4MU7HzviGeNho/UJDfi6B5p3sHeWIQ0KGIU0Jpxi5ZHxemQfLkkAwQ==", - "dev": true, - "requires": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^3.0.4", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" - } - }, - "has-flag": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", - "integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0=", - "dev": true - }, - "invert-kv": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/invert-kv/-/invert-kv-2.0.0.tgz", - "integrity": "sha512-wPVv/y/QQ/Uiirj/vh3oP+1Ww+AWehmi1g5fFWGPF6IpCBCDVrhgHRMvrLfdYcwDh3QJbGXDW4JAuzxElLSqKA==", - "dev": true - }, - "lcid": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/lcid/-/lcid-2.0.0.tgz", - "integrity": "sha512-avPEb8P8EGnwXKClwsNUgryVjllcRqtMYa49NTsbQagYuT1DcXnl1915oxWjoyGrXR6zH/Y0Zc96xWsPcoDKeA==", - "dev": true, - "requires": { - "invert-kv": "^2.0.0" - } - }, - "ms": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.1.tgz", - "integrity": "sha512-tgp+dl5cGk28utYktBsrFqA7HKgrhgPsg6Z/EfhWI4gl1Hwq8B/GmY/0oXZ6nF8hDVesS/FpnYaD/kOWhYQvyg==", - "dev": true - }, - "os-locale": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/os-locale/-/os-locale-3.1.0.tgz", - "integrity": "sha512-Z8l3R4wYWM40/52Z+S265okfFj8Kt2cC2MKY+xNi3kFs+XGI7WXu/I309QQQYbRW4ijiZ+yxs9pqEhJh0DqW3Q==", - "dev": true, - "requires": { - "execa": "^1.0.0", - "lcid": "^2.0.0", - "mem": "^4.0.0" - } - }, - "strip-ansi": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-4.0.0.tgz", - "integrity": "sha1-qEeQIusaw2iocTibY1JixQXuNo8=", - "dev": true, - "requires": { - "ansi-regex": "^3.0.0" - } - }, - "supports-color": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-6.0.0.tgz", - "integrity": "sha512-on9Kwidc1IUQo+bQdhi8+Tijpo0e1SS6RoGo2guUwn5vdaxw8RXOF9Vb2ws+ihWOmh4JnCJOvaziZWP1VABaLg==", - "dev": true, - "requires": { - "has-flag": "^3.0.0" - } - }, - "wrap-ansi": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-2.1.0.tgz", - "integrity": "sha1-2Pw9KE3QV5T+hJc8rs3Rz4JP3YU=", - "dev": true, - "requires": { - "string-width": "^1.0.1", - "strip-ansi": "^3.0.1" - }, - "dependencies": { - "ansi-regex": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-2.1.1.tgz", - "integrity": "sha1-w7M6te42DYbg5ijwRorn7yfWVN8=", - "dev": true - }, - "is-fullwidth-code-point": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-1.0.0.tgz", - "integrity": "sha1-754xOG8DGn8NZDr4L95QxFfvAMs=", - "dev": true, - "requires": { - "number-is-nan": "^1.0.0" - } - }, - "string-width": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-1.0.2.tgz", - "integrity": "sha1-EYvfW4zcUaKn5w0hHgfisLmxB9M=", - "dev": true, - "requires": { - "code-point-at": "^1.0.0", - "is-fullwidth-code-point": "^1.0.0", - "strip-ansi": "^3.0.0" - } - }, - "strip-ansi": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-3.0.1.tgz", - "integrity": "sha1-ajhfuIU9lS1f8F0Oiq+UJ43GPc8=", - "dev": true, - "requires": { - "ansi-regex": "^2.0.0" - } - } - } - }, - "yargs": { - "version": "13.2.2", - "resolved": "https://registry.npmjs.org/yargs/-/yargs-13.2.2.tgz", - "integrity": "sha512-WyEoxgyTD3w5XRpAQNYUB9ycVH/PQrToaTXdYXRdOXvEy1l19br+VJsc0vcO8PTGg5ro/l/GY7F/JMEBmI0BxA==", - "dev": true, - "requires": { - "cliui": "^4.0.0", - "find-up": "^3.0.0", - "get-caller-file": "^2.0.1", - "os-locale": "^3.1.0", - "require-directory": "^2.1.1", - "require-main-filename": "^2.0.0", - "set-blocking": "^2.0.0", - "string-width": "^3.0.0", - "which-module": "^2.0.0", - "y18n": "^4.0.0", - "yargs-parser": "^13.0.0" - } - }, - "yargs-parser": { - "version": "13.0.0", - "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-13.0.0.tgz", - "integrity": "sha512-w2LXjoL8oRdRQN+hOyppuXs+V/fVAYtpcrRxZuF7Kt/Oc+Jr2uAcVntaUTNT6w5ihoWfFDpNY8CPx1QskxZ/pw==", - "dev": true, - "requires": { - "camelcase": "^5.0.0", - "decamelize": "^1.2.0" - } - } - } - }, - "moment": { - "version": "2.29.1", - "resolved": "https://registry.npmjs.org/moment/-/moment-2.29.1.tgz", - "integrity": "sha512-kHmoybcPV8Sqy59DwNDY3Jefr64lK/by/da0ViFcuA4DH0vQg5Q6Ze5VimxkfQNSC+Mls/Kx53s7TjP1RhFEDQ==", - "dev": true - }, - "ms": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", - "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", - "dev": true - }, - "ms-rest": { - "version": "2.5.4", - "resolved": "https://registry.npmjs.org/ms-rest/-/ms-rest-2.5.4.tgz", - "integrity": "sha512-VeqCbawxRM6nhw0RKNfj7TWL7SL8PB6MypqwgylXCi+u412uvYoyY/kSmO8n06wyd8nIcnTbYToCmSKFMI1mCg==", - "dev": true, - "requires": { - "duplexer": "^0.1.1", - "is-buffer": "^1.1.6", - "is-stream": "^1.1.0", - "moment": "^2.21.0", - "request": "^2.88.0", - "through": "^2.3.8", - "tunnel": "0.0.5", - "uuid": "^3.2.1" - } - }, - "nanomatch": { - "version": "1.2.13", - "resolved": "https://registry.npmjs.org/nanomatch/-/nanomatch-1.2.13.tgz", - "integrity": "sha512-fpoe2T0RbHwBTBUOftAfBPaDEi06ufaUai0mE6Yn1kacc3SnTErfb/h+X94VXzI64rKFHYImXSvdwGGCmwOqCA==", - "dev": true, - "requires": { - "arr-diff": "^4.0.0", - "array-unique": "^0.3.2", - "define-property": "^2.0.2", - "extend-shallow": "^3.0.2", - "fragment-cache": "^0.2.1", - "is-windows": "^1.0.2", - "kind-of": "^6.0.2", - "object.pick": "^1.3.0", - "regex-not": "^1.0.0", - "snapdragon": "^0.8.1", - "to-regex": "^3.0.1" - } - }, - "native-promise-only": { - "version": "0.8.1", - "resolved": "https://registry.npmjs.org/native-promise-only/-/native-promise-only-0.8.1.tgz", - "integrity": "sha1-IKMYwwy0X3H+et+/eyHJnBRy7xE=", - "dev": true - }, - "neo-async": { - "version": "2.6.2", - "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz", - "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==", - "dev": true - }, - "nice-try": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/nice-try/-/nice-try-1.0.5.tgz", - "integrity": "sha512-1nh45deeb5olNY7eX82BkPO7SSxR5SSYJiPTrTdFUVYwAl8CKMA5N9PjTYkHiRjisVcxcQ1HXdLhx2qxxJzLNQ==", - "dev": true - }, - "node-environment-flags": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/node-environment-flags/-/node-environment-flags-1.0.5.tgz", - "integrity": "sha512-VNYPRfGfmZLx0Ye20jWzHUjyTW/c+6Wq+iLhDzUI4XmhrDd9l/FozXV3F2xOaXjvp0co0+v1YSR3CMP6g+VvLQ==", - "dev": true, - "requires": { - "object.getownpropertydescriptors": "^2.0.3", - "semver": "^5.7.0" - } - }, - "node-fetch": { - "version": "2.6.1", - "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.1.tgz", - "integrity": "sha512-V4aYg89jEoVRxRb2fJdAg8FHvI7cEyYdVAh94HH0UIK8oJxUfkjlDQN9RbMx+bEjP7+ggMiFRprSti032Oipxw==", - "dev": true - }, - "node-object-hash": { - "version": "1.4.2", - "resolved": "https://registry.npmjs.org/node-object-hash/-/node-object-hash-1.4.2.tgz", - "integrity": "sha512-UdS4swXs85fCGWWf6t6DMGgpN/vnlKeSGEQ7hJcrs7PBFoxoKLmibc3QRb7fwiYsjdL7PX8iI/TMSlZ90dgHhQ==", - "dev": true - }, - "node-preload": { - "version": "0.2.1", - "resolved": "https://registry.npmjs.org/node-preload/-/node-preload-0.2.1.tgz", - "integrity": "sha512-RM5oyBy45cLEoHqCeh+MNuFAxO0vTFBLskvQbOKnEE7YTTSN4tbN8QWDIPQ6L+WvKsB/qLEGpYe2ZZ9d4W9OIQ==", - "dev": true, - "requires": { - "process-on-spawn": "^1.0.0" - } - }, - "nopt": { - "version": "3.0.6", - "resolved": "https://registry.npmjs.org/nopt/-/nopt-3.0.6.tgz", - "integrity": "sha1-xkZdvwirzU2zWTF/eaxopkayj/k=", - "dev": true, - "requires": { - "abbrev": "1" - } - }, - "npm-run-path": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-2.0.2.tgz", - "integrity": "sha1-NakjLfo11wZ7TLLd8jV7GHFTbF8=", - "dev": true, - "requires": { - "path-key": "^2.0.0" - } - }, - "number-is-nan": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/number-is-nan/-/number-is-nan-1.0.1.tgz", - "integrity": "sha1-CXtgK1NCKlIsGvuHkDGDNpQaAR0=", - "dev": true - }, - "nwsapi": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/nwsapi/-/nwsapi-2.2.0.tgz", - "integrity": "sha512-h2AatdwYH+JHiZpv7pt/gSX1XoRGb7L/qSIeuqA6GwYoF9w1vP1cw42TO0aI2pNyshRK5893hNSl+1//vHK7hQ==", - "dev": true - }, - "nyc": { - "version": "15.1.0", - "resolved": "https://registry.npmjs.org/nyc/-/nyc-15.1.0.tgz", - "integrity": "sha512-jMW04n9SxKdKi1ZMGhvUTHBN0EICCRkHemEoE5jm6mTYcqcdas0ATzgUgejlQUHMvpnOZqGB5Xxsv9KxJW1j8A==", - "dev": true, - "requires": { - "@istanbuljs/load-nyc-config": "^1.0.0", - "@istanbuljs/schema": "^0.1.2", - "caching-transform": "^4.0.0", - "convert-source-map": "^1.7.0", - "decamelize": "^1.2.0", - "find-cache-dir": "^3.2.0", - "find-up": "^4.1.0", - "foreground-child": "^2.0.0", - "get-package-type": "^0.1.0", - "glob": "^7.1.6", - "istanbul-lib-coverage": "^3.0.0", - "istanbul-lib-hook": "^3.0.0", - "istanbul-lib-instrument": "^4.0.0", - "istanbul-lib-processinfo": "^2.0.2", - "istanbul-lib-report": "^3.0.0", - "istanbul-lib-source-maps": "^4.0.0", - "istanbul-reports": "^3.0.2", - "make-dir": "^3.0.0", - "node-preload": "^0.2.1", - "p-map": "^3.0.0", - "process-on-spawn": "^1.0.0", - "resolve-from": "^5.0.0", - "rimraf": "^3.0.0", - "signal-exit": "^3.0.2", - "spawn-wrap": "^2.0.0", - "test-exclude": "^6.0.0", - "yargs": "^15.0.2" - }, - "dependencies": { - "find-up": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-4.1.0.tgz", - "integrity": "sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw==", - "dev": true, - "requires": { - "locate-path": "^5.0.0", - "path-exists": "^4.0.0" - } - }, - "glob": { - "version": "7.1.6", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.6.tgz", - "integrity": "sha512-LwaxwyZ72Lk7vZINtNNrywX0ZuLyStrdDtabefZKAY5ZGJhVtgdznluResxNmPitE0SAO+O26sWTHeKSI2wMBA==", - "dev": true, - "requires": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^3.0.4", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" - } - }, - "locate-path": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-5.0.0.tgz", - "integrity": "sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g==", - "dev": true, - "requires": { - "p-locate": "^4.1.0" - } - }, - "p-locate": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-4.1.0.tgz", - "integrity": "sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A==", - "dev": true, - "requires": { - "p-limit": "^2.2.0" - } - }, - "path-exists": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", - "integrity": "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==", - "dev": true - } - } - }, - "oauth-sign": { - "version": "0.9.0", - "resolved": "https://registry.npmjs.org/oauth-sign/-/oauth-sign-0.9.0.tgz", - "integrity": "sha512-fexhUFFPTGV8ybAtSIGbV6gOkSv8UtRbDBnAyLQw4QPKkgNlsH2ByPGtMUqdWkos6YCRmAqViwgZrJc/mRDzZQ==", - "dev": true - }, - "oav": { - "version": "0.22.9", - "resolved": "https://registry.npmjs.org/oav/-/oav-0.22.9.tgz", - "integrity": "sha512-HaeA+nduM5tSx++TjPB15vlZrku5x/8dQPSrK1qOtjkc9gpVfIWAAxV+n0vyLMHeKXKNrD+BdYfhxMhHI/P+MQ==", - "dev": true, - "requires": { - "@azure/openapi-markdown": "^0.9.2", - "@microsoft.azure/autorest-extension-base": "1.0.13", - "@ts-common/commonmark-to-markdown": "^1.2.0", - "@ts-common/iterator": "^0.3.6", - "@ts-common/json": "^0.3.1", - "@ts-common/json-parser": "^0.9.0", - "@ts-common/property-set": "^0.1.0", - "@ts-common/source-map": "^0.5.0", - "@ts-common/string-map": "^0.3.0", - "@ts-common/virtual-fs": "^0.3.0", - "@types/jsonpath": "^0.2.0", - "commonmark": "^0.29.0", - "glob": "^5.0.15", - "globby": "^9.2.0", - "js-yaml": "^3.13.1", - "json-pointer": "^0.6.0", - "json-refs": "^3.0.13", - "jsonpath": "^1.0.1", - "kind-of": "^6.0.3", - "linq": "^3.2.0", - "lodash": "^4.17.15", - "md5-file": "^4.0.0", - "moment": "^2.24.0", - "ms-rest": "^2.5.4", - "swagger-parser": "^6.0.5", - "uuid": "^3.3.2", - "vscode-jsonrpc": "^3.6.2", - "winston": "^3.2.1", - "yargs": "^15.4.1", - "yasway": "^1.10.5", - "yuml2svg": "^4.2.1", - "z-schema": "^4.2.2" - }, - "dependencies": { - "async": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/async/-/async-3.2.0.tgz", - "integrity": "sha512-TR2mEZFVOj2pLStYxLht7TyfuRzaydfpxr3k9RpHIzMgw7A64dzsdqCxH1WJyQdoe8T10nDXd9wnEigmiuHIZw==", - "dev": true - }, - "glob": { - "version": "5.0.15", - "resolved": "https://registry.npmjs.org/glob/-/glob-5.0.15.tgz", - "integrity": "sha1-G8k2ueAvSmA/zCIuz3Yz0wuLk7E=", - "dev": true, - "requires": { - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "2 || 3", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" - } - }, - "is-stream": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.0.tgz", - "integrity": "sha512-XCoy+WlUr7d1+Z8GgSuXmpuUFC9fOhRXglJMx+dwLKTkL44Cjd4W1Z5P+BQZpr+cR93aGP4S/s7Ftw6Nd/kiEw==", - "dev": true - }, - "readable-stream": { - "version": "3.6.0", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.0.tgz", - "integrity": "sha512-BViHy7LKeTz4oNnkcLJ+lVSL6vpiFeX6/d3oSH8zCW7UxP2onchk+vTGB143xuFjHS3deTgkKoXXymXqymiIdA==", - "dev": true, - "requires": { - "inherits": "^2.0.3", - "string_decoder": "^1.1.1", - "util-deprecate": "^1.0.1" - } - }, - "winston": { - "version": "3.3.3", - "resolved": "https://registry.npmjs.org/winston/-/winston-3.3.3.tgz", - "integrity": "sha512-oEXTISQnC8VlSAKf1KYSSd7J6IWuRPQqDdo8eoRNaYKLvwSb5+79Z3Yi1lrl6KDpU6/VWaxpakDAtb1oQ4n9aw==", - "dev": true, - "requires": { - "@dabh/diagnostics": "^2.0.2", - "async": "^3.1.0", - "is-stream": "^2.0.0", - "logform": "^2.2.0", - "one-time": "^1.0.0", - "readable-stream": "^3.4.0", - "stack-trace": "0.0.x", - "triple-beam": "^1.3.0", - "winston-transport": "^4.4.0" - } - } - } - }, - "object-copy": { - "version": "0.1.0", - "resolved": "https://registry.npmjs.org/object-copy/-/object-copy-0.1.0.tgz", - "integrity": "sha1-fn2Fi3gb18mRpBupde04EnVOmYw=", - "dev": true, - "requires": { - "copy-descriptor": "^0.1.0", - "define-property": "^0.2.5", - "kind-of": "^3.0.3" - }, - "dependencies": { - "define-property": { - "version": "0.2.5", - "resolved": "https://registry.npmjs.org/define-property/-/define-property-0.2.5.tgz", - "integrity": "sha1-w1se+RjsPJkPmlvFe+BKrOxcgRY=", - "dev": true, - "requires": { - "is-descriptor": "^0.1.0" - } - }, - "kind-of": { - "version": "3.2.2", - "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-3.2.2.tgz", - "integrity": "sha1-MeohpzS6ubuw8yRm2JOupR5KPGQ=", - "dev": true, - "requires": { - "is-buffer": "^1.1.5" - } - } - } - }, - "object-keys": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", - "integrity": "sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==", - "dev": true - }, - "object-visit": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/object-visit/-/object-visit-1.0.1.tgz", - "integrity": "sha1-95xEk68MU3e1n+OdOV5BBC3QRbs=", - "dev": true, - "requires": { - "isobject": "^3.0.0" - } - }, - "object.assign": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.0.tgz", - "integrity": "sha512-exHJeq6kBKj58mqGyTQ9DFvrZC/eR6OwxzoM9YRoGBqrXYonaFyGiFMuc9VZrXf7DarreEwMpurG3dd+CNyW5w==", - "dev": true, - "requires": { - "define-properties": "^1.1.2", - "function-bind": "^1.1.1", - "has-symbols": "^1.0.0", - "object-keys": "^1.0.11" - } - }, - "object.getownpropertydescriptors": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/object.getownpropertydescriptors/-/object.getownpropertydescriptors-2.0.3.tgz", - "integrity": "sha1-h1jIRvW0B62rDyNuCYbxSwUcqhY=", - "dev": true, - "requires": { - "define-properties": "^1.1.2", - "es-abstract": "^1.5.1" - } - }, - "object.pick": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/object.pick/-/object.pick-1.3.0.tgz", - "integrity": "sha1-h6EKxMFpS9Lhy/U1kaZhQftd10c=", - "dev": true, - "requires": { - "isobject": "^3.0.1" - } - }, - "octokit-pagination-methods": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/octokit-pagination-methods/-/octokit-pagination-methods-1.1.0.tgz", - "integrity": "sha512-fZ4qZdQ2nxJvtcasX7Ghl+WlWS/d9IgnBIwFZXVNNZUmzpno91SX5bc5vuxiuKoCtK78XxGGNuSCrDC7xYB3OQ==", - "dev": true - }, - "once": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", - "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=", - "dev": true, - "requires": { - "wrappy": "1" - } - }, - "one-time": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/one-time/-/one-time-1.0.0.tgz", - "integrity": "sha512-5DXOiRKwuSEcQ/l0kGCF6Q3jcADFv5tSmRaJck/OqkVFcOzutB134KRSfF0xDrL39MNnqxbHBbUUcjZIhTgb2g==", - "dev": true, - "requires": { - "fn.name": "1.x.x" - } - }, - "ono": { - "version": "4.0.11", - "resolved": "https://registry.npmjs.org/ono/-/ono-4.0.11.tgz", - "integrity": "sha512-jQ31cORBFE6td25deYeD80wxKBMj+zBmHTrVxnc6CKhx8gho6ipmWM5zj/oeoqioZ99yqBls9Z/9Nss7J26G2g==", - "dev": true, - "requires": { - "format-util": "^1.0.3" - } - }, - "openapi-schema-validation": { - "version": "0.4.2", - "resolved": "https://registry.npmjs.org/openapi-schema-validation/-/openapi-schema-validation-0.4.2.tgz", - "integrity": "sha512-K8LqLpkUf2S04p2Nphq9L+3bGFh/kJypxIG2NVGKX0ffzT4NQI9HirhiY6Iurfej9lCu7y4Ndm4tv+lm86Ck7w==", - "dev": true, - "requires": { - "jsonschema": "1.2.4", - "jsonschema-draft4": "^1.0.0", - "swagger-schema-official": "2.0.0-bab6bed" - } - }, - "optionator": { - "version": "0.8.3", - "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.8.3.tgz", - "integrity": "sha512-+IW9pACdk3XWmmTXG8m3upGUJst5XRGzxMRjXzAuJ1XnIFNvfhjjIuYkDvysnPQ7qzqVzLt78BCruntqRhWQbA==", - "dev": true, - "requires": { - "deep-is": "~0.1.3", - "fast-levenshtein": "~2.0.6", - "levn": "~0.3.0", - "prelude-ls": "~1.1.2", - "type-check": "~0.3.2", - "word-wrap": "~1.2.3" - } - }, - "os-name": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/os-name/-/os-name-3.1.0.tgz", - "integrity": "sha512-h8L+8aNjNcMpo/mAIBPn5PXCM16iyPGjHNWo6U1YO8sJTMHtEtyczI6QJnLoplswm6goopQkqc7OAnjhWcugVg==", - "dev": true, - "requires": { - "macos-release": "^2.2.0", - "windows-release": "^3.1.0" - } - }, - "p-defer": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/p-defer/-/p-defer-1.0.0.tgz", - "integrity": "sha1-n26xgvbJqozXQwBKfU+WsZaw+ww=", - "dev": true - }, - "p-finally": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/p-finally/-/p-finally-1.0.0.tgz", - "integrity": "sha1-P7z7FbiZpEEjs0ttzBi3JDNqLK4=", - "dev": true - }, - "p-is-promise": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/p-is-promise/-/p-is-promise-2.1.0.tgz", - "integrity": "sha512-Y3W0wlRPK8ZMRbNq97l4M5otioeA5lm1z7bkNkxCka8HSPjR0xRWmpCmc9utiaLP9Jb1eD8BgeIxTW4AIF45Pg==", - "dev": true - }, - "p-limit": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.2.1.tgz", - "integrity": "sha512-85Tk+90UCVWvbDavCLKPOLC9vvY8OwEX/RtKF+/1OADJMVlFfEHOiMTPVyxg7mk/dKa+ipdHm0OUkTvCpMTuwg==", - "dev": true, - "requires": { - "p-try": "^2.0.0" - } - }, - "p-locate": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-3.0.0.tgz", - "integrity": "sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ==", - "dev": true, - "requires": { - "p-limit": "^2.0.0" - } - }, - "p-map": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/p-map/-/p-map-3.0.0.tgz", - "integrity": "sha512-d3qXVTF/s+W+CdJ5A29wywV2n8CQQYahlgz2bFiA+4eVNJbHJodPZ+/gXwPGh0bOqA+j8S+6+ckmvLGPk1QpxQ==", - "dev": true, - "requires": { - "aggregate-error": "^3.0.0" - } - }, - "p-try": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", - "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", - "dev": true - }, - "package-hash": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/package-hash/-/package-hash-4.0.0.tgz", - "integrity": "sha512-whdkPIooSu/bASggZ96BWVvZTRMOFxnyUG5PnTSGKoJE2gd5mbVNmR2Nj20QFzxYYgAXpoqC+AiXzl+UMRh7zQ==", - "dev": true, - "requires": { - "graceful-fs": "^4.1.15", - "hasha": "^5.0.0", - "lodash.flattendeep": "^4.4.0", - "release-zalgo": "^1.0.0" - } - }, - "parse5": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/parse5/-/parse5-4.0.0.tgz", - "integrity": "sha512-VrZ7eOd3T1Fk4XWNXMgiGBK/z0MG48BWG2uQNU4I72fkQuKUTZpl+u9k+CxEG0twMVzSmXEEz12z5Fnw1jIQFA==", - "dev": true - }, - "pascalcase": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/pascalcase/-/pascalcase-0.1.1.tgz", - "integrity": "sha1-s2PlXoAGym/iF4TS2yK9FdeRfxQ=", - "dev": true - }, - "path-dirname": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/path-dirname/-/path-dirname-1.0.2.tgz", - "integrity": "sha1-zDPSTVJeCZpTiMAzbG4yuRYGCeA=", - "dev": true - }, - "path-exists": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-3.0.0.tgz", - "integrity": "sha1-zg6+ql94yxiSXqfYENe1mwEP1RU=", - "dev": true - }, - "path-is-absolute": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", - "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=", - "dev": true - }, - "path-key": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/path-key/-/path-key-2.0.1.tgz", - "integrity": "sha1-QRyttXTFoUDTpLGRDUDYDMn0C0A=", - "dev": true - }, - "path-loader": { - "version": "1.0.10", - "resolved": "https://registry.npmjs.org/path-loader/-/path-loader-1.0.10.tgz", - "integrity": "sha512-CMP0v6S6z8PHeJ6NFVyVJm6WyJjIwFvyz2b0n2/4bKdS/0uZa/9sKUlYZzubrn3zuDRU0zIuEDX9DZYQ2ZI8TA==", - "dev": true, - "requires": { - "native-promise-only": "^0.8.1", - "superagent": "^3.8.3" - } - }, - "path-parse": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.6.tgz", - "integrity": "sha512-GSmOT2EbHrINBf9SR7CDELwlJ8AENk3Qn7OikK4nFYAu3Ote2+JYNVvkpAEQm3/TLNEJFD/xZJjzyxg3KBWOzw==", - "dev": true - }, - "path-to-regexp": { - "version": "1.8.0", - "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-1.8.0.tgz", - "integrity": "sha512-n43JRhlUKUAlibEJhPeir1ncUID16QnEjNpwzNdO3Lm4ywrBpBZ5oLD0I6br9evr1Y9JTqwRtAh7JLoOzAQdVA==", - "dev": true, - "requires": { - "isarray": "0.0.1" - }, - "dependencies": { - "isarray": { - "version": "0.0.1", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz", - "integrity": "sha1-ihis/Kmo9Bd+Cav8YDiTmwXR7t8=", - "dev": true - } - } - }, - "path-type": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/path-type/-/path-type-3.0.0.tgz", - "integrity": "sha512-T2ZUsdZFHgA3u4e5PfPbjd7HDDpxPnQb5jN0SrDsjNSuVXHJqtwTnWqG0B1jZrgmJ/7lj1EmVIByWt1gxGkWvg==", - "dev": true, - "requires": { - "pify": "^3.0.0" - }, - "dependencies": { - "pify": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/pify/-/pify-3.0.0.tgz", - "integrity": "sha1-5aSs0sEB/fPZpNB/DbxNtJ3SgXY=", - "dev": true - } - } - }, - "performance-now": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/performance-now/-/performance-now-2.1.0.tgz", - "integrity": "sha1-Ywn04OX6kT7BxpMHrjZLSzd8nns=", - "dev": true - }, - "picomatch": { - "version": "2.0.7", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.0.7.tgz", - "integrity": "sha512-oLHIdio3tZ0qH76NybpeneBhYVj0QFTfXEFTc/B3zKQspYfYYkWYgFsmzo+4kvId/bQRcNkVeguI3y+CD22BtA==", - "dev": true - }, - "pify": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/pify/-/pify-4.0.1.tgz", - "integrity": "sha512-uB80kBFb/tfd68bVleG9T5GGsGPjJrLAUpR5PZIrhBnIaRTQRjqdJSsIKkOP6OAIFbj7GOrcudc5pNjZ+geV2g==", - "dev": true - }, - "pkg-dir": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/pkg-dir/-/pkg-dir-4.2.0.tgz", - "integrity": "sha512-HRDzbaKjC+AOWVXxAU/x54COGeIv9eb+6CkDSQoNTt4XyWoIJvuPsXizxu/Fr23EiekbtZwmh1IcIG/l/a10GQ==", - "dev": true, - "requires": { - "find-up": "^4.0.0" - }, - "dependencies": { - "find-up": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-4.1.0.tgz", - "integrity": "sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw==", - "dev": true, - "requires": { - "locate-path": "^5.0.0", - "path-exists": "^4.0.0" - } - }, - "locate-path": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-5.0.0.tgz", - "integrity": "sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g==", - "dev": true, - "requires": { - "p-locate": "^4.1.0" - } - }, - "p-locate": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-4.1.0.tgz", - "integrity": "sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A==", - "dev": true, - "requires": { - "p-limit": "^2.2.0" - } - }, - "path-exists": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", - "integrity": "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==", - "dev": true - } - } - }, - "pn": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/pn/-/pn-1.1.0.tgz", - "integrity": "sha512-2qHaIQr2VLRFoxe2nASzsV6ef4yOOH+Fi9FBOVH6cqeSgUnoyySPZkxzLuzd+RYOQTRpROA0ztTMqxROKSb/nA==", - "dev": true - }, - "posix-character-classes": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/posix-character-classes/-/posix-character-classes-0.1.1.tgz", - "integrity": "sha1-AerA/jta9xoqbAL+q7jB/vfgDqs=", - "dev": true - }, - "prelude-ls": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.1.2.tgz", - "integrity": "sha1-IZMqVJ9eUv/ZqCf1cOBL5iqX2lQ=", - "dev": true - }, - "prettier": { - "version": "1.19.1", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-1.19.1.tgz", - "integrity": "sha1-99f1/4qc2HKnvkyhQglZVqYHl8s=", - "dev": true - }, - "process-nextick-args": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.1.tgz", - "integrity": "sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag==", - "dev": true - }, - "process-on-spawn": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/process-on-spawn/-/process-on-spawn-1.0.0.tgz", - "integrity": "sha512-1WsPDsUSMmZH5LeMLegqkPDrsGgsWwk1Exipy2hvB0o/F0ASzbpIctSCcZIK1ykJvtTJULEH+20WOFjMvGnCTg==", - "dev": true, - "requires": { - "fromentries": "^1.2.0" - } - }, - "psl": { - "version": "1.8.0", - "resolved": "https://registry.npmjs.org/psl/-/psl-1.8.0.tgz", - "integrity": "sha512-RIdOzyoavK+hA18OGGWDqUTsCLhtA7IcZ/6NCs4fFJaHBDab+pDDmDIByWFRQJq2Cd7r1OoQxBGKOaztq+hjIQ==", - "dev": true - }, - "pump": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/pump/-/pump-3.0.0.tgz", - "integrity": "sha512-LwZy+p3SFs1Pytd/jYct4wpv49HiYCqd9Rlc5ZVdk0V+8Yzv6jR5Blk3TRmPL1ft69TxP0IMZGJ+WPFU2BFhww==", - "dev": true, - "requires": { - "end-of-stream": "^1.1.0", - "once": "^1.3.1" - } - }, - "punycode": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz", - "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==", - "dev": true - }, - "qs": { - "version": "6.9.4", - "resolved": "https://registry.npmjs.org/qs/-/qs-6.9.4.tgz", - "integrity": "sha512-A1kFqHekCTM7cz0udomYUoYNWjBebHm/5wzU/XqrBRBNWectVH0QIiN+NEcZ0Dte5hvzHwbr8+XQmguPhJ6WdQ==", - "dev": true - }, - "randexp": { - "version": "0.5.3", - "resolved": "https://registry.npmjs.org/randexp/-/randexp-0.5.3.tgz", - "integrity": "sha512-U+5l2KrcMNOUPYvazA3h5ekF80FHTUG+87SEAmHZmolh1M+i/WyTCxVzmi+tidIa1tM4BSe8g2Y/D3loWDjj+w==", - "dev": true, - "requires": { - "drange": "^1.0.2", - "ret": "^0.2.0" - }, - "dependencies": { - "ret": { - "version": "0.2.2", - "resolved": "https://registry.npmjs.org/ret/-/ret-0.2.2.tgz", - "integrity": "sha512-M0b3YWQs7R3Z917WRQy1HHA7Ba7D8hvZg6UE5mLykJxQVE2ju0IXbGlaHPPlkY+WN7wFP+wUMXmBFA0aV6vYGQ==", - "dev": true - } - } - }, - "readable-stream": { - "version": "2.3.7", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.7.tgz", - "integrity": "sha512-Ebho8K4jIbHAxnuxi7o42OrZgF/ZTNcsZj6nRKyUmkhLFq8CHItp/fy6hQZuZmP/n3yZ9VBUbp4zz/mX8hmYPw==", - "dev": true, - "requires": { - "core-util-is": "~1.0.0", - "inherits": "~2.0.3", - "isarray": "~1.0.0", - "process-nextick-args": "~2.0.0", - "safe-buffer": "~5.1.1", - "string_decoder": "~1.1.1", - "util-deprecate": "~1.0.1" - } - }, - "regex-not": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/regex-not/-/regex-not-1.0.2.tgz", - "integrity": "sha512-J6SDjUgDxQj5NusnOtdFxDwN/+HWykR8GELwctJ7mdqhcyy1xEc4SRFHUXvxTp661YaVKAjfRLZ9cCqS6tn32A==", - "dev": true, - "requires": { - "extend-shallow": "^3.0.2", - "safe-regex": "^1.1.0" - } - }, - "release-zalgo": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/release-zalgo/-/release-zalgo-1.0.0.tgz", - "integrity": "sha1-CXALflB0Mpc5Mw5TXFqQ+2eFFzA=", - "dev": true, - "requires": { - "es6-error": "^4.0.1" - } - }, - "repeat-element": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/repeat-element/-/repeat-element-1.1.3.tgz", - "integrity": "sha512-ahGq0ZnV5m5XtZLMb+vP76kcAM5nkLqk0lpqAuojSKGgQtn4eRi4ZZGm2olo2zKFH+sMsWaqOCW1dqAnOru72g==", - "dev": true - }, - "repeat-string": { - "version": "1.6.1", - "resolved": "https://registry.npmjs.org/repeat-string/-/repeat-string-1.6.1.tgz", - "integrity": "sha1-jcrkcOHIirwtYA//Sndihtp15jc=", - "dev": true - }, - "request": { - "version": "2.88.2", - "resolved": "https://registry.npmjs.org/request/-/request-2.88.2.tgz", - "integrity": "sha512-MsvtOrfG9ZcrOwAW+Qi+F6HbD0CWXEh9ou77uOb7FM2WPhwT7smM833PzanhJLsgXjN89Ir6V2PczXNnMpwKhw==", - "dev": true, - "requires": { - "aws-sign2": "~0.7.0", - "aws4": "^1.8.0", - "caseless": "~0.12.0", - "combined-stream": "~1.0.6", - "extend": "~3.0.2", - "forever-agent": "~0.6.1", - "form-data": "~2.3.2", - "har-validator": "~5.1.3", - "http-signature": "~1.2.0", - "is-typedarray": "~1.0.0", - "isstream": "~0.1.2", - "json-stringify-safe": "~5.0.1", - "mime-types": "~2.1.19", - "oauth-sign": "~0.9.0", - "performance-now": "^2.1.0", - "qs": "~6.5.2", - "safe-buffer": "^5.1.2", - "tough-cookie": "~2.5.0", - "tunnel-agent": "^0.6.0", - "uuid": "^3.3.2" - }, - "dependencies": { - "form-data": { - "version": "2.3.3", - "resolved": "https://registry.npmjs.org/form-data/-/form-data-2.3.3.tgz", - "integrity": "sha512-1lLKB2Mu3aGP1Q/2eCOx0fNbRMe7XdwktwOruhfqqd0rIJWwN4Dh+E3hrPSlDCXnSR7UtZ1N38rVXm+6+MEhJQ==", - "dev": true, - "requires": { - "asynckit": "^0.4.0", - "combined-stream": "^1.0.6", - "mime-types": "^2.1.12" - } - }, - "qs": { - "version": "6.5.2", - "resolved": "https://registry.npmjs.org/qs/-/qs-6.5.2.tgz", - "integrity": "sha512-N5ZAX4/LxJmF+7wN74pUD6qAh9/wnvdQcjq9TZjevvXzSUo7bfmw91saqMjzGS2xq91/odN2dW/WOl7qQHNDGA==", - "dev": true - } - } - }, - "request-promise-core": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/request-promise-core/-/request-promise-core-1.1.4.tgz", - "integrity": "sha512-TTbAfBBRdWD7aNNOoVOBH4pN/KigV6LyapYNNlAPA8JwbovRti1E88m3sYAwsLi5ryhPKsE9APwnjFTgdUjTpw==", - "dev": true, - "requires": { - "lodash": "^4.17.19" - } - }, - "request-promise-native": { - "version": "1.0.9", - "resolved": "https://registry.npmjs.org/request-promise-native/-/request-promise-native-1.0.9.tgz", - "integrity": "sha512-wcW+sIUiWnKgNY0dqCpOZkUbF/I+YPi+f09JZIDa39Ec+q82CpSYniDp+ISgTTbKmnpJWASeJBPZmoxH84wt3g==", - "dev": true, - "requires": { - "request-promise-core": "1.1.4", - "stealthy-require": "^1.1.1", - "tough-cookie": "^2.3.3" - } - }, - "require-directory": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", - "integrity": "sha1-jGStX9MNqxyXbiNE/+f3kqam30I=", - "dev": true - }, - "require-main-filename": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/require-main-filename/-/require-main-filename-2.0.0.tgz", - "integrity": "sha512-NKN5kMDylKuldxYLSUfrbo5Tuzh4hd+2E8NPPX02mZtn1VuREQToYe/ZdlJy+J3uCpfaiGF05e7B8W0iXbQHmg==", - "dev": true - }, - "resolve": { - "version": "1.1.7", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.1.7.tgz", - "integrity": "sha1-IDEU2CrSxe2ejgQRs5ModeiJ6Xs=", - "dev": true - }, - "resolve-from": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-5.0.0.tgz", - "integrity": "sha512-qYg9KP24dD5qka9J47d0aVky0N+b4fTU89LN9iDnjB5waksiC49rvMB0PrUJQGoTmH50XPiqOvAjDfaijGxYZw==", - "dev": true - }, - "resolve-url": { - "version": "0.2.1", - "resolved": "https://registry.npmjs.org/resolve-url/-/resolve-url-0.2.1.tgz", - "integrity": "sha1-LGN/53yJOv0qZj/iGqkIAGjiBSo=", - "dev": true - }, - "ret": { - "version": "0.1.15", - "resolved": "https://registry.npmjs.org/ret/-/ret-0.1.15.tgz", - "integrity": "sha512-TTlYpa+OL+vMMNG24xSlQGEJ3B/RzEfUlLct7b5G/ytav+wPrplCpVMFuwzXbkecJrb6IYo1iFb0S9v37754mg==", - "dev": true - }, - "retry": { - "version": "0.12.0", - "resolved": "https://registry.npmjs.org/retry/-/retry-0.12.0.tgz", - "integrity": "sha1-G0KmJmoh8HQh0bC1S33BZ7AcATs=", - "dev": true - }, - "rimraf": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz", - "integrity": "sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==", - "dev": true, - "requires": { - "glob": "^7.1.3" - } - }, - "safe-buffer": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz", - "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==", - "dev": true - }, - "safe-regex": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/safe-regex/-/safe-regex-1.1.0.tgz", - "integrity": "sha1-QKNmnzsHfR6UPURinhV91IAjvy4=", - "dev": true, - "requires": { - "ret": "~0.1.10" - } - }, - "safer-buffer": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", - "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==", - "dev": true - }, - "sax": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/sax/-/sax-1.2.4.tgz", - "integrity": "sha512-NqVDv9TpANUjFm0N8uM5GxL36UgKi9/atZw+x7YFnQ8ckwFGKrl4xX4yWtrey3UJm5nP1kUbnYgLopqWNSRhWw==", - "dev": true - }, - "semver": { - "version": "5.7.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.1.tgz", - "integrity": "sha512-sauaDf/PZdVgrLTNYHRtpXa1iRiKcaebiKQ1BJdpQlWH2lCvexQdX55snPFyK7QzpudqbCI0qXFfOasHdyNDGQ==", - "dev": true - }, - "set-blocking": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/set-blocking/-/set-blocking-2.0.0.tgz", - "integrity": "sha1-BF+XgtARrppoA93TgrJDkrPYkPc=", - "dev": true - }, - "set-value": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/set-value/-/set-value-2.0.1.tgz", - "integrity": "sha512-JxHc1weCN68wRY0fhCoXpyK55m/XPHafOmK4UWD7m2CI14GMcFypt4w/0+NV5f/ZMby2F6S2wwA7fgynh9gWSw==", - "dev": true, - "requires": { - "extend-shallow": "^2.0.1", - "is-extendable": "^0.1.1", - "is-plain-object": "^2.0.3", - "split-string": "^3.0.1" - }, - "dependencies": { - "extend-shallow": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz", - "integrity": "sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=", - "dev": true, - "requires": { - "is-extendable": "^0.1.0" - } - }, - "is-plain-object": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-2.0.4.tgz", - "integrity": "sha512-h5PpgXkWitc38BBMYawTYMWJHFZJVnBquFE57xFpjB8pJFiF6gZ+bU+WyI/yqXiFR5mdLsgYNaPe8uao6Uv9Og==", - "dev": true, - "requires": { - "isobject": "^3.0.1" - } - } - } - }, - "shallow-clone": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/shallow-clone/-/shallow-clone-3.0.1.tgz", - "integrity": "sha512-/6KqX+GVUdqPuPPd2LxDDxzX6CAbjJehAAOKlNpqqUpAqPM6HeL8f+o3a+JsyGjn2lv0WY8UsTgUJjU9Ok55NA==", - "dev": true, - "requires": { - "kind-of": "^6.0.2" - } - }, - "shebang-command": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-1.2.0.tgz", - "integrity": "sha1-RKrGW2lbAzmJaMOfNj/uXer98eo=", - "dev": true, - "requires": { - "shebang-regex": "^1.0.0" - } - }, - "shebang-regex": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-1.0.0.tgz", - "integrity": "sha1-2kL0l0DAtC2yypcoVxyxkMmO/qM=", - "dev": true - }, - "signal-exit": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.2.tgz", - "integrity": "sha1-tf3AjxKH6hF4Yo5BXiUTK3NkbG0=", - "dev": true - }, - "simple-swizzle": { - "version": "0.2.2", - "resolved": "https://registry.npmjs.org/simple-swizzle/-/simple-swizzle-0.2.2.tgz", - "integrity": "sha1-pNprY1/8zMoz9w0Xy5JZLeleVXo=", - "dev": true, - "requires": { - "is-arrayish": "^0.3.1" - } - }, - "slash": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", - "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==", - "dev": true - }, - "snapdragon": { - "version": "0.8.2", - "resolved": "https://registry.npmjs.org/snapdragon/-/snapdragon-0.8.2.tgz", - "integrity": "sha512-FtyOnWN/wCHTVXOMwvSv26d+ko5vWlIDD6zoUJ7LW8vh+ZBC8QdljveRP+crNrtBwioEUWy/4dMtbBjA4ioNlg==", + "mocha": { + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/mocha/-/mocha-6.2.0.tgz", + "integrity": "sha512-qwfFgY+7EKAAUAdv7VYMZQknI7YJSGesxHyhn6qD52DV8UcSZs5XwCifcZGMVIE4a5fbmhvbotxC0DLQ0oKohQ==", "dev": true, "requires": { - "base": "^0.11.1", - "debug": "^2.2.0", - "define-property": "^0.2.5", - "extend-shallow": "^2.0.1", - "map-cache": "^0.2.2", - "source-map": "^0.5.6", - "source-map-resolve": "^0.5.0", - "use": "^3.1.0" + "ansi-colors": "3.2.3", + "browser-stdout": "1.3.1", + "debug": "3.2.6", + "diff": "3.5.0", + "escape-string-regexp": "1.0.5", + "find-up": "3.0.0", + "glob": "7.1.3", + "growl": "1.10.5", + "he": "1.2.0", + "js-yaml": "3.13.1", + "log-symbols": "2.2.0", + "minimatch": "3.0.4", + "mkdirp": "0.5.1", + "ms": "2.1.1", + "node-environment-flags": "1.0.5", + "object.assign": "4.1.0", + "strip-json-comments": "2.0.1", + "supports-color": "6.0.0", + "which": "1.3.1", + "wide-align": "1.1.3", + "yargs": "13.2.2", + "yargs-parser": "13.0.0", + "yargs-unparser": "1.5.0" }, "dependencies": { - "debug": { - "version": "2.6.9", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", - "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", - "dev": true, - "requires": { - "ms": "2.0.0" - } + "ansi-regex": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-3.0.0.tgz", + "integrity": "sha1-7QMXwyIGT3lGbAKWa922Bas32Zg=", + "dev": true }, - "define-property": { - "version": "0.2.5", - "resolved": "https://registry.npmjs.org/define-property/-/define-property-0.2.5.tgz", - "integrity": "sha1-w1se+RjsPJkPmlvFe+BKrOxcgRY=", + "cliui": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/cliui/-/cliui-4.1.0.tgz", + "integrity": "sha512-4FG+RSG9DL7uEwRUZXZn3SS34DiDPfzP0VOiEwtUWlE+AR2EIg+hSyvrIgUUfhdgR/UkAeW2QHgeP+hWrXs7jQ==", "dev": true, "requires": { - "is-descriptor": "^0.1.0" + "string-width": "^2.1.1", + "strip-ansi": "^4.0.0", + "wrap-ansi": "^2.0.0" + }, + "dependencies": { + "string-width": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-2.1.1.tgz", + "integrity": "sha512-nOqH59deCq9SRHlxq1Aw85Jnt4w6KvLKqWVik6oA9ZklXLNIOlqg4F2yrT1MVaTjAqvVwdfeZ7w7aCvJD7ugkw==", + "dev": true, + "requires": { + "is-fullwidth-code-point": "^2.0.0", + "strip-ansi": "^4.0.0" + } + } } }, - "extend-shallow": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz", - "integrity": "sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=", + "glob": { + "version": "7.1.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.3.tgz", + "integrity": "sha512-vcfuiIxogLV4DlGBHIUOwI0IbrJ8HWPc4MU7HzviGeNho/UJDfi6B5p3sHeWIQ0KGIU0Jpxi5ZHxemQfLkkAwQ==", "dev": true, "requires": { - "is-extendable": "^0.1.0" + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.0.4", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" } }, - "ms": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", - "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=", + "has-flag": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", + "integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0=", "dev": true }, - "source-map": { - "version": "0.5.7", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.5.7.tgz", - "integrity": "sha1-igOdLRAh0i0eoUyA2OpGi6LvP8w=", + "invert-kv": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/invert-kv/-/invert-kv-2.0.0.tgz", + "integrity": "sha512-wPVv/y/QQ/Uiirj/vh3oP+1Ww+AWehmi1g5fFWGPF6IpCBCDVrhgHRMvrLfdYcwDh3QJbGXDW4JAuzxElLSqKA==", "dev": true - } - } - }, - "snapdragon-node": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/snapdragon-node/-/snapdragon-node-2.1.1.tgz", - "integrity": "sha512-O27l4xaMYt/RSQ5TR3vpWCAB5Kb/czIcqUFOM/C4fYcLnbZUc1PkjTAMjof2pBWaSTwOUd6qUHcFGVGj7aIwnw==", - "dev": true, - "requires": { - "define-property": "^1.0.0", - "isobject": "^3.0.0", - "snapdragon-util": "^3.0.1" - }, - "dependencies": { - "define-property": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/define-property/-/define-property-1.0.0.tgz", - "integrity": "sha1-dp66rz9KY6rTr56NMEybvnm/sOY=", - "dev": true, - "requires": { - "is-descriptor": "^1.0.0" - } - }, - "is-accessor-descriptor": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-accessor-descriptor/-/is-accessor-descriptor-1.0.0.tgz", - "integrity": "sha512-m5hnHTkcVsPfqx3AKlyttIPb7J+XykHvJP2B9bZDjlhLIoEq4XoK64Vg7boZlVWYK6LUY94dYPEE7Lh0ZkZKcQ==", - "dev": true, - "requires": { - "kind-of": "^6.0.0" - } }, - "is-data-descriptor": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-data-descriptor/-/is-data-descriptor-1.0.0.tgz", - "integrity": "sha512-jbRXy1FmtAoCjQkVmIVYwuuqDFUbaOeDjmed1tOGPrsMhtJA4rD9tkgA0F1qJ3gRFRXcHYVkdeaP50Q5rE/jLQ==", + "lcid": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/lcid/-/lcid-2.0.0.tgz", + "integrity": "sha512-avPEb8P8EGnwXKClwsNUgryVjllcRqtMYa49NTsbQagYuT1DcXnl1915oxWjoyGrXR6zH/Y0Zc96xWsPcoDKeA==", "dev": true, "requires": { - "kind-of": "^6.0.0" + "invert-kv": "^2.0.0" } }, - "is-descriptor": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/is-descriptor/-/is-descriptor-1.0.2.tgz", - "integrity": "sha512-2eis5WqQGV7peooDyLmNEPUrps9+SXX5c9pL3xEB+4e9HnGuDa7mB7kHxHw4CbqS9k1T2hOH3miL8n8WtiYVtg==", - "dev": true, - "requires": { - "is-accessor-descriptor": "^1.0.0", - "is-data-descriptor": "^1.0.0", - "kind-of": "^6.0.2" - } - } - } - }, - "snapdragon-util": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/snapdragon-util/-/snapdragon-util-3.0.1.tgz", - "integrity": "sha512-mbKkMdQKsjX4BAL4bRYTj21edOf8cN7XHdYUJEe+Zn99hVEYcMvKPct1IqNe7+AZPirn8BCDOQBHQZknqmKlZQ==", - "dev": true, - "requires": { - "kind-of": "^3.2.0" - }, - "dependencies": { - "kind-of": { - "version": "3.2.2", - "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-3.2.2.tgz", - "integrity": "sha1-MeohpzS6ubuw8yRm2JOupR5KPGQ=", - "dev": true, - "requires": { - "is-buffer": "^1.1.5" - } - } - } - }, - "source-map": { - "version": "0.7.3", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.7.3.tgz", - "integrity": "sha512-CkCj6giN3S+n9qrYiBTX5gystlENnRW5jZeNLHpe6aue+SrHcG5VYwujhW9s4dY31mEGsxBDrHR6oI69fTXsaQ==", - "dev": true - }, - "source-map-resolve": { - "version": "0.5.3", - "resolved": "https://registry.npmjs.org/source-map-resolve/-/source-map-resolve-0.5.3.tgz", - "integrity": "sha512-Htz+RnsXWk5+P2slx5Jh3Q66vhQj1Cllm0zvnaY98+NFx+Dv2CF/f5O/t8x+KaNdrdIAsruNzoh/KpialbqAnw==", - "dev": true, - "requires": { - "atob": "^2.1.2", - "decode-uri-component": "^0.2.0", - "resolve-url": "^0.2.1", - "source-map-url": "^0.4.0", - "urix": "^0.1.0" - } - }, - "source-map-support": { - "version": "0.5.13", - "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.13.tgz", - "integrity": "sha512-SHSKFHadjVA5oR4PPqhtAVdcBWwRYVd6g6cAXnIbRiIwc2EhPrTuKUBdSLvlEKyIP3GCf89fltvcZiP9MMFA1w==", - "dev": true, - "requires": { - "buffer-from": "^1.0.0", - "source-map": "^0.6.0" - }, - "dependencies": { - "source-map": { - "version": "0.6.1", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", - "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "ms": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.1.tgz", + "integrity": "sha512-tgp+dl5cGk28utYktBsrFqA7HKgrhgPsg6Z/EfhWI4gl1Hwq8B/GmY/0oXZ6nF8hDVesS/FpnYaD/kOWhYQvyg==", "dev": true - } - } - }, - "source-map-url": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/source-map-url/-/source-map-url-0.4.0.tgz", - "integrity": "sha1-PpNdfd1zYxuXZZlW1VEo6HtQhKM=", - "dev": true - }, - "spawn-wrap": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/spawn-wrap/-/spawn-wrap-2.0.0.tgz", - "integrity": "sha512-EeajNjfN9zMnULLwhZZQU3GWBoFNkbngTUPfaawT4RkMiviTxcX0qfhVbGey39mfctfDHkWtuecgQ8NJcyQWHg==", - "dev": true, - "requires": { - "foreground-child": "^2.0.0", - "is-windows": "^1.0.2", - "make-dir": "^3.0.0", - "rimraf": "^3.0.0", - "signal-exit": "^3.0.2", - "which": "^2.0.1" - }, - "dependencies": { - "which": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", - "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", + }, + "os-locale": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/os-locale/-/os-locale-3.1.0.tgz", + "integrity": "sha512-Z8l3R4wYWM40/52Z+S265okfFj8Kt2cC2MKY+xNi3kFs+XGI7WXu/I309QQQYbRW4ijiZ+yxs9pqEhJh0DqW3Q==", "dev": true, "requires": { - "isexe": "^2.0.0" - } - } - } - }, - "split-string": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/split-string/-/split-string-3.1.0.tgz", - "integrity": "sha512-NzNVhJDYpwceVVii8/Hu6DKfD2G+NrQHlS/V/qgv763EYudVwEcMQNxd2lh+0VrUByXN/oJkl5grOhYWvQUYiw==", - "dev": true, - "requires": { - "extend-shallow": "^3.0.0" - } - }, - "sprintf-js": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", - "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=", - "dev": true - }, - "sshpk": { - "version": "1.16.1", - "resolved": "https://registry.npmjs.org/sshpk/-/sshpk-1.16.1.tgz", - "integrity": "sha512-HXXqVUq7+pcKeLqqZj6mHFUMvXtOJt1uoUx09pFW6011inTMxqI8BA8PM95myrIyyKwdnzjdFjLiE6KBPVtJIg==", - "dev": true, - "requires": { - "asn1": "~0.2.3", - "assert-plus": "^1.0.0", - "bcrypt-pbkdf": "^1.0.0", - "dashdash": "^1.12.0", - "ecc-jsbn": "~0.1.1", - "getpass": "^0.1.1", - "jsbn": "~0.1.0", - "safer-buffer": "^2.0.2", - "tweetnacl": "~0.14.0" - } - }, - "stack-trace": { - "version": "0.0.10", - "resolved": "https://registry.npmjs.org/stack-trace/-/stack-trace-0.0.10.tgz", - "integrity": "sha1-VHxws0fo0ytOEI6hoqFZ5f3eGcA=", - "dev": true - }, - "static-eval": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/static-eval/-/static-eval-2.0.2.tgz", - "integrity": "sha512-N/D219Hcr2bPjLxPiV+TQE++Tsmrady7TqAJugLy7Xk1EumfDWS/f5dtBbkRCGE7wKKXuYockQoj8Rm2/pVKyg==", - "dev": true, - "requires": { - "escodegen": "^1.8.1" - } - }, - "static-extend": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/static-extend/-/static-extend-0.1.2.tgz", - "integrity": "sha1-YICcOcv/VTNyJv1eC1IPNB8ftcY=", - "dev": true, - "requires": { - "define-property": "^0.2.5", - "object-copy": "^0.1.0" - }, - "dependencies": { - "define-property": { - "version": "0.2.5", - "resolved": "https://registry.npmjs.org/define-property/-/define-property-0.2.5.tgz", - "integrity": "sha1-w1se+RjsPJkPmlvFe+BKrOxcgRY=", + "execa": "^1.0.0", + "lcid": "^2.0.0", + "mem": "^4.0.0" + } + }, + "strip-ansi": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-4.0.0.tgz", + "integrity": "sha1-qEeQIusaw2iocTibY1JixQXuNo8=", "dev": true, "requires": { - "is-descriptor": "^0.1.0" + "ansi-regex": "^3.0.0" } - } - } - }, - "stealthy-require": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/stealthy-require/-/stealthy-require-1.1.1.tgz", - "integrity": "sha1-NbCYdbT/SfJqd35QmzCQoyJr8ks=", - "dev": true - }, - "string-width": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz", - "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==", - "dev": true, - "requires": { - "emoji-regex": "^7.0.1", - "is-fullwidth-code-point": "^2.0.0", - "strip-ansi": "^5.1.0" - } - }, - "string.prototype.repeat": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/string.prototype.repeat/-/string.prototype.repeat-0.2.0.tgz", - "integrity": "sha1-q6Nt4I3O5qWjN9SbLqHaGyj8Ds8=", - "dev": true - }, - "string_decoder": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", - "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", - "dev": true, - "requires": { - "safe-buffer": "~5.1.0" - } - }, - "strip-ansi": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz", - "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==", - "dev": true, - "requires": { - "ansi-regex": "^4.1.0" - } - }, - "strip-bom": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/strip-bom/-/strip-bom-4.0.0.tgz", - "integrity": "sha512-3xurFv5tEgii33Zi8Jtp55wEIILR9eh34FAW00PZf+JnSsTmV/ioewSgQl97JHvgjoRGwPShsWm+IdrxB35d0w==", - "dev": true - }, - "strip-eof": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/strip-eof/-/strip-eof-1.0.0.tgz", - "integrity": "sha1-u0P/VZim6wXYm1n80SnJgzE2Br8=", - "dev": true - }, - "strip-json-comments": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz", - "integrity": "sha1-PFMZQukIwml8DsNEhYwobHygpgo=", - "dev": true - }, - "superagent": { - "version": "3.8.3", - "resolved": "https://registry.npmjs.org/superagent/-/superagent-3.8.3.tgz", - "integrity": "sha512-GLQtLMCoEIK4eDv6OGtkOoSMt3D+oq0y3dsxMuYuDvaNUvuT8eFBuLmfR0iYYzHC1e8hpzC6ZsxbuP6DIalMFA==", - "dev": true, - "requires": { - "component-emitter": "^1.2.0", - "cookiejar": "^2.1.0", - "debug": "^3.1.0", - "extend": "^3.0.0", - "form-data": "^2.3.1", - "formidable": "^1.2.0", - "methods": "^1.1.1", - "mime": "^1.4.1", - "qs": "^6.5.1", - "readable-stream": "^2.3.5" - }, - "dependencies": { - "form-data": { - "version": "2.5.1", - "resolved": "https://registry.npmjs.org/form-data/-/form-data-2.5.1.tgz", - "integrity": "sha512-m21N3WOmEEURgk6B9GLOE4RuWOFf28Lhh9qGYeNlGq4VDXUlJy2th2slBNU8Gp8EzloYZOibZJ7t5ecIrFSjVA==", + }, + "supports-color": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-6.0.0.tgz", + "integrity": "sha512-on9Kwidc1IUQo+bQdhi8+Tijpo0e1SS6RoGo2guUwn5vdaxw8RXOF9Vb2ws+ihWOmh4JnCJOvaziZWP1VABaLg==", "dev": true, "requires": { - "asynckit": "^0.4.0", - "combined-stream": "^1.0.6", - "mime-types": "^2.1.12" + "has-flag": "^3.0.0" } - } - } - }, - "supports-color": { - "version": "3.2.3", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-3.2.3.tgz", - "integrity": "sha1-ZawFBLOVQXHYpklGsq48u4pfVPY=", - "dev": true, - "requires": { - "has-flag": "^1.0.0" - } - }, - "swagger-methods": { - "version": "1.0.8", - "resolved": "https://registry.npmjs.org/swagger-methods/-/swagger-methods-1.0.8.tgz", - "integrity": "sha512-G6baCwuHA+C5jf4FNOrosE4XlmGsdjbOjdBK4yuiDDj/ro9uR4Srj3OR84oQMT8F3qKp00tYNv0YN730oTHPZA==", - "dev": true - }, - "swagger-parser": { - "version": "6.0.5", - "resolved": "https://registry.npmjs.org/swagger-parser/-/swagger-parser-6.0.5.tgz", - "integrity": "sha512-UL47eu4+GRm5y+N7J+W6QQiqAJn2lojyqgMwS0EZgA55dXd5xmpQCsjUmH/Rf0eKDiG1kULc9VS515PxAyTDVw==", - "dev": true, - "requires": { - "call-me-maybe": "^1.0.1", - "json-schema-ref-parser": "^6.0.3", - "ono": "^4.0.11", - "openapi-schema-validation": "^0.4.2", - "swagger-methods": "^1.0.8", - "swagger-schema-official": "2.0.0-bab6bed", - "z-schema": "^3.24.2" - }, - "dependencies": { - "commander": { - "version": "2.20.3", - "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", - "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", + }, + "wrap-ansi": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-2.1.0.tgz", + "integrity": "sha1-2Pw9KE3QV5T+hJc8rs3Rz4JP3YU=", + "dev": true, + "requires": { + "string-width": "^1.0.1", + "strip-ansi": "^3.0.1" + }, + "dependencies": { + "ansi-regex": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-2.1.1.tgz", + "integrity": "sha1-w7M6te42DYbg5ijwRorn7yfWVN8=", + "dev": true + }, + "is-fullwidth-code-point": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-1.0.0.tgz", + "integrity": "sha1-754xOG8DGn8NZDr4L95QxFfvAMs=", + "dev": true, + "requires": { + "number-is-nan": "^1.0.0" + } + }, + "string-width": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-1.0.2.tgz", + "integrity": "sha1-EYvfW4zcUaKn5w0hHgfisLmxB9M=", + "dev": true, + "requires": { + "code-point-at": "^1.0.0", + "is-fullwidth-code-point": "^1.0.0", + "strip-ansi": "^3.0.0" + } + }, + "strip-ansi": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-3.0.1.tgz", + "integrity": "sha1-ajhfuIU9lS1f8F0Oiq+UJ43GPc8=", + "dev": true, + "requires": { + "ansi-regex": "^2.0.0" + } + } + } + }, + "yargs": { + "version": "13.2.2", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-13.2.2.tgz", + "integrity": "sha512-WyEoxgyTD3w5XRpAQNYUB9ycVH/PQrToaTXdYXRdOXvEy1l19br+VJsc0vcO8PTGg5ro/l/GY7F/JMEBmI0BxA==", "dev": true, - "optional": true + "requires": { + "cliui": "^4.0.0", + "find-up": "^3.0.0", + "get-caller-file": "^2.0.1", + "os-locale": "^3.1.0", + "require-directory": "^2.1.1", + "require-main-filename": "^2.0.0", + "set-blocking": "^2.0.0", + "string-width": "^3.0.0", + "which-module": "^2.0.0", + "y18n": "^4.0.0", + "yargs-parser": "^13.0.0" + } }, - "z-schema": { - "version": "3.25.1", - "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-3.25.1.tgz", - "integrity": "sha512-7tDlwhrBG+oYFdXNOjILSurpfQyuVgkRe3hB2q8TEssamDHB7BbLWYkYO98nTn0FibfdFroFKDjndbgufAgS/Q==", + "yargs-parser": { + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-13.0.0.tgz", + "integrity": "sha512-w2LXjoL8oRdRQN+hOyppuXs+V/fVAYtpcrRxZuF7Kt/Oc+Jr2uAcVntaUTNT6w5ihoWfFDpNY8CPx1QskxZ/pw==", "dev": true, "requires": { - "commander": "^2.7.1", - "core-js": "^2.5.7", - "lodash.get": "^4.0.0", - "lodash.isequal": "^4.0.0", - "validator": "^10.0.0" + "camelcase": "^5.0.0", + "decamelize": "^1.2.0" } } } }, - "swagger-schema-official": { - "version": "2.0.0-bab6bed", - "resolved": "https://registry.npmjs.org/swagger-schema-official/-/swagger-schema-official-2.0.0-bab6bed.tgz", - "integrity": "sha1-cAcEaNbSl3ylI3suUZyn0Gouo/0=", + "ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", "dev": true }, - "symbol-tree": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/symbol-tree/-/symbol-tree-3.2.4.tgz", - "integrity": "sha512-9QNk5KwDF+Bvz+PyObkmSYjI5ksVUYtjW7AU22r2NKcfLJcXp96hkDWU3+XndOsUb+AQ9QhfzfCT2O+CNWT5Tw==", + "nice-try": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/nice-try/-/nice-try-1.0.5.tgz", + "integrity": "sha512-1nh45deeb5olNY7eX82BkPO7SSxR5SSYJiPTrTdFUVYwAl8CKMA5N9PjTYkHiRjisVcxcQ1HXdLhx2qxxJzLNQ==", "dev": true }, - "test-exclude": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-6.0.0.tgz", - "integrity": "sha512-cAGWPIyOHU6zlmg88jwm7VRyXnMN7iV68OGAbYDk/Mh/xC/pzVPlQtY6ngoIH/5/tciuhGfvESU8GrHrcxD56w==", + "node-environment-flags": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/node-environment-flags/-/node-environment-flags-1.0.5.tgz", + "integrity": "sha512-VNYPRfGfmZLx0Ye20jWzHUjyTW/c+6Wq+iLhDzUI4XmhrDd9l/FozXV3F2xOaXjvp0co0+v1YSR3CMP6g+VvLQ==", "dev": true, "requires": { - "@istanbuljs/schema": "^0.1.2", - "glob": "^7.1.4", - "minimatch": "^3.0.4" + "object.getownpropertydescriptors": "^2.0.3", + "semver": "^5.7.0" } }, - "text-hex": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/text-hex/-/text-hex-1.0.0.tgz", - "integrity": "sha512-uuVGNWzgJ4yhRaNSiubPY7OjISw4sw4E5Uv0wbjp+OzcbmVU/rsT8ujgcXJhn9ypzsgr5vlzpPqP+MBBKcGvbg==", - "dev": true - }, - "through": { - "version": "2.3.8", - "resolved": "https://registry.npmjs.org/through/-/through-2.3.8.tgz", - "integrity": "sha1-DdTJ/6q8NXlgsbckEV1+Doai4fU=", + "node-fetch": { + "version": "2.6.1", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.1.tgz", + "integrity": "sha512-V4aYg89jEoVRxRb2fJdAg8FHvI7cEyYdVAh94HH0UIK8oJxUfkjlDQN9RbMx+bEjP7+ggMiFRprSti032Oipxw==", "dev": true }, - "to-fast-properties": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/to-fast-properties/-/to-fast-properties-2.0.0.tgz", - "integrity": "sha1-3F5pjL0HkmW8c+A3doGk5Og/YW4=", + "node-object-hash": { + "version": "1.4.2", + "resolved": "https://registry.npmjs.org/node-object-hash/-/node-object-hash-1.4.2.tgz", + "integrity": "sha512-UdS4swXs85fCGWWf6t6DMGgpN/vnlKeSGEQ7hJcrs7PBFoxoKLmibc3QRb7fwiYsjdL7PX8iI/TMSlZ90dgHhQ==", "dev": true }, - "to-object-path": { - "version": "0.3.0", - "resolved": "https://registry.npmjs.org/to-object-path/-/to-object-path-0.3.0.tgz", - "integrity": "sha1-KXWIt7Dn4KwI4E5nL4XB9JmeF68=", - "dev": true, - "requires": { - "kind-of": "^3.0.2" - }, - "dependencies": { - "kind-of": { - "version": "3.2.2", - "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-3.2.2.tgz", - "integrity": "sha1-MeohpzS6ubuw8yRm2JOupR5KPGQ=", - "dev": true, - "requires": { - "is-buffer": "^1.1.5" - } - } - } - }, - "to-regex": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/to-regex/-/to-regex-3.0.2.tgz", - "integrity": "sha512-FWtleNAtZ/Ki2qtqej2CXTOayOH9bHDQF+Q48VpWyDXjbYxA4Yz8iDB31zXOBUlOHHKidDbqGVrTUvQMPmBGBw==", + "npm-run-path": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-2.0.2.tgz", + "integrity": "sha1-NakjLfo11wZ7TLLd8jV7GHFTbF8=", "dev": true, "requires": { - "define-property": "^2.0.2", - "extend-shallow": "^3.0.2", - "regex-not": "^1.0.2", - "safe-regex": "^1.1.0" + "path-key": "^2.0.0" } }, - "to-regex-range": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-2.1.1.tgz", - "integrity": "sha1-fIDBe53+vlmeJzZ+DU3VWQFB2zg=", - "dev": true, - "requires": { - "is-number": "^3.0.0", - "repeat-string": "^1.6.1" - } + "number-is-nan": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/number-is-nan/-/number-is-nan-1.0.1.tgz", + "integrity": "sha1-CXtgK1NCKlIsGvuHkDGDNpQaAR0=", + "dev": true }, - "tough-cookie": { - "version": "2.5.0", - "resolved": "https://registry.npmjs.org/tough-cookie/-/tough-cookie-2.5.0.tgz", - "integrity": "sha512-nlLsUzgm1kfLXSXfRZMc1KLAugd4hqJHDTvc2hDIwS3mZAfMEuMbc03SujMF+GEcpaX/qboeycw6iO8JwVv2+g==", - "dev": true, - "requires": { - "psl": "^1.1.28", - "punycode": "^2.1.1" - } + "object-keys": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", + "integrity": "sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==", + "dev": true }, - "tr46": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/tr46/-/tr46-1.0.1.tgz", - "integrity": "sha1-qLE/1r/SSJUZZ0zN5VujaTtwbQk=", + "object.assign": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.0.tgz", + "integrity": "sha512-exHJeq6kBKj58mqGyTQ9DFvrZC/eR6OwxzoM9YRoGBqrXYonaFyGiFMuc9VZrXf7DarreEwMpurG3dd+CNyW5w==", "dev": true, "requires": { - "punycode": "^2.1.0" + "define-properties": "^1.1.2", + "function-bind": "^1.1.1", + "has-symbols": "^1.0.0", + "object-keys": "^1.0.11" } }, - "triple-beam": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/triple-beam/-/triple-beam-1.3.0.tgz", - "integrity": "sha512-XrHUvV5HpdLmIj4uVMxHggLbFSZYIn7HEWsqePZcI50pco+MPqJ50wMGY794X7AOOhxOBAjbkqfAbEe/QMp2Lw==", - "dev": true - }, - "ts-node": { - "version": "8.3.0", - "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-8.3.0.tgz", - "integrity": "sha512-dyNS/RqyVTDcmNM4NIBAeDMpsAdaQ+ojdf0GOLqE6nwJOgzEkdRNzJywhDfwnuvB10oa6NLVG1rUJQCpRN7qoQ==", + "object.getownpropertydescriptors": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/object.getownpropertydescriptors/-/object.getownpropertydescriptors-2.0.3.tgz", + "integrity": "sha1-h1jIRvW0B62rDyNuCYbxSwUcqhY=", "dev": true, "requires": { - "arg": "^4.1.0", - "diff": "^4.0.1", - "make-error": "^1.1.1", - "source-map-support": "^0.5.6", - "yn": "^3.0.0" - }, - "dependencies": { - "diff": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/diff/-/diff-4.0.1.tgz", - "integrity": "sha512-s2+XdvhPCOF01LRQBC8hf4vhbVmI2CGS5aZnxLJlT5FtdhPCDFq80q++zK2KlrVorVDdL5BOGZ/VfLrVtYNF+Q==", - "dev": true - } + "define-properties": "^1.1.2", + "es-abstract": "^1.5.1" } }, - "tslib": { - "version": "1.10.0", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.10.0.tgz", - "integrity": "sha512-qOebF53frne81cf0S9B41ByenJ3/IuH8yJKngAX35CmiZySA0khhkovshKK+jGCaMnVomla7gVlIcc3EvKPbTQ==", - "dev": true - }, - "tunnel": { - "version": "0.0.5", - "resolved": "https://registry.npmjs.org/tunnel/-/tunnel-0.0.5.tgz", - "integrity": "sha512-gj5sdqherx4VZKMcBA4vewER7zdK25Td+z1npBqpbDys4eJrLx+SlYjJvq1bDXs2irkuJM5pf8ktaEQVipkrbA==", - "dev": true - }, - "tunnel-agent": { - "version": "0.6.0", - "resolved": "https://registry.npmjs.org/tunnel-agent/-/tunnel-agent-0.6.0.tgz", - "integrity": "sha1-J6XeoGs2sEoKmWZ3SykIaPD8QP0=", + "once": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", + "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=", "dev": true, "requires": { - "safe-buffer": "^5.0.1" + "wrappy": "1" } }, - "tweetnacl": { - "version": "0.14.5", - "resolved": "https://registry.npmjs.org/tweetnacl/-/tweetnacl-0.14.5.tgz", - "integrity": "sha1-WuaBd/GS1EViadEIr6k/+HQ/T2Q=", - "dev": true - }, - "type-check": { - "version": "0.3.2", - "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.3.2.tgz", - "integrity": "sha1-WITKtRLPHTVeP7eE8wgEsrUg23I=", + "ono": { + "version": "4.0.11", + "resolved": "https://registry.npmjs.org/ono/-/ono-4.0.11.tgz", + "integrity": "sha512-jQ31cORBFE6td25deYeD80wxKBMj+zBmHTrVxnc6CKhx8gho6ipmWM5zj/oeoqioZ99yqBls9Z/9Nss7J26G2g==", "dev": true, "requires": { - "prelude-ls": "~1.1.2" + "format-util": "^1.0.3" } }, - "type-fest": { - "version": "0.8.1", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.8.1.tgz", - "integrity": "sha512-4dbzIzqvjtgiM5rw1k5rEHtBANKmdudhGyBEajN01fEyhaAIhsoKNy6y7+IN93IfpFtwY9iqi7kD+xwKhQsNJA==", + "p-defer": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/p-defer/-/p-defer-1.0.0.tgz", + "integrity": "sha1-n26xgvbJqozXQwBKfU+WsZaw+ww=", "dev": true }, - "typedarray-to-buffer": { - "version": "3.1.5", - "resolved": "https://registry.npmjs.org/typedarray-to-buffer/-/typedarray-to-buffer-3.1.5.tgz", - "integrity": "sha512-zdu8XMNEDepKKR+XYOXAVPtWui0ly0NtohUscw+UmaHiAWT8hrV1rr//H6V+0DvJ3OQ19S979M0laLfX8rm82Q==", - "dev": true, - "requires": { - "is-typedarray": "^1.0.0" - } - }, - "typescript": { - "version": "3.5.3", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.5.3.tgz", - "integrity": "sha1-yDD2V/k/HqhGgZ6SkJL1/lmD6Xc=", + "p-finally": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/p-finally/-/p-finally-1.0.0.tgz", + "integrity": "sha1-P7z7FbiZpEEjs0ttzBi3JDNqLK4=", "dev": true }, - "uglify-js": { - "version": "3.12.1", - "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.12.1.tgz", - "integrity": "sha512-o8lHP20KjIiQe5b/67Rh68xEGRrc2SRsCuuoYclXXoC74AfSRGblU1HKzJWH3HxPZ+Ort85fWHpSX7KwBUC9CQ==", - "optional": true - }, - "underscore": { - "version": "1.12.1", - "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.12.1.tgz", - "integrity": "sha512-hEQt0+ZLDVUMhebKxL4x1BTtDY7bavVofhZ9KZ4aI26X9SRaE+Y3m83XUL1UP2jn8ynjndwCCpEHdUG+9pP1Tw==", + "p-is-promise": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/p-is-promise/-/p-is-promise-2.1.0.tgz", + "integrity": "sha512-Y3W0wlRPK8ZMRbNq97l4M5otioeA5lm1z7bkNkxCka8HSPjR0xRWmpCmc9utiaLP9Jb1eD8BgeIxTW4AIF45Pg==", "dev": true }, - "union-value": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/union-value/-/union-value-1.0.1.tgz", - "integrity": "sha512-tJfXmxMeWYnczCVs7XAEvIV7ieppALdyepWMkHkwciRpZraG/xwT+s2JN8+pr1+8jCRf80FFzvr+MpQeeoF4Xg==", + "p-limit": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.2.1.tgz", + "integrity": "sha512-85Tk+90UCVWvbDavCLKPOLC9vvY8OwEX/RtKF+/1OADJMVlFfEHOiMTPVyxg7mk/dKa+ipdHm0OUkTvCpMTuwg==", "dev": true, "requires": { - "arr-union": "^3.1.0", - "get-value": "^2.0.6", - "is-extendable": "^0.1.1", - "set-value": "^2.0.1" + "p-try": "^2.0.0" } }, - "unique-string": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/unique-string/-/unique-string-2.0.0.tgz", - "integrity": "sha512-uNaeirEPvpZWSgzwsPGtU2zVSTrn/8L5q/IexZmH0eH6SA73CmAA5U4GwORTxQAZs95TAXLNqeLoPPNO5gZfWg==", + "p-locate": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-3.0.0.tgz", + "integrity": "sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ==", "dev": true, "requires": { - "crypto-random-string": "^2.0.0" + "p-limit": "^2.0.0" } }, - "universal-user-agent": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/universal-user-agent/-/universal-user-agent-4.0.1.tgz", - "integrity": "sha512-LnST3ebHwVL2aNe4mejI9IQh2HfZ1RLo8Io2HugSif8ekzD1TlWpHpColOB/eh8JHMLkGH3Akqf040I+4ylNxg==", - "dev": true, - "requires": { - "os-name": "^3.1.0" - } + "p-try": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", + "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", + "dev": true }, - "universalify": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz", - "integrity": "sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==", + "path-exists": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-3.0.0.tgz", + "integrity": "sha1-zg6+ql94yxiSXqfYENe1mwEP1RU=", "dev": true }, - "unset-value": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/unset-value/-/unset-value-1.0.0.tgz", - "integrity": "sha1-g3aHP30jNRef+x5vw6jtDfyKtVk=", - "dev": true, - "requires": { - "has-value": "^0.3.1", - "isobject": "^3.0.0" - }, - "dependencies": { - "has-value": { - "version": "0.3.1", - "resolved": "https://registry.npmjs.org/has-value/-/has-value-0.3.1.tgz", - "integrity": "sha1-ex9YutpiyoJ+wKIHgCVlSEWZXh8=", - "dev": true, - "requires": { - "get-value": "^2.0.3", - "has-values": "^0.1.4", - "isobject": "^2.0.0" - }, - "dependencies": { - "isobject": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/isobject/-/isobject-2.1.0.tgz", - "integrity": "sha1-8GVWEJaj8dou9GJy+BXIQNh+DIk=", - "dev": true, - "requires": { - "isarray": "1.0.0" - } - } - } - }, - "has-values": { - "version": "0.1.4", - "resolved": "https://registry.npmjs.org/has-values/-/has-values-0.1.4.tgz", - "integrity": "sha1-bWHeldkd/Km5oCCJrThL/49it3E=", - "dev": true - } - } + "path-is-absolute": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", + "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=", + "dev": true + }, + "path-key": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/path-key/-/path-key-2.0.1.tgz", + "integrity": "sha1-QRyttXTFoUDTpLGRDUDYDMn0C0A=", + "dev": true + }, + "prettier": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.1.2.tgz", + "integrity": "sha512-16c7K+x4qVlJg9rEbXl7HEGmQyZlG4R9AgP+oHKRMsMsuk8s+ATStlf1NpDqyBI1HpVyfjLOeMhH2LvuNvV5Vg==", + "dev": true }, - "uri-js": { - "version": "4.4.0", - "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.0.tgz", - "integrity": "sha512-B0yRTzYdUCCn9n+F4+Gh4yIDtMQcaJsmYBDsTSG8g/OejKBodLQ2IHfN3bM7jUsRXndopT7OIXWdYqc1fjmV6g==", + "pump": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/pump/-/pump-3.0.0.tgz", + "integrity": "sha512-LwZy+p3SFs1Pytd/jYct4wpv49HiYCqd9Rlc5ZVdk0V+8Yzv6jR5Blk3TRmPL1ft69TxP0IMZGJ+WPFU2BFhww==", "dev": true, "requires": { - "punycode": "^2.1.0" + "end-of-stream": "^1.1.0", + "once": "^1.3.1" } }, - "urix": { - "version": "0.1.0", - "resolved": "https://registry.npmjs.org/urix/-/urix-0.1.0.tgz", - "integrity": "sha1-2pN/emLiH+wf0Y1Js1wpNQZ6bHI=", + "require-directory": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", + "integrity": "sha1-jGStX9MNqxyXbiNE/+f3kqam30I=", "dev": true }, - "use": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/use/-/use-3.1.1.tgz", - "integrity": "sha512-cwESVXlO3url9YWlFW/TA9cshCEhtu7IKJ/p5soJ/gGpj7vbvFrAY/eIioQ6Dw23KjZhYgiIo8HOs1nQ2vr/oQ==", + "require-main-filename": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/require-main-filename/-/require-main-filename-2.0.0.tgz", + "integrity": "sha512-NKN5kMDylKuldxYLSUfrbo5Tuzh4hd+2E8NPPX02mZtn1VuREQToYe/ZdlJy+J3uCpfaiGF05e7B8W0iXbQHmg==", "dev": true }, - "util-deprecate": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", - "integrity": "sha1-RQ1Nyfpw3nMnYvvS1KKJgUGaDM8=", + "retry": { + "version": "0.12.0", + "resolved": "https://registry.npmjs.org/retry/-/retry-0.12.0.tgz", + "integrity": "sha1-G0KmJmoh8HQh0bC1S33BZ7AcATs=", "dev": true }, - "uuid": { - "version": "3.4.0", - "resolved": "https://registry.npmjs.org/uuid/-/uuid-3.4.0.tgz", - "integrity": "sha512-HjSDRw6gZE5JMggctHBcjVak08+KEVhSIiDzFnT9S9aegmp85S/bReBVTb4QTFaRNptJ9kuYaNhnbNEOkbKb/A==", + "semver": { + "version": "5.7.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.1.tgz", + "integrity": "sha512-sauaDf/PZdVgrLTNYHRtpXa1iRiKcaebiKQ1BJdpQlWH2lCvexQdX55snPFyK7QzpudqbCI0qXFfOasHdyNDGQ==", "dev": true }, - "validator": { - "version": "10.11.0", - "resolved": "https://registry.npmjs.org/validator/-/validator-10.11.0.tgz", - "integrity": "sha512-X/p3UZerAIsbBfN/IwahhYaBbY68EN/UQBWHtsbXGT5bfrH/p4NQzUCG1kF/rtKaNpnJ7jAu6NGTdSNtyNIXMw==", + "set-blocking": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/set-blocking/-/set-blocking-2.0.0.tgz", + "integrity": "sha1-BF+XgtARrppoA93TgrJDkrPYkPc=", "dev": true }, - "verror": { - "version": "1.10.0", - "resolved": "https://registry.npmjs.org/verror/-/verror-1.10.0.tgz", - "integrity": "sha1-OhBcoXBTr1XW4nDB+CiGguGNpAA=", + "shebang-command": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-1.2.0.tgz", + "integrity": "sha1-RKrGW2lbAzmJaMOfNj/uXer98eo=", "dev": true, "requires": { - "assert-plus": "^1.0.0", - "core-util-is": "1.0.2", - "extsprintf": "^1.2.0" + "shebang-regex": "^1.0.0" } }, - "viz.js": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/viz.js/-/viz.js-2.1.2.tgz", - "integrity": "sha512-UO6CPAuEMJ8oNR0gLLNl+wUiIzQUsyUOp8SyyDKTqVRBtq7kk1VnFmIZW8QufjxGrGEuI+LVR7p/C7uEKy0LQw==", + "shebang-regex": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-1.0.0.tgz", + "integrity": "sha1-2kL0l0DAtC2yypcoVxyxkMmO/qM=", + "dev": true + }, + "signal-exit": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.2.tgz", + "integrity": "sha1-tf3AjxKH6hF4Yo5BXiUTK3NkbG0=", "dev": true }, - "vscode-jsonrpc": { - "version": "3.6.2", - "resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-3.6.2.tgz", - "integrity": "sha512-T24Jb5V48e4VgYliUXMnZ379ItbrXgOimweKaJshD84z+8q7ZOZjJan0MeDe+Ugb+uqERDVV8SBmemaGMSMugA==", + "source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", "dev": true }, - "vscode-uri": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/vscode-uri/-/vscode-uri-2.0.3.tgz", - "integrity": "sha512-4D3DI3F4uRy09WNtDGD93H9q034OHImxiIcSq664Hq1Y1AScehlP3qqZyTkX/RWxeu0MRMHGkrxYqm2qlDF/aw==", + "source-map-support": { + "version": "0.5.19", + "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.19.tgz", + "integrity": "sha512-Wonm7zOCIJzBGQdB+thsPar0kYuCIzYvxZwlBa87yi/Mdjv7Tip2cyVbLj5o0cFPN4EVkuTwb3GDDyUx2DGnGw==", + "dev": true, + "requires": { + "buffer-from": "^1.0.0", + "source-map": "^0.6.0" + } + }, + "sprintf-js": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", + "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=", "dev": true }, - "w3c-hr-time": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/w3c-hr-time/-/w3c-hr-time-1.0.2.tgz", - "integrity": "sha512-z8P5DvDNjKDoFIHK7q8r8lackT6l+jo/Ye3HOle7l9nICP9lf1Ci25fy9vHd0JOWewkIFzXIEig3TdKT7JQ5fQ==", + "string-width": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz", + "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==", "dev": true, "requires": { - "browser-process-hrtime": "^1.0.0" + "emoji-regex": "^7.0.1", + "is-fullwidth-code-point": "^2.0.0", + "strip-ansi": "^5.1.0" } }, - "webidl-conversions": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-4.0.2.tgz", - "integrity": "sha512-YQ+BmxuTgd6UXZW3+ICGfyqRyHXVlD5GtQr5+qjiNW7bF0cqrzX500HVXPBOvgXb5YnzDd+h0zqyv61KUD7+Sg==", + "string.prototype.repeat": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/string.prototype.repeat/-/string.prototype.repeat-0.2.0.tgz", + "integrity": "sha1-q6Nt4I3O5qWjN9SbLqHaGyj8Ds8=", "dev": true }, - "whatwg-encoding": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/whatwg-encoding/-/whatwg-encoding-1.0.5.tgz", - "integrity": "sha512-b5lim54JOPN9HtzvK9HFXvBma/rnfFeqsic0hSpjtDbVxR3dJKLc+KB4V6GgiGOvl7CY/KNh8rxSo9DKQrnUEw==", + "strip-ansi": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz", + "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==", "dev": true, "requires": { - "iconv-lite": "0.4.24" + "ansi-regex": "^4.1.0" } }, - "whatwg-mimetype": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/whatwg-mimetype/-/whatwg-mimetype-2.3.0.tgz", - "integrity": "sha512-M4yMwr6mAnQz76TbJm914+gPpB/nCwvZbJU28cUD6dR004SAxDLOOSUaB1JDRqLtaOV/vi0IC5lEAGFgrjGv/g==", + "strip-eof": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/strip-eof/-/strip-eof-1.0.0.tgz", + "integrity": "sha1-u0P/VZim6wXYm1n80SnJgzE2Br8=", + "dev": true + }, + "strip-json-comments": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz", + "integrity": "sha1-PFMZQukIwml8DsNEhYwobHygpgo=", "dev": true }, - "whatwg-url": { - "version": "6.5.0", - "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-6.5.0.tgz", - "integrity": "sha512-rhRZRqx/TLJQWUpQ6bmrt2UV4f0HCQ463yQuONJqC6fO2VoEb1pTYddbe59SkYq87aoM5A3bdhMZiUiVws+fzQ==", + "ts-node": { + "version": "10.1.0", + "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.1.0.tgz", + "integrity": "sha512-6szn3+J9WyG2hE+5W8e0ruZrzyk1uFLYye6IGMBadnOzDh8aP7t8CbFpsfCiEx2+wMixAhjFt7lOZC4+l+WbEA==", "dev": true, "requires": { - "lodash.sortby": "^4.7.0", - "tr46": "^1.0.1", - "webidl-conversions": "^4.0.2" + "@tsconfig/node10": "^1.0.7", + "@tsconfig/node12": "^1.0.7", + "@tsconfig/node14": "^1.0.0", + "@tsconfig/node16": "^1.0.1", + "arg": "^4.1.0", + "create-require": "^1.1.0", + "diff": "^4.0.1", + "make-error": "^1.1.1", + "source-map-support": "^0.5.17", + "yn": "3.1.1" + }, + "dependencies": { + "diff": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/diff/-/diff-4.0.2.tgz", + "integrity": "sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==", + "dev": true + } } }, + "tslib": { + "version": "1.10.0", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.10.0.tgz", + "integrity": "sha512-qOebF53frne81cf0S9B41ByenJ3/IuH8yJKngAX35CmiZySA0khhkovshKK+jGCaMnVomla7gVlIcc3EvKPbTQ==", + "dev": true + }, + "typescript": { + "version": "3.5.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.5.3.tgz", + "integrity": "sha512-ACzBtm/PhXBDId6a6sDJfroT2pOWt/oOnk4/dElG5G33ZL776N3Y6/6bKZJBFpd+b05F3Ct9qDjMeJmRWtE2/g==", + "dev": true + }, "which": { "version": "1.3.1", "resolved": "https://registry.npmjs.org/which/-/which-1.3.1.tgz", @@ -6201,51 +1500,6 @@ } } }, - "windows-release": { - "version": "3.3.3", - "resolved": "https://registry.npmjs.org/windows-release/-/windows-release-3.3.3.tgz", - "integrity": "sha512-OSOGH1QYiW5yVor9TtmXKQvt2vjQqbYS+DqmsZw+r7xDwLXEeT3JGW0ZppFmHx4diyXmxt238KFR3N9jzevBRg==", - "dev": true, - "requires": { - "execa": "^1.0.0" - } - }, - "winston": { - "version": "2.4.5", - "resolved": "https://registry.npmjs.org/winston/-/winston-2.4.5.tgz", - "integrity": "sha512-TWoamHt5yYvsMarGlGEQE59SbJHqGsZV8/lwC+iCcGeAe0vUaOh+Lv6SYM17ouzC/a/LB1/hz/7sxFBtlu1l4A==", - "dev": true, - "requires": { - "async": "~1.0.0", - "colors": "1.0.x", - "cycle": "1.0.x", - "eyes": "0.1.x", - "isstream": "0.1.x", - "stack-trace": "0.0.x" - } - }, - "winston-transport": { - "version": "4.4.0", - "resolved": "https://registry.npmjs.org/winston-transport/-/winston-transport-4.4.0.tgz", - "integrity": "sha512-Lc7/p3GtqtqPBYYtS6KCN3c77/2QCev51DvcJKbkFPQNoj1sinkGwLGFDxkXY9J6p9+EPnYs+D90uwbnaiURTw==", - "dev": true, - "requires": { - "readable-stream": "^2.3.7", - "triple-beam": "^1.2.0" - } - }, - "word-wrap": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.3.tgz", - "integrity": "sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==", - "dev": true - }, - "wordwrap": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz", - "integrity": "sha1-J1hIEIkUVqQXHI0CJkQa3pDLyus=", - "dev": true - }, "wrap-ansi": { "version": "6.2.0", "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-6.2.0.tgz", @@ -6327,39 +1581,6 @@ "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=", "dev": true }, - "write-file-atomic": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-3.0.0.tgz", - "integrity": "sha512-EIgkf60l2oWsffja2Sf2AL384dx328c0B+cIYPTQq5q2rOYuDV00/iPFBOUiDKKwKMOhkymH8AidPaRvzfxY+Q==", - "dev": true, - "requires": { - "imurmurhash": "^0.1.4", - "is-typedarray": "^1.0.0", - "signal-exit": "^3.0.2", - "typedarray-to-buffer": "^3.1.5" - } - }, - "ws": { - "version": "5.2.2", - "resolved": "https://registry.npmjs.org/ws/-/ws-5.2.2.tgz", - "integrity": "sha512-jaHFD6PFv6UgoIVda6qZllptQsMlDEJkTQcybzzXDYM1XO9Y8em691FGMPmM46WGyLU4z9KMgQN+qrux/nhlHA==", - "dev": true, - "requires": { - "async-limiter": "~1.0.0" - } - }, - "xdg-basedir": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/xdg-basedir/-/xdg-basedir-4.0.0.tgz", - "integrity": "sha512-PSNhEJDejZYV7h50BohL09Er9VaIefr2LMAf3OEmpCkjOi34eYyQYAXUTjEQtZJTKcF0E2UKTh+osDLsgNim9Q==", - "dev": true - }, - "xml-name-validator": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/xml-name-validator/-/xml-name-validator-3.0.0.tgz", - "integrity": "sha512-A5CUptxDsvxKJEU3yO6DuWBSJz/qizqzJKOMIfUJHETbBw/sFaDxgd6fxm1ewUaM0jZ444Fc5vC5ROYurg/4Pw==", - "dev": true - }, "y18n": { "version": "4.0.1", "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.1.tgz", @@ -6633,85 +1854,11 @@ } } }, - "yasway": { - "version": "1.10.5", - "resolved": "https://registry.npmjs.org/yasway/-/yasway-1.10.5.tgz", - "integrity": "sha512-JZ2i8zFaeJkGlsoK0u6x7XC4GN4ftr/I/WJJbzMO+w35JrxHaJ926/fM+Q+vLzMXU+4eoIYeqqUiXdTfrC+d/w==", - "dev": true, - "requires": { - "@ts-common/json": "^0.3.0", - "@ts-common/string-map": "^0.3.0", - "clone-deep": "^4.0.1", - "debug": "^4.1.1", - "faker": "^4.1.0", - "istanbul": "^0.4.5", - "js-base64": "^2.5.1", - "js-yaml": "^3.13.1", - "json-refs": "^3.0.13", - "json-schema-faker": "^0.5.0-rc16", - "lodash": "^4.17.20", - "native-promise-only": "^0.8.1", - "nyc": "^15.0.1", - "path-to-regexp": "^1.7.0", - "swagger-methods": "^1.0.8", - "swagger-schema-official": "2.0.0-bab6bed", - "z-schema": "^4.2.2" - }, - "dependencies": { - "debug": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", - "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", - "dev": true, - "requires": { - "ms": "2.1.2" - } - } - } - }, "yn": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/yn/-/yn-3.1.1.tgz", "integrity": "sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q==", "dev": true - }, - "yuml2svg": { - "version": "4.2.2", - "resolved": "https://registry.npmjs.org/yuml2svg/-/yuml2svg-4.2.2.tgz", - "integrity": "sha512-u1hdk7QaxNhMXaqawFJxwGQE2nu93H0v4F+2Mzp+X0tEvc1sg1QMFE+5TcniMr7PaRVfIniYYWWVgojWzUuRDg==", - "dev": true, - "requires": { - "color": "^3.0.0", - "jsdom": "^11.6.2", - "viz.js": "^2.0.0" - } - }, - "z-schema": { - "version": "4.2.3", - "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-4.2.3.tgz", - "integrity": "sha512-zkvK/9TC6p38IwcrbnT3ul9in1UX4cm1y/VZSs4GHKIiDCrlafc+YQBgQBUdDXLAoZHf2qvQ7gJJOo6yT1LH6A==", - "dev": true, - "requires": { - "commander": "^2.7.1", - "lodash.get": "^4.4.2", - "lodash.isequal": "^4.5.0", - "validator": "^12.0.0" - }, - "dependencies": { - "commander": { - "version": "2.20.3", - "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", - "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", - "dev": true, - "optional": true - }, - "validator": { - "version": "12.2.0", - "resolved": "https://registry.npmjs.org/validator/-/validator-12.2.0.tgz", - "integrity": "sha512-jJfE/DW6tIK1Ek8nCfNFqt8Wb3nzMoAbocBF6/Icgg1ZFSBpObdnwVY2jQj6qUqzhx5jc71fpvBWyLGO7Xl+nQ==", - "dev": true - } - } } } } diff --git a/package.json b/package.json index cfd1bd9140c2..fd74c6939741 100644 --- a/package.json +++ b/package.json @@ -11,21 +11,19 @@ "license": "MIT", "devDependencies": { "@azure/avocado": "^0.7.2", - "@azure/rest-api-specs-scripts": "^0.14.0", "@ts-common/commonmark-to-markdown": "^1.2.0", "@ts-common/fs": "0.2.0", "@ts-common/iterator": "^0.3.6", "@types/js-yaml": "^3.12.1", - "@types/mocha": "^5.2.6", - "@types/prettier": "^1.18.3", - "cspell": "^4.0.30", + "@types/mocha": "^9.0.0", + "@types/prettier": "^2.3.0", "js-yaml": "^3.13.1", "json-schema-ref-parser": "^6.1.0", "mocha": "*", - "prettier": "^1.19.1", - "ts-node": "^8.1.0", + "prettier": "^2.1.2", + "ts-node": "^10.1.0", "tslib": "^1.10.0", - "typescript": "3.5.3" + "typescript": "^3.5.3" }, "homepage": "https://github.com/azure/azure-rest-api-specs", "repository": { @@ -38,7 +36,6 @@ "scripts": { "postinstall": "tsc", "test": "tsc && mocha -t 500000 --reporter min", - "spellcheck": "ts-node ./scripts/spellcheck.ts", "prettier-check": "ts-node ./scripts/prettier-check.ts", "prettier-fix": "prettier --write specification/**/*.json", "prettier": "prettier", diff --git a/scripts/install-dotnet.sh b/scripts/install-dotnet.sh deleted file mode 100755 index 551b4263a1dc..000000000000 --- a/scripts/install-dotnet.sh +++ /dev/null @@ -1,9 +0,0 @@ -#!/bin/sh - -# From https://www.microsoft.com/net/download/linux-package-manager/ubuntu14-04/sdk-2.0.0 - -wget -q https://packages.microsoft.com/config/ubuntu/16.04/packages-microsoft-prod.deb -sudo dpkg -i packages-microsoft-prod.deb -sudo apt-get install apt-transport-https -y -sudo apt-get update -sudo apt-get install dotnet-sdk-2.0.0 -y \ No newline at end of file diff --git a/scripts/latest-profile-generator.ts b/scripts/latest-profile-generator.ts deleted file mode 100644 index ce8a0d9bc0d1..000000000000 --- a/scripts/latest-profile-generator.ts +++ /dev/null @@ -1,315 +0,0 @@ -import * as fs from "@ts-common/fs" -import * as process from "process" -import * as Path from "path" -import * as cm from "@ts-common/commonmark-to-markdown" -import * as it from "@ts-common/iterator" -import * as yaml from "js-yaml" -import { values, keys } from '@ts-common/string-map'; - -type Code = { - readonly "input-file"?: ReadonlyArray|string -} - -const main = async (specificationsDirectory: string, profilesDirectory: string) => { - try { - const list = fs.recursiveReaddir(specificationsDirectory); - const specs = []; - let foundMultiApiReadmes = false; - for await (const file of list) { - const f = Path.parse(file); - if (f.base === "readme.enable-multi-api.md") { - foundMultiApiReadmes = true; - const content = (await fs.readFile(file)).toString(); - const readMe = cm.parse(content); - const set = new Set(); - for (const c of cm.iterate(readMe.markDown)) { - if ( - c.type === "code_block" && - c.info !== null && - c.info.startsWith("yaml") && - c.literal !== null - ) { - const y = (yaml.load(c.literal) as Code)["input-file"]; - if (typeof y === "string") { - set.add(y.replace('$(this-folder)', '')); - } else if (it.isArray(y)) { - for (const i of y) { - let cleanFilePath = i.replace('$(this-folder)', ''); - set.add(cleanFilePath); - specs.push(Path.join(f.dir, cleanFilePath)); - } - } - } - } - } - } - - if (!foundMultiApiReadmes){ - throw `Couldn't find any readme.enable-multi-api.md files.` - } - - const allPaths = await getPaths(specs); - const crawlResult = getCrawlData(allPaths); - const telemetryDir = Path.join(profilesDirectory, 'crawl-log.json') - fs.writeFile(telemetryDir, JSON.stringify(crawlResult, null, 2)); - console.log(`Telemetry written at ${telemetryDir}`); - - const latestProfile = getLatestProfile(crawlResult); - const latestProfileMarkDown = cm.markDownExToString( - { - markDown: cm.createNode( - "document", - cm.createNode( - "heading", - cm.createText("Latest Azure Profile") - ), - cm.createNode( - "block_quote", - cm.createNode( - "paragraph", - cm.createText("see https://aka.ms/autorest") - ) - ), - cm.createCodeBlock( - "yaml ", - yaml.dump({ "profiles":{[`latest-${getFormattedDate()}`]: latestProfile} }, { lineWidth: 1000 }) - ) - ) - } - ); - const latestProfileDir = Path.join(profilesDirectory, `definitions/`); - const latestProfileLocation = Path.join(latestProfileDir, `latest-${getFormattedDate()}.md`); - fs.writeFile(latestProfileLocation, latestProfileMarkDown); - console.log(`Latest profile written at ${latestProfileLocation}`); - - // now get all the profile definitions and generate the readme. - const definitions = fs.recursiveReaddir(latestProfileDir); - const definitionsRelativePaths = []; - for await (const file of definitions){ - const f = Path.parse(file); - definitionsRelativePaths.push(`$(this-folder)/definitions/${f.base}`); - } - - const profilesReadme = cm.markDownExToString( - { - markDown: cm.createNode( - "document", - cm.createNode( - 'heading', - cm.createText("Azure Profiles") - ), - cm.createNode( - "block_quote", - cm.createNode( - "paragraph", - cm.createText("see https://aka.ms/autorest") - ) - ), - cm.createNode( - "block_quote", - cm.createNode( - "paragraph", - cm.createText("The files under this directory are the profile definitions used by autorest.") - ) - ), - cm.createCodeBlock( - "yaml", - yaml.dump({ "require": definitionsRelativePaths }) - ) - ) - } - ); - - fs.writeFile(Path.join(profilesDirectory, "readme.md"), profilesReadme); - console.log(`Regenerated profiles readme.md at ${profilesDirectory}`); - console.log('DONE'); - } catch (e) { - console.error(e); - } -} - -function getFormattedDate(): string { - const today = new Date(); - const monthNumber = today.getMonth() + 1; - const dayNumber = today.getDate(); - - const yyyy = String(today.getFullYear()); - const mm = (monthNumber < 10) ? `0${monthNumber}` : String(monthNumber); - const dd = (dayNumber < 10) ? `0${dayNumber}` : String(dayNumber); - - return `${yyyy}-${mm}-${dd}`; -} - -async function getPaths(specHandles: Array): Promise> { - console.log(`Parsing specs`); - const result = new Array(); - for (const specHandle of specHandles) { - try { - const spec = JSON.parse((await fs.readFile(specHandle)).toString()); - if (spec.swagger && spec.info.version) { - for (const path of Object.entries(spec.paths)) { - result.push({endpoint: path[0], apiVersion: spec.info.version, originalLocation: Path.relative(process.cwd(), specHandle).replace(/\\/g, '/')}); - } - } - } catch (e) { - console.error(`Couldn't parse ${specHandle} - ${e}`); - } - } - - return result; -} - -function getCrawlData(paths: Array): CrawlResult { - console.log(`Crawling paths for resources and getting telemetry ...`); - const result: CrawlResult = {resources: new Array(), operations: {}}; - const providerNamePattern = `microsoft\.[a-z]+(?:\.[a-z]+)?`; - const parameterPattern = `\{[a-z0-9]+\}`; - const nonParameterPattern = `[a-z0-9]+`; - const resourcePathRegex = new RegExp(`(.*)(\/providers\/${providerNamePattern}(:?\/${nonParameterPattern}|\/${parameterPattern})+\/?$)`, 'gi'); - for (const p of paths) { - if (p.endpoint.match(resourcePathRegex)) { - const resource = { path: p.endpoint, apiVersion: p.apiVersion, providerNamespace: '', name: ''}; - - // get last /provider/microsoft.... section. Also, get rid of any possible trailing slash '/' - const scopedProviderSection = resource.path.replace(/\/*$/, '').replace(resourcePathRegex, '$2').split('/'); - resource.providerNamespace = scopedProviderSection[2].toLowerCase(); - - // for now, only provider-namespaces ending with admin are blacklisted - if (resource.providerNamespace.endsWith('admin')){ - if (result.blackListedPaths === undefined) { - result.blackListedPaths = []; - } - - result.blackListedPaths.push(p); - continue; - } - - const resourcesSection = `/${scopedProviderSection.slice(3).join('/')}`; - const resourceRegex = new RegExp(`\/${nonParameterPattern}\/${nonParameterPattern}|\/${nonParameterPattern}\/${parameterPattern}|\/${nonParameterPattern}$`, 'gi'); - const resourceMatches = resourcesSection.match(resourceRegex); - if (resourceMatches !== null) { - const resourceNames = resourceMatches.map(each => each.split('/')[1]); - resource.name = resourceNames.join('/'); - } - - result.resources.push(resource); - } else { - if (result.operations[p.endpoint] === undefined){ - result.operations[p.endpoint] = []; - } - - result.operations[p.endpoint].push({apiVersion:p.apiVersion, originalLocation: p.originalLocation}) - } - } - - return result; -} - - -export function getLatestProfile(crawlData: CrawlResult): Profile { - const latestProfile: Profile = {resources:{}, operations: {}}; - const allResources = crawlData.resources; - const allOperations = crawlData.operations; - const compareVersions = require('compare-versions'); - console.log('Constructing latest profile ...') - - // --- Process Resources --- - crawlData.resources.sort((a, b) => { - try{ - return compareVersions(getSemverEquivalent(b.apiVersion), getSemverEquivalent(a.apiVersion)); - } catch { - const dummy = ''; - console.log(dummy); - } - - }); - - const latestResources: {[uid: string] : Resource } = {}; - for (const resource of allResources) { - const resourceUid = `${resource.providerNamespace.toLowerCase()}${resource.name.toLowerCase()}`; - if (latestResources[resourceUid] === undefined) { - latestResources[resourceUid] = { apiVersion: resource.apiVersion, name: resource.name, providerNamespace: resource.providerNamespace.toLowerCase(), path: resource.path }; - } - } - - - for (const resource of values(latestResources)) { - latestProfile.resources[resource.providerNamespace] = latestProfile.resources[resource.providerNamespace] || {}; - latestProfile.resources[resource.providerNamespace][resource.apiVersion] = latestProfile.resources[resource.providerNamespace][resource.apiVersion] || []; - latestProfile.resources[resource.providerNamespace][resource.apiVersion].push(resource.name); - } - - for (const apiVersion of values(latestProfile.resources)) { - for (const resources of values(apiVersion)) { - resources.sort(); - } - } - - // --- Process Operations --- - for (const operation of values(allOperations)) { - operation.sort((a, b) => { - return compareVersions(getSemverEquivalent(b.apiVersion), getSemverEquivalent(a.apiVersion)); - }); - } - - for (const operation of keys(allOperations)) { - latestProfile.operations[operation] = allOperations[operation][0].apiVersion; - } - - return latestProfile; -} - -// azure rest specs mostly uses versioning of the form yyyy-mm-dd -// To take into consideration this we convert to an equivalent of -// semver for comparisons. -function getSemverEquivalent(version: string) { - let result = ''; - for (const i of version.split(/[\.\-]/g)) { - if (!result) { - result = i; - continue; - } - result = Number.isNaN(Number.parseInt(i)) ? `${result}-${i}` : `${result}.${Number(i)}`; - } - - const semver = require('semver'); - - return semver.valid(semver.coerce(result)); -} - -interface Resource { - path: string; - apiVersion: string; - providerNamespace: string; - name: string; -} - -interface CrawlResult { - operations: { - [operation:string]: Array<{ - apiVersion: string; - originalLocation: string; - }>; - }, - resources: Array, - blackListedPaths?: Array; -} - -interface PathMetadata { - endpoint: string; - apiVersion: string; - originalLocation: string; -} - -interface Profile { - resources: { - [providerNamespace: string]: { - [apiVersion: string]: Array; - }; - }, - operations: { - [path: string]: string; - } -} - -main(Path.join(process.cwd(), "specification"), Path.join(process.cwd(), "profiles")); diff --git a/scripts/multiapi.ts b/scripts/multiapi.ts deleted file mode 100644 index caed08c5e71e..000000000000 --- a/scripts/multiapi.ts +++ /dev/null @@ -1,108 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT License. See License.txt in the project root for license information. - -import * as fs from "@ts-common/fs" -import * as process from "process" -import * as path from "path" -import * as cm from "@ts-common/commonmark-to-markdown" -import * as it from "@ts-common/iterator" -import * as yaml from "js-yaml" - -type Code = { - readonly "input-file"?: ReadonlyArray|string -} -const magic = `yaml $(tag) == 'all-api-versions' /* autogenerated */`; -const pathRegex = /microsoft\.(\w+)[\\\/]\S*[\\\/](\d{4}-\d{2}-\d{2}(|-preview))[\\\/]/i; - -const main = async (specificationDir: string) => { - try { - const list = fs.recursiveReaddir(specificationDir) - for await (const file of list) { - const f = path.parse(file) - if (f.base === "readme.md" && f.dir.endsWith('resource-manager')) { - const original_content = (await fs.readFile(file)).toString() - let content = original_content; - const readMe = cm.parse(content) - const set = new Set() - for (const c of cm.iterate(readMe.markDown)) { - if ( - c.type === "code_block" && - c.info !== null && - (c.info.startsWith("yaml") && !c.info.startsWith(magic)) && - c.literal !== null - ) { - const DOC = (yaml.load(c.literal) as Code); - if (DOC ) { - const y = DOC['input-file'] - if (typeof y === "string") { - set.add(y) - } else if (it.isArray(y)) { - for (const i of y) { - set.add(i) - } - } - } - } - } - let map = new Map(); - for (let input of set) { - let match = pathRegex.exec(input); - if (!!match) { - let tagName = `schema-${match[1].toLowerCase()}-${match[2]}`; - if (!map.has(tagName)) { - map.set(tagName, []); - } - let array = map.get(tagName); - if (!!array) { - array.push(input); - } - } - } - map = new Map(Array.from(map.entries()).sort().reverse()); - let schemaReadmeContent = -`## AzureResourceSchema - -These settings apply only when \`--azureresourceschema\` is specified on the command line. - -### AzureResourceSchema multi-api - -\`\`\` yaml $(azureresourceschema) && $(multiapi) -${yaml.dump({ 'batch': it.toArray(it.map(map.keys(), (tagName) => ({'tag': tagName})))}, { lineWidth: 1000})} -\`\`\` - -Please also specify \`--azureresourceschema-folder=\`. -` - map.forEach((inputList, tagName) => { - schemaReadmeContent += -` -### Tag: ${tagName} and azureresourceschema - -\`\`\` yaml $(tag) == '${tagName}' && $(azureresourceschema) -output-folder: $(azureresourceschema-folder)/schemas - -# all the input files in this apiVersion -${yaml.dump({ 'input-file': it.toArray(inputList)}, { lineWidth: 1000})} -\`\`\` -` - }); - - // content = content.replace( /``` yaml \$\(tag\) == 'all-api-versions' \/\* autogenerated \*\/[\S\s]*?```/g, '') - // content = content.replace( /``` yaml \$\(tag\) == 'all-api-versions'[\S\s]*?```/g, '') - // content = content.replace( /## Multi-API\/Profile support for AutoRest v3 generators[\S\s]*/g, '') - - // if(original_content !== content ){ - // console.log(`Updating: ${file}`); - // fs.writeFile(path.join(f.dir, "readme.md"), content) - // } - - console.log(`Rewriting: ${f.dir}/readme.azureresourceschema.md`); - fs.writeFile(path.join(f.dir, "readme.azureresourceschema.md"), schemaReadmeContent); - - } - } - } catch (e) { - console.error(e) - } -} - -main(path.join(process.cwd(), "specification")) diff --git a/scripts/prettier-swagger-plugin.ts b/scripts/prettier-swagger-plugin.ts index 2d858e33e4fd..ee005c7ccc5e 100644 --- a/scripts/prettier-swagger-plugin.ts +++ b/scripts/prettier-swagger-plugin.ts @@ -1,5 +1,5 @@ import { ParserOptions, FastPath, Doc, doc, Plugin, AST } from 'prettier'; -import { parsers as bundledParsers } from 'prettier/parser-babylon'; +import { parsers as bundledParsers } from 'prettier/parser-babel'; const { concat, indent, hardline, join } = doc.builders; diff --git a/scripts/spellcheck.ts b/scripts/spellcheck.ts deleted file mode 100644 index 357e943f238e..000000000000 --- a/scripts/spellcheck.ts +++ /dev/null @@ -1,25 +0,0 @@ -import { logError, logWarn, runCheckOverChangedSpecFiles } from './utils'; - -runCheckOverChangedSpecFiles({ - onCheckFile: (context, filePath) => { - return context.exec(`cspell ${filePath}`); - }, - - onExecError: async (result) => { - if (result.stdout) { - logError(result.stdout); - } - if (result.stderr) { - console.error(result.stderr); - } - }, - - onNotInCI: (context) => { - logWarn("Not in CI environment. Run against all the spec json."); - return context.exec(`cspell "specification/**/*.json"`); - }, - - onFinalFailed: async () => { - logError('Please fix the error or add words to ./custom-words.txt'); - } -}) \ No newline at end of file diff --git a/scripts/swagger-to-sdk.sh b/scripts/swagger-to-sdk.sh deleted file mode 100755 index d9a664677038..000000000000 --- a/scripts/swagger-to-sdk.sh +++ /dev/null @@ -1,5 +0,0 @@ -#!/bin/sh - -python -c "import os; print('\n'.join(v for v in os.environ.keys() if v.startswith('TRAVIS') or v.startswith('NODE')))" > /tmp/env_file -docker pull azuresdk/swagger-to-sdk -docker run --rm --env-file /tmp/env_file -e GH_TOKEN -v $PWD:/git-restapi/ azuresdk/swagger-to-sdk "$@" diff --git a/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/Addons.json b/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/Addons.json index a4e9517dd2d7..78b509103685 100644 --- a/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/Addons.json +++ b/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/Addons.json @@ -48,7 +48,7 @@ "200": { "description": "List all the operations.", "schema": { - "$ref": "#/definitions/OperationList" + "$ref": "#/definitions/OperationListValue" } }, "default": { @@ -327,6 +327,15 @@ } } }, + "OperationListValue": { + "type": "object", + "description": "List of supported operations.", + "properties": { + "value": { + "$ref": "#/definitions/OperationList" + } + } + }, "OperationList": { "type": "array", "description": "List of supported operations.", @@ -384,10 +393,8 @@ "description": "Description of the error." }, "code": { - "type": "integer", - "description": "Service specific error code which serves as the substatus for the HTTP error code.", - "minimum": 100, - "maximum": 600 + "type": "string", + "description": "Service specific error code which serves as the substatus for the HTTP error code." } } } diff --git a/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/examples/Operations_List.json b/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/examples/Operations_List.json index b43f0323a561..42335ff287aa 100644 --- a/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/examples/Operations_List.json +++ b/specification/addons/resource-manager/Microsoft.Addons/preview/2017-05-15/examples/Operations_List.json @@ -4,53 +4,55 @@ }, "responses": { "200": { - "body": [ - { - "name": "Microsoft.Addons/supportProviders/supportPlanTypes/read", - "display": { - "provider": "Microsoft Addons", - "resource": "supportPlanTypes", - "operation": "Get Canonical support plan state", - "description": "Get the specified Canonical support plan state." + "body": { + "value": [ + { + "name": "Microsoft.Addons/supportProviders/supportPlanTypes/read", + "display": { + "provider": "Microsoft Addons", + "resource": "supportPlanTypes", + "operation": "Get Canonical support plan state", + "description": "Get the specified Canonical support plan state." + } + }, + { + "name": "Microsoft.Addons/supportProviders/supportPlanTypes/write", + "display": { + "provider": "Microsoft Addons", + "resource": "supportPlanTypes", + "operation": "Adds a Canonical support plan.", + "description": "Adds the Canonical support plan type specified." + } + }, + { + "name": "Microsoft.Addons/supportProviders/supportPlanTypes/delete", + "display": { + "provider": "Microsoft Addons", + "resource": "supportPlanTypes", + "operation": "Removes the Canonical support plan", + "description": "Removes the specified Canonical support plan" + } + }, + { + "name": "Microsoft.Addons/supportProviders/canonical/supportPlanTypes/get", + "display": { + "provider": "Microsoft Addons", + "resource": "supportProviders", + "operation": "Gets available Canonical support plan types.", + "description": "Gets the available Canonical support plan types as well as some extra metadata on their enabled status." + } + }, + { + "name": "Microsoft.Addons/register/action", + "display": { + "provider": "Microsoft Addons", + "resource": "register", + "operation": "Register for Microsoft.Addons", + "description": "Register the specified subscription with Microsoft.Addons" + } } - }, - { - "name": "Microsoft.Addons/supportProviders/supportPlanTypes/write", - "display": { - "provider": "Microsoft Addons", - "resource": "supportPlanTypes", - "operation": "Adds a Canonical support plan.", - "description": "Adds the Canonical support plan type specified." - } - }, - { - "name": "Microsoft.Addons/supportProviders/supportPlanTypes/delete", - "display": { - "provider": "Microsoft Addons", - "resource": "supportPlanTypes", - "operation": "Removes the Canonical support plan", - "description": "Removes the specified Canonical support plan" - } - }, - { - "name": "Microsoft.Addons/supportProviders/canonical/supportPlanTypes/get", - "display": { - "provider": "Microsoft Addons", - "resource": "supportProviders", - "operation": "Gets available Canonical support plan types.", - "description": "Gets the available Canonical support plan types as well as some extra metadata on their enabled status." - } - }, - { - "name": "Microsoft.Addons/register/action", - "display": { - "provider": "Microsoft Addons", - "resource": "register", - "operation": "Register for Microsoft.Addons", - "description": "Register the specified subscription with Microsoft.Addons" - } - } - ] + ] + } } } } diff --git a/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/addons-swagger.json b/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/addons-swagger.json index 62b473bf1191..1927068ae594 100644 --- a/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/addons-swagger.json +++ b/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/addons-swagger.json @@ -48,7 +48,7 @@ "200": { "description": "List all the operations.", "schema": { - "$ref": "#/definitions/OperationList" + "$ref": "#/definitions/OperationListValue" } }, "default": { @@ -336,6 +336,15 @@ } } }, + "OperationListValue": { + "type": "object", + "description": "List of supported operations.", + "properties": { + "value": { + "$ref": "#/definitions/OperationList" + } + } + }, "OperationList": { "type": "array", "description": "List of supported operations.", @@ -393,10 +402,8 @@ "description": "Description of the error." }, "code": { - "type": "integer", - "description": "Service specific error code which serves as the substatus for the HTTP error code.", - "minimum": 100, - "maximum": 600 + "type": "string", + "description": "Service specific error code which serves as the substatus for the HTTP error code." } } } diff --git a/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/examples/Operations_List.json b/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/examples/Operations_List.json index b43f0323a561..f8f846235048 100644 --- a/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/examples/Operations_List.json +++ b/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/examples/Operations_List.json @@ -1,56 +1,58 @@ { "parameters": { - "api-version": "2017-05-15" + "api-version": "2018-03-01" }, "responses": { "200": { - "body": [ - { - "name": "Microsoft.Addons/supportProviders/supportPlanTypes/read", - "display": { - "provider": "Microsoft Addons", - "resource": "supportPlanTypes", - "operation": "Get Canonical support plan state", - "description": "Get the specified Canonical support plan state." + "body": { + "value": [ + { + "name": "Microsoft.Addons/supportProviders/supportPlanTypes/read", + "display": { + "provider": "Microsoft Addons", + "resource": "supportPlanTypes", + "operation": "Get Canonical support plan state", + "description": "Get the specified Canonical support plan state." + } + }, + { + "name": "Microsoft.Addons/supportProviders/supportPlanTypes/write", + "display": { + "provider": "Microsoft Addons", + "resource": "supportPlanTypes", + "operation": "Adds a Canonical support plan.", + "description": "Adds the Canonical support plan type specified." + } + }, + { + "name": "Microsoft.Addons/supportProviders/supportPlanTypes/delete", + "display": { + "provider": "Microsoft Addons", + "resource": "supportPlanTypes", + "operation": "Removes the Canonical support plan", + "description": "Removes the specified Canonical support plan" + } + }, + { + "name": "Microsoft.Addons/supportProviders/canonical/supportPlanTypes/get", + "display": { + "provider": "Microsoft Addons", + "resource": "supportProviders", + "operation": "Gets available Canonical support plan types.", + "description": "Gets the available Canonical support plan types as well as some extra metadata on their enabled status." + } + }, + { + "name": "Microsoft.Addons/register/action", + "display": { + "provider": "Microsoft Addons", + "resource": "register", + "operation": "Register for Microsoft.Addons", + "description": "Register the specified subscription with Microsoft.Addons" + } } - }, - { - "name": "Microsoft.Addons/supportProviders/supportPlanTypes/write", - "display": { - "provider": "Microsoft Addons", - "resource": "supportPlanTypes", - "operation": "Adds a Canonical support plan.", - "description": "Adds the Canonical support plan type specified." - } - }, - { - "name": "Microsoft.Addons/supportProviders/supportPlanTypes/delete", - "display": { - "provider": "Microsoft Addons", - "resource": "supportPlanTypes", - "operation": "Removes the Canonical support plan", - "description": "Removes the specified Canonical support plan" - } - }, - { - "name": "Microsoft.Addons/supportProviders/canonical/supportPlanTypes/get", - "display": { - "provider": "Microsoft Addons", - "resource": "supportProviders", - "operation": "Gets available Canonical support plan types.", - "description": "Gets the available Canonical support plan types as well as some extra metadata on their enabled status." - } - }, - { - "name": "Microsoft.Addons/register/action", - "display": { - "provider": "Microsoft Addons", - "resource": "register", - "operation": "Register for Microsoft.Addons", - "description": "Register the specified subscription with Microsoft.Addons" - } - } - ] + ] + } } } } diff --git a/specification/advisor/resource-manager/readme.md b/specification/advisor/resource-manager/readme.md index d631a4e49820..6e9ca7ba8d72 100644 --- a/specification/advisor/resource-manager/readme.md +++ b/specification/advisor/resource-manager/readme.md @@ -85,7 +85,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js @@ -93,54 +93,14 @@ swagger-to-sdk: - repo: azure-resource-manager-schemas ``` -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.advisor - package-name: azure-mgmt-advisor - package-version: 1.0.1 - clear-output-folder: true -``` - -``` yaml $(python) && $(track2) -python-mode: create -azure-arm: true -license-header: MICROSOFT_MIT_NO_VERSION -namespace: azure.mgmt.advisor -package-name: azure-mgmt-advisor -package-version: 9.0.0b1 -clear-output-folder: true -``` - -``` yaml $(python) && $(python-mode) == 'update' -no-namespace-folders: true -output-folder: $(python-sdks-folder)/advisor/azure-mgmt-advisor/azure/mgmt/advisor -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/advisor/azure-mgmt-advisor/azure/mgmt/advisor -``` - -``` yaml $(python) && $(python-mode) == 'create' -basic-setup-py: true -output-folder: $(python-sdks-folder)/advisor/azure-mgmt-advisor -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/advisor/azure-mgmt-advisor -``` - ## Go See configuration in [readme.go.md](./readme.go.md) +## Python + +See configuration in [readme.python.md](./readme.python.md) + ## C# These settings apply only when `--csharp` is specified on the command line. diff --git a/specification/advisor/resource-manager/readme.python.md b/specification/advisor/resource-manager/readme.python.md new file mode 100644 index 000000000000..4fc829a9b050 --- /dev/null +++ b/specification/advisor/resource-manager/readme.python.md @@ -0,0 +1,24 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) && $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +namespace: azure.mgmt.advisor +package-name: azure-mgmt-advisor +package-version: 9.0.0b1 +clear-output-folder: true +``` + +``` yaml $(python) && $(python-mode) == 'update' && $(track2) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/advisor/azure-mgmt-advisor/azure/mgmt/advisor +``` + +``` yaml $(python) && $(python-mode) == 'create' && $(track2) +basic-setup-py: true +output-folder: $(python-sdks-folder)/advisor/azure-mgmt-advisor +``` diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json deleted file mode 100644 index 945954613e93..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json +++ /dev/null @@ -1,11826 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure AgFoodPlatform Data Plane Service", - "description": "APIs documentation for Azure AgPlatform DataPlane Service.", - "version": "2021-03-31-preview" - }, - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "#/parameters/Endpoint" - } - ] - }, - "paths": { - "/farmers/{farmerId}/application-data": { - "get": { - "tags": [ - "ApplicationData" - ], - "description": "Returns a paginated list of application data resources under a particular farm.", - "operationId": "ApplicationData_ListByFarmerId", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer.", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "minAvgMaterial", - "description": "Minimum average amount of material applied during the application (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxAvgMaterial", - "description": "Maximum average amount of material applied during the application (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "minTotalMaterial", - "description": "Minimum total amount of material applied during the application (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxTotalMaterial", - "description": "Maximum total amount of material applied during the application (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "sources", - "description": "Sources of the operation data.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "associatedBoundaryIds", - "description": "Boundary IDs associated with operation data.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "operationBoundaryIds", - "description": "Operation boundary IDs associated with operation data.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "minOperationStartDateTime", - "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "maxOperationStartDateTime", - "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "minOperationEndDateTime", - "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "maxOperationEndDateTime", - "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "minOperationModifiedDateTime", - "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "maxOperationModifiedDateTime", - "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "minArea", - "description": "Minimum area for which operation was applied (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxArea", - "description": "Maximum area for which operation was applied (inclusive).", - "type": "number", - "format": "double" - }, - { - "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/ApplicationDataListResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "ApplicationData_ListByFarmerId": { - "$ref": "./examples/ApplicationData_ListByFarmerId.json" - } - } - } - }, - "/application-data": { - "get": { - "tags": [ - "ApplicationData" - ], - "description": "Returns a paginated list of application data resources across all farmers.", - "operationId": "ApplicationData_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "query", - "name": "minAvgMaterial", - "description": "Minimum average amount of material applied during the application (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxAvgMaterial", - "description": "Maximum average amount of material applied during the application (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "minTotalMaterial", - "description": "Minimum total amount of material applied during the application (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxTotalMaterial", - "description": "Maximum total amount of material applied during the application (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "sources", - "description": "Sources of the operation data.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "associatedBoundaryIds", - "description": "Boundary IDs associated with operation data.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "operationBoundaryIds", - "description": "Operation boundary IDs associated with operation data.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "minOperationStartDateTime", - "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "maxOperationStartDateTime", - "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "minOperationEndDateTime", - "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "maxOperationEndDateTime", - "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "minOperationModifiedDateTime", - "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "maxOperationModifiedDateTime", - "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "minArea", - "description": "Minimum area for which operation was applied (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxArea", - "description": "Maximum area for which operation was applied (inclusive).", - "type": "number", - "format": "double" - }, - { - "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/ApplicationDataListResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "ApplicationData_List": { - "$ref": "./examples/ApplicationData_List.json" - } - } - } - }, - "/farmers/{farmerId}/application-data/{applicationDataId}": { - "get": { - "tags": [ - "ApplicationData" - ], - "description": "Get a specified application data resource under a particular farmer.", - "operationId": "ApplicationData_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer 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" - } - } - }, - "x-ms-examples": { - "ApplicationData_Get": { - "$ref": "./examples/ApplicationData_Get.json" - } - } - }, - "patch": { - "tags": [ - "ApplicationData" - ], - "description": "Creates or updates an application data resource under a particular farmer.", - "operationId": "ApplicationData_CreateOrUpdate", - "consumes": [ - "application/merge-patch+json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer.", - "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.", - "schema": { - "$ref": "#/definitions/ApplicationData" - } - } - ], - "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ApplicationData" - } - }, - "201": { - "description": "Success", - "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 farmer.", - "operationId": "ApplicationData_Delete", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer 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": "Success" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "ApplicationData_Delete": { - "$ref": "./examples/ApplicationData_Delete.json" - } - } - } - }, - "/farmers/{farmerId}/attachments": { - "get": { - "tags": [ - "Attachments" - ], - "description": "Returns a paginated list of attachment resources under a particular farmer.", - "operationId": "Attachments_ListByFarmerId", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer.", - "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.", - "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" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Attachments_ListByFarmerId": { - "$ref": "./examples/Attachments_ListByFarmerId.json" - } - } - } - }, - "/farmers/{farmerId}/attachments/{attachmentId}": { - "get": { - "tags": [ - "Attachments" - ], - "description": "Gets a specified attachment resource under a particular farmer.", - "operationId": "Attachments_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer.", - "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" - } - } - }, - "x-ms-examples": { - "Attachments_Get": { - "$ref": "./examples/Attachments_Get.json" - } - } - }, - "patch": { - "tags": [ - "Attachments" - ], - "description": "Creates or updates an attachment resource under a particular farmer.", - "operationId": "Attachments_CreateOrUpdate", - "consumes": [ - "multipart/form-data" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer 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", - "description": "File to be uploaded.", - "type": "file", - "format": "binary" - }, - { - "in": "formData", - "name": "FarmerId", - "description": "Farmer id for this attachment.", - "type": "string" - }, - { - "in": "formData", - "name": "ResourceId", - "description": "Associated Resource id for this attachment.", - "type": "string" - }, - { - "in": "formData", - "name": "ResourceType", - "description": "Associated Resource type for this attachment\r\ni.e. Farmer, Farm, Field, SeasonalField, Boundary, FarmOperationApplicationData, HarvestData, TillageData, PlantingData.", - "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": "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": "ETag", - "description": "The ETag value to implement optimistic concurrency.", - "type": "string" - } - ], - "responses": { - "201": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Attachment" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Attachment" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Attachments_CreateOrUpdate": { - "$ref": "./examples/Attachments_CreateOrUpdate.json" - } - } - }, - "delete": { - "tags": [ - "Attachments" - ], - "description": "Deletes a specified attachment resource under a particular farmer.", - "operationId": "Attachments_Delete", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the farmer.", - "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": "Success" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Attachments_Delete": { - "$ref": "./examples/Attachments_Delete.json" - } - } - } - }, - "/farmers/{farmerId}/attachments/{attachmentId}/file": { - "get": { - "tags": [ - "Attachments" - ], - "description": "Downloads and returns attachment as response for the given input filePath.", - "operationId": "Attachments_Download", - "produces": [ - "application/octet-stream", - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer.", - "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" - } - } - }, - "x-ms-examples": { - "Attachments_Download": { - "$ref": "./examples/Attachments_Download.json" - } - } - } - }, - "/farmers/{farmerId}/boundaries": { - "get": { - "tags": [ - "Boundaries" - ], - "description": "Returns a paginated list of boundary resources under a particular farmer.", - "operationId": "Boundaries_ListByFarmerId", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer.", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "isPrimary", - "description": "Is the boundary primary.", - "type": "boolean" - }, - { - "in": "query", - "name": "parentType", - "description": "Type of the parent it belongs to.", - "type": "string" - }, - { - "in": "query", - "name": "parentIds", - "description": "Parent Ids of the resource.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "minAcreage", - "description": "Minimum acreage of the boundary (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxAcreage", - "description": "Maximum acreage of the boundary (inclusive).", - "type": "number", - "format": "double" - }, - { - "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/BoundaryListResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Boundaries_ListByFarmerId": { - "$ref": "./examples/Boundaries_ListByFarmerId.json" - } - } - }, - "post": { - "tags": [ - "Boundaries" - ], - "description": "Search for boundaries by fields and intersecting geometry.", - "operationId": "Boundaries_SearchByFarmerId", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the farmer.", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "api-version", - "description": "The requested API version", - "required": true, - "type": "string" - }, - { - "in": "body", - "name": "query", - "description": "Query filters.", - "schema": { - "$ref": "#/definitions/SearchBoundaryQuery" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/BoundaryListResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Boundaries_SearchByFarmerId": { - "$ref": "./examples/Boundaries_SearchByFarmerId.json" - } - } - } - }, - "/boundaries": { - "get": { - "tags": [ - "Boundaries" - ], - "description": "Returns a paginated list of boundary resources across all farmers.", - "operationId": "Boundaries_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "query", - "name": "isPrimary", - "description": "Is the boundary primary.", - "type": "boolean" - }, - { - "in": "query", - "name": "parentType", - "description": "Type of the parent it belongs to.", - "type": "string" - }, - { - "in": "query", - "name": "parentIds", - "description": "Parent Ids of the resource.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "minAcreage", - "description": "Minimum acreage of the boundary (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxAcreage", - "description": "Maximum acreage of the boundary (inclusive).", - "type": "number", - "format": "double" - }, - { - "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/BoundaryListResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Boundaries_List": { - "$ref": "./examples/Boundaries_List.json" - } - } - }, - "post": { - "tags": [ - "Boundaries" - ], - "description": "Search for boundaries across all farmers by fields and intersecting geometry.", - "operationId": "Boundaries_Search", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "query", - "name": "api-version", - "description": "The requested API version", - "required": true, - "type": "string" - }, - { - "in": "body", - "name": "query", - "description": "Query filters.", - "schema": { - "$ref": "#/definitions/SearchBoundaryQuery" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/BoundaryListResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Boundaries_Search": { - "$ref": "./examples/Boundaries_Search.json" - } - } - } - }, - "/boundaries/cascade-delete/{jobId}": { - "get": { - "tags": [ - "Boundaries" - ], - "description": "Get cascade delete job for specified boundary.", - "operationId": "Boundaries_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" - } - } - }, - "x-ms-examples": { - "Boundaries_GetCascadeDeleteJobDetails": { - "$ref": "./examples/Boundaries_GetCascadeDeleteJobDetails.json" - } - } - }, - "put": { - "tags": [ - "Boundaries" - ], - "description": "Create a cascade delete job for specified boundary.", - "operationId": "Boundaries_CreateCascadeDeleteJob", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "jobId", - "description": "Job ID supplied by end user.", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "farmerId", - "description": "ID of the associated farmer.", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "boundaryId", - "description": "ID of the boundary to be deleted.", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "api-version", - "description": "The requested API version", - "required": true, - "type": "string" - } - ], - "responses": { - "202": { - "description": "Success", - "schema": { - "$ref": "#/definitions/CascadeDeleteJob" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "Boundaries_CreateCascadeDeleteJob": { - "$ref": "./examples/Boundaries_CreateCascadeDeleteJob.json" - } - } - } - }, - "/farmers/{farmerId}/boundaries/{boundaryId}": { - "get": { - "tags": [ - "Boundaries" - ], - "description": "Gets a specified boundary resource under a particular farmer.", - "operationId": "Boundaries_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "boundaryId", - "description": "ID of the boundary.", - "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/Boundary" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Boundaries_Get": { - "$ref": "./examples/Boundaries_Get.json" - } - } - }, - "patch": { - "tags": [ - "Boundaries" - ], - "description": "Creates or updates a boundary resource.", - "operationId": "Boundaries_CreateOrUpdate", - "consumes": [ - "application/merge-patch+json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the farmer resource.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "boundaryId", - "description": "ID of the boundary resource.", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "api-version", - "description": "The requested API version", - "required": true, - "type": "string" - }, - { - "in": "body", - "name": "boundary", - "description": "Boundary resource payload to create or update.", - "schema": { - "$ref": "#/definitions/Boundary" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Boundary" - } - }, - "201": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Boundary" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Boundaries_CreateOrUpdate": { - "$ref": "./examples/Boundaries_CreateOrUpdate.json" - } - } - }, - "delete": { - "tags": [ - "Boundaries" - ], - "description": "Deletes a specified boundary resource under a particular farmer.", - "operationId": "Boundaries_Delete", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the farmer.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "boundaryId", - "description": "ID of the boundary.", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "api-version", - "description": "The requested API version", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "Success" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Boundaries_Delete": { - "$ref": "./examples/Boundaries_Delete.json" - } - } - } - }, - "/farmers/{farmerId}/boundaries/{boundaryId}/overlap": { - "get": { - "tags": [ - "Boundaries" - ], - "description": "Returns overlapping acreage between two boundary Ids.", - "operationId": "Boundaries_GetOverlap", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the farmer.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "boundaryId", - "description": "ID of the boundary.", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "otherFarmerId", - "description": "FarmerId of the other field.", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "otherBoundaryId", - "description": "ID of the other boundary.", - "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/BoundaryOverlapResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Boundaries_GetOverlap": { - "$ref": "./examples/Boundaries_GetOverlap.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 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/CropListResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "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" - } - } - }, - "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.", - "schema": { - "$ref": "#/definitions/Crop" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Crop" - } - }, - "201": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Crop" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "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": "Success" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Crops_Delete": { - "$ref": "./examples/Crops_Delete.json" - } - } - } - }, - "/crops/{cropId}/crop-varieties": { - "get": { - "tags": [ - "CropVarieties" - ], - "description": "Returns a paginated list of crop variety resources under a particular crop.", - "operationId": "CropVarieties_ListByCropId", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "cropId", - "description": "ID of the associated crop.", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "cropIds", - "description": "CropIds of the resource.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "brands", - "description": "Brands of the resource.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "products", - "description": "Products of 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/CropVarietyListResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "CropVarieties_ListByCropId": { - "$ref": "./examples/CropVarieties_ListByCropId.json" - } - } - } - }, - "/crop-varieties": { - "get": { - "tags": [ - "CropVarieties" - ], - "description": "Returns a paginated list of crop variety resources across all crops.", - "operationId": "CropVarieties_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "query", - "name": "cropIds", - "description": "CropIds of the resource.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "brands", - "description": "Brands of the resource.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "products", - "description": "Products of 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/CropVarietyListResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "CropVarieties_List": { - "$ref": "./examples/CropVarieties_List.json" - } - } - } - }, - "/crops/{cropId}/crop-varieties/{cropVarietyId}": { - "get": { - "tags": [ - "CropVarieties" - ], - "description": "Gets a specified crop variety resource under a particular crop.", - "operationId": "CropVarieties_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "cropId", - "description": "ID of the associated crop.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "cropVarietyId", - "description": "ID of the crop variety.", - "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/CropVariety" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "CropVarieties_Get": { - "$ref": "./examples/CropVarieties_Get.json" - } - } - }, - "patch": { - "tags": [ - "CropVarieties" - ], - "description": "Creates or updates a crop variety resource.", - "operationId": "CropVarieties_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": "path", - "name": "cropVarietyId", - "description": "ID of the crop variety resource.", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "api-version", - "description": "The requested API version", - "required": true, - "type": "string" - }, - { - "in": "body", - "name": "cropVariety", - "description": "Crop variety resource payload to create or update.", - "schema": { - "$ref": "#/definitions/CropVariety" - } - } - ], - "responses": { - "201": { - "description": "Success", - "schema": { - "$ref": "#/definitions/CropVariety" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/CropVariety" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "CropVarieties_CreateOrUpdate": { - "$ref": "./examples/CropVarieties_CreateOrUpdate.json" - } - } - }, - "delete": { - "tags": [ - "CropVarieties" - ], - "description": "Deletes a specified crop variety resource under a particular crop.", - "operationId": "CropVarieties_Delete", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "cropId", - "description": "ID of the crop.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "cropVarietyId", - "description": "ID of the crop variety.", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "api-version", - "description": "The requested API version", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "Success" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "CropVarieties_Delete": { - "$ref": "./examples/CropVarieties_Delete.json" - } - } - } - }, - "/farmers": { - "get": { - "tags": [ - "Farmers" - ], - "description": "Returns a paginated list of farmer resources.", - "operationId": "Farmers_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/FarmerListResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Farmers_List": { - "$ref": "./examples/Farmers_List.json" - } - } - } - }, - "/farmers/{farmerId}": { - "get": { - "tags": [ - "Farmers" - ], - "description": "Gets a specified farmer resource.", - "operationId": "Farmers_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer.", - "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/Farmer" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Farmers_Get": { - "$ref": "./examples/Farmers_Get.json" - } - } - }, - "patch": { - "tags": [ - "Farmers" - ], - "description": "Creates or updates a farmer resource.", - "operationId": "Farmers_CreateOrUpdate", - "consumes": [ - "application/merge-patch+json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the farmer resource.", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "api-version", - "description": "The requested API version", - "required": true, - "type": "string" - }, - { - "in": "body", - "name": "farmer", - "description": "Farmer resource payload to create or update.", - "schema": { - "$ref": "#/definitions/Farmer" - } - } - ], - "responses": { - "201": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Farmer" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Farmer" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Farmers_CreateOrUpdate": { - "$ref": "./examples/Farmers_CreateOrUpdate.json" - } - } - }, - "delete": { - "tags": [ - "Farmers" - ], - "description": "Deletes a specified farmer resource.", - "operationId": "Farmers_Delete", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of farmer to be deleted.", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "api-version", - "description": "The requested API version", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "Success" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Farmers_Delete": { - "$ref": "./examples/Farmers_Delete.json" - } - } - } - }, - "/farmers/cascade-delete/{jobId}": { - "get": { - "tags": [ - "Farmers" - ], - "description": "Get a cascade delete job for specified farmer.", - "operationId": "Farmers_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" - } - } - }, - "x-ms-examples": { - "Farmers_GetCascadeDeleteJobDetails": { - "$ref": "./examples/Farmers_GetCascadeDeleteJobDetails.json" - } - } - }, - "put": { - "tags": [ - "Farmers" - ], - "description": "Create a cascade delete job for specified farmer.", - "operationId": "Farmers_CreateCascadeDeleteJob", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "jobId", - "description": "Job ID supplied by end user.", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "farmerId", - "description": "ID of the farmer to be deleted.", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "api-version", - "description": "The requested API version", - "required": true, - "type": "string" - } - ], - "responses": { - "202": { - "description": "Success", - "schema": { - "$ref": "#/definitions/CascadeDeleteJob" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "Farmers_CreateCascadeDeleteJob": { - "$ref": "./examples/Farmers_CreateCascadeDeleteJob.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.", - "schema": { - "$ref": "#/definitions/FarmOperationDataIngestionJob" - } - } - ], - "responses": { - "202": { - "description": "Success", - "schema": { - "$ref": "#/definitions/FarmOperationDataIngestionJob" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "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" - } - } - }, - "x-ms-examples": { - "FarmOperations_GetDataIngestionJobDetails": { - "$ref": "./examples/FarmOperations_GetDataIngestionJobDetails.json" - } - } - } - }, - "/farmers/{farmerId}/farms": { - "get": { - "tags": [ - "Farms" - ], - "description": "Returns a paginated list of farm resources under a particular farmer.", - "operationId": "Farms_ListByFarmerId", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer.", - "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" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Farms_ListByFarmerId": { - "$ref": "./examples/Farms_ListByFarmerId.json" - } - } - } - }, - "/farms": { - "get": { - "tags": [ - "Farms" - ], - "description": "Returns a paginated list of farm resources across all farmers.", - "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" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Farms_List": { - "$ref": "./examples/Farms_List.json" - } - } - } - }, - "/farmers/{farmerId}/farms/{farmId}": { - "get": { - "tags": [ - "Farms" - ], - "description": "Gets a specified farm resource under a particular farmer.", - "operationId": "Farms_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer 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" - } - } - }, - "x-ms-examples": { - "Farms_Get": { - "$ref": "./examples/Farms_Get.json" - } - } - }, - "patch": { - "tags": [ - "Farms" - ], - "description": "Creates or updates a farm resource under a particular farmer.", - "operationId": "Farms_CreateOrUpdate", - "consumes": [ - "application/merge-patch+json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer 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.", - "schema": { - "$ref": "#/definitions/Farm" - } - } - ], - "responses": { - "201": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Farm" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Farm" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Farms_CreateOrUpdate": { - "$ref": "./examples/Farms_CreateOrUpdate.json" - } - } - }, - "delete": { - "tags": [ - "Farms" - ], - "description": "Deletes a specified farm resource under a particular farmer.", - "operationId": "Farms_Delete", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the farmer.", - "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": "Success" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Farms_Delete": { - "$ref": "./examples/Farms_Delete.json" - } - } - } - }, - "/farms/cascade-delete/{jobId}": { - "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" - } - } - }, - "x-ms-examples": { - "Farms_GetCascadeDeleteJobDetails": { - "$ref": "./examples/Farms_GetCascadeDeleteJobDetails.json" - } - } - }, - "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": "farmerId", - "description": "ID of the associated farmer.", - "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": "Success", - "schema": { - "$ref": "#/definitions/CascadeDeleteJob" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "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" - } - } - } - }, - "/farmers/{farmerId}/fields": { - "get": { - "tags": [ - "Fields" - ], - "description": "Returns a paginated list of field resources under a particular farmer.", - "operationId": "Fields_ListByFarmerId", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer.", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "farmIds", - "description": "Farm Ids of 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/FieldListResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Fields_ListByFarmerId": { - "$ref": "./examples/Fields_ListByFarmerId.json" - } - } - } - }, - "/fields": { - "get": { - "tags": [ - "Fields" - ], - "description": "Returns a paginated list of field resources across all farmers.", - "operationId": "Fields_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "query", - "name": "farmIds", - "description": "Farm Ids of 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/FieldListResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Fields_List": { - "$ref": "./examples/Fields_List.json" - } - } - } - }, - "/farmers/{farmerId}/fields/{fieldId}": { - "get": { - "tags": [ - "Fields" - ], - "description": "Gets a specified field resource under a particular farmer.", - "operationId": "Fields_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer.", - "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" - } - } - }, - "x-ms-examples": { - "Fields_Get": { - "$ref": "./examples/Fields_Get.json" - } - } - }, - "patch": { - "tags": [ - "Fields" - ], - "description": "Creates or Updates a field resource under a particular farmer.", - "operationId": "Fields_CreateOrUpdate", - "consumes": [ - "application/merge-patch+json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer 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.", - "schema": { - "$ref": "#/definitions/Field" - } - } - ], - "responses": { - "201": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Field" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Field" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Fields_CreateOrUpdate": { - "$ref": "./examples/Fields_CreateOrUpdate.json" - } - } - }, - "delete": { - "tags": [ - "Fields" - ], - "description": "Deletes a specified field resource under a particular farmer.", - "operationId": "Fields_Delete", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the farmer.", - "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": "Success" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Fields_Delete": { - "$ref": "./examples/Fields_Delete.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" - } - } - }, - "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": "farmerId", - "description": "ID of the associated farmer.", - "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": "Success", - "schema": { - "$ref": "#/definitions/CascadeDeleteJob" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "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" - } - } - } - }, - "/farmers/{farmerId}/harvest-data": { - "get": { - "tags": [ - "HarvestData" - ], - "description": "Returns a paginated list of harvest data resources under a particular farm.", - "operationId": "HarvestData_ListByFarmerId", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer.", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "minTotalYield", - "description": "Minimum Yield value(inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxTotalYield", - "description": "Maximum Yield value (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "minAvgYield", - "description": "Minimum AvgYield value(inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxAvgYield", - "description": "Maximum AvgYield value (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "minTotalWetMass", - "description": "Minimum Total WetMass value(inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxTotalWetMass", - "description": "Maximum Total WetMass value (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "minAvgWetMass", - "description": "Minimum AvgWetMass value(inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxAvgWetMass", - "description": "Maximum AvgWetMass value (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "minAvgMoisture", - "description": "Minimum AvgMoisture value(inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxAvgMoisture", - "description": "Maximum AvgMoisture value (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "minAvgSpeed", - "description": "Minimum AvgSpeed value(inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxAvgSpeed", - "description": "Maximum AvgSpeed value (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "sources", - "description": "Sources of the operation data.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "associatedBoundaryIds", - "description": "Boundary IDs associated with operation data.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "operationBoundaryIds", - "description": "Operation boundary IDs associated with operation data.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "minOperationStartDateTime", - "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "maxOperationStartDateTime", - "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "minOperationEndDateTime", - "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "maxOperationEndDateTime", - "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "minOperationModifiedDateTime", - "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "maxOperationModifiedDateTime", - "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "minArea", - "description": "Minimum area for which operation was applied (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxArea", - "description": "Maximum area for which operation was applied (inclusive).", - "type": "number", - "format": "double" - }, - { - "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/HarvestDataListResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "HarvestData_ListByFarmerId": { - "$ref": "./examples/HarvestData_ListByFarmerId.json" - } - } - } - }, - "/harvest-data": { - "get": { - "tags": [ - "HarvestData" - ], - "description": "Returns a paginated list of harvest data resources across all farmers.", - "operationId": "HarvestData_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "query", - "name": "minTotalYield", - "description": "Minimum Yield value(inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxTotalYield", - "description": "Maximum Yield value (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "minAvgYield", - "description": "Minimum AvgYield value(inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxAvgYield", - "description": "Maximum AvgYield value (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "minTotalWetMass", - "description": "Minimum Total WetMass value(inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxTotalWetMass", - "description": "Maximum Total WetMass value (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "minAvgWetMass", - "description": "Minimum AvgWetMass value(inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxAvgWetMass", - "description": "Maximum AvgWetMass value (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "minAvgMoisture", - "description": "Minimum AvgMoisture value(inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxAvgMoisture", - "description": "Maximum AvgMoisture value (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "minAvgSpeed", - "description": "Minimum AvgSpeed value(inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxAvgSpeed", - "description": "Maximum AvgSpeed value (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "sources", - "description": "Sources of the operation data.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "associatedBoundaryIds", - "description": "Boundary IDs associated with operation data.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "operationBoundaryIds", - "description": "Operation boundary IDs associated with operation data.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "minOperationStartDateTime", - "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "maxOperationStartDateTime", - "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "minOperationEndDateTime", - "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "maxOperationEndDateTime", - "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "minOperationModifiedDateTime", - "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "maxOperationModifiedDateTime", - "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "minArea", - "description": "Minimum area for which operation was applied (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxArea", - "description": "Maximum area for which operation was applied (inclusive).", - "type": "number", - "format": "double" - }, - { - "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/HarvestDataListResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "HarvestData_List": { - "$ref": "./examples/HarvestData_List.json" - } - } - } - }, - "/farmers/{farmerId}/harvest-data/{harvestDataId}": { - "get": { - "tags": [ - "HarvestData" - ], - "description": "Get a specified harvest data resource under a particular farmer.", - "operationId": "HarvestData_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer 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" - } - } - }, - "x-ms-examples": { - "HarvestData_Get": { - "$ref": "./examples/HarvestData_Get.json" - } - } - }, - "patch": { - "tags": [ - "HarvestData" - ], - "description": "Creates or updates harvest data resource under a particular farmer.", - "operationId": "HarvestData_CreateOrUpdate", - "consumes": [ - "application/merge-patch+json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the farmer.", - "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.", - "schema": { - "$ref": "#/definitions/HarvestData" - } - } - ], - "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/HarvestData" - } - }, - "201": { - "description": "Success", - "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 farmer.", - "operationId": "HarvestData_Delete", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer 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": "Success" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "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.", - "schema": { - "$ref": "#/definitions/ImageProcessingRasterizeJob" - } - } - ], - "responses": { - "202": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ImageProcessingRasterizeJob" - } - }, - "default": { - "description": "Error" - } - }, - "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" - } - } - }, - "x-ms-examples": { - "ImageProcessing_GetRasterizeJob": { - "$ref": "./examples/ImageProcessing_GetRasterizeJob.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" - } - } - }, - "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" - } - } - }, - "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.", - "schema": { - "$ref": "#/definitions/OAuthProvider" - } - } - ], - "responses": { - "201": { - "description": "Success", - "schema": { - "$ref": "#/definitions/OAuthProvider" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/OAuthProvider" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "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": "Success" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "OAuthProviders_Delete": { - "$ref": "./examples/OAuthProviders_Delete.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": "farmerIds", - "description": "List of farmers.", - "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" - } - } - }, - "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": "connectRequest", - "description": "OAuth Connect Request.", - "schema": { - "$ref": "#/definitions/OAuthConnectRequest" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "type": "string" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "OAuthTokens_GetOAuthConnectionLink": { - "$ref": "./examples/OAuthTokens_GetOAuthConnectionLink.json" - } - } - } - }, - "/oauth/tokens/remove/{jobId}": { - "get": { - "tags": [ - "OAuthTokens" - ], - "description": "Get cascade delete job details for OAuth tokens for specified job ID.", - "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" - } - } - }, - "x-ms-examples": { - "OAuthTokens_GetCascadeDeleteJobDetails": { - "$ref": "./examples/OAuthTokens_GetCascadeDeleteJobDetails.json" - } - } - }, - "put": { - "tags": [ - "OAuthTokens" - ], - "description": "Create a cascade delete job for OAuth tokens.", - "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": "farmerId", - "description": "ID of the farmer.", - "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": "Success", - "schema": { - "$ref": "#/definitions/CascadeDeleteJob" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "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" - } - } - } - }, - "/farmers/{farmerId}/planting-data": { - "get": { - "tags": [ - "PlantingData" - ], - "description": "Returns a paginated list of planting data resources under a particular farm.", - "operationId": "PlantingData_ListByFarmerId", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer.", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "minAvgPlantingRate", - "description": "Minimum AvgPlantingRate value(inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxAvgPlantingRate", - "description": "Maximum AvgPlantingRate value (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "minTotalMaterial", - "description": "Minimum TotalMaterial value(inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxTotalMaterial", - "description": "Maximum TotalMaterial value (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "minAvgMaterial", - "description": "Minimum AvgMaterial value(inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxAvgMaterial", - "description": "Maximum AvgMaterial value (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "sources", - "description": "Sources of the operation data.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "associatedBoundaryIds", - "description": "Boundary IDs associated with operation data.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "operationBoundaryIds", - "description": "Operation boundary IDs associated with operation data.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "minOperationStartDateTime", - "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "maxOperationStartDateTime", - "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "minOperationEndDateTime", - "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "maxOperationEndDateTime", - "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "minOperationModifiedDateTime", - "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "maxOperationModifiedDateTime", - "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "minArea", - "description": "Minimum area for which operation was applied (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxArea", - "description": "Maximum area for which operation was applied (inclusive).", - "type": "number", - "format": "double" - }, - { - "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/PlantingDataListResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "PlantingData_ListByFarmerId": { - "$ref": "./examples/PlantingData_ListByFarmerId.json" - } - } - } - }, - "/planting-data": { - "get": { - "tags": [ - "PlantingData" - ], - "description": "Returns a paginated list of planting data resources across all farmers.", - "operationId": "PlantingData_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "query", - "name": "minAvgPlantingRate", - "description": "Minimum AvgPlantingRate value(inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxAvgPlantingRate", - "description": "Maximum AvgPlantingRate value (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "minTotalMaterial", - "description": "Minimum TotalMaterial value(inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxTotalMaterial", - "description": "Maximum TotalMaterial value (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "minAvgMaterial", - "description": "Minimum AvgMaterial value(inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxAvgMaterial", - "description": "Maximum AvgMaterial value (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "sources", - "description": "Sources of the operation data.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "associatedBoundaryIds", - "description": "Boundary IDs associated with operation data.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "operationBoundaryIds", - "description": "Operation boundary IDs associated with operation data.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "minOperationStartDateTime", - "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "maxOperationStartDateTime", - "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "minOperationEndDateTime", - "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "maxOperationEndDateTime", - "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "minOperationModifiedDateTime", - "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "maxOperationModifiedDateTime", - "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "minArea", - "description": "Minimum area for which operation was applied (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxArea", - "description": "Maximum area for which operation was applied (inclusive).", - "type": "number", - "format": "double" - }, - { - "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/PlantingDataListResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "PlantingData_List": { - "$ref": "./examples/PlantingData_List.json" - } - } - } - }, - "/farmers/{farmerId}/planting-data/{plantingDataId}": { - "get": { - "tags": [ - "PlantingData" - ], - "description": "Get a specified planting data resource under a particular farmer.", - "operationId": "PlantingData_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer 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" - } - } - }, - "x-ms-examples": { - "PlantingData_Get": { - "$ref": "./examples/PlantingData_Get.json" - } - } - }, - "patch": { - "tags": [ - "PlantingData" - ], - "description": "Creates or updates an planting data resource under a particular farmer.", - "operationId": "PlantingData_CreateOrUpdate", - "consumes": [ - "application/merge-patch+json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer.", - "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.", - "schema": { - "$ref": "#/definitions/PlantingData" - } - } - ], - "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/PlantingData" - } - }, - "201": { - "description": "Success", - "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 farmer.", - "operationId": "PlantingData_Delete", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer 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": "Success" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "PlantingData_Delete": { - "$ref": "./examples/PlantingData_Delete.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.", - "required": true, - "type": "string", - "default": "Microsoft" - }, - { - "in": "query", - "name": "farmerId", - "description": "FarmerId.", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "boundaryId", - "description": "BoundaryId.", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "source", - "description": "Source name of scene data, default value Sentinel_2_L2A (Sentinel 2 L2A).", - "type": "string", - "default": "Sentinel_2_L2A" - }, - { - "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" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Scenes_List": { - "$ref": "./examples/Scenes_List.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.", - "schema": { - "$ref": "#/definitions/SatelliteDataIngestionJob" - } - } - ], - "responses": { - "202": { - "description": "Success", - "schema": { - "$ref": "#/definitions/SatelliteDataIngestionJob" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "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" - } - } - }, - "x-ms-examples": { - "Scenes_GetSatelliteDataIngestionJobDetails": { - "$ref": "./examples/Scenes_GetSatelliteDataIngestionJobDetails.json" - } - } - } - }, - "/scenes/downloadFiles": { - "get": { - "tags": [ - "Scenes" - ], - "description": "Downloads and returns file stream as response for the given input filePath.", - "operationId": "Scenes_Download", - "produces": [ - "application/octet-stream", - "application/json" - ], - "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" - } - } - }, - "x-ms-examples": { - "Scenes_Download": { - "$ref": "./examples/Scenes_Download.json" - } - } - } - }, - "/farmers/{farmerId}/seasonal-fields": { - "get": { - "tags": [ - "SeasonalFields" - ], - "description": "Returns a paginated list of seasonal field resources under a particular farmer.", - "operationId": "SeasonalFields_ListByFarmerId", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer.", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "farmIds", - "description": "Farm 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": "seasonIds", - "description": "Season Ids of the resource.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "cropVarietyIds", - "description": "CropVarietyIds of the resource.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "cropIds", - "description": "Ids of the crop it belongs to.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "minAvgYieldValue", - "description": "Minimum average yield value of the seasonal field(inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxAvgYieldValue", - "description": "Maximum average yield value of the seasonal field(inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "avgYieldUnit", - "description": "Unit of the average yield value attribute.", - "type": "string" - }, - { - "in": "query", - "name": "minAvgSeedPopulationValue", - "description": "Minimum average seed population value of the seasonal field(inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxAvgSeedPopulationValue", - "description": "Maximum average seed population value of the seasonal field(inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "avgSeedPopulationUnit", - "description": "Unit of average seed population value attribute.", - "type": "string" - }, - { - "in": "query", - "name": "minPlantingDateTime", - "description": "Minimum planting datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "maxPlantingDateTime", - "description": "Maximum planting datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", - "type": "string", - "format": "date-time" - }, - { - "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/SeasonalFieldListResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "SeasonalFields_ListByFarmerId": { - "$ref": "./examples/SeasonalFields_ListByFarmerId.json" - } - } - } - }, - "/seasonal-fields": { - "get": { - "tags": [ - "SeasonalFields" - ], - "description": "Returns a paginated list of seasonal field resources across all farmers.", - "operationId": "SeasonalFields_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "query", - "name": "farmIds", - "description": "Farm 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": "seasonIds", - "description": "Season Ids of the resource.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "cropVarietyIds", - "description": "CropVarietyIds of the resource.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "cropIds", - "description": "Ids of the crop it belongs to.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "minAvgYieldValue", - "description": "Minimum average yield value of the seasonal field(inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxAvgYieldValue", - "description": "Maximum average yield value of the seasonal field(inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "avgYieldUnit", - "description": "Unit of the average yield value attribute.", - "type": "string" - }, - { - "in": "query", - "name": "minAvgSeedPopulationValue", - "description": "Minimum average seed population value of the seasonal field(inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxAvgSeedPopulationValue", - "description": "Maximum average seed population value of the seasonal field(inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "avgSeedPopulationUnit", - "description": "Unit of average seed population value attribute.", - "type": "string" - }, - { - "in": "query", - "name": "minPlantingDateTime", - "description": "Minimum planting datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "maxPlantingDateTime", - "description": "Maximum planting datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", - "type": "string", - "format": "date-time" - }, - { - "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/SeasonalFieldListResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "SeasonalFields_List": { - "$ref": "./examples/SeasonalFields_List.json" - } - } - } - }, - "/farmers/{farmerId}/seasonal-fields/{seasonalFieldId}": { - "get": { - "tags": [ - "SeasonalFields" - ], - "description": "Gets a specified seasonal field resource under a particular farmer.", - "operationId": "SeasonalFields_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer.", - "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" - } - } - }, - "x-ms-examples": { - "SeasonalFields_Get": { - "$ref": "./examples/SeasonalFields_Get.json" - } - } - }, - "patch": { - "tags": [ - "SeasonalFields" - ], - "description": "Creates or Updates a seasonal field resource under a particular farmer.", - "operationId": "SeasonalFields_CreateOrUpdate", - "consumes": [ - "application/merge-patch+json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer 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.", - "schema": { - "$ref": "#/definitions/SeasonalField" - } - } - ], - "responses": { - "201": { - "description": "Success", - "schema": { - "$ref": "#/definitions/SeasonalField" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/SeasonalField" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "SeasonalFields_CreateOrUpdate": { - "$ref": "./examples/SeasonalFields_CreateOrUpdate.json" - } - } - }, - "delete": { - "tags": [ - "SeasonalFields" - ], - "description": "Deletes a specified seasonal-field resource under a particular farmer.", - "operationId": "SeasonalFields_Delete", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the farmer.", - "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": "Success" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "SeasonalFields_Delete": { - "$ref": "./examples/SeasonalFields_Delete.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" - } - } - }, - "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": "farmerId", - "description": "ID of the associated farmer.", - "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": "Success", - "schema": { - "$ref": "#/definitions/CascadeDeleteJob" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "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" - } - } - }, - "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" - } - } - }, - "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.", - "schema": { - "$ref": "#/definitions/Season" - } - } - ], - "responses": { - "201": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Season" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Season" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "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": "Success" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Seasons_Delete": { - "$ref": "./examples/Seasons_Delete.json" - } - } - } - }, - "/farmers/{farmerId}/tillage-data": { - "get": { - "tags": [ - "TillageData" - ], - "description": "Returns a paginated list of tillage data resources under a particular farm.", - "operationId": "TillageData_ListByFarmerId", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer.", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "minTillageDepth", - "description": "Minimum measured tillage depth (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxTillageDepth", - "description": "Maximum measured tillage depth (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "minTillagePressure", - "description": "Minimum pressure applied by a tillage implement (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxTillagePressure", - "description": "Maximum pressure applied by a tillage implement (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "sources", - "description": "Sources of the operation data.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "associatedBoundaryIds", - "description": "Boundary IDs associated with operation data.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "operationBoundaryIds", - "description": "Operation boundary IDs associated with operation data.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "minOperationStartDateTime", - "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "maxOperationStartDateTime", - "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "minOperationEndDateTime", - "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "maxOperationEndDateTime", - "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "minOperationModifiedDateTime", - "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "maxOperationModifiedDateTime", - "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "minArea", - "description": "Minimum area for which operation was applied (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxArea", - "description": "Maximum area for which operation was applied (inclusive).", - "type": "number", - "format": "double" - }, - { - "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/TillageDataListResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "TillageData_ListByFarmerId": { - "$ref": "./examples/TillageData_ListByFarmerId.json" - } - } - } - }, - "/tillage-data": { - "get": { - "tags": [ - "TillageData" - ], - "description": "Returns a paginated list of tillage data resources across all farmers.", - "operationId": "TillageData_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "query", - "name": "minTillageDepth", - "description": "Minimum measured tillage depth (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxTillageDepth", - "description": "Maximum measured tillage depth (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "minTillagePressure", - "description": "Minimum pressure applied by a tillage implement (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxTillagePressure", - "description": "Maximum pressure applied by a tillage implement (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "sources", - "description": "Sources of the operation data.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "associatedBoundaryIds", - "description": "Boundary IDs associated with operation data.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "operationBoundaryIds", - "description": "Operation boundary IDs associated with operation data.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "minOperationStartDateTime", - "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "maxOperationStartDateTime", - "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "minOperationEndDateTime", - "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "maxOperationEndDateTime", - "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "minOperationModifiedDateTime", - "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "maxOperationModifiedDateTime", - "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "minArea", - "description": "Minimum area for which operation was applied (inclusive).", - "type": "number", - "format": "double" - }, - { - "in": "query", - "name": "maxArea", - "description": "Maximum area for which operation was applied (inclusive).", - "type": "number", - "format": "double" - }, - { - "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/TillageDataListResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "TillageData_List": { - "$ref": "./examples/TillageData_List.json" - } - } - } - }, - "/farmers/{farmerId}/tillage-data/{tillageDataId}": { - "get": { - "tags": [ - "TillageData" - ], - "description": "Get a specified tillage data resource under a particular farmer.", - "operationId": "TillageData_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer 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" - } - } - }, - "x-ms-examples": { - "TillageData_Get": { - "$ref": "./examples/TillageData_Get.json" - } - } - }, - "patch": { - "tags": [ - "TillageData" - ], - "description": "Creates or updates an tillage data resource under a particular farmer.", - "operationId": "TillageData_CreateOrUpdate", - "consumes": [ - "application/merge-patch+json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer.", - "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.", - "schema": { - "$ref": "#/definitions/TillageData" - } - } - ], - "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/TillageData" - } - }, - "201": { - "description": "Success", - "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 farmer.", - "operationId": "TillageData_Delete", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmerId", - "description": "ID of the associated farmer 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": "Success" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "TillageData_Delete": { - "$ref": "./examples/TillageData_Delete.json" - } - } - } - }, - "/weather": { - "get": { - "tags": [ - "Weather" - ], - "description": "Returns a paginated list of weather data.", - "operationId": "Weather_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "query", - "name": "farmerId", - "description": "Farmer ID.", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "boundaryId", - "description": "Boundary ID.", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "extensionId", - "description": "ID of the weather extension.", - "required": true, - "type": "string", - "pattern": "^[A-za-z]{3,50}[.][A-za-z]{3,100}$" - }, - { - "in": "query", - "name": "weatherDataType", - "description": "Type of weather data (forecast/historical).", - "required": true, - "type": "string", - "maxLength": 50, - "minLength": 0 - }, - { - "in": "query", - "name": "granularity", - "description": "Granularity of weather data (daily/hourly).", - "required": true, - "type": "string", - "maxLength": 50, - "minLength": 0 - }, - { - "in": "query", - "name": "startDateTime", - "description": "Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.", - "type": "string", - "format": "date-time" - }, - { - "in": "query", - "name": "endDateTime", - "description": "Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.", - "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/WeatherDataListResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Weather_List": { - "$ref": "./examples/Weather_List.json" - } - } - } - }, - "/weather/ingest-data/{jobId}": { - "get": { - "tags": [ - "Weather" - ], - "description": "Get weather ingestion job.", - "operationId": "Weather_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/WeatherDataIngestionJob" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Weather_GetDataIngestionJobDetails": { - "$ref": "./examples/Weather_GetDataIngestionJobDetails.json" - } - } - }, - "put": { - "tags": [ - "Weather" - ], - "description": "Create a weather data ingestion job.", - "operationId": "Weather_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.", - "schema": { - "$ref": "#/definitions/WeatherDataIngestionJob" - } - } - ], - "responses": { - "202": { - "description": "Success", - "schema": { - "$ref": "#/definitions/WeatherDataIngestionJob" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "Weather_CreateDataIngestionJob": { - "$ref": "./examples/Weather_CreateDataIngestionJob.json" - } - } - } - }, - "/weather/delete-data/{jobId}": { - "get": { - "tags": [ - "Weather" - ], - "description": "Get weather data delete job.", - "operationId": "Weather_GetDataDeleteJobDetails", - "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/WeatherDataDeleteJob" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Weather_GetDataDeleteJobDetails": { - "$ref": "./examples/Weather_GetDataDeleteJobDetails.json" - } - } - }, - "put": { - "tags": [ - "Weather" - ], - "description": "Create a weather data delete job.", - "operationId": "Weather_CreateDataDeleteJob", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "jobId", - "description": "Job ID supplied by end 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.", - "schema": { - "$ref": "#/definitions/WeatherDataDeleteJob" - } - } - ], - "responses": { - "202": { - "description": "Success", - "schema": { - "$ref": "#/definitions/WeatherDataDeleteJob" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "Weather_CreateDataDeleteJob": { - "$ref": "./examples/Weather_CreateDataDeleteJob.json" - } - } - } - } - }, - "parameters": { - "Endpoint": { - "name": "Endpoint", - "description": "The endpoint of your FarmBeats resource (protocol and hostname, for example: https://{resourceName}.farmbeats.azure.net).", - "x-ms-parameter-location": "client", - "required": true, - "type": "string", - "in": "path", - "x-ms-skip-url-encoding": true - } - }, - "definitions": { - "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" - } - } - }, - "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" - } - } - }, - "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" - }, - "source": { - "description": "Source of the operation data.", - "maxLength": 100, - "minLength": 2, - "type": "string" - }, - "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" - }, - "operationStartDateTime": { - "format": "date-time", - "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", - "type": "string" - }, - "operationEndDateTime": { - "format": "date-time", - "description": "End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", - "type": "string" - }, - "attachmentsLink": { - "description": "Link for attachments.", - "type": "string", - "readOnly": true - }, - "associatedBoundaryId": { - "description": "Optional boundary ID of the field for which operation was applied.", - "type": "string" - }, - "operationBoundaryId": { - "description": "Optional boundary ID of the actual area for which operation was applied inside the specified field.", - "type": "string" - }, - "farmerId": { - "description": "Farmer 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 - }, - "modifiedDateTime": { - "format": "date-time", - "description": "Date-time when resource was last modified, 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" - }, - "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 and numeral values are supported.", - "type": "object", - "additionalProperties": { - "type": "object" - }, - "example": { - "key1": "value1", - "key2": 123.45 - } - } - } - }, - "ApplicationDataListResponse": { - "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", - "type": "object", - "properties": { - "value": { - "description": "List of requested objects.", - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationData" - } - }, - "$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" - } - } - }, - "InnerError": { - "description": "Inner error containing list of errors.\r\nInnerError reference document.", - "type": "object", - "properties": { - "code": { - "description": "Specific error code than was provided by the\r\ncontaining error.", - "type": "string" - }, - "innererror": { - "$ref": "#/definitions/InnerError" - } - }, - "additionalProperties": { - "type": "object" - } - }, - "Error": { - "description": "An error from the Azure AgPlatform service.", - "type": "object", - "properties": { - "code": { - "description": "Server-defined set of error codes.", - "type": "string" - }, - "message": { - "description": "Human-readable representation of the error.", - "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" - } - } - }, - "ErrorResponse": { - "description": "An error response from the Azure AgPlatform service.\r\nErrorResponse reference document..", - "type": "object", - "properties": { - "error": { - "$ref": "#/definitions/Error" - }, - "traceId": { - "description": "Unique trace ID.", - "type": "string" - } - } - }, - "Attachment": { - "description": "Schema of attachment resource.", - "type": "object", - "properties": { - "farmerId": { - "description": "Farmer id for this attachment.", - "type": "string", - "readOnly": true - }, - "resourceId": { - "description": "Associated Resource id for this attachment.", - "type": "string" - }, - "resourceType": { - "description": "Associated Resource type for this attachment\r\ni.e. Farmer, Farm, Field, SeasonalField, Boundary, FarmOperationApplicationData, HarvestData, TillageData, PlantingData.", - "type": "string" - }, - "originalFileName": { - "description": "Original File Name 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 - }, - "name": { - "description": "Name to identify resource.", - "maxLength": 100, - "minLength": 0, - "type": "string" - }, - "description": { - "description": "Textual description of resource.", - "maxLength": 500, - "minLength": 0, - "type": "string" - }, - "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.", - "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" - } - } - }, - "GeoJsonObjectType": { - "description": "GeoJSON object type.", - "enum": [ - "Point", - "Polygon", - "MultiPolygon" - ], - "type": "string", - "x-ms-enum": { - "name": "GeoJsonObjectType", - "modelAsString": true - } - }, - "GeoJsonObject": { - "description": "GeoJSON abstract class.", - "required": [ - "type" - ], - "type": "object", - "properties": { - "type": { - "$ref": "#/definitions/GeoJsonObjectType" - } - }, - "discriminator": "type" - }, - "Boundary": { - "description": "Schema of boundary resource.", - "type": "object", - "properties": { - "farmerId": { - "description": "Farmer ID.", - "type": "string", - "readOnly": true - }, - "parentId": { - "description": "ID of the parent(field or seasonalField) it belongs to.", - "type": "string" - }, - "geometry": { - "$ref": "#/definitions/GeoJsonObject" - }, - "isPrimary": { - "description": "Is the boundary primary.", - "type": "boolean" - }, - "acreage": { - "format": "double", - "description": "Boundary area in acres.", - "type": "number", - "readOnly": true - }, - "parentType": { - "description": "Type of the parent it belongs to.", - "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 - }, - "modifiedDateTime": { - "format": "date-time", - "description": "Date-time when resource was last modified, 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" - }, - "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 and numeral values are supported.", - "type": "object", - "additionalProperties": { - "type": "object" - } - } - }, - "example": { - "name": "string", - "description": "string", - "parentId": "string", - "isPrimary": false, - "geometry": { - "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 - ] - ] - ] - } - } - }, - "BoundaryListResponse": { - "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", - "type": "object", - "properties": { - "value": { - "description": "List of requested objects.", - "type": "array", - "items": { - "$ref": "#/definitions/Boundary" - } - }, - "$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" - } - } - }, - "SearchBoundaryQuery": { - "description": "SearchAllBoundaries and SearchBoundaries parameters.", - "type": "object", - "properties": { - "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\neg. \"{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" - }, - "$maxPageSize": { - "format": "int32", - "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", - "default": 50, - "maximum": 1000, - "minimum": 10, - "type": "integer" - }, - "$skipToken": { - "description": "Skip token for getting next set of results.", - "type": "string" - }, - "isPrimary": { - "description": "Is the boundary primary.", - "type": "boolean" - }, - "parentType": { - "description": "Type of the parent it belongs to.", - "type": "string" - }, - "parentIds": { - "description": "Parent Ids of the resource.", - "type": "array", - "items": { - "type": "string" - } - }, - "minAcreage": { - "format": "double", - "description": "Minimum acreage of the boundary (inclusive).", - "type": "number" - }, - "maxAcreage": { - "format": "double", - "description": "Maximum acreage of the boundary (inclusive).", - "type": "number" - }, - "intersectsWithGeometry": { - "$ref": "#/definitions/GeoJsonObject" - } - } - }, - "CascadeDeleteJob": { - "description": "Schema of cascade delete job.", - "required": [ - "farmerId", - "resourceId", - "resourceType" - ], - "type": "object", - "properties": { - "farmerId": { - "description": "Farmer ID.", - "type": "string" - }, - "resourceId": { - "description": "The id of the resource.", - "type": "string" - }, - "resourceType": { - "description": "The type of the resource.", - "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 - }, - "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" - }, - "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 and numeral values are supported.", - "type": "object", - "additionalProperties": { - "type": "object" - }, - "example": { - "key1": "value1", - "key2": 123.45 - } - } - } - }, - "BoundaryOverlapResponse": { - "description": "Schema of boundary overlap response.", - "type": "object", - "properties": { - "boundaryAcreage": { - "format": "double", - "description": "Acreage of Main boundary.", - "type": "number" - }, - "otherBoundaryAcreage": { - "format": "double", - "description": "Acreage of other boundary.", - "type": "number" - }, - "intersectingAcreage": { - "format": "double", - "description": "Acreage of intersecting boundary.", - "type": "number" - } - } - }, - "Crop": { - "description": "Schema of crop resource.", - "type": "object", - "properties": { - "phenotype": { - "description": "Crop phenotype.", - "maxLength": 100, - "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 - }, - "modifiedDateTime": { - "format": "date-time", - "description": "Date-time when resource was last modified, 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" - }, - "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 and numeral values are supported.", - "type": "object", - "additionalProperties": { - "type": "object" - }, - "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.", - "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" - } - } - }, - "CropVariety": { - "description": "Schema of crop variety resource.", - "type": "object", - "properties": { - "cropId": { - "description": "ID of the crop it belongs to.", - "type": "string", - "readOnly": true - }, - "brand": { - "description": "CropVariety Brand.", - "maxLength": 100, - "minLength": 0, - "type": "string" - }, - "product": { - "description": "CropVariety product.", - "maxLength": 100, - "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 - }, - "modifiedDateTime": { - "format": "date-time", - "description": "Date-time when resource was last modified, 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" - }, - "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 and numeral values are supported.", - "type": "object", - "additionalProperties": { - "type": "object" - }, - "example": { - "key1": "value1", - "key2": 123.45 - } - } - } - }, - "CropVarietyListResponse": { - "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", - "type": "object", - "properties": { - "value": { - "description": "List of requested objects.", - "type": "array", - "items": { - "$ref": "#/definitions/CropVariety" - } - }, - "$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" - } - } - }, - "Farmer": { - "description": "Schema of farmer 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 - }, - "modifiedDateTime": { - "format": "date-time", - "description": "Date-time when resource was last modified, 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" - }, - "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 and numeral values are supported.", - "type": "object", - "additionalProperties": { - "type": "object" - }, - "example": { - "key1": "value1", - "key2": 123.45 - } - } - } - }, - "FarmerListResponse": { - "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", - "type": "object", - "properties": { - "value": { - "description": "List of requested objects.", - "type": "array", - "items": { - "$ref": "#/definitions/Farmer" - } - }, - "$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", - "farmerId", - "startYear" - ], - "type": "object", - "properties": { - "farmerId": { - "description": "Farmer ID.", - "type": "string" - }, - "authProviderId": { - "description": "Authentication provider ID.", - "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" - }, - "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 - }, - "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" - }, - "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 and numeral values are supported.", - "type": "object", - "additionalProperties": { - "type": "object" - }, - "example": { - "key1": "value1", - "key2": 123.45 - } - } - } - }, - "Farm": { - "description": "Schema of farm resource.", - "type": "object", - "properties": { - "farmerId": { - "description": "Farmer 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 - }, - "modifiedDateTime": { - "format": "date-time", - "description": "Date-time when resource was last modified, 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" - }, - "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 and numeral values are supported.", - "type": "object", - "additionalProperties": { - "type": "object" - }, - "example": { - "key1": "value1", - "key2": 123.45 - } - } - } - }, - "FarmListResponse": { - "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", - "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" - } - } - }, - "Field": { - "description": "Schema of field resource.", - "type": "object", - "properties": { - "farmId": { - "description": "ID of the associated Farm.", - "type": "string" - }, - "farmerId": { - "description": "Farmer ID.", - "type": "string", - "readOnly": true - }, - "primaryBoundaryId": { - "description": "Primary boundary id.", - "type": "string", - "readOnly": true - }, - "boundaryIds": { - "description": "Boundary Ids.", - "uniqueItems": true, - "type": "array", - "items": { - "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 - }, - "modifiedDateTime": { - "format": "date-time", - "description": "Date-time when resource was last modified, 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" - }, - "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 and numeral values are supported.", - "type": "object", - "additionalProperties": { - "type": "object" - }, - "example": { - "key1": "value1", - "key2": 123.45 - } - } - } - }, - "FieldListResponse": { - "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", - "type": "object", - "properties": { - "value": { - "description": "List of requested objects.", - "type": "array", - "items": { - "$ref": "#/definitions/Field" - } - }, - "$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" - } - } - }, - "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" - }, - "source": { - "description": "Source of the operation data.", - "maxLength": 100, - "minLength": 2, - "type": "string" - }, - "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" - }, - "operationStartDateTime": { - "format": "date-time", - "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", - "type": "string" - }, - "operationEndDateTime": { - "format": "date-time", - "description": "End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", - "type": "string" - }, - "attachmentsLink": { - "description": "Link for attachments.", - "type": "string", - "readOnly": true - }, - "associatedBoundaryId": { - "description": "Optional boundary ID of the field for which operation was applied.", - "type": "string" - }, - "operationBoundaryId": { - "description": "Optional boundary ID of the actual area for which operation was applied inside the specified field.", - "type": "string" - }, - "farmerId": { - "description": "Farmer 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 - }, - "modifiedDateTime": { - "format": "date-time", - "description": "Date-time when resource was last modified, 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" - }, - "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 and numeral values are supported.", - "type": "object", - "additionalProperties": { - "type": "object" - }, - "example": { - "key1": "value1", - "key2": 123.45 - } - } - } - }, - "HarvestDataListResponse": { - "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", - "type": "object", - "properties": { - "value": { - "description": "List of requested objects.", - "type": "array", - "items": { - "$ref": "#/definitions/HarvestData" - } - }, - "$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" - } - } - }, - "ImageProcessingRasterizeJob": { - "description": "ImageProcessingRasterizeJob.", - "required": [ - "farmerId", - "shapefileAttachmentId", - "shapefileColumnNames" - ], - "type": "object", - "properties": { - "farmerId": { - "description": "Farmer ID.", - "type": "string" - }, - "shapefileAttachmentId": { - "description": "Shapefile attachment ID.", - "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 - }, - "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" - }, - "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 and numeral values are supported.", - "type": "object", - "additionalProperties": { - "type": "object" - }, - "example": { - "key1": "value1", - "key2": 123.45 - } - } - } - }, - "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 - }, - "modifiedDateTime": { - "format": "date-time", - "description": "Date-time when resource was last modified, 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" - }, - "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 and numeral values are supported.", - "type": "object", - "additionalProperties": { - "type": "object" - }, - "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.", - "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", - "farmerId" - ], - "type": "object", - "properties": { - "farmerId": { - "description": "Farmer ID for this OAuth config.", - "type": "string" - }, - "authProviderId": { - "description": "ID of the OAuth provider resource containing app information.", - "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 - }, - "modifiedDateTime": { - "format": "date-time", - "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", - "type": "string", - "readOnly": true - } - } - }, - "OAuthTokenListResponse": { - "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", - "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" - } - } - }, - "OAuthConnectRequest": { - "description": "Get OAuth config query parameters.", - "required": [ - "farmerId", - "oAuthProviderId", - "userRedirectLink" - ], - "type": "object", - "properties": { - "farmerId": { - "description": "ID of the farmer.", - "type": "string" - }, - "oAuthProviderId": { - "description": "ID of the OAuthProvider.", - "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" - } - } - }, - "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" - } - } - }, - "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" - }, - "source": { - "description": "Source of the operation data.", - "maxLength": 100, - "minLength": 2, - "type": "string" - }, - "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" - }, - "operationStartDateTime": { - "format": "date-time", - "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", - "type": "string" - }, - "operationEndDateTime": { - "format": "date-time", - "description": "End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", - "type": "string" - }, - "attachmentsLink": { - "description": "Link for attachments.", - "type": "string", - "readOnly": true - }, - "associatedBoundaryId": { - "description": "Optional boundary ID of the field for which operation was applied.", - "type": "string" - }, - "operationBoundaryId": { - "description": "Optional boundary ID of the actual area for which operation was applied inside the specified field.", - "type": "string" - }, - "farmerId": { - "description": "Farmer 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 - }, - "modifiedDateTime": { - "format": "date-time", - "description": "Date-time when resource was last modified, 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" - }, - "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 and numeral values are supported.", - "type": "object", - "additionalProperties": { - "type": "object" - }, - "example": { - "key1": "value1", - "key2": 123.45 - } - } - } - }, - "PlantingDataListResponse": { - "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", - "type": "object", - "properties": { - "value": { - "description": "List of requested objects.", - "type": "array", - "items": { - "$ref": "#/definitions/PlantingData" - } - }, - "$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" - } - } - }, - "ImageFormat": { - "description": "Supported image formats for scene resource.", - "enum": [ - "TIF" - ], - "type": "string", - "x-ms-enum": { - "name": "ImageFormat", - "modelAsString": true - } - }, - "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.", - "type": "string" - }, - "imageFormat": { - "$ref": "#/definitions/ImageFormat" - }, - "resolution": { - "format": "double", - "description": "Resolution of image file in meters.", - "type": "number" - } - } - }, - "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" - }, - "source": { - "description": "Data source 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" - }, - "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" - }, - "boundaryId": { - "description": "Boundary ID which belongs to the scene.", - "maxLength": 100, - "minLength": 2, - "type": "string" - }, - "farmerId": { - "description": "Farmer 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 - } - } - }, - "SceneListResponse": { - "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", - "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" - } - } - }, - "DataProvider": { - "description": "Provider of satellite data.", - "enum": [ - "Microsoft" - ], - "type": "string", - "x-ms-enum": { - "name": "DataProvider", - "modelAsString": true - } - }, - "Source": { - "description": "Source of satellite data.", - "enum": [ - "Sentinel_2_L2A" - ], - "type": "string", - "x-ms-enum": { - "name": "Source", - "modelAsString": true - } - }, - "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": [ - "boundaryId", - "endDateTime", - "farmerId", - "startDateTime" - ], - "type": "object", - "properties": { - "farmerId": { - "description": "Farmer ID.", - "type": "string" - }, - "boundaryId": { - "description": "The id of the boundary object for which satellite data is being fetched.", - "type": "string" - }, - "startDateTime": { - "format": "date-time", - "description": "Start Date.", - "type": "string" - }, - "endDateTime": { - "format": "date-time", - "description": "End Date.", - "type": "string" - }, - "provider": { - "$ref": "#/definitions/DataProvider" - }, - "source": { - "$ref": "#/definitions/Source" - }, - "data": { - "$ref": "#/definitions/SatelliteData" - }, - "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 - }, - "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" - }, - "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 and numeral values are supported.", - "type": "object", - "additionalProperties": { - "type": "object" - }, - "example": { - "key1": "value1", - "key2": 123.45 - } - } - } - }, - "SeasonalField": { - "description": "Schema of seasonal field resource.", - "type": "object", - "properties": { - "farmerId": { - "description": "Farmer ID.", - "type": "string", - "readOnly": true - }, - "primaryBoundaryId": { - "description": "Primary boundary id.", - "type": "string", - "readOnly": true - }, - "boundaryIds": { - "description": "Boundary Ids.", - "uniqueItems": true, - "type": "array", - "items": { - "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" - }, - "cropVarietyIds": { - "description": "CropVariety ids.", - "uniqueItems": true, - "type": "array", - "items": { - "type": "string" - } - }, - "cropId": { - "description": "ID of the crop it belongs to.", - "type": "string" - }, - "avgYieldValue": { - "format": "double", - "description": "Average yield value of the seasonal field.", - "type": "number" - }, - "avgYieldUnit": { - "description": "Unit of the average yield value attribute.", - "maxLength": 32, - "minLength": 2, - "type": "string" - }, - "avgSeedPopulationValue": { - "format": "double", - "description": "Average seed population value of the seasonal field.", - "type": "number" - }, - "avgSeedPopulationUnit": { - "description": "Unit of average seed population value attribute.", - "maxLength": 32, - "minLength": 2, - "type": "string" - }, - "plantingDateTime": { - "format": "date-time", - "description": "Planting datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", - "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 - }, - "modifiedDateTime": { - "format": "date-time", - "description": "Date-time when resource was last modified, 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" - }, - "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 and numeral values are supported.", - "type": "object", - "additionalProperties": { - "type": "object" - }, - "example": { - "key1": "value1", - "key2": 123.45 - } - } - } - }, - "SeasonalFieldListResponse": { - "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", - "type": "object", - "properties": { - "value": { - "description": "List of requested objects.", - "type": "array", - "items": { - "$ref": "#/definitions/SeasonalField" - } - }, - "$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" - } - } - }, - "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" - }, - "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 - }, - "modifiedDateTime": { - "format": "date-time", - "description": "Date-time when resource was last modified, 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" - }, - "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 and numeral values are supported.", - "type": "object", - "additionalProperties": { - "type": "object" - }, - "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.", - "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" - } - } - }, - "TillageData": { - "description": "Schema of tillage data resource.", - "type": "object", - "properties": { - "tillageDepth": { - "$ref": "#/definitions/Measure" - }, - "tillagePressure": { - "$ref": "#/definitions/Measure" - }, - "area": { - "$ref": "#/definitions/Measure" - }, - "source": { - "description": "Source of the operation data.", - "maxLength": 100, - "minLength": 2, - "type": "string" - }, - "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" - }, - "operationStartDateTime": { - "format": "date-time", - "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", - "type": "string" - }, - "operationEndDateTime": { - "format": "date-time", - "description": "End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", - "type": "string" - }, - "attachmentsLink": { - "description": "Link for attachments.", - "type": "string", - "readOnly": true - }, - "associatedBoundaryId": { - "description": "Optional boundary ID of the field for which operation was applied.", - "type": "string" - }, - "operationBoundaryId": { - "description": "Optional boundary ID of the actual area for which operation was applied inside the specified field.", - "type": "string" - }, - "farmerId": { - "description": "Farmer 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 - }, - "modifiedDateTime": { - "format": "date-time", - "description": "Date-time when resource was last modified, 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" - }, - "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 and numeral values are supported.", - "type": "object", - "additionalProperties": { - "type": "object" - }, - "example": { - "key1": "value1", - "key2": 123.45 - } - } - } - }, - "TillageDataListResponse": { - "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", - "type": "object", - "properties": { - "value": { - "description": "List of requested objects.", - "type": "array", - "items": { - "$ref": "#/definitions/TillageData" - } - }, - "$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" - } - } - }, - "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" - } - } - }, - "WeatherData": { - "description": "Schema of weather data.", - "required": [ - "boundaryId", - "dateTime", - "extensionId", - "extensionVersion", - "farmerId", - "granularity", - "location", - "weatherDataType" - ], - "type": "object", - "properties": { - "farmerId": { - "description": "Farmer ID.", - "type": "string" - }, - "boundaryId": { - "description": "Boundary ID.", - "type": "string" - }, - "extensionId": { - "description": "ID of the weather extension.", - "type": "string" - }, - "location": { - "$ref": "#/definitions/Location" - }, - "dateTime": { - "format": "date-time", - "description": "Date-time of the weather data, sample format: yyyy-MM-ddTHH:mm:ssZ.", - "type": "string" - }, - "unitSystemCode": { - "description": "Unit System like US/SI etc.", - "type": "string" - }, - "extensionVersion": { - "description": "Version of the weather data extension.", - "type": "string" - }, - "weatherDataType": { - "description": "Type of weather data (forecast/historical).", - "type": "string" - }, - "granularity": { - "description": "Granularity of weather data (daily/hourly).", - "type": "string" - }, - "cloudCover": { - "$ref": "#/definitions/Measure" - }, - "dewPoint": { - "$ref": "#/definitions/Measure" - }, - "growingDegreeDay": { - "$ref": "#/definitions/Measure" - }, - "precipitation": { - "$ref": "#/definitions/Measure" - }, - "pressure": { - "$ref": "#/definitions/Measure" - }, - "relativeHumidity": { - "$ref": "#/definitions/Measure" - }, - "soilMoisture": { - "$ref": "#/definitions/Measure" - }, - "soilTemperature": { - "$ref": "#/definitions/Measure" - }, - "temperature": { - "$ref": "#/definitions/Measure" - }, - "visibility": { - "$ref": "#/definitions/Measure" - }, - "wetBulbTemperature": { - "$ref": "#/definitions/Measure" - }, - "windChill": { - "$ref": "#/definitions/Measure" - }, - "windDirection": { - "$ref": "#/definitions/Measure" - }, - "windGust": { - "$ref": "#/definitions/Measure" - }, - "windSpeed": { - "$ref": "#/definitions/Measure" - }, - "id": { - "description": "Weather data ID.", - "type": "string" - }, - "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 - }, - "modifiedDateTime": { - "format": "date-time", - "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", - "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 and numeral values are supported.", - "type": "object", - "additionalProperties": { - "type": "object" - }, - "example": { - "key1": "value1", - "key2": 123.45 - } - } - } - }, - "WeatherDataListResponse": { - "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", - "type": "object", - "properties": { - "value": { - "description": "List of requested objects.", - "type": "array", - "items": { - "$ref": "#/definitions/WeatherData" - } - }, - "$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" - } - } - }, - "WeatherDataIngestionJob": { - "description": "Schema of weather ingestion job.", - "required": [ - "boundaryId", - "extensionApiInput", - "extensionApiName", - "extensionId", - "farmerId" - ], - "type": "object", - "properties": { - "boundaryId": { - "description": "The id of the boundary object for which weather data is being fetched.", - "type": "string" - }, - "farmerId": { - "description": "The id of the farmer object for which weather data is being fetched.", - "type": "string" - }, - "extensionId": { - "description": "ID of the extension to be used for the providerInput. eg. DTN.ClearAg.", - "maxLength": 100, - "minLength": 2, - "pattern": "^[A-za-z]{3,50}[.][A-za-z]{3,100}$", - "type": "string" - }, - "extensionApiName": { - "description": "Extension api name to which request is to be made.", - "maxLength": 100, - "minLength": 2, - "type": "string" - }, - "extensionApiInput": { - "description": "Extension api input dictionary which would be used to feed request query/body/parameter information.", - "type": "object", - "additionalProperties": { - "type": "object" - } - }, - "extensionDataProviderAppId": { - "description": "App id of the weather data provider.", - "maxLength": 200, - "minLength": 2, - "type": "string" - }, - "extensionDataProviderApiKey": { - "description": "Api key of the weather data provider.", - "maxLength": 200, - "minLength": 2, - "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 - }, - "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" - }, - "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 and numeral values are supported.", - "type": "object", - "additionalProperties": { - "type": "object" - }, - "example": { - "key1": "value1", - "key2": 123.45 - } - } - } - }, - "WeatherDataDeleteJob": { - "description": "Schema of weather data delete job.", - "required": [ - "boundaryId", - "extensionId", - "farmerId" - ], - "type": "object", - "properties": { - "extensionId": { - "description": "ID of the extension to be used for the providerInput. eg. DTN.ClearAg.", - "maxLength": 100, - "minLength": 2, - "pattern": "^[A-za-z]{3,50}[.][A-za-z]{3,100}$", - "type": "string" - }, - "farmerId": { - "description": "The id of the farmer object for which weather data is being fetched.", - "type": "string" - }, - "boundaryId": { - "description": "The id of the boundary object for which weather data is being fetched.", - "type": "string" - }, - "weatherDataType": { - "description": "Type of weather data. Possible values include: 'forecast' , 'historical'.", - "type": "string" - }, - "granularity": { - "description": "Granularity of weather data. Possible values include: 'daily' , 'hourly'.", - "type": "string" - }, - "startDateTime": { - "format": "date-time", - "description": "Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.", - "type": "string" - }, - "endDateTime": { - "format": "date-time", - "description": "Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.", - "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 - }, - "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" - }, - "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 and numeral values are supported.", - "type": "object", - "additionalProperties": { - "type": "object" - }, - "example": { - "key1": "value1", - "key2": 123.45 - } - } - } - }, - "MultiPolygon": { - "description": "MultiPolygon geometry.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/GeoJsonObject" - }, - { - "$ref": "#/definitions/MultiPolygonCoordinates" - } - ], - "x-ms-discriminator-value": "MultiPolygon" - }, - "MultiPolygonCoordinates": { - "description": "Schema of multi polygon coordinates.", - "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.", - "minLength": 1, - "type": "array", - "items": { - "type": "array", - "items": { - "type": "array", - "items": { - "type": "array", - "items": { - "format": "double", - "type": "number" - } - } - } - } - } - } - }, - "Point": { - "description": "Point geometry.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/GeoJsonObject" - }, - { - "$ref": "#/definitions/PointCoordinates" - } - ], - "x-ms-discriminator-value": "Point" - }, - "PointCoordinates": { - "description": "Schema of the coordinates of a point.", - "type": "object", - "required": [ - "coordinates" - ], - "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" - } - } - } - }, - "Polygon": { - "description": "Polygon geometry.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/GeoJsonObject" - }, - { - "$ref": "#/definitions/PolygonCoordinates" - } - ], - "x-ms-discriminator-value": "Polygon" - }, - "PolygonCoordinates": { - "description": "Schema of polygon coordinates.", - "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.", - "minLength": 1, - "type": "array", - "items": { - "type": "array", - "items": { - "type": "array", - "items": { - "format": "double", - "type": "number" - } - } - } - } - } - } - }, - "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/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_CreateOrUpdate.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_CreateOrUpdate.json deleted file mode 100644 index 57545922eeb1..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_CreateOrUpdate.json +++ /dev/null @@ -1,149 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "farmerId": "FARMER123", - "applicationDataId": "APPLICATION123", - "api-version": "2021-03-31-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", - "operationBoundaryId": "APPLICATIONOPBOUNDARY1", - "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", - "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": { - "farmerId": "FARMER123", - "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", - "operationBoundaryId": "APPLICATIONOPBOUNDARY1", - "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", - "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 - }, - "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{applicationDataId}}&resourceTypes=ApplicationData", - "createdDateTime": "2021-02-29T04:57:04Z", - "modifiedDateTime": "2021-03-08T18:22:07Z", - "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" - } - }, - "201": { - "body": { - "farmerId": "FARMER123", - "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", - "operationBoundaryId": "APPLICATIONOPBOUNDARY1", - "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", - "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 - }, - "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{applicationDataId}}&resourceTypes=ApplicationData", - "createdDateTime": "2021-02-29T04:57:04Z", - "modifiedDateTime": "2021-03-08T18:22:07Z", - "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" - } - } - } -} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_Delete.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_Delete.json deleted file mode 100644 index 20dc9e559382..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_Delete.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "farmerId": "FARMER123", - "applicationDataId": "APPLICATION123", - "api-version": "2021-03-31-preview" - }, - "responses": { - "204": {} - } -} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_Get.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_Get.json deleted file mode 100644 index b9daa7a1fd1f..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_Get.json +++ /dev/null @@ -1,59 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "farmerId": "FARMER123", - "applicationDataId": "APPLICATION123", - "api-version": "2021-03-31-preview" - }, - "responses": { - "200": { - "body": { - "farmerId": "FARMER123", - "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", - "operationBoundaryId": "APPLICATIONOPBOUNDARY1", - "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", - "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 - }, - "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{applicationDataId}}&resourceTypes=ApplicationData", - "createdDateTime": "2021-02-29T04:57:04Z", - "modifiedDateTime": "2021-03-08T18:22:07Z", - "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" - } - } - } -} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_List.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_List.json deleted file mode 100644 index 5f76b4ef2d0d..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_List.json +++ /dev/null @@ -1,63 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "api-version": "2021-03-31-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "farmerId": "FARMER123", - "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", - "operationBoundaryId": "APPLICATIONOPBOUNDARY1", - "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", - "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 - }, - "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{applicationDataId}}&resourceTypes=ApplicationData", - "createdDateTime": "2021-02-29T04:57:04Z", - "modifiedDateTime": "2021-03-08T18:22:07Z", - "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" - } - ], - "$skipToken": "string", - "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/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/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_ListByFarmerId.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_ListByFarmerId.json deleted file mode 100644 index 5b0d758e3ae4..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_ListByFarmerId.json +++ /dev/null @@ -1,64 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "farmerId": "FARMER123", - "api-version": "2021-03-31-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "farmerId": "FARMER123", - "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", - "operationBoundaryId": "APPLICATIONOPBOUNDARY1", - "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", - "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 - }, - "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{applicationDataId}}&resourceTypes=ApplicationData", - "createdDateTime": "2021-02-29T04:57:04Z", - "modifiedDateTime": "2021-03-08T18:22:07Z", - "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" - } - ], - "$skipToken": "string", - "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/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/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_CreateCascadeDeleteJob.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_CreateCascadeDeleteJob.json deleted file mode 100644 index 09ce3d8c2053..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_CreateCascadeDeleteJob.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "farmerId": "FARMER123", - "boundaryId": "BOUNDARY123", - "api-version": "2021-03-31-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", - "farmerId": "FARMER123", - "resourceId": "BOUNDARY123", - "resourceType": "boundary", - "name": "John Smith's Boundary", - "description": "Some description", - "properties": { - "Irrigated": "Yes", - "RetailerId": "Retailer123" - } - } - } - } -} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/FarmOperations_CreateDataIngestionJob.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/FarmOperations_CreateDataIngestionJob.json deleted file mode 100644 index 163cbf16f9e4..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/FarmOperations_CreateDataIngestionJob.json +++ /dev/null @@ -1,45 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "jobId": "JOB123", - "api-version": "2021-03-31-preview", - "body": { - "farmerId": "TEST-FARMER", - "authProviderId": "JOHNDEERE", - "operations": [ - "AllOperations" - ], - "startYear": 2012, - "name": "Farm Operations Job", - "description": "For TEST-FARMER", - "properties": { - "Operation": "All" - } - } - }, - "responses": { - "202": { - "body": { - "operations": [ - "AllOperations" - ], - "startYear": 2012, - "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-FARMER", - "properties": { - "Operation": "All" - }, - "farmerId": "TEST-FARMER", - "authProviderId": "JOHNDEERE" - } - } - } -} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/FarmOperations_GetDataIngestionJobDetails.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/FarmOperations_GetDataIngestionJobDetails.json deleted file mode 100644 index 19947892604d..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/FarmOperations_GetDataIngestionJobDetails.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "jobId": "JOB123", - "api-version": "2021-03-31-preview" - }, - "responses": { - "200": { - "body": { - "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" - }, - "farmerId": "FARMER123", - "authProviderId": "JOHNDEERE", - "operations": [ - "AllOperations" - ], - "startYear": 2012 - } - } - } -} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_CreateCascadeDeleteJob.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_CreateCascadeDeleteJob.json deleted file mode 100644 index a7d2c1e25a5b..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_CreateCascadeDeleteJob.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "farmerId": "FARMER123", - "api-version": "2021-03-31-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", - "farmerId": "FARMER123", - "resourceId": "FARMER123", - "resourceType": "farmer", - "name": "John Smith", - "description": "Some description", - "properties": { - "Irrigated": "Yes", - "RetailerId": "Retailer123" - } - } - } - } -} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_CreateCascadeDeleteJob.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_CreateCascadeDeleteJob.json deleted file mode 100644 index 4a26aca784c9..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_CreateCascadeDeleteJob.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "farmerId": "FARMER123", - "farmId": "FARM123", - "api-version": "2021-03-31-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", - "farmerId": "FARMER123", - "resourceId": "FARM123", - "resourceType": "farm", - "name": "John Smith's Field", - "description": "Some description", - "properties": { - "Irrigated": "Yes", - "RetailerId": "Retailer123" - } - } - } - } -} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_CreateCascadeDeleteJob.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_CreateCascadeDeleteJob.json deleted file mode 100644 index 3db893452b2a..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_CreateCascadeDeleteJob.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "farmerId": "FARMER123", - "fieldId": "FIELD123", - "api-version": "2021-03-31-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", - "farmerId": "FARMER123", - "resourceId": "FIELD123", - "resourceType": "field", - "name": "John Smith's Field", - "description": "Some description", - "properties": { - "Irrigated": "Yes", - "RetailerId": "Retailer123" - } - } - } - } -} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_CreateOrUpdate.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_CreateOrUpdate.json deleted file mode 100644 index 1b81b715ffee..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_CreateOrUpdate.json +++ /dev/null @@ -1,242 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "api-version": "2021-03-31-preview", - "farmerId": "FARMER123", - "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", - "operationBoundaryId": "HARVESTOPBOUNDARY1", - "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", - "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": { - "farmerId": "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:12:12Z", - "operationBoundaryId": "HARVESTOPBOUNDARY1", - "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", - "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 - }, - "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{harvestDataId}}&resourceTypes=HarvestData", - "createdDateTime": "2021-02-29T04:57:04Z", - "modifiedDateTime": "2021-03-08T18:22:07Z", - "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" - } - }, - "201": { - "body": { - "farmerId": "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:12:12Z", - "operationBoundaryId": "HARVESTOPBOUNDARY1", - "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", - "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 - }, - "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{harvestDataId}}&resourceTypes=HarvestData", - "createdDateTime": "2021-02-29T04:57:04Z", - "modifiedDateTime": "2021-03-08T18:22:07Z", - "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" - } - } - } -} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_Delete.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_Delete.json deleted file mode 100644 index 88c5785f4045..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_Delete.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "api-version": "2021-03-31-preview", - "farmerId": "FARMER123", - "harvestDataId": "HARVESTOP123" - }, - "responses": { - "204": {} - } -} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_Get.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_Get.json deleted file mode 100644 index caae9cb85c56..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_Get.json +++ /dev/null @@ -1,90 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "api-version": "2021-03-31-preview", - "farmerId": "FARMER123", - "harvestDataId": "HARVESTOP123" - }, - "responses": { - "200": { - "body": { - "farmerId": "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:12:12Z", - "operationBoundaryId": "HARVESTOPBOUNDARY1", - "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", - "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 - }, - "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{harvestDataId}}&resourceTypes=HarvestData", - "createdDateTime": "2021-02-29T04:57:04Z", - "modifiedDateTime": "2021-03-08T18:22:07Z", - "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" - } - } - } -} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_List.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_List.json deleted file mode 100644 index 7eecebcce739..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_List.json +++ /dev/null @@ -1,94 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "api-version": "2021-03-31-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "farmerId": "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", - "operationBoundaryId": "HARVESTOPBOUNDARY1", - "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", - "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 - }, - "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{harvestDataId}}&resourceTypes=HarvestData", - "createdDateTime": "2021-02-29T04:57:04Z", - "modifiedDateTime": "2021-03-08T18:22:07Z", - "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" - } - ], - "$skipToken": "string", - "nextLink": "https:/{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/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/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_ListByFarmerId.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_ListByFarmerId.json deleted file mode 100644 index fdab67c54d14..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_ListByFarmerId.json +++ /dev/null @@ -1,95 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "api-version": "2021-03-31-preview", - "farmerId": "FARMER123" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "farmerId": "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:12:12Z", - "operationBoundaryId": "HARVESTOPBOUNDARY1", - "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", - "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 - }, - "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{harvestDataId}}&resourceTypes=HarvestData", - "createdDateTime": "2021-02-29T04:57:04Z", - "modifiedDateTime": "2021-03-08T18:22:07Z", - "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" - } - ], - "$skipToken": "string", - "nextLink": "https:/{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/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/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ImageProcessing_CreateRasterizeJob.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ImageProcessing_CreateRasterizeJob.json deleted file mode 100644 index b3dc595eb9bd..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ImageProcessing_CreateRasterizeJob.json +++ /dev/null @@ -1,45 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "jobId": "JOB123", - "api-version": "2021-03-31-preview", - "body": { - "farmerId": "test_farmer", - "shapefileAttachmentId": "harvesting_data_shapefile123", - "shapefileColumnNames": [ - "Wet_yield", - "Dry_yield" - ], - "name": "Harvest_Data_Rasterize_Job", - "description": "Rasterize harvest data shape file", - "properties": { - "region": "Asia" - } - } - }, - "responses": { - "202": { - "body": { - "durationInSeconds": 12.4, - "id": "weather-job", - "status": "Waiting", - "message": "Created job to fetch weather data for job name 'TestWeatherJob', farmer id 'test_farmer' and field id 'test_field'.", - "createdDateTime": "2021-04-16T11:33:45Z", - "lastActionDateTime": "2021-04-16T11:33:45Z", - "startTime": "2021-04-16T11:33:45Z", - "endTime": "2021-04-16T11:33:45Z", - "farmerId": "test_farmer", - "shapefileAttachmentId": "harvesting_data_shapefile123", - "shapefileColumnNames": [ - "Wet_yield", - "Dry_yield" - ], - "name": "Harvest_Data_Rasterize_Job", - "description": "Rasterize harvest data shape file", - "properties": { - "region": "Asia" - } - } - } - } -} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ImageProcessing_GetRasterizeJob.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ImageProcessing_GetRasterizeJob.json deleted file mode 100644 index 62face2583c2..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ImageProcessing_GetRasterizeJob.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "jobId": "JOB123", - "api-version": "2021-03-31-preview" - }, - "responses": { - "200": { - "body": { - "durationInSeconds": 12.4, - "id": "weather-job", - "status": "Succeeded", - "message": "Weather data is available for startTime to endTime", - "createdDateTime": "2021-04-16T08:24:50Z", - "lastActionDateTime": "2021-04-16T08:24:50Z", - "startTime": "2021-04-16T08:24:50Z", - "endTime": "2021-04-16T08:24:50Z", - "farmerId": "test_farmer", - "shapefileAttachmentId": "harvesting_data_shapefile123", - "shapefileColumnNames": [ - "Wet_yield", - "Dry_yield" - ], - "name": "Harvest_Data_Rasterize_Job", - "description": "Rasterize harvest data shape file", - "properties": { - "region": "Asia" - } - } - } - } -} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_CreateOrUpdate.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_CreateOrUpdate.json deleted file mode 100644 index 80139cdbf05e..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_CreateOrUpdate.json +++ /dev/null @@ -1,54 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "oauthProviderId": "JOHNDEERE", - "api-version": "2021-03-31-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/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_Get.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_Get.json deleted file mode 100644 index 994c7a7013be..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_Get.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "oauthProviderId": "JOHNDEERE", - "api-version": "2021-03-31-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": { - "Farmer": "123" - } - } - } - } -} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_List.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_List.json deleted file mode 100644 index 3777236bf4b3..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_List.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "api-version": "2021-03-31-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": { - "Farmer": "123" - } - } - ], - "$skipToken": "string", - "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/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/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_CreateCascadeDeleteJob.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_CreateCascadeDeleteJob.json deleted file mode 100644 index 65800d1eba15..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_CreateCascadeDeleteJob.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "jobId": "JOBID123", - "farmerId": "FARMER123", - "oauthProviderId": "JOHNDEERE", - "api-version": "2021-03-31-preview" - }, - "responses": { - "202": { - "body": { - "farmerId": "FARMER123", - "resourceId": "JOHNDEERE", - "resourceType": "oauthtokeninfo", - "id": "JOBID123", - "status": "Waiting", - "message": "Created cascade delete job for 'oauthtokeninfo' resource with id 'JOHNDEERE' and farmerId 'FARMER123'.", - "createdDateTime": "2021-05-13T20:04:39Z", - "lastActionDateTime": "2021-05-13T20:04:39Z", - "startTime": "2021-05-13T20:04:37Z" - } - } - } -} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_List.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_List.json deleted file mode 100644 index 7ccb4143441b..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_List.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "api-version": "2021-03-31-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "farmerId": "FARMER123", - "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/farmers/{{farmerId}}/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/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_CreateOrUpdate.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_CreateOrUpdate.json deleted file mode 100644 index 3c9dad916c1e..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_CreateOrUpdate.json +++ /dev/null @@ -1,170 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "api-version": "2021-03-31-preview", - "farmerId": "FARMER123", - "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", - "operationBoundaryId": "PLANTINGOPBOUNDARY1", - "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", - "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": { - "farmerId": "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", - "operationBoundaryId": "PLANTINGOPBOUNDARY1", - "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", - "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 - }, - "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantingDataId}}&resourceTypes=PlantingData", - "createdDateTime": "2021-02-29T04:57:04Z", - "modifiedDateTime": "2021-03-08T18:22:07Z", - "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" - } - }, - "201": { - "body": { - "farmerId": "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", - "operationBoundaryId": "PLANTINGOPBOUNDARY1", - "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", - "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 - }, - "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantingDataId}}&resourceTypes=PlantingData", - "createdDateTime": "2021-02-29T04:57:04Z", - "modifiedDateTime": "2021-03-08T18:22:07Z", - "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" - } - } - } -} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_Delete.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_Delete.json deleted file mode 100644 index 8b17313f1110..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_Delete.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "api-version": "2021-03-31-preview", - "farmerId": "FARMER123", - "plantingDataId": "PLANTINGOP123" - }, - "responses": { - "204": {} - } -} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_Get.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_Get.json deleted file mode 100644 index 155712c370fd..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_Get.json +++ /dev/null @@ -1,66 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "api-version": "2021-03-31-preview", - "farmerId": "FARMER123", - "plantingDataId": "PLANTINGOP123" - }, - "responses": { - "200": { - "body": { - "farmerId": "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", - "operationBoundaryId": "PLANTINGOPBOUNDARY1", - "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", - "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 - }, - "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantingDataId}}&resourceTypes=PlantingData", - "createdDateTime": "2021-02-29T04:57:04Z", - "modifiedDateTime": "2021-03-08T18:22:07Z", - "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" - } - } - } -} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_List.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_List.json deleted file mode 100644 index b6c59eaee01a..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_List.json +++ /dev/null @@ -1,70 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "api-version": "2021-03-31-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "farmerId": "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", - "operationBoundaryId": "PLANTINGOPBOUNDARY1", - "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", - "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 - }, - "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantingDataId}}&resourceTypes=PlantingData", - "createdDateTime": "2021-02-29T04:57:04Z", - "modifiedDateTime": "2021-03-08T18:22:07Z", - "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" - } - ], - "$skipToken": "string", - "nextLink": "https:/{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/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/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_ListByFarmerId.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_ListByFarmerId.json deleted file mode 100644 index 7bb636bba095..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_ListByFarmerId.json +++ /dev/null @@ -1,71 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "api-version": "2021-03-31-preview", - "farmerId": "FARMER123" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "farmerId": "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", - "operationBoundaryId": "PLANTINGOPBOUNDARY1", - "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", - "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 - }, - "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantingDataId}}&resourceTypes=PlantingData", - "createdDateTime": "2021-02-29T04:57:04Z", - "modifiedDateTime": "2021-03-08T18:22:07Z", - "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" - } - ], - "$skipToken": "string", - "nextLink": "https:/{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/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/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_CreateSatelliteDataIngestionJob.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_CreateSatelliteDataIngestionJob.json deleted file mode 100644 index 3e97b7391d97..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_CreateSatelliteDataIngestionJob.json +++ /dev/null @@ -1,52 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "jobId": "JOB123", - "api-version": "2021-03-31-preview", - "body": { - "boundaryId": "BOUNDARY123", - "farmerId": "FARMER123", - "startDateTime": "2020-04-16T10:14:12Z", - "endDateTime": "2021-04-16T10:14:12Z", - "provider": "Microsoft", - "source": "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", - "farmerId": "FARMER123", - "boundaryId": "BOUNDARY123", - "name": "North Farm 2019 satellite imagery", - "description": "Test job", - "properties": { - "Region": "Asia" - } - } - } - } -} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_Download.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_Download.json deleted file mode 100644 index 0fe996302727..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_Download.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "filePath": "https://filePath", - "api-version": "2021-03-31-preview" - }, - "responses": { - "200": { - "body": "101010101" - } - } -} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_GetSatelliteDataIngestionJobDetails.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_GetSatelliteDataIngestionJobDetails.json deleted file mode 100644 index 07ac177ebd7d..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_GetSatelliteDataIngestionJobDetails.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "jobId": "JOB123", - "api-version": "2021-03-31-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" - }, - "boundaryId": "BOUNDARY123", - "farmerId": "FARMER123", - "startDateTime": "2020-04-16T10:14:12Z", - "endDateTime": "2021-04-16T10:14:12Z", - "provider": "Microsoft", - "source": "Sentinel_2_L2A", - "data": { - "imageFormats": [ - "Tif" - ], - "imageNames": [ - "NDVI" - ], - "imageResolutions": [ - 10.0 - ] - } - } - } - } -} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_List.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_List.json deleted file mode 100644 index cd555fe0682f..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_List.json +++ /dev/null @@ -1,142 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "provider": "Microsoft", - "farmerId": "FARMER123", - "boundaryId": "BOUNDARY123", - "api-version": "2021-03-31-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "400e200f-ccc4-0cea-c120-3fdc6a41f99f", - "sceneDateTime": "2019-01-27T00:00:00Z", - "boundaryId": "BOUNDARY123", - "farmerId": "FARMER123", - "provider": "Microsoft", - "source": "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=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/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=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/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=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/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=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/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=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/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=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/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=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/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=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/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=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/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=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/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=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/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=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/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=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/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=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/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=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/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=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/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=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/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=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/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=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/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=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/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=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/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=2020-12-31-preview& filePath=microsoft/sentinel_2_l2a/FARMER123/BOUNDARY123/2019-01-27/00-00-00/b12_10.tif" - } - ] - } - ], - "$skipToken": "string", - "nextLink": "https://{{resourceName}}.farmbeats.azure.net/scenes?provider=Microsoft&farmerId=FARMER123&boundaryId=BOUNDARY123&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/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_CreateOrUpdate.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_CreateOrUpdate.json deleted file mode 100644 index 4dfc09b2a20b..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_CreateOrUpdate.json +++ /dev/null @@ -1,107 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "api-version": "2021-03-31-preview", - "farmerId": "FARMER123", - "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", - "operationBoundaryId": "PLANTINGOPBOUNDARY1", - "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", - "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": { - "farmerId": "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:12:12Z", - "operationBoundaryId": "PLANTINGOPBOUNDARY1", - "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", - "area": { - "unit": "acre", - "value": 30 - }, - "tillagePressure": { - "unit": "kg per sq cms", - "value": 950 - }, - "tillageDepth": { - "unit": "cms", - "value": 9.5 - }, - "properties": { - "Region": "Europe", - "CountyCode": 123 - }, - "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantingDataId}}&resourceTypes=PlantingData", - "createdDateTime": "2021-02-29T04:57:04Z", - "modifiedDateTime": "2021-03-08T18:22:07Z", - "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" - } - }, - "201": { - "body": { - "farmerId": "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:12:12Z", - "operationBoundaryId": "PLANTINGOPBOUNDARY1", - "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", - "area": { - "unit": "acre", - "value": 30 - }, - "tillagePressure": { - "unit": "kg per sq cms", - "value": 950 - }, - "tillageDepth": { - "unit": "cms", - "value": 9.5 - }, - "properties": { - "Region": "Europe", - "CountyCode": 123 - }, - "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantingDataId}}&resourceTypes=PlantingData", - "createdDateTime": "2021-02-29T04:57:04Z", - "modifiedDateTime": "2021-03-08T18:22:07Z", - "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" - } - } - } -} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_Delete.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_Delete.json deleted file mode 100644 index 8ab38e14e5fb..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_Delete.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "api-version": "2021-03-31-preview", - "farmerId": "FARMER123", - "tillageDataId": "TILLAGEOP123" - }, - "responses": { - "204": {} - } -} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_Get.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_Get.json deleted file mode 100644 index a9499ed7990f..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_Get.json +++ /dev/null @@ -1,45 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "api-version": "2021-03-31-preview", - "farmerId": "FARMER123", - "tillageDataId": "TILLAGEOP123" - }, - "responses": { - "200": { - "body": { - "farmerId": "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", - "operationBoundaryId": "PLANTINGOPBOUNDARY1", - "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", - "area": { - "unit": "acre", - "value": 30 - }, - "tillagePressure": { - "unit": "kg per sq cms", - "value": 950 - }, - "tillageDepth": { - "unit": "cms", - "value": 9.5 - }, - "properties": { - "Region": "Asia", - "CountyCode": 123 - }, - "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantingDataId}}&resourceTypes=PlantingData", - "createdDateTime": "2021-02-29T04:57:04Z", - "modifiedDateTime": "2021-03-08T18:22:07Z", - "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" - } - } - } -} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_List.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_List.json deleted file mode 100644 index 52e57fe5de5e..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_List.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "api-version": "2021-03-31-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "farmerId": "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", - "operationBoundaryId": "PLANTINGOPBOUNDARY1", - "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", - "area": { - "unit": "acre", - "value": 30 - }, - "tillagePressure": { - "unit": "kg per sq cms", - "value": 950 - }, - "tillageDepth": { - "unit": "cms", - "value": 9.5 - }, - "properties": { - "Region": "Europe", - "CountyCode": 123 - }, - "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantingDataId}}&resourceTypes=PlantingData", - "createdDateTime": "2021-02-29T04:57:04Z", - "modifiedDateTime": "2021-03-08T18:22:07Z", - "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" - } - ], - "$skipToken": "string", - "nextLink": "https:/{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/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/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_ListByFarmerId.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_ListByFarmerId.json deleted file mode 100644 index 240a3548c76b..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_ListByFarmerId.json +++ /dev/null @@ -1,50 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "api-version": "2021-03-31-preview", - "farmerId": "FARMER123" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "farmerId": "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", - "operationBoundaryId": "PLANTINGOPBOUNDARY1", - "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY", - "area": { - "unit": "acre", - "value": 30 - }, - "tillagePressure": { - "unit": "kg per sq cms", - "value": 950 - }, - "tillageDepth": { - "unit": "cms", - "value": 9.5 - }, - "properties": { - "Region": "Europe", - "CountyCode": 123 - }, - "attachmentsLink": "https://.farmbeats.azure.net/farmer/{{farmerId}}/attachments?api-version={{apiVersion}}&resourceIds={{plantingDataId}}&resourceTypes=PlantingData", - "createdDateTime": "2021-02-29T04:57:04Z", - "modifiedDateTime": "2021-03-08T18:22:07Z", - "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" - } - ], - "$skipToken": "string", - "nextLink": "https:/{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/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/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_CreateDataDeleteJob.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_CreateDataDeleteJob.json deleted file mode 100644 index 98a2a1267033..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_CreateDataDeleteJob.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "jobId": "JOB123", - "api-version": "2021-03-31-preview", - "body": { - "extensionId": "dtn.clearAg", - "farmerId": "test_farmer", - "boundaryId": "test_farmer", - "weatherDataType": "forecast", - "granularity": "daily", - "startDateTime": "2021-04-18T01:32:42Z", - "endDateTime": "2021-04-18T01:32:42Z", - "name": "Delete Job", - "description": "For extension dtn.clearAg", - "properties": { - "region": "US" - } - } - }, - "responses": { - "202": { - "body": { - "durationInSeconds": 12.4, - "id": "delete-weather-job", - "status": "Waiting", - "message": "Created job to delete weather data for job name 'delete-weather-job', farmer id 'test_farmer' and boundary id 'test_boundary'.", - "createdDateTime": "2021-04-16T11:33:45Z", - "lastActionDateTime": "2021-04-16T11:33:45Z", - "startTime": "2021-04-16T11:33:45Z", - "endTime": "2021-04-16T11:33:45Z", - "farmerId": "test_farmer", - "boundaryId": "test_farmer", - "extensionId": "dtn.clearAg", - "name": "Delete Job", - "description": "For extension dtn.clearAg", - "properties": { - "region": "US" - } - } - } - } -} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_CreateDataIngestionJob.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_CreateDataIngestionJob.json deleted file mode 100644 index 27b4b7a446cc..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_CreateDataIngestionJob.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "jobId": "JOB123", - "api-version": "2021-03-31-preview", - "body": { - "farmerId": "test_farmer", - "boundaryId": "test_boundary", - "extensionId": "dtn.clearAg", - "extensionApiName": "dailyforecast", - "extensionApiInput": { - "start": 0, - "end": 5 - }, - "name": "TestWeatherJob", - "description": "Daily Forecast data for 5 days", - "properties": { - "region": "Asia" - } - } - }, - "responses": { - "202": { - "body": { - "durationInSeconds": 12.4, - "id": "weather-job", - "status": "Waiting", - "message": "Created job to fetch weather data for job name 'TestWeatherJob', farmer id 'test_farmer' and field id 'test_field'.", - "createdDateTime": "2021-04-16T11:33:45Z", - "lastActionDateTime": "2021-04-16T11:33:45Z", - "startTime": "2021-04-16T11:33:45Z", - "endTime": "2021-04-16T11:33:45Z", - "farmerId": "test_farmer", - "boundaryId": "test_boundary", - "extensionId": "dtn.clearAg", - "extensionApiName": "dailyforecast", - "extensionApiInput": { - "start": 0, - "end": 5 - }, - "name": "TestWeatherJob", - "description": "Daily Forecast data for 5 days", - "properties": { - "region": "Asia" - } - } - } - } -} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_GetDataDeleteJobDetails.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_GetDataDeleteJobDetails.json deleted file mode 100644 index 91bd4cb389ae..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_GetDataDeleteJobDetails.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "jobId": "JOB123", - "api-version": "2021-03-31-preview" - }, - "responses": { - "200": { - "body": { - "durationInSeconds": 12.4, - "id": "weather-delete-job", - "status": "Succeeded", - "message": "Weather data is deleted for startTime to endTime", - "createdDateTime": "2021-04-16T08:24:50Z", - "lastActionDateTime": "2021-04-16T08:24:50Z", - "extensionId": "dtn.clearAg", - "farmerId": "test_farmer", - "boundaryId": "test_farmer", - "weatherDataType": "forecast", - "granularity": "daily", - "startDateTime": "2021-04-18T01:32:42Z", - "endDateTime": "2021-04-18T01:32:42Z", - "name": "Delete Job", - "description": "For extension dtn.clearAg", - "properties": { - "region": "US" - } - } - } - } -} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_GetDataIngestionJobDetails.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_GetDataIngestionJobDetails.json deleted file mode 100644 index 9b4a6f6ac0e9..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_GetDataIngestionJobDetails.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "jobId": "JOB123", - "api-version": "2021-03-31-preview" - }, - "responses": { - "200": { - "body": { - "durationInSeconds": 12.4, - "id": "weather-job", - "status": "Succeeded", - "message": "Weather data is available for startTime to endTime", - "createdDateTime": "2021-04-16T08:24:50Z", - "lastActionDateTime": "2021-04-16T08:24:50Z", - "startTime": "2021-04-16T08:24:50Z", - "endTime": "2021-04-16T08:24:50Z", - "farmerId": "test_farmer", - "boundaryId": "test_boundary", - "extensionId": "dtn.clearAg", - "extensionApiName": "dailyforecast", - "extensionApiInput": { - "start": 0, - "end": 5 - }, - "name": "TestWeatherJob", - "description": "Daily Forecast data for 5 days", - "properties": { - "region": "Asia" - } - } - } - } -} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_List.json b/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_List.json deleted file mode 100644 index 837c992aaa74..000000000000 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_List.json +++ /dev/null @@ -1,143 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "farmerId": "FARMER123", - "boundaryId": "BOUNDARY123", - "extensionId": "DTN.ClearAg", - "weatherDataType": "Historical", - "granularity": "Daily", - "api-version": "2021-03-31-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "ecd327e7-07f1-31b1-65ee-2162e193c055", - "farmerId": "test_farmer", - "boundaryId": "test_boundary", - "extensionId": "dtn.clearAg", - "location": { - "latitude": 77.75695801443568, - "longitude": 12.30932563432023 - }, - "dateTime": "2020-12-23T00:00:00Z", - "unitSystemCode": "us-std", - "extensionVersion": "1.0", - "weatherDataType": "forecast", - "granularity": "daily", - "cloudCover": { - "unit": "%", - "value": 81.1 - }, - "dewPoint": { - "unit": "F", - "value": 26.0 - }, - "precipitation": { - "unit": "in", - "value": 0.1 - }, - "relativeHumidity": { - "unit": "%", - "value": 74.0 - }, - "temperature": { - "unit": "F", - "value": 33.0 - }, - "windGust": { - "unit": "mph", - "value": 50.0 - }, - "windSpeed": { - "unit": "mph", - "value": 31.0 - }, - "eTag": "\"2b00a419-0000-0700-0000-5fe1ae4c0000\"", - "properties": { - "air_temp_max": { - "unit": "F", - "value": 36.0 - }, - "air_temp_min": "29", - "cloudCoverDescriptor": "Becoming Broken Overcast", - "precipitationDescriptor": "Light Snow Likely", - "weatherDescriptor": "Light Snow Likely", - "windDirectionDescriptor": "East", - "windTrendDescriptor": "None", - "dewPointMax": { - "unit": "F", - "value": 28.0 - }, - "dewPointMin": { - "unit": "F", - "value": 22.0 - }, - "iceAccPeriod": { - "unit": "in", - "value": 0.0 - }, - "liquidAccPeriod": { - "unit": "in", - "value": 0.0 - }, - "longWaveRadiationAvg": { - "unit": "W/m^2", - "value": 291.0 - }, - "petPeriod": { - "unit": "in", - "value": 0.04 - }, - "precipProb": { - "unit": "%", - "value": 75.0 - }, - "relativeHumidityMax": { - "unit": "%", - "value": 81.0 - }, - "relativeHumidityMin": { - "unit": "%", - "value": 69.0 - }, - "shortWaveRadiationAvg": { - "unit": "W/m^2", - "value": 0.0 - }, - "snowAccPeriod": { - "unit": "in", - "value": 0.7 - }, - "sunshineDuration": { - "unit": "hours", - "value": 0.0 - }, - "windSpeed2mAvg": { - "unit": "mph", - "value": 24.0 - }, - "windSpeed2mMax": { - "unit": "mph", - "value": 32.0 - }, - "windSpeed2mMin": { - "unit": "mph", - "value": 17.0 - }, - "windSpeedMax": { - "unit": "mph", - "value": 42.0 - }, - "windSpeedMin": { - "unit": "mph", - "value": 23.0 - } - } - } - ] - } - } - } -} diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json deleted file mode 100644 index 4c4c7db32213..000000000000 --- a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json +++ /dev/null @@ -1,1200 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure AgFoodPlatform RP Service", - "description": "APIs documentation for Azure AgFoodPlatform Resource Provider Service.", - "version": "2020-05-12-preview" - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/extensions/{extensionId}": { - "put": { - "tags": [ - "Extensions" - ], - "description": "Install extension.", - "operationId": "Extensions_Create", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ExtensionIdParameter" - }, - { - "$ref": "#/parameters/FarmBeatsResourceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "201": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Extension" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Extensions_Create": { - "$ref": "./examples/Extensions_Create.json" - } - } - }, - "get": { - "tags": [ - "Extensions" - ], - "description": "Get installed extension details by extension id.", - "operationId": "Extensions_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ExtensionIdParameter" - }, - { - "$ref": "#/parameters/FarmBeatsResourceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Extension" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Extensions_Get": { - "$ref": "./examples/Extensions_Get.json" - } - } - }, - "patch": { - "tags": [ - "Extensions" - ], - "description": "Upgrade to latest extension.", - "operationId": "Extensions_Update", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ExtensionIdParameter" - }, - { - "$ref": "#/parameters/FarmBeatsResourceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Extension" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Extensions_Update": { - "$ref": "./examples/Extensions_Update.json" - } - } - }, - "delete": { - "tags": [ - "Extensions" - ], - "description": "Uninstall extension.", - "operationId": "Extensions_Delete", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ExtensionIdParameter" - }, - { - "$ref": "#/parameters/FarmBeatsResourceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success" - }, - "204": { - "description": "Success" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Extensions_Delete": { - "$ref": "./examples/Extensions_Delete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/extensions": { - "get": { - "tags": [ - "Extensions" - ], - "description": "Get installed extensions details.", - "operationId": "Extensions_ListByFarmBeats", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/FarmBeatsResourceNameParameter" - }, - { - "in": "query", - "name": "extensionIds", - "description": "Installed extension ids.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "extensionCategories", - "description": "Installed extension categories.", - "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" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ExtensionListResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Extensions_ListByFarmBeats": { - "$ref": "./examples/Extensions_ListByFarmBeats.json" - } - } - } - }, - "/providers/Microsoft.AgFoodPlatform/farmBeatsExtensionDefinitions": { - "get": { - "tags": [ - "FarmBeatsExtensions" - ], - "description": "Get list of farmBeats extension.", - "operationId": "FarmBeatsExtensions_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "query", - "name": "farmBeatsExtensionIds", - "description": "FarmBeatsExtension ids.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "farmBeatsExtensionNames", - "description": "FarmBeats extension names.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "extensionCategories", - "description": "Extension categories.", - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "in": "query", - "name": "publisherIds", - "description": "Publisher 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 - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/FarmBeatsExtensionListResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "FarmBeatsExtensions_List": { - "$ref": "./examples/FarmBeatsExtensions_List.json" - } - } - } - }, - "/providers/Microsoft.AgFoodPlatform/farmBeatsExtensionDefinitions/{farmBeatsExtensionId}": { - "get": { - "tags": [ - "FarmBeatsExtensions" - ], - "description": "Get farmBeats extension.", - "operationId": "FarmBeatsExtensions_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "farmBeatsExtensionId", - "description": "farmBeatsExtensionId to be queried.", - "required": true, - "type": "string", - "pattern": "^[A-za-z]{3,50}[.][A-za-z]{3,100}$" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/FarmBeatsExtension" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "FarmBeatsExtensions_Get": { - "$ref": "./examples/FarmBeatsExtensions_Get.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}": { - "get": { - "tags": [ - "FarmBeatsModels" - ], - "description": "Get FarmBeats resource.", - "operationId": "FarmBeatsModels_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/FarmBeatsResourceNameParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/FarmBeats" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "FarmBeatsModels_Get": { - "$ref": "./examples/FarmBeatsModels_Get.json" - } - } - }, - "put": { - "tags": [ - "FarmBeatsModels" - ], - "description": "Create or update FarmBeats resource.", - "operationId": "FarmBeatsModels_CreateOrUpdate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/FarmBeatsResourceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "FarmBeats resource create or update request object.", - "required": true, - "schema": { - "$ref": "#/definitions/FarmBeats" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/FarmBeats" - } - }, - "201": { - "description": "Success", - "schema": { - "$ref": "#/definitions/FarmBeats" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "FarmBeatsModels_CreateOrUpdate": { - "$ref": "./examples/FarmBeatsModels_CreateOrUpdate.json" - } - } - }, - "patch": { - "tags": [ - "FarmBeatsModels" - ], - "description": "Update a FarmBeats resource.", - "operationId": "FarmBeatsModels_Update", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/FarmBeatsResourceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "Request object.", - "required": true, - "schema": { - "$ref": "#/definitions/FarmBeatsUpdateRequestModel" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/FarmBeats" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "FarmBeatsModels_Update": { - "$ref": "./examples/FarmBeatsModels_Update.json" - } - } - }, - "delete": { - "tags": [ - "FarmBeatsModels" - ], - "description": "Delete a FarmBeats resource.", - "operationId": "FarmBeatsModels_Delete", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/FarmBeatsResourceNameParameter" - } - ], - "responses": { - "200": { - "description": "Success" - }, - "204": { - "description": "Success" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "FarmBeatsModels_Delete": { - "$ref": "./examples/FarmBeatsModels_Delete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.AgFoodPlatform/farmBeats": { - "get": { - "tags": [ - "FarmBeatsModels" - ], - "description": "Lists the FarmBeats instances for a subscription.", - "operationId": "FarmBeatsModels_ListBySubscription", - "produces": [ - "application/json" - ], - "parameters": [ - { - "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" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/FarmBeatsListResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "FarmBeatsModels_ListBySubscription": { - "$ref": "./examples/FarmBeatsModels_ListBySubscription.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats": { - "get": { - "tags": [ - "FarmBeatsModels" - ], - "description": "Lists the FarmBeats instances for a resource group.", - "operationId": "FarmBeatsModels_ListByResourceGroup", - "produces": [ - "application/json" - ], - "parameters": [ - { - "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": "Continuation token for getting next set of results.", - "type": "string" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/FarmBeatsListResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "FarmBeatsModels_ListByResourceGroup": { - "$ref": "./examples/FarmBeatsModels_ListByResourceGroup.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.AgFoodPlatform/checkNameAvailability": { - "post": { - "tags": [ - "Locations" - ], - "description": "Checks the name availability of the resource with requested resource name.", - "operationId": "Locations_CheckNameAvailability", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "NameAvailabilityRequest object.", - "required": true, - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/CheckNameAvailabilityRequest" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/CheckNameAvailabilityResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Locations_CheckNameAvailability_AlreadyExists": { - "$ref": "./examples/Locations_CheckNameAvailability_AlreadyExists.json" - }, - "Locations_CheckNameAvailability_Available": { - "$ref": "./examples/Locations_CheckNameAvailability_Available.json" - } - } - } - }, - "/providers/Microsoft.AgFoodPlatform/operations": { - "get": { - "tags": [ - "Operations" - ], - "description": "Lists the available operations of Microsoft.AgFoodPlatform resource provider.", - "operationId": "Operations_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/OperationListResult" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Operations_List": { - "$ref": "./examples/Operations_List.json" - } - } - } - } - }, - "definitions": { - "ExtensionProperties": { - "description": "Extension resource properties.", - "type": "object", - "properties": { - "extensionId": { - "description": "Extension Id.", - "pattern": "^[A-za-z]{3,50}[.][A-za-z]{3,100}$", - "type": "string", - "readOnly": true - }, - "extensionCategory": { - "description": "Extension category. e.g. weather/sensor/satellite.", - "type": "string", - "readOnly": true - }, - "installedExtensionVersion": { - "description": "Installed extension version.", - "pattern": "^([1-9]|10).\\d$", - "type": "string", - "readOnly": true - }, - "extensionAuthLink": { - "description": "Extension auth link.", - "type": "string", - "readOnly": true - }, - "extensionApiDocsLink": { - "description": "Extension api docs link.", - "type": "string", - "readOnly": true - } - } - }, - "Extension": { - "description": "Extension resource.", - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" - }, - "properties": { - "$ref": "#/definitions/ExtensionProperties", - "x-ms-client-flatten": true - }, - "eTag": { - "description": "The ETag value to implement optimistic concurrency.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "ExtensionListResponse": { - "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", - "type": "object", - "properties": { - "value": { - "description": "List of requested objects.", - "type": "array", - "items": { - "$ref": "#/definitions/Extension" - } - }, - "nextLink": { - "description": "Continuation link (absolute URI) to the next page of results in the list.", - "type": "string", - "readOnly": true - } - } - }, - "UnitSystemsInfo": { - "description": "Unit systems info for the data provider.", - "required": [ - "key", - "values" - ], - "type": "object", - "properties": { - "key": { - "description": "UnitSystem key sent as part of ProviderInput.", - "maxLength": 100, - "minLength": 2, - "type": "string" - }, - "values": { - "description": "List of unit systems supported by this data provider.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "DetailedInformation": { - "description": "Model to capture detailed information for farmBeatsExtensions.", - "type": "object", - "properties": { - "apiName": { - "description": "ApiName available for the farmBeatsExtension.", - "type": "string", - "example": "dailyforecast, dailyhistorical." - }, - "customParameters": { - "description": "List of customParameters.", - "type": "array", - "items": { - "type": "string" - } - }, - "platformParameters": { - "description": "List of platformParameters.", - "type": "array", - "items": { - "type": "string" - } - }, - "unitsSupported": { - "$ref": "#/definitions/UnitSystemsInfo" - }, - "apiInputParameters": { - "description": "List of apiInputParameters.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "FarmBeatsExtensionProperties": { - "description": "FarmBeatsExtension properties.", - "type": "object", - "properties": { - "targetResourceType": { - "description": "Target ResourceType of the farmBeatsExtension.", - "type": "string", - "readOnly": true - }, - "farmBeatsExtensionId": { - "description": "FarmBeatsExtension ID.", - "maxLength": 100, - "minLength": 2, - "pattern": "^[A-za-z]{3,50}[.][A-za-z]{3,100}$", - "type": "string", - "readOnly": true - }, - "farmBeatsExtensionName": { - "description": "FarmBeatsExtension name.", - "maxLength": 100, - "minLength": 2, - "type": "string", - "readOnly": true - }, - "farmBeatsExtensionVersion": { - "description": "FarmBeatsExtension version.", - "maxLength": 100, - "minLength": 2, - "pattern": "^([1-9]|10).\\d$", - "type": "string", - "readOnly": true - }, - "publisherId": { - "description": "Publisher ID.", - "maxLength": 100, - "minLength": 2, - "type": "string", - "readOnly": true - }, - "description": { - "description": "Textual description.", - "maxLength": 500, - "minLength": 2, - "type": "string", - "readOnly": true - }, - "extensionCategory": { - "description": "Category of the extension. e.g. weather/sensor/satellite.", - "maxLength": 100, - "minLength": 2, - "type": "string", - "readOnly": true - }, - "extensionAuthLink": { - "description": "FarmBeatsExtension auth link.", - "type": "string", - "readOnly": true - }, - "extensionApiDocsLink": { - "description": "FarmBeatsExtension api docs link.", - "type": "string", - "readOnly": true - }, - "detailedInformation": { - "description": "Detailed information which shows summary of requested data.\r\nUsed in descriptive get extension metadata call.\r\nInformation for weather category per api included are apisSupported,\r\ncustomParameters, PlatformParameters and Units supported.", - "type": "array", - "items": { - "$ref": "#/definitions/DetailedInformation" - }, - "readOnly": true - } - } - }, - "FarmBeatsExtension": { - "description": "FarmBeats extension resource.", - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" - }, - "properties": { - "$ref": "#/definitions/FarmBeatsExtensionProperties", - "x-ms-client-flatten": true - } - }, - "x-ms-azure-resource": true - }, - "FarmBeatsExtensionListResponse": { - "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", - "type": "object", - "properties": { - "value": { - "description": "List of requested objects.", - "type": "array", - "items": { - "$ref": "#/definitions/FarmBeatsExtension" - } - }, - "nextLink": { - "description": "Continuation link (absolute URI) to the next page of results in the list.", - "type": "string", - "readOnly": true - } - } - }, - "FarmBeatsProperties": { - "description": "FarmBeats ARM Resource properties.", - "type": "object", - "properties": { - "instanceUri": { - "format": "uri", - "description": "Uri of the FarmBeats instance.", - "type": "string", - "readOnly": true - }, - "provisioningState": { - "description": "FarmBeats instance provisioning state.", - "enum": [ - "Succeeded", - "Failed" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - } - } - }, - "FarmBeats": { - "description": "FarmBeats ARM Resource.", - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" - }, - "properties": { - "$ref": "#/definitions/FarmBeatsProperties", - "x-ms-client-flatten": true - } - }, - "x-ms-azure-resource": true - }, - "FarmBeatsUpdateRequestModel": { - "description": "FarmBeats update request.", - "type": "object", - "properties": { - "location": { - "description": "Geo-location where the resource lives.", - "type": "string" - }, - "tags": { - "description": "Resource tags.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "FarmBeatsListResponse": { - "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", - "type": "object", - "properties": { - "value": { - "description": "List of requested objects.", - "type": "array", - "uniqueItems": false, - "items": { - "$ref": "#/definitions/FarmBeats" - } - }, - "nextLink": { - "description": "Continuation link (absolute URI) to the next page of results in the list.", - "type": "string", - "readOnly": true - } - } - } - }, - "parameters": { - "FarmBeatsResourceNameParameter": { - "in": "path", - "name": "farmBeatsResourceName", - "description": "FarmBeats resource name.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ExtensionIdParameter": { - "in": "path", - "name": "extensionId", - "description": "Id of extension resource.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow." - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "host": "management.azure.com", - "schemes": [ - "https" - ], - "produces": [ - "application/json" - ], - "consumes": [ - "application/json" - ] -} diff --git a/specification/agfood/resource-manager/readme.csharp.md b/specification/agfood/resource-manager/readme.csharp.md deleted file mode 100644 index 9e64c3052486..000000000000 --- a/specification/agfood/resource-manager/readme.csharp.md +++ /dev/null @@ -1,15 +0,0 @@ -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -```yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 1 - clear-output-folder: true - client-side-validation: false - namespace: Microsoft.AgFoodPlatform - output-folder: $(csharp-sdks-folder)/agfood/management/Microsoft.AgFoodPlatform/Generated -``` diff --git a/specification/agfood/resource-manager/readme.go.md b/specification/agfood/resource-manager/readme.go.md deleted file mode 100644 index 056ea4b911ef..000000000000 --- a/specification/agfood/resource-manager/readme.go.md +++ /dev/null @@ -1,11 +0,0 @@ -## Go - -These settings apply only when `--go` is specified on the command line. - -```yaml $(go) && $(track2) -license-header: MICROSOFT_MIT_NO_VERSION -module-name: sdk/agfood/armagfood -module: github.com/Azure/azure-sdk-for-go/$(module-name) -output-folder: $(go-sdk-folder)/$(module-name) -azure-arm: true -``` diff --git a/specification/agfood/resource-manager/readme.md b/specification/agfood/resource-manager/readme.md deleted file mode 100644 index 2798ac8e8a73..000000000000 --- a/specification/agfood/resource-manager/readme.md +++ /dev/null @@ -1,105 +0,0 @@ -# agfood - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for agfood. - -## 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 agfood. - -```yaml -openapi-type: arm -tag: package-2020-05-12-preview -``` - -### Tag: package-2020-05-12-preview - -These settings apply only when `--tag=package-2020-05-12-preview` is specified on the command line. - -```yaml $(tag) == 'package-2020-05-12-preview' -input-file: - - Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json -``` - ---- - -# Code Generation - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -```yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python-track2 - - repo: azure-sdk-for-js -``` -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Python - -See configuration in [readme.python.md](./readme.python.md) - -## TypeScript - -See configuration in [readme.typescript.md](./readme.typescript.md) - -## CSharp - -See configuration in [readme.csharp.md](./readme.csharp.md) - -## Suppression - -``` yaml -directive: - - from: agfood.json - suppress: R3006 # BodyTopLevelProperties - where: $.definitions.FarmBeats.properties - reason: Currently systemData is not allowed. - - from: agfood.json - suppress: R3006 # BodyTopLevelProperties - where: $.definitions.Extension.properties - reason: Currently systemData is not allowed. - - from: agfood.json - suppress: R3018 # EnumInsteadOfBoolean - where: - - $.definitions.Operation.properties.isDataAction - - $.definitions.CheckNameAvailabilityResult.properties.nameAvailable - reason: Booleans are used to indicate binary states of the property, enum is not appropriate. - - from: agfood.json - suppress: R4000 # DescriptionAndTitleMissing - where: - - $.definitions.Error.properties.innererror - - $.definitions.ErrorResponse.properties.error - - $.definitions.Extension.properties.properties - - $.definitions.Extension.properties.systemData - - $.definitions.FarmBeats.properties.properties - - $.definitions.FarmBeats.properties.systemData - - $.definitions.InnerError.properties.innererror - - $.definitions.Operation.properties.display - reason: Model has description added in it's schema. - - from: types.json - suppress: R4000 # DescriptionAndTitleMissing - where: $.definitions.Resource - reason: Common type models are inherited. -``` diff --git a/specification/agfood/resource-manager/readme.python.md b/specification/agfood/resource-manager/readme.python.md deleted file mode 100644 index f109f297029c..000000000000 --- a/specification/agfood/resource-manager/readme.python.md +++ /dev/null @@ -1,23 +0,0 @@ -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(track2) -azure-arm: true -license-header: MICROSOFT_MIT_NO_VERSION -package-name: azure-mgmt-agfood -no-namespace-folders: true -package-version: 1.0.0b1 -clear-output-folder: true -``` - -``` yaml $(python-mode) == 'update' && $(track2) -no-namespace-folders: true -output-folder: $(python-sdks-folder)/agfood/azure-mgmt-agfood/azure/mgmt/agfood -``` - -``` yaml $(python-mode) == 'create' && $(track2) -basic-setup-py: true -output-folder: $(python-sdks-folder)/agfood/azure-mgmt-agfood -``` diff --git a/specification/agfood/resource-manager/readme.typescript.md b/specification/agfood/resource-manager/readme.typescript.md deleted file mode 100644 index c4ad9c4e1545..000000000000 --- a/specification/agfood/resource-manager/readme.typescript.md +++ /dev/null @@ -1,15 +0,0 @@ -## 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 - license-header: MICROSOFT_MIT_NO_VERSION - package-name: "@azure/arm-agfood" - output-folder: "$(typescript-sdks-folder)/sdk/agfood/arm-agfood" - payload-flattening-threshold: 1 - clear-output-folder: true - generate-metadata: true -``` diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json new file mode 100644 index 000000000000..027ef43d4b80 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json @@ -0,0 +1,12429 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure AgFoodPlatform Data Plane Service", + "description": "APIs documentation for Azure AgPlatform DataPlane Service.", + "version": "2021-03-31-preview" + }, + "paths": { + "/farmers/{farmerId}/application-data": { + "get": { + "tags": [ + "ApplicationData" + ], + "description": "Get a paginated list of application data resources for a given farmer and search criteria.\n\n\r###### Note: \n1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", + "operationId": "ApplicationData_ListByFarmerId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "minAvgMaterial", + "description": "Application data with average material greater than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgMaterial", + "description": "Application data with average material lesser than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minTotalMaterial", + "description": "Application data with total material greater than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTotalMaterial", + "description": "Application data with total material lesser than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "sources", + "description": "Application data obtained from the given list of sources will be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "associatedBoundaryIds", + "description": "List of boundary Ids of the field/seasonal field on which the application operation was done.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "operationBoundaryIds", + "description": "List of the boundary Ids that were created using the geographical area on which the application operation was carried out.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minOperationStartDateTime", + "description": "Application operations that began at or after the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationStartDateTime", + "description": "Application operations that began at or before the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationEndDateTime", + "description": "Application operations that ended at or after the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationEndDateTime", + "description": "Application operations that ended at or before the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationModifiedDateTime", + "description": "Application operations that were modified (at source) at or after the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationModifiedDateTime", + "description": "Application operations that were modified (at source) at or before the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minArea", + "description": "Application operations carried over area greater than or equal to the given value is returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxArea", + "description": "Application operations carried over area lesser than or equal to the given value is returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "ids", + "description": "List of Ids of application operations to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "List of names of application operations to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Application data with only given statuses are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Resources created at or after the given UTC date-time are returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Resources created at or before the given UTC date-time are returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Resources last modified at or after the given UTC date-time are returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Resources last modified at or before the given UTC date-time are returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items to be returned in a single page.", + "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/ApplicationDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ApplicationData_ListByFarmerId": { + "$ref": "./examples/ApplicationData_ListByFarmerId.json" + } + } + } + }, + "/application-data": { + "get": { + "tags": [ + "ApplicationData" + ], + "description": "Get a paginated list of application data resources across all the farmers for a given search criteria.\n\n\r###### Note:\n1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant.\n2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", + "operationId": "ApplicationData_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "minAvgMaterial", + "description": "Application data with average material greater than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgMaterial", + "description": " Application data with average material lesser than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minTotalMaterial", + "description": "Application data with total material greater than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTotalMaterial", + "description": "Application data with total material lesser than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "sources", + "description": "Application data obtained from the given list of sources will be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "associatedBoundaryIds", + "description": "List of boundary Ids of the field/seasonal field on which the application operation was done.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "operationBoundaryIds", + "description": "List of the boundary Ids that were created using the geographical area on which the application operation was carried out.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minOperationStartDateTime", + "description": "Application operations that began at or after the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationStartDateTime", + "description": "Application operations that began at or before the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationEndDateTime", + "description": "Application operations that ended at or after the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationEndDateTime", + "description": "Application operations that ended at or before the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationModifiedDateTime", + "description": "Application operations that were modified (at source) at or after the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationModifiedDateTime", + "description": "Application operations that were modified (at source) at or before the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minArea", + "description": "Application operations carried over area greater than or equal to the given value is returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxArea", + "description": "Application operations carried over area lesser than or equal to the given value is returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "ids", + "description": "List of Ids of application operations to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "List of names of application operations to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Application data with only the given statuses are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items to be returned in a single page.", + "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/ApplicationDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ApplicationData_List": { + "$ref": "./examples/ApplicationData_List.json" + } + } + } + }, + "/farmers/{farmerId}/application-data/{applicationDataId}": { + "get": { + "tags": [ + "ApplicationData" + ], + "description": "Get a specified application data resource for a given farmer.\n\n", + "operationId": "ApplicationData_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "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" + } + } + }, + "x-ms-examples": { + "ApplicationData_Get": { + "$ref": "./examples/ApplicationData_Get.json" + } + } + }, + "patch": { + "tags": [ + "ApplicationData" + ], + "description": "Create or update an application data resource for a given farmer.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**.\n2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", + "operationId": "ApplicationData_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "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.", + "schema": { + "$ref": "#/definitions/ApplicationData" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ApplicationData" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ApplicationData" + } + } + }, + "x-ms-examples": { + "ApplicationData_CreateOrUpdate": { + "$ref": "./examples/ApplicationData_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "ApplicationData" + ], + "description": "Delete a specified application data resource for a given farmer.\n\n", + "operationId": "ApplicationData_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "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": { + "204": { + "description": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApplicationData_Delete": { + "$ref": "./examples/ApplicationData_Delete.json" + } + } + } + }, + "/application-data/cascade-delete/{jobId}": { + "get": { + "tags": [ + "ApplicationData" + ], + "description": "Get details of a cascade delete job for application data resource.\n\n", + "operationId": "ApplicationData_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the application data cascade delete 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" + } + } + }, + "x-ms-examples": { + "ApplicationData_GetCascadeDeleteJobDetails": { + "$ref": "./examples/ApplicationData_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "ApplicationData" + ], + "description": "Create cascade delete job for application data resource.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n\n", + "operationId": "ApplicationData_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the application data cascade delete job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "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": { + "202": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "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" + } + } + } + }, + "/farmers/{farmerId}/attachments": { + "get": { + "tags": [ + "Attachments" + ], + "description": "Get a paginated list of attachment resources for a given farmer and search criteria.\n\n", + "operationId": "Attachments_ListByFarmerId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "resourceIds", + "description": "Attachments belonging to the given list of resources will be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "resourceTypes", + "description": "Attachments belonging to the resources of the given resource types will be returned. Valid values are Farmer, Farm, Field, SeasonalField, Boundary, ApplicationData, HarvestData, TillageDat and PlantingData.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the attachments to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "List of names of attachments to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Attachments with only the given statuses are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Attachments created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Attachments created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Attachments last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Attachments last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items to be returned in a single page.", + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Attachments_ListByFarmerId": { + "$ref": "./examples/Attachments_ListByFarmerId.json" + } + } + } + }, + "/farmers/{farmerId}/attachments/{attachmentId}": { + "get": { + "tags": [ + "Attachments" + ], + "description": "Get a specified attachment resource for a given farmer.\n\n", + "operationId": "Attachments_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "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" + } + } + }, + "x-ms-examples": { + "Attachments_Get": { + "$ref": "./examples/Attachments_Get.json" + } + } + }, + "patch": { + "tags": [ + "Attachments" + ], + "description": "Create or update an attachment resource for a given farmer.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**.\n2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters.\n\n", + "operationId": "Attachments_CreateOrUpdate", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "attachmentId", + "description": "Id of the attachment. This Id is unique for a given farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version.", + "required": true, + "type": "string" + }, + { + "in": "formData", + "name": "file", + "description": "File to be uploaded.", + "type": "file", + "format": "binary" + }, + { + "in": "formData", + "name": "FarmerId", + "description": "Id of the associated farmer.", + "type": "string" + }, + { + "in": "formData", + "name": "ResourceId", + "description": "This is the Id of the resource to which the attachment belongs. Ids of following entities are valid: Farmer, Farm, Field, Seasonal field, Boundary, Application data, Harvest data, Tillage data and Planting data.", + "type": "string" + }, + { + "in": "formData", + "name": "ResourceType", + "description": "Indicates the type of resource to which this attachment belongs. Valid values are Farmer, Farm, Field, SeasonalField, Boundary, ApplicationData, HarvestData, TillageDat and PlantingData.", + "type": "string" + }, + { + "in": "formData", + "name": "OriginalFileName", + "description": "Original file name of the attachment.", + "type": "string" + }, + { + "in": "formData", + "name": "Id", + "description": "Unique Id of the attachment. This Id is unique for a given farmer.", + "type": "string" + }, + { + "in": "formData", + "name": "Status", + "description": "User provided status of the attachment.", + "type": "string", + "maxLength": 100, + "minLength": 0 + }, + { + "in": "formData", + "name": "CreatedDateTime", + "description": "UTC Date-time at which the attachment was created (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "formData", + "name": "ModifiedDateTime", + "description": "UTC Date-time at which the attachment was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "formData", + "name": "Name", + "description": "Name of the attachment.", + "type": "string", + "maxLength": 100, + "minLength": 0 + }, + { + "in": "formData", + "name": "Description", + "description": "Brief description of the attachment.", + "type": "string", + "maxLength": 500, + "minLength": 0 + }, + { + "in": "formData", + "name": "ETag", + "description": "ETag value can be used to implement optimistic concurrency.", + "type": "string" + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Attachment" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Attachment" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Attachments_CreateOrUpdate": { + "$ref": "./examples/Attachments_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Attachments" + ], + "description": "Delete a specified attachment resource for a given farmer.\n\n", + "operationId": "Attachments_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "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": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Attachments_Delete": { + "$ref": "./examples/Attachments_Delete.json" + } + } + } + }, + "/farmers/{farmerId}/attachments/{attachmentId}/file": { + "get": { + "tags": [ + "Attachments" + ], + "description": "Return attachment as a file stream for a given input filePath.\n\n", + "operationId": "Attachments_Download", + "produces": [ + "application/octet-stream", + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "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" + } + } + }, + "x-ms-examples": { + "Attachments_Download": { + "$ref": "./examples/Attachments_Download.json" + } + } + } + }, + "/farmers/{farmerId}/boundaries": { + "get": { + "tags": [ + "Boundaries" + ], + "description": "Get a paginated list of boundary resources for a given farmer and search criteria.\n\n\r###### Note: \n1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", + "operationId": "Boundaries_ListByFarmerId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "isPrimary", + "description": "If set, only primary boundaries are returned.", + "type": "boolean" + }, + { + "in": "query", + "name": "parentType", + "description": "Boundaries with given parent types are returned. VAlid values are 'Field' and 'SeasonalField'.", + "type": "string" + }, + { + "in": "query", + "name": "parentIds", + "description": "Boundaries associated with the given parent Ids are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minAcreage", + "description": "Boundaries with acreage equal to or greater than the given value are returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAcreage", + "description": "Boundaries with acreage equal to or lesser than the given value are returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "ids", + "description": "List of Ids of boundaries to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "List of names of boundaries to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Boundaries with only the given statuses are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items to be returned in a single page.", + "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/BoundaryListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Boundaries_ListByFarmerId": { + "$ref": "./examples/Boundaries_ListByFarmerId.json" + } + } + }, + "post": { + "tags": [ + "Boundaries" + ], + "description": "Search for boundaries of a farmer intersecting with a given geometry.\nThis API is expected to be used when users want to find boundaries that intersect with a given geometry. Otherwise, this is functionally same as 'List by Farmer Id' API for boundaries.\n\n\r###### Note: \n1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", + "operationId": "Boundaries_SearchByFarmerId", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version.", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "query", + "description": "Query filters.", + "schema": { + "$ref": "#/definitions/SearchBoundaryQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BoundaryListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Boundaries_SearchByFarmerId": { + "$ref": "./examples/Boundaries_SearchByFarmerId.json" + } + } + } + }, + "/boundaries": { + "get": { + "tags": [ + "Boundaries" + ], + "description": "Get a paginated list of boundary resources across all the farmers for a given search criteria.\n\n\r###### Note:\n1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant.\n2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", + "operationId": "Boundaries_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "isPrimary", + "description": "If set, only primary boundaries are returned.", + "type": "boolean" + }, + { + "in": "query", + "name": "parentType", + "description": "Boundaries with given parent types are returned. VAlid values are 'Field' and 'SeasonalField'.", + "type": "string" + }, + { + "in": "query", + "name": "parentIds", + "description": "Boundaries associated with the given parent Ids are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minAcreage", + "description": "Boundaries with acreage equal to or greater than the given value are returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAcreage", + "description": "Boundaries with acreage equal to or lesser than the given value are returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "ids", + "description": "List of Ids of boundaries to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "List of names of boundaries to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Boundaries with only the given statuses are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items to be returned in a single page.", + "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/BoundaryListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Boundaries_List": { + "$ref": "./examples/Boundaries_List.json" + } + } + }, + "post": { + "tags": [ + "Boundaries" + ], + "description": "Search for boundaries across all the farmers intersecting with a given geometry.\nThis API is expected to be used when users want to find boundaries that intersect with a given geometry. Otherwise, this is functionally same as 'List' API for boundaries.\n\n\r\n\n\r###### Note:\n1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘Search by Farmer Id’** API as it is performant.\n2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", + "operationId": "Boundaries_Search", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "api-version", + "description": "The requested API version.", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "query", + "description": "Query filters.", + "schema": { + "$ref": "#/definitions/SearchBoundaryQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BoundaryListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Boundaries_Search": { + "$ref": "./examples/Boundaries_Search.json" + } + } + } + }, + "/boundaries/cascade-delete/{jobId}": { + "get": { + "tags": [ + "Boundaries" + ], + "description": "Get details of cascade delete job for a specified boundary.\n\n", + "operationId": "Boundaries_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the boundary cascade delete 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" + } + } + }, + "x-ms-examples": { + "Boundaries_GetCascadeDeleteJobDetails": { + "$ref": "./examples/Boundaries_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "Boundaries" + ], + "description": "Create a cascade delete job for a specified boundary.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n\n", + "operationId": "Boundaries_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the boundary cascade delete job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "boundaryId", + "description": "Id of the boundary to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Boundaries_CreateCascadeDeleteJob": { + "$ref": "./examples/Boundaries_CreateCascadeDeleteJob.json" + } + } + } + }, + "/farmers/{farmerId}/boundaries/{boundaryId}": { + "get": { + "tags": [ + "Boundaries" + ], + "description": "Get a specified boundary resource for a given farmer.\n\n", + "operationId": "Boundaries_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "boundaryId", + "description": "Id of the boundary.", + "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/Boundary" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Boundaries_Get": { + "$ref": "./examples/Boundaries_Get.json" + } + } + }, + "patch": { + "tags": [ + "Boundaries" + ], + "description": "Create or update a boundary resource.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**.\n2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", + "operationId": "Boundaries_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "boundaryId", + "description": "Unique Id of the boundary. This Id is unique for a given farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version.", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "boundary", + "description": "Boundary resource payload to Create or update.", + "schema": { + "$ref": "#/definitions/Boundary" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Boundary" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Boundary" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Boundaries_CreateOrUpdate": { + "$ref": "./examples/Boundaries_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Boundaries" + ], + "description": "Delete a specified boundary resource for a given farmer. It can only be deleted if it has no linked attachments, satellite or weather data.\n\n", + "operationId": "Boundaries_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "boundaryId", + "description": "Id of the boundary to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Boundaries_Delete": { + "$ref": "./examples/Boundaries_Delete.json" + } + } + } + }, + "/farmers/{farmerId}/boundaries/{boundaryId}/overlap": { + "get": { + "tags": [ + "Boundaries" + ], + "description": "Get overlapping (intersecting) acreage between two boundaries.\n\n", + "operationId": "Boundaries_GetOverlap", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the farmer associated with the given boundary.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "boundaryId", + "description": "Id of the given boundary.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "otherFarmerId", + "description": "Id of the farmer associated with the other boundary.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "otherBoundaryId", + "description": "Id of the other boundary.", + "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/BoundaryOverlapResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Boundaries_GetOverlap": { + "$ref": "./examples/Boundaries_GetOverlap.json" + } + } + } + }, + "/crops": { + "get": { + "tags": [ + "Crops" + ], + "description": "Get a paginated list of crop resources.\n\n\r###### Note: \n1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", + "operationId": "Crops_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "phenotypes", + "description": "Crops with the given list of phenotypes are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "List of Ids of crops to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "List of names of crops to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Crops with only the given statuses are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items to be returned in a single page.", + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Crops_List": { + "$ref": "./examples/Crops_List.json" + } + } + } + }, + "/crops/{cropId}": { + "get": { + "tags": [ + "Crops" + ], + "description": "Get a specified crop resource.\n\n", + "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" + } + } + }, + "x-ms-examples": { + "Crops_Get": { + "$ref": "./examples/Crops_Get.json" + } + } + }, + "patch": { + "tags": [ + "Crops" + ], + "description": "Create or update a crop resource.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**.\n2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", + "operationId": "Crops_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "cropId", + "description": "Id of the crop resource. This Id is unique for a given tenant.", + "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.", + "schema": { + "$ref": "#/definitions/Crop" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Crop" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Crop" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Crops_CreateOrUpdate": { + "$ref": "./examples/Crops_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Crops" + ], + "description": "Delete a specified crop resource.\n\n", + "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": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Crops_Delete": { + "$ref": "./examples/Crops_Delete.json" + } + } + } + }, + "/crops/{cropId}/crop-varieties": { + "get": { + "tags": [ + "CropVarieties" + ], + "description": "Get a paginated list of crop variety resources for a given crop and search criteria.\n\n\r###### Note: \n1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", + "operationId": "CropVarieties_ListByCropId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "cropId", + "description": "Id of the associated crop.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "cropIds", + "description": "Crop varieties associated with the given list of crop ids are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "brands", + "description": "Crop varieties associated with the given list of brands are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "products", + "description": "Crop varieties associated with the given list of products are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "List of Ids of crop varieties to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "List of names of crop varieties to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Crop varieties with only the given statuses are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items to be returned in a single page.", + "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/CropVarietyListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "CropVarieties_ListByCropId": { + "$ref": "./examples/CropVarieties_ListByCropId.json" + } + } + } + }, + "/crop-varieties": { + "get": { + "tags": [ + "CropVarieties" + ], + "description": "Get a paginated list of crop variety resources across all the crops for a given search criteria.\n\n\r###### Note:\n1. This API does a serial search of the database for the given search criteria. If the crop Id is available, it is strongly recommended to use **‘List by Crop Id’** API as it is performant.\n2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", + "operationId": "CropVarieties_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "cropIds", + "description": "Crop varieties associated with the given list of crop ids are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "brands", + "description": "Crop varieties associated with the given list of brands are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "products", + "description": "Crop varieties associated with the given list of products are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "List of Ids of crop varieties to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "List of names of crop varieties to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Crop varieties with only the given statuses are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items to be returned in a single page.", + "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/CropVarietyListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "CropVarieties_List": { + "$ref": "./examples/CropVarieties_List.json" + } + } + } + }, + "/crops/{cropId}/crop-varieties/{cropVarietyId}": { + "get": { + "tags": [ + "CropVarieties" + ], + "description": "Get a specified crop variety resource for a given crop.\n\n", + "operationId": "CropVarieties_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "cropId", + "description": "Id of the associated crop.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "cropVarietyId", + "description": "Id of the crop variety.", + "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/CropVariety" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CropVarieties_Get": { + "$ref": "./examples/CropVarieties_Get.json" + } + } + }, + "patch": { + "tags": [ + "CropVarieties" + ], + "description": "Create or update a crop variety resource.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**.\n2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", + "operationId": "CropVarieties_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "cropId", + "description": "Id of the associated crop.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "cropVarietyId", + "description": "Unique Id of the crop variety. This Is is unique for a given crop.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version.", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "cropVariety", + "description": "Crop variety resource payload to create or update.", + "schema": { + "$ref": "#/definitions/CropVariety" + } + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CropVariety" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CropVariety" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CropVarieties_CreateOrUpdate": { + "$ref": "./examples/CropVarieties_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "CropVarieties" + ], + "description": "Delete a specified crop variety resource for a given crop.\n\n", + "operationId": "CropVarieties_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "cropId", + "description": "Id of the associated crop.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "cropVarietyId", + "description": "Id of the crop variety to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CropVarieties_Delete": { + "$ref": "./examples/CropVarieties_Delete.json" + } + } + } + }, + "/farmers": { + "get": { + "tags": [ + "Farmers" + ], + "description": "Get a paginated list of farmer resources for a given search criteria.\n\n", + "operationId": "Farmers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "ids", + "description": "List of Ids of farmers to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "List of names of farmers to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Farmers with only the given statuses are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items to be returned in a single page.", + "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/FarmerListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Farmers_List": { + "$ref": "./examples/Farmers_List.json" + } + } + } + }, + "/farmers/{farmerId}": { + "get": { + "tags": [ + "Farmers" + ], + "description": "Get a specified farmer resource.\n\n", + "operationId": "Farmers_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "ID of the farmer.", + "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/Farmer" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Farmers_Get": { + "$ref": "./examples/Farmers_Get.json" + } + } + }, + "patch": { + "tags": [ + "Farmers" + ], + "description": "Create or update a farmer resource.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**.\n2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", + "operationId": "Farmers_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version.", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "farmer", + "description": "Farmer resource payload to create or update.", + "schema": { + "$ref": "#/definitions/Farmer" + } + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Farmer" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Farmer" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Farmers_CreateOrUpdate": { + "$ref": "./examples/Farmers_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Farmers" + ], + "description": "Delete a specified farmer resource. It can only be deleted if it has no linked attachments or farms.\n\n", + "operationId": "Farmers_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of farmer to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Farmers_Delete": { + "$ref": "./examples/Farmers_Delete.json" + } + } + } + }, + "/farmers/cascade-delete/{jobId}": { + "get": { + "tags": [ + "Farmers" + ], + "description": "Get details of a cascade delete job for a specified farmer.\n\n", + "operationId": "Farmers_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the farmer cascade delete 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" + } + } + }, + "x-ms-examples": { + "Farmers_GetCascadeDeleteJobDetails": { + "$ref": "./examples/Farmers_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "Farmers" + ], + "description": "Create a cascade delete job for a specified farmer.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n\n", + "operationId": "Farmers_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the farmer cascade delete job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "farmerId", + "description": "Id of the farmer to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Farmers_CreateCascadeDeleteJob": { + "$ref": "./examples/Farmers_CreateCascadeDeleteJob.json" + } + } + } + }, + "/farm-operations/ingest-data/{jobId}": { + "put": { + "tags": [ + "FarmOperations" + ], + "description": "Create a farm operation data ingestion job.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", + "operationId": "FarmOperations_CreateDataIngestionJob", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the farm operation data ingestion job.", + "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 the user.", + "schema": { + "$ref": "#/definitions/FarmOperationDataIngestionJob" + } + } + ], + "responses": { + "202": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FarmOperationDataIngestionJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "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 details of a farm operation data ingestion job.\n\n", + "operationId": "FarmOperations_GetDataIngestionJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the farm operation data ingestion 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" + } + } + }, + "x-ms-examples": { + "FarmOperations_GetDataIngestionJobDetails": { + "$ref": "./examples/FarmOperations_GetDataIngestionJobDetails.json" + } + } + } + }, + "/farmers/{farmerId}/farms": { + "get": { + "tags": [ + "Farms" + ], + "description": "Get a paginated list of farm resources for a given farmer and search criteria.\n\n\r###### Note: \n1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", + "operationId": "Farms_ListByFarmerId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "ids", + "description": "List of Ids of farms to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "List of names of farms to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Farms with only the given statuses are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items to be returned in a single page.", + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Farms_ListByFarmerId": { + "$ref": "./examples/Farms_ListByFarmerId.json" + } + } + } + }, + "/farms": { + "get": { + "tags": [ + "Farms" + ], + "description": "Get a paginated list of farm resources across all the farmers for a given search criteria.\n\n\r###### Note:\n1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant.\n2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", + "operationId": "Farms_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "ids", + "description": "List of Ids of farms to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "List of names of farms to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Farms with only the given statuses are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items to be returned in a single page.", + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Farms_List": { + "$ref": "./examples/Farms_List.json" + } + } + } + }, + "/farmers/{farmerId}/farms/{farmId}": { + "get": { + "tags": [ + "Farms" + ], + "description": "Get a specified farm resource for a given farmer.\n\n", + "operationId": "Farms_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "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": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Farm" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Farms_Get": { + "$ref": "./examples/Farms_Get.json" + } + } + }, + "patch": { + "tags": [ + "Farms" + ], + "description": "Create or update a farm resource for a given farmer.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**.\n2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", + "operationId": "Farms_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "farmId", + "description": "Unique Id of the farm. This Id is unique for a given farmer.", + "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.", + "schema": { + "$ref": "#/definitions/Farm" + } + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Farm" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Farm" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Farms_CreateOrUpdate": { + "$ref": "./examples/Farms_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Farms" + ], + "description": "Delete a specified farm resource for a given farmer. It can only be deleted if it has no linked attachments, fields or seasonal fields.\n\n", + "operationId": "Farms_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the farmer.", + "required": true, + "type": "string" + }, + { + "in": "path", + "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": { + "204": { + "description": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Farms_Delete": { + "$ref": "./examples/Farms_Delete.json" + } + } + } + }, + "/farms/cascade-delete/{jobId}": { + "get": { + "tags": [ + "Farms" + ], + "description": "Get details of cascade delete job for a specified farm.\n\n", + "operationId": "Farms_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the farm cascade delete 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" + } + } + }, + "x-ms-examples": { + "Farms_GetCascadeDeleteJobDetails": { + "$ref": "./examples/Farms_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "Farms" + ], + "description": "Create a cascade delete job for a specified farm.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n\n", + "operationId": "Farms_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the farm cascade delete job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "farmerId", + "description": "ID of the associated farmer.", + "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": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "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" + } + } + } + }, + "/farmers/{farmerId}/fields": { + "get": { + "tags": [ + "Fields" + ], + "description": "Get a paginated list of field resources for a given farmer and search criteria.\n\n\r###### Note: \n1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", + "operationId": "Fields_ListByFarmerId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "farmIds", + "description": "Fields associated with the given list of farms are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "List of Ids of fields to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "List of names of fields to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Fields with only the given statuses are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items to be returned in a single page.", + "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/FieldListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Fields_ListByFarmerId": { + "$ref": "./examples/Fields_ListByFarmerId.json" + } + } + } + }, + "/fields": { + "get": { + "tags": [ + "Fields" + ], + "description": "Get a paginated list of field resources across all the farmers for a given search criteria.\n\n\r###### Note:\n1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant.\n2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", + "operationId": "Fields_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "farmIds", + "description": "Fields associated with the given list of farms are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "List of Ids of fields to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "List of names of fields to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Fields with only the given statuses are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items to be returned in a single page.", + "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/FieldListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Fields_List": { + "$ref": "./examples/Fields_List.json" + } + } + } + }, + "/farmers/{farmerId}/fields/{fieldId}": { + "get": { + "tags": [ + "Fields" + ], + "description": "Get a specified field resource for a given farmer.\n\n", + "operationId": "Fields_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "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" + } + } + }, + "x-ms-examples": { + "Fields_Get": { + "$ref": "./examples/Fields_Get.json" + } + } + }, + "patch": { + "tags": [ + "Fields" + ], + "description": "Create or update a field resource for a given farmer.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**.\n2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", + "operationId": "Fields_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "fieldId", + "description": "Unique Id of the field. This Id is unique for a given farmer.", + "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.", + "schema": { + "$ref": "#/definitions/Field" + } + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Field" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Field" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Fields_CreateOrUpdate": { + "$ref": "./examples/Fields_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Fields" + ], + "description": "Delete a specified field resource for a given farmer. It can only be deleted if it has no linked attachments, boundaries or seasonal fields.\n\n", + "operationId": "Fields_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "path", + "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": { + "204": { + "description": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Fields_Delete": { + "$ref": "./examples/Fields_Delete.json" + } + } + } + }, + "/fields/cascade-delete/{jobId}": { + "get": { + "tags": [ + "Fields" + ], + "description": "Get details of cascade delete job for a specified field.\n\n", + "operationId": "Fields_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of field cascade delete 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" + } + } + }, + "x-ms-examples": { + "Fields_GetCascadeDeleteJobDetails": { + "$ref": "./examples/Fields_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "Fields" + ], + "description": "Create a cascade delete job for specified field.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n\n", + "operationId": "Fields_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of field cascade delete job. This Id is unique for a given tenant.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "farmerId", + "description": "Id of the associated farmer.", + "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": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "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" + } + } + } + }, + "/farmers/{farmerId}/harvest-data": { + "get": { + "tags": [ + "HarvestData" + ], + "description": "Get a paginated list of harvest data resources for a given farmer and search criteria.\n\n\r###### Note: \n1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", + "operationId": "HarvestData_ListByFarmerId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "minTotalYield", + "description": "Harvest data with total yield greater than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTotalYield", + "description": "Harvest data with total yield lesser than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minAvgYield", + "description": "Harvest data with average yield greater than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgYield", + "description": "Harvest data with average yield lesser than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minTotalWetMass", + "description": "Harvest data with total wet mass greater than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTotalWetMass", + "description": "Harvest data with total wet mass lesser than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minAvgWetMass", + "description": "Harvest data with average wet mass greater than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgWetMass", + "description": "Harvest data with average wet mass lesser than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minAvgMoisture", + "description": "Harvest data with average moisture greater than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgMoisture", + "description": "Harvest data with average moisture lesser than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minAvgSpeed", + "description": "Harvest data with average speed greater than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgSpeed", + "description": "Harvest data with average speed lesser than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "sources", + "description": "Harvest data obtained from the given list of sources will be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "associatedBoundaryIds", + "description": "List of boundary Ids of the field/seasonal field on which the harvest operation was done.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "operationBoundaryIds", + "description": "List of the boundary Ids that were created using the geographical area on which the harvest operation was carried out.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minOperationStartDateTime", + "description": "Harvest operations that began at or after the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationStartDateTime", + "description": "Harvest operations that began at or before the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationEndDateTime", + "description": "Harvest operations that ended at or after the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationEndDateTime", + "description": "Harvest operations that ended at or before the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationModifiedDateTime", + "description": "Harvest operations that were modified (at source) at or after the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationModifiedDateTime", + "description": "Harvest operations that were modified (at source) at or before the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minArea", + "description": "Harvest operations carried over area greater than or equal to the given value is returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxArea", + "description": "Harvest operations carried over area lesser than or equal to the given value is returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "ids", + "description": "List of Ids of harvest operations to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "List of names of harvest operations to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Harvest data with only the given statuses are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items to be returned in a single page.", + "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/HarvestDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "HarvestData_ListByFarmerId": { + "$ref": "./examples/HarvestData_ListByFarmerId.json" + } + } + } + }, + "/harvest-data": { + "get": { + "tags": [ + "HarvestData" + ], + "description": "Get a paginated list of harvest data resources across all the farmers for a given search criteria.\n\n\r###### Note:\n1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant.\n2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", + "operationId": "HarvestData_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "minTotalYield", + "description": "Harvest data with total yield greater than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTotalYield", + "description": "Harvest data with total yield lesser than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minAvgYield", + "description": "Harvest data with average yield greater than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgYield", + "description": "Harvest data with average yield lesser than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minTotalWetMass", + "description": "Harvest data with total wet mass greater than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTotalWetMass", + "description": "Harvest data with total wet mass lesser than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minAvgWetMass", + "description": "Harvest data with average wet mass greater than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgWetMass", + "description": "Harvest data with average wet mass lesser than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minAvgMoisture", + "description": "Harvest data with average moisture greater than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgMoisture", + "description": "Harvest data with average moisture lesser than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minAvgSpeed", + "description": "Harvest data with average speed greater than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgSpeed", + "description": "Harvest data with average speed lesser than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "sources", + "description": "Harvest data obtained from the given list of sources will be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "associatedBoundaryIds", + "description": "List of boundary Ids of the field/seasonal field on which the harvest operation was done.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "operationBoundaryIds", + "description": "List of the boundary Ids that were created using the geographical area on which the harvest operation was carried out.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minOperationStartDateTime", + "description": "Harvest operations that began at or after the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationStartDateTime", + "description": "Harvest operations that began at or before the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationEndDateTime", + "description": "Harvest operations that ended at or after the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationEndDateTime", + "description": "Harvest operations that ended at or before the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationModifiedDateTime", + "description": "Harvest operations that were modified (at source) at or after the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationModifiedDateTime", + "description": "Harvest operations that were modified (at source) at or before the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minArea", + "description": "Harvest operations carried over area greater than or equal to the given value is returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxArea", + "description": "Harvest operations carried over area lesser than or equal to the given value is returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "ids", + "description": "List of Ids of harvest operations to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "List of names of harvest operations to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Harvest data with only the given statuses are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items to be returned in a single page.", + "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/HarvestDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "HarvestData_List": { + "$ref": "./examples/HarvestData_List.json" + } + } + } + }, + "/farmers/{farmerId}/harvest-data/{harvestDataId}": { + "get": { + "tags": [ + "HarvestData" + ], + "description": "Get a specified harvest data resource for a given farmer.\n\n", + "operationId": "HarvestData_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "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" + } + } + }, + "x-ms-examples": { + "HarvestData_Get": { + "$ref": "./examples/HarvestData_Get.json" + } + } + }, + "patch": { + "tags": [ + "HarvestData" + ], + "description": "Create or update harvest data resource for a given farmer.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**.\n2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", + "operationId": "HarvestData_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "harvestDataId", + "description": "IDd 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.", + "schema": { + "$ref": "#/definitions/HarvestData" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/HarvestData" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/HarvestData" + } + } + }, + "x-ms-examples": { + "HarvestData_CreateOrUpdate": { + "$ref": "./examples/HarvestData_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "HarvestData" + ], + "description": "Delete a specified harvest data resource for a given farmer.\n\n", + "operationId": "HarvestData_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "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": { + "204": { + "description": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HarvestData_Delete": { + "$ref": "./examples/HarvestData_Delete.json" + } + } + } + }, + "/harvest-data/cascade-delete/{jobId}": { + "get": { + "tags": [ + "HarvestData" + ], + "description": "Get details of a cascade delete job for harvest data resource.\n\n", + "operationId": "HarvestData_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the harvest data cascade delete 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" + } + } + }, + "x-ms-examples": { + "HarvestData_GetCascadeDeleteJobDetails": { + "$ref": "./examples/HarvestData_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "HarvestData" + ], + "description": "Create cascade delete job for harvest data resource.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n\n", + "operationId": "HarvestData_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the harvest data cascade delete job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "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": { + "202": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "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" + } + } + } + }, + "/image-processing/rasterize/{jobId}": { + "put": { + "tags": [ + "ImageProcessing" + ], + "description": "Create a job which converts shape files into raster images.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", + "operationId": "ImageProcessing_CreateRasterizeJob", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Unique Id of the image processing (rasterize) job. This Id must be unique for a given tenant.", + "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 the user.", + "schema": { + "$ref": "#/definitions/ImageProcessingRasterizeJob" + } + } + ], + "responses": { + "202": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ImageProcessingRasterizeJob" + } + }, + "default": { + "description": "Error" + } + }, + "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 details of rasterize job. Rasterize job converts shape files into raster images.\n\n", + "operationId": "ImageProcessing_GetRasterizeJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the image processing (rasterize) 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" + } + } + }, + "x-ms-examples": { + "ImageProcessing_GetRasterizeJob": { + "$ref": "./examples/ImageProcessing_GetRasterizeJob.json" + } + } + } + }, + "/oauth/providers": { + "get": { + "tags": [ + "OAuthProviders" + ], + "description": "Get a paginated list of OAuth provider resources for a given search criteria.\n\n\r###### Note: \n1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", + "operationId": "OAuthProviders_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "ids", + "description": "List of Ids of OAuth providers to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "List of names of OAuth providers to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "OAuth providers with only the given statuses are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items to be returned in a single page.", + "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" + } + } + }, + "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 OAuth provider resource.\n\n", + "operationId": "OAuthProviders_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "oauthProviderId", + "description": "Id of the OAuth provider 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" + } + } + }, + "x-ms-examples": { + "OAuthProviders_Get": { + "$ref": "./examples/OAuthProviders_Get.json" + } + } + }, + "patch": { + "tags": [ + "OAuthProviders" + ], + "description": "Create or update an OAuth provider resource.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**.\n2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", + "operationId": "OAuthProviders_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "oauthProviderId", + "description": "Id of the OAuth provider 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.", + "schema": { + "$ref": "#/definitions/OAuthProvider" + } + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OAuthProvider" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OAuthProvider" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OAuthProviders_CreateOrUpdate": { + "$ref": "./examples/OAuthProviders_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "OAuthProviders" + ], + "description": "Delete a specified OAuth provider resource.\n\n", + "operationId": "OAuthProviders_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "oauthProviderId", + "description": "Id of the OAuth provider resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OAuthProviders_Delete": { + "$ref": "./examples/OAuthProviders_Delete.json" + } + } + } + }, + "/oauth/providers/cascade-delete/{jobId}": { + "get": { + "tags": [ + "OAuthProviders" + ], + "description": "Get details of cascade delete job for an OAuth provider resource.\n\n", + "operationId": "OAuthProviders_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the OAuth provider cascade delete 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" + } + } + }, + "x-ms-examples": { + "OAuthProviders_GetCascadeDeleteJobDetails": { + "$ref": "./examples/OAuthProviders_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "OAuthProviders" + ], + "description": "Create cascade delete job for an OAuth provider resource.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n\n", + "operationId": "OAuthProviders_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the OAuth provider cascade delete job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "oauthProviderId", + "description": "Id of the OAuth provider resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OAuthProviderCascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "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": "Get a list of OAuthToken documents for a given search criteria.\n\n", + "operationId": "OAuthTokens_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "authProviderIds", + "description": "List of Ids of OAuth providers to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "farmerIds", + "description": "List of Ids of associated farmers.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "isValid", + "description": "If set, only valid (non expired) OAuth tokens are returned.", + "type": "boolean" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items to be returned in a single page.", + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "OAuthTokens_List": { + "$ref": "./examples/OAuthTokens_List.json" + } + } + } + }, + "/oauth/tokens/:connect": { + "post": { + "tags": [ + "OAuthTokens" + ], + "description": "Get connection link needed in the OAuth flow.\n\n", + "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": "connectRequest", + "description": "OAuth Connect Request.", + "schema": { + "$ref": "#/definitions/OAuthConnectRequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OAuthTokens_GetOAuthConnectionLink": { + "$ref": "./examples/OAuthTokens_GetOAuthConnectionLink.json" + } + } + } + }, + "/oauth/tokens/remove/{jobId}": { + "get": { + "tags": [ + "OAuthTokens" + ], + "description": "Get details of OAuth token remove job.\n\n", + "operationId": "OAuthTokens_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the OAuth token removal 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" + } + } + }, + "x-ms-examples": { + "OAuthTokens_GetCascadeDeleteJobDetails": { + "$ref": "./examples/OAuthTokens_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "OAuthTokens" + ], + "description": "Create job to remove OAuth token.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n\n", + "operationId": "OAuthTokens_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the OAuth token removal job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "oauthProviderId", + "description": "Id of the OAuth provider resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "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" + } + } + } + }, + "/farmers/{farmerId}/planting-data": { + "get": { + "tags": [ + "PlantingData" + ], + "description": "Get a paginated list of planting data resources for a given farm and search criteria.\n\n\r###### Note: \n1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", + "operationId": "PlantingData_ListByFarmerId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "minAvgPlantingRate", + "description": "Planting data with average planting rate greater than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgPlantingRate", + "description": "Planting data with average planting rate lesser than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minTotalMaterial", + "description": "Planting data with total material greater than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTotalMaterial", + "description": "Planting data with total material lesser than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minAvgMaterial", + "description": "Planting data with average material greater than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgMaterial", + "description": "Planting data with total material lesser than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "sources", + "description": "Planting data obtained from the given list of sources will be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "associatedBoundaryIds", + "description": "List of boundary Ids of the field/seasonal field on which the planting operation was done.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "operationBoundaryIds", + "description": "List of the boundary Ids that were created using the geographical area on which the planting operation was carried out.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minOperationStartDateTime", + "description": "Planting operations that began at or after the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationStartDateTime", + "description": "Planting operations that began at or before the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationEndDateTime", + "description": "Planting operations that ended at or after the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationEndDateTime", + "description": "Planting operations that ended at or before the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationModifiedDateTime", + "description": "Planting operations that were modified (at source) at or after the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationModifiedDateTime", + "description": "Planting operations that were modified (at source) at or before the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minArea", + "description": "Planting operations carried over area greater than or equal to the given value is returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxArea", + "description": "Planting operations carried over area lesser than or equal to the given value is returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "ids", + "description": "List of Ids of planting operations to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "List of names of planting operations to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Planting data with only the given statuses are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items to be returned in a single page.", + "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/PlantingDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PlantingData_ListByFarmerId": { + "$ref": "./examples/PlantingData_ListByFarmerId.json" + } + } + } + }, + "/planting-data": { + "get": { + "tags": [ + "PlantingData" + ], + "description": "Get a paginated list of planting data resources across all the farmers for a given search criteria.\n\n\r###### Note:\n1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant.\n2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", + "operationId": "PlantingData_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "minAvgPlantingRate", + "description": "Planting data with average planting rate greater than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgPlantingRate", + "description": "Planting data with average planting rate lesser than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minTotalMaterial", + "description": "Planting data with total material greater than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTotalMaterial", + "description": "Planting data with total material lesser than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minAvgMaterial", + "description": "Planting data with average material greater than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgMaterial", + "description": "Planting data with average material lesser than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "sources", + "description": "Planting data obtained from the given list of sources will be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "associatedBoundaryIds", + "description": "List of boundary Ids of the field/seasonal field on which the planting operation was done.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "operationBoundaryIds", + "description": "List of the boundary Ids that were created using the geographical area on which the planting operation was carried out.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minOperationStartDateTime", + "description": "Planting operations that began at or after the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationStartDateTime", + "description": "Planting operations that began at or before the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationEndDateTime", + "description": "Planting operations that ended at or after the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationEndDateTime", + "description": "Planting operations that ended at or before the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationModifiedDateTime", + "description": "Planting operations that were modified (at source) at or after the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationModifiedDateTime", + "description": "Planting operations that were modified (at source) at or before the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minArea", + "description": "Planting operations carried over area greater than or equal to the given value is returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxArea", + "description": "Planting operations carried over area lesser than or equal to the given value is returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "ids", + "description": "List of Ids of planting operations to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "List of names of planting operations to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Planting data with only the given statuses are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items to be returned in a single page.", + "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/PlantingDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PlantingData_List": { + "$ref": "./examples/PlantingData_List.json" + } + } + } + }, + "/farmers/{farmerId}/planting-data/{plantingDataId}": { + "get": { + "tags": [ + "PlantingData" + ], + "description": "Get a specified planting data resource for a given farmer.\n\n", + "operationId": "PlantingData_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "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" + } + } + }, + "x-ms-examples": { + "PlantingData_Get": { + "$ref": "./examples/PlantingData_Get.json" + } + } + }, + "patch": { + "tags": [ + "PlantingData" + ], + "description": "Create or update a planting data resource for a given farmer.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**.\n2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", + "operationId": "PlantingData_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "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.", + "schema": { + "$ref": "#/definitions/PlantingData" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PlantingData" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PlantingData" + } + } + }, + "x-ms-examples": { + "PlantingData_CreateOrUpdate": { + "$ref": "./examples/PlantingData_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PlantingData" + ], + "description": "Delete a specified planting data resource under a particular farmer.\n\n", + "operationId": "PlantingData_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "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": { + "204": { + "description": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PlantingData_Delete": { + "$ref": "./examples/PlantingData_Delete.json" + } + } + } + }, + "/planting-data/cascade-delete/{jobId}": { + "get": { + "tags": [ + "PlantingData" + ], + "description": "Get details of a cascade delete job for planting data resource.\n\n", + "operationId": "PlantingData_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the planting data cascade delete 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" + } + } + }, + "x-ms-examples": { + "PlantingData_GetCascadeDeleteJobDetails": { + "$ref": "./examples/PlantingData_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "PlantingData" + ], + "description": "Create cascade delete job for planting data resource.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n\n", + "operationId": "PlantingData_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the planting data cascade delete job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "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": { + "202": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "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" + } + } + } + }, + "/scenes": { + "get": { + "tags": [ + "Scenes" + ], + "description": "Get a paginated list of scene resources for a given search criteria.\n\n\r###### Note: \n1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n2. This API will retrieve scenes present in the FarmBeats datastore and does not ingest new data. Example: a user has ingested satellite data from 1st of Jan 2019 to 30th of June 2019. However, using the current API, the user has asked for data from 1st of Jan 2019 to 31st of December 2019. In such a case, only data for the first 6 months is returned to the user.\n\n", + "operationId": "Scenes_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "provider", + "description": "Name of the data provider for the scene. For satellite imagery, this refers to the name of the satellite data provider.", + "required": true, + "type": "string", + "default": "Microsoft" + }, + { + "in": "query", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "boundaryId", + "description": "Id of the associated boundary.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "source", + "description": "Source from where the scene was procured/generated. For satellite imagery, this refers to the name of the satellite constellation.", + "type": "string", + "default": "Sentinel_2_L2A" + }, + { + "in": "query", + "name": "startDateTime", + "description": "Scenes that were captured/made available (at source) at or after this UTC Date-time is returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "endDateTime", + "description": "Scenes that were captured/made available (at source) at or before this UTC Date-time is returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCloudCoveragePercentage", + "description": "Scenes with cloud cover less than or equal to the given value are returned. Range [0 to 100.0].", + "type": "number", + "format": "double", + "default": 100, + "maximum": 100, + "minimum": 0 + }, + { + "in": "query", + "name": "maxDarkPixelCoveragePercentage", + "description": "Scenes with dark pixel cover less than or equal to the given value are returned. Range [0 to 100.0].", + "type": "number", + "format": "double", + "default": 100, + "maximum": 100, + "minimum": 0 + }, + { + "in": "query", + "name": "imageNames", + "description": "List of names of images to be fetched.\r\nFor Sentinel-2, allowed values are: 'B01', 'B02', 'B03', 'B04', 'B05', 'B06', 'B07', 'B08', 'B8A', 'B09', 'B11', 'B12', 'AOT', 'SCL', 'SNW', 'CLD', 'NDVI', 'NDWI', 'EVI', 'LAI', 'LAIMask', 'CLP', 'CLM', 'dataMask', sunAzimuthAngles, sunZenithAngles, viewAzimuthMean and viewZenithMean.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "imageResolutions", + "description": "List of image resolutions in meters. For Sentinel-2, available values are: 10, 20, 60.", + "type": "array", + "items": { + "format": "double", + "type": "number" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "imageFormats", + "description": "Format in which the scenes are to be returned. Available value: TIF.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items to be returned in a single page.", + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Scenes_List": { + "$ref": "./examples/Scenes_List.json" + } + } + } + }, + "/scenes/satellite/ingest-data/{jobId}": { + "put": { + "tags": [ + "Scenes" + ], + "description": "Create a satellite data ingestion job.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", + "operationId": "Scenes_CreateSatelliteDataIngestionJob", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the satellite data ingestion job.", + "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 the user.", + "schema": { + "$ref": "#/definitions/SatelliteDataIngestionJob" + } + } + ], + "responses": { + "202": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SatelliteDataIngestionJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "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 details of a satellite data ingestion job.\n\n", + "operationId": "Scenes_GetSatelliteDataIngestionJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the satellite data ingestion 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" + } + } + }, + "x-ms-examples": { + "Scenes_GetSatelliteDataIngestionJobDetails": { + "$ref": "./examples/Scenes_GetSatelliteDataIngestionJobDetails.json" + } + } + } + }, + "/scenes/downloadFiles": { + "get": { + "tags": [ + "Scenes" + ], + "description": "Return scenes as a file stream for a given input filePath.\n\n", + "operationId": "Scenes_Download", + "produces": [ + "application/octet-stream", + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "filePath", + "description": "Relative path where the scene is stored in cloud storage.", + "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" + } + } + }, + "x-ms-examples": { + "Scenes_Download": { + "$ref": "./examples/Scenes_Download.json" + } + } + } + }, + "/farmers/{farmerId}/seasonal-fields": { + "get": { + "tags": [ + "SeasonalFields" + ], + "description": "Get a paginated list of seasonal field resources for a given farmer and search criteria.\n\n\r###### Note: \n1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", + "operationId": "SeasonalFields_ListByFarmerId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "farmIds", + "description": "Seasonal fields associated with the given farms are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "fieldIds", + "description": "Seasonal fields associated with the given fields are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "seasonIds", + "description": "Seasonal fields associated with the given seasons are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "cropVarietyIds", + "description": "Seasonal fields associated with at least one of the given crop varieties are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "cropIds", + "description": "Seasonal fields associated with at least one of the given crops are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minAvgYieldValue", + "description": "Seasonal fields with average yield greater than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgYieldValue", + "description": "Seasonal fields with average yield lesser than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "avgYieldUnit", + "description": "Unit of the average yield.", + "type": "string" + }, + { + "in": "query", + "name": "minAvgSeedPopulationValue", + "description": "Seasonal fields with average seed population greater than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgSeedPopulationValue", + "description": "Seasonal fields with average seed population lesser than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "avgSeedPopulationUnit", + "description": "Unit of average seed population.", + "type": "string" + }, + { + "in": "query", + "name": "minPlantingDateTime", + "description": "Seasonal fields with planting date at or after the value specified will be returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPlantingDateTime", + "description": "Seasonal fields with planting date at or before the value specified will be returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "ids", + "description": "List of Ids of seasonal fields to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "List of names of seasonal fields to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Seasonal fields with only the given statuses are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items to be returned in a single page.", + "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/SeasonalFieldListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SeasonalFields_ListByFarmerId": { + "$ref": "./examples/SeasonalFields_ListByFarmerId.json" + } + } + } + }, + "/seasonal-fields": { + "get": { + "tags": [ + "SeasonalFields" + ], + "description": "Get a paginated list of seasonal field resources across all the farmers for a given search criteria.\n\n\r###### Note:\n1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant.\n2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", + "operationId": "SeasonalFields_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "farmIds", + "description": "Seasonal fields associated with the given farms are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "fieldIds", + "description": "Seasonal fields associated with the given fields are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "seasonIds", + "description": "Seasonal fields associated with the given seasons are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "cropVarietyIds", + "description": "Seasonal fields associated with at least one of the given crop varieties are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "cropIds", + "description": "Seasonal fields associated with at least one of the given crops are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minAvgYieldValue", + "description": "Seasonal fields with average yield greater than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgYieldValue", + "description": "Seasonal fields with average yield lesser than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "avgYieldUnit", + "description": "Unit of the average yield.", + "type": "string" + }, + { + "in": "query", + "name": "minAvgSeedPopulationValue", + "description": "Seasonal fields with average seed population greater than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxAvgSeedPopulationValue", + "description": "Seasonal fields with average seed population lesser than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "avgSeedPopulationUnit", + "description": "Unit of average seed population.", + "type": "string" + }, + { + "in": "query", + "name": "minPlantingDateTime", + "description": "Seasonal fields with planting date at or after the value specified will be returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPlantingDateTime", + "description": "Seasonal fields with planting date at or before the value specified will be returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "ids", + "description": "List of Ids of seasonal fields to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "List of names of seasonal fields to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Seasonal fields with only the given statuses are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items to be returned in a single page.", + "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/SeasonalFieldListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SeasonalFields_List": { + "$ref": "./examples/SeasonalFields_List.json" + } + } + } + }, + "/farmers/{farmerId}/seasonal-fields/{seasonalFieldId}": { + "get": { + "tags": [ + "SeasonalFields" + ], + "description": "Get a specified seasonal field resource for a given farmer.\n\n", + "operationId": "SeasonalFields_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "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" + } + } + }, + "x-ms-examples": { + "SeasonalFields_Get": { + "$ref": "./examples/SeasonalFields_Get.json" + } + } + }, + "patch": { + "tags": [ + "SeasonalFields" + ], + "description": "Create or update a seasonal field resource for a given farmer.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**.\n2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", + "operationId": "SeasonalFields_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "seasonalFieldId", + "description": "Unique Id of the seasonal field. This Id is unique for a given farmer.", + "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.", + "schema": { + "$ref": "#/definitions/SeasonalField" + } + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SeasonalField" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SeasonalField" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SeasonalFields_CreateOrUpdate": { + "$ref": "./examples/SeasonalFields_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "SeasonalFields" + ], + "description": "Delete a specified seasonal field resource for a given farmer. It can only be deleted if it has no linked attachments or boundaries.\n\n", + "operationId": "SeasonalFields_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "seasonalFieldId", + "description": "Id of the seasonal field to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SeasonalFields_Delete": { + "$ref": "./examples/SeasonalFields_Delete.json" + } + } + } + }, + "/seasonal-fields/cascade-delete/{jobId}": { + "get": { + "tags": [ + "SeasonalFields" + ], + "description": "Get details of cascade delete job for a specified seasonal field.\n\n", + "operationId": "SeasonalFields_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the seasonal field cascade delete 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" + } + } + }, + "x-ms-examples": { + "SeasonalFields_GetCascadeDeleteJobDetails": { + "$ref": "./examples/SeasonalFields_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "SeasonalFields" + ], + "description": "Create a cascade delete job for a specified seasonal field.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n\n", + "operationId": "SeasonalFields_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the seasonal field cascade delete job. This Id is unique for a given tenant.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "seasonalFieldId", + "description": "Id of the seasonal 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": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "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": "Get a paginated list of season resources.\n\n\r###### Note: \n1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", + "operationId": "Seasons_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "minStartDateTime", + "description": "Seasons which start at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxStartDateTime", + "description": "Seasons which start at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minEndDateTime", + "description": "Seasons which end at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxEndDateTime", + "description": "Seasons which end at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "years", + "description": "Seasons with given list of years are returned.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "List of Ids of seasons to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "List of names of seasons to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Seasons with only the given statuses are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items to be returned in a single page.", + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Seasons_List": { + "$ref": "./examples/Seasons_List.json" + } + } + } + }, + "/seasons/{seasonId}": { + "get": { + "tags": [ + "Seasons" + ], + "description": "Get a specified season resource.\n\n", + "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" + } + } + }, + "x-ms-examples": { + "Seasons_Get": { + "$ref": "./examples/Seasons_Get.json" + } + } + }, + "patch": { + "tags": [ + "Seasons" + ], + "description": "Create or update a season resource.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**.\n2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", + "operationId": "Seasons_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "seasonId", + "description": "Unique Id of the season. This Id is unique for a given tenant.", + "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.", + "schema": { + "$ref": "#/definitions/Season" + } + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Season" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Season" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Seasons_CreateOrUpdate": { + "$ref": "./examples/Seasons_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Seasons" + ], + "description": "Delete a specified season resource.\n\n", + "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": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Seasons_Delete": { + "$ref": "./examples/Seasons_Delete.json" + } + } + } + }, + "/farmers/{farmerId}/tillage-data": { + "get": { + "tags": [ + "TillageData" + ], + "description": "Get a paginated list of tillage data resources for a given farmer and search criteria.\n\n\r###### Note: \n1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", + "operationId": "TillageData_ListByFarmerId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "minTillageDepth", + "description": "Tillage data with tillage depth greater than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTillageDepth", + "description": "Tillage data with tillage depth lesser than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minTillagePressure", + "description": "Tillage data with tillage pressure greater than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTillagePressure", + "description": "Tillage data with tillage pressure lesser than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "sources", + "description": "Tillage data obtained from the given list of sources will be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "associatedBoundaryIds", + "description": "List of boundary Ids of the field/seasonal field on which the tillage operation was done.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "operationBoundaryIds", + "description": "List of the boundary Ids that were created using the geographical area on which the tillage operation was carried out.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minOperationStartDateTime", + "description": "Tillage operations that began at or after the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationStartDateTime", + "description": "Tillage operations that began at or before the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationEndDateTime", + "description": "Tillage operations that ended at or after the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationEndDateTime", + "description": "Tillage operations that ended at or before the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationModifiedDateTime", + "description": "Tillage operations that were modified (at source) at or after the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationModifiedDateTime", + "description": "Tillage operations that were modified (at source) at or before the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minArea", + "description": "Tillage operations carried over area greater than or equal to the given value is returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxArea", + "description": "Tillage operations carried over area lesser than or equal to the given value is returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "ids", + "description": "List of Ids of tillage operations to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "List of names of tillage operations to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Tillage data with only the given statuses are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items to be returned in a single page.", + "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/TillageDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TillageData_ListByFarmerId": { + "$ref": "./examples/TillageData_ListByFarmerId.json" + } + } + } + }, + "/tillage-data": { + "get": { + "tags": [ + "TillageData" + ], + "description": "Get a paginated list of tillage data resources across all the farmers for a given search criteria.\n\n\r###### Note:\n1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant.\n2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n\n", + "operationId": "TillageData_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "minTillageDepth", + "description": "Tillage data with tillage depth greater than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTillageDepth", + "description": "Tillage data with tillage depth lesser than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "minTillagePressure", + "description": "Tillage data with tillage pressure greater than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxTillagePressure", + "description": "Tillage data with tillage pressure lesser than or equal to the value specified will be returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "sources", + "description": "Tillage data obtained from the given list of sources will be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "associatedBoundaryIds", + "description": "List of boundary Ids of the field/seasonal field on which the tillage operation was done.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "operationBoundaryIds", + "description": "List of the boundary Ids that were created using the geographical area on which the tillage operation was carried out.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minOperationStartDateTime", + "description": "Tillage operations that began at or after the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationStartDateTime", + "description": "Tillage operations that began at or before the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationEndDateTime", + "description": "Tillage operations that ended at or after the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationEndDateTime", + "description": "Tillage operations that ended at or before the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minOperationModifiedDateTime", + "description": "Tillage operations that were modified (at source) at or after the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxOperationModifiedDateTime", + "description": "Tillage operations that were modified (at source) at or before the given UTC date-time is returned.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minArea", + "description": "Tillage operations carried over area greater than or equal to the given value is returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "maxArea", + "description": "Tillage operations carried over area lesser than or equal to the given value is returned.", + "type": "number", + "format": "double" + }, + { + "in": "query", + "name": "ids", + "description": "List of Ids of tillage operations to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "List of names of tillage operations to be returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Tillage data with only the given statuses are returned.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items to be returned in a single page.", + "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/TillageDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TillageData_List": { + "$ref": "./examples/TillageData_List.json" + } + } + } + }, + "/farmers/{farmerId}/tillage-data/{tillageDataId}": { + "get": { + "tags": [ + "TillageData" + ], + "description": "Get a specified tillage data resource for a given farmer.\n\n", + "operationId": "TillageData_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "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" + } + } + }, + "x-ms-examples": { + "TillageData_Get": { + "$ref": "./examples/TillageData_Get.json" + } + } + }, + "patch": { + "tags": [ + "TillageData" + ], + "description": "Create or update a tillage data resource for a given farmer.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**.\n2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", + "operationId": "TillageData_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "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.", + "schema": { + "$ref": "#/definitions/TillageData" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/TillageData" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/TillageData" + } + } + }, + "x-ms-examples": { + "TillageData_CreateOrUpdate": { + "$ref": "./examples/TillageData_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "TillageData" + ], + "description": "Delete a specified tillage data resource for a given farmer.\n\n", + "operationId": "TillageData_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmerId", + "description": "Id of the associated farmer.", + "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": { + "204": { + "description": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TillageData_Delete": { + "$ref": "./examples/TillageData_Delete.json" + } + } + } + }, + "/tillage-data/cascade-delete/{jobId}": { + "get": { + "tags": [ + "TillageData" + ], + "description": "Get details of a cascade delete job for tillage data resource.\n\n", + "operationId": "TillageData_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the tillage data cascade delete 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" + } + } + }, + "x-ms-examples": { + "TillageData_GetCascadeDeleteJobDetails": { + "$ref": "./examples/TillageData_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "TillageData" + ], + "description": "Create cascade delete job for tillage data resource.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n\n", + "operationId": "TillageData_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the tillage data cascade delete job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "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": { + "202": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "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" + } + } + } + }, + "/weather": { + "get": { + "tags": [ + "Weather" + ], + "description": "Get a paginated list of weather data resources for a given search criteria.\n\n\r###### Note: \n1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null.\n2. This API will retrieve weather data present in the FarmBeats datastore and does not ingest new data. Example: a user has ingested historical weather data from 1st of Jan 2019 to 30th of June 2019. However, using the current API, the user has asked for historical data from 1st of Jan 2019 to 31st of December 2019. In such a case, only data for the first 6 months is returned to the user.\n\n", + "operationId": "Weather_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "farmerId", + "description": "Id of the associated farmer.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "boundaryId", + "description": "Id of the associated boundary.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "extensionId", + "description": "Id of the weather extension. This signifies the source from where the weather data is fetched (eg. DTN.ClearAg).", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$" + }, + { + "in": "query", + "name": "weatherDataType", + "description": "Type of weather data (forecast/historical).", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 0 + }, + { + "in": "query", + "name": "granularity", + "description": "Granularity of weather data (daily/hourly).", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 0 + }, + { + "in": "query", + "name": "startDateTime", + "description": "Weather data at or after the given UTC Date-time will be returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "endDateTime", + "description": "Weather data at or before the given UTC Date-time will be returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items to be returned in a single page.", + "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/WeatherDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Weather_List": { + "$ref": "./examples/Weather_List.json" + } + } + } + }, + "/weather/ingest-data/{jobId}": { + "get": { + "tags": [ + "Weather" + ], + "description": "Get details of a weather data ingestion job.\n\n", + "operationId": "Weather_GetDataIngestionJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the weather data ingestion 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/WeatherDataIngestionJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Weather_GetDataIngestionJobDetails": { + "$ref": "./examples/Weather_GetDataIngestionJobDetails.json" + } + } + }, + "put": { + "tags": [ + "Weather" + ], + "description": "Create a weather data ingestion job.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", + "operationId": "Weather_CreateDataIngestionJob", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the weather data ingestion job.", + "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 the user.", + "schema": { + "$ref": "#/definitions/WeatherDataIngestionJob" + } + } + ], + "responses": { + "202": { + "description": "Success", + "schema": { + "$ref": "#/definitions/WeatherDataIngestionJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Weather_CreateDataIngestionJob": { + "$ref": "./examples/Weather_CreateDataIngestionJob.json" + } + } + } + }, + "/weather/delete-data/{jobId}": { + "get": { + "tags": [ + "Weather" + ], + "description": "Get details of a weather data delete job.\n\n", + "operationId": "Weather_GetDataDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the weather data delete 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/WeatherDataDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Weather_GetDataDeleteJobDetails": { + "$ref": "./examples/Weather_GetDataDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "Weather" + ], + "description": "Create a weather data delete job.\n\n\r###### Note:\n\r1. The **‘contentType’** in the request header should be **'application/json'**.\n2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters.\n3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively.\n\n", + "operationId": "Weather_CreateDataDeleteJob", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the weather data delete job.", + "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 the user.", + "schema": { + "$ref": "#/definitions/WeatherDataDeleteJob" + } + } + ], + "responses": { + "202": { + "description": "Success", + "schema": { + "$ref": "#/definitions/WeatherDataDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Weather_CreateDataDeleteJob": { + "$ref": "./examples/Weather_CreateDataDeleteJob.json" + } + } + } + } + }, + "parameters": { + "Endpoint": { + "name": "Endpoint", + "description": "The endpoint of your FarmBeats resource (protocol and hostname, for example: https://{resourceName}.farmbeats.azure.net).", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + } + }, + "definitions": { + "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" + } + } + }, + "ApplicationProductDetail": { + "description": "Schema of a product used during application.", + "type": "object", + "properties": { + "productName": { + "description": "Name of a product applied.", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "isCarrier": { + "description": "Indicates if the product is a carrier for a tank mix.", + "default": false, + "type": "boolean" + }, + "avgMaterial": { + "$ref": "#/definitions/Measure" + }, + "totalMaterial": { + "$ref": "#/definitions/Measure" + } + } + }, + "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" + }, + "source": { + "description": "Represents the source from which the application data was obtained.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "operationModifiedDateTime": { + "format": "date-time", + "description": "UTC date-time at which the operation data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source.", + "type": "string" + }, + "operationStartDateTime": { + "format": "date-time", + "description": "UTC date-time at which the operation started (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string" + }, + "operationEndDateTime": { + "format": "date-time", + "description": "UTC date-time at which the operation ended (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string" + }, + "attachmentsLink": { + "description": "Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation.", + "type": "string", + "readOnly": true + }, + "associatedBoundaryId": { + "description": "Id of the boundary of the field/seasonal field on which the application operation was done.", + "type": "string" + }, + "operationBoundaryId": { + "description": "Id of the boundary that is created using the geographical area on which the application operation was carried out.", + "type": "string" + }, + "farmerId": { + "description": "Id of the associated farmer.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique Id of the operation (application). This Id is unique for a given farmer.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "ETag value can be used to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "User determined status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "modifiedDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the application operation.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Brief description of the application operation.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "properties": { + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "ApplicationDataListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationData" + } + }, + "$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. If null, there are no additional pages.", + "type": "string" + } + } + }, + "InnerError": { + "description": "Inner error containing list of errors.\r\nInnerError reference document.", + "type": "object", + "properties": { + "code": { + "description": "Specific error code than was provided by the containing error.", + "type": "string" + }, + "innererror": { + "$ref": "#/definitions/InnerError" + } + }, + "additionalProperties": { + "type": "object" + } + }, + "Error": { + "description": "An error from Azure FarmBeats service.", + "type": "object", + "properties": { + "code": { + "description": "Server-defined set of error codes.", + "type": "string" + }, + "message": { + "description": "Human-readable representation of the error.", + "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" + } + } + }, + "ErrorResponse": { + "description": "An error response from Azure AgPlatform service.\r\nErrorResponse reference document..", + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/Error" + }, + "traceId": { + "description": "Unique trace Id.", + "type": "string" + } + } + }, + "CascadeDeleteJob": { + "description": "Schema of cascade delete job.", + "required": [ + "farmerId", + "resourceId", + "resourceType" + ], + "type": "object", + "properties": { + "farmerId": { + "description": "Farmer Id.", + "type": "string" + }, + "resourceId": { + "description": "The id of the resource which is to be deleted (along with the subtree & associated data).", + "type": "string" + }, + "resourceType": { + "description": "Signifies the type of the resource that is being deleted (along with the subtree & associated data).", + "type": "string" + }, + "id": { + "description": "Unique Id of the cascade delete job. This Id is unique for a given tenant.", + "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": "Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Brief description of the result of the job.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + } + } + }, + "Attachment": { + "description": "Schema of attachment resource.", + "type": "object", + "properties": { + "farmerId": { + "description": "Id of the associated farmer.", + "type": "string", + "readOnly": true + }, + "resourceId": { + "description": "This is the Id of the resource to which the attachment belongs. Ids of following entities are valid: Farmer, Farm, Field, Seasonal field, Boundary, Application data, Harvest data, Tillage data and Planting data.", + "type": "string" + }, + "resourceType": { + "description": "Indicates the type of resource to which this attachment belongs. Valid values are Farmer, Farm, Field, SeasonalField, Boundary, ApplicationData, HarvestData, TillageDat and PlantingData.", + "type": "string" + }, + "originalFileName": { + "description": "Original file name of the attachment.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique Id of the attachment. This Id is unique for a given farmer.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "User determined status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "modifiedDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the attachment.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Brief description of the attachment.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "eTag": { + "description": "ETag value can be used 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.", + "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. If null, there are no additional pages.", + "type": "string" + } + } + }, + "GeoJsonObjectType": { + "description": "GeoJSON object type.", + "enum": [ + "Point", + "Polygon", + "MultiPolygon" + ], + "type": "string", + "x-ms-enum": { + "name": "GeoJsonObjectType", + "modelAsString": true + } + }, + "GeoJsonObject": { + "description": "GeoJSON abstract class.", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/GeoJsonObjectType" + } + }, + "discriminator": "type" + }, + "Boundary": { + "description": "Schema of boundary resource.", + "type": "object", + "properties": { + "farmerId": { + "description": "Id of the associated farmer.", + "type": "string", + "readOnly": true + }, + "parentId": { + "description": "If the boundary is associated with a field or a seasonal field then the parent id refers to the id of the field/seasonal field.", + "type": "string" + }, + "geometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "isPrimary": { + "description": "Indicates if the boundary is a primary boundary for the associated parent (if any).", + "type": "boolean" + }, + "acreage": { + "format": "double", + "description": "Area of the boundary in acres.", + "type": "number", + "readOnly": true + }, + "parentType": { + "description": "Indicates if the parent is a field or a seasonal field. Permissible values are 'Field' and 'SeasonalField'.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique Id of the boundary. This Id is unique for a given farmer.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "ETag value can be used to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "User determined status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "modifiedDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the boundary.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Brief description of the boundary.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "properties": { + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + }, + "example": { + "name": "string", + "description": "string", + "parentId": "string", + "isPrimary": false, + "geometry": { + "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 + ] + ] + ] + } + } + }, + "BoundaryListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Boundary" + } + }, + "$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. If null, there are no additional pages.", + "type": "string" + } + } + }, + "SearchBoundaryQuery": { + "description": "SearchAllBoundaries and SearchBoundaries parameters.", + "type": "object", + "properties": { + "ids": { + "description": "List of boundary Ids to be searched.", + "type": "array", + "items": { + "type": "string" + } + }, + "names": { + "description": "List of names of boundaries to be searched.", + "type": "array", + "items": { + "type": "string" + } + }, + "propertyFilters": { + "description": "Filters on key-value pairs within 'Properties'.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + } + }, + "statuses": { + "description": "List of statuses of boundaries to be searched.", + "type": "array", + "items": { + "type": "string" + } + }, + "minCreatedDateTime": { + "format": "date-time", + "description": "Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string" + }, + "maxCreatedDateTime": { + "format": "date-time", + "description": "Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string" + }, + "minLastModifiedDateTime": { + "format": "date-time", + "description": "Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string" + }, + "maxLastModifiedDateTime": { + "format": "date-time", + "description": "Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string" + }, + "$maxPageSize": { + "format": "int32", + "description": "Maximum number of items to be returned in a single page.", + "default": 50, + "maximum": 1000, + "minimum": 10, + "type": "integer" + }, + "$skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "isPrimary": { + "description": "If set, search result will contain only primary boundaries.", + "type": "boolean" + }, + "parentType": { + "description": "Used to search based on the parent type (Field/ SeasonalField).", + "type": "string" + }, + "parentIds": { + "description": "List of parent Ids whose boundaries are to be retrieved.", + "type": "array", + "items": { + "type": "string" + } + }, + "minAcreage": { + "format": "double", + "description": "Minimum acreage of the boundary (inclusive).", + "type": "number" + }, + "maxAcreage": { + "format": "double", + "description": "Maximum acreage of the boundary (inclusive).", + "type": "number" + }, + "intersectsWithGeometry": { + "$ref": "#/definitions/GeoJsonObject" + } + } + }, + "BoundaryOverlapResponse": { + "description": "Schema of boundary overlap response.", + "type": "object", + "properties": { + "boundaryAcreage": { + "format": "double", + "description": "Acreage of the main boundary.", + "type": "number" + }, + "otherBoundaryAcreage": { + "format": "double", + "description": "Acreage of the other boundary.", + "type": "number" + }, + "intersectingAcreage": { + "format": "double", + "description": "Acreage of the intersecting area between the given boundaries.", + "type": "number" + } + } + }, + "Crop": { + "description": "Schema of crop resource.", + "type": "object", + "properties": { + "phenotype": { + "description": "Phenotype of the crop.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Unique Id of the crop.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "ETag value can be used to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "User determined status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "modifiedDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the crop.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Brief description of the crop.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "properties": { + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "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.", + "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. If null, there are no additional pages.", + "type": "string" + } + } + }, + "CropVariety": { + "description": "Schema of crop variety resource.", + "type": "object", + "properties": { + "cropId": { + "description": "Id of the associated crop.", + "type": "string", + "readOnly": true + }, + "brand": { + "description": "Brand of the crop variety.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "product": { + "description": "Commercial name of the crop variety.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Unique Id of the crop variety. This Id is unique for a given crop.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "ETag value can be used to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "User determined status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "modifiedDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the crop variety.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Brief description of the crop variety.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "properties": { + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "CropVarietyListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/CropVariety" + } + }, + "$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. If null, there are no additional pages.", + "type": "string" + } + } + }, + "Farmer": { + "description": "Schema of farmer resource.", + "type": "object", + "properties": { + "id": { + "description": "Unique Id of the farmer.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "ETag value can be used to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "User determined status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "modifiedDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the farmer.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Brief description of the farmer.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "properties": { + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "FarmerListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Farmer" + } + }, + "$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. If null, there are no additional pages.", + "type": "string" + } + } + }, + "FarmOperationDataIngestionJob": { + "description": "Schema of farm operation data ingestion job.", + "required": [ + "authProviderId", + "farmerId", + "startYear" + ], + "type": "object", + "properties": { + "farmerId": { + "description": "Id of the farmer whose farm operations are to be fetched.", + "type": "string" + }, + "authProviderId": { + "description": "Id of the farm operations data provider. Use 'JOHNDEERE' to fetch data from John Deere.", + "type": "string" + }, + "operations": { + "description": "List of types of farm operations for which data needs to be fetched. Valid values are AllOperations, Application, Planting, Harvest and Tillage.", + "type": "array", + "items": { + "type": "string" + } + }, + "startYear": { + "format": "int32", + "description": "The beginning year from when the farm operations data needs to be fetched (minimum = 2000, maximum = current year).", + "type": "integer" + }, + "id": { + "description": "Unique Id of the farm operations data ingestion job. This Id must be unique for a given tenant.", + "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": "Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Brief description of the result of the job.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the farm operations data ingestion job.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Brief description of the farm operations data ingestion job.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "properties": { + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "Farm": { + "description": "Schema of a farm resource.", + "type": "object", + "properties": { + "farmerId": { + "description": "Id of the associated farmer.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique Id of the farm. This Id is unique for a given farmer.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "ETag value can be used to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "User determined status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "modifiedDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the farm.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Brief description of the farm.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "properties": { + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "FarmListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "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. If null, there are no additional pages.", + "type": "string" + } + } + }, + "Field": { + "description": "Schema of a field resource.", + "type": "object", + "properties": { + "farmId": { + "description": "Id of the associated farm.", + "type": "string" + }, + "farmerId": { + "description": "Id of the associated farmer.", + "type": "string", + "readOnly": true + }, + "primaryBoundaryId": { + "description": "Id of the primary boundary associated with the field. At any point in time, a field can contain a maximum of one primary boundary.", + "type": "string", + "readOnly": true + }, + "boundaryIds": { + "description": "List of Ids of boundaries associated with the field.", + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "id": { + "description": "Unique Id of the field. This Id is unique for a given farmer.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "ETag value can be used to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "User determined status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "modifiedDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the field.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Brief description of the field.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "properties": { + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "FieldListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Field" + } + }, + "$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. If null, there are no additional pages.", + "type": "string" + } + } + }, + "HarvestProductDetail": { + "description": "Schema of a harvested product.", + "type": "object", + "properties": { + "productName": { + "description": "Name of a harvested 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" + } + } + }, + "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": "Details of harvested products.", + "type": "array", + "items": { + "$ref": "#/definitions/HarvestProductDetail" + } + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "source": { + "description": "Represents the source from which the harvest data was obtained.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "operationModifiedDateTime": { + "format": "date-time", + "description": "UTC date-time at which the harvest data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source.", + "type": "string" + }, + "operationStartDateTime": { + "format": "date-time", + "description": "UTC date-time at which the harvest operation started (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string" + }, + "operationEndDateTime": { + "format": "date-time", + "description": "UTC date-time at which the harvest operation ended (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string" + }, + "attachmentsLink": { + "description": "Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation.", + "type": "string", + "readOnly": true + }, + "associatedBoundaryId": { + "description": "Id of the boundary of the field/seasonal field on which the harvest operation was done.", + "type": "string" + }, + "operationBoundaryId": { + "description": "Id of the boundary that is created using the geographical area on which the harvest operation was carried out.", + "type": "string" + }, + "farmerId": { + "description": "Id of the associated farmer.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique Id of the operation (harvest). This Id is unique for a given farmer.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "ETag value can be used to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "User determined status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "modifiedDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the harvest operation.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Brief description of the harvest operation.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "properties": { + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "HarvestDataListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/HarvestData" + } + }, + "$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. If null, there are no additional pages.", + "type": "string" + } + } + }, + "ImageProcessingRasterizeJob": { + "description": "ImageProcessingRasterizeJob.", + "required": [ + "farmerId", + "shapefileAttachmentId", + "shapefileColumnNames" + ], + "type": "object", + "properties": { + "farmerId": { + "description": "Id of the associated farmer.", + "type": "string" + }, + "shapefileAttachmentId": { + "description": "Attachment id of the input shapefile which must be rasterized.", + "type": "string" + }, + "shapefileColumnNames": { + "description": "List of shapefile column names that must be rasterized.", + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "description": "Unique Id of the image processing (rasterize) job. This Id must be unique for a given tenant.", + "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": "Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Brief description of the result of the job.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the image processing (rasterize) job.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Brief description of the image processing (rasterize) job.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "properties": { + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "OAuthProvider": { + "description": "Schema of OAuth provider resource.", + "type": "object", + "properties": { + "appId": { + "description": "OAuth App Id for a given OAuth Provider.", + "maxLength": 200, + "minLength": 2, + "type": "string" + }, + "appSecret": { + "description": "OAuth App secret for a given OAuth Provider.\r\nNote: The app secret will not be part of the response.", + "maxLength": 200, + "minLength": 2, + "type": "string" + }, + "apiKey": { + "description": "OAuth Api key for a given Provider.\r\nNote: The Api key will not be part of the response. This is applicable only for authenticating to Climate Corp.", + "maxLength": 200, + "minLength": 2, + "type": "string" + }, + "isProductionApp": { + "description": "An optional flag to determine if the OAuth App is ready to be used for production scenarios.\r\nNote: This is applicable only for John Deere.", + "default": false, + "type": "boolean" + }, + "id": { + "description": "FarmBeats recognized unique Id for the OAuth provider. Valid value: 'JOHNDEERE.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "ETag value can be used to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "modifiedDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the OAuth provider.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Brief description of the OAuth provider.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "properties": { + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "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.", + "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. If null, there are no additional pages.", + "type": "string" + } + } + }, + "OAuthProviderCascadeDeleteJob": { + "description": "Schema of oauth provider cascade delete job.", + "required": [ + "oauthProviderId" + ], + "type": "object", + "properties": { + "oauthProviderId": { + "description": "FarmBeats recognized unique Id for the OAuth provider. Valid value: 'JOHNDEERE'.", + "type": "string" + }, + "id": { + "description": "Unique Id of the OAuth provider delete job. This Id must be unique for a given tenant.", + "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": "Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Brief description of the result of the job.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the OAuth provider cascade delete job.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Brief description of the OAuth provider cascade delete job..", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "properties": { + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "OAuthToken": { + "description": "Schema of OAuth token resource.", + "required": [ + "authProviderId", + "farmerId" + ], + "type": "object", + "properties": { + "farmerId": { + "description": "Id of the farmer for whom the OAuth flow is being configured.", + "type": "string" + }, + "authProviderId": { + "description": "Id of the OAuth provider resource containing the app information.", + "type": "string" + }, + "isValid": { + "description": "An optional flag indicating whether the token is valid or expired.", + "default": true, + "type": "boolean" + }, + "eTag": { + "description": "ETag value can be used to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "modifiedDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + } + } + }, + "OAuthTokenListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "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. If null, there are no additional pages.", + "type": "string" + } + } + }, + "OAuthConnectRequest": { + "description": "Get OAuth config query parameters.", + "required": [ + "farmerId", + "oAuthProviderId", + "userRedirectLink" + ], + "type": "object", + "properties": { + "farmerId": { + "description": "Id of the farmer for whom the OAuth flow is being configured.", + "type": "string" + }, + "oAuthProviderId": { + "description": "Id of the OAuth provider.", + "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 be returned when redirecting the user at the end of the oauth flow.", + "maxLength": 200, + "minLength": 0, + "type": "string" + } + } + }, + "PlantingProductDetail": { + "description": "Schema of a planted product.", + "type": "object", + "properties": { + "productName": { + "description": "Name of the planted product.", + "type": "string" + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "totalMaterial": { + "$ref": "#/definitions/Measure" + }, + "avgMaterial": { + "$ref": "#/definitions/Measure" + } + } + }, + "PlantingData": { + "description": "Schema of planting data resource.", + "type": "object", + "properties": { + "avgPlantingRate": { + "$ref": "#/definitions/Measure" + }, + "totalMaterial": { + "$ref": "#/definitions/Measure" + }, + "avgMaterial": { + "$ref": "#/definitions/Measure" + }, + "plantingProductDetails": { + "description": "Details of products planted.", + "type": "array", + "items": { + "$ref": "#/definitions/PlantingProductDetail" + } + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "source": { + "description": "Represents the source from which the planting data was obtained.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "operationModifiedDateTime": { + "format": "date-time", + "description": "UTC date-time at which the operation data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source.", + "type": "string" + }, + "operationStartDateTime": { + "format": "date-time", + "description": "UTC date-time at which the operation started (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string" + }, + "operationEndDateTime": { + "format": "date-time", + "description": "UTC date-time at which the operation ended (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string" + }, + "attachmentsLink": { + "description": "Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation.", + "type": "string", + "readOnly": true + }, + "associatedBoundaryId": { + "description": "Id of the boundary of the field/seasonal field on which the planting operation was done.", + "type": "string" + }, + "operationBoundaryId": { + "description": "Id of the boundary that is created using the geographical area on which the planting operation was carried out.", + "type": "string" + }, + "farmerId": { + "description": "Id of the associated farmer.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique Id of the operation (planting). This Id is unique for a given farmer.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "ETag value can be used to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "User determined status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "modifiedDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the planting operation.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Brief description of the planting operation.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "properties": { + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "PlantingDataListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/PlantingData" + } + }, + "$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. If null, there are no additional pages.", + "type": "string" + } + } + }, + "ImageFormat": { + "description": "Supported image formats for scene resource.", + "enum": [ + "TIF" + ], + "type": "string", + "x-ms-enum": { + "name": "ImageFormat", + "modelAsString": true + } + }, + "ImageFile": { + "description": "Schema of image file resource.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "fileLink": { + "description": "Link to the image file.", + "type": "string" + }, + "name": { + "description": "Name of the image file.", + "type": "string" + }, + "imageFormat": { + "$ref": "#/definitions/ImageFormat" + }, + "resolution": { + "format": "double", + "description": "Resolution of image in meters.", + "type": "number" + } + } + }, + "Scene": { + "description": "Schema of scene resource.", + "type": "object", + "properties": { + "sceneDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the image was captured/made available at source (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string" + }, + "provider": { + "description": "Name of the data provider for the scene. For satellite imagery, this refers to the name of the satellite data provider.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "source": { + "description": "Source from where the scene was procured/generated. For satellite imagery, this refers to the name of the satellite constellation.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "imageFiles": { + "description": "Collection of image files.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageFile" + } + }, + "imageFormat": { + "$ref": "#/definitions/ImageFormat" + }, + "cloudCoverPercentage": { + "format": "double", + "description": "Signifies the percentage of the scene covered by clouds.", + "maximum": 100, + "minimum": 0, + "type": "number" + }, + "darkPixelPercentage": { + "format": "double", + "description": "Signifies the percentage of the scene covered by dark pixels.", + "maximum": 100, + "minimum": 0, + "type": "number" + }, + "ndviMedianValue": { + "format": "double", + "description": "Median of NDVI values of the scene.", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "boundaryId": { + "description": "Id of the associated boundary.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "farmerId": { + "description": "Id of the associated farmer.", + "type": "string" + }, + "id": { + "description": "Unique Id of the scene", + "type": "string" + }, + "eTag": { + "description": "ETag value can be used to implement optimistic concurrency.", + "type": "string", + "readOnly": true + } + } + }, + "SceneListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "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. If null, there are no additional pages.", + "type": "string" + } + } + }, + "DataProvider": { + "description": "Provider of satellite data.", + "enum": [ + "Microsoft" + ], + "type": "string", + "x-ms-enum": { + "name": "DataProvider", + "modelAsString": true + } + }, + "Source": { + "description": "Source of satellite data.", + "enum": [ + "Sentinel_2_L2A" + ], + "type": "string", + "x-ms-enum": { + "name": "Source", + "modelAsString": true + } + }, + "SatelliteData": { + "description": "Data Model for SatelliteIngestionJobRequest.", + "type": "object", + "properties": { + "imageNames": { + "description": "List of names of images to be fetched.\r\nFor Sentinel-2, allowed values are: 'B01', 'B02', 'B03', 'B04', 'B05', 'B06', 'B07', 'B08', 'B8A', 'B09', 'B11', 'B12', 'AOT', 'SCL', 'SNW', 'CLD', 'NDVI', 'NDWI', 'EVI', 'LAI', 'LAIMask', 'CLP', 'CLM', and 'dataMask'.", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "NDVI" + ] + }, + "imageFormats": { + "description": "List of formats in which images can be fetched. Available value: TIF.", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "TIF" + ] + }, + "imageResolutions": { + "description": "List of image resolutions in meters. For Sentinel-2, available values are: 10, 20, 60.", + "type": "array", + "items": { + "format": "double", + "type": "number" + }, + "example": [ + 10 + ] + } + } + }, + "SatelliteDataIngestionJob": { + "description": "Schema of satellite data ingestion job.", + "required": [ + "boundaryId", + "endDateTime", + "farmerId", + "startDateTime" + ], + "type": "object", + "properties": { + "farmerId": { + "description": "Id of the associated farmer.", + "type": "string" + }, + "boundaryId": { + "description": "The id of the boundary for which satellite data is being fetched.", + "type": "string" + }, + "startDateTime": { + "format": "date-time", + "description": "UTC Date-time from when the satellite data has to be fetched (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string" + }, + "endDateTime": { + "format": "date-time", + "description": "UTC Date-time till when the satellite data has to be fetched (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string" + }, + "provider": { + "$ref": "#/definitions/DataProvider" + }, + "source": { + "$ref": "#/definitions/Source" + }, + "data": { + "$ref": "#/definitions/SatelliteData" + }, + "id": { + "description": "Unique Id of the satellite data ingestion job. This Id must be unique for a given tenant.", + "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": "DProcessing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Brief description of the result of the job.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the satellite data ingestion job.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Brief description of the satellite data ingestion job.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "properties": { + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "SeasonalField": { + "description": "Schema of seasonal field resource.", + "type": "object", + "properties": { + "farmerId": { + "description": "Id of the associated farmer.", + "type": "string", + "readOnly": true + }, + "primaryBoundaryId": { + "description": "Id of the primary boundary associated with the seasonal field. At any point in time, a seasonal field can contain a maximum of one primary boundary.", + "type": "string", + "readOnly": true + }, + "boundaryIds": { + "description": "List of Ids of boundaries associated with the seasonal field.", + "uniqueItems": true, + "type": "array", + "items": { + "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 associated with the seasonal field.", + "type": "string" + }, + "cropVarietyIds": { + "description": "List of Ids of crop varieties associated with the seasonal field. All the crop varieties must belong to the same crop.", + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + }, + "cropId": { + "description": "Id of the crop associated with the seasonal field. Seasonal fields are mono crop entities.", + "type": "string" + }, + "avgYieldValue": { + "format": "double", + "description": "Average yield generated from the seasonal field.", + "type": "number" + }, + "avgYieldUnit": { + "description": "Unit to measure average yield.", + "maxLength": 32, + "minLength": 2, + "type": "string" + }, + "avgSeedPopulationValue": { + "format": "double", + "description": "Average seed population planted in the seasonal field.", + "type": "number" + }, + "avgSeedPopulationUnit": { + "description": "Unit to measure average seed population.", + "maxLength": 32, + "minLength": 2, + "type": "string" + }, + "plantingDateTime": { + "format": "date-time", + "description": "UTC Date-time at which crops were planted (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string" + }, + "id": { + "description": "Unique Id of the seasonal field. This Id is unique for a given farmer.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "ETag value can be used to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "User determined status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "modifiedDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the seasonal field.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Brief description of the seasonal field.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "properties": { + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "SeasonalFieldListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/SeasonalField" + } + }, + "$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. If null, there are no additional pages.", + "type": "string" + } + } + }, + "Season": { + "description": "Schema of season resource.", + "type": "object", + "properties": { + "startDateTime": { + "format": "date-time", + "description": "UTC date-time signifying the start of the season (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string" + }, + "endDateTime": { + "format": "date-time", + "description": "UTC date-time signifying the end of the season (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string" + }, + "year": { + "format": "int32", + "description": "Year associated with the harvest i.e. year of season end date-time.", + "type": "integer" + }, + "id": { + "description": "Unique Id of the season.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "ETag value can be used to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "User determined status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "modifiedDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the season.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Brief description of the season.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "properties": { + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "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.", + "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. If null, there are no additional pages.", + "type": "string" + } + } + }, + "TillageData": { + "description": "Schema of tillage data resource.", + "type": "object", + "properties": { + "tillageDepth": { + "$ref": "#/definitions/Measure" + }, + "tillagePressure": { + "$ref": "#/definitions/Measure" + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "source": { + "description": "Represents the source from which the tillage data was obtained.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "operationModifiedDateTime": { + "format": "date-time", + "description": "UTC date-time at which the operation data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source.", + "type": "string" + }, + "operationStartDateTime": { + "format": "date-time", + "description": "UTC date-time at which the operation started (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string" + }, + "operationEndDateTime": { + "format": "date-time", + "description": "UTC date-time at which the operation ended (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string" + }, + "attachmentsLink": { + "description": "Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation.", + "type": "string", + "readOnly": true + }, + "associatedBoundaryId": { + "description": "Id of the boundary of the field/seasonal field on which the tillage operation was done.", + "type": "string" + }, + "operationBoundaryId": { + "description": "Id of the boundary that is created using the geographical area on which the tillage operation was carried out.", + "type": "string" + }, + "farmerId": { + "description": "Id of the associated farmer.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique Id of the operation (tillage). This Id is unique for a given farmer.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "ETag value can be used to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "User determined status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "modifiedDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the tillage operation.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Brief description of the tillage operation.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "properties": { + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "TillageDataListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/TillageData" + } + }, + "$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. If null, there are no additional pages.", + "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" + } + } + }, + "WeatherData": { + "description": "Schema of weather data.", + "required": [ + "boundaryId", + "dateTime", + "extensionId", + "extensionVersion", + "farmerId", + "granularity", + "location", + "weatherDataType" + ], + "type": "object", + "properties": { + "farmerId": { + "description": "Id of the associated farmer.", + "type": "string" + }, + "boundaryId": { + "description": "Id of the associated boundary.", + "type": "string" + }, + "extensionId": { + "description": "Id of the weather extension. This signifies the source from where the weather data is fetched (eg. DTN.ClearAg).", + "type": "string" + }, + "location": { + "$ref": "#/definitions/Location" + }, + "dateTime": { + "format": "date-time", + "description": "UTC Date-time of the weather data (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string" + }, + "unitSystemCode": { + "description": "Unit system like US/SI etc.", + "type": "string" + }, + "extensionVersion": { + "description": "Version of the weather data extension.", + "type": "string" + }, + "weatherDataType": { + "description": "Type of weather data (forecast/historical).", + "type": "string" + }, + "granularity": { + "description": "Granularity of weather data (daily/hourly).", + "type": "string" + }, + "cloudCover": { + "$ref": "#/definitions/Measure" + }, + "dewPoint": { + "$ref": "#/definitions/Measure" + }, + "growingDegreeDay": { + "$ref": "#/definitions/Measure" + }, + "precipitation": { + "$ref": "#/definitions/Measure" + }, + "pressure": { + "$ref": "#/definitions/Measure" + }, + "relativeHumidity": { + "$ref": "#/definitions/Measure" + }, + "soilMoisture": { + "$ref": "#/definitions/Measure" + }, + "soilTemperature": { + "$ref": "#/definitions/Measure" + }, + "temperature": { + "$ref": "#/definitions/Measure" + }, + "visibility": { + "$ref": "#/definitions/Measure" + }, + "wetBulbTemperature": { + "$ref": "#/definitions/Measure" + }, + "windChill": { + "$ref": "#/definitions/Measure" + }, + "windDirection": { + "$ref": "#/definitions/Measure" + }, + "windGust": { + "$ref": "#/definitions/Measure" + }, + "windSpeed": { + "$ref": "#/definitions/Measure" + }, + "id": { + "description": "Unique id of weather data.", + "type": "string" + }, + "eTag": { + "description": "ETag value can be used to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "modifiedDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "WeatherDataListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/WeatherData" + } + }, + "$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. If null, there are no additional pages.", + "type": "string" + } + } + }, + "WeatherDataIngestionJob": { + "description": "Schema of weather ingestion job.", + "required": [ + "boundaryId", + "extensionApiInput", + "extensionApiName", + "extensionId", + "farmerId" + ], + "type": "object", + "properties": { + "boundaryId": { + "description": "Id of the associated boundary.", + "type": "string" + }, + "farmerId": { + "description": "Id of the associated farmer.", + "type": "string" + }, + "extensionId": { + "description": "Id of the weather extension. This signifies the source from where the weather data is fetched (eg. DTN.ClearAg).", + "maxLength": 100, + "minLength": 2, + "pattern": "^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$", + "type": "string" + }, + "extensionApiName": { + "description": "Extension api name to which the request is to be made.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "extensionApiInput": { + "description": "Dictionary of inputs for extension api. This would be passed as part fo request to weather data provider.", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "extensionDataProviderAppId": { + "description": "App id of the weather data provider.", + "maxLength": 200, + "minLength": 2, + "type": "string" + }, + "extensionDataProviderApiKey": { + "description": "Api key of the weather data provider.", + "maxLength": 200, + "minLength": 2, + "type": "string" + }, + "id": { + "description": "Unique Id of the weather data ingestion job. This Id must be unique for a given tenant.", + "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": "Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Brief description of the result of the job.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to weather data ingestion job.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Brief description of the weather data ingestion job.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "properties": { + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "WeatherDataDeleteJob": { + "description": "Schema of weather data delete job.", + "required": [ + "boundaryId", + "extensionId", + "farmerId" + ], + "type": "object", + "properties": { + "extensionId": { + "description": "Id of the weather extension. This signifies the source from where the weather data was fetched (eg. DTN.ClearAg).", + "maxLength": 100, + "minLength": 2, + "pattern": "^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$", + "type": "string" + }, + "farmerId": { + "description": "The Id of the associated farmer.", + "type": "string" + }, + "boundaryId": { + "description": "The id of the associated boundary.", + "type": "string" + }, + "weatherDataType": { + "description": "Type of weather data (forecast/historical).", + "type": "string" + }, + "granularity": { + "description": "Granularity of weather data (daily/hourly).", + "type": "string" + }, + "startDateTime": { + "format": "date-time", + "description": "UTC Date-time from when the weather data has to be deleted (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string" + }, + "endDateTime": { + "format": "date-time", + "description": "UTC Date-time till when the weather data has to be deleted (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string" + }, + "id": { + "description": "Unique Id of the weather data delete job. This Id must be unique for a given tenant.", + "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": "Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Brief description of the result of the job.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ).", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the weather data deletion job.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Brief description of the weather data deletion job.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "properties": { + "description": "A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "MultiPolygon": { + "description": "MultiPolygon geometry.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJsonObject" + }, + { + "$ref": "#/definitions/MultiPolygonCoordinates" + } + ], + "x-ms-discriminator-value": "MultiPolygon" + }, + "MultiPolygonCoordinates": { + "description": "Schema of multi polygon coordinates.", + "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.", + "minLength": 1, + "type": "array", + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "format": "double", + "type": "number" + } + } + } + } + } + } + }, + "Point": { + "description": "Point geometry.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJsonObject" + }, + { + "$ref": "#/definitions/PointCoordinates" + } + ], + "x-ms-discriminator-value": "Point" + }, + "PointCoordinates": { + "description": "Schema of the coordinates of a point.", + "type": "object", + "required": [ + "coordinates" + ], + "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 respectively.", + "maximum": 3, + "minimum": 2, + "type": "array", + "items": { + "format": "double", + "type": "number" + } + } + } + }, + "Polygon": { + "description": "Polygon geometry.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJsonObject" + }, + { + "$ref": "#/definitions/PolygonCoordinates" + } + ], + "x-ms-discriminator-value": "Polygon" + }, + "PolygonCoordinates": { + "description": "Schema of polygon coordinates.", + "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.", + "minLength": 1, + "type": "array", + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "format": "double", + "type": "number" + } + } + } + } + } + } + }, + "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/2021-03-31-preview/examples/ApplicationData_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..62087dad58ba --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_CreateCascadeDeleteJob.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "Farmer123", + "applicationDataId": "Application123", + "api-version": "2021-03-31-preview", + "jobId": "Job123" + }, + "responses": { + "202": { + "body": { + "farmerId": "Farmer123", + "resourceId": "Application123", + "resourceType": "farmoperationapplicationdata", + "id": "Job123", + "status": "Waiting", + "message": "Created cascade delete job for 'farmoperationapplicationdata' resource with id 'Application123' and farmerId 'Farmer123'.", + "createdDateTime": "2021-06-19T09:39:37Z", + "lastActionDateTime": "2021-06-19T09:39:37Z", + "startTime": "2021-06-19T09:39:37Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_CreateOrUpdate.json new file mode 100644 index 000000000000..a5ef976c5ffd --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_CreateOrUpdate.json @@ -0,0 +1,147 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "Farmer123", + "applicationDataId": "Application123", + "api-version": "2021-03-31-preview", + "applicationData": { + "applicationProductDetails": [ + { + "productName": "Product123", + "isCarrier": false, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9 + } + } + ], + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9 + }, + "area": { + "unit": "acre", + "value": 60 + }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-25T16:57:04Z", + "operationStartDateTime": "2021-02-27T10:13:06Z", + "operationEndDateTime": "2021-02-28T11:12:12Z", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "status": "Active", + "name": "Test application data", + "description": "Test application data description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + }, + "responses": { + "200": { + "body": { + "applicationProductDetails": [ + { + "productName": "Product123", + "isCarrier": false, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9.0 + } + } + ], + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9.0 + }, + "area": { + "unit": "acre", + "value": 60.0 + }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-25T16:57:04Z", + "operationStartDateTime": "2021-02-27T10:13:06Z", + "operationEndDateTime": "2021-02-28T11:12:12Z", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Application123", + "eTag": "0300c56c-0000-0600-0000-60cc93920000", + "status": "Active", + "createdDateTime": "2021-06-18T12:37:38Z", + "modifiedDateTime": "2021-06-18T12:37:38Z", + "name": "Test application data", + "description": "Test application data description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + }, + "201": { + "body": { + "applicationProductDetails": [ + { + "productName": "Product123", + "isCarrier": false, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9.0 + } + } + ], + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9.0 + }, + "area": { + "unit": "acre", + "value": 60.0 + }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-25T16:57:04Z", + "operationStartDateTime": "2021-02-27T10:13:06Z", + "operationEndDateTime": "2021-02-28T11:12:12Z", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Application123", + "eTag": "0300c56c-0000-0600-0000-60cc93920000", + "status": "Active", + "createdDateTime": "2021-06-18T12:37:38Z", + "modifiedDateTime": "2021-06-18T12:37:38Z", + "name": "Test application data", + "description": "Test application data description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_Delete.json new file mode 100644 index 000000000000..b2c455bc5945 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "Farmer123", + "applicationDataId": "Application123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_Get.json new file mode 100644 index 000000000000..94fa4a8be6a5 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_Get.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "Farmer123", + "applicationDataId": "Application123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "applicationProductDetails": [ + { + "productName": "Product123", + "isCarrier": false, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9.0 + } + } + ], + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9.0 + }, + "area": { + "unit": "acre", + "value": 60.0 + }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-25T16:57:04Z", + "operationStartDateTime": "2021-02-27T10:13:06Z", + "operationEndDateTime": "2021-02-28T11:12:12Z", + "attachmentsLink": "https://test.farmbeats.azure.net/farmer/Farmer123/attachments?api-version=2021-03-31-preview&resourceIds=Application123&resourceTypes=FarmOperationApplicationData", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Application123", + "eTag": "0300c56c-0000-0600-0000-60cc93920000", + "status": "Active", + "createdDateTime": "2021-06-18T12:37:38Z", + "modifiedDateTime": "2021-06-18T12:37:38Z", + "name": "Test application data", + "description": "Test application data description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..a520e9287e6a --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_GetCascadeDeleteJobDetails.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "jobId": "Job123" + }, + "responses": { + "200": { + "body": { + "farmerId": "Farmer123", + "resourceId": "Application123", + "resourceType": "farmoperationapplicationdata", + "id": "Job123", + "status": "Succeeded", + "durationInSeconds": 10.1100966, + "message": "Job completed successfully.", + "createdDateTime": "2021-06-19T09:39:37Z", + "lastActionDateTime": "2021-06-19T09:39:47Z", + "startTime": "2021-06-19T09:39:37Z", + "endTime": "2021-06-19T09:39:47Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_List.json new file mode 100644 index 000000000000..a48ec37f6b84 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_List.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "applicationProductDetails": [ + { + "productName": "Product123", + "isCarrier": false, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9.0 + } + } + ], + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9.0 + }, + "area": { + "unit": "acre", + "value": 60.0 + }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-25T16:57:04Z", + "operationStartDateTime": "2021-02-27T10:13:06Z", + "operationEndDateTime": "2021-02-28T11:12:12Z", + "attachmentsLink": "https://test.farmbeats.azure.net/farmer/Farmer123/attachments?api-version=2021-03-31-preview&resourceIds=Application123&resourceTypes=FarmOperationApplicationData", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Application123", + "eTag": "0300c56c-0000-0600-0000-60cc93920000", + "status": "Active", + "createdDateTime": "2021-06-18T12:37:38Z", + "modifiedDateTime": "2021-06-18T12:37:38Z", + "name": "Test application data", + "description": "Test application data description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + ], + "nextLink": "https://bb-prod-wcus-1.farmbeats.azure.net/application-data?api-version=2021-03-31-preview&$skipToken=ffa6d232-0892-4e7e-bc8d-6acb12645251" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_ListByFarmerId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_ListByFarmerId.json new file mode 100644 index 000000000000..c9034ea0b9ed --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ApplicationData_ListByFarmerId.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "Farmer123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "applicationProductDetails": [ + { + "productName": "Product123", + "isCarrier": false, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9.0 + } + } + ], + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9.0 + }, + "area": { + "unit": "acre", + "value": 60.0 + }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-25T16:57:04Z", + "operationStartDateTime": "2021-02-27T10:13:06Z", + "operationEndDateTime": "2021-02-28T11:12:12Z", + "attachmentsLink": "https://bb-prod-wcus-1.farmbeats.azure.net/farmer/Farmer123/attachments?api-version=2021-03-31-preview&resourceIds=Application123&resourceTypes=FarmOperationApplicationData", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Application123", + "eTag": "0300c56c-0000-0600-0000-60cc93920000", + "status": "Active", + "createdDateTime": "2021-06-18T12:37:38Z", + "modifiedDateTime": "2021-06-18T12:37:38Z", + "name": "Test application data", + "description": "Test application data description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + ] + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_CreateOrUpdate.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_CreateOrUpdate.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_CreateOrUpdate.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_Delete.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_Delete.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_Delete.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_Download.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_Download.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_Download.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_Download.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_Get.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_Get.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_Get.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_ListByFarmerId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_ListByFarmerId.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_ListByFarmerId.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Attachments_ListByFarmerId.json diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..0555328dc7e3 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_CreateCascadeDeleteJob.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "boundaryId": "BOUNDARY123", + "api-version": "2021-03-31-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", + "farmerId": "FARMER123", + "resourceId": "BOUNDARY123", + "resourceType": "boundary" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_CreateOrUpdate.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_CreateOrUpdate.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_CreateOrUpdate.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_Delete.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_Delete.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_Delete.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_Get.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_Get.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_Get.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_GetCascadeDeleteJobDetails.json similarity index 77% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_GetCascadeDeleteJobDetails.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_GetCascadeDeleteJobDetails.json index aa0fba378785..8a44e2a721e6 100644 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_GetCascadeDeleteJobDetails.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_GetCascadeDeleteJobDetails.json @@ -15,12 +15,6 @@ "lastActionDateTime": "2021-04-19T11:31:34Z", "startTime": "2021-04-19T11:31:19Z", "endTime": "2021-04-19T11:31:34Z", - "name": "John Smith's Boundary", - "description": "Some description", - "properties": { - "Irrigated": "Yes", - "RetailerId": "Retailer123" - }, "farmerId": "FARMER123", "resourceId": "BOUNDARY123", "resourceType": "boundary" diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_GetOverlap.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_GetOverlap.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_GetOverlap.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_GetOverlap.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_List.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_List.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_List.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_ListByFarmerId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_ListByFarmerId.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_ListByFarmerId.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_ListByFarmerId.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_Search.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_Search.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_Search.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_Search.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_SearchByFarmerId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_SearchByFarmerId.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_SearchByFarmerId.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Boundaries_SearchByFarmerId.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_CreateOrUpdate.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_CreateOrUpdate.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_CreateOrUpdate.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_Delete.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_Delete.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_Delete.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_Get.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_Get.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_Get.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_List.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_List.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_List.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_ListByCropId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_ListByCropId.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_ListByCropId.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/CropVarieties_ListByCropId.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_CreateOrUpdate.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_CreateOrUpdate.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_CreateOrUpdate.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_Delete.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_Delete.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_Delete.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_Get.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_Get.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_Get.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_List.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_List.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Crops_List.json diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/FarmOperations_CreateDataIngestionJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/FarmOperations_CreateDataIngestionJob.json new file mode 100644 index 000000000000..071b842541ba --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/FarmOperations_CreateDataIngestionJob.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "jobId": "Job123", + "api-version": "2021-03-31-preview", + "body": { + "farmerId": "Farmer123", + "authProviderId": "JOHNDEERE", + "operations": [ + "AllOperations" + ], + "startYear": 2012, + "name": "Test farm operations job", + "description": "Test farm operations job details", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + }, + "responses": { + "202": { + "body": { + "operations": [ + "AllOperations" + ], + "startYear": 2012, + "durationInSeconds": 14.79, + "id": "sdi-0916aeec-ad8d-41d0-9797-63924f818cd7", + "status": "Waiting", + "message": "Created job to ingest farm operations data for job name 'Job123', farmer id 'Farmer123'.", + "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": "Test farm operations job", + "description": "Test farm operations job details", + "properties": { + "Region": "Central US", + "RetailerId": 123 + }, + "farmerId": "Farmer123", + "authProviderId": "JOHNDEERE" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/FarmOperations_GetDataIngestionJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/FarmOperations_GetDataIngestionJobDetails.json new file mode 100644 index 000000000000..982aa60223bc --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/FarmOperations_GetDataIngestionJobDetails.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "jobId": "Job123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "durationInSeconds": 11.2, + "id": "Job123", + "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": "Farm operations job details", + "properties": { + "Region": "Central US", + "RetailerId": 123 + }, + "farmerId": "Farmer123", + "authProviderId": "JOHNDEERE", + "operations": [ + "AllOperations" + ], + "startYear": 2012 + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..4c41fbdd9aeb --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_CreateCascadeDeleteJob.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "api-version": "2021-03-31-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", + "farmerId": "FARMER123", + "resourceId": "FARMER123", + "resourceType": "farmer" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_CreateOrUpdate.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_CreateOrUpdate.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_CreateOrUpdate.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_Delete.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_Delete.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_Delete.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_Get.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_Get.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_Get.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_GetCascadeDeleteJobDetails.json similarity index 78% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_GetCascadeDeleteJobDetails.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_GetCascadeDeleteJobDetails.json index fa3c14969a1d..24cf8a5c8f36 100644 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_GetCascadeDeleteJobDetails.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_GetCascadeDeleteJobDetails.json @@ -15,12 +15,6 @@ "lastActionDateTime": "2021-04-19T11:31:34Z", "startTime": "2021-04-19T11:31:19Z", "endTime": "2021-04-19T11:31:34Z", - "name": "John Smith", - "description": "Some description", - "properties": { - "Irrigated": "Yes", - "RetailerId": "Retailer123" - }, "farmerId": "FARMER123", "resourceId": "FARMER123", "resourceType": "farmer" diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_List.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_List.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farmers_List.json diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..dd78c9aa4e89 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_CreateCascadeDeleteJob.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "farmId": "FARM123", + "api-version": "2021-03-31-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", + "farmerId": "FARMER123", + "resourceId": "FARM123", + "resourceType": "farm" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_CreateOrUpdate.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_CreateOrUpdate.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_CreateOrUpdate.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_Delete.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_Delete.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_Delete.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_Get.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_Get.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_Get.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_GetCascadeDeleteJobDetails.json similarity index 77% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_GetCascadeDeleteJobDetails.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_GetCascadeDeleteJobDetails.json index 3721e59fb36c..76a9400b995d 100644 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_GetCascadeDeleteJobDetails.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_GetCascadeDeleteJobDetails.json @@ -15,12 +15,6 @@ "lastActionDateTime": "2021-04-19T11:31:34Z", "startTime": "2021-04-19T11:31:19Z", "endTime": "2021-04-19T11:31:34Z", - "name": "John Smith's Farm", - "description": "Some description", - "properties": { - "Irrigated": "Yes", - "RetailerId": "Retailer123" - }, "farmerId": "FARMER123", "resourceId": "FARM123", "resourceType": "farm" diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_List.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_List.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_List.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_ListByFarmerId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_ListByFarmerId.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_ListByFarmerId.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Farms_ListByFarmerId.json diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..45fd781771bb --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_CreateCascadeDeleteJob.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "FARMER123", + "fieldId": "FIELD123", + "api-version": "2021-03-31-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", + "farmerId": "FARMER123", + "resourceId": "FIELD123", + "resourceType": "field" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_CreateOrUpdate.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_CreateOrUpdate.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_CreateOrUpdate.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_Delete.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_Delete.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_Delete.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_Get.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_Get.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_Get.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_GetCascadeDeleteJobDetails.json similarity index 77% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_GetCascadeDeleteJobDetails.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_GetCascadeDeleteJobDetails.json index fe5878968de1..a4f99959cb1d 100644 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_GetCascadeDeleteJobDetails.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_GetCascadeDeleteJobDetails.json @@ -15,12 +15,6 @@ "lastActionDateTime": "2021-04-19T11:31:34Z", "startTime": "2021-04-19T11:31:19Z", "endTime": "2021-04-19T11:31:34Z", - "name": "John Smith's Field", - "description": "Some description", - "properties": { - "Irrigated": "Yes", - "RetailerId": "Retailer123" - }, "farmerId": "FARMER123", "resourceId": "FIELD123", "resourceType": "field" diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_List.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_List.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_List.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_ListByFarmerId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_ListByFarmerId.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_ListByFarmerId.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Fields_ListByFarmerId.json diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..b9eb70d322f5 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_CreateCascadeDeleteJob.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "Farmer123", + "harvestDataId": "Harvest123", + "api-version": "2021-03-31-preview", + "jobId": "Job123" + }, + "responses": { + "202": { + "body": { + "farmerId": "Farmer123", + "resourceId": "Harvest123", + "resourceType": "harvestdata", + "id": "Job123", + "status": "Waiting", + "message": "Created cascade delete job for 'harvestdata' resource with id 'Harvest123' and farmerId 'Farmer123'.", + "createdDateTime": "2021-06-19T11:55:34Z", + "lastActionDateTime": "2021-06-19T11:55:34Z", + "startTime": "2021-06-19T11:55:34Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_CreateOrUpdate.json new file mode 100644 index 000000000000..31a7b46a7184 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_CreateOrUpdate.json @@ -0,0 +1,240 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "farmerId": "Farmer123", + "harvestDataId": "Harvest123", + "harvestData": { + "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": "Product123", + "area": { + "unit": "acre", + "value": 30 + }, + "totalYield": { + "unit": "kilos", + "value": 900 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 + }, + "totalWetMass": { + "unit": "kilos", + "value": 300 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + } + } + ], + "area": { + "unit": "acre", + "value": 30 + }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "status": "Active", + "name": "Test harvest data", + "description": "Test harvest data description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + }, + "responses": { + "201": { + "body": { + "totalYield": { + "unit": "kilos", + "value": 1400.0 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 28.0 + }, + "totalWetMass": { + "unit": "kilos", + "value": 500.0 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10.0 + }, + "avgMoisture": { + "unit": "percent", + "value": 14.61 + }, + "avgSpeed": { + "unit": "kmsperhour", + "value": 7.2 + }, + "harvestProductDetails": [ + { + "productName": "Product123", + "area": { + "unit": "acre", + "value": 30.0 + }, + "totalYield": { + "unit": "kilos", + "value": 900.0 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 10.0 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 + }, + "totalWetMass": { + "unit": "kilos", + "value": 300.0 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10.0 + } + } + ], + "area": { + "unit": "acre", + "value": 30.0 + }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Harvest123", + "eTag": "02002c9d-0000-0600-0000-60cdd6a40000", + "status": "Active", + "createdDateTime": "2021-06-19T11:36:04Z", + "modifiedDateTime": "2021-06-19T11:36:04Z", + "name": "Test harvest data", + "description": "Test harvest data description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + }, + "200": { + "body": { + "totalYield": { + "unit": "kilos", + "value": 1400.0 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 28.0 + }, + "totalWetMass": { + "unit": "kilos", + "value": 500.0 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10.0 + }, + "avgMoisture": { + "unit": "percent", + "value": 14.61 + }, + "avgSpeed": { + "unit": "kmsperhour", + "value": 7.2 + }, + "harvestProductDetails": [ + { + "productName": "Product123", + "area": { + "unit": "acre", + "value": 30.0 + }, + "totalYield": { + "unit": "kilos", + "value": 900.0 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 10.0 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 + }, + "totalWetMass": { + "unit": "kilos", + "value": 300.0 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10.0 + } + } + ], + "area": { + "unit": "acre", + "value": 30.0 + }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Harvest123", + "eTag": "02002c9d-0000-0600-0000-60cdd6a40000", + "status": "Active", + "createdDateTime": "2021-06-19T11:36:04Z", + "modifiedDateTime": "2021-06-19T11:36:04Z", + "name": "Test harvest data", + "description": "Test harvest data description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_Delete.json new file mode 100644 index 000000000000..642cb085baa0 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "Farmer123", + "harvestDataId": "Harvest123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_Get.json new file mode 100644 index 000000000000..b745fe382f5f --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_Get.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "farmerId": "Farmer123", + "harvestDataId": "Harvest123" + }, + "responses": { + "200": { + "body": { + "totalYield": { + "unit": "kilos", + "value": 1400.0 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 28.0 + }, + "totalWetMass": { + "unit": "kilos", + "value": 500.0 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10.0 + }, + "avgMoisture": { + "unit": "percent", + "value": 14.61 + }, + "avgSpeed": { + "unit": "kmsperhour", + "value": 7.2 + }, + "harvestProductDetails": [ + { + "productName": "Product123", + "area": { + "unit": "acre", + "value": 30.0 + }, + "totalYield": { + "unit": "kilos", + "value": 900.0 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 10.0 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 + }, + "totalWetMass": { + "unit": "kilos", + "value": 300.0 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10.0 + } + } + ], + "area": { + "unit": "acre", + "value": 30.0 + }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "attachmentsLink": "https://bb-prod-wcus-1.farmbeats.azure.net/farmer/Farmer123/attachments?api-version=2021-03-31-preview&resourceIds=Harvest123&resourceTypes=HarvestData", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Harvest123", + "eTag": "02002c9d-0000-0600-0000-60cdd6a40000", + "status": "Active", + "createdDateTime": "2021-06-19T11:36:04Z", + "modifiedDateTime": "2021-06-19T11:36:04Z", + "name": "Test harvest data", + "description": "Test harvest data description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..8cf31a9ff735 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_GetCascadeDeleteJobDetails.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "jobId": "Job123" + }, + "responses": { + "200": { + "body": { + "farmerId": "Farmer123", + "resourceId": "Harvest123", + "resourceType": "harvestdata", + "id": "Job123", + "status": "Succeeded", + "durationInSeconds": 0.9115014, + "message": "Job completed successfully.", + "createdDateTime": "2021-06-19T11:55:34Z", + "lastActionDateTime": "2021-06-19T11:55:35Z", + "startTime": "2021-06-19T11:55:34Z", + "endTime": "2021-06-19T11:55:35Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_List.json new file mode 100644 index 000000000000..5e2ad3cb52bd --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_List.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "farmerId": "Farmer123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "totalYield": { + "unit": "kilos", + "value": 1400.0 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 28.0 + }, + "totalWetMass": { + "unit": "kilos", + "value": 500.0 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10.0 + }, + "avgMoisture": { + "unit": "percent", + "value": 14.61 + }, + "avgSpeed": { + "unit": "kmsperhour", + "value": 7.2 + }, + "harvestProductDetails": [ + { + "productName": "Product123", + "area": { + "unit": "acre", + "value": 30.0 + }, + "totalYield": { + "unit": "kilos", + "value": 900.0 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 10.0 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 + }, + "totalWetMass": { + "unit": "kilos", + "value": 300.0 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10.0 + } + } + ], + "area": { + "unit": "acre", + "value": 30.0 + }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "attachmentsLink": "https://bb-prod-wcus-1.farmbeats.azure.net/farmer/Farmer123/attachments?api-version=2021-03-31-preview&resourceIds=Harvest123&resourceTypes=HarvestData", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Harvest123", + "eTag": "02002c9d-0000-0600-0000-60cdd6a40000", + "status": "Active", + "createdDateTime": "2021-06-19T11:36:04Z", + "modifiedDateTime": "2021-06-19T11:36:04Z", + "name": "Test harvest data", + "description": "Test harvest data description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + ], + "nextLink": "https://test.farmbeats.azure.net/planting-data?api-version=2021-03-31-preview&$skipToken=2d7dad55-cfa9-4760-b198-0df17ec2fb65" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_ListByFarmerId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_ListByFarmerId.json new file mode 100644 index 000000000000..9c884906cde0 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/HarvestData_ListByFarmerId.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "farmerId": "Farmer123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "totalYield": { + "unit": "kilos", + "value": 1400.0 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 28.0 + }, + "totalWetMass": { + "unit": "kilos", + "value": 500.0 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10.0 + }, + "avgMoisture": { + "unit": "percent", + "value": 14.61 + }, + "avgSpeed": { + "unit": "kmsperhour", + "value": 7.2 + }, + "harvestProductDetails": [ + { + "productName": "Product123", + "area": { + "unit": "acre", + "value": 30.0 + }, + "totalYield": { + "unit": "kilos", + "value": 900.0 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 10.0 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 + }, + "totalWetMass": { + "unit": "kilos", + "value": 300.0 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10.0 + } + } + ], + "area": { + "unit": "acre", + "value": 30.0 + }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "attachmentsLink": "https://bb-prod-wcus-1.farmbeats.azure.net/farmer/Farmer123/attachments?api-version=2021-03-31-preview&resourceIds=Harvest123&resourceTypes=HarvestData", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Harvest123", + "eTag": "02002c9d-0000-0600-0000-60cdd6a40000", + "status": "Active", + "createdDateTime": "2021-06-19T11:36:04Z", + "modifiedDateTime": "2021-06-19T11:36:04Z", + "name": "Test harvest data", + "description": "Test harvest data description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + ] + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ImageProcessing_CreateRasterizeJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ImageProcessing_CreateRasterizeJob.json new file mode 100644 index 000000000000..77685a7910b8 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ImageProcessing_CreateRasterizeJob.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "jobId": "Job123", + "api-version": "2021-03-31-preview", + "body": { + "farmerId": "Farmer123", + "shapefileAttachmentId": "HarvestingDataShapefile123", + "shapefileColumnNames": [ + "Wet_yield", + "Dry_yield" + ], + "name": "Harvest data rasterize job", + "description": "Harvest data rasterize job details", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + }, + "responses": { + "202": { + "body": { + "durationInSeconds": 12.4, + "id": "Job123", + "status": "Waiting", + "message": "Created job to rasterize shapefile for job name 'Job123', farmer id 'Farmer123' and shapefileAttachment id 'HarvestingDataShapefile123'.", + "createdDateTime": "2021-04-16T11:33:45Z", + "lastActionDateTime": "2021-04-16T11:33:45Z", + "startTime": "2021-04-16T11:33:45Z", + "endTime": "2021-04-16T11:33:45Z", + "farmerId": "Farmer123", + "shapefileAttachmentId": "HarvestingDataShapefile123", + "shapefileColumnNames": [ + "Wet_yield", + "Dry_yield" + ], + "name": "Harvest data rasterize job", + "description": "Harvest data rasterize job details", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ImageProcessing_GetRasterizeJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ImageProcessing_GetRasterizeJob.json new file mode 100644 index 000000000000..1fe7dac4a5f2 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/ImageProcessing_GetRasterizeJob.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "jobId": "Job123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "durationInSeconds": 12.4, + "id": "Job123", + "status": "Succeeded", + "message": "Rasterization of shapefile is completed", + "createdDateTime": "2021-04-16T08:24:50Z", + "lastActionDateTime": "2021-04-16T08:24:50Z", + "startTime": "2021-04-16T08:24:50Z", + "endTime": "2021-04-16T08:24:50Z", + "farmerId": "Farmer123", + "shapefileAttachmentId": "HarvestingDataShapefile123", + "shapefileColumnNames": [ + "Wet_yield", + "Dry_yield" + ], + "name": "Harvest data rasterize job", + "description": "Harvest data rasterize job details", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..5efbae69a6ce --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_CreateCascadeDeleteJob.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "oauthProviderId": "JOHNDEERE", + "api-version": "2021-03-31-preview", + "jobId": "Job123" + }, + "responses": { + "202": { + "body": { + "oauthProviderId": "JOHNDEERE", + "id": "Job123", + "status": "Waiting", + "message": "Created cascade delete job for oauth provider 'JOHNDEERE'.", + "createdDateTime": "2021-06-19T13:21:49Z", + "lastActionDateTime": "2021-06-19T13:21:49Z", + "startTime": "2021-06-19T13:21:49Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_CreateOrUpdate.json new file mode 100644 index 000000000000..70e0719a0cac --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_CreateOrUpdate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "oauthProviderId": "JOHNDEERE", + "api-version": "2021-03-31-preview", + "oauthProvider": { + "appId": "appId", + "appSecret": "appSecret", + "apiKey": "apiKey", + "isProductionApp": false, + "name": "Test oAuth provider", + "description": "Test oAuth provider description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + }, + "responses": { + "200": { + "body": { + "id": "JOHNDEERE", + "appId": "appId", + "isProductionApp": false, + "name": "Test oAuth provider", + "description": "Test oAuth provider description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + }, + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e", + "createdDateTime": "2021-04-23T11:31:10Z", + "modifiedDateTime": "2021-04-23T11:31:10Z" + } + }, + "201": { + "body": { + "id": "JOHNDEERE", + "appId": "appId", + "isProductionApp": false, + "name": "Test oAuth provider", + "description": "Test oAuth provider description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + }, + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e", + "createdDateTime": "2021-04-23T11:31:10Z", + "modifiedDateTime": "2021-04-23T11:31:10Z" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_Delete.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_Delete.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_Delete.json diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_Get.json new file mode 100644 index 000000000000..5f70efb1d71c --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "oauthProviderId": "JOHNDEERE", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "appId": "appId", + "isProductionApp": false, + "id": "JOHNDEERE", + "eTag": "f8fad5b-d9cb-469f-a165-70867728950e", + "createdDateTime": "2021-04-22T18:27:37Z", + "modifiedDateTime": "2021-04-22T18:27:37Z", + "name": "Test oAuth provider", + "description": "Test oAuth provider description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..ed961b3625d8 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_GetCascadeDeleteJobDetails.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "jobId": "Job123" + }, + "responses": { + "200": { + "body": { + "oauthProviderId": "CLIMATE", + "id": "J12", + "status": "Succeeded", + "durationInSeconds": 5.154055, + "message": "Job completed successfully.", + "createdDateTime": "2021-06-19T13:21:49Z", + "lastActionDateTime": "2021-06-19T13:21:54Z", + "startTime": "2021-06-19T13:21:49Z", + "endTime": "2021-06-19T13:21:54Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_List.json new file mode 100644 index 000000000000..03aeb49776ac --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthProviders_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "appId": "0oagl9ap4plg0p6fn1t7ss", + "isProductionApp": false, + "id": "JOHNDEERE", + "eTag": "0200239b-0000-0600-0000-60c87b7b0000", + "createdDateTime": "2021-06-15T10:05:47Z", + "modifiedDateTime": "2021-06-15T10:05:47Z", + "name": "Test oAuth provider", + "description": "Test oAuth provider description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + ] + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..4924b6b5fd04 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_CreateCascadeDeleteJob.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "jobId": "Job123", + "farmerId": "Farmer123", + "oauthProviderId": "JOHNDEERE", + "api-version": "2021-03-31-preview" + }, + "responses": { + "202": { + "body": { + "farmerId": "Farmer123", + "resourceId": "JOHNDEERE", + "resourceType": "oauthtokeninfo", + "id": "Job123", + "status": "Waiting", + "message": "Created cascade delete job for 'oauthtokeninfo' resource with id 'JOHNDEERE' and farmerId 'Farmer123'.", + "createdDateTime": "2021-05-13T20:04:39Z", + "lastActionDateTime": "2021-05-13T20:04:39Z", + "startTime": "2021-05-13T20:04:37Z" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_GetCascadeDeleteJobDetails.json similarity index 76% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_GetCascadeDeleteJobDetails.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_GetCascadeDeleteJobDetails.json index 9a263d908ddf..dff4c27ebfd3 100644 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_GetCascadeDeleteJobDetails.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_GetCascadeDeleteJobDetails.json @@ -1,18 +1,18 @@ { "parameters": { "Endpoint": "{Endpoint}", - "jobId": "JOBID123", + "jobId": "Job123", "api-version": "2021-03-31-preview" }, "responses": { "200": { "body": { - "farmerId": "FARMER123", + "farmerId": "Farmer123", "resourceId": "JOHNDEERE", "resourceType": "oauthtokeninfo", - "id": "JOBID123", + "id": "Job123", "status": "Waiting", - "message": "Created cascade delete job for 'oauthtokeninfo' resource with id 'JOHNDEERE' and farmerId 'FARMER123'.", + "message": "Created cascade delete job for 'oauthtokeninfo' resource with id 'JOHNDEERE' and farmerId 'Farmer123'.", "createdDateTime": "2021-05-13T20:04:39Z", "lastActionDateTime": "2021-05-13T20:04:39Z", "startTime": "2021-05-13T20:04:37Z" diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_GetOAuthConnectionLink.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_GetOAuthConnectionLink.json similarity index 91% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_GetOAuthConnectionLink.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_GetOAuthConnectionLink.json index 31c435205661..cdded3a90641 100644 --- a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_GetOAuthConnectionLink.json +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_GetOAuthConnectionLink.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "api-version": "2021-03-31-preview", "body": { - "farmerId": "FARMER123", + "farmerId": "Farmer123", "oAuthProviderId": "JOHNDEERE", "userRedirectLink": "https://docs.microsoft.com", "userRedirectState": "code" diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_List.json new file mode 100644 index 000000000000..a1db524cb2e2 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/OAuthTokens_List.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "farmerId": "Farmer123", + "authProviderId": "JOHNDEERE", + "isValid": true, + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e", + "createdDateTime": "2021-04-22T18:49:25Z", + "modifiedDateTime": "2021-04-22T18:49:25Z" + } + ] + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..d55ceb369a18 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_CreateCascadeDeleteJob.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "Farmer123", + "plantingDataId": "Planting123", + "api-version": "2021-03-31-preview", + "jobId": "Job123" + }, + "responses": { + "202": { + "body": { + "farmerId": "Farmer123", + "resourceId": "Planting123", + "resourceType": "plantingdata", + "id": "Job123", + "status": "Waiting", + "message": "Created cascade delete job for 'plantingdata' resource with id 'Planting123' and farmerId 'Farmer123'.", + "createdDateTime": "2021-06-19T11:09:35Z", + "lastActionDateTime": "2021-06-19T11:09:35Z", + "startTime": "2021-06-19T11:09:35Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_CreateOrUpdate.json new file mode 100644 index 000000000000..66ce59f30a5f --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_CreateOrUpdate.json @@ -0,0 +1,168 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "farmerId": "Farmer123", + "plantingDataId": "Planting123", + "plantingData": { + "avgPlantingRate": { + "unit": "seedsperacre", + "value": 30 + }, + "totalMaterial": { + "unit": "seeds", + "value": 758814 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 25293 + }, + "plantingProductDetails": [ + { + "productName": "Product123", + "area": { + "unit": "acre", + "value": 20 + }, + "totalMaterial": { + "unit": "seeds", + "value": 389214 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 19460 + } + } + ], + "area": { + "unit": "acre", + "value": 30 + }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "status": "Active", + "name": "Test planting data", + "description": "Test planting data details", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + }, + "responses": { + "201": { + "body": { + "avgPlantingRate": { + "unit": "seedsperacre", + "value": 30.0 + }, + "totalMaterial": { + "unit": "seeds", + "value": 758814.0 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 25293.0 + }, + "plantingProductDetails": [ + { + "productName": "Product123", + "area": { + "unit": "acre", + "value": 20.0 + }, + "totalMaterial": { + "unit": "seeds", + "value": 389214.0 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 19460.0 + } + } + ], + "area": { + "unit": "acre", + "value": 30.0 + }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Planting123", + "eTag": "03002c6d-0000-0600-0000-60cdc7740000", + "status": "Active", + "createdDateTime": "2021-06-19T10:31:16Z", + "modifiedDateTime": "2021-06-19T10:31:16Z", + "name": "Test planting data", + "description": "Test planting data details", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + }, + "200": { + "body": { + "avgPlantingRate": { + "unit": "seedsperacre", + "value": 30.0 + }, + "totalMaterial": { + "unit": "seeds", + "value": 758814.0 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 25293.0 + }, + "plantingProductDetails": [ + { + "productName": "Product123", + "area": { + "unit": "acre", + "value": 20.0 + }, + "totalMaterial": { + "unit": "seeds", + "value": 389214.0 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 19460.0 + } + } + ], + "area": { + "unit": "acre", + "value": 30.0 + }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Planting123", + "eTag": "03002c6d-0000-0600-0000-60cdc7740000", + "status": "Active", + "createdDateTime": "2021-06-19T10:31:16Z", + "modifiedDateTime": "2021-06-19T10:31:16Z", + "name": "Test planting data", + "description": "Test planting data details", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_Delete.json new file mode 100644 index 000000000000..02a7b6acb22a --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "Farmer123", + "plantingDataId": "Planting123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_Get.json new file mode 100644 index 000000000000..c3b63e06ed10 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_Get.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "farmerId": "Farmer123", + "plantingDataId": "Planting123" + }, + "responses": { + "200": { + "body": { + "avgPlantingRate": { + "unit": "seedsperacre", + "value": 30.0 + }, + "totalMaterial": { + "unit": "seeds", + "value": 758814.0 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 25293.0 + }, + "plantingProductDetails": [ + { + "productName": "Product123", + "area": { + "unit": "acre", + "value": 20.0 + }, + "totalMaterial": { + "unit": "seeds", + "value": 389214.0 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 19460.0 + } + } + ], + "area": { + "unit": "acre", + "value": 30.0 + }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "attachmentsLink": "https://bb-prod-wcus-1.farmbeats.azure.net/farmer/Farmer123/attachments?api-version=2021-03-31-preview&resourceIds=Planting123&resourceTypes=PlantingData", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Planting123", + "eTag": "03002c6d-0000-0600-0000-60cdc7740000", + "status": "Active", + "createdDateTime": "2021-06-19T10:31:16Z", + "modifiedDateTime": "2021-06-19T10:31:16Z", + "name": "Test planting data", + "description": "Test planting data details", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..d9271c70f746 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_GetCascadeDeleteJobDetails.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "jobId": "Job123" + }, + "responses": { + "200": { + "body": { + "farmerId": "Farmer123", + "resourceId": "Planting123", + "resourceType": "plantingdata", + "id": "Job1234", + "status": "Succeeded", + "durationInSeconds": 2.73909, + "message": "Job completed successfully.", + "createdDateTime": "2021-06-19T11:09:35Z", + "lastActionDateTime": "2021-06-19T11:09:38Z", + "startTime": "2021-06-19T11:09:35Z", + "endTime": "2021-06-19T11:09:38Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_List.json new file mode 100644 index 000000000000..e04e6b9919c2 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_List.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "farmerId": "FARMER123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "avgPlantingRate": { + "unit": "seedsperacre", + "value": 30.0 + }, + "totalMaterial": { + "unit": "seeds", + "value": 758814.0 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 25293.0 + }, + "plantingProductDetails": [ + { + "productName": "Product123", + "area": { + "unit": "acre", + "value": 20.0 + }, + "totalMaterial": { + "unit": "seeds", + "value": 389214.0 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 19460.0 + } + } + ], + "area": { + "unit": "acre", + "value": 30.0 + }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "attachmentsLink": "https://bb-prod-wcus-1.farmbeats.azure.net/farmer/Farmer123/attachments?api-version=2021-03-31-preview&resourceIds=Planting123&resourceTypes=PlantingData", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Planting123", + "eTag": "03002c6d-0000-0600-0000-60cdc7740000", + "status": "Active", + "createdDateTime": "2021-06-19T10:31:16Z", + "modifiedDateTime": "2021-06-19T10:31:16Z", + "name": "Test planting data", + "description": "Test planting data details", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + ], + "nextLink": "https://test.farmbeats.azure.net/planting-data?api-version=2021-03-31-preview&$skipToken=2d7dad55-cfa9-4760-b198-0df17ec2fb65" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_ListByFarmerId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_ListByFarmerId.json new file mode 100644 index 000000000000..428296e0c1a7 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/PlantingData_ListByFarmerId.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "farmerId": "FARMER123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "avgPlantingRate": { + "unit": "seedsperacre", + "value": 30.0 + }, + "totalMaterial": { + "unit": "seeds", + "value": 758814.0 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 25293.0 + }, + "plantingProductDetails": [ + { + "productName": "Product123", + "area": { + "unit": "acre", + "value": 20.0 + }, + "totalMaterial": { + "unit": "seeds", + "value": 389214.0 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 19460.0 + } + } + ], + "area": { + "unit": "acre", + "value": 30.0 + }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "attachmentsLink": "https://bb-prod-wcus-1.farmbeats.azure.net/farmer/Farmer123/attachments?api-version=2021-03-31-preview&resourceIds=Planting123&resourceTypes=PlantingData", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Planting123", + "eTag": "03002c6d-0000-0600-0000-60cdc7740000", + "status": "Active", + "createdDateTime": "2021-06-19T10:31:16Z", + "modifiedDateTime": "2021-06-19T10:31:16Z", + "name": "Test planting data", + "description": "Test planting data details", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + ] + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_CreateSatelliteDataIngestionJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_CreateSatelliteDataIngestionJob.json new file mode 100644 index 000000000000..e2904fe8beb0 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_CreateSatelliteDataIngestionJob.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "jobId": "Job123", + "api-version": "2021-03-31-preview", + "body": { + "boundaryId": "Boundary123", + "endDateTime": "2021-04-16T10:14:12Z", + "farmerId": "Farmer123", + "startDateTime": "2020-04-16T10:14:12Z", + "provider": "Microsoft", + "source": "Sentinel_2_L2A", + "data": { + "imageFormats": [ + "TIF" + ], + "imageNames": [ + "NDVI" + ], + "imageResolutions": [ + 10.0 + ] + }, + "name": "Test satellite job", + "description": "Test satellite job details", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + }, + "responses": { + "202": { + "body": { + "farmerId": "Farmer123", + "boundaryId": "Boundary123", + "startDateTime": "2020-04-16T10:14:12Z", + "endDateTime": "2021-04-16T10:14:12Z", + "provider": "Microsoft", + "source": "Sentinel_2_L2A", + "data": { + "imageNames": [ + "NDVI" + ], + "imageFormats": [ + "TIF" + ], + "imageResolutions": [ + 10.0 + ] + }, + "id": "Job123", + "status": "Waiting", + "message": "Created job 'Job123' to fetch satellite data for boundary 'Boundary123' from startDate '04/16/2020' to endDate '04/16/2021' (both inclusive).", + "createdDateTime": "2021-06-19T15:30:50Z", + "lastActionDateTime": "2021-06-19T15:30:50Z", + "startTime": "2021-06-19T15:30:50Z", + "name": "Test satellite job", + "description": "Test satellite job details", + "properties": { + "region": "Central US", + "retailerId": 123 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_Download.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_Download.json new file mode 100644 index 000000000000..7323e0bd0174 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_Download.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "filePath": "Microsoft%2fSentinel_2_L2A%2fFarmer123%2fBoundary123%2f2021-04-16%2f00-00-00%2fndvi_10.tif", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": "101010101" + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_GetSatelliteDataIngestionJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_GetSatelliteDataIngestionJobDetails.json new file mode 100644 index 000000000000..3438c104e95a --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_GetSatelliteDataIngestionJobDetails.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "jobId": "Job123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "farmerId": "Farmer123", + "boundaryId": "Boundary123", + "startDateTime": "2020-04-16T10:14:12Z", + "endDateTime": "2021-04-16T10:14:12Z", + "provider": "Microsoft", + "source": "Sentinel_2_L2A", + "data": { + "imageNames": [ + "NDVI" + ], + "imageFormats": [ + "TIF" + ], + "imageResolutions": [ + 10.0 + ] + }, + "id": "Job123", + "status": "Succeeded", + "durationInSeconds": 14.2833851, + "message": "Satellite data is available for 73 days from provider in the requested date range. Successfully fetched data for 73 days.", + "createdDateTime": "2021-06-19T15:30:50Z", + "lastActionDateTime": "2021-06-19T15:31:04Z", + "startTime": "2021-06-19T15:30:50Z", + "endTime": "2021-06-19T15:31:04Z", + "name": "Test satellite job", + "description": "Test satellite job details", + "properties": { + "region": "Central US", + "retailerId": 123 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_List.json new file mode 100644 index 000000000000..6dbc301b029b --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Scenes_List.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "provider": "Microsoft", + "farmerId": "Farmer123", + "boundaryId": "Boundary123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sceneDateTime": "2021-04-16T00:00:00Z", + "provider": "Microsoft", + "source": "Sentinel_2_L2A", + "imageFiles": [ + { + "fileLink": "https://test.farmbeats.azure.net/scenes/downloadFiles?api-version=2021-03-31-preview&filePath=Microsoft%2fSentinel_2_L2A%2fFarmer123%2fBoundary123%2f2021-04-16%2f00-00-00%2fndvi_10.tif", + "name": "NDVI", + "resolution": 10.0 + } + ], + "imageFormat": "TIF", + "cloudCoverPercentage": 0.0, + "darkPixelPercentage": 0.0, + "ndviMedianValue": 0.43166860938072205, + "boundaryId": "Boundary123", + "farmerId": "Farmer123", + "id": "4e533975-5cfc-5b54-b216-6c6a0fdb387b", + "eTag": "03007b6d-0000-0600-0000-60ce0db80000" + }, + { + "sceneDateTime": "2021-04-11T00:00:00Z", + "provider": "Microsoft", + "source": "Sentinel_2_L2A", + "imageFiles": [ + { + "fileLink": "https://test.farmbeats.azure.net/scenes/downloadFiles?api-version=2021-03-31-preview&filePath=Microsoft%2fSentinel_2_L2A%2fFarmer123%2fBoundary123%2f2021-04-11%2f00-00-00%2fndvi_10.tif", + "name": "NDVI", + "resolution": 10.0 + } + ], + "imageFormat": "TIF", + "cloudCoverPercentage": 0.0, + "darkPixelPercentage": 0.0, + "ndviMedianValue": 0.41777390241622925, + "boundaryId": "Boundary123", + "farmerId": "Farmer123", + "id": "4ebdef7f-3ade-7750-0096-2c5024eb72c0", + "eTag": "0300796d-0000-0600-0000-60ce0db80000" + } + ], + "nextLink": "https://test.farmbeats.azure.net/scenes?provider=Microsoft&farmerId=Farmer123&boundaryId=Boundary123&source=Sentinel_2_L2A&api-version=2021-03-31-preview&$skipToken=W3sidG9rZW4iOiIrUklEOn5Qa1pRQU1teHVDWVVQZ0VBQUFBQUFBPT0jUlQ6MSNUUkM6NTAjUlREOm4rVGxTTDV1UEkzZjhDSUxkNys1QlRNeE16RXVNVGt1TVRwVk1URTdNVEU3TVRGYkFBPT0jSVNWOjIjSUVPOjY1NTY3I1FDRjo3I0ZQQzpBZXc5QVFBQUFBQUFORDRCQUFBQUFBQT0iLCJyYW5nZSI6eyJtaW4iOiIiLCJtYXgiOiIxRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRkZGRiJ9fV0" + } + } + } +} diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_CreateCascadeDeleteJob.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_CreateCascadeDeleteJob.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_CreateCascadeDeleteJob.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_CreateOrUpdate.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_CreateOrUpdate.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_CreateOrUpdate.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_Delete.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_Delete.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_Delete.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_Get.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_Get.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_Get.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_GetCascadeDeleteJobDetails.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_GetCascadeDeleteJobDetails.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_GetCascadeDeleteJobDetails.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_List.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_List.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_List.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_ListByFarmerId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_ListByFarmerId.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_ListByFarmerId.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/SeasonalFields_ListByFarmerId.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_CreateOrUpdate.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_CreateOrUpdate.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_CreateOrUpdate.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_Delete.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_Delete.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_Delete.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_Get.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_Get.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_Get.json diff --git a/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_List.json similarity index 100% rename from specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_List.json rename to specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Seasons_List.json diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..16ba808c4004 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_CreateCascadeDeleteJob.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "Farmer123", + "tillageDataId": "Tillage123", + "api-version": "2021-03-31-preview", + "jobId": "Job123" + }, + "responses": { + "202": { + "body": { + "farmerId": "Farmer123", + "resourceId": "Tillage123", + "resourceType": "tillagedata", + "id": "Job123", + "status": "Waiting", + "message": "Created cascade delete job for 'tillagedata' resource with id 'Tillage123' and farmerId 'Farmer123'.", + "createdDateTime": "2021-06-19T12:27:56Z", + "lastActionDateTime": "2021-06-19T12:27:56Z", + "startTime": "2021-06-19T12:27:56Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_CreateOrUpdate.json new file mode 100644 index 000000000000..7115dc5ceda2 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_CreateOrUpdate.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "farmerId": "Farmer123", + "tillageDataId": "Tillage123", + "tillageData": { + "tillageDepth": { + "unit": "cms", + "value": 9.5 + }, + "tillagePressure": { + "unit": "kg per sq cms", + "value": 950 + }, + "area": { + "unit": "acre", + "value": 30 + }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "status": "Active", + "name": "Test tillage data", + "description": "Test tillage data description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + }, + "responses": { + "201": { + "body": { + "tillageDepth": { + "unit": "cms", + "value": 9.5 + }, + "tillagePressure": { + "unit": "kg per sq cms", + "value": 950.0 + }, + "area": { + "unit": "acre", + "value": 30.0 + }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Tillage123", + "eTag": "02002e9d-0000-0600-0000-60cdddc00000", + "status": "Active", + "createdDateTime": "2021-06-19T12:06:24Z", + "modifiedDateTime": "2021-06-19T12:06:24Z", + "name": "Test tillage data", + "description": "Test tillage data description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + }, + "200": { + "body": { + "tillageDepth": { + "unit": "cms", + "value": 9.5 + }, + "tillagePressure": { + "unit": "kg per sq cms", + "value": 950.0 + }, + "area": { + "unit": "acre", + "value": 30.0 + }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Tillage123", + "eTag": "02002e9d-0000-0600-0000-60cdddc00000", + "status": "Active", + "createdDateTime": "2021-06-19T12:06:24Z", + "modifiedDateTime": "2021-06-19T12:06:24Z", + "name": "Test tillage data", + "description": "Test tillage data description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_Delete.json new file mode 100644 index 000000000000..052a95b5a0cd --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "Farmer123", + "tillageDataId": "Tillage123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_Get.json new file mode 100644 index 000000000000..4e70cbc636c1 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_Get.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "farmerId": "Farmer123", + "tillageDataId": "Tillage123" + }, + "responses": { + "200": { + "body": { + "tillageDepth": { + "unit": "cms", + "value": 9.5 + }, + "tillagePressure": { + "unit": "kg per sq cms", + "value": 950.0 + }, + "area": { + "unit": "acre", + "value": 30.0 + }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "attachmentsLink": "https://bb-prod-wcus-1.farmbeats.azure.net/farmer/Farmer123/attachments?api-version=2021-03-31-preview&resourceIds=Tillage123&resourceTypes=TillageData", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Tillage123", + "eTag": "02002e9d-0000-0600-0000-60cdddc00000", + "status": "Active", + "createdDateTime": "2021-06-19T12:06:24Z", + "modifiedDateTime": "2021-06-19T12:06:24Z", + "name": "Test tillage data", + "description": "Test tillage data description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..f8bdc2c408b1 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_GetCascadeDeleteJobDetails.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "jobId": "Job123" + }, + "responses": { + "200": { + "body": { + "farmerId": "Farmer123", + "resourceId": "Tillage123", + "resourceType": "tillagedata", + "id": "Job1234", + "status": "Succeeded", + "durationInSeconds": 2.73909, + "message": "Job completed successfully.", + "createdDateTime": "2021-06-19T11:09:35Z", + "lastActionDateTime": "2021-06-19T11:09:38Z", + "startTime": "2021-06-19T11:09:35Z", + "endTime": "2021-06-19T11:09:38Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_List.json new file mode 100644 index 000000000000..45b28cb2a4e9 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_List.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "farmerId": "Farmer123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "tillageDepth": { + "unit": "cms", + "value": 9.5 + }, + "tillagePressure": { + "unit": "kg per sq cms", + "value": 950.0 + }, + "area": { + "unit": "acre", + "value": 30.0 + }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "attachmentsLink": "https://bb-prod-wcus-1.farmbeats.azure.net/farmer/Farmer123/attachments?api-version=2021-03-31-preview&resourceIds=Tillage123&resourceTypes=TillageData", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Tillage123", + "eTag": "02002e9d-0000-0600-0000-60cdddc00000", + "status": "Active", + "createdDateTime": "2021-06-19T12:06:24Z", + "modifiedDateTime": "2021-06-19T12:06:24Z", + "name": "Test tillage data", + "description": "Test tillage data description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + ], + "nextLink": "https://test.farmbeats.azure.net/planting-data?api-version=2021-03-31-preview&$skipToken=2d7dad55-cfa9-4760-b198-0df17ec2fb65" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_ListByFarmerId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_ListByFarmerId.json new file mode 100644 index 000000000000..62c94adf2f67 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/TillageData_ListByFarmerId.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "api-version": "2021-03-31-preview", + "farmerId": "Farmer123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "tillageDepth": { + "unit": "cms", + "value": 9.5 + }, + "tillagePressure": { + "unit": "kg per sq cms", + "value": 950.0 + }, + "area": { + "unit": "acre", + "value": 30.0 + }, + "source": "Manual", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "attachmentsLink": "https://bb-prod-wcus-1.farmbeats.azure.net/farmer/Farmer123/attachments?api-version=2021-03-31-preview&resourceIds=Tillage123&resourceTypes=TillageData", + "associatedBoundaryId": "AssociatedBoundary123", + "operationBoundaryId": "OperationBoundary123", + "farmerId": "Farmer123", + "id": "Tillage123", + "eTag": "02002e9d-0000-0600-0000-60cdddc00000", + "status": "Active", + "createdDateTime": "2021-06-19T12:06:24Z", + "modifiedDateTime": "2021-06-19T12:06:24Z", + "name": "Test tillage data", + "description": "Test tillage data description", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + ] + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_CreateDataDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_CreateDataDeleteJob.json new file mode 100644 index 000000000000..e17fd42cf841 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_CreateDataDeleteJob.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "jobId": "Job123", + "api-version": "2021-03-31-preview", + "body": { + "boundaryId": "Boundary123", + "extensionId": "DTN.ClearAg", + "farmerId": "Farmer123", + "weatherDataType": "historical", + "granularity": "daily", + "name": "Test delete weather job", + "description": "Test delete weather job details", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + }, + "responses": { + "202": { + "body": { + "extensionId": "DTN.ClearAg", + "farmerId": "Farmer123", + "boundaryId": "Boundary123", + "weatherDataType": "historical", + "granularity": "daily", + "id": "Job123", + "status": "Waiting", + "message": "Created weather data delete job for farmer id 'Farmer123', boundary id 'Boundary123' and extension id 'DTN.ClearAg'", + "createdDateTime": "2021-06-19T15:13:15Z", + "lastActionDateTime": "2021-06-19T15:13:15Z", + "startTime": "2021-06-19T15:13:15Z", + "name": "Test delete weather job", + "description": "Test delete weather job details", + "properties": { + "region": "Central US", + "retailerId": 123 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_CreateDataIngestionJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_CreateDataIngestionJob.json new file mode 100644 index 000000000000..3a004def2cd2 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_CreateDataIngestionJob.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "jobId": "Job123", + "api-version": "2021-03-31-preview", + "body": { + "boundaryId": "Boundary123", + "extensionApiInput": { + "location": "47.922759,-97.089954", + "start": "1606262400", + "end": "1606780800" + }, + "extensionApiName": "dailyhistorical", + "extensionId": "DTN.ClearAg", + "farmerId": "Farmer123", + "extensionDataProviderAppId": "12...ca0", + "extensionDataProviderApiKey": "c743a0f....1eed0709", + "name": "Test weather job", + "description": "Test weather job details", + "properties": { + "Region": "Central US", + "RetailerId": 123 + } + } + }, + "responses": { + "202": { + "body": { + "boundaryId": "Boundary123", + "farmerId": "Farmer123", + "extensionId": "DTN.ClearAg", + "extensionApiName": "dailyhistorical", + "extensionApiInput": { + "location": "47.922759,-97.089954", + "start": "1606262400", + "end": "1606780800" + }, + "id": "Job123", + "status": "Waiting", + "message": "Created job 'Job123' to fetch weather data for farmer id 'Farmer123' and boundary id 'Boundary123'.", + "createdDateTime": "2021-06-19T14:52:22Z", + "lastActionDateTime": "2021-06-19T14:52:22Z", + "startTime": "2021-06-19T14:52:22Z", + "name": "Test weather job", + "description": "Test weather job details", + "properties": { + "region": "Central US", + "retailerId": 123 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_GetDataDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_GetDataDeleteJobDetails.json new file mode 100644 index 000000000000..ca4050c0b333 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_GetDataDeleteJobDetails.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "jobId": "Job123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "extensionId": "DTN.ClearAg", + "farmerId": "Farmer123", + "boundaryId": "Boundary123", + "weatherDataType": "historical", + "granularity": "daily", + "id": "Job123", + "status": "Succeeded", + "durationInSeconds": 2.7015882, + "message": "Created weather data delete job for farmer id 'Farmer123', boundary id 'Boundary123' and extension id 'DTN.ClearAg'", + "createdDateTime": "2021-06-19T15:13:15Z", + "lastActionDateTime": "2021-06-19T15:13:18Z", + "startTime": "2021-06-19T15:13:15Z", + "endTime": "2021-06-19T15:13:18Z", + "name": "Test delete weather job", + "description": "Test delete weather job details", + "properties": { + "region": "Central US", + "retailerId": 123 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_GetDataIngestionJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_GetDataIngestionJobDetails.json new file mode 100644 index 000000000000..14a80af2347c --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_GetDataIngestionJobDetails.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "jobId": "Job123", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "boundaryId": "Boundary123", + "farmerId": "Farmer123", + "extensionId": "DTN.ClearAg", + "extensionApiName": "dailyhistorical", + "extensionApiInput": { + "location": "47.922759,-97.089954", + "start": "1606262400", + "end": "1606780800" + }, + "id": "Job123", + "status": "Succeeded", + "durationInSeconds": 2.9322843, + "message": "Weather data available from '11/25/2020 00:00:00' to '11/30/2020 00:00:00'.", + "createdDateTime": "2021-06-19T14:52:22Z", + "lastActionDateTime": "2021-06-19T14:52:25Z", + "startTime": "2021-06-19T14:52:22Z", + "endTime": "2021-06-19T14:52:25Z", + "name": "Test weather job", + "description": "Test weather job details", + "properties": { + "region": "Central US", + "retailerId": 123 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_List.json new file mode 100644 index 000000000000..1ee1d1fc9f3a --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples/Weather_List.json @@ -0,0 +1,186 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "farmerId": "Farmer123", + "boundaryId": "Boundary123", + "extensionId": "DTN.ClearAg", + "weatherDataType": "historical", + "granularity": "daily", + "api-version": "2021-03-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "farmerId": "Farmer123", + "boundaryId": "Boundary123", + "extensionId": "DTN.ClearAg", + "location": { + "latitude": 47.922759, + "longitude": -97.089954 + }, + "dateTime": "2020-11-30T00:00:00Z", + "unitSystemCode": "us-std", + "extensionVersion": "1.0", + "weatherDataType": "historical", + "granularity": "daily", + "cloudCover": { + "unit": "%", + "value": 10.2 + }, + "dewPoint": { + "unit": "F", + "value": 12.0 + }, + "precipitation": { + "unit": "in", + "value": 0.0 + }, + "relativeHumidity": { + "unit": "%", + "value": 70.0 + }, + "temperature": { + "unit": "F", + "value": 21.0 + }, + "visibility": { + "unit": "mi", + "value": 10.0 + }, + "windGust": { + "unit": "mph", + "value": 26.0 + }, + "windSpeed": { + "unit": "mph", + "value": 12.0 + }, + "id": "b947d00f-5078-9bfa-f97a-1ef1ce54756a", + "eTag": "03002f6d-0000-0600-0000-60ce04a90000", + "createdDateTime": "2021-06-19T14:52:25Z", + "modifiedDateTime": "2021-06-19T14:52:25Z", + "properties": { + "airTempMax": { + "unit": "F", + "value": 35.0 + }, + "airTempMin": { + "unit": "F", + "value": 10.0 + }, + "cloudCoverMax": { + "unit": "%", + "value": 59.7 + }, + "cloudCoverMin": { + "unit": "%", + "value": 0.0 + }, + "cloudCoverAvgDescriptor": "Sunny", + "cloudCoverMaxDescriptor": "Partly Cloudy", + "cloudCoverMinDescriptor": "Sunny", + "dewPointMax": { + "unit": "F", + "value": 18.0 + }, + "dewPointMin": { + "unit": "F", + "value": 6.0 + }, + "iceAccPeriod": { + "unit": "in", + "value": 0.0 + }, + "liquidAccPeriod": { + "unit": "in", + "value": 0.0 + }, + "longWaveRadiationAvg": { + "unit": "W/m^2", + "value": 210.0 + }, + "longWaveRadiationMax": { + "unit": "W/m^2", + "value": 264.0 + }, + "longWaveRadiationMin": { + "unit": "W/m^2", + "value": 173.0 + }, + "petPeriod": { + "unit": "in", + "value": 0.02 + }, + "precipAccPeriodAdjusted": { + "unit": "%", + "value": 0.0 + }, + "precipAccPeriodRaw": { + "unit": "%", + "value": 0.0 + }, + "relativeHumidityMax": { + "unit": "%", + "value": 82.0 + }, + "relativeHumidityMin": { + "unit": "%", + "value": 46.0 + }, + "shortWaveRadiationAvg": { + "unit": "W/m^2", + "value": 44.0 + }, + "shortWaveRadiationMax": { + "unit": "W/m^2", + "value": 220.0 + }, + "shortWaveRadiationMin": { + "unit": "W/m^2", + "value": 0.0 + }, + "snowAccPeriod": { + "unit": "in", + "value": 0.0 + }, + "sunshineDuration": { + "unit": "hours", + "value": 2.0 + }, + "visibilityMax": { + "unit": "mi", + "value": 10.0 + }, + "visibilityMin": { + "unit": "mi", + "value": 10.0 + }, + "windSpeed2mAvg": { + "unit": "mph", + "value": 9.0 + }, + "windSpeed2mMax": { + "unit": "mph", + "value": 14.0 + }, + "windSpeed2mMin": { + "unit": "mph", + "value": 4.0 + }, + "windSpeedMax": { + "unit": "mph", + "value": 18.0 + }, + "windSpeedMin": { + "unit": "mph", + "value": 5.0 + } + } + } + ] + } + } + } +} diff --git a/specification/agfood/data-plane/readme.md b/specification/agrifood/data-plane/readme.md similarity index 100% rename from specification/agfood/data-plane/readme.md rename to specification/agrifood/data-plane/readme.md diff --git a/specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json b/specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json new file mode 100644 index 000000000000..09e106523d9b --- /dev/null +++ b/specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json @@ -0,0 +1,1200 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure AgriFood RP Service", + "description": "APIs documentation for Azure AgriFood Resource Provider Service.", + "version": "2020-05-12-preview" + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/extensions/{extensionId}": { + "put": { + "tags": [ + "Extensions" + ], + "description": "Install extension.", + "operationId": "Extensions_Create", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ExtensionIdParameter" + }, + { + "$ref": "#/parameters/FarmBeatsResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Extension" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Extensions_Create": { + "$ref": "./examples/Extensions_Create.json" + } + } + }, + "get": { + "tags": [ + "Extensions" + ], + "description": "Get installed extension details by extension id.", + "operationId": "Extensions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ExtensionIdParameter" + }, + { + "$ref": "#/parameters/FarmBeatsResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Extension" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Extensions_Get": { + "$ref": "./examples/Extensions_Get.json" + } + } + }, + "patch": { + "tags": [ + "Extensions" + ], + "description": "Upgrade to latest extension.", + "operationId": "Extensions_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ExtensionIdParameter" + }, + { + "$ref": "#/parameters/FarmBeatsResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Extension" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Extensions_Update": { + "$ref": "./examples/Extensions_Update.json" + } + } + }, + "delete": { + "tags": [ + "Extensions" + ], + "description": "Uninstall extension.", + "operationId": "Extensions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ExtensionIdParameter" + }, + { + "$ref": "#/parameters/FarmBeatsResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Extensions_Delete": { + "$ref": "./examples/Extensions_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/extensions": { + "get": { + "tags": [ + "Extensions" + ], + "description": "Get installed extensions details.", + "operationId": "Extensions_ListByFarmBeats", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FarmBeatsResourceNameParameter" + }, + { + "in": "query", + "name": "extensionIds", + "description": "Installed extension ids.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "extensionCategories", + "description": "Installed extension categories.", + "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" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ExtensionListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Extensions_ListByFarmBeats": { + "$ref": "./examples/Extensions_ListByFarmBeats.json" + } + } + } + }, + "/providers/Microsoft.AgFoodPlatform/farmBeatsExtensionDefinitions": { + "get": { + "tags": [ + "FarmBeatsExtensions" + ], + "description": "Get list of farmBeats extension.", + "operationId": "FarmBeatsExtensions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "farmBeatsExtensionIds", + "description": "FarmBeatsExtension ids.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "farmBeatsExtensionNames", + "description": "FarmBeats extension names.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "extensionCategories", + "description": "Extension categories.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "publisherIds", + "description": "Publisher 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 + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FarmBeatsExtensionListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "FarmBeatsExtensions_List": { + "$ref": "./examples/FarmBeatsExtensions_List.json" + } + } + } + }, + "/providers/Microsoft.AgFoodPlatform/farmBeatsExtensionDefinitions/{farmBeatsExtensionId}": { + "get": { + "tags": [ + "FarmBeatsExtensions" + ], + "description": "Get farmBeats extension.", + "operationId": "FarmBeatsExtensions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmBeatsExtensionId", + "description": "farmBeatsExtensionId to be queried.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FarmBeatsExtension" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "FarmBeatsExtensions_Get": { + "$ref": "./examples/FarmBeatsExtensions_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}": { + "get": { + "tags": [ + "FarmBeatsModels" + ], + "description": "Get FarmBeats resource.", + "operationId": "FarmBeatsModels_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FarmBeatsResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FarmBeats" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "FarmBeatsModels_Get": { + "$ref": "./examples/FarmBeatsModels_Get.json" + } + } + }, + "put": { + "tags": [ + "FarmBeatsModels" + ], + "description": "Create or update FarmBeats resource.", + "operationId": "FarmBeatsModels_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/FarmBeatsResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "FarmBeats resource create or update request object.", + "required": true, + "schema": { + "$ref": "#/definitions/FarmBeats" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FarmBeats" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FarmBeats" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "FarmBeatsModels_CreateOrUpdate": { + "$ref": "./examples/FarmBeatsModels_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "FarmBeatsModels" + ], + "description": "Update a FarmBeats resource.", + "operationId": "FarmBeatsModels_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/FarmBeatsResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Request object.", + "required": true, + "schema": { + "$ref": "#/definitions/FarmBeatsUpdateRequestModel" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FarmBeats" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "FarmBeatsModels_Update": { + "$ref": "./examples/FarmBeatsModels_Update.json" + } + } + }, + "delete": { + "tags": [ + "FarmBeatsModels" + ], + "description": "Delete a FarmBeats resource.", + "operationId": "FarmBeatsModels_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FarmBeatsResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "FarmBeatsModels_Delete": { + "$ref": "./examples/FarmBeatsModels_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AgFoodPlatform/farmBeats": { + "get": { + "tags": [ + "FarmBeatsModels" + ], + "description": "Lists the FarmBeats instances for a subscription.", + "operationId": "FarmBeatsModels_ListBySubscription", + "produces": [ + "application/json" + ], + "parameters": [ + { + "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" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FarmBeatsListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "FarmBeatsModels_ListBySubscription": { + "$ref": "./examples/FarmBeatsModels_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats": { + "get": { + "tags": [ + "FarmBeatsModels" + ], + "description": "Lists the FarmBeats instances for a resource group.", + "operationId": "FarmBeatsModels_ListByResourceGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "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": "Continuation token for getting next set of results.", + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FarmBeatsListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "FarmBeatsModels_ListByResourceGroup": { + "$ref": "./examples/FarmBeatsModels_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AgFoodPlatform/checkNameAvailability": { + "post": { + "tags": [ + "Locations" + ], + "description": "Checks the name availability of the resource with requested resource name.", + "operationId": "Locations_CheckNameAvailability", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "NameAvailabilityRequest object.", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/CheckNameAvailabilityRequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/CheckNameAvailabilityResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Locations_CheckNameAvailability_AlreadyExists": { + "$ref": "./examples/Locations_CheckNameAvailability_AlreadyExists.json" + }, + "Locations_CheckNameAvailability_Available": { + "$ref": "./examples/Locations_CheckNameAvailability_Available.json" + } + } + } + }, + "/providers/Microsoft.AgFoodPlatform/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists the available operations of Microsoft.AgFoodPlatform resource provider.", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + } + }, + "definitions": { + "ExtensionProperties": { + "description": "Extension resource properties.", + "type": "object", + "properties": { + "extensionId": { + "description": "Extension Id.", + "pattern": "^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$", + "type": "string", + "readOnly": true + }, + "extensionCategory": { + "description": "Extension category. e.g. weather/sensor/satellite.", + "type": "string", + "readOnly": true + }, + "installedExtensionVersion": { + "description": "Installed extension version.", + "pattern": "^([1-9]|10).\\d$", + "type": "string", + "readOnly": true + }, + "extensionAuthLink": { + "description": "Extension auth link.", + "type": "string", + "readOnly": true + }, + "extensionApiDocsLink": { + "description": "Extension api docs link.", + "type": "string", + "readOnly": true + } + } + }, + "Extension": { + "description": "Extension resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + }, + "properties": { + "$ref": "#/definitions/ExtensionProperties", + "x-ms-client-flatten": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "ExtensionListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Extension" + } + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string", + "readOnly": true + } + } + }, + "UnitSystemsInfo": { + "description": "Unit systems info for the data provider.", + "required": [ + "key", + "values" + ], + "type": "object", + "properties": { + "key": { + "description": "UnitSystem key sent as part of ProviderInput.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "values": { + "description": "List of unit systems supported by this data provider.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DetailedInformation": { + "description": "Model to capture detailed information for farmBeatsExtensions.", + "type": "object", + "properties": { + "apiName": { + "description": "ApiName available for the farmBeatsExtension.", + "type": "string", + "example": "dailyforecast, dailyhistorical." + }, + "customParameters": { + "description": "List of customParameters.", + "type": "array", + "items": { + "type": "string" + } + }, + "platformParameters": { + "description": "List of platformParameters.", + "type": "array", + "items": { + "type": "string" + } + }, + "unitsSupported": { + "$ref": "#/definitions/UnitSystemsInfo" + }, + "apiInputParameters": { + "description": "List of apiInputParameters.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "FarmBeatsExtensionProperties": { + "description": "FarmBeatsExtension properties.", + "type": "object", + "properties": { + "targetResourceType": { + "description": "Target ResourceType of the farmBeatsExtension.", + "type": "string", + "readOnly": true + }, + "farmBeatsExtensionId": { + "description": "FarmBeatsExtension ID.", + "maxLength": 100, + "minLength": 2, + "pattern": "^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$", + "type": "string", + "readOnly": true + }, + "farmBeatsExtensionName": { + "description": "FarmBeatsExtension name.", + "maxLength": 100, + "minLength": 2, + "type": "string", + "readOnly": true + }, + "farmBeatsExtensionVersion": { + "description": "FarmBeatsExtension version.", + "maxLength": 100, + "minLength": 2, + "pattern": "^([1-9]|10).\\d$", + "type": "string", + "readOnly": true + }, + "publisherId": { + "description": "Publisher ID.", + "maxLength": 100, + "minLength": 2, + "type": "string", + "readOnly": true + }, + "description": { + "description": "Textual description.", + "maxLength": 500, + "minLength": 2, + "type": "string", + "readOnly": true + }, + "extensionCategory": { + "description": "Category of the extension. e.g. weather/sensor/satellite.", + "maxLength": 100, + "minLength": 2, + "type": "string", + "readOnly": true + }, + "extensionAuthLink": { + "description": "FarmBeatsExtension auth link.", + "type": "string", + "readOnly": true + }, + "extensionApiDocsLink": { + "description": "FarmBeatsExtension api docs link.", + "type": "string", + "readOnly": true + }, + "detailedInformation": { + "description": "Detailed information which shows summary of requested data.\r\nUsed in descriptive get extension metadata call.\r\nInformation for weather category per api included are apisSupported,\r\ncustomParameters, PlatformParameters and Units supported.", + "type": "array", + "items": { + "$ref": "#/definitions/DetailedInformation" + }, + "readOnly": true + } + } + }, + "FarmBeatsExtension": { + "description": "FarmBeats extension resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + }, + "properties": { + "$ref": "#/definitions/FarmBeatsExtensionProperties", + "x-ms-client-flatten": true + } + }, + "x-ms-azure-resource": true + }, + "FarmBeatsExtensionListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/FarmBeatsExtension" + } + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string", + "readOnly": true + } + } + }, + "FarmBeatsProperties": { + "description": "FarmBeats ARM Resource properties.", + "type": "object", + "properties": { + "instanceUri": { + "format": "uri", + "description": "Uri of the FarmBeats instance.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "FarmBeats instance provisioning state.", + "enum": [ + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + } + } + }, + "FarmBeats": { + "description": "FarmBeats ARM Resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + }, + "properties": { + "$ref": "#/definitions/FarmBeatsProperties", + "x-ms-client-flatten": true + } + }, + "x-ms-azure-resource": true + }, + "FarmBeatsUpdateRequestModel": { + "description": "FarmBeats update request.", + "type": "object", + "properties": { + "location": { + "description": "Geo-location where the resource lives.", + "type": "string" + }, + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "FarmBeatsListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "uniqueItems": false, + "items": { + "$ref": "#/definitions/FarmBeats" + } + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "FarmBeatsResourceNameParameter": { + "in": "path", + "name": "farmBeatsResourceName", + "description": "FarmBeats resource name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ExtensionIdParameter": { + "in": "path", + "name": "extensionId", + "description": "Id of extension resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] +} diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_Create.json b/specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_Create.json similarity index 100% rename from specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_Create.json rename to specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_Create.json diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_Delete.json b/specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_Delete.json similarity index 100% rename from specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_Delete.json rename to specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_Delete.json diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_Get.json b/specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_Get.json similarity index 100% rename from specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_Get.json rename to specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_Get.json diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_ListByFarmBeats.json b/specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_ListByFarmBeats.json similarity index 100% rename from specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_ListByFarmBeats.json rename to specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_ListByFarmBeats.json diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_Update.json b/specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_Update.json similarity index 100% rename from specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_Update.json rename to specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_Update.json diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsExtensions_Get.json b/specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsExtensions_Get.json similarity index 100% rename from specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsExtensions_Get.json rename to specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsExtensions_Get.json diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsExtensions_List.json b/specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsExtensions_List.json similarity index 100% rename from specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsExtensions_List.json rename to specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsExtensions_List.json diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_CreateOrUpdate.json b/specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_CreateOrUpdate.json similarity index 100% rename from specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_CreateOrUpdate.json rename to specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_CreateOrUpdate.json diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_Delete.json b/specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_Delete.json similarity index 100% rename from specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_Delete.json rename to specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_Delete.json diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_Get.json b/specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_Get.json similarity index 100% rename from specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_Get.json rename to specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_Get.json diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_ListByResourceGroup.json b/specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_ListByResourceGroup.json similarity index 100% rename from specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_ListByResourceGroup.json rename to specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_ListByResourceGroup.json diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_ListBySubscription.json b/specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_ListBySubscription.json similarity index 100% rename from specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_ListBySubscription.json rename to specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_ListBySubscription.json diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_Update.json b/specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_Update.json similarity index 100% rename from specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_Update.json rename to specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_Update.json diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Locations_CheckNameAvailability_AlreadyExists.json b/specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Locations_CheckNameAvailability_AlreadyExists.json similarity index 100% rename from specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Locations_CheckNameAvailability_AlreadyExists.json rename to specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Locations_CheckNameAvailability_AlreadyExists.json diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Locations_CheckNameAvailability_Available.json b/specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Locations_CheckNameAvailability_Available.json similarity index 100% rename from specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Locations_CheckNameAvailability_Available.json rename to specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Locations_CheckNameAvailability_Available.json diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Operations_List.json b/specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Operations_List.json similarity index 100% rename from specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Operations_List.json rename to specification/agrifood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Operations_List.json diff --git a/specification/agrifood/resource-manager/readme.csharp.md b/specification/agrifood/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..e43f57857a1f --- /dev/null +++ b/specification/agrifood/resource-manager/readme.csharp.md @@ -0,0 +1,15 @@ +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true + client-side-validation: false + namespace: Microsoft.Azure.Management.AgriFood + output-folder: $(csharp-sdks-folder)/agrifood/Microsoft.Azure.Management.AgriFood/src/Generated +``` diff --git a/specification/agrifood/resource-manager/readme.go.md b/specification/agrifood/resource-manager/readme.go.md new file mode 100644 index 000000000000..7acfd99fba12 --- /dev/null +++ b/specification/agrifood/resource-manager/readme.go.md @@ -0,0 +1,11 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) && $(track2) +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/agrifood/armagrifood +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) +azure-arm: true +``` diff --git a/specification/agrifood/resource-manager/readme.md b/specification/agrifood/resource-manager/readme.md new file mode 100644 index 000000000000..0ba226c8c8ee --- /dev/null +++ b/specification/agrifood/resource-manager/readme.md @@ -0,0 +1,105 @@ +# agfood + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for agfood. + +## 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 agrifood. + +```yaml +openapi-type: arm +tag: package-2020-05-12-preview +``` + +### Tag: package-2020-05-12-preview + +These settings apply only when `--tag=package-2020-05-12-preview` is specified on the command line. + +```yaml $(tag) == 'package-2020-05-12-preview' +input-file: + - Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-js +``` +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) + +## Suppression + +``` yaml +directive: + - from: agfood.json + suppress: R3006 # BodyTopLevelProperties + where: $.definitions.FarmBeats.properties + reason: Currently systemData is not allowed. + - from: agfood.json + suppress: R3006 # BodyTopLevelProperties + where: $.definitions.Extension.properties + reason: Currently systemData is not allowed. + - from: agfood.json + suppress: R3018 # EnumInsteadOfBoolean + where: + - $.definitions.Operation.properties.isDataAction + - $.definitions.CheckNameAvailabilityResult.properties.nameAvailable + reason: Booleans are used to indicate binary states of the property, enum is not appropriate. + - from: agfood.json + suppress: R4000 # DescriptionAndTitleMissing + where: + - $.definitions.Error.properties.innererror + - $.definitions.ErrorResponse.properties.error + - $.definitions.Extension.properties.properties + - $.definitions.Extension.properties.systemData + - $.definitions.FarmBeats.properties.properties + - $.definitions.FarmBeats.properties.systemData + - $.definitions.InnerError.properties.innererror + - $.definitions.Operation.properties.display + reason: Model has description added in it's schema. + - from: types.json + suppress: R4000 # DescriptionAndTitleMissing + where: $.definitions.Resource + reason: Common type models are inherited. +``` diff --git a/specification/agrifood/resource-manager/readme.python.md b/specification/agrifood/resource-manager/readme.python.md new file mode 100644 index 000000000000..8d1ac3775c76 --- /dev/null +++ b/specification/agrifood/resource-manager/readme.python.md @@ -0,0 +1,23 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(python) && $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +namespace: azure.mgmt.agrifood +package-name: azure-mgmt-agrifood +package-version: 1.0.0b1 +clear-output-folder: true +``` + +``` yaml $(python) && $(python-mode) == 'update' && $(track2) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/agrifood/azure-mgmt-agrifood/azure/mgmt/agrifood +``` + +``` yaml $(python) && $(python-mode) == 'create' && $(track2) +basic-setup-py: true +output-folder: $(python-sdks-folder)/agrifood/azure-mgmt-agrifood +``` diff --git a/specification/agrifood/resource-manager/readme.typescript.md b/specification/agrifood/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..b6ecbc0290a9 --- /dev/null +++ b/specification/agrifood/resource-manager/readme.typescript.md @@ -0,0 +1,15 @@ +## 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 + license-header: MICROSOFT_MIT_NO_VERSION + package-name: "@azure/arm-agrifood" + output-folder: "$(typescript-sdks-folder)/sdk/agrifood/arm-agrifood" + payload-flattening-threshold: 1 + clear-output-folder: true + generate-metadata: true +``` diff --git a/specification/alertsmanagement/resource-manager/readme.md b/specification/alertsmanagement/resource-manager/readme.md index fff705d11ce5..980821a0c9d2 100644 --- a/specification/alertsmanagement/resource-manager/readme.md +++ b/specification/alertsmanagement/resource-manager/readme.md @@ -147,7 +147,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-libraries-for-java - repo: azure-sdk-for-go diff --git a/specification/alertsmanagement/resource-manager/readme.python.md b/specification/alertsmanagement/resource-manager/readme.python.md index 4617043919d7..c0946a274a69 100644 --- a/specification/alertsmanagement/resource-manager/readme.python.md +++ b/specification/alertsmanagement/resource-manager/readme.python.md @@ -4,47 +4,28 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.alertsmanagement - package-name: azure-mgmt-alertsmanagement - clear-output-folder: true -``` ``` yaml $(python) && $(track2) -python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.alertsmanagement package-name: azure-mgmt-alertsmanagement package-version: 1.0.0b1 clear-output-folder: true -modelerfour: - lenient-model-deduplication: true ``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/alertsmanagement/azure-mgmt-alertsmanagement/azure/mgmt/alertsmanagement -``` ``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/alertsmanagement/azure-mgmt-alertsmanagement/azure/mgmt/alertsmanagement ``` -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/alertsmanagement/azure-mgmt-alertsmanagement -``` - ``` yaml $(python) && $(python-mode) == 'create' && $(track2) basic-setup-py: true output-folder: $(python-sdks-folder)/alertsmanagement/azure-mgmt-alertsmanagement +``` + +``` yaml $(python) && $(track2) +modelerfour: + lenient-model-deduplication: true ``` \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2021-01-01-preview/definitions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2021-01-01-preview/definitions.json index d6d917f5d309..e7cef40ed991 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2021-01-01-preview/definitions.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2021-01-01-preview/definitions.json @@ -4986,16 +4986,7 @@ "description": "API Schema create or update contract Properties." }, "SchemaDocumentProperties": { - "properties": { - "value": { - "type": "string", - "description": "Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI." - }, - "definitions": { - "type": "object", - "description": "Types definitions. Used for Swagger/OpenAPI schemas only, null otherwise." - } - }, + "type": "object", "description": "Schema Document Properties." }, "SubscriptionCollection": { diff --git a/specification/apimanagement/resource-manager/readme.az.md b/specification/apimanagement/resource-manager/readme.az.md new file mode 100644 index 000000000000..35e571b5dfd0 --- /dev/null +++ b/specification/apimanagement/resource-manager/readme.az.md @@ -0,0 +1,19 @@ +## AZ + +These settings apply only when `--az` is specified on the command line. + +``` yaml $(az) && $(target-mode) == 'core' +tag: package-preview-2021-01 +az: + extensions: apim + namespace: azure.mgmt.apimanagement + package-name: azure-mgmt-apimanagement +az-output-folder: $(azure-cli-folder)/src/azure-cli/azure/cli/command_modules/apim +python-sdk-output-folder: $(az-output-folder)/vendored_sdks/apimanagement +cli: + cli-directive: + - where: + group: "*" + op: "*" + hidden: true +``` \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/readme.cli.md b/specification/apimanagement/resource-manager/readme.cli.md new file mode 100644 index 000000000000..179636a56760 --- /dev/null +++ b/specification/apimanagement/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/apimanagement/resource-manager/readme.go.md b/specification/apimanagement/resource-manager/readme.go.md index 9a8ab0f515d6..4c8cf47ad2ea 100644 --- a/specification/apimanagement/resource-manager/readme.go.md +++ b/specification/apimanagement/resource-manager/readme.go.md @@ -13,6 +13,7 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-preview-2021-01 - tag: package-2020-12 - tag: package-2019-12 - tag: package-preview-2019-12 @@ -24,6 +25,15 @@ batch: - tag: package-2016-07 ``` +### Tag: package-preview-2021-01 and go + +These settings apply only when `--tag=package-preview-2021-01 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-preview-2021-01' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2021-01-01-preview/$(namespace) +``` + ### Tag: package-2020-12 and go These settings apply only when `--tag=package-2020-12 --go` is specified on the command line. diff --git a/specification/apimanagement/resource-manager/readme.md b/specification/apimanagement/resource-manager/readme.md index 5458143088a5..cb24f175cfa9 100644 --- a/specification/apimanagement/resource-manager/readme.md +++ b/specification/apimanagement/resource-manager/readme.md @@ -28,7 +28,7 @@ These are the global settings for the ApiManagement API. title: ApiManagementClient description: ApiManagement Client openapi-type: arm -tag: package-preview-2021-01 +tag: package-2020-12 ``` @@ -516,7 +516,9 @@ See configuration in [readme.go.md](./readme.go.md) See configuration in [readme.java.md](./readme.java.md) +## AZ +See configuration in [readme.az.md](./readme.az.md) ## Suppression @@ -606,4 +608,4 @@ directive: - suppress: R4009 from: apimnotifications.json reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. -``` +``` \ No newline at end of file diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2021-03-01-preview/appconfiguration.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2021-03-01-preview/appconfiguration.json index 0607f2b84c9f..187d6c17f486 100644 --- a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2021-03-01-preview/appconfiguration.json +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/preview/2021-03-01-preview/appconfiguration.json @@ -1220,6 +1220,18 @@ "disableLocalAuth": { "type": "boolean", "description": "Disables all authentication methods other than AAD authentication." + }, + "publicNetworkAccess": { + "description": "Control permission for data plane traffic coming from public networks while private endpoint is enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } } } }, diff --git a/specification/appconfiguration/resource-manager/readme.md b/specification/appconfiguration/resource-manager/readme.md index 9ff6fa69e34d..3389cac9bafb 100644 --- a/specification/appconfiguration/resource-manager/readme.md +++ b/specification/appconfiguration/resource-manager/readme.md @@ -95,7 +95,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-powershell - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-net diff --git a/specification/appconfiguration/resource-manager/readme.python.md b/specification/appconfiguration/resource-manager/readme.python.md index 1a125d702381..90f50f633308 100644 --- a/specification/appconfiguration/resource-manager/readme.python.md +++ b/specification/appconfiguration/resource-manager/readme.python.md @@ -1,21 +1,5 @@ ## Python -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.appconfiguration - package-name: azure-mgmt-appconfiguration - package-version: 0.1.0 - clear-output-folder: true -``` - These settings apply only when `--track2` is specified on the command line. ``` yaml $(track2) @@ -23,20 +7,15 @@ azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-appconfiguration no-namespace-folders: true -package-version: 0.1.0 +package-version: 1.0.0b1 +clear-output-folder: true ``` -``` yaml $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/appconfiguration/azure-mgmt-appconfiguration/azure/mgmt/appconfiguration +``` yaml $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/appconfiguration/azure-mgmt-appconfiguration/azure/mgmt/appconfiguration ``` -``` yaml $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/appconfiguration/azure-mgmt-appconfiguration +``` yaml $(python-mode) == 'create' && $(track2) basic-setup-py: true output-folder: $(python-sdks-folder)/appconfiguration/azure-mgmt-appconfiguration ``` diff --git a/specification/applicationinsights/data-plane/Monitor.Exporters/preview/v2.1/examples/track.json b/specification/applicationinsights/data-plane/Monitor.Exporters/preview/v2.1/examples/track.json new file mode 100644 index 000000000000..dad4cd1bc839 --- /dev/null +++ b/specification/applicationinsights/data-plane/Monitor.Exporters/preview/v2.1/examples/track.json @@ -0,0 +1,193 @@ +{ + "parameters": { + "Host": "{Host}", + "body": [ + { + "ver": 1, + "name": "Microsoft.ApplicationInsights.b4f83947968d4e2f82ad804be07697ae.Event", + "time": "2020-09-22T10:12:53.208-0700", + "sampleRate": 100.0, + "iKey": "c1f83947-938c-5e2a-82ff-804be07647bc", + "tags": { + "ai.internal.sdkVersion": "java:3.0.0-PREVIEW.5", + "ai.internal.nodeName": "MININT-PLOJ2RD", + "ai.operation.id": "f364119ed1ff3bcda0d4ee0896cf785f", + "ai.cloud.roleInstance": "MININT-PLOJ2RD", + "ai.operation.childid": "75706a2ac9456288" + } + }, + { + "ver": 1, + "name": "Microsoft.ApplicationInsights.b4f83947968d4e2f82ad804be07697ae.Event", + "time": "2020-09-22T10:12:53.208-0700", + "sampleRate": 100.0, + "iKey": "c1f83947-938c-5e2a-82ff-804be07647bc", + "tags": { + "ai.internal.sdkVersion": "java:3.0.0-PREVIEW.5", + "ai.internal.nodeName": "MININT-PLOJ2RD", + "ai.operation.id": "f364119ed1ff3bcda0d4ee0896cf785f", + "ai.cloud.roleInstance": "MININT-PLOJ2RD", + "ai.operation.childid": "75706a2ac9456288" + } + }, + { + "ver": 1, + "name": "Microsoft.ApplicationInsights.b4f83947968d4e2f82ad804be07697ae.Event", + "time": "2020-09-22T10:12:53.208-0700", + "sampleRate": 100.0, + "iKey": "c1f83947-938c-5e2a-82ff-804be07647bc", + "tags": { + "ai.internal.sdkVersion": "java:3.0.0-PREVIEW.5", + "ai.internal.nodeName": "MININT-PLOJ2RD", + "ai.operation.id": "f364119ed1ff3bcda0d4ee0896cf785f", + "ai.cloud.roleInstance": "MININT-PLOJ2RD", + "ai.operation.childid": "75706a2ac9456288" + } + }, + { + "ver": 1, + "name": "Microsoft.ApplicationInsights.b4f83947968d4e2f82ad804be07697ae.Event", + "time": "2020-09-22T10:12:53.208-0700", + "sampleRate": 100.0, + "iKey": "c1f83947-938c-5e2a-82ff-804be07647bc", + "tags": { + "ai.internal.sdkVersion": "java:3.0.0-PREVIEW.5", + "ai.internal.nodeName": "MININT-PLOJ2RD", + "ai.operation.id": "f364119ed1ff3bcda0d4ee0896cf785f", + "ai.cloud.roleInstance": "MININT-PLOJ2RD", + "ai.operation.childid": "75706a2ac9456288" + } + }, + { + "ver": 1, + "name": "Microsoft.ApplicationInsights.b4f83947968d4e2f82ad804be07697ae.Event", + "time": "2020-09-22T10:12:53.208-0700", + "sampleRate": 100.0, + "iKey": "c1f83947-938c-5e2a-82ff-804be07647bc", + "tags": { + "ai.internal.sdkVersion": "java:3.0.0-PREVIEW.5", + "ai.internal.nodeName": "MININT-PLOJ2RD", + "ai.operation.id": "f364119ed1ff3bcda0d4ee0896cf785f", + "ai.cloud.roleInstance": "MININT-PLOJ2RD", + "ai.operation.childid": "75706a2ac9456288" + } + }, + { + "ver": 1, + "name": "Microsoft.ApplicationInsights.b4f83947968d4e2f82ad804be07697ae.Event", + "time": "2020-09-22T10:12:53.208-0700", + "sampleRate": 100.0, + "iKey": "c1f83947-938c-5e2a-82ff-804be07647bc", + "tags": { + "ai.internal.sdkVersion": "java:3.0.0-PREVIEW.5", + "ai.internal.nodeName": "MININT-PLOJ2RD", + "ai.operation.id": "f364119ed1ff3bcda0d4ee0896cf785f", + "ai.cloud.roleInstance": "MININT-PLOJ2RD", + "ai.operation.childid": "75706a2ac9456288" + } + }, + { + "ver": 1, + "name": "Microsoft.ApplicationInsights.b4f83947968d4e2f82ad804be07697ae.Event", + "time": "2020-09-22T10:12:53.208-0700", + "sampleRate": 100.0, + "iKey": "c1f83947-938c-5e2a-82ff-804be07647bc", + "tags": { + "ai.internal.sdkVersion": "java:3.0.0-PREVIEW.5", + "ai.internal.nodeName": "MININT-PLOJ2RD", + "ai.operation.id": "f364119ed1ff3bcda0d4ee0896cf785f", + "ai.cloud.roleInstance": "MININT-PLOJ2RD", + "ai.operation.childid": "75706a2ac9456288" + } + } + ] + }, + "responses": { + "200": { + "headers": {}, + "body": { + "itemsReceived": 1, + "itemsAccepted": 1, + "errors": [] + } + }, + "206": { + "headers": {}, + "body": { + "itemsReceived": 1, + "itemsAccepted": 1, + "errors": [] + } + }, + "400": { + "headers": {}, + "body": { + "itemsReceived": 1, + "itemsAccepted": 0, + "errors": [ + { + "index": 1, + "statusCode": 400, + "message": "103: Field 'time' on type 'Envelope' is older than the allowed min date. Expected: now - 172800000ms, Actual: now - 2694990759ms" + } + ] + } + }, + "402": { + "headers": {}, + "body": { + "itemsReceived": 1, + "itemsAccepted": 0, + "errors": [ + { + "index": 1, + "statusCode": 402, + "message": "" + } + ] + } + }, + "429": { + "headers": {}, + "body": { + "itemsReceived": 1, + "itemsAccepted": 0, + "errors": [ + { + "index": 1, + "statusCode": 429, + "message": "" + } + ] + } + }, + "500": { + "headers": {}, + "body": { + "itemsReceived": 1, + "itemsAccepted": 0, + "errors": [ + { + "index": 1, + "statusCode": 500, + "message": "" + } + ] + } + }, + "503": { + "headers": {}, + "body": { + "itemsReceived": 1, + "itemsAccepted": 0, + "errors": [ + { + "index": 1, + "statusCode": 503, + "message": "" + } + ] + } + } + } +} diff --git a/specification/applicationinsights/data-plane/Monitor.Exporters/preview/v2.1/swagger.json b/specification/applicationinsights/data-plane/Monitor.Exporters/preview/v2.1/swagger.json new file mode 100644 index 000000000000..e87c94887062 --- /dev/null +++ b/specification/applicationinsights/data-plane/Monitor.Exporters/preview/v2.1/swagger.json @@ -0,0 +1,1022 @@ +{ + "swagger": "2.0", + "info": { + "version": "v2.1", + "title": "ApplicationInsightsClient", + "description": "This document describes the protocol for client requests and responses to the data collection endpoint." + }, + "x-ms-parameterized-host": { + "hostTemplate": "{Host}/v2.1", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Host" + } + ] + }, + "paths": { + "/track": { + "post": { + "summary": "Track telemetry events", + "description": "This operation sends a sequence of telemetry events that will be monitored by Azure Monitor.", + "operationId": "track", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "The list of telemetry events to track.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/TelemetryEnvelope" + } + } + } + ], + "consumes": [ + "application/json", + "x-json-stream" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "All of the telemetry items were accepted and processed.", + "schema": { + "$ref": "#/definitions/TrackResponse" + } + }, + "206": { + "description": "Partial success. Some of the telemetry items were accepted and processed.", + "schema": { + "$ref": "#/definitions/TrackResponse" + } + }, + "400": { + "description": "Bad Request", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/TrackResponse" + } + }, + "402": { + "description": "Payment Required", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/TrackResponse" + } + }, + "429": { + "description": "Too Many Requests", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/TrackResponse" + } + }, + "500": { + "description": "Internal Server Error", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/TrackResponse" + } + }, + "503": { + "description": "Service Unavailable", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/TrackResponse" + } + } + }, + "x-ms-examples": { + "Track examples": { + "$ref": "examples/track.json" + } + } + } + } + }, + "definitions": { + "AvailabilityData": { + "allOf": [ + { + "$ref": "#/definitions/Domain" + }, + { + "type": "object", + "description": "Instances of AvailabilityData represent the result of executing an availability test.", + "required": [ + "id", + "name", + "duration", + "success" + ], + "properties": { + "id": { + "type": "string", + "description": "Identifier of a test run. Use it to correlate steps of test run and telemetry generated by the service.", + "maxLength": 512 + }, + "name": { + "type": "string", + "description": "Name of the test that these availability results represent.", + "maxLength": 1024 + }, + "duration": { + "type": "string", + "description": "Duration in format: DD.HH:MM:SS.MMMMMM. Must be less than 1000 days." + }, + "success": { + "type": "boolean", + "x-nullable": false, + "description": "Success flag." + }, + "runLocation": { + "type": "string", + "description": "Name of the location where the test was run from.", + "maxLength": 1024 + }, + "message": { + "type": "string", + "description": "Diagnostic message for the result.", + "maxLength": 8192 + }, + "properties": { + "type": "object", + "description": "Collection of custom properties.", + "additionalProperties": { + "type": "string", + "maxLength": 8192 + } + }, + "measurements": { + "type": "object", + "description": "Collection of custom measurements.", + "additionalProperties": { + "type": "number", + "format": "double" + } + } + } + } + ] + }, + "Base": { + "x-ms-client-name": "MonitorBase", + "type": "object", + "description": "Data struct to contain only C section with custom fields.", + "properties": { + "baseType": { + "type": "string", + "description": "Name of item (B section) if any. If telemetry data is derived straight from this, this should be null." + }, + "baseData": { + "$ref": "#/definitions/Domain", + "description": "The data payload for the telemetry request" + } + } + }, + "DataPoint": { + "x-ms-client-name": "MetricDataPoint", + "type": "object", + "description": "Metric data single measurement.", + "required": [ + "name", + "value" + ], + "properties": { + "ns": { + "x-ms-client-name": "namespace", + "type": "string", + "description": "Namespace of the metric.", + "maxLength": 256 + }, + "name": { + "type": "string", + "description": "Name of the metric.", + "maxLength": 1024 + }, + "kind": { + "x-ms-client-name": "dataPointType", + "$ref": "#/definitions/DataPointType", + "description": "Metric type. Single measurement or the aggregated value." + }, + "value": { + "type": "number", + "description": "Single value for measurement. Sum of individual measurements for the aggregation.", + "format": "double" + }, + "count": { + "type": "number", + "format": "int32", + "description": "Metric weight of the aggregated metric. Should not be set for a measurement.", + "x-nullable": true + }, + "min": { + "type": "number", + "format": "double", + "description": "Minimum value of the aggregated metric. Should not be set for a measurement.", + "x-nullable": true + }, + "max": { + "type": "number", + "format": "double", + "description": "Maximum value of the aggregated metric. Should not be set for a measurement.", + "x-nullable": true + }, + "stdDev": { + "type": "number", + "format": "double", + "description": "Standard deviation of the aggregated metric. Should not be set for a measurement.", + "x-nullable": true + } + } + }, + "DataPointType": { + "type": "string", + "description": "Type of the metric data measurement.", + "enum": [ + "Measurement", + "Aggregation" + ] + }, + "Domain": { + "x-ms-client-name": "MonitorDomain", + "type": "object", + "description": "The abstract common base of all domains.", + "required": [ + "ver" + ], + "additionalProperties": true, + "properties": { + "ver": { + "x-ms-client-name": "version", + "type": "integer", + "format": "int32", + "description": "Schema version", + "default": 2 + } + } + }, + "EventData": { + "x-ms-client-name": "TelemetryEventData", + "allOf": [ + { + "$ref": "#/definitions/Domain" + }, + { + "type": "object", + "description": "Instances of Event represent structured event records that can be grouped and searched by their properties. Event data item also creates a metric of event count by name.", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "Event name. Keep it low cardinality to allow proper grouping and useful metrics.", + "maxLength": 512 + }, + "properties": { + "type": "object", + "description": "Collection of custom properties.", + "additionalProperties": { + "type": "string", + "maxLength": 8192 + } + }, + "measurements": { + "type": "object", + "description": "Collection of custom measurements.", + "additionalProperties": { + "type": "number", + "format": "double" + } + } + } + } + ] + }, + "ExceptionData": { + "x-ms-client-name": "TelemetryExceptionData", + "allOf": [ + { + "$ref": "#/definitions/Domain" + }, + { + "type": "object", + "description": "An instance of Exception represents a handled or unhandled exception that occurred during execution of the monitored application.", + "required": [ + "exceptions" + ], + "properties": { + "exceptions": { + "type": "array", + "description": "Exception chain - list of inner exceptions.", + "items": { + "$ref": "#/definitions/ExceptionDetails" + } + }, + "severityLevel": { + "x-nullable": true, + "description": "Severity level. Mostly used to indicate exception severity level when it is reported by logging library.", + "$ref": "#/definitions/SeverityLevel" + }, + "problemId": { + "type": "string", + "description": "Identifier of where the exception was thrown in code. Used for exceptions grouping. Typically a combination of exception type and a function from the call stack.", + "maxLength": 1024 + }, + "properties": { + "type": "object", + "description": "Collection of custom properties.", + "additionalProperties": { + "type": "string", + "maxLength": 8192 + } + }, + "measurements": { + "type": "object", + "description": "Collection of custom measurements.", + "additionalProperties": { + "type": "number", + "format": "double" + } + } + } + } + ] + }, + "ExceptionDetails": { + "x-ms-client-name": "TelemetryExceptionDetails", + "type": "object", + "description": "Exception details of the exception in a chain.", + "required": [ + "message" + ], + "properties": { + "id": { + "type": "number", + "format": "int32", + "description": "In case exception is nested (outer exception contains inner one), the id and outerId properties are used to represent the nesting." + }, + "outerId": { + "type": "number", + "format": "int32", + "description": "The value of outerId is a reference to an element in ExceptionDetails that represents the outer exception" + }, + "typeName": { + "type": "string", + "description": "Exception type name.", + "maxLength": 1024 + }, + "message": { + "type": "string", + "description": "Exception message.", + "maxLength": 32768 + }, + "hasFullStack": { + "type": "boolean", + "default": true, + "description": "Indicates if full exception stack is provided in the exception. The stack may be trimmed, such as in the case of a StackOverflow exception." + }, + "stack": { + "type": "string", + "description": "Text describing the stack. Either stack or parsedStack should have a value.", + "maxLength": 32768 + }, + "parsedStack": { + "type": "array", + "description": "List of stack frames. Either stack or parsedStack should have a value.", + "items": { + "$ref": "#/definitions/StackFrame" + } + } + } + }, + "MessageData": { + "allOf": [ + { + "$ref": "#/definitions/Domain" + }, + { + "type": "object", + "description": "Instances of Message represent printf-like trace statements that are text-searched. Log4Net, NLog and other text-based log file entries are translated into instances of this type. The message does not have measurements.", + "required": [ + "message" + ], + "properties": { + "message": { + "type": "string", + "description": "Trace message", + "maxLength": 32768 + }, + "severityLevel": { + "$ref": "#/definitions/SeverityLevel", + "description": "Trace severity level." + }, + "properties": { + "type": "object", + "description": "Collection of custom properties.", + "additionalProperties": { + "type": "string", + "maxLength": 8192 + } + }, + "measurements": { + "type": "object", + "description": "Collection of custom measurements.", + "additionalProperties": { + "type": "number", + "format": "double" + } + } + } + } + ] + }, + "MetricsData": { + "allOf": [ + { + "$ref": "#/definitions/Domain" + }, + { + "type": "object", + "description": "An instance of the Metric item is a list of measurements (single data points) and/or aggregations.", + "required": [ + "metrics" + ], + "properties": { + "metrics": { + "type": "array", + "description": "List of metrics. Only one metric in the list is currently supported by Application Insights storage. If multiple data points were sent only the first one will be used.", + "items": { + "$ref": "#/definitions/DataPoint" + } + }, + "properties": { + "type": "object", + "description": "Collection of custom properties.", + "additionalProperties": { + "type": "string", + "maxLength": 8192 + } + } + } + } + ] + }, + "PageViewData": { + "allOf": [ + { + "$ref": "#/definitions/Domain" + }, + { + "type": "object", + "description": "An instance of PageView represents a generic action on a page like a button click. It is also the base type for PageView.", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "description": "Identifier of a page view instance. Used for correlation between page view and other telemetry items.", + "maxLength": 512 + }, + "name": { + "type": "string", + "description": "Event name. Keep it low cardinality to allow proper grouping and useful metrics.", + "maxLength": 1024 + }, + "url": { + "type": "string", + "description": "Request URL with all query string parameters", + "maxLength": 2048 + }, + "duration": { + "type": "string", + "description": "Request duration in format: DD.HH:MM:SS.MMMMMM. For a page view (PageViewData), this is the duration. For a page view with performance information (PageViewPerfData), this is the page load time. Must be less than 1000 days." + }, + "referredUri": { + "type": "string", + "description": "Fully qualified page URI or URL of the referring page; if unknown, leave blank", + "maxLength": 2048 + }, + "properties": { + "type": "object", + "description": "Collection of custom properties.", + "additionalProperties": { + "type": "string", + "maxLength": 8192 + } + }, + "measurements": { + "type": "object", + "description": "Collection of custom measurements.", + "additionalProperties": { + "type": "number", + "format": "double" + } + } + } + } + ] + }, + "PageViewPerfData": { + "allOf": [ + { + "$ref": "#/definitions/Domain" + }, + { + "type": "object", + "description": "An instance of PageViewPerf represents: a page view with no performance data, a page view with performance data, or just the performance data of an earlier page request.", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "description": "Identifier of a page view instance. Used for correlation between page view and other telemetry items.", + "maxLength": 512 + }, + "name": { + "type": "string", + "description": "Event name. Keep it low cardinality to allow proper grouping and useful metrics.", + "maxLength": 1024 + }, + "url": { + "type": "string", + "description": "Request URL with all query string parameters", + "maxLength": 2048 + }, + "duration": { + "type": "string", + "description": "Request duration in format: DD.HH:MM:SS.MMMMMM. For a page view (PageViewData), this is the duration. For a page view with performance information (PageViewPerfData), this is the page load time. Must be less than 1000 days." + }, + "perfTotal": { + "type": "string", + "description": "Performance total in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff" + }, + "networkConnect": { + "type": "string", + "description": "Network connection time in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff" + }, + "sentRequest": { + "type": "string", + "description": "Sent request time in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff" + }, + "receivedResponse": { + "type": "string", + "description": "Received response time in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff" + }, + "domProcessing": { + "type": "string", + "description": "DOM processing time in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff" + }, + "properties": { + "type": "object", + "description": "Collection of custom properties.", + "additionalProperties": { + "type": "string", + "maxLength": 8192 + } + }, + "measurements": { + "type": "object", + "description": "Collection of custom measurements.", + "additionalProperties": { + "type": "number", + "format": "double" + } + } + } + } + ] + }, + "RemoteDependencyData": { + "allOf": [ + { + "$ref": "#/definitions/Domain" + }, + { + "type": "object", + "description": "An instance of Remote Dependency represents an interaction of the monitored component with a remote component/service like SQL or an HTTP endpoint.", + "required": [ + "name", + "duration" + ], + "properties": { + "id": { + "type": "string", + "description": "Identifier of a dependency call instance. Used for correlation with the request telemetry item corresponding to this dependency call.", + "maxLength": 512 + }, + "name": { + "type": "string", + "description": "Name of the command initiated with this dependency call. Low cardinality value. Examples are stored procedure name and URL path template.", + "maxLength": 1024 + }, + "resultCode": { + "type": "string", + "description": "Result code of a dependency call. Examples are SQL error code and HTTP status code.", + "maxLength": 1024 + }, + "data": { + "type": "string", + "description": "Command initiated by this dependency call. Examples are SQL statement and HTTP URL with all query parameters.", + "maxLength": 8192 + }, + "type": { + "type": "string", + "description": "Dependency type name. Very low cardinality value for logical grouping of dependencies and interpretation of other fields like commandName and resultCode. Examples are SQL, Azure table, and HTTP.", + "maxLength": 1024 + }, + "target": { + "type": "string", + "description": "Target site of a dependency call. Examples are server name, host address.", + "maxLength": 1024 + }, + "duration": { + "type": "string", + "description": "Request duration in format: DD.HH:MM:SS.MMMMMM. Must be less than 1000 days." + }, + "success": { + "type": "boolean", + "description": "Indication of successful or unsuccessful call.", + "default": true + }, + "properties": { + "type": "object", + "description": "Collection of custom properties.", + "additionalProperties": { + "type": "string", + "maxLength": 8192 + } + }, + "measurements": { + "type": "object", + "description": "Collection of custom measurements.", + "additionalProperties": { + "type": "number", + "format": "double" + } + } + } + } + ] + }, + "RequestData": { + "allOf": [ + { + "$ref": "#/definitions/Domain" + }, + { + "type": "object", + "description": "An instance of Request represents completion of an external request to the application to do work and contains a summary of that request execution and the results.", + "required": [ + "id", + "duration", + "responseCode", + "success" + ], + "properties": { + "id": { + "type": "string", + "description": "Identifier of a request call instance. Used for correlation between request and other telemetry items.", + "maxLength": 512 + }, + "name": { + "type": "string", + "description": "Name of the request. Represents code path taken to process request. Low cardinality value to allow better grouping of requests. For HTTP requests it represents the HTTP method and URL path template like 'GET /values/{id}'.", + "maxLength": 1024 + }, + "duration": { + "type": "string", + "description": "Request duration in format: DD.HH:MM:SS.MMMMMM. Must be less than 1000 days." + }, + "success": { + "type": "boolean", + "description": "Indication of successful or unsuccessful call.", + "default": true + }, + "responseCode": { + "type": "string", + "description": "Result of a request execution. HTTP status code for HTTP requests.", + "maxLength": 1024 + }, + "source": { + "type": "string", + "description": "Source of the request. Examples are the instrumentation key of the caller or the ip address of the caller.", + "maxLength": 1024 + }, + "url": { + "type": "string", + "description": "Request URL with all query string parameters.", + "maxLength": 2048 + }, + "properties": { + "type": "object", + "description": "Collection of custom properties.", + "additionalProperties": { + "type": "string", + "maxLength": 8192 + } + }, + "measurements": { + "type": "object", + "description": "Collection of custom measurements.", + "additionalProperties": { + "type": "number", + "format": "double" + } + } + } + } + ] + }, + "SeverityLevel": { + "type": "string", + "description": "Defines the level of severity for the event.", + "enum": [ + "Verbose", + "Information", + "Warning", + "Error", + "Critical" + ] + }, + "StackFrame": { + "type": "object", + "description": "Stack frame information.", + "required": [ + "level", + "method" + ], + "properties": { + "level": { + "type": "number", + "format": "int32", + "description": "" + }, + "method": { + "type": "string", + "description": "Method name.", + "maxLength": 1024 + }, + "assembly": { + "type": "string", + "description": "Name of the assembly (dll, jar, etc.) containing this function.", + "maxLength": 1024 + }, + "fileName": { + "type": "string", + "description": "File name or URL of the method implementation.", + "maxLength": 1024 + }, + "line": { + "type": "number", + "format": "int32", + "description": "Line number of the code implementation." + } + } + }, + "TrackResponse": { + "description": "Response containing the status of each telemetry item.", + "type": "object", + "properties": { + "itemsReceived": { + "type": "number", + "format": "int32", + "description": "The number of items received." + }, + "itemsAccepted": { + "type": "number", + "format": "int32", + "description": "The number of items accepted." + }, + "errors": { + "type": "array", + "description": "An array of error detail objects.", + "items": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "ErrorDetails": { + "x-ms-client-name": "TelemetryErrorDetails", + "description": "The error details", + "type": "object", + "properties": { + "index": { + "type": "number", + "format": "int32", + "description": "The index in the original payload of the item." + }, + "statusCode": { + "type": "number", + "format": "int32", + "description": "The item specific [HTTP Response status code](#Response Status Codes)." + }, + "message": { + "type": "string", + "description": "The error message." + } + } + }, + "TelemetryEnvelope": { + "x-ms-client-name": "TelemetryItem", + "description": "System variables for a telemetry item.", + "type": "object", + "required": [ + "name", + "time" + ], + "properties": { + "ver": { + "type": "number", + "x-ms-client-name": "version", + "format": "int32", + "default": 1, + "description": "Envelope version. For internal use only. By assigning this the default, it will not be serialized within the payload unless changed to a value other than #1." + }, + "name": { + "type": "string", + "description": "Type name of telemetry data item." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "Event date time when telemetry item was created. This is the wall clock time on the client when the event was generated. There is no guarantee that the client's time is accurate. This field must be formatted in UTC ISO 8601 format, with a trailing 'Z' character, as described publicly on https://en.wikipedia.org/wiki/ISO_8601#UTC. Note: the number of decimal seconds digits provided are variable (and unspecified). Consumers should handle this, i.e. managed code consumers should not use format 'O' for parsing as it specifies a fixed length. Example: 2009-06-15T13:45:30.0000000Z." + }, + "sampleRate": { + "type": "number", + "format": "float", + "default": 100.0, + "description": "Sampling rate used in application. This telemetry item represents 100 / sampleRate actual telemetry items." + }, + "seq": { + "type": "string", + "x-ms-client-name": "sequence", + "maxLength": 64, + "description": "Sequence field used to track absolute order of uploaded events." + }, + "iKey": { + "type": "string", + "x-ms-client-name": "instrumentationKey", + "description": "The instrumentation key of the Application Insights resource." + }, + "tags": { + "type": "object", + "description": "Key/value collection of context properties. See ContextTagKeys for information on available properties.", + "additionalProperties": { + "type": "string" + } + }, + "data": { + "$ref": "#/definitions/Base", + "description": "Telemetry data item." + } + } + }, + "ContextTagKeys": { + "type": "string", + "description": "The context tag keys.", + "enum": [ + "ApplicationVersion", + "DeviceId", + "DeviceLocale", + "DeviceModel", + "DeviceOEMName", + "DeviceOSVersion", + "DeviceType", + "LocationIp", + "LocationCountry", + "LocationProvince", + "LocationCity", + "OperationId", + "OperationName", + "OperationParentId", + "OperationSyntheticSource", + "OperationCorrelationVector", + "SessionId", + "SessionIsFirst", + "UserAccountId", + "UserId", + "UserAuthUserId", + "CloudRole", + "CloudRoleVer", + "CloudRoleInstance", + "CloudLocation", + "InternalSdkVersion", + "InternalAgentVersion", + "InternalNodeName " + ], + "x-ms-enum": { + "name": "ContextTagKeys", + "modelAsString": true, + "values": [ + { + "value": "ai.application.ver" + }, + { + "value": "ai.device.id" + }, + { + "value": "ai.device.locale" + }, + { + "value": "ai.device.model" + }, + { + "value": "ai.device.oemName" + }, + { + "value": "ai.device.osVersion" + }, + { + "value": "ai.device.type" + }, + { + "value": "ai.location.ip" + }, + { + "value": "ai.location.country" + }, + { + "value": "ai.location.province" + }, + { + "value": "ai.location.city" + }, + { + "value": "ai.operation.id" + }, + { + "value": "ai.operation.name" + }, + { + "value": "ai.operation.parentId" + }, + { + "value": "ai.operation.syntheticSource" + }, + { + "value": "ai.operation.correlationVector" + }, + { + "value": "ai.session.id" + }, + { + "value": "ai.session.isFirst" + }, + { + "value": "ai.user.accountId" + }, + { + "value": "ai.user.id" + }, + { + "value": "ai.user.authUserId" + }, + { + "value": "ai.cloud.role" + }, + { + "value": "ai.cloud.roleVer" + }, + { + "value": "ai.cloud.roleInstance" + }, + { + "value": "ai.cloud.location" + }, + { + "value": "ai.internal.sdkVersion" + }, + { + "value": "ai.internal.agentVersion" + }, + { + "value": "ai.internal.nodeName" + } + ] + } + } + }, + "parameters": { + "Host": { + "name": "Host", + "description": "Breeze endpoint: https://dc.services.visualstudio.com", + "x-ms-parameter-location": "client", + "default": "https://dc.services.visualstudio.com", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/applicationinsights/data-plane/Monitor.Exporters/readme.md b/specification/applicationinsights/data-plane/Monitor.Exporters/readme.md index b1ae6ed86f47..fe680188a953 100644 --- a/specification/applicationinsights/data-plane/Monitor.Exporters/readme.md +++ b/specification/applicationinsights/data-plane/Monitor.Exporters/readme.md @@ -42,3 +42,17 @@ input-file: - preview/2020-09-15_Preview/swagger.json ``` +```yaml +openapi-type: data-plane +tag: v2.1 +``` + +### Tag: v2.1 + +These settings apply only when `--tag=v2.1` is specified on the command line. + +```yaml $(tag) == 'v2.1' +input-file: + - preview/v2.1/swagger.json +``` + diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2017-10-01/examples/CurrentPricingPlanCreateAndUpdate.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2017-10-01/examples/CurrentPricingPlanCreateAndUpdate.json index 6d269785be16..7f62be7b2683 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2017-10-01/examples/CurrentPricingPlanCreateAndUpdate.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2017-10-01/examples/CurrentPricingPlanCreateAndUpdate.json @@ -7,12 +7,9 @@ "PricingPlanProperties": { "id": "/subscriptions/subid/resourceGroups/my-resource-group/providers/microsoft.insights/components/my-component/pricingPlans/current", "name": "current", - "type": "microsoft.insights/components/pricingPlans", "properties": { "planType": "Basic", "cap": 500, - "maxHistoryCap": 500, - "resetHour": 16, "warningThreshold": 90, "stopSendNotificationWhenHitThreshold": false, "stopSendNotificationWhenHitCap": false diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2017-10-01/examples/CurrentPricingPlanUpdate.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2017-10-01/examples/CurrentPricingPlanUpdate.json index fccdba43b6f8..7f62be7b2683 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2017-10-01/examples/CurrentPricingPlanUpdate.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2017-10-01/examples/CurrentPricingPlanUpdate.json @@ -7,7 +7,6 @@ "PricingPlanProperties": { "id": "/subscriptions/subid/resourceGroups/my-resource-group/providers/microsoft.insights/components/my-component/pricingPlans/current", "name": "current", - "type": "microsoft.insights/components/pricingPlans", "properties": { "planType": "Basic", "cap": 500, diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-03-01-preview/componentLinkedStorageAccounts_API.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-03-01-preview/componentLinkedStorageAccounts_API.json index 22fcf9bfa10f..bde9a0c44184 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-03-01-preview/componentLinkedStorageAccounts_API.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-03-01-preview/componentLinkedStorageAccounts_API.json @@ -59,7 +59,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponseLinkedStorage" } }, "200": { @@ -108,7 +108,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponseLinkedStorage" } }, "200": { @@ -157,7 +157,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponseLinkedStorage" } }, "200": { @@ -197,7 +197,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponseLinkedStorage" } }, "200": { @@ -216,17 +216,24 @@ } }, "definitions": { - "ErrorResponse": { - "description": "Error response indicates Insights service is not able to process the incoming request. The reason is provided in the error message.", + "ErrorResponseLinkedStorage": { "type": "object", "properties": { - "code": { - "description": "Error code.", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" + "error": { + "description": "Error response indicates Insights service is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "code": { + "readOnly": true, + "description": "Error code.", + "type": "string" + }, + "message": { + "readOnly": true, + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } } } }, diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-06-02-preview/livetoken_API.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-06-02-preview/livetoken_API.json index bac300f6f969..a64727e554c7 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-06-02-preview/livetoken_API.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-06-02-preview/livetoken_API.json @@ -93,7 +93,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../2020-03-01-preview/componentLinkedStorageAccounts_API.json#/definitions/ErrorResponse" + "$ref": "../2020-03-01-preview/componentLinkedStorageAccounts_API.json#/definitions/ErrorResponseLinkedStorage" } }, "200": { diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/components_API.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/components_API.json new file mode 100644 index 000000000000..8b7c68c31127 --- /dev/null +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/components_API.json @@ -0,0 +1,794 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApplicationInsightsManagementClient", + "description": "Azure Application Insights client for Components", + "version": "2020-02-02" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Insights/components": { + "get": { + "description": "Gets a list of all Application Insights components within a subscription.", + "operationId": "Components_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A list containing 0 or more Application Insights component definitions.", + "schema": { + "$ref": "#/definitions/ApplicationInsightsComponentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponseComponents" + } + } + }, + "x-ms-examples": { + "ComponentsList.json": { + "$ref": "./examples/ComponentsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components": { + "get": { + "description": "Gets a list of Application Insights components within a resource group.", + "operationId": "Components_ListByResourceGroup", + "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": "A list containing 0 or more Application Insights component definitions.", + "schema": { + "$ref": "#/definitions/ApplicationInsightsComponentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponseComponents" + } + } + }, + "x-ms-examples": { + "ComponentListByResourceGroup": { + "$ref": "./examples/ComponentsListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}": { + "delete": { + "description": "Deletes an Application Insights component.", + "operationId": "Components_Delete", + "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" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successful request when deleting an Application Insights component." + }, + "204": { + "description": "The specified component does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponseComponents" + } + } + }, + "x-ms-examples": { + "ComponentsDelete": { + "$ref": "./examples/ComponentsDelete.json" + } + } + }, + "get": { + "description": "Returns an Application Insights component.", + "operationId": "Components_Get", + "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" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "An Application Insights Component definition.", + "schema": { + "$ref": "#/definitions/ApplicationInsightsComponent" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponseComponents" + } + } + }, + "x-ms-examples": { + "ComponentGet": { + "$ref": "./examples/ComponentsGet.json" + } + } + }, + "put": { + "description": "Creates (or updates) an Application Insights component. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.", + "operationId": "Components_CreateOrUpdate", + "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" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "InsightProperties", + "description": "Properties that need to be specified to create an Application Insights component.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationInsightsComponent" + } + } + ], + "responses": { + "200": { + "description": "Successful request when creating or updating an Application Insights component. The updated component is returned.", + "schema": { + "$ref": "#/definitions/ApplicationInsightsComponent" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponseComponents" + } + } + }, + "x-ms-examples": { + "ComponentCreate": { + "$ref": "./examples/ComponentsCreate.json" + }, + "ComponentUpdate": { + "$ref": "./examples/ComponentsUpdate.json" + } + } + }, + "patch": { + "description": "Updates an existing component's tags. To update other fields use the CreateOrUpdate method.", + "operationId": "Components_UpdateTags", + "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" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "ComponentTags", + "description": "Updated tag information to set into the component instance.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsResource" + } + } + ], + "responses": { + "200": { + "description": "Updating the Application Insights component's tags was successful. Component tags are updated and returned with the rest of the Component's object properties.", + "schema": { + "$ref": "#/definitions/ApplicationInsightsComponent" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponseComponents" + } + } + }, + "x-ms-examples": { + "ComponentUpdateTagsOnly": { + "$ref": "./examples/ComponentsUpdateTagsOnly.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/purge": { + "post": { + "description": "Purges data in an Application Insights component by a set of user-defined filters.\n\nIn order to manage system resources, purge requests are throttled at 50 requests per hour. You should batch the execution of purge requests by sending a single command whose predicate includes all user identities that require purging. Use the in operator to specify multiple identities. You should run the query prior to using for a purge request to verify that the results are expected.", + "operationId": "Components_Purge", + "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" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ComponentPurgeParameter" + } + ], + "responses": { + "202": { + "description": "Accepted request for purging an Application Insights component.", + "schema": { + "$ref": "#/definitions/ComponentPurgeResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponseComponents" + } + } + }, + "x-ms-examples": { + "ComponentPurge": { + "$ref": "./examples/ComponentsPurge.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/operations/{purgeId}": { + "get": { + "description": "Get status for an ongoing purge operation.", + "operationId": "Components_GetPurgeStatus", + "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" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ComponentPurgeIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns status of purge operation in body of response. e.g.: running, completed.", + "schema": { + "$ref": "#/definitions/ComponentPurgeStatusResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponseComponents" + } + } + }, + "x-ms-examples": { + "ComponentPurge": { + "$ref": "./examples/ComponentsPurgeStatus.json" + } + } + } + } + }, + "definitions": { + "ErrorResponseComponents": { + "type": "object", + "properties": { + "error": { + "description": "Error response indicates Insights service is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "code": { + "readOnly": true, + "description": "Error code.", + "type": "string" + }, + "message": { + "readOnly": true, + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + } + } + }, + "ComponentsResource": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id" + }, + "name": { + "type": "string", + "description": "Azure resource name", + "readOnly": true + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Azure resource type" + }, + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true, + "description": "An azure resource object" + }, + "TagsResource": { + "properties": { + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "description": "A container holding only the Tags for a resource, allowing the user to update the tags on a WebTest instance." + }, + "ApplicationInsightsComponent": { + "properties": { + "kind": { + "type": "string", + "description": "The kind of application that this component refers to, used to customize UI. This value is a freeform string, values should typically be one of the following: web, ios, other, store, java, phone." + }, + "etag": { + "type": "string", + "description": "Resource etag" + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Properties that define an Application Insights component resource.", + "$ref": "#/definitions/ApplicationInsightsComponentProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ComponentsResource" + } + ], + "required": [ + "kind" + ], + "description": "An Application Insights component definition." + }, + "ApplicationInsightsComponentProperties": { + "description": "Properties that define an Application Insights component resource.", + "properties": { + "ApplicationId": { + "type": "string", + "description": "The unique ID of your application. This field mirrors the 'Name' field and cannot be changed.", + "readOnly": true + }, + "AppId": { + "type": "string", + "readOnly": true, + "description": "Application Insights Unique ID for your Application." + }, + "Name": { + "type": "string", + "readOnly": true, + "description": "Application name." + }, + "Application_Type": { + "type": "string", + "description": "Type of application being monitored.", + "default": "web", + "enum": [ + "web", + "other" + ], + "x-ms-enum": { + "name": "ApplicationType", + "modelAsString": true + }, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "Flow_Type": { + "type": "string", + "description": "Used by the Application Insights system to determine what kind of flow this component was created by. This is to be set to 'Bluefield' when creating/updating a component via the REST API.", + "default": "Bluefield", + "enum": [ + "Bluefield" + ], + "x-ms-enum": { + "name": "FlowType", + "modelAsString": true + } + }, + "Request_Source": { + "type": "string", + "description": "Describes what tool created this Application Insights component. Customers using this API should set this to the default 'rest'.", + "default": "rest", + "enum": [ + "rest" + ], + "x-ms-enum": { + "name": "RequestSource", + "modelAsString": true + } + }, + "InstrumentationKey": { + "type": "string", + "readOnly": true, + "description": "Application Insights Instrumentation key. A read-only value that applications can use to identify the destination for all telemetry sent to Azure Application Insights. This value will be supplied upon construction of each new Application Insights component." + }, + "CreationDate": { + "type": "string", + "readOnly": true, + "description": "Creation Date for the Application Insights component, in ISO 8601 format.", + "format": "date-time" + }, + "TenantId": { + "type": "string", + "readOnly": true, + "description": "Azure Tenant Id." + }, + "HockeyAppId": { + "type": "string", + "description": "The unique application ID created when a new application is added to HockeyApp, used for communications with HockeyApp.", + "externalDocs": { + "url": "https://aka.ms/ewjuel" + } + }, + "HockeyAppToken": { + "type": "string", + "description": "Token used to authenticate communications with between Application Insights and HockeyApp.", + "readOnly": true, + "externalDocs": { + "url": "https://aka.ms/sls76s" + } + }, + "provisioningState": { + "type": "string", + "description": "Current state of this component: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Succeeded, Deploying, Canceled, and Failed.", + "readOnly": true + }, + "SamplingPercentage": { + "type": "number", + "format": "double", + "description": "Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry.", + "externalDocs": { + "url": "https://aka.ms/sl0yqd" + } + }, + "ConnectionString": { + "type": "string", + "readOnly": true, + "description": "Application Insights component connection string." + }, + "RetentionInDays": { + "type": "integer", + "description": "Retention period in days." + }, + "DisableIpMasking": { + "type": "boolean", + "description": "Disable IP masking." + }, + "ImmediatePurgeDataOn30Days": { + "type": "boolean", + "description": "Purge data immediately after 30 days." + }, + "WorkspaceResourceId": { + "type": "string", + "description": "Resource Id of the log analytics workspace which the data will be ingested to. This property is required to create an application with this API version. Applications from older versions will not have this property." + }, + "LaMigrationDate": { + "type": "string", + "readOnly": true, + "description": "The date which the component got migrated to LA, in ISO 8601 format.", + "format": "date-time" + }, + "PrivateLinkScopedResources": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkScopedResource" + }, + "description": "List of linked private link scope resources." + }, + "publicNetworkAccessForIngestion": { + "description": "The network access type for accessing Application Insights ingestion.", + "$ref": "#/definitions/PublicNetworkAccessType" + }, + "publicNetworkAccessForQuery": { + "description": "The network access type for accessing Application Insights query.", + "$ref": "#/definitions/PublicNetworkAccessType" + }, + "IngestionMode": { + "type": "string", + "description": "Indicates the flow of the ingestion.", + "default": "LogAnalytics", + "enum": [ + "ApplicationInsights", + "ApplicationInsightsWithDiagnosticSettings", + "LogAnalytics" + ], + "x-ms-enum": { + "name": "IngestionMode", + "modelAsString": true + } + }, + "DisableLocalAuth": { + "type": "boolean", + "description": "Disable Non-AAD based Auth." + }, + "ForceCustomerStorageForProfiler": { + "type": "boolean", + "description": "Force users to create their own storage account for profiler and debugger." + } + }, + "required": [ + "Application_Type" + ] + }, + "PrivateLinkScopedResource": { + "properties": { + "ResourceId": { + "type": "string", + "description": "The full resource Id of the private link scope resource." + }, + "ScopeId": { + "type": "string", + "description": "The private link scope unique Identifier." + } + }, + "description": "The private link scope resource reference." + }, + "ApplicationInsightsComponentListResult": { + "description": "Describes the list of Application Insights Resources.", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of Application Insights component definitions.", + "items": { + "$ref": "#/definitions/ApplicationInsightsComponent" + } + }, + "nextLink": { + "type": "string", + "description": "The URI to get the next set of Application Insights component definitions if too many components where returned in the result set." + } + } + }, + "ComponentPurgeBody": { + "description": "Describes the body of a purge request for an App Insights component", + "required": [ + "table", + "filters" + ], + "properties": { + "table": { + "type": "string", + "description": "Table from which to purge data." + }, + "filters": { + "type": "array", + "description": "The set of columns and filters (queries) to run over them to purge the resulting data.", + "items": { + "$ref": "#/definitions/ComponentPurgeBodyFilters" + } + } + } + }, + "ComponentPurgeBodyFilters": { + "description": "User-defined filters to return data which will be purged from the table.", + "properties": { + "column": { + "description": "The column of the table over which the given query should run", + "type": "string" + }, + "operator": { + "description": "A query operator to evaluate over the provided column and value(s). Supported operators are ==, =~, in, in~, >, >=, <, <=, between, and have the same behavior as they would in a KQL query.", + "type": "string" + }, + "value": { + "description": "the value for the operator to function over. This can be a number (e.g., > 100), a string (timestamp >= '2017-09-01') or array of values." + }, + "key": { + "description": "When filtering over custom dimensions, this key will be used as the name of the custom dimension.", + "type": "string" + } + } + }, + "ComponentPurgeResponse": { + "description": "Response containing operationId for a specific purge action.", + "properties": { + "operationId": { + "description": "Id to use when querying for status for a particular purge operation.", + "type": "string" + } + }, + "required": [ + "operationId" + ] + }, + "ComponentPurgeStatusResponse": { + "description": "Response containing status for a specific purge operation.", + "properties": { + "status": { + "description": "Status of the operation represented by the requested Id.", + "type": "string", + "enum": [ + "pending", + "completed" + ], + "x-ms-enum": { + "name": "PurgeState", + "modelAsString": true + } + } + }, + "required": [ + "status" + ] + }, + "PublicNetworkAccessType": { + "type": "string", + "description": "The network access type for operating on the Application Insights Component. By default it is Enabled", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccessType", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Enables connectivity to Application Insights through public DNS." + }, + { + "value": "Disabled", + "description": "Disables public connectivity to Application Insights through public DNS." + } + ] + } + } + }, + "parameters": { + "ResourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Application Insights component resource.", + "x-ms-parameter-location": "method" + }, + "ComponentPurgeParameter": { + "name": "body", + "in": "body", + "description": "Describes the body of a request to purge data in a single table of an Application Insights component", + "required": true, + "schema": { + "$ref": "#/definitions/ComponentPurgeBody" + }, + "x-ms-parameter-location": "method" + }, + "ComponentPurgeIdParameter": { + "name": "purgeId", + "in": "path", + "required": true, + "type": "string", + "description": "In a purge status request, this is the Id of the operation the status of which is returned.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/examples/ComponentsCreate.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/examples/ComponentsCreate.json new file mode 100644 index 000000000000..e47be170ccc3 --- /dev/null +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/examples/ComponentsCreate.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2020-02-02", + "subscriptionId": "subid", + "resourceGroupName": "my-resource-group", + "resourceName": "my-component", + "InsightProperties": { + "location": "South Central US", + "kind": "web", + "properties": { + "Application_Type": "web", + "Flow_Type": "Bluefield", + "WorkspaceResourceId": "/subscriptions/subid/resourcegroups/my-resource-group/providers/microsoft.operationalinsights/workspaces/my-workspace", + "Request_Source": "rest" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/my-resource-group/providers/Microsoft.Insights/components/my-component", + "name": "my-component", + "type": "Microsoft.Insights/components", + "location": "South Central US", + "tags": "", + "kind": "web", + "properties": { + "ApplicationId": "my-component", + "AppId": "887f4bfd-b5fd-40d7-9fc3-123456789abc", + "Application_Type": "web", + "Flow_Type": "Bluefield", + "Request_Source": "rest", + "InstrumentationKey": "bc095013-3cf2-45ac-ab47-123456789abc", + "CreationDate": "2017-01-24T01:05:38.5934061+00:00", + "TenantId": "f438d567-7177-4fe1-a5e3-123456789abc", + "HockeyAppId": "", + "HockeyAppToken": "", + "provisioningState": "Succeeded", + "SamplingPercentage": 100.0, + "WorkspaceResourceId": "/subscriptions/subid/resourcegroups/my-resource-group/providers/microsoft.operationalinsights/workspaces/my-workspace", + "ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc", + "DisableIpMasking": false, + "publicNetworkAccessForQuery": "Enabled", + "publicNetworkAccessForIngestion": "Enabled", + "IngestionMode": "LogAnalytics" + } + } + } + } +} diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/examples/ComponentsDelete.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/examples/ComponentsDelete.json new file mode 100644 index 000000000000..2e8b78b498f1 --- /dev/null +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/examples/ComponentsDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2020-02-02", + "subscriptionId": "subid", + "resourceGroupName": "my-resource-group", + "resourceName": "my-component" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/examples/ComponentsGet.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/examples/ComponentsGet.json new file mode 100644 index 000000000000..92fc3f43beb7 --- /dev/null +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/examples/ComponentsGet.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2020-02-02", + "subscriptionId": "subid", + "resourceGroupName": "my-resource-group", + "resourceName": "my-component" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/my-resource-group/providers/Microsoft.Insights/components/my-component", + "name": "my-component", + "type": "Microsoft.Insights/components", + "location": "South Central US", + "tags": "", + "kind": "web", + "properties": { + "ApplicationId": "my-component", + "AppId": "887f4bfd-b5fd-40d7-9fc3-123456789abc", + "Application_Type": "web", + "Flow_Type": "Bluefield", + "Request_Source": "rest", + "InstrumentationKey": "bc095013-3cf2-45ac-ab47-123456789abc", + "CreationDate": "2017-01-24T01:05:38.5934061+00:00", + "TenantId": "f438d567-7177-4fe1-a5e3-123456789abc", + "HockeyAppId": "", + "HockeyAppToken": "", + "provisioningState": "Succeeded", + "SamplingPercentage": 100.0, + "WorkspaceResourceId": "/subscriptions/subid/resourcegroups/my-resource-group/providers/microsoft.operationalinsights/workspaces/my-workspace", + "ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc", + "DisableIpMasking": false, + "publicNetworkAccessForQuery": "Enabled", + "publicNetworkAccessForIngestion": "Enabled", + "IngestionMode": "LogAnalytics" + } + } + } + } +} diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/examples/ComponentsList.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/examples/ComponentsList.json new file mode 100644 index 000000000000..4d5b050bbcbc --- /dev/null +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/examples/ComponentsList.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2020-02-02", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/my-resource-group/providers/Microsoft.Insights/components/my-component", + "name": "my-component", + "type": "Microsoft.Insights/components", + "location": "South Central US", + "tags": "", + "kind": "web", + "properties": { + "ApplicationId": "my-component", + "AppId": "16526d1a-dfba-4362-a9e9-123456789abc", + "Application_Type": "web", + "Flow_Type": "Bluefield", + "Request_Source": "rest", + "InstrumentationKey": "dc5931c7-a7ad-4ad0-89d6-123456789abc", + "CreationDate": "2017-02-14T12:24:05.0041213+00:00", + "TenantId": "f438d567-7177-4fe1-a5e3-123456789abc", + "HockeyAppId": "", + "HockeyAppToken": "", + "provisioningState": "Succeeded", + "SamplingPercentage": 75.0, + "WorkspaceResourceId": "/subscriptions/subid/resourcegroups/my-resource-group/providers/microsoft.operationalinsights/workspaces/my-workspace", + "ConnectionString": "InstrumentationKey=dc5931c7-a7ad-4ad0-89d6-123456789abc", + "DisableIpMasking": false, + "publicNetworkAccessForQuery": "Enabled", + "publicNetworkAccessForIngestion": "Enabled", + "IngestionMode": "LogAnalytics" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/my-other-resource-group/providers/Microsoft.Insights/components/my-other-component", + "name": "my-other-component", + "type": "Microsoft.Insights/components", + "location": "South Central US", + "tags": "", + "kind": "web", + "properties": { + "ApplicationId": "my-other-component", + "AppId": "887f4bfd-b5fd-40d7-9fc3-123456789abc", + "Application_Type": "web", + "Flow_Type": "Bluefield", + "Request_Source": "rest", + "InstrumentationKey": "bc095013-3cf2-45ac-ab47-123456789abc", + "CreationDate": "2017-01-24T01:05:38.5934061+00:00", + "TenantId": "f438d567-7177-4fe1-a5e3-123456789abc", + "HockeyAppId": "", + "HockeyAppToken": "", + "provisioningState": "Succeeded", + "SamplingPercentage": 30.0, + "WorkspaceResourceId": "/subscriptions/subid/resourcegroups/my-resource-group/providers/microsoft.operationalinsights/workspaces/my-workspace", + "ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc", + "DisableIpMasking": false, + "publicNetworkAccessForQuery": "Enabled", + "publicNetworkAccessForIngestion": "Enabled", + "IngestionMode": "LogAnalytics" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/examples/ComponentsListByResourceGroup.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/examples/ComponentsListByResourceGroup.json new file mode 100644 index 000000000000..e7cfff55f02e --- /dev/null +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/examples/ComponentsListByResourceGroup.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2020-02-02", + "subscriptionId": "subid", + "resourceGroupName": "my-resource-group" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/my-resource-group/providers/Microsoft.Insights/components/my-component", + "name": "my-component", + "type": "Microsoft.Insights/components", + "location": "South Central US", + "tags": "", + "kind": "web", + "properties": { + "ApplicationId": "my-component", + "AppId": "16526d1a-dfba-4362-a9e9-123456789abc", + "Application_Type": "web", + "Flow_Type": "Bluefield", + "Request_Source": "rest", + "InstrumentationKey": "dc5931c7-a7ad-4ad0-89d6-123456789abc", + "CreationDate": "2017-02-14T12:24:05.0041213+00:00", + "TenantId": "f438d567-7177-4fe1-a5e3-123456789abc", + "HockeyAppId": "", + "HockeyAppToken": "", + "provisioningState": "Succeeded", + "SamplingPercentage": 100.0, + "WorkspaceResourceId": "/subscriptions/subid/resourcegroups/my-resource-group/providers/microsoft.operationalinsights/workspaces/my-workspace", + "ConnectionString": "InstrumentationKey=dc5931c7-a7ad-4ad0-89d6-123456789abc", + "DisableIpMasking": false, + "publicNetworkAccessForQuery": "Enabled", + "publicNetworkAccessForIngestion": "Enabled", + "IngestionMode": "LogAnalytics" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/my-other-resource-group/providers/Microsoft.Insights/components/my-other-component", + "name": "my-other-component", + "type": "Microsoft.Insights/components", + "location": "South Central US", + "tags": "", + "kind": "web", + "properties": { + "ApplicationId": "my-other-component", + "AppId": "887f4bfd-b5fd-40d7-9fc3-123456789abc", + "Application_Type": "web", + "Flow_Type": "Bluefield", + "Request_Source": "rest", + "InstrumentationKey": "bc095013-3cf2-45ac-ab47-123456789abc", + "CreationDate": "2017-01-24T01:05:38.5934061+00:00", + "TenantId": "f438d567-7177-4fe1-a5e3-123456789abc", + "HockeyAppId": "", + "HockeyAppToken": "", + "provisioningState": "Succeeded", + "SamplingPercentage": 50.0, + "WorkspaceResourceId": "/subscriptions/subid/resourcegroups/my-resource-group/providers/microsoft.operationalinsights/workspaces/my-workspace", + "ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc", + "DisableIpMasking": false, + "publicNetworkAccessForQuery": "Enabled", + "publicNetworkAccessForIngestion": "Enabled", + "IngestionMode": "LogAnalytics" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/examples/ComponentsPurge.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/examples/ComponentsPurge.json new file mode 100644 index 000000000000..8fa7612ae7f2 --- /dev/null +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/examples/ComponentsPurge.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "resourceGroupName": "OIAutoRest5123", + "resourceName": "aztest5048", + "api-version": "2020-02-02", + "subscriptionId": "00000000-0000-0000-0000-00000000000", + "body": { + "table": "Heartbeat", + "filters": [ + { + "column": "TimeGenerated", + "operator": ">", + "value": "2017-09-01T00:00:00" + } + ] + } + }, + "responses": { + "202": { + "headers": { + "x-ms-status-location": "https://management.azure.com/subscriptions/b96161de-b34a-480f-7343-59b099299283/resourceGroups/example/providers/microsoft.insights/components/test/operations/purge-970318e7-b859-4edb-8903-83b1b54d0b74?api-version=2015-05-01" + }, + "body": { + "operationId": "7d7cf277-9113-4ab3-8359-d0364b74d01d" + } + } + } +} diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/examples/ComponentsPurgeStatus.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/examples/ComponentsPurgeStatus.json new file mode 100644 index 000000000000..0f38ffa06709 --- /dev/null +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/examples/ComponentsPurgeStatus.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "OIAutoRest5123", + "resourceName": "aztest5048", + "api-version": "2020-02-02", + "subscriptionId": "00000000-0000-0000-0000-00000000000", + "purgeId": "purge-970318e7-b859-4edb-8903-83b1b54d0b74" + }, + "responses": { + "200": { + "body": { + "status": "completed" + } + } + } +} diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/examples/ComponentsUpdate.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/examples/ComponentsUpdate.json new file mode 100644 index 000000000000..5130daaccc3c --- /dev/null +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/examples/ComponentsUpdate.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2020-02-02", + "subscriptionId": "subid", + "resourceGroupName": "my-resource-group", + "resourceName": "my-component", + "InsightProperties": { + "location": "South Central US", + "kind": "web", + "tags": { + "ApplicationGatewayType": "Internal-Only", + "BillingEntity": "Self" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/my-resource-group/providers/Microsoft.Insights/components/my-component", + "name": "my-component", + "type": "Microsoft.Insights/components", + "location": "South Central US", + "tags": { + "ApplicationGatewayType": "Internal-Only", + "BillingEntity": "Self" + }, + "kind": "web", + "properties": { + "ApplicationId": "my-component", + "AppId": "887f4bfd-b5fd-40d7-9fc3-123456789abc", + "Application_Type": "web", + "Flow_Type": "Bluefield", + "Request_Source": "rest", + "InstrumentationKey": "bc095013-3cf2-45ac-ab47-123456789abc", + "CreationDate": "2017-01-24T01:05:38.5934061+00:00", + "TenantId": "f438d567-7177-4fe1-a5e3-123456789abc", + "HockeyAppId": "", + "HockeyAppToken": "", + "provisioningState": "Succeeded", + "SamplingPercentage": 100.0, + "WorkspaceResourceId": "/subscriptions/subid/resourcegroups/my-resource-group/providers/microsoft.operationalinsights/workspaces/my-workspace", + "ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc", + "DisableIpMasking": false, + "publicNetworkAccessForQuery": "Enabled", + "publicNetworkAccessForIngestion": "Enabled", + "IngestionMode": "LogAnalytics" + } + } + } + } +} diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/examples/ComponentsUpdateTagsOnly.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/examples/ComponentsUpdateTagsOnly.json new file mode 100644 index 000000000000..a01dea72ce89 --- /dev/null +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/examples/ComponentsUpdateTagsOnly.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2020-02-02", + "subscriptionId": "subid", + "resourceGroupName": "my-resource-group", + "resourceName": "my-component", + "ComponentTags": { + "tags": { + "ApplicationGatewayType": "Internal-Only", + "BillingEntity": "Self", + "Color": "AzureBlue", + "CustomField_01": "Custom text in some random field named randomly", + "NodeType": "Edge" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/my-resource-group/providers/Microsoft.Insights/components/my-component", + "name": "my-component", + "type": "Microsoft.Insights/components", + "location": "South Central US", + "tags": { + "ApplicationGatewayType": "Internal-Only", + "BillingEntity": "Self", + "Color": "AzureBlue", + "CustomField_01": "Custom text in some random field named randomly", + "NodeType": "Edge" + }, + "kind": "web", + "properties": { + "ApplicationId": "my-component", + "AppId": "887f4bfd-b5fd-40d7-9fc3-123456789abc", + "Application_Type": "web", + "Flow_Type": "Bluefield", + "Request_Source": "rest", + "InstrumentationKey": "bc095013-3cf2-45ac-ab47-123456789abc", + "CreationDate": "2017-01-24T01:05:38.5934061+00:00", + "TenantId": "f438d567-7177-4fe1-a5e3-123456789abc", + "HockeyAppId": "", + "HockeyAppToken": "", + "provisioningState": "Succeeded", + "SamplingPercentage": 100.0, + "WorkspaceResourceId": "/subscriptions/subid/resourcegroups/my-resource-group/providers/microsoft.operationalinsights/workspaces/my-workspace", + "ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc", + "DisableIpMasking": false, + "publicNetworkAccessForQuery": "Enabled", + "publicNetworkAccessForIngestion": "Enabled", + "IngestionMode": "LogAnalytics" + } + } + } + } +} diff --git a/specification/applicationinsights/resource-manager/readme.go.md b/specification/applicationinsights/resource-manager/readme.go.md index 8d3ea9fc8783..0d015d62389f 100644 --- a/specification/applicationinsights/resource-manager/readme.go.md +++ b/specification/applicationinsights/resource-manager/readme.go.md @@ -14,6 +14,7 @@ go: ``` yaml $(go) && $(multiapi) batch: - tag: package-2015-05 + - tag: package-2020-02-02 ``` ### Tag: package-2015-05 and go @@ -25,24 +26,11 @@ Please also specify `--go-sdk-folder=`. -override-info: - title: ApplicationInsightsManagementClient +``` yaml $(tag) == 'package-2020-02-02' && $(go) +output-folder: $(go-sdk-folder)/services/appinsights/mgmt/2020-02-02/$(namespace) ``` diff --git a/specification/applicationinsights/resource-manager/readme.md b/specification/applicationinsights/resource-manager/readme.md index 536297aaaec0..7d16982291bc 100644 --- a/specification/applicationinsights/resource-manager/readme.md +++ b/specification/applicationinsights/resource-manager/readme.md @@ -354,6 +354,28 @@ input-file: - Microsoft.Insights/preview/2020-02-02-preview/components_API.json ``` +### Tag: package-2020-02-02 + +These settings apply only when `--tag=package-2020-02-02` is specified on the command line. + +``` yaml $(tag) == 'package-2020-02-02' +input-file: +- Microsoft.Insights/stable/2015-05-01/aiOperations_API.json +- Microsoft.Insights/stable/2015-05-01/componentAnnotations_API.json +- Microsoft.Insights/stable/2015-05-01/componentApiKeys_API.json +- Microsoft.Insights/stable/2015-05-01/componentContinuousExport_API.json +- Microsoft.Insights/stable/2015-05-01/componentFeaturesAndPricing_API.json +- Microsoft.Insights/stable/2015-05-01/componentProactiveDetection_API.json +- Microsoft.Insights/stable/2015-05-01/componentWorkItemConfigs_API.json +- Microsoft.Insights/stable/2015-05-01/favorites_API.json +- Microsoft.Insights/stable/2015-05-01/webTestLocations_API.json +- Microsoft.Insights/stable/2015-05-01/webTests_API.json +- Microsoft.Insights/stable/2015-05-01/analyticsItems_API.json +- Microsoft.Insights/stable/2015-05-01/workbooks_API.json +- Microsoft.Insights/stable/2015-05-01/myworkbooks_API.json +- Microsoft.Insights/stable/2020-02-02/components_API.json +``` + ### Tag: package-2019-10-17-preview These settings apply only when `--tag=package-2019-10-17-preview` is specified on the command line. @@ -426,9 +448,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - after_scripts: - - python ./scripts/multiapi_init_gen.py --default-api-version=2020-03-01-preview azure-mgmt-applicationinsights - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/applicationinsights/resource-manager/readme.python.md b/specification/applicationinsights/resource-manager/readme.python.md index 913e69037551..7a82c19ac38b 100644 --- a/specification/applicationinsights/resource-manager/readme.python.md +++ b/specification/applicationinsights/resource-manager/readme.python.md @@ -1,42 +1,20 @@ ## Python -## python These settings apply only when `--python` is specified on the command line. -```yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - package-name: azure-mgmt-applicationinsights - clear-output-folder: true - no-namespace-folders: true -``` ```yaml $(python) && $(track2) python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-applicationinsights +package-version: 1.0.0b1 clear-output-folder: true no-namespace-folders: true -modelerfour: - lenient-model-deduplication: true ``` ### Python multi-api -``` yaml $(python) && $(multiapi) && !$(track2) -batch: - - tag: package-2015-05 - - tag: package-2017-10 - - tag: package-2018-05-01-preview - - tag: package-2018-06-17-preview - - tag: package-2019-10-17-preview - - tag: package-2020-02-02-preview - - tag: package-2020-03-01-preview - - tag: package-preview-2020-06-only -``` ``` yaml $(python) && $(multiapi) && $(track2) +clear-output-folder: true batch: - tag: package-2015-05 - tag: package-2017-10 @@ -44,6 +22,7 @@ batch: - tag: package-2018-06-17-preview - tag: package-2019-10-17-preview - tag: package-2020-02-02-preview + - tag: package-2020-02-02 - tag: package-2020-03-01-preview - tag: package-preview-2020-06-only - multiapiscript: true @@ -59,11 +38,6 @@ perform-load: false These settings apply only when `--tag=package-2015-05 --python` is specified on the command line. -``` yaml $(tag) == 'package-2015-05' && $(python) && !$(track2) -python: - namespace: azure.mgmt.applicationinsights.v2015_05_01 - output-folder: $(python-sdks-folder)/applicationinsights/azure-mgmt-applicationinsights/azure/mgmt/applicationinsights/v2015_05_01 -``` ``` yaml $(tag) == 'package-2015-05' && $(python) && $(track2) namespace: azure.mgmt.applicationinsights.v2015_05_01 output-folder: $(python-sdks-folder)/applicationinsights/azure-mgmt-applicationinsights/azure/mgmt/applicationinsights/v2015_05_01 @@ -73,11 +47,6 @@ output-folder: $(python-sdks-folder)/applicationinsights/azure-mgmt-applicationi These settings apply only when `--tag=package-2017-10 --python` is specified on the command line. -``` yaml $(tag) == 'package-2017-10' && $(python) && !$(track2) -python: - namespace: azure.mgmt.applicationinsights.v2017_10_01 - output-folder: $(python-sdks-folder)/applicationinsights/azure-mgmt-applicationinsights/azure/mgmt/applicationinsights/v2017_10_01 -``` ``` yaml $(tag) == 'package-2017-10' && $(python) && $(track2) namespace: azure.mgmt.applicationinsights.v2017_10_01 output-folder: $(python-sdks-folder)/applicationinsights/azure-mgmt-applicationinsights/azure/mgmt/applicationinsights/v2017_10_01 @@ -87,11 +56,6 @@ output-folder: $(python-sdks-folder)/applicationinsights/azure-mgmt-applicationi These settings apply only when `--tag=package-2018-06-17-preview --python` is specified on the command line. -``` yaml $(tag) == 'package-2018-06-17-preview' && $(python) && !$(track2) -python: - namespace: azure.mgmt.applicationinsights.v2018_06_17_preview - output-folder: $(python-sdks-folder)/applicationinsights/azure-mgmt-applicationinsights/azure/mgmt/applicationinsights/v2018_06_17_preview -``` ``` yaml $(tag) == 'package-2018-06-17-preview' && $(python) && $(track2) namespace: azure.mgmt.applicationinsights.v2018_06_17_preview output-folder: $(python-sdks-folder)/applicationinsights/azure-mgmt-applicationinsights/azure/mgmt/applicationinsights/v2018_06_17_preview @@ -101,11 +65,6 @@ output-folder: $(python-sdks-folder)/applicationinsights/azure-mgmt-applicationi These settings apply only when `--tag=package-2019-10-17-preview --python` is specified on the command line. -```yaml $(tag) == 'package-2019-10-17-preview' && $(python) && !$(track2) -python: - namespace: azure.mgmt.applicationinsights.v2019_10_17_preview - output-folder: $(python-sdks-folder)/applicationinsights/azure-mgmt-applicationinsights/azure/mgmt/applicationinsights/v2019_10_17_preview -``` ```yaml $(tag) == 'package-2019-10-17-preview' && $(python) && $(track2) namespace: azure.mgmt.applicationinsights.v2019_10_17_preview output-folder: $(python-sdks-folder)/applicationinsights/azure-mgmt-applicationinsights/azure/mgmt/applicationinsights/v2019_10_17_preview @@ -115,11 +74,6 @@ output-folder: $(python-sdks-folder)/applicationinsights/azure-mgmt-applicationi These settings apply only when `--tag=package-2018-05-01-preview --python` is specified on the command line. -``` yaml $(tag) == 'package-2018-05-01-preview' && $(python) && !$(track2) -python: - namespace: azure.mgmt.applicationinsights.v2018_05_01_preview - output-folder: $(python-sdks-folder)/applicationinsights/azure-mgmt-applicationinsights/azure/mgmt/applicationinsights/v2018_05_01_preview -``` ``` yaml $(tag) == 'package-2018-05-01-preview' && $(python) && $(track2) namespace: azure.mgmt.applicationinsights.v2018_05_01_preview output-folder: $(python-sdks-folder)/applicationinsights/azure-mgmt-applicationinsights/azure/mgmt/applicationinsights/v2018_05_01_preview @@ -129,11 +83,6 @@ output-folder: $(python-sdks-folder)/applicationinsights/azure-mgmt-applicationi These settings apply only when `--tag=package-2020-02-02-preview --python` is specified on the command line. -``` yaml $(tag) == 'package-2020-02-02-preview' && $(python) && !$(track2) -python: - namespace: azure.mgmt.applicationinsights.v2020_02_02_preview - output-folder: $(python-sdks-folder)/applicationinsights/azure-mgmt-applicationinsights/azure/mgmt/applicationinsights/v2020_02_02_preview -``` ``` yaml $(tag) == 'package-2020-02-02-preview' && $(python) && $(track2) namespace: azure.mgmt.applicationinsights.v2020_02_02_preview output-folder: $(python-sdks-folder)/applicationinsights/azure-mgmt-applicationinsights/azure/mgmt/applicationinsights/v2020_02_02_preview @@ -143,11 +92,6 @@ output-folder: $(python-sdks-folder)/applicationinsights/azure-mgmt-applicationi These settings apply only when `--tag=package-2020-03-01-preview --python` is specified on the command line. -``` yaml $(tag) == 'package-2020-03-01-preview' && $(python) && !$(track2) -python: - namespace: azure.mgmt.applicationinsights.v2020_03_01_preview - output-folder: $(python-sdks-folder)/applicationinsights/azure-mgmt-applicationinsights/azure/mgmt/applicationinsights/v2020_03_01_preview -``` ``` yaml $(tag) == 'package-2020-03-01-preview' && $(python) && $(track2) namespace: azure.mgmt.applicationinsights.v2020_03_01_preview output-folder: $(python-sdks-folder)/applicationinsights/azure-mgmt-applicationinsights/azure/mgmt/applicationinsights/v2020_03_01_preview @@ -157,12 +101,11 @@ output-folder: $(python-sdks-folder)/applicationinsights/azure-mgmt-applicationi These settings apply only when `--tag=package-preview-2020-06-only --python` is specified on the command line. -``` yaml $(tag) == 'package-preview-2020-06-only' && $(python) && !$(track2) -python: - namespace: azure.mgmt.applicationinsights.v2020_06_02_preview - output-folder: $(python-sdks-folder)/applicationinsights/azure-mgmt-applicationinsights/azure/mgmt/applicationinsights/v2020_06_02_preview -``` ``` yaml $(tag) == 'package-preview-2020-06-only' && $(python) && $(track2) namespace: azure.mgmt.applicationinsights.v2020_06_02_preview output-folder: $(python-sdks-folder)/applicationinsights/azure-mgmt-applicationinsights/azure/mgmt/applicationinsights/v2020_06_02_preview ``` +```yaml $(python) && $(track2) +modelerfour: + lenient-model-deduplication: true +``` \ No newline at end of file diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json index 4e06ef972f13..63d5c1ac19c4 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json @@ -2857,8 +2857,7 @@ }, "temporaryDisk": { "$ref": "#/definitions/TemporaryDisk", - "description": "Temporary disk settings", - "default": "/tmp" + "description": "Temporary disk settings" }, "persistentDisk": { "$ref": "#/definitions/PersistentDisk", @@ -2879,7 +2878,8 @@ }, "mountPath": { "description": "Mount path of the temporary disk", - "type": "string" + "type": "string", + "default": "/tmp" } } }, diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2020-11-01-preview/appplatform.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2020-11-01-preview/appplatform.json index 75f29e4dfae3..aa9615cff9b6 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2020-11-01-preview/appplatform.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2020-11-01-preview/appplatform.json @@ -3443,8 +3443,7 @@ }, "temporaryDisk": { "$ref": "#/definitions/TemporaryDisk", - "description": "Temporary disk settings", - "default": "/tmp" + "description": "Temporary disk settings" }, "persistentDisk": { "$ref": "#/definitions/PersistentDisk", @@ -3470,7 +3469,8 @@ }, "mountPath": { "description": "Mount path of the temporary disk", - "type": "string" + "type": "string", + "default": "/tmp" } } }, @@ -4258,6 +4258,10 @@ "displayName": { "description": "Localized friendly display name of the dimension", "type": "string" + }, + "toBeExportedForShoebox": { + "description": "Whether this dimension should be included for the Shoebox export scenario", + "type": "boolean" } } }, diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2021-06-01-preview/appplatform.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2021-06-01-preview/appplatform.json index 6a0cd41ee4e0..0fa858b7ca6e 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2021-06-01-preview/appplatform.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2021-06-01-preview/appplatform.json @@ -3066,23 +3066,43 @@ "properties": { "serviceRuntimeSubnetId": { "description": "Fully qualified resource Id of the subnet to host Azure Spring Cloud Service Runtime", - "type": "string" + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] }, "appSubnetId": { "description": "Fully qualified resource Id of the subnet to host Azure Spring Cloud Apps", - "type": "string" + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] }, "serviceCidr": { "description": "Azure Spring Cloud service reserved CIDR", - "type": "string" + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] }, "serviceRuntimeNetworkResourceGroup": { "description": "Name of the resource group containing network resources of Azure Spring Cloud Service Runtime", - "type": "string" + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] }, "appNetworkResourceGroup": { "description": "Name of the resource group containing network resources of Azure Spring Cloud Apps", - "type": "string" + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] }, "outboundIPs": { "description": "Desired outbound IP resources for Azure Spring Cloud instance.", @@ -3413,11 +3433,16 @@ }, "fqdn": { "description": "Fully qualified dns Name.", - "type": "string" + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] }, "httpsOnly": { "description": "Indicate if only https is allowed.", - "type": "boolean" + "type": "boolean", + "default": false }, "createdTime": { "format": "date-time", @@ -3435,7 +3460,8 @@ }, "enableEndToEndTLS": { "description": "Indicate if end to end TLS is enabled.", - "type": "boolean" + "type": "boolean", + "default": false } } }, @@ -3452,7 +3478,8 @@ }, "mountPath": { "description": "Mount path of the temporary disk", - "type": "string" + "type": "string", + "default": "/tmp" } } }, @@ -4018,6 +4045,7 @@ }, "runtimeVersion": { "description": "Runtime version", + "default": "Java_8", "enum": [ "Java_8", "Java_11", @@ -4310,6 +4338,10 @@ "displayName": { "description": "Localized friendly display name of the dimension", "type": "string" + }, + "toBeExportedForShoebox": { + "description": "Whether this dimension should be included for the Shoebox export scenario", + "type": "boolean" } } }, diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/appplatform.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/appplatform.json index d873f13edda8..d0d132d16f10 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/appplatform.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/appplatform.json @@ -3419,8 +3419,7 @@ }, "temporaryDisk": { "$ref": "#/definitions/TemporaryDisk", - "description": "Temporary disk settings", - "default": "/tmp" + "description": "Temporary disk settings" }, "persistentDisk": { "$ref": "#/definitions/PersistentDisk", @@ -3441,7 +3440,8 @@ }, "mountPath": { "description": "Mount path of the temporary disk", - "type": "string" + "type": "string", + "default": "/tmp" } } }, @@ -4229,6 +4229,10 @@ "displayName": { "description": "Localized friendly display name of the dimension", "type": "string" + }, + "toBeExportedForShoebox": { + "description": "Whether this dimension should be included for the Shoebox export scenario", + "type": "boolean" } } }, diff --git a/specification/appplatform/resource-manager/readme.go.md b/specification/appplatform/resource-manager/readme.go.md index d67828bed9ae..463b0fc15645 100644 --- a/specification/appplatform/resource-manager/readme.go.md +++ b/specification/appplatform/resource-manager/readme.go.md @@ -13,11 +13,21 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-preview-2021-06 - tag: package-preview-2020-11 - tag: package-2020-07 - tag: package-2019-05-01-preview ``` +### Tag: package-preview-2021-06 and go + +These settings apply only when `--tag=package-preview-2021-06 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-preview-2021-06' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2021-06-01-preview/$(namespace) +``` + ### Tag: package-preview-2020-11 and go These settings apply only when `--tag=package-preview-2020-11 --go` is specified on the command line. diff --git a/specification/appplatform/resource-manager/readme.java.md b/specification/appplatform/resource-manager/readme.java.md index 6ef8eb3c1a57..a8db157ff0c9 100644 --- a/specification/appplatform/resource-manager/readme.java.md +++ b/specification/appplatform/resource-manager/readme.java.md @@ -16,11 +16,25 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-appplatform ``` yaml $(java) && $(multiapi) batch: + - tag: package-preview-2021-06 - tag: package-preview-2020-11 - tag: package-2020-07 - tag: package-2019-05-01-preview ``` +### Tag: package-preview-2021-06 and java + +These settings apply only when `--tag=package-preview-2021-06 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-preview-2021-06' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.appplatform.v2021_06_01_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/appplatform/mgmt-v2021_06_01_preview +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-preview-2020-11 and java These settings apply only when `--tag=package-preview-2020-11 --java` is specified on the command line. diff --git a/specification/appplatform/resource-manager/readme.md b/specification/appplatform/resource-manager/readme.md index 11dd36545e4d..c169a4fccdb7 100644 --- a/specification/appplatform/resource-manager/readme.md +++ b/specification/appplatform/resource-manager/readme.md @@ -97,9 +97,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-powershell - - repo: azure-sdk-for-python - after_scripts: - - python ./scripts/multiapi_init_gen.py azure-mgmt-appplatform - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-net diff --git a/specification/appplatform/resource-manager/readme.python.md b/specification/appplatform/resource-manager/readme.python.md index 0a0051851a78..748f15d43ccc 100644 --- a/specification/appplatform/resource-manager/readme.python.md +++ b/specification/appplatform/resource-manager/readme.python.md @@ -4,21 +4,12 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - package-name: azure-mgmt-appplatform - clear-output-folder: true - no-namespace-folders: true -``` ``` yaml $(python) && $(track2) python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-appplatform +package-version: 1.0.0b1 clear-output-folder: true no-namespace-folders: true ``` @@ -27,16 +18,11 @@ no-namespace-folders: true Generate all API versions currently shipped for this package -```yaml $(python) && $(multiapi) && !$(track2) -batch: - - tag: package-preview-2020-11 - - tag: package-2020-07 - - tag: package-2019-05-01-preview -``` ```yaml $(python) && $(multiapi) && $(track2) clear-output-folder: true batch: + - tag: package-preview-2021-06 - tag: package-preview-2020-11 - tag: package-2020-07 - tag: package-2019-05-01-preview @@ -49,16 +35,21 @@ clear-output-folder: false perform-load: false ``` +### Tag: package-preview-2021-06 and python + +These settings apply only when `--tag=package-preview-2021-06 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-preview-2021-06' && $(python) && $(track2) +namespace: azure.mgmt.appplatform.v2021_06_01_preview +output-folder: $(python-sdks-folder)/appplatform/azure-mgmt-appplatform/azure/mgmt/appplatform/v2021_06_01_preview +``` + ### Tag: package-preview-2020-11 and python These settings apply only when `--tag=package-preview-2020-11 --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-preview-2020-11' && $(python) && !$(track2) -python: - namespace: azure.mgmt.appplatform.v2020_11_01_preview - output-folder: $(python-sdks-folder)/appplatform/azure-mgmt-appplatform/azure/mgmt/appplatform/v2020_11_01_preview -``` ``` yaml $(tag) == 'package-preview-2020-11' && $(python) && $(track2) namespace: azure.mgmt.appplatform.v2020_11_01_preview output-folder: $(python-sdks-folder)/appplatform/azure-mgmt-appplatform/azure/mgmt/appplatform/v2020_11_01_preview @@ -69,11 +60,6 @@ output-folder: $(python-sdks-folder)/appplatform/azure-mgmt-appplatform/azure/mg These settings apply only when `--tag=package-2020-07 --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2020-07' && $(python) && !$(track2) -python: - namespace: azure.mgmt.appplatform.v2020_07_01 - output-folder: $(python-sdks-folder)/appplatform/azure-mgmt-appplatform/azure/mgmt/appplatform/v2020_07_01 -``` ``` yaml $(tag) == 'package-2020-07' && $(python) && $(track2) namespace: azure.mgmt.appplatform.v2020_07_01 output-folder: $(python-sdks-folder)/appplatform/azure-mgmt-appplatform/azure/mgmt/appplatform/v2020_07_01 @@ -84,11 +70,6 @@ output-folder: $(python-sdks-folder)/appplatform/azure-mgmt-appplatform/azure/mg These settings apply only when `--tag=package-2019-05-01-preview --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2019-05-01-preview' && $(python) && !$(track2) -python: - namespace: azure.mgmt.appplatform.v2019_05_01_preview - output-folder: $(python-sdks-folder)/appplatform/azure-mgmt-appplatform/azure/mgmt/appplatform/v2019_05_01_preview -``` ``` yaml $(tag) == 'package-2019-05-01-preview' && $(python) && $(track2) namespace: azure.mgmt.appplatform.v2019_05_01_preview diff --git a/specification/appplatform/resource-manager/readme.ruby.md b/specification/appplatform/resource-manager/readme.ruby.md index b4130d932c68..379a5ac27cb1 100644 --- a/specification/appplatform/resource-manager/readme.ruby.md +++ b/specification/appplatform/resource-manager/readme.ruby.md @@ -12,11 +12,22 @@ azure-arm: true ``` yaml $(ruby) && $(multiapi) batch: + - tag: package-preview-2021-06 - tag: package-preview-2020-11 - tag: package-2020-07 - tag: package-2019-05-01-preview ``` +### Tag: package-preview-2021-06 and ruby + +These settings apply only when `--tag=package-preview-2021-06 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-preview-2021-06' && $(ruby) +namespace: "Azure::AppPlatform::Mgmt::V2021_06_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_appplatform/lib +``` + ### Tag: package-preview-2020-11 and ruby These settings apply only when `--tag=package-preview-2020-11 --ruby` is specified on the command line. @@ -45,4 +56,4 @@ Please also specify `--ruby-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.attestation - package-name: azure-mgmt-attestation - package-version: 0.1.0 - clear-output-folder: true -``` ``` yaml $(python) && $(track2) -python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.attestation @@ -26,16 +14,7 @@ clear-output-folder: true modelerfour: lenient-model-deduplication: true ``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/attestation/azure-mgmt-attestation/azure/mgmt/attestation -``` -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/attestation/azure-mgmt-attestation -``` + ``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/attestation/azure-mgmt-attestation/azure/mgmt/attestation @@ -44,3 +23,8 @@ output-folder: $(python-sdks-folder)/attestation/azure-mgmt-attestation/azure/mg basic-setup-py: true output-folder: $(python-sdks-folder)/attestation/azure-mgmt-attestation ``` + +``` yaml $(python) && $(track2) +modelerfour: + lenient-model-deduplication: true +``` diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/authorization-AccessReviewCalls.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/authorization-AccessReviewCalls.json new file mode 100644 index 000000000000..597756ea0d43 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/authorization-AccessReviewCalls.json @@ -0,0 +1,2161 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-07-01-preview", + "title": "AuthorizationManagementClient", + "description": "Access reviews service provides the workflow for running access reviews on different kind of resources." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Authorization/operations": { + "get": { + "operationId": "Operations_List", + "x-ms-examples": {}, + "description": "Lists the operations available from this provider.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorDefinition" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewScheduleDefinitions": { + "get": { + "tags": [ + "GetAccessReviewScheduleDefinitions" + ], + "operationId": "AccessReviewScheduleDefinitions_List", + "x-ms-examples": { + "GetAccessReviews": { + "$ref": "./examples/GetAccessReviewScheduleDefinitions.json" + } + }, + "description": "Get access review schedule definitions", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/AccessReviewsFilterParameter" + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/AccessReviewScheduleDefinitionListResult" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorDefinition" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/{scheduleDefinitionId}": { + "get": { + "tags": [ + "GetAccessReviewScheduleDefinition" + ], + "operationId": "AccessReviewScheduleDefinitions_GetById", + "x-ms-examples": { + "GetAccessReview": { + "$ref": "./examples/GetAccessReviewScheduleDefinition.json" + } + }, + "description": "Get single access review definition", + "parameters": [ + { + "name": "scheduleDefinitionId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review schedule definition." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/AccessReviewScheduleDefinition" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorDefinition" + } + } + } + }, + "delete": { + "tags": [ + "DeleteAccessReviewScheduleDefinition" + ], + "operationId": "AccessReviewScheduleDefinitions_DeleteById", + "x-ms-examples": { + "DeleteAccessReview": { + "$ref": "./examples/DeleteAccessReviewScheduleDefinition.json" + } + }, + "description": "Delete access review schedule definition", + "parameters": [ + { + "name": "scheduleDefinitionId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review schedule definition." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request is well formed but the resource does not exist" + }, + "200": { + "description": "Resource deleted successfully" + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorDefinition" + } + } + } + }, + "put": { + "tags": [ + "PutAccessReviewScheduleDefinition" + ], + "operationId": "AccessReviewScheduleDefinitions_CreateOrUpdateById", + "x-ms-examples": { + "PutAccessReview": { + "$ref": "./examples/PutAccessReviewScheduleDefinition.json" + } + }, + "description": "Create or Update access review schedule definition.", + "parameters": [ + { + "name": "scheduleDefinitionId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review schedule definition." + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AccessReviewScheduleDefinitionProperties" + }, + "description": "Access review schedule definition properties." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful update", + "schema": { + "$ref": "#/definitions/AccessReviewScheduleDefinition" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorDefinition" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/{scheduleDefinitionId}/stop": { + "post": { + "tags": [ + "AccessReviewScheduleDefinitionStop" + ], + "operationId": "AccessReviewScheduleDefinitions_Stop", + "x-ms-examples": { + "GetAccessReview": { + "$ref": "./examples/StopAccessReviewScheduleDefinition.json" + } + }, + "description": "Stop access review definition", + "parameters": [ + { + "name": "scheduleDefinitionId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review schedule definition." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Describe the result of a successful operation." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorDefinition" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/{scheduleDefinitionId}/instances": { + "get": { + "tags": [ + "GetAccessReviewInstances" + ], + "operationId": "AccessReviewInstances_List", + "x-ms-examples": { + "GetAccessReviews": { + "$ref": "./examples/GetAccessReviewInstances.json" + } + }, + "description": "Get access review instances", + "parameters": [ + { + "name": "scheduleDefinitionId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review schedule definition." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/AccessReviewsFilterParameter" + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/AccessReviewInstanceListResult" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorDefinition" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/{scheduleDefinitionId}/instances/{id}": { + "get": { + "tags": [ + "GetAccessReviewInstance" + ], + "operationId": "AccessReviewInstances_GetById", + "x-ms-examples": { + "GetAccessReviews": { + "$ref": "./examples/GetAccessReviewInstance.json" + } + }, + "description": "Get access review instances", + "parameters": [ + { + "name": "scheduleDefinitionId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review schedule definition." + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review instance." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/AccessReviewInstance" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorDefinition" + } + } + } + }, + "put": { + "tags": [ + "PutAccessReviewInstance" + ], + "operationId": "AccessReviewInstances_Create", + "x-ms-examples": { + "GetAccessReviews": { + "$ref": "./examples/PutAccessReviewInstance.json" + } + }, + "description": "Update access review instance.", + "parameters": [ + { + "name": "scheduleDefinitionId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review schedule definition." + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review instance." + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AccessReviewInstanceProperties" + }, + "description": "Access review instance properties." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful update", + "schema": { + "$ref": "#/definitions/AccessReviewInstance" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorDefinition" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/{scheduleDefinitionId}/instances/{id}/stop": { + "post": { + "tags": [ + "AccessReviewInstanceStop" + ], + "operationId": "AccessReviewInstance_Stop", + "x-ms-examples": { + "GetAccessReview": { + "$ref": "./examples/StopAccessReviewInstance.json" + } + }, + "description": "An action to stop an access review instance.", + "parameters": [ + { + "name": "scheduleDefinitionId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review schedule definition." + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review instance." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Describe the result of a successful operation." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorDefinition" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/{scheduleDefinitionId}/instances/{id}/resetDecisions": { + "post": { + "tags": [ + "AccessReviewInstanceResetDecisions" + ], + "operationId": "AccessReviewInstance_ResetDecisions", + "x-ms-examples": { + "GetAccessReview": { + "$ref": "./examples/AccessReviewInstanceResetDecisions.json" + } + }, + "description": "An action to reset all decisions for an access review instance.", + "parameters": [ + { + "name": "scheduleDefinitionId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review schedule definition." + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review instance." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Describe the result of a successful operation." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorDefinition" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/{scheduleDefinitionId}/instances/{id}/applyDecisions": { + "post": { + "tags": [ + "AccessReviewInstanceApplyDecisions" + ], + "operationId": "AccessReviewInstance_ApplyDecisions", + "x-ms-examples": { + "GetAccessReview": { + "$ref": "./examples/AccessReviewInstanceApplyDecisions.json" + } + }, + "description": "An action to apply all decisions for an access review instance.", + "parameters": [ + { + "name": "scheduleDefinitionId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review schedule definition." + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review instance." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Describe the result of a successful operation." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorDefinition" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/{scheduleDefinitionId}/instances/{id}/sendReminders": { + "post": { + "tags": [ + "AccessReviewInstanceSendReminders" + ], + "operationId": "AccessReviewInstance_SendReminders", + "x-ms-examples": { + "GetAccessReview": { + "$ref": "./examples/AccessReviewInstanceSendReminders.json" + } + }, + "description": "An action to send reminders for an access review instance.", + "parameters": [ + { + "name": "scheduleDefinitionId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review schedule definition." + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review instance." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Describe the result of a successful operation." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorDefinition" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/{scheduleDefinitionId}/instances/{id}/decisions": { + "get": { + "tags": [ + "GetAccessReviewInstanceDecisions" + ], + "operationId": "AccessReviewInstanceDecisions_List", + "x-ms-examples": { + "GetAccessReviews": { + "$ref": "./examples/GetAccessReviewInstanceDecisions.json" + } + }, + "description": "Get access review instance decisions", + "parameters": [ + { + "name": "scheduleDefinitionId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review schedule definition." + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review instance." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/AccessReviewsFilterParameter" + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/AccessReviewDecisionListResult" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorDefinition" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/{scheduleDefinitionId}/instances/{id}/contactedReviewers": { + "get": { + "tags": [ + "GetAccessReviewInstanceContactedReviewers" + ], + "operationId": "AccessReviewInstanceContactedReviewers_List", + "x-ms-examples": { + "GetAccessReviews": { + "$ref": "./examples/GetAccessReviewInstanceContactedReviewers.json" + } + }, + "description": "Get access review instance contacted reviewers", + "parameters": [ + { + "name": "scheduleDefinitionId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review schedule definition." + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review instance." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/AccessReviewContactedReviewerListResult" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorDefinition" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewScheduleSettings/default": { + "get": { + "tags": [ + "GetAccessReviewDefaultSettings" + ], + "operationId": "AccessReviewDefaultSettings_Get", + "x-ms-examples": { + "GetAccessReviewDefaultSettings": { + "$ref": "./examples/GetAccessReviewDefaultSettings.json" + } + }, + "description": "Get access review default settings for the subscription", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/AccessReviewDefaultSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorDefinition" + } + } + } + }, + "put": { + "tags": [ + "PutAccessReviewDefaultSettings" + ], + "operationId": "AccessReviewDefaultSettings_Put", + "x-ms-examples": { + "GetAccessReviewDefaultSettings": { + "$ref": "./examples/PutAccessReviewDefaultSettings.json" + } + }, + "description": "Get access review default settings for the subscription", + "parameters": [ + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AccessReviewScheduleSettings" + }, + "description": "Access review schedule settings." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/AccessReviewDefaultSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorDefinition" + } + } + } + } + }, + "/providers/Microsoft.Authorization/accessReviewScheduleDefinitions": { + "get": { + "tags": [ + "GetAccessReviewScheduleDefinitionsAssignedForMyApproval" + ], + "operationId": "AccessReviewScheduleDefinitionsAssignedForMyApproval_List", + "x-ms-examples": { + "GetAccessReviews": { + "$ref": "./examples/GetAccessReviewScheduleDefinitionsAssignedForMyApproval.json" + } + }, + "description": "Get access review instances assigned for my approval.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/AccessReviewsFilterParameter" + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/AccessReviewScheduleDefinitionListResult" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorDefinition" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/{scheduleDefinitionId}/instances": { + "get": { + "tags": [ + "GetAccessReviewInstancesAssignedForMyApproval" + ], + "operationId": "AccessReviewInstancesAssignedForMyApproval_List", + "x-ms-examples": { + "GetAccessReviews": { + "$ref": "./examples/GetAccessReviewInstancesAssignedForMyApproval.json" + } + }, + "description": "Get access review instances assigned for my approval.", + "parameters": [ + { + "name": "scheduleDefinitionId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review schedule definition." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/AccessReviewsFilterParameter" + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/AccessReviewInstanceListResult" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorDefinition" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/{scheduleDefinitionId}/instances/{id}": { + "get": { + "tags": [ + "GetAccessReviewInstance" + ], + "operationId": "AccessReviewInstancesAssignedForMyApproval_GetById", + "x-ms-examples": { + "GetAccessReviews": { + "$ref": "./examples/GetAccessReviewInstanceAssignedForMyApproval.json" + } + }, + "description": "Get single access review instance assigned for my approval.", + "parameters": [ + { + "name": "scheduleDefinitionId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review schedule definition." + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review instance." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/AccessReviewInstance" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorDefinition" + } + } + } + } + }, + "/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/{scheduleDefinitionId}/instances/{id}/acceptRecommendations": { + "post": { + "tags": [ + "AccessReviewInstanceAcceptRecommmendations" + ], + "operationId": "AccessReviewInstance_AcceptRecommendations", + "x-ms-examples": { + "GetAccessReview": { + "$ref": "./examples/AccessReviewInstanceAcceptRecommendations.json" + } + }, + "description": "An action to accept recommendations for decision in an access review instance.", + "parameters": [ + { + "name": "scheduleDefinitionId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review schedule definition." + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review instance." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Describe the result of a successful operation." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorDefinition" + } + } + } + } + }, + "/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/{scheduleDefinitionId}/instances/{id}/decisions": { + "get": { + "tags": [ + "GetAccessReviewMyInstanceDecisions" + ], + "operationId": "AccessReviewInstanceMyDecisions_List", + "x-ms-examples": { + "GetAccessReviews": { + "$ref": "./examples/GetAccessReviewInstanceMyDecisions.json" + } + }, + "description": "Get my access review instance decisions.", + "parameters": [ + { + "name": "scheduleDefinitionId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review schedule definition." + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review instance." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/AccessReviewsFilterParameter" + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/AccessReviewDecisionListResult" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorDefinition" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/{scheduleDefinitionId}/instances/{id}/contactedReviewers": { + "get": { + "tags": [ + "TenantLevelGetAccessReviewInstanceContactedReviewers" + ], + "operationId": "TenantLevelAccessReviewInstanceContactedReviewers_List", + "x-ms-examples": { + "GetAccessReviews": { + "$ref": "./examples/TenantLevelGetAccessReviewInstanceContactedReviewers.json" + } + }, + "description": "Get access review instance contacted reviewers", + "parameters": [ + { + "name": "scheduleDefinitionId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review schedule definition." + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review instance." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/AccessReviewContactedReviewerListResult" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorDefinition" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/{scheduleDefinitionId}/instances/{id}/decisions/{decisionId}": { + "get": { + "tags": [ + "GetAccessReviewMyInstanceDecision" + ], + "operationId": "AccessReviewInstanceMyDecisions_GetById", + "x-ms-examples": { + "GetAccessReviews": { + "$ref": "./examples/GetAccessReviewInstanceMyDecisionById.json" + } + }, + "description": "Get my single access review instance decision.", + "parameters": [ + { + "name": "scheduleDefinitionId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review schedule definition." + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review instance." + }, + { + "name": "decisionId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the decision record." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/AccessReviewDecision" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorDefinition" + } + } + } + }, + "patch": { + "tags": [ + "PatchAccessReviewMyInstanceDecision" + ], + "operationId": "AccessReviewInstanceMyDecisions_Patch", + "x-ms-examples": { + "GetAccessReviews": { + "$ref": "./examples/PatchAccessReviewInstanceMyDecisionById.json" + } + }, + "description": "Record a decision.", + "parameters": [ + { + "name": "scheduleDefinitionId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review schedule definition." + }, + { + "name": "id", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the access review instance." + }, + { + "name": "decisionId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the decision record." + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AccessReviewDecisionProperties" + }, + "description": "Access review decision properties to patch." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/AccessReviewDecision" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorDefinition" + } + } + } + } + } + }, + "definitions": { + "AccessReviewScheduleDefinition": { + "x-ms-azure-resource": true, + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The access review schedule definition id." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The access review schedule definition unique id." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The resource type." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessReviewScheduleDefinitionProperties", + "description": "Access Review properties." + } + }, + "description": "Access Review Schedule Definition." + }, + "AccessReviewScheduleDefinitionProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "The display name for the schedule definition." + }, + "status": { + "type": "string", + "readOnly": true, + "description": "This read-only field specifies the status of an accessReview.", + "enum": [ + "NotStarted", + "InProgress", + "Completed", + "Applied", + "Initializing", + "Applying", + "Completing", + "Scheduled", + "AutoReviewing", + "AutoReviewed", + "Starting" + ], + "x-ms-enum": { + "name": "AccessReviewScheduleDefinitionStatus", + "modelAsString": true + } + }, + "descriptionForAdmins": { + "type": "string", + "description": "The description provided by the access review creator and visible to admins." + }, + "descriptionForReviewers": { + "type": "string", + "description": "The description provided by the access review creator to be shown to reviewers." + }, + "createdBy": { + "readOnly": true, + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessReviewActorIdentity", + "description": "The user or other identity who created this review." + }, + "settings": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessReviewScheduleSettings", + "description": "Access Review Settings." + }, + "scope": { + "readOnly": true, + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessReviewScope", + "description": "This is used to define what to include in scope of the review. The scope definition includes the resourceId and roleDefinitionId." + }, + "reviewers": { + "type": "array", + "items": { + "$ref": "#/definitions/AccessReviewReviewer" + }, + "description": "This is the collection of reviewers." + }, + "backupReviewers": { + "type": "array", + "items": { + "$ref": "#/definitions/AccessReviewReviewer" + }, + "description": "This is the collection of backup reviewers." + }, + "reviewersType": { + "type": "string", + "readOnly": true, + "description": "This field specifies the type of reviewers for a review. Usually for a review, reviewers are explicitly assigned. However, in some cases, the reviewers may not be assigned and instead be chosen dynamically. For example managers review or self review.", + "enum": [ + "Assigned", + "Self", + "Managers" + ], + "x-ms-enum": { + "name": "AccessReviewScheduleDefinitionReviewersType", + "modelAsString": true + } + }, + "instances": { + "type": "array", + "items": { + "$ref": "#/definitions/AccessReviewInstance" + }, + "description": "This is the collection of instances returned when one does an expand on it." + } + }, + "description": "Access Review." + }, + "AccessReviewInstance": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The access review instance id." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The access review instance name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The resource type." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessReviewInstanceProperties", + "description": "Access Review properties." + } + }, + "description": "Access Review Instance." + }, + "AccessReviewInstanceProperties": { + "type": "object", + "properties": { + "status": { + "type": "string", + "readOnly": true, + "description": "This read-only field specifies the status of an access review instance.", + "enum": [ + "NotStarted", + "InProgress", + "Completed", + "Applied", + "Initializing", + "Applying", + "Completing", + "Scheduled", + "AutoReviewing", + "AutoReviewed", + "Starting" + ], + "x-ms-enum": { + "name": "AccessReviewInstanceStatus", + "modelAsString": true + } + }, + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "The DateTime when the review instance is scheduled to be start.", + "x-nullable": false + }, + "endDateTime": { + "type": "string", + "format": "date-time", + "description": "The DateTime when the review instance is scheduled to end.", + "x-nullable": false + }, + "reviewers": { + "type": "array", + "items": { + "$ref": "#/definitions/AccessReviewReviewer" + }, + "description": "This is the collection of reviewers." + }, + "backupReviewers": { + "type": "array", + "items": { + "$ref": "#/definitions/AccessReviewReviewer" + }, + "description": "This is the collection of backup reviewers." + }, + "reviewersType": { + "type": "string", + "readOnly": true, + "description": "This field specifies the type of reviewers for a review. Usually for a review, reviewers are explicitly assigned. However, in some cases, the reviewers may not be assigned and instead be chosen dynamically. For example managers review or self review.", + "enum": [ + "Assigned", + "Self", + "Managers" + ], + "x-ms-enum": { + "name": "AccessReviewInstanceReviewersType", + "modelAsString": true + } + } + }, + "description": "Access Review Instance properties." + }, + "AccessReviewScheduleSettings": { + "type": "object", + "properties": { + "mailNotificationsEnabled": { + "type": "boolean", + "description": "Flag to indicate whether sending mails to reviewers and the review creator is enabled." + }, + "reminderNotificationsEnabled": { + "type": "boolean", + "description": "Flag to indicate whether sending reminder emails to reviewers are enabled." + }, + "defaultDecisionEnabled": { + "type": "boolean", + "description": "Flag to indicate whether reviewers are required to provide a justification when reviewing access." + }, + "justificationRequiredOnApproval": { + "type": "boolean", + "description": "Flag to indicate whether the reviewer is required to pass justification when recording a decision." + }, + "defaultDecision": { + "type": "string", + "description": "This specifies the behavior for the autoReview feature when an access review completes.", + "enum": [ + "Approve", + "Deny", + "Recommendation" + ], + "x-ms-enum": { + "name": "DefaultDecisionType", + "modelAsString": true + } + }, + "autoApplyDecisionsEnabled": { + "type": "boolean", + "description": "Flag to indicate whether auto-apply capability, to automatically change the target object access resource, is enabled. If not enabled, a user must, after the review completes, apply the access review." + }, + "recommendationsEnabled": { + "type": "boolean", + "description": "Flag to indicate whether showing recommendations to reviewers is enabled." + }, + "recommendationLookBackDuration": { + "type": "string", + "format": "duration", + "description": "Recommendations for access reviews are calculated by looking back at 30 days of data(w.r.t the start date of the review) by default. However, in some scenarios, customers want to change how far back to look at and want to configure 60 days, 90 days, etc. instead. This setting allows customers to configure this duration. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))" + }, + "instanceDurationInDays": { + "type": "integer", + "format": "int32", + "description": "The duration in days for an instance." + }, + "recurrence": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessReviewRecurrenceSettings", + "description": "Access Review Settings." + } + }, + "description": "Settings of an Access Review." + }, + "AccessReviewDefaultSettings": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The access review default settings id. This is only going to be default" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The access review default settings name. This is always going to be Access Review Default Settings" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The resource type." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessReviewScheduleSettings", + "description": "Access Review properties." + } + }, + "description": "Access Review Default Settings." + }, + "AccessReviewRecurrenceSettings": { + "type": "object", + "properties": { + "pattern": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessReviewRecurrencePattern", + "description": "Access Review schedule definition recurrence pattern." + }, + "range": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessReviewRecurrenceRange", + "description": "Access Review schedule definition recurrence range." + } + }, + "description": "Recurrence Settings of an Access Review Schedule Definition." + }, + "AccessReviewRecurrencePattern": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The recurrence type : weekly, monthly, etc.", + "enum": [ + "weekly", + "absoluteMonthly" + ], + "x-ms-enum": { + "name": "AccessReviewRecurrencePatternType", + "modelAsString": true + } + }, + "interval": { + "type": "integer", + "format": "int32", + "description": "The interval for recurrence. For a quarterly review, the interval is 3 for type : absoluteMonthly." + } + }, + "description": "Recurrence Pattern of an Access Review Schedule Definition." + }, + "AccessReviewRecurrenceRange": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The recurrence range type. The possible values are: endDate, noEnd, numbered.", + "enum": [ + "endDate", + "noEnd", + "numbered" + ], + "x-ms-enum": { + "name": "AccessReviewRecurrenceRangeType", + "modelAsString": true + } + }, + "numberOfOccurrences": { + "type": "integer", + "format": "int32", + "description": "The number of times to repeat the access review. Required and must be positive if type is numbered." + }, + "startDate": { + "type": "string", + "format": "date-time", + "description": "The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create.", + "x-nullable": true + }, + "endDate": { + "type": "string", + "format": "date-time", + "description": "The DateTime when the review is scheduled to end. Required if type is endDate", + "x-nullable": true + } + }, + "description": "Recurrence Range of an Access Review Schedule Definition." + }, + "AccessReviewScope": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "readOnly": true, + "description": "ResourceId in which this review is getting created" + }, + "roleDefinitionId": { + "type": "string", + "readOnly": true, + "description": "This is used to indicate the role being reviewed" + }, + "principalType": { + "type": "string", + "readOnly": true, + "description": "The identity type user/servicePrincipal to review", + "enum": [ + "user", + "guestUser", + "servicePrincipal", + "user,group", + "redeemedGuestUser" + ], + "x-ms-enum": { + "name": "AccessReviewScopePrincipalType", + "modelAsString": true + } + }, + "assignmentState": { + "type": "string", + "readOnly": true, + "description": "The role assignment state eligible/active to review", + "enum": [ + "eligible", + "active" + ], + "x-ms-enum": { + "name": "AccessReviewScopeAssignmentState", + "modelAsString": true + } + }, + "inactiveDuration": { + "type": "string", + "format": "duration", + "description": "Duration users are inactive for. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))" + }, + "expandNestedMemberships": { + "type": "boolean", + "description": "Flag to indicate whether to expand nested memberships or not." + } + }, + "description": "Descriptor for what needs to be reviewed" + }, + "AccessReviewReviewer": { + "type": "object", + "properties": { + "principalId": { + "type": "string", + "description": "The id of the reviewer(user/servicePrincipal)" + }, + "principalType": { + "type": "string", + "readOnly": true, + "description": "The identity type : user/servicePrincipal", + "enum": [ + "user", + "servicePrincipal" + ], + "x-ms-enum": { + "name": "AccessReviewReviewerType", + "modelAsString": true + } + } + }, + "description": "Descriptor for what needs to be reviewed" + }, + "AccessReviewDecision": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The access review decision id." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The access review decision name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The resource type." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessReviewDecisionProperties", + "description": "Access Review Decision properties." + } + }, + "description": "Access Review." + }, + "AccessReviewDecisionProperties": { + "type": "object", + "properties": { + "principal": { + "readOnly": true, + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessReviewDecisionIdentity", + "description": "Principal associated with the decision record. Can be AccessReviewDecisionUserIdentity or AccessReviewDecisionServicePrincipalIdentity", + "x-nullable": true + }, + "resource": { + "readOnly": true, + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessReviewDecisionResource", + "description": "Resource associated with this decision record.", + "x-nullable": true + }, + "recommendation": { + "type": "string", + "readOnly": true, + "description": "The feature- generated recommendation shown to the reviewer.", + "enum": [ + "Approve", + "Deny", + "NoInfoAvailable" + ], + "x-ms-enum": { + "name": "AccessRecommendationType", + "modelAsString": true + } + }, + "decision": { + "type": "string", + "description": "The decision on the approval step. This value is initially set to NotReviewed. Approvers can take action of Approve/Deny", + "enum": [ + "Approve", + "Deny", + "NotReviewed", + "DontKnow", + "NotNotified" + ], + "x-ms-enum": { + "name": "AccessReviewResult", + "modelAsString": true + } + }, + "justification": { + "type": "string", + "description": "Justification provided by approvers for their action" + }, + "reviewedDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "Date Time when a decision was taken.", + "x-nullable": true + }, + "reviewedBy": { + "readOnly": true, + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessReviewActorIdentity", + "description": "Details of the approver.", + "x-nullable": true + }, + "applyResult": { + "type": "string", + "readOnly": true, + "description": "The outcome of applying the decision.", + "enum": [ + "New", + "Applying", + "AppliedSuccessfully", + "AppliedWithUnknownFailure", + "AppliedSuccessfullyButObjectNotFound", + "ApplyNotSupported" + ], + "x-ms-enum": { + "name": "AccessReviewApplyResult", + "modelAsString": true + } + }, + "appliedDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The date and time when the review decision was applied.", + "x-nullable": true + }, + "appliedBy": { + "readOnly": true, + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessReviewActorIdentity", + "description": "Details of the approver.", + "x-nullable": true + } + }, + "description": "Approval Step." + }, + "AccessReviewDecisionResource": { + "type": "object", + "discriminator": "type", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "description": "The type of resource", + "enum": [ + "azureRole" + ], + "x-ms-enum": { + "name": "DecisionResourceType", + "modelAsString": true + } + }, + "id": { + "type": "string", + "readOnly": true, + "description": "The id of resource associated with a decision record." + }, + "displayName": { + "type": "string", + "readOnly": true, + "description": "The display name of resource associated with a decision record." + } + }, + "description": "Target of the decision." + }, + "AccessReviewDecisionIdentity": { + "type": "object", + "discriminator": "type", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "description": "The type of decision target : User/ServicePrincipal", + "enum": [ + "user", + "servicePrincipal" + ], + "x-ms-enum": { + "name": "DecisionTargetType", + "modelAsString": true + } + }, + "id": { + "type": "string", + "readOnly": true, + "description": "The id of principal whose access was reviewed." + }, + "displayName": { + "type": "string", + "readOnly": true, + "description": "The display name of the user whose access was reviewed." + } + }, + "description": "Target of the decision." + }, + "AccessReviewDecisionUserIdentity": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AccessReviewDecisionIdentity" + }, + { + "type": "object", + "description": "AccessReviewDecisionUserIdentity" + } + ], + "x-ms-discriminator-value": "user", + "properties": { + "userPrincipalName": { + "type": "string", + "readOnly": true, + "description": "The user principal name of the user whose access was reviewed." + } + }, + "description": "User Decision Target" + }, + "AccessReviewDecisionServicePrincipalIdentity": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AccessReviewDecisionIdentity" + }, + { + "type": "object", + "description": "AccessReviewDecisionServicePrincipalIdentity" + } + ], + "x-ms-discriminator-value": "servicePrincipal", + "properties": { + "appId": { + "type": "string", + "readOnly": true, + "description": "The appId for the service principal entity being reviewed" + } + }, + "description": "Service Principal Decision Target" + }, + "AccessReviewActorIdentity": { + "type": "object", + "properties": { + "principalId": { + "type": "string", + "readOnly": true, + "description": "The identity id" + }, + "principalType": { + "type": "string", + "readOnly": true, + "description": "The identity type : user/servicePrincipal", + "enum": [ + "user", + "servicePrincipal" + ], + "x-ms-enum": { + "name": "AccessReviewActorIdentityType", + "modelAsString": true + } + }, + "principalName": { + "type": "string", + "readOnly": true, + "description": "The identity display name" + }, + "userPrincipalName": { + "type": "string", + "readOnly": true, + "description": "The user principal name(if valid)" + } + }, + "description": "Details of the actor identity" + }, + "AccessReviewContactedReviewer": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The access review reviewer id." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The access review reviewer id." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The resource type." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessReviewContactedReviewerProperties", + "description": "Access Review Contacted Reviewer properties." + } + }, + "description": "Access Review Contacted Reviewer." + }, + "AccessReviewContactedReviewerProperties": { + "type": "object", + "properties": { + "userDisplayName": { + "type": "string", + "description": "The display name of the reviewer", + "readOnly": true + }, + "userPrincipalName": { + "type": "string", + "description": "The user principal name of the reviewer", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "Date Time when the reviewer was contacted.", + "x-nullable": true + } + }, + "description": "Properties of access review contacted reviewer." + }, + "AccessReviewScheduleDefinitionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AccessReviewScheduleDefinition" + }, + "description": "Access Review Schedule Definition list." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "List of Access Review Schedule Definitions." + }, + "AccessReviewInstanceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AccessReviewInstance" + }, + "description": "Access Review Instance list." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "List of Access Review Instances." + }, + "AccessReviewDecisionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AccessReviewDecision" + }, + "description": "Access Review Decision list." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "List of access review decisions." + }, + "AccessReviewContactedReviewerListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AccessReviewContactedReviewer" + }, + "description": "Access Review Contacted Reviewer." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "List of access review contacted reviewers." + }, + "ErrorDefinition": { + "type": "object", + "title": "Error", + "description": "Error description and code explaining why an operation failed.", + "properties": { + "error": { + "$ref": "#/definitions/ErrorDefinitionProperties", + "description": "Error of the list gateway status." + } + } + }, + "ErrorDefinitionProperties": { + "type": "object", + "title": "Error", + "description": "Error description and code explaining why an operation failed.", + "properties": { + "message": { + "type": "string", + "readOnly": true, + "description": "Description of the error." + }, + "code": { + "type": "string", + "description": "Error code of list gateway." + } + } + }, + "Operation": { + "description": "The definition of a Microsoft.Authorization operation.", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation", + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "Display of the operation" + }, + "origin": { + "description": "Origin of the operation", + "type": "string" + } + } + }, + "OperationDisplay": { + "description": "The display information for a Microsoft.Authorization operation.", + "type": "object", + "properties": { + "provider": { + "description": "The resource provider name: Microsoft.Authorization.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "The resource on which the operation is performed.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "The operation that users can perform.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The description for the operation.", + "type": "string", + "readOnly": true + } + } + }, + "OperationListResult": { + "description": "The result of a request to list Microsoft.Authorization operations.", + "type": "object", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next set of paged results.", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the target subscription." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to be used with the HTTP request." + }, + "AccessReviewsFilterParameter": { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Other than standard filters, one custom filter option is supported : 'assignedToMeToReview()'. When one specified $filter=assignedToMeToReview(), only items that are assigned to the calling user to review are returned", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/AccessReviewInstanceAcceptRecommendations.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/AccessReviewInstanceAcceptRecommendations.json new file mode 100644 index 000000000000..ea31f2814614 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/AccessReviewInstanceAcceptRecommendations.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "scheduleDefinitionId": "488a6d0e-0a63-4946-86e3-1f5bbc934661", + "id": "d9b9e056-7004-470b-bf21-1635e98487da" + }, + "responses": { + "204": {} + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/AccessReviewInstanceApplyDecisions.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/AccessReviewInstanceApplyDecisions.json new file mode 100644 index 000000000000..35252e41c385 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/AccessReviewInstanceApplyDecisions.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "subscriptionId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "scheduleDefinitionId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "id": "d9b9e056-7004-470b-bf21-1635e98487da" + }, + "responses": { + "204": {} + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/AccessReviewInstanceResetDecisions.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/AccessReviewInstanceResetDecisions.json new file mode 100644 index 000000000000..35252e41c385 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/AccessReviewInstanceResetDecisions.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "subscriptionId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "scheduleDefinitionId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "id": "d9b9e056-7004-470b-bf21-1635e98487da" + }, + "responses": { + "204": {} + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/AccessReviewInstanceSendReminders.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/AccessReviewInstanceSendReminders.json new file mode 100644 index 000000000000..35252e41c385 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/AccessReviewInstanceSendReminders.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "subscriptionId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "scheduleDefinitionId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "id": "d9b9e056-7004-470b-bf21-1635e98487da" + }, + "responses": { + "204": {} + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/DeleteAccessReviewScheduleDefinition.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/DeleteAccessReviewScheduleDefinition.json new file mode 100644 index 000000000000..16685ee52a98 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/DeleteAccessReviewScheduleDefinition.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "subscriptionId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "scheduleDefinitionId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewDefaultSettings.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewDefaultSettings.json new file mode 100644 index 000000000000..7ead2b63ace4 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewDefaultSettings.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "subscriptionId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d/providers/Microsoft.Authorization/accessReviewSettings/default", + "type": "Microsoft.Authorization/accessReviewSettings", + "name": "default", + "properties": { + "mailNotificationsEnabled": true, + "reminderNotificationsEnabled": true, + "justificationRequiredOnApproval": true, + "recommendationsEnabled": true, + "instanceDurationInDays": 30, + "recurrence": { + "range": { + "type": "endDate", + "numberOfOccurrences": 1, + "startDate": "2018-08-03T21:02:30.667Z", + "endDate": "2018-08-03T21:17:30.513Z" + } + }, + "defaultDecisionEnabled": true, + "defaultDecision": "Approve", + "autoApplyDecisionsEnabled": true + } + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewInstance.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewInstance.json new file mode 100644 index 000000000000..0b0c3880ceba --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewInstance.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "subscriptionId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "scheduleDefinitionId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "id": "4135f961-be78-4005-8101-c72a5af307a2" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d/instances/4135f961-be78-4005-8101-c72a5af307a2", + "type": "Microsoft.Authorization/accessReviewScheduleDefinitions/instances", + "name": "4135f961-be78-4005-8101-c72a5af307a2", + "properties": { + "status": "Applied", + "startDateTime": "2018-08-03T21:02:30.667Z", + "endDateTime": "2018-08-03T21:17:30.513Z" + } + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewInstanceAssignedForMyApproval.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewInstanceAssignedForMyApproval.json new file mode 100644 index 000000000000..cbd3a2490bf7 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewInstanceAssignedForMyApproval.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "scheduleDefinitionId": "488a6d0e-0a63-4946-86e3-1f5bbc934661", + "id": "4135f961-be78-4005-8101-c72a5af307a2", + "$filter": "assignedToMeToReview()" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/488a6d0e-0a63-4946-86e3-1f5bbc934661/instances/4135f961-be78-4005-8101-c72a5af307a2", + "type": "Microsoft.Authorization/accessReviewScheduleDefinitions/instances", + "name": "4135f961-be78-4005-8101-c72a5af307a2", + "properties": { + "status": "Applied", + "startDateTime": "2018-08-03T21:02:30.667Z", + "endDateTime": "2018-08-03T21:17:30.513Z" + } + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewInstanceContactedReviewers.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewInstanceContactedReviewers.json new file mode 100644 index 000000000000..29dfc28b98af --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewInstanceContactedReviewers.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "subscriptionId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "scheduleDefinitionId": "265785a7-a81f-4201-8a18-bb0db95982b7", + "id": "f25ed880-9c31-4101-bc57-825d8df3b58c" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d/instances/f8882fec-7d56-4e97-ad6d-5e3f4557971d/contactedReviewers/fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "type": "Microsoft.Authorization/accessReviewScheduleDefinitions/instances/contactedReviewers", + "name": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "properties": { + "userDisplayName": "Bob", + "userPrincipalName": "bob@contoso.com", + "createdDateTime": "2018-08-03T21:02:30.667Z" + } + } + ] + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewInstanceDecisions.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewInstanceDecisions.json new file mode 100644 index 000000000000..17d978662714 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewInstanceDecisions.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "subscriptionId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "scheduleDefinitionId": "265785a7-a81f-4201-8a18-bb0db95982b7", + "id": "f25ed880-9c31-4101-bc57-825d8df3b58c" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d/instances/f8882fec-7d56-4e97-ad6d-5e3f4557971d/decisions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "type": "Microsoft.Authorization/accessReviewScheduleDefinitions/instances/decisions", + "name": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "properties": { + "reviewedBy": { + "principalType": "user", + "principalId": "a6c7aecb-cbfd-4763-87ef-e91b4bd509d9", + "principalName": "Shubham Gupta", + "userPrincipalName": "shugup@microsoft.com" + }, + "reviewedDateTime": "2018-08-03T21:02:30.667Z", + "decision": "Deny", + "justification": "This person has left this team", + "appliedBy": { + "principalType": "user", + "principalId": "36777fc8-4ec2-49ea-a56c-cec0bd47d83a", + "principalName": "Amit Ghosh", + "userPrincipalName": "amitgho@microsoft.com" + }, + "appliedDateTime": "2018-10-03T21:02:30.667Z", + "applyResult": "Success", + "recommendation": "Deny", + "principal": { + "type": "user", + "id": "a6c7aecb-cbfd-4763-87ef-e91b4bd509d9", + "displayName": "Shubham Gupta", + "userPrincipalName": "shugup@microsoft.com" + }, + "resource": { + "type": "azureRole", + "id": "a6c7aecb-cbfd-4763-87ef-e91b4bd509d9", + "displayName": "Owner" + } + } + } + ] + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewInstanceMyDecisionById.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewInstanceMyDecisionById.json new file mode 100644 index 000000000000..79d779cb192f --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewInstanceMyDecisionById.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "id": "4135f961-be78-4005-8101-c72a5af307a2", + "scheduleDefinitionId": "488a6d0e-0a63-4946-86e3-1f5bbc934661", + "decisionId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/488a6d0e-0a63-4946-86e3-1f5bbc934661/instances/4135f961-be78-4005-8101-c72a5af307a2/decisions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "type": "Microsoft.Authorization/accessReviewScheduleDefinitions/instances/decisions", + "name": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "properties": { + "reviewedBy": { + "principalType": "user", + "principalId": "a6c7aecb-cbfd-4763-87ef-e91b4bd509d9", + "principalName": "Shubham Gupta", + "userPrincipalName": "shugup@microsoft.com" + }, + "reviewedDateTime": "2018-08-03T21:02:30.667Z", + "decision": "Deny", + "justification": "This person has left this team", + "appliedBy": { + "principalType": "user", + "principalId": "36777fc8-4ec2-49ea-a56c-cec0bd47d83a", + "principalName": "Amit Ghosh", + "userPrincipalName": "amitgho@microsoft.com" + }, + "appliedDateTime": "2018-10-03T21:02:30.667Z", + "applyResult": "Success", + "recommendation": "Deny", + "principal": { + "type": "user", + "id": "a6c7aecb-cbfd-4763-87ef-e91b4bd509d9", + "displayName": "Shubham Gupta", + "userPrincipalName": "shugup@microsoft.com" + }, + "resource": { + "type": "azureRole", + "id": "a6c7aecb-cbfd-4763-87ef-e91b4bd509d9", + "displayName": "Owner" + } + } + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewInstanceMyDecisions.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewInstanceMyDecisions.json new file mode 100644 index 000000000000..34adad32b223 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewInstanceMyDecisions.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "scheduleDefinitionId": "488a6d0e-0a63-4946-86e3-1f5bbc934661", + "id": "4135f961-be78-4005-8101-c72a5af307a2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/488a6d0e-0a63-4946-86e3-1f5bbc934661/instances/4135f961-be78-4005-8101-c72a5af307a2/decisions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "type": "Microsoft.Authorization/accessReviewScheduleDefinitions/instances/decisions", + "name": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "properties": { + "reviewedBy": { + "principalType": "user", + "principalId": "a6c7aecb-cbfd-4763-87ef-e91b4bd509d9", + "principalName": "Shubham Gupta", + "userPrincipalName": "shugup@microsoft.com" + }, + "reviewedDateTime": "2018-08-03T21:02:30.667Z", + "decision": "Deny", + "justification": "This person has left this team", + "appliedBy": { + "principalType": "user", + "principalId": "36777fc8-4ec2-49ea-a56c-cec0bd47d83a", + "principalName": "Amit Ghosh", + "userPrincipalName": "amitgho@microsoft.com" + }, + "appliedDateTime": "2018-10-03T21:02:30.667Z", + "applyResult": "Success", + "recommendation": "Deny", + "principal": { + "type": "user", + "id": "a6c7aecb-cbfd-4763-87ef-e91b4bd509d9", + "displayName": "Shubham Gupta", + "userPrincipalName": "shugup@microsoft.com" + }, + "resource": { + "type": "azureRole", + "id": "a6c7aecb-cbfd-4763-87ef-e91b4bd509d9", + "displayName": "Owner" + } + } + } + ] + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewInstances.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewInstances.json new file mode 100644 index 000000000000..21f3fb55469f --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewInstances.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "subscriptionId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "scheduleDefinitionId": "265785a7-a81f-4201-8a18-bb0db95982b7" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d/instances/4135f961-be78-4005-8101-c72a5af307a2", + "type": "Microsoft.Authorization/accessReviewScheduleDefinitions/instances", + "name": "4135f961-be78-4005-8101-c72a5af307a2", + "properties": { + "status": "Applied", + "startDateTime": "2018-08-03T21:02:30.667Z", + "endDateTime": "2018-08-03T21:17:30.513Z" + } + } + ] + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewInstancesAssignedForMyApproval.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewInstancesAssignedForMyApproval.json new file mode 100644 index 000000000000..966ce5c115db --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewInstancesAssignedForMyApproval.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "scheduleDefinitionId": "488a6d0e-0a63-4946-86e3-1f5bbc934661", + "$filter": "assignedToMeToReview()" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/488a6d0e-0a63-4946-86e3-1f5bbc934661/instances/4135f961-be78-4005-8101-c72a5af307a2", + "type": "Microsoft.Authorization/accessReviewScheduleDefinitions/instances", + "name": "4135f961-be78-4005-8101-c72a5af307a2", + "properties": { + "status": "Applied", + "startDateTime": "2018-08-03T21:02:30.667Z", + "endDateTime": "2018-08-03T21:17:30.513Z" + } + } + ] + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewScheduleDefinition.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewScheduleDefinition.json new file mode 100644 index 000000000000..ea660f2a3802 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewScheduleDefinition.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "subscriptionId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "scheduleDefinitionId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "type": "Microsoft.Authorization/accessReviewScheduleDefinitions", + "name": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "properties": { + "displayName": "Hello world", + "status": "InProgress", + "descriptionForAdmins": "asdfasdf", + "descriptionForReviewers": "asdfasdf", + "createdBy": { + "principalType": "user", + "principalId": "a6c7aecb-cbfd-4763-87ef-e91b4bd509d9", + "principalName": "Shubham Gupta", + "userPrincipalName": "shugup@microsoft.com" + }, + "scope": { + "resourceId": "/subscriptions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "roleDefinitionId": "/subscriptions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d/providers/Microsoft.Authorization/roleDefinitions/b225c7ff-4338-4cdc-a790-6b34d987f7cd" + }, + "reviewers": [ + { + "principalId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d ", + "principalType": "user" + } + ], + "reviewersType": "Assigned", + "settings": { + "mailNotificationsEnabled": true, + "reminderNotificationsEnabled": true, + "justificationRequiredOnApproval": true, + "recommendationsEnabled": true, + "instanceDurationInDays": 30, + "recurrence": { + "range": { + "type": "endDate", + "numberOfOccurrences": 1, + "startDate": "2018-08-03T21:02:30.667Z", + "endDate": "2018-08-03T21:17:30.513Z" + } + }, + "defaultDecisionEnabled": true, + "defaultDecision": "Approve", + "autoApplyDecisionsEnabled": true + } + } + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewScheduleDefinitions.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewScheduleDefinitions.json new file mode 100644 index 000000000000..1c08b15bfe96 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewScheduleDefinitions.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "subscriptionId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "type": "Microsoft.Authorization/accessReviewScheduleDefinitions", + "name": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "properties": { + "displayName": "Hello world", + "status": "InProgress", + "descriptionForAdmins": "asdfasdf", + "descriptionForReviewers": "asdfasdf", + "createdBy": { + "principalType": "user", + "principalId": "a6c7aecb-cbfd-4763-87ef-e91b4bd509d9", + "principalName": "Shubham Gupta", + "userPrincipalName": "shugup@microsoft.com" + }, + "scope": { + "resourceId": "/subscriptions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "roleDefinitionId": "/subscriptions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d/providers/Microsoft.Authorization/roleDefinitions/b225c7ff-4338-4cdc-a790-6b34d987f7cd" + }, + "reviewers": [ + { + "principalId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d ", + "principalType": "user" + } + ], + "reviewersType": "Assigned", + "settings": { + "mailNotificationsEnabled": true, + "reminderNotificationsEnabled": true, + "justificationRequiredOnApproval": true, + "recommendationsEnabled": true, + "instanceDurationInDays": 30, + "recurrence": { + "range": { + "type": "endDate", + "numberOfOccurrences": 1, + "startDate": "2018-08-03T21:02:30.667Z", + "endDate": "2018-08-03T21:17:30.513Z" + } + }, + "defaultDecisionEnabled": true, + "defaultDecision": "Approve", + "autoApplyDecisionsEnabled": true + } + } + } + ] + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewScheduleDefinitionsAssignedForMyApproval.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewScheduleDefinitionsAssignedForMyApproval.json new file mode 100644 index 000000000000..7ace3dd0025e --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/GetAccessReviewScheduleDefinitionsAssignedForMyApproval.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "$filter": "assignedToMeToReview()" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "type": "Microsoft.Authorization/accessReviewScheduleDefinitions", + "name": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "properties": { + "displayName": "Hello world", + "status": "InProgress", + "descriptionForAdmins": "asdfasdf", + "descriptionForReviewers": "asdfasdf", + "createdBy": { + "principalType": "user", + "principalId": "a6c7aecb-cbfd-4763-87ef-e91b4bd509d9", + "principalName": "Shubham Gupta", + "userPrincipalName": "shugup@microsoft.com" + }, + "scope": { + "resourceId": "/subscriptions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "roleDefinitionId": "/subscriptions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d/providers/Microsoft.Authorization/roleDefinitions/b225c7ff-4338-4cdc-a790-6b34d987f7cd" + }, + "reviewers": [ + { + "principalId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d ", + "principalType": "user" + } + ], + "reviewersType": "Assigned", + "settings": { + "mailNotificationsEnabled": true, + "reminderNotificationsEnabled": true, + "justificationRequiredOnApproval": true, + "recommendationsEnabled": true, + "instanceDurationInDays": 30, + "recurrence": { + "range": { + "type": "endDate", + "numberOfOccurrences": 1, + "startDate": "2018-08-03T21:02:30.667Z", + "endDate": "2018-08-03T21:17:30.513Z" + } + }, + "defaultDecisionEnabled": true, + "defaultDecision": "Approve", + "autoApplyDecisionsEnabled": true + }, + "instances": [ + { + "id": "/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/488a6d0e-0a63-4946-86e3-1f5bbc934661/instances/4135f961-be78-4005-8101-c72a5af307a2", + "type": "Microsoft.Authorization/accessReviewScheduleDefinitions/instances", + "name": "4135f961-be78-4005-8101-c72a5af307a2", + "properties": { + "status": "Applied", + "startDateTime": "2018-08-03T21:02:30.667Z", + "endDateTime": "2018-08-03T21:17:30.513Z" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/PatchAccessReviewInstanceMyDecisionById.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/PatchAccessReviewInstanceMyDecisionById.json new file mode 100644 index 000000000000..71572f5792e6 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/PatchAccessReviewInstanceMyDecisionById.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "scheduleDefinitionId": "488a6d0e-0a63-4946-86e3-1f5bbc934661", + "id": "4135f961-be78-4005-8101-c72a5af307a2", + "decisionId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "properties": {}, + "body": { + "properties": { + "decision": "Approve", + "justification": "I trust this person." + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/488a6d0e-0a63-4946-86e3-1f5bbc934661/instances/4135f961-be78-4005-8101-c72a5af307a2/decisions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "type": "Microsoft.Authorization/accessReviewScheduleDefinitions/instances/decisions", + "name": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "properties": { + "reviewedBy": { + "principalType": "user", + "principalId": "a6c7aecb-cbfd-4763-87ef-e91b4bd509d9", + "principalName": "Shubham Gupta", + "userPrincipalName": "shugup@microsoft.com" + }, + "reviewedDateTime": "2018-08-03T21:02:30.667Z", + "decision": "Deny", + "justification": "This person has left this team", + "appliedBy": { + "principalType": "user", + "principalId": "36777fc8-4ec2-49ea-a56c-cec0bd47d83a", + "principalName": "Amit Ghosh", + "userPrincipalName": "amitgho@microsoft.com" + }, + "appliedDateTime": "2018-10-03T21:02:30.667Z", + "applyResult": "Success", + "recommendation": "Deny", + "principal": { + "type": "user", + "id": "a6c7aecb-cbfd-4763-87ef-e91b4bd509d9", + "displayName": "Shubham Gupta", + "userPrincipalName": "shugup@microsoft.com" + }, + "resource": { + "type": "azureRole", + "id": "a6c7aecb-cbfd-4763-87ef-e91b4bd509d9", + "displayName": "Owner" + } + } + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/PutAccessReviewDefaultSettings.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/PutAccessReviewDefaultSettings.json new file mode 100644 index 000000000000..c8cbaff919d3 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/PutAccessReviewDefaultSettings.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "subscriptionId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "id": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "properties": {}, + "body": { + "properties": { + "mailNotificationsEnabled": true, + "remindersEnabled": true, + "justificationRequiredOnApproval": true, + "accessRecommendationsEnabled": true, + "recurrenceSettings": { + "recurrenceType": "weekly", + "recurrenceEndType": "never", + "durationInDays": 5, + "recurrenceCount": 0 + }, + "autoReviewEnabled": true, + "autoReviewNotReviewedResult": "Approve", + "autoApplyReviewResultsEnabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d/providers/Microsoft.Authorization/accessReviewSettings/default", + "type": "Microsoft.Authorization/accessReviewSettings", + "name": "default", + "properties": { + "mailNotificationsEnabled": true, + "reminderNotificationsEnabled": true, + "justificationRequiredOnApproval": true, + "recommendationsEnabled": true, + "instanceDurationInDays": 30, + "recurrence": { + "range": { + "type": "endDate", + "numberOfOccurrences": 1, + "startDate": "2018-08-03T21:02:30.667Z", + "endDate": "2018-08-03T21:17:30.513Z" + } + }, + "defaultDecisionEnabled": true, + "defaultDecision": "Approve", + "autoApplyDecisionsEnabled": true + } + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/PutAccessReviewInstance.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/PutAccessReviewInstance.json new file mode 100644 index 000000000000..dd575d005c12 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/PutAccessReviewInstance.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "subscriptionId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "scheduleDefinitionId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "id": "4135f961-be78-4005-8101-c72a5af307a2", + "properties": {}, + "body": { + "properties": { + "status": "InProgress", + "startDateTime": "2018-08-03T21:02:30.667Z", + "endDateTime": "2018-08-03T21:17:30.513Z", + "reviewers": [ + { + "principalId": "89ff94f6-029c-429c-9037-6cf4fe2f4a13", + "principalType": "group" + } + ], + "backupReviewers": [ + { + "principalId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "principalType": "user" + } + ], + "reviewersType": "Assigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d/instances/4135f961-be78-4005-8101-c72a5af307a2", + "type": "Microsoft.Authorization/accessReviewScheduleDefinitions/instances", + "name": "4135f961-be78-4005-8101-c72a5af307a2", + "properties": { + "status": "InProgress", + "startDateTime": "2018-08-03T21:02:30.667Z", + "endDateTime": "2018-08-03T21:17:30.513Z", + "reviewers": [ + { + "principalId": "89ff94f6-029c-429c-9037-6cf4fe2f4a13", + "principalType": "group" + } + ], + "backupReviewers": [ + { + "principalId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "principalType": "user" + } + ], + "reviewersType": "Assigned" + } + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/PutAccessReviewScheduleDefinition.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/PutAccessReviewScheduleDefinition.json new file mode 100644 index 000000000000..8a87014174ee --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/PutAccessReviewScheduleDefinition.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "subscriptionId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "scheduleDefinitionId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "properties": {}, + "body": { + "properties": { + "displayName": "Hello world", + "status": "InProgress", + "descriptionForAdmins": "asdfasdf", + "descriptionForReviewers": "asdfasdf", + "createdBy": { + "principalType": "user", + "principalId": "a6c7aecb-cbfd-4763-87ef-e91b4bd509d9", + "principalName": "Shubham Gupta", + "userPrincipalName": "shugup@microsoft.com" + }, + "scope": { + "resourceId": "/subscriptions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "roleDefinitionId": "/subscriptions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d/providers/Microsoft.Authorization/roleDefinitions/b225c7ff-4338-4cdc-a790-6b34d987f7cd" + }, + "reviewers": [ + { + "principalId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d ", + "principalType": "user" + } + ], + "reviewersType": "Assigned", + "settings": { + "mailNotificationsEnabled": true, + "reminderNotificationsEnabled": true, + "justificationRequiredOnApproval": true, + "recommendationsEnabled": true, + "instanceDurationInDays": 30, + "recurrence": { + "range": { + "type": "endDate", + "numberOfOccurrences": 1, + "startDate": "2018-08-03T21:02:30.667Z", + "endDate": "2018-08-03T21:17:30.513Z" + } + }, + "defaultDecisionEnabled": true, + "defaultDecision": "Approve", + "autoApplyDecisionsEnabled": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "type": "Microsoft.Authorization/accessReviewScheduleDefinitions", + "name": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "properties": { + "displayName": "Hello world", + "status": "InProgress", + "descriptionForAdmins": "asdfasdf", + "descriptionForReviewers": "asdfasdf", + "createdBy": { + "principalType": "user", + "principalId": "a6c7aecb-cbfd-4763-87ef-e91b4bd509d9", + "principalName": "Shubham Gupta", + "userPrincipalName": "shugup@microsoft.com" + }, + "scope": { + "resourceId": "/subscriptions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "roleDefinitionId": "/subscriptions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d/providers/Microsoft.Authorization/roleDefinitions/b225c7ff-4338-4cdc-a790-6b34d987f7cd" + }, + "reviewers": [ + { + "principalId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d ", + "principalType": "user" + } + ], + "reviewersType": "Assigned", + "settings": { + "mailNotificationsEnabled": true, + "reminderNotificationsEnabled": true, + "justificationRequiredOnApproval": true, + "recommendationsEnabled": true, + "instanceDurationInDays": 30, + "recurrence": { + "range": { + "type": "endDate", + "numberOfOccurrences": 1, + "startDate": "2018-08-03T21:02:30.667Z", + "endDate": "2018-08-03T21:17:30.513Z" + } + }, + "defaultDecisionEnabled": true, + "defaultDecision": "Approve", + "autoApplyDecisionsEnabled": true + } + } + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/StopAccessReviewInstance.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/StopAccessReviewInstance.json new file mode 100644 index 000000000000..35252e41c385 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/StopAccessReviewInstance.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "subscriptionId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "scheduleDefinitionId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "id": "d9b9e056-7004-470b-bf21-1635e98487da" + }, + "responses": { + "204": {} + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/StopAccessReviewScheduleDefinition.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/StopAccessReviewScheduleDefinition.json new file mode 100644 index 000000000000..8dceb1a14268 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/StopAccessReviewScheduleDefinition.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "subscriptionId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "scheduleDefinitionId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d" + }, + "responses": { + "204": {} + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/TenantLevelGetAccessReviewInstanceContactedReviewers.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/TenantLevelGetAccessReviewInstanceContactedReviewers.json new file mode 100644 index 000000000000..3ccdf51c0039 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-07-01-preview/examples/TenantLevelGetAccessReviewInstanceContactedReviewers.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "scheduleDefinitionId": "265785a7-a81f-4201-8a18-bb0db95982b7", + "id": "f25ed880-9c31-4101-bc57-825d8df3b58c" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d/instances/f8882fec-7d56-4e97-ad6d-5e3f4557971d/contactedReviewers/fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "type": "Microsoft.Authorization/accessReviewScheduleDefinitions/instances/contactedReviewers", + "name": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d", + "properties": { + "userDisplayName": "Bob", + "userPrincipalName": "bob@contoso.com", + "createdDateTime": "2018-08-03T21:02:30.667Z" + } + } + ] + } + } + } +} diff --git a/specification/authorization/resource-manager/readme.go.md b/specification/authorization/resource-manager/readme.go.md index 5fc1395ba05f..60b1d5130283 100644 --- a/specification/authorization/resource-manager/readme.go.md +++ b/specification/authorization/resource-manager/readme.go.md @@ -2,13 +2,21 @@ These settings apply only when `--go` is specified on the command line. -``` yaml $(go) +``` yaml $(go) && !$(track2) go: license-header: MICROSOFT_MIT_NO_VERSION namespace: authorization clear-output-folder: true ``` +``` yaml $(go) && $(track2) +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/authorization/armauthorization +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) diff --git a/specification/authorization/resource-manager/readme.java.md b/specification/authorization/resource-manager/readme.java.md index be6d12d76089..50d86a2a1032 100644 --- a/specification/authorization/resource-manager/readme.java.md +++ b/specification/authorization/resource-manager/readme.java.md @@ -23,6 +23,20 @@ batch: - tag: package-2020-10-01-preview - tag: package-2021-01-01-preview-only - tag: package-2021-03-01-preview-only + - tag: package-2021-07-01-preview-only +``` + +### Tag: package-2021-07-01-preview-only and java + +These settings apply only when `--tag=package-2021-07-01-preview-only --java` is specified on he command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2021-07-01-preview-only' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.authorization.v2021_07_01_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/authorization/mgmt-v2021_07_01_preview +regenerate-manager: true +generate-interface: true ``` ### Tag: package-2021-03-01-preview-only and java diff --git a/specification/authorization/resource-manager/readme.md b/specification/authorization/resource-manager/readme.md index b5b24935109a..4b666ad7f74f 100644 --- a/specification/authorization/resource-manager/readme.md +++ b/specification/authorization/resource-manager/readme.md @@ -90,6 +90,15 @@ directive: reason: API documentation is not exposed yet. We're making some small changes before publishing documentation. ``` +### Tag: package-2021-07-01-preview-only + +These settings apply only when `--tag=package-2021-07-01-preview-only` is specified on the command line. + +``` yaml $(tag) == 'package-2021-07-01-preview-only' +input-file: +- Microsoft.Authorization/preview/2021-07-01-preview/authorization-AccessReviewCalls.json +``` + ### Tag: package-2021-03-01-preview-only These settings apply only when `--tag=package-2021-03-01-preview-only` is specified on the command line. @@ -341,9 +350,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - after_scripts: - - python ./scripts/multiapi_init_gen.py azure-mgmt-authorization --default-api-version=2018-09-01-preview + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node @@ -362,5 +369,9 @@ See configuration in [readme.go.md](./readme.go.md) See configuration in [readme.java.md](./readme.java.md) +## Python + +See configuration in [readme.python.md](./readme.python.md) + diff --git a/specification/authorization/resource-manager/readme.python.md b/specification/authorization/resource-manager/readme.python.md index f43554d6a8ea..dc4663923c3a 100644 --- a/specification/authorization/resource-manager/readme.python.md +++ b/specification/authorization/resource-manager/readme.python.md @@ -1,26 +1,23 @@ ## Python -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - package-name: azure-mgmt-authorization - clear-output-folder: true - no-namespace-folders: true +These settings apply only when `--track2` is specified on the command line. + +``` yaml $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-authorization +no-namespace-folders: true +package-version: 1.0.0b1 ``` ### Python multi-api Generate all API versions currently shipped for this package -```yaml $(python) && $(multiapi) +```yaml $(multiapi) +clear-output-folder: true batch: + - tag: package-2021-07-01-preview-only - tag: package-2021-03-01-preview-only - tag: package-2021-01-01-preview-only - tag: package-2020-04-01-preview-only @@ -31,6 +28,22 @@ batch: - tag: package-2018-01-01-preview-only - tag: package-2015-07-01 - tag: package-2015-06-01-preview + - multiapiscript: true +``` +``` yaml $(multiapiscript) +output-folder: $(python-sdks-folder)/authorization/azure-mgmt-authorization/azure/mgmt/authorization/ +clear-output-folder: false +perform-load: false +``` + +### Tag: package-2021-07-01-preview-only and python + +These settings apply only when `--tag=package-2021-07-01-preview-only --python` is specified on the command line. + +``` yaml $(tag) == 'package-2021-07-01-preview-only' && $(python) +python: + namespace: azure.mgmt.authorization.v2021_07_01_preview + output-folder: $(python-sdks-folder)/authorization/azure-mgmt-authorization/azure/mgmt/authorization/v2021_07_01_preview ``` ### Tag: package-2021-03-01-preview-only and python @@ -38,9 +51,8 @@ batch: These settings apply only when `--tag=package-2021-03-01-preview-only --python` is specified on the command line. ``` yaml $(tag) == 'package-2021-03-01-preview-only' && $(python) -python: - namespace: azure.mgmt.authorization.v2021_03_01_preview - output-folder: $(python-sdks-folder)/authorization/azure-mgmt-authorization/azure/mgmt/authorization/v2021_03_01_preview +namespace: azure.mgmt.authorization.v2021_03_01_preview +output-folder: $(python-sdks-folder)/authorization/azure-mgmt-authorization/azure/mgmt/authorization/v2021_03_01_preview ``` ### Tag: package-2020-04-01-preview-only and python @@ -48,9 +60,8 @@ python: These settings apply only when `--tag=package-2020-04-01-preview-only --python` is specified on the command line. ``` yaml $(tag) == 'package-2020-04-01-preview-only' && $(python) -python: - namespace: azure.mgmt.authorization.v2020_04_01_preview - output-folder: $(python-sdks-folder)/authorization/azure-mgmt-authorization/azure/mgmt/authorization/v2020_04_01_preview +namespace: azure.mgmt.authorization.v2020_04_01_preview +output-folder: $(python-sdks-folder)/authorization/azure-mgmt-authorization/azure/mgmt/authorization/v2020_04_01_preview ``` ### Tag: package-2018-09-01-preview-only and python @@ -58,9 +69,8 @@ python: These settings apply only when `--tag=package-2018-09-01-preview-only --python` is specified on the command line. ``` yaml $(tag) == 'package-2018-09-01-preview-only' && $(python) -python: - namespace: azure.mgmt.authorization.v2018_09_01_preview - output-folder: $(python-sdks-folder)/authorization/azure-mgmt-authorization/azure/mgmt/authorization/v2018_09_01_preview +namespace: azure.mgmt.authorization.v2018_09_01_preview +output-folder: $(python-sdks-folder)/authorization/azure-mgmt-authorization/azure/mgmt/authorization/v2018_09_01_preview ``` ### Tag: package-2018-07-01-preview-only and python @@ -68,9 +78,8 @@ python: These settings apply only when `--tag=package-2018-07-01-preview-only --python` is specified on the command line. ``` yaml $(tag) == 'package-2018-07-01-preview-only' && $(python) -python: - namespace: azure.mgmt.authorization.v2018_07_01_preview - output-folder: $(python-sdks-folder)/authorization/azure-mgmt-authorization/azure/mgmt/authorization/v2018_07_01_preview +namespace: azure.mgmt.authorization.v2018_07_01_preview +output-folder: $(python-sdks-folder)/authorization/azure-mgmt-authorization/azure/mgmt/authorization/v2018_07_01_preview ``` ### Tag: package-2018-05-01-preview and python @@ -78,9 +87,8 @@ python: These settings apply only when `--tag=package-2018-05-01-preview --python` is specified on the command line. ``` yaml $(tag) == 'package-2018-05-01-preview' && $(python) -python: - namespace: azure.mgmt.authorization.v2018_05_01_preview - output-folder: $(python-sdks-folder)/authorization/azure-mgmt-authorization/azure/mgmt/authorization/v2018_05_01_preview +namespace: azure.mgmt.authorization.v2018_05_01_preview +output-folder: $(python-sdks-folder)/authorization/azure-mgmt-authorization/azure/mgmt/authorization/v2018_05_01_preview ``` ### Tag: package-2018-01-01-preview-only and python @@ -88,9 +96,8 @@ python: These settings apply only when `--tag=package-2018-01-01-preview-only --python` is specified on the command line. ``` yaml $(tag) == 'package-2018-01-01-preview-only' && $(python) -python: - namespace: azure.mgmt.authorization.v2018_01_01_preview - output-folder: $(python-sdks-folder)/authorization/azure-mgmt-authorization/azure/mgmt/authorization/v2018_01_01_preview +namespace: azure.mgmt.authorization.v2018_01_01_preview +output-folder: $(python-sdks-folder)/authorization/azure-mgmt-authorization/azure/mgmt/authorization/v2018_01_01_preview ``` ### Tag: package-2015-07-01 and python @@ -98,9 +105,8 @@ python: These settings apply only when `--tag=package-2015-07-01 --python` is specified on the command line. ``` yaml $(tag) == 'package-2015-07-01' && $(python) -python: - namespace: azure.mgmt.authorization.v2015_07_01 - output-folder: $(python-sdks-folder)/authorization/azure-mgmt-authorization/azure/mgmt/authorization/v2015_07_01 +namespace: azure.mgmt.authorization.v2015_07_01 +output-folder: $(python-sdks-folder)/authorization/azure-mgmt-authorization/azure/mgmt/authorization/v2015_07_01 ``` ### Tag: 2015-06-01-preview and python @@ -108,9 +114,8 @@ python: These settings apply only when `--tag=2015-06-01-preview --python` is specified on the command line. ``` yaml $(tag) == 'package-2015-06-01-preview' && $(python) -python: - namespace: azure.mgmt.authorization.v2015_06_01 - output-folder: $(python-sdks-folder)/authorization/azure-mgmt-authorization/azure/mgmt/authorization/v2015_06_01 +namespace: azure.mgmt.authorization.v2015_06_01 +output-folder: $(python-sdks-folder)/authorization/azure-mgmt-authorization/azure/mgmt/authorization/v2015_06_01 ``` ### Tag: package-2021-01-01-preview-only and python @@ -118,16 +123,14 @@ python: These settings apply only when `--tag=package-2021-01-01-preview-only --python` is specified on the command line. ``` yaml $(tag) == 'package-2021-01-01-preview-only' && $(python) -python: - namespace: azure.mgmt.authorization.v2021_01_01_preview - output-folder: $(python-sdks-folder)/authorization/azure-mgmt-authorization/azure/mgmt/authorization/v2021_01_01_preview +namespace: azure.mgmt.authorization.v2021_01_01_preview +output-folder: $(python-sdks-folder)/authorization/azure-mgmt-authorization/azure/mgmt/authorization/v2021_01_01_preview ``` ### Tag: package-2020-10-01-preview and python These settings apply only when `--tag=package-2020-10-01-preview --python` is specified on the command line. ``` yaml $(tag) == 'package-2020-10-01-preview' && $(python) -python: - namespace: azure.mgmt.authorization.v2020_10_01_preview - output-folder: $(python-sdks-folder)/authorization/azure-mgmt-authorization/azure/mgmt/authorization/v2020_10_01_preview +namespace: azure.mgmt.authorization.v2020_10_01_preview +output-folder: $(python-sdks-folder)/authorization/azure-mgmt-authorization/azure/mgmt/authorization/v2020_10_01_preview ``` \ No newline at end of file diff --git a/specification/authorization/resource-manager/readme.ruby.md b/specification/authorization/resource-manager/readme.ruby.md index f51bc0959efd..ba8997c7253a 100644 --- a/specification/authorization/resource-manager/readme.ruby.md +++ b/specification/authorization/resource-manager/readme.ruby.md @@ -20,6 +20,7 @@ batch: - tag: package-2020-10-01-preview - tag: package-2021-01-01-preview-only - tag: package-2021-03-01-preview-only + - tag: package-2021-07-01-preview-only ``` ### Tag: package-2015-07-01 and ruby @@ -102,3 +103,13 @@ Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2021-07-01-preview-only' && $(ruby) +namespace: "Azure::Authorization::Mgmt::V2021_07_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_authorization/lib +``` diff --git a/specification/authorization/resource-manager/readme.typescript.md b/specification/authorization/resource-manager/readme.typescript.md index f491412a6532..c237c5e19fd4 100644 --- a/specification/authorization/resource-manager/readme.typescript.md +++ b/specification/authorization/resource-manager/readme.typescript.md @@ -12,7 +12,7 @@ typescript: payload-flattening-threshold: 1 ``` -``` yaml $(typescript) && !$(profile) +``` yaml $(typescript) && !$(profile-content) typescript: package-name: "@azure/arm-authorization" output-folder: "$(typescript-sdks-folder)/sdk/authorization/arm-authorization" @@ -21,9 +21,9 @@ typescript: ### Profile: profile-hybrid-2019-03-01 -These settings apply only when `--profile=profile-hybrid-2019-03-01` is specified on the command line. +These settings apply only when `--profile-content=profile-hybrid-2019-03-01` is specified on the command line. -``` yaml $(profile)=='profile-hybrid-2019-03-01' +``` yaml $(profile-content)=='profile-hybrid-2019-03-01' typescript: package-name: "@azure/arm-authorization-profile-2019-03-01-hybrid" output-folder: "$(typescript-sdks-folder)/sdk/authorization/arm-authorization-profile-2019-03-01-hybrid" @@ -34,9 +34,9 @@ typescript: ### Profile: profile-hybrid-2020-09-01 -These settings apply only when `--profile=profile-hybrid-2020-09-01` is specified on the command line. +These settings apply only when `--profile-content=profile-hybrid-2020-09-01` is specified on the command line. -``` yaml $(profile)=='profile-hybrid-2020-09-01' +``` yaml $(profile-content)=='profile-hybrid-2020-09-01' typescript: package-name: "@azure/arm-authorization-profile-2020-09-01-hybrid" output-folder: "$(typescript-sdks-folder)/sdk/authorization/arm-authorization-profile-2020-09-01-hybrid" @@ -47,9 +47,9 @@ typescript: ### Profile: package-2020-10-01-preview -These settings apply only when `--profile=package-2020-10-01-preview` is specified on the command line. +These settings apply only when `--profile-content=package-2020-10-01-preview` is specified on the command line. -``` yaml $(profile)=='package-2020-10-01-preview' +``` yaml $(profile-content)=='package-2020-10-01-preview' typescript: package-name: "@azure/arm-authorization-package-2020-10-01-preview" output-folder: "$(typescript-sdks-folder)/sdk/authorization/arm-authorization-package-2020-10-01-preview" diff --git a/specification/automation/resource-manager/readme.md b/specification/automation/resource-manager/readme.md index 333ec8249cba..a6d099417107 100644 --- a/specification/automation/resource-manager/readme.md +++ b/specification/automation/resource-manager/readme.md @@ -270,7 +270,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-go - repo: azure-sdk-for-js diff --git a/specification/automation/resource-manager/readme.python.md b/specification/automation/resource-manager/readme.python.md index 0ca10a24ffb3..761572592260 100644 --- a/specification/automation/resource-manager/readme.python.md +++ b/specification/automation/resource-manager/readme.python.md @@ -2,35 +2,14 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.automation - package-name: azure-mgmt-automation - package-version: 0.1.1 - clear-output-folder: true -``` ``` yaml $(python) && $(track2) -python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.automation package-name: azure-mgmt-automation package-version: 1.0.0b1 clear-output-folder: true -modelerfour: - lenient-model-deduplication: true -``` - -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/automation/azure-mgmt-automation/azure/mgmt/automation ``` ``` yaml $(python) && $(python-mode) == 'update' && $(track2) @@ -38,13 +17,13 @@ no-namespace-folders: true output-folder: $(python-sdks-folder)/automation/azure-mgmt-automation/azure/mgmt/automation ``` -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/automation/azure-mgmt-automation -``` ``` yaml $(python) && $(python-mode) == 'create' && $(track2) basic-setup-py: true output-folder: $(python-sdks-folder)/automation/azure-mgmt-automation ``` + +``` yaml $(python) && $(track2) +modelerfour: + lenient-model-deduplication: true +``` \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/Compute.json b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/Compute.json index 2629d4674821..c1427ac94da9 100644 --- a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/Compute.json +++ b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/Compute.json @@ -29,7 +29,7 @@ "operationId": "Operations_List", "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -38,6 +38,12 @@ "schema": { "$ref": "#/definitions/OperationList" } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "schema": { + "$ref": "Compute.json#/definitions/CrpErrorResponse" + } } }, "x-ms-pageable": { @@ -73,6 +79,32 @@ }, "x-ms-azure-resource": true }, + "CrpResource": { + "description": "Base resource object.", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "description": "ID of the resource.", + "type": "string" + }, + "name": { + "readOnly": true, + "description": "Name of the resource.", + "type": "string" + }, + "type": { + "readOnly": true, + "description": "Type of Resource.", + "type": "string" + }, + "location": { + "description": "Location of the resource.", + "type": "string" + } + }, + "x-ms-azure-resource": true + }, "ProvisioningState": { "description": "The provisioning state of the resource.", "enum": [ @@ -88,6 +120,7 @@ }, "Operation": { "description": "Describes the supported REST operation.", + "type": "object", "properties": { "name": { "description": "The name of the operation being performed on this particular object. This name should match the name that appears in RBAC or the event service.", @@ -106,6 +139,7 @@ }, "Display": { "description": "Contains the localized display information for this particular operation or action.", + "type": "object", "properties": { "provider": { "description": "The localized, friendly version of the resource provider name. The provider name is expected to include the name of the publisher or company responsible. The provider name format should use title case and begin with \"Microsoft\" for first-party services. For example, the provider name may be\"Microsoft Monitoring Insights\" or \"Microsoft Compute.\"", @@ -127,6 +161,7 @@ }, "OperationList": { "description": "List of Operations", + "type": "object", "properties": { "value": { "description": "Array of operations", @@ -140,6 +175,54 @@ "type": "string" } } + }, + "ErrorDetail": { + "description": "The error detail.", + "type": "object", + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "The error code." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "The error message." + }, + "target": { + "readOnly": true, + "type": "string", + "description": "The error target." + } + } + }, + "CrpErrorResponse": { + "title": "Error response", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "type": "object", + "properties": { + "error": { + "description": "The error object.", + "$ref": "#/definitions/ErrorDetail" + } + } + }, + "ErrorAdditionalInfo": { + "type": "object", + "properties": { + "type": { + "readOnly": true, + "type": "string", + "description": "The additional info type." + }, + "info": { + "readOnly": true, + "type": "object", + "description": "The additional info." + } + }, + "description": "The resource management error additional info." } }, "parameters": { @@ -150,14 +233,6 @@ "required": true, "type": "string" }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "Client API Version.", - "required": true, - "type": "string", - "default": "2015-12-01-preview" - }, "LocationParameter": { "description": "Location of the resource.", "name": "location", diff --git a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/PlatformImages.json b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/PlatformImages.json index eeeac1dc49a7..0ea7cf5e15ae 100644 --- a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/PlatformImages.json +++ b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/PlatformImages.json @@ -36,7 +36,7 @@ "$ref": "Compute.json#/parameters/LocationParameter" }, { - "$ref": "Compute.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -45,6 +45,12 @@ "schema": { "$ref": "#/definitions/PlatformImageList" } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "schema": { + "$ref": "Compute.json#/definitions/CrpErrorResponse" + } } } } @@ -82,7 +88,7 @@ "$ref": "Compute.json#/parameters/VersionParameter" }, { - "$ref": "Compute.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -91,6 +97,12 @@ "schema": { "$ref": "#/definitions/PlatformImage" } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "schema": { + "$ref": "Compute.json#/definitions/CrpErrorResponse" + } } } }, @@ -126,7 +138,7 @@ "$ref": "Compute.json#/parameters/VersionParameter" }, { - "$ref": "Compute.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/NewPlatformImageParameter" @@ -150,6 +162,12 @@ "schema": { "$ref": "#/definitions/PlatformImage" } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "schema": { + "$ref": "Compute.json#/definitions/CrpErrorResponse" + } } }, "x-ms-long-running-operation": true @@ -186,10 +204,16 @@ "$ref": "Compute.json#/parameters/VersionParameter" }, { - "$ref": "Compute.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "schema": { + "$ref": "Compute.json#/definitions/CrpErrorResponse" + } + }, "200": { "description": "OK" } @@ -210,7 +234,7 @@ }, "allOf": [ { - "$ref": "Compute.json#/definitions/Resource" + "$ref": "Compute.json#/definitions/CrpResource" } ] }, diff --git a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/Quotas.json b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/Quotas.json index 046fa9229b43..614d08736800 100644 --- a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/Quotas.json +++ b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/Quotas.json @@ -39,7 +39,7 @@ "$ref": "#/parameters/QuotaParameter" }, { - "$ref": "Compute.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -80,7 +80,7 @@ "$ref": "#/parameters/QuotaParameter" }, { - "$ref": "Compute.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/NewQuotaParameter" @@ -124,7 +124,7 @@ "$ref": "#/parameters/QuotaParameter" }, { - "$ref": "Compute.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -161,7 +161,7 @@ "$ref": "Compute.json#/parameters/LocationParameter" }, { - "$ref": "Compute.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -191,7 +191,7 @@ }, "allOf": [ { - "$ref": "Compute.json#/definitions/Resource" + "$ref": "Compute.json#/definitions/CrpResource" } ] }, diff --git a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/VMExtensions.json b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/VMExtensions.json index 933404e75268..f7972ddfce81 100644 --- a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/VMExtensions.json +++ b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/VMExtensions.json @@ -45,7 +45,7 @@ "$ref": "Compute.json#/parameters/VersionParameter" }, { - "$ref": "Compute.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -54,6 +54,12 @@ "schema": { "$ref": "#/definitions/VMExtension" } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "schema": { + "$ref": "Compute.json#/definitions/CrpErrorResponse" + } } } }, @@ -92,7 +98,7 @@ "$ref": "Compute.json#/parameters/VersionParameter" }, { - "$ref": "Compute.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/VMExtensionParameter" @@ -110,6 +116,12 @@ "schema": { "$ref": "#/definitions/VMExtension" } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "schema": { + "$ref": "Compute.json#/definitions/CrpErrorResponse" + } } } }, @@ -148,12 +160,18 @@ "$ref": "Compute.json#/parameters/VersionParameter" }, { - "$ref": "Compute.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK" + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "schema": { + "$ref": "Compute.json#/definitions/CrpErrorResponse" + } } } } @@ -185,7 +203,7 @@ "$ref": "Compute.json#/parameters/LocationParameter" }, { - "$ref": "Compute.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -194,6 +212,12 @@ "schema": { "$ref": "#/definitions/VMExtensionList" } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "schema": { + "$ref": "Compute.json#/definitions/CrpErrorResponse" + } } } } @@ -212,7 +236,7 @@ }, "allOf": [ { - "$ref": "Compute.json#/definitions/Resource" + "$ref": "Compute.json#/definitions/CrpResource" } ] }, diff --git a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/examples/Operations/List.json b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/examples/Operations/List.json index ed7fc4ebeeb6..3c478352aa0f 100644 --- a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/examples/Operations/List.json +++ b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/examples/Operations/List.json @@ -114,6 +114,15 @@ "description": "Delete any VMExtension" } }, + { + "name": "Microsoft.Compute.Admin/locations/computeScaleUnits/read", + "display": { + "provider": "Microsoft Compute Admin", + "resource": "ScaleUnitView", + "operation": "Get scale unit view", + "description": "Get scale unit view" + } + }, { "name": "Microsoft.Compute.Admin/locations/Disks/read", "display": { diff --git a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-02-09/Quotas.json b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-02-09/Quotas.json index e8517f1d54e0..599fe25344e2 100644 --- a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-02-09/Quotas.json +++ b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-02-09/Quotas.json @@ -39,7 +39,7 @@ "$ref": "Quotas.json#/parameters/QuotaParameter" }, { - "$ref": "Quotas.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -80,7 +80,7 @@ "$ref": "Quotas.json#/parameters/QuotaParameter" }, { - "$ref": "Quotas.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "Quotas.json#/parameters/NewQuotaParameter" @@ -124,7 +124,7 @@ "$ref": "Quotas.json#/parameters/QuotaParameter" }, { - "$ref": "Quotas.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -161,7 +161,7 @@ "$ref": "../2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { - "$ref": "Quotas.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -256,13 +256,6 @@ } }, "parameters": { - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "Client API Version.", - "required": true, - "type": "string" - }, "QuotaParameter": { "description": "Name of the quota.", "name": "quotaName", diff --git a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-07-30-preview/DiskMigrationJobs.json b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-07-30-preview/DiskMigrationJobs.json index 2456dcf23c55..0a1302baa3f9 100644 --- a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-07-30-preview/DiskMigrationJobs.json +++ b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-07-30-preview/DiskMigrationJobs.json @@ -39,7 +39,7 @@ "$ref": "DiskMigrationJobs.json#/parameters/MigrationJobStatusParameter" }, { - "$ref": "Disks.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -48,6 +48,12 @@ "schema": { "$ref": "DiskMigrationJobs.json#/definitions/DiskMigrationJobList" } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "schema": { + "$ref": "../2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" + } } }, "x-ms-pageable": { @@ -78,7 +84,7 @@ "$ref": "DiskMigrationJobs.json#/parameters/MigrationIdParameter" }, { - "$ref": "Disks.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -87,6 +93,12 @@ "schema": { "$ref": "DiskMigrationJobs.json#/definitions/DiskMigrationJob" } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "schema": { + "$ref": "../2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" + } } } }, @@ -124,7 +136,7 @@ "$ref": "DiskMigrationJobs.json#/parameters/DiskListParameter" }, { - "$ref": "Disks.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -133,6 +145,12 @@ "schema": { "$ref": "DiskMigrationJobs.json#/definitions/DiskMigrationJob" } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "schema": { + "$ref": "../2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" + } } } } @@ -160,7 +178,7 @@ "$ref": "DiskMigrationJobs.json#/parameters/MigrationIdParameter" }, { - "$ref": "Disks.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -169,6 +187,12 @@ "schema": { "$ref": "DiskMigrationJobs.json#/definitions/DiskMigrationJob" } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "schema": { + "$ref": "../2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" + } } } } diff --git a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-07-30-preview/Disks.json b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-07-30-preview/Disks.json index b0bfd8aa99e9..3dd553e131ba 100644 --- a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-07-30-preview/Disks.json +++ b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-07-30-preview/Disks.json @@ -57,7 +57,7 @@ "$ref": "Disks.json#/parameters/DiskStartParameter" }, { - "$ref": "Disks.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -66,6 +66,12 @@ "schema": { "$ref": "Disks.json#/definitions/DiskList" } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "schema": { + "$ref": "../2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" + } } }, "x-ms-pageable": { @@ -96,7 +102,7 @@ "$ref": "Disks.json#/parameters/DiskIdParameter" }, { - "$ref": "Disks.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -105,6 +111,12 @@ "schema": { "$ref": "Disks.json#/definitions/Disk" } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "schema": { + "$ref": "../2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" + } } } } @@ -248,14 +260,6 @@ } }, "parameters": { - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "Client API Version.", - "required": true, - "type": "string", - "default": "2018-07-30-preview" - }, "UserSubscriptionIdParameter": { "description": "User Subscription Id which the resource belongs to.", "name": "userSubscriptionId", diff --git a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-07-30-preview/examples/DiskMigrationJobs/Create.json b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-07-30-preview/examples/DiskMigrationJobs/Create.json index 45b134eda4b3..504e0202d3d0 100644 --- a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-07-30-preview/examples/DiskMigrationJobs/Create.json +++ b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-07-30-preview/examples/DiskMigrationJobs/Create.json @@ -7,9 +7,6 @@ "targetShare": "\\\\SU1FileServer.mydomain.com\\SU1_ObjStore_1", "disks": [ { - "id": "/subscriptions/04666444-56f0-4d4f-afc5-dbd6b134b084/providers/Microsoft.Compute.Admin/locations/redmond/disks/423e4eb4-f791-4d13-ad5b-4d415733b0d6", - "name": "redmond/423e4eb4-f791-4d13-ad5b-4d415733b0d6", - "type": "Microsoft.Compute.Admin/locations/disks", "location": "redmond", "properties": { "diskId": "423e4eb4-f791-4d13-ad5b-4d415733b0d6", @@ -18,9 +15,6 @@ } }, { - "id": "/subscriptions/04666444-56f0-4d4f-afc5-dbd6b134b084/providers/Microsoft.Compute.Admin/locations/redmond/disks/48dc9b56-5883-4011-9dc3-0e527f33e6ab", - "name": "redmond/48dc9b56-5883-4011-9dc3-0e527f33e6ab", - "type": "Microsoft.Compute.Admin/locations/disks", "location": "redmond", "properties": { "diskId": "48dc9b56-5883-4011-9dc3-0e527f33e6ab", diff --git a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2020-11-01/Features.json b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2020-11-01/Features.json index 08e49c717a68..298398535e20 100644 --- a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2020-11-01/Features.json +++ b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2020-11-01/Features.json @@ -30,16 +30,16 @@ ], "parameters": [ { - "$ref": "Features.json#/parameters/SubscriptionIdParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "Features.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { "$ref": "Features.json#/parameters/FeatureParameter" }, { - "$ref": "Features.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -50,9 +50,9 @@ } }, "default": { - "description": "Default error response.", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "schema": { - "$ref": "#/definitions/ErrorDetails" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" } } } @@ -79,13 +79,13 @@ ], "parameters": [ { - "$ref": "Features.json#/parameters/SubscriptionIdParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "Features.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { - "$ref": "Features.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -96,9 +96,9 @@ } }, "default": { - "description": "Default error response.", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "schema": { - "$ref": "#/definitions/ErrorDetails" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" } } }, @@ -128,16 +128,16 @@ ], "parameters": [ { - "$ref": "Features.json#/parameters/SubscriptionIdParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "Features.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { "$ref": "Features.json#/parameters/FeatureParameter" }, { - "$ref": "Features.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "Features.json#/parameters/GlobalFeatureSettingsParameter" @@ -148,9 +148,9 @@ "description": "OK" }, "default": { - "description": "Default error response.", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "schema": { - "$ref": "#/definitions/ErrorDetails" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" } } } @@ -177,16 +177,16 @@ ], "parameters": [ { - "$ref": "Features.json#/parameters/SubscriptionIdParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "Features.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { "$ref": "Features.json#/parameters/FeatureParameter" }, { - "$ref": "Features.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "Features.json#/parameters/TenantSubscriptionFeatureSettingsParameter" @@ -197,9 +197,9 @@ "description": "OK" }, "default": { - "description": "Default error response.", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "schema": { - "$ref": "#/definitions/ErrorDetails" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" } } } @@ -226,16 +226,16 @@ ], "parameters": [ { - "$ref": "Features.json#/parameters/SubscriptionIdParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "Features.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { "$ref": "Features.json#/parameters/FeatureParameter" }, { - "$ref": "Features.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "Features.json#/parameters/TenantSubscriptionFeatureSettingsParameter" @@ -246,9 +246,9 @@ "description": "OK" }, "default": { - "description": "Default error response.", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "schema": { - "$ref": "#/definitions/ErrorDetails" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" } } } @@ -268,7 +268,7 @@ }, "allOf": [ { - "$ref": "#/definitions/Resource" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/definitions/CrpResource" } ] }, @@ -341,88 +341,9 @@ "type": "string" } } - }, - "ErrorDetails": { - "description": "Error details.", - "type": "object", - "properties": { - "error": { - "description": "Object containing error details.", - "$ref": "#/definitions/ErrorDetailsInternal" - } - } - }, - "ErrorDetailsInternal": { - "description": "Error details.", - "type": "object", - "properties": { - "code": { - "description": "The error code.", - "type": "string", - "readOnly": true - }, - "message": { - "description": "The error message.", - "type": "string", - "readOnly": true - }, - "target": { - "description": "The target of the particular error.", - "type": "string", - "readOnly": true - } - } - }, - "Resource": { - "description": "Base resource object.", - "type": "object", - "properties": { - "id": { - "readOnly": true, - "description": "ID of the resource.", - "type": "string" - }, - "name": { - "readOnly": true, - "description": "Name of the resource.", - "type": "string" - }, - "type": { - "readOnly": true, - "description": "Type of Resource.", - "type": "string" - }, - "location": { - "description": "Location of the resource.", - "type": "string" - } - }, - "x-ms-azure-resource": true } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", - "required": true, - "type": "string" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "Client API Version.", - "required": true, - "type": "string" - }, - "LocationParameter": { - "description": "Location of the resource.", - "name": "location", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, "FeatureParameter": { "description": "Name of the feature.", "name": "featureName", diff --git a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-01-01/Quotas.json b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-01-01/Quotas.json index 34ec689cfc5e..b776b710b058 100644 --- a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-01-01/Quotas.json +++ b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-01-01/Quotas.json @@ -30,16 +30,16 @@ ], "parameters": [ { - "$ref": "Quotas.json#/parameters/SubscriptionIdParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "Quotas.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { "$ref": "Quotas.json#/parameters/QuotaParameter" }, { - "$ref": "Quotas.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -48,6 +48,12 @@ "schema": { "$ref": "Quotas.json#/definitions/Quota" } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "schema": { + "$ref": "../../preview/2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" + } } } }, @@ -71,16 +77,16 @@ ], "parameters": [ { - "$ref": "Quotas.json#/parameters/SubscriptionIdParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "Quotas.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { "$ref": "Quotas.json#/parameters/QuotaParameter" }, { - "$ref": "Quotas.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "$ref": "Quotas.json#/parameters/NewQuotaParameter" @@ -92,6 +98,12 @@ "schema": { "$ref": "Quotas.json#/definitions/Quota" } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "schema": { + "$ref": "../../preview/2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" + } } } }, @@ -115,21 +127,27 @@ ], "parameters": [ { - "$ref": "Quotas.json#/parameters/SubscriptionIdParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "Quotas.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { "$ref": "Quotas.json#/parameters/QuotaParameter" }, { - "$ref": "Quotas.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK" + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "schema": { + "$ref": "../../preview/2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" + } } } } @@ -155,13 +173,13 @@ ], "parameters": [ { - "$ref": "Quotas.json#/parameters/SubscriptionIdParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "Quotas.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { - "$ref": "Quotas.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -170,6 +188,12 @@ "schema": { "$ref": "Quotas.json#/definitions/QuotaList" } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "schema": { + "$ref": "../../preview/2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" + } } }, "x-ms-pageable": { @@ -191,7 +215,7 @@ }, "allOf": [ { - "$ref": "#/definitions/Resource" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/definitions/CrpResource" } ] }, @@ -265,57 +289,9 @@ } } } - }, - "Resource": { - "description": "Base resource object.", - "type": "object", - "properties": { - "id": { - "readOnly": true, - "description": "ID of the resource.", - "type": "string" - }, - "name": { - "readOnly": true, - "description": "Name of the resource.", - "type": "string" - }, - "type": { - "readOnly": true, - "description": "Type of Resource.", - "type": "string" - }, - "location": { - "description": "Location of the resource.", - "type": "string" - } - }, - "x-ms-azure-resource": true } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", - "required": true, - "type": "string" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "Client API Version.", - "required": true, - "type": "string" - }, - "LocationParameter": { - "description": "Location of the resource.", - "name": "location", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, "QuotaParameter": { "description": "Name of the quota.", "name": "quotaName", diff --git a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-03-30/ScaleUnits.json b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-03-30/ScaleUnits.json new file mode 100644 index 000000000000..5fae6684baaf --- /dev/null +++ b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-03-30/ScaleUnits.json @@ -0,0 +1,220 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-03-30", + "title": "Compute Admin Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute.Admin/locations/{location}/computeScaleUnits/{scaleUnitName}": { + "get": { + "x-ms-examples": { + "Get an existing scale set.": { + "$ref": "./examples/ScaleUnits/Get.json" + } + }, + "tags": [ + "ScaleUnits" + ], + "summary": "Returns the scale unit view.", + "description": "Get the scale unit view.", + "operationId": "ScaleUnits_Get", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" + }, + { + "$ref": "ScaleUnits.json#/parameters/ScaleUnitParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "ScaleUnits.json#/definitions/ScaleUnit" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "schema": { + "$ref": "../../preview/2015-12-01-preview/Compute.json#/definitions/CrpErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ScaleUnit": { + "description": "The scale unit operator view.", + "type": "object", + "properties": { + "properties": { + "description": "The scale unit operator view properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScaleUnitProperties" + } + }, + "allOf": [ + { + "$ref": "../../preview/2015-12-01-preview/Compute.json#/definitions/Resource" + } + ] + }, + "ScaleUnitProperties": { + "description": "Properties for a scale unit", + "type": "object", + "properties": { + "scaleUnitName": { + "description": "The name of the scale unit.", + "type": "string" + }, + "lastUpdatedTime": { + "description": "The scale unit last update time (UTC).", + "type": "string" + }, + "nodes": { + "description": "The nodes of the scale unit.", + "type": "array", + "items": { + "$ref": "#/definitions/NodeView" + } + } + } + }, + "NodeView": { + "description": "Properties for a node", + "type": "object", + "properties": { + "nodeName": { + "description": "The name of the node.", + "type": "string" + }, + "lastUpdatedTime": { + "description": "The node last update time (UTC).", + "type": "string" + }, + "nodeHealthState": { + "description": "The node health state.", + "enum": [ + "Unknown", + "Up", + "Down", + "MaintenanceMode" + ], + "type": "string", + "x-ms-enum": { + "name": "NodeHealthState" + } + }, + "virtualMachines": { + "description": "The virtual machines on the node.", + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineView" + } + } + } + }, + "VirtualMachineView": { + "description": "Properties for a virtual machine", + "type": "object", + "properties": { + "vmName": { + "description": "The name of the virtual machine.", + "type": "string" + }, + "vmId": { + "description": "The identifier of the virtual machine.", + "type": "string" + }, + "subscriptionId": { + "description": "The identifier of the subscription.", + "type": "string" + }, + "resourceGroupName": { + "description": "The resource group name.", + "type": "string" + }, + "vmSize": { + "description": "The virtual machine size.", + "type": "string" + }, + "vmScaleSetName": { + "description": "The virtual machine scale set name.", + "type": "string" + }, + "lastProvisioningErrorMessage": { + "description": "The virtual machine last provisioning error message.", + "type": "string" + }, + "timeOfLastConfigurationChange": { + "description": "The time of last configuration change (UTC).", + "type": "string" + }, + "powerState": { + "description": "The fabric VM power state.", + "enum": [ + "Unknown", + "Stopped", + "Running", + "Paused", + "SavedState", + "Stopping", + "Starting", + "Pausing", + "Resuming", + "Saving" + ], + "type": "string", + "x-ms-enum": { + "name": "VmPowerState" + } + } + } + } + }, + "parameters": { + "ScaleUnitParameter": { + "description": "Name of the scale unit.", + "name": "scaleUnitName", + "type": "string", + "required": true, + "in": "path", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-03-30/examples/ScaleUnits/Get.json b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-03-30/examples/ScaleUnits/Get.json new file mode 100644 index 000000000000..0e369316cb79 --- /dev/null +++ b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-03-30/examples/ScaleUnits/Get.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "location": "local", + "subscriptionId": "FAC2EE4D-C642-4411-A8BE-68379E72FC96", + "scaleUnitName": "s-cluster", + "api-version": "2021-03-30" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/FAC2EE4D-C642-4411-A8BE-68379E72FC96/providers/Microsoft.Compute.Admin/locations/local/computeScaleUnits/s-cluster", + "type": "Microsoft.Compute.Admin/locations/computeScaleUnits", + "location": "local", + "properties": { + "scaleUnitName": "s-cluster", + "lastUpdatedTime": "2021-03-30T12:34:00.00000Z", + "nodes": [ + { + "nodeName": "AzsNode1", + "lastUpdatedTime": "2021-03-30T12:34:00.00000Z", + "nodeHealthState": "Up", + "virtualMachines": [ + { + "vmName": "tenantVm1", + "vmId": "AE7920EF-2225-4D4B-965F-76D077278A92", + "subscriptionId": "CF82763A-3528-4776-9D4C-F0BF718900C7", + "resourceGroupName": "tenantRg1", + "vmSize": "Standard_A1", + "timeOfLastConfigurationChange": "2021-03-30T12:34:00.00000Z", + "powerState": "Running" + }, + { + "vmName": "tenantVmScaleSet_0", + "vmId": "6832C576-9F0B-438C-AC58-23BB540FD960", + "subscriptionId": "CF82763A-3528-4776-9D4C-F0BF718900C7", + "resourceGroupName": "tenantRg1", + "vmSize": "Standard_A1", + "vmScaleSetName": "tenantVmScaleSet", + "timeOfLastConfigurationChange": "2021-03-30T12:34:00.00000Z", + "powerState": "Running" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-04-01/DiskMigrationJobs.json b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-04-01/DiskMigrationJobs.json index ebf93493cbd8..fe2f8f6bd4bb 100644 --- a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-04-01/DiskMigrationJobs.json +++ b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-04-01/DiskMigrationJobs.json @@ -30,16 +30,16 @@ "description": "Returns a list of disk migration jobs.", "parameters": [ { - "$ref": "Disks.json#/parameters/SubscriptionIdParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "Disks.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { "$ref": "DiskMigrationJobs.json#/parameters/MigrationJobStatusParameter" }, { - "$ref": "Disks.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -75,16 +75,16 @@ "description": "Returns the requested disk migration job.", "parameters": [ { - "$ref": "Disks.json#/parameters/SubscriptionIdParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "Disks.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { "$ref": "DiskMigrationJobs.json#/parameters/MigrationIdParameter" }, { - "$ref": "Disks.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -115,10 +115,10 @@ "description": "Create a disk migration job.", "parameters": [ { - "$ref": "Disks.json#/parameters/SubscriptionIdParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "Disks.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { "$ref": "DiskMigrationJobs.json#/parameters/MigrationIdParameter" @@ -136,7 +136,7 @@ "$ref": "DiskMigrationJobs.json#/parameters/DiskListParameter" }, { - "$ref": "Disks.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -169,16 +169,16 @@ "description": "Cancel a disk migration job.", "parameters": [ { - "$ref": "Disks.json#/parameters/SubscriptionIdParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "Disks.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { "$ref": "DiskMigrationJobs.json#/parameters/MigrationIdParameter" }, { - "$ref": "Disks.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { diff --git a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-04-01/Disks.json b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-04-01/Disks.json index 575505b8c72d..aba9c372ab09 100644 --- a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-04-01/Disks.json +++ b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/stable/2021-04-01/Disks.json @@ -30,10 +30,10 @@ "description": "Returns a list of disks.", "parameters": [ { - "$ref": "Disks.json#/parameters/SubscriptionIdParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "Disks.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { "$ref": "Disks.json#/parameters/UserSubscriptionIdParameter" @@ -57,7 +57,7 @@ "$ref": "Disks.json#/parameters/DiskStartParameter" }, { - "$ref": "Disks.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -93,10 +93,10 @@ "description": "Returns the disk.", "parameters": [ { - "$ref": "Disks.json#/parameters/SubscriptionIdParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "Disks.json#/parameters/LocationParameter" + "$ref": "../../preview/2015-12-01-preview/Compute.json#/parameters/LocationParameter" }, { "$ref": "Disks.json#/parameters/DiskIdParameter" @@ -105,7 +105,7 @@ "$ref": "Disks.json#/parameters/DiskSizeDetailParameter" }, { - "$ref": "Disks.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -327,29 +327,6 @@ } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", - "required": true, - "type": "string" - }, - "LocationParameter": { - "description": "Location of the resource.", - "name": "location", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "Client API Version.", - "required": true, - "type": "string", - "default": "2021-04-01" - }, "UserSubscriptionIdParameter": { "description": "User Subscription Id which the resource belongs to.", "name": "userSubscriptionId", diff --git a/specification/azsadmin/resource-manager/compute/readme.azsautogen.md b/specification/azsadmin/resource-manager/compute/readme.azsautogen.md index e37ff2fce66c..3c4569631855 100644 --- a/specification/azsadmin/resource-manager/compute/readme.azsautogen.md +++ b/specification/azsadmin/resource-manager/compute/readme.azsautogen.md @@ -6,10 +6,10 @@ input-file: - Microsoft.Compute.Admin/preview/2015-12-01-preview/Compute.json - Microsoft.Compute.Admin/preview/2015-12-01-preview/PlatformImages.json - - Microsoft.Compute.Admin/preview/2018-02-09/Quotas.json - Microsoft.Compute.Admin/preview/2015-12-01-preview/VMExtensions.json - - Microsoft.Compute.Admin/preview/2018-07-30-preview/Disks.json - - Microsoft.Compute.Admin/preview/2018-07-30-preview/DiskMigrationJobs.json + - Microsoft.Compute.Admin/stable/2020-11-01/Features.json + - Microsoft.Compute.Admin/stable/2021-01-01/Quotas.json + - Microsoft.Compute.Admin/stable/2021-03-30/ScaleUnits.json - Microsoft.Compute.Admin/stable/2021-04-01/Disks.json - Microsoft.Compute.Admin/stable/2021-04-01/DiskMigrationJobs.json ``` diff --git a/specification/azsadmin/resource-manager/compute/readme.md b/specification/azsadmin/resource-manager/compute/readme.md index deeed7be84a1..94fc994fddf8 100644 --- a/specification/azsadmin/resource-manager/compute/readme.md +++ b/specification/azsadmin/resource-manager/compute/readme.md @@ -17,6 +17,7 @@ To see additional help and options, run: ## Configuration + ### Basic Information These are the global settings for the Compute API. @@ -25,21 +26,30 @@ title: ComputeAdminClient description: Compute Admin Client openapi-type: arm tag: package-2021-04-01 + +directive: + - where: + - $.definitions.ScaleUnit + suppress: + - NestedResourcesMustHaveListOperation + reason: + - CRP cannot support the list API for scale units due to the undesired load that would inflict on the system ``` -### Tag: package-2021-01-01 +### Tag: package-2021-04-01 These settings apply only when `--tag=package-2021-04-01` is specified on the command line. -``` yaml $(tag) == 'package-2021-01-01' +``` yaml $(tag) == 'package-2021-04-01' input-file: - - Microsoft.Compute.Admin/preview/2015-12-01-preview/Compute.json - - Microsoft.Compute.Admin/preview/2015-12-01-preview/PlatformImages.json - - Microsoft.Compute.Admin/preview/2015-12-01-preview/VMExtensions.json - - Microsoft.Compute.Admin/stable/2020-11-01/Features.json - - Microsoft.Compute.Admin/stable/2021-01-01/Quotas.json - - Microsoft.Compute.Admin/stable/2021-04-01/Disks.json - - Microsoft.Compute.Admin/stable/2021-04-01/DiskMigrationJobs.json + - Microsoft.Compute.Admin/preview/2015-12-01-preview/Compute.json + - Microsoft.Compute.Admin/preview/2015-12-01-preview/PlatformImages.json + - Microsoft.Compute.Admin/preview/2015-12-01-preview/VMExtensions.json + - Microsoft.Compute.Admin/stable/2020-11-01/Features.json + - Microsoft.Compute.Admin/stable/2021-01-01/Quotas.json + - Microsoft.Compute.Admin/stable/2021-03-30/ScaleUnits.json + - Microsoft.Compute.Admin/stable/2021-04-01/Disks.json + - Microsoft.Compute.Admin/stable/2021-04-01/DiskMigrationJobs.json ``` --- @@ -63,13 +73,14 @@ csharp: ``` yaml input-file: - - Microsoft.Compute.Admin/preview/2015-12-01-preview/Compute.json - - Microsoft.Compute.Admin/preview/2015-12-01-preview/PlatformImages.json - - Microsoft.Compute.Admin/preview/2015-12-01-preview/VMExtensions.json - - Microsoft.Compute.Admin/stable/2020-11-01/Features.json - - Microsoft.Compute.Admin/stable/2021-01-01/Quotas.json - - Microsoft.Compute.Admin/stable/2021-04-01/Disks.json - - Microsoft.Compute.Admin/stable/2021-04-01/DiskMigrationJobs.json + - Microsoft.Compute.Admin/preview/2015-12-01-preview/Compute.json + - Microsoft.Compute.Admin/preview/2015-12-01-preview/PlatformImages.json + - Microsoft.Compute.Admin/preview/2015-12-01-preview/VMExtensions.json + - Microsoft.Compute.Admin/stable/2020-11-01/Features.json + - Microsoft.Compute.Admin/stable/2021-01-01/Quotas.json + - Microsoft.Compute.Admin/stable/2021-03-30/ScaleUnits.json + - Microsoft.Compute.Admin/stable/2021-04-01/Disks.json + - Microsoft.Compute.Admin/stable/2021-04-01/DiskMigrationJobs.json ``` ## Multi-API/Profile support for AutoRest v3 generators @@ -84,15 +95,17 @@ require: $(this-folder)/../../../../profiles/readme.md # all the input files across all versions input-file: - - $(this-folder)/Microsoft.Compute.Admin/preview/2015-12-01-preview/Compute.json - - $(this-folder)/Microsoft.Compute.Admin/preview/2015-12-01-preview/PlatformImages.json - - $(this-folder)/Microsoft.Compute.Admin/preview/2018-02-09/Quotas.json - - $(this-folder)/Microsoft.Compute.Admin/preview/2015-12-01-preview/VMExtensions.json - - $(this-folder)/Microsoft.Compute.Admin/preview/2018-07-30-preview/Disks.json - - $(this-folder)/Microsoft.Compute.Admin/preview/2018-07-30-preview/DiskMigrationJobs.json - - $(this-folder)/Microsoft.Compute.Admin/stable/2021-04-01/Disks.json - - $(this-folder)/Microsoft.Compute.Admin/stable/2021-04-01/DiskMigrationJobs.json - + - $(this-folder)/Microsoft.Compute.Admin/preview/2015-12-01-preview/Compute.json + - $(this-folder)/Microsoft.Compute.Admin/preview/2015-12-01-preview/PlatformImages.json + - $(this-folder)/Microsoft.Compute.Admin/preview/2015-12-01-preview/VMExtensions.json + - $(this-folder)/Microsoft.Compute.Admin/preview/2018-02-09/Quotas.json + - $(this-folder)/Microsoft.Compute.Admin/preview/2018-07-30-preview/Disks.json + - $(this-folder)/Microsoft.Compute.Admin/preview/2018-07-30-preview/DiskMigrationJobs.json + - $(this-folder)/Microsoft.Compute.Admin/stable/2020-11-01/Features.json + - $(this-folder)/Microsoft.Compute.Admin/stable/2021-01-01/Quotas.json + - $(this-folder)/Microsoft.Compute.Admin/stable/2021-03-30/ScaleUnits.json + - $(this-folder)/Microsoft.Compute.Admin/stable/2021-04-01/Disks.json + - $(this-folder)/Microsoft.Compute.Admin/stable/2021-04-01/DiskMigrationJobs.json ``` If there are files that should not be in the `all-api-versions` set, diff --git a/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/capacity.json b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/capacity.json new file mode 100644 index 000000000000..febe3c2514e2 --- /dev/null +++ b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/capacity.json @@ -0,0 +1,180 @@ +{ + "swagger": "2.0", + "info": { + "version": "2019-11-01-preview", + "title": "ContainerRegistryManagementClient", + "description": "Admin Container Registry Management Client." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerRegistry.Admin/locations/{location}/capacities/{capacityName}": { + "get": { + "x-ms-examples": { + "Returns container registry capacity properties.": { + "$ref": "./examples/Configuration/GetCapacity.json" + } + }, + "tags": [ + "ContainerRegistryCapacity" + ], + "description": "Returns container registry capacity property.", + "operationId": "ContainerRegistryCapacity_Get", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/CapacityNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Container registry capacity property is being returned.", + "schema": { + "$ref": "#/definitions/ContainerRegistryCapacity" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerRegistry.Admin/locations/{location}/capacities": { + "get": { + "x-ms-examples": { + "Returns container registry capacity properties.": { + "$ref": "./examples/Configuration/ListCapacity.json" + } + }, + "tags": [ + "ContainerRegistryCapacities" + ], + "description": "Returns a list of container registry capacity properties.", + "operationId": "ContainerRegistryCapacity_List", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Container registry capacity properties are being returned.", + "schema": { + "$ref": "#/definitions/ContainerRegistryCapacityList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ContainerRegistryCapacity": { + "description": "Container registry capacity property.", + "type": "object", + "properties": { + "properties": { + "description": "Container registry capacity property.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ContainerRegistryCapacityProperty" + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ] + }, + "ContainerRegistryCapacityProperty": { + "description": "Container registry capacity property.", + "type": "object", + "properties": { + "maximumCapacityInGiB": { + "description": "Total storage capacity (GiB) which can used by the registry.", + "type": "integer", + "format": "int32" + }, + "allowPush": { + "description": "Flag denotes if pushes are blocked for all registries.", + "type": "boolean" + }, + "registriesConsumptionInGiB": { + "description": "Total storage capacity (GiB) consumed by the registry.", + "type": "number", + "format": "float" + } + } + }, + "ContainerRegistryCapacityList": { + "description": "List of capacity property.", + "type": "object", + "properties": { + "value": { + "description": "List of capacity property.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerRegistryCapacity" + } + } + } + } + }, + "parameters": { + "CapacityNameParameter": { + "description": "The name of the capacity parameter.", + "name": "capacityName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/configuration.json b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/configuration.json new file mode 100644 index 000000000000..e652eb31a23d --- /dev/null +++ b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/configuration.json @@ -0,0 +1,264 @@ +{ + "swagger": "2.0", + "info": { + "version": "2019-11-01-preview", + "title": "ContainerRegistryManagementClient", + "description": "Admin Container Registry Management Client." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerRegistry.Admin/locations/{location}/configurations/{configurationName}": { + "put": { + "x-ms-examples": { + "Returns container registry overall configuration properties.": { + "$ref": "./examples/Configuration/PutConfiguration.json" + } + }, + "tags": [ + "ContainerRegistryConfiguration" + ], + "description": "Configure container registry overall configuration properties.", + "operationId": "ContainerRegistryConfiguration_Put", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Container registry overall configuration properties is being returned.", + "schema": { + "$ref": "#/definitions/ContainerRegistryConfiguration" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete an existing container registry quota.": { + "$ref": "./examples/Configuration/DeleteConfiguration.json" + } + }, + "tags": [ + "ContainerRegistryConfiguration" + ], + "description": "Delete an existing container registry configuration", + "operationId": "ContainerRegistryConfiguration_Delete", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The container registry configuration has been deleted." + }, + "204": { + "description": "NotFound -- The container registry configuration not found." + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "x-ms-examples": { + "Returns the specified configuration.": { + "$ref": "./examples/Configuration/GetConfiguration.json" + } + }, + "tags": [ + "ContainerRegistryConfiguration" + ], + "description": "Returns the specified configuration details.", + "operationId": "ContainerRegistryConfiguration_Get", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The configuration has been returned.", + "schema": { + "$ref": "#/definitions/ContainerRegistryConfiguration" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerRegistry.Admin/locations/{location}/configurations": { + "get": { + "x-ms-examples": { + "Returns a list of configuration at the given location.": { + "$ref": "./examples/Configuration/ListConfiguration.json" + } + }, + "tags": [ + "ContainerRegistryConfiguration" + ], + "description": "Returns a list of configuration at the given location.", + "operationId": "ContainerRegistryConfiguration_List", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of configuration has been returned.", + "schema": { + "$ref": "#/definitions/ContainerRegistryConfigurationList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ContainerRegistryConfiguration": { + "description": "Container registry configuration property.", + "type": "object", + "properties": { + "properties": { + "description": "Container registry configuration property.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ContainerRegistryConfigurationProperty" + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ] + }, + "ContainerRegistryConfigurationProperty": { + "description": "Container registry configuration property.", + "type": "object", + "properties": { + "maximumCapacityInGiB": { + "description": "Total storage capacity (GiB) which can used by the registry.", + "type": "integer", + "format": "int32" + } + } + }, + "ContainerRegistryConfigurationList": { + "description": "List of configuration.", + "type": "object", + "properties": { + "value": { + "description": "List of configuration.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerRegistryConfiguration" + } + } + } + } + }, + "parameters": { + "ConfigurationNameParameter": { + "description": "The name of the configuration.", + "name": "configurationName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ConfigurationParameter": { + "description": "The properties of configuration being created or updated.", + "name": "configurationObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ContainerRegistryConfiguration" + }, + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Configuration/DeleteConfiguration.json b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Configuration/DeleteConfiguration.json new file mode 100644 index 000000000000..4546df16a13a --- /dev/null +++ b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Configuration/DeleteConfiguration.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "location": "local", + "configurationName": "Default", + "api-version": "2019-11-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Configuration/GetCapacity.json b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Configuration/GetCapacity.json new file mode 100644 index 000000000000..ab8e07e38fcb --- /dev/null +++ b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Configuration/GetCapacity.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2019-11-01-preview", + "location": "local", + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "capacityName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/providers/Microsoft.ContainerRegistry.Admin/locations/local/capacities/Default", + "name": "local/Default", + "type": "Microsoft.ContainerRegistry.Admin/locations/capacities", + "properties": { + "maximumCapacityInGiB": 100, + "registriesConsumptionInGiB": 50.12, + "allowPush": true + } + } + } + } +} diff --git a/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Configuration/GetConfiguration.json b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Configuration/GetConfiguration.json new file mode 100644 index 000000000000..4c4d4f60bc54 --- /dev/null +++ b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Configuration/GetConfiguration.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2019-11-01-preview", + "location": "local", + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "configurationName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/providers/Microsoft.ContainerRegistry.Admin/locations/local/configurations/Default", + "name": "local/Default", + "type": "Microsoft.ContainerRegistry.Admin/locations/configurations", + "properties": { + "maximumCapacityInGiB": 100 + } + } + } + } +} diff --git a/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Configuration/ListCapacity.json b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Configuration/ListCapacity.json new file mode 100644 index 000000000000..a9002248457d --- /dev/null +++ b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Configuration/ListCapacity.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "location": "local", + "api-version": "2019-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/providers/Microsoft.ContainerRegistry.Admin/locations/local/capacities/Default", + "name": "local/Default", + "type": "Microsoft.ContainerRegistry.Admin/locations/capacities", + "properties": { + "maximumCapacityInGiB": 100, + "registriesConsumptionInGiB": 50.12, + "allowPush": true + } + } + ] + } + } + } +} diff --git a/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Configuration/ListConfiguration.json b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Configuration/ListConfiguration.json new file mode 100644 index 000000000000..b39b129eac7d --- /dev/null +++ b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Configuration/ListConfiguration.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "location": "local", + "api-version": "2019-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/providers/Microsoft.ContainerRegistry.Admin/locations/local/configurations/Default", + "name": "local/Default", + "type": "Microsoft.ContainerRegistry.Admin/locations/configurations", + "properties": { + "maximumCapacityInGiB": 100 + } + } + ] + } + } + } +} diff --git a/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Configuration/PutConfiguration.json b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Configuration/PutConfiguration.json new file mode 100644 index 000000000000..4edd55e0794b --- /dev/null +++ b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Configuration/PutConfiguration.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2019-11-01-preview", + "location": "local", + "configurationName": "Default", + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "configurationObject": { + "properties": { + "maximumCapacityInGiB": 10 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/providers/Microsoft.ContainerRegistry.Admin/locations/local/configurations/Default", + "name": "local/Default", + "type": "Microsoft.ContainerRegistry.Admin/locations/configurations", + "properties": { + "maximumCapacityInGiB": 10 + } + } + } + } +} diff --git a/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Operations/List.json b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Operations/List.json new file mode 100644 index 000000000000..aca2b8331077 --- /dev/null +++ b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Operations/List.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "api-version": "2019-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ContainerRegistry.Admin/locations/quotas/read", + "display": { + "provider": "Microsoft.ContainerRegistry.Admin", + "resource": "Quotas", + "operation": "List/Get Registry Quota(s)", + "description": "Gets a list of all Registry quota resources in the specified location." + } + }, + { + "name": "Microsoft.ContainerRegistry.Admin/locations/quotas/write", + "display": { + "provider": "Microsoft.ContainerRegistry.Admin", + "resource": "Quotas", + "operation": "Create/Update Registry Quota", + "description": "Creates a Registry quota resource or modifies the quota values in the specified location." + } + }, + { + "name": "Microsoft.ContainerRegistry.Admin/locations/quotas/delete", + "display": { + "provider": "Microsoft.ContainerRegistry.Admin", + "resource": "Quotas", + "operation": "Delete Registry Quota", + "description": "Deletes the given Registry quota resource from the specified location." + } + }, + { + "name": "Microsoft.ContainerRegistry.Admin/operations/read", + "display": { + "provider": "Microsoft.ContainerRegistry.Admin", + "resource": "Operations", + "operation": "List Available Operations", + "description": "Lists operations available on registry resource provider" + } + }, + { + "name": "Microsoft.ContainerRegistry.Admin/locations/capacity/read", + "display": { + "provider": "Microsoft.ContainerRegistry.Admin", + "resource": "Registry Capacity Action", + "operation": "Get Registry Capacity Setting", + "description": "Returns registry capacity property." + } + }, + { + "name": "Microsoft.ContainerRegistry.Admin/locations/configuration/read", + "display": { + "provider": "Microsoft.ContainerRegistry.Admin", + "resource": "Registry configuration", + "operation": "Get Registry stamp configuration action", + "description": "Returns properties for registry stamp configuration." + } + }, + { + "name": "Microsoft.ContainerRegistry.Admin/locations/configuration/write", + "display": { + "provider": "Microsoft.ContainerRegistry.Admin", + "resource": "Registry configuration", + "operation": "Update registry stamp configuration action", + "description": "Update registry stamp configuration." + } + }, + { + "name": "Microsoft.ContainerRegistry.Admin/locations/registries/read", + "display": { + "provider": "Microsoft.ContainerRegistry.Admin", + "resource": "Registries", + "operation": "List Registries", + "description": "Returns properties for the registries." + } + }, + { + "name": "Microsoft.ContainerRegistry.Admin/startSetup/action", + "display": { + "provider": "Microsoft.ContainerRegistry.Setup", + "resource": "Start setup", + "operation": "Start container registry certificate upload and service deployment", + "description": "Update registry stamp configuration." + } + }, + { + "name": "Microsoft.ContainerRegistry.Admin/setupStatus/read", + "display": { + "provider": "Microsoft.ContainerRegistry.Setup", + "resource": "Setup status", + "operation": "Get status of container registry certificate upload and service deployment", + "description": "Get status of container registry certificate upload and service deployment." + } + } + ] + } + } + } +} diff --git a/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Quotas/CreateOrUpdate.json b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Quotas/CreateOrUpdate.json new file mode 100644 index 000000000000..2937812393aa --- /dev/null +++ b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Quotas/CreateOrUpdate.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "location": "local", + "quotaName": "TestCreateQuota", + "api-version": "2019-11-01-preview", + "quotaObject": { + "properties": { + "numberOfRegistries": 10, + "capacityPerRegistryInGiB": 50 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/providers/Microsoft.ContainerRegistry.Admin/locations/local/quotas/TestCreateQuota", + "name": "local/TestCreateQuota", + "type": "Microsoft.ContainerRegistry.Admin/locations/quotas", + "properties": { + "numberOfRegistries": 10, + "capacityPerRegistryInGiB": 50 + } + } + } + } +} diff --git a/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Quotas/Delete.json b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Quotas/Delete.json new file mode 100644 index 000000000000..ee8823b69a78 --- /dev/null +++ b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Quotas/Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "location": "local", + "quotaName": "TestCreateQuota", + "api-version": "2019-11-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Quotas/Get.json b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Quotas/Get.json new file mode 100644 index 000000000000..d0dd163b576a --- /dev/null +++ b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Quotas/Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "location": "local", + "quotaName": "TestCreateQuota", + "api-version": "2019-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/providers/Microsoft.ContainerRegistry.Admin/locations/local/quotas/TestCreateQuota", + "name": "local/TestCreateQuota", + "type": "Microsoft.ContainerRegistry.Admin/locations/quotas", + "properties": { + "numberOfRegistries": 10, + "capacityPerRegistryInGiB": 50 + } + } + } + } +} diff --git a/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Quotas/List.json b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Quotas/List.json new file mode 100644 index 000000000000..695010a07054 --- /dev/null +++ b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Quotas/List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "location": "local", + "api-version": "2019-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/providers/Microsoft.ContainerRegistry.Admin/locations/local/quotas/TestCreateQuota", + "name": "local/TestCreateQuota", + "type": "Microsoft.ContainerRegistry.Admin/locations/quotas", + "properties": { + "numberOfRegistries": 10, + "capacityPerRegistryInGiB": 50 + } + } + ] + } + } + } +} diff --git a/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Setup/Get.json b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Setup/Get.json new file mode 100644 index 000000000000..2a02836a8746 --- /dev/null +++ b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Setup/Get.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "api-version": "2019-11-01-preview", + "location": "local" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/providers/Microsoft.ContainerRegistry.Setup/locations/local/setup", + "name": "value", + "type": "Microsoft.ContainerRegistry.Setup/locations/global/setup", + "properties": { + "status": "SetupCompleted" + } + } + } + } +} diff --git a/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Setup/Start.json b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Setup/Start.json new file mode 100644 index 000000000000..b5cf9ed01d3a --- /dev/null +++ b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/Setup/Start.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2019-11-01-preview", + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "location": "local", + "configurationName": "Default", + "startSetupRequest": { + "password": "password", + "sslCertBase64": "sslCertBase64" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/providers/Microsoft.ContainerRegistry.Setup/locations/global/setup", + "name": "value", + "type": "Microsoft.ContainerRegistry.Setup/locations/global/setup", + "properties": { + "statusUri": "https://adminmanagement.redmond.ext-v.masd.stbtest.microsoft.com/subscriptions/731e84f5-d31e-4c6a-aa1d-546d6bfb2789/providers/Microsoft.ContainerRegistry.Setup/locations/local/setup?api-version=2019-11-01-preview" + } + } + } + } +} diff --git a/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/registries/List.json b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/registries/List.json new file mode 100644 index 000000000000..8ec1fcb9c198 --- /dev/null +++ b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/examples/registries/List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "location": "local", + "api-version": "2019-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/providers/Microsoft.ContainerRegistry.Admin/locations/local/registries/testregistry", + "name": "local/testregistry", + "type": "Microsoft.ContainerRegistry.Admin/locations/registries", + "properties": { + "registryId": "/subscriptions/9a20956c-05fe-4c72-aa29-b2a1e5b802a7/resourceGroups/localResource/providers/Microsoft.ContainerRegistry/registries/testregistry", + "name": "testregistry", + "location": "local", + "creationDate": "2021-04-09T17:02:09.9839001Z", + "subscriptionId": "9a20956c-05fe-4c72-aa29-b2a1e5b802a7", + "resourceGroup": "localResource", + "registrySizeInBytes": 0 + } + } + ] + } + } + } +} diff --git a/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/operations.json b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/operations.json new file mode 100644 index 000000000000..ab1608cc86c7 --- /dev/null +++ b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/operations.json @@ -0,0 +1,132 @@ +{ + "swagger": "2.0", + "info": { + "version": "2019-11-01-preview", + "title": "ContainerRegistryManagementClient", + "description": "Admin Container Registry Management Client." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.ContainerRegistry.Admin/operations": { + "get": { + "x-ms-examples": { + "Get the list of support rest operations.": { + "$ref": "./examples/Operations/List.json" + } + }, + "description": "Get the list of supported admin container registry rest operations.", + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of operations has been returned.", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "Operation": { + "description": "Describes the supported REST operation.", + "type": "object", + "properties": { + "name": { + "description": "The name of the operation being performed on this particular object. It should match the action name that appears in RBAC / the event service.", + "type": "string", + "readOnly": true + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "display": { + "description": "Contains the localized display information for this particular operation / action.", + "$ref": "#/definitions/Display", + "readOnly": true + } + } + }, + "Display": { + "description": "Contains the localized display information for this particular operation / action.", + "type": "object", + "properties": { + "provider": { + "description": "The localized friendly form of the resource provider name – it is expected to also include the publisher/company responsible. It should use Title Casing and begin with \"Microsoft\" for 1st party services. e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute.\"", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "The localized friendly form of the resource type related to this action/operation – it should match the public documentation for the resource provider.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "The localized friendly name for the operation, as it should be shown to the user.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The localized friendly description for the operation, as it should be shown to the user. It should be thorough, yet concise – it will be used in tool tips and detailed views.", + "type": "string", + "readOnly": true + } + } + }, + "OperationList": { + "description": "Pageable list of supported operations.", + "type": "object", + "properties": { + "value": { + "description": "List of operations", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/quotas.json b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/quotas.json new file mode 100644 index 000000000000..e517e6930272 --- /dev/null +++ b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/quotas.json @@ -0,0 +1,271 @@ +{ + "swagger": "2.0", + "info": { + "version": "2019-11-01-preview", + "title": "ContainerRegistryManagementClient", + "description": "Admin Container Registry Management Client." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerRegistry.Admin/locations/{location}/quotas/{quotaName}": { + "put": { + "x-ms-examples": { + "Create or update an existing container registry quota.": { + "$ref": "./examples/Quotas/CreateOrUpdate.json" + } + }, + "tags": [ + "ContainerRegistryQuotas" + ], + "description": "Create or update an existing container registry quota.", + "operationId": "Quota_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/QuotaNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ContainerRegistryQuotaParameters" + } + ], + "responses": { + "200": { + "description": "OK -- The container registry quota has been created or updated.", + "schema": { + "$ref": "#/definitions/ContainerRegistryQuota" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete an existing container registry quota.": { + "$ref": "./examples/Quotas/Delete.json" + } + }, + "tags": [ + "ContainerRegistryQuotas" + ], + "description": "Delete an existing container registry quota", + "operationId": "Quotas_Delete", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/QuotaNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The container registry quota has been deleted." + }, + "204": { + "description": "NotFound -- The container registry quota not found." + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "x-ms-examples": { + "Returns the specified container registry quota.": { + "$ref": "./examples/Quotas/Get.json" + } + }, + "tags": [ + "ContainerRegistryQuotas" + ], + "description": "Returns the specified container registry quota.", + "operationId": "Quotas_Get", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/QuotaNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The container registry quota has been returned.", + "schema": { + "$ref": "#/definitions/ContainerRegistryQuota" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerRegistry.Admin/locations/{location}/quotas": { + "get": { + "x-ms-examples": { + "Returns a list of container registry quotas at the given location.": { + "$ref": "./examples/Quotas/List.json" + } + }, + "tags": [ + "ContainerRegistryQuotas" + ], + "description": "Returns a list of container registry quotas at the given location.", + "operationId": "Quotas_List", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of container registry quotas has been returned.", + "schema": { + "$ref": "#/definitions/ContainerRegistryQuotaList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ContainerRegistryQuota": { + "description": "Container registry quota.", + "type": "object", + "properties": { + "properties": { + "description": "Container registry quota properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ContainerRegistryQuotaProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ] + }, + "ContainerRegistryQuotaProperties": { + "description": "Container registry quota properties.", + "type": "object", + "properties": { + "numberOfRegistries": { + "description": "Total number of container registry accounts.", + "type": "integer", + "format": "int32", + "default": 20 + }, + "capacityPerRegistryInGiB": { + "description": "Storage capacity (GiB) of each registry.", + "type": "integer", + "format": "int32", + "default": 100 + } + } + }, + "ContainerRegistryQuotaList": { + "description": "List of container registry quotas.", + "type": "object", + "properties": { + "value": { + "description": "List of container registry quotas.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerRegistryQuota" + } + } + } + } + }, + "parameters": { + "QuotaNameParameter": { + "description": "The name of the container registry quota.", + "name": "quotaName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ContainerRegistryQuotaParameters": { + "description": "The properties of quota being created or updated.", + "name": "quotaObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ContainerRegistryQuota" + }, + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/registries.json b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/registries.json new file mode 100644 index 000000000000..6699e2df73ef --- /dev/null +++ b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/registries.json @@ -0,0 +1,156 @@ +{ + "swagger": "2.0", + "info": { + "version": "2019-11-01-preview", + "title": "ContainerRegistryManagementClient", + "description": "Admin Container Registry Management Client." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerRegistry.Admin/locations/{location}/registries": { + "get": { + "x-ms-examples": { + "Returns a list of container registries at the given location.": { + "$ref": "./examples/registries/List.json" + } + }, + "tags": [ + "ContainerRegistries" + ], + "description": "Returns a list of container registries present in all tenant location.", + "operationId": "ContainerRegistryRegistries_List", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of container registries has been returned.", + "schema": { + "$ref": "#/definitions/ContainerRegistriesList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ContainerRegistry": { + "description": "Container registry properties.", + "type": "object", + "properties": { + "properties": { + "description": "Container registry properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ContainerRegistryProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ] + }, + "ContainerRegistryProperties": { + "description": "Container registry properties.", + "type": "object", + "properties": { + "registryId": { + "description": "Container registry id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Container registry name.", + "type": "string", + "readOnly": true + }, + "location": { + "description": "Container registry location.", + "type": "string", + "readOnly": true + }, + "subscriptionId": { + "description": "SubscriptionId where container registry is present.", + "type": "string", + "readOnly": true + }, + "resourceGroup": { + "description": "ResourceGroup where container registry is present.", + "type": "string", + "readOnly": true + }, + "creationDate": { + "format": "date-time", + "description": "The time at which the registry created.", + "type": "string" + }, + "registrySizeInBytes": { + "description": "Total storage capacity (GiB) used by the registry.", + "type": "integer", + "format": "int64" + } + } + }, + "ContainerRegistriesList": { + "description": "List of container registries.", + "type": "object", + "properties": { + "nextLink": { + "description": "URI to the next page.", + "type": "string" + }, + "value": { + "description": "List of container registries.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerRegistry" + } + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/setup.json b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/setup.json new file mode 100644 index 000000000000..d93cafeb7155 --- /dev/null +++ b/specification/azsadmin/resource-manager/containerregistry/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/setup.json @@ -0,0 +1,215 @@ +{ + "swagger": "2.0", + "info": { + "version": "2019-11-01-preview", + "title": "ContainerRegistryManagementClient", + "description": "Admin Container Registry Management Client." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerRegistry.Setup/locations/{location}/setup": { + "post": { + "x-ms-examples": { + "Invokes container registry certificate uploading and ACR service deployment.": { + "$ref": "./examples/Setup/Start.json" + } + }, + "tags": [ + "ContainerRegistrySetupStart" + ], + "description": "Invokes container registry certificate uploading and service deployment.", + "operationId": "ContainerRegistry_StartSetup", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/StartSetupParameter" + } + ], + "responses": { + "201": { + "description": "Created -- Container registry certificate was uploaded successfully and deployment started.", + "schema": { + "$ref": "#/definitions/ContainerRegistrySetup" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "x-ms-examples": { + "Returns the status of the container registry setup.": { + "$ref": "./examples/Setup/Get.json" + } + }, + "tags": [ + "ContainerRegistrySetupStatus" + ], + "description": "Returns the status of the container registry setup.", + "operationId": "ContainerRegistry_GetSetupStatus", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The status of the container registry setup has been returned.", + "schema": { + "$ref": "#/definitions/SetupResult" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ContainerRegistrySetupProperty": { + "description": "Container registry setup properties.", + "type": "object", + "properties": { + "password": { + "description": "Ssl certificate password.", + "type": "string", + "format": "password" + }, + "sslCertBase64": { + "description": "Ssl certificate in base64 format.", + "type": "string", + "format": "byte" + } + } + }, + "ContainerRegistrySetup": { + "description": "Container registry start setup return.", + "type": "object", + "properties": { + "properties": { + "description": "Container registry start setup return properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SetupProperty" + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ] + }, + "SetupProperty": { + "description": "Container registry start setup return property.", + "type": "object", + "properties": { + "statusUri": { + "description": "The uri to poll status of the container registry setup.", + "type": "string" + } + } + }, + "SetupResult": { + "description": "Container registry setup result.", + "type": "object", + "properties": { + "properties": { + "description": "Container registry setup result properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SetupResultProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ] + }, + "SetupResultProperties": { + "description": "Container registry setup result properties.", + "type": "object", + "properties": { + "status": { + "description": "The status of the container registry setup.", + "$ref": "#/definitions/SetupStatus", + "readOnly": true + } + } + }, + "SetupStatus": { + "description": "The status of the container registry setup.", + "type": "string", + "enum": [ + "ReadyToSetup", + "Running", + "Failed", + "Cancelled", + "Completed" + ], + "x-ms-enum": { + "name": "SetupStatus", + "modelAsString": true + } + } + }, + "parameters": { + "StartSetupParameter": { + "name": "startSetupRequest", + "in": "body", + "description": "The object containing information for the configuration request.", + "required": true, + "schema": { + "$ref": "#/definitions/ContainerRegistrySetupProperty" + }, + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/containerregistry/readme.azsautogen.md b/specification/azsadmin/resource-manager/containerregistry/readme.azsautogen.md new file mode 100644 index 000000000000..a97a374fe88f --- /dev/null +++ b/specification/azsadmin/resource-manager/containerregistry/readme.azsautogen.md @@ -0,0 +1,56 @@ +# ContainerRegistry Admin + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for ContainerRegistry Admin. + +--- +## Getting Started +To build the SDK for ContainerRegistry Admin, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + +### Basic Information +These are the global settings for the ContainerRegistry API. + +``` yaml +title: ContainerRegistryAdminClient +description: ContainerRegistry Admin Client +openapi-type: arm +tag: package-2019-11-01 +``` + +``` yaml +input-file: + - $(this-folder)/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/capacity.json + - $(this-folder)/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/configuration.json + - $(this-folder)/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/operations.json + - $(this-folder)/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/quotas.json + - $(this-folder)/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/registries.json + - $(this-folder)/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/setup.json +``` + +--- +# Code Generation + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.AzureStack.Management.ContainerRegistry.Admin + payload-flattening-threshold: 1 + output-folder: $(csharp-sdks-folder)/Generated + clear-output-folder: true +``` diff --git a/specification/azsadmin/resource-manager/containerregistry/readme.md b/specification/azsadmin/resource-manager/containerregistry/readme.md new file mode 100644 index 000000000000..8b50a3246886 --- /dev/null +++ b/specification/azsadmin/resource-manager/containerregistry/readme.md @@ -0,0 +1,89 @@ +# ContainerRegistry Admin + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for ContainerRegistry Admin. + +--- +## Getting Started +To build the SDK for ContainerRegistry Admin, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + +### Basic Information +These are the global settings for the ContainerRegistry API. + +``` yaml +title: ContainerRegistryAdminClient +description: ContainerRegistry Admin Client +openapi-type: arm +tag: package-2019-11-01 +``` + +### Tag: package-2019-11-01 + +These settings apply only when `--tag=package-2019-11-01` is specified on the command line. + +``` yaml $(tag) == 'package-2019-11-01-preview' +input-file: + - "Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/capacity.json" + - "Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/configuration.json" + - "Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/operations.json" + - "Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/quotas.json" + - "Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/registries.json" + - "Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/setup.json" +``` + +--- +# Code Generation + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.AzureStack.Management.ContainerRegistry.Admin + payload-flattening-threshold: 1 + output-folder: $(csharp-sdks-folder)/Generated + clear-output-folder: true +``` + +## Multi-API/Profile support for AutoRest v3 generators + +AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. + +This block is updated by an automatic script. Edits may be lost! + +``` yaml $(tag) == 'all-api-versions' /* autogenerated */ +# include the azure profile definitions from the standard location +require: $(this-folder)/../../../../profiles/readme.md + +# all the input files across all versions +input-file: + - $(this-folder)/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/capacity.json + - $(this-folder)/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/configuration.json + - $(this-folder)/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/operations.json + - $(this-folder)/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/quotas.json + - $(this-folder)/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/registries.json + - $(this-folder)/Microsoft.ContainerRegistry.Admin/preview/2019-11-01-preview/setup.json +``` + +If there are files that should not be in the `all-api-versions` set, +uncomment the `exclude-file` section below and add the file paths. + +``` yaml $(tag) == 'all-api-versions' +#exclude-file: +# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json +``` + diff --git a/specification/azure-kusto/resource-manager/readme.md b/specification/azure-kusto/resource-manager/readme.md index 3df94ea80244..c7b5b9f16c66 100644 --- a/specification/azure-kusto/resource-manager/readme.md +++ b/specification/azure-kusto/resource-manager/readme.md @@ -187,7 +187,6 @@ This is not used by Autorest itself. swagger-to-sdk: - repo: azure-powershell - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-js - repo: azure-sdk-for-go @@ -214,6 +213,10 @@ csharp: See configuration in [readme.java.md](./readme.java.md) +## Python + +See configuration in [readme.python.md](./readme.python.md) + ## Suppression diff --git a/specification/azure-kusto/resource-manager/readme.python.md b/specification/azure-kusto/resource-manager/readme.python.md index c3949f58096c..3ca07178e0ff 100644 --- a/specification/azure-kusto/resource-manager/readme.python.md +++ b/specification/azure-kusto/resource-manager/readme.python.md @@ -4,36 +4,15 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.kusto - package-name: azure-mgmt-kusto - package-version: 0.1.0 - clear-output-folder: true -``` ``` yaml $(python) && $(track2) python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.kusto package-name: azure-mgmt-kusto -package-version: 0.1.0 +package-version: 1.0.0b1 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/kusto/azure-mgmt-kusto/azure/mgmt/kusto -``` -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/kusto/azure-mgmt-kusto -``` ``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/kusto/azure-mgmt-kusto/azure/mgmt/kusto diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/azurearcdata.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/azurearcdata.json new file mode 100644 index 000000000000..3980d7531adc --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/azurearcdata.json @@ -0,0 +1,2223 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.AzureArcData/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available Azure Data Services on Azure Arc API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved operations.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Lists all of the available Azure Data Services on Azure Arc API operations.": { + "$ref": "./examples/ListOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/sqlManagedInstances": { + "get": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_List", + "summary": "List sqlManagedInstance resources in the subscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlManagedInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 404 ResourceNotFound - The requested resource was not found.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Instance in a subscription.": { + "$ref": "./examples/ListSubscriptionSqlManagedInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlManagedInstances": { + "get": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_ListByResourceGroup", + "description": "Gets all sqlManagedInstances in a resource group.", + "summary": "List sqlManagedInstance resources in the resource group", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlManagedInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Instance in a resource group.": { + "$ref": "./examples/ListByResourceGroupSqlManagedInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlManagedInstances/{sqlManagedInstanceName}": { + "get": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_Get", + "description": "Retrieves a SQL Managed Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlManagedInstanceName", + "description": "Name of SQL Managed Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlManagedInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a SQL Instance tags.": { + "$ref": "./examples/GetSqlManagedInstance.json" + } + } + }, + "put": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_Create", + "description": "Creates or replaces a SQL Managed Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlManagedInstanceName", + "description": "The name of SQL Managed Instances", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "sqlManagedInstance", + "in": "body", + "description": "The SQL Managed Instance to be created or updated.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlManagedInstance" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlManagedInstance" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SqlManagedInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a SQL Managed Instance": { + "$ref": "./examples/CreateOrUpdateSqlManagedInstance.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_Delete", + "description": "Deletes a SQL Managed Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlManagedInstanceName", + "description": "The name of Sql Managed Instances", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the SQL Managed Instance." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified SQL Managed Instance does not exist." + } + }, + "x-ms-examples": { + "Delete a SQL Instance.": { + "$ref": "./examples/DeleteSqlManagedInstance.json" + } + } + }, + "patch": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_Update", + "description": "Updates a SQL Managed Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlManagedInstanceName", + "description": "Name of sqlManagedInstance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "parameters", + "in": "body", + "description": "The SQL Managed Instance.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlManagedInstanceUpdate" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlManagedInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a sql Instance tags.": { + "$ref": "./examples/UpdateSqlManagedInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/sqlServerInstances": { + "get": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_List", + "summary": "List sqlServerInstance resources in the subscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 404 ResourceNotFound - The requested resource was not found.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Server Instance in a subscription.": { + "$ref": "./examples/ListSubscriptionSqlServerInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances": { + "get": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_ListByResourceGroup", + "description": "Gets all sqlServerInstances in a resource group.", + "summary": "List sqlServerInstance resources in the resource group", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Server Instance in a resource group.": { + "$ref": "./examples/ListByResourceGroupSqlServerInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}": { + "get": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_Get", + "description": "Retrieves a SQL Server Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlServerInstanceName", + "description": "Name of SQL Server Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a SQL Server Instance tags.": { + "$ref": "./examples/GetSqlServerInstance.json" + } + } + }, + "put": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_Create", + "description": "Creates or replaces a SQL Server Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlServerInstanceName", + "description": "The name of SQL Server Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "sqlServerInstance", + "in": "body", + "description": "The SQL Server Instance to be created or updated.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlServerInstance" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerInstance" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SqlServerInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a SQL Server Instance tags.": { + "$ref": "./examples/CreateOrUpdateSqlServerInstance.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_Delete", + "description": "Deletes a SQL Server Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlServerInstanceName", + "description": "The name of SQL Server Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the SQL Server Instance." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified SQL Server Instance does not exist." + } + }, + "x-ms-examples": { + "Delete a SQL Server Instance.": { + "$ref": "./examples/DeleteSqlServerInstance.json" + } + } + }, + "patch": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_Update", + "description": "Updates a SQL Server Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlServerInstanceName", + "description": "Name of sqlServerInstance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "parameters", + "in": "body", + "description": "The SQL Server Instance.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlServerInstanceUpdate" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a SQL Server Instance tags.": { + "$ref": "./examples/UpdateSqlServerInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/postgresInstances": { + "get": { + "tags": [ + "PostgresInstances" + ], + "operationId": "PostgresInstances_List", + "summary": "List postgres Instance resources in the subscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PostgresInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all Postgres Instance in a subscription.": { + "$ref": "./examples/ListSubscriptionPostgresInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/postgresInstances": { + "get": { + "tags": [ + "PostgresInstances" + ], + "operationId": "PostgresInstances_ListByResourceGroup", + "description": "Get a postgres Instances list by Resource group name.", + "summary": "List postgres Instance resources in the resource group", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PostgresInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all postgres Instances in a resource group.": { + "$ref": "./examples/ListByResourceGroupPostgresInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/postgresInstances/{postgresInstanceName}": { + "get": { + "tags": [ + "PostgresInstances" + ], + "operationId": "PostgresInstances_Get", + "description": "Retrieves a postgres Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "postgresInstanceName", + "description": "Name of Postgres Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PostgresInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets a postgres Instances.": { + "$ref": "./examples/GetPostgresInstance.json" + } + } + }, + "put": { + "tags": [ + "PostgresInstances" + ], + "operationId": "PostgresInstances_Create", + "description": "Creates or replaces a postgres Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "postgresInstanceName", + "description": "Name of PostgresInstance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "name": "resource", + "description": "The postgres instance", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/PostgresInstance" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PostgresInstance" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/PostgresInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a Postgres Instance.": { + "$ref": "./examples/CreateOrUpdatePostgresInstance.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "PostgresInstances" + ], + "operationId": "PostgresInstances_Delete", + "description": "Deletes a postgres Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "postgresInstanceName", + "description": "Name of Postgres Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the Postgres Instance." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified Postgres Instance does not exist." + } + }, + "x-ms-examples": { + "Deletes a PostgresInstances.": { + "$ref": "./examples/DeletePostgresInstance.json" + } + } + }, + "patch": { + "tags": [ + "PostgresInstances" + ], + "operationId": "PostgresInstances_Update", + "description": "Updates a postgres Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "postgresInstanceName", + "description": "Name of Postgres Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "parameters", + "in": "body", + "description": "The Postgres Instance.", + "required": true, + "schema": { + "$ref": "#/definitions/PostgresInstanceUpdate" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PostgresInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a postgres Instances tags.": { + "$ref": "./examples/UpdatePostgresInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/dataControllers": { + "get": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_ListInSubscription", + "summary": "List dataController resources in the subscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PageOfDataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all dataControllers in a subscription.": { + "$ref": "./examples/ListSubscriptionDataController.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/dataControllers": { + "get": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_ListInGroup", + "summary": "List dataController resources in the resource group", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PageOfDataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all dataControllers in a resource group.": { + "$ref": "./examples/ListByResourceGroupDataController.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/dataControllers/{dataControllerName}": { + "put": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_PutDataController", + "description": "Creates or replaces a dataController resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "dataControllerResource", + "description": "desc", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/DataControllerResource" + } + }, + { + "name": "dataControllerName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DataControllerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a Data Controller.": { + "$ref": "./examples/CreateOrUpdateDataController.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_DeleteDataController", + "description": "Deletes a dataController resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "dataControllerName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the DataController." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified DataController does not exist." + } + }, + "x-ms-examples": { + "Delete a dataController.": { + "$ref": "./examples/DeleteDataController.json" + } + } + }, + "get": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_GetDataController", + "description": "Retrieves a dataController resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "dataControllerName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a data controller.": { + "$ref": "./examples/GetDataController.json" + } + } + }, + "patch": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_PatchDataController", + "description": "Updates a dataController resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "dataControllerName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "name": "dataControllerResource", + "description": "The update data controller resource", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/DataControllerUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a dataController tags.": { + "$ref": "./examples/UpdateDataController.json" + } + } + } + } + }, + "definitions": { + "CommonSku": { + "description": "The resource model definition representing SKU for ARM resources", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU. It is typically a letter+number code" + }, + "dev": { + "type": "boolean", + "default": true, + "description": "Whether dev/test is enabled. When the dev field is set to true, the resource is used for dev/test purpose. " + }, + "size": { + "type": "string", + "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. " + }, + "family": { + "type": "string", + "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here." + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted." + } + }, + "required": [ + "name" + ] + }, + "SqlManagedInstanceSku": { + "description": "The resource model definition representing SKU for Azure Managed Instance - Azure Arc", + "type": "object", + "properties": { + "tier": { + "type": "string", + "enum": [ + "GeneralPurpose", + "BusinessCritical" + ], + "x-ms-enum": { + "name": "SqlManagedInstanceSkuTier", + "modelAsString": false + }, + "default": "GeneralPurpose", + "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier." + } + }, + "allOf": [ + { + "$ref": "#/definitions/CommonSku" + } + ] + }, + "PostgresInstanceSku": { + "description": "The resource model definition representing SKU for Azure Database for PostgresSQL - Azure Arc", + "type": "object", + "properties": { + "tier": { + "type": "string", + "enum": [ + "Hyperscale" + ], + "x-ms-enum": { + "name": "PostgresInstanceSkuTier", + "modelAsString": false + }, + "default": "Hyperscale", + "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier." + } + }, + "allOf": [ + { + "$ref": "#/definitions/CommonSku" + } + ] + }, + "Identity": { + "description": "Identity for the resource.", + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of resource identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID of resource." + }, + "type": { + "type": "string", + "description": "The identity type.", + "enum": [ + "SystemAssigned" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + } + } + }, + "Plan": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "A user defined name of the 3rd Party Artifact that is being procured." + }, + "publisher": { + "type": "string", + "description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic" + }, + "product": { + "type": "string", + "description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. " + }, + "promotionCode": { + "type": "string", + "description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact." + }, + "version": { + "type": "string", + "description": "The version of the desired product/artifact." + } + }, + "description": "Plan for the resource.", + "required": [ + "name", + "publisher", + "product" + ] + }, + "OperationListResult": { + "description": "Result of the request to list Azure Data Services on Azure Arc operations.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "Operation": { + "description": "Azure Data Services on Azure Arc operation definition.", + "type": "object", + "properties": { + "name": { + "description": "The name of the operation being performed on this particular object.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "The localized display information for this particular operation / action." + }, + "origin": { + "description": "The intended executor of the operation.", + "enum": [ + "user", + "system" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "OperationOrigin", + "modelAsString": true + } + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "properties": { + "description": "Additional descriptions for the operation.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "readOnly": true, + "x-ms-client-flatten": false + } + }, + "required": [ + "name", + "display", + "isDataAction" + ] + }, + "OperationDisplay": { + "description": "Display metadata associated with the operation.", + "type": "object", + "properties": { + "provider": { + "description": "The localized friendly form of the resource provider name.", + "type": "string" + }, + "resource": { + "description": "The localized friendly form of the resource type related to this action/operation.", + "type": "string" + }, + "operation": { + "description": "The localized friendly name for the operation.", + "type": "string" + }, + "description": { + "description": "The localized friendly description for the operation.", + "type": "string" + } + }, + "required": [ + "provider", + "resource", + "operation", + "description" + ] + }, + "Resource": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts." + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "type": "object", + "description": "The resource model definition for a ARM tracked top level resource", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "systemData": { + "$ref": "#/definitions/SystemData", + "readOnly": true + } + }, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ProxyResource": { + "type": "object", + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "PageOfDataControllerResource": { + "type": "object", + "properties": { + "value": { + "items": { + "$ref": "#/definitions/DataControllerResource" + }, + "type": "array" + }, + "nextLink": { + "type": "string", + "description": "Link to retrieve next page of results." + } + } + }, + "DataControllerResource": { + "description": "Data controller resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + }, + "properties": { + "$ref": "#/definitions/DataControllerProperties", + "description": "The data controller's properties", + "x-ms-client-flatten": false + } + }, + "required": [ + "properties" + ] + }, + "DataControllerUpdate": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "description": "Used for updating a data controller resource." + }, + "SystemData": { + "description": "Read only system data", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "An identifier for the identity that created the resource" + }, + "createdByType": { + "$ref": "#/definitions/IdentityType", + "description": "The type of identity that created the resource" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)" + }, + "lastModifiedBy": { + "type": "string", + "description": "An identifier for the identity that last modified the resource" + }, + "lastModifiedByType": { + "$ref": "#/definitions/IdentityType", + "description": "The type of identity that last modified the resource" + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)" + } + } + }, + "IdentityType": { + "description": "The type of identity that creates/modifies resources", + "type": "string", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": true + } + }, + "ResourceSku": { + "type": "object", + "properties": { + "capacity": { + "type": "integer", + "format": "int32" + }, + "family": { + "type": "string" + }, + "name": { + "type": "string" + }, + "size": { + "type": "string" + }, + "tier": { + "type": "string" + } + } + }, + "DataControllerProperties": { + "description": "The data controller properties.", + "type": "object", + "properties": { + "onPremiseProperty": { + "$ref": "#/definitions/OnPremiseProperty" + }, + "k8sRaw": { + "type": "object", + "description": "The raw kubernetes information" + }, + "uploadWatermark": { + "$ref": "#/definitions/UploadWatermark" + }, + "lastUploadedDate": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date from Kubernetes cluster. Defaults to current date time" + }, + "basicLoginInformation": { + "$ref": "#/definitions/BasicLoginInformation" + }, + "logAnalyticsWorkspaceConfig": { + "$ref": "#/definitions/LogAnalyticsWorkspaceConfig" + }, + "uploadServicePrincipal": { + "$ref": "#/definitions/UploadServicePrincipal" + }, + "provisioningState": { + "type": "string", + "readOnly": true + } + } + }, + "UploadWatermark": { + "description": "Properties on upload watermark. Mostly timestamp for each upload data type", + "type": "object", + "properties": { + "metrics": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date for metrics from kubernetes cluster. Defaults to current date time" + }, + "logs": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date for logs from kubernetes cluster. Defaults to current date time" + }, + "usages": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date for usages from kubernetes cluster. Defaults to current date time" + } + } + }, + "OnPremiseProperty": { + "description": "Properties from the Kubernetes data controller", + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "A globally unique ID identifying the associated Kubernetes cluster" + }, + "publicSigningKey": { + "type": "string", + "description": "Certificate that contains the Kubernetes cluster public key used to verify signing" + }, + "signingCertificateThumbprint": { + "type": "string", + "description": "Unique thumbprint returned to customer to verify the certificate being uploaded" + } + }, + "required": [ + "id", + "publicSigningKey" + ] + }, + "PostgresInstanceProperties": { + "description": "Postgres Instance properties.", + "type": "object", + "properties": { + "dataControllerId": { + "type": "string", + "description": "The data controller id" + }, + "admin": { + "type": "string", + "description": "The instance admin" + }, + "basicLoginInformation": { + "$ref": "#/definitions/BasicLoginInformation", + "description": "Username and password for basic authentication." + }, + "k8sRaw": { + "type": "object", + "description": "The raw kubernetes information" + }, + "lastUploadedDate": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date from Kubernetes cluster. Defaults to current date time" + }, + "provisioningState": { + "type": "string", + "readOnly": true + } + } + }, + "PostgresInstance": { + "description": "A Postgres Instance.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource", + "description": "null" + } + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + }, + "properties": { + "$ref": "#/definitions/PostgresInstanceProperties", + "x-ms-client-flatten": false, + "description": "null" + }, + "sku": { + "$ref": "#/definitions/PostgresInstanceSku", + "description": "Resource sku." + } + }, + "required": [ + "properties" + ] + }, + "PostgresInstanceUpdate": { + "description": "An update to a Postgres Instance.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/PostgresInstanceProperties" + } + } + }, + "PostgresInstanceListResult": { + "description": "A list of PostgresInstance.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/PostgresInstance" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "SqlManagedInstanceProperties": { + "description": "Properties of sqlManagedInstance.", + "type": "object", + "properties": { + "dataControllerId": { + "type": "string", + "description": "null" + }, + "admin": { + "type": "string", + "description": "The instance admin user" + }, + "startTime": { + "type": "string", + "description": "The instance start time" + }, + "endTime": { + "type": "string", + "description": "The instance end time" + }, + "k8sRaw": { + "type": "object", + "description": "The raw kubernetes information" + }, + "basicLoginInformation": { + "$ref": "#/definitions/BasicLoginInformation", + "description": "Username and password for basic authentication." + }, + "lastUploadedDate": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date from Kubernetes cluster. Defaults to current date time" + }, + "provisioningState": { + "type": "string", + "readOnly": true + } + } + }, + "SqlManagedInstance": { + "description": "A SqlManagedInstance.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlManagedInstanceProperties", + "description": "null", + "x-ms-client-flatten": false + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + }, + "sku": { + "$ref": "#/definitions/SqlManagedInstanceSku", + "description": "Resource sku." + } + }, + "required": [ + "properties" + ] + }, + "SqlManagedInstanceUpdate": { + "description": "An update to a SQL Managed Instance.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SqlManagedInstanceListResult": { + "description": "A list of SqlManagedInstance.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlManagedInstance" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "SqlServerInstanceProperties": { + "description": "Properties of SqlServerInstance.", + "type": "object", + "properties": { + "version": { + "type": "string", + "description": "SQL Server version." + }, + "edition": { + "type": "string", + "description": "SQL Server edition." + }, + "containerResourceId": { + "type": "string", + "description": "ARM Resource id of the container resource (Azure Arc for Servers)." + }, + "createTime": { + "type": "string", + "description": "The time when the resource was created.", + "readOnly": true + }, + "vCore": { + "type": "string", + "description": "The number of logical processors used by the SQL Server instance." + }, + "status": { + "type": "string", + "description": "The cloud connectivity status." + }, + "patchLevel": { + "type": "string", + "description": "SQL Server update level." + }, + "collation": { + "type": "string", + "description": "SQL Server collation." + }, + "currentVersion": { + "type": "string", + "description": "SQL Server current version." + }, + "instanceName": { + "type": "string", + "description": "SQL Server instance name." + }, + "tcpDynamicPorts": { + "type": "string", + "description": "Dynamic TCP ports used by SQL Server." + }, + "tcpStaticPorts": { + "type": "string", + "description": "Static TCP ports used by SQL Server." + }, + "productId": { + "type": "string", + "description": "SQL Server product ID." + }, + "licenseType": { + "type": "string", + "description": "SQL Server license type." + }, + "provisioningState": { + "type": "string", + "readOnly": true + } + }, + "required": [ + "containerResourceId", + "status" + ] + }, + "SqlServerInstance": { + "description": "A SqlServerInstance.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlServerInstanceProperties", + "description": "null", + "x-ms-client-flatten": false + } + } + }, + "SqlServerInstanceUpdate": { + "description": "An update to a SQL Server Instance.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SqlServerInstanceListResult": { + "description": "A list of SqlServerInstance.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlServerInstance" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ErrorResponse": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorResponseBody", + "description": "null" + } + }, + "description": "An error response from the Azure Data on Azure Arc service." + }, + "ErrorResponseBody": { + "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/ErrorResponseBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Batch service." + }, + "ODataError": { + "properties": { + "code": { + "type": "string", + "description": "A language-independent error name." + }, + "message": { + "type": "string", + "description": "The error message." + }, + "target": { + "type": "string", + "description": "The target of the error (for example, the name of the property in error)." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ODataError" + }, + "description": "The error details." + } + }, + "type": "object", + "description": "Information about an error." + }, + "ExtendedLocation": { + "type": "object", + "description": "The complex type of the extended location.", + "properties": { + "name": { + "type": "string", + "description": "The name of the extended location." + }, + "type": { + "$ref": "#/definitions/ExtendedLocationType", + "description": "The type of the extended location." + } + } + }, + "ExtendedLocationType": { + "type": "string", + "description": "The type of extendedLocation.", + "enum": [ + "CustomLocation" + ], + "x-ms-enum": { + "name": "ExtendedLocationTypes", + "modelAsString": true + } + }, + "BasicLoginInformation": { + "type": "object", + "description": "Username and password for basic login authentication.", + "properties": { + "username": { + "type": "string", + "description": "Login username." + }, + "password": { + "type": "string", + "description": "Login password.", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + } + }, + "LogAnalyticsWorkspaceConfig": { + "type": "object", + "description": "Log analytics workspace id and primary key", + "properties": { + "workspaceId": { + "type": "string", + "format": "uuid", + "description": "Azure Log Analytics workspace ID" + }, + "primaryKey": { + "type": "string", + "description": "Primary key of the workspace", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + } + }, + "UploadServicePrincipal": { + "type": "object", + "description": "Service principal for uploading billing, metrics and logs.", + "properties": { + "clientId": { + "type": "string", + "format": "uuid", + "description": "Client ID of the service principal for uploading data." + }, + "tenantId": { + "type": "string", + "format": "uuid", + "description": "Tenant ID of the service principal." + }, + "authority": { + "type": "string", + "description": "Authority for the service principal. Example: https://login.microsoftonline.com/" + }, + "clientSecret": { + "type": "string", + "description": "Secret of the service principal", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + } + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Azure subscription", + "x-ms-parameter-location": "client" + }, + "resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group", + "x-ms-parameter-location": "method" + }, + "location": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure region to use for the request", + "x-ms-parameter-location": "method" + }, + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request", + "x-ms-parameter-location": "client" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/CreateOrUpdateDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/CreateOrUpdateDataController.json new file mode 100644 index 000000000000..0122096d46c4 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/CreateOrUpdateDataController.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController", + "api-version": "2021-06-01-preview", + "dataControllerResource": { + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey" + }, + "basicLoginInformation": { + "username": "username", + "password": "********" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444", + "primaryKey": "********" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/", + "clientSecret": "********" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate being uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + } + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController", + "name": "testdataController", + "type": "Microsoft.AzureArcData/dataControllers" + } + }, + "201": { + "body": { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate being uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + } + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController", + "name": "testdataController", + "type": "Microsoft.AzureArcData/dataControllers" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/CreateOrUpdatePostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/CreateOrUpdatePostgresInstance.json new file mode 100644 index 000000000000..5534cbe6fb0b --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/CreateOrUpdatePostgresInstance.json @@ -0,0 +1,172 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "postgresInstanceName": "testpostgresInstance", + "api-version": "2021-06-01-preview", + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "resource": { + "location": "eastus", + "properties": { + "dataControllerId": "dataControllerId", + "admin": "admin", + "basicLoginInformation": { + "username": "username", + "password": "********" + }, + "k8sRaw": { + "apiVersion": "apiVersion", + "kind": "postgresql-12", + "metadata": { + "creationTimestamp": "2020-08-25T14:55:10Z", + "generation": 1, + "name": "pg1", + "namespace": "test", + "resourceVersion": "527780", + "selfLink": "/apis/arcdata.microsoft.com/v1alpha1/namespaces/test/postgresql-12s/pg1", + "uid": "1111aaaa-ffff-ffff-ffff-99999aaaaaaa" + }, + "spec": { + "backups": { + "deltaMinutes": 3, + "fullMinutes": 10, + "tiers": [ + { + "retention": { + "maximums": [ + "6", + "512MB" + ], + "minimums": [ + "3" + ] + }, + "storage": { + "volumeSize": "1Gi" + } + } + ] + }, + "engine": { + "extensions": [ + { + "name": "citus" + } + ] + }, + "scale": { + "shards": 3 + }, + "scheduling": { + "default": { + "resources": { + "requests": { + "memory": "256Mi" + } + } + } + }, + "service": { + "type": "NodePort" + }, + "storage": { + "data": { + "className": "local-storage", + "size": "5Gi" + }, + "logs": { + "className": "local-storage", + "size": "5Gi" + } + } + }, + "status": { + "externalEndpoint": null, + "readyPods": "4/4", + "state": "Ready" + } + } + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstance/testpostgresInstance", + "name": "testpostgresInstance", + "type": "Microsoft.AzureArcData/PostgresInstance" + } + }, + "201": { + "body": { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstance/testpostgresInstance", + "name": "testsqlregistration", + "type": "Microsoft.AzureArcData/PostgresInstance" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/CreateOrUpdateSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/CreateOrUpdateSqlManagedInstance.json new file mode 100644 index 000000000000..2699ca4130df --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/CreateOrUpdateSqlManagedInstance.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testsqlManagedInstance", + "api-version": "2021-06-01-preview", + "sqlManagedInstance": { + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "sku": { + "name": "default", + "tier": "GeneralPurpose", + "dev": true + }, + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username", + "password": "********" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testsqlManagedInstance", + "name": "testsqlManagedInstance", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + } + }, + "201": { + "body": { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testsqlManagedInstance", + "name": "testsqlManagedInstance", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/CreateOrUpdateSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/CreateOrUpdateSqlServerInstance.json new file mode 100644 index 000000000000..5e0b755e91f6 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/CreateOrUpdateSqlServerInstance.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlServerInstance", + "api-version": "2021-06-01-preview", + "sqlServerInstance": { + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "vCore": "4", + "patchLevel": "patchlevel", + "collation": "collation", + "currentVersion": "2008 R2", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "licenseType": "Free", + "status": "Connected" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "currentVersion": "2008 R2", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "licenseType": "Free", + "status": "Connected" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/testsqlServerInstance", + "name": "testsqlServerInstance", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + }, + "201": { + "body": { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "currentVersion": "2008 R2", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "licenseType": "Free", + "status": "Connected" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/testsqlServerInstance", + "name": "testsqlServerInstance", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/DeleteDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/DeleteDataController.json new file mode 100644 index 000000000000..a56ea92464fc --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/DeleteDataController.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/DeletePostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/DeletePostgresInstance.json new file mode 100644 index 000000000000..1c6d347e53a9 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/DeletePostgresInstance.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "postgresInstanceName": "testpostgresInstance", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/DeleteSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/DeleteSqlManagedInstance.json new file mode 100644 index 000000000000..8db20f0534b2 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/DeleteSqlManagedInstance.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testsqlManagedInstance", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/DeleteSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/DeleteSqlServerInstance.json new file mode 100644 index 000000000000..1baf43410d0f --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/DeleteSqlServerInstance.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlServerInstance", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/GetDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/GetDataController.json new file mode 100644 index 000000000000..d8b5e8d0d720 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/GetDataController.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + } + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController", + "name": "testdataController", + "type": "Microsoft.AzureArcData/dataControllers" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/GetPostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/GetPostgresInstance.json new file mode 100644 index 000000000000..48102ebb1d03 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/GetPostgresInstance.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "postgresInstanceName": "testpostgresInstances", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstances/testpostgresInstances", + "name": "testpostgresInstances", + "type": "Microsoft.AzureArcData/PostgresInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/GetSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/GetSqlManagedInstance.json new file mode 100644 index 000000000000..ab9bf539dc95 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/GetSqlManagedInstance.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testsqlManagedInstance", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testsqlManagedInstance", + "name": "testsqlManagedInstance", + "type": "Microsoft.AzureArcData/sqlManagedInstance" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/GetSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/GetSqlServerInstance.json new file mode 100644 index 000000000000..ba668d667513 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/GetSqlServerInstance.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlServerInstance", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "currentVersion": "2008 R2", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "licenseType": "Free", + "status": "Connected" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/testsqlServerInstance", + "name": "testsqlServerInstance", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/ListByResourceGroupDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/ListByResourceGroupDataController.json new file mode 100644 index 000000000000..224e814969db --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/ListByResourceGroupDataController.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController1", + "name": "testdataController1", + "type": "Microsoft.AzureArcData/dataControllers" + }, + { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController2", + "name": "testdataController2", + "type": "Microsoft.AzureArcData/dataControllers" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/ListByResourceGroupPostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/ListByResourceGroupPostgresInstance.json new file mode 100644 index 000000000000..1269bc31587a --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/ListByResourceGroupPostgresInstance.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstances/testpostgresInstances1", + "name": "testpostgresInstances1", + "type": "Microsoft.AzureArcData/PostgresInstances" + }, + { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstances/testpostgresInstances2", + "name": "testpostgresInstances2", + "type": "Microsoft.AzureArcData/PostgresInstances" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/ListByResourceGroupSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/ListByResourceGroupSqlManagedInstance.json new file mode 100644 index 000000000000..7f51deb536f7 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/ListByResourceGroupSqlManagedInstance.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/sqlManagedInstance1", + "name": "sqlManagedInstances1", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + }, + { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/sqlManagedInstance2", + "name": "sqlManagedInstances2", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/ListByResourceGroupSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/ListByResourceGroupSqlServerInstance.json new file mode 100644 index 000000000000..0e4cdf1b3ba8 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/ListByResourceGroupSqlServerInstance.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "currentVersion": "2008 R2", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "licenseType": "Free", + "status": "Connected" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServerInstance1", + "name": "sqlServerInstance1", + "type": "Microsoft.AzureArcData/SqlServerInstances" + }, + { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "currentVersion": "2008 R2", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "licenseType": "Free", + "status": "Connected" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServerInstance2", + "name": "sqlServerInstance2", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/ListOperation.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/ListOperation.json new file mode 100644 index 000000000000..c2e8949ffefa --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/ListOperation.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.AzureArcData/operations/read", + "isDataAction": false, + "display": { + "resource": "Microsoft.AzureArcData", + "provider": "Azure Arc Data Resource Provider.", + "operation": "List all available operations.", + "description": "List all available operations." + } + }, + { + "name": "Microsoft.AzureArcData/sqlManagedInstances/read", + "isDataAction": false, + "display": { + "resource": "Microsoft.AzureArcData", + "provider": "Azure Arc Data Resource Provider.", + "operation": "Get Sql Managed Instances details.", + "description": "Retrieves details of Sql Managed Instances." + } + }, + { + "name": "Microsoft.AzureArcData/sqlManagedInstances/write", + "isDataAction": false, + "display": { + "resource": "Microsoft.AzureArcData", + "provider": "Azure Arc Data Resource Provider.", + "operation": "Create new or update existing Sql Managed Instances", + "description": "Create a new or change properties of existing Sql Managed Instances.." + } + }, + { + "name": "Microsoft.AzureArcData/sqlManagedInstances/delete", + "isDataAction": false, + "display": { + "resource": "Microsoft.AzureArcData", + "provider": "Azure Arc Data Resource Provider.", + "operation": "Delete exisiting Sql Managed Instances.", + "description": "Delete exisiting Sql Managed Instances." + } + }, + { + "name": "Microsoft.AzureArcData/postgresInstances/read", + "isDataAction": false, + "display": { + "resource": "Microsoft.AzureArcData", + "provider": "Azure Arc Data Resource Provider.", + "operation": "Get Postgres Instance details.", + "description": "Retrieves details of Postgres Instances." + } + }, + { + "name": "Microsoft.AzureArcData/postgresInstances/write", + "isDataAction": false, + "display": { + "resource": "Microsoft.AzureArcData", + "provider": "Azure Arc Data Resource Provider.", + "operation": "Create new or update existing Postgres Instances.", + "description": "Create a new or change properties of existing Postgres Instances." + } + }, + { + "name": "Microsoft.AzureArcData/postgresInstances/delete", + "isDataAction": false, + "display": { + "resource": "Microsoft.AzureArcData", + "provider": "Azure Arc Data Resource Provider.", + "operation": "Delete exisiting Postgres Instances.", + "description": "Delete exisiting Postgres Instances." + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/read", + "isDataAction": false, + "display": { + "resource": "Microsoft.AzureArcData", + "provider": "Azure Arc Data Resource Provider.", + "operation": "Get dataControllers details.", + "description": "Retrieves details of dataControllers." + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/write", + "isDataAction": false, + "display": { + "resource": "Microsoft.AzureArcData", + "provider": "Azure Arc Data Resource Provider.", + "operation": "Create new or update existing dataControllers.", + "description": "Create a new or change properties of existing dataControllers." + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/delete", + "isDataAction": false, + "display": { + "resource": "Microsoft.AzureArcData", + "provider": "Azure Arc Data Resource Provider.", + "operation": "Delete exisiting dataControllers.", + "description": "Delete exisiting dataControllers." + } + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/ListSubscriptionDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/ListSubscriptionDataController.json new file mode 100644 index 000000000000..9d5c6c9d241f --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/ListSubscriptionDataController.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController1", + "name": "testdataController1", + "type": "Microsoft.AzureArcData/dataControllers" + }, + { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController2", + "name": "testdataController2", + "type": "Microsoft.AzureArcData/dataControllers" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/ListSubscriptionPostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/ListSubscriptionPostgresInstance.json new file mode 100644 index 000000000000..b9ae760d8f86 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/ListSubscriptionPostgresInstance.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstances/testpostgresInstances1", + "name": "testpostgresInstances1", + "type": "Microsoft.AzureArcData/PostgresInstances" + }, + { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstances/testpostgresInstances2", + "name": "testpostgresInstances2", + "type": "Microsoft.AzureArcData/PostgresInstances" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/ListSubscriptionSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/ListSubscriptionSqlManagedInstance.json new file mode 100644 index 000000000000..e78ed912b712 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/ListSubscriptionSqlManagedInstance.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlManagedInstances/sqlManagedInstance1", + "name": "sqlManagedInstances1", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + }, + { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlManagedInstances/sqlManagedInstance2", + "name": "sqlManagedInstances2", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/ListSubscriptionSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/ListSubscriptionSqlServerInstance.json new file mode 100644 index 000000000000..d49ed5f681bf --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/ListSubscriptionSqlServerInstance.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "currentVersion": "2008 R2", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "licenseType": "Free", + "status": "Connected" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServerInstance1", + "name": "sqlServerInstance1", + "type": "Microsoft.AzureArcData/SqlServerInstances" + }, + { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "currentVersion": "2008 R2", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "licenseType": "Free", + "status": "Connected" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServerInstance2", + "name": "sqlServerInstance2", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/UpdateDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/UpdateDataController.json new file mode 100644 index 000000000000..ed7ea65a5616 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/UpdateDataController.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController1", + "api-version": "2021-06-01-preview", + "dataControllerResource": { + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + } + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController1", + "name": "testdataController1", + "type": "Microsoft.AzureArcData/dataControllers" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/UpdatePostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/UpdatePostgresInstance.json new file mode 100644 index 000000000000..929d5761a8d1 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/UpdatePostgresInstance.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "postgresInstanceName": "testpostgresInstance", + "api-version": "2021-06-01-preview", + "parameters": { + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstance/testpostgresInstance", + "name": "testpostgresInstance", + "type": "Microsoft.AzureArcData/PostgresInstance" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/UpdateSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/UpdateSqlManagedInstance.json new file mode 100644 index 000000000000..6c1171ac4ad2 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/UpdateSqlManagedInstance.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testsqlManagedInstance", + "api-version": "2021-06-01-preview", + "parameters": { + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "sku": { + "name": "default", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testsqlManagedInstance", + "name": "testsqlManagedInstance", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/UpdateSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/UpdateSqlServerInstance.json new file mode 100644 index 000000000000..59c10e66c3e1 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2021-06-01-preview/examples/UpdateSqlServerInstance.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlServerInstance", + "api-version": "2021-06-01-preview", + "parameters": { + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "currentVersion": "2008 R2", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "licenseType": "Free", + "status": "Connected" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/testsqlServerInstance", + "name": "testsqlServerInstance", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json new file mode 100644 index 000000000000..8365ce078488 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json @@ -0,0 +1,2015 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-08-01", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.AzureArcData/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available Azure Data Services on Azure Arc API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved operations.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Lists all of the available Azure Data Services on Azure Arc API operations.": { + "$ref": "./examples/ListOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/sqlManagedInstances": { + "get": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_List", + "summary": "List sqlManagedInstance resources in the subscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlManagedInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 404 ResourceNotFound - The requested resource was not found.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Instance in a subscription.": { + "$ref": "./examples/ListSubscriptionSqlManagedInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlManagedInstances": { + "get": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_ListByResourceGroup", + "description": "Gets all sqlManagedInstances in a resource group.", + "summary": "List sqlManagedInstance resources in the resource group", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlManagedInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Instance in a resource group.": { + "$ref": "./examples/ListByResourceGroupSqlManagedInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlManagedInstances/{sqlManagedInstanceName}": { + "get": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_Get", + "description": "Retrieves a SQL Managed Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlManagedInstanceName", + "description": "Name of SQL Managed Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlManagedInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a SQL Instance tags.": { + "$ref": "./examples/GetSqlManagedInstance.json" + } + } + }, + "put": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_Create", + "description": "Creates or replaces a SQL Managed Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlManagedInstanceName", + "description": "The name of SQL Managed Instances", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "sqlManagedInstance", + "in": "body", + "description": "The SQL Managed Instance to be created or updated.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlManagedInstance" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlManagedInstance" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SqlManagedInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a SQL Managed Instance": { + "$ref": "./examples/CreateOrUpdateSqlManagedInstance.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_Delete", + "description": "Deletes a SQL Managed Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlManagedInstanceName", + "description": "The name of Sql Managed Instances", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the SQL Managed Instance." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified SQL Managed Instance does not exist." + } + }, + "x-ms-examples": { + "Delete a SQL Instance.": { + "$ref": "./examples/DeleteSqlManagedInstance.json" + } + } + }, + "patch": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_Update", + "description": "Updates a SQL Managed Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlManagedInstanceName", + "description": "Name of sqlManagedInstance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "parameters", + "in": "body", + "description": "The SQL Managed Instance.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlManagedInstanceUpdate" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlManagedInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a sql Instance tags.": { + "$ref": "./examples/UpdateSqlManagedInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/sqlServerInstances": { + "get": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_List", + "summary": "List sqlServerInstance resources in the subscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 404 ResourceNotFound - The requested resource was not found.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Server Instance in a subscription.": { + "$ref": "./examples/ListSubscriptionSqlServerInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances": { + "get": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_ListByResourceGroup", + "description": "Gets all sqlServerInstances in a resource group.", + "summary": "List sqlServerInstance resources in the resource group", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Server Instance in a resource group.": { + "$ref": "./examples/ListByResourceGroupSqlServerInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}": { + "get": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_Get", + "description": "Retrieves a SQL Server Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlServerInstanceName", + "description": "Name of SQL Server Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a SQL Server Instance tags.": { + "$ref": "./examples/GetSqlServerInstance.json" + } + } + }, + "put": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_Create", + "description": "Creates or replaces a SQL Server Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlServerInstanceName", + "description": "The name of SQL Server Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "sqlServerInstance", + "in": "body", + "description": "The SQL Server Instance to be created or updated.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlServerInstance" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerInstance" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SqlServerInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a SQL Server Instance tags.": { + "$ref": "./examples/CreateOrUpdateSqlServerInstance.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_Delete", + "description": "Deletes a SQL Server Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlServerInstanceName", + "description": "The name of SQL Server Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the SQL Server Instance." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified SQL Server Instance does not exist." + } + }, + "x-ms-examples": { + "Delete a SQL Server Instance.": { + "$ref": "./examples/DeleteSqlServerInstance.json" + } + } + }, + "patch": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_Update", + "description": "Updates a SQL Server Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlServerInstanceName", + "description": "Name of sqlServerInstance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "parameters", + "in": "body", + "description": "The SQL Server Instance.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlServerInstanceUpdate" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a SQL Server Instance tags.": { + "$ref": "./examples/UpdateSqlServerInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/dataControllers": { + "get": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_ListInSubscription", + "summary": "List dataController resources in the subscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PageOfDataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all dataControllers in a subscription.": { + "$ref": "./examples/ListSubscriptionDataController.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/dataControllers": { + "get": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_ListInGroup", + "summary": "List dataController resources in the resource group", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PageOfDataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all dataControllers in a resource group.": { + "$ref": "./examples/ListByResourceGroupDataController.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/dataControllers/{dataControllerName}": { + "put": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_PutDataController", + "description": "Creates or replaces a dataController resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "dataControllerResource", + "description": "desc", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/DataControllerResource" + } + }, + { + "name": "dataControllerName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DataControllerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a Data Controller.": { + "$ref": "./examples/CreateOrUpdateDataController.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_DeleteDataController", + "description": "Deletes a dataController resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "dataControllerName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the DataController." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified DataController does not exist." + } + }, + "x-ms-examples": { + "Delete a dataController.": { + "$ref": "./examples/DeleteDataController.json" + } + } + }, + "get": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_GetDataController", + "description": "Retrieves a dataController resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "dataControllerName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a data controller.": { + "$ref": "./examples/GetDataController.json" + } + } + }, + "patch": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_PatchDataController", + "description": "Updates a dataController resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "dataControllerName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "name": "dataControllerResource", + "description": "The update data controller resource", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/DataControllerUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a dataController tags.": { + "$ref": "./examples/UpdateDataController.json" + } + } + } + } + }, + "definitions": { + "CommonSku": { + "description": "The resource model definition representing SKU for ARM resources", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU. It is typically a letter+number code" + }, + "dev": { + "type": "boolean", + "default": true, + "description": "Whether dev/test is enabled. When the dev field is set to true, the resource is used for dev/test purpose. " + }, + "size": { + "type": "string", + "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. " + }, + "family": { + "type": "string", + "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here." + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted." + } + }, + "required": [ + "name" + ] + }, + "SqlManagedInstanceSku": { + "description": "The resource model definition representing SKU for Azure Managed Instance - Azure Arc", + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "vCore" + ], + "description": "The name of the SKU." + }, + "tier": { + "type": "string", + "enum": [ + "GeneralPurpose", + "BusinessCritical" + ], + "x-ms-enum": { + "name": "SqlManagedInstanceSkuTier", + "modelAsString": false + }, + "default": "GeneralPurpose", + "description": "The pricing tier for the instance." + }, + "dev": { + "type": "boolean", + "default": true, + "description": "Whether dev/test is enabled. When the dev field is set to true, the resource is used for dev/test purpose. " + }, + "size": { + "type": "string", + "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. " + }, + "family": { + "type": "string" + }, + "capacity": { + "type": "integer", + "format": "int32" + } + }, + "required": [ + "name" + ] + }, + "Identity": { + "description": "Identity for the resource.", + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of resource identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID of resource." + }, + "type": { + "type": "string", + "description": "The identity type.", + "enum": [ + "SystemAssigned" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + } + } + }, + "Plan": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "A user defined name of the 3rd Party Artifact that is being procured." + }, + "publisher": { + "type": "string", + "description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic" + }, + "product": { + "type": "string", + "description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. " + }, + "promotionCode": { + "type": "string", + "description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact." + }, + "version": { + "type": "string", + "description": "The version of the desired product/artifact." + } + }, + "description": "Plan for the resource.", + "required": [ + "name", + "publisher", + "product" + ] + }, + "OperationListResult": { + "description": "Result of the request to list Azure Data Services on Azure Arc operations.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "Operation": { + "description": "Azure Data Services on Azure Arc operation definition.", + "type": "object", + "properties": { + "name": { + "description": "The name of the operation being performed on this particular object.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "The localized display information for this particular operation / action." + }, + "origin": { + "description": "The intended executor of the operation.", + "enum": [ + "user", + "system" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "OperationOrigin", + "modelAsString": true + } + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "properties": { + "description": "Additional descriptions for the operation.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "readOnly": true, + "x-ms-client-flatten": false + } + }, + "required": [ + "name", + "display", + "isDataAction" + ] + }, + "OperationDisplay": { + "description": "Display metadata associated with the operation.", + "type": "object", + "properties": { + "provider": { + "description": "The localized friendly form of the resource provider name.", + "type": "string" + }, + "resource": { + "description": "The localized friendly form of the resource type related to this action/operation.", + "type": "string" + }, + "operation": { + "description": "The localized friendly name for the operation.", + "type": "string" + }, + "description": { + "description": "The localized friendly description for the operation.", + "type": "string" + } + }, + "required": [ + "provider", + "resource", + "operation", + "description" + ] + }, + "Resource": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts." + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "type": "object", + "description": "The resource model definition for a ARM tracked top level resource", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "systemData": { + "$ref": "#/definitions/SystemData", + "readOnly": true + } + }, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ProxyResource": { + "type": "object", + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "PageOfDataControllerResource": { + "type": "object", + "properties": { + "value": { + "items": { + "$ref": "#/definitions/DataControllerResource" + }, + "type": "array" + }, + "nextLink": { + "type": "string", + "description": "Link to retrieve next page of results." + } + } + }, + "DataControllerResource": { + "description": "Data controller resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + }, + "properties": { + "$ref": "#/definitions/DataControllerProperties", + "description": "The data controller's properties", + "x-ms-client-flatten": false + } + }, + "required": [ + "properties" + ] + }, + "DataControllerUpdate": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "description": "Used for updating a data controller resource." + }, + "SystemData": { + "description": "Read only system data", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "An identifier for the identity that created the resource" + }, + "createdByType": { + "$ref": "#/definitions/IdentityType", + "description": "The type of identity that created the resource" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)" + }, + "lastModifiedBy": { + "type": "string", + "description": "An identifier for the identity that last modified the resource" + }, + "lastModifiedByType": { + "$ref": "#/definitions/IdentityType", + "description": "The type of identity that last modified the resource" + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)" + } + } + }, + "IdentityType": { + "description": "The type of identity that creates/modifies resources", + "type": "string", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": true + } + }, + "ResourceSku": { + "type": "object", + "properties": { + "capacity": { + "type": "integer", + "format": "int32" + }, + "family": { + "type": "string" + }, + "name": { + "type": "string" + }, + "size": { + "type": "string" + }, + "tier": { + "type": "string" + } + } + }, + "DataControllerProperties": { + "description": "The data controller properties.", + "type": "object", + "properties": { + "infrastructure": { + "type": "string", + "enum": [ + "azure", + "gcp", + "aws", + "alibaba", + "onpremises", + "other" + ], + "x-ms-enum": { + "name": "infrastructure", + "modelAsString": false + }, + "default": "other", + "description": "The infrastructure the data controller is running on." + }, + "onPremiseProperty": { + "$ref": "#/definitions/OnPremiseProperty" + }, + "k8sRaw": { + "type": "object", + "description": "The raw kubernetes information" + }, + "uploadWatermark": { + "$ref": "#/definitions/UploadWatermark" + }, + "lastUploadedDate": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date from Kubernetes cluster. Defaults to current date time" + }, + "basicLoginInformation": { + "$ref": "#/definitions/BasicLoginInformation" + }, + "logAnalyticsWorkspaceConfig": { + "$ref": "#/definitions/LogAnalyticsWorkspaceConfig" + }, + "uploadServicePrincipal": { + "$ref": "#/definitions/UploadServicePrincipal" + }, + "provisioningState": { + "type": "string", + "readOnly": true + }, + "clusterId": { + "type": "string", + "description": "If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to." + }, + "extensionId": { + "type": "string", + "description": "If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to." + } + } + }, + "UploadWatermark": { + "description": "Properties on upload watermark. Mostly timestamp for each upload data type", + "type": "object", + "properties": { + "metrics": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date for metrics from kubernetes cluster. Defaults to current date time" + }, + "logs": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date for logs from kubernetes cluster. Defaults to current date time" + }, + "usages": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date for usages from kubernetes cluster. Defaults to current date time" + } + } + }, + "OnPremiseProperty": { + "description": "Properties from the Kubernetes data controller", + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "A globally unique ID identifying the associated Kubernetes cluster" + }, + "publicSigningKey": { + "type": "string", + "description": "Certificate that contains the Kubernetes cluster public key used to verify signing" + }, + "signingCertificateThumbprint": { + "type": "string", + "description": "Unique thumbprint returned to customer to verify the certificate being uploaded" + } + }, + "required": [ + "id", + "publicSigningKey" + ] + }, + "SqlManagedInstanceProperties": { + "description": "Properties of sqlManagedInstance.", + "type": "object", + "properties": { + "dataControllerId": { + "type": "string", + "description": "null" + }, + "admin": { + "type": "string", + "description": "The instance admin user" + }, + "startTime": { + "type": "string", + "description": "The instance start time" + }, + "endTime": { + "type": "string", + "description": "The instance end time" + }, + "k8sRaw": { + "$ref": "#/definitions/SqlManagedInstanceK8sRaw", + "description": "The raw kubernetes information" + }, + "basicLoginInformation": { + "$ref": "#/definitions/BasicLoginInformation", + "description": "Username and password for basic authentication." + }, + "lastUploadedDate": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date from Kubernetes cluster. Defaults to current date time" + }, + "provisioningState": { + "type": "string", + "readOnly": true + }, + "licenseType": { + "type": "string", + "enum": [ + "BasePrice", + "LicenseIncluded" + ], + "x-ms-enum": { + "name": "arcSqlManagedInstanceLicenseType", + "modelAsString": false + }, + "default": "BasePrice", + "description": "The license type to apply for this managed instance." + }, + "clusterId": { + "type": "string", + "description": "If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to." + }, + "extensionId": { + "type": "string", + "description": "If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to." + } + } + }, + "SqlManagedInstance": { + "description": "A SqlManagedInstance.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlManagedInstanceProperties", + "description": "null", + "x-ms-client-flatten": false + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + }, + "sku": { + "$ref": "#/definitions/SqlManagedInstanceSku", + "description": "Resource sku." + } + }, + "required": [ + "properties" + ] + }, + "SqlManagedInstanceUpdate": { + "description": "An update to a SQL Managed Instance.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SqlManagedInstanceListResult": { + "description": "A list of SqlManagedInstance.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlManagedInstance" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "SqlServerInstanceProperties": { + "description": "Properties of SqlServerInstance.", + "type": "object", + "properties": { + "version": { + "type": "string", + "description": "SQL Server version.", + "enum": [ + "SQL Server 2019", + "SQL Server 2017", + "SQL Server 2016" + ], + "x-ms-enum": { + "name": "sqlVersion", + "modelAsString": true + } + }, + "edition": { + "type": "string", + "description": "SQL Server edition.", + "enum": [ + "Evaluation", + "Enterprise", + "Standard", + "Web", + "Developer", + "Express" + ], + "x-ms-enum": { + "name": "editionType", + "modelAsString": true + } + }, + "containerResourceId": { + "type": "string", + "description": "ARM Resource id of the container resource (Azure Arc for Servers)." + }, + "createTime": { + "type": "string", + "description": "The time when the resource was created.", + "readOnly": true + }, + "vCore": { + "type": "string", + "description": "The number of logical processors used by the SQL Server instance." + }, + "status": { + "type": "string", + "description": "The cloud connectivity status.", + "enum": [ + "Connected", + "Disconnected", + "Unknown" + ], + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + } + }, + "patchLevel": { + "type": "string", + "description": "SQL Server update level." + }, + "collation": { + "type": "string", + "description": "SQL Server collation." + }, + "currentVersion": { + "type": "string", + "description": "SQL Server current version." + }, + "instanceName": { + "type": "string", + "description": "SQL Server instance name." + }, + "tcpDynamicPorts": { + "type": "string", + "description": "Dynamic TCP ports used by SQL Server." + }, + "tcpStaticPorts": { + "type": "string", + "description": "Static TCP ports used by SQL Server." + }, + "productId": { + "type": "string", + "description": "SQL Server product ID." + }, + "licenseType": { + "type": "string", + "description": "SQL Server license type.", + "enum": [ + "Paid", + "Free", + "HADR", + "Undefined" + ], + "x-ms-enum": { + "name": "arcSqlServerLicenseType", + "modelAsString": true + } + }, + "azureDefenderStatusLastUpdated": { + "type": "string", + "format": "date-time", + "description": "Timestamp of last Azure Defender status update." + }, + "azureDefenderStatus": { + "type": "string", + "description": "Status of Azure Defender.", + "enum": [ + "Protected", + "Unprotected", + "Unknown" + ], + "x-ms-enum": { + "name": "defenderStatus", + "modelAsString": true + } + }, + "provisioningState": { + "type": "string", + "readOnly": true + } + }, + "required": [ + "containerResourceId", + "status" + ] + }, + "SqlServerInstance": { + "description": "A SqlServerInstance.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlServerInstanceProperties", + "description": "null", + "x-ms-client-flatten": false + } + } + }, + "SqlServerInstanceUpdate": { + "description": "An update to a SQL Server Instance.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SqlServerInstanceListResult": { + "description": "A list of SqlServerInstance.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlServerInstance" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ErrorResponse": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorResponseBody", + "description": "null" + } + }, + "description": "An error response from the Azure Data on Azure Arc service." + }, + "ErrorResponseBody": { + "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/ErrorResponseBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Batch service." + }, + "ODataError": { + "properties": { + "code": { + "type": "string", + "description": "A language-independent error name." + }, + "message": { + "type": "string", + "description": "The error message." + }, + "target": { + "type": "string", + "description": "The target of the error (for example, the name of the property in error)." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ODataError" + }, + "description": "The error details." + } + }, + "type": "object", + "description": "Information about an error." + }, + "ExtendedLocation": { + "type": "object", + "description": "The complex type of the extended location.", + "properties": { + "name": { + "type": "string", + "description": "The name of the extended location." + }, + "type": { + "$ref": "#/definitions/ExtendedLocationType", + "description": "The type of the extended location." + } + } + }, + "ExtendedLocationType": { + "type": "string", + "description": "The type of extendedLocation.", + "enum": [ + "CustomLocation" + ], + "x-ms-enum": { + "name": "ExtendedLocationTypes", + "modelAsString": true + } + }, + "BasicLoginInformation": { + "type": "object", + "description": "Username and password for basic login authentication.", + "properties": { + "username": { + "type": "string", + "description": "Login username." + }, + "password": { + "type": "string", + "description": "Login password.", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + } + }, + "SqlManagedInstanceK8sRaw": { + "type": "object", + "description": "The raw kubernetes information.", + "properties": { + "spec": { + "$ref": "#/definitions/SqlManagedInstanceK8sSpec" + } + }, + "additionalProperties": { + "type": "object" + } + }, + "SqlManagedInstanceK8sSpec": { + "type": "object", + "description": "The kubernetes spec information.", + "properties": { + "scheduling": { + "$ref": "#/definitions/K8sScheduling" + }, + "replicas": { + "type": "integer", + "format": "int32", + "description": "This option specifies the number of SQL Managed Instance replicas that will be deployed in your Kubernetes cluster for high availability purposes. If sku.tier is BusinessCritical, allowed values are '2' or '3' with default of '3'. If sku.tier is GeneralPurpose, replicas must be '1'." + } + }, + "additionalProperties": { + "type": "object" + } + }, + "K8sScheduling": { + "type": "object", + "description": "The kubernetes scheduling information.", + "properties": { + "default": { + "$ref": "#/definitions/K8sSchedulingOptions" + } + }, + "additionalProperties": { + "type": "object" + } + }, + "K8sSchedulingOptions": { + "type": "object", + "description": "The kubernetes scheduling options. It describes restrictions used to help Kubernetes select appropriate nodes to host the database service", + "properties": { + "resources": { + "$ref": "#/definitions/K8sResourceRequirements" + } + }, + "additionalProperties": { + "type": "object" + } + }, + "K8sResourceRequirements": { + "type": "object", + "description": "The kubernetes resource limits and requests used to restrict or reserve resource usage.", + "properties": { + "requests": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Requests for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'." + }, + "limits": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Limits for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'." + } + }, + "additionalProperties": { + "type": "object" + } + }, + "LogAnalyticsWorkspaceConfig": { + "type": "object", + "description": "Log analytics workspace id and primary key", + "properties": { + "workspaceId": { + "type": "string", + "format": "uuid", + "description": "Azure Log Analytics workspace ID" + }, + "primaryKey": { + "type": "string", + "description": "Primary key of the workspace", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + } + }, + "UploadServicePrincipal": { + "type": "object", + "description": "Service principal for uploading billing, metrics and logs.", + "properties": { + "clientId": { + "type": "string", + "format": "uuid", + "description": "Client ID of the service principal for uploading data." + }, + "tenantId": { + "type": "string", + "format": "uuid", + "description": "Tenant ID of the service principal." + }, + "authority": { + "type": "string", + "description": "Authority for the service principal. Example: https://login.microsoftonline.com/" + }, + "clientSecret": { + "type": "string", + "description": "Secret of the service principal", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + } + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Azure subscription", + "x-ms-parameter-location": "client" + }, + "resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group", + "x-ms-parameter-location": "method" + }, + "location": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure region to use for the request", + "x-ms-parameter-location": "method" + }, + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request", + "x-ms-parameter-location": "client" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/CreateOrUpdateDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/CreateOrUpdateDataController.json new file mode 100644 index 000000000000..be610ab85443 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/CreateOrUpdateDataController.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController", + "api-version": "2021-08-01", + "dataControllerResource": { + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey" + }, + "basicLoginInformation": { + "username": "username", + "password": "********" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444", + "primaryKey": "********" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/", + "clientSecret": "********" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate being uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController", + "name": "testdataController", + "type": "Microsoft.AzureArcData/dataControllers" + } + }, + "201": { + "body": { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate being uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController", + "name": "testdataController", + "type": "Microsoft.AzureArcData/dataControllers" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/CreateOrUpdateSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/CreateOrUpdateSqlManagedInstance.json new file mode 100644 index 000000000000..b32b7c337fd2 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/CreateOrUpdateSqlManagedInstance.json @@ -0,0 +1,181 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testsqlManagedInstance", + "api-version": "2021-08-01", + "sqlManagedInstance": { + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username", + "password": "********" + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testsqlManagedInstance", + "name": "testsqlManagedInstance", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + } + }, + "201": { + "body": { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testsqlManagedInstance", + "name": "testsqlManagedInstance", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/CreateOrUpdateSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/CreateOrUpdateSqlServerInstance.json new file mode 100644 index 000000000000..f5b18b1cc7c1 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/CreateOrUpdateSqlServerInstance.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlServerInstance", + "api-version": "2021-08-01", + "sqlServerInstance": { + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "vCore": "4", + "patchLevel": "patchlevel", + "collation": "collation", + "currentVersion": "2008 R2", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "status": "Connected", + "azureDefenderStatus": "Protected" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "currentVersion": "2008 R2", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "status": "Connected", + "azureDefenderStatus": "Protected" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/testsqlServerInstance", + "name": "testsqlServerInstance", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + }, + "201": { + "body": { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "currentVersion": "2008 R2", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "status": "Connected", + "azureDefenderStatus": "Protected" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/testsqlServerInstance", + "name": "testsqlServerInstance", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/DeleteDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/DeleteDataController.json new file mode 100644 index 000000000000..6a89f9eee6a4 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/DeleteDataController.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController", + "api-version": "2021-08-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/DeleteSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/DeleteSqlManagedInstance.json new file mode 100644 index 000000000000..9e3e3d305063 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/DeleteSqlManagedInstance.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testsqlManagedInstance", + "api-version": "2021-08-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/DeleteSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/DeleteSqlServerInstance.json new file mode 100644 index 000000000000..93f371929bfe --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/DeleteSqlServerInstance.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlServerInstance", + "api-version": "2021-08-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/GetDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/GetDataController.json new file mode 100644 index 000000000000..2dcb2fbc4ab2 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/GetDataController.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController", + "api-version": "2021-08-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController", + "name": "testdataController", + "type": "Microsoft.AzureArcData/dataControllers" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/GetSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/GetSqlManagedInstance.json new file mode 100644 index 000000000000..5179d96d4e40 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/GetSqlManagedInstance.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testsqlManagedInstance", + "api-version": "2021-08-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testsqlManagedInstance", + "name": "testsqlManagedInstance", + "type": "Microsoft.AzureArcData/sqlManagedInstance" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/GetSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/GetSqlServerInstance.json new file mode 100644 index 000000000000..0efaecdfe3d6 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/GetSqlServerInstance.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlServerInstance", + "api-version": "2021-08-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "currentVersion": "2008 R2", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "azureDefenderStatus": "Protected", + "status": "Connected" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/testsqlServerInstance", + "name": "testsqlServerInstance", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/ListByResourceGroupDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/ListByResourceGroupDataController.json new file mode 100644 index 000000000000..f1a3099b21f9 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/ListByResourceGroupDataController.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2021-08-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController1", + "name": "testdataController1", + "type": "Microsoft.AzureArcData/dataControllers" + }, + { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController2", + "name": "testdataController2", + "type": "Microsoft.AzureArcData/dataControllers" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/ListByResourceGroupSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/ListByResourceGroupSqlManagedInstance.json new file mode 100644 index 000000000000..923e5a9bbb6b --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/ListByResourceGroupSqlManagedInstance.json @@ -0,0 +1,131 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2021-08-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "licenseType": "LicenseIncluded", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/sqlManagedInstance1", + "name": "sqlManagedInstances1", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + }, + { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/sqlManagedInstance2", + "name": "sqlManagedInstances2", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/ListByResourceGroupSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/ListByResourceGroupSqlServerInstance.json new file mode 100644 index 000000000000..c545dd367158 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/ListByResourceGroupSqlServerInstance.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2021-08-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "currentVersion": "2008 R2", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "azureDefenderStatus": "Protected", + "status": "Connected" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServerInstance1", + "name": "sqlServerInstance1", + "type": "Microsoft.AzureArcData/SqlServerInstances" + }, + { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "currentVersion": "2008 R2", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "azureDefenderStatus": "Protected", + "status": "Connected" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServerInstance2", + "name": "sqlServerInstance2", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/ListOperation.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/ListOperation.json new file mode 100644 index 000000000000..0d6c0a6b6335 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/ListOperation.json @@ -0,0 +1,243 @@ +{ + "parameters": { + "api-version": "2021-08-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.AzureArcData/Locations/OperationStatuses/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "Locations/OperationStatuses", + "operation": "read_OperationStatuses", + "description": "read OperationStatuses" + } + }, + { + "name": "Microsoft.AzureArcData/Locations/OperationStatuses/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "Locations/OperationStatuses", + "operation": "write_OperationStatuses", + "description": "write OperationStatuses" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers", + "operation": "DataControllers_ListInSubscription", + "description": "read dataControllers" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers", + "operation": "DataControllers_ListInGroup", + "description": "read dataControllers" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers", + "operation": "DataControllers_GetDataController", + "description": "Retrieves a dataController resource" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers", + "operation": "DataControllers_PutDataController", + "description": "Creates or replaces a dataController resource" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers", + "operation": "DataControllers_DeleteDataController", + "description": "Deletes a dataController resource" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers", + "operation": "DataControllers_PatchDataController", + "description": "Updates a dataController resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlManagedInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlManagedInstances", + "operation": "SqlManagedInstances_List", + "description": "read sqlManagedInstances" + } + }, + { + "name": "Microsoft.AzureArcData/sqlManagedInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlManagedInstances", + "operation": "SqlManagedInstances_ListByResourceGroup", + "description": "Gets all sqlManagedInstances in a resource group." + } + }, + { + "name": "Microsoft.AzureArcData/sqlManagedInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlManagedInstances", + "operation": "SqlManagedInstances_Get", + "description": "Retrieves a SQL Managed Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlManagedInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlManagedInstances", + "operation": "SqlManagedInstances_Create", + "description": "Creates or replaces a SQL Managed Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlManagedInstances/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlManagedInstances", + "operation": "SqlManagedInstances_Delete", + "description": "Deletes a SQL Managed Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlManagedInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlManagedInstances", + "operation": "SqlManagedInstances_Update", + "description": "Updates a SQL Managed Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances", + "operation": "SqlServerInstances_List", + "description": "read sqlServerInstances" + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances", + "operation": "SqlServerInstances_ListByResourceGroup", + "description": "Gets all sqlServerInstances in a resource group." + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances", + "operation": "SqlServerInstances_Get", + "description": "Retrieves a SQL Server Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances", + "operation": "SqlServerInstances_Create", + "description": "Creates or replaces a SQL Server Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances", + "operation": "SqlServerInstances_Delete", + "description": "Deletes a SQL Server Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances", + "operation": "SqlServerInstances_Update", + "description": "Updates a SQL Server Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/register/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "Microsoft.AzureArcData", + "operation": "Register the Microsoft.AzureArcData", + "description": "Register the subscription for Microsoft.AzureArcData" + } + }, + { + "name": "Microsoft.AzureArcData/unregister/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "Microsoft.AzureArcData", + "operation": "Unregister the Microsoft.AzureArcData", + "description": "Unregister the subscription for Microsoft.AzureArcData" + } + }, + { + "name": "Microsoft.AzureArcData/Operations/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "Operations", + "operation": "read_Operations", + "description": "read Operations" + } + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/ListSubscriptionDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/ListSubscriptionDataController.json new file mode 100644 index 000000000000..815edac1e42d --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/ListSubscriptionDataController.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2021-08-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController1", + "name": "testdataController1", + "type": "Microsoft.AzureArcData/dataControllers" + }, + { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension" + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController2", + "name": "testdataController2", + "type": "Microsoft.AzureArcData/dataControllers" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/ListSubscriptionSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/ListSubscriptionSqlManagedInstance.json new file mode 100644 index 000000000000..74a311b6c5fd --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/ListSubscriptionSqlManagedInstance.json @@ -0,0 +1,132 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2021-08-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlManagedInstances/sqlManagedInstance1", + "name": "sqlManagedInstances1", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + }, + { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlManagedInstances/sqlManagedInstance2", + "name": "sqlManagedInstances2", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/ListSubscriptionSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/ListSubscriptionSqlServerInstance.json new file mode 100644 index 000000000000..b926167c5eef --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/ListSubscriptionSqlServerInstance.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2021-08-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "currentVersion": "2008 R2", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "azureDefenderStatus": "Protected", + "status": "Connected" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServerInstance1", + "name": "sqlServerInstance1", + "type": "Microsoft.AzureArcData/SqlServerInstances" + }, + { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "currentVersion": "2008 R2", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "azureDefenderStatus": "Protected", + "status": "Connected" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServerInstance2", + "name": "sqlServerInstance2", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/UpdateDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/UpdateDataController.json new file mode 100644 index 000000000000..53c6bdf36e40 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/UpdateDataController.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController1", + "api-version": "2021-08-01", + "dataControllerResource": { + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController1", + "name": "testdataController1", + "type": "Microsoft.AzureArcData/dataControllers" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/UpdateSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/UpdateSqlManagedInstance.json new file mode 100644 index 000000000000..282574bd0d9a --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/UpdateSqlManagedInstance.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testsqlManagedInstance", + "api-version": "2021-08-01", + "parameters": { + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testsqlManagedInstance", + "name": "testsqlManagedInstance", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/UpdateSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/UpdateSqlServerInstance.json new file mode 100644 index 000000000000..19679c23e53f --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/stable/2021-08-01/examples/UpdateSqlServerInstance.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlServerInstance", + "api-version": "2021-08-01", + "parameters": { + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "currentVersion": "2008 R2", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "azureDefenderStatus": "Protected", + "status": "Connected" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/testsqlServerInstance", + "name": "testsqlServerInstance", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/readme.azureresourceschema.md b/specification/azurearcdata/resource-manager/readme.azureresourceschema.md new file mode 100644 index 000000000000..8a5870cc234b --- /dev/null +++ b/specification/azurearcdata/resource-manager/readme.azureresourceschema.md @@ -0,0 +1,24 @@ +## AzureResourceSchema + +These settings apply only when `--azureresourceschema` is specified on the command line. + +### AzureResourceSchema multi-api + +``` yaml $(azureresourceschema) && $(multiapi) +batch: + - tag: schema-azurearcdata-2021-08-01 + +``` + +Please also specify `--azureresourceschema-folder=`. + +### Tag: schema-azurearcdata-2021-08-01 and azureresourceschema + +``` yaml $(tag) == 'schema-azurearcdata-2021-08-01' && $(azureresourceschema) +output-folder: $(azureresourceschema-folder)/schemas + +# all the input files in this apiVersion +input-file: + - Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json + +``` diff --git a/specification/azurearcdata/resource-manager/readme.csharp.md b/specification/azurearcdata/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..86e6f18ef788 --- /dev/null +++ b/specification/azurearcdata/resource-manager/readme.csharp.md @@ -0,0 +1,15 @@ +## C + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true + client-side-validation: false + namespace: Microsoft.Azure.Management.AzureArcData + output-folder: $(csharp-sdks-folder)/resources/Microsoft.Azure.Management.AzureArcData/src/Generated +``` diff --git a/specification/azurearcdata/resource-manager/readme.go.md b/specification/azurearcdata/resource-manager/readme.go.md new file mode 100644 index 000000000000..52d7ddc4175a --- /dev/null +++ b/specification/azurearcdata/resource-manager/readme.go.md @@ -0,0 +1,26 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + clear-output-folder: true + namespace: azurearcdata +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2021-08-01 +``` + +### Tag: package-2021-08-01 and go + +These settings apply only when `--tag=package-2021-08-01 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +```yaml $(tag) == 'package-2021-08-01' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2021-08-01/$(namespace) +``` diff --git a/specification/azurearcdata/resource-manager/readme.md b/specification/azurearcdata/resource-manager/readme.md new file mode 100644 index 000000000000..3cafcfb94b48 --- /dev/null +++ b/specification/azurearcdata/resource-manager/readme.md @@ -0,0 +1,97 @@ +# azurearcdata + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for azurearcdata. + +## 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 azurearcdata. + +``` yaml +openapi-type: arm +openapi-subtype: rpaas +tag: package-2021-08-01 +``` + +### Tag: package-2021-08-01 + +These settings apply only when `--tag=package-2021-08-01` is specified on the command line. + +```yaml $(tag) == 'package-2021-08-01' +input-file: + - Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json +``` + +### Tag: package-preview-2021-06-01 + +These settings apply only when `--tag=package-preview-2021-06-01` is specified on the command line. + +```yaml $(tag) == 'package-preview-2021-06-01' +input-file: + - Microsoft.AzureArcData/preview/2021-06-01-preview/azurearcdata.json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-net + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_azurearcdata'] + - repo: azure-resource-manager-schemas + after_scripts: + - node sdkauto_afterscript.js azurearcdata/resource-manager +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Ruby + +See configuration in [readme.ruby.md](./readme.ruby.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) + +## AzureResourceSchema + +See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) diff --git a/specification/azurearcdata/resource-manager/readme.python.md b/specification/azurearcdata/resource-manager/readme.python.md new file mode 100644 index 000000000000..a0e2218f035d --- /dev/null +++ b/specification/azurearcdata/resource-manager/readme.python.md @@ -0,0 +1,23 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-azurearcdata +no-namespace-folders: true +package-version: 1.0.0b1 +clear-output-folder: true +``` + +``` yaml $(python-mode) == 'update' && $(track2) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/azurearcdata/azure-mgmt-azurearcdata/azure/mgmt/azurearcdata +``` + +``` yaml $(python-mode) == 'create' && $(track2) +basic-setup-py: true +output-folder: $(python-sdks-folder)/azurearcdata/azure-mgmt-azurearcdata +``` diff --git a/specification/azurearcdata/resource-manager/readme.ruby.md b/specification/azurearcdata/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..171ecdb4caaf --- /dev/null +++ b/specification/azurearcdata/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_azurearcdata +package-version: 2021-08-01 +azure-arm: true +``` + +### Tag: package-2021-08-01 and ruby + +These settings apply only when `--tag=package-2021-08-01 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +```yaml $(tag) == 'package-2021-08-01' && $(ruby) +namespace: Microsoft.AzureArcData +output-folder: $(ruby-sdks-folder)/azurearcdata +``` diff --git a/specification/azurearcdata/resource-manager/readme.typescript.md b/specification/azurearcdata/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..cb07caca32d6 --- /dev/null +++ b/specification/azurearcdata/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: "@azure/arm-azurearcdata" + output-folder: "$(typescript-sdks-folder)/sdk/azurearcdata/arm-azurearcdata" + clear-output-folder: true + generate-metadata: true +``` diff --git a/specification/azurestack/resource-manager/Microsoft.AzureStack/preview/2020-06-01-preview/Registration.json b/specification/azurestack/resource-manager/Microsoft.AzureStack/preview/2020-06-01-preview/Registration.json index 81bd4d72a687..4c8bed535693 100644 --- a/specification/azurestack/resource-manager/Microsoft.AzureStack/preview/2020-06-01-preview/Registration.json +++ b/specification/azurestack/resource-manager/Microsoft.AzureStack/preview/2020-06-01-preview/Registration.json @@ -57,6 +57,45 @@ } } }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStack/registrations": { + "get": { + "x-ms-examples": { + "Returns a list of all registrations under current subscription.": { + "$ref": "examples/Registration/ListBySubscription.json" + } + }, + "tags": [ + "Registrations" + ], + "description": "Returns a list of all registrations under current subscription.", + "operationId": "Registrations_ListBySubscription", + "parameters": [ + { + "$ref": "AzureStack.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "AzureStack.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RegistrationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "AzureStack.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}": { "get": { "x-ms-examples": { diff --git a/specification/azurestack/resource-manager/Microsoft.AzureStack/preview/2020-06-01-preview/examples/Registration/ListBySubscription.json b/specification/azurestack/resource-manager/Microsoft.AzureStack/preview/2020-06-01-preview/examples/Registration/ListBySubscription.json new file mode 100644 index 000000000000..31cbdf475a66 --- /dev/null +++ b/specification/azurestack/resource-manager/Microsoft.AzureStack/preview/2020-06-01-preview/examples/Registration/ListBySubscription.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "dd8597b4-8739-4467-8b10-f8679f62bfbf", + "api-version": "2020-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/dd8597b4-8739-4467-8b10-f8679f62bfbf/resourceGroups/azurestack/providers/Microsoft.AzureStack/registrations/testregistration", + "name": "testregistration", + "type": "Microsoft.AzureStack/registrations", + "location": "global", + "etag": "0d00527e-0000-0000-0000-5a81ebdf0000", + "properties": { + "objectId": "9e9704ab-561a-4498-ac60-64b2314456ee", + "billingModel": "Development" + } + } + ] + } + } + } +} diff --git a/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2016-01-01/Registration.json b/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2016-01-01/Registration.json index 355796065ed9..8be68c13c109 100644 --- a/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2016-01-01/Registration.json +++ b/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2016-01-01/Registration.json @@ -57,6 +57,45 @@ } } }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStack/registrations": { + "get": { + "x-ms-examples": { + "Returns a list of all registrations under current subscription.": { + "$ref": "examples/Registration/ListBySubscription.json" + } + }, + "tags": [ + "Registrations" + ], + "description": "Returns a list of all registrations under current subscription.", + "operationId": "Registrations_ListBySubscription", + "parameters": [ + { + "$ref": "AzureStack.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "AzureStack.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RegistrationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}": { "get": { "x-ms-examples": { diff --git a/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2016-01-01/examples/Registration/ListBySubscription.json b/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2016-01-01/examples/Registration/ListBySubscription.json new file mode 100644 index 000000000000..ba856fdadce2 --- /dev/null +++ b/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2016-01-01/examples/Registration/ListBySubscription.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "dd8597b4-8739-4467-8b10-f8679f62bfbf", + "api-version": "2016-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/dd8597b4-8739-4467-8b10-f8679f62bfbf/resourceGroups/azurestack/providers/Microsoft.AzureStack/registrations/testregistration", + "name": "testregistration", + "type": "Microsoft.AzureStack/registrations", + "location": "global", + "etag": "0d00527e-0000-0000-0000-5a81ebdf0000", + "properties": { + "objectId": "9e9704ab-561a-4498-ac60-64b2314456ee", + "billingModel": "Development" + } + } + ] + } + } + } +} diff --git a/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/Registration.json b/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/Registration.json index c2e067d946e9..98e9c47a4d91 100644 --- a/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/Registration.json +++ b/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/Registration.json @@ -57,6 +57,45 @@ } } }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStack/registrations": { + "get": { + "x-ms-examples": { + "Returns a list of all registrations under current subscription.": { + "$ref": "examples/Registration/ListBySubscription.json" + } + }, + "tags": [ + "Registrations" + ], + "description": "Returns a list of all registrations under current subscription.", + "operationId": "Registrations_ListBySubscription", + "parameters": [ + { + "$ref": "AzureStack.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "AzureStack.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RegistrationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "AzureStack.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}": { "get": { "x-ms-examples": { diff --git a/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/examples/Registration/ListBySubscription.json b/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/examples/Registration/ListBySubscription.json new file mode 100644 index 000000000000..3931cc0f0b72 --- /dev/null +++ b/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/examples/Registration/ListBySubscription.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "dd8597b4-8739-4467-8b10-f8679f62bfbf", + "api-version": "2017-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/dd8597b4-8739-4467-8b10-f8679f62bfbf/resourceGroups/azurestack/providers/Microsoft.AzureStack/registrations/testregistration", + "name": "testregistration", + "type": "Microsoft.AzureStack/registrations", + "location": "global", + "etag": "0d00527e-0000-0000-0000-5a81ebdf0000", + "properties": { + "objectId": "9e9704ab-561a-4498-ac60-64b2314456ee", + "billingModel": "Development" + } + } + ] + } + } + } +} diff --git a/specification/azurestack/resource-manager/readme.md b/specification/azurestack/resource-manager/readme.md index 1a330200bcbd..1ff4b827e59a 100644 --- a/specification/azurestack/resource-manager/readme.md +++ b/specification/azurestack/resource-manager/readme.md @@ -96,7 +96,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/azurestack/resource-manager/readme.python.md b/specification/azurestack/resource-manager/readme.python.md index 9a4e4bef6073..743c17a3b419 100644 --- a/specification/azurestack/resource-manager/readme.python.md +++ b/specification/azurestack/resource-manager/readme.python.md @@ -4,37 +4,15 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.azurestack - package-name: azure-mgmt-azurestack - package-version: 0.1.0 - clear-output-folder: true -``` ``` yaml $(python) && $(track2) -python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.azurestack package-name: azure-mgmt-azurestack -package-version: 0.1.0 +package-version: 1.0.0b1 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azurestack/azure-mgmt-azurestack/azure/mgmt/azurestack -``` -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azurestack/azure-mgmt-azurestack -``` ``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/azurestack/azure-mgmt-azurestack/azure/mgmt/azurestack diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/arcSettings.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/arcSettings.json new file mode 100644 index 000000000000..6b01d85d5b2b --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/arcSettings.json @@ -0,0 +1,379 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-01-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/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": "OK", + "schema": { + "$ref": "#/definitions/ArcSettingList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/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/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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/v2/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/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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/v2/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/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create ArcSetting": { + "$ref": "./examples/PutArcSetting.json" + } + } + }, + "delete": { + "operationId": "ArcSettings_Delete", + "description": "Delete ArcSetting resource details of HCI Cluster.", + "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/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "OK" + }, + "204": { + "description": "No content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Delete ArcSetting": { + "$ref": "./examples/DeleteArcSetting.json" + } + } + } + } + }, + "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 + } + } + }, + "ArcSetting": { + "description": "ArcSetting details.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "systemData": { + "description": "System data of ArcSetting resource", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "x-ms-client-flatten": true, + "readOnly": true + }, + "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": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning" + ], + "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", + "readOnly": true + }, + "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" + ], + "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 + } + } + }, + "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 + }, + "state": { + "description": "State of Arc agent in this node.", + "type": "string", + "enum": [ + "NotSpecified", + "Error", + "Succeeded", + "Canceled", + "Failed", + "Connected", + "Disconnected", + "Deleted", + "Creating", + "Updating", + "Deleting", + "Moving" + ], + "x-ms-enum": { + "name": "NodeArcState", + "modelAsString": true + }, + "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/2021-01-01-preview/clusters.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/clusters.json new file mode 100644 index 000000000000..bcfe0418f8e6 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/clusters.json @@ -0,0 +1,557 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-01-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/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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/v2/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/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": "OK", + "schema": { + "$ref": "#/definitions/ClusterList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.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/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": "OK", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/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/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": "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/v2/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/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": "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/v2/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/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": "OK" + }, + "204": { + "description": "No content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "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/v2/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "systemData": { + "description": "System data of Cluster resource", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "x-ms-client-flatten": true, + "readOnly": 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" + } + }, + "properties": { + "description": "Cluster properties.", + "$ref": "#/definitions/ClusterPatchProperties", + "x-ms-client-flatten": true + } + } + }, + "ClusterProperties": { + "description": "Cluster properties.", + "type": "object", + "required": [ + "aadClientId", + "aadTenantId" + ], + "properties": { + "provisioningState": { + "description": "Provisioning state.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "status": { + "description": "Status of the cluster agent.", + "type": "string", + "enum": [ + "NotYetRegistered", + "ConnectedRecently", + "NotConnectedRecently", + "Disconnected", + "Error" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true + }, + "readOnly": true + }, + "cloudId": { + "description": "Unique, immutable resource id.", + "type": "string", + "readOnly": true + }, + "cloudManagementEndpoint": { + "type": "string", + "description": "Endpoint configured for management from the Azure portal" + }, + "aadClientId": { + "description": "App id of cluster AAD identity.", + "type": "string" + }, + "aadTenantId": { + "description": "Tenant id of cluster AAD identity.", + "type": "string" + }, + "reportedProperties": { + "description": "Properties reported by cluster agent.", + "$ref": "#/definitions/ClusterReportedProperties", + "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 + } + } + }, + "ClusterPatchProperties": { + "description": "Cluster properties.", + "type": "object", + "properties": { + "cloudManagementEndpoint": { + "type": "string", + "description": "Endpoint configured for management from the Azure portal" + } + } + }, + "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 + } + } + }, + "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 + }, + "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 + }, + "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 + } + } + } + }, + "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/2021-01-01-preview/examples/CreateCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/CreateCluster.json new file mode 100644 index 000000000000..edb831c4487c --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/CreateCluster.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2021-01-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" + } + } + }, + "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": "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", + "reportedProperties": {}, + "trialDaysRemaining": 30, + "billingModel": "Trial" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/DeleteArcSetting.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/DeleteArcSetting.json new file mode 100644 index 000000000000..33dea5921c34 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/DeleteArcSetting.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2021-01-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/DeleteCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/DeleteCluster.json new file mode 100644 index 000000000000..38424d9081e8 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/DeleteCluster.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2021-01-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/DeleteExtension.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/DeleteExtension.json new file mode 100644 index 000000000000..c8e6f345ed2c --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/DeleteExtension.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "extensionName": "MicrosoftMonitoringAgent", + "api-version": "2021-01-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/GetArcSetting.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/GetArcSetting.json new file mode 100644 index 000000000000..9e69a057c1a4 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/GetArcSetting.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2021-01-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/machine/Node-1", + "state": "Connected" + }, + { + "name": "Node-2", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machine/Node-2", + "state": "Disconnected" + } + ] + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/GetCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/GetCluster.json new file mode 100644 index 000000000000..693b2636ba04 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/GetCluster.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2021-01-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", + "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", + "reportedProperties": { + "clusterName": "cluster1", + "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425", + "clusterVersion": "10.0.17777", + "nodes": [ + { + "name": "Node1", + "id": 1, + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q45CZC3", + "coreCount": 8, + "memoryInGiB": 128 + }, + { + "name": "Node2", + "id": 2, + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44BSC3", + "coreCount": 8, + "memoryInGiB": 128 + }, + { + "name": "Node3", + "id": 3, + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44RFC3", + "coreCount": 16, + "memoryInGiB": 256 + } + ], + "lastUpdated": "2020-03-11T19:24:42.1946017Z" + }, + "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/2021-01-01-preview/examples/GetExtension.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/GetExtension.json new file mode 100644 index 000000000000..56d8fe6308dc --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/GetExtension.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "extensionName": "MicrosoftMonitoringAgent", + "api-version": "2021-01-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, + "settings": { + "workspaceId": "xx" + } + }, + "aggregateState": "PartiallySucceeded", + "perNodeExtensionDetails": [ + { + "name": "Node-1", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machine/Node-1/Extensions/MicrosoftMonitoringAgent", + "state": "Succeeded" + }, + { + "name": "Node-2", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machine/Node-2/Extensions/MicrosoftMonitoringAgent", + "state": "Failed" + } + ] + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/ListArcSettingsByCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/ListArcSettingsByCluster.json new file mode 100644 index 000000000000..f16546b83095 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/ListArcSettingsByCluster.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2021-01-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/machine/Node-1", + "state": "Connected" + }, + { + "name": "Node-2", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machine/Node-2", + "state": "Disconnected" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/ListClustersByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/ListClustersByResourceGroup.json new file mode 100644 index 000000000000..c0c5fc6ac4c6 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/ListClustersByResourceGroup.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "api-version": "2021-01-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", + "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", + "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", + "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", + "reportedProperties": { + "clusterName": "cluster1", + "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425", + "clusterVersion": "10.0.17777", + "nodes": [ + { + "name": "Node1", + "id": 0, + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q45CZC3", + "coreCount": 8, + "memoryInGiB": 128 + }, + { + "name": "Node2", + "id": 1, + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44BSC3", + "coreCount": 8, + "memoryInGiB": 128 + }, + { + "name": "Node3", + "id": 2, + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44RFC3", + "coreCount": 16, + "memoryInGiB": 256 + } + ], + "lastUpdated": "2020-03-11T19:24:42.1946017Z" + }, + "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/2021-01-01-preview/examples/ListClustersBySubscription.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/ListClustersBySubscription.json new file mode 100644 index 000000000000..de736bc9c1de --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/ListClustersBySubscription.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "api-version": "2021-01-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", + "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", + "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", + "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", + "reportedProperties": { + "clusterName": "cluster1", + "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425", + "clusterVersion": "10.0.17777", + "nodes": [ + { + "name": "Node1", + "id": 0, + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q45CZC3", + "coreCount": 8, + "memoryInGiB": 128 + }, + { + "name": "Node2", + "id": 1, + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44BSC3", + "coreCount": 8, + "memoryInGiB": 128 + }, + { + "name": "Node3", + "id": 2, + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44RFC3", + "coreCount": 16, + "memoryInGiB": 256 + } + ], + "lastUpdated": "2020-03-11T19:24:42.1946017Z" + }, + "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/2021-01-01-preview/examples/ListExtensionsByArcSetting.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/ListExtensionsByArcSetting.json new file mode 100644 index 000000000000..d648cc7d3c22 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/ListExtensionsByArcSetting.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2021-01-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/machine/Node-1/Extensions/MicrosoftMonitoringAgent", + "state": "Connected" + }, + { + "name": "Node-2", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machine/Node-2/Extensions/MicrosoftMonitoringAgent", + "state": "Disconnected" + } + ] + } + }, + { + "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/machine/Node-1/Extensions/SecurityExtension", + "state": "Succeeded" + }, + { + "name": "Node-2", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machine/Node-2/Extensions/SecurityExtension", + "state": "Failed" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/PatchExtension.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/PatchExtension.json new file mode 100644 index 000000000000..659e0f8271cf --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/PatchExtension.json @@ -0,0 +1,64 @@ +{ + "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", + "settings": { + "workspaceId": "xx" + } + } + } + }, + "api-version": "2021-01-01-preview" + }, + "responses": { + "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", + "autoUpgradeMinorVersion": false, + "settings": { + "workspaceId": "xx" + } + }, + "aggregateState": "PartiallyConnected", + "perNodeExtensionDetails": [ + { + "name": "Node-1", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machine/Node-1/Extensions/MicrosoftMonitoringAgent", + "state": "Connected" + }, + { + "name": "Node-2", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machine/Node-2/Extensions/MicrosoftMonitoringAgent", + "state": "Disconnected" + } + ] + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/PutArcSetting.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/PutArcSetting.json new file mode 100644 index 000000000000..0da113834792 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/PutArcSetting.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "arcSetting": {}, + "api-version": "2021-01-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/machine/Node-1", + "state": "Creating" + }, + { + "name": "Node-2", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machine/Node-2", + "state": "Creating" + } + ] + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/PutExtension.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/PutExtension.json new file mode 100644 index 000000000000..10c96ddf224e --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/PutExtension.json @@ -0,0 +1,107 @@ +{ + "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", + "settings": { + "workspaceId": "xx" + }, + "protectedSettings": { + "workspaceKey": "xx" + } + } + } + }, + "api-version": "2021-01-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, + "settings": { + "workspaceId": "xx" + } + }, + "aggregateState": "PartiallySucceeded", + "perNodeExtensionDetails": [ + { + "name": "Node-1", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machine/Node-1/Extensions/MicrosoftMonitoringAgent", + "state": "Succeeded" + }, + { + "name": "Node-2", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machine/Node-2/Extensions/MicrosoftMonitoringAgent", + "state": "Failed" + } + ] + } + } + }, + "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", + "autoUpgradeMinorVersion": false, + "settings": { + "workspaceId": "xx" + } + }, + "aggregateState": "PartiallySucceeded", + "perNodeExtensionDetails": [ + { + "name": "Node-1", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machine/Node-1/Extensions/MicrosoftMonitoringAgent", + "state": "Succeeded" + }, + { + "name": "Node-2", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machine/Node-2/Extensions/MicrosoftMonitoringAgent", + "state": "Failed" + } + ] + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/UpdateCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/UpdateCluster.json new file mode 100644 index 000000000000..4a4a6d11f3dd --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/examples/UpdateCluster.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2021-01-01-preview", + "cluster": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "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": { + "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", + "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", + "reportedProperties": { + "clusterName": "cluster1", + "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425", + "clusterVersion": "10.0.17777", + "nodes": [ + { + "name": "Node1", + "id": 1, + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q45CZC3", + "coreCount": 8, + "memoryInGiB": 128 + }, + { + "name": "Node2", + "id": 2, + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44BSC3", + "coreCount": 8, + "memoryInGiB": 128 + }, + { + "name": "Node3", + "id": 3, + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44RFC3", + "coreCount": 16, + "memoryInGiB": 256 + } + ], + "lastUpdated": "2020-03-11T19:24:42.1946017Z" + }, + "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/2021-01-01-preview/extensions.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/extensions.json new file mode 100644 index 000000000000..6140987c9459 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/extensions.json @@ -0,0 +1,500 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-01-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/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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/v2/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/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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/v2/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/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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/v2/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/v2/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/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Extension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "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/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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/v2/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" + } + } + } + } + }, + "definitions": { + "Extension": { + "description": "Details of a particular extension in HCI Cluster.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "systemData": { + "description": "System data of Extension resource.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "x-ms-client-flatten": true, + "readOnly": true + }, + "properties": { + "description": "Describes Machine Extension Properties.", + "$ref": "#/definitions/ExtensionProperties", + "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": [ + "Succeeded", + "Failed", + "Canceled", + "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" + ], + "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 + } + } + }, + "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 + }, + "state": { + "description": "State of Arc Extension in this node.", + "type": "string", + "enum": [ + "NotSpecified", + "Error", + "Succeeded", + "Canceled", + "Failed", + "Connected", + "Disconnected", + "Deleted", + "Creating", + "Updating", + "Deleting", + "Moving" + ], + "x-ms-enum": { + "name": "NodeExtensionState", + "modelAsString": true + }, + "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." + }, + "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 + } + } + } + }, + "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/2021-01-01-preview/operations.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/operations.json new file mode 100644 index 000000000000..d1c136c85e5a --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2021-01-01-preview/operations.json @@ -0,0 +1,68 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-01-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", + "description": "List all available Microsoft.AzureStackHCI provider operations", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/azurestackhci/resource-manager/readme.go.md b/specification/azurestackhci/resource-manager/readme.go.md index a7f05b7c4929..0b8a319c2c4b 100644 --- a/specification/azurestackhci/resource-manager/readme.go.md +++ b/specification/azurestackhci/resource-manager/readme.go.md @@ -12,10 +12,21 @@ go: ```yaml $(go) && $(multiapi) batch: + - tag: package-preview-2021-01 - tag: package-2020-10 - tag: package-2020-03-01-preview ``` +### Tag: package-preview-2021-01 and go + +These settings apply only when `--tag=package-preview-2021-01 --go` is specified on the command line. +Please also specify `--go-sdks-folder=`. + +```yaml $(tag) == 'package-preview-2021-01' && $(go) +namespace: azurestackhci +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2021-01-01-preview/$(namespace) +``` + ### Tag: package-2020-10 and go These settings apply only when `--tag=package-2020-10 --go` is specified on the command line. diff --git a/specification/azurestackhci/resource-manager/readme.md b/specification/azurestackhci/resource-manager/readme.md index db260de2b2ec..1ccf280a1ac3 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-2020-10 +tag: package-preview-2021-01 ``` ## Suppression @@ -37,19 +37,35 @@ tag: package-2020-10 ``` yaml directive: - suppress: R3020 - from: azurestackhci.json + from: + - arcSettings.json + - clusters.json + - extensions.json + - operations.json reason: Microsoft.AzureStackHCI is the correct name for our RP. ``` +### Tag: package-preview-2021-01 + +These settings apply only when `--tag=package-preview-2021-01` is specified on the command line. + +```yaml $(tag) == 'package-preview-2021-01' +input-file: + - Microsoft.AzureStackHCI/preview/2021-01-01-preview/arcSettings.json + - Microsoft.AzureStackHCI/preview/2021-01-01-preview/clusters.json + - Microsoft.AzureStackHCI/preview/2021-01-01-preview/extensions.json + - Microsoft.AzureStackHCI/preview/2021-01-01-preview/operations.json +``` ### Tag: package-2020-10 These settings apply only when `--tag=package-2020-10` is specified on the command line. -```yaml $(tag) == 'package-2020-10' +``` yaml $(tag) == 'package-2020-10' input-file: - Microsoft.AzureStackHCI/stable/2020-10-01/azurestackhci.json ``` + ### Tag: package-2020-03-01-preview These settings apply only when `--tag=package-2020-03-01-preview` is specified on the command line. @@ -103,5 +119,3 @@ See configuration in [readme.typescript.md](./readme.typescript.md) ## CSharp See configuration in [readme.csharp.md](./readme.csharp.md) - - diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/baremetalinfrastructure.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/baremetalinfrastructure.json index 7e70ac58553f..a49b2e8ca22b 100644 --- a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/baremetalinfrastructure.json +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/baremetalinfrastructure.json @@ -720,6 +720,7 @@ "description": "Displayed AzureBareMetal operation information" }, "isDataAction": { + "readOnly": true, "description": "indicates whether an operation is a data action or not.", "type": "boolean" } diff --git a/specification/baremetalinfrastructure/resource-manager/readme.go.md b/specification/baremetalinfrastructure/resource-manager/readme.go.md index 3944151a092b..0f7be40125be 100644 --- a/specification/baremetalinfrastructure/resource-manager/readme.go.md +++ b/specification/baremetalinfrastructure/resource-manager/readme.go.md @@ -5,9 +5,17 @@ These settings apply only when `--go` is specified on the command line. ```yaml $(go) go: license-header: MICROSOFT_MIT_NO_VERSION + namespace: baremetalinfrastructure clear-output-folder: true ``` +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2020-08-06-preview +``` + ### Tag: package-2020-08-06-preview and go These settings apply only when `--tag=package-2020-08-06-preview --go` is specified on the command line. diff --git a/specification/baremetalinfrastructure/resource-manager/readme.md b/specification/baremetalinfrastructure/resource-manager/readme.md index a56160acb966..3812cf3b6901 100644 --- a/specification/baremetalinfrastructure/resource-manager/readme.md +++ b/specification/baremetalinfrastructure/resource-manager/readme.md @@ -49,7 +49,6 @@ This is not used by Autorest itself. ```yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/baremetalinfrastructure/resource-manager/readme.python.md b/specification/baremetalinfrastructure/resource-manager/readme.python.md index 3048a78804d7..005b88759d16 100644 --- a/specification/baremetalinfrastructure/resource-manager/readme.python.md +++ b/specification/baremetalinfrastructure/resource-manager/readme.python.md @@ -4,18 +4,6 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use --python-mode=update if you already have a setup.py and just want to update the code itself. -```yaml !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.baremetalinfrastructure - package-name: azure-mgmt-baremetalinfrastructure - package-version: 0.1.0 - clear-output-folder: true -``` - These settings apply only when `--track2` is specified on the command line. ``` yaml $(track2) @@ -23,21 +11,16 @@ azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-baremetalinfrastructure no-namespace-folders: true -package-version: 0.1.0 +package-version: 1.0.0b1 +clear-output-folder: true ``` -``` yaml $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/baremetalinfrastructure/azure-mgmt-baremetalinfrastructure/azure/mgmt/baremetalinfrastructure +``` yaml $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/baremetalinfrastructure/azure-mgmt-baremetalinfrastructure/azure/mgmt/baremetalinfrastructure ``` -``` yaml $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/baremetalinfrastructure/azure-mgmt-baremetalinfrastructure +``` yaml $(python-mode) == 'create' && $(track2) basic-setup-py: true output-folder: $(python-sdks-folder)/baremetalinfrastructure/azure-mgmt-baremetalinfrastructure ``` \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/BatchService.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/BatchService.json new file mode 100644 index 000000000000..5904e0cb0119 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/BatchService.json @@ -0,0 +1,17532 @@ +{ + "swagger": "2.0", + "info": { + "title": "BatchServiceClient", + "version": "2021-06-01.14.0", + "description": "A client for issuing REST requests to the Azure Batch service." + }, + "x-ms-parameterized-host": { + "hostTemplate": "{batchUrl}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/batchUrl" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json; odata=minimalmetadata" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + }, + { + "api_key": [] + } + ], + "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" + } + }, + "api_key": { + "type": "apiKey", + "name": "Authorization", + "in": "header" + } + }, + "paths": { + "/applications": { + "get": { + "tags": [ + "Applications" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "Application_List", + "x-ms-examples": { + "List applications": { + "$ref": "./examples/ApplicationList.json" + } + }, + "summary": "Lists all of the applications available in the specified Account.", + "description": "This operation returns only Applications and versions that are available for use on Compute Nodes; that is, that can be used in an Package reference. For administrator information about applications and versions that are not yet available to Compute Nodes, use the Azure portal or the Azure Resource Manager API.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 applications can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of applications.", + "schema": { + "$ref": "#/definitions/ApplicationListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/applications/{applicationId}": { + "get": { + "tags": [ + "Applications" + ], + "operationId": "Application_Get", + "x-ms-examples": { + "Get applications": { + "$ref": "./examples/ApplicationGet.json" + } + }, + "summary": "Gets information about the specified Application.", + "description": "This operation returns only Applications and versions that are available for use on Compute Nodes; that is, that can be used in an Package reference. For administrator information about Applications and versions that are not yet available to Compute Nodes, use the Azure portal or the Azure Resource Manager API.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Application." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the application.", + "schema": { + "$ref": "#/definitions/ApplicationSummary" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/poolusagemetrics": { + "get": { + "tags": [ + "Pools" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "Pool_ListUsageMetrics", + "x-ms-examples": { + "Pool list usage metrics": { + "$ref": "./examples/PoolListUsageMetrics.json" + } + }, + "summary": "Lists the usage metrics, aggregated by Pool across individual time intervals, for the specified Account.", + "description": "If you do not specify a $filter clause including a poolId, the response includes all Pools that existed in the Account in the time range of the returned aggregation intervals. If you do not specify a $filter clause including a startTime or endTime these filters default to the start and end times of the last aggregation interval currently available; that is, only the last aggregation interval is returned.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "starttime", + "x-ms-client-name": "startTime", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "The earliest time from which to include metrics. This must be at least two and a half hours before the current time. If not specified this defaults to the start time of the last aggregation interval currently available.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "endtime", + "x-ms-client-name": "endTime", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "The latest time from which to include metrics. This must be at least two hours before the current time. If not specified this defaults to the end time of the last aggregation interval currently available.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 results will be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of Pool usage details.", + "schema": { + "$ref": "#/definitions/PoolListUsageMetricsResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/supportedimages": { + "get": { + "tags": [ + "Accounts" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "Account_ListSupportedImages", + "x-ms-examples": { + "Account list node agent skus": { + "$ref": "./examples/AccountListSupportedImages.json" + } + }, + "summary": "Lists all Virtual Machine Images supported by the Azure Batch service.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-support-images.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 results will be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of supported Virtual Machine Images.", + "schema": { + "$ref": "#/definitions/AccountListSupportedImagesResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/nodecounts": { + "get": { + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "tags": [ + "Accounts" + ], + "operationId": "Account_ListPoolNodeCounts", + "description": "Gets the number of Compute Nodes in each state, grouped by Pool. Note that the numbers returned may not always be up to date. If you need exact node counts, use a list query.", + "x-ms-examples": { + "NodeCountsPayload": { + "$ref": "./examples/AccountListPoolNodeCounts.json" + } + }, + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 10, + "minimum": 1, + "maximum": 10, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + } + }, + "description": "The response contains the number of Compute Nodes in each Compute Node state, grouped by Pool.", + "schema": { + "$ref": "#/definitions/PoolNodeCountsListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/lifetimepoolstats": { + "get": { + "tags": [ + "Pools" + ], + "operationId": "Pool_GetAllLifetimeStatistics", + "x-ms-examples": { + "Pool get lifetime statistics": { + "$ref": "./examples/PoolGetLifetimeStatistics.json" + } + }, + "summary": "Gets lifetime summary statistics for all of the Pools in the specified Account.", + "description": "Statistics are aggregated across all Pools that have ever existed in the Account, from Account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the Pool statistics for the lifetime of the Batch Account.", + "schema": { + "$ref": "#/definitions/PoolStatistics" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/lifetimejobstats": { + "get": { + "tags": [ + "Jobs" + ], + "operationId": "Job_GetAllLifetimeStatistics", + "x-ms-examples": { + "Job get lifetime statistics": { + "$ref": "./examples/JobGetLifetimeStatistics.json" + } + }, + "summary": "Gets lifetime summary statistics for all of the Jobs in the specified Account.", + "description": "Statistics are aggregated across all Jobs that have ever existed in the Account, from Account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the Job statistics for the lifetime of the Batch Account.", + "schema": { + "$ref": "#/definitions/JobStatistics" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/certificates": { + "post": { + "tags": [ + "Certificates" + ], + "operationId": "Certificate_Add", + "x-ms-examples": { + "Certificate add": { + "$ref": "./examples/CertificateAdd.json" + } + }, + "summary": "Adds a Certificate to the specified Account.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "certificate", + "in": "body", + "description": "The Certificate to be added.", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateAddParameter" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "Certificates" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "Certificate_List", + "x-ms-examples": { + "Certificate list": { + "$ref": "./examples/CertificateList.json" + } + }, + "summary": "Lists all of the Certificates that have been added to the specified Account.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-certificates.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 Certificates can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of Certificates.", + "schema": { + "$ref": "#/definitions/CertificateListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})/canceldelete": { + "post": { + "tags": [ + "Certificates" + ], + "operationId": "Certificate_CancelDeletion", + "x-ms-examples": { + "Certificate cancel delete": { + "$ref": "./examples/CertificateCancelDelete.json" + } + }, + "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.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "thumbprintAlgorithm", + "in": "path", + "required": true, + "type": "string", + "description": "The algorithm used to derive the thumbprint parameter. This must be sha1." + }, + { + "name": "thumbprint", + "in": "path", + "required": true, + "type": "string", + "description": "The thumbprint of the Certificate being deleted." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})": { + "delete": { + "tags": [ + "Certificates" + ], + "operationId": "Certificate_Delete", + "x-ms-examples": { + "Certificate delete": { + "$ref": "./examples/CertificateDelete.json" + } + }, + "summary": "Deletes a Certificate from the specified Account.", + "description": "You cannot delete a Certificate if a resource (Pool or Compute Node) is using it. Before you can delete a Certificate, you must therefore make sure that the Certificate is not associated with any existing Pools, the Certificate is not installed on any Nodes (even if you remove a Certificate from a Pool, it is not removed from existing Compute Nodes in that Pool until they restart), and no running Tasks depend on the Certificate. If you try to delete a Certificate that is in use, the deletion fails. The Certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the Certificate.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "thumbprintAlgorithm", + "in": "path", + "required": true, + "type": "string", + "description": "The algorithm used to derive the thumbprint parameter. This must be sha1." + }, + { + "name": "thumbprint", + "in": "path", + "required": true, + "type": "string", + "description": "The thumbprint of the Certificate to be deleted." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "Certificates" + ], + "operationId": "Certificate_Get", + "x-ms-examples": { + "Certificate get": { + "$ref": "./examples/CertificateGet.json" + } + }, + "description": "Gets information about the specified Certificate.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "thumbprintAlgorithm", + "in": "path", + "required": true, + "type": "string", + "description": "The algorithm used to derive the thumbprint parameter. This must be sha1." + }, + { + "name": "thumbprint", + "in": "path", + "required": true, + "type": "string", + "description": "The thumbprint of the Certificate to get." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the Certificate.", + "schema": { + "$ref": "#/definitions/Certificate" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/tasks/{taskId}/files/{filePath}": { + "delete": { + "tags": [ + "Files" + ], + "operationId": "File_DeleteFromTask", + "x-ms-examples": { + "File delete from task": { + "$ref": "./examples/FileDeleteFromTask.json" + } + }, + "summary": "Deletes the specified Task file from the Compute Node where the Task ran.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job that contains the Task." + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Task whose file you want to delete." + }, + { + "name": "filePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the Task file or directory that you want to delete." + }, + { + "name": "recursive", + "in": "query", + "required": false, + "type": "boolean", + "description": "Whether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can set recursive to true to delete the directory and all of the files and subdirectories in it. If recursive is false then the directory must be empty or deletion will fail." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "Files" + ], + "operationId": "File_GetFromTask", + "x-ms-examples": { + "Get File From Task": { + "$ref": "./examples/FileGetFromTask.json" + } + }, + "description": "Returns the content of the specified Task file.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job that contains the Task." + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Task whose file you want to retrieve." + }, + { + "name": "filePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the Task file that you want to get the content of." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-range", + "in": "header", + "required": false, + "type": "string", + "description": "The byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "produces": [ + "application/json", + "application/octet-stream" + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ocp-creation-time": { + "description": "The file creation time.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ocp-batch-file-isdirectory": { + "description": "Whether the object represents a directory.", + "type": "boolean" + }, + "ocp-batch-file-url": { + "description": "The URL of the file.", + "type": "string" + }, + "ocp-batch-file-mode": { + "description": "The file mode attribute in octal format.", + "type": "string" + }, + "Content-Type": { + "description": "The content type of the file.", + "type": "string" + }, + "Content-Length": { + "description": "The length of the file.", + "type": "integer", + "format": "int64" + } + }, + "description": "A response containing the file content.", + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "head": { + "tags": [ + "Files" + ], + "operationId": "File_GetPropertiesFromTask", + "x-ms-examples": { + "File get properties from task": { + "$ref": "./examples/FileGetPropertiesFromTask.json" + } + }, + "description": "Gets the properties of the specified Task file.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job that contains the Task." + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Task whose file you want to get the properties of." + }, + { + "name": "filePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the Task file that you want to get the properties of." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ocp-creation-time": { + "description": "The file creation time.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ocp-batch-file-isdirectory": { + "description": "Whether the object represents a directory.", + "type": "boolean" + }, + "ocp-batch-file-url": { + "description": "The URL of the file.", + "type": "string" + }, + "ocp-batch-file-mode": { + "description": "The file mode attribute in octal format.", + "type": "string" + }, + "Content-Type": { + "description": "The content type of the file.", + "type": "string" + }, + "Content-Length": { + "description": "The length of the file.", + "type": "integer", + "format": "int64" + } + }, + "description": "A response containing the file properties." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/files/{filePath}": { + "delete": { + "tags": [ + "Files" + ], + "operationId": "File_DeleteFromComputeNode", + "x-ms-examples": { + "File delete from node": { + "$ref": "./examples/FileDeleteFromNode.json" + } + }, + "summary": "Deletes the specified file from the Compute Node.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Compute Node from which you want to delete the file." + }, + { + "name": "filePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the file or directory that you want to delete." + }, + { + "name": "recursive", + "in": "query", + "required": false, + "type": "boolean", + "description": "Whether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can set recursive to true to delete the directory and all of the files and subdirectories in it. If recursive is false then the directory must be empty or deletion will fail." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "Files" + ], + "operationId": "File_GetFromComputeNode", + "x-ms-examples": { + "Get File From Compute Node": { + "$ref": "./examples/FileGetFromNode.json" + } + }, + "description": "Returns the content of the specified Compute Node file.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Compute Node that contains the file." + }, + { + "name": "filePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the Compute Node file that you want to get the content of." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-range", + "in": "header", + "required": false, + "type": "string", + "description": "The byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "produces": [ + "application/json", + "application/octet-stream" + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ocp-creation-time": { + "description": "The file creation time.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ocp-batch-file-isdirectory": { + "description": "Whether the object represents a directory.", + "type": "boolean" + }, + "ocp-batch-file-url": { + "description": "The URL of the file.", + "type": "string" + }, + "ocp-batch-file-mode": { + "description": "The file mode attribute in octal format.", + "type": "string" + }, + "Content-Type": { + "description": "The content type of the file.", + "type": "string" + }, + "Content-Length": { + "description": "The length of the file.", + "type": "integer", + "format": "int64" + } + }, + "description": "The file content.", + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "head": { + "tags": [ + "Files" + ], + "operationId": "File_GetPropertiesFromComputeNode", + "x-ms-examples": { + "File get properties from node": { + "$ref": "./examples/FileGetPropertiesFromNode.json" + } + }, + "description": "Gets the properties of the specified Compute Node file.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Compute Node that contains the file." + }, + { + "name": "filePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the Compute Node file that you want to get the properties of." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ocp-creation-time": { + "description": "The file creation time.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ocp-batch-file-isdirectory": { + "description": "Whether the object represents a directory.", + "type": "boolean" + }, + "ocp-batch-file-url": { + "description": "The URL of the file.", + "type": "string" + }, + "ocp-batch-file-mode": { + "description": "The file mode attribute in octal format.", + "type": "string" + }, + "Content-Type": { + "description": "The content type of the file.", + "type": "string" + }, + "Content-Length": { + "description": "The length of the file.", + "type": "integer", + "format": "int64" + } + }, + "description": "A response containing the file properties." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/tasks/{taskId}/files": { + "get": { + "tags": [ + "Files" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "File_ListFromTask", + "x-ms-examples": { + "File list from task": { + "$ref": "./examples/FileListFromTask.json" + } + }, + "summary": "Lists the files in a Task's directory on its Compute Node.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job that contains the Task." + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Task whose files you want to list." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-task-files.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "recursive", + "in": "query", + "required": false, + "type": "boolean", + "description": "Whether to list children of the Task directory. This parameter can be used in combination with the filter parameter to list specific type of files." + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 files can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of files.", + "schema": { + "$ref": "#/definitions/NodeFileListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/files": { + "get": { + "tags": [ + "Files" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "File_ListFromComputeNode", + "x-ms-examples": { + "File list from node": { + "$ref": "./examples/FileListFromNode.json" + } + }, + "summary": "Lists all of the files in Task directories on the specified Compute Node.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Compute Node whose files you want to list." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "recursive", + "in": "query", + "required": false, + "type": "boolean", + "description": "Whether to list children of a directory." + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 files can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of files.", + "schema": { + "$ref": "#/definitions/NodeFileListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobschedules/{jobScheduleId}": { + "head": { + "tags": [ + "JobSchedules" + ], + "operationId": "JobSchedule_Exists", + "x-ms-examples": { + "Check Job Schedule Exists": { + "$ref": "./examples/JobScheduleExists.json" + } + }, + "summary": "Checks the specified Job Schedule exists.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobScheduleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job Schedule which you want to check." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing headers related to the Job Schedule, if it exists." + }, + "404": { + "description": "The Job Schedule does not exist." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "delete": { + "tags": [ + "JobSchedules" + ], + "operationId": "JobSchedule_Delete", + "x-ms-examples": { + "JobSchedule delete": { + "$ref": "./examples/JobScheduleDelete.json" + } + }, + "summary": "Deletes a Job Schedule from the specified Account.", + "description": "When you delete a Job Schedule, this also deletes all Jobs and Tasks under that schedule. When Tasks are deleted, all the files in their working directories on the Compute Nodes are also deleted (the retention period is ignored). The Job Schedule statistics are no longer accessible once the Job Schedule is deleted, though they are still counted towards Account lifetime statistics.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobScheduleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job Schedule to delete." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "JobSchedules" + ], + "operationId": "JobSchedule_Get", + "x-ms-examples": { + "JobSchedule get": { + "$ref": "./examples/JobScheduleGet.json" + } + }, + "description": "Gets information about the specified Job Schedule.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobScheduleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job Schedule to get." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $expand clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the Job Schedule.", + "schema": { + "$ref": "#/definitions/CloudJobSchedule" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "patch": { + "tags": [ + "JobSchedules" + ], + "operationId": "JobSchedule_Patch", + "x-ms-examples": { + "JobSchedule patch": { + "$ref": "./examples/JobSchedulePatch.json" + } + }, + "summary": "Updates the properties of the specified Job Schedule.", + "description": "This replaces only the Job Schedule properties specified in the request. For example, if the schedule property is not specified with this request, then the Batch service will keep the existing schedule. Changes to a Job Schedule only impact Jobs created by the schedule after the update has taken place; currently running Jobs are unaffected.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobScheduleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job Schedule to update." + }, + { + "name": "jobSchedulePatchParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobSchedulePatchParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "put": { + "tags": [ + "JobSchedules" + ], + "operationId": "JobSchedule_Update", + "x-ms-examples": { + "JobSchedule update": { + "$ref": "./examples/JobScheduleUpdate.json" + } + }, + "summary": "Updates the properties of the specified Job Schedule.", + "description": "This fully replaces all the updatable properties of the Job Schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a Job Schedule only impact Jobs created by the schedule after the update has taken place; currently running Jobs are unaffected.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobScheduleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job Schedule to update." + }, + { + "name": "jobScheduleUpdateParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobScheduleUpdateParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobschedules/{jobScheduleId}/disable": { + "post": { + "tags": [ + "JobSchedules" + ], + "operationId": "JobSchedule_Disable", + "x-ms-examples": { + "JobSchedule disable": { + "$ref": "./examples/JobScheduleDisable.json" + } + }, + "summary": "Disables a Job Schedule.", + "description": "No new Jobs will be created until the Job Schedule is enabled again.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobScheduleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job Schedule to disable." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobschedules/{jobScheduleId}/enable": { + "post": { + "tags": [ + "JobSchedules" + ], + "operationId": "JobSchedule_Enable", + "x-ms-examples": { + "JobSchedule enable": { + "$ref": "./examples/JobScheduleEnable.json" + } + }, + "summary": "Enables a Job Schedule.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobScheduleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job Schedule to enable." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobschedules/{jobScheduleId}/terminate": { + "post": { + "tags": [ + "JobSchedules" + ], + "operationId": "JobSchedule_Terminate", + "x-ms-examples": { + "JobSchedule terminate": { + "$ref": "./examples/JobScheduleTerminate.json" + } + }, + "summary": "Terminates a Job Schedule.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobScheduleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job Schedule to terminates." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobschedules": { + "post": { + "tags": [ + "JobSchedules" + ], + "operationId": "JobSchedule_Add", + "x-ms-examples": { + "Add a basic JobSchedule": { + "$ref": "./examples/JobScheduleAdd_Basic.json" + }, + "Add a complex JobScheduleAdd": { + "$ref": "./examples/JobScheduleAdd_Complex.json" + } + }, + "summary": "Adds a Job Schedule to the specified Account.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "cloudJobSchedule", + "in": "body", + "description": "The Job Schedule to be added.", + "required": true, + "schema": { + "$ref": "#/definitions/JobScheduleAddParameter" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "JobSchedules" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "JobSchedule_List", + "x-ms-examples": { + "JobSchedule list": { + "$ref": "./examples/JobScheduleList.json" + } + }, + "summary": "Lists all of the Job Schedules in the specified Account.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-schedules.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $expand clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 Job Schedules can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of Job Schedules.", + "schema": { + "$ref": "#/definitions/CloudJobScheduleListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}": { + "delete": { + "tags": [ + "Jobs" + ], + "operationId": "Job_Delete", + "x-ms-examples": { + "Delete Job": { + "$ref": "./examples/JobDelete.json" + } + }, + "summary": "Deletes a Job.", + "description": "Deleting a Job also deletes all Tasks that are part of that Job, and all Job statistics. This also overrides the retention period for Task data; that is, if the Job contains Tasks which are still retained on Compute Nodes, the Batch services deletes those Tasks' working directories and all their contents. When a Delete Job request is received, the Batch service sets the Job to the deleting state. All update operations on a Job that is in deleting state will fail with status code 409 (Conflict), with additional information indicating that the Job is being deleted.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job to delete." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "Jobs" + ], + "operationId": "Job_Get", + "x-ms-examples": { + "Job get": { + "$ref": "./examples/JobGet.json" + } + }, + "summary": "Gets information about the specified Job.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $expand clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the Job.", + "schema": { + "$ref": "#/definitions/CloudJob" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "patch": { + "tags": [ + "Jobs" + ], + "operationId": "Job_Patch", + "x-ms-examples": { + "Job patch": { + "$ref": "./examples/JobPatch.json" + } + }, + "summary": "Updates the properties of the specified Job.", + "description": "This replaces only the Job properties specified in the request. For example, if the Job has constraints, and a request does not specify the constraints element, then the Job keeps the existing constraints.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job whose properties you want to update." + }, + { + "name": "jobPatchParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobPatchParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "put": { + "tags": [ + "Jobs" + ], + "operationId": "Job_Update", + "x-ms-examples": { + "Job update": { + "$ref": "./examples/JobUpdate.json" + } + }, + "summary": "Updates the properties of the specified Job.", + "description": "This fully replaces all the updatable properties of the Job. For example, if the Job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job whose properties you want to update." + }, + { + "name": "jobUpdateParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobUpdateParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/disable": { + "post": { + "tags": [ + "Jobs" + ], + "operationId": "Job_Disable", + "x-ms-examples": { + "Job disable": { + "$ref": "./examples/JobDisable.json" + } + }, + "summary": "Disables the specified Job, preventing new Tasks from running.", + "description": "The Batch Service immediately moves the Job to the disabling state. Batch then uses the disableTasks parameter to determine what to do with the currently running Tasks of the Job. The Job remains in the disabling state until the disable operation is completed and all Tasks have been dealt with according to the disableTasks option; the Job then moves to the disabled state. No new Tasks are started under the Job until it moves back to active state. If you try to disable a Job that is in any state other than active, disabling, or disabled, the request fails with status code 409.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job to disable." + }, + { + "name": "jobDisableParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobDisableParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/enable": { + "post": { + "tags": [ + "Jobs" + ], + "operationId": "Job_Enable", + "x-ms-examples": { + "Job enable": { + "$ref": "./examples/JobEnable.json" + } + }, + "summary": "Enables the specified Job, allowing new Tasks to run.", + "description": "When you call this API, the Batch service sets a disabled Job to the enabling state. After the this operation is completed, the Job moves to the active state, and scheduling of new Tasks under the Job resumes. The Batch service does not allow a Task to remain in the active state for more than 180 days. Therefore, if you enable a Job containing active Tasks which were added more than 180 days ago, those Tasks will not run.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job to enable." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/terminate": { + "post": { + "tags": [ + "Jobs" + ], + "operationId": "Job_Terminate", + "x-ms-examples": { + "Job terminate": { + "$ref": "./examples/JobTerminate.json" + } + }, + "summary": "Terminates the specified Job, marking it as completed.", + "description": "When a Terminate Job request is received, the Batch service sets the Job to the terminating state. The Batch service then terminates any running Tasks associated with the Job and runs any required Job release Tasks. Then the Job moves into the completed state. If there are any Tasks in the Job in the active state, they will remain in the active state. Once a Job is terminated, new Tasks cannot be added and any remaining active Tasks will not be scheduled.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job to terminate." + }, + { + "name": "jobTerminateParameter", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/JobTerminateParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs": { + "post": { + "tags": [ + "Jobs" + ], + "operationId": "Job_Add", + "x-ms-examples": { + "Add a basic job": { + "$ref": "./examples/JobAdd_Basic.json" + }, + "Add a complex job": { + "$ref": "./examples/JobAdd_Complex.json" + } + }, + "summary": "Adds a Job to the specified Account.", + "description": "The Batch service supports two ways to control the work done as part of a Job. In the first approach, the user specifies a Job Manager Task. The Batch service launches this Task when it is ready to start the Job. The Job Manager Task controls all other Tasks that run under this Job, by using the Task APIs. In the second approach, the user directly controls the execution of Tasks under an active Job, by using the Task APIs. Also note: when naming Jobs, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "job", + "in": "body", + "description": "The Job to be added.", + "required": true, + "schema": { + "$ref": "#/definitions/JobAddParameter" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "Jobs" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "Job_List", + "x-ms-examples": { + "Job list": { + "$ref": "./examples/JobList.json" + } + }, + "summary": "Lists all of the Jobs in the specified Account.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $expand clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 Jobs can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of Jobs.", + "schema": { + "$ref": "#/definitions/CloudJobListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobschedules/{jobScheduleId}/jobs": { + "get": { + "tags": [ + "Jobs" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "x-ms-examples": { + "List Job Under Job Schedule": { + "$ref": "./examples/JobListFromJobSchedule.json" + } + }, + "operationId": "Job_ListFromJobSchedule", + "summary": "Lists the Jobs that have been created under the specified Job Schedule.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobScheduleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job Schedule from which you want to get a list of Jobs." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs-in-a-job-schedule.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $expand clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 Jobs can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of Jobs.", + "schema": { + "$ref": "#/definitions/CloudJobListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/jobpreparationandreleasetaskstatus": { + "get": { + "tags": [ + "Jobs" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "Job_ListPreparationAndReleaseTaskStatus", + "x-ms-examples": { + "Job list preparation and release task status": { + "$ref": "./examples/JobListPreparationAndReleaseTaskStatus.json" + } + }, + "summary": "Lists the execution status of the Job Preparation and Job Release Task for the specified Job across the Compute Nodes where the Job has run.", + "description": "This API returns the Job Preparation and Job Release Task status on all Compute Nodes that have run the Job Preparation or Job Release Task. This includes Compute Nodes which have since been removed from the Pool. If this API is invoked on a Job which has no Job Preparation or Job Release Task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 Tasks can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing a list of Job Preparation and Job Release Task statuses.", + "schema": { + "$ref": "#/definitions/CloudJobListPreparationAndReleaseTaskStatusResult" + } + }, + "default": { + "description": "The error from the Batch service. If this API is invoked on a Job which has no Job Preparation or Job Release Task, the Batch service returns HTTP status code 409.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/taskcounts": { + "get": { + "tags": [ + "Jobs" + ], + "operationId": "Job_GetTaskCounts", + "x-ms-examples": { + "Job get task counts": { + "$ref": "./examples/JobGetTaskCounts.json" + } + }, + "summary": "Gets the Task counts for the specified Job.", + "description": "Task counts provide a count of the Tasks by active, running or completed Task state, and a count of Tasks which succeeded or failed. Tasks in the preparing state are counted as running. Note that the numbers returned may not always be up to date. If you need exact task counts, use a list query.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + } + }, + "description": "A response containing the Task counts for the specified Job.", + "schema": { + "$ref": "#/definitions/TaskCountsResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools": { + "post": { + "tags": [ + "Pools" + ], + "operationId": "Pool_Add", + "x-ms-examples": { + "Add a CloudServiceConfiguration pool": { + "$ref": "./examples/PoolAdd_CloudServiceConfiguration.json" + }, + "Add a VirtualMachineConfiguration pool": { + "$ref": "./examples/PoolAdd_VirtualMachineConfiguration.json" + }, + "Add a VirtualMachineConfiguration pool with containers": { + "$ref": "./examples/PoolAdd_VirtualMachineConfigurationWithContainers.json" + }, + "Add a VirtualMachineConfiguration pool with extensions": { + "$ref": "./examples/PoolAdd_VirtualMachineConfigurationWithExtensions.json" + }, + "Add a pool with mount drive specified": { + "$ref": "./examples/PoolAdd_MountConfiguration.json" + } + }, + "summary": "Adds a Pool to the specified Account.", + "description": "When naming Pools, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "pool", + "in": "body", + "description": "The Pool to be added.", + "required": true, + "schema": { + "$ref": "#/definitions/PoolAddParameter" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "Pools" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "Pool_List", + "x-ms-examples": { + "Pool list": { + "$ref": "./examples/PoolList_Basic.json" + } + }, + "summary": "Lists all of the Pools in the specified Account.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-pools.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $expand clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 Pools can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of Pools.", + "schema": { + "$ref": "#/definitions/CloudPoolListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}": { + "delete": { + "tags": [ + "Pools" + ], + "operationId": "Pool_Delete", + "x-ms-examples": { + "Pool delete": { + "$ref": "./examples/PoolDelete.json" + } + }, + "summary": "Deletes a Pool from the specified Account.", + "description": "When you request that a Pool be deleted, the following actions occur: the Pool state is set to deleting; any ongoing resize operation on the Pool are stopped; the Batch service starts resizing the Pool to zero Compute Nodes; any Tasks running on existing Compute Nodes are terminated and requeued (as if a resize Pool operation had been requested with the default requeue option); finally, the Pool is removed from the system. Because running Tasks are requeued, the user can rerun these Tasks by updating their Job to target a different Pool. The Tasks can then run on the new Pool. If you want to override the requeue behavior, then you should call resize Pool explicitly to shrink the Pool to zero size before deleting the Pool. If you call an Update, Patch or Delete API on a Pool in the deleting state, it will fail with HTTP status code 409 with error code PoolBeingDeleted.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool to delete." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "head": { + "tags": [ + "Pools" + ], + "operationId": "Pool_Exists", + "x-ms-examples": { + "Check Pool Exists": { + "$ref": "./examples/PoolExists.json" + } + }, + "description": "Gets basic properties of a Pool.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool to get." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing headers related to the Pool, if it exists." + }, + "404": { + "description": "The Pool does not exist." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "Pools" + ], + "operationId": "Pool_Get", + "x-ms-examples": { + "Pool get": { + "$ref": "./examples/PoolGet_Basic.json" + }, + "Get a VirtualMachineConfiguration pool with extensions": { + "$ref": "./examples/PoolGet_VirtualMachineConfigurationWithExtensions.json" + } + }, + "description": "Gets information about the specified Pool.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool to get." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $expand clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the Pool.", + "schema": { + "$ref": "#/definitions/CloudPool" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "patch": { + "tags": [ + "Pools" + ], + "operationId": "Pool_Patch", + "x-ms-examples": { + "Patch the Pool": { + "$ref": "./examples/PoolPatch.json" + } + }, + "summary": "Updates the properties of the specified Pool.", + "description": "This only replaces the Pool properties specified in the request. For example, if the Pool has a StartTask associated with it, and a request does not specify a StartTask element, then the Pool keeps the existing StartTask.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool to update." + }, + { + "name": "poolPatchParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PoolPatchParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/disableautoscale": { + "post": { + "tags": [ + "Pools" + ], + "operationId": "Pool_DisableAutoScale", + "x-ms-examples": { + "Disable pool autoscale": { + "$ref": "./examples/PoolDisableAutoScale.json" + } + }, + "summary": "Disables automatic scaling for a Pool.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool on which to disable automatic scaling." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/enableautoscale": { + "post": { + "tags": [ + "Pools" + ], + "operationId": "Pool_EnableAutoScale", + "x-ms-examples": { + "Pool enable autoscale": { + "$ref": "./examples/PoolEnableAutoscale.json" + } + }, + "summary": "Enables automatic scaling for a Pool.", + "description": "You cannot enable automatic scaling on a Pool if a resize operation is in progress on the Pool. If automatic scaling of the Pool is currently disabled, you must specify a valid autoscale formula as part of the request. If automatic scaling of the Pool is already enabled, you may specify a new autoscale formula and/or a new evaluation interval. You cannot call this API for the same Pool more than once every 30 seconds.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool on which to enable automatic scaling." + }, + { + "name": "poolEnableAutoScaleParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PoolEnableAutoScaleParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/evaluateautoscale": { + "post": { + "tags": [ + "Pools" + ], + "operationId": "Pool_EvaluateAutoScale", + "x-ms-examples": { + "Pool evaluate autoscale": { + "$ref": "./examples/PoolEvaluateAutoscale.json" + } + }, + "summary": "Gets the result of evaluating an automatic scaling formula on the Pool.", + "description": "This API is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the Pool. The Pool must have auto scaling enabled in order to evaluate a formula.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool on which to evaluate the automatic scaling formula." + }, + { + "name": "poolEvaluateAutoScaleParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PoolEvaluateAutoScaleParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "A response containing the results of the autoscale evaluation.", + "schema": { + "$ref": "#/definitions/AutoScaleRun" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/resize": { + "post": { + "tags": [ + "Pools" + ], + "operationId": "Pool_Resize", + "x-ms-examples": { + "Pool resize": { + "$ref": "./examples/PoolResize.json" + } + }, + "summary": "Changes the number of Compute Nodes that are assigned to a Pool.", + "description": "You can only resize a Pool when its allocation state is steady. If the Pool is already resizing, the request fails with status code 409. When you resize a Pool, the Pool's allocation state changes from steady to resizing. You cannot resize Pools which are configured for automatic scaling. If you try to do this, the Batch service returns an error 409. If you resize a Pool downwards, the Batch service chooses which Compute Nodes to remove. To remove specific Compute Nodes, use the Pool remove Compute Nodes API instead.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool to resize." + }, + { + "name": "poolResizeParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PoolResizeParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/stopresize": { + "post": { + "tags": [ + "Pools" + ], + "operationId": "Pool_StopResize", + "x-ms-examples": { + "Pool stop resize": { + "$ref": "./examples/PoolStopResize.json" + } + }, + "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 Compute 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-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool whose resizing you want to stop." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service. If you call this API on a Pool which is not in the resizing state, the request fails with HTTP status code 409.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/updateproperties": { + "post": { + "tags": [ + "Pools" + ], + "operationId": "Pool_UpdateProperties", + "x-ms-examples": { + "Pool update": { + "$ref": "./examples/PoolUpdate.json" + } + }, + "summary": "Updates the properties of the specified Pool.", + "description": "This fully replaces all the updatable properties of the Pool. For example, if the Pool has a StartTask associated with it and if StartTask is not specified with this request, then the Batch service will remove the existing StartTask.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool to update." + }, + { + "name": "poolUpdatePropertiesParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PoolUpdatePropertiesParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/removenodes": { + "post": { + "tags": [ + "ComputeNodes" + ], + "operationId": "Pool_RemoveNodes", + "x-ms-examples": { + "Pool remove nodes": { + "$ref": "./examples/PoolRemoveNodes.json" + } + }, + "summary": "Removes Compute Nodes from the specified Pool.", + "description": "This operation can only run when the allocation state of the Pool is steady. When this operation runs, the allocation state changes from steady to resizing. Each request may remove up to 100 nodes.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool from which you want to remove Compute Nodes." + }, + { + "name": "nodeRemoveParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NodeRemoveParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/tasks": { + "post": { + "tags": [ + "Tasks" + ], + "operationId": "Task_Add", + "x-ms-examples": { + "Add a basic task": { + "$ref": "./examples/TaskAdd_Basic.json" + }, + "Add a task with exit conditions": { + "$ref": "./examples/TaskAdd_ExitConditions.json" + }, + "Add a task with container settings": { + "$ref": "./examples/TaskAdd_ContainerSettings.json" + }, + "Add a task with extra slot requirement": { + "$ref": "./examples/TaskAdd_RequiredSlots.json" + } + }, + "summary": "Adds a Task to the specified Job.", + "description": "The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job to which the Task is to be added." + }, + { + "name": "task", + "in": "body", + "description": "The Task to be added.", + "required": true, + "schema": { + "$ref": "#/definitions/TaskAddParameter" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "Tasks" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "Task_List", + "x-ms-examples": { + "Task list": { + "$ref": "./examples/TaskList.json" + } + }, + "summary": "Lists all of the Tasks that are associated with the specified Job.", + "description": "For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-tasks.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $expand clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 Tasks can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of Tasks.", + "schema": { + "$ref": "#/definitions/CloudTaskListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/addtaskcollection": { + "post": { + "tags": [ + "Tasks" + ], + "operationId": "Task_AddCollection", + "x-ms-examples": { + "Add a basic collection of tasks": { + "$ref": "./examples/TaskAddCollection_Basic.json" + }, + "Add a complex collection of tasks": { + "$ref": "./examples/TaskAddCollection_Complex.json" + } + }, + "summary": "Adds a collection of Tasks to the specified Job.", + "description": "Note that each Task must have a unique ID. The Batch service may not return the results for each Task in the same order the Tasks were submitted in this request. If the server times out or the connection is closed during the request, the request may have been partially or fully processed, or not at all. In such cases, the user should re-issue the request. Note that it is up to the user to correctly handle failures when re-issuing a request. For example, you should use the same Task IDs during a retry so that if the prior operation succeeded, the retry will not create extra Tasks unexpectedly. If the response contains any Tasks which failed to add, a client can retry the request. In a retry, it is most efficient to resubmit only Tasks that failed to add, and to omit Tasks that were successfully added on the first attempt. The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job to which the Task collection is to be added." + }, + { + "name": "taskCollection", + "in": "body", + "description": "The Tasks to be added.", + "required": true, + "schema": { + "$ref": "#/definitions/TaskAddCollectionParameter" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/TaskAddCollectionResult" + }, + "description": "A response containing the results of the add Task collection operation." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/tasks/{taskId}": { + "delete": { + "tags": [ + "Tasks" + ], + "operationId": "Task_Delete", + "x-ms-examples": { + "Task delete": { + "$ref": "./examples/TaskDelete.json" + } + }, + "summary": "Deletes a Task from the specified Job.", + "description": "When a Task is deleted, all of the files in its directory on the Compute Node where it ran are also deleted (regardless of the retention time). For multi-instance Tasks, the delete Task operation applies synchronously to the primary task; subtasks and their files are then deleted asynchronously in the background.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job from which to delete the Task." + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Task to delete." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "Tasks" + ], + "operationId": "Task_Get", + "x-ms-examples": { + "Task get": { + "$ref": "./examples/TaskGet.json" + } + }, + "summary": "Gets information about the specified Task.", + "description": "For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job that contains the Task." + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Task to get information about." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $expand clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "A response containing the Task.", + "schema": { + "$ref": "#/definitions/CloudTask" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "put": { + "tags": [ + "Tasks" + ], + "operationId": "Task_Update", + "x-ms-examples": { + "Task update": { + "$ref": "./examples/TaskUpdate.json" + } + }, + "description": "Updates the properties of the specified Task.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job containing the Task." + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Task to update." + }, + { + "name": "taskUpdateParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TaskUpdateParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/tasks/{taskId}/subtasksinfo": { + "get": { + "tags": [ + "Tasks" + ], + "operationId": "Task_ListSubtasks", + "x-ms-examples": { + "Task list subtasks": { + "$ref": "./examples/TaskListSubtasks.json" + } + }, + "summary": "Lists all of the subtasks that are associated with the specified multi-instance Task.", + "description": "If the Task is not a multi-instance Task then this returns an empty collection.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job." + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Task." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of subtasks.", + "schema": { + "$ref": "#/definitions/CloudTaskListSubtasksResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/tasks/{taskId}/terminate": { + "post": { + "tags": [ + "Tasks" + ], + "operationId": "Task_Terminate", + "x-ms-examples": { + "Task terminate": { + "$ref": "./examples/TaskTerminate.json" + } + }, + "summary": "Terminates the specified Task.", + "description": "When the Task has been terminated, it moves to the completed state. For multi-instance Tasks, the terminate Task operation applies synchronously to the primary task; subtasks are then terminated asynchronously in the background.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job containing the Task." + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Task to terminate." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/tasks/{taskId}/reactivate": { + "post": { + "tags": [ + "Tasks" + ], + "operationId": "Task_Reactivate", + "x-ms-examples": { + "Task reactivate": { + "$ref": "./examples/TaskReactivate.json" + } + }, + "summary": "Reactivates a Task, allowing it to run again even if its retry count has been exhausted.", + "description": "Reactivation makes a Task eligible to be retried again up to its maximum retry count. The Task's state is changed to active. As the Task is no longer in the completed state, any previous exit code or failure information is no longer available after reactivation. Each time a Task is reactivated, its retry count is reset to 0. Reactivation will fail for Tasks that are not completed or that previously completed successfully (with an exit code of 0). Additionally, it will fail if the Job has completed (or is terminating or deleting).", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job containing the Task." + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Task to reactivate." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/users": { + "post": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_AddUser", + "x-ms-examples": { + "Node add user": { + "$ref": "./examples/NodeAddUser.json" + } + }, + "summary": "Adds a user Account to the specified Compute Node.", + "description": "You can add a user Account to a Compute Node only when it is in the idle or running state.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the machine on which you want to create a user Account." + }, + { + "name": "user", + "in": "body", + "description": "The user Account to be created.", + "required": true, + "schema": { + "$ref": "#/definitions/ComputeNodeUser" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/users/{userName}": { + "delete": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_DeleteUser", + "x-ms-examples": { + "Node delete user": { + "$ref": "./examples/NodeDeleteUser.json" + } + }, + "summary": "Deletes a user Account from the specified Compute Node.", + "description": "You can delete a user Account to a Compute Node only when it is in the idle or running state.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the machine on which you want to delete a user Account." + }, + { + "name": "userName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the user Account to delete." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "put": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_UpdateUser", + "x-ms-examples": { + "Node update user": { + "$ref": "./examples/NodeUpdateUser.json" + } + }, + "summary": "Updates the password and expiration time of a user Account on the specified Compute Node.", + "description": "This operation replaces of all the updatable properties of the Account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user Account on a Compute Node only when it is in the idle or running state.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the machine on which you want to update a user Account." + }, + { + "name": "userName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the user Account to update." + }, + { + "name": "nodeUpdateUserParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NodeUpdateUserParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}": { + "get": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_Get", + "x-ms-examples": { + "Node get": { + "$ref": "./examples/NodeGet_Basic.json" + } + }, + "summary": "Gets information about the specified Compute Node.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Compute Node that you want to get information about." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the Compute Node.", + "schema": { + "$ref": "#/definitions/ComputeNode" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/reboot": { + "post": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_Reboot", + "x-ms-examples": { + "Node reboot": { + "$ref": "./examples/NodeReboot.json" + } + }, + "summary": "Restarts the specified Compute Node.", + "description": "You can restart a Compute Node only if it is in an idle or running state.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Compute Node that you want to restart." + }, + { + "name": "nodeRebootParameter", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/NodeRebootParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/reimage": { + "post": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_Reimage", + "x-ms-examples": { + "Node reimage": { + "$ref": "./examples/NodeReimage.json" + } + }, + "summary": "Reinstalls the operating system on the specified Compute Node.", + "description": "You can reinstall the operating system on a Compute Node only if it is in an idle or running state. This API can be invoked only on Pools created with the cloud service configuration property.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Compute Node that you want to restart." + }, + { + "name": "nodeReimageParameter", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/NodeReimageParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/disablescheduling": { + "post": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_DisableScheduling", + "x-ms-examples": { + "Node disable scheduling": { + "$ref": "./examples/NodeDisableScheduling.json" + } + }, + "summary": "Disables Task scheduling on the specified Compute Node.", + "description": "You can disable Task scheduling on a Compute Node only if its current scheduling state is enabled.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Compute Node on which you want to disable Task scheduling." + }, + { + "name": "nodeDisableSchedulingParameter", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/NodeDisableSchedulingParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/enablescheduling": { + "post": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_EnableScheduling", + "x-ms-examples": { + "Node enable scheduling": { + "$ref": "./examples/NodeEnableScheduling.json" + } + }, + "summary": "Enables Task scheduling on the specified Compute Node.", + "description": "You can enable Task scheduling on a Compute Node only if its current scheduling state is disabled", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Compute Node on which you want to enable Task scheduling." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/remoteloginsettings": { + "get": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_GetRemoteLoginSettings", + "x-ms-examples": { + "Node get remote login settings": { + "$ref": "./examples/NodeGetRemoteLoginSettings.json" + } + }, + "summary": "Gets the settings required for remote login to a Compute Node.", + "description": "Before you can remotely login to a Compute Node using the remote login settings, you must create a user Account on the Compute Node. This API can be invoked only on Pools created with the virtual machine configuration property. For Pools created with a cloud service configuration, see the GetRemoteDesktop API.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Compute Node for which to obtain the remote login settings." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the login settings.", + "schema": { + "$ref": "#/definitions/ComputeNodeGetRemoteLoginSettingsResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/rdp": { + "get": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_GetRemoteDesktop", + "x-ms-examples": { + "Get RDP file of the compute node": { + "$ref": "./examples/NodeGetRemoteDesktop.json" + } + }, + "summary": "Gets the Remote Desktop Protocol file for the specified Compute Node.", + "description": "Before you can access a Compute Node by using the RDP file, you must create a user Account on the Compute Node. This API can only be invoked on Pools created with a cloud service configuration. For Pools created with a virtual machine configuration, see the GetRemoteLoginSettings API.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Compute Node for which you want to get the Remote Desktop Protocol file." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "produces": [ + "application/json", + "application/octet-stream" + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the RDP information.", + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs": { + "post": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_UploadBatchServiceLogs", + "summary": "Upload Azure Batch service log files from the specified Compute Node to Azure Blob Storage.", + "description": "This is for gathering Azure Batch service log files in an automated fashion from Compute Nodes if you are experiencing an error and wish to escalate to Azure support. The Azure Batch service log files should be shared with Azure support to aid in debugging issues with the Batch service.", + "x-ms-examples": { + "Upload BatchService Logs": { + "$ref": "./examples/NodeUploadBatchServiceLogs.json" + } + }, + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Compute Node from which you want to upload the Azure Batch service log files." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "uploadBatchServiceLogsConfiguration", + "in": "body", + "description": "The Azure Batch service log files upload configuration.", + "required": true, + "schema": { + "$ref": "#/definitions/UploadBatchServiceLogsConfiguration" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + } + }, + "description": "The request to the Batch service was successful.", + "schema": { + "$ref": "#/definitions/UploadBatchServiceLogsResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes": { + "get": { + "tags": [ + "ComputeNodes" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "ComputeNode_List", + "x-ms-examples": { + "Node list": { + "$ref": "./examples/NodeList.json" + } + }, + "summary": "Lists the Compute Nodes in the specified Pool.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool from which you want to list Compute Nodes." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 Compute Nodes can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of Compute Nodes.", + "schema": { + "$ref": "#/definitions/ComputeNodeListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/extensions/{extensionName}": { + "get": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNodeExtension_Get", + "x-ms-examples": { + "Get compute node extension": { + "$ref": "./examples/ComputeNodeExtensionGet.json" + } + }, + "summary": "Gets information about the specified Compute Node Extension.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Compute Node that contains the extensions." + }, + { + "name": "extensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the of the Compute Node Extension that you want to get information about." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the Compute Node Extension.", + "schema": { + "$ref": "#/definitions/NodeVMExtension" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/extensions": { + "get": { + "tags": [ + "ComputeNodes" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "ComputeNodeExtension_List", + "x-ms-examples": { + "List compute node extensions": { + "$ref": "./examples/ComputeNodeExtensionList.json" + } + }, + "summary": "Lists the Compute Nodes Extensions in the specified Pool.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Compute Node that you want to list extensions." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 Compute Nodes can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "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-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of Compute Nodes.", + "schema": { + "$ref": "#/definitions/NodeVMExtensionList" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + } + }, + "definitions": { + "PoolUsageMetrics": { + "type": "object", + "properties": { + "poolId": { + "type": "string", + "title": "The ID of the Pool whose metrics are aggregated in this entry." + }, + "startTime": { + "type": "string", + "format": "date-time", + "title": "The start time of the aggregation interval covered by this entry." + }, + "endTime": { + "type": "string", + "format": "date-time", + "title": "The end time of the aggregation interval covered by this entry." + }, + "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 in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes)." + }, + "totalCoreHours": { + "type": "number", + "format": "double", + "title": "The total core hours used in the Pool during this aggregation interval." + } + }, + "required": [ + "poolId", + "startTime", + "endTime", + "vmSize", + "totalCoreHours" + ], + "title": "Usage metrics for a Pool across an aggregation interval." + }, + "PoolListUsageMetricsResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PoolUsageMetrics" + }, + "title": "The Pool usage metrics data." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of a listing the usage metrics for an Account." + }, + "ImageInformation": { + "type": "object", + "properties": { + "nodeAgentSKUId": { + "type": "string", + "title": "The ID of the Compute Node agent SKU which the Image supports." + }, + "imageReference": { + "$ref": "#/definitions/ImageReference", + "title": "The reference to the Azure Virtual Machine's Marketplace Image." + }, + "osType": { + "type": "string", + "title": "The type of operating system (e.g. Windows or Linux) of the Image.", + "enum": [ + "linux", + "windows" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": false, + "values": [ + { + "value": "linux", + "description": "The Linux operating system." + }, + { + "value": "windows", + "description": "The Windows operating system." + } + ] + } + }, + "capabilities": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The capabilities or features which the Image supports.", + "description": "Not every capability of the Image is listed. Capabilities in this list are considered of special interest and are generally related to integration with other features in the Azure Batch service." + }, + "batchSupportEndOfLife": { + "type": "string", + "format": "date-time", + "title": "The time when the Azure Batch service will stop accepting create Pool requests for the Image." + }, + "verificationType": { + "type": "string", + "title": "Whether the Azure Batch service actively verifies that the Image is compatible with the associated Compute Node agent SKU.", + "enum": [ + "verified", + "unverified" + ], + "x-ms-enum": { + "name": "VerificationType", + "modelAsString": false, + "values": [ + { + "value": "verified", + "description": "The Image is guaranteed to be compatible with the associated Compute Node agent SKU and all Batch features have been confirmed to work as expected." + }, + { + "value": "unverified", + "description": "The associated Compute Node agent SKU should have binary compatibility with the Image, but specific functionality has not been verified." + } + ] + } + } + }, + "required": [ + "imageReference", + "verificationType", + "osType", + "nodeAgentSKUId" + ], + "title": "A reference to the Azure Virtual Machines Marketplace Image and additional information about the Image." + }, + "AuthenticationTokenSettings": { + "type": "object", + "properties": { + "access": { + "type": "array", + "items": { + "type": "string", + "x-nullable": false, + "enum": [ + "job" + ], + "x-ms-enum": { + "name": "AccessScope", + "modelAsString": false, + "values": [ + { + "value": "job", + "description": "Grants access to perform all operations on the Job containing the Task." + } + ] + } + }, + "title": "The Batch resources to which the token grants access.", + "description": "The authentication token grants access to a limited set of Batch service operations. Currently the only supported value for the access property is 'job', which grants access to all operations related to the Job which contains the Task." + } + }, + "title": "The settings for an authentication token that the Task can use to perform Batch service operations." + }, + "AccountListSupportedImagesResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageInformation" + }, + "title": "The list of supported Virtual Machine Images." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the supported Virtual Machine Images." + }, + "UsageStatistics": { + "type": "object", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "title": "The start time of the time range covered by the statistics." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime." + }, + "dedicatedCoreTime": { + "type": "string", + "format": "duration", + "title": "The aggregated wall-clock time of the dedicated Compute Node cores being part of the Pool." + } + }, + "required": [ + "startTime", + "lastUpdateTime", + "dedicatedCoreTime" + ], + "title": "Statistics related to Pool usage information." + }, + "ResourceStatistics": { + "type": "object", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "title": "The start time of the time range covered by the statistics." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime." + }, + "avgCPUPercentage": { + "type": "number", + "format": "double", + "title": "The average CPU usage across all Compute Nodes in the Pool (percentage per node)." + }, + "avgMemoryGiB": { + "type": "number", + "format": "double", + "title": "The average memory usage in GiB across all Compute Nodes in the Pool." + }, + "peakMemoryGiB": { + "type": "number", + "format": "double", + "title": "The peak memory usage in GiB across all Compute Nodes in the Pool." + }, + "avgDiskGiB": { + "type": "number", + "format": "double", + "title": "The average used disk space in GiB across all Compute Nodes in the Pool." + }, + "peakDiskGiB": { + "type": "number", + "format": "double", + "title": "The peak used disk space in GiB across all Compute Nodes in the Pool." + }, + "diskReadIOps": { + "type": "integer", + "format": "int64", + "title": "The total number of disk read operations across all Compute Nodes in the Pool." + }, + "diskWriteIOps": { + "type": "integer", + "format": "int64", + "title": "The total number of disk write operations across all Compute Nodes in the Pool." + }, + "diskReadGiB": { + "type": "number", + "format": "double", + "title": "The total amount of data in GiB of disk reads across all Compute Nodes in the Pool." + }, + "diskWriteGiB": { + "type": "number", + "format": "double", + "title": "The total amount of data in GiB of disk writes across all Compute Nodes in the Pool." + }, + "networkReadGiB": { + "type": "number", + "format": "double", + "title": "The total amount of data in GiB of network reads across all Compute Nodes in the Pool." + }, + "networkWriteGiB": { + "type": "number", + "format": "double", + "title": "The total amount of data in GiB of network writes across all Compute Nodes in the Pool." + } + }, + "required": [ + "startTime", + "lastUpdateTime", + "avgCPUPercentage", + "avgMemoryGiB", + "peakMemoryGiB", + "avgDiskGiB", + "peakDiskGiB", + "diskReadIOps", + "diskWriteIOps", + "diskReadGiB", + "diskWriteGiB", + "networkReadGiB", + "networkWriteGiB" + ], + "title": "Statistics related to resource consumption by Compute Nodes in a Pool." + }, + "PoolStatistics": { + "type": "object", + "properties": { + "url": { + "type": "string", + "title": "The URL for the statistics." + }, + "startTime": { + "type": "string", + "format": "date-time", + "title": "The start time of the time range covered by the statistics." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime." + }, + "usageStats": { + "$ref": "#/definitions/UsageStatistics", + "title": "Statistics related to Pool usage, such as the amount of core-time used." + }, + "resourceStats": { + "$ref": "#/definitions/ResourceStatistics", + "title": "Statistics related to resource consumption by Compute Nodes in the Pool." + } + }, + "required": [ + "url", + "startTime", + "lastUpdateTime" + ], + "title": "Contains utilization and resource usage statistics for the lifetime of a Pool." + }, + "JobStatistics": { + "type": "object", + "properties": { + "url": { + "type": "string", + "title": "The URL of the statistics." + }, + "startTime": { + "type": "string", + "format": "date-time", + "title": "The start time of the time range covered by the statistics." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime." + }, + "userCPUTime": { + "type": "string", + "format": "duration", + "title": "The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job." + }, + "kernelCPUTime": { + "type": "string", + "format": "duration", + "title": "The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job." + }, + "wallClockTime": { + "type": "string", + "format": "duration", + "title": "The total wall clock time of all Tasks in the Job.", + "description": " The wall clock time is the elapsed time from when the Task started running on a Compute Node to when it finished (or to the last time the statistics were updated, if the Task had not finished by then). If a Task was retried, this includes the wall clock time of all the Task retries." + }, + "readIOps": { + "type": "integer", + "format": "int64", + "title": "The total number of disk read operations made by all Tasks in the Job." + }, + "writeIOps": { + "type": "integer", + "format": "int64", + "title": "The total number of disk write operations made by all Tasks in the Job." + }, + "readIOGiB": { + "type": "number", + "format": "double", + "title": "The total amount of data in GiB read from disk by all Tasks in the Job." + }, + "writeIOGiB": { + "type": "number", + "format": "double", + "title": "The total amount of data in GiB written to disk by all Tasks in the Job." + }, + "numSucceededTasks": { + "type": "integer", + "format": "int64", + "title": "The total number of Tasks successfully completed in the Job during the given time range.", + "description": "A Task completes successfully if it returns exit code 0." + }, + "numFailedTasks": { + "type": "integer", + "format": "int64", + "title": "The total number of Tasks in the Job that failed during the given time range.", + "description": "A Task fails if it exhausts its maximum retry count without returning exit code 0." + }, + "numTaskRetries": { + "type": "integer", + "format": "int64", + "title": "The total number of retries on all the Tasks in the Job during the given time range." + }, + "waitTime": { + "type": "string", + "format": "duration", + "title": "The total wait time of all Tasks in the Job.", + "description": "The wait time for a Task is defined as the elapsed time between the creation of the Task and the start of Task execution. (If the Task is retried due to failures, the wait time is the time to the most recent Task execution.) This value is only reported in the Account lifetime statistics; it is not included in the Job statistics." + } + }, + "required": [ + "url", + "startTime", + "lastUpdateTime", + "userCPUTime", + "kernelCPUTime", + "wallClockTime", + "readIOps", + "writeIOps", + "readIOGiB", + "writeIOGiB", + "numSucceededTasks", + "numFailedTasks", + "numTaskRetries", + "waitTime" + ], + "title": "Resource usage statistics for a Job." + }, + "NameValuePair": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "The name in the name-value pair." + }, + "value": { + "type": "string", + "title": "The value in the name-value pair." + } + }, + "title": "Represents a name-value pair." + }, + "DeleteCertificateError": { + "type": "object", + "properties": { + "code": { + "type": "string", + "title": "An identifier for the Certificate deletion error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "title": "A message describing the Certificate deletion error, intended to be suitable for display in a user interface." + }, + "values": { + "type": "array", + "items": { + "$ref": "#/definitions/NameValuePair" + }, + "title": "A list of additional error details related to the Certificate deletion error.", + "description": "This list includes details such as the active Pools and Compute Nodes referencing this Certificate. However, if a large number of resources reference the Certificate, the list contains only about the first hundred." + } + }, + "title": "An error encountered by the Batch service when deleting a Certificate." + }, + "Certificate": { + "type": "object", + "properties": { + "thumbprint": { + "type": "string", + "title": "The X.509 thumbprint of the Certificate. This is a sequence of up to 40 hex digits." + }, + "thumbprintAlgorithm": { + "type": "string", + "title": "The algorithm used to derive the thumbprint." + }, + "url": { + "type": "string", + "title": "The URL of the Certificate." + }, + "state": { + "title": "The current state of the Certificate.", + "$ref": "#/definitions/CertificateState" + }, + "stateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Certificate entered its current state." + }, + "previousState": { + "title": "The previous state of the Certificate.", + "description": "This property is not set if the Certificate is in its initial active state.", + "$ref": "#/definitions/CertificateState" + }, + "previousStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Certificate entered its previous state.", + "description": "This property is not set if the Certificate is in its initial Active state." + }, + "publicData": { + "type": "string", + "title": "The public part of the Certificate as a base-64 encoded .cer file." + }, + "deleteCertificateError": { + "$ref": "#/definitions/DeleteCertificateError", + "title": "The error that occurred on the last attempt to delete this Certificate.", + "description": "This property is set only if the Certificate is in the DeleteFailed state." + } + }, + "description": "A Certificate that can be installed on Compute Nodes and can be used to authenticate operations on the machine." + }, + "ApplicationPackageReference": { + "type": "object", + "properties": { + "applicationId": { + "type": "string", + "title": "The ID of the application to deploy." + }, + "version": { + "type": "string", + "title": "The version of the application to deploy. If omitted, the default version is deployed.", + "description": "If this is omitted on a Pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task fails with a pre-processing error." + } + }, + "required": [ + "applicationId" + ], + "title": "A reference to an Package to be deployed to Compute Nodes." + }, + "ApplicationSummary": { + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the application within the Account." + }, + "displayName": { + "type": "string", + "title": "The display name for the application." + }, + "versions": { + "type": "array", + "title": "The list of available versions of the application.", + "items": { + "type": "string" + } + } + }, + "required": [ + "id", + "displayName", + "versions" + ], + "title": "Contains information about an application in an Azure Batch Account." + }, + "CertificateAddParameter": { + "type": "object", + "properties": { + "thumbprint": { + "type": "string", + "title": "The X.509 thumbprint of the Certificate. This is a sequence of up to 40 hex digits (it may include spaces but these are removed)." + }, + "thumbprintAlgorithm": { + "type": "string", + "title": "The algorithm used to derive the thumbprint. This must be sha1." + }, + "data": { + "type": "string", + "title": "The base64-encoded contents of the Certificate. The maximum size is 10KB." + }, + "certificateFormat": { + "type": "string", + "title": "The format of the Certificate data.", + "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." + } + ] + } + }, + "password": { + "type": "string", + "title": "The password to access the Certificate's private key.", + "description": "This must be omitted if the Certificate format is cer." + } + }, + "required": [ + "thumbprint", + "thumbprintAlgorithm", + "data" + ], + "title": "A Certificate that can be installed on Compute Nodes and can be used to authenticate operations on the machine." + }, + "CertificateListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Certificate" + }, + "title": "The list of Certificates." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the Certificates in the Account." + }, + "FileProperties": { + "type": "object", + "properties": { + "creationTime": { + "type": "string", + "format": "date-time", + "title": "The file creation time.", + "description": "The creation time is not returned for files on Linux Compute Nodes." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "title": "The time at which the file was last modified." + }, + "contentLength": { + "type": "integer", + "format": "int64", + "title": "The length of the file." + }, + "contentType": { + "type": "string", + "title": "The content type of the file." + }, + "fileMode": { + "type": "string", + "title": "The file mode attribute in octal format.", + "description": "The file mode is returned only for files on Linux Compute Nodes." + } + }, + "required": [ + "lastModified", + "contentLength" + ], + "title": "The properties of a file on a Compute Node." + }, + "NodeFile": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "The file path." + }, + "url": { + "type": "string", + "title": "The URL of the file." + }, + "isDirectory": { + "type": "boolean", + "title": "Whether the object represents a directory." + }, + "properties": { + "$ref": "#/definitions/FileProperties", + "title": "The file properties." + } + }, + "title": "Information about a file or directory on a Compute Node." + }, + "NodeFileListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeFile" + }, + "title": "The list of files." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the files on a Compute Node, or the files associated with a Task on a Compute Node." + }, + "Schedule": { + "type": "object", + "properties": { + "doNotRunUntil": { + "type": "string", + "format": "date-time", + "title": "The earliest time at which any Job may be created under this Job Schedule.", + "description": "If you do not specify a doNotRunUntil time, the schedule becomes ready to create Jobs immediately." + }, + "doNotRunAfter": { + "type": "string", + "format": "date-time", + "title": "A time after which no Job will be created under this Job Schedule. The schedule will move to the completed state as soon as this deadline is past and there is no active Job under this Job Schedule.", + "description": "If you do not specify a doNotRunAfter time, and you are creating a recurring Job Schedule, the Job Schedule will remain active until you explicitly terminate it." + }, + "startWindow": { + "type": "string", + "format": "duration", + "title": "The time interval, starting from the time at which the schedule indicates a Job should be created, within which a Job must be created.", + "description": "If a Job is not created within the startWindow interval, then the 'opportunity' is lost; no Job will be created until the next recurrence of the schedule. If the schedule is recurring, and the startWindow is longer than the recurrence interval, then this is equivalent to an infinite startWindow, because the Job that is 'due' in one recurrenceInterval is not carried forward into the next recurrence interval. The default is infinite. The minimum value is 1 minute. If you specify a lower value, the Batch service rejects the schedule with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "recurrenceInterval": { + "type": "string", + "format": "duration", + "title": "The time interval between the start times of two successive Jobs under the Job Schedule. A Job Schedule can have at most one active Job under it at any given time.", + "description": "Because a Job Schedule can have at most one active Job under it at any given time, if it is time to create a new Job under a Job Schedule, but the previous Job is still running, the Batch service will not create the new Job until the previous Job finishes. If the previous Job does not finish within the startWindow period of the new recurrenceInterval, then no new Job will be scheduled for that interval. For recurring Jobs, you should normally specify a jobManagerTask in the jobSpecification. If you do not use jobManagerTask, you will need an external process to monitor when Jobs are created, add Tasks to the Jobs and terminate the Jobs ready for the next recurrence. The default is that the schedule does not recur: one Job is created, within the startWindow after the doNotRunUntil time, and the schedule is complete as soon as that Job finishes. The minimum value is 1 minute. If you specify a lower value, the Batch service rejects the schedule with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + } + }, + "title": "The schedule according to which Jobs will be created" + }, + "JobConstraints": { + "type": "object", + "properties": { + "maxWallClockTime": { + "type": "string", + "format": "duration", + "title": "The maximum elapsed time that the Job may run, measured from the time the Job is created.", + "description": "If the Job does not complete within the time limit, the Batch service terminates it and any Tasks that are still running. In this case, the termination reason will be MaxWallClockTimeExpiry. If this property is not specified, there is no time limit on how long the Job may run." + }, + "maxTaskRetryCount": { + "type": "integer", + "format": "int32", + "title": "The maximum number of times each Task may be retried. The Batch service retries a Task if its exit code is nonzero.", + "description": "Note that this value specifically controls the number of retries. The Batch service will try each Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries a Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry Tasks. If the maximum retry count is -1, the Batch service retries Tasks without limit. The default value is 0 (no retries)." + } + }, + "title": "The execution constraints for a Job." + }, + "JobNetworkConfiguration": { + "type": "object", + "properties": { + "subnetId": { + "type": "string", + "title": "The ARM resource identifier of the virtual network subnet which Compute Nodes running Tasks from the Job will join for the duration of the Task. This will only work with a VirtualMachineConfiguration Pool.", + "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 Compute Nodes which will run Tasks from the Job. This can be up to the number of Compute Nodes in the Pool. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet so that Azure Batch service can schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication from the Azure Batch service. 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. Port 443 is also required to be open for outbound connections for communications to Azure Storage. 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" + } + } + }, + "required": [ + "subnetId" + ], + "title": "The network configuration for the Job." + }, + "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": "The location of the container Task working directory.", + "description": "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": "Use the working directory defined in the container Image. 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(s), 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 Compute Node. If this property is not specified for a Linux Compute 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." + }, + "ExitConditions": { + "type": "object", + "properties": { + "exitCodes": { + "type": "array", + "items": { + "$ref": "#/definitions/ExitCodeMapping" + }, + "title": "A list of individual Task exit codes and how the Batch service should respond to them." + }, + "exitCodeRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/ExitCodeRangeMapping" + }, + "title": "A list of Task exit code ranges and how the Batch service should respond to them." + }, + "preProcessingError": { + "$ref": "#/definitions/ExitOptions", + "title": "How the Batch service should respond if the Task fails to start due to an error." + }, + "fileUploadError": { + "$ref": "#/definitions/ExitOptions", + "title": "How the Batch service should respond if a file upload error occurs.", + "description": "If the Task exited with an exit code that was specified via exitCodes or exitCodeRanges, and then encountered a file upload error, then the action specified by the exit code takes precedence." + }, + "default": { + "$ref": "#/definitions/ExitOptions", + "title": "How the Batch service should respond if the Task fails with an exit condition not covered by any of the other properties.", + "description": "This value is used if the Task exits with any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, with a pre-processing error if the preProcessingError property is not present, or with a file upload error if the fileUploadError property is not present. If you want non-default behavior on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection." + } + }, + "title": "Specifies how the Batch service should respond when the Task completes." + }, + "ExitCodeMapping": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "title": "A process exit code." + }, + "exitOptions": { + "$ref": "#/definitions/ExitOptions", + "title": "How the Batch service should respond if the Task exits with this exit code." + } + }, + "title": "How the Batch service should respond if a Task exits with a particular exit code.", + "required": [ + "code", + "exitOptions" + ] + }, + "ExitCodeRangeMapping": { + "type": "object", + "properties": { + "start": { + "type": "integer", + "format": "int32", + "title": "The first exit code in the range." + }, + "end": { + "type": "integer", + "format": "int32", + "title": "The last exit code in the range." + }, + "exitOptions": { + "$ref": "#/definitions/ExitOptions", + "title": "How the Batch service should respond if the Task exits with an exit code in the range start to end (inclusive)." + } + }, + "title": "A range of exit codes and how the Batch service should respond to exit codes within that range.", + "required": [ + "start", + "end", + "exitOptions" + ] + }, + "ExitOptions": { + "type": "object", + "properties": { + "jobAction": { + "type": "string", + "title": "An action to take on the Job containing the Task, if the Task completes with the given exit condition and the Job's onTaskFailed property is 'performExitOptionsJobAction'.", + "description": "The default is none for exit code 0 and terminate for all other exit conditions. If the Job's onTaskFailed property is noaction, then specifying this property returns an error and the add Task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", + "enum": [ + "none", + "disable", + "terminate" + ], + "x-ms-enum": { + "name": "JobAction", + "modelAsString": false, + "values": [ + { + "value": "none", + "description": "Take no action." + }, + { + "value": "disable", + "description": "Disable the Job. This is equivalent to calling the disable Job API, with a disableTasks value of requeue." + }, + { + "value": "terminate", + "description": "Terminate the Job. The terminateReason in the Job's executionInfo is set to \"TaskFailed\"." + } + ] + } + }, + "dependencyAction": { + "type": "string", + "title": "An action that the Batch service performs on Tasks that depend on this Task.", + "description": "Possible values are 'satisfy' (allowing dependent tasks to progress) and 'block' (dependent tasks continue to wait). Batch does not yet support cancellation of dependent tasks.", + "enum": [ + "satisfy", + "block" + ], + "x-ms-enum": { + "name": "DependencyAction", + "modelAsString": false, + "values": [ + { + "value": "satisfy", + "description": "Satisfy tasks waiting on this task; once all dependencies are satisfied, the task will be scheduled to run." + }, + { + "value": "block", + "description": "Blocks tasks waiting on this task, preventing them from being scheduled." + } + ] + } + } + }, + "title": "Specifies how the Batch service responds to a particular exit condition." + }, + "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 StartTasks.", + "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 Compute 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." + }, + "UserIdentity": { + "type": "object", + "properties": { + "username": { + "type": "string", + "x-ms-client-name": "userName", + "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." + }, + "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 Compute 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 Compute Nodes (no modification of the user's .ssh directory is done)." + } + }, + "title": "Properties used to create a user Account on a Linux Compute Node." + }, + "WindowsUserConfiguration": { + "type": "object", + "properties": { + "loginMode": { + "type": "string", + "title": "The login mode for the user", + "description": "The default value for VirtualMachineConfiguration Pools is 'batch' and for CloudServiceConfiguration Pools is 'interactive'.", + "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. UAC is enabled on Windows VirtualMachineConfiguration Pools. If this option is used with an elevated user identity in a Windows VirtualMachineConfiguration Pool, the user session will not be elevated unless the application executed by the Task command line is configured to always require administrative privilege or to always require maximum privilege." + } + ] + } + } + }, + "title": "Properties used to create a user Account on a Windows Compute Node." + }, + "UserAccount": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "The name of the user Account." + }, + "password": { + "type": "string", + "title": "The password for the user Account." + }, + "elevationLevel": { + "title": "The elevation level of the user Account.", + "description": "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 used to execute Tasks on an Azure Batch Compute Node." + }, + "TaskConstraints": { + "type": "object", + "properties": { + "maxWallClockTime": { + "type": "string", + "format": "duration", + "title": "The maximum elapsed time that the Task may run, measured from the time the Task starts. If the Task does not complete within the time limit, the Batch service terminates it.", + "description": "If this is not specified, there is no time limit on how long the Task may run." + }, + "retentionTime": { + "type": "string", + "format": "duration", + "title": "The minimum time to retain the Task directory on the Compute Node where it ran, from the time it completes execution. After this time, the Batch service may delete the Task directory and all its contents.", + "description": "The default is 7 days, i.e. the Task directory will be retained for 7 days unless the Compute Node is removed or the Job is deleted." + }, + "maxTaskRetryCount": { + "type": "integer", + "format": "int32", + "title": "The maximum number of times the Task may be retried. The Batch service retries a Task if its exit code is nonzero.", + "description": "Note that this value specifically controls the number of retries for the Task executable due to a nonzero exit code. 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 after the first attempt. If the maximum retry count is -1, the Batch service retries the Task without limit." + } + }, + "title": "Execution constraints to apply to a Task." + }, + "JobManagerTask": { + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the Job Manager Task within the Job.", + "description": "The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters." + }, + "displayName": { + "type": "string", + "title": "The display name of the Job Manager Task.", + "description": "It need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "commandLine": { + "type": "string", + "title": "The command line of the Job Manager 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. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables)." + }, + "containerSettings": { + "$ref": "#/definitions/TaskContainerSettings", + "title": "The settings for the container under which the Job Manager Task runs.", + "description": "If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. 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. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files." + }, + "resourceFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "title": "A list of files that the Batch service will download to the Compute Node before running the command line.", + "description": "Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers." + }, + "outputFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/OutputFile" + }, + "title": "A list of files that the Batch service will upload from the Compute Node after running the command line.", + "description": "For multi-instance Tasks, the files will only be uploaded from the Compute Node on which the primary Task is executed." + }, + "environmentSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "title": "A list of environment variable settings for the Job Manager Task." + }, + "constraints": { + "$ref": "#/definitions/TaskConstraints", + "title": "Constraints that apply to the Job Manager Task." + }, + "requiredSlots": { + "type": "integer", + "format": "int32", + "title": "The number of scheduling slots that the Task requires to run.", + "description": "The default is 1. A Task can only be scheduled to run on a compute node if the node has enough free scheduling slots available. For multi-instance Tasks, this property is not supported and must not be specified." + }, + "killJobOnCompletion": { + "type": "boolean", + "title": "Whether completion of the Job Manager Task signifies completion of the entire Job.", + "description": "If true, when the Job Manager Task completes, the Batch service marks the Job as complete. If any Tasks are still running at this time (other than Job Release), those Tasks are terminated. If false, the completion of the Job Manager Task does not affect the Job status. In this case, you should either use the onAllTasksComplete attribute to terminate the Job, or have a client or user terminate the Job explicitly. An example of this is if the Job Manager creates a set of Tasks but then takes no further role in their execution. The default value is true. If you are using the onAllTasksComplete and onTaskFailure attributes to control Job lifetime, and using the Job Manager Task only to create the Tasks for the Job (not to monitor progress), then it is important to set killJobOnCompletion to false." + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "title": "The user identity under which the Job Manager Task runs.", + "description": "If omitted, the Task runs as a non-administrative user unique to the Task." + }, + "runExclusive": { + "type": "boolean", + "title": "Whether the Job Manager Task requires exclusive use of the Compute Node where it runs.", + "description": "If true, no other Tasks will run on the same Node for as long as the Job Manager is running. If false, other Tasks can run simultaneously with the Job Manager on a Compute Node. The Job Manager Task counts normally against the Compute Node's concurrent Task limit, so this is only relevant if the Compute Node allows multiple concurrent Tasks. The default value is true." + }, + "applicationPackageReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationPackageReference" + }, + "title": "A list of Application Packages that the Batch service will deploy to the Compute Node before running the command line.", + "description": "Application Packages are downloaded and deployed to a shared directory, not the Task working directory. Therefore, if a referenced Application Package is already on the Compute Node, and is up to date, then it is not re-downloaded; the existing copy on the Compute Node is used. If a referenced Application Package cannot be installed, for example because the package has been deleted or because download failed, the Task fails." + }, + "authenticationTokenSettings": { + "title": "The settings for an authentication token that the Task can use to perform Batch service operations.", + "description": "If this property is set, the Batch service provides the Task with an authentication token which can be used to authenticate Batch service operations without requiring an Account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the Task can carry out using the token depend on the settings. For example, a Task can request Job permissions in order to add other Tasks to the Job, or check the status of the Job or of other Tasks under the Job.", + "$ref": "#/definitions/AuthenticationTokenSettings" + }, + "allowLowPriorityNode": { + "type": "boolean", + "title": "Whether the Job Manager Task may run on a low-priority Compute Node.", + "description": "The default value is true." + } + }, + "required": [ + "id", + "commandLine" + ], + "title": "Specifies details of a Job Manager Task.", + "description": "The Job Manager Task is automatically started when the Job is created. The Batch service tries to schedule the Job Manager Task before any other Tasks in the Job. When shrinking a Pool, the Batch service tries to preserve Nodes where Job Manager Tasks are running for as long as possible (that is, Compute Nodes running 'normal' Tasks are removed before Compute Nodes running Job Manager Tasks). When a Job Manager Task fails and needs to be restarted, the system tries to schedule it at the highest priority. If there are no idle Compute Nodes available, the system may terminate one of the running Tasks in the Pool and return it to the queue in order to make room for the Job Manager Task to restart. Note that a Job Manager Task in one Job does not have priority over Tasks in other Jobs. Across Jobs, only Job level priorities are observed. For example, if a Job Manager in a priority 0 Job needs to be restarted, it will not displace Tasks of a priority 1 Job. Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing." + }, + "JobPreparationTask": { + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the Job Preparation Task within the Job.", + "description": "The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobpreparation'. No other Task in the Job can have the same ID as the Job Preparation Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobPreparationTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict)." + }, + "commandLine": { + "type": "string", + "title": "The command line of the Job Preparation 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. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables)." + }, + "containerSettings": { + "$ref": "#/definitions/TaskContainerSettings", + "title": "The settings for the container under which the Job Preparation 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. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files." + }, + "resourceFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "title": "A list of files that the Batch service will download to the Compute Node before running the command line.", + "description": "Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers." + }, + "environmentSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "title": "A list of environment variable settings for the Job Preparation Task." + }, + "constraints": { + "$ref": "#/definitions/TaskConstraints", + "title": "Constraints that apply to the Job Preparation Task." + }, + "waitForSuccess": { + "type": "boolean", + "title": "Whether the Batch service should wait for the Job Preparation Task to complete successfully before scheduling any other Tasks of the Job on the Compute Node. A Job Preparation Task has completed successfully if it exits with exit code 0.", + "description": "If true and the Job Preparation Task fails on a Node, the Batch service retries the Job Preparation Task up to its maximum retry count (as specified in the constraints element). If the Task has still not completed successfully after all retries, then the Batch service will not schedule Tasks of the Job to the Node. The Node remains active and eligible to run Tasks of other Jobs. If false, the Batch service will not wait for the Job Preparation Task to complete. In this case, other Tasks of the Job can start executing on the Compute Node while the Job Preparation Task is still running; and even if the Job Preparation Task fails, new Tasks will continue to be scheduled on the Compute Node. The default value is true." + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "title": "The user identity under which the Job Preparation Task runs.", + "description": "If omitted, the Task runs as a non-administrative user unique to the Task on Windows Compute Nodes, or a non-administrative user unique to the Pool on Linux Compute Nodes." + }, + "rerunOnNodeRebootAfterSuccess": { + "type": "boolean", + "title": "Whether the Batch service should rerun the Job Preparation Task after a Compute Node reboots.", + "description": "The Job Preparation Task is always rerun if a Compute Node is reimaged, or if the Job Preparation Task did not complete (e.g. because the reboot occurred while the Task was running). Therefore, you should always write a Job Preparation Task to be idempotent and to behave correctly if run multiple times. The default value is true." + } + }, + "required": [ + "commandLine" + ], + "title": "A Job Preparation Task to run before any Tasks of the Job on any given Compute Node.", + "description": "You can use Job Preparation to prepare a Node to run Tasks for the Job. Activities commonly performed in Job Preparation include: Downloading common resource files used by all the Tasks in the Job. The Job Preparation Task can download these common resource files to the shared location on the Node. (AZ_BATCH_NODE_ROOT_DIR\\shared), or starting a local service on the Node so that all Tasks of that Job can communicate with it. If the Job Preparation Task fails (that is, exhausts its retry count before exiting with exit code 0), Batch will not run Tasks of this Job on the Node. The Compute Node remains ineligible to run Tasks of this Job until it is reimaged. The Compute Node remains active and can be used for other Jobs. The Job Preparation Task can run multiple times on the same Node. Therefore, you should write the Job Preparation Task to handle re-execution. If the Node is rebooted, the Job Preparation Task is run again on the Compute Node before scheduling any other Task of the Job, if rerunOnNodeRebootAfterSuccess is true or if the Job Preparation Task did not previously complete. If the Node is reimaged, the Job Preparation Task is run again before scheduling any Task of the Job. Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing." + }, + "JobReleaseTask": { + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the Job Release Task within the Job.", + "description": "The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobrelease'. No other Task in the Job can have the same ID as the Job Release Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict)." + }, + "commandLine": { + "type": "string", + "title": "The command line of the Job Release 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. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables)." + }, + "containerSettings": { + "$ref": "#/definitions/TaskContainerSettings", + "title": "The settings for the container under which the Job Release 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. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files." + }, + "resourceFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "title": "A list of files that the Batch service will download to the Compute Node before running the command line. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.", + "description": "Files listed under this element are located in the Task's working directory." + }, + "environmentSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "title": "A list of environment variable settings for the Job Release Task." + }, + "maxWallClockTime": { + "type": "string", + "format": "duration", + "title": "The maximum elapsed time that the Job Release Task may run on a given Compute Node, measured from the time the Task starts. If the Task does not complete within the time limit, the Batch service terminates it. The default value is 15 minutes. You may not specify a timeout longer than 15 minutes. If you do, the Batch service rejects it with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "retentionTime": { + "type": "string", + "format": "duration", + "title": "The minimum time to retain the Task directory for the Job Release Task on the Compute Node. After this time, the Batch service may delete the Task directory and all its contents.", + "description": "The default is 7 days, i.e. the Task directory will be retained for 7 days unless the Compute Node is removed or the Job is deleted." + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "title": "The user identity under which the Job Release Task runs.", + "description": "If omitted, the Task runs as a non-administrative user unique to the Task." + } + }, + "required": [ + "commandLine" + ], + "title": "A Job Release Task to run on Job completion on any Compute Node where the Job has run.", + "description": "The Job Release Task runs when the Job ends, because of one of the following: The user calls the Terminate Job API, or the Delete Job API while the Job is still active, the Job's maximum wall clock time constraint is reached, and the Job is still active, or the Job's Job Manager Task completed, and the Job is configured to terminate when the Job Manager completes. The Job Release Task runs on each Node where Tasks of the Job have run and the Job Preparation Task ran and completed. If you reimage a Node after it has run the Job Preparation Task, and the Job ends without any further Tasks of the Job running on that Node (and hence the Job Preparation Task does not re-run), then the Job Release Task does not run on that Compute Node. If a Node reboots while the Job Release Task is still running, the Job Release Task runs again when the Compute Node starts up. The Job is not marked as complete until all Job Release Tasks have completed. The Job Release Task runs in the background. It does not occupy a scheduling slot; that is, it does not count towards the taskSlotsPerNode limit specified on the Pool." + }, + "TaskSchedulingPolicy": { + "type": "object", + "properties": { + "nodeFillType": { + "type": "string", + "title": "How Tasks are distributed across Compute Nodes in a Pool.", + "description": "If not specified, the default is spread.", + "enum": [ + "spread", + "pack" + ], + "x-ms-enum": { + "name": "ComputeNodeFillType", + "modelAsString": false, + "values": [ + { + "value": "spread", + "description": "Tasks should be assigned evenly across all Compute Nodes in the Pool." + }, + { + "value": "pack", + "description": "As many Tasks as possible (taskSlotsPerNode) should be assigned to each Compute Node in the Pool before any Tasks are assigned to the next Compute Node in the Pool." + } + ] + } + } + }, + "required": [ + "nodeFillType" + ], + "title": "Specifies how Tasks should be distributed across Compute Nodes." + }, + "StartTask": { + "type": "object", + "properties": { + "commandLine": { + "type": "string", + "title": "The command line of the StartTask.", + "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. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables)." + }, + "containerSettings": { + "$ref": "#/definitions/TaskContainerSettings", + "title": "The settings for the container under which the StartTask 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. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files." + }, + "resourceFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "title": "A list of files that the Batch service will download to the Compute Node before running the command line. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.", + "description": "Files listed under this element are located in the Task's working directory." + }, + "environmentSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "title": "A list of environment variable settings for the StartTask." + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "title": "The user identity under which the StartTask runs.", + "description": "If omitted, the Task runs as a non-administrative user unique to the Task." + }, + "maxTaskRetryCount": { + "type": "integer", + "format": "int32", + "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." + }, + "waitForSuccess": { + "type": "boolean", + "title": "Whether the Batch service should wait for the StartTask to complete successfully (that is, to exit with exit code 0) before scheduling any Tasks on the Compute Node.", + "description": "If true and the StartTask fails on a Node, the Batch service retries the StartTask up to its maximum retry count (maxTaskRetryCount). If the Task has still not completed successfully after all retries, then the Batch service marks the Node unusable, and will not schedule Tasks to it. This condition can be detected via the Compute Node state and failure info details. If false, the Batch service will not wait for the StartTask to complete. In this case, other Tasks can start executing on the Compute Node while the StartTask is still running; and even if the StartTask fails, new Tasks will continue to be scheduled on the Compute Node. The default is true." + } + }, + "required": [ + "commandLine" + ], + "title": "A Task which is run when a Node joins a Pool in the Azure Batch service, or when the Compute Node is rebooted or reimaged.", + "description": "Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing. In some cases the StartTask may be re-run even though the Compute Node was not rebooted. Special care should be taken to avoid StartTasks which create breakaway process or install/launch services from the StartTask working directory, as this will block Batch from being able to re-run the StartTask." + }, + "CertificateReference": { + "type": "object", + "properties": { + "thumbprint": { + "type": "string", + "title": "The thumbprint of the Certificate." + }, + "thumbprintAlgorithm": { + "type": "string", + "title": "The algorithm with which the thumbprint is associated. This must be sha1." + }, + "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 Compute 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.", + "name": "currentUser" + }, + { + "value": "localmachine", + "description": "Certificates should be installed to the LocalMachine Certificate store.", + "name": "localMachine" + } + ] + } + }, + "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 Compute 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 StartTask 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.", + "name": "startTask" + }, + { + "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 Compute Node.", + "name": "remoteUser" + } + ] + } + }, + "title": "Which user Accounts on the Compute Node should have access to the private data of the Certificate.", + "description": "You can specify more than one visibility in this collection. The default is all Accounts." + } + }, + "required": [ + "thumbprint", + "thumbprintAlgorithm" + ], + "title": "A reference to a Certificate to be installed on Compute Nodes in a Pool." + }, + "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." + }, + "PoolSpecification": { + "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." + }, + "vmSize": { + "type": "string", + "title": "The size of the virtual machines in the Pool. All virtual machines in a Pool are the same size.", + "description": "For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes)." + }, + "cloudServiceConfiguration": { + "$ref": "#/definitions/CloudServiceConfiguration", + "title": "The cloud service configuration for the Pool.", + "description": "This property must be specified if the Pool needs to be created with Azure PaaS VMs. This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. If neither is specified then the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). 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 must be specified if the Pool needs to be created with Azure IaaS VMs. This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified. If neither is specified then the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "taskSlotsPerNode": { + "type": "integer", + "format": "int32", + "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." + }, + "resizeTimeout": { + "type": "string", + "format": "duration", + "title": "The timeout for allocation of Compute Nodes to the Pool.", + "description": "This timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 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": "This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both." + }, + "targetLowPriorityNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of low-priority Compute Nodes in the Pool.", + "description": "This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both." + }, + "enableAutoScale": { + "type": "boolean", + "title": "Whether the Pool size should automatically adjust over time.", + "description": "If false, at least one of targetDedicatedNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula element is required. The Pool automatically resizes according to the formula. The default value is false." + }, + "autoScaleFormula": { + "type": "string", + "title": "The formula for the desired number of Compute Nodes in the Pool.", + "description": "This property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the Pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information." + }, + "autoScaleEvaluationInterval": { + "type": "string", + "format": "duration", + "title": "The time interval at which to automatically adjust the Pool size according to the autoscale formula.", + "description": "The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "enableInterNodeCommunication": { + "type": "boolean", + "title": "Whether the Pool permits direct communication between Compute Nodes.", + "description": "Enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching its desired size. The default value is false." + }, + "networkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration", + "title": "The network configuration for the Pool." + }, + "startTask": { + "$ref": "#/definitions/StartTask", + "title": "A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted." + }, + "certificateReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateReference" + }, + "title": "A list of Certificates to be installed on each Compute Node in the Pool.", + "description": "For Windows 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." + }, + "applicationPackageReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationPackageReference" + }, + "title": "The list of Packages to be installed on each Compute Node in the Pool.", + "description": "Changes to Package references affect all new 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 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. The permitted licenses available on the Pool are 'maya', 'vray', '3dsmax', 'arnold'. An additional charge applies for each application license added to the Pool." + }, + "userAccounts": { + "type": "array", + "items": { + "$ref": "#/definitions/UserAccount" + }, + "title": "The list of user Accounts to be created on each Compute Node in the Pool." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "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." + }, + "mountConfiguration": { + "type": "array", + "items": { + "$ref": "#/definitions/MountConfiguration" + }, + "title": "A list of file systems to mount on each node in the pool.", + "description": "This supports Azure Files, NFS, CIFS/SMB, and Blobfuse." + } + }, + "required": [ + "vmSize" + ], + "title": "Specification for creating a new Pool." + }, + "AutoPoolSpecification": { + "type": "object", + "properties": { + "autoPoolIdPrefix": { + "type": "string", + "title": "A prefix to be added to the unique identifier when a Pool is automatically created.", + "description": "The Batch service assigns each auto Pool a unique identifier on creation. To distinguish between Pools created for different purposes, you can specify this element to add a prefix to the ID that is assigned. The prefix can be up to 20 characters long." + }, + "poolLifetimeOption": { + "type": "string", + "title": "The minimum lifetime of created auto Pools, and how multiple Jobs on a schedule are assigned to Pools.", + "enum": [ + "jobschedule", + "job" + ], + "x-ms-enum": { + "name": "PoolLifetimeOption", + "modelAsString": false, + "values": [ + { + "value": "jobschedule", + "description": "The Pool exists for the lifetime of the Job Schedule. The Batch Service creates the Pool when it creates the first Job on the schedule. You may apply this option only to Job Schedules, not to Jobs.", + "name": "jobSchedule" + }, + { + "value": "job", + "description": "The Pool exists for the lifetime of the Job to which it is dedicated. The Batch service creates the Pool when it creates the Job. If the 'job' option is applied to a Job Schedule, the Batch service creates a new auto Pool for every Job created on the schedule." + } + ] + } + }, + "keepAlive": { + "type": "boolean", + "title": "Whether to keep an auto Pool alive after its lifetime expires.", + "description": "If false, the Batch service deletes the Pool once its lifetime (as determined by the poolLifetimeOption setting) expires; that is, when the Job or Job Schedule completes. If true, the Batch service does not delete the Pool automatically. It is up to the user to delete auto Pools created with this option." + }, + "pool": { + "$ref": "#/definitions/PoolSpecification", + "title": "The Pool specification for the auto Pool." + } + }, + "required": [ + "poolLifetimeOption" + ], + "title": "Specifies characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted." + }, + "PoolInformation": { + "type": "object", + "properties": { + "poolId": { + "type": "string", + "title": "The ID of an existing Pool. All the Tasks of the Job will run on the specified Pool.", + "description": "You must ensure that the Pool referenced by this property exists. If the Pool does not exist at the time the Batch service tries to schedule a Job, no Tasks for the Job will run until you create a Pool with that id. Note that the Batch service will not reject the Job request; it will simply not run Tasks until the Pool exists. You must specify either the Pool ID or the auto Pool specification, but not both." + }, + "autoPoolSpecification": { + "$ref": "#/definitions/AutoPoolSpecification", + "title": "Characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted.", + "description": "If auto Pool creation fails, the Batch service moves the Job to a completed state, and the Pool creation error is set in the Job's scheduling error property. The Batch service manages the lifetime (both creation and, unless keepAlive is specified, deletion) of the auto Pool. Any user actions that affect the lifetime of the auto Pool while the Job is active will result in unexpected behavior. You must specify either the Pool ID or the auto Pool specification, but not both." + } + }, + "title": "Specifies how a Job should be assigned to a Pool." + }, + "JobSpecification": { + "type": "object", + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "title": "The priority of Jobs created under this schedule.", + "description": "Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0. This priority is used as the default for all Jobs under the Job Schedule. You can update a Job's priority after it has been created using by using the update Job API." + }, + "maxParallelTasks": { + "type": "integer", + "format": "int32", + "default": -1, + "title": "The maximum number of tasks that can be executed in parallel for the job.", + "description": "The value of maxParallelTasks must be -1 or greater than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API." + }, + "displayName": { + "type": "string", + "title": "The display name for Jobs created under this schedule.", + "description": "The name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "usesTaskDependencies": { + "type": "boolean", + "title": "Whether Tasks in the Job can define dependencies on each other. The default is false." + }, + "onAllTasksComplete": { + "title": "The action the Batch service should take when all Tasks in a Job created under this schedule are in the completed state.", + "description": "Note that if a Job contains no Tasks, then all Tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic Job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the Job properties to set onAllTasksComplete to terminatejob once you have finished adding Tasks. The default is noaction.", + "$ref": "#/definitions/OnAllTasksComplete" + }, + "onTaskFailure": { + "title": "The action the Batch service should take when any Task fails in a Job created under this schedule. A Task is considered to have failed if it have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error.", + "description": "The default is noaction.", + "$ref": "#/definitions/OnTaskFailure" + }, + "networkConfiguration": { + "$ref": "#/definitions/JobNetworkConfiguration", + "title": "The network configuration for the Job." + }, + "constraints": { + "$ref": "#/definitions/JobConstraints", + "title": "The execution constraints for Jobs created under this schedule." + }, + "jobManagerTask": { + "$ref": "#/definitions/JobManagerTask", + "title": "The details of a Job Manager Task to be launched when a Job is started under this schedule.", + "description": "If the Job does not specify a Job Manager Task, the user must explicitly add Tasks to the Job using the Task API. If the Job does specify a Job Manager Task, the Batch service creates the Job Manager Task when the Job is created, and will try to schedule the Job Manager Task before scheduling other Tasks in the Job." + }, + "jobPreparationTask": { + "$ref": "#/definitions/JobPreparationTask", + "title": "The Job Preparation Task for Jobs created under this schedule.", + "description": "If a Job has a Job Preparation Task, the Batch service will run the Job Preparation Task on a Node before starting any Tasks of that Job on that Compute Node." + }, + "jobReleaseTask": { + "$ref": "#/definitions/JobReleaseTask", + "title": "The Job Release Task for Jobs created under this schedule.", + "description": "The primary purpose of the Job Release Task is to undo changes to Nodes made by the Job Preparation Task. Example activities include deleting local files, or shutting down services that were started as part of Job preparation. A Job Release Task cannot be specified without also specifying a Job Preparation Task for the Job. The Batch service runs the Job Release Task on the Compute Nodes that have run the Job Preparation Task." + }, + "commonEnvironmentSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "title": "A list of common environment variable settings. These environment variables are set for all Tasks in Jobs created under this schedule (including the Job Manager, Job Preparation and Job Release Tasks).", + "description": "Individual Tasks can override an environment setting specified here by specifying the same setting name with a different value." + }, + "poolInfo": { + "$ref": "#/definitions/PoolInformation", + "title": "The Pool on which the Batch service runs the Tasks of Jobs created under this schedule." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with each Job created under this schedule as metadata.", + "description": "The Batch service does not assign any meaning to metadata; it is solely for the use of user code." + } + }, + "required": [ + "poolInfo" + ], + "title": "Specifies details of the Jobs to be created on a schedule." + }, + "RecentJob": { + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "The ID of the Job." + }, + "url": { + "type": "string", + "title": "The URL of the Job." + } + }, + "title": "Information about the most recent Job to run under the Job Schedule." + }, + "JobScheduleExecutionInformation": { + "type": "object", + "properties": { + "nextRunTime": { + "type": "string", + "format": "date-time", + "title": "The next time at which a Job will be created under this schedule.", + "description": "This property is meaningful only if the schedule is in the active state when the time comes around. For example, if the schedule is disabled, no Job will be created at nextRunTime unless the Job is enabled before then." + }, + "recentJob": { + "$ref": "#/definitions/RecentJob", + "title": "Information about the most recent Job under the Job Schedule.", + "description": "This property is present only if the at least one Job has run under the schedule." + }, + "endTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the schedule ended.", + "description": "This property is set only if the Job Schedule is in the completed state." + } + }, + "title": "Contains information about Jobs that have been and will be run under a Job Schedule." + }, + "JobScheduleStatistics": { + "type": "object", + "properties": { + "url": { + "type": "string", + "title": "The URL of the statistics." + }, + "startTime": { + "type": "string", + "format": "date-time", + "title": "The start time of the time range covered by the statistics." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime." + }, + "userCPUTime": { + "type": "string", + "format": "duration", + "title": "The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in all Jobs created under the schedule." + }, + "kernelCPUTime": { + "type": "string", + "format": "duration", + "title": "The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in all Jobs created under the schedule." + }, + "wallClockTime": { + "type": "string", + "format": "duration", + "title": "The total wall clock time of all the Tasks in all the Jobs created under the schedule.", + "description": "The wall clock time is the elapsed time from when the Task started running on a Compute Node to when it finished (or to the last time the statistics were updated, if the Task had not finished by then). If a Task was retried, this includes the wall clock time of all the Task retries." + }, + "readIOps": { + "type": "integer", + "format": "int64", + "title": "The total number of disk read operations made by all Tasks in all Jobs created under the schedule." + }, + "writeIOps": { + "type": "integer", + "format": "int64", + "title": "The total number of disk write operations made by all Tasks in all Jobs created under the schedule." + }, + "readIOGiB": { + "type": "number", + "format": "double", + "title": "The total gibibytes read from disk by all Tasks in all Jobs created under the schedule." + }, + "writeIOGiB": { + "type": "number", + "format": "double", + "title": "The total gibibytes written to disk by all Tasks in all Jobs created under the schedule." + }, + "numSucceededTasks": { + "type": "integer", + "format": "int64", + "title": "The total number of Tasks successfully completed during the given time range in Jobs created under the schedule. A Task completes successfully if it returns exit code 0." + }, + "numFailedTasks": { + "type": "integer", + "format": "int64", + "title": "The total number of Tasks that failed during the given time range in Jobs created under the schedule. A Task fails if it exhausts its maximum retry count without returning exit code 0." + }, + "numTaskRetries": { + "type": "integer", + "format": "int64", + "title": "The total number of retries during the given time range on all Tasks in all Jobs created under the schedule." + }, + "waitTime": { + "type": "string", + "format": "duration", + "title": "The total wait time of all Tasks in all Jobs created under the schedule. The wait time for a Task is defined as the elapsed time between the creation of the Task and the start of Task execution. (If the Task is retried due to failures, the wait time is the time to the most recent Task execution.)", + "description": "This value is only reported in the Account lifetime statistics; it is not included in the Job statistics." + } + }, + "required": [ + "url", + "startTime", + "lastUpdateTime", + "userCPUTime", + "kernelCPUTime", + "wallClockTime", + "readIOps", + "writeIOps", + "readIOGiB", + "writeIOGiB", + "numSucceededTasks", + "numFailedTasks", + "numTaskRetries", + "waitTime" + ], + "title": "Resource usage statistics for a Job Schedule." + }, + "CloudJobSchedule": { + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the schedule within the Account." + }, + "displayName": { + "type": "string", + "title": "The display name for the schedule." + }, + "url": { + "type": "string", + "title": "The URL of the Job Schedule." + }, + "eTag": { + "type": "string", + "title": "The ETag of the Job Schedule.", + "description": "This is an opaque string. You can use it to detect whether the Job Schedule has changed between requests. In particular, you can be pass the ETag with an Update Job Schedule request to specify that your changes should take effect only if nobody else has modified the schedule in the meantime." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "title": "The last modified time of the Job Schedule.", + "description": "This is the last time at which the schedule level data, such as the Job specification or recurrence information, changed. It does not factor in job-level changes such as new Jobs being created or Jobs changing state." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "title": "The creation time of the Job Schedule." + }, + "state": { + "title": "The current state of the Job Schedule.", + "$ref": "#/definitions/JobScheduleState" + }, + "stateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Job Schedule entered the current state." + }, + "previousState": { + "title": "The previous state of the Job Schedule.", + "description": "This property is not present if the Job Schedule is in its initial active state.", + "$ref": "#/definitions/JobScheduleState" + }, + "previousStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Job Schedule entered its previous state.", + "description": "This property is not present if the Job Schedule is in its initial active state." + }, + "schedule": { + "$ref": "#/definitions/Schedule", + "title": "The schedule according to which Jobs will be created." + }, + "jobSpecification": { + "$ref": "#/definitions/JobSpecification", + "title": "The details of the Jobs to be created on this schedule." + }, + "executionInfo": { + "$ref": "#/definitions/JobScheduleExecutionInformation", + "title": "Information about Jobs that have been and will be run under this schedule." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the schedule as metadata.", + "description": "The Batch service does not assign any meaning to metadata; it is solely for the use of user code." + }, + "stats": { + "$ref": "#/definitions/JobScheduleStatistics", + "title": "The lifetime resource usage statistics for the Job Schedule. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes." + } + }, + "title": "A Job Schedule that allows recurring Jobs by specifying when to run Jobs and a specification used to create each Job." + }, + "JobScheduleAddParameter": { + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the schedule within the Account.", + "description": "The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case)." + }, + "displayName": { + "type": "string", + "title": "The display name for the schedule.", + "description": "The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "schedule": { + "$ref": "#/definitions/Schedule", + "title": "The schedule according to which Jobs will be created." + }, + "jobSpecification": { + "$ref": "#/definitions/JobSpecification", + "title": "The details of the Jobs to be created on this schedule." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the schedule as metadata.", + "description": "The Batch service does not assign any meaning to metadata; it is solely for the use of user code." + } + }, + "required": [ + "id", + "schedule", + "jobSpecification" + ], + "title": "A Job Schedule that allows recurring Jobs by specifying when to run Jobs and a specification used to create each Job." + }, + "CloudJobScheduleListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudJobSchedule" + }, + "title": "The list of Job Schedules." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the Job Schedules in an Account." + }, + "JobSchedulingError": { + "type": "object", + "properties": { + "category": { + "title": "The category of the Job scheduling error.", + "$ref": "#/definitions/ErrorCategory" + }, + "code": { + "type": "string", + "title": "An identifier for the Job scheduling error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "title": "A message describing the Job scheduling error, intended to be suitable for display in a user interface." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/NameValuePair" + }, + "title": "A list of additional error details related to the scheduling error." + } + }, + "required": [ + "category" + ], + "title": "An error encountered by the Batch service when scheduling a Job." + }, + "JobExecutionInformation": { + "type": "object", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "title": "The start time of the Job.", + "description": "This is the time at which the Job was created." + }, + "endTime": { + "type": "string", + "format": "date-time", + "title": "The completion time of the Job.", + "description": "This property is set only if the Job is in the completed state." + }, + "poolId": { + "type": "string", + "title": "The ID of the Pool to which this Job is assigned.", + "description": "This element contains the actual Pool where the Job is assigned. When you get Job details from the service, they also contain a poolInfo element, which contains the Pool configuration data from when the Job was added or updated. That poolInfo element may also contain a poolId element. If it does, the two IDs are the same. If it does not, it means the Job ran on an auto Pool, and this property contains the ID of that auto Pool." + }, + "schedulingError": { + "$ref": "#/definitions/JobSchedulingError", + "title": "Details of any error encountered by the service in starting the Job.", + "description": "This property is not set if there was no error starting the Job." + }, + "terminateReason": { + "type": "string", + "title": "A string describing the reason the Job ended.", + "description": "This property is set only if the Job is in the completed state. If the Batch service terminates the Job, it sets the reason as follows: JMComplete - the Job Manager Task completed, and killJobOnCompletion was set to true. MaxWallClockTimeExpiry - the Job reached its maxWallClockTime constraint. TerminateJobSchedule - the Job ran as part of a schedule, and the schedule terminated. AllTasksComplete - the Job's onAllTasksComplete attribute is set to terminatejob, and all Tasks in the Job are complete. TaskFailed - the Job's onTaskFailure attribute is set to performExitOptionsJobAction, and a Task in the Job failed with an exit condition that specified a jobAction of terminatejob. Any other string is a user-defined reason specified in a call to the 'Terminate a Job' operation." + } + }, + "required": [ + "startTime" + ], + "title": "Contains information about the execution of a Job in the Azure Batch service." + }, + "CloudJob": { + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the Job within the Account.", + "description": "The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case)." + }, + "displayName": { + "type": "string", + "title": "The display name for the Job." + }, + "usesTaskDependencies": { + "type": "boolean", + "title": "Whether Tasks in the Job can define dependencies on each other. The default is false." + }, + "url": { + "type": "string", + "title": "The URL of the Job." + }, + "eTag": { + "type": "string", + "title": "The ETag of the Job.", + "description": "This is an opaque string. You can use it to detect whether the Job has changed between requests. In particular, you can be pass the ETag when updating a Job to specify that your changes should take effect only if nobody else has modified the Job in the meantime." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "title": "The last modified time of the Job.", + "description": "This is the last time at which the Job level data, such as the Job state or priority, changed. It does not factor in task-level changes such as adding new Tasks or Tasks changing state." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "title": "The creation time of the Job." + }, + "state": { + "title": "The current state of the Job.", + "$ref": "#/definitions/JobState" + }, + "stateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Job entered its current state." + }, + "previousState": { + "title": "The previous state of the Job.", + "description": "This property is not set if the Job is in its initial Active state.", + "$ref": "#/definitions/JobState" + }, + "previousStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Job entered its previous state.", + "description": "This property is not set if the Job is in its initial Active state." + }, + "priority": { + "type": "integer", + "format": "int32", + "title": "The priority of the Job.", + "description": "Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0." + }, + "maxParallelTasks": { + "type": "integer", + "format": "int32", + "default": -1, + "title": "The maximum number of tasks that can be executed in parallel for the job.", + "description": "The value of maxParallelTasks must be -1 or greater than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API." + }, + "constraints": { + "$ref": "#/definitions/JobConstraints", + "title": "The execution constraints for the Job." + }, + "jobManagerTask": { + "$ref": "#/definitions/JobManagerTask", + "title": "Details of a Job Manager Task to be launched when the Job is started." + }, + "jobPreparationTask": { + "$ref": "#/definitions/JobPreparationTask", + "title": "The Job Preparation Task.", + "description": "The Job Preparation Task is a special Task run on each Compute Node before any other Task of the Job." + }, + "jobReleaseTask": { + "$ref": "#/definitions/JobReleaseTask", + "title": "The Job Release Task.", + "description": "The Job Release Task is a special Task run at the end of the Job on each Compute Node that has run any other Task of the Job." + }, + "commonEnvironmentSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "title": "The list of common environment variable settings. These environment variables are set for all Tasks in the Job (including the Job Manager, Job Preparation and Job Release Tasks).", + "description": "Individual Tasks can override an environment setting specified here by specifying the same setting name with a different value." + }, + "poolInfo": { + "$ref": "#/definitions/PoolInformation", + "title": "The Pool settings associated with the Job." + }, + "onAllTasksComplete": { + "title": "The action the Batch service should take when all Tasks in the Job are in the completed state.", + "description": "The default is noaction.", + "$ref": "#/definitions/OnAllTasksComplete" + }, + "onTaskFailure": { + "title": "The action the Batch service should take when any Task in the Job fails.", + "description": "A Task is considered to have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error. The default is noaction.", + "$ref": "#/definitions/OnTaskFailure" + }, + "networkConfiguration": { + "$ref": "#/definitions/JobNetworkConfiguration", + "title": "The network configuration for the Job." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the Job as metadata.", + "description": "The Batch service does not assign any meaning to metadata; it is solely for the use of user code." + }, + "executionInfo": { + "$ref": "#/definitions/JobExecutionInformation", + "title": "The execution information for the Job." + }, + "stats": { + "$ref": "#/definitions/JobStatistics", + "title": "Resource usage statistics for the entire lifetime of the Job.", + "description": "This property is populated only if the CloudJob was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes." + } + }, + "title": "An Azure Batch Job." + }, + "JobAddParameter": { + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the Job within the Account.", + "description": "The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case)." + }, + "displayName": { + "type": "string", + "title": "The display name for the Job.", + "description": "The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "priority": { + "type": "integer", + "format": "int32", + "title": "The priority of the Job.", + "description": "Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0." + }, + "maxParallelTasks": { + "type": "integer", + "format": "int32", + "default": -1, + "title": "The maximum number of tasks that can be executed in parallel for the job.", + "description": "The value of maxParallelTasks must be -1 or greater than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API." + }, + "constraints": { + "$ref": "#/definitions/JobConstraints", + "description": "The execution constraints for the Job." + }, + "jobManagerTask": { + "$ref": "#/definitions/JobManagerTask", + "title": "Details of a Job Manager Task to be launched when the Job is started.", + "description": "If the Job does not specify a Job Manager Task, the user must explicitly add Tasks to the Job. If the Job does specify a Job Manager Task, the Batch service creates the Job Manager Task when the Job is created, and will try to schedule the Job Manager Task before scheduling other Tasks in the Job. The Job Manager Task's typical purpose is to control and/or monitor Job execution, for example by deciding what additional Tasks to run, determining when the work is complete, etc. (However, a Job Manager Task is not restricted to these activities - it is a fully-fledged Task in the system and perform whatever actions are required for the Job.) For example, a Job Manager Task might download a file specified as a parameter, analyze the contents of that file and submit additional Tasks based on those contents." + }, + "jobPreparationTask": { + "$ref": "#/definitions/JobPreparationTask", + "title": "The Job Preparation Task.", + "description": "If a Job has a Job Preparation Task, the Batch service will run the Job Preparation Task on a Node before starting any Tasks of that Job on that Compute Node." + }, + "jobReleaseTask": { + "$ref": "#/definitions/JobReleaseTask", + "title": "The Job Release Task.", + "description": "A Job Release Task cannot be specified without also specifying a Job Preparation Task for the Job. The Batch service runs the Job Release Task on the Nodes that have run the Job Preparation Task. The primary purpose of the Job Release Task is to undo changes to Compute Nodes made by the Job Preparation Task. Example activities include deleting local files, or shutting down services that were started as part of Job preparation." + }, + "commonEnvironmentSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "title": "The list of common environment variable settings. These environment variables are set for all Tasks in the Job (including the Job Manager, Job Preparation and Job Release Tasks).", + "description": "Individual Tasks can override an environment setting specified here by specifying the same setting name with a different value." + }, + "poolInfo": { + "$ref": "#/definitions/PoolInformation", + "title": "The Pool on which the Batch service runs the Job's Tasks." + }, + "onAllTasksComplete": { + "title": "The action the Batch service should take when all Tasks in the Job are in the completed state.", + "description": "Note that if a Job contains no Tasks, then all Tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic Job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the Job properties to set onAllTasksComplete to terminatejob once you have finished adding Tasks. The default is noaction.", + "$ref": "#/definitions/OnAllTasksComplete" + }, + "onTaskFailure": { + "title": "The action the Batch service should take when any Task in the Job fails.", + "description": "A Task is considered to have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error. The default is noaction.", + "$ref": "#/definitions/OnTaskFailure" + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the Job as metadata.", + "description": "The Batch service does not assign any meaning to metadata; it is solely for the use of user code." + }, + "usesTaskDependencies": { + "type": "boolean", + "title": "Whether Tasks in the Job can define dependencies on each other. The default is false." + }, + "networkConfiguration": { + "$ref": "#/definitions/JobNetworkConfiguration", + "title": "The network configuration for the Job." + } + }, + "required": [ + "id", + "poolInfo" + ], + "title": "An Azure Batch Job to add." + }, + "CloudJobListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudJob" + }, + "title": "The list of Jobs." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the Jobs in an Account." + }, + "TaskContainerExecutionInformation": { + "type": "object", + "properties": { + "containerId": { + "type": "string", + "title": "The ID of the container." + }, + "state": { + "type": "string", + "title": "The state of the container.", + "description": "This is the state of the container according to the Docker service. It is equivalent to the status field returned by \"docker inspect\"." + }, + "error": { + "type": "string", + "title": "Detailed error information about the container.", + "description": "This is the detailed error string from the Docker service, if available. It is equivalent to the error field returned by \"docker inspect\"." + } + }, + "title": "Contains information about the container which a Task is executing." + }, + "TaskFailureInformation": { + "type": "object", + "properties": { + "category": { + "title": "The category of the Task error.", + "$ref": "#/definitions/ErrorCategory" + }, + "code": { + "type": "string", + "title": "An identifier for the Task error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "title": "A message describing the Task error, intended to be suitable for display in a user interface." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/NameValuePair" + }, + "title": "A list of additional details related to the error." + } + }, + "required": [ + "category" + ], + "title": "Information about a Task failure." + }, + "JobPreparationTaskExecutionInformation": { + "type": "object", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Task started running.", + "description": "If the Task has been restarted or retried, this is the most recent time at which the Task started running." + }, + "endTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Job Preparation Task completed.", + "description": "This property is set only if the Task is in the Completed state." + }, + "state": { + "type": "string", + "title": "The current state of the Job Preparation Task on the Compute Node.", + "enum": [ + "running", + "completed" + ], + "x-ms-enum": { + "name": "JobPreparationTaskState", + "modelAsString": false, + "values": [ + { + "value": "running", + "description": "The Task is currently running (including retrying)." + }, + { + "value": "completed", + "description": "The Task has exited with exit code 0, or the Task has exhausted its retry limit, or the Batch service was unable to start the Task due to Task preparation errors (such as resource file download failures)." + } + ] + } + }, + "taskRootDirectory": { + "type": "string", + "title": "The root directory of the Job Preparation Task on the Compute Node. You can use this path to retrieve files created by the Task, such as log files." + }, + "taskRootDirectoryUrl": { + "type": "string", + "title": "The URL to the root directory of the Job Preparation Task on the Compute Node." + }, + "exitCode": { + "type": "integer", + "format": "int32", + "title": "The exit code of the program specified on the Task command line.", + "description": "This parameter is returned only if the Task is in the completed state. The exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. Note that the exit code may also be generated by the Compute Node operating system, such as when a process is forcibly terminated." + }, + "containerInfo": { + "$ref": "#/definitions/TaskContainerExecutionInformation", + "title": "Information about the container under which the Task is executing.", + "description": "This property is set only if the Task runs in a container context." + }, + "failureInfo": { + "$ref": "#/definitions/TaskFailureInformation", + "title": "Information describing the Task failure, if any.", + "description": "This property is set only if the Task is in the completed state and encountered a failure." + }, + "retryCount": { + "type": "integer", + "format": "int32", + "title": "The number of times the Task has been retried by the Batch service. Task application failures (non-zero exit code) are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch service will retry the Task up to the limit specified by the constraints.", + "description": "Task application failures (non-zero exit code) are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch service will retry the Task up to the limit specified by the constraints." + }, + "lastRetryTime": { + "type": "string", + "format": "date-time", + "title": "The most recent time at which a retry of the Job Preparation Task started running.", + "description": "This property is set only if the Task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the Task has been restarted for reasons other than retry; for example, if the Compute Node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not." + }, + "result": { + "$ref": "#/definitions/TaskExecutionResult", + "title": "The result of the Task execution.", + "description": "If the value is 'failed', then the details of the failure can be found in the failureInfo property." + } + }, + "required": [ + "startTime", + "retryCount", + "state" + ], + "title": "Contains information about the execution of a Job Preparation Task on a Compute Node." + }, + "JobReleaseTaskExecutionInformation": { + "type": "object", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Task started running.", + "description": "If the Task has been restarted or retried, this is the most recent time at which the Task started running." + }, + "endTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Job Release Task completed.", + "description": "This property is set only if the Task is in the Completed state." + }, + "state": { + "type": "string", + "title": "The current state of the Job Release Task on the Compute Node.", + "enum": [ + "running", + "completed" + ], + "x-ms-enum": { + "name": "JobReleaseTaskState", + "modelAsString": false, + "values": [ + { + "value": "running", + "description": "The Task is currently running (including retrying)." + }, + { + "value": "completed", + "description": "The Task has exited with exit code 0, or the Task has exhausted its retry limit, or the Batch service was unable to start the Task due to Task preparation errors (such as resource file download failures)." + } + ] + } + }, + "taskRootDirectory": { + "type": "string", + "title": "The root directory of the Job Release Task on the Compute Node. You can use this path to retrieve files created by the Task, such as log files." + }, + "taskRootDirectoryUrl": { + "type": "string", + "title": "The URL to the root directory of the Job Release Task on the Compute Node." + }, + "exitCode": { + "type": "integer", + "format": "int32", + "title": "The exit code of the program specified on the Task command line.", + "description": "This parameter is returned only if the Task is in the completed state. The exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. Note that the exit code may also be generated by the Compute Node operating system, such as when a process is forcibly terminated." + }, + "containerInfo": { + "$ref": "#/definitions/TaskContainerExecutionInformation", + "title": "Information about the container under which the Task is executing.", + "description": "This property is set only if the Task runs in a container context." + }, + "failureInfo": { + "$ref": "#/definitions/TaskFailureInformation", + "title": "Information describing the Task failure, if any.", + "description": "This property is set only if the Task is in the completed state and encountered a failure." + }, + "result": { + "$ref": "#/definitions/TaskExecutionResult", + "title": "The result of the Task execution.", + "description": "If the value is 'failed', then the details of the failure can be found in the failureInfo property." + } + }, + "required": [ + "startTime", + "state" + ], + "title": "Contains information about the execution of a Job Release Task on a Compute Node." + }, + "JobPreparationAndReleaseTaskExecutionInformation": { + "type": "object", + "properties": { + "poolId": { + "type": "string", + "title": "The ID of the Pool containing the Compute Node to which this entry refers." + }, + "nodeId": { + "type": "string", + "title": "The ID of the Compute Node to which this entry refers." + }, + "nodeUrl": { + "type": "string", + "title": "The URL of the Compute Node to which this entry refers." + }, + "jobPreparationTaskExecutionInfo": { + "$ref": "#/definitions/JobPreparationTaskExecutionInformation", + "title": "Information about the execution status of the Job Preparation Task on this Compute Node." + }, + "jobReleaseTaskExecutionInfo": { + "$ref": "#/definitions/JobReleaseTaskExecutionInformation", + "title": "Information about the execution status of the Job Release Task on this Compute Node.", + "description": "This property is set only if the Job Release Task has run on the Compute Node." + } + }, + "title": "The status of the Job Preparation and Job Release Tasks on a Compute Node." + }, + "CloudJobListPreparationAndReleaseTaskStatusResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/JobPreparationAndReleaseTaskExecutionInformation" + }, + "title": "A list of Job Preparation and Job Release Task execution information." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the status of the Job Preparation and Job Release Tasks for a Job." + }, + "TaskCountsResult": { + "type": "object", + "properties": { + "taskCounts": { + "$ref": "#/definitions/TaskCounts", + "title": "The number of Tasks per state." + }, + "taskSlotCounts": { + "$ref": "#/definitions/TaskSlotCounts", + "title": "The number of TaskSlots required by Tasks per state." + } + }, + "required": [ + "taskCounts", + "taskSlotCounts" + ], + "title": "The Task and TaskSlot counts for a Job." + }, + "TaskCounts": { + "type": "object", + "properties": { + "active": { + "type": "integer", + "format": "int32", + "title": "The number of Tasks in the active state." + }, + "running": { + "type": "integer", + "format": "int32", + "title": "The number of Tasks in the running or preparing state." + }, + "completed": { + "type": "integer", + "format": "int32", + "title": "The number of Tasks in the completed state." + }, + "succeeded": { + "type": "integer", + "format": "int32", + "title": "The number of Tasks which succeeded. A Task succeeds if its result (found in the executionInfo property) is 'success'." + }, + "failed": { + "type": "integer", + "format": "int32", + "title": "The number of Tasks which failed. A Task fails if its result (found in the executionInfo property) is 'failure'." + } + }, + "required": [ + "active", + "running", + "completed", + "succeeded", + "failed" + ], + "title": "The Task counts for a Job." + }, + "TaskSlotCounts": { + "type": "object", + "properties": { + "active": { + "type": "integer", + "format": "int32", + "title": "The number of TaskSlots for active Tasks." + }, + "running": { + "type": "integer", + "format": "int32", + "title": "The number of TaskSlots for running Tasks." + }, + "completed": { + "type": "integer", + "format": "int32", + "title": "The number of TaskSlots for completed Tasks." + }, + "succeeded": { + "type": "integer", + "format": "int32", + "title": "The number of TaskSlots for succeeded Tasks." + }, + "failed": { + "type": "integer", + "format": "int32", + "title": "The number of TaskSlots for failed Tasks." + } + }, + "required": [ + "active", + "running", + "completed", + "succeeded", + "failed" + ], + "title": "The TaskSlot counts for a Job." + }, + "AutoScaleRunError": { + "type": "object", + "properties": { + "code": { + "type": "string", + "title": "An identifier for the autoscale error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "title": "A message describing the autoscale error, intended to be suitable for display in a user interface." + }, + "values": { + "type": "array", + "items": { + "$ref": "#/definitions/NameValuePair" + }, + "title": "A list of additional error details related to the autoscale error." + } + }, + "title": "An error that occurred when executing or evaluating a Pool autoscale formula." + }, + "AutoScaleRun": { + "type": "object", + "properties": { + "timestamp": { + "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": [ + "timestamp" + ], + "title": "The results and errors from an execution of a Pool autoscale formula." + }, + "ResizeError": { + "type": "object", + "properties": { + "code": { + "type": "string", + "title": "An identifier for the Pool resize error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "title": "A message describing the Pool resize error, intended to be suitable for display in a user interface." + }, + "values": { + "type": "array", + "items": { + "$ref": "#/definitions/NameValuePair" + }, + "title": "A list of additional error details related to the Pool resize error." + } + }, + "title": "An error that occurred when resizing 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:\n2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1.\n3 - OS Family 3, equivalent to Windows Server 2012.\n4 - OS Family 4, equivalent to Windows Server 2012 R2.\n5 - OS Family 5, equivalent to Windows Server 2016.\n6 - 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 Compute Nodes in a Pool based on the Azure Cloud Services platform." + }, + "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 2019-Datacenter." + }, + "version": { + "type": "string", + "title": "The version of the Azure Virtual Machines Marketplace Image.", + "description": "A value of 'latest' can be specified to select the latest version of an Image. If omitted, the default is 'latest'." + }, + "virtualMachineImageId": { + "type": "string", + "title": "The ARM resource identifier of the Shared Image 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} or /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} for always defaulting to the latest image version.", + "description": "This property is mutually exclusive with other ImageReference properties. The Shared Image Gallery Image must have replicas in the same region and must be in the same subscription as the Azure Batch account. If the image version is not specified in the imageId, the latest version will be used. For information about the firewall settings for the Batch Compute 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." + }, + "exactVersion": { + "type": "string", + "readOnly": true, + "description": "The specific version of the platform image or marketplace image used to create the node. This read-only field differs from 'version' only if the value specified for 'version' when the pool was created was 'latest'." + } + }, + "title": "A reference to an Azure Virtual Machines Marketplace Image or a Shared Image Gallery Image. To get the list of all Azure Marketplace Image references verified by Azure Batch, see the 'List Supported Images' operation." + }, + "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." + }, + "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": "The default value for caching is readwrite. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "title": "The initial disk size in gigabytes." + }, + "storageAccountType": { + "title": "The storage Account type to be used for the data disk.", + "description": "If omitted, the default is \"standard_lrs\".", + "$ref": "#/definitions/StorageAccountType" + } + }, + "required": [ + "lun", + "diskSizeGB" + ], + "title": "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." + }, + "StorageAccountType": { + "type": "string", + "title": "The storage Account type for use in creating data disks.", + "enum": [ + "standard_lrs", + "premium_lrs" + ], + "x-ms-enum": { + "name": "StorageAccountType", + "modelAsString": false, + "values": [ + { + "value": "standard_lrs", + "description": "The data disk should use standard locally redundant storage.", + "name": "StandardLRS" + }, + { + "value": "premium_lrs", + "description": "The data disk should use premium locally redundant storage.", + "name": "PremiumLRS" + } + ] + } + }, + "CachingType": { + "type": "string", + "title": "The type of caching to enable for the disk.", + "description": "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/.", + "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.", + "name": "readOnly" + }, + { + "value": "readwrite", + "description": "The caching mode for the disk is read and write.", + "name": "readWrite" + } + ] + } + }, + "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 Compute Node agent to be provisioned on Compute Nodes in the Pool.", + "description": "The Batch Compute Node agent is a program that runs on each Compute Node in the Pool, and provides the command-and-control interface between the Compute Node and the Batch service. There are different implementations of the Compute Node agent, known as SKUs, for different operating systems. You must specify a Compute Node agent SKU which matches the selected Image reference. To get the list of supported Compute Node agent SKUs along with their list of verified Image references, see the 'List supported Compute 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 property specifies a Linux OS Image." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/DataDisk" + }, + "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. This cannot be updated. Each Compute Node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the Compute Node is removed from the Pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine." + }, + "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 Compute 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 Compute 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" + }, + "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." + } + }, + "required": [ + "nodeAgentSKUId", + "imageReference" + ], + "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." + }, + "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." + }, + "ContainerConfiguration": { + "type": "object", + "properties": { + "type": { + "type": "string", + "title": "The container technology to be used.", + "enum": [ + "dockerCompatible" + ], + "x-ms-enum": { + "name": "ContainerType", + "modelAsString": false, + "values": [ + { + "value": "dockerCompatible", + "description": "A Docker compatible container 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" + }, + "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." + }, + "DiskEncryptionConfiguration": { + "type": "object", + "properties": { + "targets": { + "type": "array", + "items": { + "type": "string", + "x-nullable": false, + "title": "A disk to encrypt.", + "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": "If omitted, no disks on the compute nodes in the pool will be encrypted. 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 Shared Image Gallery Image." + }, + "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.", + "name": "regional" + }, + { + "value": "zonal", + "description": "Nodes in the pool will be spread across different availability zones with best effort balancing.", + "name": "zonal" + } + ] + } + }, + "NodePlacementConfiguration": { + "type": "object", + "title": "Node placement configuration for a pool.", + "description": "For regional placement, nodes in the pool will be allocated in the same region. For zonal placement, nodes in the pool will be spread across different zones with best effort balancing.", + "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 extension." + }, + "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." + }, + "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." + }, + "InstanceViewStatus": { + "type": "object", + "properties": { + "code": { + "type": "string", + "title": "The status code." + }, + "displayStatus": { + "type": "string", + "title": "The localized label for the status." + }, + "level": { + "type": "string", + "title": "Level code.", + "enum": [ + "Error", + "Info", + "Warning" + ], + "x-ms-enum": { + "name": "StatusLevelTypes", + "modelAsString": false, + "values": [ + { + "value": "Error" + }, + { + "value": "Info" + }, + { + "value": "Warning" + } + ] + } + }, + "message": { + "type": "string", + "title": "The detailed status message." + }, + "time": { + "type": "string", + "description": "The time of the status." + } + }, + "title": "The instance view status." + }, + "VMExtensionInstanceView": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "The name of the vm extension instance view." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + }, + "subStatuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "title": "The vm extension instance view." + }, + "NodeVMExtension": { + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "title": "The provisioning state of the virtual machine extension." + }, + "vmExtension": { + "$ref": "#/definitions/VMExtension", + "title": "The virtual machine extension" + }, + "instanceView": { + "$ref": "#/definitions/VMExtensionInstanceView", + "title": "The vm extension instance view." + } + }, + "title": "The configuration for virtual machine extension instance view." + }, + "NodeVMExtensionList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeVMExtension" + }, + "title": "The list of Compute Node extensions." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the Compute Node extensions in a Node." + }, + "DiffDiskPlacement": { + "type": "string", + "title": "Specifies the ephemeral disk placement for operating system disk for all compute nodes (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 the location 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 compute node (VM)." + }, + "OSDisk": { + "type": "object", + "properties": { + "ephemeralOSDiskSettings": { + "$ref": "#/definitions/DiffDiskSettings", + "title": "Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM)." + } + }, + "title": "Settings for the operating system disk of the compute node (VM)." + }, + "IPAddressProvisioningType": { + "type": "string", + "title": "The provisioning type for Public IP Addresses for the 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.", + "name": "batchManaged" + }, + { + "value": "usermanaged", + "description": "Public IPs are provided by the user and will be used to provision the Compute Nodes.", + "name": "userManaged" + }, + { + "value": "nopublicipaddresses", + "description": "No public IP Address will be created.", + "name": "noPublicIPAddresses" + } + ] + } + }, + "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 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 Compute Nodes in the Pool. If the subnet doesn't have enough free IP addresses, the Pool will partially allocate 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 Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. For Pools created with virtualMachineConfiguration only ARM virtual networks ('Microsoft.Network/virtualNetworks') are supported, but for Pools created with cloudServiceConfiguration both ARM and classic virtual networks are supported. 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 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.", + "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." + } + ] + } + }, + "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": "Public IP configuration property is only supported on Pools with the virtualMachineConfiguration property." + } + }, + "description": "The network configuration for a Pool." + }, + "CloudPool": { + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the Pool within the Account.", + "description": "The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case)." + }, + "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." + }, + "url": { + "type": "string", + "title": "The URL of the Pool." + }, + "eTag": { + "type": "string", + "title": "The ETag of the Pool.", + "description": "This is an opaque string. You can use it to detect whether the Pool has changed between requests. In particular, you can be pass the ETag when updating a Pool to specify that your changes should take effect only if nobody else has modified the Pool in the meantime." + }, + "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 enableAutoscale settings, changed. It does not factor in node-level changes such as a Compute Node changing state." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "title": "The creation time of the Pool." + }, + "state": { + "type": "string", + "title": "The current state of the Pool.", + "enum": [ + "active", + "deleting" + ], + "x-ms-enum": { + "name": "PoolState", + "modelAsString": false, + "values": [ + { + "value": "active", + "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." + } + ] + } + }, + "stateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Pool entered its current state." + }, + "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 Compute 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 Compute 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." + } + ] + } + }, + "allocationStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Pool entered its current allocation state." + }, + "vmSize": { + "type": "string", + "title": "The size of virtual machines in the Pool. All virtual machines in a Pool are the same size.", + "description": "For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes)." + }, + "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." + }, + "resizeTimeout": { + "type": "string", + "format": "duration", + "title": "The timeout for allocation of Compute Nodes to the Pool.", + "description": "This is the timeout for the most recent resize operation. (The initial sizing when the Pool is created counts as a resize.) The default value is 15 minutes." + }, + "resizeErrors": { + "type": "array", + "items": { + "$ref": "#/definitions/ResizeError" + }, + "title": "A list of errors encountered while performing the last resize on the Pool.", + "description": "This property is set only if one or more errors occurred during the last Pool resize, and only when the Pool allocationState is Steady." + }, + "currentDedicatedNodes": { + "type": "integer", + "format": "int32", + "title": "The number of dedicated Compute Nodes currently in the Pool." + }, + "currentLowPriorityNodes": { + "type": "integer", + "format": "int32", + "title": "The number of low-priority Compute Nodes currently in the Pool.", + "description": "low-priority Compute Nodes which have been preempted are included in this count." + }, + "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 low-priority Compute Nodes in the Pool." + }, + "enableAutoScale": { + "type": "boolean", + "title": "Whether the Pool size should automatically adjust over time.", + "description": "If false, at least one of targetDedicatedNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula property is required and the Pool automatically resizes according to the formula. The default value is false." + }, + "autoScaleFormula": { + "type": "string", + "title": "A formula for the desired number of Compute Nodes in the Pool.", + "description": "This property is set only if the Pool automatically scales, i.e. enableAutoScale is true." + }, + "autoScaleEvaluationInterval": { + "type": "string", + "format": "duration", + "title": "The time interval at which to automatically adjust the Pool size according to the autoscale formula.", + "description": "This property is set only if the Pool automatically scales, i.e. enableAutoScale is true." + }, + "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. enableAutoScale is true." + }, + "enableInterNodeCommunication": { + "type": "boolean", + "title": "Whether the Pool permits direct communication between Compute Nodes.", + "description": "This imposes restrictions on which Compute Nodes can be assigned to the Pool. Specifying this value can reduce the chance of the requested number of Compute Nodes to be allocated in the Pool." + }, + "networkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration", + "title": "The network configuration for the Pool." + }, + "startTask": { + "$ref": "#/definitions/StartTask", + "title": "A Task specified to run on each Compute Node as it joins the Pool." + }, + "certificateReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateReference" + }, + "title": "The list of Certificates to be installed on each Compute Node in the Pool.", + "description": "For Windows 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." + }, + "applicationPackageReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationPackageReference" + }, + "title": "The list of Packages to be installed on each Compute Node in the Pool.", + "description": "Changes to Package references affect all new 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 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." + }, + "taskSlotsPerNode": { + "type": "integer", + "format": "int32", + "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" + }, + "title": "The list of user Accounts to be created on each Compute Node in the Pool." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the Pool as metadata." + }, + "stats": { + "$ref": "#/definitions/PoolStatistics", + "title": "Utilization and resource usage statistics for the entire lifetime of the Pool.", + "description": "This property is populated only if the CloudPool was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes." + }, + "mountConfiguration": { + "type": "array", + "items": { + "$ref": "#/definitions/MountConfiguration" + }, + "title": "A list of file systems to mount on each node in the pool.", + "description": "This supports Azure Files, NFS, CIFS/SMB, and Blobfuse." + }, + "identity": { + "title": "The identity of the Batch pool, if configured.", + "description": "The list of user identities associated with the Batch pool. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "$ref": "#/definitions/BatchPoolIdentity" + } + }, + "title": "A Pool in the Azure Batch service." + }, + "PoolAddParameter": { + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the Pool within the Account.", + "description": "The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two Pool IDs within an Account that differ only by case)." + }, + "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." + }, + "vmSize": { + "type": "string", + "title": "The size of virtual machines in the Pool. All virtual machines 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, A1V2 and A2V2. 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)." + }, + "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." + }, + "resizeTimeout": { + "type": "string", + "format": "duration", + "title": "The timeout for allocation of Compute Nodes to the Pool.", + "description": "This timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. 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)." + }, + "targetDedicatedNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of dedicated Compute Nodes in the Pool.", + "description": "This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both." + }, + "targetLowPriorityNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of low-priority Compute Nodes in the Pool.", + "description": "This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both." + }, + "enableAutoScale": { + "type": "boolean", + "title": "Whether the Pool size should automatically adjust over time.", + "description": "If false, at least one of targetDedicatedNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula property is required and the Pool automatically resizes according to the formula. The default value is false." + }, + "autoScaleFormula": { + "type": "string", + "title": "A formula for the desired number of Compute Nodes in the Pool.", + "description": "This property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the Pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information. For more information about specifying this formula, see 'Automatically scale Compute Nodes in an Azure Batch Pool' (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/)." + }, + "autoScaleEvaluationInterval": { + "type": "string", + "format": "duration", + "title": "The time interval at which to automatically adjust the Pool size according to the autoscale formula.", + "description": "The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "enableInterNodeCommunication": { + "type": "boolean", + "title": "Whether the Pool permits direct communication between Compute Nodes.", + "description": "Enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching its desired size. The default value is false." + }, + "networkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration", + "title": "The network configuration for the Pool." + }, + "startTask": { + "$ref": "#/definitions/StartTask", + "title": "A Task specified to run on each Compute Node as it joins the Pool.", + "description": "The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted." + }, + "certificateReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateReference" + }, + "title": "The list of Certificates to be installed on each Compute Node in the Pool.", + "description": "For Windows 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." + }, + "applicationPackageReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationPackageReference" + }, + "title": "The list of Packages to be installed on each Compute Node in the Pool.", + "description": "Changes to Package references affect all new 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 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." + }, + "taskSlotsPerNode": { + "type": "integer", + "format": "int32", + "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" + }, + "title": "The list of user Accounts to be created on each Compute Node in the Pool." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "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." + }, + "mountConfiguration": { + "type": "array", + "items": { + "$ref": "#/definitions/MountConfiguration" + }, + "title": "Mount storage using specified file system for the entire lifetime of the pool.", + "description": "Mount the storage using Azure fileshare, NFS, CIFS or Blobfuse based file system." + } + }, + "required": [ + "id", + "vmSize" + ], + "title": "A Pool in the Azure Batch service to add." + }, + "ApplicationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationSummary" + }, + "title": "The list of applications available in the Account." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the applications available in an Account." + }, + "CloudPoolListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudPool" + }, + "title": "The list of Pools." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the Pools in an Account." + }, + "AffinityInformation": { + "type": "object", + "properties": { + "affinityId": { + "type": "string", + "title": "An opaque string representing the location of a Compute Node or a Task that has run previously.", + "description": "You can pass the affinityId of a Node to indicate that this Task needs to run on that Compute Node. Note that this is just a soft affinity. If the target Compute Node is busy or unavailable at the time the Task is scheduled, then the Task will be scheduled elsewhere." + } + }, + "required": [ + "affinityId" + ], + "title": "A locality hint that can be used by the Batch service to select a Compute Node on which to start a Task." + }, + "TaskExecutionInformation": { + "type": "object", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Task started running.", + "description": "'Running' corresponds to the running state, so if the Task specifies resource files or Packages, then the start time reflects the time at which the Task started downloading or deploying these. If the Task has been restarted or retried, this is the most recent time at which the Task started running. This property is present only for Tasks that are in the running or completed state." + }, + "endTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Task completed.", + "description": "This property is set only if the Task is in the Completed state." + }, + "exitCode": { + "type": "integer", + "format": "int32", + "title": "The exit code of the program specified on the Task command line.", + "description": "This property is set only if the Task is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the Task (due to timeout, or user termination via the API) you may see an operating system-defined exit code." + }, + "containerInfo": { + "$ref": "#/definitions/TaskContainerExecutionInformation", + "title": "Information about the container under which the Task is executing.", + "description": "This property is set only if the Task runs in a container context." + }, + "failureInfo": { + "$ref": "#/definitions/TaskFailureInformation", + "title": "Information describing the Task failure, if any.", + "description": "This property is set only if the Task is in the completed state and encountered a failure." + }, + "retryCount": { + "type": "integer", + "format": "int32", + "title": "The number of times the Task has been retried by the Batch service.", + "description": "Task application failures (non-zero exit code) are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch service will retry the Task up to the limit specified by the constraints." + }, + "lastRetryTime": { + "type": "string", + "format": "date-time", + "title": "The most recent time at which a retry of the Task started running.", + "description": "This element is present only if the Task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the Task has been restarted for reasons other than retry; for example, if the Compute Node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not." + }, + "requeueCount": { + "type": "integer", + "format": "int32", + "title": "The number of times the Task has been requeued by the Batch service as the result of a user request.", + "description": "When the user removes Compute Nodes from a Pool (by resizing/shrinking the pool) or when the Job is being disabled, the user can specify that running Tasks on the Compute Nodes be requeued for execution. This count tracks how many times the Task has been requeued for these reasons." + }, + "lastRequeueTime": { + "type": "string", + "format": "date-time", + "title": "The most recent time at which the Task has been requeued by the Batch service as the result of a user request.", + "description": "This property is set only if the requeueCount is nonzero." + }, + "result": { + "$ref": "#/definitions/TaskExecutionResult", + "title": "The result of the Task execution.", + "description": "If the value is 'failed', then the details of the failure can be found in the failureInfo property." + } + }, + "required": [ + "requeueCount", + "retryCount" + ], + "title": "Information about the execution of a Task." + }, + "ComputeNodeInformation": { + "type": "object", + "properties": { + "affinityId": { + "type": "string", + "title": "An identifier for the Node on which the Task ran, which can be passed when adding a Task to request that the Task be scheduled on this Compute Node." + }, + "nodeUrl": { + "type": "string", + "title": "The URL of the Compute Node on which the Task ran. " + }, + "poolId": { + "type": "string", + "title": "The ID of the Pool on which the Task ran." + }, + "nodeId": { + "type": "string", + "title": "The ID of the Compute Node on which the Task ran." + }, + "taskRootDirectory": { + "type": "string", + "title": "The root directory of the Task on the Compute Node." + }, + "taskRootDirectoryUrl": { + "type": "string", + "title": "The URL to the root directory of the Task on the Compute Node." + } + }, + "title": "Information about the Compute Node on which a Task ran." + }, + "NodeAgentInformation": { + "type": "object", + "properties": { + "version": { + "type": "string", + "title": "The version of the Batch Compute Node agent running on the Compute Node.", + "description": "This version number can be checked against the Compute Node agent release notes located at https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "title": "The time when the Compute Node agent was updated on the Compute Node.", + "description": "This is the most recent time that the Compute Node agent was updated to a new version." + } + }, + "required": [ + "version", + "lastUpdateTime" + ], + "title": "Information about the Compute Node agent.", + "description": "The Batch Compute Node agent is a program that runs on each Compute Node in the Pool and provides Batch capability on the Compute Node." + }, + "MultiInstanceSettings": { + "type": "object", + "properties": { + "numberOfInstances": { + "type": "integer", + "format": "int32", + "title": "The number of Compute Nodes required by the Task.", + "description": "If omitted, the default is 1." + }, + "coordinationCommandLine": { + "type": "string", + "title": "The command line to run on all the Compute Nodes to enable them to coordinate when the primary runs the main Task command.", + "description": "A typical coordination command line launches a background service and verifies that the service is ready to process inter-node messages." + }, + "commonResourceFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "title": "A list of files that the Batch service will download before running the coordination command line.", + "description": "The difference between common resource files and Task resource files is that common resource files are downloaded for all subtasks including the primary, whereas Task resource files are downloaded only for the primary. Also note that these resource files are not downloaded to the Task working directory, but instead are downloaded to the Task root directory (one directory above the working directory). There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers." + } + }, + "required": [ + "coordinationCommandLine" + ], + "title": "Settings which specify how to run a multi-instance Task.", + "description": "Multi-instance Tasks are commonly used to support MPI Tasks. In the MPI case, if any of the subtasks fail (for example due to exiting with a non-zero exit code) the entire multi-instance Task fails. The multi-instance Task is then terminated and retried, up to its retry limit." + }, + "TaskStatistics": { + "type": "object", + "properties": { + "url": { + "type": "string", + "title": "The URL of the statistics." + }, + "startTime": { + "type": "string", + "format": "date-time", + "title": "The start time of the time range covered by the statistics." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime." + }, + "userCPUTime": { + "type": "string", + "format": "duration", + "title": "The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by the Task." + }, + "kernelCPUTime": { + "type": "string", + "format": "duration", + "title": "The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by the Task." + }, + "wallClockTime": { + "type": "string", + "format": "duration", + "title": "The total wall clock time of the Task.", + "description": "The wall clock time is the elapsed time from when the Task started running on a Compute Node to when it finished (or to the last time the statistics were updated, if the Task had not finished by then). If the Task was retried, this includes the wall clock time of all the Task retries." + }, + "readIOps": { + "type": "integer", + "format": "int64", + "title": "The total number of disk read operations made by the Task." + }, + "writeIOps": { + "type": "integer", + "format": "int64", + "title": "The total number of disk write operations made by the Task." + }, + "readIOGiB": { + "type": "number", + "format": "double", + "title": "The total gibibytes read from disk by the Task." + }, + "writeIOGiB": { + "type": "number", + "format": "double", + "title": "The total gibibytes written to disk by the Task." + }, + "waitTime": { + "type": "string", + "format": "duration", + "title": "The total wait time of the Task. The wait time for a Task is defined as the elapsed time between the creation of the Task and the start of Task execution. (If the Task is retried due to failures, the wait time is the time to the most recent Task execution.)" + } + }, + "required": [ + "url", + "startTime", + "lastUpdateTime", + "userCPUTime", + "kernelCPUTime", + "wallClockTime", + "readIOps", + "writeIOps", + "readIOGiB", + "writeIOGiB", + "waitTime" + ], + "title": "Resource usage statistics for a Task." + }, + "TaskDependencies": { + "type": "object", + "properties": { + "taskIds": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The list of Task IDs that this Task depends on. All Tasks in this list must complete successfully before the dependent Task can be scheduled.", + "description": "The taskIds collection is limited to 64000 characters total (i.e. the combined length of all Task IDs). If the taskIds collection exceeds the maximum length, the Add Task request fails with error code TaskDependencyListTooLong. In this case consider using Task ID ranges instead." + }, + "taskIdRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/TaskIdRange" + }, + "title": "The list of Task ID ranges that this Task depends on. All Tasks in all ranges must complete successfully before the dependent Task can be scheduled." + } + }, + "title": "Specifies any dependencies of a Task. Any Task that is explicitly specified or within a dependency range must complete before the dependant Task will be scheduled." + }, + "TaskIdRange": { + "type": "object", + "properties": { + "start": { + "type": "integer", + "format": "int32", + "title": "The first Task ID in the range." + }, + "end": { + "type": "integer", + "format": "int32", + "title": "The last Task ID in the range." + } + }, + "title": "A range of Task IDs that a Task can depend on. All Tasks with IDs in the range must complete successfully before the dependent Task can be scheduled.", + "description": "The start and end of the range are inclusive. For example, if a range has start 9 and end 12, then it represents Tasks '9', '10', '11' and '12'.", + "required": [ + "start", + "end" + ] + }, + "CloudTask": { + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the Task within the Job.", + "description": "The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters." + }, + "displayName": { + "type": "string", + "title": "A display name for the Task.", + "description": "The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "url": { + "type": "string", + "title": "The URL of the Task." + }, + "eTag": { + "type": "string", + "title": "The ETag of the Task.", + "description": "This is an opaque string. You can use it to detect whether the Task has changed between requests. In particular, you can be pass the ETag when updating a Task to specify that your changes should take effect only if nobody else has modified the Task in the meantime." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "title": "The last modified time of the Task." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "title": "The creation time of the Task." + }, + "exitConditions": { + "$ref": "#/definitions/ExitConditions", + "description": "How the Batch service should respond when the Task completes." + }, + "state": { + "title": "The current state of the Task.", + "$ref": "#/definitions/TaskState" + }, + "stateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Task entered its current state." + }, + "previousState": { + "title": "The previous state of the Task.", + "description": "This property is not set if the Task is in its initial Active state.", + "$ref": "#/definitions/TaskState" + }, + "previousStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Task entered its previous state.", + "description": "This property is not set if the Task is in its initial Active state." + }, + "commandLine": { + "type": "string", + "title": "The command line of the Task.", + "description": "For multi-instance Tasks, the command line is executed as the primary Task, after the primary Task and all subtasks have finished executing the coordination command line. 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. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables)." + }, + "containerSettings": { + "$ref": "#/definitions/TaskContainerSettings", + "title": "The settings for the container under which the Task runs.", + "description": "If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. 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. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files." + }, + "resourceFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "title": "A list of files that the Batch service will download to the Compute Node before running the command line.", + "description": "For multi-instance Tasks, the resource files will only be downloaded to the Compute Node on which the primary Task is executed. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers." + }, + "outputFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/OutputFile" + }, + "title": "A list of files that the Batch service will upload from the Compute Node after running the command line.", + "description": "For multi-instance Tasks, the files will only be uploaded from the Compute Node on which the primary Task is executed." + }, + "environmentSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "title": "A list of environment variable settings for the Task." + }, + "affinityInfo": { + "$ref": "#/definitions/AffinityInformation", + "title": "A locality hint that can be used by the Batch service to select a Compute Node on which to start the new Task." + }, + "constraints": { + "$ref": "#/definitions/TaskConstraints", + "title": "The execution constraints that apply to this Task." + }, + "requiredSlots": { + "type": "integer", + "format": "int32", + "title": "The number of scheduling slots that the Task requires to run.", + "description": "The default is 1. A Task can only be scheduled to run on a compute node if the node has enough free scheduling slots available. For multi-instance Tasks, this must be 1." + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "title": "The user identity under which the Task runs.", + "description": "If omitted, the Task runs as a non-administrative user unique to the Task." + }, + "executionInfo": { + "$ref": "#/definitions/TaskExecutionInformation", + "title": "Information about the execution of the Task." + }, + "nodeInfo": { + "$ref": "#/definitions/ComputeNodeInformation", + "title": "Information about the Compute Node on which the Task ran." + }, + "multiInstanceSettings": { + "$ref": "#/definitions/MultiInstanceSettings", + "title": "An object that indicates that the Task is a multi-instance Task, and contains information about how to run the multi-instance Task." + }, + "stats": { + "$ref": "#/definitions/TaskStatistics", + "title": "Resource usage statistics for the Task." + }, + "dependsOn": { + "$ref": "#/definitions/TaskDependencies", + "title": "The Tasks that this Task depends on.", + "description": "This Task will not be scheduled until all Tasks that it depends on have completed successfully. If any of those Tasks fail and exhaust their retry counts, this Task will never be scheduled." + }, + "applicationPackageReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationPackageReference" + }, + "title": "A list of Packages that the Batch service will deploy to the Compute Node before running the command line.", + "description": "Application packages are downloaded and deployed to a shared directory, not the Task working directory. Therefore, if a referenced package is already on the Node, and is up to date, then it is not re-downloaded; the existing copy on the Compute Node is used. If a referenced Package cannot be installed, for example because the package has been deleted or because download failed, the Task fails." + }, + "authenticationTokenSettings": { + "title": "The settings for an authentication token that the Task can use to perform Batch service operations.", + "description": "If this property is set, the Batch service provides the Task with an authentication token which can be used to authenticate Batch service operations without requiring an Account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the Task can carry out using the token depend on the settings. For example, a Task can request Job permissions in order to add other Tasks to the Job, or check the status of the Job or of other Tasks under the Job.", + "$ref": "#/definitions/AuthenticationTokenSettings" + } + }, + "title": "An Azure Batch Task.", + "description": "Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing." + }, + "TaskAddParameter": { + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the Task within the Job.", + "description": "The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within a Job that differ only by case)." + }, + "displayName": { + "type": "string", + "title": "A display name for the Task.", + "description": "The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "commandLine": { + "type": "string", + "title": "The command line of the Task.", + "description": "For multi-instance Tasks, the command line is executed as the primary Task, after the primary Task and all subtasks have finished executing the coordination command line. 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. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables)." + }, + "containerSettings": { + "$ref": "#/definitions/TaskContainerSettings", + "title": "The settings for the container under which the Task runs.", + "description": "If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. 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. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files." + }, + "exitConditions": { + "$ref": "#/definitions/ExitConditions", + "description": "How the Batch service should respond when the Task completes." + }, + "resourceFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "title": "A list of files that the Batch service will download to the Compute Node before running the command line.", + "description": "For multi-instance Tasks, the resource files will only be downloaded to the Compute Node on which the primary Task is executed. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers." + }, + "outputFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/OutputFile" + }, + "title": "A list of files that the Batch service will upload from the Compute Node after running the command line.", + "description": "For multi-instance Tasks, the files will only be uploaded from the Compute Node on which the primary Task is executed." + }, + "environmentSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "title": "A list of environment variable settings for the Task." + }, + "affinityInfo": { + "$ref": "#/definitions/AffinityInformation", + "title": "A locality hint that can be used by the Batch service to select a Compute Node on which to start the new Task." + }, + "constraints": { + "$ref": "#/definitions/TaskConstraints", + "title": "The execution constraints that apply to this Task.", + "description": "If you do not specify constraints, the maxTaskRetryCount is the maxTaskRetryCount specified for the Job, the maxWallClockTime is infinite, and the retentionTime is 7 days." + }, + "requiredSlots": { + "type": "integer", + "format": "int32", + "title": "The number of scheduling slots that the Task required to run.", + "description": "The default is 1. A Task can only be scheduled to run on a compute node if the node has enough free scheduling slots available. For multi-instance Tasks, this must be 1." + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "title": "The user identity under which the Task runs.", + "description": "If omitted, the Task runs as a non-administrative user unique to the Task." + }, + "multiInstanceSettings": { + "$ref": "#/definitions/MultiInstanceSettings", + "title": "An object that indicates that the Task is a multi-instance Task, and contains information about how to run the multi-instance Task." + }, + "dependsOn": { + "$ref": "#/definitions/TaskDependencies", + "title": "The Tasks that this Task depends on.", + "description": "This Task will not be scheduled until all Tasks that it depends on have completed successfully. If any of those Tasks fail and exhaust their retry counts, this Task will never be scheduled. If the Job does not have usesTaskDependencies set to true, and this element is present, the request fails with error code TaskDependenciesNotSpecifiedOnJob." + }, + "applicationPackageReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationPackageReference" + }, + "title": "A list of Packages that the Batch service will deploy to the Compute Node before running the command line.", + "description": "Application packages are downloaded and deployed to a shared directory, not the Task working directory. Therefore, if a referenced package is already on the Node, and is up to date, then it is not re-downloaded; the existing copy on the Compute Node is used. If a referenced Package cannot be installed, for example because the package has been deleted or because download failed, the Task fails." + }, + "authenticationTokenSettings": { + "title": "The settings for an authentication token that the Task can use to perform Batch service operations.", + "description": "If this property is set, the Batch service provides the Task with an authentication token which can be used to authenticate Batch service operations without requiring an Account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the Task can carry out using the token depend on the settings. For example, a Task can request Job permissions in order to add other Tasks to the Job, or check the status of the Job or of other Tasks under the Job.", + "$ref": "#/definitions/AuthenticationTokenSettings" + } + }, + "required": [ + "id", + "commandLine" + ], + "title": "An Azure Batch Task to add.", + "description": "Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing." + }, + "TaskAddCollectionParameter": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TaskAddParameter" + }, + "maxItems": 100, + "title": "The collection of Tasks to add. The maximum count of Tasks is 100.", + "description": "The total serialized size of this collection must be less than 1MB. If it is greater than 1MB (for example if each Task has 100's of resource files or environment variables), the request will fail with code 'RequestBodyTooLarge' and should be retried again with fewer Tasks." + } + }, + "required": [ + "value" + ], + "title": "A collection of Azure Batch Tasks to add." + }, + "TaskAddResult": { + "type": "object", + "properties": { + "status": { + "type": "string", + "title": "The status of the add Task request.", + "enum": [ + "success", + "clienterror", + "servererror" + ], + "x-ms-enum": { + "name": "TaskAddStatus", + "modelAsString": false, + "values": [ + { + "value": "success", + "description": "The Task was added successfully." + }, + { + "value": "clienterror", + "description": "The Task failed to add due to a client error and should not be retried without modifying the request as appropriate.", + "name": "clientError" + }, + { + "value": "servererror", + "description": "Task failed to add due to a server error and can be retried without modification.", + "name": "serverError" + } + ] + } + }, + "taskId": { + "type": "string", + "title": "The ID of the Task for which this is the result." + }, + "eTag": { + "type": "string", + "title": "The ETag of the Task, if the Task was successfully added.", + "description": "You can use this to detect whether the Task has changed between requests. In particular, you can be pass the ETag with an Update Task request to specify that your changes should take effect only if nobody else has modified the Job in the meantime." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "title": "The last modified time of the Task." + }, + "location": { + "type": "string", + "title": "The URL of the Task, if the Task was successfully added." + }, + "error": { + "$ref": "#/definitions/BatchError", + "title": "The error encountered while attempting to add the Task." + } + }, + "required": [ + "status", + "taskId" + ], + "title": "Result for a single Task added as part of an add Task collection operation." + }, + "TaskAddCollectionResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TaskAddResult" + }, + "title": "The results of the add Task collection operation." + } + }, + "title": "The result of adding a collection of Tasks to a Job." + }, + "SubtaskInformation": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "title": "The ID of the subtask." + }, + "nodeInfo": { + "$ref": "#/definitions/ComputeNodeInformation", + "title": "Information about the Compute Node on which the subtask ran." + }, + "startTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the subtask started running. If the subtask has been restarted or retried, this is the most recent time at which the subtask started running." + }, + "endTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the subtask completed.", + "description": "This property is set only if the subtask is in the Completed state." + }, + "exitCode": { + "type": "integer", + "format": "int32", + "title": "The exit code of the program specified on the subtask command line.", + "description": "This property is set only if the subtask is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the subtask (due to timeout, or user termination via the API) you may see an operating system-defined exit code." + }, + "containerInfo": { + "$ref": "#/definitions/TaskContainerExecutionInformation", + "title": "Information about the container under which the Task is executing.", + "description": "This property is set only if the Task runs in a container context." + }, + "failureInfo": { + "$ref": "#/definitions/TaskFailureInformation", + "title": "Information describing the Task failure, if any.", + "description": "This property is set only if the Task is in the completed state and encountered a failure." + }, + "state": { + "title": "The current state of the subtask.", + "$ref": "#/definitions/SubtaskState" + }, + "stateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the subtask entered its current state." + }, + "previousState": { + "title": "The previous state of the subtask.", + "description": "This property is not set if the subtask is in its initial running state.", + "$ref": "#/definitions/SubtaskState" + }, + "previousStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the subtask entered its previous state.", + "description": "This property is not set if the subtask is in its initial running state." + }, + "result": { + "$ref": "#/definitions/TaskExecutionResult", + "title": "The result of the Task execution.", + "description": "If the value is 'failed', then the details of the failure can be found in the failureInfo property." + } + }, + "title": "Information about an Azure Batch subtask." + }, + "CloudTaskListSubtasksResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SubtaskInformation" + }, + "title": "The list of subtasks." + } + }, + "title": "The result of listing the subtasks of a Task." + }, + "CloudTaskListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudTask" + }, + "title": "The list of Tasks." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the Tasks in a Job." + }, + "TaskInformation": { + "type": "object", + "properties": { + "taskUrl": { + "type": "string", + "title": "The URL of the Task." + }, + "jobId": { + "type": "string", + "title": "The ID of the Job to which the Task belongs." + }, + "taskId": { + "type": "string", + "title": "The ID of the Task." + }, + "subtaskId": { + "type": "integer", + "format": "int32", + "title": "The ID of the subtask if the Task is a multi-instance Task." + }, + "taskState": { + "title": "The current state of the Task.", + "$ref": "#/definitions/TaskState" + }, + "executionInfo": { + "$ref": "#/definitions/TaskExecutionInformation", + "title": "Information about the execution of the Task." + } + }, + "required": [ + "taskState" + ], + "title": "Information about a Task running on a Compute Node." + }, + "StartTaskInformation": { + "type": "object", + "properties": { + "state": { + "type": "string", + "title": "The state of the StartTask on the Compute Node.", + "enum": [ + "running", + "completed" + ], + "x-ms-enum": { + "name": "StartTaskState", + "modelAsString": false, + "values": [ + { + "value": "running", + "description": "The StartTask is currently running." + }, + { + "value": "completed", + "description": "The StartTask has exited with exit code 0, or the StartTask has failed and the retry limit has reached, or the StartTask process did not run due to Task preparation errors (such as resource file download failures)." + } + ] + } + }, + "startTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the StartTask started running.", + "description": "This value is reset every time the Task is restarted or retried (that is, this is the most recent time at which the StartTask started running)." + }, + "endTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the StartTask stopped running.", + "description": "This is the end time of the most recent run of the StartTask, if that run has completed (even if that run failed and a retry is pending). This element is not present if the StartTask is currently running." + }, + "exitCode": { + "type": "integer", + "format": "int32", + "title": "The exit code of the program specified on the StartTask command line.", + "description": "This property is set only if the StartTask is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the StartTask (due to timeout, or user termination via the API) you may see an operating system-defined exit code." + }, + "containerInfo": { + "$ref": "#/definitions/TaskContainerExecutionInformation", + "title": "Information about the container under which the Task is executing.", + "description": "This property is set only if the Task runs in a container context." + }, + "failureInfo": { + "$ref": "#/definitions/TaskFailureInformation", + "title": "Information describing the Task failure, if any.", + "description": "This property is set only if the Task is in the completed state and encountered a failure." + }, + "retryCount": { + "type": "integer", + "format": "int32", + "title": "The number of times the Task has been retried by the Batch service.", + "description": "Task application failures (non-zero exit code) are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch service will retry the Task up to the limit specified by the constraints." + }, + "lastRetryTime": { + "type": "string", + "format": "date-time", + "title": "The most recent time at which a retry of the Task started running.", + "description": "This element is present only if the Task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the Task has been restarted for reasons other than retry; for example, if the Compute Node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not." + }, + "result": { + "$ref": "#/definitions/TaskExecutionResult", + "title": "The result of the Task execution.", + "description": "If the value is 'failed', then the details of the failure can be found in the failureInfo property." + } + }, + "required": [ + "state", + "startTime", + "retryCount" + ], + "title": "Information about a StartTask running on a Compute Node." + }, + "ComputeNodeError": { + "type": "object", + "properties": { + "code": { + "type": "string", + "title": "An identifier for the Compute Node error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "title": "A message describing the Compute Node error, intended to be suitable for display in a user interface." + }, + "errorDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/NameValuePair" + }, + "title": "The list of additional error details related to the Compute Node error." + } + }, + "title": "An error encountered by a Compute Node." + }, + "ComputeNode": { + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "The ID of the Compute Node.", + "description": "Every Compute Node that is added to a Pool is assigned a unique ID. Whenever a Compute Node is removed from a Pool, all of its local files are deleted, and the ID is reclaimed and could be reused for new Compute Nodes." + }, + "url": { + "type": "string", + "title": "The URL of the Compute Node." + }, + "state": { + "type": "string", + "title": "The current state of the Compute Node.", + "description": "The low-priority Compute Node has been preempted. Tasks which were running on the Compute Node when it was preempted will be rescheduled when another Compute Node becomes available.", + "enum": [ + "idle", + "rebooting", + "reimaging", + "running", + "unusable", + "creating", + "starting", + "waitingforstarttask", + "starttaskfailed", + "unknown", + "leavingpool", + "offline", + "preempted" + ], + "x-ms-enum": { + "name": "ComputeNodeState", + "modelAsString": false, + "values": [ + { + "value": "idle", + "description": "The Compute Node is not currently running a Task." + }, + { + "value": "rebooting", + "description": "The Compute Node is rebooting." + }, + { + "value": "reimaging", + "description": "The Compute Node is reimaging." + }, + { + "value": "running", + "description": "The Compute Node is running one or more Tasks (other than a StartTask)." + }, + { + "value": "unusable", + "description": "The Compute Node cannot be used for Task execution due to errors." + }, + { + "value": "creating", + "description": "The Batch service has obtained the underlying virtual machine from Azure Compute, but it has not yet started to join the Pool." + }, + { + "value": "starting", + "description": "The Batch service is starting on the underlying virtual machine." + }, + { + "value": "waitingforstarttask", + "description": "The StartTask has started running on the Compute Node, but waitForSuccess is set and the StartTask has not yet completed.", + "name": "waitingForStartTask" + }, + { + "value": "starttaskfailed", + "description": "The StartTask has failed on the Compute Node (and exhausted all retries), and waitForSuccess is set. The Compute Node is not usable for running Tasks.", + "name": "startTaskFailed" + }, + { + "value": "unknown", + "description": "The Batch service has lost contact with the Compute Node, and does not know its true state." + }, + { + "value": "leavingpool", + "description": "The Compute Node is leaving the Pool, either because the user explicitly removed it or because the Pool is resizing or autoscaling down.", + "name": "leavingPool" + }, + { + "value": "offline", + "description": "The Compute Node is not currently running a Task, and scheduling of new Tasks to the Compute Node is disabled." + }, + { + "value": "preempted", + "description": "The low-priority Compute Node has been preempted. Tasks which were running on the Compute Node when it was preempted will be rescheduled when another Compute Node becomes available." + } + ] + } + }, + "schedulingState": { + "type": "string", + "title": "Whether the Compute Node is available for Task scheduling.", + "enum": [ + "enabled", + "disabled" + ], + "x-ms-enum": { + "name": "SchedulingState", + "modelAsString": false, + "values": [ + { + "value": "enabled", + "description": "Tasks can be scheduled on the Compute Node." + }, + { + "value": "disabled", + "description": "No new Tasks will be scheduled on the Compute Node. Tasks already running on the Compute Node may still run to completion. All Compute Nodes start with scheduling enabled." + } + ] + } + }, + "stateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Compute Node entered its current state." + }, + "lastBootTime": { + "type": "string", + "format": "date-time", + "title": "The last time at which the Compute Node was started.", + "description": "This property may not be present if the Compute Node state is unusable." + }, + "allocationTime": { + "type": "string", + "format": "date-time", + "title": "The time at which this Compute Node was allocated to the Pool.", + "description": "This is the time when the Compute Node was initially allocated and doesn't change once set. It is not updated when the Compute Node is service healed or preempted." + }, + "ipAddress": { + "type": "string", + "title": "The IP address that other Nodes can use to communicate with this Compute Node.", + "description": "Every Compute Node that is added to a Pool is assigned a unique IP address. Whenever a Compute Node is removed from a Pool, all of its local files are deleted, and the IP address is reclaimed and could be reused for new Compute Nodes." + }, + "affinityId": { + "type": "string", + "title": "An identifier which can be passed when adding a Task to request that the Task be scheduled on this Compute Node.", + "description": "Note that this is just a soft affinity. If the target Compute Node is busy or unavailable at the time the Task is scheduled, then the Task will be scheduled elsewhere." + }, + "vmSize": { + "type": "string", + "title": "The size of the virtual machine hosting the Compute Node.", + "description": "For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes)." + }, + "totalTasksRun": { + "type": "integer", + "format": "int32", + "title": "The total number of Job Tasks completed on the Compute Node. This includes Job Manager Tasks and normal Tasks, but not Job Preparation, Job Release or Start Tasks." + }, + "runningTasksCount": { + "type": "integer", + "format": "int32", + "title": "The total number of currently running Job Tasks on the Compute Node. This includes Job Manager Tasks and normal Tasks, but not Job Preparation, Job Release or Start Tasks." + }, + "runningTaskSlotsCount": { + "type": "integer", + "format": "int32", + "title": "The total number of scheduling slots used by currently running Job Tasks on the Compute Node. This includes Job Manager Tasks and normal Tasks, but not Job Preparation, Job Release or Start Tasks." + }, + "totalTasksSucceeded": { + "type": "integer", + "format": "int32", + "title": "The total number of Job Tasks which completed successfully (with exitCode 0) on the Compute Node. This includes Job Manager Tasks and normal Tasks, but not Job Preparation, Job Release or Start Tasks." + }, + "recentTasks": { + "type": "array", + "items": { + "$ref": "#/definitions/TaskInformation" + }, + "title": "A list of Tasks whose state has recently changed.", + "description": "This property is present only if at least one Task has run on this Compute Node since it was assigned to the Pool." + }, + "startTask": { + "$ref": "#/definitions/StartTask", + "title": "The Task specified to run on the Compute Node as it joins the Pool." + }, + "startTaskInfo": { + "$ref": "#/definitions/StartTaskInformation", + "title": "Runtime information about the execution of the StartTask on the Compute Node." + }, + "certificateReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateReference" + }, + "title": "The list of Certificates installed on the Compute Node.", + "description": "For Windows 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." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ComputeNodeError" + }, + "title": "The list of errors that are currently being encountered by the Compute Node." + }, + "isDedicated": { + "type": "boolean", + "title": "Whether this Compute Node is a dedicated Compute Node. If false, the Compute Node is a low-priority Compute Node." + }, + "endpointConfiguration": { + "$ref": "#/definitions/ComputeNodeEndpointConfiguration", + "title": "The endpoint configuration for the Compute Node." + }, + "nodeAgentInfo": { + "$ref": "#/definitions/NodeAgentInformation", + "title": "Information about the Compute Node agent version and the time the Compute Node upgraded to a new version." + }, + "virtualMachineInfo": { + "$ref": "#/definitions/VirtualMachineInfo", + "title": "Info about the current state of the virtual machine." + } + }, + "title": "A Compute Node in the Batch service." + }, + "VirtualMachineInfo": { + "type": "object", + "title": "Info about the current state of the virtual machine.", + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "title": "The reference to the Azure Virtual Machine's Marketplace Image." + } + } + }, + "PoolEndpointConfiguration": { + "type": "object", + "properties": { + "inboundNATPools": { + "type": "array", + "items": { + "$ref": "#/definitions/InboundNATPool" + }, + "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": { + "$ref": "#/definitions/InboundEndpointProtocol", + "title": "The protocol of 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. Each range must contain at least 40 ports. 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. Each range must contain at least 40 ports. 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" + } + } + }, + "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), a specific port (i.e. 22), or a port range (i.e. 100-200). The ports must be in the range of 0 to 65535. Each entry in this collection must not overlap any other entry (either a range or an individual port). If any other values are provided the request fails with HTTP status code 400. The default value is '*'." + } + }, + "required": [ + "priority", + "access", + "sourceAddressPrefix" + ], + "title": "A network security group rule to apply to an inbound endpoint." + }, + "ComputeNodeEndpointConfiguration": { + "type": "object", + "properties": { + "inboundEndpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/InboundEndpoint" + }, + "title": "The list of inbound endpoints that are accessible on the Compute Node." + } + }, + "required": [ + "inboundEndpoints" + ], + "title": "The endpoint configuration for the Compute Node." + }, + "InboundEndpoint": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "The name of the endpoint." + }, + "protocol": { + "$ref": "#/definitions/InboundEndpointProtocol", + "title": "The protocol of the endpoint." + }, + "publicIPAddress": { + "type": "string", + "title": "The public IP address of the Compute Node." + }, + "publicFQDN": { + "type": "string", + "title": "The public fully qualified domain name for the Compute Node." + }, + "frontendPort": { + "type": "integer", + "format": "int32", + "title": "The public port number of the endpoint." + }, + "backendPort": { + "type": "integer", + "format": "int32", + "title": "The backend port number of the endpoint." + } + }, + "required": [ + "name", + "protocol", + "publicIPAddress", + "publicFQDN", + "frontendPort", + "backendPort" + ], + "title": "An inbound endpoint on a Compute Node." + }, + "ComputeNodeListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ComputeNode" + }, + "title": "The list of Compute Nodes." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the Compute Nodes in a Pool." + }, + "ComputeNodeUser": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "The user name of the Account." + }, + "isAdmin": { + "type": "boolean", + "title": "Whether the Account should be an administrator on the Compute Node.", + "description": "The default value is false." + }, + "expiryTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Account should expire.", + "description": "If omitted, the default is 1 day from the current time. For Linux Compute Nodes, the expiryTime has a precision up to a day." + }, + "password": { + "type": "string", + "title": "The password of the Account.", + "description": "The password is required for Windows Compute Nodes (those created with 'cloudServiceConfiguration', or created with 'virtualMachineConfiguration' using a Windows Image reference). For Linux Compute Nodes, the password can optionally be specified along with the sshPublicKey property." + }, + "sshPublicKey": { + "type": "string", + "title": "The SSH public key that can be used for remote login to the Compute Node.", + "description": "The public key should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be specified only for Linux Compute Nodes. If this is specified for a Windows Compute Node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + } + }, + "required": [ + "name" + ], + "title": "A user Account for RDP or SSH access on a Compute Node." + }, + "ComputeNodeGetRemoteLoginSettingsResult": { + "type": "object", + "properties": { + "remoteLoginIPAddress": { + "type": "string", + "title": "The IP address used for remote login to the Compute Node." + }, + "remoteLoginPort": { + "type": "integer", + "format": "int32", + "title": "The port used for remote login to the Compute Node." + } + }, + "required": [ + "remoteLoginIPAddress", + "remoteLoginPort" + ], + "title": "The remote login settings for a Compute Node." + }, + "JobSchedulePatchParameter": { + "type": "object", + "properties": { + "schedule": { + "$ref": "#/definitions/Schedule", + "title": "The schedule according to which Jobs will be created.", + "description": "If you do not specify this element, the existing schedule is left unchanged." + }, + "jobSpecification": { + "$ref": "#/definitions/JobSpecification", + "title": "The details of the Jobs to be created on this schedule.", + "description": "Updates affect only Jobs that are started after the update has taken place. Any currently active Job continues with the older specification." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the Job Schedule as metadata.", + "description": "If you do not specify this element, existing metadata is left unchanged." + } + }, + "title": "The set of changes to be made to a Job Schedule." + }, + "JobScheduleUpdateParameter": { + "type": "object", + "properties": { + "schedule": { + "$ref": "#/definitions/Schedule", + "title": "The schedule according to which Jobs will be created.", + "description": "If you do not specify this element, it is equivalent to passing the default schedule: that is, a single Job scheduled to run immediately." + }, + "jobSpecification": { + "$ref": "#/definitions/JobSpecification", + "title": "Details of the Jobs to be created on this schedule.", + "description": "Updates affect only Jobs that are started after the update has taken place. Any currently active Job continues with the older specification." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the Job Schedule as metadata.", + "description": "If you do not specify this element, it takes the default value of an empty list; in effect, any existing metadata is deleted." + } + }, + "required": [ + "schedule", + "jobSpecification" + ], + "title": "The set of changes to be made to a Job Schedule." + }, + "JobDisableParameter": { + "type": "object", + "properties": { + "disableTasks": { + "type": "string", + "title": "What to do with active Tasks associated with the Job.", + "enum": [ + "requeue", + "terminate", + "wait" + ], + "x-ms-enum": { + "name": "DisableJobOption", + "modelAsString": false, + "values": [ + { + "value": "requeue", + "description": "Terminate running Tasks and requeue them. The Tasks will run again when the Job is enabled." + }, + { + "value": "terminate", + "description": "Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they were terminated, and will not run again." + }, + { + "value": "wait", + "description": "Allow currently running Tasks to complete." + } + ] + } + } + }, + "required": [ + "disableTasks" + ], + "title": "Options when disabling a Job." + }, + "JobTerminateParameter": { + "type": "object", + "properties": { + "terminateReason": { + "type": "string", + "title": "The text you want to appear as the Job's TerminateReason. The default is 'UserTerminate'." + } + }, + "title": "Options when terminating a Job." + }, + "JobPatchParameter": { + "type": "object", + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "title": "The priority of the Job.", + "description": "Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. If omitted, the priority of the Job is left unchanged." + }, + "maxParallelTasks": { + "type": "integer", + "format": "int32", + "title": "The maximum number of tasks that can be executed in parallel for the job.", + "description": "The value of maxParallelTasks must be -1 or greater than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API." + }, + "onAllTasksComplete": { + "title": "The action the Batch service should take when all Tasks in the Job are in the completed state.", + "description": "If omitted, the completion behavior is left unchanged. You may not change the value from terminatejob to noaction - that is, once you have engaged automatic Job termination, you cannot turn it off again. If you try to do this, the request fails with an 'invalid property value' error response; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", + "$ref": "#/definitions/OnAllTasksComplete" + }, + "constraints": { + "$ref": "#/definitions/JobConstraints", + "title": "The execution constraints for the Job.", + "description": "If omitted, the existing execution constraints are left unchanged." + }, + "poolInfo": { + "$ref": "#/definitions/PoolInformation", + "title": "The Pool on which the Batch service runs the Job's Tasks.", + "description": "You may change the Pool for a Job only when the Job is disabled. The Patch Job call will fail if you include the poolInfo element and the Job is not disabled. If you specify an autoPoolSpecification in the poolInfo, only the keepAlive property of the autoPoolSpecification can be updated, and then only if the autoPoolSpecification has a poolLifetimeOption of Job (other job properties can be updated as normal). If omitted, the Job continues to run on its current Pool." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the Job as metadata.", + "description": "If omitted, the existing Job metadata is left unchanged." + } + }, + "title": "The set of changes to be made to a Job." + }, + "JobUpdateParameter": { + "type": "object", + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "title": "The priority of the Job.", + "description": "Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. If omitted, it is set to the default value 0." + }, + "constraints": { + "$ref": "#/definitions/JobConstraints", + "title": "The execution constraints for the Job.", + "description": "If omitted, the constraints are cleared." + }, + "poolInfo": { + "$ref": "#/definitions/PoolInformation", + "title": "The Pool on which the Batch service runs the Job's Tasks.", + "description": "You may change the Pool for a Job only when the Job is disabled. The Update Job call will fail if you include the poolInfo element and the Job is not disabled. If you specify an autoPoolSpecification in the poolInfo, only the keepAlive property of the autoPoolSpecification can be updated, and then only if the autoPoolSpecification has a poolLifetimeOption of Job (other job properties can be updated as normal)." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the Job as metadata.", + "description": "If omitted, it takes the default value of an empty list; in effect, any existing metadata is deleted." + }, + "onAllTasksComplete": { + "title": "The action the Batch service should take when all Tasks in the Job are in the completed state.", + "description": "If omitted, the completion behavior is set to noaction. If the current value is terminatejob, this is an error because a Job's completion behavior may not be changed from terminatejob to noaction. You may not change the value from terminatejob to noaction - that is, once you have engaged automatic Job termination, you cannot turn it off again. If you try to do this, the request fails and Batch returns status code 400 (Bad Request) and an 'invalid property value' error response. If you do not specify this element in a PUT request, it is equivalent to passing noaction. This is an error if the current value is terminatejob.", + "$ref": "#/definitions/OnAllTasksComplete" + } + }, + "required": [ + "poolInfo" + ], + "title": "The set of changes to be made to a Job." + }, + "PoolEnableAutoScaleParameter": { + "type": "object", + "properties": { + "autoScaleFormula": { + "type": "string", + "title": "The formula for the desired number of Compute Nodes in the Pool.", + "description": "The formula is checked for validity before it is applied to the Pool. If the formula is not valid, the Batch service rejects the request with detailed error information. For more information about specifying this formula, see Automatically scale Compute Nodes in an Azure Batch Pool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling)." + }, + "autoScaleEvaluationInterval": { + "type": "string", + "format": "duration", + "title": "The time interval at which to automatically adjust the Pool size according to the autoscale formula.", + "description": "The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). If you specify a new interval, then the existing autoscale evaluation schedule will be stopped and a new autoscale evaluation schedule will be started, with its starting time being the time when this request was issued." + } + }, + "title": "Options for enabling automatic scaling on a Pool." + }, + "PoolEvaluateAutoScaleParameter": { + "type": "object", + "properties": { + "autoScaleFormula": { + "type": "string", + "title": "The formula for the desired number of Compute Nodes in the Pool.", + "description": "The formula is validated and its results calculated, but it is not applied to the Pool. To apply the formula to the Pool, 'Enable automatic scaling on a Pool'. For more information about specifying this formula, see Automatically scale Compute Nodes in an Azure Batch Pool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling)." + } + }, + "required": [ + "autoScaleFormula" + ], + "title": "Options for evaluating an automatic scaling formula on a Pool." + }, + "PoolResizeParameter": { + "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 low-priority Compute Nodes in the Pool." + }, + "resizeTimeout": { + "type": "string", + "format": "duration", + "title": "The timeout for allocation of 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 Compute Node and its running task(s) if the Pool size is decreasing.", + "description": "The default value is requeue.", + "$ref": "#/definitions/ComputeNodeDeallocationOption" + } + }, + "title": "Options for changing the size of a Pool." + }, + "PoolUpdatePropertiesParameter": { + "type": "object", + "properties": { + "startTask": { + "$ref": "#/definitions/StartTask", + "title": "A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted.", + "description": "If this element is present, it overwrites any existing StartTask. If omitted, any existing StartTask is removed from the Pool." + }, + "certificateReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateReference" + }, + "title": "A list of Certificates to be installed on each Compute Node in the Pool.", + "description": "This list replaces any existing Certificate references configured on the Pool. If you specify an empty collection, any existing Certificate references are removed from the Pool. For Windows 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." + }, + "applicationPackageReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationPackageReference" + }, + "title": "The list of Application Packages to be installed on each Compute Node in the Pool.", + "description": "The list replaces any existing Application Package references on the Pool. 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. If omitted, or if you specify an empty collection, any existing Application Packages references are removed from the Pool. A maximum of 10 references may be specified on a given Pool." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the Pool as metadata.", + "description": "This list replaces any existing metadata configured on the Pool. If omitted, or if you specify an empty collection, any existing metadata is removed from the Pool." + } + }, + "required": [ + "certificateReferences", + "metadata", + "applicationPackageReferences" + ], + "title": "The set of changes to be made to a Pool." + }, + "PoolPatchParameter": { + "type": "object", + "properties": { + "startTask": { + "$ref": "#/definitions/StartTask", + "title": "A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted.", + "description": "If this element is present, it overwrites any existing StartTask. If omitted, any existing StartTask is left unchanged." + }, + "certificateReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateReference" + }, + "title": "A list of Certificates to be installed on each Compute Node in the Pool.", + "description": "If this element is present, it replaces any existing Certificate references configured on the Pool. If omitted, any existing Certificate references are left unchanged. For Windows 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." + }, + "applicationPackageReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationPackageReference" + }, + "title": "A list of Packages to be installed on each Compute Node in the Pool.", + "description": "Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. If this element is present, it replaces any existing Package references. If you specify an empty collection, then all Package references are removed from the Pool. If omitted, any existing Package references are left unchanged." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the Pool as metadata.", + "description": "If this element is present, it replaces any existing metadata configured on the Pool. If you specify an empty collection, any metadata is removed from the Pool. If omitted, any existing metadata is left unchanged." + } + }, + "title": "The set of changes to be made to a Pool." + }, + "TaskUpdateParameter": { + "type": "object", + "properties": { + "constraints": { + "$ref": "#/definitions/TaskConstraints", + "title": "Constraints that apply to this Task.", + "description": "If omitted, the Task is given the default constraints. For multi-instance Tasks, updating the retention time applies only to the primary Task and not subtasks." + } + }, + "title": "The set of changes to be made to a Task." + }, + "NodeUpdateUserParameter": { + "type": "object", + "properties": { + "password": { + "type": "string", + "title": "The password of the Account.", + "description": "The password is required for Windows Compute Nodes (those created with 'cloudServiceConfiguration', or created with 'virtualMachineConfiguration' using a Windows Image reference). For Linux Compute Nodes, the password can optionally be specified along with the sshPublicKey property. If omitted, any existing password is removed." + }, + "expiryTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Account should expire.", + "description": "If omitted, the default is 1 day from the current time. For Linux Compute Nodes, the expiryTime has a precision up to a day." + }, + "sshPublicKey": { + "type": "string", + "title": "The SSH public key that can be used for remote login to the Compute Node.", + "description": "The public key should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be specified only for Linux Compute Nodes. If this is specified for a Windows Compute Node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). If omitted, any existing SSH public key is removed." + } + }, + "title": "The set of changes to be made to a user Account on a Compute Node." + }, + "NodeRebootParameter": { + "type": "object", + "properties": { + "nodeRebootOption": { + "type": "string", + "title": "When to reboot the Compute Node and what to do with currently running Tasks.", + "description": "The default value is requeue.", + "enum": [ + "requeue", + "terminate", + "taskcompletion", + "retaineddata" + ], + "x-ms-enum": { + "name": "ComputeNodeRebootOption", + "modelAsString": false, + "values": [ + { + "value": "requeue", + "description": "Terminate running Task processes and requeue the Tasks. The Tasks will run again when a Compute Node is available. Restart the Compute Node 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. Restart the Compute Node as soon as Tasks have been terminated." + }, + { + "value": "taskcompletion", + "description": "Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Restart the Compute Node when all Tasks have completed.", + "name": "taskCompletion" + }, + { + "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. Restart the Compute Node when all Task retention periods have expired.", + "name": "retainedData" + } + ] + } + } + }, + "title": "Options for rebooting a Compute Node." + }, + "NodeReimageParameter": { + "type": "object", + "properties": { + "nodeReimageOption": { + "type": "string", + "title": "When to reimage the Compute Node and what to do with currently running Tasks.", + "description": "The default value is requeue.", + "enum": [ + "requeue", + "terminate", + "taskcompletion", + "retaineddata" + ], + "x-ms-enum": { + "name": "ComputeNodeReimageOption", + "modelAsString": false, + "values": [ + { + "value": "requeue", + "description": "Terminate running Task processes and requeue the Tasks. The Tasks will run again when a Compute Node is available. Reimage the Compute Node 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. Reimage the Compute Node as soon as Tasks have been terminated." + }, + { + "value": "taskcompletion", + "description": "Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Reimage the Compute Node when all Tasks have completed.", + "name": "taskCompletion" + }, + { + "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. Reimage the Compute Node when all Task retention periods have expired.", + "name": "retainedData" + } + ] + } + } + }, + "title": "Options for reimaging a Compute Node." + }, + "NodeDisableSchedulingParameter": { + "type": "object", + "properties": { + "nodeDisableSchedulingOption": { + "type": "string", + "title": "What to do with currently running Tasks when disabling Task scheduling on the Compute Node.", + "description": "The default value is requeue.", + "enum": [ + "requeue", + "terminate", + "taskcompletion" + ], + "x-ms-enum": { + "name": "DisableComputeNodeSchedulingOption", + "modelAsString": false, + "values": [ + { + "value": "requeue", + "description": "Terminate running Task processes and requeue the Tasks. The Tasks may run again on other Compute Nodes, or when Task scheduling is re-enabled on this Compute Node. Enter offline state 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. Enter offline state as soon as Tasks have been terminated." + }, + { + "value": "taskcompletion", + "description": "Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Enter offline state when all Tasks have completed.", + "name": "taskCompletion" + } + ] + } + } + }, + "title": "Options for disabling scheduling on a Compute Node." + }, + "NodeRemoveParameter": { + "type": "object", + "properties": { + "nodeList": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string" + }, + "title": "A list containing the IDs of the Compute Nodes to be removed from the specified Pool.", + "description": "A maximum of 100 nodes may be removed per request." + }, + "resizeTimeout": { + "type": "string", + "format": "duration", + "title": "The timeout for removal of Compute Nodes to 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 Compute Node and its running task(s) after it has been selected for deallocation.", + "description": "The default value is requeue.", + "$ref": "#/definitions/ComputeNodeDeallocationOption" + } + }, + "required": [ + "nodeList" + ], + "title": "Options for removing Compute Nodes from a Pool." + }, + "OutputFile": { + "type": "object", + "properties": { + "filePattern": { + "type": "string", + "title": "A pattern indicating which file(s) to upload.", + "description": "Both relative and absolute paths are supported. Relative paths are relative to the Task working directory. The following wildcards are supported: * matches 0 or more characters (for example pattern abc* would match abc or abcdef), ** matches any directory, ? matches any single character, [abc] matches one character in the brackets, and [a-c] matches one character in the range. Brackets can include a negation to match any character not specified (for example [!abc] matches any character but a, b, or c). If a file name starts with \".\" it is ignored by default but may be matched by specifying it explicitly (for example *.gif will not match .a.gif, but .*.gif will). A simple example: **\\*.txt matches any file that does not start in '.' and ends with .txt in the Task working directory or any subdirectory. If the filename contains a wildcard character it can be escaped using brackets (for example abc[*] would match a file named abc*). Note that both \\ and / are treated as directory separators on Windows, but only / is on Linux. Environment variables (%var% on Windows or $var on Linux) are expanded prior to the pattern being applied." + }, + "destination": { + "title": "The destination for the output file(s).", + "$ref": "#/definitions/OutputFileDestination" + }, + "uploadOptions": { + "title": "Additional options for the upload operation, including under what conditions to perform the upload.", + "$ref": "#/definitions/OutputFileUploadOptions" + } + }, + "required": [ + "filePattern", + "destination", + "uploadOptions" + ], + "title": "A specification for uploading files from an Azure Batch Compute Node to another location after the Batch service has finished executing the Task process.", + "description": "On every file uploads, Batch service writes two log files to the compute node, 'fileuploadout.txt' and 'fileuploaderr.txt'. These log files are used to learn more about a specific failure." + }, + "OutputFileDestination": { + "type": "object", + "properties": { + "container": { + "title": "A location in Azure blob storage to which files are uploaded.", + "$ref": "#/definitions/OutputFileBlobContainerDestination" + } + }, + "title": "The destination to which a file should be uploaded." + }, + "OutputFileBlobContainerDestination": { + "type": "object", + "properties": { + "path": { + "type": "string", + "title": "The destination blob or virtual directory within the Azure Storage container.", + "description": "If filePattern refers to a specific file (i.e. contains no wildcards), then path is the name of the blob to which to upload that file. If filePattern contains one or more wildcards (and therefore may match multiple files), then path is the name of the blob virtual directory (which is prepended to each blob name) to which to upload the file(s). If omitted, file(s) are uploaded to the root of the container with a blob name matching their file name." + }, + "containerUrl": { + "type": "string", + "title": "The URL of the container within Azure Blob Storage to which to upload the file(s).", + "description": "If not using a managed identity, the URL must include a Shared Access Signature (SAS) granting write permissions to the container." + }, + "identityReference": { + "title": "The reference to the user assigned identity to use to access Azure Blob Storage specified by containerUrl", + "description": "The identity must have write access to the Azure Blob Storage container", + "$ref": "#/definitions/ComputeNodeIdentityReference" + } + }, + "required": [ + "containerUrl" + ], + "title": "Specifies a file upload destination within an Azure blob storage container." + }, + "OutputFileUploadOptions": { + "type": "object", + "properties": { + "uploadCondition": { + "title": "The conditions under which the Task output file or set of files should be uploaded.", + "description": "The default is taskcompletion.", + "$ref": "#/definitions/OutputFileUploadCondition" + } + }, + "required": [ + "uploadCondition" + ], + "title": "Details about an output file upload operation, including under what conditions to perform the upload." + }, + "ErrorMessage": { + "type": "object", + "properties": { + "lang": { + "type": "string", + "title": "The language code of the error message" + }, + "value": { + "type": "string", + "title": "The text of the message." + } + }, + "title": "An error message received in an Azure Batch error response." + }, + "BatchErrorDetail": { + "type": "object", + "properties": { + "key": { + "type": "string", + "title": "An identifier specifying the meaning of the Value property." + }, + "value": { + "type": "string", + "title": "The additional information included with the error response." + } + }, + "title": "An item of additional information included in an Azure Batch error response." + }, + "BatchError": { + "type": "object", + "properties": { + "code": { + "type": "string", + "title": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "$ref": "#/definitions/ErrorMessage", + "title": "A message describing the error, intended to be suitable for display in a user interface." + }, + "values": { + "type": "array", + "items": { + "$ref": "#/definitions/BatchErrorDetail" + }, + "title": "A collection of key-value pairs containing additional details about the error." + } + }, + "title": "An error response received from the Azure Batch service." + }, + "CertificateState": { + "type": "string", + "title": "The state of the Certificate.", + "enum": [ + "active", + "deleting", + "deletefailed" + ], + "x-ms-enum": { + "name": "CertificateState", + "modelAsString": false, + "values": [ + { + "value": "active", + "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": "deletefailed", + "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 Nodes. (The latter can occur if the Certificate has been removed from the Pool, but the Compute Node has not yet restarted. Compute 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.", + "name": "deleteFailed" + } + ] + } + }, + "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.", + "name": "nonAdmin" + }, + { + "value": "admin", + "description": "The user is a user with elevated access and operates with full Administrator permissions." + } + ] + } + }, + "JobScheduleState": { + "type": "string", + "title": "The state of the Job Schedule.", + "enum": [ + "active", + "completed", + "disabled", + "terminating", + "deleting" + ], + "x-ms-enum": { + "name": "JobScheduleState", + "modelAsString": false, + "values": [ + { + "value": "active", + "description": "The Job Schedule is active and will create Jobs as per its schedule." + }, + { + "value": "completed", + "description": "The Job Schedule has terminated, either by reaching its end time or by the user terminating it explicitly." + }, + { + "value": "disabled", + "description": "The user has disabled the Job Schedule. The scheduler will not initiate any new Jobs will on this schedule, but any existing active Job will continue to run." + }, + { + "value": "terminating", + "description": "The Job Schedule has no more work to do, or has been explicitly terminated by the user, but the termination operation is still in progress. The scheduler will not initiate any new Jobs for this Job Schedule, nor is any existing Job active." + }, + { + "value": "deleting", + "description": "The user has requested that the Job Schedule be deleted, but the delete operation is still in progress. The scheduler will not initiate any new Jobs for this Job Schedule, and will delete any existing Jobs and Tasks under the Job Schedule, including any active Job. The Job Schedule will be deleted when all Jobs and Tasks under the Job Schedule have been deleted." + } + ] + } + }, + "JobState": { + "type": "string", + "title": "The state of the Job.", + "enum": [ + "active", + "disabling", + "disabled", + "enabling", + "terminating", + "completed", + "deleting" + ], + "x-ms-enum": { + "name": "JobState", + "modelAsString": false, + "values": [ + { + "value": "active", + "description": "The Job is available to have Tasks scheduled." + }, + { + "value": "disabling", + "description": "A user has requested that the Job be disabled, but the disable operation is still in progress (for example, waiting for Tasks to terminate)." + }, + { + "value": "disabled", + "description": "A user has disabled the Job. No Tasks are running, and no new Tasks will be scheduled." + }, + { + "value": "enabling", + "description": "A user has requested that the Job be enabled, but the enable operation is still in progress." + }, + { + "value": "terminating", + "description": "The Job is about to complete, either because a Job Manager Task has completed or because the user has terminated the Job, but the terminate operation is still in progress (for example, because Job Release Tasks are running)." + }, + { + "value": "completed", + "description": "All Tasks have terminated, and the system will not accept any more Tasks or any further changes to the Job." + }, + { + "value": "deleting", + "description": "A user has requested that the Job be deleted, but the delete operation is still in progress (for example, because the system is still terminating running Tasks)." + } + ] + } + }, + "OnAllTasksComplete": { + "type": "string", + "title": "The action the Batch service should take when all Tasks in the Job are in the completed state.", + "enum": [ + "noaction", + "terminatejob" + ], + "x-ms-enum": { + "name": "OnAllTasksComplete", + "modelAsString": false, + "values": [ + { + "value": "noaction", + "description": "Do nothing. The Job remains active unless terminated or disabled by some other means.", + "name": "noAction" + }, + { + "value": "terminatejob", + "description": "Terminate the Job. The Job's terminateReason is set to 'AllTasksComplete'.", + "name": "terminateJob" + } + ] + } + }, + "OnTaskFailure": { + "type": "string", + "title": "The action the Batch service should take when any Task in the Job fails.", + "description": "A Task is considered to have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error. The default is noaction.", + "enum": [ + "noaction", + "performexitoptionsjobaction" + ], + "x-ms-enum": { + "name": "OnTaskFailure", + "modelAsString": false, + "values": [ + { + "value": "noaction", + "description": "Do nothing. The Job remains active unless terminated or disabled by some other means.", + "name": "noAction" + }, + { + "value": "performexitoptionsjobaction", + "description": "Take the action associated with the Task exit condition in the Task's exitConditions collection. (This may still result in no action being taken, if that is what the Task specifies.)", + "name": "performExitOptionsJobAction" + } + ] + } + }, + "ErrorCategory": { + "type": "string", + "title": "The category of the error.", + "enum": [ + "usererror", + "servererror" + ], + "x-ms-enum": { + "name": "ErrorCategory", + "modelAsString": false, + "values": [ + { + "value": "usererror", + "description": "The error is due to a user issue, such as misconfiguration.", + "name": "userError" + }, + { + "value": "servererror", + "description": "The error is due to an internal server issue.", + "name": "serverError" + } + ] + } + }, + "TaskState": { + "type": "string", + "title": "The state of the Task.", + "enum": [ + "active", + "preparing", + "running", + "completed" + ], + "x-ms-enum": { + "name": "TaskState", + "modelAsString": false, + "values": [ + { + "value": "active", + "description": "The Task is queued and able to run, but is not currently assigned to a Compute Node. A Task enters this state when it is created, when it is enabled after being disabled, or when it is awaiting a retry after a failed run." + }, + { + "value": "preparing", + "description": "The Task has been assigned to a Compute Node, but is waiting for a required Job Preparation Task to complete on the Compute Node. If the Job Preparation Task succeeds, the Task will move to running. If the Job Preparation Task fails, the Task will return to active and will be eligible to be assigned to a different Compute Node." + }, + { + "value": "running", + "description": "The Task is running on a Compute Node. This includes task-level preparation such as downloading resource files or deploying Packages specified on the Task - it does not necessarily mean that the Task command line has started executing." + }, + { + "value": "completed", + "description": "The Task is no longer eligible to run, usually because the Task has finished successfully, or the Task has finished unsuccessfully and has exhausted its retry limit. A Task is also marked as completed if an error occurred launching the Task, or when the Task has been terminated." + } + ] + } + }, + "SubtaskState": { + "type": "string", + "title": "The state of the subtask.", + "enum": [ + "preparing", + "running", + "completed" + ], + "x-ms-enum": { + "name": "SubtaskState", + "modelAsString": false, + "values": [ + { + "value": "preparing", + "description": "The Task has been assigned to a Compute Node, but is waiting for a required Job Preparation Task to complete on the Compute Node. If the Job Preparation Task succeeds, the Task will move to running. If the Job Preparation Task fails, the Task will return to active and will be eligible to be assigned to a different Compute Node." + }, + { + "value": "running", + "description": "The Task is running on a Compute Node. This includes task-level preparation such as downloading resource files or deploying Packages specified on the Task - it does not necessarily mean that the Task command line has started executing." + }, + { + "value": "completed", + "description": "The Task is no longer eligible to run, usually because the Task has finished successfully, or the Task has finished unsuccessfully and has exhausted its retry limit. A Task is also marked as completed if an error occurred launching the Task, or when the Task has been terminated." + } + ] + } + }, + "ComputeNodeDeallocationOption": { + "type": "string", + "title": "Determines what to do with a Compute Node and its running task(s) after it has been selected for deallocation.", + "description": "The default value is requeue.", + "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 Compute Node is available. Remove Compute 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 Compute Nodes as soon as Tasks have been terminated." + }, + { + "value": "taskcompletion", + "description": "Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Remove Compute Nodes when all Tasks have completed.", + "name": "taskCompletion" + }, + { + "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 Compute Nodes when all Task retention periods have expired.", + "name": "retainedData" + } + ] + } + }, + "OutputFileUploadCondition": { + "type": "string", + "title": "The conditions under which a Task output file or set of files should be uploaded.", + "enum": [ + "tasksuccess", + "taskfailure", + "taskcompletion" + ], + "x-ms-enum": { + "name": "OutputFileUploadCondition", + "modelAsString": false, + "values": [ + { + "value": "tasksuccess", + "description": "Upload the file(s) only after the Task process exits with an exit code of 0.", + "name": "taskSuccess" + }, + { + "value": "taskfailure", + "description": "Upload the file(s) only after the Task process exits with a nonzero exit code.", + "name": "taskFailure" + }, + { + "value": "taskcompletion", + "description": "Upload the file(s) after the Task process exits, no matter what the exit code was.", + "name": "taskCompletion" + } + ] + } + }, + "TaskExecutionResult": { + "type": "string", + "title": "The result of Task execution.", + "enum": [ + "success", + "failure" + ], + "x-ms-enum": { + "name": "TaskExecutionResult", + "modelAsString": false, + "values": [ + { + "value": "success", + "description": "The Task ran successfully.", + "name": "success" + }, + { + "value": "failure", + "description": "There was an error during processing of the Task. The failure may have occurred before the Task process was launched, while the Task process was executing, or after the Task process exited.", + "name": "failure" + } + ] + } + }, + "InboundEndpointProtocol": { + "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.", + "name": "tcp" + }, + { + "value": "udp", + "description": "Use UDP for the endpoint.", + "name": "udp" + } + ] + } + }, + "UploadBatchServiceLogsConfiguration": { + "type": "object", + "properties": { + "containerUrl": { + "type": "string", + "title": "The URL of the container within Azure Blob Storage to which to upload the Batch Service log file(s).", + "description": "If a user assigned managed identity is not being used, the URL must include a Shared Access Signature (SAS) granting write permissions to the container. The SAS duration must allow enough time for the upload to finish. The start time for SAS is optional and recommended to not be specified." + }, + "startTime": { + "type": "string", + "format": "date-time", + "title": "The start of the time range from which to upload Batch Service log file(s).", + "description": "Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded, but the operation should not retrieve fewer logs than have been requested." + }, + "endTime": { + "type": "string", + "format": "date-time", + "title": "The end of the time range from which to upload Batch Service log file(s).", + "description": "Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded, but the operation should not retrieve fewer logs than have been requested. If omitted, the default is to upload all logs available after the startTime." + }, + "identityReference": { + "title": "The reference to the user assigned identity to use to access Azure Blob Storage specified by containerUrl.", + "description": "The identity must have write access to the Azure Blob Storage container.", + "$ref": "#/definitions/ComputeNodeIdentityReference" + } + }, + "required": [ + "containerUrl", + "startTime" + ], + "title": "The Azure Batch service log files upload configuration for a Compute Node." + }, + "UploadBatchServiceLogsResult": { + "type": "object", + "properties": { + "virtualDirectoryName": { + "type": "string", + "title": "The virtual directory within Azure Blob Storage container to which the Batch Service log file(s) will be uploaded.", + "description": "The virtual directory name is part of the blob name for each log file uploaded, and it is built based poolId, nodeId and a unique identifier." + }, + "numberOfFilesUploaded": { + "type": "integer", + "format": "int32", + "title": "The number of log files which will be uploaded." + } + }, + "required": [ + "virtualDirectoryName", + "numberOfFilesUploaded" + ], + "title": "The result of uploading Batch service log files from a specific Compute Node." + }, + "PoolNodeCountsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PoolNodeCounts" + }, + "description": "A list of Compute Node counts by Pool." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the Compute Node counts in the Account." + }, + "PoolNodeCounts": { + "type": "object", + "properties": { + "poolId": { + "type": "string", + "title": "The ID of the Pool." + }, + "dedicated": { + "$ref": "#/definitions/NodeCounts", + "title": "The number of dedicated Compute Nodes in each state." + }, + "lowPriority": { + "$ref": "#/definitions/NodeCounts", + "title": "The number of low-priority Compute Nodes in each state." + } + }, + "required": [ + "poolId" + ], + "title": "The number of Compute Nodes in each state for a Pool." + }, + "NodeCounts": { + "type": "object", + "properties": { + "creating": { + "type": "integer", + "format": "int32", + "title": "The number of Compute Nodes in the creating state." + }, + "idle": { + "type": "integer", + "format": "int32", + "title": "The number of Compute Nodes in the idle state." + }, + "offline": { + "type": "integer", + "format": "int32", + "title": "The number of Compute Nodes in the offline state." + }, + "preempted": { + "type": "integer", + "format": "int32", + "title": "The number of Compute Nodes in the preempted state." + }, + "rebooting": { + "type": "integer", + "format": "int32", + "title": "The count of Compute Nodes in the rebooting state." + }, + "reimaging": { + "type": "integer", + "format": "int32", + "title": "The number of Compute Nodes in the reimaging state." + }, + "running": { + "type": "integer", + "format": "int32", + "title": "The number of Compute Nodes in the running state." + }, + "starting": { + "type": "integer", + "format": "int32", + "title": "The number of Compute Nodes in the starting state." + }, + "startTaskFailed": { + "type": "integer", + "format": "int32", + "title": "The number of Compute Nodes in the startTaskFailed state." + }, + "leavingPool": { + "type": "integer", + "format": "int32", + "title": "The number of Compute Nodes in the leavingPool state." + }, + "unknown": { + "type": "integer", + "format": "int32", + "title": "The number of Compute Nodes in the unknown state." + }, + "unusable": { + "type": "integer", + "format": "int32", + "title": "The number of Compute Nodes in the unusable state." + }, + "waitingForStartTask": { + "type": "integer", + "format": "int32", + "title": "The number of Compute Nodes in the waitingForStartTask state." + }, + "total": { + "type": "integer", + "format": "int32", + "title": "The total number of Compute Nodes." + } + }, + "required": [ + "creating", + "idle", + "offline", + "preempted", + "rebooting", + "reimaging", + "running", + "starting", + "startTaskFailed", + "leavingPool", + "unknown", + "unusable", + "waitingForStartTask", + "total" + ], + "title": "The number of Compute Nodes in each Compute Node state." + }, + "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." + }, + "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." + }, + "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." + } + }, + "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." + }, + "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", + "accountKey", + "relativeMountPath" + ], + "title": "Information used to connect to an Azure Fileshare." + }, + "BatchPoolIdentity": { + "type": "object", + "title": "The identity of the Batch pool, if configured.", + "properties": { + "type": { + "type": "string", + "title": "The identity of the Batch pool, if configured.", + "description": "The list of user identities associated with the Batch pool. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "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": "array", + "title": "The list of user identities associated with the Batch account.", + "description": "The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "items": { + "$ref": "#/definitions/UserAssignedIdentity" + } + } + }, + "description": "The identity of the Batch pool, if configured.", + "required": [ + "type" + ] + }, + "UserAssignedIdentity": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "description": "The ARM resource id of the user assigned identity" + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of the user assigned identity." + }, + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the user assigned identity." + } + }, + "description": "The user assigned Identity", + "required": [ + "resourceId" + ] + }, + "ComputeNodeIdentityReference": { + "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." + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API Version." + }, + "batchUrl": { + "name": "batchUrl", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "description": "The base URL for all Azure Batch service requests." + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/AccountListPoolNodeCounts.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/AccountListPoolNodeCounts.json new file mode 100644 index 000000000000..01ae3e9eed47 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/AccountListPoolNodeCounts.json @@ -0,0 +1,121 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "poolId": "pool1", + "dedicated": { + "creating": 0, + "idle": 0, + "leavingPool": 0, + "offline": 0, + "preempted": 0, + "rebooting": 0, + "reimaging": 0, + "running": 0, + "starting": 0, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "total": 0 + }, + "lowPriority": { + "creating": 0, + "idle": 0, + "leavingPool": 0, + "offline": 0, + "preempted": 0, + "rebooting": 0, + "reimaging": 0, + "running": 2, + "starting": 1, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "total": 3 + } + }, + { + "poolId": "pool2", + "dedicated": { + "creating": 0, + "idle": 1, + "leavingPool": 0, + "offline": 3, + "preempted": 0, + "rebooting": 0, + "reimaging": 0, + "running": 0, + "starting": 0, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "total": 4 + }, + "lowPriority": { + "creating": 0, + "idle": 0, + "leavingPool": 0, + "offline": 0, + "preempted": 0, + "rebooting": 0, + "reimaging": 0, + "running": 0, + "starting": 0, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "total": 0 + } + }, + { + "poolId": "pool3", + "dedicated": { + "creating": 0, + "idle": 5, + "leavingPool": 0, + "offline": 0, + "preempted": 0, + "rebooting": 0, + "reimaging": 4, + "running": 0, + "starting": 0, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "total": 9 + }, + "lowPriority": { + "creating": 7, + "idle": 0, + "leavingPool": 0, + "offline": 0, + "preempted": 0, + "rebooting": 0, + "reimaging": 0, + "running": 4, + "starting": 0, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "total": 11 + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/AccountListSupportedImages.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/AccountListSupportedImages.json new file mode 100644 index 000000000000..4e6f5d2a4534 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/AccountListSupportedImages.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "nodeAgentSKUId": "batch.node.centos 7", + "imageReference": { + "publisher": "OpenLogic", + "offer": "CentOS", + "sku": "7.2", + "version": "latest" + }, + "verificationType": "verified", + "capabilities": [ + "DockerCompatible", + "NvidiaTeslaDriverInstalled" + ], + "osType": "linux" + }, + { + "nodeAgentSKUId": "batch.node.centos 7", + "imageReference": { + "publisher": "OpenLogic", + "offer": "CentOS", + "sku": "7.1", + "version": "latest" + }, + "verificationType": "unverified", + "osType": "linux", + "batchSupportEndOfLife": "2019-11-01T00:00:00.0Z" + }, + { + "nodeAgentSKUId": "batch.node.debian 8", + "imageReference": { + "publisher": "Credativ", + "offer": "Debian", + "sku": "8", + "version": "latest" + }, + "verificationType": "verified", + "osType": "linux" + }, + { + "nodeAgentSKUId": "batch.node.windows amd64", + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2012-R2-Datacenter", + "version": "latest" + }, + "verificationType": "verified", + "osType": "windows" + }, + { + "nodeAgentSKUId": "batch.node.windows amd64", + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2012-Datacenter", + "version": "latest" + }, + "verificationType": "verified", + "osType": "windows" + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/ApplicationGet.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/ApplicationGet.json new file mode 100644 index 000000000000..7d89644fb249 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/ApplicationGet.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "applicationId": "my_application_id" + }, + "responses": { + "200": { + "body": { + "id": "my_application_id", + "versions": [ + "v1.0" + ], + "displayName": "my_display_name" + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/ApplicationList.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/ApplicationList.json new file mode 100644 index 000000000000..a31beb54c6a4 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/ApplicationList.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "my_application_id", + "versions": [ + "v1.0" + ], + "displayName": "my_display_name" + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/CertificateAdd.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/CertificateAdd.json new file mode 100644 index 000000000000..9542dfd0b4f6 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/CertificateAdd.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "certificate": { + "thumbprintAlgorithm": "sha1", + "thumbprint": "0123456789abcdef0123456789abcdef01234567", + "data": "#####...", + "certificateFormat": "pfx", + "password": "" + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/CertificateCancelDelete.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/CertificateCancelDelete.json new file mode 100644 index 000000000000..52cfc3639b55 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/CertificateCancelDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "thumbprintAlgorithm": "sha1", + "thumbprint": "0123456789abcdef0123456789abcdef01234567", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "204": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/CertificateDelete.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/CertificateDelete.json new file mode 100644 index 000000000000..d527895cebd2 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/CertificateDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "thumbprintAlgorithm": "sha1", + "thumbprint": "0123456789abcdef0123456789abcdef01234567", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/CertificateGet.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/CertificateGet.json new file mode 100644 index 000000000000..68060f0d5875 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/CertificateGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "thumbprintAlgorithm": "sha1", + "thumbprint": "0123456789abcdef0123456789abcdef01234567", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "thumbprint": "0123456789abcdef0123456789abcdef01234567", + "thumbprintAlgorithm": "sha1", + "url": "https://account.region.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=0123456789abcdef0123456789abcdef01234567)", + "state": "deletefailed", + "stateTransitionTime": "2014-07-31T21:12:58.236Z", + "previousState": "deleting", + "previousStateTransitionTime": "2014-07-31T21:11:58.236Z", + "publicData": "#####...", + "deleteCertificateError": { + "code": "PoolsReferencingCertificate", + "message": "The specified certificate is being used by the below mentioned pool(s)", + "values": [ + { + "name": "Pools", + "value": "mypool1" + } + ] + } + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/CertificateList.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/CertificateList.json new file mode 100644 index 000000000000..48f51178ebda --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/CertificateList.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "thumbprint": "0123456789abcdef0123456789abcdef01234567", + "thumbprintAlgorithm": "sha1", + "url": "https://account.region.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=0123456789abcdef0123456789abcdef01234567)", + "state": "deletefailed", + "stateTransitionTime": "2014-07-31T21:12:58.236Z", + "previousState": "deleting", + "previousStateTransitionTime": "2014-07-31T21:11:58.236Z", + "publicData": "#####...", + "deleteCertificateError": { + "code": "PoolsReferencingCertificate", + "message": "The specified certificate is being used by the below mentioned pool(s)", + "values": [ + { + "name": "Pools", + "value": "mypool1" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/ComputeNodeExtensionGet.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/ComputeNodeExtensionGet.json new file mode 100644 index 000000000000..68565eec9bdc --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/ComputeNodeExtensionGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "poolId": "poolId", + "nodeId": "tvm-1695681911_2-20161122t193202z", + "extensionName": "batchNodeExtension", + "api-version": "2021-06-01.14.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "instanceView": { + "name": "batchNodeExtension", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": "Enable succeeded: Enabling and starting agent and controller" + } + ] + }, + "vmExtension": { + "name": "batchNodeExtension", + "publisher": "Microsoft.Azure.Extensions", + "type": "CustomScript", + "typeHandlerVersion": "2.0", + "autoUpgradeMinorVersion": true + } + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/ComputeNodeExtensionList.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/ComputeNodeExtensionList.json new file mode 100644 index 000000000000..6bcea70cb90a --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/ComputeNodeExtensionList.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_2-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "instanceView": { + "name": "batchNodeExtension", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": "Enable succeeded: Enabling and starting agent and controller" + } + ] + }, + "vmExtension": { + "name": "batchNodeExtension", + "publisher": "Microsoft.Azure.Extensions", + "type": "CustomScript", + "typeHandlerVersion": "2.0", + "autoUpgradeMinorVersion": true + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/FileDeleteFromNode.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/FileDeleteFromNode.json new file mode 100644 index 000000000000..e21659eafb48 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/FileDeleteFromNode.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "recursive": false + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/FileDeleteFromTask.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/FileDeleteFromTask.json new file mode 100644 index 000000000000..56d7aeb972bd --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/FileDeleteFromTask.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobId": "jobId", + "taskId": "task1", + "filePath": "wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "recursive": false + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/FileGetFromNode.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/FileGetFromNode.json new file mode 100644 index 000000000000..2b1047f9ce71 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/FileGetFromNode.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "poolId": "poolId", + "nodeId": "nodeId", + "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", + "ocp-batch-file-isdirectory": "false", + "Content-Length": "17", + "Content-Type": "application/octet-stream", + "body": "This is actually a byte stream. This request/response is being presented as a string for readability in the example" + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/FileGetFromTask.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/FileGetFromTask.json new file mode 100644 index 000000000000..b76f165a67ab --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/FileGetFromTask.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobId": "jobId", + "taskId": "task1", + "filePath": "wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", + "ocp-batch-file-isdirectory": "false", + "Content-Length": "17", + "Content-Type": "application/octet-stream", + "body": "This is actually a byte stream. This request/response is being presented as a string for readability in the example" + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/FileGetPropertiesFromNode.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/FileGetPropertiesFromNode.json new file mode 100644 index 000000000000..25cf1b5c897b --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/FileGetPropertiesFromNode.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "poolId": "poolId", + "nodeId": "nodeId", + "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", + "ocp-batch-file-isdirectory": "false", + "Content-Length": "17", + "Content-Type": "application/octet-stream" + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/FileGetPropertiesFromTask.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/FileGetPropertiesFromTask.json new file mode 100644 index 000000000000..883d746510b8 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/FileGetPropertiesFromTask.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobId": "jobId", + "taskId": "taskId", + "filePath": "wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", + "ocp-batch-file-isdirectory": "false", + "Content-Length": "17", + "Content-Type": "application/octet-stream" + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/FileListFromNode.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/FileListFromNode.json new file mode 100644 index 000000000000..ffd284fb487c --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/FileListFromNode.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "recursive": false + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "shared", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/shared", + "isDirectory": true + }, + { + "name": "startup\\ProcessEnv.cmd", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/startup\\ProcessEnv.cmd", + "isDirectory": false, + "properties": { + "creationTime": "2014-09-19T21:56:17.679195Z", + "lastModified": "2014-09-19T21:56:17.679195Z", + "contentLength": 1813, + "contentType": "application/octet-stream" + } + }, + { + "name": "startup\\stderr.txt", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/startup\\stderr.txt", + "isDirectory": false, + "properties": { + "creationTime": "2014-09-19T21:56:17.5590855Z", + "lastModified": "2014-09-19T21:56:17.5590855Z", + "contentLength": 0, + "contentType": "application/octet-stream" + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/FileListFromTask.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/FileListFromTask.json new file mode 100644 index 000000000000..0c12adffa466 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/FileListFromTask.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "recursive": false + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "startup\\ProcessEnv.cmd", + "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId/files/startup\\ProcessEnv.cmd", + "isDirectory": false, + "properties": { + "creationTime": "2014-09-19T21:56:17.679195Z", + "lastModified": "2014-09-19T21:56:17.679195Z", + "contentLength": 1813, + "contentType": "application/octet-stream" + } + }, + { + "name": "startup\\stderr.txt", + "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId/files/startup\\stderr.txt", + "isDirectory": false, + "properties": { + "creationTime": "2014-09-19T21:56:17.5590855Z", + "lastModified": "2014-09-19T21:56:17.5590855Z", + "contentLength": 0, + "contentType": "application/octet-stream" + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobAdd_Basic.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobAdd_Basic.json new file mode 100644 index 000000000000..063703e88f0a --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobAdd_Basic.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "job": { + "id": "jobId", + "priority": 0, + "poolInfo": { + "poolId": "poolId" + } + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobAdd_Complex.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobAdd_Complex.json new file mode 100644 index 000000000000..d7b297a1800c --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobAdd_Complex.json @@ -0,0 +1,121 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "job": { + "id": "jobId", + "priority": 100, + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": -1 + }, + "jobManagerTask": { + "id": "taskId", + "commandLine": "myprogram.exe", + "resourceFiles": [ + { + "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram.exe?sas", + "filePath": "myprogram.exe" + }, + { + "storageContainerUrl": "http://mystorage1.blob.core.windows.net/data?sas", + "filePath": "datafolder" + } + ], + "environmentSettings": [ + { + "name": "myvariable", + "value": "myvalue" + } + ], + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": 0, + "retentionTime": "PT1H" + }, + "requiredSlots": 2, + "killJobOnCompletion": false, + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "admin" + } + }, + "runExclusive": true + }, + "poolInfo": { + "autoPoolSpecification": { + "autoPoolIdPrefix": "mypool", + "poolLifetimeOption": "job", + "pool": { + "vmSize": "small", + "cloudServiceConfiguration": { + "osFamily": "4", + "osVersion": "*" + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 2, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false, + "enableInterNodeCommunication": true, + "startTask": { + "commandLine": "myprogram2.exe", + "resourceFiles": [ + { + "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram2.exe?sas", + "filePath": "myprogram2.exe" + } + ], + "environmentSettings": [ + { + "name": "myvariable", + "value": "myvalue" + } + ], + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "admin" + } + }, + "maxTaskRetryCount": 2, + "waitForSuccess": true + }, + "certificateReferences": [ + { + "thumbprint": "0123456789abcdef0123456789abcdef01234567", + "thumbprintAlgorithm": "sha1", + "storeLocation": "localmachine", + "storeName": "Root", + "visibility": [ + "task" + ] + } + ], + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ] + } + } + }, + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ] + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobDelete.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobDelete.json new file mode 100644 index 000000000000..bf1163d6be05 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobDisable.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobDisable.json new file mode 100644 index 000000000000..9f5e7e96a402 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobDisable.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobDisableParameter": { + "disableTasks": "terminate" + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobEnable.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobEnable.json new file mode 100644 index 000000000000..bf1163d6be05 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobEnable.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobGet.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobGet.json new file mode 100644 index 000000000000..8d89379f931c --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobGet.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "jobId", + "url": "https://account.region.batch.azure.com/jobs/jobId", + "eTag": "0x8D4100FC49F0278", + "lastModified": "2016-11-19T00:05:27.5391608Z", + "creationTime": "2016-11-19T00:05:25.311915Z", + "state": "completed", + "stateTransitionTime": "2016-11-19T00:05:27.578581Z", + "previousState": "active", + "previousStateTransitionTime": "2016-11-19T00:05:27.2137716Z", + "priority": 0, + "maxParallelTasks": -1, + "usesTaskDependencies": false, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + }, + "executionInfo": { + "startTime": "2016-11-19T00:05:25.3309105Z", + "endTime": "2016-11-19T00:05:27.578581Z", + "poolId": "poolId", + "terminateReason": "UserTerminate" + }, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction" + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobGetLifetimeStatistics.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobGetLifetimeStatistics.json new file mode 100644 index 000000000000..d5bd89f3d2b6 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobGetLifetimeStatistics.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "url": "https://account.region.batch.core.windows.net/lifetimejobstats", + "startTime": "2014-08-01T18:30:00.4345729Z", + "lastUpdateTime": "2014-08-04T18:30:00.4345729Z", + "userCPUTime": "PT0S", + "kernelCPUTime": "PT0S", + "wallClockTime": "PT0S", + "readIOps": 0, + "writeIOps": 0, + "readIOGiB": 10.0, + "writeIOGiB": 5.0, + "numSucceededTasks": 0, + "numFailedTasks": 0, + "numTaskRetries": 0, + "waitTime": "PT0S" + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobGetTaskCounts.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobGetTaskCounts.json new file mode 100644 index 000000000000..cb36267df107 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobGetTaskCounts.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "taskCounts": { + "active": 5, + "running": 7, + "completed": 4, + "succeeded": 2, + "failed": 2 + }, + "taskSlotCounts": { + "active": 5, + "running": 7, + "completed": 4, + "succeeded": 2, + "failed": 2 + } + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobList.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobList.json new file mode 100644 index 000000000000..2df5f5575811 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobList.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "jobId", + "url": "https://account.region.batch.azure.com/jobs/jobId", + "eTag": "0x8D4100FC46D5BF4", + "lastModified": "2016-11-19T00:05:27.2137716Z", + "creationTime": "2016-11-19T00:05:25.311915Z", + "state": "active", + "stateTransitionTime": "2016-11-19T00:05:27.2137716Z", + "previousState": "disabled", + "previousStateTransitionTime": "2016-11-19T00:05:26.88777Z", + "priority": 0, + "maxParallelTasks": -1, + "usesTaskDependencies": false, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + }, + "executionInfo": { + "startTime": "2016-11-19T00:05:25.3309105Z", + "poolId": "poolId" + }, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction" + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobListFromJobSchedule.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobListFromJobSchedule.json new file mode 100644 index 000000000000..5e9fcc995acd --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobListFromJobSchedule.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "jobId", + "url": "https://account.region.batch.azure.com/jobs/jobId", + "eTag": "0x8D4100FC46D5BF4", + "lastModified": "2016-11-19T00:05:27.2137716Z", + "creationTime": "2016-11-19T00:05:25.311915Z", + "state": "active", + "stateTransitionTime": "2016-11-19T00:05:27.2137716Z", + "previousState": "disabled", + "previousStateTransitionTime": "2016-11-19T00:05:26.88777Z", + "priority": 0, + "usesTaskDependencies": false, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + }, + "executionInfo": { + "startTime": "2016-11-19T00:05:25.3309105Z", + "poolId": "poolId" + }, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction" + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobListPreparationAndReleaseTaskStatus.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobListPreparationAndReleaseTaskStatus.json new file mode 100644 index 000000000000..b66d897f626a --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobListPreparationAndReleaseTaskStatus.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "poolId": "poolId", + "nodeId": "tvm-2167304207_1-20140905t174658z", + "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z", + "jobPreparationTaskExecutionInfo": { + "state": "completed", + "startTime": "2015-05-01T10:20:31Z", + "endTime": "2015-05-02T20:12:42Z", + "taskRootDirectory": "tasks/myjob/job-1/myjobpreptask", + "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z/files/tasks/myjob/job-1/myjobpreptask", + "exitCode": 0, + "retryCount": 0 + }, + "jobReleaseTaskExecutionInfo": { + "state": "completed", + "startTime": "2015-05-01T10:20:31Z", + "endTime": "2015-05-02T20:12:42Z", + "taskRootDirectory": "tasks/myjob/job-1/myjobreleasetask", + "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z/files/tasks/myjob/job-1/myjobreleasetask", + "exitCode": 0 + } + } + ], + "odata.nextLink": "https://account.region.batch.azure.com/jobs/myjob/jobpreparationandreleasestatus?$skipToken=tvm-2167304207_1-20140905t174658z&api-version=2021-06-01.14.0" + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobPatch.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobPatch.json new file mode 100644 index 000000000000..c3a1af46d3ad --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobPatch.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobPatchParameter": { + "priority": 100, + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": -1 + }, + "poolInfo": { + "poolId": "poolId" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobScheduleAdd_Basic.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobScheduleAdd_Basic.json new file mode 100644 index 000000000000..e56b23bdff79 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobScheduleAdd_Basic.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "cloudJobSchedule": { + "id": "jobScheduleId", + "schedule": { + "recurrenceInterval": "PT5M" + }, + "jobSpecification": { + "poolInfo": { + "poolId": "poolId" + } + } + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobScheduleAdd_Complex.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobScheduleAdd_Complex.json new file mode 100644 index 000000000000..0a2ebf4aa79b --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobScheduleAdd_Complex.json @@ -0,0 +1,129 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "cloudJobSchedule": { + "id": "jobScheduleId", + "schedule": { + "doNotRunUntil": "2014-09-10T02:30:00.000Z", + "doNotRunAfter": "2014-09-10T06:30:00.000Z", + "startWindow": "PT1M", + "recurrenceInterval": "PT5M" + }, + "jobSpecification": { + "priority": 100, + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": -1 + }, + "jobManagerTask": { + "id": "mytask1", + "commandLine": "myprogram.exe", + "resourceFiles": [ + { + "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram.exe?sas", + "filePath": "myprogram.exe" + }, + { + "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/test.txt?sas", + "filePath": "test.txt" + } + ], + "environmentSettings": [ + { + "name": "myvariable", + "value": "myvalue" + } + ], + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": 0, + "retentionTime": "PT1H" + }, + "requiredSlots": 2, + "killJobOnCompletion": true, + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "runExclusive": true + }, + "poolInfo": { + "autoPoolSpecification": { + "autoPoolIdPrefix": "mypool", + "poolLifetimeOption": "jobschedule", + "pool": { + "vmSize": "small", + "cloudServiceConfiguration": { + "osFamily": "4", + "osVersion": "*" + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 2, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false, + "enableInterNodeCommunication": true, + "startTask": { + "commandLine": "myprogram2.exe", + "resourceFiles": [ + { + "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram2.exe?sas", + "filePath": "myprogram2.exe" + } + ], + "environmentSettings": [ + { + "name": "myvariable", + "value": "myvalue" + } + ], + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "admin" + } + }, + "maxTaskRetryCount": 2, + "waitForSuccess": true + }, + "certificateReferences": [ + { + "thumbprint": "0123456789abcdef0123456789abcdef01234567", + "thumbprintAlgorithm": "sha1", + "storeLocation": "localmachine", + "storeName": "Root", + "visibility": [ + "task" + ] + } + ], + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ] + } + } + } + }, + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ] + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobScheduleDelete.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobScheduleDelete.json new file mode 100644 index 000000000000..18a0d9f14c02 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobScheduleDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobScheduleDisable.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobScheduleDisable.json new file mode 100644 index 000000000000..8597d47b90e6 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobScheduleDisable.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "204": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobScheduleEnable.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobScheduleEnable.json new file mode 100644 index 000000000000..8597d47b90e6 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobScheduleEnable.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "204": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobScheduleExists.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobScheduleExists.json new file mode 100644 index 000000000000..a8b0f91f9df2 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobScheduleExists.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": {}, + "404": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobScheduleGet.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobScheduleGet.json new file mode 100644 index 000000000000..764721b3ae03 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobScheduleGet.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "jobScheduleId", + "url": "https://account.region.batch.azure.com/jobschedules/jobScheduleId", + "eTag": "0x8D40FFD2E848323", + "lastModified": "2016-11-18T21:52:24.7661347Z", + "creationTime": "2016-11-18T21:52:22.5431125Z", + "state": "completed", + "stateTransitionTime": "2016-11-18T21:52:24.8371778Z", + "previousState": "active", + "previousStateTransitionTime": "2016-11-18T21:52:24.0064874Z", + "jobSpecification": { + "priority": 0, + "maxParallelTasks": -1, + "usesTaskDependencies": false, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction", + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "testPool" + } + }, + "executionInfo": { + "recentJob": { + "url": "https://account.region.batch.azure.com/jobschedules/jobScheduleId:job-1", + "id": "jobScheduleId:job-1" + }, + "endTime": "2016-11-18T21:52:24.8371778Z" + } + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobScheduleList.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobScheduleList.json new file mode 100644 index 000000000000..daf9138eac7c --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobScheduleList.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "jobSchedule1", + "url": "https://account.region.batch.azure.com/jobschedules/jobSchedule1", + "eTag": "0x8D40FFD2E10996A", + "lastModified": "2016-11-18T21:52:24.0064874Z", + "creationTime": "2016-11-18T21:52:22.5431125Z", + "state": "active", + "stateTransitionTime": "2016-11-18T21:52:24.0064874Z", + "previousState": "disabled", + "previousStateTransitionTime": "2016-11-18T21:52:23.6471782Z", + "jobSpecification": { + "priority": 0, + "maxParallelTasks": -1, + "usesTaskDependencies": false, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction", + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + } + }, + "executionInfo": { + "recentJob": { + "url": "https://account.region.batch.azure.com/jobs/jobSchedule1:job-1", + "id": "jobSchedule1:job-1" + } + } + }, + { + "id": "jobSchedule2", + "url": "https://account.region.batch.azure.com/jobschedules/jobSchedule2", + "eTag": "0x8D40FFCFF760B51", + "lastModified": "2016-11-18T21:51:05.8184017Z", + "creationTime": "2016-11-18T21:51:05.8184017Z", + "state": "active", + "stateTransitionTime": "2016-11-18T21:51:05.8184017Z", + "schedule": { + "doNotRunUntil": "2020-01-01T12:30:00Z" + }, + "jobSpecification": { + "priority": 0, + "maxParallelTasks": -1, + "usesTaskDependencies": false, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction", + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "testPool2" + } + }, + "executionInfo": { + "nextRunTime": "2020-01-01T12:30:00Z" + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobSchedulePatch.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobSchedulePatch.json new file mode 100644 index 000000000000..cd82bfa5e382 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobSchedulePatch.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobSchedulePatchParameter": { + "schedule": { + "doNotRunUntil": "2025-01-01T12:30:00Z" + }, + "jobSpecification": { + "priority": 0, + "usesTaskDependencies": false, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + } + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobScheduleTerminate.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobScheduleTerminate.json new file mode 100644 index 000000000000..18a0d9f14c02 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobScheduleTerminate.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobScheduleUpdate.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobScheduleUpdate.json new file mode 100644 index 000000000000..6b039f259412 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobScheduleUpdate.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobScheduleUpdateParameter": { + "schedule": { + "doNotRunUntil": "2025-01-01T12:30:00Z" + }, + "jobSpecification": { + "priority": 0, + "usesTaskDependencies": false, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + } + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobTerminate.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobTerminate.json new file mode 100644 index 000000000000..c661045f9573 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobTerminate.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobTerminateParameter": { + "terminateReason": "User supplied termination reason" + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobUpdate.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobUpdate.json new file mode 100644 index 000000000000..c2645b712373 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/JobUpdate.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobUpdateParameter": { + "priority": 100, + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": -1 + }, + "poolInfo": { + "poolId": "poolId" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeAddUser.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeAddUser.json new file mode 100644 index 000000000000..1a42dd910f15 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeAddUser.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "user": { + "name": "userName", + "isAdmin": false, + "expiryTime": "2017-08-01T00:00:00Z", + "password": "Password" + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeDeleteUser.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeDeleteUser.json new file mode 100644 index 000000000000..90fc1a123124 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeDeleteUser.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "userName": "userName", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeDisableScheduling.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeDisableScheduling.json new file mode 100644 index 000000000000..2f428af2ed59 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeDisableScheduling.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "nodeDisableSchedulingParameter": { + "nodeDisableSchedulingOption": "terminate" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeEnableScheduling.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeEnableScheduling.json new file mode 100644 index 000000000000..53ad3015e48e --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeEnableScheduling.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeGetRemoteDesktop.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeGetRemoteDesktop.json new file mode 100644 index 000000000000..712c88cdc733 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeGetRemoteDesktop.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": "This is actually a byte stream. This request/response is being presented as a string for readability in the example" + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeGetRemoteLoginSettings.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeGetRemoteLoginSettings.json new file mode 100644 index 000000000000..7359485f8cb1 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeGetRemoteLoginSettings.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "remoteLoginIPAddress": "1.1.1.1", + "remoteLoginPort": 50000 + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeGet_Basic.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeGet_Basic.json new file mode 100644 index 000000000000..5021c86fa689 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeGet_Basic.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "poolId": "poolId", + "nodeId": "tvm-1695681911_2-20161122t193202z", + "api-version": "2021-06-01.14.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "tvm-1695681911_2-20161122t193202z", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z", + "state": "idle", + "schedulingState": "enabled", + "stateTransitionTime": "2016-11-22T19:37:31.4285526Z", + "lastBootTime": "2016-11-22T19:37:28.623369Z", + "allocationTime": "2016-11-22T19:32:02.8155319Z", + "ipAddress": "1.1.1.1", + "affinityId": "TVM:tvm-1695681911_2-20161122t193202z", + "vmSize": "small", + "totalTasksRun": 0, + "totalTasksSucceeded": 0, + "runningTasksCount": 0, + "isDedicated": true, + "startTask": { + "commandLine": "cmd /c echo hello", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "startTaskInfo": { + "state": "completed", + "startTime": "2016-11-22T19:37:31.4285526Z", + "endTime": "2016-11-22T19:37:31.838028Z", + "exitCode": 0, + "retryCount": 0 + }, + "nodeAgentInfo": { + "version": "1.2.0.0", + "lastUpdateTime": "2016-11-22T19:37:28.623369Z" + } + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeList.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeList.json new file mode 100644 index 000000000000..59ab1ce00a29 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeList.json @@ -0,0 +1,134 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "tvm-1695681911_1-20161122t193202z", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z", + "state": "idle", + "schedulingState": "enabled", + "stateTransitionTime": "2016-11-22T22:22:27.2236818Z", + "lastBootTime": "2016-11-22T22:22:24.4634125Z", + "allocationTime": "2016-11-22T19:32:02.8155319Z", + "ipAddress": "1.1.1.1", + "affinityId": "TVM:tvm-1695681911_1-20161122t193202z", + "vmSize": "small", + "totalTasksRun": 0, + "totalTasksSucceeded": 0, + "runningTasksCount": 0, + "runningTaskSlotsCount": 0, + "isDedicated": true, + "startTask": { + "commandLine": "cmd /c echo hello", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "startTaskInfo": { + "state": "completed", + "startTime": "2016-11-22T22:22:27.2236818Z", + "endTime": "2016-11-22T22:22:27.567189Z", + "exitCode": 0, + "retryCount": 0 + }, + "nodeAgentInfo": { + "version": "1.2.0.0", + "lastUpdateTime": "2016-11-22T22:22:24.4634125Z" + } + }, + { + "id": "tvm-1695681911_2-20161122t193202z", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z", + "state": "idle", + "schedulingState": "enabled", + "stateTransitionTime": "2016-11-22T19:37:31.4285526Z", + "lastBootTime": "2016-11-22T19:37:28.623369Z", + "allocationTime": "2016-11-22T19:32:02.8155319Z", + "ipAddress": "1.1.1.1", + "affinityId": "TVM:tvm-1695681911_2-20161122t193202z", + "vmSize": "small", + "totalTasksRun": 0, + "totalTasksSucceeded": 0, + "runningTasksCount": 0, + "runningTaskSlotsCount": 0, + "isDedicated": true, + "startTask": { + "commandLine": "cmd /c echo hello", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "startTaskInfo": { + "state": "completed", + "startTime": "2016-11-22T19:37:31.4285526Z", + "endTime": "2016-11-22T19:37:31.838028Z", + "exitCode": 0, + "retryCount": 0 + }, + "nodeAgentInfo": { + "version": "1.2.0.0", + "lastUpdateTime": "2016-11-22T22:22:24.4634125Z" + } + }, + { + "id": "tvm-1695681911_3-20161122t193202z", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_3-20161122t193202z", + "state": "idle", + "schedulingState": "enabled", + "stateTransitionTime": "2016-11-22T19:36:51.0013378Z", + "lastBootTime": "2016-11-22T19:36:48.21721Z", + "allocationTime": "2016-11-22T19:32:02.8155319Z", + "ipAddress": "1.1.1.1", + "affinityId": "TVM:tvm-1695681911_3-20161122t193202z", + "vmSize": "small", + "totalTasksRun": 0, + "totalTasksSucceeded": 0, + "runningTasksCount": 0, + "runningTaskSlotsCount": 0, + "isDedicated": true, + "startTask": { + "commandLine": "cmd /c echo hello", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "startTaskInfo": { + "state": "completed", + "startTime": "2016-11-22T19:36:51.0013378Z", + "endTime": "2016-11-22T19:36:51.2363447Z", + "exitCode": 0, + "retryCount": 0 + }, + "nodeAgentInfo": { + "version": "1.2.0.0", + "lastUpdateTime": "2016-11-22T22:22:24.4634125Z" + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeReboot.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeReboot.json new file mode 100644 index 000000000000..4add29fb7bdd --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeReboot.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "nodeRebootParameter": { + "nodeRebootOption": "terminate" + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeReimage.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeReimage.json new file mode 100644 index 000000000000..ac6ec4420d8b --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeReimage.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "nodeReimageParameter": { + "nodeReimageOption": "terminate" + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeUpdateUser.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeUpdateUser.json new file mode 100644 index 000000000000..5f41cc025831 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeUpdateUser.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "userName": "userName", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "nodeUpdateUserParameter": { + "password": "12345", + "expiryTime": "2016-11-27T00:45:48.7320857Z" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeUploadBatchServiceLogs.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeUploadBatchServiceLogs.json new file mode 100644 index 000000000000..fe8ed12e671b --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/NodeUploadBatchServiceLogs.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "uploadBatchServiceLogsConfiguration": { + "containerUrl": "https://somestorageacct.blob.core.windows.net/batch-compute-node-logs?se=2017-12-09T18%3A51%3A00Z&sp=w&sv=2016-05-31&sr=c&sig", + "startTime": "2017-11-27T00:00:00Z" + } + }, + "responses": { + "200": { + "body": { + "virtualDirectoryName": "poolId/tvm-1695681911-1-20161121t182739z/0795539d-82fe-48e3-bbff-2964905b6de0", + "numberOfFilesUploaded": 8 + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolAdd_CloudServiceConfiguration.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolAdd_CloudServiceConfiguration.json new file mode 100644 index 000000000000..d624e9387d49 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolAdd_CloudServiceConfiguration.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "pool": { + "id": "poolId", + "vmSize": "small", + "cloudServiceConfiguration": { + "osFamily": "4" + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 5, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 3, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false, + "enableInterNodeCommunication": true, + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ] + } + }, + "responses": { + "201": { + "request-id": "00000000-0000-0000-0000-000000000000", + "ETag": "0x8D45765A6A2DC04", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolAdd_MountConfiguration.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolAdd_MountConfiguration.json new file mode 100644 index 000000000000..b518cda6aed2 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolAdd_MountConfiguration.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-data": "Fri, 17 Feb 2017 00:00:00 GMT", + "pool": { + "id": "pool2", + "vmSize": "standard_a1", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "20_04-lts" + }, + "nodeAgentSKUId": "batch.node.ubuntu 20.04" + }, + "mountConfiguration": [ + { + "azureBlobFileSystemConfiguration": { + "accountName": "accountName", + "containerName": "blobContainerName", + "accountKey": "accountKey", + "relativeMountPath": "bfusepath" + } + }, + { + "azureFileShareConfiguration": { + "accountName": "accountName", + "azureFileUrl": "https://myaccount.file.core.windows.net/fileshare", + "accountKey": "accountKey", + "relativeMountPath": "filesharepath", + "mountOptions": "mount options ver=1.0" + } + }, + { + "nfsMountConfiguration": { + "source": "somesource nfs url", + "relativeMountPath": "mountpath", + "mountOptions": "mount options ver=1.0" + } + }, + { + "cifsMountConfiguration": { + "username": "accountName", + "password": "password", + "source": "//myaccount.file.core.windows.net/file", + "relativeMountPath": "mountpath", + "mountOptions": "mount options ver=1.0" + } + } + ], + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 5, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 3, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false + } + }, + "responses": { + "201": { + "request-id": "00000000-0000-0000-0000-000000000000", + "ETag": "0x8D45765A6A2DC04", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolAdd_VirtualMachineConfiguration.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolAdd_VirtualMachineConfiguration.json new file mode 100644 index 000000000000..47edc5809291 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolAdd_VirtualMachineConfiguration.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "pool": { + "id": "pool2", + "vmSize": "standard_a1", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts" + }, + "nodeAgentSKUId": "batch.node.ubuntu 20.04" + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 5, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 3, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false, + "enableInterNodeCommunication": true, + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ] + } + }, + "responses": { + "201": { + "request-id": "00000000-0000-0000-0000-000000000000", + "ETag": "0x8D45765A6A2DC04", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolAdd_VirtualMachineConfigurationWithContainers.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolAdd_VirtualMachineConfigurationWithContainers.json new file mode 100644 index 000000000000..44997c56c5be --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolAdd_VirtualMachineConfigurationWithContainers.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "pool": { + "id": "pool2", + "vmSize": "standard_a1", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "120_04-lts" + }, + "nodeAgentSKUId": "batch.node.ubuntu 20.04", + "containerConfiguration": { + "type": "dockerCompatible", + "containerImageNames": [ + "busybox" + ] + } + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 5, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 3, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false + } + }, + "responses": { + "201": { + "request-id": "00000000-0000-0000-0000-000000000000", + "ETag": "0x8D45765A6A2DC04", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolAdd_VirtualMachineConfigurationWithExtensions.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolAdd_VirtualMachineConfigurationWithExtensions.json new file mode 100644 index 000000000000..1fde4df98dcc --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolAdd_VirtualMachineConfigurationWithExtensions.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "pool": { + "id": "pool2", + "vmSize": "standard_a1", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts" + }, + "nodeAgentSKUId": "batch.node.ubuntu 20.04", + "extensions": [ + { + "name": "batchextension1", + "type": "SecurityMonitoringForLinux", + "publisher": "Microsoft.Azure.Security.Monitoring", + "typeHandlerVersion": "1.0", + "autoUpgradeMinorVersion": true, + "settings": "{\"settingsKey\":\"settingsValue\"}", + "protectedSettings": "{\"protectedSettingsKey\":\"protectedSettingsValue\"}" + } + ] + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 5, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 3, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false, + "enableInterNodeCommunication": true, + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ] + } + }, + "responses": { + "201": { + "request-id": "00000000-0000-0000-0000-000000000000", + "ETag": "0x8D45765A6A2DC04", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolDelete.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolDelete.json new file mode 100644 index 000000000000..1152c2d5dc5c --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolDisableAutoScale.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolDisableAutoScale.json new file mode 100644 index 000000000000..bac63721e6da --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolDisableAutoScale.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolEnableAutoscale.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolEnableAutoscale.json new file mode 100644 index 000000000000..75f6223cb50d --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolEnableAutoscale.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "poolEnableAutoScaleParameter": { + "autoScaleFormula": "$TargetDedicated=0", + "autoScaleEvaluationInterval": "PT8M" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolEvaluateAutoscale.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolEvaluateAutoscale.json new file mode 100644 index 000000000000..52c47e8e32fa --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolEvaluateAutoscale.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "poolEvaluateAutoScaleParameter": { + "autoScaleFormula": "$TargetDedicated=1" + } + }, + "responses": { + "200": { + "body": { + "timestamp": "2016-11-22T19:39:28.5246331Z", + "results": "$TargetDedicated=1;$NodeDeallocationOption=requeue" + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolExists.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolExists.json new file mode 100644 index 000000000000..1251db9f1e50 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolExists.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": {}, + "404": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolGetLifetimeStatistics.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolGetLifetimeStatistics.json new file mode 100644 index 000000000000..830cbdd1f306 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolGetLifetimeStatistics.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "url": "https://account.region.batch.core.windows.net/lifetimepoolstats", + "startTime": "2014-08-01T18:30:00.4345729Z", + "lastUpdateTime": "2014-08-04T18:30:00.4345729Z", + "usageStats": { + "startTime": "2014-08-01T18:30:00.4345729Z", + "lastUpdateTime": "2014-08-04T18:30:00.4345729Z", + "dedicatedCoreTime": "PT0S" + }, + "resourceStats": { + "startTime": "2014-08-01T18:30:00.4345729Z", + "lastUpdateTime": "2014-08-04T18:30:00.4345729Z", + "avgCPUPercentage": 40.0, + "avgMemoryGiB": 2.0, + "peakMemoryGiB": 4.0, + "avgDiskGiB": 125.0, + "peakDiskGiB": 240.0, + "diskReadIOps": 0, + "diskWriteIOps": 0, + "diskReadGiB": 10.0, + "diskWriteGiB": 1.0, + "networkReadGiB": 20.0, + "networkWriteGiB": 25.0 + } + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolGet_Basic.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolGet_Basic.json new file mode 100644 index 000000000000..6c7102a438e0 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolGet_Basic.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "poolId": "pool", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "pool", + "url": "https://account.region.batch.azure.com/pools/pool", + "eTag": "0x8D413091E739A56", + "lastModified": "2016-11-22T18:55:25.2608598Z", + "creationTime": "2016-11-22T18:55:24.2632496Z", + "state": "active", + "stateTransitionTime": "2016-11-22T18:55:24.2632496Z", + "allocationState": "steady", + "allocationStateTransitionTime": "2016-11-22T18:55:24.8154041Z", + "vmSize": "standard_a1", + "resizeTimeout": "PT15M", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "targetDedicatedNodes": 0, + "targetLowPriorityNodes": 0, + "enableAutoScale": false, + "enableInterNodeCommunication": false, + "startTask": { + "commandLine": "/bin/bash -c 'echo start task'", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.ubuntu 20.04" + } + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolGet_VirtualMachineConfigurationWithExtensions.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolGet_VirtualMachineConfigurationWithExtensions.json new file mode 100644 index 000000000000..f26b5b52c1a9 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolGet_VirtualMachineConfigurationWithExtensions.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "poolId": "pool", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "pool", + "url": "https://account.region.batch.azure.com/pools/pool", + "eTag": "0x8D413091E739A56", + "lastModified": "2016-11-22T18:55:25.2608598Z", + "creationTime": "2016-11-22T18:55:24.2632496Z", + "state": "active", + "stateTransitionTime": "2016-11-22T18:55:24.2632496Z", + "allocationState": "steady", + "allocationStateTransitionTime": "2016-11-22T18:55:24.8154041Z", + "vmSize": "standard_a1", + "resizeTimeout": "PT15M", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "targetDedicatedNodes": 0, + "targetLowPriorityNodes": 0, + "enableAutoScale": false, + "enableInterNodeCommunication": false, + "startTask": { + "commandLine": "/bin/bash -c 'echo start task'", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.ubuntu 20.04", + "extensions": [ + { + "name": "batchextension1", + "type": "SecurityMonitoringForLinux", + "publisher": "Microsoft.Azure.Security.Monitoring", + "typeHandlerVersion": "1.0", + "autoUpgradeMinorVersion": true, + "settings": "{\"settingsKey\":\"settingsValue\"}" + } + ] + } + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolListUsageMetrics.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolListUsageMetrics.json new file mode 100644 index 000000000000..7d6a681916db --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolListUsageMetrics.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "startTime": "2013-04-01T00:00:00Z", + "endTime": "2013-04-01T00:30:00Z", + "poolId": "p1", + "vmSize": "a1", + "totalCoreHours": 39.384838 + }, + { + "startTime": "2013-04-01T00:30:00Z", + "endTime": "2013-04-01T01:00:00Z", + "poolId": "p2", + "vmSize": "a8", + "totalCoreHours": 3039.384838 + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolList_Basic.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolList_Basic.json new file mode 100644 index 000000000000..840551e19cf2 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolList_Basic.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "testPool", + "url": "https://accountname.region.batch.azure.com/pools/testPool", + "eTag": "0x8D4123BEF87D233", + "lastModified": "2016-11-21T18:26:39.7108787Z", + "creationTime": "2016-11-21T18:26:39.7108787Z", + "state": "active", + "stateTransitionTime": "2016-11-21T18:26:39.7108787Z", + "allocationState": "steady", + "allocationStateTransitionTime": "2016-11-21T18:27:40.287803Z", + "vmSize": "small", + "resizeTimeout": "PT15M", + "currentDedicatedNodes": 3, + "currentLowPriorityNodes": 0, + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0, + "enableAutoScale": false, + "enableInterNodeCommunication": false, + "startTask": { + "commandLine": "cmd /c echo hello", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "cloudServiceConfiguration": { + "osFamily": "4", + "osVersion": "*" + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolPatch.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolPatch.json new file mode 100644 index 000000000000..ea65dec5c795 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolPatch.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "poolPatchParameter": { + "startTask": { + "commandLine": "/bin/bash -c 'echo start task'" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolRemoveNodes.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolRemoveNodes.json new file mode 100644 index 000000000000..c03369e6dab7 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolRemoveNodes.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "nodeRemoveParameter": { + "nodeList": [ + "tvm-1695681911_1-20161122t224741z", + "tvm-1695681911_2-20161122t224741z" + ] + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolResize.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolResize.json new file mode 100644 index 000000000000..5aae7b480ddb --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolResize.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "poolId": "resizePool", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "poolResizeParameter": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolStopResize.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolStopResize.json new file mode 100644 index 000000000000..1152c2d5dc5c --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolStopResize.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolUpdate.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolUpdate.json new file mode 100644 index 000000000000..f81c1c802b8a --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/PoolUpdate.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "poolUpdatePropertiesParameter": { + "startTask": { + "commandLine": "/bin/bash -c 'echo start task'" + }, + "certificateReferences": [], + "applicationPackageReferences": [], + "metadata": [] + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskAddCollection_Basic.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskAddCollection_Basic.json new file mode 100644 index 000000000000..170470127993 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskAddCollection_Basic.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "taskCollection": { + "value": [ + { + "id": "simple1", + "commandLine": "cmd /c dir /s" + }, + { + "id": "simple2", + "commandLine": "cmd /c dir /s" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "status": "success", + "taskId": "simple1", + "eTag": "0x8D3D623CD661246", + "lastModified": "2016-09-06T07:02:44.7589958Z", + "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple1" + }, + { + "status": "success", + "taskId": "simple2", + "eTag": "0x8D3D623CD7072CC", + "lastModified": "2016-09-06T07:02:44.8270028Z", + "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple2" + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskAddCollection_Complex.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskAddCollection_Complex.json new file mode 100644 index 000000000000..946e28b4540a --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskAddCollection_Complex.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "taskCollection": { + "value": [ + { + "id": "complex1", + "commandLine": "cmd /c dir /s", + "resourceFiles": [ + { + "autoStorageContainerName": "containerName", + "filePath": "data" + } + ], + "environmentSettings": [ + { + "name": "env1", + "value": "value1" + }, + { + "name": "env2", + "value": "value2" + } + ], + "affinityInfo": { + "affinityId": "affinityId" + }, + "constraints": { + "maxWallClockTime": "P1D", + "retentionTime": "P2D", + "maxTaskRetryCount": 5 + }, + "requiredSlots": 2, + "multiInstanceSettings": { + "numberOfInstances": 3, + "coordinationCommandLine": "cmd /c echo coordinating", + "commonResourceFiles": [ + { + "httpUrl": "https://common.blob.core.windows.net/", + "filePath": "common.exe" + } + ] + } + }, + { + "id": "simple3", + "commandLine": "cmd /c dir /s" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "taskId": "simple3", + "status": "success", + "eTag": "0x8D3D623CE295629", + "lastModified": "2016-09-06T07:02:46.0386857Z", + "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple3" + }, + { + "taskId": "complex1", + "status": "success", + "eTag": "0x8D3D623CE29A412", + "lastModified": "2016-09-06T07:02:46.0406802Z", + "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/complex1" + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskAdd_Basic.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskAdd_Basic.json new file mode 100644 index 000000000000..8c0ef7f01d51 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskAdd_Basic.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "task": { + "id": "task1", + "commandLine": "cmd /c echo task1" + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskAdd_ContainerSettings.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskAdd_ContainerSettings.json new file mode 100644 index 000000000000..793848082f16 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskAdd_ContainerSettings.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "task": { + "id": "taskId", + "commandLine": "bash -c 'echo hello'", + "containerSettings": { + "imageName": "ubuntu", + "containerRunOptions": "--rm" + }, + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + } + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskAdd_ExitConditions.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskAdd_ExitConditions.json new file mode 100644 index 000000000000..2f40b7af089e --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskAdd_ExitConditions.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "task": { + "id": "taskId", + "commandLine": "cmd /c exit 3", + "exitConditions": { + "exitCodeRanges": [ + { + "start": 2, + "end": 4, + "exitOptions": { + "jobAction": "terminate" + } + } + ] + }, + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + } + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskAdd_RequiredSlots.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskAdd_RequiredSlots.json new file mode 100644 index 000000000000..587a688ccf92 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskAdd_RequiredSlots.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "task": { + "id": "task1", + "requiredSlots": 2, + "commandLine": "cmd /c echo task1" + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskDelete.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskDelete.json new file mode 100644 index 000000000000..e7e4d31f3227 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskGet.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskGet.json new file mode 100644 index 000000000000..3d4c378b0626 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskGet.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "testTask", + "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId", + "eTag": "0x8D3D62350711C55", + "creationTime": "2016-09-06T06:59:15.1161429Z", + "lastModified": "2016-09-06T06:59:15.1161429Z", + "state": "active", + "stateTransitionTime": "2016-09-06T06:59:15.1161429Z", + "commandLine": "cmd /c hostname", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "multiInstanceSettings": { + "numberOfInstances": 3, + "coordinationCommandLine": "cmd /c echo coordinating" + }, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "retentionTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "requiredSlots": 2, + "executionInfo": { + "retryCount": 0, + "requeueCount": 0 + } + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskList.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskList.json new file mode 100644 index 000000000000..d416275bf17a --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskList.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "task1", + "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/task1", + "eTag": "0x8D4125FD1A825A4", + "creationTime": "2016-11-21T22:43:31.4733476Z", + "lastModified": "2016-11-21T22:43:31.4733476Z", + "state": "active", + "stateTransitionTime": "2016-11-21T22:43:31.4733476Z", + "commandLine": "cmd /c echo task1", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "retentionTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "requiredSlots": 2, + "executionInfo": { + "retryCount": 0, + "requeueCount": 0 + } + }, + { + "id": "task2", + "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/task2", + "eTag": "0x8D4125FD2153345", + "creationTime": "2016-11-21T22:43:31.6736345Z", + "lastModified": "2016-11-21T22:43:32.1880389Z", + "state": "active", + "stateTransitionTime": "2016-11-21T22:43:31.6736345Z", + "commandLine": "cmd /c echo task2", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "retentionTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 3 + }, + "requiredSlots": 2, + "executionInfo": { + "retryCount": 0, + "requeueCount": 0 + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskListSubtasks.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskListSubtasks.json new file mode 100644 index 000000000000..62b872311eaf --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskListSubtasks.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": 1, + "startTime": "2016-09-06T06:59:16.3139271Z", + "endTime": "2016-09-06T06:59:20.0242024Z", + "state": "completed", + "stateTransitionTime": "2016-09-06T06:59:20.0242024Z", + "previousState": "running", + "previousStateTransitionTime": "2016-09-06T06:59:16.3139271Z", + "exitCode": 0, + "nodeInfo": { + "affinityId": "TVM:tvm-2544493925_3-20160905t051718z", + "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_3-20160905t051718z", + "poolId": "mpiPool", + "nodeId": "tvm-2544493925_3-20160905t051718z", + "taskRootDirectory": "\\workitems\\jobId\\job-1\\taskId\\1", + "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_3-20160905t051718z/files//workitems/jobId/job-1/taskId/1" + } + }, + { + "id": 2, + "startTime": "2016-09-06T06:59:16.9702844Z", + "state": "running", + "stateTransitionTime": "2016-09-06T06:59:16.9702844Z", + "nodeInfo": { + "affinityId": "TVM:tvm-2544493925_2-20160905t051718z", + "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_2-20160905t051718z", + "poolId": "mpiPool", + "nodeId": "tvm-2544493925_2-20160905t051718z", + "taskRootDirectory": "\\workitems\\jobId\\job-1\\taskId\\2", + "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_2-20160905t051718z/files//workitems/jobId/job-1/taskId/2" + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskReactivate.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskReactivate.json new file mode 100644 index 000000000000..1b8c8b9165c6 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskReactivate.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "204": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskTerminate.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskTerminate.json new file mode 100644 index 000000000000..1b8c8b9165c6 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskTerminate.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "204": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskUpdate.json b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskUpdate.json new file mode 100644 index 000000000000..53ad3a232c81 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2021-06-01.14.0/examples/TaskUpdate.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2021-06-01.14.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "taskUpdateParameter": { + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": 3, + "retentionTime": "PT1H" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/readme.go.md b/specification/batch/data-plane/readme.go.md index 280a31def094..602bbad8b012 100644 --- a/specification/batch/data-plane/readme.go.md +++ b/specification/batch/data-plane/readme.go.md @@ -21,6 +21,16 @@ batch: - tag: package-2019-08.10.0 - tag: package-2020-03.11.0 - tag: package-2020-09.12.0 + - tag: package-2021-06.14.0 +``` + +### Tag: package-2021-06.14.0 and go + +These settings apply only when `--tag=package-2021-06.14.0 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2021-06.14.0' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/2021-06-01.14.0/$(namespace) ``` ### Tag: package-2020-09.12.0 and go diff --git a/specification/batch/data-plane/readme.md b/specification/batch/data-plane/readme.md index e5301ce18278..daed39ac7aac 100644 --- a/specification/batch/data-plane/readme.md +++ b/specification/batch/data-plane/readme.md @@ -25,8 +25,18 @@ To see additional help and options, run: These are the global settings for the Batch API. ``` yaml +title: BatchServiceClient openapi-type: data-plane -tag: package-2020-09.12.0 +tag: package-2021-06.14.0 +``` + +### Tag: package-2021-06.14.0 + +These settings apply only when `--tag=package-2021-06.14.0` is specified on the command line. + +``` yaml $(tag) == 'package-2021-06.14.0' +input-file: +- Microsoft.Batch/stable/2021-06-01.14.0/BatchService.json ``` ### Tag: package-2020-09.12.0 @@ -116,120 +126,137 @@ Note that this setting should be removed once [this GitHub bug](https://github.c ``` yaml directive: + - suppress: R1001 + where: + - $.paths["/jobschedules/{jobScheduleId}/jobs"].get.operationId + reason: Breaking change. + + - suppress: R1003 + where: + - $.paths["/jobs/{jobId}/addtaskcollection"].post.operationId + reason: Breaking change. + + - suppress: R1006 + where: + - $.paths["/jobs/{jobId}"].put.operationId + - $.paths["/jobs/{jobId}/tasks/{taskId}"].put.operationId + - $.paths["/jobschedules/{jobScheduleId}"].put.operationId + - $.paths["/pools/{poolId}/nodes/{nodeId}/users/{userName}"].put.operationId + reason: Breaking change. + + - suppress: R1007 + where: + - $.paths["/jobs/{jobId}"].patch.operationId + - $.paths["/jobschedules/{jobScheduleId}"].patch.operationId + - $.paths["/pools/{poolId}"].patch.operationId + reason: Breaking change. + + - suppress: R2001 + where: + - $.definitions.NodeFile.properties.properties + reason: Breaking change. + + - suppress: R2004 + where: + - $.paths["/jobs/{jobId}/tasks/{taskId}/files/{filePath}"].get.produces[1] + - $.paths["/pools/{poolId}/nodes/{nodeId}/files/{filePath}"].get.produces[1] + - $.paths["/pools/{poolId}/nodes/{nodeId}/rdp"].get.produces[1] + reason: This is not an ARM API. + + - suppress: R2007 + where: + - $.paths["/jobschedules/{jobScheduleId}"].delete + - $.paths["/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})"].delete + - $.paths["/jobschedules/{jobScheduleId}/terminate"].post + - $.paths["/jobs/{jobId}"].delete + - $.paths["/jobs/{jobId}/disable"].post + - $.paths["/jobs/{jobId}/enable"].post + - $.paths["/jobs/{jobId}/terminate"].post + - $.paths["/pools/{poolId}"].delete + - $.paths["/pools/{poolId}/resize"].post + - $.paths["/pools/{poolId}/stopresize"].post + - $.paths["/pools/{poolId}/removenodes"].post + - $.paths["/pools/{poolId}/nodes/{nodeId}/reboot"].post + - $.paths["/pools/{poolId}/nodes/{nodeId}/reimage"].post + reason: Service does not return 200, nor supply location header. + + - suppress: R2017 + where: + - $.paths["/jobschedules/{jobScheduleId}"].put + - $.paths["/jobs/{jobId}"].put + - $.paths["/jobs/{jobId}/tasks/{taskId}"].put + - $.paths["/pools/{poolId}/nodes/{nodeId}/users/{userName}"].put + reason: Matching service response. + + - suppress: R2029 + where: + - $.paths["/applications/{applicationId}"].get + - $.paths["/jobs/{jobId}/tasks/{taskId}/subtasksinfo"].get + reason: Not pageable. + + - suppress: R2054 + reason: The security definition already matches the required structure exactly. + + # Note that this setting should be removed once [this GitHub bug](https://github.com/Azure/azure-openapi-validator/issues/68) is fixed. - suppress: R2063 - from: BatchService.json reason: Bug in linter -``` - -Note that this setting should be removed once [this GitHub bug](https://github.com/Azure/azure-openapi-validator/issues/69) is fixed. -``` yaml -directive: + # Note that this setting should be removed once [this GitHub bug](https://github.com/Azure/azure-openapi-validator/issues/69) is fixed. - suppress: R2064 - from: BatchService.json reason: This is a data plane swagger specification, LRO's do not apply -``` -``` yaml -directive: + - suppress: R2066 + where: + - $.paths["/certificates"].post.operationId + - $.paths["/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})"].post.operationId + - $.paths["/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})/canceldelete"].post.operationId + - $.paths["/jobs"].post.operationId + - $.paths["/jobschedules"].post.operationId + - $.paths["/jobs/{jobId}/tasks"].post.operationId + - $.paths["/jobs/{jobId}/addtaskcollection"].post.operationId + - $.paths["/pools"].post.operationId + - $.paths["/pools/{poolId}/nodes/{nodeId}/users"].post.operationId + reason: This is fine as long as the OperationIds are all unique (as they presently are), and fixing it would likely involve a breaking change. + - suppress: R3016 - from: BatchService.json where: $..["odata.nextLink"] reason: The casing of this property is not incorrect. -``` -``` yaml -directive: - suppress: R3016 - from: BatchService.json - where: $..["publicFQDN"] + where: + - $..["publicFQDN"] + - $.definitions.ImageInformation.properties.nodeAgentSKUId + - $.definitions.JobStatistics.properties.kernelCPUTime + - $.definitions.JobStatistics.properties.userCPUTime + - $.definitions.JobScheduleStatistics.properties.kernelCPUTime + - $.definitions.JobScheduleStatistics.properties.userCPUTime + - $.definitions.PoolEndpointConfiguration.properties.inboundNATPools + - $.definitions.ResourceStatistics.properties.avgCPUPercentage + - $.definitions.TaskStatistics.properties.userCPUTime + - $.definitions.TaskStatistics.properties.kernelCPUTime + - $.definitions.VirtualMachineConfiguration.properties.nodeAgentSKUId reason: The suggested casing of this property is worse than the casing that we're using -``` -``` yaml -directive: - - suppress: R3016 - from: BatchService.json - where: $.definitions.JobScheduleStatistics.properties.kernelCPUTime - reason: The suggested casing of this property is worse than the casing that we're using -``` + - suppress: R3018 + reason: This would be a big breaking change, and there are too many existing instances (over 100) to enumerate here. -``` yaml -directive: - - suppress: R3016 - from: BatchService.json - where: $.definitions.TaskStatistics.properties.userCPUTime - reason: The suggested casing of this property is worse than the casing that we're using -``` + - suppress: R3023 + reason: This is not an ARM API. -``` yaml -directive: - - suppress: R3016 - from: BatchService.json - where: $.definitions.TaskStatistics.properties.kernelCPUTime - reason: The suggested casing of this property is worse than the casing that we're using -``` + - suppress: R4007 + reason: We essentially are following the error schema, and this would be a big breaking change. -``` yaml -directive: - - suppress: R3016 - from: BatchService.json - where: $.definitions.JobScheduleStatistics.properties.userCPUTime - reason: The suggested casing of this property is worse than the casing that we're using -``` - -``` yaml -directive: - - suppress: R3016 - from: BatchService.json - where: $.definitions.JobStatistics.properties.kernelCPUTime - reason: The suggested casing of this property is worse than the casing that we're using -``` - -``` yaml -directive: - - suppress: R3016 - from: BatchService.json - where: $.definitions.JobStatistics.properties.userCPUTime - reason: The suggested casing of this property is worse than the casing that we're using -``` - -``` yaml -directive: - - suppress: R3016 - from: BatchService.json - where: $.definitions.ResourceStatistics.properties.avgCPUPercentage - reason: The suggested casing of this property is worse than the casing that we're using -``` - -``` yaml -directive: - - suppress: R3016 - from: BatchService.json - where: $.definitions.PoolEndpointConfiguration.properties.inboundNATPools - reason: The suggested casing of this property is worse than the casing that we're using -``` - -``` yaml -directive: - - suppress: R3016 - from: BatchService.json - where: $.definitions.VirtualMachineConfiguration.properties.nodeAgentSKUId - reason: The suggested casing of this property is worse than the casing that we're using -``` - -``` yaml - - suppress: DefinitionsPropertiesNamesCamelCase - where: $.definitions.ImageInformation.properties.nodeAgentSKUId - from: BatchService.json - reason: Changing the casing of this property would be a breaking change -``` - -``` yaml - - suppress: AvoidNestedProperties - where: $.definitions.NodeFile.properties.properties - from: BatchService.json - reason: Switching to x-ms-client-flatten would be a breaking change to the SDKs + - suppress: R4011 + where: + - $.paths["/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})"].delete.responses + - $.paths["/jobs/{jobId}/tasks/{taskId}/files/{filePath}"].delete.responses + - $.paths["/pools/{poolId}/nodes/{nodeId}/files/{filePath}"].delete.responses + - $.paths["/jobschedules/{jobScheduleId}"].delete.responses + - $.paths["/jobs/{jobId}"].delete.responses + - $.paths["/pools/{poolId}"].delete.responses + - $.paths["/jobs/{jobId}/tasks/{taskId}"].delete.responses + - $.paths["/pools/{poolId}/nodes/{nodeId}/users/{userName}"].delete.responses + reason: These delete operations have the required responses. Looks like a bug with the validator. ``` ### Tag: package-2017-05.5.0 @@ -279,7 +306,7 @@ input-file: --- -# Code Generation +## Code Generation ## Swagger to SDK @@ -293,7 +320,7 @@ swagger-to-sdk: - repo: azure-sdk-for-node ``` -## C# +## C\# These settings apply only when `--csharp` is specified on the command line. Please also specify `--csharp-sdks-folder=`. @@ -345,32 +372,29 @@ See configuration in [readme.go.md](./readme.go.md) ## Java These settings apply only when `--java` is specified on the command line. -Please also specify `--node-sdks-folder=`. +Please also specify `--java-sdks-folder=`. -``` yaml $(java) -nodejs: +``` yaml $(java) && $(openapi-type) == 'management-plane' +java: azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION - namespace: com.microsoft.azure.batch.protocol - output-folder: $(node-sdks-folder)/src/main/java + namespace: com.microsoft.azure.batch + output-folder: $(java-sdks-folder)/sdk/batch/azure-resourcemanager-batch payload-flattening-threshold: 1 generate-license-txt: true clear-output-folder: true ``` -## Java - These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. +Please also specify `--java-sdks-folder=`. -``` yaml $(java) +``` yaml $(java) && $(openapi-type) == 'data-plane' java: azure-arm: true - fluent: true - namespace: com.microsoft.azure.batch + namespace: com.microsoft.azure.batch.protocol license-header: MICROSOFT_MIT_NO_CODEGEN payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-batch + output-folder: $(java-sdks-folder)/sdk/batch/microsoft-azure-batch ``` ## Multi-API/Profile support for AutoRest v3 generators @@ -379,7 +403,7 @@ AutoRest V3 generators require the use of `--tag=all-api-versions` to select api This block is updated by an automatic script. Edits may be lost! -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ +``` yaml $(tag) == 'all-api-versions' /*autogenerated*/ # include the azure profile definitions from the standard location require: $(this-folder)/../../../profiles/readme.md diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/BatchManagement.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/BatchManagement.json new file mode 100644 index 000000000000..38fb4c0ed701 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/BatchManagement.json @@ -0,0 +1,5879 @@ +{ + "swagger": "2.0", + "info": { + "title": "BatchManagementClient", + "description": "The Batch Management Client.", + "version": "2021-06-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.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", + "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" + ], + "operationId": "Certificate_ListByBatchAccount", + "description": "Lists all of the certificates in the specified account.", + "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" + ], + "operationId": "Certificate_Create", + "description": "Creates a new certificate inside the specified account.", + "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" + ], + "operationId": "Certificate_Update", + "description": "Updates the properties of an existing certificate.", + "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" + ], + "operationId": "Certificate_Delete", + "description": "Deletes the specified certificate.", + "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" + ], + "operationId": "Certificate_Get", + "description": "Gets information about the specified certificate.", + "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" + ], + "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.", + "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}/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" + } + } + }, + "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 - 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" + } + }, + "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" + } + }, + "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", + "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." + } + }, + "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 Azure Active Directory. If the mode is UserSubscription, clients must use Azure Active Directory. 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" + }, + "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 Azure Active Directory." + }, + { + "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", + "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." + }, + "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": { + "readOnly": true, + "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" + }, + "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 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" + }, + "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": "Batch is transitioning its core quota system for dedicated cores to be enforced per Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual Machine family may not yet be enforced. If this flag is false, dedicated core quota is enforced via the old dedicatedCoreQuota property on the account and does not consider Virtual Machine family. If this flag is true, dedicated core quota is enforced via the dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not apply." + }, + "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": false, + "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" + }, + "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 versioned secret. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. 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." + } + ] + } + }, + "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." + }, + "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." + } + }, + "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" + }, + "description": "A list of additional details about the error." + } + }, + "required": [ + "code", + "message" + ], + "description": "An error response from the Batch service." + }, + "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": [ + "Succeeded", + "Updating", + "Failed" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": false, + "values": [ + { + "value": "Succeeded", + "description": "The connection status is final and is ready for use if Status is Approved." + }, + { + "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": "Failed", + "description": "The user requested that the connection be updated and it failed. You may retry the update operation." + } + ] + } + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "title": "The ARM resource identifier of the private endpoint." + }, + "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" + }, + "actionRequired": { + "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 compute nodes currently in the pool.", + "readOnly": true + }, + "currentLowPriorityNodes": { + "type": "integer", + "format": "int32", + "title": "The number of 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", + "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" + }, + "title": "The list of user accounts to be created on each node in the pool." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "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." + }, + "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" + }, + "title": "A list of file systems to mount on each node in the pool.", + "description": "This supports Azure Files, NFS, CIFS/SMB, and Blobfuse." + } + }, + "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", + "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 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" + } + }, + "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." + }, + "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" + }, + "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" + }, + "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." + }, + "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" + }, + "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" + }, + "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." + } + }, + "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." + }, + "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 Shared Image Gallery Image." + }, + "ContainerConfiguration": { + "type": "object", + "properties": { + "type": { + "type": "string", + "title": "The container technology to be used.", + "enum": [ + "DockerCompatible" + ], + "x-ms-enum": { + "name": "ContainerType", + "modelAsString": false, + "values": [ + { + "value": "DockerCompatible", + "description": "A Docker compatible container 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" + }, + "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." + }, + "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 2019-Datacenter." + }, + "version": { + "type": "string", + "title": "The version of the Azure Virtual Machines Marketplace image.", + "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 Shared Image 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 Shared Image 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", + "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)." + } + }, + "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." + }, + "password": { + "type": "string", + "title": "The password for the user account." + }, + "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" + }, + "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" + }, + "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", + "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." + }, + "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.", + "enum": [ + "Standard_LRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "StorageAccountType", + "modelAsString": false, + "values": [ + { + "value": "Standard_LRS", + "description": "The data disk should use standard locally redundant storage." + }, + { + "value": "Premium_LRS", + "description": "The data disk should use premium 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." + } + }, + "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 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" + } + }, + "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." + } + }, + "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 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" + }, + "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" + }, + "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" + } + } + }, + "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" + }, + "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" + }, + "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" + }, + "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" + }, + "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." + }, + "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." + }, + "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." + } + }, + "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." + }, + "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", + "accountKey", + "relativeMountPath" + ], + "title": "Information used to connect to an Azure Fileshare." + }, + "OutboundEnvironmentEndpointCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OutboundEnvironmentEndpoint" + }, + "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" + }, + "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" + }, + "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." + } + }, + "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" + }, + "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/2021-06-01/examples/ApplicationCreate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/ApplicationCreate.json new file mode 100644 index 000000000000..909806f24dea --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/ApplicationCreate.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2021-06-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/2021-06-01/examples/ApplicationDelete.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/ApplicationDelete.json new file mode 100644 index 000000000000..d409bbd11a81 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/ApplicationDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2021-06-01", + "subscriptionId": "subid", + "applicationName": "app1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/ApplicationGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/ApplicationGet.json new file mode 100644 index 000000000000..c9524d3f4bdd --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/ApplicationGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2021-06-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/2021-06-01/examples/ApplicationList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/ApplicationList.json new file mode 100644 index 000000000000..21bfc6d9e13f --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/ApplicationList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2021-06-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/2021-06-01/examples/ApplicationPackageActivate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/ApplicationPackageActivate.json new file mode 100644 index 000000000000..c70bfe5da986 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/ApplicationPackageActivate.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2021-06-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/2021-06-01/examples/ApplicationPackageCreate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/ApplicationPackageCreate.json new file mode 100644 index 000000000000..361e1f558d4e --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/ApplicationPackageCreate.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2021-06-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/2021-06-01/examples/ApplicationPackageDelete.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/ApplicationPackageDelete.json new file mode 100644 index 000000000000..ddf9acde6edb --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/ApplicationPackageDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2021-06-01", + "subscriptionId": "subid", + "applicationName": "app1", + "versionName": "1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/ApplicationPackageGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/ApplicationPackageGet.json new file mode 100644 index 000000000000..0984d18eb28c --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/ApplicationPackageGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2021-06-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/2021-06-01/examples/ApplicationPackageList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/ApplicationPackageList.json new file mode 100644 index 000000000000..d153122bd715 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/ApplicationPackageList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2021-06-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/2021-06-01/examples/ApplicationUpdate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/ApplicationUpdate.json new file mode 100644 index 000000000000..42892e7deaa2 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/ApplicationUpdate.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2021-06-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/2021-06-01/examples/BatchAccountCreate_BYOS.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/BatchAccountCreate_BYOS.json new file mode 100644 index 000000000000..29b21d222829 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/BatchAccountCreate_BYOS.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2021-06-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/2021-06-01/examples/BatchAccountCreate_Default.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/BatchAccountCreate_Default.json new file mode 100644 index 000000000000..8e81717f624f --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/BatchAccountCreate_Default.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2021-06-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/2021-06-01/examples/BatchAccountCreate_SystemAssignedIdentity.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/BatchAccountCreate_SystemAssignedIdentity.json new file mode 100644 index 000000000000..2ebc4373a6dc --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/BatchAccountCreate_SystemAssignedIdentity.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2021-06-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/2021-06-01/examples/BatchAccountCreate_UserAssignedIdentity.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/BatchAccountCreate_UserAssignedIdentity.json new file mode 100644 index 000000000000..73de0288d389 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/BatchAccountCreate_UserAssignedIdentity.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2021-06-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/2021-06-01/examples/BatchAccountDelete.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/BatchAccountDelete.json new file mode 100644 index 000000000000..d658fe606052 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/BatchAccountDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2021-06-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/BatchAccountGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/BatchAccountGet.json new file mode 100644 index 000000000000..2f851af7c9d4 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/BatchAccountGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2021-06-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/2021-06-01/examples/BatchAccountGetKeys.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/BatchAccountGetKeys.json new file mode 100644 index 000000000000..5fdacf853c00 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/BatchAccountGetKeys.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2021-06-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "accountName": "sampleacct", + "primary": "AAAA==", + "secondary": "BBBB==" + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/BatchAccountList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/BatchAccountList.json new file mode 100644 index 000000000000..338b00394731 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/BatchAccountList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2021-06-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/2021-06-01/examples/BatchAccountListByResourceGroup.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/BatchAccountListByResourceGroup.json new file mode 100644 index 000000000000..4cd2ef5733f2 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/BatchAccountListByResourceGroup.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2021-06-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/2021-06-01/examples/BatchAccountListOutboundNetworkDependenciesEndpoints.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/BatchAccountListOutboundNetworkDependenciesEndpoints.json new file mode 100644 index 000000000000..63d7df270e92 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/BatchAccountListOutboundNetworkDependenciesEndpoints.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2021-06-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "category": "Azure Batch", + "endpoints": [ + { + "domainName": "japaneast.batch.azure.com", + "description": "Applicable to all Azure Batch pools.", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Azure Storage", + "endpoints": [ + { + "domainName": "sampleautostorageaccountname.blob.core.windows.net", + "description": "AutoStorage endpoint for this Batch account. Applicable to all Azure Batch pools under this account.", + "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/en-us/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/en-us/azure/batch/disk-encryption. Learn more about encryption at host and supported VM sizes at https://docs.microsoft.com/en-us/azure/virtual-machines/disks-enable-host-based-encryption-portal.", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/BatchAccountRegenerateKey.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/BatchAccountRegenerateKey.json new file mode 100644 index 000000000000..b72485394ea8 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/BatchAccountRegenerateKey.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2021-06-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/2021-06-01/examples/BatchAccountSynchronizeAutoStorageKeys.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/BatchAccountSynchronizeAutoStorageKeys.json new file mode 100644 index 000000000000..4b4f6b4ca88f --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/BatchAccountSynchronizeAutoStorageKeys.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2021-06-01", + "subscriptionId": "subid" + }, + "responses": { + "204": {} + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/BatchAccountUpdate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/BatchAccountUpdate.json new file mode 100644 index 000000000000..59888836a2bd --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/BatchAccountUpdate.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2021-06-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/2021-06-01/examples/CertificateCancelDeletion.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/CertificateCancelDeletion.json new file mode 100644 index 000000000000..ced3220fbf77 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/CertificateCancelDeletion.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2021-06-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/2021-06-01/examples/CertificateCreate_Full.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/CertificateCreate_Full.json new file mode 100644 index 000000000000..b2cbab29061d --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/CertificateCreate_Full.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2021-06-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/2021-06-01/examples/CertificateCreate_Minimal.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/CertificateCreate_Minimal.json new file mode 100644 index 000000000000..ace5bd33881c --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/CertificateCreate_Minimal.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2021-06-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/2021-06-01/examples/CertificateCreate_MinimalCer.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/CertificateCreate_MinimalCer.json new file mode 100644 index 000000000000..30d1ade78cc5 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/CertificateCreate_MinimalCer.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2021-06-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/2021-06-01/examples/CertificateDelete.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/CertificateDelete.json new file mode 100644 index 000000000000..a85c4a909bdb --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/CertificateDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "certificateName": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "api-version": "2021-06-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=2021-06-01" + } + }, + "204": {} + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/CertificateGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/CertificateGet.json new file mode 100644 index 000000000000..87ecf056c30e --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/CertificateGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "certificateName": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "api-version": "2021-06-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/2021-06-01/examples/CertificateGetWithDeletionError.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/CertificateGetWithDeletionError.json new file mode 100644 index 000000000000..fc87ca11c1d0 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/CertificateGetWithDeletionError.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "certificateName": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "api-version": "2021-06-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/2021-06-01/examples/CertificateList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/CertificateList.json new file mode 100644 index 000000000000..bd6a8eac84cb --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/CertificateList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "api-version": "2021-06-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=2021-06-01&$skiptoken=NPK%3D28%3A2857p428pug%2022F53A7734C947B8NRK%3D45%3Asha1-c23dc7f22edc793856a7506fe66397ccb4a33b46SM%3D5%3AFalse" + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/CertificateListWithFilter.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/CertificateListWithFilter.json new file mode 100644 index 000000000000..3a408d38e71e --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/CertificateListWithFilter.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "api-version": "2021-06-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/2021-06-01/examples/CertificateUpdate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/CertificateUpdate.json new file mode 100644 index 000000000000..ace5bd33881c --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/CertificateUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2021-06-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/2021-06-01/examples/LocationCheckNameAvailability_AlreadyExists.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/LocationCheckNameAvailability_AlreadyExists.json new file mode 100644 index 000000000000..67f0be3d1c3d --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/LocationCheckNameAvailability_AlreadyExists.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2021-06-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/2021-06-01/examples/LocationCheckNameAvailability_Available.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/LocationCheckNameAvailability_Available.json new file mode 100644 index 000000000000..a870b1274550 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/LocationCheckNameAvailability_Available.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2021-06-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/2021-06-01/examples/LocationGetQuotas.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/LocationGetQuotas.json new file mode 100644 index 000000000000..5ed6271a895b --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/LocationGetQuotas.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "subscriptionId": "subid", + "locationName": "japaneast" + }, + "responses": { + "200": { + "body": { + "accountQuota": 1 + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/LocationListCloudServiceSkus.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/LocationListCloudServiceSkus.json new file mode 100644 index 000000000000..10b6677cc4df --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/LocationListCloudServiceSkus.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2021-06-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/2021-06-01/examples/LocationListVirtualMachineSkus.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/LocationListVirtualMachineSkus.json new file mode 100644 index 000000000000..50d0d6c8bb0a --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/LocationListVirtualMachineSkus.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2021-06-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/2021-06-01/examples/PoolCreate_CloudServiceConfiguration.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolCreate_CloudServiceConfiguration.json new file mode 100644 index 000000000000..d287c8c2bf52 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolCreate_CloudServiceConfiguration.json @@ -0,0 +1,227 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2021-06-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/2021-06-01/examples/PoolCreate_MinimalCloudServiceConfiguration.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolCreate_MinimalCloudServiceConfiguration.json new file mode 100644 index 000000000000..d7ab25768f80 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolCreate_MinimalCloudServiceConfiguration.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2021-06-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/2021-06-01/examples/PoolCreate_MinimalVirtualMachineConfiguration.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolCreate_MinimalVirtualMachineConfiguration.json new file mode 100644 index 000000000000..16e0ea605d59 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolCreate_MinimalVirtualMachineConfiguration.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2021-06-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/2021-06-01/examples/PoolCreate_NoPublicIPAddresses.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolCreate_NoPublicIPAddresses.json new file mode 100644 index 000000000000..9a0dbeda4d0e --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolCreate_NoPublicIPAddresses.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2021-06-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/2021-06-01/examples/PoolCreate_PublicIPs.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolCreate_PublicIPs.json new file mode 100644 index 000000000000..af9496e8a1e0 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolCreate_PublicIPs.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2021-06-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/2021-06-01/examples/PoolCreate_SharedImageGallery.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolCreate_SharedImageGallery.json new file mode 100644 index 000000000000..c103a6d700e6 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolCreate_SharedImageGallery.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2021-06-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/2021-06-01/examples/PoolCreate_UserAssignedIdentities.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolCreate_UserAssignedIdentities.json new file mode 100644 index 000000000000..8d14cdff7015 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolCreate_UserAssignedIdentities.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "9999-09-09", + "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/2021-06-01/examples/PoolCreate_VirtualMachineConfiguration.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolCreate_VirtualMachineConfiguration.json new file mode 100644 index 000000000000..e2339d74cfe6 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolCreate_VirtualMachineConfiguration.json @@ -0,0 +1,200 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2021-06-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/2021-06-01/examples/PoolCreate_VirtualMachineConfiguration_Extensions.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolCreate_VirtualMachineConfiguration_Extensions.json new file mode 100644 index 000000000000..9325f7da91bc --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolCreate_VirtualMachineConfiguration_Extensions.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2021-06-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": "SecurityMonitoringForLinux", + "publisher": "Microsoft.Azure.Security.Monitoring", + "typeHandlerVersion": "1.0", + "autoUpgradeMinorVersion": true, + "settings": { + "settingsKey": "settingsValue" + }, + "protectedSettings": { + "protectedSettingsKey": "protectedSettingsValue" + } + } + ] + } + } + } + } + }, + "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": "SecurityMonitoringForLinux", + "publisher": "Microsoft.Azure.Security.Monitoring", + "typeHandlerVersion": "1.0", + "autoUpgradeMinorVersion": true, + "settings": { + "settingsKey": "settingsValue" + } + } + ] + } + } + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolDelete.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolDelete.json new file mode 100644 index 000000000000..7f55ae2263b4 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2021-06-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=2021-06-01" + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolDisableAutoScale.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolDisableAutoScale.json new file mode 100644 index 000000000000..0b23169f027f --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolDisableAutoScale.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2021-06-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/2021-06-01/examples/PoolGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolGet.json new file mode 100644 index 000000000000..adbc2f8990a2 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolGet.json @@ -0,0 +1,155 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2021-06-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/2021-06-01/examples/PoolGet_VirtualMachineConfiguration_Extensions.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolGet_VirtualMachineConfiguration_Extensions.json new file mode 100644 index 000000000000..7c40ec9eec97 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolGet_VirtualMachineConfiguration_Extensions.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2021-06-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": "SecurityMonitoringForLinux", + "publisher": "Microsoft.Azure.Security.Monitoring", + "typeHandlerVersion": "1.0", + "autoUpgradeMinorVersion": true, + "settings": { + "settingsKey": "settingsValue" + } + } + ] + } + } + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolList.json new file mode 100644 index 000000000000..13f89b4cfa54 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolList.json @@ -0,0 +1,161 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2021-06-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/2021-06-01/examples/PoolListWithFilter.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolListWithFilter.json new file mode 100644 index 000000000000..f715e4a42f1f --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolListWithFilter.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2021-06-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/2021-06-01/examples/PoolStopResize.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolStopResize.json new file mode 100644 index 000000000000..dae287e6958a --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolStopResize.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2021-06-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/2021-06-01/examples/PoolUpdate_EnableAutoScale.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolUpdate_EnableAutoScale.json new file mode 100644 index 000000000000..11f1859c57db --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolUpdate_EnableAutoScale.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2021-06-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/2021-06-01/examples/PoolUpdate_OtherProperties.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolUpdate_OtherProperties.json new file mode 100644 index 000000000000..f21c7af76372 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolUpdate_OtherProperties.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2021-06-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" + } + ] + } + } + }, + "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" + ] + } + ] + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolUpdate_RemoveStartTask.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolUpdate_RemoveStartTask.json new file mode 100644 index 000000000000..afcb4bce62ff --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolUpdate_RemoveStartTask.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2021-06-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/2021-06-01/examples/PoolUpdate_ResizePool.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolUpdate_ResizePool.json new file mode 100644 index 000000000000..597f1fa0ceae --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PoolUpdate_ResizePool.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2021-06-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/2021-06-01/examples/PrivateBatchAccountCreate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PrivateBatchAccountCreate.json new file mode 100644 index 000000000000..9626d5c7ee10 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PrivateBatchAccountCreate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2021-06-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/2021-06-01/examples/PrivateBatchAccountGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PrivateBatchAccountGet.json new file mode 100644 index 000000000000..689f0182af96 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PrivateBatchAccountGet.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2021-06-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/2021-06-01/examples/PrivateEndpointConnectionGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PrivateEndpointConnectionGet.json new file mode 100644 index 000000000000..e046801ea1e4 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PrivateEndpointConnectionGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "privateEndpointConnectionName": "testprivateEndpointConnection5testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "api-version": "2021-06-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": { + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by xyz.abc@company.com" + } + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PrivateEndpointConnectionUpdate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PrivateEndpointConnectionUpdate.json new file mode 100644 index 000000000000..8a15b89d3a1a --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PrivateEndpointConnectionUpdate.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "privateEndpointConnectionName": "testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "api-version": "2021-06-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" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by xyz.abc@company.com" + } + } + } + }, + "204": {}, + "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=2021-06-01" + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PrivateEndpointConnectionsList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PrivateEndpointConnectionsList.json new file mode 100644 index 000000000000..bcaca06284a0 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PrivateEndpointConnectionsList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "privateEndpointConnectionName": "testprivateEndpointConnection", + "api-version": "2021-06-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": { + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by xyz.abc@company.com" + } + } + } + ] + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PrivateLinkResourceGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PrivateLinkResourceGet.json new file mode 100644 index 000000000000..34f90b597826 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PrivateLinkResourceGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "privateLinkResourceName": "sampleacct", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateLinkResources/sampleacct", + "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/2021-06-01/examples/PrivateLinkResourcesList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PrivateLinkResourcesList.json new file mode 100644 index 000000000000..97078372522b --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2021-06-01/examples/PrivateLinkResourcesList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "privateLinkResourceName": "testprivateLinkResource", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateLinkResources/testprivateLinkResource", + "name": "testprivateLinkResource", + "type": "Microsoft.Batch/batchAccounts/privateLinkResources", + "properties": { + "groupId": "batchAccount", + "requiredMembers": [ + "batchAccount" + ], + "requiredZoneNames": [ + "privatelink.japaneast.batch.azure.com" + ] + } + } + ] + } + } + } +} diff --git a/specification/batch/resource-manager/readme.go.md b/specification/batch/resource-manager/readme.go.md index e209c4d48fa6..cf96dea9bd46 100644 --- a/specification/batch/resource-manager/readme.go.md +++ b/specification/batch/resource-manager/readme.go.md @@ -1,6 +1,5 @@ - -## Go +# Go These settings apply only when `--go` is specified on the command line. @@ -11,9 +10,11 @@ go: clear-output-folder: true ``` -### Go multi-api +## Go multi-api + ``` yaml $(go) && $(multiapi) batch: + - tag: package-2021-06 - tag: package-2021-01 - tag: package-2020-09 - tag: package-2020-05 @@ -27,6 +28,15 @@ batch: - tag: package-2015-12 ``` +### Tag: package-2021-06 and go + +These settings apply only when `--tag=package-2021-06 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2021-06' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2021-06-01/$(namespace) +``` + ### Tag: package-2021-01 and go These settings apply only when `--tag=package-2021-01 --go` is specified on the command line. diff --git a/specification/batch/resource-manager/readme.md b/specification/batch/resource-manager/readme.md index 6f8b4e786064..61332e05cd70 100644 --- a/specification/batch/resource-manager/readme.md +++ b/specification/batch/resource-manager/readme.md @@ -25,8 +25,19 @@ To see additional help and options, run: These are the global settings for the Batch API. ``` yaml +title: BatchManagementClient +description: Batch Client openapi-type: arm -tag: package-2021-01 +tag: package-2021-06 +``` + +### Tag: package-2021-06 + +These settings apply only when `--tag=package-2021-06` is specified on the command line. + +```yaml $(tag) == 'package-2021-06' +input-file: + - Microsoft.Batch/stable/2021-06-01/BatchManagement.json ``` ### Tag: package-2021-01 @@ -107,33 +118,64 @@ Note that this setting should be removed once [this GitHub bug](https://github.c ``` yaml directive: + - suppress: R2001 + where: $.definitions.Operation.properties.properties + reason: Breaking change. + + - suppress: R2017 + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}"].put + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates/{certificateName}"].put + reason: Matching service response. + - suppress: R2063 - from: BatchManagement.json reason: Bug in linter - - from: - - 2017-09-01/BatchManagement.json - - 2017-05-01/BatchManagement.json - - 2017-01-01/BatchManagement.json - - 2015-12-01/BatchManagement.json + + - suppress: R2066 where: - - $.definitions.Application - - $.definitions.ApplicationPackage - suppress: - - R2020 - reason: Proxy resource written prior to ARM guidelines update and would require breaking changes to fix. The shape of the entity will be corrected in future next API versions. - - from: - - 2017-09-01/BatchManagement.json - - 2017-05-01/BatchManagement.json - - 2017-01-01/BatchManagement.json - - 2015-12-01/BatchManagement.json + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates/{certificateName}/cancelDelete"].post.operationId + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/listKeys"].post.operationId + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/regenerateKeys"].post.operationId + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/syncAutoStorageKeys"].post.operationId + reason: This is fine as long as the OperationIds are all unique (as they presently are), and fixing it would likely involve a breaking change. + + - suppress: R3018 + where: + - $.definitions.ApplicationProperties.properties.allowUpdates + - $.definitions.BatchAccountProperties.properties.dedicatedCoreQuotaPerVMFamilyEnforced + - $.definitions.CheckNameAvailabilityResult.properties.nameAvailable + - $.definitions.StartTask.properties.waitForSuccess + - $.definitions.VMExtension.properties.autoUpgradeMinorVersion + - $.definitions.WindowsConfiguration.properties.enableAutomaticUpdates + reason: Breaking change. + + - suppress: R3018 + where: + - $.definitions.Operation.properties.isDataAction + reason: Boolean required for operations schema. + + - suppress: R4009 where: - - $.definitions.Application.properties - - $.definitions.ApplicationPackage.properties - suppress: - - R3006 - reason: Proxy resource written prior to ARM guidelines update and would require breaking changes to fix. The shape of the entity will be corrected in future API versions. + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}"].get + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}"].patch + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}"].put + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}"].get + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}"].patch + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}"].put + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions/{versionName}"].get + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions/{versionName}"].put + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates/{certificateName}"].get + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates/{certificateName}"].patch + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates/{certificateName}"].put + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}"].get + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}"].put + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}"].patch + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}"].patch + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}"].get + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateLinkResources/{privateLinkResourceName}"].get + reason: Service missing headers. + - suppress: OBJECT_MISSING_REQUIRED_PROPERTY - from: BatchManagement.json where: $.definitions.UserAccount reason: This field contains a secret (password) and is not returned on a get (but is required on a PUT/PATCH). Previous discussions with the modelling team had said that this was the correct way to model this type of field. ``` @@ -167,7 +209,7 @@ input-file: --- -# Code Generation +## Code Generation ## Swagger to SDK @@ -177,7 +219,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go @@ -189,7 +230,7 @@ swagger-to-sdk: - repo: azure-resource-manager-schemas ``` -## C# +## C\# These settings apply only when `--csharp` is specified on the command line. Please also specify `--csharp-sdks-folder=`. @@ -286,6 +327,3 @@ generate-interface: true ``` ` - - - diff --git a/specification/batch/resource-manager/readme.nodejs.md b/specification/batch/resource-manager/readme.nodejs.md index 50afafe7c4fc..c54c92a3c9b0 100644 --- a/specification/batch/resource-manager/readme.nodejs.md +++ b/specification/batch/resource-manager/readme.nodejs.md @@ -1,4 +1,4 @@ -## Node.js +# Node.js These settings apply only when `--nodejs` is specified on the command line. Please also specify `--node-sdks-folder=`. diff --git a/specification/batch/resource-manager/readme.python.md b/specification/batch/resource-manager/readme.python.md index 66e1624afbd8..4d29c125de77 100644 --- a/specification/batch/resource-manager/readme.python.md +++ b/specification/batch/resource-manager/readme.python.md @@ -1,22 +1,10 @@ -## Python +# Python These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.batch - package-name: azure-mgmt-batch - clear-output-folder: true -``` - ``` yaml $(python) && $(track2) -python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.batch @@ -25,18 +13,12 @@ package-version: 14.0.0b1 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' +``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/batch/azure-mgmt-batch/azure/mgmt/batch -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/batch/azure-mgmt-batch/azure/mgmt/batch ``` -``` yaml $(python) && $(python-mode) == 'create' +``` yaml $(python) && $(python-mode) == 'create' && $(track2) basic-setup-py: true output-folder: $(python-sdks-folder)/batch/azure-mgmt-batch -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/batch/azure-mgmt-batch ``` diff --git a/specification/batch/resource-manager/readme.ruby.md b/specification/batch/resource-manager/readme.ruby.md index eb5052b24524..05bb60ad1152 100644 --- a/specification/batch/resource-manager/readme.ruby.md +++ b/specification/batch/resource-manager/readme.ruby.md @@ -1,4 +1,4 @@ -## Ruby +# Ruby These settings apply only when `--ruby` is specified on the command line. @@ -8,7 +8,7 @@ package-version: "0.16.0" azure-arm: true ``` -### Ruby multi-api +## Ruby multi-api ``` yaml $(ruby) && $(multiapi) batch: diff --git a/specification/batch/resource-manager/readme.typescript.md b/specification/batch/resource-manager/readme.typescript.md index 2db481be9600..bd6ffddf3dea 100644 --- a/specification/batch/resource-manager/readme.typescript.md +++ b/specification/batch/resource-manager/readme.typescript.md @@ -1,4 +1,4 @@ -## TypeScript +# TypeScript These settings apply only when `--typescript` is specified on the command line. Please also specify `--typescript-sdks-folder=`. diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/BatchAI.json b/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/BatchAI.json deleted file mode 100644 index 05b6f9f5945e..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/BatchAI.json +++ /dev/null @@ -1,2991 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "BatchAI", - "description": "The Azure BatchAI Management API.", - "version": "2017-09-01-preview", - "x-ms-code-generation-settings": { - "name": "BatchAIManagementClient" - } - }, - "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.BatchAI/operations": { - "get": { - "tags": [ - "Operations" - ], - "operationId": "Operations_List", - "description": "Lists available operations for the Microsoft.BatchAI provider.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List of available operations for Batch AI Resource Provider": { - "$ref": "./examples/OperationList.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/clusters/{clusterName}": { - "put": { - "tags": [ - "Cluster" - ], - "operationId": "Clusters_Create", - "description": "Adds a cluster. A cluster is a collection of compute nodes. Multiple jobs can be run on the same cluster.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterCreateParameters" - }, - "description": "The parameters to provide for cluster creation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains the cluster entity.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "202": { - "description": "The operation will be completed asynchronously." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Create or update cluster": { - "$ref": "./examples/PutCluster.json" - } - } - }, - "patch": { - "tags": [ - "Cluster" - ], - "operationId": "Clusters_Update", - "description": "Update the properties of a given cluster.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterUpdateParameters" - }, - "description": "Additional parameters for cluster update." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains the Cluster entity.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-examples": { - "Patch cluster": { - "$ref": "./examples/PatchCluster.json" - } - } - }, - "delete": { - "tags": [ - "Cluster" - ], - "operationId": "Clusters_Delete", - "description": "Deletes a Cluster.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful." - }, - "202": { - "description": "The operation will be completed asynchronously." - }, - "204": { - "description": "No content." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Delete cluster": { - "$ref": "./examples/DeleteCluster.json" - } - } - }, - "get": { - "tags": [ - "Cluster" - ], - "operationId": "Clusters_Get", - "description": "Gets information about the specified Cluster.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains information about the cluster.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-examples": { - "Get cluster": { - "$ref": "./examples/GetCluster.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/clusters/{clusterName}/listRemoteLoginInformation": { - "post": { - "tags": [ - "Cluster" - ], - "operationId": "Clusters_ListRemoteLoginInformation", - "description": "Get the IP address, port of all the compute nodes in the cluster.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains the list of IP addresses.", - "schema": { - "$ref": "#/definitions/RemoteLoginInformationListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Get a cluster's remote-login-information": { - "$ref": "./examples/ClusterListRemoteLoginInfo.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.BatchAI/clusters": { - "get": { - "tags": [ - "Cluster" - ], - "operationId": "Clusters_List", - "description": "Gets information about the Clusters associated with the subscription.", - "parameters": [ - { - "$ref": "#/parameters/FilterParameter" - }, - { - "$ref": "#/parameters/SelectParameter" - }, - { - "$ref": "#/parameters/MaxResultsParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains a list of Cluster entities associated with the subscription.", - "schema": { - "$ref": "#/definitions/ClusterListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List clusters": { - "$ref": "./examples/ListCluster.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/clusters": { - "get": { - "tags": [ - "Cluster" - ], - "operationId": "Clusters_ListByResourceGroup", - "description": "Gets information about the Clusters associated within the specified resource group.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/FilterParameter" - }, - { - "$ref": "#/parameters/SelectParameter" - }, - { - "$ref": "#/parameters/MaxResultsParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains a list of Cluster entities associated with the resource group.", - "schema": { - "$ref": "#/definitions/ClusterListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List clusters": { - "$ref": "./examples/ListClusterByResourceGroup.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/jobs/{jobName}": { - "put": { - "tags": [ - "Job" - ], - "operationId": "Jobs_Create", - "description": "Adds a Job that gets executed on a cluster.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/JobNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/JobCreateParameters" - }, - "description": "The parameters to provide for job creation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains the job entity.", - "schema": { - "$ref": "#/definitions/Job" - } - }, - "202": { - "description": "The operation will be completed asynchronously." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Create or update job": { - "$ref": "./examples/PutJob.json" - } - } - }, - "delete": { - "tags": [ - "Job" - ], - "operationId": "Jobs_Delete", - "description": "Deletes the specified Batch AI job.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/JobNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful." - }, - "202": { - "description": "The operation will be completed asynchronously." - }, - "204": { - "description": "No content." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Delete job": { - "$ref": "./examples/DeleteJob.json" - } - } - }, - "get": { - "tags": [ - "Job" - ], - "operationId": "Jobs_Get", - "description": "Gets information about the specified Batch AI job.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/JobNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains the Batch AI job entity.", - "schema": { - "$ref": "#/definitions/Job" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-examples": { - "Get job": { - "$ref": "./examples/GetJob.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/jobs/{jobName}/listRemoteLoginInformation": { - "post": { - "tags": [ - "Job" - ], - "operationId": "Jobs_ListRemoteLoginInformation", - "description": "Gets the IP address and port information of all the compute nodes which are used for job execution.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/JobNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains compute node remote login information.", - "schema": { - "$ref": "#/definitions/RemoteLoginInformationListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Get a job's remote-login-information ": { - "$ref": "./examples/JobListRemoteLoginInfo.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/jobs/{jobName}/terminate": { - "post": { - "tags": [ - "Job" - ], - "operationId": "Jobs_Terminate", - "description": "Terminates a job.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/JobNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful." - }, - "202": { - "description": "The operation will be completed asynchronously." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Terminate job": { - "$ref": "./examples/TerminateJob.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.BatchAI/jobs": { - "get": { - "tags": [ - "Job" - ], - "operationId": "Jobs_List", - "description": "Gets information about the jobs associated with the subscription.", - "parameters": [ - { - "$ref": "#/parameters/FilterParameter" - }, - { - "$ref": "#/parameters/SelectParameter" - }, - { - "$ref": "#/parameters/MaxResultsParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains a list of Batch AI job entities associated with the subscription.", - "schema": { - "$ref": "#/definitions/JobListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List jobs": { - "$ref": "./examples/ListJob.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/jobs": { - "get": { - "tags": [ - "Job" - ], - "operationId": "Jobs_ListByResourceGroup", - "description": "Gets information about the Batch AI jobs associated within the specified resource group.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/FilterParameter" - }, - { - "$ref": "#/parameters/SelectParameter" - }, - { - "$ref": "#/parameters/MaxResultsParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains a list of Job entities associated with the resource group.", - "schema": { - "$ref": "#/definitions/JobListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List jobs": { - "$ref": "./examples/ListJobByResourceGroup.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/jobs/{jobName}/listOutputFiles": { - "post": { - "tags": [ - "Job" - ], - "operationId": "Jobs_ListOutputFiles", - "description": "List all files inside the given output directory (Only if the output directory is on Azure File Share or Azure Storage container).", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/JobNameParameter" - }, - { - "$ref": "#/parameters/OutputDirectoryIdParameter" - }, - { - "$ref": "#/parameters/DownloadLinkExpiryParameter" - }, - { - "$ref": "#/parameters/MaxResultsParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains the list of job files.", - "schema": { - "$ref": "#/definitions/FileListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List a job's files": { - "$ref": "./examples/ListOutputFiles.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/fileServers/{fileServerName}": { - "put": { - "tags": [ - "FileServer" - ], - "operationId": "FileServers_Create", - "description": "Creates a file server.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/FileServerNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/FileServerCreateParameters" - }, - "description": "The parameters to provide for file server creation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains the file server entity.", - "schema": { - "$ref": "#/definitions/FileServer" - } - }, - "202": { - "description": "The operation will be completed asynchronously." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Create or update file server": { - "$ref": "./examples/PutFileServer.json" - } - } - }, - "delete": { - "tags": [ - "FileServer" - ], - "operationId": "FileServers_Delete", - "description": "Delete a file Server.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/FileServerNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful." - }, - "202": { - "description": "The operation will be completed asynchronously." - }, - "204": { - "description": "No content." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Delete file server": { - "$ref": "./examples/DeleteFileServer.json" - } - } - }, - "get": { - "tags": [ - "FileServer" - ], - "operationId": "FileServers_Get", - "description": "Gets information about the specified Cluster.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/FileServerNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains information about the FileServer.", - "schema": { - "$ref": "#/definitions/FileServer" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-examples": { - "Get file server": { - "$ref": "./examples/GetFileServer.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.BatchAI/fileServers": { - "get": { - "tags": [ - "FileServer" - ], - "operationId": "FileServers_List", - "description": "To list all the file servers available under the given subscription (and across all resource groups within that subscription)", - "parameters": [ - { - "$ref": "#/parameters/FilterParameter" - }, - { - "$ref": "#/parameters/SelectParameter" - }, - { - "$ref": "#/parameters/MaxResultsParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains a formatted list of clusters and their properties.", - "schema": { - "$ref": "#/definitions/FileServerListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List file servers": { - "$ref": "./examples/ListFileServer.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/fileServers": { - "get": { - "tags": [ - "FileServer" - ], - "operationId": "FileServers_ListByResourceGroup", - "description": "Gets a formatted list of file servers and their properties associated within the specified resource group.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/FilterParameter" - }, - { - "$ref": "#/parameters/SelectParameter" - }, - { - "$ref": "#/parameters/MaxResultsParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains a list of formatted file servers and their properties associated with the resource group.", - "schema": { - "$ref": "#/definitions/FileServerListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List file servers": { - "$ref": "./examples/ListFileServerByResourceGroup.json" - } - } - } - } - }, - "definitions": { - "FileServerBaseProperties": { - "properties": { - "vmSize": { - "type": "string", - "title": "The size of the virtual machine of the file server.", - "description": "For information about available VM sizes for fileservers from the Virtual Machines Marketplace, see Sizes for Virtual Machines (Linux)." - }, - "sshConfiguration": { - "title": "SSH settings for the file server.", - "$ref": "#/definitions/SshConfiguration" - }, - "dataDisks": { - "title": "Settings for the data disk which would be created for the file server.", - "$ref": "#/definitions/DataDisks" - }, - "subnet": { - "title": "Specifies the identifier of the subnet.", - "$ref": "#/definitions/ResourceId" - } - }, - "required": [ - "vmSize", - "sshConfiguration", - "dataDisks" - ], - "description": "The properties of a file server." - }, - "FileServerListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/FileServer" - }, - "description": "The collection of File Servers." - }, - "nextLink": { - "type": "string", - "description": "The continuation token." - } - }, - "description": "Values returned by the List operation." - }, - "DataDisks": { - "properties": { - "diskSizeInGB": { - "type": "integer", - "format": "int32", - "readOnly": false, - "title": "Initial disk size in GB for blank data disks, and the new desired size for resizing existing data disks." - }, - "cachingType": { - "type": "string", - "readOnly": true, - "title": "None, ReadOnly, ReadWrite. Default value is None. This property is not patchable.", - "default": "none", - "enum": [ - "none", - "readonly", - "readwrite" - ], - "x-ms-enum": { - "name": "CachingType", - "modelAsString": false - } - }, - "diskCount": { - "type": "integer", - "format": "int32", - "readOnly": false, - "title": "Number of data disks to be attached to the VM. RAID level 0 will be applied in the case of multiple disks." - }, - "storageAccountType": { - "type": "string", - "readOnly": false, - "title": "Specifies the type of storage account to be used on the disk. Possible values are: Standard_LRS or Premium_LRS.", - "enum": [ - "Standard_LRS", - "Premium_LRS" - ], - "x-ms-enum": { - "name": "StorageAccountType", - "modelAsString": true - } - } - }, - "required": [ - "diskSizeInGB", - "diskCount", - "storageAccountType" - ], - "description": "Settings for the data disk which would be created for the File Server." - }, - "KeyVaultSecretReference": { - "properties": { - "sourceVault": { - "title": "Fully qualified resource Id for the Key Vault.", - "$ref": "#/definitions/ResourceId" - }, - "secretUrl": { - "type": "string", - "title": "The URL referencing a secret in a Key Vault." - } - }, - "required": [ - "sourceVault", - "secretUrl" - ], - "description": "Describes a reference to Key Vault Secret." - }, - "KeyVaultKeyReference": { - "properties": { - "sourceVault": { - "title": "Fully qualified resource Id for the Key Vault.", - "$ref": "#/definitions/ResourceId" - }, - "keyUrl": { - "type": "string", - "title": "The URL referencing a key in a Key Vault." - } - }, - "required": [ - "sourceVault", - "keyUrl" - ], - "description": "Describes a reference to Key Vault Key." - }, - "MountSettings": { - "properties": { - "mountPoint": { - "type": "string", - "title": "Path where the NFS is mounted on the Server." - }, - "fileServerPublicIP": { - "type": "string", - "title": "Public IP of the File Server VM." - }, - "fileServerInternalIP": { - "type": "string", - "title": "Internal subnet IP which can be used to access the file Server from within the subnet." - }, - "fileServerType": { - "type": "string", - "title": "Type of the fileserver e.g. nfs, glusterfs etc.", - "enum": [ - "nfs", - "glusterfs" - ], - "x-ms-enum": { - "name": "FileServerType", - "modelAsString": true - } - } - }, - "description": "Details of the File Server." - }, - "SshConfiguration": { - "properties": { - "publicIPsToAllow": { - "type": "array", - "items": { - "type": "string" - }, - "title": "List of source IP ranges to allow SSH connection to VM.", - "description": "Default value is '*' can be used to match all source IPs. Maximum number of publicIPs that can be specified are 400." - }, - "userAccountSettings": { - "title": "Settings for user account of VMs.", - "$ref": "#/definitions/UserAccountSettings" - } - }, - "required": [ - "userAccountSettings" - ], - "description": "SSH configuration settings for the VM" - }, - "FileServerCreateParameters": { - "properties": { - "location": { - "type": "string", - "description": "The region in which to create the File Server." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "The user specified tags associated with the File Server." - }, - "properties": { - "$ref": "#/definitions/FileServerBaseProperties", - "description": "The properties of the File Server.", - "x-ms-client-flatten": true - } - }, - "required": [ - "location" - ], - "description": "Parameters supplied to the Create operation." - }, - "FileServerProperties": { - "properties": { - "vmSize": { - "type": "string", - "title": "The size of the virtual machine of the File Server.", - "description": "For information about available VM sizes for File Server from the Virtual Machines Marketplace, see Sizes for Virtual Machines (Linux)." - }, - "sshConfiguration": { - "title": "SSH settings for the File Server.", - "$ref": "#/definitions/SshConfiguration" - }, - "dataDisks": { - "title": "Settings for the data disk which would be created for the File Server.", - "$ref": "#/definitions/DataDisks" - }, - "subnet": { - "title": "Specifies the identifier of the subnet.", - "$ref": "#/definitions/ResourceId" - }, - "mountSettings": { - "title": "Details of the File Server.", - "readOnly": true, - "$ref": "#/definitions/MountSettings" - }, - "provisioningStateTransitionTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "title": "Time when the status was changed." - }, - "creationTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "title": "Time when the FileServer was created." - }, - "provisioningState": { - "type": "string", - "readOnly": true, - "x-nullable": false, - "title": "Specifies the provisioning state of the File Server.", - "description": "Possible values: creating - The File Server is getting created. updating - The File Server creation has been accepted and it is getting updated. deleting - The user has requested that the File Server be deleted, and it is in the process of being deleted. failed - The File Server creation has failed with the specified errorCode. Details about the error code are specified in the message field. succeeded - The File Server creation has succeeded.", - "enum": [ - "creating", - "updating", - "deleting", - "succeeded", - "failed" - ], - "x-ms-enum": { - "name": "FileServerProvisioningState", - "modelAsString": false - } - } - }, - "description": "File server specific properties." - }, - "FileServer": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/FileServerProperties", - "description": "The properties associated with the File Server." - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Contains information about the File Server." - }, - "ClusterBaseProperties": { - "properties": { - "vmSize": { - "type": "string", - "title": "The size of the virtual machines in the cluster.", - "description": "All virtual machines in a cluster are the same size. For information about available VM sizes for clusters using images from the Virtual Machines Marketplace (see Sizes for Virtual Machines (Linux) or Sizes for Virtual Machines (Windows). Batch AI service supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)." - }, - "vmPriority": { - "type": "string", - "title": "dedicated or lowpriority.", - "description": "Default is dedicated.", - "default": "dedicated", - "enum": [ - "dedicated", - "lowpriority" - ], - "x-ms-enum": { - "name": "VmPriority", - "modelAsString": false - } - }, - "scaleSettings": { - "$ref": "#/definitions/ScaleSettings", - "title": "Desired scale for the cluster." - }, - "virtualMachineConfiguration": { - "title": "Settings for OS image and mounted data volumes.", - "$ref": "#/definitions/VirtualMachineConfiguration" - }, - "nodeSetup": { - "title": "Setup to be done on all compute nodes in the cluster.", - "$ref": "#/definitions/NodeSetup" - }, - "userAccountSettings": { - "title": "Settings for user account that will be created on all compute nodes of the cluster.", - "$ref": "#/definitions/UserAccountSettings" - }, - "subnet": { - "title": "Specifies the identifier of the subnet. ", - "$ref": "#/definitions/ResourceId" - } - }, - "required": [ - "vmSize", - "userAccountSettings" - ], - "description": "The properties of a Cluster." - }, - "ClusterUpdateProperties": { - "properties": { - "scaleSettings": { - "$ref": "#/definitions/ScaleSettings", - "title": "Desired scale for the cluster" - } - }, - "description": "The properties of a Cluster that need to be updated." - }, - "DeallocationOption": { - "type": "string", - "title": "Specifies when compute nodes may be removed from the cluster, if the cluster size is decreasing.", - "description": "Possible values are: requeue - Terminate running jobs and requeue them. The jobs will run again. Remove compute nodes as soon as jobs have been terminated. terminate - Terminate running jobs. The jobs will not run again. Remove compute nodes as soon as jobs have been terminated. jobcompletion - Allow currently running jobs to complete. Schedule no new jobs while waiting. Remove compute nodes when all jobs have completed. The default value is requeue.", - "default": "requeue", - "enum": [ - "requeue", - "terminate", - "waitforjobcompletion", - "unknown" - ], - "x-ms-enum": { - "name": "DeallocationOption", - "modelAsString": false - } - }, - "ScaleSettings": { - "properties": { - "manual": { - "$ref": "#/definitions/ManualScaleSettings", - "title": "The scale for the cluster by manual settings" - }, - "autoScale": { - "$ref": "#/definitions/AutoScaleSettings", - "title": "The scale for the cluster by autoscale settings" - } - }, - "description": "At least one of manual or autoScale settings must be specified. Only one of manual or autoScale settings can be specified. If autoScale settings are specified, the system automatically scales the cluster up and down (within the supplied limits) based on the pending jobs on the cluster." - }, - "AutoScaleSettings": { - "properties": { - "minimumNodeCount": { - "type": "integer", - "format": "int32", - "title": "Specifies the minimum number of compute nodes the cluster can have." - }, - "maximumNodeCount": { - "type": "integer", - "format": "int32", - "title": "Specifies the maximum number of compute nodes the cluster can have." - }, - "initialNodeCount": { - "type": "integer", - "format": "int32", - "title": "Specifies the number of compute nodes to allocate on cluster creation. Note that this value is used only during cluster creation.", - "default": 0 - } - }, - "required": [ - "minimumNodeCount", - "maximumNodeCount" - ], - "description": "The system automatically scales the cluster up and down (within minimumNodeCount and maximumNodeCount) based on the pending and running jobs on the cluster." - }, - "ManualScaleSettings": { - "properties": { - "targetNodeCount": { - "type": "integer", - "format": "int32", - "title": "The desired number of compute nodes in the Cluster.", - "default": 0, - "description": "Default is 0. If autoScaleSettings are not specified, then the Cluster starts with this target." - }, - "nodeDeallocationOption": { - "title": "Determines what to do with the job(s) running on compute node if the Cluster size is decreasing.", - "description": "The default value is requeue.", - "default": "requeue", - "$ref": "#/definitions/DeallocationOption" - } - }, - "required": [ - "targetNodeCount" - ], - "description": "Manual scale settings for the cluster." - }, - "VirtualMachineConfiguration": { - "properties": { - "imageReference": { - "title": "Reference to OS image.", - "$ref": "#/definitions/ImageReference" - } - }, - "description": "Settings for OS image." - }, - "ImageReference": { - "properties": { - "publisher": { - "type": "string", - "title": "Publisher of the image." - }, - "offer": { - "type": "string", - "title": "Offer of the image." - }, - "sku": { - "type": "string", - "title": "SKU of the image." - }, - "version": { - "type": "string", - "title": "Version of the image" - } - }, - "required": [ - "publisher", - "offer", - "sku" - ], - "description": "The image reference." - }, - "NodeStateCounts": { - "properties": { - "idleNodeCount": { - "type": "integer", - "format": "int32", - "title": "Number of compute nodes in idle state." - }, - "runningNodeCount": { - "type": "integer", - "format": "int32", - "title": "Number of compute nodes which are running jobs." - }, - "preparingNodeCount": { - "type": "integer", - "format": "int32", - "title": "Number of compute nodes which are being prepared." - }, - "unusableNodeCount": { - "type": "integer", - "format": "int32", - "title": "Number of compute nodes which are unusable." - }, - "leavingNodeCount": { - "type": "integer", - "format": "int32", - "title": "Number of compute nodes which are leaving the cluster." - } - }, - "required": [ - "idleNodeCount", - "runningNodeCount", - "preparingNodeCount", - "unusableNodeCount", - "leavingNodeCount" - ], - "description": "Counts of various compute node states on the cluster." - }, - "UserAccountSettings": { - "properties": { - "adminUserName": { - "type": "string", - "title": "Specifies the name of the administrator account." - }, - "adminUserSshPublicKey": { - "type": "string", - "title": "SSH public keys used to authenticate with linux based VMs. This does not get returned in a GET response body." - }, - "adminUserPassword": { - "type": "string", - "title": "Admin user Password (linux only). This does not get returned in a GET response body." - } - }, - "required": [ - "adminUserName" - ], - "description": "Settings for user account that gets created on each on the nodes of a cluster." - }, - "NodeSetup": { - "properties": { - "setupTask": { - "title": "Specifies a setup task which can be used to customize the compute nodes of the cluster. The NodeSetup task runs every time a VM is rebooted. For that reason the task code needs to be idempotent. Generally it is used to either download static data that is required for all jobs that run on the cluster VMs or to download/install software.", - "$ref": "#/definitions/SetupTask" - }, - "mountVolumes": { - "title": "Information on shared volumes to be used by jobs.", - "$ref": "#/definitions/MountVolumes" - } - }, - "description": "Use this to prepare the VM. NOTE: The volumes specified in mountVolumes are mounted first and then the setupTask is run. Therefore the setup task can use local mountPaths in its execution." - }, - "SetupTask": { - "properties": { - "commandLine": { - "type": "string", - "title": "Command Line to start Setup process." - }, - "environmentVariables": { - "type": "array", - "items": { - "$ref": "#/definitions/EnvironmentSetting" - }, - "title": "Collection of environment settings." - }, - "runElevated": { - "type": "boolean", - "title": "Specifies whether to run the setup task in elevated mode. The default value is false.", - "default": false - }, - "stdOutErrPathPrefix": { - "type": "string", - "description": "The path where the Batch AI service will upload the stdout and stderror of setup task." - } - }, - "required": [ - "commandLine", - "stdOutErrPathPrefix" - ], - "description": "Specifies a setup task which can be used to customize the compute nodes of the cluster." - }, - "ClusterCreateParameters": { - "properties": { - "location": { - "type": "string", - "description": "The region in which to create the cluster." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "The user specified tags associated with the Cluster." - }, - "properties": { - "$ref": "#/definitions/ClusterBaseProperties", - "description": "The properties of the Cluster.", - "x-ms-client-flatten": true - } - }, - "required": [ - "location" - ], - "description": "Parameters supplied to the Create operation." - }, - "ClusterUpdateParameters": { - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "The user specified tags associated with the Cluster." - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ClusterUpdateProperties", - "description": "The properties of the Cluster." - } - }, - "description": "Parameters supplied to the Update operation." - }, - "ClusterProperties": { - "properties": { - "vmSize": { - "type": "string", - "title": "The size of the virtual machines in the cluster.", - "description": "All virtual machines in a cluster are the same size. For information about available VM sizes for clusters using images from the Virtual Machines Marketplace (see Sizes for Virtual Machines (Linux) or Sizes for Virtual Machines (Windows). Batch AI service supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)." - }, - "vmPriority": { - "type": "string", - "title": "dedicated or lowpriority.", - "description": "The default value is dedicated. The node can get preempted while the task is running if lowpriority is chosen. This is best suited if the workload is checkpointing and can be restarted.", - "default": "dedicated", - "enum": [ - "dedicated", - "lowpriority" - ], - "x-ms-enum": { - "name": "VmPriority", - "modelAsString": false - } - }, - "scaleSettings": { - "$ref": "#/definitions/ScaleSettings", - "title": "Desired scale for the Cluster." - }, - "virtualMachineConfiguration": { - "title": "Settings for OS image and mounted data volumes.", - "$ref": "#/definitions/VirtualMachineConfiguration" - }, - "nodeSetup": { - "title": "Setup to be done on all compute nodes in the Cluster.", - "$ref": "#/definitions/NodeSetup" - }, - "userAccountSettings": { - "title": "Settings for user account of compute nodes.", - "$ref": "#/definitions/UserAccountSettings" - }, - "subnet": { - "title": "Specifies the identifier of the subnet.", - "$ref": "#/definitions/ResourceId" - }, - "creationTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "title": "The creation time of the cluster." - }, - "provisioningState": { - "type": "string", - "readOnly": true, - "x-nullable": false, - "title": "Specifies the provisioning state of the cluster.", - "description": "Possible value are: creating - Specifies that the cluster is being created. succeeded - Specifies that the cluster has been created successfully. failed - Specifies that the cluster creation has failed. deleting - Specifies that the cluster is being deleted.", - "enum": [ - "creating", - "succeeded", - "failed", - "deleting" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": false - } - }, - "provisioningStateTransitionTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "title": "The provisioning state transition time of the cluster." - }, - "allocationState": { - "type": "string", - "readOnly": true, - "title": "Indicates whether the cluster is resizing.", - "description": "Possible values are: steady and resizing. steady state indicates that the cluster is not resizing. There are no changes to the number of compute nodes in the cluster in progress. A cluster enters this state when it is created and when no operations are being performed on the cluster to change the number of compute nodes. resizing state indicates that the cluster is resizing; that is, compute nodes are being added to or removed from the cluster.", - "enum": [ - "steady", - "resizing" - ], - "x-ms-enum": { - "name": "AllocationState", - "modelAsString": false - } - }, - "allocationStateTransitionTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "title": "The time at which the cluster entered its current allocation state." - }, - "errors": { - "title": "Contains details of various errors on the cluster including resize and node setup task", - "description": "This element contains all the errors encountered by various compute nodes during node setup.", - "type": "array", - "items": { - "$ref": "#/definitions/BatchAIError" - } - }, - "currentNodeCount": { - "type": "integer", - "readOnly": true, - "format": "int32", - "title": "The number of compute nodes currently assigned to the cluster." - }, - "nodeStateCounts": { - "title": "Counts of various node states on the cluster.", - "readOnly": true, - "$ref": "#/definitions/NodeStateCounts" - } - }, - "description": "Job specific properties." - }, - "Cluster": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ClusterProperties", - "description": "The properties associated with the Cluster." - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Contains information about a Cluster." - }, - "ClusterListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Cluster" - }, - "description": "The collection of returned Clusters." - }, - "nextLink": { - "type": "string", - "description": "The continuation token." - } - }, - "description": "Values returned by the List Clusters operation." - }, - "JobBaseProperties": { - "properties": { - "experimentName": { - "type": "string", - "description": "Describe the experiment information of the job" - }, - "priority": { - "type": "integer", - "format": "int32", - "title": "Priority associated with the job.", - "description": "Priority associated with the job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0.", - "default": 0 - }, - "cluster": { - "title": "Specifies the Id of the cluster on which this job will run.", - "$ref": "#/definitions/ResourceId" - }, - "nodeCount": { - "type": "integer", - "format": "int32", - "title": "Number of compute nodes to run the job on.", - "description": "The job will be gang scheduled on that many compute nodes" - }, - "containerSettings": { - "title": "If provided the job will run in the specified container.", - "description": "If the container was downloaded as part of cluster setup then the same container image will be used. If not provided, the job will run on the VM.", - "$ref": "#/definitions/ContainerSettings" - }, - "cntkSettings": { - "title": "Specifies the settings for CNTK (aka Microsoft Cognitive Toolkit) job.", - "$ref": "#/definitions/CNTKsettings" - }, - "tensorFlowSettings": { - "title": "Specifies the settings for Tensor Flow job.", - "$ref": "#/definitions/TensorFlowSettings" - }, - "caffeSettings": { - "title": "Specifies the settings for Caffe job.", - "$ref": "#/definitions/CaffeSettings" - }, - "caffe2Settings": { - "title": "Specifies the settings for Caffe2 job.", - "$ref": "#/definitions/Caffe2Settings" - }, - "chainerSettings": { - "title": "Specifies the settings for Chainer job.", - "$ref": "#/definitions/ChainerSettings" - }, - "customToolkitSettings": { - "title": "Specifies the settings for custom tool kit job.", - "$ref": "#/definitions/CustomToolkitSettings" - }, - "jobPreparation": { - "title": "Specifies the command line to be executed before tool kit is launched.", - "description": "The specified actions will run on all the nodes that are part of the job", - "$ref": "#/definitions/JobPreparation" - }, - "stdOutErrPathPrefix": { - "type": "string", - "description": "The path where the Batch AI service will upload stdout and stderror of the job." - }, - "inputDirectories": { - "type": "array", - "items": { - "$ref": "#/definitions/InputDirectory" - }, - "title": "Specifies the list of input directories for the Job." - }, - "outputDirectories": { - "type": "array", - "items": { - "$ref": "#/definitions/OutputDirectory" - }, - "title": "Specifies the list of output directories where the models will be created. ." - }, - "environmentVariables": { - "type": "array", - "items": { - "$ref": "#/definitions/EnvironmentSetting" - }, - "title": "Additional environment variables to set on the job.", - "description": "Batch AI service sets the following environment variables for all jobs: AZ_BATCHAI_INPUT_id, AZ_BATCHAI_OUTPUT_id, AZ_BATCHAI_NUM_GPUS_PER_NODE. For distributed TensorFlow jobs, following additional environment variables are set by the Batch AI Service: AZ_BATCHAI_PS_HOSTS, AZ_BATCHAI_WORKER_HOSTS" - }, - "constraints": { - "properties": { - "maxWallClockTime": { - "type": "string", - "format": "duration", - "title": "Max time the job can run.", - "description": "Default Value = 1 week.", - "default": "7.00:00:00" - } - }, - "description": "Constraints associated with the Job." - } - }, - "required": [ - "cluster", - "nodeCount", - "stdOutErrPathPrefix" - ], - "description": "The properties of a Batch AI job." - }, - "JobCreateParameters": { - "properties": { - "location": { - "type": "string", - "description": "The region in which to create the job." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "The user specified tags associated with the job." - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/JobBaseProperties", - "description": "The properties of the Job." - } - }, - "required": [ - "location" - ], - "description": "Parameters supplied to the Create operation." - }, - "JobProperties": { - "properties": { - "experimentName": { - "type": "string", - "description": "Describe the experiment information of the job" - }, - "priority": { - "type": "integer", - "format": "int32", - "title": "Priority associated with the job.", - "description": "Priority associated with the job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0.", - "default": 0 - }, - "cluster": { - "title": "Specifies the Id of the cluster on which this job will run.", - "$ref": "#/definitions/ResourceId" - }, - "nodeCount": { - "type": "integer", - "format": "int32", - "title": "Number of compute nodes to run the job on.", - "description": "The job will be gang scheduled on that many compute nodes" - }, - "containerSettings": { - "title": "If provided the job will run in the specified container.", - "description": "If the container was downloaded as part of cluster setup then the same container image will be used. If not provided, the job will run on the VM.", - "$ref": "#/definitions/ContainerSettings" - }, - "toolType": { - "title": "The toolkit type of this job.", - "description": "Possible values are: cntk, tensorflow, caffe, caffe2, chainer, custom.", - "$ref": "#/definitions/ToolType" - }, - "cntkSettings": { - "title": "Specifies the settings for CNTK (aka Microsoft Cognitive Toolkit) job.", - "$ref": "#/definitions/CNTKsettings" - }, - "tensorFlowSettings": { - "title": "Specifies the settings for Tensor Flow job.", - "$ref": "#/definitions/TensorFlowSettings" - }, - "caffeSettings": { - "title": "Specifies the settings for Caffe job.", - "$ref": "#/definitions/CaffeSettings" - }, - "chainerSettings": { - "title": "Specifies the settings for Chainer job.", - "$ref": "#/definitions/ChainerSettings" - }, - "customToolkitSettings": { - "title": "Specifies the settings for custom tool kit job.", - "$ref": "#/definitions/CustomToolkitSettings" - }, - "jobPreparation": { - "title": "Specifies the actions to be performed before tool kit is launched.", - "description": "The specified actions will run on all the nodes that are part of the job", - "$ref": "#/definitions/JobPreparation" - }, - "stdOutErrPathPrefix": { - "type": "string", - "description": "The path where the Batch AI service will upload stdout and stderror of the job." - }, - "inputDirectories": { - "type": "array", - "items": { - "$ref": "#/definitions/InputDirectory" - }, - "title": "Specifies the list of input directories for the Job." - }, - "outputDirectories": { - "type": "array", - "items": { - "$ref": "#/definitions/OutputDirectory" - }, - "title": "Specifies the list of output directories where the models will be created. ." - }, - "environmentVariables": { - "type": "array", - "items": { - "$ref": "#/definitions/EnvironmentSetting" - }, - "title": "Additional environment variables to be passed to the job.", - "description": "Batch AI services sets the following environment variables for all jobs: AZ_BATCHAI_INPUT_id, AZ_BATCHAI_OUTPUT_id, AZ_BATCHAI_NUM_GPUS_PER_NODE, For distributed TensorFlow jobs, following additional environment variables are set by the Batch AI Service: AZ_BATCHAI_PS_HOSTS, AZ_BATCHAI_WORKER_HOSTS." - }, - "constraints": { - "properties": { - "maxWallClockTime": { - "type": "string", - "format": "duration", - "title": "Max time the job can run.", - "description": "Default Value = 1 week.", - "default": "7.00:00:00" - } - }, - "description": "Constraints associated with the Job." - }, - "creationTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "title": "The job creation time.", - "description": "The creation time of the job." - }, - "provisioningState": { - "type": "string", - "readOnly": true, - "x-nullable": false, - "description": "The provisioned state of the Batch AI job", - "enum": [ - "creating", - "deleting", - "succeeded", - "failed" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": false - } - }, - "provisioningStateTransitionTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "title": "The time at which the job entered its current provisioning state.", - "description": "The time at which the job entered its current provisioning state." - }, - "executionState": { - "type": "string", - "title": "The current state of the job.", - "description": "The current state of the job. Possible values are: queued - The job is queued and able to run. A job enters this state when it is created, or when it is awaiting a retry after a failed run. running - The job is running on a compute cluster. This includes job-level preparation such as downloading resource files or set up container specified on the job - it does not necessarily mean that the job command line has started executing. terminating - The job is terminated by the user, the terminate operation is in progress. succeeded - The job has completed running successfully and exited with exit code 0. failed - The job has finished unsuccessfully (failed with a non-zero exit code) and has exhausted its retry limit. A job is also marked as failed if an error occurred launching the job.", - "enum": [ - "queued", - "running", - "terminating", - "succeeded", - "failed" - ], - "x-ms-enum": { - "name": "ExecutionState", - "modelAsString": false - } - }, - "executionStateTransitionTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "title": "The time at which the job entered its current execution state.", - "description": "The time at which the job entered its current execution state." - }, - "executionInfo": { - "properties": { - "startTime": { - "type": "string", - "format": "date-time", - "title": "The time at which the job started running.", - "description": "'Running' corresponds to the running state. If the job has been restarted or retried, this is the most recent time at which the job started running. This property is present only for job that are in the running or completed state." - }, - "endTime": { - "type": "string", - "format": "date-time", - "title": "The time at which the job completed.", - "description": "This property is only returned if the job is in completed state." - }, - "exitCode": { - "type": "integer", - "format": "int32", - "title": "The exit code of the job.", - "description": "This property is only returned if the job is in completed state." - }, - "errors": { - "title": "Contains details of various errors encountered by the service during job execution", - "type": "array", - "items": { - "$ref": "#/definitions/BatchAIError" - } - } - }, - "required": [ - "startTime" - ], - "description": "Contains information about the execution of a job in the Azure Batch service." - } - }, - "description": "Job specific properties." - }, - "Job": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/JobProperties", - "description": "The properties associated with the job." - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Contains information about the job." - }, - "JobListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Job" - }, - "description": "The collection of jobs." - }, - "nextLink": { - "type": "string", - "description": "The continuation token." - } - }, - "description": "Values returned by the List operation." - }, - "RemoteLoginInformation": { - "properties": { - "nodeId": { - "type": "string", - "description": "Id of the compute node" - }, - "ipAddress": { - "type": "string", - "description": "ip address" - }, - "port": { - "type": "number", - "format": "int32", - "title": "port number" - } - }, - "description": "Contains remote login details to SSH/RDP to a compute node in cluster.", - "required": [ - "nodeId", - "ipAddress", - "port" - ] - }, - "RemoteLoginInformationListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/RemoteLoginInformation" - }, - "description": "The collection of returned remote login details." - }, - "nextLink": { - "type": "string", - "description": "The continuation token." - } - }, - "description": "Values returned by the List operation." - }, - "FileProperties": { - "properties": { - "lastModified": { - "type": "string", - "format": "date-time", - "title": "The time at which the file was last modified.", - "description": "The time at which the file was last modified." - }, - "contentLength": { - "type": "integer", - "format": "int64", - "title": "The file size.", - "description": "The file size." - } - }, - "description": "File specific properties." - }, - "File": { - "properties": { - "name": { - "type": "string", - "description": "file name" - }, - "downloadUrl": { - "type": "string", - "title": "file download url, example: https://mystg.blob.core.windows.net/mycontainer/myModel_1.dnn", - "description": "This will be returned only if the model has been archived. During job run, this won't be returned and customers can use SSH tunneling to download. Users can use Get Remote Login Information API to get the IP address and port information of all the compute nodes running the job." - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/FileProperties", - "description": "The properties associated with the file." - } - }, - "description": "Properties of the file.", - "required": [ - "name", - "downloadUrl" - ] - }, - "FileListResult": { - "properties": { - "value": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/File" - }, - "description": "The collection of returned job files." - }, - "nextLink": { - "type": "string", - "description": "The continuation token." - } - }, - "description": "Values returned by the List operation." - }, - "ResourceId": { - "properties": { - "id": { - "type": "string", - "description": "The ID of the resource" - } - }, - "required": [ - "id" - ], - "description": "Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.", - "x-ms-azure-resource": true - }, - "Resource": { - "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 - }, - "ToolType": { - "type": "string", - "description": "The toolkit type of this job.", - "enum": [ - "cntk", - "tensorflow", - "caffe", - "caffe2", - "chainer", - "custom" - ], - "x-ms-enum": { - "name": "ToolType", - "modelAsString": true - } - }, - "NameValuePair": { - "properties": { - "name": { - "type": "string", - "title": "The name in the name-value pair." - }, - "value": { - "type": "string", - "title": "The value in the name-value pair." - } - }, - "description": "Represents a name-value pair." - }, - "EnvironmentSetting": { - "properties": { - "name": { - "type": "string", - "title": "The name of the environment variable." - }, - "value": { - "type": "string", - "title": "The value of the environment variable." - } - }, - "required": [ - "name" - ], - "description": "A collection of environment variables to set." - }, - "LocalDataVolume": { - "properties": { - "hostPath": { - "type": "string", - "title": "The path on the host that is to be mounted as a directory in the container." - }, - "localPath": { - "type": "string", - "title": "The container local path where the host directory is mounted." - } - }, - "description": "Represents mapping of host directories to directories in the container.", - "required": [ - "hostPath", - "localPath" - ] - }, - "ImageSourceRegistry": { - "properties": { - "serverUrl": { - "type": "string", - "title": "URL for image repository." - }, - "image": { - "type": "string", - "title": "The name of the image in image repository." - }, - "credentials": { - "title": "Information to access the private Docker repository.", - "$ref": "#/definitions/PrivateRegistryCredentials" - } - }, - "description": "Details of the container image such as name, URL and credentials.", - "required": [ - "image" - ] - }, - "PrivateRegistryCredentials": { - "properties": { - "username": { - "type": "string", - "title": "User name to login." - }, - "password": { - "type": "string", - "title": "Password to login.", - "description": "One of password or passwordSecretReference must be specified." - }, - "passwordSecretReference": { - "title": "Specifies the location of the password, which is a Key Vault Secret.", - "description": "Users can store their secrets in Azure KeyVault and pass it to the Batch AI Service to integrate with KeyVault. One of password or passwordSecretReference must be specified.", - "$ref": "#/definitions/KeyVaultSecretReference" - } - }, - "description": "Credentials to access a container image in a private repository.", - "required": [ - "username" - ] - }, - "ContainerSettings": { - "properties": { - "imageSourceRegistry": { - "title": "Registry to download the container from.", - "$ref": "#/definitions/ImageSourceRegistry" - } - }, - "description": "Settings for the container to be downloaded.", - "required": [ - "imageSourceRegistry" - ] - }, - "InputDirectory": { - "properties": { - "id": { - "type": "string", - "title": "The id for the input directory.", - "description": "It will be available for the job as an environment variable under AZ_BATCHAI_INPUT_id. The service will also provide the following environment variable: AZ_BATCHAI_PREV_OUTPUT_Name. The value of the variable will be populated if the job is being retried after a previous failure, otherwise it will be set to nothing." - }, - "path": { - "type": "string", - "title": "The path to the input directory." - } - }, - "description": "Input directory for the job.", - "required": [ - "id", - "path" - ] - }, - "OutputDirectory": { - "properties": { - "id": { - "type": "string", - "title": "The name for the output directory.", - "description": "It will be available for the job as an environment variable under AZ_BATCHAI_OUTPUT_id." - }, - "pathPrefix": { - "type": "string", - "title": "The prefix path where the output directory will be created.", - "description": "NOTE: This is an absolute path to prefix. E.g. $AZ_BATCHAI_MOUNT_ROOT/MyNFS/MyLogs." - }, - "pathSuffix": { - "type": "string", - "title": "The suffix path where the output directory will be created.", - "description": "The suffix path where the output directory will be created." - }, - "type": { - "type": "string", - "title": "An enumeration, which specifies the type of job output directory.", - "description": "Default value is Custom. The possible values are Model, Logs, Summary, and Custom. Users can use multiple enums for a single directory. Eg. outPutType='Model,Logs, Summary'", - "default": "custom", - "enum": [ - "model", - "logs", - "summary", - "custom" - ], - "x-ms-enum": { - "name": "OutputType", - "modelAsString": true - } - }, - "createNew": { - "type": "boolean", - "title": "True to create new directory.", - "description": "Default is true. If false, then the directory is not created and can be any directory path that the user specifies.", - "default": true - } - }, - "description": "Output directory for the job.", - "required": [ - "id", - "pathPrefix" - ] - }, - "AzureStorageCredentialsInfo": { - "properties": { - "accountKey": { - "type": "string", - "title": "Storage account key.", - "description": "One of accountKey or accountKeySecretReference must be specified." - }, - "accountKeySecretReference": { - "title": "Specifies the location of the storage account key, which is a Key Vault Secret.", - "description": "Users can store their secrets in Azure KeyVault and pass it to the Batch AI Service to integrate with KeyVault. One of accountKey or accountKeySecretReference must be specified.", - "$ref": "#/definitions/KeyVaultSecretReference" - } - }, - "description": "Credentials to access Azure File Share." - }, - "AzureFileShareReference": { - "properties": { - "accountName": { - "type": "string", - "title": "Name of the storage account." - }, - "azureFileUrl": { - "type": "string", - "title": "URL to access the Azure File." - }, - "credentials": { - "title": "Information of the Azure File credentials.", - "$ref": "#/definitions/AzureStorageCredentialsInfo" - }, - "relativeMountPath": { - "type": "string", - "title": "Specifies the relative path on the compute node where the Azure file share will be mounted.", - "description": "Note that all file shares will be mounted under $AZ_BATCHAI_MOUNT_ROOT location." - }, - "fileMode": { - "type": "string", - "title": "Specifies the file mode.", - "description": "Default value is 0777. Valid only if OS is linux.", - "default": "0777" - }, - "directoryMode": { - "type": "string", - "title": "Specifies the directory Mode.", - "description": "Default value is 0777. Valid only if OS is linux.", - "default": "0777" - } - }, - "description": "Details of the Azure File Share to mount on the cluster.", - "required": [ - "accountName", - "azureFileUrl", - "credentials", - "relativeMountPath" - ] - }, - "AzureBlobFileSystemReference": { - "properties": { - "accountName": { - "type": "string", - "title": "Name of the Azure Blob Storage account." - }, - "containerName": { - "type": "string", - "title": "Name of the Azure Blob Storage container to mount on the cluster." - }, - "credentials": { - "title": "Information of the Azure Blob Storage account credentials.", - "$ref": "#/definitions/AzureStorageCredentialsInfo" - }, - "relativeMountPath": { - "type": "string", - "title": "Specifies the relative path on the compute node where the Azure Blob file system will be mounted.", - "description": "Note that all blob file systems will be mounted under $AZ_BATCHAI_MOUNT_ROOT location." - }, - "mountOptions": { - "type": "string", - "title": "Specifies the various mount options that can be used to configure Blob file system." - } - }, - "description": "Provides required information, for the service to be able to mount Azure Blob Storage container on the cluster nodes.", - "required": [ - "accountName", - "containerName", - "credentials", - "relativeMountPath" - ] - }, - "FileServerReference": { - "properties": { - "fileServer": { - "title": "Reference to the file server resource.", - "$ref": "#/definitions/ResourceId" - }, - "sourceDirectory": { - "type": "string", - "title": "Specifies the source directory in File Server that needs to be mounted.", - "description": "If this property is not specified, the entire File Server will be mounted." - }, - "relativeMountPath": { - "type": "string", - "title": "Specifies the relative path on the compute node where the File Server will be mounted.", - "description": "Note that all file shares will be mounted under $AZ_BATCHAI_MOUNT_ROOT location." - }, - "mountOptions": { - "type": "string", - "title": "Specifies the mount options for File Server." - } - }, - "description": "Provides required information, for the service to be able to mount Azure FileShare on the cluster nodes.", - "required": [ - "fileServer", - "relativeMountPath" - ] - }, - "UnmanagedFileSystemReference": { - "properties": { - "mountCommand": { - "title": "Command used to mount the unmanaged file system.", - "type": "string" - }, - "relativeMountPath": { - "type": "string", - "title": "Specifies the relative path on the compute cluster node where the file system will be mounted.", - "description": "Note that all file shares will be mounted under $AZ_BATCHAI_MOUNT_ROOT location." - } - }, - "description": "Details of the file system to mount on the compute cluster nodes.", - "required": [ - "mountCommand", - "relativeMountPath" - ] - }, - "MountVolumes": { - "properties": { - "azureFileShares": { - "type": "array", - "items": { - "$ref": "#/definitions/AzureFileShareReference" - }, - "title": "Azure File Share setup configuration.", - "description": "References to Azure File Shares that are to be mounted to the cluster nodes." - }, - "azureBlobFileSystems": { - "type": "array", - "items": { - "$ref": "#/definitions/AzureBlobFileSystemReference" - }, - "title": "Azure Blob FileSystem setup configuration.", - "description": "References to Azure Blob FUSE that are to be mounted to the cluster nodes." - }, - "fileServers": { - "type": "array", - "items": { - "$ref": "#/definitions/FileServerReference" - }, - "title": "References to a list of file servers that are mounted to the cluster node." - }, - "unmanagedFileSystems": { - "type": "array", - "items": { - "$ref": "#/definitions/UnmanagedFileSystemReference" - }, - "title": "References to a list of file servers that are mounted to the cluster node." - } - }, - "description": "Details of volumes to mount on the cluster." - }, - "CNTKsettings": { - "properties": { - "languageType": { - "type": "string", - "title": "Specifies the language type to use for launching CNTK (aka Microsoft Cognitive Toolkit) job.", - "description": "Valid values are 'BrainScript' or 'Python'." - }, - "configFilePath": { - "type": "string", - "title": "Specifies the path of the config file.", - "description": "This property can be specified only if the languageType is 'BrainScript'." - }, - "pythonScriptFilePath": { - "type": "string", - "title": "The path and file name of the python script to execute the job.", - "description": "This property can be specified only if the languageType is 'Python'." - }, - "pythonInterpreterPath": { - "type": "string", - "title": "The path to python interpreter.", - "description": "This property can be specified only if the languageType is 'Python'." - }, - "commandLineArgs": { - "type": "string", - "title": "Command line arguments that needs to be passed to the python script or CNTK.exe." - }, - "processCount": { - "type": "integer", - "format": "int32", - "title": "Number of processes parameter that is passed to MPI runtime.", - "description": "The default value for this property is equal to nodeCount property" - } - }, - "description": "Specifies the settings for CNTK (aka Microsoft Cognitive Toolkit) job." - }, - "CaffeSettings": { - "properties": { - "configFilePath": { - "type": "string", - "title": "Specifies the path of the config file.", - "description": "This property cannot be specified if pythonScriptFilePath is specified." - }, - "pythonScriptFilePath": { - "type": "string", - "title": "The path and file name of the python script to execute the job.", - "description": "This property cannot be specified if configFilePath is specified." - }, - "pythonInterpreterPath": { - "type": "string", - "title": "The path to python interpreter.", - "description": "This property can be specified only if the pythonScriptFilePath is specified." - }, - "commandLineArgs": { - "type": "string", - "title": "Command line arguments that needs to be passed to the Caffe job." - }, - "processCount": { - "type": "integer", - "format": "int32", - "title": "Number of processes parameter that is passed to MPI runtime.", - "description": "The default value for this property is equal to nodeCount property" - } - }, - "description": "Specifies the settings for Caffe job." - }, - "Caffe2Settings": { - "properties": { - "pythonScriptFilePath": { - "type": "string", - "title": "The path and file name of the python script to execute the job." - }, - "pythonInterpreterPath": { - "type": "string", - "title": "The path to python interpreter." - }, - "commandLineArgs": { - "type": "string", - "title": "Command line arguments that needs to be passed to the python script" - } - }, - "description": "Specifies the settings for Caffe2 job.", - "required": [ - "pythonScriptFilePath" - ] - }, - "ChainerSettings": { - "properties": { - "pythonScriptFilePath": { - "type": "string", - "title": "The path and file name of the python script to execute the job." - }, - "pythonInterpreterPath": { - "type": "string", - "title": "The path to python interpreter." - }, - "commandLineArgs": { - "type": "string", - "title": "Command line arguments that needs to be passed to the python script" - }, - "processCount": { - "type": "integer", - "format": "int32", - "title": "Number of processes parameter that is passed to MPI runtime.", - "description": "The default value for this property is equal to nodeCount property" - } - }, - "description": "Specifies the settings for Chainer job.", - "required": [ - "pythonScriptFilePath" - ] - }, - "CustomToolkitSettings": { - "properties": { - "commandLine": { - "type": "string", - "title": "The command line to execute the custom toolkit Job." - } - }, - "description": "Specifies the settings for a custom tool kit job." - }, - "JobPreparation": { - "properties": { - "commandLine": { - "type": "string", - "title": "The command line to execute.", - "description": "If containerSettings is specified on the job, this commandLine will be executed in the same container as job. Otherwise it will be executed on the node." - } - }, - "description": "Specifies the settings for job preparation.", - "required": [ - "commandLine" - ] - }, - "TensorFlowSettings": { - "properties": { - "pythonScriptFilePath": { - "type": "string", - "title": "The path and file name of the python script to execute the job." - }, - "pythonInterpreterPath": { - "type": "string", - "title": "The path to python interpreter." - }, - "masterCommandLineArgs": { - "type": "string", - "title": "Specifies the command line arguments for the master task." - }, - "workerCommandLineArgs": { - "type": "string", - "title": "Specifies the command line arguments for the worker task.", - "description": "This property is optional for single machine training." - }, - "parameterServerCommandLineArgs": { - "type": "string", - "title": "Specifies the command line arguments for the parameter server task.", - "description": "This property is optional for single machine training." - }, - "workerCount": { - "type": "integer", - "format": "int32", - "title": "The number of worker tasks.", - "description": "If specified, the value must be less than or equal to (nodeCount * numberOfGPUs per VM). If not specified, the default value is equal to nodeCount. This property can be specified only for distributed TensorFlow training" - }, - "parameterServerCount": { - "type": "integer", - "format": "int32", - "title": "The number of parameter server tasks.", - "description": "If specified, the value must be less than or equal to nodeCount. If not specified, the default value is equal to 1 for distributed TensorFlow training (This property is not applicable for single machine training). This property can be specified only for distributed TensorFlow training." - } - }, - "description": "Specifies the settings for TensorFlow job.", - "required": [ - "pythonScriptFilePath", - "masterCommandLineArgs" - ] - }, - "CloudError": { - "x-ms-external": true, - "properties": { - "error": { - "$ref": "#/definitions/CloudErrorBody", - "description": "An error response from the Batch AI service." - } - }, - "description": "An error response from the Batch AI 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." - }, - "target": { - "type": "string", - "description": "The target of the particular error. For example, the name of the property in error." - }, - "details": { - "type": "array", - "items": { - "$ref": "#/definitions/CloudErrorBody" - }, - "description": "A list of additional details about the error." - } - }, - "description": "An error response from the Batch AI service." - }, - "BatchAIError": { - "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/NameValuePair" - }, - "description": "A list of additional details about the error." - } - }, - "description": "An error response from the Batch AI service." - }, - "Operation": { - "title": "A REST API operation", - "description": "Details of a REST API operation", - "type": "object", - "properties": { - "name": { - "title": "The operation name.", - "description": "This is of the format {provider}/{resource}/{operation}", - "type": "string" - }, - "display": { - "description": "The object that describes the operation.", - "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": { - "x-ms-client-flatten": true, - "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.", - "description": "Contains the list of all operations supported by BatchAI resource provider", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Operation" - }, - "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." - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscriptionID for the Azure user." - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "description": "Name of the resource group to which the resource belongs.", - "required": true, - "x-ms-parameter-location": "method", - "type": "string", - "pattern": "^[-\\w\\._]+$" - }, - "ClusterNameParameter": { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[-\\w\\._]+$", - "minLength": 1, - "maxLength": 64, - "x-ms-parameter-location": "method", - "description": "The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long." - }, - "JobNameParameter": { - "name": "jobName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[-\\w\\._]+$", - "minLength": 1, - "maxLength": 64, - "x-ms-parameter-location": "method", - "description": "The name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long." - }, - "FileServerNameParameter": { - "name": "fileServerName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[-\\w\\._]+$", - "minLength": 1, - "maxLength": 64, - "x-ms-parameter-location": "method", - "description": "The name of the file server within the specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Specifies the version of API used for this request." - }, - "SelectParameter": { - "name": "$select", - "in": "query", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "description": "An OData $select clause. Used to select the properties to be returned in the GET response.", - "x-ms-parameter-grouping": { - "postfix": "Options" - } - }, - "FilterParameter": { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "description": "An OData $filter clause. Used to filter results that are returned in the GET response.", - "x-ms-parameter-grouping": { - "postfix": "Options" - } - }, - "MaxResultsParameter": { - "name": "maxresults", - "x-ms-client-name": "maxResults", - "default": 1000, - "minimum": 1, - "maximum": 1000, - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method", - "description": "The maximum number of items to return in the response. A maximum of 1000 files can be returned.", - "x-ms-parameter-grouping": { - "postfix": "Options" - } - }, - "OutputDirectoryIdParameter": { - "name": "outputdirectoryid", - "in": "query", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "description": "Id of the job output directory. This is the OutputDirectory-->id parameter that is given by the user during Create Job.", - "x-ms-parameter-grouping": { - "postfix": "Options" - } - }, - "DownloadLinkExpiryParameter": { - "name": "linkexpiryinminutes", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "minimum": 5, - "maximum": 600, - "default": 60, - "x-ms-parameter-location": "method", - "description": "The number of minutes after which the download link will expire.", - "x-ms-parameter-grouping": { - "postfix": "Options" - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/ClusterListRemoteLoginInfo.json b/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/ClusterListRemoteLoginInfo.json deleted file mode 100644 index 6dfbb83cd9d2..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/ClusterListRemoteLoginInfo.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "clusterName": "demo_cluster", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "nodeId": "tvm-3601533753_1-20170719t162906z", - "ipAddress": "13.84.190.124", - "port": 50000 - }, - { - "nodeId": "tvm-3601533753_2-20170719t162906z", - "ipAddress": "13.84.190.124", - "port": 50001 - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/DeleteCluster.json b/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/DeleteCluster.json deleted file mode 100644 index 9c05055ded37..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/DeleteCluster.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "clusterName": "demo_cluster", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2017-09-01-preview" - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2017-09-01-preview", - "Retry-After": 15 - } - }, - "200": {}, - "204": {} - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/DeleteFileServer.json b/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/DeleteFileServer.json deleted file mode 100644 index 99587060667d..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/DeleteFileServer.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "fileServerName": "demo_nfs", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2017-09-01-preview" - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2017-09-01-preview", - "Retry-After": 15 - } - }, - "200": {}, - "204": {} - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/DeleteJob.json b/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/DeleteJob.json deleted file mode 100644 index 36611d63d54f..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/DeleteJob.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "jobName": "demo_job", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2017-09-01-preview" - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2017-09-01-preview", - "Retry-After": 15 - } - }, - "200": {}, - "204": {} - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/GetCluster.json b/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/GetCluster.json deleted file mode 100644 index b294ee0ca701..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/GetCluster.json +++ /dev/null @@ -1,78 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "clusterName": "demo_cluster", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/clusters/demo_cluster", - "name": "demo_cluster", - "type": "Microsoft.BatchAI/Clusters", - "location": "eastus", - "properties": { - "provisioningState": "succeeded", - "allocationState": "resizing", - "creationTime": "2017-09-27T21:50:02.377Z", - "allocationStateTransitionTime": "2017-09-27T21:50:04.521Z", - "provisioningStateTransitionTime": "2017-09-27T21:50:03.828Z", - "vmSize": "STANDARD_NC6", - "currentNodeCount": 0, - "nodeStateCounts": { - "runningNodeCount": 0, - "idleNodeCount": 0, - "unusableNodeCount": 0, - "preparingNodeCount": 0, - "leavingNodeCount": 0 - }, - "vmPriority": "dedicated", - "scaleSettings": { - "manual": { - "targetNodeCount": 1, - "nodeDeallocationOption": "requeue" - } - }, - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "UbuntuServer", - "sku": "16.04-LTS", - "version": "latest" - } - }, - "userAccountSettings": { - "adminUserName": "admin_user_name" - }, - "nodeSetup": { - "mountVolumes": { - "azureFileShares": [ - { - "accountName": "storage_account_name", - "azureFileUrl": "https://storage_account_name.file.core.windows.net/azure_file_share_name", - "credentials": {}, - "relativeMountPath": "azfiles", - "fileMode": "0777", - "directoryMode": "0777" - } - ], - "fileServers": [ - { - "fileServer": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/fileservers/fileservercedd134b" - }, - "relativeMountPath": "nfs", - "mountOptions": "rw" - } - ] - } - }, - "subnet": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.Network/virtualNetworks/7feb1976-8c31-4f1f-bea2-86cb1839a7bavnet/subnets/Subnet-1" - } - } - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/GetFileServer.json b/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/GetFileServer.json deleted file mode 100644 index 2eb829a0e3f0..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/GetFileServer.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "fileServerName": "demo_nfs", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/fileservers/fileservercedd134b", - "name": "fileservercedd134b", - "type": "Microsoft.BatchAI/FileServers", - "location": "eastus", - "properties": { - "provisioningState": "succeeded", - "creationTime": "2017-09-27T21:45:28.159Z", - "provisioningStateTransitionTime": "2017-09-27T21:49:25.416Z", - "vmSize": "STANDARD_NC6", - "sshConfiguration": { - "userAccountSettings": { - "adminUserName": "admin_user_name" - } - }, - "dataDisks": { - "diskSizeInGB": 10, - "cachingType": "none", - "diskCount": 2, - "storageAccountType": "Standard_LRS" - }, - "subnet": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.Network/virtualNetworks/7feb1976-8c31-4f1f-bea2-86cb1839a7bavnet/subnets/Subnet-1" - }, - "mountSettings": { - "mountPoint": "/mnt/data", - "fileServerPublicIP": "13.90.141.66", - "fileServerInternalIP": "10.0.0.4", - "fileServerType": "nfs" - } - } - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/GetJob.json b/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/GetJob.json deleted file mode 100644 index e42f70e81680..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/GetJob.json +++ /dev/null @@ -1,60 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "jobName": "demo_job", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/jobs/job", - "name": "job", - "type": "Microsoft.BatchAI/Jobs", - "properties": { - "priority": 0, - "cluster": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/clusters/demo_cluster" - }, - "nodeCount": 1, - "containerSettings": { - "imageSourceRegistry": { - "image": "ubuntu" - } - }, - "toolType": "custom", - "customToolkitSettings": { - "commandLine": "echo hi | tee $AZ_BATCHAI_OUTPUT_OUTPUTS/hi.txt" - }, - "stdOutErrPathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles", - "inputDirectories": [ - { - "id": "INPUT", - "path": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/input" - } - ], - "outputDirectories": [ - { - "id": "OUTPUTS", - "pathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/", - "pathSuffix": "files", - "type": "custom", - "createNew": true - } - ], - "constraints": { - "maxWallClockTime": "P7D" - }, - "creationTime": "2017-09-27T23:36:52.611Z", - "provisioningState": "succeeded", - "provisioningStateTransitionTime": "2017-09-27T23:36:53.701Z", - "executionState": "running", - "executionStateTransitionTime": "2017-09-27T23:36:56.395Z", - "executionInfo": { - "startTime": "2017-09-27T23:36:54.115Z" - } - } - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/JobListRemoteLoginInfo.json b/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/JobListRemoteLoginInfo.json deleted file mode 100644 index acfea76aec83..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/JobListRemoteLoginInfo.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "jobName": "demo_job", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "nodeId": "tvm-3601533753_1-20170719t162906z", - "ipAddress": "13.84.190.124", - "port": 50000 - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/ListCluster.json b/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/ListCluster.json deleted file mode 100644 index 27b016ee6119..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/ListCluster.json +++ /dev/null @@ -1,68 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/clusters/demo_cluster", - "name": "demo_cluster", - "type": "Microsoft.BatchAI/Clusters", - "location": "eastus", - "properties": { - "provisioningState": "succeeded", - "allocationState": "resizing", - "creationTime": "2017-09-27T22:28:07.645Z", - "allocationStateTransitionTime": "2017-09-27T22:28:08.998Z", - "provisioningStateTransitionTime": "2017-09-27T22:28:08.327Z", - "vmSize": "STANDARD_NC6", - "currentNodeCount": 0, - "nodeStateCounts": { - "runningNodeCount": 0, - "idleNodeCount": 0, - "unusableNodeCount": 0, - "preparingNodeCount": 0, - "leavingNodeCount": 0 - }, - "vmPriority": "dedicated", - "scaleSettings": { - "manual": { - "targetNodeCount": 1, - "nodeDeallocationOption": "requeue" - } - }, - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "UbuntuServer", - "sku": "16.04-LTS", - "version": "latest" - } - }, - "userAccountSettings": { - "adminUserName": "admin_user_name" - }, - "nodeSetup": { - "mountVolumes": { - "azureFileShares": [ - { - "accountName": "storage_account_name", - "azureFileUrl": "https://storage_account_name.file.core.windows.net/azure_file_share_name", - "credentials": {}, - "relativeMountPath": "azfiles", - "fileMode": "0777", - "directoryMode": "0777" - } - ] - } - } - } - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/ListClusterByResourceGroup.json b/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/ListClusterByResourceGroup.json deleted file mode 100644 index 0a3ace6f4b68..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/ListClusterByResourceGroup.json +++ /dev/null @@ -1,69 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/clusters/demo_cluster", - "name": "demo_cluster", - "type": "Microsoft.BatchAI/Clusters", - "location": "eastus", - "properties": { - "provisioningState": "succeeded", - "allocationState": "resizing", - "creationTime": "2017-09-27T22:28:07.645Z", - "allocationStateTransitionTime": "2017-09-27T22:28:08.998Z", - "provisioningStateTransitionTime": "2017-09-27T22:28:08.327Z", - "vmSize": "STANDARD_NC6", - "currentNodeCount": 0, - "nodeStateCounts": { - "runningNodeCount": 0, - "idleNodeCount": 0, - "unusableNodeCount": 0, - "preparingNodeCount": 0, - "leavingNodeCount": 0 - }, - "vmPriority": "dedicated", - "scaleSettings": { - "manual": { - "targetNodeCount": 1, - "nodeDeallocationOption": "requeue" - } - }, - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "UbuntuServer", - "sku": "16.04-LTS", - "version": "latest" - } - }, - "userAccountSettings": { - "adminUserName": "admin_user_name" - }, - "nodeSetup": { - "mountVolumes": { - "azureFileShares": [ - { - "accountName": "storage_account_name", - "azureFileUrl": "https://storage_account_name.file.core.windows.net/azure_file_share_name", - "credentials": {}, - "relativeMountPath": "azfiles", - "fileMode": "0777", - "directoryMode": "0777" - } - ] - } - } - } - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/ListFileServer.json b/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/ListFileServer.json deleted file mode 100644 index 9545568e238c..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/ListFileServer.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/fileservers/fileservercedd134b", - "name": "fileservercedd134b", - "type": "Microsoft.BatchAI/FileServers", - "location": "eastus", - "properties": { - "provisioningState": "succeeded", - "creationTime": "2017-09-27T21:45:28.159Z", - "provisioningStateTransitionTime": "2017-09-27T21:49:25.416Z", - "vmSize": "STANDARD_NC6", - "sshConfiguration": { - "userAccountSettings": { - "adminUserName": "admin_user_name" - } - }, - "dataDisks": { - "diskSizeInGB": 10, - "cachingType": "none", - "diskCount": 2, - "storageAccountType": "Standard_LRS" - }, - "subnet": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.Network/virtualNetworks/7feb1976-8c31-4f1f-bea2-86cb1839a7bavnet/subnets/Subnet-1" - }, - "mountSettings": { - "mountPoint": "/mnt/data", - "fileServerPublicIP": "13.90.141.66", - "fileServerInternalIP": "10.0.0.4", - "fileServerType": "nfs" - } - } - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/ListFileServerByResourceGroup.json b/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/ListFileServerByResourceGroup.json deleted file mode 100644 index 3bb1b0eeaacd..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/ListFileServerByResourceGroup.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/fileservers/fileservercedd134b", - "name": "fileservercedd134b", - "type": "Microsoft.BatchAI/FileServers", - "location": "eastus", - "properties": { - "provisioningState": "succeeded", - "creationTime": "2017-09-27T21:45:28.159Z", - "provisioningStateTransitionTime": "2017-09-27T21:49:25.416Z", - "vmSize": "STANDARD_NC6", - "sshConfiguration": { - "userAccountSettings": { - "adminUserName": "admin_user_name" - } - }, - "dataDisks": { - "diskSizeInGB": 10, - "cachingType": "none", - "diskCount": 2, - "storageAccountType": "Standard_LRS" - }, - "subnet": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.Network/virtualNetworks/7feb1976-8c31-4f1f-bea2-86cb1839a7bavnet/subnets/Subnet-1" - }, - "mountSettings": { - "mountPoint": "/mnt/data", - "fileServerPublicIP": "13.90.141.66", - "fileServerInternalIP": "10.0.0.4", - "fileServerType": "nfs" - } - } - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/ListJob.json b/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/ListJob.json deleted file mode 100644 index 576cf681e890..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/ListJob.json +++ /dev/null @@ -1,62 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/jobs/job", - "name": "job", - "type": "Microsoft.BatchAI/Jobs", - "properties": { - "priority": 0, - "cluster": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/clusters/demo_cluster" - }, - "nodeCount": 1, - "containerSettings": { - "imageSourceRegistry": { - "image": "ubuntu" - } - }, - "toolType": "custom", - "customToolkitSettings": { - "commandLine": "echo hi | tee $AZ_BATCHAI_OUTPUT_OUTPUTS/hi.txt" - }, - "stdOutErrPathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles", - "inputDirectories": [ - { - "id": "INPUT", - "path": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/input" - } - ], - "outputDirectories": [ - { - "id": "OUTPUTS", - "pathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/", - "pathSuffix": "files", - "type": "custom", - "createNew": true - } - ], - "constraints": { - "maxWallClockTime": "P7D" - }, - "creationTime": "2017-09-27T23:36:52.611Z", - "provisioningState": "succeeded", - "provisioningStateTransitionTime": "2017-09-27T23:36:53.701Z", - "executionState": "running", - "executionStateTransitionTime": "2017-09-27T23:36:56.395Z", - "executionInfo": { - "startTime": "2017-09-27T23:36:54.115Z" - } - } - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/ListJobByResourceGroup.json b/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/ListJobByResourceGroup.json deleted file mode 100644 index 3d2512013ac2..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/ListJobByResourceGroup.json +++ /dev/null @@ -1,63 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/jobs/job", - "name": "job", - "type": "Microsoft.BatchAI/Jobs", - "properties": { - "priority": 0, - "cluster": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/clusters/demo_cluster" - }, - "nodeCount": 1, - "containerSettings": { - "imageSourceRegistry": { - "image": "ubuntu" - } - }, - "toolType": "custom", - "customToolkitSettings": { - "commandLine": "echo hi | tee $AZ_BATCHAI_OUTPUT_OUTPUTS/hi.txt" - }, - "stdOutErrPathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles", - "inputDirectories": [ - { - "id": "INPUT", - "path": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/input" - } - ], - "outputDirectories": [ - { - "id": "OUTPUTS", - "pathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/", - "pathSuffix": "files", - "type": "custom", - "createNew": true - } - ], - "constraints": { - "maxWallClockTime": "P7D" - }, - "creationTime": "2017-09-27T23:36:52.611Z", - "provisioningState": "succeeded", - "provisioningStateTransitionTime": "2017-09-27T23:36:53.701Z", - "executionState": "running", - "executionStateTransitionTime": "2017-09-27T23:36:56.395Z", - "executionInfo": { - "startTime": "2017-09-27T23:36:54.115Z" - } - } - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/ListOutputFiles.json b/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/ListOutputFiles.json deleted file mode 100644 index b148c06a9384..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/ListOutputFiles.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "jobName": "demo_job", - "outputdirectoryid": "stdouterr", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "stderr-job_prep.txt", - "downloadUrl": "https://storage_account_name.file.core.windows.net/share/00000000-0000-0000-0000-000000000000/test_mgmt_batchai_jobs_test_job_preparation_hoste0e613b6/jobs/job/host_prep_stderr.txt?sv=2016-05-31&sr=f&sig=CNPJmjDQT9Anld9%2FdnQ52ZBpfOff2el8r4el6J%2BnpJE%3D&se=2017-09-28T01%3A22%3A35Z&sp=rl", - "properties": { - "lastModified": "2017-09-28T00:22:19Z", - "contentLength": 0 - } - }, - { - "name": "stdout-job_prep.txt", - "downloadUrl": "https://storage_account_name.file.core.windows.net/share/00000000-0000-0000-0000-000000000000/test_mgmt_batchai_jobs_test_job_preparation_hoste0e613b6/jobs/job/host_prep_stdout.txt?sv=2016-05-31&sr=f&sig=yK%2F5acWSTdcmBZGGL9%2F3IqeZ7N%2B1sRXfwB%2FaCkoRS%2Bc%3D&se=2017-09-28T01%3A22%3A35Z&sp=rl", - "properties": { - "lastModified": "2017-09-28T00:22:19Z", - "contentLength": 720 - } - }, - { - "name": "stderr.txt", - "downloadUrl": "https://storage_account_name.file.core.windows.net/share/00000000-0000-0000-0000-000000000000/test_mgmt_batchai_jobs_test_job_preparation_hoste0e613b6/jobs/job/stderr.txt?sv=2016-05-31&sr=f&sig=TdvHhdQjvWWA0Z7aPb0oZpPgGbBPOyDarNXWHFnRS3c%3D&se=2017-09-28T01%3A22%3A35Z&sp=rl", - "properties": { - "lastModified": "2017-09-28T00:22:19Z", - "contentLength": 0 - } - }, - { - "name": "stdout.txt", - "downloadUrl": "https://storage_account_name.file.core.windows.net/share/00000000-0000-0000-0000-000000000000/test_mgmt_batchai_jobs_test_job_preparation_hoste0e613b6/jobs/job/stdout.txt?sv=2016-05-31&sr=f&sig=nyydEjNnYpQfovknJc%2B5G%2F05g0IV4acWKlfkM35lh00%3D&se=2017-09-28T01%3A22%3A35Z&sp=rl", - "properties": { - "lastModified": "2017-09-28T00:22:19Z", - "contentLength": 32 - } - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/OperationList.json b/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/OperationList.json deleted file mode 100644 index 1001d46cb40e..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/OperationList.json +++ /dev/null @@ -1,133 +0,0 @@ -{ - "parameters": { - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Microsoft.BatchAI/clusters/read", - "display": { - "provider": "Microsoft Batch AI", - "resource": "Batch AI Clusters", - "operation": "List or get Batch AI clusters", - "description": "Lists Batch AI clusters or gets the properties of a Batch AI cluster" - }, - "origin": "user,system" - }, - { - "name": "Microsoft.BatchAI/clusters/write", - "display": { - "provider": "Microsoft Batch AI", - "resource": "Batch AI Clusters", - "operation": "Create or update Batch AI cluster", - "description": "Creates a new Batch AI cluster or updates an existing Batch AI cluster" - }, - "origin": "user,system" - }, - { - "name": "Microsoft.BatchAI/clusters/delete", - "display": { - "provider": "Microsoft Batch AI", - "resource": "Batch AI Clusters", - "operation": "Delete Batch AI cluster", - "description": "Deletes a Batch AI cluster" - }, - "origin": "user,system" - }, - { - "name": "Microsoft.BatchAI/clusters/listRemoteLoginInformation", - "display": { - "provider": "Microsoft Batch AI", - "resource": "Batch AI Clusters", - "operation": "List Batch AI cluster remote-login information", - "description": "Lists remote-login information for a Batch AI cluster" - }, - "origin": "user,system" - }, - { - "name": "Microsoft.BatchAI/jobs/read", - "display": { - "provider": "Microsoft Batch AI", - "resource": "Batch AI Jobs", - "operation": "List or get Batch AI jobs", - "description": "Lists Batch AI jobs or gets the properties of a Batch AI job" - }, - "origin": "user,system" - }, - { - "name": "Microsoft.BatchAI/jobs/write", - "display": { - "provider": "Microsoft Batch AI", - "resource": "Batch AI Jobs", - "operation": "Create or update Batch AI job", - "description": "Creates a new Batch AI job or updates an existing Batch AI job" - }, - "origin": "user,system" - }, - { - "name": "Microsoft.BatchAI/jobs/delete", - "display": { - "provider": "Microsoft Batch AI", - "resource": "Batch AI Jobs", - "operation": "Delete Batch AI job", - "description": "Deletes a Batch AI job" - }, - "origin": "user,system" - }, - { - "name": "Microsoft.BatchAI/jobs/terminate/action", - "display": { - "provider": "Microsoft Batch AI", - "resource": "Batch AI Jobs", - "operation": "Terminate Batch AI job", - "description": "Terminates a Batch AI job" - }, - "origin": "user,system" - }, - { - "name": "Microsoft.BatchAI/jobs/listRemoteLoginInformation", - "display": { - "provider": "Microsoft Batch AI", - "resource": "Batch AI Jobs", - "operation": "List Batch AI job remote-login information", - "description": "Lists remote-login information for a Batch AI job" - }, - "origin": "user,system" - }, - { - "name": "Microsoft.BatchAI/fileservers/read", - "display": { - "provider": "Microsoft Batch AI", - "resource": "Batch AI Fileservers", - "operation": "List or get Batch AI fileservers", - "description": "Lists Batch AI fileservers or gets the properties of a Batch AI fileserver" - }, - "origin": "user,system" - }, - { - "name": "Microsoft.BatchAI/fileservers/write", - "display": { - "provider": "Microsoft Batch AI", - "resource": "Batch AI Fileservers", - "operation": "Create or update Batch AI fileserver", - "description": "Creates a new Batch AI fileserver or updates an existing Batch AI fileserver" - }, - "origin": "user,system" - }, - { - "name": "Microsoft.BatchAI/fileservers/delete", - "display": { - "provider": "Microsoft Batch AI", - "resource": "Batch AI Fileservers", - "operation": "Delete Batch AI filserver", - "description": "Deletes a Batch AI fileserver" - }, - "origin": "user,system" - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/PatchCluster.json b/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/PatchCluster.json deleted file mode 100644 index acbc2cb36334..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/PatchCluster.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "clusterName": "demo_cluster", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2017-09-01-preview", - "parameters": { - "properties": { - "scaleSettings": { - "autoScale": { - "minimumNodeCount": 0, - "maximumNodeCount": 10 - } - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/clusters/demo_cluster", - "name": "demo_cluster", - "type": "Microsoft.BatchAI/Clusters", - "location": "eastus", - "properties": { - "provisioningState": "succeeded", - "allocationState": "steady", - "creationTime": "2017-09-27T21:43:55.215Z", - "allocationStateTransitionTime": "2017-09-27T21:43:57.664Z", - "provisioningStateTransitionTime": "2017-09-27T21:43:56.238Z", - "vmSize": "STANDARD_NC6", - "currentNodeCount": 0, - "nodeStateCounts": { - "runningNodeCount": 0, - "idleNodeCount": 0, - "unusableNodeCount": 0, - "preparingNodeCount": 0, - "leavingNodeCount": 0 - }, - "vmPriority": "dedicated", - "scaleSettings": { - "autoScale": { - "minimumNodeCount": 0, - "maximumNodeCount": 10, - "initialNodeCount": 0 - } - }, - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "UbuntuServer", - "sku": "16.04-LTS", - "version": "latest" - } - }, - "userAccountSettings": { - "adminUserName": "admin_user_name" - }, - "nodeSetup": { - "mountVolumes": { - "azureFileShares": [ - { - "accountName": "storage_account_name", - "azureFileUrl": "https://storage_account_name.file.core.windows.net/azure_file_share_name", - "credentials": {}, - "relativeMountPath": "azfiles", - "fileMode": "0777", - "directoryMode": "0777" - } - ] - } - } - } - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/PutCluster.json b/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/PutCluster.json deleted file mode 100644 index 6a4891c9c857..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/PutCluster.json +++ /dev/null @@ -1,127 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "clusterName": "demo_cluster", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2017-09-01-preview", - "parameters": { - "location": "eastus", - "properties": { - "scaleSettings": { - "manual": { - "nodeDeallocationOption": "requeue", - "targetNodeCount": 1 - } - }, - "userAccountSettings": { - "adminUserPassword": "admin_user_password", - "adminUserSshPublicKey": "ssh-rsa AAAAB3NzaC1yc...", - "adminUserName": "admin_user_name" - }, - "nodeSetup": { - "mountVolumes": { - "fileServers": [ - { - "fileServer": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/fileservers/fileservercedd134b" - }, - "mountOptions": "rw", - "relativeMountPath": "nfs" - } - ], - "azureFileShares": [ - { - "relativeMountPath": "azfiles", - "directoryMode": "0777", - "accountName": "storage_account_name", - "azureFileUrl": "https://storage_account_name.file.core.windows.net/azure_file_share_name", - "fileMode": "0777", - "credentials": { - "accountKey": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000==" - } - } - ] - } - }, - "vmPriority": "dedicated", - "vmSize": "STANDARD_NC6" - } - } - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2017-09-01-preview", - "Retry-After": 15 - } - }, - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/clusters/demo_cluster", - "name": "demo_cluster", - "type": "Microsoft.BatchAI/Clusters", - "location": "eastus", - "properties": { - "provisioningState": "succeeded", - "allocationState": "resizing", - "creationTime": "2017-09-27T21:50:02.377Z", - "allocationStateTransitionTime": "2017-09-27T21:50:04.521Z", - "provisioningStateTransitionTime": "2017-09-27T21:50:03.828Z", - "vmSize": "STANDARD_NC6", - "currentNodeCount": 0, - "nodeStateCounts": { - "runningNodeCount": 0, - "idleNodeCount": 0, - "unusableNodeCount": 0, - "preparingNodeCount": 0, - "leavingNodeCount": 0 - }, - "vmPriority": "dedicated", - "scaleSettings": { - "manual": { - "targetNodeCount": 1, - "nodeDeallocationOption": "requeue" - } - }, - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "UbuntuServer", - "sku": "16.04-LTS", - "version": "latest" - } - }, - "userAccountSettings": { - "adminUserName": "admin_user_name" - }, - "nodeSetup": { - "mountVolumes": { - "azureFileShares": [ - { - "accountName": "storage_account_name", - "azureFileUrl": "https://storage_account_name.file.core.windows.net/azure_file_share_name", - "credentials": {}, - "relativeMountPath": "azfiles", - "fileMode": "0777", - "directoryMode": "0777" - } - ], - "fileServers": [ - { - "fileServer": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/fileservers/fileservercedd134b" - }, - "relativeMountPath": "nfs", - "mountOptions": "rw" - } - ] - } - }, - "subnet": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.Network/virtualNetworks/7feb1976-8c31-4f1f-bea2-86cb1839a7bavnet/subnets/Subnet-1" - } - } - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/PutFileServer.json b/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/PutFileServer.json deleted file mode 100644 index f511bcdaa541..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/PutFileServer.json +++ /dev/null @@ -1,67 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "fileServerName": "demo_nfs", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2017-09-01-preview", - "parameters": { - "location": "eastus", - "properties": { - "sshConfiguration": { - "userAccountSettings": { - "adminUserPassword": "admin_user_password", - "adminUserName": "admin_user_name" - } - }, - "dataDisks": { - "diskSizeInGB": 10, - "storageAccountType": "Standard_LRS", - "diskCount": 2 - }, - "vmSize": "STANDARD_NC6" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/fileservers/fileservercedd134b", - "name": "demo_nfs", - "type": "Microsoft.BatchAI/FileServers", - "location": "eastus", - "properties": { - "provisioningState": "succeeded", - "creationTime": "2017-09-27T21:45:28.159Z", - "provisioningStateTransitionTime": "2017-09-27T21:49:25.416Z", - "vmSize": "STANDARD_NC6", - "sshConfiguration": { - "userAccountSettings": { - "adminUserName": "admin_user_name" - } - }, - "dataDisks": { - "diskSizeInGB": 10, - "cachingType": "none", - "diskCount": 2, - "storageAccountType": "Standard_LRS" - }, - "subnet": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.Network/virtualNetworks/7feb1976-8c31-4f1f-bea2-86cb1839a7bavnet/subnets/Subnet-1" - }, - "mountSettings": { - "mountPoint": "/mnt/data", - "fileServerPublicIP": "13.90.141.66", - "fileServerInternalIP": "10.0.0.4", - "fileServerType": "nfs" - } - } - } - }, - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2017-09-01-preview", - "Retry-After": 15 - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/PutJob.json b/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/PutJob.json deleted file mode 100644 index a3f42a1bb8c0..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/PutJob.json +++ /dev/null @@ -1,100 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "jobName": "demo_job", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2017-09-01-preview", - "parameters": { - "location": "eastus", - "properties": { - "stdOutErrPathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles", - "cluster": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/clusters/demo_cluster" - }, - "nodeCount": 1, - "customToolkitSettings": { - "commandLine": "echo hi | tee $AZ_BATCHAI_OUTPUT_OUTPUTS/hi.txt" - }, - "inputDirectories": [ - { - "id": "INPUT", - "path": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/input" - } - ], - "priority": 0, - "containerSettings": { - "imageSourceRegistry": { - "image": "ubuntu" - } - }, - "outputDirectories": [ - { - "pathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/", - "type": "custom", - "id": "OUTPUTS", - "pathSuffix": "files", - "createNew": true - } - ] - } - } - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2017-09-01-preview", - "Retry-After": 15 - } - }, - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/jobs/demo_job", - "name": "demo_job", - "type": "Microsoft.BatchAI/Job", - "properties": { - "priority": 0, - "cluster": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/clusters/demo_cluster" - }, - "nodeCount": 1, - "containerSettings": { - "imageSourceRegistry": { - "image": "ubuntu" - } - }, - "toolType": "custom", - "customToolkitSettings": { - "commandLine": "echo hi | tee $AZ_BATCHAI_OUTPUT_OUTPUTS/hi.txt" - }, - "stdOutErrPathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles", - "inputDirectories": [ - { - "id": "INPUT", - "path": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/input" - } - ], - "outputDirectories": [ - { - "id": "OUTPUTS", - "pathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/", - "pathSuffix": "files", - "type": "custom", - "createNew": true - } - ], - "constraints": { - "maxWallClockTime": "P7D" - }, - "creationTime": "2017-09-27T23:36:52.611Z", - "provisioningState": "succeeded", - "provisioningStateTransitionTime": "2017-09-27T23:36:53.701Z", - "executionState": "running", - "executionStateTransitionTime": "2017-09-27T23:36:56.395Z", - "executionInfo": { - "startTime": "2017-09-27T23:36:54.115Z" - } - } - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/TerminateJob.json b/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/TerminateJob.json deleted file mode 100644 index a68455be43a5..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/examples/TerminateJob.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "jobName": "demo_job", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2017-09-01-preview" - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2017-09-01-preview", - "Retry-After": 15 - } - }, - "200": {} - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/BatchAI.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/BatchAI.json deleted file mode 100644 index 3d43131b4147..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/BatchAI.json +++ /dev/null @@ -1,3267 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "BatchAI", - "description": "The Azure BatchAI Management API.", - "version": "2018-03-01", - "x-ms-code-generation-settings": { - "name": "BatchAIManagementClient" - } - }, - "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.BatchAI/operations": { - "get": { - "tags": [ - "Operations" - ], - "operationId": "Operations_List", - "description": "Lists available operations for the Microsoft.BatchAI provider.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List of available operations for Batch AI Resource Provider": { - "$ref": "./examples/OperationList.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.BatchAI/locations/{location}/usages": { - "get": { - "tags": [ - "Usage" - ], - "operationId": "Usage_List", - "description": "Gets the current usage information as well as limits for Batch AI resources for given subscription.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The location for which resource usage is queried.", - "pattern": "^[-\\w\\._]+$" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ListUsagesResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Create or update cluster": { - "$ref": "./examples/ListUsages.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/clusters/{clusterName}": { - "put": { - "tags": [ - "Cluster" - ], - "operationId": "Clusters_Create", - "description": "Adds a cluster. A cluster is a collection of compute nodes. Multiple jobs can be run on the same cluster.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterCreateParameters" - }, - "description": "The parameters to provide for cluster creation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains the cluster entity.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "202": { - "description": "The operation will be completed asynchronously." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Create or update cluster": { - "$ref": "./examples/PutCluster.json" - } - } - }, - "patch": { - "tags": [ - "Cluster" - ], - "operationId": "Clusters_Update", - "description": "Update the properties of a given cluster.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterUpdateParameters" - }, - "description": "Additional parameters for cluster update." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains the Cluster entity.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-examples": { - "Patch cluster": { - "$ref": "./examples/PatchCluster.json" - } - } - }, - "delete": { - "tags": [ - "Cluster" - ], - "operationId": "Clusters_Delete", - "description": "Deletes a Cluster.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful." - }, - "202": { - "description": "The operation will be completed asynchronously." - }, - "204": { - "description": "No content." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Delete cluster": { - "$ref": "./examples/DeleteCluster.json" - } - } - }, - "get": { - "tags": [ - "Cluster" - ], - "operationId": "Clusters_Get", - "description": "Gets information about the specified Cluster.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains information about the cluster.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-examples": { - "Get cluster": { - "$ref": "./examples/GetCluster.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/clusters/{clusterName}/listRemoteLoginInformation": { - "post": { - "tags": [ - "Cluster" - ], - "operationId": "Clusters_ListRemoteLoginInformation", - "description": "Get the IP address, port of all the compute nodes in the cluster.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains the list of IP addresses.", - "schema": { - "$ref": "#/definitions/RemoteLoginInformationListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Get a cluster's remote-login-information": { - "$ref": "./examples/ClusterListRemoteLoginInfo.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.BatchAI/clusters": { - "get": { - "tags": [ - "Cluster" - ], - "operationId": "Clusters_List", - "description": "Gets information about the Clusters associated with the subscription.", - "parameters": [ - { - "$ref": "#/parameters/FilterParameter" - }, - { - "$ref": "#/parameters/SelectParameter" - }, - { - "$ref": "#/parameters/MaxResultsParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains a list of Cluster entities associated with the subscription.", - "schema": { - "$ref": "#/definitions/ClusterListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List clusters": { - "$ref": "./examples/ListCluster.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/clusters": { - "get": { - "tags": [ - "Cluster" - ], - "operationId": "Clusters_ListByResourceGroup", - "description": "Gets information about the Clusters associated within the specified resource group.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/FilterParameter" - }, - { - "$ref": "#/parameters/SelectParameter" - }, - { - "$ref": "#/parameters/MaxResultsParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains a list of Cluster entities associated with the resource group.", - "schema": { - "$ref": "#/definitions/ClusterListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List clusters": { - "$ref": "./examples/ListClusterByResourceGroup.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/jobs/{jobName}": { - "put": { - "tags": [ - "Job" - ], - "operationId": "Jobs_Create", - "description": "Adds a Job that gets executed on a cluster.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/JobNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/JobCreateParameters" - }, - "description": "The parameters to provide for job creation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains the job entity.", - "schema": { - "$ref": "#/definitions/Job" - } - }, - "202": { - "description": "The operation will be completed asynchronously." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Create or update job": { - "$ref": "./examples/PutJob.json" - } - } - }, - "delete": { - "tags": [ - "Job" - ], - "operationId": "Jobs_Delete", - "description": "Deletes the specified Batch AI job.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/JobNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful." - }, - "202": { - "description": "The operation will be completed asynchronously." - }, - "204": { - "description": "No content." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Delete job": { - "$ref": "./examples/DeleteJob.json" - } - } - }, - "get": { - "tags": [ - "Job" - ], - "operationId": "Jobs_Get", - "description": "Gets information about the specified Batch AI job.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/JobNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains the Batch AI job entity.", - "schema": { - "$ref": "#/definitions/Job" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-examples": { - "Get job": { - "$ref": "./examples/GetJob.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/jobs/{jobName}/listRemoteLoginInformation": { - "post": { - "tags": [ - "Job" - ], - "operationId": "Jobs_ListRemoteLoginInformation", - "description": "Gets the IP address and port information of all the compute nodes which are used for job execution.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/JobNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains compute node remote login information.", - "schema": { - "$ref": "#/definitions/RemoteLoginInformationListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Get a job's remote-login-information ": { - "$ref": "./examples/JobListRemoteLoginInfo.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/jobs/{jobName}/terminate": { - "post": { - "tags": [ - "Job" - ], - "operationId": "Jobs_Terminate", - "description": "Terminates a job.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/JobNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful." - }, - "202": { - "description": "The operation will be completed asynchronously." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Terminate job": { - "$ref": "./examples/TerminateJob.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.BatchAI/jobs": { - "get": { - "tags": [ - "Job" - ], - "operationId": "Jobs_List", - "description": "Gets information about the jobs associated with the subscription.", - "parameters": [ - { - "$ref": "#/parameters/FilterParameter" - }, - { - "$ref": "#/parameters/SelectParameter" - }, - { - "$ref": "#/parameters/MaxResultsParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains a list of Batch AI job entities associated with the subscription.", - "schema": { - "$ref": "#/definitions/JobListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List jobs": { - "$ref": "./examples/ListJob.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/jobs": { - "get": { - "tags": [ - "Job" - ], - "operationId": "Jobs_ListByResourceGroup", - "description": "Gets information about the Batch AI jobs associated within the specified resource group.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/FilterParameter" - }, - { - "$ref": "#/parameters/SelectParameter" - }, - { - "$ref": "#/parameters/MaxResultsParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains a list of Job entities associated with the resource group.", - "schema": { - "$ref": "#/definitions/JobListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List jobs": { - "$ref": "./examples/ListJobByResourceGroup.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/jobs/{jobName}/listOutputFiles": { - "post": { - "tags": [ - "Job" - ], - "operationId": "Jobs_ListOutputFiles", - "description": "List all directories and files inside the given directory of the output directory (Only if the output directory is on Azure File Share or Azure Storage container).", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/JobNameParameter" - }, - { - "$ref": "#/parameters/OutputDirectoryIdParameter" - }, - { - "$ref": "#/parameters/Directory" - }, - { - "$ref": "#/parameters/DownloadLinkExpiryParameter" - }, - { - "$ref": "#/parameters/MaxResultsParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains the list of job files.", - "schema": { - "$ref": "#/definitions/FileListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List a job's files": { - "$ref": "./examples/ListOutputFiles.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/fileServers/{fileServerName}": { - "put": { - "tags": [ - "FileServer" - ], - "operationId": "FileServers_Create", - "description": "Creates a file server.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/FileServerNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/FileServerCreateParameters" - }, - "description": "The parameters to provide for file server creation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains the file server entity.", - "schema": { - "$ref": "#/definitions/FileServer" - } - }, - "202": { - "description": "The operation will be completed asynchronously." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Create or update file server": { - "$ref": "./examples/PutFileServer.json" - } - } - }, - "delete": { - "tags": [ - "FileServer" - ], - "operationId": "FileServers_Delete", - "description": "Delete a file Server.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/FileServerNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful." - }, - "202": { - "description": "The operation will be completed asynchronously." - }, - "204": { - "description": "No content." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Delete file server": { - "$ref": "./examples/DeleteFileServer.json" - } - } - }, - "get": { - "tags": [ - "FileServer" - ], - "operationId": "FileServers_Get", - "description": "Gets information about the specified Cluster.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/FileServerNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains information about the FileServer.", - "schema": { - "$ref": "#/definitions/FileServer" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-examples": { - "Get file server": { - "$ref": "./examples/GetFileServer.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.BatchAI/fileServers": { - "get": { - "tags": [ - "FileServer" - ], - "operationId": "FileServers_List", - "description": "To list all the file servers available under the given subscription (and across all resource groups within that subscription)", - "parameters": [ - { - "$ref": "#/parameters/FilterParameter" - }, - { - "$ref": "#/parameters/SelectParameter" - }, - { - "$ref": "#/parameters/MaxResultsParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains a formatted list of clusters and their properties.", - "schema": { - "$ref": "#/definitions/FileServerListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List file servers": { - "$ref": "./examples/ListFileServer.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/fileServers": { - "get": { - "tags": [ - "FileServer" - ], - "operationId": "FileServers_ListByResourceGroup", - "description": "Gets a formatted list of file servers and their properties associated within the specified resource group.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/FilterParameter" - }, - { - "$ref": "#/parameters/SelectParameter" - }, - { - "$ref": "#/parameters/MaxResultsParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains a list of formatted file servers and their properties associated with the resource group.", - "schema": { - "$ref": "#/definitions/FileServerListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List file servers": { - "$ref": "./examples/ListFileServerByResourceGroup.json" - } - } - } - } - }, - "definitions": { - "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 Batch AI Resource Usage." - }, - "ListUsagesResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Usage" - }, - "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." - }, - "FileServerBaseProperties": { - "properties": { - "vmSize": { - "type": "string", - "title": "The size of the virtual machine of the file server.", - "description": "For information about available VM sizes for fileservers from the Virtual Machines Marketplace, see Sizes for Virtual Machines (Linux)." - }, - "sshConfiguration": { - "title": "SSH configuration for the file server.", - "$ref": "#/definitions/SshConfiguration" - }, - "dataDisks": { - "title": "Settings for the data disk which would be created for the file server.", - "$ref": "#/definitions/DataDisks" - }, - "subnet": { - "title": "Specifies the identifier of the subnet.", - "$ref": "#/definitions/ResourceId" - } - }, - "required": [ - "vmSize", - "sshConfiguration", - "dataDisks" - ], - "description": "The properties of a file server." - }, - "FileServerListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/FileServer" - }, - "description": "The collection of File Servers." - }, - "nextLink": { - "type": "string", - "description": "The continuation token." - } - }, - "description": "Values returned by the List operation." - }, - "DataDisks": { - "properties": { - "diskSizeInGB": { - "type": "integer", - "format": "int32", - "readOnly": false, - "title": "Initial disk size in GB for blank data disks, and the new desired size for resizing existing data disks." - }, - "cachingType": { - "type": "string", - "title": "None, ReadOnly, ReadWrite. Default value is None. This property is not patchable.", - "default": "none", - "enum": [ - "none", - "readonly", - "readwrite" - ], - "x-ms-enum": { - "name": "CachingType", - "modelAsString": false - } - }, - "diskCount": { - "type": "integer", - "format": "int32", - "readOnly": false, - "title": "Number of data disks to be attached to the VM. RAID level 0 will be applied in the case of multiple disks." - }, - "storageAccountType": { - "type": "string", - "readOnly": false, - "title": "Specifies the type of storage account to be used on the disk. Possible values are: Standard_LRS or Premium_LRS.", - "enum": [ - "Standard_LRS", - "Premium_LRS" - ], - "x-ms-enum": { - "name": "StorageAccountType", - "modelAsString": true - } - } - }, - "required": [ - "diskSizeInGB", - "diskCount", - "storageAccountType" - ], - "description": "Settings for the data disk which would be created for the File Server." - }, - "KeyVaultSecretReference": { - "properties": { - "sourceVault": { - "title": "Fully qualified resource Id for the Key Vault.", - "$ref": "#/definitions/ResourceId" - }, - "secretUrl": { - "type": "string", - "title": "The URL referencing a secret in a Key Vault." - } - }, - "required": [ - "sourceVault", - "secretUrl" - ], - "description": "Describes a reference to Key Vault Secret." - }, - "KeyVaultKeyReference": { - "properties": { - "sourceVault": { - "title": "Fully qualified resource Id for the Key Vault.", - "$ref": "#/definitions/ResourceId" - }, - "keyUrl": { - "type": "string", - "title": "The URL referencing a key in a Key Vault." - } - }, - "required": [ - "sourceVault", - "keyUrl" - ], - "description": "Describes a reference to Key Vault Key." - }, - "MountSettings": { - "properties": { - "mountPoint": { - "type": "string", - "title": "Path where the NFS is mounted on the Server." - }, - "fileServerPublicIP": { - "type": "string", - "title": "Public IP of the File Server VM." - }, - "fileServerInternalIP": { - "type": "string", - "title": "Internal subnet IP which can be used to access the file Server from within the subnet." - }, - "fileServerType": { - "type": "string", - "title": "Type of the fileserver e.g. nfs, glusterfs etc.", - "enum": [ - "nfs", - "glusterfs" - ], - "x-ms-enum": { - "name": "FileServerType", - "modelAsString": true - } - } - }, - "description": "Details of the File Server." - }, - "SshConfiguration": { - "properties": { - "publicIPsToAllow": { - "type": "array", - "items": { - "type": "string" - }, - "title": "List of source IP ranges to allow SSH connection to a node.", - "description": "Default value is '*' can be used to match all source IPs. Maximum number of IP ranges that can be specified are 400." - }, - "userAccountSettings": { - "title": "Settings for user account to be created on a node.", - "$ref": "#/definitions/UserAccountSettings" - } - }, - "required": [ - "userAccountSettings" - ], - "description": "SSH configuration settings for the VM" - }, - "FileServerCreateParameters": { - "properties": { - "location": { - "type": "string", - "description": "The region in which to create the File Server." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "The user specified tags associated with the File Server." - }, - "properties": { - "$ref": "#/definitions/FileServerBaseProperties", - "description": "The properties of the File Server.", - "x-ms-client-flatten": true - } - }, - "required": [ - "location" - ], - "description": "Parameters supplied to the Create operation." - }, - "FileServerProperties": { - "properties": { - "vmSize": { - "type": "string", - "title": "The size of the virtual machine of the File Server.", - "description": "For information about available VM sizes for File Server from the Virtual Machines Marketplace, see Sizes for Virtual Machines (Linux)." - }, - "sshConfiguration": { - "title": "SSH settings for the File Server.", - "$ref": "#/definitions/SshConfiguration" - }, - "dataDisks": { - "title": "Settings for the data disk which would be created for the File Server.", - "$ref": "#/definitions/DataDisks" - }, - "subnet": { - "title": "Specifies the identifier of the subnet.", - "$ref": "#/definitions/ResourceId" - }, - "mountSettings": { - "title": "Details of the File Server.", - "readOnly": true, - "$ref": "#/definitions/MountSettings" - }, - "provisioningStateTransitionTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "title": "Time when the status was changed." - }, - "creationTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "title": "Time when the FileServer was created." - }, - "provisioningState": { - "type": "string", - "readOnly": true, - "x-nullable": false, - "title": "Specifies the provisioning state of the File Server.", - "description": "Possible values: creating - The File Server is getting created. updating - The File Server creation has been accepted and it is getting updated. deleting - The user has requested that the File Server be deleted, and it is in the process of being deleted. failed - The File Server creation has failed with the specified errorCode. Details about the error code are specified in the message field. succeeded - The File Server creation has succeeded.", - "enum": [ - "creating", - "updating", - "deleting", - "succeeded", - "failed" - ], - "x-ms-enum": { - "name": "FileServerProvisioningState", - "modelAsString": false - } - } - }, - "description": "File server specific properties." - }, - "FileServer": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/FileServerProperties", - "description": "The properties associated with the File Server." - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Contains information about the File Server." - }, - "ClusterBaseProperties": { - "properties": { - "vmSize": { - "type": "string", - "title": "The size of the virtual machines in the cluster.", - "description": "All virtual machines in a cluster are the same size. For information about available VM sizes for clusters using images from the Virtual Machines Marketplace (see Sizes for Virtual Machines (Linux) or Sizes for Virtual Machines (Windows). Batch AI service supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)." - }, - "vmPriority": { - "type": "string", - "title": "dedicated or lowpriority.", - "description": "Default is dedicated.", - "default": "dedicated", - "enum": [ - "dedicated", - "lowpriority" - ], - "x-ms-enum": { - "name": "VmPriority", - "modelAsString": false - } - }, - "scaleSettings": { - "$ref": "#/definitions/ScaleSettings", - "title": "Desired scale for the cluster." - }, - "virtualMachineConfiguration": { - "title": "Settings for OS image and mounted data volumes.", - "$ref": "#/definitions/VirtualMachineConfiguration" - }, - "nodeSetup": { - "title": "Setup to be done on all compute nodes in the cluster.", - "$ref": "#/definitions/NodeSetup" - }, - "userAccountSettings": { - "title": "Settings for user account that will be created on all compute nodes of the cluster.", - "$ref": "#/definitions/UserAccountSettings" - }, - "subnet": { - "title": "Specifies the identifier of the subnet. ", - "$ref": "#/definitions/ResourceId" - } - }, - "required": [ - "vmSize", - "userAccountSettings" - ], - "description": "The properties of a Cluster." - }, - "ClusterUpdateProperties": { - "properties": { - "scaleSettings": { - "$ref": "#/definitions/ScaleSettings", - "title": "Desired scale for the cluster" - } - }, - "description": "The properties of a Cluster that need to be updated." - }, - "DeallocationOption": { - "type": "string", - "title": "Specifies when compute nodes may be removed from the cluster, if the cluster size is decreasing.", - "description": "Possible values are: requeue - Terminate running jobs and requeue them. The jobs will run again. Remove compute nodes as soon as jobs have been terminated. terminate - Terminate running jobs. The jobs will not run again. Remove compute nodes as soon as jobs have been terminated. jobcompletion - Allow currently running jobs to complete. Schedule no new jobs while waiting. Remove compute nodes when all jobs have completed. The default value is requeue.", - "default": "requeue", - "enum": [ - "requeue", - "terminate", - "waitforjobcompletion", - "unknown" - ], - "x-ms-enum": { - "name": "DeallocationOption", - "modelAsString": false - } - }, - "ScaleSettings": { - "properties": { - "manual": { - "$ref": "#/definitions/ManualScaleSettings", - "title": "The scale for the cluster by manual settings" - }, - "autoScale": { - "$ref": "#/definitions/AutoScaleSettings", - "title": "The scale for the cluster by autoscale settings" - } - }, - "description": "At least one of manual or autoScale settings must be specified. Only one of manual or autoScale settings can be specified. If autoScale settings are specified, the system automatically scales the cluster up and down (within the supplied limits) based on the pending jobs on the cluster." - }, - "AutoScaleSettings": { - "properties": { - "minimumNodeCount": { - "type": "integer", - "format": "int32", - "title": "Specifies the minimum number of compute nodes the cluster can have." - }, - "maximumNodeCount": { - "type": "integer", - "format": "int32", - "title": "Specifies the maximum number of compute nodes the cluster can have." - }, - "initialNodeCount": { - "type": "integer", - "format": "int32", - "title": "Specifies the number of compute nodes to allocate on cluster creation. Note that this value is used only during cluster creation.", - "default": 0 - } - }, - "required": [ - "minimumNodeCount", - "maximumNodeCount" - ], - "description": "The system automatically scales the cluster up and down (within minimumNodeCount and maximumNodeCount) based on the pending and running jobs on the cluster." - }, - "ManualScaleSettings": { - "properties": { - "targetNodeCount": { - "type": "integer", - "format": "int32", - "title": "The desired number of compute nodes in the Cluster.", - "default": 0, - "description": "Default is 0. If autoScaleSettings are not specified, then the Cluster starts with this target." - }, - "nodeDeallocationOption": { - "title": "Determines what to do with the job(s) running on compute node if the Cluster size is decreasing.", - "description": "The default value is requeue.", - "default": "requeue", - "$ref": "#/definitions/DeallocationOption" - } - }, - "required": [ - "targetNodeCount" - ], - "description": "Manual scale settings for the cluster." - }, - "VirtualMachineConfiguration": { - "properties": { - "imageReference": { - "title": "Reference to OS image.", - "$ref": "#/definitions/ImageReference" - } - }, - "description": "Settings for OS image." - }, - "ImageReference": { - "properties": { - "publisher": { - "type": "string", - "title": "Publisher of the image." - }, - "offer": { - "type": "string", - "title": "Offer of the image." - }, - "sku": { - "type": "string", - "title": "SKU of the image." - }, - "version": { - "type": "string", - "title": "Version of the image." - }, - "virtualMachineImageId": { - "type": "string", - "title": "The ARM resource identifier of the virtual machine image. Computes nodes of the cluster will be created using this custom image. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}", - "description": "The virtual machine image must be in the same region and subscription as the cluster. 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. Note, you need to provide publisher, offer and sku of the base OS image of which the custom image has been derived from." - } - }, - "required": [ - "publisher", - "offer", - "sku" - ], - "description": "The image reference." - }, - "NodeStateCounts": { - "properties": { - "idleNodeCount": { - "type": "integer", - "format": "int32", - "title": "Number of compute nodes in idle state." - }, - "runningNodeCount": { - "type": "integer", - "format": "int32", - "title": "Number of compute nodes which are running jobs." - }, - "preparingNodeCount": { - "type": "integer", - "format": "int32", - "title": "Number of compute nodes which are being prepared." - }, - "unusableNodeCount": { - "type": "integer", - "format": "int32", - "title": "Number of compute nodes which are unusable." - }, - "leavingNodeCount": { - "type": "integer", - "format": "int32", - "title": "Number of compute nodes which are leaving the cluster." - } - }, - "required": [ - "idleNodeCount", - "runningNodeCount", - "preparingNodeCount", - "unusableNodeCount", - "leavingNodeCount" - ], - "description": "Counts of various compute node states on the cluster." - }, - "UserAccountSettings": { - "properties": { - "adminUserName": { - "type": "string", - "title": "Specifies the name of the administrator account." - }, - "adminUserSshPublicKey": { - "type": "string", - "title": "SSH public keys used to authenticate with linux based VMs. This does not get returned in a GET response body." - }, - "adminUserPassword": { - "type": "string", - "title": "Admin user Password (linux only). This does not get returned in a GET response body." - } - }, - "required": [ - "adminUserName" - ], - "description": "Settings for user account that gets created on each on the nodes of a cluster." - }, - "PerformanceCountersSettings": { - "properties": { - "appInsightsReference": { - "title": "Specifies Azure Application Insights information for performance counters reporting.", - "description": "If provided, Batch AI will upload node performance counters to the corresponding Azure Application Insights account.", - "$ref": "#/definitions/AppInsightsReference" - } - }, - "required": [ - "appInsightsReference" - ], - "description": "Performance counters reporting settings." - }, - "AppInsightsReference": { - "properties": { - "component": { - "title": "Specifies the Azure Application Insights component resource id.", - "$ref": "#/definitions/ResourceId" - }, - "instrumentationKey": { - "type": "string", - "title": "Value of the Azure Application Insights instrumentation key." - }, - "instrumentationKeySecretReference": { - "title": "Specifies a KeyVault Secret containing Azure Application Insights instrumentation key.", - "description": "Specifies KeyVault Store and Secret which contains Azure Application Insights instrumentation key. One of instrumentationKey or instrumentationKeySecretReference must be specified.", - "$ref": "#/definitions/KeyVaultSecretReference" - } - }, - "required": [ - "component" - ], - "description": "Specifies Azure Application Insights information for performance counters reporting." - }, - "NodeSetup": { - "properties": { - "setupTask": { - "title": "Specifies a setup task which can be used to customize the compute nodes of the cluster. The NodeSetup task runs every time a VM is rebooted. For that reason the task code needs to be idempotent. Generally it is used to either download static data that is required for all jobs that run on the cluster VMs or to download/install software.", - "$ref": "#/definitions/SetupTask" - }, - "mountVolumes": { - "title": "Information on shared volumes to be used by jobs.", - "description": "Specified mount volumes will be available to all jobs executing on the cluster. The volumes will be mounted at location specified by $AZ_BATCHAI_MOUNT_ROOT environment variable.", - "$ref": "#/definitions/MountVolumes" - }, - "performanceCountersSettings": { - "title": "Specifies settings for performance counters collecting and uploading.", - "$ref": "#/definitions/PerformanceCountersSettings" - } - }, - "description": "Use this to prepare the VM. NOTE: The volumes specified in mountVolumes are mounted first and then the setupTask is run. Therefore the setup task can use local mountPaths in its execution." - }, - "SetupTask": { - "properties": { - "commandLine": { - "type": "string", - "title": "Command Line to start Setup process." - }, - "environmentVariables": { - "type": "array", - "items": { - "$ref": "#/definitions/EnvironmentVariable" - }, - "title": "Collection of environment variables to be set for setup task." - }, - "secrets": { - "type": "array", - "items": { - "$ref": "#/definitions/EnvironmentVariableWithSecretValue" - }, - "title": "Collection of environment variables with secret values to be set for setup task.", - "description": "Server will never report values of these variables back." - }, - "runElevated": { - "type": "boolean", - "title": "Specifies whether to run the setup task under root account. The default value is false.", - "description": "Note. Non-elevated tasks are run under an account added into sudoer list and can perform sudo when required.", - "default": false - }, - "stdOutErrPathPrefix": { - "type": "string", - "description": "The prefix of a path where the Batch AI service will upload the stdout and stderr of the setup task." - }, - "stdOutErrPathSuffix": { - "type": "string", - "title": "A path segment appended by Batch AI to stdOutErrPathPrefix to form a path where stdout and stderr of the setup task will be uploaded.", - "description": "Batch AI creates the setup task output directories under an unique path to avoid conflicts between different clusters. You can concatenate stdOutErrPathPrefix and stdOutErrPathSuffix to get the full path to the output directory.", - "readOnly": true - } - }, - "required": [ - "commandLine", - "stdOutErrPathPrefix" - ], - "description": "Specifies a setup task which can be used to customize the compute nodes of the cluster." - }, - "ClusterCreateParameters": { - "properties": { - "location": { - "type": "string", - "description": "The region in which to create the cluster." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "The user specified tags associated with the Cluster." - }, - "properties": { - "$ref": "#/definitions/ClusterBaseProperties", - "description": "The properties of the Cluster.", - "x-ms-client-flatten": true - } - }, - "required": [ - "location" - ], - "description": "Parameters supplied to the Create operation." - }, - "ClusterUpdateParameters": { - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "The user specified tags associated with the Cluster." - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ClusterUpdateProperties", - "description": "The properties of the Cluster." - } - }, - "description": "Parameters supplied to the Update operation." - }, - "ClusterProperties": { - "properties": { - "vmSize": { - "type": "string", - "title": "The size of the virtual machines in the cluster.", - "description": "All virtual machines in a cluster are the same size. For information about available VM sizes for clusters using images from the Virtual Machines Marketplace (see Sizes for Virtual Machines (Linux) or Sizes for Virtual Machines (Windows). Batch AI service supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)." - }, - "vmPriority": { - "type": "string", - "title": "dedicated or lowpriority.", - "description": "The default value is dedicated. The node can get preempted while the task is running if lowpriority is chosen. This is best suited if the workload is checkpointing and can be restarted.", - "default": "dedicated", - "enum": [ - "dedicated", - "lowpriority" - ], - "x-ms-enum": { - "name": "VmPriority", - "modelAsString": false - } - }, - "scaleSettings": { - "$ref": "#/definitions/ScaleSettings", - "title": "Desired scale for the Cluster." - }, - "virtualMachineConfiguration": { - "title": "Settings for OS image and mounted data volumes.", - "$ref": "#/definitions/VirtualMachineConfiguration" - }, - "nodeSetup": { - "title": "Setup to be done on all compute nodes in the Cluster.", - "$ref": "#/definitions/NodeSetup" - }, - "userAccountSettings": { - "title": "Settings for user account of compute nodes.", - "$ref": "#/definitions/UserAccountSettings" - }, - "subnet": { - "title": "Specifies the identifier of the subnet.", - "$ref": "#/definitions/ResourceId" - }, - "creationTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "title": "The creation time of the cluster." - }, - "provisioningState": { - "type": "string", - "readOnly": true, - "x-nullable": false, - "title": "Specifies the provisioning state of the cluster.", - "description": "Possible value are: creating - Specifies that the cluster is being created. succeeded - Specifies that the cluster has been created successfully. failed - Specifies that the cluster creation has failed. deleting - Specifies that the cluster is being deleted.", - "enum": [ - "creating", - "succeeded", - "failed", - "deleting" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": false - } - }, - "provisioningStateTransitionTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "title": "The provisioning state transition time of the cluster." - }, - "allocationState": { - "type": "string", - "readOnly": true, - "title": "Indicates whether the cluster is resizing.", - "description": "Possible values are: steady and resizing. steady state indicates that the cluster is not resizing. There are no changes to the number of compute nodes in the cluster in progress. A cluster enters this state when it is created and when no operations are being performed on the cluster to change the number of compute nodes. resizing state indicates that the cluster is resizing; that is, compute nodes are being added to or removed from the cluster.", - "enum": [ - "steady", - "resizing" - ], - "x-ms-enum": { - "name": "AllocationState", - "modelAsString": false - } - }, - "allocationStateTransitionTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "title": "The time at which the cluster entered its current allocation state." - }, - "errors": { - "title": "Contains details of various errors on the cluster including resize and node setup task", - "description": "This element contains all the errors encountered by various compute nodes during node setup.", - "type": "array", - "items": { - "$ref": "#/definitions/BatchAIError" - } - }, - "currentNodeCount": { - "type": "integer", - "readOnly": true, - "format": "int32", - "title": "The number of compute nodes currently assigned to the cluster." - }, - "nodeStateCounts": { - "title": "Counts of various node states on the cluster.", - "readOnly": true, - "$ref": "#/definitions/NodeStateCounts" - } - }, - "description": "Job specific properties." - }, - "Cluster": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ClusterProperties", - "description": "The properties associated with the Cluster." - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Contains information about a Cluster." - }, - "ClusterListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Cluster" - }, - "description": "The collection of returned Clusters." - }, - "nextLink": { - "type": "string", - "description": "The continuation token." - } - }, - "description": "Values returned by the List Clusters operation." - }, - "JobBaseProperties": { - "properties": { - "experimentName": { - "type": "string", - "description": "Describe the experiment information of the job" - }, - "priority": { - "type": "integer", - "format": "int32", - "title": "Priority associated with the job.", - "description": "Priority associated with the job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0.", - "default": 0 - }, - "cluster": { - "title": "Specifies the Id of the cluster on which this job will run.", - "$ref": "#/definitions/ResourceId" - }, - "mountVolumes": { - "title": "Information on mount volumes to be used by the job.", - "description": "These volumes will be mounted before the job execution and will be unmounted after the job completion. The volumes will be mounted at location specified by $AZ_BATCHAI_JOB_MOUNT_ROOT environment variable.", - "$ref": "#/definitions/MountVolumes" - }, - "nodeCount": { - "type": "integer", - "format": "int32", - "title": "Number of compute nodes to run the job on.", - "description": "The job will be gang scheduled on that many compute nodes" - }, - "containerSettings": { - "title": "If provided the job will run in the specified container.", - "description": "If the container was downloaded as part of cluster setup then the same container image will be used. If not provided, the job will run on the VM.", - "$ref": "#/definitions/ContainerSettings" - }, - "cntkSettings": { - "title": "Specifies the settings for CNTK (aka Microsoft Cognitive Toolkit) job.", - "$ref": "#/definitions/CNTKsettings" - }, - "pyTorchSettings": { - "title": "Specifies the settings for pyTorch job.", - "$ref": "#/definitions/PyTorchSettings" - }, - "tensorFlowSettings": { - "title": "Specifies the settings for Tensor Flow job.", - "$ref": "#/definitions/TensorFlowSettings" - }, - "caffeSettings": { - "title": "Specifies the settings for Caffe job.", - "$ref": "#/definitions/CaffeSettings" - }, - "caffe2Settings": { - "title": "Specifies the settings for Caffe2 job.", - "$ref": "#/definitions/Caffe2Settings" - }, - "chainerSettings": { - "title": "Specifies the settings for Chainer job.", - "$ref": "#/definitions/ChainerSettings" - }, - "customToolkitSettings": { - "title": "Specifies the settings for custom tool kit job.", - "$ref": "#/definitions/CustomToolkitSettings" - }, - "jobPreparation": { - "title": "Specifies the command line to be executed before tool kit is launched.", - "description": "The specified actions will run on all the nodes that are part of the job", - "$ref": "#/definitions/JobPreparation" - }, - "stdOutErrPathPrefix": { - "type": "string", - "description": "The path where the Batch AI service will upload stdout and stderror of the job." - }, - "inputDirectories": { - "type": "array", - "items": { - "$ref": "#/definitions/InputDirectory" - }, - "title": "Specifies the list of input directories for the Job." - }, - "outputDirectories": { - "type": "array", - "items": { - "$ref": "#/definitions/OutputDirectory" - }, - "title": "Specifies the list of output directories." - }, - "environmentVariables": { - "type": "array", - "items": { - "$ref": "#/definitions/EnvironmentVariable" - }, - "title": "Additional environment variables to set on the job.", - "description": "Batch AI will setup these additional environment variables for the job." - }, - "secrets": { - "type": "array", - "items": { - "$ref": "#/definitions/EnvironmentVariableWithSecretValue" - }, - "title": "Additional environment variables with secret values to set on the job.", - "description": "Batch AI will setup these additional environment variables for the job. Server will never report values of these variables back." - }, - "constraints": { - "properties": { - "maxWallClockTime": { - "type": "string", - "format": "duration", - "title": "Max time the job can run.", - "description": "Default Value = 1 week.", - "default": "7.00:00:00" - } - }, - "description": "Constraints associated with the Job." - } - }, - "required": [ - "cluster", - "nodeCount", - "stdOutErrPathPrefix" - ], - "description": "The properties of a Batch AI job." - }, - "JobCreateParameters": { - "properties": { - "location": { - "type": "string", - "description": "The region in which to create the job." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "The user specified tags associated with the job." - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/JobBaseProperties", - "description": "The properties of the Job." - } - }, - "required": [ - "location" - ], - "description": "Parameters supplied to the Create operation." - }, - "JobProperties": { - "properties": { - "experimentName": { - "type": "string", - "description": "Describe the experiment information of the job" - }, - "priority": { - "type": "integer", - "format": "int32", - "title": "Priority associated with the job.", - "description": "Priority associated with the job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0.", - "default": 0 - }, - "cluster": { - "title": "Specifies the Id of the cluster on which this job will run.", - "$ref": "#/definitions/ResourceId" - }, - "mountVolumes": { - "title": "Information on mount volumes to be used by the job.", - "description": "These volumes will be mounted before the job execution and will be unmounted after the job completion. The volumes will be mounted at location specified by $AZ_BATCHAI_JOB_MOUNT_ROOT environment variable.", - "$ref": "#/definitions/MountVolumes" - }, - "jobOutputDirectoryPathSegment": { - "type": "string", - "title": "A segment of job's output directories path created by BatchAI.", - "description": "Batch AI creates job's output directories under an unique path to avoid conflicts between jobs. This value contains a path segment generated by Batch AI to make the path unique and can be used to find the output directory on the node or mounted filesystem." - }, - "nodeCount": { - "type": "integer", - "format": "int32", - "title": "Number of compute nodes to run the job on.", - "description": "The job will be gang scheduled on that many compute nodes" - }, - "containerSettings": { - "title": "If provided the job will run in the specified container.", - "description": "If the container was downloaded as part of cluster setup then the same container image will be used. If not provided, the job will run on the VM.", - "$ref": "#/definitions/ContainerSettings" - }, - "toolType": { - "title": "The toolkit type of this job.", - "description": "Possible values are: cntk, tensorflow, caffe, caffe2, chainer, pytorch, custom.", - "$ref": "#/definitions/ToolType" - }, - "cntkSettings": { - "title": "Specifies the settings for CNTK (aka Microsoft Cognitive Toolkit) job.", - "$ref": "#/definitions/CNTKsettings" - }, - "pyTorchSettings": { - "title": "Specifies the settings for pyTorch job.", - "$ref": "#/definitions/PyTorchSettings" - }, - "tensorFlowSettings": { - "title": "Specifies the settings for Tensor Flow job.", - "$ref": "#/definitions/TensorFlowSettings" - }, - "caffeSettings": { - "title": "Specifies the settings for Caffe job.", - "$ref": "#/definitions/CaffeSettings" - }, - "chainerSettings": { - "title": "Specifies the settings for Chainer job.", - "$ref": "#/definitions/ChainerSettings" - }, - "customToolkitSettings": { - "title": "Specifies the settings for custom tool kit job.", - "$ref": "#/definitions/CustomToolkitSettings" - }, - "jobPreparation": { - "title": "Specifies the actions to be performed before tool kit is launched.", - "description": "The specified actions will run on all the nodes that are part of the job", - "$ref": "#/definitions/JobPreparation" - }, - "stdOutErrPathPrefix": { - "type": "string", - "description": "The path where the Batch AI service will upload stdout and stderror of the job." - }, - "inputDirectories": { - "type": "array", - "items": { - "$ref": "#/definitions/InputDirectory" - }, - "title": "Specifies the list of input directories for the Job." - }, - "outputDirectories": { - "type": "array", - "items": { - "$ref": "#/definitions/OutputDirectory" - }, - "title": "Specifies the list of output directories where the models will be created." - }, - "environmentVariables": { - "type": "array", - "items": { - "$ref": "#/definitions/EnvironmentVariable" - }, - "title": "Additional environment variables to set on the job.", - "description": "Batch AI will setup these additional environment variables for the job." - }, - "secrets": { - "type": "array", - "items": { - "$ref": "#/definitions/EnvironmentVariableWithSecretValue" - }, - "title": "Additional environment variables with secret values to set on the job.", - "description": "Batch AI will setup these additional environment variables for the job. Server will never report values of these variables back." - }, - "constraints": { - "properties": { - "maxWallClockTime": { - "type": "string", - "format": "duration", - "title": "Max time the job can run.", - "description": "Default Value = 1 week.", - "default": "7.00:00:00" - } - }, - "description": "Constraints associated with the Job." - }, - "creationTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "title": "The job creation time.", - "description": "The creation time of the job." - }, - "provisioningState": { - "type": "string", - "readOnly": true, - "x-nullable": false, - "description": "The provisioned state of the Batch AI job", - "enum": [ - "creating", - "deleting", - "succeeded", - "failed" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": false - } - }, - "provisioningStateTransitionTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "title": "The time at which the job entered its current provisioning state.", - "description": "The time at which the job entered its current provisioning state." - }, - "executionState": { - "type": "string", - "title": "The current state of the job.", - "description": "The current state of the job. Possible values are: queued - The job is queued and able to run. A job enters this state when it is created, or when it is awaiting a retry after a failed run. running - The job is running on a compute cluster. This includes job-level preparation such as downloading resource files or set up container specified on the job - it does not necessarily mean that the job command line has started executing. terminating - The job is terminated by the user, the terminate operation is in progress. succeeded - The job has completed running successfully and exited with exit code 0. failed - The job has finished unsuccessfully (failed with a non-zero exit code) and has exhausted its retry limit. A job is also marked as failed if an error occurred launching the job.", - "enum": [ - "queued", - "running", - "terminating", - "succeeded", - "failed" - ], - "x-ms-enum": { - "name": "ExecutionState", - "modelAsString": false - } - }, - "executionStateTransitionTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "title": "The time at which the job entered its current execution state.", - "description": "The time at which the job entered its current execution state." - }, - "executionInfo": { - "properties": { - "startTime": { - "type": "string", - "format": "date-time", - "title": "The time at which the job started running.", - "description": "'Running' corresponds to the running state. If the job has been restarted or retried, this is the most recent time at which the job started running. This property is present only for job that are in the running or completed state." - }, - "endTime": { - "type": "string", - "format": "date-time", - "title": "The time at which the job completed.", - "description": "This property is only returned if the job is in completed state." - }, - "exitCode": { - "type": "integer", - "format": "int32", - "title": "The exit code of the job.", - "description": "This property is only returned if the job is in completed state." - }, - "errors": { - "title": "Contains details of various errors encountered by the service during job execution", - "type": "array", - "items": { - "$ref": "#/definitions/BatchAIError" - } - } - }, - "required": [ - "startTime" - ], - "description": "Contains information about the execution of a job in the Azure Batch service." - } - }, - "description": "Job specific properties." - }, - "Job": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/JobProperties", - "description": "The properties associated with the job." - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Contains information about the job." - }, - "JobListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Job" - }, - "description": "The collection of jobs." - }, - "nextLink": { - "type": "string", - "description": "The continuation token." - } - }, - "description": "Values returned by the List operation." - }, - "RemoteLoginInformation": { - "properties": { - "nodeId": { - "type": "string", - "description": "Id of the compute node" - }, - "ipAddress": { - "type": "string", - "description": "ip address" - }, - "port": { - "type": "number", - "format": "int32", - "title": "port number" - } - }, - "description": "Contains remote login details to SSH/RDP to a compute node in cluster.", - "required": [ - "nodeId", - "ipAddress", - "port" - ] - }, - "RemoteLoginInformationListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/RemoteLoginInformation" - }, - "description": "The collection of returned remote login details." - }, - "nextLink": { - "type": "string", - "description": "The continuation token." - } - }, - "description": "Values returned by the List operation." - }, - "FileProperties": { - "properties": { - "lastModified": { - "type": "string", - "format": "date-time", - "title": "The time at which the file was last modified.", - "description": "The time at which the file was last modified." - }, - "contentLength": { - "type": "integer", - "format": "int64", - "title": "The file size.", - "description": "The file size." - } - }, - "description": "File specific properties." - }, - "File": { - "properties": { - "name": { - "type": "string", - "description": "Name of the file." - }, - "isDirectory": { - "type": "boolean", - "description": "Indicates if the file is a directory." - }, - "downloadUrl": { - "type": "string", - "title": "Will contain an URL to download the corresponding file. The downloadUrl is not returned for directories." - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/FileProperties", - "description": "The properties associated with the file. The properties are not returned for directories." - } - }, - "description": "Properties of the file or directory.", - "required": [ - "name", - "isDirectory" - ] - }, - "FileListResult": { - "properties": { - "value": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/File" - }, - "description": "The collection of returned job directories and files." - }, - "nextLink": { - "type": "string", - "description": "The continuation token." - } - }, - "description": "Values returned by the List operation." - }, - "ResourceId": { - "properties": { - "id": { - "type": "string", - "description": "The ID of the resource" - } - }, - "required": [ - "id" - ], - "description": "Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.", - "x-ms-azure-resource": true - }, - "Resource": { - "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 - }, - "ToolType": { - "type": "string", - "description": "The toolkit type of this job.", - "enum": [ - "cntk", - "tensorflow", - "caffe", - "caffe2", - "chainer", - "custom" - ], - "x-ms-enum": { - "name": "ToolType", - "modelAsString": true - } - }, - "NameValuePair": { - "properties": { - "name": { - "type": "string", - "title": "The name in the name-value pair." - }, - "value": { - "type": "string", - "title": "The value in the name-value pair." - } - }, - "description": "Represents a name-value pair." - }, - "EnvironmentVariable": { - "properties": { - "name": { - "type": "string", - "title": "The name of the environment variable." - }, - "value": { - "type": "string", - "title": "The value of the environment variable." - } - }, - "required": [ - "name", - "value" - ], - "description": "A collection of environment variables to set." - }, - "EnvironmentVariableWithSecretValue": { - "properties": { - "name": { - "type": "string", - "title": "The name of the environment variable to store the secret value." - }, - "value": { - "type": "string", - "title": "The value of the environment variable. This value will never be reported back by Batch AI." - }, - "valueSecretReference": { - "title": "Specifies the location of the Azure KeyVault secret which will be used as the environment variable value.", - "description": "Specifies KeyVault Store and Secret which contains the value for the environment variable. One of value or valueSecretReference must be provided.", - "$ref": "#/definitions/KeyVaultSecretReference" - } - }, - "required": [ - "name" - ], - "description": "A collection of environment variables with secret values to set." - }, - "LocalDataVolume": { - "properties": { - "hostPath": { - "type": "string", - "title": "The path on the host that is to be mounted as a directory in the container." - }, - "localPath": { - "type": "string", - "title": "The container local path where the host directory is mounted." - } - }, - "description": "Represents mapping of host directories to directories in the container.", - "required": [ - "hostPath", - "localPath" - ] - }, - "ImageSourceRegistry": { - "properties": { - "serverUrl": { - "type": "string", - "title": "URL for image repository." - }, - "image": { - "type": "string", - "title": "The name of the image in image repository." - }, - "credentials": { - "title": "Information to access the private Docker repository.", - "$ref": "#/definitions/PrivateRegistryCredentials" - } - }, - "description": "Details of the container image such as name, URL and credentials.", - "required": [ - "image" - ] - }, - "PrivateRegistryCredentials": { - "properties": { - "username": { - "type": "string", - "title": "User name to login." - }, - "password": { - "type": "string", - "title": "Password to login.", - "description": "One of password or passwordSecretReference must be specified." - }, - "passwordSecretReference": { - "title": "Specifies the location of the password, which is a Key Vault Secret.", - "description": "Users can store their secrets in Azure KeyVault and pass it to the Batch AI Service to integrate with KeyVault. One of password or passwordSecretReference must be specified.", - "$ref": "#/definitions/KeyVaultSecretReference" - } - }, - "description": "Credentials to access a container image in a private repository.", - "required": [ - "username" - ] - }, - "ContainerSettings": { - "properties": { - "imageSourceRegistry": { - "title": "Registry to download the container from.", - "$ref": "#/definitions/ImageSourceRegistry" - } - }, - "description": "Settings for the container to be downloaded.", - "required": [ - "imageSourceRegistry" - ] - }, - "InputDirectory": { - "properties": { - "id": { - "type": "string", - "title": "The id for the input directory.", - "description": "The path of the input directory will be available as a value of an environment variable with AZ_BATCHAI_INPUT_ name, where is the value of id attribute." - }, - "path": { - "type": "string", - "title": "The path to the input directory." - } - }, - "description": "Input directory for the job.", - "required": [ - "id", - "path" - ] - }, - "OutputDirectory": { - "properties": { - "id": { - "type": "string", - "title": "The name for the output directory.", - "description": "The path of the output directory will be available as a value of an environment variable with AZ_BATCHAI_OUTPUT_ name, where is the value of id attribute." - }, - "pathPrefix": { - "type": "string", - "title": "The prefix path where the output directory will be created.", - "description": "NOTE: This is an absolute path to prefix. E.g. $AZ_BATCHAI_MOUNT_ROOT/MyNFS/MyLogs. You can find the full path to the output directory by combining pathPrefix, jobOutputDirectoryPathSegment (reported by get job) and pathSuffix." - }, - "pathSuffix": { - "type": "string", - "title": "The suffix path where the output directory will be created.", - "description": "The suffix path where the output directory will be created. E.g. models. You can find the full path to the output directory by combining pathPrefix, jobOutputDirectoryPathSegment (reported by get job) and pathSuffix." - }, - "type": { - "type": "string", - "title": "An enumeration, which specifies the type of job output directory.", - "description": "Default value is Custom. The possible values are Model, Logs, Summary, and Custom. Users can use multiple enums for a single directory. Eg. outPutType='Model,Logs, Summary'", - "default": "custom", - "enum": [ - "model", - "logs", - "summary", - "custom" - ], - "x-ms-enum": { - "name": "OutputType", - "modelAsString": true - } - }, - "createNew": { - "type": "boolean", - "title": "True to create new directory.", - "description": "Default is true. If false, then the directory is not created and can be any directory path that the user specifies.", - "default": true - } - }, - "description": "Output directory for the job.", - "required": [ - "id", - "pathPrefix" - ] - }, - "AzureStorageCredentialsInfo": { - "properties": { - "accountKey": { - "type": "string", - "title": "Storage account key.", - "description": "One of accountKey or accountKeySecretReference must be specified." - }, - "accountKeySecretReference": { - "title": "Specifies the location of the storage account key, which is a Key Vault Secret.", - "description": "Users can store their secrets in Azure KeyVault and pass it to the Batch AI Service to integrate with KeyVault. One of accountKey or accountKeySecretReference must be specified.", - "$ref": "#/definitions/KeyVaultSecretReference" - } - }, - "description": "Credentials to access Azure File Share." - }, - "AzureFileShareReference": { - "properties": { - "accountName": { - "type": "string", - "title": "Name of the storage account." - }, - "azureFileUrl": { - "type": "string", - "title": "URL to access the Azure File." - }, - "credentials": { - "title": "Information of the Azure File credentials.", - "$ref": "#/definitions/AzureStorageCredentialsInfo" - }, - "relativeMountPath": { - "type": "string", - "title": "Specifies the relative path on the compute node where the Azure file share will be mounted.", - "description": "Note that all cluster level file shares will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and all job level file shares will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT." - }, - "fileMode": { - "type": "string", - "title": "Specifies the file mode.", - "description": "Default value is 0777. Valid only if OS is linux.", - "default": "0777" - }, - "directoryMode": { - "type": "string", - "title": "Specifies the directory Mode.", - "description": "Default value is 0777. Valid only if OS is linux.", - "default": "0777" - } - }, - "description": "Details of the Azure File Share to mount on the cluster.", - "required": [ - "accountName", - "azureFileUrl", - "credentials", - "relativeMountPath" - ] - }, - "AzureBlobFileSystemReference": { - "properties": { - "accountName": { - "type": "string", - "title": "Name of the Azure Blob Storage account." - }, - "containerName": { - "type": "string", - "title": "Name of the Azure Blob Storage container to mount on the cluster." - }, - "credentials": { - "title": "Information of the Azure Blob Storage account credentials.", - "$ref": "#/definitions/AzureStorageCredentialsInfo" - }, - "relativeMountPath": { - "type": "string", - "title": "Specifies the relative path on the compute node where the Azure Blob file system will be mounted.", - "description": "Note that all cluster level blob file systems will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and all job level blob file systems will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT." - }, - "mountOptions": { - "type": "string", - "title": "Specifies the various mount options that can be used to configure Blob file system." - } - }, - "description": "Provides required information, for the service to be able to mount Azure Blob Storage container on the cluster nodes.", - "required": [ - "accountName", - "containerName", - "credentials", - "relativeMountPath" - ] - }, - "FileServerReference": { - "properties": { - "fileServer": { - "title": "Reference to the file server resource.", - "$ref": "#/definitions/ResourceId" - }, - "sourceDirectory": { - "type": "string", - "title": "Specifies the source directory in File Server that needs to be mounted.", - "description": "If this property is not specified, the entire File Server will be mounted." - }, - "relativeMountPath": { - "type": "string", - "title": "Specifies the relative path on the compute node where the File Server will be mounted.", - "description": "Note that all cluster level file servers will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and job level file servers will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT." - }, - "mountOptions": { - "type": "string", - "title": "Specifies the mount options for File Server." - } - }, - "description": "Provides required information, for the service to be able to mount Azure FileShare on the cluster nodes.", - "required": [ - "fileServer", - "relativeMountPath" - ] - }, - "UnmanagedFileSystemReference": { - "properties": { - "mountCommand": { - "title": "Command used to mount the unmanaged file system.", - "type": "string" - }, - "relativeMountPath": { - "type": "string", - "title": "Specifies the relative path on the compute cluster node where the file system will be mounted.", - "description": "Note that all cluster level unmanaged file system will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and job level unmanaged file system will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT." - } - }, - "description": "Details of the file system to mount on the compute cluster nodes.", - "required": [ - "mountCommand", - "relativeMountPath" - ] - }, - "MountVolumes": { - "properties": { - "azureFileShares": { - "type": "array", - "items": { - "$ref": "#/definitions/AzureFileShareReference" - }, - "title": "Azure File Share setup configuration.", - "description": "References to Azure File Shares that are to be mounted to the cluster nodes." - }, - "azureBlobFileSystems": { - "type": "array", - "items": { - "$ref": "#/definitions/AzureBlobFileSystemReference" - }, - "title": "Azure Blob FileSystem setup configuration.", - "description": "References to Azure Blob FUSE that are to be mounted to the cluster nodes." - }, - "fileServers": { - "type": "array", - "items": { - "$ref": "#/definitions/FileServerReference" - }, - "title": "References to a list of file servers that are mounted to the cluster node." - }, - "unmanagedFileSystems": { - "type": "array", - "items": { - "$ref": "#/definitions/UnmanagedFileSystemReference" - }, - "title": "References to a list of file servers that are mounted to the cluster node." - } - }, - "description": "Details of volumes to mount on the cluster." - }, - "CNTKsettings": { - "properties": { - "languageType": { - "type": "string", - "title": "Specifies the language type to use for launching CNTK (aka Microsoft Cognitive Toolkit) job.", - "description": "Valid values are 'BrainScript' or 'Python'." - }, - "configFilePath": { - "type": "string", - "title": "Specifies the path of the config file.", - "description": "This property can be specified only if the languageType is 'BrainScript'." - }, - "pythonScriptFilePath": { - "type": "string", - "title": "The path and file name of the python script to execute the job.", - "description": "This property can be specified only if the languageType is 'Python'." - }, - "pythonInterpreterPath": { - "type": "string", - "title": "The path to python interpreter.", - "description": "This property can be specified only if the languageType is 'Python'." - }, - "commandLineArgs": { - "type": "string", - "title": "Command line arguments that needs to be passed to the python script or CNTK.exe." - }, - "processCount": { - "type": "integer", - "format": "int32", - "title": "Number of processes parameter that is passed to MPI runtime.", - "description": "The default value for this property is equal to nodeCount property" - } - }, - "description": "Specifies the settings for CNTK (aka Microsoft Cognitive Toolkit) job." - }, - "CaffeSettings": { - "properties": { - "configFilePath": { - "type": "string", - "title": "Specifies the path of the config file.", - "description": "This property cannot be specified if pythonScriptFilePath is specified." - }, - "pythonScriptFilePath": { - "type": "string", - "title": "The path and file name of the python script to execute the job.", - "description": "This property cannot be specified if configFilePath is specified." - }, - "pythonInterpreterPath": { - "type": "string", - "title": "The path to python interpreter.", - "description": "This property can be specified only if the pythonScriptFilePath is specified." - }, - "commandLineArgs": { - "type": "string", - "title": "Command line arguments that needs to be passed to the Caffe job." - }, - "processCount": { - "type": "integer", - "format": "int32", - "title": "Number of processes parameter that is passed to MPI runtime.", - "description": "The default value for this property is equal to nodeCount property" - } - }, - "description": "Specifies the settings for Caffe job." - }, - "Caffe2Settings": { - "properties": { - "pythonScriptFilePath": { - "type": "string", - "title": "The path and file name of the python script to execute the job." - }, - "pythonInterpreterPath": { - "type": "string", - "title": "The path to python interpreter." - }, - "commandLineArgs": { - "type": "string", - "title": "Command line arguments that needs to be passed to the python script" - } - }, - "description": "Specifies the settings for Caffe2 job.", - "required": [ - "pythonScriptFilePath" - ] - }, - "ChainerSettings": { - "properties": { - "pythonScriptFilePath": { - "type": "string", - "title": "The path and file name of the python script to execute the job." - }, - "pythonInterpreterPath": { - "type": "string", - "title": "The path to python interpreter." - }, - "commandLineArgs": { - "type": "string", - "title": "Command line arguments that needs to be passed to the python script" - }, - "processCount": { - "type": "integer", - "format": "int32", - "title": "Number of processes parameter that is passed to MPI runtime.", - "description": "The default value for this property is equal to nodeCount property" - } - }, - "description": "Specifies the settings for Chainer job.", - "required": [ - "pythonScriptFilePath" - ] - }, - "CustomToolkitSettings": { - "properties": { - "commandLine": { - "type": "string", - "title": "The command line to execute the custom toolkit Job." - } - }, - "description": "Specifies the settings for a custom tool kit job." - }, - "JobPreparation": { - "properties": { - "commandLine": { - "type": "string", - "title": "The command line to execute.", - "description": "If containerSettings is specified on the job, this commandLine will be executed in the same container as job. Otherwise it will be executed on the node." - } - }, - "description": "Specifies the settings for job preparation.", - "required": [ - "commandLine" - ] - }, - "PyTorchSettings": { - "properties": { - "pythonScriptFilePath": { - "type": "string", - "title": "The path and file name of the python script to execute the job." - }, - "pythonInterpreterPath": { - "type": "string", - "title": "The path to python interpreter." - }, - "commandLineArgs": { - "type": "string", - "title": "Specifies the command line arguments for the master task." - }, - "processCount": { - "type": "integer", - "format": "int32", - "title": "Number of processes to launch for the job execution.", - "description": "The default value for this property is equal to nodeCount property." - }, - "communicationBackend": { - "type": "string", - "title": "Type of the communication backend for distributed jobs.", - "description": "Valid values are 'TCP', 'Gloo' or 'MPI'. Not required for non-distributed jobs." - } - }, - "description": "Specifies the settings for pyTorch job.", - "required": [ - "pythonScriptFilePath" - ] - }, - "TensorFlowSettings": { - "properties": { - "pythonScriptFilePath": { - "type": "string", - "title": "The path and file name of the python script to execute the job." - }, - "pythonInterpreterPath": { - "type": "string", - "title": "The path to python interpreter." - }, - "masterCommandLineArgs": { - "type": "string", - "title": "Specifies the command line arguments for the master task." - }, - "workerCommandLineArgs": { - "type": "string", - "title": "Specifies the command line arguments for the worker task.", - "description": "This property is optional for single machine training." - }, - "parameterServerCommandLineArgs": { - "type": "string", - "title": "Specifies the command line arguments for the parameter server task.", - "description": "This property is optional for single machine training." - }, - "workerCount": { - "type": "integer", - "format": "int32", - "title": "The number of worker tasks.", - "description": "If specified, the value must be less than or equal to (nodeCount * numberOfGPUs per VM). If not specified, the default value is equal to nodeCount. This property can be specified only for distributed TensorFlow training" - }, - "parameterServerCount": { - "type": "integer", - "format": "int32", - "title": "The number of parameter server tasks.", - "description": "If specified, the value must be less than or equal to nodeCount. If not specified, the default value is equal to 1 for distributed TensorFlow training (This property is not applicable for single machine training). This property can be specified only for distributed TensorFlow training." - } - }, - "description": "Specifies the settings for TensorFlow job.", - "required": [ - "pythonScriptFilePath" - ] - }, - "CloudError": { - "x-ms-external": true, - "properties": { - "error": { - "$ref": "#/definitions/CloudErrorBody", - "description": "An error response from the Batch AI service." - } - }, - "description": "An error response from the Batch AI 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." - }, - "target": { - "type": "string", - "description": "The target of the particular error. For example, the name of the property in error." - }, - "details": { - "type": "array", - "items": { - "$ref": "#/definitions/CloudErrorBody" - }, - "description": "A list of additional details about the error." - } - }, - "description": "An error response from the Batch AI service." - }, - "BatchAIError": { - "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/NameValuePair" - }, - "description": "A list of additional details about the error." - } - }, - "description": "An error response from the Batch AI service." - }, - "Operation": { - "title": "A REST API operation", - "description": "Details of a REST API operation", - "type": "object", - "properties": { - "name": { - "title": "The operation name.", - "description": "This is of the format {provider}/{resource}/{operation}", - "type": "string" - }, - "display": { - "description": "The object that describes the operation.", - "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": { - "x-ms-client-flatten": true, - "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.", - "description": "Contains the list of all operations supported by BatchAI resource provider", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Operation" - }, - "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." - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscriptionID for the Azure user." - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "description": "Name of the resource group to which the resource belongs.", - "required": true, - "x-ms-parameter-location": "method", - "type": "string", - "pattern": "^[-\\w\\._]+$" - }, - "ClusterNameParameter": { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[-\\w\\._]+$", - "minLength": 1, - "maxLength": 64, - "x-ms-parameter-location": "method", - "description": "The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long." - }, - "JobNameParameter": { - "name": "jobName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[-\\w\\._]+$", - "minLength": 1, - "maxLength": 64, - "x-ms-parameter-location": "method", - "description": "The name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long." - }, - "FileServerNameParameter": { - "name": "fileServerName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[-\\w\\._]+$", - "minLength": 1, - "maxLength": 64, - "x-ms-parameter-location": "method", - "description": "The name of the file server within the specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Specifies the version of API used for this request." - }, - "SelectParameter": { - "name": "$select", - "in": "query", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "description": "An OData $select clause. Used to select the properties to be returned in the GET response.", - "x-ms-parameter-grouping": { - "postfix": "Options" - } - }, - "FilterParameter": { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "description": "An OData $filter clause. Used to filter results that are returned in the GET response.", - "x-ms-parameter-grouping": { - "postfix": "Options" - } - }, - "MaxResultsParameter": { - "name": "maxresults", - "x-ms-client-name": "maxResults", - "default": 1000, - "minimum": 1, - "maximum": 1000, - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method", - "description": "The maximum number of items to return in the response. A maximum of 1000 files can be returned.", - "x-ms-parameter-grouping": { - "postfix": "Options" - } - }, - "OutputDirectoryIdParameter": { - "name": "outputdirectoryid", - "in": "query", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "description": "Id of the job output directory. This is the OutputDirectory-->id parameter that is given by the user during Create Job.", - "x-ms-parameter-grouping": { - "postfix": "Options" - } - }, - "DownloadLinkExpiryParameter": { - "name": "linkexpiryinminutes", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "minimum": 5, - "maximum": 600, - "default": 60, - "x-ms-parameter-location": "method", - "description": "The number of minutes after which the download link will expire.", - "x-ms-parameter-grouping": { - "postfix": "Options" - } - }, - "Directory": { - "name": "directory", - "in": "query", - "default": ".", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "description": "The path to the directory.", - "x-ms-parameter-grouping": { - "postfix": "Options" - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/ClusterListRemoteLoginInfo.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/ClusterListRemoteLoginInfo.json deleted file mode 100644 index 82af47f24759..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/ClusterListRemoteLoginInfo.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "clusterName": "demo_cluster", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-03-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "nodeId": "tvm-3601533753_1-20170719t162906z", - "ipAddress": "13.84.190.124", - "port": 50000 - }, - { - "nodeId": "tvm-3601533753_2-20170719t162906z", - "ipAddress": "13.84.190.124", - "port": 50001 - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/DeleteCluster.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/DeleteCluster.json deleted file mode 100644 index abeac1c492b5..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/DeleteCluster.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "clusterName": "demo_cluster", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-03-01" - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2018-03-01", - "Retry-After": 15 - } - }, - "200": {}, - "204": {} - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/DeleteFileServer.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/DeleteFileServer.json deleted file mode 100644 index 1ac3d44eebb7..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/DeleteFileServer.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "fileServerName": "demo_nfs", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-03-01" - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2018-03-01", - "Retry-After": 15 - } - }, - "200": {}, - "204": {} - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/DeleteJob.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/DeleteJob.json deleted file mode 100644 index d7e75b4c5b80..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/DeleteJob.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "jobName": "demo_job", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-03-01" - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2018-03-01", - "Retry-After": 15 - } - }, - "200": {}, - "204": {} - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/GetCluster.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/GetCluster.json deleted file mode 100644 index b8f834cbdf8c..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/GetCluster.json +++ /dev/null @@ -1,78 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "clusterName": "demo_cluster", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-03-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/clusters/demo_cluster", - "name": "demo_cluster", - "type": "Microsoft.BatchAI/Clusters", - "location": "eastus", - "properties": { - "provisioningState": "succeeded", - "allocationState": "resizing", - "creationTime": "2017-09-27T21:50:02.377Z", - "allocationStateTransitionTime": "2017-09-27T21:50:04.521Z", - "provisioningStateTransitionTime": "2017-09-27T21:50:03.828Z", - "vmSize": "STANDARD_NC6", - "currentNodeCount": 0, - "nodeStateCounts": { - "runningNodeCount": 0, - "idleNodeCount": 0, - "unusableNodeCount": 0, - "preparingNodeCount": 0, - "leavingNodeCount": 0 - }, - "vmPriority": "dedicated", - "scaleSettings": { - "manual": { - "targetNodeCount": 1, - "nodeDeallocationOption": "requeue" - } - }, - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "UbuntuServer", - "sku": "16.04-LTS", - "version": "latest" - } - }, - "userAccountSettings": { - "adminUserName": "admin_user_name" - }, - "nodeSetup": { - "mountVolumes": { - "azureFileShares": [ - { - "accountName": "storage_account_name", - "azureFileUrl": "https://storage_account_name.file.core.windows.net/azure_file_share_name", - "credentials": {}, - "relativeMountPath": "azfiles", - "fileMode": "0777", - "directoryMode": "0777" - } - ], - "fileServers": [ - { - "fileServer": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/fileservers/fileservercedd134b" - }, - "relativeMountPath": "nfs", - "mountOptions": "rw" - } - ] - } - }, - "subnet": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.Network/virtualNetworks/7feb1976-8c31-4f1f-bea2-86cb1839a7bavnet/subnets/Subnet-1" - } - } - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/GetFileServer.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/GetFileServer.json deleted file mode 100644 index ffc3ca9e94c5..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/GetFileServer.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "fileServerName": "demo_nfs", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-03-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/fileservers/fileservercedd134b", - "name": "fileservercedd134b", - "type": "Microsoft.BatchAI/FileServers", - "location": "eastus", - "properties": { - "provisioningState": "succeeded", - "creationTime": "2017-09-27T21:45:28.159Z", - "provisioningStateTransitionTime": "2017-09-27T21:49:25.416Z", - "vmSize": "STANDARD_NC6", - "sshConfiguration": { - "userAccountSettings": { - "adminUserName": "admin_user_name" - } - }, - "dataDisks": { - "diskSizeInGB": 10, - "cachingType": "none", - "diskCount": 2, - "storageAccountType": "Standard_LRS" - }, - "subnet": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.Network/virtualNetworks/7feb1976-8c31-4f1f-bea2-86cb1839a7bavnet/subnets/Subnet-1" - }, - "mountSettings": { - "mountPoint": "/mnt/data", - "fileServerPublicIP": "13.90.141.66", - "fileServerInternalIP": "10.0.0.4", - "fileServerType": "nfs" - } - } - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/GetJob.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/GetJob.json deleted file mode 100644 index 6281e1649656..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/GetJob.json +++ /dev/null @@ -1,61 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "jobName": "demo_job", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-03-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/jobs/demo_job", - "name": "job", - "type": "Microsoft.BatchAI/Jobs", - "properties": { - "priority": 0, - "cluster": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/clusters/demo_cluster" - }, - "nodeCount": 1, - "containerSettings": { - "imageSourceRegistry": { - "image": "ubuntu" - } - }, - "toolType": "custom", - "customToolkitSettings": { - "commandLine": "echo hi | tee $AZ_BATCHAI_OUTPUT_OUTPUTS/hi.txt" - }, - "stdOutErrPathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles", - "jobOutputDirectoryPathSegment": "00000000-0000-0000-0000-000000000000/demo_resource_group/jobs/demo_job/00000000-0000-0000-0000-000000000000", - "inputDirectories": [ - { - "id": "INPUT", - "path": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/input" - } - ], - "outputDirectories": [ - { - "id": "OUTPUTS", - "pathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/", - "pathSuffix": "files", - "type": "custom", - "createNew": true - } - ], - "constraints": { - "maxWallClockTime": "P7D" - }, - "creationTime": "2017-09-27T23:36:52.611Z", - "provisioningState": "succeeded", - "provisioningStateTransitionTime": "2017-09-27T23:36:53.701Z", - "executionState": "running", - "executionStateTransitionTime": "2017-09-27T23:36:56.395Z", - "executionInfo": { - "startTime": "2017-09-27T23:36:54.115Z" - } - } - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/JobListRemoteLoginInfo.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/JobListRemoteLoginInfo.json deleted file mode 100644 index 67825475ed81..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/JobListRemoteLoginInfo.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "jobName": "demo_job", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-03-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "nodeId": "tvm-3601533753_1-20170719t162906z", - "ipAddress": "13.84.190.124", - "port": 50000 - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/ListCluster.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/ListCluster.json deleted file mode 100644 index 67401ac4bcf3..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/ListCluster.json +++ /dev/null @@ -1,68 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-03-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/clusters/demo_cluster", - "name": "demo_cluster", - "type": "Microsoft.BatchAI/Clusters", - "location": "eastus", - "properties": { - "provisioningState": "succeeded", - "allocationState": "resizing", - "creationTime": "2017-09-27T22:28:07.645Z", - "allocationStateTransitionTime": "2017-09-27T22:28:08.998Z", - "provisioningStateTransitionTime": "2017-09-27T22:28:08.327Z", - "vmSize": "STANDARD_NC6", - "currentNodeCount": 0, - "nodeStateCounts": { - "runningNodeCount": 0, - "idleNodeCount": 0, - "unusableNodeCount": 0, - "preparingNodeCount": 0, - "leavingNodeCount": 0 - }, - "vmPriority": "dedicated", - "scaleSettings": { - "manual": { - "targetNodeCount": 1, - "nodeDeallocationOption": "requeue" - } - }, - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "UbuntuServer", - "sku": "16.04-LTS", - "version": "latest" - } - }, - "userAccountSettings": { - "adminUserName": "admin_user_name" - }, - "nodeSetup": { - "mountVolumes": { - "azureFileShares": [ - { - "accountName": "storage_account_name", - "azureFileUrl": "https://storage_account_name.file.core.windows.net/azure_file_share_name", - "credentials": {}, - "relativeMountPath": "azfiles", - "fileMode": "0777", - "directoryMode": "0777" - } - ] - } - } - } - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/ListClusterByResourceGroup.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/ListClusterByResourceGroup.json deleted file mode 100644 index acded1f180c8..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/ListClusterByResourceGroup.json +++ /dev/null @@ -1,69 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-03-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/clusters/demo_cluster", - "name": "demo_cluster", - "type": "Microsoft.BatchAI/Clusters", - "location": "eastus", - "properties": { - "provisioningState": "succeeded", - "allocationState": "resizing", - "creationTime": "2017-09-27T22:28:07.645Z", - "allocationStateTransitionTime": "2017-09-27T22:28:08.998Z", - "provisioningStateTransitionTime": "2017-09-27T22:28:08.327Z", - "vmSize": "STANDARD_NC6", - "currentNodeCount": 0, - "nodeStateCounts": { - "runningNodeCount": 0, - "idleNodeCount": 0, - "unusableNodeCount": 0, - "preparingNodeCount": 0, - "leavingNodeCount": 0 - }, - "vmPriority": "dedicated", - "scaleSettings": { - "manual": { - "targetNodeCount": 1, - "nodeDeallocationOption": "requeue" - } - }, - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "UbuntuServer", - "sku": "16.04-LTS", - "version": "latest" - } - }, - "userAccountSettings": { - "adminUserName": "admin_user_name" - }, - "nodeSetup": { - "mountVolumes": { - "azureFileShares": [ - { - "accountName": "storage_account_name", - "azureFileUrl": "https://storage_account_name.file.core.windows.net/azure_file_share_name", - "credentials": {}, - "relativeMountPath": "azfiles", - "fileMode": "0777", - "directoryMode": "0777" - } - ] - } - } - } - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/ListFileServer.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/ListFileServer.json deleted file mode 100644 index 6f30672681f6..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/ListFileServer.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-03-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/fileservers/fileservercedd134b", - "name": "fileservercedd134b", - "type": "Microsoft.BatchAI/FileServers", - "location": "eastus", - "properties": { - "provisioningState": "succeeded", - "creationTime": "2017-09-27T21:45:28.159Z", - "provisioningStateTransitionTime": "2017-09-27T21:49:25.416Z", - "vmSize": "STANDARD_NC6", - "sshConfiguration": { - "userAccountSettings": { - "adminUserName": "admin_user_name" - } - }, - "dataDisks": { - "diskSizeInGB": 10, - "cachingType": "none", - "diskCount": 2, - "storageAccountType": "Standard_LRS" - }, - "subnet": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.Network/virtualNetworks/7feb1976-8c31-4f1f-bea2-86cb1839a7bavnet/subnets/Subnet-1" - }, - "mountSettings": { - "mountPoint": "/mnt/data", - "fileServerPublicIP": "13.90.141.66", - "fileServerInternalIP": "10.0.0.4", - "fileServerType": "nfs" - } - } - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/ListFileServerByResourceGroup.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/ListFileServerByResourceGroup.json deleted file mode 100644 index f55e77a9ba96..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/ListFileServerByResourceGroup.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-03-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/fileservers/fileservercedd134b", - "name": "fileservercedd134b", - "type": "Microsoft.BatchAI/FileServers", - "location": "eastus", - "properties": { - "provisioningState": "succeeded", - "creationTime": "2017-09-27T21:45:28.159Z", - "provisioningStateTransitionTime": "2017-09-27T21:49:25.416Z", - "vmSize": "STANDARD_NC6", - "sshConfiguration": { - "userAccountSettings": { - "adminUserName": "admin_user_name" - } - }, - "dataDisks": { - "diskSizeInGB": 10, - "cachingType": "none", - "diskCount": 2, - "storageAccountType": "Standard_LRS" - }, - "subnet": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.Network/virtualNetworks/7feb1976-8c31-4f1f-bea2-86cb1839a7bavnet/subnets/Subnet-1" - }, - "mountSettings": { - "mountPoint": "/mnt/data", - "fileServerPublicIP": "13.90.141.66", - "fileServerInternalIP": "10.0.0.4", - "fileServerType": "nfs" - } - } - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/ListJob.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/ListJob.json deleted file mode 100644 index aabab623bf5b..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/ListJob.json +++ /dev/null @@ -1,62 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-03-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/jobs/job", - "name": "job", - "type": "Microsoft.BatchAI/Jobs", - "properties": { - "priority": 0, - "cluster": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/clusters/demo_cluster" - }, - "nodeCount": 1, - "containerSettings": { - "imageSourceRegistry": { - "image": "ubuntu" - } - }, - "toolType": "custom", - "customToolkitSettings": { - "commandLine": "echo hi | tee $AZ_BATCHAI_OUTPUT_OUTPUTS/hi.txt" - }, - "stdOutErrPathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles", - "inputDirectories": [ - { - "id": "INPUT", - "path": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/input" - } - ], - "outputDirectories": [ - { - "id": "OUTPUTS", - "pathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/", - "pathSuffix": "files", - "type": "custom", - "createNew": true - } - ], - "constraints": { - "maxWallClockTime": "P7D" - }, - "creationTime": "2017-09-27T23:36:52.611Z", - "provisioningState": "succeeded", - "provisioningStateTransitionTime": "2017-09-27T23:36:53.701Z", - "executionState": "running", - "executionStateTransitionTime": "2017-09-27T23:36:56.395Z", - "executionInfo": { - "startTime": "2017-09-27T23:36:54.115Z" - } - } - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/ListJobByResourceGroup.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/ListJobByResourceGroup.json deleted file mode 100644 index f6af04715932..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/ListJobByResourceGroup.json +++ /dev/null @@ -1,63 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-03-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/jobs/job", - "name": "job", - "type": "Microsoft.BatchAI/Jobs", - "properties": { - "priority": 0, - "cluster": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/clusters/demo_cluster" - }, - "nodeCount": 1, - "containerSettings": { - "imageSourceRegistry": { - "image": "ubuntu" - } - }, - "toolType": "custom", - "customToolkitSettings": { - "commandLine": "echo hi | tee $AZ_BATCHAI_OUTPUT_OUTPUTS/hi.txt" - }, - "stdOutErrPathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles", - "inputDirectories": [ - { - "id": "INPUT", - "path": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/input" - } - ], - "outputDirectories": [ - { - "id": "OUTPUTS", - "pathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/", - "pathSuffix": "files", - "type": "custom", - "createNew": true - } - ], - "constraints": { - "maxWallClockTime": "P7D" - }, - "creationTime": "2017-09-27T23:36:52.611Z", - "provisioningState": "succeeded", - "provisioningStateTransitionTime": "2017-09-27T23:36:53.701Z", - "executionState": "running", - "executionStateTransitionTime": "2017-09-27T23:36:56.395Z", - "executionInfo": { - "startTime": "2017-09-27T23:36:54.115Z" - } - } - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/ListOutputFiles.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/ListOutputFiles.json deleted file mode 100644 index 1ca937d3da47..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/ListOutputFiles.json +++ /dev/null @@ -1,57 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "jobName": "demo_job", - "outputdirectoryid": "stdouterr", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-03-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "stderr-job_prep.txt", - "isDirectory": false, - "downloadUrl": "https://storage_account_name.file.core.windows.net/share/00000000-0000-0000-0000-000000000000/test_mgmt_batchai_jobs_test_job_preparation_hoste0e613b6/jobs/job/host_prep_stderr.txt?sv=2016-05-31&sr=f&sig=CNPJmjDQT9Anld9%2FdnQ52ZBpfOff2el8r4el6J%2BnpJE%3D&se=2017-09-28T01%3A22%3A35Z&sp=rl", - "properties": { - "lastModified": "2017-09-28T00:22:19Z", - "contentLength": 0 - } - }, - { - "name": "stdout-job_prep.txt", - "isDirectory": false, - "downloadUrl": "https://storage_account_name.file.core.windows.net/share/00000000-0000-0000-0000-000000000000/test_mgmt_batchai_jobs_test_job_preparation_hoste0e613b6/jobs/job/host_prep_stdout.txt?sv=2016-05-31&sr=f&sig=yK%2F5acWSTdcmBZGGL9%2F3IqeZ7N%2B1sRXfwB%2FaCkoRS%2Bc%3D&se=2017-09-28T01%3A22%3A35Z&sp=rl", - "properties": { - "lastModified": "2017-09-28T00:22:19Z", - "contentLength": 720 - } - }, - { - "name": "stderr.txt", - "isDirectory": false, - "downloadUrl": "https://storage_account_name.file.core.windows.net/share/00000000-0000-0000-0000-000000000000/test_mgmt_batchai_jobs_test_job_preparation_hoste0e613b6/jobs/job/stderr.txt?sv=2016-05-31&sr=f&sig=TdvHhdQjvWWA0Z7aPb0oZpPgGbBPOyDarNXWHFnRS3c%3D&se=2017-09-28T01%3A22%3A35Z&sp=rl", - "properties": { - "lastModified": "2017-09-28T00:22:19Z", - "contentLength": 0 - } - }, - { - "name": "stdout.txt", - "isDirectory": false, - "downloadUrl": "https://storage_account_name.file.core.windows.net/share/00000000-0000-0000-0000-000000000000/test_mgmt_batchai_jobs_test_job_preparation_hoste0e613b6/jobs/job/stdout.txt?sv=2016-05-31&sr=f&sig=nyydEjNnYpQfovknJc%2B5G%2F05g0IV4acWKlfkM35lh00%3D&se=2017-09-28T01%3A22%3A35Z&sp=rl", - "properties": { - "lastModified": "2017-09-28T00:22:19Z", - "contentLength": 32 - } - }, - { - "name": "counters", - "isDirectory": true - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/ListUsages.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/ListUsages.json deleted file mode 100644 index 9de24fc8f343..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/ListUsages.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "location": "eastus", - "api-version": "2018-03-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "unit": "Count", - "currentValue": 51, - "limit": 250, - "name": { - "value": "Number of Active Jobs", - "localizedValue": "Number of Active Jobs" - } - }, - { - "unit": "Count", - "currentValue": 0, - "limit": 250, - "name": { - "value": "Number of Clusters", - "localizedValue": "Number of Clusters" - } - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/OperationList.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/OperationList.json deleted file mode 100644 index 6c3b8dbf3dc0..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/OperationList.json +++ /dev/null @@ -1,133 +0,0 @@ -{ - "parameters": { - "api-version": "2018-03-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Microsoft.BatchAI/clusters/read", - "display": { - "provider": "Microsoft Batch AI", - "resource": "Batch AI Clusters", - "operation": "List or get Batch AI clusters", - "description": "Lists Batch AI clusters or gets the properties of a Batch AI cluster" - }, - "origin": "user,system" - }, - { - "name": "Microsoft.BatchAI/clusters/write", - "display": { - "provider": "Microsoft Batch AI", - "resource": "Batch AI Clusters", - "operation": "Create or update Batch AI cluster", - "description": "Creates a new Batch AI cluster or updates an existing Batch AI cluster" - }, - "origin": "user,system" - }, - { - "name": "Microsoft.BatchAI/clusters/delete", - "display": { - "provider": "Microsoft Batch AI", - "resource": "Batch AI Clusters", - "operation": "Delete Batch AI cluster", - "description": "Deletes a Batch AI cluster" - }, - "origin": "user,system" - }, - { - "name": "Microsoft.BatchAI/clusters/listRemoteLoginInformation", - "display": { - "provider": "Microsoft Batch AI", - "resource": "Batch AI Clusters", - "operation": "List Batch AI cluster remote-login information", - "description": "Lists remote-login information for a Batch AI cluster" - }, - "origin": "user,system" - }, - { - "name": "Microsoft.BatchAI/jobs/read", - "display": { - "provider": "Microsoft Batch AI", - "resource": "Batch AI Jobs", - "operation": "List or get Batch AI jobs", - "description": "Lists Batch AI jobs or gets the properties of a Batch AI job" - }, - "origin": "user,system" - }, - { - "name": "Microsoft.BatchAI/jobs/write", - "display": { - "provider": "Microsoft Batch AI", - "resource": "Batch AI Jobs", - "operation": "Create or update Batch AI job", - "description": "Creates a new Batch AI job or updates an existing Batch AI job" - }, - "origin": "user,system" - }, - { - "name": "Microsoft.BatchAI/jobs/delete", - "display": { - "provider": "Microsoft Batch AI", - "resource": "Batch AI Jobs", - "operation": "Delete Batch AI job", - "description": "Deletes a Batch AI job" - }, - "origin": "user,system" - }, - { - "name": "Microsoft.BatchAI/jobs/terminate/action", - "display": { - "provider": "Microsoft Batch AI", - "resource": "Batch AI Jobs", - "operation": "Terminate Batch AI job", - "description": "Terminates a Batch AI job" - }, - "origin": "user,system" - }, - { - "name": "Microsoft.BatchAI/jobs/listRemoteLoginInformation", - "display": { - "provider": "Microsoft Batch AI", - "resource": "Batch AI Jobs", - "operation": "List Batch AI job remote-login information", - "description": "Lists remote-login information for a Batch AI job" - }, - "origin": "user,system" - }, - { - "name": "Microsoft.BatchAI/fileservers/read", - "display": { - "provider": "Microsoft Batch AI", - "resource": "Batch AI Fileservers", - "operation": "List or get Batch AI fileservers", - "description": "Lists Batch AI fileservers or gets the properties of a Batch AI fileserver" - }, - "origin": "user,system" - }, - { - "name": "Microsoft.BatchAI/fileservers/write", - "display": { - "provider": "Microsoft Batch AI", - "resource": "Batch AI Fileservers", - "operation": "Create or update Batch AI fileserver", - "description": "Creates a new Batch AI fileserver or updates an existing Batch AI fileserver" - }, - "origin": "user,system" - }, - { - "name": "Microsoft.BatchAI/fileservers/delete", - "display": { - "provider": "Microsoft Batch AI", - "resource": "Batch AI Fileservers", - "operation": "Delete Batch AI filserver", - "description": "Deletes a Batch AI fileserver" - }, - "origin": "user,system" - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/PatchCluster.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/PatchCluster.json deleted file mode 100644 index 10671d95be32..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/PatchCluster.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "clusterName": "demo_cluster", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-03-01", - "parameters": { - "properties": { - "scaleSettings": { - "autoScale": { - "minimumNodeCount": 0, - "maximumNodeCount": 10 - } - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/clusters/demo_cluster", - "name": "demo_cluster", - "type": "Microsoft.BatchAI/Clusters", - "location": "eastus", - "properties": { - "provisioningState": "succeeded", - "allocationState": "steady", - "creationTime": "2017-09-27T21:43:55.215Z", - "allocationStateTransitionTime": "2017-09-27T21:43:57.664Z", - "provisioningStateTransitionTime": "2017-09-27T21:43:56.238Z", - "vmSize": "STANDARD_NC6", - "currentNodeCount": 0, - "nodeStateCounts": { - "runningNodeCount": 0, - "idleNodeCount": 0, - "unusableNodeCount": 0, - "preparingNodeCount": 0, - "leavingNodeCount": 0 - }, - "vmPriority": "dedicated", - "scaleSettings": { - "autoScale": { - "minimumNodeCount": 0, - "maximumNodeCount": 10, - "initialNodeCount": 0 - } - }, - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "UbuntuServer", - "sku": "16.04-LTS", - "version": "latest" - } - }, - "userAccountSettings": { - "adminUserName": "admin_user_name" - }, - "nodeSetup": { - "mountVolumes": { - "azureFileShares": [ - { - "accountName": "storage_account_name", - "azureFileUrl": "https://storage_account_name.file.core.windows.net/azure_file_share_name", - "credentials": {}, - "relativeMountPath": "azfiles", - "fileMode": "0777", - "directoryMode": "0777" - } - ] - } - } - } - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/PutCluster.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/PutCluster.json deleted file mode 100644 index 8f4bbfcb6778..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/PutCluster.json +++ /dev/null @@ -1,127 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "clusterName": "demo_cluster", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-03-01", - "parameters": { - "location": "eastus", - "properties": { - "scaleSettings": { - "manual": { - "nodeDeallocationOption": "requeue", - "targetNodeCount": 1 - } - }, - "userAccountSettings": { - "adminUserPassword": "admin_user_password", - "adminUserSshPublicKey": "ssh-rsa AAAAB3NzaC1yc...", - "adminUserName": "admin_user_name" - }, - "nodeSetup": { - "mountVolumes": { - "fileServers": [ - { - "fileServer": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/fileservers/fileservercedd134b" - }, - "mountOptions": "rw", - "relativeMountPath": "nfs" - } - ], - "azureFileShares": [ - { - "relativeMountPath": "azfiles", - "directoryMode": "0777", - "accountName": "storage_account_name", - "azureFileUrl": "https://storage_account_name.file.core.windows.net/azure_file_share_name", - "fileMode": "0777", - "credentials": { - "accountKey": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000==" - } - } - ] - } - }, - "vmPriority": "dedicated", - "vmSize": "STANDARD_NC6" - } - } - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2018-03-01", - "Retry-After": 15 - } - }, - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/clusters/demo_cluster", - "name": "demo_cluster", - "type": "Microsoft.BatchAI/Clusters", - "location": "eastus", - "properties": { - "provisioningState": "succeeded", - "allocationState": "resizing", - "creationTime": "2017-09-27T21:50:02.377Z", - "allocationStateTransitionTime": "2017-09-27T21:50:04.521Z", - "provisioningStateTransitionTime": "2017-09-27T21:50:03.828Z", - "vmSize": "STANDARD_NC6", - "currentNodeCount": 0, - "nodeStateCounts": { - "runningNodeCount": 0, - "idleNodeCount": 0, - "unusableNodeCount": 0, - "preparingNodeCount": 0, - "leavingNodeCount": 0 - }, - "vmPriority": "dedicated", - "scaleSettings": { - "manual": { - "targetNodeCount": 1, - "nodeDeallocationOption": "requeue" - } - }, - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "UbuntuServer", - "sku": "16.04-LTS", - "version": "latest" - } - }, - "userAccountSettings": { - "adminUserName": "admin_user_name" - }, - "nodeSetup": { - "mountVolumes": { - "azureFileShares": [ - { - "accountName": "storage_account_name", - "azureFileUrl": "https://storage_account_name.file.core.windows.net/azure_file_share_name", - "credentials": {}, - "relativeMountPath": "azfiles", - "fileMode": "0777", - "directoryMode": "0777" - } - ], - "fileServers": [ - { - "fileServer": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/fileservers/fileservercedd134b" - }, - "relativeMountPath": "nfs", - "mountOptions": "rw" - } - ] - } - }, - "subnet": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.Network/virtualNetworks/7feb1976-8c31-4f1f-bea2-86cb1839a7bavnet/subnets/Subnet-1" - } - } - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/PutFileServer.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/PutFileServer.json deleted file mode 100644 index f319ee74030f..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/PutFileServer.json +++ /dev/null @@ -1,67 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "fileServerName": "demo_nfs", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-03-01", - "parameters": { - "location": "eastus", - "properties": { - "sshConfiguration": { - "userAccountSettings": { - "adminUserPassword": "admin_user_password", - "adminUserName": "admin_user_name" - } - }, - "dataDisks": { - "diskSizeInGB": 10, - "storageAccountType": "Standard_LRS", - "diskCount": 2 - }, - "vmSize": "STANDARD_NC6" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/fileservers/fileservercedd134b", - "name": "demo_nfs", - "type": "Microsoft.BatchAI/FileServers", - "location": "eastus", - "properties": { - "provisioningState": "succeeded", - "creationTime": "2017-09-27T21:45:28.159Z", - "provisioningStateTransitionTime": "2017-09-27T21:49:25.416Z", - "vmSize": "STANDARD_NC6", - "sshConfiguration": { - "userAccountSettings": { - "adminUserName": "admin_user_name" - } - }, - "dataDisks": { - "diskSizeInGB": 10, - "cachingType": "none", - "diskCount": 2, - "storageAccountType": "Standard_LRS" - }, - "subnet": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.Network/virtualNetworks/7feb1976-8c31-4f1f-bea2-86cb1839a7bavnet/subnets/Subnet-1" - }, - "mountSettings": { - "mountPoint": "/mnt/data", - "fileServerPublicIP": "13.90.141.66", - "fileServerInternalIP": "10.0.0.4", - "fileServerType": "nfs" - } - } - } - }, - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2018-03-01", - "Retry-After": 15 - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/PutJob.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/PutJob.json deleted file mode 100644 index ac859e204b25..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/PutJob.json +++ /dev/null @@ -1,100 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "jobName": "demo_job", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-03-01", - "parameters": { - "location": "eastus", - "properties": { - "stdOutErrPathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles", - "cluster": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/clusters/demo_cluster" - }, - "nodeCount": 1, - "customToolkitSettings": { - "commandLine": "echo hi | tee $AZ_BATCHAI_OUTPUT_OUTPUTS/hi.txt" - }, - "inputDirectories": [ - { - "id": "INPUT", - "path": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/input" - } - ], - "priority": 0, - "containerSettings": { - "imageSourceRegistry": { - "image": "ubuntu" - } - }, - "outputDirectories": [ - { - "pathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/", - "type": "custom", - "id": "OUTPUTS", - "pathSuffix": "files", - "createNew": true - } - ] - } - } - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2018-03-01", - "Retry-After": 15 - } - }, - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/jobs/demo_job", - "name": "demo_job", - "type": "Microsoft.BatchAI/Job", - "properties": { - "priority": 0, - "cluster": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/clusters/demo_cluster" - }, - "nodeCount": 1, - "containerSettings": { - "imageSourceRegistry": { - "image": "ubuntu" - } - }, - "toolType": "custom", - "customToolkitSettings": { - "commandLine": "echo hi | tee $AZ_BATCHAI_OUTPUT_OUTPUTS/hi.txt" - }, - "stdOutErrPathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles", - "inputDirectories": [ - { - "id": "INPUT", - "path": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/input" - } - ], - "outputDirectories": [ - { - "id": "OUTPUTS", - "pathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/", - "pathSuffix": "files", - "type": "custom", - "createNew": true - } - ], - "constraints": { - "maxWallClockTime": "P7D" - }, - "creationTime": "2017-09-27T23:36:52.611Z", - "provisioningState": "succeeded", - "provisioningStateTransitionTime": "2017-09-27T23:36:53.701Z", - "executionState": "running", - "executionStateTransitionTime": "2017-09-27T23:36:56.395Z", - "executionInfo": { - "startTime": "2017-09-27T23:36:54.115Z" - } - } - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/TerminateJob.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/TerminateJob.json deleted file mode 100644 index 7413be5ca3af..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/examples/TerminateJob.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "jobName": "demo_job", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-03-01" - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2018-03-01", - "Retry-After": 15 - } - }, - "200": {} - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/BatchAI.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/BatchAI.json deleted file mode 100644 index 2d368c2751f1..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/BatchAI.json +++ /dev/null @@ -1,3859 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "BatchAI", - "description": "The Azure BatchAI Management API.", - "version": "2018-05-01", - "x-ms-code-generation-settings": { - "name": "BatchAIManagementClient" - } - }, - "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.BatchAI/operations": { - "get": { - "tags": [ - "Operations" - ], - "operationId": "Operations_List", - "description": "Lists available operations for the Microsoft.BatchAI provider.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Create or update cluster": { - "$ref": "./examples/ListOperation.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.BatchAI/locations/{location}/usages": { - "get": { - "tags": [ - "Usage" - ], - "operationId": "Usages_List", - "description": "Gets the current usage information as well as limits for Batch AI resources for given subscription.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The location for which resource usage is queried.", - "pattern": "^[-\\w\\._]+$" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ListUsagesResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Create or update cluster": { - "$ref": "./examples/ListUsages.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.BatchAI/workspaces": { - "get": { - "tags": [ - "Workspace" - ], - "operationId": "Workspaces_List", - "description": "Gets a list of Workspaces associated with the given subscription.", - "parameters": [ - { - "$ref": "#/parameters/MaxResultsParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains a formatted list of workspaces and their properties.", - "schema": { - "$ref": "#/definitions/WorkspaceListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List file servers": { - "$ref": "./examples/ListWorkspace.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/workspaces": { - "get": { - "tags": [ - "Workspace" - ], - "operationId": "Workspaces_ListByResourceGroup", - "description": "Gets a list of Workspaces within the specified resource group.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/MaxResultsParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains a list of workspaces within the resource group.", - "schema": { - "$ref": "#/definitions/WorkspaceListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List workspaces": { - "$ref": "./examples/ListWorkspaceByResourceGroup.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/workspaces/{workspaceName}": { - "put": { - "tags": [ - "Workspace" - ], - "operationId": "Workspaces_Create", - "description": "Creates a Workspace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/WorkspaceCreateParameters" - }, - "description": "Workspace creation parameters." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains the workspace entity.", - "schema": { - "$ref": "#/definitions/Workspace" - } - }, - "202": { - "description": "The operation will be completed asynchronously." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Create a workspace": { - "$ref": "./examples/PutWorkspace.json" - } - } - }, - "patch": { - "tags": [ - "Workspace" - ], - "operationId": "Workspaces_Update", - "description": "Updates properties of a Workspace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/WorkspaceUpdateParameters" - }, - "description": "Additional parameters for workspace update." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains the Workspace entity.", - "schema": { - "$ref": "#/definitions/Workspace" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-examples": { - "Update workspace tags": { - "$ref": "./examples/PatchWorkspace.json" - } - } - }, - "delete": { - "tags": [ - "Workspace" - ], - "operationId": "Workspaces_Delete", - "description": "Deletes a Workspace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful." - }, - "202": { - "description": "The operation will be completed asynchronously." - }, - "204": { - "description": "No content." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Delete a workspace": { - "$ref": "./examples/DeleteWorkspace.json" - } - } - }, - "get": { - "tags": [ - "Workspace" - ], - "operationId": "Workspaces_Get", - "description": "Gets information about a Workspace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains information about the Workspace.", - "schema": { - "$ref": "#/definitions/Workspace" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-examples": { - "Get a workspace information": { - "$ref": "./examples/GetWorkspace.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/workspaces/{workspaceName}/experiments": { - "get": { - "tags": [ - "Experiment" - ], - "operationId": "Experiments_ListByWorkspace", - "description": "Gets a list of Experiments within the specified Workspace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/MaxResultsParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains a list of experiments within the workspace.", - "schema": { - "$ref": "#/definitions/ExperimentListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List experiments": { - "$ref": "./examples/ListExperimentByWorkspace.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/workspaces/{workspaceName}/experiments/{experimentName}": { - "put": { - "tags": [ - "Experiment" - ], - "operationId": "Experiments_Create", - "description": "Creates an Experiment.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ExperimentNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains the experiment entity.", - "schema": { - "$ref": "#/definitions/Experiment" - } - }, - "202": { - "description": "The operation will be completed asynchronously." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Create an experiment": { - "$ref": "./examples/PutExperiment.json" - } - } - }, - "delete": { - "tags": [ - "Experiment" - ], - "operationId": "Experiments_Delete", - "description": "Deletes an Experiment.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ExperimentNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful." - }, - "202": { - "description": "The operation will be completed asynchronously." - }, - "204": { - "description": "No content." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Delete an experiment": { - "$ref": "./examples/DeleteExperiment.json" - } - } - }, - "get": { - "tags": [ - "Experiment" - ], - "operationId": "Experiments_Get", - "description": "Gets information about an Experiment.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ExperimentNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains information about the experiment.", - "schema": { - "$ref": "#/definitions/Experiment" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-examples": { - "Get an experiment information": { - "$ref": "./examples/GetExperiment.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/workspaces/{workspaceName}/experiments/{experimentName}/jobs": { - "get": { - "tags": [ - "Job" - ], - "operationId": "Jobs_ListByExperiment", - "description": "Gets a list of Jobs within the specified Experiment.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ExperimentNameParameter" - }, - { - "$ref": "#/parameters/MaxResultsParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains a list of ExperimentJob entities associated with the experiment.", - "schema": { - "$ref": "#/definitions/JobListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List jobs in an experiment": { - "$ref": "./examples/ListJobByExperiment.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/workspaces/{workspaceName}/experiments/{experimentName}/jobs/{jobName}": { - "put": { - "tags": [ - "Job" - ], - "operationId": "Jobs_Create", - "description": "Creates a Job in the given Experiment.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ExperimentNameParameter" - }, - { - "$ref": "#/parameters/JobNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/JobCreateParameters" - }, - "description": "The parameters to provide for job creation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains the job entity.", - "schema": { - "$ref": "#/definitions/Job" - } - }, - "202": { - "description": "The operation will be completed asynchronously." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Create a job": { - "$ref": "./examples/PutJob.json" - } - } - }, - "delete": { - "tags": [ - "Job" - ], - "operationId": "Jobs_Delete", - "description": "Deletes a Job.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ExperimentNameParameter" - }, - { - "$ref": "#/parameters/JobNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful." - }, - "202": { - "description": "The operation will be completed asynchronously." - }, - "204": { - "description": "No content." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Delete a job": { - "$ref": "./examples/DeleteJob.json" - } - } - }, - "get": { - "tags": [ - "Job" - ], - "operationId": "Jobs_Get", - "description": "Gets information about a Job.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ExperimentNameParameter" - }, - { - "$ref": "#/parameters/JobNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains the Job entity.", - "schema": { - "$ref": "#/definitions/Job" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-examples": { - "Get job's information": { - "$ref": "./examples/GetJob.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/workspaces/{workspaceName}/experiments/{experimentName}/jobs/{jobName}/listOutputFiles": { - "post": { - "tags": [ - "Job" - ], - "operationId": "Jobs_ListOutputFiles", - "description": "List all directories and files inside the given directory of the Job's output directory (if the output directory is on Azure File Share or Azure Storage Container).", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ExperimentNameParameter" - }, - { - "$ref": "#/parameters/JobNameParameter" - }, - { - "$ref": "#/parameters/OutputDirectoryIdParameter" - }, - { - "$ref": "#/parameters/Directory" - }, - { - "$ref": "#/parameters/DownloadLinkExpiryParameter" - }, - { - "$ref": "#/parameters/MaxResultsParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains the list of files.", - "schema": { - "$ref": "#/definitions/FileListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List a job's files": { - "$ref": "./examples/ListOutputFiles.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/workspaces/{workspaceName}/experiments/{experimentName}/jobs/{jobName}/listRemoteLoginInformation": { - "post": { - "tags": [ - "Job" - ], - "operationId": "Jobs_ListRemoteLoginInformation", - "description": "Gets a list of currently existing nodes which were used for the Job execution. The returned information contains the node ID, its public IP and SSH port.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ExperimentNameParameter" - }, - { - "$ref": "#/parameters/JobNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains compute node remote login information.", - "schema": { - "$ref": "#/definitions/RemoteLoginInformationListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Get information about nodes which ran a job": { - "$ref": "./examples/JobListRemoteLoginInfo.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/workspaces/{workspaceName}/experiments/{experimentName}/jobs/{jobName}/terminate": { - "post": { - "tags": [ - "Job" - ], - "operationId": "Jobs_Terminate", - "description": "Terminates a job.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ExperimentNameParameter" - }, - { - "$ref": "#/parameters/JobNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful." - }, - "202": { - "description": "The operation will be completed asynchronously." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Terminate a job": { - "$ref": "./examples/TerminateJob.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/workspaces/{workspaceName}/fileServers/{fileServerName}": { - "put": { - "tags": [ - "FileServer" - ], - "operationId": "FileServers_Create", - "description": "Creates a File Server in the given workspace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/FileServerNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/FileServerCreateParameters" - }, - "description": "The parameters to provide for File Server creation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains the file server entity.", - "schema": { - "$ref": "#/definitions/FileServer" - } - }, - "202": { - "description": "The operation will be completed asynchronously." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Create a file server": { - "$ref": "./examples/PutFileServer.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/workspaces/{workspaceName}/fileServers": { - "get": { - "tags": [ - "FileServer" - ], - "operationId": "FileServers_ListByWorkspace", - "description": "Gets a list of File Servers associated with the specified workspace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/MaxResultsParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains a list of File Servers and their properties.", - "schema": { - "$ref": "#/definitions/FileServerListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Get a list of file servers": { - "$ref": "./examples/ListFileServerByWorkspace.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/workspaces/{workspaceName}/clusters/{clusterName}": { - "put": { - "tags": [ - "Cluster" - ], - "operationId": "Clusters_Create", - "description": "Creates a Cluster in the given Workspace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterCreateParameters" - }, - "description": "The parameters to provide for the Cluster creation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains the Cluster entity.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "202": { - "description": "The operation will be completed asynchronously." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Create a cluster": { - "$ref": "./examples/PutCluster.json" - } - } - }, - "patch": { - "tags": [ - "Cluster" - ], - "operationId": "Clusters_Update", - "description": "Updates properties of a Cluster.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterUpdateParameters" - }, - "description": "Additional parameters for cluster update." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains the Cluster entity.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-examples": { - "Resize a cluster": { - "$ref": "./examples/PatchCluster.json" - } - } - }, - "delete": { - "tags": [ - "Cluster" - ], - "operationId": "Clusters_Delete", - "description": "Deletes a Cluster.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful." - }, - "202": { - "description": "The operation will be completed asynchronously." - }, - "204": { - "description": "No content." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Delete a cluster": { - "$ref": "./examples/DeleteCluster.json" - } - } - }, - "get": { - "tags": [ - "Cluster" - ], - "operationId": "Clusters_Get", - "description": "Gets information about a Cluster.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains information about the Cluster.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-examples": { - "Get a cluster's information": { - "$ref": "./examples/GetCluster.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/workspaces/{workspaceName}/clusters/{clusterName}/listRemoteLoginInformation": { - "post": { - "tags": [ - "Cluster" - ], - "operationId": "Clusters_ListRemoteLoginInformation", - "description": "Get the IP address, port of all the compute nodes in the Cluster.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains the list of IP addresses.", - "schema": { - "$ref": "#/definitions/RemoteLoginInformationListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Get remote login information for a cluster's nodes ": { - "$ref": "./examples/ClusterListRemoteLoginInfo.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/workspaces/{workspaceName}/clusters": { - "get": { - "tags": [ - "Cluster" - ], - "operationId": "Clusters_ListByWorkspace", - "description": "Gets information about Clusters associated with the given Workspace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "#/parameters/MaxResultsParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation was successful. The response contains a list of Clusters and their properties.", - "schema": { - "$ref": "#/definitions/ClusterListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Get a list of cluster in a workspace": { - "$ref": "./examples/ListClusterByWorkspace.json" - } - } - } - } - }, - "definitions": { - "UsageName": { - "properties": { - "value": { - "readOnly": true, - "type": "string", - "description": "The name of the resource." - }, - "localizedValue": { - "readOnly": true, - "type": "string", - "description": "The localized name of the resource." - } - }, - "description": "The Usage Names." - }, - "Usage": { - "properties": { - "unit": { - "readOnly": true, - "type": "string", - "description": "An enum describing the unit of usage measurement.", - "enum": [ - "Count" - ], - "x-ms-enum": { - "name": "UsageUnit", - "modelAsString": true - } - }, - "currentValue": { - "readOnly": true, - "type": "integer", - "format": "int32", - "description": "The current usage of the resource." - }, - "limit": { - "readOnly": true, - "type": "integer", - "format": "int64", - "description": "The maximum permitted usage of the resource." - }, - "name": { - "readOnly": true, - "$ref": "#/definitions/UsageName", - "description": "The name of the type of usage." - } - }, - "description": "Describes Batch AI Resource Usage." - }, - "ListUsagesResult": { - "properties": { - "value": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/Usage" - }, - "description": "The list of compute resource usages." - }, - "nextLink": { - "readOnly": true, - "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." - } - }, - "description": "The List Usages operation response." - }, - "FileServerBaseProperties": { - "properties": { - "vmSize": { - "type": "string", - "title": "VM size.", - "description": "The size of the virtual machine for the File Server. For information about available VM sizes from the Virtual Machines Marketplace, see Sizes for Virtual Machines (Linux)." - }, - "sshConfiguration": { - "title": "SSH configuration.", - "description": "SSH configuration for the File Server node.", - "$ref": "#/definitions/SshConfiguration" - }, - "dataDisks": { - "title": "Data disks.", - "description": "Settings for the data disks which will be created for the File Server.", - "$ref": "#/definitions/DataDisks" - }, - "subnet": { - "title": "Subnet identifier.", - "description": "Identifier of an existing virtual network subnet to put the File Server in. If not provided, a new virtual network and subnet will be created.", - "$ref": "#/definitions/ResourceId" - } - }, - "required": [ - "vmSize", - "sshConfiguration", - "dataDisks" - ], - "description": "The properties of a file server." - }, - "FileServerListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/FileServer" - }, - "description": "The collection of File Servers." - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The continuation token." - } - }, - "description": "Values returned by the File Server List operation." - }, - "DataDisks": { - "properties": { - "diskSizeInGB": { - "type": "integer", - "format": "int32", - "readOnly": false, - "title": "Disk size in GB.", - "description": "Disk size in GB for the blank data disks." - }, - "cachingType": { - "type": "string", - "title": "Caching type.", - "description": "Caching type for the disks. Available values are none (default), readonly, readwrite. Caching type can be set only for VM sizes supporting premium storage.", - "default": "none", - "enum": [ - "none", - "readonly", - "readwrite" - ], - "x-ms-enum": { - "name": "CachingType", - "modelAsString": false - } - }, - "diskCount": { - "type": "integer", - "format": "int32", - "readOnly": false, - "title": "Number of data disks.", - "description": "Number of data disks attached to the File Server. If multiple disks attached, they will be configured in RAID level 0." - }, - "storageAccountType": { - "type": "string", - "readOnly": false, - "title": "Storage account type.", - "description": "Type of storage account to be used on the disk. Possible values are: Standard_LRS or Premium_LRS. Premium storage account type can only be used with VM sizes supporting premium storage.", - "enum": [ - "Standard_LRS", - "Premium_LRS" - ], - "x-ms-enum": { - "name": "StorageAccountType", - "modelAsString": true - } - } - }, - "required": [ - "diskSizeInGB", - "diskCount", - "storageAccountType" - ], - "description": "Data disks settings." - }, - "KeyVaultSecretReference": { - "properties": { - "sourceVault": { - "title": "Key Vault resource identifier.", - "description": "Fully qualified resource identifier of the Key Vault.", - "$ref": "#/definitions/ResourceId" - }, - "secretUrl": { - "type": "string", - "title": "Secret URL.", - "description": "The URL referencing a secret in the Key Vault." - } - }, - "required": [ - "sourceVault", - "secretUrl" - ], - "description": "Key Vault Secret reference." - }, - "MountSettings": { - "properties": { - "mountPoint": { - "type": "string", - "title": "Mount Point.", - "description": "Path where the data disks are mounted on the File Server." - }, - "fileServerPublicIP": { - "type": "string", - "title": "Public IP.", - "description": "Public IP address of the File Server which can be used to SSH to the node from outside of the subnet." - }, - "fileServerInternalIP": { - "type": "string", - "title": "Internal IP.", - "description": "Internal IP address of the File Server which can be used to access the File Server from within the subnet." - } - }, - "description": "File Server mount Information." - }, - "SshConfiguration": { - "properties": { - "publicIPsToAllow": { - "type": "array", - "items": { - "type": "string" - }, - "title": "Allowed public IPs.", - "description": "List of source IP ranges to allow SSH connection from. The default value is '*' (all source IPs are allowed). Maximum number of IP ranges that can be specified is 400." - }, - "userAccountSettings": { - "title": "User account settings.", - "description": "Settings for administrator user account to be created on a node. The account can be used to establish SSH connection to the node.", - "$ref": "#/definitions/UserAccountSettings" - } - }, - "required": [ - "userAccountSettings" - ], - "description": "SSH configuration." - }, - "FileServerCreateParameters": { - "properties": { - "properties": { - "$ref": "#/definitions/FileServerBaseProperties", - "description": "The properties of the File Server.", - "x-ms-client-flatten": true - } - }, - "description": "File Server creation parameters." - }, - "FileServerProperties": { - "properties": { - "vmSize": { - "type": "string", - "title": "VM size.", - "description": "VM size of the File Server." - }, - "sshConfiguration": { - "title": "SSH configuration.", - "description": "SSH configuration for accessing the File Server node.", - "$ref": "#/definitions/SshConfiguration" - }, - "dataDisks": { - "title": "Data disks configuration.", - "description": "Information about disks attached to File Server VM.", - "$ref": "#/definitions/DataDisks" - }, - "subnet": { - "title": "Subnet.", - "description": "File Server virtual network subnet resource ID.", - "$ref": "#/definitions/ResourceId" - }, - "mountSettings": { - "title": "Mount settings.", - "description": "File Server mount settings.", - "readOnly": true, - "$ref": "#/definitions/MountSettings" - }, - "provisioningStateTransitionTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "title": "Provisioning State Transition time.", - "description": "Time when the provisioning state was changed." - }, - "creationTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "title": "Creation time.", - "description": "Time when the FileServer was created." - }, - "provisioningState": { - "type": "string", - "readOnly": true, - "x-nullable": false, - "title": "Provisioning state.", - "description": "Provisioning state of the File Server. Possible values: creating - The File Server is getting created; updating - The File Server creation has been accepted and it is getting updated; deleting - The user has requested that the File Server be deleted, and it is in the process of being deleted; failed - The File Server creation has failed with the specified error code. Details about the error code are specified in the message field; succeeded - The File Server creation has succeeded.", - "enum": [ - "creating", - "updating", - "deleting", - "succeeded", - "failed" - ], - "x-ms-enum": { - "name": "FileServerProvisioningState", - "modelAsString": true - } - } - }, - "description": "File Server properties." - }, - "FileServer": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/FileServerProperties", - "description": "File Server properties." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "description": "File Server information." - }, - "ClusterBaseProperties": { - "properties": { - "vmSize": { - "type": "string", - "title": "VM size.", - "description": "The size of the virtual machines in the cluster. All nodes in a cluster have the same VM size. For information about available VM sizes for clusters using images from the Virtual Machines Marketplace see Sizes for Virtual Machines (Linux). Batch AI service supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)." - }, - "vmPriority": { - "type": "string", - "title": "VM priority.", - "description": "VM priority. Allowed values are: dedicated (default) and lowpriority.", - "default": "dedicated", - "enum": [ - "dedicated", - "lowpriority" - ], - "x-ms-enum": { - "name": "VmPriority", - "modelAsString": false - } - }, - "scaleSettings": { - "$ref": "#/definitions/ScaleSettings", - "title": "Scale settings.", - "description": "Scale settings for the cluster. Batch AI service supports manual and auto scale clusters." - }, - "virtualMachineConfiguration": { - "title": "VM configuration.", - "description": "OS image configuration for cluster nodes. All nodes in a cluster have the same OS image.", - "$ref": "#/definitions/VirtualMachineConfiguration" - }, - "nodeSetup": { - "title": "Node setup.", - "description": "Setup to be performed on each compute node in the cluster.", - "$ref": "#/definitions/NodeSetup" - }, - "userAccountSettings": { - "title": "User account settings.", - "description": "Settings for an administrator user account that will be created on each compute node in the cluster.", - "$ref": "#/definitions/UserAccountSettings" - }, - "subnet": { - "title": "Subnet.", - "description": "Existing virtual network subnet to put the cluster nodes in. Note, if a File Server mount configured in node setup, the File Server's subnet will be used automatically.", - "$ref": "#/definitions/ResourceId" - } - }, - "required": [ - "vmSize", - "userAccountSettings" - ], - "description": "The properties of a Cluster." - }, - "ClusterUpdateProperties": { - "properties": { - "scaleSettings": { - "$ref": "#/definitions/ScaleSettings", - "title": "Scale settings.", - "description": "Desired scale settings for the cluster. Batch AI service supports manual and auto scale clusters." - } - }, - "description": "The properties of a Cluster that need to be updated." - }, - "DeallocationOption": { - "type": "string", - "title": "Deallocation options.", - "description": "Actions which should be performed when compute nodes are removed from the cluster. Possible values are: requeue (default) - Terminate running jobs and requeue them so the jobs will run again. Remove compute nodes as soon as jobs have been terminated; terminate - Terminate running jobs. The jobs will not run again. Remove compute nodes as soon as jobs have been terminated. waitforjobcompletion - Allow currently running jobs to complete. Schedule no new jobs while waiting. Remove compute nodes when all jobs have completed.", - "default": "requeue", - "enum": [ - "requeue", - "terminate", - "waitforjobcompletion" - ], - "x-ms-enum": { - "name": "DeallocationOption", - "modelAsString": true - } - }, - "ScaleSettings": { - "properties": { - "manual": { - "$ref": "#/definitions/ManualScaleSettings", - "title": "Manual scale settings.", - "description": "Manual scale settings for the cluster." - }, - "autoScale": { - "$ref": "#/definitions/AutoScaleSettings", - "title": "Auto-scale settings.", - "description": "Auto-scale settings for the cluster." - } - }, - "description": "At least one of manual or autoScale settings must be specified. Only one of manual or autoScale settings can be specified. If autoScale settings are specified, the system automatically scales the cluster up and down (within the supplied limits) based on the pending jobs on the cluster." - }, - "AutoScaleSettings": { - "properties": { - "minimumNodeCount": { - "type": "integer", - "format": "int32", - "title": "Minimum node count.", - "description": "The minimum number of compute nodes the Batch AI service will try to allocate for the cluster. Note, the actual number of nodes can be less than the specified value if the subscription has not enough quota to fulfill the request." - }, - "maximumNodeCount": { - "type": "integer", - "format": "int32", - "title": "Maximum node count.", - "description": "The maximum number of compute nodes the cluster can have." - }, - "initialNodeCount": { - "type": "integer", - "format": "int32", - "title": "Initial node count.", - "description": "The number of compute nodes to allocate on cluster creation. Note that this value is used only during cluster creation. Default: 0.", - "default": 0 - } - }, - "required": [ - "minimumNodeCount", - "maximumNodeCount" - ], - "description": "Auto-scale settings for the cluster. The system automatically scales the cluster up and down (within minimumNodeCount and maximumNodeCount) based on the number of queued and running jobs assigned to the cluster." - }, - "ManualScaleSettings": { - "properties": { - "targetNodeCount": { - "type": "integer", - "format": "int32", - "title": "Target node count.", - "description": "The desired number of compute nodes in the Cluster. Default is 0.", - "default": 0 - }, - "nodeDeallocationOption": { - "title": "Node deallocation options.", - "description": "An action to be performed when the cluster size is decreasing. The default value is requeue.", - "default": "requeue", - "$ref": "#/definitions/DeallocationOption" - } - }, - "required": [ - "targetNodeCount" - ], - "description": "Manual scale settings for the cluster." - }, - "VirtualMachineConfiguration": { - "properties": { - "imageReference": { - "title": "Image reference.", - "description": "OS image reference for cluster nodes.", - "$ref": "#/definitions/ImageReference" - } - }, - "description": "VM configuration." - }, - "ImageReference": { - "properties": { - "publisher": { - "type": "string", - "title": "Publisher.", - "description": "Publisher of the image." - }, - "offer": { - "type": "string", - "title": "Offer.", - "description": "Offer of the image." - }, - "sku": { - "type": "string", - "title": "SKU.", - "description": "SKU of the image." - }, - "version": { - "type": "string", - "title": "Version.", - "description": "Version of the image." - }, - "virtualMachineImageId": { - "type": "string", - "title": "Custom VM image resource ID.", - "description": "The ARM resource identifier of the virtual machine image for the compute nodes. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}. The virtual machine image must be in the same region and subscription as the cluster. 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. Note, you need to provide publisher, offer and sku of the base OS image of which the custom image has been derived from." - } - }, - "required": [ - "publisher", - "offer", - "sku" - ], - "description": "The OS image reference." - }, - "NodeStateCounts": { - "properties": { - "idleNodeCount": { - "readOnly": true, - "type": "integer", - "format": "int32", - "title": "Idle node count.", - "description": "Number of compute nodes in idle state." - }, - "runningNodeCount": { - "readOnly": true, - "type": "integer", - "format": "int32", - "title": "Running node count.", - "description": "Number of compute nodes which are running jobs." - }, - "preparingNodeCount": { - "readOnly": true, - "type": "integer", - "format": "int32", - "title": "Preparing node count.", - "description": "Number of compute nodes which are being prepared." - }, - "unusableNodeCount": { - "readOnly": true, - "type": "integer", - "format": "int32", - "title": "Unusable node count.", - "description": "Number of compute nodes which are in unusable state." - }, - "leavingNodeCount": { - "readOnly": true, - "type": "integer", - "format": "int32", - "title": "Leaving node count.", - "description": "Number of compute nodes which are leaving the cluster." - } - }, - "description": "Counts of various compute node states on the cluster." - }, - "UserAccountSettings": { - "properties": { - "adminUserName": { - "type": "string", - "title": "User name.", - "description": "Name of the administrator user account which can be used to SSH to nodes." - }, - "adminUserSshPublicKey": { - "type": "string", - "title": "SSH public key.", - "description": "SSH public key of the administrator user account." - }, - "adminUserPassword": { - "type": "string", - "title": "Password.", - "description": "Password of the administrator user account." - } - }, - "required": [ - "adminUserName" - ], - "description": "Settings for user account that gets created on each on the nodes of a cluster." - }, - "PerformanceCountersSettings": { - "properties": { - "appInsightsReference": { - "title": "Azure Application Insights reference.", - "description": "Azure Application Insights information for performance counters reporting. If provided, Batch AI will upload node performance counters to the corresponding Azure Application Insights account.", - "$ref": "#/definitions/AppInsightsReference" - } - }, - "required": [ - "appInsightsReference" - ], - "description": "Performance counters reporting settings." - }, - "AppInsightsReference": { - "properties": { - "component": { - "title": "Component ID.", - "description": "Azure Application Insights component resource ID.", - "$ref": "#/definitions/ResourceId" - }, - "instrumentationKey": { - "type": "string", - "title": "Instrumentation Key.", - "description": "Value of the Azure Application Insights instrumentation key." - }, - "instrumentationKeySecretReference": { - "title": "Instrumentation key KeyVault Secret reference.", - "description": "KeyVault Store and Secret which contains Azure Application Insights instrumentation key. One of instrumentationKey or instrumentationKeySecretReference must be specified.", - "$ref": "#/definitions/KeyVaultSecretReference" - } - }, - "required": [ - "component" - ], - "description": "Azure Application Insights information for performance counters reporting." - }, - "NodeSetup": { - "properties": { - "setupTask": { - "title": "Setup task.", - "description": "Setup task to run on cluster nodes when nodes got created or rebooted. The setup task code needs to be idempotent. Generally the setup task is used to download static data that is required for all jobs that run on the cluster VMs and/or to download/install software.", - "$ref": "#/definitions/SetupTask" - }, - "mountVolumes": { - "title": "Mount volumes.", - "description": "Mount volumes to be available to setup task and all jobs executing on the cluster. The volumes will be mounted at location specified by $AZ_BATCHAI_MOUNT_ROOT environment variable.", - "$ref": "#/definitions/MountVolumes" - }, - "performanceCountersSettings": { - "title": "Performance counters settings.", - "description": "Settings for performance counters collecting and uploading.", - "$ref": "#/definitions/PerformanceCountersSettings" - } - }, - "description": "Node setup settings." - }, - "SetupTask": { - "properties": { - "commandLine": { - "type": "string", - "title": "Command line.", - "description": "The command line to be executed on each cluster's node after it being allocated or rebooted. The command is executed in a bash subshell as a root." - }, - "environmentVariables": { - "type": "array", - "items": { - "$ref": "#/definitions/EnvironmentVariable" - }, - "title": "Environment variables.", - "description": "A collection of user defined environment variables to be set for setup task." - }, - "secrets": { - "type": "array", - "items": { - "$ref": "#/definitions/EnvironmentVariableWithSecretValue" - }, - "title": "Secrets.", - "description": "A collection of user defined environment variables with secret values to be set for the setup task. Server will never report values of these variables back." - }, - "stdOutErrPathPrefix": { - "type": "string", - "title": "Output path prefix.", - "description": "The prefix of a path where the Batch AI service will upload the stdout, stderr and execution log of the setup task." - }, - "stdOutErrPathSuffix": { - "type": "string", - "title": "Output path suffix.", - "description": "A path segment appended by Batch AI to stdOutErrPathPrefix to form a path where stdout, stderr and execution log of the setup task will be uploaded. Batch AI creates the setup task output directories under an unique path to avoid conflicts between different clusters. The full path can be obtained by concatenation of stdOutErrPathPrefix and stdOutErrPathSuffix.", - "readOnly": true - } - }, - "required": [ - "commandLine", - "stdOutErrPathPrefix" - ], - "description": "Specifies a setup task which can be used to customize the compute nodes of the cluster." - }, - "ClusterCreateParameters": { - "properties": { - "properties": { - "$ref": "#/definitions/ClusterBaseProperties", - "description": "The properties of the Cluster.", - "x-ms-client-flatten": true - } - }, - "description": "Cluster creation operation." - }, - "ClusterUpdateParameters": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ClusterUpdateProperties", - "description": "The properties of the Cluster." - } - }, - "description": "Cluster update parameters." - }, - "ClusterProperties": { - "properties": { - "vmSize": { - "type": "string", - "title": "VM size.", - "description": "The size of the virtual machines in the cluster. All nodes in a cluster have the same VM size." - }, - "vmPriority": { - "type": "string", - "title": "VM priority.", - "description": "VM priority of cluster nodes.", - "default": "dedicated", - "enum": [ - "dedicated", - "lowpriority" - ], - "x-ms-enum": { - "name": "VmPriority", - "modelAsString": false - } - }, - "scaleSettings": { - "$ref": "#/definitions/ScaleSettings", - "title": "Scale settings.", - "description": "Scale settings of the cluster." - }, - "virtualMachineConfiguration": { - "title": "VM configuration.", - "description": "Virtual machine configuration (OS image) of the compute nodes. All nodes in a cluster have the same OS image configuration.", - "$ref": "#/definitions/VirtualMachineConfiguration" - }, - "nodeSetup": { - "title": "Node setup.", - "description": "Setup (mount file systems, performance counters settings and custom setup task) to be performed on each compute node in the cluster.", - "$ref": "#/definitions/NodeSetup" - }, - "userAccountSettings": { - "title": "User account settings.", - "description": "Administrator user account settings which can be used to SSH to compute nodes.", - "$ref": "#/definitions/UserAccountSettings" - }, - "subnet": { - "title": "Subnet.", - "description": "Virtual network subnet resource ID the cluster nodes belong to.", - "$ref": "#/definitions/ResourceId" - }, - "creationTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "title": "Creation time.", - "description": "The time when the cluster was created." - }, - "provisioningState": { - "type": "string", - "readOnly": true, - "x-nullable": false, - "title": "Provisioning state.", - "description": "Provisioning state of the cluster. Possible value are: creating - Specifies that the cluster is being created. succeeded - Specifies that the cluster has been created successfully. failed - Specifies that the cluster creation has failed. deleting - Specifies that the cluster is being deleted.", - "enum": [ - "creating", - "succeeded", - "failed", - "deleting" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - }, - "provisioningStateTransitionTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "title": "Provisioning State Transition time.", - "description": "Time when the provisioning state was changed." - }, - "allocationState": { - "type": "string", - "readOnly": true, - "title": "Allocation state.", - "description": "Allocation state of the cluster. Possible values are: steady - Indicates that the cluster is not resizing. There are no changes to the number of compute nodes in the cluster in progress. A cluster enters this state when it is created and when no operations are being performed on the cluster to change the number of compute nodes. resizing - Indicates that the cluster is resizing; that is, compute nodes are being added to or removed from the cluster.", - "enum": [ - "steady", - "resizing" - ], - "x-ms-enum": { - "name": "AllocationState", - "modelAsString": true - } - }, - "allocationStateTransitionTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "title": "Allocation state transition time.", - "description": "The time at which the cluster entered its current allocation state." - }, - "errors": { - "readOnly": true, - "title": "Errors.", - "description": "Collection of errors encountered by various compute nodes during node setup.", - "type": "array", - "items": { - "$ref": "#/definitions/BatchAIError" - } - }, - "currentNodeCount": { - "type": "integer", - "readOnly": true, - "format": "int32", - "title": "Current node count.", - "description": "The number of compute nodes currently assigned to the cluster." - }, - "nodeStateCounts": { - "title": "Node state counts.", - "description": "Counts of various node states on the cluster.", - "readOnly": true, - "$ref": "#/definitions/NodeStateCounts" - } - }, - "description": "Cluster properties." - }, - "Cluster": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ClusterProperties", - "description": "The properties associated with the Cluster." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "description": "Information about a Cluster." - }, - "ClusterListResult": { - "properties": { - "value": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/Cluster" - }, - "description": "The collection of returned Clusters." - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The continuation token." - } - }, - "description": "Values returned by the List Clusters operation." - }, - "JobBaseProperties": { - "properties": { - "schedulingPriority": { - "type": "string", - "default": "normal", - "enum": [ - "low", - "normal", - "high" - ], - "x-ms-enum": { - "name": "JobPriority", - "modelAsString": true - }, - "title": "Scheduling priority.", - "description": "Scheduling priority associated with the job. Possible values: low, normal, high." - }, - "cluster": { - "title": "Cluster.", - "description": "Resource ID of the cluster on which this job will run.", - "$ref": "#/definitions/ResourceId" - }, - "mountVolumes": { - "title": "Mount volumes.", - "description": "Information on mount volumes to be used by the job. These volumes will be mounted before the job execution and will be unmounted after the job completion. The volumes will be mounted at location specified by $AZ_BATCHAI_JOB_MOUNT_ROOT environment variable.", - "$ref": "#/definitions/MountVolumes" - }, - "nodeCount": { - "type": "integer", - "format": "int32", - "title": "Node count.", - "description": "Number of compute nodes to run the job on. The job will be gang scheduled on that many compute nodes." - }, - "containerSettings": { - "title": "Container settings.", - "description": "Docker container settings for the job. If not provided, the job will run directly on the node.", - "$ref": "#/definitions/ContainerSettings" - }, - "cntkSettings": { - "title": "CNTK settings.", - "description": "Settings for CNTK (aka Microsoft Cognitive Toolkit) job.", - "$ref": "#/definitions/CNTKsettings" - }, - "pyTorchSettings": { - "title": "pyTorch settings.", - "description": "Settings for pyTorch job.", - "$ref": "#/definitions/PyTorchSettings" - }, - "tensorFlowSettings": { - "title": "TensorFlow settings.", - "description": "Settings for Tensor Flow job.", - "$ref": "#/definitions/TensorFlowSettings" - }, - "caffeSettings": { - "title": "Caffe settings.", - "description": "Settings for Caffe job.", - "$ref": "#/definitions/CaffeSettings" - }, - "caffe2Settings": { - "title": "Caffe2 settings.", - "description": "Settings for Caffe2 job.", - "$ref": "#/definitions/Caffe2Settings" - }, - "chainerSettings": { - "title": "Chainer settings.", - "description": "Settings for Chainer job.", - "$ref": "#/definitions/ChainerSettings" - }, - "customToolkitSettings": { - "title": "Custom tool kit job.", - "description": "Settings for custom tool kit job.", - "$ref": "#/definitions/CustomToolkitSettings" - }, - "customMpiSettings": { - "title": "Custom MPI settings.", - "description": "Settings for custom MPI job.", - "$ref": "#/definitions/CustomMpiSettings" - }, - "horovodSettings": { - "title": "Horovod settings.", - "description": "Settings for Horovod job.", - "$ref": "#/definitions/HorovodSettings" - }, - "jobPreparation": { - "title": "Job preparation.", - "description": "A command line to be executed on each node allocated for the job before tool kit is launched.", - "$ref": "#/definitions/JobPreparation" - }, - "stdOutErrPathPrefix": { - "type": "string", - "title": "Standard output path prefix.", - "description": "The path where the Batch AI service will store stdout, stderror and execution log of the job." - }, - "inputDirectories": { - "type": "array", - "items": { - "$ref": "#/definitions/InputDirectory" - }, - "title": "Input directories.", - "description": "A list of input directories for the job." - }, - "outputDirectories": { - "type": "array", - "items": { - "$ref": "#/definitions/OutputDirectory" - }, - "title": "Output directories.", - "description": "A list of output directories for the job." - }, - "environmentVariables": { - "type": "array", - "items": { - "$ref": "#/definitions/EnvironmentVariable" - }, - "title": "Environment variables.", - "description": "A list of user defined environment variables which will be setup for the job." - }, - "secrets": { - "type": "array", - "items": { - "$ref": "#/definitions/EnvironmentVariableWithSecretValue" - }, - "title": "Secrets.", - "description": "A list of user defined environment variables with secret values which will be setup for the job. Server will never report values of these variables back." - }, - "constraints": { - "properties": { - "maxWallClockTime": { - "type": "string", - "format": "duration", - "title": "Max wall clock time.", - "description": "Max time the job can run. Default value: 1 week.", - "default": "7.00:00:00" - } - }, - "description": "Constraints associated with the Job." - } - }, - "required": [ - "cluster", - "nodeCount", - "stdOutErrPathPrefix" - ], - "description": "The properties of a Batch AI Job." - }, - "JobCreateParameters": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/JobBaseProperties", - "description": "The properties of the Job." - } - }, - "description": "Job creation parameters." - }, - "JobProperties": { - "properties": { - "schedulingPriority": { - "type": "string", - "default": "normal", - "enum": [ - "low", - "normal", - "high" - ], - "x-ms-enum": { - "name": "JobPriority", - "modelAsString": true - }, - "title": "Scheduling priority.", - "description": "Scheduling priority associated with the job." - }, - "cluster": { - "title": "Cluster.", - "description": "Resource ID of the cluster associated with the job.", - "$ref": "#/definitions/ResourceId" - }, - "mountVolumes": { - "title": "Mount volumes.", - "description": "Collection of mount volumes available to the job during execution. These volumes are mounted before the job execution and unmounted after the job completion. The volumes are mounted at location specified by $AZ_BATCHAI_JOB_MOUNT_ROOT environment variable.", - "$ref": "#/definitions/MountVolumes" - }, - "nodeCount": { - "type": "integer", - "format": "int32", - "title": "Number of compute nodes to run the job on.", - "description": "The job will be gang scheduled on that many compute nodes" - }, - "containerSettings": { - "title": "If provided the job will run in the specified container.", - "description": "If the container was downloaded as part of cluster setup then the same container image will be used. If not provided, the job will run on the VM.", - "$ref": "#/definitions/ContainerSettings" - }, - "toolType": { - "title": "The toolkit type of this job.", - "description": "Possible values are: cntk, tensorflow, caffe, caffe2, chainer, pytorch, custom, custommpi, horovod.", - "$ref": "#/definitions/ToolType" - }, - "cntkSettings": { - "title": "Specifies the settings for CNTK (aka Microsoft Cognitive Toolkit) job.", - "$ref": "#/definitions/CNTKsettings" - }, - "pyTorchSettings": { - "title": "Specifies the settings for pyTorch job.", - "$ref": "#/definitions/PyTorchSettings" - }, - "tensorFlowSettings": { - "title": "Specifies the settings for Tensor Flow job.", - "$ref": "#/definitions/TensorFlowSettings" - }, - "caffeSettings": { - "title": "Specifies the settings for Caffe job.", - "$ref": "#/definitions/CaffeSettings" - }, - "caffe2Settings": { - "title": "Specifies the settings for Caffe2 job.", - "$ref": "#/definitions/Caffe2Settings" - }, - "chainerSettings": { - "title": "Specifies the settings for Chainer job.", - "$ref": "#/definitions/ChainerSettings" - }, - "customToolkitSettings": { - "title": "Specifies the settings for custom tool kit job.", - "$ref": "#/definitions/CustomToolkitSettings" - }, - "customMpiSettings": { - "title": "Specifies the settings for custom MPI job.", - "$ref": "#/definitions/CustomMpiSettings" - }, - "horovodSettings": { - "title": "Specifies the settings for Horovod job.", - "$ref": "#/definitions/HorovodSettings" - }, - "jobPreparation": { - "title": "Specifies the actions to be performed before tool kit is launched.", - "description": "The specified actions will run on all the nodes that are part of the job", - "$ref": "#/definitions/JobPreparation" - }, - "jobOutputDirectoryPathSegment": { - "readOnly": true, - "type": "string", - "title": "Output directory path segment.", - "description": "A segment of job's output directories path created by Batch AI. Batch AI creates job's output directories under an unique path to avoid conflicts between jobs. This value contains a path segment generated by Batch AI to make the path unique and can be used to find the output directory on the node or mounted filesystem." - }, - "stdOutErrPathPrefix": { - "type": "string", - "title": "Standard output directory path prefix.", - "description": "The path where the Batch AI service stores stdout, stderror and execution log of the job." - }, - "inputDirectories": { - "type": "array", - "items": { - "$ref": "#/definitions/InputDirectory" - }, - "title": "Input directories.", - "description": "A list of input directories for the job." - }, - "outputDirectories": { - "type": "array", - "items": { - "$ref": "#/definitions/OutputDirectory" - }, - "title": "Output directories.", - "description": "A list of output directories for the job." - }, - "environmentVariables": { - "type": "array", - "items": { - "$ref": "#/definitions/EnvironmentVariable" - }, - "title": "Environment variables.", - "description": "A collection of user defined environment variables to be setup for the job." - }, - "secrets": { - "type": "array", - "items": { - "$ref": "#/definitions/EnvironmentVariableWithSecretValue" - }, - "title": "Secrets.", - "description": "A collection of user defined environment variables with secret values to be setup for the job. Server will never report values of these variables back." - }, - "constraints": { - "properties": { - "maxWallClockTime": { - "type": "string", - "format": "duration", - "title": "Max wall clock time.", - "description": "Max time the job can run. Default value: 1 week.", - "default": "7.00:00:00" - } - }, - "description": "Constraints associated with the Job." - }, - "creationTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "title": "Creation time.", - "description": "The creation time of the job." - }, - "provisioningState": { - "type": "string", - "readOnly": true, - "x-nullable": false, - "title": "Provisioning state.", - "description": "The provisioned state of the Batch AI job", - "enum": [ - "creating", - "deleting", - "succeeded", - "failed" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - }, - "provisioningStateTransitionTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "title": "Provisioning state transition time.", - "description": "The time at which the job entered its current provisioning state." - }, - "executionState": { - "readOnly": true, - "type": "string", - "title": "Execution state.", - "description": "The current state of the job. Possible values are: queued - The job is queued and able to run. A job enters this state when it is created, or when it is awaiting a retry after a failed run. running - The job is running on a compute cluster. This includes job-level preparation such as downloading resource files or set up container specified on the job - it does not necessarily mean that the job command line has started executing. terminating - The job is terminated by the user, the terminate operation is in progress. succeeded - The job has completed running successfully and exited with exit code 0. failed - The job has finished unsuccessfully (failed with a non-zero exit code) and has exhausted its retry limit. A job is also marked as failed if an error occurred launching the job.", - "enum": [ - "queued", - "running", - "terminating", - "succeeded", - "failed" - ], - "x-ms-enum": { - "name": "ExecutionState", - "modelAsString": true - } - }, - "executionStateTransitionTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "title": "Execution state transition time.", - "description": "The time at which the job entered its current execution state." - }, - "executionInfo": { - "properties": { - "startTime": { - "readOnly": true, - "type": "string", - "format": "date-time", - "title": "Start time.", - "description": "The time at which the job started running. 'Running' corresponds to the running state. If the job has been restarted or retried, this is the most recent time at which the job started running. This property is present only for job that are in the running or completed state." - }, - "endTime": { - "readOnly": true, - "type": "string", - "format": "date-time", - "title": "End time.", - "description": "The time at which the job completed. This property is only returned if the job is in completed state." - }, - "exitCode": { - "readOnly": true, - "type": "integer", - "format": "int32", - "title": "Exit code.", - "description": "The exit code of the job. This property is only returned if the job is in completed state." - }, - "errors": { - "readOnly": true, - "title": "Errors.", - "description": "A collection of errors encountered by the service during job execution.", - "type": "array", - "items": { - "$ref": "#/definitions/BatchAIError" - } - } - }, - "description": "Information about the execution of a job." - } - }, - "description": "Job properties." - }, - "Job": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/JobProperties", - "description": "The properties associated with the Job." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "description": "Information about a Job." - }, - "JobListResult": { - "properties": { - "value": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/Job" - }, - "description": "The collection of jobs." - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The continuation token." - } - }, - "description": "Values returned by the List operation." - }, - "RemoteLoginInformation": { - "properties": { - "nodeId": { - "readOnly": true, - "type": "string", - "title": "Node ID.", - "description": "ID of the compute node." - }, - "ipAddress": { - "readOnly": true, - "type": "string", - "title": "IP address.", - "description": "Public IP address of the compute node." - }, - "port": { - "readOnly": true, - "type": "number", - "format": "int32", - "title": "Port.", - "description": "SSH port number of the node." - } - }, - "description": "Login details to SSH to a compute node in cluster." - }, - "RemoteLoginInformationListResult": { - "properties": { - "value": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/RemoteLoginInformation" - }, - "description": "The collection of returned remote login details." - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The continuation token." - } - }, - "description": "Values returned by the List operation." - }, - "FileProperties": { - "properties": { - "lastModified": { - "readOnly": true, - "type": "string", - "format": "date-time", - "title": "Last modified time.", - "description": "The time at which the file was last modified." - }, - "contentLength": { - "readOnly": true, - "type": "integer", - "format": "int64", - "title": "Content length.", - "description": "The file of the size." - } - }, - "description": "File properties." - }, - "File": { - "properties": { - "name": { - "readOnly": true, - "type": "string", - "title": "Name.", - "description": "Name of the file." - }, - "fileType": { - "readOnly": true, - "type": "string", - "enum": [ - "file", - "directory" - ], - "x-ms-enum": { - "name": "FileType", - "modelAsString": true - }, - "title": "File type.", - "description": "Type of the file. Possible values are file and directory." - }, - "downloadUrl": { - "readOnly": true, - "type": "string", - "title": "Download URL.", - "description": "URL to download the corresponding file. The downloadUrl is not returned for directories." - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/FileProperties", - "title": "Properties.", - "description": "The properties associated with the file. The properties are not returned for directories." - } - }, - "description": "Properties of the file or directory." - }, - "FileListResult": { - "properties": { - "value": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/File" - }, - "description": "The collection of returned job directories and files." - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The continuation token." - } - }, - "description": "Values returned by the List operation." - }, - "ResourceId": { - "properties": { - "id": { - "type": "string", - "description": "The ID of the resource" - } - }, - "required": [ - "id" - ], - "description": "Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.", - "x-ms-azure-resource": true - }, - "Resource": { - "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": { - "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." - } - }, - "description": "A definition of an Azure proxy resource.", - "x-ms-azure-resource": true - }, - "ToolType": { - "type": "string", - "title": "Toolkit type.", - "description": "The toolkit type of the job.", - "enum": [ - "cntk", - "tensorflow", - "caffe", - "caffe2", - "chainer", - "horovod", - "custommpi", - "custom" - ], - "x-ms-enum": { - "name": "ToolType", - "modelAsString": true - } - }, - "NameValuePair": { - "properties": { - "name": { - "type": "string", - "title": "Name.", - "description": "The name in the name-value pair." - }, - "value": { - "type": "string", - "title": "Value.", - "description": "The value in the name-value pair." - } - }, - "description": "Name-value pair." - }, - "EnvironmentVariable": { - "properties": { - "name": { - "type": "string", - "title": "Name.", - "description": "The name of the environment variable." - }, - "value": { - "type": "string", - "title": "Value.", - "description": "The value of the environment variable." - } - }, - "required": [ - "name", - "value" - ], - "description": "An environment variable definition." - }, - "EnvironmentVariableWithSecretValue": { - "properties": { - "name": { - "type": "string", - "title": "Name.", - "description": "The name of the environment variable to store the secret value." - }, - "value": { - "type": "string", - "title": "Value.", - "description": "The value of the environment variable. This value will never be reported back by Batch AI." - }, - "valueSecretReference": { - "title": "KeyVault secret reference.", - "description": "KeyVault store and secret which contains the value for the environment variable. One of value or valueSecretReference must be provided.", - "$ref": "#/definitions/KeyVaultSecretReference" - } - }, - "required": [ - "name" - ], - "description": "An environment variable with secret value definition." - }, - "ImageSourceRegistry": { - "properties": { - "serverUrl": { - "type": "string", - "title": "Server URL.", - "description": "URL for image repository." - }, - "image": { - "type": "string", - "title": "Image.", - "description": "The name of the image in the image repository." - }, - "credentials": { - "title": "Credentials.", - "description": "Credentials to access the private docker repository.", - "$ref": "#/definitions/PrivateRegistryCredentials" - } - }, - "description": "Information about docker image for the job.", - "required": [ - "image" - ] - }, - "PrivateRegistryCredentials": { - "properties": { - "username": { - "type": "string", - "title": "User name.", - "description": "User name to login to the repository." - }, - "password": { - "type": "string", - "title": "Password.", - "description": "User password to login to the docker repository. One of password or passwordSecretReference must be specified." - }, - "passwordSecretReference": { - "title": "Password secret reference.", - "description": "KeyVault Secret storing the password. Users can store their secrets in Azure KeyVault and pass it to the Batch AI service to integrate with KeyVault. One of password or passwordSecretReference must be specified.", - "$ref": "#/definitions/KeyVaultSecretReference" - } - }, - "description": "Credentials to access a container image in a private repository.", - "required": [ - "username" - ] - }, - "ContainerSettings": { - "properties": { - "imageSourceRegistry": { - "title": "Image source registry.", - "description": "Information about docker image and docker registry to download the container from.", - "$ref": "#/definitions/ImageSourceRegistry" - }, - "shmSize": { - "type": "string", - "title": "/dev/shm size.", - "description": "Size of /dev/shm. Please refer to docker documentation for supported argument formats." - } - }, - "description": "Docker container settings.", - "required": [ - "imageSourceRegistry" - ] - }, - "InputDirectory": { - "properties": { - "id": { - "type": "string", - "title": "ID.", - "description": "The ID for the input directory. The job can use AZ_BATCHAI_INPUT_ environment variable to find the directory path, where is the value of id attribute." - }, - "path": { - "type": "string", - "title": "Path.", - "description": "The path to the input directory." - } - }, - "description": "Input directory for the job.", - "required": [ - "id", - "path" - ] - }, - "OutputDirectory": { - "properties": { - "id": { - "type": "string", - "title": "ID.", - "description": "The ID of the output directory. The job can use AZ_BATCHAI_OUTPUT_ environment variable to find the directory path, where is the value of id attribute." - }, - "pathPrefix": { - "type": "string", - "title": "Path prefix.", - "description": "The prefix path where the output directory will be created. Note, this is an absolute path to prefix. E.g. $AZ_BATCHAI_MOUNT_ROOT/MyNFS/MyLogs. The full path to the output directory by combining pathPrefix, jobOutputDirectoryPathSegment (reported by get job) and pathSuffix." - }, - "pathSuffix": { - "type": "string", - "title": "Path suffix.", - "description": "The suffix path where the output directory will be created. E.g. models. You can find the full path to the output directory by combining pathPrefix, jobOutputDirectoryPathSegment (reported by get job) and pathSuffix." - } - }, - "description": "Output directory for the job.", - "required": [ - "id", - "pathPrefix" - ] - }, - "AzureStorageCredentialsInfo": { - "properties": { - "accountKey": { - "type": "string", - "title": "Account key.", - "description": "Storage account key. One of accountKey or accountKeySecretReference must be specified." - }, - "accountKeySecretReference": { - "title": "Account key secret reference.", - "description": "Information about KeyVault secret storing the storage account key. One of accountKey or accountKeySecretReference must be specified.", - "$ref": "#/definitions/KeyVaultSecretReference" - } - }, - "description": "Azure storage account credentials." - }, - "AzureFileShareReference": { - "properties": { - "accountName": { - "type": "string", - "title": "Account name.", - "description": "Name of the Azure storage account." - }, - "azureFileUrl": { - "type": "string", - "title": "Azure File URL.", - "description": "URL to access the Azure File." - }, - "credentials": { - "title": "Credentials.", - "description": "Information about the Azure storage credentials.", - "$ref": "#/definitions/AzureStorageCredentialsInfo" - }, - "relativeMountPath": { - "type": "string", - "title": "Relative mount path.", - "description": "The relative path on the compute node where the Azure File share will be mounted. Note that all cluster level file shares will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and all job level file shares will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT." - }, - "fileMode": { - "type": "string", - "title": "File mode.", - "description": "File mode for files on the mounted file share. Default value: 0777.", - "default": "0777" - }, - "directoryMode": { - "type": "string", - "title": "Directory mode.", - "description": "File mode for directories on the mounted file share. Default value: 0777.", - "default": "0777" - } - }, - "description": "Azure File Share mounting configuration.", - "required": [ - "accountName", - "azureFileUrl", - "credentials", - "relativeMountPath" - ] - }, - "AzureBlobFileSystemReference": { - "properties": { - "accountName": { - "type": "string", - "title": "Account name.", - "description": "Name of the Azure storage account." - }, - "containerName": { - "type": "string", - "title": "Container name.", - "description": "Name of the Azure Blob Storage container to mount on the cluster." - }, - "credentials": { - "title": "Credentials.", - "description": "Information about the Azure storage credentials.", - "$ref": "#/definitions/AzureStorageCredentialsInfo" - }, - "relativeMountPath": { - "type": "string", - "title": "Relative mount path.", - "description": "The relative path on the compute node where the Azure File container will be mounted. Note that all cluster level containers will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and all job level containers will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT." - }, - "mountOptions": { - "type": "string", - "title": "Mount options.", - "description": "Mount options for mounting blobfuse file system." - } - }, - "description": "Azure Blob Storage Container mounting configuration.", - "required": [ - "accountName", - "containerName", - "credentials", - "relativeMountPath" - ] - }, - "FileServerReference": { - "properties": { - "fileServer": { - "title": "File server.", - "description": "Resource ID of the existing File Server to be mounted.", - "$ref": "#/definitions/ResourceId" - }, - "sourceDirectory": { - "type": "string", - "title": "Source directory.", - "description": "File Server directory that needs to be mounted. If this property is not specified, the entire File Server will be mounted." - }, - "relativeMountPath": { - "type": "string", - "title": "Relative mount path.", - "description": "The relative path on the compute node where the File Server will be mounted. Note that all cluster level file servers will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and all job level file servers will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT." - }, - "mountOptions": { - "type": "string", - "title": "Mount options.", - "description": "Mount options to be passed to mount command." - } - }, - "description": "File Server mounting configuration.", - "required": [ - "fileServer", - "relativeMountPath" - ] - }, - "UnmanagedFileSystemReference": { - "properties": { - "mountCommand": { - "title": "Mount command.", - "description": "Mount command line. Note, Batch AI will append mount path to the command on its own.", - "type": "string" - }, - "relativeMountPath": { - "type": "string", - "title": "Relative mount path.", - "description": "The relative path on the compute node where the unmanaged file system will be mounted. Note that all cluster level unmanaged file systems will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and all job level unmanaged file systems will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT." - } - }, - "description": "Unmanaged file system mounting configuration.", - "required": [ - "mountCommand", - "relativeMountPath" - ] - }, - "MountVolumes": { - "properties": { - "azureFileShares": { - "type": "array", - "items": { - "$ref": "#/definitions/AzureFileShareReference" - }, - "title": "Azure File Shares.", - "description": "A collection of Azure File Shares that are to be mounted to the cluster nodes." - }, - "azureBlobFileSystems": { - "type": "array", - "items": { - "$ref": "#/definitions/AzureBlobFileSystemReference" - }, - "title": "Azure Blob file systems.", - "description": "A collection of Azure Blob Containers that are to be mounted to the cluster nodes." - }, - "fileServers": { - "type": "array", - "items": { - "$ref": "#/definitions/FileServerReference" - }, - "title": "File Servers.", - "description": "A collection of Batch AI File Servers that are to be mounted to the cluster nodes." - }, - "unmanagedFileSystems": { - "type": "array", - "items": { - "$ref": "#/definitions/UnmanagedFileSystemReference" - }, - "title": "Unmanaged file systems.", - "description": "A collection of unmanaged file systems that are to be mounted to the cluster nodes." - } - }, - "description": "Details of volumes to mount on the cluster." - }, - "CNTKsettings": { - "properties": { - "languageType": { - "type": "string", - "title": "Language type.", - "description": "The language to use for launching CNTK (aka Microsoft Cognitive Toolkit) job. Valid values are 'BrainScript' or 'Python'." - }, - "configFilePath": { - "type": "string", - "title": "Config file path.", - "description": "Specifies the path of the BrainScript config file. This property can be specified only if the languageType is 'BrainScript'." - }, - "pythonScriptFilePath": { - "type": "string", - "title": "Python script file path.", - "description": "Python script to execute. This property can be specified only if the languageType is 'Python'." - }, - "pythonInterpreterPath": { - "type": "string", - "title": "Python interpreter path.", - "description": "The path to the Python interpreter. This property can be specified only if the languageType is 'Python'." - }, - "commandLineArgs": { - "type": "string", - "title": "Command line arguments.", - "description": "Command line arguments that need to be passed to the python script or cntk executable." - }, - "processCount": { - "type": "integer", - "format": "int32", - "title": "Process count.", - "description": "Number of processes to launch for the job execution. The default value for this property is equal to nodeCount property" - } - }, - "description": "CNTK (aka Microsoft Cognitive Toolkit) job settings." - }, - "CaffeSettings": { - "properties": { - "configFilePath": { - "type": "string", - "title": "Config file path.", - "description": "Path of the config file for the job. This property cannot be specified if pythonScriptFilePath is specified." - }, - "pythonScriptFilePath": { - "type": "string", - "title": "Python script file path.", - "description": "Python script to execute. This property cannot be specified if configFilePath is specified." - }, - "pythonInterpreterPath": { - "type": "string", - "title": "Python interpreter path.", - "description": "The path to the Python interpreter. The property can be specified only if the pythonScriptFilePath is specified." - }, - "commandLineArgs": { - "type": "string", - "title": "Command line arguments.", - "description": "Command line arguments that need to be passed to the Caffe job." - }, - "processCount": { - "type": "integer", - "format": "int32", - "title": "Process count.", - "description": "Number of processes to launch for the job execution. The default value for this property is equal to nodeCount property" - } - }, - "description": "Caffe job settings." - }, - "Caffe2Settings": { - "properties": { - "pythonScriptFilePath": { - "type": "string", - "title": "Python script file path.", - "description": "The python script to execute." - }, - "pythonInterpreterPath": { - "type": "string", - "title": "Python interpreter path.", - "description": "The path to the Python interpreter." - }, - "commandLineArgs": { - "type": "string", - "title": "Command line arguments.", - "description": "Command line arguments that need to be passed to the python script." - } - }, - "description": "Caffe2 job settings.", - "required": [ - "pythonScriptFilePath" - ] - }, - "ChainerSettings": { - "properties": { - "pythonScriptFilePath": { - "type": "string", - "title": "Python script file path.", - "description": "The python script to execute." - }, - "pythonInterpreterPath": { - "type": "string", - "title": "Python interpreter path.", - "description": "The path to the Python interpreter." - }, - "commandLineArgs": { - "type": "string", - "title": "Command line arguments.", - "description": "Command line arguments that need to be passed to the python script." - }, - "processCount": { - "type": "integer", - "format": "int32", - "title": "Process count.", - "description": "Number of processes to launch for the job execution. The default value for this property is equal to nodeCount property" - } - }, - "description": "Chainer job settings.", - "required": [ - "pythonScriptFilePath" - ] - }, - "CustomToolkitSettings": { - "properties": { - "commandLine": { - "type": "string", - "title": "Command line.", - "description": "The command line to execute on the master node." - } - }, - "description": "Custom tool kit job settings." - }, - "CustomMpiSettings": { - "properties": { - "commandLine": { - "type": "string", - "title": "Command line.", - "description": "The command line to be executed by mpi runtime on each compute node." - }, - "processCount": { - "type": "integer", - "format": "int32", - "title": "Process count.", - "description": "Number of processes to launch for the job execution. The default value for this property is equal to nodeCount property" - } - }, - "description": "Custom MPI job settings.", - "required": [ - "commandLine" - ] - }, - "JobPreparation": { - "properties": { - "commandLine": { - "type": "string", - "title": "Command line.", - "description": "The command line to execute. If containerSettings is specified on the job, this commandLine will be executed in the same container as job. Otherwise it will be executed on the node." - } - }, - "description": "Job preparation settings.", - "required": [ - "commandLine" - ] - }, - "PyTorchSettings": { - "properties": { - "pythonScriptFilePath": { - "type": "string", - "title": "Python script file path.", - "description": "The python script to execute." - }, - "pythonInterpreterPath": { - "type": "string", - "title": "Python interpreter path.", - "description": "The path to the Python interpreter." - }, - "commandLineArgs": { - "type": "string", - "title": "Command line arguments.", - "description": "Command line arguments that need to be passed to the python script." - }, - "processCount": { - "type": "integer", - "format": "int32", - "title": "Process count.", - "description": "Number of processes to launch for the job execution. The default value for this property is equal to nodeCount property" - }, - "communicationBackend": { - "type": "string", - "title": "Communication backend.", - "description": "Type of the communication backend for distributed jobs. Valid values are 'TCP', 'Gloo' or 'MPI'. Not required for non-distributed jobs." - } - }, - "description": "pyTorch job settings.", - "required": [ - "pythonScriptFilePath" - ] - }, - "HorovodSettings": { - "properties": { - "pythonScriptFilePath": { - "type": "string", - "title": "Python script file path.", - "description": "The python script to execute." - }, - "pythonInterpreterPath": { - "type": "string", - "title": "Python interpreter path.", - "description": "The path to the Python interpreter." - }, - "commandLineArgs": { - "type": "string", - "title": "Command line arguments.", - "description": "Command line arguments that need to be passed to the python script." - }, - "processCount": { - "type": "integer", - "format": "int32", - "title": "Process count.", - "description": "Number of processes to launch for the job execution. The default value for this property is equal to nodeCount property" - } - }, - "description": "Specifies the settings for Horovod job.", - "required": [ - "pythonScriptFilePath" - ] - }, - "TensorFlowSettings": { - "properties": { - "pythonScriptFilePath": { - "type": "string", - "title": "Python script file path.", - "description": "The python script to execute." - }, - "pythonInterpreterPath": { - "type": "string", - "title": "Python interpreter path.", - "description": "The path to the Python interpreter." - }, - "masterCommandLineArgs": { - "type": "string", - "title": "Master command line arguments.", - "description": "Command line arguments that need to be passed to the python script for the master task." - }, - "workerCommandLineArgs": { - "type": "string", - "title": "Worker command line arguments.", - "description": "Command line arguments that need to be passed to the python script for the worker task. Optional for single process jobs." - }, - "parameterServerCommandLineArgs": { - "type": "string", - "title": "Parameter server command line arguments.", - "description": "Command line arguments that need to be passed to the python script for the parameter server. Optional for single process jobs." - }, - "workerCount": { - "type": "integer", - "format": "int32", - "title": "Worker count.", - "description": "The number of worker tasks. If specified, the value must be less than or equal to (nodeCount * numberOfGPUs per VM). If not specified, the default value is equal to nodeCount. This property can be specified only for distributed TensorFlow training." - }, - "parameterServerCount": { - "type": "integer", - "format": "int32", - "title": "Parameter server count.", - "description": "The number of parameter server tasks. If specified, the value must be less than or equal to nodeCount. If not specified, the default value is equal to 1 for distributed TensorFlow training. This property can be specified only for distributed TensorFlow training." - } - }, - "description": "TensorFlow job settings.", - "required": [ - "pythonScriptFilePath" - ] - }, - "CloudError": { - "x-ms-external": true, - "properties": { - "error": { - "readOnly": true, - "$ref": "#/definitions/CloudErrorBody", - "description": "An error response from the Batch AI service." - } - }, - "description": "An error response from the Batch AI service." - }, - "CloudErrorBody": { - "x-ms-external": true, - "properties": { - "code": { - "readOnly": true, - "type": "string", - "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." - }, - "message": { - "readOnly": true, - "type": "string", - "description": "A message describing the error, intended to be suitable for display in a user interface." - }, - "target": { - "readOnly": true, - "type": "string", - "description": "The target of the particular error. For example, the name of the property in error." - }, - "details": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/CloudErrorBody" - }, - "description": "A list of additional details about the error." - } - }, - "description": "An error response from the Batch AI service." - }, - "BatchAIError": { - "properties": { - "code": { - "readOnly": true, - "type": "string", - "description": "An identifier of the error. Codes are invariant and are intended to be consumed programmatically." - }, - "message": { - "readOnly": true, - "type": "string", - "description": "A message describing the error, intended to be suitable for display in a user interface." - }, - "details": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/NameValuePair" - }, - "description": "A list of additional details about the error." - } - }, - "description": "An error response from the Batch AI service." - }, - "Operation": { - "title": "A REST API operation.", - "description": "Details of a REST API operation", - "type": "object", - "properties": { - "name": { - "readOnly": true, - "title": "The operation name.", - "description": "This is of the format {provider}/{resource}/{operation}", - "type": "string" - }, - "display": { - "description": "The object that describes the operation.", - "properties": { - "provider": { - "readOnly": true, - "title": "Friendly name of the resource provider.", - "type": "string" - }, - "operation": { - "readOnly": true, - "title": "The operation type.", - "description": "For example: read, write, delete, or listKeys/action", - "type": "string" - }, - "resource": { - "readOnly": true, - "title": "The resource type on which the operation is performed.", - "type": "string" - }, - "description": { - "readOnly": true, - "title": "The friendly name of the operation.", - "type": "string" - } - } - }, - "origin": { - "readOnly": true, - "title": "The intended executor of the operation.", - "type": "string" - }, - "properties": { - "x-ms-client-flatten": true, - "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.", - "description": "Contains the list of all operations supported by BatchAI resource provider", - "properties": { - "value": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/Operation" - }, - "title": "The list of operations supported by the resource provider." - }, - "nextLink": { - "readOnly": true, - "type": "string", - "title": "The URL to get the next set of operation list results if there are any." - } - } - }, - "WorkspaceListResult": { - "properties": { - "value": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/Workspace" - }, - "description": "The collection of workspaces." - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The continuation token." - } - }, - "description": "Values returned by the List operation." - }, - "WorkspaceCreateParameters": { - "properties": { - "location": { - "type": "string", - "title": "Location.", - "description": "The region in which to create the Workspace." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "title": "Tags.", - "description": "The user specified tags associated with the Workspace." - } - }, - "required": [ - "location" - ], - "description": "Workspace creation parameters." - }, - "WorkspaceUpdateParameters": { - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "title": "Tags.", - "description": "The user specified tags associated with the Workspace." - } - }, - "description": "Workspace update parameters." - }, - "WorkspaceProperties": { - "properties": { - "creationTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "title": "Creation time.", - "description": "Time when the Workspace was created." - }, - "provisioningState": { - "type": "string", - "readOnly": true, - "x-nullable": false, - "title": "Provisioning state.", - "description": "The provisioned state of the Workspace", - "enum": [ - "creating", - "deleting", - "succeeded", - "failed" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - }, - "provisioningStateTransitionTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "title": "Provisioning state transition time.", - "description": "The time at which the workspace entered its current provisioning state." - } - }, - "description": "Workspace specific properties." - }, - "Workspace": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/WorkspaceProperties", - "description": "The properties associated with the workspace." - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Batch AI Workspace information." - }, - "ExperimentListResult": { - "properties": { - "value": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/Experiment" - }, - "description": "The collection of experiments." - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The continuation token." - } - }, - "description": "Values returned by the List operation." - }, - "ExperimentProperties": { - "properties": { - "creationTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "title": "Creation time.", - "description": "Time when the Experiment was created." - }, - "provisioningState": { - "type": "string", - "readOnly": true, - "x-nullable": false, - "title": "Provisioning state.", - "description": "The provisioned state of the experiment", - "enum": [ - "creating", - "deleting", - "succeeded", - "failed" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - }, - "provisioningStateTransitionTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "title": "Provisioning state transition time.", - "description": "The time at which the experiment entered its current provisioning state." - } - }, - "description": "Experiment properties." - }, - "Experiment": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ExperimentProperties", - "description": "The properties associated with the experiment." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "description": "Experiment information." - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscriptionID for the Azure user." - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "description": "Name of the resource group to which the resource belongs.", - "required": true, - "x-ms-parameter-location": "method", - "type": "string", - "pattern": "^[-\\w\\._]+$" - }, - "ClusterNameParameter": { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[-\\w_]+$", - "minLength": 1, - "maxLength": 64, - "x-ms-parameter-location": "method", - "description": "The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long." - }, - "JobNameParameter": { - "name": "jobName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[-\\w_]+$", - "minLength": 1, - "maxLength": 64, - "x-ms-parameter-location": "method", - "description": "The name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long." - }, - "FileServerNameParameter": { - "name": "fileServerName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[-\\w_]+$", - "minLength": 1, - "maxLength": 64, - "x-ms-parameter-location": "method", - "description": "The name of the file server within the specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Specifies the version of API used for this request." - }, - "MaxResultsParameter": { - "name": "maxresults", - "x-ms-client-name": "maxResults", - "default": 1000, - "minimum": 1, - "maximum": 1000, - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method", - "description": "The maximum number of items to return in the response. A maximum of 1000 files can be returned.", - "x-ms-parameter-grouping": { - "postfix": "Options" - } - }, - "OutputDirectoryIdParameter": { - "name": "outputdirectoryid", - "in": "query", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "description": "Id of the job output directory. This is the OutputDirectory-->id parameter that is given by the user during Create Job.", - "x-ms-parameter-grouping": { - "postfix": "Options" - } - }, - "DownloadLinkExpiryParameter": { - "name": "linkexpiryinminutes", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "minimum": 5, - "maximum": 600, - "default": 60, - "x-ms-parameter-location": "method", - "description": "The number of minutes after which the download link will expire.", - "x-ms-parameter-grouping": { - "postfix": "Options" - } - }, - "Directory": { - "name": "directory", - "in": "query", - "default": ".", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "description": "The path to the directory.", - "x-ms-parameter-grouping": { - "postfix": "Options" - } - }, - "WorkspaceNameParameter": { - "name": "workspaceName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[-\\w_]+$", - "minLength": 1, - "maxLength": 64, - "x-ms-parameter-location": "method", - "description": "The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long." - }, - "ExperimentNameParameter": { - "name": "experimentName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[-\\w_]+$", - "minLength": 1, - "maxLength": 64, - "x-ms-parameter-location": "method", - "description": "The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long." - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ClusterListRemoteLoginInfo.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ClusterListRemoteLoginInfo.json deleted file mode 100644 index 49bad0763fc4..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ClusterListRemoteLoginInfo.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "workspaceName": "demo_workspace", - "clusterName": "demo_cluster", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-05-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "nodeId": "tvm-3601533753_1-20170719t162906z", - "ipAddress": "13.84.190.124", - "port": 50000 - }, - { - "nodeId": "tvm-3601533753_2-20170719t162906z", - "ipAddress": "13.84.190.124", - "port": 50001 - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/DeleteCluster.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/DeleteCluster.json deleted file mode 100644 index c69f44a389ec..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/DeleteCluster.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "workspaceName": "demo_workspace", - "clusterName": "demo_cluster", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-05-01" - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2018-05-01", - "Retry-After": 15 - } - }, - "200": {}, - "204": {} - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/DeleteExperiment.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/DeleteExperiment.json deleted file mode 100644 index 75532f285149..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/DeleteExperiment.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "workspaceName": "demo_workspace", - "experimentName": "demo_experiment", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-05-01" - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2018-05-01", - "Retry-After": 15 - } - }, - "200": {}, - "204": {} - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/DeleteJob.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/DeleteJob.json deleted file mode 100644 index 1ecc8f2e6c98..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/DeleteJob.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "workspaceName": "demo_workspace", - "experimentName": "demo_experiment", - "jobName": "demo_job", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-05-01" - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2018-05-01", - "Retry-After": 15 - } - }, - "200": {}, - "204": {} - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/DeleteWorkspace.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/DeleteWorkspace.json deleted file mode 100644 index e10e644a8974..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/DeleteWorkspace.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "workspaceName": "demo_workspace", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-05-01" - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2018-05-01", - "Retry-After": 15 - } - }, - "200": {}, - "204": {} - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/GetCluster.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/GetCluster.json deleted file mode 100644 index 2f6ebeb7d966..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/GetCluster.json +++ /dev/null @@ -1,69 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "workspaceName": "demo_workspace", - "clusterName": "demo_cluster", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-05-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspace/clusters/demo_cluster", - "name": "demo_cluster", - "type": "Microsoft.BatchAI/Clusters", - "properties": { - "provisioningState": "succeeded", - "allocationState": "resizing", - "creationTime": "2017-09-27T21:50:02.377Z", - "allocationStateTransitionTime": "2017-09-27T21:50:04.521Z", - "provisioningStateTransitionTime": "2017-09-27T21:50:03.828Z", - "vmSize": "STANDARD_NC6", - "currentNodeCount": 0, - "nodeStateCounts": { - "runningNodeCount": 0, - "idleNodeCount": 0, - "unusableNodeCount": 0, - "preparingNodeCount": 0, - "leavingNodeCount": 0 - }, - "vmPriority": "dedicated", - "scaleSettings": { - "manual": { - "targetNodeCount": 1, - "nodeDeallocationOption": "requeue" - } - }, - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "UbuntuServer", - "sku": "16.04-LTS", - "version": "latest" - } - }, - "userAccountSettings": { - "adminUserName": "admin_user_name" - }, - "nodeSetup": { - "mountVolumes": { - "azureFileShares": [ - { - "accountName": "storage_account_name", - "azureFileUrl": "https://storage_account_name.file.core.windows.net/azure_file_share_name", - "credentials": {}, - "relativeMountPath": "azfiles", - "fileMode": "0777", - "directoryMode": "0777" - } - ] - } - }, - "subnet": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.Network/virtualNetworks/7feb1976-8c31-4f1f-bea2-86cb1839a7bavnet/subnets/Subnet-1" - } - } - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/GetExperiment.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/GetExperiment.json deleted file mode 100644 index e7e3195ec79d..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/GetExperiment.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "demo_resource_group", - "workspaceName": "demo_workspace", - "experimentName": "demo_experiment", - "api-version": "2018-05-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspace/demo_workspace/experiments/demo_experiment", - "name": "demo_experiment", - "type": "Microsoft.BatchAI/Experiments", - "properties": { - "creationTime": "2017-09-27T22:27:52.611Z", - "provisioningState": "succeeded", - "provisioningStateTransitionTime": "2017-09-27T22:28:08.327Z" - } - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/GetJob.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/GetJob.json deleted file mode 100644 index 9cddc22e76d6..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/GetJob.json +++ /dev/null @@ -1,61 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "workspaceName": "demo_workspace", - "experimentName": "demo_experiment", - "jobName": "demo_job", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-05-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspace/experiments/demo_experiment/jobs/demo_job", - "name": "demo_job", - "type": "Microsoft.BatchAI/Jobs", - "properties": { - "schedulingPriority": "normal", - "cluster": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/clusters/demo_cluster" - }, - "nodeCount": 1, - "containerSettings": { - "imageSourceRegistry": { - "image": "ubuntu" - } - }, - "toolType": "custom", - "customToolkitSettings": { - "commandLine": "echo hi | tee $AZ_BATCHAI_OUTPUT_OUTPUTS/hi.txt" - }, - "stdOutErrPathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles", - "jobOutputDirectoryPathSegment": "00000000-0000-0000-0000-000000000000/demo_resource_group/workspaces/demo_workspace/experiments/demo_experiment/jobs/demo_job/00000000-0000-0000-0000-000000000000", - "inputDirectories": [ - { - "id": "INPUT", - "path": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/input" - } - ], - "outputDirectories": [ - { - "id": "OUTPUTS", - "pathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/", - "pathSuffix": "files" - } - ], - "constraints": { - "maxWallClockTime": "P7D" - }, - "creationTime": "2017-09-27T23:36:52.611Z", - "provisioningState": "succeeded", - "provisioningStateTransitionTime": "2017-09-27T23:36:53.701Z", - "executionState": "running", - "executionStateTransitionTime": "2017-09-27T23:36:56.395Z", - "executionInfo": { - "startTime": "2017-09-27T23:36:54.115Z" - } - } - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/GetWorkspace.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/GetWorkspace.json deleted file mode 100644 index 86c67ea2fdd9..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/GetWorkspace.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "workspaceName": "demo_workspace", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-05-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspace", - "name": "demo_workspace", - "type": "Microsoft.BatchAI/Workspace", - "location": "eastus", - "properties": { - "creationTime": "2017-09-27T21:50:03.828Z", - "provisioningState": "succeeded", - "provisioningStateTransitionTime": "2017-09-27T21:50:03.828Z" - } - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/JobListRemoteLoginInfo.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/JobListRemoteLoginInfo.json deleted file mode 100644 index 13b7d5aafe00..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/JobListRemoteLoginInfo.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "workspaceName": "demo_workspace", - "experimentName": "demo_experiment", - "jobName": "demo_job", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-05-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "nodeId": "tvm-3601533753_1-20170719t162906z", - "ipAddress": "13.84.190.124", - "port": 50000 - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListClusterByWorkspace.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListClusterByWorkspace.json deleted file mode 100644 index 86e7bef7611e..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListClusterByWorkspace.json +++ /dev/null @@ -1,69 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "workspaceName": "demo_workspace", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-05-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspace/demo_workspace/clusters/demo_cluster", - "name": "demo_cluster", - "type": "Microsoft.BatchAI/Clusters", - "properties": { - "provisioningState": "succeeded", - "allocationState": "resizing", - "creationTime": "2017-09-27T22:28:07.645Z", - "allocationStateTransitionTime": "2017-09-27T22:28:08.998Z", - "provisioningStateTransitionTime": "2017-09-27T22:28:08.327Z", - "vmSize": "STANDARD_NC6", - "currentNodeCount": 0, - "nodeStateCounts": { - "runningNodeCount": 0, - "idleNodeCount": 0, - "unusableNodeCount": 0, - "preparingNodeCount": 0, - "leavingNodeCount": 0 - }, - "vmPriority": "dedicated", - "scaleSettings": { - "manual": { - "targetNodeCount": 1, - "nodeDeallocationOption": "requeue" - } - }, - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "UbuntuServer", - "sku": "16.04-LTS", - "version": "latest" - } - }, - "userAccountSettings": { - "adminUserName": "admin_user_name" - }, - "nodeSetup": { - "mountVolumes": { - "azureFileShares": [ - { - "accountName": "storage_account_name", - "azureFileUrl": "https://storage_account_name.file.core.windows.net/azure_file_share_name", - "credentials": {}, - "relativeMountPath": "azfiles", - "fileMode": "0777", - "directoryMode": "0777" - } - ] - } - } - } - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListExperimentByWorkspace.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListExperimentByWorkspace.json deleted file mode 100644 index d3e6990dc623..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListExperimentByWorkspace.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "demo_resource_group", - "workspaceName": "demo_workspace", - "api-version": "2018-05-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspace/demo_workspace/experiments/demo_experiment", - "name": "demo_experiment", - "type": "Microsoft.BatchAI/Experiments", - "properties": { - "creationTime": "2017-09-27T22:27:52.611Z", - "provisioningState": "succeeded", - "provisioningStateTransitionTime": "2017-09-27T22:28:08.327Z" - } - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListFileServerByWorkspace.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListFileServerByWorkspace.json deleted file mode 100644 index 7eb6060f6fbe..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListFileServerByWorkspace.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "workspaceName": "demo_workspace", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-05-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspace/fileservers/fileservercedd134b", - "name": "fileservercedd134b", - "type": "Microsoft.BatchAI/FileServers", - "properties": { - "provisioningState": "succeeded", - "creationTime": "2017-09-27T21:45:28.159Z", - "provisioningStateTransitionTime": "2017-09-27T21:49:25.416Z", - "vmSize": "STANDARD_NC6", - "sshConfiguration": { - "userAccountSettings": { - "adminUserName": "admin_user_name" - } - }, - "dataDisks": { - "diskSizeInGB": 10, - "cachingType": "none", - "diskCount": 2, - "storageAccountType": "Standard_LRS" - }, - "subnet": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.Network/virtualNetworks/7feb1976-8c31-4f1f-bea2-86cb1839a7bavnet/subnets/Subnet-1" - }, - "mountSettings": { - "mountPoint": "/mnt/data", - "fileServerPublicIP": "13.90.141.66", - "fileServerInternalIP": "10.0.0.4" - } - } - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListJobByExperiment.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListJobByExperiment.json deleted file mode 100644 index bac6e5cda218..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListJobByExperiment.json +++ /dev/null @@ -1,64 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "workspaceName": "demo_workspace", - "experimentName": "demo_experimnet", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-05-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspace/jobs/demo_job", - "name": "demo_job", - "type": "Microsoft.BatchAI/Jobs", - "properties": { - "schedulingPriority": "normal", - "cluster": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspace/clusters/demo_cluster" - }, - "nodeCount": 1, - "containerSettings": { - "imageSourceRegistry": { - "image": "ubuntu" - } - }, - "toolType": "custom", - "customToolkitSettings": { - "commandLine": "echo hi | tee $AZ_BATCHAI_OUTPUT_OUTPUTS/hi.txt" - }, - "stdOutErrPathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles", - "jobOutputDirectoryPathSegment": "00000000-0000-0000-0000-000000000000/demo_resource_group/workspaces/demo_workspace/experiments/demo_experiment/jobs/demo_job/00000000-0000-0000-0000-000000000000", - "inputDirectories": [ - { - "id": "INPUT", - "path": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/input" - } - ], - "outputDirectories": [ - { - "id": "OUTPUTS", - "pathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/", - "pathSuffix": "files" - } - ], - "constraints": { - "maxWallClockTime": "P7D" - }, - "creationTime": "2017-09-27T23:36:52.611Z", - "provisioningState": "succeeded", - "provisioningStateTransitionTime": "2017-09-27T23:36:53.701Z", - "executionState": "running", - "executionStateTransitionTime": "2017-09-27T23:36:56.395Z", - "executionInfo": { - "startTime": "2017-09-27T23:36:54.115Z" - } - } - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListOperation.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListOperation.json deleted file mode 100644 index 39c6ee54cbed..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListOperation.json +++ /dev/null @@ -1,255 +0,0 @@ -{ - "parameters": { - "api-version": "2018-05-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "display": { - "description": "Lists Batch AI workspaces or gets the properties of a Batch AI workspace", - "operation": "List or get Batch AI workspaces", - "provider": "Microsoft Batch AI", - "resource": "Batch AI Workspaces" - }, - "name": "Microsoft.BatchAI/workspaces/read", - "origin": "user,system", - "properties": null - }, - { - "display": { - "description": "Creates a new Batch AI workspace or updates an existing Batch AI workspace", - "operation": "Create or update Batch AI workspace", - "provider": "Microsoft Batch AI", - "resource": "Batch AI Workspaces" - }, - "name": "Microsoft.BatchAI/workspaces/write", - "origin": "user,system", - "properties": null - }, - { - "display": { - "description": "Deletes a Batch AI workspace", - "operation": "Delete Batch AI workspace", - "provider": "Microsoft Batch AI", - "resource": "Batch AI Clusters" - }, - "name": "Microsoft.BatchAI/workspaces/delete", - "origin": "user,system", - "properties": null - }, - { - "display": { - "description": "Lists Batch AI experiments or gets the properties of a Batch AI experiment", - "operation": "List or get Batch AI experiements", - "provider": "Microsoft Batch AI", - "resource": "Batch AI Experiments" - }, - "name": "Microsoft.BatchAI/workspaces/experiments/read", - "origin": "user,system", - "properties": null - }, - { - "display": { - "description": "Creates a new Batch AI experiment or updates an existing Batch AI experiment", - "operation": "Create or update Batch AI experiement", - "provider": "Microsoft Batch AI", - "resource": "Batch AI Experiments" - }, - "name": "Microsoft.BatchAI/workspaces/experiments/write", - "origin": "user,system", - "properties": null - }, - { - "display": { - "description": "Deletes a Batch AI experiment", - "operation": "Delete Batch AI experiment", - "provider": "Microsoft Batch AI", - "resource": "Batch AI Experiments" - }, - "name": "Microsoft.BatchAI/workspaces/experiments/delete", - "origin": "user,system", - "properties": null - }, - { - "display": { - "description": "Lists Batch AI clusters or gets the properties of a Batch AI cluster", - "operation": "List or get Batch AI clusters", - "provider": "Microsoft Batch AI", - "resource": "Batch AI Clusters" - }, - "name": "Microsoft.BatchAI/clusters/read", - "origin": "user,system", - "properties": null - }, - { - "display": { - "description": "Lists Batch AI clusters or gets the properties of a Batch AI cluster", - "operation": "List or get Batch AI clusters", - "provider": "Microsoft Batch AI", - "resource": "Batch AI Clusters" - }, - "name": "Microsoft.BatchAI/workspaces/clusters/read", - "origin": "user,system", - "properties": null - }, - { - "display": { - "description": "Creates a new Batch AI cluster or updates an existing Batch AI cluster", - "operation": "Create or update Batch AI cluster", - "provider": "Microsoft Batch AI", - "resource": "Batch AI Clusters" - }, - "name": "Microsoft.BatchAI/workspaces/clusters/write", - "origin": "user,system", - "properties": null - }, - { - "display": { - "description": "Deletes a Batch AI cluster", - "operation": "Delete Batch AI cluster", - "provider": "Microsoft Batch AI", - "resource": "Batch AI Clusters" - }, - "name": "Microsoft.BatchAI/workspaces/clusters/delete", - "origin": "user,system", - "properties": null - }, - { - "display": { - "description": "Lists remote-login information for a Batch AI cluster", - "operation": "List Batch AI cluster remote-login information", - "provider": "Microsoft Batch AI", - "resource": "Batch AI Clusters" - }, - "name": "Microsoft.BatchAI/workspaces/clusters/remoteLoginInformation/action", - "origin": "user,system", - "properties": null - }, - { - "display": { - "description": "Lists Batch AI jobs or gets the properties of a Batch AI job", - "operation": "List or get Batch AI jobs", - "provider": "Microsoft Batch AI", - "resource": "Batch AI Jobs" - }, - "name": "Microsoft.BatchAI/workspaces/experiments/jobs/read", - "origin": "user,system", - "properties": null - }, - { - "display": { - "description": "Creates a new Batch AI job or updates an existing Batch AI job", - "operation": "Create or update Batch AI job", - "provider": "Microsoft Batch AI", - "resource": "Batch AI Jobs" - }, - "name": "Microsoft.BatchAI/workspaces/experiments/jobs/write", - "origin": "user,system", - "properties": null - }, - { - "display": { - "description": "Deletes a Batch AI job", - "operation": "Delete Batch AI job", - "provider": "Microsoft Batch AI", - "resource": "Batch AI Jobs" - }, - "name": "Microsoft.BatchAI/workspaces/experiments/jobs/delete", - "origin": "user,system", - "properties": null - }, - { - "display": { - "description": "Terminates a Batch AI job", - "operation": "Terminate Batch AI job", - "provider": "Microsoft Batch AI", - "resource": "Batch AI Jobs" - }, - "name": "Microsoft.BatchAI/workspaces/experiments/jobs/terminate/action", - "origin": "user,system", - "properties": null - }, - { - "display": { - "description": "Lists remote-login information for a Batch AI job", - "operation": "List Batch AI job remote-login information", - "provider": "Microsoft Batch AI", - "resource": "Batch AI Jobs" - }, - "name": "Microsoft.BatchAI/workspaces/experiments/jobs/remoteLoginInformation/action", - "origin": "user,system", - "properties": null - }, - { - "display": { - "description": "Lists output files for a Batch AI job", - "operation": "List Batch AI job output files", - "provider": "Microsoft Batch AI", - "resource": "Batch AI Jobs" - }, - "name": "Microsoft.BatchAI/workspaces/experiments/jobs/listoutputfiles/action", - "origin": "user,system", - "properties": null - }, - { - "display": { - "description": "Gets Batch AI usages of the specified subscription at the specified Azure region", - "operation": "Get Batch AI Usages", - "provider": "Microsoft Batch AI", - "resource": "Batch AI Usages" - }, - "name": "Microsoft.BatchAI/locations/usages/read", - "origin": "user,system", - "properties": null - }, - { - "display": { - "description": "Registers the subscription for the Batch AI Resource Provider and enables the creation of Batch AI resources", - "operation": "Register the Batch AI Resource Provider", - "provider": "Microsoft Batch AI", - "resource": "Batch AI Resource Provider" - }, - "name": "Microsoft.BatchAI/register/action", - "origin": "user,system", - "properties": null - }, - { - "display": { - "description": "Unregisters the subscription for the Batch AI Resource Provider preventing the creation of Batch AI resources", - "operation": "Unregister the Batch AI Resource Provider", - "provider": "Microsoft Batch AI", - "resource": "Batch AI Resource Provider" - }, - "name": "Microsoft.BatchAI/unregister/action", - "origin": "user,system", - "properties": null - }, - { - "display": { - "description": "Gets Batch AI async operation result at the specified Azure region", - "operation": "Get Batch AI Opreation Result", - "provider": "Microsoft Batch AI", - "resource": "Batch AI Operation Results" - }, - "name": "Microsoft.BatchAI/locations/operationresults/read", - "origin": "user,system", - "properties": null - }, - { - "display": { - "description": "Gets Batch AI async operation status at the specified Azure region", - "operation": "Get Batch AI Opreation Status", - "provider": "Microsoft Batch AI", - "resource": "Batch AI Operation Statuses" - }, - "name": "Microsoft.BatchAI/locations/operationstatuses/read", - "origin": "user,system", - "properties": null - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListOutputFiles.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListOutputFiles.json deleted file mode 100644 index 1a9676422d27..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListOutputFiles.json +++ /dev/null @@ -1,59 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "workspaceName": "demo_workspace", - "experimentName": "demo_experiment", - "jobName": "demo_job", - "outputdirectoryid": "stdouterr", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-05-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "stderr-job_prep.txt", - "fileType": "file", - "downloadUrl": "https://storage_account_name.file.core.windows.net/share/00000000-0000-0000-0000-000000000000/test_mgmt_batchai_jobs_test_job_preparation_hoste0e613b6/jobs/job/host_prep_stderr.txt?sv=2016-05-31&sr=f&sig=CNPJmjDQT9Anld9%2FdnQ52ZBpfOff2el8r4el6J%2BnpJE%3D&se=2017-09-28T01%3A22%3A35Z&sp=rl", - "properties": { - "lastModified": "2017-09-28T00:22:19Z", - "contentLength": 0 - } - }, - { - "name": "stdout-job_prep.txt", - "fileType": "file", - "downloadUrl": "https://storage_account_name.file.core.windows.net/share/00000000-0000-0000-0000-000000000000/test_mgmt_batchai_jobs_test_job_preparation_hoste0e613b6/jobs/job/host_prep_stdout.txt?sv=2016-05-31&sr=f&sig=yK%2F5acWSTdcmBZGGL9%2F3IqeZ7N%2B1sRXfwB%2FaCkoRS%2Bc%3D&se=2017-09-28T01%3A22%3A35Z&sp=rl", - "properties": { - "lastModified": "2017-09-28T00:22:19Z", - "contentLength": 720 - } - }, - { - "name": "stderr.txt", - "fileType": "file", - "downloadUrl": "https://storage_account_name.file.core.windows.net/share/00000000-0000-0000-0000-000000000000/test_mgmt_batchai_jobs_test_job_preparation_hoste0e613b6/jobs/job/stderr.txt?sv=2016-05-31&sr=f&sig=TdvHhdQjvWWA0Z7aPb0oZpPgGbBPOyDarNXWHFnRS3c%3D&se=2017-09-28T01%3A22%3A35Z&sp=rl", - "properties": { - "lastModified": "2017-09-28T00:22:19Z", - "contentLength": 0 - } - }, - { - "name": "stdout.txt", - "fileType": "file", - "downloadUrl": "https://storage_account_name.file.core.windows.net/share/00000000-0000-0000-0000-000000000000/test_mgmt_batchai_jobs_test_job_preparation_hoste0e613b6/jobs/job/stdout.txt?sv=2016-05-31&sr=f&sig=nyydEjNnYpQfovknJc%2B5G%2F05g0IV4acWKlfkM35lh00%3D&se=2017-09-28T01%3A22%3A35Z&sp=rl", - "properties": { - "lastModified": "2017-09-28T00:22:19Z", - "contentLength": 32 - } - }, - { - "name": "counters", - "fileType": "directory" - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListUsages.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListUsages.json deleted file mode 100644 index 4852be27aa0a..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListUsages.json +++ /dev/null @@ -1,168 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "location": "eastus", - "api-version": "2018-05-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "currentValue": 5, - "limit": 20, - "name": { - "localizedValue": "Clusters", - "value": "Clusters" - }, - "unit": "Count" - }, - { - "currentValue": 49, - "limit": 600, - "name": { - "localizedValue": "Total Cluster Dedicated Regional vCPUs", - "value": "Total Cluster Dedicated Regional vCPUs" - }, - "unit": "Count" - }, - { - "currentValue": 1, - "limit": 600, - "name": { - "localizedValue": "Standard D Family Cluster Dedicated vCPUs", - "value": "Standard D Family Cluster Dedicated vCPUs" - }, - "unit": "Count" - }, - { - "currentValue": 0, - "limit": 600, - "name": { - "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs", - "value": "Standard Dv2 Family Cluster Dedicated vCPUs" - }, - "unit": "Count" - }, - { - "currentValue": 48, - "limit": 600, - "name": { - "localizedValue": "Standard NC Family Cluster Dedicated vCPUs", - "value": "Standard NC Family Cluster Dedicated vCPUs" - }, - "unit": "Count" - }, - { - "currentValue": 0, - "limit": 0, - "name": { - "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs", - "value": "Standard NCv2 Family Cluster Dedicated vCPUs" - }, - "unit": "Count" - }, - { - "currentValue": 0, - "limit": 0, - "name": { - "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs", - "value": "Standard NCv3 Family Cluster Dedicated vCPUs" - }, - "unit": "Count" - }, - { - "currentValue": 0, - "limit": 0, - "name": { - "localizedValue": "Standard ND Family Cluster Dedicated vCPUs", - "value": "Standard ND Family Cluster Dedicated vCPUs" - }, - "unit": "Count" - }, - { - "currentValue": 0, - "limit": 600, - "name": { - "localizedValue": "Standard NV Family Cluster Dedicated vCPUs", - "value": "Standard NV Family Cluster Dedicated vCPUs" - }, - "unit": "Count" - }, - { - "currentValue": 0, - "limit": 150, - "name": { - "localizedValue": "Total Cluster Low Priority Regional vCPUs", - "value": "Total Cluster LowPriority Regional vCPUs" - }, - "unit": "Count" - }, - { - "currentValue": 0, - "limit": 150, - "name": { - "localizedValue": "Standard D Family Cluster Low Priority vCPUs", - "value": "Standard D Family Cluster LowPriority vCPUs" - }, - "unit": "Count" - }, - { - "currentValue": 0, - "limit": 150, - "name": { - "localizedValue": "Standard Dv2 Family Cluster Low Priority vCPUs", - "value": "Standard Dv2 Family Cluster LowPriority vCPUs" - }, - "unit": "Count" - }, - { - "currentValue": 0, - "limit": 150, - "name": { - "localizedValue": "Standard NC Family Cluster Low Priority vCPUs", - "value": "Standard NC Family Cluster LowPriority vCPUs" - }, - "unit": "Count" - }, - { - "currentValue": 0, - "limit": 0, - "name": { - "localizedValue": "Standard NCv2 Family Cluster Low Priority vCPUs", - "value": "Standard NCv2 Family Cluster LowPriority vCPUs" - }, - "unit": "Count" - }, - { - "currentValue": 0, - "limit": 0, - "name": { - "localizedValue": "Standard NCv3 Family Cluster Low Priority vCPUs", - "value": "Standard NCv3 Family Cluster LowPriority vCPUs" - }, - "unit": "Count" - }, - { - "currentValue": 0, - "limit": 0, - "name": { - "localizedValue": "Standard ND Family Cluster Low Priority vCPUs", - "value": "Standard ND Family Cluster LowPriority vCPUs" - }, - "unit": "Count" - }, - { - "currentValue": 0, - "limit": 150, - "name": { - "localizedValue": "Standard NV Family Cluster Low Priority vCPUs", - "value": "Standard NV Family Cluster LowPriority vCPUs" - }, - "unit": "Count" - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListWorkspace.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListWorkspace.json deleted file mode 100644 index 4c9d5ace6f2e..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListWorkspace.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-05-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspace/demo_workspace", - "name": "demo_workspace", - "type": "Microsoft.BatchAI/Workspaces", - "location": "eastus", - "properties": { - "creationTime": "2017-09-27T22:28:08.325Z", - "provisioningState": "succeeded", - "provisioningStateTransitionTime": "2017-09-27T22:28:08.327Z" - } - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListWorkspaceByResourceGroup.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListWorkspaceByResourceGroup.json deleted file mode 100644 index a2684681d8be..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListWorkspaceByResourceGroup.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "demo_resource_group", - "api-version": "2018-05-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspace/demo_workspace", - "name": "demo_workspace", - "type": "Microsoft.BatchAI/Workspaces", - "location": "eastus", - "properties": { - "creationTime": "2017-09-27T22:28:08.325Z", - "provisioningState": "succeeded", - "provisioningStateTransitionTime": "2017-09-27T22:28:08.327Z" - } - } - ] - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PatchCluster.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PatchCluster.json deleted file mode 100644 index 5d6802d5aabb..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PatchCluster.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "workspaceName": "demo_workspace", - "clusterName": "demo_cluster", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-05-01", - "parameters": { - "properties": { - "scaleSettings": { - "autoScale": { - "minimumNodeCount": 0, - "maximumNodeCount": 10 - } - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspace/clusters/demo_cluster", - "name": "demo_cluster", - "type": "Microsoft.BatchAI/Clusters", - "properties": { - "provisioningState": "succeeded", - "allocationState": "steady", - "creationTime": "2017-09-27T21:43:55.215Z", - "allocationStateTransitionTime": "2017-09-27T21:43:57.664Z", - "provisioningStateTransitionTime": "2017-09-27T21:43:56.238Z", - "vmSize": "STANDARD_NC6", - "currentNodeCount": 0, - "nodeStateCounts": { - "runningNodeCount": 0, - "idleNodeCount": 0, - "unusableNodeCount": 0, - "preparingNodeCount": 0, - "leavingNodeCount": 0 - }, - "vmPriority": "dedicated", - "scaleSettings": { - "autoScale": { - "minimumNodeCount": 0, - "maximumNodeCount": 10, - "initialNodeCount": 0 - } - }, - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "UbuntuServer", - "sku": "16.04-LTS", - "version": "latest" - } - }, - "userAccountSettings": { - "adminUserName": "admin_user_name" - }, - "nodeSetup": { - "mountVolumes": { - "azureFileShares": [ - { - "accountName": "storage_account_name", - "azureFileUrl": "https://storage_account_name.file.core.windows.net/azure_file_share_name", - "credentials": {}, - "relativeMountPath": "azfiles", - "fileMode": "0777", - "directoryMode": "0777" - } - ] - } - } - } - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PatchWorkspace.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PatchWorkspace.json deleted file mode 100644 index 7e5160fcf08f..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PatchWorkspace.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "workspaceName": "demo_workspace", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-05-01", - "parameters": { - "tags": { - "key1": "value1" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspace", - "name": "demo_worksapce", - "type": "Microsoft.BatchAI/Workspaces", - "location": "eastus", - "tags": { - "key1": "value1" - }, - "properties": { - "creationTime": "2017-09-27T21:50:03.828Z", - "provisioningState": "succeeded", - "provisioningStateTransitionTime": "2017-09-27T21:50:03.828Z" - } - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PutCluster.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PutCluster.json deleted file mode 100644 index 5bd81f4ee174..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PutCluster.json +++ /dev/null @@ -1,108 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "workspaceName": "demo_workspace", - "clusterName": "demo_cluster", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-05-01", - "parameters": { - "properties": { - "scaleSettings": { - "manual": { - "nodeDeallocationOption": "requeue", - "targetNodeCount": 1 - } - }, - "userAccountSettings": { - "adminUserPassword": "admin_user_password", - "adminUserSshPublicKey": "ssh-rsa AAAAB3NzaC1yc...", - "adminUserName": "admin_user_name" - }, - "nodeSetup": { - "mountVolumes": { - "azureFileShares": [ - { - "relativeMountPath": "azfiles", - "directoryMode": "0777", - "accountName": "storage_account_name", - "azureFileUrl": "https://storage_account_name.file.core.windows.net/azure_file_share_name", - "fileMode": "0777", - "credentials": { - "accountKey": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000==" - } - } - ] - } - }, - "vmPriority": "dedicated", - "vmSize": "STANDARD_NC6" - } - } - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2018-05-01", - "Retry-After": 15 - } - }, - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspace/clusters/demo_cluster", - "name": "demo_cluster", - "type": "Microsoft.BatchAI/Clusters", - "properties": { - "provisioningState": "succeeded", - "allocationState": "resizing", - "creationTime": "2017-09-27T21:50:02.377Z", - "allocationStateTransitionTime": "2017-09-27T21:50:04.521Z", - "provisioningStateTransitionTime": "2017-09-27T21:50:03.828Z", - "vmSize": "STANDARD_NC6", - "currentNodeCount": 0, - "nodeStateCounts": { - "runningNodeCount": 0, - "idleNodeCount": 0, - "unusableNodeCount": 0, - "preparingNodeCount": 0, - "leavingNodeCount": 0 - }, - "vmPriority": "dedicated", - "scaleSettings": { - "manual": { - "targetNodeCount": 1, - "nodeDeallocationOption": "requeue" - } - }, - "virtualMachineConfiguration": { - "imageReference": { - "publisher": "Canonical", - "offer": "UbuntuServer", - "sku": "16.04-LTS", - "version": "latest" - } - }, - "userAccountSettings": { - "adminUserName": "admin_user_name" - }, - "nodeSetup": { - "mountVolumes": { - "azureFileShares": [ - { - "accountName": "storage_account_name", - "azureFileUrl": "https://storage_account_name.file.core.windows.net/azure_file_share_name", - "credentials": {}, - "relativeMountPath": "azfiles", - "fileMode": "0777", - "directoryMode": "0777" - } - ] - } - }, - "subnet": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.Network/virtualNetworks/7feb1976-8c31-4f1f-bea2-86cb1839a7bavnet/subnets/Subnet-1" - } - } - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PutExperiment.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PutExperiment.json deleted file mode 100644 index 3b4b6f8bfd59..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PutExperiment.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "workspaceName": "demo_workspace", - "experimentName": "demo_experiment", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-05-01", - "parameters": { - "properties": {} - } - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2018-05-01", - "Retry-After": 15 - } - }, - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspace/experiments/demo_experiment", - "name": "demo_experiment", - "type": "Microsoft.BatchAI/Experiments", - "properties": { - "creationTime": "2017-09-27T21:49:52.611Z", - "provisioningState": "succeeded", - "provisioningStateTransitionTime": "2017-09-27T21:50:03.828Z" - } - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PutFileServer.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PutFileServer.json deleted file mode 100644 index e11fd4ec53b0..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PutFileServer.json +++ /dev/null @@ -1,65 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "workspaceName": "demo_workspace", - "fileServerName": "demo_nfs", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-05-01", - "parameters": { - "properties": { - "sshConfiguration": { - "userAccountSettings": { - "adminUserPassword": "admin_user_password", - "adminUserName": "admin_user_name" - } - }, - "dataDisks": { - "diskSizeInGB": 10, - "storageAccountType": "Standard_LRS", - "diskCount": 2 - }, - "vmSize": "STANDARD_NC6" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspace/fileservers/fileservercedd134b", - "name": "demo_nfs", - "type": "Microsoft.BatchAI/FileServers", - "properties": { - "provisioningState": "succeeded", - "creationTime": "2017-09-27T21:45:28.159Z", - "provisioningStateTransitionTime": "2017-09-27T21:49:25.416Z", - "vmSize": "STANDARD_NC6", - "sshConfiguration": { - "userAccountSettings": { - "adminUserName": "admin_user_name" - } - }, - "dataDisks": { - "diskSizeInGB": 10, - "cachingType": "none", - "diskCount": 2, - "storageAccountType": "Standard_LRS" - }, - "subnet": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.Network/virtualNetworks/7feb1976-8c31-4f1f-bea2-86cb1839a7bavnet/subnets/Subnet-1" - }, - "mountSettings": { - "mountPoint": "/mnt/data", - "fileServerPublicIP": "13.90.141.66", - "fileServerInternalIP": "10.0.0.4" - } - } - } - }, - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2018-05-01", - "Retry-After": 15 - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PutJob.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PutJob.json deleted file mode 100644 index 8d9d08d6cb20..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PutJob.json +++ /dev/null @@ -1,98 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "workspaceName": "demo_workspace", - "experimentName": "demo_experiment", - "jobName": "demo_job", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-05-01", - "parameters": { - "properties": { - "stdOutErrPathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles", - "cluster": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspace/demo_workspace/clusters/demo_cluster" - }, - "nodeCount": 1, - "customToolkitSettings": { - "commandLine": "echo hi | tee $AZ_BATCHAI_OUTPUT_OUTPUTS/hi.txt" - }, - "inputDirectories": [ - { - "id": "INPUT", - "path": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/input" - } - ], - "schedulingPriority": "normal", - "containerSettings": { - "imageSourceRegistry": { - "image": "ubuntu" - } - }, - "outputDirectories": [ - { - "pathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/", - "id": "OUTPUTS", - "pathSuffix": "files" - } - ] - } - } - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2018-05-01", - "Retry-After": 15 - } - }, - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspace/experiments/demo_experiment/jobs/demo_job", - "name": "demo_job", - "type": "Microsoft.BatchAI/Job", - "properties": { - "schedulingPriority": "normal", - "cluster": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspace/clusters/demo_cluster" - }, - "nodeCount": 1, - "containerSettings": { - "imageSourceRegistry": { - "image": "ubuntu" - } - }, - "toolType": "custom", - "customToolkitSettings": { - "commandLine": "echo hi | tee $AZ_BATCHAI_OUTPUT_OUTPUTS/hi.txt" - }, - "stdOutErrPathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles", - "jobOutputDirectoryPathSegment": "00000000-0000-0000-0000-000000000000/demo_resource_group/workspaces/demo_workspace/00000000-0000-0000-0000-000000000000/experiments/demo_experiment/00000000-0000-0000-0000-000000000000/jobs/demo_job/00000000-0000-0000-0000-000000000000", - "inputDirectories": [ - { - "id": "INPUT", - "path": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/input" - } - ], - "outputDirectories": [ - { - "id": "OUTPUTS", - "pathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/", - "pathSuffix": "files" - } - ], - "constraints": { - "maxWallClockTime": "P7D" - }, - "creationTime": "2017-09-27T23:36:52.611Z", - "provisioningState": "succeeded", - "provisioningStateTransitionTime": "2017-09-27T23:36:53.701Z", - "executionState": "running", - "executionStateTransitionTime": "2017-09-27T23:36:56.395Z", - "executionInfo": { - "startTime": "2017-09-27T23:36:54.115Z" - } - } - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PutWorkspace.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PutWorkspace.json deleted file mode 100644 index 0fd0054e9ef5..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PutWorkspace.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "workspaceName": "demo_workspace", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-05-01", - "parameters": { - "location": "eastus" - } - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2018-05-01", - "Retry-After": 15 - } - }, - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspace", - "name": "demo_worksapce", - "type": "Microsoft.BatchAI/Workspaces", - "location": "eastus", - "properties": { - "creationTime": "2017-09-27T21:50:03.828Z", - "provisioningState": "succeeded", - "provisioningStateTransitionTime": "2017-09-27T21:50:03.828Z" - } - } - } - } -} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/TerminateJob.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/TerminateJob.json deleted file mode 100644 index 717faf5754ed..000000000000 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/TerminateJob.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "demo_resource_group", - "workspaceName": "demo_workspace", - "experimentName": "demo_experiment", - "jobName": "demo_job", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-05-01" - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2018-05-01", - "Retry-After": 15 - } - }, - "200": {} - } -} diff --git a/specification/batchai/resource-manager/readme.go.md b/specification/batchai/resource-manager/readme.go.md deleted file mode 100644 index b72de716abdf..000000000000 --- a/specification/batchai/resource-manager/readme.go.md +++ /dev/null @@ -1,46 +0,0 @@ -## Go - -These settings apply only when `--go` is specified on the command line. - -``` yaml $(go) -go: - license-header: MICROSOFT_MIT_NO_VERSION - clear-output-folder: true - namespace: batchai -``` - -### Go multi-api - -``` yaml $(go) && $(multiapi) -batch: - - tag: package-2017-09-preview - - tag: package-2018-03 - - tag: package-2018-05 -``` - -### Tag: package-2017-09-preview and go - -These settings apply only when `--tag=package-2017-09-preview --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag)=='package-2017-09-preview' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2017-09-01-preview/$(namespace) -``` - -### Tag: package-2018-03 and go - -These settings apply only when `--tag=package-2018-03 --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag)=='package-2018-03' && $(go) -output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2018-03-01/$(namespace) -``` - -### Tag: package-2018-05 and go - -These settings apply only when `--tag=package-2018-05 --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag)=='package-2018-05' && $(go) -output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2018-05-01/$(namespace) -``` \ No newline at end of file diff --git a/specification/batchai/resource-manager/readme.md b/specification/batchai/resource-manager/readme.md deleted file mode 100644 index 5167bc9667aa..000000000000 --- a/specification/batchai/resource-manager/readme.md +++ /dev/null @@ -1,188 +0,0 @@ -# Batch AI SDK - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Batch AI SDK. - ---- -## Getting Started -To build the SDK for Batch AI, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the Batch AI. - -``` yaml -openapi-type: arm -tag: package-2018-05 -``` - - -### Tag: package-2017-09-preview - -These settings apply only when `--tag=package-2017-09-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2017-09-preview' -input-file: -- Microsoft.BatchAI/preview/2017-09-01-preview/BatchAI.json -``` - -### Tag: package-2018-03 - -These settings apply only when `--tag=package-2018-03` is specified on the command line. - -``` yaml $(tag) == 'package-2018-03' -input-file: -- Microsoft.BatchAI/stable/2018-03-01/BatchAI.json -``` - -### Tag: package-2018-05 - -These settings apply only when `--tag=package-2018-05` is specified on the command line. - -``` yaml $(tag) == 'package-2018-05' -input-file: -- Microsoft.BatchAI/stable/2018-05-01/BatchAI.json -``` - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-resource-manager-schemas -``` - - -## CSharp Settings - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.BatchAI - payload-flattening-threshold: 1 - output-folder: $(csharp-sdks-folder)/batchai/Microsoft.Azure.Management.BatchAI/src/Generated - clear-output-folder: true -``` - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.batchai - package-name: azure-mgmt-batchai - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-batchai/azure/mgmt/batchai -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-batchai -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.batchai -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-batchai -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2017-09-preview - - tag: package-2018-03 - - tag: package-2018-05 -``` - -### Tag: package-2017-09-preview and java - -These settings apply only when `--tag=package-2017-09-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag)=='package-2017-09-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.batchai.v2017_09_01_preview - output-folder: $(azure-libraries-for-java-folder)/sdk/batchai/mgmt-v2017_09_01_preview -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2018-03 and java - -These settings apply only when `--tag=package-2018-03 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag)=='package-2018-03' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.batchai.v2018_03_01 - output-folder: $(azure-libraries-for-java-folder)/sdk/batchai/mgmt-v2018_03_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2018-05 and java - -These settings apply only when `--tag=package-2018-05 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag)=='package-2018-05' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.batchai.v2018_05_01 - output-folder: $(azure-libraries-for-java-folder)/sdk/batchai/mgmt-v2018_05_01 -regenerate-manager: true -generate-interface: true -``` - - - diff --git a/specification/batchai/resource-manager/readme.nodejs.md b/specification/batchai/resource-manager/readme.nodejs.md deleted file mode 100644 index 0b3cb3651787..000000000000 --- a/specification/batchai/resource-manager/readme.nodejs.md +++ /dev/null @@ -1,15 +0,0 @@ -## Node.js - -These settings apply only when `--nodejs` is specified on the command line. -Please also specify `--node-sdks-folder=`. - -``` yaml $(nodejs) -nodejs: - azure-arm: true - package-name: azure-arm-batchai - output-folder: $(node-sdks-folder)/lib/services/batchaiManagement - payload-flattening-threshold: 1 - generate-license-txt: true - generate-package-json: true - generate-readme-md: true -``` diff --git a/specification/batchai/resource-manager/readme.typescript.md b/specification/batchai/resource-manager/readme.typescript.md deleted file mode 100644 index 7fe1eb8e1ad6..000000000000 --- a/specification/batchai/resource-manager/readme.typescript.md +++ /dev/null @@ -1,14 +0,0 @@ -## TypeScript - -These settings apply only when `--typescript` is specified on the command line. -Please also specify `--typescript-sdks-folder=`. - -``` yaml $(typescript) -typescript: - azure-arm: true - package-name: "@azure/arm-batchai" - output-folder: "$(typescript-sdks-folder)/sdk/batchai/arm-batchai" - clear-output-folder: true - payload-flattening-threshold: 1 - generate-metadata: true -``` diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2020-09-01-preview/billingPromotions.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2020-09-01-preview/billingPromotions.json new file mode 100644 index 000000000000..b0e4afadc220 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2020-09-01-preview/billingPromotions.json @@ -0,0 +1,454 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-09-01-preview", + "title": "BillingManagementClient", + "description": "Billing client provides access to billing resources for Azure subscriptions." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.Billing/promotions/{promotionId}": { + "put": { + "summary": "Activate promotion", + "description": "Activate promotion and create promotion resource.", + "operationId": "Activate_Promotion", + "x-ms-examples": { + "PromotionActivation": { + "$ref": "./examples/PromotionActivation.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/promotionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PromotionCreateRequest" + }, + "description": "Request parameters that are provided to activate the promotion." + } + ], + "tags": [ + "Promotion, Activate" + ], + "responses": { + "200": { + "description": "The resource has been created", + "schema": { + "$ref": "#/definitions/PromotionResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "summary": "Get a specific Promotion.", + "description": "Get the details of the `Promotion`.", + "operationId": "Promotion_Get", + "x-ms-examples": { + "GetPromotion": { + "$ref": "./examples/PromotionDetails.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/promotionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "tags": [ + "Promotion" + ], + "responses": { + "200": { + "description": "Details of the `Promotion`.", + "schema": { + "$ref": "#/definitions/PromotionResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/promotions": { + "get": { + "summary": "Get all `Promotion`s.", + "description": "List of all the `Promotion`s that the user has access.", + "operationId": "Promotions_List", + "x-ms-examples": { + "PromotionList": { + "$ref": "./examples/GetPromotions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "tags": [ + "Promotion" + ], + "responses": { + "200": { + "description": "List of `Promotion`s", + "schema": { + "$ref": "#/definitions/PromotionList" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/promotions/{promotionSkuId}/checkEligibility": { + "get": { + "tags": [ + "Promotion_CheckEligibility" + ], + "operationId": "Promotion_CheckEligibility", + "description": "Checks the eligibility of a subscription for all active promotions.", + "x-ms-examples": { + "PromotionCheckEligibility": { + "$ref": "./examples/PromotionCheckEligibility.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/promotionSkuId" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PromotionCheckEligibilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "PromotionCreateRequest": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "sku": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PromotionCreateSkuNameRequestProperties" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PromotionCreateRequestProperties" + } + } + }, + "PromotionCreateSkuNameRequestProperties": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "SKU Name of the promotion to activate" + } + } + }, + "PromotionCreateRequestProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "Friendly name for user to easily identified the promotion." + }, + "appliedScopes": { + "$ref": "#/definitions/AppliedScopes", + "description": "List of subscriptions getting the benefit of the promotion." + }, + "orderId": { + "type": "string", + "description": "Unique Id for the promotion order." + } + } + }, + "PromotionList": { + "type": "object", + "properties": { + "value": { + "description": "The list of promotions.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/PromotionResponse" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "PromotionResponse": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "etag": { + "type": "integer", + "format": "int64" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Identifier of the promotion" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Name of the promotion" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PromotionResponseProperties" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Type of resource. \"Microsoft.Billing/Promotions\"" + } + } + }, + "PromotionResponseProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "Friendly name for user to easily identified the promotion." + }, + "effectiveDateTime": { + "type": "string", + "format": "date-time", + "description": "This is the DateTime when the promotion would come in effect" + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "Last update time of the promotion resource." + }, + "expiryDate": { + "type": "string", + "format": "date", + "description": "This is the date when the Reservation will expire." + }, + "provisioningState": { + "type": "string", + "description": "Current state of the promotion." + }, + "appliedScopes": { + "$ref": "#/definitions/AppliedScopes", + "description": "List of subscriptions getting the benefit of the promotion." + } + } + }, + "AppliedScopes": { + "type": "array", + "description": "List of the subscriptions that the benefit will be applied.", + "items": { + "type": "string", + "minItems": 1, + "maxItems": 1 + } + }, + "PromotionCheckEligibilityResponse": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PromotionCheckEligibilityResponseProperties" + } + } + }, + "PromotionCheckEligibilityResponseProperties": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Name of the promotion" + }, + "name": { + "type": "string", + "description": "Name of the promotion" + }, + "eligible": { + "type": "boolean", + "description": "Specifies whether the subscription is eligible for the promotion" + }, + "reason": { + "type": "string", + "description": "Reason in case the subscription is not eligible for promotion." + }, + "eligibilitySubscriptionId": { + "type": "string", + "description": "Subscription Id on which the eligibility check was performed." + }, + "expiryDate": { + "type": "string", + "format": "date", + "description": "Date till when the promotion is available." + } + } + }, + "ErrorResponse": { + "description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "error": { + "description": "The details of the error.", + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "ErrorDetails": { + "description": "The details of the error.", + "properties": { + "code": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "The target of the particular error.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "The sub details of the error.", + "readOnly": true, + "$ref": "#/definitions/ErrorSubDetails" + } + } + }, + "ErrorSubDetails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "The target of the particular error.", + "type": "string", + "readOnly": true + } + } + } + } + }, + "parameters": { + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The version of the API to be used with the client request. The current version is 2019-10-01-preview." + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The ID that uniquely identifies an Azure subscription.", + "required": true, + "type": "string" + }, + "promotionIdParameter": { + "name": "promotionId", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "description": "Promotion Id" + }, + "promotionSkuId": { + "name": "promotionSkuId", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "description": "Promotion Sku Id" + } + }, + "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" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2020-09-01-preview/examples/GetPromotions.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2020-09-01-preview/examples/GetPromotions.json new file mode 100644 index 000000000000..6063a7926691 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2020-09-01-preview/examples/GetPromotions.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2020-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/promotions/105363ba-c9e4-421e-a630-4968bdc3f217", + "type": "Microsoft.Billing/promotions", + "name": "105363ba-c9e4-421e-a630-4968bdc3f217", + "etag": 1, + "properties": { + "appliedScopes": [ + "/subscriptions/a4f60096-7846-4c87-9143-771e73ae26ce" + ], + "provisioningState": "Creating", + "displayName": "test-promo1", + "effectiveDateTime": "2020-10-19T21:03:19.9905904Z", + "lastUpdatedDateTime": "2020-10-19T21:03:19.9905904Z", + "expiryDate": "2021-01-31" + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2020-09-01-preview/examples/PromotionActivation.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2020-09-01-preview/examples/PromotionActivation.json new file mode 100644 index 000000000000..764d4c7d6818 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2020-09-01-preview/examples/PromotionActivation.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2020-09-01-preview", + "promotionId": "ff0f1add-122a-43c1-a2ec-c2277781667d", + "parameters": { + "sku": { + "name": "wvd_promo_30p" + }, + "properties": { + "appliedScopes": [ + "/subscriptions/f6dc64c8-34bb-43d3-96b0-fd2b8c94f1c3" + ], + "displayName": "promotion-displayname", + "orderId": "ff0f1add-122a-43c1-a2ec-c2277781667d" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/promotions/ff0f1add-122a-43c1-a2ec-c2277781667d", + "type": "Microsoft.Billing/promotions", + "name": "ff0f1add-122a-43c1-a2ec-c2277781667d", + "properties": { + "appliedScopes": [ + "/subscriptions/a4f60096-7846-4c87-9143-771e73ae26ce" + ], + "provisioningState": "Succeeded", + "expiryDate": "2021-02-01", + "displayName": "promotion-displayname", + "effectiveDateTime": "2020-11-03T02:26:53.0006733Z" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2020-09-01-preview/examples/PromotionCheckEligibility.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2020-09-01-preview/examples/PromotionCheckEligibility.json new file mode 100644 index 000000000000..b6fd54b05579 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2020-09-01-preview/examples/PromotionCheckEligibility.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2020-09-01-preview", + "promotionSkuId": "wvd_promo_30p", + "subscriptionId": "f6dc64c8-34bb-43d3-96b0-fd2b8c94f1c3" + }, + "responses": { + "200": { + "body": { + "properties": { + "id": "wvd_promo_30p", + "name": "WVD 30 percent off", + "eligible": true, + "reason": "None", + "eligibilitySubscriptionId": "f6dc64c8-34bb-43d3-96b0-fd2b8c94f1c3", + "expiryDate": "2021-10-01" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2020-09-01-preview/examples/PromotionDetails.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2020-09-01-preview/examples/PromotionDetails.json new file mode 100644 index 000000000000..4a4e4829822f --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2020-09-01-preview/examples/PromotionDetails.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2020-09-01-preview", + "promotionId": "{promotionId}" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/promotions/105363ba-c9e4-421e-a630-4968bdc3f217", + "type": "Microsoft.Billing/promotions", + "name": "105363ba-c9e4-421e-a630-4968bdc3f217", + "etag": 1, + "properties": { + "appliedScopes": [ + "/subscriptions/a4f60096-7846-4c87-9143-771e73ae26ce" + ], + "provisioningState": "Creating", + "displayName": "test-promo1", + "effectiveDateTime": "2020-10-19T21:03:19.9905904Z", + "lastUpdatedDateTime": "2020-10-19T21:03:19.9905904Z", + "expiryDate": "2020-10-19" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/billing.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/billing.json index 5256816c34ae..f21b8f6c8c51 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/billing.json +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/billing.json @@ -5729,6 +5729,12 @@ "$ref": "#/definitions/Transaction" } }, + "totalCount": { + "description": "Total number of records.", + "type": "number", + "format": "int32", + "readOnly": true + }, "nextLink": { "description": "The link (url) to the next page of results.", "type": "string", diff --git a/specification/billing/resource-manager/readme.md b/specification/billing/resource-manager/readme.md index 8cb5f3f3a9a5..83c64370e22e 100644 --- a/specification/billing/resource-manager/readme.md +++ b/specification/billing/resource-manager/readme.md @@ -38,6 +38,17 @@ input-file: - Microsoft.Billing/stable/2020-05-01/billing.json - Microsoft.Billing/preview/2018-03-01-preview/billingV2.json ``` + +### Tag: package-2020-09-preview + +These settings apply only when `--tag=package-2020-09-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2020-09-preview' +input-file: +- Microsoft.Billing/stable/2020-05-01/billing.json +- Microsoft.Billing/preview/2020-09-01-preview/billingPromotions.json +``` + ### Tag: package-2020-11-preview These settings apply only when `--tag=package-2020-11-preview` is specified on the command line. diff --git a/specification/blueprint/resource-manager/readme.md b/specification/blueprint/resource-manager/readme.md index 5d57c7587278..3445d11dc42a 100644 --- a/specification/blueprint/resource-manager/readme.md +++ b/specification/blueprint/resource-manager/readme.md @@ -62,7 +62,7 @@ swagger-to-sdk: - repo: azure-sdk-for-net - repo: azure-sdk-for-go - repo: azure-sdk-for-js - - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 - repo: azure-resource-manager-schemas ``` diff --git a/specification/blueprint/resource-manager/readme.python.md b/specification/blueprint/resource-manager/readme.python.md index c5fa5e96e328..e39e1e3a364a 100644 --- a/specification/blueprint/resource-manager/readme.python.md +++ b/specification/blueprint/resource-manager/readme.python.md @@ -2,27 +2,22 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.blueprint - package-name: azure-mgmt-blueprint - title: BlueprintManagementClient - description: The Blueprint Client. - clear-output-folder: true +``` yaml $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-blueprint +no-namespace-folders: true +package-version: 1.0.0b1 +clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-blueprint/azure/mgmt/blueprint + +``` yaml $(python-mode) == 'update' && $(track2) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/blueprint/azure-mgmt-blueprint/azure/mgmt/blueprint +``` + +``` yaml $(python-mode) == 'create' && $(track2) +basic-setup-py: true +output-folder: $(python-sdks-folder)/blueprint/azure-mgmt-blueprint ``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-blueprint -``` \ No newline at end of file diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/botservice.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/botservice.json index 772e0a1c5d47..3de5ee04b265 100644 --- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/botservice.json +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/botservice.json @@ -1554,10 +1554,31 @@ "readOnly": true, "description": "The bot's endpoint version" }, + "msaAppType": { + "type": "string", + "description": "Microsoft App Type for the bot", + "enum": [ + "UserAssignedMSI", + "SingleTenant", + "MultiTenant" + ], + "x-ms-enum": { + "name": "msaAppType", + "modelAsString": true + } + }, "msaAppId": { "type": "string", "description": "Microsoft App Id for the bot" }, + "msaAppTenantId": { + "type": "string", + "description": "Microsoft App Tenant Id for the bot" + }, + "msaAppMSIResourceId": { + "type": "string", + "description": "Microsoft App Managed Identity Resource Id for the bot" + }, "configuredChannels": { "type": "array", "items": { @@ -1609,9 +1630,21 @@ "type": "boolean", "description": "Whether the bot is in an isolated network" }, + "disableLocalAuth": { + "type": "boolean", + "description": "Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication." + }, "schemaTransformationVersion": { "type": "string", "description": "The channel schema transformation version for the bot" + }, + "privateEndpointConnections": { + "type": "array", + "readOnly": true, + "description": "List of Private Endpoint Connections configured for the bot", + "items": { + "$ref": "./privatelinks.json#/definitions/PrivateEndpointConnection" + } } }, "description": "The parameters to provide for the Bot.", @@ -2137,6 +2170,10 @@ "type": "string", "description": "The Slack verification token. Value only returned through POST to the action Channel List API, otherwise empty." }, + "scopes": { + "type": "string", + "description": "The Slack permission scopes." + }, "landingPageUrl": { "type": "string", "description": "The Slack landing page Url" diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/CreateBot.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/CreateBot.json index 459eed1e7555..c459dffeba3a 100644 --- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/CreateBot.json +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/CreateBot.json @@ -28,10 +28,14 @@ "luisappid2" ], "luisKey": "luiskey", + "msaAppType": "UserAssignedMSI", "msaAppId": "exampleappid", + "msaAppTenantId": "exampleapptenantid", + "msaAppMSIResourceId": "/subscriptions/foo/resourcegroups/bar/providers/microsoft.managedidentity/userassignedidentities/sampleId", "isCmekEnabled": true, "cmekKeyVaultUrl": "https://myCmekKey", "isIsolated": false, + "disableLocalAuth": true, "schemaTransformationVersion": "1.0" } } @@ -61,7 +65,10 @@ "luisappid1", "luisappid2" ], + "msaAppType": "UserAssignedMSI", "msaAppId": "msaappid", + "msaAppTenantId": "msaapptenantid", + "msaAppMSIResourceId": "/subscriptions/foo/resourcegroups/bar/providers/microsoft.managedidentity/userassignedidentities/sampleId", "configuredChannels": [ "facebook", "groupme" @@ -72,6 +79,7 @@ "isCmekEnabled": true, "cmekKeyVaultUrl": "https://myCmekKey", "isIsolated": false, + "disableLocalAuth": true, "schemaTransformationVersion": "1.0" } } @@ -98,7 +106,10 @@ "luisappid1", "luisappid2" ], + "msaAppType": "UserAssignedMSI", "msaAppId": "msaappid", + "msaAppTenantId": "msaapptenantid", + "msaAppMSIResourceId": "/subscriptions/foo/resourcegroups/bar/providers/microsoft.managedidentity/userassignedidentities/sampleId", "configuredChannels": [ "facebook", "groupme" @@ -109,6 +120,7 @@ "isCmekEnabled": true, "cmekKeyVaultUrl": "https://myCmekKey", "isIsolated": false, + "disableLocalAuth": true, "schemaTransformationVersion": "1.0" } } diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetBot.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetBot.json index 478fbb23654d..f7d816111dc9 100644 --- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetBot.json +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetBot.json @@ -30,7 +30,10 @@ "luisappid1", "luisappid2" ], + "msaAppType": "UserAssignedMSI", "msaAppId": "msaappid", + "msaAppTenantId": "msaapptenantid", + "msaAppMSIResourceId": "/subscriptions/foo/resourcegroups/bar/providers/microsoft.managedidentity/userassignedidentities/sampleId", "configuredChannels": [ "facebook", "groupme" @@ -41,7 +44,24 @@ "isCmekEnabled": true, "cmekKeyVaultUrl": "https://myCmekKey", "isIsolated": false, - "schemaTransformationVersion": "1.0" + "schemaTransformationVersion": "1.0", + "disableLocalAuth": true, + "privateEndpointConnections": [ + { + "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.BotService/botServices/samplebotname/privateEndpointConnections/privatelink", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.Network/privateEndpoints/privatelink" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] } } } diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetPrivateEndpointConnection.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetPrivateEndpointConnection.json index 99cfb5068631..080872d4aa88 100644 --- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetPrivateEndpointConnection.json +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetPrivateEndpointConnection.json @@ -20,7 +20,7 @@ "privateLinkServiceConnectionState": { "status": "Approved", "description": "Auto-Approved", - "actionRequired": "None" + "actionsRequired": "None" } } } diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/ListBotsByResourceGroup.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/ListBotsByResourceGroup.json index 07a253f7c039..6c61eae3c818 100644 --- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/ListBotsByResourceGroup.json +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/ListBotsByResourceGroup.json @@ -31,7 +31,10 @@ "luisappid1", "luisappid2" ], + "msaAppType": "UserAssignedMSI", "msaAppId": "msaappid", + "msaAppTenantId": "msaapptenantid", + "msaAppMSIResourceId": "/subscriptions/foo/resourcegroups/bar/providers/microsoft.managedidentity/userassignedidentities/sampleId", "configuredChannels": [ "facebook", "groupme" @@ -42,6 +45,7 @@ "isCmekEnabled": true, "cmekKeyVaultUrl": "https://myCmekKey", "isIsolated": false, + "disableLocalAuth": true, "schemaTransformationVersion": "1.0" } } diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/ListBotsBySubscription.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/ListBotsBySubscription.json index 8988345f5d8c..af352d809295 100644 --- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/ListBotsBySubscription.json +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/ListBotsBySubscription.json @@ -30,7 +30,10 @@ "luisappid1", "luisappid2" ], + "msaAppType": "UserAssignedMSI", "msaAppId": "msaappid", + "msaAppTenantId": "msaapptenantid", + "msaAppMSIResourceId": "/subscriptions/foo/resourcegroups/bar/providers/microsoft.managedidentity/userassignedidentities/sampleId", "configuredChannels": [ "facebook", "groupme" @@ -41,6 +44,7 @@ "isCmekEnabled": true, "cmekKeyVaultUrl": "https://myCmekKey", "isIsolated": false, + "disableLocalAuth": true, "schemaTransformationVersion": "1.0" } } diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/ListPrivateEndpointConnections.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/ListPrivateEndpointConnections.json index 7408d6fa87c6..ed58760cd1e4 100644 --- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/ListPrivateEndpointConnections.json +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/ListPrivateEndpointConnections.json @@ -21,7 +21,7 @@ "privateLinkServiceConnectionState": { "status": "Approved", "description": "Auto-Approved", - "actionRequired": "None" + "actionsRequired": "None" } } }, @@ -37,7 +37,7 @@ "privateLinkServiceConnectionState": { "status": "Approved", "description": "Auto-Approved", - "actionRequired": "None" + "actionsRequired": "None" } } } diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/PutPrivateEndpointConnection.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/PutPrivateEndpointConnection.json index 0b79af4523d6..6c254cfbc054 100644 --- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/PutPrivateEndpointConnection.json +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/PutPrivateEndpointConnection.json @@ -28,7 +28,7 @@ "privateLinkServiceConnectionState": { "status": "Approved", "description": "Auto-Approved", - "actionRequired": "None" + "actionsRequired": "None" } } } diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/UpdateBot.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/UpdateBot.json index d1a7719305c9..15e4556a4308 100644 --- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/UpdateBot.json +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/UpdateBot.json @@ -28,10 +28,14 @@ "luisappid2" ], "luisKey": "luiskey", + "msaAppType": "UserAssignedMSI", "msaAppId": "msaappid", + "msaAppTenantId": "msaapptenantid", + "msaAppMSIResourceId": "/subscriptions/foo/resourcegroups/bar/providers/microsoft.managedidentity/userassignedidentities/sampleId", "isCmekEnabled": true, "cmekKeyVaultUrl": "https://myCmekKey", "isIsolated": false, + "disableLocalAuth": true, "schemaTransformationVersion": "1.0" } } @@ -61,7 +65,10 @@ "luisappid1", "luisappid2" ], + "msaAppType": "UserAssignedMSI", "msaAppId": "msaappid", + "msaAppTenantId": "msaapptenantid", + "msaAppMSIResourceId": "/subscriptions/foo/resourcegroups/bar/providers/microsoft.managedidentity/userassignedidentities/sampleId", "configuredChannels": [ "facebook", "groupme" @@ -72,6 +79,7 @@ "isCmekEnabled": true, "cmekKeyVaultUrl": "https://myCmekKey", "isIsolated": false, + "disableLocalAuth": true, "schemaTransformationVersion": "1.0" } } @@ -100,7 +108,10 @@ "luisappid1", "luisappid2" ], + "msaAppType": "UserAssignedMSI", "msaAppId": "msaappid", + "msaAppTenantId": "msaapptenantid", + "msaAppMSIResourceId": "/subscriptions/foo/resourcegroups/bar/providers/microsoft.managedidentity/userassignedidentities/sampleId", "configuredChannels": [ "facebook", "groupme" @@ -111,6 +122,7 @@ "isCmekEnabled": true, "cmekKeyVaultUrl": "https://myCmekKey", "isIsolated": false, + "disableLocalAuth": true, "schemaTransformationVersion": "1.0" } } diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/privatelinks.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/privatelinks.json index 03d65e67e1b3..974e0dfb111d 100644 --- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/privatelinks.json +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/privatelinks.json @@ -83,7 +83,7 @@ "type": "string", "description": "The reason for approval/rejection of the connection." }, - "actionRequired": { + "actionsRequired": { "type": "string", "description": "A message indicating if changes on the service provider require any updates on the consumer." } diff --git a/specification/botservice/resource-manager/readme.typescript.md b/specification/botservice/resource-manager/readme.typescript.md index 82dedaee02ad..8ac0657d2852 100644 --- a/specification/botservice/resource-manager/readme.typescript.md +++ b/specification/botservice/resource-manager/readme.typescript.md @@ -11,7 +11,7 @@ typescript: generate-metadata: true ``` -``` yaml $(typescript) && !$(profile) +``` yaml $(typescript) && !$(profile-content) typescript: package-name: "@azure/arm-botservice" output-folder: "$(typescript-sdks-folder)/sdk/botservice/arm-botservice" diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-04-15/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-04-15/cdn.json index 72bfef245f21..6dff0ae76a06 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-04-15/cdn.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-04-15/cdn.json @@ -1642,7 +1642,8 @@ "$ref": "#/definitions/ErrorResponse" } } - } + }, + "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/enableCustomHttps": { @@ -1717,7 +1718,8 @@ "$ref": "#/definitions/ErrorResponse" } } - } + }, + "x-ms-long-running-operation": true } }, "/providers/Microsoft.Cdn/checkNameAvailability": { diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-06-15/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-06-15/cdn.json index 85e58bdd2080..768647aaadab 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-06-15/cdn.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-06-15/cdn.json @@ -1642,7 +1642,8 @@ "$ref": "#/definitions/ErrorResponse" } } - } + }, + "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/enableCustomHttps": { @@ -1717,7 +1718,8 @@ "$ref": "#/definitions/ErrorResponse" } } - } + }, + "x-ms-long-running-operation": true } }, "/providers/Microsoft.Cdn/checkNameAvailability": { diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/cdn.json index 985cc15ee100..7ea810593f26 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/cdn.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/cdn.json @@ -2110,7 +2110,8 @@ "$ref": "#/definitions/ErrorResponse" } } - } + }, + "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/enableCustomHttps": { @@ -2185,7 +2186,8 @@ "$ref": "#/definitions/ErrorResponse" } } - } + }, + "x-ms-long-running-operation": true } }, "/providers/Microsoft.Cdn/checkNameAvailability": { diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-03-31/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-03-31/cdn.json index 5b5bb55288fa..8c80108d158f 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-03-31/cdn.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-03-31/cdn.json @@ -2110,7 +2110,8 @@ "$ref": "#/definitions/ErrorResponse" } } - } + }, + "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/enableCustomHttps": { @@ -2185,7 +2186,8 @@ "$ref": "#/definitions/ErrorResponse" } } - } + }, + "x-ms-long-running-operation": true } }, "/providers/Microsoft.Cdn/checkNameAvailability": { diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json index 24ba251127d2..51fa15d2fd67 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json @@ -2110,7 +2110,8 @@ "$ref": "#/definitions/ErrorResponse" } } - } + }, + "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/enableCustomHttps": { @@ -2185,7 +2186,8 @@ "$ref": "#/definitions/ErrorResponse" } } - } + }, + "x-ms-long-running-operation": true } }, "/providers/Microsoft.Cdn/checkNameAvailability": { diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-09-01/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-09-01/cdn.json index 6b5dd994036b..0cc2ca2e464f 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-09-01/cdn.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-09-01/cdn.json @@ -2110,7 +2110,8 @@ "$ref": "#/definitions/ErrorResponse" } } - } + }, + "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/enableCustomHttps": { @@ -2185,7 +2186,8 @@ "$ref": "#/definitions/ErrorResponse" } } - } + }, + "x-ms-long-running-operation": true } }, "/providers/Microsoft.Cdn/checkNameAvailability": { diff --git a/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/changeanalysis.json b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/changeanalysis.json index c24b52c938f2..2bb224b8f2c4 100644 --- a/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/changeanalysis.json +++ b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/changeanalysis.json @@ -287,9 +287,25 @@ "workspaceResourceId": { "description": "The Azure Monitor workspace ARM Resource ID. The resource ID should be in the following format: /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}", "type": "string" + }, + "includeChangeDetails": { + "$ref": "#/definitions/ChangeDetailsMode" } } }, + "ChangeDetailsMode": { + "description": "The mode of includeChangeDetails feature. The flag configures whether to include or exclude content of the change before and after values.", + "enum": [ + "None", + "Include", + "Exclude" + ], + "type": "string", + "x-ms-enum": { + "name": "ChangeDetailsMode", + "modelAsString": true + } + }, "NotificationsState": { "description": "The state of notifications feature.", "enum": [ @@ -376,6 +392,10 @@ }, "properties": { "$ref": "#/definitions/ConfigurationProfileResourceProperties" + }, + "location": { + "description": "The location where the resource is to be deployed.", + "type": "string" } } }, diff --git a/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileCreate.json b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileCreate.json index bd24d84d7d07..5612c00136c4 100644 --- a/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileCreate.json +++ b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileCreate.json @@ -3,7 +3,9 @@ "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", "profileName": "default", "api-version": "2020-04-01-preview", - "resource": {} + "resource": { + "location": "centralus" + } }, "responses": { "200": { @@ -13,11 +15,13 @@ "notifications": { "azureMonitorWorkspaceProperties": { "workspaceId": null, - "workspaceResourceId": null + "workspaceResourceId": null, + "includeChangeDetails": "None" }, "activationState": "None" } }, + "location": "centralus", "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/providers/Microsoft.ChangeAnalysis/profile/default", "name": "default" } diff --git a/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileCreateWithIdentity.json b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileCreateWithIdentity.json index 09c9f23cba8d..03ba1abda668 100644 --- a/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileCreateWithIdentity.json +++ b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileCreateWithIdentity.json @@ -6,7 +6,8 @@ "resource": { "identity": { "type": "SystemAssigned" - } + }, + "location": "centralus" } }, "responses": { @@ -17,7 +18,8 @@ "notifications": { "azureMonitorWorkspaceProperties": { "workspaceId": null, - "workspaceResourceId": null + "workspaceResourceId": null, + "includeChangeDetails": "None" }, "activationState": "None" } @@ -27,6 +29,7 @@ "tenantId": "BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB", "type": "SystemAssigned" }, + "location": "centralus", "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/providers/Microsoft.ChangeAnalysis/profile/default", "name": "default" } diff --git a/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileGet.json b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileGet.json index 9cc400f02bac..7ea27969f73a 100644 --- a/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileGet.json +++ b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileGet.json @@ -12,7 +12,8 @@ "notifications": { "azureMonitorWorkspaceProperties": { "workspaceId": null, - "workspaceResourceId": null + "workspaceResourceId": null, + "includeChangeDetails": "None" }, "activationState": "None" } @@ -22,6 +23,7 @@ "tenantId": "BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB", "type": "SystemAssigned" }, + "location": "centralus", "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/providers/Microsoft.ChangeAnalysis/profile/default", "name": "default" } diff --git a/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileUpdate.json b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileUpdate.json index 000c465f20ca..11aaa3c894b7 100644 --- a/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileUpdate.json +++ b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileUpdate.json @@ -8,11 +8,13 @@ "notifications": { "azureMonitorWorkspaceProperties": { "workspaceId": "workspaceIdValue", - "workspaceResourceId": "workspace resource Id" + "workspaceResourceId": "workspace resource Id", + "includeChangeDetails": "None" }, "activationState": "Enabled" } - } + }, + "location": "centralus" } }, "responses": { @@ -23,12 +25,14 @@ "notifications": { "azureMonitorWorkspaceProperties": { "workspaceId": "workspaceIdValue", - "workspaceResourceId": "workspace resource Id" + "workspaceResourceId": "workspace resource Id", + "includeChangeDetails": "None" }, "activationState": "Enabled" } } }, + "location": "centralus", "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/providers/Microsoft.ChangeAnalysis/profile/default", "name": "default" } diff --git a/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileUpdateWithIdentity.json b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileUpdateWithIdentity.json index 3b06d6733ce9..fe1beb80587e 100644 --- a/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileUpdateWithIdentity.json +++ b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileUpdateWithIdentity.json @@ -15,7 +15,8 @@ }, "identity": { "type": "SystemAssigned" - } + }, + "location": "centralus" } }, "responses": { @@ -26,7 +27,8 @@ "notifications": { "azureMonitorWorkspaceProperties": { "workspaceId": "workspaceIdValue", - "workspaceResourceId": "workspace resource Id" + "workspaceResourceId": "workspace resource Id", + "includeChangeDetails": "None" }, "activationState": "Enabled" } @@ -36,6 +38,7 @@ "tenantId": "BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB", "type": "SystemAssigned" }, + "location": "centralus", "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/providers/Microsoft.ChangeAnalysis/profile/default", "name": "default" } diff --git a/specification/cognitiveservices/data-plane/ComputerVision/readme.md b/specification/cognitiveservices/data-plane/ComputerVision/readme.md index 2611a60db70e..f21a6095beb1 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/readme.md +++ b/specification/cognitiveservices/data-plane/ComputerVision/readme.md @@ -125,6 +125,7 @@ directive: These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. +May need to supply `--version=V2` on the command line. ``` yaml $(python) python-mode: create @@ -133,11 +134,13 @@ add-credentials: true payload-flattening-threshold: 2 namespace: azure.cognitiveservices.vision.computervision package-name: azure-cognitiveservices-vision-computervision +package-version: 0.9.0 clear-output-folder: true use: "@microsoft.azure/autorest.python@~4.0.71" version: V2 multiapi: true no-async: true +client-side-validation: false directive: from: source-file-python diff --git a/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/Face.json b/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/Face.json index e7cef17c8c3f..d38d30cd08d9 100644 --- a/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/Face.json +++ b/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/Face.json @@ -2492,7 +2492,7 @@ "200": { "description": "A successful call returns the operation's status.", "schema": { - "$ref": "#/definitions/AsyncStatus" + "$ref": "#/definitions/OperationStatus" } }, "default": { @@ -2582,6 +2582,12 @@ "responses": { "202": { "description": "Success", + "headers": { + "Operation-Location": { + "description": "Operation location with an operation id used to track the progress of person creation.", + "type": "string" + } + }, "schema": { "$ref": "#/definitions/PersonCreationResponse" } @@ -2665,7 +2671,13 @@ ], "responses": { "202": { - "description": "Success" + "description": "Success", + "headers": { + "Operation-Location": { + "description": "Operation location with an operation id used to track the progress of person creation.", + "type": "string" + } + } }, "default": { "description": "Response entity accompanying non-successful responses containing additional details about the error.", @@ -2766,6 +2778,12 @@ "responses": { "202": { "description": "Success", + "headers": { + "Operation-Location": { + "description": "Operation location with an operation id used to track the progress of person creation.", + "type": "string" + } + }, "schema": { "$ref": "#/definitions/EnrollmentPrintResponse" } @@ -2864,7 +2882,13 @@ ], "responses": { "202": { - "description": "Success" + "description": "Success", + "headers": { + "Operation-Location": { + "description": "Operation location with an operation id used to track the progress of person creation.", + "type": "string" + } + } }, "default": { "description": "Response entity accompanying non-successful responses containing additional details about the error.", @@ -3029,7 +3053,13 @@ "description": "Success" }, "202": { - "description": "Success" + "description": "Success", + "headers": { + "Operation-Location": { + "description": "Operation location with an operation id used to track the progress of person creation.", + "type": "string" + } + } }, "default": { "description": "Response entity accompanying non-successful responses containing additional details about the error.", @@ -3076,7 +3106,13 @@ ], "responses": { "202": { - "description": "Success" + "description": "Success", + "headers": { + "Operation-Location": { + "description": "Operation location with an operation id used to track the progress of person creation.", + "type": "string" + } + } }, "default": { "description": "Response entity accompanying non-successful responses containing additional details about the error.", @@ -3149,7 +3185,13 @@ ], "responses": { "202": { - "description": "Success" + "description": "Success", + "headers": { + "Operation-Location": { + "description": "Operation location with an operation id used to track the progress of person creation.", + "type": "string" + } + } }, "default": { "description": "Response entity accompanying non-successful responses containing additional details about the error.", @@ -3670,6 +3712,12 @@ "responses": { "202": { "description": "Success", + "headers": { + "Operation-Location": { + "description": "Operation location with an operation id used to track the progress of person creation.", + "type": "string" + } + }, "schema": { "$ref": "#/definitions/EnrollmentPrintResponse" } @@ -4813,6 +4861,26 @@ "minimum": 0, "maximum": 1 }, + "NameAndUserDataContractForCreation": { + "type": "object", + "description": "A combination of user defined name and user specified data for the person, largePersonGroup/personGroup, and largeFaceList/faceList.", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "User defined name, maximum length is 128.", + "maxLength": 128, + "minLength": 1 + }, + "userData": { + "type": "string", + "description": "User specified data. Length should not exceed 16KB.", + "maxLength": 16384 + } + } + }, "NameAndUserDataContract": { "type": "object", "description": "A combination of user defined name and user specified data for the person, largePersonGroup/personGroup, and largeFaceList/faceList.", @@ -4839,7 +4907,7 @@ }, "allOf": [ { - "$ref": "#/definitions/NameAndUserDataContract" + "$ref": "#/definitions/NameAndUserDataContractForCreation" } ] }, @@ -5014,48 +5082,6 @@ } } }, - "OperationStatus": { - "type": "object", - "required": [ - "status", - "createdTime" - ], - "description": "Operation status object. Operation refers to the asynchronous backend task including taking a snapshot and applying a snapshot.", - "properties": { - "status": { - "type": "string", - "description": "Operation status: notstarted, running, succeeded, failed. If the operation is requested and waiting to perform, the status is notstarted. If the operation is ongoing in backend, the status is running. Status succeeded means the operation is completed successfully, specifically for snapshot taking operation, it illustrates the snapshot is well taken and ready to apply, and for snapshot applying operation, it presents the target object has finished creating by the snapshot and ready to be used. Status failed is often caused by editing the source object while taking the snapshot or editing the target object while applying the snapshot before completion, see the field \"message\" to check the failure reason.", - "x-ms-enum": { - "name": "OperationStatusType", - "modelAsString": false - }, - "enum": [ - "notstarted", - "running", - "succeeded", - "failed" - ] - }, - "createdTime": { - "type": "string", - "format": "date-time", - "description": "A combined UTC date and time string that describes the time when the operation (take or apply a snapshot) is requested. E.g. 2018-12-25T11:41:02.2331413Z." - }, - "lastActionTime": { - "type": "string", - "format": "date-time", - "description": "A combined UTC date and time string that describes the last time the operation (take or apply a snapshot) is actively migrating data. The lastActionTime will keep increasing until the operation finishes. E.g. 2018-12-25T11:51:27.8705696Z." - }, - "resourceLocation": { - "type": "string", - "description": "When the operation succeeds successfully, for snapshot taking operation the snapshot id will be included in this field, and for snapshot applying operation, the path to get the target object will be returned in this field." - }, - "message": { - "type": "string", - "description": "Show failure message when operation fails (omitted when operation succeeds)." - } - } - }, "PersistedFaceResponse": { "type": "object", "properties": { @@ -5075,31 +5101,46 @@ "succeeded", "failed" ], - "type": "string" + "type": "string", + "description": "Operation status: notstarted, running, succeeded, failed. If the operation is requested and waiting to perform, the status is notstarted. If the operation is ongoing in backend, the status is running. Status succeeded means the operation is completed successfully, specifically for snapshot taking operation, it illustrates the snapshot is well taken and ready to apply, and for snapshot applying operation, it presents the target object has finished creating by the snapshot and ready to be used. Status failed is often caused by editing the source object while taking the snapshot or editing the target object while applying the snapshot before completion, see the field \"message\" to check the failure reason.", + "x-ms-enum": { + "name": "OperationStatusType", + "modelAsString": false + } }, - "AsyncStatus": { + "OperationStatus": { "type": "object", + "required": [ + "status", + "createdTime" + ], + "description": "Operation status object. Operation refers to an asynchronous backend task.", "properties": { "status": { "$ref": "#/definitions/AsyncOperationStatus" }, "createdTime": { "format": "date-time", - "type": "string" + "type": "string", + "description": "A combined UTC date and time string that describes the time when the operation is requested. E.g. 2018-12-25T11:41:02.2331413Z." }, "lastActionTime": { "format": "date-time", - "type": "string" + "type": "string", + "description": "A combined UTC date and time string that describes the last time the operation is actively running. The lastActionTime will keep increasing until the operation finishes. E.g. 2018-12-25T11:51:27.8705696Z." }, "finishedTime": { "format": "date-time", - "type": "string" + "type": "string", + "description": "A combined UTC date and time string that describes the time when the operation finished. E.g. 2018-12-25T11:41:02.2331413Z." }, "resourceLocation": { - "type": "string" + "type": "string", + "description": "When the operation succeeds successfully, for snapshot taking operation the snapshot id will be included in this field, and for snapshot applying operation, the path to get the target object will be returned in this field." }, "message": { - "type": "string" + "type": "string", + "description": "Show failure message when operation fails (omitted when operation succeeds)." } } }, diff --git a/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/AddPersonDirectoryPersonFaceFromStream.json b/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/AddPersonDirectoryPersonFaceFromStream.json index a0472d1b8c6c..1ad4270ba1b0 100644 --- a/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/AddPersonDirectoryPersonFaceFromStream.json +++ b/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/AddPersonDirectoryPersonFaceFromStream.json @@ -12,6 +12,9 @@ }, "responses": { "202": { + "header": { + "Operation-Location": "/operations/a63a3bdd-a1db-4d05-87b8-dbad6850062a" + }, "body": { "persistedFaceId": "6e04c175-219e-42a2-9d26-0e7b790e1ef4", "recognitionModel": null, diff --git a/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/AddPersonDirectoryPersonFaceFromUrl.json b/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/AddPersonDirectoryPersonFaceFromUrl.json index 67cfe0b4669b..6e8510fd9ac5 100644 --- a/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/AddPersonDirectoryPersonFaceFromUrl.json +++ b/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/AddPersonDirectoryPersonFaceFromUrl.json @@ -14,6 +14,9 @@ }, "responses": { "202": { + "header": { + "Operation-Location": "/operations/a63a3bdd-a1db-4d05-87b8-dbad6850062a" + }, "body": { "persistedFaceId": "6e04c175-219e-42a2-9d26-0e7b790e1ef4", "recognitionModel": null, diff --git a/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/CreateNewDynamicPersonGroup.json b/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/CreateNewDynamicPersonGroup.json index 6b55410a2911..aaa952d485de 100644 --- a/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/CreateNewDynamicPersonGroup.json +++ b/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/CreateNewDynamicPersonGroup.json @@ -11,6 +11,10 @@ }, "responses": { "200": {}, - "202": {} + "202": { + "header": { + "Operation-Location": "/operations/a63a3bdd-a1db-4d05-87b8-dbad6850062a" + } + } } } diff --git a/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/CreateNewPersonDirectoryPerson.json b/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/CreateNewPersonDirectoryPerson.json index 712996b5f693..a20321319d26 100644 --- a/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/CreateNewPersonDirectoryPerson.json +++ b/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/CreateNewPersonDirectoryPerson.json @@ -10,6 +10,9 @@ }, "responses": { "202": { + "header": { + "Operation-Location": "/operations/a63a3bdd-a1db-4d05-87b8-dbad6850062a" + }, "body": { "personId": "4caa25ee-3bc6-4e88-adf8-12455ce7aab0" } diff --git a/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/DeleteDynamicPersonGroup.json b/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/DeleteDynamicPersonGroup.json index bd318036ed6d..fcbdb738c691 100644 --- a/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/DeleteDynamicPersonGroup.json +++ b/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/DeleteDynamicPersonGroup.json @@ -6,6 +6,10 @@ "dynamicPersonGroupId": "abc" }, "responses": { - "202": {} + "202": { + "header": { + "Operation-Location": "/operations/a63a3bdd-a1db-4d05-87b8-dbad6850062a" + } + } } } diff --git a/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/DeletePersonDirectoryPerson.json b/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/DeletePersonDirectoryPerson.json index a2f224a8c305..bbb4bde7653b 100644 --- a/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/DeletePersonDirectoryPerson.json +++ b/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/DeletePersonDirectoryPerson.json @@ -6,6 +6,10 @@ "personId": "25985303-c537-4467-b41d-bdb45cd95ca1" }, "responses": { - "202": {} + "202": { + "header": { + "Operation-Location": "/operations/a63a3bdd-a1db-4d05-87b8-dbad6850062a" + } + } } } diff --git a/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/DeletePersonDirectoryPersonFace.json b/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/DeletePersonDirectoryPersonFace.json index 626c7b5e3503..687c94122726 100644 --- a/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/DeletePersonDirectoryPersonFace.json +++ b/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/DeletePersonDirectoryPersonFace.json @@ -8,6 +8,10 @@ "persistedFaceId": "62004fa7-1ac0-478e-9d5a-b38f9e7fbc68" }, "responses": { - "202": {} + "202": { + "header": { + "Operation-Location": "/operations/a63a3bdd-a1db-4d05-87b8-dbad6850062a" + } + } } } diff --git a/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/UpdateDynamicPersonGroup.json b/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/UpdateDynamicPersonGroup.json index c76dd3808c39..6fec5b4772bc 100644 --- a/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/UpdateDynamicPersonGroup.json +++ b/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/examples/UpdateDynamicPersonGroup.json @@ -17,6 +17,10 @@ } }, "responses": { - "202": {} + "202": { + "header": { + "Operation-Location": "/operations/a63a3bdd-a1db-4d05-87b8-dbad6850062a" + } + } } } diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json index 33604243db34..a0d5e7d06a50 100644 --- a/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json +++ b/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json @@ -3922,6 +3922,26 @@ "minimum": 0, "maximum": 1 }, + "NonNullableNameAndNullableUserDataContract": { + "type": "object", + "description": "A combination of user defined name and user specified data for the person, largePersonGroup/personGroup, and largeFaceList/faceList.", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "User defined name, maximum length is 128.", + "maxLength": 128, + "minLength": 1 + }, + "userData": { + "type": "string", + "description": "User specified data. Length should not exceed 16KB.", + "maxLength": 16384 + } + } + }, "NameAndUserDataContract": { "type": "object", "description": "A combination of user defined name and user specified data for the person, largePersonGroup/personGroup, and largeFaceList/faceList.", @@ -3948,7 +3968,7 @@ }, "allOf": [ { - "$ref": "#/definitions/NameAndUserDataContract" + "$ref": "#/definitions/NonNullableNameAndNullableUserDataContract" } ] }, diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json index bc483ec8f4a8..0d5db509f29c 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/preview/v1.0/MetricsAdvisor.json @@ -1284,7 +1284,6 @@ "Daily", "Hourly", "Minutely", - "Secondly", "Custom" ], "x-ms-enum": { @@ -4116,9 +4115,6 @@ } }, "AzureSQLConnectionStringParam": { - "required": [ - "connectionString" - ], "type": "object", "properties": { "connectionString": { @@ -4193,9 +4189,6 @@ "x-ms-discriminator-value": "AzureSQLConnectionString" }, "DataLakeGen2SharedKeyParam": { - "required": [ - "accountKey" - ], "type": "object", "properties": { "accountKey": { @@ -4224,7 +4217,6 @@ "ServicePrincipalParam": { "required": [ "clientId", - "clientSecret", "tenantId" ], "type": "object", @@ -4263,7 +4255,6 @@ "ServicePrincipalInKVParam": { "required": [ "keyVaultClientId", - "keyVaultClientSecret", "keyVaultEndpoint", "servicePrincipalIdNameInKV", "servicePrincipalSecretNameInKV", @@ -4611,7 +4602,6 @@ "Daily", "Hourly", "Minutely", - "Secondly", "Custom" ], "type": "string", diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.1/Personalizer.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.1/Personalizer.json index ef0bf3bcda8a..533090317e6a 100644 --- a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.1/Personalizer.json +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.1/Personalizer.json @@ -1,11 +1,10 @@ { "swagger": "2.0", "info": { - "title": "Personalizer Client v1.1-preview.1", + "title": "Personalizer Base", "description": "Personalizer Service is an Azure Cognitive Service that makes it easy to target content and experiences without complex pre-analysis or cleanup of past data. Given a context and featurized content, the Personalizer Service returns which content item to show to users in rewardActionId. As rewards are sent in response to the use of rewardActionId, the reinforcement learning algorithm will improve the model and improve performance of future rank calls.", "version": "v1.1-preview.1" }, - "host": "localhost:5001", "basePath": "/personalizer/v1.1-preview.1", "schemes": [ "https" @@ -181,7 +180,7 @@ "ConfigurationsV1Dot1Preview1" ], "summary": "Apply Learning Settings and model from a pre-existing Offline Evaluation, making them the current online Learning Settings and model and replacing the previous ones.", - "operationId": "Evaluation_Apply", + "operationId": "ServiceConfiguration_ApplyFromEvaluation", "consumes": [ "application/json" ], @@ -210,8 +209,8 @@ } }, "x-ms-examples": { - "Successful Evaluation_Apply request": { - "$ref": "./examples/Evaluation_Apply.json" + "Successful ServiceConfiguration_ApplyFromEvaluation request": { + "$ref": "./examples/ServiceConfiguration_ApplyFromEvaluation.json" } } } @@ -770,73 +769,6 @@ } }, "definitions": { - "ApprenticeLearningMetrics": { - "required": [ - "numberOfEvents", - "numberOfImitatedEvents", - "sumOfImitatedRewards", - "sumOfRewards" - ], - "type": "object", - "properties": { - "numberOfEvents": { - "format": "int64", - "type": "integer" - }, - "sumOfRewards": { - "format": "float", - "type": "number" - }, - "numberOfImitatedEvents": { - "format": "int64", - "type": "integer" - }, - "sumOfImitatedRewards": { - "format": "float", - "type": "number" - } - } - }, - "ApprenticeModeMetrics": { - "required": [ - "lastProcessedEventTime", - "numberOfEvents", - "numberOfImitatedEvents", - "startTime", - "sumOfImitatedRewards", - "sumOfRewards" - ], - "type": "object", - "properties": { - "startTime": { - "format": "date-time", - "type": "string" - }, - "lastProcessedEventTime": { - "format": "date-time", - "type": "string" - }, - "lastBatchMetrics": { - "$ref": "#/definitions/ApprenticeLearningMetrics" - }, - "numberOfEvents": { - "format": "int64", - "type": "integer" - }, - "sumOfRewards": { - "format": "float", - "type": "number" - }, - "numberOfImitatedEvents": { - "format": "int64", - "type": "integer" - }, - "sumOfImitatedRewards": { - "format": "float", - "type": "number" - } - } - }, "ServiceConfiguration": { "description": "The configuration of the service.", "required": [ @@ -911,9 +843,6 @@ "modelAsString": true } }, - "latestApprenticeModeMetrics": { - "$ref": "#/definitions/ApprenticeModeMetrics" - }, "isAutoOptimizationEnabled": { "description": "Flag indicating whether Personalizer will automatically optimize Learning Settings by running Offline Evaluations periodically.", "type": "boolean" @@ -1308,6 +1237,8 @@ "readOnly": true }, "totalSummary": { + "description": "The aggregate total of the Offline Evaluation.", + "type": "object", "allOf": [ { "$ref": "#/definitions/PolicyResultSummary" @@ -1318,7 +1249,7 @@ } }, "Evaluation": { - "description": "A counterfactual evaluation.", + "description": "A Counterfactual Evaluation.", "type": "object", "properties": { "id": { @@ -1376,6 +1307,7 @@ } }, "featureImportance": { + "description": "Feature Importance.", "type": "array", "items": { "type": "array", @@ -1385,6 +1317,7 @@ } }, "evaluationType": { + "description": "Evaluation type (manual or through Automatic Optimization).", "enum": [ "Manual", "Auto" @@ -1396,9 +1329,11 @@ } }, "optimalPolicy": { + "description": "Thr optimal policy.", "type": "string" }, "creationTime": { + "description": "Creation time.", "format": "date-time", "type": "string" } @@ -1479,6 +1414,8 @@ "type": "object", "properties": { "dateRange": { + "description": "Date range.", + "type": "object", "allOf": [ { "$ref": "#/definitions/DateRange" @@ -1534,6 +1471,7 @@ "type": "object", "properties": { "reward": { + "description": "List of SlotRewards", "type": "array", "items": { "$ref": "#/definitions/SlotReward" @@ -1785,18 +1723,6 @@ "x-ms-skip-url-encoding": true } }, - "securityDefinitions": { - "apim_key": { - "type": "apiKey", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "apim_key": [] - } - ], "tags": [ { "name": "ConfigurationsV1Dot1Preview1", diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.1/examples/Evaluation_Apply.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.1/examples/ServiceConfiguration_ApplyFromEvaluation.json similarity index 100% rename from specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.1/examples/Evaluation_Apply.json rename to specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.1/examples/ServiceConfiguration_ApplyFromEvaluation.json diff --git a/specification/cognitiveservices/data-plane/Personalizer/readme.md b/specification/cognitiveservices/data-plane/Personalizer/readme.md index 612669f6ca1b..326e97aec360 100644 --- a/specification/cognitiveservices/data-plane/Personalizer/readme.md +++ b/specification/cognitiveservices/data-plane/Personalizer/readme.md @@ -4,10 +4,10 @@ > see https://aka.ms/autorest -The current release is `release_1_0`. A preview release release_1_0 is also available +The current release is `release_1_0`. A preview release release_1_1_preview.1 is also available ``` yaml -tag: release_1_0 +tag: release_1_1_preview.1 add-credentials: true openapi-type: data-plane ``` @@ -28,7 +28,7 @@ input-file: - preview/v1.0/Personalizer.json ``` -### Release 1.0-Preview +### Release 1.1-Preview These settings apply only when `--tag=release_1_1_preview.1` is specified on the command line. ``` yaml $(tag) == 'release_1_1_preview.1' diff --git a/specification/cognitiveservices/data-plane/Personalizer/readme.python.md b/specification/cognitiveservices/data-plane/Personalizer/readme.python.md index 24c65deccf6b..d76948d9823c 100644 --- a/specification/cognitiveservices/data-plane/Personalizer/readme.python.md +++ b/specification/cognitiveservices/data-plane/Personalizer/readme.python.md @@ -3,24 +3,27 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. +When used on the command line, you may need to specify `--verison=V2`. ``` yaml $(python) -python-mode: create -python: - license-header: MICROSOFT_MIT_NO_VERSION - add-credentials: true - payload-flattening-threshold: 2 - namespace: azure.cognitiveservices.personalizer - package-name: azure-cognitiveservices-personalizer - clear-output-folder: true +package-version: 0.2.0 +license-header: MICROSOFT_MIT_NO_VERSION +add-credentials: true +payload-flattening-threshold: 2 +namespace: azure.cognitiveservices.personalizer +package-name: azure-cognitiveservices-personalizer +use: "@microsoft.azure/autorest.python@~4.0.71" +version: V2 +multiapi: true +no-async: true ``` ``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/cognitiveservices/azure-cognitiveservices-personalizer/azure/cognitiveservices/personalizer +no-namespace-folders: true +clear-output-folder: false +output-folder: $(python-sdks-folder)/cognitiveservices/azure-cognitiveservices-personalizer/azure/cognitiveservices/personalizer ``` ``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/cognitiveservices/azure-cognitiveservices-personalizer +basic-setup-py: true +clear-output-folder: true +output-folder: $(python-sdks-folder)/cognitiveservices/azure-cognitiveservices-personalizer ``` diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/TextAnalytics.json b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/TextAnalytics.json new file mode 100644 index 000000000000..0b6cf21ddf91 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/TextAnalytics.json @@ -0,0 +1,3123 @@ +{ + "swagger": "2.0", + "info": { + "version": "v3.2-preview.1", + "contact": { + "name": "Microsoft Cognitive Services", + "url": "https://azure.microsoft.com/en-us/services/cognitive-services/text-analytics/", + "email": "mlapi@microsoft.com" + }, + "title": "Text Analytics Client", + "description": "The Text Analytics API is a suite of natural language processing (NLP) services built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction and language detection. Functionality for analysis of text specific to the healthcare domain and personal information are also available in the API. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview" + }, + "securityDefinitions": { + "apim_key": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "apim_key": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/text/analytics/{ApiVersion}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ] + }, + "paths": { + "/analyze": { + "post": { + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "description": "Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed.", + "operationId": "Analyze", + "summary": "Submit analysis job", + "parameters": [ + { + "description": "Collection of documents to analyze and tasks to execute.", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/AnalyzeBatchInput" + } + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", + "headers": { + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Submit analysis job request": { + "$ref": ".//examples//SuccessfulAnalyzeRequest.json" + } + }, + "deprecated": false, + "x-ms-long-running-operation": true + } + }, + "/analyze/jobs/{jobId}": { + "get": { + "produces": [ + "application/json", + "text/json" + ], + "description": "Get the status of an analysis job. A job may consist of one or more tasks. Once all tasks are completed, the job will transition to the completed state and results will be available for each task.", + "operationId": "AnalyzeStatus", + "summary": "Get analysis status and results", + "parameters": [ + { + "$ref": "#/parameters/AnalyzeJobId" + }, + { + "$ref": "#/parameters/ShowStats" + }, + { + "default": 20, + "description": "(Optional) Set the maximum number of results per task. When both $top and $skip are specified, $skip is applied first.", + "in": "query", + "maximum": 50, + "minimum": 1, + "name": "$top", + "type": "integer" + }, + { + "default": 0, + "description": "(Optional) Set the number of elements to offset in the response. When both $top and $skip are specified, $skip is applied first.", + "in": "query", + "minimum": 0, + "name": "$skip", + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Analysis job status and metadata.", + "schema": { + "$ref": "#/definitions/AnalyzeJobState" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Analysis job status request": { + "$ref": ".//examples//SuccessfulAnalyzeStatusRequest.json" + } + }, + "deprecated": false + } + }, + "/entities/health/jobs/{jobId}": { + "get": { + "produces": [ + "application/json", + "text/json" + ], + "description": "Get details of the healthcare prediction job specified by the jobId.", + "operationId": "HealthStatus", + "summary": "Get healthcare analysis job status and results", + "parameters": [ + { + "$ref": "#/parameters/JobId" + }, + { + "default": 20, + "description": "(Optional) Set the maximum number of results per task. When both $top and $skip are specified, $skip is applied first.", + "in": "query", + "maximum": 50, + "minimum": 1, + "name": "$top", + "type": "integer" + }, + { + "default": 0, + "description": "(Optional) Set the number of elements to offset in the response. When both $top and $skip are specified, $skip is applied first.", + "in": "query", + "minimum": 0, + "name": "$skip", + "type": "integer" + }, + { + "$ref": "#/parameters/ShowStats" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HealthcareJobState" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Health request": { + "$ref": ".//examples//SuccessfulHealthStatusRequest.json" + } + }, + "deprecated": false + }, + "delete": { + "produces": [ + "application/json", + "text/json" + ], + "description": "Cancel healthcare prediction job.", + "operationId": "CancelHealthJob", + "summary": "Cancel healthcare prediction job", + "parameters": [ + { + "$ref": "#/parameters/JobId" + } + ], + "responses": { + "202": { + "description": "Cancel Job request has been received.", + "headers": { + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Health request": { + "$ref": ".//examples//SuccessfulHealthDeleteRequest.json" + } + }, + "deprecated": false, + "x-ms-long-running-operation": true + } + }, + "/entities/health/jobs": { + "post": { + "summary": "Submit healthcare analysis job", + "description": "Start a healthcare analysis job to recognize healthcare related entities (drugs, conditions, symptoms, etc) and their relations.", + "operationId": "Health", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ModelVersion" + }, + { + "$ref": "#/parameters/StringIndexType" + }, + { + "$ref": "#/parameters/MultiLanguageInput" + }, + { + "$ref": "#/parameters/LoggingOptOut" + } + ], + "responses": { + "202": { + "description": "Accepted - call results in a link where the status of the submitted job can be checked via the GET operation.", + "headers": { + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Health request": { + "$ref": ".//examples//SuccessfulHealthRequest.json" + } + }, + "deprecated": false, + "x-ms-long-running-operation": true + } + }, + "/entities/recognition/general": { + "post": { + "summary": "Named Entity Recognition", + "description": "The API returns a list of general named entities in a given document. For the list of supported entity types, check Supported Entity Types in Text Analytics API. See the Supported languages in Text Analytics API for the list of enabled languages.", + "operationId": "EntitiesRecognitionGeneral", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ModelVersion" + }, + { + "$ref": "#/parameters/ShowStats" + }, + { + "$ref": "#/parameters/LoggingOptOut" + }, + { + "$ref": "#/parameters/StringIndexType" + }, + { + "$ref": "#/parameters/MultiLanguageInput" + } + ], + "responses": { + "200": { + "description": "A successful call results in a list of recognized entities returned for each valid document.", + "schema": { + "$ref": "#/definitions/EntitiesResult" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Entities request": { + "$ref": ".//examples//SuccessfulEntitiesRequest.json" + } + }, + "deprecated": false + } + }, + "/entities/recognition/pii": { + "post": { + "summary": "Entities containing personal information", + "description": "The API returns a list of entities with personal information (\\\"SSN\\\", \\\"Bank Account\\\" etc) in the document. For the list of supported entity types, check Supported Entity Types in Text Analytics API. See the Supported languages in Text Analytics API for the list of enabled languages.\n", + "operationId": "EntitiesRecognitionPii", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ModelVersion" + }, + { + "$ref": "#/parameters/ShowStats" + }, + { + "$ref": "#/parameters/LoggingOptOut" + }, + { + "name": "domain", + "in": "query", + "description": "(Optional) if specified, will set the PII domain to include only a subset of the entity categories. Possible values include: 'PHI', 'none'.", + "type": "string" + }, + { + "$ref": "#/parameters/StringIndexType" + }, + { + "$ref": "#/parameters/PiiCategories" + }, + { + "$ref": "#/parameters/MultiLanguageInput" + } + ], + "responses": { + "200": { + "description": "A successful call results in a list of entities containing personal information returned for each valid document", + "schema": { + "$ref": "#/definitions/PiiResult" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Entity PII request": { + "$ref": ".//examples//SuccessfulEntityPIIRequest.json" + } + }, + "deprecated": false + } + }, + "/entities/linking": { + "post": { + "summary": "Linked entities from a well known knowledge base", + "description": "The API returns a list of recognized entities with links to a well known knowledge base. See the Supported languages in Text Analytics API for the list of enabled languages.", + "operationId": "EntitiesLinking", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ModelVersion" + }, + { + "$ref": "#/parameters/ShowStats" + }, + { + "$ref": "#/parameters/LoggingOptOut" + }, + { + "$ref": "#/parameters/StringIndexType" + }, + { + "$ref": "#/parameters/MultiLanguageInput" + } + ], + "responses": { + "200": { + "description": "A successful call results in a list of recognized entities with links to a well known knowledge base returned for each valid document", + "schema": { + "$ref": "#/definitions/EntityLinkingResult" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Entity Linking request": { + "$ref": ".//examples//SuccessfulEntityLinkingRequest.json" + } + }, + "deprecated": false + } + }, + "/keyPhrases": { + "post": { + "summary": "Key Phrases", + "description": "The API returns a list of strings denoting the key phrases in the input text. See the Supported languages in Text Analytics API for the list of enabled languages.", + "operationId": "KeyPhrases", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ModelVersion" + }, + { + "$ref": "#/parameters/ShowStats" + }, + { + "$ref": "#/parameters/LoggingOptOut" + }, + { + "$ref": "#/parameters/MultiLanguageInput" + } + ], + "responses": { + "200": { + "description": "A successful response results in 0 or more key phrases identified in each valid document", + "schema": { + "$ref": "#/definitions/KeyPhraseResult" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Key Phrase request": { + "$ref": ".//examples//SuccessfulKeyPhrasesRequest.json" + } + }, + "deprecated": false + } + }, + "/languages": { + "post": { + "summary": "Detect Language", + "description": "The API returns the detected language and a numeric score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true. See the Supported languages in Text Analytics API for the list of enabled languages.", + "operationId": "Languages", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ModelVersion" + }, + { + "$ref": "#/parameters/ShowStats" + }, + { + "$ref": "#/parameters/LoggingOptOut" + }, + { + "$ref": "#/parameters/LanguageInput" + } + ], + "responses": { + "200": { + "description": "A successful call results in the detected language with the highest probability for each valid document", + "schema": { + "$ref": "#/definitions/LanguageResult" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Detect Language request": { + "$ref": ".//examples//SuccessfulLanguagesRequest.json" + } + }, + "deprecated": false + } + }, + "/sentiment": { + "post": { + "summary": "Sentiment", + "description": "The API returns a detailed sentiment analysis for the input text. The analysis is done in multiple levels of granularity, start from the a document level, down to sentence and key terms (targets and assessments).", + "operationId": "Sentiment", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ModelVersion" + }, + { + "$ref": "#/parameters/ShowStats" + }, + { + "$ref": "#/parameters/LoggingOptOut" + }, + { + "name": "opinionMining", + "in": "query", + "description": "(Optional) if set to true, response will contain not only sentiment prediction but also opinion mining (aspect-based sentiment analysis) results.", + "type": "boolean" + }, + { + "$ref": "#/parameters/StringIndexType" + }, + { + "$ref": "#/parameters/MultiLanguageInput" + } + ], + "responses": { + "200": { + "description": "A successful call results in a document sentiment prediction, as well as sentiment scores for each sentiment class (Positive, Negative, and Neutral)", + "schema": { + "$ref": "#/definitions/SentimentResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Sentiment request": { + "$ref": ".//examples//SuccessfulSentimentRequest.json" + } + }, + "deprecated": false + } + } + }, + "definitions": { + "JobManifest": { + "properties": { + "tasks": { + "description": "The set of tasks to execute on the input documents. Cannot specify the same task more than once.", + "properties": { + "entityRecognitionTasks": { + "type": "array", + "items": { + "$ref": "#/definitions/EntitiesTask" + } + }, + "entityRecognitionPiiTasks": { + "type": "array", + "items": { + "$ref": "#/definitions/PiiTask" + } + }, + "keyPhraseExtractionTasks": { + "type": "array", + "items": { + "$ref": "#/definitions/KeyPhrasesTask" + } + }, + "entityLinkingTasks": { + "type": "array", + "items": { + "$ref": "#/definitions/EntityLinkingTask" + } + }, + "sentimentAnalysisTasks": { + "type": "array", + "items": { + "$ref": "#/definitions/SentimentAnalysisTask" + } + }, + "extractiveSummarizationTasks": { + "type": "array", + "items": { + "$ref": "#/definitions/ExtractiveSummarizationTask" + } + } + }, + "type": "object" + } + }, + "required": [ + "tasks" + ], + "type": "object" + }, + "MultiLanguageBatchInput": { + "type": "object", + "required": [ + "documents" + ], + "properties": { + "documents": { + "type": "array", + "description": "The set of documents to process as part of this batch.", + "items": { + "$ref": "#/definitions/MultiLanguageInput" + } + } + }, + "description": "Contains a set of input documents to be analyzed by the service." + }, + "MultiLanguageInput": { + "type": "object", + "required": [ + "id", + "text" + ], + "properties": { + "id": { + "type": "string", + "description": "A unique, non-empty document identifier." + }, + "text": { + "type": "string", + "description": "The input text to process." + }, + "language": { + "type": "string", + "description": "(Optional) This is the 2 letter ISO 639-1 representation of a language. For example, use \"en\" for English; \"es\" for Spanish etc. If not set, use \"en\" for English as default." + } + }, + "description": "Contains an input document to be analyzed by the service." + }, + "DocumentError": { + "type": "object", + "required": [ + "id", + "error" + ], + "properties": { + "id": { + "type": "string", + "description": "Document Id." + }, + "error": { + "type": "object", + "description": "Document Error.", + "$ref": "#/definitions/TextAnalyticsError" + } + } + }, + "ErrorResponse": { + "type": "object", + "required": [ + "error" + ], + "properties": { + "error": { + "type": "object", + "description": "Document Error.", + "$ref": "#/definitions/TextAnalyticsError" + } + } + }, + "TextAnalyticsError": { + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "InvalidRequest", + "InvalidArgument", + "InternalServerError", + "ServiceUnavailable", + "NotFound" + ], + "x-ms-enum": { + "name": "ErrorCodeValue", + "modelAsString": true + }, + "description": "Error code." + }, + "message": { + "type": "string", + "description": "Error message." + }, + "target": { + "type": "string", + "description": "Error target." + }, + "innererror": { + "$ref": "#/definitions/InnerError", + "description": "Inner error contains more specific information." + }, + "details": { + "type": "array", + "description": "Details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/TextAnalyticsError" + } + } + } + }, + "TextAnalyticsWarning": { + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "LongWordsInDocument", + "DocumentTruncated" + ], + "x-ms-enum": { + "name": "WarningCodeValue", + "modelAsString": true + }, + "description": "Error code." + }, + "message": { + "type": "string", + "description": "Warning message." + }, + "targetRef": { + "type": "string", + "description": "A JSON pointer reference indicating the target object." + } + } + }, + "ExtractiveSummarizationTask": { + "type": "object", + "properties": { + "parameters": { + "type": "object", + "properties": { + "model-version": { + "default": "latest", + "type": "string" + }, + "loggingOptOut": { + "default": false, + "type": "boolean" + }, + "stringIndexType": { + "$ref": "#/definitions/StringIndexType" + }, + "sentenceCount": { + "default": 3, + "type": "integer" + }, + "sortBy": { + "default": "Offset", + "enum": [ + "Offset", + "Rank" + ], + "type": "string" + } + } + }, + "taskName": { + "type": "string" + } + } + }, + "PiiTask": { + "properties": { + "parameters": { + "properties": { + "domain": { + "default": "none", + "enum": [ + "phi", + "none" + ], + "type": "string" + }, + "model-version": { + "default": "latest", + "type": "string" + }, + "loggingOptOut": { + "default": true, + "type": "boolean" + }, + "piiCategories": { + "$ref": "#/definitions/PiiCategories" + }, + "stringIndexType": { + "$ref": "#/definitions/StringIndexType" + } + }, + "type": "object" + }, + "taskName": { + "type": "string" + } + }, + "type": "object" + }, + "EntitiesTask": { + "properties": { + "parameters": { + "properties": { + "model-version": { + "default": "latest", + "type": "string" + }, + "loggingOptOut": { + "default": false, + "type": "boolean" + }, + "stringIndexType": { + "$ref": "#/definitions/StringIndexType" + } + }, + "type": "object" + }, + "taskName": { + "type": "string" + } + }, + "type": "object" + }, + "SentimentAnalysisTask": { + "properties": { + "parameters": { + "properties": { + "model-version": { + "default": "latest", + "type": "string" + }, + "loggingOptOut": { + "default": false, + "type": "boolean" + }, + "opinionMining": { + "default": false, + "type": "boolean" + }, + "stringIndexType": { + "$ref": "#/definitions/StringIndexType" + } + }, + "type": "object" + }, + "taskName": { + "type": "string" + } + }, + "type": "object" + }, + "InnerError": { + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "InvalidParameterValue", + "InvalidRequestBodyFormat", + "EmptyRequest", + "MissingInputRecords", + "InvalidDocument", + "ModelVersionIncorrect", + "InvalidDocumentBatch", + "UnsupportedLanguageCode", + "InvalidCountryHint" + ], + "x-ms-enum": { + "name": "InnerErrorCodeValue", + "modelAsString": true + }, + "description": "Error code." + }, + "message": { + "type": "string", + "description": "Error message." + }, + "details": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Error details." + }, + "target": { + "type": "string", + "description": "Error target." + }, + "innererror": { + "$ref": "#/definitions/InnerError", + "description": "Inner error contains more specific information." + } + } + }, + "AnalyzeBatchInput": { + "allOf": [ + { + "$ref": "#/definitions/JobDescriptor" + }, + { + "$ref": "#/definitions/AnalysisInput" + }, + { + "$ref": "#/definitions/JobManifest" + } + ] + }, + "AnalyzeJobState": { + "allOf": [ + { + "$ref": "#/definitions/AnalyzeJobMetadata" + }, + { + "$ref": "#/definitions/TasksState" + }, + { + "$ref": "#/definitions/AnalyzeJobErrorsAndStatistics" + }, + { + "$ref": "#/definitions/Pagination" + } + ] + }, + "ExtractiveSummarizationResult": { + "type": "object", + "required": [ + "documents", + "errors", + "modelVersion" + ], + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/ExtractedDocumentSummary" + } + }, + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics" + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + } + } + }, + "ExtractedDocumentSummary": { + "type": "object", + "required": [ + "id", + "sentences", + "warnings" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "sentences": { + "type": "array", + "description": "A ranked list of sentences representing the extracted summary.", + "items": { + "$ref": "#/definitions/ExtractedSummarySentence" + } + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/TextAnalyticsWarning" + } + }, + "statistics": { + "description": "if showStats=true was specified in the request this field will contain information about the document payload.", + "$ref": "#/definitions/DocumentStatistics" + } + } + }, + "ExtractedSummarySentence": { + "type": "object", + "required": [ + "text", + "rankScore", + "offset", + "length" + ], + "properties": { + "text": { + "type": "string", + "description": "The extracted sentence text." + }, + "rankScore": { + "type": "number", + "format": "double", + "description": "A double value representing the relevance of the sentence within the summary. Higher values indicate higher importance." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The sentence offset from the start of the document, based on the value of the parameter StringIndexType." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the sentence." + } + } + }, + "SentimentResponse": { + "type": "object", + "required": [ + "documents", + "errors", + "modelVersion" + ], + "properties": { + "documents": { + "type": "array", + "description": "Sentiment analysis per document.", + "items": { + "$ref": "#/definitions/DocumentSentiment" + } + }, + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics" + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + } + } + }, + "TaskState": { + "properties": { + "lastUpdateDateTime": { + "format": "date-time", + "type": "string" + }, + "taskName": { + "type": "string" + }, + "status": { + "enum": [ + "notStarted", + "running", + "succeeded", + "failed", + "rejected", + "cancelled", + "cancelling" + ], + "x-ms-enum": { + "modelAsString": false, + "name": "State" + } + } + }, + "required": [ + "status", + "lastUpdateDateTime", + "taskName" + ], + "type": "object" + }, + "TasksState": { + "properties": { + "tasks": { + "properties": { + "completed": { + "type": "integer" + }, + "failed": { + "type": "integer" + }, + "inProgress": { + "type": "integer" + }, + "total": { + "type": "integer" + }, + "entityRecognitionTasks": { + "type": "array", + "items": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskState" + }, + { + "$ref": "#/definitions/EntitiesTaskResult" + } + ] + } + }, + "entityRecognitionPiiTasks": { + "type": "array", + "items": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskState" + }, + { + "$ref": "#/definitions/PiiTaskResult" + } + ] + } + }, + "keyPhraseExtractionTasks": { + "type": "array", + "items": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskState" + }, + { + "$ref": "#/definitions/KeyPhraseTaskResult" + } + ] + } + }, + "entityLinkingTasks": { + "type": "array", + "items": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskState" + }, + { + "$ref": "#/definitions/EntityLinkingTaskResult" + } + ] + } + }, + "sentimentAnalysisTasks": { + "type": "array", + "items": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskState" + }, + { + "$ref": "#/definitions/SentimentTaskResult" + } + ] + } + }, + "extractiveSummarizationTasks": { + "type": "array", + "items": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskState" + }, + { + "$ref": "#/definitions/ExtractiveSummarizationTaskResult" + } + ] + } + } + }, + "required": [ + "total", + "completed", + "failed", + "inProgress" + ], + "type": "object" + } + }, + "required": [ + "tasks" + ], + "type": "object" + }, + "DocumentSentiment": { + "type": "object", + "required": [ + "id", + "sentiment", + "confidenceScores", + "sentences", + "warnings" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "sentiment": { + "type": "string", + "description": "Predicted sentiment for document (Negative, Neutral, Positive, or Mixed).", + "enum": [ + "positive", + "neutral", + "negative", + "mixed" + ], + "x-ms-enum": { + "name": "DocumentSentimentValue", + "modelAsString": false + } + }, + "statistics": { + "$ref": "#/definitions/DocumentStatistics" + }, + "confidenceScores": { + "description": "Document level sentiment confidence scores between 0 and 1 for each sentiment class.", + "$ref": "#/definitions/SentimentConfidenceScorePerLabel" + }, + "sentences": { + "type": "array", + "description": "Sentence level sentiment analysis.", + "items": { + "$ref": "#/definitions/SentenceSentiment" + } + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/TextAnalyticsWarning" + } + } + } + }, + "RequestStatistics": { + "type": "object", + "required": [ + "documentsCount", + "validDocumentsCount", + "erroneousDocumentsCount", + "transactionsCount" + ], + "properties": { + "documentsCount": { + "type": "integer", + "format": "int32", + "description": "Number of documents submitted in the request." + }, + "validDocumentsCount": { + "type": "integer", + "format": "int32", + "description": "Number of valid documents. This excludes empty, over-size limit or non-supported languages documents." + }, + "erroneousDocumentsCount": { + "type": "integer", + "format": "int32", + "description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents." + }, + "transactionsCount": { + "type": "integer", + "format": "int64", + "description": "Number of transactions for the request." + } + }, + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "DocumentStatistics": { + "type": "object", + "required": [ + "charactersCount", + "transactionsCount" + ], + "properties": { + "charactersCount": { + "type": "integer", + "format": "int32", + "description": "Number of text elements recognized in the document." + }, + "transactionsCount": { + "type": "integer", + "format": "int32", + "description": "Number of transactions for the document." + } + }, + "description": "if showStats=true was specified in the request this field will contain information about the document payload." + }, + "SentimentConfidenceScorePerLabel": { + "type": "object", + "required": [ + "positive", + "neutral", + "negative" + ], + "properties": { + "positive": { + "type": "number", + "format": "double" + }, + "neutral": { + "type": "number", + "format": "double" + }, + "negative": { + "type": "number", + "format": "double" + } + }, + "description": "Represents the confidence scores between 0 and 1 across all sentiment classes: positive, neutral, negative." + }, + "SentenceSentiment": { + "type": "object", + "required": [ + "text", + "sentiment", + "confidenceScores", + "offset", + "length" + ], + "properties": { + "text": { + "type": "string", + "description": "The sentence text." + }, + "sentiment": { + "type": "string", + "description": "The predicted Sentiment for the sentence.", + "enum": [ + "positive", + "neutral", + "negative" + ], + "x-ms-enum": { + "name": "SentenceSentimentValue", + "modelAsString": false + } + }, + "confidenceScores": { + "description": "The sentiment confidence score between 0 and 1 for the sentence for all classes.", + "$ref": "#/definitions/SentimentConfidenceScorePerLabel" + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The sentence offset from the start of the document." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the sentence." + }, + "targets": { + "type": "array", + "description": "The array of sentence targets for the sentence.", + "items": { + "$ref": "#/definitions/SentenceTarget" + } + }, + "assessments": { + "type": "array", + "description": "The array of assessments for the sentence.", + "items": { + "$ref": "#/definitions/SentenceAssessment" + } + } + } + }, + "SentenceTarget": { + "type": "object", + "required": [ + "confidenceScores", + "length", + "offset", + "relations", + "sentiment", + "text" + ], + "properties": { + "sentiment": { + "type": "string", + "enum": [ + "positive", + "mixed", + "negative" + ], + "x-ms-enum": { + "name": "TokenSentimentValue", + "modelAsString": false + }, + "description": "Targeted sentiment in the sentence." + }, + "confidenceScores": { + "description": "Target sentiment confidence scores for the target in the sentence.", + "$ref": "#/definitions/TargetConfidenceScoreLabel" + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The target offset from the start of the sentence." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the target." + }, + "text": { + "type": "string", + "description": "The target text detected." + }, + "relations": { + "type": "array", + "description": "The array of either assessment or target objects which is related to the target.", + "items": { + "$ref": "#/definitions/TargetRelation" + } + } + } + }, + "SentenceAssessment": { + "type": "object", + "required": [ + "confidenceScores", + "isNegated", + "length", + "offset", + "sentiment", + "text" + ], + "properties": { + "sentiment": { + "type": "string", + "enum": [ + "positive", + "mixed", + "negative" + ], + "x-ms-enum": { + "name": "TokenSentimentValue", + "modelAsString": false + }, + "description": "Assessment sentiment in the sentence." + }, + "confidenceScores": { + "description": "Assessment sentiment confidence scores in the sentence.", + "$ref": "#/definitions/TargetConfidenceScoreLabel" + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The assessment offset from the start of the sentence." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the assessment." + }, + "text": { + "type": "string", + "description": "The assessment text detected." + }, + "isNegated": { + "type": "boolean", + "description": "The indicator representing if the assessment is negated." + } + } + }, + "TargetRelation": { + "type": "object", + "required": [ + "ref", + "relationType" + ], + "properties": { + "relationType": { + "type": "string", + "enum": [ + "assessment", + "target" + ], + "x-ms-enum": { + "name": "TargetRelationType", + "modelAsString": false + }, + "description": "The type related to the target." + }, + "ref": { + "type": "string", + "description": "The JSON pointer indicating the linked object." + } + } + }, + "TargetConfidenceScoreLabel": { + "type": "object", + "required": [ + "negative", + "positive" + ], + "properties": { + "positive": { + "type": "number", + "format": "double" + }, + "negative": { + "type": "number", + "format": "double" + } + }, + "description": "Represents the confidence scores across all sentiment classes: positive, neutral, negative." + }, + "EntitiesResult": { + "type": "object", + "required": [ + "documents", + "errors", + "modelVersion" + ], + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/DocumentEntities" + } + }, + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics" + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + } + } + }, + "DocumentEntities": { + "type": "object", + "required": [ + "id", + "entities", + "warnings" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "entities": { + "type": "array", + "description": "Recognized entities in the document.", + "items": { + "$ref": "#/definitions/Entity" + } + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/TextAnalyticsWarning" + } + }, + "statistics": { + "description": "if showStats=true was specified in the request this field will contain information about the document payload.", + "$ref": "#/definitions/DocumentStatistics" + } + } + }, + "PiiDocumentEntities": { + "type": "object", + "required": [ + "id", + "redactedText", + "entities", + "warnings" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "redactedText": { + "type": "string", + "description": "Returns redacted text." + }, + "entities": { + "type": "array", + "description": "Recognized entities in the document.", + "items": { + "$ref": "#/definitions/Entity" + } + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/TextAnalyticsWarning" + } + }, + "statistics": { + "description": "if showStats=true was specified in the request this field will contain information about the document payload.", + "$ref": "#/definitions/DocumentStatistics" + } + } + }, + "Entity": { + "type": "object", + "required": [ + "text", + "category", + "offset", + "length", + "confidenceScore" + ], + "properties": { + "text": { + "type": "string", + "description": "Entity text as appears in the request." + }, + "category": { + "type": "string", + "description": "Entity type." + }, + "subcategory": { + "type": "string", + "description": "(Optional) Entity sub type." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Confidence score between 0 and 1 of the extracted entity." + } + } + }, + "EntityLinkingResult": { + "type": "object", + "required": [ + "documents", + "errors", + "modelVersion" + ], + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/DocumentLinkedEntities" + } + }, + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics" + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + } + } + }, + "DocumentLinkedEntities": { + "type": "object", + "required": [ + "id", + "entities", + "warnings" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "entities": { + "type": "array", + "description": "Recognized well known entities in the document.", + "items": { + "$ref": "#/definitions/LinkedEntity" + } + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/TextAnalyticsWarning" + } + }, + "statistics": { + "description": "if showStats=true was specified in the request this field will contain information about the document payload.", + "$ref": "#/definitions/DocumentStatistics" + } + } + }, + "HealthcareJobState": { + "allOf": [ + { + "$ref": "#/definitions/JobMetadata" + }, + { + "$ref": "#/definitions/HealthcareTaskResult" + }, + { + "$ref": "#/definitions/Pagination" + } + ] + }, + "HealthcareResult": { + "type": "object", + "required": [ + "documents", + "errors", + "modelVersion" + ], + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/DocumentHealthcareEntities" + } + }, + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics" + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + } + } + }, + "DocumentHealthcareEntities": { + "type": "object", + "required": [ + "id", + "entities", + "relations", + "warnings" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "entities": { + "description": "Healthcare entities.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthcareEntity" + } + }, + "relations": { + "type": "array", + "description": "Healthcare entity relations.", + "items": { + "$ref": "#/definitions/HealthcareRelation" + } + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/TextAnalyticsWarning" + } + }, + "statistics": { + "description": "if showStats=true was specified in the request this field will contain information about the document payload.", + "$ref": "#/definitions/DocumentStatistics" + } + } + }, + "HealthcareEntity": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HealthcareEntityProperties" + }, + { + "$ref": "#/definitions/HealthcareLinkingProperties" + } + ] + }, + "HealthcareRelation": { + "type": "object", + "description": "Every relation is an entity graph of a certain relationType, where all entities are connected and have specific roles within the relation context.", + "required": [ + "relationType", + "entities" + ], + "properties": { + "relationType": { + "description": "Type of relation. Examples include: `DosageOfMedication` or 'FrequencyOfMedication', etc.", + "type": "string", + "enum": [ + "Abbreviation", + "DirectionOfBodyStructure", + "DirectionOfCondition", + "DirectionOfExamination", + "DirectionOfTreatment", + "DosageOfMedication", + "FormOfMedication", + "FrequencyOfMedication", + "FrequencyOfTreatment", + "QualifierOfCondition", + "RelationOfExamination", + "RouteOfMedication", + "TimeOfCondition", + "TimeOfEvent", + "TimeOfExamination", + "TimeOfMedication", + "TimeOfTreatment", + "UnitOfCondition", + "UnitOfExamination", + "ValueOfCondition", + "ValueOfExamination" + ], + "x-ms-enum": { + "name": "relationType", + "modelAsString": true + } + }, + "entities": { + "description": "The entities in the relation.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthcareRelationEntity" + } + } + } + }, + "HealthcareAssertion": { + "type": "object", + "properties": { + "conditionality": { + "description": "Describes any conditionality on the entity.", + "type": "string", + "enum": [ + "hypothetical", + "conditional" + ], + "x-ms-enum": { + "name": "Conditionality", + "modelAsString": false + } + }, + "certainty": { + "description": "Describes the entities certainty and polarity.", + "type": "string", + "enum": [ + "positive", + "positivePossible", + "neutralPossible", + "negativePossible", + "negative" + ], + "x-ms-enum": { + "name": "Certainty", + "modelAsString": false + } + }, + "association": { + "description": "Describes if the entity is the subject of the text or if it describes someone else.", + "type": "string", + "enum": [ + "subject", + "other" + ], + "x-ms-enum": { + "name": "Association", + "modelAsString": false + } + } + } + }, + "HealthcareRelationEntity": { + "type": "object", + "required": [ + "ref", + "role" + ], + "properties": { + "ref": { + "description": "Reference link object, using a JSON pointer RFC 6901 (URI Fragment Identifier Representation), pointing to the entity .", + "type": "string" + }, + "role": { + "description": "Role of entity in the relationship. For example: 'CD20-positive diffuse large B-cell lymphoma' has the following entities with their roles in parenthesis: CD20 (GeneOrProtein), Positive (Expression), diffuse large B-cell lymphoma (Diagnosis).", + "type": "string" + } + } + }, + "HealthcareEntityLink": { + "type": "object", + "required": [ + "dataSource", + "id" + ], + "properties": { + "dataSource": { + "description": "Entity Catalog. Examples include: UMLS, CHV, MSH, etc.", + "type": "string" + }, + "id": { + "description": "Entity id in the given source catalog.", + "type": "string" + } + } + }, + "HealthcareEntityProperties": { + "type": "object", + "required": [ + "text", + "category", + "offset", + "length", + "confidenceScore" + ], + "properties": { + "text": { + "type": "string", + "description": "Entity text as appears in the request." + }, + "category": { + "x-ms-enum": { + "name": "healthcareEntityCategory", + "modelAsString": true + }, + "type": "string", + "description": "Healthcare Entity Category.", + "enum": [ + "BODY_STRUCTURE", + "AGE", + "GENDER", + "EXAMINATION_NAME", + "DATE", + "DIRECTION", + "FREQUENCY", + "MEASUREMENT_VALUE", + "MEASUREMENT_UNIT", + "RELATIONAL_OPERATOR", + "TIME", + "GENE_OR_PROTEIN", + "VARIANT", + "ADMINISTRATIVE_EVENT", + "CARE_ENVIRONMENT", + "HEALTHCARE_PROFESSION", + "DIAGNOSIS", + "SYMPTOM_OR_SIGN", + "CONDITION_QUALIFIER", + "MEDICATION_CLASS", + "MEDICATION_NAME", + "DOSAGE", + "MEDICATION_FORM", + "MEDICATION_ROUTE", + "FAMILY_RELATION", + "TREATMENT_NAME" + ] + }, + "subcategory": { + "type": "string", + "description": "(Optional) Entity sub type." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Confidence score between 0 and 1 of the extracted entity." + } + } + }, + "HealthcareLinkingProperties": { + "properties": { + "assertion": { + "type": "object", + "$ref": "#/definitions/HealthcareAssertion" + }, + "name": { + "description": "Preferred name for the entity. Example: 'histologically' would have a 'name' of 'histologic'.", + "type": "string" + }, + "links": { + "description": "Entity references in known data sources.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthcareEntityLink" + } + } + } + }, + "LinkedEntity": { + "type": "object", + "required": [ + "name", + "matches", + "language", + "url", + "dataSource" + ], + "properties": { + "name": { + "type": "string", + "description": "Entity Linking formal name." + }, + "matches": { + "type": "array", + "description": "List of instances this entity appears in the text.", + "items": { + "$ref": "#/definitions/Match" + } + }, + "language": { + "type": "string", + "description": "Language used in the data source." + }, + "id": { + "type": "string", + "description": "Unique identifier of the recognized entity from the data source." + }, + "url": { + "type": "string", + "description": "URL for the entity's page from the data source." + }, + "dataSource": { + "type": "string", + "description": "Data source used to extract entity linking, such as Wiki/Bing etc." + }, + "bingId": { + "type": "string", + "description": "Bing Entity Search API unique identifier of the recognized entity." + } + } + }, + "Match": { + "type": "object", + "required": [ + "confidenceScore", + "text", + "offset", + "length" + ], + "properties": { + "confidenceScore": { + "type": "number", + "format": "double", + "description": "If a well known item is recognized, a decimal number denoting the confidence level between 0 and 1 will be returned." + }, + "text": { + "type": "string", + "description": "Entity text as appears in the request." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the entity match text." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Length for the entity match text." + } + } + }, + "AnalysisInput": { + "type": "object", + "required": [ + "analysisInput" + ], + "properties": { + "analysisInput": { + "$ref": "#/definitions/MultiLanguageBatchInput" + } + } + }, + "EntitiesTaskResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/EntitiesResult" + } + } + }, + "PiiTaskResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/PiiResult" + } + } + }, + "KeyPhraseTaskResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/KeyPhraseResult" + } + } + }, + "EntityLinkingTaskResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/EntityLinkingResult" + } + } + }, + "SentimentTaskResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/SentimentResponse" + } + } + }, + "ExtractiveSummarizationTaskResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/ExtractiveSummarizationResult" + } + } + }, + "HealthcareTaskResult": { + "properties": { + "results": { + "$ref": "#/definitions/HealthcareResult" + }, + "errors": { + "items": { + "$ref": "#/definitions/TextAnalyticsError" + }, + "type": "array" + } + }, + "type": "object" + }, + "JobDescriptor": { + "properties": { + "displayName": { + "description": "Optional display name for the analysis job.", + "type": "string" + } + }, + "type": "object" + }, + "JobMetadata": { + "properties": { + "createdDateTime": { + "format": "date-time", + "type": "string" + }, + "expirationDateTime": { + "format": "date-time", + "type": "string" + }, + "jobId": { + "format": "uuid", + "type": "string" + }, + "lastUpdateDateTime": { + "format": "date-time", + "type": "string" + }, + "status": { + "enum": [ + "notStarted", + "running", + "succeeded", + "failed", + "cancelled", + "cancelling" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": false, + "name": "State" + } + } + }, + "required": [ + "jobId", + "lastUpdateDateTime", + "createdDateTime", + "status" + ], + "type": "object" + }, + "AnalyzeJobDisplayName": { + "properties": { + "displayName": { + "type": "string" + } + } + }, + "AnalyzeJobMetadata": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobMetadata" + }, + { + "$ref": "#/definitions/AnalyzeJobDisplayName" + } + ] + }, + "AnalyzeJobErrorsAndStatistics": { + "properties": { + "errors": { + "items": { + "$ref": "#/definitions/TextAnalyticsError" + }, + "type": "array" + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics" + } + }, + "type": "object" + }, + "KeyPhraseResult": { + "type": "object", + "required": [ + "documents", + "errors", + "modelVersion" + ], + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/DocumentKeyPhrases" + } + }, + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics" + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + } + } + }, + "DocumentKeyPhrases": { + "type": "object", + "required": [ + "id", + "keyPhrases", + "warnings" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "keyPhrases": { + "type": "array", + "description": "A list of representative words or phrases. The number of key phrases returned is proportional to the number of words in the input document.", + "items": { + "type": "string" + } + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/TextAnalyticsWarning" + } + }, + "statistics": { + "description": "if showStats=true was specified in the request this field will contain information about the document payload.", + "$ref": "#/definitions/DocumentStatistics" + } + } + }, + "KeyPhrasesTask": { + "properties": { + "parameters": { + "properties": { + "model-version": { + "default": "latest", + "type": "string" + }, + "loggingOptOut": { + "default": false, + "type": "boolean" + } + }, + "type": "object" + }, + "taskName": { + "type": "string" + } + }, + "type": "object" + }, + "EntityLinkingTask": { + "properties": { + "parameters": { + "properties": { + "model-version": { + "default": "latest", + "type": "string" + }, + "loggingOptOut": { + "default": false, + "type": "boolean" + }, + "stringIndexType": { + "$ref": "#/definitions/StringIndexType" + } + }, + "type": "object" + }, + "taskName": { + "type": "string" + } + }, + "type": "object" + }, + "LanguageBatchInput": { + "type": "object", + "required": [ + "documents" + ], + "properties": { + "documents": { + "type": "array", + "items": { + "$ref": "#/definitions/LanguageInput" + } + } + } + }, + "LanguageInput": { + "type": "object", + "required": [ + "id", + "text" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "text": { + "type": "string" + }, + "countryHint": { + "type": "string" + } + } + }, + "Pagination": { + "properties": { + "@nextLink": { + "type": "string" + } + }, + "type": "object" + }, + "PiiResult": { + "type": "object", + "required": [ + "documents", + "errors", + "modelVersion" + ], + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/PiiDocumentEntities" + } + }, + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics" + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + } + } + }, + "LanguageResult": { + "type": "object", + "required": [ + "documents", + "errors", + "modelVersion" + ], + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/DocumentLanguage" + } + }, + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics" + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + } + } + }, + "DocumentLanguage": { + "type": "object", + "required": [ + "id", + "detectedLanguage", + "warnings" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "detectedLanguage": { + "description": "Detected Language.", + "$ref": "#/definitions/DetectedLanguage" + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/TextAnalyticsWarning" + } + }, + "statistics": { + "description": "if showStats=true was specified in the request this field will contain information about the document payload.", + "$ref": "#/definitions/DocumentStatistics" + } + } + }, + "DetectedLanguage": { + "type": "object", + "required": [ + "name", + "iso6391Name", + "confidenceScore" + ], + "properties": { + "name": { + "type": "string", + "description": "Long name of a detected language (e.g. English, French)." + }, + "iso6391Name": { + "type": "string", + "description": "A two letter representation of the detected language according to the ISO 639-1 standard (e.g. en, fr)." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "A confidence score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true." + } + } + }, + "StringIndexType": { + "default": "TextElement_v8", + "enum": [ + "TextElement_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "value": "TextElement_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + }, + "type": "string" + }, + "PiiCategories": { + "description": "(Optional) describes the PII categories to return", + "items": { + "type": "string", + "x-ms-enum": { + "name": "PiiCategory", + "modelAsString": true + }, + "enum": [ + "ABARoutingNumber", + "ARNationalIdentityNumber", + "AUBankAccountNumber", + "AUDriversLicenseNumber", + "AUMedicalAccountNumber", + "AUPassportNumber", + "AUTaxFileNumber", + "AUBusinessNumber", + "AUCompanyNumber", + "ATIdentityCard", + "ATTaxIdentificationNumber", + "ATValueAddedTaxNumber", + "AzureDocumentDBAuthKey", + "AzureIAASDatabaseConnectionAndSQLString", + "AzureIoTConnectionString", + "AzurePublishSettingPassword", + "AzureRedisCacheString", + "AzureSAS", + "AzureServiceBusString", + "AzureStorageAccountKey", + "AzureStorageAccountGeneric", + "BENationalNumber", + "BENationalNumberV2", + "BEValueAddedTaxNumber", + "BRCPFNumber", + "BRLegalEntityNumber", + "BRNationalIDRG", + "BGUniformCivilNumber", + "CABankAccountNumber", + "CADriversLicenseNumber", + "CAHealthServiceNumber", + "CAPassportNumber", + "CAPersonalHealthIdentification", + "CASocialInsuranceNumber", + "CLIdentityCardNumber", + "CNResidentIdentityCardNumber", + "CreditCardNumber", + "HRIdentityCardNumber", + "HRNationalIDNumber", + "HRPersonalIdentificationNumber", + "HRPersonalIdentificationOIBNumberV2", + "CYIdentityCard", + "CYTaxIdentificationNumber", + "CZPersonalIdentityNumber", + "CZPersonalIdentityV2", + "DKPersonalIdentificationNumber", + "DKPersonalIdentificationV2", + "DrugEnforcementAgencyNumber", + "EEPersonalIdentificationCode", + "EUDebitCardNumber", + "EUDriversLicenseNumber", + "EUGPSCoordinates", + "EUNationalIdentificationNumber", + "EUPassportNumber", + "EUSocialSecurityNumber", + "EUTaxIdentificationNumber", + "FIEuropeanHealthNumber", + "FINationalID", + "FINationalIDV2", + "FIPassportNumber", + "FRDriversLicenseNumber", + "FRHealthInsuranceNumber", + "FRNationalID", + "FRPassportNumber", + "FRSocialSecurityNumber", + "FRTaxIdentificationNumber", + "FRValueAddedTaxNumber", + "DEDriversLicenseNumber", + "DEPassportNumber", + "DEIdentityCardNumber", + "DETaxIdentificationNumber", + "DEValueAddedNumber", + "GRNationalIDCard", + "GRNationalIDV2", + "GRTaxIdentificationNumber", + "HKIdentityCardNumber", + "HUValueAddedNumber", + "HUPersonalIdentificationNumber", + "HUTaxIdentificationNumber", + "INPermanentAccount", + "INUniqueIdentificationNumber", + "IDIdentityCardNumber", + "InternationalBankingAccountNumber", + "IEPersonalPublicServiceNumber", + "IEPersonalPublicServiceNumberV2", + "ILBankAccountNumber", + "ILNationalID", + "ITDriversLicenseNumber", + "ITFiscalCode", + "ITValueAddedTaxNumber", + "JPBankAccountNumber", + "JPDriversLicenseNumber", + "JPPassportNumber", + "JPResidentRegistrationNumber", + "JPSocialInsuranceNumber", + "JPMyNumberCorporate", + "JPMyNumberPersonal", + "JPResidenceCardNumber", + "LVPersonalCode", + "LTPersonalCode", + "LUNationalIdentificationNumberNatural", + "LUNationalIdentificationNumberNonNatural", + "MYIdentityCardNumber", + "MTIdentityCardNumber", + "MTTaxIDNumber", + "NLCitizensServiceNumber", + "NLCitizensServiceNumberV2", + "NLTaxIdentificationNumber", + "NLValueAddedTaxNumber", + "NZBankAccountNumber", + "NZDriversLicenseNumber", + "NZInlandRevenueNumber", + "NZMinistryOfHealthNumber", + "NZSocialWelfareNumber", + "NOIdentityNumber", + "PHUnifiedMultiPurposeIDNumber", + "PLIdentityCard", + "PLNationalID", + "PLNationalIDV2", + "PLPassportNumber", + "PLTaxIdentificationNumber", + "PLREGONNumber", + "PTCitizenCardNumber", + "PTCitizenCardNumberV2", + "PTTaxIdentificationNumber", + "ROPersonalNumericalCode", + "RUPassportNumberDomestic", + "RUPassportNumberInternational", + "SANationalID", + "SGNationalRegistrationIdentityCardNumber", + "SKPersonalNumber", + "SITaxIdentificationNumber", + "SIUniqueMasterCitizenNumber", + "ZAIdentificationNumber", + "KRResidentRegistrationNumber", + "ESDNI", + "ESSocialSecurityNumber", + "ESTaxIdentificationNumber", + "SQLServerConnectionString", + "SENationalID", + "SENationalIDV2", + "SEPassportNumber", + "SETaxIdentificationNumber", + "SWIFTCode", + "CHSocialSecurityNumber", + "TWNationalID", + "TWPassportNumber", + "TWResidentCertificate", + "THPopulationIdentificationCode", + "TRNationalIdentificationNumber", + "UKDriversLicenseNumber", + "UKElectoralRollNumber", + "UKNationalHealthNumber", + "UKNationalInsuranceNumber", + "UKUniqueTaxpayerNumber", + "USUKPassportNumber", + "USBankAccountNumber", + "USDriversLicenseNumber", + "USIndividualTaxpayerIdentification", + "USSocialSecurityNumber", + "UAPassportNumberDomestic", + "UAPassportNumberInternational", + "Organization", + "Email", + "URL", + "Age", + "PhoneNumber", + "IPAddress", + "Date", + "Person", + "Address", + "All", + "Default" + ] + }, + "type": "array", + "uniqueItems": true + } + }, + "parameters": { + "ApiVersion": { + "name": "ApiVersion", + "description": "Text Analytics API version (for example, v3.0).", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "enum": [ + "v3.2-preview.1" + ], + "in": "path", + "x-ms-skip-url-encoding": true + }, + "Endpoint": { + "name": "Endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + }, + "StringIndexType": { + "name": "stringIndexType", + "in": "query", + "type": "string", + "description": "(Optional) Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets", + "default": "TextElement_v8", + "enum": [ + "TextElement_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "value": "TextElement_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "PiiCategories": { + "description": "(Optional) describes the PII categories to return", + "in": "query", + "collectionFormat": "csv", + "items": { + "type": "string", + "x-ms-enum": { + "name": "PiiCategory", + "modelAsString": true + }, + "enum": [ + "ABARoutingNumber", + "ARNationalIdentityNumber", + "AUBankAccountNumber", + "AUDriversLicenseNumber", + "AUMedicalAccountNumber", + "AUPassportNumber", + "AUTaxFileNumber", + "AUBusinessNumber", + "AUCompanyNumber", + "ATIdentityCard", + "ATTaxIdentificationNumber", + "ATValueAddedTaxNumber", + "AzureDocumentDBAuthKey", + "AzureIAASDatabaseConnectionAndSQLString", + "AzureIoTConnectionString", + "AzurePublishSettingPassword", + "AzureRedisCacheString", + "AzureSAS", + "AzureServiceBusString", + "AzureStorageAccountKey", + "AzureStorageAccountGeneric", + "BENationalNumber", + "BENationalNumberV2", + "BEValueAddedTaxNumber", + "BRCPFNumber", + "BRLegalEntityNumber", + "BRNationalIDRG", + "BGUniformCivilNumber", + "CABankAccountNumber", + "CADriversLicenseNumber", + "CAHealthServiceNumber", + "CAPassportNumber", + "CAPersonalHealthIdentification", + "CASocialInsuranceNumber", + "CLIdentityCardNumber", + "CNResidentIdentityCardNumber", + "CreditCardNumber", + "HRIdentityCardNumber", + "HRNationalIDNumber", + "HRPersonalIdentificationNumber", + "HRPersonalIdentificationOIBNumberV2", + "CYIdentityCard", + "CYTaxIdentificationNumber", + "CZPersonalIdentityNumber", + "CZPersonalIdentityV2", + "DKPersonalIdentificationNumber", + "DKPersonalIdentificationV2", + "DrugEnforcementAgencyNumber", + "EEPersonalIdentificationCode", + "EUDebitCardNumber", + "EUDriversLicenseNumber", + "EUGPSCoordinates", + "EUNationalIdentificationNumber", + "EUPassportNumber", + "EUSocialSecurityNumber", + "EUTaxIdentificationNumber", + "FIEuropeanHealthNumber", + "FINationalID", + "FINationalIDV2", + "FIPassportNumber", + "FRDriversLicenseNumber", + "FRHealthInsuranceNumber", + "FRNationalID", + "FRPassportNumber", + "FRSocialSecurityNumber", + "FRTaxIdentificationNumber", + "FRValueAddedTaxNumber", + "DEDriversLicenseNumber", + "DEPassportNumber", + "DEIdentityCardNumber", + "DETaxIdentificationNumber", + "DEValueAddedNumber", + "GRNationalIDCard", + "GRNationalIDV2", + "GRTaxIdentificationNumber", + "HKIdentityCardNumber", + "HUValueAddedNumber", + "HUPersonalIdentificationNumber", + "HUTaxIdentificationNumber", + "INPermanentAccount", + "INUniqueIdentificationNumber", + "IDIdentityCardNumber", + "InternationalBankingAccountNumber", + "IEPersonalPublicServiceNumber", + "IEPersonalPublicServiceNumberV2", + "ILBankAccountNumber", + "ILNationalID", + "ITDriversLicenseNumber", + "ITFiscalCode", + "ITValueAddedTaxNumber", + "JPBankAccountNumber", + "JPDriversLicenseNumber", + "JPPassportNumber", + "JPResidentRegistrationNumber", + "JPSocialInsuranceNumber", + "JPMyNumberCorporate", + "JPMyNumberPersonal", + "JPResidenceCardNumber", + "LVPersonalCode", + "LTPersonalCode", + "LUNationalIdentificationNumberNatural", + "LUNationalIdentificationNumberNonNatural", + "MYIdentityCardNumber", + "MTIdentityCardNumber", + "MTTaxIDNumber", + "NLCitizensServiceNumber", + "NLCitizensServiceNumberV2", + "NLTaxIdentificationNumber", + "NLValueAddedTaxNumber", + "NZBankAccountNumber", + "NZDriversLicenseNumber", + "NZInlandRevenueNumber", + "NZMinistryOfHealthNumber", + "NZSocialWelfareNumber", + "NOIdentityNumber", + "PHUnifiedMultiPurposeIDNumber", + "PLIdentityCard", + "PLNationalID", + "PLNationalIDV2", + "PLPassportNumber", + "PLTaxIdentificationNumber", + "PLREGONNumber", + "PTCitizenCardNumber", + "PTCitizenCardNumberV2", + "PTTaxIdentificationNumber", + "ROPersonalNumericalCode", + "RUPassportNumberDomestic", + "RUPassportNumberInternational", + "SANationalID", + "SGNationalRegistrationIdentityCardNumber", + "SKPersonalNumber", + "SITaxIdentificationNumber", + "SIUniqueMasterCitizenNumber", + "ZAIdentificationNumber", + "KRResidentRegistrationNumber", + "ESDNI", + "ESSocialSecurityNumber", + "ESTaxIdentificationNumber", + "SQLServerConnectionString", + "SENationalID", + "SENationalIDV2", + "SEPassportNumber", + "SETaxIdentificationNumber", + "SWIFTCode", + "CHSocialSecurityNumber", + "TWNationalID", + "TWPassportNumber", + "TWResidentCertificate", + "THPopulationIdentificationCode", + "TRNationalIdentificationNumber", + "UKDriversLicenseNumber", + "UKElectoralRollNumber", + "UKNationalHealthNumber", + "UKNationalInsuranceNumber", + "UKUniqueTaxpayerNumber", + "USUKPassportNumber", + "USBankAccountNumber", + "USDriversLicenseNumber", + "USIndividualTaxpayerIdentification", + "USSocialSecurityNumber", + "UAPassportNumberDomestic", + "UAPassportNumberInternational", + "Organization", + "Email", + "URL", + "Age", + "PhoneNumber", + "IPAddress", + "Date", + "Person", + "Address", + "All", + "Default" + ] + }, + "name": "piiCategories", + "required": false, + "type": "array", + "uniqueItems": true, + "x-ms-parameter-location": "method" + }, + "JobId": { + "description": "Job ID", + "format": "uuid", + "in": "path", + "name": "jobId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "AnalyzeJobId": { + "description": "Job ID for Analyze", + "in": "path", + "name": "jobId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ShowStats": { + "name": "showStats", + "in": "query", + "description": "(Optional) if set to true, response will contain request and document level statistics.", + "type": "boolean", + "required": false, + "x-ms-parameter-location": "method" + }, + "LoggingOptOut": { + "name": "loggingOptOut", + "in": "query", + "description": "(Optional) If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to allow for troubleshooting issues in providing you with the Text Analytics natural language processing functions. Setting this parameter to true, disables input logging and may limit our ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI principles at https://www.microsoft.com/en-us/ai/responsible-ai.", + "type": "boolean", + "required": false, + "x-ms-parameter-location": "method" + }, + "ModelVersion": { + "name": "model-version", + "in": "query", + "description": "(Optional) This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version. ", + "type": "string", + "required": false, + "x-ms-parameter-location": "method" + }, + "MultiLanguageInput": { + "in": "body", + "name": "input", + "description": "Collection of documents to analyze.", + "required": true, + "schema": { + "$ref": "#/definitions/MultiLanguageBatchInput" + }, + "x-ms-parameter-location": "method" + }, + "LanguageInput": { + "in": "body", + "name": "input", + "description": "Collection of documents to analyze for language endpoint.", + "required": true, + "schema": { + "$ref": "#/definitions/LanguageBatchInput" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulAnalyzeRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulAnalyzeRequest.json new file mode 100644 index 000000000000..b50ef145aac3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulAnalyzeRequest.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "ApiVersion": "v3.2-preview.1", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "input": { + "displayName": "Extracting Location & US Region", + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "I had a wonderful trip to Seattle last week." + }, + { + "id": "2", + "language": "en", + "text": "I'm flying to NYC tomorrow. See you there." + } + ] + }, + "tasks": { + "entityRecognitionTasks": [ + { + "parameters": { + "model-version": "latest" + } + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/text/analytics/v3.2-preview.1/analyze/jobs/{jobId}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulAnalyzeStatusRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulAnalyzeStatusRequest.json new file mode 100644 index 000000000000..0eb83f5cfa8e --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulAnalyzeStatusRequest.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "ApiVersion": "v3.2-preview.1", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2020-10-01T15:00:45Z", + "displayName": "Extracting Location & US Region", + "expirationDateTime": "2020-10-03T15:01:03Z", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + "lastUpdateDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "tasks": { + "completed": 2, + "failed": 0, + "inProgress": 0, + "total": 2, + "entityRecognitionTasks": [ + { + "taskName": "Recognize Entities (2020-04-01)", + "lastUpdateDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "results": { + "documents": [ + { + "entities": [ + { + "category": "Event", + "confidenceScore": 0.61, + "length": 4, + "offset": 18, + "text": "trip" + }, + { + "category": "Location", + "confidenceScore": 0.82, + "length": 7, + "offset": 26, + "subcategory": "GPE", + "text": "Seattle" + }, + { + "category": "DateTime", + "confidenceScore": 0.8, + "length": 9, + "offset": 34, + "subcategory": "DateRange", + "text": "last week" + } + ], + "id": "1", + "warnings": [] + }, + { + "entities": [ + { + "category": "Location", + "confidenceScore": 0.52, + "length": 3, + "offset": 14, + "subcategory": "GPE", + "text": "NYC" + }, + { + "category": "DateTime", + "confidenceScore": 0.8, + "length": 8, + "offset": 18, + "subcategory": "Date", + "text": "tomorrow" + } + ], + "id": "2", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2020-04-01" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulEntitiesRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulEntitiesRequest.json new file mode 100644 index 000000000000..0735c8d46bc3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulEntitiesRequest.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "ApiVersion": "v3.2-preview.1", + "Endpoint": "{Endpoint}", + "input": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "Microsoft was founded by Bill Gates and Paul Allen." + }, + { + "id": "2", + "language": "en", + "text": "Pike place market is my favorite Seattle attraction." + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "documents": [ + { + "entities": [ + { + "category": "Organization", + "confidenceScore": 0.84, + "length": 9, + "offset": 0, + "text": "Microsoft" + }, + { + "category": "Person", + "confidenceScore": 0.85, + "length": 10, + "offset": 25, + "text": "Bill Gates" + }, + { + "category": "Person", + "confidenceScore": 0.9, + "length": 10, + "offset": 40, + "text": "Paul Allen" + } + ], + "id": "1", + "warnings": [] + }, + { + "entities": [ + { + "category": "Location", + "confidenceScore": 0.55, + "length": 7, + "offset": 33, + "subcategory": "GPE", + "text": "Seattle" + } + ], + "id": "2", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2020-04-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulEntityLinkingRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulEntityLinkingRequest.json new file mode 100644 index 000000000000..22f109e8ccea --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulEntityLinkingRequest.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "ApiVersion": "v3.2-preview.1", + "Endpoint": "{Endpoint}", + "input": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "Microsoft was founded by Bill Gates and Paul Allen." + }, + { + "id": "2", + "language": "en", + "text": "Pike place market is my favorite Seattle attraction." + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "documents": [ + { + "entities": [ + { + "dataSource": "Wikipedia", + "id": "Bill Gates", + "language": "en", + "matches": [ + { + "confidenceScore": 0.52, + "length": 10, + "offset": 25, + "text": "Bill Gates" + } + ], + "name": "Bill Gates", + "url": "https://en.wikipedia.org/wiki/Bill_Gates" + }, + { + "dataSource": "Wikipedia", + "id": "Paul Allen", + "language": "en", + "matches": [ + { + "confidenceScore": 0.54, + "length": 10, + "offset": 40, + "text": "Paul Allen" + } + ], + "name": "Paul Allen", + "url": "https://en.wikipedia.org/wiki/Paul_Allen" + }, + { + "dataSource": "Wikipedia", + "id": "Microsoft", + "language": "en", + "matches": [ + { + "confidenceScore": 0.49, + "length": 9, + "offset": 0, + "text": "Microsoft" + } + ], + "name": "Microsoft", + "url": "https://en.wikipedia.org/wiki/Microsoft" + } + ], + "id": "1", + "warnings": [] + }, + { + "entities": [ + { + "dataSource": "Wikipedia", + "id": "Pike Place Market", + "language": "en", + "matches": [ + { + "confidenceScore": 0.86, + "length": 17, + "offset": 0, + "text": "Pike place market" + } + ], + "name": "Pike Place Market", + "url": "https://en.wikipedia.org/wiki/Pike_Place_Market" + }, + { + "dataSource": "Wikipedia", + "id": "Seattle", + "language": "en", + "matches": [ + { + "confidenceScore": 0.27, + "length": 7, + "offset": 33, + "text": "Seattle" + } + ], + "name": "Seattle", + "url": "https://en.wikipedia.org/wiki/Seattle" + } + ], + "id": "2", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2020-02-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulEntityPIIRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulEntityPIIRequest.json new file mode 100644 index 000000000000..9a0aef782973 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulEntityPIIRequest.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "ApiVersion": "v3.2-preview.1", + "Endpoint": "{Endpoint}", + "input": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "My SSN is 859-98-0987" + }, + { + "id": "2", + "language": "en", + "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check." + }, + { + "id": "3", + "language": "en", + "text": "Is 998.214.865-68 your Brazilian CPF number?" + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "documents": [ + { + "id": "1", + "redactedText": "My SSN is ***********", + "entities": [ + { + "category": "U.S. Social Security Number (SSN)", + "confidenceScore": 0.65, + "length": 11, + "offset": 28, + "text": "859-98-0987" + } + ], + "warnings": [] + }, + { + "id": "2", + "redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.", + "entities": [ + { + "category": "ABA Routing Number", + "confidenceScore": 0.75, + "length": 9, + "offset": 18, + "text": "111000025" + } + ], + "warnings": [] + }, + { + "id": "3", + "redactedText": "Is ************** your Brazilian CPF number?", + "entities": [ + { + "category": "Brazil CPF Number", + "confidenceScore": 0.85, + "length": 14, + "offset": 3, + "text": "998.214.865-68" + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2019-10-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulHealthDeleteRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulHealthDeleteRequest.json new file mode 100644 index 000000000000..0822a3fec54c --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulHealthDeleteRequest.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "ApiVersion": "v3.2-preview.1", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}" + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/text/analytics/v3.2-preview.1/entities/healthcare/jobs/{jobId}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulHealthRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulHealthRequest.json new file mode 100644 index 000000000000..08df27f320cd --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulHealthRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "ApiVersion": "v3.2-preview.1", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "input": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "Subject is taking 100mg of ibuprofen twice daily." + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/text/analytics/v3.2-preview.1/entities/healthcare/jobs/{jobId}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulHealthStatusRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulHealthStatusRequest.json new file mode 100644 index 000000000000..2423db1d8db0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulHealthStatusRequest.json @@ -0,0 +1,206 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "ApiVersion": "v3.2-preview.1", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2020-10-01T15:01:03Z", + "expirationDateTime": "2020-10-03T15:01:03Z", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + "lastUpdateDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "results": { + "documents": [ + { + "id": "1", + "entities": [ + { + "offset": 18, + "length": 5, + "text": "100mg", + "category": "DOSAGE", + "confidenceScore": 0.99 + }, + { + "offset": 27, + "length": 9, + "text": "ibuprofen", + "category": "MEDICATION_NAME", + "confidenceScore": 1.0, + "assertion": { + "certainty": "positive" + }, + "links": [ + { + "id": "C0020740", + "dataSource": "UMLS" + }, + { + "id": "0000019879", + "dataSource": "AOD" + }, + { + "id": "M01AE01", + "dataSource": "ATC" + }, + { + "id": "0046165", + "dataSource": "CCPSS" + }, + { + "id": "0000006519", + "dataSource": "CHV" + }, + { + "id": "2270-2077", + "dataSource": "CSP" + }, + { + "id": "DB01050", + "dataSource": "DRUGBANK" + }, + { + "id": "1611", + "dataSource": "GS" + }, + { + "id": "sh97005926", + "dataSource": "LCH_NW" + }, + { + "id": "LP16165-0", + "dataSource": "LNC" + }, + { + "id": "40458", + "dataSource": "MEDCIN" + }, + { + "id": "d00015", + "dataSource": "MMSL" + }, + { + "id": "D007052", + "dataSource": "MSH" + }, + { + "id": "WK2XYI10QM", + "dataSource": "MTHSPL" + }, + { + "id": "C561", + "dataSource": "NCI" + }, + { + "id": "C561", + "dataSource": "NCI_CTRP" + }, + { + "id": "00803", + "dataSource": "NCI_DCP" + }, + { + "id": "NSC0256857", + "dataSource": "NCI_DTP" + }, + { + "id": "WK2XYI10QM", + "dataSource": "NCI_FDA" + }, + { + "id": "CDR0000613511", + "dataSource": "NCI_NCI-GLOSS" + }, + { + "id": "002377", + "dataSource": "NDDF" + }, + { + "id": "CDR0000040475", + "dataSource": "PDQ" + }, + { + "id": "x02MO", + "dataSource": "RCD" + }, + { + "id": "5640", + "dataSource": "RXNORM" + }, + { + "id": "E-7772", + "dataSource": "SNM" + }, + { + "id": "C-603C0", + "dataSource": "SNMI" + }, + { + "id": "387207008", + "dataSource": "SNOMEDCT_US" + }, + { + "id": "m39860", + "dataSource": "USP" + }, + { + "id": "MTHU000060", + "dataSource": "USPMG" + }, + { + "id": "4017840", + "dataSource": "VANDF" + } + ] + }, + { + "offset": 37, + "length": 11, + "text": "twice daily", + "category": "FREQUENCY", + "confidenceScore": 1 + } + ], + "relations": [ + { + "relationType": "DosageOfMedication", + "entities": [ + { + "ref": "#/documents/0/entities/0", + "role": "Attribute" + }, + { + "ref": "#/documents/0/entities/1", + "role": "Entity" + } + ] + }, + { + "relationType": "FrequencyOfMedication", + "entities": [ + { + "ref": "#/documents/0/entities/2", + "role": "Attribute" + }, + { + "ref": "#/documents/0/entities/1", + "role": "Entity" + } + ] + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2020-05-08" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulKeyPhrasesRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulKeyPhrasesRequest.json new file mode 100644 index 000000000000..82907a754644 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulKeyPhrasesRequest.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "ApiVersion": "v3.2-preview.1", + "Endpoint": "{Endpoint}", + "input": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "Microsoft was founded by Bill Gates and Paul Allen." + }, + { + "id": "2", + "language": "en", + "text": "Text Analytics is one of the Azure Cognitive Services." + }, + { + "id": "3", + "language": "en", + "text": "My cat might need to see a veterinarian." + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "documents": [ + { + "id": "1", + "keyPhrases": [ + "Bill Gates", + "Paul Allen", + "Microsoft" + ], + "warnings": [] + }, + { + "id": "2", + "keyPhrases": [ + "Azure Cognitive Services", + "Text Analytics" + ], + "warnings": [] + }, + { + "id": "3", + "keyPhrases": [ + "cat", + "veterinarian" + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2019-10-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulLanguagesRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulLanguagesRequest.json new file mode 100644 index 000000000000..813500e96b5f --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulLanguagesRequest.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "ApiVersion": "v3.2-preview.1", + "Endpoint": "{Endpoint}", + "input": { + "documents": [ + { + "id": "1", + "text": "Hello world" + }, + { + "id": "2", + "text": "Bonjour tout le monde" + }, + { + "id": "3", + "text": "Hola mundo" + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "documents": [ + { + "detectedLanguage": { + "confidenceScore": 1, + "iso6391Name": "en", + "name": "English" + }, + "id": "1", + "warnings": [] + }, + { + "detectedLanguage": { + "confidenceScore": 1, + "iso6391Name": "fr", + "name": "French" + }, + "id": "2", + "warnings": [] + }, + { + "detectedLanguage": { + "confidenceScore": 1, + "iso6391Name": "es", + "name": "Spanish" + }, + "id": "3", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2020-04-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulSentimentRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulSentimentRequest.json new file mode 100644 index 000000000000..92985e7f3e31 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.2-preview.1/examples/SuccessfulSentimentRequest.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "ApiVersion": "v3.2-preview.1", + "Endpoint": "{Endpoint}", + "input": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "Great atmosphere. Close to plenty of restaurants, hotels, and transit! Staff are friendly and helpful." + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "documents": [ + { + "confidenceScores": { + "negative": 0, + "neutral": 0, + "positive": 1 + }, + "id": "1", + "sentences": [ + { + "targets": [ + { + "confidenceScores": { + "negative": 0, + "positive": 1 + }, + "length": 10, + "offset": 6, + "relations": [ + { + "ref": "#/documents/0/sentences/0/assessments/0", + "relationType": "assessment" + } + ], + "sentiment": "positive", + "text": "atmosphere" + } + ], + "confidenceScores": { + "negative": 0, + "neutral": 0, + "positive": 1 + }, + "length": 17, + "offset": 0, + "assessments": [ + { + "confidenceScores": { + "negative": 0, + "positive": 1 + }, + "isNegated": false, + "length": 5, + "offset": 0, + "sentiment": "positive", + "text": "great" + } + ], + "sentiment": "positive", + "text": "Great atmosphere." + }, + { + "targets": [ + { + "confidenceScores": { + "negative": 0.01, + "positive": 0.99 + }, + "length": 11, + "offset": 37, + "relations": [ + { + "ref": "#/documents/0/sentences/1/assessments/0", + "relationType": "assessment" + } + ], + "sentiment": "positive", + "text": "restaurants" + }, + { + "confidenceScores": { + "negative": 0.01, + "positive": 0.99 + }, + "length": 6, + "offset": 50, + "relations": [ + { + "ref": "#/documents/0/sentences/1/assessments/0", + "relationType": "assessment" + } + ], + "sentiment": "positive", + "text": "hotels" + } + ], + "confidenceScores": { + "negative": 0.01, + "neutral": 0.86, + "positive": 0.13 + }, + "length": 52, + "offset": 18, + "assessments": [ + { + "confidenceScores": { + "negative": 0.01, + "positive": 0.99 + }, + "isNegated": false, + "length": 15, + "offset": 18, + "sentiment": "positive", + "text": "Close to plenty" + } + ], + "sentiment": "neutral", + "text": "Close to plenty of restaurants, hotels, and transit!" + } + ], + "sentiment": "positive", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2020-04-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/readme.md b/specification/cognitiveservices/data-plane/TextAnalytics/readme.md index 3565ecfa5880..28558b8301bd 100644 --- a/specification/cognitiveservices/data-plane/TextAnalytics/readme.md +++ b/specification/cognitiveservices/data-plane/TextAnalytics/readme.md @@ -116,6 +116,22 @@ These settings apply only when `--tag=release_3_1_preview.5` is specified on the input-file: preview/v3.1-preview.5/TextAnalytics.json ``` +### Release 3.1 + +These settings apply only when `--tag=release_3_1` is specified on the command line. + +``` yaml $(tag) == 'release_3_1' +input-file: stable/v3.1/TextAnalytics.json +``` + +### Release 3.2-preview.1 + +These settings apply only when `--tag=release_3_2_preview.1` is specified on the command line. + +``` yaml $(tag) == 'release_3_2_preview.1' +input-file: preview/v3.2-preview.1/TextAnalytics.json +``` + ## Swagger to SDK This section describes what SDK should be generated by the automatic system. diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/TextAnalytics.json b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/TextAnalytics.json new file mode 100644 index 000000000000..39d988388122 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/TextAnalytics.json @@ -0,0 +1,2966 @@ +{ + "swagger": "2.0", + "info": { + "version": "v3.1", + "contact": { + "name": "Microsoft Cognitive Services", + "url": "https://azure.microsoft.com/en-us/services/cognitive-services/text-analytics/", + "email": "mlapi@microsoft.com" + }, + "title": "Text Analytics Client", + "description": "The Text Analytics API is a suite of natural language processing (NLP) services built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction and language detection. Functionality for analysis of text specific to the healthcare domain and personal information are also available in the API. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview" + }, + "securityDefinitions": { + "apim_key": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "apim_key": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/text/analytics/{ApiVersion}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ] + }, + "paths": { + "/analyze": { + "post": { + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "description": "Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed.", + "operationId": "Analyze", + "summary": "Submit analysis job", + "parameters": [ + { + "description": "Collection of documents to analyze and tasks to execute.", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/AnalyzeBatchInput" + } + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", + "headers": { + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Submit analysis job request": { + "$ref": ".//examples//SuccessfulAnalyzeRequest.json" + } + }, + "deprecated": false, + "x-ms-long-running-operation": true + } + }, + "/analyze/jobs/{jobId}": { + "get": { + "produces": [ + "application/json", + "text/json" + ], + "description": "Get the status of an analysis job. A job may consist of one or more tasks. Once all tasks are completed, the job will transition to the completed state and results will be available for each task.", + "operationId": "AnalyzeStatus", + "summary": "Get analysis status and results", + "parameters": [ + { + "$ref": "#/parameters/AnalyzeJobId" + }, + { + "$ref": "#/parameters/ShowStats" + }, + { + "default": 20, + "description": "(Optional) Set the maximum number of results per task. When both $top and $skip are specified, $skip is applied first.", + "in": "query", + "maximum": 50, + "minimum": 1, + "name": "$top", + "type": "integer" + }, + { + "default": 0, + "description": "(Optional) Set the number of elements to offset in the response. When both $top and $skip are specified, $skip is applied first.", + "in": "query", + "minimum": 0, + "name": "$skip", + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Analysis job status and metadata.", + "schema": { + "$ref": "#/definitions/AnalyzeJobState" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Analysis job status request": { + "$ref": ".//examples//SuccessfulAnalyzeStatusRequest.json" + } + }, + "deprecated": false + } + }, + "/entities/health/jobs/{jobId}": { + "get": { + "produces": [ + "application/json", + "text/json" + ], + "description": "Get details of the healthcare prediction job specified by the jobId.", + "operationId": "HealthStatus", + "summary": "Get healthcare analysis job status and results", + "parameters": [ + { + "$ref": "#/parameters/JobId" + }, + { + "default": 20, + "description": "(Optional) Set the maximum number of results per task. When both $top and $skip are specified, $skip is applied first.", + "in": "query", + "maximum": 50, + "minimum": 1, + "name": "$top", + "type": "integer" + }, + { + "default": 0, + "description": "(Optional) Set the number of elements to offset in the response. When both $top and $skip are specified, $skip is applied first.", + "in": "query", + "minimum": 0, + "name": "$skip", + "type": "integer" + }, + { + "$ref": "#/parameters/ShowStats" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HealthcareJobState" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Health request": { + "$ref": ".//examples//SuccessfulHealthStatusRequest.json" + } + }, + "deprecated": false + }, + "delete": { + "produces": [ + "application/json", + "text/json" + ], + "description": "Cancel healthcare prediction job.", + "operationId": "CancelHealthJob", + "summary": "Cancel healthcare prediction job", + "parameters": [ + { + "$ref": "#/parameters/JobId" + } + ], + "responses": { + "202": { + "description": "Cancel Job request has been received.", + "headers": { + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Health request": { + "$ref": ".//examples//SuccessfulHealthDeleteRequest.json" + } + }, + "deprecated": false, + "x-ms-long-running-operation": true + } + }, + "/entities/health/jobs": { + "post": { + "summary": "Submit healthcare analysis job", + "description": "Start a healthcare analysis job to recognize healthcare related entities (drugs, conditions, symptoms, etc) and their relations.", + "operationId": "Health", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ModelVersion" + }, + { + "$ref": "#/parameters/StringIndexType" + }, + { + "$ref": "#/parameters/MultiLanguageInput" + }, + { + "$ref": "#/parameters/LoggingOptOut" + } + ], + "responses": { + "202": { + "description": "Accepted - call results in a link where the status of the submitted job can be checked via the GET operation.", + "headers": { + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Health request": { + "$ref": ".//examples//SuccessfulHealthRequest.json" + } + }, + "deprecated": false, + "x-ms-long-running-operation": true + } + }, + "/entities/recognition/general": { + "post": { + "summary": "Named Entity Recognition", + "description": "The API returns a list of general named entities in a given document. For the list of supported entity types, check Supported Entity Types in Text Analytics API. See the Supported languages in Text Analytics API for the list of enabled languages.", + "operationId": "EntitiesRecognitionGeneral", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ModelVersion" + }, + { + "$ref": "#/parameters/ShowStats" + }, + { + "$ref": "#/parameters/LoggingOptOut" + }, + { + "$ref": "#/parameters/StringIndexType" + }, + { + "$ref": "#/parameters/MultiLanguageInput" + } + ], + "responses": { + "200": { + "description": "A successful call results in a list of recognized entities returned for each valid document.", + "schema": { + "$ref": "#/definitions/EntitiesResult" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Entities request": { + "$ref": ".//examples//SuccessfulEntitiesRequest.json" + } + }, + "deprecated": false + } + }, + "/entities/recognition/pii": { + "post": { + "summary": "Entities containing personal information", + "description": "The API returns a list of entities with personal information (\\\"SSN\\\", \\\"Bank Account\\\" etc) in the document. For the list of supported entity types, check Supported Entity Types in Text Analytics API. See the Supported languages in Text Analytics API for the list of enabled languages.\n", + "operationId": "EntitiesRecognitionPii", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ModelVersion" + }, + { + "$ref": "#/parameters/ShowStats" + }, + { + "$ref": "#/parameters/LoggingOptOut" + }, + { + "name": "domain", + "in": "query", + "description": "(Optional) if specified, will set the PII domain to include only a subset of the entity categories. Possible values include: 'PHI', 'none'.", + "type": "string" + }, + { + "$ref": "#/parameters/StringIndexType" + }, + { + "$ref": "#/parameters/PiiCategories" + }, + { + "$ref": "#/parameters/MultiLanguageInput" + } + ], + "responses": { + "200": { + "description": "A successful call results in a list of entities containing personal information returned for each valid document", + "schema": { + "$ref": "#/definitions/PiiResult" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Entity PII request": { + "$ref": ".//examples//SuccessfulEntityPIIRequest.json" + } + }, + "deprecated": false + } + }, + "/entities/linking": { + "post": { + "summary": "Linked entities from a well known knowledge base", + "description": "The API returns a list of recognized entities with links to a well known knowledge base. See the Supported languages in Text Analytics API for the list of enabled languages.", + "operationId": "EntitiesLinking", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ModelVersion" + }, + { + "$ref": "#/parameters/ShowStats" + }, + { + "$ref": "#/parameters/LoggingOptOut" + }, + { + "$ref": "#/parameters/StringIndexType" + }, + { + "$ref": "#/parameters/MultiLanguageInput" + } + ], + "responses": { + "200": { + "description": "A successful call results in a list of recognized entities with links to a well known knowledge base returned for each valid document", + "schema": { + "$ref": "#/definitions/EntityLinkingResult" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Entity Linking request": { + "$ref": ".//examples//SuccessfulEntityLinkingRequest.json" + } + }, + "deprecated": false + } + }, + "/keyPhrases": { + "post": { + "summary": "Key Phrases", + "description": "The API returns a list of strings denoting the key phrases in the input text. See the Supported languages in Text Analytics API for the list of enabled languages.", + "operationId": "KeyPhrases", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ModelVersion" + }, + { + "$ref": "#/parameters/ShowStats" + }, + { + "$ref": "#/parameters/LoggingOptOut" + }, + { + "$ref": "#/parameters/MultiLanguageInput" + } + ], + "responses": { + "200": { + "description": "A successful response results in 0 or more key phrases identified in each valid document", + "schema": { + "$ref": "#/definitions/KeyPhraseResult" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Key Phrase request": { + "$ref": ".//examples//SuccessfulKeyPhrasesRequest.json" + } + }, + "deprecated": false + } + }, + "/languages": { + "post": { + "summary": "Detect Language", + "description": "The API returns the detected language and a numeric score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true. See the Supported languages in Text Analytics API for the list of enabled languages.", + "operationId": "Languages", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ModelVersion" + }, + { + "$ref": "#/parameters/ShowStats" + }, + { + "$ref": "#/parameters/LoggingOptOut" + }, + { + "$ref": "#/parameters/LanguageInput" + } + ], + "responses": { + "200": { + "description": "A successful call results in the detected language with the highest probability for each valid document", + "schema": { + "$ref": "#/definitions/LanguageResult" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Detect Language request": { + "$ref": ".//examples//SuccessfulLanguagesRequest.json" + } + }, + "deprecated": false + } + }, + "/sentiment": { + "post": { + "summary": "Sentiment", + "description": "The API returns a detailed sentiment analysis for the input text. The analysis is done in multiple levels of granularity, start from the a document level, down to sentence and key terms (targets and assessments).", + "operationId": "Sentiment", + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ModelVersion" + }, + { + "$ref": "#/parameters/ShowStats" + }, + { + "$ref": "#/parameters/LoggingOptOut" + }, + { + "name": "opinionMining", + "in": "query", + "description": "(Optional) if set to true, response will contain not only sentiment prediction but also opinion mining (aspect-based sentiment analysis) results.", + "type": "boolean" + }, + { + "$ref": "#/parameters/StringIndexType" + }, + { + "$ref": "#/parameters/MultiLanguageInput" + } + ], + "responses": { + "200": { + "description": "A successful call results in a document sentiment prediction, as well as sentiment scores for each sentiment class (Positive, Negative, and Neutral)", + "schema": { + "$ref": "#/definitions/SentimentResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Sentiment request": { + "$ref": ".//examples//SuccessfulSentimentRequest.json" + } + }, + "deprecated": false + } + } + }, + "definitions": { + "JobManifest": { + "properties": { + "tasks": { + "description": "The set of tasks to execute on the input documents. Cannot specify the same task more than once.", + "properties": { + "entityRecognitionTasks": { + "type": "array", + "items": { + "$ref": "#/definitions/EntitiesTask" + } + }, + "entityRecognitionPiiTasks": { + "type": "array", + "items": { + "$ref": "#/definitions/PiiTask" + } + }, + "keyPhraseExtractionTasks": { + "type": "array", + "items": { + "$ref": "#/definitions/KeyPhrasesTask" + } + }, + "entityLinkingTasks": { + "type": "array", + "items": { + "$ref": "#/definitions/EntityLinkingTask" + } + }, + "sentimentAnalysisTasks": { + "type": "array", + "items": { + "$ref": "#/definitions/SentimentAnalysisTask" + } + } + }, + "type": "object" + } + }, + "required": [ + "tasks" + ], + "type": "object" + }, + "MultiLanguageBatchInput": { + "type": "object", + "required": [ + "documents" + ], + "properties": { + "documents": { + "type": "array", + "description": "The set of documents to process as part of this batch.", + "items": { + "$ref": "#/definitions/MultiLanguageInput" + } + } + }, + "description": "Contains a set of input documents to be analyzed by the service." + }, + "MultiLanguageInput": { + "type": "object", + "required": [ + "id", + "text" + ], + "properties": { + "id": { + "type": "string", + "description": "A unique, non-empty document identifier." + }, + "text": { + "type": "string", + "description": "The input text to process." + }, + "language": { + "type": "string", + "description": "(Optional) This is the 2 letter ISO 639-1 representation of a language. For example, use \"en\" for English; \"es\" for Spanish etc. If not set, use \"en\" for English as default." + } + }, + "description": "Contains an input document to be analyzed by the service." + }, + "DocumentError": { + "type": "object", + "required": [ + "id", + "error" + ], + "properties": { + "id": { + "type": "string", + "description": "Document Id." + }, + "error": { + "type": "object", + "description": "Document Error.", + "$ref": "#/definitions/TextAnalyticsError" + } + } + }, + "ErrorResponse": { + "type": "object", + "required": [ + "error" + ], + "properties": { + "error": { + "type": "object", + "description": "Document Error.", + "$ref": "#/definitions/TextAnalyticsError" + } + } + }, + "TextAnalyticsError": { + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "InvalidRequest", + "InvalidArgument", + "InternalServerError", + "ServiceUnavailable", + "NotFound" + ], + "x-ms-enum": { + "name": "ErrorCodeValue", + "modelAsString": true + }, + "description": "Error code." + }, + "message": { + "type": "string", + "description": "Error message." + }, + "target": { + "type": "string", + "description": "Error target." + }, + "innererror": { + "$ref": "#/definitions/InnerError", + "description": "Inner error contains more specific information." + }, + "details": { + "type": "array", + "description": "Details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/TextAnalyticsError" + } + } + } + }, + "TextAnalyticsWarning": { + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "LongWordsInDocument", + "DocumentTruncated" + ], + "x-ms-enum": { + "name": "WarningCodeValue", + "modelAsString": true + }, + "description": "Error code." + }, + "message": { + "type": "string", + "description": "Warning message." + }, + "targetRef": { + "type": "string", + "description": "A JSON pointer reference indicating the target object." + } + } + }, + "PiiTask": { + "properties": { + "parameters": { + "properties": { + "domain": { + "default": "none", + "enum": [ + "phi", + "none" + ], + "type": "string" + }, + "model-version": { + "default": "latest", + "type": "string" + }, + "loggingOptOut": { + "default": true, + "type": "boolean" + }, + "piiCategories": { + "$ref": "#/definitions/PiiCategories" + }, + "stringIndexType": { + "$ref": "#/definitions/StringIndexType" + } + }, + "type": "object" + }, + "taskName": { + "type": "string" + } + }, + "type": "object" + }, + "EntitiesTask": { + "properties": { + "parameters": { + "properties": { + "model-version": { + "default": "latest", + "type": "string" + }, + "loggingOptOut": { + "default": false, + "type": "boolean" + }, + "stringIndexType": { + "$ref": "#/definitions/StringIndexType" + } + }, + "type": "object" + }, + "taskName": { + "type": "string" + } + }, + "type": "object" + }, + "SentimentAnalysisTask": { + "properties": { + "parameters": { + "properties": { + "model-version": { + "default": "latest", + "type": "string" + }, + "loggingOptOut": { + "default": false, + "type": "boolean" + }, + "opinionMining": { + "default": false, + "type": "boolean" + }, + "stringIndexType": { + "$ref": "#/definitions/StringIndexType" + } + }, + "type": "object" + }, + "taskName": { + "type": "string" + } + }, + "type": "object" + }, + "InnerError": { + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "InvalidParameterValue", + "InvalidRequestBodyFormat", + "EmptyRequest", + "MissingInputRecords", + "InvalidDocument", + "ModelVersionIncorrect", + "InvalidDocumentBatch", + "UnsupportedLanguageCode", + "InvalidCountryHint" + ], + "x-ms-enum": { + "name": "InnerErrorCodeValue", + "modelAsString": true + }, + "description": "Error code." + }, + "message": { + "type": "string", + "description": "Error message." + }, + "details": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Error details." + }, + "target": { + "type": "string", + "description": "Error target." + }, + "innererror": { + "$ref": "#/definitions/InnerError", + "description": "Inner error contains more specific information." + } + } + }, + "AnalyzeBatchInput": { + "allOf": [ + { + "$ref": "#/definitions/JobDescriptor" + }, + { + "$ref": "#/definitions/AnalysisInput" + }, + { + "$ref": "#/definitions/JobManifest" + } + ] + }, + "AnalyzeJobState": { + "allOf": [ + { + "$ref": "#/definitions/AnalyzeJobMetadata" + }, + { + "$ref": "#/definitions/TasksState" + }, + { + "$ref": "#/definitions/AnalyzeJobErrorsAndStatistics" + }, + { + "$ref": "#/definitions/Pagination" + } + ] + }, + "SentimentResponse": { + "type": "object", + "required": [ + "documents", + "errors", + "modelVersion" + ], + "properties": { + "documents": { + "type": "array", + "description": "Sentiment analysis per document.", + "items": { + "$ref": "#/definitions/DocumentSentiment" + } + }, + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics" + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + } + } + }, + "TaskState": { + "properties": { + "lastUpdateDateTime": { + "format": "date-time", + "type": "string" + }, + "taskName": { + "type": "string" + }, + "status": { + "enum": [ + "notStarted", + "running", + "succeeded", + "failed", + "rejected", + "cancelled", + "cancelling" + ], + "x-ms-enum": { + "modelAsString": false, + "name": "State" + } + } + }, + "required": [ + "status", + "lastUpdateDateTime", + "taskName" + ], + "type": "object" + }, + "TasksState": { + "properties": { + "tasks": { + "properties": { + "completed": { + "type": "integer" + }, + "failed": { + "type": "integer" + }, + "inProgress": { + "type": "integer" + }, + "total": { + "type": "integer" + }, + "entityRecognitionTasks": { + "type": "array", + "items": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskState" + }, + { + "$ref": "#/definitions/EntitiesTaskResult" + } + ] + } + }, + "entityRecognitionPiiTasks": { + "type": "array", + "items": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskState" + }, + { + "$ref": "#/definitions/PiiTaskResult" + } + ] + } + }, + "keyPhraseExtractionTasks": { + "type": "array", + "items": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskState" + }, + { + "$ref": "#/definitions/KeyPhraseTaskResult" + } + ] + } + }, + "entityLinkingTasks": { + "type": "array", + "items": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskState" + }, + { + "$ref": "#/definitions/EntityLinkingTaskResult" + } + ] + } + }, + "sentimentAnalysisTasks": { + "type": "array", + "items": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskState" + }, + { + "$ref": "#/definitions/SentimentTaskResult" + } + ] + } + } + }, + "required": [ + "total", + "completed", + "failed", + "inProgress" + ], + "type": "object" + } + }, + "required": [ + "tasks" + ], + "type": "object" + }, + "DocumentSentiment": { + "type": "object", + "required": [ + "id", + "sentiment", + "confidenceScores", + "sentences", + "warnings" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "sentiment": { + "type": "string", + "description": "Predicted sentiment for document (Negative, Neutral, Positive, or Mixed).", + "enum": [ + "positive", + "neutral", + "negative", + "mixed" + ], + "x-ms-enum": { + "name": "DocumentSentimentValue", + "modelAsString": false + } + }, + "statistics": { + "$ref": "#/definitions/DocumentStatistics" + }, + "confidenceScores": { + "description": "Document level sentiment confidence scores between 0 and 1 for each sentiment class.", + "$ref": "#/definitions/SentimentConfidenceScorePerLabel" + }, + "sentences": { + "type": "array", + "description": "Sentence level sentiment analysis.", + "items": { + "$ref": "#/definitions/SentenceSentiment" + } + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/TextAnalyticsWarning" + } + } + } + }, + "RequestStatistics": { + "type": "object", + "required": [ + "documentsCount", + "validDocumentsCount", + "erroneousDocumentsCount", + "transactionsCount" + ], + "properties": { + "documentsCount": { + "type": "integer", + "format": "int32", + "description": "Number of documents submitted in the request." + }, + "validDocumentsCount": { + "type": "integer", + "format": "int32", + "description": "Number of valid documents. This excludes empty, over-size limit or non-supported languages documents." + }, + "erroneousDocumentsCount": { + "type": "integer", + "format": "int32", + "description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents." + }, + "transactionsCount": { + "type": "integer", + "format": "int64", + "description": "Number of transactions for the request." + } + }, + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "DocumentStatistics": { + "type": "object", + "required": [ + "charactersCount", + "transactionsCount" + ], + "properties": { + "charactersCount": { + "type": "integer", + "format": "int32", + "description": "Number of text elements recognized in the document." + }, + "transactionsCount": { + "type": "integer", + "format": "int32", + "description": "Number of transactions for the document." + } + }, + "description": "if showStats=true was specified in the request this field will contain information about the document payload." + }, + "SentimentConfidenceScorePerLabel": { + "type": "object", + "required": [ + "positive", + "neutral", + "negative" + ], + "properties": { + "positive": { + "type": "number", + "format": "double" + }, + "neutral": { + "type": "number", + "format": "double" + }, + "negative": { + "type": "number", + "format": "double" + } + }, + "description": "Represents the confidence scores between 0 and 1 across all sentiment classes: positive, neutral, negative." + }, + "SentenceSentiment": { + "type": "object", + "required": [ + "text", + "sentiment", + "confidenceScores", + "offset", + "length" + ], + "properties": { + "text": { + "type": "string", + "description": "The sentence text." + }, + "sentiment": { + "type": "string", + "description": "The predicted Sentiment for the sentence.", + "enum": [ + "positive", + "neutral", + "negative" + ], + "x-ms-enum": { + "name": "SentenceSentimentValue", + "modelAsString": false + } + }, + "confidenceScores": { + "description": "The sentiment confidence score between 0 and 1 for the sentence for all classes.", + "$ref": "#/definitions/SentimentConfidenceScorePerLabel" + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The sentence offset from the start of the document." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the sentence." + }, + "targets": { + "type": "array", + "description": "The array of sentence targets for the sentence.", + "items": { + "$ref": "#/definitions/SentenceTarget" + } + }, + "assessments": { + "type": "array", + "description": "The array of assessments for the sentence.", + "items": { + "$ref": "#/definitions/SentenceAssessment" + } + } + } + }, + "SentenceTarget": { + "type": "object", + "required": [ + "confidenceScores", + "length", + "offset", + "relations", + "sentiment", + "text" + ], + "properties": { + "sentiment": { + "type": "string", + "enum": [ + "positive", + "mixed", + "negative" + ], + "x-ms-enum": { + "name": "TokenSentimentValue", + "modelAsString": false + }, + "description": "Targeted sentiment in the sentence." + }, + "confidenceScores": { + "description": "Target sentiment confidence scores for the target in the sentence.", + "$ref": "#/definitions/TargetConfidenceScoreLabel" + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The target offset from the start of the sentence." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the target." + }, + "text": { + "type": "string", + "description": "The target text detected." + }, + "relations": { + "type": "array", + "description": "The array of either assessment or target objects which is related to the target.", + "items": { + "$ref": "#/definitions/TargetRelation" + } + } + } + }, + "SentenceAssessment": { + "type": "object", + "required": [ + "confidenceScores", + "isNegated", + "length", + "offset", + "sentiment", + "text" + ], + "properties": { + "sentiment": { + "type": "string", + "enum": [ + "positive", + "mixed", + "negative" + ], + "x-ms-enum": { + "name": "TokenSentimentValue", + "modelAsString": false + }, + "description": "Assessment sentiment in the sentence." + }, + "confidenceScores": { + "description": "Assessment sentiment confidence scores in the sentence.", + "$ref": "#/definitions/TargetConfidenceScoreLabel" + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The assessment offset from the start of the sentence." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the assessment." + }, + "text": { + "type": "string", + "description": "The assessment text detected." + }, + "isNegated": { + "type": "boolean", + "description": "The indicator representing if the assessment is negated." + } + } + }, + "TargetRelation": { + "type": "object", + "required": [ + "ref", + "relationType" + ], + "properties": { + "relationType": { + "type": "string", + "enum": [ + "assessment", + "target" + ], + "x-ms-enum": { + "name": "TargetRelationType", + "modelAsString": false + }, + "description": "The type related to the target." + }, + "ref": { + "type": "string", + "description": "The JSON pointer indicating the linked object." + } + } + }, + "TargetConfidenceScoreLabel": { + "type": "object", + "required": [ + "negative", + "positive" + ], + "properties": { + "positive": { + "type": "number", + "format": "double" + }, + "negative": { + "type": "number", + "format": "double" + } + }, + "description": "Represents the confidence scores across all sentiment classes: positive, neutral, negative." + }, + "EntitiesResult": { + "type": "object", + "required": [ + "documents", + "errors", + "modelVersion" + ], + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/DocumentEntities" + } + }, + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics" + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + } + } + }, + "DocumentEntities": { + "type": "object", + "required": [ + "id", + "entities", + "warnings" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "entities": { + "type": "array", + "description": "Recognized entities in the document.", + "items": { + "$ref": "#/definitions/Entity" + } + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/TextAnalyticsWarning" + } + }, + "statistics": { + "description": "if showStats=true was specified in the request this field will contain information about the document payload.", + "$ref": "#/definitions/DocumentStatistics" + } + } + }, + "PiiDocumentEntities": { + "type": "object", + "required": [ + "id", + "redactedText", + "entities", + "warnings" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "redactedText": { + "type": "string", + "description": "Returns redacted text." + }, + "entities": { + "type": "array", + "description": "Recognized entities in the document.", + "items": { + "$ref": "#/definitions/Entity" + } + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/TextAnalyticsWarning" + } + }, + "statistics": { + "description": "if showStats=true was specified in the request this field will contain information about the document payload.", + "$ref": "#/definitions/DocumentStatistics" + } + } + }, + "Entity": { + "type": "object", + "required": [ + "text", + "category", + "offset", + "length", + "confidenceScore" + ], + "properties": { + "text": { + "type": "string", + "description": "Entity text as appears in the request." + }, + "category": { + "type": "string", + "description": "Entity type." + }, + "subcategory": { + "type": "string", + "description": "(Optional) Entity sub type." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Confidence score between 0 and 1 of the extracted entity." + } + } + }, + "EntityLinkingResult": { + "type": "object", + "required": [ + "documents", + "errors", + "modelVersion" + ], + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/DocumentLinkedEntities" + } + }, + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics" + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + } + } + }, + "DocumentLinkedEntities": { + "type": "object", + "required": [ + "id", + "entities", + "warnings" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "entities": { + "type": "array", + "description": "Recognized well known entities in the document.", + "items": { + "$ref": "#/definitions/LinkedEntity" + } + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/TextAnalyticsWarning" + } + }, + "statistics": { + "description": "if showStats=true was specified in the request this field will contain information about the document payload.", + "$ref": "#/definitions/DocumentStatistics" + } + } + }, + "HealthcareJobState": { + "allOf": [ + { + "$ref": "#/definitions/JobMetadata" + }, + { + "$ref": "#/definitions/HealthcareTaskResult" + }, + { + "$ref": "#/definitions/Pagination" + } + ] + }, + "HealthcareResult": { + "type": "object", + "required": [ + "documents", + "errors", + "modelVersion" + ], + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/DocumentHealthcareEntities" + } + }, + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics" + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + } + } + }, + "DocumentHealthcareEntities": { + "type": "object", + "required": [ + "id", + "entities", + "relations", + "warnings" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "entities": { + "description": "Healthcare entities.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthcareEntity" + } + }, + "relations": { + "type": "array", + "description": "Healthcare entity relations.", + "items": { + "$ref": "#/definitions/HealthcareRelation" + } + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/TextAnalyticsWarning" + } + }, + "statistics": { + "description": "if showStats=true was specified in the request this field will contain information about the document payload.", + "$ref": "#/definitions/DocumentStatistics" + } + } + }, + "HealthcareEntity": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HealthcareEntityProperties" + }, + { + "$ref": "#/definitions/HealthcareLinkingProperties" + } + ] + }, + "HealthcareRelation": { + "type": "object", + "description": "Every relation is an entity graph of a certain relationType, where all entities are connected and have specific roles within the relation context.", + "required": [ + "relationType", + "entities" + ], + "properties": { + "relationType": { + "description": "Type of relation. Examples include: `DosageOfMedication` or 'FrequencyOfMedication', etc.", + "type": "string", + "enum": [ + "Abbreviation", + "DirectionOfBodyStructure", + "DirectionOfCondition", + "DirectionOfExamination", + "DirectionOfTreatment", + "DosageOfMedication", + "FormOfMedication", + "FrequencyOfMedication", + "FrequencyOfTreatment", + "QualifierOfCondition", + "RelationOfExamination", + "RouteOfMedication", + "TimeOfCondition", + "TimeOfEvent", + "TimeOfExamination", + "TimeOfMedication", + "TimeOfTreatment", + "UnitOfCondition", + "UnitOfExamination", + "ValueOfCondition", + "ValueOfExamination" + ], + "x-ms-enum": { + "name": "relationType", + "modelAsString": true + } + }, + "entities": { + "description": "The entities in the relation.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthcareRelationEntity" + } + } + } + }, + "HealthcareAssertion": { + "type": "object", + "properties": { + "conditionality": { + "description": "Describes any conditionality on the entity.", + "type": "string", + "enum": [ + "hypothetical", + "conditional" + ], + "x-ms-enum": { + "name": "Conditionality", + "modelAsString": false + } + }, + "certainty": { + "description": "Describes the entities certainty and polarity.", + "type": "string", + "enum": [ + "positive", + "positivePossible", + "neutralPossible", + "negativePossible", + "negative" + ], + "x-ms-enum": { + "name": "Certainty", + "modelAsString": false + } + }, + "association": { + "description": "Describes if the entity is the subject of the text or if it describes someone else.", + "type": "string", + "enum": [ + "subject", + "other" + ], + "x-ms-enum": { + "name": "Association", + "modelAsString": false + } + } + } + }, + "HealthcareRelationEntity": { + "type": "object", + "required": [ + "ref", + "role" + ], + "properties": { + "ref": { + "description": "Reference link object, using a JSON pointer RFC 6901 (URI Fragment Identifier Representation), pointing to the entity .", + "type": "string" + }, + "role": { + "description": "Role of entity in the relationship. For example: 'CD20-positive diffuse large B-cell lymphoma' has the following entities with their roles in parenthesis: CD20 (GeneOrProtein), Positive (Expression), diffuse large B-cell lymphoma (Diagnosis).", + "type": "string" + } + } + }, + "HealthcareEntityLink": { + "type": "object", + "required": [ + "dataSource", + "id" + ], + "properties": { + "dataSource": { + "description": "Entity Catalog. Examples include: UMLS, CHV, MSH, etc.", + "type": "string" + }, + "id": { + "description": "Entity id in the given source catalog.", + "type": "string" + } + } + }, + "HealthcareEntityProperties": { + "type": "object", + "required": [ + "text", + "category", + "offset", + "length", + "confidenceScore" + ], + "properties": { + "text": { + "type": "string", + "description": "Entity text as appears in the request." + }, + "category": { + "x-ms-enum": { + "name": "healthcareEntityCategory", + "modelAsString": true + }, + "type": "string", + "description": "Healthcare Entity Category.", + "enum": [ + "BODY_STRUCTURE", + "AGE", + "GENDER", + "EXAMINATION_NAME", + "DATE", + "DIRECTION", + "FREQUENCY", + "MEASUREMENT_VALUE", + "MEASUREMENT_UNIT", + "RELATIONAL_OPERATOR", + "TIME", + "GENE_OR_PROTEIN", + "VARIANT", + "ADMINISTRATIVE_EVENT", + "CARE_ENVIRONMENT", + "HEALTHCARE_PROFESSION", + "DIAGNOSIS", + "SYMPTOM_OR_SIGN", + "CONDITION_QUALIFIER", + "MEDICATION_CLASS", + "MEDICATION_NAME", + "DOSAGE", + "MEDICATION_FORM", + "MEDICATION_ROUTE", + "FAMILY_RELATION", + "TREATMENT_NAME" + ] + }, + "subcategory": { + "type": "string", + "description": "(Optional) Entity sub type." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Confidence score between 0 and 1 of the extracted entity." + } + } + }, + "HealthcareLinkingProperties": { + "properties": { + "assertion": { + "type": "object", + "$ref": "#/definitions/HealthcareAssertion" + }, + "name": { + "description": "Preferred name for the entity. Example: 'histologically' would have a 'name' of 'histologic'.", + "type": "string" + }, + "links": { + "description": "Entity references in known data sources.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthcareEntityLink" + } + } + } + }, + "LinkedEntity": { + "type": "object", + "required": [ + "name", + "matches", + "language", + "url", + "dataSource" + ], + "properties": { + "name": { + "type": "string", + "description": "Entity Linking formal name." + }, + "matches": { + "type": "array", + "description": "List of instances this entity appears in the text.", + "items": { + "$ref": "#/definitions/Match" + } + }, + "language": { + "type": "string", + "description": "Language used in the data source." + }, + "id": { + "type": "string", + "description": "Unique identifier of the recognized entity from the data source." + }, + "url": { + "type": "string", + "description": "URL for the entity's page from the data source." + }, + "dataSource": { + "type": "string", + "description": "Data source used to extract entity linking, such as Wiki/Bing etc." + }, + "bingId": { + "type": "string", + "description": "Bing Entity Search API unique identifier of the recognized entity." + } + } + }, + "Match": { + "type": "object", + "required": [ + "confidenceScore", + "text", + "offset", + "length" + ], + "properties": { + "confidenceScore": { + "type": "number", + "format": "double", + "description": "If a well known item is recognized, a decimal number denoting the confidence level between 0 and 1 will be returned." + }, + "text": { + "type": "string", + "description": "Entity text as appears in the request." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the entity match text." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Length for the entity match text." + } + } + }, + "AnalysisInput": { + "type": "object", + "required": [ + "analysisInput" + ], + "properties": { + "analysisInput": { + "$ref": "#/definitions/MultiLanguageBatchInput" + } + } + }, + "EntitiesTaskResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/EntitiesResult" + } + } + }, + "PiiTaskResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/PiiResult" + } + } + }, + "KeyPhraseTaskResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/KeyPhraseResult" + } + } + }, + "EntityLinkingTaskResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/EntityLinkingResult" + } + } + }, + "SentimentTaskResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/SentimentResponse" + } + } + }, + "HealthcareTaskResult": { + "properties": { + "results": { + "$ref": "#/definitions/HealthcareResult" + }, + "errors": { + "items": { + "$ref": "#/definitions/TextAnalyticsError" + }, + "type": "array" + } + }, + "type": "object" + }, + "JobDescriptor": { + "properties": { + "displayName": { + "description": "Optional display name for the analysis job.", + "type": "string" + } + }, + "type": "object" + }, + "JobMetadata": { + "properties": { + "createdDateTime": { + "format": "date-time", + "type": "string" + }, + "expirationDateTime": { + "format": "date-time", + "type": "string" + }, + "jobId": { + "format": "uuid", + "type": "string" + }, + "lastUpdateDateTime": { + "format": "date-time", + "type": "string" + }, + "status": { + "enum": [ + "notStarted", + "running", + "succeeded", + "failed", + "cancelled", + "cancelling" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": false, + "name": "State" + } + } + }, + "required": [ + "jobId", + "lastUpdateDateTime", + "createdDateTime", + "status" + ], + "type": "object" + }, + "AnalyzeJobDisplayName": { + "properties": { + "displayName": { + "type": "string" + } + } + }, + "AnalyzeJobMetadata": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobMetadata" + }, + { + "$ref": "#/definitions/AnalyzeJobDisplayName" + } + ] + }, + "AnalyzeJobErrorsAndStatistics": { + "properties": { + "errors": { + "items": { + "$ref": "#/definitions/TextAnalyticsError" + }, + "type": "array" + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics" + } + }, + "type": "object" + }, + "KeyPhraseResult": { + "type": "object", + "required": [ + "documents", + "errors", + "modelVersion" + ], + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/DocumentKeyPhrases" + } + }, + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics" + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + } + } + }, + "DocumentKeyPhrases": { + "type": "object", + "required": [ + "id", + "keyPhrases", + "warnings" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "keyPhrases": { + "type": "array", + "description": "A list of representative words or phrases. The number of key phrases returned is proportional to the number of words in the input document.", + "items": { + "type": "string" + } + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/TextAnalyticsWarning" + } + }, + "statistics": { + "description": "if showStats=true was specified in the request this field will contain information about the document payload.", + "$ref": "#/definitions/DocumentStatistics" + } + } + }, + "KeyPhrasesTask": { + "properties": { + "parameters": { + "properties": { + "model-version": { + "default": "latest", + "type": "string" + }, + "loggingOptOut": { + "default": false, + "type": "boolean" + } + }, + "type": "object" + }, + "taskName": { + "type": "string" + } + }, + "type": "object" + }, + "EntityLinkingTask": { + "properties": { + "parameters": { + "properties": { + "model-version": { + "default": "latest", + "type": "string" + }, + "loggingOptOut": { + "default": false, + "type": "boolean" + }, + "stringIndexType": { + "$ref": "#/definitions/StringIndexType" + } + }, + "type": "object" + }, + "taskName": { + "type": "string" + } + }, + "type": "object" + }, + "LanguageBatchInput": { + "type": "object", + "required": [ + "documents" + ], + "properties": { + "documents": { + "type": "array", + "items": { + "$ref": "#/definitions/LanguageInput" + } + } + } + }, + "LanguageInput": { + "type": "object", + "required": [ + "id", + "text" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "text": { + "type": "string" + }, + "countryHint": { + "type": "string" + } + } + }, + "Pagination": { + "properties": { + "@nextLink": { + "type": "string" + } + }, + "type": "object" + }, + "PiiResult": { + "type": "object", + "required": [ + "documents", + "errors", + "modelVersion" + ], + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/PiiDocumentEntities" + } + }, + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics" + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + } + } + }, + "LanguageResult": { + "type": "object", + "required": [ + "documents", + "errors", + "modelVersion" + ], + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/DocumentLanguage" + } + }, + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics" + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + } + } + }, + "DocumentLanguage": { + "type": "object", + "required": [ + "id", + "detectedLanguage", + "warnings" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "detectedLanguage": { + "description": "Detected Language.", + "$ref": "#/definitions/DetectedLanguage" + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/TextAnalyticsWarning" + } + }, + "statistics": { + "description": "if showStats=true was specified in the request this field will contain information about the document payload.", + "$ref": "#/definitions/DocumentStatistics" + } + } + }, + "DetectedLanguage": { + "type": "object", + "required": [ + "name", + "iso6391Name", + "confidenceScore" + ], + "properties": { + "name": { + "type": "string", + "description": "Long name of a detected language (e.g. English, French)." + }, + "iso6391Name": { + "type": "string", + "description": "A two letter representation of the detected language according to the ISO 639-1 standard (e.g. en, fr)." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "A confidence score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true." + } + } + }, + "StringIndexType": { + "default": "TextElement_v8", + "enum": [ + "TextElement_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "value": "TextElement_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + }, + "type": "string" + }, + "PiiCategories": { + "description": "(Optional) describes the PII categories to return", + "items": { + "type": "string", + "x-ms-enum": { + "name": "PiiCategory", + "modelAsString": true + }, + "enum": [ + "ABARoutingNumber", + "ARNationalIdentityNumber", + "AUBankAccountNumber", + "AUDriversLicenseNumber", + "AUMedicalAccountNumber", + "AUPassportNumber", + "AUTaxFileNumber", + "AUBusinessNumber", + "AUCompanyNumber", + "ATIdentityCard", + "ATTaxIdentificationNumber", + "ATValueAddedTaxNumber", + "AzureDocumentDBAuthKey", + "AzureIAASDatabaseConnectionAndSQLString", + "AzureIoTConnectionString", + "AzurePublishSettingPassword", + "AzureRedisCacheString", + "AzureSAS", + "AzureServiceBusString", + "AzureStorageAccountKey", + "AzureStorageAccountGeneric", + "BENationalNumber", + "BENationalNumberV2", + "BEValueAddedTaxNumber", + "BRCPFNumber", + "BRLegalEntityNumber", + "BRNationalIDRG", + "BGUniformCivilNumber", + "CABankAccountNumber", + "CADriversLicenseNumber", + "CAHealthServiceNumber", + "CAPassportNumber", + "CAPersonalHealthIdentification", + "CASocialInsuranceNumber", + "CLIdentityCardNumber", + "CNResidentIdentityCardNumber", + "CreditCardNumber", + "HRIdentityCardNumber", + "HRNationalIDNumber", + "HRPersonalIdentificationNumber", + "HRPersonalIdentificationOIBNumberV2", + "CYIdentityCard", + "CYTaxIdentificationNumber", + "CZPersonalIdentityNumber", + "CZPersonalIdentityV2", + "DKPersonalIdentificationNumber", + "DKPersonalIdentificationV2", + "DrugEnforcementAgencyNumber", + "EEPersonalIdentificationCode", + "EUDebitCardNumber", + "EUDriversLicenseNumber", + "EUGPSCoordinates", + "EUNationalIdentificationNumber", + "EUPassportNumber", + "EUSocialSecurityNumber", + "EUTaxIdentificationNumber", + "FIEuropeanHealthNumber", + "FINationalID", + "FINationalIDV2", + "FIPassportNumber", + "FRDriversLicenseNumber", + "FRHealthInsuranceNumber", + "FRNationalID", + "FRPassportNumber", + "FRSocialSecurityNumber", + "FRTaxIdentificationNumber", + "FRValueAddedTaxNumber", + "DEDriversLicenseNumber", + "DEPassportNumber", + "DEIdentityCardNumber", + "DETaxIdentificationNumber", + "DEValueAddedNumber", + "GRNationalIDCard", + "GRNationalIDV2", + "GRTaxIdentificationNumber", + "HKIdentityCardNumber", + "HUValueAddedNumber", + "HUPersonalIdentificationNumber", + "HUTaxIdentificationNumber", + "INPermanentAccount", + "INUniqueIdentificationNumber", + "IDIdentityCardNumber", + "InternationalBankingAccountNumber", + "IEPersonalPublicServiceNumber", + "IEPersonalPublicServiceNumberV2", + "ILBankAccountNumber", + "ILNationalID", + "ITDriversLicenseNumber", + "ITFiscalCode", + "ITValueAddedTaxNumber", + "JPBankAccountNumber", + "JPDriversLicenseNumber", + "JPPassportNumber", + "JPResidentRegistrationNumber", + "JPSocialInsuranceNumber", + "JPMyNumberCorporate", + "JPMyNumberPersonal", + "JPResidenceCardNumber", + "LVPersonalCode", + "LTPersonalCode", + "LUNationalIdentificationNumberNatural", + "LUNationalIdentificationNumberNonNatural", + "MYIdentityCardNumber", + "MTIdentityCardNumber", + "MTTaxIDNumber", + "NLCitizensServiceNumber", + "NLCitizensServiceNumberV2", + "NLTaxIdentificationNumber", + "NLValueAddedTaxNumber", + "NZBankAccountNumber", + "NZDriversLicenseNumber", + "NZInlandRevenueNumber", + "NZMinistryOfHealthNumber", + "NZSocialWelfareNumber", + "NOIdentityNumber", + "PHUnifiedMultiPurposeIDNumber", + "PLIdentityCard", + "PLNationalID", + "PLNationalIDV2", + "PLPassportNumber", + "PLTaxIdentificationNumber", + "PLREGONNumber", + "PTCitizenCardNumber", + "PTCitizenCardNumberV2", + "PTTaxIdentificationNumber", + "ROPersonalNumericalCode", + "RUPassportNumberDomestic", + "RUPassportNumberInternational", + "SANationalID", + "SGNationalRegistrationIdentityCardNumber", + "SKPersonalNumber", + "SITaxIdentificationNumber", + "SIUniqueMasterCitizenNumber", + "ZAIdentificationNumber", + "KRResidentRegistrationNumber", + "ESDNI", + "ESSocialSecurityNumber", + "ESTaxIdentificationNumber", + "SQLServerConnectionString", + "SENationalID", + "SENationalIDV2", + "SEPassportNumber", + "SETaxIdentificationNumber", + "SWIFTCode", + "CHSocialSecurityNumber", + "TWNationalID", + "TWPassportNumber", + "TWResidentCertificate", + "THPopulationIdentificationCode", + "TRNationalIdentificationNumber", + "UKDriversLicenseNumber", + "UKElectoralRollNumber", + "UKNationalHealthNumber", + "UKNationalInsuranceNumber", + "UKUniqueTaxpayerNumber", + "USUKPassportNumber", + "USBankAccountNumber", + "USDriversLicenseNumber", + "USIndividualTaxpayerIdentification", + "USSocialSecurityNumber", + "UAPassportNumberDomestic", + "UAPassportNumberInternational", + "Organization", + "Email", + "URL", + "Age", + "PhoneNumber", + "IPAddress", + "Date", + "Person", + "Address", + "All", + "Default" + ] + }, + "type": "array", + "uniqueItems": true + } + }, + "parameters": { + "ApiVersion": { + "name": "ApiVersion", + "description": "Text Analytics API version (for example, v3.0).", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "enum": [ + "v3.1" + ], + "in": "path", + "x-ms-skip-url-encoding": true + }, + "Endpoint": { + "name": "Endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + }, + "StringIndexType": { + "name": "stringIndexType", + "in": "query", + "type": "string", + "description": "(Optional) Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets", + "default": "TextElement_v8", + "enum": [ + "TextElement_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "value": "TextElement_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "PiiCategories": { + "description": "(Optional) describes the PII categories to return", + "in": "query", + "collectionFormat": "csv", + "items": { + "type": "string", + "x-ms-enum": { + "name": "PiiCategory", + "modelAsString": true + }, + "enum": [ + "ABARoutingNumber", + "ARNationalIdentityNumber", + "AUBankAccountNumber", + "AUDriversLicenseNumber", + "AUMedicalAccountNumber", + "AUPassportNumber", + "AUTaxFileNumber", + "AUBusinessNumber", + "AUCompanyNumber", + "ATIdentityCard", + "ATTaxIdentificationNumber", + "ATValueAddedTaxNumber", + "AzureDocumentDBAuthKey", + "AzureIAASDatabaseConnectionAndSQLString", + "AzureIoTConnectionString", + "AzurePublishSettingPassword", + "AzureRedisCacheString", + "AzureSAS", + "AzureServiceBusString", + "AzureStorageAccountKey", + "AzureStorageAccountGeneric", + "BENationalNumber", + "BENationalNumberV2", + "BEValueAddedTaxNumber", + "BRCPFNumber", + "BRLegalEntityNumber", + "BRNationalIDRG", + "BGUniformCivilNumber", + "CABankAccountNumber", + "CADriversLicenseNumber", + "CAHealthServiceNumber", + "CAPassportNumber", + "CAPersonalHealthIdentification", + "CASocialInsuranceNumber", + "CLIdentityCardNumber", + "CNResidentIdentityCardNumber", + "CreditCardNumber", + "HRIdentityCardNumber", + "HRNationalIDNumber", + "HRPersonalIdentificationNumber", + "HRPersonalIdentificationOIBNumberV2", + "CYIdentityCard", + "CYTaxIdentificationNumber", + "CZPersonalIdentityNumber", + "CZPersonalIdentityV2", + "DKPersonalIdentificationNumber", + "DKPersonalIdentificationV2", + "DrugEnforcementAgencyNumber", + "EEPersonalIdentificationCode", + "EUDebitCardNumber", + "EUDriversLicenseNumber", + "EUGPSCoordinates", + "EUNationalIdentificationNumber", + "EUPassportNumber", + "EUSocialSecurityNumber", + "EUTaxIdentificationNumber", + "FIEuropeanHealthNumber", + "FINationalID", + "FINationalIDV2", + "FIPassportNumber", + "FRDriversLicenseNumber", + "FRHealthInsuranceNumber", + "FRNationalID", + "FRPassportNumber", + "FRSocialSecurityNumber", + "FRTaxIdentificationNumber", + "FRValueAddedTaxNumber", + "DEDriversLicenseNumber", + "DEPassportNumber", + "DEIdentityCardNumber", + "DETaxIdentificationNumber", + "DEValueAddedNumber", + "GRNationalIDCard", + "GRNationalIDV2", + "GRTaxIdentificationNumber", + "HKIdentityCardNumber", + "HUValueAddedNumber", + "HUPersonalIdentificationNumber", + "HUTaxIdentificationNumber", + "INPermanentAccount", + "INUniqueIdentificationNumber", + "IDIdentityCardNumber", + "InternationalBankingAccountNumber", + "IEPersonalPublicServiceNumber", + "IEPersonalPublicServiceNumberV2", + "ILBankAccountNumber", + "ILNationalID", + "ITDriversLicenseNumber", + "ITFiscalCode", + "ITValueAddedTaxNumber", + "JPBankAccountNumber", + "JPDriversLicenseNumber", + "JPPassportNumber", + "JPResidentRegistrationNumber", + "JPSocialInsuranceNumber", + "JPMyNumberCorporate", + "JPMyNumberPersonal", + "JPResidenceCardNumber", + "LVPersonalCode", + "LTPersonalCode", + "LUNationalIdentificationNumberNatural", + "LUNationalIdentificationNumberNonNatural", + "MYIdentityCardNumber", + "MTIdentityCardNumber", + "MTTaxIDNumber", + "NLCitizensServiceNumber", + "NLCitizensServiceNumberV2", + "NLTaxIdentificationNumber", + "NLValueAddedTaxNumber", + "NZBankAccountNumber", + "NZDriversLicenseNumber", + "NZInlandRevenueNumber", + "NZMinistryOfHealthNumber", + "NZSocialWelfareNumber", + "NOIdentityNumber", + "PHUnifiedMultiPurposeIDNumber", + "PLIdentityCard", + "PLNationalID", + "PLNationalIDV2", + "PLPassportNumber", + "PLTaxIdentificationNumber", + "PLREGONNumber", + "PTCitizenCardNumber", + "PTCitizenCardNumberV2", + "PTTaxIdentificationNumber", + "ROPersonalNumericalCode", + "RUPassportNumberDomestic", + "RUPassportNumberInternational", + "SANationalID", + "SGNationalRegistrationIdentityCardNumber", + "SKPersonalNumber", + "SITaxIdentificationNumber", + "SIUniqueMasterCitizenNumber", + "ZAIdentificationNumber", + "KRResidentRegistrationNumber", + "ESDNI", + "ESSocialSecurityNumber", + "ESTaxIdentificationNumber", + "SQLServerConnectionString", + "SENationalID", + "SENationalIDV2", + "SEPassportNumber", + "SETaxIdentificationNumber", + "SWIFTCode", + "CHSocialSecurityNumber", + "TWNationalID", + "TWPassportNumber", + "TWResidentCertificate", + "THPopulationIdentificationCode", + "TRNationalIdentificationNumber", + "UKDriversLicenseNumber", + "UKElectoralRollNumber", + "UKNationalHealthNumber", + "UKNationalInsuranceNumber", + "UKUniqueTaxpayerNumber", + "USUKPassportNumber", + "USBankAccountNumber", + "USDriversLicenseNumber", + "USIndividualTaxpayerIdentification", + "USSocialSecurityNumber", + "UAPassportNumberDomestic", + "UAPassportNumberInternational", + "Organization", + "Email", + "URL", + "Age", + "PhoneNumber", + "IPAddress", + "Date", + "Person", + "Address", + "All", + "Default" + ] + }, + "name": "piiCategories", + "required": false, + "type": "array", + "uniqueItems": true, + "x-ms-parameter-location": "method" + }, + "JobId": { + "description": "Job ID", + "format": "uuid", + "in": "path", + "name": "jobId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "AnalyzeJobId": { + "description": "Job ID for Analyze", + "in": "path", + "name": "jobId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ShowStats": { + "name": "showStats", + "in": "query", + "description": "(Optional) if set to true, response will contain request and document level statistics.", + "type": "boolean", + "required": false, + "x-ms-parameter-location": "method" + }, + "LoggingOptOut": { + "name": "loggingOptOut", + "in": "query", + "description": "(Optional) If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to allow for troubleshooting issues in providing you with the Text Analytics natural language processing functions. Setting this parameter to true, disables input logging and may limit our ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI principles at https://www.microsoft.com/en-us/ai/responsible-ai.", + "type": "boolean", + "required": false, + "x-ms-parameter-location": "method" + }, + "ModelVersion": { + "name": "model-version", + "in": "query", + "description": "(Optional) This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version. ", + "type": "string", + "required": false, + "x-ms-parameter-location": "method" + }, + "MultiLanguageInput": { + "in": "body", + "name": "input", + "description": "Collection of documents to analyze.", + "required": true, + "schema": { + "$ref": "#/definitions/MultiLanguageBatchInput" + }, + "x-ms-parameter-location": "method" + }, + "LanguageInput": { + "in": "body", + "name": "input", + "description": "Collection of documents to analyze for language endpoint.", + "required": true, + "schema": { + "$ref": "#/definitions/LanguageBatchInput" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulAnalyzeRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulAnalyzeRequest.json new file mode 100644 index 000000000000..f80468967cea --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulAnalyzeRequest.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "ApiVersion": "v3.1", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "input": { + "displayName": "Extracting Location & US Region", + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "I had a wonderful trip to Seattle last week." + }, + { + "id": "2", + "language": "en", + "text": "I'm flying to NYC tomorrow. See you there." + } + ] + }, + "tasks": { + "entityRecognitionTasks": [ + { + "parameters": { + "model-version": "latest" + } + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/text/analytics/v3.1/analyze/jobs/{jobId}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulAnalyzeStatusRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulAnalyzeStatusRequest.json new file mode 100644 index 000000000000..d4ee37b40eab --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulAnalyzeStatusRequest.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "ApiVersion": "v3.1", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2020-10-01T15:00:45Z", + "displayName": "Extracting Location & US Region", + "expirationDateTime": "2020-10-03T15:01:03Z", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + "lastUpdateDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "tasks": { + "completed": 2, + "failed": 0, + "inProgress": 0, + "total": 2, + "entityRecognitionTasks": [ + { + "taskName": "Recognize Entities (2020-04-01)", + "lastUpdateDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "results": { + "documents": [ + { + "entities": [ + { + "category": "Event", + "confidenceScore": 0.61, + "length": 4, + "offset": 18, + "text": "trip" + }, + { + "category": "Location", + "confidenceScore": 0.82, + "length": 7, + "offset": 26, + "subcategory": "GPE", + "text": "Seattle" + }, + { + "category": "DateTime", + "confidenceScore": 0.8, + "length": 9, + "offset": 34, + "subcategory": "DateRange", + "text": "last week" + } + ], + "id": "1", + "warnings": [] + }, + { + "entities": [ + { + "category": "Location", + "confidenceScore": 0.52, + "length": 3, + "offset": 14, + "subcategory": "GPE", + "text": "NYC" + }, + { + "category": "DateTime", + "confidenceScore": 0.8, + "length": 8, + "offset": 18, + "subcategory": "Date", + "text": "tomorrow" + } + ], + "id": "2", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2020-04-01" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulEntitiesRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulEntitiesRequest.json new file mode 100644 index 000000000000..5c72248e9ba2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulEntitiesRequest.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "ApiVersion": "v3.1", + "Endpoint": "{Endpoint}", + "input": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "Microsoft was founded by Bill Gates and Paul Allen." + }, + { + "id": "2", + "language": "en", + "text": "Pike place market is my favorite Seattle attraction." + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "documents": [ + { + "entities": [ + { + "category": "Organization", + "confidenceScore": 0.84, + "length": 9, + "offset": 0, + "text": "Microsoft" + }, + { + "category": "Person", + "confidenceScore": 0.85, + "length": 10, + "offset": 25, + "text": "Bill Gates" + }, + { + "category": "Person", + "confidenceScore": 0.9, + "length": 10, + "offset": 40, + "text": "Paul Allen" + } + ], + "id": "1", + "warnings": [] + }, + { + "entities": [ + { + "category": "Location", + "confidenceScore": 0.55, + "length": 7, + "offset": 33, + "subcategory": "GPE", + "text": "Seattle" + } + ], + "id": "2", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2020-04-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulEntityLinkingRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulEntityLinkingRequest.json new file mode 100644 index 000000000000..3c5b9357e0cc --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulEntityLinkingRequest.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "ApiVersion": "v3.1", + "Endpoint": "{Endpoint}", + "input": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "Microsoft was founded by Bill Gates and Paul Allen." + }, + { + "id": "2", + "language": "en", + "text": "Pike place market is my favorite Seattle attraction." + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "documents": [ + { + "entities": [ + { + "dataSource": "Wikipedia", + "id": "Bill Gates", + "language": "en", + "matches": [ + { + "confidenceScore": 0.52, + "length": 10, + "offset": 25, + "text": "Bill Gates" + } + ], + "name": "Bill Gates", + "url": "https://en.wikipedia.org/wiki/Bill_Gates" + }, + { + "dataSource": "Wikipedia", + "id": "Paul Allen", + "language": "en", + "matches": [ + { + "confidenceScore": 0.54, + "length": 10, + "offset": 40, + "text": "Paul Allen" + } + ], + "name": "Paul Allen", + "url": "https://en.wikipedia.org/wiki/Paul_Allen" + }, + { + "dataSource": "Wikipedia", + "id": "Microsoft", + "language": "en", + "matches": [ + { + "confidenceScore": 0.49, + "length": 9, + "offset": 0, + "text": "Microsoft" + } + ], + "name": "Microsoft", + "url": "https://en.wikipedia.org/wiki/Microsoft" + } + ], + "id": "1", + "warnings": [] + }, + { + "entities": [ + { + "dataSource": "Wikipedia", + "id": "Pike Place Market", + "language": "en", + "matches": [ + { + "confidenceScore": 0.86, + "length": 17, + "offset": 0, + "text": "Pike place market" + } + ], + "name": "Pike Place Market", + "url": "https://en.wikipedia.org/wiki/Pike_Place_Market" + }, + { + "dataSource": "Wikipedia", + "id": "Seattle", + "language": "en", + "matches": [ + { + "confidenceScore": 0.27, + "length": 7, + "offset": 33, + "text": "Seattle" + } + ], + "name": "Seattle", + "url": "https://en.wikipedia.org/wiki/Seattle" + } + ], + "id": "2", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2020-02-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulEntityPIIRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulEntityPIIRequest.json new file mode 100644 index 000000000000..8f64ad94acec --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulEntityPIIRequest.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "ApiVersion": "v3.1", + "Endpoint": "{Endpoint}", + "input": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "My SSN is 859-98-0987" + }, + { + "id": "2", + "language": "en", + "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check." + }, + { + "id": "3", + "language": "en", + "text": "Is 998.214.865-68 your Brazilian CPF number?" + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "documents": [ + { + "id": "1", + "redactedText": "My SSN is ***********", + "entities": [ + { + "category": "U.S. Social Security Number (SSN)", + "confidenceScore": 0.65, + "length": 11, + "offset": 28, + "text": "859-98-0987" + } + ], + "warnings": [] + }, + { + "id": "2", + "redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.", + "entities": [ + { + "category": "ABA Routing Number", + "confidenceScore": 0.75, + "length": 9, + "offset": 18, + "text": "111000025" + } + ], + "warnings": [] + }, + { + "id": "3", + "redactedText": "Is ************** your Brazilian CPF number?", + "entities": [ + { + "category": "Brazil CPF Number", + "confidenceScore": 0.85, + "length": 14, + "offset": 3, + "text": "998.214.865-68" + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2019-10-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulHealthDeleteRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulHealthDeleteRequest.json new file mode 100644 index 000000000000..071c295ccd22 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulHealthDeleteRequest.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "ApiVersion": "v3.1", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}" + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/text/analytics/v3.1/entities/healthcare/jobs/{jobId}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulHealthRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulHealthRequest.json new file mode 100644 index 000000000000..3791aecb42a4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulHealthRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "ApiVersion": "v3.1", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "input": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "Subject is taking 100mg of ibuprofen twice daily." + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/text/analytics/v3.1/entities/healthcare/jobs/{jobId}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulHealthStatusRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulHealthStatusRequest.json new file mode 100644 index 000000000000..0c0fd5102404 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulHealthStatusRequest.json @@ -0,0 +1,206 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "ApiVersion": "v3.1", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2020-10-01T15:01:03Z", + "expirationDateTime": "2020-10-03T15:01:03Z", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + "lastUpdateDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "results": { + "documents": [ + { + "id": "1", + "entities": [ + { + "offset": 18, + "length": 5, + "text": "100mg", + "category": "DOSAGE", + "confidenceScore": 0.99 + }, + { + "offset": 27, + "length": 9, + "text": "ibuprofen", + "category": "MEDICATION_NAME", + "confidenceScore": 1.0, + "assertion": { + "certainty": "positive" + }, + "links": [ + { + "id": "C0020740", + "dataSource": "UMLS" + }, + { + "id": "0000019879", + "dataSource": "AOD" + }, + { + "id": "M01AE01", + "dataSource": "ATC" + }, + { + "id": "0046165", + "dataSource": "CCPSS" + }, + { + "id": "0000006519", + "dataSource": "CHV" + }, + { + "id": "2270-2077", + "dataSource": "CSP" + }, + { + "id": "DB01050", + "dataSource": "DRUGBANK" + }, + { + "id": "1611", + "dataSource": "GS" + }, + { + "id": "sh97005926", + "dataSource": "LCH_NW" + }, + { + "id": "LP16165-0", + "dataSource": "LNC" + }, + { + "id": "40458", + "dataSource": "MEDCIN" + }, + { + "id": "d00015", + "dataSource": "MMSL" + }, + { + "id": "D007052", + "dataSource": "MSH" + }, + { + "id": "WK2XYI10QM", + "dataSource": "MTHSPL" + }, + { + "id": "C561", + "dataSource": "NCI" + }, + { + "id": "C561", + "dataSource": "NCI_CTRP" + }, + { + "id": "00803", + "dataSource": "NCI_DCP" + }, + { + "id": "NSC0256857", + "dataSource": "NCI_DTP" + }, + { + "id": "WK2XYI10QM", + "dataSource": "NCI_FDA" + }, + { + "id": "CDR0000613511", + "dataSource": "NCI_NCI-GLOSS" + }, + { + "id": "002377", + "dataSource": "NDDF" + }, + { + "id": "CDR0000040475", + "dataSource": "PDQ" + }, + { + "id": "x02MO", + "dataSource": "RCD" + }, + { + "id": "5640", + "dataSource": "RXNORM" + }, + { + "id": "E-7772", + "dataSource": "SNM" + }, + { + "id": "C-603C0", + "dataSource": "SNMI" + }, + { + "id": "387207008", + "dataSource": "SNOMEDCT_US" + }, + { + "id": "m39860", + "dataSource": "USP" + }, + { + "id": "MTHU000060", + "dataSource": "USPMG" + }, + { + "id": "4017840", + "dataSource": "VANDF" + } + ] + }, + { + "offset": 37, + "length": 11, + "text": "twice daily", + "category": "FREQUENCY", + "confidenceScore": 1 + } + ], + "relations": [ + { + "relationType": "DosageOfMedication", + "entities": [ + { + "ref": "#/documents/0/entities/0", + "role": "Attribute" + }, + { + "ref": "#/documents/0/entities/1", + "role": "Entity" + } + ] + }, + { + "relationType": "FrequencyOfMedication", + "entities": [ + { + "ref": "#/documents/0/entities/2", + "role": "Attribute" + }, + { + "ref": "#/documents/0/entities/1", + "role": "Entity" + } + ] + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2020-05-08" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulKeyPhrasesRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulKeyPhrasesRequest.json new file mode 100644 index 000000000000..544df54ecd4d --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulKeyPhrasesRequest.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "ApiVersion": "v3.1", + "Endpoint": "{Endpoint}", + "input": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "Microsoft was founded by Bill Gates and Paul Allen." + }, + { + "id": "2", + "language": "en", + "text": "Text Analytics is one of the Azure Cognitive Services." + }, + { + "id": "3", + "language": "en", + "text": "My cat might need to see a veterinarian." + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "documents": [ + { + "id": "1", + "keyPhrases": [ + "Bill Gates", + "Paul Allen", + "Microsoft" + ], + "warnings": [] + }, + { + "id": "2", + "keyPhrases": [ + "Azure Cognitive Services", + "Text Analytics" + ], + "warnings": [] + }, + { + "id": "3", + "keyPhrases": [ + "cat", + "veterinarian" + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2019-10-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulLanguagesRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulLanguagesRequest.json new file mode 100644 index 000000000000..e5c9d454ee49 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulLanguagesRequest.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "ApiVersion": "v3.1", + "Endpoint": "{Endpoint}", + "input": { + "documents": [ + { + "id": "1", + "text": "Hello world" + }, + { + "id": "2", + "text": "Bonjour tout le monde" + }, + { + "id": "3", + "text": "Hola mundo" + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "documents": [ + { + "detectedLanguage": { + "confidenceScore": 1, + "iso6391Name": "en", + "name": "English" + }, + "id": "1", + "warnings": [] + }, + { + "detectedLanguage": { + "confidenceScore": 1, + "iso6391Name": "fr", + "name": "French" + }, + "id": "2", + "warnings": [] + }, + { + "detectedLanguage": { + "confidenceScore": 1, + "iso6391Name": "es", + "name": "Spanish" + }, + "id": "3", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2020-04-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulSentimentRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulSentimentRequest.json new file mode 100644 index 000000000000..8170ba0275c8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v3.1/examples/SuccessfulSentimentRequest.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "ApiVersion": "v3.1", + "Endpoint": "{Endpoint}", + "input": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "Great atmosphere. Close to plenty of restaurants, hotels, and transit! Staff are friendly and helpful." + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "documents": [ + { + "confidenceScores": { + "negative": 0, + "neutral": 0, + "positive": 1 + }, + "id": "1", + "sentences": [ + { + "targets": [ + { + "confidenceScores": { + "negative": 0, + "positive": 1 + }, + "length": 10, + "offset": 6, + "relations": [ + { + "ref": "#/documents/0/sentences/0/assessments/0", + "relationType": "assessment" + } + ], + "sentiment": "positive", + "text": "atmosphere" + } + ], + "confidenceScores": { + "negative": 0, + "neutral": 0, + "positive": 1 + }, + "length": 17, + "offset": 0, + "assessments": [ + { + "confidenceScores": { + "negative": 0, + "positive": 1 + }, + "isNegated": false, + "length": 5, + "offset": 0, + "sentiment": "positive", + "text": "great" + } + ], + "sentiment": "positive", + "text": "Great atmosphere." + }, + { + "targets": [ + { + "confidenceScores": { + "negative": 0.01, + "positive": 0.99 + }, + "length": 11, + "offset": 37, + "relations": [ + { + "ref": "#/documents/0/sentences/1/assessments/0", + "relationType": "assessment" + } + ], + "sentiment": "positive", + "text": "restaurants" + }, + { + "confidenceScores": { + "negative": 0.01, + "positive": 0.99 + }, + "length": 6, + "offset": 50, + "relations": [ + { + "ref": "#/documents/0/sentences/1/assessments/0", + "relationType": "assessment" + } + ], + "sentiment": "positive", + "text": "hotels" + } + ], + "confidenceScores": { + "negative": 0.01, + "neutral": 0.86, + "positive": 0.13 + }, + "length": 52, + "offset": 18, + "assessments": [ + { + "confidenceScores": { + "negative": 0.01, + "positive": 0.99 + }, + "isNegated": false, + "length": 15, + "offset": 18, + "sentiment": "positive", + "text": "Close to plenty" + } + ], + "sentiment": "neutral", + "text": "Close to plenty of restaurants, hotels, and transit!" + } + ], + "sentiment": "positive", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2020-04-01" + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/CheckSkuAvailability.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/CheckSkuAvailability.json index d8e7bd7b7cb7..5ff30f99d648 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/CheckSkuAvailability.json +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/CheckSkuAvailability.json @@ -5,7 +5,7 @@ "location": "westus", "parameters": { "skus": [ - "S0" + "S" ], "kind": "Face", "type": "Microsoft.CognitiveServices/accounts" diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/GetSkus.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/GetSkus.json index b44ab00bba73..1daed7ba8a3c 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/GetSkus.json +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/examples/GetSkus.json @@ -329,47 +329,7 @@ }, { "resourceType": "accounts", - "name": "S0", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "AUSTRALIAEAST" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S1", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "AUSTRALIAEAST" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S2", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "AUSTRALIAEAST" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S3", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "AUSTRALIAEAST" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S4", + "name": "S", "tier": "Standard", "kind": "TextAnalytics", "locations": [ @@ -469,47 +429,7 @@ }, { "resourceType": "accounts", - "name": "S0", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "BRAZILSOUTH" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S1", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "BRAZILSOUTH" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S2", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "BRAZILSOUTH" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S3", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "BRAZILSOUTH" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S4", + "name": "S", "tier": "Standard", "kind": "TextAnalytics", "locations": [ @@ -589,47 +509,7 @@ }, { "resourceType": "accounts", - "name": "S0", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "CENTRALUSEUAP" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S1", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "CENTRALUSEUAP" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S2", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "CENTRALUSEUAP" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S3", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "CENTRALUSEUAP" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S4", + "name": "S", "tier": "Standard", "kind": "TextAnalytics", "locations": [ @@ -749,47 +629,7 @@ }, { "resourceType": "accounts", - "name": "S0", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "WESTUS" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S1", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "WESTUS" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S2", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "WESTUS" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S3", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "WESTUS" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S4", + "name": "S", "tier": "Standard", "kind": "TextAnalytics", "locations": [ @@ -929,47 +769,7 @@ }, { "resourceType": "accounts", - "name": "S0", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "WESTUS2" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S1", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "WESTUS2" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S2", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "WESTUS2" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S3", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "WESTUS2" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S4", + "name": "S", "tier": "Standard", "kind": "TextAnalytics", "locations": [ @@ -1089,7 +889,7 @@ }, { "resourceType": "accounts", - "name": "S0", + "name": "S", "tier": "Standard", "kind": "TextAnalytics", "locations": [ @@ -1099,41 +899,41 @@ }, { "resourceType": "accounts", - "name": "S1", - "tier": "Standard", - "kind": "TextAnalytics", + "name": "F0", + "tier": "Free", + "kind": "Face", "locations": [ - "WESTEUROPE" + "NORTHEUROPE" ], "restrictions": [] }, { "resourceType": "accounts", - "name": "S2", + "name": "S0", "tier": "Standard", - "kind": "TextAnalytics", + "kind": "Face", "locations": [ - "WESTEUROPE" + "NORTHEUROPE" ], "restrictions": [] }, { "resourceType": "accounts", - "name": "S3", - "tier": "Standard", - "kind": "TextAnalytics", + "name": "F0", + "tier": "Free", + "kind": "ComputerVision", "locations": [ - "WESTEUROPE" + "NORTHEUROPE" ], "restrictions": [] }, { "resourceType": "accounts", - "name": "S4", + "name": "S1", "tier": "Standard", - "kind": "TextAnalytics", + "kind": "ComputerVision", "locations": [ - "WESTEUROPE" + "NORTHEUROPE" ], "restrictions": [] }, @@ -1141,7 +941,7 @@ "resourceType": "accounts", "name": "F0", "tier": "Free", - "kind": "Face", + "kind": "ContentModerator", "locations": [ "NORTHEUROPE" ], @@ -1151,7 +951,7 @@ "resourceType": "accounts", "name": "S0", "tier": "Standard", - "kind": "Face", + "kind": "ContentModerator", "locations": [ "NORTHEUROPE" ], @@ -1161,7 +961,7 @@ "resourceType": "accounts", "name": "F0", "tier": "Free", - "kind": "ComputerVision", + "kind": "TextAnalytics", "locations": [ "NORTHEUROPE" ], @@ -1169,9 +969,9 @@ }, { "resourceType": "accounts", - "name": "S1", + "name": "S", "tier": "Standard", - "kind": "ComputerVision", + "kind": "TextAnalytics", "locations": [ "NORTHEUROPE" ], @@ -1181,7 +981,7 @@ "resourceType": "accounts", "name": "F0", "tier": "Free", - "kind": "ContentModerator", + "kind": "LUIS", "locations": [ "NORTHEUROPE" ], @@ -1191,7 +991,7 @@ "resourceType": "accounts", "name": "S0", "tier": "Standard", - "kind": "ContentModerator", + "kind": "LUIS", "locations": [ "NORTHEUROPE" ], @@ -1201,9 +1001,9 @@ "resourceType": "accounts", "name": "F0", "tier": "Free", - "kind": "TextAnalytics", + "kind": "Face", "locations": [ - "NORTHEUROPE" + "SOUTHEASTASIA" ], "restrictions": [] }, @@ -1211,89 +1011,9 @@ "resourceType": "accounts", "name": "S0", "tier": "Standard", - "kind": "TextAnalytics", + "kind": "Face", "locations": [ - "NORTHEUROPE" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S1", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "NORTHEUROPE" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S2", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "NORTHEUROPE" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S3", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "NORTHEUROPE" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S4", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "NORTHEUROPE" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "F0", - "tier": "Free", - "kind": "LUIS", - "locations": [ - "NORTHEUROPE" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S0", - "tier": "Standard", - "kind": "LUIS", - "locations": [ - "NORTHEUROPE" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "F0", - "tier": "Free", - "kind": "Face", - "locations": [ - "SOUTHEASTASIA" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S0", - "tier": "Standard", - "kind": "Face", - "locations": [ - "SOUTHEASTASIA" + "SOUTHEASTASIA" ], "restrictions": [] }, @@ -1369,47 +1089,7 @@ }, { "resourceType": "accounts", - "name": "S0", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "SOUTHEASTASIA" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S1", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "SOUTHEASTASIA" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S2", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "SOUTHEASTASIA" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S3", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "SOUTHEASTASIA" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S4", + "name": "S", "tier": "Standard", "kind": "TextAnalytics", "locations": [ @@ -1489,47 +1169,7 @@ }, { "resourceType": "accounts", - "name": "S0", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "EASTASIA" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S1", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "EASTASIA" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S2", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "EASTASIA" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S3", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "EASTASIA" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S4", + "name": "S", "tier": "Standard", "kind": "TextAnalytics", "locations": [ @@ -1649,47 +1289,7 @@ }, { "resourceType": "accounts", - "name": "S0", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "WESTCENTRALUS" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S1", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "WESTCENTRALUS" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S2", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "WESTCENTRALUS" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S3", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "WESTCENTRALUS" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S4", + "name": "S", "tier": "Standard", "kind": "TextAnalytics", "locations": [ @@ -1769,47 +1369,7 @@ }, { "resourceType": "accounts", - "name": "S0", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "SOUTHCENTRALUS" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S1", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "SOUTHCENTRALUS" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S2", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "SOUTHCENTRALUS" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S3", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "SOUTHCENTRALUS" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S4", + "name": "S", "tier": "Standard", "kind": "TextAnalytics", "locations": [ @@ -1949,7 +1509,7 @@ }, { "resourceType": "accounts", - "name": "S0", + "name": "S", "tier": "Standard", "kind": "TextAnalytics", "locations": [ @@ -1957,56 +1517,6 @@ ], "restrictions": [] }, - { - "resourceType": "accounts", - "name": "S1", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "EASTUS" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S2", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "EASTUS" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S3", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "EASTUS" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S4", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "EASTUS" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "F0", - "tier": "Free", - "kind": "LUIS", - "locations": [ - "EASTUS" - ], - "restrictions": [] - }, { "resourceType": "accounts", "name": "S0", @@ -2109,47 +1619,7 @@ }, { "resourceType": "accounts", - "name": "S0", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "EASTUS2" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S1", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "EASTUS2" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S2", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "EASTUS2" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S3", - "tier": "Standard", - "kind": "TextAnalytics", - "locations": [ - "EASTUS2" - ], - "restrictions": [] - }, - { - "resourceType": "accounts", - "name": "S4", + "name": "S", "tier": "Standard", "kind": "TextAnalytics", "locations": [ diff --git a/specification/cognitiveservices/resource-manager/readme.md b/specification/cognitiveservices/resource-manager/readme.md index fe2aad3a95f4..846c047e0ed7 100644 --- a/specification/cognitiveservices/resource-manager/readme.md +++ b/specification/cognitiveservices/resource-manager/readme.md @@ -71,7 +71,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/cognitiveservices/resource-manager/readme.python.md b/specification/cognitiveservices/resource-manager/readme.python.md index 342f0b0c1455..df7348bac398 100644 --- a/specification/cognitiveservices/resource-manager/readme.python.md +++ b/specification/cognitiveservices/resource-manager/readme.python.md @@ -4,18 +4,6 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.cognitiveservices - package-name: azure-mgmt-cognitiveservices - package-version: 2.0.0 - clear-output-folder: true -``` - ``` yaml $(python) && $(track2) python-mode: create azure-arm: true @@ -26,17 +14,11 @@ package-version: 11.0.0b1 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' +``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/cognitiveservices/azure-mgmt-cognitiveservices/azure/mgmt/cognitiveservices -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/cognitiveservices/azure-mgmt-cognitiveservices/azure/mgmt/cognitiveservices ``` -``` yaml $(python) && $(python-mode) == 'create' +``` yaml $(python) && $(python-mode) == 'create' && $(track2) basic-setup-py: true output-folder: $(python-sdks-folder)/cognitiveservices/azure-mgmt-cognitiveservices -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/cognitiveservices/azure-mgmt-cognitiveservices ``` diff --git a/specification/commerce/resource-manager/readme.md b/specification/commerce/resource-manager/readme.md index 78eeba4be483..9decb8b7ce87 100644 --- a/specification/commerce/resource-manager/readme.md +++ b/specification/commerce/resource-manager/readme.md @@ -59,9 +59,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-python - after_scripts: - - python ./scripts/multiapi_init_gen.py azure-mgmt-commerce + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js @@ -75,43 +73,7 @@ swagger-to-sdk: ## Python -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.commerce - package-name: azure-mgmt-commerce - clear-output-folder: true - no-namespace-folders: true -``` - -### Python multi-api - -Generate all API versions currently shipped for this package - -```yaml $(python) && $(multiapi) -batch: - - tag: package-2015-06-preview -``` - -### Tag: package-2015-06-preview and python - -These settings apply only when `--tag=package-2015-06-preview --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2015-06-preview' && $(python) -namespace: azure.mgmt.commerce.v2015_06_01_preview -output-folder: $(python-sdks-folder)/commerce/azure-mgmt-commerce/azure/mgmt/commerce/v2015_06_01_preview -python: - namespace: azure.mgmt.commerce.v2015_06_01_preview - output-folder: $(python-sdks-folder)/commerce/azure-mgmt-commerce/azure/mgmt/commerce/v2015_06_01_preview -``` +See configuration in [readme.python.md](./readme.python.md) ## Go diff --git a/specification/commerce/resource-manager/readme.python.md b/specification/commerce/resource-manager/readme.python.md new file mode 100644 index 000000000000..a89b9c1df3a8 --- /dev/null +++ b/specification/commerce/resource-manager/readme.python.md @@ -0,0 +1,48 @@ +## Python + +These settings apply only when `--track2` is specified on the command line. + +``` yaml $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-commerce +package-version: 1.0.0b1 +no-namespace-folders: true +``` + +### Python multi-api + +Generate all API versions currently shipped for this package + +```yaml $(multiapi) +clear-output-folder: true +batch: + - tag: package-2015-06-preview + - multiapiscript: true +``` + +``` yaml $(multiapiscript) +output-folder: $(python-sdks-folder)/commerce/azure-mgmt-commerce/azure/mgmt/commerce/ +clear-output-folder: false +perform-load: false +``` + +### Tag: package-2015-06-preview and python + +These settings apply only when `--tag=package-2015-06-preview --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2015-06-preview' +namespace: azure.mgmt.commerce.v2015_06_01_preview +output-folder: $(python-sdks-folder)/commerce/azure-mgmt-commerce/azure/mgmt/commerce/v2015_06_01_preview +``` + +``` yaml $(python) && $(track2) +modelerfour: + lenient-model-deduplication: true +directive: + - from: swagger-document + where: $.definitions.OfferTermInfo.properties.Name + transform: > + $['x-ms-enum']['name'] = 'OfferTermInfoEnum'; +``` diff --git a/specification/commerce/resource-manager/readme.typescript.md b/specification/commerce/resource-manager/readme.typescript.md index 2026b493f92f..c05c2e4b58f9 100644 --- a/specification/commerce/resource-manager/readme.typescript.md +++ b/specification/commerce/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) && !$(profile) +``` yaml $(typescript) && !$(profile-content) typescript: azure-arm: true package-name: "@azure/arm-commerce" @@ -15,9 +15,9 @@ typescript: ### Profile: profile-hybrid-2020-09-01 -These settings apply only when `--profile=profile-hybrid-2020-09-01` is specified on the command line. +These settings apply only when `--profile-content=profile-hybrid-2020-09-01` is specified on the command line. -``` yaml $(profile)=='profile-hybrid-2020-09-01' +``` yaml $(profile-content)=='profile-hybrid-2020-09-01' typescript: package-name: "@azure/arm-commerce-profile-2020-09-01-hybrid" output-folder: "$(typescript-sdks-folder)/sdk/commerce/arm-commerce-profile-2020-09-01-hybrid" @@ -26,4 +26,4 @@ typescript: generate-metadata: true batch: - tag: profile-hybrid-2020-09-01 -``` \ No newline at end of file +``` diff --git a/specification/common-types/data-plane/v1/types.json b/specification/common-types/data-plane/v1/types.json new file mode 100644 index 000000000000..b28088d93ada --- /dev/null +++ b/specification/common-types/data-plane/v1/types.json @@ -0,0 +1,74 @@ +{ + "swagger": "2.0", + "info": { + "version": "1.0", + "title": "Common types" + }, + "paths": {}, + "definitions": { + "ErrorDetail": { + "type": "object", + "description": "The error detail.", + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "The error code." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "The error message." + }, + "target": { + "readOnly": true, + "type": "string", + "description": "The error target." + }, + "details": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetail" + }, + "description": "The error details." + }, + "additionalInfo": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ErrorAdditionalInfo" + }, + "description": "The error additional info." + } + } + }, + "ErrorResponse": { + "type": "object", + "title": "Error response", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "properties": { + "error": { + "description": "The error object.", + "$ref": "#/definitions/ErrorDetail" + } + } + }, + "ErrorAdditionalInfo": { + "type": "object", + "properties": { + "type": { + "readOnly": true, + "type": "string", + "description": "The additional info type." + }, + "info": { + "readOnly": true, + "type": "object", + "description": "The additional info." + } + }, + "description": "The resource management error additional info." + } + } +} diff --git a/specification/common-types/resource-management/v1/privatelinks.json b/specification/common-types/resource-management/v1/privatelinks.json index 91e640b03feb..5ceea8c222c7 100644 --- a/specification/common-types/resource-management/v1/privatelinks.json +++ b/specification/common-types/resource-management/v1/privatelinks.json @@ -7,6 +7,7 @@ "paths": {}, "definitions": { "PrivateEndpoint": { + "type": "object", "properties": { "id": { "readOnly": true, @@ -17,6 +18,7 @@ "description": "The Private Endpoint resource." }, "PrivateEndpointConnection": { + "type": "object", "properties": { "properties": { "$ref": "#/definitions/PrivateEndpointConnectionProperties", @@ -32,6 +34,7 @@ "description": "The Private Endpoint Connection resource." }, "PrivateEndpointConnectionProperties": { + "type": "object", "properties": { "privateEndpoint": { "$ref": "#/definitions/PrivateEndpoint", @@ -52,6 +55,7 @@ "description": "Properties of the PrivateEndpointConnectProperties." }, "PrivateLinkServiceConnectionState": { + "type": "object", "properties": { "status": { "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", @@ -97,6 +101,7 @@ } }, "PrivateLinkResource": { + "type": "object", "properties": { "properties": { "$ref": "#/definitions/PrivateLinkResourceProperties", @@ -112,6 +117,7 @@ "description": "A private link resource" }, "PrivateLinkResourceProperties": { + "type": "object", "properties": { "groupId": { "description": "The private link resource group id.", @@ -137,6 +143,7 @@ "description": "Properties of a private link resource." }, "PrivateEndpointConnectionListResult": { + "type": "object", "properties": { "value": { "type": "array", @@ -149,6 +156,7 @@ "description": "List of private endpoint connection associated with the specified storage account" }, "PrivateLinkResourceListResult": { + "type": "object", "properties": { "value": { "type": "array", diff --git a/specification/common-types/resource-management/v1/types.json b/specification/common-types/resource-management/v1/types.json index c85c6a77693a..8a817487e2b9 100644 --- a/specification/common-types/resource-management/v1/types.json +++ b/specification/common-types/resource-management/v1/types.json @@ -9,6 +9,7 @@ "Resource": { "title": "Resource", "description": "Common fields that are returned in the response for all Azure Resource Manager resources", + "type": "object", "properties": { "id": { "readOnly": true, @@ -32,6 +33,7 @@ "x-ms-client-name": "AzureEntityResource", "title": "Entity Resource", "description": "The resource model definition for an Azure Resource Manager resource with an etag.", + "type": "object", "properties": { "etag": { "type": "string", @@ -48,6 +50,7 @@ "TrackedResource": { "title": "Tracked Resource", "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'", + "type": "object", "properties": { "tags": { "type": "object", @@ -82,6 +85,7 @@ "ProxyResource": { "title": "Proxy Resource", "description": "The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location", + "type": "object", "allOf": [ { "$ref": "#/definitions/Resource" @@ -90,6 +94,7 @@ }, "ResourceModelWithAllowedPropertySet": { "description": "The resource model definition containing the full set of allowed properties for a resource. Except properties bag, there cannot be a top level property outside of this set.", + "type": "object", "properties": { "id": { "readOnly": true, @@ -181,6 +186,7 @@ }, "Sku": { "description": "The resource model definition representing SKU", + "type": "object", "properties": { "name": { "type": "string", @@ -220,6 +226,7 @@ }, "Identity": { "description": "Identity for the resource.", + "type": "object", "properties": { "principalId": { "readOnly": true, @@ -245,6 +252,7 @@ } }, "Plan": { + "type": "object", "properties": { "name": { "type": "string", @@ -277,6 +285,7 @@ "ErrorResponse": { "title": "Error Response", "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)", + "type": "object", "properties": { "code": { "readOnly": true, @@ -312,6 +321,7 @@ } }, "ErrorAdditionalInfo": { + "type": "object", "properties": { "type": { "readOnly": true, @@ -343,6 +353,7 @@ }, "display": { "description": "Localized display information for this particular operation.", + "type": "object", "properties": { "provider": { "description": "The localized friendly form of the resource provider name, e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute\".", @@ -396,6 +407,7 @@ }, "OperationListResult": { "description": "A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.", + "type": "object", "properties": { "value": { "type": "array", @@ -550,7 +562,6 @@ "required": true, "type": "string", "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._\\(\\)]+$", "minLength": 1, "maxLength": 90, "x-ms-parameter-location": "method" diff --git a/specification/common-types/resource-management/v2/privatelinks.json b/specification/common-types/resource-management/v2/privatelinks.json index be415f3555ea..117c93054e7b 100644 --- a/specification/common-types/resource-management/v2/privatelinks.json +++ b/specification/common-types/resource-management/v2/privatelinks.json @@ -7,6 +7,7 @@ "paths": {}, "definitions": { "PrivateEndpoint": { + "type": "object", "properties": { "id": { "readOnly": true, @@ -17,6 +18,7 @@ "description": "The Private Endpoint resource." }, "PrivateEndpointConnection": { + "type": "object", "properties": { "properties": { "$ref": "#/definitions/PrivateEndpointConnectionProperties", @@ -32,6 +34,7 @@ "description": "The Private Endpoint Connection resource." }, "PrivateEndpointConnectionProperties": { + "type": "object", "properties": { "privateEndpoint": { "$ref": "#/definitions/PrivateEndpoint", @@ -52,6 +55,7 @@ "description": "Properties of the PrivateEndpointConnectProperties." }, "PrivateLinkServiceConnectionState": { + "type": "object", "properties": { "status": { "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", @@ -97,6 +101,7 @@ } }, "PrivateLinkResource": { + "type": "object", "properties": { "properties": { "$ref": "#/definitions/PrivateLinkResourceProperties", @@ -112,6 +117,7 @@ "description": "A private link resource" }, "PrivateLinkResourceProperties": { + "type": "object", "properties": { "groupId": { "description": "The private link resource group id.", @@ -137,6 +143,7 @@ "description": "Properties of a private link resource." }, "PrivateEndpointConnectionListResult": { + "type": "object", "properties": { "value": { "type": "array", @@ -149,6 +156,7 @@ "description": "List of private endpoint connection associated with the specified storage account" }, "PrivateLinkResourceListResult": { + "type": "object", "properties": { "value": { "type": "array", diff --git a/specification/common-types/resource-management/v2/types.json b/specification/common-types/resource-management/v2/types.json index b883e5c7a7f0..a6224050586b 100644 --- a/specification/common-types/resource-management/v2/types.json +++ b/specification/common-types/resource-management/v2/types.json @@ -9,6 +9,7 @@ "Resource": { "title": "Resource", "description": "Common fields that are returned in the response for all Azure Resource Manager resources", + "type": "object", "properties": { "id": { "readOnly": true, @@ -32,6 +33,7 @@ "x-ms-client-name": "AzureEntityResource", "title": "Entity Resource", "description": "The resource model definition for an Azure Resource Manager resource with an etag.", + "type": "object", "properties": { "etag": { "type": "string", @@ -48,6 +50,7 @@ "TrackedResource": { "title": "Tracked Resource", "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'", + "type": "object", "properties": { "tags": { "type": "object", @@ -82,6 +85,7 @@ "ProxyResource": { "title": "Proxy Resource", "description": "The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location", + "type": "object", "allOf": [ { "$ref": "#/definitions/Resource" @@ -90,6 +94,7 @@ }, "ResourceModelWithAllowedPropertySet": { "description": "The resource model definition containing the full set of allowed properties for a resource. Except properties bag, there cannot be a top level property outside of this set.", + "type": "object", "properties": { "id": { "readOnly": true, @@ -181,6 +186,7 @@ }, "Sku": { "description": "The resource model definition representing SKU", + "type": "object", "properties": { "name": { "type": "string", @@ -220,6 +226,7 @@ }, "Identity": { "description": "Identity for the resource.", + "type": "object", "properties": { "principalId": { "readOnly": true, @@ -245,6 +252,7 @@ } }, "Plan": { + "type": "object", "properties": { "name": { "type": "string", @@ -276,6 +284,7 @@ }, "ErrorDetail": { "description": "The error detail.", + "type": "object", "properties": { "code": { "readOnly": true, @@ -313,6 +322,7 @@ "ErrorResponse": { "title": "Error response", "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "type": "object", "properties": { "error": { "description": "The error object.", @@ -321,6 +331,7 @@ } }, "ErrorAdditionalInfo": { + "type": "object", "properties": { "type": { "readOnly": true, @@ -352,6 +363,7 @@ }, "display": { "description": "Localized display information for this particular operation.", + "type": "object", "properties": { "provider": { "description": "The localized friendly form of the resource provider name, e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute\".", @@ -405,6 +417,7 @@ }, "OperationListResult": { "description": "A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.", + "type": "object", "properties": { "value": { "type": "array", @@ -647,7 +660,6 @@ "required": true, "type": "string", "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._\\(\\)]+$", "minLength": 1, "maxLength": 90, "x-ms-parameter-location": "method" diff --git a/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/communicationservicescallingserver.json b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/communicationservicescallingserver.json new file mode 100644 index 000000000000..a529c3c06520 --- /dev/null +++ b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/communicationservicescallingserver.json @@ -0,0 +1,1457 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-15-preview", + "title": "Azure Communication CallingServer Service", + "description": "Azure Communication CallingServer Service" + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/calling/callConnections": { + "post": { + "tags": [ + "CallConnection" + ], + "summary": "Create a new call.", + "description": "Create a new call.", + "operationId": "CallConnections_CreateCall", + "parameters": [ + { + "name": "callRequest", + "in": "body", + "description": "Create call request.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateCallRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Returns the create call response.", + "schema": { + "$ref": "#/definitions/CreateCallResult" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "x-ms-examples": { + "Create a new call.": { + "$ref": "./examples/CallConnections_CreateCall.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}/:hangup": { + "post": { + "tags": [ + "CallConnection" + ], + "summary": "Hangup the call.", + "description": "Hangup the call.", + "operationId": "CallConnections_HangupCall", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Returns the hangup call response." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "x-ms-examples": { + "Hangup the call.": { + "$ref": "./examples/CallConnections_HangupCall.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}/:playAudio": { + "post": { + "tags": [ + "CallConnection" + ], + "summary": "Play audio in the call.", + "description": "Play audio in the call.", + "operationId": "CallConnections_PlayAudio", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id.", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "Play audio request.", + "required": true, + "schema": { + "$ref": "#/definitions/PlayAudioRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Returns the play audio response.", + "schema": { + "$ref": "#/definitions/PlayAudioResult" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "x-ms-examples": { + "Play audio in the call.": { + "$ref": "./examples/CallConnections_PlayAudio.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}/:cancelAllMediaOperations": { + "post": { + "tags": [ + "CallConnection" + ], + "summary": "Cancel all media operations.", + "description": "Cancel all media operations.", + "operationId": "CallConnections_CancelAllMediaOperations", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id", + "required": true, + "type": "string" + }, + { + "name": "cancelAllMediaOperationRequest", + "in": "body", + "description": "The cancel all media operations context.", + "required": true, + "schema": { + "$ref": "#/definitions/CancelAllMediaOperationsRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Returns the cancel all media operations response.", + "schema": { + "$ref": "#/definitions/CancelAllMediaOperationsResult" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "x-ms-examples": { + "Cancel all media operations.": { + "$ref": "./examples/CallConnections_CancelAllMediaOperations.json" + } + } + } + }, + "/calling/serverCalls/{serverCallId}/participants": { + "post": { + "tags": [ + "ServerCall" + ], + "summary": "Add a participant to the call.", + "description": "Add a participant to the call.", + "operationId": "ServerCalls_AddParticipant", + "parameters": [ + { + "name": "serverCallId", + "in": "path", + "description": "The server call id.", + "required": true, + "type": "string" + }, + { + "name": "addParticipantRequest", + "in": "body", + "description": "The add participant request.", + "required": true, + "schema": { + "$ref": "#/definitions/AddParticipantRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Returns the add participant response.", + "schema": { + "$ref": "#/definitions/AddParticipantResult" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "x-ms-examples": { + "Add a participant to the call.": { + "$ref": "./examples/ServerCalls_AddParticipant.json" + } + } + } + }, + "/calling/serverCalls/{serverCallId}/participants/{participantId}": { + "delete": { + "tags": [ + "ServerCall" + ], + "summary": "Remove participant from the call.", + "description": "Remove participant from the call.", + "operationId": "ServerCalls_RemoveParticipant", + "parameters": [ + { + "name": "serverCallId", + "in": "path", + "description": "Server call id.", + "required": true, + "type": "string" + }, + { + "name": "participantId", + "in": "path", + "description": "Participant id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Returns the remove participant response." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "x-ms-examples": { + "Remove participant from the call.": { + "$ref": "./examples/ServerCalls_RemoveParticipant.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}/participants": { + "post": { + "tags": [ + "CallConnection" + ], + "summary": "Add a participant to the call.", + "description": "Add a participant to the call.", + "operationId": "CallConnections_AddParticipant", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id.", + "required": true, + "type": "string" + }, + { + "name": "addParticipantRequest", + "in": "body", + "description": "Add participant request.", + "required": true, + "schema": { + "$ref": "#/definitions/AddParticipantRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Returns the add participant response.", + "schema": { + "$ref": "#/definitions/AddParticipantResult" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "x-ms-examples": { + "Add a participant to the call.": { + "$ref": "./examples/CallConnections_AddParticipant.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}/participants/{participantId}": { + "delete": { + "tags": [ + "CallConnection" + ], + "summary": "Remove a participant from the call.", + "description": "Remove a participant from the call.", + "operationId": "CallConnections_RemoveParticipant", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id.", + "required": true, + "type": "string" + }, + { + "name": "participantId", + "in": "path", + "description": "The participant id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Returns the remove participant response." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "x-ms-examples": { + "Remove a participant from the call.": { + "$ref": "./examples/CallConnections_RemoveParticipant.json" + } + } + } + }, + "/calling/serverCalls/{serverCallId}/recordings": { + "post": { + "tags": [ + "Recording" + ], + "summary": "Start recording of the call.", + "operationId": "ServerCalls_StartRecording", + "parameters": [ + { + "name": "serverCallId", + "in": "path", + "description": "The server call id.", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "The request body of start call recording request.", + "required": true, + "schema": { + "$ref": "#/definitions/StartCallRecordingRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Returns the start call recording response.", + "schema": { + "$ref": "#/definitions/StartCallRecordingResult" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "x-ms-examples": { + "Start recording of the call.": { + "$ref": "./examples/ServerCalls_StartRecording.json" + } + } + } + }, + "/calling/serverCalls/{serverCallId}/recordings/{recordingId}": { + "get": { + "tags": [ + "Recording" + ], + "summary": "Get call recording properties.", + "operationId": "ServerCalls_GetRecordingProperties", + "parameters": [ + { + "name": "serverCallId", + "in": "path", + "description": "The server call id.", + "required": true, + "type": "string" + }, + { + "name": "recordingId", + "in": "path", + "description": "The recording id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Returns the recording state.", + "schema": { + "$ref": "#/definitions/CallRecordingProperties" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "x-ms-examples": { + "Get call recording properties.": { + "$ref": "./examples/ServerCalls_GetRecordingProperties.json" + } + } + }, + "delete": { + "tags": [ + "Recording" + ], + "summary": "Stop recording the call.", + "operationId": "ServerCalls_StopRecording", + "parameters": [ + { + "name": "serverCallId", + "in": "path", + "description": "The server call id.", + "required": true, + "type": "string" + }, + { + "name": "recordingId", + "in": "path", + "description": "The recording id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Returns the stop call recording response." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "x-ms-examples": { + "Stop recording the call.": { + "$ref": "./examples/ServerCalls_StopRecording.json" + } + } + } + }, + "/calling/serverCalls/{serverCallId}/recordings/{recordingId}/:pause": { + "post": { + "tags": [ + "Recording" + ], + "summary": "Pause recording the call.", + "operationId": "ServerCalls_PauseRecording", + "parameters": [ + { + "name": "serverCallId", + "in": "path", + "description": "The server call id.", + "required": true, + "type": "string" + }, + { + "name": "recordingId", + "in": "path", + "description": "The recording id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Returns the pause call recording response." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "x-ms-examples": { + "Pause recording the call.": { + "$ref": "./examples/ServerCalls_PauseRecording.json" + } + } + } + }, + "/calling/serverCalls/{serverCallId}/recordings/{recordingId}/:resume": { + "post": { + "tags": [ + "Recording" + ], + "summary": "Resume recording the call.", + "operationId": "ServerCalls_ResumeRecording", + "parameters": [ + { + "name": "serverCallId", + "in": "path", + "description": "The server call id.", + "required": true, + "type": "string" + }, + { + "name": "recordingId", + "in": "path", + "description": "The recording id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Returns the resume call recording response." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "x-ms-examples": { + "Resume recording the call.": { + "$ref": "./examples/ServerCalls_ResumeRecording.json" + } + } + } + }, + "/calling/serverCalls/{serverCallId}/:join": { + "post": { + "tags": [ + "ServerCall" + ], + "summary": "Join a call.", + "description": "Join a call.", + "operationId": "ServerCalls_JoinCall", + "parameters": [ + { + "name": "serverCallId", + "in": "path", + "description": "The server call id.", + "required": true, + "type": "string" + }, + { + "name": "callRequest", + "in": "body", + "description": "The join call request.", + "required": true, + "schema": { + "$ref": "#/definitions/JoinCallRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Returns the join call response.", + "schema": { + "$ref": "#/definitions/JoinCallResult" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "x-ms-examples": { + "Join a call.": { + "$ref": "./examples/ServerCalls_JoinCall.json" + } + } + } + }, + "/calling/serverCalls/{serverCallId}/:playAudio": { + "post": { + "tags": [ + "ServerCall" + ], + "summary": "Play audio in the call.", + "description": "Play audio in the call.", + "operationId": "ServerCalls_PlayAudio", + "parameters": [ + { + "name": "serverCallId", + "in": "path", + "description": "The server call id.", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "Play audio request.", + "required": true, + "schema": { + "$ref": "#/definitions/PlayAudioRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Returns the play audio response.", + "schema": { + "$ref": "#/definitions/PlayAudioResult" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "x-ms-examples": { + "Play audio in the call.": { + "$ref": "./examples/ServerCalls_PlayAudio.json" + } + } + } + } + }, + "definitions": { + "MediaType": { + "enum": [ + "audio", + "video" + ], + "type": "string", + "x-ms-enum": { + "name": "MediaType", + "modelAsString": true + } + }, + "EventSubscriptionType": { + "enum": [ + "participantsUpdated", + "dtmfReceived" + ], + "type": "string", + "x-ms-enum": { + "name": "EventSubscriptionType", + "modelAsString": true + } + }, + "CreateCallRequest": { + "description": "The request payload for create call.", + "required": [ + "targets", + "source", + "callbackUri" + ], + "type": "object", + "properties": { + "alternateCallerId": { + "$ref": "#/definitions/PhoneNumberIdentifier", + "description": "The alternate identity of the source of the call if dialing out to a pstn number" + }, + "targets": { + "description": "The targets of the call.", + "type": "array", + "items": { + "$ref": "#/definitions/CommunicationIdentifier" + } + }, + "source": { + "$ref": "#/definitions/CommunicationIdentifier", + "description": "The source of the call." + }, + "subject": { + "description": "The subject.", + "type": "string" + }, + "callbackUri": { + "description": "The callback URI.", + "type": "string" + }, + "requestedMediaTypes": { + "description": "The requested modalities.", + "type": "array", + "items": { + "$ref": "#/definitions/MediaType" + } + }, + "requestedCallEvents": { + "description": "The requested call events to subscribe to.", + "type": "array", + "items": { + "$ref": "#/definitions/EventSubscriptionType" + } + } + } + }, + "PhoneNumberIdentifier": { + "$ref": "../../../Common/stable/2021-03-07/common.json#/definitions/PhoneNumberIdentifierModel" + }, + "CommunicationIdentifier": { + "$ref": "../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationIdentifierModel" + }, + "CommunicationUserIdentifier": { + "$ref": "../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationUserIdentifierModel" + }, + "CommunicationCloudEnvironment": { + "$ref": "../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationCloudEnvironmentModel" + }, + "MicrosoftTeamsUserIdentifier": { + "$ref": "../../../Common/stable/2021-03-07/common.json#/definitions/MicrosoftTeamsUserIdentifierModel" + }, + "CreateCallResult": { + "description": "The response payload of the create call operation.", + "type": "object", + "properties": { + "callConnectionId": { + "description": "The call connection id.", + "type": "string" + } + } + }, + "PlayAudioRequest": { + "description": "The request payload for playing audio.", + "type": "object", + "properties": { + "audioFileUri": { + "description": "The media resource uri of the play audio request. \r\nCurrently only Wave file (.wav) format audio prompts are supported.\r\nMore specifically, the audio content in the wave file must be mono (single-channel),\r\n16-bit samples with a 16,000 (16KHz) sampling rate.", + "type": "string" + }, + "loop": { + "description": "The flag indicating whether audio file needs to be played in loop or not.", + "type": "boolean" + }, + "operationContext": { + "description": "The value to identify context of the operation.", + "type": "string" + }, + "audioFileId": { + "description": "An id for the media in the AudioFileUri, using which we cache the media resource.", + "type": "string" + }, + "callbackUri": { + "description": "The callback Uri to receive PlayAudio status notifications.", + "type": "string" + } + } + }, + "OperationStatus": { + "description": "The status of the operation", + "enum": [ + "notStarted", + "running", + "completed", + "failed" + ], + "type": "string", + "x-ms-enum": { + "name": "OperationStatus", + "modelAsString": true + } + }, + "PlayAudioResult": { + "description": "The response payload for play audio operation.", + "required": [ + "status" + ], + "type": "object", + "properties": { + "operationId": { + "description": "The operation id.", + "type": "string" + }, + "status": { + "$ref": "#/definitions/OperationStatus" + }, + "operationContext": { + "description": "The operation context provided by client.", + "type": "string" + }, + "resultInfo": { + "$ref": "#/definitions/ResultInfo", + "description": "The result info for the operation." + } + } + }, + "ResultInfo": { + "description": "Result info class to be used to report result status for actions/operations.", + "required": [ + "code", + "subcode" + ], + "type": "object", + "properties": { + "code": { + "format": "int32", + "description": "The result code associated with the operation.", + "type": "integer" + }, + "subcode": { + "format": "int32", + "description": "The subcode that further classifies the result.", + "type": "integer" + }, + "message": { + "description": "The message is a detail explanation of subcode.", + "type": "string" + } + } + }, + "CancelAllMediaOperationsRequest": { + "description": "The request payload for cancel all media operations", + "type": "object", + "properties": { + "operationContext": { + "description": "The context for this operation.", + "type": "string" + } + } + }, + "CancelAllMediaOperationsResult": { + "description": "The response payload of the cancel all media operations.", + "required": [ + "status" + ], + "type": "object", + "properties": { + "operationId": { + "description": "The operation id.", + "type": "string" + }, + "status": { + "$ref": "#/definitions/OperationStatus" + }, + "operationContext": { + "description": "The operation context provided by client.", + "type": "string" + }, + "resultInfo": { + "$ref": "#/definitions/ResultInfo", + "description": "The result info for the operation." + } + } + }, + "AddParticipantRequest": { + "description": "The add participant request.", + "type": "object", + "properties": { + "alternateCallerId": { + "$ref": "#/definitions/PhoneNumberIdentifier", + "description": "The alternate identity of source participant." + }, + "participant": { + "$ref": "#/definitions/CommunicationIdentifier", + "description": "The participant to be added to the call." + }, + "operationContext": { + "description": "The operation context.", + "type": "string" + }, + "callbackUri": { + "description": "The callback URI.", + "type": "string" + } + } + }, + "AddParticipantResult": { + "description": "The add participant result", + "type": "object", + "properties": { + "participantId": { + "description": "The id of the added participant.", + "type": "string" + } + } + }, + "StartCallRecordingRequest": { + "description": "The request payload start call recording operation.", + "type": "object", + "properties": { + "recordingStateCallbackUri": { + "description": "The uri to send notifications to.", + "type": "string" + } + } + }, + "StartCallRecordingResult": { + "description": "The response payload of start call recording operation.", + "type": "object", + "properties": { + "recordingId": { + "description": "The recording id of the started recording", + "type": "string" + } + } + }, + "CallRecordingState": { + "description": "The state of the recording", + "enum": [ + "active", + "inactive" + ], + "type": "string", + "x-ms-enum": { + "name": "CallRecordingState", + "modelAsString": true + } + }, + "CallRecordingProperties": { + "description": "The response payload of get call recording properties operation.", + "required": [ + "recordingState" + ], + "type": "object", + "properties": { + "recordingState": { + "$ref": "#/definitions/CallRecordingState" + } + } + }, + "JoinCallRequest": { + "description": "The request payload for join call.", + "required": [ + "source", + "callbackUri" + ], + "type": "object", + "properties": { + "source": { + "$ref": "#/definitions/CommunicationIdentifier", + "description": "The source of the call." + }, + "subject": { + "description": "The subject.", + "type": "string" + }, + "callbackUri": { + "description": "The callback URI.", + "type": "string" + }, + "requestedMediaTypes": { + "description": "The requested modalities.", + "type": "array", + "items": { + "$ref": "#/definitions/MediaType" + } + }, + "requestedCallEvents": { + "description": "The requested call events to subscribe to.", + "type": "array", + "items": { + "$ref": "#/definitions/EventSubscriptionType" + } + } + } + }, + "JoinCallResult": { + "description": "The response payload of the join call operation.", + "type": "object", + "properties": { + "callConnectionId": { + "description": "The call connection id.", + "type": "string" + } + } + }, + "CallConnectionState": { + "description": "The call connection state.", + "enum": [ + "incoming", + "connecting", + "connected", + "disconnecting", + "disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "CallConnectionState", + "modelAsString": true + } + }, + "CallConnectionStateChangedEvent": { + "description": "The call connection state changed event.", + "required": [ + "callConnectionState" + ], + "type": "object", + "properties": { + "serverCallId": { + "description": "The server call.id.", + "type": "string" + }, + "callConnectionId": { + "description": "The call connection id.", + "type": "string" + }, + "callConnectionState": { + "$ref": "#/definitions/CallConnectionState" + } + } + }, + "CallRecordingStateChangeEvent": { + "description": "The call recording state change event.", + "required": [ + "state", + "startDateTime" + ], + "type": "object", + "properties": { + "recordingId": { + "description": "The call recording id", + "type": "string" + }, + "state": { + "$ref": "#/definitions/CallRecordingState" + }, + "startDateTime": { + "format": "date-time", + "description": "The time of the recording started", + "type": "string" + }, + "serverCallId": { + "description": "The server call.id.", + "type": "string" + } + } + }, + "AddParticipantResultEvent": { + "required": [ + "status" + ], + "type": "object", + "properties": { + "resultInfo": { + "$ref": "#/definitions/ResultInfo", + "description": "The result details." + }, + "operationContext": { + "description": "The operation context.", + "type": "string" + }, + "status": { + "$ref": "#/definitions/OperationStatus" + } + } + }, + "ParticipantsUpdatedEvent": { + "description": "The participant update event", + "type": "object", + "properties": { + "callConnectionId": { + "description": "The call connection id.", + "type": "string" + }, + "participants": { + "description": "The list of participants.", + "type": "array", + "items": { + "$ref": "#/definitions/CallParticipant" + } + } + } + }, + "CallParticipant": { + "description": "A participant in a call.", + "required": [ + "isMuted" + ], + "type": "object", + "properties": { + "identifier": { + "$ref": "#/definitions/CommunicationIdentifier", + "description": "Communication identifier of the participant" + }, + "participantId": { + "description": "Participant id", + "type": "string" + }, + "isMuted": { + "description": "Is participant muted", + "type": "boolean" + } + } + }, + "PlayAudioResultEvent": { + "description": "The play audio result event.", + "required": [ + "status" + ], + "type": "object", + "properties": { + "resultInfo": { + "$ref": "#/definitions/ResultInfo", + "description": "The result details." + }, + "operationContext": { + "description": "The operation context.", + "type": "string" + }, + "status": { + "$ref": "#/definitions/OperationStatus" + } + } + }, + "ToneReceivedEvent": { + "description": "The subscribe to tone event", + "required": [ + "toneInfo" + ], + "type": "object", + "properties": { + "toneInfo": { + "$ref": "#/definitions/ToneInfo", + "description": "The tone info." + }, + "callConnectionId": { + "description": "The call connection id.", + "type": "string" + } + } + }, + "ToneValue": { + "description": "The tone value.", + "enum": [ + "tone0", + "tone1", + "tone2", + "tone3", + "tone4", + "tone5", + "tone6", + "tone7", + "tone8", + "tone9", + "star", + "pound", + "a", + "b", + "c", + "d", + "flash" + ], + "type": "string", + "x-ms-enum": { + "name": "ToneValue", + "modelAsString": true + } + }, + "ToneInfo": { + "description": "The information about the tone.", + "required": [ + "sequenceId", + "tone" + ], + "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" + }, + "tone": { + "$ref": "#/definitions/ToneValue" + } + } + }, + "CommunicationErrorResponse": { + "$ref": "../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse" + }, + "CommunicationError": { + "$ref": "../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationError" + } + }, + "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", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + } + }, + "responses": { + "400": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "404": { + "description": "NotFound", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "500": { + "description": "InternalServerError", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + } +} diff --git a/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/CallConnections_AddParticipant.json b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/CallConnections_AddParticipant.json new file mode 100644 index 000000000000..e2d52eddcafd --- /dev/null +++ b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/CallConnections_AddParticipant.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2021-06-15-preview", + "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c", + "addParticipantRequest": { + "participant": { + "communicationUser": { + "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_387c0153-3b4d-4779-9ee3-a6e2440df075" + } + }, + "operationContext": "5161f20a-7225-4a74-a529-efaf8e7b351d", + "callbackUri": "https://app.contoso.com/callback" + } + }, + "responses": { + "202": { + "body": { + "participantId": "c736e607-5b39-42a7-a6bb-bb43029e5bac" + } + }, + "400": { + "body": { + "error": { + "code": "400", + "message": "The request contains invalid data." + } + } + }, + "401": { + "body": { + "error": { + "code": "401", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "403", + "message": "User is not allowed to perform specified action." + } + } + }, + "404": { + "body": { + "error": { + "code": "404", + "message": "Resource not found on the server." + } + } + }, + "500": { + "body": { + "error": { + "code": "500", + "message": "Internal server error." + } + } + } + } +} diff --git a/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/CallConnections_CancelAllMediaOperations.json b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/CallConnections_CancelAllMediaOperations.json new file mode 100644 index 000000000000..03642fbb32b3 --- /dev/null +++ b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/CallConnections_CancelAllMediaOperations.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2021-06-15-preview", + "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c", + "cancelAllMediaOperationRequest": { + "operationContext": "91848e99-0d36-4bca-ac06-6c38fe390289" + } + }, + "responses": { + "200": { + "body": { + "status": "completed", + "operationContext": "91848e99-0d36-4bca-ac06-6c38fe390289" + } + }, + "400": { + "body": { + "error": { + "code": "400", + "message": "The request contains invalid data." + } + } + }, + "401": { + "body": { + "error": { + "code": "401", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "403", + "message": "User is not allowed to perform specified action." + } + } + }, + "404": { + "body": { + "error": { + "code": "404", + "message": "Resource not found on the server." + } + } + }, + "500": { + "body": { + "error": { + "code": "500", + "message": "Internal server error." + } + } + } + } +} diff --git a/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/CallConnections_CreateCall.json b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/CallConnections_CreateCall.json new file mode 100644 index 000000000000..071b505be1ee --- /dev/null +++ b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/CallConnections_CreateCall.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2021-06-15-preview", + "callRequest": { + "source": { + "communicationUser": { + "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce" + } + }, + "targets": [ + { + "communicationUser": { + "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_0f50d091-5bd3-448b-884d-44be7037d9b9" + } + }, + { + "phoneNumber": { + "value": "+14250123456" + } + } + ], + "alternateCallerId": { + "value": "+18440123456" + }, + "subject": "Reminder call", + "callbackUri": "https://app.contoso.com/callback", + "requestedMediaTypes": [ + "audio", + "video" + ], + "requestedCallEvents": [ + "dtmfReceived", + "participantsUpdated" + ] + } + }, + "responses": { + "201": { + "body": { + "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c" + } + }, + "400": { + "body": { + "error": { + "code": "400", + "message": "The request contains invalid data." + } + } + }, + "401": { + "body": { + "error": { + "code": "401", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "403", + "message": "User is not allowed to perform specified action." + } + } + }, + "500": { + "body": { + "error": { + "code": "500", + "message": "Internal server error." + } + } + } + } +} diff --git a/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/CallConnections_HangupCall.json b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/CallConnections_HangupCall.json new file mode 100644 index 000000000000..813b2fdf62fa --- /dev/null +++ b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/CallConnections_HangupCall.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2021-06-15-preview", + "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c" + }, + "responses": { + "202": {}, + "400": { + "body": { + "error": { + "code": "400", + "message": "The request contains invalid data." + } + } + }, + "401": { + "body": { + "error": { + "code": "401", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "403", + "message": "User is not allowed to perform specified action." + } + } + }, + "404": { + "body": { + "error": { + "code": "404", + "message": "Resource not found on the server." + } + } + }, + "500": { + "body": { + "error": { + "code": "500", + "message": "Internal server error." + } + } + } + } +} diff --git a/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/CallConnections_PlayAudio.json b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/CallConnections_PlayAudio.json new file mode 100644 index 000000000000..7eb69a0c1b39 --- /dev/null +++ b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/CallConnections_PlayAudio.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2021-06-15-preview", + "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c", + "request": { + "audioFileUri": "https://app.contoso.com/audio/message.wav", + "loop": false, + "operationContext": "31130c66-2f86-41b5-af61-23850243e093", + "audioFileId": "42922e2c-a204-4ac4-8d80-375ae2792389" + } + }, + "responses": { + "202": { + "body": { + "status": "running", + "operationContext": "31130c66-2f86-41b5-af61-23850243e093" + } + }, + "400": { + "body": { + "error": { + "code": "400", + "message": "The request contains invalid data." + } + } + }, + "401": { + "body": { + "error": { + "code": "401", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "403", + "message": "User is not allowed to perform specified action." + } + } + }, + "404": { + "body": { + "error": { + "code": "404", + "message": "Resource not found on the server." + } + } + }, + "500": { + "body": { + "error": { + "code": "500", + "message": "Internal server error." + } + } + } + } +} diff --git a/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/CallConnections_RemoveParticipant.json b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/CallConnections_RemoveParticipant.json new file mode 100644 index 000000000000..52b34a7ee44a --- /dev/null +++ b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/CallConnections_RemoveParticipant.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2021-06-15-preview", + "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c", + "participantId": "d8b26c04-7186-41e2-971a-bdfa9a662a53" + }, + "responses": { + "202": {}, + "400": { + "body": { + "error": { + "code": "400", + "message": "The request contains invalid data." + } + } + }, + "401": { + "body": { + "error": { + "code": "401", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "403", + "message": "User is not allowed to perform specified action." + } + } + }, + "404": { + "body": { + "error": { + "code": "404", + "message": "Resource not found on the server." + } + } + }, + "500": { + "body": { + "error": { + "code": "500", + "message": "Internal server error." + } + } + } + } +} diff --git a/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/ServerCalls_AddParticipant.json b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/ServerCalls_AddParticipant.json new file mode 100644 index 000000000000..df749269243e --- /dev/null +++ b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/ServerCalls_AddParticipant.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2021-06-15-preview", + "serverCallId": "aHR0cHM6Ly9jb252ZXJzYXRpb251cmwvdGVzdA", + "addParticipantRequest": { + "participant": { + "communicationUser": { + "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_ae9e3307-f56e-44be-8934-80a63f080538" + } + }, + "operationContext": "5161f20a-7225-4a74-a529-efaf8e7b351d", + "callbackUri": "https://app.contoso.com/callback" + } + }, + "responses": { + "202": { + "body": { + "participantId": "c736e607-5b39-42a7-a6bb-bb43029e5bac" + } + }, + "400": { + "body": { + "error": { + "code": "400", + "message": "The request contains invalid data." + } + } + }, + "401": { + "body": { + "error": { + "code": "401", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "403", + "message": "User is not allowed to perform specified action." + } + } + }, + "404": { + "body": { + "error": { + "code": "404", + "message": "Resource not found on the server." + } + } + }, + "500": { + "body": { + "error": { + "code": "500", + "message": "Internal server error." + } + } + } + } +} diff --git a/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/ServerCalls_GetRecordingProperties.json b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/ServerCalls_GetRecordingProperties.json new file mode 100644 index 000000000000..784c30d73294 --- /dev/null +++ b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/ServerCalls_GetRecordingProperties.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2021-06-15-preview", + "serverCallId": "aHR0cHM6Ly9jb252ZXJzYXRpb251cmwvdGVzdA", + "recordingId": "eyJQbGF0Zm9ybUVuZHBvaW50SWQiOiI3ZjQyNmI1OC03NTRmLTQ2M2UtYWRkMS0wNWFhNGNiYjliMzQiLCJSZXNvdXJjZVNwZWNpZmljSWQiOiJmNjMzODYwMS00MmE1LTRkMGUtODI3My01NjIwM2JhNzAzODYifQ" + }, + "responses": { + "200": { + "body": { + "recordingState": "active" + } + }, + "400": { + "body": { + "error": { + "code": "400", + "message": "The request contains invalid data." + } + } + }, + "401": { + "body": { + "error": { + "code": "401", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "403", + "message": "User is not allowed to perform specified action." + } + } + }, + "404": { + "body": { + "error": { + "code": "404", + "message": "Resource not found on the server." + } + } + }, + "500": { + "body": { + "error": { + "code": "500", + "message": "Internal server error." + } + } + } + } +} diff --git a/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/ServerCalls_JoinCall.json b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/ServerCalls_JoinCall.json new file mode 100644 index 000000000000..c6394104b9d1 --- /dev/null +++ b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/ServerCalls_JoinCall.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2021-06-15-preview", + "serverCallId": "aHR0cHM6Ly9jb252ZXJzYXRpb251cmwvdGVzdA", + "callRequest": { + "source": { + "communicationUser": { + "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_f51123c4-004b-494d-98cf-802d4b824fc4" + } + }, + "subject": "Incident meeting", + "callbackUri": "https://app.contoso.com/callback", + "requestedMediaTypes": [ + "audio" + ], + "requestedCallEvents": [ + "participantsUpdated" + ] + } + }, + "responses": { + "202": { + "body": { + "callConnectionId": "b9614373-fd0b-480c-8fd2-cb58b70eab9f" + } + }, + "400": { + "body": { + "error": { + "code": "400", + "message": "The request contains invalid data." + } + } + }, + "401": { + "body": { + "error": { + "code": "401", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "403", + "message": "User is not allowed to perform specified action." + } + } + }, + "500": { + "body": { + "error": { + "code": "500", + "message": "Internal server error." + } + } + } + } +} diff --git a/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/ServerCalls_PauseRecording.json b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/ServerCalls_PauseRecording.json new file mode 100644 index 000000000000..0015a5349313 --- /dev/null +++ b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/ServerCalls_PauseRecording.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2021-06-15-preview", + "serverCallId": "aHR0cHM6Ly9jb252ZXJzYXRpb251cmwvdGVzdA", + "recordingId": "eyJQbGF0Zm9ybUVuZHBvaW50SWQiOiI3ZjQyNmI1OC03NTRmLTQ2M2UtYWRkMS0wNWFhNGNiYjliMzQiLCJSZXNvdXJjZVNwZWNpZmljSWQiOiJmNjMzODYwMS00MmE1LTRkMGUtODI3My01NjIwM2JhNzAzODYifQ" + }, + "responses": { + "200": {}, + "400": { + "body": { + "error": { + "code": "400", + "message": "The request contains invalid data." + } + } + }, + "401": { + "body": { + "error": { + "code": "401", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "403", + "message": "User is not allowed to perform specified action." + } + } + }, + "404": { + "body": { + "error": { + "code": "404", + "message": "Resource not found on the server." + } + } + }, + "500": { + "body": { + "error": { + "code": "500", + "message": "Internal server error." + } + } + } + } +} diff --git a/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/ServerCalls_PlayAudio.json b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/ServerCalls_PlayAudio.json new file mode 100644 index 000000000000..2f15ac48d2df --- /dev/null +++ b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/ServerCalls_PlayAudio.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2021-06-15-preview", + "serverCallId": "aHR0cHM6Ly9jb252ZXJzYXRpb251cmwvdGVzdA", + "request": { + "audioFileUri": "https://app.contoso.com/audio/message.wav", + "loop": false, + "operationContext": "31130c66-2f86-41b5-af61-23850243e093", + "audioFileId": "42922e2c-a204-4ac4-8d80-375ae2792389", + "callbackUri": "https://app.contoso.com/callback" + } + }, + "responses": { + "202": { + "body": { + "status": "running", + "operationContext": "31130c66-2f86-41b5-af61-23850243e093" + } + }, + "400": { + "body": { + "error": { + "code": "400", + "message": "The request contains invalid data." + } + } + }, + "401": { + "body": { + "error": { + "code": "401", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "403", + "message": "User is not allowed to perform specified action." + } + } + }, + "404": { + "body": { + "error": { + "code": "404", + "message": "Resource not found on the server." + } + } + }, + "500": { + "body": { + "error": { + "code": "500", + "message": "Internal server error." + } + } + } + } +} diff --git a/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/ServerCalls_RemoveParticipant.json b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/ServerCalls_RemoveParticipant.json new file mode 100644 index 000000000000..1ab21f281dfd --- /dev/null +++ b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/ServerCalls_RemoveParticipant.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2021-06-15-preview", + "serverCallId": "aHR0cHM6Ly9jb252ZXJzYXRpb251cmwvdGVzdA", + "participantId": "d8b26c04-7186-41e2-971a-bdfa9a662a53" + }, + "responses": { + "202": {}, + "400": { + "body": { + "error": { + "code": "400", + "message": "The request contains invalid data." + } + } + }, + "401": { + "body": { + "error": { + "code": "401", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "403", + "message": "User is not allowed to perform specified action." + } + } + }, + "404": { + "body": { + "error": { + "code": "404", + "message": "Resource not found on the server." + } + } + }, + "500": { + "body": { + "error": { + "code": "500", + "message": "Internal server error." + } + } + } + } +} diff --git a/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/ServerCalls_ResumeRecording.json b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/ServerCalls_ResumeRecording.json new file mode 100644 index 000000000000..0015a5349313 --- /dev/null +++ b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/ServerCalls_ResumeRecording.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2021-06-15-preview", + "serverCallId": "aHR0cHM6Ly9jb252ZXJzYXRpb251cmwvdGVzdA", + "recordingId": "eyJQbGF0Zm9ybUVuZHBvaW50SWQiOiI3ZjQyNmI1OC03NTRmLTQ2M2UtYWRkMS0wNWFhNGNiYjliMzQiLCJSZXNvdXJjZVNwZWNpZmljSWQiOiJmNjMzODYwMS00MmE1LTRkMGUtODI3My01NjIwM2JhNzAzODYifQ" + }, + "responses": { + "200": {}, + "400": { + "body": { + "error": { + "code": "400", + "message": "The request contains invalid data." + } + } + }, + "401": { + "body": { + "error": { + "code": "401", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "403", + "message": "User is not allowed to perform specified action." + } + } + }, + "404": { + "body": { + "error": { + "code": "404", + "message": "Resource not found on the server." + } + } + }, + "500": { + "body": { + "error": { + "code": "500", + "message": "Internal server error." + } + } + } + } +} diff --git a/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/ServerCalls_StartRecording.json b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/ServerCalls_StartRecording.json new file mode 100644 index 000000000000..ac39cd68f62c --- /dev/null +++ b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/ServerCalls_StartRecording.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2021-06-15-preview", + "serverCallId": "aHR0cHM6Ly9jb252ZXJzYXRpb251cmwvdGVzdA", + "request": { + "recordingStateCallbackUri": "https://app.contoso.com/callback" + } + }, + "responses": { + "200": { + "body": { + "recordingId": "eyJQbGF0Zm9ybUVuZHBvaW50SWQiOiI3ZjQyNmI1OC03NTRmLTQ2M2UtYWRkMS0wNWFhNGNiYjliMzQiLCJSZXNvdXJjZVNwZWNpZmljSWQiOiJmNjMzODYwMS00MmE1LTRkMGUtODI3My01NjIwM2JhNzAzODYifQ" + } + }, + "400": { + "body": { + "error": { + "code": "400", + "message": "The request contains invalid data." + } + } + }, + "401": { + "body": { + "error": { + "code": "401", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "403", + "message": "User is not allowed to perform specified action." + } + } + }, + "404": { + "body": { + "error": { + "code": "404", + "message": "Resource not found on the server." + } + } + }, + "500": { + "body": { + "error": { + "code": "500", + "message": "Internal server error." + } + } + } + } +} diff --git a/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/ServerCalls_StopRecording.json b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/ServerCalls_StopRecording.json new file mode 100644 index 000000000000..0015a5349313 --- /dev/null +++ b/specification/communication/data-plane/CallingServer/preview/2021-06-15-preview/examples/ServerCalls_StopRecording.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2021-06-15-preview", + "serverCallId": "aHR0cHM6Ly9jb252ZXJzYXRpb251cmwvdGVzdA", + "recordingId": "eyJQbGF0Zm9ybUVuZHBvaW50SWQiOiI3ZjQyNmI1OC03NTRmLTQ2M2UtYWRkMS0wNWFhNGNiYjliMzQiLCJSZXNvdXJjZVNwZWNpZmljSWQiOiJmNjMzODYwMS00MmE1LTRkMGUtODI3My01NjIwM2JhNzAzODYifQ" + }, + "responses": { + "200": {}, + "400": { + "body": { + "error": { + "code": "400", + "message": "The request contains invalid data." + } + } + }, + "401": { + "body": { + "error": { + "code": "401", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "403", + "message": "User is not allowed to perform specified action." + } + } + }, + "404": { + "body": { + "error": { + "code": "404", + "message": "Resource not found on the server." + } + } + }, + "500": { + "body": { + "error": { + "code": "500", + "message": "Internal server error." + } + } + } + } +} diff --git a/specification/communication/data-plane/CallingServer/readme.csharp.md b/specification/communication/data-plane/CallingServer/readme.csharp.md new file mode 100644 index 000000000000..41ceb968d271 --- /dev/null +++ b/specification/communication/data-plane/CallingServer/readme.csharp.md @@ -0,0 +1,15 @@ +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true + client-side-validation: false + namespace: Microsoft.CommunicationServices + output-folder: $(csharp-sdks-folder)/communicationservices/management/Microsoft.CommunicationServices/GeneratedProtocol +``` diff --git a/specification/communication/data-plane/CallingServer/readme.md b/specification/communication/data-plane/CallingServer/readme.md new file mode 100644 index 000000000000..59b9562ec823 --- /dev/null +++ b/specification/communication/data-plane/CallingServer/readme.md @@ -0,0 +1,55 @@ +# communicationservices + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for communicationservices. + +## 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 communicationservices. + +```yaml +openapi-type: data-plane +tag: package-2021-06-15-preview +``` + +### Tag: package-2021-06-15-preview + +These settings apply only when `--tag=package-2021-06-15-preview` is specified on the command line. + +```yaml $(tag) == 'package-2021-06-15-preview' +input-file: + - preview/2021-06-15-preview/communicationservicescallingserver.json +title: + Azure Communication Services +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) + diff --git a/specification/communication/data-plane/Chat/preview/2021-04-05-preview6/communicationserviceschat.json b/specification/communication/data-plane/Chat/preview/2021-04-05-preview6/communicationserviceschat.json index 667c70287e62..09ddac82e7bc 100644 --- a/specification/communication/data-plane/Chat/preview/2021-04-05-preview6/communicationserviceschat.json +++ b/specification/communication/data-plane/Chat/preview/2021-04-05-preview6/communicationserviceschat.json @@ -537,68 +537,6 @@ } } }, - "/chat/threads/{chatThreadId}/typing": { - "post": { - "tags": [ - "Messages" - ], - "summary": "Posts a typing event to a thread, on behalf of a user.", - "operationId": "ChatThread_SendTypingNotification", - "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." - }, - "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" - } - } - } - }, "/chat/threads/{chatThreadId}/participants": { "get": { "tags": [ @@ -1183,6 +1121,80 @@ } } } + }, + "/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", + "application/merge-patch+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": { @@ -1665,6 +1677,17 @@ "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": { diff --git a/specification/communication/data-plane/Chat/preview/2021-04-05-preview6/examples/Messages_SendTypingNotification.json b/specification/communication/data-plane/Chat/preview/2021-04-05-preview6/examples/Messages_SendTypingNotification.json index c49f8efc76e7..5c1b7831993d 100644 --- a/specification/communication/data-plane/Chat/preview/2021-04-05-preview6/examples/Messages_SendTypingNotification.json +++ b/specification/communication/data-plane/Chat/preview/2021-04-05-preview6/examples/Messages_SendTypingNotification.json @@ -2,7 +2,10 @@ "parameters": { "endpoint": "https://contoso.westus.communications.azure.com", "api-version": "2021-04-05-preview6", - "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345" + "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "sendTypingNotificationRequest": { + "senderDisplayName": "Jane" + } }, "responses": { "200": {}, diff --git a/specification/communication/data-plane/SipRouting/preview/2021-05-01-preview/communicationservicessiprouting.json b/specification/communication/data-plane/SipRouting/preview/2021-05-01-preview/communicationservicessiprouting.json new file mode 100644 index 000000000000..f50f588232fd --- /dev/null +++ b/specification/communication/data-plane/SipRouting/preview/2021-05-01-preview/communicationservicessiprouting.json @@ -0,0 +1,259 @@ +{ + "swagger": "2.0", + "info": { + "title": "SipRouting Service", + "description": "SipRouting Service", + "contact": { + "email": "acsdevexdisc@microsoft.com" + }, + "version": "2021-05-01-preview" + }, + "paths": { + "/sip": { + "get": { + "tags": [ + "SipConfiguration" + ], + "summary": "Gets SIP configuration for resource.", + "operationId": "GetSipConfiguration", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok.", + "schema": { + "$ref": "#/definitions/SipConfiguration" + } + }, + "default": { + "description": "Failure", + "schema": { + "$ref": "../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get SIP configuration for resource": { + "$ref": "./examples/GetSipConfiguration.json" + } + } + }, + "patch": { + "tags": [ + "SipConfiguration" + ], + "summary": "Patches SIP configuration for resource.", + "operationId": "PatchSipConfiguration", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Configuration patch.", + "schema": { + "$ref": "#/definitions/SipConfigurationPatch" + } + } + ], + "responses": { + "200": { + "description": "Patched configuration is returned.", + "schema": { + "$ref": "#/definitions/SipConfiguration" + } + }, + "415": { + "description": "Unsupported media type of the patch.", + "schema": { + "$ref": "../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "422": { + "description": "If the request is empty, unprocessable or inconsistent with the stored data.", + "schema": { + "$ref": "../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "500": { + "description": "All other api errors.", + "schema": { + "$ref": "../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "default": { + "description": "Failure", + "schema": { + "$ref": "../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Patch SIP configuration for resource": { + "$ref": "./examples/PatchSipConfiguration.json" + } + } + } + } + }, + "definitions": { + "Trunk": { + "description": "Represents a SIP trunk for routing calls. See RFC 4904.", + "required": [ + "sipSignalingPort" + ], + "type": "object", + "properties": { + "sipSignalingPort": { + "format": "int32", + "description": "Gets or sets SIP signaling port of the trunk.", + "type": "integer" + } + } + }, + "TrunkPatch": { + "description": "Represents a SIP trunk patch.", + "type": "object", + "properties": { + "sipSignalingPort": { + "format": "int32", + "description": "Gets or sets SIP signaling port of the trunk.", + "type": "integer" + } + } + }, + "TrunkRoute": { + "description": "Represents a trunk route for routing calls.", + "required": [ + "name", + "numberPattern" + ], + "type": "object", + "properties": { + "description": { + "description": "Gets or sets description of the route.", + "maxLength": 1024, + "type": "string" + }, + "name": { + "description": "Gets or sets name of the route.", + "maxLength": 256, + "type": "string" + }, + "numberPattern": { + "description": "Gets or sets regex number pattern for routing calls. .NET regex format is supported.\r\nThe regex should match only digits with an optional '+' prefix without spaces.\r\nI.e. \"^\\+[1-9][0-9]{3,23}$\".", + "maxLength": 1024, + "type": "string" + }, + "trunks": { + "description": "Gets or sets list of SIP trunks for routing calls. Trunks are represented as FQDN.", + "maxLength": 250, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SipConfiguration": { + "description": "Represents a SIP configuration.\r\nWhen a call is being routed the routes are applied in the same order as in the routes list.\r\nA route is matched by its number pattern.\r\nCall is then directed into route's first available trunk, based on the order in the route's trunks list.", + "type": "object", + "properties": { + "trunks": { + "description": "SIP trunks for routing calls.\r\nMap key is trunk's FQDN (1-249 characters).", + "maxLength": 250, + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/Trunk" + } + }, + "routes": { + "description": "Trunk routes for routing calls.", + "maxLength": 250, + "type": "array", + "items": { + "$ref": "#/definitions/TrunkRoute" + } + } + } + }, + "SipConfigurationPatch": { + "description": "Represents a SIP configuration patch.", + "type": "object", + "properties": { + "trunks": { + "description": "SIP trunks for routing calls.\r\nMap key is trunk's FQDN (1-249 characters).", + "maxLength": 250, + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/TrunkPatch" + } + }, + "routes": { + "description": "Trunk routes for routing calls.", + "maxLength": 250, + "type": "array", + "items": { + "$ref": "#/definitions/TrunkRoute" + } + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "in": "query", + "name": "api-version", + "description": "Version of API to invoke", + "required": true, + "type": "string" + }, + "Endpoint": { + "in": "path", + "name": "endpoint", + "description": "The communication resource, for example https://resourcename.communication.azure.com", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + } + }, + "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" + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + } +} diff --git a/specification/communication/data-plane/SipRouting/preview/2021-05-01-preview/examples/GetSipConfiguration.json b/specification/communication/data-plane/SipRouting/preview/2021-05-01-preview/examples/GetSipConfiguration.json new file mode 100644 index 000000000000..a1d81517a88a --- /dev/null +++ b/specification/communication/data-plane/SipRouting/preview/2021-05-01-preview/examples/GetSipConfiguration.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2021-05-01-preview", + "endpoint": "https://resourcename.communication.azure.com/" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "trunks": { + "vendor.xyz.biz": { + "sipSignalingPort": 5061 + }, + "vendor.abc.biz": { + "sipSignalingPort": 5061 + } + }, + "routes": [ + { + "name": "LocalRoute", + "numberPattern": "^\\+1[0-9]{10}$" + }, + { + "name": "VendorXYZ", + "description": "External route XYZ", + "numberPattern": "^\\+?\\d+$", + "trunks": [ + "vendor.xyz.biz" + ] + } + ] + } + } + } +} diff --git a/specification/communication/data-plane/SipRouting/preview/2021-05-01-preview/examples/PatchSipConfiguration.json b/specification/communication/data-plane/SipRouting/preview/2021-05-01-preview/examples/PatchSipConfiguration.json new file mode 100644 index 000000000000..ba703fcfde76 --- /dev/null +++ b/specification/communication/data-plane/SipRouting/preview/2021-05-01-preview/examples/PatchSipConfiguration.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2021-05-01-preview", + "body": { + "trunks": { + "vendor.xyz.biz": { + "sipSignalingPort": 5061 + } + }, + "routes": [ + { + "name": "VendorXYZ", + "description": "External route XYZ", + "numberPattern": "^\\+?\\d+$", + "trunks": [ + "vendor.xyz.biz" + ] + } + ] + }, + "endpoint": "https://resourcename.communication.azure.com/" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "trunks": { + "vendor.xyz.biz": { + "sipSignalingPort": 5061 + } + }, + "routes": [ + { + "name": "VendorXYZ", + "description": "External route XYZ", + "numberPattern": "^\\+?\\d+$", + "trunks": [ + "vendor.xyz.biz" + ] + } + ] + } + }, + "415": { + "headers": {}, + "body": { + "error": { + "code": "UnsupportedMediaType", + "message": "Unsupported Media Type." + } + } + }, + "422": { + "headers": {}, + "body": { + "error": { + "code": "UnprocessableEntity", + "message": "One or more request inputs are not valid.", + "innererror": { + "code": "InvalidRegex", + "message": "Unsupported regex format provided." + } + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "InternalError", + "message": "The server encountered an internal error." + } + } + } + } +} diff --git a/specification/communication/data-plane/SipRouting/readme.csharp.md b/specification/communication/data-plane/SipRouting/readme.csharp.md new file mode 100644 index 000000000000..2efd3715cdc3 --- /dev/null +++ b/specification/communication/data-plane/SipRouting/readme.csharp.md @@ -0,0 +1,15 @@ +## C + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true + client-side-validation: false + namespace: Microsoft.CommunicationServices + output-folder: $(csharp-sdks-folder)/communicationservices/management/Microsoft.CommunicationServices/GeneratedProtocol +``` diff --git a/specification/communication/data-plane/SipRouting/readme.md b/specification/communication/data-plane/SipRouting/readme.md new file mode 100644 index 000000000000..0cc6817ee49d --- /dev/null +++ b/specification/communication/data-plane/SipRouting/readme.md @@ -0,0 +1,66 @@ +# communicationservices + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for communicationservices. + +## 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 communicationservices. + +```yaml +openapi-type: data-plane +tag: package-2021-05-01-preview +``` + +### Tag: package-2021-05-01-preview + +These settings apply only when `--tag=package-2021-05-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2021-05-01-preview' +input-file: + - preview/2021-05-01-preview/communicationservicessiprouting.json +title: + Azure Communication Services +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Ruby + +See configuration in [readme.ruby.md](./readme.ruby.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) diff --git a/specification/communication/data-plane/SipRouting/readme.python.md b/specification/communication/data-plane/SipRouting/readme.python.md new file mode 100644 index 000000000000..f5192ef154c3 --- /dev/null +++ b/specification/communication/data-plane/SipRouting/readme.python.md @@ -0,0 +1,21 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +```yaml $(python) +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: Microsoft.CommunicationServices + package-name: communicationservices + package-version: 2021-05-01-preview + clear-output-folder: true +``` + +```yaml $(python) +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt/communicationservices +``` diff --git a/specification/communication/data-plane/SipRouting/readme.ruby.md b/specification/communication/data-plane/SipRouting/readme.ruby.md new file mode 100644 index 000000000000..3e261aae6a2e --- /dev/null +++ b/specification/communication/data-plane/SipRouting/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_communicationservices +package-version: 2021-05-01-preview +azure-arm: true +``` + +### Tag: package-2021-05-01-preview and ruby + +These settings apply only when `--tag=package-2021-05-01-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +```yaml $(tag) == 'package-2021-05-01-preview' && $(ruby) +namespace: Microsoft.CommunicationServices +output-folder: $(ruby-sdks-folder)/communicationservices +``` diff --git a/specification/communication/data-plane/SipRouting/readme.typescript.md b/specification/communication/data-plane/SipRouting/readme.typescript.md new file mode 100644 index 000000000000..be9f877fd1c2 --- /dev/null +++ b/specification/communication/data-plane/SipRouting/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: "communicationservices" + output-folder: "$(typescript-sdks-folder)/packages/communicationservices" + payload-flattening-threshold: 1 + generate-metadata: true +``` diff --git a/specification/communication/data-plane/Turn/preview/2021-02-22-preview1/CommunicationTurn.json b/specification/communication/data-plane/Turn/preview/2021-02-22-preview1/CommunicationTurn.json index 462437eca5d9..90274733cebf 100644 --- a/specification/communication/data-plane/Turn/preview/2021-02-22-preview1/CommunicationTurn.json +++ b/specification/communication/data-plane/Turn/preview/2021-02-22-preview1/CommunicationTurn.json @@ -38,7 +38,7 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/CommunicationTurnCredentialsResponse" + "$ref": "#/definitions/CommunicationRelayConfiguration" } } }, @@ -77,8 +77,8 @@ } } }, - "CommunicationTurnCredentialsResponse": { - "description": "A TURN credentials response.", + "CommunicationRelayConfiguration": { + "description": "A relay configuration containing the TURN URLs and credentials.", "required": [ "expiresOn", "turnServers" @@ -106,6 +106,9 @@ "name": "api-version", "description": "Version of API to invoke.", "required": true, + "enum": [ + "2021-02-22-preview1" + ], "type": "string" } }, diff --git a/specification/communication/data-plane/Turn/preview/2021-06-21-preview/CommunicationTurn.json b/specification/communication/data-plane/Turn/preview/2021-06-21-preview/CommunicationTurn.json new file mode 100644 index 000000000000..e80c4cf07de8 --- /dev/null +++ b/specification/communication/data-plane/Turn/preview/2021-06-21-preview/CommunicationTurn.json @@ -0,0 +1,157 @@ +{ + "swagger": "2.0", + "info": { + "title": "CommunicationNetworkingClient", + "description": "Azure Communication Networking Service", + "version": "2021-06-21-preview" + }, + "paths": { + "/networktraversal/:issueRelayConfiguration": { + "post": { + "tags": [ + "Turn" + ], + "summary": "Issue a configuration for an STUN/TURN server for an existing identity.", + "operationId": "CommunicationNetworkTraversal_IssueRelayConfiguration", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CommunicationRelayConfigurationRequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CommunicationRelayConfiguration" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "Issue Relay Configuration": { + "$ref": "./examples/IssueRelayConfiguration.json" + } + } + } + } + }, + "definitions": { + "CommunicationRelayConfigurationRequest": { + "description": "Request for a CommunicationRelayConfiguration.", + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "description": "An existing ACS identity.", + "type": "string" + } + } + }, + "CommunicationIceServer": { + "description": "An instance of a STUN/TURN server with credentials to be used for ICE negotiation.", + "required": [ + "credential", + "urls", + "username" + ], + "type": "object", + "properties": { + "urls": { + "description": "List of STUN/TURN server URLs.", + "type": "array", + "items": { + "type": "string" + } + }, + "username": { + "description": "User account name which uniquely identifies the credentials.", + "type": "string" + }, + "credential": { + "description": "Credential for the server.", + "type": "string" + } + } + }, + "CommunicationRelayConfiguration": { + "description": "A relay configuration containing the STUN/TURN URLs and credentials.", + "required": [ + "expiresOn", + "iceServers" + ], + "type": "object", + "properties": { + "expiresOn": { + "format": "date-time", + "description": "The date for which the username and credentials are not longer valid.", + "type": "string" + }, + "iceServers": { + "description": "An array representing the credentials and the STUN/TURN server URLs for use in ICE negotiations.", + "type": "array", + "items": { + "$ref": "#/definitions/CommunicationIceServer" + } + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "in": "query", + "name": "api-version", + "description": "Version of API to invoke.", + "required": true, + "enum": [ + "2021-06-21-preview" + ], + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "description": "The communication resource, for example https://my-resource.communication.azure.com", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + } + ] + } +} diff --git a/specification/communication/data-plane/Turn/preview/2021-06-21-preview/examples/IssueRelayConfiguration.json b/specification/communication/data-plane/Turn/preview/2021-06-21-preview/examples/IssueRelayConfiguration.json new file mode 100644 index 000000000000..2f9afc180120 --- /dev/null +++ b/specification/communication/data-plane/Turn/preview/2021-06-21-preview/examples/IssueRelayConfiguration.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2021-06-21-preview", + "content-type": "application/json", + "body": { + "id": "8:acs:2dee53b4-368b-45b4-ab52-8493fb117652_00000005-14a2-493b-8a72-5a3a0d000081" + }, + "endpoint": "https://my-resource.communication.azure.com" + }, + "responses": { + "200": { + "body": { + "expiresOn": "2020-09-10T21:39:39.3244584+00:00", + "iceServers": [ + { + "urls": [ + "turn:131.107.255.255:3478" + ], + "username": "AgAAJNOeygwB1uVGvuwAVMHV4PLhYDgY66Fg1dUZvQ4AAAAEhXrhc8uJFjOK8lxEsZk3KIpWxc0=", + "credential": "9rl8ablFWj6/aqSuPLgLykLZKqw=" + } + ] + } + } + } +} diff --git a/specification/communication/data-plane/Turn/readme.md b/specification/communication/data-plane/Turn/readme.md index ef1a1f47ba50..7c074acdd7ff 100644 --- a/specification/communication/data-plane/Turn/readme.md +++ b/specification/communication/data-plane/Turn/readme.md @@ -40,6 +40,15 @@ title: Azure Communication Services ``` +### Tag: package-2021-06-21-preview + +These settings apply only when `--tag=package-2021-06-21-preview` is specified on the command line. + +```yaml $(tag) == 'package-2021-06-21-preview' +input-file: + - preview/2021-06-21-preview/CommunicationTurn.json +``` + --- # Code Generation diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json index 29037dce4c85..302987076754 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json @@ -8149,7 +8149,7 @@ }, "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. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types", + "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. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types", "enum": [ "Standard_LRS", "Premium_LRS", @@ -8201,7 +8201,7 @@ "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." + "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." }, "diskEncryptionSet": { "$ref": "#/definitions/DiskEncryptionSetParameters", diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/compute.json index 9125b984da8d..63a425f0fdcd 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/compute.json @@ -8939,7 +8939,7 @@ }, "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/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types", + "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. 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/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types", "enum": [ "Standard_LRS", "Premium_LRS", @@ -8993,7 +8993,7 @@ "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." + "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." }, "diskEncryptionSet": { "$ref": "#/definitions/DiskEncryptionSetParameters", @@ -9186,7 +9186,7 @@ ], "x-ms-enum": { "name": "SecurityTypes", - "modelAsString": false + "modelAsString": true } } }, diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/disk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/disk.json index 17e3b33cf33e..d88c793f8e2b 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/disk.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/disk.json @@ -251,6 +251,11 @@ "description": "If the disk is deleted, this is an expected error code." } }, + "x-ms-examples": { + "Delete a managed disk.": { + "$ref": "./examples/DeleteAManagedDisk.json" + } + }, "x-ms-long-running-operation": true } }, @@ -364,6 +369,11 @@ "description": "Accepted" } }, + "x-ms-examples": { + "Get a sas on a managed disk.": { + "$ref": "./examples/BeginGetAccessManagedDisk.json" + } + }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" @@ -399,6 +409,11 @@ "description": "Accepted" } }, + "x-ms-examples": { + "Revoke access to a managed disk.": { + "$ref": "./examples/EndGetAccessManagedDisk.json" + } + }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" @@ -505,6 +520,11 @@ } } }, + "x-ms-examples": { + "Update a snapshot.": { + "$ref": "./examples/UpdateASnapshot.json" + } + }, "x-ms-long-running-operation": true }, "get": { @@ -572,6 +592,11 @@ "description": "If the snapshot is deleted, this is an expected error code." } }, + "x-ms-examples": { + "Delete a snapshot.": { + "$ref": "./examples/DeleteASnapshot.json" + } + }, "x-ms-long-running-operation": true } }, @@ -685,6 +710,11 @@ "description": "Accepted" } }, + "x-ms-examples": { + "Get a sas on a snapshot.": { + "$ref": "./examples/BeginGetAccessSnapshot.json" + } + }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" @@ -720,6 +750,11 @@ "description": "Accepted" } }, + "x-ms-examples": { + "Revoke access to a snapshot.": { + "$ref": "./examples/EndGetAccessSnapshot.json" + } + }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" @@ -1668,6 +1703,122 @@ "nextLinkName": "nextLink" } } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{vmRestorePointName}/diskRestorePoints/{diskRestorePointName}/beginGetAccess": { + "post": { + "tags": [ + "IncrementalRestorePoints" + ], + "operationId": "DiskRestorePoint_GrantAccess", + "description": "Grants access to a diskRestorePoint.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RestorePointCollectionNameParameter" + }, + { + "$ref": "#/parameters/VmRestorePointNameParameter" + }, + { + "$ref": "#/parameters/DiskRestorePointNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "grantAccessData", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GrantAccessData" + }, + "description": "Access data object supplied in the body of the get disk access operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AccessUri" + } + }, + "202": { + "description": "Accepted" + }, + "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": { + "Grants access to a diskRestorePoint.": { + "$ref": "./examples/BeginGetAccessDiskRestorePoint.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{vmRestorePointName}/diskRestorePoints/{diskRestorePointName}/endGetAccess": { + "post": { + "tags": [ + "IncrementalRestorePoints" + ], + "operationId": "DiskRestorePoint_RevokeAccess", + "description": "Revokes access to a diskRestorePoint.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RestorePointCollectionNameParameter" + }, + { + "$ref": "#/parameters/VmRestorePointNameParameter" + }, + { + "$ref": "#/parameters/DiskRestorePointNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "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": { + "Revokes access to a diskRestorePoint.": { + "$ref": "./examples/EndGetAccessDiskRestorePoint.json" + } + } + } } }, "definitions": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/examples/BeginGetAccessDiskRestorePoint.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/examples/BeginGetAccessDiskRestorePoint.json new file mode 100644 index 000000000000..39574d184aa7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/examples/BeginGetAccessDiskRestorePoint.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "restorePointCollectionName": "rpc", + "vmRestorePointName": "vmrp", + "diskRestorePointName": "TestDisk45ceb03433006d1baee0_b70cd924-3362-4a80-93c2-9415eaa12745", + "api-version": "2020-12-01", + "grantAccessData": { + "access": "Read", + "durationInSeconds": 300 + } + }, + "responses": { + "200": { + "body": { + "accessSAS": "https://md-gpvmcxzlzxgd.partition.blob.storage.azure.net/xx3cqcx53f0v/abcd?sv=2014-02-14&sr=b&sk=key1&sig=XXX&st=2021-05-24T18:02:34Z&se=2021-05-24T18:19:14Z&sp=r" + } + }, + "202": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/examples/BeginGetAccessManagedDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/examples/BeginGetAccessManagedDisk.json new file mode 100644 index 000000000000..d3468610efd4 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/examples/BeginGetAccessManagedDisk.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "diskName": "myDisk", + "api-version": "2020-12-01", + "grantAccessData": { + "access": "Read", + "durationInSeconds": 300 + } + }, + "responses": { + "200": { + "body": { + "accessSAS": "https://md-gpvmcxzlzxgd.partition.blob.storage.azure.net/xx3cqcx53f0v/abcd?sv=2014-02-14&sr=b&sk=key1&sig=XXX&st=2021-05-24T18:02:34Z&se=2021-05-24T18:19:14Z&sp=r" + } + }, + "202": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/examples/BeginGetAccessSnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/examples/BeginGetAccessSnapshot.json new file mode 100644 index 000000000000..08eb6fbf141f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/examples/BeginGetAccessSnapshot.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "snapshotName": "mySnapshot", + "api-version": "2020-12-01", + "grantAccessData": { + "access": "Read", + "durationInSeconds": 300 + } + }, + "responses": { + "200": { + "body": { + "accessSAS": "https://md-gpvmcxzlzxgd.partition.blob.storage.azure.net/xx3cqcx53f0v/abcd?sv=2014-02-14&sr=b&sk=key1&sig=XXX&st=2021-05-24T18:02:34Z&se=2021-05-24T18:19:14Z&sp=r" + } + }, + "202": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/examples/DeleteAManagedDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/examples/DeleteAManagedDisk.json new file mode 100644 index 000000000000..bf0cc769ef69 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/examples/DeleteAManagedDisk.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "diskName": "myDisk", + "api-version": "2020-12-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/examples/DeleteASnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/examples/DeleteASnapshot.json new file mode 100644 index 000000000000..a4531262115f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/examples/DeleteASnapshot.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "snapshotName": "mySnapshot", + "api-version": "2020-12-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/examples/EndGetAccessDiskRestorePoint.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/examples/EndGetAccessDiskRestorePoint.json new file mode 100644 index 000000000000..2527d728d056 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/examples/EndGetAccessDiskRestorePoint.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "restorePointCollectionName": "rpc", + "vmRestorePointName": "vmrp", + "diskRestorePointName": "TestDisk45ceb03433006d1baee0_b70cd924-3362-4a80-93c2-9415eaa12745", + "api-version": "2020-12-01" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/examples/EndGetAccessManagedDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/examples/EndGetAccessManagedDisk.json new file mode 100644 index 000000000000..68e1820621d8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/examples/EndGetAccessManagedDisk.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "diskName": "myDisk", + "api-version": "2020-12-01" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/examples/EndGetAccessSnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/examples/EndGetAccessSnapshot.json new file mode 100644 index 000000000000..29fe90a3dc5f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/examples/EndGetAccessSnapshot.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "snapshotName": "mySnapshot", + "api-version": "2020-12-01" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/examples/UpdateASnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/examples/UpdateASnapshot.json new file mode 100644 index 000000000000..411ba6166e8b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/examples/UpdateASnapshot.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "snapshotName": "mySnapshot", + "api-version": "2020-12-01", + "snapshot": { + "properties": { + "diskSizeGB": 20 + }, + "tags": { + "department": "Development", + "project": "UpdateSnapshots" + } + } + }, + "responses": { + "202": { + "body": { + "properties": { + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "diskSizeGB": 20, + "provisioningState": "Updating" + }, + "tags": { + "department": "Development", + "project": "UpdateSnapshots" + }, + "location": "West US", + "name": "mySnapshot" + } + }, + "200": { + "body": { + "properties": { + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "diskSizeGB": 20, + "provisioningState": "Succeeded" + }, + "tags": { + "department": "Development", + "project": "UpdateSnapshots" + }, + "location": "West US", + "name": "mySnapshot" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/compute.json index 5cfd2ded350b..4bba7558ffa9 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/compute.json @@ -7538,6 +7538,10 @@ "securityProfile": { "$ref": "#/definitions/SecurityProfile", "description": "Gets the security profile." + }, + "location": { + "type": "string", + "description": "Location of the VM from which the restore point was created." } }, "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." @@ -7657,6 +7661,28 @@ }, "RestorePoint": { "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RestorePointProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Restore Point details." + }, + "RestorePointProperties": { + "type": "object", + "properties": { + "excludeDisks": { + "type": "array", + "items": { + "$ref": "#/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": { "readOnly": true, "$ref": "#/definitions/RestorePointSourceMetadata", @@ -7685,21 +7711,9 @@ "$ref": "#/definitions/RestorePointProvisioningDetails", "readOnly": true, "description": "Gets the provisioning details set by the server during Create restore point operation." - }, - "excludeDisks": { - "type": "array", - "items": { - "$ref": "#/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." } }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "description": "Restore Point details." + "description": "The restore point properties." }, "ComputeOperationListResult": { "properties": { @@ -9764,7 +9778,7 @@ }, "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", + "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. 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", @@ -9818,7 +9832,7 @@ "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." + "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." }, "diskEncryptionSet": { "$ref": "#/definitions/DiskEncryptionSetParameters", @@ -10019,7 +10033,7 @@ ], "x-ms-enum": { "name": "SecurityTypes", - "modelAsString": false + "modelAsString": true } } }, @@ -10093,7 +10107,7 @@ }, "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\":\"\"
}" + "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)." } }, "description": "Describes Protocol and thumbprint of Windows Remote Management listener" @@ -10192,7 +10206,7 @@ "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\":\"\"
}" + "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", @@ -10248,7 +10262,7 @@ "items": { "$ref": "#/definitions/VaultSecretGroup" }, - "description": "Specifies set of certificates that should be installed onto the virtual machine." + "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", @@ -10397,7 +10411,7 @@ }, "PublicIPAddressSku": { "properties": { - "publicIPAddressSkuName": { + "name": { "type": "string", "description": "Specify public IP sku name", "enum": [ @@ -10409,7 +10423,7 @@ "modelAsString": true } }, - "publicIPAddressSkuTier": { + "tier": { "type": "string", "description": "Specify public IP sku tier", "enum": [ @@ -10422,9 +10436,6 @@ } } }, - "required": [ - "publicIPAddressSkuName" - ], "description": "Describes the public IP Sku" }, "VirtualMachinePublicIPAddressConfiguration": { @@ -11550,7 +11561,7 @@ "items": { "$ref": "#/definitions/VaultSecretGroup" }, - "description": "Specifies set of certificates that should be installed onto the virtual machines in the scale set." + "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)." } }, "description": "Describes a virtual machine scale set OS profile." diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/CreateARestorePoint.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/CreateARestorePoint.json index 3053bee70ba9..0e147d3d62db 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/CreateARestorePoint.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/CreateARestorePoint.json @@ -4,14 +4,15 @@ "resourceGroupName": "myResourceGroup", "restorePointCollectionName": "rpcName", "restorePointName": "rpName", - "vmName": "myVM", "api-version": "2021-03-01", "parameters": { - "excludeDisks": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vm8768_disk2_fe6ffde4f69b491ca33fb984d5bcd89f" - } - ] + "properties": { + "excludeDisks": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123" + } + ] + } } }, "responses": { @@ -19,69 +20,72 @@ "body": { "name": "rpName", "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName", - "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" - } + "properties": { + "excludeDisks": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123" + } + ], + "sourceMetadata": { + "vmId": "76d6541e-80bd-4dc1-932b-3cae4cfb80e7", + "hardwareProfile": { + "vmSize": "Standard_B1s" }, - "dataDisks": [ - { - "lun": 1, - "name": "testingexcludedisk_DataDisk_1", - "caching": "None", + "storageProfile": { + "osDisk": { + "osType": "Windows", + "name": "osDisk123", + "caching": "ReadWrite", "managedDisk": { "storageAccountType": "Standard_LRS", - "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/disks/testingexcludedisk_DataDisk_1" + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/osDisk123" }, "diskRestorePoint": { - "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/testingexcludedisk_DataDisk_1_68785190-1acb-4d5e-a8ae-705b45f3dca5" + "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" + } } + ] + }, + "osProfile": { + "computerName": "computerName", + "adminUsername": "admin", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + }, + "secrets": [], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true } - ] - }, - "osProfile": { - "computerName": "computerName", - "adminUsername": "admin", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true }, - "secrets": [], - "allowExtensionOperations": true, - "requireGuestProvisionSignal": true + "location": "westus" }, - "diagnosticsProfile": { - "bootDiagnostics": { - "enabled": true - } + "provisioningState": "Succeeded", + "consistencyMode": "ApplicationConsistent", + "provisioningDetails": { + "creationTime": "2021-01-27T20:35:05.8401519+00:00", + "totalUsedSizeInBytes": 10835349504, + "statusCode": 0, + "statusMessage": "{\"jobMessage\":\"\",\"messageStr\":\"1/27/2021 8:35:56 PM , snapshotCreator=guestExtension, hostStatusCodePreSnapshot=200, Plugin enable Succeeded (command: Snapshot) Snapshot command completed \",\"snapshotConsistency\":2}" } - }, - "provisioningState": "Succeeded", - "consistencyMode": "ApplicationConsistent", - "provisioningDetails": { - "creationTime": "2021-01-27T20:35:05.8401519+00:00", - "totalUsedSizeInBytes": 10835349504, - "statusCode": 0, - "statusMessage": "{\"jobMessage\":\"\",\"messageStr\":\"1/27/2021 8:35:56 PM , snapshotCreator=guestExtension, hostStatusCodePreSnapshot=200, Plugin enable Succeeded (command: Snapshot) Snapshot command completed \",\"snapshotConsistency\":2}" - }, - "excludeDisks": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vm8768_disk2_fe6ffde4f69b491ca33fb984d5bcd89f" - } - ] + } } } } diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/CreateAVmWithNetworkInterfaceConfiguration.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/CreateAVmWithNetworkInterfaceConfiguration.json index 75cb4f765ab2..088045553d1a 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/CreateAVmWithNetworkInterfaceConfiguration.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/CreateAVmWithNetworkInterfaceConfiguration.json @@ -42,8 +42,8 @@ "publicIPAddressConfiguration": { "name": "{publicIP-config-name}", "sku": { - "publicIPAddressSkuName": "Basic", - "publicIPAddressSkuTier": "Global" + "name": "Basic", + "tier": "Global" }, "properties": { "deleteOption": "Detach", diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetRestorePoint.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetRestorePoint.json index e10b1fa5653f..989bc1353c3b 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetRestorePoint.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetRestorePoint.json @@ -11,69 +11,72 @@ "body": { "name": "rpName", "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName", - "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" - } + "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" }, - "dataDisks": [ - { - "lun": 1, - "name": "testingexcludedisk_DataDisk_1", - "caching": "None", + "storageProfile": { + "osDisk": { + "osType": "Windows", + "name": "testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f", + "caching": "ReadWrite", "managedDisk": { "storageAccountType": "Standard_LRS", - "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/disks/testingexcludedisk_DataDisk_1" + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f" }, "diskRestorePoint": { - "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/testingexcludedisk_DataDisk_1_68785190-1acb-4d5e-a8ae-705b45f3dca5" + "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" + } } + ] + }, + "osProfile": { + "computerName": "computerName", + "adminUsername": "admin", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + }, + "secrets": [], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true } - ] - }, - "osProfile": { - "computerName": "computerName", - "adminUsername": "admin", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true }, - "secrets": [], - "allowExtensionOperations": true, - "requireGuestProvisionSignal": true + "location": "westus" }, - "diagnosticsProfile": { - "bootDiagnostics": { - "enabled": true - } - } - }, - "provisioningState": "Succeeded", - "consistencyMode": "ApplicationConsistent", - "provisioningDetails": { - "creationTime": "2021-01-27T20:35:05.8401519+00:00", - "totalUsedSizeInBytes": 10835349504, - "statusCode": 0, - "statusMessage": "{\"jobMessage\":\"\",\"messageStr\":\"1/27/2021 8:35:56 PM , snapshotCreator=guestExtension, hostStatusCodePreSnapshot=200, Plugin enable Succeeded (command: Snapshot) Snapshot command completed \",\"snapshotConsistency\":2}" - }, - "excludeDisks": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vm8768_disk2_fe6ffde4f69b491ca33fb984d5bcd89f" + "provisioningState": "Succeeded", + "consistencyMode": "ApplicationConsistent", + "provisioningDetails": { + "creationTime": "2021-01-27T20:35:05.8401519+00:00", + "totalUsedSizeInBytes": 10835349504, + "statusCode": 0, + "statusMessage": "{\"jobMessage\":\"\",\"messageStr\":\"1/27/2021 8:35:56 PM , snapshotCreator=guestExtension, hostStatusCodePreSnapshot=200, Plugin enable Succeeded (command: Snapshot) Snapshot command completed \",\"snapshotConsistency\":2}" } - ] + } } } } diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetRestorePointCollection.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetRestorePointCollection.json index 63cf8efb6ca6..4d2f9a04c3ef 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetRestorePointCollection.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetRestorePointCollection.json @@ -11,7 +11,7 @@ "name": "myRpc", "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc", "type": "Microsoft.Compute/restorePointCollections", - "location": "West US", + "location": "westus", "tags": { "myTag1": "tagValue1" }, diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetRestorePointCollectionWithContainedRestorePoints.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetRestorePointCollectionWithContainedRestorePoints.json index 4aa7fc88b198..fcdefbc18c78 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetRestorePointCollectionWithContainedRestorePoints.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetRestorePointCollectionWithContainedRestorePoints.json @@ -12,7 +12,7 @@ "name": "rpcName", "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName", "type": "Microsoft.Compute/restorePointCollections", - "location": "West US", + "location": "westus", "tags": { "myTag1": "tagValue1" }, @@ -27,69 +27,72 @@ { "name": "restorePointName", "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName", - "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" - } + "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" }, - "dataDisks": [ - { - "lun": 1, - "name": "testingexcludedisk_DataDisk_1", - "caching": "None", + "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_DataDisk_1" + "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_DataDisk_1_68785190-1acb-4d5e-a8ae-705b45f3dca5" + "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" + } } + ] + }, + "osProfile": { + "computerName": "computerName", + "adminUsername": "admin", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + }, + "secrets": [], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true } - ] - }, - "osProfile": { - "computerName": "computerName", - "adminUsername": "admin", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true }, - "secrets": [], - "allowExtensionOperations": true, - "requireGuestProvisionSignal": true + "location": "westus" }, - "diagnosticsProfile": { - "bootDiagnostics": { - "enabled": true - } - } - }, - "provisioningState": "Succeeded", - "consistencyMode": "ApplicationConsistent", - "provisioningDetails": { - "creationTime": "2021-01-27T20:35:05.8401519+00:00", - "totalUsedSizeInBytes": 10835349504, - "statusCode": 0, - "statusMessage": "{\"jobMessage\":\"\",\"messageStr\":\"1/27/2021 8:35:56 PM , snapshotCreator=guestExtension, hostStatusCodePreSnapshot=200, Plugin enable Succeeded (command: Snapshot) Snapshot command completed \",\"snapshotConsistency\":2}" - }, - "excludeDisks": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vm8768_disk2_fe6ffde4f69b491ca33fb984d5bcd89f" + "provisioningState": "Succeeded", + "consistencyMode": "ApplicationConsistent", + "provisioningDetails": { + "creationTime": "2021-01-27T20:35:05.8401519+00:00", + "totalUsedSizeInBytes": 10835349504, + "statusCode": 0, + "statusMessage": "{\"jobMessage\":\"\",\"messageStr\":\"1/27/2021 8:35:56 PM , snapshotCreator=guestExtension, hostStatusCodePreSnapshot=200, Plugin enable Succeeded (command: Snapshot) Snapshot command completed \",\"snapshotConsistency\":2}" } - ] + } } ] } diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetRestorePointCollectionsInAResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetRestorePointCollectionsInAResourceGroup.json index ece3579969d2..057dc3450953 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetRestorePointCollectionsInAResourceGroup.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetRestorePointCollectionsInAResourceGroup.json @@ -12,14 +12,14 @@ "name": "restorePointCollection1", "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/restorePointCollection1", "type": "Microsoft.Compute/restorePointCollections", - "location": "West US", + "location": "westus", "tags": { "myTag1": "tagValue1" }, "properties": { "source": { "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/restorePointCollection1", - "location": "West US" + "location": "westus" }, "restorePointCollectionId": "59f04a5d-f783-4200-a1bd-d3f464e8c4b4", "provisioningState": "Successful" @@ -29,14 +29,14 @@ "name": "restorePointCollection2", "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/restorePointCollection2", "type": "Microsoft.Compute/restorePointCollections", - "location": "West US", + "location": "westus", "tags": { "myTag1": "tagValue1" }, "properties": { "source": { "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/restorePointCollection2", - "location": "West US" + "location": "westus" }, "restorePointCollectionId": "2875c590-e337-4102-9668-4f5b7e3f98a4", "provisioningState": "Deleting" diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetRestorePointCollectionsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetRestorePointCollectionsInASubscription.json index 0216a257babc..1a84836d7ced 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetRestorePointCollectionsInASubscription.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetRestorePointCollectionsInASubscription.json @@ -11,14 +11,14 @@ "name": "restorePointCollection1", "id": "/subscriptions/{subscription-id}/resourceGroups/resourceGroup1/providers/Microsoft.Compute/restorePointCollections/restorePointCollection1", "type": "Microsoft.Compute/restorePointCollections", - "location": "West US", + "location": "westus", "tags": { "myTag1": "tagValue1" }, "properties": { "source": { "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/VM_Test", - "location": "West US" + "location": "westus" }, "restorePointCollectionId": "59f04a5d-f783-4200-a1bd-d3f464e8c4b4", "provisioningState": "Successful" @@ -28,14 +28,14 @@ "name": "restorePointCollection2", "id": "/subscriptions/{subscription-id}/resourceGroups/resourceGroup2/providers/Microsoft.Compute/restorePointCollections/restorePointCollection2", "type": "Microsoft.Compute/restorePointCollections", - "location": "West US", + "location": "westus", "tags": { "myTag1": "tagValue1" }, "properties": { "source": { "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/VM_Prod", - "location": "West US" + "location": "westus" }, "restorePointCollectionId": "2875c590-e337-4102-9668-4f5b7e3f98a4", "provisioningState": "Deleting" diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetVirtualMachineScaleSetVMWithUserData.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetVirtualMachineScaleSetVMWithUserData.json index c3dfdc7addf1..1afab87e608c 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetVirtualMachineScaleSetVMWithUserData.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetVirtualMachineScaleSetVMWithUserData.json @@ -13,7 +13,7 @@ "name": "{vmss-vm-name}", "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0", "type": "Microsoft.Compute/virtualMachines", - "location": "West US", + "location": "westus", "tags": { "myTag1": "tagValue1" }, @@ -113,7 +113,7 @@ "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", + "location": "westus", "tags": { "displayName": "CustomScriptExtension-DSC" }, diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetVirtualMachineScaleSetWithUserData.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetVirtualMachineScaleSetWithUserData.json index b609dfbee505..3f351925eeb5 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetVirtualMachineScaleSetWithUserData.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/examples/GetVirtualMachineScaleSetWithUserData.json @@ -12,7 +12,7 @@ "name": "myVirtualMachineScaleSet", "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet", "type": "Microsoft.Compute/virtualMachineScaleSets", - "location": "West US", + "location": "westus", "tags": { "myTag1": "tagValue1" }, diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/compute.json new file mode 100644 index 000000000000..c4f8526dc54f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/compute.json @@ -0,0 +1,14989 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2021-04-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": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ComputeOperationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + } + }, + "x-ms-examples": { + "Create an availability set.": { + "$ref": "./examples/CreateAnAvailabilitySet.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + } + } + }, + "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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + } + } + }, + "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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/availabilitySets": { + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_ListBySubscription", + "description": "Lists all availability sets in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List availability sets in a subscription.": { + "$ref": "./examples/ListAvailabilitySetsInASubscription.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySetListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroup" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroup" + } + } + }, + "x-ms-examples": { + "Create or Update a proximity placement group.": { + "$ref": "./examples/CreateOrUpdateAProximityPlacementGroup.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroup" + } + } + }, + "x-ms-examples": { + "Create a proximity placement group.": { + "$ref": "./examples/PatchAProximityPlacementGroup.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "x-ms-examples": { + "Create a proximity placement group.": { + "$ref": "./examples/DeleteAProximityPlacementGroup.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroup" + } + } + }, + "x-ms-examples": { + "Create a proximity placement group.": { + "$ref": "./examples/GetAProximityPlacementGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/proximityPlacementGroups": { + "get": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_ListBySubscription", + "description": "Lists all proximity placement groups in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroupListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Create a proximity placement group.": { + "$ref": "./examples/ListProximityPlacementGroupsInASubscription.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroupListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Create a proximity placement group.": { + "$ref": "./examples/ListProximityPlacementGroupsInAResourceGroup.json" + } + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + } + } + }, + "x-ms-examples": { + "Create or update a dedicated host group.": { + "$ref": "./examples/CreateOrUpdateADedicatedHostGroup.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + } + } + } + }, + "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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + } + } + }, + "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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + } + } + }, + "x-ms-examples": { + "Create a dedicated host group.": { + "$ref": "./examples/GetADedicatedHostGroup.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroupListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroupListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHost" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DedicatedHost" + } + } + }, + "x-ms-examples": { + "Create or update a dedicated host .": { + "$ref": "./examples/CreateOrUpdateADedicatedHost.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "DedicatedHosts" + ], + "operationId": "DedicatedHosts_Update", + "description": "Update an 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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHost" + } + } + }, + "x-ms-long-running-operation": true + }, + "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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHost" + } + } + }, + "x-ms-examples": { + "Get a dedicated host.": { + "$ref": "./examples/GetADedicatedHost.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SshPublicKeysGroupListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SshPublicKeysGroupListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SshPublicKeyResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SshPublicKeyResource" + } + } + }, + "x-ms-examples": { + "Create a new SSH public key resource.": { + "$ref": "./examples/CreateAnSshPublicKey.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SshPublicKeyResource" + } + } + } + }, + "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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + } + } + }, + "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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SshPublicKeyResource" + } + } + }, + "x-ms-examples": { + "Get an ssh public key.": { + "$ref": "./examples/GetAnSshPublicKey.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." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SshPublicKeyGenerateKeyPairResult" + } + } + }, + "x-ms-examples": { + "Generate an SSH key pair.": { + "$ref": "./examples/GenerateSshKeyPair.json" + } + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtensionImage" + } + } + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionImage" + } + } + } + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionImage" + } + } + } + }, + "x-ms-odata": "#/definitions/VirtualMachineExtensionImage" + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + } + }, + "x-ms-long-running-operation": true + }, + "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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + } + }, + "x-ms-long-running-operation": true + }, + "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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + } + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtensionsListResult" + } + } + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineImage" + } + } + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + } + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + } + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + } + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + } + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineImage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListUsagesResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineListResult" + } + } + }, + "x-ms-examples": { + "Lists all the virtual machines under the specified subscription for the specified location.": { + "$ref": "./examples/ListVirtualMachinesInASubscriptionByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Lists all the VM scale sets under the specified subscription for the specified location.": { + "$ref": "./examples/ListVirtualMachineScaleSetsInASubscriptionByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Image" + } + } + }, + "x-ms-examples": { + "Create a virtual machine image from a blob.": { + "$ref": "./examples/CreateAnImageFromABlob.json" + }, + "Create a virtual machine image from a snapshot.": { + "$ref": "./examples/CreateAnImageFromASnapshot.json" + }, + "Create a virtual machine image from a managed disk.": { + "$ref": "./examples/CreateAnImageFromAManagedDisk.json" + }, + "Create a virtual machine image from an existing virtual machine.": { + "$ref": "./examples/CreateAnImageFromAVM.json" + }, + "Create a virtual machine image that includes a data disk from a blob.": { + "$ref": "./examples/CreateAnImageThatIncludesADataDiskFromABlob.json" + }, + "Create a virtual machine image that includes a data disk from a snapshot.": { + "$ref": "./examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json" + }, + "Create a virtual machine image that includes a data disk from a managed disk.": { + "$ref": "./examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json" + }, + "Create a virtual machine image from a blob with DiskEncryptionSet resource.": { + "$ref": "./examples/CreateAnImageFromABlobWithDiskEncryptionSet.json" + }, + "Create a virtual machine image from a snapshot with DiskEncryptionSet resource.": { + "$ref": "./examples/CreateAnImageFromASnapshotWithDiskEncryptionSet.json" + }, + "Create a virtual machine image from a managed disk with DiskEncryptionSet resource.": { + "$ref": "./examples/CreateAnImageFromAManagedDiskWithDiskEncryptionSet.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Image" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates tags of an Image.": { + "$ref": "./examples/UpdateImage.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Image" + } + } + }, + "x-ms-examples": { + "Get information about a virtual machine image.": { + "$ref": "./examples/GetInformationAboutAnImage.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.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + } + }, + "x-ms-examples": { + "List all virtual machine images in a resource group.": { + "$ref": "./examples/ListImagesInAResourceGroup.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + } + }, + "x-ms-examples": { + "List all virtual machine images in a subscription.": { + "$ref": "./examples/ListImagesInASubscription.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineCaptureResult" + } + }, + "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}": { + "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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a vm with password authentication.": { + "$ref": "./examples/CreateAVmWithPasswordAuthentication.json" + }, + "Create a vm with ssh authentication.": { + "$ref": "./examples/CreateAVmWithSshAuthentication.json" + }, + "Create a vm with premium storage.": { + "$ref": "./examples/CreateAVmWithPremiumStorage.json" + }, + "Create a vm in a Virtual Machine Scale Set with customer assigned platformFaultDomain.": { + "$ref": "./examples/CreateAVmInAVirtualMachineScaleSetWithCustomerAssignedPlatformFaultDomain.json" + }, + "Create a vm in an availability set.": { + "$ref": "./examples/CreateAVmInAnAvailabilitySet.json" + }, + "Create a vm with Scheduled Events Profile": { + "$ref": "./examples/CreateAVmWithScheduledEventsProfile.json" + }, + "Create a vm with boot diagnostics.": { + "$ref": "./examples/CreateAVmWithBootDiagnostics.json" + }, + "Create a vm with managed boot diagnostics.": { + "$ref": "./examples/CreateAVmWithManagedBootDiagnostics.json" + }, + "Create a vm with empty data disks.": { + "$ref": "./examples/CreateAVmWithEmptyDataDisks.json" + }, + "Create a vm with a marketplace image plan.": { + "$ref": "./examples/CreateAVmWithAMarketplaceImagePlan.json" + }, + "Create a vm from a custom image.": { + "$ref": "./examples/CreateAVmFromACustomImage.json" + }, + "Create a platform-image vm with unmanaged os and data disks.": { + "$ref": "./examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json" + }, + "Create a custom-image vm from an unmanaged generalized os image.": { + "$ref": "./examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json" + }, + "Create a vm with ephemeral os disk.": { + "$ref": "./examples/CreateAVmWithADiffOsDisk.json" + }, + "Create a vm with DiskEncryptionSet resource id in the os disk and data disk.": { + "$ref": "./examples/CreateAVmWithDiskEncryptionSetResource.json" + }, + "Create a vm with ephemeral os disk provisioning in Resource disk using placement property.": { + "$ref": "./examples/CreateAVmWithADiffOsDiskUsingDiffDiskPlacementAsResourceDisk.json" + }, + "Create a vm with ephemeral os disk provisioning in Cache disk using placement property.": { + "$ref": "./examples/CreateAVmWithADiffOsDiskUsingDiffDiskPlacementAsCacheDisk.json" + }, + "Create a vm with Host Encryption using encryptionAtHost property.": { + "$ref": "./examples/CreateAVmWithEncryptionAtHost.json" + }, + "Create a Windows vm with a patch setting patchMode of AutomaticByOS.": { + "$ref": "./examples/CreateAWindowsVmWithPatchSettingModeOfAutomaticByOS.json" + }, + "Create a Windows vm with patch settings patchMode and assessmentMode set to AutomaticByPlatform.": { + "$ref": "./examples/CreateAWindowsVmWithPatchSettingModesOfAutomaticByPlatform.json" + }, + "Create a Windows vm with a patch setting patchMode of Manual.": { + "$ref": "./examples/CreateAWindowsVmWithPatchSettingModeOfManual.json" + }, + "Create a Windows vm with a patch setting assessmentMode of ImageDefault.": { + "$ref": "./examples/CreateAWindowsVmWithPatchSettingAssessmentModeOfImageDefault.json" + }, + "Create a Windows vm with a patch setting patchMode of AutomaticByPlatform and enableHotpatching set to true.": { + "$ref": "./examples/CreateAWindowsVmWithPatchSettingModeOfAutomaticByPlatformAndEnableHotPatchingTrue.json" + }, + "Create a Linux vm with a patch settings patchMode and assessmentMode set to AutomaticByPlatform.": { + "$ref": "./examples/CreateALinuxVmWithPatchSettingModesOfAutomaticByPlatform.json" + }, + "Create a Linux vm with a patch setting patchMode of ImageDefault.": { + "$ref": "./examples/CreateALinuxVmWithPatchSettingModeOfImageDefault.json" + }, + "Create a Linux vm with a patch setting assessmentMode of ImageDefault.": { + "$ref": "./examples/CreateALinuxVmWithPatchSettingAssessmentModeOfImageDefault.json" + }, + "Create a vm with an extensions time budget.": { + "$ref": "./examples/CreateAVmWithExtensionsTimeBudget.json" + }, + "Create a VM with Uefi Settings of secureBoot and vTPM.": { + "$ref": "./examples/CreateAVmWithUefiSettings.json" + }, + "Create a vm from a generalized shared image.": { + "$ref": "./examples/CreateAVmFromAGeneralizedSharedImage.json" + }, + "Create a vm from a specialized shared image.": { + "$ref": "./examples/CreateAVmFromASpecializedSharedImage.json" + }, + "Create a VM with network interface configuration": { + "$ref": "./examples/CreateAVmWithNetworkInterfaceConfiguration.json" + }, + "Create a VM with UserData": { + "$ref": "./examples/CreateOrUpdateAVmWithUserData.json" + }, + "Create or update a VM with capacity reservation": { + "$ref": "./examples/CreateOrUpdateAVmWithCapacityReservation.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a VM by detaching data disk": { + "$ref": "./examples/UpdateVMDetachDataDiskUsingToBeDetachedProperty.json" + }, + "Update a VM by force-detaching data disk": { + "$ref": "./examples/UpdateVMForceDetachDataDisk.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.(Feature in Preview)" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Force delete a VM": { + "$ref": "./examples/ForceDeleteVirtualMachine.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + } + }, + "x-ms-examples": { + "Get a Virtual Machine.": { + "$ref": "./examples/GetVirtualMachine.json" + }, + "Get a virtual machine placed on a dedicated host group through automatic placement": { + "$ref": "./examples/GetVirtualMachineAutoPlacedOnDedicatedHostGroup.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineInstanceView" + } + } + }, + "x-ms-examples": { + "Get Virtual Machine Instance View.": { + "$ref": "./examples/GetVirtualMachineInstanceView.json" + }, + "Get instance view of a virtual machine placed on a dedicated host group through automatic placement.": { + "$ref": "./examples/GetVirtualMachineInstanceViewAutoPlacedOnDedicatedHostGroup.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/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." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "x-ms-examples": { + "Generalize a Virtual Machine.": { + "$ref": "./examples/GeneralizeVirtualMachine.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." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/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/CreateOrUpdateARestorePointCollection.json" + } + }, + "parameters": [ + { + "$ref": "#/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": "#/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": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "RestorePointCollections" + ], + "operationId": "RestorePointCollections_Update", + "description": "The operation to update the restore point collection.", + "parameters": [ + { + "$ref": "#/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": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RestorePointCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "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": "#/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": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "RestorePointCollections" + ], + "operationId": "RestorePointCollections_Get", + "description": "The operation to get the restore point collection.", + "parameters": [ + { + "$ref": "#/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": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "Get a restore point collection (but not the restore points contained in the restore point collection)": { + "$ref": "./examples/GetRestorePointCollection.json" + }, + "Get a restore point collection, including the restore points contained in the restore point collection": { + "$ref": "./examples/GetRestorePointCollectionWithContainedRestorePoints.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RestorePointCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "Gets the list of restore point collections in a resource group.": { + "$ref": "./examples/GetRestorePointCollectionsInAResourceGroup.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RestorePointCollectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RestorePointCollectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gets the list of restore point collections in a subscription": { + "$ref": "./examples/GetRestorePointCollectionsInASubscription.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/CreateARestorePoint.json" + } + }, + "parameters": [ + { + "$ref": "#/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": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/RestorePoint" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "RestorePoints_Delete", + "description": "The operation to delete the restore point.", + "parameters": [ + { + "$ref": "#/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": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "operationId": "RestorePoints_Get", + "description": "The operation to get the restore point.", + "parameters": [ + { + "$ref": "#/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": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "Get a restore point": { + "$ref": "./examples/GetRestorePoint.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RestorePoint" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + } + }, + "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/ListAvailableVmSizes_VirtualMachines.json" + } + } + } + }, + "/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 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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create or update a capacity reservation group.": { + "$ref": "./examples/CreateOrUpdateACapacityReservationGroup.json" + } + } + }, + "patch": { + "tags": [ + "CapacityReservationGroups" + ], + "operationId": "CapacityReservationGroups_Update", + "description": "The operation to update a capacity reservation group. When updating a capacity reservation group, only tags 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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapacityReservationGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapacityReservationGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a capacity reservation Group.": { + "$ref": "./examples/GetACapacityReservationGroup.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List capacity reservation groups in resource group.": { + "$ref": "./examples/ListCapacityReservationGroupsInResourceGroup.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List capacity reservation groups in subscription.": { + "$ref": "./examples/ListCapacityReservationGroupsInSubscription.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create or update a capacity reservation .": { + "$ref": "./examples/CreateOrUpdateACapacityReservation.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapacityReservation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapacityReservation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a capacity reservation.": { + "$ref": "./examples/GetACapacityReservation.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapacityReservationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List capacity reservations in reservation group.": { + "$ref": "./examples/ListCapacityReservationsInReservationGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Reapply the state of a virtual machine.": { + "$ref": "./examples/ReapplyVirtualMachine.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/reimage": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Reimage", + "description": "Reimages the virtual machine which has an ephemeral OS disk back to its initial 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." + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineReimageParameters" + }, + "description": "Parameters supplied to the Reimage Virtual Machine operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Reimage a Virtual Machine.": { + "$ref": "./examples/ReimageVirtualMachine.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RetrieveBootDiagnosticsDataResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "RetrieveBootDiagnosticsData of a virtual machine.": { + "$ref": "./examples/RetrieveBootDiagnosticsDataVirtualMachine.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Simulate Eviction a virtual machine.": { + "$ref": "./examples/SimulateEvictionOfVM.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/VirtualMachineAssessPatches.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineAssessPatchesResult" + } + }, + "202": { + "description": "Accepted" + }, + "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" + } + } + }, + "/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/VirtualMachineInstallPatches.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineInstallPatchesResult" + } + }, + "202": { + "description": "Accepted" + }, + "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" + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a scale set with password authentication.": { + "$ref": "./examples/CreateAScaleSetWithPasswordAuthentication.json" + }, + "Create a scale set with ssh authentication.": { + "$ref": "./examples/CreateAScaleSetWithSshAuthentication.json" + }, + "Create a scale set with premium storage.": { + "$ref": "./examples/CreateAScaleSetWithPremiumStorage.json" + }, + "Create a scale set with empty data disks on each vm.": { + "$ref": "./examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json" + }, + "Create a scale set with an azure load balancer.": { + "$ref": "./examples/CreateAScaleSetWithAnAzureLoadBalancer.json" + }, + "Create a scale set with an azure application gateway.": { + "$ref": "./examples/CreateAScaleSetWithAnAzureApplicationGateway.json" + }, + "Create a scale set with boot diagnostics.": { + "$ref": "./examples/CreateAScaleSetWithBootDiagnostics.json" + }, + "Create a scale set with managed boot diagnostics.": { + "$ref": "./examples/CreateAScaleSetWithManagedBootDiagnostics.json" + }, + "Create a scale set with a marketplace image plan.": { + "$ref": "./examples/CreateAScaleSetWithAMarketplaceImagePlan.json" + }, + "Create a scale set from a custom image.": { + "$ref": "./examples/CreateAScaleSetFromACustomImage.json" + }, + "Create a platform-image scale set with unmanaged os disks.": { + "$ref": "./examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json" + }, + "Create a custom-image scale set from an unmanaged generalized os image.": { + "$ref": "./examples/CreateACustomImageScaleSetFromAnUnmanagedGeneralizedOsImage.json" + }, + "Create a scale set with virtual machines in different zones.": { + "$ref": "./examples/CreateAScaleSetWithVMsInDifferentZones.json" + }, + "Create a scale set with ephemeral os disks.": { + "$ref": "./examples/CreateAScaleSetWithDiffOsDisk.json" + }, + "Create a scale set with terminate scheduled events enabled.": { + "$ref": "./examples/CreateAScaleSetWithTerminateScheduledEventEnabled.json" + }, + "Create a scale set with automatic repairs enabled": { + "$ref": "./examples/CreateAScaleSetWithAutomaticRepairs.json" + }, + "Create a scale set with DiskEncryptionSet resource in os disk and data disk.": { + "$ref": "./examples/CreateAScalesetWithDiskEncryptionSetResource.json" + }, + "Create a scale set with ephemeral os disks using placement property.": { + "$ref": "./examples/CreateAScaleSetWithDiffOsDiskUsingDiffDiskPlacement.json" + }, + "Create a scale set with extension time budget.": { + "$ref": "./examples/CreateAScaleSetWithExtensionsTimeBudget.json" + }, + "Create a scale set with Host Encryption using encryptionAtHost property.": { + "$ref": "./examples/CreateAScaleSetWithEncryptionAtHost.json" + }, + "Create a scale set with Fpga Network Interfaces.": { + "$ref": "./examples/CreateAScaleSetFromWithFpgaNetworkInterface.json" + }, + "Create a scale set with Uefi Settings of secureBoot and vTPM.": { + "$ref": "./examples/CreateAScaleSetWithUefiSettings.json" + }, + "Create a scale set from a generalized shared image.": { + "$ref": "./examples/CreateAScaleSetFromAGeneralizedSharedImage.json" + }, + "Create a scale set from a specialized shared image.": { + "$ref": "./examples/CreateAScaleSetFromASpecializedSharedImage.json" + }, + "Create a scale set with userData.": { + "$ref": "./examples/CreateOrUpdateAScaleSetWithUserData.json" + }, + "Create or update a scale set with capacity reservation.": { + "$ref": "./examples/CreateOrUpdateAScaleSetWithCapacityReservation.json" + }, + "Create a scale set with spot restore policy": { + "$ref": "./examples/CreateAScaleSetWithSpotRestorePolicy.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + } + }, + "x-ms-long-running-operation": true + }, + "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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Force Delete a VM scale set.": { + "$ref": "./examples/ForceDeleteVirtualMachineScaleSets.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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" + } + } + }, + "x-ms-examples": { + "Get a virtual machine scale set placed on a dedicated host group through automatic placement.": { + "$ref": "./examples/GetVirtualMachineScaleSetAutoPlacedOnDedicatedHostGroup.json" + }, + "Get a virtual machine scale set with UserData": { + "$ref": "./examples/GetVirtualMachineScaleSetWithUserData.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." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetInstanceView" + } + } + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + } + }, + "x-ms-long-running-operation": true + }, + "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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + } + }, + "x-ms-long-running-operation": true + }, + "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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + } + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListWithLinkResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListSkusResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListOSUpgradeHistory" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Start an extension rolling upgrade.": { + "$ref": "./examples/VMScaleSetExtensionRollingUpgrade.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RollingUpgradeStatusInfo" + } + } + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "platformUpdateDomain", + "in": "query", + "required": true, + "type": "integer", + "description": "The platform update domain for which a manual recovery walk is requested" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryWalkResponse" + } + } + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create VirtualMachineScaleSet VM extension.": { + "$ref": "./examples/CreateOrUpdateVirtualMachineScaleSetVMExtensions.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMExtension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update VirtualMachineScaleSet VM extension.": { + "$ref": "./examples/UpdateVirtualMachineScaleSetVMExtensions.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete VirtualMachineScaleSet VM extension.": { + "$ref": "./examples/DeleteVirtualMachineScaleSetVMExtensions.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMExtension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get VirtualMachineScaleSet VM extension.": { + "$ref": "./examples/GetVirtualMachineScaleSetVMExtensions.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMExtensionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List extensions in Vmss instance.": { + "$ref": "./examples/ListVirtualMachineScaleSetVMExtensions.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + } + } + }, + "x-ms-long-running-operation": true + }, + "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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Force Delete a virtual machine from a VM scale set.": { + "$ref": "./examples/ForceDeleteVirtualMachineScaleSetVM.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + } + } + }, + "x-ms-examples": { + "Get VM scale set VM with UserData": { + "$ref": "./examples/GetVirtualMachineScaleSetVMWithUserData.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceView" + } + } + }, + "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/GetVirtualMachineScaleSetVMInstanceViewAutoPlacedOnDedicatedHostGroup.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/VirtualMachineScaleSetVM" + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RetrieveBootDiagnosticsDataResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "RetrieveBootDiagnosticsData of a virtual machine.": { + "$ref": "./examples/RetrieveBootDiagnosticsDataVMScaleSetVM.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Simulate Eviction a virtual machine.": { + "$ref": "./examples/SimulateEvictionOfVmssVM.json" + } + } + } + }, + "/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/LogAnalyticsRequestRateByInterval.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LogAnalyticsOperationResult" + } + }, + "202": { + "description": "Accepted" + } + }, + "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/LogAnalyticsThrottledRequests.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LogAnalyticsOperationResult" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + } + }, + "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": "#/definitions/Resource" + } + ], + "description": "Create or update Restore Point collection parameters." + }, + "RestorePointCollectionUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RestorePointCollectionProperties" + } + }, + "allOf": [ + { + "$ref": "#/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": { + "$ref": "#/definitions/HardwareProfile", + "description": "Gets the hardware profile." + }, + "storageProfile": { + "$ref": "#/definitions/RestorePointSourceVMStorageProfile", + "description": "Gets the storage profile." + }, + "osProfile": { + "$ref": "#/definitions/OSProfile", + "description": "Gets the OS profile." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/DiagnosticsProfile", + "description": "Gets the diagnostics profile." + }, + "licenseType": { + "type": "string", + "description": "Gets the license type, which is for bring your own license scenario." + }, + "vmId": { + "type": "string", + "description": "Gets the virtual machine unique id." + }, + "securityProfile": { + "$ref": "#/definitions/SecurityProfile", + "description": "Gets the security profile." + }, + "location": { + "type": "string", + "description": "Location of the VM from which the restore point was created." + } + }, + "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" + }, + "description": "Gets the data disks of the VM captured at the time of the restore point creation." + } + }, + "description": "Describes the storage profile." + }, + "RestorePointSourceVMOSDisk": { + "properties": { + "osType": { + "type": "string", + "description": "Gets the Operating System type.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemType", + "modelAsString": true + } + }, + "encryptionSettings": { + "$ref": "#/definitions/DiskEncryptionSettings", + "description": "Gets the disk encryption settings." + }, + "name": { + "type": "string", + "description": "Gets the disk name." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Gets the caching type." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Gets the disk size in GB." + }, + "managedDisk": { + "$ref": "#/definitions/ManagedDiskParameters", + "description": "Gets the managed disk details" + }, + "diskRestorePoint": { + "$ref": "#/definitions/ApiEntityReference", + "description": "Gets the disk restore point Id." + } + }, + "description": "Describes an Operating System disk." + }, + "RestorePointSourceVMDataDisk": { + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "description": "Gets the logical unit number." + }, + "name": { + "type": "string", + "description": "Gets the disk name." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Gets the caching type." + }, + "diskSizeGB": { + "type": "integer", + "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": "#/definitions/ManagedDiskParameters", + "description": "Gets the managed disk details" + }, + "diskRestorePoint": { + "$ref": "#/definitions/ApiEntityReference", + "description": "Gets the disk restore point Id." + } + }, + "description": "Describes a data disk." + }, + "RestorePointProvisioningDetails": { + "properties": { + "creationTime": { + "type": "string", + "format": "date-time", + "description": "Gets the creation time of the restore point." + }, + "totalUsedSizeInBytes": { + "type": "integer", + "format": "int64", + "description": "Gets the total size of the data in all the disks which are part of the restore point." + }, + "statusCode": { + "type": "integer", + "format": "int32", + "description": "Gets the status of the Create restore point operation." + }, + "statusMessage": { + "type": "string", + "description": "Gets the status message of the Create restore point operation." + } + }, + "description": "Restore Point Provisioning details." + }, + "RestorePoint": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RestorePointProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Restore Point details." + }, + "RestorePointProperties": { + "type": "object", + "properties": { + "excludeDisks": { + "type": "array", + "items": { + "$ref": "#/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": { + "readOnly": true, + "$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", + "readOnly": true, + "enum": [ + "CrashConsistent", + "FileSystemConsistent", + "ApplicationConsistent" + ], + "x-ms-enum": { + "name": "ConsistencyModeTypes", + "modelAsString": true + }, + "description": "Gets the consistency mode for the restore point. Please refer to https://aka.ms/RestorePoints for more details." + }, + "provisioningDetails": { + "$ref": "#/definitions/RestorePointProvisioningDetails", + "readOnly": true, + "description": "Gets the provisioning details set by the server during Create restore point operation." + } + }, + "description": "The restore point properties." + }, + "ComputeOperationListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ComputeOperationValue" + }, + "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." + }, + "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." + }, + "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." + }, + "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." + } + }, + "description": "Instance view status." + }, + "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": "#/definitions/SubResource" + }, + "description": "A list of references to all virtual machines in the availability set." + }, + "proximityPlacementGroup": { + "$ref": "#/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": "#/definitions/InstanceViewStatus" + }, + "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": "#/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": "#/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 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": "#/definitions/Sku", + "description": "Sku of the availability set" + } + }, + "allOf": [ + { + "$ref": "#/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." + }, + "SubResourceWithColocationStatus": { + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "colocationStatus": { + "$ref": "#/definitions/InstanceViewStatus", + "description": "Describes colocation status of a resource in the Proximity Placement Group." + } + } + }, + "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": "#/definitions/SubResourceWithColocationStatus" + }, + "description": "A list of references to all virtual machines in the proximity placement group." + }, + "virtualMachineScaleSets": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/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": "#/definitions/SubResourceWithColocationStatus" + }, + "description": "A list of references to all availability sets in the proximity placement group." + }, + "colocationStatus": { + "$ref": "#/definitions/InstanceViewStatus", + "description": "Describes colocation status 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." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Specifies information about the proximity placement group." + }, + "ProximityPlacementGroupUpdate": { + "allOf": [ + { + "$ref": "#/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." + }, + "DedicatedHostGroupInstanceView": { + "properties": { + "hosts": { + "type": "array", + "items": { + "$ref": "#/definitions/DedicatedHostInstanceViewWithName" + }, + "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": "#/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." + } + }, + "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": "#/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": "#/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**

Default: **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" + }, + "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": "#/definitions/InstanceViewStatus" + }, + "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": "#/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**

Default: **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." + } + }, + "description": "Properties of the dedicated host." + }, + "DedicatedHost": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DedicatedHostProperties" + }, + "sku": { + "$ref": "#/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": "#/definitions/Resource" + } + ], + "required": [ + "sku" + ], + "description": "Specifies information about the Dedicated host." + }, + "DedicatedHostUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DedicatedHostProperties" + } + }, + "allOf": [ + { + "$ref": "#/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." + }, + "CapacityReservationGroupInstanceView": { + "type": "object", + "properties": { + "capacityReservations": { + "type": "array", + "items": { + "$ref": "#/definitions/CapacityReservationInstanceViewWithName" + }, + "readOnly": true, + "description": "List of instance view of the capacity reservations under the capacity reservation group." + } + } + }, + "CapacityReservationGroupProperties": { + "type": "object", + "properties": { + "capacityReservations": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResourceReadOnly" + }, + "readOnly": true, + "description": "A list of all capacity reservation resource ids that belong to capacity reservation group." + }, + "virtualMachinesAssociated": { + "type": "array", + "items": { + "$ref": "#/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." + } + }, + "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": "#/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": "#/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": "#/definitions/InstanceViewStatus" + }, + "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": { + "virtualMachinesAllocated": { + "type": "array", + "items": { + "$ref": "#/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." + }, + "virtualMachinesAssociated": { + "type": "array", + "items": { + "$ref": "#/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." + } + }, + "description": "Properties of the Capacity reservation." + }, + "CapacityReservation": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CapacityReservationProperties" + }, + "sku": { + "$ref": "#/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": "#/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": "#/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": "#/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." + }, + "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": "#/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": "#/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." + }, + "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" + }, + "description": "The list of virtual machine sizes." + } + }, + "description": "The List Virtual Machine operation response." + }, + "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": "#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine Extension 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": "#/definitions/ExtendedLocation", + "description": "The extended location of the Virtual Machine." + } + }, + "required": [ + "name", + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Virtual machine image resource information." + }, + "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": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "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." + } + }, + "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." + } + }, + "description": "Describes the properties of a Virtual Machine Extension." + }, + "VirtualMachineExtension": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineExtensionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine Extension." + }, + "VirtualMachineScaleSetVMExtension": { + "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/VirtualMachineExtensionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResourceReadOnly" + } + ], + "description": "Describes a VMSS VM Extension." + }, + "VirtualMachineExtensionUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineExtensionUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Describes a Virtual Machine Extension." + }, + "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": "#/definitions/VirtualMachineExtensionUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResourceReadOnly" + } + ], + "description": "Describes a VMSS VM Extension." + }, + "VirtualMachineExtensionsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "The list of extensions" + } + }, + "description": "The List Extension operation response" + }, + "VirtualMachineScaleSetVMExtensionsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetVMExtension" + }, + "description": "The list of VMSS VM extensions" + } + }, + "description": "The List VMSS VM 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" + }, + "description": "The list of patches that have been detected as available for installation." + }, + "error": { + "$ref": "#/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": [ + "maximumDuration", + "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" + }, + "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": "#/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." + }, + "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." + }, + "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" + } + }, + "automaticOSUpgradeProperties": { + "$ref": "#/definitions/AutomaticOSUpgradeProperties" + }, + "hyperVGeneration": { + "$ref": "#/definitions/HyperVGenerationType" + }, + "disallowed": { + "$ref": "#/definitions/DisallowedConfiguration", + "description": "Specifies disallowed configuration for the VirtualMachine created from the image" + }, + "features": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageFeature" + } + } + }, + "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." + }, + "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" + }, + "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." + }, + "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." + } + }, + "description": "Parameters for Reimaging Virtual Machine. NOTE: Virtual Machine OS disk will always be reimaged" + }, + "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" + }, + "description": "a list of resource items of the captured virtual machine" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Output of virtual machine capture operation." + }, + "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.

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 + } + } + }, + "description": "Specifies the hardware settings for 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." + }, + "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'." + } + }, + "allOf": [ + { + "$ref": "#/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." + }, + "KeyVaultSecretReference": { + "properties": { + "secretUrl": { + "type": "string", + "description": "The URL referencing a secret in a Key Vault." + }, + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing the secret." + } + }, + "required": [ + "secretUrl", + "sourceVault" + ], + "description": "Describes a reference to Key Vault Secret" + }, + "DiskEncryptionSetParameters": { + "allOf": [ + { + "$ref": "#/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." + }, + "KeyVaultKeyReference": { + "properties": { + "keyUrl": { + "type": "string", + "description": "The URL referencing a key encryption key in Key Vault." + }, + "sourceVault": { + "$ref": "#/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" + }, + "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**

Default: **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** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

**FromImage** \\u2013 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: **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 i.e whether the managed disk is deleted or detached. Supported values:

**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" + ], + "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**

Default: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** is used.

Refer to 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." + } + }, + "allOf": [ + { + "$ref": "#/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**

Default: **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** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

**FromImage** \\u2013 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." + }, + "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.

This value cannot be larger than 1023 GB" + }, + "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:

**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**. User cannot change the delete option for 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**

Default: **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** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

**FromImage** \\u2013 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." + }, + "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.

This value cannot be larger than 1023 GB" + }, + "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:

**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": "#/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" + }, + "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)." + } + }, + "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" + }, + "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.

Default: 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 is set as TrustedLaunch to enable UefiSettings.

Default: UefiSettings will not be enabled unless this property is set as TrustedLaunch.", + "enum": [ + "TrustedLaunch" + ], + "x-ms-enum": { + "name": "SecurityTypes", + "modelAsString": true + } + } + }, + "description": "Specifies the Security profile settings for the virtual machine or virtual machine scale set." + }, + "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." + } + }, + "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 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)." + } + }, + "description": "Describes Protocol and thumbprint of Windows Remote Management listener" + }, + "WinRMConfiguration": { + "properties": { + "listeners": { + "type": "array", + "items": { + "$ref": "#/definitions/WinRMListener" + }, + "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, 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." + }, + "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" + }, + "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." + } + }, + "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" + }, + "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." + } + }, + "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": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing all of the certificates in VaultCertificates." + }, + "vaultCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultCertificate" + }, + "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)" + }, + "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.

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" + }, + "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": "Specifies whether the guest provision signal is required to infer provision success of the virtual machine. **Note: This property is for private testing only, and all customers must not set the property to false.**" + } + }, + "description": "Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned." + }, + "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 30 minutes (PT30M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M)." + } + }, + "description": "Specifies the configuration parameters for automatic repairs on the virtual machine scale set." + }, + "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": "#/definitions/SubResource" + } + ], + "description": "Describes a network interface reference." + }, + "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." + } + }, + "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" + }, + "description": "The list of IP tags associated with the public IP address." + }, + "publicIPPrefix": { + "$ref": "#/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" + }, + "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" + }, + "VirtualMachinePublicIPAddressConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The publicIP address configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachinePublicIPAddressConfigurationProperties" + }, + "sku": { + "$ref": "#/definitions/PublicIPAddressSku" + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machines IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineNetworkInterfaceIPConfigurationProperties": { + "properties": { + "subnet": { + "$ref": "#/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": "#/definitions/SubResource" + }, + "description": "Specifies an array of references to application security group." + }, + "applicationGatewayBackendAddressPools": { + "type": "array", + "items": { + "$ref": "#/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": "#/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." + }, + "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": "#/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" + }, + "description": "Specifies the IP configurations of the network interface." + }, + "dscpConfiguration": { + "$ref": "#/definitions/SubResource" + } + }, + "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." + }, + "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": "#/definitions/VirtualMachineNetworkInterfaceConfiguration" + }, + "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.

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." + }, + "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": "#/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" + }, + "description": "The virtual machine extension handler instance view." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of the VM Agent running on the virtual machine." + }, + "DiskInstanceView": { + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "encryptionSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskEncryptionSettings" + }, + "description": "Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15" + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "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." + }, + "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": { + "type": "object", + "additionalProperties": { + "type": "object", + "x-ms-client-name": "userAssignedIdentitiesValue", + "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 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." + }, + "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." + }, + "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": "#/definitions/MaintenanceRedeployStatus", + "description": "The Maintenance Operation status on the virtual machine." + }, + "disks": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskInstanceView" + }, + "description": "The virtual machine disk information." + }, + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionInstanceView" + }, + "description": "The extensions information." + }, + "vmHealth": { + "readOnly": true, + "$ref": "#/definitions/VirtualMachineHealthStatus", + "description": "The health status for the VM." + }, + "bootDiagnostics": { + "$ref": "#/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": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + }, + "patchStatus": { + "$ref": "#/definitions/VirtualMachinePatchStatus", + "description": "[Preview Feature] The status of virtual machine patch operations." + } + }, + "description": "The instance view of a virtual machine." + }, + "VirtualMachineProperties": { + "properties": { + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfile", + "description": "Specifies the hardware settings for the virtual machine." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "additionalCapabilities": { + "$ref": "#/definitions/AdditionalCapabilities", + "description": "Specifies additional capabilities enabled or disabled on the virtual machine." + }, + "osProfile": { + "$ref": "#/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": "#/definitions/NetworkProfile", + "description": "Specifies the network interfaces of the virtual machine." + }, + "securityProfile": { + "$ref": "#/definitions/SecurityProfile", + "description": "Specifies the Security related profile settings for the virtual machine." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/DiagnosticsProfile", + "description": "Specifies the boot diagnostic settings state.

Minimum api-version: 2015-06-15." + }, + "availabilitySet": { + "$ref": "#/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": "#/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": "#/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": "#/definitions/priority", + "description": "Specifies the priority for the virtual machine.

Minimum api-version: 2019-03-01" + }, + "evictionPolicy": { + "$ref": "#/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": "#/definitions/BillingProfile", + "description": "Specifies the billing related details of a Azure Spot virtual machine.

Minimum api-version: 2019-03-01." + }, + "host": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the dedicated host that the virtual machine resides in.

Minimum api-version: 2018-10-01." + }, + "hostGroup": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the dedicated host group that the virtual machine resides in.

Minimum api-version: 2020-06-01.

NOTE: User cannot specify both host and hostGroup properties." + }, + "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' > 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": "#/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": "#/definitions/CapacityReservationProfile", + "description": "Specifies information about the capacity reservation that is used to allocate virtual machine.

    Minimum api-version: 2021-04-01." + } + }, + "description": "Describes the properties of a Virtual Machine." + }, + "VirtualMachine": { + "properties": { + "plan": { + "$ref": "#/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": "#/definitions/ExtendedLocation", + "description": "The extended location of the Virtual Machine." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine." + }, + "VirtualMachineUpdate": { + "properties": { + "plan": { + "$ref": "#/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": "#/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." + }, + "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." + }, + "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." + } + }, + "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." + }, + "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." + } + }, + "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.

    " + } + }, + "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." + }, + "OrchestrationMode": { + "type": "string", + "description": "Specifies the orchestration mode for the virtual machine scale set.", + "enum": [ + "Uniform", + "Flexible" + ], + "x-ms-enum": { + "name": "OrchestrationMode", + "modelAsString": true + } + }, + "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.", + "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": "#/definitions/SubResource", + "description": "The snapshot." + }, + "managedDisk": { + "$ref": "#/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**

    Default: **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": "#/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 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" + }, + "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": "#/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": "#/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": "#/definitions/ExtendedLocation", + "description": "The extended location of the Image." + } + }, + "allOf": [ + { + "$ref": "#/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": "#/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." + }, + "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": { + "type": "object", + "additionalProperties": { + "type": "object", + "x-ms-client-name": "VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue", + "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 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)" + }, + "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": "#/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" + }, + "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)." + } + }, + "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": "#/definitions/WindowsConfiguration", + "description": "The Windows Configuration of the OS profile." + }, + "linuxConfiguration": { + "$ref": "#/definitions/LinuxConfiguration", + "description": "The Linux Configuration of the OS profile." + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + }, + "description": "The List of certificates for addition to the VM." + } + }, + "description": "Describes a virtual machine scale set OS profile." + }, + "VirtualMachineScaleSetManagedDiskParameters": { + "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." + } + }, + "description": "Describes the parameters of a ScaleSet managed disk." + }, + "VirtualMachineScaleSetOSDisk": { + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **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 machines in the scale set should be created.

    The only allowed value is: **FromImage** \\u2013 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": "#/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 the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "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": "#/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" + } + }, + "required": [ + "createOption" + ], + "description": "Describes a virtual machine scale set operating system disk." + }, + "VirtualMachineScaleSetUpdateOSDisk": { + "properties": { + "caching": { + "$ref": "#/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 the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "image": { + "$ref": "#/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" + } + }, + "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": "#/definitions/Caching", + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **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": "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.

    This value cannot be larger than 1023 GB" + }, + "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." + } + }, + "required": [ + "lun", + "createOption" + ], + "description": "Describes a virtual machine scale set data disk." + }, + "VirtualMachineScaleSetStorageProfile": { + "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/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" + }, + "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)." + } + }, + "description": "Describes a virtual machine scale set storage profile." + }, + "VirtualMachineScaleSetUpdateStorageProfile": { + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "The image reference." + }, + "osDisk": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateOSDisk", + "description": "The OS disk." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" + }, + "description": "The data disks." + } + }, + "description": "Describes a virtual machine scale set storage profile." + }, + "ApiEntityReference": { + "properties": { + "id": { + "type": "string", + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." + } + }, + "description": "The API entity reference." + }, + "VirtualMachineScaleSetIPConfigurationProperties": { + "properties": { + "subnet": { + "$ref": "#/definitions/ApiEntityReference", + "description": "Specifies the identifier of the subnet." + }, + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more 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": "#/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": "#/definitions/SubResource" + }, + "description": "Specifies an array of references to application security group." + }, + "loadBalancerBackendAddressPools": { + "type": "array", + "items": { + "$ref": "#/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": "#/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": "#/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": "#/definitions/SubResource" + }, + "description": "The application gateway backend address pools." + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "Specifies an array of references to application security group." + }, + "loadBalancerBackendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "The load balancer backend address pools." + }, + "loadBalancerInboundNatPools": { + "type": "array", + "items": { + "$ref": "#/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" + ], + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "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" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "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" + }, + "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." + }, + "enableFpga": { + "type": "boolean", + "description": "Specifies whether the network interface is FPGA networking-enabled." + }, + "networkSecurityGroup": { + "$ref": "#/definitions/SubResource", + "description": "The network security group." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings", + "description": "The dns settings to be applied on the network interfaces." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" + }, + "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 + } + } + }, + "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." + }, + "enableFpga": { + "type": "boolean", + "description": "Specifies whether the network interface is FPGA networking-enabled." + }, + "networkSecurityGroup": { + "$ref": "#/definitions/SubResource", + "description": "The network security group." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings", + "description": "The dns settings to be applied on the network interfaces." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateIPConfiguration" + }, + "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 + } + } + }, + "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" + ], + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "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" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a virtual machine scale set network profile's network configurations." + }, + "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" + } + }, + "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": "#/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" + }, + "description": "The list of IP tags associated with the public IP address." + }, + "publicIPPrefix": { + "$ref": "#/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 ." + }, + "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": "#/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" + }, + "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": "#/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" + }, + "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." + } + }, + "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": "#/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": "#/definitions/SubResourceReadOnly" + } + ], + "description": "Describes a Virtual Machine Scale Set Extension." + }, + "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": "#/definitions/SecurityProfile", + "description": "Specifies the Security related profile settings for the virtual machines in the scale set." + }, + "diagnosticsProfile": { + "$ref": "#/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": "#/definitions/priority", + "description": "Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview" + }, + "evictionPolicy": { + "$ref": "#/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": "#/definitions/BillingProfile", + "description": "Specifies the billing related details of a Azure Spot VMSS.

    Minimum api-version: 2019-03-01." + }, + "scheduledEventsProfile": { + "$ref": "#/definitions/ScheduledEventsProfile", + "description": "Specifies Scheduled Event related configurations." + }, + "userData": { + "type": "string", + "description": "UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here.

    Minimum api-version: 2021-03-01" + }, + "capacityReservation": { + "$ref": "#/definitions/CapacityReservationProfile", + "description": "Specifies the capacity reservation related details of a scale set.

    Minimum api-version: 2021-04-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": "#/definitions/SecurityProfile", + "description": "The virtual machine scale set Security profile" + }, + "diagnosticsProfile": { + "$ref": "#/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": "#/definitions/BillingProfile", + "description": "Specifies the billing related details of a Azure Spot VMSS.

    Minimum api-version: 2019-03-01." + }, + "scheduledEventsProfile": { + "$ref": "#/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" + } + }, + "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": "#/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": "#/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": "#/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 scale-in policy that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled-in." + }, + "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." + } + }, + "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": "#/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 scale-in policy that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled-in." + }, + "proximityPlacementGroup": { + "$ref": "#/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." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSet": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The virtual machine scale set sku." + }, + "plan": { + "$ref": "#/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": "#/definitions/ExtendedLocation", + "description": "The extended location of the Virtual Machine Scale Set." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSetVMReimageParameters": { + "allOf": [ + { + "$ref": "#/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": "#/definitions/Sku", + "description": "The virtual machine scale set sku." + }, + "plan": { + "$ref": "#/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": "#/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" + }, + "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" + }, + "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" + }, + "description": "The extensions information." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + }, + "orchestrationServices": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/OrchestrationServiceSummary" + }, + "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": "#/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" + }, + "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." + }, + "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": "#/definitions/ApiError", + "readOnly": true, + "description": "Error details if OS rollback failed." + } + }, + "description": "Information about rollback on failed VM instances after a OS Upgrade operation." + }, + "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": "#/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": "#/definitions/ImageReference", + "readOnly": true, + "description": "Image Reference details" + }, + "rollbackInfo": { + "$ref": "#/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" + }, + "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": "#/definitions/HardwareProfile", + "description": "Specifies the hardware settings for the virtual machine." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "additionalCapabilities": { + "$ref": "#/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": "#/definitions/OSProfile", + "description": "Specifies the operating system settings for the virtual machine." + }, + "securityProfile": { + "$ref": "#/definitions/SecurityProfile", + "description": "Specifies the Security related profile settings for the virtual machine." + }, + "networkProfile": { + "$ref": "#/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": "#/definitions/DiagnosticsProfile", + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "availabilitySet": { + "$ref": "#/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" + } + }, + "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": "#/definitions/Sku", + "readOnly": true, + "description": "The virtual machine SKU." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetVMProperties" + }, + "plan": { + "$ref": "#/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": "#/definitions/VirtualMachineExtension" + }, + "description": "The virtual machine child extension resources." + }, + "zones": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine zones." + } + }, + "allOf": [ + { + "$ref": "#/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": "#/definitions/VirtualMachineAgentInstanceView", + "description": "The VM Agent running on the virtual machine." + }, + "maintenanceRedeployStatus": { + "$ref": "#/definitions/MaintenanceRedeployStatus", + "description": "The Maintenance Operation status on the virtual machine." + }, + "disks": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskInstanceView" + }, + "description": "The disks information." + }, + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionInstanceView" + }, + "description": "The extensions information." + }, + "vmHealth": { + "readOnly": true, + "$ref": "#/definitions/VirtualMachineHealthStatus", + "description": "The health status for the VM." + }, + "bootDiagnostics": { + "$ref": "#/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": "#/definitions/InstanceViewStatus" + }, + "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." + } + }, + "description": "The instance view of a virtual machine scale set VM." + }, + "VirtualMachineScaleSetVMNetworkProfileConfiguration": { + "properties": { + "networkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" + }, + "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." + }, + "ScheduledEventsProfile": { + "type": "object", + "properties": { + "terminateNotificationProfile": { + "$ref": "#/definitions/TerminateNotificationProfile", + "description": "Specifies Terminate 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." + } + } + }, + "VirtualMachineHealthStatus": { + "properties": { + "status": { + "readOnly": true, + "$ref": "#/definitions/InstanceViewStatus", + "description": "The health status information for the VM." + } + }, + "description": "The health status of the 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": "#/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": "#/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." + }, + "ApiErrorBase": { + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "Api error base." + }, + "InnerError": { + "properties": { + "exceptiontype": { + "type": "string", + "description": "The exception type." + }, + "errordetail": { + "type": "string", + "description": "The internal error message or exception dump." + } + }, + "description": "Inner error details." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/ApiError" + } + }, + "description": "An error response from the Compute service." + }, + "ApiError": { + "properties": { + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiErrorBase" + }, + "description": "The Api error details" + }, + "innererror": { + "$ref": "#/definitions/InnerError", + "description": "The Api inner error" + }, + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "Api error." + }, + "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 + }, + "Resource": { + "description": "The 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" + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + }, + "UpdateResource": { + "description": "The Update Resource model definition.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + } + }, + "SubResource": { + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + }, + "x-ms-azure-resource": true + }, + "SubResourceReadOnly": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + } + }, + "x-ms-azure-resource": true + }, + "ExtendedLocationType": { + "type": "string", + "description": "The type of extendedLocation.", + "enum": [ + "EdgeZone" + ], + "x-ms-enum": { + "name": "ExtendedLocationTypes", + "modelAsString": true + } + }, + "ExtendedLocation": { + "description": "The complex type of the extended location.", + "properties": { + "name": { + "type": "string", + "description": "The name of the extended location." + }, + "type": { + "$ref": "#/definitions/ExtendedLocationType", + "description": "The type of the extended location." + } + } + }, + "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" + }, + "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" + }, + "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" + ] + }, + "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 + } + } + }, + "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 + } + } + }, + "description": "Specifies settings related to VM Guest Patching on Linux." + }, + "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": "#/definitions/InstanceViewStatus" + } + } + }, + "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": "#/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": "#/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." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateACustomImageScaleSetFromAnUnmanagedGeneralizedOsImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateACustomImageScaleSetFromAnUnmanagedGeneralizedOsImage.json new file mode 100644 index 000000000000..3602d5291629 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateACustomImageScaleSetFromAnUnmanagedGeneralizedOsImage.json @@ -0,0 +1,202 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json new file mode 100644 index 000000000000..95dbc4ba4c8f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json @@ -0,0 +1,145 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "{vm-name}", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateALinuxVmWithPatchSettingAssessmentModeOfImageDefault.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateALinuxVmWithPatchSettingAssessmentModeOfImageDefault.json new file mode 100644 index 000000000000..4309b8d99508 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateALinuxVmWithPatchSettingAssessmentModeOfImageDefault.json @@ -0,0 +1,163 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateALinuxVmWithPatchSettingModeOfImageDefault.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateALinuxVmWithPatchSettingModeOfImageDefault.json new file mode 100644 index 000000000000..989dc640f5f7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateALinuxVmWithPatchSettingModeOfImageDefault.json @@ -0,0 +1,163 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateALinuxVmWithPatchSettingModesOfAutomaticByPlatform.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateALinuxVmWithPatchSettingModesOfAutomaticByPlatform.json new file mode 100644 index 000000000000..23c5d40b556b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateALinuxVmWithPatchSettingModesOfAutomaticByPlatform.json @@ -0,0 +1,166 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json new file mode 100644 index 000000000000..98adf49b6429 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json @@ -0,0 +1,222 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json new file mode 100644 index 000000000000..f63ae55441ba --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json @@ -0,0 +1,213 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "{vm-name}", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateARestorePoint.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateARestorePoint.json new file mode 100644 index 000000000000..d6ea9279f204 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateARestorePoint.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "restorePointCollectionName": "rpcName", + "restorePointName": "rpName", + "api-version": "2021-04-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" + } + } + ] + }, + "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", + "provisioningDetails": { + "creationTime": "2021-01-27T20:35:05.8401519+00:00", + "totalUsedSizeInBytes": 10835349504, + "statusCode": 0, + "statusMessage": "{\"jobMessage\":\"\",\"messageStr\":\"1/27/2021 8:35:56 PM , snapshotCreator=guestExtension, hostStatusCodePreSnapshot=200, Plugin enable Succeeded (command: Snapshot) Snapshot command completed \",\"snapshotConsistency\":2}" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetFromACustomImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetFromACustomImage.json new file mode 100644 index 000000000000..a4d1e732bb13 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetFromACustomImage.json @@ -0,0 +1,204 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAScaleSetFromAGeneralizedSharedImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetFromAGeneralizedSharedImage.json new file mode 100644 index 000000000000..ebd864d76d82 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetFromAGeneralizedSharedImage.json @@ -0,0 +1,204 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAScaleSetFromASpecializedSharedImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetFromASpecializedSharedImage.json new file mode 100644 index 000000000000..d7435f155f25 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetFromASpecializedSharedImage.json @@ -0,0 +1,183 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAScaleSetFromWithFpgaNetworkInterface.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetFromWithFpgaNetworkInterface.json new file mode 100644 index 000000000000..3da8e0b8e71e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetFromWithFpgaNetworkInterface.json @@ -0,0 +1,271 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAScaleSetWithAMarketplaceImagePlan.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithAMarketplaceImagePlan.json new file mode 100644 index 000000000000..35b1b70a423f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithAMarketplaceImagePlan.json @@ -0,0 +1,230 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAScaleSetWithAnAzureApplicationGateway.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithAnAzureApplicationGateway.json new file mode 100644 index 000000000000..21315645fb7e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithAnAzureApplicationGateway.json @@ -0,0 +1,230 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAScaleSetWithAnAzureLoadBalancer.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithAnAzureLoadBalancer.json new file mode 100644 index 000000000000..88bc93fae906 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithAnAzureLoadBalancer.json @@ -0,0 +1,251 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAScaleSetWithAutomaticRepairs.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithAutomaticRepairs.json new file mode 100644 index 000000000000..9248c5b730a2 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithAutomaticRepairs.json @@ -0,0 +1,227 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2021-04-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": "PT30M" + } + } + } + }, + "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": "PT30M" + }, + "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": "PT30M" + }, + "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/stable/2021-04-01/examples/CreateAScaleSetWithBootDiagnostics.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithBootDiagnostics.json new file mode 100644 index 000000000000..a67b78e742fd --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithBootDiagnostics.json @@ -0,0 +1,233 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAScaleSetWithDiffOsDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithDiffOsDisk.json new file mode 100644 index 000000000000..2d5c1ad0012c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithDiffOsDisk.json @@ -0,0 +1,239 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAScaleSetWithDiffOsDiskUsingDiffDiskPlacement.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithDiffOsDiskUsingDiffDiskPlacement.json new file mode 100644 index 000000000000..550adbd50c43 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithDiffOsDiskUsingDiffDiskPlacement.json @@ -0,0 +1,242 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json new file mode 100644 index 000000000000..10048566fcaf --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json @@ -0,0 +1,270 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAScaleSetWithEncryptionAtHost.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithEncryptionAtHost.json new file mode 100644 index 000000000000..a2f13b09017a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithEncryptionAtHost.json @@ -0,0 +1,239 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAScaleSetWithExtensionsTimeBudget.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithExtensionsTimeBudget.json new file mode 100644 index 000000000000..a959d7dd0485 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithExtensionsTimeBudget.json @@ -0,0 +1,278 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAScaleSetWithManagedBootDiagnostics.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithManagedBootDiagnostics.json new file mode 100644 index 000000000000..3cf98b096051 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithManagedBootDiagnostics.json @@ -0,0 +1,230 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAScaleSetWithPasswordAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithPasswordAuthentication.json new file mode 100644 index 000000000000..895cc8d4dba8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithPasswordAuthentication.json @@ -0,0 +1,215 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAScaleSetWithPremiumStorage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithPremiumStorage.json new file mode 100644 index 000000000000..ebc9925c699e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithPremiumStorage.json @@ -0,0 +1,215 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAScaleSetWithSpotRestorePolicy.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithSpotRestorePolicy.json new file mode 100644 index 000000000000..616ebb4f1cd0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithSpotRestorePolicy.json @@ -0,0 +1,242 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAScaleSetWithSshAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithSshAuthentication.json new file mode 100644 index 000000000000..029e2344985c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithSshAuthentication.json @@ -0,0 +1,239 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAScaleSetWithTerminateScheduledEventEnabled.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithTerminateScheduledEventEnabled.json new file mode 100644 index 000000000000..0b6e36ee3607 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithTerminateScheduledEventEnabled.json @@ -0,0 +1,233 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAScaleSetWithUefiSettings.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithUefiSettings.json new file mode 100644 index 000000000000..7babdc5f55d0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithUefiSettings.json @@ -0,0 +1,236 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAScaleSetWithVMsInDifferentZones.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithVMsInDifferentZones.json new file mode 100644 index 000000000000..ff1c8659747b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScaleSetWithVMsInDifferentZones.json @@ -0,0 +1,284 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAScalesetWithDiskEncryptionSetResource.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScalesetWithDiskEncryptionSetResource.json new file mode 100644 index 000000000000..b1a81dd639bc --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAScalesetWithDiskEncryptionSetResource.json @@ -0,0 +1,255 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAVmFromACustomImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmFromACustomImage.json new file mode 100644 index 000000000000..be5294a8165d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmFromACustomImage.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAVmFromAGeneralizedSharedImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmFromAGeneralizedSharedImage.json new file mode 100644 index 000000000000..69f037bfff74 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmFromAGeneralizedSharedImage.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAVmFromASpecializedSharedImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmFromASpecializedSharedImage.json new file mode 100644 index 000000000000..953a0c326b43 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmFromASpecializedSharedImage.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAVmInAVirtualMachineScaleSetWithCustomerAssignedPlatformFaultDomain.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmInAVirtualMachineScaleSetWithCustomerAssignedPlatformFaultDomain.json new file mode 100644 index 000000000000..5ce9deb9a806 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmInAVirtualMachineScaleSetWithCustomerAssignedPlatformFaultDomain.json @@ -0,0 +1,165 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAVmInAnAvailabilitySet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmInAnAvailabilitySet.json new file mode 100644 index 000000000000..c1187c14f7e0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmInAnAvailabilitySet.json @@ -0,0 +1,162 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAVmWithADiffOsDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithADiffOsDisk.json new file mode 100644 index 000000000000..990e392c5e6a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithADiffOsDisk.json @@ -0,0 +1,177 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAVmWithADiffOsDiskUsingDiffDiskPlacementAsCacheDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithADiffOsDiskUsingDiffDiskPlacementAsCacheDisk.json new file mode 100644 index 000000000000..f867373ad21f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithADiffOsDiskUsingDiffDiskPlacementAsCacheDisk.json @@ -0,0 +1,180 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAVmWithADiffOsDiskUsingDiffDiskPlacementAsResourceDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithADiffOsDiskUsingDiffDiskPlacementAsResourceDisk.json new file mode 100644 index 000000000000..4eb617e0b5f8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithADiffOsDiskUsingDiffDiskPlacementAsResourceDisk.json @@ -0,0 +1,180 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAVmWithAMarketplaceImagePlan.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithAMarketplaceImagePlan.json new file mode 100644 index 000000000000..59040a71a84d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithAMarketplaceImagePlan.json @@ -0,0 +1,168 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAVmWithBootDiagnostics.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithBootDiagnostics.json new file mode 100644 index 000000000000..4c2f4d97fdd3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithBootDiagnostics.json @@ -0,0 +1,171 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAVmWithDiskEncryptionSetResource.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithDiskEncryptionSetResource.json new file mode 100644 index 000000000000..cdf6f904d8b3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithDiskEncryptionSetResource.json @@ -0,0 +1,229 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAVmWithEmptyDataDisks.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithEmptyDataDisks.json new file mode 100644 index 000000000000..7eab9344cdec --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithEmptyDataDisks.json @@ -0,0 +1,205 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAVmWithEncryptionAtHost.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithEncryptionAtHost.json new file mode 100644 index 000000000000..594b20914efa --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithEncryptionAtHost.json @@ -0,0 +1,177 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAVmWithExtensionsTimeBudget.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithExtensionsTimeBudget.json new file mode 100644 index 000000000000..f753091644c2 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithExtensionsTimeBudget.json @@ -0,0 +1,174 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAVmWithManagedBootDiagnostics.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithManagedBootDiagnostics.json new file mode 100644 index 000000000000..cd54304a38f7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithManagedBootDiagnostics.json @@ -0,0 +1,168 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAVmWithNetworkInterfaceConfiguration.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithNetworkInterfaceConfiguration.json new file mode 100644 index 000000000000..34c9297a9aaf --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithNetworkInterfaceConfiguration.json @@ -0,0 +1,174 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAVmWithPasswordAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithPasswordAuthentication.json new file mode 100644 index 000000000000..561882b2e722 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithPasswordAuthentication.json @@ -0,0 +1,153 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAVmWithPremiumStorage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithPremiumStorage.json new file mode 100644 index 000000000000..2565ede11f03 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithPremiumStorage.json @@ -0,0 +1,153 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAVmWithScheduledEventsProfile.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithScheduledEventsProfile.json new file mode 100644 index 000000000000..29eb922aa29b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithScheduledEventsProfile.json @@ -0,0 +1,189 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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 + } + } + } + } + }, + "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 + } + }, + "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 + } + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithSshAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithSshAuthentication.json new file mode 100644 index 000000000000..6cfdd99d6657 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithSshAuthentication.json @@ -0,0 +1,177 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAVmWithUefiSettings.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithUefiSettings.json new file mode 100644 index 000000000000..46074b78401f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAVmWithUefiSettings.json @@ -0,0 +1,174 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAWindowsVmWithPatchSettingAssessmentModeOfImageDefault.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAWindowsVmWithPatchSettingAssessmentModeOfImageDefault.json new file mode 100644 index 000000000000..17e3c81a226d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAWindowsVmWithPatchSettingAssessmentModeOfImageDefault.json @@ -0,0 +1,166 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAWindowsVmWithPatchSettingModeOfAutomaticByOS.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAWindowsVmWithPatchSettingModeOfAutomaticByOS.json new file mode 100644 index 000000000000..e4018def75cd --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAWindowsVmWithPatchSettingModeOfAutomaticByOS.json @@ -0,0 +1,166 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAWindowsVmWithPatchSettingModeOfAutomaticByPlatformAndEnableHotPatchingTrue.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAWindowsVmWithPatchSettingModeOfAutomaticByPlatformAndEnableHotPatchingTrue.json new file mode 100644 index 000000000000..0d90dc9a3849 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAWindowsVmWithPatchSettingModeOfAutomaticByPlatformAndEnableHotPatchingTrue.json @@ -0,0 +1,169 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAWindowsVmWithPatchSettingModeOfManual.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAWindowsVmWithPatchSettingModeOfManual.json new file mode 100644 index 000000000000..974ab4794ca1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAWindowsVmWithPatchSettingModeOfManual.json @@ -0,0 +1,166 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAWindowsVmWithPatchSettingModesOfAutomaticByPlatform.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAWindowsVmWithPatchSettingModesOfAutomaticByPlatform.json new file mode 100644 index 000000000000..989771283f2a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAWindowsVmWithPatchSettingModesOfAutomaticByPlatform.json @@ -0,0 +1,169 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAnAvailabilitySet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAnAvailabilitySet.json new file mode 100644 index 000000000000..46832b9a0714 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAnAvailabilitySet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAnImageFromABlob.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAnImageFromABlob.json new file mode 100644 index 000000000000..a3e312917c70 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAnImageFromABlob.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAnImageFromABlobWithDiskEncryptionSet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAnImageFromABlobWithDiskEncryptionSet.json new file mode 100644 index 000000000000..4534d44c813d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAnImageFromABlobWithDiskEncryptionSet.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAnImageFromAManagedDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAnImageFromAManagedDisk.json new file mode 100644 index 000000000000..b1be3688ad60 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAnImageFromAManagedDisk.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAnImageFromAManagedDiskWithDiskEncryptionSet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAnImageFromAManagedDiskWithDiskEncryptionSet.json new file mode 100644 index 000000000000..9b19a309e80a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAnImageFromAManagedDiskWithDiskEncryptionSet.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAnImageFromASnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAnImageFromASnapshot.json new file mode 100644 index 000000000000..a4a0f87dc47b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAnImageFromASnapshot.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAnImageFromASnapshotWithDiskEncryptionSet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAnImageFromASnapshotWithDiskEncryptionSet.json new file mode 100644 index 000000000000..a21f61b8b48c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAnImageFromASnapshotWithDiskEncryptionSet.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAnImageFromAVM.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAnImageFromAVM.json new file mode 100644 index 000000000000..88432bc14e9a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAnImageFromAVM.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAnImageThatIncludesADataDiskFromABlob.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAnImageThatIncludesADataDiskFromABlob.json new file mode 100644 index 000000000000..ecddc33253e6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAnImageThatIncludesADataDiskFromABlob.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json new file mode 100644 index 000000000000..111a53e775eb --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json new file mode 100644 index 000000000000..f7fcdf9e9d03 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateAnSshPublicKey.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAnSshPublicKey.json new file mode 100644 index 000000000000..31b0fa5e43d8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateAnSshPublicKey.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateOrUpdateACapacityReservation.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateOrUpdateACapacityReservation.json new file mode 100644 index 000000000000..f88d05ea8875 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateOrUpdateACapacityReservation.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-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": { + "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": { + "reservationId": "{GUID}", + "provisioningState": "Creating", + "provisioningTime": "2021-06-27T01:02:38.3138469+00:00" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateOrUpdateACapacityReservationGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateOrUpdateACapacityReservationGroup.json new file mode 100644 index 000000000000..f57b47d7c221 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateOrUpdateACapacityReservationGroup.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-01", + "capacityReservationGroupName": "myCapacityReservationGroup", + "parameters": { + "location": "westus", + "tags": { + "department": "finance" + }, + "zones": [ + "1", + "2" + ] + } + }, + "responses": { + "201": { + "body": { + "name": "myCapacityReservationGroup", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/CapacityReservationGroups/myCapacityReservationGroup", + "tags": { + "department": "finance" + }, + "zones": [ + "1", + "2" + ] + } + }, + "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" + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateOrUpdateADedicatedHost.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateOrUpdateADedicatedHost.json new file mode 100644 index 000000000000..b1dc01fd1f9d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateOrUpdateADedicatedHost.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateOrUpdateADedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateOrUpdateADedicatedHostGroup.json new file mode 100644 index 000000000000..ec69628b755a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateOrUpdateADedicatedHostGroup.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateOrUpdateAProximityPlacementGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateOrUpdateAProximityPlacementGroup.json new file mode 100644 index 000000000000..76f78fbce459 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateOrUpdateAProximityPlacementGroup.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-01", + "proximityPlacementGroupName": "myProximityPlacementGroup", + "parameters": { + "location": "westus", + "properties": { + "proximityPlacementGroupType": "Standard" + } + } + }, + "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" + } + }, + "201": { + "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/stable/2021-04-01/examples/CreateOrUpdateARestorePointCollection.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateOrUpdateARestorePointCollection.json new file mode 100644 index 000000000000..6deefcfb3ec2 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateOrUpdateARestorePointCollection.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "restorePointCollectionName": "myRpc", + "api-version": "2021-04-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": "Successful" + } + } + }, + "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": "Successful" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateOrUpdateAScaleSetWithCapacityReservation.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateOrUpdateAScaleSetWithCapacityReservation.json new file mode 100644 index 000000000000..28db6f9f0134 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateOrUpdateAScaleSetWithCapacityReservation.json @@ -0,0 +1,230 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateOrUpdateAScaleSetWithUserData.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateOrUpdateAScaleSetWithUserData.json new file mode 100644 index 000000000000..6cc592906a24 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateOrUpdateAScaleSetWithUserData.json @@ -0,0 +1,228 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateOrUpdateAVmWithCapacityReservation.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateOrUpdateAVmWithCapacityReservation.json new file mode 100644 index 000000000000..fde53d69c2d9 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateOrUpdateAVmWithCapacityReservation.json @@ -0,0 +1,183 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateOrUpdateAVmWithUserData.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateOrUpdateAVmWithUserData.json new file mode 100644 index 000000000000..bc72274b3760 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateOrUpdateAVmWithUserData.json @@ -0,0 +1,172 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "{vm-name}", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateOrUpdateRunCommand.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateOrUpdateRunCommand.json new file mode 100644 index 000000000000..d9851ff2a7d6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateOrUpdateRunCommand.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "runCommandName": "myRunCommand", + "api-version": "2021-04-01", + "runCommand": { + "location": "West US", + "properties": { + "source": { + "script": "Write-Host Hello World!" + }, + "parameters": [ + { + "name": "param1", + "value": "value1" + }, + { + "name": "param2", + "value": "value2" + } + ], + "asyncExecution": false, + "runAsUser": "user1", + "runAsPassword": "", + "timeoutInSeconds": 3600 + } + } + }, + "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!" + }, + "parameters": [ + { + "name": "param1", + "value": "value1" + }, + { + "name": "param2", + "value": "value2" + } + ], + "asyncExecution": false, + "runAsUser": "user1", + "timeoutInSeconds": 3600, + "provisioningState": "Succeeded" + } + } + }, + "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": { + "script": "Write-Host Hello World!" + }, + "parameters": [ + { + "name": "param1", + "value": "value1" + }, + { + "name": "param2", + "value": "value2" + } + ], + "asyncExecution": false, + "runAsUser": "user1", + "timeoutInSeconds": 3600, + "provisioningState": "Creating" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateOrUpdateVirtualMachineScaleSetVMExtensions.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateOrUpdateVirtualMachineScaleSetVMExtensions.json new file mode 100644 index 000000000000..bd695ac9f7f6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateOrUpdateVirtualMachineScaleSetVMExtensions.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "vmExtensionName": "myVMExtension", + "api-version": "2021-04-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/stable/2021-04-01/examples/CreateOrUpdateVirtualMachineScaleSetVMRunCommands.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateOrUpdateVirtualMachineScaleSetVMRunCommands.json new file mode 100644 index 000000000000..7713653ae209 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/CreateOrUpdateVirtualMachineScaleSetVMRunCommands.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "runCommandName": "myRunCommand", + "api-version": "2021-04-01", + "runCommand": { + "location": "West US", + "properties": { + "source": { + "script": "Write-Host Hello World!" + }, + "parameters": [ + { + "name": "param1", + "value": "value1" + }, + { + "name": "param2", + "value": "value2" + } + ], + "asyncExecution": false, + "runAsUser": "user1", + "runAsPassword": "", + "timeoutInSeconds": 3600 + } + } + }, + "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": { + "script": "Write-Host Hello World!" + }, + "parameters": [ + { + "name": "param1", + "value": "value1" + }, + { + "name": "param2", + "value": "value2" + } + ], + "asyncExecution": false, + "runAsUser": "user1", + "timeoutInSeconds": 3600, + "provisioningState": "Succeeded" + } + } + }, + "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": { + "script": "Write-Host Hello World!" + }, + "parameters": [ + { + "name": "param1", + "value": "value1" + }, + { + "name": "param2", + "value": "value2" + } + ], + "asyncExecution": false, + "runAsUser": "user1", + "timeoutInSeconds": 3600, + "provisioningState": "Creating" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/DeleteAProximityPlacementGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/DeleteAProximityPlacementGroup.json new file mode 100644 index 000000000000..8bacc2379582 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/DeleteAProximityPlacementGroup.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-01", + "proximityPlacementGroupName": "myProximityPlacementGroup", + "parameters": {} + }, + "responses": { + "200": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/DeleteRunCommand.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/DeleteRunCommand.json new file mode 100644 index 000000000000..c7a5a6a7e637 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/DeleteRunCommand.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "runCommandName": "myRunCommand", + "api-version": "2021-04-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/DeleteVirtualMachineScaleSetVMExtensions.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/DeleteVirtualMachineScaleSetVMExtensions.json new file mode 100644 index 000000000000..a338c794afc9 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/DeleteVirtualMachineScaleSetVMExtensions.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "vmExtensionName": "myVMExtension", + "api-version": "2021-04-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/DeleteVirtualMachineScaleSetVMRunCommands.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/DeleteVirtualMachineScaleSetVMRunCommands.json new file mode 100644 index 000000000000..b0d61e4ce19c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/DeleteVirtualMachineScaleSetVMRunCommands.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "runCommandName": "myRunCommand", + "api-version": "2021-04-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ForceDeleteVirtualMachine.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ForceDeleteVirtualMachine.json new file mode 100644 index 000000000000..9df319254733 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ForceDeleteVirtualMachine.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "forceDeletion": true, + "api-version": "2021-04-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ForceDeleteVirtualMachineScaleSetVM.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ForceDeleteVirtualMachineScaleSetVM.json new file mode 100644 index 000000000000..d45d2d64564c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ForceDeleteVirtualMachineScaleSetVM.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "forceDeletion": true, + "api-version": "2021-04-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ForceDeleteVirtualMachineScaleSets.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ForceDeleteVirtualMachineScaleSets.json new file mode 100644 index 000000000000..2c8a367918a5 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ForceDeleteVirtualMachineScaleSets.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "forceDeletion": true, + "api-version": "2021-04-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GeneralizeVirtualMachine.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GeneralizeVirtualMachine.json new file mode 100644 index 000000000000..df2333c82b73 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GeneralizeVirtualMachine.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-01", + "vmName": "myVMName" + }, + "responses": { + "200": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GenerateSshKeyPair.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GenerateSshKeyPair.json new file mode 100644 index 000000000000..5e7af2b018d6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GenerateSshKeyPair.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-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/stable/2021-04-01/examples/GetACapacityReservation.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetACapacityReservation.json new file mode 100644 index 000000000000..1840196c0879 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetACapacityReservation.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-01", + "capacityReservationGroupName": "myCapacityReservationGroup", + "capacityReservationName": "myCapacityReservation" + }, + "responses": { + "200": { + "body": { + "properties": { + "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": { + "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" + } + ] + } + }, + "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/stable/2021-04-01/examples/GetACapacityReservationGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetACapacityReservationGroup.json new file mode 100644 index 000000000000..9a6b9fecd440 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetACapacityReservationGroup.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-01", + "capacityReservationGroupName": "myCapacityReservationGroup", + "expand": "instanceView" + }, + "responses": { + "200": { + "body": { + "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" + } + ], + "instanceView": { + "capacityReservations": [ + { + "name": "myCapacityReservation1", + "utilizationInfo": { + "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": { + "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" + } + ] + } + ] + } + }, + "location": "westus", + "tags": { + "{tagName}": "{tagValue}" + }, + "name": "myCapacityReservationGroup", + "zones": [ + "3", + "1" + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetADedicatedHost.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetADedicatedHost.json new file mode 100644 index 000000000000..83effcadcd7c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetADedicatedHost.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-01", + "hostGroupName": "myDedicatedHostGroup", + "hostName": "myHost" + }, + "responses": { + "200": { + "body": { + "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" + } + ] + } + }, + "location": "westus", + "tags": { + "department": "HR" + }, + "sku": { + "name": "DSv3-Type1" + }, + "name": "myHost" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetADedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetADedicatedHostGroup.json new file mode 100644 index 000000000000..6e576a972e7a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetADedicatedHostGroup.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-01", + "hostGroupName": "myDedicatedHostGroup", + "expand": "instanceView" + }, + "responses": { + "200": { + "body": { + "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/stable/2021-04-01/examples/GetAProximityPlacementGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetAProximityPlacementGroup.json new file mode 100644 index 000000000000..2323f96056d7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetAProximityPlacementGroup.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-01", + "proximityPlacementGroupName": "myProximityPlacementGroup", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "name": "myProximityPlacementGroup", + "properties": { + "proximityPlacementGroupType": "Standard", + "virtualMachines": [ + { + "id": "string" + } + ], + "virtualMachineScaleSets": [ + { + "id": "string" + } + ], + "availabilitySets": [ + { + "id": "string" + } + ] + }, + "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/stable/2021-04-01/examples/GetAnSshPublicKey.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetAnSshPublicKey.json new file mode 100644 index 000000000000..25307aa0b0cd --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetAnSshPublicKey.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-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/stable/2021-04-01/examples/GetInformationAboutAnImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetInformationAboutAnImage.json new file mode 100644 index 000000000000..acc5d74dbcd7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetInformationAboutAnImage.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-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/stable/2021-04-01/examples/GetRestorePoint.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetRestorePoint.json new file mode 100644 index 000000000000..08a2c87d845a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetRestorePoint.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "restorePointCollectionName": "rpcName", + "restorePointName": "rpName", + "api-version": "2021-04-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" + } + } + ] + }, + "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", + "provisioningDetails": { + "creationTime": "2021-01-27T20:35:05.8401519+00:00", + "totalUsedSizeInBytes": 10835349504, + "statusCode": 0, + "statusMessage": "{\"jobMessage\":\"\",\"messageStr\":\"1/27/2021 8:35:56 PM , snapshotCreator=guestExtension, hostStatusCodePreSnapshot=200, Plugin enable Succeeded (command: Snapshot) Snapshot command completed \",\"snapshotConsistency\":2}" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetRestorePointCollection.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetRestorePointCollection.json new file mode 100644 index 000000000000..f2eb99cedd97 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetRestorePointCollection.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "restorePointCollectionName": "myRpc", + "api-version": "2021-04-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": "Successful" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetRestorePointCollectionWithContainedRestorePoints.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetRestorePointCollectionWithContainedRestorePoints.json new file mode 100644 index 000000000000..e8c954c155b9 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetRestorePointCollectionWithContainedRestorePoints.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "restorePointCollectionName": "rpcName", + "api-version": "2021-04-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": "Successful", + "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" + } + } + ] + }, + "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", + "provisioningDetails": { + "creationTime": "2021-01-27T20:35:05.8401519+00:00", + "totalUsedSizeInBytes": 10835349504, + "statusCode": 0, + "statusMessage": "{\"jobMessage\":\"\",\"messageStr\":\"1/27/2021 8:35:56 PM , snapshotCreator=guestExtension, hostStatusCodePreSnapshot=200, Plugin enable Succeeded (command: Snapshot) Snapshot command completed \",\"snapshotConsistency\":2}" + } + } + } + ] + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetRestorePointCollectionsInAResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetRestorePointCollectionsInAResourceGroup.json new file mode 100644 index 000000000000..c6ea66b87dde --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetRestorePointCollectionsInAResourceGroup.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-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": "Successful" + } + }, + { + "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/stable/2021-04-01/examples/GetRestorePointCollectionsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetRestorePointCollectionsInASubscription.json new file mode 100644 index 000000000000..b6aa117b9ecf --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetRestorePointCollectionsInASubscription.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2021-04-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": "Successful" + } + }, + { + "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/stable/2021-04-01/examples/GetRunCommand.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetRunCommand.json new file mode 100644 index 000000000000..707eb1b6bbbf --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetRunCommand.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "runCommandName": "myRunCommand", + "api-version": "2021-04-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!" + }, + "parameters": [ + { + "name": "param1", + "value": "value1" + }, + { + "name": "param2", + "value": "value2" + } + ], + "asyncExecution": false, + "runAsUser": "user1", + "timeoutInSeconds": 3600, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetVirtualMachine.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetVirtualMachine.json new file mode 100644 index 000000000000..c52b2878bd1c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetVirtualMachine.json @@ -0,0 +1,121 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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" + }, + "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 + } + ] + }, + "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/stable/2021-04-01/examples/GetVirtualMachineAutoPlacedOnDedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetVirtualMachineAutoPlacedOnDedicatedHostGroup.json new file mode 100644 index 000000000000..51e25c9e4aeb --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetVirtualMachineAutoPlacedOnDedicatedHostGroup.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/GetVirtualMachineInstanceView.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetVirtualMachineInstanceView.json new file mode 100644 index 000000000000..066faf120161 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetVirtualMachineInstanceView.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-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": "PatchModeConfigurationState/Pending", + "level": "Info", + "displayStatus": "Status_PatchModeConfigurationState_Pending", + "time": "2020-04-24T21:02:04.2556154Z" + }, + { + "code": "AssessmentModeConfigurationState/Pending", + "level": "Info", + "displayStatus": "Status_AssessmentModeConfigurationState_Pending", + "time": "2020-04-24T21:02:04.2556154Z" + } + ] + }, + "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/stable/2021-04-01/examples/GetVirtualMachineInstanceViewAutoPlacedOnDedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetVirtualMachineInstanceViewAutoPlacedOnDedicatedHostGroup.json new file mode 100644 index 000000000000..ed7ee667964d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetVirtualMachineInstanceViewAutoPlacedOnDedicatedHostGroup.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-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": "2021-04-01T23:11:22+00:00" + } + ] + }, + "disks": [ + { + "name": "myOsDisk", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "time": "2021-04-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": "2021-04-01T21:30:12.8051917+00:00" + }, + { + "code": "PowerState/running", + "level": "Info", + "displayStatus": "VM running" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetVirtualMachineScaleSetAutoPlacedOnDedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetVirtualMachineScaleSetAutoPlacedOnDedicatedHostGroup.json new file mode 100644 index 000000000000..ca3aa5435a86 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetVirtualMachineScaleSetAutoPlacedOnDedicatedHostGroup.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myVirtualMachineScaleSet", + "api-version": "2021-04-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/stable/2021-04-01/examples/GetVirtualMachineScaleSetVMExtensions.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetVirtualMachineScaleSetVMExtensions.json new file mode 100644 index 000000000000..dd302fb07672 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetVirtualMachineScaleSetVMExtensions.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "vmExtensionName": "myVMExtension", + "api-version": "2021-04-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/stable/2021-04-01/examples/GetVirtualMachineScaleSetVMInstanceViewAutoPlacedOnDedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetVirtualMachineScaleSetVMInstanceViewAutoPlacedOnDedicatedHostGroup.json new file mode 100644 index 000000000000..19085dbf8dc4 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetVirtualMachineScaleSetVMInstanceViewAutoPlacedOnDedicatedHostGroup.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myVirtualMachineScaleSet", + "instanceId": "0", + "api-version": "2021-04-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": "2021-04-01T05:00:32+00:00" + } + ], + "extensionHandlers": null + }, + "disks": [ + { + "name": "myOSDisk", + "encryptionSettings": null, + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": null, + "time": "2021-04-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/stable/2021-04-01/examples/GetVirtualMachineScaleSetVMRunCommands.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetVirtualMachineScaleSetVMRunCommands.json new file mode 100644 index 000000000000..a188ce126a7a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetVirtualMachineScaleSetVMRunCommands.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "runCommandName": "myRunCommand", + "api-version": "2021-04-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": { + "script": "Write-Host Hello World!" + }, + "parameters": [ + { + "name": "param1", + "value": "value1" + }, + { + "name": "param2", + "value": "value2" + } + ], + "asyncExecution": false, + "runAsUser": "user1", + "timeoutInSeconds": 3600, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetVirtualMachineScaleSetVMWithUserData.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetVirtualMachineScaleSetVMWithUserData.json new file mode 100644 index 000000000000..c4dc7b20a940 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetVirtualMachineScaleSetVMWithUserData.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "instanceId": "0", + "api-version": "2021-04-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" + }, + "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/stable/2021-04-01/examples/GetVirtualMachineScaleSetWithUserData.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetVirtualMachineScaleSetWithUserData.json new file mode 100644 index 000000000000..d88db448231b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/GetVirtualMachineScaleSetWithUserData.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myVirtualMachineScaleSet", + "api-version": "2021-04-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": [] + }, + "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/stable/2021-04-01/examples/ListAvailabilitySetsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListAvailabilitySetsInASubscription.json new file mode 100644 index 000000000000..b4bdd43deb4a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListAvailabilitySetsInASubscription.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "api-version": "2021-04-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/stable/2021-04-01/examples/ListAvailableVmSizes_VirtualMachines.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListAvailableVmSizes_VirtualMachines.json new file mode 100644 index 000000000000..31c44ba45498 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListAvailableVmSizes_VirtualMachines.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVmName", + "api-version": "2021-04-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/stable/2021-04-01/examples/ListCapacityReservationGroupsInResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListCapacityReservationGroupsInResourceGroup.json new file mode 100644 index 000000000000..5e52445ad92d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListCapacityReservationGroupsInResourceGroup.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-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/stable/2021-04-01/examples/ListCapacityReservationGroupsInSubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListCapacityReservationGroupsInSubscription.json new file mode 100644 index 000000000000..8db3408ae6a4 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListCapacityReservationGroupsInSubscription.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2021-04-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/stable/2021-04-01/examples/ListCapacityReservationsInReservationGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListCapacityReservationsInReservationGroup.json new file mode 100644 index 000000000000..17af4c495263 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListCapacityReservationsInReservationGroup.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "capacityReservationGroupName": "myCapacityReservationGroup", + "api-version": "2021-04-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": { + "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": { + "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/stable/2021-04-01/examples/ListImagesInAResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListImagesInAResourceGroup.json new file mode 100644 index 000000000000..b4303df553d8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListImagesInAResourceGroup.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-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" + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListImagesInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListImagesInASubscription.json new file mode 100644 index 000000000000..7da35a49d0ae --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListImagesInASubscription.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2021-04-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" + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListProximityPlacementGroupsInAResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListProximityPlacementGroupsInAResourceGroup.json new file mode 100644 index 000000000000..982bc371fd8e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListProximityPlacementGroupsInAResourceGroup.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-01", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myProximityPlacementGroup", + "properties": { + "proximityPlacementGroupType": "Standard", + "virtualMachines": [ + { + "id": "string" + } + ], + "virtualMachineScaleSets": [ + { + "id": "string" + } + ], + "availabilitySets": [ + { + "id": "string" + } + ] + }, + "location": "westus", + "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/stable/2021-04-01/examples/ListProximityPlacementGroupsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListProximityPlacementGroupsInASubscription.json new file mode 100644 index 000000000000..bbb351f485ca --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListProximityPlacementGroupsInASubscription.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2021-04-01", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myProximityPlacementGroup", + "properties": { + "proximityPlacementGroupType": "Standard", + "virtualMachines": [ + { + "id": "string" + } + ], + "virtualMachineScaleSets": [ + { + "id": "string" + } + ], + "availabilitySets": [ + { + "id": "string" + } + ] + }, + "location": "westus", + "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/stable/2021-04-01/examples/ListRunCommandsInVM.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListRunCommandsInVM.json new file mode 100644 index 000000000000..68fa51e9ded8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListRunCommandsInVM.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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, + "runAsUser": "user1", + "timeoutInSeconds": 0, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListVirtualMachineScaleSetVMExtensions.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListVirtualMachineScaleSetVMExtensions.json new file mode 100644 index 000000000000..a99a47694793 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListVirtualMachineScaleSetVMExtensions.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "api-version": "2021-04-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/stable/2021-04-01/examples/ListVirtualMachineScaleSetVMRunCommands.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListVirtualMachineScaleSetVMRunCommands.json new file mode 100644 index 000000000000..ae2840c1e8d8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListVirtualMachineScaleSetVMRunCommands.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "api-version": "2021-04-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!" + }, + "parameters": [ + { + "name": "param1", + "value": "value1" + }, + { + "name": "param2", + "value": "value2" + } + ], + "asyncExecution": false, + "runAsUser": "user1", + "timeoutInSeconds": 0, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListVirtualMachineScaleSetsInASubscriptionByLocation.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListVirtualMachineScaleSetsInASubscriptionByLocation.json new file mode 100644 index 000000000000..002bd4005eba --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListVirtualMachineScaleSetsInASubscriptionByLocation.json @@ -0,0 +1,169 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "eastus", + "api-version": "2021-04-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/stable/2021-04-01/examples/ListVirtualMachinesInASubscriptionByLocation.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListVirtualMachinesInASubscriptionByLocation.json new file mode 100644 index 000000000000..b2b47978904f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ListVirtualMachinesInASubscriptionByLocation.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "location": "eastus", + "api-version": "2021-04-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/stable/2021-04-01/examples/LogAnalyticsRequestRateByInterval.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/LogAnalyticsRequestRateByInterval.json new file mode 100644 index 000000000000..cda207bb0d30 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/LogAnalyticsRequestRateByInterval.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "westus", + "api-version": "2021-04-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": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/LogAnalyticsThrottledRequests.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/LogAnalyticsThrottledRequests.json new file mode 100644 index 000000000000..217cdd705fe0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/LogAnalyticsThrottledRequests.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "westus", + "api-version": "2021-04-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": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/PatchAProximityPlacementGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/PatchAProximityPlacementGroup.json new file mode 100644 index 000000000000..9922817ea53d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/PatchAProximityPlacementGroup.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-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/stable/2021-04-01/examples/ReapplyVirtualMachine.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ReapplyVirtualMachine.json new file mode 100644 index 000000000000..bb5c32d3c8b9 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ReapplyVirtualMachine.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "ResourceGroup", + "api-version": "2021-04-01", + "vmName": "VMName" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ReimageVirtualMachine.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ReimageVirtualMachine.json new file mode 100644 index 000000000000..fde680d23158 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/ReimageVirtualMachine.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-01", + "vmName": "myVMName", + "parameters": { + "tempDisk": true + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/RetrieveBootDiagnosticsDataVMScaleSetVM.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/RetrieveBootDiagnosticsDataVMScaleSetVM.json new file mode 100644 index 000000000000..0cc7ba4eac5e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/RetrieveBootDiagnosticsDataVMScaleSetVM.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "ResourceGroup", + "api-version": "2021-04-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/stable/2021-04-01/examples/RetrieveBootDiagnosticsDataVirtualMachine.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/RetrieveBootDiagnosticsDataVirtualMachine.json new file mode 100644 index 000000000000..9555878e99d3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/RetrieveBootDiagnosticsDataVirtualMachine.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "ResourceGroup", + "api-version": "2021-04-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/stable/2021-04-01/examples/SimulateEvictionOfVM.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/SimulateEvictionOfVM.json new file mode 100644 index 000000000000..662ffb458c76 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/SimulateEvictionOfVM.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "ResourceGroup", + "api-version": "2021-04-01", + "vmName": "VMName" + }, + "responses": { + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/SimulateEvictionOfVmssVM.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/SimulateEvictionOfVmssVM.json new file mode 100644 index 000000000000..7bc3bb704a5f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/SimulateEvictionOfVmssVM.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "ResourceGroup", + "vmScaleSetName": "VmScaleSetName", + "api-version": "2021-04-01", + "instanceId": "InstanceId" + }, + "responses": { + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/UpdateImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/UpdateImage.json new file mode 100644 index 000000000000..cdb7f304612e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/UpdateImage.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-04-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/stable/2021-04-01/examples/UpdateRunCommand.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/UpdateRunCommand.json new file mode 100644 index 000000000000..d705159eb175 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/UpdateRunCommand.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "runCommandName": "myRunCommand", + "api-version": "2021-04-01", + "runCommand": { + "properties": { + "source": { + "script": "Write-Host Script Source Updated!" + } + } + } + }, + "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 Script Source Updated!" + }, + "parameters": [ + { + "name": "param1", + "value": "value1" + }, + { + "name": "param2", + "value": "value2" + } + ], + "asyncExecution": false, + "runAsUser": "user1", + "timeoutInSeconds": 3600, + "provisioningState": "Updating" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/UpdateVMDetachDataDiskUsingToBeDetachedProperty.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/UpdateVMDetachDataDiskUsingToBeDetachedProperty.json new file mode 100644 index 000000000000..9e0387ccae84 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/UpdateVMDetachDataDiskUsingToBeDetachedProperty.json @@ -0,0 +1,135 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/UpdateVMForceDetachDataDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/UpdateVMForceDetachDataDisk.json new file mode 100644 index 000000000000..4908ecd66fdb --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/UpdateVMForceDetachDataDisk.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2021-04-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/stable/2021-04-01/examples/UpdateVirtualMachineScaleSetVMExtensions.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/UpdateVirtualMachineScaleSetVMExtensions.json new file mode 100644 index 000000000000..4a570a5234c3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/UpdateVirtualMachineScaleSetVMExtensions.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "vmExtensionName": "myVMExtension", + "api-version": "2021-04-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/stable/2021-04-01/examples/UpdateVirtualMachineScaleSetVMRunCommands.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/UpdateVirtualMachineScaleSetVMRunCommands.json new file mode 100644 index 000000000000..059db6adabe6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/UpdateVirtualMachineScaleSetVMRunCommands.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "runCommandName": "myRunCommand", + "api-version": "2021-04-01", + "runCommand": { + "properties": { + "source": { + "script": "Write-Host Script Source Updated!" + } + } + } + }, + "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": { + "script": "Write-Host Script Source Updated!" + }, + "parameters": [ + { + "name": "param1", + "value": "value1" + }, + { + "name": "param2", + "value": "value2" + } + ], + "asyncExecution": false, + "runAsUser": "user1", + "timeoutInSeconds": 3600, + "provisioningState": "Updating" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/VMScaleSetExtensionRollingUpgrade.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/VMScaleSetExtensionRollingUpgrade.json new file mode 100644 index 000000000000..5a7210cf0f85 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/VMScaleSetExtensionRollingUpgrade.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2021-04-01" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/VMScaleSetRunCommand.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/VMScaleSetRunCommand.json new file mode 100644 index 000000000000..3814ec9341c9 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/VMScaleSetRunCommand.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myVirtualMachineScaleSet", + "instanceId": "0", + "api-version": "2021-04-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": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/VirtualMachineAssessPatches.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/VirtualMachineAssessPatches.json new file mode 100644 index 000000000000..e59f57cb3d1b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/VirtualMachineAssessPatches.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "api-version": "2021-04-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": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/VirtualMachineInstallPatches.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/VirtualMachineInstallPatches.json new file mode 100644 index 000000000000..cabd945e6589 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/VirtualMachineInstallPatches.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "api-version": "2021-04-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": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/VirtualMachineRunCommand.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/VirtualMachineRunCommand.json new file mode 100644 index 000000000000..7cf5b15eed6a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/VirtualMachineRunCommand.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "24fb23e3-6ba3-41f0-9b6e-e41131d5d61e", + "resourceGroupName": "crptestar98131", + "vmName": "vm3036", + "$top": 1, + "api-version": "2021-04-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": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/VirtualMachineRunCommandGet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/VirtualMachineRunCommandGet.json new file mode 100644 index 000000000000..0ca93cd159da --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/VirtualMachineRunCommandGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "24fb23e3-6ba3-41f0-9b6e-e41131d5d61e", + "location": "SoutheastAsia", + "commandId": "RunPowerShellScript", + "api-version": "2021-04-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/stable/2021-04-01/examples/VirtualMachineRunCommandList.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/VirtualMachineRunCommandList.json new file mode 100644 index 000000000000..b6c72d586787 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/examples/VirtualMachineRunCommandList.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "SoutheastAsia", + "api-version": "2021-04-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/stable/2021-04-01/runCommands.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/runCommands.json new file mode 100644 index 000000000000..a05d2e7f7e8f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-04-01/runCommands.json @@ -0,0 +1,1438 @@ +{ + "swagger": "2.0", + "info": { + "title": "RunCommandsClient", + "description": "The Run Commands Client.", + "version": "2021-04-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/VirtualMachineRunCommandList.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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/VirtualMachineRunCommandGet.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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/VMScaleSetRunCommand.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update a run command.": { + "$ref": "./examples/CreateOrUpdateRunCommand.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommand" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a run command.": { + "$ref": "./examples/UpdateRunCommand.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a run command.": { + "$ref": "./examples/DeleteRunCommand.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommand" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a run command.": { + "$ref": "./examples/GetRunCommand.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommandsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List run commands in a Virtual Machine.": { + "$ref": "./examples/ListRunCommandsInVM.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create VirtualMachineScaleSet VM run command.": { + "$ref": "./examples/CreateOrUpdateVirtualMachineScaleSetVMRunCommands.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommand" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update VirtualMachineScaleSet VM run command.": { + "$ref": "./examples/UpdateVirtualMachineScaleSetVMRunCommands.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete VirtualMachineScaleSet VM run command.": { + "$ref": "./examples/DeleteVirtualMachineScaleSetVMRunCommands.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommand" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get VirtualMachineScaleSet VM run commands.": { + "$ref": "./examples/GetVirtualMachineScaleSetVMRunCommands.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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommandsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List run commands in Vmss instance.": { + "$ref": "./examples/ListVirtualMachineScaleSetVMRunCommands.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" + ], + "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" + }, + "description": "The run command parameters." + } + }, + "required": [ + "commandId" + ], + "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" + ], + "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" + ], + "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" + }, + "description": "The parameters used by the script." + } + }, + "required": [ + "script" + ], + "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" + ], + "description": "The List Virtual Machine operation response." + }, + "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." + } + }, + "description": "Instance view status." + }, + "RunCommandResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "Run command operation response." + } + } + }, + "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": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "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." + }, + "commandId": { + "type": "string", + "description": "Specifies a commandId of predefined built-in script." + } + }, + "description": "Describes the script sources for run command." + }, + "VirtualMachineRunCommandProperties": { + "properties": { + "source": { + "$ref": "#/definitions/VirtualMachineRunCommandScriptSource", + "description": "The source of the run command script." + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/RunCommandInputParameter" + }, + "description": "The parameters used by the script." + }, + "protectedParameters": { + "type": "array", + "items": { + "$ref": "#/definitions/RunCommandInputParameter" + }, + "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." + }, + "errorBlobUri": { + "type": "string", + "description": "Specifies the Azure storage blob where script error stream will be uploaded." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "instanceView": { + "readOnly": true, + "$ref": "#/definitions/VirtualMachineRunCommandInstanceView", + "description": "The virtual machine run command instance view." + } + }, + "description": "Describes the properties of a Virtual Machine run command." + }, + "VirtualMachineRunCommand": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineRunCommandProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine run command." + }, + "VirtualMachineRunCommandUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineRunCommandProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "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" + ], + "description": "The List run command operation response" + }, + "ApiErrorBase": { + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "Api error base." + }, + "InnerError": { + "properties": { + "exceptiontype": { + "type": "string", + "description": "The exception type." + }, + "errordetail": { + "type": "string", + "description": "The internal error message or exception dump." + } + }, + "description": "Inner error details." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/ApiError" + } + }, + "description": "An error response from the Compute service." + }, + "ApiError": { + "properties": { + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiErrorBase" + }, + "description": "The Api error details" + }, + "innererror": { + "$ref": "#/definitions/InnerError", + "description": "The Api inner error" + }, + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "Api error." + }, + "Resource": { + "description": "The 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" + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + }, + "UpdateResource": { + "description": "The Update Resource model definition.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } +} diff --git a/specification/compute/resource-manager/readme.go.md b/specification/compute/resource-manager/readme.go.md index 5144774ed3b6..cf01a327f3da 100644 --- a/specification/compute/resource-manager/readme.go.md +++ b/specification/compute/resource-manager/readme.go.md @@ -2,13 +2,14 @@ These settings apply only when `--go` is specified on the command line. -```yaml $(go) && !(track2) +```yaml $(go) && !$(track2) go: license-header: MICROSOFT_MIT_NO_VERSION clear-output-folder: true directive: - # dynamically add a DummyOrchestrationServiceName value to the enum + # dynamically add a DummyOrchestrationServiceName value to the enum and then remove it from the generated code to avoid the generator generates the code by hard-coding the single-entry enum value + # this directive adds a DummyOrchestrationServiceName to the enum type - from: compute.json where: $..enum transform: >- @@ -17,14 +18,15 @@ directive: } return $; + # this directive removes the DummyOrchestrationServiceName from the generated code, so that we still have only one enum entry in this enum type. - from: source-file-go where: $ transform: >- return $. - replace(/\/\/ DummyOrchestrationServiceName .../g,''). - replace(/DummyOrchestrationServiceName OrchestrationServiceNames = "DummyOrchestrationServiceName"\n/g,''). - replace(/,DummyOrchestrationServiceName/,''). - replace(/, 'DummyOrchestrationServiceName'/,''); + replace(/\/\/ (OrchestrationServiceNames)?DummyOrchestrationServiceName .../g,''). + replace(/(OrchestrationServiceNames)?DummyOrchestrationServiceName OrchestrationServiceNames = "DummyOrchestrationServiceName"\n/g,''). + replace(/,(OrchestrationServiceNames)?DummyOrchestrationServiceName/,''). + replace(/, '(OrchestrationServiceNames)?DummyOrchestrationServiceName'/,''); ``` ``` yaml $(go) && $(track2) @@ -35,6 +37,7 @@ output-folder: $(go-sdk-folder)/$(module-name) azure-arm: true directive: + # we do not need to hack to add a dummy enum entry in track 2, because track 2 generator will generate the enum type even if it only has on entry - from: disk.json where: "$.definitions.PurchasePlan" transform: > @@ -45,6 +48,7 @@ directive: ```yaml $(go) && $(multiapi) batch: + - tag: package-2021-04-01 - tag: package-2021-03-01 - tag: package-2020-12-01 - tag: package-2020-10-01-preview @@ -69,6 +73,16 @@ batch: - tag: package-container-service-2015-11-preview ``` +### Tag: package-2021-04-01 and go + +These settings apply only when `--tag=package-2021-04-01 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +```yaml $(tag)=='package-2021-04-01' && $(go) +namespace: compute +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2021-04-01/$(namespace) +``` + ### Tag: package-2021-03-01 and go These settings apply only when `--tag=package-2021-03-01 --go` is specified on the command line. diff --git a/specification/compute/resource-manager/readme.md b/specification/compute/resource-manager/readme.md index 1f07309b64ab..6f923ad453c3 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-2021-03-01 +tag: package-2021-04-01 directive: - where: @@ -229,6 +229,31 @@ directive: reason: - CRP supports the list /restorePoint operation by allowing customers to call Get RestorePointCollection with $expand=RestorePoints ``` +### Tag: package-2021-04-01 + +These settings apply only when `--tag=package-2021-04-01` is specified on the command line. + +``` yaml $(tag) == 'package-2021-04-01' +input-file: +- Microsoft.Compute/stable/2021-04-01/compute.json +- Microsoft.Compute/stable/2021-04-01/runCommands.json +- Microsoft.Compute/stable/2019-04-01/skus.json +- Microsoft.Compute/stable/2020-12-01/disk.json +- Microsoft.Compute/stable/2020-09-30/gallery.json +- Microsoft.Compute/stable/2020-09-30/sharedGallery.json +- Microsoft.Compute/stable/2021-03-01/cloudService.json +``` + +### Tag: package-2021-04-01-only + +These settings apply only when `--tag=package-2021-04-01-only` is specified on the command line. + +``` yaml $(tag) == 'package-2021-04-01-only' +input-file: +- Microsoft.Compute/stable/2021-04-01/compute.json +- Microsoft.Compute/stable/2021-04-01/runCommands.json +``` + ### Tag: package-2021-03-01 These settings apply only when `--tag=package-2021-03-01` is specified on the command line. diff --git a/specification/compute/resource-manager/readme.python.md b/specification/compute/resource-manager/readme.python.md index 69726bc4ee7d..00b026529eb0 100644 --- a/specification/compute/resource-manager/readme.python.md +++ b/specification/compute/resource-manager/readme.python.md @@ -36,6 +36,7 @@ Generate all API versions currently shipped for this package ```yaml $(multiapi) clear-output-folder: true batch: + - tag: package-2021-04-01-only - tag: package-2021-03-01-only - tag: package-2020-12-01-only - tag: package-2020-10-01-preview-only @@ -67,6 +68,16 @@ clear-output-folder: false perform-load: false ``` +### Tag: package-2021-04-01-only + +These settings apply only when `--tag=package-2021-04-01-only --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2021-04-01-only' +namespace: azure.mgmt.compute.v2021_04_01 +output-folder: $(python-sdks-folder)/compute/azure-mgmt-compute/azure/mgmt/compute/v2021_04_01 +``` + ### Tag: package-2021-03-01-only These settings apply only when `--tag=package-2021-03-01-only --python` is specified on the command line. diff --git a/specification/compute/resource-manager/readme.typescript.md b/specification/compute/resource-manager/readme.typescript.md index b6fd59f1adbd..20938f8dfd23 100644 --- a/specification/compute/resource-manager/readme.typescript.md +++ b/specification/compute/resource-manager/readme.typescript.md @@ -27,7 +27,7 @@ directive: replace(/[,|*] 'DummyOrchestrationServiceName'/g,''); ``` -``` yaml $(typescript) && !$(profile) +``` yaml $(typescript) && !$(profile-content) package-name: "@azure/arm-compute" output-folder: "$(typescript-sdks-folder)/sdk/compute/arm-compute" clear-output-folder: true @@ -36,9 +36,9 @@ directive: ### Profile: profile-hybrid-2019-03-01 -These settings apply only when `--profile=profile-hybrid-2019-03-01` is specified on the command line. +These settings apply only when `--profile-content=profile-hybrid-2019-03-01` is specified on the command line. -``` yaml $(profile)=='profile-hybrid-2019-03-01' +``` yaml $(profile-content)=='profile-hybrid-2019-03-01' typescript: package-name: "@azure/arm-compute-profile-2019-03-01-hybrid" output-folder: "$(typescript-sdks-folder)/sdk/compute/arm-compute-profile-2019-03-01-hybrid" @@ -48,9 +48,9 @@ typescript: ### Profile: profile-hybrid-2020-09-01 -These settings apply only when `--profile=profile-hybrid-2020-09-01` is specified on the command line. +These settings apply only when `--profile-content=profile-hybrid-2020-09-01` is specified on the command line. -``` yaml $(profile)=='profile-hybrid-2020-09-01' +``` yaml $(profile-content)=='profile-hybrid-2020-09-01' typescript: package-name: "@azure/arm-compute-profile-2020-09-01-hybrid" output-folder: "$(typescript-sdks-folder)/sdk/compute/arm-compute-profile-2020-09-01-hybrid" @@ -59,4 +59,4 @@ typescript: generate-metadata: true batch: - tag: profile-hybrid-2020-09-01 -``` \ No newline at end of file +``` diff --git a/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/confidentialledger.json b/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/confidentialledger.json new file mode 100644 index 000000000000..96e423cee57f --- /dev/null +++ b/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/confidentialledger.json @@ -0,0 +1,730 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-05-13-preview", + "title": "ConfidentialLedger", + "description": "Microsoft Azure Confidential Compute Ledger Control Plane REST API version 2020-12-01-preview." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.ConfidentialLedger/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Retrieves a list of available API operations", + "summary": "Retrieves a list of available API operations under this Resource Provider.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; response contains the list of operations under Microsoft.ConfidentialLedger resource provider.", + "schema": { + "$ref": "#/definitions/ResourceProviderOperationList" + } + }, + "default": { + "description": "Error response describing the reason for operation failure. 404 - NotFound (Confidential Ledger does not exist.)", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OperationsGet": { + "$ref": "./examples/Operations_Get.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ConfidentialLedger/checkNameAvailability": { + "post": { + "tags": [ + "NameAvailability" + ], + "description": "To check whether a resource name is available.", + "operationId": "CheckNameAvailability", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "nameAvailabilityRequest", + "in": "body", + "description": "Name availability request payload.", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/CheckNameAvailabilityRequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/CheckNameAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing the reason for operation failure.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckNameAvailability": { + "$ref": "./examples/CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConfidentialLedger/ledgers/{ledgerName}": { + "get": { + "tags": [ + "Confidential Ledger" + ], + "summary": "Retrieves information about a Confidential Ledger resource.", + "description": "Retrieves the properties of a Confidential Ledger.", + "operationId": "Ledger_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/LedgerNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; response contains the Confidential Ledger", + "schema": { + "$ref": "#/definitions/ConfidentialLedger" + } + }, + "default": { + "description": "Error response describing the reason for operation failure. 404 - NotFound (Confidential Ledger does not exist.)", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConfidentialLedgerGet": { + "$ref": "./examples/ConfidentialLedger_Get.json" + } + } + }, + "delete": { + "tags": [ + "Confidential Ledger" + ], + "summary": "Deletes a Confidential Ledger resource.", + "description": "Deletes an existing Confidential Ledger.", + "operationId": "Ledger_Delete", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/LedgerNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the Confidential Ledger is deleted." + }, + "202": { + "description": "The Confidential Ledger resource will be deleted asynchronously" + }, + "204": { + "description": "The request was successful; Confidential Ledger does not exist." + }, + "default": { + "description": "Error response describing the reason for operation failure. 409 - Conflict(Confidential Ledger is in a non-terminal state due to an ongoing operation.)", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConfidentialLedgerDelete": { + "$ref": "./examples/ConfidentialLedger_Delete.json" + } + } + }, + "put": { + "tags": [ + "Confidential Ledger" + ], + "summary": "Creates a Confidential Ledger.", + "description": "Creates a Confidential Ledger with the specified ledger parameters.", + "operationId": "Ledger_Create", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/LedgerNameParameter" + }, + { + "name": "confidentialLedger", + "in": "body", + "description": "Confidential Ledger Create Request Body", + "required": true, + "schema": { + "$ref": "#/definitions/ConfidentialLedger" + } + } + ], + "responses": { + "200": { + "description": "The request was successful and ledger was created; response contains the Confidential Ledger", + "schema": { + "$ref": "#/definitions/ConfidentialLedger" + } + }, + "201": { + "description": "The Confidential Ledger resource will be created asynchronously" + }, + "default": { + "description": "Error response describing the reason for operation failure. 404 - NotFound (Confidential Ledger could not be created/updated)", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConfidentialLedgerCreate": { + "$ref": "./examples/ConfidentialLedger_Create.json" + } + } + }, + "patch": { + "tags": [ + "Confidential Ledger" + ], + "summary": "Update Confidential Ledger properties", + "description": "Updates properties of Confidential Ledger", + "operationId": "Ledger_Update", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/LedgerNameParameter" + }, + { + "name": "confidentialLedger", + "in": "body", + "description": "Confidential Ledger request body for Updating Ledger", + "required": true, + "schema": { + "$ref": "#/definitions/ConfidentialLedger" + } + } + ], + "responses": { + "200": { + "description": "The request was successful and ledger was recovered; response contains the Confidential Ledger", + "schema": { + "$ref": "#/definitions/ConfidentialLedger" + } + }, + "201": { + "description": "The Confidential Ledger resource will be updated asynchronously" + }, + "default": { + "description": "Error response describing the reason for operation failure. 404 - NotFound (Confidential Ledger could not be created/updated)", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConfidentialLedgerUpdate": { + "$ref": "./examples/ConfidentialLedger_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConfidentialLedger/ledgers": { + "get": { + "tags": [ + "Confidential Ledger" + ], + "summary": "Retrieves information about all Confidential Ledger resources under the given subscription and resource group", + "description": "Retrieves the properties of all Confidential Ledgers.", + "operationId": "Ledger_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "type": "string", + "description": "The filter to apply on the list operation. eg. $filter=ledgerType eq 'Public'", + "name": "$filter", + "in": "query" + } + ], + "responses": { + "200": { + "description": "The request was successful; response contains the Confidential Ledger", + "schema": { + "$ref": "#/definitions/ConfidentialLedgerList" + } + }, + "default": { + "description": "Error response describing the reason for operation failure. 404 - NotFound (Confidential Ledger does not exist.)", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ConfidentialLedgerList": { + "$ref": "./examples/ConfidentialLedger_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ConfidentialLedger/ledgers/": { + "get": { + "tags": [ + "Confidential Ledger" + ], + "summary": "Retrieves information about all Confidential Ledger resources under the given subscription", + "description": "Retrieves the properties of all Confidential Ledgers.", + "operationId": "Ledger_ListBySubscription", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "type": "string", + "description": "The filter to apply on the list operation. eg. $filter=ledgerType eq 'Public'", + "name": "$filter", + "in": "query" + } + ], + "responses": { + "200": { + "description": "The request was successful; response contains the list of Confidential Ledgers", + "schema": { + "$ref": "#/definitions/ConfidentialLedgerList" + } + }, + "default": { + "description": "Error response describing the reason for operation failure. 404 - NotFound (Confidential Ledger does not exist.)", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ConfidentialLedgerListBySub": { + "$ref": "./examples/ConfidentialLedger_ListBySub.json" + } + } + } + } + }, + "definitions": { + "Location": { + "description": "Location of the ARM Resource", + "type": "object", + "properties": { + "location": { + "description": "The Azure location where the Confidential Ledger is running.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + } + }, + "Tags": { + "description": "Tags for Confidential Ledger Resource", + "type": "object", + "properties": { + "tags": { + "type": "object", + "description": "Additional tags for Confidential Ledger", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ] + } + } + }, + "Resource": { + "description": "An Azure resource.", + "x-ms-azure-resource": true, + "type": "object", + "properties": { + "name": { + "description": "Name of the Resource.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Fully qualified resource Id for the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + } + }, + "ResourceProviderOperationList": { + "description": "List containing this Resource Provider's available operations.", + "type": "object", + "properties": { + "value": { + "description": "Resource provider operations list.", + "type": "array", + "items": { + "$ref": "#/definitions/ResourceProviderOperationDefinition" + }, + "readOnly": true + }, + "nextLink": { + "description": "The URI that can be used to request the next page for list of Azure operations.", + "type": "string", + "readOnly": true + } + } + }, + "ResourceProviderOperationDefinition": { + "description": "Describes the Resource Provider Operation.", + "type": "object", + "properties": { + "name": { + "description": "Resource provider operation name.", + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation is data action or not.", + "type": "boolean" + }, + "display": { + "description": "Details about the operations", + "$ref": "#/definitions/ResourceProviderOperationDisplay" + } + } + }, + "ResourceProviderOperationDisplay": { + "description": "Describes the properties of the Operation.", + "type": "object", + "properties": { + "provider": { + "description": "Name of the resource provider.", + "type": "string" + }, + "resource": { + "description": "Name of the resource type.", + "type": "string" + }, + "operation": { + "description": "Name of the resource provider operation.", + "type": "string" + }, + "description": { + "description": "Description of the resource provider operation.", + "type": "string" + } + } + }, + "ConfidentialLedgerType": { + "type": "string", + "description": "Type of the ledger. Private means transaction data is encrypted.", + "enum": [ + "Unknown", + "Public", + "Private" + ], + "x-ms-enum": { + "name": "LedgerType", + "modelAsString": true + } + }, + "ProvisioningState": { + "type": "string", + "description": "Object representing ProvisioningState for Confidential Ledger.", + "enum": [ + "Unknown", + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "LedgerRoleName": { + "description": "LedgerRole associated with the Security Principal of Ledger", + "type": "string", + "enum": [ + "Reader", + "Contributor", + "Administrator" + ], + "x-ms-enum": { + "name": "LedgerRoleName", + "modelAsString": true + } + }, + "CertBasedSecurityPrincipal": { + "type": "object", + "description": "Cert based security principal with Ledger RoleName", + "properties": { + "cert": { + "description": "Base64 encoded public key of the user cert (.pem or .cer)", + "type": "string" + }, + "ledgerRoleName": { + "$ref": "#/definitions/LedgerRoleName" + } + } + }, + "AADBasedSecurityPrincipal": { + "type": "object", + "description": "AAD based security principal with associated Ledger RoleName", + "properties": { + "principalId": { + "description": "UUID/GUID based Principal Id of the Security Principal", + "type": "string" + }, + "tenantId": { + "description": "UUID/GUID based Tenant Id of the Security Principal", + "type": "string" + }, + "ledgerRoleName": { + "$ref": "#/definitions/LedgerRoleName" + } + } + }, + "LedgerProperties": { + "type": "object", + "description": "Additional Confidential Ledger properties.", + "title": "LedgerProperties", + "properties": { + "ledgerName": { + "readOnly": true, + "type": "string", + "description": "Unique name for the Confidential Ledger." + }, + "ledgerUri": { + "type": "string", + "readOnly": true, + "description": "Endpoint for calling Ledger Service." + }, + "identityServiceUri": { + "type": "string", + "readOnly": true, + "description": "Endpoint for accessing network identity." + }, + "ledgerInternalNamespace": { + "type": "string", + "readOnly": true, + "description": "Internal namespace for the Ledger" + }, + "ledgerType": { + "description": "Type of Confidential Ledger", + "$ref": "#/definitions/ConfidentialLedgerType" + }, + "provisioningState": { + "description": "Provisioning state of Ledger Resource", + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "aadBasedSecurityPrincipals": { + "description": "Array of all AAD based Security Principals.", + "type": "array", + "items": { + "$ref": "#/definitions/AADBasedSecurityPrincipal" + } + }, + "certBasedSecurityPrincipals": { + "description": "Array of all cert based Security Principals.", + "type": "array", + "items": { + "$ref": "#/definitions/CertBasedSecurityPrincipal" + } + } + } + }, + "ConfidentialLedger": { + "type": "object", + "description": "Confidential Ledger. Contains the properties of Confidential Ledger Resource.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "$ref": "#/definitions/Location" + }, + { + "$ref": "#/definitions/Tags" + } + ], + "properties": { + "properties": { + "description": "Properties of Confidential Ledger Resource.", + "$ref": "#/definitions/LedgerProperties" + } + } + }, + "ConfidentialLedgerList": { + "description": "Object that includes an array of Confidential Ledgers and a possible link for next set.", + "type": "object", + "properties": { + "value": { + "description": "List of Confidential Ledgers", + "type": "array", + "items": { + "$ref": "#/definitions/ConfidentialLedger" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).", + "type": "string" + } + } + } + }, + "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)" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "maxLength": 90, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to be used with the HTTP request." + }, + "LedgerNameParameter": { + "name": "ledgerName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the Confidential Ledger", + "pattern": "^[a-zA-Z0-9]", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/CheckNameAvailability.json b/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..c6ad9c826664 --- /dev/null +++ b/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/CheckNameAvailability.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-05-13-preview", + "nameAvailabilityRequest": { + "name": "sample-name", + "type": "Microsoft.ConfidentialLedger/ledgers" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/ConfidentialLedger_Create.json b/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/ConfidentialLedger_Create.json new file mode 100644 index 000000000000..75df24f7242e --- /dev/null +++ b/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/ConfidentialLedger_Create.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2021-05-13-preview", + "subscriptionId": "0000000-0000-0000-0000-000000000001", + "resourceGroupName": "DummyResourceGroupName", + "ledgerName": "DummyLedgerName", + "confidentialLedger": { + "properties": { + "ledgerType": "Public", + "aadBasedSecurityPrincipals": [ + { + "principalId": "34621747-6fc8-4771-a2eb-72f31c461f2e", + "tenantId": "bce123b9-2b7b-4975-8360-5ca0b9b1cd08", + "ledgerRoleName": "Administrator" + } + ], + "certBasedSecurityPrincipals": [ + { + "cert": "MIIDBTCCAe2gAwIBAgIQXVogj9BAf49IpuOSIvztNDANBgkqhkiG9w0BAQsFADAtMSswKQYDVQQDEyJhY2NvdW50cy5hY2Nlc3Njb250cm9sLndpbmRvd3MubmV0MB4XDTIwMDMxNzAwMDAwMFoXDTI1MDMxNzAwMDAwMFowLTErMCkGA1UEAxMiYWNjb3VudHMuYWNjZXNzY29udHJvbC53aW5kb3dzLm5ldDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBANfLmdz9yIDskpZzrMXiDeVlCs75ZunrzwzBW5lz7UxdBjHu7Q9iT32otlBp++LOwBcKsVjuQ0GUbulX0FLsfLjEeCe58ZtSn//+6VRFSScg7i+WvDwEUWELR+vMPtCGcXBTpILEnYbSMz0No4+Jpkc1lyMIfDP/KSeqojo74xfW4RKtAgv39uwZ5Yz2hZ/IcWOvaQqMXp1lqhXLFIRWbwjLYYUbmwGwYpQ6++Cml0ucQoMkgYT88HpA/fzXQlLgrHamr3eE/lVp26ZWwfGLAvkdNBabQRSrk8k/c6BmY1mYpUFZo+795PI16mAdp1ioEwH8I5osis+/BR5GhPpwiA8CAwEAAaMhMB8wHQYDVR0OBBYEFF8MDGklOGhGNVJvsHHRCaqtzexcMA0GCSqGSIb3DQEBCwUAA4IBAQCKkegw/mdpCVl1lOpgU4G9RT+1gtcPqZK9kpimuDggSJju6KUQlOCi5/lIH5DCzpjFdmG17TjWVBNve5kowmrhLzovY0Ykk7+6hYTBK8dNNSmd4SK7zY++0aDIuOzHP2Cur+kgFC0gez50tPzotLDtMmp40gknXuzltwJfezNSw3gLgljDsGGcDIXK3qLSYh44qSuRGwulcN2EJUZBI9tIxoODpaWHIN8+z2uZvf8JBYFjA3+n9FRQn51X16CTcjq4QRTbNVpgVuQuyaYnEtx0ZnDvguB3RjGSPIXTRBkLl2x7e8/6uAZ6tchw8rhcOtPsFgJuoJokGjvcUSR/6Eqd", + "ledgerRoleName": "Reader" + } + ] + }, + "location": "EastUS", + "tags": { + "additionalProps1": "additional properties" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "ledgerName": "DummyLedgerName", + "ledgerUri": "https://dummy.accledger.domain.com/DummyLedgerName", + "identityServiceUri": "https://dummy.accledger.identity.com/DummyLedgerName", + "ledgerType": "Public", + "ledgerInternalNamespace": "dummyNamespace", + "provisioningState": "Succeeded", + "aadBasedSecurityPrincipals": [ + { + "principalId": "34621747-6fc8-4771-a2eb-72f31c461f2e", + "tenantId": "bce123b9-2b7b-4975-8360-5ca0b9b1cd08", + "ledgerRoleName": "Administrator" + } + ], + "certBasedSecurityPrincipals": [ + { + "cert": "-----BEGIN CERTIFICATE-----\nMIIDUjCCAjqgAwIBAgIQJ2IrDBawSkiAbkBYmiAopDANBgkqhkiG9w0BAQsFADAmMSQwIgYDVQQDExtTeW50aGV0aWNzIExlZGdlciBVc2VyIENlcnQwHhcNMjAwOTIzMjIxODQ2WhcNMjEwOTIzMjIyODQ2WjAmMSQwIgYDVQQDExtTeW50aGV0aWNzIExlZGdlciBVc2VyIENlcnQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCX2s/Eu4q/eQ63N+Ugeg5oAciZua/YCJr41c/696szvSY7Zg1SNJlW88/nbz70+QpO55OmqlEE3QCU+T0Vl/h0Gf//n1PYcoBbTGUnYEmV+fTTHict6rFiEwrGJ62tvcpYgwapInSLyEeUzjki0zhOLJ1OfRnYd1eGnFVMpE5aVjiS8Q5dmTEUyd51EIprGE8RYAW9aeWSwTH7gjHUsRlJnHKcdhaK/v5QKJnNu5bzPFUcpC0ZBcizoMPAtroLAD4B68Jl0z3op18MgZe6lRrVoWuxfqnk5GojuB/Vu8ohAZKoFhQ6NB6r+LL2AUs+Zr7Bt26IkEdR178n9JMEA4gHAgMBAAGjfDB6MA4GA1UdDwEB/wQEAwIFoDAJBgNVHRMEAjAAMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAfBgNVHSMEGDAWgBS/a7PU9iOfOKEyZCp11Oen5VSuuDAdBgNVHQ4EFgQUv2uz1PYjnzihMmQqddTnp+VUrrgwDQYJKoZIhvcNAQELBQADggEBAF5q2fDwnse8egXhfaJCqqM969E9gSacqFmASpoDJPRPEX7gqoO7v1ww7nqRtRDoRiBvo/yNk7jlSAkRN3nRRnZLZZ3MYQdmCr4FGyIqRg4Y94+nja+Du9pDD761rxRktMVPSOaAVM/E5DQvscDlPvlPYe9mkcrLCE4DXYpiMmLT8Tm55LJJq5m07dVDgzAIR1L/hmEcbK0pnLgzciMtMLxGO2udnyyW/UW9WxnjvrrD2JluTHH9mVbb+XQP1oFtlRBfH7aui1ZgWfKvxrdP4zdK9QoWSUvRux3TLsGmHRBjBMtqYDY3y5mB+aNjLelvWpeVb0m2aOSVXynrLwNCAVA=\n-----END CERTIFICATE-----", + "ledgerRoleName": "Reader" + } + ] + }, + "name": "DummyLedgerName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.ConfidentialLedger/ledgers/DummyLedgerName", + "type": "Microsoft.ConfidentialLedger/ledgers", + "location": "EastUS", + "tags": { + "additionalProps1": "additional properties" + }, + "systemData": { + "createdBy": "ledgerAdmin@contoso.com", + "createdByType": "Admin1", + "createdAt": "2020-12-01T00:00:00.1234567Z", + "lastModifiedBy": "ledgerAdmin2@outlook.com", + "lastModifiedByType": "Admin2", + "lastModifiedAt": "2020-12-02T00:00:00.1234567Z" + } + } + }, + "201": {} + } +} diff --git a/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/ConfidentialLedger_Delete.json b/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/ConfidentialLedger_Delete.json new file mode 100644 index 000000000000..cd9c1f94cace --- /dev/null +++ b/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/ConfidentialLedger_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-05-13-preview", + "subscriptionId": "0000000-0000-0000-0000-000000000001", + "resourceGroupName": "DummyResourceGroupName", + "ledgerName": "DummyLedgerName" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/ConfidentialLedger_Get.json b/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/ConfidentialLedger_Get.json new file mode 100644 index 000000000000..03d118818c8d --- /dev/null +++ b/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/ConfidentialLedger_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2021-05-13-preview", + "subscriptionId": "0000000-0000-0000-0000-000000000001", + "resourceGroupName": "DummyResourceGroupName", + "ledgerName": "DummyLedgerName" + }, + "responses": { + "200": { + "body": { + "properties": { + "ledgerName": "DummyLedgerName", + "ledgerUri": "https://dummy.accledger.domain.com/DummyLedgerName", + "identityServiceUri": "https://dummy.accledger.identity.com/DummyLedgerName", + "ledgerType": "Public", + "ledgerInternalNamespace": "dummyNamespace", + "provisioningState": "Succeeded", + "aadBasedSecurityPrincipals": [ + { + "principalId": "34621747-6fc8-4771-a2eb-72f31c461f2e", + "tenantId": "bce123b9-2b7b-4975-8360-5ca0b9b1cd08", + "ledgerRoleName": "Administrator" + } + ] + }, + "name": "DummyLedgerName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.ConfidentialLedger/ledgers/DummyLedgerName", + "type": "Microsoft.ConfidentialLedger/ledgers", + "location": "EastUS", + "tags": { + "additionalProps1": "additional properties" + }, + "systemData": { + "createdBy": "ledgerAdmin@contoso.com", + "createdByType": "Admin1", + "createdAt": "2020-12-01T00:00:00.1234567Z", + "lastModifiedBy": "ledgerAdmin2@outlook.com", + "lastModifiedByType": "Admin2", + "lastModifiedAt": "2020-12-02T00:00:00.1234567Z" + } + } + } + } +} diff --git a/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/ConfidentialLedger_List.json b/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/ConfidentialLedger_List.json new file mode 100644 index 000000000000..f3507d4df552 --- /dev/null +++ b/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/ConfidentialLedger_List.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2021-05-13-preview", + "subscriptionId": "0000000-0000-0000-0000-000000000001", + "resourceGroupName": "DummyResourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "ledgerName": "DummyLedgerName", + "ledgerUri": "https://dummy.accledger.domain.com/DummyLedgerName", + "identityServiceUri": "https://dummy.accledger.identity.com/DummyLedgerName", + "ledgerType": "Public", + "ledgerInternalNamespace": "dummyNamespace", + "provisioningState": "Succeeded", + "aadBasedSecurityPrincipals": [ + { + "principalId": "34621747-6fc8-4771-a2eb-72f31c461f2e", + "tenantId": "bce123b9-2b7b-4975-8360-5ca0b9b1cd08", + "ledgerRoleName": "Administrator" + } + ] + }, + "name": "DummyLedgerName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.ConfidentialLedger/ledgers/DummyLedgerName", + "type": "Microsoft.ConfidentialLedger/ledgers", + "location": "EastUS", + "tags": { + "additionalProps1": "additional properties" + }, + "systemData": { + "createdBy": "ledgerAdmin@contoso.com", + "createdByType": "Admin1", + "createdAt": "2020-12-01T00:00:00.1234567Z", + "lastModifiedBy": "ledgerAdmin2@outlook.com", + "lastModifiedByType": "Admin2", + "lastModifiedAt": "2020-12-02T00:00:00.1234567Z" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/ConfidentialLedger_ListBySub.json b/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/ConfidentialLedger_ListBySub.json new file mode 100644 index 000000000000..3c830340d9da --- /dev/null +++ b/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/ConfidentialLedger_ListBySub.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2021-05-13-preview", + "subscriptionId": "0000000-0000-0000-0000-000000000001" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "ledgerName": "DummyLedgerName", + "ledgerUri": "https://dummy.accledger.domain.com/DummyLedgerName", + "identityServiceUri": "https://dummy.accledger.identity.com/DummyLedgerName", + "ledgerType": "Public", + "ledgerInternalNamespace": "dummyNamespace", + "provisioningState": "Succeeded", + "certBasedSecurityPrincipals": [ + { + "cert": "-----BEGIN CERTIFICATE-----\nMIIDUjCCAjqgAwIBAgIQJ2IrDBawSkiAbkBYmiAopDANBgkqhkiG9w0BAQsFADAmMSQwIgYDVQQDExtTeW50aGV0aWNzIExlZGdlciBVc2VyIENlcnQwHhcNMjAwOTIzMjIxODQ2WhcNMjEwOTIzMjIyODQ2WjAmMSQwIgYDVQQDExtTeW50aGV0aWNzIExlZGdlciBVc2VyIENlcnQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCX2s/Eu4q/eQ63N+Ugeg5oAciZua/YCJr41c/696szvSY7Zg1SNJlW88/nbz70+QpO55OmqlEE3QCU+T0Vl/h0Gf//n1PYcoBbTGUnYEmV+fTTHict6rFiEwrGJ62tvcpYgwapInSLyEeUzjki0zhOLJ1OfRnYd1eGnFVMpE5aVjiS8Q5dmTEUyd51EIprGE8RYAW9aeWSwTH7gjHUsRlJnHKcdhaK/v5QKJnNu5bzPFUcpC0ZBcizoMPAtroLAD4B68Jl0z3op18MgZe6lRrVoWuxfqnk5GojuB/Vu8ohAZKoFhQ6NB6r+LL2AUs+Zr7Bt26IkEdR178n9JMEA4gHAgMBAAGjfDB6MA4GA1UdDwEB/wQEAwIFoDAJBgNVHRMEAjAAMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAfBgNVHSMEGDAWgBS/a7PU9iOfOKEyZCp11Oen5VSuuDAdBgNVHQ4EFgQUv2uz1PYjnzihMmQqddTnp+VUrrgwDQYJKoZIhvcNAQELBQADggEBAF5q2fDwnse8egXhfaJCqqM969E9gSacqFmASpoDJPRPEX7gqoO7v1ww7nqRtRDoRiBvo/yNk7jlSAkRN3nRRnZLZZ3MYQdmCr4FGyIqRg4Y94+nja+Du9pDD761rxRktMVPSOaAVM/E5DQvscDlPvlPYe9mkcrLCE4DXYpiMmLT8Tm55LJJq5m07dVDgzAIR1L/hmEcbK0pnLgzciMtMLxGO2udnyyW/UW9WxnjvrrD2JluTHH9mVbb+XQP1oFtlRBfH7aui1ZgWfKvxrdP4zdK9QoWSUvRux3TLsGmHRBjBMtqYDY3y5mB+aNjLelvWpeVb0m2aOSVXynrLwNCAVA=\n-----END CERTIFICATE-----", + "ledgerRoleName": "Reader" + } + ] + }, + "name": "DummyLedgerName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.ConfidentialLedger/ledgers/DummyLedgerName", + "type": "Microsoft.ConfidentialLedger/ledgers", + "location": "EastUS", + "tags": { + "additionalProps1": "additional properties" + }, + "systemData": { + "createdBy": "ledgerAdmin@contoso.com", + "createdByType": "Admin1", + "createdAt": "2020-12-01T00:00:00.1234567Z", + "lastModifiedBy": "ledgerAdmin2@outlook.com", + "lastModifiedByType": "Admin2", + "lastModifiedAt": "2020-12-02T00:00:00.1234567Z" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/ConfidentialLedger_Update.json b/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/ConfidentialLedger_Update.json new file mode 100644 index 000000000000..d822f7d26004 --- /dev/null +++ b/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/ConfidentialLedger_Update.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2021-05-13-preview", + "subscriptionId": "0000000-0000-0000-0000-000000000001", + "resourceGroupName": "DummyResourceGroupName", + "ledgerName": "DummyLedgerName", + "confidentialLedger": { + "properties": {}, + "location": "EastUS", + "tags": { + "additionalProps1": "additional properties", + "additionProps2": "additional property value" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "ledgerName": "DummyLedgerName", + "ledgerUri": "https://dummy.accledger.domain.com/DummyLedgerName", + "identityServiceUri": "https://dummy.accledger.identity.com/DummyLedgerName", + "ledgerType": "Public", + "ledgerInternalNamespace": "dummyNamespace", + "provisioningState": "Succeeded", + "aadBasedSecurityPrincipals": [ + { + "principalId": "34621747-6fc8-4771-a2eb-72f31c461f2e", + "tenantId": "bce123b9-2b7b-4975-8360-5ca0b9b1cd08", + "ledgerRoleName": "Administrator" + } + ] + }, + "name": "DummyLedgerName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.ConfidentialLedger/ledgers/DummyLedgerName", + "type": "Microsoft.ConfidentialLedger/ledgers", + "location": "EastUS", + "tags": { + "additionalProps1": "additional properties", + "additionProps2": "additional property value" + }, + "systemData": { + "createdBy": "ledgerAdmin@contoso.com", + "createdByType": "Admin1", + "createdAt": "2020-12-01T00:00:00.1234567Z", + "lastModifiedBy": "ledgerAdmin2@outlook.com", + "lastModifiedByType": "Admin2", + "lastModifiedAt": "2020-12-02T00:00:00.1234567Z" + } + } + }, + "201": {} + } +} diff --git a/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/Operations_Get.json b/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/Operations_Get.json new file mode 100644 index 000000000000..c8801738e7d8 --- /dev/null +++ b/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/Operations_Get.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2021-05-13-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ConfidentialLedger/ledgers/read", + "isDataAction": false, + "display": { + "resource": "ledger", + "operation": "Get Confidential Ledger properties", + "description": "View the properties of a Confidential Ledger" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/confidentialledger/resource-manager/readme.go.md b/specification/confidentialledger/resource-manager/readme.go.md index 44efe957d751..861fb6931060 100644 --- a/specification/confidentialledger/resource-manager/readme.go.md +++ b/specification/confidentialledger/resource-manager/readme.go.md @@ -4,7 +4,7 @@ These settings apply only when `--go` is specified on the command line. ```yaml $(go) go: - license-header: MICROSOFT_MIT_NO_VERSION + license-header: MICROSOFT_APACHE_NO_VERSION namespace: confidentialledger clear-output-folder: true ``` @@ -14,6 +14,7 @@ go: ``` yaml $(go) && $(multiapi) batch: - tag: package-2020-12-01-preview + - tag: package-2021-05-13-preview ``` ### Tag: package-2020-12-01-preview and go @@ -24,3 +25,12 @@ Please also specify `--go-sdks-folder=`. + +```yaml $(tag) == 'package-2021-05-13-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2021-05-13-preview/$(namespace) +``` diff --git a/specification/confidentialledger/resource-manager/readme.md b/specification/confidentialledger/resource-manager/readme.md index b34f5f14c2cb..c4861ecbcde1 100644 --- a/specification/confidentialledger/resource-manager/readme.md +++ b/specification/confidentialledger/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for the confidentialledger. ```yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2020-12-01-preview +tag: package-2021-05-13-preview ``` ### Tag: package-2020-12-01-preview @@ -39,6 +39,15 @@ input-file: - Microsoft.ConfidentialLedger/preview/2020-12-01-preview/confidentialledger.json ``` +### Tag: package-2021-05-13-preview + +These settings apply only when `--tag=package-2021-05-13-preview` is specified on the command line. + +```yaml $(tag) == 'package-2021-05-13-preview' +input-file: + - Microsoft.ConfidentialLedger/preview/2021-05-13-preview/confidentialledger.json +``` + --- # Code Generation @@ -51,7 +60,7 @@ This is not used by Autorest itself. ```yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js diff --git a/specification/confidentialledger/resource-manager/readme.python.md b/specification/confidentialledger/resource-manager/readme.python.md index aef6ed5ec919..d51e32acadda 100644 --- a/specification/confidentialledger/resource-manager/readme.python.md +++ b/specification/confidentialledger/resource-manager/readme.python.md @@ -3,21 +3,19 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(track2) -azure-arm: true -license-header: MICROSOFT_MIT_NO_VERSION -package-name: azure-mgmt-confidentialledger -no-namespace-folders: true -package-version: 1.0.0b1 -clear-output-folder: true +```yaml $(python) +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: microsoft.confidentialledger + package-name: azure-mgmt-confidentialledger + package-version: 0.0.1 + clear-output-folder: true ``` -``` yaml $(python-mode) == 'update' && $(track2) -no-namespace-folders: true -output-folder: $(python-sdks-folder)/confidentialledger/azure-mgmt-confidentialledger/azure/mgmt/confidentialledger -``` - -``` yaml $(python-mode) == 'create' && $(track2) -basic-setup-py: true -output-folder: $(python-sdks-folder)/confidentialledger/azure-mgmt-confidentialledger +```yaml $(python) +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/confidentialledger/azure-mgmt-confidentialledger/azure/mgmt/confidentialledger ``` diff --git a/specification/confidentialledger/resource-manager/readme.ruby.md b/specification/confidentialledger/resource-manager/readme.ruby.md index 7ce0aac185a6..6497879fb3f5 100644 --- a/specification/confidentialledger/resource-manager/readme.ruby.md +++ b/specification/confidentialledger/resource-manager/readme.ruby.md @@ -17,3 +17,19 @@ Please also specify `--ruby-sdks-folder=`. + +```yaml $(tag) == 'package-2021-05-13-preview' && $(ruby) +namespace: Microsoft.ConfidentialLedger +output-folder: $(ruby-sdks-folder)/confidentialledger +``` \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json index c566b00a8d9a..c6a19e934001 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json @@ -812,7 +812,7 @@ { "name": "startDate", "in": "query", - "description": "Start date. Only applicable when querying with billing profile", + "description": "Start date. Required only when querying with billing profile", "required": false, "type": "string", "x-ms-parameter-location": "method" @@ -820,14 +820,14 @@ { "name": "endDate", "in": "query", - "description": "End date. Only applicable when querying with billing profile", + "description": "End date. Required only when querying with billing profile", "required": false, "type": "string", "x-ms-parameter-location": "method" }, { "name": "$filter", - "description": "Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'. Not applicable when querying with billing profile", + "description": "The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'. Not required when querying with billing profile", "in": "query", "required": false, "type": "string" diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingAccountId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingAccountId.json index e301b98fe19f..ef4d890884ca 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingAccountId.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingAccountId.json @@ -2,7 +2,8 @@ "parameters": { "api-version": "2019-10-01", "scope": "providers/Microsoft.Billing/billingAccounts/12345", - "grain": "monthly" + "grain": "monthly", + "$filter": "properties/usageDate ge 2017-10-01 AND properties/usageDate le 2017-11-20" }, "responses": { "200": { diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingProfileId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingProfileId.json index 72ecb47a78d1..97b7fc49aeb3 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingProfileId.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingProfileId.json @@ -2,7 +2,9 @@ "parameters": { "api-version": "2019-10-01", "scope": "providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579", - "grain": "monthly" + "grain": "monthly", + "startDate": "2017-10-01", + "endDate": "2017-11-20" }, "responses": { "200": { diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingProfileIdReservationId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingProfileIdReservationId.json index 4d7621b008d8..339ca77aff63 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingProfileIdReservationId.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingProfileIdReservationId.json @@ -3,6 +3,8 @@ "api-version": "2019-10-01", "scope": "providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579", "grain": "monthly", + "startDate": "2017-10-01", + "endDate": "2017-11-20", "reservationId": "1c6b6358-709f-484c-85f1-72e862a0cf3b", "reservationOrderId": "9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc" }, diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-11-01/consumption.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-11-01/consumption.json index 55e47eaf75b6..329e7bc17c32 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-11-01/consumption.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-11-01/consumption.json @@ -2073,6 +2073,12 @@ "description": "Indicates how frequently this charge will occur. OneTime for purchases which only happen once, Monthly for fees which recur every month, and UsageBased for charges based on how much a service is used.", "type": "string", "readOnly": true + }, + "payGPrice": { + "description": "Retail price for the resource.", + "type": "number", + "format": "decimal", + "readOnly": true } } }, @@ -2104,6 +2110,11 @@ "type": "string", "readOnly": true }, + "pricingModel": { + "description": "Identifier that indicates how the meter is priced. Possible values could be 'On Demand', 'Reservation', 'Spot'.", + "type": "string", + "readOnly": true + }, "billingAccountName": { "description": "Name of the Billing Account.", "type": "string", diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-05-01/consumption.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-05-01/consumption.json index a4be3db6b309..55d7258b93a8 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-05-01/consumption.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-05-01/consumption.json @@ -1554,7 +1554,7 @@ } } }, - "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/Microsoft.Consumption/aggregatedCost": { + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/aggregatedCost": { "get": { "tags": [ "AggregatedCost" @@ -4999,6 +4999,51 @@ "description": "Identifies the source of the lot for which the event happened. ", "type": "string", "readOnly": true + }, + "canceledCredit": { + "description": "Amount of canceled credit.", + "readOnly": true, + "$ref": "#/definitions/amount" + }, + "creditCurrency": { + "description": "The credit currency of the event.", + "type": "string", + "readOnly": true + }, + "billingCurrency": { + "description": "The billing currency of the event.", + "type": "string", + "readOnly": true + }, + "reseller": { + "description": "The reseller of the event.", + "readOnly": true, + "$ref": "#/definitions/Reseller" + }, + "creditExpiredInBillingCurrency": { + "description": "The amount of expired credit or commitment for NewCredit or SettleCharges event in billing currency.", + "readOnly": true, + "$ref": "#/definitions/AmountWithExchangeRate" + }, + "newCreditInBillingCurrency": { + "description": "The amount of new credit or commitment for NewCredit or SettleCharges event in billing currency.", + "readOnly": true, + "$ref": "#/definitions/AmountWithExchangeRate" + }, + "adjustmentsInBillingCurrency": { + "description": "The amount of balance adjustment in billing currency.", + "readOnly": true, + "$ref": "#/definitions/AmountWithExchangeRate" + }, + "chargesInBillingCurrency": { + "description": "The amount of charges for events of type SettleCharges and PendingEligibleCharges in billing currency.", + "readOnly": true, + "$ref": "#/definitions/AmountWithExchangeRate" + }, + "closedBalanceInBillingCurrency": { + "description": "The balance in billing currency after the event.", + "readOnly": true, + "$ref": "#/definitions/AmountWithExchangeRate" } } }, @@ -5089,7 +5134,44 @@ "status": { "description": "The status of the lot.", "type": "string", + "enum": [ + "None", + "Active", + "Inactive", + "Expired", + "Complete", + "Canceled" + ], + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": true + } + }, + "creditCurrency": { + "description": "The currency of the lot.", + "type": "string", "readOnly": true + }, + "billingCurrency": { + "description": "The billing currency of the lot.", + "type": "string", + "readOnly": true + }, + "originalAmountInBillingCurrency": { + "description": "The original amount of a lot in billing currency.", + "readOnly": true, + "$ref": "#/definitions/AmountWithExchangeRate" + }, + "closedBalanceInBillingCurrency": { + "description": "The balance as of the last invoice in billing currency.", + "readOnly": true, + "$ref": "#/definitions/AmountWithExchangeRate" + }, + "reseller": { + "description": "The reseller of the lot.", + "readOnly": true, + "$ref": "#/definitions/Reseller" } } }, @@ -5132,6 +5214,21 @@ "description": "Pending eligible charges.", "readOnly": true, "$ref": "#/definitions/amount" + }, + "creditCurrency": { + "description": "The credit currency.", + "type": "string", + "readOnly": true + }, + "billingCurrency": { + "description": "The billing currency.", + "type": "string", + "readOnly": true + }, + "reseller": { + "description": "Credit's reseller.", + "readOnly": true, + "$ref": "#/definitions/Reseller" } } }, @@ -5147,6 +5244,11 @@ "description": "Current balance.", "readOnly": true, "$ref": "#/definitions/amount" + }, + "estimatedBalanceInBillingCurrency": { + "description": "Estimated balance in billing currency.", + "readOnly": true, + "$ref": "#/definitions/AmountWithExchangeRate" } } }, @@ -5268,6 +5370,39 @@ } }, "x-ms-azure-resource": true + }, + "AmountWithExchangeRate": { + "description": "The amount with exchange rate.", + "properties": { + "exchangeRate": { + "description": "The exchange rate.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "exchangeRateMonth": { + "description": "The exchange rate month.", + "type": "integer", + "format": "int32", + "readOnly": true + } + } + }, + "Reseller": { + "description": "The reseller properties.", + "type": "object", + "properties": { + "resellerId": { + "description": "The reseller property ID.", + "type": "string", + "readOnly": true + }, + "resellerDescription": { + "description": "The reseller property description.", + "type": "string", + "readOnly": true + } + } } }, "parameters": { diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-05-01/examples/CreditSummaryByBillingProfile.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-05-01/examples/CreditSummaryByBillingProfile.json index 14fe28c08646..1fb696218838 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-05-01/examples/CreditSummaryByBillingProfile.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-05-01/examples/CreditSummaryByBillingProfile.json @@ -11,6 +11,8 @@ "name": "balanceSummary1", "type": "Microsoft.Consumption/credits/balanceSummary", "properties": { + "creditCurrency": "USD", + "billingCurrency": "USD", "balanceSummary": { "estimatedBalance": { "currency": "USD", @@ -32,6 +34,10 @@ "pendingEligibleCharges": { "currency": "USD", "value": 0.00 + }, + "reseller": { + "resellerId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/reseller/reseller1", + "resellerDescription": "Reseller information." } } } diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-05-01/examples/EventsGetByBillingAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-05-01/examples/EventsGetByBillingAccount.json index f35e79cd5742..3bd360a4972e 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-05-01/examples/EventsGetByBillingAccount.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-05-01/examples/EventsGetByBillingAccount.json @@ -17,16 +17,21 @@ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/X3TD-KVTT-BG7-TGB", "billingProfileDisplayName": "Contoso Operations Billing", "transactionDate": "2019-07-01T00:00:00Z", - "description": "Settled invoice #312033", + "description": "New MACC Added", "charges": { "currency": "USD", "value": 500 }, + "newCredit": { + "currency": "USD", + "value": 500 + }, "closedBalance": { "currency": "USD", "value": 500 }, - "invoiceNumber": "3304" + "invoiceNumber": "3304", + "eventType": "NewCredit" } }, { @@ -39,7 +44,7 @@ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/X3TD-KVTT-BG7-TGB", "billingProfileDisplayName": "Contoso Operations Billing", "transactionDate": "2019-07-01T00:00:00Z", - "description": "Settled invoice #312033", + "description": "Balance after invoice 3304", "charges": { "currency": "USD", "value": 500 @@ -48,7 +53,8 @@ "currency": "USD", "value": 500 }, - "invoiceNumber": "3304" + "invoiceNumber": "3304", + "eventType": "SettledCharges" } } ] diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-05-01/examples/EventsGetByBillingAccountWithFilters.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-05-01/examples/EventsGetByBillingAccountWithFilters.json index eba73c41a66c..9f3abbc8588b 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-05-01/examples/EventsGetByBillingAccountWithFilters.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-05-01/examples/EventsGetByBillingAccountWithFilters.json @@ -18,16 +18,17 @@ "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/X3TD-KVTT-BG7-TGB", "billingProfileDisplayName": "Contoso Operations Billing", "transactionDate": "2019-07-01T00:00:00Z", - "description": "Settled invoice #312033", - "charges": { + "description": "MACC Canceled", + "canceledCredit": { "currency": "USD", - "value": 500 + "value": 200 }, "closedBalance": { "currency": "USD", "value": 500 }, - "invoiceNumber": "3304" + "invoiceNumber": "3304", + "eventType": "CanceledCredit" } } ] diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-05-01/examples/EventsListByBillingProfile.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-05-01/examples/EventsListByBillingProfile.json index 5a0bbe735938..737140b05560 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-05-01/examples/EventsListByBillingProfile.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-05-01/examples/EventsListByBillingProfile.json @@ -17,26 +17,52 @@ "properties": { "transactionDate": "2019-07-01T00:00:00Z", "description": "Settled invoice #312033", + "creditCurrency": "USD", + "reseller": { + "resellerId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/reseller/reseller1", + "resellerDescription": "Reseller information" + }, + "billingCurrency": "USD", "newCredit": { "currency": "USD", "value": 0.00 }, + "newCreditInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, "adjustments": { "currency": "USD", "value": 0.00 }, + "adjustmentsInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, "creditExpired": { "currency": "USD", "value": 0.00 }, + "creditExpiredInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, "charges": { "currency": "USD", "value": 500.00 }, + "chargesInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, "closedBalance": { "currency": "USD", "value": 500.00 }, + "closedBalanceInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, "eventType": "SettledCharges", "invoiceNumber": "3301" } @@ -48,26 +74,56 @@ "properties": { "transactionDate": "2019-08-01T00:00:00Z", "description": "New credits added", + "creditCurrency": "USD", + "reseller": { + "resellerId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/reseller/reseller1", + "resellerDescription": "Reseller information" + }, + "billingCurrency": "USD", "newCredit": { "currency": "USD", "value": 400.00 }, + "newCreditInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, + "canceledCredit": { + "currency": "USD", + "value": 5000 + }, "adjustments": { "currency": "USD", "value": 0.00 }, + "adjustmentsInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, "creditExpired": { "currency": "USD", "value": 0.00 }, + "creditExpiredInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, "charges": { "currency": "USD", "value": 0.00 }, + "chargesInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, "closedBalance": { "currency": "USD", "value": 900.00 }, + "closedBalanceInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, "eventType": "NewCredit", "invoiceNumber": "3302" } @@ -79,26 +135,56 @@ "properties": { "transactionDate": "2019-09-01T00:00:00Z", "description": "Credits Expired", + "creditCurrency": "USD", + "reseller": { + "resellerId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/reseller/reseller1", + "resellerDescription": "Reseller information" + }, + "billingCurrency": "USD", "newCredit": { "currency": "USD", "value": 0.00 }, + "newCreditInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, + "canceledCredit": { + "currency": "USD", + "value": 5000 + }, "adjustments": { "currency": "USD", "value": 0.00 }, + "adjustmentsInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, "creditExpired": { "currency": "USD", "value": 300.00 }, + "creditExpiredInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, "charges": { "currency": "USD", "value": 0.00 }, + "chargesInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, "closedBalance": { "currency": "USD", "value": 600.00 }, + "closedBalanceInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, "eventType": "ExpiredCredit", "invoiceNumber": "" } @@ -110,26 +196,56 @@ "properties": { "transactionDate": "2021-05-01T00:00:00Z", "description": "Settled invoice #212033", + "creditCurrency": "USD", + "reseller": { + "resellerId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/reseller/reseller1", + "resellerDescription": "Reseller information" + }, + "billingCurrency": "USD", "newCredit": { "currency": "USD", "value": 300.00 }, + "newCreditInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, + "canceledCredit": { + "currency": "USD", + "value": 5000 + }, "adjustments": { "currency": "USD", "value": -200.00 }, + "adjustmentsInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, "creditExpired": { "currency": "USD", "value": 100.00 }, + "creditExpiredInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, "charges": { "currency": "USD", "value": 300.00 }, + "chargesInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, "closedBalance": { "currency": "USD", "value": 700.00 }, + "closedBalanceInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, "eventType": "SettledCharges", "invoiceNumber": "3303" } diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-05-01/examples/LotsListByBillingProfile.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-05-01/examples/LotsListByBillingProfile.json index ae8f827faffb..9d7a66b8aa02 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-05-01/examples/LotsListByBillingProfile.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-05-01/examples/LotsListByBillingProfile.json @@ -13,14 +13,28 @@ "name": "lot1", "type": "Microsoft.Consumption/lots", "properties": { + "creditCurrency": "USD", + "billingCurrency": "USD", "originalAmount": { "currency": "USD", "value": 5000.00 }, + "originalAmountInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, "closedBalance": { "currency": "USD", "value": 60.90 }, + "closedBalanceInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, + "reseller": { + "resellerId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/reseller/reseller1", + "resellerDescription": "Reseller information." + }, "source": "PurchasedCredit", "startDate": "2021-05-01T00:00:00Z", "expirationDate": "2021-05-01T00:00:00Z", @@ -32,14 +46,28 @@ "name": "lot2", "type": "Microsoft.Consumption/lots", "properties": { + "creditCurrency": "USD", + "billingCurrency": "USD", "originalAmount": { "currency": "USD", "value": 6000.00 }, + "originalAmountInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, "closedBalance": { "currency": "USD", "value": 80.90 }, + "closedBalanceInBillingCurrency": { + "exchangeRate": 5000.00, + "exchangeRateMonth": 1 + }, + "reseller": { + "resellerId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/reseller/reseller2", + "resellerDescription": "Reseller information." + }, "source": "PurchasedCredit", "startDate": "2021-05-01T00:00:00Z", "expirationDate": "2019-12-31T00:00:00Z", diff --git a/specification/consumption/resource-manager/readme.md b/specification/consumption/resource-manager/readme.md index 43a5f80bdd34..bdc8e3d7c472 100644 --- a/specification/consumption/resource-manager/readme.md +++ b/specification/consumption/resource-manager/readme.md @@ -230,7 +230,6 @@ This is not used by Autorest itself. swagger-to-sdk: - repo: azure-sdk-for-net - repo: azure-sdk-for-go - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-js diff --git a/specification/consumption/resource-manager/readme.python.md b/specification/consumption/resource-manager/readme.python.md index 59aa8be66709..da32a2eb292b 100644 --- a/specification/consumption/resource-manager/readme.python.md +++ b/specification/consumption/resource-manager/readme.python.md @@ -4,40 +4,23 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.consumption - package-name: azure-mgmt-consumption - package-version: 2.0.0 - clear-output-folder: true -``` + ``` yaml $(python) && $(track2) -python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION payload-flattening-threshold: 2 namespace: azure.mgmt.consumption package-name: azure-mgmt-consumption -package-version: 2.0.0 +package-version: 1.0.0b1 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/consumption/azure-mgmt-consumption/azure/mgmt/consumption +``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/consumption/azure-mgmt-consumption/azure/mgmt/consumption ``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/consumption/azure-mgmt-consumption +``` yaml $(python) && $(python-mode) == 'create' && $(track2) basic-setup-py: true output-folder: $(python-sdks-folder)/consumption/azure-mgmt-consumption ``` diff --git a/specification/containerinstance/resource-manager/readme.go.md b/specification/containerinstance/resource-manager/readme.go.md index e0f0f02aa8db..d656607d0aa8 100644 --- a/specification/containerinstance/resource-manager/readme.go.md +++ b/specification/containerinstance/resource-manager/readme.go.md @@ -13,6 +13,7 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2021-03 - tag: package-2020-11 - tag: package-2019-12 - tag: package-2018-10 @@ -25,6 +26,15 @@ batch: - tag: package-2017-08-preview ``` +### Tag: package-2021-03 and go + +These settings apply only when `--tag=package-2021-03 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2021-03' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2021-03-01/$(namespace) +``` + ### Tag: package-2020-11 and go These settings apply only when `--tag=package-2020-11 --go` is specified on the command line. diff --git a/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/containerregistry.json b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/containerregistry.json new file mode 100644 index 000000000000..58f36202266b --- /dev/null +++ b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/containerregistry.json @@ -0,0 +1,3091 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Container Registry", + "description": "Metadata API definition for the Azure Container Registry runtime", + "version": "2019-08-15-preview" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{url}", + "useSchemePrefix": false, + "positionInOperation": "first", + "parameters": [ + { + "$ref": "#/parameters/Url" + } + ] + }, + "securityDefinitions": { + "registry_auth": { + "type": "basic" + }, + "registry_oauth2": { + "type": "apiKey", + "in": "header", + "name": "Authorization" + } + }, + "security": [ + { + "registry_auth": [], + "registry_oauth2": [] + } + ], + "tags": [ + { + "name": "ContainerRegistry", + "description": "Registry Operations" + }, + { + "name": "ContainerRegistryBlob", + "description": "Blob Operations" + } + ], + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "paths": { + "/v2/": { + "get": { + "tags": [ + "Registry" + ], + "description": "Tells whether this Docker Registry instance supports Docker Registry HTTP API v2", + "operationId": "ContainerRegistry_CheckDockerV2Support", + "x-ms-examples": { + "Check Docker Registry V2 Support": { + "$ref": "./examples/GetDockerRegistryV2Support.json" + } + }, + "responses": { + "200": { + "description": "Successful response. API v2 supported" + }, + "default": { + "description": "ACR error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AcrErrors" + } + } + } + } + }, + "/v2/{name}/manifests/{reference}": { + "get": { + "tags": [ + "Repository" + ], + "description": "Get the manifest identified by `name` and `reference` where `reference` can be a tag or digest.", + "x-ms-examples": { + "Get manifest": { + "$ref": "./examples/GetManifest.json" + } + }, + "operationId": "ContainerRegistry_GetManifest", + "parameters": [ + { + "$ref": "#/parameters/ImageName" + }, + { + "$ref": "#/parameters/ImageReference" + }, + { + "name": "accept", + "in": "header", + "description": "Accept header string delimited by comma. For example, application/vnd.docker.distribution.manifest.v2+json", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Returns the requested manifest file in a larger combined group", + "schema": { + "$ref": "#/definitions/Manifest" + } + }, + "default": { + "description": "ACR error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AcrErrors" + } + } + } + }, + "put": { + "tags": [ + "Repository" + ], + "x-ms-long-running-operation": false, + "description": "Put the manifest identified by `name` and `reference` where `reference` can be a tag or digest.", + "x-ms-examples": { + "Put manifest": { + "$ref": "./examples/CreateManifest.json" + } + }, + "consumes": [ + "application/vnd.docker.distribution.manifest.v2+json" + ], + "operationId": "ContainerRegistry_CreateManifest", + "parameters": [ + { + "$ref": "#/parameters/ImageName" + }, + { + "$ref": "#/parameters/ImageReference" + }, + { + "$ref": "#/parameters/ManifestBody" + } + ], + "responses": { + "201": { + "description": "The manifest is updated", + "schema": {}, + "headers": { + "Docker-Content-Digest": { + "type": "string", + "description": "Identifies the docker upload uuid for the current request." + }, + "Location": { + "type": "string", + "description": "The canonical location url of the uploaded manifest." + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The length of the requested blob content." + } + } + }, + "default": { + "description": "ACR error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AcrErrors" + } + } + } + }, + "delete": { + "tags": [ + "Repository" + ], + "description": "Delete the manifest identified by `name` and `reference`. Note that a manifest can _only_ be deleted by `digest`.", + "x-ms-examples": { + "Delete manifest": { + "$ref": "./examples/DeleteManifest.json" + } + }, + "operationId": "ContainerRegistry_DeleteManifest", + "parameters": [ + { + "$ref": "#/parameters/ImageName" + }, + { + "$ref": "#/parameters/DigestReference" + } + ], + "responses": { + "202": { + "description": "The manifest has been deleted" + }, + "404": { + "description": "The manifest was not found" + }, + "default": { + "description": "ACR error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AcrErrors" + } + } + } + } + }, + "/v2/{name}/blobs/{digest}": { + "get": { + "produces": [ + "application/octet-stream" + ], + "tags": [ + "ContainerRegistryBlob" + ], + "parameters": [ + { + "$ref": "#/parameters/ImageName" + }, + { + "$ref": "#/parameters/Digest" + } + ], + "x-ms-examples": { + "Get a blob from digest": { + "$ref": "./examples/GetBlob.json" + } + }, + "description": "Retrieve the blob from the registry identified by digest.", + "operationId": "ContainerRegistryBlob_GetBlob", + "responses": { + "200": { + "description": "The blob identified by digest is available. The blob content will be present in the body of the response.", + "schema": { + "description": "blob binary data", + "type": "file", + "format": "file" + }, + "headers": { + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The length of the requested blob content." + }, + "Docker-Content-Digest": { + "description": "Digest of the targeted content for the request.", + "type": "string" + } + } + }, + "307": { + "description": "The blob identified by digest is available at the provided location.", + "headers": { + "Location": { + "type": "string", + "description": "The location where the layer should be accessible." + } + } + }, + "default": { + "description": "ACR error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AcrErrors" + } + } + } + }, + "head": { + "tags": [ + "ContainerRegistryBlob" + ], + "description": "Same as GET, except only the headers are returned.", + "operationId": "ContainerRegistryBlob_CheckBlobExists", + "x-ms-examples": { + "Head for a Blob Chunk": { + "$ref": "./examples/CheckBlob.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ImageName" + }, + { + "$ref": "#/parameters/Digest" + } + ], + "responses": { + "200": { + "description": "The blob identified by digest is available. The blob content will be present in the body of the response.", + "headers": { + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The length of the requested blob content." + }, + "Docker-Content-Digest": { + "description": "Digest of the targeted content for the request.", + "type": "string" + } + } + }, + "307": { + "description": "The blob identified by digest is available at the provided location.", + "headers": { + "Location": { + "type": "string", + "description": "The location where the layer should be accessible." + } + } + }, + "default": { + "description": "ACR error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AcrErrors" + } + } + } + }, + "delete": { + "parameters": [ + { + "$ref": "#/parameters/ImageName" + }, + { + "$ref": "#/parameters/Digest" + } + ], + "description": "Removes an already uploaded blob.", + "produces": [ + "application/octet-stream" + ], + "tags": [ + "ContainerRegistryBlob" + ], + "operationId": "ContainerRegistryBlob_DeleteBlob", + "x-ms-examples": { + "Delete a blob": { + "$ref": "./examples/DeleteBlob.json" + } + }, + "responses": { + "202": { + "description": "The blob identified by digest is available. The blob content will be present in the body of the response.", + "schema": { + "description": "blob binary data", + "type": "file", + "format": "file" + }, + "headers": { + "Docker-Content-Digest": { + "description": "Digest of the targeted content for the request.", + "type": "string" + } + } + }, + "default": { + "description": "ACR error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AcrErrors" + } + } + } + } + }, + "/v2/{name}/blobs/uploads/": { + "post": { + "tags": [ + "ContainerRegistryBlob" + ], + "description": "Mount a blob identified by the `mount` parameter from another repository.", + "operationId": "ContainerRegistryBlob_MountBlob", + "x-ms-examples": { + "Mount a blob from repository": { + "$ref": "./examples/MountBlob.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ImageName" + }, + { + "$ref": "#/parameters/From" + }, + { + "$ref": "#/parameters/Mount" + } + ], + "responses": { + "201": { + "description": "The blob has been created in the registry and is available at the provided location.", + "headers": { + "Location": { + "description": "Provided location for blob", + "type": "string" + }, + "Docker-Upload-UUID": { + "description": "Identifies the docker upload uuid for the current request.", + "type": "string" + }, + "Docker-Content-Digest": { + "description": "Digest of the targeted content for the request.", + "type": "string" + } + } + }, + "default": { + "description": "ACR error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AcrErrors" + } + } + } + } + }, + "/{nextBlobUuidLink}": { + "get": { + "tags": [ + "ContainerRegistryBlob" + ], + "parameters": [ + { + "$ref": "#/parameters/NextLink" + } + ], + "description": "Retrieve status of upload identified by uuid. The primary purpose of this endpoint is to resolve the current status of a resumable upload.", + "operationId": "ContainerRegistryBlob_GetUploadStatus", + "x-ms-examples": { + "Get blob status": { + "$ref": "./examples/GetBlobStatus.json" + } + }, + "responses": { + "204": { + "description": "The upload is known and in progress. The last received offset is available in the Range header.", + "headers": { + "Range": { + "description": "Range indicating the current progress of the upload.", + "type": "string" + }, + "Docker-Upload-UUID": { + "description": "Identifies the docker upload uuid for the current request.", + "type": "string" + } + } + }, + "default": { + "description": "ACR error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AcrErrors" + } + } + } + }, + "patch": { + "security": [ + { + "registry_auth": [], + "registry_oauth2": [] + } + ], + "tags": [ + "ContainerRegistryBlob" + ], + "description": "Upload a stream of data without completing the upload.", + "operationId": "ContainerRegistryBlob_UploadChunk", + "x-ms-examples": { + "Upload Blob": { + "$ref": "./examples/UploadBlob.json" + } + }, + "consumes": [ + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "#/parameters/RawData" + }, + { + "$ref": "#/parameters/NextLink" + } + ], + "responses": { + "202": { + "description": "The stream of data has been accepted and the current progress is available in the range header. The updated upload location is available in the Location header.", + "headers": { + "Location": { + "description": "Provided location for blob", + "type": "string" + }, + "Range": { + "description": "Range indicating the current progress of the upload.", + "type": "string" + }, + "Docker-Upload-UUID": { + "description": "Identifies the docker upload uuid for the current request.", + "type": "string" + } + } + }, + "default": { + "description": "ACR error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AcrErrors" + } + } + } + }, + "put": { + "tags": [ + "ContainerRegistryBlob" + ], + "consumes": [ + "application/octet-stream" + ], + "description": "Complete the upload, providing all the data in the body, if necessary. A request without a body will just complete the upload with previously uploaded content.", + "operationId": "ContainerRegistryBlob_CompleteUpload", + "x-ms-examples": { + "End a blob upload": { + "$ref": "./examples/EndBlobUpload.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/BlobQueryDigest" + }, + { + "$ref": "#/parameters/RawDataOptional" + }, + { + "$ref": "#/parameters/NextLink" + } + ], + "responses": { + "201": { + "description": "The upload has been completed and accepted by the registry.", + "headers": { + "Location": { + "description": "Provided location for blob", + "type": "string" + }, + "Range": { + "description": "Range indicating the current progress of the upload.", + "type": "string" + }, + "Docker-Content-Digest": { + "description": "Digest of the targeted content for the request.", + "type": "string" + } + } + }, + "default": { + "description": "ACR error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AcrErrors" + } + } + } + }, + "delete": { + "tags": [ + "ContainerRegistryBlob" + ], + "parameters": [ + { + "$ref": "#/parameters/NextLink" + } + ], + "description": "Cancel outstanding upload processes, releasing associated resources. If this is not called, the unfinished uploads will eventually timeout.", + "operationId": "ContainerRegistryBlob_CancelUpload", + "x-ms-examples": { + "End a blob upload": { + "$ref": "./examples/CancelBlobUpload.json" + } + }, + "responses": { + "204": { + "description": "The upload has been successfully deleted." + }, + "default": { + "description": "ACR error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AcrErrors" + } + } + } + } + }, + "/acr/v1/_catalog": { + "get": { + "tags": [ + "Registry" + ], + "description": "List repositories", + "operationId": "ContainerRegistry_GetRepositories", + "x-ms-pageable": { + "itemName": "repositories", + "nextLinkName": "link" + }, + "x-ms-examples": { + "Get repositories in a registry": { + "$ref": "./examples/GetRepositoryList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/QueryLast" + }, + { + "$ref": "#/parameters/QueryNum" + } + ], + "responses": { + "200": { + "headers": { + "Link": { + "description": "next paginated result", + "type": "string" + } + }, + "description": "Returns a list of repositories", + "schema": { + "$ref": "#/definitions/Repositories" + } + }, + "default": { + "description": "ACR error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AcrErrors" + } + } + } + } + }, + "/acr/v1/{name}": { + "get": { + "tags": [ + "Registry" + ], + "description": "Get repository attributes", + "operationId": "ContainerRegistry_GetProperties", + "x-ms-examples": { + "Get details of repository": { + "$ref": "./examples/GetRepositoryAttributes.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ImageName" + } + ], + "responses": { + "200": { + "description": "Returns a list of attributes", + "schema": { + "$ref": "#/definitions/RepositoryAttributes" + } + }, + "default": { + "description": "ACR error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AcrErrors" + } + } + } + }, + "delete": { + "tags": [ + "Registry" + ], + "description": "Delete the repository identified by `name`", + "operationId": "ContainerRegistry_DeleteRepository", + "x-ms-examples": { + "Delete a repository": { + "$ref": "./examples/DeleteAcrRepository.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ImageName" + } + ], + "responses": { + "202": { + "description": "The repository is deleted" + }, + "404": { + "description": "The repository was not found" + }, + "default": { + "description": "ACR error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AcrErrors" + } + } + } + }, + "patch": { + "tags": [ + "Registry" + ], + "description": "Update the attribute identified by `name` where `reference` is the name of the repository.", + "operationId": "ContainerRegistry_UpdateProperties", + "x-ms-examples": { + "Update repository attributes": { + "$ref": "./examples/UpdateRepositoryAttributes.json" + } + }, + "consumes": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ImageName" + }, + { + "$ref": "#/parameters/RepositoryAttributeValue" + } + ], + "responses": { + "200": { + "description": "The attributes are updated", + "schema": { + "$ref": "#/definitions/RepositoryAttributes" + } + }, + "default": { + "description": "ACR error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AcrErrors" + } + } + } + } + }, + "/acr/v1/{name}/_tags": { + "get": { + "tags": [ + "Repository" + ], + "description": "List tags of a repository", + "operationId": "ContainerRegistry_GetTags", + "x-ms-examples": { + "Get tags of a repository": { + "$ref": "./examples/GetTagList.json" + } + }, + "x-ms-pageable": { + "itemName": "tags", + "nextLinkName": "link" + }, + "parameters": [ + { + "$ref": "#/parameters/ImageName" + }, + { + "$ref": "#/parameters/QueryLast" + }, + { + "$ref": "#/parameters/QueryNum" + }, + { + "$ref": "#/parameters/QueryOrderBy" + }, + { + "$ref": "#/parameters/QueryDigest" + } + ], + "responses": { + "200": { + "headers": { + "Link": { + "description": "next paginated result", + "type": "string" + } + }, + "description": "Tag details of a repository", + "schema": { + "$ref": "#/definitions/TagList" + } + }, + "default": { + "description": "ACR error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AcrErrors" + } + } + } + } + }, + "/acr/v1/{name}/_tags/{reference}": { + "get": { + "tags": [ + "Repository" + ], + "description": "Get tag attributes by tag", + "operationId": "ContainerRegistry_GetTagProperties", + "x-ms-examples": { + "Get tag attributes": { + "$ref": "./examples/GetTagAttributes.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ImageName" + }, + { + "$ref": "#/parameters/TagReference" + } + ], + "responses": { + "200": { + "description": "Tag attributes", + "schema": { + "$ref": "#/definitions/TagAttributes" + } + }, + "default": { + "description": "ACR error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AcrErrors" + } + } + } + }, + "patch": { + "tags": [ + "Repository" + ], + "description": "Update tag attributes", + "operationId": "ContainerRegistry_UpdateTagAttributes", + "consumes": [ + "application/json" + ], + "x-ms-examples": { + "Update attributes of a tag": { + "$ref": "./examples/UpdateTagAttributes.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ImageName" + }, + { + "$ref": "#/parameters/TagReference" + }, + { + "$ref": "#/parameters/TagAttributeValue" + } + ], + "responses": { + "200": { + "description": "The attributes are updated", + "schema": { + "$ref": "#/definitions/TagAttributes" + } + }, + "default": { + "description": "ACR error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AcrErrors" + } + } + } + }, + "delete": { + "tags": [ + "Repository" + ], + "description": "Delete tag", + "operationId": "ContainerRegistry_DeleteTag", + "consumes": [ + "application/json" + ], + "x-ms-examples": { + "Delete a tag": { + "$ref": "./examples/DeleteTag.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ImageName" + }, + { + "$ref": "#/parameters/TagReference" + } + ], + "responses": { + "202": { + "description": "The tag is deleted" + }, + "404": { + "description": "The tag was not found" + }, + "default": { + "description": "ACR error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AcrErrors" + } + } + } + } + }, + "/acr/v1/{name}/_manifests": { + "get": { + "tags": [ + "Repository" + ], + "description": "List manifests of a repository", + "operationId": "ContainerRegistry_GetManifests", + "x-ms-examples": { + "Get list of available manifests": { + "$ref": "./examples/GetManifestList.json" + } + }, + "x-ms-pageable": { + "itemName": "manifests", + "nextLinkName": "link" + }, + "parameters": [ + { + "$ref": "#/parameters/ImageName" + }, + { + "$ref": "#/parameters/QueryLast" + }, + { + "$ref": "#/parameters/QueryNum" + }, + { + "$ref": "#/parameters/QueryOrderBy" + } + ], + "responses": { + "200": { + "headers": { + "Link": { + "description": "next paginated result", + "type": "string" + } + }, + "description": "Returns a list of manifests", + "schema": { + "$ref": "#/definitions/AcrManifests" + } + }, + "default": { + "description": "ACR error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AcrErrors" + } + } + } + } + }, + "/acr/v1/{name}/_manifests/{digest}": { + "get": { + "tags": [ + "Repository" + ], + "description": "Get manifest attributes", + "operationId": "ContainerRegistry_GetManifestProperties", + "x-ms-examples": { + "Get manifest attributes": { + "$ref": "./examples/GetManifestAttributes.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ImageName" + }, + { + "$ref": "#/parameters/Digest" + } + ], + "responses": { + "200": { + "description": "List of attributes", + "schema": { + "$ref": "#/definitions/ManifestAttributes" + } + }, + "default": { + "description": "ACR error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AcrErrors" + } + } + } + }, + "patch": { + "tags": [ + "Repository" + ], + "description": "Update properties of a manifest", + "operationId": "ContainerRegistry_UpdateManifestProperties", + "consumes": [ + "application/json" + ], + "x-ms-examples": { + "Update attributes of a manifest": { + "$ref": "./examples/UpdateManifestAttributes.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ImageName" + }, + { + "$ref": "#/parameters/Digest" + }, + { + "$ref": "#/parameters/ManifestAttributeValue" + } + ], + "responses": { + "200": { + "description": "The attributes are updated", + "schema": { + "$ref": "#/definitions/ManifestAttributes" + } + }, + "default": { + "description": "ACR error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AcrErrors" + } + } + } + } + }, + "/oauth2/exchange": { + "post": { + "tags": [ + "AcrToken", + "RefreshToken" + ], + "description": "Exchange AAD tokens for an ACR refresh Token", + "operationId": "Authentication_ExchangeAadAccessTokenForAcrRefreshToken", + "consumes": [ + "application/x-www-form-urlencoded" + ], + "parameters": [ + { + "$ref": "#/parameters/Grant_type" + }, + { + "$ref": "#/parameters/Service" + }, + { + "$ref": "#/parameters/AccessToken" + } + ], + "responses": { + "200": { + "description": "ACR refresh token acquired", + "schema": { + "$ref": "#/definitions/RefreshToken" + } + }, + "default": { + "description": "ACR error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AcrErrors" + } + } + }, + "security": [], + "x-ms-examples": { + "Exchange AAD Token for ACR Refresh": { + "$ref": "./examples/PostRefreshToken.json" + } + } + } + }, + "/oauth2/token": { + "post": { + "tags": [ + "AcrToken", + "AccessToken" + ], + "description": "Exchange ACR Refresh token for an ACR Access Token", + "operationId": "Authentication_ExchangeAcrRefreshTokenForAcrAccessToken", + "consumes": [ + "application/x-www-form-urlencoded" + ], + "parameters": [ + { + "$ref": "#/parameters/Service" + }, + { + "name": "scope", + "in": "formData", + "required": true, + "description": "Which is expected to be a valid scope, and can be specified more than once for multiple scope requests. You obtained this from the Www-Authenticate response header from the challenge.", + "type": "string" + }, + { + "name": "refresh_token", + "x-ms-client-name": "acrRefreshToken", + "in": "formData", + "required": true, + "description": "Must be a valid ACR refresh token", + "type": "string" + }, + { + "name": "grant_type", + "in": "formData", + "description": "Grant type is expected to be refresh_token", + "required": true, + "type": "string", + "enum": [ + "refresh_token", + "password" + ], + "x-ms-enum": { + "name": "TokenGrantType" + }, + "x-accessibility": "internal", + "x-ms-client-default": "refresh_token" + } + ], + "responses": { + "200": { + "description": "ACR access token acquired", + "schema": { + "$ref": "#/definitions/AccessToken" + } + }, + "default": { + "description": "ACR error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AcrErrors" + } + } + }, + "security": [], + "x-ms-examples": { + "Get Access Token with Refresh Token": { + "$ref": "./examples/PostAccessToken.json" + } + } + } + } + }, + "x-ms-paths": { + "/v2/{name}/blobs/uploads/?mode=resumable": { + "post": { + "tags": [ + "ContainerRegistryBlob" + ], + "description": "Initiate a resumable blob upload with an empty request body.", + "operationId": "ContainerRegistryBlob_StartUpload", + "x-ms-examples": { + "Start a blob upload": { + "$ref": "./examples/StartBlobUpload.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ImageName" + } + ], + "responses": { + "202": { + "description": "The upload has been created. The Location header must be used to complete the upload. The response should be identical to a GET request on the contents of the returned Location header.", + "headers": { + "Location": { + "description": "Provided location for blob", + "type": "string" + }, + "Range": { + "description": "Range indicating the current progress of the upload.", + "type": "string" + }, + "Docker-Upload-UUID": { + "description": "Identifies the docker upload uuid for the current request.", + "type": "string" + } + } + }, + "default": { + "description": "ACR error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AcrErrors" + } + } + } + } + }, + "/v2/{name}/blobs/{digest}?mode=chunk": { + "get": { + "produces": [ + "application/octet-stream" + ], + "tags": [ + "ContainerRegistryBlob" + ], + "description": "Retrieve the blob from the registry identified by `digest`. This endpoint may also support RFC7233 compliant range requests. Support can be detected by issuing a HEAD request. If the header `Accept-Range: bytes` is returned, range requests can be used to fetch partial content.", + "operationId": "ContainerRegistryBlob_GetChunk", + "parameters": [ + { + "$ref": "#/parameters/ImageName" + }, + { + "$ref": "#/parameters/Digest" + }, + { + "$ref": "#/parameters/Range" + } + ], + "x-ms-examples": { + "Get a blob Chunk": { + "$ref": "./examples/GetBlobChunk.json" + } + }, + "responses": { + "206": { + "description": "The blob identified by digest is available. The specified chunk of blob content will be present in the body of the request.", + "schema": { + "description": "blob binary data", + "type": "file", + "format": "file" + }, + "headers": { + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The length of the requested blob content." + }, + "Content-Range": { + "type": "string", + "description": "Content range of blob chunk." + } + } + }, + "default": { + "description": "ACR error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AcrErrors" + } + } + } + }, + "head": { + "tags": [ + "ContainerRegistryBlob" + ], + "parameters": [ + { + "$ref": "#/parameters/ImageName" + }, + { + "$ref": "#/parameters/Digest" + }, + { + "$ref": "#/parameters/Range" + } + ], + "description": "Same as GET, except only the headers are returned.", + "operationId": "ContainerRegistryBlob_CheckChunkExists", + "x-ms-examples": { + "Get headers without blob Chunk": { + "$ref": "./examples/CheckBlobChunk.json" + } + }, + "responses": { + "200": { + "description": "The blob identified by digest is available. The specified chunk of blob content will be present in the body of the request.", + "headers": { + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The length of the requested blob content." + }, + "Content-Range": { + "type": "string", + "description": "Content range of blob chunk." + } + } + }, + "default": { + "description": "ACR error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AcrErrors" + } + } + } + } + } + }, + "definitions": { + "RepositoryAttributes": { + "required": [ + "registry", + "imageName", + "createdTime", + "lastUpdateTime", + "manifestCount", + "tagCount", + "changeableAttributes" + ], + "x-ms-client-name": "ContainerRepositoryProperties", + "type": "object", + "description": "Properties of this repository.", + "properties": { + "registry": { + "type": "string", + "readOnly": true, + "description": "Registry login server.", + "x-ms-client-name": "registryLoginServer" + }, + "imageName": { + "type": "string", + "readOnly": true, + "description": "Image name", + "x-ms-client-name": "name" + }, + "createdTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "Image created time", + "x-ms-client-name": "createdOn" + }, + "lastUpdateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "Image last update time", + "x-ms-client-name": "lastUpdatedOn" + }, + "manifestCount": { + "type": "integer", + "readOnly": true, + "description": "Number of the manifests" + }, + "tagCount": { + "type": "integer", + "readOnly": true, + "description": "Number of the tags" + }, + "changeableAttributes": { + "description": "Writeable properties of the resource", + "$ref": "#/definitions/RepositoryChangeableAttributes", + "x-ms-client-flatten": true + } + }, + "example": { + "registry": "registryname.azurecr.io", + "changeableAttributes": { + "readEnabled": true, + "listEnabled": true, + "deleteEnabled": true, + "writeEnabled": true, + "teleportEnabled": false + }, + "imageName": "imageName", + "createdTime": "2018-09-07T16:30:46.6583219Z", + "tagCount": 6, + "manifestCount": 2, + "lastUpdateTime": "2018-09-07T16:30:46.6583219Z" + } + }, + "TagList": { + "required": [ + "registry", + "imageName", + "tags" + ], + "description": "List of tag details", + "x-accessibility": "internal", + "properties": { + "registry": { + "type": "string", + "description": "Registry login server.", + "x-ms-client-name": "RegistryLoginServer" + }, + "imageName": { + "type": "string", + "description": "Image name", + "x-ms-client-name": "repository" + }, + "tags": { + "type": "array", + "description": "List of tag attribute details", + "x-ms-client-name": "TagAttributeBases", + "x-accessibility": "internal", + "items": { + "$ref": "#/definitions/TagAttributesBase" + } + }, + "link": { + "type": "string" + } + }, + "example": { + "registry": "registry", + "imageName": "imageName", + "tags": [ + { + "changeableAttributes": { + "readEnabled": true, + "listEnabled": true, + "deleteEnabled": true, + "writeEnabled": true + }, + "name": "name", + "digest": "digest", + "createdTime": "createdTime", + "signed": true, + "lastUpdateTime": "lastUpdateTime" + }, + { + "changeableAttributes": { + "readEnabled": true, + "listEnabled": true, + "deleteEnabled": true, + "writeEnabled": true + }, + "name": "name", + "digest": "digest", + "createdTime": "createdTime", + "signed": true, + "lastUpdateTime": "lastUpdateTime" + } + ] + } + }, + "TagAttributes": { + "required": [ + "registry", + "imageName", + "tag" + ], + "x-ms-client-name": "ArtifactTagProperties", + "description": "Tag attributes", + "properties": { + "registry": { + "type": "string", + "readOnly": true, + "description": "Registry login server.", + "x-ms-client-name": "registryLoginServer" + }, + "imageName": { + "type": "string", + "readOnly": true, + "description": "Image name", + "x-ms-client-name": "repositoryName" + }, + "tag": { + "x-ms-client-flatten": true, + "description": "List of tag attribute details", + "readOnly": true, + "$ref": "#/definitions/TagAttributesBase" + } + }, + "example": { + "registry": "registry", + "imageName": "imageName", + "tag": { + "changeableAttributes": { + "readEnabled": true, + "listEnabled": true, + "deleteEnabled": true, + "writeEnabled": true + }, + "name": "name", + "digest": "digest", + "createdTime": "createdTime", + "signed": true, + "lastUpdateTime": "lastUpdateTime" + } + } + }, + "TagAttributesBase": { + "required": [ + "name", + "digest", + "createdTime", + "lastUpdateTime", + "changeableAttributes" + ], + "description": "Tag attribute details", + "x-accessibility": "internal", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "Tag name" + }, + "digest": { + "type": "string", + "readOnly": true, + "description": "Tag digest" + }, + "createdTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "Tag created time", + "x-ms-client-name": "createdOn" + }, + "lastUpdateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "Tag last update time", + "x-ms-client-name": "lastUpdatedOn" + }, + "changeableAttributes": { + "$ref": "#/definitions/TagChangeableAttributes", + "description": "Writeable properties of the resource", + "x-ms-client-flatten": true + } + }, + "example": { + "changeableAttributes": { + "readEnabled": true, + "listEnabled": true, + "deleteEnabled": true, + "writeEnabled": true + }, + "name": "tagname", + "digest": "sha256:0873c923e00e0fd2ba78041bfb64a105e1ecb7678916d1f7776311e45bf5634b", + "createdTime": "2018-08-10T17:28:44.1082945Z", + "signed": true, + "lastUpdateTime": "2018-08-10T17:28:44.1082945Z" + } + }, + "TagOrderBy": { + "type": "string", + "enum": [ + "none", + "timedesc", + "timeasc" + ], + "x-ms-enum": { + "name": "ArtifactTagOrderBy", + "values": [ + { + "value": "none", + "name": "None", + "description": "Do not provide an orderby value in the request." + }, + { + "value": "timedesc", + "name": "LastUpdatedOnDescending", + "description": "Order tags by LastUpdatedOn field, from most recently updated to least recently updated." + }, + { + "value": "timeasc", + "name": "LastUpdatedOnAscending", + "description": "Order tags by LastUpdatedOn field, from least recently updated to most recently updated." + } + ] + }, + "x-accessibility": "public" + }, + "ArtifactArchitecture": { + "type": "string", + "enum": [ + "386", + "amd64", + "arm", + "arm64", + "mips", + "mipsle", + "mips64", + "mips64le", + "ppc64", + "ppc641e", + "riscv64", + "s390x", + "wasm" + ], + "x-ms-enum": { + "name": "ArtifactArchitecture", + "modelAsString": true, + "values": [ + { + "value": "386", + "name": "I386", + "description": "" + }, + { + "value": "amd64", + "name": "Amd64", + "description": "" + }, + { + "value": "arm", + "name": "Arm", + "description": "" + }, + { + "value": "arm64", + "name": "Arm64", + "description": "" + }, + { + "value": "mips", + "name": "Mips", + "description": "" + }, + { + "value": "mipsle", + "name": "MipsLe", + "description": "" + }, + { + "value": "mips64", + "name": "Mips64", + "description": "" + }, + { + "value": "mips64le", + "name": "Mips64Le", + "description": "" + }, + { + "value": "ppc64", + "name": "Ppc64", + "description": "" + }, + { + "value": "ppc64le", + "name": "Ppc64Le", + "description": "" + }, + { + "value": "riscv64", + "name": "RiscV64", + "description": "" + }, + { + "value": "s390x", + "name": "S390x", + "description": "" + }, + { + "value": "wasm", + "name": "Wasm", + "description": "" + } + ] + }, + "x-accessibility": "public" + }, + "ArtifactOperatingSystem": { + "type": "string", + "enum": [ + "aix", + "android", + "darwin", + "dragonfly", + "freebsd", + "illumos", + "ios", + "js", + "linux", + "netbsd", + "openbsd", + "plan9", + "solaris", + "windows" + ], + "x-ms-enum": { + "name": "ArtifactOperatingSystem", + "modelAsString": true, + "values": [ + { + "value": "aix", + "name": "Aix", + "description": "" + }, + { + "value": "android", + "name": "Android", + "description": "" + }, + { + "value": "darwin", + "name": "Darwin", + "description": "" + }, + { + "value": "dragonfly", + "name": "Dragonfly", + "description": "" + }, + { + "value": "freebsd", + "name": "FreeBsd", + "description": "" + }, + { + "value": "illumos", + "name": "Illumos", + "description": "" + }, + { + "value": "ios", + "name": "iOS", + "description": "" + }, + { + "value": "js", + "name": "JS", + "description": "" + }, + { + "value": "linux", + "name": "Linux", + "description": "" + }, + { + "value": "netbsd", + "name": "NetBsd", + "description": "" + }, + { + "value": "openbsd", + "name": "OpenBsd", + "description": "" + }, + { + "value": "plan9", + "name": "Plan9", + "description": "" + }, + { + "value": "solaris", + "name": "Solaris", + "description": "" + }, + { + "value": "windows", + "name": "Windows", + "description": "" + } + ] + }, + "x-accessibility": "public" + }, + "AcrManifests": { + "description": "Manifest attributes", + "properties": { + "registry": { + "type": "string", + "description": "Registry login server.", + "x-ms-client-name": "registryLoginServer" + }, + "imageName": { + "type": "string", + "description": "Image name", + "x-ms-client-name": "repository" + }, + "manifests": { + "type": "array", + "description": "List of manifests", + "items": { + "$ref": "#/definitions/ManifestAttributesBase", + "description": "Manifest details" + } + }, + "link": { + "type": "string" + } + }, + "x-accessibility": "internal", + "example": { + "registry": "registry", + "imageName": "imageName", + "manifests": [ + { + "changeableAttributes": { + "quarantineDetails": "quarantineDetails", + "readEnabled": true, + "quarantineState": "quarantineState", + "listEnabled": true, + "deleteEnabled": true, + "writeEnabled": true + }, + "os": "os", + "digest": "digest", + "imageSize": 2401606, + "createdTime": "createdTime", + "mediaType": "mediaType", + "configMediaType": "configMediaType", + "lastUpdateTime": "lastUpdateTime", + "architecture": "architecture", + "tags": [ + "tags", + "tags" + ] + }, + { + "changeableAttributes": { + "quarantineDetails": "quarantineDetails", + "readEnabled": true, + "quarantineState": "quarantineState", + "listEnabled": true, + "deleteEnabled": true, + "writeEnabled": true + }, + "os": "os", + "digest": "digest", + "imageSize": 2401606, + "createdTime": "createdTime", + "mediaType": "mediaType", + "configMediaType": "configMediaType", + "lastUpdateTime": "lastUpdateTime", + "architecture": "architecture", + "tags": [ + "tags", + "tags" + ] + } + ] + } + }, + "ManifestAttributes": { + "required": [ + "manifest" + ], + "x-ms-client-name": "ArtifactManifestProperties", + "description": "Manifest attributes details", + "properties": { + "registry": { + "description": "Registry login server.", + "readOnly": true, + "type": "string", + "x-ms-client-name": "registryLoginServer" + }, + "imageName": { + "description": "Repository name", + "type": "string", + "readOnly": true, + "x-ms-client-name": "repositoryName" + }, + "manifest": { + "x-ms-client-flatten": true, + "readOnly": true, + "description": "Manifest attributes", + "$ref": "#/definitions/ManifestAttributesBase" + } + }, + "example": { + "registry": "acrapi.azurecr-test.io", + "imageName": "nanoserver", + "manifest": { + "digest": "sha256:110d2b6c84592561338aa040b1b14b7ab81c2f9edbd564c2285dd7d70d777086", + "imageSize": 2401606, + "createdTime": "2018-09-06T06:17:20.9983915Z", + "lastUpdateTime": "2018-09-06T06:17:20.9983915Z", + "architecture": "amd64", + "os": "windows", + "mediaType": "application/vnd.docker.distribution.manifest.v2+json", + "configMediaType": "application/vnd.docker.container.image.v1+json", + "tags": [ + "4.7.2-20180905-nanoserver-1803" + ], + "changeableAttributes": { + "deleteEnabled": true, + "writeEnabled": true, + "readEnabled": true, + "listEnabled": true + } + } + } + }, + "ManifestAttributesBase": { + "required": [ + "digest", + "createdTime", + "lastUpdateTime" + ], + "type": "object", + "description": "Manifest details", + "x-accessibility": "internal", + "properties": { + "digest": { + "type": "string", + "readOnly": true, + "description": "Manifest" + }, + "imageSize": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "Image size", + "x-ms-client-name": "size" + }, + "createdTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "Created time", + "x-ms-client-name": "createdOn" + }, + "lastUpdateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "Last update time", + "x-ms-client-name": "lastUpdatedOn" + }, + "architecture": { + "$ref": "#/definitions/ArtifactArchitecture", + "description": "CPU architecture", + "readOnly": true, + "x-nullable": true + }, + "os": { + "$ref": "#/definitions/ArtifactOperatingSystem", + "description": "Operating system", + "x-ms-client-name": "operatingSystem", + "readOnly": true, + "x-nullable": true + }, + "references": { + "type": "array", + "readOnly": true, + "description": "List of artifacts that are referenced by this manifest list, with information about the platform each supports. This list will be empty if this is a leaf manifest and not a manifest list.", + "x-ms-client-name": "relatedArtifacts", + "items": { + "$ref": "#/definitions/ManifestAttributes_manifest_references", + "description": "Manifest attributes details" + } + }, + "tags": { + "type": "array", + "readOnly": true, + "description": "List of tags", + "items": { + "type": "string", + "description": "Tag name" + } + }, + "changeableAttributes": { + "$ref": "#/definitions/ManifestChangeableAttributes", + "description": "Writeable properties of the resource", + "x-ms-client-flatten": true + } + }, + "example": { + "changeableAttributes": { + "readEnabled": true, + "listEnabled": true, + "deleteEnabled": true, + "writeEnabled": true + }, + "os": "os", + "digest": "digest", + "imageSize": 2401606, + "createdTime": "createdTime", + "mediaType": "mediaType", + "configMediaType": "configMediaType", + "lastUpdateTime": "lastUpdateTime", + "architecture": "architecture", + "tags": [ + "tags", + "tags" + ] + } + }, + "RefreshToken": { + "type": "object", + "properties": { + "refresh_token": { + "description": "The refresh token to be used for generating access tokens", + "type": "string" + } + }, + "x-accessibility": "internal", + "x-ms-client-name": "AcrRefreshToken" + }, + "ManifestOrderBy": { + "type": "string", + "enum": [ + "none", + "timedesc", + "timeasc" + ], + "x-ms-enum": { + "name": "ArtifactManifestOrderBy", + "values": [ + { + "value": "none", + "name": "None", + "description": "Do not provide an orderby value in the request." + }, + { + "value": "timedesc", + "name": "LastUpdatedOnDescending", + "description": "Order manifests by LastUpdatedOn field, from most recently updated to least recently updated." + }, + { + "value": "timeasc", + "name": "LastUpdatedOnAscending", + "description": "Order manifest by LastUpdatedOn field, from least recently updated to most recently updated." + } + ] + }, + "default": "none", + "description": "Sort options for ordering manifests in a collection.", + "x-accessibility": "public" + }, + "AccessToken": { + "type": "object", + "properties": { + "access_token": { + "description": "The access token for performing authenticated requests", + "type": "string" + } + }, + "x-accessibility": "internal", + "x-ms-client-name": "AcrAccessToken" + }, + "AcrErrors": { + "description": "Acr error response describing why the operation failed", + "properties": { + "errors": { + "type": "array", + "description": "Array of detailed error", + "items": { + "$ref": "#/definitions/AcrErrorInfo" + } + } + } + }, + "RepositoryTags": { + "description": "Result of the request to list tags of the image", + "x-accessibility": "internal", + "properties": { + "name": { + "type": "string", + "description": "Name of the image" + }, + "tags": { + "type": "array", + "description": "List of tags", + "items": { + "type": "string", + "description": "Tag name" + } + } + }, + "example": { + "name": "name", + "tags": [ + "tags", + "tags" + ] + } + }, + "ImageSignature": { + "description": "Signature of a signed manifest", + "x-accessibility": "internal", + "properties": { + "header": { + "description": "A JSON web signature", + "$ref": "#/definitions/JWK" + }, + "signature": { + "type": "string", + "description": "A signature for the image manifest, signed by a libtrust private key" + }, + "protected": { + "type": "string", + "description": "The signed protected header" + } + }, + "example": { + "header": { + "jwk": { + "crv": "P-256", + "kid": "WGXM:EYWQ:DA53:LQUP:BCWG:5RDG:S3ZM:ETH7:VMQS:WWKZ:EWDG:V74Q", + "kty": "EC", + "x": "OxZ9k5BVjPZ7jb3BmBD4X0d8MVPJqfF4NeSe8reoqnY", + "y": "EaCqTe4-vYwhk7qU6Bs2-AeLGOVtCe_-IY2MdE0Vfyc" + }, + "alg": "ES256" + }, + "signature": "p73LfotMGD8nNXz2g9YX2XtSllb4GI5-b3vjqP5N0nkv8QXg-r5z_omGiVbOZE2BYG1X_4TIN23l1KSEqsXxOg", + "protected": "eyJmb3JtYXRMZW5ndGgiOjI5ODYsImZvcm1hdFRhaWwiOiJDbjAiLCJ0aW1lIjoiMjAxOC0wOS0yMFQyMzo0MTo1MloifQ" + } + }, + "JWK": { + "description": "A JSON web signature", + "x-accessibility": "internal", + "properties": { + "jwk": { + "$ref": "#/definitions/JWKHeader" + }, + "alg": { + "type": "string", + "description": "The algorithm used to sign or encrypt the JWT" + } + } + }, + "JWKHeader": { + "description": "JSON web key parameter", + "x-accessibility": "internal", + "properties": { + "crv": { + "type": "string", + "description": "crv value" + }, + "kid": { + "type": "string", + "description": "kid value" + }, + "kty": { + "type": "string", + "description": "kty value" + }, + "x": { + "type": "string", + "description": "x value" + }, + "y": { + "type": "string", + "description": "y value" + } + } + }, + "History": { + "description": "A list of unstructured historical data for v1 compatibility", + "x-accessibility": "internal", + "properties": { + "v1Compatibility": { + "type": "string", + "description": "The raw v1 compatibility information" + } + }, + "example": { + "v1Compatibility": "v1 compatibility info" + } + }, + "Repositories": { + "description": "List of repositories", + "properties": { + "repositories": { + "type": "array", + "description": "Repository names", + "items": { + "type": "string" + } + }, + "link": { + "type": "string" + } + }, + "x-accessibility": "internal", + "example": { + "repositories": [ + "production/alpine", + "testing/alpine" + ] + } + }, + "DeletedRepository": { + "x-ms-client-name": "DeleteRepositoryResult", + "description": "Deleted repository", + "properties": { + "manifestsDeleted": { + "type": "array", + "readOnly": true, + "description": "SHA of the deleted image", + "items": { + "type": "string" + }, + "x-ms-client-name": "deletedManifests" + }, + "tagsDeleted": { + "type": "array", + "readOnly": true, + "description": "Tag of the deleted image", + "items": { + "type": "string" + }, + "x-ms-client-name": "deletedTags" + } + } + }, + "AcrErrorInfo": { + "description": "Error information", + "properties": { + "code": { + "description": "Error code", + "type": "string" + }, + "message": { + "type": "string", + "description": "Error message" + }, + "detail": { + "type": "object", + "description": "Error details" + } + } + }, + "FsLayer": { + "description": "Image layer information", + "x-accessibility": "internal", + "properties": { + "blobSum": { + "type": "string", + "description": "SHA of an image layer" + } + }, + "example": { + "blobSum": "sha256:1f7d468f830cb0ed4beb8edc9438f18096e8c682e56a35242f60e6c61b718b30" + } + }, + "Descriptor": { + "description": "Docker V2 image layer descriptor including config and layers", + "x-accessibility": "internal", + "properties": { + "mediaType": { + "type": "string", + "description": "Layer media type" + }, + "size": { + "type": "integer", + "format": "int64", + "description": "Layer size" + }, + "digest": { + "type": "string", + "description": "Layer digest" + }, + "urls": { + "type": "array", + "description": "Specifies a list of URIs from which this object may be downloaded.", + "items": { + "description": "Must conform to RFC 3986. Entries should use the http and https schemes, as defined in RFC 7230.", + "type": "string" + } + }, + "annotations": { + "$ref": "#/definitions/Annotations" + } + }, + "example": { + "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 2107098, + "digest": "sha256:5d20c808ce198565ff70b3ed23a991dd49afac45dece63474b27ce6ed036adc6" + } + }, + "TagChangeableAttributes": { + "description": "Changeable attributes", + "x-ms-client-name": "TagWriteableProperties", + "x-accessibility": "internal", + "properties": { + "deleteEnabled": { + "type": "boolean", + "description": "Delete enabled", + "x-ms-client-name": "canDelete" + }, + "writeEnabled": { + "type": "boolean", + "description": "Write enabled", + "x-ms-client-name": "canWrite" + }, + "listEnabled": { + "type": "boolean", + "description": "List enabled", + "x-ms-client-name": "canList" + }, + "readEnabled": { + "type": "boolean", + "description": "Read enabled", + "x-ms-client-name": "canRead" + } + }, + "example": { + "readEnabled": true, + "listEnabled": true, + "deleteEnabled": true, + "writeEnabled": true + } + }, + "TagAttributes_tag": { + "description": "Tag", + "properties": { + "signatureRecord": { + "description": "SignatureRecord value", + "type": "string" + } + }, + "example": { + "signatureRecord": "signatureRecord" + } + }, + "ManifestAttributes_manifest_references": { + "required": [ + "digest" + ], + "x-ms-client-name": "ArtifactManifestPlatform", + "description": "Manifest attributes details", + "properties": { + "digest": { + "type": "string", + "readOnly": true, + "description": "Manifest digest" + }, + "architecture": { + "$ref": "#/definitions/ArtifactArchitecture", + "readOnly": true, + "description": "CPU architecture" + }, + "os": { + "$ref": "#/definitions/ArtifactOperatingSystem", + "readOnly": true, + "description": "Operating system", + "x-ms-client-name": "operatingSystem" + } + }, + "example": { + "os": "os", + "digest": "digest", + "architecture": "architecture" + } + }, + "ManifestAttributes_manifest": { + "description": "List of manifest attributes", + "properties": { + "references": { + "type": "array", + "description": "List of manifest attributes details", + "items": { + "$ref": "#/definitions/ManifestAttributes_manifest_references", + "description": "Manifest attributes details" + } + }, + "quarantineTag": { + "type": "string", + "description": "Quarantine tag name" + } + }, + "example": { + "quarantineTag": "quarantineTag", + "references": [ + { + "os": "os", + "digest": "digest", + "architecture": "architecture" + }, + { + "os": "os", + "digest": "digest", + "architecture": "architecture" + } + ] + } + }, + "ManifestChangeableAttributes": { + "description": "Changeable attributes", + "x-ms-client-name": "ManifestWriteableProperties", + "x-accessibility": "internal", + "properties": { + "deleteEnabled": { + "type": "boolean", + "description": "Delete enabled", + "x-ms-client-name": "canDelete" + }, + "writeEnabled": { + "type": "boolean", + "description": "Write enabled", + "x-ms-client-name": "canWrite" + }, + "listEnabled": { + "type": "boolean", + "description": "List enabled", + "x-ms-client-name": "canList" + }, + "readEnabled": { + "type": "boolean", + "description": "Read enabled", + "x-ms-client-name": "canRead" + }, + "quarantineState": { + "type": "string", + "description": "Quarantine state", + "x-accessibility": "internal" + }, + "quarantineDetails": { + "type": "string", + "description": "Quarantine details", + "x-accessibility": "internal" + } + }, + "example": { + "quarantineDetails": "quarantineDetails", + "readEnabled": true, + "quarantineState": "quarantineState", + "listEnabled": true, + "deleteEnabled": true, + "writeEnabled": true + } + }, + "RepositoryChangeableAttributes": { + "description": "Changeable attributes for Repository", + "x-ms-client-name": "RepositoryWriteableProperties", + "x-accessibility": "internal", + "properties": { + "deleteEnabled": { + "type": "boolean", + "description": "Delete enabled", + "x-ms-client-name": "canDelete" + }, + "writeEnabled": { + "type": "boolean", + "description": "Write enabled", + "x-ms-client-name": "canWrite" + }, + "listEnabled": { + "type": "boolean", + "description": "List enabled", + "x-ms-client-name": "canList" + }, + "readEnabled": { + "type": "boolean", + "description": "Read enabled", + "x-ms-client-name": "canRead" + }, + "teleportEnabled": { + "type": "boolean", + "description": "Enables Teleport functionality on new images in the repository improving Container startup performance" + } + }, + "example": { + "readEnabled": true, + "listEnabled": true, + "deleteEnabled": true, + "writeEnabled": true, + "teleportEnabled": true + } + }, + "Manifest": { + "description": "Returns the requested manifest file", + "x-accessibility": "internal", + "properties": { + "schemaVersion": { + "type": "integer", + "description": "Schema version" + } + } + }, + "ManifestWrapper": { + "description": "Returns the requested manifest file", + "x-accessibility": "internal", + "properties": { + "mediaType": { + "type": "string", + "description": "Media type for this Manifest" + }, + "manifests": { + "type": "array", + "description": "(ManifestList, OCIIndex) List of V2 image layer information", + "items": { + "$ref": "#/definitions/ManifestListAttributes" + } + }, + "config": { + "description": "(V2, OCI) Image config descriptor", + "$ref": "#/definitions/Descriptor" + }, + "layers": { + "type": "array", + "description": "(V2, OCI) List of V2 image layer information", + "items": { + "$ref": "#/definitions/Descriptor" + } + }, + "annotations": { + "description": "(OCI, OCIIndex) Additional metadata", + "$ref": "#/definitions/Annotations" + }, + "architecture": { + "type": "string", + "description": "(V1) CPU architecture" + }, + "name": { + "type": "string", + "description": "(V1) Image name" + }, + "tag": { + "type": "string", + "description": "(V1) Image tag" + }, + "fsLayers": { + "type": "array", + "description": "(V1) List of layer information", + "items": { + "$ref": "#/definitions/FsLayer" + } + }, + "history": { + "type": "array", + "description": "(V1) Image history", + "items": { + "$ref": "#/definitions/History" + } + }, + "signatures": { + "type": "array", + "description": "(V1) Image signature", + "items": { + "$ref": "#/definitions/ImageSignature" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/Manifest" + } + ] + }, + "ManifestList": { + "x-ms-discriminator-value": "application/vnd.docker.distribution.manifest.list.v2+json", + "description": "Returns the requested Docker multi-arch-manifest file", + "x-accessibility": "internal", + "properties": { + "mediaType": { + "type": "string", + "description": "Media type for this Manifest" + }, + "manifests": { + "type": "array", + "description": "List of V2 image layer information", + "items": { + "$ref": "#/definitions/ManifestListAttributes" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/Manifest" + } + ] + }, + "ManifestListAttributes": { + "x-accessibility": "internal", + "properties": { + "mediaType": { + "type": "string", + "description": "The MIME type of the referenced object. This will generally be application/vnd.docker.image.manifest.v2+json, but it could also be application/vnd.docker.image.manifest.v1+json" + }, + "size": { + "type": "integer", + "format": "int64", + "description": "The size in bytes of the object" + }, + "digest": { + "type": "string", + "description": "The digest of the content, as defined by the Registry V2 HTTP API Specification" + }, + "platform": { + "$ref": "#/definitions/Platform" + } + } + }, + "Platform": { + "description": "The platform object describes the platform which the image in the manifest runs on. A full list of valid operating system and architecture values are listed in the Go language documentation for $GOOS and $GOARCH", + "x-accessibility": "internal", + "properties": { + "architecture": { + "type": "string", + "description": "Specifies the CPU architecture, for example amd64 or ppc64le." + }, + "os": { + "type": "string", + "description": "The os field specifies the operating system, for example linux or windows." + }, + "os.version": { + "type": "string", + "description": "The optional os.version field specifies the operating system version, for example 10.0.10586." + }, + "os.features": { + "type": "array", + "description": "The optional os.features field specifies an array of strings, each listing a required OS feature (for example on Windows win32k", + "items": { + "type": "string" + } + }, + "variant": { + "type": "string", + "description": "The optional variant field specifies a variant of the CPU, for example armv6l to specify a particular CPU variant of the ARM CPU." + }, + "features": { + "type": "array", + "description": "The optional features field specifies an array of strings, each listing a required CPU feature (for example sse4 or aes", + "items": { + "type": "string" + } + } + } + }, + "V2Manifest": { + "x-ms-discriminator-value": "application/vnd.docker.distribution.manifest.v2+json", + "x-accessibility": "internal", + "description": "Returns the requested Docker V2 Manifest file", + "properties": { + "mediaType": { + "type": "string", + "description": "Media type for this Manifest" + }, + "config": { + "description": "V2 image config descriptor", + "$ref": "#/definitions/Descriptor" + }, + "layers": { + "type": "array", + "description": "List of V2 image layer information", + "items": { + "$ref": "#/definitions/Descriptor" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/Manifest" + } + ], + "example": { + "schemaVersion": 2, + "mediaType": "application/vnd.docker.distribution.manifest.v2+json", + "config": { + "mediaType": "application/vnd.docker.container.image.v1+json", + "size": 1512, + "digest": "sha256:6d1ef012b5674ad8a127ecfa9b5e6f5178d171b90ee462846974177fd9bdd39f" + }, + "layers": [ + { + "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 2107098, + "digest": "sha256:5d20c808ce198565ff70b3ed23a991dd49afac45dece63474b27ce6ed036adc6" + } + ] + } + }, + "OCIManifest": { + "x-ms-discriminator-value": "application/vnd.oci.image.manifest.v1+json", + "x-accessibility": "internal", + "description": "Returns the requested OCI Manifest file", + "properties": { + "config": { + "description": "V2 image config descriptor", + "$ref": "#/definitions/Descriptor" + }, + "layers": { + "type": "array", + "description": "List of V2 image layer information", + "items": { + "$ref": "#/definitions/Descriptor" + } + }, + "annotations": { + "$ref": "#/definitions/Annotations" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Manifest" + } + ] + }, + "OCIIndex": { + "x-ms-discriminator-value": "application/vnd.oci.image.index.v1+json", + "x-accessibility": "internal", + "description": "Returns the requested OCI index file", + "properties": { + "manifests": { + "type": "array", + "description": "List of OCI image layer information", + "items": { + "$ref": "#/definitions/ManifestListAttributes" + } + }, + "annotations": { + "$ref": "#/definitions/Annotations" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Manifest" + } + ] + }, + "V1Manifest": { + "description": "Returns the requested V1 manifest file", + "x-ms-discriminator-value": "application/vnd.oci.image.manifest.v1+json", + "x-accessibility": "internal", + "properties": { + "architecture": { + "type": "string", + "description": "CPU architecture" + }, + "name": { + "type": "string", + "description": "Image name" + }, + "tag": { + "type": "string", + "description": "Image tag" + }, + "fsLayers": { + "type": "array", + "description": "List of layer information", + "items": { + "$ref": "#/definitions/FsLayer" + } + }, + "history": { + "type": "array", + "description": "Image history", + "items": { + "$ref": "#/definitions/History" + } + }, + "signatures": { + "type": "array", + "description": "Image signature", + "items": { + "$ref": "#/definitions/ImageSignature" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/Manifest" + } + ] + }, + "Annotations": { + "description": "Additional information provided through arbitrary metadata.", + "x-accessibility": "internal", + "type": "object", + "x-nullable": true, + "additionalProperties": { + "type": "object" + }, + "properties": { + "org.opencontainers.image.created": { + "description": "Date and time on which the image was built (string, date-time as defined by https://tools.ietf.org/html/rfc3339#section-5.6)", + "type": "string", + "format": "date-time", + "x-ms-client-name": "Created" + }, + "org.opencontainers.image.authors": { + "description": "Contact details of the people or organization responsible for the image.", + "type": "string", + "x-ms-client-name": "Authors" + }, + "org.opencontainers.image.url": { + "description": "URL to find more information on the image.", + "type": "string", + "x-ms-client-name": "Url" + }, + "org.opencontainers.image.documentation": { + "description": "URL to get documentation on the image.", + "type": "string", + "x-ms-client-name": "Documentation" + }, + "org.opencontainers.image.source": { + "description": "URL to get source code for building the image.", + "type": "string", + "x-ms-client-name": "Source" + }, + "org.opencontainers.image.version": { + "description": "Version of the packaged software. The version MAY match a label or tag in the source code repository, may also be Semantic versioning-compatible", + "type": "string", + "x-ms-client-name": "Version" + }, + "org.opencontainers.image.revision": { + "description": "Source control revision identifier for the packaged software.", + "type": "string", + "x-ms-client-name": "Revision" + }, + "org.opencontainers.image.vendor": { + "description": "Name of the distributing entity, organization or individual.", + "type": "string", + "x-ms-client-name": "Vendor" + }, + "org.opencontainers.image.licenses": { + "description": "License(s) under which contained software is distributed as an SPDX License Expression.", + "type": "string", + "x-ms-client-name": "Licenses" + }, + "org.opencontainers.image.ref.name": { + "description": "Name of the reference for a target.", + "type": "string", + "x-ms-client-name": "Name" + }, + "org.opencontainers.image.title": { + "description": "Human-readable title of the image", + "type": "string", + "x-ms-client-name": "Title" + }, + "org.opencontainers.image.description": { + "description": "Human-readable description of the software packaged in the image", + "type": "string", + "x-ms-client-name": "Description" + } + } + } + }, + "parameters": { + "Url": { + "name": "url", + "x-ms-client-name": "loginUri", + "description": "Registry login URL", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "ImageReference": { + "name": "reference", + "in": "path", + "description": "A tag or a digest, pointing to a specific image", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ManifestReference": { + "name": "reference", + "in": "path", + "description": "Tag or digest of the target manifest", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "TagReference": { + "name": "reference", + "in": "path", + "description": "Tag name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Digest": { + "name": "digest", + "in": "path", + "description": "Digest of a BLOB", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DigestReference": { + "name": "reference", + "in": "path", + "description": "Digest of a BLOB", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "BlobQueryDigest": { + "name": "digest", + "in": "query", + "description": "Digest of a BLOB", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "RepositoryAttributeValue": { + "name": "value", + "in": "body", + "description": "Repository attribute value", + "required": false, + "schema": { + "$ref": "#/definitions/RepositoryChangeableAttributes" + }, + "x-ms-parameter-location": "method" + }, + "TagAttributeValue": { + "name": "value", + "in": "body", + "description": "Tag attribute value", + "required": false, + "schema": { + "$ref": "#/definitions/TagChangeableAttributes" + }, + "x-ms-parameter-location": "method" + }, + "ManifestAttributeValue": { + "name": "value", + "in": "body", + "description": "Manifest attribute value", + "required": false, + "schema": { + "$ref": "#/definitions/ManifestChangeableAttributes" + }, + "x-ms-parameter-location": "method" + }, + "QueryOrderBy": { + "name": "orderby", + "in": "query", + "description": "orderby query parameter", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "QueryNum": { + "name": "n", + "in": "query", + "description": "query parameter for max number of items", + "required": false, + "type": "integer", + "x-ms-parameter-location": "method" + }, + "QueryLast": { + "name": "last", + "in": "query", + "description": "Query parameter for the last item in previous query. Result set will include values lexically after last.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "QueryDigest": { + "name": "digest", + "in": "query", + "description": "filter by digest", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Grant_type": { + "name": "grant_type", + "description": "Can take a value of access_token", + "type": "string", + "in": "formData", + "required": true, + "enum": [ + "access_token" + ], + "x-ms-parameter-location": "method", + "x-accessibility": "internal" + }, + "Service": { + "name": "service", + "in": "formData", + "required": true, + "description": "Indicates the name of your Azure container registry.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "Tenant": { + "name": "tenant", + "in": "formData", + "required": false, + "description": "AAD tenant associated to the AAD credentials.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "Scope": { + "name": "scope", + "in": "formData", + "required": true, + "description": "Which is expected to be a valid scope, and can be specified more than once for multiple scope requests. You can obtain this from the Www-Authenticate response header from the challenge.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "RefreshToken": { + "name": "refresh_token", + "in": "formData", + "required": false, + "description": "AAD refresh token, mandatory when grant_type is access_token_refresh_token or refresh_token", + "type": "string", + "x-ms-parameter-location": "method" + }, + "AccessToken": { + "name": "access_token", + "x-ms-client-name": "aadAccessToken", + "in": "formData", + "required": true, + "description": "AAD access token, mandatory when grant_type is access_token_refresh_token or access_token.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "ImageName": { + "name": "name", + "in": "path", + "description": "Name of the image (including the namespace)", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ManifestBody": { + "description": "Manifest body, can take v1 or v2 values depending on accept header", + "name": "payload", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Manifest" + }, + "x-ms-parameter-location": "method" + }, + "RawData": { + "name": "value", + "description": "Raw data of blob", + "in": "body", + "schema": { + "type": "object", + "format": "file" + }, + "required": true, + "x-ms-parameter-location": "method" + }, + "RawDataOptional": { + "name": "value", + "description": "Optional raw data of blob", + "in": "body", + "schema": { + "type": "object", + "format": "file" + }, + "required": false, + "x-ms-parameter-location": "method" + }, + "From": { + "name": "from", + "type": "string", + "in": "query", + "description": "Name of the source repository.", + "required": true, + "x-ms-parameter-location": "method" + }, + "Mount": { + "name": "mount", + "description": "Digest of blob to mount from the source repository.", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "method" + }, + "Uuid": { + "name": "uuid", + "description": "A uuid identifying the upload.", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "Content-Range": { + "name": "Content-Range", + "in": "header", + "description": "Range of bytes identifying the desired block of content represented by the body. Start must the end offset retrieved via status check plus one. Note that this is a non-standard use of the `Content-Range` header.", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "Range": { + "name": "Range", + "type": "string", + "description": "Format : bytes=-, HTTP Range header specifying blob chunk.", + "in": "header", + "required": true, + "x-ms-parameter-location": "method" + }, + "NoUploadCache": { + "description": "Acquired from NextLink", + "name": "_nouploadcache", + "in": "query", + "type": "boolean", + "required": false, + "x-ms-parameter-location": "method" + }, + "State": { + "description": "Acquired from NextLink", + "name": "_state", + "in": "query", + "type": "string", + "required": false, + "x-ms-parameter-location": "method" + }, + "NextLink": { + "name": "nextBlobUuidLink", + "x-ms-client-name": "location", + "type": "string", + "description": "Link acquired from upload start or previous chunk. Note, do not include initial / (must do substring(1) )", + "in": "path", + "required": true, + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/CancelBlobUpload.json b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/CancelBlobUpload.json new file mode 100644 index 000000000000..1a32d216e7bd --- /dev/null +++ b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/CancelBlobUpload.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "url": "acrapi.azurecr-test.io", + "nextBlobUuidLink": "v2/blobland/blobs/uploads/2b28c60d-d296-44b7-b2b4-1f01c63195c6?_nouploadcache=false&_state=VYABvUSCNW2yY5e5VabLHppXqwU0K7cvT0YUdq57KBt7Ik5hbWUiOiJibG9ibGFuZCIsIlVVSUQiOiIyYjI4YzYwZC1kMjk2LTQ0YjctYjJiNC0xZjAxYzYzMTk1YzYiLCJPZmZzZXQiOjAsIlN0YXJ0ZWRBdCI6IjIwMTktMDgtMjdUMjM6NTI6NDcuMDUzNjU2Mjg1WiJ9" + }, + "responses": { + "204": {} + } +} diff --git a/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/CheckBlob.json b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/CheckBlob.json new file mode 100644 index 000000000000..519425f52232 --- /dev/null +++ b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/CheckBlob.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "url": "acrapi.azurecr-test.io", + "name": "prod/bash", + "digest": "sha256:16463e0c481e161aabb735437d30b3c9c7391c2747cc564bb927e843b73dcb39" + }, + "responses": { + "200": { + "headers": { + "Content-Length": 5635 + } + }, + "307": { + "headers": { + "Location": "https://csharpsdktest.azurecr.io/v2/prod/bash/blobs/sha256:3131d2b2b3352091117a3abe745d01a3fed472b7327c3183602247937800e3a6" + } + } + } +} diff --git a/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/CheckBlobChunk.json b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/CheckBlobChunk.json new file mode 100644 index 000000000000..49fddb0cd1b9 --- /dev/null +++ b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/CheckBlobChunk.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "url": "acrapi.azurecr-test.io", + "name": "prod/bash", + "digest": "sha256:16463e0c481e161aabb735437d30b3c9c7391c2747cc564bb927e843b73dcb39", + "Range": "bytes=0-299" + }, + "responses": { + "200": { + "headers": { + "Content-Length": "300", + "Content-Range": "bytes 0-299/5635" + } + } + } +} diff --git a/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/CreateManifest.json b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/CreateManifest.json new file mode 100644 index 000000000000..9009925c6027 --- /dev/null +++ b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/CreateManifest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "url": "acrapi.azurecr-test.io", + "name": "hello-world", + "reference": "a20190628-081044z", + "payload": "{\"schemaVersion\":2,\"mediaType\":\"application/vnd.docker.distribution.manifest.v2+json\",\"config\":{\"mediaType\":\"application/vnd.docker.container.image.v1+json\",\"size\":1512,\"digest\":\"sha256:6d1ef012b5674ad8a127ecfa9b5e6f5178d171b90ee462846974177fd9bdd39f\"},\"layers\":[{\"mediaType\":\"application/vnd.docker.image.rootfs.diff.tar.gzip\",\"size\":2107098,\"digest\":\"sha256:5d20c808ce198565ff70b3ed23a991dd49afac45dece63474b27ce6ed036adc6\"}]}" + }, + "responses": { + "201": { + "headers": { + "Docker-Content-Digest": "sha256:15685c48490175b7dde62e6bfcfb54d9420c6495ea6404776e2facca3da93cd8", + "Location": "/v2/hello-world/manifests/sha256:15685c48490175b7dde62e6bfcfb54d9420c6495ea6404776e2facca3da93cd8", + "Content-Length": 0 + }, + "body": {} + } + } +} diff --git a/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/DeleteAcrRepository.json b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/DeleteAcrRepository.json new file mode 100644 index 000000000000..a827c298d237 --- /dev/null +++ b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/DeleteAcrRepository.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "url": "acrapi.azurecr-test.io", + "name": "nanoserver" + }, + "responses": { + "202": {}, + "404": {} + } +} diff --git a/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/DeleteBlob.json b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/DeleteBlob.json new file mode 100644 index 000000000000..8852e49d5c19 --- /dev/null +++ b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/DeleteBlob.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "url": "acrapi.azurecr-test.io", + "name": "prod/bash", + "digest": "sha256:16463e0c481e161aabb735437d30b3c9c7391c2747cc564bb927e843b73dcb39" + }, + "responses": { + "202": { + "body": "" + } + } +} diff --git a/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/DeleteManifest.json b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/DeleteManifest.json new file mode 100644 index 000000000000..136be72af409 --- /dev/null +++ b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/DeleteManifest.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "url": "acrapi.azurecr-test.io", + "name": "alpine", + "reference": "3.7" + }, + "responses": { + "202": {}, + "404": {} + } +} diff --git a/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/DeleteTag.json b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/DeleteTag.json new file mode 100644 index 000000000000..eda882dea680 --- /dev/null +++ b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/DeleteTag.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "url": "acrapi.azurecr-test.io", + "name": "nanoserver", + "reference": "4.7.2-20180905-nanoserver-1803" + }, + "responses": { + "202": {}, + "404": {} + } +} diff --git a/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/EndBlobUpload.json b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/EndBlobUpload.json new file mode 100644 index 000000000000..82f0c9c35538 --- /dev/null +++ b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/EndBlobUpload.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "url": "acrapi.azurecr-test.io", + "nextBlobUuidLink": "v2/blobland/blobs/uploads/2b28c60d-d296-44b7-b2b4-1f01c63195c6?_nouploadcache=false&_state=VYABvUSCNW2yY5e5VabLHppXqwU0K7cvT0YUdq57KBt7Ik5hbWUiOiJibG9ibGFuZCIsIlVVSUQiOiIyYjI4YzYwZC1kMjk2LTQ0YjctYjJiNC0xZjAxYzYzMTk1YzYiLCJPZmZzZXQiOjAsIlN0YXJ0ZWRBdCI6IjIwMTktMDgtMjdUMjM6NTI6NDcuMDUzNjU2Mjg1WiJ9", + "digest": "sha256:a05a7abc31b0caadd5058069eaa623cdd0538512dbddacc7ca5bad73c3957c5e", + "value": "usuallyEmpty" + }, + "responses": { + "201": { + "headers": { + "Location": "/v2/blobland/blobs/sha256:a05a7abc31b0caadd5058069eaa623cdd0538512dbddacc7ca5bad73c3957c5e", + "Docker-Content-Digest": "sha256:a05a7abc31b0caadd5058069eaa623cdd0538512dbddacc7ca5bad73c3957c5e" + } + } + } +} diff --git a/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetBlob.json b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetBlob.json new file mode 100644 index 000000000000..b50eee9da47c --- /dev/null +++ b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetBlob.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "url": "acrapi.azurecr-test.io", + "name": "prod/bash", + "digest": "sha256:16463e0c481e161aabb735437d30b3c9c7391c2747cc564bb927e843b73dcb39" + }, + "responses": { + "200": { + "body": "eyJhcmNoaXRlY3R1cmUiOiJhbWQ2NCIsImNvbmZpZyI6eyJIb3N0bmFtZSI6IiIsIkRvbWFpbm5hbWUiOiIiLCJVc2VyIjoiIiwiQXR0YWNoU3RkaW4iOmZhbHNlLCJBdHRhY2hTdGRvdXQiOmZhbHNlLCJBdHRhY2hTdGRlcnIiOmZhbHNlLCJUdHkiOmZhbHNlLCJPcGVuU3RkaW4iOmZhbHNlLCJTdGRpbk9uY2UiOmZhbHNlLCJFbnYiOlsiUEFUSD0vdXNyL2xvY2FsL3NiaW46L3Vzci9sb2NhbC9iaW46L3Vzci9zYmluOi91c3IvYmluOi9zYmluOi9iaW4iLCJfQkFTSF9HUEdfS0VZPTdDMDEzNUZCMDg4QUFGNkM2NkM2NTBCOUJCNTg2OUYwNjRFQTc0QUIiLCJfQkFTSF9WRVJTSU9OPTUuMCIsIl9CQVNIX1BBVENIX0xFVkVMPTAiLCJfQkFTSF9MQVRFU1RfUEFUQ0g9NyJdLCJDbWQiOlsiYmFzaCJdLCJBcmdzRXNjYXBlZCI6dHJ1ZSwiSW1hZ2UiOiJzaGEyNTY6MzhhZDJmYmM5ZjljMGE4N2RmZTBhMmIxOWJkY2E5NGJlNDVmNDY2M2Y3M2ZkMDlmZWZlZTQ5MmFmZDJjMDE0NCIsIlZvbHVtZXMiOm51bGwsIldvcmtpbmdEaXIiOiIiLCJFbnRyeXBvaW50IjpbImRvY2tlci1lbnRyeXBvaW50LnNoIl0sIk9uQnVpbGQiOm51bGwsIkxhYmVscyI6bnVsbH0sImNvbnRhaW5lciI6IjRiMDU0NmZhNDlkZjVkY2FlZDViNjYzNzE3ZjQ0MmNlZjcxYTFiOTVjMGZmYjQyYzhjNWNlNzIzMWI5MGMwMjYiLCJjb250YWluZXJfY29uZmlnIjp7Ikhvc3RuYW1lIjoiNGIwNTQ2ZmE0OWRmIiwiRG9tYWlubmFtZSI6IiIsIlVzZXIiOiIiLCJBdHRhY2hTdGRpbiI6ZmFsc2UsIkF0dGFjaFN0ZG91dCI6ZmFsc2UsIkF0dGFjaFN0ZGVyciI6ZmFsc2UsIlR0eSI6ZmFsc2UsIk9wZW5TdGRpbiI6ZmFsc2UsIlN0ZGluT25jZSI6ZmFsc2UsIkVudiI6WyJQQVRIPS91c3IvbG9jYWwvc2JpbjovdXNyL2xvY2FsL2JpbjovdXNyL3NiaW46L3Vzci9iaW46L3NiaW46L2JpbiIsIl9CQVNIX0dQR19LRVk9N0MwMTM1RkIwODhBQUY2QzY2QzY1MEI5QkI1ODY5RjA2NEVBNzRBQiIsIl9CQVNIX1ZFUlNJT049NS4wIiwiX0JBU0hfUEFUQ0hfTEVWRUw9MCIsIl9CQVNIX0xBVEVTVF9QQVRDSD03Il0sIkNtZCI6WyIvYmluL3NoIiwiLWMiLCIjKG5vcCkgIiwiQ01EIFtcImJhc2hcIl0iXSwiQXJnc0VzY2FwZWQiOnRydWUsIkltYWdlIjoic2hhMjU2OjM4YWQyZmJjOWY5YzBhODdkZmUwYTJiMTliZGNhOTRiZTQ1ZjQ2NjNmNzNmZDA5ZmVmZWU0OTJhZmQyYzAxNDQiLCJWb2x1bWVzIjpudWxsLCJXb3JraW5nRGlyIjoiIiwiRW50cnlwb2ludCI6WyJkb2NrZXItZW50cnlwb2ludC5zaCJdLCJPbkJ1aWxkIjpudWxsLCJMYWJlbHMiOnt9fSwiY3JlYXRlZCI6IjIwMTktMDctMTNUMDE6MTY6MDYuNTI3NTE1OTAyWiIsImRvY2tlcl92ZXJzaW9uIjoiMTguMDYuMS1jZSIsImhpc3RvcnkiOlt7ImNyZWF0ZWQiOiIyMDE5LTA3LTExVDIyOjIwOjUyLjEzOTcwOTM1NVoiLCJjcmVhdGVkX2J5IjoiL2Jpbi9zaCAtYyAjKG5vcCkgQUREIGZpbGU6MGViNWVhMzU3NDFkMjNmZTM5Y2JhYzI0NWIzYTVkODQ4NTZlZDYzODRmNGZmMDdkNDk2MzY5ZWU2ZDk2MGJhZCBpbiAvICJ9LHsiY3JlYXRlZCI6IjIwMTktMDctMTFUMjI6MjA6NTIuMzc1Mjg2NDA0WiIsImNyZWF0ZWRfYnkiOiIvYmluL3NoIC1jICMobm9wKSAgQ01EIFtcIi9iaW4vc2hcIl0iLCJlbXB0eV9sYXllciI6dHJ1ZX0seyJjcmVhdGVkIjoiMjAxOS0wNy0xM1QwMToxNToxMy41Njc2Njk4MTJaIiwiY3JlYXRlZF9ieSI6Ii9iaW4vc2ggLWMgIyhub3ApICBFTlYgX0JBU0hfR1BHX0tFWT03QzAxMzVGQjA4OEFBRjZDNjZDNjUwQjlCQjU4NjlGMDY0RUE3NEFCIiwiZW1wdHlfbGF5ZXIiOnRydWV9LHsiY3JlYXRlZCI6IjIwMTktMDctMTNUMDE6MTU6MTMuNzQ1NjUyMDk4WiIsImNyZWF0ZWRfYnkiOiIvYmluL3NoIC1jICMobm9wKSAgRU5WIF9CQVNIX1ZFUlNJT049NS4wIiwiZW1wdHlfbGF5ZXIiOnRydWV9LHsiY3JlYXRlZCI6IjIwMTktMDctMTNUMDE6MTU6MTMuOTQwNDU1NDE5WiIsImNyZWF0ZWRfYnkiOiIvYmluL3NoIC1jICMobm9wKSAgRU5WIF9CQVNIX1BBVENIX0xFVkVMPTAiLCJlbXB0eV9sYXllciI6dHJ1ZX0seyJjcmVhdGVkIjoiMjAxOS0wNy0xM1QwMToxNToxNC4wOTkzMDAwNzVaIiwiY3JlYXRlZF9ieSI6Ii9iaW4vc2ggLWMgIyhub3ApICBFTlYgX0JBU0hfTEFURVNUX1BBVENIPTciLCJlbXB0eV9sYXllciI6dHJ1ZX0seyJjcmVhdGVkIjoiMjAxOS0wNy0xM1QwMToxNjowNS45Mjg0MjkyNjJaIiwiY3JlYXRlZF9ieSI6Ii9iaW4vc2ggLWMgc2V0IC1ldXg7IFx0XHRhcGsgYWRkIC0tbm8tY2FjaGUgLS12aXJ0dWFsIC5idWlsZC1kZXBzIFx0XHRiaXNvbiBcdFx0Y29yZXV0aWxzIFx0XHRkcGtnLWRldiBkcGtnIFx0XHRnY2MgXHRcdGdudXBnIFx0XHRsaWJjLWRldiBcdFx0bWFrZSBcdFx0bmN1cnNlcy1kZXYgXHRcdHBhdGNoIFx0XHR0YXIgXHQ7IFx0XHR2ZXJzaW9uPVwiJF9CQVNIX1ZFUlNJT05cIjsgXHRpZiBbIFwiJF9CQVNIX1BBVENIX0xFVkVMXCIgLWd0IDAgXTsgdGhlbiBcdFx0dmVyc2lvbj1cIiR2ZXJzaW9uLiRfQkFTSF9QQVRDSF9MRVZFTFwiOyBcdGZpOyBcdHdnZXQgLU8gYmFzaC50YXIuZ3ogXCJodHRwczovL2Z0cC5nbnUub3JnL2dudS9iYXNoL2Jhc2gtJHZlcnNpb24udGFyLmd6XCI7IFx0d2dldCAtTyBiYXNoLnRhci5nei5zaWcgXCJodHRwczovL2Z0cC5nbnUub3JnL2dudS9iYXNoL2Jhc2gtJHZlcnNpb24udGFyLmd6LnNpZ1wiOyBcdFx0aWYgWyBcIiRfQkFTSF9MQVRFU1RfUEFUQ0hcIiAtZ3QgXCIkX0JBU0hfUEFUQ0hfTEVWRUxcIiBdOyB0aGVuIFx0XHRta2RpciAtcCBiYXNoLXBhdGNoZXM7IFx0XHRmaXJzdD1cIiQocHJpbnRmICclMDNkJyBcIiQoKCBfQkFTSF9QQVRDSF9MRVZFTCArIDEgKSlcIilcIjsgXHRcdGxhc3Q9XCIkKHByaW50ZiAnJTAzZCcgXCIkX0JBU0hfTEFURVNUX1BBVENIXCIpXCI7IFx0XHRmb3IgcGF0Y2ggaW4gJChzZXEgLXcgXCIkZmlyc3RcIiBcIiRsYXN0XCIpOyBkbyBcdFx0XHR1cmw9XCJodHRwczovL2Z0cC5nbnUub3JnL2dudS9iYXNoL2Jhc2gtJF9CQVNIX1ZFUlNJT04tcGF0Y2hlcy9iYXNoJHtfQkFTSF9WRVJTSU9OLy8uL30tJHBhdGNoXCI7IFx0XHRcdHdnZXQgLU8gXCJiYXNoLXBhdGNoZXMvJHBhdGNoXCIgXCIkdXJsXCI7IFx0XHRcdHdnZXQgLU8gXCJiYXNoLXBhdGNoZXMvJHBhdGNoLnNpZ1wiIFwiJHVybC5zaWdcIjsgXHRcdGRvbmU7IFx0Zmk7IFx0XHRleHBvcnQgR05VUEdIT01FPVwiJChta3RlbXAgLWQpXCI7IFx0Z3BnIC0tYmF0Y2ggLS1rZXlzZXJ2ZXIgaGEucG9vbC5za3Mta2V5c2VydmVycy5uZXQgLS1yZWN2LWtleXMgXCIkX0JBU0hfR1BHX0tFWVwiOyBcdGdwZyAtLWJhdGNoIC0tdmVyaWZ5IGJhc2gudGFyLmd6LnNpZyBiYXNoLnRhci5nejsgXHRncGdjb25mIC0ta2lsbCBhbGw7IFx0cm0gYmFzaC50YXIuZ3ouc2lnOyBcdGlmIFsgLWQgYmFzaC1wYXRjaGVzIF07IHRoZW4gXHRcdGZvciBzaWcgaW4gYmFzaC1wYXRjaGVzLyouc2lnOyBkbyBcdFx0XHRwPVwiJHtzaWclLnNpZ31cIjsgXHRcdFx0Z3BnIC0tYmF0Y2ggLS12ZXJpZnkgXCIkc2lnXCIgXCIkcFwiOyBcdFx0XHRybSBcIiRzaWdcIjsgXHRcdGRvbmU7IFx0Zmk7IFx0cm0gLXJmIFwiJEdOVVBHSE9NRVwiOyBcdFx0bWtkaXIgLXAgL3Vzci9zcmMvYmFzaDsgXHR0YXIgXHRcdC0tZXh0cmFjdCBcdFx0LS1maWxlPWJhc2gudGFyLmd6IFx0XHQtLXN0cmlwLWNvbXBvbmVudHM9MSBcdFx0LS1kaXJlY3Rvcnk9L3Vzci9zcmMvYmFzaCBcdDsgXHRybSBiYXNoLnRhci5nejsgXHRcdGlmIFsgLWQgYmFzaC1wYXRjaGVzIF07IHRoZW4gXHRcdGZvciBwIGluIGJhc2gtcGF0Y2hlcy8qOyBkbyBcdFx0XHRwYXRjaCBcdFx0XHRcdC0tZGlyZWN0b3J5PS91c3Ivc3JjL2Jhc2ggXHRcdFx0XHQtLWlucHV0PVwiJChyZWFkbGluayAtZiBcIiRwXCIpXCIgXHRcdFx0XHQtLXN0cmlwPTAgXHRcdFx0OyBcdFx0XHRybSBcIiRwXCI7IFx0XHRkb25lOyBcdFx0cm1kaXIgYmFzaC1wYXRjaGVzOyBcdGZpOyBcdFx0Y2QgL3Vzci9zcmMvYmFzaDsgXHRnbnVBcmNoPVwiJChkcGtnLWFyY2hpdGVjdHVyZSAtLXF1ZXJ5IERFQl9CVUlMRF9HTlVfVFlQRSlcIjsgXHQuL2NvbmZpZ3VyZSBcdFx0LS1idWlsZD1cIiRnbnVBcmNoXCIgXHRcdC0tZW5hYmxlLXJlYWRsaW5lIFx0XHQtLXdpdGgtY3Vyc2VzIFx0XHQtLXdpdGhvdXQtYmFzaC1tYWxsb2MgXHR8fCB7IFx0XHRjYXQgXHUwMDNlXHUwMDI2MiBjb25maWcubG9nOyBcdFx0ZmFsc2U7IFx0fTsgXHRtYWtlIC1qIFwiJChucHJvYylcIjsgXHRtYWtlIGluc3RhbGw7IFx0Y2QgLzsgXHRybSAtciAvdXNyL3NyYy9iYXNoOyBcdFx0cm0gLXIgXHRcdC91c3IvbG9jYWwvc2hhcmUvZG9jL2Jhc2gvKi5odG1sIFx0XHQvdXNyL2xvY2FsL3NoYXJlL2luZm8gXHRcdC91c3IvbG9jYWwvc2hhcmUvbG9jYWxlIFx0XHQvdXNyL2xvY2FsL3NoYXJlL21hbiBcdDsgXHRcdHJ1bkRlcHM9XCIkKCBcdFx0c2NhbmVsZiAtLW5lZWRlZCAtLW5vYmFubmVyIC0tZm9ybWF0ICclbiNwJyAtLXJlY3Vyc2l2ZSAvdXNyL2xvY2FsIFx0XHRcdHwgdHIgJywnICdcXG4nIFx0XHRcdHwgc29ydCAtdSBcdFx0XHR8IGF3ayAnc3lzdGVtKFwiWyAtZSAvdXNyL2xvY2FsL2xpYi9cIiAkMSBcIiBdXCIpID09IDAgeyBuZXh0IH0geyBwcmludCBcInNvOlwiICQxIH0nIFx0KVwiOyBcdGFwayBhZGQgLS1uby1jYWNoZSAtLXZpcnR1YWwgLmJhc2gtcnVuZGVwcyAkcnVuRGVwczsgXHRhcGsgZGVsIC5idWlsZC1kZXBzOyBcdFx0WyBcIiQod2hpY2ggYmFzaClcIiA9ICcvdXNyL2xvY2FsL2Jpbi9iYXNoJyBdOyBcdGJhc2ggLS12ZXJzaW9uOyBcdFsgXCIkKGJhc2ggLWMgJ2VjaG8gXCIke0JBU0hfVkVSU0lPTiUlW14wLTkuXSp9XCInKVwiID0gXCIke19CQVNIX1ZFUlNJT04lJS0qfS4kX0JBU0hfTEFURVNUX1BBVENIXCIgXTsifSx7ImNyZWF0ZWQiOiIyMDE5LTA3LTEzVDAxOjE2OjA2LjE2NDEyODQxMloiLCJjcmVhdGVkX2J5IjoiL2Jpbi9zaCAtYyAjKG5vcCkgQ09QWSBmaWxlOjY1MWIzYmViZWJhOGJlOTE2MmM1NmIzZWI1NjExOTk5MDUyMzVmM2UxYzc4MTEyMzJiNmM5ZjQ4YWMzMzM2NTEgaW4gL3Vzci9sb2NhbC9iaW4vICJ9LHsiY3JlYXRlZCI6IjIwMTktMDctMTNUMDE6MTY6MDYuMzE5Mzc1ODg0WiIsImNyZWF0ZWRfYnkiOiIvYmluL3NoIC1jICMobm9wKSAgRU5UUllQT0lOVCBbXCJkb2NrZXItZW50cnlwb2ludC5zaFwiXSIsImVtcHR5X2xheWVyIjp0cnVlfSx7ImNyZWF0ZWQiOiIyMDE5LTA3LTEzVDAxOjE2OjA2LjUyNzUxNTkwMloiLCJjcmVhdGVkX2J5IjoiL2Jpbi9zaCAtYyAjKG5vcCkgIENNRCBbXCJiYXNoXCJdIiwiZW1wdHlfbGF5ZXIiOnRydWV9XSwib3MiOiJsaW51eCIsInJvb3RmcyI6eyJ0eXBlIjoibGF5ZXJzIiwiZGlmZl9pZHMiOlsic2hhMjU2OjFiZmVlYmQ2NTMyM2I4ZGRmNWJkNmE1MWNjNzA5N2I3Mjc4OGJjOTgyZTlhYjMyODBkNTNkM2M2MTNhZGZmYTciLCJzaGEyNTY6NDgzYzk4MGFjNmFiZjYzZmM0ZDcyNjJiMTdhMTk1NGQ2MjI2NmRhYzMwMjliNWJlMzg0ZDAzYjM5MjI5ODAzZSIsInNoYTI1Njo1ZjVmOTNhOTMzMDUyMTBhOTZjYzQxN2Y1NzlkNzBhNDk2YmJmMGRiOGU4MGVhMWU5NDM2NjgyYzM3OWYyNWQ5Il19fQ==", + "headers": { + "Content-Length": 5635 + } + }, + "307": { + "headers": { + "Location": "https://csharpsdktest.azurecr.io/v2/prod/bash/blobs/sha256:3131d2b2b3352091117a3abe745d01a3fed472b7327c3183602247937800e3a6" + } + } + } +} diff --git a/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetBlobChunk.json b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetBlobChunk.json new file mode 100644 index 000000000000..12671ea6b036 --- /dev/null +++ b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetBlobChunk.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "url": "acrapi.azurecr-test.io", + "name": "prod/bash", + "digest": "sha256:16463e0c481e161aabb735437d30b3c9c7391c2747cc564bb927e843b73dcb39", + "Range": "bytes=0-299" + }, + "responses": { + "206": { + "body": "eyJhcmNoaXRlY3R1cmUiOiJhbWQ2NCIsImNvbmZpZyI6eyJIb3N0bmFtZSI6IiIsIkRvbWFpbm5hbWUiOiIiLCJVc2VyIjoiIiwiQXR0YWNoU3RkaW4iOmZhbHNlLCJBdHRhY2hTdGRvdXQiOmZhbHNlLCJBdHRhY2hTdGRlcnIiOmZhbHNlLCJUdHkiOmZhbHNlLCJPcGVuU3RkaW4iOmZhbHNlLCJTdGRpbk9uY2UiOmZhbHNlLCJFbnYiOlsiUEFUSD0vdXNyL2xvY2FsL3NiaW46L3Vzci9sb2NhbC9iaW46L3Vzci9zYmluOi91c3IvYmluOi9zYmluOi9iaW4iLCJfQkFTSF9HUEdfS0VZPTdDMDEzNUZCMDg4QUFGNkM2NkM2NTBCOUJC", + "headers": { + "Content-Length": "300", + "Content-Range": "bytes 0-299/5635" + } + } + } +} diff --git a/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetBlobStatus.json b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetBlobStatus.json new file mode 100644 index 000000000000..03da3ca3fcd9 --- /dev/null +++ b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetBlobStatus.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "url": "acrapi.azurecr-test.io", + "nextBlobUuidLink": "v2/blobland/blobs/uploads/2b28c60d-d296-44b7-b2b4-1f01c63195c6?_nouploadcache=false&_state=VYABvUSCNW2yY5e5VabLHppXqwU0K7cvT0YUdq57KBt7Ik5hbWUiOiJibG9ibGFuZCIsIlVVSUQiOiIyYjI4YzYwZC1kMjk2LTQ0YjctYjJiNC0xZjAxYzYzMTk1YzYiLCJPZmZzZXQiOjAsIlN0YXJ0ZWRBdCI6IjIwMTktMDgtMjdUMjM6NTI6NDcuMDUzNjU2Mjg1WiJ9" + }, + "responses": { + "204": { + "headers": { + "Range": "0-0", + "Docker-Upload-Uuid": "2b28c60d-d296-44b7-b2b4-1f01c63195c6" + } + } + } +} diff --git a/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetDockerRegistryV2Support.json b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetDockerRegistryV2Support.json new file mode 100644 index 000000000000..181e2eec438e --- /dev/null +++ b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetDockerRegistryV2Support.json @@ -0,0 +1,8 @@ +{ + "parameters": { + "url": "acrapi.azurecr-test.io" + }, + "responses": { + "200": {} + } +} diff --git a/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetManifest.json b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetManifest.json new file mode 100644 index 000000000000..21e956b58cf3 --- /dev/null +++ b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetManifest.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "url": "acrapi.azurecr-test.io", + "name": "hello-world-dangling", + "reference": "20190628-033033z", + "accept": "application/vnd.docker.distribution.manifest.v2+json" + }, + "responses": { + "200": { + "body": { + "schemaVersion": 2 + } + } + } +} diff --git a/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetManifestAttributes.json b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetManifestAttributes.json new file mode 100644 index 000000000000..980d97942be7 --- /dev/null +++ b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetManifestAttributes.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "url": "acrapi.azurecr-test.io", + "name": "nanoserver", + "digest": "sha256:110d2b6c84592561338aa040b1b14b7ab81c2f9edbd564c2285dd7d70d777086" + }, + "responses": { + "200": { + "body": { + "registry": "acrapi.azurecr-test.io", + "imageName": "nanoserver", + "manifest": { + "digest": "sha256:110d2b6c84592561338aa040b1b14b7ab81c2f9edbd564c2285dd7d70d777086", + "imageSize": 2401606, + "createdTime": "2018-09-06T06:17:20.9983915Z", + "lastUpdateTime": "2018-09-06T06:17:20.9983915Z", + "architecture": "amd64", + "os": "windows", + "tags": [ + "4.7.2-20180905-nanoserver-1803" + ], + "changeableAttributes": { + "deleteEnabled": true, + "writeEnabled": true, + "readEnabled": true, + "listEnabled": true + } + } + } + } + } +} diff --git a/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetManifestList.json b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetManifestList.json new file mode 100644 index 000000000000..7b82d487513a --- /dev/null +++ b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetManifestList.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "url": "acrapi.azurecr-test.io", + "name": "nanoserver" + }, + "responses": { + "200": { + "body": { + "registry": "acrapi.azurecr-test.io", + "imageName": "nanoserver", + "manifests": [ + { + "digest": "sha256:110d2b6c84592561338aa040b1b14b7ab81c2f9edbd564c2285dd7d70d777086", + "imageSize": 2401606, + "createdTime": "2018-09-06T06:17:20.9983915Z", + "lastUpdateTime": "2018-09-06T06:17:20.9983915Z", + "architecture": "amd64", + "os": "windows", + "tags": [ + "4.7.2-20180905-nanoserver-1803" + ], + "changeableAttributes": { + "deleteEnabled": true, + "writeEnabled": true, + "readEnabled": true, + "listEnabled": true + } + }, + { + "digest": "sha256:7af5cd1dde3e8f5c2c9103860afa4ca871a6075373b6564b0e7b1b47866dab52", + "imageSize": 4135121, + "createdTime": "2018-09-07T16:30:46.5651701Z", + "lastUpdateTime": "2018-09-07T16:30:46.5651701Z", + "architecture": "amd64", + "os": "windows", + "tags": [ + "4.7.2-20180906-nanoserver-1803" + ], + "changeableAttributes": { + "deleteEnabled": true, + "writeEnabled": true, + "readEnabled": true, + "listEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetRepositoryAttributes.json b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetRepositoryAttributes.json new file mode 100644 index 000000000000..c6791683bfd2 --- /dev/null +++ b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetRepositoryAttributes.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "url": "acrapi.azurecr-test.io", + "name": "nanoserver" + }, + "responses": { + "200": { + "body": { + "registry": "acrapi.azurecr-test.io", + "imageName": "nanoserver", + "createdTime": "2018-09-06T06:17:20.9531248Z", + "lastUpdateTime": "2018-09-07T16:30:46.6583219Z", + "manifestCount": 2, + "tagCount": 2, + "changeableAttributes": { + "deleteEnabled": true, + "writeEnabled": true, + "readEnabled": true, + "listEnabled": true + } + } + } + } +} diff --git a/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetRepositoryList.json b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetRepositoryList.json new file mode 100644 index 000000000000..4b6864e0ea95 --- /dev/null +++ b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetRepositoryList.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "url": "acrapi.azurecr-test.io" + }, + "responses": { + "200": { + "body": { + "repositories": [ + "production/alpine", + "testing/alpine" + ] + } + } + } +} diff --git a/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetTagAttributes.json b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetTagAttributes.json new file mode 100644 index 000000000000..6238aebb8b96 --- /dev/null +++ b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetTagAttributes.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "url": "acrapi.azurecr-test.io", + "name": "test/bash", + "reference": "sha256:eabe547f78d4c18c708dd97ec3166cf7464cc651f1cbb67e7afas407405b7ad7b6" + }, + "responses": { + "200": { + "body": { + "registry": "acrapi.azurecr-test.io", + "imageName": "test/bash", + "tag": { + "name": "tagName", + "digest": "sha256:eabe547f78d4c18c708dd97ec3166cf7464cc651f1cbb67e70d407405b7ad7b6", + "createdTime": "2018-10-05T20:54:24.1286047Z", + "lastUpdateTime": "2018-10-05T20:54:24.1286047Z", + "changeableAttributes": { + "deleteEnabled": true, + "writeEnabled": false, + "readEnabled": true, + "listEnabled": true + } + } + } + } + } +} diff --git a/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetTagList.json b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetTagList.json new file mode 100644 index 000000000000..54af71dbac6a --- /dev/null +++ b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/GetTagList.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "url": "acrapi.azurecr-test.io", + "name": "nanoserver" + }, + "responses": { + "200": { + "body": { + "registry": "acrapi.azurecr-test.io", + "imageName": "nanoserver", + "tags": [ + { + "name": "4.7.2-20180905-nanoserver-1803", + "digest": "sha256:110d2b6c84592561338aa040b1b14b7ab81c2f9edbd564c2285dd7d70d777086", + "createdTime": "2018-09-06T06:17:21.0856539Z", + "lastUpdateTime": "2018-09-06T06:17:21.0856539Z", + "changeableAttributes": { + "deleteEnabled": true, + "writeEnabled": true, + "readEnabled": true, + "listEnabled": true + } + }, + { + "name": "4.7.2-20180906-nanoserver-1803", + "digest": "sha256:7af5cd1dde3e8f5c2c9103860afa4ca871a6075373b6564b0e7b1b47866dab52", + "createdTime": "2018-09-06T16:30:43.3860166Z", + "lastUpdateTime": "2018-09-07T16:30:46.7022734Z", + "changeableAttributes": { + "deleteEnabled": true, + "writeEnabled": true, + "readEnabled": true, + "listEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/MountBlob.json b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/MountBlob.json new file mode 100644 index 000000000000..45623b98265b --- /dev/null +++ b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/MountBlob.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "url": "acrapi.azurecr-test.io", + "name": "newimage", + "mount": "prod/bash", + "from": "sha256:16463e0c481e161aabb735437d30b3c9c7391c2747cc564bb927e843b73dcb39" + }, + "responses": { + "201": { + "headers": { + "Location": "/v2/somethingnew/blobs/sha256:16463e0c481e161aabb735437d30b3c9c7391c2747cc564bb927e843b73dcb39", + "Docker-Content-Digest": "sha256:16463e0c481e161aabb735437d30b3c9c7391c2747cc564bb927e843b73dcb39" + } + } + } +} diff --git a/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/PostAccessToken.json b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/PostAccessToken.json new file mode 100644 index 000000000000..a4e6293133b5 --- /dev/null +++ b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/PostAccessToken.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "url": "acrapi.azurecr-test.io", + "grant_type": "refresh_token", + "service": "someregistry.azurecr.io", + "scope": "registry:catalog:*", + "refresh_token": "eyJ0eXAiOiJKJhbGci1dCI6IkN0ZlFDOExlLTMejlnIiwidGlkIjoiNzJmOTgWItMmQ3Y2QwMTFkYjQ3Ii..." + }, + "responses": { + "200": { + "body": { + "access_token": "eyJ0eXAiOiJKJhbGcigdCI6IkN0ZlFaOExlLTMejlnIiwidGlkIjoiNzbmOTgWItMmQ3Y2QwMTFkYjQ3Ii..." + } + } + } +} diff --git a/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/PostRefreshToken.json b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/PostRefreshToken.json new file mode 100644 index 000000000000..4176aaccecfd --- /dev/null +++ b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/PostRefreshToken.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "grant_type": "access_token", + "url": "acrapi.azurecr-test.io", + "service": "someregistry.azurecr.io", + "tenant": "02f900bf-86f1-31af-p1ab-2b7cd0nndb47", + "access_token": "eyJ0eXAiOiJKJhbGci1dCI6IkN0ZlFDOExlLTMejlnIiwidGlkIjoiNzJmOTgWItMmQ3Y2QwMTFkYjQ3Ii..." + }, + "responses": { + "200": { + "body": { + "refresh_token": "eyJ0eXAiOiJKJhbGcigdCI6IkN0ZlFaOExlLTMejlnIiwidGlkIjoiNzbmOTgWItMmQ3Y2QwMTFkYjQ3Ii..." + } + } + } +} diff --git a/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/StartBlobUpload.json b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/StartBlobUpload.json new file mode 100644 index 000000000000..38d70c467e5f --- /dev/null +++ b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/StartBlobUpload.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "url": "acrapi.azurecr-test.io", + "name": "newimg" + }, + "responses": { + "202": { + "headers": { + "Location": "/v2/blobland/blobs/uploads/f6d3451c-3352-43ff-b67c-fd0cfc793066?_nouploadcache=false&_state=iWTaVpaWiz23JTt8ZsYFPEU5JwLOFgdumWOmqGxIYGt7Ik5hbWUiOiJibG9ibGFuZCIsIlVVSUQiOiJmNmQzNDUxYy0zMzUyLTQzZmYtYjY3Yy1mZDBjZmM3OTMwNjYiLCJPZmZzZXQiOjAsIlN0YXJ0ZWRBdCI6IjIwMTktMDgtMjdUMjM6NTI6NTQuNTM1MDQ5ODY1WiJ9", + "Range": "0-0", + "Docker-Upload-Uuid": "f6d3451c-3352-43ff-b67c-fd0cfc793066" + } + } + } +} diff --git a/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/UpdateManifestAttributes.json b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/UpdateManifestAttributes.json new file mode 100644 index 000000000000..83e9868d303f --- /dev/null +++ b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/UpdateManifestAttributes.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "url": "acrapi.azurecr-test.io", + "name": "nanoserver", + "digest": "sha256:110d2b6c84592561338aa040b1b14b7ab81c2f9edbd564c2285dd7d70d777086", + "value": { + "writeEnabled": false + } + }, + "responses": { + "200": { + "body": { + "registry": "acrapi.azurecr-test.io", + "imageName": "nanoserver", + "manifest": { + "digest": "sha256:110d2b6c84592561338aa040b1b14b7ab81c2f9edbd564c2285dd7d70d777086", + "imageSize": 2401606, + "createdTime": "2018-09-06T06:17:20.9983915Z", + "lastUpdateTime": "2018-09-06T06:17:20.9983915Z", + "architecture": "amd64", + "os": "windows", + "tags": [ + "4.7.2-20180905-nanoserver-1803" + ], + "changeableAttributes": { + "deleteEnabled": true, + "writeEnabled": false, + "readEnabled": true, + "listEnabled": true + } + } + } + } + } +} diff --git a/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/UpdateRepositoryAttributes.json b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/UpdateRepositoryAttributes.json new file mode 100644 index 000000000000..8077b21fbdd9 --- /dev/null +++ b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/UpdateRepositoryAttributes.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "url": "acrapi.azurecr-test.io", + "name": "nanoserver", + "value": { + "writeEnabled": false + } + }, + "responses": { + "200": { + "body": { + "registry": "acrapi.azurecr-test.io", + "imageName": "nanoserver", + "createdTime": "2018-09-06T06:17:20.9531248Z", + "lastUpdateTime": "2018-09-07T16:30:46.6583219Z", + "manifestCount": 2, + "tagCount": 2, + "changeableAttributes": { + "deleteEnabled": true, + "writeEnabled": false, + "readEnabled": true, + "listEnabled": true + } + } + } + } +} diff --git a/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/UpdateTagAttributes.json b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/UpdateTagAttributes.json new file mode 100644 index 000000000000..37f164b29436 --- /dev/null +++ b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/UpdateTagAttributes.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "url": "acrapi.azurecr-test.io", + "name": "nanoserver", + "reference": "4.7.2-20180905-nanoserver-1803", + "value": "{\"writeEnabled\": false}" + }, + "responses": { + "200": { + "body": { + "registry": "acrapi.azurecr-test.io", + "imageName": "test/bash", + "tag": { + "name": "tagName", + "digest": "sha256:eabe547f78d4c18c708dd97ec3166cf7464cc651f1cbb67e70d407405b7ad7b6", + "createdTime": "2018-10-05T20:54:24.1286047Z", + "lastUpdateTime": "2018-10-05T20:54:24.1286047Z", + "changeableAttributes": { + "deleteEnabled": true, + "writeEnabled": false, + "readEnabled": true, + "listEnabled": true + } + } + } + } + } +} diff --git a/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/UploadBlob.json b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/UploadBlob.json new file mode 100644 index 000000000000..7add0750729c --- /dev/null +++ b/specification/containerregistry/data-plane/Azure.ContainerRegistry/preview/2019-08-15-preview/examples/UploadBlob.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "url": "acrapi.azurecr-test.io", + "nextBlobUuidLink": "v2/blobland/blobs/uploads/2b28c60d-d296-44b7-b2b4-1f01c63195c6?_nouploadcache=false&_state=VYABvUSCNW2yY5e5VabLHppXqwU0K7cvT0YUdq57KBt7Ik5hbWUiOiJibG9ibGFuZCIsIlVVSUQiOiIyYjI4YzYwZC1kMjk2LTQ0YjctYjJiNC0xZjAxYzYzMTk1YzYiLCJPZmZzZXQiOjAsIlN0YXJ0ZWRBdCI6IjIwMTktMDgtMjdUMjM6NTI6NDcuMDUzNjU2Mjg1WiJ9", + "value": "U29tZXRoaW5nRWxzZQ==" + }, + "responses": { + "202": { + "headers": { + "Location": "/v2/blobland/blobs/uploads/f6d3451c-3352-43ff-b67c-fd0cfc793066?_nouploadcache=false&_state=9G2t2KQOw-ANeo5TrnwVb5OeAUIe0NaEJ2jxwLT6Y1J7Ik5hbWUiOiJibG9ibGFuZCIsIlVVSUQiOiJmNmQzNDUxYy0zMzUyLTQzZmYtYjY3Yy1mZDBjZmM3OTMwNjYiLCJPZmZzZXQiOjEzLCJTdGFydGVkQXQiOiIyMDE5LTA4LTI3VDIzOjUyOjU0WiJ9", + "Range": "0-12", + "Docker-Upload-Uuid": "f6d3451c-3352-43ff-b67c-fd0cfc793066" + } + } + } +} diff --git a/specification/containerregistry/data-plane/Azure.ContainerRegistry/readme.md b/specification/containerregistry/data-plane/Azure.ContainerRegistry/readme.md new file mode 100644 index 000000000000..81347188f7fa --- /dev/null +++ b/specification/containerregistry/data-plane/Azure.ContainerRegistry/readme.md @@ -0,0 +1,148 @@ +# ContainerRegistry + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for ContainerRegistry. + +--- + +## Configuration + +### Basic Information + +These are the global settings for the ContainerRegistry API. + +``` yaml +# common +title: ContainerRegistryClient +openapi-type: data-plane +tag: package-2019-08 +``` +### Tag: package-2019-08 + +These settings apply only when `--tag=package-2019-08` is specified on the command line. + +``` yaml $(tag) == 'package-2019-08' +input-file: preview/2019-08-15-preview/containerregistry.json +``` + +--- +# Code Generation + +## C# + +These settings apply only when `--csharp` is specified on the command line. + +``` yaml $(csharp) +csharp: true +model-namespace: false +directive: + - from: containerregistry.json + where: $.definitions.DeletedRepository + transform: > + $["x-accessibility"] = "internal" + + - from: containerregistry.json + where: $.definitions.ManifestAttributes_manifest_references + transform: > + $["x-accessibility"] = "internal" +``` + +## Java + +These settings apply only when `--java` is specified on the command line. + +``` yaml $(java) +java: true +``` + +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. + +``` yaml $(typescript) +typescript: true +v3: true +package-name: "@azure/container-registry" +title: GeneratedClient +description: Container Registry Client +generate-metadata: false +license-header: MICROSOFT_MIT_NO_VERSION +add-credentials: false +override-client-name: GeneratedClient +disable-async-iterators: true +hide-clients: true +use-extension: + "@autorest/typescript": "6.0.0-beta.4" +output-folder: ../ +source-code-folder-path: ./src/generated +``` + +## Python +These settings apply only when `--python` is specified on the command line. + +``` yaml $(python) +python: true +``` + +## Suppression + +``` yaml +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + from: containerregistry.json + where: $.definitions.AccessToken.properties.access_token + reason: Property name is used in compliance with Docker's own specs for compatibility purposes. Specifics https://docs.docker.com/registry/spec/auth/oauth/ + - suppress: DefinitionsPropertiesNamesCamelCase + from: containerregistry.json + where: $.definitions.RefreshToken.properties.refresh_token + reason: Property name is used in compliance with Docker's own specs for compatibility purposes. Specifics https://docs.docker.com/registry/spec/auth/oauth/ + - suppress: LROStatusCodesReturnTypeSchema + reason: No content is returned by put Manifest in compliance with Docker's own specs for compatibility purposes. Specifics https://docs.docker.com/registry/spec/api/#put-manifest + from: containerregistry.json + where: $.paths["/v2/{name}/manifests/{reference}"].put.responses["201"] + - suppress: LROStatusCodesReturnTypeSchema + reason: No content is returned by put End Upload in compliance with Docker's own specs for compatibility purposes. Specifics https://docs.docker.com/v17.12/registry/spec/api/ + from: containerregistry.json + where: $.paths["/{nextBlobUuidLink}"].put.responses["201"] + - suppress: DefinitionsPropertiesNamesCamelCase + reason: These default values are specified by the Open Container Initiative. Used for cross compatibility. Specifics https://github.com/opencontainers/image-spec/blob/master/annotations.md#rules + from: containerregistry.json + where: + - $.definitions.Platform.properties["os.version"] + - $.definitions.Platform.properties["os.features"] + - $.definitions.Annotations.properties["org.opencontainers.image.created"] + - $.definitions.Annotations.properties["org.opencontainers.image.authors"] + - $.definitions.Annotations.properties["org.opencontainers.image.url"] + - $.definitions.Annotations.properties["org.opencontainers.image.documentation"] + - $.definitions.Annotations.properties["org.opencontainers.image.source"] + - $.definitions.Annotations.properties["org.opencontainers.image.version"] + - $.definitions.Annotations.properties["org.opencontainers.image.revision"] + - $.definitions.Annotations.properties["org.opencontainers.image.vendor"] + - $.definitions.Annotations.properties["org.opencontainers.image.licenses"] + - $.definitions.Annotations.properties["org.opencontainers.image.ref.name"] + - $.definitions.Annotations.properties["org.opencontainers.image.title"] + - $.definitions.Annotations.properties["org.opencontainers.image.description"] + - suppress: RequiredReadOnlyProperties + reason: These are used in output types to mark readonly properties as non-optional. It should be allowed https://github.com/Azure/azure-openapi-validator/issues/243 + from: containerregistry.json + where: + - $.definitions.RepositoryAttributes.properties["registry"] + - $.definitions.RepositoryAttributes.properties["imageName"] + - $.definitions.RepositoryAttributes.properties["createdTime"] + - $.definitions.RepositoryAttributes.properties["lastUpdateTime"] + - $.definitions.RepositoryAttributes.properties["manifestCount"] + - $.definitions.RepositoryAttributes.properties["tagCount"] + - $.definitions.TagAttributes.properties["registry"] + - $.definitions.TagAttributes.properties["imageName"] + - $.definitions.TagAttributes.properties["tag"] + - $.definitions.TagAttributesBase.properties["name"] + - $.definitions.TagAttributesBase.properties["digest"] + - $.definitions.TagAttributesBase.properties["createdTime"] + - $.definitions.TagAttributesBase.properties["lastUpdateTime"] + - $.definitions.ManifestAttributes_manifest_references.properties["digest"] + - $.definitions.ManifestAttributesBase.properties["digest"] + - $.definitions.ManifestAttributesBase.properties["createdTime"] + - $.definitions.ManifestAttributesBase.properties["lastUpdateTime"] + - $.definitions.ManifestAttributes.properties["manifest"] +``` diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/containerregistry.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/containerregistry.json new file mode 100644 index 000000000000..fe45fa370537 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/containerregistry.json @@ -0,0 +1,5953 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01-preview", + "title": "ContainerRegistryManagementClient" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/connectedRegistries/{connectedRegistryName}": { + "get": { + "tags": [ + "ConnectedRegistries" + ], + "description": "Gets the properties of the connected registry.", + "operationId": "ConnectedRegistries_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ConnectedRegistryNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ConnectedRegistry" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource does not exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConnectedRegistryGet": { + "$ref": "./examples/ConnectedRegistryGet.json" + } + } + }, + "put": { + "tags": [ + "ConnectedRegistries" + ], + "description": "Creates a connected registry for a container registry with the specified parameters.", + "operationId": "ConnectedRegistries_Create", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ConnectedRegistryNameParameter" + }, + { + "name": "connectedRegistryCreateParameters", + "in": "body", + "description": "The parameters for creating a connectedRegistry.", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectedRegistry" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ConnectedRegistry" + } + }, + "201": { + "description": "The request was successful; the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ConnectedRegistry" + } + }, + "default": { + "description": "Error response describing why the operation failed. If any of the input parameters are invalid, 400 (Bad Request) is returned. If the request cannot be processed due to a conflict in the request, 409 (Conflict) is returned.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConnectedRegistryCreate": { + "$ref": "./examples/ConnectedRegistryCreate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "ConnectedRegistries" + ], + "description": "Deletes a connected registry from a container registry.", + "operationId": "ConnectedRegistries_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ConnectedRegistryNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "The request was successful; the operation will complete asynchronously." + }, + "204": { + "description": "The webhook does not exist in the subscription." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConnectedRegistryDelete": { + "$ref": "./examples/ConnectedRegistryDelete.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "ConnectedRegistries" + ], + "description": "Updates a connected registry with the specified parameters.", + "operationId": "ConnectedRegistries_Update", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ConnectedRegistryNameParameter" + }, + { + "name": "connectedRegistryUpdateParameters", + "in": "body", + "description": "The parameters for updating a connectedRegistry.", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectedRegistryUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ConnectedRegistry" + } + }, + "201": { + "description": "The request was successful; the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ConnectedRegistry" + } + }, + "default": { + "description": "Error response describing why the operation failed. If any of the input parameters are invalid, 400 (Bad Request) is returned. If the request cannot be processed due to a conflict in the request, 409 (Conflict) is returned.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConnectedRegistryUpdate": { + "$ref": "./examples/ConnectedRegistryUpdate.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/connectedRegistries": { + "get": { + "tags": [ + "ConnectedRegistries" + ], + "description": "Lists all connected registries for the specified container registry.", + "operationId": "ConnectedRegistries_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ConnectedRegistryFilterParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ConnectedRegistryListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConnectedRegistryList": { + "$ref": "./examples/ConnectedRegistryList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/connectedRegistries/{connectedRegistryName}/deactivate": { + "post": { + "tags": [ + "ConnectedRegistries" + ], + "description": "Deactivates the connected registry instance.", + "operationId": "ConnectedRegistries_Deactivate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ConnectedRegistryNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "The request was successful; the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConnectedRegistryDeactivate": { + "$ref": "./examples/ConnectedRegistryDeactivate.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/exportPipelines/{exportPipelineName}": { + "get": { + "tags": [ + "ExportPipelines" + ], + "description": "Gets the properties of the export pipeline.", + "operationId": "ExportPipelines_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ExportPipelineNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ExportPipeline" + } + } + }, + "x-ms-examples": { + "ExportPipelineGet": { + "$ref": "./examples/ExportPipelineGet.json" + } + } + }, + "put": { + "tags": [ + "ExportPipelines" + ], + "description": "Creates an export pipeline for a container registry with the specified parameters.", + "operationId": "ExportPipelines_Create", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ExportPipelineNameParameter" + }, + { + "name": "exportPipelineCreateParameters", + "in": "body", + "description": "The parameters for creating an export pipeline.", + "required": true, + "schema": { + "$ref": "#/definitions/ExportPipeline" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the operation has completed successfully.", + "schema": { + "$ref": "#/definitions/ExportPipeline" + } + }, + "201": { + "description": "The request was successful; the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ExportPipeline" + } + } + }, + "x-ms-examples": { + "ExportPipelineCreate": { + "$ref": "./examples/ExportPipelineCreate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "ExportPipelines" + ], + "description": "Deletes an export pipeline from a container registry.", + "operationId": "ExportPipelines_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ExportPipelineNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "The request was successful; the operation will complete asynchronously." + }, + "204": { + "description": "The export pipeline does not exist in the subscription." + } + }, + "x-ms-examples": { + "ExportPipelineDelete": { + "$ref": "./examples/ExportPipelineDelete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/exportPipelines": { + "get": { + "tags": [ + "ExportPipelines" + ], + "description": "Lists all export pipelines for the specified container registry.", + "operationId": "ExportPipelines_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ExportPipelineListResult" + } + } + }, + "x-ms-examples": { + "ExportPipelineList": { + "$ref": "./examples/ExportPipelineList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/importImage": { + "post": { + "tags": [ + "Registries" + ], + "description": "Copies an image to this container registry from the specified container registry.", + "operationId": "Registries_ImportImage", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The parameters specifying the image to copy and the source container registry.", + "required": true, + "schema": { + "$ref": "#/definitions/ImportImageParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the operation has completed successfully." + }, + "202": { + "description": "The request was successful; the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "ImportImageByTag": { + "$ref": "./examples/ImportImageByTag.json" + }, + "ImportImageByManifestDigest": { + "$ref": "./examples/ImportImageByManifestDigest.json" + }, + "ImportImageFromPublicRegistry": { + "$ref": "./examples/ImportImageFromPublicRegistry.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/importPipelines/{importPipelineName}": { + "get": { + "tags": [ + "ImportPipelines" + ], + "description": "Gets the properties of the import pipeline.", + "operationId": "ImportPipelines_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ImportPipelineNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ImportPipeline" + } + } + }, + "x-ms-examples": { + "ImportPipelineGet": { + "$ref": "./examples/ImportPipelineGet.json" + } + } + }, + "put": { + "tags": [ + "ImportPipelines" + ], + "description": "Creates an import pipeline for a container registry with the specified parameters.", + "operationId": "ImportPipelines_Create", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ImportPipelineNameParameter" + }, + { + "name": "importPipelineCreateParameters", + "in": "body", + "description": "The parameters for creating an import pipeline.", + "required": true, + "schema": { + "$ref": "#/definitions/ImportPipeline" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the operation has completed successfully.", + "schema": { + "$ref": "#/definitions/ImportPipeline" + } + }, + "201": { + "description": "The request was successful; the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ImportPipeline" + } + } + }, + "x-ms-examples": { + "ImportPipelineCreate": { + "$ref": "./examples/ImportPipelineCreate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "ImportPipelines" + ], + "description": "Deletes an import pipeline from a container registry.", + "operationId": "ImportPipelines_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ImportPipelineNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "The request was successful; the operation will complete asynchronously." + }, + "204": { + "description": "The import pipeline does not exist in the subscription." + } + }, + "x-ms-examples": { + "ImportPipelineDelete": { + "$ref": "./examples/ImportPipelineDelete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/importPipelines": { + "get": { + "tags": [ + "ImportPipelines" + ], + "description": "Lists all import pipelines for the specified container registry.", + "operationId": "ImportPipelines_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ImportPipelineListResult" + } + } + }, + "x-ms-examples": { + "ImportPipelineList": { + "$ref": "./examples/ImportPipelineList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerRegistry/checkNameAvailability": { + "post": { + "tags": [ + "Operation" + ], + "description": "Checks whether the container registry name is available for use. The name must contain only alphanumeric characters, be globally unique, and between 5 and 50 characters in length.", + "operationId": "Registries_CheckNameAvailability", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "registryNameCheckRequest", + "in": "body", + "description": "The object containing information for the availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/RegistryNameCheckRequest" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/RegistryNameStatus" + } + } + }, + "x-ms-examples": { + "RegistryCheckNameAvailable": { + "$ref": "./examples/RegistryCheckNameAvailable.json" + }, + "RegistryCheckNameNotAvailable": { + "$ref": "./examples/RegistryCheckNameNotAvailable.json" + } + } + } + }, + "/providers/Microsoft.ContainerRegistry/operations": { + "get": { + "tags": [ + "Operation" + ], + "description": "Lists all of the available Azure Container Registry REST API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + } + }, + "x-ms-examples": { + "OperationList": { + "$ref": "./examples/OperationList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/pipelineRuns/{pipelineRunName}": { + "get": { + "tags": [ + "PipelineRuns" + ], + "description": "Gets the detailed information for a given pipeline run.", + "operationId": "PipelineRuns_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/PipelineRunNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well - formed and received properly.", + "schema": { + "$ref": "#/definitions/PipelineRun" + } + } + }, + "x-ms-examples": { + "PipelineRunGet": { + "$ref": "./examples/PipelineRunGet.json" + } + } + }, + "put": { + "tags": [ + "PipelineRuns" + ], + "description": "Creates a pipeline run for a container registry with the specified parameters", + "operationId": "PipelineRuns_Create", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/PipelineRunNameParameter" + }, + { + "name": "pipelineRunCreateParameters", + "in": "body", + "description": "The parameters for creating a pipeline run.", + "required": true, + "schema": { + "$ref": "#/definitions/PipelineRun" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well - formed and received properly.", + "schema": { + "$ref": "#/definitions/PipelineRun" + } + }, + "201": { + "description": "The request was successful; the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/PipelineRun" + } + } + }, + "x-ms-examples": { + "PipelineRunCreate_Export": { + "$ref": "./examples/PipelineRunCreate_Export.json" + }, + "PipelineRunCreate_Import": { + "$ref": "./examples/PipelineRunCreate_Import.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "PipelineRuns" + ], + "description": "Deletes a pipeline run from a container registry.", + "operationId": "PipelineRuns_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/PipelineRunNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "The request was successful; the operation will complete asynchronously." + }, + "204": { + "description": "The pipeline run does not exist in the subscription." + } + }, + "x-ms-examples": { + "PipelineRunDelete": { + "$ref": "./examples/PipelineRunDelete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/pipelineRuns": { + "get": { + "tags": [ + "PipelineRuns" + ], + "description": "Lists all the pipeline runs for the specified container registry.", + "operationId": "PipelineRuns_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well - formed and received properly.", + "schema": { + "$ref": "#/definitions/PipelineRunListResult" + } + } + }, + "x-ms-examples": { + "PipelineRunList": { + "$ref": "./examples/PipelineRunList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Get the specified private endpoint connection associated with the container registry.", + "operationId": "PrivateEndpointConnections_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnectionGet": { + "$ref": "./examples/PrivateEndpointConnectionGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Update the state of specified private endpoint connection associated with the container registry.", + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "name": "privateEndpointConnection", + "in": "body", + "description": "The parameters for creating a private endpoint connection.", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "The request was successful; the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnectionCreateOrUpdate": { + "$ref": "./examples/PrivateEndpointConnectionCreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Deletes the specified private endpoint connection associated with the container registry.", + "operationId": "PrivateEndpointConnections_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "The request was successful; the operation will complete asynchronously." + }, + "204": { + "description": "The private endpoint connection does not exist in the subscription." + } + }, + "x-ms-examples": { + "PrivateEndpointConnectionDelete": { + "$ref": "./examples/PrivateEndpointConnectionDelete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "List all private endpoint connections in a container registry.", + "operationId": "PrivateEndpointConnections_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnectionList": { + "$ref": "./examples/PrivateEndpointConnectionList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}": { + "get": { + "tags": [ + "Registries" + ], + "description": "Gets the properties of the specified container registry.", + "operationId": "Registries_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Registry" + } + } + }, + "x-ms-examples": { + "RegistryGet": { + "$ref": "./examples/RegistryGet.json" + } + } + }, + "put": { + "tags": [ + "Registries" + ], + "description": "Creates a container registry with the specified parameters.", + "operationId": "Registries_Create", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "name": "registry", + "in": "body", + "description": "The parameters for creating a container registry.", + "required": true, + "schema": { + "$ref": "#/definitions/Registry" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Registry" + } + }, + "201": { + "description": "The request was successful; the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Registry" + } + } + }, + "x-ms-examples": { + "RegistryCreate": { + "$ref": "./examples/RegistryCreate.json" + }, + "RegistryCreateZoneRedundant": { + "$ref": "./examples/RegistryCreateZoneRedundant.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Registries" + ], + "description": "Deletes a container registry.", + "operationId": "Registries_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "The request was successful; the operation will complete asynchronously." + }, + "204": { + "description": "The container registry does not exist in the subscription." + } + }, + "x-ms-examples": { + "RegistryDelete": { + "$ref": "./examples/RegistryDelete.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Registries" + ], + "description": "Updates a container registry with the specified parameters.", + "operationId": "Registries_Update", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "name": "registryUpdateParameters", + "in": "body", + "description": "The parameters for updating a container registry.", + "required": true, + "schema": { + "$ref": "#/definitions/RegistryUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Registry" + } + }, + "201": { + "description": "The request was successful; the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Registry" + } + } + }, + "x-ms-examples": { + "RegistryUpdate": { + "$ref": "./examples/RegistryUpdate.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries": { + "get": { + "tags": [ + "Registries" + ], + "description": "Lists all the container registries under the specified resource group.", + "operationId": "Registries_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/RegistryListResult" + } + } + }, + "x-ms-examples": { + "RegistryListByResourceGroup": { + "$ref": "./examples/RegistryListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerRegistry/registries": { + "get": { + "tags": [ + "Registries" + ], + "description": "Lists all the container registries under the specified subscription.", + "operationId": "Registries_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/RegistryListResult" + } + } + }, + "x-ms-examples": { + "RegistryList": { + "$ref": "./examples/RegistryList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/listCredentials": { + "post": { + "tags": [ + "Registries" + ], + "description": "Lists the login credentials for the specified container registry.", + "operationId": "Registries_ListCredentials", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the list of credentials retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/RegistryListCredentialsResult" + } + } + }, + "x-ms-examples": { + "RegistryListCredentials": { + "$ref": "./examples/RegistryListCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/regenerateCredential": { + "post": { + "tags": [ + "Registries" + ], + "description": "Regenerates one of the login credentials for the specified container registry.", + "operationId": "Registries_RegenerateCredential", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "name": "regenerateCredentialParameters", + "in": "body", + "description": "Specifies name of the password which should be regenerated -- password or password2.", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateCredentialParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the specified credential regenerated successfully.", + "schema": { + "$ref": "#/definitions/RegistryListCredentialsResult" + } + } + }, + "x-ms-examples": { + "RegistryRegenerateCredential": { + "$ref": "./examples/RegistryRegenerateCredential.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/listUsages": { + "get": { + "tags": [ + "Registries" + ], + "description": "Gets the quota usages for the specified container registry.", + "operationId": "Registries_ListUsages", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the registry usages retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/RegistryUsageListResult" + } + } + }, + "x-ms-examples": { + "RegistryListUsages": { + "$ref": "./examples/RegistryListUsages.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateLinkResources": { + "get": { + "tags": [ + "Registries" + ], + "description": "Lists the private link resources for a container registry.", + "operationId": "Registries_ListPrivateLinkResources", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the private link resources were retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + } + }, + "x-ms-examples": { + "RegistryListPrivateLinkResources": { + "$ref": "./examples/RegistryListPrivateLinkResources.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/replications/{replicationName}": { + "get": { + "tags": [ + "Replications" + ], + "description": "Gets the properties of the specified replication.", + "operationId": "Replications_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ReplicationNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Replication" + } + } + }, + "x-ms-examples": { + "ReplicationGet": { + "$ref": "./examples/ReplicationGet.json" + } + } + }, + "put": { + "tags": [ + "Replications" + ], + "description": "Creates a replication for a container registry with the specified parameters.", + "operationId": "Replications_Create", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ReplicationNameParameter" + }, + { + "name": "replication", + "in": "body", + "description": "The parameters for creating a replication.", + "required": true, + "schema": { + "$ref": "#/definitions/Replication" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Replication" + } + }, + "201": { + "description": "The request was successful; the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Replication" + } + } + }, + "x-ms-examples": { + "ReplicationCreate": { + "$ref": "./examples/ReplicationCreate.json" + }, + "ReplicationCreateZoneRedundant": { + "$ref": "./examples/ReplicationCreateZoneRedundant.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Replications" + ], + "description": "Deletes a replication from a container registry.", + "operationId": "Replications_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ReplicationNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "The request was successful; the operation will complete asynchronously." + }, + "204": { + "description": "The replication does not exist in the subscription." + } + }, + "x-ms-examples": { + "ReplicationDelete": { + "$ref": "./examples/ReplicationDelete.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Replications" + ], + "description": "Updates a replication for a container registry with the specified parameters.", + "operationId": "Replications_Update", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ReplicationNameParameter" + }, + { + "name": "replicationUpdateParameters", + "in": "body", + "description": "The parameters for updating a replication.", + "required": true, + "schema": { + "$ref": "#/definitions/ReplicationUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Replication" + } + }, + "201": { + "description": "The request was successful; the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Replication" + } + } + }, + "x-ms-examples": { + "ReplicationUpdate": { + "$ref": "./examples/ReplicationUpdate.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/replications": { + "get": { + "tags": [ + "Replications" + ], + "description": "Lists all the replications for the specified container registry.", + "operationId": "Replications_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ReplicationListResult" + } + } + }, + "x-ms-examples": { + "ReplicationList": { + "$ref": "./examples/ReplicationList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps/{scopeMapName}": { + "get": { + "tags": [ + "ScopeMaps" + ], + "description": "Gets the properties of the specified scope map.", + "operationId": "ScopeMaps_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ScopeMapNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ScopeMap" + } + } + }, + "x-ms-examples": { + "ScopeMapGet": { + "$ref": "./examples/ScopeMapGet.json" + } + } + }, + "put": { + "tags": [ + "ScopeMaps" + ], + "description": "Creates a scope map for a container registry with the specified parameters.", + "operationId": "ScopeMaps_Create", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ScopeMapNameParameter" + }, + { + "name": "scopeMapCreateParameters", + "in": "body", + "description": "The parameters for creating a scope map.", + "required": true, + "schema": { + "$ref": "#/definitions/ScopeMap" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ScopeMap" + } + }, + "201": { + "description": "The request was successful; the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ScopeMap" + } + } + }, + "x-ms-examples": { + "ScopeMapCreate": { + "$ref": "./examples/ScopeMapCreate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "ScopeMaps" + ], + "description": "Deletes a scope map from a container registry.", + "operationId": "ScopeMaps_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ScopeMapNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "The request was successful; the operation will complete asynchronously." + }, + "204": { + "description": "The scopemap does not exist in the subscription." + } + }, + "x-ms-examples": { + "ScopeMapDelete": { + "$ref": "./examples/ScopeMapDelete.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "ScopeMaps" + ], + "description": "Updates a scope map with the specified parameters.", + "operationId": "ScopeMaps_Update", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ScopeMapNameParameter" + }, + { + "name": "scopeMapUpdateParameters", + "in": "body", + "description": "The parameters for updating a scope map.", + "required": true, + "schema": { + "$ref": "#/definitions/ScopeMapUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ScopeMap" + } + }, + "201": { + "description": "The request was successful; the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ScopeMap" + } + } + }, + "x-ms-examples": { + "ScopeMapUpdate": { + "$ref": "./examples/ScopeMapUpdate.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps": { + "get": { + "tags": [ + "ScopeMaps" + ], + "description": "Lists all the scope maps for the specified container registry.", + "operationId": "ScopeMaps_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ScopeMapListResult" + } + } + }, + "x-ms-examples": { + "ScopeMapList": { + "$ref": "./examples/ScopeMapList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens/{tokenName}": { + "get": { + "tags": [ + "Tokens" + ], + "description": "Gets the properties of the specified token.", + "operationId": "Tokens_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/TokenNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Token" + } + } + }, + "x-ms-examples": { + "TokenGet": { + "$ref": "./examples/TokenGet.json" + } + } + }, + "put": { + "tags": [ + "Tokens" + ], + "description": "Creates a token for a container registry with the specified parameters.", + "operationId": "Tokens_Create", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/TokenNameParameter" + }, + { + "name": "tokenCreateParameters", + "in": "body", + "description": "The parameters for creating a token.", + "required": true, + "schema": { + "$ref": "#/definitions/Token" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Token" + } + }, + "201": { + "description": "The request was successful; the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Token" + } + } + }, + "x-ms-examples": { + "TokenCreate": { + "$ref": "./examples/TokenCreate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Tokens" + ], + "description": "Deletes a token from a container registry.", + "operationId": "Tokens_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/TokenNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "The request was successful; the operation will complete asynchronously." + }, + "204": { + "description": "The token does not exist in the subscription." + } + }, + "x-ms-examples": { + "TokenDelete": { + "$ref": "./examples/TokenDelete.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Tokens" + ], + "description": "Updates a token with the specified parameters.", + "operationId": "Tokens_Update", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/TokenNameParameter" + }, + { + "name": "tokenUpdateParameters", + "in": "body", + "description": "The parameters for updating a token.", + "required": true, + "schema": { + "$ref": "#/definitions/TokenUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Token" + } + }, + "201": { + "description": "The request was successful; the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Token" + } + } + }, + "x-ms-examples": { + "TokenUpdate": { + "$ref": "./examples/TokenUpdate.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens": { + "get": { + "tags": [ + "Tokens" + ], + "description": "Lists all the tokens for the specified container registry.", + "operationId": "Tokens_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/TokenListResult" + } + } + }, + "x-ms-examples": { + "TokenList": { + "$ref": "./examples/TokenList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/generateCredentials": { + "post": { + "tags": [ + "Registries" + ], + "description": "Generate keys for a token of a specified container registry.", + "operationId": "Registries_GenerateCredentials", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "name": "generateCredentialsParameters", + "in": "body", + "description": "The parameters for generating credentials.", + "required": true, + "schema": { + "$ref": "#/definitions/GenerateCredentialsParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/GenerateCredentialsResult" + } + }, + "202": { + "description": "The request was successful; the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "RegistryGenerateCredentials": { + "$ref": "./examples/RegistryGenerateCredentials.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}": { + "get": { + "tags": [ + "Webhooks" + ], + "description": "Gets the properties of the specified webhook.", + "operationId": "Webhooks_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/WebhookNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Webhook" + } + } + }, + "x-ms-examples": { + "WebhookGet": { + "$ref": "./examples/WebhookGet.json" + } + } + }, + "put": { + "tags": [ + "Webhooks" + ], + "description": "Creates a webhook for a container registry with the specified parameters.", + "operationId": "Webhooks_Create", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/WebhookNameParameter" + }, + { + "name": "webhookCreateParameters", + "in": "body", + "description": "The parameters for creating a webhook.", + "required": true, + "schema": { + "$ref": "#/definitions/WebhookCreateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Webhook" + } + }, + "201": { + "description": "The request was successful; the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Webhook" + } + } + }, + "x-ms-examples": { + "WebhookCreate": { + "$ref": "./examples/WebhookCreate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Webhooks" + ], + "description": "Deletes a webhook from a container registry.", + "operationId": "Webhooks_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/WebhookNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "The request was successful; the operation will complete asynchronously." + }, + "204": { + "description": "The webhook does not exist in the subscription." + } + }, + "x-ms-examples": { + "WebhookDelete": { + "$ref": "./examples/WebhookDelete.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Webhooks" + ], + "description": "Updates a webhook with the specified parameters.", + "operationId": "Webhooks_Update", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/WebhookNameParameter" + }, + { + "name": "webhookUpdateParameters", + "in": "body", + "description": "The parameters for updating a webhook.", + "required": true, + "schema": { + "$ref": "#/definitions/WebhookUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Webhook" + } + }, + "201": { + "description": "The request was successful; the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Webhook" + } + } + }, + "x-ms-examples": { + "WebhookUpdate": { + "$ref": "./examples/WebhookUpdate.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks": { + "get": { + "tags": [ + "Webhooks" + ], + "description": "Lists all the webhooks for the specified container registry.", + "operationId": "Webhooks_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WebhookListResult" + } + } + }, + "x-ms-examples": { + "WebhookList": { + "$ref": "./examples/WebhookList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}/ping": { + "post": { + "tags": [ + "Webhooks" + ], + "description": "Triggers a ping event to be sent to the webhook.", + "operationId": "Webhooks_Ping", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/WebhookNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/EventInfo" + } + } + }, + "x-ms-examples": { + "WebhookPing": { + "$ref": "./examples/WebhookPing.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}/getCallbackConfig": { + "post": { + "tags": [ + "Webhooks" + ], + "description": "Gets the configuration of service URI and custom headers for the webhook.", + "operationId": "Webhooks_GetCallbackConfig", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/WebhookNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/CallbackConfig" + } + } + }, + "x-ms-examples": { + "WebhookGetCallbackConfig": { + "$ref": "./examples/WebhookGetCallbackConfig.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}/listEvents": { + "post": { + "tags": [ + "Webhooks" + ], + "description": "Lists recent events for the specified webhook.", + "operationId": "Webhooks_ListEvents", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/WebhookNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/EventListResult" + } + } + }, + "x-ms-examples": { + "WebhookListEvents": { + "$ref": "./examples/WebhookListEvents.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ConnectedRegistry": { + "description": "An object that represents a connected registry for a container registry.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ConnectedRegistryProperties", + "description": "The properties of the connected registry.", + "x-ms-client-flatten": true + } + } + }, + "ProxyResource": { + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags.", + "properties": { + "id": { + "description": "The resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "systemData": { + "$ref": "#/definitions/SystemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "ConnectedRegistryProperties": { + "description": "The properties of a connected registry.", + "required": [ + "mode", + "parent" + ], + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the resource.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "mode": { + "description": "The mode of the connected registry resource that indicates the permissions of the registry.", + "enum": [ + "Registry", + "Mirror" + ], + "type": "string", + "x-ms-enum": { + "name": "ConnectedRegistryMode", + "modelAsString": true + } + }, + "version": { + "description": "The current version of ACR runtime on the connected registry.", + "type": "string", + "readOnly": true + }, + "connectionState": { + "description": "The current connection state of the connected registry.", + "enum": [ + "Online", + "Offline", + "Syncing", + "Unhealthy" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ConnectionState", + "modelAsString": true + } + }, + "lastActivityTime": { + "format": "date-time", + "description": "The last activity time of the connected registry.", + "type": "string", + "readOnly": true + }, + "activation": { + "$ref": "#/definitions/ActivationProperties", + "description": "The activation properties of the connected registry.", + "readOnly": true + }, + "parent": { + "$ref": "#/definitions/ParentProperties", + "description": "The parent of the connected registry." + }, + "clientTokenIds": { + "description": "The list of the ACR token resource IDs used to authenticate clients to the connected registry.", + "type": "array", + "items": { + "type": "string" + } + }, + "loginServer": { + "$ref": "#/definitions/LoginServerProperties", + "description": "The login server properties of the connected registry." + }, + "logging": { + "$ref": "#/definitions/LoggingProperties", + "description": "The logging properties of the connected registry." + }, + "statusDetails": { + "description": "The list of current statuses of the connected registry.", + "type": "array", + "items": { + "$ref": "#/definitions/StatusDetailProperties" + }, + "readOnly": true + } + } + }, + "ActivationProperties": { + "description": "The activation properties of the connected registry.", + "type": "object", + "properties": { + "status": { + "description": "The activation status of the connected registry.", + "enum": [ + "Active", + "Inactive" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ActivationStatus", + "modelAsString": true + } + } + } + }, + "ParentProperties": { + "description": "The properties of the connected registry parent.", + "required": [ + "syncProperties" + ], + "type": "object", + "properties": { + "id": { + "description": "The resource ID of the parent to which the connected registry will be associated.", + "type": "string" + }, + "syncProperties": { + "$ref": "#/definitions/SyncProperties", + "description": "The sync properties of the connected registry with its parent." + } + } + }, + "LoginServerProperties": { + "description": "The login server properties of the connected registry.", + "type": "object", + "properties": { + "host": { + "description": "The host of the connected registry. Can be FQDN or IP.", + "type": "string", + "readOnly": true + }, + "tls": { + "$ref": "#/definitions/TlsProperties", + "description": "The TLS properties of the connected registry login server.", + "readOnly": true + } + } + }, + "LoggingProperties": { + "description": "The logging properties of the connected registry.", + "type": "object", + "properties": { + "logLevel": { + "description": "The verbosity of logs persisted on the connected registry.", + "default": "Information", + "enum": [ + "Debug", + "Information", + "Warning", + "Error", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "LogLevel", + "modelAsString": true + } + }, + "auditLogStatus": { + "description": "Indicates whether audit logs are enabled on the connected registry.", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AuditLogStatus", + "modelAsString": true + } + } + } + }, + "StatusDetailProperties": { + "description": "The status detail properties of the connected registry.", + "type": "object", + "properties": { + "type": { + "description": "The component of the connected registry corresponding to the status.", + "type": "string", + "readOnly": true + }, + "code": { + "description": "The code of the status.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The description of the status.", + "type": "string", + "readOnly": true + }, + "timestamp": { + "format": "date-time", + "description": "The timestamp of the status.", + "type": "string", + "readOnly": true + }, + "correlationId": { + "description": "The correlation ID of the status.", + "type": "string", + "readOnly": true + } + } + }, + "SyncProperties": { + "description": "The sync properties of the connected registry with its parent.", + "required": [ + "tokenId", + "messageTtl" + ], + "type": "object", + "properties": { + "tokenId": { + "description": "The resource ID of the ACR token used to authenticate the connected registry to its parent during sync.", + "type": "string" + }, + "schedule": { + "description": "The cron expression indicating the schedule that the connected registry will sync with its parent.", + "type": "string" + }, + "syncWindow": { + "format": "duration", + "description": "The time window during which sync is enabled for each schedule occurrence. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601.", + "type": "string" + }, + "messageTtl": { + "format": "duration", + "description": "The period of time for which a message is available to sync before it is expired. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601.", + "type": "string" + }, + "lastSyncTime": { + "format": "date-time", + "description": "The last time a sync occurred between the connected registry and its parent.", + "type": "string", + "readOnly": true + }, + "gatewayEndpoint": { + "description": "The gateway endpoint used by the connected registry to communicate with its parent.", + "type": "string", + "readOnly": true + } + } + }, + "TlsProperties": { + "description": "The TLS properties of the connected registry login server.", + "type": "object", + "properties": { + "status": { + "description": "Indicates whether HTTPS is enabled for the login server.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "TlsStatus", + "modelAsString": true + } + }, + "certificate": { + "$ref": "#/definitions/TlsCertificateProperties", + "description": "The certificate used to configure HTTPS for the login server.", + "readOnly": true + } + } + }, + "TlsCertificateProperties": { + "description": "The TLS certificate properties of the connected registry login server.", + "type": "object", + "properties": { + "type": { + "description": "The type of certificate location.", + "enum": [ + "LocalDirectory" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "CertificateType", + "modelAsString": true + } + }, + "location": { + "description": "Indicates the location of the certificates.", + "type": "string", + "readOnly": true + } + } + }, + "ConnectedRegistryUpdateParameters": { + "description": "The parameters for updating a connected registry.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ConnectedRegistryUpdateProperties", + "description": "The properties of the connected registry update parameters.", + "x-ms-client-flatten": true + } + } + }, + "ConnectedRegistryUpdateProperties": { + "description": "The parameters for updating token properties.", + "type": "object", + "properties": { + "syncProperties": { + "$ref": "#/definitions/SyncUpdateProperties", + "description": "The sync properties of the connected registry with its parent." + }, + "logging": { + "$ref": "#/definitions/LoggingProperties", + "description": "The logging properties of the connected registry." + }, + "clientTokenIds": { + "description": "The list of the ACR token resource IDs used to authenticate clients to the connected registry.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SyncUpdateProperties": { + "description": "The parameters for updating the sync properties of the connected registry with its parent.", + "type": "object", + "properties": { + "schedule": { + "description": "The cron expression indicating the schedule that the connected registry will sync with its parent.", + "type": "string" + }, + "syncWindow": { + "format": "duration", + "description": "The time window during which sync is enabled for each schedule occurrence. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601.", + "type": "string" + }, + "messageTtl": { + "format": "duration", + "description": "The period of time for which a message is available to sync before it is expired. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601.", + "type": "string" + } + } + }, + "ConnectedRegistryListResult": { + "description": "The result of a request to list connected registries for a container registry.", + "type": "object", + "properties": { + "value": { + "description": "The list of connected registries. Since this list may be incomplete, the nextLink field should be used to request the next list of connected registries.", + "type": "array", + "items": { + "$ref": "#/definitions/ConnectedRegistry" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next list of connected registries.", + "type": "string" + } + } + }, + "ExportPipeline": { + "description": "An object that represents an export pipeline for a container registry.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "location": { + "description": "The location of the export pipeline.", + "type": "string" + }, + "identity": { + "$ref": "#/definitions/IdentityProperties", + "description": "The identity of the export pipeline." + }, + "properties": { + "$ref": "#/definitions/ExportPipelineProperties", + "description": "The properties of the export pipeline.", + "x-ms-client-flatten": true + } + } + }, + "IdentityProperties": { + "description": "Managed identity for the resource.", + "type": "object", + "properties": { + "principalId": { + "description": "The principal ID of resource identity.", + "type": "string" + }, + "tenantId": { + "description": "The tenant ID of resource.", + "type": "string" + }, + "type": { + "description": "The identity type.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "description": "The list of user identities associated with the resource. The user identity \r\ndictionary key references will be ARM resource ids in the form: \r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\r\n providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserIdentityProperties" + } + } + } + }, + "ExportPipelineProperties": { + "description": "The properties of an export pipeline.", + "required": [ + "target" + ], + "type": "object", + "properties": { + "target": { + "$ref": "#/definitions/ExportPipelineTargetProperties", + "description": "The target properties of the export pipeline." + }, + "options": { + "description": "The list of all options configured for the pipeline.", + "type": "array", + "items": { + "enum": [ + "OverwriteTags", + "OverwriteBlobs", + "DeleteSourceBlobOnSuccess", + "ContinueOnErrors" + ], + "type": "string", + "x-ms-enum": { + "name": "PipelineOptions", + "modelAsString": true + } + } + }, + "provisioningState": { + "description": "The provisioning state of the pipeline at the time the operation was called.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + } + } + }, + "UserIdentityProperties": { + "type": "object", + "properties": { + "principalId": { + "description": "The principal id of user assigned identity.", + "type": "string" + }, + "clientId": { + "description": "The client id of user assigned identity.", + "type": "string" + } + } + }, + "ExportPipelineTargetProperties": { + "description": "The properties of the export pipeline target.", + "required": [ + "keyVaultUri" + ], + "type": "object", + "properties": { + "type": { + "description": "The type of target for the export pipeline.", + "type": "string" + }, + "uri": { + "description": "The target uri of the export pipeline.\r\nWhen 'AzureStorageBlob': \"https://accountName.blob.core.windows.net/containerName/blobName\"\r\nWhen 'AzureStorageBlobContainer': \"https://accountName.blob.core.windows.net/containerName\"", + "type": "string" + }, + "keyVaultUri": { + "description": "They key vault secret uri to obtain the target storage SAS token.", + "type": "string" + } + } + }, + "ExportPipelineListResult": { + "description": "The result of a request to list export pipelines for a container registry.", + "type": "object", + "properties": { + "value": { + "description": "The list of export pipelines. Since this list may be incomplete, the nextLink field should be used to request the next list of export pipelines.", + "type": "array", + "items": { + "$ref": "#/definitions/ExportPipeline" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next list of pipeline runs.", + "type": "string" + } + } + }, + "ImportImageParameters": { + "required": [ + "source" + ], + "type": "object", + "properties": { + "source": { + "$ref": "#/definitions/ImportSource", + "description": "The source of the image." + }, + "targetTags": { + "description": "List of strings of the form repo[:tag]. When tag is omitted the source will be used (or 'latest' if source tag is also omitted).", + "type": "array", + "items": { + "type": "string" + } + }, + "untaggedTargetRepositories": { + "description": "List of strings of repository names to do a manifest only copy. No tag will be created.", + "type": "array", + "items": { + "type": "string" + } + }, + "mode": { + "description": "When Force, any existing target tags will be overwritten. When NoForce, any existing target tags will fail the operation before any copying begins.", + "default": "NoForce", + "enum": [ + "NoForce", + "Force" + ], + "type": "string", + "x-ms-enum": { + "name": "ImportMode", + "modelAsString": true + } + } + } + }, + "ImportSource": { + "required": [ + "sourceImage" + ], + "type": "object", + "properties": { + "resourceId": { + "description": "The resource identifier of the source Azure Container Registry.", + "type": "string" + }, + "registryUri": { + "description": "The address of the source registry (e.g. 'mcr.microsoft.com').", + "type": "string" + }, + "credentials": { + "$ref": "#/definitions/ImportSourceCredentials", + "description": "Credentials used when importing from a registry uri." + }, + "sourceImage": { + "description": "Repository name of the source image.\r\nSpecify an image by repository ('hello-world'). This will use the 'latest' tag.\r\nSpecify an image by tag ('hello-world:latest').\r\nSpecify an image by sha256-based manifest digest ('hello-world@sha256:abc123').", + "type": "string" + } + } + }, + "ImportSourceCredentials": { + "required": [ + "password" + ], + "type": "object", + "properties": { + "username": { + "description": "The username to authenticate with the source registry.", + "type": "string" + }, + "password": { + "description": "The password used to authenticate with the source registry.", + "type": "string" + } + } + }, + "ImportPipeline": { + "description": "An object that represents an import pipeline for a container registry.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "location": { + "description": "The location of the import pipeline.", + "type": "string" + }, + "identity": { + "$ref": "#/definitions/IdentityProperties", + "description": "The identity of the import pipeline." + }, + "properties": { + "$ref": "#/definitions/ImportPipelineProperties", + "description": "The properties of the import pipeline.", + "x-ms-client-flatten": true + } + } + }, + "ImportPipelineProperties": { + "description": "The properties of an import pipeline.", + "required": [ + "source" + ], + "type": "object", + "properties": { + "source": { + "$ref": "#/definitions/ImportPipelineSourceProperties", + "description": "The source properties of the import pipeline." + }, + "trigger": { + "$ref": "#/definitions/PipelineTriggerProperties", + "description": "The properties that describe the trigger of the import pipeline." + }, + "options": { + "description": "The list of all options configured for the pipeline.", + "type": "array", + "items": { + "enum": [ + "OverwriteTags", + "OverwriteBlobs", + "DeleteSourceBlobOnSuccess", + "ContinueOnErrors" + ], + "type": "string", + "x-ms-enum": { + "name": "PipelineOptions", + "modelAsString": true + } + } + }, + "provisioningState": { + "description": "The provisioning state of the pipeline at the time the operation was called.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + } + } + }, + "ImportPipelineSourceProperties": { + "description": "The properties of the import pipeline source.", + "required": [ + "keyVaultUri" + ], + "type": "object", + "properties": { + "type": { + "description": "The type of source for the import pipeline.", + "default": "AzureStorageBlobContainer", + "enum": [ + "AzureStorageBlobContainer" + ], + "type": "string", + "x-ms-enum": { + "name": "PipelineSourceType", + "modelAsString": true + } + }, + "uri": { + "description": "The source uri of the import pipeline.\r\nWhen 'AzureStorageBlob': \"https://accountName.blob.core.windows.net/containerName/blobName\"\r\nWhen 'AzureStorageBlobContainer': \"https://accountName.blob.core.windows.net/containerName\"", + "type": "string" + }, + "keyVaultUri": { + "description": "They key vault secret uri to obtain the source storage SAS token.", + "type": "string" + } + } + }, + "PipelineTriggerProperties": { + "type": "object", + "properties": { + "sourceTrigger": { + "$ref": "#/definitions/PipelineSourceTriggerProperties", + "description": "The source trigger properties of the pipeline." + } + } + }, + "PipelineSourceTriggerProperties": { + "required": [ + "status" + ], + "type": "object", + "properties": { + "status": { + "description": "The current status of the source trigger.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "TriggerStatus", + "modelAsString": true + } + } + } + }, + "ImportPipelineListResult": { + "description": "The result of a request to list import pipelines for a container registry.", + "type": "object", + "properties": { + "value": { + "description": "The list of import pipelines. Since this list may be incomplete, the nextLink field should be used to request the next list of import pipelines.", + "type": "array", + "items": { + "$ref": "#/definitions/ImportPipeline" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next list of pipeline runs.", + "type": "string" + } + } + }, + "RegistryNameCheckRequest": { + "description": "A request to check whether a container registry name is available.", + "required": [ + "name", + "type" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the container registry.", + "maxLength": 50, + "minLength": 5, + "pattern": "^[a-zA-Z0-9]*$", + "type": "string" + }, + "type": { + "description": "The resource type of the container registry. This field must be set to 'Microsoft.ContainerRegistry/registries'.", + "enum": [ + "Microsoft.ContainerRegistry/registries" + ], + "type": "string", + "x-ms-enum": { + "name": "ContainerRegistryResourceType", + "modelAsString": false + } + } + } + }, + "RegistryNameStatus": { + "description": "The result of a request to check the availability of a container registry name.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "The value that indicates whether the name is available.", + "type": "boolean" + }, + "reason": { + "description": "If any, the reason that the name is not available.", + "type": "string" + }, + "message": { + "description": "If any, the error message that provides more detail for the reason that the name is not available.", + "type": "string" + } + } + }, + "OperationListResult": { + "description": "The result of a request to list container registry operations.", + "type": "object", + "properties": { + "value": { + "description": "The list of container registry operations. Since this list may be incomplete, the nextLink field should be used to request the next list of operations.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationDefinition" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next list of container registry operations.", + "type": "string" + } + } + }, + "OperationDefinition": { + "description": "The definition of a container registry operation.", + "type": "object", + "properties": { + "origin": { + "description": "The origin information of the container registry operation.", + "type": "string" + }, + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplayDefinition", + "description": "The display information for the container registry operation." + }, + "properties": { + "$ref": "#/definitions/OperationPropertiesDefinition", + "description": "The properties information for the container registry operation.", + "x-ms-client-flatten": true + }, + "isDataAction": { + "description": "This property indicates if the operation is an action or a data action\r\nref: https://docs.microsoft.com/en-us/azure/role-based-access-control/role-definitions#management-and-data-operations", + "type": "boolean" + } + } + }, + "OperationDisplayDefinition": { + "description": "The display information for a container registry operation.", + "type": "object", + "properties": { + "provider": { + "description": "The resource provider name: Microsoft.ContainerRegistry.", + "type": "string" + }, + "resource": { + "description": "The resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "The operation that users can perform.", + "type": "string" + }, + "description": { + "description": "The description for the operation.", + "type": "string" + } + } + }, + "OperationPropertiesDefinition": { + "description": "The definition of Azure Monitoring properties.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/OperationServiceSpecificationDefinition", + "description": "The definition of Azure Monitoring service." + } + } + }, + "OperationServiceSpecificationDefinition": { + "description": "The definition of Azure Monitoring list.", + "type": "object", + "properties": { + "metricSpecifications": { + "description": "A list of Azure Monitoring metrics definition.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationMetricSpecificationDefinition" + } + }, + "logSpecifications": { + "description": "A list of Azure Monitoring log definitions.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationLogSpecificationDefinition" + } + } + } + }, + "OperationMetricSpecificationDefinition": { + "description": "The definition of Azure Monitoring metric.", + "type": "object", + "properties": { + "name": { + "description": "Metric name.", + "type": "string" + }, + "displayName": { + "description": "Metric display name.", + "type": "string" + }, + "displayDescription": { + "description": "Metric description.", + "type": "string" + }, + "unit": { + "description": "Metric unit.", + "type": "string" + }, + "aggregationType": { + "description": "Metric aggregation type.", + "type": "string" + }, + "internalMetricName": { + "description": "Internal metric name.", + "type": "string" + } + } + }, + "OperationLogSpecificationDefinition": { + "description": "The definition of Azure Monitoring log.", + "type": "object", + "properties": { + "name": { + "description": "Log name.", + "type": "string" + }, + "displayName": { + "description": "Log display name.", + "type": "string" + }, + "blobDuration": { + "description": "Log blob duration.", + "type": "string" + } + } + }, + "PipelineRun": { + "description": "An object that represents a pipeline run for a container registry.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PipelineRunProperties", + "description": "The properties of a pipeline run.", + "x-ms-client-flatten": true + } + } + }, + "PipelineRunProperties": { + "description": "The properties of a pipeline run.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of a pipeline run.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "request": { + "$ref": "#/definitions/PipelineRunRequest", + "description": "The request parameters for a pipeline run." + }, + "response": { + "$ref": "#/definitions/PipelineRunResponse", + "description": "The response of a pipeline run.", + "readOnly": true + }, + "forceUpdateTag": { + "description": "How the pipeline run should be forced to recreate even if the pipeline run configuration has not changed.", + "type": "string" + } + } + }, + "PipelineRunRequest": { + "description": "The request properties provided for a pipeline run.", + "type": "object", + "properties": { + "pipelineResourceId": { + "description": "The resource ID of the pipeline to run.", + "type": "string" + }, + "artifacts": { + "description": "List of source artifacts to be transferred by the pipeline. \r\nSpecify an image by repository ('hello-world'). This will use the 'latest' tag.\r\nSpecify an image by tag ('hello-world:latest').\r\nSpecify an image by sha256-based manifest digest ('hello-world@sha256:abc123').", + "type": "array", + "items": { + "type": "string" + } + }, + "source": { + "$ref": "#/definitions/PipelineRunSourceProperties", + "description": "The source properties of the pipeline run." + }, + "target": { + "$ref": "#/definitions/PipelineRunTargetProperties", + "description": "The target properties of the pipeline run." + }, + "catalogDigest": { + "description": "The digest of the tar used to transfer the artifacts.", + "type": "string" + } + } + }, + "PipelineRunResponse": { + "description": "The response properties returned for a pipeline run.", + "type": "object", + "properties": { + "status": { + "description": "The current status of the pipeline run.", + "type": "string" + }, + "importedArtifacts": { + "description": "The artifacts imported in the pipeline run.", + "type": "array", + "items": { + "type": "string" + } + }, + "progress": { + "$ref": "#/definitions/ProgressProperties", + "description": "The current progress of the copy operation." + }, + "startTime": { + "format": "date-time", + "description": "The time the pipeline run started.", + "type": "string" + }, + "finishTime": { + "format": "date-time", + "description": "The time the pipeline run finished.", + "type": "string" + }, + "source": { + "$ref": "#/definitions/ImportPipelineSourceProperties", + "description": "The source of the pipeline run." + }, + "target": { + "$ref": "#/definitions/ExportPipelineTargetProperties", + "description": "The target of the pipeline run." + }, + "catalogDigest": { + "description": "The digest of the tar used to transfer the artifacts.", + "type": "string" + }, + "trigger": { + "$ref": "#/definitions/PipelineTriggerDescriptor", + "description": "The trigger that caused the pipeline run." + }, + "pipelineRunErrorMessage": { + "description": "The detailed error message for the pipeline run in the case of failure.", + "type": "string" + } + } + }, + "PipelineRunSourceProperties": { + "type": "object", + "properties": { + "type": { + "description": "The type of the source.", + "default": "AzureStorageBlob", + "enum": [ + "AzureStorageBlob" + ], + "type": "string", + "x-ms-enum": { + "name": "PipelineRunSourceType", + "modelAsString": true + } + }, + "name": { + "description": "The name of the source.", + "type": "string" + } + } + }, + "PipelineRunTargetProperties": { + "type": "object", + "properties": { + "type": { + "description": "The type of the target.", + "default": "AzureStorageBlob", + "enum": [ + "AzureStorageBlob" + ], + "type": "string", + "x-ms-enum": { + "name": "PipelineRunTargetType", + "modelAsString": true + } + }, + "name": { + "description": "The name of the target.", + "type": "string" + } + } + }, + "ProgressProperties": { + "type": "object", + "properties": { + "percentage": { + "description": "The percentage complete of the copy operation.", + "type": "string" + } + } + }, + "PipelineTriggerDescriptor": { + "type": "object", + "properties": { + "sourceTrigger": { + "$ref": "#/definitions/PipelineSourceTriggerDescriptor", + "description": "The source trigger that caused the pipeline run." + } + } + }, + "PipelineSourceTriggerDescriptor": { + "type": "object", + "properties": { + "timestamp": { + "format": "date-time", + "description": "The timestamp when the source update happened.", + "type": "string" + } + } + }, + "PipelineRunListResult": { + "description": "The result of a request to list pipeline runs for a container registry.", + "type": "object", + "properties": { + "value": { + "description": "The list of pipeline runs. Since this list may be incomplete, the nextLink field should be used to request the next list of pipeline runs.", + "type": "array", + "items": { + "$ref": "#/definitions/PipelineRun" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next list of pipeline runs.", + "type": "string" + } + } + }, + "PrivateEndpointConnection": { + "description": "An object that represents a private endpoint connection for a container registry.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The properties of a private endpoint connection.", + "x-ms-client-flatten": true + } + } + }, + "PrivateEndpointConnectionProperties": { + "description": "The properties of a private endpoint connection.", + "type": "object", + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private endpoint." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "provisioningState": { + "description": "The provisioning state of private endpoint connection resource.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + } + } + }, + "PrivateEndpoint": { + "description": "The Private Endpoint resource.", + "type": "object", + "properties": { + "id": { + "description": "This is private endpoint resource created with Microsoft.Network resource provider.", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "The state of a private link service connection.", + "type": "object", + "properties": { + "status": { + "description": "The private link service connection status.", + "enum": [ + "Approved", + "Pending", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + } + }, + "description": { + "description": "The description for connection status. For example if connection is rejected it can indicate reason for rejection.", + "type": "string" + }, + "actionsRequired": { + "description": "A message indicating if changes on the service provider require any updates on the consumer.", + "enum": [ + "None", + "Recreate" + ], + "type": "string", + "x-ms-enum": { + "name": "ActionsRequired", + "modelAsString": true + } + } + } + }, + "PrivateEndpointConnectionListResult": { + "description": "The result of a request to list private endpoint connections for a container registry.", + "type": "object", + "properties": { + "value": { + "description": "The list of private endpoint connections. Since this list may be incomplete, the nextLink field should be used to request the next list of private endpoint connections.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next list of private endpoint connections.", + "type": "string" + } + } + }, + "Registry": { + "description": "An object that represents a container registry.", + "required": [ + "sku" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU of the container registry." + }, + "identity": { + "$ref": "#/definitions/IdentityProperties", + "description": "The identity of the container registry." + }, + "properties": { + "$ref": "#/definitions/RegistryProperties", + "description": "The properties of the container registry.", + "x-ms-client-flatten": true + } + } + }, + "Sku": { + "description": "The SKU of a container registry.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The SKU name of the container registry. Required for registry creation.", + "enum": [ + "Classic", + "Basic", + "Standard", + "Premium" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "tier": { + "description": "The SKU tier based on the SKU name.", + "enum": [ + "Classic", + "Basic", + "Standard", + "Premium" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + } + } + }, + "RegistryProperties": { + "description": "The properties of a container registry.", + "type": "object", + "properties": { + "loginServer": { + "description": "The URL that can be used to log into the container registry.", + "type": "string", + "readOnly": true + }, + "creationDate": { + "format": "date-time", + "description": "The creation date of the container registry in ISO8601 format.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the container registry at the time the operation was called.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the container registry at the time the operation was called.", + "readOnly": true + }, + "adminUserEnabled": { + "description": "The value that indicates whether the admin user is enabled.", + "default": false, + "type": "boolean" + }, + "networkRuleSet": { + "$ref": "#/definitions/NetworkRuleSet", + "description": "The network rule set for a container registry." + }, + "policies": { + "$ref": "#/definitions/Policies", + "description": "The policies for a container registry." + }, + "encryption": { + "$ref": "#/definitions/EncryptionProperty", + "description": "The encryption settings of container registry." + }, + "dataEndpointEnabled": { + "description": "Enable a single data endpoint per region for serving data.", + "type": "boolean" + }, + "dataEndpointHostNames": { + "description": "List of host names that will serve data when dataEndpointEnabled is true.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "privateEndpointConnections": { + "description": "List of private endpoint connections for a container registry.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "publicNetworkAccess": { + "description": "Whether or not public network access is allowed for the container registry.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + }, + "networkRuleBypassOptions": { + "description": "Whether to allow trusted Azure services to access a network restricted registry.", + "default": "AzureServices", + "enum": [ + "AzureServices", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "NetworkRuleBypassOptions", + "modelAsString": true + } + }, + "zoneRedundancy": { + "description": "Whether or not zone redundancy is enabled for this container registry", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "ZoneRedundancy", + "modelAsString": true + } + }, + "anonymousPullEnabled": { + "description": "Enables registry-wide pull from unauthenticated clients.", + "default": false, + "type": "boolean" + } + } + }, + "Status": { + "description": "The status of an Azure resource at the time the operation was called.", + "type": "object", + "properties": { + "displayStatus": { + "description": "The short label for the status.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The detailed message for the status, including alerts and error messages.", + "type": "string", + "readOnly": true + }, + "timestamp": { + "format": "date-time", + "description": "The timestamp when the status was changed to the current value.", + "type": "string", + "readOnly": true + } + } + }, + "NetworkRuleSet": { + "description": "The network rule set for a container registry.", + "required": [ + "defaultAction" + ], + "type": "object", + "properties": { + "defaultAction": { + "description": "The default action of allow or deny when no other rules match.", + "default": "Allow", + "enum": [ + "Allow", + "Deny" + ], + "type": "string", + "x-ms-enum": { + "name": "DefaultAction", + "modelAsString": true + } + }, + "virtualNetworkRules": { + "description": "The virtual network rules.", + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkRule" + } + }, + "ipRules": { + "description": "The IP ACL rules.", + "type": "array", + "items": { + "$ref": "#/definitions/IPRule" + } + } + } + }, + "Policies": { + "description": "The policies for a container registry.", + "type": "object", + "properties": { + "quarantinePolicy": { + "$ref": "#/definitions/QuarantinePolicy", + "description": "The quarantine policy for a container registry." + }, + "trustPolicy": { + "$ref": "#/definitions/TrustPolicy", + "description": "The content trust policy for a container registry." + }, + "retentionPolicy": { + "$ref": "#/definitions/RetentionPolicy", + "description": "The retention policy for a container registry." + }, + "exportPolicy": { + "$ref": "#/definitions/ExportPolicy", + "description": "The export policy for a container registry." + } + } + }, + "EncryptionProperty": { + "type": "object", + "properties": { + "status": { + "description": "Indicates whether or not the encryption is enabled for container registry.", + "enum": [ + "enabled", + "disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EncryptionStatus", + "modelAsString": true + } + }, + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Key vault properties." + } + } + }, + "VirtualNetworkRule": { + "description": "Virtual network rule.", + "required": [ + "id" + ], + "type": "object", + "properties": { + "action": { + "description": "The action of virtual network rule.", + "default": "Allow", + "enum": [ + "Allow" + ], + "type": "string", + "x-ms-enum": { + "name": "Action", + "modelAsString": true + } + }, + "id": { + "description": "Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}.", + "type": "string", + "x-ms-client-name": "VirtualNetworkResourceId" + } + } + }, + "IPRule": { + "description": "IP rule with specific IP or IP range in CIDR format.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "action": { + "description": "The action of IP ACL rule.", + "default": "Allow", + "enum": [ + "Allow" + ], + "type": "string", + "x-ms-enum": { + "name": "Action", + "modelAsString": true + } + }, + "value": { + "description": "Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.", + "type": "string", + "x-ms-client-name": "IPAddressOrRange" + } + } + }, + "QuarantinePolicy": { + "description": "The quarantine policy for a container registry.", + "type": "object", + "properties": { + "status": { + "description": "The value that indicates whether the policy is enabled or not.", + "default": "disabled", + "enum": [ + "enabled", + "disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PolicyStatus", + "modelAsString": true + } + } + } + }, + "TrustPolicy": { + "description": "The content trust policy for a container registry.", + "type": "object", + "properties": { + "type": { + "description": "The type of trust policy.", + "default": "Notary", + "enum": [ + "Notary" + ], + "type": "string", + "x-ms-enum": { + "name": "TrustPolicyType", + "modelAsString": true + } + }, + "status": { + "description": "The value that indicates whether the policy is enabled or not.", + "default": "disabled", + "enum": [ + "enabled", + "disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PolicyStatus", + "modelAsString": true + } + } + } + }, + "RetentionPolicy": { + "description": "The retention policy for a container registry.", + "type": "object", + "properties": { + "days": { + "format": "int32", + "description": "The number of days to retain an untagged manifest after which it gets purged.", + "default": 7, + "type": "integer" + }, + "lastUpdatedTime": { + "format": "date-time", + "description": "The timestamp when the policy was last updated.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The value that indicates whether the policy is enabled or not.", + "default": "disabled", + "enum": [ + "enabled", + "disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PolicyStatus", + "modelAsString": true + } + } + } + }, + "ExportPolicy": { + "description": "The export policy for a container registry.", + "type": "object", + "properties": { + "status": { + "description": "The value that indicates whether the policy is enabled or not.", + "default": "enabled", + "enum": [ + "enabled", + "disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "ExportPolicyStatus", + "modelAsString": true + } + } + } + }, + "KeyVaultProperties": { + "type": "object", + "properties": { + "keyIdentifier": { + "description": "Key vault uri to access the encryption key.", + "type": "string" + }, + "versionedKeyIdentifier": { + "description": "The fully qualified key identifier that includes the version of the key that is actually used for encryption.", + "type": "string", + "readOnly": true + }, + "identity": { + "description": "The client id of the identity which will be used to access key vault.", + "type": "string" + }, + "keyRotationEnabled": { + "description": "Auto key rotation status for a CMK enabled registry.", + "type": "boolean", + "readOnly": true + }, + "lastKeyRotationTimestamp": { + "format": "date-time", + "description": "Timestamp of the last successful key rotation.", + "type": "string", + "readOnly": true + } + } + }, + "RegistryUpdateParameters": { + "description": "The parameters for updating a container registry.", + "type": "object", + "properties": { + "identity": { + "$ref": "#/definitions/IdentityProperties", + "description": "The identity of the container registry." + }, + "tags": { + "description": "The tags for the container registry.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU of the container registry." + }, + "properties": { + "$ref": "#/definitions/RegistryPropertiesUpdateParameters", + "description": "The properties that the container registry will be updated with.", + "x-ms-client-flatten": true + } + } + }, + "RegistryPropertiesUpdateParameters": { + "description": "The parameters for updating the properties of a container registry.", + "type": "object", + "properties": { + "adminUserEnabled": { + "description": "The value that indicates whether the admin user is enabled.", + "type": "boolean" + }, + "networkRuleSet": { + "$ref": "#/definitions/NetworkRuleSet", + "description": "The network rule set for a container registry." + }, + "policies": { + "$ref": "#/definitions/Policies", + "description": "The policies for a container registry." + }, + "encryption": { + "$ref": "#/definitions/EncryptionProperty", + "description": "The encryption settings of container registry." + }, + "dataEndpointEnabled": { + "description": "Enable a single data endpoint per region for serving data.", + "type": "boolean" + }, + "publicNetworkAccess": { + "description": "Whether or not public network access is allowed for the container registry.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + }, + "networkRuleBypassOptions": { + "description": "Whether to allow trusted Azure services to access a network restricted registry.", + "default": "AzureServices", + "enum": [ + "AzureServices", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "NetworkRuleBypassOptions", + "modelAsString": true + } + }, + "anonymousPullEnabled": { + "description": "Enables registry-wide pull from unauthenticated clients.", + "type": "boolean" + } + } + }, + "RegistryListResult": { + "description": "The result of a request to list container registries.", + "type": "object", + "properties": { + "value": { + "description": "The list of container registries. Since this list may be incomplete, the nextLink field should be used to request the next list of container registries.", + "type": "array", + "items": { + "$ref": "#/definitions/Registry" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next list of container registries.", + "type": "string" + } + } + }, + "RegistryListCredentialsResult": { + "description": "The response from the ListCredentials operation.", + "type": "object", + "properties": { + "username": { + "description": "The username for a container registry.", + "type": "string" + }, + "passwords": { + "description": "The list of passwords for a container registry.", + "type": "array", + "items": { + "$ref": "#/definitions/RegistryPassword" + } + } + } + }, + "RegistryPassword": { + "description": "The login password for the container registry.", + "type": "object", + "properties": { + "name": { + "description": "The password name.", + "enum": [ + "password", + "password2" + ], + "type": "string", + "x-ms-enum": { + "name": "PasswordName", + "modelAsString": false + } + }, + "value": { + "description": "The password value.", + "type": "string" + } + } + }, + "RegenerateCredentialParameters": { + "description": "The parameters used to regenerate the login credential.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "Specifies name of the password which should be regenerated -- password or password2.", + "enum": [ + "password", + "password2" + ], + "type": "string", + "x-ms-enum": { + "name": "PasswordName", + "modelAsString": false + } + } + } + }, + "RegistryUsageListResult": { + "description": "The result of a request to get container registry quota usages.", + "type": "object", + "properties": { + "value": { + "description": "The list of container registry quota usages.", + "type": "array", + "items": { + "$ref": "#/definitions/RegistryUsage" + } + } + } + }, + "RegistryUsage": { + "description": "The quota usage for a container registry.", + "type": "object", + "properties": { + "name": { + "description": "The name of the usage.", + "type": "string" + }, + "limit": { + "format": "int64", + "description": "The limit of the usage.", + "type": "integer" + }, + "currentValue": { + "format": "int64", + "description": "The current value of the usage.", + "type": "integer" + }, + "unit": { + "description": "The unit of measurement.", + "enum": [ + "Count", + "Bytes" + ], + "type": "string", + "x-ms-enum": { + "name": "RegistryUsageUnit", + "modelAsString": true + } + } + } + }, + "PrivateLinkResourceListResult": { + "description": "The result of a request to list private link resources for a container registry.", + "type": "object", + "properties": { + "value": { + "description": "The list of private link resources. Since this list may be incomplete, the nextLink field should be used to request the next list of private link resources.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next list of private link resources.", + "type": "string" + } + } + }, + "PrivateLinkResource": { + "description": "A resource that supports private link capabilities.", + "type": "object", + "properties": { + "type": { + "description": "The resource type is private link resource.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "The resource ID.", + "type": "string" + }, + "name": { + "description": "The name of the resource.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "A resource that supports private link capabilities.", + "x-ms-client-flatten": true + } + } + }, + "PrivateLinkResourceProperties": { + "description": "The properties of a private link resource.", + "type": "object", + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string" + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + } + }, + "requiredZoneNames": { + "description": "The private link resource Private link DNS zone name.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Replication": { + "description": "An object that represents a replication for a container registry.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ReplicationProperties", + "description": "The properties of the replication.", + "x-ms-client-flatten": true + } + } + }, + "ReplicationProperties": { + "description": "The properties of a replication.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the replication at the time the operation was called.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the replication at the time the operation was called.", + "readOnly": true + }, + "regionEndpointEnabled": { + "description": "Specifies whether the replication's regional endpoint is enabled. Requests will not be routed to a replication whose regional endpoint is disabled, however its data will continue to be synced with other replications.", + "default": true, + "type": "boolean" + }, + "zoneRedundancy": { + "description": "Whether or not zone redundancy is enabled for this container registry replication", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "ZoneRedundancy", + "modelAsString": true + } + } + } + }, + "ReplicationUpdateParameters": { + "description": "The parameters for updating a replication.", + "type": "object", + "properties": { + "tags": { + "description": "The tags for the replication.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/ReplicationUpdateParametersProperties", + "description": "The parameters for updating a replication's properties", + "x-ms-client-flatten": true + } + } + }, + "ReplicationUpdateParametersProperties": { + "type": "object", + "properties": { + "regionEndpointEnabled": { + "description": "Specifies whether the replication's regional endpoint is enabled. Requests will not be routed to a replication whose regional endpoint is disabled, however its data will continue to be synced with other replications.", + "type": "boolean" + } + } + }, + "ReplicationListResult": { + "description": "The result of a request to list replications for a container registry.", + "type": "object", + "properties": { + "value": { + "description": "The list of replications. Since this list may be incomplete, the nextLink field should be used to request the next list of replications.", + "type": "array", + "items": { + "$ref": "#/definitions/Replication" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next list of replications.", + "type": "string" + } + } + }, + "ScopeMap": { + "description": "An object that represents a scope map for a container registry.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ScopeMapProperties", + "description": "The properties of the scope map.", + "x-ms-client-flatten": true + } + } + }, + "ScopeMapProperties": { + "description": "The properties of a scope map.", + "required": [ + "actions" + ], + "type": "object", + "properties": { + "description": { + "description": "The user friendly description of the scope map.", + "type": "string" + }, + "type": { + "description": "The type of the scope map. E.g. BuildIn scope map.", + "type": "string", + "readOnly": true + }, + "creationDate": { + "format": "date-time", + "description": "The creation date of scope map.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "Provisioning state of the resource.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "actions": { + "description": "The list of scoped permissions for registry artifacts.\r\nE.g. repositories/repository-name/content/read,\r\nrepositories/repository-name/metadata/write", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ScopeMapUpdateParameters": { + "description": "The properties for updating the scope map.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ScopeMapPropertiesUpdateParameters", + "description": "The update parameters for scope map properties.", + "x-ms-client-flatten": true + } + } + }, + "ScopeMapPropertiesUpdateParameters": { + "description": "The update parameters for scope map properties.", + "type": "object", + "properties": { + "description": { + "description": "The user friendly description of the scope map.", + "type": "string" + }, + "actions": { + "description": "The list of scope permissions for registry artifacts.\r\nE.g. repositories/repository-name/pull, \r\nrepositories/repository-name/delete", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ScopeMapListResult": { + "description": "The result of a request to list scope maps for a container registry.", + "type": "object", + "properties": { + "value": { + "description": "The list of scope maps. Since this list may be incomplete, the nextLink field should be used to request the next list of scope maps.", + "type": "array", + "items": { + "$ref": "#/definitions/ScopeMap" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next list of scope maps.", + "type": "string" + } + } + }, + "Token": { + "description": "An object that represents a token for a container registry.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TokenProperties", + "description": "The properties of the token.", + "x-ms-client-flatten": true + } + } + }, + "TokenProperties": { + "description": "The properties of a token.", + "type": "object", + "properties": { + "creationDate": { + "format": "date-time", + "description": "The creation date of scope map.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "Provisioning state of the resource.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "scopeMapId": { + "description": "The resource ID of the scope map to which the token will be associated with.", + "type": "string" + }, + "credentials": { + "$ref": "#/definitions/TokenCredentialsProperties", + "description": "The credentials that can be used for authenticating the token." + }, + "status": { + "description": "The status of the token example enabled or disabled.", + "enum": [ + "enabled", + "disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "TokenStatus", + "modelAsString": true + } + } + } + }, + "TokenCredentialsProperties": { + "description": "The properties of the credentials that can be used for authenticating the token.", + "type": "object", + "properties": { + "certificates": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenCertificate" + } + }, + "passwords": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenPassword" + } + } + } + }, + "ActiveDirectoryObject": { + "description": "The Active Directory Object that will be used for authenticating the token of a container registry.", + "type": "object", + "properties": { + "objectId": { + "description": "The user/group/application object ID for Active Directory Object that will be used for authenticating the token of a container registry.", + "type": "string" + }, + "tenantId": { + "description": "The tenant ID of user/group/application object Active Directory Object that will be used for authenticating the token of a container registry.", + "type": "string" + } + } + }, + "TokenCertificate": { + "description": "The properties of a certificate used for authenticating a token.", + "type": "object", + "properties": { + "name": { + "enum": [ + "certificate1", + "certificate2" + ], + "type": "string", + "x-ms-enum": { + "name": "TokenCertificateName", + "modelAsString": true + } + }, + "expiry": { + "format": "date-time", + "description": "The expiry datetime of the certificate.", + "type": "string" + }, + "thumbprint": { + "description": "The thumbprint of the certificate.", + "type": "string" + }, + "encodedPemCertificate": { + "description": "Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token.", + "type": "string" + } + } + }, + "TokenPassword": { + "description": "The password that will be used for authenticating the token of a container registry.", + "type": "object", + "properties": { + "creationTime": { + "format": "date-time", + "description": "The creation datetime of the password.", + "type": "string" + }, + "expiry": { + "format": "date-time", + "description": "The expiry datetime of the password.", + "type": "string" + }, + "name": { + "description": "The password name \"password1\" or \"password2\"", + "enum": [ + "password1", + "password2" + ], + "type": "string", + "x-ms-enum": { + "name": "TokenPasswordName", + "modelAsString": true + } + }, + "value": { + "description": "The password value.", + "type": "string", + "readOnly": true + } + } + }, + "TokenUpdateParameters": { + "description": "The parameters for updating a token.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/TokenUpdateProperties", + "description": "The properties of the token update parameters.", + "x-ms-client-flatten": true + } + } + }, + "TokenUpdateProperties": { + "description": "The parameters for updating token properties.", + "type": "object", + "properties": { + "scopeMapId": { + "description": "The resource ID of the scope map to which the token will be associated with.", + "type": "string" + }, + "status": { + "description": "The status of the token example enabled or disabled.", + "enum": [ + "enabled", + "disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "TokenStatus", + "modelAsString": true + } + }, + "credentials": { + "$ref": "#/definitions/TokenCredentialsProperties", + "description": "The credentials that can be used for authenticating the token." + } + } + }, + "TokenListResult": { + "description": "The result of a request to list tokens for a container registry.", + "type": "object", + "properties": { + "value": { + "description": "The list of tokens. Since this list may be incomplete, the nextLink field should be used to request the next list of tokens.", + "type": "array", + "items": { + "$ref": "#/definitions/Token" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next list of tokens.", + "type": "string" + } + } + }, + "GenerateCredentialsParameters": { + "description": "The parameters used to generate credentials for a specified token or user of a container registry.", + "type": "object", + "properties": { + "tokenId": { + "description": "The resource ID of the token for which credentials have to be generated.", + "type": "string" + }, + "expiry": { + "format": "date-time", + "description": "The expiry date of the generated credentials after which the credentials become invalid.", + "type": "string" + }, + "name": { + "description": "Specifies name of the password which should be regenerated if any -- password1 or password2.", + "enum": [ + "password1", + "password2" + ], + "type": "string", + "x-ms-enum": { + "name": "TokenPasswordName", + "modelAsString": true + } + } + } + }, + "GenerateCredentialsResult": { + "description": "The response from the GenerateCredentials operation.", + "type": "object", + "properties": { + "username": { + "description": "The username for a container registry.", + "type": "string" + }, + "passwords": { + "description": "The list of passwords for a container registry.", + "type": "array", + "items": { + "$ref": "#/definitions/TokenPassword" + } + } + } + }, + "Webhook": { + "description": "An object that represents a webhook for a container registry.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/WebhookProperties", + "description": "The properties of the webhook.", + "x-ms-client-flatten": true + } + } + }, + "WebhookProperties": { + "description": "The properties of a webhook.", + "required": [ + "actions" + ], + "type": "object", + "properties": { + "status": { + "description": "The status of the webhook at the time the operation was called.", + "enum": [ + "enabled", + "disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "WebhookStatus", + "modelAsString": true + } + }, + "scope": { + "description": "The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events.", + "type": "string" + }, + "actions": { + "description": "The list of actions that trigger the webhook to post notifications.", + "type": "array", + "items": { + "enum": [ + "push", + "delete", + "quarantine", + "chart_push", + "chart_delete" + ], + "type": "string", + "x-ms-enum": { + "name": "WebhookAction", + "modelAsString": true + } + } + }, + "provisioningState": { + "description": "The provisioning state of the webhook at the time the operation was called.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + } + } + }, + "WebhookCreateParameters": { + "description": "The parameters for creating a webhook.", + "required": [ + "location" + ], + "type": "object", + "properties": { + "tags": { + "description": "The tags for the webhook.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "location": { + "description": "The location of the webhook. This cannot be changed after the resource is created.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/WebhookPropertiesCreateParameters", + "description": "The properties that the webhook will be created with.", + "x-ms-client-flatten": true + } + } + }, + "WebhookPropertiesCreateParameters": { + "description": "The parameters for creating the properties of a webhook.", + "required": [ + "serviceUri", + "actions" + ], + "type": "object", + "properties": { + "serviceUri": { + "description": "The service URI for the webhook to post notifications.", + "type": "string", + "x-ms-secret": true + }, + "customHeaders": { + "description": "Custom headers that will be added to the webhook notifications.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-secret": true + }, + "status": { + "description": "The status of the webhook at the time the operation was called.", + "enum": [ + "enabled", + "disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "WebhookStatus", + "modelAsString": true + } + }, + "scope": { + "description": "The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events.", + "type": "string" + }, + "actions": { + "description": "The list of actions that trigger the webhook to post notifications.", + "type": "array", + "items": { + "enum": [ + "push", + "delete", + "quarantine", + "chart_push", + "chart_delete" + ], + "type": "string", + "x-ms-enum": { + "name": "WebhookAction", + "modelAsString": true + } + } + } + } + }, + "WebhookUpdateParameters": { + "description": "The parameters for updating a webhook.", + "type": "object", + "properties": { + "tags": { + "description": "The tags for the webhook.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/WebhookPropertiesUpdateParameters", + "description": "The properties that the webhook will be updated with.", + "x-ms-client-flatten": true + } + } + }, + "WebhookPropertiesUpdateParameters": { + "description": "The parameters for updating the properties of a webhook.", + "type": "object", + "properties": { + "serviceUri": { + "description": "The service URI for the webhook to post notifications.", + "type": "string", + "x-ms-secret": true + }, + "customHeaders": { + "description": "Custom headers that will be added to the webhook notifications.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-secret": true + }, + "status": { + "description": "The status of the webhook at the time the operation was called.", + "enum": [ + "enabled", + "disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "WebhookStatus", + "modelAsString": true + } + }, + "scope": { + "description": "The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events.", + "type": "string" + }, + "actions": { + "description": "The list of actions that trigger the webhook to post notifications.", + "type": "array", + "items": { + "enum": [ + "push", + "delete", + "quarantine", + "chart_push", + "chart_delete" + ], + "type": "string", + "x-ms-enum": { + "name": "WebhookAction", + "modelAsString": true + } + } + } + } + }, + "WebhookListResult": { + "description": "The result of a request to list webhooks for a container registry.", + "type": "object", + "properties": { + "value": { + "description": "The list of webhooks. Since this list may be incomplete, the nextLink field should be used to request the next list of webhooks.", + "type": "array", + "items": { + "$ref": "#/definitions/Webhook" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next list of webhooks.", + "type": "string" + } + } + }, + "EventInfo": { + "description": "The basic information of an event.", + "type": "object", + "properties": { + "id": { + "description": "The event ID.", + "type": "string" + } + } + }, + "CallbackConfig": { + "description": "The configuration of service URI and custom headers for the webhook.", + "required": [ + "serviceUri" + ], + "type": "object", + "properties": { + "serviceUri": { + "description": "The service URI for the webhook to post notifications.", + "type": "string" + }, + "customHeaders": { + "description": "Custom headers that will be added to the webhook notifications.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "EventListResult": { + "description": "The result of a request to list events for a webhook.", + "type": "object", + "properties": { + "value": { + "description": "The list of events. Since this list may be incomplete, the nextLink field should be used to request the next list of events.", + "type": "array", + "items": { + "$ref": "#/definitions/Event" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next list of events.", + "type": "string" + } + } + }, + "Event": { + "description": "The event for a webhook.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventInfo" + } + ], + "properties": { + "eventRequestMessage": { + "$ref": "#/definitions/EventRequestMessage", + "description": "The event request message sent to the service URI." + }, + "eventResponseMessage": { + "$ref": "#/definitions/EventResponseMessage", + "description": "The event response message received from the service URI." + } + } + }, + "EventRequestMessage": { + "description": "The event request message sent to the service URI.", + "type": "object", + "properties": { + "content": { + "$ref": "#/definitions/EventContent", + "description": "The content of the event request message." + }, + "headers": { + "description": "The headers of the event request message.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "method": { + "description": "The HTTP method used to send the event request message.", + "type": "string" + }, + "requestUri": { + "description": "The URI used to send the event request message.", + "type": "string" + }, + "version": { + "description": "The HTTP message version.", + "type": "string" + } + } + }, + "EventResponseMessage": { + "description": "The event response message received from the service URI.", + "type": "object", + "properties": { + "content": { + "description": "The content of the event response message.", + "type": "string" + }, + "headers": { + "description": "The headers of the event response message.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "reasonPhrase": { + "description": "The reason phrase of the event response message.", + "type": "string" + }, + "statusCode": { + "description": "The status code of the event response message.", + "type": "string" + }, + "version": { + "description": "The HTTP message version.", + "type": "string" + } + } + }, + "EventContent": { + "description": "The content of the event request message.", + "type": "object", + "properties": { + "id": { + "description": "The event ID.", + "type": "string" + }, + "timestamp": { + "format": "date-time", + "description": "The time at which the event occurred.", + "type": "string" + }, + "action": { + "description": "The action that encompasses the provided event.", + "type": "string" + }, + "target": { + "$ref": "#/definitions/Target", + "description": "The target of the event." + }, + "request": { + "$ref": "#/definitions/Request", + "description": "The request that generated the event." + }, + "actor": { + "$ref": "#/definitions/Actor", + "description": "The agent that initiated the event. For most situations, this could be from the authorization context of the request." + }, + "source": { + "$ref": "#/definitions/Source", + "description": "The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it." + } + } + }, + "Target": { + "description": "The target of the event.", + "type": "object", + "properties": { + "mediaType": { + "description": "The MIME type of the referenced object.", + "type": "string" + }, + "size": { + "format": "int64", + "description": "The number of bytes of the content. Same as Length field.", + "type": "integer" + }, + "digest": { + "description": "The digest of the content, as defined by the Registry V2 HTTP API Specification.", + "type": "string" + }, + "length": { + "format": "int64", + "description": "The number of bytes of the content. Same as Size field.", + "type": "integer" + }, + "repository": { + "description": "The repository name.", + "type": "string" + }, + "url": { + "description": "The direct URL to the content.", + "type": "string" + }, + "tag": { + "description": "The tag name.", + "type": "string" + }, + "name": { + "description": "The name of the artifact.", + "type": "string" + }, + "version": { + "description": "The version of the artifact.", + "type": "string" + } + } + }, + "Request": { + "description": "The request that generated the event.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the request that initiated the event.", + "type": "string" + }, + "addr": { + "description": "The IP or hostname and possibly port of the client connection that initiated the event. This is the RemoteAddr from the standard http request.", + "type": "string" + }, + "host": { + "description": "The externally accessible hostname of the registry instance, as specified by the http host header on incoming requests.", + "type": "string" + }, + "method": { + "description": "The request method that generated the event.", + "type": "string" + }, + "useragent": { + "description": "The user agent header of the request.", + "type": "string" + } + } + }, + "Actor": { + "description": "The agent that initiated the event. For most situations, this could be from the authorization context of the request.", + "type": "object", + "properties": { + "name": { + "description": "The subject or username associated with the request context that generated the event.", + "type": "string" + } + } + }, + "Source": { + "description": "The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.", + "type": "object", + "properties": { + "addr": { + "description": "The IP or hostname and the port of the registry node that generated the event. Generally, this will be resolved by os.Hostname() along with the running port.", + "type": "string" + }, + "instanceID": { + "description": "The running instance of an application. Changes after each restart.", + "type": "string" + } + } + }, + "Resource": { + "description": "An Azure resource.", + "required": [ + "location" + ], + "properties": { + "id": { + "description": "The resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "location": { + "description": "The location of the resource. This cannot be changed after the resource is created.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "description": "The tags of the resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "systemData": { + "$ref": "#/definitions/SystemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "properties": { + "createdBy": { + "description": "The identity that created the resource.", + "type": "string" + }, + "createdByType": { + "description": "The type of identity that created the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "type": "string", + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "createdAt": { + "format": "date-time", + "description": "The timestamp of resource creation (UTC).", + "type": "string" + }, + "lastModifiedBy": { + "description": "The identity that last modified the resource.", + "type": "string" + }, + "lastModifiedByType": { + "description": "The type of identity that last modified the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "type": "string", + "x-ms-enum": { + "name": "lastModifiedByType", + "modelAsString": true + } + }, + "lastModifiedAt": { + "format": "date-time", + "description": "The timestamp of resource modification (UTC).", + "type": "string" + } + }, + "readOnly": true + }, + "ErrorResponse": { + "description": "An error response from the Azure Container Registry service.", + "properties": { + "error": { + "$ref": "#/definitions/ErrorResponseBody", + "description": "Azure container registry build API error body." + } + } + }, + "ErrorResponseBody": { + "description": "An error response from the Azure Container Registry service.", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "description": "error code.", + "type": "string" + }, + "message": { + "description": "error message.", + "type": "string" + }, + "target": { + "description": "target of the particular error.", + "type": "string" + }, + "details": { + "$ref": "#/definitions/InnerErrorDescription", + "description": "an array of additional nested error response info objects, as described by this contract.", + "type": "array" + } + } + }, + "InnerErrorDescription": { + "description": "inner error.", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "description": "error code.", + "type": "string" + }, + "message": { + "description": "error message.", + "type": "string" + }, + "target": { + "description": "target of the particular error.", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The Microsoft Azure subscription ID.", + "required": true, + "type": "string" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The client API version.", + "required": true, + "type": "string" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group to which the container registry belongs.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method" + }, + "RegistryNameParameter": { + "name": "registryName", + "in": "path", + "description": "The name of the container registry.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 5, + "pattern": "^[a-zA-Z0-9]*$", + "x-ms-parameter-location": "method" + }, + "WebhookNameParameter": { + "name": "webhookName", + "in": "path", + "description": "The name of the webhook.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 5, + "pattern": "^[a-zA-Z0-9]*$", + "x-ms-parameter-location": "method" + }, + "ReplicationNameParameter": { + "name": "replicationName", + "in": "path", + "description": "The name of the replication.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 5, + "pattern": "^[a-zA-Z0-9]*$", + "x-ms-parameter-location": "method" + }, + "ScopeMapNameParameter": { + "name": "scopeMapName", + "in": "path", + "description": "The name of the scope map.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 5, + "pattern": "^[a-zA-Z0-9-_]*$", + "x-ms-parameter-location": "method" + }, + "TokenNameParameter": { + "name": "tokenName", + "in": "path", + "description": "The name of the token.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 5, + "pattern": "^[a-zA-Z0-9-]*$", + "x-ms-parameter-location": "method" + }, + "PrivateEndpointConnectionNameParameter": { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ExportPipelineNameParameter": { + "name": "exportPipelineName", + "in": "path", + "description": "The name of the export pipeline.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 5, + "pattern": "^[a-zA-Z0-9]*$", + "x-ms-parameter-location": "method" + }, + "ImportPipelineNameParameter": { + "name": "importPipelineName", + "in": "path", + "description": "The name of the import pipeline.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 5, + "pattern": "^[a-zA-Z0-9]*$", + "x-ms-parameter-location": "method" + }, + "PipelineRunNameParameter": { + "name": "pipelineRunName", + "in": "path", + "description": "The name of the pipeline run.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 5, + "pattern": "^[a-zA-Z0-9]*$", + "x-ms-parameter-location": "method" + }, + "ConnectedRegistryNameParameter": { + "name": "connectedRegistryName", + "in": "path", + "description": "The name of the connected registry.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 5, + "pattern": "^[a-zA-Z0-9]*$", + "x-ms-parameter-location": "method" + }, + "ConnectedRegistryFilterParameter": { + "name": "$filter", + "in": "query", + "description": "An OData filter expression that describes a subset of connectedRegistries to return. The parameters that can be filtered are parent.id (the resource id of the connectedRegistry parent), mode, and connectionState. The supported operator is eq.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ConnectedRegistryCreate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ConnectedRegistryCreate.json new file mode 100644 index 000000000000..35f12b9253cb --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ConnectedRegistryCreate.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "connectedRegistryName": "myConnectedRegistry", + "connectedRegistryCreateParameters": { + "properties": { + "mode": "Registry", + "parent": { + "syncProperties": { + "tokenId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/syncToken", + "schedule": "0 9 * * *", + "messageTtl": "P2D", + "syncWindow": "PT3H" + } + }, + "clientTokenIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/client1Token" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/connectedRegistries/myConnectedRegistry", + "name": "myConnectedRegistry", + "type": "Microsoft.ContainerRegistry/registries/connectedRegistries", + "properties": { + "mode": "Registry", + "activation": { + "status": "Inactive" + }, + "parent": { + "syncProperties": { + "tokenId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/syncToken", + "schedule": "0 9 * * *", + "messageTtl": "P2D", + "syncWindow": "PT3H" + } + }, + "clientTokenIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/client1Token" + ], + "logging": { + "logLevel": "Information", + "auditLogStatus": "Disabled" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/connectedRegistries/myConnectedRegistry", + "name": "myConnectedRegistry", + "type": "Microsoft.ContainerRegistry/registries/connectedRegistries", + "properties": { + "mode": "Registry", + "activation": { + "status": "Inactive" + }, + "parent": { + "syncProperties": { + "tokenId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/syncToken", + "schedule": "0 9 * * *", + "messageTtl": "P2D", + "syncWindow": "PT3H" + } + }, + "clientTokenIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/client1Token" + ], + "logging": { + "logLevel": "Information", + "auditLogStatus": "Disabled" + } + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ConnectedRegistryDeactivate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ConnectedRegistryDeactivate.json new file mode 100644 index 000000000000..bc39b891a22f --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ConnectedRegistryDeactivate.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "connectedRegistryName": "myConnectedRegistry" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ConnectedRegistryDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ConnectedRegistryDelete.json new file mode 100644 index 000000000000..454de640ab64 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ConnectedRegistryDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "connectedRegistryName": "myConnectedRegistry" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ConnectedRegistryGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ConnectedRegistryGet.json new file mode 100644 index 000000000000..5341da2b2715 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ConnectedRegistryGet.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "connectedRegistryName": "myConnectedRegistry" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/connectedRegistries/myConnectedRegistry", + "name": "myConnectedRegistry", + "type": "Microsoft.ContainerRegistry/registries/connectedRegistries", + "properties": { + "mode": "Registry", + "activation": { + "status": "Inactive" + }, + "parent": { + "syncProperties": { + "tokenId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/syncToken", + "schedule": "0 9 * * *", + "messageTtl": "P2D", + "syncWindow": "PT3H" + } + }, + "clientTokenIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/client1Token" + ], + "logging": { + "logLevel": "Information", + "auditLogStatus": "Disabled" + } + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ConnectedRegistryList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ConnectedRegistryList.json new file mode 100644 index 000000000000..65c7b81ba602 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ConnectedRegistryList.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/connectedRegistries/myConnectedRegistry", + "name": "myConnectedRegistry", + "type": "Microsoft.ContainerRegistry/registries/connectedRegistries", + "properties": { + "mode": "Registry", + "activation": { + "status": "Inactive" + }, + "parent": { + "syncProperties": { + "tokenId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/syncToken", + "schedule": "0 9 * * *", + "messageTtl": "P2D", + "syncWindow": "PT3H" + } + }, + "clientTokenIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/client1Token" + ], + "logging": { + "logLevel": "Information", + "auditLogStatus": "Disabled" + } + } + } + ] + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ConnectedRegistryUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ConnectedRegistryUpdate.json new file mode 100644 index 000000000000..a76d1d9bee57 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ConnectedRegistryUpdate.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "connectedRegistryName": "myScopeMap", + "connectedRegistryUpdateParameters": { + "properties": { + "syncProperties": { + "schedule": "0 0 */10 * *", + "messageTtl": "P30D", + "syncWindow": "P2D" + }, + "logging": { + "logLevel": "Debug", + "auditLogStatus": "Enabled" + }, + "clientTokenIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/client1Token", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/client2Token" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/connectedRegistries/myConnectedRegistry", + "name": "myConnectedRegistry", + "type": "Microsoft.ContainerRegistry/registries/connectedRegistries", + "properties": { + "mode": "Registry", + "parent": { + "syncProperties": { + "tokenId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/syncToken", + "schedule": "0 0 */10 * *", + "messageTtl": "P30D", + "syncWindow": "P2D" + } + }, + "clientTokenIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/client1Token", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/client2Token" + ], + "logging": { + "logLevel": "Debug", + "auditLogStatus": "Enabled" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/connectedRegistries/myConnectedRegistry", + "name": "myConnectedRegistry", + "type": "Microsoft.ContainerRegistry/registries/connectedRegistries", + "properties": { + "mode": "Registry", + "parent": { + "syncProperties": { + "tokenId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/syncToken", + "schedule": "0 0 */10 * *", + "messageTtl": "P30D", + "syncWindow": "P2D" + } + }, + "clientTokenIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/client1Token", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/client2Token" + ], + "logging": { + "logLevel": "Debug", + "auditLogStatus": "Enabled" + } + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ExportPipelineCreate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ExportPipelineCreate.json new file mode 100644 index 000000000000..9e334879cb40 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ExportPipelineCreate.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "exportPipelineName": "myExportPipeline", + "exportPipelineCreateParameters": { + "location": "westus", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "target": { + "type": "AzureStorageBlobContainer", + "uri": "https://accountname.blob.core.windows.net/containername", + "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrexportsas" + }, + "options": [ + "OverwriteBlobs" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/exportPipelines/myExportPipeline", + "name": "myExportPipeline", + "type": "Microsoft.ContainerRegistry/registries/exportPipelines", + "properties": { + "target": { + "type": "AzureStorageBlobContainer", + "uri": "https://accountname.blob.core.windows.net/containername", + "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrexportsas" + }, + "options": [ + "OverwriteBlobs" + ], + "provisioningState": "Succeeded" + }, + "location": "westus", + "identity": { + "principalId": "fa153151-b9fd-46f4-9088-5e6600f2689v", + "tenantId": "f686d426-8d16-42db-81b7-abu4gm510ccd", + "type": "SystemAssigned" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/exportPipelines/myExportPipeline", + "name": "myExportPipeline", + "type": "Microsoft.ContainerRegistry/registries/exportPipelines", + "properties": { + "target": { + "type": "AzureStorageBlobContainer", + "uri": "https://accountname.blob.core.windows.net/containername", + "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrexportsas" + }, + "options": [ + "OverwriteBlobs" + ], + "provisioningState": "Succeeded" + }, + "location": "westus", + "identity": { + "principalId": "fa153151-b9fd-46f4-9088-5e6600f2689v", + "tenantId": "f686d426-8d16-42db-81b7-abu4gm510ccd", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ExportPipelineDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ExportPipelineDelete.json new file mode 100644 index 000000000000..9fcb5100fce1 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ExportPipelineDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "exportPipelineName": "myExportPipeline" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ExportPipelineGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ExportPipelineGet.json new file mode 100644 index 000000000000..668ef92be16f --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ExportPipelineGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "exportPipelineName": "myExportPipeline" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/exportPipelines/myExportPipeline", + "name": "myExportPipeline", + "type": "Microsoft.ContainerRegistry/registries/exportPipelines", + "properties": { + "target": { + "type": "AzureStorageBlobContainer", + "uri": "https://accountname.blob.core.windows.net/containername", + "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrexportsas" + }, + "options": [ + "OverwriteBlobs" + ], + "provisioningState": "Succeeded" + }, + "location": "westus", + "identity": { + "principalId": "fa153151-b9fd-46f4-9088-5e6600f2689v", + "tenantId": "f686d426-8d16-42db-81b7-abu4gm510ccd", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ExportPipelineList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ExportPipelineList.json new file mode 100644 index 000000000000..71a8f06df984 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ExportPipelineList.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/exportPipelines/myExportPipeline", + "name": "myExportPipeline", + "type": "Microsoft.ContainerRegistry/registries/exportPipelines", + "properties": { + "target": { + "type": "AzureStorageBlobContainer", + "uri": "https://accountname.blob.core.windows.net/containername", + "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrexportsas" + }, + "options": [ + "OverwriteBlobs" + ], + "provisioningState": "Succeeded" + }, + "location": "westus", + "identity": { + "principalId": "fa153151-b9fd-46f4-9088-5e6600f2689v", + "tenantId": "f686d426-8d16-42db-81b7-abu4gm510ccd", + "type": "SystemAssigned" + } + } + ] + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ImportImageByManifestDigest.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ImportImageByManifestDigest.json new file mode 100644 index 000000000000..832cfe01ca8d --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ImportImageByManifestDigest.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "parameters": { + "source": { + "resourceId": "/subscriptions/10000000-0000-0000-0000-000000000000/resourceGroups/sourceResourceGroup/providers/Microsoft.ContainerRegistry/registries/sourceRegistry", + "sourceImage": "sourceRepository@sha256:0000000000000000000000000000000000000000000000000000000000000000" + }, + "targetTags": [ + "targetRepository:targetTag" + ], + "untaggedTargetRepositories": [ + "targetRepository1" + ], + "mode": "Force" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ImportImageByTag.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ImportImageByTag.json new file mode 100644 index 000000000000..605fa5021f3a --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ImportImageByTag.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "parameters": { + "source": { + "resourceId": "/subscriptions/10000000-0000-0000-0000-000000000000/resourceGroups/sourceResourceGroup/providers/Microsoft.ContainerRegistry/registries/sourceRegistry", + "sourceImage": "sourceRepository:sourceTag" + }, + "targetTags": [ + "targetRepository:targetTag" + ], + "untaggedTargetRepositories": [ + "targetRepository1" + ], + "mode": "Force" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ImportImageFromPublicRegistry.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ImportImageFromPublicRegistry.json new file mode 100644 index 000000000000..c10155eecc48 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ImportImageFromPublicRegistry.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "parameters": { + "source": { + "registryUri": "registry.hub.docker.com", + "sourceImage": "library/hello-world" + }, + "targetTags": [ + "targetRepository:targetTag" + ], + "untaggedTargetRepositories": [ + "targetRepository1" + ], + "mode": "Force" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ImportPipelineCreate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ImportPipelineCreate.json new file mode 100644 index 000000000000..e599a6ade62f --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ImportPipelineCreate.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "importPipelineName": "myImportPipeline", + "importPipelineCreateParameters": { + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/f9d7ebed-adbd-4cb4-b973-aaf82c136138/resourcegroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": {} + } + }, + "properties": { + "source": { + "type": "AzureStorageBlobContainer", + "uri": "https://accountname.blob.core.windows.net/containername", + "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrimportsas" + }, + "options": [ + "OverwriteTags", + "DeleteSourceBlobOnSuccess", + "ContinueOnErrors" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/importPipelines/myImportPipeline", + "name": "myImportPipeline", + "type": "Microsoft.ContainerRegistry/registries/importPipelines", + "properties": { + "source": { + "type": "AzureStorageBlobContainer", + "uri": "https://accountname.blob.core.windows.net/containername", + "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrimportsas" + }, + "trigger": { + "sourceTrigger": { + "status": "Enabled" + } + }, + "options": [ + "OverwriteTags", + "DeleteSourceBlobOnSuccess", + "ContinueOnErrors" + ], + "provisioningState": "Succeeded" + }, + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/f9d7ebed-adbd-4cb4-b973-aaf82c136138/resourcegroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": { + "clientId": "d3ce1bc2-f7d7-4a5b-9979-950f4e57680e", + "principalId": "b6p9f58b-6fbf-4efd-a7e0-fvd46911a466" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/importPipelines/myImportPipeline", + "name": "myImportPipeline", + "type": "Microsoft.ContainerRegistry/registries/importPipelines", + "properties": { + "source": { + "type": "AzureStorageBlobContainer", + "uri": "https://accountname.blob.core.windows.net/containername", + "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrimportsas" + }, + "trigger": { + "sourceTrigger": { + "status": "Enabled" + } + }, + "options": [ + "OverwriteTags", + "DeleteSourceBlobOnSuccess", + "ContinueOnErrors" + ], + "provisioningState": "Succeeded" + }, + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/f9d7ebed-adbd-4cb4-b973-aaf82c136138/resourcegroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": { + "clientId": "d3ce1bc2-f7d7-4a5b-9979-950f4e57680e", + "principalId": "b6p9f58b-6fbf-4efd-a7e0-fvd46911a466" + } + } + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ImportPipelineDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ImportPipelineDelete.json new file mode 100644 index 000000000000..f1c9743fe1e8 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ImportPipelineDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "importPipelineName": "myImportPipeline" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ImportPipelineGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ImportPipelineGet.json new file mode 100644 index 000000000000..38697966e8b5 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ImportPipelineGet.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "importPipelineName": "myImportPipeline" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/importPipelines/myImportPipeline", + "name": "myImportPipeline", + "type": "Microsoft.ContainerRegistry/registries/importPipelines", + "properties": { + "source": { + "type": "AzureStorageBlobContainer", + "uri": "https://accountname.blob.core.windows.net/containername", + "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrimportsas" + }, + "trigger": { + "sourceTrigger": { + "status": "Enabled" + } + }, + "options": [ + "OverwriteTags", + "DeleteSourceBlobOnSuccess", + "ContinueOnErrors" + ], + "provisioningState": "Succeeded" + }, + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/f9d7ebed-adbd-4cb4-b973-aaf82c136138/resourcegroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": { + "clientId": "d3ce1bc2-f7d7-4a5b-9979-950f4e57680e", + "principalId": "b6p9f58b-6fbf-4efd-a7e0-fvd46911a466" + } + } + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ImportPipelineList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ImportPipelineList.json new file mode 100644 index 000000000000..7a6c7c1046bf --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ImportPipelineList.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/importPipelines/myImportPipeline", + "name": "myImportPipeline", + "type": "Microsoft.ContainerRegistry/registries/importPipelines", + "properties": { + "source": { + "type": "AzureStorageBlobContainer", + "uri": "https://accountname.blob.core.windows.net/containername", + "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrimportsas" + }, + "trigger": { + "sourceTrigger": { + "status": "Enabled" + } + }, + "options": [ + "OverwriteTags", + "DeleteSourceBlobOnSuccess", + "ContinueOnErrors" + ], + "provisioningState": "Succeeded" + }, + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/f9d7ebed-adbd-4cb4-b973-aaf82c136138/resourcegroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": { + "clientId": "d3ce1bc2-f7d7-4a5b-9979-950f4e57680e", + "principalId": "b6p9f58b-6fbf-4efd-a7e0-fvd46911a466" + } + } + } + } + ] + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/OperationList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/OperationList.json new file mode 100644 index 000000000000..11d3dba8ecc7 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/OperationList.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ContainerRegistry/locations/deleteVirtualNetworkOrSubnets/action", + "display": { + "provider": "Microsoft ContainerRegistry", + "resource": "", + "operation": "Delete virtual network or subnets notifications", + "description": "Notifies Microsoft.ContainerRegistry that virtual network or subnet is being deleted" + } + } + ] + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/PipelineRunCreate_Export.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/PipelineRunCreate_Export.json new file mode 100644 index 000000000000..cebbc83d4d00 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/PipelineRunCreate_Export.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "pipelineRunName": "myPipelineRun", + "pipelineRunCreateParameters": { + "properties": { + "request": { + "pipelineResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/exportPipelines/myExportPipeline", + "target": { + "type": "AzureStorageBlob", + "name": "myblob.tar.gz" + }, + "artifacts": [ + "sourceRepository/hello-world", + "sourceRepository2@sha256:00000000000000000000000000000000000" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/pipelineRuns/myPipelineRun", + "name": "myPipelineRun", + "type": "Microsoft.ContainerRegistry/registries/pipelineRuns", + "properties": { + "request": { + "pipelineResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/exportPipelines/myExportPipeline", + "artifacts": [ + "sourceRepository/hello-world", + "sourceRepository2@sha256:00000000000000000000000000000000000" + ] + }, + "response": { + "status": "Running", + "catalogDigest": "sha256@", + "progress": { + "percentage": "20" + }, + "startTime": "2020-03-04T17:23:21.9261521+00:00", + "target": { + "type": "AzureStorageBlob", + "uri": "https://accountname.blob.core.windows.net/containername/myblob.tar.gz", + "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrexportsas" + } + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/pipelineRuns/myPipelineRun", + "name": "myPipelineRun", + "type": "Microsoft.ContainerRegistry/registries/pipelineRuns", + "properties": { + "request": { + "pipelineResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/exportPipelines/myExportPipeline", + "artifacts": [ + "sourceRepository/hello-world", + "sourceRepository2@sha256:00000000000000000000000000000000000" + ] + }, + "response": { + "status": "Running", + "catalogDigest": "sha256@", + "progress": { + "percentage": "20" + }, + "startTime": "2020-03-04T17:23:21.9261521+00:00", + "target": { + "type": "AzureStorageBlob", + "uri": "https://accountname.blob.core.windows.net/containername/myblob.tar.gz", + "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrexportsas" + } + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/PipelineRunCreate_Import.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/PipelineRunCreate_Import.json new file mode 100644 index 000000000000..0c53d646f713 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/PipelineRunCreate_Import.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "pipelineRunName": "myPipelineRun", + "pipelineRunCreateParameters": { + "properties": { + "request": { + "pipelineResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/importPipelines/myImportPipeline", + "source": { + "type": "AzureStorageBlob", + "name": "myblob.tar.gz" + }, + "catalogDigest": "sha256@" + }, + "forceUpdateTag": "2020-03-04T17:23:21.9261521+00:00" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/pipelineRuns/myPipelineRun", + "name": "myPipelineRun", + "type": "Microsoft.ContainerRegistry/registries/pipelineRuns", + "properties": { + "request": { + "pipelineResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/importPipelines/myImportPipeline" + }, + "response": { + "status": "Succeeded", + "progress": { + "percentage": "100" + }, + "startTime": "2020-03-04T17:23:21.9261521+00:00", + "importedArtifacts": [ + "sourceRepository/hello-world", + "sourceRepository2@sha256:00000000000000000000000000000000000" + ], + "source": { + "type": "AzureStorageBlob", + "uri": "https://accountname.blob.core.windows.net/containername/myblob.tar.gz", + "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrimportsas" + }, + "catalogDigest": "sha256@" + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/pipelineRuns/myPipelineRun", + "name": "myPipelineRun", + "type": "Microsoft.ContainerRegistry/registries/pipelineRuns", + "properties": { + "request": { + "pipelineResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/importPipelines/myImportPipeline" + }, + "response": { + "status": "Succeeded", + "progress": { + "percentage": "100" + }, + "startTime": "2020-03-04T17:23:21.9261521+00:00", + "finishTime": "2020-03-04T17:25:21.9261521+00:00", + "importedArtifacts": [ + "sourceRepository/hello-world", + "sourceRepository2@sha256:00000000000000000000000000000000000" + ], + "source": { + "type": "AzureStorageBlob", + "uri": "https://accountname.blob.core.windows.net/containername/myblob.tar.gz", + "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrimportsas" + }, + "catalogDigest": "sha256@" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/PipelineRunDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/PipelineRunDelete.json new file mode 100644 index 000000000000..1ca716bbfa93 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/PipelineRunDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "pipelineRunName": "myPipelineRun" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/PipelineRunGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/PipelineRunGet.json new file mode 100644 index 000000000000..524c74e2c8ad --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/PipelineRunGet.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "pipelineRunName": "myPipelineRun" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/pipelineRuns/myPipelineRun", + "name": "myPipelineRun", + "type": "Microsoft.ContainerRegistry/registries/pipelineRuns", + "properties": { + "request": { + "pipelineResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/exportPipelines/myExportPipeline", + "artifacts": [ + "sourceRepository/hello-world", + "sourceRepository2@sha256:00000000000000000000000000000000000" + ] + }, + "response": { + "status": "Running", + "catalogDigest": "sha256@", + "progress": { + "percentage": "20" + }, + "startTime": "2020-03-04T17:23:21.9261521+00:00", + "target": { + "type": "AzureStorageBlob", + "uri": "https://accountname.blob.core.windows.net/containername/myblob.tar.gz", + "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrexportsas" + } + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/PipelineRunList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/PipelineRunList.json new file mode 100644 index 000000000000..d80e6d94d79f --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/PipelineRunList.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/pipelineRuns/myPipelineRun", + "name": "myPipelineRun", + "type": "Microsoft.ContainerRegistry/registries/pipelineRuns", + "properties": { + "request": { + "pipelineResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/exportPipelines/myExportPipeline", + "artifacts": [ + "sourceRepository/hello-world", + "sourceRepository2@sha256:00000000000000000000000000000000000" + ] + }, + "response": { + "status": "Running", + "catalogDigest": "sha256@", + "progress": { + "percentage": "20" + }, + "startTime": "2020-03-04T17:23:21.9261521+00:00", + "target": { + "type": "AzureStorageBlob", + "uri": "https://accountname.blob.core.windows.net/containername/myblob.tar.gz", + "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrexportsas" + } + }, + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/pipelineRuns/myPipelineRun", + "name": "myPipelineRun", + "type": "Microsoft.ContainerRegistry/registries/pipelineRuns", + "properties": { + "request": { + "pipelineResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/importPipelines/myImportPipeline" + }, + "response": { + "status": "Succeeded", + "progress": { + "percentage": "100" + }, + "startTime": "2020-03-03T17:23:21.9261521+00:00", + "importedArtifacts": [ + "sourceRepository/hello-world", + "sourceRepository2@sha256:00000000000000000000000000000000000" + ], + "source": { + "type": "AzureStorageBlob", + "uri": "https://accountname.blob.core.windows.net/containername/myblob.tar.gz", + "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrimportsas" + }, + "catalogDigest": "sha256@" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/PrivateEndpointConnectionCreateOrUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/PrivateEndpointConnectionCreateOrUpdate.json new file mode 100644 index 000000000000..b3c20c4f50be --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/PrivateEndpointConnectionCreateOrUpdate.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "privateEndpointConnectionName": "myConnection", + "privateEndpointConnection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/privateEndpointConnections/myConnection", + "name": "myConnection", + "type": "Microsoft.ContainerRegistry/registries/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/peexample01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/privateEndpointConnections/myConnection", + "name": "myConnection", + "type": "Microsoft.ContainerRegistry/registries/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/peexample01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/PrivateEndpointConnectionDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/PrivateEndpointConnectionDelete.json new file mode 100644 index 000000000000..5d8236906e68 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/PrivateEndpointConnectionDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "privateEndpointConnectionName": "myConnection" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/PrivateEndpointConnectionGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/PrivateEndpointConnectionGet.json new file mode 100644 index 000000000000..48046a33586a --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/PrivateEndpointConnectionGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "privateEndpointConnectionName": "myConnection" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/privateEndpointConnections/myConnection", + "name": "myConnection", + "type": "Microsoft.ContainerRegistry/registries/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/peexample01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/PrivateEndpointConnectionList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/PrivateEndpointConnectionList.json new file mode 100644 index 000000000000..4c0c2d1f547b --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/PrivateEndpointConnectionList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/privateEndpointConnections/myConnection", + "name": "myConnection", + "type": "Microsoft.ContainerRegistry/registries/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/peexample01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryCheckNameAvailable.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryCheckNameAvailable.json new file mode 100644 index 000000000000..bc0c0499f824 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryCheckNameAvailable.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "registryNameCheckRequest": { + "name": "myRegistry", + "type": "Microsoft.ContainerRegistry/registries" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryCheckNameNotAvailable.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryCheckNameNotAvailable.json new file mode 100644 index 000000000000..a8737b5ec556 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryCheckNameNotAvailable.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "registryNameCheckRequest": { + "name": "myRegistry", + "type": "Microsoft.ContainerRegistry/registries" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "The registry myRegistry is already in use." + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryCreate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryCreate.json new file mode 100644 index 000000000000..3ccaa4e942d3 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryCreate.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "registry": { + "location": "westus", + "tags": { + "key": "value" + }, + "sku": { + "name": "Standard" + }, + "properties": { + "adminUserEnabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry", + "name": "myRegistry", + "type": "Microsoft.ContainerRegistry/registries", + "location": "westus", + "tags": { + "key": "value" + }, + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "loginServer": "myRegistry.azurecr-test.io", + "creationDate": "2021-06-15T21:38:26.1537861Z", + "provisioningState": "Succeeded", + "adminUserEnabled": true, + "networkRuleSet": { + "defaultAction": "Allow", + "virtualNetworkRules": [], + "ipRules": [] + }, + "policies": { + "quarantinePolicy": { + "status": "disabled" + }, + "trustPolicy": { + "type": "Notary", + "status": "disabled" + }, + "retentionPolicy": { + "days": 7, + "lastUpdatedTime": "2021-06-15T21:40:12.8506835+00:00", + "status": "disabled" + }, + "exportPolicy": { + "status": "enabled" + } + }, + "encryption": { + "status": "disabled" + }, + "status": null, + "dataEndpointEnabled": false, + "dataEndpointHostNames": [], + "privateEndpointConnections": [], + "publicNetworkAccess": "Enabled", + "networkRuleBypassOptions": "AzureServices", + "zoneRedundancy": "Disabled", + "anonymousPullEnabled": false + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry", + "name": "myRegistry", + "type": "Microsoft.ContainerRegistry/registries", + "location": "westus", + "tags": { + "key": "value" + }, + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "loginServer": "myRegistry.azurecr-test.io", + "creationDate": "2021-06-15T21:38:26.1537861Z", + "provisioningState": "Creating", + "adminUserEnabled": true, + "networkRuleSet": { + "defaultAction": "Allow", + "virtualNetworkRules": [], + "ipRules": [] + }, + "policies": { + "quarantinePolicy": { + "status": "disabled" + }, + "trustPolicy": { + "type": "Notary", + "status": "disabled" + }, + "retentionPolicy": { + "days": 7, + "lastUpdatedTime": "2021-06-15T21:40:12.8506835+00:00", + "status": "disabled" + }, + "exportPolicy": { + "status": "enabled" + } + }, + "encryption": { + "status": "disabled" + }, + "status": null, + "dataEndpointEnabled": false, + "dataEndpointHostNames": [], + "privateEndpointConnections": [], + "publicNetworkAccess": "Enabled", + "networkRuleBypassOptions": "AzureServices", + "zoneRedundancy": "Disabled", + "anonymousPullEnabled": false + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryCreateZoneRedundant.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryCreateZoneRedundant.json new file mode 100644 index 000000000000..1cdef6492e3b --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryCreateZoneRedundant.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "registry": { + "location": "westus", + "tags": { + "key": "value" + }, + "sku": { + "name": "Standard" + }, + "properties": { + "zoneRedundancy": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry", + "name": "myRegistry", + "type": "Microsoft.ContainerRegistry/registries", + "location": "westus", + "tags": { + "key": "value" + }, + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "loginServer": "myRegistry.azurecr-test.io", + "creationDate": "2021-06-15T21:38:26.1537861Z", + "provisioningState": "Succeeded", + "adminUserEnabled": false, + "networkRuleSet": { + "defaultAction": "Allow", + "virtualNetworkRules": [], + "ipRules": [] + }, + "policies": { + "quarantinePolicy": { + "status": "disabled" + }, + "trustPolicy": { + "type": "Notary", + "status": "disabled" + }, + "retentionPolicy": { + "days": 7, + "lastUpdatedTime": "2021-06-15T21:40:12.8506835+00:00", + "status": "disabled" + }, + "exportPolicy": { + "status": "enabled" + } + }, + "encryption": { + "status": "disabled" + }, + "status": null, + "dataEndpointEnabled": false, + "dataEndpointHostNames": [], + "privateEndpointConnections": [], + "publicNetworkAccess": "Enabled", + "networkRuleBypassOptions": "AzureServices", + "zoneRedundancy": "Enabled", + "anonymousPullEnabled": false + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry", + "name": "myRegistry", + "type": "Microsoft.ContainerRegistry/registries", + "location": "westus", + "tags": { + "key": "value" + }, + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "loginServer": "myRegistry.azurecr-test.io", + "creationDate": "2021-06-15T21:38:26.1537861Z", + "provisioningState": "Creating", + "adminUserEnabled": false, + "networkRuleSet": { + "defaultAction": "Allow", + "virtualNetworkRules": [], + "ipRules": [] + }, + "policies": { + "quarantinePolicy": { + "status": "disabled" + }, + "trustPolicy": { + "type": "Notary", + "status": "disabled" + }, + "retentionPolicy": { + "days": 7, + "lastUpdatedTime": "2021-06-15T21:40:12.8506835+00:00", + "status": "disabled" + }, + "exportPolicy": { + "status": "enabled" + } + }, + "encryption": { + "status": "disabled" + }, + "status": null, + "dataEndpointEnabled": false, + "dataEndpointHostNames": [], + "privateEndpointConnections": [], + "publicNetworkAccess": "Enabled", + "networkRuleBypassOptions": "AzureServices", + "zoneRedundancy": "Enabled", + "anonymousPullEnabled": false + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryDelete.json new file mode 100644 index 000000000000..b393b2af36c9 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryGenerateCredentials.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryGenerateCredentials.json new file mode 100644 index 000000000000..eed1d51965ab --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryGenerateCredentials.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "generateCredentialsParameters": { + "tokenId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/myToken", + "expiry": "2020-12-31T15:59:59.0707808Z" + } + }, + "responses": { + "200": { + "body": { + "username": "myToken", + "passwords": [ + { + "expiry": "2020-12-31T15:59:59.0707808Z", + "name": "password1", + "value": "00000000000000000000000000000000" + }, + { + "expiry": "2020-12-31T15:59:59.0707808Z", + "name": "password2", + "value": "00000000000000000000000000000000" + } + ] + } + }, + "202": {} + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryGet.json new file mode 100644 index 000000000000..30203f5e170b --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryGet.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry", + "name": "myRegistry", + "type": "Microsoft.ContainerRegistry/registries", + "location": "westus", + "tags": { + "key": "value" + }, + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "loginServer": "myRegistry.azurecr-test.io", + "creationDate": "2021-06-15T21:38:26.1537861Z", + "provisioningState": "Succeeded", + "adminUserEnabled": false, + "networkRuleSet": { + "defaultAction": "Allow", + "virtualNetworkRules": [], + "ipRules": [] + }, + "policies": { + "quarantinePolicy": { + "status": "disabled" + }, + "trustPolicy": { + "type": "Notary", + "status": "disabled" + }, + "retentionPolicy": { + "days": 7, + "lastUpdatedTime": "2021-06-15T21:40:12.8506835+00:00", + "status": "disabled" + }, + "exportPolicy": { + "status": "enabled" + } + }, + "encryption": { + "status": "disabled" + }, + "status": null, + "dataEndpointEnabled": false, + "dataEndpointHostNames": [], + "privateEndpointConnections": [], + "publicNetworkAccess": "Enabled", + "networkRuleBypassOptions": "AzureServices", + "zoneRedundancy": "Disabled", + "anonymousPullEnabled": false + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryList.json new file mode 100644 index 000000000000..e41ecfd31a7e --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryList.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry", + "name": "myRegistry", + "type": "Microsoft.ContainerRegistry/registries", + "location": "westus", + "tags": { + "key": "value" + }, + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "loginServer": "myRegistry.azurecr-test.io", + "creationDate": "2021-06-15T21:38:26.1537861Z", + "provisioningState": "Succeeded", + "adminUserEnabled": false, + "networkRuleSet": { + "defaultAction": "Allow", + "virtualNetworkRules": [], + "ipRules": [] + }, + "policies": { + "quarantinePolicy": { + "status": "disabled" + }, + "trustPolicy": { + "type": "Notary", + "status": "disabled" + }, + "retentionPolicy": { + "days": 7, + "lastUpdatedTime": "2021-06-15T21:40:12.8506835+00:00", + "status": "disabled" + }, + "exportPolicy": { + "status": "enabled" + } + }, + "encryption": { + "status": "disabled" + }, + "status": null, + "dataEndpointEnabled": false, + "dataEndpointHostNames": [], + "privateEndpointConnections": [], + "publicNetworkAccess": "Enabled", + "networkRuleBypassOptions": "AzureServices", + "zoneRedundancy": "Disabled", + "anonymousPullEnabled": false + } + } + ] + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryListByResourceGroup.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryListByResourceGroup.json new file mode 100644 index 000000000000..5fdf7ce6514e --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryListByResourceGroup.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry", + "name": "myRegistry", + "type": "Microsoft.ContainerRegistry/registries", + "location": "westus", + "tags": { + "key": "value" + }, + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "loginServer": "myRegistry.azurecr-test.io", + "creationDate": "2021-06-15T21:38:26.1537861Z", + "provisioningState": "Succeeded", + "adminUserEnabled": false, + "networkRuleSet": { + "defaultAction": "Allow", + "virtualNetworkRules": [], + "ipRules": [] + }, + "policies": { + "quarantinePolicy": { + "status": "disabled" + }, + "trustPolicy": { + "type": "Notary", + "status": "disabled" + }, + "retentionPolicy": { + "days": 7, + "lastUpdatedTime": "2021-06-15T21:40:12.8506835+00:00", + "status": "disabled" + }, + "exportPolicy": { + "status": "enabled" + } + }, + "encryption": { + "status": "disabled" + }, + "status": null, + "dataEndpointEnabled": false, + "dataEndpointHostNames": [], + "privateEndpointConnections": [], + "publicNetworkAccess": "Enabled", + "networkRuleBypassOptions": "AzureServices", + "zoneRedundancy": "Disabled", + "anonymousPullEnabled": false + } + } + ] + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryListCredentials.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryListCredentials.json new file mode 100644 index 000000000000..877f006de865 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryListCredentials.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry" + }, + "responses": { + "200": { + "body": { + "username": "myRegistry", + "passwords": [ + { + "name": "password", + "value": "00000000000000000000000000000000" + }, + { + "name": "password2", + "value": "00000000000000000000000000000000" + } + ] + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryListPrivateLinkResources.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryListPrivateLinkResources.json new file mode 100644 index 000000000000..ac92b0afd81e --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryListPrivateLinkResources.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/privateLinkResources/registry", + "name": "registry", + "type": "Microsoft.ContainerRegistry/registries/privateLinkResources", + "properties": { + "groupId": "registry", + "requiredMembers": [ + "registry", + "registry_data_myregion" + ], + "requiredZoneNames": [ + "privatelink.azurecr.io" + ] + } + } + ] + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryListUsages.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryListUsages.json new file mode 100644 index 000000000000..ff7ddaec297b --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryListUsages.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Size", + "limit": 107374182400, + "currentValue": 12345678, + "unit": "Bytes" + }, + { + "name": "Webhooks", + "limit": 10, + "currentValue": 2, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryRegenerateCredential.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryRegenerateCredential.json new file mode 100644 index 000000000000..f9d059f6aff3 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryRegenerateCredential.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "regenerateCredentialParameters": { + "name": "password" + } + }, + "responses": { + "200": { + "body": { + "username": "myRegistry", + "passwords": [ + { + "name": "password", + "value": "00000000000000000000000000000000" + }, + { + "name": "password2", + "value": "00000000000000000000000000000000" + } + ] + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryUpdate.json new file mode 100644 index 000000000000..144512b97f19 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/RegistryUpdate.json @@ -0,0 +1,129 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "registryUpdateParameters": { + "tags": { + "key": "value" + }, + "sku": { + "name": "Standard" + }, + "properties": { + "adminUserEnabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry", + "name": "myRegistry", + "type": "Microsoft.ContainerRegistry/registries", + "location": "westus", + "tags": { + "key": "value" + }, + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "loginServer": "myRegistry.azurecr-test.io", + "creationDate": "2021-06-15T21:38:26.1537861Z", + "provisioningState": "Succeeded", + "adminUserEnabled": true, + "networkRuleSet": { + "defaultAction": "Allow", + "virtualNetworkRules": [], + "ipRules": [] + }, + "policies": { + "quarantinePolicy": { + "status": "disabled" + }, + "trustPolicy": { + "type": "Notary", + "status": "disabled" + }, + "retentionPolicy": { + "days": 7, + "lastUpdatedTime": "2021-06-15T21:40:12.8506835+00:00", + "status": "disabled" + }, + "exportPolicy": { + "status": "enabled" + } + }, + "encryption": { + "status": "disabled" + }, + "status": null, + "dataEndpointEnabled": false, + "dataEndpointHostNames": [], + "privateEndpointConnections": [], + "publicNetworkAccess": "Enabled", + "networkRuleBypassOptions": "AzureServices", + "zoneRedundancy": "Disabled", + "anonymousPullEnabled": false + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry", + "name": "myRegistry", + "type": "Microsoft.ContainerRegistry/registries", + "location": "westus", + "tags": { + "key": "value" + }, + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "loginServer": "myRegistry.azurecr-test.io", + "creationDate": "2021-06-15T21:38:26.1537861Z", + "provisioningState": "Updating", + "adminUserEnabled": true, + "networkRuleSet": { + "defaultAction": "Allow", + "virtualNetworkRules": [], + "ipRules": [] + }, + "policies": { + "quarantinePolicy": { + "status": "disabled" + }, + "trustPolicy": { + "type": "Notary", + "status": "disabled" + }, + "retentionPolicy": { + "days": 7, + "lastUpdatedTime": "2021-06-15T21:40:12.8506835+00:00", + "status": "disabled" + }, + "exportPolicy": { + "status": "enabled" + } + }, + "encryption": { + "status": "disabled" + }, + "status": null, + "dataEndpointEnabled": false, + "dataEndpointHostNames": [], + "privateEndpointConnections": [], + "publicNetworkAccess": "Enabled", + "networkRuleBypassOptions": "AzureServices", + "zoneRedundancy": "Disabled", + "anonymousPullEnabled": false + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ReplicationCreate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ReplicationCreate.json new file mode 100644 index 000000000000..f31b4cd3d7cd --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ReplicationCreate.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "replicationName": "myReplication", + "replication": { + "location": "eastus", + "tags": { + "key": "value" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication", + "name": "myReplication", + "type": "Microsoft.ContainerRegistry/registries/replications", + "location": "eastus", + "tags": { + "key": "value" + }, + "properties": { + "provisioningState": "Succeeded", + "status": { + "displayStatus": "Ready", + "message": "The replication is ready.", + "timestamp": "2017-03-01T23:15:37.0707808Z" + }, + "regionEndpointEnabled": true, + "zoneRedundancy": "Disabled" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication", + "name": "myReplication", + "type": "Microsoft.ContainerRegistry/registries/replications", + "location": "eastus", + "tags": { + "key": "value" + }, + "properties": { + "provisioningState": "Creating", + "status": { + "displayStatus": "Provisioning", + "message": "The replication is provisioning.", + "timestamp": "2017-03-01T23:15:37.0707808Z" + }, + "regionEndpointEnabled": true, + "zoneRedundancy": "Disabled" + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ReplicationCreateZoneRedundant.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ReplicationCreateZoneRedundant.json new file mode 100644 index 000000000000..a59bbff8f669 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ReplicationCreateZoneRedundant.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "replicationName": "myReplication", + "replication": { + "location": "eastus", + "tags": { + "key": "value" + }, + "properties": { + "regionEndpointEnabled": true, + "zoneRedundancy": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication", + "name": "myReplication", + "type": "Microsoft.ContainerRegistry/registries/replications", + "location": "eastus", + "tags": { + "key": "value" + }, + "properties": { + "provisioningState": "Succeeded", + "status": { + "displayStatus": "Ready", + "message": "The replication is ready.", + "timestamp": "2017-03-01T23:15:37.0707808Z" + }, + "regionEndpointEnabled": true, + "zoneRedundancy": "Enabled" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication", + "name": "myReplication", + "type": "Microsoft.ContainerRegistry/registries/replications", + "location": "eastus", + "tags": { + "key": "value" + }, + "properties": { + "provisioningState": "Creating", + "status": { + "displayStatus": "Provisioning", + "message": "The replication is provisioning.", + "timestamp": "2017-03-01T23:15:37.0707808Z" + }, + "regionEndpointEnabled": true, + "zoneRedundancy": "Enabled" + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ReplicationDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ReplicationDelete.json new file mode 100644 index 000000000000..edf305fe9f9f --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ReplicationDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "replicationName": "myReplication" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ReplicationGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ReplicationGet.json new file mode 100644 index 000000000000..afee7df00e38 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ReplicationGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "replicationName": "myReplication" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication", + "name": "myReplication", + "type": "Microsoft.ContainerRegistry/registries/replications", + "location": "eastus", + "tags": { + "key": "value" + }, + "properties": { + "provisioningState": "Succeeded", + "status": { + "displayStatus": "Ready", + "message": "The replication is ready.", + "timestamp": "2017-03-01T23:15:37.0707808Z" + }, + "regionEndpointEnabled": true, + "zoneRedundancy": "Disabled" + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ReplicationList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ReplicationList.json new file mode 100644 index 000000000000..ad9ba1b7d8e8 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ReplicationList.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication", + "name": "myReplication", + "type": "Microsoft.ContainerRegistry/registries/replications", + "location": "eastus", + "tags": { + "key": "value" + }, + "properties": { + "provisioningState": "Succeeded", + "status": { + "displayStatus": "Ready", + "message": "The replication is ready.", + "timestamp": "2017-03-01T23:15:37.0707808Z" + }, + "regionEndpointEnabled": true, + "zoneRedundancy": "Disabled" + } + } + ] + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ReplicationUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ReplicationUpdate.json new file mode 100644 index 000000000000..9038ad2d753b --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ReplicationUpdate.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "replicationName": "myReplication", + "replicationUpdateParameters": { + "tags": { + "key": "value" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication", + "name": "myReplication", + "type": "Microsoft.ContainerRegistry/registries/replications", + "location": "eastus", + "tags": { + "key": "value" + }, + "properties": { + "provisioningState": "Succeeded", + "status": { + "displayStatus": "Ready", + "message": "The replication is ready.", + "timestamp": "2017-03-01T23:15:37.0707808Z" + }, + "regionEndpointEnabled": true, + "zoneRedundancy": "Disabled" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication", + "name": "myReplication", + "type": "Microsoft.ContainerRegistry/registries/replications", + "location": "eastus", + "tags": { + "key": "value" + }, + "properties": { + "provisioningState": "Updating", + "status": { + "displayStatus": "Provisioning", + "message": "The replication is provisioning.", + "timestamp": "2017-03-01T23:15:37.0707808Z" + }, + "regionEndpointEnabled": true, + "zoneRedundancy": "Disabled" + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ScopeMapCreate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ScopeMapCreate.json new file mode 100644 index 000000000000..42f30cf7c3d2 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ScopeMapCreate.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "scopeMapName": "myScopeMap", + "scopeMapCreateParameters": { + "properties": { + "description": "Developer Scopes", + "actions": [ + "repositories/myrepository/contentWrite", + "repositories/myrepository/delete" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap", + "name": "myScopeMap", + "type": "Microsoft.ContainerRegistry/registries/scopeMaps", + "properties": { + "creationDate": "2017-03-01T23:14:37.0707808Z", + "type": "IsUserDefined", + "actions": [ + "repositories/myrepository/contentWrite", + "repositories/myrepository/delete" + ], + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap", + "name": "myScopeMap", + "type": "Microsoft.ContainerRegistry/registries/scopeMaps", + "properties": { + "creationDate": "2017-03-01T23:14:37.0707808Z", + "type": "IsUserDefined", + "actions": [ + "repositories/myrepository/contentWrite", + "repositories/myrepository/delete" + ], + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ScopeMapDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ScopeMapDelete.json new file mode 100644 index 000000000000..cc7b2e0789c4 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ScopeMapDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "scopeMapName": "myScopeMap" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ScopeMapGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ScopeMapGet.json new file mode 100644 index 000000000000..bb81f97ded98 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ScopeMapGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "scopeMapName": "myScopeMap" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap", + "name": "myScopeMap", + "type": "Microsoft.ContainerRegistry/registries/scopeMaps", + "properties": { + "creationDate": "2017-03-01T23:14:37.0707808Z", + "type": "IsUserDefined", + "actions": [ + "repositories/myrepository/contentWrite", + "repositories/myrepository/delete" + ], + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ScopeMapList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ScopeMapList.json new file mode 100644 index 000000000000..01bd88789218 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ScopeMapList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap", + "name": "myScopeMap", + "type": "Microsoft.ContainerRegistry/registries/scopeMaps", + "properties": { + "creationDate": "2017-03-01T23:14:37.0707808Z", + "type": "IsUserDefined", + "actions": [ + "repositories/myrepository/contentWrite", + "repositories/myrepository/delete" + ], + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ScopeMapUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ScopeMapUpdate.json new file mode 100644 index 000000000000..f9b0ef8b4035 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/ScopeMapUpdate.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "scopeMapName": "myScopeMap", + "scopeMapUpdateParameters": { + "properties": { + "description": "Developer Scopes", + "actions": [ + "repositories/myrepository/contentWrite", + "repositories/myrepository/contentRead" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap", + "name": "myScopeMap", + "type": "Microsoft.ContainerRegistry/registries/scopeMaps", + "properties": { + "creationDate": "2017-03-01T23:14:37.0707808Z", + "type": "IsUserDefined", + "actions": [ + "repositories/myrepository/contentWrite", + "repositories/myrepository/contentRead" + ], + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap", + "name": "myScopeMap", + "type": "Microsoft.ContainerRegistry/registries/scopeMaps", + "properties": { + "creationDate": "2017-03-01T23:14:37.0707808Z", + "type": "IsUserDefined", + "actions": [ + "repositories/myrepository/contentWrite", + "repositories/myrepository/contentRead" + ], + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/TokenCreate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/TokenCreate.json new file mode 100644 index 000000000000..80bb4872fc57 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/TokenCreate.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "tokenName": "myToken", + "tokenCreateParameters": { + "properties": { + "scopeMapId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap", + "status": "disabled", + "credentials": { + "certificates": [ + { + "name": "certificate1", + "encodedPemCertificate": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUc3akNDQk5hZ0F3SUJBZ0lURmdBQlR3UVpyZGdmdmhxdzBnQUFBQUZQQkRBTkJna3Foa2lHOXcwQkFRc0YKQURDQml6RUxNQWtHQTFVRUJoTUNWVk14RXpBUkJnTlZCQWdUQ2xkaGMyaHBibWQwYjI0eEVEQU9CZ05WQkFjVApCMUpsWkcxdmJtUXhIakFjQmdOVkJBb1RGVTFwWTNKdmMyOW1kQ0JEYjNKd2IzSmhkR2x2YmpFVk1CTUdBMVVFCkN4TU1UV2xqY205emIyWjBJRWxVTVI0d0hBWURWUVFERXhWTmFXTnliM052Wm5RZ1NWUWdWRXhUSUVOQklEUXcKSGhjTk1UZ3dOREV5TWpJek1qUTRXaGNOTWpBd05ERXlNakl6TWpRNFdqQTVNVGN3TlFZRFZRUURFeTV6WlhKMgphV05sWTJ4cFpXNTBZMlZ5ZEMxd1lYSjBibVZ5TG0xaGJtRm5aVzFsYm5RdVlYcDFjbVV1WTI5dE1JSUJJakFOCkJna3Foa2lHOXcwQkFRRUZBQU9DQVE4QU1JSUJDZ0tDQVFFQTBSYjdJcHpxMmR4emhhbVpyS1ZDakMzeTQyYlYKUnNIY2pCUTFuSDBHZ1puUDhXeDZDSE1mWThybkVJQzRLeVRRYkJXVzhnNXlmc3NSQ0ZXbFpxYjR6SkRXS0pmTgpGSmNMUm9LNnhwTktZYVZVTkVlT25IdUxHYTM0ZlA0VjBFRjZybzdvbkRLME5zanhjY1dZVzRNVXVzc0xrQS94CkUrM2RwU1REdk1KcjJoWUpsVnFDcVR6blQvbmZaVUZzQUVEQnp5MUpOOHZiZDlIR2czc2Myd0x4dk95cFJOc0gKT1V3V2pmN2xzWWZleEVlcWkzY29EeHc2alpLVWEyVkdsUnBpTkowMjhBQitYSi9TU1FVNVBsd0JBbU9TT3ovRApGY0NKdGpPZlBqU1NKckFIQVV3SHU3RzlSV05JTFBwYU9zQ1J5eitETE5zNGpvNlEvUUg4d1lManJRSURBUUFCCm80SUNtakNDQXBZd0N3WURWUjBQQkFRREFnU3dNQjBHQTFVZEpRUVdNQlFHQ0NzR0FRVUZCd01DQmdnckJnRUYKQlFjREFUQWRCZ05WSFE0RUZnUVVlbEdkVVJrZzJoSFFOWEQ4WUc4L3drdjJVT0F3SHdZRFZSMGpCQmd3Rm9BVQplbnVNd2Mvbm9Nb2MxR3Y2KytFend3OGFvcDB3Z2F3R0ExVWRId1NCcERDQm9UQ0JucUNCbTZDQm1JWkxhSFIwCmNEb3ZMMjF6WTNKc0xtMXBZM0p2YzI5bWRDNWpiMjB2Y0d0cEwyMXpZMjl5Y0M5amNtd3ZUV2xqY205emIyWjAKSlRJd1NWUWxNakJVVEZNbE1qQkRRU1V5TURRdVkzSnNoa2xvZEhSd09pOHZZM0pzTG0xcFkzSnZjMjltZEM1agpiMjB2Y0d0cEwyMXpZMjl5Y0M5amNtd3ZUV2xqY205emIyWjBKVEl3U1ZRbE1qQlVURk1sTWpCRFFTVXlNRFF1ClkzSnNNSUdGQmdnckJnRUZCUWNCQVFSNU1IY3dVUVlJS3dZQkJRVUhNQUtHUldoMGRIQTZMeTkzZDNjdWJXbGoKY205emIyWjBMbU52YlM5d2Eya3ZiWE5qYjNKd0wwMXBZM0p2YzI5bWRDVXlNRWxVSlRJd1ZFeFRKVEl3UTBFbApNakEwTG1OeWREQWlCZ2dyQmdFRkJRY3dBWVlXYUhSMGNEb3ZMMjlqYzNBdWJYTnZZM053TG1OdmJUQStCZ2tyCkJnRUVBWUkzRlFjRU1UQXZCaWNyQmdFRUFZSTNGUWlIMm9aMWcrN1pBWUxKaFJ1QnRaNWhoZlRyWUlGZGhOTGYKUW9Mbmszb0NBV1FDQVIwd1RRWURWUjBnQkVZd1JEQkNCZ2tyQmdFRUFZSTNLZ0V3TlRBekJnZ3JCZ0VGQlFjQwpBUlluYUhSMGNEb3ZMM2QzZHk1dGFXTnliM052Wm5RdVkyOXRMM0JyYVM5dGMyTnZjbkF2WTNCek1DY0dDU3NHCkFRUUJnamNWQ2dRYU1CZ3dDZ1lJS3dZQkJRVUhBd0l3Q2dZSUt3WUJCUVVIQXdFd09RWURWUjBSQkRJd01JSXUKYzJWeWRtbGpaV05zYVdWdWRHTmxjblF0Y0dGeWRHNWxjaTV0WVc1aFoyVnRaVzUwTG1GNmRYSmxMbU52YlRBTgpCZ2txaGtpRzl3MEJBUXNGQUFPQ0FnRUFIVXIzbk1vdUI5WWdDUlRWYndUTllIS2RkWGJkSW1GUXNDYys4T1g1CjE5c0N6dFFSR05iSXEwVW1Ba01MbFVvWTIxckh4ZXdxU2hWczFhL2RwaFh5Tk1pcUdaU2QzU1BtYzZscitqUFQKNXVEREs0MUlWeXN0K2VUNlpyazFvcCtMVmdkeS9EU2lyNzVqcWZFY016bS82bU8rNnFNeWRLTWtVYmM5K3JHVwphUkpUcjRWUUdIRmEwNEIwZVZpNUd4MG9pL2RpZDNSaXg2aXJMMjFJSGEwYjN6c1hzZHpHU0R2K3hqL2Q2S0l4Ckdrd2FhYmZvU1NoQnFqaFNlQ0VyZXFlb1RpYjljdGw0MGRVdUp3THl4bjhHS2N6K3AvMEJUOEIxU3lYK01OQ2wKY0pkMjVtMjhLajY2TGUxOEVyeFlJYXZJVGVGa3Y2eGZjdkEvcHladDdPaU41QTlGQk1IUmpQK1kyZ2tvdjMrcQpISFRUZG4xNnlRajduNit3YlFHNGVleXc0YisyQkRLcUxNVFU2ZmlSQ3ZPM2FPZVBLSFVNN3R4b1FidWl6Z3NzCkNiMzl3QnJOTEZsMkJLQ1RkSCtkSU9oZVJiSkZvbmlwOGRPOUVFZWdSSG9lQW54ZUlYTFBrdXMzTzEvZjRhNkIKWHQ3RG5BUm8xSzJmeEp3VXRaU2MvR3dFSjU5NzlnRXlEa3pDZEVsLzdpWE9QZXVjTXhlM2xVM2pweUtsNERUaApjSkJqQytqNGpLWTFrK1U4b040aGdqYnJISUx6Vnd2eU15OU5KS290U3BMSjQxeHdPOHlGangxalFTT3Bxc0N1ClFhUFUvTjhSZ0hxWjBGTkFzS3dNUmZ6WmdXanRCNzRzYUVEdk5jVmNuNFhCQnFNSG0ydHo2Uzk3d3kxZGt0cTgKSE5BPQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/myToken", + "name": "myToken", + "type": "Microsoft.ContainerRegistry/registries/tokens", + "properties": { + "creationDate": "2017-03-01T23:14:37.0707808Z", + "scopeMapId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap", + "provisioningState": "Succeeded", + "status": "disabled", + "credentials": { + "certificates": [ + { + "name": "certificate1", + "thumbprint": "feeb79a888bf1415f8e17c4965a2a5bb5c8a2ff7", + "expiry": "2020-12-04T15:32:48.0707808Z" + } + ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/myToken", + "name": "myToken", + "type": "Microsoft.ContainerRegistry/registries/tokens", + "properties": { + "creationDate": "2017-03-01T23:14:37.0707808Z", + "scopeMapId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap", + "provisioningState": "Succeeded", + "status": "disabled", + "credentials": { + "certificates": [ + { + "name": "certificate1", + "thumbprint": "feeb79a888bf1415f8e17c4965a2a5bb5c8a2ff7", + "expiry": "2020-12-04T15:32:48.0707808Z" + } + ] + } + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/TokenDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/TokenDelete.json new file mode 100644 index 000000000000..d3a2ee6aaecb --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/TokenDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "tokenName": "myToken" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/TokenGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/TokenGet.json new file mode 100644 index 000000000000..c1b104e24817 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/TokenGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "tokenName": "myToken" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/myToken", + "name": "myToken", + "type": "Microsoft.ContainerRegistry/registries/tokens", + "properties": { + "creationDate": "2017-03-01T23:14:37.0707808Z", + "scopeMapId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap", + "provisioningState": "Succeeded", + "status": "enabled" + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/TokenList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/TokenList.json new file mode 100644 index 000000000000..9255b7c70045 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/TokenList.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/myToken", + "name": "myToken", + "type": "Microsoft.ContainerRegistry/registries/tokens", + "properties": { + "creationDate": "2017-03-01T23:14:37.0707808Z", + "scopeMapId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap", + "provisioningState": "Succeeded", + "status": "enabled" + } + } + ] + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/TokenUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/TokenUpdate.json new file mode 100644 index 000000000000..781fad8871a7 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/TokenUpdate.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "tokenName": "myToken", + "tokenUpdateParameters": { + "properties": { + "scopeMapId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myNewScopeMap", + "credentials": { + "certificates": [ + { + "name": "certificate1", + "encodedPemCertificate": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUc3akNDQk5hZ0F3SUJBZ0lURmdBQlR3UVpyZGdmdmhxdzBnQUFBQUZQQkRBTkJna3Foa2lHOXcwQkFRc0YKQURDQml6RUxNQWtHQTFVRUJoTUNWVk14RXpBUkJnTlZCQWdUQ2xkaGMyaHBibWQwYjI0eEVEQU9CZ05WQkFjVApCMUpsWkcxdmJtUXhIakFjQmdOVkJBb1RGVTFwWTNKdmMyOW1kQ0JEYjNKd2IzSmhkR2x2YmpFVk1CTUdBMVVFCkN4TU1UV2xqY205emIyWjBJRWxVTVI0d0hBWURWUVFERXhWTmFXTnliM052Wm5RZ1NWUWdWRXhUSUVOQklEUXcKSGhjTk1UZ3dOREV5TWpJek1qUTRXaGNOTWpBd05ERXlNakl6TWpRNFdqQTVNVGN3TlFZRFZRUURFeTV6WlhKMgphV05sWTJ4cFpXNTBZMlZ5ZEMxd1lYSjBibVZ5TG0xaGJtRm5aVzFsYm5RdVlYcDFjbVV1WTI5dE1JSUJJakFOCkJna3Foa2lHOXcwQkFRRUZBQU9DQVE4QU1JSUJDZ0tDQVFFQTBSYjdJcHpxMmR4emhhbVpyS1ZDakMzeTQyYlYKUnNIY2pCUTFuSDBHZ1puUDhXeDZDSE1mWThybkVJQzRLeVRRYkJXVzhnNXlmc3NSQ0ZXbFpxYjR6SkRXS0pmTgpGSmNMUm9LNnhwTktZYVZVTkVlT25IdUxHYTM0ZlA0VjBFRjZybzdvbkRLME5zanhjY1dZVzRNVXVzc0xrQS94CkUrM2RwU1REdk1KcjJoWUpsVnFDcVR6blQvbmZaVUZzQUVEQnp5MUpOOHZiZDlIR2czc2Myd0x4dk95cFJOc0gKT1V3V2pmN2xzWWZleEVlcWkzY29EeHc2alpLVWEyVkdsUnBpTkowMjhBQitYSi9TU1FVNVBsd0JBbU9TT3ovRApGY0NKdGpPZlBqU1NKckFIQVV3SHU3RzlSV05JTFBwYU9zQ1J5eitETE5zNGpvNlEvUUg4d1lManJRSURBUUFCCm80SUNtakNDQXBZd0N3WURWUjBQQkFRREFnU3dNQjBHQTFVZEpRUVdNQlFHQ0NzR0FRVUZCd01DQmdnckJnRUYKQlFjREFUQWRCZ05WSFE0RUZnUVVlbEdkVVJrZzJoSFFOWEQ4WUc4L3drdjJVT0F3SHdZRFZSMGpCQmd3Rm9BVQplbnVNd2Mvbm9Nb2MxR3Y2KytFend3OGFvcDB3Z2F3R0ExVWRId1NCcERDQm9UQ0JucUNCbTZDQm1JWkxhSFIwCmNEb3ZMMjF6WTNKc0xtMXBZM0p2YzI5bWRDNWpiMjB2Y0d0cEwyMXpZMjl5Y0M5amNtd3ZUV2xqY205emIyWjAKSlRJd1NWUWxNakJVVEZNbE1qQkRRU1V5TURRdVkzSnNoa2xvZEhSd09pOHZZM0pzTG0xcFkzSnZjMjltZEM1agpiMjB2Y0d0cEwyMXpZMjl5Y0M5amNtd3ZUV2xqY205emIyWjBKVEl3U1ZRbE1qQlVURk1sTWpCRFFTVXlNRFF1ClkzSnNNSUdGQmdnckJnRUZCUWNCQVFSNU1IY3dVUVlJS3dZQkJRVUhNQUtHUldoMGRIQTZMeTkzZDNjdWJXbGoKY205emIyWjBMbU52YlM5d2Eya3ZiWE5qYjNKd0wwMXBZM0p2YzI5bWRDVXlNRWxVSlRJd1ZFeFRKVEl3UTBFbApNakEwTG1OeWREQWlCZ2dyQmdFRkJRY3dBWVlXYUhSMGNEb3ZMMjlqYzNBdWJYTnZZM053TG1OdmJUQStCZ2tyCkJnRUVBWUkzRlFjRU1UQXZCaWNyQmdFRUFZSTNGUWlIMm9aMWcrN1pBWUxKaFJ1QnRaNWhoZlRyWUlGZGhOTGYKUW9Mbmszb0NBV1FDQVIwd1RRWURWUjBnQkVZd1JEQkNCZ2tyQmdFRUFZSTNLZ0V3TlRBekJnZ3JCZ0VGQlFjQwpBUlluYUhSMGNEb3ZMM2QzZHk1dGFXTnliM052Wm5RdVkyOXRMM0JyYVM5dGMyTnZjbkF2WTNCek1DY0dDU3NHCkFRUUJnamNWQ2dRYU1CZ3dDZ1lJS3dZQkJRVUhBd0l3Q2dZSUt3WUJCUVVIQXdFd09RWURWUjBSQkRJd01JSXUKYzJWeWRtbGpaV05zYVdWdWRHTmxjblF0Y0dGeWRHNWxjaTV0WVc1aFoyVnRaVzUwTG1GNmRYSmxMbU52YlRBTgpCZ2txaGtpRzl3MEJBUXNGQUFPQ0FnRUFIVXIzbk1vdUI5WWdDUlRWYndUTllIS2RkWGJkSW1GUXNDYys4T1g1CjE5c0N6dFFSR05iSXEwVW1Ba01MbFVvWTIxckh4ZXdxU2hWczFhL2RwaFh5Tk1pcUdaU2QzU1BtYzZscitqUFQKNXVEREs0MUlWeXN0K2VUNlpyazFvcCtMVmdkeS9EU2lyNzVqcWZFY016bS82bU8rNnFNeWRLTWtVYmM5K3JHVwphUkpUcjRWUUdIRmEwNEIwZVZpNUd4MG9pL2RpZDNSaXg2aXJMMjFJSGEwYjN6c1hzZHpHU0R2K3hqL2Q2S0l4Ckdrd2FhYmZvU1NoQnFqaFNlQ0VyZXFlb1RpYjljdGw0MGRVdUp3THl4bjhHS2N6K3AvMEJUOEIxU3lYK01OQ2wKY0pkMjVtMjhLajY2TGUxOEVyeFlJYXZJVGVGa3Y2eGZjdkEvcHladDdPaU41QTlGQk1IUmpQK1kyZ2tvdjMrcQpISFRUZG4xNnlRajduNit3YlFHNGVleXc0YisyQkRLcUxNVFU2ZmlSQ3ZPM2FPZVBLSFVNN3R4b1FidWl6Z3NzCkNiMzl3QnJOTEZsMkJLQ1RkSCtkSU9oZVJiSkZvbmlwOGRPOUVFZWdSSG9lQW54ZUlYTFBrdXMzTzEvZjRhNkIKWHQ3RG5BUm8xSzJmeEp3VXRaU2MvR3dFSjU5NzlnRXlEa3pDZEVsLzdpWE9QZXVjTXhlM2xVM2pweUtsNERUaApjSkJqQytqNGpLWTFrK1U4b040aGdqYnJISUx6Vnd2eU15OU5KS290U3BMSjQxeHdPOHlGangxalFTT3Bxc0N1ClFhUFUvTjhSZ0hxWjBGTkFzS3dNUmZ6WmdXanRCNzRzYUVEdk5jVmNuNFhCQnFNSG0ydHo2Uzk3d3kxZGt0cTgKSE5BPQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/myToken", + "name": "myToken", + "type": "Microsoft.ContainerRegistry/registries/tokens", + "properties": { + "creationDate": "2017-03-01T23:14:37.0707808Z", + "scopeMapId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myNewScopeMap", + "provisioningState": "Succeeded", + "status": "enabled", + "credentials": { + "certificates": [ + { + "name": "certificate1", + "encodedPemCertificate": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUc3akNDQk5hZ0F3SUJBZ0lURmdBQlR3UVpyZGdmdmhxdzBnQUFBQUZQQkRBTkJna3Foa2lHOXcwQkFRc0YKQURDQml6RUxNQWtHQTFVRUJoTUNWVk14RXpBUkJnTlZCQWdUQ2xkaGMyaHBibWQwYjI0eEVEQU9CZ05WQkFjVApCMUpsWkcxdmJtUXhIakFjQmdOVkJBb1RGVTFwWTNKdmMyOW1kQ0JEYjNKd2IzSmhkR2x2YmpFVk1CTUdBMVVFCkN4TU1UV2xqY205emIyWjBJRWxVTVI0d0hBWURWUVFERXhWTmFXTnliM052Wm5RZ1NWUWdWRXhUSUVOQklEUXcKSGhjTk1UZ3dOREV5TWpJek1qUTRXaGNOTWpBd05ERXlNakl6TWpRNFdqQTVNVGN3TlFZRFZRUURFeTV6WlhKMgphV05sWTJ4cFpXNTBZMlZ5ZEMxd1lYSjBibVZ5TG0xaGJtRm5aVzFsYm5RdVlYcDFjbVV1WTI5dE1JSUJJakFOCkJna3Foa2lHOXcwQkFRRUZBQU9DQVE4QU1JSUJDZ0tDQVFFQTBSYjdJcHpxMmR4emhhbVpyS1ZDakMzeTQyYlYKUnNIY2pCUTFuSDBHZ1puUDhXeDZDSE1mWThybkVJQzRLeVRRYkJXVzhnNXlmc3NSQ0ZXbFpxYjR6SkRXS0pmTgpGSmNMUm9LNnhwTktZYVZVTkVlT25IdUxHYTM0ZlA0VjBFRjZybzdvbkRLME5zanhjY1dZVzRNVXVzc0xrQS94CkUrM2RwU1REdk1KcjJoWUpsVnFDcVR6blQvbmZaVUZzQUVEQnp5MUpOOHZiZDlIR2czc2Myd0x4dk95cFJOc0gKT1V3V2pmN2xzWWZleEVlcWkzY29EeHc2alpLVWEyVkdsUnBpTkowMjhBQitYSi9TU1FVNVBsd0JBbU9TT3ovRApGY0NKdGpPZlBqU1NKckFIQVV3SHU3RzlSV05JTFBwYU9zQ1J5eitETE5zNGpvNlEvUUg4d1lManJRSURBUUFCCm80SUNtakNDQXBZd0N3WURWUjBQQkFRREFnU3dNQjBHQTFVZEpRUVdNQlFHQ0NzR0FRVUZCd01DQmdnckJnRUYKQlFjREFUQWRCZ05WSFE0RUZnUVVlbEdkVVJrZzJoSFFOWEQ4WUc4L3drdjJVT0F3SHdZRFZSMGpCQmd3Rm9BVQplbnVNd2Mvbm9Nb2MxR3Y2KytFend3OGFvcDB3Z2F3R0ExVWRId1NCcERDQm9UQ0JucUNCbTZDQm1JWkxhSFIwCmNEb3ZMMjF6WTNKc0xtMXBZM0p2YzI5bWRDNWpiMjB2Y0d0cEwyMXpZMjl5Y0M5amNtd3ZUV2xqY205emIyWjAKSlRJd1NWUWxNakJVVEZNbE1qQkRRU1V5TURRdVkzSnNoa2xvZEhSd09pOHZZM0pzTG0xcFkzSnZjMjltZEM1agpiMjB2Y0d0cEwyMXpZMjl5Y0M5amNtd3ZUV2xqY205emIyWjBKVEl3U1ZRbE1qQlVURk1sTWpCRFFTVXlNRFF1ClkzSnNNSUdGQmdnckJnRUZCUWNCQVFSNU1IY3dVUVlJS3dZQkJRVUhNQUtHUldoMGRIQTZMeTkzZDNjdWJXbGoKY205emIyWjBMbU52YlM5d2Eya3ZiWE5qYjNKd0wwMXBZM0p2YzI5bWRDVXlNRWxVSlRJd1ZFeFRKVEl3UTBFbApNakEwTG1OeWREQWlCZ2dyQmdFRkJRY3dBWVlXYUhSMGNEb3ZMMjlqYzNBdWJYTnZZM053TG1OdmJUQStCZ2tyCkJnRUVBWUkzRlFjRU1UQXZCaWNyQmdFRUFZSTNGUWlIMm9aMWcrN1pBWUxKaFJ1QnRaNWhoZlRyWUlGZGhOTGYKUW9Mbmszb0NBV1FDQVIwd1RRWURWUjBnQkVZd1JEQkNCZ2tyQmdFRUFZSTNLZ0V3TlRBekJnZ3JCZ0VGQlFjQwpBUlluYUhSMGNEb3ZMM2QzZHk1dGFXTnliM052Wm5RdVkyOXRMM0JyYVM5dGMyTnZjbkF2WTNCek1DY0dDU3NHCkFRUUJnamNWQ2dRYU1CZ3dDZ1lJS3dZQkJRVUhBd0l3Q2dZSUt3WUJCUVVIQXdFd09RWURWUjBSQkRJd01JSXUKYzJWeWRtbGpaV05zYVdWdWRHTmxjblF0Y0dGeWRHNWxjaTV0WVc1aFoyVnRaVzUwTG1GNmRYSmxMbU52YlRBTgpCZ2txaGtpRzl3MEJBUXNGQUFPQ0FnRUFIVXIzbk1vdUI5WWdDUlRWYndUTllIS2RkWGJkSW1GUXNDYys4T1g1CjE5c0N6dFFSR05iSXEwVW1Ba01MbFVvWTIxckh4ZXdxU2hWczFhL2RwaFh5Tk1pcUdaU2QzU1BtYzZscitqUFQKNXVEREs0MUlWeXN0K2VUNlpyazFvcCtMVmdkeS9EU2lyNzVqcWZFY016bS82bU8rNnFNeWRLTWtVYmM5K3JHVwphUkpUcjRWUUdIRmEwNEIwZVZpNUd4MG9pL2RpZDNSaXg2aXJMMjFJSGEwYjN6c1hzZHpHU0R2K3hqL2Q2S0l4Ckdrd2FhYmZvU1NoQnFqaFNlQ0VyZXFlb1RpYjljdGw0MGRVdUp3THl4bjhHS2N6K3AvMEJUOEIxU3lYK01OQ2wKY0pkMjVtMjhLajY2TGUxOEVyeFlJYXZJVGVGa3Y2eGZjdkEvcHladDdPaU41QTlGQk1IUmpQK1kyZ2tvdjMrcQpISFRUZG4xNnlRajduNit3YlFHNGVleXc0YisyQkRLcUxNVFU2ZmlSQ3ZPM2FPZVBLSFVNN3R4b1FidWl6Z3NzCkNiMzl3QnJOTEZsMkJLQ1RkSCtkSU9oZVJiSkZvbmlwOGRPOUVFZWdSSG9lQW54ZUlYTFBrdXMzTzEvZjRhNkIKWHQ3RG5BUm8xSzJmeEp3VXRaU2MvR3dFSjU5NzlnRXlEa3pDZEVsLzdpWE9QZXVjTXhlM2xVM2pweUtsNERUaApjSkJqQytqNGpLWTFrK1U4b040aGdqYnJISUx6Vnd2eU15OU5KS290U3BMSjQxeHdPOHlGangxalFTT3Bxc0N1ClFhUFUvTjhSZ0hxWjBGTkFzS3dNUmZ6WmdXanRCNzRzYUVEdk5jVmNuNFhCQnFNSG0ydHo2Uzk3d3kxZGt0cTgKSE5BPQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==" + } + ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/myToken", + "name": "myToken", + "type": "Microsoft.ContainerRegistry/registries/tokens", + "properties": { + "creationDate": "2017-03-01T23:14:37.0707808Z", + "scopeMapId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myNewScopeMap", + "provisioningState": "Succeeded", + "status": "enabled", + "credentials": { + "certificates": [ + { + "name": "certificate1", + "encodedPemCertificate": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUc3akNDQk5hZ0F3SUJBZ0lURmdBQlR3UVpyZGdmdmhxdzBnQUFBQUZQQkRBTkJna3Foa2lHOXcwQkFRc0YKQURDQml6RUxNQWtHQTFVRUJoTUNWVk14RXpBUkJnTlZCQWdUQ2xkaGMyaHBibWQwYjI0eEVEQU9CZ05WQkFjVApCMUpsWkcxdmJtUXhIakFjQmdOVkJBb1RGVTFwWTNKdmMyOW1kQ0JEYjNKd2IzSmhkR2x2YmpFVk1CTUdBMVVFCkN4TU1UV2xqY205emIyWjBJRWxVTVI0d0hBWURWUVFERXhWTmFXTnliM052Wm5RZ1NWUWdWRXhUSUVOQklEUXcKSGhjTk1UZ3dOREV5TWpJek1qUTRXaGNOTWpBd05ERXlNakl6TWpRNFdqQTVNVGN3TlFZRFZRUURFeTV6WlhKMgphV05sWTJ4cFpXNTBZMlZ5ZEMxd1lYSjBibVZ5TG0xaGJtRm5aVzFsYm5RdVlYcDFjbVV1WTI5dE1JSUJJakFOCkJna3Foa2lHOXcwQkFRRUZBQU9DQVE4QU1JSUJDZ0tDQVFFQTBSYjdJcHpxMmR4emhhbVpyS1ZDakMzeTQyYlYKUnNIY2pCUTFuSDBHZ1puUDhXeDZDSE1mWThybkVJQzRLeVRRYkJXVzhnNXlmc3NSQ0ZXbFpxYjR6SkRXS0pmTgpGSmNMUm9LNnhwTktZYVZVTkVlT25IdUxHYTM0ZlA0VjBFRjZybzdvbkRLME5zanhjY1dZVzRNVXVzc0xrQS94CkUrM2RwU1REdk1KcjJoWUpsVnFDcVR6blQvbmZaVUZzQUVEQnp5MUpOOHZiZDlIR2czc2Myd0x4dk95cFJOc0gKT1V3V2pmN2xzWWZleEVlcWkzY29EeHc2alpLVWEyVkdsUnBpTkowMjhBQitYSi9TU1FVNVBsd0JBbU9TT3ovRApGY0NKdGpPZlBqU1NKckFIQVV3SHU3RzlSV05JTFBwYU9zQ1J5eitETE5zNGpvNlEvUUg4d1lManJRSURBUUFCCm80SUNtakNDQXBZd0N3WURWUjBQQkFRREFnU3dNQjBHQTFVZEpRUVdNQlFHQ0NzR0FRVUZCd01DQmdnckJnRUYKQlFjREFUQWRCZ05WSFE0RUZnUVVlbEdkVVJrZzJoSFFOWEQ4WUc4L3drdjJVT0F3SHdZRFZSMGpCQmd3Rm9BVQplbnVNd2Mvbm9Nb2MxR3Y2KytFend3OGFvcDB3Z2F3R0ExVWRId1NCcERDQm9UQ0JucUNCbTZDQm1JWkxhSFIwCmNEb3ZMMjF6WTNKc0xtMXBZM0p2YzI5bWRDNWpiMjB2Y0d0cEwyMXpZMjl5Y0M5amNtd3ZUV2xqY205emIyWjAKSlRJd1NWUWxNakJVVEZNbE1qQkRRU1V5TURRdVkzSnNoa2xvZEhSd09pOHZZM0pzTG0xcFkzSnZjMjltZEM1agpiMjB2Y0d0cEwyMXpZMjl5Y0M5amNtd3ZUV2xqY205emIyWjBKVEl3U1ZRbE1qQlVURk1sTWpCRFFTVXlNRFF1ClkzSnNNSUdGQmdnckJnRUZCUWNCQVFSNU1IY3dVUVlJS3dZQkJRVUhNQUtHUldoMGRIQTZMeTkzZDNjdWJXbGoKY205emIyWjBMbU52YlM5d2Eya3ZiWE5qYjNKd0wwMXBZM0p2YzI5bWRDVXlNRWxVSlRJd1ZFeFRKVEl3UTBFbApNakEwTG1OeWREQWlCZ2dyQmdFRkJRY3dBWVlXYUhSMGNEb3ZMMjlqYzNBdWJYTnZZM053TG1OdmJUQStCZ2tyCkJnRUVBWUkzRlFjRU1UQXZCaWNyQmdFRUFZSTNGUWlIMm9aMWcrN1pBWUxKaFJ1QnRaNWhoZlRyWUlGZGhOTGYKUW9Mbmszb0NBV1FDQVIwd1RRWURWUjBnQkVZd1JEQkNCZ2tyQmdFRUFZSTNLZ0V3TlRBekJnZ3JCZ0VGQlFjQwpBUlluYUhSMGNEb3ZMM2QzZHk1dGFXTnliM052Wm5RdVkyOXRMM0JyYVM5dGMyTnZjbkF2WTNCek1DY0dDU3NHCkFRUUJnamNWQ2dRYU1CZ3dDZ1lJS3dZQkJRVUhBd0l3Q2dZSUt3WUJCUVVIQXdFd09RWURWUjBSQkRJd01JSXUKYzJWeWRtbGpaV05zYVdWdWRHTmxjblF0Y0dGeWRHNWxjaTV0WVc1aFoyVnRaVzUwTG1GNmRYSmxMbU52YlRBTgpCZ2txaGtpRzl3MEJBUXNGQUFPQ0FnRUFIVXIzbk1vdUI5WWdDUlRWYndUTllIS2RkWGJkSW1GUXNDYys4T1g1CjE5c0N6dFFSR05iSXEwVW1Ba01MbFVvWTIxckh4ZXdxU2hWczFhL2RwaFh5Tk1pcUdaU2QzU1BtYzZscitqUFQKNXVEREs0MUlWeXN0K2VUNlpyazFvcCtMVmdkeS9EU2lyNzVqcWZFY016bS82bU8rNnFNeWRLTWtVYmM5K3JHVwphUkpUcjRWUUdIRmEwNEIwZVZpNUd4MG9pL2RpZDNSaXg2aXJMMjFJSGEwYjN6c1hzZHpHU0R2K3hqL2Q2S0l4Ckdrd2FhYmZvU1NoQnFqaFNlQ0VyZXFlb1RpYjljdGw0MGRVdUp3THl4bjhHS2N6K3AvMEJUOEIxU3lYK01OQ2wKY0pkMjVtMjhLajY2TGUxOEVyeFlJYXZJVGVGa3Y2eGZjdkEvcHladDdPaU41QTlGQk1IUmpQK1kyZ2tvdjMrcQpISFRUZG4xNnlRajduNit3YlFHNGVleXc0YisyQkRLcUxNVFU2ZmlSQ3ZPM2FPZVBLSFVNN3R4b1FidWl6Z3NzCkNiMzl3QnJOTEZsMkJLQ1RkSCtkSU9oZVJiSkZvbmlwOGRPOUVFZWdSSG9lQW54ZUlYTFBrdXMzTzEvZjRhNkIKWHQ3RG5BUm8xSzJmeEp3VXRaU2MvR3dFSjU5NzlnRXlEa3pDZEVsLzdpWE9QZXVjTXhlM2xVM2pweUtsNERUaApjSkJqQytqNGpLWTFrK1U4b040aGdqYnJISUx6Vnd2eU15OU5KS290U3BMSjQxeHdPOHlGangxalFTT3Bxc0N1ClFhUFUvTjhSZ0hxWjBGTkFzS3dNUmZ6WmdXanRCNzRzYUVEdk5jVmNuNFhCQnFNSG0ydHo2Uzk3d3kxZGt0cTgKSE5BPQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==" + } + ] + } + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/WebhookCreate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/WebhookCreate.json new file mode 100644 index 000000000000..6d40076c8e58 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/WebhookCreate.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "webhookName": "myWebhook", + "webhookCreateParameters": { + "location": "westus", + "tags": { + "key": "value" + }, + "properties": { + "serviceUri": "http://myservice.com", + "customHeaders": { + "Authorization": "Basic 000000000000000000000000000000000000000000000000000" + }, + "status": "enabled", + "scope": "myRepository", + "actions": [ + "push" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/webhooks/myWebhook", + "name": "myWebhook", + "type": "Microsoft.ContainerRegistry/registries/webhooks", + "location": "westus", + "tags": { + "key": "value" + }, + "properties": { + "status": "enabled", + "scope": "myRepository", + "actions": [ + "push" + ], + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/webhooks/myWebhook", + "name": "myWebhook", + "type": "Microsoft.ContainerRegistry/registries/webhooks", + "location": "westus", + "tags": { + "key": "value" + }, + "properties": { + "status": "enabled", + "scope": "myRepository", + "actions": [ + "push" + ], + "provisioningState": "Creating" + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/WebhookDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/WebhookDelete.json new file mode 100644 index 000000000000..e053b9286634 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/WebhookDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "webhookName": "myWebhook" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/WebhookGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/WebhookGet.json new file mode 100644 index 000000000000..a5f04b466091 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/WebhookGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "webhookName": "myWebhook" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/webhooks/myWebhook", + "name": "myWebhook", + "type": "Microsoft.ContainerRegistry/registries/webhooks", + "location": "westus", + "tags": { + "key": "value" + }, + "properties": { + "status": "enabled", + "scope": "myRepository", + "actions": [ + "push" + ], + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/WebhookGetCallbackConfig.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/WebhookGetCallbackConfig.json new file mode 100644 index 000000000000..6a3c7c517bba --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/WebhookGetCallbackConfig.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "webhookName": "myWebhook" + }, + "responses": { + "200": { + "body": { + "serviceUri": "http://myservice.com", + "customHeaders": { + "Authorization": "Basic 000000000000000000000000000000000000000000000000000" + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/WebhookList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/WebhookList.json new file mode 100644 index 000000000000..a07a037ad645 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/WebhookList.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/webhooks/myWebhook", + "name": "myWebhook", + "type": "Microsoft.ContainerRegistry/registries/webhooks", + "location": "westus", + "tags": { + "key": "value" + }, + "properties": { + "status": "enabled", + "scope": "myRepository", + "actions": [ + "push" + ], + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/WebhookListEvents.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/WebhookListEvents.json new file mode 100644 index 000000000000..0949cd114b9d --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/WebhookListEvents.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "webhookName": "myWebhook" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "00000000-0000-0000-0000-000000000000", + "eventRequestMessage": { + "content": { + "id": "00000000-0000-0000-0000-000000000000", + "timestamp": "2017-03-01T23:14:37.0707808Z", + "action": "push", + "target": { + "mediaType": "application/vnd.docker.distribution.manifest.v2+json", + "size": 708, + "digest": "sha256:fea8895f450959fa676bcc1df0611ea93823a735a01205fd8622846041d0c7cf", + "length": 708, + "repository": "hello-world", + "url": "http://192.168.100.227:5000/v2/hello-world/manifests/sha256:fea8895f450959fa676bcc1df0611ea93823a735a01205fd8622846041d0c7cf", + "tag": "latest" + }, + "request": { + "id": "00000000-0000-0000-0000-000000000000", + "addr": "192.168.64.11:42961", + "host": "192.168.100.227:5000", + "method": "GET", + "useragent": "curl/7.38.0" + }, + "actor": {}, + "source": { + "addr": "xtal.local:5000", + "instanceID": "00000000-0000-0000-0000-000000000000" + } + }, + "headers": { + "Content-Type": "application/json", + "Content-Length": "719", + "Authorization": "******" + }, + "method": "POST", + "requestUri": "http://myservice.com", + "version": "1.1" + }, + "eventResponseMessage": { + "headers": { + "Content-Length": "0" + }, + "statusCode": "200", + "version": "1.1" + } + } + ] + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/WebhookPing.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/WebhookPing.json new file mode 100644 index 000000000000..cc0b33f804f5 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/WebhookPing.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "webhookName": "myWebhook" + }, + "responses": { + "200": { + "body": { + "id": "00000000-0000-0000-0000-000000000000" + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/WebhookUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/WebhookUpdate.json new file mode 100644 index 000000000000..52446b9bd449 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2021-06-01-preview/examples/WebhookUpdate.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "webhookName": "myWebhook", + "webhookUpdateParameters": { + "tags": { + "key": "value" + }, + "properties": { + "serviceUri": "http://myservice.com", + "customHeaders": { + "Authorization": "Basic 000000000000000000000000000000000000000000000000000" + }, + "status": "enabled", + "scope": "myRepository", + "actions": [ + "push" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/webhooks/myWebhook", + "name": "myWebhook", + "type": "Microsoft.ContainerRegistry/registries/webhooks", + "location": "westus", + "tags": { + "key": "value" + }, + "properties": { + "status": "enabled", + "scope": "myRepository", + "actions": [ + "push" + ], + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/webhooks/myWebhook", + "name": "myWebhook", + "type": "Microsoft.ContainerRegistry/registries/webhooks", + "location": "westus", + "tags": { + "key": "value" + }, + "properties": { + "status": "enabled", + "scope": "myRepository", + "actions": [ + "push" + ], + "provisioningState": "Updating" + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/readme.go.md b/specification/containerregistry/resource-manager/readme.go.md index cbac89f4b333..91738b70e38a 100644 --- a/specification/containerregistry/resource-manager/readme.go.md +++ b/specification/containerregistry/resource-manager/readme.go.md @@ -2,7 +2,15 @@ These settings apply only when `--go` is specified on the command line. -``` yaml $(go) +``` yaml $(go) && $(track2) +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/containerregistry/armcontainerregistry +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) +azure-arm: true +``` + +``` yaml $(go) && !$(track2) go: license-header: MICROSOFT_MIT_NO_VERSION namespace: containerregistry @@ -13,6 +21,7 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2021-06-preview - tag: package-2020-11-preview - tag: package-2019-12-preview - tag: package-2019-06-preview @@ -26,6 +35,15 @@ batch: - tag: package-2016-06-preview ``` +### Tag: package-2021-06-preview and go + +These settings apply only when `--tag=package-2021-06-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2021-06-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2021-06-01-preview/$(namespace) +``` + ### Tag: package-2020-11-preview and go These settings apply only when `--tag=package-2020-11-preview --go` is specified on the command line. @@ -123,4 +141,4 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2021-06-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerregistry.v2021_06_01_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/containerregistry/mgmt-v2021_06_01_preview +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-2020-11-preview and java These settings apply only when `--tag=package-2020-11-preview --java` is specified on the command line. diff --git a/specification/containerregistry/resource-manager/readme.md b/specification/containerregistry/resource-manager/readme.md index 81784d6809f4..85d1d178aa71 100644 --- a/specification/containerregistry/resource-manager/readme.md +++ b/specification/containerregistry/resource-manager/readme.md @@ -26,8 +26,28 @@ These are the global settings for the ContainerRegistry API. ``` yaml openapi-type: arm -tag: package-2020-11-preview +tag: package-2021-06-preview ``` + +### Tag: package-2021-06-preview-only + +These settings apply only when `--tag=package-2021-06-preview-only` is specified on the command line. + +```yaml $(tag) == 'package-2021-06-preview-only' +input-file: + - Microsoft.ContainerRegistry/preview/2021-06-01-preview/containerregistry.json +``` + +### Tag: package-2021-06-preview + +These settings apply only when `--tag=package-2021-06-preview` is specified on the command line. + +```yaml $(tag) == 'package-2021-06-preview' +input-file: + - Microsoft.ContainerRegistry/preview/2021-06-01-preview/containerregistry.json + - Microsoft.ContainerRegistry/preview/2019-06-01-preview/containerregistry_build.json +``` + ### Tag: package-2020-11-preview-only These settings apply only when `--tag=package-2020-11-preview-only` is specified on the command line. @@ -230,12 +250,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - autorest_options: - use: "@microsoft.azure/autorest.python@4.0.70" - after_scripts: - - python ./scripts/multiapi_init_gen.py azure-mgmt-containerregistry - - python ./scripts/trim_aio.py ./sdk/containerregistry/azure-mgmt-containerregistry - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/containerregistry/resource-manager/readme.nodejs.md b/specification/containerregistry/resource-manager/readme.nodejs.md index a8327ece72a2..709bcdecf903 100644 --- a/specification/containerregistry/resource-manager/readme.nodejs.md +++ b/specification/containerregistry/resource-manager/readme.nodejs.md @@ -12,6 +12,6 @@ nodejs: generate-package-json: true generate-readme-md: true input-file: -- Microsoft.ContainerRegistry/preview/2020-11-01-preview/containerregistry.json +- Microsoft.ContainerRegistry/preview/2021-06-01-preview/containerregistry.json - Microsoft.ContainerRegistry/preview/2019-06-01-preview/containerregistry_build.json ``` diff --git a/specification/containerregistry/resource-manager/readme.python.md b/specification/containerregistry/resource-manager/readme.python.md index 6cab3774be2b..ba0c75f1f194 100644 --- a/specification/containerregistry/resource-manager/readme.python.md +++ b/specification/containerregistry/resource-manager/readme.python.md @@ -2,15 +2,6 @@ These settings apply only when `--python` is specified on the command line. -```yaml $(python) && !$(track2) -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - package-name: azure-mgmt-containerregistry - clear-output-folder: true - no-namespace-folders: true -``` ```yaml $(python) && $(track2) azure-arm: true @@ -25,23 +16,10 @@ no-namespace-folders: true Generate all API versions currently shipped for this package -```yaml $(python) && $(multiapi) && !$(track2) -batch: - - tag: package-2020-11-preview - - tag: package-2019-12-preview - - tag: package-2019-06-preview - - tag: package-2019-05 - - tag: package-2019-05-preview - - tag: package-2019-04 - - tag: package-2018-09 - - tag: package-2018-02-preview - - tag: package-2017-10 - - tag: package-2017-03 -``` - ```yaml $(python) && $(multiapi) && $(track2) clear-output-folder: true batch: + - tag: package-2021-06-preview-only - tag: package-2020-11-preview-only - tag: package-2019-12-preview-only - tag: package-2019-06-preview-only @@ -60,15 +38,33 @@ output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregis clear-output-folder: false perform-load: false ``` + +### Tag: package-2021-06-preview-only and python + +These settings apply only when `--tag=package-2021-06-preview-only --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2021-06-preview-only' && $(python) +namespace: azure.mgmt.containerregistry.v2021_06_01_preview +output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2021_06_01_preview +``` + +### Tag: package-2021-06-preview and python + +These settings apply only when `--tag=package-2021-06-preview --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2021-06-preview' && $(python) +namespace: azure.mgmt.containerregistry.v2021_06_01_preview +output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2021_06_01_preview +``` + ### Tag: package-2020-11-preview-only and python These settings apply only when `--tag=package-2020-11-preview-only --python` is specified on the command line. Please also specify `--python-sdks-folder=`. ``` yaml $(tag) == 'package-2020-11-preview-only' && $(python) -python: - namespace: azure.mgmt.containerregistry.v2020_11_01_preview - output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2020_11_01_preview namespace: azure.mgmt.containerregistry.v2020_11_01_preview output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2020_11_01_preview ``` @@ -79,9 +75,6 @@ These settings apply only when `--tag=package-2020-11-preview --python` is speci Please also specify `--python-sdks-folder=`. ``` yaml $(tag) == 'package-2020-11-preview' && $(python) -python: - namespace: azure.mgmt.containerregistry.v2020_11_01_preview - output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2020_11_01_preview namespace: azure.mgmt.containerregistry.v2020_11_01_preview output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2020_11_01_preview ``` @@ -92,9 +85,6 @@ These settings apply only when `--tag=package-2019-12-preview-only --python` is Please also specify `--python-sdks-folder=`. ``` yaml $(tag) == 'package-2019-12-preview-only' && $(python) -python: - namespace: azure.mgmt.containerregistry.v2019_12_01_preview - output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2019_12_01_preview namespace: azure.mgmt.containerregistry.v2019_12_01_preview output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2019_12_01_preview ``` @@ -105,9 +95,6 @@ These settings apply only when `--tag=package-2019-12-preview --python` is speci Please also specify `--python-sdks-folder=`. ``` yaml $(tag) == 'package-2019-12-preview' && $(python) -python: - namespace: azure.mgmt.containerregistry.v2019_12_01_preview - output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2019_12_01_preview namespace: azure.mgmt.containerregistry.v2019_12_01_preview output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2019_12_01_preview ``` @@ -118,9 +105,6 @@ These settings apply only when `--tag=package-2019-06-preview-only --python` is Please also specify `--python-sdks-folder=`. ``` yaml $(tag) == 'package-2019-06-preview-only' && $(python) -python: - namespace: azure.mgmt.containerregistry.v2019_06_01_preview - output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2019_06_01_preview namespace: azure.mgmt.containerregistry.v2019_06_01_preview output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2019_06_01_preview ``` @@ -131,9 +115,6 @@ These settings apply only when `--tag=package-2019-06-preview --python` is speci Please also specify `--python-sdks-folder=`. ``` yaml $(tag) == 'package-2019-06-preview' && $(python) -python: - namespace: azure.mgmt.containerregistry.v2019_06_01_preview - output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2019_06_01_preview namespace: azure.mgmt.containerregistry.v2019_06_01_preview output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2019_06_01_preview ``` @@ -144,9 +125,6 @@ These settings apply only when `--tag=package-2019-05-only --python` is specifie Please also specify `--python-sdks-folder=`. ``` yaml $(tag) == 'package-2019-05-only' && $(python) -python: - namespace: azure.mgmt.containerregistry.v2019_05_01 - output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2019_05_01 namespace: azure.mgmt.containerregistry.v2019_05_01 output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2019_05_01 ``` @@ -157,9 +135,6 @@ These settings apply only when `--tag=package-2019-05 --python` is specified on Please also specify `--python-sdks-folder=`. ``` yaml $(tag) == 'package-2019-05' && $(python) -python: - namespace: azure.mgmt.containerregistry.v2019_05_01 - output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2019_05_01 namespace: azure.mgmt.containerregistry.v2019_05_01 output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2019_05_01 ``` @@ -170,9 +145,6 @@ These settings apply only when `--tag=package-2019-05-preview-only --python` is Please also specify `--python-sdks-folder=`. ``` yaml $(tag) == 'package-2019-05-preview-only' && $(python) -python: - namespace: azure.mgmt.containerregistry.v2019_05_01_preview - output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2019_05_01_preview namespace: azure.mgmt.containerregistry.v2019_05_01_preview output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2019_05_01_preview ``` @@ -183,9 +155,6 @@ These settings apply only when `--tag=package-2019-05-preview --python` is speci Please also specify `--python-sdks-folder=`. ``` yaml $(tag) == 'package-2019-05-preview' && $(python) -python: - namespace: azure.mgmt.containerregistry.v2019_05_01_preview - output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2019_05_01_preview namespace: azure.mgmt.containerregistry.v2019_05_01_preview output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2019_05_01_preview ``` @@ -196,9 +165,6 @@ These settings apply only when `--tag=package-2019-04-only --python` is specifie Please also specify `--python-sdks-folder=`. ``` yaml $(tag) == 'package-2019-04-only' && $(python) -python: - namespace: azure.mgmt.containerregistry.v2019_04_01 - output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2019_04_01 namespace: azure.mgmt.containerregistry.v2019_04_01 output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2019_04_01 ``` @@ -209,9 +175,6 @@ These settings apply only when `--tag=package-2019-04 --python` is specified on Please also specify `--python-sdks-folder=`. ``` yaml $(tag) == 'package-2019-04' && $(python) -python: - namespace: azure.mgmt.containerregistry.v2019_04_01 - output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2019_04_01 namespace: azure.mgmt.containerregistry.v2019_04_01 output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2019_04_01 ``` @@ -222,9 +185,6 @@ These settings apply only when `--tag=package-2018-09-only --python` is specifie Please also specify `--python-sdks-folder=`. ``` yaml $(tag) == 'package-2018-09-only' && $(python) -python: - namespace: azure.mgmt.containerregistry.v2018_09_01 - output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2018_09_01 namespace: azure.mgmt.containerregistry.v2018_09_01 output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2018_09_01 ``` @@ -235,9 +195,6 @@ These settings apply only when `--tag=package-2018-09 --python` is specified on Please also specify `--python-sdks-folder=`. ``` yaml $(tag) == 'package-2018-09' && $(python) -python: - namespace: azure.mgmt.containerregistry.v2018_09_01 - output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2018_09_01 namespace: azure.mgmt.containerregistry.v2018_09_01 output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2018_09_01 ``` @@ -248,9 +205,6 @@ These settings apply only when `--tag=package-2018-02-preview-only --python` is Please also specify `--python-sdks-folder=`. ``` yaml $(tag) == 'package-2018-02-preview-only' && $(python) -python: - namespace: azure.mgmt.containerregistry.v2018_02_01_preview - output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2018_02_01_preview namespace: azure.mgmt.containerregistry.v2018_02_01_preview output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2018_02_01_preview ``` @@ -261,9 +215,6 @@ These settings apply only when `--tag=package-2018-02-preview --python` is speci Please also specify `--python-sdks-folder=`. ``` yaml $(tag) == 'package-2018-02-preview' && $(python) -python: - namespace: azure.mgmt.containerregistry.v2018_02_01_preview - output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2018_02_01_preview namespace: azure.mgmt.containerregistry.v2018_02_01_preview output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2018_02_01_preview ``` @@ -274,9 +225,6 @@ These settings apply only when `--tag=package-2017-10 --python` is specified on Please also specify `--python-sdks-folder=`. ``` yaml $(tag) == 'package-2017-10' && $(python) -python: - namespace: azure.mgmt.containerregistry.v2017_10_01 - output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2017_10_01 namespace: azure.mgmt.containerregistry.v2017_10_01 output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2017_10_01 ``` @@ -287,9 +235,6 @@ These settings apply only when `--tag=package-2017-03 --python` is specified on Please also specify `--python-sdks-folder=`. ``` yaml $(tag) == 'package-2017-03' && $(python) -python: - namespace: azure.mgmt.containerregistry.v2017_03_01 - output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2017_03_01 namespace: azure.mgmt.containerregistry.v2017_03_01 output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2017_03_01 ``` diff --git a/specification/containerregistry/resource-manager/readme.ruby.md b/specification/containerregistry/resource-manager/readme.ruby.md index 0e5ebef4d309..200b1c1dbf9e 100644 --- a/specification/containerregistry/resource-manager/readme.ruby.md +++ b/specification/containerregistry/resource-manager/readme.ruby.md @@ -12,6 +12,7 @@ azure-arm: true ``` yaml $(ruby) && $(multiapi) batch: + - tag: package-2021-06-preview - tag: package-2020-11-preview - tag: package-2019-12-preview - tag: package-2017-10 @@ -20,6 +21,16 @@ batch: - tag: package-2016-06-preview ``` +### Tag: package-2021-06-preview and ruby + +These settings apply only when `--tag=package-2021-06-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2021-06-preview' && $(ruby) +namespace: "Azure::ContainerRegistry::Mgmt::V2021_06_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_container_registry/lib +``` + ### Tag: package-2020-11-preview and ruby These settings apply only when `--tag=package-2020-11-preview --ruby` is specified on the command line. diff --git a/specification/containerregistry/resource-manager/readme.typescript.md b/specification/containerregistry/resource-manager/readme.typescript.md index d78cfd959f51..5d15348ef436 100644 --- a/specification/containerregistry/resource-manager/readme.typescript.md +++ b/specification/containerregistry/resource-manager/readme.typescript.md @@ -5,7 +5,7 @@ Please also specify `--typescript-sdks-folder=
    **Restriction:** Cannot end in \".\"

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

    **Minimum-length:** 1 character

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

    **Minimum-length:** 8 characters

    **Max-length:** 123 characters

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

    **Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\"" + }, + "licenseType": { + "type": "string", + "enum": [ + "None", + "Windows_Server" + ], + "x-ms-enum": { + "name": "licenseType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No additional licensing is applied." + }, + { + "value": "Windows_Server", + "description": "Enables Azure Hybrid User Benefits for Windows VMs." + } + ] + }, + "description": "The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details." + }, + "enableCSIProxy": { + "type": "boolean", + "title": "Whether to enable CSI proxy.", + "description": "For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy)." + } + }, + "required": [ + "adminUsername" + ], + "description": "Profile for Windows VMs in the managed cluster." + }, + "ContainerServiceLinuxProfile": { + "properties": { + "adminUsername": { + "type": "string", + "description": "The administrator username to use for Linux VMs.", + "pattern": "^[A-Za-z][-A-Za-z0-9_]*$" + }, + "ssh": { + "$ref": "#/definitions/ContainerServiceSshConfiguration", + "description": "The SSH configuration for Linux-based VMs running on Azure." + } + }, + "required": [ + "adminUsername", + "ssh" + ], + "description": "Profile for Linux VMs in the container service cluster." + }, + "ContainerServiceNetworkProfile": { + "properties": { + "networkPlugin": { + "type": "string", + "enum": [ + "azure", + "kubenet" + ], + "default": "kubenet", + "x-ms-enum": { + "name": "NetworkPlugin", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Use the Azure CNI network plugin. See [Azure CNI (advanced) networking](https://docs.microsoft.com/azure/aks/concepts-network#azure-cni-advanced-networking) for more information." + }, + { + "value": "kubenet", + "description": "Use the Kubenet network plugin. See [Kubenet (basic) networking](https://docs.microsoft.com/azure/aks/concepts-network#kubenet-basic-networking) for more information." + } + ] + }, + "description": "Network plugin used for building the Kubernetes network." + }, + "networkPolicy": { + "type": "string", + "enum": [ + "calico", + "azure" + ], + "x-ms-enum": { + "name": "NetworkPolicy", + "modelAsString": true, + "values": [ + { + "value": "calico", + "description": "Use Calico network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information." + }, + { + "value": "azure", + "description": "Use Azure network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information." + } + ] + }, + "description": "Network policy used for building the Kubernetes network." + }, + "networkMode": { + "type": "string", + "enum": [ + "transparent", + "bridge" + ], + "x-ms-enum": { + "name": "networkMode", + "modelAsString": true, + "values": [ + { + "value": "transparent", + "description": "No bridge is created. Intra-VM Pod to Pod communication is through IP routes created by Azure CNI. See [Transparent Mode](https://docs.microsoft.com/azure/aks/faq#transparent-mode) for more information." + }, + { + "value": "bridge", + "description": "This is no longer supported" + } + ] + }, + "title": "The network mode Azure CNI is configured with.", + "description": "This cannot be specified if networkPlugin is anything other than 'azure'." + }, + "podCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.244.0.0/16", + "description": "A CIDR notation IP range from which to assign pod IPs when kubenet is used." + }, + "serviceCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.0.0.0/16", + "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges." + }, + "dnsServiceIP": { + "type": "string", + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "default": "10.0.0.10", + "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr." + }, + "dockerBridgeCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "172.17.0.1/16", + "description": "A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range." + }, + "outboundType": { + "type": "string", + "enum": [ + "loadBalancer", + "userDefinedRouting" + ], + "x-ms-enum": { + "name": "outboundType", + "modelAsString": true, + "values": [ + { + "value": "loadBalancer", + "description": "The load balancer is used for egress through an AKS assigned public IP. This supports Kubernetes services of type 'loadBalancer'. For more information see [outbound type loadbalancer](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-loadbalancer)." + }, + { + "value": "userDefinedRouting", + "description": "Egress paths must be defined by the user. This is an advanced scenario and requires proper network configuration. For more information see [outbound type userDefinedRouting](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-userdefinedrouting)." + } + ] + }, + "default": "loadBalancer", + "title": "The outbound (egress) routing method.", + "description": "This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype)." + }, + "loadBalancerSku": { + "type": "string", + "enum": [ + "standard", + "basic" + ], + "x-ms-enum": { + "name": "loadBalancerSku", + "modelAsString": true, + "values": [ + { + "value": "standard", + "description": "Use a a standard Load Balancer. This is the recommended Load Balancer SKU. For more information about on working with the load balancer in the managed cluster, see the [standard Load Balancer](https://docs.microsoft.com/azure/aks/load-balancer-standard) article." + }, + { + "value": "basic", + "description": "Use a basic Load Balancer with limited functionality." + } + ] + }, + "title": "The load balancer sku for the managed cluster.", + "description": "The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs." + }, + "loadBalancerProfile": { + "$ref": "#/definitions/ManagedClusterLoadBalancerProfile", + "description": "Profile of the cluster load balancer." + } + }, + "description": "Profile of network configuration." + }, + "MaintenanceConfigurationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MaintenanceConfiguration" + }, + "description": "The list of maintenance configurations." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of maintenance configuration results.", + "readOnly": true + } + }, + "description": "The response from the List maintenance configurations operation." + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "type": "string", + "description": "The type of identity that created the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The UTC timestamp of resource creation." + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "type": "string", + "description": "The type of identity that last modified the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The type of identity that last modified the resource." + } + } + }, + "MaintenanceConfiguration": { + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "systemData": { + "$ref": "#/definitions/SystemData", + "readOnly": true, + "description": "The system metadata relating to this resource." + }, + "properties": { + "description": "Properties of a default maintenance configuration.", + "$ref": "#/definitions/MaintenanceConfigurationProperties", + "x-ms-client-flatten": true + } + }, + "title": "Planned maintenance configuration, used to configure when updates can be deployed to a Managed Cluster.", + "description": "See [planned maintenance](https://docs.microsoft.com/azure/aks/planned-maintenance) for more information about planned maintenance." + }, + "MaintenanceConfigurationProperties": { + "properties": { + "timeInWeek": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeInWeek" + }, + "title": "Time slots during the week when planned maintenance is allowed to proceed.", + "description": "If two array entries specify the same day of the week, the applied configuration is the union of times in both entries." + }, + "notAllowedTime": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeSpan" + }, + "description": "Time slots on which upgrade is not allowed." + } + }, + "description": "Properties used to configure planned maintenance for a Managed Cluster." + }, + "TimeInWeek": { + "properties": { + "day": { + "$ref": "#/definitions/WeekDay", + "description": "The day of the week." + }, + "hourSlots": { + "type": "array", + "items": { + "$ref": "#/definitions/HourInDay" + }, + "title": "A list of hours in the day used to identify a time range.", + "description": "Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range." + } + }, + "description": "Time in a week." + }, + "WeekDay": { + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "WeekDay", + "modelAsString": true + }, + "description": "The weekday enum." + }, + "HourInDay": { + "type": "integer", + "format": "int32", + "maximum": 23, + "minimum": 0, + "description": "Hour in a day." + }, + "TimeSpan": { + "properties": { + "start": { + "type": "string", + "format": "date-time", + "description": "The start of a time span" + }, + "end": { + "type": "string", + "format": "date-time", + "description": "The end of a time span" + } + }, + "title": "A time range.", + "description": "For example, between 2021-05-25T13:00:00Z and 2021-05-25T14:00:00Z." + }, + "RunCommandRequest": { + "properties": { + "command": { + "type": "string", + "description": "The command to run." + }, + "context": { + "type": "string", + "description": "A base64 encoded zip file containing the files required by the command." + }, + "clusterToken": { + "type": "string", + "description": "AuthToken issued for AKS AAD Server App." + } + }, + "description": "A run command request", + "required": [ + "command" + ] + }, + "RunCommandResult": { + "properties": { + "id": { + "type": "string", + "description": "The command id.", + "readOnly": true + }, + "properties": { + "description": "Properties of command result.", + "$ref": "#/definitions/CommandResultProperties", + "x-ms-client-flatten": true + } + }, + "description": "run command result." + }, + "CommandResultProperties": { + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "provisioning State" + }, + "exitCode": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The exit code of the command" + }, + "startedAt": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time when the command started." + }, + "finishedAt": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time when the command finished." + }, + "logs": { + "type": "string", + "readOnly": true, + "description": "The command output." + }, + "reason": { + "type": "string", + "readOnly": true, + "description": "An explanation of why provisioningState is set to failed (if so)." + } + }, + "description": "The results of a run command" + }, + "ManagedClusterLoadBalancerProfile": { + "properties": { + "managedOutboundIPs": { + "properties": { + "count": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 1, + "description": "The desired number of outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ", + "default": 1 + } + }, + "description": "Desired managed outbound IPs for the cluster load balancer." + }, + "outboundIPPrefixes": { + "properties": { + "publicIPPrefixes": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP prefix resources." + } + }, + "description": "Desired outbound IP Prefix resources for the cluster load balancer." + }, + "outboundIPs": { + "properties": { + "publicIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP resources." + } + }, + "description": "Desired outbound IP resources for the cluster load balancer." + }, + "effectiveOutboundIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "The effective outbound IP resources of the cluster load balancer." + }, + "allocatedOutboundPorts": { + "type": "integer", + "format": "int32", + "maximum": 64000, + "minimum": 0, + "description": "The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports.", + "default": 0 + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 120, + "minimum": 4, + "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes.", + "default": 30 + } + }, + "description": "Profile of the managed cluster load balancer." + }, + "ResourceReference": { + "properties": { + "id": { + "type": "string", + "description": "The fully qualified Azure resource id." + } + }, + "description": "A reference to an Azure resource." + }, + "ContainerServiceSshConfiguration": { + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerServiceSshPublicKey" + }, + "description": "The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified." + } + }, + "description": "SSH configuration for Linux-based VMs running on Azure.", + "required": [ + "publicKeys" + ] + }, + "ContainerServiceSshPublicKey": { + "properties": { + "keyData": { + "type": "string", + "description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers." + } + }, + "required": [ + "keyData" + ], + "description": "Contains information about SSH certificate public key data." + }, + "ContainerServiceDiagnosticsProfile": { + "properties": { + "vmDiagnostics": { + "$ref": "#/definitions/ContainerServiceVMDiagnostics", + "description": "Profile for diagnostics on the container service VMs." + } + }, + "description": "Profile for diagnostics on the container service cluster.", + "required": [ + "vmDiagnostics" + ] + }, + "ContainerServiceVMDiagnostics": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the VM diagnostic agent is provisioned on the VM." + }, + "storageUri": { + "readOnly": true, + "type": "string", + "description": "The URI of the storage account where diagnostics are stored." + } + }, + "description": "Profile for diagnostics on the container service VMs.", + "required": [ + "enabled" + ] + }, + "ManagedClusterListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "The list of managed clusters." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of managed cluster results.", + "readOnly": true + } + }, + "description": "The response from the List Managed Clusters operation." + }, + "ManagedCluster": { + "properties": { + "sku": { + "$ref": "#/definitions/ManagedClusterSKU", + "description": "The managed cluster SKU." + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the Virtual Machine." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "properties": { + "properties": { + "description": "Properties of a managed cluster.", + "$ref": "#/definitions/ManagedClusterProperties", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "#/definitions/ManagedClusterIdentity", + "description": "The identity of the managed cluster, if configured." + } + } + } + ], + "description": "Managed cluster." + }, + "ManagedClusterProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current provisioning state." + }, + "powerState": { + "$ref": "#/definitions/PowerState", + "description": "The Power State of the cluster.", + "readOnly": true + }, + "maxAgentPools": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The max number of agent pools for the managed cluster." + }, + "kubernetesVersion": { + "type": "string", + "title": "The version of Kubernetes the Managed Cluster is running.", + "description": "When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details." + }, + "dnsPrefix": { + "type": "string", + "title": "The DNS prefix of the Managed Cluster.", + "description": "This cannot be updated once the Managed Cluster has been created." + }, + "fqdnSubdomain": { + "type": "string", + "title": "The FQDN subdomain of the private cluster with custom private dns zone.", + "description": "This cannot be updated once the Managed Cluster has been created." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "The FQDN of the master pool." + }, + "privateFQDN": { + "readOnly": true, + "type": "string", + "description": "The FQDN of private cluster." + }, + "azurePortalFQDN": { + "readOnly": true, + "type": "string", + "title": "The special FQDN used by the Azure Portal to access the Managed Cluster. This FQDN is for use only by the Azure Portal and should not be used by other clients.", + "description": "The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterAgentPoolProfile" + }, + "description": "The agent pool properties." + }, + "linuxProfile": { + "$ref": "#/definitions/ContainerServiceLinuxProfile", + "description": "The profile for Linux VMs in the Managed Cluster." + }, + "windowsProfile": { + "$ref": "#/definitions/ManagedClusterWindowsProfile", + "description": "The profile for Windows VMs in the Managed Cluster." + }, + "servicePrincipalProfile": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile", + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs." + }, + "addonProfiles": { + "additionalProperties": { + "$ref": "#/definitions/ManagedClusterAddonProfile" + }, + "description": "The profile of managed cluster add-on." + }, + "podIdentityProfile": { + "$ref": "#/definitions/ManagedClusterPodIdentityProfile", + "title": "The pod identity profile of the Managed Cluster.", + "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on AAD pod identity integration." + }, + "nodeResourceGroup": { + "type": "string", + "description": "The name of the resource group containing agent pool nodes." + }, + "enableRBAC": { + "type": "boolean", + "description": "Whether to enable Kubernetes Role-Based Access Control." + }, + "enablePodSecurityPolicy": { + "type": "boolean", + "description": "(DEPRECATING) Whether to enable Kubernetes pod security policy (preview). This feature is set for removal on October 15th, 2020. Learn more at aka.ms/aks/azpodpolicy." + }, + "networkProfile": { + "$ref": "#/definitions/ContainerServiceNetworkProfile", + "description": "The network configuration profile." + }, + "aadProfile": { + "$ref": "#/definitions/ManagedClusterAADProfile", + "description": "The Azure Active Directory configuration." + }, + "autoUpgradeProfile": { + "$ref": "#/definitions/ManagedClusterAutoUpgradeProfile", + "description": "The auto upgrade configuration." + }, + "autoScalerProfile": { + "type": "object", + "properties": { + "balance-similar-node-groups": { + "type": "string", + "title": "Detects similar node pools and balances the number of nodes between them.", + "description": "Valid values are 'true' and 'false'" + }, + "expander": { + "type": "string", + "enum": [ + "least-waste", + "most-pods", + "priority", + "random" + ], + "x-ms-enum": { + "name": "expander", + "modelAsString": true, + "values": [ + { + "value": "least-waste", + "description": "Selects the node group that will have the least idle CPU (if tied, unused memory) after scale-up. This is useful when you have different classes of nodes, for example, high CPU or high memory nodes, and only want to expand those when there are pending pods that need a lot of those resources." + }, + { + "value": "most-pods", + "description": "Selects the node group that would be able to schedule the most pods when scaling up. This is useful when you are using nodeSelector to make sure certain pods land on certain nodes. Note that this won't cause the autoscaler to select bigger nodes vs. smaller, as it can add multiple smaller nodes at once." + }, + { + "value": "priority", + "description": "Selects the node group that has the highest priority assigned by the user. It's configuration is described in more details [here](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/expander/priority/readme.md)." + }, + { + "value": "random", + "description": "Used when you don't have a particular need for the node groups to scale differently." + } + ] + }, + "title": "The expander to use when scaling up", + "description": "If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information." + }, + "max-empty-bulk-delete": { + "type": "string", + "title": "The maximum number of empty nodes that can be deleted at the same time. This must be a positive integer.", + "description": "The default is 10." + }, + "max-graceful-termination-sec": { + "type": "string", + "title": "The maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node.", + "description": "The default is 600." + }, + "max-node-provision-time": { + "type": "string", + "title": "The maximum time the autoscaler waits for a node to be provisioned.", + "description": "The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "max-total-unready-percentage": { + "type": "string", + "title": "The maximum percentage of unready nodes in the cluster. After this percentage is exceeded, cluster autoscaler halts operations.", + "description": "The default is 45. The maximum is 100 and the minimum is 0." + }, + "new-pod-scale-up-delay": { + "type": "string", + "title": "Ignore unscheduled pods before they're a certain age.", + "description": "For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc)." + }, + "ok-total-unready-count": { + "type": "string", + "title": "The number of allowed unready nodes, irrespective of max-total-unready-percentage.", + "description": "This must be an integer. The default is 3." + }, + "scan-interval": { + "type": "string", + "title": "How often cluster is reevaluated for scale up or down.", + "description": "The default is '10'. Values must be an integer number of seconds." + }, + "scale-down-delay-after-add": { + "type": "string", + "title": "How long after scale up that scale down evaluation resumes", + "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-delay-after-delete": { + "type": "string", + "title": "How long after node deletion that scale down evaluation resumes.", + "description": "The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-delay-after-failure": { + "type": "string", + "title": "How long after scale down failure that scale down evaluation resumes.", + "description": "The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-unneeded-time": { + "type": "string", + "title": "How long a node should be unneeded before it is eligible for scale down.", + "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-unready-time": { + "type": "string", + "title": "How long an unready node should be unneeded before it is eligible for scale down", + "description": "The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-utilization-threshold": { + "type": "string", + "title": "Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down.", + "description": "The default is '0.5'." + }, + "skip-nodes-with-local-storage": { + "type": "string", + "title": "If cluster autoscaler will skip deleting nodes with pods with local storage, for example, EmptyDir or HostPath.", + "description": "The default is true." + }, + "skip-nodes-with-system-pods": { + "type": "string", + "title": "If cluster autoscaler will skip deleting nodes with pods from kube-system (except for DaemonSet or mirror pods)", + "description": "The default is true." + } + }, + "description": "Parameters to be applied to the cluster-autoscaler when enabled" + }, + "apiServerAccessProfile": { + "$ref": "#/definitions/ManagedClusterAPIServerAccessProfile", + "description": "The access profile for managed cluster API server." + }, + "diskEncryptionSetID": { + "type": "string", + "title": "The Resource ID of the disk encryption set to use for enabling encryption at rest.", + "description": "This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'" + }, + "identityProfile": { + "additionalProperties": { + "allOf": [ + { + "$ref": "#/definitions/UserAssignedIdentity" + } + ] + }, + "description": "Identities associated with the cluster." + }, + "privateLinkResources": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "Private link resources associated with the cluster." + }, + "disableLocalAccounts": { + "type": "boolean", + "title": "If local accounts should be disabled on the Managed Cluster.", + "description": "If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview)." + }, + "httpProxyConfig": { + "$ref": "#/definitions/ManagedClusterHTTPProxyConfig", + "description": "Configurations for provisioning the cluster with HTTP proxy servers." + } + }, + "description": "Properties of the managed cluster." + }, + "PowerState": { + "description": "Describes the Power State of the cluster", + "properties": { + "code": { + "type": "string", + "description": "Tells whether the cluster is Running or Stopped", + "enum": [ + "Running", + "Stopped" + ], + "x-ms-enum": { + "name": "code", + "modelAsString": true, + "values": [ + { + "value": "Running", + "description": "The cluster is running." + }, + { + "value": "Stopped", + "description": "The cluster is stopped." + } + ] + } + } + } + }, + "ManagedClusterAPIServerAccessProfile": { + "properties": { + "authorizedIPRanges": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The IP ranges authorized to access the Kubernetes API server.", + "description": "IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see [API server authorized IP ranges](https://docs.microsoft.com/azure/aks/api-server-authorized-ip-ranges)." + }, + "enablePrivateCluster": { + "type": "boolean", + "title": "Whether to create the cluster as a private cluster or not.", + "description": "For more details, see [Creating a private AKS cluster](https://docs.microsoft.com/azure/aks/private-clusters)." + }, + "privateDNSZone": { + "type": "string", + "title": "The private DNS zone mode for the cluster.", + "description": "The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'." + }, + "enablePrivateClusterPublicFQDN": { + "type": "boolean", + "description": "Whether to create additional public FQDN for private cluster or not." + } + }, + "description": "Access profile for managed cluster API server." + }, + "ManagedClusterIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the system assigned identity which is used by master components." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id of the system assigned identity which is used by master components." + }, + "type": { + "type": "string", + "title": "The type of identity used for the managed cluster.", + "description": "For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity).", + "enum": [ + "SystemAssigned", + "UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false, + "values": [ + { + "value": "SystemAssigned", + "description": "Use an implicitly created system assigned managed identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the system assigned managed identity to manipulate Azure resources." + }, + { + "value": "UserAssigned", + "description": "Use a user-specified identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the specified user assigned managed identity to manipulate Azure resources." + }, + { + "value": "None", + "description": "Do not use a managed identity for the Managed Cluster, service principal will be used instead." + } + ] + } + }, + "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." + } + } + }, + "title": "The user identity associated with the managed cluster. This identity will be used in control plane. Only one user assigned identity is allowed.", + "description": "The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the managed cluster." + }, + "UserAssignedIdentity": { + "properties": { + "resourceId": { + "type": "string", + "description": "The resource ID of the user assigned identity." + }, + "clientId": { + "type": "string", + "description": "The client ID of the user assigned identity." + }, + "objectId": { + "type": "string", + "description": "The object ID of the user assigned identity." + } + }, + "description": "Details about a user assigned identity." + }, + "ManagedClusterAccessProfile": { + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "properties": { + "properties": { + "description": "AccessProfile of a managed cluster.", + "$ref": "#/definitions/AccessProfile", + "x-ms-client-flatten": true + } + } + } + ], + "description": "Managed cluster Access Profile.", + "x-ms-azure-resource": false + }, + "AccessProfile": { + "type": "object", + "properties": { + "kubeConfig": { + "type": "string", + "format": "byte", + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "Profile for enabling a user to access a managed cluster." + }, + "ManagedClusterPoolUpgradeProfile": { + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "name": { + "type": "string", + "description": "The Agent Pool name." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether the Kubernetes version is currently in preview." + } + } + }, + "description": "List of orchestrator types and versions available for upgrade." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "ManagedClusterUpgradeProfileProperties": { + "properties": { + "controlPlaneProfile": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile", + "description": "The list of available upgrade versions for the control plane." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile" + }, + "description": "The list of available upgrade versions for agent pools." + } + }, + "required": [ + "controlPlaneProfile", + "agentPoolProfiles" + ], + "description": "Control plane and agent pool upgrade profiles." + }, + "ManagedClusterAutoUpgradeProfile": { + "properties": { + "upgradeChannel": { + "type": "string", + "enum": [ + "rapid", + "stable", + "patch", + "node-image", + "none" + ], + "x-ms-enum": { + "name": "upgradeChannel", + "modelAsString": true, + "values": [ + { + "value": "rapid", + "description": "Automatically upgrade the cluster to the latest supported patch release on the latest supported minor version. In cases where the cluster is at a version of Kubernetes that is at an N-2 minor version where N is the latest supported minor version, the cluster first upgrades to the latest supported patch version on N-1 minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster first is upgraded to 1.18.6, then is upgraded to 1.19.1." + }, + { + "value": "stable", + "description": "Automatically upgrade the cluster to the latest supported patch release on minor version N-1, where N is the latest supported minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.18.6." + }, + { + "value": "patch", + "description": "Automatically upgrade the cluster to the latest supported patch version when it becomes available while keeping the minor version the same. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.17.9." + }, + { + "value": "node-image", + "description": "Automatically upgrade the node image to the latest version available. Microsoft provides patches and new images for image nodes frequently (usually weekly), but your running nodes won't get the new images unless you do a node image upgrade. Turning on the node-image channel will automatically update your node images whenever a new version is available." + }, + { + "value": "none", + "description": "Disables auto-upgrades and keeps the cluster at its current version of Kubernetes." + } + ] + }, + "title": "The upgrade channel for auto upgrade. The default is 'none'.", + "description": "For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel)." + } + }, + "description": "Auto upgrade profile for a managed cluster." + }, + "ManagedClusterAADProfile": { + "properties": { + "managed": { + "type": "boolean", + "description": "Whether to enable managed AAD." + }, + "enableAzureRBAC": { + "type": "boolean", + "description": "Whether to enable Azure RBAC for Kubernetes authorization." + }, + "adminGroupObjectIDs": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of AAD group object IDs that will have admin role of the cluster." + }, + "clientAppID": { + "type": "string", + "description": "The client AAD application ID." + }, + "serverAppID": { + "type": "string", + "description": "The server AAD application ID." + }, + "serverAppSecret": { + "type": "string", + "description": "The server AAD application secret." + }, + "tenantID": { + "type": "string", + "description": "The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription." + } + }, + "title": "AADProfile specifies attributes for Azure Active Directory integration.", + "description": "For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad)." + }, + "ManagedClusterAddonProfile": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the add-on is enabled or not." + }, + "config": { + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs for configuring an add-on." + }, + "identity": { + "readOnly": true, + "description": "Information of user assigned identity used by this add-on.", + "allOf": [ + { + "$ref": "#/definitions/UserAssignedIdentity" + } + ] + } + }, + "required": [ + "enabled" + ], + "description": "A Kubernetes add-on profile for a managed cluster." + }, + "ManagedClusterPodIdentity": { + "properties": { + "name": { + "type": "string", + "description": "The name of the pod identity." + }, + "namespace": { + "type": "string", + "description": "The namespace of the pod identity." + }, + "bindingSelector": { + "type": "string", + "description": "The binding selector to use for the AzureIdentityBinding resource." + }, + "identity": { + "$ref": "#/definitions/UserAssignedIdentity", + "description": "The user assigned identity details." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state of the pod identity.", + "enum": [ + "Assigned", + "Updating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "ManagedClusterPodIdentityProvisioningState", + "modelAsString": true + } + }, + "provisioningInfo": { + "readOnly": true, + "properties": { + "error": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningError", + "description": "Pod identity assignment error (if any)." + } + } + } + }, + "required": [ + "name", + "namespace", + "identity" + ], + "description": "Details about the pod identity assigned to the Managed Cluster." + }, + "ManagedClusterPodIdentityProvisioningError": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningErrorBody", + "description": "Details about the error." + } + }, + "description": "An error response from the pod identity provisioning." + }, + "ManagedClusterPodIdentityProvisioningErrorBody": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningErrorBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the pod identity provisioning." + }, + "ManagedClusterPodIdentityException": { + "properties": { + "name": { + "type": "string", + "description": "The name of the pod identity exception." + }, + "namespace": { + "type": "string", + "description": "The namespace of the pod identity exception." + }, + "podLabels": { + "type": "object", + "description": "The pod labels to match.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "name", + "namespace", + "podLabels" + ], + "title": "A pod identity exception, which allows pods with certain labels to access the Azure Instance Metadata Service (IMDS) endpoint without being intercepted by the node-managed identity (NMI) server.", + "description": "See [disable AAD Pod Identity for a specific Pod/Application](https://azure.github.io/aad-pod-identity/docs/configure/application_exception/) for more details." + }, + "ManagedClusterPodIdentityProfile": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the pod identity addon is enabled." + }, + "allowNetworkPluginKubenet": { + "type": "boolean", + "title": "Whether pod identity is allowed to run on clusters with Kubenet networking.", + "description": "Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information." + }, + "userAssignedIdentities": { + "description": "The pod identities to use in the cluster.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentity" + } + }, + "userAssignedIdentityExceptions": { + "description": "The pod identity exceptions to allow.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentityException" + } + } + }, + "title": "The pod identity profile of the Managed Cluster.", + "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration." + }, + "ManagedClusterUpgradeProfile": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the upgrade profile." + }, + "properties": { + "$ref": "#/definitions/ManagedClusterUpgradeProfileProperties", + "description": "The properties of the upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for compute pools." + }, + "AgentPoolUpgradeProfile": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the agent pool upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the agent pool upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the agent pool upgrade profile." + }, + "properties": { + "$ref": "#/definitions/AgentPoolUpgradeProfileProperties", + "description": "The properties of the agent pool upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for an agent pool." + }, + "AgentPoolUpgradeProfileProperties": { + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether the Kubernetes version is currently in preview." + } + } + }, + "description": "List of orchestrator types and versions available for upgrade." + }, + "latestNodeImageVersion": { + "type": "string", + "description": "The latest AKS supported node image version." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "AgentPoolAvailableVersions": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the agent pool version list." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the agent pool version list." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the agent pool version list." + }, + "properties": { + "$ref": "#/definitions/AgentPoolAvailableVersionsProperties", + "description": "Properties of agent pool available versions.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available versions for an agent pool." + }, + "AgentPoolAvailableVersionsProperties": { + "properties": { + "agentPoolVersions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "default": { + "type": "boolean", + "description": "Whether this version is the default agent pool version." + }, + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether Kubernetes version is currently in preview." + } + } + }, + "description": "List of versions available for agent pool." + } + }, + "description": "The list of available agent pool versions." + }, + "OSType": { + "type": "string", + "default": "Linux", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": true, + "values": [ + { + "value": "Linux", + "description": "Use Linux." + }, + { + "value": "Windows", + "description": "Use Windows." + } + ] + }, + "description": "The operating system type. The default is Linux." + }, + "OSSKU": { + "type": "string", + "enum": [ + "Ubuntu", + "CBLMariner" + ], + "x-ms-enum": { + "name": "OSSKU", + "modelAsString": true + }, + "description": "Specifies an OS SKU. This value must not be specified if OSType is Windows." + }, + "ScaleSetPriority": { + "type": "string", + "default": "Regular", + "enum": [ + "Spot", + "Regular" + ], + "x-ms-enum": { + "name": "ScaleSetPriority", + "modelAsString": true, + "values": [ + { + "value": "Spot", + "description": "Spot priority VMs will be used. There is no SLA for spot nodes. See [spot on AKS](https://docs.microsoft.com/azure/aks/spot-node-pool) for more information." + }, + { + "value": "Regular", + "description": "Regular VMs will be used." + } + ] + }, + "description": "The Virtual Machine Scale Set priority." + }, + "ScaleSetEvictionPolicy": { + "type": "string", + "default": "Delete", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "ScaleSetEvictionPolicy", + "modelAsString": true, + "values": [ + { + "value": "Delete", + "description": "Nodes in the underlying Scale Set of the node pool are deleted when they're evicted." + }, + { + "value": "Deallocate", + "description": "Nodes in the underlying Scale Set of the node pool are set to the stopped-deallocated state upon eviction. Nodes in the stopped-deallocated state count against your compute quota and can cause issues with cluster scaling or upgrading." + } + ] + }, + "title": "The Virtual Machine Scale Set eviction policy.", + "description": "The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms)" + }, + "SpotMaxPrice": { + "type": "number", + "default": -1, + "title": "The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.", + "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)" + }, + "ProximityPlacementGroupID": { + "type": "string", + "description": "The ID for Proximity Placement Group." + }, + "CredentialResults": { + "properties": { + "kubeconfigs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CredentialResult" + }, + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The list credential result response." + }, + "CredentialResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the credential." + }, + "value": { + "type": "string", + "format": "byte", + "readOnly": true, + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The credential result response." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "Details about the error." + } + }, + "description": "An error response from the Container 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." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Container service." + }, + "ManagedClusterSKU": { + "properties": { + "name": { + "type": "string", + "description": "The name of a managed cluster SKU.", + "enum": [ + "Basic" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "title": "The tier of a managed cluster SKU.", + "description": "If not specified, the default is 'Free'. See [uptime SLA](https://docs.microsoft.com/azure/aks/uptime-sla) for more details.", + "enum": [ + "Paid", + "Free" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUTier", + "modelAsString": true, + "values": [ + { + "value": "Paid", + "description": "Guarantees 99.95% availability of the Kubernetes API server endpoint for clusters that use Availability Zones and 99.9% of availability for clusters that don't use Availability Zones." + }, + { + "value": "Free", + "description": "No guaranteed SLA, no additional charges. Free tier clusters have an SLO of 99.5%." + } + ] + } + } + }, + "description": "The SKU of a Managed Cluster." + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "A list of private endpoint connections", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the private endpoint connection." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the private endpoint connection.", + "externalDocs": { + "url": "https://aka.ms/search-naming-rules" + } + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The properties of a private endpoint connection.", + "x-ms-client-flatten": true + } + }, + "x-ms-azure-resource": true + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "description": "Properties of a private endpoint connection.", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private endpoint." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpoint": { + "type": "object", + "description": "Private endpoint which a connection belongs to.", + "properties": { + "id": { + "description": "The resource ID of the private endpoint", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "The state of a private link service connection.", + "type": "object", + "properties": { + "status": { + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "description": "The private link service connection status.", + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + } + }, + "description": { + "type": "string", + "description": "The private link service connection description." + } + } + }, + "PrivateLinkResourcesListResult": { + "type": "object", + "description": "A list of private link resources", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + } + }, + "PrivateLinkResource": { + "description": "A private link resource", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the private link resource." + }, + "name": { + "type": "string", + "description": "The name of the private link resource.", + "externalDocs": { + "url": "https://aka.ms/search-naming-rules" + } + }, + "type": { + "type": "string", + "description": "The resource type." + }, + "groupId": { + "type": "string", + "description": "The group ID of the resource." + }, + "requiredMembers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The RequiredMembers of the resource" + }, + "privateLinkServiceID": { + "readOnly": true, + "type": "string", + "description": "The private link service ID of the resource, this field is exposed only to NRP internally." + } + } + }, + "OSDiskType": { + "type": "string", + "enum": [ + "Managed", + "Ephemeral" + ], + "x-ms-enum": { + "name": "OSDiskType", + "modelAsString": true, + "values": [ + { + "value": "Managed", + "description": "Azure replicates the operating system disk for a virtual machine to Azure storage to avoid data loss should the VM need to be relocated to another host. Since containers aren't designed to have local state persisted, this behavior offers limited value while providing some drawbacks, including slower node provisioning and higher read/write latency." + }, + { + "value": "Ephemeral", + "description": "Ephemeral OS disks are stored only on the host machine, just like a temporary disk. This provides lower read/write latency, along with faster node scaling and cluster upgrades." + } + ] + }, + "title": "The OS disk type to be used for machines in the agent pool.", + "description": "The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os)." + }, + "KubeletDiskType": { + "type": "string", + "enum": [ + "OS", + "Temporary" + ], + "x-ms-enum": { + "name": "KubeletDiskType", + "modelAsString": true, + "values": [ + { + "value": "OS", + "description": "Kubelet will use the OS disk for its data." + }, + { + "value": "Temporary", + "description": "Kubelet will use the temporary disk for its data." + } + ] + }, + "description": "Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage." + }, + "KubeletConfig": { + "title": "Kubelet configurations of agent nodes.", + "description": "See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details.", + "type": "object", + "properties": { + "cpuManagerPolicy": { + "type": "string", + "title": "The CPU Manager policy to use.", + "description": "The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'." + }, + "cpuCfsQuota": { + "type": "boolean", + "title": "If CPU CFS quota enforcement is enabled for containers that specify CPU limits.", + "description": "The default is true." + }, + "cpuCfsQuotaPeriod": { + "type": "string", + "title": "The CPU CFS quota period value.", + "description": "The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'." + }, + "imageGcHighThreshold": { + "type": "integer", + "format": "int32", + "title": "The percent of disk usage after which image garbage collection is always run.", + "description": "To disable image garbage collection, set to 100. The default is 85%" + }, + "imageGcLowThreshold": { + "type": "integer", + "format": "int32", + "title": "The percent of disk usage before which image garbage collection is never run.", + "description": "This cannot be set higher than imageGcHighThreshold. The default is 80%" + }, + "topologyManagerPolicy": { + "type": "string", + "title": "The Topology Manager policy to use.", + "description": "For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'." + }, + "allowedUnsafeSysctls": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`)." + }, + "failSwapOn": { + "type": "boolean", + "description": "If set to true it will make the Kubelet fail to start if swap is enabled on the node." + }, + "containerLogMaxSizeMB": { + "type": "integer", + "format": "int32", + "description": "The maximum size (e.g. 10Mi) of container log file before it is rotated." + }, + "containerLogMaxFiles": { + "type": "integer", + "format": "int32", + "description": "The maximum number of container log files that can be present for a container. The number must be ≥ 2.", + "minimum": 2 + }, + "podMaxPids": { + "type": "integer", + "format": "int32", + "description": "The maximum number of processes per pod." + } + } + }, + "LinuxOSConfig": { + "title": "OS configurations of Linux agent nodes.", + "description": "See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details.", + "type": "object", + "properties": { + "sysctls": { + "$ref": "#/definitions/SysctlConfig", + "description": "Sysctl settings for Linux agent nodes." + }, + "transparentHugePageEnabled": { + "type": "string", + "title": "Whether transparent hugepages are enabled.", + "description": "Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)." + }, + "transparentHugePageDefrag": { + "type": "string", + "title": "Whether the kernel should make aggressive use of memory compaction to make more hugepages available.", + "description": "Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)." + }, + "swapFileSizeMB": { + "type": "integer", + "format": "int32", + "description": "The size in MB of a swap file that will be created on each node." + } + } + }, + "SysctlConfig": { + "description": "Sysctl settings for Linux agent nodes.", + "type": "object", + "properties": { + "netCoreSomaxconn": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.somaxconn." + }, + "netCoreNetdevMaxBacklog": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.netdev_max_backlog." + }, + "netCoreRmemDefault": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.rmem_default." + }, + "netCoreRmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.rmem_max." + }, + "netCoreWmemDefault": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.wmem_default." + }, + "netCoreWmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.wmem_max." + }, + "netCoreOptmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.optmem_max." + }, + "netIpv4TcpMaxSynBacklog": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_max_syn_backlog." + }, + "netIpv4TcpMaxTwBuckets": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_max_tw_buckets." + }, + "netIpv4TcpFinTimeout": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_fin_timeout." + }, + "netIpv4TcpKeepaliveTime": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_keepalive_time." + }, + "netIpv4TcpKeepaliveProbes": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_keepalive_probes." + }, + "netIpv4TcpkeepaliveIntvl": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_keepalive_intvl." + }, + "netIpv4TcpTwReuse": { + "type": "boolean", + "description": "Sysctl setting net.ipv4.tcp_tw_reuse." + }, + "netIpv4IpLocalPortRange": { + "type": "string", + "description": "Sysctl setting net.ipv4.ip_local_port_range." + }, + "netIpv4NeighDefaultGcThresh1": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh1." + }, + "netIpv4NeighDefaultGcThresh2": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh2." + }, + "netIpv4NeighDefaultGcThresh3": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh3." + }, + "netNetfilterNfConntrackMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.netfilter.nf_conntrack_max." + }, + "netNetfilterNfConntrackBuckets": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.netfilter.nf_conntrack_buckets." + }, + "fsInotifyMaxUserWatches": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.inotify.max_user_watches." + }, + "fsFileMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.file-max." + }, + "fsAioMaxNr": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.aio-max-nr." + }, + "fsNrOpen": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.nr_open." + }, + "kernelThreadsMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting kernel.threads-max." + }, + "vmMaxMapCount": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.max_map_count." + }, + "vmSwappiness": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.swappiness." + }, + "vmVfsCachePressure": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.vfs_cache_pressure." + } + } + }, + "ManagedClusterHTTPProxyConfig": { + "description": "Cluster HTTP proxy configuration.", + "type": "object", + "properties": { + "httpProxy": { + "type": "string", + "description": "The HTTP proxy server endpoint to use." + }, + "httpsProxy": { + "type": "string", + "description": "The HTTPS proxy server endpoint to use." + }, + "noProxy": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The endpoints that should not go through proxy." + }, + "trustedCa": { + "type": "string", + "description": "Alternative CA cert to use for connecting to proxy servers." + } + } + }, + "GPUInstanceProfile": { + "type": "string", + "enum": [ + "MIG1g", + "MIG2g", + "MIG3g", + "MIG4g", + "MIG7g" + ], + "x-ms-enum": { + "name": "GPUInstanceProfile ", + "modelAsString": true + }, + "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU." + }, + "ExtendedLocationType": { + "type": "string", + "description": "The type of extendedLocation.", + "enum": [ + "EdgeZone" + ], + "x-ms-enum": { + "name": "ExtendedLocationTypes", + "modelAsString": true + } + }, + "ExtendedLocation": { + "description": "The complex type of the extended location.", + "properties": { + "name": { + "type": "string", + "description": "The name of the extended location." + }, + "type": { + "$ref": "#/definitions/ExtendedLocationType", + "description": "The type of the extended location." + } + } + }, + "OSOptionProperty": { + "properties": { + "os-type": { + "type": "string", + "description": "The OS type." + }, + "enable-fips-image": { + "type": "boolean", + "description": "Whether the image is FIPS-enabled." + } + }, + "required": [ + "os-type", + "enable-fips-image" + ], + "description": "OS option property." + }, + "OSOptionPropertyList": { + "properties": { + "osOptionPropertyList": { + "type": "array", + "items": { + "$ref": "#/definitions/OSOptionProperty" + }, + "description": "The list of OS options." + } + }, + "required": [ + "osOptionPropertyList" + ], + "description": "The list of OS option properties." + }, + "OSOptionProfile": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the OS option resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the OS option resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the OS option resource." + }, + "properties": { + "$ref": "#/definitions/OSOptionPropertyList", + "description": "The list of OS options.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The OS option profile." + }, + "EndpointDependency": { + "description": "A domain name that AKS agent nodes are reaching at.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name of the dependency.", + "type": "string" + }, + "endpointDetails": { + "description": "The Ports and Protocols used when connecting to domainName.", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDetail" + } + } + } + }, + "EndpointDetail": { + "description": "connect information from the AKS agent nodes to a single endpoint.", + "type": "object", + "properties": { + "ipAddress": { + "description": "An IP Address that Domain Name currently resolves to.", + "type": "string" + }, + "port": { + "format": "int32", + "description": "The port an endpoint is connected to.", + "type": "integer" + }, + "protocol": { + "description": "The protocol used for connection", + "type": "string" + }, + "description": { + "description": "Description of the detail", + "type": "string" + } + } + }, + "OutboundEnvironmentEndpoint": { + "description": "Egress endpoints which AKS agent nodes connect to for common purpose.", + "type": "object", + "properties": { + "category": { + "description": "The category of endpoints accessed by the AKS agent node, e.g. azure-resource-management, apiserver, etc.", + "type": "string" + }, + "endpoints": { + "description": "The endpoints that AKS agent nodes connect to", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDependency" + } + } + } + }, + "OutboundEnvironmentEndpointCollection": { + "description": "Collection of OutboundEnvironmentEndpoint", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/OutboundEnvironmentEndpoint" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version.", + "x-ms-parameter-location": "client" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ResourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "description": "The name of the managed cluster resource.", + "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region.", + "x-ms-parameter-location": "method" + }, + "ResourceTypeParameter": { + "name": "resource-type", + "in": "query", + "required": false, + "type": "string", + "description": "The resource type for which the OS options needs to be returned", + "x-ms-parameter-location": "method" + }, + "ServerFqdnParameter": { + "name": "server-fqdn", + "in": "query", + "required": false, + "type": "string", + "description": "server fqdn type for credentials to be returned", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_CustomNodeConfig.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_CustomNodeConfig.json new file mode 100644 index 000000000000..7a81e35c0ae8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_CustomNodeConfig.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_EnableEncryptionAtHost.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_EnableEncryptionAtHost.json new file mode 100644 index 000000000000..7bd011745f8a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_EnableEncryptionAtHost.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_EnableFIPS.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_EnableFIPS.json new file mode 100644 index 000000000000..36ad833bed75 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_EnableFIPS.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableFIPS": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_EnableUltraSSD.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_EnableUltraSSD.json new file mode 100644 index 000000000000..420a94ccdfbe --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_EnableUltraSSD.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableUltraSSD": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableUltraSSD": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableUltraSSD": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_Ephemeral.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_Ephemeral.json new file mode 100644 index 000000000000..33e772e6e07d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_Ephemeral.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osDiskType": "Ephemeral", + "osDiskSizeGB": 64 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskType": "Ephemeral", + "osDiskSizeGB": 64 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskType": "Ephemeral", + "kubeletDiskType": "OS", + "osDiskSizeGB": 64 + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_GPUMIG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_GPUMIG.json new file mode 100644 index 000000000000..b6d119023c27 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_GPUMIG.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_OSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_OSSKU.json new file mode 100644 index 000000000000..d0685bd412d8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_OSSKU.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osSKU": "CBLMariner", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "CBLMariner", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "CBLMariner", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_PPG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_PPG.json new file mode 100644 index 000000000000..c9126120e912 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_PPG.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers//Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers//Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers//Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_Spot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_Spot.json new file mode 100644 index 000000000000..0d716d389482 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_Spot.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "spotMaxPrice": -1 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "spotMaxPrice": -1 + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_Update.json new file mode 100644 index 000000000000..bfc73da7aa8c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsCreate_Update.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsDelete.json new file mode 100644 index 000000000000..7abd28274a60 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsGet.json new file mode 100644 index 000000000000..7115e7bf5908 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json new file mode 100644 index 000000000000..4b70589ba17c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/availableagentpoolversions", + "name": "default", + "properties": { + "agentPoolVersions": [ + { + "kubernetesVersion": "1.12.7" + }, + { + "kubernetesVersion": "1.12.8" + }, + { + "default": true, + "kubernetesVersion": "1.13.5", + "isPreview": true + } + ] + }, + "type": "Microsoft.ContainerService/managedClusters/availableAgentpoolVersions" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsGetUpgradeProfile.json new file mode 100644 index 000000000000..523ba5165458 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsGetUpgradeProfile.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/upgradeprofiles/default", + "name": "default", + "properties": { + "kubernetesVersion": "1.12.8", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.13.5" + } + ], + "latestNodeImageVersion": "AKSUbuntu:1604:2020.03.11" + }, + "type": "Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsList.json new file mode 100644 index 000000000000..f6d876b4d9e1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsList.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsUpgradeNodeImageVersion.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsUpgradeNodeImageVersion.json new file mode 100644 index 000000000000..80111711caea --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPoolsUpgradeNodeImageVersion.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": {}, + "202": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "UpgradingNodeImageVersion", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu-1604-2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPools_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPools_Update.json new file mode 100644 index 000000000000..e22a36fb6619 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/AgentPools_Update.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Updating", + "orchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ContainerServiceGetOSOptions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ContainerServiceGetOSOptions.json new file mode 100644 index 000000000000..81567aad6a93 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ContainerServiceGetOSOptions.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/providers/Microsoft.ContainerService/locations/location1/osOptions/default", + "name": "default", + "type": "Microsoft.ContainerService/locations/osOptions", + "properties": { + "osOptionPropertyList": [ + { + "os-type": "Linux", + "enable-fips-image": false + }, + { + "os-type": "Windows", + "enable-fips-image": false + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/MaintenanceConfigurationsCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/MaintenanceConfigurationsCreate_Update.json new file mode 100644 index 000000000000..659e202045b2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/MaintenanceConfigurationsCreate_Update.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default", + "parameters": { + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/MaintenanceConfigurationsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/MaintenanceConfigurationsDelete.json new file mode 100644 index 000000000000..252d9d9ec5a1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/MaintenanceConfigurationsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/MaintenanceConfigurationsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/MaintenanceConfigurationsGet.json new file mode 100644 index 000000000000..359ad13790ed --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/MaintenanceConfigurationsGet.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "default", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/MaintenanceConfigurationsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/MaintenanceConfigurationsList.json new file mode 100644 index 000000000000..10ef8a493b28 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/MaintenanceConfigurationsList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "default", + "properties": { + "timeInWeek": [ + { + "day": "Monday", + "hourSlots": [ + 1, + 2 + ] + } + ], + "notAllowedTime": [ + { + "start": "2020-11-26T03:00:00Z", + "end": "2020-11-30T12:00:00Z" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_EnableEncryptionAtHost.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_EnableEncryptionAtHost.json new file mode 100644 index 000000000000..9befa3db9ec0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_EnableEncryptionAtHost.json @@ -0,0 +1,236 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_EnableUltraSSD.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_EnableUltraSSD.json new file mode 100644 index 000000000000..c6e275c77fa5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_EnableUltraSSD.json @@ -0,0 +1,236 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_EnabledFIPS.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_EnabledFIPS.json new file mode 100644 index 000000000000..87045b6bd58e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_EnabledFIPS.json @@ -0,0 +1,236 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_GPUMIG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_GPUMIG.json new file mode 100644 index 000000000000..7d0e144c3631 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_GPUMIG.json @@ -0,0 +1,263 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_HTTPProxy.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_HTTPProxy.json new file mode 100644 index 000000000000..9f44b5355fac --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_HTTPProxy.json @@ -0,0 +1,260 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_ManagedNATGateway.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_ManagedNATGateway.json new file mode 100644 index 000000000000..273c3967f0c5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_ManagedNATGateway.json @@ -0,0 +1,231 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "managedOutboundIPProfile": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "idleTimeoutInMinutes": 4, + "managedOutboundIPProfile": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "idleTimeoutInMinutes": 4, + "managedOutboundIPProfile": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_NodePublicIPPrefix.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_NodePublicIPPrefix.json new file mode 100644 index 000000000000..c6669505e40f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_NodePublicIPPrefix.json @@ -0,0 +1,236 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodePublicIPPrefixID": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "nodePublicIPPrefixID": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodePublicIPPrefixID": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_OSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_OSSKU.json new file mode 100644 index 000000000000..0442c3fcbcf4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_OSSKU.json @@ -0,0 +1,263 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osSKU": "CBLMariner", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "CBLMariner", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "CBLMariner", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_PPG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_PPG.json new file mode 100644 index 000000000000..bb0a9cff6af5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_PPG.json @@ -0,0 +1,236 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers//Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers//Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers//Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_PodIdentity.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_PodIdentity.json new file mode 100644 index 000000000000..84be13528663 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_PodIdentity.json @@ -0,0 +1,245 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json new file mode 100644 index 000000000000..a1476b36261f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json @@ -0,0 +1,246 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "privateFQDN": "domain1.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "privateFQDN": "domain1.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json new file mode 100644 index 000000000000..abfdd1507653 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json @@ -0,0 +1,250 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true + }, + "addonProfiles": {}, + "enableRBAC": true, + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true, + "privateDNSZone": "system" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true, + "privateDNSZone": "system" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_SecurityProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_SecurityProfile.json new file mode 100644 index 000000000000..246b9da63e52 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_SecurityProfile.json @@ -0,0 +1,227 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "securityProfile": { + "azureDefender": { + "enabled": true, + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "securityProfile": { + "azureDefender": { + "enabled": true, + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "securityProfile": { + "azureDefender": { + "enabled": true, + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_Update.json new file mode 100644 index 000000000000..69c71a5ad646 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_Update.json @@ -0,0 +1,285 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_UpdateWithAHUB.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_UpdateWithAHUB.json new file mode 100644 index 000000000000..27f72d5fee7e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_UpdateWithAHUB.json @@ -0,0 +1,275 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json new file mode 100644 index 000000000000..aff62fd4fa0b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json @@ -0,0 +1,264 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "aadProfile": { + "managed": true, + "enableAzureRBAC": true + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aadProfile": { + "managed": true, + "adminGroupObjectIDs": null, + "enableAzureRBAC": true, + "tenantID": "tenantID" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aadProfile": { + "managed": true, + "adminGroupObjectIDs": null, + "enableAzureRBAC": true, + "tenantID": "tenantID" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_UserAssignedNATGateway.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_UserAssignedNATGateway.json new file mode 100644 index 000000000000..98c7777dcc27 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_UserAssignedNATGateway.json @@ -0,0 +1,198 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersDelete.json new file mode 100644 index 000000000000..8619884896be --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersGet.json new file mode 100644 index 000000000000..e16b90a8e161 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersGet.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "azurePortalFQDN": "dnsprefix1-abcd1234.portal.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "availabilityZones": [ + "1", + "2", + "3" + ], + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "outboundIPs": { + "publicIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip2" + } + ] + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersGetAccessProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersGetAccessProfile.json new file mode 100644 index 000000000000..a146c96ba0bc --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersGetAccessProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "roleName": "clusterUser" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/accessProfiles/clusterUser", + "location": "location1", + "name": "clusterUser", + "properties": { + "kubeConfig": "kubeConfig1" + }, + "type": "Microsoft.ContainerService/ManagedClusters/AccessProfiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersGetUpgradeProfile.json new file mode 100644 index 000000000000..83e19917c07d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersGetUpgradeProfile.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/upgradeprofiles/default", + "name": "default", + "properties": { + "agentPoolProfiles": [ + { + "kubernetesVersion": "1.7.7", + "name": "agent", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.7.9" + }, + { + "kubernetesVersion": "1.7.11", + "isPreview": true + } + ] + } + ], + "controlPlaneProfile": { + "kubernetesVersion": "1.7.7", + "name": "master", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.7.9", + "isPreview": true + }, + { + "kubernetesVersion": "1.7.11" + } + ] + } + }, + "type": "Microsoft.ContainerService/managedClusters/upgradeprofiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersList.json new file mode 100644 index 000000000000..114534764189 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersList.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/providers/Microsoft.ContainerService/managedClusters", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "maxAgentPools": 1, + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersListByResourceGroup.json new file mode 100644 index 000000000000..906c34655f43 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersListByResourceGroup.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "maxAgentPools": 1, + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersListClusterCredentialResult.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersListClusterCredentialResult.json new file mode 100644 index 000000000000..610bdce6972a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersListClusterCredentialResult.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "credentialValue1" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersResetAADProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersResetAADProfile.json new file mode 100644 index 000000000000..d87d79f4ff29 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersResetAADProfile.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientAppID": "clientappid", + "serverAppID": "serverappid", + "serverAppSecret": "serverappsecret", + "tenantID": "tenantid" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersResetServicePrincipalProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersResetServicePrincipalProfile.json new file mode 100644 index 000000000000..8e2c79eb820d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersResetServicePrincipalProfile.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientId": "clientid", + "secret": "secret" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersRotateClusterCertificates.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersRotateClusterCertificates.json new file mode 100644 index 000000000000..8619884896be --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersRotateClusterCertificates.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersStart.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersStart.json new file mode 100644 index 000000000000..8619884896be --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersStart.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersStop.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersStop.json new file mode 100644 index 000000000000..8619884896be --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersStop.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersUpdateTags.json new file mode 100644 index 000000000000..43fb1d61bbe5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersUpdateTags.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "tags": { + "tier": "testing", + "archv3": "" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv3": "", + "tier": "testing" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/OutboundNetworkDependenciesEndpointsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/OutboundNetworkDependenciesEndpointsList.json new file mode 100644 index 000000000000..5ddcd803ef8f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/OutboundNetworkDependenciesEndpointsList.json @@ -0,0 +1,242 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "management.azure.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "login.microsoftonline.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "images", + "endpoints": [ + { + "domainName": "mcr.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "*.data.mcr.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https", + "description": "mcr cdn" + } + ] + } + ] + }, + { + "category": "artifacts", + "endpoints": [ + { + "domainName": "packages.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "acs-mirror.azureedge.net", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "time-sync", + "endpoints": [ + { + "domainName": "ntp.ubuntu.com", + "endpointDetails": [ + { + "port": 123, + "protocol": "UDP" + } + ] + } + ] + }, + { + "category": "ubuntu-optional", + "endpoints": [ + { + "domainName": "security.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "azure.archive.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "changelogs.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + } + ] + }, + { + "category": "gpu", + "endpoints": [ + { + "domainName": "nvidia.github.io", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "us.download.nvidia.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "apt.dockerproject.org", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "windows", + "endpoints": [ + { + "domainName": "onegetcdn.azureedge.net", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "go.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "*.mp.microsoft.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "www.msftconnecttest.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "ctldl.windowsupdate.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + } + ] + }, + { + "category": "apiserver", + "endpoints": [ + { + "domainName": "*.azmk8s.io", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "tunnel-classic", + "endpoints": [ + { + "domainName": "*.azmk8s.io", + "endpointDetails": [ + { + "port": 9000, + "protocol": "TCP" + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateEndpointConnectionsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateEndpointConnectionsDelete.json new file mode 100644 index 000000000000..f3f0d1147be2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateEndpointConnectionsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateEndpointConnectionsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateEndpointConnectionsGet.json new file mode 100644 index 000000000000..9e553822c7f3 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateEndpointConnectionsGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1" + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + }, + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateEndpointConnectionsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateEndpointConnectionsList.json new file mode 100644 index 000000000000..c326b66057d2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateEndpointConnectionsList.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + }, + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateEndpointConnectionsUpdate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateEndpointConnectionsUpdate.json new file mode 100644 index 000000000000..2597e4561133 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateEndpointConnectionsUpdate.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + }, + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateLinkResourcesList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateLinkResourcesList.json new file mode 100644 index 000000000000..917d4b4f846f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/PrivateLinkResourcesList.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "management", + "type": "Microsoft.ContainerService/managedClusters/privateLinkResources", + "groupId": "management", + "requiredMembers": [ + "management" + ], + "privateLinkServiceID": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/plsName" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ResolvePrivateLinkServiceId.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ResolvePrivateLinkServiceId.json new file mode 100644 index 000000000000..6ba35d2a6bbf --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/ResolvePrivateLinkServiceId.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "name": "management" + } + }, + "responses": { + "200": { + "body": { + "privateLinkServiceID": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/plsName" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/RunCommandRequest.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/RunCommandRequest.json new file mode 100644 index 000000000000..ca1e14b98238 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/RunCommandRequest.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "requestPayload": { + "command": "kubectl apply -f ns.yaml", + "context": "", + "clusterToken": "" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2021-07-01" + } + }, + "200": { + "description": "to mitigate RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE", + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "succeeded", + "exitCode": 0, + "startedAt": "2021-02-17T00:28:20Z", + "finishedAt": "2021-02-17T00:28:33Z", + "logs": "namespace dummy created" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/RunCommandResultFailed.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/RunCommandResultFailed.json new file mode 100644 index 000000000000..39245dc8c6f9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/RunCommandResultFailed.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "commandId": "def7b3ea71bd4f7e9d226ddbc0f00ad9" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2021-07-01" + } + }, + "200": { + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "failed", + "reason": "ImagePullBackoff" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/RunCommandResultSucceed.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/RunCommandResultSucceed.json new file mode 100644 index 000000000000..a573f93953ed --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/examples/RunCommandResultSucceed.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "commandId": "def7b3ea71bd4f7e9d226ddbc0f00ad9" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2021-07-01" + } + }, + "200": { + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "succeeded", + "exitCode": 0, + "startedAt": "2021-02-17T00:28:20Z", + "finishedAt": "2021-02-17T00:28:33Z", + "logs": "namespace dummy created" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/managedClusters.json new file mode 100644 index 000000000000..8ff720f12f79 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/managedClusters.json @@ -0,0 +1,5109 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerServiceClient", + "description": "The Container Service Client.", + "version": "2021-07-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.ContainerService/operations": { + "get": { + "tags": [ + "managedClusters" + ], + "operationId": "Operations_List", + "summary": "Gets a list of operations.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/osOptions/default": { + "get": { + "tags": [ + "managedClusters" + ], + "operationId": "ManagedClusters_GetOSOptions", + "summary": "Gets supported OS options in the specified subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ResourceTypeParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OSOptionProfile" + } + } + }, + "x-ms-examples": { + "Get Container Service OS Options": { + "$ref": "./examples/ContainerServiceGetOSOptions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_List", + "summary": "Gets a list of managed clusters in the specified subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Managed Clusters": { + "$ref": "./examples/ManagedClustersList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListByResourceGroup", + "summary": "Lists managed clusters in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Managed Clusters by Resource Group": { + "$ref": "./examples/ManagedClustersListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/upgradeProfiles/default": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetUpgradeProfile", + "summary": "Gets the upgrade profile of a managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Managed Cluster": { + "$ref": "./examples/ManagedClustersGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/accessProfiles/{roleName}/listCredential": { + "post": { + "deprecated": true, + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetAccessProfile", + "summary": "Gets an access profile of a managed cluster.", + "description": "**WARNING**: This API will be deprecated. Instead use [ListClusterUserCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusterusercredentials) or [ListClusterAdminCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusteradmincredentials) .", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "roleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role for managed cluster accessProfile resource." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterAccessProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGetAccessProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterAdminCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterAdminCredentials", + "summary": "Lists the admin credentials of a managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterCredentialResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterUserCredentials", + "summary": "Lists the user credentials of a managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterCredentialResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterMonitoringUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterMonitoringUserCredentials", + "summary": "Lists the cluster monitoring user credentials of a managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterCredentialResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Get", + "summary": "Gets a managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_CreateOrUpdate", + "summary": "Creates or updates a managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "The managed cluster to create or update." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Managed Cluster": { + "$ref": "./examples/ManagedClustersCreate_Update.json" + }, + "Create/Update AAD Managed Cluster with EnableAzureRBAC": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json" + }, + "Create Managed Cluster with PPG": { + "$ref": "./examples/ManagedClustersCreate_PPG.json" + }, + "Create Managed Cluster with OSSKU": { + "$ref": "./examples/ManagedClustersCreate_OSSKU.json" + }, + "Create Managed Cluster with GPUMIG": { + "$ref": "./examples/ManagedClustersCreate_GPUMIG.json" + }, + "Create/Update Managed Cluster with EnableAHUB": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithAHUB.json" + }, + "Create Managed Cluster with EncryptionAtHost enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableEncryptionAtHost.json" + }, + "Create Managed Cluster with UltraSSD enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableUltraSSD.json" + }, + "Create Managed Cluster with PodIdentity enabled": { + "$ref": "./examples/ManagedClustersCreate_PodIdentity.json" + }, + "Create Managed Private Cluster with fqdn subdomain specified": { + "$ref": "./examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json" + }, + "Create Managed Private Cluster with Public FQDN specified": { + "$ref": "./examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json" + }, + "Create Managed Cluster with Node Public IP Prefix": { + "$ref": "./examples/ManagedClustersCreate_NodePublicIPPrefix.json" + }, + "Create Managed Cluster with FIPS enabled OS": { + "$ref": "./examples/ManagedClustersCreate_EnabledFIPS.json" + }, + "Create Managed Cluster with HTTP proxy configured": { + "$ref": "./examples/ManagedClustersCreate_HTTPProxy.json" + }, + "Create Managed Cluster with Security Profile configured": { + "$ref": "./examples/ManagedClustersCreate_SecurityProfile.json" + }, + "Create Managed Cluster with AKS-managed NAT gateway as outbound type": { + "$ref": "./examples/ManagedClustersCreate_ManagedNATGateway.json" + }, + "Create Managed Cluster with user-assigned NAT gateway as outbound type": { + "$ref": "./examples/ManagedClustersCreate_UserAssignedNATGateway.json" + } + } + }, + "patch": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_UpdateTags", + "summary": "Updates tags on a managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update Managed Cluster Tags operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update Managed Cluster Tags": { + "$ref": "./examples/ManagedClustersUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Delete", + "summary": "Deletes a managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Managed Cluster": { + "$ref": "./examples/ManagedClustersDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations": { + "get": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_ListByManagedCluster", + "summary": "Gets a list of maintenance configurations in the specified managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List maintenance configurations by Managed Cluster": { + "$ref": "./examples/MaintenanceConfigurationsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations/{configName}": { + "get": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_Get", + "summary": "Gets the specified maintenance configuration of a managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsGet.json" + } + } + }, + "put": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_CreateOrUpdate", + "summary": "Creates or updates a maintenance configuration in the specified managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + }, + "description": "The maintenance configuration to create or update." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Create/Update Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsCreate_Update.json" + } + } + }, + "delete": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_Delete", + "summary": "Deletes a maintenance configuration.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Delete Maintenance Configuration": { + "$ref": "./examples/MaintenanceConfigurationsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_List", + "summary": "Gets a list of agent pools in the specified managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Agent Pools by Managed Cluster": { + "$ref": "./examples/AgentPoolsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_Get", + "summary": "Gets the specified managed cluster agent pool.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the agent pool." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Agent Pool": { + "$ref": "./examples/AgentPoolsGet.json" + } + } + }, + "put": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_CreateOrUpdate", + "summary": "Creates or updates an agent pool in the specified managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the agent pool." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AgentPool" + }, + "description": "The agent pool to create or update." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Agent Pool": { + "$ref": "./examples/AgentPoolsCreate_Update.json" + }, + "Update Agent Pool": { + "$ref": "./examples/AgentPools_Update.json" + }, + "Create Spot Agent Pool": { + "$ref": "./examples/AgentPoolsCreate_Spot.json" + }, + "Create Agent Pool with PPG": { + "$ref": "./examples/AgentPoolsCreate_PPG.json" + }, + "Create Agent Pool with OSSKU": { + "$ref": "./examples/AgentPoolsCreate_OSSKU.json" + }, + "Create Agent Pool with GPUMIG": { + "$ref": "./examples/AgentPoolsCreate_GPUMIG.json" + }, + "Create Agent Pool with Ephemeral OS Disk": { + "$ref": "./examples/AgentPoolsCreate_Ephemeral.json" + }, + "Create Agent Pool with KubeletConfig and LinuxOSConfig": { + "$ref": "./examples/AgentPoolsCreate_CustomNodeConfig.json" + }, + "Create Agent Pool with EncryptionAtHost enabled": { + "$ref": "./examples/AgentPoolsCreate_EnableEncryptionAtHost.json" + }, + "Create Agent Pool with UltraSSD enabled": { + "$ref": "./examples/AgentPoolsCreate_EnableUltraSSD.json" + }, + "Create Agent Pool with FIPS enabled OS": { + "$ref": "./examples/AgentPoolsCreate_EnableFIPS.json" + } + } + }, + "delete": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_Delete", + "summary": "Deletes an agent pool in the specified managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the agent pool." + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Agent Pool": { + "$ref": "./examples/AgentPoolsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeProfiles/default": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_GetUpgradeProfile", + "summary": "Gets the upgrade profile for an agent pool.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the agent pool." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Agent Pool": { + "$ref": "./examples/AgentPoolsGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/availableAgentPoolVersions": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_GetAvailableAgentPoolVersions", + "summary": "Gets a list of supported Kubernetes versions for the specified agent pool.", + "description": "See [supported Kubernetes versions](https://docs.microsoft.com/azure/aks/supported-kubernetes-versions) for more details about the version lifecycle.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolAvailableVersions" + } + } + }, + "x-ms-examples": { + "Get available versions for agent pool": { + "$ref": "./examples/AgentPoolsGetAgentPoolAvailableVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetServicePrincipalProfile": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetServicePrincipalProfile", + "summary": "Reset the Service Principal Profile of a managed cluster.", + "description": "This action cannot be performed on a cluster that is not using a service principal", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile" + }, + "description": "The service principal profile to set on the managed cluster." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Reset Service Principal Profile": { + "$ref": "./examples/ManagedClustersResetServicePrincipalProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetAADProfile": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetAADProfile", + "summary": "Reset the AAD Profile of a managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterAADProfile" + }, + "description": "The AAD profile to set on the Managed Cluster" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Reset AAD Profile": { + "$ref": "./examples/ManagedClustersResetAADProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateClusterCertificates": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RotateClusterCertificates", + "summary": "Rotates the certificates of a managed cluster.", + "description": "See [Certificate rotation](https://docs.microsoft.com/azure/aks/certificate-rotation) for more details about rotating managed cluster certificates.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Rotate Cluster Certificates": { + "$ref": "./examples/ManagedClustersRotateClusterCertificates.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/stop": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Stop", + "summary": "Stops a Managed Cluster", + "description": "This can only be performed on Azure Virtual Machine Scale set backed clusters. Stopping a cluster stops the control plane and agent nodes entirely, while maintaining all object and cluster state. A cluster does not accrue charges while it is stopped. See [stopping a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about stopping a cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Stop Managed Cluster": { + "$ref": "./examples/ManagedClustersStop.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/start": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Start", + "summary": "Starts a previously stopped Managed Cluster", + "description": "See [starting a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about starting a cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Start Managed Cluster": { + "$ref": "./examples/ManagedClustersStart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "summary": "Gets a list of private endpoint connections in the specified managed cluster.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Private Endpoint Connections by Managed Cluster": { + "$ref": "./examples/PrivateEndpointConnectionsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "summary": "Gets the specified private endpoint connection.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Update", + "summary": "Updates a private endpoint connection.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The updated private endpoint connection." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "summary": "Deletes a private endpoint connection.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content -- The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeNodeImageVersion": { + "post": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_UpgradeNodeImageVersion", + "summary": "Upgrades the node image version of an agent pool to the latest.", + "description": "Upgrading the node image version of an agent pool applies the newest OS and runtime updates to the nodes. AKS provides one new image per week with the latest updates. For more details on node image versions, see: https://docs.microsoft.com/azure/aks/node-image-upgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the agent pool." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Upgrade Agent Pool Node Image Version": { + "$ref": "./examples/AgentPoolsUpgradeNodeImageVersion.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "privateLinkResources" + ], + "operationId": "PrivateLinkResources_List", + "summary": "Gets a list of private link resources in the specified managed cluster.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResourcesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Private Link Resources by Managed Cluster": { + "$ref": "./examples/PrivateLinkResourcesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resolvePrivateLinkServiceId": { + "post": { + "tags": [ + "resolvePrivateLinkServiceId" + ], + "operationId": "ResolvePrivateLinkServiceId_POST", + "summary": "Gets the private link service ID for the specified managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "Parameters required in order to resolve a private link service ID." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Resolve the Private Link Service ID for Managed Cluster": { + "$ref": "./examples/ResolvePrivateLinkServiceId.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/runCommand": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RunCommand", + "summary": "Submits a command to run against the Managed Cluster.", + "description": "AKS will create a pod to run the command. This is primarily useful for private clusters. For more information see [AKS Run Command](https://docs.microsoft.com/azure/aks/private-clusters#aks-run-command-preview).", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "requestPayload", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunCommandRequest" + }, + "description": "The run command request" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "200": { + "description": "command finished with async pattern, tracking by location header. !!! this is for autorest only, you never get 200 from this api !!!", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "submitNewCommand": { + "$ref": "./examples/RunCommandRequest.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/commandResults/{commandId}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetCommandResult", + "summary": "Gets the results of a command which has been run on the Managed Cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "commandId", + "in": "path", + "required": true, + "type": "string", + "description": "Id of the command." + } + ], + "responses": { + "202": { + "description": "command running in progress" + }, + "200": { + "description": "command finished", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "commandSucceedResult": { + "$ref": "./examples/RunCommandResultSucceed.json" + }, + "commandFailedResult": { + "$ref": "./examples/RunCommandResultFailed.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/outboundNetworkDependenciesEndpoints": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListOutboundNetworkDependenciesEndpoints", + "summary": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster.", + "description": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster. The operation returns properties of each egress endpoint.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OutboundEnvironmentEndpointCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List OutboundNetworkDependenciesEndpoints by Managed Cluster": { + "$ref": "./examples/OutboundNetworkDependenciesEndpointsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "OperationListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OperationValue" + }, + "description": "The list of operations" + } + }, + "description": "The List Operation response." + }, + "OperationValue": { + "properties": { + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of the operation." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the operation." + }, + "display": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationValueDisplay", + "description": "Describes the properties of a Operation Value Display." + } + }, + "description": "Describes the properties of a Operation value." + }, + "OperationValueDisplay": { + "properties": { + "operation": { + "type": "string", + "readOnly": true, + "description": "The display name of the operation." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "The display name of the resource the operation applies to." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "The description of the operation." + }, + "provider": { + "type": "string", + "readOnly": true, + "description": "The resource provider for the operation." + } + }, + "description": "Describes the properties of a Operation Value Display." + }, + "Resource": { + "description": "The 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" + }, + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + }, + "SubResource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource ID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + } + }, + "description": "Reference to another subresource.", + "x-ms-azure-resource": true + }, + "TagsObject": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + }, + "ContainerServiceOSDisk": { + "type": "integer", + "format": "int32", + "maximum": 2048, + "minimum": 0, + "description": "OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." + }, + "ContainerServiceStorageProfile": { + "type": "string", + "x-ms-enum": { + "name": "ContainerServiceStorageProfileTypes", + "modelAsString": true + }, + "enum": [ + "StorageAccount", + "ManagedDisks" + ], + "description": "Specifies what kind of storage to use. If omitted, the default will be chosen on your behalf based on the choice of orchestrator." + }, + "ContainerServiceVnetSubnetID": { + "type": "string", + "description": "specifies a subnet's resource id with subscription, resource group, vnet and subnet name" + }, + "ContainerServiceVMSize": { + "type": "string", + "x-ms-enum": { + "name": "ContainerServiceVMSizeTypes", + "modelAsString": true + }, + "description": "Size of agent VMs. Note: This is no longer maintained.", + "enum": [ + "Standard_A1", + "Standard_A10", + "Standard_A11", + "Standard_A1_v2", + "Standard_A2", + "Standard_A2_v2", + "Standard_A2m_v2", + "Standard_A3", + "Standard_A4", + "Standard_A4_v2", + "Standard_A4m_v2", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A8_v2", + "Standard_A8m_v2", + "Standard_A9", + "Standard_B2ms", + "Standard_B2s", + "Standard_B4ms", + "Standard_B8ms", + "Standard_D1", + "Standard_D11", + "Standard_D11_v2", + "Standard_D11_v2_Promo", + "Standard_D12", + "Standard_D12_v2", + "Standard_D12_v2_Promo", + "Standard_D13", + "Standard_D13_v2", + "Standard_D13_v2_Promo", + "Standard_D14", + "Standard_D14_v2", + "Standard_D14_v2_Promo", + "Standard_D15_v2", + "Standard_D16_v3", + "Standard_D16s_v3", + "Standard_D1_v2", + "Standard_D2", + "Standard_D2_v2", + "Standard_D2_v2_Promo", + "Standard_D2_v3", + "Standard_D2s_v3", + "Standard_D3", + "Standard_D32_v3", + "Standard_D32s_v3", + "Standard_D3_v2", + "Standard_D3_v2_Promo", + "Standard_D4", + "Standard_D4_v2", + "Standard_D4_v2_Promo", + "Standard_D4_v3", + "Standard_D4s_v3", + "Standard_D5_v2", + "Standard_D5_v2_Promo", + "Standard_D64_v3", + "Standard_D64s_v3", + "Standard_D8_v3", + "Standard_D8s_v3", + "Standard_DS1", + "Standard_DS11", + "Standard_DS11_v2", + "Standard_DS11_v2_Promo", + "Standard_DS12", + "Standard_DS12_v2", + "Standard_DS12_v2_Promo", + "Standard_DS13", + "Standard_DS13-2_v2", + "Standard_DS13-4_v2", + "Standard_DS13_v2", + "Standard_DS13_v2_Promo", + "Standard_DS14", + "Standard_DS14-4_v2", + "Standard_DS14-8_v2", + "Standard_DS14_v2", + "Standard_DS14_v2_Promo", + "Standard_DS15_v2", + "Standard_DS1_v2", + "Standard_DS2", + "Standard_DS2_v2", + "Standard_DS2_v2_Promo", + "Standard_DS3", + "Standard_DS3_v2", + "Standard_DS3_v2_Promo", + "Standard_DS4", + "Standard_DS4_v2", + "Standard_DS4_v2_Promo", + "Standard_DS5_v2", + "Standard_DS5_v2_Promo", + "Standard_E16_v3", + "Standard_E16s_v3", + "Standard_E2_v3", + "Standard_E2s_v3", + "Standard_E32-16s_v3", + "Standard_E32-8s_v3", + "Standard_E32_v3", + "Standard_E32s_v3", + "Standard_E4_v3", + "Standard_E4s_v3", + "Standard_E64-16s_v3", + "Standard_E64-32s_v3", + "Standard_E64_v3", + "Standard_E64s_v3", + "Standard_E8_v3", + "Standard_E8s_v3", + "Standard_F1", + "Standard_F16", + "Standard_F16s", + "Standard_F16s_v2", + "Standard_F1s", + "Standard_F2", + "Standard_F2s", + "Standard_F2s_v2", + "Standard_F32s_v2", + "Standard_F4", + "Standard_F4s", + "Standard_F4s_v2", + "Standard_F64s_v2", + "Standard_F72s_v2", + "Standard_F8", + "Standard_F8s", + "Standard_F8s_v2", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS4-4", + "Standard_GS4-8", + "Standard_GS5", + "Standard_GS5-16", + "Standard_GS5-8", + "Standard_H16", + "Standard_H16m", + "Standard_H16mr", + "Standard_H16r", + "Standard_H8", + "Standard_H8m", + "Standard_L16s", + "Standard_L32s", + "Standard_L4s", + "Standard_L8s", + "Standard_M128-32ms", + "Standard_M128-64ms", + "Standard_M128ms", + "Standard_M128s", + "Standard_M64-16ms", + "Standard_M64-32ms", + "Standard_M64ms", + "Standard_M64s", + "Standard_NC12", + "Standard_NC12s_v2", + "Standard_NC12s_v3", + "Standard_NC24", + "Standard_NC24r", + "Standard_NC24rs_v2", + "Standard_NC24rs_v3", + "Standard_NC24s_v2", + "Standard_NC24s_v3", + "Standard_NC6", + "Standard_NC6s_v2", + "Standard_NC6s_v3", + "Standard_ND12s", + "Standard_ND24rs", + "Standard_ND24s", + "Standard_ND6s", + "Standard_NV12", + "Standard_NV24", + "Standard_NV6" + ] + }, + "ManagedClusterServicePrincipalProfile": { + "properties": { + "clientId": { + "type": "string", + "description": "The ID for the service principal." + }, + "secret": { + "type": "string", + "description": "The secret password associated with the service principal in plain text." + } + }, + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs.", + "required": [ + "clientId" + ] + }, + "ContainerServiceMasterProfile": { + "properties": { + "count": { + "type": "integer", + "format": "int32", + "enum": [ + 1, + 3, + 5 + ], + "x-ms-enum": { + "name": "Count", + "modelAsString": false + }, + "description": "Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1.", + "default": 1 + }, + "dnsPrefix": { + "type": "string", + "description": "DNS prefix to be used to create the FQDN for the master pool." + }, + "vmSize": { + "$ref": "#/definitions/ContainerServiceVMSize", + "description": "Size of agent VMs." + }, + "osDiskSizeGB": { + "$ref": "#/definitions/ContainerServiceOSDisk", + "description": "OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." + }, + "vnetSubnetID": { + "$ref": "#/definitions/ContainerServiceVnetSubnetID", + "description": "VNet SubnetID specifies the VNet's subnet identifier." + }, + "firstConsecutiveStaticIP": { + "type": "string", + "description": "FirstConsecutiveStaticIP used to specify the first static ip of masters.", + "default": "10.240.255.5" + }, + "storageProfile": { + "$ref": "#/definitions/ContainerServiceStorageProfile", + "description": "Storage profile specifies what kind of storage used. Choose from StorageAccount and ManagedDisks. Leave it empty, we will choose for you based on the orchestrator choice." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "FQDN for the master pool." + } + }, + "required": [ + "dnsPrefix", + "vmSize" + ], + "description": "Profile for the container service master." + }, + "ManagedClusterAgentPoolProfileProperties": { + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1." + }, + "vmSize": { + "type": "string", + "title": "The size of the agent pool VMs.", + "description": "VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions" + }, + "osDiskSizeGB": { + "$ref": "#/definitions/ContainerServiceOSDisk" + }, + "osDiskType": { + "$ref": "#/definitions/OSDiskType" + }, + "kubeletDiskType": { + "$ref": "#/definitions/KubeletDiskType" + }, + "vnetSubnetID": { + "type": "string", + "title": "The ID of the subnet which agent pool nodes and optionally pods will join on startup.", + "description": "If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "podSubnetID": { + "type": "string", + "title": "The ID of the subnet which pods will join when launched.", + "description": "If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "maxPods": { + "type": "integer", + "format": "int32", + "description": "The maximum number of pods that can run on a node." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "osSKU": { + "$ref": "#/definitions/OSSKU" + }, + "maxCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of nodes for auto-scaling" + }, + "minCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of nodes for auto-scaling" + }, + "enableAutoScaling": { + "type": "boolean", + "description": "Whether to enable auto-scaler" + }, + "scaleDownMode": { + "$ref": "#/definitions/ScaleDownMode", + "title": "The scale down mode to use when scaling the Agent Pool.", + "description": "This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete." + }, + "type": { + "$ref": "#/definitions/AgentPoolType" + }, + "mode": { + "$ref": "#/definitions/AgentPoolMode" + }, + "orchestratorVersion": { + "type": "string", + "title": "The version of Kubernetes running on the Agent Pool.", + "description": "As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool)." + }, + "nodeImageVersion": { + "readOnly": true, + "type": "string", + "description": "The version of node image" + }, + "upgradeSettings": { + "$ref": "#/definitions/AgentPoolUpgradeSettings", + "description": "Settings for upgrading the agentpool" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state." + }, + "powerState": { + "readOnly": true, + "description": "Describes whether the Agent Pool is Running or Stopped", + "$ref": "#/definitions/PowerState" + }, + "availabilityZones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'." + }, + "enableNodePublicIP": { + "type": "boolean", + "title": "Whether each node is allocated its own public IP.", + "description": "Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false." + }, + "nodePublicIPPrefixID": { + "type": "string", + "title": "The public IP prefix ID which VM nodes should use IPs from.", + "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "scaleSetPriority": { + "$ref": "#/definitions/ScaleSetPriority", + "description": "The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'." + }, + "scaleSetEvictionPolicy": { + "$ref": "#/definitions/ScaleSetEvictionPolicy", + "title": "The Virtual Machine Scale Set eviction policy to use.", + "description": "This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'." + }, + "spotMaxPrice": { + "$ref": "#/definitions/SpotMaxPrice", + "title": "The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.", + "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags to be persisted on the agent pool virtual machine scale set." + }, + "nodeLabels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The node labels to be persisted across all nodes in agent pool." + }, + "nodeTaints": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule." + }, + "proximityPlacementGroupID": { + "$ref": "#/definitions/ProximityPlacementGroupID", + "description": "The ID for Proximity Placement Group." + }, + "kubeletConfig": { + "$ref": "#/definitions/KubeletConfig", + "description": "The Kubelet configuration on the agent pool nodes." + }, + "linuxOSConfig": { + "$ref": "#/definitions/LinuxOSConfig", + "description": "The OS configuration of Linux agent nodes." + }, + "enableEncryptionAtHost": { + "type": "boolean", + "title": "Whether to enable host based OS and data drive encryption.", + "description": "This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption" + }, + "enableUltraSSD": { + "type": "boolean", + "description": "Whether to enable UltraSSD" + }, + "enableFIPS": { + "type": "boolean", + "title": "Whether to use a FIPS-enabled OS.", + "description": "See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details." + }, + "gpuInstanceProfile": { + "$ref": "#/definitions/GPUInstanceProfile", + "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU." + } + }, + "description": "Properties for the container service agent pool profile." + }, + "ManagedClusterAgentPoolProfile": { + "allOf": [ + { + "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties" + }, + { + "properties": { + "name": { + "type": "string", + "title": "Unique name of the agent pool profile in the context of the subscription and resource group.", + "description": "Windows agent pool names must be 6 characters or less.", + "pattern": "^[a-z][a-z0-9]{0,11}$" + } + } + } + ], + "required": [ + "name" + ], + "description": "Profile for the container service agent pool." + }, + "AgentPoolType": { + "type": "string", + "enum": [ + "VirtualMachineScaleSets", + "AvailabilitySet" + ], + "x-ms-enum": { + "name": "AgentPoolType", + "modelAsString": true, + "values": [ + { + "value": "VirtualMachineScaleSets", + "description": "Create an Agent Pool backed by a Virtual Machine Scale Set." + }, + { + "value": "AvailabilitySet", + "description": "Use of this is strongly discouraged." + } + ] + }, + "description": "The type of Agent Pool." + }, + "AgentPoolMode": { + "type": "string", + "enum": [ + "System", + "User" + ], + "x-ms-enum": { + "name": "AgentPoolMode", + "modelAsString": true, + "values": [ + { + "value": "System", + "description": "System agent pools are primarily for hosting critical system pods such as CoreDNS and metrics-server. System agent pools osType must be Linux. System agent pools VM SKU must have at least 2vCPUs and 4GB of memory." + }, + { + "value": "User", + "description": "User agent pools are primarily for hosting your application pods." + } + ] + }, + "title": "The mode of an agent pool.", + "description": "A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools" + }, + "AgentPoolListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AgentPool" + }, + "description": "The list of agent pools." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of agent pool results.", + "readOnly": true + } + }, + "description": "The response from the List Agent Pools operation." + }, + "AgentPoolUpgradeSettings": { + "properties": { + "maxSurge": { + "type": "string", + "title": "The maximum number or percentage of nodes that are surged during upgrade.", + "description": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade" + } + }, + "description": "Settings for upgrading an agentpool" + }, + "AgentPool": { + "allOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "properties": { + "properties": { + "description": "Properties of an agent pool.", + "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties", + "x-ms-client-flatten": true + } + } + } + ], + "description": "Agent Pool." + }, + "ManagedClusterWindowsProfile": { + "properties": { + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

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

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

    **Minimum-length:** 1 character

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

    **Minimum-length:** 8 characters

    **Max-length:** 123 characters

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

    **Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\"" + }, + "licenseType": { + "type": "string", + "enum": [ + "None", + "Windows_Server" + ], + "x-ms-enum": { + "name": "licenseType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No additional licensing is applied." + }, + { + "value": "Windows_Server", + "description": "Enables Azure Hybrid User Benefits for Windows VMs." + } + ] + }, + "description": "The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details." + }, + "enableCSIProxy": { + "type": "boolean", + "title": "Whether to enable CSI proxy.", + "description": "For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy)." + } + }, + "required": [ + "adminUsername" + ], + "description": "Profile for Windows VMs in the managed cluster." + }, + "ContainerServiceLinuxProfile": { + "properties": { + "adminUsername": { + "type": "string", + "description": "The administrator username to use for Linux VMs.", + "pattern": "^[A-Za-z][-A-Za-z0-9_]*$" + }, + "ssh": { + "$ref": "#/definitions/ContainerServiceSshConfiguration", + "description": "The SSH configuration for Linux-based VMs running on Azure." + } + }, + "required": [ + "adminUsername", + "ssh" + ], + "description": "Profile for Linux VMs in the container service cluster." + }, + "ContainerServiceNetworkProfile": { + "properties": { + "networkPlugin": { + "type": "string", + "enum": [ + "azure", + "kubenet" + ], + "default": "kubenet", + "x-ms-enum": { + "name": "NetworkPlugin", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Use the Azure CNI network plugin. See [Azure CNI (advanced) networking](https://docs.microsoft.com/azure/aks/concepts-network#azure-cni-advanced-networking) for more information." + }, + { + "value": "kubenet", + "description": "Use the Kubenet network plugin. See [Kubenet (basic) networking](https://docs.microsoft.com/azure/aks/concepts-network#kubenet-basic-networking) for more information." + } + ] + }, + "description": "Network plugin used for building the Kubernetes network." + }, + "networkPolicy": { + "type": "string", + "enum": [ + "calico", + "azure" + ], + "x-ms-enum": { + "name": "NetworkPolicy", + "modelAsString": true, + "values": [ + { + "value": "calico", + "description": "Use Calico network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information." + }, + { + "value": "azure", + "description": "Use Azure network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information." + } + ] + }, + "description": "Network policy used for building the Kubernetes network." + }, + "networkMode": { + "type": "string", + "enum": [ + "transparent", + "bridge" + ], + "x-ms-enum": { + "name": "networkMode", + "modelAsString": true, + "values": [ + { + "value": "transparent", + "description": "No bridge is created. Intra-VM Pod to Pod communication is through IP routes created by Azure CNI. See [Transparent Mode](https://docs.microsoft.com/azure/aks/faq#transparent-mode) for more information." + }, + { + "value": "bridge", + "description": "This is no longer supported" + } + ] + }, + "title": "The network mode Azure CNI is configured with.", + "description": "This cannot be specified if networkPlugin is anything other than 'azure'." + }, + "podCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.244.0.0/16", + "description": "A CIDR notation IP range from which to assign pod IPs when kubenet is used." + }, + "serviceCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.0.0.0/16", + "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges." + }, + "dnsServiceIP": { + "type": "string", + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "default": "10.0.0.10", + "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr." + }, + "dockerBridgeCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "172.17.0.1/16", + "description": "A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range." + }, + "outboundType": { + "type": "string", + "enum": [ + "loadBalancer", + "userDefinedRouting", + "managedNATGateway", + "userAssignedNATGateway" + ], + "x-ms-enum": { + "name": "outboundType", + "modelAsString": true, + "values": [ + { + "value": "loadBalancer", + "description": "The load balancer is used for egress through an AKS assigned public IP. This supports Kubernetes services of type 'loadBalancer'. For more information see [outbound type loadbalancer](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-loadbalancer)." + }, + { + "value": "userDefinedRouting", + "description": "Egress paths must be defined by the user. This is an advanced scenario and requires proper network configuration. For more information see [outbound type userDefinedRouting](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-userdefinedrouting)." + }, + { + "value": "managedNATGateway", + "description": "The AKS-managed NAT gateway is used for egress." + }, + { + "value": "userAssignedNATGateway", + "description": "The user-assigned NAT gateway associated to the cluster subnet is used for egress. This is an advanced scenario and requires proper network configuration." + } + ] + }, + "default": "loadBalancer", + "title": "The outbound (egress) routing method.", + "description": "This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype)." + }, + "loadBalancerSku": { + "type": "string", + "enum": [ + "standard", + "basic" + ], + "x-ms-enum": { + "name": "loadBalancerSku", + "modelAsString": true, + "values": [ + { + "value": "standard", + "description": "Use a a standard Load Balancer. This is the recommended Load Balancer SKU. For more information about on working with the load balancer in the managed cluster, see the [standard Load Balancer](https://docs.microsoft.com/azure/aks/load-balancer-standard) article." + }, + { + "value": "basic", + "description": "Use a basic Load Balancer with limited functionality." + } + ] + }, + "title": "The load balancer sku for the managed cluster.", + "description": "The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs." + }, + "loadBalancerProfile": { + "$ref": "#/definitions/ManagedClusterLoadBalancerProfile", + "description": "Profile of the cluster load balancer." + }, + "natGatewayProfile": { + "$ref": "#/definitions/ManagedClusterNATGatewayProfile", + "description": "Profile of the cluster NAT gateway." + } + }, + "description": "Profile of network configuration." + }, + "MaintenanceConfigurationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MaintenanceConfiguration" + }, + "description": "The list of maintenance configurations." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of maintenance configuration results.", + "readOnly": true + } + }, + "description": "The response from the List maintenance configurations operation." + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "type": "string", + "description": "The type of identity that created the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The UTC timestamp of resource creation." + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "type": "string", + "description": "The type of identity that last modified the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The type of identity that last modified the resource." + } + } + }, + "MaintenanceConfiguration": { + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "systemData": { + "$ref": "#/definitions/SystemData", + "readOnly": true, + "description": "The system metadata relating to this resource." + }, + "properties": { + "description": "Properties of a default maintenance configuration.", + "$ref": "#/definitions/MaintenanceConfigurationProperties", + "x-ms-client-flatten": true + } + }, + "title": "Planned maintenance configuration, used to configure when updates can be deployed to a Managed Cluster.", + "description": "See [planned maintenance](https://docs.microsoft.com/azure/aks/planned-maintenance) for more information about planned maintenance." + }, + "MaintenanceConfigurationProperties": { + "properties": { + "timeInWeek": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeInWeek" + }, + "title": "Time slots during the week when planned maintenance is allowed to proceed.", + "description": "If two array entries specify the same day of the week, the applied configuration is the union of times in both entries." + }, + "notAllowedTime": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeSpan" + }, + "description": "Time slots on which upgrade is not allowed." + } + }, + "description": "Properties used to configure planned maintenance for a Managed Cluster." + }, + "TimeInWeek": { + "properties": { + "day": { + "$ref": "#/definitions/WeekDay", + "description": "The day of the week." + }, + "hourSlots": { + "type": "array", + "items": { + "$ref": "#/definitions/HourInDay" + }, + "title": "A list of hours in the day used to identify a time range.", + "description": "Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range." + } + }, + "description": "Time in a week." + }, + "WeekDay": { + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "WeekDay", + "modelAsString": true + }, + "description": "The weekday enum." + }, + "HourInDay": { + "type": "integer", + "format": "int32", + "maximum": 23, + "minimum": 0, + "description": "Hour in a day." + }, + "TimeSpan": { + "properties": { + "start": { + "type": "string", + "format": "date-time", + "description": "The start of a time span" + }, + "end": { + "type": "string", + "format": "date-time", + "description": "The end of a time span" + } + }, + "title": "A time range.", + "description": "For example, between 2021-05-25T13:00:00Z and 2021-05-25T14:00:00Z." + }, + "RunCommandRequest": { + "properties": { + "command": { + "type": "string", + "description": "The command to run." + }, + "context": { + "type": "string", + "description": "A base64 encoded zip file containing the files required by the command." + }, + "clusterToken": { + "type": "string", + "description": "AuthToken issued for AKS AAD Server App." + } + }, + "description": "A run command request", + "required": [ + "command" + ] + }, + "RunCommandResult": { + "properties": { + "id": { + "type": "string", + "description": "The command id.", + "readOnly": true + }, + "properties": { + "description": "Properties of command result.", + "$ref": "#/definitions/CommandResultProperties", + "x-ms-client-flatten": true + } + }, + "description": "run command result." + }, + "CommandResultProperties": { + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "provisioning State" + }, + "exitCode": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The exit code of the command" + }, + "startedAt": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time when the command started." + }, + "finishedAt": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time when the command finished." + }, + "logs": { + "type": "string", + "readOnly": true, + "description": "The command output." + }, + "reason": { + "type": "string", + "readOnly": true, + "description": "An explanation of why provisioningState is set to failed (if so)." + } + }, + "description": "The results of a run command" + }, + "ManagedClusterNATGatewayProfile": { + "type": "object", + "properties": { + "managedOutboundIPProfile": { + "$ref": "#/definitions/ManagedClusterManagedOutboundIPProfile", + "description": "Profile of the managed outbound IP resources of the cluster NAT gateway." + }, + "effectiveOutboundIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "The effective outbound IP resources of the cluster NAT gateway." + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 120, + "minimum": 4, + "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes.", + "default": 4 + } + }, + "description": "Profile of the managed cluster NAT gateway." + }, + "ManagedClusterManagedOutboundIPProfile": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "maximum": 16, + "minimum": 1, + "description": "The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. ", + "default": 1 + } + }, + "description": "Profile of the managed outbound IP resources of the managed cluster." + }, + "ManagedClusterLoadBalancerProfile": { + "properties": { + "managedOutboundIPs": { + "properties": { + "count": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 1, + "description": "The desired number of outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ", + "default": 1 + } + }, + "description": "Desired managed outbound IPs for the cluster load balancer." + }, + "outboundIPPrefixes": { + "properties": { + "publicIPPrefixes": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP prefix resources." + } + }, + "description": "Desired outbound IP Prefix resources for the cluster load balancer." + }, + "outboundIPs": { + "properties": { + "publicIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP resources." + } + }, + "description": "Desired outbound IP resources for the cluster load balancer." + }, + "effectiveOutboundIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "The effective outbound IP resources of the cluster load balancer." + }, + "allocatedOutboundPorts": { + "type": "integer", + "format": "int32", + "maximum": 64000, + "minimum": 0, + "description": "The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports.", + "default": 0 + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 120, + "minimum": 4, + "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes.", + "default": 30 + } + }, + "description": "Profile of the managed cluster load balancer." + }, + "ResourceReference": { + "properties": { + "id": { + "type": "string", + "description": "The fully qualified Azure resource id." + } + }, + "description": "A reference to an Azure resource." + }, + "ContainerServiceSshConfiguration": { + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerServiceSshPublicKey" + }, + "description": "The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified." + } + }, + "description": "SSH configuration for Linux-based VMs running on Azure.", + "required": [ + "publicKeys" + ] + }, + "ContainerServiceSshPublicKey": { + "properties": { + "keyData": { + "type": "string", + "description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers." + } + }, + "required": [ + "keyData" + ], + "description": "Contains information about SSH certificate public key data." + }, + "ContainerServiceDiagnosticsProfile": { + "properties": { + "vmDiagnostics": { + "$ref": "#/definitions/ContainerServiceVMDiagnostics", + "description": "Profile for diagnostics on the container service VMs." + } + }, + "description": "Profile for diagnostics on the container service cluster.", + "required": [ + "vmDiagnostics" + ] + }, + "ContainerServiceVMDiagnostics": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the VM diagnostic agent is provisioned on the VM." + }, + "storageUri": { + "readOnly": true, + "type": "string", + "description": "The URI of the storage account where diagnostics are stored." + } + }, + "description": "Profile for diagnostics on the container service VMs.", + "required": [ + "enabled" + ] + }, + "ManagedClusterListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "The list of managed clusters." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of managed cluster results.", + "readOnly": true + } + }, + "description": "The response from the List Managed Clusters operation." + }, + "ManagedCluster": { + "properties": { + "sku": { + "$ref": "#/definitions/ManagedClusterSKU", + "description": "The managed cluster SKU." + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the Virtual Machine." + }, + "identity": { + "$ref": "#/definitions/ManagedClusterIdentity", + "description": "The identity of the managed cluster, if configured." + }, + "properties": { + "description": "Properties of a managed cluster.", + "$ref": "#/definitions/ManagedClusterProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Managed cluster." + }, + "ManagedClusterProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current provisioning state." + }, + "powerState": { + "$ref": "#/definitions/PowerState", + "description": "The Power State of the cluster.", + "readOnly": true + }, + "maxAgentPools": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The max number of agent pools for the managed cluster." + }, + "kubernetesVersion": { + "type": "string", + "title": "The version of Kubernetes the Managed Cluster is running.", + "description": "When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details." + }, + "dnsPrefix": { + "type": "string", + "title": "The DNS prefix of the Managed Cluster.", + "description": "This cannot be updated once the Managed Cluster has been created." + }, + "fqdnSubdomain": { + "type": "string", + "title": "The FQDN subdomain of the private cluster with custom private dns zone.", + "description": "This cannot be updated once the Managed Cluster has been created." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "The FQDN of the master pool." + }, + "privateFQDN": { + "readOnly": true, + "type": "string", + "description": "The FQDN of private cluster." + }, + "azurePortalFQDN": { + "readOnly": true, + "type": "string", + "title": "The special FQDN used by the Azure Portal to access the Managed Cluster. This FQDN is for use only by the Azure Portal and should not be used by other clients.", + "description": "The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterAgentPoolProfile" + }, + "description": "The agent pool properties." + }, + "linuxProfile": { + "$ref": "#/definitions/ContainerServiceLinuxProfile", + "description": "The profile for Linux VMs in the Managed Cluster." + }, + "windowsProfile": { + "$ref": "#/definitions/ManagedClusterWindowsProfile", + "description": "The profile for Windows VMs in the Managed Cluster." + }, + "servicePrincipalProfile": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile", + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs." + }, + "addonProfiles": { + "additionalProperties": { + "$ref": "#/definitions/ManagedClusterAddonProfile" + }, + "description": "The profile of managed cluster add-on." + }, + "podIdentityProfile": { + "$ref": "#/definitions/ManagedClusterPodIdentityProfile", + "title": "The pod identity profile of the Managed Cluster.", + "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on AAD pod identity integration." + }, + "nodeResourceGroup": { + "type": "string", + "description": "The name of the resource group containing agent pool nodes." + }, + "enableRBAC": { + "type": "boolean", + "description": "Whether to enable Kubernetes Role-Based Access Control." + }, + "enablePodSecurityPolicy": { + "type": "boolean", + "description": "(DEPRECATING) Whether to enable Kubernetes pod security policy (preview). This feature is set for removal on October 15th, 2020. Learn more at aka.ms/aks/azpodpolicy." + }, + "networkProfile": { + "$ref": "#/definitions/ContainerServiceNetworkProfile", + "description": "The network configuration profile." + }, + "aadProfile": { + "$ref": "#/definitions/ManagedClusterAADProfile", + "description": "The Azure Active Directory configuration." + }, + "autoUpgradeProfile": { + "$ref": "#/definitions/ManagedClusterAutoUpgradeProfile", + "description": "The auto upgrade configuration." + }, + "autoScalerProfile": { + "type": "object", + "properties": { + "balance-similar-node-groups": { + "type": "string", + "title": "Detects similar node pools and balances the number of nodes between them.", + "description": "Valid values are 'true' and 'false'" + }, + "expander": { + "type": "string", + "enum": [ + "least-waste", + "most-pods", + "priority", + "random" + ], + "x-ms-enum": { + "name": "expander", + "modelAsString": true, + "values": [ + { + "value": "least-waste", + "description": "Selects the node group that will have the least idle CPU (if tied, unused memory) after scale-up. This is useful when you have different classes of nodes, for example, high CPU or high memory nodes, and only want to expand those when there are pending pods that need a lot of those resources." + }, + { + "value": "most-pods", + "description": "Selects the node group that would be able to schedule the most pods when scaling up. This is useful when you are using nodeSelector to make sure certain pods land on certain nodes. Note that this won't cause the autoscaler to select bigger nodes vs. smaller, as it can add multiple smaller nodes at once." + }, + { + "value": "priority", + "description": "Selects the node group that has the highest priority assigned by the user. It's configuration is described in more details [here](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/expander/priority/readme.md)." + }, + { + "value": "random", + "description": "Used when you don't have a particular need for the node groups to scale differently." + } + ] + }, + "title": "The expander to use when scaling up", + "description": "If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information." + }, + "max-empty-bulk-delete": { + "type": "string", + "title": "The maximum number of empty nodes that can be deleted at the same time. This must be a positive integer.", + "description": "The default is 10." + }, + "max-graceful-termination-sec": { + "type": "string", + "title": "The maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node.", + "description": "The default is 600." + }, + "max-node-provision-time": { + "type": "string", + "title": "The maximum time the autoscaler waits for a node to be provisioned.", + "description": "The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "max-total-unready-percentage": { + "type": "string", + "title": "The maximum percentage of unready nodes in the cluster. After this percentage is exceeded, cluster autoscaler halts operations.", + "description": "The default is 45. The maximum is 100 and the minimum is 0." + }, + "new-pod-scale-up-delay": { + "type": "string", + "title": "Ignore unscheduled pods before they're a certain age.", + "description": "For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc)." + }, + "ok-total-unready-count": { + "type": "string", + "title": "The number of allowed unready nodes, irrespective of max-total-unready-percentage.", + "description": "This must be an integer. The default is 3." + }, + "scan-interval": { + "type": "string", + "title": "How often cluster is reevaluated for scale up or down.", + "description": "The default is '10'. Values must be an integer number of seconds." + }, + "scale-down-delay-after-add": { + "type": "string", + "title": "How long after scale up that scale down evaluation resumes", + "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-delay-after-delete": { + "type": "string", + "title": "How long after node deletion that scale down evaluation resumes.", + "description": "The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-delay-after-failure": { + "type": "string", + "title": "How long after scale down failure that scale down evaluation resumes.", + "description": "The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-unneeded-time": { + "type": "string", + "title": "How long a node should be unneeded before it is eligible for scale down.", + "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-unready-time": { + "type": "string", + "title": "How long an unready node should be unneeded before it is eligible for scale down", + "description": "The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-utilization-threshold": { + "type": "string", + "title": "Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down.", + "description": "The default is '0.5'." + }, + "skip-nodes-with-local-storage": { + "type": "string", + "title": "If cluster autoscaler will skip deleting nodes with pods with local storage, for example, EmptyDir or HostPath.", + "description": "The default is true." + }, + "skip-nodes-with-system-pods": { + "type": "string", + "title": "If cluster autoscaler will skip deleting nodes with pods from kube-system (except for DaemonSet or mirror pods)", + "description": "The default is true." + } + }, + "description": "Parameters to be applied to the cluster-autoscaler when enabled" + }, + "apiServerAccessProfile": { + "$ref": "#/definitions/ManagedClusterAPIServerAccessProfile", + "description": "The access profile for managed cluster API server." + }, + "diskEncryptionSetID": { + "type": "string", + "title": "The Resource ID of the disk encryption set to use for enabling encryption at rest.", + "description": "This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'" + }, + "identityProfile": { + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + }, + "description": "Identities associated with the cluster." + }, + "privateLinkResources": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "Private link resources associated with the cluster." + }, + "disableLocalAccounts": { + "type": "boolean", + "title": "If local accounts should be disabled on the Managed Cluster.", + "description": "If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview)." + }, + "httpProxyConfig": { + "$ref": "#/definitions/ManagedClusterHTTPProxyConfig", + "description": "Configurations for provisioning the cluster with HTTP proxy servers." + }, + "securityProfile": { + "$ref": "#/definitions/ManagedClusterSecurityProfile", + "description": "Security profile for the managed cluster." + } + }, + "description": "Properties of the managed cluster." + }, + "PowerState": { + "description": "Describes the Power State of the cluster", + "properties": { + "code": { + "type": "string", + "description": "Tells whether the cluster is Running or Stopped", + "enum": [ + "Running", + "Stopped" + ], + "x-ms-enum": { + "name": "code", + "modelAsString": true, + "values": [ + { + "value": "Running", + "description": "The cluster is running." + }, + { + "value": "Stopped", + "description": "The cluster is stopped." + } + ] + } + } + } + }, + "ManagedClusterAPIServerAccessProfile": { + "properties": { + "authorizedIPRanges": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The IP ranges authorized to access the Kubernetes API server.", + "description": "IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see [API server authorized IP ranges](https://docs.microsoft.com/azure/aks/api-server-authorized-ip-ranges)." + }, + "enablePrivateCluster": { + "type": "boolean", + "title": "Whether to create the cluster as a private cluster or not.", + "description": "For more details, see [Creating a private AKS cluster](https://docs.microsoft.com/azure/aks/private-clusters)." + }, + "privateDNSZone": { + "type": "string", + "title": "The private DNS zone mode for the cluster.", + "description": "The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'." + }, + "enablePrivateClusterPublicFQDN": { + "type": "boolean", + "description": "Whether to create additional public FQDN for private cluster or not." + } + }, + "description": "Access profile for managed cluster API server." + }, + "ManagedClusterIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the system assigned identity which is used by master components." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id of the system assigned identity which is used by master components." + }, + "type": { + "type": "string", + "title": "The type of identity used for the managed cluster.", + "description": "For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity).", + "enum": [ + "SystemAssigned", + "UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false, + "values": [ + { + "value": "SystemAssigned", + "description": "Use an implicitly created system assigned managed identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the system assigned managed identity to manipulate Azure resources." + }, + { + "value": "UserAssigned", + "description": "Use a user-specified identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the specified user assigned managed identity to manipulate Azure resources." + }, + { + "value": "None", + "description": "Do not use a managed identity for the Managed Cluster, service principal will be used instead." + } + ] + } + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "x-ms-client-name": "ManagedServiceIdentityUserAssignedIdentitiesValue", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "title": "The user identity associated with the managed cluster. This identity will be used in control plane. Only one user assigned identity is allowed.", + "description": "The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the managed cluster." + }, + "UserAssignedIdentity": { + "properties": { + "resourceId": { + "type": "string", + "description": "The resource ID of the user assigned identity." + }, + "clientId": { + "type": "string", + "description": "The client ID of the user assigned identity." + }, + "objectId": { + "type": "string", + "description": "The object ID of the user assigned identity." + } + }, + "description": "Details about a user assigned identity." + }, + "ManagedClusterAccessProfile": { + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "properties": { + "properties": { + "description": "AccessProfile of a managed cluster.", + "$ref": "#/definitions/AccessProfile", + "x-ms-client-flatten": true + } + } + } + ], + "description": "Managed cluster Access Profile.", + "x-ms-azure-resource": false + }, + "AccessProfile": { + "type": "object", + "properties": { + "kubeConfig": { + "type": "string", + "format": "byte", + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "Profile for enabling a user to access a managed cluster." + }, + "ManagedClusterPoolUpgradeProfile": { + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "name": { + "type": "string", + "description": "The Agent Pool name." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether the Kubernetes version is currently in preview." + } + } + }, + "description": "List of orchestrator types and versions available for upgrade." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "ManagedClusterUpgradeProfileProperties": { + "properties": { + "controlPlaneProfile": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile", + "description": "The list of available upgrade versions for the control plane." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile" + }, + "description": "The list of available upgrade versions for agent pools." + } + }, + "required": [ + "controlPlaneProfile", + "agentPoolProfiles" + ], + "description": "Control plane and agent pool upgrade profiles." + }, + "ManagedClusterAutoUpgradeProfile": { + "properties": { + "upgradeChannel": { + "type": "string", + "enum": [ + "rapid", + "stable", + "patch", + "node-image", + "none" + ], + "x-ms-enum": { + "name": "upgradeChannel", + "modelAsString": true, + "values": [ + { + "value": "rapid", + "description": "Automatically upgrade the cluster to the latest supported patch release on the latest supported minor version. In cases where the cluster is at a version of Kubernetes that is at an N-2 minor version where N is the latest supported minor version, the cluster first upgrades to the latest supported patch version on N-1 minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster first is upgraded to 1.18.6, then is upgraded to 1.19.1." + }, + { + "value": "stable", + "description": "Automatically upgrade the cluster to the latest supported patch release on minor version N-1, where N is the latest supported minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.18.6." + }, + { + "value": "patch", + "description": "Automatically upgrade the cluster to the latest supported patch version when it becomes available while keeping the minor version the same. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.17.9." + }, + { + "value": "node-image", + "description": "Automatically upgrade the node image to the latest version available. Microsoft provides patches and new images for image nodes frequently (usually weekly), but your running nodes won't get the new images unless you do a node image upgrade. Turning on the node-image channel will automatically update your node images whenever a new version is available." + }, + { + "value": "none", + "description": "Disables auto-upgrades and keeps the cluster at its current version of Kubernetes." + } + ] + }, + "title": "The upgrade channel for auto upgrade. The default is 'none'.", + "description": "For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel)." + } + }, + "description": "Auto upgrade profile for a managed cluster." + }, + "ManagedClusterAADProfile": { + "properties": { + "managed": { + "type": "boolean", + "description": "Whether to enable managed AAD." + }, + "enableAzureRBAC": { + "type": "boolean", + "description": "Whether to enable Azure RBAC for Kubernetes authorization." + }, + "adminGroupObjectIDs": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of AAD group object IDs that will have admin role of the cluster." + }, + "clientAppID": { + "type": "string", + "description": "The client AAD application ID." + }, + "serverAppID": { + "type": "string", + "description": "The server AAD application ID." + }, + "serverAppSecret": { + "type": "string", + "description": "The server AAD application secret." + }, + "tenantID": { + "type": "string", + "description": "The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription." + } + }, + "title": "AADProfile specifies attributes for Azure Active Directory integration.", + "description": "For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad)." + }, + "ManagedClusterAddonProfile": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the add-on is enabled or not." + }, + "config": { + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs for configuring an add-on." + }, + "identity": { + "readOnly": true, + "description": "Information of user assigned identity used by this add-on.", + "allOf": [ + { + "$ref": "#/definitions/UserAssignedIdentity" + } + ] + } + }, + "required": [ + "enabled" + ], + "description": "A Kubernetes add-on profile for a managed cluster." + }, + "ManagedClusterPodIdentity": { + "properties": { + "name": { + "type": "string", + "description": "The name of the pod identity." + }, + "namespace": { + "type": "string", + "description": "The namespace of the pod identity." + }, + "bindingSelector": { + "type": "string", + "description": "The binding selector to use for the AzureIdentityBinding resource." + }, + "identity": { + "$ref": "#/definitions/UserAssignedIdentity", + "description": "The user assigned identity details." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state of the pod identity.", + "enum": [ + "Assigned", + "Updating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "ManagedClusterPodIdentityProvisioningState", + "modelAsString": true + } + }, + "provisioningInfo": { + "readOnly": true, + "properties": { + "error": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningError", + "description": "Pod identity assignment error (if any)." + } + } + } + }, + "required": [ + "name", + "namespace", + "identity" + ], + "description": "Details about the pod identity assigned to the Managed Cluster." + }, + "ManagedClusterPodIdentityProvisioningError": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningErrorBody", + "description": "Details about the error." + } + }, + "description": "An error response from the pod identity provisioning." + }, + "ManagedClusterPodIdentityProvisioningErrorBody": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningErrorBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the pod identity provisioning." + }, + "ManagedClusterPodIdentityException": { + "properties": { + "name": { + "type": "string", + "description": "The name of the pod identity exception." + }, + "namespace": { + "type": "string", + "description": "The namespace of the pod identity exception." + }, + "podLabels": { + "type": "object", + "description": "The pod labels to match.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "name", + "namespace", + "podLabels" + ], + "title": "A pod identity exception, which allows pods with certain labels to access the Azure Instance Metadata Service (IMDS) endpoint without being intercepted by the node-managed identity (NMI) server.", + "description": "See [disable AAD Pod Identity for a specific Pod/Application](https://azure.github.io/aad-pod-identity/docs/configure/application_exception/) for more details." + }, + "ManagedClusterPodIdentityProfile": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the pod identity addon is enabled." + }, + "allowNetworkPluginKubenet": { + "type": "boolean", + "title": "Whether pod identity is allowed to run on clusters with Kubenet networking.", + "description": "Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information." + }, + "userAssignedIdentities": { + "description": "The pod identities to use in the cluster.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentity" + } + }, + "userAssignedIdentityExceptions": { + "description": "The pod identity exceptions to allow.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentityException" + } + } + }, + "title": "The pod identity profile of the Managed Cluster.", + "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration." + }, + "ManagedClusterUpgradeProfile": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the upgrade profile." + }, + "properties": { + "$ref": "#/definitions/ManagedClusterUpgradeProfileProperties", + "description": "The properties of the upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for compute pools." + }, + "AgentPoolUpgradeProfile": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the agent pool upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the agent pool upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the agent pool upgrade profile." + }, + "properties": { + "$ref": "#/definitions/AgentPoolUpgradeProfileProperties", + "description": "The properties of the agent pool upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for an agent pool." + }, + "AgentPoolUpgradeProfileProperties": { + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether the Kubernetes version is currently in preview." + } + } + }, + "description": "List of orchestrator types and versions available for upgrade." + }, + "latestNodeImageVersion": { + "type": "string", + "description": "The latest AKS supported node image version." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "AgentPoolAvailableVersions": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the agent pool version list." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the agent pool version list." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the agent pool version list." + }, + "properties": { + "$ref": "#/definitions/AgentPoolAvailableVersionsProperties", + "description": "Properties of agent pool available versions.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available versions for an agent pool." + }, + "AgentPoolAvailableVersionsProperties": { + "properties": { + "agentPoolVersions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "default": { + "type": "boolean", + "description": "Whether this version is the default agent pool version." + }, + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether Kubernetes version is currently in preview." + } + } + }, + "description": "List of versions available for agent pool." + } + }, + "description": "The list of available agent pool versions." + }, + "OSType": { + "type": "string", + "default": "Linux", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": true, + "values": [ + { + "value": "Linux", + "description": "Use Linux." + }, + { + "value": "Windows", + "description": "Use Windows." + } + ] + }, + "description": "The operating system type. The default is Linux." + }, + "OSSKU": { + "type": "string", + "enum": [ + "Ubuntu", + "CBLMariner" + ], + "x-ms-enum": { + "name": "OSSKU", + "modelAsString": true + }, + "description": "Specifies an OS SKU. This value must not be specified if OSType is Windows." + }, + "ScaleSetPriority": { + "type": "string", + "default": "Regular", + "enum": [ + "Spot", + "Regular" + ], + "x-ms-enum": { + "name": "ScaleSetPriority", + "modelAsString": true, + "values": [ + { + "value": "Spot", + "description": "Spot priority VMs will be used. There is no SLA for spot nodes. See [spot on AKS](https://docs.microsoft.com/azure/aks/spot-node-pool) for more information." + }, + { + "value": "Regular", + "description": "Regular VMs will be used." + } + ] + }, + "description": "The Virtual Machine Scale Set priority." + }, + "ScaleSetEvictionPolicy": { + "type": "string", + "default": "Delete", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "ScaleSetEvictionPolicy", + "modelAsString": true, + "values": [ + { + "value": "Delete", + "description": "Nodes in the underlying Scale Set of the node pool are deleted when they're evicted." + }, + { + "value": "Deallocate", + "description": "Nodes in the underlying Scale Set of the node pool are set to the stopped-deallocated state upon eviction. Nodes in the stopped-deallocated state count against your compute quota and can cause issues with cluster scaling or upgrading." + } + ] + }, + "title": "The Virtual Machine Scale Set eviction policy.", + "description": "The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms)" + }, + "SpotMaxPrice": { + "type": "number", + "default": -1, + "title": "The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.", + "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)" + }, + "ScaleDownMode": { + "type": "string", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "ScaleDownMode", + "modelAsString": true, + "values": [ + { + "value": "Delete", + "description": "Create new instances during scale up and remove instances during scale down." + }, + { + "value": "Deallocate", + "description": "Attempt to start deallocated instances (if they exist) during scale up and deallocate instances during scale down." + } + ] + }, + "description": "Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing)." + }, + "ProximityPlacementGroupID": { + "type": "string", + "description": "The ID for Proximity Placement Group." + }, + "CredentialResults": { + "properties": { + "kubeconfigs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CredentialResult" + }, + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The list credential result response." + }, + "CredentialResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the credential." + }, + "value": { + "type": "string", + "format": "byte", + "readOnly": true, + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The credential result response." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "Details about the error." + } + }, + "description": "An error response from the Container 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." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Container service." + }, + "ManagedClusterSKU": { + "properties": { + "name": { + "type": "string", + "description": "The name of a managed cluster SKU.", + "enum": [ + "Basic" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "title": "The tier of a managed cluster SKU.", + "description": "If not specified, the default is 'Free'. See [uptime SLA](https://docs.microsoft.com/azure/aks/uptime-sla) for more details.", + "enum": [ + "Paid", + "Free" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUTier", + "modelAsString": true, + "values": [ + { + "value": "Paid", + "description": "Guarantees 99.95% availability of the Kubernetes API server endpoint for clusters that use Availability Zones and 99.9% of availability for clusters that don't use Availability Zones." + }, + { + "value": "Free", + "description": "No guaranteed SLA, no additional charges. Free tier clusters have an SLO of 99.5%." + } + ] + } + } + }, + "description": "The SKU of a Managed Cluster." + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "A list of private endpoint connections", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the private endpoint connection." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the private endpoint connection.", + "externalDocs": { + "url": "https://aka.ms/search-naming-rules" + } + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The properties of a private endpoint connection.", + "x-ms-client-flatten": true + } + }, + "x-ms-azure-resource": true + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "description": "Properties of a private endpoint connection.", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private endpoint." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpoint": { + "type": "object", + "description": "Private endpoint which a connection belongs to.", + "properties": { + "id": { + "description": "The resource ID of the private endpoint", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "The state of a private link service connection.", + "type": "object", + "properties": { + "status": { + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "description": "The private link service connection status.", + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + } + }, + "description": { + "type": "string", + "description": "The private link service connection description." + } + } + }, + "PrivateLinkResourcesListResult": { + "type": "object", + "description": "A list of private link resources", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + } + }, + "PrivateLinkResource": { + "description": "A private link resource", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the private link resource." + }, + "name": { + "type": "string", + "description": "The name of the private link resource.", + "externalDocs": { + "url": "https://aka.ms/search-naming-rules" + } + }, + "type": { + "type": "string", + "description": "The resource type." + }, + "groupId": { + "type": "string", + "description": "The group ID of the resource." + }, + "requiredMembers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The RequiredMembers of the resource" + }, + "privateLinkServiceID": { + "readOnly": true, + "type": "string", + "description": "The private link service ID of the resource, this field is exposed only to NRP internally." + } + } + }, + "OSDiskType": { + "type": "string", + "enum": [ + "Managed", + "Ephemeral" + ], + "x-ms-enum": { + "name": "OSDiskType", + "modelAsString": true, + "values": [ + { + "value": "Managed", + "description": "Azure replicates the operating system disk for a virtual machine to Azure storage to avoid data loss should the VM need to be relocated to another host. Since containers aren't designed to have local state persisted, this behavior offers limited value while providing some drawbacks, including slower node provisioning and higher read/write latency." + }, + { + "value": "Ephemeral", + "description": "Ephemeral OS disks are stored only on the host machine, just like a temporary disk. This provides lower read/write latency, along with faster node scaling and cluster upgrades." + } + ] + }, + "title": "The OS disk type to be used for machines in the agent pool.", + "description": "The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os)." + }, + "KubeletDiskType": { + "type": "string", + "enum": [ + "OS", + "Temporary" + ], + "x-ms-enum": { + "name": "KubeletDiskType", + "modelAsString": true, + "values": [ + { + "value": "OS", + "description": "Kubelet will use the OS disk for its data." + }, + { + "value": "Temporary", + "description": "Kubelet will use the temporary disk for its data." + } + ] + }, + "description": "Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage." + }, + "KubeletConfig": { + "title": "Kubelet configurations of agent nodes.", + "description": "See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details.", + "type": "object", + "properties": { + "cpuManagerPolicy": { + "type": "string", + "title": "The CPU Manager policy to use.", + "description": "The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'." + }, + "cpuCfsQuota": { + "type": "boolean", + "title": "If CPU CFS quota enforcement is enabled for containers that specify CPU limits.", + "description": "The default is true." + }, + "cpuCfsQuotaPeriod": { + "type": "string", + "title": "The CPU CFS quota period value.", + "description": "The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'." + }, + "imageGcHighThreshold": { + "type": "integer", + "format": "int32", + "title": "The percent of disk usage after which image garbage collection is always run.", + "description": "To disable image garbage collection, set to 100. The default is 85%" + }, + "imageGcLowThreshold": { + "type": "integer", + "format": "int32", + "title": "The percent of disk usage before which image garbage collection is never run.", + "description": "This cannot be set higher than imageGcHighThreshold. The default is 80%" + }, + "topologyManagerPolicy": { + "type": "string", + "title": "The Topology Manager policy to use.", + "description": "For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'." + }, + "allowedUnsafeSysctls": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`)." + }, + "failSwapOn": { + "type": "boolean", + "description": "If set to true it will make the Kubelet fail to start if swap is enabled on the node." + }, + "containerLogMaxSizeMB": { + "type": "integer", + "format": "int32", + "description": "The maximum size (e.g. 10Mi) of container log file before it is rotated." + }, + "containerLogMaxFiles": { + "type": "integer", + "format": "int32", + "description": "The maximum number of container log files that can be present for a container. The number must be ≥ 2.", + "minimum": 2 + }, + "podMaxPids": { + "type": "integer", + "format": "int32", + "description": "The maximum number of processes per pod." + } + } + }, + "LinuxOSConfig": { + "title": "OS configurations of Linux agent nodes.", + "description": "See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details.", + "type": "object", + "properties": { + "sysctls": { + "$ref": "#/definitions/SysctlConfig", + "description": "Sysctl settings for Linux agent nodes." + }, + "transparentHugePageEnabled": { + "type": "string", + "title": "Whether transparent hugepages are enabled.", + "description": "Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)." + }, + "transparentHugePageDefrag": { + "type": "string", + "title": "Whether the kernel should make aggressive use of memory compaction to make more hugepages available.", + "description": "Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)." + }, + "swapFileSizeMB": { + "type": "integer", + "format": "int32", + "description": "The size in MB of a swap file that will be created on each node." + } + } + }, + "SysctlConfig": { + "description": "Sysctl settings for Linux agent nodes.", + "type": "object", + "properties": { + "netCoreSomaxconn": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.somaxconn." + }, + "netCoreNetdevMaxBacklog": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.netdev_max_backlog." + }, + "netCoreRmemDefault": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.rmem_default." + }, + "netCoreRmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.rmem_max." + }, + "netCoreWmemDefault": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.wmem_default." + }, + "netCoreWmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.wmem_max." + }, + "netCoreOptmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.optmem_max." + }, + "netIpv4TcpMaxSynBacklog": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_max_syn_backlog." + }, + "netIpv4TcpMaxTwBuckets": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_max_tw_buckets." + }, + "netIpv4TcpFinTimeout": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_fin_timeout." + }, + "netIpv4TcpKeepaliveTime": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_keepalive_time." + }, + "netIpv4TcpKeepaliveProbes": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_keepalive_probes." + }, + "netIpv4TcpkeepaliveIntvl": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_keepalive_intvl." + }, + "netIpv4TcpTwReuse": { + "type": "boolean", + "description": "Sysctl setting net.ipv4.tcp_tw_reuse." + }, + "netIpv4IpLocalPortRange": { + "type": "string", + "description": "Sysctl setting net.ipv4.ip_local_port_range." + }, + "netIpv4NeighDefaultGcThresh1": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh1." + }, + "netIpv4NeighDefaultGcThresh2": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh2." + }, + "netIpv4NeighDefaultGcThresh3": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh3." + }, + "netNetfilterNfConntrackMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.netfilter.nf_conntrack_max." + }, + "netNetfilterNfConntrackBuckets": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.netfilter.nf_conntrack_buckets." + }, + "fsInotifyMaxUserWatches": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.inotify.max_user_watches." + }, + "fsFileMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.file-max." + }, + "fsAioMaxNr": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.aio-max-nr." + }, + "fsNrOpen": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.nr_open." + }, + "kernelThreadsMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting kernel.threads-max." + }, + "vmMaxMapCount": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.max_map_count." + }, + "vmSwappiness": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.swappiness." + }, + "vmVfsCachePressure": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.vfs_cache_pressure." + } + } + }, + "ManagedClusterHTTPProxyConfig": { + "description": "Cluster HTTP proxy configuration.", + "type": "object", + "properties": { + "httpProxy": { + "type": "string", + "description": "The HTTP proxy server endpoint to use." + }, + "httpsProxy": { + "type": "string", + "description": "The HTTPS proxy server endpoint to use." + }, + "noProxy": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The endpoints that should not go through proxy." + }, + "trustedCa": { + "type": "string", + "description": "Alternative CA cert to use for connecting to proxy servers." + } + } + }, + "GPUInstanceProfile": { + "type": "string", + "enum": [ + "MIG1g", + "MIG2g", + "MIG3g", + "MIG4g", + "MIG7g" + ], + "x-ms-enum": { + "name": "GPUInstanceProfile ", + "modelAsString": true + }, + "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU." + }, + "ExtendedLocationType": { + "type": "string", + "description": "The type of extendedLocation.", + "enum": [ + "EdgeZone" + ], + "x-ms-enum": { + "name": "ExtendedLocationTypes", + "modelAsString": true + } + }, + "ExtendedLocation": { + "description": "The complex type of the extended location.", + "properties": { + "name": { + "type": "string", + "description": "The name of the extended location." + }, + "type": { + "$ref": "#/definitions/ExtendedLocationType", + "description": "The type of the extended location." + } + } + }, + "OSOptionProperty": { + "properties": { + "os-type": { + "type": "string", + "description": "The OS type." + }, + "enable-fips-image": { + "type": "boolean", + "description": "Whether the image is FIPS-enabled." + } + }, + "required": [ + "os-type", + "enable-fips-image" + ], + "description": "OS option property." + }, + "OSOptionPropertyList": { + "properties": { + "osOptionPropertyList": { + "type": "array", + "items": { + "$ref": "#/definitions/OSOptionProperty" + }, + "description": "The list of OS options." + } + }, + "required": [ + "osOptionPropertyList" + ], + "description": "The list of OS option properties." + }, + "OSOptionProfile": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the OS option resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the OS option resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the OS option resource." + }, + "properties": { + "$ref": "#/definitions/OSOptionPropertyList", + "description": "The list of OS options.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The OS option profile." + }, + "EndpointDependency": { + "description": "A domain name that AKS agent nodes are reaching at.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name of the dependency.", + "type": "string" + }, + "endpointDetails": { + "description": "The Ports and Protocols used when connecting to domainName.", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDetail" + } + } + } + }, + "EndpointDetail": { + "description": "connect information from the AKS agent nodes to a single endpoint.", + "type": "object", + "properties": { + "ipAddress": { + "description": "An IP Address that Domain Name currently resolves to.", + "type": "string" + }, + "port": { + "format": "int32", + "description": "The port an endpoint is connected to.", + "type": "integer" + }, + "protocol": { + "description": "The protocol used for connection", + "type": "string" + }, + "description": { + "description": "Description of the detail", + "type": "string" + } + } + }, + "OutboundEnvironmentEndpoint": { + "description": "Egress endpoints which AKS agent nodes connect to for common purpose.", + "type": "object", + "properties": { + "category": { + "description": "The category of endpoints accessed by the AKS agent node, e.g. azure-resource-management, apiserver, etc.", + "type": "string" + }, + "endpoints": { + "description": "The endpoints that AKS agent nodes connect to", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDependency" + } + } + } + }, + "OutboundEnvironmentEndpointCollection": { + "description": "Collection of OutboundEnvironmentEndpoint", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/OutboundEnvironmentEndpoint" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedClusterSecurityProfile": { + "type": "object", + "properties": { + "azureDefender": { + "$ref": "#/definitions/ManagedClusterSecurityProfileAzureDefender", + "description": "Azure Defender settings for the security profile." + } + }, + "description": "Security profile for the container service cluster." + }, + "ManagedClusterSecurityProfileAzureDefender": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Azure Defender" + }, + "logAnalyticsWorkspaceResourceId": { + "type": "string", + "description": "Resource ID of the Log Analytics workspace to be associated with Azure Defender. When Azure Defender is enabled, this field is required and must be a valid workspace resource ID. When Azure Defender is disabled, leave the field empty." + } + }, + "description": "Azure Defender settings for the security profile." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version.", + "x-ms-parameter-location": "client" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ResourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "description": "The name of the managed cluster resource.", + "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region.", + "x-ms-parameter-location": "method" + }, + "ResourceTypeParameter": { + "name": "resource-type", + "in": "query", + "required": false, + "type": "string", + "description": "The resource type for which the OS options needs to be returned", + "x-ms-parameter-location": "method" + }, + "ServerFqdnParameter": { + "name": "server-fqdn", + "in": "query", + "required": false, + "type": "string", + "description": "server fqdn type for credentials to be returned", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/containerservice/resource-manager/readme.go.md b/specification/containerservice/resource-manager/readme.go.md index d545be48b756..1ecd72072b97 100644 --- a/specification/containerservice/resource-manager/readme.go.md +++ b/specification/containerservice/resource-manager/readme.go.md @@ -2,16 +2,26 @@ These settings apply only when `--go` is specified on the command line. -``` yaml $(go) +``` yaml $(go) && !$(track2) go: license-header: MICROSOFT_MIT_NO_VERSION clear-output-folder: true ``` +``` yaml $(go) && $(track2) +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/containerservice/armcontainerservice +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-2021-07 + - tag: package-2021-05 - tag: package-2021-03 - tag: package-2021-02 - tag: package-2020-12 @@ -39,6 +49,24 @@ batch: - tag: package-2017-07 ``` +### Tag: package-2021-07 and go + +These settings apply only when `--package-2021-07 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2021-07' && $(go) +namespace: containerservice +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2021-07-01/$(namespace) +``` +### Tag: package-2021-05 and go + +These settings apply only when `--package-2021-05 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2021-05' && $(go) +namespace: containerservice +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2021-05-01/$(namespace) +``` ### Tag: package-2021-03 and go These settings apply only when `--package-2021-03 --go` is specified on the command line. diff --git a/specification/containerservice/resource-manager/readme.java.md b/specification/containerservice/resource-manager/readme.java.md index 22255152bc3b..8fd0b2b6bafc 100644 --- a/specification/containerservice/resource-manager/readme.java.md +++ b/specification/containerservice/resource-manager/readme.java.md @@ -10,6 +10,11 @@ payload-flattening-threshold: 1 output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-containerservice title: ContainerServiceManagementClient description: "Container Service Client" + +input-file: + - Microsoft.ContainerService/stable/2019-04-30/openShiftManagedClusters.json + - Microsoft.ContainerService/stable/2017-07-01/containerService.json + - Microsoft.ContainerService/stable/2019-08-01/location.json ``` ### Java multi-api @@ -31,6 +36,34 @@ batch: - tag: package-2020-12 - tag: package-2021-02 - tag: package-2021-03 + - tag: package-2021-05 + - tag: package-2021-07 +``` + +### Tag: package-2021-07 and java + +These settings apply only when `--tag=package-2021-07` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2021-07' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerservice.v2021_07_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/containerservice/mgmt-v2021_07_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2021-05 and java + +These settings apply only when `--tag=package-2021-05` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2021-05' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerservice.v2021_05_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/containerservice/mgmt-v2021_05_01 +regenerate-manager: true +generate-interface: true ``` ### Tag: package-2021-03 and java diff --git a/specification/containerservice/resource-manager/readme.md b/specification/containerservice/resource-manager/readme.md index e616703da9e6..8bc3bff594d7 100644 --- a/specification/containerservice/resource-manager/readme.md +++ b/specification/containerservice/resource-manager/readme.md @@ -34,18 +34,37 @@ These are the global settings for the ContainerServices API. ``` yaml openapi-type: arm -tag: package-2021-03 +tag: package-2021-07 ``` +### Tag: package-2021-07 + +These settings apply only when `--tag=package-2021-07` is specified on the command line. + +``` yaml $(tag) == 'package-2021-07' +input-file: + - Microsoft.ContainerService/stable/2021-07-01/managedClusters.json +``` + +### Tag: package-2021-05 + +These settings apply only when `--tag=package-2021-05` is specified on the command line. + +``` yaml $(tag) == 'package-2021-05' +input-file: + - Microsoft.ContainerService/stable/2021-05-01/managedClusters.json +``` + ### Tag: package-2021-03 These settings apply only when `--tag=package-2021-03` is specified on the command line. -```yaml $(tag) == 'package-2021-03' +``` yaml $(tag) == 'package-2021-03' input-file: - Microsoft.ContainerService/stable/2021-03-01/managedClusters.json ``` + ### Tag: package-2021-02 These settings apply only when `--tag=package-2021-02` is specified on the command line. @@ -319,6 +338,32 @@ input-file: ``` +### Tag: package-2021-07-01-only + +These settings apply only when `--tag=package-2021-07-01-only` is specified on the command line. + +``` yaml $(tag) == 'package-2021-07-01-only' +input-file: +- Microsoft.ContainerService/stable/2021-07-01/managedClusters.json +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + where: $.definitions.ManagedClusterProperties.properties.autoScalerProfile + reason: Cluster-autoscaler settings are not camel-cased +``` + +### Tag: package-2021-05-01-only + +These settings apply only when `--tag=package-2021-05-01-only` is specified on the command line. + +``` yaml $(tag) == 'package-2021-05-01-only' +input-file: +- Microsoft.ContainerService/stable/2021-05-01/managedClusters.json +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + where: $.definitions.ManagedClusterProperties.properties.autoScalerProfile + reason: Cluster-autoscaler settings are not camel-cased +``` + ### Tag: package-2021-03-01-only These settings apply only when `--tag=package-2021-03-01-only` is specified on the command line. @@ -637,9 +682,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-python - after_scripts: - - python ./scripts/multiapi_init_gen.py azure-mgmt-containerservice - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go @@ -671,6 +713,10 @@ csharp: See configuration in [readme.go.md](./readme.go.md) +## Python + +See configuration in [readme.python.md](./readme.python.md) + ## Java See configuration in [readme.java.md](./readme.java.md) @@ -686,5 +732,3 @@ directive: from: containerService.json reason: ACS service is deprecated so a PATCH endpoint won't be implemented ``` - - diff --git a/specification/containerservice/resource-manager/readme.python.md b/specification/containerservice/resource-manager/readme.python.md index ddd4bfebd653..91d6d2079b3b 100644 --- a/specification/containerservice/resource-manager/readme.python.md +++ b/specification/containerservice/resource-manager/readme.python.md @@ -2,20 +2,11 @@ These settings apply only when `--python` is specified on the command line. -```yaml $(python) && !$(track2) -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - package-name: azure-mgmt-containerservice - clear-output-folder: true - no-namespace-folders: true -``` - ```yaml $(python) && $(track2) azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-containerservice +package-verion: 1.0.0b1 clear-output-folder: true no-namespace-folders: true ``` @@ -24,36 +15,10 @@ no-namespace-folders: true Generate all API versions currently shipped for this package -```yaml $(python) && $(multiapi) && !$(track2) -batch: - - tag: package-2021-03-01-only - - tag: package-2021-02-01-only - - tag: package-2020-12-01-only - - tag: package-2020-11-01-only - - tag: package-2020-09-01-only - - tag: package-2020-07-01-only - - tag: package-2020-06-01-only - - tag: package-2020-04-01-only - - tag: package-2020-03-01-only - - tag: package-2020-02-01-only - - tag: package-2020-01-01-only - - tag: package-2019-11-01-only - - tag: package-2019-10-27-preview-only - - tag: package-2019-10-01-only - - tag: package-2019-08-01-only - - tag: package-2019-06-01-only - - tag: package-2019-04-30-only - - tag: package-2019-04-01-only - - tag: package-2019-02-only - - tag: package-2018-09-preview-only - - tag: package-2019-09-preview-only - - tag: package-2018-08-preview-only - - tag: package-2018-03-only - - tag: package-2017-07-only-extended -``` - ```yaml $(python) && $(multiapi) && $(track2) batch: + - tag: package-2021-07-01-only + - tag: package-2021-05-01-only - tag: package-2021-03-01-only - tag: package-2021-02-01-only - tag: package-2020-12-01-only @@ -87,15 +52,32 @@ clear-output-folder: false perform-load: false ``` +### Tag: package-2021-07-01-only and python + +These settings apply only when `--tag=package-2021-07-01-only --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2021-07-01-only' && $(python) +namespace: azure.mgmt.containerservice.v2021_07_01 +output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_07_01 +``` + +### Tag: package-2021-05-01-only and python + +These settings apply only when `--tag=package-2021-05-01-only --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2021-05-01-only' && $(python) +namespace: azure.mgmt.containerservice.v2021_05_01 +output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_05_01 +``` + ### Tag: package-2021-03-01-only and python These settings apply only when `--tag=package-2021-03-01-only --python` is specified on the command line. Please also specify `--python-sdks-folder=`. ``` yaml $(tag) == 'package-2021-03-01-only' && $(python) -python: - namespace: azure.mgmt.containerservice.v2021_03_01 - output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_03_01 namespace: azure.mgmt.containerservice.v2021_03_01 output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_03_01 ``` @@ -106,9 +88,6 @@ These settings apply only when `--tag=package-2021-02-01-only --python` is speci Please also specify `--python-sdks-folder=`. ``` yaml $(tag) == 'package-2021-02-01-only' && $(python) -python: - namespace: azure.mgmt.containerservice.v2021_02_01 - output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_02_01 namespace: azure.mgmt.containerservice.v2021_02_01 output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2021_02_01 ``` @@ -119,9 +98,6 @@ These settings apply only when `--tag=package-2020-12-01-only --python` is speci Please also specify `--python-sdks-folder=`. ``` yaml $(tag) == 'package-2020-12-01-only' && $(python) -python: - namespace: azure.mgmt.containerservice.v2020_12_01 - output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2020_12_01 namespace: azure.mgmt.containerservice.v2020_12_01 output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2020_12_01 ``` @@ -132,9 +108,6 @@ These settings apply only when `--tag=package-2020-11-01-only --python` is speci Please also specify `--python-sdks-folder=`. ``` yaml $(tag) == 'package-2020-11-01-only' && $(python) -python: - namespace: azure.mgmt.containerservice.v2020_11_01 - output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2020_11_01 namespace: azure.mgmt.containerservice.v2020_11_01 output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2020_11_01 ``` @@ -145,9 +118,6 @@ These settings apply only when `--tag=package-2020-09-01-only --python` is speci Please also specify `--python-sdks-folder=`. ``` yaml $(tag) == 'package-2020-09-01-only' && $(python) -python: - namespace: azure.mgmt.containerservice.v2020_09_01 - output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2020_09_01 namespace: azure.mgmt.containerservice.v2020_09_01 output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2020_09_01 ``` @@ -158,9 +128,6 @@ These settings apply only when `--tag=package-2020-07-01-only --python` is speci Please also specify `--python-sdks-folder=`. ``` yaml $(tag) == 'package-2020-07-01-only' && $(python) -python: - namespace: azure.mgmt.containerservice.v2020_07_01 - output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2020_07_01 namespace: azure.mgmt.containerservice.v2020_07_01 output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2020_07_01 ``` @@ -173,9 +140,6 @@ Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2021-06' && $(go) +output-folder: $(go-sdk-folder)/services/cosmos-db/mgmt/2021-06-15/$(namespace) +``` + +### Tag: package-2021-05 and go + +These settings apply only when `--tag=package-2021-05 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2021-05' && $(go) +output-folder: $(go-sdk-folder)/services/cosmos-db/mgmt/2021-05-15/$(namespace) +``` + ### Tag: package-2021-04 and go These settings apply only when `--tag=package-2021-04 --go` is specified on the command line. diff --git a/specification/cosmos-db/resource-manager/readme.md b/specification/cosmos-db/resource-manager/readme.md index 2df2aad52bcb..11a44469efb5 100644 --- a/specification/cosmos-db/resource-manager/readme.md +++ b/specification/cosmos-db/resource-manager/readme.md @@ -27,14 +27,30 @@ These are the global settings for the Cosmos-DB API. ``` yaml title: CosmosDBManagementClient openapi-type: arm -tag: package-2021-05 +tag: package-2021-06 +``` + +### Tag: package-2021-06 + +These settings apply only when `--tag=package-2021-06` is specified on the command line. + +```yaml $(tag) == 'package-2021-06' +input-file: + - Microsoft.DocumentDB/stable/2021-06-15/cosmos-db.json + - Microsoft.DocumentDB/stable/2021-06-15/notebook.json + - Microsoft.DocumentDB/stable/2021-06-15/privateEndpointConnection.json + - Microsoft.DocumentDB/stable/2021-06-15/privateLinkResources.json + - Microsoft.DocumentDB/stable/2021-06-15/rbac.json + - Microsoft.DocumentDB/stable/2021-06-15/restorable.json +modelerfour: + lenient-model-deduplication: true ``` ### Tag: package-2021-05 These settings apply only when `--tag=package-2021-05` is specified on the command line. -```yaml $(tag) == 'package-2021-05' +``` yaml $(tag) == 'package-2021-05' input-file: - Microsoft.DocumentDB/stable/2021-05-15/cosmos-db.json - Microsoft.DocumentDB/stable/2021-05-15/notebook.json @@ -49,7 +65,7 @@ modelerfour: These settings apply only when `--tag=package-2021-04` is specified on the command line. -```yaml $(tag) == 'package-2021-04' +``` yaml $(tag) == 'package-2021-04' input-file: - Microsoft.DocumentDB/stable/2021-04-15/cosmos-db.json - Microsoft.DocumentDB/stable/2021-04-15/notebook.json @@ -64,7 +80,7 @@ modelerfour: These settings apply only when `--tag=package-2021-04` is specified on the command line. -```yaml $(tag) == 'package-2021-04-preview' +``` yaml $(tag) == 'package-2021-04-preview' input-file: - Microsoft.DocumentDB/preview/2021-04-01-preview/cosmos-db.json - Microsoft.DocumentDB/preview/2021-04-01-preview/notebook.json @@ -82,7 +98,7 @@ modelerfour: These settings apply only when `--tag=package-2021-03` is specified on the command line. -```yaml $(tag) == 'package-2021-03' +``` yaml $(tag) == 'package-2021-03' input-file: - Microsoft.DocumentDB/stable/2021-03-15/cosmos-db.json - Microsoft.DocumentDB/stable/2021-03-15/notebook.json @@ -110,12 +126,11 @@ modelerfour: tag: package-preview-2021-04 ``` - ### Tag: package-preview-2021-04 These settings apply only when `--tag=package-preview-2021-04` is specified on the command line. -```yaml $(tag) == 'package-preview-2021-04' +``` yaml $(tag) == 'package-preview-2021-04' input-file: - Microsoft.DocumentDB/preview/2021-04-01-preview/cosmos-db.json - Microsoft.DocumentDB/preview/2021-04-01-preview/managedCassandra.json @@ -125,6 +140,7 @@ input-file: - Microsoft.DocumentDB/preview/2021-04-01-preview/rbac.json - Microsoft.DocumentDB/preview/2021-04-01-preview/restorable.json ``` + ### Tag: package-2021-01 These settings apply only when `--tag=package-2021-01` is specified on the command line. @@ -416,8 +432,6 @@ See configuration in [readme.go.md](./readme.go.md) See configuration in [readme.java.md](./readme.java.md) - - ## Multi-API/Profile support for AutoRest v3 generators AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/costmanagement.json index 254541ce9660..9054208220de 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/costmanagement.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/costmanagement.json @@ -925,7 +925,7 @@ }, "filter": { "type": "object", - "description": "Has filter expression to use in the query.", + "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" } } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-09-01/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-09-01/costmanagement.json index 3a52625d8593..ffb411372671 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-09-01/costmanagement.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-09-01/costmanagement.json @@ -947,7 +947,7 @@ }, "filter": { "type": "object", - "description": "Has filter expression to use in the query.", + "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" } } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-10-01/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-10-01/costmanagement.json index 7b8ee24c3400..908df9c4aab4 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-10-01/costmanagement.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-10-01/costmanagement.json @@ -1025,7 +1025,7 @@ }, "filter": { "type": "object", - "description": "Has filter expression to use in the query.", + "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" } } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/costmanagement.exports.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/costmanagement.exports.json index 17692a659dae..e4fed3f863c3 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/costmanagement.exports.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/costmanagement.exports.json @@ -560,7 +560,7 @@ }, "filter": { "type": "object", - "description": "Has filter expression to use in the query.", + "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" } } @@ -588,6 +588,9 @@ "description": "The name of the aggregation function to use.", "type": "string", "enum": [ + "Avg", + "Max", + "Min", "Sum" ], "x-ms-enum": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/costmanagement.json index b27fb39070f9..1f6d3933e194 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/costmanagement.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/costmanagement.json @@ -1575,6 +1575,9 @@ "description": "The name of the aggregation function to use.", "type": "string", "enum": [ + "Avg", + "Max", + "Min", "Sum" ], "x-ms-enum": { @@ -2626,7 +2629,8 @@ }, "required": [ "type", - "timeframe" + "timeframe", + "dataset" ] }, "QueryDefinition": { @@ -2672,7 +2676,8 @@ }, "required": [ "type", - "timeframe" + "timeframe", + "dataset" ] }, "QueryTimePeriod": { @@ -2731,7 +2736,7 @@ }, "filter": { "type": "object", - "description": "Has filter expression to use in the query.", + "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" } } @@ -2806,6 +2811,9 @@ "description": "The name of the aggregation function to use.", "type": "string", "enum": [ + "Avg", + "Max", + "Min", "Sum" ], "x-ms-enum": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/costmanagement.json index 92d41577545c..3f944e7603ef 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/costmanagement.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/costmanagement.json @@ -2159,7 +2159,8 @@ }, "required": [ "type", - "timeframe" + "timeframe", + "dataset" ] }, "ForecastDataset": { @@ -2239,7 +2240,8 @@ }, "required": [ "type", - "timeframe" + "timeframe", + "dataset" ] }, "QueryTimePeriod": { @@ -2298,7 +2300,7 @@ }, "filter": { "type": "object", - "description": "Has filter expression to use in the query.", + "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" } } diff --git a/specification/cost-management/resource-manager/readme.go.md b/specification/cost-management/resource-manager/readme.go.md index 82aa00c6f6f8..4142d9fd465e 100644 --- a/specification/cost-management/resource-manager/readme.go.md +++ b/specification/cost-management/resource-manager/readme.go.md @@ -17,6 +17,7 @@ batch: - tag: package-2019-01 - tag: package-preview-2019-03 - tag: package-2019-10 + - tag: package-2019-11 - tag: package-2020-06 - tag: package-2021-01 ``` diff --git a/specification/cost-management/resource-manager/readme.md b/specification/cost-management/resource-manager/readme.md index 3ee8c75f9c3f..4cbe311bdc14 100644 --- a/specification/cost-management/resource-manager/readme.md +++ b/specification/cost-management/resource-manager/readme.md @@ -228,7 +228,6 @@ This is not used by Autorest itself. swagger-to-sdk: - repo: azure-sdk-for-net - repo: azure-sdk-for-go - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-node - repo: azure-sdk-for-ruby @@ -256,6 +255,10 @@ csharp: See configuration in [readme.go.md](./readme.go.md) +## Python + +See configuration in [readme.python.md](./readme.python.md) + ## Java These settings apply only when `--java` is specified on the command line. diff --git a/specification/cost-management/resource-manager/readme.python.md b/specification/cost-management/resource-manager/readme.python.md index 0a2ccb6be4f0..450889764cbd 100644 --- a/specification/cost-management/resource-manager/readme.python.md +++ b/specification/cost-management/resource-manager/readme.python.md @@ -4,48 +4,26 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.costmanagement - package-name: azure-mgmt-costmanagement - package-version: 1.2.0 - clear-output-folder: true -``` - ``` yaml $(python) && $(track2) -python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.costmanagement package-name: azure-mgmt-costmanagement package-version: 1.0.0b1 clear-output-folder: true -modelerfour: - lenient-model-deduplication: true ``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/costmanagement/azure-mgmt-costmanagement/azure/mgmt/costmanagement -``` ``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/costmanagement/azure-mgmt-costmanagement/azure/mgmt/costmanagement ``` -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/costmanagement/azure-mgmt-costmanagement -``` - ``` yaml $(python) && $(python-mode) == 'create' && $(track2) basic-setup-py: true output-folder: $(python-sdks-folder)/costmanagement/azure-mgmt-costmanagement ``` +``` yaml $(python) && $(track2) +modelerfour: + lenient-model-deduplication: true +``` diff --git a/specification/cost-management/resource-manager/readme.typescript.md b/specification/cost-management/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..191f220e76bf --- /dev/null +++ b/specification/cost-management/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: "@azure/arm-costmanagement" + output-folder: "$(typescript-sdks-folder)/sdk/cost-management/arm-costmanagement" + clear-output-folder: true + generate-metadata: true +``` diff --git a/specification/cpim/resource-manager/readme.python.md b/specification/cpim/resource-manager/readme.python.md index 2bcf09fec915..16ca755ad519 100644 --- a/specification/cpim/resource-manager/readme.python.md +++ b/specification/cpim/resource-manager/readme.python.md @@ -1,19 +1,5 @@ ## Python -These settings apply only when `--python` is specified on the command line. - -```yaml !$(track2) -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - package-name: azure-mgmt-azureadb2c - clear-output-folder: true - no-namespace-folders: true - python-base-folder: azureadb2c/azure-mgmt-azureadb2c/azure/mgmt/azureadb2c - python-base-namespace: azure.mgmt.azureadb2c -``` - These settings apply only when `--track2` is specified on the command line. ```yaml $(track2) @@ -29,12 +15,6 @@ python-base-folder: azureadb2c/azure-mgmt-azureadb2c/azure/mgmt/azureadb2c Generate all API versions currently shipped for this package -```yaml $(multiapi) && !$(track2) -batch: - - tag: package-2020-05-01-preview - - tag: package-2019-01-01-preview -``` - ```yaml $(multiapi) && $(track2) clear-output-folder: true batch: @@ -56,9 +36,6 @@ These settings apply only when `--tag=package-2020-05-01-preview --python` is sp ```yaml $(tag) =='package-2020-05-01-preview' namespace: $(python-base-namespace).v2020_05_01_preview output-folder: $(python-sdks-folder)/$(python-base-folder)/v2020_05_01_preview -python: - namespace: $(python-base-namespace).v2020_05_01_preview - output-folder: $(python-sdks-folder)/$(python-base-folder)/v2020_05_01_preview ``` ### Tag: package-2019-01-01-preview and python @@ -68,7 +45,4 @@ These settings apply only when `--tag=package-2019-01-01-preview --python` is sp ```yaml $(tag) =='package-2019-01-01-preview' namespace: $(python-base-namespace).v2019_01_01_preview output-folder: $(python-sdks-folder)/$(python-base-folder)/v2019_01_01_preview -python: - namespace: $(python-base-namespace).v2019_01_01_preview - output-folder: $(python-sdks-folder)/$(python-base-folder)/v2019_01_01_preview ``` diff --git a/specification/customproviders/resource-manager/readme.md b/specification/customproviders/resource-manager/readme.md index 84b2982cf20a..d79a7ead5125 100644 --- a/specification/customproviders/resource-manager/readme.md +++ b/specification/customproviders/resource-manager/readme.md @@ -51,7 +51,6 @@ This is not used by Autorest itself. swagger-to-sdk: - repo: azure-powershell - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/customproviders/resource-manager/readme.python.md b/specification/customproviders/resource-manager/readme.python.md index ae8f7bd9c9d8..f30be160c48e 100644 --- a/specification/customproviders/resource-manager/readme.python.md +++ b/specification/customproviders/resource-manager/readme.python.md @@ -3,37 +3,15 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. -```yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.customproviders - package-name: azure-mgmt-customproviders - package-version: 2018-09-01-preview - clear-output-folder: true -``` ```yaml $(python) && $(track2) -python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.customproviders package-name: azure-mgmt-customproviders -package-version: 2018-09-01-preview +package-version: 1.0.0b1 clear-output-folder: true ``` -```yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/customproviders/azure-mgmt-customproviders -``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/customproviders/azure-mgmt-customproviders/azure/mgmt/customproviders -``` ```yaml $(python) && $(python-mode) == 'create' && $(track2) basic-setup-py: true diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/databox.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/databox.json new file mode 100644 index 000000000000..4d18086b9234 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/databox.json @@ -0,0 +1,5022 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-05-01", + "title": "DataBoxManagementClient" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.DataBox/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "This method gets all the operations.", + "operationId": "Operations_List", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The supported operations list.", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "OperationsGet": { + "$ref": "./examples/OperationsGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/jobs": { + "get": { + "tags": [ + "Jobs" + ], + "description": "Lists all the jobs available under the subscription.", + "operationId": "Jobs_List", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$skipToken", + "in": "query", + "description": "$skipToken is supported on Get list of jobs, which provides the next page in the list of jobs.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List of jobs available under the subscription.", + "schema": { + "$ref": "#/definitions/JobResourceList" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "JobsList": { + "$ref": "./examples/JobsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/mitigate": { + "post": { + "tags": [ + "Jobs" + ], + "description": "Request to mitigate for a given job", + "operationId": "Mitigate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "mitigateJobRequest", + "in": "body", + "description": "Mitigation Request", + "required": true, + "schema": { + "$ref": "#/definitions/MitigateJobRequest" + } + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-examples": { + "Mitigate": { + "$ref": "./examples/JobMitigate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/locations/{location}/availableSkus": { + "post": { + "tags": [ + "Service" + ], + "description": "This method provides the list of available skus for the given subscription, resource group and location.", + "operationId": "Service_ListAvailableSkusByResourceGroup", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "availableSkuRequest", + "in": "body", + "description": "Filters for showing the available skus.", + "required": true, + "schema": { + "$ref": "#/definitions/AvailableSkuRequest" + } + } + ], + "responses": { + "200": { + "description": "The list of available skus under Resource group.", + "schema": { + "$ref": "#/definitions/AvailableSkusResult" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AvailableSkusPost": { + "$ref": "./examples/AvailableSkusPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/validateAddress": { + "post": { + "tags": [ + "Service" + ], + "description": "[DEPRECATED NOTICE: This operation will soon be removed]. This method validates the customer shipping address and provide alternate addresses if any.", + "operationId": "Service_ValidateAddress", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "validateAddress", + "in": "body", + "description": "Shipping address of the customer.", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateAddress" + } + } + ], + "responses": { + "200": { + "description": "The valid and alternate addresses.", + "schema": { + "$ref": "#/definitions/AddressValidationOutput" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "deprecated": true, + "x-ms-examples": { + "ValidateAddressPost": { + "$ref": "./examples/ValidateAddressPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/locations/{location}/validateInputs": { + "post": { + "tags": [ + "Service" + ], + "description": "This method does all necessary pre-job creation validation under resource group.", + "operationId": "Service_ValidateInputsByResourceGroup", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "validationRequest", + "in": "body", + "description": "Inputs of the customer.", + "required": true, + "schema": { + "$ref": "#/definitions/ValidationRequest" + } + } + ], + "responses": { + "200": { + "description": "The validation status and responses of each validating parameter.", + "schema": { + "$ref": "#/definitions/ValidationResponse" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-examples": { + "ValidateInputsByResourceGroup": { + "$ref": "./examples/ValidateInputsByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/validateInputs": { + "post": { + "tags": [ + "Service" + ], + "description": "This method does all necessary pre-job creation validation under subscription.", + "operationId": "Service_ValidateInputs", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "validationRequest", + "in": "body", + "description": "Inputs of the customer.", + "required": true, + "schema": { + "$ref": "#/definitions/ValidationRequest" + } + } + ], + "responses": { + "200": { + "description": "The validation status and responses of each validating parameter.", + "schema": { + "$ref": "#/definitions/ValidationResponse" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-examples": { + "ValidateInputs": { + "$ref": "./examples/ValidateInputs.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs": { + "get": { + "tags": [ + "Jobs" + ], + "description": "Lists all the jobs available under the given resource group.", + "operationId": "Jobs_ListByResourceGroup", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$skipToken", + "in": "query", + "description": "$skipToken is supported on Get list of jobs, which provides the next page in the list of jobs.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List of jobs by resource group.", + "schema": { + "$ref": "#/definitions/JobResourceList" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "JobsListByResourceGroup": { + "$ref": "./examples/JobsListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}": { + "get": { + "tags": [ + "Jobs" + ], + "description": "Gets information about the specified job.", + "operationId": "Jobs_Get", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$expand", + "in": "query", + "description": "$expand is supported on details parameter for job, which provides details on the job stages.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Job object.", + "schema": { + "$ref": "#/definitions/JobResource" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-examples": { + "JobsGet": { + "$ref": "./examples/JobsGet.json" + }, + "JobsGetCmk": { + "$ref": "./examples/JobsGetCmk.json" + }, + "JobsGetExport": { + "$ref": "./examples/JobsGetExport.json" + }, + "JobsGetCopyStuck": { + "$ref": "./examples/JobsGetCopyStuck.json" + }, + "JobsGetWaitingForAction": { + "$ref": "./examples/JobsGetWaitingForAction.json" + } + } + }, + "put": { + "tags": [ + "Jobs" + ], + "description": "Creates a new job with the specified parameters. Existing job cannot be updated with this API and should instead be updated with the Update job API.", + "operationId": "Jobs_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "jobResource", + "in": "body", + "description": "Job details from request body.", + "required": true, + "schema": { + "$ref": "#/definitions/JobResource" + } + } + ], + "responses": { + "200": { + "description": "Job object.", + "schema": { + "$ref": "#/definitions/JobResource" + } + }, + "202": { + "description": "Accepted request for create Job." + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "JobsCreate": { + "$ref": "./examples/JobsCreate.json" + }, + "JobsCreateDevicePassword": { + "$ref": "./examples/JobsCreateDevicePassword.json" + }, + "JobsCreateExport": { + "$ref": "./examples/JobsCreateExport.json" + }, + "JobsCreateDoubleEncryption": { + "$ref": "./examples/JobsCreateDoubleEncryption.json" + }, + "JobsCreateWithUserAssignedIdentity": { + "$ref": "./examples/JobsCreateWithUserAssignedIdentity.json" + } + } + }, + "delete": { + "tags": [ + "Jobs" + ], + "description": "Deletes a job.", + "operationId": "Jobs_Delete", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Just for swagger we are adding this status code." + }, + "202": { + "description": "Accepted request for delete Job." + }, + "204": { + "description": "Job deleted." + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "JobsDelete": { + "$ref": "./examples/JobsDelete.json" + } + } + }, + "patch": { + "tags": [ + "Jobs" + ], + "description": "Updates the properties of an existing job.", + "operationId": "Jobs_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "If-Match", + "in": "header", + "description": "Defines the If-Match condition. The patch will be performed only if the ETag of the job on the server matches this value.", + "type": "string" + }, + { + "name": "jobResourceUpdateParameter", + "in": "body", + "description": "Job update parameters from request body.", + "required": true, + "schema": { + "$ref": "#/definitions/JobResourceUpdateParameter" + } + } + ], + "responses": { + "200": { + "description": "Job object.", + "schema": { + "$ref": "#/definitions/JobResource" + } + }, + "202": { + "description": "Accepted request for job updated." + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "JobsPatch": { + "$ref": "./examples/JobsPatch.json" + }, + "JobsPatchCmk": { + "$ref": "./examples/JobsPatchCmk.json" + }, + "JobsPatchSystemAssignedToUserAssigned": { + "$ref": "./examples/JobsPatchSystemAssignedToUserAssigned.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/bookShipmentPickUp": { + "post": { + "tags": [ + "Jobs" + ], + "description": "Book shipment pick up.", + "operationId": "Jobs_BookShipmentPickUp", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "shipmentPickUpRequest", + "in": "body", + "description": "Details of shipment pick up request.", + "required": true, + "schema": { + "$ref": "#/definitions/ShipmentPickUpRequest" + } + } + ], + "responses": { + "200": { + "description": "Booked shipment pick up successfully.", + "schema": { + "$ref": "#/definitions/ShipmentPickUpResponse" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-examples": { + "BookShipmentPickupPost": { + "$ref": "./examples/BookShipmentPickupPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/cancel": { + "post": { + "tags": [ + "Jobs" + ], + "description": "CancelJob.", + "operationId": "Jobs_Cancel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "cancellationReason", + "in": "body", + "description": "Reason for cancellation.", + "required": true, + "schema": { + "$ref": "#/definitions/CancellationReason" + } + } + ], + "responses": { + "204": { + "description": "Job cancelled." + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-examples": { + "JobsCancelPost": { + "$ref": "./examples/JobsCancelPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/listCredentials": { + "post": { + "tags": [ + "Jobs" + ], + "description": "This method gets the unencrypted secrets related to the job.", + "operationId": "Jobs_ListCredentials", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of unencrypted credentials of the job.", + "schema": { + "$ref": "#/definitions/UnencryptedCredentialsList" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "JobsListCredentials": { + "$ref": "./examples/JobsListCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/regionConfiguration": { + "post": { + "tags": [ + "Service" + ], + "description": "This API provides configuration details specific to given region/location at Subscription level.", + "operationId": "Service_RegionConfiguration", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "regionConfigurationRequest", + "in": "body", + "description": "Request body to get the configuration for the region.", + "required": true, + "schema": { + "$ref": "#/definitions/RegionConfigurationRequest" + } + } + ], + "responses": { + "200": { + "description": "Region configuration response.", + "schema": { + "$ref": "#/definitions/RegionConfigurationResponse" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-examples": { + "RegionConfiguration": { + "$ref": "./examples/RegionConfiguration.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/locations/{location}/regionConfiguration": { + "post": { + "tags": [ + "Service" + ], + "description": "This API provides configuration details specific to given region/location at Resource group level.", + "operationId": "Service_RegionConfigurationByResourceGroup", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "regionConfigurationRequest", + "in": "body", + "description": "Request body to get the configuration for the region at resource group level.", + "required": true, + "schema": { + "$ref": "#/definitions/RegionConfigurationRequest" + } + } + ], + "responses": { + "200": { + "description": "Region configuration response.", + "schema": { + "$ref": "#/definitions/RegionConfigurationResponse" + } + }, + "default": { + "description": "Error response describing reason for operation failure.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-examples": { + "RegionConfigurationByResourceGroup": { + "$ref": "./examples/RegionConfigurationByResourceGroup.json" + } + } + } + } + }, + "definitions": { + "AccountCredentialDetails": { + "description": "Credential details of the account.", + "type": "object", + "properties": { + "accountName": { + "description": "Name of the account.", + "type": "string", + "readOnly": true + }, + "dataAccountType": { + "description": "Type of the account.", + "enum": [ + "StorageAccount", + "ManagedDisk" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DataAccountType", + "modelAsExtensible": true, + "values": [ + { + "value": "StorageAccount", + "description": "Storage Accounts ." + }, + { + "value": "ManagedDisk", + "description": "Azure Managed disk storage." + } + ] + } + }, + "accountConnectionString": { + "description": "Connection string of the account endpoint to use the account as a storage endpoint on the device.", + "type": "string", + "readOnly": true + }, + "shareCredentialDetails": { + "description": "Per share level unencrypted access credentials.", + "type": "array", + "items": { + "$ref": "#/definitions/ShareCredentialDetails" + }, + "readOnly": true + } + } + }, + "AdditionalErrorInfo": { + "type": "object", + "description": "Additional error info.", + "properties": { + "type": { + "description": "Additional error type.", + "type": "string" + }, + "info": { + "description": "Additional error info.", + "type": "object" + } + } + }, + "AddressValidationOutput": { + "description": "Output of the address validation api.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AddressValidationProperties", + "description": "The address validation properties.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "AddressValidationProperties": { + "description": "The address validation output.", + "required": [ + "validationType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidationInputResponse" + } + ], + "properties": { + "validationStatus": { + "description": "The address validation status.", + "enum": [ + "Valid", + "Invalid", + "Ambiguous" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AddressValidationStatus", + "modelAsExtensible": true, + "values": [ + { + "value": "Valid", + "description": "Address provided is valid." + }, + { + "value": "Invalid", + "description": "Address provided is invalid or not supported." + }, + { + "value": "Ambiguous", + "description": "Address provided is ambiguous, please choose one of the alternate addresses returned." + } + ] + } + }, + "alternateAddresses": { + "description": "List of alternate addresses.", + "type": "array", + "items": { + "$ref": "#/definitions/ShippingAddress" + }, + "readOnly": true + } + }, + "x-ms-discriminator-value": "ValidateAddress" + }, + "ApiError": { + "required": [ + "error" + ], + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorDetail" + } + } + }, + "ApplianceNetworkConfiguration": { + "description": "The Network Adapter configuration of a DataBox.", + "type": "object", + "properties": { + "name": { + "description": "Name of the network.", + "type": "string", + "readOnly": true + }, + "macAddress": { + "description": "Mac Address.", + "type": "string", + "readOnly": true + } + } + }, + "ArmBaseObject": { + "description": "Base class for all objects under resource.", + "type": "object", + "properties": { + "name": { + "description": "Name of the object.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id of the object.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of the object.", + "type": "string", + "readOnly": true + } + } + }, + "AvailableSkuRequest": { + "description": "The filters for showing the available skus.", + "required": [ + "transferType", + "country", + "location" + ], + "type": "object", + "properties": { + "transferType": { + "description": "Type of the transfer.", + "enum": [ + "ImportToAzure", + "ExportFromAzure" + ], + "type": "string", + "x-ms-enum": { + "name": "TransferType", + "modelAsExtensible": true, + "values": [ + { + "value": "ImportToAzure", + "description": "Import data to azure." + }, + { + "value": "ExportFromAzure", + "description": "Export data from azure." + } + ] + } + }, + "country": { + "description": "ISO country code. Country for hardware shipment. For codes check: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements", + "type": "string" + }, + "location": { + "description": "Location for data transfer. For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01", + "type": "string" + }, + "skuNames": { + "description": "Sku Names to filter for available skus", + "type": "array", + "items": { + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsExtensible": true, + "values": [ + { + "value": "DataBox", + "description": "Data Box." + }, + { + "value": "DataBoxDisk", + "description": "Data Box Disk." + }, + { + "value": "DataBoxHeavy", + "description": "Data Box Heavy." + } + ] + } + } + } + } + }, + "AvailableSkusResult": { + "description": "The available skus operation response.", + "type": "object", + "properties": { + "value": { + "description": "List of available skus.", + "type": "array", + "items": { + "$ref": "#/definitions/SkuInformation" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link for the next set of skus.", + "type": "string" + } + } + }, + "AzureFileFilterDetails": { + "description": "Filter details to transfer Azure files", + "type": "object", + "properties": { + "filePrefixList": { + "description": "Prefix list of the Azure files to be transferred.", + "type": "array", + "items": { + "type": "string" + } + }, + "filePathList": { + "description": "List of full path of the files to be transferred.", + "type": "array", + "items": { + "type": "string" + } + }, + "fileShareList": { + "description": "List of file shares to be transferred.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "BlobFilterDetails": { + "description": "Filter details to transfer Azure Blobs", + "type": "object", + "properties": { + "blobPrefixList": { + "description": "Prefix list of the Azure blobs to be transferred.", + "type": "array", + "items": { + "type": "string" + } + }, + "blobPathList": { + "description": "List of full path of the blobs to be transferred.", + "type": "array", + "items": { + "type": "string" + } + }, + "containerList": { + "description": "List of blob containers to be transferred.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "CancellationReason": { + "description": "Reason for cancellation.", + "required": [ + "reason" + ], + "type": "object", + "properties": { + "reason": { + "description": "Reason for cancellation.", + "type": "string" + } + } + }, + "CloudError": { + "description": "Cloud error.", + "type": "object", + "properties": { + "code": { + "description": "Cloud error code.", + "type": "string" + }, + "message": { + "description": "Cloud error message.", + "type": "string" + }, + "target": { + "description": "Cloud error target.", + "type": "string" + }, + "details": { + "description": "Cloud error details.", + "type": "array", + "items": { + "$ref": "#/definitions/CloudError" + }, + "readOnly": true + }, + "additionalInfo": { + "description": "Cloud error additional info.", + "type": "array", + "items": { + "$ref": "#/definitions/AdditionalErrorInfo" + }, + "readOnly": true + } + }, + "x-ms-external": true + }, + "ContactDetails": { + "description": "Contact Details.", + "required": [ + "contactName", + "phone", + "emailList" + ], + "type": "object", + "properties": { + "contactName": { + "description": "Contact name of the person.", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact person.", + "type": "string" + }, + "phoneExtension": { + "description": "Phone extension number of the contact person.", + "type": "string" + }, + "mobile": { + "description": "Mobile number of the contact person.", + "type": "string" + }, + "emailList": { + "description": "List of Email-ids to be notified about job progress.", + "type": "array", + "items": { + "type": "string" + } + }, + "notificationPreference": { + "description": "Notification preference for a job stage.", + "type": "array", + "items": { + "$ref": "#/definitions/NotificationPreference" + } + } + } + }, + "CopyLogDetails": { + "description": "Details for log generated during copy.", + "required": [ + "copyLogDetailsType" + ], + "type": "object", + "properties": { + "copyLogDetailsType": { + "description": "Indicates the type of job details.", + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassDiscriminator", + "modelAsExtensible": false, + "values": [ + { + "value": "DataBox", + "description": "Data Box orders." + }, + { + "value": "DataBoxDisk", + "description": "Data Box Disk orders." + }, + { + "value": "DataBoxHeavy", + "description": "Data Box Heavy orders." + } + ] + } + } + }, + "discriminator": "copyLogDetailsType" + }, + "CopyProgress": { + "description": "Copy progress.", + "type": "object", + "properties": { + "storageAccountName": { + "description": "Name of the storage account. This will be empty for data account types other than storage account.", + "type": "string", + "readOnly": true + }, + "transferType": { + "description": "Transfer type of data", + "enum": [ + "ImportToAzure", + "ExportFromAzure" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "TransferType", + "modelAsExtensible": true, + "values": [ + { + "value": "ImportToAzure", + "description": "Import data to azure." + }, + { + "value": "ExportFromAzure", + "description": "Export data from azure." + } + ] + } + }, + "dataAccountType": { + "description": "Data Account Type.", + "enum": [ + "StorageAccount", + "ManagedDisk" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DataAccountType", + "modelAsExtensible": true, + "values": [ + { + "value": "StorageAccount", + "description": "Storage Accounts ." + }, + { + "value": "ManagedDisk", + "description": "Azure Managed disk storage." + } + ] + } + }, + "accountId": { + "description": "Id of the account where the data needs to be uploaded.", + "type": "string", + "readOnly": true + }, + "bytesProcessed": { + "format": "int64", + "description": "To indicate bytes transferred.", + "type": "integer", + "readOnly": true + }, + "totalBytesToProcess": { + "format": "int64", + "description": "Total amount of data to be processed by the job.", + "type": "integer", + "readOnly": true + }, + "filesProcessed": { + "format": "int64", + "description": "Number of files processed", + "type": "integer", + "readOnly": true + }, + "totalFilesToProcess": { + "format": "int64", + "description": "Total files to process", + "type": "integer", + "readOnly": true + }, + "invalidFilesProcessed": { + "format": "int64", + "description": "Number of files not adhering to azure naming conventions which were processed by automatic renaming", + "type": "integer", + "readOnly": true + }, + "invalidFileBytesUploaded": { + "format": "int64", + "description": "Total amount of data not adhering to azure naming conventions which were processed by automatic renaming", + "type": "integer", + "readOnly": true + }, + "renamedContainerCount": { + "format": "int64", + "description": "Number of folders not adhering to azure naming conventions which were processed by automatic renaming", + "type": "integer", + "readOnly": true + }, + "filesErroredOut": { + "format": "int64", + "description": "Number of files which could not be copied", + "type": "integer", + "readOnly": true + }, + "directoriesErroredOut": { + "format": "int64", + "description": "To indicate directories errored out in the job.", + "type": "integer", + "readOnly": true + }, + "invalidDirectoriesProcessed": { + "format": "int64", + "description": "To indicate directories renamed", + "type": "integer", + "readOnly": true + }, + "isEnumerationInProgress": { + "description": "To indicate if enumeration of data is in progress. \r\nUntil this is true, the TotalBytesToProcess may not be valid.", + "type": "boolean", + "readOnly": true + } + } + }, + "CreateJobValidations": { + "description": "It does all pre-job creation validations.", + "required": [ + "validationCategory", + "individualRequestDetails" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidationRequest" + } + ], + "properties": {}, + "x-ms-discriminator-value": "JobCreationValidation" + }, + "CreateOrderLimitForSubscriptionValidationRequest": { + "description": "Request to validate create order limit for current subscription.", + "required": [ + "deviceType", + "validationType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidationInputRequest" + } + ], + "properties": { + "deviceType": { + "description": "Device type to be used for the job.", + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsExtensible": true, + "values": [ + { + "value": "DataBox", + "description": "Data Box." + }, + { + "value": "DataBoxDisk", + "description": "Data Box Disk." + }, + { + "value": "DataBoxHeavy", + "description": "Data Box Heavy." + } + ] + } + } + }, + "x-ms-discriminator-value": "ValidateCreateOrderLimit" + }, + "CreateOrderLimitForSubscriptionValidationResponseProperties": { + "description": "Properties of create order limit for subscription validation response.", + "required": [ + "validationType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidationInputResponse" + } + ], + "properties": { + "status": { + "description": "Create order limit validation status.", + "enum": [ + "Valid", + "Invalid", + "Skipped" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ValidationStatus", + "modelAsExtensible": true, + "values": [ + { + "value": "Valid", + "description": "Validation is successful" + }, + { + "value": "Invalid", + "description": "Validation is not successful" + }, + { + "value": "Skipped", + "description": "Validation is skipped" + } + ] + } + } + }, + "x-ms-discriminator-value": "ValidateCreateOrderLimit" + }, + "DataAccountDetails": { + "description": "Account details of the data to be transferred", + "required": [ + "dataAccountType" + ], + "type": "object", + "properties": { + "dataAccountType": { + "description": "Account Type of the data to be transferred.", + "enum": [ + "StorageAccount", + "ManagedDisk" + ], + "type": "string", + "x-ms-enum": { + "name": "DataAccountType", + "modelAsExtensible": true, + "values": [ + { + "value": "StorageAccount", + "description": "Storage Accounts ." + }, + { + "value": "ManagedDisk", + "description": "Azure Managed disk storage." + } + ] + }, + "default": "StorageAccount" + }, + "sharePassword": { + "description": "Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\\-$%^!+=;:_()]+", + "type": "string", + "x-ms-secret": true, + "x-ms-mutability": [ + "create" + ] + } + }, + "discriminator": "dataAccountType" + }, + "DataBoxAccountCopyLogDetails": { + "description": "Copy log details for a storage account of a DataBox job", + "required": [ + "copyLogDetailsType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopyLogDetails" + } + ], + "properties": { + "accountName": { + "description": "Account name.", + "type": "string", + "readOnly": true + }, + "copyLogLink": { + "description": "Link for copy logs.", + "type": "string", + "readOnly": true + }, + "copyVerboseLogLink": { + "description": "Link for copy verbose logs. This will be set only when LogCollectionLevel is set to Verbose.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "DataBox" + }, + "DataBoxDiskCopyLogDetails": { + "description": "Copy Log Details for a disk", + "required": [ + "copyLogDetailsType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopyLogDetails" + } + ], + "properties": { + "diskSerialNumber": { + "description": "Disk Serial Number.", + "type": "string", + "readOnly": true + }, + "errorLogLink": { + "description": "Link for copy error logs.", + "type": "string", + "readOnly": true + }, + "verboseLogLink": { + "description": "Link for copy verbose logs.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "DataBoxDisk" + }, + "DataBoxDiskCopyProgress": { + "description": "DataBox Disk Copy Progress", + "type": "object", + "properties": { + "serialNumber": { + "description": "The serial number of the disk", + "type": "string", + "readOnly": true + }, + "bytesCopied": { + "format": "int64", + "description": "Bytes copied during the copy of disk.", + "type": "integer", + "readOnly": true + }, + "percentComplete": { + "format": "int32", + "description": "Indicates the percentage completed for the copy of the disk.", + "type": "integer", + "readOnly": true + }, + "status": { + "description": "The Status of the copy", + "enum": [ + "NotStarted", + "InProgress", + "Completed", + "CompletedWithErrors", + "Failed", + "NotReturned", + "HardwareError", + "DeviceFormatted", + "DeviceMetadataModified", + "StorageAccountNotAccessible", + "UnsupportedData" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "CopyStatus", + "modelAsExtensible": true, + "values": [ + { + "value": "NotStarted", + "description": "Data copy hasn't started yet." + }, + { + "value": "InProgress", + "description": "Data copy is in progress." + }, + { + "value": "Completed", + "description": "Data copy completed." + }, + { + "value": "CompletedWithErrors", + "description": "Data copy completed with errors." + }, + { + "value": "Failed", + "description": "Data copy failed. No data was copied." + }, + { + "value": "NotReturned", + "description": "No copy triggered as device was not returned." + }, + { + "value": "HardwareError", + "description": "The Device has hit hardware issues." + }, + { + "value": "DeviceFormatted", + "description": "Data copy failed. The Device was formatted by user." + }, + { + "value": "DeviceMetadataModified", + "description": "Data copy failed. Device metadata was modified by user." + }, + { + "value": "StorageAccountNotAccessible", + "description": "Data copy failed. Storage Account was not accessible during copy." + }, + { + "value": "UnsupportedData", + "description": "Data copy failed. The Device data content is not supported." + } + ] + } + } + } + }, + "DataBoxDiskJobDetails": { + "description": "DataBox Disk Job Details.", + "required": [ + "contactDetails", + "jobDetailsType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": { + "preferredDisks": { + "description": "User preference on what size disks are needed for the job. The map is from the disk size in TB to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against an int.", + "type": "object", + "additionalProperties": { + "format": "int32", + "type": "integer" + } + }, + "copyProgress": { + "description": "Copy progress per disk.", + "type": "array", + "items": { + "$ref": "#/definitions/DataBoxDiskCopyProgress" + }, + "readOnly": true + }, + "disksAndSizeDetails": { + "description": "Contains the map of disk serial number to the disk size being used for the job. Is returned only after the disks are shipped to the customer.", + "type": "object", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "passkey": { + "description": "User entered passkey for DataBox Disk job.", + "type": "string" + } + }, + "x-ms-discriminator-value": "DataBoxDisk" + }, + "DataBoxDiskJobSecrets": { + "description": "The secrets related to disk job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobSecrets" + } + ], + "properties": { + "diskSecrets": { + "description": "Contains the list of secrets object for that device.", + "type": "array", + "items": { + "$ref": "#/definitions/DiskSecret" + }, + "readOnly": true + }, + "passKey": { + "description": "PassKey for the disk Job.", + "type": "string", + "readOnly": true + }, + "isPasskeyUserDefined": { + "description": "Whether passkey was provided by user.", + "type": "boolean", + "readOnly": true + } + }, + "x-ms-discriminator-value": "DataBoxDisk" + }, + "DataBoxHeavyAccountCopyLogDetails": { + "description": "Copy log details for a storage account for Databox heavy", + "required": [ + "copyLogDetailsType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopyLogDetails" + } + ], + "properties": { + "accountName": { + "description": "Account name.", + "type": "string", + "readOnly": true + }, + "copyLogLink": { + "description": "Link for copy logs.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "copyVerboseLogLink": { + "description": "Link for copy verbose logs. This will be set only when the LogCollectionLevel is set to verbose.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + }, + "x-ms-discriminator-value": "DataBoxHeavy" + }, + "DataBoxHeavyJobDetails": { + "description": "Databox Heavy Device Job Details", + "required": [ + "contactDetails", + "jobDetailsType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": { + "copyProgress": { + "description": "Copy progress per account.", + "type": "array", + "items": { + "$ref": "#/definitions/CopyProgress" + }, + "readOnly": true + }, + "devicePassword": { + "description": "Set Device password for unlocking Databox Heavy. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\\-$%^!+=;:_()]+", + "type": "string" + } + }, + "x-ms-discriminator-value": "DataBoxHeavy" + }, + "DataBoxHeavyJobSecrets": { + "description": "The secrets related to a databox heavy job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobSecrets" + } + ], + "properties": { + "cabinetPodSecrets": { + "description": "Contains the list of secret objects for a databox heavy job.", + "type": "array", + "items": { + "$ref": "#/definitions/DataBoxHeavySecret" + }, + "readOnly": true + } + }, + "x-ms-discriminator-value": "DataBoxHeavy" + }, + "DataBoxHeavySecret": { + "description": "The secrets related to a databox heavy.", + "type": "object", + "properties": { + "deviceSerialNumber": { + "description": "Serial number of the assigned device.", + "type": "string", + "readOnly": true + }, + "devicePassword": { + "description": "Password for out of the box experience on device.", + "type": "string", + "readOnly": true + }, + "networkConfigurations": { + "description": "Network configuration of the appliance.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplianceNetworkConfiguration" + }, + "readOnly": true + }, + "encodedValidationCertPubKey": { + "description": "The base 64 encoded public key to authenticate with the device", + "type": "string", + "readOnly": true + }, + "accountCredentialDetails": { + "description": "Per account level access credentials.", + "type": "array", + "items": { + "$ref": "#/definitions/AccountCredentialDetails" + }, + "readOnly": true + } + } + }, + "DataBoxJobDetails": { + "description": "Databox Job Details", + "required": [ + "contactDetails", + "jobDetailsType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": { + "copyProgress": { + "description": "Copy progress per storage account.", + "type": "array", + "items": { + "$ref": "#/definitions/CopyProgress" + }, + "readOnly": true + }, + "devicePassword": { + "description": "Set Device password for unlocking Databox. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\\-$%^!+=;:_()]+", + "type": "string" + } + }, + "x-ms-discriminator-value": "DataBox" + }, + "DataboxJobSecrets": { + "description": "The secrets related to a databox job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobSecrets" + } + ], + "properties": { + "podSecrets": { + "description": "Contains the list of secret objects for a job.", + "type": "array", + "items": { + "$ref": "#/definitions/DataBoxSecret" + } + } + }, + "x-ms-discriminator-value": "DataBox" + }, + "DataBoxScheduleAvailabilityRequest": { + "description": "Request body to get the availability for scheduling data box orders orders.", + "required": [ + "storageLocation", + "skuName" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScheduleAvailabilityRequest" + } + ], + "properties": {}, + "x-ms-discriminator-value": "DataBox" + }, + "DataBoxSecret": { + "description": "The secrets related to a DataBox.", + "type": "object", + "properties": { + "deviceSerialNumber": { + "description": "Serial number of the assigned device.", + "type": "string", + "readOnly": true + }, + "devicePassword": { + "description": "Password for out of the box experience on device.", + "type": "string", + "readOnly": true + }, + "networkConfigurations": { + "description": "Network configuration of the appliance.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplianceNetworkConfiguration" + }, + "readOnly": true + }, + "encodedValidationCertPubKey": { + "description": "The base 64 encoded public key to authenticate with the device", + "type": "string", + "readOnly": true + }, + "accountCredentialDetails": { + "description": "Per account level access credentials.", + "type": "array", + "items": { + "$ref": "#/definitions/AccountCredentialDetails" + }, + "readOnly": true + } + } + }, + "DataExportDetails": { + "description": "Details of the data to be used for exporting data from azure.", + "required": [ + "transferConfiguration", + "accountDetails" + ], + "type": "object", + "properties": { + "transferConfiguration": { + "$ref": "#/definitions/TransferConfiguration", + "description": "Configuration for the data transfer." + }, + "logCollectionLevel": { + "description": "Level of the logs to be collected.", + "enum": [ + "Error", + "Verbose" + ], + "type": "string", + "x-ms-enum": { + "name": "LogCollectionLevel", + "modelAsExtensible": true, + "values": [ + { + "value": "Error", + "description": "Only Errors will be collected in the logs." + }, + { + "value": "Verbose", + "description": "Verbose logging (includes Errors, CRC, size information and others)." + } + ] + }, + "default": "Error" + }, + "accountDetails": { + "$ref": "#/definitions/DataAccountDetails", + "description": "Account details of the data to be transferred" + } + } + }, + "DataImportDetails": { + "description": "Details of the data to be used for importing data to azure.", + "required": [ + "accountDetails" + ], + "type": "object", + "properties": { + "accountDetails": { + "$ref": "#/definitions/DataAccountDetails", + "description": "Account details of the data to be transferred" + } + } + }, + "DataLocationToServiceLocationMap": { + "description": "Map of data location to service location", + "type": "object", + "properties": { + "dataLocation": { + "description": "Location of the data.", + "type": "string", + "readOnly": true + }, + "serviceLocation": { + "description": "Location of the service.", + "type": "string", + "readOnly": true + } + } + }, + "DataTransferDetailsValidationRequest": { + "description": "Request to validate export and import data details.", + "required": [ + "deviceType", + "transferType", + "validationType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidationInputRequest" + } + ], + "properties": { + "dataExportDetails": { + "description": "List of DataTransfer details to be used to export data from azure.", + "type": "array", + "items": { + "$ref": "#/definitions/DataExportDetails" + } + }, + "dataImportDetails": { + "description": "List of DataTransfer details to be used to import data to azure.", + "type": "array", + "items": { + "$ref": "#/definitions/DataImportDetails" + } + }, + "deviceType": { + "description": "Device type.", + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsExtensible": true, + "values": [ + { + "value": "DataBox", + "description": "Data Box." + }, + { + "value": "DataBoxDisk", + "description": "Data Box Disk." + }, + { + "value": "DataBoxHeavy", + "description": "Data Box Heavy." + } + ] + } + }, + "transferType": { + "description": "Type of the transfer.", + "enum": [ + "ImportToAzure", + "ExportFromAzure" + ], + "type": "string", + "x-ms-enum": { + "name": "TransferType", + "modelAsExtensible": true, + "values": [ + { + "value": "ImportToAzure", + "description": "Import data to azure." + }, + { + "value": "ExportFromAzure", + "description": "Export data from azure." + } + ] + } + } + }, + "x-ms-discriminator-value": "ValidateDataTransferDetails" + }, + "DataTransferDetailsValidationResponseProperties": { + "description": "Properties of data transfer details validation response.", + "required": [ + "validationType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidationInputResponse" + } + ], + "properties": { + "status": { + "description": "Data transfer details validation status.", + "enum": [ + "Valid", + "Invalid", + "Skipped" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ValidationStatus", + "modelAsExtensible": true, + "values": [ + { + "value": "Valid", + "description": "Validation is successful" + }, + { + "value": "Invalid", + "description": "Validation is not successful" + }, + { + "value": "Skipped", + "description": "Validation is skipped" + } + ] + } + } + }, + "x-ms-discriminator-value": "ValidateDataTransferDetails" + }, + "DcAccessSecurityCode": { + "description": "Dc access security code", + "type": "object", + "properties": { + "reverseDCAccessCode": { + "description": "Reverse Dc access security code.", + "type": "string" + }, + "forwardDCAccessCode": { + "description": "Forward Dc access security code.", + "type": "string" + } + } + }, + "Details": { + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "DiskScheduleAvailabilityRequest": { + "description": "Request body to get the availability for scheduling disk orders.", + "required": [ + "storageLocation", + "skuName", + "expectedDataSizeInTeraBytes" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScheduleAvailabilityRequest" + } + ], + "properties": { + "expectedDataSizeInTeraBytes": { + "format": "int32", + "description": "The expected size of the data, which needs to be transferred in this job, in terabytes.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "DataBoxDisk" + }, + "DiskSecret": { + "description": "Contains all the secrets of a Disk.", + "type": "object", + "properties": { + "diskSerialNumber": { + "description": "Serial number of the assigned disk.", + "type": "string", + "readOnly": true + }, + "bitLockerKey": { + "description": "Bit Locker key of the disk which can be used to unlock the disk to copy data.", + "type": "string", + "readOnly": true + } + } + }, + "EncryptionPreferences": { + "description": "Preferences related to the Encryption.", + "type": "object", + "properties": { + "doubleEncryption": { + "description": "Defines secondary layer of software-based encryption enablement.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "DoubleEncryption", + "modelAsExtensible": true, + "values": [ + { + "value": "Enabled", + "description": "Software-based encryption is enabled." + }, + { + "value": "Disabled", + "description": "Software-based encryption is disabled." + } + ] + }, + "default": "Disabled" + } + } + }, + "ErrorDetail": { + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/Details" + } + }, + "target": { + "type": "string" + } + } + }, + "FilterFileDetails": { + "description": "Details of the filter files to be used for data transfer.", + "required": [ + "filterFileType", + "filterFilePath" + ], + "type": "object", + "properties": { + "filterFileType": { + "description": "Type of the filter file.", + "enum": [ + "AzureBlob", + "AzureFile" + ], + "type": "string", + "x-ms-enum": { + "name": "FilterFileType", + "modelAsExtensible": true, + "values": [ + { + "value": "AzureBlob", + "description": "Filter file is of the type AzureBlob." + }, + { + "value": "AzureFile", + "description": "Filter file is of the type AzureFiles." + } + ] + } + }, + "filterFilePath": { + "description": "Path of the file that contains the details of all items to transfer.", + "type": "string" + } + } + }, + "HeavyScheduleAvailabilityRequest": { + "description": "Request body to get the availability for scheduling heavy orders.", + "required": [ + "storageLocation", + "skuName" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScheduleAvailabilityRequest" + } + ], + "properties": {}, + "x-ms-discriminator-value": "DataBoxHeavy" + }, + "IdentityProperties": { + "description": "Managed identity properties.", + "type": "object", + "properties": { + "type": { + "description": "Managed service identity type.", + "type": "string" + }, + "userAssigned": { + "$ref": "#/definitions/UserAssignedProperties", + "description": "User assigned identity properties." + } + } + }, + "JobDeliveryInfo": { + "description": "Additional delivery info.", + "type": "object", + "properties": { + "scheduledDateTime": { + "format": "date-time", + "description": "Scheduled date time.", + "type": "string" + } + } + }, + "JobDetails": { + "description": "Job details.", + "required": [ + "contactDetails", + "jobDetailsType" + ], + "type": "object", + "properties": { + "jobStages": { + "description": "List of stages that run in the job.", + "type": "array", + "items": { + "$ref": "#/definitions/JobStages" + }, + "readOnly": true + }, + "contactDetails": { + "$ref": "#/definitions/ContactDetails", + "description": "Contact details for notification and shipping." + }, + "shippingAddress": { + "$ref": "#/definitions/ShippingAddress", + "description": "Shipping address of the customer." + }, + "deliveryPackage": { + "$ref": "#/definitions/PackageShippingDetails", + "description": "Delivery package shipping details.", + "readOnly": true + }, + "returnPackage": { + "$ref": "#/definitions/PackageShippingDetails", + "description": "Return package shipping details.", + "readOnly": true + }, + "dataImportDetails": { + "description": "Details of the data to be imported into azure.", + "type": "array", + "items": { + "$ref": "#/definitions/DataImportDetails" + } + }, + "dataExportDetails": { + "description": "Details of the data to be exported from azure.", + "type": "array", + "items": { + "$ref": "#/definitions/DataExportDetails" + } + }, + "jobDetailsType": { + "description": "Indicates the type of job details.", + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassDiscriminator", + "modelAsExtensible": false, + "values": [ + { + "value": "DataBox", + "description": "Data Box orders." + }, + { + "value": "DataBoxDisk", + "description": "Data Box Disk orders." + }, + { + "value": "DataBoxHeavy", + "description": "Data Box Heavy orders." + } + ] + } + }, + "preferences": { + "$ref": "#/definitions/Preferences", + "description": "Preferences for the order." + }, + "copyLogDetails": { + "description": "List of copy log details.", + "type": "array", + "items": { + "$ref": "#/definitions/CopyLogDetails" + }, + "readOnly": true + }, + "reverseShipmentLabelSasKey": { + "description": "Shared access key to download the return shipment label", + "type": "string", + "readOnly": true + }, + "chainOfCustodySasKey": { + "description": "Shared access key to download the chain of custody logs", + "type": "string", + "readOnly": true + }, + "keyEncryptionKey": { + "$ref": "#/definitions/KeyEncryptionKey", + "description": "Details about which key encryption type is being used." + }, + "expectedDataSizeInTeraBytes": { + "format": "int32", + "description": "The expected size of the data, which needs to be transferred in this job, in terabytes.", + "type": "integer" + }, + "actions": { + "description": "Available actions on the job.", + "uniqueItems": false, + "type": "array", + "items": { + "enum": [ + "None", + "MoveToCleanUpDevice", + "Resume" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomerResolutionCode", + "modelAsExtensible": true, + "values": [ + { + "value": "None", + "description": "No Resolution Yet" + }, + { + "value": "MoveToCleanUpDevice", + "description": "Clean the device" + }, + { + "value": "Resume", + "description": "Resume the job to same stage" + } + ] + } + }, + "readOnly": true + }, + "lastMitigationActionOnJob": { + "$ref": "#/definitions/LastMitigationActionOnJob", + "description": "Last mitigation action performed on the job.", + "readOnly": true + } + }, + "discriminator": "jobDetailsType" + }, + "JobProperties": { + "description": "Job Properties", + "required": [ + "transferType" + ], + "type": "object", + "properties": { + "transferType": { + "description": "Type of the data transfer.", + "enum": [ + "ImportToAzure", + "ExportFromAzure" + ], + "type": "string", + "x-ms-enum": { + "name": "TransferType", + "modelAsExtensible": true, + "values": [ + { + "value": "ImportToAzure", + "description": "Import data to azure." + }, + { + "value": "ExportFromAzure", + "description": "Export data from azure." + } + ] + } + }, + "isCancellable": { + "description": "Describes whether the job is cancellable or not.", + "type": "boolean", + "readOnly": true + }, + "isDeletable": { + "description": "Describes whether the job is deletable or not.", + "type": "boolean", + "readOnly": true + }, + "isShippingAddressEditable": { + "description": "Describes whether the shipping address is editable or not.", + "type": "boolean", + "readOnly": true + }, + "isPrepareToShipEnabled": { + "description": "Is Prepare To Ship Enabled on this job", + "type": "boolean", + "readOnly": true + }, + "status": { + "description": "Name of the stage which is in progress.", + "enum": [ + "DeviceOrdered", + "DevicePrepared", + "Dispatched", + "Delivered", + "PickedUp", + "AtAzureDC", + "DataCopy", + "Completed", + "CompletedWithErrors", + "Cancelled", + "Failed_IssueReportedAtCustomer", + "Failed_IssueDetectedAtAzureDC", + "Aborted", + "CompletedWithWarnings", + "ReadyToDispatchFromAzureDC", + "ReadyToReceiveAtAzureDC" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "StageName", + "modelAsExtensible": true, + "values": [ + { + "value": "DeviceOrdered", + "description": "An order has been created." + }, + { + "value": "DevicePrepared", + "description": "A device has been prepared for the order." + }, + { + "value": "Dispatched", + "description": "Device has been dispatched to the user of the order." + }, + { + "value": "Delivered", + "description": "Device has been delivered to the user of the order." + }, + { + "value": "PickedUp", + "description": "Device has been picked up from user and in transit to Azure datacenter." + }, + { + "value": "AtAzureDC", + "description": "Device has been received at Azure datacenter from the user." + }, + { + "value": "DataCopy", + "description": "Data copy from the device at Azure datacenter." + }, + { + "value": "Completed", + "description": "Order has completed." + }, + { + "value": "CompletedWithErrors", + "description": "Order has completed with errors." + }, + { + "value": "Cancelled", + "description": "Order has been cancelled." + }, + { + "value": "Failed_IssueReportedAtCustomer", + "description": "Order has failed due to issue reported by user." + }, + { + "value": "Failed_IssueDetectedAtAzureDC", + "description": "Order has failed due to issue detected at Azure datacenter." + }, + { + "value": "Aborted", + "description": "Order has been aborted." + }, + { + "value": "CompletedWithWarnings", + "description": "Order has completed with warnings." + }, + { + "value": "ReadyToDispatchFromAzureDC", + "description": "Device is ready to be handed to customer from Azure DC." + }, + { + "value": "ReadyToReceiveAtAzureDC", + "description": "Device can be dropped off at Azure DC." + } + ] + } + }, + "startTime": { + "format": "date-time", + "description": "Time at which the job was started in UTC ISO 8601 format.", + "type": "string", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/CloudError", + "description": "Top level error for the job.", + "readOnly": true + }, + "details": { + "$ref": "#/definitions/JobDetails", + "description": "Details of a job run. This field will only be sent for expand details filter." + }, + "cancellationReason": { + "description": "Reason for cancellation.", + "type": "string", + "readOnly": true + }, + "deliveryType": { + "description": "Delivery type of Job.", + "enum": [ + "NonScheduled", + "Scheduled" + ], + "type": "string", + "x-ms-enum": { + "name": "JobDeliveryType", + "modelAsExtensible": true, + "values": [ + { + "value": "NonScheduled", + "description": "Non Scheduled job." + }, + { + "value": "Scheduled", + "description": "Scheduled job." + } + ] + }, + "default": "NonScheduled" + }, + "deliveryInfo": { + "$ref": "#/definitions/JobDeliveryInfo", + "description": "Delivery Info of Job." + }, + "isCancellableWithoutFee": { + "description": "Flag to indicate cancellation of scheduled job.", + "type": "boolean", + "readOnly": true + } + } + }, + "JobResource": { + "description": "Job Resource.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "Properties of a job.", + "x-ms-client-flatten": true + }, + "name": { + "description": "Name of the object.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id of the object.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of the object.", + "type": "string", + "readOnly": true + }, + "systemData": { + "$ref": "#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + } + }, + "JobResourceList": { + "description": "Job Resource Collection", + "type": "object", + "properties": { + "value": { + "description": "List of job resources.", + "type": "array", + "items": { + "$ref": "#/definitions/JobResource" + } + }, + "nextLink": { + "description": "Link for the next set of job resources.", + "type": "string" + } + } + }, + "JobResourceUpdateParameter": { + "description": "The JobResourceUpdateParameter.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateJobProperties", + "description": "Properties of a job to be updated.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "identity": { + "$ref": "#/definitions/ResourceIdentity", + "description": "Msi identity of the resource" + } + } + }, + "JobSecrets": { + "description": "The base class for the secrets", + "required": [ + "jobSecretsType" + ], + "type": "object", + "properties": { + "jobSecretsType": { + "description": "Used to indicate what type of job secrets object.", + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassDiscriminator", + "modelAsExtensible": false, + "values": [ + { + "value": "DataBox", + "description": "Data Box orders." + }, + { + "value": "DataBoxDisk", + "description": "Data Box Disk orders." + }, + { + "value": "DataBoxHeavy", + "description": "Data Box Heavy orders." + } + ] + } + }, + "dcAccessSecurityCode": { + "$ref": "#/definitions/DcAccessSecurityCode", + "description": "Dc Access Security Code for Customer Managed Shipping", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/CloudError", + "description": "Error while fetching the secrets.", + "readOnly": true + } + }, + "discriminator": "jobSecretsType" + }, + "JobStages": { + "description": "Job stages.", + "type": "object", + "properties": { + "stageName": { + "description": "Name of the job stage.", + "enum": [ + "DeviceOrdered", + "DevicePrepared", + "Dispatched", + "Delivered", + "PickedUp", + "AtAzureDC", + "DataCopy", + "Completed", + "CompletedWithErrors", + "Cancelled", + "Failed_IssueReportedAtCustomer", + "Failed_IssueDetectedAtAzureDC", + "Aborted", + "CompletedWithWarnings", + "ReadyToDispatchFromAzureDC", + "ReadyToReceiveAtAzureDC" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "StageName", + "modelAsExtensible": true, + "values": [ + { + "value": "DeviceOrdered", + "description": "An order has been created." + }, + { + "value": "DevicePrepared", + "description": "A device has been prepared for the order." + }, + { + "value": "Dispatched", + "description": "Device has been dispatched to the user of the order." + }, + { + "value": "Delivered", + "description": "Device has been delivered to the user of the order." + }, + { + "value": "PickedUp", + "description": "Device has been picked up from user and in transit to Azure datacenter." + }, + { + "value": "AtAzureDC", + "description": "Device has been received at Azure datacenter from the user." + }, + { + "value": "DataCopy", + "description": "Data copy from the device at Azure datacenter." + }, + { + "value": "Completed", + "description": "Order has completed." + }, + { + "value": "CompletedWithErrors", + "description": "Order has completed with errors." + }, + { + "value": "Cancelled", + "description": "Order has been cancelled." + }, + { + "value": "Failed_IssueReportedAtCustomer", + "description": "Order has failed due to issue reported by user." + }, + { + "value": "Failed_IssueDetectedAtAzureDC", + "description": "Order has failed due to issue detected at Azure datacenter." + }, + { + "value": "Aborted", + "description": "Order has been aborted." + }, + { + "value": "CompletedWithWarnings", + "description": "Order has completed with warnings." + }, + { + "value": "ReadyToDispatchFromAzureDC", + "description": "Device is ready to be handed to customer from Azure DC." + }, + { + "value": "ReadyToReceiveAtAzureDC", + "description": "Device can be dropped off at Azure DC." + } + ] + } + }, + "displayName": { + "description": "Display name of the job stage.", + "type": "string", + "readOnly": true + }, + "stageStatus": { + "description": "Status of the job stage.", + "enum": [ + "None", + "InProgress", + "Succeeded", + "Failed", + "Cancelled", + "Cancelling", + "SucceededWithErrors", + "WaitingForCustomerAction", + "SucceededWithWarnings", + "WaitingForCustomerActionForKek", + "WaitingForCustomerActionForCleanUp", + "CustomerActionPerformedForCleanUp" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "StageStatus", + "modelAsExtensible": true, + "values": [ + { + "value": "None", + "description": "No status available yet." + }, + { + "value": "InProgress", + "description": "Stage is in progress." + }, + { + "value": "Succeeded", + "description": "Stage has succeeded." + }, + { + "value": "Failed", + "description": "Stage has failed." + }, + { + "value": "Cancelled", + "description": "Stage has been cancelled." + }, + { + "value": "Cancelling", + "description": "Stage is cancelling." + }, + { + "value": "SucceededWithErrors", + "description": "Stage has succeeded with errors." + }, + { + "value": "WaitingForCustomerAction", + "description": "Stage is stuck until customer takes some action." + }, + { + "value": "SucceededWithWarnings", + "description": "Stage has succeeded with warnings." + }, + { + "value": "WaitingForCustomerActionForKek", + "description": "Stage is waiting for customer action for kek action items." + }, + { + "value": "WaitingForCustomerActionForCleanUp", + "description": "Stage is waiting for customer action for clean up." + }, + { + "value": "CustomerActionPerformedForCleanUp", + "description": "Stage has performed customer action for clean up." + } + ] + } + }, + "stageTime": { + "format": "date-time", + "description": "Time for the job stage in UTC ISO 8601 format.", + "type": "string", + "readOnly": true + }, + "jobStageDetails": { + "description": "Job Stage Details", + "type": "object", + "readOnly": true + } + } + }, + "KeyEncryptionKey": { + "description": "Encryption key containing details about key to encrypt different keys.", + "required": [ + "kekType" + ], + "type": "object", + "properties": { + "kekType": { + "description": "Type of encryption key used for key encryption.", + "enum": [ + "MicrosoftManaged", + "CustomerManaged" + ], + "type": "string", + "x-ms-enum": { + "name": "KekType", + "modelAsExtensible": true, + "values": [ + { + "value": "MicrosoftManaged", + "description": "Key encryption key is managed by Microsoft." + }, + { + "value": "CustomerManaged", + "description": "Key encryption key is managed by the Customer." + } + ] + }, + "default": "MicrosoftManaged" + }, + "identityProperties": { + "$ref": "#/definitions/IdentityProperties", + "description": "Managed identity properties used for key encryption." + }, + "kekUrl": { + "description": "Key encryption key. It is required in case of Customer managed KekType.", + "type": "string" + }, + "kekVaultResourceID": { + "description": "Kek vault resource id. It is required in case of Customer managed KekType.", + "type": "string" + } + } + }, + "ManagedDiskDetails": { + "description": "Details of the managed disks.", + "required": [ + "resourceGroupId", + "stagingStorageAccountId", + "dataAccountType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataAccountDetails" + } + ], + "properties": { + "resourceGroupId": { + "description": "Resource Group Id of the compute disks.", + "type": "string" + }, + "stagingStorageAccountId": { + "description": "Resource Id of the storage account that can be used to copy the vhd for staging.", + "type": "string" + } + }, + "x-ms-discriminator-value": "ManagedDisk" + }, + "LastMitigationActionOnJob": { + "description": "Last Mitigation Action Performed On Job", + "type": "object", + "properties": { + "actionDateTimeInUtc": { + "format": "date-time", + "description": "Action performed date time", + "type": "string" + }, + "isPerformedByCustomer": { + "description": "Action performed by customer,\r\npossibility is that mitigation might happen by customer or service or by ops", + "type": "boolean" + }, + "customerResolution": { + "description": "Resolution code provided by customer", + "enum": [ + "None", + "MoveToCleanUpDevice", + "Resume" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomerResolutionCode", + "modelAsExtensible": true, + "values": [ + { + "value": "None", + "description": "No Resolution Yet" + }, + { + "value": "MoveToCleanUpDevice", + "description": "Clean the device" + }, + { + "value": "Resume", + "description": "Resume the job to same stage" + } + ] + } + } + } + }, + "MitigateJobRequest": { + "description": "The Mitigate Job captured from request body for Mitigate API", + "required": [ + "customerResolutionCode" + ], + "type": "object", + "properties": { + "customerResolutionCode": { + "description": "Resolution code for the job", + "enum": [ + "None", + "MoveToCleanUpDevice", + "Resume" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomerResolutionCode", + "modelAsExtensible": true, + "values": [ + { + "value": "None", + "description": "No Resolution Yet" + }, + { + "value": "MoveToCleanUpDevice", + "description": "Clean the device" + }, + { + "value": "Resume", + "description": "Resume the job to same stage" + } + ] + } + } + } + }, + "NotificationPreference": { + "description": "Notification preference for a job stage.", + "required": [ + "stageName", + "sendNotification" + ], + "type": "object", + "properties": { + "stageName": { + "description": "Name of the stage.", + "enum": [ + "DevicePrepared", + "Dispatched", + "Delivered", + "PickedUp", + "AtAzureDC", + "DataCopy" + ], + "type": "string", + "x-ms-enum": { + "name": "NotificationStageName", + "modelAsExtensible": true, + "values": [ + { + "value": "DevicePrepared", + "description": "Notification at device prepared stage." + }, + { + "value": "Dispatched", + "description": "Notification at device dispatched stage." + }, + { + "value": "Delivered", + "description": "Notification at device delivered stage." + }, + { + "value": "PickedUp", + "description": "Notification at device picked up from user stage." + }, + { + "value": "AtAzureDC", + "description": "Notification at device received at Azure datacenter stage." + }, + { + "value": "DataCopy", + "description": "Notification at data copy started stage." + } + ] + } + }, + "sendNotification": { + "description": "Notification is required or not.", + "type": "boolean", + "default": true + } + } + }, + "Operation": { + "description": "Operation entity.", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation. Format: {resourceProviderNamespace}/{resourceType}/{read|write|delete|action}", + "type": "string", + "readOnly": true + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "Operation display values.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Operation properties.", + "readOnly": true, + "x-ms-client-flatten": true + }, + "origin": { + "description": "Origin of the operation. Can be : user|system|user,system", + "type": "string", + "readOnly": true + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + } + } + }, + "OperationDisplay": { + "description": "Operation display", + "type": "object", + "properties": { + "provider": { + "description": "Provider name.", + "type": "string" + }, + "resource": { + "description": "Resource name.", + "type": "string" + }, + "operation": { + "description": "Localized name of the operation for display purpose.", + "type": "string" + }, + "description": { + "description": "Localized description of the operation for display purpose.", + "type": "string" + } + } + }, + "OperationList": { + "description": "Operation Collection.", + "type": "object", + "properties": { + "value": { + "description": "List of operations.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link for the next set of operations.", + "type": "string" + } + } + }, + "OperationProperties": { + "description": "Operation properties.", + "type": "object", + "properties": {} + }, + "PackageShippingDetails": { + "description": "Shipping details.", + "type": "object", + "properties": { + "carrierName": { + "description": "Name of the carrier.", + "type": "string", + "readOnly": true + }, + "trackingId": { + "description": "Tracking Id of shipment.", + "type": "string", + "readOnly": true + }, + "trackingUrl": { + "description": "Url where shipment can be tracked.", + "type": "string", + "readOnly": true + } + } + }, + "Preferences": { + "description": "Preferences related to the order", + "type": "object", + "properties": { + "preferredDataCenterRegion": { + "description": "Preferred data center region.", + "type": "array", + "items": { + "type": "string" + } + }, + "transportPreferences": { + "$ref": "#/definitions/TransportPreferences", + "description": "Preferences related to the shipment logistics of the sku." + }, + "encryptionPreferences": { + "$ref": "#/definitions/EncryptionPreferences", + "description": "Preferences related to the Encryption." + } + } + }, + "PreferencesValidationRequest": { + "description": "Request to validate preference of transport and data center.", + "required": [ + "deviceType", + "validationType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidationInputRequest" + } + ], + "properties": { + "preference": { + "description": "Preference of transport and data center.", + "$ref": "#/definitions/Preferences" + }, + "deviceType": { + "description": "Device type to be used for the job.", + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsExtensible": true, + "values": [ + { + "value": "DataBox", + "description": "Data Box." + }, + { + "value": "DataBoxDisk", + "description": "Data Box Disk." + }, + { + "value": "DataBoxHeavy", + "description": "Data Box Heavy." + } + ] + } + } + }, + "x-ms-discriminator-value": "ValidatePreferences" + }, + "PreferencesValidationResponseProperties": { + "description": "Properties of data center and transport preference validation response.", + "required": [ + "validationType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidationInputResponse" + } + ], + "properties": { + "status": { + "description": "Validation status of requested data center and transport.", + "enum": [ + "Valid", + "Invalid", + "Skipped" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ValidationStatus", + "modelAsExtensible": true, + "values": [ + { + "value": "Valid", + "description": "Validation is successful" + }, + { + "value": "Invalid", + "description": "Validation is not successful" + }, + { + "value": "Skipped", + "description": "Validation is skipped" + } + ] + } + } + }, + "x-ms-discriminator-value": "ValidatePreferences" + }, + "RegionConfigurationRequest": { + "description": "Request body to get the configuration for the region.", + "type": "object", + "properties": { + "scheduleAvailabilityRequest": { + "$ref": "#/definitions/ScheduleAvailabilityRequest", + "description": "Request body to get the availability for scheduling orders." + }, + "transportAvailabilityRequest": { + "$ref": "#/definitions/TransportAvailabilityRequest", + "description": "Request body to get the transport availability for given sku." + } + } + }, + "RegionConfigurationResponse": { + "description": "Configuration response specific to a region.", + "type": "object", + "properties": { + "scheduleAvailabilityResponse": { + "$ref": "#/definitions/ScheduleAvailabilityResponse", + "description": "Schedule availability for given sku in a region.", + "readOnly": true + }, + "transportAvailabilityResponse": { + "$ref": "#/definitions/TransportAvailabilityResponse", + "description": "Transport options available for given sku in a region.", + "readOnly": true + } + } + }, + "Resource": { + "description": "Model of the Resource.", + "required": [ + "location", + "sku" + ], + "type": "object", + "properties": { + "location": { + "description": "The location of the resource. This will be one of the supported and registered Azure Regions (e.g. West US, East US, Southeast Asia, etc.). The region of a resource cannot be changed once it is created, but if an identical region is specified on update the request will succeed.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "description": "The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku type." + }, + "identity": { + "$ref": "#/definitions/ResourceIdentity", + "description": "Msi identity of the resource" + } + }, + "x-ms-azure-resource": true + }, + "ResourceIdentity": { + "description": "Msi identity details of the resource", + "type": "object", + "properties": { + "type": { + "description": "Identity type", + "type": "string", + "default": "None" + }, + "principalId": { + "description": "Service Principal Id backing the Msi", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "Home Tenant Id", + "type": "string", + "readOnly": true + }, + "userAssignedIdentities": { + "description": "User Assigned Identities", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + } + } + } + }, + "ScheduleAvailabilityRequest": { + "description": "Request body to get the availability for scheduling orders.", + "required": [ + "storageLocation", + "skuName" + ], + "type": "object", + "properties": { + "storageLocation": { + "description": "Location for data transfer. For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01", + "type": "string" + }, + "skuName": { + "description": "Sku Name for which the order is to be scheduled.", + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsExtensible": true, + "values": [ + { + "value": "DataBox", + "description": "Data Box." + }, + { + "value": "DataBoxDisk", + "description": "Data Box Disk." + }, + { + "value": "DataBoxHeavy", + "description": "Data Box Heavy." + } + ] + } + }, + "country": { + "description": "Country in which storage location should be supported.", + "type": "string" + } + }, + "discriminator": "skuName" + }, + "ScheduleAvailabilityResponse": { + "description": "Schedule availability for given sku in a region.", + "type": "object", + "properties": { + "availableDates": { + "description": "List of dates available to schedule", + "type": "array", + "items": { + "format": "date-time", + "type": "string" + }, + "readOnly": true + } + } + }, + "ShareCredentialDetails": { + "description": "Credential details of the shares in account.", + "type": "object", + "properties": { + "shareName": { + "description": "Name of the share.", + "type": "string", + "readOnly": true + }, + "shareType": { + "description": "Type of the share.", + "enum": [ + "UnknownType", + "HCS", + "BlockBlob", + "PageBlob", + "AzureFile", + "ManagedDisk" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ShareDestinationFormatType", + "modelAsExtensible": true, + "values": [ + { + "value": "UnknownType", + "description": "Unknown format." + }, + { + "value": "HCS", + "description": "Storsimple data format." + }, + { + "value": "BlockBlob", + "description": "Azure storage block blob format." + }, + { + "value": "PageBlob", + "description": "Azure storage page blob format." + }, + { + "value": "AzureFile", + "description": "Azure storage file format." + }, + { + "value": "ManagedDisk", + "description": "Azure Compute Disk." + } + ] + } + }, + "userName": { + "description": "User name for the share.", + "type": "string", + "readOnly": true + }, + "password": { + "description": "Password for the share.", + "type": "string", + "readOnly": true + }, + "supportedAccessProtocols": { + "description": "Access protocols supported on the device.", + "type": "array", + "items": { + "enum": [ + "SMB", + "NFS" + ], + "type": "string", + "x-ms-enum": { + "name": "AccessProtocol", + "modelAsExtensible": true, + "values": [ + { + "value": "SMB", + "description": "Server Message Block protocol(SMB)." + }, + { + "value": "NFS", + "description": "Network File System protocol(NFS)." + } + ] + } + }, + "readOnly": true + } + } + }, + "ShipmentPickUpRequest": { + "description": "Shipment pick up request details.", + "required": [ + "startTime", + "endTime", + "shipmentLocation" + ], + "type": "object", + "properties": { + "startTime": { + "format": "date-time", + "description": "Minimum date after which the pick up should commence, this must be in local time of pick up area.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "Maximum date before which the pick up should commence, this must be in local time of pick up area.", + "type": "string" + }, + "shipmentLocation": { + "description": "Shipment Location in the pickup place. Eg.front desk", + "type": "string" + } + } + }, + "ShipmentPickUpResponse": { + "description": "Shipment pick up response.", + "type": "object", + "properties": { + "confirmationNumber": { + "description": "Confirmation number for the pick up request.", + "type": "string", + "readOnly": true + }, + "readyByTime": { + "format": "date-time", + "description": "Time by which shipment should be ready for pick up, this is in local time of pick up area.", + "type": "string", + "readOnly": true + } + } + }, + "ShippingAddress": { + "description": "Shipping address where customer wishes to receive the device.", + "required": [ + "streetAddress1", + "country" + ], + "type": "object", + "properties": { + "streetAddress1": { + "description": "Street Address line 1.", + "type": "string" + }, + "streetAddress2": { + "description": "Street Address line 2.", + "type": "string" + }, + "streetAddress3": { + "description": "Street Address line 3.", + "type": "string" + }, + "city": { + "description": "Name of the City.", + "type": "string" + }, + "stateOrProvince": { + "description": "Name of the State or Province.", + "type": "string" + }, + "country": { + "description": "Name of the Country.", + "type": "string" + }, + "postalCode": { + "description": "Postal code.", + "type": "string" + }, + "zipExtendedCode": { + "description": "Extended Zip Code.", + "type": "string" + }, + "companyName": { + "description": "Name of the company.", + "type": "string" + }, + "addressType": { + "description": "Type of address.", + "enum": [ + "None", + "Residential", + "Commercial" + ], + "type": "string", + "x-ms-enum": { + "name": "AddressType", + "modelAsExtensible": true, + "values": [ + { + "value": "None", + "description": "Address type not known." + }, + { + "value": "Residential", + "description": "Residential Address." + }, + { + "value": "Commercial", + "description": "Commercial Address." + } + ] + }, + "default": "None" + } + } + }, + "Sku": { + "description": "The Sku.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The sku name.", + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsExtensible": true, + "values": [ + { + "value": "DataBox", + "description": "Data Box." + }, + { + "value": "DataBoxDisk", + "description": "Data Box Disk." + }, + { + "value": "DataBoxHeavy", + "description": "Data Box Heavy." + } + ] + } + }, + "displayName": { + "description": "The display name of the sku.", + "type": "string" + }, + "family": { + "description": "The sku family.", + "type": "string" + } + } + }, + "SkuAvailabilityValidationRequest": { + "description": "Request to validate sku availability.", + "required": [ + "deviceType", + "transferType", + "country", + "location", + "validationType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidationInputRequest" + } + ], + "properties": { + "deviceType": { + "description": "Device type to be used for the job.", + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsExtensible": true, + "values": [ + { + "value": "DataBox", + "description": "Data Box." + }, + { + "value": "DataBoxDisk", + "description": "Data Box Disk." + }, + { + "value": "DataBoxHeavy", + "description": "Data Box Heavy." + } + ] + } + }, + "transferType": { + "description": "Type of the transfer.", + "enum": [ + "ImportToAzure", + "ExportFromAzure" + ], + "type": "string", + "x-ms-enum": { + "name": "TransferType", + "modelAsExtensible": true, + "values": [ + { + "value": "ImportToAzure", + "description": "Import data to azure." + }, + { + "value": "ExportFromAzure", + "description": "Export data from azure." + } + ] + } + }, + "country": { + "description": "ISO country code. Country for hardware shipment. For codes check: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements", + "type": "string" + }, + "location": { + "description": "Location for data transfer. For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01", + "type": "string" + } + }, + "x-ms-discriminator-value": "ValidateSkuAvailability" + }, + "SkuAvailabilityValidationResponseProperties": { + "description": "Properties of sku availability validation response.", + "required": [ + "validationType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidationInputResponse" + } + ], + "properties": { + "status": { + "description": "Sku availability validation status.", + "enum": [ + "Valid", + "Invalid", + "Skipped" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ValidationStatus", + "modelAsExtensible": true, + "values": [ + { + "value": "Valid", + "description": "Validation is successful" + }, + { + "value": "Invalid", + "description": "Validation is not successful" + }, + { + "value": "Skipped", + "description": "Validation is skipped" + } + ] + } + } + }, + "x-ms-discriminator-value": "ValidateSkuAvailability" + }, + "SkuCapacity": { + "description": "Capacity of the sku.", + "type": "object", + "properties": { + "usable": { + "description": "Usable capacity in TB.", + "type": "string", + "readOnly": true + }, + "maximum": { + "description": "Maximum capacity in TB.", + "type": "string", + "readOnly": true + } + } + }, + "SkuCost": { + "description": "Describes metadata for retrieving price info.", + "type": "object", + "properties": { + "meterId": { + "description": "Meter id of the Sku.", + "type": "string", + "readOnly": true + }, + "meterType": { + "description": "The type of the meter.", + "type": "string", + "readOnly": true + }, + "multiplier": { + "format": "double", + "description": "Multiplier specifies the region specific value to be multiplied with 1$ guid. Eg: Our new regions will be using 1$ shipping guid with appropriate multiplier specific to region.", + "type": "number", + "readOnly": true + } + } + }, + "SkuInformation": { + "description": "Information of the sku.", + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The Sku.", + "readOnly": true + }, + "enabled": { + "description": "The sku is enabled or not.", + "type": "boolean", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/SkuProperties", + "description": "Properties of the sku.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "SkuProperties": { + "description": "Properties of the sku.", + "type": "object", + "properties": { + "dataLocationToServiceLocationMap": { + "description": "The map of data location to service location.", + "type": "array", + "items": { + "$ref": "#/definitions/DataLocationToServiceLocationMap" + }, + "readOnly": true + }, + "capacity": { + "$ref": "#/definitions/SkuCapacity", + "description": "Capacity of the Sku.", + "readOnly": true + }, + "costs": { + "description": "Cost of the Sku.", + "type": "array", + "items": { + "$ref": "#/definitions/SkuCost" + }, + "readOnly": true + }, + "apiVersions": { + "description": "Api versions that support this Sku.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "disabledReason": { + "description": "Reason why the Sku is disabled.", + "enum": [ + "None", + "Country", + "Region", + "Feature", + "OfferType", + "NoSubscriptionInfo" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SkuDisabledReason", + "modelAsExtensible": true, + "values": [ + { + "value": "None", + "description": "SKU is not disabled." + }, + { + "value": "Country", + "description": "SKU is not available in the requested country." + }, + { + "value": "Region", + "description": "SKU is not available to push data to the requested Azure region." + }, + { + "value": "Feature", + "description": "Required features are not enabled for the SKU." + }, + { + "value": "OfferType", + "description": "Subscription does not have required offer types for the SKU." + }, + { + "value": "NoSubscriptionInfo", + "description": "Subscription has not registered to Microsoft.DataBox and Service does not have the subscription notification." + } + ] + } + }, + "disabledReasonMessage": { + "description": "Message for why the Sku is disabled.", + "type": "string", + "readOnly": true + }, + "requiredFeature": { + "description": "Required feature to access the sku.", + "type": "string", + "readOnly": true + } + } + }, + "StorageAccountDetails": { + "description": "Details for the storage account.", + "required": [ + "storageAccountId", + "dataAccountType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataAccountDetails" + } + ], + "properties": { + "storageAccountId": { + "description": "Storage Account Resource Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "StorageAccount" + }, + "SubscriptionIsAllowedToCreateJobValidationRequest": { + "description": "Request to validate subscription permission to create jobs.", + "required": [ + "validationType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidationInputRequest" + } + ], + "properties": {}, + "x-ms-discriminator-value": "ValidateSubscriptionIsAllowedToCreateJob" + }, + "SubscriptionIsAllowedToCreateJobValidationResponseProperties": { + "description": "Properties of subscription permission to create job validation response.", + "required": [ + "validationType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidationInputResponse" + } + ], + "properties": { + "status": { + "description": "Validation status of subscription permission to create job.", + "enum": [ + "Valid", + "Invalid", + "Skipped" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ValidationStatus", + "modelAsExtensible": true, + "values": [ + { + "value": "Valid", + "description": "Validation is successful" + }, + { + "value": "Invalid", + "description": "Validation is not successful" + }, + { + "value": "Skipped", + "description": "Validation is skipped" + } + ] + } + } + }, + "x-ms-discriminator-value": "ValidateSubscriptionIsAllowedToCreateJob" + }, + "systemData": { + "description": "Provides details about resource creation and update time", + "type": "object", + "properties": { + "createdBy": { + "description": "A string identifier for the identity that created the resource", + "type": "string", + "readOnly": true + }, + "createdByType": { + "description": "The type of identity that created the resource: user, application, managedIdentity", + "type": "string", + "readOnly": true + }, + "createdAt": { + "format": "date-time", + "description": "The timestamp of resource creation (UTC)", + "type": "string", + "readOnly": true + }, + "lastModifiedBy": { + "description": "A string identifier for the identity that last modified the resource", + "type": "string", + "readOnly": true + }, + "lastModifiedByType": { + "description": "The type of identity that last modified the resource: user, application, managedIdentity", + "type": "string", + "readOnly": true + }, + "lastModifiedAt": { + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)", + "type": "string", + "readOnly": true + } + } + }, + "TransferAllDetails": { + "description": "Details to transfer all data.", + "required": [ + "dataAccountType" + ], + "type": "object", + "properties": { + "dataAccountType": { + "description": "Type of the account of data", + "enum": [ + "StorageAccount", + "ManagedDisk" + ], + "type": "string", + "x-ms-enum": { + "name": "DataAccountType", + "modelAsExtensible": true, + "values": [ + { + "value": "StorageAccount", + "description": "Storage Accounts ." + }, + { + "value": "ManagedDisk", + "description": "Azure Managed disk storage." + } + ] + }, + "default": "StorageAccount" + }, + "transferAllBlobs": { + "description": "To indicate if all Azure blobs have to be transferred", + "type": "boolean" + }, + "transferAllFiles": { + "description": "To indicate if all Azure Files have to be transferred", + "type": "boolean" + } + } + }, + "TransferConfiguration": { + "description": "Configuration for defining the transfer of data.", + "required": [ + "transferConfigurationType" + ], + "type": "object", + "properties": { + "transferConfigurationType": { + "description": "Type of the configuration for transfer.", + "enum": [ + "TransferAll", + "TransferUsingFilter" + ], + "type": "string", + "x-ms-enum": { + "name": "TransferConfigurationType", + "modelAsExtensible": true, + "values": [ + { + "value": "TransferAll", + "description": "Transfer all the data." + }, + { + "value": "TransferUsingFilter", + "description": "Transfer using filter." + } + ] + } + }, + "transferFilterDetails": { + "description": "Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter.", + "type": "object", + "properties": { + "include": { + "description": "Details of the filtering the transfer of data.", + "$ref": "#/definitions/TransferFilterDetails" + } + } + }, + "transferAllDetails": { + "description": "Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll", + "type": "object", + "properties": { + "include": { + "description": "Details to transfer all data.", + "$ref": "#/definitions/TransferAllDetails" + } + } + } + } + }, + "TransferFilterDetails": { + "description": "Details of the filtering the transfer of data.", + "required": [ + "dataAccountType" + ], + "type": "object", + "properties": { + "dataAccountType": { + "description": "Type of the account of data.", + "enum": [ + "StorageAccount", + "ManagedDisk" + ], + "type": "string", + "x-ms-enum": { + "name": "DataAccountType", + "modelAsExtensible": true, + "values": [ + { + "value": "StorageAccount", + "description": "Storage Accounts ." + }, + { + "value": "ManagedDisk", + "description": "Azure Managed disk storage." + } + ] + }, + "default": "StorageAccount" + }, + "blobFilterDetails": { + "$ref": "#/definitions/BlobFilterDetails", + "description": "Filter details to transfer blobs." + }, + "azureFileFilterDetails": { + "$ref": "#/definitions/AzureFileFilterDetails", + "description": "Filter details to transfer Azure files." + }, + "filterFileDetails": { + "description": "Details of the filter files to be used for data transfer.", + "type": "array", + "items": { + "$ref": "#/definitions/FilterFileDetails" + } + } + } + }, + "TransportAvailabilityDetails": { + "description": "Transport options availability details for given region.", + "type": "object", + "properties": { + "shipmentType": { + "description": "Transport Shipment Type supported for given region.", + "enum": [ + "CustomerManaged", + "MicrosoftManaged" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "TransportShipmentTypes", + "modelAsExtensible": true, + "values": [ + { + "value": "CustomerManaged", + "description": "Shipment Logistics is handled by the customer." + }, + { + "value": "MicrosoftManaged", + "description": "Shipment Logistics is handled by Microsoft." + } + ] + } + } + } + }, + "TransportAvailabilityRequest": { + "description": "Request body to get the transport availability for given sku.", + "type": "object", + "properties": { + "skuName": { + "description": "Type of the device.", + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsExtensible": true, + "values": [ + { + "value": "DataBox", + "description": "Data Box." + }, + { + "value": "DataBoxDisk", + "description": "Data Box Disk." + }, + { + "value": "DataBoxHeavy", + "description": "Data Box Heavy." + } + ] + } + } + } + }, + "TransportAvailabilityResponse": { + "description": "Transport options available for given sku in a region.", + "type": "object", + "properties": { + "transportAvailabilityDetails": { + "description": "List of transport availability details for given region", + "type": "array", + "items": { + "$ref": "#/definitions/TransportAvailabilityDetails" + }, + "readOnly": true + } + } + }, + "TransportPreferences": { + "description": "Preferences related to the shipment logistics of the sku", + "required": [ + "preferredShipmentType" + ], + "type": "object", + "properties": { + "preferredShipmentType": { + "description": "Indicates Shipment Logistics type that the customer preferred.", + "enum": [ + "CustomerManaged", + "MicrosoftManaged" + ], + "type": "string", + "x-ms-enum": { + "name": "TransportShipmentTypes", + "modelAsExtensible": true, + "values": [ + { + "value": "CustomerManaged", + "description": "Shipment Logistics is handled by the customer." + }, + { + "value": "MicrosoftManaged", + "description": "Shipment Logistics is handled by Microsoft." + } + ] + } + } + } + }, + "UnencryptedCredentials": { + "description": "Unencrypted credentials for accessing device.", + "type": "object", + "properties": { + "jobName": { + "description": "Name of the job.", + "type": "string", + "readOnly": true + }, + "jobSecrets": { + "$ref": "#/definitions/JobSecrets", + "description": "Secrets related to this job.", + "readOnly": true + } + } + }, + "UnencryptedCredentialsList": { + "description": "List of unencrypted credentials for accessing device.", + "type": "object", + "properties": { + "value": { + "description": "List of unencrypted credentials.", + "type": "array", + "items": { + "$ref": "#/definitions/UnencryptedCredentials" + } + }, + "nextLink": { + "description": "Link for the next set of unencrypted credentials.", + "type": "string" + } + } + }, + "UpdateJobDetails": { + "description": "Job details for update.", + "type": "object", + "properties": { + "contactDetails": { + "$ref": "#/definitions/ContactDetails", + "description": "Contact details for notification and shipping." + }, + "shippingAddress": { + "$ref": "#/definitions/ShippingAddress", + "description": "Shipping address of the customer." + }, + "keyEncryptionKey": { + "$ref": "#/definitions/KeyEncryptionKey", + "description": "Key encryption key for the job." + } + } + }, + "UpdateJobProperties": { + "description": "Job Properties for update", + "type": "object", + "properties": { + "details": { + "$ref": "#/definitions/UpdateJobDetails", + "description": "Details of a job to be updated." + } + } + }, + "UserAssignedIdentity": { + "description": "Class defining User assigned identity details.", + "type": "object", + "properties": { + "principalId": { + "description": "The principal id of user assigned identity.", + "type": "string", + "readOnly": true + }, + "clientId": { + "description": "The client id of user assigned identity.", + "type": "string", + "readOnly": true + } + } + }, + "UserAssignedProperties": { + "description": "User assigned identity properties.", + "type": "object", + "properties": { + "resourceId": { + "description": "Arm resource id for user assigned identity to be used to fetch MSI token.", + "type": "string" + } + } + }, + "ValidateAddress": { + "description": "The requirements to validate customer address where the device needs to be shipped.", + "required": [ + "shippingAddress", + "deviceType", + "validationType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidationInputRequest" + } + ], + "properties": { + "shippingAddress": { + "$ref": "#/definitions/ShippingAddress", + "description": "Shipping address of the customer." + }, + "deviceType": { + "description": "Device type to be used for the job.", + "enum": [ + "DataBox", + "DataBoxDisk", + "DataBoxHeavy" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsExtensible": true, + "values": [ + { + "value": "DataBox", + "description": "Data Box." + }, + { + "value": "DataBoxDisk", + "description": "Data Box Disk." + }, + { + "value": "DataBoxHeavy", + "description": "Data Box Heavy." + } + ] + } + }, + "transportPreferences": { + "$ref": "#/definitions/TransportPreferences", + "description": "Preferences related to the shipment logistics of the sku." + } + }, + "x-ms-discriminator-value": "ValidateAddress" + }, + "ValidationInputRequest": { + "description": "Minimum fields that must be present in any type of validation request.", + "required": [ + "validationType" + ], + "type": "object", + "properties": { + "validationType": { + "description": "Identifies the type of validation request.", + "enum": [ + "ValidateAddress", + "ValidateSubscriptionIsAllowedToCreateJob", + "ValidatePreferences", + "ValidateCreateOrderLimit", + "ValidateSkuAvailability", + "ValidateDataTransferDetails" + ], + "type": "string", + "x-ms-enum": { + "name": "ValidationInputDiscriminator", + "modelAsExtensible": true, + "values": [ + { + "value": "ValidateAddress", + "description": "Identify request and response of address validation." + }, + { + "value": "ValidateSubscriptionIsAllowedToCreateJob", + "description": "Identify request and response for validation of subscription permission to create job." + }, + { + "value": "ValidatePreferences", + "description": "Identify request and response of preference validation." + }, + { + "value": "ValidateCreateOrderLimit", + "description": "Identify request and response of create order limit for subscription validation." + }, + { + "value": "ValidateSkuAvailability", + "description": "Identify request and response of active job limit for sku availability." + }, + { + "value": "ValidateDataTransferDetails", + "description": "Identify request and response of data transfer details validation." + } + ] + } + } + }, + "discriminator": "validationType" + }, + "ValidationInputResponse": { + "description": "Minimum properties that should be present in each individual validation response.", + "required": [ + "validationType" + ], + "type": "object", + "properties": { + "validationType": { + "description": "Identifies the type of validation response.", + "enum": [ + "ValidateAddress", + "ValidateSubscriptionIsAllowedToCreateJob", + "ValidatePreferences", + "ValidateCreateOrderLimit", + "ValidateSkuAvailability", + "ValidateDataTransferDetails" + ], + "type": "string", + "x-ms-enum": { + "name": "ValidationInputDiscriminator", + "modelAsExtensible": true, + "values": [ + { + "value": "ValidateAddress", + "description": "Identify request and response of address validation." + }, + { + "value": "ValidateSubscriptionIsAllowedToCreateJob", + "description": "Identify request and response for validation of subscription permission to create job." + }, + { + "value": "ValidatePreferences", + "description": "Identify request and response of preference validation." + }, + { + "value": "ValidateCreateOrderLimit", + "description": "Identify request and response of create order limit for subscription validation." + }, + { + "value": "ValidateSkuAvailability", + "description": "Identify request and response of active job limit for sku availability." + }, + { + "value": "ValidateDataTransferDetails", + "description": "Identify request and response of data transfer details validation." + } + ] + } + }, + "error": { + "$ref": "#/definitions/CloudError", + "description": "Error code and message of validation response.", + "readOnly": true + } + }, + "discriminator": "validationType" + }, + "ValidationRequest": { + "description": "Minimum request requirement of any validation category.", + "required": [ + "validationCategory", + "individualRequestDetails" + ], + "type": "object", + "properties": { + "validationCategory": { + "description": "Identify the nature of validation.", + "enum": [ + "JobCreationValidation" + ], + "type": "string", + "x-ms-enum": { + "name": "ValidationCategory", + "modelAsExtensible": true, + "values": [ + { + "value": "JobCreationValidation", + "description": "Identify request of pre-job creation validations." + } + ] + } + }, + "individualRequestDetails": { + "description": "List of request details contain validationType and its request as key and value respectively.", + "type": "array", + "items": { + "$ref": "#/definitions/ValidationInputRequest" + } + } + }, + "discriminator": "validationCategory" + }, + "ValidationResponse": { + "description": "Response of pre job creation validations.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ValidationResponseProperties", + "description": "Properties of pre job creation validation response.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "ValidationResponseProperties": { + "description": "Properties of pre job creation validation response.", + "type": "object", + "properties": { + "status": { + "description": "Overall validation status.", + "enum": [ + "AllValidToProceed", + "InputsRevisitRequired", + "CertainInputValidationsSkipped" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "OverallValidationStatus", + "modelAsExtensible": true, + "values": [ + { + "value": "AllValidToProceed", + "description": "Every input request is valid." + }, + { + "value": "InputsRevisitRequired", + "description": "Some input requests are not valid." + }, + { + "value": "CertainInputValidationsSkipped", + "description": "Certain input validations skipped." + } + ] + } + }, + "individualResponseDetails": { + "description": "List of response details contain validationType and its response as key and value respectively.", + "type": "array", + "items": { + "$ref": "#/definitions/ValidationInputResponse" + }, + "readOnly": true + } + } + } + }, + "parameters": { + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API Version", + "required": true, + "type": "string" + }, + "jobNameParameter": { + "name": "jobName", + "in": "path", + "description": "The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only", + "required": true, + "type": "string", + "maxLength": 24, + "minLength": 3, + "pattern": "^[-\\w\\.]+$", + "x-ms-parameter-location": "method" + }, + "locationParameter": { + "name": "location", + "in": "path", + "description": "The location of the resource", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The Resource Group Name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The Subscription Id", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/AvailableSkusPost.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/AvailableSkusPost.json new file mode 100644 index 000000000000..b152fbd9b733 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/AvailableSkusPost.json @@ -0,0 +1,280 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "bvttoolrg6", + "location": "westus", + "api-version": "2020-11-01", + "x-ms-client-request-id": [ + "ce815189-a9cc-4288-8166-d78f211bed5a" + ], + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.29017.01", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.18363.", + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "84" + ], + "availableSkuRequest": { + "transferType": "ImportToAzure", + "country": "US", + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "DataBox" + }, + "enabled": true, + "properties": { + "dataLocationToServiceLocationMap": [ + { + "dataLocation": "westus", + "serviceLocation": "westus" + }, + { + "dataLocation": "centralus", + "serviceLocation": "westus" + }, + { + "dataLocation": "eastus", + "serviceLocation": "westus" + }, + { + "dataLocation": "eastus2", + "serviceLocation": "westus" + }, + { + "dataLocation": "northcentralus", + "serviceLocation": "westus" + }, + { + "dataLocation": "southcentralus", + "serviceLocation": "westus" + }, + { + "dataLocation": "westcentralus", + "serviceLocation": "westus" + }, + { + "dataLocation": "westus2", + "serviceLocation": "westus" + }, + { + "dataLocation": "centraluseuap", + "serviceLocation": "centraluseuap" + }, + { + "dataLocation": "eastus2euap", + "serviceLocation": "eastus2euap" + } + ], + "capacity": { + "usable": "80", + "maximum": "100" + }, + "costs": [ + { + "meterId": "0cf23ffc-0b64-49e6-9bdd-1db885349042", + "meterType": "DataBoxServiceFee", + "multiplier": 1 + }, + { + "meterId": "a701f058-119b-4713-a923-bed7da4b7801", + "meterType": "DataBoxShippingFee", + "multiplier": 1 + }, + { + "meterId": "049fa331-0a48-4a81-9991-a6bef3c79fed", + "meterType": "DataBoxExtraDayFee", + "multiplier": 1 + }, + { + "meterId": "c3ea978d-6a0a-4632-b094-4fffcafcb057", + "meterType": "DataBoxLostOrDamagedDeviceFee", + "multiplier": 1 + } + ], + "apiVersions": [ + "2018-01-01" + ], + "disabledReason": "None" + } + }, + { + "sku": { + "name": "DataBoxDisk" + }, + "enabled": true, + "properties": { + "dataLocationToServiceLocationMap": [ + { + "dataLocation": "westus", + "serviceLocation": "westus" + }, + { + "dataLocation": "centralus", + "serviceLocation": "westus" + }, + { + "dataLocation": "eastus", + "serviceLocation": "westus" + }, + { + "dataLocation": "eastus2", + "serviceLocation": "westus" + }, + { + "dataLocation": "northcentralus", + "serviceLocation": "westus" + }, + { + "dataLocation": "southcentralus", + "serviceLocation": "westus" + }, + { + "dataLocation": "westcentralus", + "serviceLocation": "westus" + }, + { + "dataLocation": "westus2", + "serviceLocation": "westus" + }, + { + "dataLocation": "centraluseuap", + "serviceLocation": "centraluseuap" + }, + { + "dataLocation": "eastus2euap", + "serviceLocation": "eastus2euap" + } + ], + "capacity": { + "usable": "35", + "maximum": "40" + }, + "costs": [ + { + "meterId": "d95cd8b5-b6f1-4cd9-ae86-a016d1945d6f", + "meterType": "DataBoxDiskServiceFee", + "multiplier": 1 + }, + { + "meterId": "4b8cf572-cb04-4ef3-9528-2cda4e9b544e", + "meterType": "DataBoxDiskShippingFee", + "multiplier": 1 + }, + { + "meterId": "b6ae9bbf-815d-49dd-bb2b-77c497b72ba4", + "meterType": "DataBoxDiskDailyUsageFee", + "multiplier": 1 + }, + { + "meterId": "08bc0ea1-6c82-421b-b953-2a7a65810d2e", + "meterType": "DataBoxDiskLostDeviceFee", + "multiplier": 1 + } + ], + "apiVersions": [ + "2018-01-01" + ], + "disabledReason": "None" + } + }, + { + "sku": { + "name": "DataBoxHeavy" + }, + "enabled": true, + "properties": { + "dataLocationToServiceLocationMap": [ + { + "dataLocation": "westus", + "serviceLocation": "westus" + }, + { + "dataLocation": "centralus", + "serviceLocation": "westus" + }, + { + "dataLocation": "eastus", + "serviceLocation": "westus" + }, + { + "dataLocation": "eastus2", + "serviceLocation": "westus" + }, + { + "dataLocation": "northcentralus", + "serviceLocation": "westus" + }, + { + "dataLocation": "southcentralus", + "serviceLocation": "westus" + }, + { + "dataLocation": "westcentralus", + "serviceLocation": "westus" + }, + { + "dataLocation": "westus2", + "serviceLocation": "westus" + }, + { + "dataLocation": "centraluseuap", + "serviceLocation": "centraluseuap" + }, + { + "dataLocation": "eastus2euap", + "serviceLocation": "eastus2euap" + } + ], + "capacity": { + "usable": "800", + "maximum": "1000" + }, + "costs": [ + { + "meterId": "d0dccaaf-3de9-4c7a-ba97-f83551b90126", + "meterType": "DataBoxHeavyServiceFee", + "multiplier": 1 + }, + { + "meterId": "7b49d11f-d4f7-4029-a197-04998fd282f9", + "meterType": "DataBoxHeavyShippingFee", + "multiplier": 1 + }, + { + "meterId": "c2c66d53-11b4-4f11-9642-43c7c336f0b7", + "meterType": "DataBoxHeavyExtraDayFee", + "multiplier": 1 + }, + { + "meterId": "188dcd7e-fbd7-4a41-aa42-162b81b0510f", + "meterType": "DataBoxHeavyLostOrDamagedDeviceFee", + "multiplier": 1 + } + ], + "apiVersions": [ + "2018-01-01" + ], + "disabledReason": "None", + "requiredFeature": "HeavyCreateAccess" + } + } + ] + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/BookShipmentPickupPost.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/BookShipmentPickupPost.json new file mode 100644 index 000000000000..bec928ad7c87 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/BookShipmentPickupPost.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "bvttoolrg6", + "jobName": "TJ-636646322037905056", + "api-version": "2019-09-01", + "x-ms-client-request-id": [ + "e1437186-b41d-492e-9b7a-e197c28a517a" + ], + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.27817.01", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.18362.", + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.2.0" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "118" + ], + "shipmentPickUpRequest": { + "startTime": "2019-09-20T18:30:00Z", + "endTime": "2019-09-22T18:30:00Z", + "shipmentLocation": "Front desk" + } + }, + "responses": { + "200": { + "body": { + "confirmationNumber": "2929602E9CP", + "readyByTime": "2019-09-20T18:30:00Z" + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobMitigate.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobMitigate.json new file mode 100644 index 000000000000..eb46de6c1f65 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobMitigate.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "SdkRg9836", + "jobName": "SdkJob8367", + "api-version": "2021-03-01", + "$expand": "details", + "x-ms-client-request-id": [ + "71d282dc-56a0-402b-a322-3b50c89711b5" + ], + "accept-language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.26614.01", + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "60" + ], + "mitigateJobRequest": { + "customerResolutionCode": "MoveToCleanUpDevice" + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsCancelPost.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsCancelPost.json new file mode 100644 index 000000000000..9203b2b65bf0 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsCancelPost.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "SdkRg5154", + "jobName": "SdkJob952", + "api-version": "2020-11-01", + "$expand": "details", + "x-ms-client-request-id": [ + "95fc15f7-4976-46bb-8370-74ed4cb676be" + ], + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.29017.01", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.18363.", + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "30" + ], + "cancellationReason": { + "reason": "CancelTest" + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsCreate.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsCreate.json new file mode 100644 index 000000000000..00263e181498 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsCreate.json @@ -0,0 +1,184 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "SdkRg5154", + "jobName": "SdkJob952", + "api-version": "2020-11-01", + "x-ms-client-request-id": [ + "04f2835f-a2a2-4f25-96df-568460e5be24" + ], + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.29017.01", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.18363.", + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "1064" + ], + "jobResource": { + "properties": { + "transferType": "ImportToAzure", + "details": { + "jobDetailsType": "DataBox", + "contactDetails": { + "contactName": "Public SDK Test", + "phone": "1234567890", + "phoneExtension": "1234", + "emailList": [ + "testing@microsoft.com" + ] + }, + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "Unit 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "Commercial" + }, + "dataImportDetails": [ + { + "accountDetails": { + "dataAccountType": "StorageAccount", + "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount" + } + } + ] + } + }, + "location": "westus", + "sku": { + "name": "DataBox" + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": true, + "isDeletable": false, + "isShippingAddressEditable": true, + "status": "DeviceOrdered", + "startTime": "2019-09-21T14:49:49.0027611+05:30", + "details": { + "copyProgress": [], + "jobStages": [ + { + "stageName": "DeviceOrdered", + "displayName": "Ordered", + "stageStatus": "Succeeded", + "stageTime": "2019-09-21T14:49:52.3995743+05:30" + }, + { + "stageName": "DevicePrepared", + "displayName": "Processed", + "stageStatus": "None" + }, + { + "stageName": "Dispatched", + "displayName": "Dispatched", + "stageStatus": "None" + }, + { + "stageName": "Delivered", + "displayName": "Delivered", + "stageStatus": "None" + }, + { + "stageName": "PickedUp", + "displayName": "Picked up", + "stageStatus": "None" + }, + { + "stageName": "AtAzureDC", + "displayName": "Received", + "stageStatus": "None" + }, + { + "stageName": "DataCopy", + "displayName": "Data copy in progress", + "stageStatus": "None" + }, + { + "stageName": "Completed", + "displayName": "Completed", + "stageStatus": "None" + } + ], + "contactDetails": { + "contactName": "Public SDK Test", + "phone": "1234567890", + "phoneExtension": "1234", + "emailList": [ + "testing@microsoft.com" + ], + "notificationPreference": [ + { + "stageName": "DevicePrepared", + "sendNotification": true + }, + { + "stageName": "Dispatched", + "sendNotification": true + }, + { + "stageName": "Delivered", + "sendNotification": true + }, + { + "stageName": "PickedUp", + "sendNotification": true + }, + { + "stageName": "AtAzureDC", + "sendNotification": true + }, + { + "stageName": "DataCopy", + "sendNotification": true + } + ] + }, + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "Unit 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "Commercial" + }, + "jobDetailsType": "DataBox", + "copyLogDetails": [] + }, + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": true + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "SdkJob952", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg5154/providers/Microsoft.DataBox/jobs/SdkJob952", + "type": "Microsoft.DataBox/jobs" + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsCreateDevicePassword.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsCreateDevicePassword.json new file mode 100644 index 000000000000..93da7704427d --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsCreateDevicePassword.json @@ -0,0 +1,186 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "SdkRg7478", + "jobName": "SdkJob9640", + "api-version": "2020-11-01", + "x-ms-client-request-id": [ + "c4c8f926-ebbe-4c07-ae1a-b716911058df" + ], + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.29017.01", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.18363.", + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "1168" + ], + "jobResource": { + "properties": { + "transferType": "ImportToAzure", + "details": { + "jobDetailsType": "DataBox", + "devicePassword": "", + "contactDetails": { + "contactName": "Public SDK Test", + "phone": "1234567890", + "phoneExtension": "1234", + "emailList": [ + "testing@microsoft.com" + ] + }, + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "Unit 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "Commercial" + }, + "dataImportDetails": [ + { + "accountDetails": { + "dataAccountType": "StorageAccount", + "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/databoxbvt1/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount2", + "sharePassword": "" + } + } + ] + } + }, + "location": "westus", + "sku": { + "name": "DataBox" + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": true, + "isDeletable": false, + "isShippingAddressEditable": true, + "status": "DeviceOrdered", + "startTime": "2019-09-21T14:49:49.0027611+05:30", + "details": { + "copyProgress": [], + "jobStages": [ + { + "stageName": "DeviceOrdered", + "displayName": "Ordered", + "stageStatus": "Succeeded", + "stageTime": "2019-09-21T14:49:52.3995743+05:30" + }, + { + "stageName": "DevicePrepared", + "displayName": "Processed", + "stageStatus": "None" + }, + { + "stageName": "Dispatched", + "displayName": "Dispatched", + "stageStatus": "None" + }, + { + "stageName": "Delivered", + "displayName": "Delivered", + "stageStatus": "None" + }, + { + "stageName": "PickedUp", + "displayName": "Picked up", + "stageStatus": "None" + }, + { + "stageName": "AtAzureDC", + "displayName": "Received", + "stageStatus": "None" + }, + { + "stageName": "DataCopy", + "displayName": "Data copy in progress", + "stageStatus": "None" + }, + { + "stageName": "Completed", + "displayName": "Completed", + "stageStatus": "None" + } + ], + "contactDetails": { + "contactName": "Public SDK Test", + "phone": "1234567890", + "phoneExtension": "1234", + "emailList": [ + "testing@microsoft.com" + ], + "notificationPreference": [ + { + "stageName": "DevicePrepared", + "sendNotification": true + }, + { + "stageName": "Dispatched", + "sendNotification": true + }, + { + "stageName": "Delivered", + "sendNotification": true + }, + { + "stageName": "PickedUp", + "sendNotification": true + }, + { + "stageName": "AtAzureDC", + "sendNotification": true + }, + { + "stageName": "DataCopy", + "sendNotification": true + } + ] + }, + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "Unit 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "Commercial" + }, + "jobDetailsType": "DataBox", + "copyLogDetails": [] + }, + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": true + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "SdkJob9640", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg7478/providers/Microsoft.DataBox/jobs/SdkJob9640", + "type": "Microsoft.DataBox/jobs" + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsCreateDoubleEncryption.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsCreateDoubleEncryption.json new file mode 100644 index 000000000000..3710dbc740bf --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsCreateDoubleEncryption.json @@ -0,0 +1,189 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "SdkRg608", + "jobName": "SdkJob6599", + "api-version": "2020-11-01", + "x-ms-client-request-id": [ + "c9c24c55-fd51-4374-839e-60ee5f0d8832" + ], + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.29220.03", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.19041.", + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.2.0" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "1186" + ], + "jobResource": { + "properties": { + "transferType": "ImportToAzure", + "details": { + "jobDetailsType": "DataBox", + "contactDetails": { + "contactName": "Public SDK Test", + "phone": "1234567890", + "phoneExtension": "1234", + "emailList": [ + "testing@microsoft.com" + ] + }, + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "Unit 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "Commercial" + }, + "dataImportDetails": [ + { + "accountDetails": { + "dataAccountType": "StorageAccount", + "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount" + } + } + ], + "preferences": { + "encryptionPreferences": { + "doubleEncryption": "Enabled" + } + } + } + }, + "location": "westus", + "sku": { + "name": "DataBox" + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "properties": { + "transferType": "ExportFromAzure", + "isCancellable": true, + "isDeletable": false, + "isShippingAddressEditable": true, + "status": "DeviceOrdered", + "startTime": "2019-09-21T14:49:49.0027611+05:30", + "details": { + "copyProgress": [], + "jobStages": [ + { + "stageName": "DeviceOrdered", + "displayName": "Ordered", + "stageStatus": "Succeeded", + "stageTime": "2019-09-21T14:49:52.3995743+05:30" + }, + { + "stageName": "DevicePrepared", + "displayName": "Processed", + "stageStatus": "None" + }, + { + "stageName": "DataCopy", + "displayName": "Data copy in progress", + "stageStatus": "None" + }, + { + "stageName": "Dispatched", + "displayName": "Dispatched", + "stageStatus": "None" + }, + { + "stageName": "Delivered", + "displayName": "Delivered", + "stageStatus": "None" + }, + { + "stageName": "PickedUp", + "displayName": "Picked up", + "stageStatus": "None" + }, + { + "stageName": "AtAzureDC", + "displayName": "Received", + "stageStatus": "None" + }, + { + "stageName": "Completed", + "displayName": "Completed", + "stageStatus": "None" + } + ], + "contactDetails": { + "contactName": "Public SDK Test", + "phone": "1234567890", + "phoneExtension": "1234", + "emailList": [ + "testing@microsoft.com" + ], + "notificationPreference": [ + { + "stageName": "DevicePrepared", + "sendNotification": true + }, + { + "stageName": "DataCopy", + "sendNotification": true + }, + { + "stageName": "Dispatched", + "sendNotification": true + }, + { + "stageName": "Delivered", + "sendNotification": true + }, + { + "stageName": "PickedUp", + "sendNotification": true + }, + { + "stageName": "AtAzureDC", + "sendNotification": true + } + ] + }, + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "Unit 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "Commercial" + }, + "jobDetailsType": "DataBox", + "copyLogDetails": [] + }, + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": true + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "SdkJob6599", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg608/providers/Microsoft.DataBox/jobs/SdkJob6599", + "type": "Microsoft.DataBox/jobs" + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsCreateExport.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsCreateExport.json new file mode 100644 index 000000000000..4356fc39fd85 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsCreateExport.json @@ -0,0 +1,194 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "SdkRg8091", + "jobName": "SdkJob6429", + "api-version": "2020-11-01", + "x-ms-client-request-id": [ + "80eaafc7-e8b7-4c5a-ad81-b1ecb9573cd4" + ], + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.29017.01", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.18363.", + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "1395" + ], + "jobResource": { + "properties": { + "transferType": "ExportFromAzure", + "details": { + "jobDetailsType": "DataBox", + "contactDetails": { + "contactName": "Public SDK Test", + "phone": "1234567890", + "phoneExtension": "1234", + "emailList": [ + "testing@microsoft.com" + ] + }, + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "Unit 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "Commercial" + }, + "dataExportDetails": [ + { + "transferConfiguration": { + "transferConfigurationType": "TransferAll", + "transferAllDetails": { + "include": { + "dataAccountType": "StorageAccount", + "transferAllBlobs": true, + "transferAllFiles": true + } + } + }, + "accountDetails": { + "dataAccountType": "StorageAccount", + "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat/providers/Microsoft.Storage/storageAccounts/aaaaaa2" + } + } + ] + } + }, + "location": "westus", + "sku": { + "name": "DataBox" + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "properties": { + "transferType": "ExportFromAzure", + "isCancellable": true, + "isDeletable": false, + "isShippingAddressEditable": true, + "status": "DeviceOrdered", + "startTime": "2019-09-21T14:49:49.0027611+05:30", + "details": { + "copyProgress": [], + "jobStages": [ + { + "stageName": "DeviceOrdered", + "displayName": "Ordered", + "stageStatus": "Succeeded", + "stageTime": "2019-09-21T14:49:52.3995743+05:30" + }, + { + "stageName": "DevicePrepared", + "displayName": "Processed", + "stageStatus": "None" + }, + { + "stageName": "DataCopy", + "displayName": "Data copy in progress", + "stageStatus": "None" + }, + { + "stageName": "Dispatched", + "displayName": "Dispatched", + "stageStatus": "None" + }, + { + "stageName": "Delivered", + "displayName": "Delivered", + "stageStatus": "None" + }, + { + "stageName": "PickedUp", + "displayName": "Picked up", + "stageStatus": "None" + }, + { + "stageName": "AtAzureDC", + "displayName": "Received", + "stageStatus": "None" + }, + { + "stageName": "Completed", + "displayName": "Completed", + "stageStatus": "None" + } + ], + "contactDetails": { + "contactName": "Public SDK Test", + "phone": "1234567890", + "phoneExtension": "1234", + "emailList": [ + "testing@microsoft.com" + ], + "notificationPreference": [ + { + "stageName": "DevicePrepared", + "sendNotification": true + }, + { + "stageName": "DataCopy", + "sendNotification": true + }, + { + "stageName": "Dispatched", + "sendNotification": true + }, + { + "stageName": "Delivered", + "sendNotification": true + }, + { + "stageName": "PickedUp", + "sendNotification": true + }, + { + "stageName": "AtAzureDC", + "sendNotification": true + } + ] + }, + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "Unit 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "Commercial" + }, + "jobDetailsType": "DataBox", + "copyLogDetails": [] + }, + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": true + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "SdkJob6429", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg8091/providers/Microsoft.DataBox/jobs/SdkJob6429", + "type": "Microsoft.DataBox/jobs" + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsCreateWithUserAssignedIdentity.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsCreateWithUserAssignedIdentity.json new file mode 100644 index 000000000000..ccc4f82aff22 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsCreateWithUserAssignedIdentity.json @@ -0,0 +1,190 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "SdkRg7552", + "jobName": "SdkJob5337", + "api-version": "2020-11-01", + "x-ms-client-request-id": [ + "618b064d-967c-4156-a8dd-a9867cc22af9" + ], + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.29220.03", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.19041.", + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.2.0" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "1318" + ], + "jobResource": { + "properties": { + "transferType": "ImportToAzure", + "details": { + "jobDetailsType": "DataBox", + "contactDetails": { + "contactName": "Public SDK Test", + "phone": "1234567890", + "phoneExtension": "1234", + "emailList": [ + "testing@microsoft.com" + ] + }, + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "Unit 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "Commercial" + }, + "dataImportDetails": [ + { + "accountDetails": { + "dataAccountType": "StorageAccount", + "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/databoxbvt1/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount2" + } + } + ] + } + }, + "location": "westus", + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sdkIdentity": {} + } + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "properties": { + "transferType": "ExportFromAzure", + "isCancellable": true, + "isDeletable": false, + "isShippingAddressEditable": true, + "status": "DeviceOrdered", + "startTime": "2019-09-21T14:49:49.0027611+05:30", + "details": { + "copyProgress": [], + "jobStages": [ + { + "stageName": "DeviceOrdered", + "displayName": "Ordered", + "stageStatus": "Succeeded", + "stageTime": "2019-09-21T14:49:52.3995743+05:30" + }, + { + "stageName": "DevicePrepared", + "displayName": "Processed", + "stageStatus": "None" + }, + { + "stageName": "DataCopy", + "displayName": "Data copy in progress", + "stageStatus": "None" + }, + { + "stageName": "Dispatched", + "displayName": "Dispatched", + "stageStatus": "None" + }, + { + "stageName": "Delivered", + "displayName": "Delivered", + "stageStatus": "None" + }, + { + "stageName": "PickedUp", + "displayName": "Picked up", + "stageStatus": "None" + }, + { + "stageName": "AtAzureDC", + "displayName": "Received", + "stageStatus": "None" + }, + { + "stageName": "Completed", + "displayName": "Completed", + "stageStatus": "None" + } + ], + "contactDetails": { + "contactName": "Public SDK Test", + "phone": "1234567890", + "phoneExtension": "1234", + "emailList": [ + "testing@microsoft.com" + ], + "notificationPreference": [ + { + "stageName": "DevicePrepared", + "sendNotification": true + }, + { + "stageName": "DataCopy", + "sendNotification": true + }, + { + "stageName": "Dispatched", + "sendNotification": true + }, + { + "stageName": "Delivered", + "sendNotification": true + }, + { + "stageName": "PickedUp", + "sendNotification": true + }, + { + "stageName": "AtAzureDC", + "sendNotification": true + } + ] + }, + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "Unit 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "Commercial" + }, + "jobDetailsType": "DataBox", + "copyLogDetails": [] + }, + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": true + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "SdkJob5337", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg7552/providers/Microsoft.DataBox/jobs/SdkJob5337", + "type": "Microsoft.DataBox/jobs" + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsDelete.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsDelete.json new file mode 100644 index 000000000000..c408ddf7352f --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsDelete.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "SdkRg5154", + "jobName": "SdkJob952", + "api-version": "2020-11-01", + "$expand": "details", + "x-ms-client-request-id": [ + "f5c227e2-13d8-4ce9-9ef2-f3c63f6935b9" + ], + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.29017.01", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.18363.", + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" + ] + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsGet.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsGet.json new file mode 100644 index 000000000000..c8dc2863f7df --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsGet.json @@ -0,0 +1,166 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "SdkRg5154", + "jobName": "SdkJob952", + "api-version": "2020-11-01", + "$expand": "details", + "x-ms-client-request-id": [ + "e76214b0-6013-499e-8f91-3a287f421f2e" + ], + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.29017.01", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.18363.", + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": true, + "isDeletable": false, + "isShippingAddressEditable": true, + "isPrepareToShipEnabled": true, + "status": "DeviceOrdered", + "startTime": "2020-08-07T10:50:36.3341513+05:30", + "details": { + "copyProgress": [], + "jobStages": [ + { + "stageName": "DeviceOrdered", + "displayName": "Ordered", + "stageStatus": "Succeeded", + "stageTime": "2020-08-07T10:50:40.1872217+05:30" + }, + { + "stageName": "DevicePrepared", + "displayName": "Processed", + "stageStatus": "None" + }, + { + "stageName": "Dispatched", + "displayName": "Dispatched", + "stageStatus": "None" + }, + { + "stageName": "Delivered", + "displayName": "Delivered", + "stageStatus": "None" + }, + { + "stageName": "PickedUp", + "displayName": "Picked up", + "stageStatus": "None" + }, + { + "stageName": "AtAzureDC", + "displayName": "Received", + "stageStatus": "None" + }, + { + "stageName": "DataCopy", + "displayName": "Data copy in progress", + "stageStatus": "None" + }, + { + "stageName": "Completed", + "displayName": "Completed", + "stageStatus": "None" + } + ], + "contactDetails": { + "contactName": "Public SDK Test", + "phone": "1234567890", + "phoneExtension": "1234", + "emailList": [ + "testing@microsoft.com" + ], + "notificationPreference": [ + { + "stageName": "DevicePrepared", + "sendNotification": true + }, + { + "stageName": "Dispatched", + "sendNotification": true + }, + { + "stageName": "Delivered", + "sendNotification": true + }, + { + "stageName": "PickedUp", + "sendNotification": true + }, + { + "stageName": "AtAzureDC", + "sendNotification": true + }, + { + "stageName": "DataCopy", + "sendNotification": true + } + ] + }, + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "Unit 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "Commercial" + }, + "deliveryPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "returnPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "dataImportDetails": [ + { + "accountDetails": { + "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount", + "dataAccountType": "StorageAccount" + } + } + ], + "jobDetailsType": "DataBox", + "copyLogDetails": [], + "reverseShipmentLabelSasKey": "https://wusbeta.blob.core.windows.net/customer-reverse-shipment-instructions/CustomerShipmentInstructions_MicrosoftManaged.PDF?sv=2018-03-28&sr=b&sig=urwfAELvNV69IGHdcXlRCn6o3O3dWZQKaRipmoAdrI0%3D&st=2020-08-07T05%3A10%3A58Z&se=2020-08-08T05%3A20%3A58Z&sp=r", + "keyEncryptionKey": { + "kekType": "MicrosoftManaged" + } + }, + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": true + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "SdkJob952", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg5154/providers/Microsoft.DataBox/jobs/SdkJob952", + "type": "Microsoft.DataBox/jobs" + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsGetCmk.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsGetCmk.json new file mode 100644 index 000000000000..73882b877d1f --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsGetCmk.json @@ -0,0 +1,170 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "SdkRg7937", + "jobName": "SdkJob1735", + "api-version": "2020-11-01", + "$expand": "details", + "x-ms-client-request-id": [ + "c8cf9d3e-55f1-488f-bcee-53f4939f44e8" + ], + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.29017.01", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.18363.", + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": true, + "isDeletable": false, + "isShippingAddressEditable": true, + "isPrepareToShipEnabled": true, + "status": "DeviceOrdered", + "startTime": "2020-08-07T10:47:42.0009935+05:30", + "details": { + "copyProgress": [], + "jobStages": [ + { + "stageName": "DeviceOrdered", + "displayName": "Ordered", + "stageStatus": "Succeeded", + "stageTime": "2020-08-07T10:47:44.8736499+05:30" + }, + { + "stageName": "DevicePrepared", + "displayName": "Processed", + "stageStatus": "None" + }, + { + "stageName": "Dispatched", + "displayName": "Dispatched", + "stageStatus": "None" + }, + { + "stageName": "Delivered", + "displayName": "Delivered", + "stageStatus": "None" + }, + { + "stageName": "PickedUp", + "displayName": "Picked up", + "stageStatus": "None" + }, + { + "stageName": "AtAzureDC", + "displayName": "Received", + "stageStatus": "None" + }, + { + "stageName": "DataCopy", + "displayName": "Data copy in progress", + "stageStatus": "None" + }, + { + "stageName": "Completed", + "displayName": "Completed", + "stageStatus": "None" + } + ], + "contactDetails": { + "contactName": "Public SDK Test", + "phone": "1234567890", + "phoneExtension": "1234", + "emailList": [ + "testing@microsoft.com" + ], + "notificationPreference": [ + { + "stageName": "DevicePrepared", + "sendNotification": true + }, + { + "stageName": "Dispatched", + "sendNotification": true + }, + { + "stageName": "Delivered", + "sendNotification": true + }, + { + "stageName": "PickedUp", + "sendNotification": true + }, + { + "stageName": "AtAzureDC", + "sendNotification": true + }, + { + "stageName": "DataCopy", + "sendNotification": true + } + ] + }, + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "Unit 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "Commercial" + }, + "deliveryPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "returnPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "dataImportDetails": [ + { + "accountDetails": { + "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/databoxbvt1/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount2", + "dataAccountType": "StorageAccount" + } + } + ], + "jobDetailsType": "DataBox", + "copyLogDetails": [], + "reverseShipmentLabelSasKey": "https://wusbeta.blob.core.windows.net/customer-reverse-shipment-instructions/CustomerShipmentInstructions_MicrosoftManaged.PDF?sv=2018-03-28&sr=b&sig=JSZSeKrFrrwWbZ4zd7PNdGdNYKExKpxa98vRDDH6ZIk%3D&st=2020-08-07T05%3A08%3A51Z&se=2020-08-08T05%3A18%3A51Z&sp=r", + "keyEncryptionKey": { + "kekType": "CustomerManaged", + "kekUrl": "https://sdkkeyvault.vault.azure.net/keys/SSDKEY/", + "kekVaultResourceID": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat/providers/Microsoft.KeyVault/vaults/SDKKeyVault" + } + }, + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": true + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "SystemAssigned", + "principalId": "9a68a7c4-0a18-4d06-a5fb-7058e9e98458", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "name": "SdkJob1735", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg7937/providers/Microsoft.DataBox/jobs/SdkJob1735", + "type": "Microsoft.DataBox/jobs" + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsGetCopyStuck.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsGetCopyStuck.json new file mode 100644 index 000000000000..646c6d4d3a9c --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsGetCopyStuck.json @@ -0,0 +1,202 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "dmstestresource", + "jobName": "TJx-637505258985313014", + "api-version": "2020-03-01", + "$expand": "details", + "x-ms-client-request-id": [ + "bdcc8e76-b662-42a4-93fd-5554809712d7" + ], + "accept-language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.26614.01", + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": false, + "isDeletable": true, + "isShippingAddressEditable": false, + "isPrepareToShipEnabled": true, + "status": "CompletedWithWarnings", + "startTime": "2021-03-05T12:56:12.6384315+05:30", + "details": { + "copyProgress": [ + { + "storageAccountName": "databoxbvttestaccount", + "transferType": "ImportToAzure", + "dataAccountType": "StorageAccount", + "accountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount", + "bytesProcessed": 2000, + "totalBytesToProcess": 2000, + "filesProcessed": 100, + "totalFilesToProcess": 110, + "invalidFilesProcessed": 10, + "invalidFileBytesUploaded": 10, + "renamedContainerCount": 60, + "filesErroredOut": 0, + "directoriesErroredOut": 0, + "invalidDirectoriesProcessed": 0, + "isEnumerationInProgress": false + } + ], + "expectedDataSizeInTeraBytes": 0, + "jobStages": [ + { + "stageName": "DeviceOrdered", + "displayName": "Ordered", + "stageStatus": "Succeeded", + "stageTime": "2021-03-05T12:56:25.3911023+05:30" + }, + { + "stageName": "DevicePrepared", + "displayName": "Processed", + "stageStatus": "Succeeded", + "stageTime": "2021-03-05T13:07:49.676421+05:30" + }, + { + "stageName": "Dispatched", + "displayName": "Dispatched", + "stageStatus": "Succeeded", + "stageTime": "2021-03-05T02:21:06+05:30" + }, + { + "stageName": "Delivered", + "displayName": "Delivered", + "stageStatus": "Succeeded", + "stageTime": "2021-03-05T02:21:13+05:30" + }, + { + "stageName": "PickedUp", + "displayName": "Picked up", + "stageStatus": "Succeeded", + "stageTime": "2021-03-05T02:23:10+05:30" + }, + { + "stageName": "AtAzureDC", + "displayName": "Received", + "stageStatus": "Succeeded", + "stageTime": "2021-03-05T02:23:17+05:30" + }, + { + "stageName": "DataCopy", + "displayName": "Data copy in progress", + "stageStatus": "Succeeded", + "stageTime": "2021-03-05T13:34:20.1497635+05:30" + }, + { + "stageName": "CompletedWithWarnings", + "stageStatus": "Succeeded", + "stageTime": "2021-03-05T14:08:38.250614+05:30" + } + ], + "contactDetails": { + "contactName": "Andrew Tribone", + "phone": "1234567890", + "phoneExtension": "1234", + "emailList": [ + "ssemmail@microsoft.com", + "vishwamdir@microsoft.com" + ], + "notificationPreference": [ + { + "stageName": "DevicePrepared", + "sendNotification": true + }, + { + "stageName": "Dispatched", + "sendNotification": true + }, + { + "stageName": "Delivered", + "sendNotification": true + }, + { + "stageName": "PickedUp", + "sendNotification": true + }, + { + "stageName": "AtAzureDC", + "sendNotification": true + }, + { + "stageName": "DataCopy", + "sendNotification": true + } + ] + }, + "shippingAddress": { + "streetAddress1": "164 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "deliveryPackage": { + "trackingUrl": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=5fb6965e-0b80-4f38-b21a-32673fed2d84", + "carrierName": "Ups", + "trackingId": "5fb6965e-0b80-4f38-b21a-32673fed2d84" + }, + "returnPackage": { + "trackingUrl": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=b3875a34-aad6-4dbe-83a9-3f39cb21b0e8", + "carrierName": "Ups", + "trackingId": "b3875a34-aad6-4dbe-83a9-3f39cb21b0e8" + }, + "dataImportDetails": [ + { + "accountDetails": { + "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount", + "dataAccountType": "StorageAccount" + } + } + ], + "jobDetailsType": "DataBox", + "preferences": {}, + "copyLogDetails": [ + { + "accountName": "databoxbvttestaccount", + "copyLogLink": "databoxcopylog/strtrinidad01_ZTS18520041_CopyLog_8425fb8f9c2b447288caa4dd6f5d34bb.xml", + "copyLogDetailsType": "DataBox" + } + ], + "reverseShipmentLabelSasKey": "http://wusbeta.blob.core.windows.net/devstoreaccount1/f6be6ea8-77da-419b-9f6b-3043c28b04e4/ReverseShipment/b3875a34-aad6-4dbe-83a9-3f39cb21b0e8.PDF?sv=2018-03-28&sr=b&sig=%2BJmOyIkG0ALrKQp%2F7NCOBYccQ80DRLvN%2FHtb6Z97heg%3D&st=2021-03-05T09%3A45%3A05Z&se=2021-03-05T10%3A15%3A05Z&sp=r", + "keyEncryptionKey": { + "kekType": "MicrosoftManaged" + }, + "actions": [], + "lastMitigationActionOnJob": { + "actionDateTimeInUtc": "2021-03-05T08:28:18.8107951Z", + "isPerformedByCustomer": true, + "customerResolution": "MoveToCleanUpDevice" + } + }, + "deliveryType": "NonScheduled", + "isCancellableWithoutFee": false + }, + "location": "westus", + "tags": { + "defaultTagsKey": "defaultTagsValue" + }, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "TJx-637505258985313014", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/dmstestresource/providers/Microsoft.DataBox/jobs/TJx-637505258985313014", + "type": "Microsoft.DataBox/jobs" + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsGetExport.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsGetExport.json new file mode 100644 index 000000000000..f5a346dce6e3 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsGetExport.json @@ -0,0 +1,135 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "SdkRg8091", + "jobName": "SdkJob6429", + "api-version": "2020-11-01", + "$expand": "details", + "x-ms-client-request-id": [ + "b3739c7c-02b6-46c2-a04c-da6f8bca279c" + ], + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.29017.01", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.18363.", + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "transferType": "ExportFromAzure", + "isCancellable": false, + "isDeletable": true, + "isShippingAddressEditable": false, + "isPrepareToShipEnabled": true, + "status": "Cancelled", + "startTime": "2020-08-07T10:49:08.7195419+05:30", + "details": { + "copyProgress": [ + { + "storageAccountName": "aaaaaa2", + "transferType": "ExportFromAzure", + "dataAccountType": "StorageAccount", + "accountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat/providers/Microsoft.Storage/storageAccounts/aaaaaa2", + "bytesProcessed": 0, + "totalBytesToProcess": 0, + "isEnumerationInProgress": false + } + ], + "jobStages": [ + { + "stageName": "DeviceOrdered", + "displayName": "Ordered", + "stageStatus": "Succeeded", + "stageTime": "2020-08-07T10:49:12.7675644+05:30" + }, + { + "stageName": "Cancelled", + "displayName": "Canceled", + "stageStatus": "Succeeded", + "stageTime": "2020-08-07T10:49:57.2572438+05:30" + } + ], + "contactDetails": { + "contactName": " ", + "emailList": [], + "phone": "1234567890", + "phoneExtension": "1234", + "notificationPreference": [] + }, + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "Unit 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "Commercial" + }, + "deliveryPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "returnPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "dataImportDetails": [], + "dataExportDetails": [ + { + "transferConfiguration": { + "transferConfigurationType": "TransferAll", + "transferFilterDetails": {}, + "transferAllDetails": { + "include": { + "dataAccountType": "StorageAccount", + "transferAllBlobs": true, + "transferAllFiles": true + } + } + }, + "logCollectionLevel": "Error", + "accountDetails": { + "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat/providers/Microsoft.Storage/storageAccounts/aaaaaa2", + "dataAccountType": "StorageAccount" + } + } + ], + "jobDetailsType": "DataBox", + "copyLogDetails": [], + "reverseShipmentLabelSasKey": "https://wusbeta.blob.core.windows.net/customer-reverse-shipment-instructions/CustomerShipmentInstructions_MicrosoftManaged.PDF?sv=2018-03-28&sr=b&sig=04aL%2FTe7998qQJlhmGI3C0Q%2FxsCVo1t0B4uQUIx7TmQ%3D&st=2020-08-07T05%3A10%3A05Z&se=2020-08-08T05%3A20%3A05Z&sp=r", + "chainOfCustodySasKey": "https://wusbeta.blob.core.windows.net/chainofcustody/9a6ee052-bcff-4b5e-a478-7dcbfb86e9fb.txt?sv=2018-03-28&sr=b&sig=JbBBXZKharvfg35ZfmrhowO1DuOpzcZCNUdeFzklvWs%3D&st=2020-08-07T05%3A10%3A05Z&se=2020-08-07T05%3A40%3A05Z&sp=r", + "keyEncryptionKey": { + "kekType": "MicrosoftManaged" + } + }, + "cancellationReason": "CancelTest", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": false + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "SdkJob6429", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg8091/providers/Microsoft.DataBox/jobs/SdkJob6429", + "type": "Microsoft.DataBox/jobs" + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsGetWaitingForAction.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsGetWaitingForAction.json new file mode 100644 index 000000000000..3cbfdcbdacfd --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsGetWaitingForAction.json @@ -0,0 +1,251 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "dmstestresource", + "jobName": "TJx-637505258985313014", + "api-version": "2021-05-01", + "$expand": "details", + "x-ms-client-request-id": [ + "bdcc8e76-b662-42a4-93fd-5554809712d7" + ], + "accept-language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.26614.01", + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": false, + "isDeletable": false, + "isShippingAddressEditable": false, + "isPrepareToShipEnabled": true, + "status": "DataCopy", + "startTime": "2021-03-14T23:49:49.5177298+00:00", + "error": { + "code": "SsemUserCopyErrorWaitingForAction", + "message": "Job has an error in copy stage and is waiting for customer action. Please review the error and select one of the actions provided in the job's properties.details.actions", + "target": "CopyIntervention", + "details": [], + "additionalInfo": [] + }, + "details": { + "copyProgress": [ + { + "storageAccountName": "databoxbvttestaccount", + "transferType": "ImportToAzure", + "dataAccountType": "StorageAccount", + "accountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount", + "bytesProcessed": 2000, + "totalBytesToProcess": 2000, + "filesProcessed": 100, + "totalFilesToProcess": 110, + "invalidFilesProcessed": 10, + "invalidFileBytesUploaded": 10, + "renamedContainerCount": 60, + "filesErroredOut": 0, + "directoriesErroredOut": 0, + "invalidDirectoriesProcessed": 0, + "isEnumerationInProgress": false + }, + { + "transferType": "ImportToAzure", + "dataAccountType": "ManagedDisk", + "accountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat3198inh0-9)inh(il(h)_fyoin)(upf(yLASD0-FJ(hal-DSNWP0JDS0P3-0SJ94", + "bytesProcessed": 2000, + "totalBytesToProcess": 2000, + "filesProcessed": 100, + "totalFilesToProcess": 110, + "invalidFilesProcessed": 10, + "invalidFileBytesUploaded": 10, + "renamedContainerCount": 60, + "filesErroredOut": 0, + "directoriesErroredOut": 0, + "invalidDirectoriesProcessed": 0, + "isEnumerationInProgress": false + } + ], + "expectedDataSizeInTeraBytes": 0, + "jobStages": [ + { + "stageName": "DeviceOrdered", + "displayName": "Ordered", + "stageStatus": "Succeeded", + "stageTime": "2021-03-14T23:49:53.81509+00:00" + }, + { + "stageName": "DevicePrepared", + "displayName": "Processed", + "stageStatus": "Succeeded", + "stageTime": "2021-03-15T00:05:18.7350971+00:00" + }, + { + "stageName": "Dispatched", + "displayName": "Dispatched", + "stageStatus": "Succeeded", + "stageTime": "2021-03-15T00:25:19+00:00" + }, + { + "stageName": "Delivered", + "displayName": "Delivered", + "stageStatus": "Succeeded", + "stageTime": "2021-03-15T00:25:26+00:00" + }, + { + "stageName": "PickedUp", + "displayName": "Picked up", + "stageStatus": "Succeeded", + "stageTime": "2021-03-15T00:30:22+00:00" + }, + { + "stageName": "AtAzureDC", + "displayName": "Received", + "stageStatus": "Succeeded", + "stageTime": "2021-03-15T00:30:29+00:00" + }, + { + "stageName": "DataCopy", + "displayName": "Data copy in progress", + "stageStatus": "WaitingForCustomerActionForCleanUp", + "stageTime": "2021-03-15T00:45:26.2679756+00:00" + }, + { + "stageName": "Completed", + "displayName": "Completed", + "stageStatus": "None" + } + ], + "contactDetails": { + "contactName": "Andrew Tribone", + "phone": "1234567890", + "phoneExtension": "1234", + "emailList": [ + "ssemmail@microsoft.com", + "vishwamdir@microsoft.com" + ], + "notificationPreference": [ + { + "stageName": "DevicePrepared", + "sendNotification": true + }, + { + "stageName": "Dispatched", + "sendNotification": true + }, + { + "stageName": "Delivered", + "sendNotification": true + }, + { + "stageName": "PickedUp", + "sendNotification": true + }, + { + "stageName": "AtAzureDC", + "sendNotification": true + }, + { + "stageName": "DataCopy", + "sendNotification": true + } + ] + }, + "shippingAddress": { + "streetAddress1": "164 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "deliveryPackage": { + "trackingUrl": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=6f00fcce-1eec-4ee7-99a8-0acc68efd1c7", + "carrierName": "Ups", + "trackingId": "6f00fcce-1eec-4ee7-99a8-0acc68efd1c7" + }, + "returnPackage": { + "trackingUrl": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=79148759-b772-4a90-933b-da5ae5ac6ebb", + "carrierName": "Ups", + "trackingId": "79148759-b772-4a90-933b-da5ae5ac6ebb" + }, + "dataImportDetails": [ + { + "accountDetails": { + "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount", + "dataAccountType": "StorageAccount" + } + }, + { + "accountDetails": { + "resourceGroupId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat3198inh0-9)inh(il(h)_fyoin)(upf(yLASD0-FJ(hal-DSNWP0JDS0P3-0SJ94", + "stagingStorageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/manageddisktest/providers/Microsoft.Storage/storageAccounts/sojainmanageddisk", + "dataAccountType": "ManagedDisk" + } + } + ], + "jobDetailsType": "DataBox", + "preferences": { + "encryptionPreferences": { + "doubleEncryption": "Disabled" + } + }, + "copyLogDetails": [ + { + "accountName": "databoxbvttestaccount", + "copyLogLink": "databoxcopylog/strtrinidad01_ZTS18520041_CopyLog_8425fb8f9c2b447288caa4dd6f5d34bb.xml", + "copyLogDetailsType": "DataBox" + }, + { + "accountName": "akvenkat3198inh0-9)inh(il(h)_fyoin)(upf(yLASD0-FJ(hal-DSNWP0JDS0P3-0SJ94", + "copyLogLink": "databoxcopylog/strtrinidad01_ZTS18520041_CopyLog_8425fb8f9c2b447288caa4dd6f5d34bb.xml", + "copyLogDetailsType": "DataBox" + } + ], + "reverseShipmentLabelSasKey": "https://wusbeta.blob.core.windows.net/10dcd296-ed09-4037-ac19-2f16c4866452/ReverseShipment/79148759-b772-4a90-933b-da5ae5ac6ebb.PDF?sv=2018-03-28&sr=b&sig=bNtVcKRfYq1kiz0vxxSV%2FIZodCK8nUsCPu6MYK%2B6Erk%3D&st=2021-06-21T15%3A35%3A29Z&se=2021-06-21T16%3A05%3A29Z&sp=r", + "keyEncryptionKey": { + "kekType": "MicrosoftManaged" + }, + "actions": [ + "MoveToCleanUpDevice" + ], + "lastMitigationActionOnJob": { + "actionDateTimeInUtc": "2021-05-12T05:00:22.5047578Z", + "isPerformedByCustomer": true, + "customerResolution": "MoveToCleanUpDevice" + } + }, + "deliveryType": "NonScheduled", + "isCancellableWithoutFee": false + }, + "systemData": { + "createdBy": "5ff6737b-7c50-45d1-b2cb-63a6cd723138", + "createdByType": "Application", + "createdAt": "2021-03-14T23:49:48.349255+00:00", + "lastModifiedBy": "5ff6737b-7c50-45d1-b2cb-63a6cd723138", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-03-14T23:49:48.349255+00:00" + }, + "location": "westus", + "tags": { + "defaultTagsKey": "defaultTagsValue" + }, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "TJx-637505258985313014", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/dmstestresource/providers/Microsoft.DataBox/jobs/TJx-637505258985313014", + "type": "Microsoft.DataBox/jobs" + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsList.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsList.json new file mode 100644 index 000000000000..d64a4a51fe40 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsList.json @@ -0,0 +1,805 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "api-version": "2020-11-01", + "$expand": "details", + "x-ms-client-request-id": [ + "044127c5-663e-4a0f-9061-2fa0ca8058c4" + ], + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.29017.01", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.18363.", + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": false, + "isDeletable": true, + "isShippingAddressEditable": false, + "isPrepareToShipEnabled": false, + "status": "Cancelled", + "startTime": "2018-08-30T14:44:39.77401+05:30", + "cancellationReason": "Old job which is still in ordered state cancelled by the service", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": false + }, + "location": "australiaeast", + "tags": {}, + "sku": { + "name": "DataBoxDisk" + }, + "identity": { + "type": "None" + }, + "name": "mnaustest", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/ausresgrpmn/providers/Microsoft.DataBox/jobs/mnaustest", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": false, + "isDeletable": true, + "isShippingAddressEditable": false, + "isPrepareToShipEnabled": false, + "status": "Cancelled", + "startTime": "2018-09-10T18:03:22.2578238+05:30", + "cancellationReason": "Old job which is still in ordered state cancelled by the service", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": false + }, + "location": "australiaeast", + "tags": {}, + "sku": { + "name": "DataBoxDisk" + }, + "identity": { + "type": "None" + }, + "name": "portalcontractAUS", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/ausresgrpmn/providers/Microsoft.DataBox/jobs/portalcontractAUS", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": false, + "isDeletable": true, + "isShippingAddressEditable": false, + "isPrepareToShipEnabled": false, + "status": "Cancelled", + "startTime": "2018-08-30T15:17:17.3753642+05:30", + "cancellationReason": "Old job which is still in ordered state cancelled by the service", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": false + }, + "location": "australiaeast", + "tags": {}, + "sku": { + "name": "DataBoxDisk" + }, + "identity": { + "type": "None" + }, + "name": "testBB-diskAU", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/testBB/providers/Microsoft.DataBox/jobs/testBB-diskAU", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "transferType": "ExportFromAzure", + "isCancellable": false, + "isDeletable": true, + "isShippingAddressEditable": false, + "isPrepareToShipEnabled": false, + "status": "Cancelled", + "startTime": "2020-05-04T11:12:15.5972523+05:30", + "cancellationReason": "Old job which is still in ordered state cancelled by the service", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": false + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "allXML", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat12/providers/Microsoft.DataBox/jobs/allXML", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "transferType": "ExportFromAzure", + "isCancellable": true, + "isDeletable": false, + "isShippingAddressEditable": true, + "isPrepareToShipEnabled": false, + "status": "DeviceOrdered", + "startTime": "2020-05-07T15:51:08.4479315+05:30", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": true + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "bothExportAllxml", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat12/providers/Microsoft.DataBox/jobs/bothExportAllxml", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "transferType": "ExportFromAzure", + "isCancellable": false, + "isDeletable": true, + "isShippingAddressEditable": false, + "isPrepareToShipEnabled": false, + "status": "Cancelled", + "startTime": "2020-05-04T19:44:59.2410723+05:30", + "cancellationReason": "Old job which is still in ordered state cancelled by the service", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": false + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "exportAll", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat12/providers/Microsoft.DataBox/jobs/exportAll", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": false, + "isDeletable": true, + "isShippingAddressEditable": false, + "isPrepareToShipEnabled": false, + "status": "Cancelled", + "startTime": "2020-05-04T18:31:05.3036028+05:30", + "cancellationReason": "Old job which is still in ordered state cancelled by the service", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": false + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "importRegressnTest", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat12/providers/Microsoft.DataBox/jobs/importRegressnTest", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "transferType": "ExportFromAzure", + "isCancellable": true, + "isDeletable": false, + "isShippingAddressEditable": true, + "isPrepareToShipEnabled": false, + "status": "DeviceOrdered", + "startTime": "2020-05-09T01:57:03.8985885+05:30", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": true + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "testBotthXMLAndAll", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat12/providers/Microsoft.DataBox/jobs/testBotthXMLAndAll", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "transferType": "ExportFromAzure", + "isCancellable": false, + "isDeletable": true, + "isShippingAddressEditable": false, + "isPrepareToShipEnabled": false, + "status": "Cancelled", + "startTime": "2020-05-05T15:56:52.6983398+05:30", + "cancellationReason": "Old job which is still in ordered state cancelled by the service", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": false + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "testExportAllOrder", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat12/providers/Microsoft.DataBox/jobs/testExportAllOrder", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "transferType": "ExportFromAzure", + "isCancellable": false, + "isDeletable": true, + "isShippingAddressEditable": false, + "isPrepareToShipEnabled": false, + "status": "Cancelled", + "startTime": "2020-05-04T17:45:25.464989+05:30", + "cancellationReason": "Old job which is still in ordered state cancelled by the service", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": false + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "testPayload", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat12/providers/Microsoft.DataBox/jobs/testPayload", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "transferType": "ExportFromAzure", + "isCancellable": false, + "isDeletable": true, + "isShippingAddressEditable": false, + "isPrepareToShipEnabled": false, + "status": "Cancelled", + "startTime": "2020-05-04T10:43:04.8775864+05:30", + "cancellationReason": "Old job which is still in ordered state cancelled by the service", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": false + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "xmlOnlyOrder", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat12/providers/Microsoft.DataBox/jobs/xmlOnlyOrder", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": false, + "isDeletable": true, + "isShippingAddressEditable": false, + "isPrepareToShipEnabled": false, + "status": "Cancelled", + "startTime": "2018-11-27T15:17:49.0760408+05:30", + "cancellationReason": "Old job which is still in ordered state cancelled by the service", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": false + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "testbadresourcegroup", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat3198inh0-9)inh(il(h)_fyoin)(upf(yLASD0-FJ(hal-DSNWP0JDS0P3-0SJ93/providers/Microsoft.DataBox/jobs/testbadresourcegroup", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": false, + "isDeletable": true, + "isShippingAddressEditable": false, + "isPrepareToShipEnabled": false, + "status": "Cancelled", + "startTime": "2019-01-04T09:08:49.9928621+05:30", + "cancellationReason": "Old job which is still in ordered state cancelled by the service", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": false + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "andipodtest4jan", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/andipodtest4jan", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "transferType": "ExportFromAzure", + "isCancellable": false, + "isDeletable": true, + "isShippingAddressEditable": false, + "isPrepareToShipEnabled": false, + "status": "Cancelled", + "startTime": "2020-05-28T15:20:48.1058546+05:30", + "cancellationReason": "NoLongerNeeded null", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": false + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "dbtest1", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/dbtest1", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": false, + "isDeletable": true, + "isShippingAddressEditable": false, + "isPrepareToShipEnabled": false, + "status": "Cancelled", + "startTime": "2020-04-14T08:51:18.2067875+05:30", + "cancellationReason": "IncorrectOrder null", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": false + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "degautam14-04-Clone", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/degautam14-04-Clone", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "transferType": "ExportFromAzure", + "isCancellable": true, + "isDeletable": false, + "isShippingAddressEditable": true, + "isPrepareToShipEnabled": false, + "status": "DeviceOrdered", + "startTime": "2020-05-27T18:08:30.6622356+05:30", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": true + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "degautamtestexport", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/degautamtestexport", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "transferType": "ExportFromAzure", + "isCancellable": true, + "isDeletable": false, + "isShippingAddressEditable": true, + "isPrepareToShipEnabled": false, + "status": "DeviceOrdered", + "startTime": "2020-05-21T20:41:02.3837388+05:30", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": true + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "DegautamTestExportOrder", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/DegautamTestExportOrder", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "transferType": "ExportFromAzure", + "isCancellable": true, + "isDeletable": false, + "isShippingAddressEditable": true, + "isPrepareToShipEnabled": false, + "status": "DeviceOrdered", + "startTime": "2020-05-24T07:56:23.6839464+05:30", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": true + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "degautamtestorder", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/degautamtestorder", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": false, + "isDeletable": true, + "isShippingAddressEditable": false, + "isPrepareToShipEnabled": false, + "status": "Cancelled", + "startTime": "2020-04-14T08:48:21.2260174+05:30", + "cancellationReason": "IncorrectOrder null", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": false + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "degautamTestOrder14-04", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/degautamTestOrder14-04", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "transferType": "ExportFromAzure", + "isCancellable": true, + "isDeletable": false, + "isShippingAddressEditable": true, + "isPrepareToShipEnabled": false, + "status": "DeviceOrdered", + "startTime": "2020-05-12T12:19:19.8627264+05:30", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": true + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "export", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/export", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "transferType": "ExportFromAzure", + "isCancellable": false, + "isDeletable": true, + "isShippingAddressEditable": false, + "isPrepareToShipEnabled": false, + "status": "Cancelled", + "startTime": "2020-04-05T19:50:20.9692355+05:30", + "cancellationReason": "Old job which is still in ordered state cancelled by the service", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": false + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "exportTestResource", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat/providers/Microsoft.DataBox/jobs/exportTestResource", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": false, + "isDeletable": true, + "isShippingAddressEditable": false, + "isPrepareToShipEnabled": false, + "status": "Cancelled", + "startTime": "2020-04-10T15:09:45.7080012+05:30", + "cancellationReason": "Old job which is still in ordered state cancelled by the service", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": false + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "sanakTestImportNew", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat/providers/Microsoft.DataBox/jobs/sanakTestImportNew", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": false, + "isDeletable": true, + "isShippingAddressEditable": false, + "isPrepareToShipEnabled": false, + "status": "Cancelled", + "startTime": "2020-04-10T15:13:02.5724966+05:30", + "cancellationReason": "Old job which is still in ordered state cancelled by the service", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": false + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "sanakTestImportOld", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat/providers/Microsoft.DataBox/jobs/sanakTestImportOld", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "transferType": "ExportFromAzure", + "isCancellable": false, + "isDeletable": true, + "isShippingAddressEditable": false, + "isPrepareToShipEnabled": false, + "status": "Cancelled", + "startTime": "2020-04-20T13:39:28.1940929+05:30", + "cancellationReason": "Old job which is still in ordered state cancelled by the service", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": false + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "sanakTestImportOld1", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat/providers/Microsoft.DataBox/jobs/sanakTestImportOld1", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": false, + "isDeletable": true, + "isShippingAddressEditable": false, + "isPrepareToShipEnabled": false, + "status": "Cancelled", + "startTime": "2020-04-10T15:14:59.6879599+05:30", + "cancellationReason": "Old job which is still in ordered state cancelled by the service", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": false + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "sanakTestImportOld2", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat/providers/Microsoft.DataBox/jobs/sanakTestImportOld2", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": true, + "isDeletable": false, + "isShippingAddressEditable": true, + "isPrepareToShipEnabled": false, + "status": "DeviceOrdered", + "startTime": "2020-07-21T23:43:34.513148+05:30", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": true + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "saranyagorder", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/saranyagorder", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": false, + "isDeletable": true, + "isShippingAddressEditable": false, + "isPrepareToShipEnabled": false, + "status": "Cancelled", + "startTime": "2019-07-04T14:01:50.9232807+05:30", + "cancellationReason": "IncorrectOrder null", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": false + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "testdeepak04-07", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/testdeepak04-07", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": false, + "isDeletable": true, + "isShippingAddressEditable": false, + "isPrepareToShipEnabled": false, + "status": "Cancelled", + "startTime": "2019-02-11T12:33:16.6231232+05:30", + "cancellationReason": "Old job which is still in ordered state cancelled by the service", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": false + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBoxHeavy" + }, + "identity": { + "type": "None" + }, + "name": "testdurga-heavy", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/testdurga-heavy", + "type": "Microsoft.DataBox/jobs" + } + ], + "nextLink": "https://management.azure.com/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/providers/Microsoft.DataBox/jobs?api-version=2020-11-01&%24skiptoken=fVJdb5swFP0v0bq3NMaFFipVU5oATRbSxBjz8WYDIQbzoUBISNX%2fPrfVumnaJvnB8rn3nON77suoSs%2fdildFO7p%2fGfmmiz13dD%2fad13T3k8mJa1olpZp1V3Ty%2fGQXsd1OWmPrI0PvOl4XbWTHb3VgQ53Y323uxurFGpjQ4vvxnFqJFRTFajC3aQ51D1P0kM7cXh8qNt6113PaUcf6%2fMkr1n7jTZ83EtcUj5AAMEYqGOgfP3SFrzBdZFWD5u5oTL%2flCUlGWIoepYD7rjqacEfBSvXfWSLY3QBPAlQucImXOT6FWTzba1voXFMJJr4FqC%2bcSS2cYh89QPNFvPznEFNIpoSBqiRd4%2fBTrBcXc%2f4NFvMpjr51FSHVT7VV0ok4motaz9ZZtNsYyEttj3JS2yLM9uTdT9fpI83pmxjaiJ9QtswWAL6obaKgkL2OK4pBS3KPG%2fAAD2uTaXzA7RBStPhqjg5lvBcbDnEbs9%2b0OSJVQwEE4qAd8YFslJPM91SCdNiWYYiaWm57p6DhjuiPmFbcamNnlApuAP3JfZCLfYXg1vV%2bgr8y9Efnl12k%2fzyCp9nVs5IdBvmaz8l0kuFIt9c3oQkVpjY327LKGc%2beteitnnxyzNnAaojM1QTJbt45Tl3lOUhsvbfmRDY8Q1KQDhEBFkrfOpxSdTEWvYJ6ESKf8vCtoYIEoBtI%2f%2fI6y0D72nZMN8aUtkpp%2f%2bXivffzE%2f9f7dBTmPds0puQUX2cmd6JlBPITlusqubRJ7R6%2bsP" + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsListByResourceGroup.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsListByResourceGroup.json new file mode 100644 index 000000000000..61e890cd477b --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsListByResourceGroup.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "SdkRg5154", + "api-version": "2020-11-01", + "$expand": "details", + "x-ms-client-request-id": [ + "c1514209-a439-4bd1-b040-76d7539d2509" + ], + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.29017.01", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.18363.", + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": true, + "isDeletable": false, + "isShippingAddressEditable": true, + "isPrepareToShipEnabled": true, + "status": "DeviceOrdered", + "startTime": "2020-07-03T11:55:54.463792+05:30", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": true + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "SystemAssigned", + "principalId": "fac84c35-5490-4b11-81b9-770053ccbe3b", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "name": "SdkJob5928", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg5154/providers/Microsoft.DataBox/jobs/SdkJob5928", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": true, + "isDeletable": false, + "isShippingAddressEditable": true, + "isPrepareToShipEnabled": true, + "status": "DeviceOrdered", + "startTime": "2020-08-07T10:50:36.3341513+05:30", + "deliveryType": "NonScheduled", + "deliveryInfo": { + "scheduledDateTime": "0001-01-01T05:30:00+05:30" + }, + "isCancellableWithoutFee": true + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "identity": { + "type": "None" + }, + "name": "SdkJob952", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg5154/providers/Microsoft.DataBox/jobs/SdkJob952", + "type": "Microsoft.DataBox/jobs" + } + ] + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsListCredentials.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsListCredentials.json new file mode 100644 index 000000000000..c5134769275f --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsListCredentials.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "bvttoolrg6", + "jobName": "TJ-636646322037905056", + "api-version": "2020-11-01", + "x-ms-client-request-id": [ + "cda11c92-529b-4b75-b56d-ff1a69ffeeba" + ], + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.29017.01", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.18363.", + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "jobName": "TJ-636646322037905056", + "jobSecrets": { + "podSecrets": [ + { + "deviceSerialNumber": "testimolapod-3ecc44ce", + "devicePassword": "", + "networkConfigurations": [ + { + "name": "DataPort3", + "macAddress": "D05099C1F439" + }, + { + "name": "DataPort1", + "macAddress": "EC0D9A21A6C0" + }, + { + "name": "DataPort2", + "macAddress": "EC0D9A21A6C1" + } + ], + "encodedValidationCertPubKey": "5CYoAoVKEBa4WgPVis8keX94w30pon4jGMADSqcdE/NlHLChj6Cmhbl4q9QOFKSB/US4AwhS7zY1QS3YMDrkAPfOy7Hi6kWMBpJWZidTq3oXX8FAQjg+IqQESti/2jvAlcDpO2453rgd7Yb6XZ43P8MMTpTjcarI0ImCf//eITQWnFa3AzfIJ9C+hxCCaA7HTYhwQEPUBMwyQJsI6v6WuQysROtlBgx1YtbWFhDVbcqYRSLIbaj+RdzlvxvDJSo70kv+8em5upuDTpVE7xP+WePLlARdSPNwwfRzHnvCUqC2UqXHpRUhQlYnMqAJEcjjroRnyIGumPmmQ8O155X8aw==", + "accountCredentialDetails": [ + { + "accountName": "databoxbvttestaccount", + "dataAccountType": "StorageAccount", + "accountConnectionString": "", + "shareCredentialDetails": [ + { + "shareName": "databoxbvttestaccount_PageBlob", + "shareType": "PageBlob", + "userName": "databoxbvttestac_903", + "password": "", + "supportedAccessProtocols": [ + "SMB" + ] + }, + { + "shareName": "databoxbvttestaccount_BlockBlob", + "shareType": "BlockBlob", + "userName": "databoxbvttestac_903", + "password": "", + "supportedAccessProtocols": [ + "SMB" + ] + }, + { + "shareName": "databoxbvttestaccount_AzFile", + "shareType": "AzureFile", + "userName": "databoxbvttestac_903", + "password": "", + "supportedAccessProtocols": [ + "SMB" + ] + } + ] + } + ] + } + ], + "jobSecretsType": "DataBox", + "dcAccessSecurityCode": {} + } + } + ] + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsPatch.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsPatch.json new file mode 100644 index 000000000000..92febae7150b --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsPatch.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "SdkRg5154", + "jobName": "SdkJob952", + "api-version": "2020-11-01", + "$expand": "details", + "x-ms-client-request-id": [ + "ff3829ca-bcb0-4737-b6e0-52af57f34bb7" + ], + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.29017.01", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.18363.", + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "584" + ], + "jobResourceUpdateParameter": { + "properties": { + "details": { + "contactDetails": { + "contactName": "Update Job", + "phone": "1234567890", + "phoneExtension": "1234", + "emailList": [ + "testing@microsoft.com" + ] + }, + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "Unit 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "Commercial" + } + } + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": true, + "isShippingAddressEditable": true, + "status": "DeviceOrdered", + "startTime": "2018-04-13T16:28:38.9999793+05:30" + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "SdkJob952", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg5154/providers/Microsoft.DataBox/jobs/SdkJob952", + "type": "Microsoft.DataBox/jobs" + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsPatchCmk.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsPatchCmk.json new file mode 100644 index 000000000000..1992899e8242 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsPatchCmk.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "SdkRg7937", + "jobName": "SdkJob1735", + "api-version": "2020-11-01", + "x-ms-client-request-id": [ + "fcab0fa9-7af8-47e0-b570-d703a48ee66b" + ], + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.29017.01", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.18363.", + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "358" + ], + "jobResourceUpdateParameter": { + "properties": { + "details": { + "keyEncryptionKey": { + "kekType": "CustomerManaged", + "kekUrl": "https://sdkkeyvault.vault.azure.net/keys/SSDKEY/", + "kekVaultResourceID": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat/providers/Microsoft.KeyVault/vaults/SDKKeyVault" + } + } + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": true, + "isShippingAddressEditable": true, + "status": "DeviceOrdered", + "startTime": "2018-04-13T16:28:38.9999793+05:30" + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "SdkJob1735", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg7937/providers/Microsoft.DataBox/jobs/SdkJob1735", + "type": "Microsoft.DataBox/jobs" + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsPatchSystemAssignedToUserAssigned.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsPatchSystemAssignedToUserAssigned.json new file mode 100644 index 000000000000..c2d169ad6a82 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/JobsPatchSystemAssignedToUserAssigned.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "SdkRg9765", + "jobName": "SdkJob2965", + "api-version": "2020-11-01", + "x-ms-client-request-id": [ + "25b11bec-6551-47a4-9ee2-575245cbfd45" + ], + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.29220.03", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.19041.", + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.2.0" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "923" + ], + "jobResourceUpdateParameter": { + "properties": { + "details": { + "keyEncryptionKey": { + "kekType": "CustomerManaged", + "identityProperties": { + "type": "UserAssigned", + "userAssigned": { + "resourceId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sdkIdentity" + } + }, + "kekUrl": "https://sdkkeyvault.vault.azure.net/keys/SSDKEY/", + "kekVaultResourceID": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat/providers/Microsoft.KeyVault/vaults/SDKKeyVault" + } + } + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sdkIdentity": {} + } + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "properties": { + "transferType": "ImportToAzure", + "isCancellable": true, + "isShippingAddressEditable": true, + "status": "DeviceOrdered", + "startTime": "2018-04-13T16:28:38.9999793+05:30" + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "SdkJob2965", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg9765/providers/Microsoft.DataBox/jobs/SdkJob2965", + "type": "Microsoft.DataBox/jobs" + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/OperationsGet.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/OperationsGet.json new file mode 100644 index 000000000000..f96f0598e269 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/OperationsGet.json @@ -0,0 +1,212 @@ +{ + "parameters": { + "api-version": "2020-11-01", + "x-ms-client-request-id": [ + "b9453354-c675-40a8-99c0-8039818c85fd" + ], + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.29017.01", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.18363.", + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DataBox/locations/operationResults/read", + "display": { + "provider": "Azure Data Box", + "resource": "Operation Results", + "operation": "List Operation Results", + "description": "List or get the Operation Results" + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/jobs/cancel/action", + "display": { + "provider": "Azure Data Box", + "resource": "Orders", + "operation": "Cancel", + "description": "Cancels an order in progress." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/jobs/bookShipmentPickUp/action", + "display": { + "provider": "Azure Data Box", + "resource": "Orders", + "operation": "Book Shipment Pick Up", + "description": "Allows to book a pick up for return shipments." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/jobs/read", + "display": { + "provider": "Azure Data Box", + "resource": "Orders", + "operation": "List Orders", + "description": "List or get the Orders" + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/jobs/delete", + "display": { + "provider": "Azure Data Box", + "resource": "Orders", + "operation": "Delete Orders", + "description": "Delete the Orders" + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/jobs/write", + "display": { + "provider": "Azure Data Box", + "resource": "Orders", + "operation": "Create or Update Orders", + "description": "Create or update the Orders" + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/jobs/listCredentials/action", + "display": { + "provider": "Azure Data Box", + "resource": "Orders", + "operation": "List Credentials", + "description": "Lists the unencrypted credentials related to the order." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/locations/validateInputs/action", + "display": { + "provider": "Azure Data Box", + "resource": "Validate Inputs", + "operation": "Validate Inputs", + "description": "This method does all type of validations." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/locations/validateAddress/action", + "display": { + "provider": "Azure Data Box", + "resource": "Validate Address", + "operation": "Validate Address", + "description": "Validates the shipping address and provides alternate addresses if any." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/subscriptions/resourceGroups/moveResources/action", + "display": { + "provider": "Azure Data Box", + "resource": "Move Resource", + "operation": "Move Resource", + "description": "This method performs the resource move." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/subscriptions/resourceGroups/validateMoveResources/action", + "display": { + "provider": "Azure Data Box", + "resource": "Move Resource", + "operation": "Validate Move Resource Request", + "description": "This method validates whether resource move is allowed or not." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/locations/availableSkus/action", + "display": { + "provider": "Azure Data Box", + "resource": "Available Skus", + "operation": "Availabe Skus", + "description": "This method returns the list of available skus." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/locations/regionConfiguration/action", + "display": { + "provider": "Azure Data Box", + "resource": "Region Configuration", + "operation": "Region Configuration", + "description": "This method returns the configurations for the region." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/locations/availableSkus/read", + "display": { + "provider": "Azure Data Box", + "resource": "Available Skus", + "operation": "List Available Skus", + "description": "List or get the Available Skus" + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/register/action", + "display": { + "provider": "Azure Data Box", + "resource": "Register Microsoft.Databox", + "operation": "Register Microsoft.Databox", + "description": "Register Provider Microsoft.Databox" + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/unregister/action", + "display": { + "provider": "Azure Data Box", + "resource": "Register Microsoft.Databox", + "operation": "Un-Register Microsoft.Databox", + "description": "Un-Register Provider Microsoft.Databox" + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/operations/read", + "display": { + "provider": "Azure Data Box", + "resource": "Operations", + "operation": "List Operations", + "description": "List or get the Operations" + }, + "properties": {}, + "origin": "user" + } + ] + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/RegionConfiguration.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/RegionConfiguration.json new file mode 100644 index 000000000000..ea1758e64f6b --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/RegionConfiguration.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "location": "westus", + "api-version": "2020-11-01", + "regionConfigurationRequest": { + "scheduleAvailabilityRequest": { + "storageLocation": "westus", + "skuName": "DataBox" + } + } + }, + "responses": { + "200": { + "body": { + "scheduleAvailabilityResponse": { + "availableDates": [ + "2019-07-11T00:00:00+00:00", + "2019-07-12T00:00:00+00:00", + "2019-07-13T00:00:00+00:00", + "2019-07-14T00:00:00+00:00", + "2019-07-15T00:00:00+00:00", + "2019-07-16T00:00:00+00:00", + "2019-07-17T00:00:00+00:00", + "2019-07-18T00:00:00+00:00", + "2019-07-19T00:00:00+00:00", + "2019-07-20T00:00:00+00:00", + "2019-07-21T00:00:00+00:00", + "2019-07-22T00:00:00+00:00", + "2019-07-23T00:00:00+00:00", + "2019-07-24T00:00:00+00:00", + "2019-07-25T00:00:00+00:00", + "2019-07-26T00:00:00+00:00", + "2019-07-27T00:00:00+00:00", + "2019-07-28T00:00:00+00:00", + "2019-07-29T00:00:00+00:00", + "2019-07-30T00:00:00+00:00", + "2019-07-31T00:00:00+00:00" + ] + } + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/RegionConfigurationByResourceGroup.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/RegionConfigurationByResourceGroup.json new file mode 100644 index 000000000000..653dbcb9e19e --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/RegionConfigurationByResourceGroup.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "SdkRg4981", + "location": "westus", + "api-version": "2020-11-01", + "regionConfigurationRequest": { + "scheduleAvailabilityRequest": { + "storageLocation": "westus", + "skuName": "DataBox" + } + } + }, + "responses": { + "200": { + "body": { + "scheduleAvailabilityResponse": { + "availableDates": [ + "2019-07-11T00:00:00+00:00", + "2019-07-12T00:00:00+00:00", + "2019-07-13T00:00:00+00:00", + "2019-07-14T00:00:00+00:00", + "2019-07-15T00:00:00+00:00", + "2019-07-16T00:00:00+00:00", + "2019-07-17T00:00:00+00:00", + "2019-07-18T00:00:00+00:00", + "2019-07-19T00:00:00+00:00", + "2019-07-20T00:00:00+00:00", + "2019-07-21T00:00:00+00:00", + "2019-07-22T00:00:00+00:00", + "2019-07-23T00:00:00+00:00", + "2019-07-24T00:00:00+00:00", + "2019-07-25T00:00:00+00:00", + "2019-07-26T00:00:00+00:00", + "2019-07-27T00:00:00+00:00", + "2019-07-28T00:00:00+00:00", + "2019-07-29T00:00:00+00:00", + "2019-07-30T00:00:00+00:00", + "2019-07-31T00:00:00+00:00" + ] + } + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/ValidateAddressPost.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/ValidateAddressPost.json new file mode 100644 index 000000000000..40a3f3c5037d --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/ValidateAddressPost.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "location": "westus", + "api-version": "2020-11-01", + "x-ms-client-request-id": [ + "cfda3c52-b129-4568-aba7-e743edf747c2" + ], + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.29017.01", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.18363.", + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "351" + ], + "validateAddress": { + "validationType": "ValidateAddress", + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "Unit 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "Commercial" + }, + "deviceType": "DataBox" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "validationStatus": "Valid", + "alternateAddresses": [ + { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "Unit 1", + "streetAddress3": "", + "city": "SAN FRANCISCO", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "addressType": "None" + } + ], + "validationType": "ValidateAddress" + } + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/ValidateInputs.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/ValidateInputs.json new file mode 100644 index 000000000000..cd8a27819782 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/ValidateInputs.json @@ -0,0 +1,166 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "location": "westus", + "api-version": "2020-11-01", + "x-ms-client-request-id": [ + "129a0589-5017-4f35-a66c-8da38e04aae1" + ], + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.29017.01", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.18363.", + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "1675" + ], + "validationRequest": { + "validationCategory": "JobCreationValidation", + "individualRequestDetails": [ + { + "validationType": "ValidateDataTransferDetails", + "dataImportDetails": [ + { + "accountDetails": { + "dataAccountType": "StorageAccount", + "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount" + } + } + ], + "deviceType": "DataBox", + "transferType": "ImportToAzure" + }, + { + "validationType": "ValidateAddress", + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "Unit 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "Commercial" + }, + "deviceType": "DataBox", + "transportPreferences": { + "preferredShipmentType": "MicrosoftManaged" + } + }, + { + "validationType": "ValidateSubscriptionIsAllowedToCreateJob" + }, + { + "validationType": "ValidateSkuAvailability", + "deviceType": "DataBox", + "transferType": "ImportToAzure", + "country": "US", + "location": "westus" + }, + { + "validationType": "ValidateCreateOrderLimit", + "deviceType": "DataBox" + }, + { + "validationType": "ValidatePreferences", + "preference": { + "transportPreferences": { + "preferredShipmentType": "MicrosoftManaged" + } + }, + "deviceType": "DataBox" + } + ] + } + }, + "responses": { + "200": { + "body": { + "properties": { + "status": "AllValidToProceed", + "individualResponseDetails": [ + { + "status": "Valid", + "validationType": "ValidateDataTransferDetails", + "error": { + "code": "Success", + "target": "KeyEncryptionKey", + "details": [], + "additionalInfo": [] + } + }, + { + "validationStatus": "Valid", + "alternateAddresses": [ + { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "Unit 1", + "streetAddress3": "", + "city": "SAN FRANCISCO", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "addressType": "None" + } + ], + "validationType": "ValidateAddress", + "error": { + "code": "Success", + "target": "KeyEncryptionKey", + "details": [], + "additionalInfo": [] + } + }, + { + "status": "Valid", + "validationType": "ValidateSubscriptionIsAllowedToCreateJob", + "error": { + "code": "Success", + "target": "KeyEncryptionKey", + "details": [], + "additionalInfo": [] + } + }, + { + "status": "Valid", + "validationType": "ValidateSkuAvailability", + "error": { + "code": "Success", + "target": "KeyEncryptionKey", + "details": [], + "additionalInfo": [] + } + }, + { + "status": "Valid", + "validationType": "ValidateCreateOrderLimit", + "error": { + "code": "Success", + "target": "KeyEncryptionKey", + "details": [], + "additionalInfo": [] + } + }, + { + "status": "Valid", + "validationType": "ValidatePreferences", + "error": { + "code": "Success", + "target": "KeyEncryptionKey", + "details": [], + "additionalInfo": [] + } + } + ] + } + } + } + } +} diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/ValidateInputsByResourceGroup.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/ValidateInputsByResourceGroup.json new file mode 100644 index 000000000000..c70a59c27ffe --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/examples/ValidateInputsByResourceGroup.json @@ -0,0 +1,167 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "SdkRg6861", + "location": "westus", + "api-version": "2020-11-01", + "x-ms-client-request-id": [ + "85f045bb-7659-4a2f-bcf5-96723954afdf" + ], + "Accept-Language": [ + "en-US" + ], + "User-Agent": [ + "FxVersion/4.6.29017.01", + "OSName/Windows", + "OSVersion/Microsoft.Windows.10.0.18363.", + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "1675" + ], + "validationRequest": { + "validationCategory": "JobCreationValidation", + "individualRequestDetails": [ + { + "validationType": "ValidateDataTransferDetails", + "dataImportDetails": [ + { + "accountDetails": { + "dataAccountType": "StorageAccount", + "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount" + } + } + ], + "deviceType": "DataBox", + "transferType": "ImportToAzure" + }, + { + "validationType": "ValidateAddress", + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "Unit 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "Commercial" + }, + "deviceType": "DataBox", + "transportPreferences": { + "preferredShipmentType": "MicrosoftManaged" + } + }, + { + "validationType": "ValidateSubscriptionIsAllowedToCreateJob" + }, + { + "validationType": "ValidateSkuAvailability", + "deviceType": "DataBox", + "transferType": "ImportToAzure", + "country": "US", + "location": "westus" + }, + { + "validationType": "ValidateCreateOrderLimit", + "deviceType": "DataBox" + }, + { + "validationType": "ValidatePreferences", + "preference": { + "transportPreferences": { + "preferredShipmentType": "MicrosoftManaged" + } + }, + "deviceType": "DataBox" + } + ] + } + }, + "responses": { + "200": { + "body": { + "properties": { + "status": "AllValidToProceed", + "individualResponseDetails": [ + { + "status": "Valid", + "validationType": "ValidateDataTransferDetails", + "error": { + "code": "Success", + "target": "KeyEncryptionKey", + "details": [], + "additionalInfo": [] + } + }, + { + "validationStatus": "Valid", + "alternateAddresses": [ + { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "Unit 1", + "streetAddress3": "", + "city": "SAN FRANCISCO", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "addressType": "None" + } + ], + "validationType": "ValidateAddress", + "error": { + "code": "Success", + "target": "KeyEncryptionKey", + "details": [], + "additionalInfo": [] + } + }, + { + "status": "Valid", + "validationType": "ValidateSubscriptionIsAllowedToCreateJob", + "error": { + "code": "Success", + "target": "KeyEncryptionKey", + "details": [], + "additionalInfo": [] + } + }, + { + "status": "Valid", + "validationType": "ValidateSkuAvailability", + "error": { + "code": "Success", + "target": "KeyEncryptionKey", + "details": [], + "additionalInfo": [] + } + }, + { + "status": "Valid", + "validationType": "ValidateCreateOrderLimit", + "error": { + "code": "Success", + "target": "KeyEncryptionKey", + "details": [], + "additionalInfo": [] + } + }, + { + "status": "Valid", + "validationType": "ValidatePreferences", + "error": { + "code": "Success", + "target": "KeyEncryptionKey", + "details": [], + "additionalInfo": [] + } + } + ] + } + } + } + } +} diff --git a/specification/databox/resource-manager/readme.cli.md b/specification/databox/resource-manager/readme.cli.md index 685a3b701cc9..c239dabad5f4 100644 --- a/specification/databox/resource-manager/readme.cli.md +++ b/specification/databox/resource-manager/readme.cli.md @@ -31,4 +31,5 @@ cli: - name: AvailableSkusPost - name: JobsDelete - name: JobMitigate + - name: JobsGetWaitingForAction ``` \ No newline at end of file diff --git a/specification/databox/resource-manager/readme.go.md b/specification/databox/resource-manager/readme.go.md index 9213be8d0375..173899588dcb 100644 --- a/specification/databox/resource-manager/readme.go.md +++ b/specification/databox/resource-manager/readme.go.md @@ -18,15 +18,7 @@ batch: - tag: package-2020-04 - tag: package-2020-11 - tag: package-2021-03 -``` - -### Tag: package-2021-03 and go - -These settings apply only when `--tag=package-2021-03 --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag) == 'package-2021-03' && $(go) -output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2021-03-01/$(namespace) + - tag: package-2021-05 ``` ### Tag: package-2018-01 and go @@ -63,4 +55,22 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2021-03' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2021-03-01/$(namespace) +``` + +### Tag: package-2021-05 and go + +These settings apply only when `--tag=package-2021-05 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2021-05' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2021-05-01/$(namespace) ``` \ No newline at end of file diff --git a/specification/databox/resource-manager/readme.java.md b/specification/databox/resource-manager/readme.java.md index e6f705978a1f..d6d4d8d7f438 100644 --- a/specification/databox/resource-manager/readme.java.md +++ b/specification/databox/resource-manager/readme.java.md @@ -22,6 +22,7 @@ batch: - tag: package-2020-04 - tag: package-2020-11 - tag: package-2021-03 + - tag: package-2021-05 ``` ### Tag: package-2018-01 and java @@ -87,4 +88,17 @@ java: output-folder: $(azure-libraries-for-java-folder)/sdk/databox/mgmt-v2021_03_01 regenerate-manager: true generate-interface: true +``` + +### Tag: package-2021-05 and java + +These settings apply only when `--tag=package-2021-05-java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2021-05' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.databox.v2021_05-01 + output-folder: $(azure-libraries-for-java-folder)/sdk/databox/mgmt-v2021_05_01 +regenerate-manager: true +generate-interface: true ``` \ No newline at end of file diff --git a/specification/databox/resource-manager/readme.md b/specification/databox/resource-manager/readme.md index cbc5359579e8..0c0afa8e836f 100644 --- a/specification/databox/resource-manager/readme.md +++ b/specification/databox/resource-manager/readme.md @@ -26,7 +26,16 @@ These are the global settings for the DataBox API. ``` yaml openapi-type: arm -tag: package-2021-03 +tag: package-2021-05 +``` + +### Tag: package-2021-05 + +These settings apply only when `--tag=package-2021-05` is specified on the command line. + +``` yaml $(tag) == 'package-2021-05' +input-file: +- Microsoft.DataBox/stable/2021-05-01/databox.json ``` ### Tag: package-2021-03 @@ -86,9 +95,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - after_scripts: - - python ./scripts/multiapi_init_gen.py azure-mgmt-databox - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-js - repo: azure-sdk-for-node diff --git a/specification/databox/resource-manager/readme.python.md b/specification/databox/resource-manager/readme.python.md index a4a1d6053bd0..c85c820f2ecd 100644 --- a/specification/databox/resource-manager/readme.python.md +++ b/specification/databox/resource-manager/readme.python.md @@ -4,26 +4,12 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.databox - package-name: azure-mgmt-databox - package-version: 0.1.0 - title: DataBoxManagementClient - description: The DataBox Client. - clear-output-folder: true - no-namespace-folders: true -``` - ``` yaml $(python) && $(track2) azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.databox package-name: azure-mgmt-databox -package-version: 0.1.0 +package-version: 1.0.0b1 title: DataBoxManagementClient description: The DataBox Client. clear-output-folder: true @@ -36,15 +22,7 @@ Generate all API versions currently shipped for this package ```yaml $(python) && $(multiapi) && !$(track2) batch: - - tag: package-2021-03 - - tag: package-2020-11 - - tag: package-2020-04 - - tag: package-2019-09 - - tag: package-2018-01 -``` - -```yaml $(python) && $(multiapi) && $(track2) -batch: + - tag: package-2021-05 - tag: package-2021-03 - tag: package-2020-11 - tag: package-2020-04 @@ -58,17 +36,21 @@ output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/datab clear-output-folder: false perform-load: false ``` +### Tag: package-2021-05 and python + +These settings apply only when `--tag=package-2021-05 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2021-05' && $(python) && $(track2) +namespace: azure.mgmt.databox.v2021_05_01 +output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox/v2021_05_01 +``` ### Tag: package-2021-03 and python These settings apply only when `--tag=package-2021-03 --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2021-03' && $(python) && !$(track2) -python: - namespace: azure.mgmt.databox.v2021_03_01 - output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox/v2021_03_01 -``` ``` yaml $(tag) == 'package-2021-03' && $(python) && $(track2) namespace: azure.mgmt.databox.v2021_03_01 output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox/v2021_03_01 @@ -79,11 +61,6 @@ output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/datab These settings apply only when `--tag=package-2020-11 --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2020-11' && $(python) && !$(track2) -python: - namespace: azure.mgmt.databox.v2020_11_01 - output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox/v2020_11_01 -``` ``` yaml $(tag) == 'package-2020-11' && $(python) && $(track2) namespace: azure.mgmt.databox.v2020_11_01 output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox/v2020_11_01 @@ -94,11 +71,6 @@ output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/datab These settings apply only when `--tag=package-2020-04 --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2020-04' && $(python) && !$(track2) -python: - namespace: azure.mgmt.databox.v2020_04_01 - output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox/v2020_04_01 -``` ``` yaml $(tag) == 'package-2020-04' && $(python) && $(track2) namespace: azure.mgmt.databox.v2020_04_01 output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox/v2020_04_01 @@ -109,11 +81,6 @@ output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/datab These settings apply only when `--tag=package-2019-09 --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2019-09' && $(python) && !$(track2) -python: - namespace: azure.mgmt.databox.v2019_09_01 - output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox/v2019_09_01 -``` ``` yaml $(tag) == 'package-2019-09' && $(python) && $(track2) namespace: azure.mgmt.databox.v2019_09_01 output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox/v2019_09_01 @@ -124,11 +91,6 @@ output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/datab These settings apply only when `--tag=package-2018-01 --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2018-01' && $(python) && !$(track2) -python: - namespace: azure.mgmt.databox.v2018_01_01 - output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox/v2018_01_01 -``` ``` yaml $(tag) == 'package-2018-01' && $(python) && $(track2) namespace: azure.mgmt.databox.v2018_01_01 output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox/v2018_01_01 diff --git a/specification/databox/resource-manager/readme.ruby.md b/specification/databox/resource-manager/readme.ruby.md index e151617df9d9..819c54c54c7f 100644 --- a/specification/databox/resource-manager/readme.ruby.md +++ b/specification/databox/resource-manager/readme.ruby.md @@ -17,16 +17,7 @@ batch: - tag: package-2020-04 - tag: package-2020-11 - tag: package-2021-03 -``` - -### Tag: package-2021-03 and ruby - -These settings apply only when `--tag=package-2021-03 --ruby` is specified on the command line. -Please also specify `--ruby-sdks-folder=`. - -``` yaml $(tag) == 'package-2018-01' && $(ruby) -namespace: "Azure::Compute::Mgmt::V2021_03_01" -output-folder: $(ruby-sdks-folder)/management/azure_mgmt_databox/lib + - tag: package-2021-05 ``` ### Tag: package-2018-01 and ruby @@ -67,4 +58,24 @@ Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2021-03' && $(ruby) +namespace: "Azure::Compute::Mgmt::V2021_03_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_databox/lib +``` + +### Tag: package-2021-05 and ruby + +These settings apply only when `--tag=package-2021-05 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2021-05' && $(ruby) +namespace: "Azure::Compute::Mgmt::V2021_05_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_databox/lib ``` \ No newline at end of file diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/databoxedge.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/databoxedge.json new file mode 100644 index 000000000000..8778950a7d8c --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/databoxedge.json @@ -0,0 +1,9240 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-02-01", + "title": "DataBoxEdgeManagementClient" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.DataBoxEdge/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "List all the supported operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of supported operations.", + "schema": { + "$ref": "#/definitions/OperationsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "OperationsGet": { + "$ref": "./examples/OperationsGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/availableSkus": { + "get": { + "tags": [ + "AvailableSkus" + ], + "summary": "List all the available Skus and information related to them.", + "operationId": "AvailableSkus_List", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Lists the available Skus and information related to them.", + "schema": { + "$ref": "#/definitions/DataBoxEdgeSkuList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AvailableSkus": { + "$ref": "./examples/AvailableSkusList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices": { + "get": { + "tags": [ + "Devices" + ], + "description": "Gets all the Data Box Edge/Data Box Gateway devices in a subscription.", + "operationId": "Devices_ListBySubscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next page in the list.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The collection of Data Box Edge/Data Box Gateway devices.", + "schema": { + "$ref": "#/definitions/DataBoxEdgeDeviceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "DataBoxEdgeDeviceGetBySubscription": { + "$ref": "./examples/DataBoxEdgeDeviceGetBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices": { + "get": { + "tags": [ + "Devices" + ], + "description": "Gets all the Data Box Edge/Data Box Gateway devices in a resource group.", + "operationId": "Devices_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next page in the list.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The collection of Data Box Edge/Data Box Gateway devices.", + "schema": { + "$ref": "#/definitions/DataBoxEdgeDeviceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "DataBoxEdgeDeviceGetByResourceGroup": { + "$ref": "./examples/DataBoxEdgeDeviceGetByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}": { + "get": { + "tags": [ + "Devices" + ], + "description": "Gets the properties of the Data Box Edge/Data Box Gateway device.", + "operationId": "Devices_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Data Box Edge/Data Box Gateway device.", + "schema": { + "$ref": "#/definitions/DataBoxEdgeDevice" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DataBoxEdgeDeviceGetByName": { + "$ref": "./examples/DataBoxEdgeDeviceGetByName.json" + } + } + }, + "put": { + "tags": [ + "Devices" + ], + "description": "Creates or updates a Data Box Edge/Data Box Gateway resource.", + "operationId": "Devices_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "dataBoxEdgeDevice", + "in": "body", + "description": "The resource object.", + "required": true, + "schema": { + "$ref": "#/definitions/DataBoxEdgeDevice" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the resource.", + "schema": { + "$ref": "#/definitions/DataBoxEdgeDevice" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DataBoxEdgeDevicePut": { + "$ref": "./examples/DataBoxEdgeDevicePut.json" + } + } + }, + "delete": { + "tags": [ + "Devices" + ], + "description": "Deletes the Data Box Edge/Data Box Gateway device.", + "operationId": "Devices_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the resource." + }, + "202": { + "description": "Accepted the request to delete the resource." + }, + "204": { + "description": "The resource is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DataBoxEdgeDeviceDelete": { + "$ref": "./examples/DataBoxEdgeDeviceDelete.json" + } + } + }, + "patch": { + "tags": [ + "Devices" + ], + "description": "Modifies a Data Box Edge/Data Box Gateway resource.", + "operationId": "Devices_Update", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The resource parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DataBoxEdgeDevicePatch" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the resource.", + "schema": { + "$ref": "#/definitions/DataBoxEdgeDevice" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DataBoxEdgeDevicePatch": { + "$ref": "./examples/DataBoxEdgeDevicePatch.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts": { + "get": { + "tags": [ + "Alerts" + ], + "description": "Gets all the alerts for a Data Box Edge/Data Box Gateway device.", + "operationId": "Alerts_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The collection of alerts.", + "schema": { + "$ref": "#/definitions/AlertList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AlertGetAllInDevice": { + "$ref": "./examples/AlertGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts/{name}": { + "get": { + "tags": [ + "Alerts" + ], + "summary": "Gets an alert by name.", + "operationId": "Alerts_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The alert name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The alert details.", + "schema": { + "$ref": "#/definitions/Alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AlertGet": { + "$ref": "./examples/AlertGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules": { + "get": { + "tags": [ + "BandwidthSchedules" + ], + "description": "Gets all the bandwidth schedules for a Data Box Edge/Data Box Gateway device.", + "operationId": "BandwidthSchedules_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The collection of bandwidth schedules.", + "schema": { + "$ref": "#/definitions/BandwidthSchedulesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BandwidthScheduleGetAllInDevice": { + "$ref": "./examples/BandwidthScheduleGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules/{name}": { + "get": { + "tags": [ + "BandwidthSchedules" + ], + "description": "Gets the properties of the specified bandwidth schedule.", + "operationId": "BandwidthSchedules_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The bandwidth schedule name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The bandwidth schedule.", + "schema": { + "$ref": "#/definitions/BandwidthSchedule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "BandwidthScheduleGet": { + "$ref": "./examples/BandwidthScheduleGet.json" + } + } + }, + "put": { + "tags": [ + "BandwidthSchedules" + ], + "description": "Creates or updates a bandwidth schedule.", + "operationId": "BandwidthSchedules_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The bandwidth schedule name which needs to be added/updated.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The bandwidth schedule to be added or updated.", + "required": true, + "schema": { + "$ref": "#/definitions/BandwidthSchedule" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the bandwidth schedule.", + "schema": { + "$ref": "#/definitions/BandwidthSchedule" + } + }, + "202": { + "description": "Accepted the request to create or update the bandwidth schedule." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BandwidthSchedulePut": { + "$ref": "./examples/BandwidthSchedulePut.json" + } + } + }, + "delete": { + "tags": [ + "BandwidthSchedules" + ], + "description": "Deletes the specified bandwidth schedule.", + "operationId": "BandwidthSchedules_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The bandwidth schedule name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted the request to delete the bandwidth schedule." + }, + "204": { + "description": "Successfully deleted the bandwidth schedule." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BandwidthScheduleDelete": { + "$ref": "./examples/BandwidthScheduleDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/diagnosticProactiveLogCollectionSettings/default": { + "get": { + "tags": [ + "DiagnosticSettings" + ], + "description": "Gets the proactive log collection settings of the specified Data Box Edge/Data Box Gateway device.", + "operationId": "DiagnosticSettings_GetDiagnosticProactiveLogCollectionSettings", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The diagnostic proactive log collection settings.", + "schema": { + "$ref": "#/definitions/DiagnosticProactiveLogCollectionSettings" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetDiagnosticProactiveLogCollectionSettings": { + "$ref": "./examples/GetDiagnosticProactiveLogCollectionSettings.json" + } + } + }, + "put": { + "tags": [ + "DiagnosticSettings" + ], + "description": "Updates the proactive log collection settings on a Data Box Edge/Data Box Gateway device.", + "operationId": "DiagnosticSettings_UpdateDiagnosticProactiveLogCollectionSettings", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "proactiveLogCollectionSettings", + "in": "body", + "description": "The proactive log collection settings.", + "required": true, + "schema": { + "$ref": "#/definitions/DiagnosticProactiveLogCollectionSettings" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the proactive log collection settings." + }, + "202": { + "description": "Accepted the request to update the proactive log collection settings." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "UpdateDiagnosticProactiveLogCollectionSettings": { + "$ref": "./examples/UpdateDiagnosticProactiveLogCollectionSettings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/diagnosticRemoteSupportSettings/default": { + "get": { + "tags": [ + "DiagnosticSettings" + ], + "description": "Gets the diagnostic remote support settings of the specified Data Box Edge/Data Box Gateway device.", + "operationId": "DiagnosticSettings_GetDiagnosticRemoteSupportSettings", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The diagnostic remote support settings.", + "schema": { + "$ref": "#/definitions/DiagnosticRemoteSupportSettings" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetDiagnosticRemoteSupportSettings": { + "$ref": "./examples/GetDiagnosticRemoteSupportSettings.json" + } + } + }, + "put": { + "tags": [ + "DiagnosticSettings" + ], + "description": "Updates the diagnostic remote support settings on a Data Box Edge/Data Box Gateway device.", + "operationId": "DiagnosticSettings_UpdateDiagnosticRemoteSupportSettings", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "diagnosticRemoteSupportSettings", + "in": "body", + "description": "The diagnostic remote support settings.", + "required": true, + "schema": { + "$ref": "#/definitions/DiagnosticRemoteSupportSettings" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted the request to update the diagnostic remote support settings." + }, + "200": { + "description": "Successfully updated the diagnostic remote support settings." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "UpdateDiagnosticRemoteSupportSettings": { + "$ref": "./examples/UpdateDiagnosticRemoteSupportSettings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/downloadUpdates": { + "post": { + "tags": [ + "Devices" + ], + "summary": "Downloads the updates on a Data Box Edge/Data Box Gateway device.", + "operationId": "Devices_DownloadUpdates", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully downloaded the updates on the device." + }, + "202": { + "description": "Accepted the request to download the updates on the device." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DownloadUpdatesPost": { + "$ref": "./examples/DownloadUpdatesPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/generateCertificate": { + "post": { + "tags": [ + "Devices" + ], + "description": "Generates certificate for activation key.", + "operationId": "Devices_GenerateCertificate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully generated self signed certificate.", + "schema": { + "$ref": "#/definitions/GenerateCertResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GenerateCertificate": { + "$ref": "./examples/GenerateCertificate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/getExtendedInformation": { + "post": { + "tags": [ + "Devices" + ], + "description": "Gets additional information for the specified Azure Stack Edge/Data Box Gateway device.", + "operationId": "Devices_GetExtendedInformation", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The additional information.", + "schema": { + "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExtendedInfoPost": { + "$ref": "./examples/ExtendedInfoPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/installUpdates": { + "post": { + "tags": [ + "Devices" + ], + "summary": "Installs the updates on the Data Box Edge/Data Box Gateway device.", + "operationId": "Devices_InstallUpdates", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully installed updates on the device." + }, + "202": { + "description": "Accepted the request to install updates on the device." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "InstallUpdatesPost": { + "$ref": "./examples/InstallUpdatesPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/jobs/{name}": { + "get": { + "tags": [ + "Jobs" + ], + "summary": "Gets the details of a specified job on a Data Box Edge/Data Box Gateway device.", + "operationId": "Jobs_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The job name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The job details.", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "JobsGet": { + "$ref": "./examples/JobsGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/networkSettings/default": { + "get": { + "tags": [ + "Devices" + ], + "description": "Gets the network settings of the specified Data Box Edge/Data Box Gateway device.", + "operationId": "Devices_GetNetworkSettings", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The device network settings.", + "schema": { + "$ref": "#/definitions/NetworkSettings" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkSettingsGet": { + "$ref": "./examples/NetworkSettingsGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/nodes": { + "get": { + "tags": [ + "Nodes" + ], + "description": "Gets all the nodes currently configured under this Data Box Edge device", + "operationId": "Nodes_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The collection of all nodes on the device.", + "schema": { + "$ref": "#/definitions/NodeList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "NodesGetAllInDevice": { + "$ref": "./examples/NodeGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/operationsStatus/{name}": { + "get": { + "tags": [ + "OperationsStatus" + ], + "summary": "Gets the details of a specified job on a Data Box Edge/Data Box Gateway device.", + "operationId": "OperationsStatus_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The job name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The job details.", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "OperationsStatusGet": { + "$ref": "./examples/OperationsStatusGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders": { + "get": { + "tags": [ + "Orders" + ], + "summary": "Lists all the orders related to a Data Box Edge/Data Box Gateway device.", + "operationId": "Orders_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Lists all the orders for the Data Box Edge Device", + "schema": { + "$ref": "#/definitions/OrderList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "OrderGetAllInDevice": { + "$ref": "./examples/OrderGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default": { + "get": { + "tags": [ + "Orders" + ], + "summary": "Gets a specific order by name.", + "operationId": "Orders_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The order details of a device.", + "schema": { + "$ref": "#/definitions/Order" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "OrderGet": { + "$ref": "./examples/OrderGet.json" + } + } + }, + "put": { + "tags": [ + "Orders" + ], + "summary": "Creates or updates an order.", + "operationId": "Orders_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The order details of a device.", + "required": true, + "type": "string" + }, + { + "name": "order", + "in": "body", + "description": "The order to be created or updated.", + "required": true, + "schema": { + "$ref": "#/definitions/Order" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the order.", + "schema": { + "$ref": "#/definitions/Order" + } + }, + "202": { + "description": "Accepted the request to create or update the order." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "OrderPut": { + "$ref": "./examples/OrderPut.json" + } + } + }, + "delete": { + "tags": [ + "Orders" + ], + "summary": "Deletes the order related to the device.", + "operationId": "Orders_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the order." + }, + "202": { + "description": "Accepted the request to delete the order." + }, + "204": { + "description": "The order is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "OrderDelete": { + "$ref": "./examples/OrderDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default/listDCAccessCode": { + "post": { + "tags": [ + "Orders" + ], + "summary": "Gets the DCAccess Code", + "operationId": "Orders_ListDCAccessCode", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "DC Access code for the device", + "schema": { + "$ref": "#/definitions/DCAccessCode" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetDCAccessCode": { + "$ref": "./examples/GetDCAccessCode.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles": { + "get": { + "tags": [ + "Roles" + ], + "description": "Lists all the roles configured in a Data Box Edge/Data Box Gateway device.", + "operationId": "Roles_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of all the roles configured in the device.", + "schema": { + "$ref": "#/definitions/RoleList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "RoleGetAllInDevice": { + "$ref": "./examples/RoleGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{name}": { + "get": { + "tags": [ + "Roles" + ], + "description": "Gets a specific role by name.", + "operationId": "Roles_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The role name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The role with the specified name in the given device.", + "schema": { + "$ref": "#/definitions/Role" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "RoleGet": { + "$ref": "./examples/RoleGet.json" + } + } + }, + "put": { + "tags": [ + "Roles" + ], + "description": "Create or update a role.", + "operationId": "Roles_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The role name.", + "required": true, + "type": "string" + }, + { + "name": "role", + "in": "body", + "description": "The role properties.", + "required": true, + "schema": { + "$ref": "#/definitions/Role" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the role.", + "schema": { + "$ref": "#/definitions/Role" + } + }, + "202": { + "description": "Accepted the request to create or update the role." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "RolePut": { + "$ref": "./examples/RolePut.json" + } + } + }, + "delete": { + "tags": [ + "Roles" + ], + "description": "Deletes the role on the device.", + "operationId": "Roles_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The role name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the role." + }, + "202": { + "description": "Accepted the request to delete the role." + }, + "204": { + "description": "The role is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "RoleDelete": { + "$ref": "./examples/RoleDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons": { + "get": { + "tags": [ + "Addons" + ], + "description": "Lists all the addons configured in the role.", + "operationId": "Addons_ListByRole", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "roleName", + "in": "path", + "description": "The role name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of all the addons configured in the role.", + "schema": { + "$ref": "#/definitions/AddonList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "RoleListAddOns": { + "$ref": "./examples/RoleListAddOns.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons/{addonName}": { + "get": { + "tags": [ + "Addons" + ], + "description": "Gets a specific addon by name.", + "operationId": "Addons_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "roleName", + "in": "path", + "description": "The role name.", + "required": true, + "type": "string" + }, + { + "name": "addonName", + "in": "path", + "description": "The addon name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The addon with the specified name in the role.", + "schema": { + "$ref": "#/definitions/Addon" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetAddOns": { + "$ref": "./examples/GetAddons.json" + } + } + }, + "put": { + "tags": [ + "Addons" + ], + "description": "Create or update a addon.", + "operationId": "Addons_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "roleName", + "in": "path", + "description": "The role name.", + "required": true, + "type": "string" + }, + { + "name": "addonName", + "in": "path", + "description": "The addon name.", + "required": true, + "type": "string" + }, + { + "name": "addon", + "in": "body", + "description": "The addon properties.", + "required": true, + "schema": { + "$ref": "#/definitions/Addon" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the addon.", + "schema": { + "$ref": "#/definitions/Addon" + } + }, + "202": { + "description": "Accepted the request to create or update the addon." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PutAddOns": { + "$ref": "./examples/PutAddons.json" + } + } + }, + "delete": { + "tags": [ + "Addons" + ], + "description": "Deletes the addon on the device.", + "operationId": "Addons_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "roleName", + "in": "path", + "description": "The role name.", + "required": true, + "type": "string" + }, + { + "name": "addonName", + "in": "path", + "description": "The addon name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the addon." + }, + "202": { + "description": "Accepted the request to delete the addon." + }, + "204": { + "description": "The addon is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DeleteAddOns": { + "$ref": "./examples/DeleteAddons.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/monitoringConfig": { + "get": { + "tags": [ + "MonitoringConfig" + ], + "summary": "Lists metric configurations in a role.", + "operationId": "MonitoringConfig_List", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "roleName", + "in": "path", + "description": "The role name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The monitoring config details.", + "schema": { + "$ref": "#/definitions/MonitoringMetricConfigurationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListMonitoringConfig": { + "$ref": "./examples/ListMonitoringConfig.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/monitoringConfig/default": { + "get": { + "tags": [ + "MonitoringConfig" + ], + "summary": "Gets a metric configuration of a role.", + "operationId": "MonitoringConfig_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "roleName", + "in": "path", + "description": "The role name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The monitoring config details.", + "schema": { + "$ref": "#/definitions/MonitoringMetricConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetMonitoringConfig": { + "$ref": "./examples/GetMonitoringConfig.json" + } + } + }, + "put": { + "tags": [ + "MonitoringConfig" + ], + "summary": "Creates a new metric configuration or updates an existing one for a role.", + "operationId": "MonitoringConfig_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "roleName", + "in": "path", + "description": "The role name.", + "required": true, + "type": "string" + }, + { + "name": "monitoringMetricConfiguration", + "in": "body", + "description": "The metric configuration.", + "required": true, + "schema": { + "$ref": "#/definitions/MonitoringMetricConfiguration" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the metrics configuration.", + "schema": { + "$ref": "#/definitions/MonitoringMetricConfiguration" + } + }, + "202": { + "description": "Accepted the request to create or update the metrics configuration." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PutMonitoringConfig": { + "$ref": "./examples/PutMonitoringConfig.json" + } + } + }, + "delete": { + "tags": [ + "MonitoringConfig" + ], + "summary": "deletes a new metric configuration for a role.", + "operationId": "MonitoringConfig_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "roleName", + "in": "path", + "description": "The role name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the metrics configuration." + }, + "202": { + "description": "Accepted the request to delete the metrics configuration." + }, + "204": { + "description": "The metrics configuration is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DeleteMonitoringConfig": { + "$ref": "./examples/DeleteMonitoringConfig.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/scanForUpdates": { + "post": { + "tags": [ + "Devices" + ], + "summary": "Scans for updates on a Data Box Edge/Data Box Gateway device.", + "operationId": "Devices_ScanForUpdates", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully scanned the device for updates." + }, + "202": { + "description": "Accepted the request to scan for updates on the device." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ScanForUpdatesPost": { + "$ref": "./examples/ScanForUpdatesPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/securitySettings/default/update": { + "post": { + "tags": [ + "Devices" + ], + "description": "Updates the security settings on a Data Box Edge/Data Box Gateway device.", + "operationId": "Devices_CreateOrUpdateSecuritySettings", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "securitySettings", + "in": "body", + "description": "The security settings.", + "required": true, + "schema": { + "$ref": "#/definitions/SecuritySettings" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted the request to update the security settings." + }, + "204": { + "description": "Updated the security settings." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CreateOrUpdateSecuritySettings": { + "$ref": "./examples/SecuritySettingsUpdatePost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares": { + "get": { + "tags": [ + "Shares" + ], + "summary": "Lists all the shares in a Data Box Edge/Data Box Gateway device.", + "operationId": "Shares_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The collection of all the shares on the device.", + "schema": { + "$ref": "#/definitions/ShareList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ShareGetAllInDevice": { + "$ref": "./examples/ShareGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}": { + "get": { + "tags": [ + "Shares" + ], + "summary": "Gets a share by name.", + "operationId": "Shares_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The share name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The share details.", + "schema": { + "$ref": "#/definitions/Share" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ShareGet": { + "$ref": "./examples/ShareGet.json" + } + } + }, + "put": { + "tags": [ + "Shares" + ], + "summary": "Creates a new share or updates an existing share on the device.", + "operationId": "Shares_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The share name.", + "required": true, + "type": "string" + }, + { + "name": "share", + "in": "body", + "description": "The share properties.", + "required": true, + "schema": { + "$ref": "#/definitions/Share" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the share.", + "schema": { + "$ref": "#/definitions/Share" + } + }, + "202": { + "description": "Accepted the request to create or update the share." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SharePut": { + "$ref": "./examples/SharePut.json" + } + } + }, + "delete": { + "tags": [ + "Shares" + ], + "description": "Deletes the share on the Data Box Edge/Data Box Gateway device.", + "operationId": "Shares_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The share name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the share." + }, + "202": { + "description": "Accepted the request to delete the share." + }, + "204": { + "description": "The share is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ShareDelete": { + "$ref": "./examples/ShareDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}/refresh": { + "post": { + "tags": [ + "Shares" + ], + "summary": "Refreshes the share metadata with the data from the cloud.", + "operationId": "Shares_Refresh", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The share name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully refreshed the share on the device." + }, + "202": { + "description": "Accepted the request to refresh the share on the device." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ShareRefreshPost": { + "$ref": "./examples/ShareRefreshPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials": { + "get": { + "tags": [ + "StorageAccountCredentials" + ], + "summary": "Gets all the storage account credentials in a Data Box Edge/Data Box Gateway device.", + "operationId": "StorageAccountCredentials_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The collection of storage account credentials.", + "schema": { + "$ref": "#/definitions/StorageAccountCredentialList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SACGetAllInDevice": { + "$ref": "./examples/SACGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials/{name}": { + "get": { + "tags": [ + "StorageAccountCredentials" + ], + "description": "Gets the properties of the specified storage account credential.", + "operationId": "StorageAccountCredentials_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The storage account credential name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The storage account credential properties.", + "schema": { + "$ref": "#/definitions/StorageAccountCredential" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "SACGet": { + "$ref": "./examples/SACGet.json" + } + } + }, + "put": { + "tags": [ + "StorageAccountCredentials" + ], + "description": "Creates or updates the storage account credential.", + "operationId": "StorageAccountCredentials_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The storage account credential name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccountCredential", + "in": "body", + "description": "The storage account credential.", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountCredential" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the storage account credential.", + "schema": { + "$ref": "#/definitions/StorageAccountCredential" + } + }, + "202": { + "description": "Accepted the request to create or update the storage account credential." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SACPut": { + "$ref": "./examples/SACPut.json" + } + } + }, + "delete": { + "tags": [ + "StorageAccountCredentials" + ], + "description": "Deletes the storage account credential.", + "operationId": "StorageAccountCredentials_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The storage account credential name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the storage account credential." + }, + "202": { + "description": "Accepted the request to delete the storage account credential." + }, + "204": { + "description": "The storage account credential is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SACDelete": { + "$ref": "./examples/SACDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts": { + "get": { + "tags": [ + "StorageAccounts" + ], + "summary": "Lists all the StorageAccounts in a Data Box Edge/Data Box Gateway device.", + "operationId": "StorageAccounts_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The collection of all the StorageAccounts on the device.", + "schema": { + "$ref": "#/definitions/StorageAccountList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "StorageAccountGetAllInDevice": { + "$ref": "./examples/StorageAccountGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}": { + "get": { + "tags": [ + "StorageAccounts" + ], + "summary": "Gets a StorageAccount by name.", + "operationId": "StorageAccounts_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccountName", + "in": "path", + "description": "The storage account name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The storage account details.", + "schema": { + "$ref": "#/definitions/StorageAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StorageAccountGet": { + "$ref": "./examples/StorageAccountGet.json" + } + } + }, + "put": { + "tags": [ + "StorageAccounts" + ], + "summary": "Creates a new StorageAccount or updates an existing StorageAccount on the device.", + "operationId": "StorageAccounts_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccountName", + "in": "path", + "description": "The StorageAccount name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccount", + "in": "body", + "description": "The StorageAccount properties.", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccount" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the StorageAccount.", + "schema": { + "$ref": "#/definitions/StorageAccount" + } + }, + "202": { + "description": "Accepted the request to create or update the StorageAccount." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "StorageAccountPut": { + "$ref": "./examples/StorageAccountPut.json" + } + } + }, + "delete": { + "tags": [ + "StorageAccounts" + ], + "description": "Deletes the StorageAccount on the Data Box Edge/Data Box Gateway device.", + "operationId": "StorageAccounts_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccountName", + "in": "path", + "description": "The StorageAccount name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted the request to delete the StorageAccount." + }, + "204": { + "description": "The StorageAccount is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "StorageAccountDelete": { + "$ref": "./examples/StorageAccountDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers": { + "get": { + "tags": [ + "Containers" + ], + "summary": "Lists all the containers of a storage Account in a Data Box Edge/Data Box Gateway device.", + "operationId": "Containers_ListByStorageAccount", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccountName", + "in": "path", + "description": "The storage Account name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The collection of all the containers on the device.", + "schema": { + "$ref": "#/definitions/ContainerList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ContainerListAllInDevice": { + "$ref": "./examples/ContainerListAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}": { + "get": { + "tags": [ + "Containers" + ], + "summary": "Gets a container by name.", + "operationId": "Containers_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccountName", + "in": "path", + "description": "The Storage Account Name", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "The container Name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The container details.", + "schema": { + "$ref": "#/definitions/Container" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ContainerGet": { + "$ref": "./examples/ContainerGet.json" + } + } + }, + "put": { + "tags": [ + "Containers" + ], + "summary": "Creates a new container or updates an existing container on the device.", + "operationId": "Containers_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccountName", + "in": "path", + "description": "The Storage Account Name", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "The container name.", + "required": true, + "type": "string" + }, + { + "name": "container", + "in": "body", + "description": "The container properties.", + "required": true, + "schema": { + "$ref": "#/definitions/Container" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the container.", + "schema": { + "$ref": "#/definitions/Container" + } + }, + "202": { + "description": "Accepted the request to create or update the container." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ContainerPut": { + "$ref": "./examples/ContainerPut.json" + } + } + }, + "delete": { + "tags": [ + "Containers" + ], + "description": "Deletes the container on the Data Box Edge/Data Box Gateway device.", + "operationId": "Containers_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccountName", + "in": "path", + "description": "The Storage Account Name", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "The container name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted the request to delete the container." + }, + "204": { + "description": "The container is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ContainerDelete": { + "$ref": "./examples/ContainerDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}/refresh": { + "post": { + "tags": [ + "Containers" + ], + "summary": "Refreshes the container metadata with the data from the cloud.", + "operationId": "Containers_Refresh", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccountName", + "in": "path", + "description": "The Storage Account Name", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "The container name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully refreshed the container on the device." + }, + "202": { + "description": "Accepted the request to refresh the container on the device." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ContainerRefresh": { + "$ref": "./examples/ContainerRefresh.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers": { + "get": { + "tags": [ + "Triggers" + ], + "description": "Lists all the triggers configured in the device.", + "operationId": "Triggers_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Specify $filter='CustomContextTag eq ' to filter on custom context tag property", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all the triggers configured in the device", + "schema": { + "$ref": "#/definitions/TriggerList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TriggerGetAllInDevice": { + "$ref": "./examples/TriggerGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers/{name}": { + "get": { + "tags": [ + "Triggers" + ], + "description": "Get a specific trigger by name.", + "operationId": "Triggers_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The trigger name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The trigger.", + "schema": { + "$ref": "#/definitions/Trigger" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "TriggerGet": { + "$ref": "./examples/TriggerGet.json" + } + } + }, + "put": { + "tags": [ + "Triggers" + ], + "description": "Creates or updates a trigger.", + "operationId": "Triggers_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Creates or updates a trigger", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The trigger name.", + "required": true, + "type": "string" + }, + { + "name": "trigger", + "in": "body", + "description": "The trigger.", + "required": true, + "schema": { + "$ref": "#/definitions/Trigger" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the trigger.", + "schema": { + "$ref": "#/definitions/Trigger" + } + }, + "202": { + "description": "Accepted the request to create or update the trigger." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "TriggerPut": { + "$ref": "./examples/TriggerPut.json" + } + } + }, + "delete": { + "tags": [ + "Triggers" + ], + "description": "Deletes the trigger on the gateway device.", + "operationId": "Triggers_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The trigger name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the trigger." + }, + "202": { + "description": "Accepted the request to delete the trigger." + }, + "204": { + "description": "The trigger is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "TriggerDelete": { + "$ref": "./examples/TriggerDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggerSupportPackage": { + "post": { + "tags": [ + "SupportPackages" + ], + "summary": "Triggers support package on the device", + "operationId": "SupportPackages_TriggerSupportPackage", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "triggerSupportPackageRequest", + "in": "body", + "description": "The trigger support package request object", + "required": true, + "schema": { + "$ref": "#/definitions/TriggerSupportPackageRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully triggered support package on the device." + }, + "202": { + "description": "Accepted the request to trigger support package on the device." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "TriggerSupportPackage": { + "$ref": "./examples/TriggerSupportPackage.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateExtendedInformation": { + "post": { + "tags": [ + "Devices" + ], + "description": "Gets additional information for the specified Data Box Edge/Data Box Gateway device.", + "operationId": "Devices_UpdateExtendedInformation", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The patch object.", + "required": true, + "schema": { + "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfoPatch" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Modify additional information.", + "schema": { + "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetUpdateExtendedInfo": { + "$ref": "./examples/GetUpdateExtendedInfo.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateSummary/default": { + "get": { + "tags": [ + "Devices" + ], + "summary": "Gets information about the availability of updates based on the last scan of the device. It also gets information about any ongoing download or install jobs on the device.", + "operationId": "Devices_GetUpdateSummary", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The update summary.", + "schema": { + "$ref": "#/definitions/UpdateSummary" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UpdateSummaryGet": { + "$ref": "./examples/UpdateSummaryGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/uploadCertificate": { + "post": { + "tags": [ + "Devices" + ], + "description": "Uploads registration certificate for the device.", + "operationId": "Devices_UploadCertificate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The upload certificate request.", + "required": true, + "schema": { + "$ref": "#/definitions/UploadCertificateRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully uploaded the registration certificate.", + "schema": { + "$ref": "#/definitions/UploadCertificateResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UploadCertificatePost": { + "$ref": "./examples/UploadCertificatePost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users": { + "get": { + "tags": [ + "Users" + ], + "description": "Gets all the users registered on a Data Box Edge/Data Box Gateway device.", + "operationId": "Users_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Specify $filter='Type eq ' to filter on user type property", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The collection of all users on the device.", + "schema": { + "$ref": "#/definitions/UserList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "UserGetAllInDevice": { + "$ref": "./examples/UserGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}": { + "get": { + "tags": [ + "Users" + ], + "description": "Gets the properties of the specified user.", + "operationId": "Users_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The user name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The user details.", + "schema": { + "$ref": "#/definitions/User" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UserGet": { + "$ref": "./examples/UserGet.json" + } + } + }, + "put": { + "tags": [ + "Users" + ], + "description": "Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.", + "operationId": "Users_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The user name.", + "required": true, + "type": "string" + }, + { + "name": "user", + "in": "body", + "description": "The user details.", + "required": true, + "schema": { + "$ref": "#/definitions/User" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the user.", + "schema": { + "$ref": "#/definitions/User" + } + }, + "202": { + "description": "Accepted the request to create or update the user." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "UserPut": { + "$ref": "./examples/UserPut.json" + } + } + }, + "delete": { + "tags": [ + "Users" + ], + "description": "Deletes the user on a databox edge/gateway device.", + "operationId": "Users_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The user name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the user." + }, + "202": { + "description": "Accepted the request to delete the user." + }, + "204": { + "description": "The user is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "UserDelete": { + "$ref": "./examples/UserDelete.json" + } + } + } + } + }, + "definitions": { + "Addon": { + "description": "Role Addon", + "required": [ + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "kind": { + "description": "Addon type.", + "enum": [ + "IotEdge", + "ArcForKubernetes" + ], + "type": "string", + "x-ms-enum": { + "name": "AddonType", + "modelAsString": true + } + }, + "systemData": { + "description": "Addon type", + "$ref": "#/definitions/SystemData" + } + }, + "discriminator": "kind" + }, + "AddonList": { + "description": "Collection of all the Role addon on the Azure Stack Edge device.", + "type": "object", + "properties": { + "value": { + "description": "The Value.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Addon" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "Address": { + "description": "The shipping address of the customer.", + "required": [ + "country" + ], + "type": "object", + "properties": { + "addressLine1": { + "description": "The address line1.", + "type": "string" + }, + "addressLine2": { + "description": "The address line2.", + "type": "string" + }, + "addressLine3": { + "description": "The address line3.", + "type": "string" + }, + "postalCode": { + "description": "The postal code.", + "type": "string" + }, + "city": { + "description": "The city name.", + "type": "string" + }, + "state": { + "description": "The state name.", + "type": "string" + }, + "country": { + "description": "The country name.", + "type": "string" + } + } + }, + "Alert": { + "description": "Alert on the data box edge/gateway device.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "systemData": { + "description": "Alert generated in the resource", + "$ref": "#/definitions/SystemData" + }, + "properties": { + "$ref": "#/definitions/AlertProperties", + "description": "Properties of alert.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "AlertErrorDetails": { + "description": "Error details for the alert.", + "type": "object", + "properties": { + "errorCode": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "errorMessage": { + "description": "Error Message.", + "type": "string", + "readOnly": true + }, + "occurrences": { + "format": "int32", + "description": "Number of occurrences.", + "type": "integer", + "readOnly": true + } + } + }, + "AlertList": { + "description": "Collection of alerts.", + "type": "object", + "properties": { + "value": { + "description": "The value.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Alert" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "AlertProperties": { + "description": "Properties of alert.", + "type": "object", + "properties": { + "title": { + "description": "Alert title.", + "type": "string", + "readOnly": true + }, + "alertType": { + "description": "Alert type.", + "type": "string", + "readOnly": true + }, + "appearedAtDateTime": { + "format": "date-time", + "description": "UTC time when the alert appeared.", + "type": "string", + "readOnly": true + }, + "recommendation": { + "description": "Alert recommendation.", + "type": "string", + "readOnly": true + }, + "severity": { + "description": "Severity of the alert.", + "enum": [ + "Informational", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AlertSeverity", + "modelAsString": true + } + }, + "errorDetails": { + "$ref": "#/definitions/AlertErrorDetails", + "description": "Error details of the alert.", + "readOnly": true + }, + "detailedInformation": { + "description": "Alert details.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + } + }, + "ArcAddon": { + "description": "Arc Addon.", + "required": [ + "properties", + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Addon" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ArcAddonProperties", + "description": "Properties specific to Arc addon.", + "x-ms-client-flatten": true + }, + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The object name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "ArcForKubernetes" + }, + "ArcAddonProperties": { + "description": "Arc addon properties.", + "required": [ + "subscriptionId", + "resourceGroupName", + "resourceName", + "resourceLocation" + ], + "type": "object", + "properties": { + "subscriptionId": { + "description": "Arc resource subscription Id", + "type": "string" + }, + "resourceGroupName": { + "description": "Arc resource group name", + "type": "string" + }, + "resourceName": { + "description": "Arc resource Name", + "type": "string" + }, + "resourceLocation": { + "description": "Arc resource location", + "type": "string" + }, + "version": { + "description": "Arc resource version", + "type": "string", + "readOnly": true + }, + "hostPlatform": { + "description": "Host OS supported by the Arc addon.", + "enum": [ + "Windows", + "Linux" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "PlatformType", + "modelAsString": true + } + }, + "hostPlatformType": { + "description": "Platform where the runtime is hosted.", + "enum": [ + "KubernetesCluster", + "LinuxVM" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "HostPlatformType", + "modelAsString": true + } + }, + "provisioningState": { + "description": "Addon Provisioning State", + "enum": [ + "Invalid", + "Creating", + "Created", + "Updating", + "Reconfiguring", + "Failed", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AddonState", + "modelAsString": true + } + } + } + }, + "ARMBaseModel": { + "description": "Represents the base class for all object models.", + "type": "object", + "properties": { + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The object name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "AsymmetricEncryptedSecret": { + "description": "Represent the secrets intended for encryption with asymmetric key pair.", + "required": [ + "value", + "encryptionAlgorithm" + ], + "type": "object", + "properties": { + "value": { + "description": "The value of the secret.", + "type": "string" + }, + "encryptionCertThumbprint": { + "description": "Thumbprint certificate used to encrypt \\\"Value\\\". If the value is unencrypted, it will be null.", + "x-ms-secret": true, + "type": "string" + }, + "encryptionAlgorithm": { + "description": "The algorithm used to encrypt \"Value\".", + "enum": [ + "None", + "AES256", + "RSAES_PKCS1_v_1_5" + ], + "type": "string", + "x-ms-enum": { + "name": "EncryptionAlgorithm", + "modelAsString": true + } + } + } + }, + "Authentication": { + "description": "Authentication mechanism for IoT devices.", + "type": "object", + "properties": { + "symmetricKey": { + "$ref": "#/definitions/SymmetricKey", + "description": "Symmetric key for authentication." + } + } + }, + "AzureContainerInfo": { + "description": "Azure container mapping of the endpoint.", + "required": [ + "storageAccountCredentialId", + "containerName", + "dataFormat" + ], + "type": "object", + "properties": { + "storageAccountCredentialId": { + "description": "ID of the storage account credential used to access storage.", + "type": "string" + }, + "containerName": { + "description": "Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob).", + "type": "string" + }, + "dataFormat": { + "description": "Storage format used for the file represented by the share.", + "enum": [ + "BlockBlob", + "PageBlob", + "AzureFile" + ], + "type": "string", + "x-ms-enum": { + "name": "AzureContainerDataFormat", + "modelAsString": true + } + } + } + }, + "BandwidthSchedule": { + "description": "The bandwidth schedule details.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "systemData": { + "description": "Bandwidth object related to ASE resource", + "$ref": "#/definitions/SystemData" + }, + "properties": { + "$ref": "#/definitions/BandwidthScheduleProperties", + "description": "The properties of the bandwidth schedule.", + "x-ms-client-flatten": true + } + } + }, + "BandwidthScheduleProperties": { + "description": "The properties of the bandwidth schedule.", + "required": [ + "start", + "stop", + "rateInMbps", + "days" + ], + "type": "object", + "properties": { + "start": { + "description": "The start time of the schedule in UTC.", + "type": "string" + }, + "stop": { + "description": "The stop time of the schedule in UTC.", + "type": "string" + }, + "rateInMbps": { + "format": "int32", + "description": "The bandwidth rate in Mbps.", + "type": "integer" + }, + "days": { + "description": "The days of the week when this schedule is applicable.", + "uniqueItems": false, + "type": "array", + "items": { + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "type": "string", + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": true + } + } + } + } + }, + "BandwidthSchedulesList": { + "description": "The collection of bandwidth schedules.", + "type": "object", + "properties": { + "value": { + "description": "The list of bandwidth schedules.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/BandwidthSchedule" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "ClientAccessRight": { + "description": "The mapping between a particular client IP and the type of access client has on the NFS share.", + "required": [ + "client", + "accessPermission" + ], + "type": "object", + "properties": { + "client": { + "description": "IP of the client.", + "type": "string" + }, + "accessPermission": { + "description": "Type of access to be allowed for the client.", + "enum": [ + "NoAccess", + "ReadOnly", + "ReadWrite" + ], + "type": "string", + "x-ms-enum": { + "name": "ClientPermissionType", + "modelAsString": true + } + } + } + }, + "CloudEdgeManagementRole": { + "description": "CloudEdgeManagementRole role, Currently It's in Private Preview", + "required": [ + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Role" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/CloudEdgeManagementRoleProperties", + "description": "Properties specific to CloudEdgeManagementRole role.", + "x-ms-client-flatten": true + }, + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The object name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "CloudEdgeManagement" + }, + "CloudEdgeManagementRoleProperties": { + "description": "CloudEdgeManagement Role properties.", + "required": [ + "roleStatus" + ], + "type": "object", + "properties": { + "localManagementStatus": { + "description": "Local Edge Management Status", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RoleStatus", + "modelAsString": true + } + }, + "edgeProfile": { + "$ref": "#/definitions/EdgeProfile", + "description": "Edge Profile of the resource", + "readOnly": true + }, + "roleStatus": { + "description": "Role status.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "RoleStatus", + "modelAsString": true + } + } + } + }, + "CloudError": { + "description": "An error response from the service.", + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "The error details." + } + }, + "x-ms-external": true + }, + "CloudErrorBody": { + "description": "An error response from the service.", + "type": "object", + "properties": { + "code": { + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically.", + "type": "string" + }, + "message": { + "description": "A message describing the error, intended to be suitable for display in a user interface.", + "type": "string" + }, + "details": { + "description": "A list of additional details about the error.", + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + } + } + }, + "x-ms-external": true + }, + "CniConfig": { + "description": "Cni configuration", + "type": "object", + "properties": { + "type": { + "description": "Cni type", + "type": "string", + "readOnly": true + }, + "version": { + "description": "Cni version", + "type": "string", + "readOnly": true + }, + "podSubnet": { + "description": "Pod Subnet", + "type": "string", + "readOnly": true + }, + "serviceSubnet": { + "description": "Service subnet", + "type": "string", + "readOnly": true + } + } + }, + "ComputeResource": { + "description": "Compute infrastructure Resource", + "required": [ + "processorCount", + "memoryInGB" + ], + "type": "object", + "properties": { + "processorCount": { + "format": "int32", + "description": "Processor count", + "type": "integer" + }, + "memoryInGB": { + "format": "int64", + "description": "Memory in GB", + "type": "integer" + } + } + }, + "ContactDetails": { + "description": "Contains all the contact details of the customer.", + "required": [ + "contactPerson", + "companyName", + "phone", + "emailList" + ], + "type": "object", + "properties": { + "contactPerson": { + "description": "The contact person name.", + "type": "string" + }, + "companyName": { + "description": "The name of the company.", + "type": "string" + }, + "phone": { + "description": "The phone number.", + "type": "string" + }, + "emailList": { + "description": "The email list.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Container": { + "description": "Represents a container on the Data Box Edge/Gateway device.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "systemData": { + "description": "Container in DataBoxEdge Resource", + "$ref": "#/definitions/SystemData" + }, + "properties": { + "$ref": "#/definitions/ContainerProperties", + "description": "The container properties.", + "x-ms-client-flatten": true + } + } + }, + "ContainerList": { + "description": "Collection of all the containers on the Data Box Edge/Gateway device.", + "type": "object", + "properties": { + "value": { + "description": "The list of containers.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Container" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "ContainerProperties": { + "description": "The container properties.", + "required": [ + "dataFormat" + ], + "type": "object", + "properties": { + "containerStatus": { + "description": "Current status of the container.", + "enum": [ + "OK", + "Offline", + "Unknown", + "Updating", + "NeedsAttention" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ContainerStatus", + "modelAsString": true + } + }, + "dataFormat": { + "description": "DataFormat for Container", + "enum": [ + "BlockBlob", + "PageBlob", + "AzureFile" + ], + "type": "string", + "x-ms-enum": { + "name": "AzureContainerDataFormat", + "modelAsString": true + } + }, + "refreshDetails": { + "$ref": "#/definitions/RefreshDetails", + "description": "Details of the refresh job on this container.", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "The UTC time when container got created.", + "type": "string", + "readOnly": true + } + } + }, + "DataBoxEdgeDevice": { + "description": "The Data Box Edge/Gateway device.", + "required": [ + "location" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "location": { + "description": "The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "description": "The list of tags that describe the device. These tags can be used to view and group this device (across resource groups).", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU type." + }, + "etag": { + "description": "The etag for the devices.", + "type": "string" + }, + "identity": { + "$ref": "#/definitions/ResourceIdentity", + "description": "Msi identity of the resource" + }, + "kind": { + "description": "The kind of the device.", + "enum": [ + "AzureDataBoxGateway", + "AzureStackEdge", + "AzureStackHub", + "AzureModularDataCentre" + ], + "type": "string", + "x-ms-enum": { + "name": "DataBoxEdgeDeviceKind", + "modelAsString": true + } + }, + "systemData": { + "description": "DataBoxEdge Resource", + "$ref": "#/definitions/SystemData" + }, + "properties": { + "$ref": "#/definitions/DataBoxEdgeDeviceProperties", + "description": "The properties of the Data Box Edge/Gateway device.", + "x-ms-client-flatten": true + } + } + }, + "DataBoxEdgeDeviceExtendedInfo": { + "description": "The extended Info of the Data Box Edge/Gateway device.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfoProperties", + "description": "The extended info properties.", + "x-ms-client-flatten": true + } + } + }, + "DataBoxEdgeDeviceExtendedInfoPatch": { + "description": "The Data Box Edge/Gateway device extended info patch.", + "type": "object", + "properties": { + "clientSecretStoreId": { + "description": "The Key Vault ARM Id for client secrets", + "type": "string" + }, + "clientSecretStoreUrl": { + "description": "The url to access the Client Key Vault", + "type": "string" + }, + "channelIntegrityKeyName": { + "description": "The name for Channel Integrity Key stored in the Client Key Vault", + "type": "string" + }, + "channelIntegrityKeyVersion": { + "description": "The version of Channel Integrity Key stored in the Client Key Vault", + "type": "string" + }, + "syncStatus": { + "description": "For changing or to initiate the resync to key-vault set the status to KeyVaultSyncPending, rest of the status will not be applicable.", + "enum": [ + "KeyVaultSynced", + "KeyVaultSyncFailed", + "KeyVaultNotConfigured", + "KeyVaultSyncPending", + "KeyVaultSyncing", + "KeyVaultNotSynced" + ], + "type": "string", + "x-ms-enum": { + "name": "KeyVaultSyncStatus", + "modelAsString": true + } + } + } + }, + "DataBoxEdgeDeviceExtendedInfoProperties": { + "description": "The properties of the Data Box Edge/Gateway device extended info.", + "type": "object", + "properties": { + "encryptionKeyThumbprint": { + "description": "The digital signature of encrypted certificate.", + "type": "string" + }, + "encryptionKey": { + "description": "The public part of the encryption certificate. Client uses this to encrypt any secret.", + "type": "string" + }, + "resourceKey": { + "description": "The Resource ID of the Resource.", + "type": "string", + "readOnly": true + }, + "clientSecretStoreId": { + "description": "The Key Vault ARM Id for client secrets", + "type": "string" + }, + "clientSecretStoreUrl": { + "description": "The url to access the Client Key Vault", + "type": "string" + }, + "channelIntegrityKeyName": { + "description": "The name of Channel Integrity Key stored in the Client Key Vault", + "type": "string" + }, + "channelIntegrityKeyVersion": { + "description": "The version of Channel Integrity Key stored in the Client Key Vault", + "type": "string" + }, + "keyVaultSyncStatus": { + "description": "Key vault sync status", + "enum": [ + "KeyVaultSynced", + "KeyVaultSyncFailed", + "KeyVaultNotConfigured", + "KeyVaultSyncPending", + "KeyVaultSyncing", + "KeyVaultNotSynced" + ], + "type": "string", + "x-ms-enum": { + "name": "KeyVaultSyncStatus", + "modelAsString": true + } + }, + "deviceSecrets": { + "description": "Device secrets, will be returned only with ODataFilter $expand=deviceSecrets", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/Secret" + }, + "readOnly": true + } + } + }, + "DataBoxEdgeDeviceList": { + "description": "The collection of Data Box Edge/Gateway devices.", + "type": "object", + "properties": { + "value": { + "description": "The list of Data Box Edge/Gateway devices.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/DataBoxEdgeDevice" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "DataBoxEdgeDevicePatch": { + "description": "The Data Box Edge/Gateway device patch.", + "type": "object", + "properties": { + "tags": { + "description": "The tags attached to the Data Box Edge/Gateway resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "identity": { + "$ref": "#/definitions/ResourceIdentity", + "description": "Msi identity of the resource" + }, + "properties": { + "$ref": "#/definitions/DataBoxEdgeDevicePropertiesPatch", + "description": "The properties associated with the Data Box Edge/Gateway resource", + "x-ms-client-flatten": true + } + } + }, + "DataBoxEdgeDeviceProperties": { + "description": "The properties of the Data Box Edge/Gateway device.", + "type": "object", + "properties": { + "systemData": { + "description": "DataBoxEdge Device Properties", + "$ref": "#/definitions/SystemData" + }, + "dataBoxEdgeDeviceStatus": { + "description": "The status of the Data Box Edge/Gateway device.", + "enum": [ + "ReadyToSetup", + "Online", + "Offline", + "NeedsAttention", + "Disconnected", + "PartiallyDisconnected", + "Maintenance" + ], + "type": "string", + "x-ms-enum": { + "name": "DataBoxEdgeDeviceStatus", + "modelAsString": true + } + }, + "serialNumber": { + "description": "The Serial Number of Data Box Edge/Gateway device.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The Description of the Data Box Edge/Gateway device.", + "type": "string", + "readOnly": true + }, + "modelDescription": { + "description": "The description of the Data Box Edge/Gateway device model.", + "type": "string", + "readOnly": true + }, + "deviceType": { + "description": "The type of the Data Box Edge/Gateway device.", + "enum": [ + "DataBoxEdgeDevice" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DeviceType", + "modelAsString": true + } + }, + "friendlyName": { + "description": "The Data Box Edge/Gateway device name.", + "type": "string", + "readOnly": true + }, + "culture": { + "description": "The Data Box Edge/Gateway device culture.", + "type": "string", + "readOnly": true + }, + "deviceModel": { + "description": "The Data Box Edge/Gateway device model.", + "type": "string", + "readOnly": true + }, + "deviceSoftwareVersion": { + "description": "The Data Box Edge/Gateway device software version.", + "type": "string", + "readOnly": true + }, + "deviceLocalCapacity": { + "format": "int64", + "description": "The Data Box Edge/Gateway device local capacity in MB.", + "type": "integer", + "readOnly": true + }, + "timeZone": { + "description": "The Data Box Edge/Gateway device timezone.", + "type": "string", + "readOnly": true + }, + "deviceHcsVersion": { + "description": "The device software version number of the device (eg: 1.2.18105.6).", + "type": "string", + "readOnly": true + }, + "configuredRoleTypes": { + "description": "Type of compute roles configured.", + "uniqueItems": false, + "type": "array", + "items": { + "enum": [ + "IOT", + "ASA", + "Functions", + "Cognitive", + "MEC", + "CloudEdgeManagement", + "Kubernetes" + ], + "type": "string", + "x-ms-enum": { + "name": "RoleTypes", + "modelAsString": true + } + }, + "readOnly": true + }, + "nodeCount": { + "format": "int32", + "description": "The number of nodes in the cluster.", + "type": "integer", + "readOnly": true + }, + "resourceMoveDetails": { + "$ref": "#/definitions/ResourceMoveDetails", + "description": "The details of the move operation on this resource.", + "readOnly": true + }, + "edgeProfile": { + "$ref": "#/definitions/EdgeProfile", + "description": "The details of Edge Profile for this resource", + "readOnly": true + }, + "dataResidency": { + "$ref": "#/definitions/DataResidency", + "description": "The details of data-residency related properties for this resource" + } + } + }, + "DataBoxEdgeDevicePropertiesPatch": { + "description": "The Data Box Edge/Gateway device properties patch.", + "type": "object", + "properties": { + "edgeProfile": { + "$ref": "#/definitions/EdgeProfilePatch", + "description": "Edge Profile property of the Data Box Edge/Gateway device" + } + } + }, + "DataBoxEdgeMoveRequest": { + "description": "Resource Move details", + "required": [ + "targetResourceGroup", + "resources" + ], + "type": "object", + "properties": { + "targetResourceGroup": { + "description": "Target resource group ARMId", + "type": "string" + }, + "resources": { + "description": "List of resources to be moved", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DataBoxEdgeSku": { + "description": "The Sku information.", + "type": "object", + "properties": { + "resourceType": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The Sku name.", + "enum": [ + "Gateway", + "Edge", + "TEA_1Node", + "TEA_1Node_UPS", + "TEA_1Node_Heater", + "TEA_1Node_UPS_Heater", + "TEA_4Node_Heater", + "TEA_4Node_UPS_Heater", + "TMA", + "TDC", + "TCA_Small", + "GPU", + "TCA_Large", + "EdgeP_Base", + "EdgeP_High", + "EdgePR_Base", + "EdgePR_Base_UPS", + "EP2_64_1VPU_W", + "EP2_128_1T4_Mx1_W", + "EP2_256_2T4_W", + "EdgeMR_Mini", + "RCA_Small", + "RCA_Large", + "RDC", + "Management" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "kind": { + "description": "The Sku kind.", + "type": "string", + "readOnly": true + }, + "tier": { + "description": "The Sku tier.", + "enum": [ + "Standard" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + }, + "size": { + "description": "The Sku kind.", + "type": "string", + "readOnly": true + }, + "family": { + "description": "The Sku family.", + "type": "string", + "readOnly": true + }, + "locations": { + "description": "Availability of the Sku for the region.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "apiVersions": { + "description": "The API versions in which Sku is available.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "locationInfo": { + "description": "Availability of the Sku for the location/zone/site.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SkuLocationInfo" + }, + "readOnly": true + }, + "costs": { + "description": "The pricing info of the Sku.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SkuCost" + }, + "readOnly": true + }, + "signupOption": { + "description": "Sku can be signed up by customer or not.", + "enum": [ + "None", + "Available" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SkuSignupOption", + "modelAsString": true + } + }, + "version": { + "description": "Availability of the Sku as preview/stable.", + "enum": [ + "Stable", + "Preview" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SkuVersion", + "modelAsString": true + } + }, + "availability": { + "description": "Links to the next set of results", + "enum": [ + "Available", + "Unavailable" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SkuAvailability", + "modelAsString": true + } + }, + "shipmentTypes": { + "description": "List of Shipment Types supported by this SKU", + "uniqueItems": false, + "type": "array", + "items": { + "enum": [ + "NotApplicable", + "ShippedToCustomer", + "SelfPickup" + ], + "type": "string", + "x-ms-enum": { + "name": "ShipmentType", + "modelAsString": true + } + }, + "readOnly": true + }, + "capabilities": { + "description": "The capability info of the SKU.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SkuCapability" + }, + "readOnly": true + } + } + }, + "DataBoxEdgeSkuList": { + "description": "List of SKU Information objects.", + "type": "object", + "properties": { + "value": { + "description": "List of ResourceType Sku", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/DataBoxEdgeSku" + }, + "readOnly": true + }, + "nextLink": { + "description": "Links to the next set of results", + "type": "string", + "readOnly": true + } + } + }, + "DataResidency": { + "description": "Wraps data-residency related information for edge-resource and this should be used with ARM layer.", + "type": "object", + "properties": { + "type": { + "description": "DataResidencyType enum", + "enum": [ + "GeoZoneReplication", + "ZoneReplication" + ], + "type": "string", + "x-ms-enum": { + "name": "DataResidencyType", + "modelAsString": true + } + } + } + }, + "DCAccessCode": { + "description": "DC Access code in the case of Self Managed Shipping.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/DCAccessCodeProperties", + "description": "DCAccessCode properties.", + "x-ms-client-flatten": true + } + } + }, + "DCAccessCodeProperties": { + "description": "DCAccessCode Properties.", + "type": "object", + "properties": { + "authCode": { + "description": "DCAccess Code for the Self Managed shipment.", + "type": "string" + } + } + }, + "DiagnosticProactiveLogCollectionSettings": { + "description": "The diagnostic proactive log collection settings of a device.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "systemData": { + "description": "DiagnosticProactiveLogCollectionSettings", + "$ref": "#/definitions/SystemData" + }, + "properties": { + "$ref": "#/definitions/ProactiveLogCollectionSettingsProperties", + "description": "Properties of the diagnostic proactive log collection settings.", + "x-ms-client-flatten": true + } + } + }, + "DiagnosticRemoteSupportSettings": { + "description": "The remote support settings of a device.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "systemData": { + "description": "DiagnosticRemoteSupportSettings", + "$ref": "#/definitions/SystemData" + }, + "properties": { + "$ref": "#/definitions/DiagnosticRemoteSupportSettingsProperties", + "description": "Properties of the remote support settings.", + "x-ms-client-flatten": true + } + } + }, + "DiagnosticRemoteSupportSettingsProperties": { + "description": "The properties of remote support settings.", + "type": "object", + "properties": { + "remoteSupportSettingsList": { + "description": "Remote support settings list according to the RemoteApplicationType", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/RemoteSupportSettings" + } + } + } + }, + "EdgeProfile": { + "description": "Details about Edge Profile for the resource", + "type": "object", + "properties": { + "subscription": { + "$ref": "#/definitions/EdgeProfileSubscription", + "description": "Edge Profile Subscription" + } + } + }, + "EdgeProfilePatch": { + "description": "The Data Box Edge/Gateway Edge Profile patch.", + "type": "object", + "properties": { + "subscription": { + "$ref": "#/definitions/EdgeProfileSubscriptionPatch", + "description": "The Data Box Edge/Gateway Edge Profile Subscription patch" + } + } + }, + "EdgeProfileSubscription": { + "description": "Subscription details for the Edge Profile", + "type": "object", + "properties": { + "registrationId": { + "description": "Edge Subscription Registration ID", + "type": "string" + }, + "id": { + "description": "ARM ID of the subscription", + "type": "string" + }, + "state": { + "enum": [ + "Registered", + "Warned", + "Suspended", + "Deleted", + "Unregistered" + ], + "type": "string", + "x-ms-enum": { + "name": "SubscriptionState", + "modelAsString": true + } + }, + "registrationDate": { + "type": "string" + }, + "subscriptionId": { + "type": "string" + }, + "properties": { + "$ref": "#/definitions/SubscriptionProperties", + "x-ms-client-flatten": true + } + } + }, + "EdgeProfileSubscriptionPatch": { + "description": "The Data Box Edge/Gateway Edge Profile Subscription patch.", + "type": "object", + "properties": { + "id": { + "description": "The path ID that uniquely identifies the subscription of the edge profile.", + "type": "string" + } + } + }, + "EtcdInfo": { + "description": "Etcd configuration", + "type": "object", + "properties": { + "type": { + "description": "Etcd type", + "type": "string", + "readOnly": true + }, + "version": { + "description": "Etcd version", + "type": "string", + "readOnly": true + } + } + }, + "FileEventTrigger": { + "description": "Trigger details.", + "required": [ + "properties", + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Trigger" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/FileTriggerProperties", + "description": "File trigger properties.", + "x-ms-client-flatten": true + }, + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The object name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "FileEvent" + }, + "FileSourceInfo": { + "description": "File source details.", + "required": [ + "shareId" + ], + "type": "object", + "properties": { + "shareId": { + "description": "File share ID.", + "type": "string" + } + } + }, + "FileTriggerProperties": { + "description": "File trigger properties.", + "required": [ + "sourceInfo", + "sinkInfo" + ], + "type": "object", + "properties": { + "sourceInfo": { + "$ref": "#/definitions/FileSourceInfo", + "description": "File event source details." + }, + "sinkInfo": { + "$ref": "#/definitions/RoleSinkInfo", + "description": "Role sink info." + }, + "customContextTag": { + "description": "A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module.", + "maxLength": 192, + "type": "string" + } + } + }, + "GenerateCertResponse": { + "description": "Used in activation key generation flow.", + "type": "object", + "properties": { + "publicKey": { + "description": "Gets or sets base64 encoded certificate raw data,\r\nthis is the public part needed to be uploaded to cert vault", + "type": "string" + }, + "privateKey": { + "description": "Gets or sets base64 encoded private part of the certificate,\r\nneeded to form the activation key", + "x-ms-secret": true, + "type": "string" + }, + "expiryTimeInUTC": { + "description": "Gets or sets expiry time in UTC", + "type": "string" + } + } + }, + "ImageRepositoryCredential": { + "description": "Image repository credential.", + "required": [ + "imageRepositoryUrl", + "userName" + ], + "type": "object", + "properties": { + "imageRepositoryUrl": { + "description": "Image repository url (e.g.: mcr.microsoft.com).", + "type": "string" + }, + "userName": { + "description": "Repository user name.", + "type": "string" + }, + "password": { + "$ref": "#/definitions/AsymmetricEncryptedSecret", + "description": "Repository user password." + } + } + }, + "IoTAddon": { + "description": "IoT Addon.", + "required": [ + "properties", + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Addon" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/IoTAddonProperties", + "description": "Properties specific to IOT addon.", + "x-ms-client-flatten": true + }, + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The object name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "IotEdge" + }, + "IoTAddonProperties": { + "description": "IoT addon properties.", + "required": [ + "ioTDeviceDetails", + "ioTEdgeDeviceDetails" + ], + "type": "object", + "properties": { + "ioTDeviceDetails": { + "$ref": "#/definitions/IoTDeviceInfo", + "description": "IoT device metadata to which appliance needs to be connected." + }, + "ioTEdgeDeviceDetails": { + "$ref": "#/definitions/IoTDeviceInfo", + "description": "IoT edge device to which the IoT Addon needs to be configured." + }, + "version": { + "description": "Version of IoT running on the appliance.", + "type": "string", + "readOnly": true + }, + "hostPlatform": { + "description": "Host OS supported by the IoT addon.", + "enum": [ + "Windows", + "Linux" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "PlatformType", + "modelAsString": true + } + }, + "hostPlatformType": { + "description": "Platform where the runtime is hosted.", + "enum": [ + "KubernetesCluster", + "LinuxVM" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "HostPlatformType", + "modelAsString": true + } + }, + "provisioningState": { + "description": "Addon Provisioning State", + "enum": [ + "Invalid", + "Creating", + "Created", + "Updating", + "Reconfiguring", + "Failed", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AddonState", + "modelAsString": true + } + } + } + }, + "IoTDeviceInfo": { + "description": "Metadata of IoT device/IoT Edge device to be configured.", + "required": [ + "deviceId", + "ioTHostHub" + ], + "type": "object", + "properties": { + "deviceId": { + "description": "ID of the IoT device/edge device.", + "type": "string" + }, + "ioTHostHub": { + "description": "Host name for the IoT hub associated to the device.", + "type": "string" + }, + "ioTHostHubId": { + "description": "Id for the IoT hub associated to the device.", + "type": "string" + }, + "authentication": { + "$ref": "#/definitions/Authentication", + "description": "Encrypted IoT device/IoT edge device connection string." + } + } + }, + "IoTEdgeAgentInfo": { + "description": "IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified.", + "required": [ + "imageName", + "tag" + ], + "type": "object", + "properties": { + "imageName": { + "description": "Name of the IoT edge agent image.", + "type": "string" + }, + "tag": { + "description": "Image Tag.", + "type": "string" + }, + "imageRepository": { + "$ref": "#/definitions/ImageRepositoryCredential", + "description": "Image repository details." + } + } + }, + "IoTRole": { + "description": "Compute role.", + "required": [ + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Role" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/IoTRoleProperties", + "description": "Properties specific to IoT role.", + "x-ms-client-flatten": true + }, + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The object name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "IOT" + }, + "IoTRoleProperties": { + "description": "IoT role properties.", + "required": [ + "hostPlatform", + "ioTDeviceDetails", + "ioTEdgeDeviceDetails", + "roleStatus" + ], + "type": "object", + "properties": { + "hostPlatform": { + "description": "Host OS supported by the IoT role.", + "enum": [ + "Windows", + "Linux" + ], + "type": "string", + "x-ms-enum": { + "name": "PlatformType", + "modelAsString": true + } + }, + "ioTDeviceDetails": { + "$ref": "#/definitions/IoTDeviceInfo", + "description": "IoT device metadata to which data box edge device needs to be connected." + }, + "ioTEdgeDeviceDetails": { + "$ref": "#/definitions/IoTDeviceInfo", + "description": "IoT edge device to which the IoT role needs to be configured." + }, + "shareMappings": { + "description": "Mount points of shares in role(s).", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MountPointMap" + } + }, + "ioTEdgeAgentInfo": { + "$ref": "#/definitions/IoTEdgeAgentInfo", + "description": "Iot edge agent details to download the agent and bootstrap iot runtime." + }, + "hostPlatformType": { + "description": "Platform where the Iot runtime is hosted.", + "enum": [ + "KubernetesCluster", + "LinuxVM" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "HostPlatformType", + "modelAsString": true + } + }, + "computeResource": { + "$ref": "#/definitions/ComputeResource", + "description": "Resource allocation" + }, + "roleStatus": { + "description": "Role status.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "RoleStatus", + "modelAsString": true + } + } + } + }, + "Ipv4Config": { + "description": "Details related to the IPv4 address configuration.", + "type": "object", + "properties": { + "ipAddress": { + "description": "The IPv4 address of the network adapter.", + "type": "string", + "readOnly": true + }, + "subnet": { + "description": "The IPv4 subnet of the network adapter.", + "type": "string", + "readOnly": true + }, + "gateway": { + "description": "The IPv4 gateway of the network adapter.", + "type": "string", + "readOnly": true + } + } + }, + "Ipv6Config": { + "description": "Details related to the IPv6 address configuration.", + "type": "object", + "properties": { + "ipAddress": { + "description": "The IPv6 address of the network adapter.", + "type": "string", + "readOnly": true + }, + "prefixLength": { + "format": "int32", + "description": "The IPv6 prefix of the network adapter.", + "type": "integer", + "readOnly": true + }, + "gateway": { + "description": "The IPv6 gateway of the network adapter.", + "type": "string", + "readOnly": true + } + } + }, + "Job": { + "description": "A device job.", + "type": "object", + "properties": { + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the object.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The current status of the job.", + "enum": [ + "Invalid", + "Running", + "Succeeded", + "Failed", + "Canceled", + "Paused", + "Scheduled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true + } + }, + "startTime": { + "format": "date-time", + "description": "The UTC date and time at which the job started.", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "The UTC date and time at which the job completed.", + "type": "string", + "readOnly": true + }, + "percentComplete": { + "format": "int32", + "description": "The percentage of the job that is complete.", + "type": "integer", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/JobErrorDetails", + "description": "The error details.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "The properties of the job.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "JobErrorDetails": { + "description": "The job error information containing the list of job errors.", + "type": "object", + "properties": { + "errorDetails": { + "description": "The error details.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/JobErrorItem" + }, + "readOnly": true + }, + "code": { + "description": "The code intended for programmatic access.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The message that describes the error in detail.", + "type": "string", + "readOnly": true + } + } + }, + "JobErrorItem": { + "description": "The job error items.", + "type": "object", + "properties": { + "recommendations": { + "description": "The recommended actions.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "code": { + "description": "The code intended for programmatic access.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The message that describes the error in detail.", + "type": "string", + "readOnly": true + } + } + }, + "JobProperties": { + "description": "The properties for the job.", + "type": "object", + "properties": { + "jobType": { + "description": "The type of the job.", + "enum": [ + "Invalid", + "ScanForUpdates", + "DownloadUpdates", + "InstallUpdates", + "RefreshShare", + "RefreshContainer", + "Backup", + "Restore", + "TriggerSupportPackage" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobType", + "modelAsString": true + } + }, + "currentStage": { + "description": "Current stage of the update operation.", + "enum": [ + "Unknown", + "Initial", + "ScanStarted", + "ScanComplete", + "ScanFailed", + "DownloadStarted", + "DownloadComplete", + "DownloadFailed", + "InstallStarted", + "InstallComplete", + "InstallFailed", + "RebootInitiated", + "Success", + "Failure", + "RescanStarted", + "RescanComplete", + "RescanFailed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "UpdateOperationStage", + "modelAsString": true + } + }, + "downloadProgress": { + "$ref": "#/definitions/UpdateDownloadProgress", + "description": "The download progress.", + "readOnly": true + }, + "installProgress": { + "$ref": "#/definitions/UpdateInstallProgress", + "description": "The install progress.", + "readOnly": true + }, + "totalRefreshErrors": { + "format": "int32", + "description": "Total number of errors encountered during the refresh process.", + "type": "integer", + "readOnly": true + }, + "errorManifestFile": { + "description": "Local share/remote container relative path to the error manifest file of the refresh.", + "type": "string", + "readOnly": true + }, + "refreshedEntityId": { + "description": "ARM ID of the entity that was refreshed.", + "type": "string", + "readOnly": true + }, + "folder": { + "description": "If only subfolders need to be refreshed, then the subfolder path inside the share or container. (The path is empty if there are no subfolders.)", + "type": "string" + } + } + }, + "KubernetesClusterInfo": { + "description": "Kubernetes cluster configuration", + "required": [ + "version" + ], + "type": "object", + "properties": { + "etcdInfo": { + "$ref": "#/definitions/EtcdInfo", + "description": "Etcd configuration", + "readOnly": true + }, + "nodes": { + "description": "Kubernetes cluster nodes", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/NodeInfo" + }, + "readOnly": true + }, + "version": { + "description": "Kubernetes cluster version", + "type": "string" + } + } + }, + "KubernetesIPConfiguration": { + "description": "Kubernetes node IP configuration", + "type": "object", + "properties": { + "port": { + "description": "Port of the Kubernetes node.", + "type": "string", + "readOnly": true + }, + "ipAddress": { + "description": "IP address of the Kubernetes node.", + "type": "string" + } + } + }, + "KubernetesRole": { + "description": "Kubernetes role, Currently it's in Private Preview", + "required": [ + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Role" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/KubernetesRoleProperties", + "description": "Properties specific to Kubernetes role.", + "x-ms-client-flatten": true + }, + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The object name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "Kubernetes" + }, + "KubernetesRoleCompute": { + "description": "Kubernetes role compute resource", + "required": [ + "vmProfile" + ], + "type": "object", + "properties": { + "vmProfile": { + "description": "VM profile", + "type": "string" + }, + "memoryInBytes": { + "format": "int64", + "description": "Memory in bytes", + "type": "integer", + "readOnly": true + }, + "processorCount": { + "format": "int32", + "description": "Processor count", + "type": "integer", + "readOnly": true + } + } + }, + "KubernetesRoleNetwork": { + "description": "Kubernetes role network resource", + "type": "object", + "properties": { + "cniConfig": { + "$ref": "#/definitions/CniConfig", + "description": "Cni configuration", + "readOnly": true + }, + "loadBalancerConfig": { + "$ref": "#/definitions/LoadBalancerConfig", + "description": "Load balancer configuration", + "readOnly": true + } + } + }, + "KubernetesRoleProperties": { + "description": "Kubernetes role properties.", + "required": [ + "hostPlatform", + "kubernetesClusterInfo", + "kubernetesRoleResources", + "roleStatus" + ], + "type": "object", + "properties": { + "hostPlatform": { + "description": "Host OS supported by the Kubernetes role.", + "enum": [ + "Windows", + "Linux" + ], + "type": "string", + "x-ms-enum": { + "name": "PlatformType", + "modelAsString": true + } + }, + "provisioningState": { + "description": "State of Kubernetes deployment", + "enum": [ + "Invalid", + "Creating", + "Created", + "Updating", + "Reconfiguring", + "Failed", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "KubernetesState", + "modelAsString": true + } + }, + "hostPlatformType": { + "description": "Platform where the runtime is hosted.", + "enum": [ + "KubernetesCluster", + "LinuxVM" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "HostPlatformType", + "modelAsString": true + } + }, + "kubernetesClusterInfo": { + "$ref": "#/definitions/KubernetesClusterInfo", + "description": "Kubernetes cluster configuration" + }, + "kubernetesRoleResources": { + "$ref": "#/definitions/KubernetesRoleResources", + "description": "Kubernetes role resources" + }, + "roleStatus": { + "description": "Role status.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "RoleStatus", + "modelAsString": true + } + } + } + }, + "KubernetesRoleResources": { + "description": "Kubernetes role resources", + "required": [ + "compute" + ], + "type": "object", + "properties": { + "storage": { + "$ref": "#/definitions/KubernetesRoleStorage", + "description": "Kubernetes role storage resource" + }, + "compute": { + "$ref": "#/definitions/KubernetesRoleCompute", + "description": "Kubernetes role compute resource" + }, + "network": { + "$ref": "#/definitions/KubernetesRoleNetwork", + "description": "Kubernetes role network resource", + "readOnly": true + } + } + }, + "KubernetesRoleStorage": { + "description": "Kubernetes role storage resource", + "type": "object", + "properties": { + "storageClasses": { + "description": "Kubernetes storage class info.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesRoleStorageClassInfo" + }, + "readOnly": true + }, + "endpoints": { + "description": "Mount points of shares in role(s).", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MountPointMap" + } + } + } + }, + "KubernetesRoleStorageClassInfo": { + "description": "Kubernetes storage class info.", + "type": "object", + "properties": { + "name": { + "description": "Storage class name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Storage class type.", + "type": "string", + "readOnly": true + }, + "posixCompliant": { + "description": "If provisioned storage is posix compliant.", + "enum": [ + "Invalid", + "Enabled", + "Disabled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "PosixComplianceStatus", + "modelAsString": true + } + } + } + }, + "LoadBalancerConfig": { + "description": "Load balancer configuration", + "type": "object", + "properties": { + "type": { + "description": "Load balancer type", + "type": "string", + "readOnly": true + }, + "version": { + "description": "Load balancer version", + "type": "string", + "readOnly": true + } + } + }, + "MECRole": { + "description": "MEC role.", + "required": [ + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Role" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MECRoleProperties", + "description": "Properties specific to MEC role.", + "x-ms-client-flatten": true + }, + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The object name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "MEC" + }, + "MECRoleProperties": { + "description": "MEC role properties.", + "required": [ + "roleStatus" + ], + "type": "object", + "properties": { + "connectionString": { + "$ref": "#/definitions/AsymmetricEncryptedSecret", + "description": "Activation key of the MEC." + }, + "controllerEndpoint": { + "description": "Controller Endpoint.", + "type": "string" + }, + "resourceUniqueId": { + "description": "Unique Id of the Resource.", + "type": "string" + }, + "roleStatus": { + "description": "Role status.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "RoleStatus", + "modelAsString": true + } + } + } + }, + "MetricConfiguration": { + "description": "Metric configuration.", + "required": [ + "resourceId", + "counterSets" + ], + "type": "object", + "properties": { + "resourceId": { + "description": "The Resource ID on which the metrics should be pushed.", + "type": "string" + }, + "mdmAccount": { + "description": "The MDM account to which the counters should be pushed.", + "type": "string" + }, + "metricNameSpace": { + "description": "The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified", + "type": "string" + }, + "counterSets": { + "description": "Host name for the IoT hub associated to the device.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MetricCounterSet" + } + } + } + }, + "MetricCounter": { + "description": "The metric counter", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The counter name.", + "type": "string" + }, + "instance": { + "description": "The instance from which counter should be collected.", + "type": "string" + }, + "dimensionFilter": { + "description": "The dimension filter.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MetricDimension" + } + }, + "additionalDimensions": { + "description": "The additional dimensions to be added to metric.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MetricDimension" + } + } + } + }, + "MetricCounterSet": { + "description": "The metric counter set", + "required": [ + "counters" + ], + "type": "object", + "properties": { + "counters": { + "description": "The counters that should be collected in this set.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MetricCounter" + } + } + } + }, + "MetricDimension": { + "description": "The metric dimension", + "required": [ + "sourceType", + "sourceName" + ], + "type": "object", + "properties": { + "sourceType": { + "description": "The dimension type.", + "type": "string" + }, + "sourceName": { + "description": "The dimension value.", + "type": "string" + } + } + }, + "MetricDimension_V1": { + "description": "Metric Dimension v1.", + "type": "object", + "properties": { + "name": { + "description": "Name of the metrics dimension.", + "type": "string" + }, + "displayName": { + "description": "Display name of the metrics dimension.", + "type": "string" + }, + "toBeExportedForShoebox": { + "description": "To be exported to shoe box.", + "type": "boolean" + } + } + }, + "MetricSpecification_V1": { + "description": "Metric specification version 1.", + "type": "object", + "properties": { + "name": { + "description": "Name of the metric.", + "type": "string" + }, + "displayName": { + "description": "Display name of the metric.", + "type": "string" + }, + "displayDescription": { + "description": "Description of the metric to be displayed.", + "type": "string" + }, + "unit": { + "description": "Metric units.", + "enum": [ + "NotSpecified", + "Percent", + "Count", + "Seconds", + "Milliseconds", + "Bytes", + "BytesPerSecond", + "CountPerSecond" + ], + "type": "string", + "x-ms-enum": { + "name": "MetricUnit", + "modelAsString": true + } + }, + "aggregationType": { + "description": "Metric aggregation type.", + "enum": [ + "NotSpecified", + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "type": "string", + "x-ms-enum": { + "name": "MetricAggregationType", + "modelAsString": true + } + }, + "dimensions": { + "description": "Metric dimensions, other than default dimension which is resource.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MetricDimension_V1" + } + }, + "fillGapWithZero": { + "description": "Set true to fill the gaps with zero.", + "type": "boolean" + }, + "category": { + "description": "Metric category.", + "enum": [ + "Capacity", + "Transaction" + ], + "type": "string", + "x-ms-enum": { + "name": "MetricCategory", + "modelAsString": true + } + }, + "resourceIdDimensionNameOverride": { + "description": "Resource name override.", + "type": "string" + }, + "supportedTimeGrainTypes": { + "description": "Support granularity of metrics.", + "uniqueItems": false, + "type": "array", + "items": { + "enum": [ + "PT1M", + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "PT1D" + ], + "type": "string", + "x-ms-enum": { + "name": "TimeGrain", + "modelAsString": true + } + } + }, + "supportedAggregationTypes": { + "description": "Support metric aggregation type.", + "uniqueItems": false, + "type": "array", + "items": { + "enum": [ + "NotSpecified", + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "type": "string", + "x-ms-enum": { + "name": "MetricAggregationType", + "modelAsString": true + } + } + } + } + }, + "MonitoringMetricConfiguration": { + "description": "The metric setting details for the role", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "systemData": { + "description": "MonitoringConfiguration on ASE device", + "$ref": "#/definitions/SystemData" + }, + "properties": { + "$ref": "#/definitions/MonitoringMetricConfigurationProperties", + "description": "The metric setting properties.", + "x-ms-client-flatten": true + } + } + }, + "MonitoringMetricConfigurationList": { + "description": "Collection of metric configurations.", + "type": "object", + "properties": { + "value": { + "description": "The list of metric configurations.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MonitoringMetricConfiguration" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "MonitoringMetricConfigurationProperties": { + "description": "Metrics properties", + "required": [ + "metricConfigurations" + ], + "type": "object", + "properties": { + "metricConfigurations": { + "description": "The metrics configuration details", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MetricConfiguration" + } + } + } + }, + "MountPointMap": { + "description": "The share mount point.", + "required": [ + "shareId" + ], + "type": "object", + "properties": { + "shareId": { + "description": "ID of the share mounted to the role VM.", + "type": "string" + }, + "roleId": { + "description": "ID of the role to which share is mounted.", + "type": "string", + "readOnly": true + }, + "mountPoint": { + "description": "Mount point for the share.", + "type": "string", + "readOnly": true + }, + "mountType": { + "description": "Mounting type.", + "enum": [ + "Volume", + "HostPath" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MountType", + "modelAsString": true + } + }, + "roleType": { + "description": "Role type.", + "enum": [ + "IOT", + "ASA", + "Functions", + "Cognitive", + "MEC", + "CloudEdgeManagement", + "Kubernetes" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RoleTypes", + "modelAsString": true + } + } + } + }, + "NetworkAdapter": { + "description": "Represents the networkAdapter on a device.", + "type": "object", + "properties": { + "adapterId": { + "description": "Instance ID of network adapter.", + "type": "string", + "readOnly": true + }, + "adapterPosition": { + "$ref": "#/definitions/NetworkAdapterPosition", + "description": "Hardware position of network adapter.", + "readOnly": true + }, + "index": { + "format": "int32", + "description": "Logical index of the adapter.", + "type": "integer", + "readOnly": true + }, + "nodeId": { + "description": "Node ID of the network adapter.", + "type": "string", + "readOnly": true + }, + "networkAdapterName": { + "description": "Network adapter name.", + "type": "string", + "readOnly": true + }, + "label": { + "description": "Hardware label for the adapter.", + "type": "string", + "readOnly": true + }, + "macAddress": { + "description": "MAC address.", + "type": "string", + "readOnly": true + }, + "linkSpeed": { + "format": "int64", + "description": "Link speed.", + "type": "integer", + "readOnly": true + }, + "status": { + "description": "Value indicating whether this adapter is valid.", + "enum": [ + "Inactive", + "Active" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "NetworkAdapterStatus", + "modelAsString": true + } + }, + "rdmaStatus": { + "description": "Value indicating whether this adapter is RDMA capable.", + "enum": [ + "Incapable", + "Capable" + ], + "type": "string", + "x-ms-enum": { + "name": "NetworkAdapterRDMAStatus", + "modelAsString": true + } + }, + "dhcpStatus": { + "description": "Value indicating whether this adapter has DHCP enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "NetworkAdapterDHCPStatus", + "modelAsString": true + } + }, + "ipv4Configuration": { + "$ref": "#/definitions/Ipv4Config", + "description": "The IPv4 configuration of the network adapter.", + "readOnly": true + }, + "ipv6Configuration": { + "$ref": "#/definitions/Ipv6Config", + "description": "The IPv6 configuration of the network adapter.", + "readOnly": true + }, + "ipv6LinkLocalAddress": { + "description": "The IPv6 local address.", + "type": "string", + "readOnly": true + }, + "dnsServers": { + "description": "The list of DNS Servers of the device.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "NetworkAdapterPosition": { + "description": "The network adapter position.", + "type": "object", + "properties": { + "networkGroup": { + "description": "The network group.", + "enum": [ + "None", + "NonRDMA", + "RDMA" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "NetworkGroup", + "modelAsString": true + } + }, + "port": { + "format": "int32", + "description": "The port.", + "type": "integer", + "readOnly": true + } + } + }, + "NetworkSettings": { + "description": "The network settings of a device.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "systemData": { + "description": "NetworkSettings on ASE device", + "$ref": "#/definitions/SystemData" + }, + "properties": { + "$ref": "#/definitions/NetworkSettingsProperties", + "description": "The properties of network settings of a device.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "NetworkSettingsProperties": { + "description": "The properties of network settings.", + "type": "object", + "properties": { + "networkAdapters": { + "description": "The network adapter list on the device.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/NetworkAdapter" + }, + "readOnly": true + } + } + }, + "Node": { + "description": "Represents a single node in a Data box Edge/Gateway device\r\nGateway devices, standalone Edge devices and a single node cluster Edge device will all have 1 node\r\nMulti-node Edge devices will have more than 1 nodes", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/NodeProperties", + "description": "The properties of the node", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "NodeInfo": { + "description": "Kubernetes node info", + "type": "object", + "properties": { + "name": { + "description": "Node name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Node type - Master/Worker", + "enum": [ + "Invalid", + "Master", + "Worker" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "KubernetesNodeType", + "modelAsString": true + } + }, + "ipConfiguration": { + "description": "IP Configuration of the Kubernetes node.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesIPConfiguration" + } + } + } + }, + "NodeList": { + "description": "Collection of Nodes.", + "type": "object", + "properties": { + "value": { + "description": "The list of Nodes.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Node" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "NodeProperties": { + "description": "This class represents the nodes in a highly available cluster", + "type": "object", + "properties": { + "nodeStatus": { + "description": "The current status of the individual node", + "enum": [ + "Unknown", + "Up", + "Down", + "Rebooting", + "ShuttingDown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "NodeStatus", + "modelAsString": true + } + }, + "nodeChassisSerialNumber": { + "description": "Serial number of the Chassis", + "type": "string", + "readOnly": true + }, + "nodeSerialNumber": { + "description": "Serial number of the individual node", + "type": "string", + "readOnly": true + }, + "nodeDisplayName": { + "description": "Display Name of the individual node", + "type": "string", + "readOnly": true + }, + "nodeFriendlySoftwareVersion": { + "description": "Friendly software version name that is currently installed on the node", + "type": "string", + "readOnly": true + }, + "nodeHcsVersion": { + "description": "HCS version that is currently installed on the node", + "type": "string", + "readOnly": true + }, + "nodeInstanceId": { + "description": "Guid instance id of the node", + "type": "string", + "readOnly": true + } + } + }, + "Operation": { + "description": "Operations.", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation.", + "type": "string" + }, + "isDataAction": { + "description": "Is data action.", + "type": "boolean" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "Properties displayed for the operation." + }, + "origin": { + "description": "Origin of the operation.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Operation properties.", + "x-ms-client-flatten": true + } + } + }, + "OperationDisplay": { + "description": "Operation display properties.", + "type": "object", + "properties": { + "provider": { + "description": "Provider name.", + "type": "string" + }, + "resource": { + "description": "The type of resource in which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Operation to be performed on the resource.", + "type": "string" + }, + "description": { + "description": "Description of the operation to be performed.", + "type": "string" + } + } + }, + "OperationProperties": { + "description": "Operation properties.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "Service specification." + } + } + }, + "OperationsList": { + "description": "The list of operations used for the discovery of available provider operations.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "The value.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string" + } + } + }, + "Order": { + "description": "The order details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "systemData": { + "description": "Order configured on ASE resource", + "$ref": "#/definitions/SystemData" + }, + "properties": { + "$ref": "#/definitions/OrderProperties", + "description": "The order properties.", + "x-ms-client-flatten": true + } + } + }, + "OrderList": { + "description": "List of order entities.", + "type": "object", + "properties": { + "value": { + "description": "The list of orders.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Order" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "OrderProperties": { + "description": "Order properties.", + "required": [ + "contactInformation" + ], + "type": "object", + "properties": { + "contactInformation": { + "$ref": "#/definitions/ContactDetails", + "description": "The contact details." + }, + "shippingAddress": { + "$ref": "#/definitions/Address", + "description": "The shipping address." + }, + "currentStatus": { + "$ref": "#/definitions/OrderStatus", + "description": "Current status of the order.", + "readOnly": true + }, + "orderHistory": { + "description": "List of status changes in the order.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/OrderStatus" + }, + "readOnly": true + }, + "serialNumber": { + "description": "Serial number of the device.", + "type": "string", + "readOnly": true + }, + "deliveryTrackingInfo": { + "description": "Tracking information for the package delivered to the customer whether it has an original or a replacement device.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/TrackingInfo" + }, + "readOnly": true + }, + "returnTrackingInfo": { + "description": "Tracking information for the package returned from the customer whether it has an original or a replacement device.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/TrackingInfo" + }, + "readOnly": true + }, + "shipmentType": { + "description": "ShipmentType of the order", + "enum": [ + "NotApplicable", + "ShippedToCustomer", + "SelfPickup" + ], + "type": "string", + "x-ms-enum": { + "name": "ShipmentType", + "modelAsString": true + } + } + } + }, + "OrderStatus": { + "description": "Represents a single status change.", + "required": [ + "status" + ], + "type": "object", + "properties": { + "status": { + "description": "Status of the order as per the allowed status types.", + "enum": [ + "Untracked", + "AwaitingFulfillment", + "AwaitingPreparation", + "AwaitingShipment", + "Shipped", + "Arriving", + "Delivered", + "ReplacementRequested", + "LostDevice", + "Declined", + "ReturnInitiated", + "AwaitingReturnShipment", + "ShippedBack", + "CollectedAtMicrosoft", + "AwaitingPickup", + "PickupCompleted", + "AwaitingDrop" + ], + "type": "string", + "x-ms-enum": { + "name": "OrderState", + "modelAsString": true + } + }, + "updateDateTime": { + "format": "date-time", + "description": "Time of status update.", + "type": "string", + "readOnly": true + }, + "comments": { + "description": "Comments related to this status change.", + "type": "string" + }, + "trackingInformation": { + "$ref": "#/definitions/TrackingInfo", + "description": "Tracking information related to the state in the ordering flow", + "readOnly": true + }, + "additionalOrderDetails": { + "description": "Dictionary to hold generic information which is not stored\r\nby the already existing properties", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + } + }, + "PeriodicTimerEventTrigger": { + "description": "Trigger details.", + "required": [ + "properties", + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Trigger" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PeriodicTimerProperties", + "description": "Periodic timer trigger properties.", + "x-ms-client-flatten": true + }, + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The object name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "PeriodicTimerEvent" + }, + "PeriodicTimerProperties": { + "description": "Periodic timer trigger properties.", + "required": [ + "sourceInfo", + "sinkInfo" + ], + "type": "object", + "properties": { + "sourceInfo": { + "$ref": "#/definitions/PeriodicTimerSourceInfo", + "description": "Periodic timer details." + }, + "sinkInfo": { + "$ref": "#/definitions/RoleSinkInfo", + "description": "Role Sink information." + }, + "customContextTag": { + "description": "A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module.", + "maxLength": 192, + "type": "string" + } + } + }, + "PeriodicTimerSourceInfo": { + "description": "Periodic timer event source.", + "required": [ + "startTime", + "schedule" + ], + "type": "object", + "properties": { + "startTime": { + "format": "date-time", + "description": "The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time.", + "type": "string" + }, + "schedule": { + "description": "Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds.", + "type": "string" + }, + "topic": { + "description": "Topic where periodic events are published to IoT device.", + "type": "string" + } + } + }, + "ProactiveLogCollectionSettingsProperties": { + "description": "The properties of proactive log collection settings.", + "required": [ + "userConsent" + ], + "type": "object", + "properties": { + "userConsent": { + "description": "Proactive diagnostic collection consent flag", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "ProactiveDiagnosticsConsent", + "modelAsString": true + } + } + } + }, + "RawCertificateData": { + "description": "Raw Certificate Data.", + "required": [ + "certificate" + ], + "type": "object", + "properties": { + "authenticationType": { + "description": "The authentication type.", + "enum": [ + "Invalid", + "AzureActiveDirectory" + ], + "type": "string", + "x-ms-enum": { + "name": "AuthenticationType", + "modelAsString": true + } + }, + "certificate": { + "description": "The base64 encoded certificate raw data.", + "type": "string" + } + } + }, + "RefreshDetails": { + "description": "Fields for tracking refresh job on the share or container.", + "type": "object", + "properties": { + "inProgressRefreshJobId": { + "description": "If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress.", + "type": "string" + }, + "lastCompletedRefreshJobTimeInUTC": { + "format": "date-time", + "description": "Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job.", + "type": "string" + }, + "errorManifestFile": { + "description": "Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job.", + "type": "string" + }, + "lastJob": { + "description": "Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job.", + "type": "string" + } + } + }, + "RemoteSupportSettings": { + "description": "RemoteApplicationType for which remote support settings is being modified", + "type": "object", + "properties": { + "remoteApplicationType": { + "description": "Remote application type", + "enum": [ + "Powershell", + "WAC", + "LocalUI", + "AllApplications" + ], + "type": "string", + "x-ms-enum": { + "name": "RemoteApplicationType", + "modelAsString": true + } + }, + "accessLevel": { + "description": "Access level allowed for this remote application type", + "enum": [ + "None", + "ReadOnly", + "ReadWrite", + "FullAccess" + ], + "type": "string", + "x-ms-enum": { + "name": "AccessLevel", + "modelAsString": true + } + }, + "expirationTimeStampInUTC": { + "format": "date-time", + "description": "Expiration time stamp", + "type": "string" + } + } + }, + "ResourceIdentity": { + "description": "Msi identity details of the resource", + "type": "object", + "properties": { + "type": { + "description": "Identity type", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "MsiIdentityType", + "modelAsString": true + } + }, + "principalId": { + "description": "Service Principal Id backing the Msi", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "Home Tenant Id", + "type": "string", + "readOnly": true + } + } + }, + "ResourceMoveDetails": { + "description": "Fields for tracking resource move", + "type": "object", + "properties": { + "operationInProgress": { + "description": "Denotes whether move operation is in progress", + "enum": [ + "None", + "ResourceMoveInProgress", + "ResourceMoveFailed" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceMoveStatus", + "modelAsString": true + } + }, + "operationInProgressLockTimeoutInUTC": { + "format": "date-time", + "description": "Denotes the timeout of the operation to finish", + "type": "string" + } + } + }, + "ResourceTypeSku": { + "description": "Resource type Sku object", + "type": "object", + "properties": { + "resourceType": { + "description": "The resource type.", + "type": "string", + "readOnly": true + }, + "skus": { + "description": "The skus.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SkuInformation" + }, + "readOnly": true + } + } + }, + "Role": { + "description": "Compute role.", + "required": [ + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "kind": { + "description": "Role type.", + "enum": [ + "IOT", + "ASA", + "Functions", + "Cognitive", + "MEC", + "CloudEdgeManagement", + "Kubernetes" + ], + "type": "string", + "x-ms-enum": { + "name": "RoleTypes", + "modelAsString": true + } + }, + "systemData": { + "description": "Role configured on ASE resource", + "$ref": "#/definitions/SystemData" + } + }, + "discriminator": "kind" + }, + "RoleList": { + "description": "Collection of all the roles on the Data Box Edge device.", + "type": "object", + "properties": { + "value": { + "description": "The Value.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Role" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "RoleSinkInfo": { + "description": "Compute role against which events will be raised.", + "required": [ + "roleId" + ], + "type": "object", + "properties": { + "roleId": { + "description": "Compute role ID.", + "type": "string" + } + } + }, + "Secret": { + "description": "Holds device secret either as a KeyVault reference or as an encrypted value.", + "type": "object", + "properties": { + "encryptedSecret": { + "$ref": "#/definitions/AsymmetricEncryptedSecret", + "description": "Encrypted (using device public key) secret value." + }, + "keyVaultId": { + "description": "Id of the Key-Vault where secret is stored (ex: secrets/AuthClientSecret/82ef4346187a4033a10d629cde07d740).", + "type": "string" + } + } + }, + "SecuritySettings": { + "description": "The security settings of a device.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SecuritySettingsProperties", + "description": "Properties of the security settings.", + "x-ms-client-flatten": true + } + } + }, + "SecuritySettingsProperties": { + "description": "The properties of security settings.", + "required": [ + "deviceAdminPassword" + ], + "type": "object", + "properties": { + "deviceAdminPassword": { + "$ref": "#/definitions/AsymmetricEncryptedSecret", + "description": "Device administrator password as an encrypted string (encrypted using RSA PKCS #1) is used to sign into the local web UI of the device. The Actual password should have at least 8 characters that are a combination of uppercase, lowercase, numeric, and special characters." + } + } + }, + "ServiceSpecification": { + "description": "Service specification.", + "type": "object", + "properties": { + "metricSpecifications": { + "description": "Metric specification as defined by shoebox.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification_V1" + } + } + } + }, + "Share": { + "description": "Represents a share on the Data Box Edge/Gateway device.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "systemData": { + "description": "Share on ASE device", + "$ref": "#/definitions/SystemData" + }, + "properties": { + "$ref": "#/definitions/ShareProperties", + "description": "The share properties.", + "x-ms-client-flatten": true + } + } + }, + "ShareAccessRight": { + "description": "Specifies the mapping between this particular user and the type of access he has on shares on this device.", + "required": [ + "shareId", + "accessType" + ], + "type": "object", + "properties": { + "shareId": { + "description": "The share ID.", + "type": "string" + }, + "accessType": { + "description": "Type of access to be allowed on the share for this user.", + "enum": [ + "Change", + "Read", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "ShareAccessType", + "modelAsString": true + } + } + } + }, + "ShareList": { + "description": "Collection of all the shares on the Data Box Edge/Gateway device.", + "type": "object", + "properties": { + "value": { + "description": "The list of shares.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Share" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "ShareProperties": { + "description": "The share properties.", + "required": [ + "shareStatus", + "monitoringStatus", + "accessProtocol" + ], + "type": "object", + "properties": { + "description": { + "description": "Description for the share.", + "type": "string" + }, + "shareStatus": { + "description": "Current status of the share.", + "enum": [ + "Offline", + "Unknown", + "OK", + "Updating", + "NeedsAttention" + ], + "type": "string", + "x-ms-enum": { + "name": "ShareStatus", + "modelAsString": true + } + }, + "monitoringStatus": { + "description": "Current monitoring status of the share.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "MonitoringStatus", + "modelAsString": true + } + }, + "azureContainerInfo": { + "$ref": "#/definitions/AzureContainerInfo", + "description": "Azure container mapping for the share." + }, + "accessProtocol": { + "description": "Access protocol to be used by the share.", + "enum": [ + "SMB", + "NFS" + ], + "type": "string", + "x-ms-enum": { + "name": "ShareAccessProtocol", + "modelAsString": true + } + }, + "userAccessRights": { + "description": "Mapping of users and corresponding access rights on the share (required for SMB protocol).", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/UserAccessRight" + } + }, + "clientAccessRights": { + "description": "List of IP addresses and corresponding access rights on the share(required for NFS protocol).", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ClientAccessRight" + } + }, + "refreshDetails": { + "$ref": "#/definitions/RefreshDetails", + "description": "Details of the refresh job on this share." + }, + "shareMappings": { + "description": "Share mount point to the role.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/MountPointMap" + }, + "readOnly": true + }, + "dataPolicy": { + "description": "Data policy of the share.", + "enum": [ + "Cloud", + "Local" + ], + "type": "string", + "x-ms-enum": { + "name": "DataPolicy", + "modelAsString": true + } + } + } + }, + "Sku": { + "description": "The SKU type.", + "type": "object", + "properties": { + "name": { + "description": "SKU name.", + "enum": [ + "Gateway", + "Edge", + "TEA_1Node", + "TEA_1Node_UPS", + "TEA_1Node_Heater", + "TEA_1Node_UPS_Heater", + "TEA_4Node_Heater", + "TEA_4Node_UPS_Heater", + "TMA", + "TDC", + "TCA_Small", + "GPU", + "TCA_Large", + "EdgeP_Base", + "EdgeP_High", + "EdgePR_Base", + "EdgePR_Base_UPS", + "EP2_64_1VPU_W", + "EP2_128_1T4_Mx1_W", + "EP2_256_2T4_W", + "EdgeMR_Mini", + "RCA_Small", + "RCA_Large", + "RDC", + "Management" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "tier": { + "description": "The SKU tier. This is based on the SKU name.", + "enum": [ + "Standard" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + } + } + }, + "SkuCapability": { + "description": "The metadata to describe the capability.", + "type": "object", + "properties": { + "name": { + "description": "An invariant to describe the feature.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "An invariant if the feature is measured by quantity.", + "type": "string", + "readOnly": true + } + } + }, + "SkuCost": { + "description": "The metadata for retrieving price info.", + "type": "object", + "properties": { + "meterId": { + "description": "Used for querying price from commerce.", + "type": "string", + "readOnly": true + }, + "quantity": { + "format": "int64", + "description": "The cost quantity.", + "type": "integer", + "readOnly": true + }, + "extendedUnit": { + "description": "The extended unit.", + "type": "string", + "readOnly": true + } + } + }, + "SkuInformation": { + "description": "Sku information", + "type": "object", + "properties": { + "name": { + "description": "The sku name.", + "type": "string", + "readOnly": true + }, + "tier": { + "description": "The sku tier.", + "type": "string", + "readOnly": true + }, + "kind": { + "description": "The sku kind.", + "type": "string", + "readOnly": true + }, + "family": { + "description": "The Sku family.", + "type": "string", + "readOnly": true + }, + "costs": { + "description": "The pricing info of the Sku.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SkuCost" + }, + "readOnly": true + }, + "locations": { + "description": "The locations where Sku is available.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "locationInfo": { + "description": "The locations where Sku is available with zones and sites info", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SkuLocationInfo" + }, + "readOnly": true + }, + "requiredQuotaIds": { + "description": "The required quotaIds for the sku to be available.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredFeatures": { + "description": "The required features for the sku to be available.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "SkuInformationList": { + "description": "List of SKU Information objects", + "type": "object", + "properties": { + "value": { + "description": "List of ResourceTypeSku objects", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ResourceTypeSku" + }, + "readOnly": true + }, + "nextLink": { + "description": "Links to the next set of results", + "type": "string", + "readOnly": true + } + } + }, + "SkuLocationInfo": { + "description": "The location info.", + "type": "object", + "properties": { + "location": { + "description": "The location.", + "type": "string", + "readOnly": true + }, + "zones": { + "description": "The zones.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "sites": { + "description": "The sites.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "StorageAccount": { + "description": "Represents a Storage Account on the Data Box Edge/Gateway device.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "systemData": { + "description": "StorageAccount object on ASE device", + "$ref": "#/definitions/SystemData" + }, + "properties": { + "$ref": "#/definitions/StorageAccountProperties", + "description": "The Storage Account properties.", + "x-ms-client-flatten": true + } + } + }, + "StorageAccountCredential": { + "description": "The storage account credential.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "systemData": { + "description": "StorageAccountCredential object", + "$ref": "#/definitions/SystemData" + }, + "properties": { + "$ref": "#/definitions/StorageAccountCredentialProperties", + "description": "The storage account credential properties.", + "x-ms-client-flatten": true + } + } + }, + "StorageAccountCredentialList": { + "description": "The collection of storage account credentials.", + "type": "object", + "properties": { + "value": { + "description": "The value.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccountCredential" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "StorageAccountCredentialProperties": { + "description": "The storage account credential properties.", + "required": [ + "alias", + "sslStatus", + "accountType" + ], + "type": "object", + "properties": { + "alias": { + "description": "Alias for the storage account.", + "type": "string" + }, + "userName": { + "description": "Username for the storage account.", + "type": "string" + }, + "accountKey": { + "$ref": "#/definitions/AsymmetricEncryptedSecret", + "description": "Encrypted storage key." + }, + "connectionString": { + "description": "Connection string for the storage account. Use this string if username and account key are not specified.", + "type": "string" + }, + "sslStatus": { + "description": "Signifies whether SSL needs to be enabled or not.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "SSLStatus", + "modelAsString": true + } + }, + "blobDomainName": { + "description": "Blob end point for private clouds.", + "type": "string" + }, + "accountType": { + "description": "Type of storage accessed on the storage account.", + "enum": [ + "GeneralPurposeStorage", + "BlobStorage" + ], + "type": "string", + "x-ms-enum": { + "name": "AccountType", + "modelAsString": true + } + }, + "storageAccountId": { + "description": "Id of the storage account.", + "type": "string" + } + } + }, + "StorageAccountList": { + "description": "Collection of all the Storage Accounts on the Data Box Edge/Gateway device.", + "type": "object", + "properties": { + "value": { + "description": "The list of storageAccounts.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccount" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "StorageAccountProperties": { + "description": "The storage account properties.", + "required": [ + "dataPolicy" + ], + "type": "object", + "properties": { + "description": { + "description": "Description for the storage Account.", + "type": "string" + }, + "storageAccountStatus": { + "description": "Current status of the storage account", + "enum": [ + "OK", + "Offline", + "Unknown", + "Updating", + "NeedsAttention" + ], + "type": "string", + "x-ms-enum": { + "name": "StorageAccountStatus", + "modelAsString": true + } + }, + "dataPolicy": { + "description": "Data policy of the storage Account.", + "enum": [ + "Cloud", + "Local" + ], + "type": "string", + "x-ms-enum": { + "name": "DataPolicy", + "modelAsString": true + } + }, + "storageAccountCredentialId": { + "description": "Storage Account Credential Id", + "type": "string" + }, + "blobEndpoint": { + "description": "BlobEndpoint of Storage Account", + "type": "string", + "readOnly": true + }, + "containerCount": { + "format": "int32", + "description": "The Container Count. Present only for Storage Accounts with DataPolicy set to Cloud.", + "type": "integer", + "readOnly": true + } + } + }, + "SubscriptionProperties": { + "type": "object", + "properties": { + "tenantId": { + "type": "string" + }, + "locationPlacementId": { + "type": "string" + }, + "quotaId": { + "type": "string" + }, + "serializedDetails": { + "type": "string" + }, + "registeredFeatures": { + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SubscriptionRegisteredFeatures" + } + } + } + }, + "SubscriptionRegisteredFeatures": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "state": { + "type": "string" + } + } + }, + "SupportPackageRequestProperties": { + "description": "The share properties.", + "type": "object", + "properties": { + "minimumTimeStamp": { + "format": "date-time", + "description": "MinimumTimeStamp from where logs need to be collected", + "type": "string" + }, + "maximumTimeStamp": { + "format": "date-time", + "description": "MaximumTimeStamp until where logs need to be collected", + "type": "string" + }, + "include": { + "description": "Type of files, which need to be included in the logs\r\nThis will contain the type of logs (Default/DefaultWithDumps/None/All/DefaultWithArchived)\r\nor a comma separated list of log types that are required", + "type": "string" + } + } + }, + "SymmetricKey": { + "description": "Symmetric key for authentication.", + "type": "object", + "properties": { + "connectionString": { + "$ref": "#/definitions/AsymmetricEncryptedSecret", + "description": "Connection string based on the symmetric key." + } + } + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "type": "string", + "description": "The type of identity that created the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)." + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "type": "string", + "description": "The type of identity that last modified the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The type of identity that last modified the resource." + } + } + }, + "TrackingInfo": { + "description": "Tracking courier information.", + "type": "object", + "properties": { + "serialNumber": { + "description": "Serial number of the device being tracked.", + "type": "string" + }, + "carrierName": { + "description": "Name of the carrier used in the delivery.", + "type": "string" + }, + "trackingId": { + "description": "Tracking ID of the shipment.", + "type": "string" + }, + "trackingUrl": { + "description": "Tracking URL of the shipment.", + "type": "string" + } + } + }, + "Trigger": { + "description": "Trigger details.", + "required": [ + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "systemData": { + "description": "Trigger in DataBoxEdge Resource", + "$ref": "#/definitions/SystemData" + }, + "kind": { + "description": "Trigger Kind.", + "enum": [ + "FileEvent", + "PeriodicTimerEvent" + ], + "type": "string", + "x-ms-enum": { + "name": "TriggerEventType", + "modelAsString": true + } + } + }, + "discriminator": "kind" + }, + "TriggerList": { + "description": "Collection of all trigger on the data box edge device.", + "type": "object", + "properties": { + "value": { + "description": "The list of triggers.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Trigger" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "TriggerSupportPackageRequest": { + "description": "The request object for trigger support package.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SupportPackageRequestProperties", + "description": "The TriggerSupportPackageRequest properties.", + "x-ms-client-flatten": true + } + } + }, + "UpdateDetails": { + "description": "Update Specific attributes", + "type": "object", + "properties": { + "updateTitle": { + "description": "Title of the Update", + "type": "string" + }, + "updateSize": { + "format": "double", + "description": "Size of the update(In Bytes)", + "type": "number" + }, + "updateType": { + "description": "Type of the Update", + "enum": [ + "Software", + "Kubernetes", + "Firmware" + ], + "type": "string", + "x-ms-enum": { + "name": "UpdateType", + "modelAsString": true + } + }, + "targetVersion": { + "description": "Target Version number", + "type": "string" + }, + "friendlyVersionNumber": { + "description": "Friendly Version Number", + "type": "string" + }, + "estimatedInstallTimeInMins": { + "format": "int32", + "description": "Estimated Install Time for the update", + "type": "integer" + }, + "rebootBehavior": { + "description": "Indicates if updates are available and at least one of the updates needs a reboot.", + "enum": [ + "NeverReboots", + "RequiresReboot", + "RequestReboot" + ], + "type": "string", + "x-ms-enum": { + "name": "InstallRebootBehavior", + "modelAsString": true + } + }, + "installationImpact": { + "description": "Impact of Installing an updateType", + "enum": [ + "None", + "DeviceRebooted", + "KubernetesWorkloadsDown" + ], + "type": "string", + "x-ms-enum": { + "name": "InstallationImpact", + "modelAsString": true + } + }, + "status": { + "description": "Status of the update.", + "enum": [ + "DownloadPending", + "DownloadStarted", + "DownloadCompleted", + "InstallStarted", + "InstallCompleted" + ], + "type": "string", + "x-ms-enum": { + "name": "UpdateStatus", + "modelAsString": true + } + } + } + }, + "UpdateDownloadProgress": { + "description": "Details about the download progress of update.", + "type": "object", + "properties": { + "downloadPhase": { + "description": "The download phase.", + "enum": [ + "Unknown", + "Initializing", + "Downloading", + "Verifying" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DownloadPhase", + "modelAsString": true + } + }, + "percentComplete": { + "format": "int32", + "description": "Percentage of completion.", + "type": "integer", + "readOnly": true + }, + "totalBytesToDownload": { + "format": "double", + "description": "Total bytes to download.", + "type": "number", + "readOnly": true + }, + "totalBytesDownloaded": { + "format": "double", + "description": "Total bytes downloaded.", + "type": "number", + "readOnly": true + }, + "numberOfUpdatesToDownload": { + "format": "int32", + "description": "Number of updates to download.", + "type": "integer", + "readOnly": true + }, + "numberOfUpdatesDownloaded": { + "format": "int32", + "description": "Number of updates downloaded.", + "type": "integer", + "readOnly": true + } + } + }, + "UpdateInstallProgress": { + "description": "Progress details during installation of updates.", + "type": "object", + "properties": { + "percentComplete": { + "format": "int32", + "description": "Percentage completed.", + "type": "integer", + "readOnly": true + }, + "numberOfUpdatesToInstall": { + "format": "int32", + "description": "Number of updates to install.", + "type": "integer", + "readOnly": true + }, + "numberOfUpdatesInstalled": { + "format": "int32", + "description": "Number of updates installed.", + "type": "integer", + "readOnly": true + } + } + }, + "UpdateSummary": { + "description": "Details about ongoing updates and availability of updates on the device.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "systemData": { + "description": "UpdateSummary Result", + "$ref": "#/definitions/SystemData" + }, + "properties": { + "$ref": "#/definitions/UpdateSummaryProperties", + "description": "The device update information summary.", + "x-ms-client-flatten": true + } + } + }, + "UpdateSummaryProperties": { + "description": "The device update information summary.", + "type": "object", + "properties": { + "deviceVersionNumber": { + "description": "The current version of the device in format: 1.2.17312.13.\",", + "type": "string" + }, + "friendlyDeviceVersionName": { + "description": "The current version of the device in text format.", + "type": "string" + }, + "deviceLastScannedDateTime": { + "format": "date-time", + "description": "The last time when a scan was done on the device.", + "type": "string" + }, + "lastCompletedScanJobDateTime": { + "format": "date-time", + "description": "The time when the last scan job was completed (success/cancelled/failed) on the appliance.", + "type": "string" + }, + "lastSuccessfulScanJobTime": { + "format": "date-time", + "description": "Time when the last scan job is successfully completed.", + "type": "string" + }, + "lastCompletedDownloadJobDateTime": { + "format": "date-time", + "description": "The time when the last Download job was completed (success/cancelled/failed) on the appliance.", + "type": "string", + "readOnly": true + }, + "lastCompletedDownloadJobId": { + "description": "JobId of the last ran download job.(Can be success/cancelled/failed)", + "type": "string", + "readOnly": true + }, + "lastDownloadJobStatus": { + "description": "JobStatus of the last ran download job.", + "enum": [ + "Invalid", + "Running", + "Succeeded", + "Failed", + "Canceled", + "Paused", + "Scheduled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true + } + }, + "lastSuccessfulInstallJobDateTime": { + "format": "date-time", + "description": "The time when the Last Install job was completed successfully on the appliance", + "type": "string" + }, + "lastCompletedInstallJobDateTime": { + "format": "date-time", + "description": "The time when the last Install job was completed (success/cancelled/failed) on the appliance.", + "type": "string", + "readOnly": true + }, + "lastCompletedInstallJobId": { + "description": "JobId of the last ran install job.(Can be success/cancelled/failed)", + "type": "string", + "readOnly": true + }, + "lastInstallJobStatus": { + "description": "JobStatus of the last ran install job.", + "enum": [ + "Invalid", + "Running", + "Succeeded", + "Failed", + "Canceled", + "Paused", + "Scheduled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true + } + }, + "totalNumberOfUpdatesAvailable": { + "format": "int32", + "description": "The number of updates available for the current device version as per the last device scan.", + "type": "integer", + "readOnly": true + }, + "totalNumberOfUpdatesPendingDownload": { + "format": "int32", + "description": "The total number of items pending download.", + "type": "integer", + "readOnly": true + }, + "totalNumberOfUpdatesPendingInstall": { + "format": "int32", + "description": "The total number of items pending install.", + "type": "integer", + "readOnly": true + }, + "rebootBehavior": { + "description": "Indicates if updates are available and at least one of the updates needs a reboot.", + "enum": [ + "NeverReboots", + "RequiresReboot", + "RequestReboot" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "InstallRebootBehavior", + "modelAsString": true + } + }, + "ongoingUpdateOperation": { + "description": "The current update operation.", + "enum": [ + "None", + "Scan", + "Download", + "Install" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "UpdateOperation", + "modelAsString": true + } + }, + "inProgressDownloadJobId": { + "description": "The job ID of the download job in progress.", + "type": "string", + "readOnly": true + }, + "inProgressInstallJobId": { + "description": "The job ID of the install job in progress.", + "type": "string", + "readOnly": true + }, + "inProgressDownloadJobStartedDateTime": { + "format": "date-time", + "description": "The time when the currently running download (if any) started.", + "type": "string", + "readOnly": true + }, + "inProgressInstallJobStartedDateTime": { + "format": "date-time", + "description": "The time when the currently running install (if any) started.", + "type": "string", + "readOnly": true + }, + "updateTitles": { + "description": "The list of updates available for install.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "updates": { + "description": "The list of updates available for install.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/UpdateDetails" + }, + "readOnly": true + }, + "totalUpdateSizeInBytes": { + "format": "double", + "description": "The total size of updates available for download in bytes.", + "type": "number", + "readOnly": true + }, + "totalTimeInMinutes": { + "format": "int32", + "description": "The total time in Minutes", + "type": "integer", + "readOnly": true + } + } + }, + "UploadCertificateRequest": { + "description": "The upload certificate request.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RawCertificateData", + "description": "The Base 64 encoded certificate raw data.", + "x-ms-client-flatten": true + } + } + }, + "UploadCertificateResponse": { + "description": "The upload registration certificate response.", + "type": "object", + "properties": { + "authType": { + "description": "Specifies authentication type.", + "enum": [ + "Invalid", + "AzureActiveDirectory" + ], + "type": "string", + "x-ms-enum": { + "name": "AuthenticationType", + "modelAsString": true + } + }, + "resourceId": { + "description": "The resource ID of the Data Box Edge/Gateway device.", + "type": "string", + "readOnly": true + }, + "aadAuthority": { + "description": "Azure Active Directory tenant authority.", + "type": "string", + "readOnly": true + }, + "aadTenantId": { + "description": "Azure Active Directory tenant ID.", + "type": "string", + "readOnly": true + }, + "servicePrincipalClientId": { + "description": "Azure Active Directory service principal client ID.", + "type": "string", + "readOnly": true + }, + "servicePrincipalObjectId": { + "description": "Azure Active Directory service principal object ID.", + "type": "string", + "readOnly": true + }, + "azureManagementEndpointAudience": { + "description": "The azure management endpoint audience.", + "type": "string", + "readOnly": true + }, + "aadAudience": { + "description": "Identifier of the target resource that is the recipient of the requested token.", + "type": "string", + "readOnly": true + } + } + }, + "User": { + "description": "Represents a user who has access to one or more shares on the Data Box Edge/Gateway device.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "systemData": { + "description": "User in DataBoxEdge Resource", + "$ref": "#/definitions/SystemData" + }, + "properties": { + "$ref": "#/definitions/UserProperties", + "description": "The storage account credential properties.", + "x-ms-client-flatten": true + } + } + }, + "UserAccessRight": { + "description": "The mapping between a particular user and the access type on the SMB share.", + "required": [ + "userId", + "accessType" + ], + "type": "object", + "properties": { + "userId": { + "description": "User ID (already existing in the device).", + "type": "string" + }, + "accessType": { + "description": "Type of access to be allowed for the user.", + "enum": [ + "Change", + "Read", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "ShareAccessType", + "modelAsString": true + } + } + } + }, + "UserList": { + "description": "Collection of users.", + "type": "object", + "properties": { + "value": { + "description": "The list of users.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/User" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "UserProperties": { + "description": "The user properties.", + "required": [ + "userType" + ], + "type": "object", + "properties": { + "encryptedPassword": { + "$ref": "#/definitions/AsymmetricEncryptedSecret", + "description": "The password details." + }, + "shareAccessRights": { + "description": "List of shares that the user has rights on. This field should not be specified during user creation.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ShareAccessRight" + }, + "readOnly": true + }, + "userType": { + "description": "Type of the user.", + "enum": [ + "Share", + "LocalManagement", + "ARM" + ], + "type": "string", + "x-ms-enum": { + "name": "UserType", + "modelAsString": true + } + } + } + } + }, + "parameters": { + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version.", + "required": true, + "type": "string" + }, + "locationParameter": { + "name": "location", + "in": "path", + "description": "The location of the resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription ID.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "tags": [] +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/AlertGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/AlertGet.json new file mode 100644 index 000000000000..942004772ecf --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/AlertGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "title": "Could not scan for updates. Error message : 'An internal error has occurred. Please contact Microsoft Support.'.", + "alertType": "UpdateScanFailedEvent", + "appearedAtDateTime": "2018-12-18T02:18:51.4270267Z", + "recommendation": "Resolve the error : An internal error has occurred. Please contact Microsoft Support.", + "severity": "Critical", + "errorDetails": { + "errorCode": "", + "errorMessage": "", + "occurrences": 1 + }, + "detailedInformation": {} + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/alerts/159a00c7-8543-4343-9435-263ac87df3bb", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "type": "dataBoxEdgeDevices/alerts" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/AlertGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/AlertGetAllInDevice.json new file mode 100644 index 000000000000..20f3bb6ba086 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/AlertGetAllInDevice.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "title": "Device password has changed", + "alertType": "PasswordChangedEvent", + "appearedAtDateTime": "2018-12-18T02:29:15.2325577Z", + "recommendation": "The device administrator password has changed. This is a required action as part of the first time device setup or regular password reset. No further action is required.", + "severity": "Informational", + "errorDetails": { + "errorCode": "", + "errorMessage": "", + "occurrences": 2 + }, + "detailedInformation": {} + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/alerts/83eccd0b-134b-40b0-ad62-b5f124d03790", + "name": "83eccd0b-134b-40b0-ad62-b5f124d03790", + "type": "dataBoxEdgeDevices/alerts" + }, + { + "properties": { + "title": "Could not scan for updates. Error message : 'An internal error has occurred. Please contact Microsoft Support.'.", + "alertType": "UpdateScanFailedEvent", + "appearedAtDateTime": "2018-12-18T02:18:51.4270267Z", + "recommendation": "Resolve the error : An internal error has occurred. Please contact Microsoft Support.", + "severity": "Critical", + "errorDetails": { + "errorCode": "", + "errorMessage": "", + "occurrences": 1 + }, + "detailedInformation": {} + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/alerts/159a00c7-8543-4343-9435-263ac87df3bb", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "type": "dataBoxEdgeDevices/alerts" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/AvailableSkusList.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/AvailableSkusList.json new file mode 100644 index 000000000000..c0f6cf7287f6 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/AvailableSkusList.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "location": "westus", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "dataBoxEdgeDevices", + "name": "Gateway", + "availability": "Available", + "tier": "Standard", + "kind": "AzureDataBoxGateway", + "version": "Stable", + "signupOption": "Available", + "locations": [ + "West US" + ], + "locationInfo": [ + { + "location": "West US" + } + ] + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/BandwidthScheduleDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/BandwidthScheduleDelete.json new file mode 100644 index 000000000000..0cf34c2016f6 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/BandwidthScheduleDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "bandwidth-1", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/BandwidthScheduleGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/BandwidthScheduleGet.json new file mode 100644 index 000000000000..a9d4c1454dc1 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/BandwidthScheduleGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "bandwidth-1", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "start": "00:00:00", + "stop": "13:59:00", + "rateInMbps": 100, + "days": [ + "Sunday", + "Monday" + ] + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1", + "name": "bandwidth-1", + "type": "dataBoxEdgeDevices/bandwidthSchedules" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/BandwidthScheduleGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/BandwidthScheduleGetAllInDevice.json new file mode 100644 index 000000000000..e8eb26b06367 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/BandwidthScheduleGetAllInDevice.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "start": "00:00:00", + "stop": "13:59:00", + "rateInMbps": 100, + "days": [ + "Sunday", + "Monday" + ] + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1", + "name": "bandwidth-1", + "type": "dataBoxEdgeDevices/bandwidthSchedules" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/BandwidthSchedulePut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/BandwidthSchedulePut.json new file mode 100644 index 000000000000..5b9aa6cf95ca --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/BandwidthSchedulePut.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "bandwidth-1", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "parameters": { + "properties": { + "start": "0:0:0", + "stop": "13:59:0", + "rateInMbps": 100, + "days": [ + "Sunday", + "Monday" + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "start": "00:00:00", + "stop": "13:59:00", + "rateInMbps": 100, + "days": [ + "Sunday", + "Monday" + ] + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1", + "name": "bandwidth-1", + "type": "dataBoxEdgeDevices/bandwidthSchedules" + } + }, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ContainerDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ContainerDelete.json new file mode 100644 index 000000000000..71b793a5b5e4 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ContainerDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "storageAccountName": "storageaccount1", + "containerName": "blobcontainer1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ContainerGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ContainerGet.json new file mode 100644 index 000000000000..11163c3cc11b --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ContainerGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "storageAccountName": "storageaccount1", + "containerName": "blobcontainer1", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "containerStatus": "OK", + "dataFormat": "BlockBlob", + "refreshDetails": {}, + "createdDateTime": "2019-10-20T23:13:27.8545799Z" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/storageaccount1/containers/blobcontainer1", + "name": "blobcontainer1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ContainerListAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ContainerListAllInDevice.json new file mode 100644 index 000000000000..58480fd9d694 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ContainerListAllInDevice.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "storageAccountName": "storageaccount1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "containerStatus": "OK", + "dataFormat": "BlockBlob", + "refreshDetails": {}, + "createdDateTime": "2019-10-20T23:14:32.3016929Z" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-6LJVNIFFB411021190437191/storageAccounts/storageaccount1/containers/blobcontainer1", + "name": "blobcontainer1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers" + }, + { + "properties": { + "containerStatus": "OK", + "dataFormat": "BlockBlob", + "refreshDetails": {}, + "createdDateTime": "2019-10-20T23:15:38.0077675Z" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-6LJVNIFFB411021190437191/storageAccounts/storageaccount1/containers/blobcontainer2", + "name": "blobcontainer2", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers" + }, + { + "properties": { + "containerStatus": "OK", + "dataFormat": "BlockBlob", + "refreshDetails": {}, + "createdDateTime": "2019-10-20T23:13:27.8545799Z" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-6LJVNIFFB411021190437191/storageAccounts/storageaccount1/containers/blobcontainer3", + "name": "blobcontainer3", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ContainerPut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ContainerPut.json new file mode 100644 index 000000000000..88c052dd2ba8 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ContainerPut.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "storageAccountName": "storageaccount1", + "containerName": "blobcontainer1", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "container": { + "properties": { + "dataFormat": "BlockBlob" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "containerStatus": "OK", + "dataFormat": "BlockBlob", + "refreshDetails": {}, + "createdDateTime": "2019-10-20T23:13:27.8545799Z" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/storageaccount1/containers/blobcontainer1", + "name": "blobcontainer-5e155efe", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers" + } + }, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ContainerRefresh.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ContainerRefresh.json new file mode 100644 index 000000000000..3fdc2bb2e2f0 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ContainerRefresh.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "storageAccountName": "storageaccount1", + "containerName": "blobcontainer1", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/DataBoxEdgeDeviceDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/DataBoxEdgeDeviceDelete.json new file mode 100644 index 000000000000..4d58f476fb81 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/DataBoxEdgeDeviceDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/DataBoxEdgeDeviceGetByName.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/DataBoxEdgeDeviceGetByName.json new file mode 100644 index 000000000000..aaade3dd076e --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/DataBoxEdgeDeviceGetByName.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "location": "eastus2euap", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "W/\"datetime'2020-09-29T18%3A50%3A31.1203818Z'\"_W/\"datetime'2020-09-29T18%3A50%3A31.1343914Z'\"", + "identity": { + "type": "SystemAssigned", + "principalId": "b3e34fcc-ab02-4ca4-9d22-5de115419091", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "kind": "AzureStackEdge", + "properties": { + "dataBoxEdgeDeviceStatus": "Offline", + "serialNumber": "1D6QHQ2", + "deviceType": "DataBoxEdgeDevice", + "friendlyName": "DBE-1D6QHQ2", + "deviceModel": "Physical", + "deviceSoftwareVersion": "Azure Stack Edge 2009", + "deviceLocalCapacity": 8042259, + "timeZone": "Pacific Standard Time", + "deviceHcsVersion": "2.1.1361.23408", + "configuredRoleTypes": [ + "CloudEdgeManagement" + ], + "nodeCount": 1, + "edgeProfile": { + "subscription": { + "registrationId": "91d8753b-af42-4908-9a5e-2a61f08b20de", + "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/VmMgmtTestPass/providers/Microsoft.AzureStack/edgeSubscriptions/daaac4b0-35c4-4008-bdc6-b72ca5890f16", + "state": "Registered" + } + } + }, + "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/VmMgmtTestPass/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EdgeTestPassResource", + "name": "EdgeTestPassResource", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/DataBoxEdgeDeviceGetByResourceGroup.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/DataBoxEdgeDeviceGetByResourceGroup.json new file mode 100644 index 000000000000..a6eabe91fc83 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/DataBoxEdgeDeviceGetByResourceGroup.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "eastus2euap", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "W/\"datetime'2020-09-29T18%3A50%3A31.1203818Z'\"_W/\"datetime'2020-09-29T18%3A50%3A31.1343914Z'\"", + "identity": { + "type": "SystemAssigned", + "principalId": "b3e34fcc-ab02-4ca4-9d22-5de115419091", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "kind": "AzureStackEdge", + "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/VmMgmtTestPass/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EdgeTestPassResource", + "name": "EdgeTestPassResource", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + }, + { + "location": "centraluseuap", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "W/\"datetime'2020-11-18T23%3A31%3A30.3266766Z'\"_W/\"datetime'2020-11-18T23%3A31%3A30.3326804Z'\"", + "identity": { + "type": "SystemAssigned", + "principalId": "d97a6de5-f5c0-485a-8f5e-b7f705d2dbc4", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "kind": "AzureStackEdge", + "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/VmMgmtTestPass/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/FPGAResource", + "name": "FPGAResource", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + }, + { + "location": "centraluseuap", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "W/\"datetime'2020-11-18T23%3A31%3A23.1715672Z'\"_W/\"datetime'2020-11-18T23%3A31%3A23.2396152Z'\"", + "identity": { + "type": "SystemAssigned", + "principalId": "6f2b341b-aded-4ec2-a1bd-d09438d6cc8f", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "kind": "AzureStackEdge", + "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/VmMgmtTestPass/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/TestVMEdgeResource", + "name": "TestVMEdgeResource", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/DataBoxEdgeDeviceGetBySubscription.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/DataBoxEdgeDeviceGetBySubscription.json new file mode 100644 index 000000000000..a8d2a292af1c --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/DataBoxEdgeDeviceGetBySubscription.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "eastus2euap", + "tags": {}, + "sku": { + "name": "Gateway", + "tier": "Standard" + }, + "etag": "W/\"datetime'2020-11-19T01%3A39%3A55.1270082Z'\"_W/\"datetime'2020-11-19T01%3A39%3A55.1320118Z'\"", + "identity": { + "type": "SystemAssigned", + "principalId": "083df009-06d9-4e3c-ae72-f9249a814334", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "kind": "AzureDataBoxGateway", + "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/abhudeda-rg/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/linksub01", + "name": "linksub01", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + }, + { + "location": "eastus2euap", + "tags": {}, + "sku": { + "name": "Gateway", + "tier": "Standard" + }, + "etag": "W/\"datetime'2020-11-19T01%3A40%3A05.9246966Z'\"_W/\"datetime'2020-11-19T01%3A40%3A05.9317011Z'\"", + "identity": { + "type": "SystemAssigned", + "principalId": "8536db30-78d2-4759-95b7-896a66e14c24", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "kind": "AzureDataBoxGateway", + "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/abhudeda-rg/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/mergeazstest", + "name": "mergeazstest", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + }, + { + "location": "eastus2euap", + "tags": {}, + "sku": { + "name": "Gateway", + "tier": "Standard" + }, + "etag": "W/\"datetime'2020-11-19T01%3A40%3A06.496102Z'\"_W/\"datetime'2020-11-19T01%3A40%3A06.503107Z'\"", + "identity": { + "type": "SystemAssigned", + "principalId": "fc4c1205-35c8-4f35-abc7-f5a78945f676", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "kind": "AzureDataBoxGateway", + "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/abhudeda-rg/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/mergeazstest2", + "name": "mergeazstest2", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/DataBoxEdgeDevicePatch.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/DataBoxEdgeDevicePatch.json new file mode 100644 index 000000000000..707d48a412b1 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/DataBoxEdgeDevicePatch.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "parameters": { + "properties": { + "edgeProfile": { + "subscription": { + "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/rapvs-rg/providers/Microsoft.AzureStack/linkedSubscriptions/ca014ddc-5cf2-45f8-b390-e901e4a0ae87" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "eastus2euap", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "W/\"datetime'2020-11-19T04%3A43%3A38.6457308Z'\"_W/\"datetime'2020-11-19T04%3A43%3A38.6507339Z'\"", + "identity": { + "type": "SystemAssigned", + "principalId": "b3e34fcc-ab02-4ca4-9d22-5de115419091", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "kind": "AzureStackEdge", + "properties": { + "dataBoxEdgeDeviceStatus": "ReadyToSetup", + "deviceType": "DataBoxEdgeDevice", + "deviceLocalCapacity": 0, + "timeZone": "Pacific Standard Time", + "nodeCount": 0, + "resourceMoveDetails": { + "operationInProgress": "None" + }, + "edgeProfile": { + "subscription": { + "registrationId": "91d8753b-af42-4908-9a5e-2a61f08b20de", + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/VmMgmtTestPass/providers/Microsoft.AzureStack/edgeSubscriptions/daaac4b0-35c4-4008-bdc6-b72ca5890f16", + "state": "Registered" + } + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourcegroups/VmMgmtTestPass/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice", + "name": "testedgedevice", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/DataBoxEdgeDevicePut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/DataBoxEdgeDevicePut.json new file mode 100644 index 000000000000..d031dca80eb6 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/DataBoxEdgeDevicePut.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "dataBoxEdgeDevice": { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + } + } + }, + "responses": { + "200": { + "body": { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "name": "testedgedevice" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/DeleteAddons.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/DeleteAddons.json new file mode 100644 index 000000000000..6dfb56a03f9d --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/DeleteAddons.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "roleName": "KubernetesRole", + "addonName": "arcName", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/DeleteMonitoringConfig.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/DeleteMonitoringConfig.json new file mode 100644 index 000000000000..3ab07060d5f9 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/DeleteMonitoringConfig.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "roleName": "testrole", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/DownloadUpdatesPost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/DownloadUpdatesPost.json new file mode 100644 index 000000000000..49a4c10a8c02 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/DownloadUpdatesPost.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ExtendedInfoPost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ExtendedInfoPost.json new file mode 100644 index 000000000000..198e469fbd1b --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ExtendedInfoPost.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "resourceKey": "3482840729935603111", + "encryptionKeyThumbprint": "", + "encryptionKey": "" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice", + "name": "testedgedevice", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/GenerateCertificate.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/GenerateCertificate.json new file mode 100644 index 000000000000..95025f41ee64 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/GenerateCertificate.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "publicKey": "MIIEDjCCAnagAwIBAgIQEW4wrxj9+JdA4kFLDgegTTANBgkqhkiG9w0BAQUFADBDMUEwPwYDVQQDHjgAQwBCAF8AUABvAHIAdABhAGwAXwA2ADMANwA0ADEAMwA1ADkAMQA4ADAAMAA3ADAAOQAxADcANTAeFw0yMDExMTkwNDU2MjBaFw0yMDExMjIwNTA2MjBaMEMxQTA/BgNVBAMeOABDAEIAXwBQAG8AcgB0AGEAbABfADYAMwA3ADQAMQAzADUAOQAxADgAMAAwADcAMAA5ADEANwA1MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAqG617KAUc4gOoht527o6FGE/c97W/wZIXqKbx4G8vifljXWw3NGDDuSQfidE3MqSMMJ/AAlDhBH/Deo/PAgUWuWB2WgM+KFWrDS0oDBvLVeIIeiMx4LOsbz4J8IbcKrGWf+ulQyum7dE/yBLzPXcPTjhJP0oMfhGOMlVVWbiKaP78/WZk2PmBQaVv7PxAQnJAPqETH2qAyuc9bd0TaMlIER56WhX9+nzsoI0u7RmBEs8+BaudVroiiK/GpEczy73TCRlpVXGChdBHg+NvYRYz91ltCV9Ijo1bdvcUjdgDJZ4Tz7G8XVCQmxbd9ml6OBLgxQUpd9HSGTcIfFiv+rTUwHR7YkY+1UGHsDPOYnBVDTXs3RFm+c5uNnCKvtyTExDJgabT+FTNb3eyD/BSYsy6b/YZBRqPiO8BRFUsIhWhXtPaUjWOEx6XMeZRnGeF4Hi8iH8TR79kEJhfYy3piSPAc3JrhgoglpyyfZOgyPOje+8tAWS9FHUNyVXKKeksDoZAgMBAAEwDQYJKoZIhvcNAQEFBQADggGBACpfQt34mgr+WlFtY0tqaPAoF6XnVzyKB6XsVAoj1uKFTSCQnr0mWvUMWKSRFTu1bV1VdDokV5I+h92kBcO4ddtHhWtkt16j9XFDsGdDvoUWJeqecZVr9fBPC69wF/9R/2E6iJporR46Pui7gcilYGqb3IjJlh8RT/XBPamQrfDbS7G8eTe91ST5cHr89R6EtDwfyhyTZr2sRrvQrxY2AjEmdH5Zcl9q2Xf8DholZhZ9vwnuYBFfl6VCXWaDAzQWiPdxo1wgXxEpNNDstGFWJKnsnz9UCohNAiPf47B+csPqxjcTLVMhcGLdU/lwpzzkEOciijpYILscvPoU3IM6DmFROgU2z6CForpgwHPDJktyWU1MC7lFdfrSzwu/5b3ZAEQhnJf7rvrybULoYBQWJEuj26Is1S6kXpNUaHAc5HIyIoc2V2eRjasbPIqsU0smjPLS/1egjHxtw9u+v4qDDvDuOjhFJtC3NkPl06TfNgO9+5LgiB1JppXnkLyCQ9RQgw==", + "privateKey": null, + "expiryTimeInUTC": "2020-11-22T05:06:20.000Z" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/GetAddons.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/GetAddons.json new file mode 100644 index 000000000000..e53eab65ef67 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/GetAddons.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "roleName": "KubernetesRole", + "addonName": "arcName", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "resourceName": "testedgedevice", + "resourceLocation": "EastUS", + "version": "0.2.18", + "hostPlatform": "Linux", + "hostPlatformType": "KubernetesCluster", + "provisioningState": "Created" + }, + "kind": "ArcForKubernetes", + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourcegroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/addonExamples/roles/kubernetesRole/addons/arcName", + "name": "arcName", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/GetDCAccessCode.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/GetDCAccessCode.json new file mode 100644 index 000000000000..8851a6704daf --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/GetDCAccessCode.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "authCode": "_sv7-NY2" + } + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/GetDiagnosticProactiveLogCollectionSettings.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/GetDiagnosticProactiveLogCollectionSettings.json new file mode 100644 index 000000000000..493346b2df4d --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/GetDiagnosticProactiveLogCollectionSettings.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "diagnosticProactiveLogCollectionSettings": { + "properties": { + "userConsent": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "userConsent": "Enabled" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/diagnosticProactiveLogCollectionSettings/default", + "name": "default", + "type": "dataBoxEdgeDevices/diagnosticSettings" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/GetDiagnosticRemoteSupportSettings.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/GetDiagnosticRemoteSupportSettings.json new file mode 100644 index 000000000000..c0642c3f5cc3 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/GetDiagnosticRemoteSupportSettings.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "remoteSupportSettingsList": [ + { + "accessLevel": "ReadWrite", + "expirationTimeStampInUTC": "2021-07-07T00:00:00+00:00", + "remoteApplicationType": "LocalUI" + } + ] + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/diagnosticRemoteSupportSettings/default", + "name": "default", + "type": "dataBoxEdgeDevices/diagnosticSettings" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/GetMonitoringConfig.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/GetMonitoringConfig.json new file mode 100644 index 000000000000..11875e9f21a6 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/GetMonitoringConfig.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "roleName": "testrole", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "metricConfigurations": [ + { + "resourceId": "test", + "mdmAccount": "test", + "metricNameSpace": "test", + "counterSets": [ + { + "counters": [ + { + "name": "test" + } + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/GetUpdateExtendedInfo.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/GetUpdateExtendedInfo.json new file mode 100644 index 000000000000..17c0a153f45d --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/GetUpdateExtendedInfo.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "parameters": {}, + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "clientSecretStoreId": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/arja-rg/providers/Microsoft.KeyVault/vaults/test-keyvault-ccy-523", + "clientSecretStoreUrl": "https://test-keyvault-ccy-523.vault.azure.net", + "channelIntegrityKeyName": "ase-cik-ab861822-21ea-4d31-96ec-89aa066f9a59", + "channelIntegrityKeyVersion": "95e9b619e65f433d82c9e1ead48214b9", + "keyVaultSyncStatus": "KeyVaultSynced", + "deviceSecrets": { + "HcsDataVolumeBitLockerExternalKey": { + "keyVaultId": "Id" + }, + "HcsInternalVolumeBitLockerExternalKey": { + "keyVaultId": "Id" + }, + "SystemVolumeBitLockerRecoveryKey": { + "keyVaultId": "Id" + }, + "SEDEncryptionExternalKeyId": {}, + "SEDEncryptionExternalKey": {}, + "BMCDefaultUserPassword": {}, + "RotateKeyForDataVolumeBitlocker": {}, + "RotateKeysForSedDrivesSerialized": {} + } + } + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/InstallUpdatesPost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/InstallUpdatesPost.json new file mode 100644 index 000000000000..49a4c10a8c02 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/InstallUpdatesPost.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/JobsGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/JobsGet.json new file mode 100644 index 000000000000..02b4976f6ddb --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/JobsGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/id/locations/westus/jobs/159a00c7-8543-4343-9435-263ac87df3bb", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "status": "Succeeded", + "startTime": "2018-12-18T02:18:51.4270267Z", + "endTime": "2018-12-18T03:18:51.4270267Z", + "percentComplete": 100, + "properties": { + "jobType": "DownloadUpdates", + "currentStage": "Success" + } + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ListMonitoringConfig.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ListMonitoringConfig.json new file mode 100644 index 000000000000..e02fb5888617 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ListMonitoringConfig.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "roleName": "testrole", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "metricConfigurations": [ + { + "resourceId": "test", + "mdmAccount": "test", + "metricNameSpace": "test", + "counterSets": [ + { + "counters": [ + { + "name": "test" + } + ] + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/NetworkSettingsGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/NetworkSettingsGet.json new file mode 100644 index 000000000000..87f4f5beffde --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/NetworkSettingsGet.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "networkAdapters": [ + { + "adapterId": "{47D0D0EC-AA8A-4221-AA2A-355B58082BA5}", + "adapterPosition": { + "networkGroup": "NonRDMA", + "port": 0 + }, + "index": 1, + "nodeId": "3fd54d9e-f7a0-45bf-bdf1-39b0977d1984", + "networkAdapterName": "DATA1", + "label": "DATA1", + "macAddress": "00155D4E265B", + "linkSpeed": 10000000000, + "status": "Inactive", + "rdmaStatus": "Incapable", + "dhcpStatus": "Disabled", + "ipv4Configuration": { + "ipAddress": "10.150.78.56", + "subnet": "255.255.252.0", + "gateway": "10.150.76.1" + }, + "ipv6Configuration": { + "ipAddress": "2404:f801:4800:1e:d5c6:50a1:465b:1bbf", + "prefixLength": 64, + "gateway": "fe80::12f3:11ff:fe36:994b%5" + }, + "ipv6LinkLocalAddress": "fe80::d5c6:50a1:465b:1bbf%5", + "dnsServers": [ + "10.50.50.50", + "10.50.10.50" + ] + } + ] + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/networkSettings/default", + "name": "default", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/networkSettings" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/NodeGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/NodeGetAllInDevice.json new file mode 100644 index 000000000000..238ecb2a47b1 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/NodeGetAllInDevice.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "nodeStatus": "Unknown", + "nodeChassisSerialNumber": "1D6QHQ2", + "nodeSerialNumber": "1D6QHQ2", + "nodeDisplayName": "Controller 1", + "nodeFriendlySoftwareVersion": "Data Box Edge 1908", + "nodeHcsVersion": "1.6.961.8307", + "nodeInstanceId": "ad051874-7d27-4ac4-a7b1-b6f231d8a035" + }, + "id": "/subscriptions/db4e2fdb-6d80-4e6e-b7cd-736098270664/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/testedgedevice/nodes/1D6QHQ2", + "name": "1D6QHQ2", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/nodes" + }, + { + "properties": { + "nodeStatus": "Unknown", + "nodeChassisSerialNumber": "1D6QHQ2", + "nodeSerialNumber": "1DCNHQ2", + "nodeDisplayName": "Controller 1", + "nodeFriendlySoftwareVersion": "Data Box Edge 1908", + "nodeHcsVersion": "1.6.961.8307", + "nodeInstanceId": "ddf3a76d-ada4-44af-99c6-a69a0e21bcb6" + }, + "id": "/subscriptions/db4e2fdb-6d80-4e6e-b7cd-736098270664/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/testedgedevice/nodes/1DCNHQ2", + "name": "1DCNHQ2", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/nodes" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/OperationsGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/OperationsGet.json new file mode 100644 index 000000000000..8d0598d5b369 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/OperationsGet.json @@ -0,0 +1,675 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "share users", + "operation": "List share users", + "description": "Lists or gets the share users" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "share users", + "operation": "List share users", + "description": "Lists or gets the share users" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/write", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "share users", + "operation": "Creates or updates share users", + "description": "Creates or updates the share users" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/delete", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "share users", + "operation": "Delete share users", + "description": "Deletes the share users" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "bandwidth schedules", + "operation": "List bandwidth schedules", + "description": "Lists or gets the bandwidth schedules" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "bandwidth schedules", + "operation": "List bandwidth schedules", + "description": "Lists or gets the bandwidth schedules" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/write", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "bandwidth schedules", + "operation": "Creates or updates bandwidth schedules", + "description": "Creates or updates the bandwidth schedules" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/delete", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "bandwidth schedules", + "operation": "Delete bandwidth schedules", + "description": "Deletes the bandwidth schedules" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "ArmApiRes_roles", + "operation": "List ArmApiRes_roles", + "description": "Lists or gets the ArmApiRes_roles" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "ArmApiRes_roles", + "operation": "List ArmApiRes_roles", + "description": "Lists or gets the ArmApiRes_roles" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/write", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "ArmApiRes_roles", + "operation": "Creates or updates ArmApiRes_roles", + "description": "Creates or updates the ArmApiRes_roles" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/delete", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "ArmApiRes_roles", + "operation": "Delete ArmApiRes_roles", + "description": "Deletes the ArmApiRes_roles" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "shares", + "operation": "List shares", + "description": "Lists or gets the shares" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "shares", + "operation": "List shares", + "description": "Lists or gets the shares" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/write", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "shares", + "operation": "Creates or updates shares", + "description": "Creates or updates the shares" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/refresh/action", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "shares", + "operation": "ArmApiOp_action_refresh_shares", + "description": "ArmApiDesc_action_refresh_shares" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/delete", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "shares", + "operation": "Delete shares", + "description": "Deletes the shares" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/uploadCertificate/action", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Upload certificates", + "description": "Upload certificate for device registration" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/write", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Creates or updates Data Box Edge devices", + "description": "Creates or updates the Data Box Edge devices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "List Data Box Edge devices", + "description": "Lists or gets the Data Box Edge devices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/delete", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Delete Data Box Edge devices", + "description": "Deletes the Data Box Edge devices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "List Data Box Edge devices", + "description": "Lists or gets the Data Box Edge devices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "List Data Box Edge devices", + "description": "Lists or gets the Data Box Edge devices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/write", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Creates or updates Data Box Edge devices", + "description": "Creates or updates the Data Box Edge devices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/getExtendedInformation/action", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "ArmApiOp_action_getExtendedInformation_dataBoxEdgeDevices", + "description": "ArmApiDesc_action_getExtendedInformation_dataBoxEdgeDevices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/extendedInformation/action", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Gets resource extended information", + "description": "Retrieves resource extended information" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/networkSettings/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Device network settings", + "operation": "List Device network settings", + "description": "Lists or gets the Device network settings" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/securitySettings/update/action", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Device security settings", + "operation": "Update security settings", + "description": "Update security settings" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/updateSummary/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "update summary", + "operation": "List update summary", + "description": "Lists or gets the update summary" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/scanForUpdates/action", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Scan for updates", + "description": "Scan for updates" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/downloadUpdates/action", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Download Updates", + "description": "Download Updates in device" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/installUpdates/action", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Install Updates", + "description": "Install Updates on device" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/jobs/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "jobs", + "operation": "List jobs", + "description": "Lists or gets the jobs" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/write", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "storage account credentials", + "operation": "Creates or updates storage account credentials", + "description": "Creates or updates the storage account credentials" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "storage account credentials", + "operation": "List storage account credentials", + "description": "Lists or gets the storage account credentials" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "storage account credentials", + "operation": "List storage account credentials", + "description": "Lists or gets the storage account credentials" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/delete", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "storage account credentials", + "operation": "Delete storage account credentials", + "description": "Deletes the storage account credentials" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/alerts/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "alerts", + "operation": "List alerts", + "description": "Lists or gets the alerts" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/alerts/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "alerts", + "operation": "List alerts", + "description": "Lists or gets the alerts" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge device", + "operation": "Read Data Box Edge device metric definition", + "description": "Gets the available Data Box Edge device level metrics" + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "NICReadThroughput", + "displayName": "Read Throughput (Network)", + "displayDescription": "The read throughput of the network interface on the device in the reporting period for all volumes in the gateway.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "dimensions": [ + { + "name": "InstanceName", + "displayName": "Name", + "toBeExportedForShoebox": true + } + ], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT1M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "NICWriteThroughput", + "displayName": "Write Throughput (Network)", + "displayDescription": "The write throughput of the network interface on the device in the reporting period for all volumes in the gateway.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "dimensions": [ + { + "name": "InstanceName", + "displayName": "Name", + "toBeExportedForShoebox": true + } + ], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT1M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "CloudReadThroughputPerShare", + "displayName": "Cloud Download Throughput (Share)", + "displayDescription": "The download throughput to Azure from a share during the reporting period.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "dimensions": [ + { + "name": "Share", + "displayName": "Share", + "toBeExportedForShoebox": true + } + ], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT1M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "CloudUploadThroughputPerShare", + "displayName": "Cloud Upload Throughput (Share)", + "displayDescription": "The upload throughput to Azure from a share during the reporting period.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "dimensions": [ + { + "name": "Share", + "displayName": "Share", + "toBeExportedForShoebox": true + } + ], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT1M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "BytesUploadedToCloudPerShare", + "displayName": "Cloud Bytes Uploaded (Share)", + "displayDescription": "The total number of bytes that is uploaded to Azure from a share during the reporting period.", + "unit": "Bytes", + "aggregationType": "Average", + "dimensions": [ + { + "name": "Share", + "displayName": "Share", + "toBeExportedForShoebox": true + } + ], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT1M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "TotalCapacity", + "displayName": "Total Capacity", + "displayDescription": "Total Capacity", + "unit": "Bytes", + "aggregationType": "Average", + "dimensions": [], + "fillGapWithZero": false, + "category": "Capacity", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "AvailableCapacity", + "displayName": "Available Capacity", + "displayDescription": "The available capacity in bytes during the reporting period.", + "unit": "Bytes", + "aggregationType": "Average", + "dimensions": [], + "fillGapWithZero": false, + "category": "Capacity", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "CloudUploadThroughput", + "displayName": "Cloud Upload Throughput", + "displayDescription": "The cloud upload throughput during the reporting period.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "dimensions": [], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "CloudReadThroughput", + "displayName": "Cloud Read Throughput", + "displayDescription": "The cloud download throughput during the reporting period.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "dimensions": [], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "BytesUploadedToCloud", + "displayName": "Cloud Bytes Uploaded (Device)", + "displayDescription": "The total number of bytes that is uploaded to Azure from a device during the reporting period.", + "unit": "Bytes", + "aggregationType": "Average", + "dimensions": [], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + } + ] + } + } + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge device", + "operation": "Write diagnostics setting", + "description": "Creates or updates the diagnostics setting for the resource" + }, + "origin": "system" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge device", + "operation": "Read diagnostics setting", + "description": "Gets the diagnostic setting for the resource" + }, + "origin": "system" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/OperationsStatusGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/OperationsStatusGet.json new file mode 100644 index 000000000000..3e623e3f6554 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/OperationsStatusGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/id/locations/westus/operationsStatus/159a00c7-8543-4343-9435-263ac87df3bb", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "status": "Succeeded", + "startTime": "2018-12-18T02:18:51.4270267Z", + "endTime": "2018-12-18T03:18:51.4270267Z", + "percentComplete": 100, + "properties": { + "jobType": "DownloadUpdates", + "currentStage": "Success" + } + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/OrderDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/OrderDelete.json new file mode 100644 index 000000000000..4d58f476fb81 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/OrderDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/OrderGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/OrderGet.json new file mode 100644 index 000000000000..bd7dfcf1225f --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/OrderGet.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default", + "name": "default", + "type": "dataBoxEdgeDevices/orders", + "properties": { + "contactInformation": { + "contactPerson": "John Mcclane", + "companyName": "Microsoft", + "phone": "(800) 426-9400", + "emailList": [ + "john@microsoft.com" + ] + }, + "shippingAddress": { + "addressLine1": "Microsoft Corporation", + "addressLine2": "One Microsoft Way", + "addressLine3": "Redmond", + "postalCode": "98052", + "city": "WA", + "state": "WA", + "country": "USA" + }, + "currentStatus": { + "status": "Untracked", + "updateDateTime": "2018-12-10T07:59:05.847Z", + "comments": "" + }, + "orderHistory": [ + { + "status": "Untracked", + "updateDateTime": "2018-12-10T07:59:05.847Z", + "comments": "lorem ipsum" + } + ], + "serialNumber": "UDS123NSDA123", + "deliveryTrackingInfo": [], + "returnTrackingInfo": [] + } + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/OrderGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/OrderGetAllInDevice.json new file mode 100644 index 000000000000..5ef34979b8df --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/OrderGetAllInDevice.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default", + "name": "default", + "type": "dataBoxEdgeDevices/orders", + "properties": { + "contactInformation": { + "contactPerson": "John Mcclane", + "companyName": "Microsoft", + "phone": "(800) 426-9400", + "emailList": [ + "john@microsoft.com" + ] + }, + "shippingAddress": { + "addressLine1": "Microsoft Corporation", + "addressLine2": "One Microsoft Way", + "addressLine3": "Redmond", + "postalCode": "98052", + "city": "WA", + "state": "WA", + "country": "USA" + }, + "currentStatus": { + "status": "Untracked", + "updateDateTime": "2018-12-10T07:59:05.847Z", + "comments": "" + }, + "orderHistory": [ + { + "status": "Untracked", + "updateDateTime": "2018-12-10T07:59:05.847Z", + "comments": "lorem ipsum" + } + ], + "serialNumber": "UDS123NSDA123", + "deliveryTrackingInfo": [], + "returnTrackingInfo": [] + } + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/OrderPut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/OrderPut.json new file mode 100644 index 000000000000..e2731eb2e14c --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/OrderPut.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "order": { + "properties": { + "contactInformation": { + "contactPerson": "John Mcclane", + "companyName": "Microsoft", + "phone": "(800) 426-9400", + "emailList": [ + "john@microsoft.com" + ] + }, + "shippingAddress": { + "addressLine1": "Microsoft Corporation", + "addressLine2": "One Microsoft Way", + "addressLine3": "Redmond", + "postalCode": "98052", + "city": "WA", + "state": "WA", + "country": "USA" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default", + "name": "default", + "type": "dataBoxEdgeDevices/orders", + "properties": { + "contactInformation": { + "contactPerson": "John Mcclane", + "companyName": "Microsoft", + "phone": "(800) 426-9400", + "emailList": [ + "john@microsoft.com" + ] + }, + "shippingAddress": { + "addressLine1": "Microsoft Corporation", + "addressLine2": "One Microsoft Way", + "addressLine3": "Redmond", + "postalCode": "98052", + "city": "WA", + "state": "WA", + "country": "USA" + }, + "currentStatus": { + "status": "Untracked", + "updateDateTime": "2018-12-10T07:59:05.847Z", + "comments": "" + }, + "orderHistory": [ + { + "status": "Untracked", + "updateDateTime": "2018-12-10T07:59:05.847Z", + "comments": "lorem ipsum" + } + ], + "serialNumber": "UDS123NSDA123", + "deliveryTrackingInfo": [], + "returnTrackingInfo": [] + } + } + }, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/PutAddons.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/PutAddons.json new file mode 100644 index 000000000000..3a636aff9a9d --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/PutAddons.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "roleName": "KubernetesRole", + "addonName": "arcName", + "addon": { + "kind": "ArcForKubernetes", + "properties": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "resourceName": "testedgedevice", + "resourceLocation": "EastUS" + } + }, + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "resourceName": "testedgedevice", + "resourceLocation": "EastUS", + "version": "0.2.18", + "hostPlatform": "Linux", + "hostPlatformType": "KubernetesCluster", + "provisioningState": "Created" + }, + "kind": "ArcForKubernetes", + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourcegroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/addonExamples/roles/kubernetesRole/addons/arcName", + "name": "arcName", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons" + } + }, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/PutMonitoringConfig.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/PutMonitoringConfig.json new file mode 100644 index 000000000000..432935225ef1 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/PutMonitoringConfig.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "roleName": "testrole", + "monitoringMetricConfiguration": { + "properties": { + "metricConfigurations": [ + { + "resourceId": "test", + "mdmAccount": "test", + "metricNameSpace": "test", + "counterSets": [ + { + "counters": [ + { + "name": "test" + } + ] + } + ] + } + ] + } + }, + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "metricConfigurations": [ + { + "resourceId": "test", + "mdmAccount": "test", + "metricNameSpace": "test", + "counterSets": [ + { + "counters": [ + { + "name": "test" + } + ] + } + ] + } + ] + } + } + }, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/RoleDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/RoleDelete.json new file mode 100644 index 000000000000..30309158173a --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/RoleDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "IoTRole1", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/RoleGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/RoleGet.json new file mode 100644 index 000000000000..7687d473d600 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/RoleGet.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "IoTRole1", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "hostPlatform": "Linux", + "ioTDeviceDetails": { + "deviceId": "iotdevice", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": {} + } + }, + "ioTEdgeDeviceDetails": { + "deviceId": "iotEdge", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": {} + } + }, + "shareMappings": [], + "roleStatus": "Enabled" + }, + "kind": "IOT", + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1", + "name": "IoTRole1", + "type": "dataBoxEdgeDevices/roles" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/RoleGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/RoleGetAllInDevice.json new file mode 100644 index 000000000000..148503dadb75 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/RoleGetAllInDevice.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "hostPlatform": "Linux", + "ioTDeviceDetails": { + "deviceId": "iotdevice", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": {} + } + }, + "ioTEdgeDeviceDetails": { + "deviceId": "iotEdge", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": {} + } + }, + "shareMappings": [], + "roleStatus": "Enabled" + }, + "kind": "IOT", + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1", + "name": "IoTRole1", + "type": "dataBoxEdgeDevices/roles" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/RoleListAddOns.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/RoleListAddOns.json new file mode 100644 index 000000000000..dd8256f8e77c --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/RoleListAddOns.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "roleName": "IoTRole1", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "subscriptionId": "0d44739e-0563-474f-97e7-24a0cdb23b29", + "resourceGroupName": "testrg1", + "resourceName": "testresource1", + "resourceLocation": "EastUS", + "version": "0.2.18", + "hostPlatform": "Linux", + "hostPlatformType": "KubernetesCluster", + "provisioningState": "Created" + }, + "kind": "ArcForKubernetes", + "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/prpare/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/addonExamples/roles/kubernetesRole/addons/arcName", + "name": "arcName", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/RolePut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/RolePut.json new file mode 100644 index 000000000000..c8cff236dfcb --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/RolePut.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "IoTRole1", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "role": { + "kind": "IOT", + "properties": { + "hostPlatform": "Linux", + "ioTDeviceDetails": { + "deviceId": "iotdevice", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": { + "connectionString": { + "value": "Encrypted<>", + "encryptionCertThumbprint": "348586569999244", + "encryptionAlgorithm": "AES256" + } + } + } + }, + "ioTEdgeDeviceDetails": { + "deviceId": "iotEdge", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": { + "connectionString": { + "value": "Encrypted<>", + "encryptionCertThumbprint": "1245475856069999244", + "encryptionAlgorithm": "AES256" + } + } + } + }, + "shareMappings": [], + "roleStatus": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "kind": "IOT", + "properties": { + "hostPlatform": "Linux", + "ioTDeviceDetails": { + "deviceId": "iotdevice", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": {} + } + }, + "ioTEdgeDeviceDetails": { + "deviceId": "iotEdge", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": {} + } + }, + "shareMappings": [], + "roleStatus": "Enabled" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1", + "name": "IoTRole1", + "type": "dataBoxEdgeDevices/roles" + } + }, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/SACDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/SACDelete.json new file mode 100644 index 000000000000..35e1d0f5d717 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/SACDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "sac1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/SACGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/SACGet.json new file mode 100644 index 000000000000..4db252891892 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/SACGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "sac1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "alias": "sac1", + "userName": "cisbvt", + "sslStatus": "Disabled", + "accountType": "BlobStorage" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1", + "name": "sac1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/SACGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/SACGetAllInDevice.json new file mode 100644 index 000000000000..5aeb4648d298 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/SACGetAllInDevice.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "alias": "sac1128180128323", + "userName": "cisbvt", + "sslStatus": "Disabled", + "accountType": "GeneralPurposeStorage" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1128180128323", + "name": "sac1128180128323", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials" + }, + { + "properties": { + "alias": "sac1128180128312", + "userName": "cisbvt", + "sslStatus": "Disabled", + "accountType": "BlobStorage" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1128180128312", + "name": "sac1128180128312", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/SACPut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/SACPut.json new file mode 100644 index 000000000000..89b6fed34ff1 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/SACPut.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "sac1", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "storageAccountCredential": { + "properties": { + "alias": "sac1", + "userName": "cisbvt", + "accountKey": { + "value": "lAeZEYi6rNP1/EyNaVUYmTSZEYyaIaWmwUsGwek0+xiZj54GM9Ue9/UA2ed/ClC03wuSit2XzM/cLRU5eYiFBwks23rGwiQOr3sruEL2a74EjPD050xYjA6M1I2hu/w2yjVHhn5j+DbXS4Xzi+rHHNZK3DgfDO3PkbECjPck+PbpSBjy9+6Mrjcld5DIZhUAeMlMHrFlg+WKRKB14o/og56u5/xX6WKlrMLEQ+y6E18dUwvWs2elTNoVO8PBE8SM/CfooX4AMNvaNdSObNBPdP+F6Lzc556nFNWXrBLRt0vC7s9qTiVRO4x/qCNaK/B4y7IqXMllwQFf4Np9UQ2ECA==", + "encryptionCertThumbprint": "2A9D8D6BE51574B5461230AEF02F162C5F01AD31", + "encryptionAlgorithm": "AES256" + }, + "sslStatus": "Disabled", + "accountType": "BlobStorage" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "alias": "sac1", + "userName": "cisbvt", + "sslStatus": "Disabled", + "accountType": "BlobStorage" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1", + "name": "sac1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials" + } + }, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ScanForUpdatesPost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ScanForUpdatesPost.json new file mode 100644 index 000000000000..49a4c10a8c02 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ScanForUpdatesPost.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/SecuritySettingsUpdatePost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/SecuritySettingsUpdatePost.json new file mode 100644 index 000000000000..bc7bfd7a2d34 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/SecuritySettingsUpdatePost.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "AzureVM", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "securitySettings": { + "properties": { + "deviceAdminPassword": { + "value": "", + "encryptionAlgorithm": "AES256", + "encryptionCertThumbprint": "" + } + } + } + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ShareDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ShareDelete.json new file mode 100644 index 000000000000..29577b021c31 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ShareDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "smbshare", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ShareGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ShareGet.json new file mode 100644 index 000000000000..62cd76f3f02e --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ShareGet.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "smbshare", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "", + "shareStatus": "Online", + "monitoringStatus": "Disabled", + "azureContainerInfo": { + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1", + "containerName": "testContainerSMB", + "dataFormat": "BlockBlob" + }, + "accessProtocol": "SMB", + "userAccessRights": [ + { + "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2", + "accessType": "Change" + } + ], + "clientAccessRights": [], + "refreshDetails": {}, + "shareMappings": [], + "dataPolicy": "Cloud" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/smbshare", + "name": "smbshare", + "type": "dataBoxEdgeDevices/shares" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ShareGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ShareGetAllInDevice.json new file mode 100644 index 000000000000..3f77f4aa153b --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ShareGetAllInDevice.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "description": "", + "shareStatus": "Online", + "monitoringStatus": "Disabled", + "azureContainerInfo": { + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1", + "containerName": "testContainerSMB", + "dataFormat": "BlockBlob" + }, + "accessProtocol": "SMB", + "userAccessRights": [ + { + "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2", + "accessType": "Change" + } + ], + "clientAccessRights": [], + "refreshDetails": {}, + "shareMappings": [], + "dataPolicy": "Cloud" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/smbshare", + "name": "smbshare", + "type": "dataBoxEdgeDevices/shares" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/SharePut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/SharePut.json new file mode 100644 index 000000000000..7c3c68c125c9 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/SharePut.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "smbshare", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "share": { + "properties": { + "description": "", + "shareStatus": "Online", + "monitoringStatus": "Enabled", + "azureContainerInfo": { + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1", + "containerName": "testContainerSMB", + "dataFormat": "BlockBlob" + }, + "accessProtocol": "SMB", + "userAccessRights": [ + { + "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2", + "accessType": "Change" + } + ], + "dataPolicy": "Cloud" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "", + "shareStatus": "Online", + "monitoringStatus": "Disabled", + "azureContainerInfo": { + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1", + "containerName": "testContainerSMB", + "dataFormat": "BlockBlob" + }, + "accessProtocol": "SMB", + "userAccessRights": [ + { + "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2", + "accessType": "Change" + } + ], + "clientAccessRights": [], + "refreshDetails": {}, + "shareMappings": [], + "dataPolicy": "Cloud" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/smbshare", + "name": "smbshare", + "type": "dataBoxEdgeDevices/shares" + } + }, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ShareRefreshPost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ShareRefreshPost.json new file mode 100644 index 000000000000..755553ecdb1b --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/ShareRefreshPost.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "smbshare", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/StorageAccountDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/StorageAccountDelete.json new file mode 100644 index 000000000000..067511ee9344 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/StorageAccountDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "storageAccountName": "storageaccount1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/StorageAccountGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/StorageAccountGet.json new file mode 100644 index 000000000000..90561bc2b0f0 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/StorageAccountGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "storageAccountName": "blobstorageaccount1", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "It's an awesome storage account", + "storageAccountStatus": "OK", + "dataPolicy": "Cloud", + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/cisbvt", + "blobEndpoint": "https://blobstorageaccount1.blob.testedge.microsoftdatabox.com/", + "containerCount": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/blobstorageaccount1", + "name": "blobstorageaccount1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/StorageAccountGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/StorageAccountGetAllInDevice.json new file mode 100644 index 000000000000..ef680adb537e --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/StorageAccountGetAllInDevice.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "description": "It's an awesome storage account", + "storageAccountStatus": "OK", + "dataPolicy": "Cloud", + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/cisbvt", + "blobEndpoint": "https://blobstorageaccount1.blob.testedge.microsoftdatabox.com/", + "containerCount": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/blobstorageaccount1", + "name": "blobstorageaccount1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/StorageAccountPut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/StorageAccountPut.json new file mode 100644 index 000000000000..3b01f56643dc --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/StorageAccountPut.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "storageAccountName": "blobstorageaccount1", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "storageAccount": { + "properties": { + "description": "It's an awesome storage account", + "storageAccountStatus": "OK", + "dataPolicy": "Cloud", + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/cisbvt" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "It's an awesome storage account", + "storageAccountStatus": "OK", + "dataPolicy": "Cloud", + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/cisbvt", + "blobEndpoint": "https://blobstorageaccount1.blob.testedge.microsoftdatabox.com/", + "containerCount": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/blobstorageaccount1", + "name": "blobstorageaccount1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts" + } + }, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/TriggerDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/TriggerDelete.json new file mode 100644 index 000000000000..c0812801cdce --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/TriggerDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "trigger1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/TriggerGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/TriggerGet.json new file mode 100644 index 000000000000..4e70406ba0d7 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/TriggerGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "trigger1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "customContextTag": "CustomContextTags-1235346475", + "sourceInfo": { + "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1" + }, + "sinkInfo": { + "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1" + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1", + "name": "trigger1", + "type": "dataBoxEdgeDevices/triggers", + "kind": "FileEvent" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/TriggerGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/TriggerGetAllInDevice.json new file mode 100644 index 000000000000..f1a0a8ab54ab --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/TriggerGetAllInDevice.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "customContextTag": "CustomContextTags-1235346475", + "sourceInfo": { + "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1" + }, + "sinkInfo": { + "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1" + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1", + "name": "trigger1", + "type": "dataBoxEdgeDevices/triggers", + "kind": "FileEvent" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/TriggerPut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/TriggerPut.json new file mode 100644 index 000000000000..889e94b80daa --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/TriggerPut.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "trigger1", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "trigger": { + "properties": { + "customContextTag": "CustomContextTags-1235346475", + "sourceInfo": { + "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1" + }, + "sinkInfo": { + "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1" + } + }, + "kind": "FileEvent" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "customContextTag": "CustomContextTags-1235346475", + "sourceInfo": { + "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1" + }, + "sinkInfo": { + "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1" + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1", + "name": "trigger1", + "type": "dataBoxEdgeDevices/triggers", + "kind": "FileEvent" + } + }, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/TriggerSupportPackage.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/TriggerSupportPackage.json new file mode 100644 index 000000000000..2499251ec7b4 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/TriggerSupportPackage.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "triggerSupportPackageRequest": { + "properties": { + "minimumTimeStamp": "2018-12-18T02:18:51.4270267Z", + "maximumTimeStamp": "2018-12-18T02:19:51.4270267Z", + "include": "DefaultWithDumps" + } + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/UpdateDiagnosticProactiveLogCollectionSettings.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/UpdateDiagnosticProactiveLogCollectionSettings.json new file mode 100644 index 000000000000..6b55fbd544a1 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/UpdateDiagnosticProactiveLogCollectionSettings.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "proactiveLogCollectionSettings": { + "properties": { + "userConsent": "Enabled" + } + } + }, + "responses": { + "202": {}, + "200": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/UpdateDiagnosticRemoteSupportSettings.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/UpdateDiagnosticRemoteSupportSettings.json new file mode 100644 index 000000000000..26b2f27dca61 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/UpdateDiagnosticRemoteSupportSettings.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "diagnosticRemoteSupportSettings": { + "properties": { + "remoteSupportSettingsList": [ + { + "accessLevel": "ReadWrite", + "expirationTimeStampInUTC": "2021-07-07T00:00:00+00:00", + "remoteApplicationType": "Powershell" + } + ] + } + } + }, + "responses": { + "202": {}, + "200": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/UpdateSummaryGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/UpdateSummaryGet.json new file mode 100644 index 000000000000..d5f28b988241 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/UpdateSummaryGet.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "parameters": { + "properties": { + "certificate": "MIIC9DCCAdygAwIBAgIQWJae7GNjiI9Mcv/gJyrOPTANBgkqhkiG9w0BAQUFADASMRAwDgYDVQQDDAdXaW5kb3dzMB4XDTE4MTEyNzAwMTA0NVoXDTIxMTEyODAwMTA0NVowEjEQMA4GA1UEAwwHV2luZG93czCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKxkRExqxf0qH1avnyORptIbRC2yQwqe3EIbJ2FPKr5jtAppGeX/dGKrFSnX+7/0HFr77aJHafdpEAtOiLyJ4zCAVs0obZCCIq4qJdmjYUTU0UXH/w/YzXfQA0d9Zh9AN+NJBX9xj05NzgsT24fkgsK2v6mWJQXT7YcWAsl5sEYPnx1e+MrupNyVSL/RUJmrS+etJSysHtFeWRhsUhVAs1DD5ExJvBLU3WH0IsojEvpXcjrutB5/MDQNrd/StGI6WovoSSPH7FyT9tgERx+q+Yg3YUGzfaIPCctlrRGehcdtzdNoKd0rsX62yCq0U6POoSfwe22NJu41oAUMd7e6R8cCAwEAAaNGMEQwEwYDVR0lBAwwCgYIKwYBBQUHAwIwHQYDVR0OBBYEFDd0VxnS3LnMIfwc7xW4b4IZWG5GMA4GA1UdDwEB/wQEAwIFIDANBgkqhkiG9w0BAQUFAAOCAQEAPQRby2u9celvtvL/DLEb5Vt3/tPStRQC5MyTD62L5RT/q8E6EMCXVZNkXF5WlWucLJi/18tY+9PNgP9xWLJh7kpSWlWdi9KPtwMqKDlEH8L2TnQdjimt9XuiCrTnoFy/1X2BGLY/rCaUJNSd15QCkz2xeW+Z+YSk2GwAc/A/4YfNpqSIMfNuPrT76o02VdD9WmJUA3fS/HY0sU9qgQRS/3F5/0EPS+HYQ0SvXCK9tggcCd4O050ytNBMJC9qMOJ7yE0iOrFfOJSCfDAuPhn/rHFh79Kn1moF+/CE+nc0/2RPiLC8r54/rt5dYyyxJDfXg0a3VrrX39W69WZGW5OXiw==" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "deviceVersionNumber": "2.1.1377.2170", + "friendlyDeviceVersionName": "Azure Stack Edge 2010", + "deviceLastScannedDateTime": "2021-03-17T19:51:51.7864634Z", + "lastCompletedScanJobDateTime": "2021-03-17T19:47:46.1595547Z", + "lastDownloadJobStatus": "Invalid", + "lastInstallJobStatus": "Invalid", + "totalNumberOfUpdatesAvailable": 1, + "totalNumberOfUpdatesPendingDownload": 1, + "totalNumberOfUpdatesPendingInstall": 1, + "rebootBehavior": "NeverReboots", + "ongoingUpdateOperation": "Install", + "updateTitles": [ + "Azure Stack Edge Update 2101 Package 1 of 2 for Pro-GPU, Pro R, Mini R" + ], + "totalUpdateSizeInBytes": 4260898192.0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/updateSummary/default", + "name": "default", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/updateSummary" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/UploadCertificatePost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/UploadCertificatePost.json new file mode 100644 index 000000000000..952fe2483d84 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/UploadCertificatePost.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "parameters": { + "properties": { + "certificate": "MIIC9DCCAdygAwIBAgIQWJae7GNjiI9Mcv/gJyrOPTANBgkqhkiG9w0BAQUFADASMRAwDgYDVQQDDAdXaW5kb3dzMB4XDTE4MTEyNzAwMTA0NVoXDTIxMTEyODAwMTA0NVowEjEQMA4GA1UEAwwHV2luZG93czCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKxkRExqxf0qH1avnyORptIbRC2yQwqe3EIbJ2FPKr5jtAppGeX/dGKrFSnX+7/0HFr77aJHafdpEAtOiLyJ4zCAVs0obZCCIq4qJdmjYUTU0UXH/w/YzXfQA0d9Zh9AN+NJBX9xj05NzgsT24fkgsK2v6mWJQXT7YcWAsl5sEYPnx1e+MrupNyVSL/RUJmrS+etJSysHtFeWRhsUhVAs1DD5ExJvBLU3WH0IsojEvpXcjrutB5/MDQNrd/StGI6WovoSSPH7FyT9tgERx+q+Yg3YUGzfaIPCctlrRGehcdtzdNoKd0rsX62yCq0U6POoSfwe22NJu41oAUMd7e6R8cCAwEAAaNGMEQwEwYDVR0lBAwwCgYIKwYBBQUHAwIwHQYDVR0OBBYEFDd0VxnS3LnMIfwc7xW4b4IZWG5GMA4GA1UdDwEB/wQEAwIFIDANBgkqhkiG9w0BAQUFAAOCAQEAPQRby2u9celvtvL/DLEb5Vt3/tPStRQC5MyTD62L5RT/q8E6EMCXVZNkXF5WlWucLJi/18tY+9PNgP9xWLJh7kpSWlWdi9KPtwMqKDlEH8L2TnQdjimt9XuiCrTnoFy/1X2BGLY/rCaUJNSd15QCkz2xeW+Z+YSk2GwAc/A/4YfNpqSIMfNuPrT76o02VdD9WmJUA3fS/HY0sU9qgQRS/3F5/0EPS+HYQ0SvXCK9tggcCd4O050ytNBMJC9qMOJ7yE0iOrFfOJSCfDAuPhn/rHFh79Kn1moF+/CE+nc0/2RPiLC8r54/rt5dYyyxJDfXg0a3VrrX39W69WZGW5OXiw==" + } + } + }, + "responses": { + "200": { + "body": { + "authType": "AzureActiveDirectory", + "resourceId": "392799901267771", + "aadAuthority": "https://login.windows.net", + "aadTenantId": "100b019d-4626-4a9e-a83c-9cff8fe41909", + "servicePrincipalClientId": "ffd8a688-82b1-4e5a-a4c1-7ede8c928e68", + "servicePrincipalObjectId": "cef6d40c-24e6-4a6f-bb9e-3ec60b4adec4", + "azureManagementEndpointAudience": "https://wus-bvtgateway.ext.trafficmanager.net/" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/UserDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/UserDelete.json new file mode 100644 index 000000000000..c0aefe22cc21 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/UserDelete.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "user1", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/UserGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/UserGet.json new file mode 100644 index 000000000000..5e8536c2106e --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/UserGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "user1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "userType": "Share" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user1", + "name": "user1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users" + }, + "202": {} + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/UserGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/UserGetAllInDevice.json new file mode 100644 index 000000000000..3253fdb8b4e9 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/UserGetAllInDevice.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "userType": "Share" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2", + "name": "user2", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users" + }, + { + "properties": { + "userType": "Share" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user1", + "name": "user1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/UserPut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/UserPut.json new file mode 100644 index 000000000000..baae31c17b00 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2021-02-01/examples/UserPut.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "user1", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "user": { + "properties": { + "encryptedPassword": { + "value": "", + "encryptionAlgorithm": "None", + "encryptionCertThumbprint": "blah" + }, + "userType": "Share" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "userType": "Share" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user1", + "name": "user1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users" + } + }, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/readme.go.md b/specification/databoxedge/resource-manager/readme.go.md index 71d584f0938c..3d14d4742ba7 100644 --- a/specification/databoxedge/resource-manager/readme.go.md +++ b/specification/databoxedge/resource-manager/readme.go.md @@ -13,6 +13,7 @@ go: ```yaml $(go) && $(multiapi) batch: + - tag: package-2021-02-01 - tag: package-2021-02-01-preview - tag: package-2020-12-01 - tag: package-2020-09-01-preview @@ -22,6 +23,15 @@ batch: - tag: package-2019-07 - tag: package-2019-03 ``` +### Tag: package-2021-02-01 and go + +These settings apply only when `--tag=package-2021-02-01 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +```yaml $(tag) == 'package-2021-02-01' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2021-02-01/$(namespace) +``` + ### Tag: package-2021-02-01-preview and go These settings apply only when `--tag=package-2021-02-01-preview --go` is specified on the command line. diff --git a/specification/databoxedge/resource-manager/readme.java.md b/specification/databoxedge/resource-manager/readme.java.md index 78e86fdee112..54e9afc51679 100644 --- a/specification/databoxedge/resource-manager/readme.java.md +++ b/specification/databoxedge/resource-manager/readme.java.md @@ -16,6 +16,7 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-databoxedge ``` yaml $(java) && $(multiapi) batch: + - tag: package-2021-02-01 - tag: package-2021-02-01-preview - tag: package-2020-12-01 - tag: package-2020-09-01-preview @@ -26,6 +27,19 @@ batch: - tag: package-2019-03 ``` +### Tag: package-2021-02-01 and java + +These settings apply only when `--tag=package-2021-02-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2021-02-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.databoxedge.v2021_02-01 + output-folder: $(azure-libraries-for-java-folder)/sdk/databoxedge/mgmt-v2021_02-01 +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-2021-02-01-preview and java These settings apply only when `--tag=package-2021-02-01-preview --java` is specified on the command line. diff --git a/specification/databoxedge/resource-manager/readme.md b/specification/databoxedge/resource-manager/readme.md index 5c292a794298..a9f7610656a3 100644 --- a/specification/databoxedge/resource-manager/readme.md +++ b/specification/databoxedge/resource-manager/readme.md @@ -26,7 +26,15 @@ These are the global settings for the DataBox Edge API. ``` yaml openapi-type: arm -tag: package-2019-08 +tag: package-2021-02-01 +``` +### Tag: package-2021-02-01 + +These settings apply only when `--tag=package-2021-02-01` is specified on the command line. + +``` yaml $(tag) == 'package-2021-02-01' +input-file: +- Microsoft.DataBoxEdge/stable/2021-02-01/databoxedge.json ``` ### Tag: package-2021-02-01-preview diff --git a/specification/databoxedge/resource-manager/readme.python.md b/specification/databoxedge/resource-manager/readme.python.md index d76d355eb72a..b59477a0b3ac 100644 --- a/specification/databoxedge/resource-manager/readme.python.md +++ b/specification/databoxedge/resource-manager/readme.python.md @@ -33,6 +33,7 @@ Generate all API versions currently shipped for this package ```yaml $(python) && $(multiapi) && !$(track2) batch: + - tag: package-2021-02-01 - tag: package-2021-02-01-preview - tag: package-2020-12-01 - tag: package-2020-09-01-preview @@ -44,6 +45,7 @@ batch: ``` ```yaml $(python) && $(multiapi) && $(track2) batch: + - tag: package-2021-02-01 - tag: package-2021-02-01-preview - tag: package-2020-12-01 - tag: package-2020-09-01-preview @@ -60,6 +62,20 @@ output-folder: $(python-sdks-folder)/databoxedge/azure-mgmt-databoxedge/azure/mg clear-output-folder: false perform-load: false ``` +### Tag: package-2021-02-01 and python + +These settings apply only when `--tag=package-2021-02-01 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2021-02-01' && $(python) & !$(track2) +python: + namespace: azure.mgmt.databoxedge.v2021_02_01 + output-folder: $(python-sdks-folder)/databoxedge/azure-mgmt-databoxedge/azure/mgmt/databoxedge/v2021_02_01 +``` +``` yaml $(tag) == 'package-2021-02-01' && $(python) && $(track2) +namespace: azure.mgmt.databoxedge.v2021_02_01 +output-folder: $(python-sdks-folder)/databoxedge/azure-mgmt-databoxedge/azure/mgmt/databoxedge/v2021_02_01 +``` ### Tag: package-2021-02-01-preview and python These settings apply only when `--tag=package-2021-02-01-preview --python` is specified on the command line. diff --git a/specification/databoxedge/resource-manager/readme.ruby.md b/specification/databoxedge/resource-manager/readme.ruby.md index 10056e13b5f1..07ceb39a135c 100644 --- a/specification/databoxedge/resource-manager/readme.ruby.md +++ b/specification/databoxedge/resource-manager/readme.ruby.md @@ -12,6 +12,7 @@ azure-arm: true ``` yaml $(ruby) && $(multiapi) batch: + - tag: package-2021-02-01 - tag: package-2021-02-01-preview - tag: package-2020-12-01 - tag: package-2020-09-01-preview @@ -21,6 +22,16 @@ batch: - tag: package-2019-07 - tag: package-2019-03 ``` +### Tag: package-2021-02-01 and ruby + +These settings apply only when `--tag=package-2021-02-01 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2021-02-01' && $(ruby) +namespace: "Azure::DataBoxEdge::Mgmt::V2021_02-01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_databoxedge/lib +``` + ### Tag: package-2021-02-01-preview and ruby These settings apply only when `--tag=package-2021-02-01-preview --ruby` is specified on the command line. diff --git a/specification/databoxedge/resource-manager/readme.typescript.md b/specification/databoxedge/resource-manager/readme.typescript.md index 0f89c078b7d1..c7b3c3226394 100644 --- a/specification/databoxedge/resource-manager/readme.typescript.md +++ b/specification/databoxedge/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) && !$(profile) +``` yaml $(typescript) && !$(profile-content) typescript: azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION @@ -16,9 +16,9 @@ typescript: ### Profile: profile-hybrid-2020-09-01 -These settings apply only when `--profile=profile-hybrid-2020-09-01` is specified on the command line. +These settings apply only when `--profile-content=profile-hybrid-2020-09-01` is specified on the command line. -``` yaml $(profile)=='profile-hybrid-2020-09-01' +``` yaml $(profile-content)=='profile-hybrid-2020-09-01' typescript: package-name: "@azure/arm-databoxedge-profile-2020-09-01-hybrid" output-folder: "$(typescript-sdks-folder)/sdk/databoxedge/arm-databoxedge-profile-2020-09-01-hybrid" @@ -27,4 +27,4 @@ typescript: generate-metadata: true batch: - tag: profile-hybrid-2020-09-01 -``` \ No newline at end of file +``` diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/databricks.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/databricks.json new file mode 100644 index 000000000000..1612dadf6c8c --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/databricks.json @@ -0,0 +1,1598 @@ +{ + "swagger": "2.0", + "info": { + "title": "DatabricksClient", + "version": "2021-04-01-preview", + "description": "These APIs allow end users to operate on Azure Databricks Workspace resources." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}": { + "get": { + "tags": [ + "Workspaces" + ], + "operationId": "Workspaces_Get", + "description": "Gets the workspace.", + "x-ms-examples": { + "Get a workspace": { + "$ref": "./examples/WorkspaceGet.json" + }, + "Get a workspace with custom parameters": { + "$ref": "./examples/WorkspaceGetParameters.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Workspaces" + ], + "operationId": "Workspaces_Delete", + "description": "Deletes the workspace.", + "x-ms-examples": { + "Delete a workspace": { + "$ref": "./examples/WorkspaceDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "200": { + "description": "OK. The request has succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "Workspaces" + ], + "operationId": "Workspaces_CreateOrUpdate", + "description": "Creates a new workspace.", + "x-ms-examples": { + "Create or update workspace": { + "$ref": "./examples/WorkspaceCreate.json" + }, + "Create or update workspace with custom parameters": { + "$ref": "./examples/WorkspaceCreateWithParameters.json" + }, + "Create a workspace which is ready for Customer-Managed Key (CMK) encryption": { + "$ref": "./examples/PrepareEncryption.json" + }, + "Enable Customer-Managed Key (CMK) encryption on a workspace which is prepared for encryption": { + "$ref": "./examples/EnableEncryption.json" + }, + "Revert Customer-Managed Key (CMK) encryption to Microsoft Managed Keys encryption on a workspace": { + "$ref": "./examples/DisableEncryption.json" + } + }, + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Workspace" + }, + "description": "Parameters supplied to the create or update a workspace." + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Created - Returns information about the workspace, including provisioning status.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "201": { + "description": "Created - Returns information about the workspace, including provisioning status.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Workspaces" + ], + "operationId": "Workspaces_Update", + "description": "Updates a workspace.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspaceUpdate" + }, + "description": "The update to the workspace." + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a workspace's tags.": { + "$ref": "./examples/WorkspaceUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "operationId": "Workspaces_ListByResourceGroup", + "description": "Gets all the workspaces within a resource group.", + "x-ms-examples": { + "Lists workspaces": { + "$ref": "./examples/WorkspacesListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of workspaces.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Databricks/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "operationId": "Workspaces_ListBySubscription", + "description": "Gets all the workspaces within a subscription.", + "x-ms-examples": { + "Lists workspaces": { + "$ref": "./examples/WorkspacesListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of workspaces.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Databricks/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available RP operations.", + "x-ms-examples": { + "Operations": { + "$ref": "./examples/OperationsList.json" + } + }, + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/privateLinkResources": { + "get": { + "tags": [ + "GET" + ], + "summary": "List private link resources", + "description": "List private link resources for a given workspace", + "operationId": "PrivateLinkResources_List", + "x-ms-examples": { + "List private link resources": { + "$ref": "./examples/ListPrivateLinkResources.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of private link resources", + "schema": { + "$ref": "#/definitions/PrivateLinkResourcesList" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/privateLinkResources/{groupId}": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the specified private link resource", + "description": "Get the specified private link resource for the given group id (sub-resource)", + "operationId": "PrivateLinkResources_Get", + "x-ms-examples": { + "Get a private link resource": { + "$ref": "./examples/PrivateLinkResourcesGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/GroupId" + } + ], + "responses": { + "200": { + "description": "OK - Returns the specified of private link resource", + "schema": { + "$ref": "#/definitions/GroupIdInformation" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/privateEndpointConnections": { + "get": { + "tags": [ + "GET" + ], + "summary": "List private endpoint connections", + "description": "List private endpoint connections of the workspace", + "operationId": "PrivateEndpointConnections_List", + "x-ms-examples": { + "List private endpoint connections": { + "$ref": "./examples/ListPrivateEndpointConnections.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns list of private endpoint connections for a workspace", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionsList" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get private endpoint connection", + "description": "Get a private endpoint connection properties for a workspace", + "operationId": "PrivateEndpointConnections_Get", + "x-ms-examples": { + "Get a private endpoint connection": { + "$ref": "./examples/PrivateEndpointConnectionsGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "OK - Returns the private endpoint connection properties of a workspace", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "PUT" + ], + "summary": "Update private endpoint connection status", + "description": "Update the status of a private endpoint connection with the specified name", + "operationId": "PrivateEndpointConnections_Create", + "x-ms-examples": { + "Update a private endpoint connection": { + "$ref": "./examples/PrivateEndpointConnectionsUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "name": "privateEndpointConnection", + "in": "body", + "description": "The private endpoint connection with updated properties", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "OK -- Update the private endpoint connection properties successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "202": { + "description": "Accepted - This is a long running operation. The operation returns a 202 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "DELETE" + ], + "summary": "Remove private endpoint connection", + "description": "Remove private endpoint connection with the specified name", + "operationId": "PrivateEndpointConnections_Delete", + "x-ms-examples": { + "Remove a private endpoint connection": { + "$ref": "./examples/PrivateEndpointConnectionsDelete.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "202": { + "description": "Accepted - This is a long running operation. The operation returns a 202 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation." + }, + "200": { + "description": "OK - Returns the status of polling request for the delete operation." + }, + "204": { + "description": "No Content - PrivateEndpoint does not exist." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "Workspace": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkspaceProperties", + "description": "The workspace properties." + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU of the resource." + }, + "systemData": { + "description": "The system metadata relating to this resource", + "type": "object", + "readOnly": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "description": "Information about workspace." + }, + "WorkspaceProperties": { + "properties": { + "managedResourceGroupId": { + "type": "string", + "description": "The managed resource group Id." + }, + "parameters": { + "$ref": "#/definitions/WorkspaceCustomParameters", + "description": "The workspace's custom parameters." + }, + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState", + "description": "The workspace provisioning state." + }, + "uiDefinitionUri": { + "type": "string", + "description": "The blob URI where the UI definition file is located." + }, + "authorizations": { + "description": "The workspace provider authorizations.", + "type": "array", + "items": { + "$ref": "#/definitions/WorkspaceProviderAuthorization" + } + }, + "createdBy": { + "description": "Indicates the Object ID, PUID and Application ID of entity that created the workspace.", + "$ref": "#/definitions/CreatedBy" + }, + "updatedBy": { + "description": "Indicates the Object ID, PUID and Application ID of entity that last updated the workspace.", + "$ref": "#/definitions/CreatedBy" + }, + "createdDateTime": { + "description": "Specifies the date and time when the workspace is created.", + "$ref": "#/definitions/CreatedDateTime" + }, + "workspaceId": { + "readOnly": true, + "description": "The unique identifier of the databricks workspace in databricks control plane.", + "type": "string" + }, + "workspaceUrl": { + "readOnly": true, + "description": "The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net'", + "type": "string" + }, + "storageAccountIdentity": { + "description": "The details of Managed Identity of Storage Account", + "$ref": "#/definitions/ManagedIdentityConfiguration" + }, + "encryption": { + "type": "object", + "description": "Encryption properties for databricks workspace", + "properties": { + "entities": { + "$ref": "#/definitions/EncryptionEntitiesDefinition", + "description": "Encryption entities definition for the workspace." + } + }, + "required": [ + "entities" + ] + }, + "privateEndpointConnections": { + "readOnly": true, + "description": "Private endpoint connections created on the workspace", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "publicNetworkAccess": { + "type": "string", + "description": "The network access type for accessing workspace. Set value to disabled to access workspace only via private link.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "PublicNetworkAccess" + } + }, + "requiredNsgRules": { + "type": "string", + "description": "Gets or sets a value indicating whether data plane (clusters) to control plane communication happen over private endpoint. Supported values are 'AllRules' and 'NoAzureDatabricksRules'. 'NoAzureServiceRules' value is for internal use only.", + "enum": [ + "AllRules", + "NoAzureDatabricksRules", + "NoAzureServiceRules" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "RequiredNsgRules" + } + } + }, + "required": [ + "managedResourceGroupId" + ], + "description": "The workspace properties." + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + } + }, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "Resource": { + "description": "The core properties of ARM resources", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts." + } + }, + "x-ms-azure-resource": true + }, + "Sku": { + "properties": { + "name": { + "type": "string", + "description": "The SKU name." + }, + "tier": { + "type": "string", + "description": "The SKU tier." + } + }, + "required": [ + "name" + ], + "description": "SKU for the resource." + }, + "ProvisioningState": { + "description": "Provisioning status of the workspace.", + "readOnly": true, + "enum": [ + "Accepted", + "Running", + "Ready", + "Creating", + "Created", + "Deleting", + "Deleted", + "Canceled", + "Failed", + "Succeeded", + "Updating" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "PeeringProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Updating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PeeringProvisioningState", + "modelAsString": true + } + }, + "ManagedIdentityConfiguration": { + "description": "The Managed Identity details for storage account.", + "properties": { + "principalId": { + "type": "string", + "format": "uuid", + "description": "The objectId of the Managed Identity that is linked to the Managed Storage account.", + "readOnly": true + }, + "tenantId": { + "type": "string", + "format": "uuid", + "description": "The tenant Id where the Managed Identity is created.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "The type of Identity created. It can be either SystemAssigned or UserAssigned.", + "readOnly": true + } + } + }, + "WorkspaceCustomParameterType": { + "description": "Provisioning status of the workspace.", + "readOnly": true, + "enum": [ + "Bool", + "Object", + "String" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomParameterType", + "modelAsString": true + } + }, + "WorkspaceCustomBooleanParameter": { + "properties": { + "type": { + "$ref": "#/definitions/WorkspaceCustomParameterType", + "description": "The type of variable that this is" + }, + "value": { + "type": "boolean", + "description": "The value which should be used for this field." + } + }, + "required": [ + "value" + ], + "description": "The value which should be used for this field." + }, + "WorkspaceCustomObjectParameter": { + "properties": { + "type": { + "$ref": "#/definitions/WorkspaceCustomParameterType", + "description": "The type of variable that this is" + }, + "value": { + "type": "object", + "description": "The value which should be used for this field." + } + }, + "required": [ + "value" + ], + "description": "The value which should be used for this field." + }, + "WorkspaceCustomStringParameter": { + "properties": { + "type": { + "$ref": "#/definitions/WorkspaceCustomParameterType", + "description": "The type of variable that this is" + }, + "value": { + "type": "string", + "description": "The value which should be used for this field." + } + }, + "required": [ + "value" + ], + "description": "The Value." + }, + "WorkspaceCustomParameters": { + "properties": { + "amlWorkspaceId": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "The ID of a Azure Machine Learning workspace to link with Databricks workspace" + }, + "customVirtualNetworkId": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "The ID of a Virtual Network where this Databricks Cluster should be created" + }, + "customPublicSubnetName": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "The name of a Public Subnet within the Virtual Network" + }, + "customPrivateSubnetName": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "The name of the Private Subnet within the Virtual Network" + }, + "enableNoPublicIp": { + "$ref": "#/definitions/WorkspaceCustomBooleanParameter", + "description": "Should the Public IP be Disabled?" + }, + "loadBalancerBackendPoolName": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "Name of the outbound Load Balancer Backend Pool for Secure Cluster Connectivity (No Public IP)." + }, + "loadBalancerId": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "Resource URI of Outbound Load balancer for Secure Cluster Connectivity (No Public IP) workspace." + }, + "natGatewayName": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "Name of the NAT gateway for Secure Cluster Connectivity (No Public IP) workspace subnets." + }, + "publicIpName": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "Name of the Public IP for No Public IP workspace with managed vNet." + }, + "prepareEncryption": { + "$ref": "#/definitions/WorkspaceCustomBooleanParameter", + "description": "Prepare the workspace for encryption. Enables the Managed Identity for managed storage account." + }, + "encryption": { + "$ref": "#/definitions/WorkspaceEncryptionParameter", + "description": "Contains the encryption details for Customer-Managed Key (CMK) enabled workspace." + }, + "requireInfrastructureEncryption": { + "$ref": "#/definitions/WorkspaceCustomBooleanParameter", + "description": "A boolean indicating whether or not the DBFS root file system will be enabled with secondary layer of encryption with platform managed keys for data at rest." + }, + "storageAccountName": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "Default DBFS storage account name." + }, + "storageAccountSkuName": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "Storage account SKU name, ex: Standard_GRS, Standard_LRS. Refer https://aka.ms/storageskus for valid inputs." + }, + "vnetAddressPrefix": { + "$ref": "#/definitions/WorkspaceCustomStringParameter", + "description": "Address prefix for Managed virtual network. Default value for this input is 10.139." + }, + "resourceTags": { + "$ref": "#/definitions/WorkspaceCustomObjectParameter", + "readOnly": true, + "description": "Tags applied to resources under Managed resource group. These can be updated by updating tags at workspace level." + } + }, + "description": "Custom Parameters used for Cluster Creation." + }, + "CreatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The date and time stamp when the workspace was created.", + "readOnly": true + }, + "CreatedBy": { + "properties": { + "oid": { + "type": "string", + "format": "uuid", + "description": "The Object ID that created the workspace.", + "readOnly": true + }, + "puid": { + "type": "string", + "description": "The Personal Object ID corresponding to the object ID above", + "readOnly": true + }, + "applicationId": { + "type": "string", + "format": "uuid", + "description": "The application ID of the application that initiated the creation of the workspace. For example, Azure Portal.", + "readOnly": true + } + }, + "description": "Provides details of the entity that created/updated the workspace." + }, + "WorkspaceEncryptionParameter": { + "properties": { + "type": { + "$ref": "#/definitions/WorkspaceCustomParameterType", + "description": "The type of variable that this is" + }, + "value": { + "$ref": "#/definitions/Encryption", + "description": "The value which should be used for this field." + } + }, + "description": "The object that contains details of encryption used on the workspace." + }, + "Encryption": { + "properties": { + "keySource": { + "type": "string", + "description": "The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault", + "enum": [ + "Default", + "Microsoft.Keyvault" + ], + "x-ms-enum": { + "name": "KeySource", + "modelAsString": true + }, + "default": "Default" + }, + "KeyName": { + "type": "string", + "description": "The name of KeyVault key." + }, + "keyversion": { + "type": "string", + "description": "The version of KeyVault key.", + "x-ms-client-name": "KeyVersion" + }, + "keyvaulturi": { + "type": "string", + "description": "The Uri of KeyVault.", + "x-ms-client-name": "KeyVaultUri" + } + }, + "description": "The object that contains details of encryption used on the workspace." + }, + "EncryptionEntitiesDefinition": { + "properties": { + "managedServices": { + "type": "object", + "description": "Encryption properties for the databricks managed services.", + "$ref": "#/definitions/EncryptionV2" + } + }, + "description": "Encryption entities for databricks workspace resource." + }, + "EncryptionV2": { + "properties": { + "keySource": { + "type": "string", + "description": "The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault", + "enum": [ + "Microsoft.Keyvault" + ], + "x-ms-enum": { + "name": "EncryptionKeySource", + "modelAsString": true + } + }, + "keyVaultProperties": { + "properties": { + "keyVaultUri": { + "type": "string", + "description": "The Uri of KeyVault." + }, + "keyName": { + "type": "string", + "description": "The name of KeyVault key." + }, + "keyVersion": { + "type": "string", + "description": "The version of KeyVault key." + } + }, + "required": [ + "keyVaultUri", + "keyName", + "keyVersion" + ], + "description": "Key Vault input properties for encryption." + } + }, + "required": [ + "keySource" + ], + "description": "The object that contains details of encryption used on the workspace." + }, + "WorkspaceProviderAuthorization": { + "properties": { + "principalId": { + "type": "string", + "format": "uuid", + "description": "The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources." + }, + "roleDefinitionId": { + "type": "string", + "format": "uuid", + "description": "The provider's role definition identifier. This role will define all the permissions that the provider must have on the workspace's container resource group. This role definition cannot have permission to delete the resource group." + } + }, + "required": [ + "principalId", + "roleDefinitionId" + ], + "description": "The workspace provider authorization." + }, + "WorkspaceUpdate": { + "description": "An update to a workspace.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ErrorDetail": { + "title": "Error details.", + "type": "object", + "properties": { + "code": { + "description": "The error's code.", + "type": "string" + }, + "message": { + "description": "A human readable error message.", + "type": "string" + }, + "target": { + "description": "Indicates which property in the request is responsible for the error.", + "type": "string" + } + }, + "required": [ + "code", + "message" + ] + }, + "ErrorInfo": { + "title": "The code and message for an error.", + "type": "object", + "properties": { + "code": { + "description": "A machine readable error code.", + "type": "string" + }, + "message": { + "description": "A human readable error message.", + "type": "string" + }, + "details": { + "description": "error details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetail" + } + }, + "innererror": { + "description": "Inner error details if they exist.", + "type": "string" + } + }, + "required": [ + "code", + "message" + ] + }, + "ErrorResponse": { + "title": "Error response.", + "description": "Contains details when the response code indicates an error.", + "type": "object", + "properties": { + "error": { + "description": "The error details.", + "$ref": "#/definitions/ErrorInfo" + } + }, + "required": [ + "error" + ] + }, + "WorkspaceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Workspace" + }, + "description": "The array of workspaces." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "List of workspaces." + }, + "Operation": { + "description": "REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft.ResourceProvider", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "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 Resource Provider operations supported by the Resource Provider resource provider." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "PrivateLinkResourcesList": { + "description": "The available private link resources for a workspace", + "type": "object", + "properties": { + "value": { + "description": "The list of available private link resources for a workspace", + "type": "array", + "items": { + "$ref": "#/definitions/GroupIdInformation" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of private link resources." + } + } + }, + "GroupIdInformation": { + "description": "The group information for creating a private endpoint on a workspace", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "description": "The group id properties.", + "type": "object", + "x-ms-client-flatten": false, + "$ref": "#/definitions/GroupIdInformationProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "properties" + ] + }, + "GroupIdInformationProperties": { + "description": "The properties for a group information object", + "type": "object", + "properties": { + "groupId": { + "type": "string", + "description": "The group id" + }, + "requiredMembers": { + "description": "The required members for a specific group id", + "type": "array", + "items": { + "type": "string" + } + }, + "requiredZoneNames": { + "description": "The required DNS zones for a specific group id", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PrivateEndpointConnectionsList": { + "description": "List of private link connections.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The list of returned private endpoint connection." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of endpoint connections." + } + } + }, + "PrivateEndpointConnection": { + "description": "The private endpoint connection of a workspace", + "x-ms-azure-resource": true, + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "type": "object", + "description": "The private endpoint connection properties.", + "x-ms-client-flatten": false, + "$ref": "#/definitions/PrivateEndpointConnectionProperties" + } + }, + "required": [ + "properties" + ] + }, + "PrivateEndpointConnectionProperties": { + "description": "The properties of a private endpoint connection", + "type": "object", + "properties": { + "privateEndpoint": { + "title": "Private endpoint", + "description": "Private endpoint", + "$ref": "#/definitions/PrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "title": "Private link service service connection state", + "description": "Private endpoint connection state", + "$ref": "#/definitions/PrivateLinkServiceConnectionState" + }, + "provisioningState": { + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState", + "description": "Provisioning state of the private endpoint connection." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpoint": { + "description": "The private endpoint property of a private endpoint connection", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "The current state of a private endpoint connection", + "type": "object", + "properties": { + "status": { + "description": "The status of a private endpoint connection", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateLinkServiceConnectionStatus", + "modelAsString": true + } + }, + "description": { + "type": "string", + "description": "The description for the current state of a private endpoint connection" + }, + "actionRequired": { + "type": "string", + "description": "Actions required for a private endpoint connection" + } + }, + "required": [ + "status" + ] + }, + "PrivateEndpointConnectionProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Updating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the target subscription." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for this operation." + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "WorkspaceName": { + "name": "workspaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the workspace.", + "minLength": 3, + "maxLength": 64, + "x-ms-parameter-location": "method" + }, + "PeeringNameParameter": { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the workspace vNet peering.", + "x-ms-parameter-location": "method" + }, + "GroupId": { + "name": "groupId", + "in": "path", + "description": "The name of the private link resource", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "PrivateEndpointConnectionName": { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/DisableEncryption.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/DisableEncryption.json new file mode 100644 index 000000000000..9bdf25502922 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/DisableEncryption.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2021-04-01-preview", + "parameters": { + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": { + "encryption": { + "value": { + "keySource": "Default" + } + } + } + }, + "location": "westus" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "sku": { + "name": "premium" + }, + "location": "East US 2", + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": { + "customPrivateSubnetName": { + "type": "String", + "value": "PrivateBob" + }, + "customPublicSubnetName": { + "type": "String", + "value": "PublicSarah" + }, + "customVirtualNetworkId": { + "type": "String", + "value": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork" + }, + "prepareEncryption": { + "type": "Bool", + "value": true + }, + "encryption": { + "type": "Object", + "value": { + "keySource": "Default" + } + } + }, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "storageAccountIdentity": { + "principalId": "55555555-5555-5555-5555-555555555555", + "tenantId": "66666666-6666-6666-6666-666666666666", + "type": "SystemAssigned" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net" + } + } + }, + "201": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": { + "environment": "dev" + }, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "provisioningState": "Accepted", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "storageAccountIdentity": { + "principalId": "55555555-5555-5555-5555-555555555555", + "tenantId": "66666666-6666-6666-6666-666666666666", + "type": "SystemAssigned" + } + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/EnableEncryption.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/EnableEncryption.json new file mode 100644 index 000000000000..8efea04befb9 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/EnableEncryption.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2021-04-01-preview", + "parameters": { + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": { + "prepareEncryption": { + "value": true + }, + "encryption": { + "value": { + "keySource": "Microsoft.Keyvault", + "keyvaulturi": "https://myKeyVault.vault.azure.net/", + "KeyName": "myKeyName", + "keyversion": "00000000000000000000000000000000" + } + } + } + }, + "location": "westus" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "sku": { + "name": "premium" + }, + "location": "East US 2", + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": { + "customPrivateSubnetName": { + "type": "String", + "value": "PrivateBob" + }, + "customPublicSubnetName": { + "type": "String", + "value": "PublicSarah" + }, + "customVirtualNetworkId": { + "type": "String", + "value": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork" + }, + "prepareEncryption": { + "type": "Bool", + "value": true + }, + "encryption": { + "type": "Object", + "value": { + "keySource": "Microsoft.Keyvault", + "keyvaulturi": "https://myKeyVault.vault.azure.net/", + "KeyName": "myKeyName", + "keyversion": "00000000000000000000000000000000" + } + } + }, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "storageAccountIdentity": { + "principalId": "55555555-5555-5555-5555-555555555555", + "tenantId": "66666666-6666-6666-6666-666666666666", + "type": "SystemAssigned" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net" + } + } + }, + "201": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": { + "environment": "dev" + }, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "provisioningState": "Accepted", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "storageAccountIdentity": { + "principalId": "55555555-5555-5555-5555-555555555555", + "tenantId": "66666666-6666-6666-6666-666666666666", + "type": "SystemAssigned" + } + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/ListPrivateEndpointConnections.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/ListPrivateEndpointConnections.json new file mode 100644 index 000000000000..98612810f524 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/ListPrivateEndpointConnections.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "workspaceName": "myWorkspace", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-04-01", + "subscriptionId": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myResourceGroup/providers/Microsoft.Databricks/workspaces/myWorkspace/PrivateEndpointConnections/myWorkspace.23456789-1111-1111-1111-111111111111", + "name": "myWorkspace.23456789-1111-1111-1111-111111111111", + "type": "Microsoft.Databricks/workspaces/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@company.com", + "actionRequired": "None" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/ListPrivateLinkResources.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/ListPrivateLinkResources.json new file mode 100644 index 000000000000..fc61ada36658 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/ListPrivateLinkResources.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "workspaceName": "myWorkspace", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-04-01", + "subscriptionId": "11111111-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myResourceGroup/providers/Microsoft.Databricks/workspaces/myWorkspace/PrivateLinkResources/databricks_ui_api", + "name": "databricks_ui_api", + "type": "Microsoft.Databricks/workspaces/PrivateLinkResources", + "properties": { + "groupId": "databricks_ui_api", + "requiredMembers": [ + "databricks_ui_api" + ], + "requiredZoneNames": [ + "privatelink.azuredatabricks.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/OperationsList.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/OperationsList.json new file mode 100644 index 000000000000..a49a86936313 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/OperationsList.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2021-04-01-preview" + }, + "responses": { + "200": { + "body": [ + { + "name": "Microsoft.Databricks/workspaces/read", + "display": { + "provider": "Microsoft Databricks", + "resource": "Workspace", + "operation": "List Workspaces", + "description": "Retrieves a list of workspaces." + } + }, + { + "name": "Microsoft.Databricks/workspaces/write", + "display": { + "provider": "Microsoft Databricks", + "resource": "Workspace", + "operation": "Create Workspace", + "description": "Creates an workspace." + } + }, + { + "name": "Microsoft.Databricks/workspaces/delete", + "display": { + "provider": "Microsoft Databricks", + "resource": "Workspace", + "operation": "Remove Workspace", + "description": "Removes an workspace." + } + }, + { + "name": "Microsoft.Databricks/workspaces/virtualNetworkPeerings/read", + "display": { + "provider": "Microsoft Databricks", + "resource": "Virtual Network Peering", + "operation": "Get Virtual Network Peering", + "description": "Gets the virtual network peering." + } + }, + { + "name": "Microsoft.Databricks/workspaces/virtualNetworkPeerings/write", + "display": { + "provider": "Microsoft Databricks", + "resource": "Virtual Network Peering", + "operation": "Add Virtual Network Peering", + "description": "Add or modify virtual network peering" + } + }, + { + "name": "Microsoft.Databricks/workspaces/virtualNetworkPeerings/delete", + "display": { + "provider": "Microsoft Databricks", + "resource": "Virtual Network Peering", + "operation": "Delete Virtual Network Peering", + "description": "Deletes a virtual network peering" + } + }, + { + "name": "Microsoft.Databricks/workspaces/PrivateLinkResources/read", + "display": { + "provider": "Microsoft Databricks", + "resource": "Private Link Resources", + "operation": "List Private Link Resources", + "description": "Retrieve List of Private Link Resources" + } + }, + { + "name": "Microsoft.Databricks/workspaces/PrivateEndpointConnections/read", + "display": { + "provider": "Microsoft Databricks", + "resource": "Private Endpoint Connection", + "operation": "List Private Endpoint Connections", + "description": "Retrieve List of Private Endpoint Connections" + } + }, + { + "name": "Microsoft.Databricks/workspaces/PrivateEndpointConnections/write", + "display": { + "provider": "Microsoft Databricks", + "resource": "Private Endpoint Connection", + "operation": "Update Private Endpoint Connection", + "description": "Update a virtual network peering" + } + }, + { + "name": "Microsoft.Databricks/workspaces/PrivateEndpointConnections/delete", + "display": { + "provider": "Microsoft Databricks", + "resource": "Private Endpoint Connection", + "operation": "Delete Private Endpoint Connection", + "description": "Delete a Private Endpoint Connection" + } + } + ] + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/PrepareEncryption.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/PrepareEncryption.json new file mode 100644 index 000000000000..8c4b7507e315 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/PrepareEncryption.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2021-04-01-preview", + "parameters": { + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": { + "prepareEncryption": { + "value": true + } + } + }, + "location": "westus" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "sku": { + "name": "premium" + }, + "location": "East US 2", + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": null, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "storageAccountIdentity": { + "principalId": "55555555-5555-5555-5555-555555555555", + "tenantId": "66666666-6666-6666-6666-666666666666", + "type": "SystemAssigned" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net" + } + } + }, + "201": { + "body": { + "name": "myWorkspace", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": { + "environment": "dev" + }, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": null, + "provisioningState": "Accepted", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z" + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/PrivateEndpointConnectionsDelete.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/PrivateEndpointConnectionsDelete.json new file mode 100644 index 000000000000..c1163754e82a --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/PrivateEndpointConnectionsDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "workspaceName": "myWorkspace", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-04-01", + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "privateEndpointConnectionName": "myWorkspace.23456789-1111-1111-1111-111111111111" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/PrivateEndpointConnectionsGet.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/PrivateEndpointConnectionsGet.json new file mode 100644 index 000000000000..1848c15d34a5 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/PrivateEndpointConnectionsGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "workspaceName": "myWorkspace", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-04-01", + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "privateEndpointConnectionName": "myWorkspace.23456789-1111-1111-1111-111111111111" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myResourceGroup/providers/Microsoft.Databricks/workspaces/myWorkspace/PrivateEndpointConnections/myWorkspace.23456789-1111-1111-1111-111111111111", + "name": "myWorkspace.23456789-1111-1111-1111-111111111111", + "type": "Microsoft.Databricks/workspaces/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my request!", + "actionRequired": "None" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/PrivateEndpointConnectionsUpdate.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/PrivateEndpointConnectionsUpdate.json new file mode 100644 index 000000000000..a3960ca636bf --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/PrivateEndpointConnectionsUpdate.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "workspaceName": "myWorkspace", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-04-01", + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "privateEndpointConnectionName": "myWorkspace.23456789-1111-1111-1111-111111111111", + "privateEndpointConnection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by databricksadmin@contoso.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myResourceGroup/providers/Microsoft.Databricks/workspaces/myWorkspace/PrivateEndpointConnections/myWorkspace.23456789-1111-1111-1111-111111111111", + "name": "myWorkspace.23456789-1111-1111-1111-111111111111", + "type": "Microsoft.Databricks/workspaces/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by databricksadmin@contoso.com", + "actionRequired": "None" + }, + "provisioningState": "Succeeded" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myResourceGroup/providers/Microsoft.Databricks/workspaces/myWorkspace/PrivateEndpointConnections/myWorkspace.23456789-1111-1111-1111-111111111111", + "name": "myWorkspace.23456789-1111-1111-1111-111111111111", + "type": "Microsoft.Databricks/workspaces/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by databricksadmin@contoso.com", + "actionRequired": "None" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/PrivateLinkResourcesGet.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/PrivateLinkResourcesGet.json new file mode 100644 index 000000000000..b4651f2cfd5e --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/PrivateLinkResourcesGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "resourceGroupName": "myResourceGroup", + "workspaceName": "myWorkspace", + "api-version": "2018-04-01", + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "groupId": "databricks_ui_api" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myResourceGroup/providers/Microsoft.Databricks/workspaces/myWorkspace/PrivateLinkResources/databricks_ui_api", + "name": "databricks_ui_api", + "type": "Microsoft.Databricks/workspaces/PrivateLinkResources", + "properties": { + "groupId": "databricks_ui_api", + "requiredMembers": [ + "databricks_ui_api" + ], + "requiredZoneNames": [ + "privatelink.azuredatabricks.net" + ] + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/WorkspaceCreate.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/WorkspaceCreate.json new file mode 100644 index 000000000000..d6c4dd1e3514 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/WorkspaceCreate.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2021-04-01-preview", + "parameters": { + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": null, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": null, + "provisioningState": "Accepted", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net" + } + } + }, + "201": { + "body": { + "name": "myWorkspace", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": { + "environment": "dev" + }, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": null, + "provisioningState": "Accepted", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z" + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/WorkspaceCreateWithParameters.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/WorkspaceCreateWithParameters.json new file mode 100644 index 000000000000..ce768155ba8d --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/WorkspaceCreateWithParameters.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2021-04-01-preview", + "parameters": { + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": { + "customVirtualNetworkId": { + "value": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork" + }, + "customPublicSubnetName": { + "value": "myPublicSubnet" + }, + "customPrivateSubnetName": { + "value": "myPrivateSubnet" + } + } + }, + "location": "westus" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": null, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": { + "customPrivateSubnetName": { + "type": "String", + "value": "myPrivateSubnet" + }, + "customPublicSubnetName": { + "type": "String", + "value": "myPublicSubnet" + }, + "customVirtualNetworkId": { + "type": "String", + "value": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork" + } + }, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net" + } + } + }, + "201": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": { + "environment": "dev" + }, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "provisioningState": "Accepted", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z" + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/WorkspaceDelete.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/WorkspaceDelete.json new file mode 100644 index 000000000000..05af344d0daf --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/WorkspaceDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "workspaceName": "myWorkspace", + "resourceGroupName": "rg", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/WorkspaceGet.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/WorkspaceGet.json new file mode 100644 index 000000000000..2f539e15a822 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/WorkspaceGet.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2021-04-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "sku": { + "name": "premium" + }, + "location": "East US 2", + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": null, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net" + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/WorkspaceGetParameters.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/WorkspaceGetParameters.json new file mode 100644 index 000000000000..4303393227fd --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/WorkspaceGetParameters.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2021-04-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": { + "customPrivateSubnetName": { + "type": "String", + "value": "PrivateBob" + }, + "customPublicSubnetName": { + "type": "String", + "value": "PublicSarah" + }, + "customVirtualNetworkId": { + "type": "String", + "value": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork" + } + }, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net", + "privateEndpointConnections": [ + { + "id": "/subscriptions/subscriptionId/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace/privateEndpointConnections/myWorkspace.23456789-1111-1111-1111-111111111111", + "name": "myWorkspace.23456789-1111-1111-1111-111111111111", + "type": "Microsoft.Databricks/workspaces/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subscriptionId/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionRequired": "None" + }, + "provisioningState": "Succeeded" + } + } + ], + "publicNetworkAccess": "Disabled", + "requiredNsgRules": "NoAzureDatabricksRules" + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/WorkspaceUpdate.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/WorkspaceUpdate.json new file mode 100644 index 000000000000..8ff14cad25a2 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/WorkspaceUpdate.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2021-04-01-preview", + "parameters": { + "tags": { + "mytag1": "myvalue1" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": { + "mytag1": "myvalue1" + }, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": null, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "6666666666666666", + "workspaceUrl": "adb-6666666666666666.19.azuredatabricks.net" + } + } + }, + "202": {} + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/WorkspacesListByResourceGroup.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/WorkspacesListByResourceGroup.json new file mode 100644 index 000000000000..6463c44a9940 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/WorkspacesListByResourceGroup.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "api-version": "2021-04-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "myWorkspace1", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace1", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": null, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": null, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net" + } + }, + { + "name": "myWorkspace2", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace2", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": null, + "sku": { + "name": "standard" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": null, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "6666666666666666", + "workspaceUrl": "adb-6666666666666666.19.azuredatabricks.net" + } + } + ] + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/WorkspacesListBySubscription.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/WorkspacesListBySubscription.json new file mode 100644 index 000000000000..45eb4534bde9 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2021-04-01-preview/examples/WorkspacesListBySubscription.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2021-04-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "myWorkspace1", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace1", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": null, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": null, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net" + } + }, + { + "name": "myWorkspace2", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace2", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": null, + "sku": { + "name": "standard" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": null, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "6666666666666666", + "workspaceUrl": "adb-6666666666666666.19.azuredatabricks.net" + } + } + ] + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/databricks.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/databricks.json index 52958f7bfee4..c0472ec55aad 100644 --- a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/databricks.json +++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/databricks.json @@ -325,205 +325,6 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/virtualNetworkPeerings/{peeringName}": { - "get": { - "tags": [ - "vNetPeering" - ], - "operationId": "vNetPeering_Get", - "description": "Gets the workspace vNet Peering.", - "x-ms-examples": { - "Get a workspace with vNet Peering Configured": { - "$ref": "./examples/WorkspaceVirtualNetPeeringGet.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/PeeringNameParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/VirtualNetworkPeering" - } - }, - "204": { - "description": "OK - NoContent" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "vNetPeering" - ], - "operationId": "vNetPeering_Delete", - "description": "Deletes the workspace vNetPeering.", - "x-ms-examples": { - "Delete a workspace vNet Peering": { - "$ref": "./examples/WorkspaceVirtualNetworkPeeringDelete.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/PeeringNameParameter" - } - ], - "responses": { - "202": { - "description": "Accepted - Returns this status until the asynchronous operation has completed." - }, - "204": { - "description": "NoContent" - }, - "200": { - "description": "OK. The request has succeeded." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - }, - "put": { - "tags": [ - "vNetPeering" - ], - "operationId": "vNetPeering_CreateOrUpdate", - "description": "Creates vNet Peering for workspace.", - "x-ms-examples": { - "Create vNet Peering for Workspace": { - "$ref": "./examples/WorkspaceVirtualNetworkPeeringCreateOrUpdate.json" - } - }, - "parameters": [ - { - "name": "VirtualNetworkPeeringParameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/VirtualNetworkPeering" - }, - "description": "Parameters supplied to the create workspace vNet Peering." - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/PeeringNameParameter" - } - ], - "responses": { - "201": { - "description": "Created - Returns information about the workspace vNet peering, including provisioning status.", - "schema": { - "$ref": "#/definitions/VirtualNetworkPeering" - } - }, - "200": { - "description": "Update succeeded - Returns information about the workspace vNet peering.", - "schema": { - "$ref": "#/definitions/VirtualNetworkPeering" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/virtualNetworkPeerings": { - "get": { - "tags": [ - "vNetPeering" - ], - "operationId": "vNetPeering_ListByWorkspace", - "description": "Lists the workspace vNet Peerings.", - "x-ms-examples": { - "List all vNet Peerings for the workspace": { - "$ref": "./examples/WorkspaceVirtualNetPeeringList.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "List succeeded. Returns the resulting resource objects in response body.", - "schema": { - "$ref": "#/definitions/VirtualNetworkPeeringList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, "/providers/Microsoft.Databricks/operations": { "get": { "tags": [ @@ -734,21 +535,6 @@ "modelAsString": true } }, - "PeeringProvisioningState": { - "type": "string", - "readOnly": true, - "description": "The current provisioning state.", - "enum": [ - "Succeeded", - "Updating", - "Deleting", - "Failed" - ], - "x-ms-enum": { - "name": "PeeringProvisioningState", - "modelAsString": true - } - }, "ManagedIdentityConfiguration": { "description": "The Managed Identity details for storage account.", "properties": { @@ -1131,132 +917,6 @@ "description": "URL to get the next set of operation list results if there are any." } } - }, - "VirtualNetworkPeeringList": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualNetworkPeering" - }, - "description": "List of virtual network peerings on workspace." - }, - "nextLink": { - "type": "string", - "description": "URL to get the next set of virtual network peering list results if there are any." - } - }, - "description": "Gets all virtual network peerings under a workspace." - }, - "VirtualNetworkPeering": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat", - "description": "List of properties for vNet Peering" - }, - "name": { - "type": "string", - "description": "Name of the virtual network peering resource", - "readOnly": true - }, - "id": { - "type": "string", - "description": "Resource ID.", - "readOnly": true - }, - "type": { - "type": "string", - "description": "type of the virtual network peering resource", - "readOnly": true - } - }, - "required": [ - "properties" - ], - "description": "Peerings in a VirtualNetwork resource", - "x-ms-azure-resource": true - }, - "VirtualNetworkPeeringPropertiesFormat": { - "properties": { - "allowVirtualNetworkAccess": { - "type": "boolean", - "description": "Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space." - }, - "allowForwardedTraffic": { - "type": "boolean", - "description": "Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network." - }, - "allowGatewayTransit": { - "type": "boolean", - "description": "If gateway links can be used in remote virtual networking to link to this virtual network." - }, - "useRemoteGateways": { - "type": "boolean", - "description": "If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway." - }, - "databricksVirtualNetwork": { - "properties": { - "id": { - "type": "string", - "description": "The Id of the databricks virtual network." - } - }, - "description": " The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering)." - }, - "databricksAddressSpace": { - "$ref": "#/definitions/AddressSpace", - "description": "The reference to the databricks virtual network address space." - }, - "remoteVirtualNetwork": { - "properties": { - "id": { - "type": "string", - "description": "The Id of the remote virtual network." - } - }, - "description": " The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering)." - }, - "remoteAddressSpace": { - "$ref": "#/definitions/AddressSpace", - "description": "The reference to the remote virtual network address space." - }, - "peeringState": { - "type": "string", - "description": "The status of the virtual network peering.", - "enum": [ - "Initiated", - "Connected", - "Disconnected" - ], - "x-ms-enum": { - "name": "peeringState", - "modelAsString": true - }, - "readOnly": true - }, - "provisioningState": { - "readOnly": true, - "$ref": "#/definitions/PeeringProvisioningState", - "description": "The provisioning state of the virtual network peering resource." - } - }, - "required": [ - "remoteVirtualNetwork" - ], - "description": "Properties of the virtual network peering." - }, - "AddressSpace": { - "properties": { - "addressPrefixes": { - "type": "array", - "items": { - "type": "string" - }, - "description": "A list of address blocks reserved for this virtual network in CIDR notation." - } - }, - "description": "AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network." } }, "parameters": { @@ -1294,14 +954,6 @@ "minLength": 3, "maxLength": 64, "x-ms-parameter-location": "method" - }, - "PeeringNameParameter": { - "name": "peeringName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the workspace vNet peering.", - "x-ms-parameter-location": "method" } } } diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/vnetpeering.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/vnetpeering.json new file mode 100644 index 000000000000..c88a288c5d03 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/vnetpeering.json @@ -0,0 +1,490 @@ +{ + "swagger": "2.0", + "info": { + "title": "DatabricksClient", + "version": "2018-04-01", + "description": "ARM Databricks" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/virtualNetworkPeerings/{peeringName}": { + "get": { + "tags": [ + "vNetPeering" + ], + "operationId": "vNetPeering_Get", + "description": "Gets the workspace vNet Peering.", + "x-ms-examples": { + "Get a workspace with vNet Peering Configured": { + "$ref": "./examples/WorkspaceVirtualNetPeeringGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PeeringNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + } + }, + "204": { + "description": "OK - NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "vNetPeering" + ], + "operationId": "vNetPeering_Delete", + "description": "Deletes the workspace vNetPeering.", + "x-ms-examples": { + "Delete a workspace vNet Peering": { + "$ref": "./examples/WorkspaceVirtualNetworkPeeringDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PeeringNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "204": { + "description": "NoContent" + }, + "200": { + "description": "OK. The request has succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "vNetPeering" + ], + "operationId": "vNetPeering_CreateOrUpdate", + "description": "Creates vNet Peering for workspace.", + "x-ms-examples": { + "Create vNet Peering for Workspace": { + "$ref": "./examples/WorkspaceVirtualNetworkPeeringCreateOrUpdate.json" + } + }, + "parameters": [ + { + "name": "VirtualNetworkPeeringParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + }, + "description": "Parameters supplied to the create workspace vNet Peering." + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PeeringNameParameter" + } + ], + "responses": { + "201": { + "description": "Created - Returns information about the workspace vNet peering, including provisioning status.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + } + }, + "200": { + "description": "Update succeeded - Returns information about the workspace vNet peering.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/virtualNetworkPeerings": { + "get": { + "tags": [ + "vNetPeering" + ], + "operationId": "vNetPeering_ListByWorkspace", + "description": "Lists the workspace vNet Peerings.", + "x-ms-examples": { + "List all vNet Peerings for the workspace": { + "$ref": "./examples/WorkspaceVirtualNetPeeringList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List succeeded. Returns the resulting resource objects in response body.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeeringList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ErrorDetail": { + "title": "Error details.", + "type": "object", + "properties": { + "code": { + "description": "The error's code.", + "type": "string" + }, + "message": { + "description": "A human readable error message.", + "type": "string" + }, + "target": { + "description": "Indicates which property in the request is responsible for the error.", + "type": "string" + } + }, + "required": [ + "code", + "message" + ] + }, + "ErrorInfo": { + "title": "The code and message for an error.", + "type": "object", + "properties": { + "code": { + "description": "A machine readable error code.", + "type": "string" + }, + "message": { + "description": "A human readable error message.", + "type": "string" + }, + "details": { + "description": "error details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetail" + } + }, + "innererror": { + "description": "Inner error details if they exist.", + "type": "string" + } + }, + "required": [ + "code", + "message" + ] + }, + "ErrorResponse": { + "title": "Error response.", + "description": "Contains details when the response code indicates an error.", + "type": "object", + "properties": { + "error": { + "description": "The error details.", + "$ref": "#/definitions/ErrorInfo" + } + }, + "required": [ + "error" + ] + }, + "VirtualNetworkPeeringList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkPeering" + }, + "description": "List of virtual network peerings on workspace." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of virtual network peering list results if there are any." + } + }, + "description": "Gets all virtual network peerings under a workspace." + }, + "VirtualNetworkPeering": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat", + "description": "List of properties for vNet Peering" + }, + "name": { + "type": "string", + "description": "Name of the virtual network peering resource", + "readOnly": true + }, + "id": { + "type": "string", + "description": "Resource ID.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "type of the virtual network peering resource", + "readOnly": true + } + }, + "required": [ + "properties" + ], + "description": "Peerings in a VirtualNetwork resource", + "x-ms-azure-resource": true + }, + "VirtualNetworkPeeringPropertiesFormat": { + "properties": { + "allowVirtualNetworkAccess": { + "type": "boolean", + "description": "Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space." + }, + "allowForwardedTraffic": { + "type": "boolean", + "description": "Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network." + }, + "allowGatewayTransit": { + "type": "boolean", + "description": "If gateway links can be used in remote virtual networking to link to this virtual network." + }, + "useRemoteGateways": { + "type": "boolean", + "description": "If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway." + }, + "databricksVirtualNetwork": { + "properties": { + "id": { + "type": "string", + "description": "The Id of the databricks virtual network." + } + }, + "description": " The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering)." + }, + "databricksAddressSpace": { + "$ref": "#/definitions/AddressSpace", + "description": "The reference to the databricks virtual network address space." + }, + "remoteVirtualNetwork": { + "properties": { + "id": { + "type": "string", + "description": "The Id of the remote virtual network." + } + }, + "description": " The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering)." + }, + "remoteAddressSpace": { + "$ref": "#/definitions/AddressSpace", + "description": "The reference to the remote virtual network address space." + }, + "peeringState": { + "type": "string", + "description": "The status of the virtual network peering.", + "enum": [ + "Initiated", + "Connected", + "Disconnected" + ], + "x-ms-enum": { + "name": "peeringState", + "modelAsString": true + }, + "readOnly": true + }, + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/PeeringProvisioningState", + "description": "The provisioning state of the virtual network peering resource." + } + }, + "required": [ + "remoteVirtualNetwork" + ], + "description": "Properties of the virtual network peering." + }, + "PeeringProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Updating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PeeringProvisioningState", + "modelAsString": true + } + }, + "AddressSpace": { + "properties": { + "addressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of address blocks reserved for this virtual network in CIDR notation." + } + }, + "description": "AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the target subscription." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for this operation." + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "WorkspaceName": { + "name": "workspaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the workspace.", + "minLength": 3, + "maxLength": 64, + "x-ms-parameter-location": "method" + }, + "PeeringNameParameter": { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the workspace vNet peering.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/databricks/resource-manager/readme.go.md b/specification/databricks/resource-manager/readme.go.md index ffcc90680a7a..867cec609286 100644 --- a/specification/databricks/resource-manager/readme.go.md +++ b/specification/databricks/resource-manager/readme.go.md @@ -13,8 +13,17 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2021-04-01-preview - tag: package-2018-04-01 ``` +### Tag: package-2021-04-01-preview and go + +These settings apply only when `--tag=package-2021-04-01-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2021-04-01-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2021-04-01-preview/$(namespace) +``` ### Tag: package-2018-04-01 and go diff --git a/specification/databricks/resource-manager/readme.md b/specification/databricks/resource-manager/readme.md index 20ac8b9c6fb4..c24f7a2e0ec5 100644 --- a/specification/databricks/resource-manager/readme.md +++ b/specification/databricks/resource-manager/readme.md @@ -12,9 +12,23 @@ This is the AutoRest configuration file for Databricks. ``` yaml $(java) && $(multiapi) batch: + - tag: package-2021-04-01-preview - tag: package-2018-04-01 ``` +### Tag: package-2021-04-01-preview and java + +These settings apply only when `--tag=package-2021-04-01-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2021-04-01-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.databricks.v2021_04_01_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/databricks/mgmt-v2021_04_01_preview +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-2018-04-01 and java These settings apply only when `--tag=package-2018-04-01 --java` is specified on the command line. @@ -47,11 +61,12 @@ To see additional help and options, run: These are the global settings for the Databricks API. ``` yaml +title: AzureDatabricksManagementClient +description: 'The Microsoft Azure management APIs allow end users to operate on Azure Databricks Workspace resources.' openapi-type: arm -tag: package-2018-04-01 +tag: package-2021-04-01-preview ``` - ### Tag: package-2018-04-01 These settings apply only when `--tag=package-2018-04-01` is specified on the command line. @@ -59,6 +74,17 @@ These settings apply only when `--tag=package-2018-04-01` is specified on the co ``` yaml $(tag) == 'package-2018-04-01' input-file: - Microsoft.Databricks/stable/2018-04-01/databricks.json +- Microsoft.Databricks/stable/2018-04-01/vnetpeering.json +``` + +### Tag: package-2021-04-01-preview + +These settings apply only when `--tag=package-2021-04-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2021-04-01-preview' +input-file: +- Microsoft.Databricks/preview/2021-04-01-preview/databricks.json +- Microsoft.Databricks/stable/2018-04-01/vnetpeering.json ``` --- @@ -70,6 +96,8 @@ directive: from: databricks.json where: $.definitions.Encryption.properties.KeyName reason: Response from service is not camel case + - suppress: RequiredReadOnlySystemData + reason: We do not yet support system data. Currently our system support system data inside property field. ``` --- @@ -83,7 +111,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-powershell - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-go - repo: azure-sdk-for-js diff --git a/specification/databricks/resource-manager/readme.python.md b/specification/databricks/resource-manager/readme.python.md index db27747a5363..d3eb2d7b886c 100644 --- a/specification/databricks/resource-manager/readme.python.md +++ b/specification/databricks/resource-manager/readme.python.md @@ -2,43 +2,22 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.databricks - package-name: azure-mgmt-databricks - package-version: 0.1.0 - clear-output-folder: true -``` -``` yaml $(python) && $(track2) -python-mode: create +``` yaml $(track2) azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION -namespace: azure.mgmt.databricks package-name: azure-mgmt-databricks -package-version: 0.1.0 +no-namespace-folders: true +package-version: 1.0.0b1 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/databricks/azure-mgmt-databricks/azure/mgmt/databricks -``` -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/databricks/azure-mgmt-databricks -``` -``` yaml $(python) && $(python-mode) == 'update' && $(track2) + +``` yaml $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/databricks/azure-mgmt-databricks/azure/mgmt/databricks ``` -``` yaml $(python) && $(python-mode) == 'create' && $(track2) + +``` yaml $(python-mode) == 'create' && $(track2) basic-setup-py: true output-folder: $(python-sdks-folder)/databricks/azure-mgmt-databricks ``` diff --git a/specification/datadog/resource-manager/readme.python.md b/specification/datadog/resource-manager/readme.python.md index 124f4d5697c1..c582dc438281 100644 --- a/specification/datadog/resource-manager/readme.python.md +++ b/specification/datadog/resource-manager/readme.python.md @@ -12,6 +12,8 @@ azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-datadog no-namespace-folders: true +package-version: 1.0.0b1 +clear-output-folder: true ``` ``` yaml $(python) && $(python-mode) == 'update' && $(track2) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json index 074c69297192..a2cfe858338e 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json @@ -946,6 +946,51 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/outboundNetworkDependenciesEndpoints": { + "get": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints", + "description": "Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime.", + "x-ms-examples": { + "IntegrationRuntimes_OutboundNetworkDependenciesEndpoints": { + "$ref": "./examples/IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getConnectionInfo": { "post": { "tags": [ @@ -5012,6 +5057,28 @@ "hostName": { "description": "GitHub Enterprise host name. For example: https://github.mydomain.com", "type": "string" + }, + "clientId": { + "description": "GitHub bring your own app client id.", + "type": "string" + }, + "clientSecret": { + "$ref": "#/definitions/GitHubClientSecret", + "description": "GitHub bring your own app client secret information." + } + } + }, + "GitHubClientSecret": { + "description": "Client secret information for factory's bring your own app repository configuration.", + "type": "object", + "properties": { + "byoaSecretAkvUrl": { + "description": "Bring your own app client secret AKV URL.", + "type": "string" + }, + "byoaSecretName": { + "description": "Bring your own app client secret name in AKV.", + "type": "string" } } }, @@ -5039,6 +5106,10 @@ "description": "GitHub application client ID.", "type": "string" }, + "gitHubClientSecret": { + "$ref": "#/definitions/GitHubClientSecret", + "description": "GitHub bring your own app client secret information." + }, "gitHubAccessTokenBaseUrl": { "description": "GitHub access token base URL.", "type": "string" @@ -5764,6 +5835,16 @@ "description": "The type of the entity that started the run.", "type": "string", "readOnly": true + }, + "pipelineName": { + "description": "The name of the pipeline that triggered the run, if any.", + "type": "string", + "readOnly": true + }, + "pipelineRunId": { + "description": "The run id of the pipeline that triggered the run, if any.", + "type": "string", + "readOnly": true } } }, @@ -6868,6 +6949,48 @@ "readOnly": true } } + }, + "CredentialReference": { + "description": "Credential reference type.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Credential reference type.", + "enum": [ + "CredentialReference" + ] + }, + "referenceName": { + "type": "string", + "description": "Reference credential name." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type", + "referenceName" + ] + }, + "CredentialResource": { + "description": "Credential resource type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "./entityTypes/Credential.json#/definitions/Credential", + "description": "Properties of credentials." + } + }, + "required": [ + "properties" + ] } }, "parameters": { diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Credential.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Credential.json new file mode 100644 index 000000000000..f64d5d79e649 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Credential.json @@ -0,0 +1,103 @@ +{ + "swagger": "2.0", + "info": { + "title": "DataFactoryManagementClient", + "version": "2018-06-01" + }, + "paths": {}, + "definitions": { + "Credential": { + "description": "The Azure Data Factory nested object which contains the information and credential which can be used to connect with related store or compute resource.", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Type of credential." + }, + "description": { + "description": "Credential description.", + "type": "string" + }, + "annotations": { + "description": "List of tags that can be used for describing the Credential.", + "type": "array", + "items": { + "type": "object" + } + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "ServicePrincipalCredential": { + "x-ms-discriminator-value": "ServicePrincipal", + "description": "Service principal credential.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Credential" + } + ], + "properties": { + "typeProperties": { + "description": "Service Principal credential properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServicePrincipalCredentialTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ServicePrincipalCredentialTypeProperties": { + "description": "Service Principal credential type properties.", + "type": "object", + "properties": { + "servicePrincipalId": { + "type": "object", + "description": "The app ID of the service principal used to authenticate" + }, + "servicePrincipalKey": { + "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "description": "The key of the service principal used to authenticate." + }, + "tenant": { + "type": "object", + "description": "The ID of the tenant to which the service principal belongs" + } + } + }, + "ManagedIdentityCredential": { + "x-ms-discriminator-value": "ManagedIdentity", + "description": "Managed identity credential.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Credential" + } + ], + "properties": { + "typeProperties": { + "description": "Managed identity credential properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ManagedIdentityTypeProperties" + } + } + }, + "ManagedIdentityTypeProperties": { + "description": "Managed identity type properties.", + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "description": "The resource id of user assigned managed identity" + } + } + } + } +} 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 d403dc5bc04d..466271b794e9 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 @@ -451,8 +451,8 @@ "type": "object", "properties": { "type": { - "type": "string", - "description": "Type of dataset compression." + "type": "object", + "description": "Type of dataset compression. Type: string (or Expression with resultType string)." } }, "additionalProperties": { @@ -646,18 +646,8 @@ "description": "The location of the avro storage." }, "avroCompressionCodec": { - "type": "string", - "enum": [ - "none", - "deflate", - "snappy", - "xz", - "bzip2" - ], - "x-ms-enum": { - "name": "avroCompressionCodec", - "modelAsString": true - } + "type": "object", + "description": "The data avroCompressionCodec. Type: string (or Expression with resultType string)." }, "avroCompressionLevel": { "type": "integer", @@ -669,6 +659,20 @@ "location" ] }, + "AvroCompressionCodec": { + "type": "string", + "enum": [ + "none", + "deflate", + "snappy", + "xz", + "bzip2" + ], + "x-ms-enum": { + "name": "avroCompressionCodec", + "modelAsString": true + } + }, "ExcelDataset": { "x-ms-discriminator-value": "Excel", "description": "Excel dataset.", @@ -943,23 +947,27 @@ "description": "The location of the ORC data storage." }, "orcCompressionCodec": { - "type": "string", - "enum": [ - "none", - "zlib", - "snappy", - "lzo" - ], - "x-ms-enum": { - "name": "orcCompressionCodec", - "modelAsString": true - } + "type": "object", + "description": "The data orcCompressionCodec. Type: string (or Expression with resultType string)." } }, "required": [ "location" ] }, + "OrcCompressionCodec": { + "type": "string", + "enum": [ + "none", + "zlib", + "snappy", + "lzo" + ], + "x-ms-enum": { + "name": "orcCompressionCodec", + "modelAsString": true + } + }, "BinaryDataset": { "x-ms-discriminator-value": "Binary", "description": "Binary dataset.", 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 160a73ec5a57..863bd385ae0f 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 @@ -153,6 +153,10 @@ "description": "Time to live (in minutes) setting of the cluster which will execute data flow job.", "type": "integer", "minimum": 0 + }, + "cleanup": { + "description": "Cluster will not be recycled and it will be used in next data flow activity run until TTL (time to live) is reached if this is set as false. Default is true.", + "type": "boolean" } }, "additionalProperties": { @@ -178,6 +182,10 @@ "type": "string", "description": "The ID of the public IP address." } + }, + "subnetId": { + "description": "The ID of subnet, to which this Azure-SSIS integration runtime will be joined.", + "type": "string" } }, "additionalProperties": { @@ -238,9 +246,9 @@ "$ref": "#/definitions/PackageStore" } }, - "managedCredential": { - "description": "The user-assigned managed identity reference.", - "$ref": "#/definitions/EntityReference" + "credential": { + "$ref": "../datafactory.json#/definitions/CredentialReference", + "description": "The credential reference containing authentication information." } }, "additionalProperties": { @@ -508,8 +516,7 @@ "type": "string", "enum": [ "IntegrationRuntimeReference", - "LinkedServiceReference", - "CredentialReference" + "LinkedServiceReference" ], "x-ms-enum": { "name": "IntegrationRuntimeEntityReferenceType", @@ -600,6 +607,64 @@ "resourceId" ] }, + "IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse": { + "description": "Azure-SSIS integration runtime outbound network dependency endpoints.", + "type": "object", + "properties": { + "value": { + "description": "The list of outbound network dependency endpoints.", + "type": "array", + "items": { + "$ref": "#/definitions/IntegrationRuntimeOutboundNetworkDependenciesCategoryEndpoint" + } + } + } + }, + "IntegrationRuntimeOutboundNetworkDependenciesCategoryEndpoint": { + "description": "Azure-SSIS integration runtime outbound network dependency endpoints for one category.", + "type": "object", + "properties": { + "category": { + "description": "The category of outbound network dependency.", + "type": "string" + }, + "endpoints": { + "description": "The endpoints for outbound network dependency.", + "type": "array", + "items": { + "$ref": "#/definitions/IntegrationRuntimeOutboundNetworkDependenciesEndpoint" + } + } + } + }, + "IntegrationRuntimeOutboundNetworkDependenciesEndpoint": { + "description": "The endpoint for Azure-SSIS integration runtime outbound network dependency.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name of endpoint.", + "type": "string" + }, + "endpointDetails": { + "description": "The details of endpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails" + } + } + } + }, + "IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails": { + "description": "The details of Azure-SSIS integration runtime outbound network dependency endpoint.", + "type": "object", + "properties": { + "port": { + "description": "The port of endpoint.", + "type": "integer", + "format": "int32" + } + } + }, "IntegrationRuntimeStatus": { "description": "Integration runtime status.", "type": "object", 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 71f9d12270d8..bde4d26c0db9 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 @@ -184,6 +184,10 @@ "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + }, + "credential": { + "$ref": "../datafactory.json#/definitions/CredentialReference", + "description": "The credential reference containing authentication information." } } }, @@ -237,6 +241,10 @@ "encryptedCredential": { "type": "object", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + }, + "credential": { + "$ref": "../datafactory.json#/definitions/CredentialReference", + "description": "The credential reference containing authentication information." } }, "required": [ @@ -345,6 +353,10 @@ "alwaysEncryptedSettings": { "$ref": "#/definitions/SqlAlwaysEncryptedProperties", "description": "Sql always encrypted properties." + }, + "credential": { + "$ref": "../datafactory.json#/definitions/CredentialReference", + "description": "The credential reference containing authentication information." } }, "required": [ @@ -405,6 +417,10 @@ "alwaysEncryptedSettings": { "$ref": "#/definitions/SqlAlwaysEncryptedProperties", "description": "Sql always encrypted properties." + }, + "credential": { + "$ref": "../datafactory.json#/definitions/CredentialReference", + "description": "The credential reference containing authentication information." } }, "required": [ @@ -485,6 +501,10 @@ "encryptedCredential": { "type": "object", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + }, + "credential": { + "$ref": "../datafactory.json#/definitions/CredentialReference", + "description": "The credential reference containing authentication information." } }, "required": [ @@ -520,6 +540,10 @@ "baseUrl": { "type": "object", "description": "The base URL of the Azure Key Vault. e.g. https://myakv.vault.azure.net Type: string (or Expression with resultType string)." + }, + "credential": { + "$ref": "../datafactory.json#/definitions/CredentialReference", + "description": "The credential reference containing authentication information." } }, "required": [ @@ -1575,6 +1599,10 @@ "encryptedCredential": { "type": "object", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + }, + "authentication": { + "type": "object", + "description": "Type of authentication (Required to specify MSI) used to connect to AzureML. Type: string (or Expression with resultType string)." } }, "required": [ @@ -2275,6 +2303,10 @@ "CosmosDbMongoDbApiLinkedServiceTypeProperties": { "description": "CosmosDB (MongoDB API) linked service properties.", "properties": { + "isServerVersionAbove32": { + "type": "object", + "description": "Whether the CosmosDB (MongoDB API) server version is higher than 3.2. The default value is false. Type: boolean (or Expression with resultType boolean)." + }, "connectionString": { "description": "The CosmosDB (MongoDB API) connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.", "type": "object" @@ -2347,6 +2379,10 @@ "encryptedCredential": { "type": "object", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + }, + "credential": { + "$ref": "../datafactory.json#/definitions/CredentialReference", + "description": "The credential reference containing authentication information." } }, "required": [ @@ -2403,6 +2439,10 @@ "encryptedCredential": { "type": "object", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + }, + "credential": { + "$ref": "../datafactory.json#/definitions/CredentialReference", + "description": "The credential reference containing authentication information." } }, "required": [ @@ -2799,6 +2839,10 @@ "encryptedCredential": { "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" + }, + "credential": { + "$ref": "../datafactory.json#/definitions/CredentialReference", + "description": "The credential reference containing authentication information." } }, "required": [ @@ -5317,6 +5361,10 @@ "subnetName": { "type": "object", "description": "The ARM resource ID for the subnet in the vNet. If virtualNetworkId was specified, then this property is required. Type: string (or Expression with resultType string)." + }, + "credential": { + "$ref": "../datafactory.json#/definitions/CredentialReference", + "description": "The credential reference containing authentication information." } }, "required": [ @@ -5536,6 +5584,10 @@ "policyId": { "type": "object", "description": "The policy id for limiting the ability to configure clusters based on a user defined set of rules. Type: string (or Expression with resultType string)." + }, + "credential": { + "$ref": "../datafactory.json#/definitions/CredentialReference", + "description": "The credential reference containing authentication information." } }, "required": [ @@ -5970,6 +6022,10 @@ "tenant": { "type": "object", "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." + }, + "credential": { + "$ref": "../datafactory.json#/definitions/CredentialReference", + "description": "The credential reference containing authentication information." } }, "required": [ @@ -6011,6 +6067,18 @@ "encryptedCredential": { "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" + }, + "credential": { + "$ref": "../datafactory.json#/definitions/CredentialReference", + "description": "The credential reference containing authentication information." + }, + "resourceId": { + "description": "Allowed token audiences for azure function.", + "type": "object" + }, + "authentication": { + "type": "object", + "description": "Type of authentication (Required to specify MSI) used to connect to AzureFunction. Type: string (or Expression with resultType string)." } }, "required": [ 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 f8dbc3deed9d..384bdf1ee640 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 @@ -1329,11 +1329,8 @@ "description": "Avro store settings." }, "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/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)." } } }, @@ -1351,11 +1348,8 @@ "description": "Excel store settings." }, "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/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)." } } }, @@ -1373,11 +1367,8 @@ "description": "Parquet store settings." }, "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/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)." } } }, @@ -1399,11 +1390,8 @@ "description": "DelimitedText format settings." }, "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/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)." } } }, @@ -1425,11 +1413,8 @@ "description": "Json format settings." }, "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/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)." } } }, @@ -1451,11 +1436,8 @@ "description": "Xml format settings." }, "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/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)." } } }, @@ -1473,11 +1455,8 @@ "description": "ORC store settings." }, "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/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)." } } }, @@ -1714,11 +1693,8 @@ "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." }, "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/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)." } } }, @@ -1786,11 +1762,8 @@ "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." }, "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/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)." } } }, @@ -1820,11 +1793,8 @@ "description": "Whether detect primitive values as datetime values. Type: boolean (or Expression with resultType boolean)." }, "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/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)." } } }, @@ -1842,11 +1812,8 @@ "description": "FetchXML is a proprietary query language that is used in Microsoft Dynamics (online & on-premises). Type: string (or Expression with resultType string)." }, "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/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)." } } }, @@ -1864,11 +1831,8 @@ "description": "FetchXML is a proprietary query language that is used in Microsoft Dynamics CRM (online & on-premises). Type: string (or Expression with resultType string)." }, "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/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)." } } }, @@ -1886,11 +1850,8 @@ "description": "FetchXML is a proprietary query language that is used in Microsoft Common Data Service for Apps (online & on-premises). Type: string (or Expression with resultType string)." }, "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/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)." } } }, @@ -1908,11 +1869,8 @@ "description": "Database query. Type: string (or Expression with resultType string)." }, "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/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)." } } }, @@ -1945,11 +1903,8 @@ "description": "Database query. Type: string (or Expression with resultType string)." }, "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/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)." } } }, @@ -2061,11 +2016,8 @@ "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." }, "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/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)." } } }, @@ -2122,11 +2074,8 @@ } }, "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/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)." } } }, @@ -2366,11 +2315,8 @@ "description": "The time to await before sending next page request. " }, "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/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)." } } }, @@ -2589,11 +2535,8 @@ "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." }, "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/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)." } } }, @@ -2675,11 +2618,8 @@ "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).." }, "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/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)." } }, "required": [ @@ -2712,11 +2652,8 @@ "$ref": "#/definitions/OraclePartitionSettings" }, "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/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)." } } }, @@ -2797,11 +2734,8 @@ ], "properties": { "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/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)." } } }, @@ -2854,11 +2788,8 @@ "description": "Database query. Should be a SQL-92 query expression. Type: string (or Expression with resultType string)." }, "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/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)." } } }, @@ -2888,11 +2819,8 @@ "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." }, "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/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)." } } }, @@ -2922,11 +2850,8 @@ "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." }, "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/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)." } } }, @@ -2956,11 +2881,8 @@ "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." }, "additionalColumns": { - "type": "array", - "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", - "items": { - "$ref": "#/definitions/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)." } } }, @@ -4141,6 +4063,19 @@ "tableOption": { "type": "object", "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." + }, + "sqlWriterUseTableLock": { + "type": "object", + "description": "Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean)." + }, + "writeBehavior": { + "type": "object", + "description": "Write behavior when copying data into sql. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum)" + }, + "upsertSettings": { + "description": "SQL upsert settings.", + "type": "object", + "$ref": "#/definitions/SqlUpsertSettings" } } }, @@ -4179,6 +4114,19 @@ "tableOption": { "type": "object", "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." + }, + "sqlWriterUseTableLock": { + "type": "object", + "description": "Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean)." + }, + "writeBehavior": { + "type": "object", + "description": "Write behavior when copying data into sql server. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum)" + }, + "upsertSettings": { + "description": "SQL upsert settings.", + "type": "object", + "$ref": "#/definitions/SqlUpsertSettings" } } }, @@ -4217,6 +4165,19 @@ "tableOption": { "type": "object", "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." + }, + "sqlWriterUseTableLock": { + "type": "object", + "description": "Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean)." + }, + "writeBehavior": { + "type": "object", + "description": "Write behavior when copying data into Azure SQL. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum)" + }, + "upsertSettings": { + "description": "SQL upsert settings.", + "type": "object", + "$ref": "#/definitions/SqlUpsertSettings" } } }, @@ -4255,6 +4216,19 @@ "tableOption": { "type": "object", "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." + }, + "sqlWriterUseTableLock": { + "type": "object", + "description": "Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean)." + }, + "writeBehavior": { + "type": "object", + "description": "White behavior when copying data into azure SQL MI. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum)" + }, + "upsertSettings": { + "description": "SQL upsert settings.", + "type": "object", + "$ref": "#/definitions/SqlUpsertSettings" } } }, @@ -4290,6 +4264,19 @@ "tableOption": { "type": "object", "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." + }, + "sqlWriterUseTableLock": { + "type": "object", + "description": "Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean)." + }, + "writeBehavior": { + "type": "object", + "description": "Write behavior when copying data into azure SQL DW. Type: SqlDWWriteBehaviorEnum (or Expression with resultType SqlDWWriteBehaviorEnum)" + }, + "upsertSettings": { + "description": "SQL DW upsert settings.", + "type": "object", + "$ref": "#/definitions/SqlDWUpsertSettings" } } }, @@ -4364,6 +4351,63 @@ } } }, + "SqlUpsertSettings": { + "description": "Sql upsert option settings", + "type": "object", + "properties": { + "useTempDB": { + "type": "object", + "description": "Specifies whether to use temp db for upsert interim table. Type: boolean (or Expression with resultType boolean)." + }, + "interimSchemaName": { + "type": "object", + "description": "Schema name for interim table. Type: string (or Expression with resultType string)." + }, + "keys": { + "type": "object", + "description": "Key column names for unique row identification. Type: array of strings (or Expression with resultType array of strings)." + } + } + }, + "SqlDWUpsertSettings": { + "description": "Sql DW upsert option settings", + "type": "object", + "properties": { + "interimSchemaName": { + "type": "object", + "description": "Schema name for interim table. Type: string (or Expression with resultType string)." + }, + "keys": { + "type": "object", + "description": "Key column names for unique row identification. Type: array of strings (or Expression with resultType array of strings)." + } + } + }, + "SqlWriteBehaviorEnum": { + "description": "Specify the write behavior when copying data into sql.", + "type": "string", + "enum": [ + "Insert", + "Upsert", + "StoredProcedure" + ], + "x-ms-enum": { + "name": "SqlWriteBehaviorEnum", + "modelAsString": true + } + }, + "SqlDWWriteBehaviorEnum": { + "description": "Specify the write behavior when copying data into sql dw.", + "type": "string", + "enum": [ + "Insert", + "Upsert" + ], + "x-ms-enum": { + "name": "SqlDWWriteBehaviorEnum", + "modelAsString": true + } + }, "SnowflakeSink": { "description": "A copy activity snowflake sink.", "type": "object", @@ -6043,11 +6087,12 @@ "userTenant": { "description": "TenantId for which Azure Auth token will be requested when using ServicePrincipal Authentication. Type: string (or Expression with resultType string).", "type": "object" + }, + "credential": { + "$ref": "../datafactory.json#/definitions/CredentialReference", + "description": "The credential reference containing authentication information." } - }, - "required": [ - "type" - ] + } }, "WebActivityTypeProperties": { "description": "Web activity type properties.", diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints.json new file mode 100644 index 000000000000..771e448ae13e --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "7ad7c73b-38b8-4df3-84ee-52ff91092f61", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "integrationRuntimeName": "exampleIntegrationRuntime", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Tue, 06 Jul 2021 04:28:10 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-request-id": "fd8e4223-7e9c-4f32-893f-06c14a8081be", + "x-ms-correlation-request-id": "1dabf122-e061-4703-ae9e-9edeeef40ee6" + }, + "body": { + "value": [ + { + "category": "Azure Data Factory (Management)", + "endpoints": [ + { + "domainName": "wu.frontend.int.clouddatahub-int.net", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Azure Storage (Management)", + "endpoints": [ + { + "domainName": "*.blob.core.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "domainName": "*.table.core.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Event Hub (Logging)", + "endpoints": [ + { + "domainName": "*.servicebus.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Microsoft Logging service (Internal Use)", + "endpoints": [ + { + "domainName": "gcs.prod.monitoring.core.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "domainName": "prod.warmpath.msftcloudes.com", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "domainName": "azurewatsonanalysis-prod.core.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/datafactory/resource-manager/readme.java.md b/specification/datafactory/resource-manager/readme.java.md index ce7c8f5845a8..d472294a50c4 100644 --- a/specification/datafactory/resource-manager/readme.java.md +++ b/specification/datafactory/resource-manager/readme.java.md @@ -10,6 +10,18 @@ namespace: com.microsoft.azure.management.datafactory license-header: MICROSOFT_MIT_NO_CODEGEN payload-flattening-threshold: 1 output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-datafactory + +directive: + - from: ManagedPrivateEndpoint.json + where: "$.definitions.ManagedPrivateEndpoint" + transform: delete $.discriminator + - from: ManagedVirtualNetwork.json + where: "$.definitions.ManagedVirtualNetwork" + transform: delete $.discriminator + - from: DataFlow.json + where: "$.definitions.DataFlow" + transform: $.required = ['type'] + reason: discriminator property must be required ``` # Validation diff --git a/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/preview/2015-10-01-preview/account.json b/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/preview/2015-10-01-preview/account.json index 91b8577bd04d..729c623dffbf 100644 --- a/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/preview/2015-10-01-preview/account.json +++ b/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/preview/2015-10-01-preview/account.json @@ -1906,6 +1906,11 @@ }, "description": "The list of hiveMetastores associated with this account." }, + "hierarchicalQueueState": { + "readOnly": true, + "type": "string", + "description": "The hierarchical queue state associated with this account." + }, "virtualNetworkRules": { "readOnly": true, "type": "array", @@ -2651,6 +2656,10 @@ "type": "string", "description": "The displayName for OperationMetaMetricSpecification." }, + "displayDescription": { + "type": "string", + "description": "The displayDescription for OperationMetaMetricSpecification." + }, "unit": { "type": "string", "description": "The unit for OperationMetaMetricSpecification." @@ -2843,6 +2852,7 @@ "Enabled", "Disabled" ], + "default": "Disabled", "x-ms-enum": { "name": "FirewallState", "modelAsString": false @@ -2855,6 +2865,7 @@ "Enabled", "Disabled" ], + "default": "Disabled", "x-ms-enum": { "name": "FirewallAllowAzureIpsState", "modelAsString": false @@ -2874,6 +2885,7 @@ "Commitment_100000AUHours", "Commitment_500000AUHours" ], + "default": "Consumption", "x-ms-enum": { "name": "TierType", "modelAsString": false @@ -2883,6 +2895,7 @@ "maxJobCount": { "type": "integer", "format": "int32", + "default": 20, "description": "The maximum supported jobs running under the account at the same time." }, "maxDegreeOfParallelism": { @@ -2894,6 +2907,7 @@ "type": "integer", "format": "int32", "minimum": 1, + "default": 32, "description": "The maximum supported degree of parallelism per job for this account." }, "minPriorityPerJob": { diff --git a/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/account.json b/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/account.json index 1bc08c8f588c..6ebafa54d06b 100644 --- a/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/account.json +++ b/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/account.json @@ -1885,6 +1885,21 @@ }, "description": "The list of hiveMetastores associated with this account." }, + "hierarchicalQueue": { + "type": "object", + "readOnly": true, + "properties": { + "root": { + "type": "object" + } + }, + "description": "The hierarchical queue associated with this account." + }, + "hierarchicalQueueState": { + "readOnly": true, + "type": "string", + "description": "The hierarchical queue state associated with this account." + }, "virtualNetworkRules": { "readOnly": true, "type": "array", @@ -1971,6 +1986,24 @@ "default": 3, "description": "The maximum supported jobs running under the account at the same time." }, + "maxActiveJobCountPerUser": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The maximum supported active jobs under the account at the same time." + }, + "maxQueuedJobCountPerUser": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The maximum supported jobs queued under the account at the same time." + }, + "maxJobRunningTimeInMin": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The maximum supported active jobs under the account at the same time." + }, "systemMaxJobCount": { "readOnly": true, "type": "integer", @@ -2831,6 +2864,7 @@ "Enabled", "Disabled" ], + "default": "Disabled", "x-ms-enum": { "name": "FirewallState", "modelAsString": false @@ -2843,6 +2877,7 @@ "Enabled", "Disabled" ], + "default": "Disabled", "x-ms-enum": { "name": "FirewallAllowAzureIpsState", "modelAsString": false @@ -2862,6 +2897,7 @@ "Commitment_100000AUHours", "Commitment_500000AUHours" ], + "default": "Consumption", "x-ms-enum": { "name": "TierType", "modelAsString": false @@ -2886,6 +2922,7 @@ "type": "integer", "format": "int32", "minimum": 1, + "default": 32, "description": "The maximum supported degree of parallelism per job for this account." }, "minPriorityPerJob": { @@ -3132,6 +3169,7 @@ }, "suffix": { "type": "string", + "default": "azuredatalakestore.net", "description": "The optional suffix for the storage account." } }, diff --git a/specification/datamigration/resource-manager/readme.md b/specification/datamigration/resource-manager/readme.md index 42e97f085902..b01b5f289ecf 100644 --- a/specification/datamigration/resource-manager/readme.md +++ b/specification/datamigration/resource-manager/readme.md @@ -187,7 +187,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-go - repo: azure-sdk-for-js diff --git a/specification/datamigration/resource-manager/readme.python.md b/specification/datamigration/resource-manager/readme.python.md index 1e32099cbf9c..2bec1c3f7d89 100644 --- a/specification/datamigration/resource-manager/readme.python.md +++ b/specification/datamigration/resource-manager/readme.python.md @@ -4,43 +4,32 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.datamigration - package-name: azure-mgmt-datamigration - package-version: 0.2.0 - clear-output-folder: true -``` + ``` yaml $(python) && $(track2) azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.datamigration package-name: azure-mgmt-datamigration -package-version: 0.2.0 +package-version: 1.0.0b1 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/datamigration/azure-mgmt-datamigration/azure/mgmt/datamigration -``` + ``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/datamigration/azure-mgmt-datamigration/azure/mgmt/datamigration ``` -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/datamigration/azure-mgmt-datamigration -``` ``` yaml $(python) && $(python-mode) == 'create' && $(track2) basic-setup-py: true output-folder: $(python-sdks-folder)/datamigration/azure-mgmt-datamigration -``` \ No newline at end of file +``` + +``` yaml $(python) && $(track2) +directive: + - from: swagger-document + where: $.definitions.MigrateSchemaSqlServerSqlDbTaskOutput + transform: > + $['required'] = ['resultType']; +``` diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-02-01-preview/dataprotection.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-02-01-preview/dataprotection.json index d262636aea34..9eb6e6b56625 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-02-01-preview/dataprotection.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-02-01-preview/dataprotection.json @@ -24,7 +24,7 @@ "BackupVaults" ], "description": "Returns resource collection belonging to a subscription.", - "operationId": "BackupVaults_GetResourcesInSubscription", + "operationId": "BackupVaults_GetInSubscription", "produces": [ "application/json" ], @@ -136,7 +136,7 @@ "OperationStatus" ], "summary": "Gets the operation status for a resource.", - "operationId": "GetOperationStatus", + "operationId": "OperationStatus_Get", "produces": [ "application/json" ], @@ -187,7 +187,7 @@ "BackupVaults" ], "description": "Returns resource collection belonging to a resource group.", - "operationId": "BackupVaults_GetResourcesInResourceGroup", + "operationId": "BackupVaults_GetInResourceGroup", "produces": [ "application/json" ], @@ -389,7 +389,7 @@ "BackupVaults" ], "description": "Updates a BackupVault resource belonging to a resource group. For example, updating tags for a resource.", - "operationId": "BackupVaults_Patch", + "operationId": "BackupVaults_Update", "produces": [ "application/json" ], @@ -446,7 +446,7 @@ "tags": [ "Resources" ], - "operationId": "GetOperationResultPatch", + "operationId": "BackupVaultOperationResults_Get", "produces": [ "application/json" ], @@ -555,7 +555,7 @@ "DppFeatureSupport" ], "summary": "Validates if a feature is supported", - "operationId": "CheckFeatureSupport", + "operationId": "DataProtection_CheckFeatureSupport", "produces": [ "application/json" ], @@ -609,7 +609,7 @@ "Operations" ], "description": "Returns the list of available operations.", - "operationId": "Operations_List", + "operationId": "DataProtectionOperations_List", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -632,6 +632,11 @@ "x-ms-pageable": { "nextLinkName": "nextLink", "itemName": "value" + }, + "x-ms-examples": { + "Returns the list of supported REST operations.": { + "$ref": "./examples/Operations/List.json" + } } } }, @@ -758,6 +763,7 @@ }, { "name": "backupPolicyName", + "description": "Name of the policy", "in": "path", "required": true, "type": "string" @@ -1236,7 +1242,7 @@ "RecoveryPoint" ], "description": "Returns a list of Recovery Points for a DataSource in a vault.", - "operationId": "RecoveryPoints_GetList", + "operationId": "RecoveryPoints_List", "produces": [ "application/json" ], @@ -1306,7 +1312,7 @@ "RecoveryPoint" ], "description": "Gets a Recovery Point using recoveryPointId for a Datasource.", - "operationId": "RecoveryPoint_Get", + "operationId": "RecoveryPoints_Get", "produces": [ "application/json" ], @@ -1870,7 +1876,7 @@ "BackupInstances" ], "description": "Validates if Restore can be triggered for a DataSource", - "operationId": "BackupInstances_ValidateRestore", + "operationId": "BackupInstances_ValidateForRestore", "produces": [ "application/json" ], @@ -1992,12 +1998,12 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstances}/findRestorableTimeRanges": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/findRestorableTimeRanges": { "post": { "tags": [ "FindRestorableTimeRanges" ], - "operationId": "FindRestorableTimeRanges_Post", + "operationId": "RestorableTimeRanges_Find", "produces": [ "application/json" ], @@ -2015,7 +2021,8 @@ "$ref": "#/parameters/SubscriptionId" }, { - "name": "backupInstances", + "name": "backupInstanceName", + "description": "The name of the backup instance", "in": "path", "required": true, "type": "string" @@ -2057,7 +2064,7 @@ "AzureBackupJob" ], "description": "Gets a job with id in a backup vault", - "operationId": "Job_Get", + "operationId": "Jobs_Get", "produces": [ "application/json" ], @@ -2367,9 +2374,7 @@ "AzureBackupFindRestorableTimeRangesRequest": { "description": "List Restore Ranges Request", "required": [ - "sourceDataStoreType", - "startTime", - "endTime" + "sourceDataStoreType" ], "type": "object", "properties": { @@ -2387,11 +2392,11 @@ } }, "startTime": { - "description": "Start time for the List Restore Ranges request", + "description": "Start time for the List Restore Ranges request. ISO 8601 format.", "type": "string" }, "endTime": { - "description": "End time for the List Restore Ranges request", + "description": "End time for the List Restore Ranges request. ISO 8601 format.", "type": "string" } } diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-02-01-preview/examples/BackupInstanceOperations/FindRestorableTimeRanges.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-02-01-preview/examples/BackupInstanceOperations/FindRestorableTimeRanges.json index 5019b2cf6725..7e1fd818feb3 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-02-01-preview/examples/BackupInstanceOperations/FindRestorableTimeRanges.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-02-01-preview/examples/BackupInstanceOperations/FindRestorableTimeRanges.json @@ -3,7 +3,7 @@ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", "resourceGroupName": "Blob-Backup", "vaultName": "ZBlobBackupVaultBVTD3", - "backupInstances": "zblobbackuptestsa58", + "backupInstanceName": "zblobbackuptestsa58", "api-version": "2021-02-01-preview", "parameters": { "sourceDataStoreType": "OperationalStore", diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-02-01-preview/examples/Operations/List.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-02-01-preview/examples/Operations/List.json new file mode 100644 index 000000000000..c3dfcdf4beb1 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-02-01-preview/examples/Operations/List.json @@ -0,0 +1,403 @@ +{ + "parameters": { + "api-version": "2021-02-01-preview" + }, + "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/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/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/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/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/providers/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/preview/2021-06-01-preview/dataprotection.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/dataprotection.json new file mode 100644 index 000000000000..891d7750b14d --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/dataprotection.json @@ -0,0 +1,5045 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01-preview", + "title": "DataProtectionBackupClient", + "x-ms-code-generation-settings": { + "internalConstructors": false + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/backupVaults": { + "get": { + "tags": [ + "BackupVaults" + ], + "description": "Returns resource collection belonging to a subscription.", + "operationId": "BackupVaults_GetInSubscription", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupVaultResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get BackupVaults in Subscription": { + "$ref": "./examples/VaultCRUD/GetBackupVaultsInSubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/locations/{location}/operationResults/{operationId}": { + "get": { + "tags": [ + "GetOperationResult" + ], + "description": "Gets the operation result for a resource", + "operationId": "OperationResult_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "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" + } + } + }, + "200": { + "description": "Contains additional information like job Id", + "schema": { + "$ref": "#/definitions/OperationJobExtendedInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "summary": "Gets the operation status for a resource.", + "x-ms-examples": { + "Get OperationResult": { + "$ref": "./examples/GetOperationResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/locations/{location}/operationStatus/{operationId}": { + "get": { + "tags": [ + "OperationStatus" + ], + "summary": "Gets the operation status for a resource.", + "operationId": "OperationStatus_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get OperationStatus": { + "$ref": "./examples/GetOperationStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults": { + "get": { + "tags": [ + "BackupVaults" + ], + "description": "Returns resource collection belonging to a resource group.", + "operationId": "BackupVaults_GetInResourceGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupVaultResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get BackupVaults in ResourceGroup": { + "$ref": "./examples/VaultCRUD/GetBackupVaultsInResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}": { + "get": { + "tags": [ + "BackupVaults" + ], + "description": "Returns a resource belonging to a resource group.", + "operationId": "BackupVaults_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupVaultResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get BackupVault": { + "$ref": "./examples/VaultCRUD/GetBackupVault.json" + }, + "Get BackupVault With MSI": { + "$ref": "./examples/VaultCRUD/GetBackupVaultWithMSI.json" + } + } + }, + "put": { + "tags": [ + "BackupVaults" + ], + "description": "Creates or updates a BackupVault resource belonging to a resource group.", + "operationId": "BackupVaults_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/BackupVaultResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupVaultResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/BackupVaultResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create BackupVault": { + "$ref": "./examples/VaultCRUD/PutBackupVault.json" + }, + "Create BackupVault With MSI": { + "$ref": "./examples/VaultCRUD/PutBackupVaultWithMSI.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "BackupVaults" + ], + "description": "Deletes a BackupVault resource from the resource group.", + "operationId": "BackupVaults_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete BackupVault": { + "$ref": "./examples/VaultCRUD/DeleteBackupVault.json" + } + } + }, + "patch": { + "tags": [ + "BackupVaults" + ], + "description": "Updates a BackupVault resource belonging to a resource group. For example, updating tags for a resource.", + "operationId": "BackupVaults_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/PatchResourceRequestInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupVaultResource" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Patch BackupVault": { + "$ref": "./examples/VaultCRUD/PatchBackupVault.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/operationResults/{operationId}": { + "get": { + "tags": [ + "Resources" + ], + "operationId": "BackupVaultOperationResults_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupVaultResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetOperationResult Patch": { + "$ref": "./examples/VaultCRUD/GetOperationResultPatch.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/checkNameAvailability": { + "post": { + "tags": [ + "BackupVaults" + ], + "summary": "API to check for resource name availability", + "operationId": "BackupVaults_CheckNameAvailability", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "location", + "in": "path", + "description": "The location in which uniqueness will be verified.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Check name availability request", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Check BackupVaults name availability": { + "$ref": "./examples/VaultCRUD/CheckBackupVaultsNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/locations/{location}/checkFeatureSupport": { + "post": { + "tags": [ + "DppFeatureSupport" + ], + "summary": "Validates if a feature is supported", + "operationId": "DataProtection_CheckFeatureSupport", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Feature support request object", + "required": true, + "schema": { + "$ref": "#/definitions/FeatureValidationRequestBase" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FeatureValidationResponseBase" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Check Azure Vm Backup Feature Support": { + "$ref": "./examples/CheckfeatureSupport.json" + } + } + } + }, + "/providers/Microsoft.DataProtection/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Returns the list of available operations.", + "operationId": "DataProtectionOperations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClientDiscoveryResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + }, + "x-ms-examples": { + "Returns the list of supported REST operations.": { + "$ref": "./examples/Operations/List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupPolicies": { + "get": { + "tags": [ + "BackupPolicies" + ], + "description": "Returns list of backup policies belonging to a backup vault", + "operationId": "BackupPolicies_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BaseBackupPolicyResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List BackupPolicy": { + "$ref": "./examples/PolicyCRUD/ListBackupPolicy.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupPolicies/{backupPolicyName}": { + "get": { + "tags": [ + "BackupPolicies" + ], + "operationId": "BackupPolicies_Get", + "description": "Gets a backup policy belonging to a backup vault", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "backupPolicyName", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BaseBackupPolicyResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "summary": "Gets a backup policy belonging to a backup vault", + "x-ms-examples": { + "Get BackupPolicy": { + "$ref": "./examples/PolicyCRUD/GetBackupPolicy.json" + } + } + }, + "put": { + "tags": [ + "BackupPolicies" + ], + "operationId": "BackupPolicies_CreateOrUpdate", + "summary": "Creates or Updates a backup policy belonging to a backup vault", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "backupPolicyName", + "description": "Name of the policy", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/BaseBackupPolicyResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BaseBackupPolicyResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate BackupPolicy": { + "$ref": "./examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json" + } + } + }, + "delete": { + "tags": [ + "BackupPolicies" + ], + "operationId": "BackupPolicies_Delete", + "summary": "Deletes a backup policy belonging to a backup vault", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "backupPolicyName", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete BackupPolicy": { + "$ref": "./examples/PolicyCRUD/DeleteBackupPolicy.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances": { + "get": { + "tags": [ + "BackupInstances" + ], + "description": "Gets a backup instances belonging to a backup vault", + "operationId": "BackupInstances_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupInstanceResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List BackupInstances in a Vault": { + "$ref": "./examples/BackupInstanceOperations/ListBackupInstances.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}": { + "get": { + "tags": [ + "BackupInstances" + ], + "description": "Gets a backup instance with name in a backup vault", + "operationId": "BackupInstances_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "backupInstanceName", + "description": "The name of the backup instance", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupInstanceResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get BackupInstance": { + "$ref": "./examples/BackupInstanceOperations/GetBackupInstance.json" + } + } + }, + "put": { + "tags": [ + "BackupInstances" + ], + "description": "Create or update a backup instance in a backup vault", + "operationId": "BackupInstances_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "backupInstanceName", + "description": "The name of the backup instance", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/BackupInstanceResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupInstanceResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/BackupInstanceResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create BackupInstance": { + "$ref": "./examples/BackupInstanceOperations/PutBackupInstance.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "BackupInstances" + ], + "description": "Delete a backup instance in a backup vault", + "operationId": "BackupInstances_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "backupInstanceName", + "description": "The name of the backup instance", + "in": "path", + "required": true, + "type": "string" + } + ], + "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" + }, + "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" + } + } + }, + "204": { + "description": "NoContent" + }, + "200": { + "description": "Ok" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete BackupInstance": { + "$ref": "./examples/BackupInstanceOperations/DeleteBackupInstance.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/backup": { + "post": { + "tags": [ + "BackupInstances" + ], + "description": "Trigger adhoc backup ", + "operationId": "BackupInstances_AdhocBackup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "backupInstanceName", + "description": "The name of the backup instance", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/TriggerBackupRequest" + } + } + ], + "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": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Trigger Adhoc Backup": { + "$ref": "./examples/BackupInstanceOperations/TriggerBackup.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/validateForBackup": { + "post": { + "tags": [ + "BackupInstances" + ], + "description": "Validate whether adhoc backup will be successful or not", + "operationId": "BackupInstances_ValidateForBackup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateForBackupRequest" + } + } + ], + "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": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Validate For Backup": { + "$ref": "./examples/BackupInstanceOperations/ValidateForBackup.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/recoveryPoints": { + "get": { + "tags": [ + "RecoveryPoint" + ], + "description": "Returns a list of Recovery Points for a DataSource in a vault.", + "operationId": "RecoveryPoints_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "backupInstanceName", + "description": "The name of the backup instance", + "in": "path", + "required": true, + "type": "string" + }, + { + "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-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/RecoveryPointsFilters", + "x-ms-examples": { + "List Recovery Points in a Vault": { + "$ref": "./examples/BackupInstanceOperations/ListRecoveryPoints.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/recoveryPoints/{recoveryPointId}": { + "get": { + "tags": [ + "RecoveryPoint" + ], + "description": "Gets a Recovery Point using recoveryPointId for a Datasource.", + "operationId": "RecoveryPoints_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "backupInstanceName", + "description": "The name of the backup instance", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "recoveryPointId", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBackupRecoveryPointResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Recovery Point": { + "$ref": "./examples/BackupInstanceOperations/GetRecoveryPoint.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/rehydrate": { + "post": { + "description": "rehydrate recovery point for restore for a BackupInstance", + "operationId": "BackupInstances_TriggerRehydrate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "description": "Request body for operation", + "in": "body", + "name": "parameters", + "required": true, + "schema": { + "$ref": "#/definitions/AzureBackupRehydrationRequest" + } + }, + { + "in": "path", + "name": "backupInstanceName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "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" + }, + "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" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "tags": [ + "BackupInstances" + ], + "x-ms-examples": { + "Trigger Rehydrate": { + "$ref": "./examples/BackupInstanceOperations/TriggerRehydrate.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/restore": { + "post": { + "tags": [ + "BackupInstances" + ], + "description": "Triggers restore for a BackupInstance", + "operationId": "BackupInstances_TriggerRestore", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "backupInstanceName", + "description": "The name of the backup instance", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/AzureBackupRestoreRequest" + } + } + ], + "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": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Trigger Restore": { + "$ref": "./examples/BackupInstanceOperations/TriggerRestore.json" + }, + "Trigger Restore As Files": { + "$ref": "./examples/BackupInstanceOperations/TriggerRestoreAsFiles.json" + }, + "Trigger Restore With Rehydration": { + "$ref": "./examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/resumeBackups": { + "post": { + "tags": [ + "BackupInstances" + ], + "description": "This operation will resume backups for backup instance", + "operationId": "BackupInstances_ResumeBackups", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "backupInstanceName", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "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": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ResumeBackups": { + "$ref": "./examples/BackupInstanceOperations/ResumeBackups.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/resumeProtection": { + "post": { + "tags": [ + "BackupInstances" + ], + "description": "This operation will resume protection for a stopped backup instance", + "operationId": "BackupInstances_ResumeProtection", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "backupInstanceName", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "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": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ResumeProtection": { + "$ref": "./examples/BackupInstanceOperations/ResumeProtection.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/stopProtection": { + "post": { + "tags": [ + "BackupInstances" + ], + "description": "This operation will stop protection of a backup instance and data will be held forever", + "operationId": "BackupInstances_StopProtection", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "backupInstanceName", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "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": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "StopProtection": { + "$ref": "./examples/BackupInstanceOperations/StopProtection.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/suspendBackups": { + "post": { + "tags": [ + "BackupInstances" + ], + "description": "This operation will stop backups for backup instance", + "operationId": "BackupInstances_SuspendBackups", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "backupInstanceName", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "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": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SuspendBackups": { + "$ref": "./examples/BackupInstanceOperations/SuspendBackups.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/sync": { + "post": { + "tags": [ + "BackupInstances" + ], + "description": "Sync backup instance again in case of failure\r\nThis action will retry last failed operation and will bring backup instance to valid state", + "operationId": "BackupInstances_SyncBackupInstance", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "backupInstanceName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/SyncBackupInstanceRequest" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "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": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Sync BackupInstance": { + "$ref": "./examples/BackupInstanceOperations/SyncBackupInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/validateRestore": { + "post": { + "tags": [ + "BackupInstances" + ], + "description": "Validates if Restore can be triggered for a DataSource", + "operationId": "BackupInstances_ValidateForRestore", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "backupInstanceName", + "description": "The name of the backup instance", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateRestoreRequestObject" + } + } + ], + "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": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Validate Restore": { + "$ref": "./examples/BackupInstanceOperations/ValidateRestore.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs": { + "get": { + "tags": [ + "AzureBackupJobs" + ], + "description": "Returns list of jobs belonging to a backup vault", + "operationId": "Jobs_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + } + ], + "responses": { + "200": { + "description": "OK", + "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": { + "Get Jobs": { + "$ref": "./examples/JobCRUD/ListJobs.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/findRestorableTimeRanges": { + "post": { + "tags": [ + "FindRestorableTimeRanges" + ], + "operationId": "RestorableTimeRanges_Find", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "backupInstanceName", + "description": "The name of the backup instance", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/AzureBackupFindRestorableTimeRangesRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBackupFindRestorableTimeRangesResponseResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Find Restorable Time Ranges": { + "$ref": "./examples/BackupInstanceOperations/FindRestorableTimeRanges.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs/{jobId}": { + "get": { + "tags": [ + "AzureBackupJob" + ], + "description": "Gets a job with id in a backup vault", + "operationId": "Jobs_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "jobId", + "description": "The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBackupJobResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Job": { + "$ref": "./examples/JobCRUD/GetJob.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/exportBackupJobs": { + "post": { + "tags": [ + "AzureBackupJob" + ], + "description": "Triggers export of jobs and returns an OperationID to track.", + "operationId": "ExportJobs_Trigger", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + } + ], + "responses": { + "202": { + "description": "Accepted", + "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": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Trigger Export Jobs": { + "$ref": "./examples/JobCRUD/TriggerExportJobs.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs/operations/{operationId}": { + "get": { + "tags": [ + "AzureBackupJob" + ], + "description": "Gets the operation result of operation triggered by Export Jobs API. If the operation is successful, then it also contains URL of a Blob and a SAS key to access the same. The blob contains exported jobs in JSON serialized format.", + "operationId": "ExportJobsOperationResult_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "operationId", + "description": "OperationID which represents the export job.", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ExportJobsResult" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Export Jobs Operation Result": { + "$ref": "./examples/JobCRUD/GetExportJobsOperationResult.json" + } + } + } + } + }, + "definitions": { + "AbsoluteDeleteOption": { + "allOf": [ + { + "$ref": "#/definitions/DeleteOption" + } + ], + "description": "Delete option with duration", + "required": [ + "duration", + "objectType" + ], + "title": "AbsoluteDeleteOption", + "type": "object", + "x-ms-discriminator-value": "AbsoluteDeleteOption" + }, + "RecoveryPointsFilters": { + "type": "object", + "properties": { + "restorePointDataStoreId": { + "type": "string" + }, + "isVisible": { + "type": "boolean" + }, + "startDate": { + "type": "string" + }, + "endDate": { + "type": "string" + }, + "extendedInfo": { + "type": "boolean" + }, + "restorePointState": { + "type": "string" + } + } + }, + "AdHocBackupRuleOptions": { + "description": "Adhoc backup rules", + "properties": { + "ruleName": { + "type": "string" + }, + "triggerOption": { + "$ref": "#/definitions/AdhocBackupTriggerOption" + } + }, + "required": [ + "ruleName", + "triggerOption" + ], + "title": "AdHocBackupRuleOptions", + "type": "object" + }, + "AdhocBackupTriggerOption": { + "description": "Adhoc backup trigger option", + "properties": { + "retentionTagOverride": { + "type": "string" + } + }, + "title": "AdhocBackupTriggerOption", + "type": "object" + }, + "AdhocBasedTaggingCriteria": { + "description": "Adhoc backup tagging criteria", + "properties": { + "tagInfo": { + "$ref": "#/definitions/RetentionTag", + "description": "Retention tag information" + } + }, + "title": "AdhocBasedTaggingCriteria", + "type": "object" + }, + "AdhocBasedTriggerContext": { + "allOf": [ + { + "$ref": "#/definitions/TriggerContext" + } + ], + "description": "Adhoc trigger context", + "properties": { + "taggingCriteria": { + "$ref": "#/definitions/AdhocBasedTaggingCriteria", + "description": "Tagging Criteria containing retention tag for adhoc backup." + } + }, + "required": [ + "objectType", + "taggingCriteria" + ], + "title": "AdhocBasedTriggerContext", + "type": "object", + "x-ms-discriminator-value": "AdhocBasedTriggerContext" + }, + "AuthCredentials": { + "description": "Base class for different types of authentication credentials.", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string", + "readOnly": false + } + }, + "discriminator": "objectType" + }, + "AzureBackupDiscreteRecoveryPoint": { + "allOf": [ + { + "$ref": "#/definitions/AzureBackupRecoveryPoint" + } + ], + "description": "Azure backup discrete RecoveryPoint", + "properties": { + "friendlyName": { + "type": "string" + }, + "recoveryPointDataStoresDetails": { + "items": { + "$ref": "#/definitions/RecoveryPointDataStoreDetails" + }, + "type": "array" + }, + "recoveryPointTime": { + "format": "date-time", + "type": "string" + }, + "policyName": { + "type": "string" + }, + "policyVersion": { + "type": "string" + }, + "recoveryPointId": { + "type": "string" + }, + "recoveryPointType": { + "type": "string" + }, + "retentionTagName": { + "type": "string" + }, + "retentionTagVersion": { + "type": "string" + } + }, + "required": [ + "recoveryPointTime" + ], + "title": "AzureBackupDiscreteRecoveryPoint", + "type": "object", + "x-ms-discriminator-value": "AzureBackupDiscreteRecoveryPoint" + }, + "AzureBackupFindRestorableTimeRangesRequest": { + "description": "List Restore Ranges Request", + "required": [ + "sourceDataStoreType" + ], + "type": "object", + "properties": { + "sourceDataStoreType": { + "description": "Gets or sets the type of the source data store.", + "enum": [ + "OperationalStore", + "VaultStore", + "ArchiveStore" + ], + "type": "string", + "x-ms-enum": { + "name": "RestoreSourceDataStoreType", + "modelAsString": true + } + }, + "startTime": { + "description": "Start time for the List Restore Ranges request. ISO 8601 format.", + "type": "string" + }, + "endTime": { + "description": "End time for the List Restore Ranges request. ISO 8601 format.", + "type": "string" + } + } + }, + "AzureBackupFindRestorableTimeRangesRequestResource": { + "description": "List Restore Ranges Request", + "allOf": [ + { + "$ref": "#/definitions/DppWorkerRequest" + } + ], + "properties": { + "content": { + "$ref": "#/definitions/AzureBackupFindRestorableTimeRangesRequest", + "description": "AzureBackupFindRestorableTimeRangesRequestResource content" + } + } + }, + "AzureBackupFindRestorableTimeRangesResponse": { + "description": "List Restore Ranges Response", + "type": "object", + "properties": { + "restorableTimeRanges": { + "description": "Returns the Restore Ranges available on the Backup Instance.", + "type": "array", + "items": { + "$ref": "#/definitions/RestorableTimeRange" + } + }, + "objectType": { + "type": "string" + } + } + }, + "AzureBackupFindRestorableTimeRangesResponseResource": { + "description": "List Restore Ranges Response", + "allOf": [ + { + "$ref": "#/definitions/DppResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AzureBackupFindRestorableTimeRangesResponse", + "description": "AzureBackupFindRestorableTimeRangesResponseResource properties" + } + } + }, + "AzureBackupJob": { + "description": "AzureBackup Job Class", + "properties": { + "activityID": { + "description": "Job Activity Id", + "type": "string" + }, + "backupInstanceFriendlyName": { + "description": "Name of the Backup Instance", + "type": "string" + }, + "backupInstanceId": { + "description": "ARM ID of the Backup Instance", + "readOnly": true, + "type": "string" + }, + "dataSourceId": { + "description": "ARM ID of the DataSource", + "type": "string" + }, + "dataSourceLocation": { + "description": "Location of the DataSource", + "type": "string" + }, + "dataSourceName": { + "description": "User Friendly Name of the DataSource", + "type": "string" + }, + "dataSourceSetName": { + "description": "Data Source Set Name of the DataSource", + "type": "string" + }, + "dataSourceType": { + "description": "Type of DataSource", + "type": "string" + }, + "duration": { + "description": "Total run time of the job. ISO 8601 format.", + "type": "string" + }, + "endTime": { + "description": "EndTime of the job(in UTC)", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "errorDetails": { + "description": "A List, detailing the errors related to the job", + "items": { + "$ref": "#/definitions/UserFacingError" + }, + "readOnly": true, + "type": "array" + }, + "extendedInfo": { + "$ref": "#/definitions/JobExtendedInfo", + "description": "Extended Information about the job", + "readOnly": true + }, + "isUserTriggered": { + "description": "Indicated that whether the job is adhoc(true) or scheduled(false)", + "type": "boolean" + }, + "operation": { + "description": "It indicates the type of Job i.e. Backup:full/log/diff ;Restore:ALR/OLR; Tiering:Backup/Archive ; Management:ConfigureProtection/UnConfigure", + "type": "string" + }, + "operationCategory": { + "description": "It indicates the type of Job i.e. Backup/Restore/Tiering/Management", + "type": "string" + }, + "policyId": { + "description": "ARM ID of the policy", + "readOnly": true, + "type": "string" + }, + "policyName": { + "description": "Name of the policy", + "readOnly": true, + "type": "string" + }, + "progressEnabled": { + "description": "Indicated whether progress is enabled for the job", + "type": "boolean" + }, + "progressUrl": { + "description": "Url which contains job's progress", + "readOnly": true, + "type": "string" + }, + "restoreType": { + "description": "It indicates the sub type of operation i.e. in case of Restore it can be ALR/OLR", + "readOnly": true, + "type": "string" + }, + "sourceResourceGroup": { + "description": "Resource Group Name of the Datasource", + "type": "string" + }, + "sourceSubscriptionID": { + "description": "SubscriptionId corresponding to the DataSource", + "type": "string" + }, + "startTime": { + "description": "StartTime of the job(in UTC)", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "Status of the job like InProgress/Success/Failed/Cancelled/SuccessWithWarning", + "type": "string" + }, + "subscriptionId": { + "description": "Subscription Id of the corresponding backup vault", + "type": "string" + }, + "supportedActions": { + "description": "List of supported actions", + "items": { + "type": "string" + }, + "type": "array" + }, + "vaultName": { + "description": "Name of the vault", + "type": "string" + }, + "etag": { + "type": "string" + }, + "sourceDataStoreName": { + "type": "string" + }, + "destinationDataStoreName": { + "type": "string" + } + }, + "required": [ + "activityID", + "subscriptionId", + "dataSourceId", + "vaultName", + "backupInstanceFriendlyName", + "sourceResourceGroup", + "dataSourceSetName", + "dataSourceName", + "progressEnabled", + "sourceSubscriptionID", + "dataSourceLocation", + "startTime", + "dataSourceType", + "operationCategory", + "operation", + "status", + "isUserTriggered", + "supportedActions" + ], + "type": "object" + }, + "AzureBackupJobResource": { + "allOf": [ + { + "$ref": "#/definitions/DppResource" + } + ], + "description": "AzureBackup Job Resource Class", + "properties": { + "properties": { + "$ref": "#/definitions/AzureBackupJob", + "description": "AzureBackupJobResource properties", + "type": "object" + } + }, + "type": "object" + }, + "AzureBackupJobResourceList": { + "allOf": [ + { + "$ref": "#/definitions/DppResourceList" + } + ], + "description": "List of AzureBackup Job resources", + "properties": { + "value": { + "description": "List of resources.", + "items": { + "$ref": "#/definitions/AzureBackupJobResource" + }, + "type": "array" + } + }, + "type": "object" + }, + "AzureBackupParams": { + "allOf": [ + { + "$ref": "#/definitions/BackupParameters" + } + ], + "description": "Azure backup parameters", + "properties": { + "backupType": { + "description": "BackupType ; Full/Incremental etc", + "type": "string" + } + }, + "required": [ + "backupType", + "objectType" + ], + "title": "AzureBackupParams", + "type": "object", + "x-ms-discriminator-value": "AzureBackupParams" + }, + "AzureBackupRecoveryPoint": { + "description": "Azure backup recoveryPoint", + "discriminator": "objectType", + "properties": { + "objectType": { + "type": "string" + } + }, + "required": [ + "objectType" + ], + "title": "AzureBackupRecoveryPoint", + "type": "object" + }, + "AzureBackupRecoveryPointBasedRestoreRequest": { + "allOf": [ + { + "$ref": "#/definitions/AzureBackupRestoreRequest" + } + ], + "description": "Azure backup recoveryPoint based restore request", + "properties": { + "recoveryPointId": { + "type": "string" + } + }, + "required": [ + "recoveryPointId" + ], + "title": "AzureBackupRecoveryPointBasedRestoreRequest", + "type": "object", + "x-ms-discriminator-value": "AzureBackupRecoveryPointBasedRestoreRequest" + }, + "AzureBackupRecoveryPointResource": { + "allOf": [ + { + "$ref": "#/definitions/DppResource" + } + ], + "description": "Azure backup recoveryPoint resource", + "properties": { + "properties": { + "$ref": "#/definitions/AzureBackupRecoveryPoint", + "description": "AzureBackupRecoveryPointResource properties" + } + }, + "title": "AzureBackupRecoveryPointResource" + }, + "AzureBackupRecoveryPointResourceList": { + "allOf": [ + { + "$ref": "#/definitions/DppResourceList" + } + ], + "description": "Azure backup recoveryPoint resource list", + "properties": { + "value": { + "description": "List of resources.", + "items": { + "$ref": "#/definitions/AzureBackupRecoveryPointResource" + }, + "type": "array" + } + }, + "title": "AzureBackupRecoveryPointResourceList", + "type": "object" + }, + "AzureBackupRehydrationRequest": { + "description": "Azure Backup Rehydrate Request", + "properties": { + "recoveryPointId": { + "description": "Id of the recovery point to be recovered", + "type": "string" + }, + "rehydrationPriority": { + "description": "Priority to be used for rehydration. Values High or Standard", + "$ref": "#/definitions/RehydrationPriority" + }, + "rehydrationRetentionDuration": { + "description": "Retention duration in ISO 8601 format i.e P10D .", + "type": "string" + } + }, + "required": [ + "recoveryPointId", + "rehydrationRetentionDuration" + ], + "title": "AzureBackupRehydrationRequest", + "type": "object" + }, + "AzureBackupRestoreRequest": { + "description": "Azure backup restore request", + "discriminator": "objectType", + "properties": { + "objectType": { + "type": "string" + }, + "restoreTargetInfo": { + "$ref": "#/definitions/RestoreTargetInfoBase", + "description": "Gets or sets the restore target information." + }, + "sourceDataStoreType": { + "description": "Gets or sets the type of the source data store.", + "enum": [ + "ArchiveStore", + "SnapshotStore", + "VaultStore" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "SourceDataStoreType" + } + } + }, + "required": [ + "objectType", + "restoreTargetInfo", + "sourceDataStoreType" + ], + "title": "AzureBackupRestoreRequest", + "type": "object" + }, + "AzureBackupRestoreWithRehydrationRequest": { + "allOf": [ + { + "$ref": "#/definitions/AzureBackupRecoveryPointBasedRestoreRequest" + } + ], + "description": "AzureBackup Restore with Rehydration Request", + "properties": { + "rehydrationPriority": { + "description": "Priority to be used for rehydration. Values High or Standard", + "$ref": "#/definitions/RehydrationPriority" + }, + "rehydrationRetentionDuration": { + "description": "Retention duration in ISO 8601 format i.e P10D .", + "type": "string" + } + }, + "required": [ + "rehydrationPriority", + "rehydrationRetentionDuration" + ], + "title": "AzureBackupRestoreWithRehydrationRequest", + "type": "object", + "x-ms-discriminator-value": "AzureBackupRestoreWithRehydrationRequest" + }, + "AzureBackupRecoveryTimeBasedRestoreRequest": { + "allOf": [ + { + "$ref": "#/definitions/AzureBackupRestoreRequest" + } + ], + "description": "AzureBackup RecoveryPointTime Based Restore Request", + "properties": { + "recoveryPointTime": { + "description": "The recovery time in ISO 8601 format example - 2020-08-14T17:30:00.0000000Z.", + "type": "string" + } + }, + "required": [ + "recoveryPointTime" + ], + "title": "AzureBackupRecoveryTimeBasedRestoreRequest", + "type": "object", + "x-ms-discriminator-value": "AzureBackupRecoveryTimeBasedRestoreRequest" + }, + "AzureBackupRule": { + "allOf": [ + { + "$ref": "#/definitions/BasePolicyRule" + } + ], + "description": "Azure backup rule", + "properties": { + "backupParameters": { + "$ref": "#/definitions/BackupParameters" + }, + "dataStore": { + "$ref": "#/definitions/DataStoreInfoBase" + }, + "trigger": { + "$ref": "#/definitions/TriggerContext" + } + }, + "required": [ + "dataStore", + "name", + "objectType", + "trigger" + ], + "title": "AzureBackupRule", + "type": "object", + "x-ms-discriminator-value": "AzureBackupRule" + }, + "AzureOperationalStoreParameters": { + "description": "Parameters for Operational-Tier DataStore", + "required": [ + "objectType", + "dataStoreType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataStoreParameters" + } + ], + "properties": { + "resourceGroupId": { + "description": "Gets or sets the Snapshot Resource Group Uri.", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureOperationalStoreParameters" + }, + "AzureRetentionRule": { + "allOf": [ + { + "$ref": "#/definitions/BasePolicyRule" + } + ], + "description": "Azure retention rule", + "properties": { + "isDefault": { + "type": "boolean" + }, + "lifecycles": { + "items": { + "$ref": "#/definitions/SourceLifeCycle" + }, + "type": "array" + } + }, + "required": [ + "lifecycles", + "name", + "objectType" + ], + "title": "AzureRetentionRule", + "type": "object", + "x-ms-discriminator-value": "AzureRetentionRule" + }, + "BackupCriteria": { + "description": "BackupCriteria base class", + "discriminator": "objectType", + "properties": { + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string" + } + }, + "required": [ + "objectType" + ], + "title": "BackupCriteria", + "type": "object" + }, + "BackupInstance": { + "description": "Backup Instance", + "required": [ + "dataSourceInfo", + "policyInfo", + "objectType" + ], + "type": "object", + "properties": { + "friendlyName": { + "description": "Gets or sets the Backup Instance friendly name.", + "type": "string" + }, + "dataSourceInfo": { + "$ref": "#/definitions/Datasource", + "description": "Gets or sets the data source information." + }, + "dataSourceSetInfo": { + "$ref": "#/definitions/DatasourceSet", + "description": "Gets or sets the data source set information." + }, + "policyInfo": { + "$ref": "#/definitions/PolicyInfo", + "description": "Gets or sets the policy information." + }, + "protectionStatus": { + "$ref": "#/definitions/ProtectionStatusDetails", + "description": "Specifies the protection status of the resource", + "readOnly": true + }, + "currentProtectionState": { + "description": "Specifies the current protection state of the resource", + "enum": [ + "Invalid", + "NotProtected", + "ConfiguringProtection", + "ProtectionConfigured", + "BackupSchedulesSuspended", + "RetentionSchedulesSuspended", + "ProtectionStopped", + "ProtectionError", + "ConfiguringProtectionFailed", + "SoftDeleting", + "SoftDeleted", + "UpdatingProtection" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "CurrentProtectionState", + "modelAsString": true + } + }, + "protectionErrorDetails": { + "$ref": "#/definitions/UserFacingError", + "description": "Specifies the protection error of the resource", + "readOnly": true + }, + "provisioningState": { + "description": "Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed", + "type": "string", + "readOnly": true + }, + "datasourceAuthCredentials": { + "$ref": "#/definitions/AuthCredentials", + "description": "Credentials to use to authenticate with data source provider." + }, + "objectType": { + "type": "string" + } + } + }, + "BackupInstanceResource": { + "allOf": [ + { + "$ref": "#/definitions/DppResource" + } + ], + "description": "BackupInstance Resource", + "properties": { + "properties": { + "$ref": "#/definitions/BackupInstance", + "description": "BackupInstanceResource properties" + } + }, + "title": "BackupInstanceResource" + }, + "BackupInstanceResourceList": { + "allOf": [ + { + "$ref": "#/definitions/DppResourceList" + } + ], + "description": "BackupInstance Resource list response", + "properties": { + "value": { + "description": "List of resources.", + "items": { + "$ref": "#/definitions/BackupInstanceResource" + }, + "type": "array" + } + }, + "title": "BackupInstanceResourceList", + "type": "object" + }, + "BackupParameters": { + "description": "BackupParameters base", + "discriminator": "objectType", + "properties": { + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string" + } + }, + "required": [ + "objectType" + ], + "title": "BackupParameters", + "type": "object" + }, + "BackupPolicy": { + "allOf": [ + { + "$ref": "#/definitions/BaseBackupPolicy" + } + ], + "description": "Rule based backup policy", + "properties": { + "policyRules": { + "description": "Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc", + "items": { + "$ref": "#/definitions/BasePolicyRule" + }, + "type": "array" + } + }, + "required": [ + "datasourceTypes", + "policyRules" + ], + "title": "BackupPolicy", + "type": "object", + "x-ms-discriminator-value": "BackupPolicy" + }, + "BackupSchedule": { + "description": "Schedule for backup", + "properties": { + "repeatingTimeIntervals": { + "description": "ISO 8601 repeating time interval format", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "repeatingTimeIntervals" + ], + "title": "BackupSchedule", + "type": "object" + }, + "BackupVault": { + "description": "Backup Vault", + "properties": { + "provisioningState": { + "description": "Provisioning state of the BackupVault resource", + "enum": [ + "Failed", + "Provisioning", + "Succeeded", + "Unknown", + "Updating" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ProvisioningState" + } + }, + "storageSettings": { + "description": "Storage Settings", + "items": { + "$ref": "#/definitions/StorageSetting" + }, + "type": "array" + } + }, + "required": [ + "storageSettings" + ], + "title": "BackupVault", + "type": "object" + }, + "BackupVaultResource": { + "allOf": [ + { + "$ref": "#/definitions/DppTrackedResource" + } + ], + "description": "Backup Vault Resource", + "properties": { + "properties": { + "$ref": "#/definitions/BackupVault", + "description": "BackupVaultResource properties" + } + }, + "required": [ + "location", + "properties" + ], + "title": "BackupVault Resource" + }, + "BackupVaultResourceList": { + "allOf": [ + { + "$ref": "#/definitions/DppResourceList" + } + ], + "description": "List of BackupVault resources", + "properties": { + "value": { + "description": "List of resources.", + "items": { + "$ref": "#/definitions/BackupVaultResource" + }, + "type": "array" + } + }, + "title": "BackupVaultResourceList", + "type": "object" + }, + "BaseBackupPolicy": { + "description": "BackupPolicy base", + "discriminator": "objectType", + "properties": { + "datasourceTypes": { + "description": "Type of datasource for the backup management", + "items": { + "type": "string" + }, + "type": "array" + }, + "objectType": { + "type": "string" + } + }, + "required": [ + "datasourceTypes", + "objectType" + ], + "title": "BaseBackupPolicy", + "type": "object" + }, + "BaseBackupPolicyResource": { + "allOf": [ + { + "$ref": "#/definitions/DppResource" + } + ], + "description": "BaseBackupPolicy resource", + "properties": { + "properties": { + "$ref": "#/definitions/BaseBackupPolicy", + "description": "BaseBackupPolicyResource properties" + } + }, + "title": "BaseBackupPolicyResource" + }, + "BaseBackupPolicyResourceList": { + "allOf": [ + { + "$ref": "#/definitions/DppResourceList" + } + ], + "description": "List of BaseBackupPolicy resources", + "properties": { + "value": { + "description": "List of resources.", + "items": { + "$ref": "#/definitions/BaseBackupPolicyResource" + }, + "type": "array" + } + }, + "title": "BaseBackupPolicyResourceList", + "type": "object" + }, + "BasePolicyRule": { + "description": "BasePolicy Rule", + "discriminator": "objectType", + "properties": { + "name": { + "type": "string" + }, + "objectType": { + "type": "string" + } + }, + "required": [ + "name", + "objectType" + ], + "title": "BasePolicyRule", + "type": "object" + }, + "CheckNameAvailabilityRequest": { + "description": "CheckNameAvailability Request", + "properties": { + "name": { + "description": "Resource name for which availability needs to be checked", + "type": "string" + }, + "type": { + "description": "Describes the Resource type: Microsoft.DataProtection/BackupVaults", + "type": "string" + } + }, + "title": "CheckNameAvailabilityRequest", + "type": "object" + }, + "CheckNameAvailabilityResult": { + "description": "CheckNameAvailability Result", + "properties": { + "message": { + "description": "Gets or sets the message.", + "type": "string" + }, + "nameAvailable": { + "description": "Gets or sets a value indicating whether [name available].", + "type": "boolean" + }, + "reason": { + "description": "Gets or sets the reason.", + "type": "string" + } + }, + "title": "CheckNameAvailabilityResult", + "type": "object" + }, + "ClientDiscoveryDisplay": { + "description": "Localized display information of an operation.", + "properties": { + "description": { + "description": "Description of the operation having details of what operation is about.", + "type": "string" + }, + "operation": { + "description": "Operations Name itself.", + "type": "string" + }, + "provider": { + "description": "Name of the provider for display purposes", + "type": "string" + }, + "resource": { + "description": "ResourceType for which this Operation can be performed.", + "type": "string" + } + }, + "title": "ClientDiscoveryDisplay", + "type": "object" + }, + "ClientDiscoveryForLogSpecification": { + "description": "Class to represent shoebox log specification in json client discovery.", + "properties": { + "blobDuration": { + "description": "blob duration of shoebox log specification", + "type": "string" + }, + "displayName": { + "description": "Localized display name", + "type": "string" + }, + "name": { + "description": "Name for shoebox log specification.", + "type": "string" + } + }, + "title": "ClientDiscoveryForLogSpecification", + "type": "object" + }, + "ClientDiscoveryForProperties": { + "description": "Class to represent shoebox properties in json client discovery.", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ClientDiscoveryForServiceSpecification", + "description": "Operation properties." + } + }, + "title": "ClientDiscoveryForProperties", + "type": "object" + }, + "ClientDiscoveryForServiceSpecification": { + "description": "Class to represent shoebox service specification in json client discovery.", + "properties": { + "logSpecifications": { + "description": "List of log specifications of this operation.", + "items": { + "$ref": "#/definitions/ClientDiscoveryForLogSpecification" + }, + "type": "array" + } + }, + "title": "ClientDiscoveryForServiceSpecification", + "type": "object" + }, + "ClientDiscoveryResponse": { + "description": "Operations List response which contains list of available APIs.", + "properties": { + "nextLink": { + "description": "Link to the next chunk of Response.", + "type": "string" + }, + "value": { + "description": "List of available operations.", + "items": { + "$ref": "#/definitions/ClientDiscoveryValueForSingleApi" + }, + "type": "array" + } + }, + "title": "ClientDiscoveryResponse", + "type": "object" + }, + "ClientDiscoveryValueForSingleApi": { + "description": "Available operation details.", + "properties": { + "display": { + "$ref": "#/definitions/ClientDiscoveryDisplay", + "description": "Contains the localized display information for this particular operation" + }, + "name": { + "description": "Name of the Operation.", + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "origin": { + "description": "The intended executor of the operation;governs the display of the operation in the RBAC UX and the audit logs UX", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/ClientDiscoveryForProperties", + "description": "Properties for the given operation." + } + }, + "title": "ClientDiscoveryValueForSingleApi", + "type": "object" + }, + "CloudError": { + "description": "An error response from Azure Backup.", + "properties": { + "error": { + "$ref": "#/definitions/Error" + } + }, + "title": "CloudError", + "x-ms-external": true + }, + "CopyOnExpiryOption": { + "allOf": [ + { + "$ref": "#/definitions/CopyOption" + } + ], + "description": "Copy on Expiry Option", + "required": [ + "objectType" + ], + "title": "CopyOnExpiryOption", + "type": "object", + "x-ms-discriminator-value": "CopyOnExpiryOption" + }, + "CopyOption": { + "description": "Options to copy", + "discriminator": "objectType", + "properties": { + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string" + } + }, + "required": [ + "objectType" + ], + "title": "CopyOption", + "type": "object" + }, + "CustomCopyOption": { + "allOf": [ + { + "$ref": "#/definitions/CopyOption" + } + ], + "description": "Duration based custom options to copy", + "properties": { + "duration": { + "description": "Data copied after given timespan", + "type": "string" + } + }, + "required": [ + "objectType" + ], + "title": "CustomCopyOption", + "type": "object", + "x-ms-discriminator-value": "CustomCopyOption" + }, + "Datasource": { + "description": "Datasource to be backed up", + "properties": { + "datasourceType": { + "description": "DatasourceType of the resource.", + "type": "string" + }, + "objectType": { + "description": "Type of Datasource object, used to initialize the right inherited type", + "type": "string" + }, + "resourceID": { + "description": "Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault.", + "type": "string" + }, + "resourceLocation": { + "description": "Location of datasource.", + "type": "string" + }, + "resourceName": { + "description": "Unique identifier of the resource in the context of parent.", + "type": "string" + }, + "resourceType": { + "description": "Resource Type of Datasource.", + "type": "string" + }, + "resourceUri": { + "description": "Uri of the resource.", + "type": "string" + } + }, + "required": [ + "resourceID" + ], + "title": "Datasource", + "type": "object" + }, + "DatasourceSet": { + "description": "DatasourceSet details of datasource to be backed up", + "properties": { + "datasourceType": { + "description": "DatasourceType of the resource.", + "type": "string" + }, + "objectType": { + "description": "Type of Datasource object, used to initialize the right inherited type", + "type": "string" + }, + "resourceID": { + "description": "Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault.", + "type": "string" + }, + "resourceLocation": { + "description": "Location of datasource.", + "type": "string" + }, + "resourceName": { + "description": "Unique identifier of the resource in the context of parent.", + "type": "string" + }, + "resourceType": { + "description": "Resource Type of Datasource.", + "type": "string" + }, + "resourceUri": { + "description": "Uri of the resource.", + "type": "string" + } + }, + "required": [ + "resourceID" + ], + "title": "DatasourceSet", + "type": "object" + }, + "DataStoreInfoBase": { + "description": "DataStoreInfo base", + "properties": { + "dataStoreType": { + "description": "type of datastore; Operational/Vault/Archive", + "enum": [ + "OperationalStore", + "VaultStore", + "ArchiveStore" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DataStoreTypes" + } + }, + "objectType": { + "description": "Type of Datasource object, used to initialize the right inherited type", + "readOnly": false, + "type": "string" + } + }, + "required": [ + "dataStoreType", + "objectType" + ], + "title": "DataStoreInfoBase", + "type": "object" + }, + "DataStoreParameters": { + "description": "Parameters for DataStore", + "required": [ + "objectType", + "dataStoreType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string", + "readOnly": false + }, + "dataStoreType": { + "description": "type of datastore; Operational/Vault/Archive", + "enum": [ + "OperationalStore", + "VaultStore", + "ArchiveStore" + ], + "type": "string", + "x-ms-enum": { + "name": "DataStoreTypes", + "modelAsString": true + } + } + }, + "discriminator": "objectType" + }, + "Day": { + "description": "Day of the week", + "properties": { + "date": { + "description": "Date of the month", + "format": "int32", + "type": "integer" + }, + "isLast": { + "description": "Whether Date is last date of month", + "type": "boolean" + } + }, + "title": "Day", + "type": "object" + }, + "DeleteOption": { + "description": "Delete Option", + "discriminator": "objectType", + "properties": { + "duration": { + "description": "Duration of deletion after given timespan", + "type": "string" + }, + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string" + } + }, + "required": [ + "duration", + "objectType" + ], + "title": "DeleteOption", + "type": "object" + }, + "DppIdentityDetails": { + "description": "Identity details", + "properties": { + "principalId": { + "description": "The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource.", + "readOnly": true, + "type": "string" + }, + "tenantId": { + "description": "A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The identityType which can be either SystemAssigned or None", + "type": "string" + } + }, + "title": "DppIdentityDetails", + "type": "object" + }, + "DppResource": { + "description": "Resource class", + "properties": { + "id": { + "description": "Resource Id represents the complete path to the resource.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Resource name associated with the resource.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...", + "readOnly": true, + "type": "string" + }, + "systemData": { + "$ref": "#/definitions/systemData" + } + }, + "title": "DppResource", + "type": "object", + "x-ms-azure-resource": true + }, + "DppResourceList": { + "description": "ListResource", + "properties": { + "nextLink": { + "description": "The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.", + "type": "string" + } + }, + "title": "List Resource", + "type": "object" + }, + "DppTrackedResource": { + "properties": { + "eTag": { + "description": "Optional ETag.", + "type": "string" + }, + "id": { + "description": "Resource Id represents the complete path to the resource.", + "readOnly": true, + "type": "string" + }, + "identity": { + "$ref": "#/definitions/DppIdentityDetails", + "description": "Input Managed Identity Details" + }, + "location": { + "description": "Resource location.", + "type": "string" + }, + "name": { + "description": "Resource name associated with the resource.", + "readOnly": true, + "type": "string" + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags.", + "type": "object" + }, + "type": { + "description": "Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...", + "readOnly": true, + "type": "string" + }, + "systemData": { + "$ref": "#/definitions/systemData" + } + }, + "type": "object", + "x-ms-azure-resource": true + }, + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "type": "string", + "description": "The type of identity that created the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)." + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "type": "string", + "description": "The type of identity that last modified the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The type of identity that last modified the resource." + } + } + }, + "DppTrackedResourceList": { + "properties": { + "nextLink": { + "description": "The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.", + "type": "string" + } + }, + "type": "object" + }, + "DppWorkerRequest": { + "type": "object", + "properties": { + "subscriptionId": { + "type": "string" + }, + "uri": { + "type": "string" + }, + "headers": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "supportedGroupVersions": { + "type": "array", + "items": { + "type": "string" + } + }, + "cultureInfo": { + "type": "string" + }, + "parameters": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "httpMethod": { + "type": "string" + } + } + }, + "Error": { + "description": "The resource management error response.", + "properties": { + "additionalInfo": { + "description": "The error additional info.", + "items": { + "$ref": "#/definitions/ErrorAdditionalInfo" + }, + "readOnly": true, + "type": "array" + }, + "code": { + "description": "The error code.", + "readOnly": true, + "type": "string" + }, + "details": { + "description": "The error details.", + "items": { + "$ref": "#/definitions/Error" + }, + "readOnly": true, + "type": "array" + }, + "message": { + "description": "The error message.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "The error target.", + "readOnly": true, + "type": "string" + } + } + }, + "ErrorAdditionalInfo": { + "description": "The resource management error additional info.", + "properties": { + "info": { + "description": "The additional info.", + "readOnly": true, + "type": "object" + }, + "type": { + "description": "The additional info type.", + "readOnly": true, + "type": "string" + } + } + }, + "ExportJobsResult": { + "description": "The result for export jobs containing blob details.", + "properties": { + "blobUrl": { + "description": "URL of the blob into which the serialized string of list of jobs is exported.", + "readOnly": true, + "type": "string" + }, + "blobSasKey": { + "description": "SAS key to access the blob.", + "readOnly": true, + "type": "string" + }, + "excelFileBlobUrl": { + "description": "URL of the blob into which the ExcelFile is uploaded.", + "readOnly": true, + "type": "string" + }, + "excelFileBlobSasKey": { + "description": "SAS key to access the ExcelFile blob.", + "readOnly": true, + "type": "string" + } + }, + "title": "ExportJobsResult", + "type": "object" + }, + "FeatureValidationRequest": { + "description": "Base class for feature object", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FeatureValidationRequestBase" + } + ], + "properties": { + "featureType": { + "description": "backup support feature type.", + "enum": [ + "Invalid", + "DataSourceType" + ], + "type": "string", + "x-ms-enum": { + "name": "FeatureType", + "modelAsString": true + } + }, + "featureName": { + "description": "backup support feature name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "FeatureValidationRequest" + }, + "FeatureValidationRequestBase": { + "description": "Base class for Backup Feature support", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string", + "readOnly": false + } + }, + "discriminator": "objectType" + }, + "FeatureValidationResponse": { + "description": "Feature Validation Response", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FeatureValidationResponseBase" + } + ], + "properties": { + "featureType": { + "description": "backup support feature type.", + "enum": [ + "Invalid", + "DataSourceType" + ], + "type": "string", + "x-ms-enum": { + "name": "FeatureType", + "modelAsString": true + } + }, + "features": { + "description": "Response features", + "type": "array", + "items": { + "$ref": "#/definitions/SupportedFeature" + } + } + }, + "x-ms-discriminator-value": "FeatureValidationResponse" + }, + "FeatureValidationResponseBase": { + "description": "Base class for Backup Feature support", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string", + "readOnly": false + } + }, + "discriminator": "objectType" + }, + "ImmediateCopyOption": { + "allOf": [ + { + "$ref": "#/definitions/CopyOption" + } + ], + "description": "Immediate copy Option", + "required": [ + "objectType" + ], + "title": "ImmediateCopyOption", + "type": "object", + "x-ms-discriminator-value": "ImmediateCopyOption" + }, + "InnerError": { + "description": "Inner Error", + "properties": { + "additionalInfo": { + "additionalProperties": { + "type": "string" + }, + "description": "Any Key value pairs that can be provided to the client for additional verbose information.", + "type": "object" + }, + "code": { + "description": "Unique code for this error", + "type": "string" + }, + "embeddedInnerError": { + "$ref": "#/definitions/InnerError", + "description": "Child Inner Error, to allow Nesting." + } + }, + "title": "InnerError", + "type": "object" + }, + "ItemLevelRestoreCriteria": { + "description": "Class to contain criteria for item level restore", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string" + } + }, + "discriminator": "objectType" + }, + "ItemLevelRestoreTargetInfo": { + "description": "Restore target info for Item level restore operation", + "required": [ + "restoreCriteria", + "datasourceInfo", + "recoveryOption" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RestoreTargetInfoBase" + } + ], + "properties": { + "restoreCriteria": { + "description": "Restore Criteria", + "type": "array", + "items": { + "$ref": "#/definitions/ItemLevelRestoreCriteria" + } + }, + "datasourceInfo": { + "$ref": "#/definitions/Datasource", + "description": "Information of target DS" + }, + "datasourceSetInfo": { + "$ref": "#/definitions/DatasourceSet", + "description": "Information of target DS Set" + }, + "datasourceAuthCredentials": { + "$ref": "#/definitions/AuthCredentials", + "description": "Credentials to use to authenticate with data source provider." + } + }, + "x-ms-discriminator-value": "ItemLevelRestoreTargetInfo" + }, + "JobExtendedInfo": { + "description": "Extended Information about the job", + "properties": { + "additionalDetails": { + "additionalProperties": { + "readOnly": true, + "type": "string" + }, + "description": "Job's Additional Details" + }, + "backupInstanceState": { + "description": "State of the Backup Instance", + "readOnly": true, + "type": "string" + }, + "dataTransferredInBytes": { + "description": "Number of bytes transferred", + "format": "double", + "readOnly": true, + "type": "number" + }, + "recoveryDestination": { + "description": "Destination where restore is done", + "readOnly": true, + "type": "string" + }, + "sourceRecoverPoint": { + "$ref": "#/definitions/RestoreJobRecoveryPointDetails", + "description": "Details of the Source Recovery Point", + "readOnly": true + }, + "subTasks": { + "description": "List of Sub Tasks of the job", + "items": { + "$ref": "#/definitions/JobSubTask" + }, + "readOnly": true, + "type": "array" + }, + "targetRecoverPoint": { + "$ref": "#/definitions/RestoreJobRecoveryPointDetails", + "description": "Details of the Target Recovery Point", + "readOnly": true + } + }, + "type": "object" + }, + "JobSubTask": { + "description": "Details of Job's Sub Task", + "properties": { + "additionalDetails": { + "additionalProperties": { + "readOnly": true, + "type": "string" + }, + "description": "Additional details of Sub Tasks" + }, + "taskId": { + "description": "Task Id of the Sub Task", + "format": "int32", + "type": "integer" + }, + "taskName": { + "description": "Name of the Sub Task", + "type": "string" + }, + "taskProgress": { + "description": "Progress of the Sub Task", + "readOnly": true, + "type": "string" + }, + "taskStatus": { + "description": "Status of the Sub Task", + "type": "string" + } + }, + "required": [ + "taskId", + "taskName", + "taskStatus" + ], + "type": "object" + }, + "OperationExtendedInfo": { + "description": "Operation Extended Info", + "properties": { + "objectType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + } + }, + "title": "OperationExtendedInfo", + "type": "object" + }, + "OperationJobExtendedInfo": { + "allOf": [ + { + "$ref": "#/definitions/OperationExtendedInfo" + } + ], + "description": "Operation Job Extended Info", + "properties": { + "jobId": { + "description": "Arm Id of the job created for this operation.", + "type": "string" + } + }, + "title": "OperationJobExtendedInfo", + "type": "object", + "x-ms-discriminator-value": "OperationJobExtendedInfo" + }, + "OperationResource": { + "description": "Operation Resource", + "properties": { + "endTime": { + "description": "End time of the operation", + "format": "date-time", + "type": "string" + }, + "error": { + "$ref": "#/definitions/Error", + "description": "Required if status == failed or status == canceled. This is the OData v4 error format, used by the RPC and will go into the v2.2 Azure REST API guidelines.\r\nThe full set of optional properties (e.g. inner errors / details) can be found in the \"Error Response\" section." + }, + "id": { + "description": "It should match what is used to GET the operation result", + "type": "string" + }, + "name": { + "description": "It must match the last segment of the \"id\" field, and will typically be a GUID / system generated value", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/OperationExtendedInfo", + "description": "End time of the operation" + }, + "startTime": { + "description": "Start time of the operation", + "format": "date-time", + "type": "string" + }, + "status": { + "type": "string" + } + }, + "title": "OperationResource", + "type": "object" + }, + "PatchResourceRequestInput": { + "description": "Patch Request content for Microsoft.DataProtection resources", + "properties": { + "identity": { + "$ref": "#/definitions/DppIdentityDetails", + "description": "Input Managed Identity Details" + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags.", + "type": "object" + } + }, + "title": "PatchResourceRequestInput", + "type": "object" + }, + "PolicyInfo": { + "description": "Policy Info in backupInstance", + "properties": { + "policyId": { + "type": "string" + }, + "policyVersion": { + "readOnly": true, + "type": "string" + }, + "policyParameters": { + "$ref": "#/definitions/PolicyParameters", + "description": "Policy parameters for the backup instance" + } + }, + "required": [ + "policyId" + ], + "title": "PolicyInfo", + "type": "object" + }, + "PolicyParameters": { + "description": "Parameters in Policy", + "type": "object", + "properties": { + "dataStoreParametersList": { + "description": "Gets or sets the DataStore Parameters", + "type": "array", + "items": { + "$ref": "#/definitions/DataStoreParameters" + } + } + } + }, + "ProtectionStatusDetails": { + "description": "Protection status details", + "properties": { + "errorDetails": { + "$ref": "#/definitions/UserFacingError", + "description": "Specifies the protection status error of the resource" + }, + "status": { + "description": "Specifies the protection status of the resource", + "enum": [ + "ConfiguringProtection", + "ConfiguringProtectionFailed", + "ProtectionConfigured", + "ProtectionStopped", + "SoftDeleted", + "SoftDeleting" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "Status" + } + } + }, + "title": "ProtectionStatusDetails", + "type": "object" + }, + "RangeBasedItemLevelRestoreCriteria": { + "description": "Item Level target info for restore operation", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ItemLevelRestoreCriteria" + } + ], + "properties": { + "minMatchingValue": { + "description": "minimum value for range prefix match", + "type": "string" + }, + "maxMatchingValue": { + "description": "maximum value for range prefix match", + "type": "string" + } + }, + "x-ms-discriminator-value": "RangeBasedItemLevelRestoreCriteria" + }, + "RecoveryPointDataStoreDetails": { + "description": "RecoveryPoint datastore details", + "properties": { + "creationTime": { + "format": "date-time", + "type": "string" + }, + "expiryTime": { + "format": "date-time", + "type": "string" + }, + "id": { + "type": "string" + }, + "metaData": { + "type": "string" + }, + "state": { + "type": "string" + }, + "type": { + "type": "string" + }, + "visible": { + "type": "boolean" + }, + "rehydrationExpiryTime": { + "format": "date-time", + "type": "string", + "readOnly": true + }, + "rehydrationStatus": { + "readOnly": true, + "enum": [ + "CREATE_IN_PROGRESS", + "COMPLETED", + "DELETE_IN_PROGRESS", + "DELETED", + "FAILED" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "RehydrationStatus" + } + } + }, + "title": "RecoveryPointDataStoreDetails", + "type": "object" + }, + "RehydrationPriority": { + "description": "Priority to be used for rehydration. Values High or Standard", + "enum": [ + "Invalid", + "High", + "Standard" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "RehydrationPriority" + } + }, + "RestoreFilesTargetInfo": { + "allOf": [ + { + "$ref": "#/definitions/RestoreTargetInfoBase" + } + ], + "description": "Class encapsulating restore as files target parameters", + "properties": { + "targetDetails": { + "$ref": "#/definitions/TargetDetails", + "description": "Destination of RestoreAsFiles operation, when destination is not a datasource" + } + }, + "required": [ + "recoveryOption", + "targetDetails" + ], + "type": "object", + "x-ms-discriminator-value": "RestoreFilesTargetInfo" + }, + "RestoreJobRecoveryPointDetails": { + "properties": { + "recoveryPointID": { + "type": "string" + }, + "recoveryPointTime": { + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "RestoreTargetInfo": { + "allOf": [ + { + "$ref": "#/definitions/RestoreTargetInfoBase" + } + ], + "description": "Class encapsulating restore target parameters", + "properties": { + "datasourceInfo": { + "$ref": "#/definitions/Datasource", + "description": "Information of target DS" + }, + "datasourceSetInfo": { + "$ref": "#/definitions/DatasourceSet", + "description": "Information of target DS Set" + }, + "datasourceAuthCredentials": { + "$ref": "#/definitions/AuthCredentials", + "description": "Credentials to use to authenticate with data source provider." + } + }, + "required": [ + "datasourceInfo", + "recoveryOption" + ], + "type": "object", + "x-ms-discriminator-value": "RestoreTargetInfo" + }, + "RestoreTargetInfoBase": { + "description": "Base class common to RestoreTargetInfo and RestoreFilesTargetInfo", + "discriminator": "objectType", + "properties": { + "objectType": { + "description": "Type of Datasource object, used to initialize the right inherited type", + "type": "string" + }, + "recoveryOption": { + "description": "Recovery Option", + "enum": [ + "FailIfExists" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "RecoveryOption" + } + }, + "restoreLocation": { + "description": "Target Restore region", + "type": "string" + } + }, + "required": [ + "objectType", + "recoveryOption" + ], + "type": "object" + }, + "RestorableTimeRange": { + "required": [ + "startTime", + "endTime" + ], + "type": "object", + "properties": { + "startTime": { + "description": "Start time for the available restore range", + "type": "string" + }, + "endTime": { + "description": "End time for the available restore range", + "type": "string" + }, + "objectType": { + "type": "string" + } + } + }, + "RetentionTag": { + "description": "Retention tag", + "properties": { + "eTag": { + "description": "Retention Tag version.", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Retention Tag version.", + "readOnly": true, + "type": "string" + }, + "tagName": { + "description": "Retention Tag Name to relate it to retention rule.", + "type": "string" + } + }, + "required": [ + "tagName" + ], + "title": "RetentionTag", + "type": "object" + }, + "ScheduleBasedBackupCriteria": { + "allOf": [ + { + "$ref": "#/definitions/BackupCriteria" + } + ], + "description": "Schedule based backup criteria", + "properties": { + "absoluteCriteria": { + "description": "it contains absolute values like \"AllBackup\" / \"FirstOfDay\" / \"FirstOfWeek\" / \"FirstOfMonth\"\r\nand should be part of AbsoluteMarker enum", + "items": { + "enum": [ + "AllBackup", + "FirstOfDay", + "FirstOfMonth", + "FirstOfWeek", + "FirstOfYear" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AbsoluteMarker" + } + }, + "type": "array" + }, + "daysOfMonth": { + "description": "This is day of the month from 1 to 28 other wise last of month", + "items": { + "$ref": "#/definitions/Day" + }, + "type": "array" + }, + "daysOfTheWeek": { + "description": "It should be Sunday/Monday/T..../Saturday", + "items": { + "enum": [ + "Friday", + "Monday", + "Saturday", + "Sunday", + "Thursday", + "Tuesday", + "Wednesday" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DayOfWeek" + } + }, + "type": "array" + }, + "monthsOfYear": { + "description": "It should be January/February/....../December", + "items": { + "enum": [ + "April", + "August", + "December", + "February", + "January", + "July", + "June", + "March", + "May", + "November", + "October", + "September" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "Month" + } + }, + "type": "array" + }, + "scheduleTimes": { + "description": "List of schedule times for backup", + "items": { + "format": "date-time", + "type": "string" + }, + "type": "array" + }, + "weeksOfTheMonth": { + "description": "It should be First/Second/Third/Fourth/Last", + "items": { + "enum": [ + "First", + "Fourth", + "Last", + "Second", + "Third" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "WeekNumber" + } + }, + "type": "array" + } + }, + "required": [ + "objectType" + ], + "title": "ScheduleBasedBackupCriteria", + "type": "object", + "x-ms-discriminator-value": "ScheduleBasedBackupCriteria" + }, + "ScheduleBasedTriggerContext": { + "allOf": [ + { + "$ref": "#/definitions/TriggerContext" + } + ], + "description": "Schedule based trigger context", + "properties": { + "schedule": { + "$ref": "#/definitions/BackupSchedule", + "description": "Schedule for this backup" + }, + "taggingCriteria": { + "description": "List of tags that can be applicable for given schedule.", + "items": { + "$ref": "#/definitions/TaggingCriteria" + }, + "type": "array" + } + }, + "required": [ + "objectType", + "schedule", + "taggingCriteria" + ], + "title": "ScheduleBasedTriggerContext", + "type": "object", + "x-ms-discriminator-value": "ScheduleBasedTriggerContext" + }, + "SecretStoreBasedAuthCredentials": { + "description": "Secret store based authentication credentials.", + "required": [ + "objectType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AuthCredentials" + } + ], + "properties": { + "secretStoreResource": { + "$ref": "#/definitions/SecretStoreResource", + "description": "Secret store resource" + } + }, + "x-ms-discriminator-value": "SecretStoreBasedAuthCredentials" + }, + "SecretStoreResource": { + "description": "Class representing a secret store resource.", + "required": [ + "secretStoreType" + ], + "type": "object", + "properties": { + "uri": { + "description": "Uri to get to the resource", + "type": "string" + }, + "secretStoreType": { + "description": "Gets or sets the type of secret store", + "enum": [ + "Invalid", + "AzureKeyVault" + ], + "type": "string", + "x-ms-enum": { + "name": "SecretStoreType", + "modelAsString": true + } + } + } + }, + "SourceLifeCycle": { + "description": "Source LifeCycle", + "properties": { + "deleteAfter": { + "$ref": "#/definitions/DeleteOption" + }, + "sourceDataStore": { + "$ref": "#/definitions/DataStoreInfoBase" + }, + "targetDataStoreCopySettings": { + "items": { + "$ref": "#/definitions/TargetCopySetting" + }, + "type": "array" + } + }, + "required": [ + "deleteAfter", + "sourceDataStore" + ], + "title": "SourceLifeCycle", + "type": "object" + }, + "StorageSetting": { + "description": "Storage setting", + "properties": { + "datastoreType": { + "description": "Gets or sets the type of the datastore.", + "enum": [ + "ArchiveStore", + "SnapshotStore", + "VaultStore" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "StorageSettingStoreTypes" + } + }, + "type": { + "description": "Gets or sets the type.", + "enum": [ + "GeoRedundant", + "LocallyRedundant" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "StorageSettingTypes" + } + } + }, + "title": "StorageSetting", + "type": "object" + }, + "SupportedFeature": { + "description": "Elements class for feature request", + "type": "object", + "properties": { + "featureName": { + "description": "support feature type.", + "type": "string" + }, + "supportStatus": { + "description": "feature support status", + "enum": [ + "Invalid", + "NotSupported", + "AlphaPreview", + "PrivatePreview", + "PublicPreview", + "GenerallyAvailable" + ], + "type": "string", + "x-ms-enum": { + "name": "FeatureSupportStatus", + "modelAsString": true + } + }, + "exposureControlledFeatures": { + "description": "support feature type.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SyncBackupInstanceRequest": { + "description": "Sync BackupInstance Request", + "type": "object", + "properties": { + "syncType": { + "description": "Field indicating sync type e.g. to sync only in case of failure or in all cases", + "enum": [ + "Default", + "ForceResync" + ], + "type": "string", + "x-ms-enum": { + "name": "SyncType", + "modelAsString": true + } + } + } + }, + "TaggingCriteria": { + "description": "Tagging criteria", + "properties": { + "criteria": { + "description": "Criteria which decides whether the tag can be applied to a triggered backup.", + "items": { + "$ref": "#/definitions/BackupCriteria" + }, + "type": "array" + }, + "isDefault": { + "description": "Specifies if tag is default.", + "type": "boolean" + }, + "taggingPriority": { + "description": "Retention Tag priority.", + "format": "int64", + "type": "integer" + }, + "tagInfo": { + "$ref": "#/definitions/RetentionTag", + "description": "Retention tag information" + } + }, + "required": [ + "isDefault", + "tagInfo", + "taggingPriority" + ], + "title": "TaggingCriteria", + "type": "object" + }, + "TargetCopySetting": { + "description": "Target copy settings", + "properties": { + "copyAfter": { + "$ref": "#/definitions/CopyOption", + "description": "It can be CustomCopyOption or ImmediateCopyOption." + }, + "dataStore": { + "$ref": "#/definitions/DataStoreInfoBase", + "description": "Info of target datastore" + } + }, + "required": [ + "copyAfter", + "dataStore" + ], + "title": "TargetCopySetting", + "type": "object" + }, + "TargetDetails": { + "description": "Class encapsulating target details, used where the destination is not a datasource", + "properties": { + "filePrefix": { + "description": "Restore operation may create multiple files inside location pointed by Url\r\nBelow will be the common prefix for all of them", + "type": "string" + }, + "restoreTargetLocationType": { + "description": "Denotes the target location where the data will be restored,\r\nstring value for the enum {Microsoft.Internal.AzureBackup.DataProtection.Common.Interface.RestoreTargetLocationType}", + "enum": [ + "Invalid", + "AzureBlobs", + "AzureFiles" + ], + "type": "string", + "x-ms-enum": { + "name": "RestoreTargetLocationType", + "modelAsString": true + } + }, + "url": { + "description": "Url denoting the restore destination. It can point to container / file share etc", + "type": "string" + } + }, + "required": [ + "filePrefix", + "restoreTargetLocationType", + "url" + ], + "type": "object" + }, + "TriggerBackupRequest": { + "description": "Trigger backup request", + "properties": { + "backupRuleOptions": { + "$ref": "#/definitions/AdHocBackupRuleOptions", + "description": "Name for the Rule of the Policy which needs to be applied for this backup" + } + }, + "required": [ + "backupRuleOptions" + ], + "title": "TriggerBackupRequest", + "type": "object" + }, + "TriggerContext": { + "description": "Trigger context", + "discriminator": "objectType", + "properties": { + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string" + } + }, + "required": [ + "objectType" + ], + "title": "TriggerContext", + "type": "object" + }, + "UserFacingError": { + "description": "Error object used by layers that have access to localized content, and propagate that to user", + "properties": { + "code": { + "description": "Unique code for this error", + "type": "string" + }, + "details": { + "description": "Additional related Errors", + "items": { + "$ref": "#/definitions/UserFacingError" + }, + "type": "array" + }, + "innerError": { + "$ref": "#/definitions/InnerError", + "description": "Inner Error" + }, + "isRetryable": { + "description": "Whether the operation will be retryable or not", + "type": "boolean" + }, + "isUserError": { + "description": "Whether the operation is due to a user error or service error", + "type": "boolean" + }, + "properties": { + "description": "Any key value pairs that can be injected inside error object", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "message": { + "type": "string" + }, + "recommendedAction": { + "description": "RecommendedAction � localized.", + "items": { + "type": "string" + }, + "type": "array" + }, + "target": { + "description": "Target of the error.", + "type": "string" + } + }, + "type": "object" + }, + "ValidateForBackupRequest": { + "description": "Validate for backup request", + "properties": { + "backupInstance": { + "$ref": "#/definitions/BackupInstance" + } + }, + "required": [ + "backupInstance" + ], + "title": "ValidateForBackupRequest", + "type": "object" + }, + "ValidateRestoreRequestObject": { + "description": "Validate restore request object", + "properties": { + "restoreRequestObject": { + "$ref": "#/definitions/AzureBackupRestoreRequest", + "description": "Gets or sets the restore request object." + } + }, + "required": [ + "restoreRequestObject" + ], + "title": "ValidateRestoreRequestObject", + "type": "object" + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription Id.", + "required": true, + "type": "string" + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group where the backup vault is present.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VaultName": { + "name": "vaultName", + "in": "path", + "description": "The name of the backup vault.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account." + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/DeleteBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/DeleteBackupInstance.json new file mode 100644 index 000000000000..29b0e798cf32 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/DeleteBackupInstance.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "backupInstanceName": "testInstance1", + "api-version": "2021-06-01-preview" + }, + "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=2021-06-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/providers/Microsoft.DataProtection/locations/westus/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2021-06-01-preview", + "Retry-After": "60" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/FindRestorableTimeRanges.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/FindRestorableTimeRanges.json new file mode 100644 index 000000000000..0c25fd77a94b --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/FindRestorableTimeRanges.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "Blob-Backup", + "vaultName": "ZBlobBackupVaultBVTD3", + "backupInstanceName": "zblobbackuptestsa58", + "api-version": "2021-06-01-preview", + "parameters": { + "sourceDataStoreType": "OperationalStore", + "startTime": "2021-02-17T23:28:17.6829685Z", + "endTime": "2021-06-24T00:35:17.6829685Z" + } + }, + "responses": { + "200": { + "body": { + "id": "zblobbackuptestsa58", + "type": "Microsoft.DataProtection/backupVaults/backupInstances/findRestorableTimeRanges", + "properties": { + "restorableTimeRanges": [ + { + "startTime": "2021-06-23T18:33:51.6349708Z", + "endTime": "2021-06-24T00:35:17.0000000Z", + "objectType": "RestorableTimeRange" + } + ], + "objectType": "AzureBackupFindRestorableTimeRangesResponse" + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/GetBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/GetBackupInstance.json new file mode 100644 index 000000000000..fc1f1fdd02e2 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/GetBackupInstance.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2021-06-01-preview", + "backupInstanceName": "testInstance1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2", + "name": "harshitbi2", + "type": "Microsoft.DataProtection/backupVaults/backupInstances", + "properties": { + "friendlyName": "harshitbi2", + "dataSourceInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "resourceUri": "", + "datasourceType": "OssDB", + "resourceName": "testdb", + "resourceType": "OssDB", + "resourceLocation": "", + "objectType": "Datasource" + }, + "dataSourceSetInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest", + "resourceUri": "", + "datasourceType": "OssDB", + "resourceName": "viveksipgtest", + "resourceType": "OssDB", + "resourceLocation": "", + "objectType": "DatasourceSet" + }, + "policyInfo": { + "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1", + "policyVersion": "3.2" + }, + "protectionStatus": { + "status": "NotProtected" + }, + "provisioningState": "Provisioning", + "objectType": "BackupInstance" + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/GetRecoveryPoint.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/GetRecoveryPoint.json new file mode 100644 index 000000000000..422dab6bee10 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/GetRecoveryPoint.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2021-06-01-preview", + "backupInstanceName": "testInstance1", + "recoveryPointId": "7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25" + }, + "responses": { + "200": { + "body": { + "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": "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" + } + ] + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/ListBackupInstances.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/ListBackupInstances.json new file mode 100644 index 000000000000..10d78a41e566 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/ListBackupInstances.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2", + "name": "harshitbi2", + "type": "Microsoft.DataProtection/backupVaults/backupInstances", + "properties": { + "friendlyName": "harshitbi2", + "dataSourceInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "resourceUri": "", + "datasourceType": "OssDB", + "resourceName": "testdb", + "resourceType": "OssDB", + "resourceLocation": "", + "objectType": "Datasource" + }, + "dataSourceSetInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest", + "resourceUri": "", + "datasourceType": "OssDB", + "resourceName": "viveksipgtest", + "resourceType": "OssDB", + "resourceLocation": "", + "objectType": "DatasourceSet" + }, + "policyInfo": { + "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1", + "policyVersion": "3.2" + }, + "protectionStatus": { + "status": "NotProtected" + }, + "provisioningState": "Provisioning", + "objectType": "BackupInstance" + } + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/ListRecoveryPoints.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/ListRecoveryPoints.json new file mode 100644 index 000000000000..28fc75238e13 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/ListRecoveryPoints.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2021-06-01-preview", + "backupInstanceName": "testInstance1" + }, + "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", + "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/preview/2021-06-01-preview/examples/BackupInstanceOperations/PutBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/PutBackupInstance.json new file mode 100644 index 000000000000..390df288e0e2 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/PutBackupInstance.json @@ -0,0 +1,150 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2021-06-01-preview", + "backupInstanceName": "testInstance1", + "parameters": { + "properties": { + "objectType": "BackupInstance", + "friendlyName": "harshitbi2", + "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": "OssDB" + }, + "dataSourceInfo": { + "objectType": "Datasource", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "resourceName": "testdb", + "resourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "OssDB" + }, + "datasourceAuthCredentials": { + "secretStoreResource": { + "uri": "https://samplevault.vault.azure.net/secrets/credentials", + "secretStoreType": "AzureKeyVault" + }, + "objectType": "SecretStoreBasedAuthCredentials" + }, + "policyInfo": { + "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/Backupvaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1", + "policyParameters": { + "dataStoreParametersList": [ + { + "objectType": "AzureOperationalStoreParameters", + "dataStoreType": "OperationalStore", + "resourceGroupId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest" + } + ] + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/providers/Microsoft.DataProtection/locations/westus/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2021-06-01-preview", + "Retry-After": "60" + }, + "body": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2", + "name": "harshitbi2", + "type": "Microsoft.DataProtection/backupVaults/backupInstances", + "properties": { + "friendlyName": "harshitbi2", + "dataSourceInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "resourceUri": "", + "datasourceType": "OssDB", + "resourceName": "testdb", + "resourceType": "OssDB", + "resourceLocation": "", + "objectType": "Datasource" + }, + "dataSourceSetInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest", + "resourceUri": "", + "datasourceType": "OssDB", + "resourceName": "viveksipgtest", + "resourceType": "OssDB", + "resourceLocation": "", + "objectType": "DatasourceSet" + }, + "policyInfo": { + "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1", + "policyVersion": "3.2", + "policyParameters": { + "dataStoreParametersList": [ + { + "objectType": "AzureOperationalStoreParameters", + "dataStoreType": "OperationalStore", + "resourceGroupId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest" + } + ] + } + }, + "protectionStatus": { + "status": "NotProtected" + }, + "provisioningState": "Provisioning", + "objectType": "BackupInstance" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2", + "name": "harshitbi2", + "type": "Microsoft.DataProtection/backupVaults/backupInstances", + "properties": { + "friendlyName": "harshitbi2", + "dataSourceInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "resourceUri": "", + "datasourceType": "OssDB", + "resourceName": "testdb", + "resourceType": "OssDB", + "resourceLocation": "", + "objectType": "Datasource" + }, + "dataSourceSetInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest", + "resourceUri": "", + "datasourceType": "OssDB", + "resourceName": "viveksipgtest", + "resourceType": "OssDB", + "resourceLocation": "", + "objectType": "DatasourceSet" + }, + "policyInfo": { + "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1", + "policyVersion": "3.2", + "policyParameters": { + "dataStoreParametersList": [ + { + "objectType": "AzureOperationalStoreParameters", + "dataStoreType": "OperationalStore", + "resourceGroupId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest" + } + ] + } + }, + "protectionStatus": { + "status": "NotProtected" + }, + "provisioningState": "Provisioned", + "objectType": "BackupInstance" + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/ResumeBackups.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/ResumeBackups.json new file mode 100644 index 000000000000..4fd466f40b07 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/ResumeBackups.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "testrg", + "vaultName": "testvault", + "backupInstanceName": "testbi", + "api-version": "2021-06-01-preview" + }, + "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=2021-06-01-preview", + "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/providers/Microsoft.DataProtection/locations/westus/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2021-06-01-preview", + "Retry-After": "60" + } + }, + "200": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/ResumeProtection.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/ResumeProtection.json new file mode 100644 index 000000000000..4fd466f40b07 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/ResumeProtection.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "testrg", + "vaultName": "testvault", + "backupInstanceName": "testbi", + "api-version": "2021-06-01-preview" + }, + "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=2021-06-01-preview", + "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/providers/Microsoft.DataProtection/locations/westus/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2021-06-01-preview", + "Retry-After": "60" + } + }, + "200": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/StopProtection.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/StopProtection.json new file mode 100644 index 000000000000..4fd466f40b07 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/StopProtection.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "testrg", + "vaultName": "testvault", + "backupInstanceName": "testbi", + "api-version": "2021-06-01-preview" + }, + "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=2021-06-01-preview", + "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/providers/Microsoft.DataProtection/locations/westus/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2021-06-01-preview", + "Retry-After": "60" + } + }, + "200": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/SuspendBackups.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/SuspendBackups.json new file mode 100644 index 000000000000..4fd466f40b07 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/SuspendBackups.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "testrg", + "vaultName": "testvault", + "backupInstanceName": "testbi", + "api-version": "2021-06-01-preview" + }, + "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=2021-06-01-preview", + "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/providers/Microsoft.DataProtection/locations/westus/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2021-06-01-preview", + "Retry-After": "60" + } + }, + "200": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/SyncBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/SyncBackupInstance.json new file mode 100644 index 000000000000..6e14707f2dd8 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/SyncBackupInstance.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "testrg", + "vaultName": "testvault", + "backupInstanceName": "testbi", + "api-version": "2021-06-01-preview", + "parameters": { + "syncType": "Default" + } + }, + "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=2021-06-01-preview", + "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/providers/Microsoft.DataProtection/locations/westus/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2021-06-01-preview", + "Retry-After": "60" + } + }, + "200": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/TriggerBackup.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/TriggerBackup.json new file mode 100644 index 000000000000..3d2c6aa12d35 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/TriggerBackup.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2021-06-01-preview", + "backupInstanceName": "testInstance1", + "parameters": { + "backupRuleOptions": { + "ruleName": "BackupWeekly", + "triggerOption": { + "retentionTagOverride": "yearly" + } + } + } + }, + "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=2021-06-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/providers/Microsoft.DataProtection/locations/westus/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2021-06-01-preview", + "Retry-After": "60" + } + }, + "200": { + "body": { + "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/TriggerRehydrate.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/TriggerRehydrate.json new file mode 100644 index 000000000000..3446fca5d0bd --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/TriggerRehydrate.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2021-06-01-preview", + "backupInstanceName": "testInstance1", + "parameters": { + "recoveryPointId": "hardcodedRP", + "rehydrationRetentionDuration": "7D", + "rehydrationPriority": "High" + } + }, + "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=2021-06-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/providers/Microsoft.DataProtection/locations/westus/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2021-06-01-preview", + "Retry-After": "60" + } + }, + "204": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/TriggerRestore.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/TriggerRestore.json new file mode 100644 index 000000000000..6339323af14c --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/TriggerRestore.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2021-06-01-preview", + "backupInstanceName": "testInstance1", + "parameters": { + "objectType": "AzureBackupRecoveryPointBasedRestoreRequest", + "recoveryPointId": "hardcodedRP", + "sourceDataStoreType": "VaultStore", + "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": "OssDB" + }, + "datasourceInfo": { + "objectType": "Datasource", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "resourceName": "testdb", + "resourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "OssDB" + }, + "datasourceAuthCredentials": { + "secretStoreResource": { + "uri": "https://samplevault.vault.azure.net/secrets/credentials", + "secretStoreType": "AzureKeyVault" + }, + "objectType": "SecretStoreBasedAuthCredentials" + }, + "restoreLocation": "southeastasia" + } + } + }, + "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=2021-06-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/providers/Microsoft.DataProtection/locations/westus/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2021-06-01-preview", + "Retry-After": "60" + } + }, + "200": { + "body": { + "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/TriggerRestoreAsFiles.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/TriggerRestoreAsFiles.json new file mode 100644 index 000000000000..f4e2c26e5c4b --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/TriggerRestoreAsFiles.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PrivatePreviewVault1", + "api-version": "2021-06-01-preview", + "backupInstanceName": "testInstance1", + "parameters": { + "objectType": "AzureBackupRecoveryPointBasedRestoreRequest", + "recoveryPointId": "hardcodedRP", + "sourceDataStoreType": "VaultStore", + "restoreTargetInfo": { + "targetDetails": { + "url": "https://teststorage.blob.core.windows.net/restoretest", + "filePrefix": "restoredblob", + "restoreTargetLocationType": "AzureBlobs" + }, + "restoreLocation": "southeastasia", + "recoveryOption": "FailIfExists", + "objectType": "RestoreFilesTargetInfo" + } + } + }, + "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=2021-06-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/providers/Microsoft.DataProtection/locations/westus/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2021-06-01-preview", + "Retry-After": "60" + } + }, + "200": { + "body": { + "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json new file mode 100644 index 000000000000..ac91cc477a56 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2021-06-01-preview", + "backupInstanceName": "testInstance1", + "parameters": { + "objectType": "AzureBackupRestoreWithRehydrationRequest", + "recoveryPointId": "hardcodedRP", + "rehydrationRetentionDuration": "7D", + "rehydrationPriority": "High", + "sourceDataStoreType": "VaultStore", + "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": "OssDB" + }, + "datasourceInfo": { + "objectType": "Datasource", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "resourceName": "testdb", + "resourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "OssDB" + }, + "restoreLocation": "southeastasia" + } + } + }, + "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=2021-06-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/providers/Microsoft.DataProtection/locations/westus/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2021-06-01-preview", + "Retry-After": "60" + } + }, + "200": { + "body": { + "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/ValidateForBackup.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/ValidateForBackup.json new file mode 100644 index 000000000000..5f2c81f0469e --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/ValidateForBackup.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2021-06-01-preview", + "backupInstanceName": "testInstance1", + "parameters": { + "backupInstance": { + "objectType": "BackupInstance", + "friendlyName": "harshitbi2", + "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": "OssDB" + }, + "dataSourceInfo": { + "objectType": "Datasource", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "resourceName": "testdb", + "resourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "OssDB" + }, + "datasourceAuthCredentials": { + "secretStoreResource": { + "uri": "https://samplevault.vault.azure.net/secrets/credentials", + "secretStoreType": "AzureKeyVault" + }, + "objectType": "SecretStoreBasedAuthCredentials" + }, + "policyInfo": { + "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/Backupvaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2021-06-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/providers/Microsoft.DataProtection/locations/westus/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2021-06-01-preview", + "Retry-After": "60" + } + }, + "200": { + "body": { + "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/ValidateRestore.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/ValidateRestore.json new file mode 100644 index 000000000000..6ef81263da6f --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/BackupInstanceOperations/ValidateRestore.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2021-06-01-preview", + "backupInstanceName": "testInstance1", + "parameters": { + "restoreRequestObject": { + "objectType": "AzureBackupRecoveryPointBasedRestoreRequest", + "recoveryPointId": "hardcodedRP", + "sourceDataStoreType": "VaultStore", + "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": "OssDB" + }, + "datasourceInfo": { + "objectType": "Datasource", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "resourceName": "testdb", + "resourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "OssDB" + }, + "datasourceAuthCredentials": { + "secretStoreResource": { + "uri": "https://samplevault.vault.azure.net/secrets/credentials", + "secretStoreType": "AzureKeyVault" + }, + "objectType": "SecretStoreBasedAuthCredentials" + }, + "restoreLocation": "southeastasia" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2021-06-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/providers/Microsoft.DataProtection/locations/westus/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2021-06-01-preview", + "Retry-After": "60" + } + }, + "200": { + "body": { + "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/CheckfeatureSupport.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/CheckfeatureSupport.json new file mode 100644 index 000000000000..de752b16ca28 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/CheckfeatureSupport.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "location": "WestUS", + "api-version": "2021-06-01-preview", + "parameters": { + "featureType": "DataSourceType", + "objectType": "FeatureValidationRequest" + } + }, + "responses": { + "200": { + "body": { + "featureType": "DataSourceType", + "features": [ + { + "featureName": "Microsoft.Storage/storageAccounts/blobServices", + "supportStatus": "PrivatePreview", + "exposureControlledFeatures": [] + }, + { + "featureName": "Microsoft.DBforPostgreSQL/servers/databases", + "supportStatus": "PublicPreview", + "exposureControlledFeatures": [] + } + ], + "objectType": "FeatureValidationResponse" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/GetOperationResult.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/GetOperationResult.json new file mode 100644 index 000000000000..786f67699ba0 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/GetOperationResult.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "location": "WestUS", + "operationId": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2021-06-01-preview", + "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/providers/Microsoft.DataProtection/locations/westus/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2021-06-01-preview", + "Retry-After": "60" + } + }, + "200": { + "body": { + "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/GetOperationStatus.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/GetOperationStatus.json new file mode 100644 index 000000000000..9be179dc0579 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/GetOperationStatus.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "location": "WestUS", + "operationId": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/providers/Microsoft.DataProtection/locations/WestUS/operationStatus/MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", + "name": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", + "status": "Succeeded", + "startTime": "2019-11-20T09:49:44.0478496Z", + "endTime": "2019-11-20T09:49:46Z" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/JobCRUD/GetExportJobsOperationResult.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/JobCRUD/GetExportJobsOperationResult.json new file mode 100644 index 000000000000..7392227ce258 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/JobCRUD/GetExportJobsOperationResult.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "blobUrl": "https://azureblob.blob.core.windows.net/reportcontainer/exportjobsreport00000000-0000-0000-0000-000000000000", + "blobSasKey": "someKey", + "excelFileBlobUrl": "https://azureblob.blob.core.windows.net/reportcontainer/exportjobsreport00000000-0000-0000-0000-000000000000_ExcelFile.xlsx", + "excelFileBlobSasKey": "someKey" + } + }, + "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=2021-06-01-preview" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/JobCRUD/GetJob.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/JobCRUD/GetJob.json new file mode 100644 index 000000000000..b1b5a90a042d --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/JobCRUD/GetJob.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "resourceGroupName": "BugBash1", + "vaultName": "BugBashVaultForCCYv11", + "jobId": "3c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "api-version": "2021-06-01-preview" + }, + "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": "centraluseuap", + "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/preview/2021-06-01-preview/examples/JobCRUD/ListJobs.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/JobCRUD/ListJobs.json new file mode 100644 index 000000000000..20183a823420 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/JobCRUD/ListJobs.json @@ -0,0 +1,135 @@ +{ + "parameters": { + "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "resourceGroupName": "BugBash1", + "vaultName": "BugBashVaultForCCYv11", + "api-version": "2021-06-01-preview" + }, + "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/preview/2021-06-01-preview/examples/JobCRUD/TriggerExportJobs.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/JobCRUD/TriggerExportJobs.json new file mode 100644 index 000000000000..064b523cba51 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/JobCRUD/TriggerExportJobs.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "api-version": "2021-06-01-preview" + }, + "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=2021-06-01-preview", + "Retry-After": 60 + } + }, + "204": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/Operations/List.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/Operations/List.json new file mode 100644 index 000000000000..c3dfcdf4beb1 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/Operations/List.json @@ -0,0 +1,403 @@ +{ + "parameters": { + "api-version": "2021-02-01-preview" + }, + "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/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/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/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/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/providers/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/preview/2021-06-01-preview/examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json new file mode 100644 index 000000000000..649bb151fcc1 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json @@ -0,0 +1,200 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PrivatePreviewVault", + "backupPolicyName": "OSSDBPolicy", + "api-version": "2021-06-01-preview", + "parameters": { + "properties": { + "policyRules": [ + { + "backupParameters": { + "backupType": "Full", + "objectType": "AzureBackupParams" + }, + "trigger": { + "schedule": { + "repeatingTimeIntervals": [ + "R/2019-11-20T08:00:00-08:00/P1W" + ] + }, + "taggingCriteria": [ + { + "tagInfo": { + "tagName": "Default" + }, + "taggingPriority": 99, + "isDefault": true + }, + { + "tagInfo": { + "tagName": "Weekly" + }, + "taggingPriority": 20, + "isDefault": false, + "criteria": [ + { + "scheduleTimes": [ + "2019-03-01T13:00:00Z" + ], + "daysOfTheWeek": [ + "Sunday" + ], + "objectType": "ScheduleBasedBackupCriteria" + } + ] + } + ], + "objectType": "ScheduleBasedTriggerContext" + }, + "dataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "name": "BackupWeekly", + "objectType": "AzureBackupRule" + }, + { + "lifecycles": [ + { + "sourceDataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "deleteAfter": { + "objectType": "AbsoluteDeleteOption", + "duration": "P1W" + } + } + ], + "isDefault": true, + "name": "Default", + "objectType": "AzureRetentionRule" + }, + { + "lifecycles": [ + { + "sourceDataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "deleteAfter": { + "objectType": "AbsoluteDeleteOption", + "duration": "P12W" + } + } + ], + "isDefault": false, + "name": "Weekly", + "objectType": "AzureRetentionRule" + } + ], + "datasourceTypes": [ + "OssDB" + ], + "objectType": "BackupPolicy" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault/backupPolicies/OSSDBPolicy", + "name": "OSSDBPolicy", + "type": "Microsoft.DataProtection/backupVaults/backupPolicies", + "properties": { + "policyRules": [ + { + "backupParameters": { + "backupType": "Full", + "objectType": "AzureBackupParams" + }, + "trigger": { + "schedule": { + "repeatingTimeIntervals": [ + "R/2019-11-20T08:00:00-08:00/P1W" + ] + }, + "taggingCriteria": [ + { + "tagInfo": { + "tagName": "Default", + "id": "Default_" + }, + "taggingPriority": 99, + "isDefault": true + }, + { + "tagInfo": { + "tagName": "Weekly", + "id": "Weekly_" + }, + "taggingPriority": 20, + "isDefault": false, + "criteria": [ + { + "scheduleTimes": [ + "2019-03-01T13:00:00Z" + ], + "daysOfTheWeek": [ + "Sunday" + ], + "objectType": "ScheduleBasedBackupCriteria" + } + ] + } + ], + "objectType": "ScheduleBasedTriggerContext" + }, + "dataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "name": "BackupWeekly", + "objectType": "AzureBackupRule" + }, + { + "lifecycles": [ + { + "sourceDataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "deleteAfter": { + "objectType": "AbsoluteDeleteOption", + "duration": "P1W" + } + } + ], + "isDefault": true, + "name": "Default", + "objectType": "AzureRetentionRule" + }, + { + "lifecycles": [ + { + "sourceDataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "deleteAfter": { + "objectType": "AbsoluteDeleteOption", + "duration": "P12W" + } + } + ], + "isDefault": false, + "name": "Weekly", + "objectType": "AzureRetentionRule" + } + ], + "datasourceTypes": [ + "OssDB" + ], + "objectType": "BackupPolicy" + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/PolicyCRUD/DeleteBackupPolicy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/PolicyCRUD/DeleteBackupPolicy.json new file mode 100644 index 000000000000..4b69a1041b13 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/PolicyCRUD/DeleteBackupPolicy.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PrivatePreviewVault", + "backupPolicyName": "OSSDBPolicy", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/PolicyCRUD/GetBackupPolicy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/PolicyCRUD/GetBackupPolicy.json new file mode 100644 index 000000000000..12707a41b67e --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/PolicyCRUD/GetBackupPolicy.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PrivatePreviewVault", + "backupPolicyName": "OSSDBPolicy", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault/backupPolicies/OSSDBPolicy", + "name": "OSSDBPolicy", + "type": "Microsoft.DataProtection/backupVaults/backupPolicies", + "properties": { + "policyRules": [ + { + "backupParameters": { + "backupType": "Full", + "objectType": "AzureBackupParams" + }, + "trigger": { + "schedule": { + "repeatingTimeIntervals": [ + "R/2019-11-20T08:00:00-08:00/P1W" + ] + }, + "taggingCriteria": [ + { + "tagInfo": { + "tagName": "Default", + "id": "Default_" + }, + "taggingPriority": 99, + "isDefault": true + }, + { + "tagInfo": { + "tagName": "Weekly", + "id": "Weekly_" + }, + "taggingPriority": 20, + "isDefault": false, + "criteria": [ + { + "scheduleTimes": [ + "2019-03-01T13:00:00Z" + ], + "daysOfTheWeek": [ + "Sunday" + ], + "objectType": "ScheduleBasedBackupCriteria" + } + ] + } + ], + "objectType": "ScheduleBasedTriggerContext" + }, + "dataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "name": "BackupWeekly", + "objectType": "AzureBackupRule" + }, + { + "lifecycles": [ + { + "sourceDataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "deleteAfter": { + "objectType": "AbsoluteDeleteOption", + "duration": "P1W" + } + } + ], + "isDefault": true, + "name": "Default", + "objectType": "AzureRetentionRule" + }, + { + "lifecycles": [ + { + "sourceDataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "deleteAfter": { + "objectType": "AbsoluteDeleteOption", + "duration": "P12W" + } + } + ], + "isDefault": false, + "name": "Weekly", + "objectType": "AzureRetentionRule" + } + ], + "datasourceTypes": [ + "OssDB" + ], + "objectType": "BackupPolicy" + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/PolicyCRUD/ListBackupPolicy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/PolicyCRUD/ListBackupPolicy.json new file mode 100644 index 000000000000..aa8af89aa9b2 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/PolicyCRUD/ListBackupPolicy.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PrivatePreviewVault", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault/backupPolicies/OSSDBPolicy", + "name": "OSSDBPolicy", + "type": "Microsoft.DataProtection/backupVaults/backupPolicies", + "properties": { + "policyRules": [ + { + "backupParameters": { + "backupType": "Full", + "objectType": "AzureBackupParams" + }, + "trigger": { + "schedule": { + "repeatingTimeIntervals": [ + "R/2019-11-20T08:00:00-08:00/P1W" + ] + }, + "taggingCriteria": [ + { + "tagInfo": { + "tagName": "Default", + "id": "Default_" + }, + "taggingPriority": 99, + "isDefault": true + }, + { + "tagInfo": { + "tagName": "Weekly", + "id": "Weekly_" + }, + "taggingPriority": 20, + "isDefault": false, + "criteria": [ + { + "scheduleTimes": [ + "2019-03-01T13:00:00Z" + ], + "daysOfTheWeek": [ + "Sunday" + ], + "objectType": "ScheduleBasedBackupCriteria" + } + ] + } + ], + "objectType": "ScheduleBasedTriggerContext" + }, + "dataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "name": "BackupWeekly", + "objectType": "AzureBackupRule" + }, + { + "lifecycles": [ + { + "sourceDataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "deleteAfter": { + "objectType": "AbsoluteDeleteOption", + "duration": "P1W" + } + } + ], + "isDefault": true, + "name": "Default", + "objectType": "AzureRetentionRule" + }, + { + "lifecycles": [ + { + "sourceDataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "deleteAfter": { + "objectType": "AbsoluteDeleteOption", + "duration": "P12W" + } + } + ], + "isDefault": false, + "name": "Weekly", + "objectType": "AzureRetentionRule" + } + ], + "datasourceTypes": [ + "OssDB" + ], + "objectType": "BackupPolicy" + } + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/VaultCRUD/CheckBackupVaultsNameAvailability.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/VaultCRUD/CheckBackupVaultsNameAvailability.json new file mode 100644 index 000000000000..836e7d976fa2 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/VaultCRUD/CheckBackupVaultsNameAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "location": "westus", + "api-version": "2021-06-01-preview", + "parameters": { + "type": "Microsoft.DataProtection/BackupVaults", + "name": "swaggerExample" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/VaultCRUD/DeleteBackupVault.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/VaultCRUD/DeleteBackupVault.json new file mode 100644 index 000000000000..8448263e1c13 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/VaultCRUD/DeleteBackupVault.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/providers/Microsoft.DataProtection/locations/West%20US/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2021-06-01-preview", + "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2021-06-01-preview" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/VaultCRUD/GetBackupVault.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/VaultCRUD/GetBackupVault.json new file mode 100644 index 000000000000..efd251330ef2 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/VaultCRUD/GetBackupVault.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "None" + }, + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.DataProtection/Backupvaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "provisioningState": "Succeeded", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ] + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/VaultCRUD/GetBackupVaultWithMSI.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/VaultCRUD/GetBackupVaultWithMSI.json new file mode 100644 index 000000000000..2edacb6a91c9 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/VaultCRUD/GetBackupVaultWithMSI.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "identity": { + "principalId": "c009b9a0-0024-417c-83cd-025d3776045d", + "tenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc", + "type": "SystemAssigned" + }, + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.DataProtection/Backupvaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "provisioningState": "Succeeded", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ] + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/VaultCRUD/GetBackupVaultsInResourceGroup.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/VaultCRUD/GetBackupVaultsInResourceGroup.json new file mode 100644 index 000000000000..ff31570cd58c --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/VaultCRUD/GetBackupVaultsInResourceGroup.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "None" + }, + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/ExampleVault1", + "name": "ExampleVault1", + "type": "Microsoft.DataProtection/BackupVaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "provisioningState": "Succeeded", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ] + } + }, + { + "identity": { + "principalId": "c009b9a0-0024-417c-83cd-025d3776045d", + "tenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc", + "type": "SystemAssigned" + }, + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/ExampleVault2", + "name": "ExampleVault2", + "type": "Microsoft.DataProtection/BackupVaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "provisioningState": "Succeeded", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/VaultCRUD/GetBackupVaultsInSubscription.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/VaultCRUD/GetBackupVaultsInSubscription.json new file mode 100644 index 000000000000..33dc1acfe359 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/VaultCRUD/GetBackupVaultsInSubscription.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "None" + }, + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup2/providers/Microsoft.DataProtection/BackupVaults/ExampleVault1", + "name": "ExampleVault1", + "type": "Microsoft.DataProtection/BackupVaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "provisioningState": "Succeeded", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ] + } + }, + { + "identity": { + "type": "None" + }, + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/ExampleVault2", + "name": "ExampleVault2", + "type": "Microsoft.DataProtection/BackupVaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "provisioningState": "Succeeded", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/VaultCRUD/GetOperationResultPatch.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/VaultCRUD/GetOperationResultPatch.json new file mode 100644 index 000000000000..30ec477d0a0a --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/VaultCRUD/GetOperationResultPatch.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "vaultName": "swaggerExample", + "operationId": "YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/providers/Microsoft.DataProtection/locations/West%20US/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2021-06-01-preview", + "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2021-06-01-preview" + }, + "body": { + "identity": { + "type": "None" + }, + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.DataProtection/Backupvaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "provisioningState": "Succeeded", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ] + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/VaultCRUD/PatchBackupVault.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/VaultCRUD/PatchBackupVault.json new file mode 100644 index 000000000000..dc2d4546af90 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/VaultCRUD/PatchBackupVault.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2021-06-01-preview", + "operationId": "YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==", + "parameters": { + "tags": { + "newKey": "newVal" + } + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/providers/Microsoft.DataProtection/locations/West%20US/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2021-06-01-preview", + "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2021-06-01-preview" + } + }, + "200": { + "body": { + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.DataProtection/Backupvaults", + "location": "WestUS", + "tags": { + "newKey": "newVal" + }, + "properties": { + "provisioningState": "Succeeded", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ] + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/VaultCRUD/PutBackupVault.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/VaultCRUD/PutBackupVault.json new file mode 100644 index 000000000000..72fcc5aedfb1 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/VaultCRUD/PutBackupVault.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2021-06-01-preview", + "parameters": { + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "identity": { + "type": "None" + }, + "properties": { + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.DataProtection/Backupvaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "provisioningState": "Provisioning", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ] + } + }, + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/providers/Microsoft.DataProtection/locations/West%20US/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2021-06-01-preview" + } + }, + "200": { + "body": { + "identity": { + "type": "None" + }, + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.DataProtection/Backupvaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "provisioningState": "Succeeded", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ] + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/VaultCRUD/PutBackupVaultWithMSI.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/VaultCRUD/PutBackupVaultWithMSI.json new file mode 100644 index 000000000000..cb359668b51c --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2021-06-01-preview/examples/VaultCRUD/PutBackupVaultWithMSI.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2021-06-01-preview", + "parameters": { + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "identity": { + "type": "systemAssigned" + }, + "properties": { + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.DataProtection/Backupvaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "provisioningState": "Provisioning", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ] + } + }, + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/providers/Microsoft.DataProtection/locations/West%20US/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2021-06-01-preview" + } + }, + "200": { + "body": { + "identity": { + "principalId": "c009b9a0-0024-417c-83cd-025d3776045d", + "tenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc", + "type": "SystemAssigned" + }, + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.DataProtection/Backupvaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "provisioningState": "Succeeded", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ] + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2021-01-01/dataprotection.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2021-01-01/dataprotection.json index b07d7b3bc7e2..26a7833efde7 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2021-01-01/dataprotection.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2021-01-01/dataprotection.json @@ -24,7 +24,7 @@ "BackupVaults" ], "description": "Returns resource collection belonging to a subscription.", - "operationId": "BackupVaults_GetResourcesInSubscription", + "operationId": "BackupVaults_GetInSubscription", "produces": [ "application/json" ], @@ -136,7 +136,7 @@ "OperationStatus" ], "summary": "Gets the operation status for a resource.", - "operationId": "GetOperationStatus", + "operationId": "OperationStatus_Get", "produces": [ "application/json" ], @@ -187,7 +187,7 @@ "BackupVaults" ], "description": "Returns resource collection belonging to a resource group.", - "operationId": "BackupVaults_GetResourcesInResourceGroup", + "operationId": "BackupVaults_GetInResourceGroup", "produces": [ "application/json" ], @@ -389,7 +389,7 @@ "BackupVaults" ], "description": "Updates a BackupVault resource belonging to a resource group. For example, updating tags for a resource.", - "operationId": "BackupVaults_Patch", + "operationId": "BackupVaults_Update", "produces": [ "application/json" ], @@ -446,7 +446,7 @@ "tags": [ "Resources" ], - "operationId": "GetOperationResultPatch", + "operationId": "BackupVaultOperationResults_Get", "produces": [ "application/json" ], @@ -555,7 +555,7 @@ "DppFeatureSupport" ], "summary": "Validates if a feature is supported", - "operationId": "CheckFeatureSupport", + "operationId": "DataProtection_CheckFeatureSupport", "produces": [ "application/json" ], @@ -609,7 +609,7 @@ "Operations" ], "description": "Returns the list of available operations.", - "operationId": "Operations_List", + "operationId": "DataProtectionOperations_List", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -632,6 +632,11 @@ "x-ms-pageable": { "nextLinkName": "nextLink", "itemName": "value" + }, + "x-ms-examples": { + "Returns the list of supported REST operations.": { + "$ref": "./examples/Operations/List.json" + } } } }, @@ -758,6 +763,7 @@ }, { "name": "backupPolicyName", + "description": "Name of the policy", "in": "path", "required": true, "type": "string" @@ -1236,7 +1242,7 @@ "RecoveryPoint" ], "description": "Returns a list of Recovery Points for a DataSource in a vault.", - "operationId": "RecoveryPoints_GetList", + "operationId": "RecoveryPoints_List", "produces": [ "application/json" ], @@ -1306,7 +1312,7 @@ "RecoveryPoint" ], "description": "Gets a Recovery Point using recoveryPointId for a Datasource.", - "operationId": "RecoveryPoint_Get", + "operationId": "RecoveryPoints_Get", "produces": [ "application/json" ], @@ -1526,7 +1532,7 @@ "BackupInstances" ], "description": "Validates if Restore can be triggered for a DataSource", - "operationId": "BackupInstances_ValidateRestore", + "operationId": "BackupInstances_ValidateForRestore", "produces": [ "application/json" ], @@ -1648,12 +1654,12 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstances}/findRestorableTimeRanges": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/findRestorableTimeRanges": { "post": { "tags": [ "FindRestorableTimeRanges" ], - "operationId": "FindRestorableTimeRanges_Post", + "operationId": "RestorableTimeRanges_Find", "produces": [ "application/json" ], @@ -1671,7 +1677,8 @@ "$ref": "#/parameters/SubscriptionId" }, { - "name": "backupInstances", + "name": "backupInstanceName", + "description": "The name of the backup instance", "in": "path", "required": true, "type": "string" @@ -1713,7 +1720,7 @@ "AzureBackupJob" ], "description": "Gets a job with id in a backup vault", - "operationId": "Job_Get", + "operationId": "Jobs_Get", "produces": [ "application/json" ], @@ -2023,9 +2030,7 @@ "AzureBackupFindRestorableTimeRangesRequest": { "description": "List Restore Ranges Request", "required": [ - "sourceDataStoreType", - "startTime", - "endTime" + "sourceDataStoreType" ], "type": "object", "properties": { @@ -2043,11 +2048,11 @@ } }, "startTime": { - "description": "Start time for the List Restore Ranges request", + "description": "Start time for the List Restore Ranges request. ISO 8601 format.", "type": "string" }, "endTime": { - "description": "End time for the List Restore Ranges request", + "description": "End time for the List Restore Ranges request. ISO 8601 format.", "type": "string" } } diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2021-01-01/examples/BackupInstanceOperations/FindRestorableTimeRanges.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2021-01-01/examples/BackupInstanceOperations/FindRestorableTimeRanges.json index e50e8a20f945..4efd81f74b40 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2021-01-01/examples/BackupInstanceOperations/FindRestorableTimeRanges.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2021-01-01/examples/BackupInstanceOperations/FindRestorableTimeRanges.json @@ -3,7 +3,7 @@ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", "resourceGroupName": "Blob-Backup", "vaultName": "ZBlobBackupVaultBVTD3", - "backupInstances": "zblobbackuptestsa58", + "backupInstanceName": "zblobbackuptestsa58", "api-version": "2021-01-01", "parameters": { "sourceDataStoreType": "OperationalStore", diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2021-01-01/examples/Operations/List.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2021-01-01/examples/Operations/List.json new file mode 100644 index 000000000000..cf150a7e1d56 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2021-01-01/examples/Operations/List.json @@ -0,0 +1,403 @@ +{ + "parameters": { + "api-version": "2021-01-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/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/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/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/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/providers/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/readme.go.md b/specification/dataprotection/resource-manager/readme.go.md index d5a424541c96..83d186dfb6e7 100644 --- a/specification/dataprotection/resource-manager/readme.go.md +++ b/specification/dataprotection/resource-manager/readme.go.md @@ -13,6 +13,7 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2021-06-preview - tag: package-2021-02-preview - tag: package-2021-01 ``` @@ -34,3 +35,12 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2021-06-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/dataprotection/mgmt/2021-06-01-preview/$(namespace) +``` diff --git a/specification/dataprotection/resource-manager/readme.java.md b/specification/dataprotection/resource-manager/readme.java.md index 18a57ddb8f12..cc701deef3de 100644 --- a/specification/dataprotection/resource-manager/readme.java.md +++ b/specification/dataprotection/resource-manager/readme.java.md @@ -17,6 +17,7 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-dataprotection ``` yaml $(java) && $(multiapi) batch: + - tag: package-2021-06-preview - tag: package-2021-02-preview - tag: package-2021-01 ``` @@ -46,3 +47,16 @@ java: regenerate-manager: true generate-interface: true ``` + +### Tag: package-2021-06-preview and java + +These settings apply only when `--tag=package-2021-06-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2021-06-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.dataprotection.v2021_06_01_preview + output-folder: $(azure-libraries-for-java-folder)/dataprotection/resource-manager/v2021_06_01_preview +regenerate-manager: true +generate-interface: true +``` diff --git a/specification/dataprotection/resource-manager/readme.md b/specification/dataprotection/resource-manager/readme.md index acf9d6e4e243..f7edd374d664 100644 --- a/specification/dataprotection/resource-manager/readme.md +++ b/specification/dataprotection/resource-manager/readme.md @@ -63,6 +63,15 @@ These settings apply only when `--tag=package-2021-02-preview` is specified on t input-file: - Microsoft.DataProtection/preview/2021-02-01-preview/dataprotection.json ``` + +### Tag: package-2021-06-preview + +These settings apply only when `--tag=package-2021-06-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2021-06-preview' +input-file: +- Microsoft.DataProtection/preview/2021-06-01-preview/dataprotection.json +``` --- # Code Generation @@ -122,7 +131,8 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: - Microsoft.DataProtection/stable/2021-01-01/dataprotection.json - - Microsoft.DataProtection/preview/2021-02-01-preview/dataprotection.json + - Microsoft.DataProtection/preview/2021-02-01-preview/dataprotection.json + - Microsoft.DataProtection/preview/2021-06-01-preview/dataprotection.json ``` If there are files that should not be in the `all-api-versions` set, diff --git a/specification/dataprotection/resource-manager/readme.ruby.md b/specification/dataprotection/resource-manager/readme.ruby.md index 8bf032fd146b..34810f4abacd 100644 --- a/specification/dataprotection/resource-manager/readme.ruby.md +++ b/specification/dataprotection/resource-manager/readme.ruby.md @@ -12,6 +12,7 @@ azure-arm: true ``` yaml $(ruby) && $(multiapi) batch: + - tag: package-2021-06-preview - tag: package-2021-02-preview ``` @@ -24,3 +25,13 @@ Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2021-06-preview' && $(ruby) +namespace: "Azure::DataProtection::Mgmt::V2021_06_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_data_protection/lib +``` diff --git a/specification/datashare/resource-manager/readme.md b/specification/datashare/resource-manager/readme.md index 584f9e203462..d16c0aef9fa1 100644 --- a/specification/datashare/resource-manager/readme.md +++ b/specification/datashare/resource-manager/readme.md @@ -78,7 +78,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-go - repo: azure-cli-extensions diff --git a/specification/datashare/resource-manager/readme.python.md b/specification/datashare/resource-manager/readme.python.md index 9bbfc58e2633..e8eac3df6c68 100644 --- a/specification/datashare/resource-manager/readme.python.md +++ b/specification/datashare/resource-manager/readme.python.md @@ -3,37 +3,15 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. -```yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.datashare - package-name: azure-mgmt-datashare - package-version: 2019-11-01 - clear-output-folder: true -``` ```yaml $(python) && $(track2) -python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.datashare package-name: azure-mgmt-datashare -package-version: 2019-11-01 +package-version: 1.0.0b1 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/datashare/azure-mgmt-datashare/azure/mgmt/datashare -``` -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/datashare/azure-mgmt-datashare -``` ``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/datashare/azure-mgmt-datashare/azure/mgmt/datashare diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/desktopvirtualization.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/desktopvirtualization.json new file mode 100644 index 000000000000..f3e38068dc6f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/desktopvirtualization.json @@ -0,0 +1,6835 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-05-13-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/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved operations.", + "schema": { + "$ref": "#/definitions/ResourceProviderOperationList" + } + } + }, + "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/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/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/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/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/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/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/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/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": { + "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/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" + } + ], + "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/v1/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/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/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/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/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/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/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/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/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/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" + } + ], + "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}/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/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "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/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/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/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/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/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/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/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/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/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" + }, + { + "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 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/v1/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/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/ApplicationGroupNameParameter" + } + ], + "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/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/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/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/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/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/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/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/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/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/ApplicationGroupNameParameter" + } + ], + "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/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/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/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/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/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/ApplicationGroupNameParameter" + } + ], + "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/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" + } + ], + "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/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": "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/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": "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/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": "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/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" + } + ], + "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/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "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}/sessionHostConfigurations/default": { + "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/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" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved host pool.", + "schema": { + "$ref": "#/definitions/SessionHostConfiguration" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "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/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": "sessionHostConfiguration", + "description": "Object containing HostPool definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SessionHostConfiguration" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated SessionHostConfiguration.", + "schema": { + "$ref": "#/definitions/SessionHostConfiguration" + } + }, + "201": { + "description": "Successfully created SessionHostConfiguration.", + "schema": { + "$ref": "#/definitions/SessionHostConfiguration" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "SessionHostConfiguration" + ], + "operationId": "SessionHostConfigurations_Delete", + "description": "Remove a SessionHostConfiguration.", + "x-ms-examples": { + "SessionHostConfigurations_Delete": { + "$ref": "./examples/SessionHostConfigurations_Delete.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" + } + ], + "responses": { + "200": { + "description": "Successfully removed host pool.", + "schema": { + "$ref": "#/definitions/SessionHostConfiguration" + } + }, + "204": { + "description": "Host pool does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "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/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": "hostPool", + "description": "Object containing HostPool definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/HostPoolPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated 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/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" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved host pool in resource group.", + "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}/update": { + "post": { + "tags": [ + "HostPoolUpdate" + ], + "operationId": "HostPoolPost_Update", + "description": "Initiate update of a hostpool.", + "x-ms-examples": { + "HostPools_Update_Post": { + "$ref": "./examples/HostPools_Update_Post.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": "hostPoolUpdate", + "description": "Object containing HostPool update definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/HostPoolUpdate" + } + } + ], + "responses": { + "202": { + "description": "Successfully initiated hostpool update." + }, + "default": { + "description": "Automation 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" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/controlUpdate": { + "post": { + "tags": [ + "HostPoolUpdate" + ], + "operationId": "HostPools_ControlUpdate", + "description": "Control update of a hostpool.", + "x-ms-examples": { + "HostPools_ControlUpdate_Post": { + "$ref": "./examples/HostPools_ControlUpdate_Post.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": "hostPoolControlParameter", + "description": "Object containing control action for hostpool update.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/HostPoolControlParameter" + } + } + ], + "responses": { + "204": { + "description": "Successfully controlled hostpool update." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/updateDetails": { + "get": { + "tags": [ + "HostPoolUpdate" + ], + "operationId": "UpdateDetails_List", + "description": "Operation status of a validate hostpool update.", + "x-ms-examples": { + "UpdateDetails_List": { + "$ref": "./examples/UpdateDetails_List.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" + } + ], + "responses": { + "200": { + "description": "Hostpool update full properties including session host config, hostpool update parameters, and migration progress.", + "schema": { + "$ref": "#/definitions/UpdateStatusList" + } + }, + "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}/updateDetails/default": { + "get": { + "tags": [ + "HostPoolUpdate" + ], + "operationId": "UpdateDetails_Get", + "description": "Operation status of a validate hostpool update.", + "x-ms-examples": { + "UpdateDetails_Get": { + "$ref": "./examples/UpdateDetails_Get.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" + } + ], + "responses": { + "200": { + "description": "Hostpool update full properties including session host config, hostpool update parameters, and migration progress.", + "schema": { + "$ref": "#/definitions/UpdateStatus" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/updateValidationOperationResults/default": { + "get": { + "tags": [ + "HostPoolUpdate" + ], + "operationId": "UpdateValidationOperationResults_Get", + "description": "Operation status of a validate hostpool update.", + "x-ms-examples": { + "UpdateValidationOperationResults_Get": { + "$ref": "./examples/UpdateValidationOperationResults_Get.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" + } + ], + "responses": { + "200": { + "description": "Errors and warnings returned by hostpool update validation.", + "schema": { + "$ref": "#/definitions/HostPoolUpdateValidationResponse" + } + }, + "202": { + "description": "Async operation in progress." + }, + "default": { + "description": "Automation 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" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/updateOperationResults/default": { + "get": { + "tags": [ + "HostPoolUpdate" + ], + "operationId": "UpdateOperationResults_Get", + "description": "Operation status of a validate hostpool update.", + "x-ms-examples": { + "UpdateOperationResults_Get": { + "$ref": "./examples/UpdateOperationResults_Get.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" + } + ], + "responses": { + "200": { + "description": "Hostpool update full properties including session host config, hostpool update parameters, and migration progress.", + "schema": { + "$ref": "#/definitions/HostPoolUpdateFullProperties" + } + }, + "202": { + "description": "Async operation in progress." + }, + "default": { + "description": "Automation 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" + } + } + }, + "/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/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" + } + ], + "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/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": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are userprincipalname and sessionstate." + } + ], + "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/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" + }, + { + "$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/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" + }, + { + "$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/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" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "name": "sessionHost", + "description": "Object containing SessionHost definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SessionHostPatch" + } + } + ], + "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/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" + } + ], + "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}/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/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" + }, + { + "$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/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" + }, + { + "$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/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" + }, + { + "$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/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" + }, + { + "$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/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" + } + ], + "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}/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/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": "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/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/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" + }, + { + "$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/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" + }, + { + "$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/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" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + } + ], + "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/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" + }, + { + "$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/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" + }, + { + "$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/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" + } + ], + "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/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" + } + ], + "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/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" + }, + { + "$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/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" + }, + { + "$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/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" + }, + { + "$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/v1/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/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" + } + ], + "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/{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/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/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/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/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/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/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/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/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/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/v1/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/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/WorkspaceNameParameter" + } + ], + "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" + } + } + } + }, + "definitions": { + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorProperties" + } + } + }, + "CloudErrorProperties": { + "type": "object", + "properties": { + "code": { + "description": "Error code", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + }, + "ResourceProviderOperationList": { + "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": { + "description": "Supported operation of this resource provider.", + "readOnly": true, + "properties": { + "name": { + "description": "Operation name, in format of {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "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 + } + } + }, + "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 + }, + "migrationRequest": { + "$ref": "#/definitions/MigrationRequestProperties", + "description": "The registration info of HostPool." + }, + "cloudPcResource": { + "type": "boolean", + "description": "Is cloud pc resource.", + "readOnly": true + } + } + }, + "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." + } + } + }, + "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", + "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", + "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." + }, + "applicationGroupReferences": { + "readOnly": true, + "type": "array", + "description": "List of applicationGroup 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." + }, + "migrationRequest": { + "$ref": "#/definitions/MigrationRequestProperties", + "description": "The registration info of HostPool." + }, + "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 + }, + "sessionHostComponentUpdateConfiguration": { + "$ref": "#/definitions/SessionHostComponentUpdateConfigurationProperties", + "description": "The session host configuration for updating agent, monitoring agent, and stack component." + } + } + }, + "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", + "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", + "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" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + }, + "type": "string", + "description": "Enabled to allow this resource to be access from the public network" + }, + "sessionHostComponentUpdateConfiguration": { + "$ref": "#/definitions/SessionHostComponentUpdateConfigurationProperties", + "description": "The session host configuration for updating agent, monitoring agent, and stack component." + } + } + }, + "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" + } + ], + "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", + "properties": { + "version": { + "type": "string", + "format": "date-time", + "description": "The time when session host configuration was last modified and something was changed.", + "readOnly": true + }, + "vMSizeId": { + "type": "string", + "description": "The id of the size of a virtual machine connected to a hostpool." + }, + "diskType": { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "UltraSSD_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." + }, + { + "value": "UltraSSD_LRS", + "description": "Ultra SSD locally redundant storage. Best for IO-intensive workloads such as SAP HANA, top tier databases (for example, SQL, Oracle), and other transaction-heavy workloads." + } + ] + }, + "description": "The disk type used by virtual machine in hostpool session host." + }, + "vmCustomConfigurationUri": { + "type": "string", + "description": "The uri to the storage blob containing scripts 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." + } + } + }, + "ImageInfoProperties": { + "description": "Image configurations of session host in a HostPool.", + "type": "object", + "properties": { + "type": { + "enum": [ + "Gallery", + "StorageBlob", + "CustomImage" + ], + "x-ms-enum": { + "name": "ImageType", + "modelAsString": true, + "values": [ + { + "value": "Gallery", + "description": "Using default gallery images offered by Azure Marketplace." + }, + { + "value": "StorageBlob", + "description": "Using a VHD stored in a storage blob." + }, + { + "value": "CustomImage", + "description": "Using custom image or custom shared 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 gallery image." + }, + "storageBlobUri": { + "type": "string", + "description": "The uri to the storage blob which contains the VHD. Image type must be StorageBlob." + }, + "customId": { + "type": "string", + "description": "The resource id of the custom image or shared image. Image type must be CustomImage." + } + } + }, + "MarketPlaceInfoProperties": { + "description": "Image configurations of HostPool.", + "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." + } + } + }, + "DomainInfoProperties": { + "description": "Domain configurations of session hosts.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The domain a virtual machine connected to a hostpool will join." + }, + "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 + }, + "mdmProviderGuid": { + "type": "string", + "description": "The MDM Provider GUID used during MDM enrollment for Azure AD joined virtual machines." + }, + "credentials": { + "$ref": "#/definitions/CredentialsProperties", + "description": "Credentials needed to create the virtual machine." + } + } + }, + "CredentialsProperties": { + "description": "Credentials needed to create the virtual machine.", + "type": "object", + "properties": { + "localAdmin": { + "$ref": "#/definitions/KeyVaultCredentialProperties", + "description": "The local admin credentials." + }, + "domainAdmin": { + "$ref": "#/definitions/KeyVaultCredentialProperties", + "description": "The domain admin credentials." + } + } + }, + "KeyVaultCredentialProperties": { + "description": "Credentials kept in the keyvault.", + "type": "object", + "properties": { + "userName": { + "type": "string", + "description": "The user name to the account." + }, + "passwordKeyVaultResourceId": { + "type": "string", + "description": "The keyvault resource id to the keyvault secrets." + }, + "passwordSecretName": { + "type": "string", + "description": "The keyvault secret name the password is stored in." + } + } + }, + "HostPoolUpdate": { + "description": "Properties for a hostpool update.", + "type": "object", + "properties": { + "validateOnly": { + "type": "boolean", + "description": "When validateOnly is true this will run validations and return warnings and errors if any, hostpool will not be updated." + }, + "parameters": { + "$ref": "#/definitions/HostPoolUpdateConfigurationProperties", + "description": "Parameters for a hostpool update." + } + } + }, + "HostPoolUpdateConfigurationProperties": { + "description": "The configurations of a hostpool update.", + "type": "object", + "properties": { + "saveOriginalDisk": { + "type": "boolean", + "description": "Whether to save original disk. False by default." + }, + "maxVMsRemovedDuringUpdate": { + "type": "integer", + "format": "int32", + "description": "The maximum virtual machines to be removed during hostpool update." + }, + "maintenanceAlerts": { + "type": "array", + "description": "The alerts given to customers for hostpool update.", + "items": { + "$ref": "#/definitions/MaintenanceAlertsProperties" + } + }, + "logOffDelaySeconds": { + "type": "integer", + "format": "int32", + "description": "Grace period before logging off users in seconds." + }, + "logOffMessage": { + "type": "string", + "description": "Log off message sent to user for logoff." + }, + "scheduledTime": { + "$ref": "#/definitions/ScheduledTimeProperties", + "description": "When set schedules the hostpool update at specific time." + } + } + }, + "MaintenanceAlertsProperties": { + "type": "object", + "description": "Properties for host pool update maintenance alerts.", + "properties": { + "message": { + "type": "string", + "description": "The path to the legacy object to migrate." + }, + "duration": { + "type": "integer", + "format": "int32", + "description": "The time maintenance notification will be sent relative to before/after the update kickoff in minutes." + }, + "beforeKickOff": { + "type": "boolean", + "description": "Whether to send maintenance alert after or before hostpool update. False by default." + } + } + }, + "ScheduledTimeProperties": { + "type": "object", + "description": "When set schedules the hostpool update at specific time.", + "properties": { + "dateTime": { + "type": "string", + "format": "date-time", + "description": "The time the hostpool update is schedule for." + }, + "timeZone": { + "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." + } + } + }, + "UpdateStatusList": { + "type": "object", + "title": "UpdateStatusList", + "description": "List of UpdateStatus definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of UpdateStatus definitions.", + "items": { + "$ref": "#/definitions/UpdateStatus" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "UpdateStatus": { + "type": "object", + "description": "Represents a Update Status 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 Update Status", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HostPoolUpdateFullProperties" + } + } + }, + "HostPoolControlParameter": { + "description": "Represents properties for a hostpool update.", + "type": "object", + "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 + }, + "message": { + "type": "string", + "description": "The cancel message sent to the user on the session host." + } + } + }, + "HostPoolUpdateProgress": { + "description": "Properties of host pool update progress.", + "type": "object", + "readOnly": true, + "properties": { + "timeCreated": { + "format": "date-time", + "type": "string", + "description": "The hostpool update create time." + }, + "timeStarted": { + "format": "date-time", + "type": "string", + "description": "The hostpool update start time." + }, + "timeFailed": { + "format": "date-time", + "type": "string", + "description": "The hostpool update fail time." + }, + "timeEnded": { + "format": "date-time", + "type": "string", + "description": "The hostpool update end time." + }, + "errors": { + "type": "array", + "description": "The alerts given to customers for hostpool update.", + "items": { + "$ref": "#/definitions/HostPoolUpdateFault" + } + }, + "progressPercentage": { + "type": "number", + "format": "float", + "description": "The progress percentage." + }, + "sessionHostsToUpdate": { + "type": "integer", + "format": "int32", + "description": "The number of session hosts to update by hostpool update." + }, + "sessionHostsUpdating": { + "type": "integer", + "format": "int32", + "description": "The number of session hosts updating by hostpool update." + }, + "sessionHostsUpdated": { + "type": "integer", + "format": "int32", + "description": "The number of session hosts updated by hostpool update." + }, + "sessionHostsRollbackFailed": { + "type": "integer", + "format": "int32", + "description": "The number of session hosts that failed to rollback." + } + } + }, + "HostPoolUpdateFullPropertiesList": { + "type": "object", + "title": "HostPoolUpdateFullPropertiesList", + "description": "List of HostPoolUpdateFullPropertiesList definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of HostPoolUpdateFullPropertiesList definitions.", + "items": { + "$ref": "#/definitions/HostPoolUpdateFullProperties" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "HostPoolUpdateFullProperties": { + "description": "Hostpool update full properties including session host config, hostpool update parameters, and update progress.", + "type": "object", + "readOnly": true, + "properties": { + "updateStatus": { + "enum": [ + "Scheduled", + "InProgress", + "Pausing", + "Paused", + "StartFailed", + "UpdateFailed", + "Cancelling", + "Canceled", + "Completed" + ], + "x-ms-enum": { + "name": "HostPoolUpdateStatus", + "modelAsString": true, + "values": [ + { + "value": "Scheduled", + "description": "Hostpool update scheduled." + }, + { + "value": "InProgress", + "description": "Hostpool update in progress." + }, + { + "value": "Pausing", + "description": "Hostpool update pausing." + }, + { + "value": "Paused", + "description": "Hostpool update paused." + }, + { + "value": "StartFailed", + "description": "Hostpool update start failed." + }, + { + "value": "UpdateFailed", + "description": "Hostpool update update failed." + }, + { + "value": "Cancelling", + "description": "Hostpool update cancelling." + }, + { + "value": "Canceled", + "description": "Hostpool update canceled." + }, + { + "value": "Completed", + "description": "Hostpool update completed." + } + ] + }, + "type": "string", + "description": "State of hostpool update.", + "x-nullable": false + }, + "version": { + "type": "string", + "description": "The version of hostpool update." + }, + "hostPoolResourceId": { + "type": "string", + "description": "The resourceId of hostpool." + }, + "correlationId": { + "type": "string", + "description": "The correlationId of the hostpool update." + }, + "updateProgress": { + "$ref": "#/definitions/HostPoolUpdateProgress", + "description": "Properties of host pool update progress." + }, + "hostPoolUpdateConfiguration": { + "$ref": "#/definitions/HostPoolUpdateConfigurationProperties", + "description": "The configurations of a hostpool update." + }, + "sessionHostConfiguration": { + "$ref": "#/definitions/SessionHostConfigurationProperties", + "description": "The session host configurations of a host pool." + } + } + }, + "HostPoolUpdateValidationResponse": { + "description": "Errors and warnings returned by hostpool update validation.", + "type": "object", + "readOnly": true, + "properties": { + "warnings": { + "type": "array", + "description": "Warnings from the hostpool update validation.", + "items": { + "$ref": "#/definitions/HostPoolUpdateFault" + } + }, + "errors": { + "type": "array", + "description": "Errors from the hostpool update validation.", + "items": { + "$ref": "#/definitions/HostPoolUpdateFault" + } + } + } + }, + "HostPoolUpdateFault": { + "description": "Hostpool update fault information.", + "type": "object", + "properties": { + "faultType": { + "type": "string", + "description": "Hostpool update fault type. Either ServiceError or UserError." + }, + "faultCode": { + "type": "string", + "description": "Hostpool update fault code." + }, + "faultText": { + "type": "string", + "description": "Hostpool update fault text." + }, + "faultContext": { + "type": "string", + "description": "Hostpool update fault context." + } + } + }, + "SessionHostComponentUpdateConfigurationProperties": { + "description": "The session host configuration for updating agent, monitoring agent, and stack component.", + "type": "object", + "properties": { + "maintenanceType": { + "type": "string", + "description": "The type of maintenance for session host components.", + "enum": [ + "Default", + "TenantAdminControlled" + ], + "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": "TenantAdminControlled", + "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." + }, + "primaryWindow": { + "$ref": "#/definitions/MaintenanceWindowProperties", + "description": "Primary Window of the maintenance. Maintenance windows are 2 hours long. We try to push component update in this window first." + }, + "secondaryWindow": { + "$ref": "#/definitions/SecondaryWindowProperties", + "description": "Secondary maintenance windows. Maintenance windows are 2 hours long. We try to exercise this only when the primary window update fails." + } + } + }, + "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 + } + } + } + }, + "SecondaryWindowProperties": { + "description": "Secondary maintenance windows is a list of days at one specific hour. Maintenance windows are 2 hours long. We try to exercise this only when the primary window update fails.", + "type": "object", + "properties": { + "hour": { + "format": "int32", + "type": "integer", + "description": "The update start hour of the day. (0 - 23)" + }, + "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" + } + } + } + }, + "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." + } + } + }, + "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." + } + } + }, + "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", + "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", + "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", + "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 + } + } + }, + "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", + "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." + }, + "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." + }, + "sessionHostHealthCheckResults": { + "type": "array", + "readOnly": true, + "description": "List of SessionHostHealthCheckReports", + "items": { + "$ref": "#/definitions/SessionHostHealthCheckReport" + } + }, + "lastSessionHostUpdateTime": { + "type": "string", + "format": "date-time", + "description": "The last time update was completed.", + "readOnly": true + }, + "sessionHostConfigurationLastUpdateTime": { + "type": "string", + "format": "date-time", + "description": "This time will match the time in the session host configuration for when the update was initiated.", + "readOnly": true + }, + "imageResourceId": { + "type": "string", + "description": "The resourceId of the image of session host.", + "readOnly": true + }, + "imageType": { + "enum": [ + "Gallery", + "StorageBlob", + "CustomImage" + ], + "x-ms-enum": { + "name": "ImageType", + "modelAsString": true, + "values": [ + { + "value": "Gallery", + "description": "Using default gallery images offered by azure market place." + }, + { + "value": "StorageBlob", + "description": "Using a VHD stored in a storage blob." + }, + { + "value": "CustomImage", + "description": "Using custom image or custom shared image." + } + ] + }, + "type": "string", + "description": "The type of image session hosts use in the hostpool.", + "x-nullable": false, + "readOnly": true + }, + "updateStatus": { + "enum": [ + "InProgress", + "NotInProgress" + ], + "x-ms-enum": { + "name": "SessionHostUpdateStatus", + "modelAsString": true, + "values": [ + { + "value": "InProgress", + "description": "Session host update in progress." + }, + { + "value": "NotInProgress", + "description": "Session host update not in progress." + } + ] + }, + "type": "string", + "description": "Updating state of the session host.", + "x-nullable": false, + "readOnly": true + } + } + }, + "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." + }, + { + "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." + }, + { + "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." + }, + { + "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." + }, + { + "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 ...)." + }, + { + "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." + }, + { + "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." + }, + { + "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." + }, + { + "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." + }, + { + "value": "MetaDataServiceCheck", + "description": "Verifies the metadata service is accessible and return compute properties." + }, + { + "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." + } + ] + }, + "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." + } + } + }, + "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.", + "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" + } + } + }, + "ScalingPlanProperties": { + "type": "object", + "description": "Scaling plan properties.", + "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": [ + "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 + }, + "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" + } + } + } + }, + "ScalingSchedule": { + "description": "Scaling plan schedule.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the scaling schedule." + }, + "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": { + "format": "date-time", + "type": "string", + "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": 0, + "maximum": 100, + "description": "Capacity threshold for ramp up period." + }, + "peakStartTime": { + "format": "date-time", + "type": "string", + "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": { + "format": "date-time", + "type": "string", + "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": 0, + "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": { + "format": "date-time", + "type": "string", + "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." + } + } + }, + "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." + }, + "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 + }, + "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" + } + } + } + }, + "MigrationRequestProperties": { + "type": "object", + "description": "Properties for arm migration.", + "properties": { + "operation": { + "enum": [ + "Start", + "Revoke", + "Complete", + "Hide", + "Unhide" + ], + "x-ms-enum": { + "name": "Operation", + "modelAsString": true, + "values": [ + { + "value": "Start", + "description": "Start the migration." + }, + { + "value": "Revoke", + "description": "Revoke the migration." + }, + { + "value": "Complete", + "description": "Complete the migration." + }, + { + "value": "Hide", + "description": "Hide the hostpool." + }, + { + "value": "Unhide", + "description": "Unhide the hostpool." + } + ] + }, + "type": "string", + "description": "The type of operation for migration." + }, + "migrationPath": { + "type": "string", + "description": "The path to the legacy object to migrate." + } + } + }, + "PrivateEndpointConnectionWithSystemData": { + "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": { + "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" + } + }, + "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" + }, + "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": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ApplicationGroup_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ApplicationGroup_Create.json new file mode 100644 index 000000000000..5deb5efc7f90 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ApplicationGroup_Create.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2021-05-13-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", + "migrationRequest": { + "migrationPath": "TenantGroups/{defaultV1TenantGroup.Name}/Tenants/{defaultV1Tenant.Name}/HostPools/{sessionHostPool.Name}", + "operation": "Start" + } + } + } + }, + "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, + "migrationRequest": { + "migrationPath": "TenantGroups/{defaultV1TenantGroup.Name}/Tenants/{defaultV1Tenant.Name}/HostPools/{sessionHostPool.Name}", + "operation": "Start" + } + } + } + }, + "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, + "migrationRequest": { + "migrationPath": "TenantGroups/{defaultV1TenantGroup.Name}/Tenants/{defaultV1Tenant.Name}/HostPools/{sessionHostPool.Name}", + "operation": "Start" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ApplicationGroup_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ApplicationGroup_Delete.json new file mode 100644 index 000000000000..a42d0d7c00c4 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ApplicationGroup_Delete.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2021-05-13-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 + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ApplicationGroup_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ApplicationGroup_Get.json new file mode 100644 index 000000000000..a9509e683f66 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ApplicationGroup_Get.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2021-05-13-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 + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ApplicationGroup_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ApplicationGroup_ListByResourceGroup.json new file mode 100644 index 000000000000..2be44e7b576b --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ApplicationGroup_ListByResourceGroup.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2021-05-13-preview", + "$filter": "applicationGroupType eq 'RailApplication'" + }, + "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 + } + }, + { + "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 + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ApplicationGroup_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ApplicationGroup_ListBySubscription.json new file mode 100644 index 000000000000..f78438193685 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ApplicationGroup_ListBySubscription.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2021-05-13-preview", + "$filter": "applicationGroupType eq 'RailApplication'" + }, + "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 + } + }, + { + "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 + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ApplicationGroup_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ApplicationGroup_Update.json new file mode 100644 index 000000000000..00ea08f02caa --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ApplicationGroup_Update.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2021-05-13-preview", + "applicationGroup": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "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 + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Application_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Application_Create.json new file mode 100644 index 000000000000..e232f5518bd6 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Application_Create.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2021-05-13-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": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA...", + "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": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA...", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Application_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Application_Delete.json new file mode 100644 index 000000000000..680f32776ce4 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Application_Delete.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2021-05-13-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": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA...", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Application_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Application_Get.json new file mode 100644 index 000000000000..cd576f35c6ec --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Application_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2021-05-13-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": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA...", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Application_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Application_List.json new file mode 100644 index 000000000000..6bbe60c906c9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Application_List.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2021-05-13-preview" + }, + "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": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA...", + "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": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA...", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Application_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Application_Update.json new file mode 100644 index 000000000000..9c626d066b01 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Application_Update.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2021-05-13-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": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA...", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Desktop_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Desktop_Get.json new file mode 100644 index 000000000000..93643fbb9aed --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Desktop_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "desktopName": "SessionDesktop", + "api-version": "2021-05-13-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": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Desktop_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Desktop_List.json new file mode 100644 index 000000000000..bf6889eec266 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Desktop_List.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2021-05-13-preview" + }, + "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": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Desktop_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Desktop_Update.json new file mode 100644 index 000000000000..2aaca3147334 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Desktop_Update.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "desktopName": "SessionDesktop", + "api-version": "2021-05-13-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": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/HostPool_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/HostPool_Create.json new file mode 100644 index 000000000000..ada51f5ff766 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/HostPool_Create.json @@ -0,0 +1,190 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2021-05-13-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}", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "migrationRequest": { + "migrationPath": "TenantGroups/{defaultV1TenantGroup.Name}/Tenants/{defaultV1Tenant.Name}/HostPools/{sessionHostPool.Name}", + "operation": "Start" + }, + "publicNetworkAccess": "Enabled", + "sessionHostComponentUpdateConfiguration": { + "maintenanceType": "TenantAdminControlled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "primaryWindow": { + "hour": 7, + "dayOfWeek": "Friday" + }, + "secondaryWindow": { + "hour": 8, + "daysOfWeek": [ + "Sunday", + "Monday" + ] + } + } + } + } + }, + "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}", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "migrationRequest": { + "migrationPath": "TenantGroups/{defaultV1TenantGroup.Name}/Tenants/{defaultV1Tenant.Name}/HostPools/{sessionHostPool.Name}", + "operation": "Start" + }, + "publicNetworkAccess": "Enabled", + "sessionHostComponentUpdateConfiguration": { + "maintenanceType": "TenantAdminControlled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "primaryWindow": { + "hour": 7, + "dayOfWeek": "Friday" + }, + "secondaryWindow": { + "hour": 8, + "daysOfWeek": [ + "Sunday", + "Monday" + ] + } + } + } + } + }, + "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}", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "migrationRequest": { + "migrationPath": "TenantGroups/{defaultV1TenantGroup.Name}/Tenants/{defaultV1Tenant.Name}/HostPools/{sessionHostPool.Name}", + "operation": "Start" + }, + "publicNetworkAccess": "Enabled", + "sessionHostComponentUpdateConfiguration": { + "maintenanceType": "TenantAdminControlled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "primaryWindow": { + "hour": 7, + "dayOfWeek": "Friday" + }, + "secondaryWindow": { + "hour": 8, + "daysOfWeek": [ + "Sunday", + "Monday" + ] + } + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/HostPool_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/HostPool_Delete.json new file mode 100644 index 000000000000..5617ea66932d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/HostPool_Delete.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2021-05-13-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}", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "startVMOnConnect": false, + "cloudPcResource": false, + "sessionHostComponentUpdateConfiguration": { + "maintenanceType": "TenantAdminControlled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "primaryWindow": { + "hour": 7, + "dayOfWeek": "Friday" + }, + "secondaryWindow": { + "hour": 8, + "daysOfWeek": [ + "Sunday", + "Monday" + ] + } + } + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/HostPool_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/HostPool_Get.json new file mode 100644 index 000000000000..724ce9eafa08 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/HostPool_Get.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2021-05-13-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}", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "publicNetworkAccess": "Enabled", + "sessionHostComponentUpdateConfiguration": { + "maintenanceType": "TenantAdminControlled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "primaryWindow": { + "hour": 7, + "dayOfWeek": "Friday" + }, + "secondaryWindow": { + "hour": 8, + "daysOfWeek": [ + "Sunday", + "Monday" + ] + } + } + } + } + }, + "default": { + "body": { + "error": { + "code": "hostPoolDoesNotExist", + "message": "Host Pool Does Not Exist" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/HostPool_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/HostPool_List.json new file mode 100644 index 000000000000..09c0967ed297 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/HostPool_List.json @@ -0,0 +1,134 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2021-05-13-preview" + }, + "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}", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "publicNetworkAccess": "Enabled", + "sessionHostComponentUpdateConfiguration": { + "maintenanceType": "TenantAdminControlled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "primaryWindow": { + "hour": 7, + "dayOfWeek": "Friday" + }, + "secondaryWindow": { + "hour": 8, + "daysOfWeek": [ + "Sunday", + "Monday" + ] + } + } + } + }, + { + "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}", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "publicNetworkAccess": "Enabled", + "sessionHostComponentUpdateConfiguration": { + "maintenanceType": "TenantAdminControlled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "primaryWindow": { + "hour": 7, + "dayOfWeek": "Friday" + }, + "secondaryWindow": { + "hour": 8, + "daysOfWeek": [ + "Sunday", + "Monday" + ] + } + } + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/HostPool_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/HostPool_ListByResourceGroup.json new file mode 100644 index 000000000000..46e046b747e2 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/HostPool_ListByResourceGroup.json @@ -0,0 +1,135 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2021-05-13-preview" + }, + "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}", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "publicNetworkAccess": "Enabled", + "sessionHostComponentUpdateConfiguration": { + "maintenanceType": "TenantAdminControlled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "primaryWindow": { + "hour": 7, + "dayOfWeek": "Friday" + }, + "secondaryWindow": { + "hour": 8, + "daysOfWeek": [ + "Sunday", + "Monday" + ] + } + } + } + }, + { + "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}", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "publicNetworkAccess": "Enabled", + "sessionHostComponentUpdateConfiguration": { + "maintenanceType": "TenantAdminControlled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "primaryWindow": { + "hour": 7, + "dayOfWeek": "Friday" + }, + "secondaryWindow": { + "hour": 8, + "daysOfWeek": [ + "Sunday", + "Monday" + ] + } + } + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/HostPool_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/HostPool_Update.json new file mode 100644 index 000000000000..10e0a72d823b --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/HostPool_Update.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2021-05-13-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, + "publicNetworkAccess": "Enabled", + "sessionHostComponentUpdateConfiguration": { + "maintenanceType": "TenantAdminControlled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "primaryWindow": { + "hour": 7, + "dayOfWeek": "Friday" + }, + "secondaryWindow": { + "hour": 8, + "daysOfWeek": [ + "Sunday", + "Monday" + ] + } + } + } + } + }, + "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}", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "publicNetworkAccess": "Enabled", + "sessionHostComponentUpdateConfiguration": { + "maintenanceType": "TenantAdminControlled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "primaryWindow": { + "hour": 7, + "dayOfWeek": "Friday" + }, + "secondaryWindow": { + "hour": 8, + "daysOfWeek": [ + "Sunday", + "Monday" + ] + } + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/HostPools_ControlUpdate_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/HostPools_ControlUpdate_Post.json new file mode 100644 index 000000000000..d11c82cf773f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/HostPools_ControlUpdate_Post.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2021-05-13-preview", + "hostPoolControlParameter": { + "action": "Start", + "message": "Host pool update started" + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/HostPools_RetrieveRegistrationToken_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/HostPools_RetrieveRegistrationToken_Post.json new file mode 100644 index 000000000000..581515ab836d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/HostPools_RetrieveRegistrationToken_Post.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2021-05-13-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/2021-05-13-preview/examples/HostPools_Update_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/HostPools_Update_Post.json new file mode 100644 index 000000000000..1e520c7f02a5 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/HostPools_Update_Post.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2021-05-13-preview", + "hostPoolUpdate": { + "validateOnly": false, + "parameters": { + "saveOriginalDisk": true, + "maxVMsRemovedDuringUpdate": 4, + "maintenanceAlerts": [ + { + "message": "hostpool under maintenance", + "duration": 10, + "beforeKickOff": false + } + ], + "logOffDelaySeconds": 10, + "logOffMessage": "logging off for hostpool update", + "scheduledTime": { + "dateTime": "2008-09-22T14:01:54.9571247Z", + "timeZone": "Alaskan Standard Time" + } + } + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/MsixImage_Expand_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/MsixImage_Expand_Post.json new file mode 100644 index 000000000000..edc743264354 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/MsixImage_Expand_Post.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2021-05-13-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": "RawIcon", + "rawPng": "RawPng" + } + ] + } + }, + { + "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": "RawIcon1", + "rawPng": "RawPng1" + }, + { + "appId": "AppId2", + "description": "PackageApplicationDescription2", + "appUserModelID": "AppUserModelId2", + "friendlyName": "FriendlyName2", + "iconImageName": "Iconimagename2", + "rawIcon": "RawIcon2", + "rawPng": "RawPng2" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/MsixPackage_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/MsixPackage_Create.json new file mode 100644 index 000000000000..ae32d4b69acf --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/MsixPackage_Create.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2021-05-13-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/2021-05-13-preview/examples/MsixPackage_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/MsixPackage_Delete.json new file mode 100644 index 000000000000..f589496bff31 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/MsixPackage_Delete.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2021-05-13-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/2021-05-13-preview/examples/MsixPackage_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/MsixPackage_Get.json new file mode 100644 index 000000000000..ed00e1a960ab --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/MsixPackage_Get.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2021-05-13-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/2021-05-13-preview/examples/MsixPackage_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/MsixPackage_List.json new file mode 100644 index 000000000000..a1d2f0bc0834 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/MsixPackage_List.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2021-05-13-preview" + }, + "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": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo2", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo2" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/MsixPackage_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/MsixPackage_Update.json new file mode 100644 index 000000000000..cf95abb5be48 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/MsixPackage_Update.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2021-05-13-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/2021-05-13-preview/examples/OperationDescription_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/OperationDescription_List.json new file mode 100644 index 000000000000..048cfe8329bf --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/OperationDescription_List.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2021-05-13-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/2021-05-13-preview/examples/PrivateEndpointConnection_DeleteByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/PrivateEndpointConnection_DeleteByHostPool.json new file mode 100644 index 000000000000..38258d1ccf5b --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-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": "2021-05-13-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/PrivateEndpointConnection_DeleteByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/PrivateEndpointConnection_DeleteByWorkspace.json new file mode 100644 index 000000000000..8255e8fd55b9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-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": "2021-05-13-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/PrivateEndpointConnection_GetByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/PrivateEndpointConnection_GetByHostPool.json new file mode 100644 index 000000000000..a7734e739290 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-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": "2021-05-13-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/2021-05-13-preview/examples/PrivateEndpointConnection_GetByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/PrivateEndpointConnection_GetByWorkspace.json new file mode 100644 index 000000000000..b5a96cde5612 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-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": "2021-05-13-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/2021-05-13-preview/examples/PrivateEndpointConnection_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/PrivateEndpointConnection_ListByHostPool.json new file mode 100644 index 000000000000..2264872aef7b --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/PrivateEndpointConnection_ListByHostPool.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2021-05-13-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/2021-05-13-preview/examples/PrivateEndpointConnection_ListByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/PrivateEndpointConnection_ListByWorkspace.json new file mode 100644 index 000000000000..1124182d808e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/PrivateEndpointConnection_ListByWorkspace.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2021-05-13-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/2021-05-13-preview/examples/PrivateEndpointConnection_UpdateByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/PrivateEndpointConnection_UpdateByHostPool.json new file mode 100644 index 000000000000..350be07eab1c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-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": "2021-05-13-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/2021-05-13-preview/examples/PrivateEndpointConnection_UpdateByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/PrivateEndpointConnection_UpdateByWorkspace.json new file mode 100644 index 000000000000..4b4f728390a6 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-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": "2021-05-13-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/2021-05-13-preview/examples/PrivateLinkResources_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/PrivateLinkResources_ListByHostPool.json new file mode 100644 index 000000000000..8d3d5af0ed08 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/PrivateLinkResources_ListByHostPool.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2021-05-13-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/2021-05-13-preview/examples/PrivateLinkResources_ListByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/PrivateLinkResources_ListByWorkspace.json new file mode 100644 index 000000000000..03a0ce347340 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/PrivateLinkResources_ListByWorkspace.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2021-05-13-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/2021-05-13-preview/examples/ScalingPlan_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ScalingPlan_Create.json new file mode 100644 index 000000000000..01bf01178e2d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ScalingPlan_Create.json @@ -0,0 +1,179 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2021-05-13-preview", + "scalingPlan": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "timeZone": "", + "hostPoolType": "Personal", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": "2020-11-10T06:00:00.000Z", + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": "2020-11-10T08:00:00.000Z", + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": "2020-11-10T18:00:00.000Z", + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": "2020-11-10T20:00:00.000Z", + "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": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "timeZone": "", + "hostPoolType": "Personal", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": "2020-11-10T06:00:00.000+00:00", + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": "2020-11-10T08:00:00.000+00:00", + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": "2020-11-10T18:00:00.000+00:00", + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": "2020-11-10T20:00:00.000+00:00", + "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": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "timeZone": "", + "hostPoolType": "Personal", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": "2020-11-10T06:00:00.000+00:00", + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": "2020-11-10T08:00:00.000+00:00", + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": "2020-11-10T18:00:00.000+00:00", + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": "2020-11-10T20:00:00.000+00:00", + "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/2021-05-13-preview/examples/ScalingPlan_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ScalingPlan_Delete.json new file mode 100644 index 000000000000..65ef70a81d4c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ScalingPlan_Delete.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2021-05-13-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": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "timeZone": "", + "hostPoolType": "Personal", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": "2020-11-10T06:00:00.000+00:00", + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": "2020-11-10T08:00:00.000+00:00", + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": "2020-11-10T18:00:00.000+00:00", + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": "2020-11-10T20:00:00.000+00:00", + "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/2021-05-13-preview/examples/ScalingPlan_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ScalingPlan_Get.json new file mode 100644 index 000000000000..dd89970192b5 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ScalingPlan_Get.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2021-05-13-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": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "timeZone": "", + "hostPoolType": "Personal", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": "2020-11-10T06:00:00.000+00:00", + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": "2020-11-10T08:00:00.000+00:00", + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": "2020-11-10T18:00:00.000+00:00", + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": "2020-11-10T20:00:00.000+00:00", + "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/2021-05-13-preview/examples/ScalingPlan_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ScalingPlan_ListByHostPool.json new file mode 100644 index 000000000000..6999d7731b77 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ScalingPlan_ListByHostPool.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2021-05-13-preview" + }, + "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": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "timeZone": "", + "hostPoolType": "Personal", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": "2020-11-10T06:00:00.000+00:00", + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": "2020-11-10T08:00:00.000+00:00", + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": "2020-11-10T18:00:00.000+00:00", + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": "2020-11-10T20:00:00.000+00:00", + "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/2021-05-13-preview/examples/ScalingPlan_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ScalingPlan_ListByResourceGroup.json new file mode 100644 index 000000000000..8cf67a65d5b5 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ScalingPlan_ListByResourceGroup.json @@ -0,0 +1,132 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2021-05-13-preview" + }, + "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": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "timeZone": "", + "hostPoolType": "Personal", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": "2020-11-10T06:00:00.000+00:00", + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": "2020-11-10T08:00:00.000+00:00", + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": "2020-11-10T18:00:00.000+00:00", + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": "2020-11-10T20:00:00.000+00:00", + "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": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "timeZone": "", + "hostPoolType": "Personal", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": "2020-11-10T06:00:00.000+00:00", + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": "2020-11-10T08:00:00.000+00:00", + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": "2020-11-10T18:00:00.000+00:00", + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": false, + "rampDownStopHostsWhen": "ZeroSessions", + "offPeakStartTime": "2020-11-10T20:00:00.000+00:00", + "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/2021-05-13-preview/examples/ScalingPlan_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ScalingPlan_ListBySubscription.json new file mode 100644 index 000000000000..eb34b9ce0b6b --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ScalingPlan_ListBySubscription.json @@ -0,0 +1,131 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2021-05-13-preview" + }, + "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": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "timeZone": "", + "hostPoolType": "Personal", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": "2020-11-10T06:00:00.000+00:00", + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": "2020-11-10T08:00:00.000+00:00", + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": "2020-11-10T18:00:00.000+00:00", + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": "2020-11-10T20:00:00.000+00:00", + "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": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "timeZone": "", + "hostPoolType": "Personal", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": "2020-11-10T06:00:00.000+00:00", + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": "2020-11-10T08:00:00.000+00:00", + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": "2020-11-10T18:00:00.000+00:00", + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": false, + "rampDownStopHostsWhen": "ZeroActiveSessions", + "offPeakStartTime": "2020-11-10T20:00:00.000+00:00", + "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/2021-05-13-preview/examples/ScalingPlan_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ScalingPlan_Update.json new file mode 100644 index 000000000000..ee4560b41040 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/ScalingPlan_Update.json @@ -0,0 +1,117 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2021-05-13-preview", + "workspace": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "timeZone": "", + "hostPoolType": "Personal", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": "2020-11-10T06:00:00.000Z", + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": "2020-11-10T08:00:00.000Z", + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": "2020-11-10T18:00:00.000Z", + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": "2020-11-10T20:00:00.000Z", + "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": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "timeZone": "", + "hostPoolType": "Personal", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": "2020-11-10T06:00:00.000+00:00", + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": "2020-11-10T08:00:00.000+00:00", + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": "2020-11-10T18:00:00.000+00:00", + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": "2020-11-10T20:00:00.000+00:00", + "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/2021-05-13-preview/examples/SessionHostConfigurations_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/SessionHostConfigurations_Create.json new file mode 100644 index 000000000000..d8a71f4a7a53 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/SessionHostConfigurations_Create.json @@ -0,0 +1,143 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2021-05-13-preview", + "sessionHostConfiguration": { + "properties": { + "vMSizeId": "Standard_D2s_v3", + "diskType": "Standard_LRS", + "vmCustomConfigurationUri": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Gallery", + "marketPlaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "storageBlobUri": "https://storageaccountname.blob.core.windows.net/blobcontainer/image.vhd", + "customId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + }, + "domainInfo": { + "name": "wvdarmtest1.net", + "joinType": "ActiveDirectory", + "mdmProviderGuid": "", + "credentials": { + "localAdmin": { + "userName": "localAdminUserName", + "passwordKeyVaultResourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.KeyVault/vaults/test-kv/secrets", + "passwordSecretName": "localAdminPasswordName" + }, + "domainAdmin": { + "userName": "domainAdminUserName", + "passwordKeyVaultResourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.KeyVault/vaults/test-kv/secrets", + "passwordSecretName": "domainAdminPasswordName" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/updateStatuses/current", + "type": "Microsoft.DesktopVirtualization/hostPools/updateStatuses", + "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": "2008-09-22T14:01:54.9571247Z", + "vMSizeId": "Standard_D2s_v3", + "diskType": "Standard_LRS", + "vmCustomConfigurationUri": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Gallery", + "marketPlaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "storageBlobUri": "https://storageaccountname.blob.core.windows.net/blobcontainer/image.vhd", + "customId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + }, + "domainInfo": { + "name": "wvdarmtest1.net", + "joinType": "ActiveDirectory", + "mdmProviderGuid": "", + "credentials": { + "localAdmin": { + "userName": "localAdminUserName", + "passwordKeyVaultResourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.KeyVault/vaults/test-kv/secrets", + "passwordSecretName": "localAdminPasswordName" + }, + "domainAdmin": { + "userName": "domainAdminUserName", + "passwordKeyVaultResourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.KeyVault/vaults/test-kv/secrets", + "passwordSecretName": "domainAdminPasswordName" + } + } + } + } + } + }, + "201": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/updateStatuses/current", + "type": "Microsoft.DesktopVirtualization/hostPools/updateStatuses", + "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": "2008-09-22T14:01:54.9571247Z", + "vMSizeId": "Standard_D2s_v3", + "diskType": "Standard_LRS", + "vmCustomConfigurationUri": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Gallery", + "marketPlaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "storageBlobUri": "https://storageaccountname.blob.core.windows.net/blobcontainer/image.vhd", + "customId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + }, + "domainInfo": { + "name": "wvdarmtest1.net", + "joinType": "ActiveDirectory", + "mdmProviderGuid": "", + "credentials": { + "localAdmin": { + "userName": "localAdminUserName", + "passwordKeyVaultResourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.KeyVault/vaults/test-kv/secrets", + "passwordSecretName": "localAdminPasswordName" + }, + "domainAdmin": { + "userName": "domainAdminUserName", + "passwordKeyVaultResourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.KeyVault/vaults/test-kv/secrets", + "passwordSecretName": "domainAdminPasswordName" + } + } + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/SessionHostConfigurations_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/SessionHostConfigurations_Delete.json new file mode 100644 index 000000000000..5928e26bc283 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/SessionHostConfigurations_Delete.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2021-05-13-preview" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/updateStatuses/current", + "type": "Microsoft.DesktopVirtualization/hostPools/updateStatuses", + "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": "2008-09-22T14:01:54.9571247Z", + "vMSizeId": "Standard_D2s_v3", + "diskType": "Standard_LRS", + "vmCustomConfigurationUri": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Gallery", + "marketPlaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "storageBlobUri": "https://storageaccountname.blob.core.windows.net/blobcontainer/image.vhd", + "customId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + }, + "domainInfo": { + "name": "wvdarmtest1.net", + "joinType": "ActiveDirectory", + "mdmProviderGuid": "", + "credentials": { + "localAdmin": { + "userName": "localAdminUserName", + "passwordKeyVaultResourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.KeyVault/vaults/test-kv/secrets", + "passwordSecretName": "localAdminPasswordName" + }, + "domainAdmin": { + "userName": "domainAdminUserName", + "passwordKeyVaultResourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.KeyVault/vaults/test-kv/secrets", + "passwordSecretName": "domainAdminPasswordName" + } + } + } + } + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/SessionHostConfigurations_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/SessionHostConfigurations_Get.json new file mode 100644 index 000000000000..a9a0910deb75 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/SessionHostConfigurations_Get.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2021-05-13-preview" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/updateStatuses/current", + "type": "Microsoft.DesktopVirtualization/hostPools/updateStatuses", + "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": "2008-09-22T14:01:54.9571247Z", + "vMSizeId": "Standard_D2s_v3", + "diskType": "Standard_LRS", + "vmCustomConfigurationUri": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Gallery", + "marketPlaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "storageBlobUri": "https://storageaccountname.blob.core.windows.net/blobcontainer/image.vhd", + "customId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + }, + "domainInfo": { + "name": "wvdarmtest1.net", + "joinType": "ActiveDirectory", + "mdmProviderGuid": "", + "credentials": { + "localAdmin": { + "userName": "localAdminUserName", + "passwordKeyVaultResourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.KeyVault/vaults/test-kv/secrets", + "passwordSecretName": "localAdminPasswordName" + }, + "domainAdmin": { + "userName": "domainAdminUserName", + "passwordKeyVaultResourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.KeyVault/vaults/test-kv/secrets", + "passwordSecretName": "domainAdminPasswordName" + } + } + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/SessionHostConfigurations_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/SessionHostConfigurations_ListByHostPool.json new file mode 100644 index 000000000000..bda716ac11be --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/SessionHostConfigurations_ListByHostPool.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2021-05-13-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/updateStatuses/current", + "type": "Microsoft.DesktopVirtualization/hostPools/updateStatuses", + "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": "2008-09-22T14:01:54.9571247Z", + "vMSizeId": "Standard_D2s_v3", + "diskType": "Standard_LRS", + "vmCustomConfigurationUri": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Gallery", + "marketPlaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "storageBlobUri": "https://storageaccountname.blob.core.windows.net/blobcontainer/image.vhd", + "customId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + }, + "domainInfo": { + "name": "wvdarmtest1.net", + "joinType": "ActiveDirectory", + "mdmProviderGuid": "", + "credentials": { + "localAdmin": { + "userName": "localAdminUserName", + "passwordKeyVaultResourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.KeyVault/vaults/test-kv/secrets", + "passwordSecretName": "localAdminPasswordName" + }, + "domainAdmin": { + "userName": "domainAdminUserName", + "passwordKeyVaultResourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.KeyVault/vaults/test-kv/secrets", + "passwordSecretName": "domainAdminPasswordName" + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/SessionHostConfigurations_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/SessionHostConfigurations_Update.json new file mode 100644 index 000000000000..7a9ca501f921 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/SessionHostConfigurations_Update.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2021-05-13-preview", + "sessionHostConfiguration": { + "properties": { + "vMSizeId": "Standard_D2s_v3", + "diskType": "Standard_LRS", + "vmCustomConfigurationUri": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Gallery", + "marketPlaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "storageBlobUri": "https://storageaccountname.blob.core.windows.net/blobcontainer/image.vhd", + "customId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + }, + "domainInfo": { + "name": "wvdarmtest1.net", + "joinType": "ActiveDirectory", + "mdmProviderGuid": "", + "credentials": { + "localAdmin": { + "userName": "localAdminUserName", + "passwordKeyVaultResourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.KeyVault/vaults/test-kv/secrets", + "passwordSecretName": "localAdminPasswordName" + }, + "domainAdmin": { + "userName": "domainAdminUserName", + "passwordKeyVaultResourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.KeyVault/vaults/test-kv/secrets", + "passwordSecretName": "domainAdminPasswordName" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/updateStatuses/current", + "type": "Microsoft.DesktopVirtualization/hostPools/updateStatuses", + "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": "2008-09-22T14:01:54.9571247Z", + "vMSizeId": "Standard_D2s_v3", + "diskType": "Standard_LRS", + "vmCustomConfigurationUri": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Gallery", + "marketPlaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "storageBlobUri": "https://storageaccountname.blob.core.windows.net/blobcontainer/image.vhd", + "customId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + }, + "domainInfo": { + "name": "wvdarmtest1.net", + "joinType": "ActiveDirectory", + "mdmProviderGuid": "", + "credentials": { + "localAdmin": { + "userName": "localAdminUserName", + "passwordKeyVaultResourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.KeyVault/vaults/test-kv/secrets", + "passwordSecretName": "localAdminPasswordName" + }, + "domainAdmin": { + "userName": "domainAdminUserName", + "passwordKeyVaultResourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.KeyVault/vaults/test-kv/secrets", + "passwordSecretName": "domainAdminPasswordName" + } + } + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/SessionHost_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/SessionHost_Delete.json new file mode 100644 index 000000000000..8752e7463645 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/SessionHost_Delete.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2021-05-13-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", + "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" + } + } + ], + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfigurationLastUpdateTime": "2021-01-14T02:09:37.6236843Z", + "imageResourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName", + "imageType": "CustomImage", + "updateStatus": "InProgress" + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/SessionHost_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/SessionHost_Get.json new file mode 100644 index 000000000000..39260a528c62 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/SessionHost_Get.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2021-05-13-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", + "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" + } + } + ], + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfigurationLastUpdateTime": "2021-01-14T02:09:37.6236843Z", + "imageResourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName", + "imageType": "CustomImage", + "updateStatus": "InProgress" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/SessionHost_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/SessionHost_List.json new file mode 100644 index 000000000000..166792aa36ff --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/SessionHost_List.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2021-05-13-preview" + }, + "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", + "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" + } + } + ], + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfigurationLastUpdateTime": "2021-01-14T02:09:37.6236843Z", + "imageResourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName", + "imageType": "CustomImage", + "updateStatus": "InProgress" + } + }, + { + "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", + "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" + } + } + ], + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfigurationLastUpdateTime": "2021-01-14T02:09:37.6236843Z", + "imageResourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName", + "imageType": "CustomImage", + "updateStatus": "InProgress" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/SessionHost_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/SessionHost_Update.json new file mode 100644 index 000000000000..a3aed2b370a5 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-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": "2021-05-13-preview", + "sessionHost": { + "properties": { + "allowNewSession": true, + "assignedUser": "user1@microsoft.com" + } + } + }, + "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", + "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" + } + } + ], + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfigurationLastUpdateTime": "2021-01-14T02:09:37.6236843Z", + "imageResourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName", + "imageType": "CustomImage", + "updateStatus": "InProgress" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/StartMenuItem_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/StartMenuItem_List.json new file mode 100644 index 000000000000..f53837468d53 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/StartMenuItem_List.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2021-05-13-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/2021-05-13-preview/examples/UpdateDetails_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/UpdateDetails_Get.json new file mode 100644 index 000000000000..fbce8e73abf6 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/UpdateDetails_Get.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2021-05-13-preview" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/updateStatuses/current", + "type": "Microsoft.DesktopVirtualization/hostPools/updateStatuses", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "updateStatus": "Scheduled", + "version": "1", + "hostPoolResourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "correlationId": "bbefabc0-95b4-48b3-b645-8a753a63c4fa", + "updateProgress": { + "timeCreated": "2020-10-01T14:01:54.9571247Z", + "timeStarted": "2020-10-01T14:01:54.9571247Z", + "timeFailed": "2020-10-01T14:01:54.9571247Z", + "timeEnded": "2020-10-01T14:01:54.9571247Z", + "errors": [ + { + "faultType": "ServiceError", + "faultCode": "code1", + "faultText": "text1", + "faultContext": "context1" + } + ], + "progressPercentage": 0.1, + "sessionHostsToUpdate": 1, + "sessionHostsUpdating": 1, + "sessionHostsUpdated": 1, + "sessionHostsRollbackFailed": 1 + }, + "hostPoolUpdateConfiguration": { + "saveOriginalDisk": true, + "maxVMsRemovedDuringUpdate": 4, + "maintenanceAlerts": [ + { + "message": "hostpool under maintenance", + "duration": 10, + "beforeKickOff": false + } + ], + "logOffDelaySeconds": 10, + "logOffMessage": "logging off for hostpool update", + "scheduledTime": { + "dateTime": "2008-09-22T14:01:54.9571247Z", + "timeZone": "Alaskan Standard Time" + } + }, + "sessionHostConfiguration": { + "vMSizeId": "Standard_D2s_v3", + "diskType": "Standard_LRS", + "vmCustomConfigurationUri": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Gallery", + "marketPlaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "storageBlobUri": "https://storageaccountname.blob.core.windows.net/blobcontainer/image.vhd", + "customId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + }, + "domainInfo": { + "name": "wvdarmtest1.net", + "joinType": "ActiveDirectory", + "mdmProviderGuid": "", + "credentials": { + "localAdmin": { + "userName": "localAdminUserName", + "passwordKeyVaultResourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.KeyVault/vaults/test-kv/secrets", + "passwordSecretName": "localAdminPasswordName" + }, + "domainAdmin": { + "userName": "domainAdminUserName", + "passwordKeyVaultResourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.KeyVault/vaults/test-kv/secrets", + "passwordSecretName": "domainAdminPasswordName" + } + } + } + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/UpdateDetails_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/UpdateDetails_List.json new file mode 100644 index 000000000000..fdde4d5eaf37 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/UpdateDetails_List.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2021-05-13-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/updateStatuses/current", + "type": "Microsoft.DesktopVirtualization/hostPools/updateStatuses", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "updateStatus": "Scheduled", + "version": "1", + "hostPoolResourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "correlationId": "bbefabc0-95b4-48b3-b645-8a753a63c4fa", + "updateProgress": { + "timeCreated": "2020-10-01T14:01:54.9571247Z", + "timeStarted": "2020-10-01T14:01:54.9571247Z", + "timeFailed": "2020-10-01T14:01:54.9571247Z", + "timeEnded": "2020-10-01T14:01:54.9571247Z", + "errors": [ + { + "faultType": "ServiceError", + "faultCode": "code1", + "faultText": "text1", + "faultContext": "context1" + } + ], + "progressPercentage": 0.1, + "sessionHostsToUpdate": 1, + "sessionHostsUpdating": 1, + "sessionHostsUpdated": 1, + "sessionHostsRollbackFailed": 1 + }, + "hostPoolUpdateConfiguration": { + "saveOriginalDisk": true, + "maxVMsRemovedDuringUpdate": 4, + "maintenanceAlerts": [ + { + "message": "hostpool under maintenance", + "duration": 10, + "beforeKickOff": false + } + ], + "logOffDelaySeconds": 10, + "logOffMessage": "logging off for hostpool update", + "scheduledTime": { + "dateTime": "2008-09-22T14:01:54.9571247Z", + "timeZone": "Alaskan Standard Time" + } + }, + "sessionHostConfiguration": { + "vMSizeId": "Standard_D2s_v3", + "diskType": "Standard_LRS", + "vmCustomConfigurationUri": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Gallery", + "marketPlaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "storageBlobUri": "https://storageaccountname.blob.core.windows.net/blobcontainer/image.vhd", + "customId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + }, + "domainInfo": { + "name": "wvdarmtest1.net", + "joinType": "ActiveDirectory", + "mdmProviderGuid": "", + "credentials": { + "localAdmin": { + "userName": "localAdminUserName", + "passwordKeyVaultResourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.KeyVault/vaults/test-kv/secrets", + "passwordSecretName": "localAdminPasswordName" + }, + "domainAdmin": { + "userName": "domainAdminUserName", + "passwordKeyVaultResourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.KeyVault/vaults/test-kv/secrets", + "passwordSecretName": "domainAdminPasswordName" + } + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/UpdateOperationResults_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/UpdateOperationResults_Get.json new file mode 100644 index 000000000000..25c06a30b37a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/UpdateOperationResults_Get.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2021-05-13-preview" + }, + "responses": { + "200": { + "body": { + "updateStatus": "Scheduled", + "version": "1", + "hostPoolResourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "correlationId": "bbefabc0-95b4-48b3-b645-8a753a63c4fa", + "updateProgress": { + "timeCreated": "2020-10-01T14:01:54.9571247Z", + "timeStarted": "2020-10-01T14:01:54.9571247Z", + "timeFailed": "2020-10-01T14:01:54.9571247Z", + "timeEnded": "2020-10-01T14:01:54.9571247Z", + "errors": [ + { + "faultType": "ServiceError", + "faultCode": "code1", + "faultText": "text1", + "faultContext": "context1" + } + ], + "progressPercentage": 0.1, + "sessionHostsToUpdate": 1, + "sessionHostsUpdating": 1, + "sessionHostsUpdated": 1, + "sessionHostsRollbackFailed": 1 + }, + "hostPoolUpdateConfiguration": { + "saveOriginalDisk": true, + "maxVMsRemovedDuringUpdate": 4, + "maintenanceAlerts": [ + { + "message": "hostpool under maintenance", + "duration": 10, + "beforeKickOff": false + } + ], + "logOffDelaySeconds": 10, + "logOffMessage": "logging off for hostpool update", + "scheduledTime": { + "dateTime": "2008-09-22T14:01:54.9571247Z", + "timeZone": "Alaskan Standard Time" + } + }, + "sessionHostConfiguration": { + "vMSizeId": "Standard_D2s_v3", + "diskType": "Standard_LRS", + "vmCustomConfigurationUri": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Gallery", + "marketPlaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "storageBlobUri": "https://storageaccountname.blob.core.windows.net/blobcontainer/image.vhd", + "customId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + }, + "domainInfo": { + "name": "wvdarmtest1.net", + "joinType": "ActiveDirectory", + "mdmProviderGuid": "", + "credentials": { + "localAdmin": { + "userName": "localAdminUserName", + "passwordKeyVaultResourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.KeyVault/vaults/test-kv/secrets", + "passwordSecretName": "localAdminPasswordName" + }, + "domainAdmin": { + "userName": "domainAdminUserName", + "passwordKeyVaultResourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.KeyVault/vaults/test-kv/secrets", + "passwordSecretName": "domainAdminPasswordName" + } + } + } + } + } + }, + "202": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/UpdateValidationOperationResults_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/UpdateValidationOperationResults_Get.json new file mode 100644 index 000000000000..fe98ff178124 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/UpdateValidationOperationResults_Get.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2021-05-13-preview" + }, + "responses": { + "200": { + "body": { + "warnings": [ + { + "faultType": "ServiceError", + "faultCode": "code1", + "faultText": "text1", + "faultContext": "context1" + } + ], + "errors": [ + { + "faultType": "ServiceError", + "faultCode": "code1", + "faultText": "text1", + "faultContext": "context1" + } + ] + } + }, + "202": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/UserSession_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/UserSession_Delete.json new file mode 100644 index 000000000000..e81fc1f11824 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-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": "2021-05-13-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/2021-05-13-preview/examples/UserSession_Disconnect_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/UserSession_Disconnect_Post.json new file mode 100644 index 000000000000..dfedc07d0993 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-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": "2021-05-13-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/UserSession_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/UserSession_Get.json new file mode 100644 index 000000000000..21d29ab270b7 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-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": "2021-05-13-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/2021-05-13-preview/examples/UserSession_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/UserSession_List.json new file mode 100644 index 000000000000..88dea55e3e18 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/UserSession_List.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2021-05-13-preview" + }, + "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/2021-05-13-preview/examples/UserSession_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/UserSession_ListByHostPool.json new file mode 100644 index 000000000000..0e0df3b105ef --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/UserSession_ListByHostPool.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2021-05-13-preview", + "$filter": "userPrincipalName eq 'user1@microsoft.com' and state eq 'active'" + }, + "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/2021-05-13-preview/examples/UserSession_SendMessage_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/UserSession_SendMessage_Post.json new file mode 100644 index 000000000000..466add3a5c5f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-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": "2021-05-13-preview", + "sendMessage": { + "messageTitle": "title", + "messageBody": "body" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Workspace_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Workspace_Create.json new file mode 100644 index 000000000000..fe25b0089854 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Workspace_Create.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2021-05-13-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, + "publicNetworkAccess": "Enabled" + } + } + }, + "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, + "publicNetworkAccess": "Enabled" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Workspace_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Workspace_Delete.json new file mode 100644 index 000000000000..e2a866d03859 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Workspace_Delete.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2021-05-13-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/2021-05-13-preview/examples/Workspace_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Workspace_Get.json new file mode 100644 index 000000000000..cacbf0445234 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Workspace_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2021-05-13-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, + "publicNetworkAccess": "Enabled" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Workspace_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Workspace_ListByResourceGroup.json new file mode 100644 index 000000000000..79e94113bed6 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Workspace_ListByResourceGroup.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2021-05-13-preview" + }, + "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, + "publicNetworkAccess": "Enabled" + } + }, + { + "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, + "publicNetworkAccess": "Enabled" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Workspace_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Workspace_ListBySubscription.json new file mode 100644 index 000000000000..4dd1da9f2a13 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Workspace_ListBySubscription.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2021-05-13-preview" + }, + "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, + "publicNetworkAccess": "Enabled" + } + }, + { + "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, + "publicNetworkAccess": "Enabled" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Workspace_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Workspace_Update.json new file mode 100644 index 000000000000..ddaa9764d739 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2021-05-13-preview/examples/Workspace_Update.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2021-05-13-preview", + "workspace": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "publicNetworkAccess": "Enabled" + } + } + }, + "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, + "publicNetworkAccess": "Enabled" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/desktopvirtualization.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/desktopvirtualization.json new file mode 100644 index 000000000000..879a5953a9d7 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/desktopvirtualization.json @@ -0,0 +1,4862 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-07-12", + "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/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved operations.", + "schema": { + "$ref": "#/definitions/ResourceProviderOperationList" + } + } + } + } + }, + "/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/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/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/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/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/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/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/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/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": { + "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/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" + } + ], + "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/v1/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/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/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/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/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/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/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/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/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/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" + } + ], + "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}/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/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "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/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/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/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/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/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/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/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/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/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" + }, + { + "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 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/v1/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/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/ApplicationGroupNameParameter" + } + ], + "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/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/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/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/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/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/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/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/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/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/ApplicationGroupNameParameter" + } + ], + "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/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/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/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/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/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/ApplicationGroupNameParameter" + } + ], + "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" + } + } + } + } + }, + "/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/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" + } + ], + "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/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": "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/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": "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/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": "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/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" + } + ], + "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/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "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}/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/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" + } + ], + "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/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": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are userprincipalname and sessionstate." + } + ], + "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/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" + }, + { + "$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/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" + }, + { + "$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/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" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "name": "sessionHost", + "description": "Object containing SessionHost definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SessionHostPatch" + } + } + ], + "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/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" + } + ], + "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}/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/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" + }, + { + "$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/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" + }, + { + "$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/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" + }, + { + "$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/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" + }, + { + "$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/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" + } + ], + "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}/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/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": "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/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/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" + }, + { + "$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/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" + }, + { + "$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/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" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + } + ], + "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/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" + }, + { + "$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/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" + }, + { + "$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": { + "UserSession_SendMessage_Post": { + "$ref": "./examples/ScalingPlan_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" + } + ], + "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" + } + } + } + }, + "definitions": { + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorProperties" + } + } + }, + "CloudErrorProperties": { + "type": "object", + "properties": { + "code": { + "description": "Error code", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + }, + "ResourceProviderOperationList": { + "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." + } + } + }, + "ResourceProviderOperation": { + "description": "Supported operation of this resource provider.", + "readOnly": true, + "properties": { + "name": { + "description": "Operation name, in format of {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "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": { + "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 + } + } + }, + "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" + } + } + } + }, + "ApplicationGroup": { + "type": "object", + "description": "Represents a ApplicationGroup definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ResourceModelWithAllowedPropertySet" + } + ], + "required": [ + "properties" + ], + "properties": { + "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 + }, + "migrationRequest": { + "$ref": "#/definitions/MigrationRequestProperties", + "description": "The registration info of HostPool." + }, + "cloudPcResource": { + "type": "boolean", + "description": "Is cloud pc resource.", + "readOnly": true + } + } + }, + "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." + } + } + }, + "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": { + "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", + "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", + "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." + }, + "applicationGroupReferences": { + "readOnly": true, + "type": "array", + "description": "List of applicationGroup 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." + }, + "migrationRequest": { + "$ref": "#/definitions/MigrationRequestProperties", + "description": "The registration info of HostPool." + }, + "cloudPcResource": { + "type": "boolean", + "description": "Is cloud pc resource.", + "readOnly": true + } + } + }, + "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", + "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", + "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." + } + } + }, + "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." + } + } + }, + "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": { + "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." + } + } + }, + "Application": { + "description": "Schema for Application properties.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "properties": { + "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", + "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", + "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": { + "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", + "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 + } + } + }, + "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": { + "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", + "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." + }, + "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." + }, + "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." + }, + { + "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." + }, + { + "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." + }, + { + "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." + }, + { + "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 ...)." + }, + { + "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." + }, + { + "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." + }, + { + "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." + }, + { + "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." + }, + { + "value": "MetaDataServiceCheck", + "description": "Verifies the metadata service is accessible and return compute properties." + }, + { + "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." + } + ] + }, + "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." + } + } + }, + "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": { + "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.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ResourceModelWithAllowedPropertySet" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for scaling plan.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScalingPlanProperties" + } + } + }, + "ScalingPlanProperties": { + "type": "object", + "description": "Scaling plan properties.", + "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": [ + "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 + }, + "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" + } + } + } + }, + "ScalingSchedule": { + "description": "Scaling plan schedule.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the scaling schedule." + }, + "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": { + "format": "date-time", + "type": "string", + "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": 0, + "maximum": 100, + "description": "Capacity threshold for ramp up period." + }, + "peakStartTime": { + "format": "date-time", + "type": "string", + "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": { + "format": "date-time", + "type": "string", + "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": 0, + "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": { + "format": "date-time", + "type": "string", + "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." + } + } + }, + "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." + }, + "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 + }, + "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" + } + } + } + }, + "MigrationRequestProperties": { + "type": "object", + "description": "Properties for arm migration.", + "properties": { + "operation": { + "enum": [ + "Start", + "Revoke", + "Complete", + "Hide", + "Unhide" + ], + "x-ms-enum": { + "name": "Operation", + "modelAsString": true, + "values": [ + { + "value": "Start", + "description": "Start the migration." + }, + { + "value": "Revoke", + "description": "Revoke the migration." + }, + { + "value": "Complete", + "description": "Complete the migration." + }, + { + "value": "Hide", + "description": "Hide the hostpool." + }, + { + "value": "Unhide", + "description": "Unhide the hostpool." + } + ] + }, + "type": "string", + "description": "The type of operation for migration." + }, + "migrationPath": { + "type": "string", + "description": "The path to the legacy object to migrate." + } + } + } + }, + "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" + }, + "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": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ApplicationGroup_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ApplicationGroup_Create.json new file mode 100644 index 000000000000..1b84e74f0c02 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ApplicationGroup_Create.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2021-07-12", + "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", + "migrationRequest": { + "migrationPath": "TenantGroups/{defaultV1TenantGroup.Name}/Tenants/{defaultV1Tenant.Name}/HostPools/{sessionHostPool.Name}", + "operation": "Start" + } + } + } + }, + "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" + }, + "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, + "migrationRequest": { + "migrationPath": "TenantGroups/{defaultV1TenantGroup.Name}/Tenants/{defaultV1Tenant.Name}/HostPools/{sessionHostPool.Name}", + "operation": "Start" + } + } + } + }, + "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" + }, + "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, + "migrationRequest": { + "migrationPath": "TenantGroups/{defaultV1TenantGroup.Name}/Tenants/{defaultV1Tenant.Name}/HostPools/{sessionHostPool.Name}", + "operation": "Start" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ApplicationGroup_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ApplicationGroup_Delete.json new file mode 100644 index 000000000000..42df1cdc192b --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ApplicationGroup_Delete.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2021-07-12" + }, + "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" + }, + "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 + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ApplicationGroup_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ApplicationGroup_Get.json new file mode 100644 index 000000000000..66ae458a837b --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ApplicationGroup_Get.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2021-07-12" + }, + "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" + }, + "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 + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ApplicationGroup_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ApplicationGroup_ListByResourceGroup.json new file mode 100644 index 000000000000..39c1267a1549 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ApplicationGroup_ListByResourceGroup.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2021-07-12", + "$filter": "applicationGroupType eq 'RailApplication'" + }, + "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" + }, + "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 + } + }, + { + "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" + }, + "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 + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ApplicationGroup_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ApplicationGroup_ListBySubscription.json new file mode 100644 index 000000000000..900dfff66785 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ApplicationGroup_ListBySubscription.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2021-07-12", + "$filter": "applicationGroupType eq 'RailApplication'" + }, + "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" + }, + "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 + } + }, + { + "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" + }, + "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 + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ApplicationGroup_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ApplicationGroup_Update.json new file mode 100644 index 000000000000..b1db05a38ef5 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ApplicationGroup_Update.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2021-07-12", + "applicationGroup": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "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" + }, + "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 + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Application_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Application_Create.json new file mode 100644 index 000000000000..cbe1444743a7 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Application_Create.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2021-07-12", + "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", + "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": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA...", + "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", + "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": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA...", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Application_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Application_Delete.json new file mode 100644 index 000000000000..be90c12f4bd6 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Application_Delete.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2021-07-12" + }, + "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", + "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": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA...", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Application_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Application_Get.json new file mode 100644 index 000000000000..546911bfd7e1 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Application_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2021-07-12" + }, + "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", + "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": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA...", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Application_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Application_List.json new file mode 100644 index 000000000000..2f423dd2ac6a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Application_List.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2021-07-12" + }, + "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", + "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": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA...", + "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", + "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": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA...", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Application_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Application_Update.json new file mode 100644 index 000000000000..b6eb86604867 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Application_Update.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2021-07-12", + "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", + "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": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA...", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Desktop_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Desktop_Get.json new file mode 100644 index 000000000000..ca8bb95f1251 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Desktop_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "desktopName": "SessionDesktop", + "api-version": "2021-07-12" + }, + "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", + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Desktop_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Desktop_List.json new file mode 100644 index 000000000000..e59f89eea8ab --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Desktop_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2021-07-12" + }, + "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", + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Desktop_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Desktop_Update.json new file mode 100644 index 000000000000..72a3b1296c7a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Desktop_Update.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "desktopName": "SessionDesktop", + "api-version": "2021-07-12", + "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", + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/HostPool_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/HostPool_Create.json new file mode 100644 index 000000000000..d50a465db5a5 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/HostPool_Create.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2021-07-12", + "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}", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "migrationRequest": { + "migrationPath": "TenantGroups/{defaultV1TenantGroup.Name}/Tenants/{defaultV1Tenant.Name}/HostPools/{sessionHostPool.Name}", + "operation": "Start" + } + } + } + }, + "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" + }, + "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}", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "migrationRequest": { + "migrationPath": "TenantGroups/{defaultV1TenantGroup.Name}/Tenants/{defaultV1Tenant.Name}/HostPools/{sessionHostPool.Name}", + "operation": "Start" + } + } + } + }, + "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" + }, + "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}", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "migrationRequest": { + "migrationPath": "TenantGroups/{defaultV1TenantGroup.Name}/Tenants/{defaultV1Tenant.Name}/HostPools/{sessionHostPool.Name}", + "operation": "Start" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/HostPool_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/HostPool_Delete.json new file mode 100644 index 000000000000..9fe11f2b5b5b --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/HostPool_Delete.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2021-07-12", + "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" + }, + "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}", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "startVMOnConnect": false, + "cloudPcResource": false + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/HostPool_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/HostPool_Get.json new file mode 100644 index 000000000000..f8cb36a4a384 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/HostPool_Get.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2021-07-12" + }, + "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" + }, + "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}", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false + } + } + }, + "default": { + "body": { + "error": { + "code": "hostPoolDoesNotExist", + "message": "Host Pool Does Not Exist" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/HostPool_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/HostPool_List.json new file mode 100644 index 000000000000..30c4542d859a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/HostPool_List.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2021-07-12" + }, + "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" + }, + "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}", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false + } + }, + { + "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" + }, + "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}", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/HostPool_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/HostPool_ListByResourceGroup.json new file mode 100644 index 000000000000..28647627a32c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/HostPool_ListByResourceGroup.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2021-07-12" + }, + "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" + }, + "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}", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false + } + }, + { + "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" + }, + "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}", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/HostPool_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/HostPool_Update.json new file mode 100644 index 000000000000..152bb06d7ef8 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/HostPool_Update.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2021-07-12", + "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 + } + } + }, + "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" + }, + "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}", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/HostPools_RetrieveRegistrationToken_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/HostPools_RetrieveRegistrationToken_Post.json new file mode 100644 index 000000000000..b8c06c288308 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/HostPools_RetrieveRegistrationToken_Post.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2021-07-12" + }, + "responses": { + "200": { + "body": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/MsixImage_Expand_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/MsixImage_Expand_Post.json new file mode 100644 index 000000000000..6f3a3b1fada1 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/MsixImage_Expand_Post.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2021-07-12", + "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": "RawIcon", + "rawPng": "RawPng" + } + ] + } + }, + { + "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": "RawIcon1", + "rawPng": "RawPng1" + }, + { + "appId": "AppId2", + "description": "PackageApplicationDescription2", + "appUserModelID": "AppUserModelId2", + "friendlyName": "FriendlyName2", + "iconImageName": "Iconimagename2", + "rawIcon": "RawIcon2", + "rawPng": "RawPng2" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/MsixPackage_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/MsixPackage_Create.json new file mode 100644 index 000000000000..6112ff717c18 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/MsixPackage_Create.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2021-07-12", + "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", + "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", + "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/stable/2021-07-12/examples/MsixPackage_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/MsixPackage_Delete.json new file mode 100644 index 000000000000..72eac51c8b46 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/MsixPackage_Delete.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2021-07-12", + "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", + "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/stable/2021-07-12/examples/MsixPackage_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/MsixPackage_Get.json new file mode 100644 index 000000000000..aea63311f7e6 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/MsixPackage_Get.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2021-07-12", + "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", + "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/stable/2021-07-12/examples/MsixPackage_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/MsixPackage_List.json new file mode 100644 index 000000000000..d00afb1e25a0 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/MsixPackage_List.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2021-07-12" + }, + "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", + "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", + "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": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo2", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo2" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/MsixPackage_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/MsixPackage_Update.json new file mode 100644 index 000000000000..c6f3552bdee6 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/MsixPackage_Update.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2021-07-12", + "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", + "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/stable/2021-07-12/examples/OperationDescription_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/OperationDescription_List.json new file mode 100644 index 000000000000..287f40ceb955 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/OperationDescription_List.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2021-07-12" + }, + "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/stable/2021-07-12/examples/ScalingPlan_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ScalingPlan_Create.json new file mode 100644 index 000000000000..ba8de6a53f0f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ScalingPlan_Create.json @@ -0,0 +1,163 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2021-07-12", + "scalingPlan": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "timeZone": "", + "hostPoolType": "Personal", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": "2020-11-10T06:00:00.000Z", + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": "2020-11-10T08:00:00.000Z", + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": "2020-11-10T18:00:00.000Z", + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": "2020-11-10T20:00:00.000Z", + "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" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "timeZone": "", + "hostPoolType": "Personal", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": "2020-11-10T06:00:00.000+00:00", + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": "2020-11-10T08:00:00.000+00:00", + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": "2020-11-10T18:00:00.000+00:00", + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": "2020-11-10T20:00:00.000+00:00", + "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" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "timeZone": "", + "hostPoolType": "Personal", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": "2020-11-10T06:00:00.000+00:00", + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": "2020-11-10T08:00:00.000+00:00", + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": "2020-11-10T18:00:00.000+00:00", + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": "2020-11-10T20:00:00.000+00:00", + "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/stable/2021-07-12/examples/ScalingPlan_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ScalingPlan_Delete.json new file mode 100644 index 000000000000..73a2decccaa6 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ScalingPlan_Delete.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2021-07-12" + }, + "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" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "timeZone": "", + "hostPoolType": "Personal", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": "2020-11-10T06:00:00.000+00:00", + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": "2020-11-10T08:00:00.000+00:00", + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": "2020-11-10T18:00:00.000+00:00", + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": "2020-11-10T20:00:00.000+00:00", + "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/stable/2021-07-12/examples/ScalingPlan_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ScalingPlan_Get.json new file mode 100644 index 000000000000..a8268ea2ecde --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ScalingPlan_Get.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2021-07-12" + }, + "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" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "timeZone": "", + "hostPoolType": "Personal", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": "2020-11-10T06:00:00.000+00:00", + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": "2020-11-10T08:00:00.000+00:00", + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": "2020-11-10T18:00:00.000+00:00", + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": "2020-11-10T20:00:00.000+00:00", + "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/stable/2021-07-12/examples/ScalingPlan_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ScalingPlan_ListByHostPool.json new file mode 100644 index 000000000000..0bd22ea7ea1c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ScalingPlan_ListByHostPool.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2021-07-12" + }, + "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" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "timeZone": "", + "hostPoolType": "Personal", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": "2020-11-10T06:00:00.000+00:00", + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": "2020-11-10T08:00:00.000+00:00", + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": "2020-11-10T18:00:00.000+00:00", + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": "2020-11-10T20:00:00.000+00:00", + "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/stable/2021-07-12/examples/ScalingPlan_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ScalingPlan_ListByResourceGroup.json new file mode 100644 index 000000000000..0ba7ad91153c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ScalingPlan_ListByResourceGroup.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2021-07-12" + }, + "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" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "timeZone": "", + "hostPoolType": "Personal", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": "2020-11-10T06:00:00.000+00:00", + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": "2020-11-10T08:00:00.000+00:00", + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": "2020-11-10T18:00:00.000+00:00", + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": "2020-11-10T20:00:00.000+00:00", + "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" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "timeZone": "", + "hostPoolType": "Personal", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": "2020-11-10T06:00:00.000+00:00", + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": "2020-11-10T08:00:00.000+00:00", + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": "2020-11-10T18:00:00.000+00:00", + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": false, + "rampDownStopHostsWhen": "ZeroSessions", + "offPeakStartTime": "2020-11-10T20:00:00.000+00:00", + "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/stable/2021-07-12/examples/ScalingPlan_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ScalingPlan_ListBySubscription.json new file mode 100644 index 000000000000..78fa89511e46 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ScalingPlan_ListBySubscription.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2021-07-12" + }, + "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" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "timeZone": "", + "hostPoolType": "Personal", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": "2020-11-10T06:00:00.000+00:00", + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": "2020-11-10T08:00:00.000+00:00", + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": "2020-11-10T18:00:00.000+00:00", + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": "2020-11-10T20:00:00.000+00:00", + "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" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "timeZone": "", + "hostPoolType": "Personal", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": "2020-11-10T06:00:00.000+00:00", + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": "2020-11-10T08:00:00.000+00:00", + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": "2020-11-10T18:00:00.000+00:00", + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": false, + "rampDownStopHostsWhen": "ZeroActiveSessions", + "offPeakStartTime": "2020-11-10T20:00:00.000+00:00", + "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/stable/2021-07-12/examples/ScalingPlan_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ScalingPlan_Update.json new file mode 100644 index 000000000000..091fe922b8ba --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/ScalingPlan_Update.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2021-07-12", + "workspace": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "timeZone": "", + "hostPoolType": "Personal", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": "2020-11-10T06:00:00.000Z", + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": "2020-11-10T08:00:00.000Z", + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": "2020-11-10T18:00:00.000Z", + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": "2020-11-10T20:00:00.000Z", + "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" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "timeZone": "", + "hostPoolType": "Personal", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": "2020-11-10T06:00:00.000+00:00", + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": "2020-11-10T08:00:00.000+00:00", + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": "2020-11-10T18:00:00.000+00:00", + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": "2020-11-10T20:00:00.000+00:00", + "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/stable/2021-07-12/examples/SessionHost_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/SessionHost_Delete.json new file mode 100644 index 000000000000..211d3fd2fa3e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/SessionHost_Delete.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2021-07-12", + "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", + "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", + "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/stable/2021-07-12/examples/SessionHost_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/SessionHost_Get.json new file mode 100644 index 000000000000..ff5e2b40b64d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/SessionHost_Get.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2021-07-12" + }, + "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", + "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", + "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/stable/2021-07-12/examples/SessionHost_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/SessionHost_List.json new file mode 100644 index 000000000000..4bcdae0c0a76 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/SessionHost_List.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2021-07-12" + }, + "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", + "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", + "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", + "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", + "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/stable/2021-07-12/examples/SessionHost_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/SessionHost_Update.json new file mode 100644 index 000000000000..27272cfb7903 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/SessionHost_Update.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2021-07-12", + "sessionHost": { + "properties": { + "allowNewSession": true, + "assignedUser": "user1@microsoft.com" + } + } + }, + "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", + "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", + "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/stable/2021-07-12/examples/StartMenuItem_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/StartMenuItem_List.json new file mode 100644 index 000000000000..d231c1cf3b7e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/StartMenuItem_List.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2021-07-12" + }, + "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/stable/2021-07-12/examples/UserSession_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/UserSession_Delete.json new file mode 100644 index 000000000000..50b90033276b --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/UserSession_Delete.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2021-07-12", + "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", + "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/stable/2021-07-12/examples/UserSession_Disconnect_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/UserSession_Disconnect_Post.json new file mode 100644 index 000000000000..3636793548e7 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/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": "2021-07-12" + }, + "responses": { + "200": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/UserSession_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/UserSession_Get.json new file mode 100644 index 000000000000..fb1f24ca3dd8 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/UserSession_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2021-07-12" + }, + "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", + "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/stable/2021-07-12/examples/UserSession_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/UserSession_List.json new file mode 100644 index 000000000000..4d5dea1e252a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/UserSession_List.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2021-07-12" + }, + "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", + "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", + "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/stable/2021-07-12/examples/UserSession_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/UserSession_ListByHostPool.json new file mode 100644 index 000000000000..620f3c7f97c7 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/UserSession_ListByHostPool.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2021-07-12", + "$filter": "userPrincipalName eq 'user1@microsoft.com' and state eq 'active'" + }, + "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", + "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", + "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/stable/2021-07-12/examples/UserSession_SendMessage_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/UserSession_SendMessage_Post.json new file mode 100644 index 000000000000..d994dfbb3b0f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/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": "2021-07-12", + "sendMessage": { + "messageTitle": "title", + "messageBody": "body" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Workspace_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Workspace_Create.json new file mode 100644 index 000000000000..df71c26608bc --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Workspace_Create.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2021-07-12", + "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" + }, + "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" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Workspace_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Workspace_Delete.json new file mode 100644 index 000000000000..106d2b7f4c2d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Workspace_Delete.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2021-07-12" + }, + "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" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Workspace_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Workspace_Get.json new file mode 100644 index 000000000000..866960107667 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Workspace_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2021-07-12" + }, + "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" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Workspace_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Workspace_ListByResourceGroup.json new file mode 100644 index 000000000000..532632ecad18 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Workspace_ListByResourceGroup.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2021-07-12" + }, + "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" + }, + "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" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Workspace_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Workspace_ListBySubscription.json new file mode 100644 index 000000000000..94c36b61e52b --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Workspace_ListBySubscription.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2021-07-12" + }, + "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" + }, + "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" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Workspace_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Workspace_Update.json new file mode 100644 index 000000000000..4e3f2f8626cc --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2021-07-12/examples/Workspace_Update.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2021-07-12", + "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" + }, + "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 61a19b4be4af..7c9fc65953c1 100644 --- a/specification/desktopvirtualization/resource-manager/readme.md +++ b/specification/desktopvirtualization/resource-manager/readme.md @@ -4,10 +4,10 @@ This is the AutoRest configuration file for Desktop Virtualization. - - --- + ## Getting Started + To build the SDK for DesktopVirtualizationClient, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: > `autorest` @@ -15,16 +15,36 @@ To build the SDK for DesktopVirtualizationClient, simply [Install AutoRest](http To see additional help and options, run: > `autorest --help` + --- ## Configuration ### Basic Information + These are the global settings for the DesktopVirtualizationClient API. ``` yaml openapi-type: arm -tag: package-2021-04-01-preview +tag: package-2021-07 +``` + + +### Tag: package-2021-07 + +These settings apply only when `--tag=package-2021-07` is specified on the command line. + +```yaml $(tag) == 'package-2021-07' +input-file: + - Microsoft.DesktopVirtualization/stable/2021-07-12/desktopvirtualization.json +``` +### Tag: package-preview-2021-05 + +These settings apply only when `--tag=package-preview-2021-05` is specified on the command line. + +``` yaml $(tag) == 'package-preview-2021-05' +input-file: + - Microsoft.DesktopVirtualization/preview/2021-05-13-preview/desktopvirtualization.json ``` ### Tag: package-2019-01-23-preview @@ -117,8 +137,8 @@ input-file: ``` --- -# Code Generation +# Code Generation ## Swagger to SDK @@ -169,7 +189,7 @@ See configuration in [readme.node.md](./readme.node.md) See configuration in [readme.ruby.md](./readme.ruby.md) -## Multi-API/Profile support for AutoRest v3 generators +## Multi-API/Profile support for AutoRest v3 generators AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. @@ -195,10 +215,10 @@ input-file: ``` -If there are files that should not be in the `all-api-versions` set, +If there are files that should not be in the `all-api-versions` set, uncomment the `exclude-file` section below and add the file paths. ``` yaml $(tag) == 'all-api-versions' #exclude-file: # - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` \ No newline at end of file +``` diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/iotdps.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/iotdps.json index fe66db3dceb7..b6dd534281d6 100644 --- a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/iotdps.json +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/iotdps.json @@ -1657,6 +1657,10 @@ "certificate": { "description": "Base-64 representation of the X509 leaf certificate .cer file or just .pem file content.", "type": "string" + }, + "isVerified": { + "description": "True indicates that the certificate will be created in verified state and proof of possession will not be required.", + "type": "boolean" } } }, diff --git a/specification/deviceprovisioningservices/resource-manager/readme.md b/specification/deviceprovisioningservices/resource-manager/readme.md index 3ebc9752fc3f..d030b6c04dbd 100644 --- a/specification/deviceprovisioningservices/resource-manager/readme.md +++ b/specification/deviceprovisioningservices/resource-manager/readme.md @@ -95,6 +95,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net + - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/deviceprovisioningservices/resource-manager/readme.python.md b/specification/deviceprovisioningservices/resource-manager/readme.python.md index b2c93d010289..fcad17c97da2 100644 --- a/specification/deviceprovisioningservices/resource-manager/readme.python.md +++ b/specification/deviceprovisioningservices/resource-manager/readme.python.md @@ -4,7 +4,19 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) +``` yaml $(python) && !$(track2) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.iothubprovisioningservices + package-name: azure-mgmt-iothubprovisioningservices + package-version: 0.1.0 + clear-output-folder: true +``` + +``` yaml $(python) && $(track2) python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION @@ -14,12 +26,24 @@ package-version: 1.0.0b1 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' +``` yaml $(python) && $(python-mode) == 'update' && !$(track2) +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/iothub/azure-mgmt-iothubprovisioningservices/azure/mgmt/iothubprovisioningservices +``` + +``` yaml $(python) && $(python-mode) == 'create' && !$(track2) +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/iothub/azure-mgmt-iothubprovisioningservices +``` + +``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/iothub/azure-mgmt-iothubprovisioningservices/azure/mgmt/iothubprovisioningservices ``` -``` yaml $(python) && $(python-mode) == 'create' +``` yaml $(python) && $(python-mode) == 'create' && $(track2) basic-setup-py: true output-folder: $(python-sdks-folder)/iothub/azure-mgmt-iothubprovisioningservices ``` diff --git a/specification/deviceupdate/data-plane/Microsoft.DeviceUpdate/preview/2020-09-01/examples/Devices_CreateOrUpdateGroup.json b/specification/deviceupdate/data-plane/Microsoft.DeviceUpdate/preview/2020-09-01/examples/Devices_CreateOrUpdateGroup.json index 9453cb9ad167..ea886186514f 100644 --- a/specification/deviceupdate/data-plane/Microsoft.DeviceUpdate/preview/2020-09-01/examples/Devices_CreateOrUpdateGroup.json +++ b/specification/deviceupdate/data-plane/Microsoft.DeviceUpdate/preview/2020-09-01/examples/Devices_CreateOrUpdateGroup.json @@ -2,12 +2,12 @@ "parameters": { "accountEndpoint": "contoso.api.adu.microsoft.com", "instanceId": "blue", - "groupId": "group1", + "groupId": "MyGroup", "group": { "groupId": "MyGroup", "groupType": "IoTHubTag", "tags": [ - "MyAduGroup" + "MyGroup" ], "createdDateTime": "2020-07-01T12:13:14.0000000Z" } @@ -18,7 +18,7 @@ "groupId": "MyGroup", "groupType": "IoTHubTag", "tags": [ - "MyAduGroup" + "MyGroup" ], "createdDateTime": "2020-07-01T12:13:14.0000000Z" } diff --git a/specification/deviceupdate/data-plane/readme.md b/specification/deviceupdate/data-plane/readme.md index 1cca118e7d26..73985a42346b 100644 --- a/specification/deviceupdate/data-plane/readme.md +++ b/specification/deviceupdate/data-plane/readme.md @@ -49,7 +49,7 @@ This is not used by Autorest itself. ```yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-js after_scripts: diff --git a/specification/deviceupdate/data-plane/readme.python.md b/specification/deviceupdate/data-plane/readme.python.md index 8d45ee47f464..35906a2b338d 100644 --- a/specification/deviceupdate/data-plane/readme.python.md +++ b/specification/deviceupdate/data-plane/readme.python.md @@ -3,22 +3,23 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. -```yaml - python-mode: create - license-header: MICROSOFT_MIT_NO_VERSION - namespace: azure.iot.deviceupdate - package-name: azure-iot-deviceupdate - package-version: 1.0.0b1 - clear-output-folder: true - add-credentials: true - credential-scopes: https://api.adu.microsoft.com/.default +``` yaml $(track2) +python-mode: create +license-header: MICROSOFT_MIT_NO_VERSION +namespace: azure.iot.deviceupdate +package-name: azure-iot-deviceupdate +package-version: 1.0.0b1 +clear-output-folder: true +add-credentials: true +credential-scopes: https://api.adu.microsoft.com/.default ``` -```yaml $(python-mode) == 'create' +``` yaml $(python-mode) == 'create' && $(track2) +basic-setup-py: true output-folder: $(python-sdks-folder)/deviceupdate/azure-iot-deviceupdate ``` -```yaml $(python-mode) == 'update' +``` yaml $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/deviceupdate/azure-iot-deviceupdate/azure/iot/deviceupdate ``` diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json index 65158a0dfbbb..277b01e35df6 100644 --- a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json +++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json @@ -792,6 +792,10 @@ "items": { "$ref": "#/definitions/IotHubSettings" } + }, + "enableDiagnostics": { + "description": "Enables or Disables the diagnostic logs collection", + "type": "boolean" } } } diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/Instances/Instances_Create.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/Instances/Instances_Create.json index 2f88472e3460..dc732514328b 100644 --- a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/Instances/Instances_Create.json +++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/Instances/Instances_Create.json @@ -14,7 +14,8 @@ "ioTHubConnectionString": "string", "eventHubConnectionString": "string" } - ] + ], + "enableDiagnostics": false } } }, @@ -32,7 +33,8 @@ { "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Devices/IotHubs/blue-contoso-hub" } - ] + ], + "enableDiagnostics": false } } } diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/Instances/Instances_Get.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/Instances/Instances_Get.json index 1f354395ae9e..23b2706d98a3 100644 --- a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/Instances/Instances_Get.json +++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/Instances/Instances_Get.json @@ -20,7 +20,8 @@ { "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Devices/IotHubs/blue-contoso-hub" } - ] + ], + "enableDiagnostics": false } } } diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/Instances/Instances_ListByAccount.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/Instances/Instances_ListByAccount.json index eac2d6134f84..162edb2678ee 100644 --- a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/Instances/Instances_ListByAccount.json +++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/Instances/Instances_ListByAccount.json @@ -22,7 +22,8 @@ { "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Devices/IotHubs/blue-contoso-hub" } - ] + ], + "enableDiagnostics": false } }, { @@ -37,7 +38,8 @@ { "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Devices/IotHubs/red-contoso-hub" } - ] + ], + "enableDiagnostics": false } } ] diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/Instances/Instances_Update.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/Instances/Instances_Update.json index a431fd26a2db..850030cfa1c0 100644 --- a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/Instances/Instances_Update.json +++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2020-03-01-preview/examples/Instances/Instances_Update.json @@ -24,7 +24,8 @@ { "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Devices/IotHubs/blue-contoso-hub" } - ] + ], + "enableDiagnostics": false }, "tags": { "tagKey": "tagValue" diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/stable/2021-03-15/delegatedSubnets.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/stable/2021-03-15/delegatedSubnets.json index 86ffa184ea2f..1eff9dddf478 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/stable/2021-03-15/delegatedSubnets.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/stable/2021-03-15/delegatedSubnets.json @@ -388,6 +388,7 @@ ], "properties": { "properties": { + "x-ms-client-flatten": true, "$ref": "#/definitions/DelegatedSubnetProperties", "description": "Properties of the provision operation request." } diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/stable/2021-03-15/orchestrators.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/stable/2021-03-15/orchestrators.json index a73359d5a957..d31facdd327c 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/stable/2021-03-15/orchestrators.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/stable/2021-03-15/orchestrators.json @@ -154,6 +154,9 @@ }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ForceDeleteParameter" } ], "responses": { @@ -498,6 +501,14 @@ "maxLength": 63, "x-ms-parameter-location": "method", "description": "The name of the resource. It must be a minimum of 3 characters, and a maximum of 63." + }, + "ForceDeleteParameter": { + "name": "forceDelete", + "in": "query", + "required": false, + "type": "boolean", + "description": "Force delete resource", + "x-ms-parameter-location": "method" } } } diff --git a/specification/dnc/resource-manager/readme.az.md b/specification/dnc/resource-manager/readme.az.md new file mode 100644 index 000000000000..7aa076d721d2 --- /dev/null +++ b/specification/dnc/resource-manager/readme.az.md @@ -0,0 +1,15 @@ +## AZ + +These settings apply only when `--az` is specified on the command line. + +``` yaml $(az) && $(target-mode) != 'core' +az: + extensions: dnc + namespace: azure.mgmt.dnc + package-name: azure-mgmt-dnc +az-output-folder: $(azure-cli-extension-folder)/src/dnc +python-sdk-output-folder: "$(az-output-folder)/azext_dnc/vendored_sdks/dnc" +# add additinal configuration here specific for Azure CLI +# refer to the faq.md for more details +extension-mode: preview +``` \ No newline at end of file diff --git a/specification/dnc/resource-manager/readme.cli.md b/specification/dnc/resource-manager/readme.cli.md new file mode 100644 index 000000000000..f3d3e64aaa25 --- /dev/null +++ b/specification/dnc/resource-manager/readme.cli.md @@ -0,0 +1,36 @@ +``` yaml +# add any configuration here for all CLI languages +# refer to the faq.md for more details +cli: + cli-directive: + - where: + group: .* + parameter: privateLinkResourceId + alias: + - priv_link_resource_id + ## hide an operation + - where: + group: .* + op: Patch + hidden: true + - where: + group: .* + op: PatchDetails + hidden: true + - where: + group: .* + op: GetDetails + name: show + - where: + group: .* + op: PutDetails + name: create + - where: + group: .* + op: ListByResourceGroup + hidden: true + - where: + group: .* + op: ListBySubscription + hidden: true +``` \ No newline at end of file diff --git a/specification/dns/resource-manager/readme.md b/specification/dns/resource-manager/readme.md index e34c59181edd..5baf1dc98983 100644 --- a/specification/dns/resource-manager/readme.md +++ b/specification/dns/resource-manager/readme.md @@ -158,9 +158,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-python - after_scripts: - - python ./scripts/multiapi_init_gen.py azure-mgmt-dns - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/dns/resource-manager/readme.python.md b/specification/dns/resource-manager/readme.python.md index 8e1f1387d5fd..5ccf3d1231c3 100644 --- a/specification/dns/resource-manager/readme.python.md +++ b/specification/dns/resource-manager/readme.python.md @@ -2,37 +2,18 @@ These settings apply only when `--python` is specified on the command line. -```yaml $(python) && !$(track2) -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - package-name: azure-mgmt-dns - clear-output-folder: true - no-namespace-folders: true -``` - ```yaml $(python) && $(track2) azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-dns no-namespace-folders: true package-version: 1.0.0b1 -modelerfour: - lenient-model-deduplication: true ``` ### Python multi-api Generate all API versions currently shipped for this package -```yaml $(python) && $(multiapi) && !$(track2) -batch: - - tag: package-2018-05 - - tag: package-2018-03-preview - - tag: package-2016-04 -``` - ```yaml $(python) && $(multiapi) && $(track2) clear-output-folder: true batch: @@ -53,12 +34,6 @@ perform-load: false These settings apply only when `--tag=package-2018-05 --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2018-05' && $(python) && !$(track2) -python: - namespace: azure.mgmt.dns.v2018_05_01 - output-folder: $(python-sdks-folder)/network/azure-mgmt-dns/azure/mgmt/dns/v2018_05_01 -``` - ``` yaml $(tag) == 'package-2018-05' && $(python) && $(track2) namespace: azure.mgmt.dns.v2018_05_01 output-folder: $(python-sdks-folder)/network/azure-mgmt-dns/azure/mgmt/dns/v2018_05_01 @@ -69,12 +44,6 @@ output-folder: $(python-sdks-folder)/network/azure-mgmt-dns/azure/mgmt/dns/v2018 These settings apply only when `--tag=package-2018-03-preview --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2018-03-preview' && $(python) && !$(track2) -python: - namespace: azure.mgmt.dns.v2018_03_01_preview - output-folder: $(python-sdks-folder)/network/azure-mgmt-dns/azure/mgmt/dns/v2018_03_01_preview -``` - ``` yaml $(tag) == 'package-2018-03-preview' && $(python) && $(track2) namespace: azure.mgmt.dns.v2018_03_01_preview output-folder: $(python-sdks-folder)/network/azure-mgmt-dns/azure/mgmt/dns/v2018_03_01_preview @@ -85,13 +54,12 @@ output-folder: $(python-sdks-folder)/network/azure-mgmt-dns/azure/mgmt/dns/v2018 These settings apply only when `--tag=package-2016-04 --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2016-04' && $(python) && !$(track2) -python: - namespace: azure.mgmt.dns.v2016_04_01 - output-folder: $(python-sdks-folder)/network/azure-mgmt-dns/azure/mgmt/dns/v2016_04_01 -``` - ``` yaml $(tag) == 'package-2016-04' && $(python) && $(track2) namespace: azure.mgmt.dns.v2016_04_01 output-folder: $(python-sdks-folder)/network/azure-mgmt-dns/azure/mgmt/dns/v2016_04_01 ``` + +```yaml $(python) && $(track2) +modelerfour: + lenient-model-deduplication: true +``` \ No newline at end of file diff --git a/specification/dns/resource-manager/readme.typescript.md b/specification/dns/resource-manager/readme.typescript.md index 6e56d2e3e9a6..b0300e04f4fa 100644 --- a/specification/dns/resource-manager/readme.typescript.md +++ b/specification/dns/resource-manager/readme.typescript.md @@ -11,7 +11,7 @@ typescript: generate-metadata: true ``` -``` yaml $(typescript) && !$(profile) +``` yaml $(typescript) && !$(profile-content) typescript: package-name: "@azure/arm-dns" output-folder: "$(typescript-sdks-folder)/sdk/dns/arm-dns" @@ -20,9 +20,9 @@ typescript: ### Profile: profile-hybrid-2019-03-01 -These settings apply only when `--profile=profile-hybrid-2019-03-01` is specified on the command line. +These settings apply only when `--profile-content=profile-hybrid-2019-03-01` is specified on the command line. -``` yaml $(profile)=='profile-hybrid-2019-03-01' +``` yaml $(profile-content)=='profile-hybrid-2019-03-01' typescript: package-name: "@azure/arm-dns-profile-2019-03-01-hybrid" output-folder: "$(typescript-sdks-folder)/sdk/dns/arm-dns-profile-2019-03-01-hybrid" @@ -33,9 +33,9 @@ typescript: ### Profile: profile-hybrid-2020-09-01 -These settings apply only when `--profile=profile-hybrid-2020-09-01` is specified on the command line. +These settings apply only when `--profile-content=profile-hybrid-2020-09-01` is specified on the command line. -``` yaml $(profile)=='profile-hybrid-2020-09-01' +``` yaml $(profile-content)=='profile-hybrid-2020-09-01' typescript: package-name: "@azure/arm-dns-profile-2020-09-01-hybrid" output-folder: "$(typescript-sdks-folder)/sdk/dns/arm-dns-profile-2020-09-01-hybrid" @@ -44,4 +44,4 @@ typescript: generate-metadata: true batch: - tag: profile-hybrid-2020-09-01 -``` \ No newline at end of file +``` diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json index 186bee071977..58deea45c710 100644 --- a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "version": "2020-12-01-preview", - "title": "Edge Ordering Service" + "title": "Edge Ordering Service-Customer" }, "host": "management.azure.com", "schemes": [ @@ -20,7 +20,7 @@ "tags": [ "Operations" ], - "description": "This method gets all the operations.", + "description": "This method gets all the operations that are exposed for customer.", "operationId": "ListOperations", "consumes": [ "application/json" @@ -111,7 +111,7 @@ }, "x-ms-examples": { "ListAddressesAtSubscriptionLevel": { - "$ref": "./examples/AddressesGetAtSubscriptionLevel.json" + "$ref": "./examples/ListAddressesAtSubscriptionLevel.json" } } } @@ -403,7 +403,7 @@ }, "x-ms-examples": { "ListOrderItemsAtSubscriptionLevel": { - "$ref": "./examples/OrderItemGetBySubscription.json" + "$ref": "./examples/ListOrderItemsAtSubscriptionLevel.json" } } } @@ -465,7 +465,7 @@ }, "x-ms-examples": { "ListAddressesAtResourceGroupLevel": { - "$ref": "./examples/AddressesGetAtResourceGrouplevel.json" + "$ref": "./examples/ListAddressesAtResourceGroupLevel.json" } } } @@ -513,7 +513,7 @@ }, "x-ms-examples": { "GetAddressByName": { - "$ref": "./examples/AddressGetByName.json" + "$ref": "./examples/GetAddressByName.json" } } }, @@ -572,7 +572,7 @@ "x-ms-long-running-operation": true, "x-ms-examples": { "CreateAddress": { - "$ref": "./examples/AddressCreate.json" + "$ref": "./examples/CreateAddress.json" } } }, @@ -622,7 +622,7 @@ "x-ms-long-running-operation": true, "x-ms-examples": { "DeleteAddressByName": { - "$ref": "./examples/AddressDelete.json" + "$ref": "./examples/DeleteAddressByName.json" } } }, @@ -688,7 +688,7 @@ "x-ms-long-running-operation": true, "x-ms-examples": { "UpdateAddress": { - "$ref": "./examples/AddressPatch.json" + "$ref": "./examples/UpdateAddress.json" } } } @@ -829,6 +829,13 @@ "required": false, "type": "string" }, + { + "name": "$expand", + "in": "query", + "description": "$expand is supported on device details parameter for order item, which provides details on the devices of the product.", + "required": false, + "type": "string" + }, { "name": "$skipToken", "in": "query", @@ -856,7 +863,7 @@ }, "x-ms-examples": { "ListOrderItemsAtResourceGroupLevel": { - "$ref": "./examples/OrderItemGetByRG.json" + "$ref": "./examples/ListOrderItemsAtResourceGroupLevel.json" } } } @@ -886,6 +893,13 @@ }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$expand", + "in": "query", + "description": "$expand is supported on device details parameter for order item, which provides details on the devices of the product.", + "required": false, + "type": "string" } ], "responses": { @@ -904,7 +918,7 @@ }, "x-ms-examples": { "GetOrderItemByName": { - "$ref": "./examples/OrderItemGet.json" + "$ref": "./examples/GetOrderItemByName.json" } } }, @@ -963,7 +977,7 @@ "x-ms-long-running-operation": true, "x-ms-examples": { "CreateOrderItem": { - "$ref": "./examples/OrderItemCreate.json" + "$ref": "./examples/CreateOrderItem.json" } } }, @@ -995,7 +1009,7 @@ ], "responses": { "200": { - "description": "Order Item Deleted" + "description": "Order item Deleted" }, "202": { "description": "Accepted delete request for an order item" @@ -1013,7 +1027,7 @@ "x-ms-long-running-operation": true, "x-ms-examples": { "DeleteOrderItemByName": { - "$ref": "./examples/OrderItemDelete.json" + "$ref": "./examples/DeleteOrderItemByName.json" } } }, @@ -1064,7 +1078,7 @@ "description": "Accepted request for order item update." }, "200": { - "description": "Order item resource object", + "description": "Order item resource object.", "schema": { "$ref": "#/definitions/OrderItemResource" } @@ -1079,7 +1093,7 @@ "x-ms-long-running-operation": true, "x-ms-examples": { "UpdateOrderItem": { - "$ref": "./examples/OrderItemUpdate.json" + "$ref": "./examples/UpdateOrderItem.json" } } } @@ -1136,7 +1150,7 @@ }, "x-ms-examples": { "CancelOrderItem": { - "$ref": "./examples/OrderItemCancel.json" + "$ref": "./examples/CancelOrderItem.json" } } } @@ -1194,26 +1208,15 @@ "x-ms-long-running-operation": true, "x-ms-examples": { "ReturnOrderItem": { - "$ref": "./examples/OrderItemReturn.json" + "$ref": "./examples/ReturnOrderItem.json" } } } } }, "definitions": { - "AdditionalErrorInfo": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "info": { - "type": "object" - } - } - }, "AddressDetails": { - "description": "Address details for an order.", + "description": "Address details for an order item.", "required": [ "forwardAddress" ], @@ -1332,13 +1335,15 @@ "Available", "ComingSoon", "Preview", - "Deprecated" + "Deprecated", + "Signup", + "Unavailable" ], "type": "string", "readOnly": true, "x-ms-enum": { "name": "AvailabilityStage", - "modelAsExtensible": true, + "modelAsString": true, "values": [ { "value": "Available", @@ -1355,6 +1360,14 @@ { "value": "Deprecated", "description": "Product is deprecated." + }, + { + "value": "Signup", + "description": "Product is available only on signup." + }, + { + "value": "Unavailable", + "description": "Product is not available." } ] } @@ -1375,7 +1388,7 @@ "readOnly": true, "x-ms-enum": { "name": "DisabledReason", - "modelAsExtensible": true, + "modelAsString": true, "values": [ { "value": "None", @@ -1454,18 +1467,7 @@ }, "hierarchyInformation": { "$ref": "#/definitions/HierarchyInformation", - "description": "Hierarchy information of the product system.", - "readOnly": true - } - } - }, - "BillingModel": { - "description": "Model to represent the billing cycle", - "type": "object", - "properties": { - "model": { - "description": "String to represent the billing model", - "type": "string", + "description": "Hierarchy information of a product.", "readOnly": true } } @@ -1553,6 +1555,11 @@ "$ref": "#/definitions/Specification" }, "readOnly": true + }, + "dimensions": { + "$ref": "#/definitions/Dimensions", + "description": "Dimensions of the configuration", + "readOnly": true } } }, @@ -1623,6 +1630,7 @@ }, "emailList": { "description": "List of Email-ids to be notified about job progress.", + "uniqueItems": false, "type": "array", "items": { "type": "string" @@ -1668,13 +1676,14 @@ "description": "Represents Metering type (eg one-time or recurrent)", "enum": [ "OneTime", - "Recurring" + "Recurring", + "Adhoc" ], "type": "string", "readOnly": true, "x-ms-enum": { "name": "MeteringType", - "modelAsExtensible": true, + "modelAsString": true, "values": [ { "value": "OneTime", @@ -1683,6 +1692,10 @@ { "value": "Recurring", "description": "Recurring billing." + }, + { + "value": "Adhoc", + "description": "Adhoc billing." } ] } @@ -1707,7 +1720,7 @@ "readOnly": true, "x-ms-enum": { "name": "DescriptionType", - "modelAsExtensible": true, + "modelAsString": true, "values": [ { "value": "Base", @@ -1764,13 +1777,107 @@ "type": "string", "readOnly": true }, - "deviceHistory": { - "description": "Device history", - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - }, + "managementResourceId": { + "description": "Management Resource Id", + "type": "string", + "readOnly": true + } + } + }, + "Dimensions": { + "description": "Dimensions of a configuration.", + "type": "object", + "properties": { + "length": { + "description": "Length of the device.", + "type": "number", + "format": "double", + "readOnly": true + }, + "height": { + "description": "Height of the device.", + "type": "number", + "format": "double", + "readOnly": true + }, + "width": { + "description": "Width of the device.", + "type": "number", + "format": "double", + "readOnly": true + }, + "lengthHeightUnit": { + "description": "Unit for the dimensions of length, height and width.", + "enum": [ + "IN", + "CM" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "LengthHeightUnit", + "modelAsString": true, + "values": [ + { + "value": "IN", + "description": "Inch, applicable for West US." + }, + { + "value": "CM", + "description": "Centimeter." + } + ] + } + }, + "weight": { + "description": "Weight of the device.", + "type": "number", + "format": "double", + "readOnly": true + }, + "depth": { + "description": "Depth of the device.", + "type": "number", + "format": "double", + "readOnly": true + }, + "weightUnit": { + "description": "Unit for the dimensions of weight.", + "enum": [ + "LBS", + "KGS" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "WeightMeasurementUnit", + "modelAsString": true, + "values": [ + { + "value": "LBS", + "description": "Pounds." + }, + { + "value": "KGS", + "description": "Kilograms." + } + ] + } + } + } + }, + "DisplayInfo": { + "description": "Describes product display information", + "type": "object", + "properties": { + "productFamilyDisplayName": { + "description": "Product family display name", + "type": "string", + "readOnly": true + }, + "configurationDisplayName": { + "description": "Configuration display name", + "type": "string", "readOnly": true } } @@ -1788,7 +1895,7 @@ "type": "string", "x-ms-enum": { "name": "DoubleEncryptionStatus", - "modelAsExtensible": true, + "modelAsString": true, "values": [ { "value": "Disabled", @@ -1799,12 +1906,13 @@ "description": "Double encryption is enabled" } ] - } + }, + "default": "Disabled" } } }, "FilterableProperty": { - "description": "Class defining the list of filter values on a filter type as part of configuration request.", + "description": "Different types of filters supported and its values.", "required": [ "type", "supportedValues" @@ -1820,7 +1928,7 @@ "type": "string", "x-ms-enum": { "name": "SupportedFilterTypes", - "modelAsExtensible": true, + "modelAsString": true, "values": [ { "value": "ShipToCountries", @@ -1880,7 +1988,7 @@ "readOnly": true, "x-ms-enum": { "name": "ImageType", - "modelAsExtensible": true, + "modelAsString": true, "values": [ { "value": "MainImage", @@ -1922,7 +2030,7 @@ "readOnly": true, "x-ms-enum": { "name": "LinkType", - "modelAsExtensible": true, + "modelAsString": true, "values": [ { "value": "Generic", @@ -1958,21 +2066,21 @@ } } }, - "ManagementResourceDetails": { - "description": "Management resource details to link device", + "ManagementResourcePreferences": { + "description": "Management resource preference to link device", "type": "object", - "required": [ - "managementResourceArmId" - ], "properties": { - "managementResourceArmId": { - "description": "Management resource ARM ID", + "preferredManagementResourceId": { + "description": "Customer preferred Management resource ARM ID", "type": "string" } } }, "MeterDetails": { "description": "Holds details about billing type and its meter guids", + "required": [ + "billingType" + ], "type": "object", "properties": { "billingType": { @@ -1982,18 +2090,17 @@ "Purchase" ], "type": "string", - "readOnly": true, "x-ms-enum": { "name": "BillingType", - "modelAsExtensible": true, + "modelAsString": true, "values": [ { "value": "Pav2", - "description": "Pav2 billing type." + "description": "PaV2 billing." }, { "value": "Purchase", - "description": "Purchase billing type." + "description": "Purchase billing." } ] } @@ -2014,7 +2121,7 @@ "readOnly": true, "x-ms-enum": { "name": "ChargingType", - "modelAsExtensible": true, + "modelAsString": true, "values": [ { "value": "PerOrder", @@ -2028,7 +2135,7 @@ } } }, - "x-ms-discriminator-value": "billingType" + "discriminator": "billingType" }, "NotificationPreference": { "description": "Notification preference for a job stage.", @@ -2041,41 +2148,21 @@ "stageName": { "description": "Name of the stage.", "enum": [ - "DevicePrepared", "Shipped", - "Delivered", - "PickedUp", - "AtAzureDC", - "DataCopy" + "Delivered" ], "type": "string", "x-ms-enum": { "name": "NotificationStageName", - "modelAsExtensible": true, + "modelAsString": true, "values": [ - { - "value": "DevicePrepared", - "description": "Notification at device prepared stage." - }, { "value": "Shipped", - "description": "Notification at device dispatched stage." + "description": "Notification at order item shipped from microsoft datacenter." }, { "value": "Delivered", - "description": "Notification at device delivered stage." - }, - { - "value": "PickedUp", - "description": "Notification at device picked up from user stage." - }, - { - "value": "AtAzureDC", - "description": "Notification at device received at Azure datacenter stage." - }, - { - "value": "DataCopy", - "description": "Notification at data copy started stage." + "description": "Notification at order item delivered to customer." } ] } @@ -2179,7 +2266,7 @@ "type": "string", "x-ms-enum": { "name": "OrderItemType", - "modelAsExtensible": true, + "modelAsString": true, "values": [ { "value": "Purchase", @@ -2234,7 +2321,7 @@ "readOnly": true }, "cancellationStatus": { - "description": "Describes whether the order is cancellable or not.", + "description": "Describes whether the orderItem is cancellable or not.", "enum": [ "Cancellable", "CancellableWithFee", @@ -2244,7 +2331,7 @@ "readOnly": true, "x-ms-enum": { "name": "OrderItemCancellationEnum", - "modelAsExtensible": true, + "modelAsString": true, "values": [ { "value": "Cancellable", @@ -2271,7 +2358,7 @@ "readOnly": true, "x-ms-enum": { "name": "ActionStatusEnum", - "modelAsExtensible": true, + "modelAsString": true, "values": [ { "value": "Allowed", @@ -2290,7 +2377,7 @@ "readOnly": true }, "returnStatus": { - "description": "Describes whether the order item is returnable or not.", + "description": "Describes whether the orderItem is returnable or not.", "enum": [ "Returnable", "ReturnableWithFee", @@ -2300,7 +2387,7 @@ "readOnly": true, "x-ms-enum": { "name": "OrderItemReturnEnum", - "modelAsExtensible": true, + "modelAsString": true, "values": [ { "value": "Returnable", @@ -2322,10 +2409,6 @@ "description": "parent RP details", "readOnly": true }, - "managementResourceDetails": { - "$ref": "#/definitions/ManagementResourceDetails", - "description": "Management resource details" - }, "error": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorDetail", "description": "Top level error for the job.", @@ -2348,7 +2431,7 @@ }, "addressDetails": { "$ref": "#/definitions/AddressDetails", - "description": "Represents shipping and return address for order" + "description": "Represents shipping and return address for order item" }, "startTime": { "format": "date-time", @@ -2357,7 +2440,7 @@ "readOnly": true }, "orderId": { - "description": "Id of the order to which order items belongs to", + "description": "Id of the order to which order item belongs to", "type": "string" } } @@ -2387,7 +2470,7 @@ } }, "OrderResourceList": { - "description": "List of orders", + "description": "List of orders.", "type": "object", "properties": { "value": { @@ -2406,11 +2489,11 @@ } }, "StageDetails": { - "description": "Resource stage details", + "description": "Resource stage details.", "type": "object", "properties": { "stageStatus": { - "description": "Stage status", + "description": "Stage status.", "enum": [ "None", "InProgress", @@ -2423,7 +2506,7 @@ "readOnly": true, "x-ms-enum": { "name": "StageStatus", - "modelAsExtensible": true, + "modelAsString": true, "values": [ { "value": "None", @@ -2455,80 +2538,25 @@ "stageName": { "description": "Stage name", "enum": [ - "DeviceOrdered", - "DevicePrepared", - "PickedUp", - "AtAzureDC", - "DataCopy", - "Completed", - "CompletedWithErrors", - "Cancelled", - "Aborted", - "CompletedWithWarnings", - "ReadyToDispatchFromAzureDC", - "ReadyToReceiveAtAzureDC", "Placed", "InReview", "Confirmed", - "ReadyForDispatch", + "ReadyToShip", "Shipped", "Delivered", - "InUse" + "InUse", + "ReturnInitiated", + "ReturnPickedUp", + "ReturnedToMicrosoft", + "ReturnCompleted", + "Cancelled" ], "type": "string", "readOnly": true, "x-ms-enum": { "name": "StageName", - "modelAsExtensible": true, + "modelAsString": true, "values": [ - { - "value": "DeviceOrdered", - "description": "An order has been created." - }, - { - "value": "DevicePrepared", - "description": "A device has been prepared for the order." - }, - { - "value": "PickedUp", - "description": "Device has been picked up from user and in transit to Azure datacenter." - }, - { - "value": "AtAzureDC", - "description": "Device has been received at Azure datacenter from the user." - }, - { - "value": "DataCopy", - "description": "Data copy from the device at Azure datacenter." - }, - { - "value": "Completed", - "description": "Order has completed." - }, - { - "value": "CompletedWithErrors", - "description": "Order has completed with errors." - }, - { - "value": "Cancelled", - "description": "Order has been cancelled." - }, - { - "value": "Aborted", - "description": "Order has been aborted." - }, - { - "value": "CompletedWithWarnings", - "description": "Order has completed with warnings." - }, - { - "value": "ReadyToDispatchFromAzureDC", - "description": "Device is ready to be handed to customer from Azure DC." - }, - { - "value": "ReadyToReceiveAtAzureDC", - "description": "Device can be dropped off at Azure DC." - }, { "value": "Placed", "description": "Currently in draft mode and can still be cancelled" @@ -2542,8 +2570,8 @@ "description": "Order is confirmed" }, { - "value": "ReadyForDispatch", - "description": "Order is ready for dispatch" + "value": "ReadyToShip", + "description": "Order is ready to ship" }, { "value": "Shipped", @@ -2556,6 +2584,26 @@ { "value": "InUse", "description": "Order is in use at customer site" + }, + { + "value": "ReturnInitiated", + "description": "Return has been initiated by customer." + }, + { + "value": "ReturnPickedUp", + "description": "Order is in transit from customer to microsoft." + }, + { + "value": "ReturnedToMicrosoft", + "description": "Order has been received back to microsoft." + }, + { + "value": "ReturnCompleted", + "description": "Return has now completed." + }, + { + "value": "Cancelled", + "description": "Order has been cancelled." } ] } @@ -2604,7 +2652,7 @@ "description": "Customer preference." }, "notificationEmailList": { - "description": "Customer preference.", + "description": "Additional notification email list.", "uniqueItems": false, "type": "array", "items": { @@ -2615,6 +2663,9 @@ }, "Pav2MeterDetails": { "description": "Billing type PAV2 meter details", + "required": [ + "billingType" + ], "type": "object", "allOf": [ { @@ -2649,6 +2700,10 @@ "encryptionPreferences": { "$ref": "#/definitions/EncryptionPreferences", "description": "Preferences related to the Encryption." + }, + "managementResourcePreferences": { + "$ref": "#/definitions/ManagementResourcePreferences", + "description": "Preferences related to the Management resource." } } }, @@ -2671,9 +2726,13 @@ ], "type": "object", "properties": { + "displayInfo": { + "$ref": "#/definitions/DisplayInfo", + "description": "Display details of the product" + }, "hierarchyInformation": { "$ref": "#/definitions/HierarchyInformation", - "description": " Hierarchy of the product which uniquely identifies the product" + "description": "Hierarchy of the product which uniquely identifies the product" }, "count": { "format": "int32", @@ -2852,6 +2911,9 @@ }, "PurchaseMeterDetails": { "description": "Billing type Purchase meter details", + "required": [ + "billingType" + ], "type": "object", "allOf": [ { @@ -2973,7 +3035,7 @@ "type": "string", "x-ms-enum": { "name": "AddressType", - "modelAsExtensible": true, + "modelAsString": true, "values": [ { "value": "None", @@ -3089,7 +3151,7 @@ "type": "string", "x-ms-enum": { "name": "TransportShipmentTypes", - "modelAsExtensible": true, + "modelAsString": true, "values": [ { "value": "CustomerManaged", diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/AddressCreate.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/AddressCreate.json deleted file mode 100644 index 65d2dc2eb577..000000000000 --- a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/AddressCreate.json +++ /dev/null @@ -1,80 +0,0 @@ -{ - "parameters": { - "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", - "resourceGroupName": "TestRG", - "addressName": "TestMSAddressName", - "api-version": "2020-12-01-preview", - "User-Agent": [ - "vscode-restclient" - ], - "Referer": [ - "https://localhost/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/addresses/TestMSAddressName?api-version=2020-12-01-preview" - ], - "x-ms-client-tenant-id": [ - " 72f988bf-86f1-41af-91ab-2d7cd011db47" - ], - "Content-Type": [ - "application/json; charset=utf-8" - ], - "Content-Length": [ - "474" - ], - "addressResource": { - "properties": { - "shippingAddress": { - "streetAddress1": "16 TOWNSEND ST", - "streetAddress2": "UNIT 1", - "city": "San Francisco", - "stateOrProvince": "CA", - "country": "US", - "postalCode": "94107", - "companyName": "Microsoft", - "addressType": "None" - }, - "contactDetails": { - "contactName": "Petr Cech", - "phone": "123344334", - "phoneExtension": "", - "emailList": [ - "ssemcr@microsoft.com" - ] - } - }, - "location": "westus" - } - }, - "responses": { - "200": { - "body": { - "properties": { - "shippingAddress": { - "streetAddress1": "16 TOWNSEND ST", - "streetAddress2": "UNIT 1", - "streetAddress3": "", - "city": "San Francisco", - "stateOrProvince": "CA", - "country": "US", - "postalCode": "94107", - "zipExtendedCode": "", - "companyName": "Microsoft", - "addressType": "None" - }, - "contactDetails": { - "contactName": "Petr Cech", - "phone": "123344334", - "phoneExtension": "", - "emailList": [ - "ssemcr@microsoft.com" - ] - } - }, - "location": "westus", - "tags": {}, - "name": "TestMSAddressName", - "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/addresses/TestMSAddressName", - "type": "Microsoft.EdgeOrder/addresses" - } - }, - "202": {} - } -} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/AddressGetByName.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/AddressGetByName.json deleted file mode 100644 index 08cd6cc1d054..000000000000 --- a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/AddressGetByName.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "parameters": { - "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", - "resourceGroupName": "TestRG", - "addressName": "TestMSAddressName", - "api-version": "2020-12-01-preview", - "User-Agent": [ - "vscode-restclient" - ], - "Referer": [ - "https://localhost/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/addresses/TestMSAddressName?api-version=2020-12-01-preview" - ] - }, - "responses": { - "200": { - "body": { - "properties": { - "shippingAddress": { - "streetAddress1": "16 TOWNSEND ST", - "streetAddress2": "UNIT 1", - "streetAddress3": "", - "city": "San Francisco", - "stateOrProvince": "CA", - "country": "US", - "postalCode": "94107", - "zipExtendedCode": "", - "companyName": "Microsoft", - "addressType": "None" - }, - "contactDetails": { - "contactName": "Petr Cech", - "phone": "123344334", - "phoneExtension": "", - "emailList": [ - "ssemcr@microsoft.com" - ] - } - }, - "location": "westus", - "tags": {}, - "name": "TestMSAddressName", - "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/addresses/TestMSAddressName", - "type": "Microsoft.EdgeOrder/addresses" - } - } - } -} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/AddressPatch.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/AddressPatch.json deleted file mode 100644 index 1a80d21622ca..000000000000 --- a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/AddressPatch.json +++ /dev/null @@ -1,87 +0,0 @@ -{ - "parameters": { - "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", - "resourceGroupName": "TestRG", - "addressName": "TestAddressName2", - "api-version": "2020-12-01-preview", - "User-Agent": [ - "vscode-restclient" - ], - "Referer": [ - "https://localhost/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/addresses/TestAddressName2?api-version=2020-12-01-preview" - ], - "Content-Type": [ - "application/json; charset=utf-8" - ], - "Content-Length": [ - "611" - ], - "addressUpdateParameter": { - "properties": { - "shippingAddress": { - "streetAddress1": "16 TOWNSEND STT", - "streetAddress2": "UNIT 1", - "city": "San Francisco", - "stateOrProvince": "CA", - "country": "US", - "postalCode": "94107", - "companyName": "Microsoft", - "addressType": "None" - }, - "contactDetails": { - "contactName": "Petr Cech", - "phone": "123344335", - "phoneExtension": "", - "emailList": [ - "ssemcr@microsoft.com" - ] - } - }, - "tags": { - "Name": "Smile-Updated", - "Work": "Engineering", - "Hobby": "Web Series Added", - "WhatElse": "Web Series Added" - } - } - }, - "responses": { - "200": { - "body": { - "properties": { - "shippingAddress": { - "streetAddress1": "16 TOWNSEND STT", - "streetAddress2": "UNIT 1", - "streetAddress3": "", - "city": "San Francisco", - "stateOrProvince": "CA", - "country": "US", - "postalCode": "94107", - "zipExtendedCode": "", - "companyName": "Microsoft", - "addressType": "None" - }, - "contactDetails": { - "contactName": "Petr Cech", - "phone": "123344335", - "phoneExtension": "", - "emailList": [ - "ssemcr@microsoft.com" - ] - } - }, - "location": "westus", - "tags": { - "name": "Smile-Updated", - "work": "Engineering", - "hobby": "Web Series Added", - "whatElse": "Web Series Added" - }, - "name": "TestAddressName2", - "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/addresses/TestAddressName2", - "type": "Microsoft.EdgeOrder/addresses" - } - }, - "202": {} - } -} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/AddressesGetAtResourceGrouplevel.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/AddressesGetAtResourceGrouplevel.json deleted file mode 100644 index fd6f2625938d..000000000000 --- a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/AddressesGetAtResourceGrouplevel.json +++ /dev/null @@ -1,111 +0,0 @@ -{ - "parameters": { - "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", - "resourceGroupName": "TestRG", - "api-version": "2020-12-01-preview", - "User-Agent": [ - "vscode-restclient" - ], - "Referer": [ - "https://localhost/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/addresses?api-version=2020-12-01-preview" - ] - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "shippingAddress": { - "streetAddress1": "16 TOWNSEND ST", - "streetAddress2": "UNIT 1", - "streetAddress3": "", - "city": "San Francisco", - "stateOrProvince": "CA", - "country": "US", - "postalCode": "94107", - "zipExtendedCode": "", - "companyName": "Microsoft", - "addressType": "None" - }, - "contactDetails": { - "contactName": "Petr Cech", - "phone": "123344334", - "phoneExtension": "", - "emailList": [ - "ssemmail@microsoft.com", - "vishwamdir@microsoft.com" - ] - } - }, - "location": "westus", - "tags": {}, - "name": "TestAddressName0", - "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/addresses/TestAddressName0", - "type": "Microsoft.EdgeOrder/addresses" - }, - { - "properties": { - "shippingAddress": { - "streetAddress1": "16 TOWNSEND ST", - "streetAddress2": "UNIT 1", - "streetAddress3": "", - "city": "San Francisco", - "stateOrProvince": "CA", - "country": "US", - "postalCode": "94107", - "zipExtendedCode": "", - "companyName": "Microsoft", - "addressType": "None" - }, - "contactDetails": { - "contactName": "Petr Cech", - "phone": "123344334", - "phoneExtension": "", - "emailList": [ - "ssemmail@microsoft.com", - "vishwamdir@microsoft.com" - ] - } - }, - "location": "westus", - "tags": {}, - "name": "TestAddressName2", - "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/addresses/TestAddressName2", - "type": "Microsoft.EdgeOrder/addresses" - }, - { - "properties": { - "shippingAddress": { - "streetAddress1": "16 TOWNSEND ST", - "streetAddress2": "UNIT 1", - "streetAddress3": "", - "city": "San Francisco", - "stateOrProvince": "CA", - "country": "US", - "postalCode": "94107", - "zipExtendedCode": "", - "companyName": "Microsoft", - "addressType": "None" - }, - "contactDetails": { - "contactName": "Petr Cech", - "phone": "123344334", - "phoneExtension": "", - "emailList": [ - "ssemmail@microsoft.com", - "vishwamdir@microsoft.com" - ] - } - }, - "location": "westus", - "tags": {}, - "name": "TestMSAddressName", - "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/addresses/TestMSAddressName", - "type": "Microsoft.EdgeOrder/addresses" - } - ] - } - } - } -} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/AddressesGetAtSubscriptionLevel.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/AddressesGetAtSubscriptionLevel.json deleted file mode 100644 index 906cd01988d1..000000000000 --- a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/AddressesGetAtSubscriptionLevel.json +++ /dev/null @@ -1,110 +0,0 @@ -{ - "parameters": { - "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", - "api-version": "2020-12-01-preview", - "User-Agent": [ - "vscode-restclient" - ], - "Referer": [ - "https://localhost/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/providers/Microsoft.EdgeOrder/addresses?api-version=2020-12-01-preview" - ] - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "shippingAddress": { - "streetAddress1": "16 TOWNSEND ST", - "streetAddress2": "UNIT 1", - "streetAddress3": "", - "city": "San Francisco", - "stateOrProvince": "CA", - "country": "US", - "postalCode": "94107", - "zipExtendedCode": "", - "companyName": "Microsoft", - "addressType": "None" - }, - "contactDetails": { - "contactName": "Petr Cech", - "phone": "123344334", - "phoneExtension": "", - "emailList": [ - "ssemmail@microsoft.com", - "vishwamdir@microsoft.com" - ] - } - }, - "location": "westus", - "tags": {}, - "name": "TestAddressName0", - "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/addresses/TestAddressName0", - "type": "Microsoft.EdgeOrder/addresses" - }, - { - "properties": { - "shippingAddress": { - "streetAddress1": "16 TOWNSEND ST", - "streetAddress2": "UNIT 1", - "streetAddress3": "", - "city": "San Francisco", - "stateOrProvince": "CA", - "country": "US", - "postalCode": "94107", - "zipExtendedCode": "", - "companyName": "Microsoft", - "addressType": "None" - }, - "contactDetails": { - "contactName": "Petr Cech", - "phone": "123344334", - "phoneExtension": "", - "emailList": [ - "ssemmail@microsoft.com", - "vishwamdir@microsoft.com" - ] - } - }, - "location": "westus", - "tags": {}, - "name": "TestAddressName2", - "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/addresses/TestAddressName2", - "type": "Microsoft.EdgeOrder/addresses" - }, - { - "properties": { - "shippingAddress": { - "streetAddress1": "16 TOWNSEND ST", - "streetAddress2": "UNIT 1", - "streetAddress3": "", - "city": "San Francisco", - "stateOrProvince": "CA", - "country": "US", - "postalCode": "94107", - "zipExtendedCode": "", - "companyName": "Microsoft", - "addressType": "None" - }, - "contactDetails": { - "contactName": "Petr Cech", - "phone": "123344334", - "phoneExtension": "", - "emailList": [ - "ssemmail@microsoft.com", - "vishwamdir@microsoft.com" - ] - } - }, - "location": "westus", - "tags": {}, - "name": "TestMSAddressName", - "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/addresses/TestMSAddressName", - "type": "Microsoft.EdgeOrder/addresses" - } - ] - } - } - } -} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/CancelOrderItem.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/CancelOrderItem.json new file mode 100644 index 000000000000..c4fbeba689e0 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/CancelOrderItem.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "TestRG", + "orderItemName": "TestOrderItemName1", + "api-version": "2020-12-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://localhost/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName1/cancel?api-version=2020-12-01-preview" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "34" + ], + "cancellationReason": { + "reason": "Order cancelled" + } + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/CreateAddress.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/CreateAddress.json new file mode 100644 index 000000000000..7091395ecc29 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/CreateAddress.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "TestRG", + "addressName": "TestMSAddressName", + "api-version": "2020-12-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://localhost/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/addresses/TestMSAddressName?api-version=2020-12-01-preview" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "492" + ], + "addressResource": { + "properties": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "Petr Cech", + "phone": "1234567890", + "phoneExtension": "", + "emailList": [ + "testemail@microsoft.com" + ] + } + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "Petr Cech", + "phone": "1234567890", + "phoneExtension": "", + "emailList": [ + "testemail@microsoft.com" + ] + } + }, + "location": "westus", + "tags": {}, + "name": "TestMSAddressName", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/addresses/TestMSAddressName", + "type": "Microsoft.EdgeOrder/addresses" + } + }, + "202": {} + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/CreateOrderItem.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/CreateOrderItem.json new file mode 100644 index 000000000000..3e016c585720 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/CreateOrderItem.json @@ -0,0 +1,167 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "TestRG", + "orderItemName": "TestOrderItemName01", + "api-version": "2020-12-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://localhost/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName01?api-version=2020-12-01-preview" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "1358" + ], + "orderItemResource": { + "properties": { + "orderItemDetails": { + "orderItemType": "Purchase", + "productDetails": { + "hierarchyInformation": { + "productFamilyName": "AzureStackEdge", + "productLineName": "AzureStackEdge", + "productName": "AzureStackEdgeGPU", + "configurationName": "AzureStackEdgeGPU" + } + }, + "preferences": { + "transportPreferences": { + "preferredShipmentType": "MicrosoftManaged" + } + } + }, + "addressDetails": { + "forwardAddress": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "zipExtendedCode": "1", + "addressType": "Residential" + }, + "contactDetails": { + "contactName": "164 TOWNSEND ST", + "phone": "3213131190", + "emailList": [ + "ssemmail@microsoft.com", + "vishwamdir@microsoft.com" + ] + } + } + }, + "orderId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/locations/westus/orders/TestOrderItemName01" + }, + "tags": { + "mango": "fruit", + "carrot": "vegetable" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "orderItemDetails": { + "productDetails": { + "displayInfo": { + "productFamilyDisplayName": "Azure Stack Edge", + "configurationDisplayName": "Azure Stack Edge Pro - 1 GPU" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "azurestackedgegpu" + }, + "count": 0 + }, + "orderItemType": "Purchase", + "currentStage": { + "stageStatus": "InProgress", + "stageName": "Placed", + "startTime": "2021-06-07T13:08:14.0368516+05:30" + }, + "orderItemStageHistory": [ + { + "stageStatus": "None", + "stageName": "Placed" + }, + { + "stageStatus": "None", + "stageName": "Confirmed" + }, + { + "stageStatus": "None", + "stageName": "ReadyToShip" + }, + { + "stageStatus": "None", + "stageName": "Shipped" + }, + { + "stageStatus": "None", + "stageName": "Delivered" + }, + { + "stageStatus": "None", + "stageName": "InUse" + } + ], + "preferences": { + "transportPreferences": { + "preferredShipmentType": "MicrosoftManaged" + } + }, + "notificationEmailList": [], + "cancellationStatus": "Cancellable", + "deletionStatus": "NotAllowed", + "returnStatus": "NotReturnable" + }, + "addressDetails": { + "forwardAddress": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "zipExtendedCode": "1", + "companyName": "Microsoft", + "addressType": "Residential" + }, + "contactDetails": { + "contactName": "164 TOWNSEND ST", + "phone": "3213131190", + "emailList": [ + "ssemmail@microsoft.com", + "vishwamdir@microsoft.com" + ] + } + } + }, + "startTime": "2021-06-07T13:08:14.0368516+05:30", + "orderId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/locations/westus/orders/TestOrderItemName01" + }, + "location": "westus", + "tags": { + "mango": "fruit", + "carrot": "vegetable" + }, + "name": "TestOrderItemName01", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName01", + "type": "Microsoft.EdgeOrder/orderItems" + } + }, + "202": {} + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/AddressDelete.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/DeleteAddressByName.json similarity index 100% rename from specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/AddressDelete.json rename to specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/DeleteAddressByName.json diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/OrderItemDelete.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/DeleteOrderItemByName.json similarity index 100% rename from specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/OrderItemDelete.json rename to specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/DeleteOrderItemByName.json diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/GetAddressByName.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/GetAddressByName.json new file mode 100644 index 000000000000..16cb0dde1138 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/GetAddressByName.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "TestRG", + "addressName": "TestMSAddressName", + "api-version": "2020-12-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://localhost/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/addresses/TestMSAddressName?api-version=2020-12-01-preview" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "Petr Cech", + "phone": "1234567890", + "phoneExtension": "", + "emailList": [ + "ssemcr@microsoft.com" + ] + } + }, + "location": "westus", + "tags": {}, + "name": "TestMSAddressName", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/addresses/TestMSAddressName", + "type": "Microsoft.EdgeOrder/addresses" + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/GetOrderByName.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/GetOrderByName.json index 738be350815f..82066cc1e357 100644 --- a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/GetOrderByName.json +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/GetOrderByName.json @@ -20,22 +20,20 @@ "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName901" ], "currentStage": { - "stageStatus": "InProgress", + "stageStatus": "Succeeded", "stageName": "InReview", - "startTime": "0001-01-01T05:30:00+05:30" + "startTime": "2021-06-07T15:30:35.4512229+05:30" }, "orderStageHistory": [ { - "stageStatus": "None", - "stageName": "InReview" + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2021-06-07T15:24:58.7140341+05:30" }, { - "stageStatus": "None", - "stageName": "Placed" - }, - { - "stageStatus": "None", - "stageName": "Confirmed" + "stageStatus": "Succeeded", + "stageName": "InReview", + "startTime": "2021-06-07T15:30:35.4512229+05:30" } ] }, diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/GetOrderItemByName.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/GetOrderItemByName.json new file mode 100644 index 000000000000..85de2d37da04 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/GetOrderItemByName.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "TestRG", + "orderItemName": "TestOrderItemName01", + "api-version": "2020-12-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://localhost/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName01?api-version=2020-12-01-preview" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "orderItemDetails": { + "productDetails": { + "displayInfo": { + "productFamilyDisplayName": "Azure Stack Edge", + "configurationDisplayName": "Azure Stack Edge Pro - 1 GPU" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "azurestackedgegpu" + }, + "count": 0 + }, + "orderItemType": "Purchase", + "currentStage": { + "stageStatus": "InProgress", + "stageName": "Placed", + "startTime": "2021-06-07T13:08:14.0368516+05:30" + }, + "orderItemStageHistory": [ + { + "stageStatus": "None", + "stageName": "Placed" + }, + { + "stageStatus": "None", + "stageName": "Confirmed" + }, + { + "stageStatus": "None", + "stageName": "ReadyToShip" + }, + { + "stageStatus": "None", + "stageName": "Shipped" + }, + { + "stageStatus": "None", + "stageName": "Delivered" + }, + { + "stageStatus": "None", + "stageName": "InUse" + } + ], + "preferences": { + "transportPreferences": { + "preferredShipmentType": "MicrosoftManaged" + } + }, + "notificationEmailList": [], + "cancellationStatus": "Cancellable", + "deletionStatus": "NotAllowed", + "returnStatus": "NotReturnable" + }, + "addressDetails": { + "forwardAddress": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "zipExtendedCode": "1", + "companyName": "Microsoft", + "addressType": "Residential" + }, + "contactDetails": { + "contactName": "164 TOWNSEND ST", + "phone": "3213131190", + "emailList": [ + "ssemmail@microsoft.com", + "vishwamdir@microsoft.com" + ] + } + } + }, + "startTime": "2021-06-07T13:08:14.0368516+05:30", + "orderId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/locations/westus/orders/TestOrderItemName01" + }, + "location": "westus", + "tags": { + "mango": "fruit", + "carrot": "vegetable" + }, + "name": "TestOrderItemName01", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName01", + "type": "Microsoft.EdgeOrder/orderItems" + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListAddressesAtResourceGroupLevel.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListAddressesAtResourceGroupLevel.json new file mode 100644 index 000000000000..cbe1be06b530 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListAddressesAtResourceGroupLevel.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "TestRG", + "api-version": "2020-12-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://localhost/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/addresses?api-version=2020-12-01-preview" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "Petr Cech", + "phone": "1234567890", + "phoneExtension": "", + "emailList": [ + "ssemmail@microsoft.com" + ] + } + }, + "location": "westus", + "tags": {}, + "name": "TestAddressName0", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/addresses/TestAddressName0", + "type": "Microsoft.EdgeOrder/addresses" + }, + { + "properties": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "Petr Cech", + "phone": "1234567890", + "phoneExtension": "", + "emailList": [ + "ssemmail@microsoft.com" + ] + } + }, + "location": "westus", + "tags": {}, + "name": "TestAddressName2", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/addresses/TestAddressName2", + "type": "Microsoft.EdgeOrder/addresses" + }, + { + "properties": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "Petr Cech", + "phone": "1234567890", + "phoneExtension": "", + "emailList": [ + "ssemmail@microsoft.com" + ] + } + }, + "location": "westus", + "tags": {}, + "name": "TestMSAddressName", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/addresses/TestMSAddressName", + "type": "Microsoft.EdgeOrder/addresses" + } + ] + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListAddressesAtSubscriptionLevel.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListAddressesAtSubscriptionLevel.json new file mode 100644 index 000000000000..ac679cf1f5ee --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListAddressesAtSubscriptionLevel.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "api-version": "2020-12-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://localhost/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/providers/Microsoft.EdgeOrder/addresses?api-version=2020-12-01-preview" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "Petr Cech", + "phone": "1234567890", + "phoneExtension": "", + "emailList": [ + "ssemmail@microsoft.com" + ] + } + }, + "location": "westus", + "tags": {}, + "name": "TestAddressName0", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/addresses/TestAddressName0", + "type": "Microsoft.EdgeOrder/addresses" + }, + { + "properties": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "Petr Cech", + "phone": "1234567890", + "phoneExtension": "", + "emailList": [ + "ssemmail@microsoft.com" + ] + } + }, + "location": "westus", + "tags": {}, + "name": "TestAddressName2", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/addresses/TestAddressName2", + "type": "Microsoft.EdgeOrder/addresses" + }, + { + "properties": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "Petr Cech", + "phone": "1234567890", + "phoneExtension": "", + "emailList": [ + "ssemcr@microsoft.com" + ] + } + }, + "location": "westus", + "tags": {}, + "name": "TestMSAddressName", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/addresses/TestMSAddressName", + "type": "Microsoft.EdgeOrder/addresses" + } + ] + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListConfigurations.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListConfigurations.json index c5a992c23441..0c8ee5d37571 100644 --- a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListConfigurations.json +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListConfigurations.json @@ -12,15 +12,15 @@ "application/json; charset=utf-8" ], "Content-Length": [ - "498" + "396" ], "configurationsRequest": { "configurationFilters": [ { "hierarchyInformation": { - "productFamilyName": "azurestackedge", - "productLineName": "azure stack edge_pl", - "productName": "azure stack edge pro - gpu" + "productFamilyName": "AzureStackEdge", + "productLineName": "AzureStackEdge", + "productName": "AzureStackEdgeGPU" }, "filterableProperty": [ { @@ -28,12 +28,6 @@ "supportedValues": [ "US" ] - }, - { - "type": "DoubleEncryptionStatus", - "supportedValues": [ - "Enabled" - ] } ] } @@ -48,50 +42,60 @@ "properties": { "specifications": [ { - "name": "Cores", - "value": "24" + "name": "Usable compute", + "value": "40 vCPU" }, { - "name": "Memory", - "value": "128 GB" + "name": "Usable memory", + "value": "102 GB" }, { - "name": "Storage", - "value": "~8 TB" + "name": "Usable storage", + "value": "4.2 TB" } ], + "dimensions": { + "length": 50.0, + "height": 15.0, + "width": 5.0, + "lengthHeightUnit": "IN", + "weight": 50.0, + "depth": 2.0, + "weightUnit": "LBS" + }, "filterableProperties": [ { "type": "ShipToCountries", "supportedValues": [ "US", - "UK" - ] - }, - { - "type": "DoubleEncryptionStatus", - "supportedValues": [ - "Enabled" + "AR" ] } ], - "displayName": "azurestackedgepro-gpu 1 GPU", + "displayName": "Azure Stack Edge Pro - 1 GPU", "description": { "descriptionType": "Base", - "keywords": [], + "shortDescription": "", + "longDescription": "", + "keywords": [ + "GPU" + ], "attributes": [], "links": [] }, "imageInformation": [], + "costInformation": { + "billingMeterDetails": [] + }, "availabilityInformation": { "availabilityStage": "Available", "disabledReason": "None" }, "hierarchyInformation": { "productFamilyName": "azurestackedge", - "productLineName": "azure stack edge_pl", - "productName": "azure stack edge pro - gpu", - "configurationName": "azurestackedgepro-gpu1 gpu" + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "edgep_base" } } } diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListOperations.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListOperations.json index 8cde9566cb92..eb2a98405b2a 100644 --- a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListOperations.json +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListOperations.json @@ -71,9 +71,9 @@ "name": "Microsoft.EdgeOrder/locations/orders/read", "display": { "provider": "Edge Ordering", - "resource": "ArmApiRes_orders", - "operation": "List or Get ArmApiRes_orders", - "description": "List or get the ArmApiRes_orders" + "resource": "Order", + "operation": "List or Get Order", + "description": "List or get the Order" }, "origin": "user", "isDataAction": false @@ -82,9 +82,9 @@ "name": "Microsoft.EdgeOrder/orders/read", "display": { "provider": "Edge Ordering", - "resource": "ArmApiRes_orders", - "operation": "List or Get ArmApiRes_orders", - "description": "List or get the ArmApiRes_orders" + "resource": "Order", + "operation": "List or Get Order", + "description": "List or get the Order" }, "origin": "user", "isDataAction": false @@ -93,27 +93,31 @@ "name": "Microsoft.EdgeOrder/orderItems/cancel/action", "display": { "provider": "Edge Ordering", - "resource": "ArmApiRes_orderItems" + "resource": "OrderItem", + "operation": "Cancel OrderItem", + "description": "Cancels an OrderItem in progress." }, "origin": "user", - "isDataAction": true + "isDataAction": false }, { "name": "Microsoft.EdgeOrder/orderItems/return/action", "display": { "provider": "Edge Ordering", - "resource": "ArmApiRes_orderItems" + "resource": "OrderItem", + "operation": "Return OrderItem", + "description": "Return an OrderItem." }, "origin": "user", - "isDataAction": true + "isDataAction": false }, { "name": "Microsoft.EdgeOrder/orderItems/read", "display": { "provider": "Edge Ordering", - "resource": "ArmApiRes_orderItems", - "operation": "List or Get ArmApiRes_orderItems", - "description": "List or get the ArmApiRes_orderItems" + "resource": "OrderItem", + "operation": "List or Get OrderItem", + "description": "List or get the OrderItem" }, "origin": "user", "isDataAction": false @@ -122,9 +126,9 @@ "name": "Microsoft.EdgeOrder/orderItems/delete", "display": { "provider": "Edge Ordering", - "resource": "ArmApiRes_orderItems", - "operation": "Delete ArmApiRes_orderItems", - "description": "Delete the ArmApiRes_orderItems" + "resource": "OrderItem", + "operation": "Delete OrderItem", + "description": "Delete the OrderItem" }, "origin": "user", "isDataAction": false @@ -133,9 +137,9 @@ "name": "Microsoft.EdgeOrder/orderItems/write", "display": { "provider": "Edge Ordering", - "resource": "ArmApiRes_orderItems", - "operation": "Create or Update ArmApiRes_orderItems", - "description": "Create or update the ArmApiRes_orderItems" + "resource": "OrderItem", + "operation": "Create or Update OrderItem", + "description": "Create or update the OrderItem" }, "origin": "user", "isDataAction": false @@ -144,28 +148,34 @@ "name": "Microsoft.EdgeOrder/productFamiliesMetadata/action", "display": { "provider": "Edge Ordering", - "resource": "ArmApiRes_Microsoft.EdgeOrder" + "resource": "ArmApiRes_Microsoft.EdgeOrder", + "operation": "List or Get product families metadata", + "description": "This method lists or gets the product families metadata." }, "origin": "user", - "isDataAction": true + "isDataAction": false }, { "name": "Microsoft.EdgeOrder/listProductFamilies/read", "display": { "provider": "Edge Ordering", - "resource": "ArmApiRes_Microsoft.EdgeOrder" + "resource": "ArmApiRes_Microsoft.EdgeOrder", + "operation": "List Product Families", + "description": "This method returns list of product families." }, "origin": "user", - "isDataAction": true + "isDataAction": false }, { "name": "Microsoft.EdgeOrder/listConfigurations/action", "display": { "provider": "Edge Ordering", - "resource": "ArmApiRes_Microsoft.EdgeOrder" + "resource": "ArmApiRes_Microsoft.EdgeOrder", + "operation": "List Product Configurations", + "description": "This method returns list of product configurations." }, "origin": "user", - "isDataAction": true + "isDataAction": false } ] } diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListOrderAtResourceGroupLevel.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListOrderAtResourceGroupLevel.json index 7654a1353a00..8a1964ba7fc7 100644 --- a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListOrderAtResourceGroupLevel.json +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListOrderAtResourceGroupLevel.json @@ -20,22 +20,20 @@ "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName901" ], "currentStage": { - "stageStatus": "InProgress", + "stageStatus": "Succeeded", "stageName": "InReview", - "startTime": "0001-01-01T05:30:00+05:30" + "startTime": "2021-06-07T13:13:35.0789537+05:30" }, "orderStageHistory": [ { - "stageStatus": "None", - "stageName": "InReview" + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2021-06-07T13:08:16.3198555+05:30" }, { - "stageStatus": "None", - "stageName": "Placed" - }, - { - "stageStatus": "None", - "stageName": "Confirmed" + "stageStatus": "Succeeded", + "stageName": "InReview", + "startTime": "2021-06-07T13:13:35.0789537+05:30" } ] }, @@ -49,22 +47,20 @@ "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName01" ], "currentStage": { - "stageStatus": "InProgress", + "stageStatus": "Succeeded", "stageName": "InReview", - "startTime": "0001-01-01T05:30:00+05:30" + "startTime": "2021-06-07T13:19:40.9984759+05:30" }, "orderStageHistory": [ { - "stageStatus": "None", - "stageName": "InReview" - }, - { - "stageStatus": "None", - "stageName": "Placed" + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2021-06-07T13:14:39.9413253+05:30" }, { - "stageStatus": "None", - "stageName": "Confirmed" + "stageStatus": "Succeeded", + "stageName": "InReview", + "startTime": "2021-06-07T13:19:40.9984759+05:30" } ] }, diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListOrderAtSubscriptionLevel.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListOrderAtSubscriptionLevel.json index e9088e13d141..8cae0bc5af33 100644 --- a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListOrderAtSubscriptionLevel.json +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListOrderAtSubscriptionLevel.json @@ -19,22 +19,20 @@ "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName901" ], "currentStage": { - "stageStatus": "InProgress", + "stageStatus": "Succeeded", "stageName": "InReview", - "startTime": "0001-01-01T05:30:00+05:30" + "startTime": "2021-06-07T13:13:35.0789537+05:30" }, "orderStageHistory": [ { - "stageStatus": "None", - "stageName": "InReview" + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2021-06-07T13:08:16.3198555+05:30" }, { - "stageStatus": "None", - "stageName": "Placed" - }, - { - "stageStatus": "None", - "stageName": "Confirmed" + "stageStatus": "Succeeded", + "stageName": "InReview", + "startTime": "2021-06-07T13:13:35.0789537+05:30" } ] }, @@ -48,22 +46,20 @@ "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName01" ], "currentStage": { - "stageStatus": "InProgress", + "stageStatus": "Succeeded", "stageName": "InReview", - "startTime": "0001-01-01T05:30:00+05:30" + "startTime": "2021-06-07T13:19:40.9984759+05:30" }, "orderStageHistory": [ { - "stageStatus": "None", - "stageName": "InReview" - }, - { - "stageStatus": "None", - "stageName": "Placed" + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2021-06-07T13:14:39.9413253+05:30" }, { - "stageStatus": "None", - "stageName": "Confirmed" + "stageStatus": "Succeeded", + "stageName": "InReview", + "startTime": "2021-06-07T13:19:40.9984759+05:30" } ] }, diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListOrderItemsAtResourceGroupLevel.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListOrderItemsAtResourceGroupLevel.json new file mode 100644 index 000000000000..a453c1898744 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListOrderItemsAtResourceGroupLevel.json @@ -0,0 +1,209 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "TestRG", + "api-version": "2020-12-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://localhost/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orderItems?api-version=2020-12-01-preview" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "orderItemDetails": { + "productDetails": { + "displayInfo": { + "productFamilyDisplayName": "Azure Stack Edge", + "configurationDisplayName": "Azure Stack Edge Pro - 1 GPU" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "azurestackedgegpu" + }, + "count": 0 + }, + "orderItemType": "Purchase", + "currentStage": { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2021-06-07T12:29:33.9791927+05:30" + }, + "orderItemStageHistory": [ + { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2021-06-07T12:29:33.9791927+05:30" + }, + { + "stageStatus": "None", + "stageName": "Confirmed" + }, + { + "stageStatus": "None", + "stageName": "ReadyToShip" + }, + { + "stageStatus": "None", + "stageName": "Shipped" + }, + { + "stageStatus": "None", + "stageName": "Delivered" + }, + { + "stageStatus": "None", + "stageName": "InUse" + } + ], + "preferences": { + "transportPreferences": { + "preferredShipmentType": "MicrosoftManaged" + } + }, + "notificationEmailList": [], + "cancellationStatus": "Cancellable", + "deletionStatus": "NotAllowed", + "returnStatus": "NotReturnable" + }, + "addressDetails": { + "forwardAddress": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "zipExtendedCode": "1", + "companyName": "Microsoft", + "addressType": "Residential" + }, + "contactDetails": { + "contactName": "164 TOWNSEND ST", + "phone": "3213131190", + "emailList": [ + "ssemmail@microsoft.com", + "vishwamdir@microsoft.com" + ] + } + } + }, + "startTime": "2021-06-07T12:29:25.6656282+05:30", + "orderId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/locations/westus/orders/TestOrderItemName901" + }, + "location": "westus", + "tags": { + "mango": "fruit", + "carrot": "vegetable" + }, + "name": "TestOrderItemName901", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName901", + "type": "Microsoft.EdgeOrder/orderItems" + }, + { + "properties": { + "orderItemDetails": { + "productDetails": { + "displayInfo": { + "productFamilyDisplayName": "Azure Stack Edge", + "configurationDisplayName": "Azure Stack Edge Pro - 1 GPU" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "azurestackedgegpu" + }, + "count": 0 + }, + "orderItemType": "Purchase", + "currentStage": { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2021-06-07T12:49:48.8869361+05:30" + }, + "orderItemStageHistory": [ + { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2021-06-07T12:31:07.7430555+05:30" + }, + { + "stageStatus": "None", + "stageName": "Confirmed" + }, + { + "stageStatus": "None", + "stageName": "ReadyToShip" + }, + { + "stageStatus": "None", + "stageName": "Shipped" + }, + { + "stageStatus": "None", + "stageName": "Delivered" + }, + { + "stageStatus": "None", + "stageName": "InUse" + } + ], + "preferences": { + "transportPreferences": { + "preferredShipmentType": "MicrosoftManaged" + } + }, + "notificationEmailList": [], + "cancellationStatus": "Cancellable", + "deletionStatus": "NotAllowed", + "returnStatus": "NotReturnable" + }, + "addressDetails": { + "forwardAddress": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "zipExtendedCode": "1", + "companyName": "Microsoft", + "addressType": "Residential" + }, + "contactDetails": { + "contactName": "164 TOWNSEND ST", + "phone": "32131311", + "emailList": [ + "ssemmail@microsoft.com", + "vishwamdir@microsoft.com" + ] + } + } + }, + "startTime": "2021-06-07T12:31:06.1244193+05:30", + "orderId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/locations/westus/orders/TestOrderItemName01" + }, + "location": "westus", + "tags": { + "mango": "fruit", + "carrot": "vegetable" + }, + "name": "TestOrderItemName01", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName01", + "type": "Microsoft.EdgeOrder/orderItems" + } + ] + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListOrderItemsAtSubscriptionLevel.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListOrderItemsAtSubscriptionLevel.json new file mode 100644 index 000000000000..744cc6c30d9f --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListOrderItemsAtSubscriptionLevel.json @@ -0,0 +1,207 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "api-version": "2020-12-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://localhost/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/providers/Microsoft.EdgeOrder/orderItems?api-version=2020-12-01-preview" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "orderItemDetails": { + "productDetails": { + "displayInfo": { + "productFamilyDisplayName": "Azure Stack Edge", + "configurationDisplayName": "Azure Stack Edge Pro - 1 GPU" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "azurestackedgegpu" + }, + "count": 0 + }, + "orderItemType": "Purchase", + "currentStage": { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2021-06-07T12:29:33.9791927+05:30" + }, + "orderItemStageHistory": [ + { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2021-06-07T12:29:33.9791927+05:30" + }, + { + "stageStatus": "None", + "stageName": "Confirmed" + }, + { + "stageStatus": "None", + "stageName": "ReadyToShip" + }, + { + "stageStatus": "None", + "stageName": "Shipped" + }, + { + "stageStatus": "None", + "stageName": "Delivered" + }, + { + "stageStatus": "None", + "stageName": "InUse" + } + ], + "preferences": { + "transportPreferences": { + "preferredShipmentType": "MicrosoftManaged" + } + }, + "notificationEmailList": [], + "cancellationStatus": "Cancellable", + "deletionStatus": "NotAllowed", + "returnStatus": "NotReturnable" + }, + "addressDetails": { + "forwardAddress": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "zipExtendedCode": "1", + "companyName": "Microsoft", + "addressType": "Residential" + }, + "contactDetails": { + "contactName": "164 TOWNSEND ST", + "phone": "3213131190", + "emailList": [ + "testemail@microsoft.com" + ] + } + } + }, + "startTime": "2021-06-07T12:29:25.6656282+05:30", + "orderId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/locations/westus/orders/TestOrderItemName901" + }, + "location": "westus", + "tags": { + "mango": "fruit", + "carrot": "vegetable" + }, + "name": "TestOrderItemName901", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName901", + "type": "Microsoft.EdgeOrder/orderItems" + }, + { + "properties": { + "orderItemDetails": { + "productDetails": { + "displayInfo": { + "productFamilyDisplayName": "Azure Stack Edge", + "configurationDisplayName": "Azure Stack Edge Pro - 1 GPU" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "azurestackedgegpu" + }, + "count": 0 + }, + "orderItemType": "Purchase", + "currentStage": { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2021-06-07T12:49:48.8869361+05:30" + }, + "orderItemStageHistory": [ + { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2021-06-07T12:31:07.7430555+05:30" + }, + { + "stageStatus": "None", + "stageName": "Confirmed" + }, + { + "stageStatus": "None", + "stageName": "ReadyToShip" + }, + { + "stageStatus": "None", + "stageName": "Shipped" + }, + { + "stageStatus": "None", + "stageName": "Delivered" + }, + { + "stageStatus": "None", + "stageName": "InUse" + } + ], + "preferences": { + "transportPreferences": { + "preferredShipmentType": "MicrosoftManaged" + } + }, + "notificationEmailList": [], + "cancellationStatus": "Cancellable", + "deletionStatus": "NotAllowed", + "returnStatus": "NotReturnable" + }, + "addressDetails": { + "forwardAddress": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "zipExtendedCode": "1", + "companyName": "Microsoft", + "addressType": "Residential" + }, + "contactDetails": { + "contactName": "164 TOWNSEND ST", + "phone": "32131311", + "emailList": [ + "ssemmail@microsoft.com", + "vishwamdir@microsoft.com" + ] + } + } + }, + "startTime": "2021-06-07T12:31:06.1244193+05:30", + "orderId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/locations/westus/orders/TestOrderItemName01" + }, + "location": "westus", + "tags": { + "mango": "fruit", + "carrot": "vegetable" + }, + "name": "TestOrderItemName01", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName01", + "type": "Microsoft.EdgeOrder/orderItems" + } + ] + } + } + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListProductFamilies.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListProductFamilies.json index 38b2fd23a071..93dc08d1792e 100644 --- a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListProductFamilies.json +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListProductFamilies.json @@ -12,7 +12,7 @@ "application/json; charset=utf-8" ], "Content-Length": [ - "174" + "181" ], "productFamiliesRequest": { "filterableProperties": { @@ -20,8 +20,7 @@ { "type": "ShipToCountries", "supportedValues": [ - "US", - "UK" + "US" ] } ] @@ -45,50 +44,59 @@ "properties": { "specifications": [ { - "name": "Cores", - "value": "24" + "name": "Usable compute", + "value": "40 vCPU" }, { - "name": "Memory", - "value": "128 GB" + "name": "Usable memory", + "value": "102 GB" }, { - "name": "Storage", - "value": "~8 TB" + "name": "Usable storage", + "value": "4.2 TB" } ], + "dimensions": { + "length": 50.0, + "height": 15.0, + "width": 5.0, + "lengthHeightUnit": "IN", + "weight": 50.0, + "depth": 2.0, + "weightUnit": "LBS" + }, "filterableProperties": [ { "type": "ShipToCountries", "supportedValues": [ - "US", - "UK" - ] - }, - { - "type": "DoubleEncryptionStatus", - "supportedValues": [ - "Disabled" + "US" ] } ], - "displayName": "Azure Stack Edge Pro - R 3 GPU", + "displayName": "Azure Stack Edge Pro - 1 GPU", "description": { "descriptionType": "Base", - "keywords": [], + "shortDescription": "", + "longDescription": "", + "keywords": [ + "GPU" + ], "attributes": [], "links": [] }, "imageInformation": [], + "costInformation": { + "billingMeterDetails": [] + }, "availabilityInformation": { "availabilityStage": "Available", "disabledReason": "None" }, "hierarchyInformation": { "productFamilyName": "azurestackedge", - "productLineName": "azure stack edge_pl", - "productName": "azure stack edge pro - r", - "configurationName": "azure stack edge pro - r 3 gpu" + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "edgep_base" } } } @@ -97,69 +105,51 @@ { "type": "ShipToCountries", "supportedValues": [ - "US", - "UK" - ] - }, - { - "type": "DoubleEncryptionStatus", - "supportedValues": [ - "Enabled" + "US" ] } ], - "displayName": "Azure Stack Edge Pro - R", + "displayName": "Azure Stack Edge Pro - GPU", "description": { "descriptionType": "Base", - "shortDescription": "Rugged physical edge compute device", - "longDescription": "Azure Stack Edge is an AI-enabled edge computing device with network data transfer capabilities. The device is powered with Intel Aria to provide accelerated AI inferencing at the edge. You can choose from the available configurations with one or two FPGAs basis your business need", + "shortDescription": "Azure managed physical edge compute device", + "longDescription": "Azure Stack Edge is an AI-enabled edge computing device with network data transfer capabilities. The device is powered with NVIDIA T4 GPUs to provide accelerated AI inferencing at the edge. You can choose from the available configurations with one or two GPUs basis your business need", "keywords": [ - "Edge", - "FPGA" + "GPU" ], "attributes": [ - "1U device shipped by Microsoft", - "Hardware accelerated ML using Intel ARIA FPGA" + "1U rack mount device with network data transfer capabilities", + "Hardware accelerated ML using Nvidia T4 GPU", + "Azure Private Edge Zones enabled" ], "links": [ + { + "linkType": "Specification", + "linkUrl": "https://aka.ms/ase-gpu-devicespecs" + }, + { + "linkType": "Generic", + "linkUrl": "https://aka.ms/ase-gpu-billing" + }, { "linkType": "TermsAndConditions", - "linkUrl": "https://aka.mx/tc" + "linkUrl": "https://aka.ms/ase-gpu-product-terms" }, { "linkType": "KnowMore", - "linkUrl": "https://aka.mx/knowmore" + "linkUrl": "https://aka.ms/ase-documentation" } ] }, - "imageInformation": [ - { - "imageType": "MainImage", - "imageUrl": "https://xyz.com" - }, - { - "imageType": "BulletImage", - "imageUrl": "https://abc.com" - }, - { - "imageType": "GenericImage", - "imageUrl": "https://xyz.com/1" - }, - { - "imageType": "GenericImage", - "imageUrl": "https://abc.com/1" - } - ], - "costInformation": {}, + "imageInformation": [], "availabilityInformation": { - "availabilityStage": "ComingSoon", - "disabledReason": "NotAvailable", - "disabledReasonMessage": "Device is not available yet" + "availabilityStage": "Available", + "disabledReason": "None" }, "hierarchyInformation": { "productFamilyName": "azurestackedge", - "productLineName": "azure stack edge_pl", - "productName": "azure stack edge pro - r", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", "configurationName": "" } } @@ -169,18 +159,11 @@ { "type": "ShipToCountries", "supportedValues": [ - "US", - "UK" - ] - }, - { - "type": "DoubleEncryptionStatus", - "supportedValues": [ - "Enabled" + "US" ] } ], - "displayName": "Azure Stack Edge_Pl", + "displayName": "Azure Stack Edge", "description": { "descriptionType": "Base", "keywords": [], @@ -194,28 +177,13 @@ }, "hierarchyInformation": { "productFamilyName": "azurestackedge", - "productLineName": "azure stack edge_pl", + "productLineName": "azurestackedge", "productName": "", "configurationName": "" } } } ], - "filterableProperties": [ - { - "type": "ShipToCountries", - "supportedValues": [ - "US", - "UK" - ] - }, - { - "type": "DoubleEncryptionStatus", - "supportedValues": [ - "Enabled" - ] - } - ], "displayName": "Azure Stack Edge", "description": { "descriptionType": "Base", diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListProductFamiliesMetadata.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListProductFamiliesMetadata.json index 67240b8f6d75..5aadcaf2d601 100644 --- a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListProductFamiliesMetadata.json +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ListProductFamiliesMetadata.json @@ -15,6 +15,21 @@ "value": [ { "properties": { + "productLines": [], + "filterableProperties": [ + { + "type": "ShipToCountries", + "supportedValues": [ + "US" + ] + }, + { + "type": "DoubleEncryptionStatus", + "supportedValues": [ + "Enabled" + ] + } + ], "displayName": "Azure Stack Edge", "description": { "descriptionType": "Base", @@ -23,20 +38,16 @@ "links": [] }, "imageInformation": [], - "costInformation": {}, "availabilityInformation": { "availabilityStage": "Available", "disabledReason": "None" }, - "filterableProperties": [ - { - "type": "ShipToCountries", - "supportedValues": [ - "US", - "UK" - ] - } - ] + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "", + "productName": "", + "configurationName": "" + } } } ] diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/OrderItemCancel.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/OrderItemCancel.json deleted file mode 100644 index 4776fefb2196..000000000000 --- a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/OrderItemCancel.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "parameters": { - "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", - "resourceGroupName": "TestRG", - "orderItemName": "TestOrderName1", - "api-version": "2020-12-01-preview", - "User-Agent": [ - "vscode-restclient" - ], - "Referer": [ - "https://localhost/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orders/TestOrderName1/cancel?api-version=2020-12-01-preview" - ], - "Content-Type": [ - "application/json; charset=utf-8" - ], - "Content-Length": [ - "34" - ], - "cancellationReason": { - "reason": "Order cancelled" - } - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/OrderItemCreate.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/OrderItemCreate.json deleted file mode 100644 index 745a4512e6de..000000000000 --- a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/OrderItemCreate.json +++ /dev/null @@ -1,156 +0,0 @@ -{ - "parameters": { - "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", - "resourceGroupName": "TestRG", - "orderItemName": "TestOrderItemName01", - "api-version": "2020-12-01-preview", - "User-Agent": [ - "vscode-restclient" - ], - "Referer": [ - "https://localhost/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName01?api-version=2020-12-01-preview" - ], - "Content-Type": [ - "application/json; charset=utf-8" - ], - "Content-Length": [ - "1388" - ], - "orderItemResource": { - "properties": { - "orderItemDetails": { - "orderItemType": "Purchase", - "productDetails": { - "hierarchyInformation": { - "productFamilyName": "azurestackedge", - "productLineName": "Azure Stack Edge_Pl", - "productName": "Azure Stack Edge Pro - FPGA", - "configurationName": "Azure Stack Edge Pro - FPGA 1 GPU" - } - }, - "preferences": { - "transportPreferences": { - "preferredShipmentType": "MicrosoftManaged" - } - } - }, - "addressDetails": { - "forwardAddress": { - "shippingAddress": { - "streetAddress1": "16 townsend st", - "streetAddress2": "unit 1", - "city": "san francisco", - "stateOrProvince": "ca", - "country": "us", - "postalCode": "94107", - "companyName": "microsoft", - "zipExtendedCode": "1", - "addressType": "Residential" - }, - "contactDetails": { - "contactName": "164 TOWNSEND ST", - "phone": "32131311", - "emailList": [ - "ssemmail@microsoft.com", - "vishwamdir@microsoft.com" - ] - } - } - }, - "orderId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/locations/westus/orders/TestOrderItemName01" - }, - "tags": { - "mango": "fruit", - "carrot": "vegetable" - }, - "location": "westus" - } - }, - "responses": { - "200": { - "body": { - "properties": { - "orderItemDetails": { - "productDetails": { - "hierarchyInformation": { - "productFamilyName": "azurestackedge", - "productLineName": "azure stack edge_pl", - "productName": "azure stack edge pro - fpga", - "configurationName": "azure stack edge pro - fpga 1 gpu" - }, - "count": 0, - "deviceDetails": [] - }, - "orderItemType": "Purchase", - "currentStage": { - "stageStatus": "InProgress", - "stageName": "InReview", - "startTime": "2021-03-24T15:17:13.1376775+05:30" - }, - "orderItemStageHistory": [ - { - "stageStatus": "None", - "stageName": "InReview" - }, - { - "stageStatus": "None", - "stageName": "Placed" - }, - { - "stageStatus": "None", - "stageName": "Confirmed" - }, - { - "stageStatus": "None", - "stageName": "ReadyForDispatch" - } - ], - "preferences": { - "transportPreferences": { - "preferredShipmentType": "MicrosoftManaged" - } - }, - "notificationEmailList": [], - "cancellationStatus": "Cancellable", - "deletionStatus": "Allowed", - "returnStatus": "Returnable" - }, - "addressDetails": { - "forwardAddress": { - "shippingAddress": { - "streetAddress1": "16 TOWNSEND ST", - "streetAddress2": "UNIT 1", - "city": "San Francisco", - "stateOrProvince": "CA", - "country": "US", - "postalCode": "94107", - "zipExtendedCode": "1", - "companyName": "Microsoft", - "addressType": "Residential" - }, - "contactDetails": { - "contactName": "164 TOWNSEND ST", - "phone": "32131311", - "emailList": [ - "ssemmail@microsoft.com", - "vishwamdir@microsoft.com" - ] - } - } - }, - "startTime": "2021-03-24T15:17:13.1376775+05:30", - "orderId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/locations/westus/orders/TestOrderItemName01" - }, - "location": "westus", - "tags": { - "mango": "fruit", - "carrot": "vegetable" - }, - "name": "TestOrderItemName01", - "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName01", - "type": "Microsoft.EdgeOrder/orderItems" - } - }, - "202": {} - } -} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/OrderItemGet.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/OrderItemGet.json deleted file mode 100644 index 9257bae6e814..000000000000 --- a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/OrderItemGet.json +++ /dev/null @@ -1,100 +0,0 @@ -{ - "parameters": { - "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", - "resourceGroupName": "TestRG", - "orderItemName": "TestOrderItemName01", - "api-version": "2020-12-01-preview", - "User-Agent": [ - "vscode-restclient" - ], - "Referer": [ - "https://localhost/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName01?api-version=2020-12-01-preview" - ] - }, - "responses": { - "200": { - "body": { - "properties": { - "orderItemDetails": { - "productDetails": { - "hierarchyInformation": { - "productFamilyName": "azurestackedge", - "productLineName": "azure stack edge_pl", - "productName": "azure stack edge pro - fpga", - "configurationName": "azure stack edge pro - fpga 1 gpu" - }, - "count": 0, - "deviceDetails": [] - }, - "orderItemType": "Purchase", - "currentStage": { - "stageStatus": "InProgress", - "stageName": "InReview", - "startTime": "2021-03-24T15:17:13.1376775+05:30" - }, - "orderItemStageHistory": [ - { - "stageStatus": "None", - "stageName": "InReview" - }, - { - "stageStatus": "None", - "stageName": "Placed" - }, - { - "stageStatus": "None", - "stageName": "Confirmed" - }, - { - "stageStatus": "None", - "stageName": "ReadyForDispatch" - } - ], - "preferences": { - "transportPreferences": { - "preferredShipmentType": "MicrosoftManaged" - } - }, - "notificationEmailList": [], - "cancellationStatus": "Cancellable", - "deletionStatus": "Allowed", - "returnStatus": "Returnable" - }, - "addressDetails": { - "forwardAddress": { - "shippingAddress": { - "streetAddress1": "16 TOWNSEND ST", - "streetAddress2": "UNIT 1", - "city": "San Francisco", - "stateOrProvince": "CA", - "country": "US", - "postalCode": "94107", - "zipExtendedCode": "1", - "companyName": "Microsoft", - "addressType": "Residential" - }, - "contactDetails": { - "contactName": "164 TOWNSEND ST", - "phone": "32131311", - "emailList": [ - "ssemmail@microsoft.com", - "vishwamdir@microsoft.com" - ] - } - } - }, - "startTime": "2021-03-24T15:17:13.1376775+05:30", - "orderId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/locations/westus/orders/TestOrderItemName01" - }, - "location": "westus", - "tags": { - "mango": "fruit", - "carrot": "vegetable" - }, - "name": "TestOrderItemName01", - "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName01", - "type": "Microsoft.EdgeOrder/orderItems" - } - } - } -} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/OrderItemGetByRG.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/OrderItemGetByRG.json deleted file mode 100644 index 58b12efd0a25..000000000000 --- a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/OrderItemGetByRG.json +++ /dev/null @@ -1,185 +0,0 @@ -{ - "parameters": { - "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", - "resourceGroupName": "TestRG", - "api-version": "2020-12-01-preview", - "User-Agent": [ - "vscode-restclient" - ], - "Referer": [ - "https://localhost/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orderItems?api-version=2020-12-01-preview" - ] - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "orderItemDetails": { - "productDetails": { - "hierarchyInformation": { - "productFamilyName": "azurestackedge", - "productLineName": "azure stack edge_pl", - "productName": "azure stack edge pro - fpga", - "configurationName": "azure stack edge pro - fpga 1 gpu" - }, - "count": 0, - "deviceDetails": [] - }, - "orderItemType": "Purchase", - "currentStage": { - "stageStatus": "InProgress", - "stageName": "InReview", - "startTime": "2021-03-24T15:13:04.0758106+05:30" - }, - "orderItemStageHistory": [ - { - "stageStatus": "None", - "stageName": "InReview" - }, - { - "stageStatus": "None", - "stageName": "Placed" - }, - { - "stageStatus": "None", - "stageName": "Confirmed" - }, - { - "stageStatus": "None", - "stageName": "ReadyForDispatch" - } - ], - "preferences": { - "transportPreferences": { - "preferredShipmentType": "MicrosoftManaged" - } - }, - "notificationEmailList": [], - "cancellationStatus": "Cancellable", - "deletionStatus": "Allowed", - "returnStatus": "Returnable" - }, - "addressDetails": { - "forwardAddress": { - "shippingAddress": { - "streetAddress1": "16 TOWNSEND ST", - "streetAddress2": "UNIT 1", - "city": "San Francisco", - "stateOrProvince": "CA", - "country": "US", - "postalCode": "94107", - "zipExtendedCode": "1", - "companyName": "Microsoft", - "addressType": "Residential" - }, - "contactDetails": { - "contactName": "164 TOWNSEND ST", - "phone": "32131311", - "emailList": [ - "ssemmail@microsoft.com", - "vishwamdir@microsoft.com" - ] - } - } - }, - "startTime": "2021-03-24T15:13:04.0758106+05:30", - "orderId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/locations/westus/orders/TestOrderItemName901" - }, - "location": "westus", - "tags": { - "mango": "fruit", - "carrot": "vegetable" - }, - "name": "TestOrderItemName901", - "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName901", - "type": "Microsoft.EdgeOrder/orderItems" - }, - { - "properties": { - "orderItemDetails": { - "productDetails": { - "hierarchyInformation": { - "productFamilyName": "azurestackedge", - "productLineName": "azure stack edge_pl", - "productName": "azure stack edge pro - fpga", - "configurationName": "azure stack edge pro - fpga 1 gpu" - }, - "count": 0, - "deviceDetails": [] - }, - "orderItemType": "Purchase", - "currentStage": { - "stageStatus": "InProgress", - "stageName": "InReview", - "startTime": "2021-03-24T15:17:13.1376775+05:30" - }, - "orderItemStageHistory": [ - { - "stageStatus": "None", - "stageName": "InReview" - }, - { - "stageStatus": "None", - "stageName": "Placed" - }, - { - "stageStatus": "None", - "stageName": "Confirmed" - }, - { - "stageStatus": "None", - "stageName": "ReadyForDispatch" - } - ], - "preferences": { - "transportPreferences": { - "preferredShipmentType": "MicrosoftManaged" - } - }, - "notificationEmailList": [], - "cancellationStatus": "Cancellable", - "deletionStatus": "Allowed", - "returnStatus": "Returnable" - }, - "addressDetails": { - "forwardAddress": { - "shippingAddress": { - "streetAddress1": "16 TOWNSEND ST", - "streetAddress2": "UNIT 1", - "city": "San Francisco", - "stateOrProvince": "CA", - "country": "US", - "postalCode": "94107", - "zipExtendedCode": "1", - "companyName": "Microsoft", - "addressType": "Residential" - }, - "contactDetails": { - "contactName": "164 TOWNSEND ST", - "phone": "32131311", - "emailList": [ - "ssemmail@microsoft.com", - "vishwamdir@microsoft.com" - ] - } - } - }, - "startTime": "2021-03-24T15:17:13.1376775+05:30", - "orderId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/locations/westus/orders/TestOrderItemName01" - }, - "location": "westus", - "tags": { - "mango": "fruit", - "carrot": "vegetable" - }, - "name": "TestOrderItemName01", - "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName01", - "type": "Microsoft.EdgeOrder/orderItems" - } - ] - } - } - } -} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/OrderItemGetBySubscription.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/OrderItemGetBySubscription.json deleted file mode 100644 index 672cd69fff94..000000000000 --- a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/OrderItemGetBySubscription.json +++ /dev/null @@ -1,184 +0,0 @@ -{ - "parameters": { - "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", - "api-version": "2020-12-01-preview", - "User-Agent": [ - "vscode-restclient" - ], - "Referer": [ - "https://localhost/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/providers/Microsoft.EdgeOrder/orderItems?api-version=2020-12-01-preview" - ] - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "orderItemDetails": { - "productDetails": { - "hierarchyInformation": { - "productFamilyName": "azurestackedge", - "productLineName": "azure stack edge_pl", - "productName": "azure stack edge pro - fpga", - "configurationName": "azure stack edge pro - fpga 1 gpu" - }, - "count": 0, - "deviceDetails": [] - }, - "orderItemType": "Purchase", - "currentStage": { - "stageStatus": "InProgress", - "stageName": "InReview", - "startTime": "2021-03-24T15:13:04.0758106+05:30" - }, - "orderItemStageHistory": [ - { - "stageStatus": "None", - "stageName": "InReview" - }, - { - "stageStatus": "None", - "stageName": "Placed" - }, - { - "stageStatus": "None", - "stageName": "Confirmed" - }, - { - "stageStatus": "None", - "stageName": "ReadyForDispatch" - } - ], - "preferences": { - "transportPreferences": { - "preferredShipmentType": "MicrosoftManaged" - } - }, - "notificationEmailList": [], - "cancellationStatus": "Cancellable", - "deletionStatus": "Allowed", - "returnStatus": "Returnable" - }, - "addressDetails": { - "forwardAddress": { - "shippingAddress": { - "streetAddress1": "16 TOWNSEND ST", - "streetAddress2": "UNIT 1", - "city": "San Francisco", - "stateOrProvince": "CA", - "country": "US", - "postalCode": "94107", - "zipExtendedCode": "1", - "companyName": "Microsoft", - "addressType": "Residential" - }, - "contactDetails": { - "contactName": "164 TOWNSEND ST", - "phone": "32131311", - "emailList": [ - "ssemmail@microsoft.com", - "vishwamdir@microsoft.com" - ] - } - } - }, - "startTime": "2021-03-24T15:13:04.0758106+05:30", - "orderId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/locations/westus/orders/TestOrderItemName901" - }, - "location": "westus", - "tags": { - "mango": "fruit", - "carrot": "vegetable" - }, - "name": "TestOrderItemName901", - "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName901", - "type": "Microsoft.EdgeOrder/orderItems" - }, - { - "properties": { - "orderItemDetails": { - "productDetails": { - "hierarchyInformation": { - "productFamilyName": "azurestackedge", - "productLineName": "azure stack edge_pl", - "productName": "azure stack edge pro - fpga", - "configurationName": "azure stack edge pro - fpga 1 gpu" - }, - "count": 0, - "deviceDetails": [] - }, - "orderItemType": "Purchase", - "currentStage": { - "stageStatus": "InProgress", - "stageName": "InReview", - "startTime": "2021-03-24T15:17:13.1376775+05:30" - }, - "orderItemStageHistory": [ - { - "stageStatus": "None", - "stageName": "InReview" - }, - { - "stageStatus": "None", - "stageName": "Placed" - }, - { - "stageStatus": "None", - "stageName": "Confirmed" - }, - { - "stageStatus": "None", - "stageName": "ReadyForDispatch" - } - ], - "preferences": { - "transportPreferences": { - "preferredShipmentType": "MicrosoftManaged" - } - }, - "notificationEmailList": [], - "cancellationStatus": "Cancellable", - "deletionStatus": "Allowed", - "returnStatus": "Returnable" - }, - "addressDetails": { - "forwardAddress": { - "shippingAddress": { - "streetAddress1": "16 TOWNSEND ST", - "streetAddress2": "UNIT 1", - "city": "San Francisco", - "stateOrProvince": "CA", - "country": "US", - "postalCode": "94107", - "zipExtendedCode": "1", - "companyName": "Microsoft", - "addressType": "Residential" - }, - "contactDetails": { - "contactName": "164 TOWNSEND ST", - "phone": "32131311", - "emailList": [ - "ssemmail@microsoft.com", - "vishwamdir@microsoft.com" - ] - } - } - }, - "startTime": "2021-03-24T15:17:13.1376775+05:30", - "orderId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/locations/westus/orders/TestOrderItemName01" - }, - "location": "westus", - "tags": { - "mango": "fruit", - "carrot": "vegetable" - }, - "name": "TestOrderItemName01", - "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName01", - "type": "Microsoft.EdgeOrder/orderItems" - } - ] - } - } - } -} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/OrderItemUpdate.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/OrderItemUpdate.json deleted file mode 100644 index 7d6e178ba412..000000000000 --- a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/OrderItemUpdate.json +++ /dev/null @@ -1,119 +0,0 @@ -{ - "parameters": { - "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", - "resourceGroupName": "TestRG", - "orderItemName": "TestOrderItemName01", - "api-version": "2020-12-01-preview", - "User-Agent": [ - "vscode-restclient" - ], - "Referer": [ - "https://localhost/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName01?api-version=2020-12-01-preview" - ], - "Content-Type": [ - "application/json; charset=utf-8" - ], - "Content-Length": [ - "493" - ], - "orderItemUpdateParameter": { - "properties": { - "forwardAddress": { - "contactDetails": { - "contactName": "Updated contact name", - "phone": "22222", - "emailList": [ - "testemail@microsoft.com" - ] - } - }, - "preferences": { - "transportPreferences": { - "preferredShipmentType": "CustomerManaged" - } - } - }, - "tags": { - "pigeon": "bird", - "tiger": "animal", - "ant": "insect" - } - } - }, - "responses": { - "200": { - "body": { - "properties": { - "orderItemDetails": { - "productDetails": { - "hierarchyInformation": { - "productFamilyName": "azurestackedge", - "productLineName": "azure stack edge_pl", - "productName": "azure stack edge pro - fpga", - "configurationName": "azure stack edge pro - fpga 1 gpu" - }, - "count": 0, - "deviceDetails": [] - }, - "orderItemType": "Purchase", - "currentStage": { - "stageStatus": "InProgress", - "stageName": "InReview", - "startTime": "2021-03-24T15:17:13.1376775+05:30" - }, - "orderItemStageHistory": [ - { - "stageStatus": "None", - "stageName": "InReview" - }, - { - "stageStatus": "None", - "stageName": "Placed" - }, - { - "stageStatus": "None", - "stageName": "Confirmed" - }, - { - "stageStatus": "None", - "stageName": "ReadyForDispatch" - } - ], - "preferences": { - "transportPreferences": { - "preferredShipmentType": "CustomerManaged" - } - }, - "notificationEmailList": [], - "cancellationStatus": "Cancellable", - "deletionStatus": "Allowed", - "returnStatus": "Returnable" - }, - "addressDetails": { - "forwardAddress": { - "contactDetails": { - "contactName": "Updated contact name", - "phone": "22222", - "emailList": [ - "testemail@microsoft.com" - ] - } - } - }, - "startTime": "2021-03-24T15:17:13.1376775+05:30", - "orderId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/locations/westus/orders/TestOrderItemName01" - }, - "location": "westus", - "tags": { - "pigeon": "bird", - "tiger": "animal", - "ant": "insect" - }, - "name": "TestOrderItemName01", - "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName01", - "type": "Microsoft.EdgeOrder/orderItems" - } - }, - "202": {} - } -} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/OrderItemReturn.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ReturnOrderItem.json similarity index 100% rename from specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/OrderItemReturn.json rename to specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/ReturnOrderItem.json diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/UpdateAddress.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/UpdateAddress.json new file mode 100644 index 000000000000..d97d12d9ceae --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/UpdateAddress.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "TestRG", + "addressName": "TestAddressName2", + "api-version": "2020-12-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://localhost/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/addresses/TestAddressName2?api-version=2020-12-01-preview" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "612" + ], + "addressUpdateParameter": { + "properties": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND STT", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "Petr Cech", + "phone": "1234567890", + "phoneExtension": "", + "emailList": [ + "ssemcr@microsoft.com" + ] + } + }, + "tags": { + "Name": "Smile-Updated", + "Work": "Engineering", + "Hobby": "Web Series Added", + "WhatElse": "Web Series Added" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND STT", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "None" + }, + "contactDetails": { + "contactName": "Petr Cech", + "phone": "1234567890", + "phoneExtension": "", + "emailList": [ + "ssemcr@microsoft.com" + ] + } + }, + "location": "westus", + "tags": { + "name": "Smile-Updated", + "work": "Engineering", + "hobby": "Web Series Added", + "whatElse": "Web Series Added" + }, + "name": "TestAddressName2", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/addresses/TestAddressName2", + "type": "Microsoft.EdgeOrder/addresses" + } + }, + "202": {} + } +} diff --git a/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/UpdateOrderItem.json b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/UpdateOrderItem.json new file mode 100644 index 000000000000..e2103d6a1000 --- /dev/null +++ b/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/preview/2020-12-01-preview/examples/UpdateOrderItem.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", + "resourceGroupName": "TestRG", + "orderItemName": "TestOrderItemName01", + "api-version": "2020-12-01-preview", + "User-Agent": [ + "vscode-restclient" + ], + "Referer": [ + "https://localhost/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName01?api-version=2020-12-01-preview" + ], + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "533" + ], + "orderItemUpdateParameter": { + "properties": { + "forwardAddress": { + "contactDetails": { + "contactName": "Updated contact name", + "phone": "2222200000", + "emailList": [ + "testemail@microsoft.com" + ] + } + }, + "preferences": { + "transportPreferences": { + "preferredShipmentType": "CustomerManaged" + } + } + }, + "tags": { + "pigeon": "bird", + "tiger": "animal", + "ant": "insect" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "orderItemDetails": { + "productDetails": { + "displayInfo": { + "productFamilyDisplayName": "Azure Stack Edge", + "configurationDisplayName": "Azure Stack Edge Pro - 1 GPU" + }, + "hierarchyInformation": { + "productFamilyName": "azurestackedge", + "productLineName": "azurestackedge", + "productName": "azurestackedgegpu", + "configurationName": "azurestackedgegpu" + }, + "count": 0 + }, + "orderItemType": "Purchase", + "currentStage": { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2021-06-07T13:14:40.0815406+05:30" + }, + "orderItemStageHistory": [ + { + "stageStatus": "Succeeded", + "stageName": "Placed", + "startTime": "2021-06-07T13:14:40.0815406+05:30" + }, + { + "stageStatus": "None", + "stageName": "Confirmed" + }, + { + "stageStatus": "None", + "stageName": "ReadyToShip" + }, + { + "stageStatus": "None", + "stageName": "Shipped" + }, + { + "stageStatus": "None", + "stageName": "Delivered" + }, + { + "stageStatus": "None", + "stageName": "InUse" + } + ], + "preferences": { + "transportPreferences": { + "preferredShipmentType": "CustomerManaged" + } + }, + "notificationEmailList": [], + "cancellationStatus": "Cancellable", + "deletionStatus": "NotAllowed", + "returnStatus": "NotReturnable" + }, + "addressDetails": { + "forwardAddress": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "UNIT 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "zipExtendedCode": "1", + "companyName": "Microsoft", + "addressType": "Residential" + }, + "contactDetails": { + "contactName": "Updated contact name", + "phone": "2222200000", + "emailList": [ + "testemail@microsoft.com" + ] + } + } + }, + "startTime": "2021-06-07T13:14:37.4649597+05:30", + "orderId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/locations/westus/orders/TestOrderItemName01" + }, + "location": "westus", + "tags": { + "pigeon": "bird", + "tiger": "animal", + "ant": "insect" + }, + "name": "TestOrderItemName01", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName01", + "type": "Microsoft.EdgeOrder/orderItems" + } + }, + "202": {} + } +} diff --git a/specification/edgeorder/resource-manager/readme.go.md b/specification/edgeorder/resource-manager/readme.go.md new file mode 100644 index 000000000000..cc32eb1019e9 --- /dev/null +++ b/specification/edgeorder/resource-manager/readme.go.md @@ -0,0 +1,26 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_MIT_NO_VERSION + clear-output-folder: true + namespace: edgeorder +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2020-12-preview +``` + +### Tag: package-2020-12-preview and go + +These settings apply only when `--tag=package-2020-12-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2020-12-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-12-01-preview/$(namespace) +``` \ No newline at end of file diff --git a/specification/edgeorder/resource-manager/readme.md b/specification/edgeorder/resource-manager/readme.md index f20620ade6ec..b35e7a45fbe2 100644 --- a/specification/edgeorder/resource-manager/readme.md +++ b/specification/edgeorder/resource-manager/readme.md @@ -25,7 +25,8 @@ To see additional help and options, run: These are the global settings for the EdgeOrder API. ``` yaml -title: Edge Order API's +title: EdgeOrderManagementClient +description: Edge Order API's openapi-type: arm tag: package-2020-12-preview ``` @@ -38,4 +39,40 @@ These settings apply only when `--tag=package-2020-12-preview` is specified on t input-file: - Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json ``` ---- \ No newline at end of file +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-net + - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-go +``` + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.EdgeOrder + output-folder: $(csharp-sdks-folder)/edgeorder/Microsoft.Azure.Management.EdgeOrder/src/Generated + clear-output-folder: true +``` + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) \ No newline at end of file diff --git a/specification/edgeorder/resource-manager/readme.python.md b/specification/edgeorder/resource-manager/readme.python.md new file mode 100644 index 000000000000..91a7c02645b3 --- /dev/null +++ b/specification/edgeorder/resource-manager/readme.python.md @@ -0,0 +1,24 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. +These settings apply only when `--track2` is specified on the command line. + +``` yaml $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-edgeorder +no-namespace-folders: true +package-version: 1.0.0b1 +clear-output-folder: true +``` + +```yaml $(python) && $(python-mode) == 'update' && $(track2) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/edgeorder/azure-mgmt-edgeorder/azure/mgmt/edgeorder +``` + +```yaml $(python) && $(python-mode) == 'create' && $(track2) +basic-setup-py: true +output-folder: $(python-sdks-folder)/edgeorder/azure-mgmt-edgeorder \ No newline at end of file diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/elastic.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/elastic.json new file mode 100644 index 000000000000..04870dd910e8 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/elastic.json @@ -0,0 +1,1569 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.Elastic", + "version": "2020-07-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Elastic/operations": { + "get": { + "tags": [ + "MonitorsResource" + ], + "summary": "List all operations provided by Microsoft.Elastic.", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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}/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/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}/tagRules": { + "get": { + "tags": [ + "Rules" + ], + "summary": "List the tag rules for a given monitor resource.", + "operationId": "TagRules_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/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" + } + } + } + } + }, + "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", + "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", + "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": 50, + "type": "string" + }, + "employeesNumber": { + "description": "Number of employees in the company", + "maxLength": 20, + "type": "string" + }, + "state": { + "description": "State of the company location.", + "maxLength": 50, + "type": "string" + }, + "country": { + "description": "Country of the company location.", + "maxLength": 50, + "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": 50, + "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" + } + } + }, + "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" + ] + }, + "liftrResourceCategory": { + "$ref": "#/definitions/LiftrResourceCategories" + }, + "liftrResourcePreference": { + "description": "The priority of the resource.", + "format": "int32", + "type": "integer", + "readOnly": true + } + } + }, + "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/v2/types.json#/definitions/systemData" + } + } + }, + "ElasticMonitorResourceListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "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", + "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" + } + } + }, + "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", + "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/v2/types.json#/definitions/systemData" + } + } + }, + "MonitoringTagRulesListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MonitoringTagRules" + } + }, + "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 + } + } + }, + "VMHostListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "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" + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to be used with the HTTP request.", + "required": true, + "type": "string", + "enum": [ + "2020-07-01" + ] + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)", + "required": true, + "type": "string" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group to which the Elastic resource belongs.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "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/stable/2020-07-01/examples/DeploymentInfo_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/DeploymentInfo_List.json new file mode 100644 index 000000000000..c82d18490286 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/DeploymentInfo_List.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2020-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "status": "Healthy", + "version": "7.9.3", + "memoryCapacity": "1024", + "diskCapacity": "245760" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/MonitoredResources_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/MonitoredResources_List.json new file mode 100644 index 000000000000..4ca83243930d --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/MonitoredResources_List.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2020-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault", + "sendingLogs": "True", + "reasonForLogsStatus": "CapturedByRules" + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/Monitors_Create.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/Monitors_Create.json new file mode 100644 index 000000000000..4132739b074a --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/Monitors_Create.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2020-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "name": "myMonitor", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "userInfo": { + "firstName": "Alice", + "lastName": "Bob", + "companyName": "Microsoft", + "emailAddress": "alice@microsoft.com", + "companyInfo": { + "domain": "microsoft.com", + "business": "Technology", + "employeeNumber": "10000", + "state": "WA", + "country": "US" + } + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "provisioningState": "Succeeded", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/Monitors_Delete.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/Monitors_Delete.json new file mode 100644 index 000000000000..b755053252d3 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/Monitors_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/Monitors_Get.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/Monitors_Get.json new file mode 100644 index 000000000000..2eaac9e3f6e4 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/Monitors_Get.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2020-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/Monitors_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/Monitors_List.json new file mode 100644 index 000000000000..791cbdb1dab3 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/Monitors_List.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2020-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/Monitors_ListByResourceGroup.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/Monitors_ListByResourceGroup.json new file mode 100644 index 000000000000..afb91c51ee4e --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/Monitors_ListByResourceGroup.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2020-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/Monitors_Update.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/Monitors_Update.json new file mode 100644 index 000000000000..c15e443129c6 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/Monitors_Update.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2020-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "name": "myMonitor", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "userInfo": { + "firstName": "Alice", + "lastName": "Bob", + "companyName": "Microsoft", + "emailAddress": "alice@microsoft.com", + "companyInfo": { + "domain": "microsoft.com", + "business": "Technology", + "employeeNumber": "10000", + "state": "WA", + "country": "US" + } + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/Operations_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/Operations_List.json new file mode 100644 index 000000000000..aecf2b634478 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/Operations_List.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2020-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Elastic/monitors/write", + "display": { + "provider": "Microsoft.Elastic", + "resource": "monitors", + "operation": "write", + "description": "Write monitors resource" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/TagRules_CreateOrUpdate.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/TagRules_CreateOrUpdate.json new file mode 100644 index 000000000000..0919ae1209c8 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/TagRules_CreateOrUpdate.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2020-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "ruleSetName": "default", + "requestBody": { + "properties": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/tagRules/default", + "type": "Microsoft.Datadog/monitors/tagRules", + "properties": { + "provisioningState": "Succeeded", + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + } + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/TagRules_Delete.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/TagRules_Delete.json new file mode 100644 index 000000000000..eb020710a82b --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/TagRules_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2020-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "ruleSetName": "default" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/TagRules_Get.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/TagRules_Get.json new file mode 100644 index 000000000000..61f34084b1fd --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/TagRules_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2020-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "ruleSetName": "default" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/tagRules/default", + "type": "Microsoft.Datadog/monitors/tagRules", + "properties": { + "provisioningState": "Succeeded", + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + } + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/TagRules_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/TagRules_List.json new file mode 100644 index 000000000000..f16fc546f923 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/TagRules_List.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2020-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/tagRules/default", + "type": "Microsoft.Datadog/monitors/tagRules", + "properties": { + "provisioningState": "Succeeded", + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/VMCollection_Update.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/VMCollection_Update.json new file mode 100644 index 000000000000..88435653e554 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/VMCollection_Update.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2020-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "vmResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualmachines/myVM", + "operationName": "Add" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/VMHost_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/VMHost_List.json new file mode 100644 index 000000000000..6fdc98452a0e --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/VMHost_List.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2020-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "vmResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualmachines/myVM" + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/VMIngestion_Details.json b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/VMIngestion_Details.json new file mode 100644 index 000000000000..737c93978e5f --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/stable/2020-07-01/examples/VMIngestion_Details.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2020-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "cloudId": "myid123", + "ingestionKey": "Vmingeationkey" + } + } + } +} diff --git a/specification/elastic/resource-manager/readme.go.md b/specification/elastic/resource-manager/readme.go.md index 7e832819f32b..49db6d1ade71 100644 --- a/specification/elastic/resource-manager/readme.go.md +++ b/specification/elastic/resource-manager/readme.go.md @@ -13,9 +13,19 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2020-07-01 - tag: package-2020-07-01-preview ``` +### Tag: package-2020-07-01 and go + +These settings apply only when `--tag=package-2020-07-01 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +```yaml $(tag) == 'package-2020-07-01' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-07-01/$(namespace) +``` + ### Tag: package-2020-07-01-preview and go These settings apply only when `--tag=package-2020-07-01-preview --go` is specified on the command line. diff --git a/specification/elastic/resource-manager/readme.md b/specification/elastic/resource-manager/readme.md index 4db60005e365..6df68d981667 100644 --- a/specification/elastic/resource-manager/readme.md +++ b/specification/elastic/resource-manager/readme.md @@ -26,7 +26,8 @@ These are the global settings for the elastic. ```yaml openapi-type: arm -tag: package-2020-07-01-preview +openapi-subtype: rpaas +tag: package-2020-07-01 ``` ### Tag: package-2020-07-01-preview @@ -40,6 +41,16 @@ input-file: --- +### Tag: package-2020-07-01 + +These settings apply only when `--tag=package-2020-07-01` is specified on the command line. + +```yaml $(tag) == 'package-2020-07-01' +input-file: + - Microsoft.Elastic/stable/2020-07-01/elastic.json +``` + +--- # Code Generation ## Swagger to SDK @@ -65,6 +76,12 @@ directive: where: - $.definitions.VMIngestionDetailsResponse.properties.ingestionKey reason: Secrets are OK to return in a POST response. + - suppress: SECRET_PROPERTY + from: + - Microsoft.Elastic/stable/2020-07-01/elastic.json + where: + - $.definitions.VMIngestionDetailsResponse.properties.ingestionKey + reason: Secrets are OK to return in a POST response. ``` ## Az diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json index 689b7e987042..d352755c3a5e 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json @@ -18,6 +18,13 @@ "messageBody": { "description": "The body of the chat message", "type": "string" + }, + "metadata": { + "description": "The chat message metadata", + "type": "object", + "additionalProperties": { + "type": "string" + } } } }, @@ -32,6 +39,13 @@ "messageBody": { "description": "The body of the chat message", "type": "string" + }, + "metadata": { + "description": "The chat message metadata", + "type": "object", + "additionalProperties": { + "type": "string" + } } } }, @@ -47,6 +61,13 @@ "description": "The body of the chat message", "type": "string" }, + "metadata": { + "description": "The chat message metadata", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, "editTime": { "description": "The time at which the message was edited", "format": "date-time", @@ -66,6 +87,13 @@ "description": "The body of the chat message", "type": "string" }, + "metadata": { + "description": "The chat message metadata", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, "editTime": { "description": "The time at which the message was edited", "format": "date-time", @@ -652,6 +680,14 @@ "endReason": { "description": "The reason for ending the recording chunk", "type": "string" + }, + "metadataLocation": { + "description": "The location of the metadata for this chunk", + "type": "string" + }, + "contentLocation": { + "description": "The location of the content for this chunk", + "type": "string" } } } diff --git a/specification/eventgrid/data-plane/Microsoft.ContainerService/stable/2018-01-01/ContainerService.json b/specification/eventgrid/data-plane/Microsoft.ContainerService/stable/2018-01-01/ContainerService.json new file mode 100644 index 000000000000..14308bc7a6d6 --- /dev/null +++ b/specification/eventgrid/data-plane/Microsoft.ContainerService/stable/2018-01-01/ContainerService.json @@ -0,0 +1,33 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-01-01", + "title": "Schema of Azure Kubernetes Service events published to Azure Event Grid", + "description": "Describes the schema of the Azure Kubernetes Service events published to Azure Event Grid. This corresponds to the Data property of an EventGridEvent" + }, + "paths": {}, + "definitions": { + "ContainerServiceNewKubernetesVersionAvailableEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.NewKubernetesVersionAvailable event", + "type": "object", + "properties": { + "latestSupportedKubernetesVersion": { + "description": "The highest PATCH Kubernetes version for the highest MINOR version supported by ManagedCluster resource", + "type": "string" + }, + "latestStableKubernetesVersion": { + "description": "The highest PATCH Kubernetes version for the MINOR version considered stable for the ManagedCluster resource", + "type": "string" + }, + "lowestMinorKubernetesVersion": { + "description": "The highest PATCH Kubernetes version for the lowest applicable MINOR version available for the ManagedCluster resource", + "type": "string" + }, + "latestPreviewKubernetesVersion": { + "description": "The highest PATCH Kubernetes version considered preview for the ManagedCluster resource. There might not be any version in preview at the time of publishing the event", + "type": "string" + } + } + } + } +} diff --git a/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/Storage.json b/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/Storage.json index 0caf38799d41..b552a85f6074 100644 --- a/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/Storage.json +++ b/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/Storage.json @@ -389,6 +389,41 @@ "type": "object" } } + }, + "StorageBlobInventoryPolicyCompletedEventData": { + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Storage.BlobInventoryPolicyCompleted event.", + "type": "object", + "properties": { + "scheduleDateTime": { + "description": "The time at which inventory policy was scheduled.", + "format": "date-time", + "type": "string" + }, + "accountName": { + "description": "The account name for which inventory policy is registered.", + "type": "string" + }, + "ruleName": { + "description": "The rule name for inventory policy.", + "type": "string" + }, + "policyRunStatus": { + "description": "The status of inventory run, it can be Succeeded/PartiallySucceeded/Failed.", + "type": "string" + }, + "policyRunStatusMessage": { + "description": "The status message for inventory run.", + "type": "string" + }, + "policyRunId": { + "description": "The policy run id for inventory run.", + "type": "string" + }, + "manifestBlobUrl": { + "description": "The blob URL for manifest file for inventory run.", + "type": "string" + } + } } } } diff --git a/specification/eventgrid/data-plane/readme.md b/specification/eventgrid/data-plane/readme.md index 394fdfaa854d..6fcfc2401860 100644 --- a/specification/eventgrid/data-plane/readme.md +++ b/specification/eventgrid/data-plane/readme.md @@ -86,6 +86,7 @@ input-file: - Microsoft.Web/stable/2018-01-01/Web.json - Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json - Microsoft.PolicyInsights/stable/2018-01-01/PolicyInsights.json +- Microsoft.ContainerService/stable/2018-01-01/ContainerService.json ``` ### Suppression @@ -179,6 +180,7 @@ input-file: - $(this-folder)/Microsoft.Cache/stable/2018-01-01/RedisCache.json - $(this-folder)/Microsoft.Web/stable/2018-01-01/Web.json - $(this-folder)/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json + - $(this-folder)/Microsoft.ContainerService/stable/2018-01-01/ContainerService.json ``` diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2020-10-15-preview/EventGrid.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2020-10-15-preview/EventGrid.json index 82ba19735633..045e22aa2f15 100644 --- a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2020-10-15-preview/EventGrid.json +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2020-10-15-preview/EventGrid.json @@ -6878,7 +6878,8 @@ }, "isSecret": { "description": "Boolean flag to tell if the attribute contains sensitive information .", - "type": "boolean" + "type": "boolean", + "default": false } } }, @@ -8241,7 +8242,8 @@ "x-ms-enum": { "name": "ResourceKind", "modelAsString": true - } + }, + "default": "Azure" }, "extendedLocation": { "$ref": "#/definitions/ExtendedLocation", diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/EventGrid.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/EventGrid.json new file mode 100644 index 000000000000..cac52caceb07 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/EventGrid.json @@ -0,0 +1,8519 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01-preview", + "title": "EventGridManagementClient", + "description": "Azure EventGrid Management Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}": { + "get": { + "tags": [ + "Domains" + ], + "summary": "Get a domain.", + "description": "Get properties of a domain.", + "operationId": "Domains_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of the domain.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Domain" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Domains_Get": { + "$ref": "./examples/Domains_Get.json" + } + } + }, + "put": { + "tags": [ + "Domains" + ], + "summary": "Create or update a domain.", + "description": "Asynchronously creates or updates a new domain with the specified parameters.", + "operationId": "Domains_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of the domain.", + "required": true, + "type": "string" + }, + { + "name": "domainInfo", + "in": "body", + "description": "Domain information.", + "required": true, + "schema": { + "$ref": "#/definitions/Domain" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Domain" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Domains_CreateOrUpdate": { + "$ref": "./examples/Domains_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Domains" + ], + "summary": "Delete a domain.", + "description": "Delete existing domain.", + "operationId": "Domains_Delete", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of the domain.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Domains_Delete": { + "$ref": "./examples/Domains_Delete.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Domains" + ], + "summary": "Update a domain.", + "description": "Asynchronously updates a domain with the specified parameters.", + "operationId": "Domains_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of the domain.", + "required": true, + "type": "string" + }, + { + "name": "domainUpdateParameters", + "in": "body", + "description": "Domain update information.", + "required": true, + "schema": { + "$ref": "#/definitions/DomainUpdateParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "201": { + "description": "Domain update request accepted.", + "schema": { + "$ref": "#/definitions/Domain" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Domains_Update": { + "$ref": "./examples/Domains_Update.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/domains": { + "get": { + "tags": [ + "Domains" + ], + "summary": "List domains under an Azure subscription.", + "description": "List all the domains under an Azure subscription.", + "operationId": "Domains_ListBySubscription", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DomainsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Domains_ListBySubscription": { + "$ref": "./examples/Domains_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains": { + "get": { + "tags": [ + "Domains" + ], + "summary": "List domains under a resource group.", + "description": "List all the domains under a resource group.", + "operationId": "Domains_ListByResourceGroup", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DomainsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Domains_ListByResourceGroup": { + "$ref": "./examples/Domains_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/listKeys": { + "post": { + "tags": [ + "Domains" + ], + "summary": "List keys for a domain.", + "description": "List the two keys used to publish to a domain.", + "operationId": "Domains_ListSharedAccessKeys", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of the domain.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DomainSharedAccessKeys" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Domains_ListSharedAccessKeys": { + "$ref": "./examples/Domains_ListSharedAccessKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/regenerateKey": { + "post": { + "tags": [ + "Domains" + ], + "summary": "Regenerate key for a domain.", + "description": "Regenerate a shared access key for a domain.", + "operationId": "Domains_RegenerateKey", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of the domain.", + "required": true, + "type": "string" + }, + { + "name": "regenerateKeyRequest", + "in": "body", + "description": "Request body to regenerate key.", + "required": true, + "schema": { + "$ref": "#/definitions/DomainRegenerateKeyRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DomainSharedAccessKeys" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Domains_RegenerateKey": { + "$ref": "./examples/Domains_RegenerateKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{domainTopicName}": { + "get": { + "tags": [ + "DomainTopics" + ], + "summary": "Get a domain topic.", + "description": "Get properties of a domain topic.", + "operationId": "DomainTopics_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of the domain.", + "required": true, + "type": "string" + }, + { + "name": "domainTopicName", + "in": "path", + "description": "Name of the topic.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DomainTopic" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "DomainTopics_Get": { + "$ref": "./examples/DomainTopics_Get.json" + } + } + }, + "put": { + "tags": [ + "DomainTopics" + ], + "summary": "Create or update a domain topic.", + "description": "Asynchronously creates or updates a new domain topic with the specified parameters.", + "operationId": "DomainTopics_CreateOrUpdate", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of the domain.", + "required": true, + "type": "string" + }, + { + "name": "domainTopicName", + "in": "path", + "description": "Name of the domain topic.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DomainTopic" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "DomainTopics_CreateOrUpdate": { + "$ref": "./examples/DomainTopics_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "DomainTopics" + ], + "summary": "Delete a domain topic.", + "description": "Delete existing domain topic.", + "operationId": "DomainTopics_Delete", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of the domain.", + "required": true, + "type": "string" + }, + { + "name": "domainTopicName", + "in": "path", + "description": "Name of the domain topic.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "DomainTopics_Delete": { + "$ref": "./examples/DomainTopics_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics": { + "get": { + "tags": [ + "DomainTopics" + ], + "summary": "List domain topics.", + "description": "List all the topics in a domain.", + "operationId": "DomainTopics_ListByDomain", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "Domain name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DomainTopicsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "DomainTopics_ListByDomain": { + "$ref": "./examples/DomainTopics_ListByDomain.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/eventChannels/{eventChannelName}": { + "get": { + "tags": [ + "EventChannels" + ], + "summary": "Get an event channel.", + "description": "Get properties of an event channel.", + "operationId": "EventChannels_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "partnerNamespaceName", + "in": "path", + "description": "Name of the partner namespace.", + "required": true, + "type": "string" + }, + { + "name": "eventChannelName", + "in": "path", + "description": "Name of the event channel.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventChannel" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventChannels_Get": { + "$ref": "./examples/EventChannels_Get.json" + } + } + }, + "put": { + "tags": [ + "EventChannels" + ], + "summary": "Create an event channel.", + "description": "Asynchronously creates a new event channel with the specified parameters.", + "operationId": "EventChannels_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "partnerNamespaceName", + "in": "path", + "description": "Name of the partner namespace.", + "required": true, + "type": "string" + }, + { + "name": "eventChannelName", + "in": "path", + "description": "Name of the event channel.", + "required": true, + "type": "string" + }, + { + "name": "eventChannelInfo", + "in": "body", + "description": "EventChannel information.", + "required": true, + "schema": { + "$ref": "#/definitions/EventChannel" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventChannel" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventChannels_CreateOrUpdate": { + "$ref": "./examples/EventChannels_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "EventChannels" + ], + "summary": "Delete an event channel.", + "description": "Delete existing event channel.", + "operationId": "EventChannels_Delete", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "partnerNamespaceName", + "in": "path", + "description": "Name of the partner namespace.", + "required": true, + "type": "string" + }, + { + "name": "eventChannelName", + "in": "path", + "description": "Name of the event channel.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventChannels_Delete": { + "$ref": "./examples/EventChannels_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/eventChannels": { + "get": { + "tags": [ + "EventChannels" + ], + "summary": "List event channels.", + "description": "List all the event channels in a partner namespace.", + "operationId": "EventChannels_ListByPartnerNamespace", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "partnerNamespaceName", + "in": "path", + "description": "Name of the partner namespace.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventChannelsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventChannels_ListByPartnerNamespace": { + "$ref": "./examples/EventChannels_ListByPartnerNamespace.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Get an event subscription.", + "description": "Get properties of an event subscription.", + "operationId": "EventSubscriptions_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "scope", + "in": "path", + "description": "The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true + }, + { + "name": "eventSubscriptionName", + "in": "path", + "description": "Name of the event subscription.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscription" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventSubscriptions_GetForSubscription": { + "$ref": "./examples/EventSubscriptions_GetForSubscription.json" + }, + "EventSubscriptions_GetForResourceGroup": { + "$ref": "./examples/EventSubscriptions_GetForResourceGroup.json" + }, + "EventSubscriptions_GetForResource": { + "$ref": "./examples/EventSubscriptions_GetForResource.json" + }, + "EventSubscriptions_GetForCustomTopic": { + "$ref": "./examples/EventSubscriptions_GetForCustomTopic.json" + } + } + }, + "put": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Create or update an event subscription.", + "description": "Asynchronously creates a new event subscription or updates an existing event subscription based on the specified scope.", + "operationId": "EventSubscriptions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "scope", + "in": "path", + "description": "The identifier of the resource to which the event subscription needs to be created or updated. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true + }, + { + "name": "eventSubscriptionName", + "in": "path", + "description": "Name of the event subscription. Event subscription names must be between 3 and 64 characters in length and should use alphanumeric letters only.", + "required": true, + "type": "string" + }, + { + "name": "eventSubscriptionInfo", + "in": "body", + "description": "Event subscription properties containing the destination and filter information.", + "required": true, + "schema": { + "$ref": "#/definitions/EventSubscription" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "EventSubscription CreateOrUpdate request accepted.", + "schema": { + "$ref": "#/definitions/EventSubscription" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventSubscriptions_CreateOrUpdateForSubscription": { + "$ref": "./examples/EventSubscriptions_CreateOrUpdateForSubscription.json" + }, + "EventSubscriptions_CreateOrUpdateForResourceGroup": { + "$ref": "./examples/EventSubscriptions_CreateOrUpdateForResourceGroup.json" + }, + "EventSubscriptions_CreateOrUpdateForResource": { + "$ref": "./examples/EventSubscriptions_CreateOrUpdateForResource.json" + }, + "EventSubscriptions_CreateOrUpdateForCustomTopic_WebhookDestination": { + "$ref": "./examples/EventSubscriptions_CreateOrUpdateForCustomTopic_WebhookDestination.json" + }, + "EventSubscriptions_CreateOrUpdateForCustomTopic_EventHubDestination": { + "$ref": "./examples/EventSubscriptions_CreateOrUpdateForCustomTopic_EventHubDestination.json" + }, + "EventSubscriptions_CreateOrUpdateForCustomTopic_HybridConnectionDestination": { + "$ref": "./examples/EventSubscriptions_CreateOrUpdateForCustomTopic_HybridConnectionDestination.json" + }, + "EventSubscriptions_CreateOrUpdateForCustomTopic_StorageQueueDestination": { + "$ref": "./examples/EventSubscriptions_CreateOrUpdateForCustomTopic_StorageQueueDestination.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Delete an event subscription.", + "description": "Delete an existing event subscription.", + "operationId": "EventSubscriptions_Delete", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "scope", + "in": "path", + "description": "The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true + }, + { + "name": "eventSubscriptionName", + "in": "path", + "description": "Name of the event subscription.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventSubscriptions_DeleteForSubscription": { + "$ref": "./examples/EventSubscriptions_DeleteForSubscription.json" + }, + "EventSubscriptions_DeleteForResourceGroup": { + "$ref": "./examples/EventSubscriptions_DeleteForResourceGroup.json" + }, + "EventSubscriptions_DeleteForResource": { + "$ref": "./examples/EventSubscriptions_DeleteForResource.json" + }, + "EventSubscriptions_DeleteForCustomTopic": { + "$ref": "./examples/EventSubscriptions_DeleteForCustomTopic.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Update an event subscription.", + "description": "Asynchronously updates an existing event subscription.", + "operationId": "EventSubscriptions_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "scope", + "in": "path", + "description": "The scope of existing event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true + }, + { + "name": "eventSubscriptionName", + "in": "path", + "description": "Name of the event subscription to be updated.", + "required": true, + "type": "string" + }, + { + "name": "eventSubscriptionUpdateParameters", + "in": "body", + "description": "Updated event subscription information.", + "required": true, + "schema": { + "$ref": "#/definitions/EventSubscriptionUpdateParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "EventSubscription update request accepted.", + "schema": { + "$ref": "#/definitions/EventSubscription" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventSubscriptions_UpdateForSubscription": { + "$ref": "./examples/EventSubscriptions_UpdateForSubscription.json" + }, + "EventSubscriptions_UpdateForResourceGroup": { + "$ref": "./examples/EventSubscriptions_UpdateForResourceGroup.json" + }, + "EventSubscriptions_UpdateForResource": { + "$ref": "./examples/EventSubscriptions_UpdateForResource.json" + }, + "EventSubscriptions_UpdateForCustomTopic": { + "$ref": "./examples/EventSubscriptions_UpdateForCustomTopic.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions/{eventSubscriptionName}": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Get an event subscription of a system topic.", + "description": "Get an event subscription.", + "operationId": "SystemTopicEventSubscriptions_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "systemTopicName", + "in": "path", + "description": "Name of the system topic.", + "required": true, + "type": "string" + }, + { + "name": "eventSubscriptionName", + "in": "path", + "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscription" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "SystemTopicEventSubscriptions_Get": { + "$ref": "./examples/SystemTopicEventSubscriptions_Get.json" + } + } + }, + "put": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Create or update an event subscription for a system topic.", + "description": "Asynchronously creates or updates an event subscription with the specified parameters. Existing event subscriptions will be updated with this API.", + "operationId": "SystemTopicEventSubscriptions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "systemTopicName", + "in": "path", + "description": "Name of the system topic.", + "required": true, + "type": "string" + }, + { + "name": "eventSubscriptionName", + "in": "path", + "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "required": true, + "type": "string" + }, + { + "name": "eventSubscriptionInfo", + "in": "body", + "description": "Event subscription properties containing the destination and filter information.", + "required": true, + "schema": { + "$ref": "#/definitions/EventSubscription" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/EventSubscription" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "SystemTopicEventSubscriptions_CreateOrUpdate": { + "$ref": "./examples/SystemTopicEventSubscriptions_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Delete an event subscription of a system topic.", + "description": "Delete an event subscription of a system topic.", + "operationId": "SystemTopicEventSubscriptions_Delete", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "systemTopicName", + "in": "path", + "description": "Name of the system topic.", + "required": true, + "type": "string" + }, + { + "name": "eventSubscriptionName", + "in": "path", + "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "SystemTopicEventSubscriptions_Delete": { + "$ref": "./examples/SystemTopicEventSubscriptions_Delete.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Update event subscription of a system topic.", + "description": "Update event subscription of a system topic.", + "operationId": "SystemTopicEventSubscriptions_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "systemTopicName", + "in": "path", + "description": "Name of the system topic.", + "required": true, + "type": "string" + }, + { + "name": "eventSubscriptionName", + "in": "path", + "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "required": true, + "type": "string" + }, + { + "name": "eventSubscriptionUpdateParameters", + "in": "body", + "description": "Updated event subscription information.", + "required": true, + "schema": { + "$ref": "#/definitions/EventSubscriptionUpdateParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/EventSubscription" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "SystemTopicEventSubscriptions_Update": { + "$ref": "./examples/SystemTopicEventSubscriptions_Update.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions/{eventSubscriptionName}/getFullUrl": { + "post": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Get full URL of an event subscription of a system topic", + "description": "Get the full endpoint URL for an event subscription of a system topic.", + "operationId": "SystemTopicEventSubscriptions_GetFullUrl", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "systemTopicName", + "in": "path", + "description": "Name of the system topic.", + "required": true, + "type": "string" + }, + { + "name": "eventSubscriptionName", + "in": "path", + "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionFullUrl" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "SystemTopicEventSubscriptions_GetFullUrl": { + "$ref": "./examples/SystemTopicEventSubscriptions_GetFullUrl.json" + } + } + } + }, + "/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}/getFullUrl": { + "post": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Get full URL of an event subscription.", + "description": "Get the full endpoint URL for an event subscription.", + "operationId": "EventSubscriptions_GetFullUrl", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "scope", + "in": "path", + "description": "The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true + }, + { + "name": "eventSubscriptionName", + "in": "path", + "description": "Name of the event subscription.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionFullUrl" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventSubscriptions_GetFullUrlForSubscription": { + "$ref": "./examples/EventSubscriptions_GetFullUrlForSubscription.json" + }, + "EventSubscriptions_GetFullUrlForResourceGroup": { + "$ref": "./examples/EventSubscriptions_GetFullUrlForResourceGroup.json" + }, + "EventSubscriptions_GetFullUrlForResource": { + "$ref": "./examples/EventSubscriptions_GetFullUrlForResource.json" + }, + "EventSubscriptions_GetFullUrlForCustomTopic": { + "$ref": "./examples/EventSubscriptions_GetFullUrlForCustomTopic.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "List event subscriptions of a system topic.", + "description": "List event subscriptions that belong to a specific system topic.", + "operationId": "SystemTopicEventSubscriptions_ListBySystemTopic", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "systemTopicName", + "in": "path", + "description": "Name of the system topic.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "SystemTopicEventSubscriptions_ListBySystemTopic": { + "$ref": "./examples/SystemTopicEventSubscriptions_ListBySystemTopic.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions/{eventSubscriptionName}": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Get an event subscription of a partner topic.", + "description": "Get an event subscription of a partner topic.", + "operationId": "PartnerTopicEventSubscriptions_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "partnerTopicName", + "in": "path", + "description": "Name of the partner topic.", + "required": true, + "type": "string" + }, + { + "name": "eventSubscriptionName", + "in": "path", + "description": "Name of the event subscription to be found. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscription" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PartnerTopicEventSubscriptions_Get": { + "$ref": "./examples/PartnerTopicEventSubscriptions_Get.json" + } + } + }, + "put": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Create or update an event subscription of a partner topic.", + "description": "Asynchronously creates or updates an event subscription of a partner topic with the specified parameters. Existing event subscriptions will be updated with this API.", + "operationId": "PartnerTopicEventSubscriptions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "partnerTopicName", + "in": "path", + "description": "Name of the partner topic.", + "required": true, + "type": "string" + }, + { + "name": "eventSubscriptionName", + "in": "path", + "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "required": true, + "type": "string" + }, + { + "name": "eventSubscriptionInfo", + "in": "body", + "description": "Event subscription properties containing the destination and filter information.", + "required": true, + "schema": { + "$ref": "#/definitions/EventSubscription" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/EventSubscription" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PartnerTopicEventSubscriptions_CreateOrUpdate": { + "$ref": "./examples/PartnerTopicEventSubscriptions_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Delete an event subscription of a partner topic.", + "description": "Delete an event subscription of a partner topic.", + "operationId": "PartnerTopicEventSubscriptions_Delete", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "partnerTopicName", + "in": "path", + "description": "Name of the partner topic.", + "required": true, + "type": "string" + }, + { + "name": "eventSubscriptionName", + "in": "path", + "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PartnerTopicEventSubscriptions_Delete": { + "$ref": "./examples/PartnerTopicEventSubscriptions_Delete.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Update event subscription of a partner topic.", + "description": "Update event subscription of a partner topic.", + "operationId": "PartnerTopicEventSubscriptions_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "partnerTopicName", + "in": "path", + "description": "Name of the partner topic.", + "required": true, + "type": "string" + }, + { + "name": "eventSubscriptionName", + "in": "path", + "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "required": true, + "type": "string" + }, + { + "name": "eventSubscriptionUpdateParameters", + "in": "body", + "description": "Updated event subscription information.", + "required": true, + "schema": { + "$ref": "#/definitions/EventSubscriptionUpdateParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/EventSubscription" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PartnerTopicEventSubscriptions_Update": { + "$ref": "./examples/PartnerTopicEventSubscriptions_Update.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions/{eventSubscriptionName}/getFullUrl": { + "post": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Get full URL of an event subscription of a partner topic.", + "description": "Get the full endpoint URL for an event subscription of a partner topic.", + "operationId": "PartnerTopicEventSubscriptions_GetFullUrl", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "partnerTopicName", + "in": "path", + "description": "Name of the partner topic.", + "required": true, + "type": "string" + }, + { + "name": "eventSubscriptionName", + "in": "path", + "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionFullUrl" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PartnerTopicEventSubscriptions_GetFullUrl": { + "$ref": "./examples/PartnerTopicEventSubscriptions_GetFullUrl.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "List event subscriptions of a partner topic.", + "description": "List event subscriptions that belong to a specific partner topic.", + "operationId": "PartnerTopicEventSubscriptions_ListByPartnerTopic", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "partnerTopicName", + "in": "path", + "description": "Name of the partner topic.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PartnerTopicEventSubscriptions_ListByPartnerTopic": { + "$ref": "./examples/PartnerTopicEventSubscriptions_ListByPartnerTopic.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Get an aggregated list of all global event subscriptions under an Azure subscription.", + "description": "List all aggregated global event subscriptions under a specific Azure subscription.", + "operationId": "EventSubscriptions_ListGlobalBySubscription", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventSubscriptions_ListGlobalBySubscription": { + "$ref": "./examples/EventSubscriptions_ListGlobalBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "List all global event subscriptions for a topic type.", + "description": "List all global event subscriptions under an Azure subscription for a topic type.", + "operationId": "EventSubscriptions_ListGlobalBySubscriptionForTopicType", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "topicTypeName", + "in": "path", + "description": "Name of the topic type.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventSubscriptions_ListGlobalBySubscriptionForTopicType": { + "$ref": "./examples/EventSubscriptions_ListGlobalBySubscriptionForTopicType.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "List all global event subscriptions under an Azure subscription and resource group.", + "description": "List all global event subscriptions under a specific Azure subscription and resource group.", + "operationId": "EventSubscriptions_ListGlobalByResourceGroup", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventSubscriptions_ListGlobalByResourceGroup": { + "$ref": "./examples/EventSubscriptions_ListGlobalByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "List all global event subscriptions under a resource group for a topic type.", + "description": "List all global event subscriptions under a resource group for a specific topic type.", + "operationId": "EventSubscriptions_ListGlobalByResourceGroupForTopicType", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "topicTypeName", + "in": "path", + "description": "Name of the topic type.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventSubscriptions_ListGlobalByResourceGroupForTopicType": { + "$ref": "./examples/EventSubscriptions_ListGlobalByResourceGroupForTopicType.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/locations/{location}/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "List all regional event subscriptions under an Azure subscription.", + "description": "List all event subscriptions from the given location under a specific Azure subscription.", + "operationId": "EventSubscriptions_ListRegionalBySubscription", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "description": "Name of the location.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventSubscriptions_ListRegionalBySubscription": { + "$ref": "./examples/EventSubscriptions_ListRegionalBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/locations/{location}/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "List all regional event subscriptions under an Azure subscription and resource group.", + "description": "List all event subscriptions from the given location under a specific Azure subscription and resource group.", + "operationId": "EventSubscriptions_ListRegionalByResourceGroup", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "location", + "in": "path", + "description": "Name of the location.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventSubscriptions_ListRegionalByResourceGroup": { + "$ref": "./examples/EventSubscriptions_ListRegionalByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/locations/{location}/topicTypes/{topicTypeName}/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "List all regional event subscriptions under an Azure subscription for a topic type.", + "description": "List all event subscriptions from the given location under a specific Azure subscription and topic type.", + "operationId": "EventSubscriptions_ListRegionalBySubscriptionForTopicType", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "description": "Name of the location.", + "required": true, + "type": "string" + }, + { + "name": "topicTypeName", + "in": "path", + "description": "Name of the topic type.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventSubscriptions_ListRegionalBySubscriptionForTopicType": { + "$ref": "./examples/EventSubscriptions_ListRegionalBySubscriptionForTopicType.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/locations/{location}/topicTypes/{topicTypeName}/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "List all regional event subscriptions under an Azure subscription and resource group for a topic type.", + "description": "List all event subscriptions from the given location under a specific Azure subscription and resource group and topic type.", + "operationId": "EventSubscriptions_ListRegionalByResourceGroupForTopicType", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "location", + "in": "path", + "description": "Name of the location.", + "required": true, + "type": "string" + }, + { + "name": "topicTypeName", + "in": "path", + "description": "Name of the topic type.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventSubscriptions_ListRegionalByResourceGroupForTopicType": { + "$ref": "./examples/EventSubscriptions_ListRegionalByResourceGroupForTopicType.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerNamespace}/{resourceTypeName}/{resourceName}/providers/Microsoft.EventGrid/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "List all event subscriptions for a specific topic.", + "description": "List all event subscriptions that have been created for a specific topic.", + "operationId": "EventSubscriptions_ListByResource", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "providerNamespace", + "in": "path", + "description": "Namespace of the provider of the topic.", + "required": true, + "type": "string" + }, + { + "name": "resourceTypeName", + "in": "path", + "description": "Name of the resource type.", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Name of the resource.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventSubscriptions_ListByResource": { + "$ref": "./examples/EventSubscriptions_ListByResource.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/providers/Microsoft.EventGrid/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "List all event subscriptions for a specific domain topic.", + "description": "List all event subscriptions that have been created for a specific domain topic.", + "operationId": "EventSubscriptions_ListByDomainTopic", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of the top level domain.", + "required": true, + "type": "string" + }, + { + "name": "topicName", + "in": "path", + "description": "Name of the domain topic.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventSubscriptions_ListByDomainTopic": { + "$ref": "./examples/EventSubscriptions_ListByDomainTopic.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}/getDeliveryAttributes": { + "post": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Get delivery attributes for an event subscription.", + "description": "Get all delivery attributes for an event subscription.", + "operationId": "EventSubscriptions_GetDeliveryAttributes", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "scope", + "in": "path", + "description": "The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true + }, + { + "name": "eventSubscriptionName", + "in": "path", + "description": "Name of the event subscription.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DeliveryAttributeListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventSubscriptions_GetDeliveryAttributes": { + "$ref": "./examples/EventSubscriptions_GetDeliveryAttributes.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}/eventSubscriptions/{eventSubscriptionName}/getDeliveryAttributes": { + "post": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Get delivery attributes for an event subscription.", + "description": "Get all delivery attributes for an event subscription.", + "operationId": "SystemTopicEventSubscriptions_GetDeliveryAttributes", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "systemTopicName", + "in": "path", + "description": "Name of the system topic.", + "required": true, + "type": "string" + }, + { + "name": "eventSubscriptionName", + "in": "path", + "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DeliveryAttributeListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "SystemTopicEventSubscriptions_GetDeliveryAttributes": { + "$ref": "./examples/SystemTopicEventSubscriptions_GetDeliveryAttributes.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions/{eventSubscriptionName}/getDeliveryAttributes": { + "post": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Get delivery attributes for an event subscription of a partner topic.", + "description": "Get all delivery attributes for an event subscription of a partner topic.", + "operationId": "PartnerTopicEventSubscriptions_GetDeliveryAttributes", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "partnerTopicName", + "in": "path", + "description": "Name of the partner topic.", + "required": true, + "type": "string" + }, + { + "name": "eventSubscriptionName", + "in": "path", + "description": "Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DeliveryAttributeListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PartnerTopicEventSubscriptions_GetDeliveryAttributes": { + "$ref": "./examples/PartnerTopicEventSubscriptions_GetDeliveryAttributes.json" + } + } + } + }, + "/providers/Microsoft.EventGrid/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "List available operations.", + "description": "List the available operations supported by the Microsoft.EventGrid resource provider.", + "operationId": "Operations_List", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}": { + "get": { + "tags": [ + "PartnerNamespaces" + ], + "summary": "Get a partner namespace.", + "description": "Get properties of a partner namespace.", + "operationId": "PartnerNamespaces_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "partnerNamespaceName", + "in": "path", + "description": "Name of the partner namespace.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PartnerNamespace" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PartnerNamespaces_Get": { + "$ref": "./examples/PartnerNamespaces_Get.json" + } + } + }, + "put": { + "tags": [ + "PartnerNamespaces" + ], + "summary": "Create a partner namespace.", + "description": "Asynchronously creates a new partner namespace with the specified parameters.", + "operationId": "PartnerNamespaces_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "partnerNamespaceName", + "in": "path", + "description": "Name of the partner namespace.", + "required": true, + "type": "string" + }, + { + "name": "partnerNamespaceInfo", + "in": "body", + "description": "PartnerNamespace information.", + "required": true, + "schema": { + "$ref": "#/definitions/PartnerNamespace" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/PartnerNamespace" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PartnerNamespaces_CreateOrUpdate": { + "$ref": "./examples/PartnerNamespaces_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "PartnerNamespaces" + ], + "summary": "Delete a partner namespace.", + "description": "Delete existing partner namespace.", + "operationId": "PartnerNamespaces_Delete", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "partnerNamespaceName", + "in": "path", + "description": "Name of the partner namespace.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PartnerNamespaces_Delete": { + "$ref": "./examples/PartnerNamespaces_Delete.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "PartnerNamespaces" + ], + "summary": "Update a partner namespace.", + "description": "Asynchronously updates a partner namespace with the specified parameters.", + "operationId": "PartnerNamespaces_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "partnerNamespaceName", + "in": "path", + "description": "Name of the partner namespace.", + "required": true, + "type": "string" + }, + { + "name": "partnerNamespaceUpdateParameters", + "in": "body", + "description": "Partner namespace update information.", + "required": true, + "schema": { + "$ref": "#/definitions/PartnerNamespaceUpdateParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "201": { + "description": "Partner namespace update request accepted.", + "schema": { + "$ref": "#/definitions/PartnerNamespace" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PartnerNamespaces_Update": { + "$ref": "./examples/PartnerNamespaces_Update.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerNamespaces": { + "get": { + "tags": [ + "PartnerNamespaces" + ], + "summary": "List partner namespaces under an Azure subscription.", + "description": "List all the partner namespaces under an Azure subscription.", + "operationId": "PartnerNamespaces_ListBySubscription", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PartnerNamespacesListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PartnerNamespaces_ListBySubscription": { + "$ref": "./examples/PartnerNamespaces_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces": { + "get": { + "tags": [ + "PartnerNamespaces" + ], + "summary": "List partner namespaces under a resource group.", + "description": "List all the partner namespaces under a resource group.", + "operationId": "PartnerNamespaces_ListByResourceGroup", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PartnerNamespacesListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PartnerNamespaces_ListByResourceGroup": { + "$ref": "./examples/PartnerNamespaces_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/listKeys": { + "post": { + "tags": [ + "PartnerNamespaces" + ], + "summary": "List keys for a partner namespace.", + "description": "List the two keys used to publish to a partner namespace.", + "operationId": "PartnerNamespaces_ListSharedAccessKeys", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "partnerNamespaceName", + "in": "path", + "description": "Name of the partner namespace.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PartnerNamespaceSharedAccessKeys" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PartnerNamespaces_ListSharedAccessKeys": { + "$ref": "./examples/PartnerNamespaces_ListSharedAccessKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/regenerateKey": { + "post": { + "tags": [ + "PartnerNamespaces" + ], + "summary": "Regenerate key for a partner namespace.", + "description": "Regenerate a shared access key for a partner namespace.", + "operationId": "PartnerNamespaces_RegenerateKey", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "partnerNamespaceName", + "in": "path", + "description": "Name of the partner namespace.", + "required": true, + "type": "string" + }, + { + "name": "regenerateKeyRequest", + "in": "body", + "description": "Request body to regenerate key.", + "required": true, + "schema": { + "$ref": "#/definitions/PartnerNamespaceRegenerateKeyRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PartnerNamespaceSharedAccessKeys" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PartnerNamespaces_RegenerateKey": { + "$ref": "./examples/PartnerNamespaces_RegenerateKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}": { + "get": { + "tags": [ + "PartnerRegistrations" + ], + "summary": "Get a partner registration.", + "description": "Gets a partner registration with the specified parameters.", + "operationId": "PartnerRegistrations_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "partnerRegistrationName", + "in": "path", + "description": "Name of the partner registration.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PartnerRegistration" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PartnerRegistrations_Get": { + "$ref": "./examples/PartnerRegistrations_Get.json" + } + } + }, + "put": { + "tags": [ + "PartnerRegistrations" + ], + "summary": "Create a partner registration.", + "description": "Creates a new partner registration with the specified parameters.", + "operationId": "PartnerRegistrations_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "partnerRegistrationName", + "in": "path", + "description": "Name of the partner registration.", + "required": true, + "type": "string" + }, + { + "name": "partnerRegistrationInfo", + "in": "body", + "description": "PartnerRegistration information.", + "required": true, + "schema": { + "$ref": "#/definitions/PartnerRegistration" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PartnerRegistration" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/PartnerRegistration" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PartnerRegistrations_CreateOrUpdate": { + "$ref": "./examples/PartnerRegistrations_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PartnerRegistrations" + ], + "summary": "Delete a partner registration.", + "description": "Deletes a partner registration with the specified parameters.", + "operationId": "PartnerRegistrations_Delete", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "partnerRegistrationName", + "in": "path", + "description": "Name of the partner registration.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PartnerRegistrations_Delete": { + "$ref": "./examples/PartnerRegistrations_Delete.json" + } + } + }, + "patch": { + "tags": [ + "PartnerRegistrations" + ], + "summary": "Update a partner registration.", + "description": "Updates a partner registration with the specified parameters.", + "operationId": "PartnerRegistrations_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "partnerRegistrationName", + "in": "path", + "description": "Name of the partner registration.", + "required": true, + "type": "string" + }, + { + "name": "partnerRegistrationUpdateParameters", + "in": "body", + "description": "Partner registration update information.", + "required": true, + "schema": { + "$ref": "#/definitions/PartnerRegistrationUpdateParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "201": { + "description": "Partner registration update request accepted.", + "schema": { + "$ref": "#/definitions/PartnerRegistration" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PartnerRegistrations_Update": { + "$ref": "./examples/PartnerRegistrations_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerRegistrations": { + "get": { + "tags": [ + "PartnerRegistrations" + ], + "summary": "List partner registrations under an Azure subscription.", + "description": "List all the partner registrations under an Azure subscription.", + "operationId": "PartnerRegistrations_ListBySubscription", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PartnerRegistrationsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PartnerRegistrations_ListBySubscription": { + "$ref": "./examples/PartnerRegistrations_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations": { + "get": { + "tags": [ + "PartnerRegistrations" + ], + "summary": "List partner registrations under a resource group.", + "description": "List all the partner registrations under a resource group.", + "operationId": "PartnerRegistrations_ListByResourceGroup", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PartnerRegistrationsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PartnerRegistrations_ListByResourceGroup": { + "$ref": "./examples/PartnerRegistrations_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}": { + "get": { + "tags": [ + "PartnerTopics" + ], + "summary": "Get a partner topic.", + "description": "Get properties of a partner topic.", + "operationId": "PartnerTopics_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "partnerTopicName", + "in": "path", + "description": "Name of the partner topic.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PartnerTopic" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PartnerTopics_Get": { + "$ref": "./examples/PartnerTopics_Get.json" + } + } + }, + "delete": { + "tags": [ + "PartnerTopics" + ], + "summary": "Delete a partner topic.", + "description": "Delete existing partner topic.", + "operationId": "PartnerTopics_Delete", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "partnerTopicName", + "in": "path", + "description": "Name of the partner topic.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PartnerTopics_Delete": { + "$ref": "./examples/PartnerTopics_Delete.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "PartnerTopics" + ], + "summary": "Update a partner topic.", + "description": "Asynchronously updates a partner topic with the specified parameters.", + "operationId": "PartnerTopics_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "partnerTopicName", + "in": "path", + "description": "Name of the partner topic.", + "required": true, + "type": "string" + }, + { + "name": "partnerTopicUpdateParameters", + "in": "body", + "description": "PartnerTopic update information.", + "required": true, + "schema": { + "$ref": "#/definitions/PartnerTopicUpdateParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "201": { + "description": "Partner Topic update request accepted.", + "schema": { + "$ref": "#/definitions/PartnerTopic" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PartnerTopics_Update": { + "$ref": "./examples/PartnerTopics_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerTopics": { + "get": { + "tags": [ + "PartnerTopics" + ], + "summary": "List partner topics under an Azure subscription.", + "description": "List all the partner topics under an Azure subscription.", + "operationId": "PartnerTopics_ListBySubscription", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PartnerTopicsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PartnerTopics_ListBySubscription": { + "$ref": "./examples/PartnerTopics_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics": { + "get": { + "tags": [ + "PartnerTopics" + ], + "summary": "List partner topics under a resource group.", + "description": "List all the partner topics under a resource group.", + "operationId": "PartnerTopics_ListByResourceGroup", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PartnerTopicsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PartnerTopics_ListByResourceGroup": { + "$ref": "./examples/PartnerTopics_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/activate": { + "post": { + "tags": [ + "PartnerTopics" + ], + "summary": "Activate a partner topic.", + "description": "Activate a newly created partner topic.", + "operationId": "PartnerTopics_Activate", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "partnerTopicName", + "in": "path", + "description": "Name of the partner topic.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PartnerTopic" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PartnerTopics_Activate": { + "$ref": "./examples/PartnerTopics_Activate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/deactivate": { + "post": { + "tags": [ + "PartnerTopics" + ], + "summary": "Deactivate a partner topic.", + "description": "Deactivate specific partner topic.", + "operationId": "PartnerTopics_Deactivate", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "partnerTopicName", + "in": "path", + "description": "Name of the partner topic.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PartnerTopic" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PartnerTopics_Deactivate": { + "$ref": "./examples/PartnerTopics_Deactivate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "summary": "Get a specific private endpoint connection.", + "description": "Get a specific private endpoint connection under a topic, domain, or partner namespace.", + "operationId": "PrivateEndpointConnections_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "parentType", + "in": "path", + "description": "The type of the parent resource. This can be either \\'topics\\', \\'domains\\', or \\'partnerNamespaces\\'.", + "required": true, + "type": "string", + "enum": [ + "topics", + "domains", + "partnerNamespaces" + ] + }, + { + "name": "parentName", + "in": "path", + "description": "The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).", + "required": true, + "type": "string" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection connection.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_Get": { + "$ref": "./examples/PrivateEndpointConnections_Get.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "summary": "Update a specific private endpoint connection.", + "description": "Update a specific private endpoint connection under a topic, domain or partner namespace.", + "operationId": "PrivateEndpointConnections_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "parentType", + "in": "path", + "description": "The type of the parent resource. This can be either \\'topics\\', \\'domains\\', or \\'partnerNamespaces\\'.", + "required": true, + "type": "string", + "enum": [ + "topics", + "domains", + "partnerNamespaces" + ] + }, + { + "name": "parentName", + "in": "path", + "description": "The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).", + "required": true, + "type": "string" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection connection.", + "required": true, + "type": "string" + }, + { + "name": "privateEndpointConnection", + "in": "body", + "description": "The private endpoint connection object to update.", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_Update": { + "$ref": "./examples/PrivateEndpointConnections_Update.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "summary": "Delete a specific private endpoint connection.", + "description": "Delete a specific private endpoint connection under a topic, domain, or partner namespace.", + "operationId": "PrivateEndpointConnections_Delete", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "parentType", + "in": "path", + "description": "The type of the parent resource. This can be either \\'topics\\', \\'domains\\', or \\'partnerNamespaces\\'.", + "required": true, + "type": "string", + "enum": [ + "topics", + "domains", + "partnerNamespaces" + ] + }, + { + "name": "parentName", + "in": "path", + "description": "The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).", + "required": true, + "type": "string" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection connection.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_Delete": { + "$ref": "./examples/PrivateEndpointConnections_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "summary": "Lists all private endpoint connections under a resource.", + "description": "Get all private endpoint connections under a topic, domain, or partner namespace.", + "operationId": "PrivateEndpointConnections_ListByResource", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "parentType", + "in": "path", + "description": "The type of the parent resource. This can be either \\'topics\\', \\'domains\\', or \\'partnerNamespaces\\'.", + "required": true, + "type": "string", + "enum": [ + "topics", + "domains", + "partnerNamespaces" + ] + }, + { + "name": "parentName", + "in": "path", + "description": "The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_ListByResource": { + "$ref": "./examples/PrivateEndpointConnections_ListByResource.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateLinkResources/{privateLinkResourceName}": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "summary": "Get a private link resource.", + "description": "Get properties of a private link resource.", + "operationId": "PrivateLinkResources_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "parentType", + "in": "path", + "description": "The type of the parent resource. This can be either \\'topics\\', \\'domains\\', or \\'partnerNamespaces\\'.", + "required": true, + "type": "string" + }, + { + "name": "parentName", + "in": "path", + "description": "The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).", + "required": true, + "type": "string" + }, + { + "name": "privateLinkResourceName", + "in": "path", + "description": "The name of private link resource.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PrivateLinkResources_Get": { + "$ref": "./examples/PrivateLinkResources_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "summary": "List private link resources under specific topic, domain, or partner namespace.", + "description": "List all the private link resources under a topic, domain, or partner namespace.", + "operationId": "PrivateLinkResources_ListByResource", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "parentType", + "in": "path", + "description": "The type of the parent resource. This can be either \\'topics\\', \\'domains\\', or \\'partnerNamespaces\\'.", + "required": true, + "type": "string" + }, + { + "name": "parentName", + "in": "path", + "description": "The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResourcesListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PrivateLinkResources_ListByResource": { + "$ref": "./examples/PrivateLinkResources_ListByResource.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics/{systemTopicName}": { + "get": { + "tags": [ + "SystemTopics" + ], + "summary": "Get a system topic.", + "description": "Get properties of a system topic.", + "operationId": "SystemTopics_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "systemTopicName", + "in": "path", + "description": "Name of the system topic.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SystemTopic" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "SystemTopics_Get": { + "$ref": "./examples/SystemTopics_Get.json" + } + } + }, + "put": { + "tags": [ + "SystemTopics" + ], + "summary": "Create a system topic.", + "description": "Asynchronously creates a new system topic with the specified parameters.", + "operationId": "SystemTopics_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "systemTopicName", + "in": "path", + "description": "Name of the system topic.", + "required": true, + "type": "string" + }, + { + "name": "systemTopicInfo", + "in": "body", + "description": "System Topic information.", + "required": true, + "schema": { + "$ref": "#/definitions/SystemTopic" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SystemTopic" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SystemTopic" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "SystemTopics_CreateOrUpdate": { + "$ref": "./examples/SystemTopics_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "SystemTopics" + ], + "summary": "Delete a system topic.", + "description": "Delete existing system topic.", + "operationId": "SystemTopics_Delete", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "systemTopicName", + "in": "path", + "description": "Name of the system topic.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "SystemTopics_Delete": { + "$ref": "./examples/SystemTopics_Delete.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "SystemTopics" + ], + "summary": "Update a system topic.", + "description": "Asynchronously updates a system topic with the specified parameters.", + "operationId": "SystemTopics_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "systemTopicName", + "in": "path", + "description": "Name of the system topic.", + "required": true, + "type": "string" + }, + { + "name": "systemTopicUpdateParameters", + "in": "body", + "description": "SystemTopic update information.", + "required": true, + "schema": { + "$ref": "#/definitions/SystemTopicUpdateParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "System Topic update request accepted.", + "schema": { + "$ref": "#/definitions/SystemTopic" + } + }, + "201": { + "description": "System Topic update request accepted.", + "schema": { + "$ref": "#/definitions/SystemTopic" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "SystemTopics_Update": { + "$ref": "./examples/SystemTopics_Update.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/systemTopics": { + "get": { + "tags": [ + "SystemTopics" + ], + "summary": "List system topics under an Azure subscription.", + "description": "List all the system topics under an Azure subscription.", + "operationId": "SystemTopics_ListBySubscription", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SystemTopicsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "SystemTopics_ListBySubscription": { + "$ref": "./examples/SystemTopics_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/systemTopics": { + "get": { + "tags": [ + "SystemTopics" + ], + "summary": "List system topics under a resource group.", + "description": "List all the system topics under a resource group.", + "operationId": "SystemTopics_ListByResourceGroup", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SystemTopicsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "SystemTopics_ListByResourceGroup": { + "$ref": "./examples/SystemTopics_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}": { + "get": { + "tags": [ + "Topics" + ], + "summary": "Get a topic.", + "description": "Get properties of a topic.", + "operationId": "Topics_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "topicName", + "in": "path", + "description": "Name of the topic.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Topic" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Topics_Get": { + "$ref": "./examples/Topics_Get.json" + } + } + }, + "put": { + "tags": [ + "Topics" + ], + "summary": "Create a topic.", + "description": "Asynchronously creates a new topic with the specified parameters.", + "operationId": "Topics_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "topicName", + "in": "path", + "description": "Name of the topic.", + "required": true, + "type": "string" + }, + { + "name": "topicInfo", + "in": "body", + "description": "Topic information.", + "required": true, + "schema": { + "$ref": "#/definitions/Topic" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Topic" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Topics_CreateOrUpdate": { + "$ref": "./examples/Topics_CreateOrUpdate.json" + }, + "Topics_CreateOrUpdateForAzureArc": { + "$ref": "./examples/Topics_CreateOrUpdateForAzureArc.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Topics" + ], + "summary": "Delete a topic.", + "description": "Delete existing topic.", + "operationId": "Topics_Delete", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "topicName", + "in": "path", + "description": "Name of the topic.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Topics_Delete": { + "$ref": "./examples/Topics_Delete.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Topics" + ], + "summary": "Update a topic.", + "description": "Asynchronously updates a topic with the specified parameters.", + "operationId": "Topics_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "topicName", + "in": "path", + "description": "Name of the topic.", + "required": true, + "type": "string" + }, + { + "name": "topicUpdateParameters", + "in": "body", + "description": "Topic update information.", + "required": true, + "schema": { + "$ref": "#/definitions/TopicUpdateParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "201": { + "description": "Topic update request accepted.", + "schema": { + "$ref": "#/definitions/Topic" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Topics_Update": { + "$ref": "./examples/Topics_Update.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/topics": { + "get": { + "tags": [ + "Topics" + ], + "summary": "List topics under an Azure subscription.", + "description": "List all the topics under an Azure subscription.", + "operationId": "Topics_ListBySubscription", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TopicsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Topics_ListBySubscription": { + "$ref": "./examples/Topics_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics": { + "get": { + "tags": [ + "Topics" + ], + "summary": "List topics under a resource group.", + "description": "List all the topics under a resource group.", + "operationId": "Topics_ListByResourceGroup", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TopicsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Topics_ListByResourceGroup": { + "$ref": "./examples/Topics_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/listKeys": { + "post": { + "tags": [ + "Topics" + ], + "summary": "List keys for a topic.", + "description": "List the two keys used to publish to a topic.", + "operationId": "Topics_ListSharedAccessKeys", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "topicName", + "in": "path", + "description": "Name of the topic.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TopicSharedAccessKeys" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Topics_ListSharedAccessKeys": { + "$ref": "./examples/Topics_ListSharedAccessKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/regenerateKey": { + "post": { + "tags": [ + "Topics" + ], + "summary": "Regenerate key for a topic.", + "description": "Regenerate a shared access key for a topic.", + "operationId": "Topics_RegenerateKey", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "topicName", + "in": "path", + "description": "Name of the topic.", + "required": true, + "type": "string" + }, + { + "name": "regenerateKeyRequest", + "in": "body", + "description": "Request body to regenerate key.", + "required": true, + "schema": { + "$ref": "#/definitions/TopicRegenerateKeyRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TopicSharedAccessKeys" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Topics_RegenerateKey": { + "$ref": "./examples/Topics_RegenerateKey.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerNamespace}/{resourceTypeName}/{resourceName}/providers/Microsoft.EventGrid/eventTypes": { + "get": { + "tags": [ + "Topics" + ], + "summary": "List topic event types.", + "description": "List event types for a topic.", + "operationId": "Topics_ListEventTypes", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "providerNamespace", + "in": "path", + "description": "Namespace of the provider of the topic.", + "required": true, + "type": "string" + }, + { + "name": "resourceTypeName", + "in": "path", + "description": "Name of the topic type.", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Name of the topic.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventTypesListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Topics_ListEventTypes": { + "$ref": "./examples/Topics_ListEventTypes.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/{scope}/providers/Microsoft.EventGrid/extensionTopics/default": { + "get": { + "tags": [ + "Topics" + ], + "summary": "Get properties of an extension topic.", + "description": "Get the properties of an extension topic.", + "operationId": "ExtensionTopics_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "scope", + "in": "path", + "description": "The identifier of the resource to which extension topic is queried. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for Azure resource.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ExtensionTopic" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "ExtensionTopics_Get": { + "$ref": "./examples/ExtensionTopics_Get.json" + } + } + } + }, + "/providers/Microsoft.EventGrid/topicTypes": { + "get": { + "tags": [ + "TopicTypes" + ], + "summary": "List topic types.", + "description": "List all registered topic types.", + "operationId": "TopicTypes_List", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TopicTypesListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "TopicTypes_List": { + "$ref": "./examples/TopicTypes_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}": { + "get": { + "tags": [ + "TopicTypes" + ], + "summary": "Get a topic type.", + "description": "Get information about a topic type.", + "operationId": "TopicTypes_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "topicTypeName", + "in": "path", + "description": "Name of the topic type.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TopicTypeInfo" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "TopicTypes_Get": { + "$ref": "./examples/TopicTypes_Get.json" + } + } + } + }, + "/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventTypes": { + "get": { + "tags": [ + "TopicTypes" + ], + "summary": "List event types.", + "description": "List event types for a topic type.", + "operationId": "TopicTypes_ListEventTypes", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "topicTypeName", + "in": "path", + "description": "Name of the topic type.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventTypesListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "TopicTypes_ListEventTypes": { + "$ref": "./examples/TopicTypes_ListEventTypes.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + } + }, + "definitions": { + "DomainProperties": { + "description": "Properties of the Event Grid Domain Resource.", + "type": "object", + "properties": { + "privateEndpointConnections": { + "description": "List of private endpoint connections.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "provisioningState": { + "description": "Provisioning state of the Event Grid Domain Resource.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Canceled", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DomainProvisioningState", + "modelAsString": true + } + }, + "endpoint": { + "description": "Endpoint for the Event Grid Domain Resource which is used for publishing the events.", + "type": "string", + "readOnly": true + }, + "inputSchema": { + "description": "This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource.", + "enum": [ + "EventGridSchema", + "CustomEventSchema", + "CloudEventSchemaV1_0" + ], + "type": "string", + "x-ms-enum": { + "name": "InputSchema", + "modelAsString": true + }, + "default": "EventGridSchema" + }, + "inputSchemaMapping": { + "$ref": "#/definitions/InputSchemaMapping", + "description": "Information about the InputSchemaMapping which specified the info about mapping event payload." + }, + "metricResourceId": { + "description": "Metric resource id for the Event Grid Domain Resource.", + "type": "string", + "readOnly": true + }, + "publicNetworkAccess": { + "description": "This determines if traffic is allowed over public network. By default it is enabled. \r\nYou can further restrict to specific IPs by configuring ", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + }, + "default": "Enabled" + }, + "inboundIpRules": { + "description": "This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.", + "type": "array", + "items": { + "$ref": "#/definitions/InboundIpRule" + } + }, + "disableLocalAuth": { + "description": "This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the domain.", + "default": false, + "type": "boolean" + }, + "autoCreateTopicWithFirstSubscription": { + "description": "This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource.\r\nIn this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true.\r\nWhen this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is\r\ncreated at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic\r\nby the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the\r\nflexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the\r\ndomain topic on demand if needed.", + "default": true, + "type": "boolean" + }, + "autoDeleteTopicWithLastSubscription": { + "description": "This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource.\r\nIn this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true.\r\nWhen this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope\r\nof the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed\r\n(e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full\r\ncontrol of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer\r\nresources by the user.", + "default": true, + "type": "boolean" + } + } + }, + "ResourceSku": { + "description": "Describes an EventGrid Resource Sku.", + "type": "object", + "properties": { + "name": { + "description": "The Sku name of the resource. The possible values are: Basic or Premium.", + "default": "Basic", + "enum": [ + "Basic", + "Premium" + ], + "type": "string", + "x-ms-enum": { + "name": "Sku", + "modelAsString": true + } + } + } + }, + "IdentityInfo": { + "description": "The identity information for the resource.", + "type": "object", + "properties": { + "type": { + "description": "The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity.", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": true + } + }, + "principalId": { + "description": "The principal ID of resource identity.", + "type": "string" + }, + "tenantId": { + "description": "The tenant ID of resource.", + "type": "string" + }, + "userAssignedIdentities": { + "description": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:\r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.\r\nThis property is currently not used and reserved for future usage.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserIdentityProperties" + } + } + } + }, + "InboundIpRule": { + "type": "object", + "properties": { + "ipMask": { + "description": "IP Address in CIDR notation e.g., 10.0.0.0/8.", + "type": "string" + }, + "action": { + "description": "Action to perform based on the match or no match of the IpMask.", + "enum": [ + "Allow" + ], + "type": "string", + "x-ms-enum": { + "name": "IpActionType", + "modelAsString": true + } + } + } + }, + "UserIdentityProperties": { + "description": "The information about the user identity.", + "type": "object", + "properties": { + "principalId": { + "description": "The principal id of user assigned identity.", + "type": "string" + }, + "clientId": { + "description": "The client id of user assigned identity.", + "type": "string" + } + } + }, + "Resource": { + "description": "Definition of a Resource", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified identifier of the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of the resource.", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "PrivateEndpointConnectionProperties": { + "description": "Properties of the private endpoint connection resource.", + "type": "object", + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The Private Endpoint resource for this Connection." + }, + "groupIds": { + "description": "GroupIds from the private link service resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/ConnectionState", + "description": "Details about the state of the connection." + }, + "provisioningState": { + "description": "Provisioning state of the Private Endpoint Connection.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Canceled", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceProvisioningState", + "modelAsString": true + } + } + } + }, + "PrivateEndpoint": { + "description": "PrivateEndpoint information.", + "type": "object", + "properties": { + "id": { + "description": "The ARM identifier for Private Endpoint.", + "type": "string" + } + } + }, + "ConnectionState": { + "description": "ConnectionState information.", + "type": "object", + "properties": { + "status": { + "description": "Status of the connection.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PersistedConnectionStatus", + "modelAsString": true + } + }, + "description": { + "description": "Description of the connection state.", + "type": "string" + }, + "actionsRequired": { + "description": "Actions required (if any).", + "type": "string" + } + } + }, + "JsonInputSchemaMappingProperties": { + "description": "This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema.", + "type": "object", + "properties": { + "id": { + "$ref": "#/definitions/JsonField", + "description": "The mapping information for the Id property of the Event Grid Event." + }, + "topic": { + "$ref": "#/definitions/JsonField", + "description": "The mapping information for the Topic property of the Event Grid Event." + }, + "eventTime": { + "$ref": "#/definitions/JsonField", + "description": "The mapping information for the EventTime property of the Event Grid Event." + }, + "eventType": { + "$ref": "#/definitions/JsonFieldWithDefault", + "description": "The mapping information for the EventType property of the Event Grid Event." + }, + "subject": { + "$ref": "#/definitions/JsonFieldWithDefault", + "description": "The mapping information for the Subject property of the Event Grid Event." + }, + "dataVersion": { + "$ref": "#/definitions/JsonFieldWithDefault", + "description": "The mapping information for the DataVersion property of the Event Grid Event." + } + } + }, + "JsonField": { + "description": "This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'id', 'topic' and 'eventtime' properties. This represents a field in the input event schema.", + "type": "object", + "properties": { + "sourceField": { + "description": "Name of a field in the input event schema that's to be used as the source of a mapping.", + "type": "string" + } + } + }, + "JsonFieldWithDefault": { + "description": "This is used to express the source of an input schema mapping for a single target field\r\nin the Event Grid Event schema. This is currently used in the mappings for the 'subject',\r\n'eventtype' and 'dataversion' properties. This represents a field in the input event schema\r\nalong with a default value to be used, and at least one of these two properties should be provided.", + "type": "object", + "properties": { + "sourceField": { + "description": "Name of a field in the input event schema that's to be used as the source of a mapping.", + "type": "string" + }, + "defaultValue": { + "description": "The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.", + "type": "string" + } + } + }, + "JsonInputSchemaMapping": { + "description": "This enables publishing to Event Grid using a custom input schema. This can be used to map properties from a custom input JSON schema to the Event Grid event schema.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/InputSchemaMapping" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/JsonInputSchemaMappingProperties", + "description": "JSON Properties of the input schema mapping", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "Json" + }, + "InputSchemaMapping": { + "description": "By default, Event Grid expects events to be in the Event Grid event schema. Specifying an input schema mapping enables publishing to Event Grid using a custom input schema. Currently, the only supported type of InputSchemaMapping is 'JsonInputSchemaMapping'.", + "required": [ + "inputSchemaMappingType" + ], + "type": "object", + "properties": { + "inputSchemaMappingType": { + "description": "Type of the custom mapping", + "enum": [ + "Json" + ], + "type": "string", + "x-ms-enum": { + "name": "InputSchemaMappingType", + "modelAsString": true + } + } + }, + "discriminator": "inputSchemaMappingType" + }, + "PrivateEndpointConnection": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Properties of the PrivateEndpointConnection.", + "x-ms-client-flatten": true + } + } + }, + "TrackedResource": { + "description": "Definition of a Tracked Resource.", + "required": [ + "location" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "description": "Location of the resource.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "description": "Tags of the resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Domain": { + "description": "EventGrid Domain.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DomainProperties", + "description": "Properties of the Event Grid Domain resource.", + "x-ms-client-flatten": true + }, + "sku": { + "$ref": "#/definitions/ResourceSku", + "description": "The Sku pricing tier for the Event Grid Domain resource." + }, + "identity": { + "$ref": "#/definitions/IdentityInfo", + "description": "Identity information for the Event Grid Domain resource." + }, + "systemData": { + "description": "The system metadata relating to the Event Grid Domain resource.", + "type": "object", + "readOnly": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + } + }, + "DomainUpdateParameters": { + "description": "Properties of the Domain update.", + "type": "object", + "properties": { + "tags": { + "description": "Tags of the domains resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/DomainUpdateParameterProperties", + "description": "Properties of the resource.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "#/definitions/IdentityInfo", + "description": "Identity information for the resource." + }, + "sku": { + "$ref": "#/definitions/ResourceSku", + "description": "The Sku pricing tier for the domain." + } + } + }, + "DomainUpdateParameterProperties": { + "description": "Information of domain update parameter properties.", + "type": "object", + "properties": { + "publicNetworkAccess": { + "description": "This determines if traffic is allowed over public network. By default it is enabled. \r\nYou can further restrict to specific IPs by configuring ", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + }, + "inboundIpRules": { + "description": "This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.", + "type": "array", + "items": { + "$ref": "#/definitions/InboundIpRule" + } + }, + "disableLocalAuth": { + "description": "This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the domain.", + "type": "boolean" + }, + "autoCreateTopicWithFirstSubscription": { + "description": "This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource.\r\nIn this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true.\r\nWhen this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is\r\ncreated at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic\r\nby the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the\r\nflexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the\r\ndomain topic on demand if needed.", + "type": "boolean" + }, + "autoDeleteTopicWithLastSubscription": { + "description": "This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource.\r\nIn this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true.\r\nWhen this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope\r\nof the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed\r\n(e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full\r\ncontrol of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer\r\nresources by the user.", + "type": "boolean" + } + } + }, + "DomainsListResult": { + "description": "Result of the List Domains operation", + "type": "object", + "properties": { + "value": { + "description": "A collection of Domains", + "type": "array", + "items": { + "$ref": "#/definitions/Domain" + } + }, + "nextLink": { + "description": "A link for the next page of domains", + "type": "string" + } + } + }, + "DomainSharedAccessKeys": { + "description": "Shared access keys of the Domain.", + "type": "object", + "properties": { + "key1": { + "description": "Shared access key1 for the domain.", + "type": "string" + }, + "key2": { + "description": "Shared access key2 for the domain.", + "type": "string" + } + } + }, + "DomainRegenerateKeyRequest": { + "description": "Domain regenerate share access key request.", + "required": [ + "keyName" + ], + "type": "object", + "properties": { + "keyName": { + "description": "Key name to regenerate key1 or key2.", + "type": "string" + } + } + }, + "DomainTopicProperties": { + "description": "Properties of the Domain Topic.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the domain topic.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Canceled", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DomainTopicProvisioningState", + "modelAsString": true + } + } + } + }, + "DomainTopic": { + "description": "Domain Topic.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DomainTopicProperties", + "description": "Properties of the Domain Topic.", + "readOnly": true, + "x-ms-client-flatten": true + }, + "systemData": { + "description": "The system metadata relating to Domain Topic resource.", + "type": "object", + "readOnly": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + } + }, + "DomainTopicsListResult": { + "description": "Result of the List Domain Topics operation.", + "type": "object", + "properties": { + "value": { + "description": "A collection of Domain Topics.", + "type": "array", + "items": { + "$ref": "#/definitions/DomainTopic" + } + }, + "nextLink": { + "description": "A link for the next page of domain topics.", + "type": "string" + } + } + }, + "EventChannelProperties": { + "description": "Properties of the Event Channel.", + "type": "object", + "properties": { + "source": { + "$ref": "#/definitions/EventChannelSource", + "description": "Source of the event channel. This represents a unique resource in the partner's resource model." + }, + "destination": { + "$ref": "#/definitions/EventChannelDestination", + "description": "Represents the destination of an event channel." + }, + "provisioningState": { + "description": "Provisioning state of the event channel.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Canceled", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "EventChannelProvisioningState", + "modelAsString": true + } + }, + "partnerTopicReadinessState": { + "description": "The readiness state of the corresponding partner topic.", + "enum": [ + "NotActivatedByUserYet", + "ActivatedByUser", + "DeactivatedByUser", + "DeletedByUser" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "PartnerTopicReadinessState", + "modelAsString": true + } + }, + "expirationTimeIfNotActivatedUtc": { + "format": "date-time", + "description": "Expiration time of the event channel. If this timer expires while the corresponding partner topic is never activated,\r\nthe event channel and corresponding partner topic are deleted.", + "type": "string" + }, + "filter": { + "$ref": "#/definitions/EventChannelFilter", + "description": "Information about the filter for the event channel." + }, + "partnerTopicFriendlyDescription": { + "description": "Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic.\r\nThis will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer.", + "type": "string" + } + } + }, + "EventChannelSource": { + "description": "Properties of the source of an event channel.", + "type": "object", + "properties": { + "source": { + "description": "The identifier of the resource that's the source of the events.\r\nThis represents a unique resource in the partner's resource model.", + "type": "string" + } + } + }, + "EventChannelDestination": { + "description": "Properties of the destination of an event channel.", + "type": "object", + "properties": { + "azureSubscriptionId": { + "description": "Azure subscription ID of the customer creating the event channel. The partner topic\r\nassociated with the event channel will be created under this Azure subscription.", + "type": "string" + }, + "resourceGroup": { + "description": "Azure Resource Group of the customer creating the event channel. The partner topic\r\nassociated with the event channel will be created under this resource group.", + "type": "string" + }, + "partnerTopicName": { + "description": "Name of the partner topic associated with the event channel.", + "type": "string" + } + } + }, + "EventChannelFilter": { + "description": "Filter for the Event Channel.", + "type": "object", + "properties": { + "enableAdvancedFilteringOnArrays": { + "description": "Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. The default value is either false or null.", + "default": false, + "type": "boolean" + }, + "advancedFilters": { + "description": "An array of advanced filters that are used for filtering event channels.", + "type": "array", + "items": { + "$ref": "#/definitions/AdvancedFilter" + } + } + } + }, + "NumberInAdvancedFilter": { + "description": "NumberIn Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": { + "values": { + "description": "The set of filter values.", + "type": "array", + "items": { + "format": "double", + "type": "number" + } + } + }, + "x-ms-discriminator-value": "NumberIn" + }, + "NumberNotInAdvancedFilter": { + "description": "NumberNotIn Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": { + "values": { + "description": "The set of filter values.", + "type": "array", + "items": { + "format": "double", + "type": "number" + } + } + }, + "x-ms-discriminator-value": "NumberNotIn" + }, + "NumberLessThanAdvancedFilter": { + "description": "NumberLessThan Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": { + "value": { + "format": "double", + "description": "The filter value.", + "type": "number" + } + }, + "x-ms-discriminator-value": "NumberLessThan" + }, + "NumberGreaterThanAdvancedFilter": { + "description": "NumberGreaterThan Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": { + "value": { + "format": "double", + "description": "The filter value.", + "type": "number" + } + }, + "x-ms-discriminator-value": "NumberGreaterThan" + }, + "NumberLessThanOrEqualsAdvancedFilter": { + "description": "NumberLessThanOrEquals Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": { + "value": { + "format": "double", + "description": "The filter value.", + "type": "number" + } + }, + "x-ms-discriminator-value": "NumberLessThanOrEquals" + }, + "NumberGreaterThanOrEqualsAdvancedFilter": { + "description": "NumberGreaterThanOrEquals Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": { + "value": { + "format": "double", + "description": "The filter value.", + "type": "number" + } + }, + "x-ms-discriminator-value": "NumberGreaterThanOrEquals" + }, + "BoolEqualsAdvancedFilter": { + "description": "BoolEquals Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": { + "value": { + "description": "The boolean filter value.", + "type": "boolean" + } + }, + "x-ms-discriminator-value": "BoolEquals" + }, + "StringInAdvancedFilter": { + "description": "StringIn Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": { + "values": { + "description": "The set of filter values.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "StringIn" + }, + "StringNotInAdvancedFilter": { + "description": "StringNotIn Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": { + "values": { + "description": "The set of filter values.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "StringNotIn" + }, + "StringBeginsWithAdvancedFilter": { + "description": "StringBeginsWith Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": { + "values": { + "description": "The set of filter values.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "StringBeginsWith" + }, + "StringEndsWithAdvancedFilter": { + "description": "StringEndsWith Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": { + "values": { + "description": "The set of filter values.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "StringEndsWith" + }, + "StringContainsAdvancedFilter": { + "description": "StringContains Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": { + "values": { + "description": "The set of filter values.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "StringContains" + }, + "NumberInRangeAdvancedFilter": { + "description": "NumberInRange Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": { + "values": { + "description": "The set of filter values.", + "type": "array", + "items": { + "type": "array", + "items": { + "format": "double", + "type": "number" + } + } + } + }, + "x-ms-discriminator-value": "NumberInRange" + }, + "NumberNotInRangeAdvancedFilter": { + "description": "NumberNotInRange Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": { + "values": { + "description": "The set of filter values.", + "type": "array", + "items": { + "type": "array", + "items": { + "format": "double", + "type": "number" + } + } + } + }, + "x-ms-discriminator-value": "NumberNotInRange" + }, + "StringNotBeginsWithAdvancedFilter": { + "description": "StringNotBeginsWith Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": { + "values": { + "description": "The set of filter values.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "StringNotBeginsWith" + }, + "StringNotEndsWithAdvancedFilter": { + "description": "StringNotEndsWith Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": { + "values": { + "description": "The set of filter values.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "StringNotEndsWith" + }, + "StringNotContainsAdvancedFilter": { + "description": "StringNotContains Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": { + "values": { + "description": "The set of filter values.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "StringNotContains" + }, + "IsNullOrUndefinedAdvancedFilter": { + "description": "IsNullOrUndefined Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": {}, + "x-ms-discriminator-value": "IsNullOrUndefined" + }, + "IsNotNullAdvancedFilter": { + "description": "IsNotNull Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": {}, + "x-ms-discriminator-value": "IsNotNull" + }, + "AdvancedFilter": { + "description": "This is the base type that represents an advanced filter. To configure an advanced filter, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class such as BoolEqualsAdvancedFilter, NumberInAdvancedFilter, StringEqualsAdvancedFilter etc. depending on the type of the key based on which you want to filter.", + "required": [ + "operatorType" + ], + "type": "object", + "properties": { + "operatorType": { + "description": "The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.", + "enum": [ + "NumberIn", + "NumberNotIn", + "NumberLessThan", + "NumberGreaterThan", + "NumberLessThanOrEquals", + "NumberGreaterThanOrEquals", + "BoolEquals", + "StringIn", + "StringNotIn", + "StringBeginsWith", + "StringEndsWith", + "StringContains", + "NumberInRange", + "NumberNotInRange", + "StringNotBeginsWith", + "StringNotEndsWith", + "StringNotContains", + "IsNullOrUndefined", + "IsNotNull" + ], + "type": "string", + "x-ms-enum": { + "name": "AdvancedFilterOperatorType", + "modelAsString": true + } + }, + "key": { + "description": "The field/property in the event based on which you want to filter.", + "type": "string" + } + }, + "discriminator": "operatorType" + }, + "EventChannel": { + "description": "Event Channel.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EventChannelProperties", + "description": "Properties of the EventChannel.", + "x-ms-client-flatten": true + }, + "systemData": { + "description": "The system metadata relating to Event Channel resource.", + "type": "object", + "readOnly": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + } + }, + "EventChannelsListResult": { + "description": "Result of the List Event Channels operation", + "type": "object", + "properties": { + "value": { + "description": "A collection of Event Channels", + "type": "array", + "items": { + "$ref": "#/definitions/EventChannel" + } + }, + "nextLink": { + "description": "A link for the next page of event channels", + "type": "string" + } + } + }, + "EventSubscriptionProperties": { + "description": "Properties of the Event Subscription.", + "type": "object", + "properties": { + "topic": { + "description": "Name of the topic of the event subscription.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "Provisioning state of the event subscription.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Canceled", + "Failed", + "AwaitingManualAction" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "EventSubscriptionProvisioningState", + "modelAsString": true + } + }, + "destination": { + "$ref": "#/definitions/EventSubscriptionDestination", + "description": "Information about the destination where events have to be delivered for the event subscription.\r\nUses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering." + }, + "deliveryWithResourceIdentity": { + "$ref": "#/definitions/DeliveryWithResourceIdentity", + "description": "Information about the destination where events have to be delivered for the event subscription.\r\nUses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering." + }, + "filter": { + "$ref": "#/definitions/EventSubscriptionFilter", + "description": "Information about the filter for the event subscription." + }, + "labels": { + "description": "List of user defined labels.", + "type": "array", + "items": { + "type": "string" + } + }, + "expirationTimeUtc": { + "format": "date-time", + "description": "Expiration time of the event subscription.", + "type": "string" + }, + "eventDeliverySchema": { + "description": "The event delivery schema for the event subscription.", + "default": "EventGridSchema", + "enum": [ + "EventGridSchema", + "CustomInputSchema", + "CloudEventSchemaV1_0" + ], + "type": "string", + "x-ms-enum": { + "name": "EventDeliverySchema", + "modelAsString": true + } + }, + "retryPolicy": { + "$ref": "#/definitions/RetryPolicy", + "description": "The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events." + }, + "deadLetterDestination": { + "$ref": "#/definitions/DeadLetterDestination", + "description": "The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination.\r\nUses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering." + }, + "deadLetterWithResourceIdentity": { + "$ref": "#/definitions/DeadLetterWithResourceIdentity", + "description": "The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination.\r\nUses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering." + } + } + }, + "DeliveryWithResourceIdentity": { + "description": "Information about the delivery for an event subscription with resource identity.", + "type": "object", + "properties": { + "identity": { + "$ref": "#/definitions/EventSubscriptionIdentity", + "description": "The identity to use when delivering events." + }, + "destination": { + "$ref": "#/definitions/EventSubscriptionDestination", + "description": "Information about the destination where events have to be delivered for the event subscription.\r\nUses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering." + } + } + }, + "EventSubscriptionFilter": { + "description": "Filter for the Event Subscription.", + "type": "object", + "properties": { + "subjectBeginsWith": { + "description": "An optional string to filter events for an event subscription based on a resource path prefix.\r\nThe format of this depends on the publisher of the events.\r\nWildcard characters are not supported in this path.", + "type": "string" + }, + "subjectEndsWith": { + "description": "An optional string to filter events for an event subscription based on a resource path suffix.\r\nWildcard characters are not supported in this path.", + "type": "string" + }, + "includedEventTypes": { + "description": "A list of applicable event types that need to be part of the event subscription. If it is desired to subscribe to all default event types, set the IncludedEventTypes to null.", + "type": "array", + "items": { + "type": "string" + } + }, + "isSubjectCaseSensitive": { + "description": "Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter\r\nshould be compared in a case sensitive manner.", + "default": false, + "type": "boolean" + }, + "enableAdvancedFilteringOnArrays": { + "description": "Allows advanced filters to be evaluated against an array of values instead of expecting a singular value.", + "type": "boolean" + }, + "advancedFilters": { + "description": "An array of advanced filters that are used for filtering event subscriptions.", + "type": "array", + "items": { + "$ref": "#/definitions/AdvancedFilter" + } + } + } + }, + "RetryPolicy": { + "description": "Information about the retry policy for an event subscription.", + "type": "object", + "properties": { + "maxDeliveryAttempts": { + "format": "int32", + "description": "Maximum number of delivery retry attempts for events.", + "default": 30, + "type": "integer" + }, + "eventTimeToLiveInMinutes": { + "format": "int32", + "description": "Time To Live (in minutes) for events.", + "default": 1440, + "type": "integer" + } + } + }, + "DeadLetterWithResourceIdentity": { + "description": "Information about the deadletter destination with resource identity.", + "type": "object", + "properties": { + "identity": { + "$ref": "#/definitions/EventSubscriptionIdentity", + "description": "The identity to use when dead-lettering events." + }, + "deadLetterDestination": { + "$ref": "#/definitions/DeadLetterDestination", + "description": "Information about the destination where events have to be delivered for the event subscription.\r\nUses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering." + } + } + }, + "EventSubscriptionIdentity": { + "description": "The identity information with the event subscription.", + "type": "object", + "properties": { + "type": { + "description": "The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity.", + "enum": [ + "SystemAssigned", + "UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "EventSubscriptionIdentityType", + "modelAsString": true + } + }, + "userAssignedIdentity": { + "description": "The user identity associated with the resource.", + "type": "string" + } + } + }, + "WebHookEventSubscriptionDestinationProperties": { + "description": "Information about the webhook destination properties for an event subscription.", + "type": "object", + "properties": { + "endpointUrl": { + "description": "The URL that represents the endpoint of the destination of an event subscription.", + "type": "string", + "x-ms-secret": true + }, + "endpointBaseUrl": { + "description": "The base URL that represents the endpoint of the destination of an event subscription.", + "type": "string", + "readOnly": true + }, + "maxEventsPerBatch": { + "format": "int32", + "description": "Maximum number of events per batch.", + "default": 1, + "type": "integer" + }, + "preferredBatchSizeInKilobytes": { + "format": "int32", + "description": "Preferred batch size in Kilobytes.", + "default": 64, + "type": "integer" + }, + "azureActiveDirectoryTenantId": { + "description": "The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests.", + "type": "string" + }, + "azureActiveDirectoryApplicationIdOrUri": { + "description": "The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests.", + "type": "string" + }, + "deliveryAttributeMappings": { + "description": "Delivery attribute details.", + "type": "array", + "items": { + "$ref": "#/definitions/DeliveryAttributeMapping" + } + } + } + }, + "StorageBlobDeadLetterDestinationProperties": { + "description": "Properties of the storage blob based dead letter destination.", + "type": "object", + "properties": { + "resourceId": { + "description": "The Azure Resource ID of the storage account that is the destination of the deadletter events", + "type": "string" + }, + "blobContainerName": { + "description": "The name of the Storage blob container that is the destination of the deadletter events", + "type": "string" + } + } + }, + "StaticDeliveryAttributeMappingProperties": { + "description": "Properties of static delivery attribute mapping.", + "type": "object", + "properties": { + "value": { + "description": "Value of the delivery attribute.", + "type": "string" + }, + "isSecret": { + "description": "Boolean flag to tell if the attribute contains sensitive information .", + "type": "boolean", + "default": false + } + } + }, + "StaticDeliveryAttributeMapping": { + "description": "Static delivery attribute mapping details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DeliveryAttributeMapping" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StaticDeliveryAttributeMappingProperties", + "description": "Properties of static delivery attribute mapping.", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "Static" + }, + "DynamicDeliveryAttributeMappingProperties": { + "description": "Properties of dynamic delivery attribute mapping.", + "type": "object", + "properties": { + "sourceField": { + "description": "JSON path in the event which contains attribute value.", + "type": "string" + } + } + }, + "DynamicDeliveryAttributeMapping": { + "description": "Dynamic delivery attribute mapping details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DeliveryAttributeMapping" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DynamicDeliveryAttributeMappingProperties", + "description": "Properties of dynamic delivery attribute mapping.", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "Dynamic" + }, + "DeliveryAttributeMapping": { + "description": "Delivery attribute mapping details.", + "required": [ + "type" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of the delivery attribute or header.", + "type": "string" + }, + "type": { + "description": "Type of the delivery attribute or header name.", + "enum": [ + "Static", + "Dynamic" + ], + "type": "string", + "x-ms-enum": { + "name": "DeliveryAttributeMappingType", + "modelAsString": true + } + } + }, + "discriminator": "type" + }, + "StorageBlobDeadLetterDestination": { + "description": "Information about the storage blob based dead letter destination.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DeadLetterDestination" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StorageBlobDeadLetterDestinationProperties", + "description": "The properties of the Storage Blob based deadletter destination", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "StorageBlob" + }, + "WebHookEventSubscriptionDestination": { + "description": "Information about the webhook destination for an event subscription.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventSubscriptionDestination" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/WebHookEventSubscriptionDestinationProperties", + "description": "WebHook Properties of the event subscription destination.", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "WebHook" + }, + "DeadLetterDestination": { + "description": "Information about the dead letter destination for an event subscription. To configure a deadletter destination, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class. Currently, StorageBlobDeadLetterDestination is the only class that derives from this class.", + "required": [ + "endpointType" + ], + "type": "object", + "properties": { + "endpointType": { + "description": "Type of the endpoint for the dead letter destination", + "enum": [ + "StorageBlob" + ], + "type": "string", + "x-ms-enum": { + "name": "DeadLetterEndPointType", + "modelAsString": true + } + } + }, + "discriminator": "endpointType" + }, + "EventHubEventSubscriptionDestinationProperties": { + "description": "The properties for a event hub destination.", + "type": "object", + "properties": { + "resourceId": { + "description": "The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription.", + "type": "string" + }, + "deliveryAttributeMappings": { + "description": "Delivery attribute details.", + "type": "array", + "items": { + "$ref": "#/definitions/DeliveryAttributeMapping" + } + } + } + }, + "EventHubEventSubscriptionDestination": { + "description": "Information about the event hub destination for an event subscription.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventSubscriptionDestination" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EventHubEventSubscriptionDestinationProperties", + "description": "Event Hub Properties of the event subscription destination.", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "EventHub" + }, + "StorageQueueEventSubscriptionDestinationProperties": { + "description": "The properties for a storage queue destination.", + "type": "object", + "properties": { + "resourceId": { + "description": "The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription.", + "type": "string" + }, + "queueName": { + "description": "The name of the Storage queue under a storage account that is the destination of an event subscription.", + "type": "string" + }, + "queueMessageTimeToLiveInSeconds": { + "format": "int64", + "description": "Storage queue message time to live in seconds.", + "type": "integer" + } + } + }, + "StorageQueueEventSubscriptionDestination": { + "description": "Information about the storage queue destination for an event subscription.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventSubscriptionDestination" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StorageQueueEventSubscriptionDestinationProperties", + "description": "Storage Queue Properties of the event subscription destination.", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "StorageQueue" + }, + "HybridConnectionEventSubscriptionDestinationProperties": { + "description": "The properties for a hybrid connection destination.", + "type": "object", + "properties": { + "resourceId": { + "description": "The Azure Resource ID of an hybrid connection that is the destination of an event subscription.", + "type": "string" + }, + "deliveryAttributeMappings": { + "description": "Delivery attribute details.", + "type": "array", + "items": { + "$ref": "#/definitions/DeliveryAttributeMapping" + } + } + } + }, + "HybridConnectionEventSubscriptionDestination": { + "description": "Information about the HybridConnection destination for an event subscription.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventSubscriptionDestination" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/HybridConnectionEventSubscriptionDestinationProperties", + "description": "Hybrid connection Properties of the event subscription destination.", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "HybridConnection" + }, + "ServiceBusQueueEventSubscriptionDestinationProperties": { + "description": "The properties that represent the Service Bus destination of an event subscription.", + "type": "object", + "properties": { + "resourceId": { + "description": "The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription.", + "type": "string" + }, + "deliveryAttributeMappings": { + "description": "Delivery attribute details.", + "type": "array", + "items": { + "$ref": "#/definitions/DeliveryAttributeMapping" + } + } + } + }, + "ServiceBusQueueEventSubscriptionDestination": { + "description": "Information about the service bus destination for an event subscription.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventSubscriptionDestination" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ServiceBusQueueEventSubscriptionDestinationProperties", + "description": "Service Bus Properties of the event subscription destination.", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "ServiceBusQueue" + }, + "ServiceBusTopicEventSubscriptionDestinationProperties": { + "description": "The properties that represent the Service Bus Topic destination of an event subscription.", + "type": "object", + "properties": { + "resourceId": { + "description": "The Azure Resource Id that represents the endpoint of the Service Bus Topic destination of an event subscription.", + "type": "string" + }, + "deliveryAttributeMappings": { + "description": "Delivery attribute details.", + "type": "array", + "items": { + "$ref": "#/definitions/DeliveryAttributeMapping" + } + } + } + }, + "ServiceBusTopicEventSubscriptionDestination": { + "description": "Information about the service bus topic destination for an event subscription.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventSubscriptionDestination" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ServiceBusTopicEventSubscriptionDestinationProperties", + "description": "Service Bus Topic Properties of the event subscription destination.", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "ServiceBusTopic" + }, + "AzureFunctionEventSubscriptionDestinationProperties": { + "description": "The properties that represent the Azure Function destination of an event subscription.", + "type": "object", + "properties": { + "resourceId": { + "description": "The Azure Resource Id that represents the endpoint of the Azure Function destination of an event subscription.", + "type": "string" + }, + "maxEventsPerBatch": { + "format": "int32", + "description": "Maximum number of events per batch.", + "default": 1, + "type": "integer" + }, + "preferredBatchSizeInKilobytes": { + "format": "int32", + "description": "Preferred batch size in Kilobytes.", + "default": 64, + "type": "integer" + }, + "deliveryAttributeMappings": { + "description": "Delivery attribute details.", + "type": "array", + "items": { + "$ref": "#/definitions/DeliveryAttributeMapping" + } + } + } + }, + "AzureFunctionEventSubscriptionDestination": { + "description": "Information about the azure function destination for an event subscription.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventSubscriptionDestination" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AzureFunctionEventSubscriptionDestinationProperties", + "description": "Azure Function Properties of the event subscription destination.", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "AzureFunction" + }, + "EventSubscriptionDestination": { + "description": "Information about the destination for an event subscription.", + "required": [ + "endpointType" + ], + "type": "object", + "properties": { + "endpointType": { + "description": "Type of the endpoint for the event subscription destination.", + "enum": [ + "WebHook", + "EventHub", + "StorageQueue", + "HybridConnection", + "ServiceBusQueue", + "ServiceBusTopic", + "AzureFunction" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointType", + "modelAsString": true + } + } + }, + "discriminator": "endpointType" + }, + "EventSubscription": { + "description": "Event Subscription", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EventSubscriptionProperties", + "description": "Properties of the event subscription.", + "x-ms-client-flatten": true + }, + "systemData": { + "description": "The system metadata relating to Event Subscription resource.", + "type": "object", + "readOnly": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + } + }, + "EventSubscriptionUpdateParameters": { + "description": "Properties of the Event Subscription update.", + "type": "object", + "properties": { + "destination": { + "$ref": "#/definitions/EventSubscriptionDestination", + "description": "Information about the destination where events have to be delivered for the event subscription.\r\nUses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering." + }, + "deliveryWithResourceIdentity": { + "$ref": "#/definitions/DeliveryWithResourceIdentity", + "description": "Information about the destination where events have to be delivered for the event subscription.\r\nUses the managed identity setup on the parent resource (topic / domain) to acquire the authentication tokens being used during delivery / dead-lettering." + }, + "filter": { + "$ref": "#/definitions/EventSubscriptionFilter", + "description": "Information about the filter for the event subscription." + }, + "labels": { + "description": "List of user defined labels.", + "type": "array", + "items": { + "type": "string" + } + }, + "expirationTimeUtc": { + "format": "date-time", + "description": "Information about the expiration time for the event subscription.", + "type": "string" + }, + "eventDeliverySchema": { + "description": "The event delivery schema for the event subscription.", + "enum": [ + "EventGridSchema", + "CustomInputSchema", + "CloudEventSchemaV1_0" + ], + "type": "string", + "x-ms-enum": { + "name": "EventDeliverySchema", + "modelAsString": true + } + }, + "retryPolicy": { + "$ref": "#/definitions/RetryPolicy", + "description": "The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events." + }, + "deadLetterDestination": { + "$ref": "#/definitions/DeadLetterDestination", + "description": "The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination.\r\nUses Azure Event Grid's identity to acquire the authentication tokens being used during delivery / dead-lettering." + }, + "deadLetterWithResourceIdentity": { + "$ref": "#/definitions/DeadLetterWithResourceIdentity", + "description": "The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination.\r\nUses the managed identity setup on the parent resource (topic / domain) to acquire the authentication tokens being used during delivery / dead-lettering." + } + } + }, + "EventSubscriptionFullUrl": { + "description": "Full endpoint url of an event subscription", + "type": "object", + "properties": { + "endpointUrl": { + "description": "The URL that represents the endpoint of the destination of an event subscription.", + "type": "string" + } + } + }, + "EventSubscriptionsListResult": { + "description": "Result of the List EventSubscriptions operation", + "type": "object", + "properties": { + "value": { + "description": "A collection of EventSubscriptions", + "type": "array", + "items": { + "$ref": "#/definitions/EventSubscription" + } + }, + "nextLink": { + "description": "A link for the next page of event subscriptions", + "type": "string" + } + } + }, + "DeliveryAttributeListResult": { + "description": "Result of the Get delivery attributes operation.", + "type": "object", + "properties": { + "value": { + "description": "A collection of DeliveryAttributeMapping", + "type": "array", + "items": { + "$ref": "#/definitions/DeliveryAttributeMapping" + } + } + } + }, + "OperationsListResult": { + "description": "Result of the List Operations operation", + "type": "object", + "properties": { + "value": { + "description": "A collection of operations", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + } + } + }, + "Operation": { + "description": "Represents an operation returned by the GetOperations request", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationInfo", + "description": "Display name of the operation" + }, + "origin": { + "description": "Origin of the operation", + "type": "string" + }, + "isDataAction": { + "description": "This Boolean is used to determine if the operation is a data plane action or not.", + "type": "boolean" + }, + "properties": { + "description": "Properties of the operation", + "type": "object", + "x-ms-client-flatten": true + } + } + }, + "OperationInfo": { + "description": "Information about an operation", + "type": "object", + "properties": { + "provider": { + "description": "Name of the provider", + "type": "string" + }, + "resource": { + "description": "Name of the resource type", + "type": "string" + }, + "operation": { + "description": "Name of the operation", + "type": "string" + }, + "description": { + "description": "Description of the operation", + "type": "string" + } + } + }, + "PartnerNamespaceProperties": { + "description": "Properties of the partner namespace.", + "type": "object", + "properties": { + "privateEndpointConnections": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "provisioningState": { + "description": "Provisioning state of the partner namespace.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Canceled", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "PartnerNamespaceProvisioningState", + "modelAsString": true + } + }, + "partnerRegistrationFullyQualifiedId": { + "description": "The fully qualified ARM Id of the partner registration that should be associated with this partner namespace. This takes the following format:\r\n/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.", + "type": "string" + }, + "endpoint": { + "description": "Endpoint for the partner namespace.", + "type": "string", + "readOnly": true + }, + "publicNetworkAccess": { + "description": "This determines if traffic is allowed over public network. By default it is enabled.\r\nYou can further restrict to specific IPs by configuring ", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + }, + "default": "Enabled" + }, + "inboundIpRules": { + "description": "This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.", + "type": "array", + "items": { + "$ref": "#/definitions/InboundIpRule" + } + }, + "disableLocalAuth": { + "description": "This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the partner namespace.", + "default": false, + "type": "boolean" + } + } + }, + "PartnerNamespace": { + "description": "EventGrid Partner Namespace.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PartnerNamespaceProperties", + "description": "Properties of the partner namespace.", + "x-ms-client-flatten": true + }, + "systemData": { + "description": "The system metadata relating to Partner Namespace resource.", + "type": "object", + "readOnly": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + } + }, + "PartnerNamespaceUpdateParameters": { + "description": "Properties of the PartnerNamespace update.", + "type": "object", + "properties": { + "tags": { + "description": "Tags of the partner namespace.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/PartnerNamespaceUpdateParameterProperties", + "description": "Properties of the Partner Namespace.", + "x-ms-client-flatten": true + } + } + }, + "PartnerNamespaceUpdateParameterProperties": { + "description": "Information of Partner Namespace update parameter properties.", + "type": "object", + "properties": { + "publicNetworkAccess": { + "description": "This determines if traffic is allowed over public network. By default it is enabled. \r\nYou can further restrict to specific IPs by configuring ", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + }, + "inboundIpRules": { + "description": "This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.", + "type": "array", + "items": { + "$ref": "#/definitions/InboundIpRule" + } + }, + "disableLocalAuth": { + "description": "This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the partner namespace.", + "type": "boolean" + } + } + }, + "PartnerNamespacesListResult": { + "description": "Result of the List Partner Namespaces operation", + "type": "object", + "properties": { + "value": { + "description": "A collection of partner namespaces.", + "type": "array", + "items": { + "$ref": "#/definitions/PartnerNamespace" + } + }, + "nextLink": { + "description": "A link for the next page of partner namespaces.", + "type": "string" + } + } + }, + "PartnerNamespaceSharedAccessKeys": { + "description": "Shared access keys of the partner namespace.", + "type": "object", + "properties": { + "key1": { + "description": "Shared access key1 for the partner namespace.", + "type": "string" + }, + "key2": { + "description": "Shared access key2 for the partner namespace.", + "type": "string" + } + } + }, + "PartnerNamespaceRegenerateKeyRequest": { + "description": "PartnerNamespace regenerate shared access key request.", + "required": [ + "keyName" + ], + "type": "object", + "properties": { + "keyName": { + "description": "Key name to regenerate (key1 or key2).", + "type": "string" + } + } + }, + "PartnerRegistrationProperties": { + "description": "Properties of the partner registration.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the partner registration.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Canceled", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "PartnerRegistrationProvisioningState", + "modelAsString": true + } + }, + "partnerName": { + "description": "Official name of the partner name. For example: \"Contoso\".", + "type": "string" + }, + "partnerResourceTypeName": { + "description": "Name of the partner resource type.", + "type": "string" + }, + "partnerResourceTypeDisplayName": { + "description": "Display name of the partner resource type.", + "type": "string" + }, + "partnerResourceTypeDescription": { + "description": "Short description of the partner resource type. The length of this description should not exceed 256 characters.", + "type": "string" + }, + "longDescription": { + "description": "Long description for the custom scenarios and integration to be displayed in the portal if needed.\r\nLength of this description should not exceed 2048 characters.", + "type": "string" + }, + "partnerCustomerServiceNumber": { + "description": "The customer service number of the publisher. The expected phone format should start with a '+' sign \r\nfollowed by the country code. The remaining digits are then followed. Only digits and spaces are allowed and its\r\nlength cannot exceed 16 digits including country code. Examples of valid phone numbers are: +1 515 123 4567 and\r\n+966 7 5115 2471. Examples of invalid phone numbers are: +1 (515) 123-4567, 1 515 123 4567 and +966 121 5115 24 7 551 1234 43", + "type": "string" + }, + "partnerCustomerServiceExtension": { + "description": "The extension of the customer service number of the publisher. Only digits are allowed and number of digits should not exceed 10.", + "type": "string" + }, + "customerServiceUri": { + "description": "The extension of the customer service URI of the publisher.", + "type": "string" + }, + "setupUri": { + "description": "URI of the partner website that can be used by Azure customers to setup Event Grid\r\nintegration on an event source.", + "type": "string" + }, + "logoUri": { + "description": "URI of the logo.", + "type": "string" + }, + "visibilityState": { + "description": "Visibility state of the partner registration.", + "enum": [ + "Hidden", + "PublicPreview", + "GenerallyAvailable" + ], + "type": "string", + "x-ms-enum": { + "name": "PartnerRegistrationVisibilityState", + "modelAsString": true + } + }, + "authorizedAzureSubscriptionIds": { + "description": "List of Azure subscription Ids that are authorized to create a partner namespace\r\nassociated with this partner registration. This is an optional property. Creating\r\npartner namespaces is always permitted under the same Azure subscription as the one used\r\nfor creating the partner registration.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PartnerRegistration": { + "description": "Information about a partner registration.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PartnerRegistrationProperties", + "description": "Properties of the partner registration.", + "x-ms-client-flatten": true + }, + "systemData": { + "description": "The system metadata relating to Partner Registration resource.", + "type": "object", + "readOnly": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + } + }, + "PartnerRegistrationUpdateParameters": { + "description": "Properties of the Partner Registration update.", + "type": "object", + "properties": { + "tags": { + "description": "Tags of the partner registration resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "partnerTopicTypeName": { + "description": "Name of the partner topic type.", + "type": "string" + }, + "partnerTopicTypeDisplayName": { + "description": "Display name of the partner topic type.", + "type": "string" + }, + "partnerTopicTypeDescription": { + "description": "Description of the partner topic type.", + "type": "string" + }, + "setupUri": { + "description": "URI of the partner website that can be used by Azure customers to setup Event Grid\r\nintegration on an event source.", + "type": "string" + }, + "logoUri": { + "description": "URI of the partner logo.", + "type": "string" + }, + "authorizedAzureSubscriptionIds": { + "description": "List of IDs of Azure AD applications that are authorized to create a partner namespace\r\nassociated with this partner registration. This is an optional property. Creating\r\npartner namespaces is always permitted under the same Azure subscription as the one used\r\nfor creating the partner registration.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PartnerRegistrationsListResult": { + "description": "Result of the List Partner Registrations operation.", + "type": "object", + "properties": { + "value": { + "description": "A collection of partner registrations.", + "type": "array", + "items": { + "$ref": "#/definitions/PartnerRegistration" + } + }, + "nextLink": { + "description": "A link for the next page of partner registrations.", + "type": "string" + } + } + }, + "EventTypeProperties": { + "description": "Properties of the event type", + "type": "object", + "properties": { + "displayName": { + "description": "Display name of the event type.", + "type": "string" + }, + "description": { + "description": "Description of the event type.", + "type": "string" + }, + "schemaUrl": { + "description": "Url of the schema for this event type.", + "type": "string" + }, + "isInDefaultSet": { + "description": "IsInDefaultSet flag of the event type.", + "type": "boolean" + } + } + }, + "EventType": { + "description": "Event Type for a subject under a topic", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EventTypeProperties", + "description": "Properties of the event type.", + "x-ms-client-flatten": true + } + } + }, + "PartnerTopicUpdateParameters": { + "description": "Properties of the Partner Topic update.", + "type": "object", + "properties": { + "tags": { + "description": "Tags of the Partner Topic resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "identity": { + "$ref": "#/definitions/IdentityInfo", + "description": "Identity information for the Partner Topic resource." + } + } + }, + "PartnerTopicProperties": { + "description": "Properties of the Partner Topic.", + "type": "object", + "properties": { + "source": { + "description": "Source associated with this partner topic. This represents a unique partner resource.", + "type": "string" + }, + "expirationTimeIfNotActivatedUtc": { + "format": "date-time", + "description": "Expiration time of the partner topic. If this timer expires while the partner topic is still never activated,\r\nthe partner topic and corresponding event channel are deleted.", + "type": "string" + }, + "provisioningState": { + "description": "Provisioning state of the partner topic.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Canceled", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "PartnerTopicProvisioningState", + "modelAsString": true + } + }, + "activationState": { + "description": "Activation state of the partner topic.", + "enum": [ + "NeverActivated", + "Activated", + "Deactivated" + ], + "type": "string", + "x-ms-enum": { + "name": "PartnerTopicActivationState", + "modelAsString": true + } + }, + "partnerTopicFriendlyDescription": { + "description": "Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic.\r\nThis will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer.", + "type": "string" + } + } + }, + "PartnerTopic": { + "description": "EventGrid Partner Topic.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PartnerTopicProperties", + "description": "Properties of the partner topic.", + "x-ms-client-flatten": true + }, + "systemData": { + "description": "The system metadata relating to Partner Topic resource.", + "type": "object", + "readOnly": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + }, + "identity": { + "$ref": "#/definitions/IdentityInfo", + "description": "Identity information for the Partner Topic resource." + } + } + }, + "PartnerTopicsListResult": { + "description": "Result of the List Partner Topics operation.", + "type": "object", + "properties": { + "value": { + "description": "A collection of partner topics.", + "type": "array", + "items": { + "$ref": "#/definitions/PartnerTopic" + } + }, + "nextLink": { + "description": "A link for the next page of partner topics.", + "type": "string" + } + } + }, + "EventTypesListResult": { + "description": "Result of the List Event Types operation", + "type": "object", + "properties": { + "value": { + "description": "A collection of event types", + "type": "array", + "items": { + "$ref": "#/definitions/EventType" + } + } + } + }, + "PrivateEndpointConnectionListResult": { + "description": "Result of the list of all private endpoint connections operation.", + "type": "object", + "properties": { + "value": { + "description": "A collection of private endpoint connection resources.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "description": "A link for the next page of private endpoint connection resources.", + "type": "string" + } + } + }, + "PrivateLinkResource": { + "description": "Information of the private link resource.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Properties of the private link resource.", + "x-ms-client-flatten": true + }, + "id": { + "description": "Fully qualified identifier of the resource.", + "type": "string" + }, + "name": { + "description": "Name of the resource.", + "type": "string" + }, + "type": { + "description": "Type of the resource.", + "type": "string" + } + } + }, + "PrivateLinkResourceProperties": { + "type": "object", + "properties": { + "groupId": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "requiredMembers": { + "type": "array", + "items": { + "type": "string" + } + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PrivateLinkResourcesListResult": { + "description": "Result of the List private link resources operation.", + "type": "object", + "properties": { + "value": { + "description": "A collection of private link resources", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "description": "A link for the next page of private link resources.", + "type": "string" + } + } + }, + "SystemTopicProperties": { + "description": "Properties of the System Topic.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the system topic.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Canceled", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ResourceProvisioningState", + "modelAsString": true + } + }, + "source": { + "description": "Source for the system topic.", + "type": "string" + }, + "topicType": { + "description": "TopicType for the system topic.", + "type": "string" + }, + "metricResourceId": { + "description": "Metric resource id for the system topic.", + "type": "string", + "readOnly": true + } + } + }, + "SystemTopic": { + "description": "EventGrid System Topic.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SystemTopicProperties", + "description": "Properties of the system topic.", + "x-ms-client-flatten": true + }, + "systemData": { + "description": "The system metadata relating to System Topic resource.", + "type": "object", + "readOnly": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + }, + "identity": { + "$ref": "#/definitions/IdentityInfo", + "description": "Identity information for the resource." + } + } + }, + "SystemTopicUpdateParameters": { + "description": "Properties of the System Topic update.", + "type": "object", + "properties": { + "tags": { + "description": "Tags of the system topic.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "identity": { + "$ref": "#/definitions/IdentityInfo", + "description": "Resource identity information." + } + } + }, + "SystemTopicsListResult": { + "description": "Result of the List System topics operation.", + "type": "object", + "properties": { + "value": { + "description": "A collection of system Topics.", + "type": "array", + "items": { + "$ref": "#/definitions/SystemTopic" + } + }, + "nextLink": { + "description": "A link for the next page of topics.", + "type": "string" + } + } + }, + "TopicProperties": { + "description": "Properties of the Topic.", + "type": "object", + "properties": { + "privateEndpointConnections": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "provisioningState": { + "description": "Provisioning state of the topic.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Canceled", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "TopicProvisioningState", + "modelAsString": true + } + }, + "endpoint": { + "description": "Endpoint for the topic.", + "type": "string", + "readOnly": true + }, + "inputSchema": { + "description": "This determines the format that Event Grid should expect for incoming events published to the topic.", + "enum": [ + "EventGridSchema", + "CustomEventSchema", + "CloudEventSchemaV1_0" + ], + "type": "string", + "x-ms-enum": { + "name": "InputSchema", + "modelAsString": true + }, + "default": "EventGridSchema" + }, + "inputSchemaMapping": { + "$ref": "#/definitions/InputSchemaMapping", + "description": "This enables publishing using custom event schemas. An InputSchemaMapping can be specified to map various properties of a source schema to various required properties of the EventGridEvent schema." + }, + "metricResourceId": { + "description": "Metric resource id for the topic.", + "type": "string", + "readOnly": true + }, + "publicNetworkAccess": { + "description": "This determines if traffic is allowed over public network. By default it is enabled. \r\nYou can further restrict to specific IPs by configuring ", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + }, + "default": "Enabled" + }, + "inboundIpRules": { + "description": "This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.", + "type": "array", + "items": { + "$ref": "#/definitions/InboundIpRule" + } + }, + "disableLocalAuth": { + "description": "This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the topic.", + "default": false, + "type": "boolean" + } + } + }, + "ExtendedLocation": { + "description": "Definition of an Extended Location", + "type": "object", + "properties": { + "name": { + "description": "Fully qualified name of the extended location.", + "type": "string" + }, + "type": { + "description": "Type of the extended location.", + "type": "string" + } + } + }, + "Topic": { + "description": "EventGrid Topic", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TopicProperties", + "description": "Properties of the topic.", + "x-ms-client-flatten": true + }, + "sku": { + "$ref": "#/definitions/ResourceSku", + "description": "The Sku pricing tier for the topic." + }, + "identity": { + "$ref": "#/definitions/IdentityInfo", + "description": "Identity information for the resource." + }, + "kind": { + "description": "Kind of the resource.", + "enum": [ + "Azure", + "AzureArc" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceKind", + "modelAsString": true + }, + "default": "Azure" + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "Extended location of the resource." + }, + "systemData": { + "description": "The system metadata relating to Topic resource.", + "type": "object", + "readOnly": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + } + }, + "TopicUpdateParameters": { + "description": "Properties of the Topic update", + "type": "object", + "properties": { + "tags": { + "description": "Tags of the Topic resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "identity": { + "$ref": "#/definitions/IdentityInfo", + "description": "Topic resource identity information." + }, + "properties": { + "$ref": "#/definitions/TopicUpdateParameterProperties", + "description": "Properties of the Topic resource.", + "x-ms-client-flatten": true + }, + "sku": { + "$ref": "#/definitions/ResourceSku", + "description": "The Sku pricing tier for the topic." + } + } + }, + "TopicUpdateParameterProperties": { + "description": "Information of topic update parameter properties.", + "type": "object", + "properties": { + "publicNetworkAccess": { + "description": "This determines if traffic is allowed over public network. By default it is enabled. \r\nYou can further restrict to specific IPs by configuring ", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + }, + "inboundIpRules": { + "description": "This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.", + "type": "array", + "items": { + "$ref": "#/definitions/InboundIpRule" + } + }, + "disableLocalAuth": { + "description": "This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the topic.", + "type": "boolean" + } + } + }, + "TopicsListResult": { + "description": "Result of the List Topics operation", + "type": "object", + "properties": { + "value": { + "description": "A collection of Topics", + "type": "array", + "items": { + "$ref": "#/definitions/Topic" + } + }, + "nextLink": { + "description": "A link for the next page of topics", + "type": "string" + } + } + }, + "TopicSharedAccessKeys": { + "description": "Shared access keys of the Topic", + "type": "object", + "properties": { + "key1": { + "description": "Shared access key1 for the topic.", + "type": "string" + }, + "key2": { + "description": "Shared access key2 for the topic.", + "type": "string" + } + } + }, + "TopicRegenerateKeyRequest": { + "description": "Topic regenerate share access key request", + "required": [ + "keyName" + ], + "type": "object", + "properties": { + "keyName": { + "description": "Key name to regenerate key1 or key2", + "type": "string" + } + } + }, + "ExtensionTopicProperties": { + "description": "Properties of the Extension Topic", + "type": "object", + "properties": { + "description": { + "description": "Description of the extension topic.", + "type": "string" + }, + "systemTopic": { + "description": "System topic resource id which is mapped to the source.", + "type": "string" + } + } + }, + "ExtensionTopic": { + "description": "Event grid Extension Topic. This is used for getting Event Grid related metrics for Azure resources.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ExtensionTopicProperties", + "description": "Properties of the extension topic", + "x-ms-client-flatten": true + } + } + }, + "TopicTypesListResult": { + "description": "Result of the List Topic Types operation", + "type": "object", + "properties": { + "value": { + "description": "A collection of topic types", + "type": "array", + "items": { + "$ref": "#/definitions/TopicTypeInfo" + } + } + } + }, + "TopicTypeProperties": { + "description": "Properties of a topic type.", + "type": "object", + "properties": { + "provider": { + "description": "Namespace of the provider of the topic type.", + "type": "string" + }, + "displayName": { + "description": "Display Name for the topic type.", + "type": "string" + }, + "description": { + "description": "Description of the topic type.", + "type": "string" + }, + "resourceRegionType": { + "description": "Region type of the resource.", + "enum": [ + "RegionalResource", + "GlobalResource" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceRegionType", + "modelAsString": true + } + }, + "provisioningState": { + "description": "Provisioning state of the topic type", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Canceled", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "TopicTypeProvisioningState", + "modelAsString": true + } + }, + "supportedLocations": { + "description": "List of locations supported by this topic type.", + "type": "array", + "items": { + "type": "string" + } + }, + "sourceResourceFormat": { + "description": "Source resource format.", + "type": "string" + }, + "supportedScopesForSource": { + "description": "Supported source scopes.", + "type": "array", + "items": { + "enum": [ + "Resource", + "ResourceGroup", + "AzureSubscription" + ], + "type": "string" + } + } + } + }, + "TopicTypeInfo": { + "description": "Properties of a topic type info.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TopicTypeProperties", + "description": "Properties of the topic type info", + "x-ms-client-flatten": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "required": true, + "type": "string" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Version of the API to be used with the client request.", + "required": true, + "type": "string" + }, + "FilterParameter": { + "name": "$filter", + "in": "query", + "description": "The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "TopParameter": { + "name": "$top", + "in": "query", + "description": "The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/DomainTopics_CreateOrUpdate.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/DomainTopics_CreateOrUpdate.json new file mode 100644 index 000000000000..85cea2d99df6 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/DomainTopics_CreateOrUpdate.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "domainName": "exampledomain1", + "domainTopicName": "exampledomaintopic1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "201": { + "body": { + "properties": { + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain1/topics/exampledomaintopic1", + "name": "exampledomaintopic1", + "type": "Microsoft.EventGrid/domains/topics" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/DomainTopics_Delete.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/DomainTopics_Delete.json new file mode 100644 index 000000000000..850b159c4413 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/DomainTopics_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "domainName": "exampledomain1", + "domainTopicName": "exampledomaintopic1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/DomainTopics_Get.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/DomainTopics_Get.json new file mode 100644 index 000000000000..832b42e4f7b0 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/DomainTopics_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "domainName": "exampledomain2", + "domainTopicName": "topic1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain2/topics/topic1", + "name": "topic1", + "properties": { + "provisioningState": "Succeeded" + }, + "type": "Microsoft.EventGrid/domains/topics" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/DomainTopics_ListByDomain.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/DomainTopics_ListByDomain.json new file mode 100644 index 000000000000..07021b9965b8 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/DomainTopics_ListByDomain.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "domainName": "exampledomain2", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/devexprg/providers/Microsoft.EventGrid/domains/domainCli100/topics/domainCli100topic1", + "name": "domainCli100topic1", + "properties": { + "provisioningState": "Succeeded" + }, + "type": "Microsoft.EventGrid/domains/topics" + }, + { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/devexprg/providers/Microsoft.EventGrid/domains/domainCli100/topics/domainCli100topic2", + "name": "domainCli100topic2", + "properties": { + "provisioningState": "Succeeded" + }, + "type": "Microsoft.EventGrid/domains/topics" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Domains_CreateOrUpdate.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Domains_CreateOrUpdate.json new file mode 100644 index 000000000000..e148bc951f4b --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Domains_CreateOrUpdate.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "domainName": "exampledomain1", + "api-version": "2021-06-01-preview", + "domainInfo": { + "location": "westus2", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "publicNetworkAccess": "Enabled", + "inboundIpRules": [ + { + "ipMask": "12.18.30.15", + "action": "Allow" + }, + { + "ipMask": "12.18.176.1", + "action": "Allow" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "endpoint": "https://exampledomain1.westus2-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled", + "inboundIpRules": [ + { + "ipMask": "12.18.30.15", + "action": "Allow" + }, + { + "ipMask": "12.18.176.1", + "action": "Allow" + } + ] + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain1", + "location": "westus2", + "name": "exampledomain1", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/domains" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Domains_Delete.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Domains_Delete.json new file mode 100644 index 000000000000..fe053c439ce3 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Domains_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "domainName": "exampledomain1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Domains_Get.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Domains_Get.json new file mode 100644 index 000000000000..f31a54a75120 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Domains_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "domainName": "exampledomain2", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "endpoint": "https://exampledomain2.westcentralus-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain2", + "location": "westcentralus", + "name": "exampledomain2", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/domains" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Domains_ListByResourceGroup.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Domains_ListByResourceGroup.json new file mode 100644 index 000000000000..74ba50db6a12 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Domains_ListByResourceGroup.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "endpoint": "https://exampledomain1.westus2-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain1", + "location": "westus2", + "name": "exampledomain1", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/domains" + }, + { + "properties": { + "endpoint": "https://exampledomain2.westcentralus-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain2", + "location": "westcentralus", + "name": "exampledomain2", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/domains" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Domains_ListBySubscription.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Domains_ListBySubscription.json new file mode 100644 index 000000000000..4045d12c803f --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Domains_ListBySubscription.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "endpoint": "https://exampledomain1.westus2-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain1", + "location": "westus2", + "name": "exampledomain1", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/domains" + }, + { + "properties": { + "endpoint": "https://exampledomain2.westcentralus-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain2", + "location": "westcentralus", + "name": "exampledomain2", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/domains" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Domains_ListSharedAccessKeys.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Domains_ListSharedAccessKeys.json new file mode 100644 index 000000000000..b2130ada0546 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Domains_ListSharedAccessKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "domainName": "exampledomain2", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "key1": "testKey1Value", + "key2": "testKey2Value" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Domains_RegenerateKey.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Domains_RegenerateKey.json new file mode 100644 index 000000000000..3353e6ee3401 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Domains_RegenerateKey.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "domainName": "exampledomain2", + "api-version": "2021-06-01-preview", + "regenerateKeyRequest": { + "keyName": "key1" + } + }, + "responses": { + "200": { + "body": { + "key1": "testKey1Value", + "key2": "testKey2Value" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Domains_Update.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Domains_Update.json new file mode 100644 index 000000000000..6fc61b59924b --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Domains_Update.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "domainName": "exampledomain1", + "api-version": "2021-06-01-preview", + "domainUpdateParameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "publicNetworkAccess": "Enabled", + "inboundIpRules": [ + { + "ipMask": "12.18.30.15", + "action": "Allow" + }, + { + "ipMask": "12.18.176.1", + "action": "Allow" + } + ] + } + } + }, + "responses": { + "200": {}, + "201": { + "body": { + "properties": { + "endpoint": "https://exampledomain1.westus2-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled", + "inboundIpRules": [ + { + "ipMask": "12.18.30.15", + "action": "Allow" + }, + { + "ipMask": "12.18.176.1", + "action": "Allow" + } + ] + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain1", + "location": "westus2", + "name": "exampledomain1", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/domains" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventChannels_CreateOrUpdate.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventChannels_CreateOrUpdate.json new file mode 100644 index 000000000000..3ae654c2a189 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventChannels_CreateOrUpdate.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "partnerNamespaceName": "examplePartnerNamespaceName1", + "eventChannelName": "exampleEventChannelName1", + "api-version": "2021-06-01-preview", + "eventChannelInfo": { + "properties": { + "source": { + "source": "ContosoCorp.Accounts.User1" + }, + "destination": { + "azureSubscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroup": "examplerg2", + "partnerTopicName": "examplePartnerTopic1" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "source": { + "source": "ContosoCorp.Accounts.User1" + }, + "destination": { + "azureSubscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroup": "examplerg2", + "partnerTopicName": "examplePartnerTopic1" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerNamespaces/partnerNamespace123/eventChannels/exampleEventChannelName1", + "name": "exampleEventChannelName1", + "type": "Microsoft.EventGrid/partnerNamespaces/eventChannels" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventChannels_Delete.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventChannels_Delete.json new file mode 100644 index 000000000000..224e368788a5 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventChannels_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "partnerNamespaceName": "examplePartnerNamespaceName1", + "eventChannelName": "exampleEventChannelName", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventChannels_Get.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventChannels_Get.json new file mode 100644 index 000000000000..1f57e7e14ab9 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventChannels_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "partnerNamespaceName": "examplePartnerNamespaceName1", + "eventChannelName": "exampleEventChannelName1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "source": { + "source": "ContosoCorp.Accounts.User1" + }, + "destination": { + "azureSubscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroup": "examplerg2", + "partnerTopicName": "examplePartnerTopic1" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerNamespaces/partnerNamespace123/eventChannels/exampleEventChannelName1", + "name": "exampleEventChannelName1", + "type": "Microsoft.EventGrid/partnerNamespaces/eventChannels" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventChannels_ListByPartnerNamespace.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventChannels_ListByPartnerNamespace.json new file mode 100644 index 000000000000..297d7ef956cd --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventChannels_ListByPartnerNamespace.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "partnerNamespaceName": "partnerNamespace123", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "source": { + "source": "ContosoCorp.Accounts.User1" + }, + "destination": { + "azureSubscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroup": "amh", + "partnerTopicName": "examplePartnerTopic1" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/amh/providers/Microsoft.EventGrid/partnerNamespaces/partnerNamespace123/eventChannels/eventChannel1234", + "name": "eventChannel1234", + "type": "Microsoft.EventGrid/partnerNamespaces/eventChannels" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_EventHubDestination.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_EventHubDestination.json new file mode 100644 index 000000000000..d1a6fa923b05 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_EventHubDestination.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "eventSubscriptionName": "examplesubscription1", + "eventSubscriptionInfo": { + "properties": { + "destination": { + "endpointType": "EventHub", + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1" + } + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "deadLetterDestination": { + "endpointType": "StorageBlob", + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg", + "blobContainerName": "contosocontainer" + } + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1" + }, + "endpointType": "EventHub" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "provisioningState": "Creating", + "labels": null, + "deadLetterDestination": { + "endpointType": "StorageBlob", + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg", + "blobContainerName": "contosocontainer" + } + } + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_HybridConnectionDestination.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_HybridConnectionDestination.json new file mode 100644 index 000000000000..c0184f05e893 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_HybridConnectionDestination.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "eventSubscriptionName": "examplesubscription1", + "eventSubscriptionInfo": { + "properties": { + "destination": { + "endpointType": "HybridConnection", + "properties": { + "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Relay/namespaces/ContosoNamespace/hybridConnections/HC1" + } + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "deadLetterDestination": { + "endpointType": "StorageBlob", + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg", + "blobContainerName": "contosocontainer" + } + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Relay/namespaces/ContosoNamespace/hybridConnections/HC1" + }, + "endpointType": "HybridConnection" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "provisioningState": "Creating", + "labels": null, + "deadLetterDestination": { + "endpointType": "StorageBlob", + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg", + "blobContainerName": "contosocontainer" + } + } + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_StorageQueueDestination.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_StorageQueueDestination.json new file mode 100644 index 000000000000..0218cb8ffb3d --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_StorageQueueDestination.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "eventSubscriptionName": "examplesubscription1", + "eventSubscriptionInfo": { + "properties": { + "destination": { + "endpointType": "StorageQueue", + "properties": { + "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg", + "queueName": "queue1", + "queueMessageTimeToLiveInSeconds": 300 + } + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "deadLetterDestination": { + "endpointType": "StorageBlob", + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg", + "blobContainerName": "contosocontainer" + } + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg", + "queueName": "queue1", + "queueMessageTimeToLiveInSeconds": 300 + }, + "endpointType": "StorageQueue" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "provisioningState": "Creating", + "labels": null, + "deadLetterDestination": { + "endpointType": "StorageBlob", + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg", + "blobContainerName": "contosocontainer" + } + } + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_WebhookDestination.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_WebhookDestination.json new file mode 100644 index 000000000000..f9d31fddfbf8 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_WebhookDestination.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "eventSubscriptionName": "examplesubscription1", + "eventSubscriptionInfo": { + "properties": { + "destination": { + "endpointType": "EventHub", + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1" + } + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_CreateOrUpdateForResource.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_CreateOrUpdateForResource.json new file mode 100644 index 000000000000..aba73eee5083 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_CreateOrUpdateForResource.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1", + "eventSubscriptionName": "examplesubscription10", + "api-version": "2021-06-01-preview", + "eventSubscriptionInfo": { + "properties": { + "destination": { + "endpointType": "WebHook", + "properties": { + "endpointUrl": "https://requestb.in/15ksip71" + } + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription10", + "name": "examplesubscription10", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_CreateOrUpdateForResourceGroup.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_CreateOrUpdateForResourceGroup.json new file mode 100644 index 000000000000..3e99e7035a5e --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_CreateOrUpdateForResourceGroup.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg", + "eventSubscriptionName": "examplesubscription2", + "api-version": "2021-06-01-preview", + "eventSubscriptionInfo": { + "properties": { + "destination": { + "endpointType": "WebHook", + "properties": { + "endpointUrl": "https://requestb.in/15ksip71" + } + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2", + "name": "examplesubscription2", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_CreateOrUpdateForSubscription.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_CreateOrUpdateForSubscription.json new file mode 100644 index 000000000000..808ef4ee4744 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_CreateOrUpdateForSubscription.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "eventSubscriptionName": "examplesubscription3", + "api-version": "2021-06-01-preview", + "eventSubscriptionInfo": { + "properties": { + "destination": { + "endpointType": "WebHook", + "properties": { + "endpointUrl": "https://requestb.in/15ksip71" + } + }, + "filter": { + "isSubjectCaseSensitive": false + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3", + "name": "examplesubscription3", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_DeleteForCustomTopic.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_DeleteForCustomTopic.json new file mode 100644 index 000000000000..4a4ac67289f4 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_DeleteForCustomTopic.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "eventSubscriptionName": "examplesubscription1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": {}, + "204": {}, + "200": {} + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_DeleteForResource.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_DeleteForResource.json new file mode 100644 index 000000000000..f3c81358f838 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_DeleteForResource.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1", + "eventSubscriptionName": "examplesubscription10", + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": {}, + "204": {}, + "200": {} + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_DeleteForResourceGroup.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_DeleteForResourceGroup.json new file mode 100644 index 000000000000..563917d16376 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_DeleteForResourceGroup.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg", + "eventSubscriptionName": "examplesubscription2", + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": {}, + "204": {}, + "200": {} + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_DeleteForSubscription.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_DeleteForSubscription.json new file mode 100644 index 000000000000..7d30ba89015f --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_DeleteForSubscription.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "eventSubscriptionName": "examplesubscription3", + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": {}, + "204": {}, + "200": {} + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_GetDeliveryAttributes.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_GetDeliveryAttributes.json new file mode 100644 index 000000000000..fdd30447d7ef --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_GetDeliveryAttributes.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", + "eventSubscriptionName": "examplesubscription1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "header1", + "type": "Static", + "properties": { + "value": "NormalValue", + "isSecret": false + } + }, + { + "name": "header2", + "type": "Dynamic", + "properties": { + "sourceField": "data.foo" + } + }, + { + "name": "header3", + "type": "Static", + "properties": { + "value": "mySecretValue", + "isSecret": true + } + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_GetForCustomTopic.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_GetForCustomTopic.json new file mode 100644 index 000000000000..fa4451b5adf2 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_GetForCustomTopic.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", + "eventSubscriptionName": "examplesubscription1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "label1", + "label2" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_GetForResource.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_GetForResource.json new file mode 100644 index 000000000000..0ef6cc0941b5 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_GetForResource.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1", + "eventSubscriptionName": "examplesubscription1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "destination": { + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1" + }, + "endpointType": "EventHub" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "label1", + "label2" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_GetForResourceGroup.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_GetForResourceGroup.json new file mode 100644 index 000000000000..ace21db9229d --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_GetForResourceGroup.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg", + "eventSubscriptionName": "examplesubscription2", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "label1", + "label2" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2", + "name": "examplesubscription2", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_GetForSubscription.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_GetForSubscription.json new file mode 100644 index 000000000000..c925aaf3e392 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_GetForSubscription.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "eventSubscriptionName": "examplesubscription3", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "label1", + "label2" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3", + "name": "examplesubscription3", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_GetFullUrlForCustomTopic.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_GetFullUrlForCustomTopic.json new file mode 100644 index 000000000000..3d2c67eafa3e --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_GetFullUrlForCustomTopic.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", + "eventSubscriptionName": "examplesubscription1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "endpointUrl": "https://requestb.in/15ksip71" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_GetFullUrlForResource.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_GetFullUrlForResource.json new file mode 100644 index 000000000000..dba9fbb9daa9 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_GetFullUrlForResource.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1", + "eventSubscriptionName": "examplesubscription1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "endpointUrl": "https://requestb.in/15ksip71" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_GetFullUrlForResourceGroup.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_GetFullUrlForResourceGroup.json new file mode 100644 index 000000000000..da5399e77d9e --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_GetFullUrlForResourceGroup.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg", + "eventSubscriptionName": "examplesubscription2", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "endpointUrl": "https://requestb.in/15ksip71" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_GetFullUrlForSubscription.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_GetFullUrlForSubscription.json new file mode 100644 index 000000000000..51b7a5fdc904 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_GetFullUrlForSubscription.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "eventSubscriptionName": "examplesubscription3", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "endpointUrl": "https://requestb.in/15ksip71" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_ListByDomainTopic.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_ListByDomainTopic.json new file mode 100644 index 000000000000..b24989918384 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_ListByDomainTopic.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "domainName": "domain1", + "topicName": "topic1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/domains/domain1/topics/topic1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/domain1/topics/topic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/eventSubscriptions" + }, + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/domains/domain1/topics/topic1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/domain1/topics/topic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2", + "name": "examplesubscription2", + "type": "Microsoft.EventGrid/eventSubscriptions" + }, + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "labels": [], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/domains/domain1/topics/topic1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/domain1/topics/topic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3", + "name": "examplesubscription3", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_ListByResource.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_ListByResource.json new file mode 100644 index 000000000000..e4cb02bea1ec --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_ListByResource.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerNamespace": "Microsoft.EventGrid", + "resourceTypeName": "topics", + "resourceName": "exampletopic2", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/eventSubscriptions" + }, + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2", + "name": "examplesubscription2", + "type": "Microsoft.EventGrid/eventSubscriptions" + }, + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "labels": [], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3", + "name": "examplesubscription3", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_ListGlobalByResourceGroup.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_ListGlobalByResourceGroup.json new file mode 100644 index 000000000000..faac65a36e7b --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_ListGlobalByResourceGroup.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2", + "name": "examplesubscription2", + "type": "Microsoft.EventGrid/eventSubscriptions" + }, + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription4", + "name": "examplesubscription4", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_ListGlobalByResourceGroupForTopicType.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_ListGlobalByResourceGroupForTopicType.json new file mode 100644 index 000000000000..93d8a6dbfb3d --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_ListGlobalByResourceGroupForTopicType.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "topicTypeName": "Microsoft.Resources.ResourceGroups", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "Finance", + "HR" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3", + "name": "examplesubscription3", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_ListGlobalBySubscription.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_ListGlobalBySubscription.json new file mode 100644 index 000000000000..faa9f7b681d9 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_ListGlobalBySubscription.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2", + "name": "examplesubscription2", + "type": "Microsoft.EventGrid/eventSubscriptions" + }, + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription4", + "name": "examplesubscription4", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_ListGlobalBySubscriptionForTopicType.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_ListGlobalBySubscriptionForTopicType.json new file mode 100644 index 000000000000..a441ca98312c --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_ListGlobalBySubscriptionForTopicType.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "topicTypeName": "Microsoft.Resources.Subscriptions", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "Finance", + "HR" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3", + "name": "examplesubscription3", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_ListRegionalByResourceGroup.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_ListRegionalByResourceGroup.json new file mode 100644 index 000000000000..1cf126e8c808 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_ListRegionalByResourceGroup.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "location": "westus2", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "Finance", + "HR" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription10", + "name": "examplesubscription10", + "type": "Microsoft.EventGrid/eventSubscriptions" + }, + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "Finance", + "HR" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription11", + "name": "examplesubscription11", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_ListRegionalByResourceGroupForTopicType.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_ListRegionalByResourceGroupForTopicType.json new file mode 100644 index 000000000000..e04f42f422d1 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_ListRegionalByResourceGroupForTopicType.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "location": "westus2", + "topicTypeName": "Microsoft.EventHub.namespaces", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "Finance", + "HR" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription10", + "name": "examplesubscription10", + "type": "Microsoft.EventGrid/eventSubscriptions" + }, + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "Finance", + "HR" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription11", + "name": "examplesubscription11", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_ListRegionalBySubscription.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_ListRegionalBySubscription.json new file mode 100644 index 000000000000..a43e26350d00 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_ListRegionalBySubscription.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "location": "westus2", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "destination": { + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1" + }, + "endpointType": "EventHub" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "Finance", + "HR" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription10", + "name": "examplesubscription10", + "type": "Microsoft.EventGrid/eventSubscriptions" + }, + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "Finance", + "HR" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription11", + "name": "examplesubscription11", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_ListRegionalBySubscriptionForTopicType.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_ListRegionalBySubscriptionForTopicType.json new file mode 100644 index 000000000000..c62c8338d267 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_ListRegionalBySubscriptionForTopicType.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "location": "westus2", + "topicTypeName": "Microsoft.EventHub.namespaces", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "Finance", + "HR" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription10", + "name": "examplesubscription10", + "type": "Microsoft.EventGrid/eventSubscriptions" + }, + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "Finance", + "HR" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription11", + "name": "examplesubscription11", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_UpdateForCustomTopic.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_UpdateForCustomTopic.json new file mode 100644 index 000000000000..031691c65eef --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_UpdateForCustomTopic.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", + "eventSubscriptionName": "examplesubscription1", + "api-version": "2021-06-01-preview", + "eventSubscriptionUpdateParameters": { + "destination": { + "endpointType": "WebHook", + "properties": { + "endpointUrl": "https://requestb.in/15ksip71" + } + }, + "filter": { + "isSubjectCaseSensitive": true, + "subjectBeginsWith": "existingPrefix", + "subjectEndsWith": "newSuffix" + }, + "labels": [ + "label1", + "label2" + ] + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": true, + "subjectBeginsWith": "existingPrefix", + "subjectEndsWith": "newSuffix" + }, + "labels": [ + "label1", + "label2" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_UpdateForResource.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_UpdateForResource.json new file mode 100644 index 000000000000..ec139092d6c3 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_UpdateForResource.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1", + "eventSubscriptionName": "examplesubscription1", + "api-version": "2021-06-01-preview", + "eventSubscriptionUpdateParameters": { + "destination": { + "endpointType": "WebHook", + "properties": { + "endpointUrl": "https://requestb.in/15ksip71" + } + }, + "filter": { + "isSubjectCaseSensitive": true, + "subjectBeginsWith": "existingPrefix", + "subjectEndsWith": "newSuffix" + }, + "labels": [ + "label1", + "label2" + ] + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": true, + "subjectBeginsWith": "existingPrefix", + "subjectEndsWith": "newSuffix" + }, + "labels": [], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_UpdateForResourceGroup.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_UpdateForResourceGroup.json new file mode 100644 index 000000000000..5fc6d9ef0692 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_UpdateForResourceGroup.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg", + "eventSubscriptionName": "examplesubscription2", + "api-version": "2021-06-01-preview", + "eventSubscriptionUpdateParameters": { + "destination": { + "endpointType": "EventHub", + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1" + } + }, + "filter": { + "isSubjectCaseSensitive": true, + "subjectBeginsWith": "existingPrefix", + "subjectEndsWith": "newSuffix" + }, + "labels": [ + "label1", + "label2" + ] + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": true, + "subjectBeginsWith": "existingPrefix", + "subjectEndsWith": "newSuffix" + }, + "labels": [], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2", + "name": "examplesubscription2", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_UpdateForSubscription.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_UpdateForSubscription.json new file mode 100644 index 000000000000..59d570fc1ecc --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/EventSubscriptions_UpdateForSubscription.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "eventSubscriptionName": "examplesubscription3", + "api-version": "2021-06-01-preview", + "eventSubscriptionUpdateParameters": { + "destination": { + "endpointType": "WebHook", + "properties": { + "endpointUrl": "https://requestb.in/15ksip71" + } + }, + "filter": { + "isSubjectCaseSensitive": true, + "subjectBeginsWith": "existingPrefix", + "subjectEndsWith": "newSuffix" + }, + "labels": [ + "label1", + "label2" + ] + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": true, + "subjectBeginsWith": "existingPrefix", + "subjectEndsWith": "newSuffix" + }, + "labels": [], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3", + "name": "examplesubscription3", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/ExtensionTopics_Get.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/ExtensionTopics_Get.json new file mode 100644 index 000000000000..9a3a9ef9da81 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/ExtensionTopics_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.storage/storageaccounts/exampleResourceName/providers/Microsoft.eventgrid/extensionTopics/default", + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerNamespace": "microsoft.storage", + "resourceTypeName": "storageaccounts", + "resourceName": "exampleResourceName", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "Extension topic for /subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.storage/storageaccounts/exampleResourceName/providers/Microsoft.eventgrid/extensionTopics/default that can be used to obtain metrics", + "systemTopic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleResourceName-2a41650f-00dd-4790-b3ab-dabd12d227cb" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.storage/storageaccounts/exampleResourceName/providers/Microsoft.eventgrid/extensionTopics/default", + "name": "default", + "type": "providers/Microsoft.EventGrid/extensionTopics" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Operations_List.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..ed591760d6c5 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Operations_List.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.EventGrid/register/action", + "display": { + "provider": "Microsoft Event Grid", + "resource": "EventGrid Resource Provider", + "operation": "Registers the EventGrid Resource Provider", + "description": "Registers the eventSubscription for the EventGrid resource provider and enables the creation of Event Grid subscriptions." + }, + "origin": "UserAndSystem" + }, + { + "name": "Microsoft.EventGrid/eventSubscriptions/write", + "display": { + "provider": "Microsoft Event Grid", + "resource": "eventSubscriptions", + "operation": "Write EventSubscription", + "description": "Create or update a eventSubscription" + }, + "origin": "UserAndSystem" + }, + { + "name": "Microsoft.EventGrid/eventSubscriptions/read", + "display": { + "provider": "Microsoft Event Grid", + "resource": "eventSubscriptions", + "operation": "Read EventSubscription", + "description": "Read a eventSubscription" + }, + "origin": "UserAndSystem" + }, + { + "name": "Microsoft.EventGrid/eventSubscriptions/delete", + "display": { + "provider": "Microsoft Event Grid", + "resource": "eventSubscriptions", + "operation": "Delete EventSubscription", + "description": "Delete a eventSubscription" + }, + "origin": "UserAndSystem" + }, + { + "name": "Microsoft.EventGrid/topics/write", + "display": { + "provider": "Microsoft Event Grid", + "resource": "topics", + "operation": "Write Topic", + "description": "Create or update a topic" + }, + "origin": "UserAndSystem" + }, + { + "name": "Microsoft.EventGrid/topics/read", + "display": { + "provider": "Microsoft Event Grid", + "resource": "topics", + "operation": "Read Topic", + "description": "Read a topic" + }, + "origin": "UserAndSystem" + }, + { + "name": "Microsoft.EventGrid/topics/delete", + "display": { + "provider": "Microsoft Event Grid", + "resource": "topics", + "operation": "Delete Topic", + "description": "Delete a topic" + }, + "origin": "UserAndSystem" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerNamespaces_CreateOrUpdate.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerNamespaces_CreateOrUpdate.json new file mode 100644 index 000000000000..40d4a5d92bc1 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerNamespaces_CreateOrUpdate.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "partnerNamespaceName": "examplePartnerNamespaceName1", + "api-version": "2021-06-01-preview", + "partnerNamespaceInfo": { + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "partnerRegistrationFullyQualifiedId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerRegistrations/ContosoCorpAccount1" + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "partnerRegistrationFullyQualifiedId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerRegistrations/ContosoCorpAccount1", + "endpoint": "https://examplePartnerNamespaceName1.centraluseuap-1.eventgrid.azure.net/api/events" + }, + "location": "westus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerNamespaces/examplePartnerNamespaceName1", + "name": "examplePartnerNamespaceName1", + "type": "Microsoft.EventGrid/partnerNamespaces" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerNamespaces_Delete.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerNamespaces_Delete.json new file mode 100644 index 000000000000..574a24996c4b --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerNamespaces_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "partnerNamespaceName": "examplePartnerNamespaceName1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerNamespaces_Get.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerNamespaces_Get.json new file mode 100644 index 000000000000..ae366db7bc74 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerNamespaces_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "partnerNamespaceName": "examplePartnerNamespaceName1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "partnerRegistrationFullyQualifiedId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerRegistrations/ContosoCorpAccount1", + "endpoint": "https://examplePartnerNamespaceName1.centraluseuap-1.eventgrid.azure.net/api/events" + }, + "location": "Central US EUAP", + "tags": { + "key1": "value1", + "key2": "value2", + "key3": "value3" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerNamespaces/examplePartnerNamespaceName1", + "name": "examplePartnerNamespaceName1", + "type": "Microsoft.EventGrid/partnerNamespaces" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerNamespaces_ListByResourceGroup.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerNamespaces_ListByResourceGroup.json new file mode 100644 index 000000000000..a14d550f71bf --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerNamespaces_ListByResourceGroup.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "partnerRegistrationFullyQualifiedId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerRegistrations/ContosoCorpAccount1", + "endpoint": "https://partnernamespace123.centraluseuap-1.eventgrid.azure.net/api/events" + }, + "location": "Central US EUAP", + "tags": { + "key1": "value1", + "key2": "value2", + "key3": "value3" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerNamespaces/partnerNamespace123", + "name": "partnerNamespace123", + "type": "Microsoft.EventGrid/partnerNamespaces" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerNamespaces_ListBySubscription.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerNamespaces_ListBySubscription.json new file mode 100644 index 000000000000..42e0ec79db37 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerNamespaces_ListBySubscription.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "partnerRegistrationFullyQualifiedId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/amh/providers/Microsoft.EventGrid/partnerRegistrations/ContosoCorpAccount1", + "endpoint": "https://partnernamespace123.centraluseuap-1.eventgrid.azure.net/api/events" + }, + "location": "Central US EUAP", + "tags": { + "key1": "value1", + "key2": "value2", + "key3": "value3" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/amh/providers/Microsoft.EventGrid/partnerNamespaces/partnerNamespace123", + "name": "partnerNamespace123", + "type": "Microsoft.EventGrid/partnerNamespaces" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerNamespaces_ListSharedAccessKeys.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerNamespaces_ListSharedAccessKeys.json new file mode 100644 index 000000000000..ddb4feae4189 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerNamespaces_ListSharedAccessKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "partnerNamespaceName": "examplePartnerNamespaceName1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "key1": "testKey1Value", + "key2": "testKey2Value" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerNamespaces_RegenerateKey.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerNamespaces_RegenerateKey.json new file mode 100644 index 000000000000..0f9c8b73234d --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerNamespaces_RegenerateKey.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "partnerNamespaceName": "examplePartnerNamespaceName1", + "api-version": "2021-06-01-preview", + "regenerateKeyRequest": { + "keyName": "key1" + } + }, + "responses": { + "200": { + "body": { + "key1": "testKey1Value", + "key2": "testKey2Value" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerNamespaces_Update.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerNamespaces_Update.json new file mode 100644 index 000000000000..3dc39b928401 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerNamespaces_Update.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "partnerNamespaceName": "examplePartnerNamespaceName1", + "api-version": "2021-06-01-preview", + "partnerNamespaceUpdateParameters": { + "tags": { + "tag1": "value1" + } + } + }, + "responses": { + "200": {}, + "201": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "partnerRegistrationFullyQualifiedId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerRegistrations/ContosoCorpAccount1", + "endpoint": "https://examplePartnerNamespaceName1.centraluseuap-1.eventgrid.azure.net/api/events" + }, + "location": "Central US EUAP", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerNamespaces/examplePartnerNamespaceName1", + "name": "examplePartnerNamespaceName1", + "type": "Microsoft.EventGrid/partnerNamespaces" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerRegistrations_CreateOrUpdate.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerRegistrations_CreateOrUpdate.json new file mode 100644 index 000000000000..06558ceee3a3 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerRegistrations_CreateOrUpdate.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "partnerRegistrationName": "examplePartnerRegistrationName1", + "api-version": "2021-06-01-preview", + "partnerRegistrationInfo": { + "properties": { + "partnerName": "ContosoCorp", + "partnerResourceTypeName": "ContosoCorp.Accounts", + "partnerResourceTypeDisplayName": "ContocoCorp Accounts DisplayName Text", + "partnerResourceTypeDescription": "ContocoCorp Accounts Description Text", + "setupUri": "https://www.example.com/setup.html", + "logoUri": "https://www.example.com/logo.png", + "authorizedAzureSubscriptionIds": [ + "d48566a8-2428-4a6c-8347-9675d09fb851" + ] + }, + "location": "global", + "tags": { + "key1": "value1", + "key2": "Value2", + "key3": "Value3" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "partnerName": "ContosoCorp", + "partnerResourceTypeName": "ContosoCorp.Accounts", + "partnerResourceTypeDisplayName": "ContocoCorp Accounts DisplayName Text", + "partnerResourceTypeDescription": "ContocoCorp Accounts Description Text", + "setupUri": "https://www.example.com/setup.html", + "logoUri": "https://www.example.com/logo.png", + "visibilityState": "Hidden", + "authorizedAzureSubscriptionIds": [ + "d48566a8-2428-4a6c-8347-9675d09fb851" + ] + }, + "location": "global", + "tags": { + "key1": "value1", + "key2": "Value2", + "key3": "Value3" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerRegistrations/examplePartnerRegistrationName1", + "name": "examplePartnerRegistrationName1", + "type": "Microsoft.EventGrid/partnerRegistrations" + } + }, + "202": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "partnerName": "ContosoCorp", + "partnerResourceTypeName": "ContosoCorp.Accounts", + "partnerResourceTypeDisplayName": "ContocoCorp Accounts DisplayName Text", + "partnerResourceTypeDescription": "ContocoCorp Accounts Description Text", + "setupUri": "https://www.example.com/setup.html", + "logoUri": "https://www.example.com/logo.png", + "visibilityState": "Hidden", + "authorizedAzureSubscriptionIds": [ + "d48566a8-2428-4a6c-8347-9675d09fb851" + ] + }, + "location": "global", + "tags": { + "key1": "value1", + "key2": "Value2", + "key3": "Value3" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerRegistrations/examplePartnerRegistrationName1", + "name": "examplePartnerRegistrationName1", + "type": "Microsoft.EventGrid/partnerRegistrations" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerRegistrations_Delete.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerRegistrations_Delete.json new file mode 100644 index 000000000000..ef37d8abafca --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerRegistrations_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "partnerRegistrationName": "examplePartnerRegistrationName1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerRegistrations_Get.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerRegistrations_Get.json new file mode 100644 index 000000000000..1d01e45b3614 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerRegistrations_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "partnerRegistrationName": "examplePartnerRegistrationName1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "partnerName": "ContosoCorp", + "partnerResourceTypeName": "ContosoCorp.Accounts", + "partnerResourceTypeDisplayName": "ContocoCorp Accounts DisplayName Text", + "partnerResourceTypeDescription": "ContocoCorp Accounts Description Text", + "setupUri": "https://www.example.com/setup.html", + "logoUri": "https://www.example.com/logo.png", + "visibilityState": "Hidden", + "authorizedAzureSubscriptionIds": [ + "348566c8-1238-3a6c-83bb-6575d12fb00f" + ] + }, + "location": "global", + "tags": { + "key1": "value1", + "key2": "Value2", + "key3": "Value3" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerRegistrations/examplePartnerRegistrationName1", + "name": "examplePartnerRegistrationName1", + "type": "Microsoft.EventGrid/partnerRegistrations" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerRegistrations_ListByResourceGroup.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerRegistrations_ListByResourceGroup.json new file mode 100644 index 000000000000..02d40bbcfb0b --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerRegistrations_ListByResourceGroup.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "partnerName": "ContosoCorp", + "partnerResourceTypeName": "ContosoCorp.Accounts", + "partnerResourceTypeDisplayName": "ContocoCorp Accounts DisplayName Text", + "partnerResourceTypeDescription": "ContocoCorp Accounts Description Text", + "setupUri": "https://www.example.com/setup.html", + "logoUri": "https://www.example.com/logo.png", + "visibilityState": "Hidden", + "authorizedAzureSubscriptionIds": [ + "d48566a8-2428-4a6c-8347-9675d09fb851" + ] + }, + "location": "global", + "tags": { + "key1": "value1", + "key2": "Value2", + "key3": "Value3" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/amh/providers/Microsoft.EventGrid/partnerRegistrations/ContosoCorpAccount1", + "name": "ContosoCorpAccount1", + "type": "Microsoft.EventGrid/partnerRegistrations" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerRegistrations_ListBySubscription.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerRegistrations_ListBySubscription.json new file mode 100644 index 000000000000..4f0c382d932d --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerRegistrations_ListBySubscription.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "partnerName": "ContosoCorp", + "partnerResourceTypeName": "ContosoCorp.Accounts", + "partnerResourceTypeDisplayName": "ContocoCorp Accounts DisplayName Text", + "partnerResourceTypeDescription": "ContocoCorp Accounts Description Text", + "setupUri": "https://www.example.com/setup.html", + "logoUri": "https://www.example.com/logo.png", + "visibilityState": "Hidden", + "authorizedAzureSubscriptionIds": [ + "d48566a8-2428-4a6c-8347-9675d09fb851" + ] + }, + "location": "global", + "tags": { + "key1": "value1", + "key2": "Value2", + "key3": "Value3" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/amh/providers/Microsoft.EventGrid/partnerRegistrations/ContosoCorpAccount1", + "name": "ContosoCorpAccount1", + "type": "Microsoft.EventGrid/partnerRegistrations" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerRegistrations_Update.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerRegistrations_Update.json new file mode 100644 index 000000000000..687286a37ecf --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerRegistrations_Update.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "partnerRegistrationName": "examplePartnerRegistrationName1", + "api-version": "2021-06-01-preview", + "partnerRegistrationUpdateParameters": { + "setupUri": "https://www.example.com/newsetup.html", + "logoUri": "https://www.example.com/newlogo.png" + } + }, + "responses": { + "200": {}, + "201": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "partnerName": "ContosoCorp", + "partnerResourceTypeName": "ContosoCorp.Accounts", + "partnerResourceTypeDisplayName": "ContocoCorp Accounts DisplayName Text", + "partnerResourceTypeDescription": "ContocoCorp Accounts Description Text", + "setupUri": "https://www.example.com/newsetup.html", + "logoUri": "https://www.example.com/newlogo.png", + "visibilityState": "Hidden", + "authorizedAzureSubscriptionIds": [ + "d48566a8-2428-4a6c-8347-9675d09fb851" + ] + }, + "location": "global", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerRegistrations/examplePartnerRegistrationName1", + "name": "examplePartnerRegistrationName1", + "type": "Microsoft.EventGrid/partnerRegistrations" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopicEventSubscriptions_CreateOrUpdate.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopicEventSubscriptions_CreateOrUpdate.json new file mode 100644 index 000000000000..022e17978000 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopicEventSubscriptions_CreateOrUpdate.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "partnerTopicName": "examplePartnerTopic1", + "eventSubscriptionName": "exampleEventSubscriptionName1", + "api-version": "2021-06-01-preview", + "eventSubscriptionInfo": { + "properties": { + "destination": { + "endpointType": "WebHook", + "properties": { + "endpointUrl": "https://requestb.in/15ksip71" + } + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": null, + "eventDeliverySchema": "EventGridSchema", + "retryPolicy": { + "maxDeliveryAttempts": 30, + "eventTimeToLiveInMinutes": 1440 + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1/eventSubscriptions/exampleEventSubscriptionName1", + "name": "exampleEventSubscriptionName1", + "type": "Microsoft.EventGrid/partnerTopics/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopicEventSubscriptions_Delete.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopicEventSubscriptions_Delete.json new file mode 100644 index 000000000000..dbc47e59a97d --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopicEventSubscriptions_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "partnerTopicName": "examplePartnerTopic1", + "eventSubscriptionName": "examplesubscription1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopicEventSubscriptions_Get.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopicEventSubscriptions_Get.json new file mode 100644 index 000000000000..501e4b2a86e8 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopicEventSubscriptions_Get.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "partnerTopicName": "examplePartnerTopic1", + "eventSubscriptionName": "examplesubscription1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1", + "provisioningState": "Succeeded", + "destination": { + "properties": { + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Storage/storageAccounts/testtrackedsource", + "queueName": "que" + }, + "endpointType": "StorageQueue" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix", + "includedEventTypes": [ + "Microsoft.Storage.BlobCreated", + "Microsoft.Storage.BlobDeleted" + ] + }, + "labels": [ + "label1", + "label2" + ], + "eventDeliverySchema": "EventGridSchema", + "retryPolicy": { + "maxDeliveryAttempts": 30, + "eventTimeToLiveInMinutes": 1440 + } + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/partnerTopics/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopicEventSubscriptions_GetDeliveryAttributes.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopicEventSubscriptions_GetDeliveryAttributes.json new file mode 100644 index 000000000000..676d5ad38dd9 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopicEventSubscriptions_GetDeliveryAttributes.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "partnerTopicName": "examplePartnerTopic1", + "eventSubscriptionName": "examplesubscription1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "header1", + "type": "Static", + "properties": { + "value": "NormalValue", + "isSecret": false + } + }, + { + "name": "header2", + "type": "Dynamic", + "properties": { + "sourceField": "data.foo" + } + }, + { + "name": "header3", + "type": "Static", + "properties": { + "value": "mySecretValue", + "isSecret": true + } + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopicEventSubscriptions_GetFullUrl.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopicEventSubscriptions_GetFullUrl.json new file mode 100644 index 000000000000..029611c6550e --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopicEventSubscriptions_GetFullUrl.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "partnerTopicName": "examplePartnerTopic1", + "eventSubscriptionName": "examplesubscription1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "endpointUrl": "https://requestb.in/15ksip71" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopicEventSubscriptions_ListByPartnerTopic.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopicEventSubscriptions_ListByPartnerTopic.json new file mode 100644 index 000000000000..f5fdf396effa --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopicEventSubscriptions_ListByPartnerTopic.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "partnerTopicName": "examplePartnerTopic1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1", + "provisioningState": "Succeeded", + "destination": { + "properties": { + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Storage/storageAccounts/testtrackedsource", + "queueName": "que" + }, + "endpointType": "StorageQueue" + }, + "filter": { + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "labels": [], + "eventDeliverySchema": "EventGridSchema", + "retryPolicy": { + "maxDeliveryAttempts": 10, + "eventTimeToLiveInMinutes": 1440 + } + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/partnerTopics/eventSubscriptions" + }, + { + "properties": { + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1", + "provisioningState": "Succeeded", + "destination": { + "properties": { + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Storage/storageAccounts/testtrackedsource", + "queueName": "que" + }, + "endpointType": "StorageQueue" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix", + "includedEventTypes": [ + "Microsoft.Storage.BlobCreated", + "Microsoft.Storage.BlobDeleted" + ] + }, + "labels": [ + "label1", + "label2" + ], + "eventDeliverySchema": "EventGridSchema", + "retryPolicy": { + "maxDeliveryAttempts": 30, + "eventTimeToLiveInMinutes": 1440 + } + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1/eventSubscriptions/examplesubscription2", + "name": "examplesubscription2", + "type": "Microsoft.EventGrid/partnerTopics/eventSubscriptions" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopicEventSubscriptions_Update.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopicEventSubscriptions_Update.json new file mode 100644 index 000000000000..2d6059699a8e --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopicEventSubscriptions_Update.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "partnerTopicName": "examplePartnerTopic1", + "eventSubscriptionName": "exampleEventSubscriptionName1", + "api-version": "2021-06-01-preview", + "eventSubscriptionUpdateParameters": { + "destination": { + "endpointType": "WebHook", + "properties": { + "endpointUrl": "https://requestb.in/15ksip71" + } + }, + "filter": { + "isSubjectCaseSensitive": true, + "subjectBeginsWith": "existingPrefix", + "subjectEndsWith": "newSuffix" + }, + "labels": [ + "label1", + "label2" + ] + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": true, + "subjectBeginsWith": "existingPrefix", + "subjectEndsWith": "newSuffix" + }, + "labels": [ + "label1", + "label2" + ], + "eventDeliverySchema": "EventGridSchema", + "retryPolicy": { + "maxDeliveryAttempts": 30, + "eventTimeToLiveInMinutes": 1440 + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1/eventSubscriptions/exampleEventSubscriptionName1", + "name": "exampleEventSubscriptionName1", + "type": "Microsoft.EventGrid/partnerTopics/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopics_Activate.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopics_Activate.json new file mode 100644 index 000000000000..4c94c3920c6e --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopics_Activate.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "partnerTopicName": "examplePartnerTopic1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "source": "ContosoCorp.Accounts.User1", + "provisioningState": "Succeeded", + "activationState": "Activated" + }, + "location": "centraluseuap", + "tags": null, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1", + "name": "examplePartnerTopic1", + "type": "Microsoft.EventGrid/partnerTopics" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopics_Deactivate.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopics_Deactivate.json new file mode 100644 index 000000000000..fe97250d3c90 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopics_Deactivate.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "partnerTopicName": "examplePartnerTopic1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "source": "ContosoCorp.Accounts.User1", + "provisioningState": "Succeeded", + "activationState": "Deactivated" + }, + "location": "centraluseuap", + "tags": null, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1", + "name": "examplePartnerTopic1", + "type": "Microsoft.EventGrid/partnerTopics" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopics_Delete.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopics_Delete.json new file mode 100644 index 000000000000..b7e9aa8eb90e --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopics_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "partnerTopicName": "examplePartnerTopicName1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopics_Get.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopics_Get.json new file mode 100644 index 000000000000..b3fd40812cb2 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopics_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "partnerTopicName": "examplePartnerTopicName1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "source": "ContosoCorp.Accounts.User1", + "provisioningState": "Succeeded", + "activationState": "NeverActivated" + }, + "location": "centraluseuap", + "tags": null, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopicName1", + "name": "examplePartnerTopicName1", + "type": "Microsoft.EventGrid/partnerTopics" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopics_ListByResourceGroup.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopics_ListByResourceGroup.json new file mode 100644 index 000000000000..315c679cb501 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopics_ListByResourceGroup.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "source": "ContosoCorp.Accounts.User1", + "provisioningState": "Succeeded", + "activationState": "NeverActivated" + }, + "location": "centraluseuap", + "tags": null, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/amh/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1", + "name": "examplePartnerTopic1", + "type": "Microsoft.EventGrid/partnerTopics" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopics_ListBySubscription.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopics_ListBySubscription.json new file mode 100644 index 000000000000..672e26ad1a06 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopics_ListBySubscription.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "source": "ContosoCorp.Accounts.User1", + "provisioningState": "Succeeded", + "activationState": "NeverActivated" + }, + "location": "centraluseuap", + "tags": null, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/amh/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1", + "name": "examplePartnerTopic1", + "type": "Microsoft.EventGrid/partnerTopics" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopics_Update.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopics_Update.json new file mode 100644 index 000000000000..f7602eaddcf7 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PartnerTopics_Update.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "partnerTopicName": "examplePartnerTopicName1", + "api-version": "2021-06-01-preview", + "partnerTopicUpdateParameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": {}, + "201": { + "body": { + "properties": { + "source": "ContosoCorp.Accounts.User1", + "provisioningState": "Succeeded", + "activationState": "NeverActivated" + }, + "location": "centraluseuap", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/amh/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1", + "name": "examplePartnerTopic1", + "type": "Microsoft.EventGrid/partnerTopics" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PrivateEndpointConnections_Delete.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PrivateEndpointConnections_Delete.json new file mode 100644 index 000000000000..7cd3e8d6efb2 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PrivateEndpointConnections_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "parentType": "topics", + "parentName": "exampletopic1", + "privateEndpointConnectionName": "BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B", + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PrivateEndpointConnections_Get.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PrivateEndpointConnections_Get.json new file mode 100644 index 000000000000..47bb67a11a0f --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PrivateEndpointConnections_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "parentType": "topics", + "parentName": "exampletopic1", + "privateEndpointConnectionName": "BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Network/privateEndpoints/bmtpe5" + }, + "groupIds": [ + "topic" + ], + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Test", + "actionsRequired": "None" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5B4B650E-28B9-4790-B3AB-DDBD88D727C4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/privateEndpointConnections/BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B", + "name": "BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B", + "type": "Microsoft.EventGrid/topics/privateEndpointConnections" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PrivateEndpointConnections_ListByResource.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PrivateEndpointConnections_ListByResource.json new file mode 100644 index 000000000000..4f4190c89558 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PrivateEndpointConnections_ListByResource.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "parentType": "topics", + "parentName": "exampletopic1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Network/privateEndpoints/bmtpe5" + }, + "groupIds": [ + "topic" + ], + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Test", + "actionsRequired": "None" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5B4B650E-28B9-4790-B3AB-DDBD88D727C4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/privateEndpointConnections/BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B", + "name": "BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B", + "type": "Microsoft.EventGrid/topics/privateEndpointConnections" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PrivateEndpointConnections_Update.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PrivateEndpointConnections_Update.json new file mode 100644 index 000000000000..cc68f3afca90 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PrivateEndpointConnections_Update.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "parentType": "topics", + "parentName": "exampletopic1", + "privateEndpointConnectionName": "BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B", + "api-version": "2021-06-01-preview", + "privateEndpointConnection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approving connection", + "actionsRequired": "None" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Network/privateEndpoints/bmtpe5" + }, + "groupIds": [ + "topic" + ], + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approving connection", + "actionsRequired": "None" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5B4B650E-28B9-4790-B3AB-DDBD88D727C4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/privateEndpointConnections/BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B", + "name": "BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B", + "type": "Microsoft.EventGrid/topics/privateEndpointConnections" + } + }, + "201": { + "body": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Network/privateEndpoints/bmtpe5" + }, + "groupIds": [ + "topic" + ], + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approving connection", + "actionsRequired": "None" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5B4B650E-28B9-4790-B3AB-DDBD88D727C4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/privateEndpointConnections/BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B", + "name": "BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B", + "type": "Microsoft.EventGrid/topics/privateEndpointConnections" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PrivateLinkResources_Get.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PrivateLinkResources_Get.json new file mode 100644 index 000000000000..8ec4f529765e --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PrivateLinkResources_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "parentType": "topics", + "parentName": "exampletopic1", + "privateLinkResourceName": "topic", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupId": "topic", + "displayName": "Event Grid topic", + "requiredMembers": [ + "topic" + ], + "requiredZoneNames": [ + "privatelink.eventgrid.azure.net" + ] + }, + "id": "/subscriptions/5B4B650E-28B9-4790-B3AB-DDBD88D727C4/resourceGroups/amh/providers/Microsoft.EventGrid/topics/exampletopic1/privateLinkResources/topic", + "name": "topic", + "type": "Microsoft.EventGrid/topics/privateLinkResources" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PrivateLinkResources_ListByResource.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PrivateLinkResources_ListByResource.json new file mode 100644 index 000000000000..5215d751b5c4 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/PrivateLinkResources_ListByResource.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "parentType": "topics", + "parentName": "exampletopic1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "topic", + "displayName": "Event Grid topic", + "requiredMembers": [ + "topic" + ], + "requiredZoneNames": [ + "privatelink.eventgrid.azure.net" + ] + }, + "id": "/subscriptions/5B4B650E-28B9-4790-B3AB-DDBD88D727C4/resourceGroups/amh/providers/Microsoft.EventGrid/topics/exampletopic1/privateLinkResources/topic", + "name": "topic", + "type": "Microsoft.EventGrid/topics/privateLinkResources" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopicEventSubscriptions_CreateOrUpdate.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopicEventSubscriptions_CreateOrUpdate.json new file mode 100644 index 000000000000..d38b393dd5ea --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopicEventSubscriptions_CreateOrUpdate.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "systemTopicName": "exampleSystemTopic1", + "eventSubscriptionName": "exampleEventSubscriptionName1", + "api-version": "2021-06-01-preview", + "eventSubscriptionInfo": { + "properties": { + "destination": { + "endpointType": "WebHook", + "properties": { + "endpointUrl": "https://requestb.in/15ksip71" + } + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": null, + "eventDeliverySchema": "EventGridSchema", + "retryPolicy": { + "maxDeliveryAttempts": 30, + "eventTimeToLiveInMinutes": 1440 + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1/eventSubscriptions/exampleEventSubscriptionName1", + "name": "exampleEventSubscriptionName1", + "type": "Microsoft.EventGrid/systemTopics/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopicEventSubscriptions_Delete.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopicEventSubscriptions_Delete.json new file mode 100644 index 000000000000..7ad62de98b14 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopicEventSubscriptions_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "systemTopicName": "exampleSystemTopic1", + "eventSubscriptionName": "examplesubscription1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopicEventSubscriptions_Get.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopicEventSubscriptions_Get.json new file mode 100644 index 000000000000..92eee757b012 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopicEventSubscriptions_Get.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "systemTopicName": "exampleSystemTopic1", + "eventSubscriptionName": "examplesubscription1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1", + "provisioningState": "Succeeded", + "destination": { + "properties": { + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Storage/storageAccounts/testtrackedsource", + "queueName": "que" + }, + "endpointType": "StorageQueue" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix", + "includedEventTypes": [ + "Microsoft.Storage.BlobCreated", + "Microsoft.Storage.BlobDeleted" + ] + }, + "labels": [ + "label1", + "label2" + ], + "eventDeliverySchema": "EventGridSchema", + "retryPolicy": { + "maxDeliveryAttempts": 30, + "eventTimeToLiveInMinutes": 1440 + } + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/systemTopics/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopicEventSubscriptions_GetDeliveryAttributes.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopicEventSubscriptions_GetDeliveryAttributes.json new file mode 100644 index 000000000000..3ffdace692f0 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopicEventSubscriptions_GetDeliveryAttributes.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "systemTopicName": "exampleSystemTopic1", + "eventSubscriptionName": "examplesubscription1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "header1", + "type": "Static", + "properties": { + "value": "NormalValue", + "isSecret": false + } + }, + { + "name": "header2", + "type": "Dynamic", + "properties": { + "sourceField": "data.foo" + } + }, + { + "name": "header3", + "type": "Static", + "properties": { + "value": "mySecretValue", + "isSecret": true + } + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopicEventSubscriptions_GetFullUrl.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopicEventSubscriptions_GetFullUrl.json new file mode 100644 index 000000000000..57e494399c58 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopicEventSubscriptions_GetFullUrl.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "systemTopicName": "exampleSystemTopic1", + "eventSubscriptionName": "examplesubscription1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "endpointUrl": "https://requestb.in/15ksip71" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopicEventSubscriptions_ListBySystemTopic.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopicEventSubscriptions_ListBySystemTopic.json new file mode 100644 index 000000000000..da7268d2b4c5 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopicEventSubscriptions_ListBySystemTopic.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "systemTopicName": "exampleSystemTopic1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1", + "provisioningState": "Succeeded", + "destination": { + "properties": { + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Storage/storageAccounts/testtrackedsource", + "queueName": "que" + }, + "endpointType": "StorageQueue" + }, + "filter": { + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "labels": [], + "eventDeliverySchema": "EventGridSchema", + "retryPolicy": { + "maxDeliveryAttempts": 10, + "eventTimeToLiveInMinutes": 1440 + } + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/systemTopics/eventSubscriptions" + }, + { + "properties": { + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1", + "provisioningState": "Succeeded", + "destination": { + "properties": { + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Storage/storageAccounts/testtrackedsource", + "queueName": "que" + }, + "endpointType": "StorageQueue" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix", + "includedEventTypes": [ + "Microsoft.Storage.BlobCreated", + "Microsoft.Storage.BlobDeleted" + ] + }, + "labels": [ + "label1", + "label2" + ], + "eventDeliverySchema": "EventGridSchema", + "retryPolicy": { + "maxDeliveryAttempts": 30, + "eventTimeToLiveInMinutes": 1440 + } + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1/eventSubscriptions/examplesubscription2", + "name": "examplesubscription2", + "type": "Microsoft.EventGrid/systemTopics/eventSubscriptions" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopicEventSubscriptions_Update.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopicEventSubscriptions_Update.json new file mode 100644 index 000000000000..9bdf21f0392f --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopicEventSubscriptions_Update.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "systemTopicName": "exampleSystemTopic1", + "eventSubscriptionName": "exampleEventSubscriptionName1", + "api-version": "2021-06-01-preview", + "eventSubscriptionUpdateParameters": { + "destination": { + "endpointType": "WebHook", + "properties": { + "endpointUrl": "https://requestb.in/15ksip71" + } + }, + "filter": { + "isSubjectCaseSensitive": true, + "subjectBeginsWith": "existingPrefix", + "subjectEndsWith": "newSuffix" + }, + "labels": [ + "label1", + "label2" + ] + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": true, + "subjectBeginsWith": "existingPrefix", + "subjectEndsWith": "newSuffix" + }, + "labels": [ + "label1", + "label2" + ], + "eventDeliverySchema": "EventGridSchema", + "retryPolicy": { + "maxDeliveryAttempts": 30, + "eventTimeToLiveInMinutes": 1440 + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1/eventSubscriptions/exampleEventSubscriptionName1", + "name": "exampleEventSubscriptionName1", + "type": "Microsoft.EventGrid/systemTopics/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopics_CreateOrUpdate.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopics_CreateOrUpdate.json new file mode 100644 index 000000000000..6f1e705dd76b --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopics_CreateOrUpdate.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "systemTopicName": "exampleSystemTopic1", + "api-version": "2021-06-01-preview", + "systemTopicInfo": { + "properties": { + "source": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/azureeventgridrunnerrgcentraluseuap/providers/microsoft.storage/storageaccounts/pubstgrunnerb71cd29e", + "topicType": "microsoft.storage.storageaccounts" + }, + "location": "westus2", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "source": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/azureeventgridrunnerrgcentraluseuap/providers/microsoft.storage/storageaccounts/pubstgrunnerb71cd29e", + "topicType": "microsoft.storage.storageaccounts", + "metricResourceId": "183c0fb1-17ff-47b6-ac77-5a47420ab01e" + }, + "location": "centraluseuap", + "tags": null, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic2", + "name": "exampleSystemTopic2", + "type": "Microsoft.EventGrid/systemTopics" + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "source": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/azureeventgridrunnerrgcentraluseuap/providers/microsoft.storage/storageaccounts/pubstgrunnerb71cd29e", + "topicType": "microsoft.storage.storageaccounts", + "metricResourceId": "183c0fb1-17ff-47b6-ac77-5a47420ab01e" + }, + "location": "centraluseuap", + "tags": null, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic2", + "name": "exampleSystemTopic2", + "type": "Microsoft.EventGrid/systemTopics" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopics_Delete.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopics_Delete.json new file mode 100644 index 000000000000..4dc3bc269b6a --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopics_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "systemTopicName": "exampleSystemTopic1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopics_Get.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopics_Get.json new file mode 100644 index 000000000000..6f2ed852108a --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopics_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "systemTopicName": "exampleSystemTopic2", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "source": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/azureeventgridrunnerrgcentraluseuap/providers/microsoft.storage/storageaccounts/pubstgrunnerb71cd29e", + "topicType": "microsoft.storage.storageaccounts", + "metricResourceId": "183c0fb1-17ff-47b6-ac77-5a47420ab01e" + }, + "location": "centraluseuap", + "tags": null, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic2", + "name": "exampleSystemTopic2", + "type": "Microsoft.EventGrid/systemTopics" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopics_ListByResourceGroup.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopics_ListByResourceGroup.json new file mode 100644 index 000000000000..6532104f0d16 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopics_ListByResourceGroup.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "source": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/azureeventgridrunnerrgcentraluseuap/providers/microsoft.storage/storageaccounts/pubstgrunnerb71cd29e", + "topicType": "microsoft.storage.storageaccounts", + "metricResourceId": "183c0fb1-17ff-47b6-ac77-5a47420ab01e" + }, + "location": "centraluseuap", + "tags": null, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/pubstgrunnerb71cd29e-86fad330-7bac-4238-8cab-9e46b75165aa", + "name": "pubstgrunnerb71cd29e-86fad330-7bac-4238-8cab-9e46b75165aa", + "type": "Microsoft.EventGrid/systemTopics" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopics_ListBySubscription.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopics_ListBySubscription.json new file mode 100644 index 000000000000..7bd800851db1 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopics_ListBySubscription.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "source": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/azureeventgridrunnerrgcentraluseuap/providers/microsoft.storage/storageaccounts/pubstgrunnerb71cd29e", + "topicType": "microsoft.storage.storageaccounts", + "metricResourceId": "183c0fb1-17ff-47b6-ac77-5a47420ab01e" + }, + "location": "centraluseuap", + "tags": null, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic2", + "name": "exampleSystemTopic2", + "type": "Microsoft.EventGrid/systemTopics" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopics_Update.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopics_Update.json new file mode 100644 index 000000000000..77be048df27e --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/SystemTopics_Update.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "systemTopicName": "exampleSystemTopic1", + "api-version": "2021-06-01-preview", + "systemTopicUpdateParameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "source": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/azureeventgridrunnerrgcentraluseuap/providers/microsoft.storage/storageaccounts/pubstgrunnerb71cd29e", + "topicType": "microsoft.storage.storageaccounts", + "metricResourceId": "183c0fb1-17ff-47b6-ac77-5a47420ab01e" + }, + "location": "centraluseuap", + "tags": null, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic2", + "name": "exampleSystemTopic2", + "type": "Microsoft.EventGrid/systemTopics" + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "source": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/azureeventgridrunnerrgcentraluseuap/providers/microsoft.storage/storageaccounts/pubstgrunnerb71cd29e", + "topicType": "microsoft.storage.storageaccounts", + "metricResourceId": "183c0fb1-17ff-47b6-ac77-5a47420ab01e" + }, + "location": "centraluseuap", + "tags": null, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic2", + "name": "exampleSystemTopic2", + "type": "Microsoft.EventGrid/systemTopics" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/TopicTypes_Get.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/TopicTypes_Get.json new file mode 100644 index 000000000000..57450a57ffe1 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/TopicTypes_Get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "topicTypeName": "Microsoft.Storage.StorageAccounts", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "Microsoft Storage service events.", + "displayName": "Storage Accounts", + "provider": "Microsoft.Storage", + "provisioningState": "Succeeded", + "resourceRegionType": "RegionalResource" + }, + "id": "providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts", + "name": "Microsoft.Storage.StorageAccounts", + "type": "Microsoft.EventGrid/topicTypes" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/TopicTypes_List.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/TopicTypes_List.json new file mode 100644 index 000000000000..157e867cd253 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/TopicTypes_List.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "description": "Microsoft EventHubs service events.", + "displayName": "EventHubs Namespace", + "provider": "Microsoft.Eventhub", + "provisioningState": "Succeeded", + "resourceRegionType": "RegionalResource" + }, + "id": "providers/Microsoft.EventGrid/topicTypes/Microsoft.Eventhub.Namespaces", + "name": "Microsoft.Eventhub.Namespaces", + "type": "Microsoft.EventGrid/topicTypes" + }, + { + "properties": { + "description": "Microsoft Storage service events.", + "displayName": "Storage Accounts", + "provider": "Microsoft.Storage", + "provisioningState": "Succeeded", + "resourceRegionType": "RegionalResource" + }, + "id": "providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts", + "name": "Microsoft.Storage.StorageAccounts", + "type": "Microsoft.EventGrid/topicTypes" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/TopicTypes_ListEventTypes.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/TopicTypes_ListEventTypes.json new file mode 100644 index 000000000000..2f9fa4175feb --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/TopicTypes_ListEventTypes.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "topicTypeName": "Microsoft.Storage.StorageAccounts", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "displayName": "Blob Created", + "description": "Raised when a blob is created.", + "schemaUrl": "tbd" + }, + "id": "providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts/eventTypes/Microsoft.Storage.BlobCreated", + "name": "Microsoft.Storage.BlobCreated", + "type": "Microsoft.EventGrid/topicTypes/eventTypes" + }, + { + "properties": { + "description": "Raised when a blob is deleted.", + "schemaUrl": "tbd", + "displayName": "Blob Deleted" + }, + "id": "providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts/eventTypes/Microsoft.Storage.BlobDeleted", + "name": "Microsoft.Storage.BlobDeleted", + "type": "Microsoft.EventGrid/topicTypes/eventTypes" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Topics_CreateOrUpdate.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Topics_CreateOrUpdate.json new file mode 100644 index 000000000000..6b3e37934377 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Topics_CreateOrUpdate.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "topicName": "exampletopic1", + "api-version": "2021-06-01-preview", + "topicInfo": { + "location": "westus2", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "publicNetworkAccess": "Enabled", + "inboundIpRules": [ + { + "ipMask": "12.18.30.15", + "action": "Allow" + }, + { + "ipMask": "12.18.176.1", + "action": "Allow" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "endpoint": "https://exampletopic1.westus2-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled", + "inboundIpRules": [ + { + "ipMask": "12.18.30.15", + "action": "Allow" + }, + { + "ipMask": "12.18.176.1", + "action": "Allow" + } + ] + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "location": "westus2", + "name": "exampletopic1", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/topics" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Topics_CreateOrUpdateForAzureArc.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Topics_CreateOrUpdateForAzureArc.json new file mode 100644 index 000000000000..b9438a304eed --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Topics_CreateOrUpdateForAzureArc.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "topicName": "exampletopic1", + "api-version": "2021-06-01-preview", + "topicInfo": { + "location": "westus2", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "kind": "AzureArc", + "extendedLocation": { + "name": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.ExtendedLocation/CustomLocations/exampleCustomLocation", + "type": "CustomLocation" + }, + "properties": { + "inputSchema": "CloudEventSchemaV1_0" + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "endpoint": "https://exampletopic1.westus2-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded", + "inputSchema": "CloudEventSchemaV1_0" + }, + "kind": "AzureArc", + "extendedLocation": { + "name": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.ExtendedLocation/CustomLocations/exampleCustomLocation", + "type": "CustomLocation" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "location": "westus2", + "name": "exampletopic1", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/topics" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Topics_Delete.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Topics_Delete.json new file mode 100644 index 000000000000..079ffbf4b810 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Topics_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg1", + "topicName": "exampletopic1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Topics_Get.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Topics_Get.json new file mode 100644 index 000000000000..44982aeeb5eb --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Topics_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "topicName": "exampletopic2", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "endpoint": "https://exampletopic2.westcentralus-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", + "location": "westcentralus", + "name": "exampletopic2", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/topics" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Topics_ListByResourceGroup.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Topics_ListByResourceGroup.json new file mode 100644 index 000000000000..84a7ee1b2f8d --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Topics_ListByResourceGroup.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "endpoint": "https://exampletopic1.westus2-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "location": "westus2", + "name": "exampletopic1", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/topics" + }, + { + "properties": { + "endpoint": "https://exampletopic2.westcentralus-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", + "location": "westcentralus", + "name": "exampletopic2", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/topics" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Topics_ListBySubscription.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Topics_ListBySubscription.json new file mode 100644 index 000000000000..31eb128db8c8 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Topics_ListBySubscription.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "endpoint": "https://exampletopic1.westus2-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "location": "westus2", + "name": "exampletopic1", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/topics" + }, + { + "properties": { + "endpoint": "https://exampletopic2.westcentralus-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", + "location": "westcentralus", + "name": "exampletopic2", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/topics" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Topics_ListEventTypes.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Topics_ListEventTypes.json new file mode 100644 index 000000000000..e2321d779f39 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Topics_ListEventTypes.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerNamespace": "Microsoft.Storage", + "resourceTypeName": "storageAccounts", + "resourceName": "ExampleStorageAccount", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "description": "Raised when a blob is created.", + "schemaUrl": "tbd", + "displayName": "Blob Created" + }, + "id": "providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts/eventTypes/Microsoft.Storage.BlobCreated", + "name": "Microsoft.Storage.BlobCreated", + "type": "Microsoft.EventGrid/topicTypes/eventTypes" + }, + { + "properties": { + "description": "Raised when a blob is deleted.", + "schemaUrl": "tbd", + "displayName": "Blob Deleted" + }, + "id": "providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts/eventTypes/Microsoft.Storage.BlobDeleted", + "name": "Microsoft.Storage.BlobDeleted", + "type": "Microsoft.EventGrid/topicTypes/eventTypes" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Topics_ListSharedAccessKeys.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Topics_ListSharedAccessKeys.json new file mode 100644 index 000000000000..e3e7fec736ef --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Topics_ListSharedAccessKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "topicName": "exampletopic2", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "key1": "testKey1Value", + "key2": "testKey2Value" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Topics_RegenerateKey.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Topics_RegenerateKey.json new file mode 100644 index 000000000000..c32eb540c026 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Topics_RegenerateKey.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "topicName": "exampletopic2", + "api-version": "2021-06-01-preview", + "regenerateKeyRequest": { + "keyName": "key1" + } + }, + "responses": { + "200": { + "body": { + "key1": "testKey1Value", + "key2": "testKey2Value" + } + }, + "202": {} + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Topics_Update.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Topics_Update.json new file mode 100644 index 000000000000..9effd99e3082 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2021-06-01-preview/examples/Topics_Update.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "topicName": "exampletopic1", + "api-version": "2021-06-01-preview", + "topicUpdateParameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "publicNetworkAccess": "Enabled", + "inboundIpRules": [ + { + "ipMask": "12.18.30.15", + "action": "Allow" + }, + { + "ipMask": "12.18.176.1", + "action": "Allow" + } + ] + } + } + }, + "responses": { + "200": {}, + "201": { + "body": { + "properties": { + "endpoint": "https://exampletopic1.westus2-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled", + "inboundIpRules": [ + { + "ipMask": "12.18.30.15", + "action": "Allow" + }, + { + "ipMask": "12.18.176.1", + "action": "Allow" + } + ] + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "location": "westus2", + "name": "exampletopic1", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/topics" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/readme.go.md b/specification/eventgrid/resource-manager/readme.go.md index 343b062224b5..c8aae0a7a32d 100644 --- a/specification/eventgrid/resource-manager/readme.go.md +++ b/specification/eventgrid/resource-manager/readme.go.md @@ -13,6 +13,7 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2021-06-preview - tag: package-2020-10-preview - tag: package-2020-06 - tag: package-2020-04-preview @@ -26,6 +27,15 @@ batch: - tag: package-2017-09-preview - tag: package-2017-06-preview ``` +### Tag: package-2021-06-preview and go + +These settings apply only when `--tag=package-2021-06-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2021-06-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2021-06-01-preview/$(namespace) +``` + ### Tag: package-2020-10-preview and go These settings apply only when `--tag=package-2020-10-preview --go` is specified on the command line. diff --git a/specification/eventgrid/resource-manager/readme.java.md b/specification/eventgrid/resource-manager/readme.java.md index cbfdd684e562..8cd94d1c8eeb 100644 --- a/specification/eventgrid/resource-manager/readme.java.md +++ b/specification/eventgrid/resource-manager/readme.java.md @@ -16,6 +16,7 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-eventgrid ``` yaml $(java) && $(multiapi) batch: + - tag: package-2021-06-preview - tag: package-2020-10-preview - tag: package-2020-06 - tag: package-2020-04-preview @@ -27,6 +28,20 @@ batch: - tag: package-2018-05-preview - tag: package-2018-01 ``` +### Tag: package-2021-06-preview and java + +These settings apply only when `--tag=package-2021-06-preview --java` is specified on the command line. + +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2021-06-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.eventgrid.v2021_06_01_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/eventgrid/mgmt-v2021_06_01_preview +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-2020-10-preview and java These settings apply only when `--tag=package-2020-10-preview --java` is specified on the command line. @@ -41,6 +56,8 @@ regenerate-manager: true generate-interface: true ``` + + ### Tag: package-2020-06 and java These settings apply only when `--tag=package-2020-06 --java` is specified on the command line. diff --git a/specification/eventgrid/resource-manager/readme.md b/specification/eventgrid/resource-manager/readme.md index 5877c8a4782f..c02c12905022 100644 --- a/specification/eventgrid/resource-manager/readme.md +++ b/specification/eventgrid/resource-manager/readme.md @@ -26,7 +26,16 @@ These are the global settings for the Azure EventGrid API. ``` yaml openapi-type: arm -tag: package-2020-10-preview +tag: package-2021-06-preview +``` + +### Tag: package-2021-06-preview + +These settings apply only when `--tag=package-2021-06-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2021-06-preview' +input-file: +- Microsoft.EventGrid/preview/2021-06-01-preview/EventGrid.json ``` ### Tag: package-2020-10-preview @@ -174,7 +183,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/eventgrid/resource-manager/readme.python.md b/specification/eventgrid/resource-manager/readme.python.md index 3fd4e976dac2..ddacd2b0f8a2 100644 --- a/specification/eventgrid/resource-manager/readme.python.md +++ b/specification/eventgrid/resource-manager/readme.python.md @@ -4,18 +4,8 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 1 - namespace: azure.mgmt.eventgrid - package-name: azure-mgmt-eventgrid - package-version: 2.2.0 - clear-output-folder: true -``` -``` yaml $(python) && $(track2) + +``` yaml $(python) python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION @@ -25,17 +15,6 @@ package-version: 2.2.0 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/eventgrid/azure-mgmt-eventgrid/azure/mgmt/eventgrid -``` - -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/eventgrid/azure-mgmt-eventgrid -``` ``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/eventgrid/azure-mgmt-eventgrid/azure/mgmt/eventgrid @@ -45,4 +24,3 @@ output-folder: $(python-sdks-folder)/eventgrid/azure-mgmt-eventgrid/azure/mgmt/e basic-setup-py: true output-folder: $(python-sdks-folder)/eventgrid/azure-mgmt-eventgrid ``` - diff --git a/specification/eventgrid/resource-manager/readme.ruby.md b/specification/eventgrid/resource-manager/readme.ruby.md index d2f99ff67a05..4c22c30b24bc 100644 --- a/specification/eventgrid/resource-manager/readme.ruby.md +++ b/specification/eventgrid/resource-manager/readme.ruby.md @@ -12,6 +12,7 @@ azure-arm: true ``` yaml $(ruby) && $(multiapi) batch: + - tag: package-2021-06-preview - tag: package-2020-10-preview - tag: package-2020-06 - tag: package-2020-04-preview @@ -25,6 +26,16 @@ batch: - tag: package-2017-09-preview - tag: package-2017-06-preview ``` +### Tag: package-2021-06-preview and ruby +These settings apply only when `--tag=package-2021-06-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2021-06-preview' && $(ruby) + +namespace: "Azure::EventGrid::Mgmt::V2021_06_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_event_grid/lib +``` + ### Tag: package-2020-10-preview and ruby These settings apply only when `--tag=package-2020-10-preview --ruby` is specified on the command line. Please also specify `--ruby-sdks-folder=`. @@ -35,6 +46,7 @@ namespace: "Azure::EventGrid::Mgmt::V2020_10_15_preview" output-folder: $(ruby-sdks-folder)/management/azure_mgmt_event_grid/lib ``` + ### Tag: package-2020-06 and ruby These settings apply only when `--tag=package-2020-06 --ruby` is specified on the command line. Please also specify `--ruby-sdks-folder=`. diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/Clusters-preview.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/Clusters-preview.json index 9300b0e7a82a..54fa3cdb8dfe 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/Clusters-preview.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/Clusters-preview.json @@ -383,7 +383,6 @@ }, "capacity": { "format": "int32", - "maximum": 32, "minimum": 1, "type": "integer", "description": "The quantity of Event Hubs Cluster Capacity Units contained in this cluster." diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/namespaces-preview.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/namespaces-preview.json index 02608d7b5225..d478155de650 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/namespaces-preview.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/namespaces-preview.json @@ -615,6 +615,11 @@ "type": "string", "description": "Provisioning state of the Namespace." }, + "status": { + "readOnly": true, + "type": "string", + "description": "Status of the Namespace." + }, "createdAt": { "readOnly": true, "format": "date-time", @@ -704,7 +709,6 @@ }, "capacity": { "format": "int32", - "maximum": 20, "minimum": 0, "type": "integer", "description": "The Event Hubs throughput units, value should be 0 to 20 throughput units." diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-01-01-preview/namespaces-preview.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-01-01-preview/namespaces-preview.json index 9d2ae9f568aa..27229f88fa20 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-01-01-preview/namespaces-preview.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-01-01-preview/namespaces-preview.json @@ -614,6 +614,11 @@ "type": "string", "description": "Provisioning state of the Namespace." }, + "status": { + "readOnly": true, + "type": "string", + "description": "Status of the Namespace." + }, "createdAt": { "readOnly": true, "format": "date-time", @@ -712,7 +717,6 @@ }, "capacity": { "format": "int32", - "maximum": 20, "minimum": 0, "type": "integer", "description": "The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units." diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/AuthorizationRules.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/AuthorizationRules.json new file mode 100644 index 000000000000..641e0f3b5df7 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/AuthorizationRules.json @@ -0,0 +1,891 @@ +{ + "swagger": "2.0", + "info": { + "title": "EventHubManagementClient", + "description": "Azure Event Hubs client", + "version": "2021-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules": { + "get": { + "tags": [ + "AuthorizationRules Namespaces" + ], + "operationId": "Namespaces_ListAuthorizationRules", + "x-ms-examples": { + "ListAuthorizationRules": { + "$ref": "./examples/NameSpaces/EHNameSpaceAuthorizationRuleListAll.json" + } + }, + "description": "Gets a list of authorization rules for a Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace AuthorizationRule successfully returned.", + "schema": { + "$ref": "#/definitions/AuthorizationRuleListResult" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}": { + "put": { + "tags": [ + "AuthorizationRules Namespaces" + ], + "operationId": "Namespaces_CreateOrUpdateAuthorizationRule", + "x-ms-examples": { + "NameSpaceAuthorizationRuleCreate": { + "$ref": "./examples/NameSpaces/EHNameSpaceAuthorizationRuleCreate.json" + } + }, + "description": "Creates or updates an AuthorizationRule for a Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AuthorizationRule" + }, + "description": "The shared access AuthorizationRule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace AuthorizationRule created", + "schema": { + "$ref": "#/definitions/AuthorizationRule" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "AuthorizationRules Namespaces" + ], + "operationId": "Namespaces_DeleteAuthorizationRule", + "x-ms-examples": { + "NameSpaceAuthorizationRuleDelete": { + "$ref": "./examples/NameSpaces/EHNameSpaceAuthorizationRuleDelete.json" + } + }, + "description": "Deletes an AuthorizationRule for a Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace AuthorizationRule successfully deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "AuthorizationRules Namespaces" + ], + "operationId": "Namespaces_GetAuthorizationRule", + "x-ms-examples": { + "NameSpaceAuthorizationRuleGet": { + "$ref": "./examples/NameSpaces/EHNameSpaceAuthorizationRuleGet.json" + } + }, + "description": "Gets an AuthorizationRule for a Namespace by rule name.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace AuthorizationRule returned successfully.", + "schema": { + "$ref": "#/definitions/AuthorizationRule" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/listKeys": { + "post": { + "tags": [ + "AuthorizationRules Namespaces" + ], + "operationId": "Namespaces_ListKeys", + "x-ms-examples": { + "NameSpaceAuthorizationRuleListKey": { + "$ref": "./examples/NameSpaces/EHNameSpaceAuthorizationRuleListKey.json" + } + }, + "description": "Gets the primary and secondary connection strings for the Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings returned successfully.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/regenerateKeys": { + "post": { + "tags": [ + "AuthorizationRules Namespaces" + ], + "operationId": "Namespaces_RegenerateKeys", + "x-ms-examples": { + "NameSpaceAuthorizationRuleRegenerateKey": { + "$ref": "./examples/NameSpaces/EHNameSpaceAuthorizationRuleRegenerateKey.json" + } + }, + "description": "Regenerates the primary or secondary connection strings for the specified Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateAccessKeyParameters" + }, + "description": "Parameters required to regenerate the connection string." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings regenerated successfully.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules": { + "get": { + "tags": [ + "AuthorizationRules DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_ListAuthorizationRules", + "x-ms-examples": { + "ListAuthorizationRules": { + "$ref": "./examples/disasterRecoveryConfigs/EHAliasAuthorizationRuleListAll.json" + } + }, + "description": "Gets a list of authorization rules for a Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace AuthorizationRule successfully returned.", + "schema": { + "$ref": "#/definitions/AuthorizationRuleListResult" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules/{authorizationRuleName}": { + "get": { + "tags": [ + "AuthorizationRules DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_GetAuthorizationRule", + "x-ms-examples": { + "NameSpaceAuthorizationRuleGet": { + "$ref": "./examples/disasterRecoveryConfigs/EHAliasAuthorizationRuleGet.json" + } + }, + "description": "Gets an AuthorizationRule for a Namespace by rule name.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Alias Namespace AuthorizationRule returned successfully.", + "schema": { + "$ref": "#/definitions/AuthorizationRule" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules/{authorizationRuleName}/listKeys": { + "post": { + "tags": [ + "AuthorizationRules DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_ListKeys", + "x-ms-examples": { + "NameSpaceAuthorizationRuleListKey": { + "$ref": "./examples/disasterRecoveryConfigs/EHAliasAuthorizationRuleListKey.json" + } + }, + "description": "Gets the primary and secondary connection strings for the Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings returned successfully.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules": { + "get": { + "tags": [ + "AuthorizationRules EventHubs" + ], + "operationId": "EventHubs_ListAuthorizationRules", + "x-ms-examples": { + "EventHubAuthorizationRuleListAll": { + "$ref": "./examples/EventHubs/EHEventHubAuthorizationRuleListAll.json" + } + }, + "description": "Gets the authorization rules for an Event Hub.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/EventHubNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Event Hub AuthorizationRule returned successfully.", + "schema": { + "$ref": "#/definitions/AuthorizationRuleListResult" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}": { + "put": { + "tags": [ + "AuthorizationRules EventHubs" + ], + "operationId": "EventHubs_CreateOrUpdateAuthorizationRule", + "x-ms-examples": { + "EventHubAuthorizationRuleCreate": { + "$ref": "./examples/EventHubs/EHEventHubAuthorizationRuleCreate.json" + } + }, + "description": "Creates or updates an AuthorizationRule for the specified Event Hub. Creation/update of the AuthorizationRule will take a few seconds to take effect.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/EventHubNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AuthorizationRule" + }, + "description": "The shared access AuthorizationRule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Event Hub AuthorizationRule successfully created.", + "schema": { + "$ref": "#/definitions/AuthorizationRule" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "EventHubs" + ], + "operationId": "EventHubs_GetAuthorizationRule", + "x-ms-examples": { + "EventHubAuthorizationRuleGet": { + "$ref": "./examples/EventHubs/EHEventHubAuthorizationRuleGet.json" + } + }, + "description": "Gets an AuthorizationRule for an Event Hub by rule name.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/EventHubNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Event Hub AuthorizationRule successfully returned.", + "schema": { + "$ref": "#/definitions/AuthorizationRule" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "EventHubs" + ], + "operationId": "EventHubs_DeleteAuthorizationRule", + "x-ms-examples": { + "EventHubAuthorizationRuleDelete": { + "$ref": "./examples/EventHubs/EHEventHubAuthorizationRuleDelete.json" + } + }, + "description": "Deletes an Event Hub AuthorizationRule.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/EventHubNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Event Hub AuthorizationRule successfully deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}/listKeys": { + "post": { + "tags": [ + "AuthorizationRules EventHubs" + ], + "operationId": "EventHubs_ListKeys", + "x-ms-examples": { + "EventHubAuthorizationRuleListKey": { + "$ref": "./examples/EventHubs/EHEventHubAuthorizationRuleListKey.json" + } + }, + "description": "Gets the ACS and SAS connection strings for the Event Hub.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/EventHubNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings successfully returned.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}/regenerateKeys": { + "post": { + "tags": [ + "AuthorizationRules EventHubs" + ], + "operationId": "EventHubs_RegenerateKeys", + "x-ms-examples": { + "EventHubAuthorizationRuleRegenerateKey": { + "$ref": "./examples/EventHubs/EHEventHubAuthorizationRuleRegenerateKey.json" + } + }, + "description": "Regenerates the ACS and SAS connection strings for the Event Hub.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/EventHubNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateAccessKeyParameters" + }, + "description": "Parameters supplied to regenerate the AuthorizationRule Keys (PrimaryKey/SecondaryKey)." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings successfully regenerated.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "AuthorizationRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AuthorizationRule" + }, + "description": "Result of the List Authorization Rules operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains an incomplete list of Authorization Rules" + } + }, + "description": "The response from the List namespace operation." + }, + "AuthorizationRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "rights": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Manage", + "Send", + "Listen" + ], + "x-ms-enum": { + "name": "AccessRights", + "modelAsString": true + } + }, + "description": "The rights associated with the rule." + } + }, + "required": [ + "rights" + ], + "description": "Properties supplied to create or update AuthorizationRule" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Single item in a List or Get AuthorizationRule operation" + }, + "AccessKeys": { + "properties": { + "primaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Primary connection string of the created namespace AuthorizationRule." + }, + "secondaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Secondary connection string of the created namespace AuthorizationRule." + }, + "aliasPrimaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Primary connection string of the alias if GEO DR is enabled" + }, + "aliasSecondaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Secondary connection string of the alias if GEO DR is enabled" + }, + "primaryKey": { + "readOnly": true, + "type": "string", + "description": "A base64-encoded 256-bit primary key for signing and validating the SAS token." + }, + "secondaryKey": { + "readOnly": true, + "type": "string", + "description": "A base64-encoded 256-bit primary key for signing and validating the SAS token." + }, + "keyName": { + "readOnly": true, + "type": "string", + "description": "A string that describes the AuthorizationRule." + } + }, + "description": "Namespace/EventHub Connection String" + }, + "RegenerateAccessKeyParameters": { + "properties": { + "keyType": { + "type": "string", + "description": "The access key to regenerate.", + "enum": [ + "PrimaryKey", + "SecondaryKey" + ], + "x-ms-enum": { + "name": "KeyType", + "modelAsString": false + } + }, + "key": { + "type": "string", + "description": "Optional, if the key value provided, is set for KeyType or autogenerated Key value set for keyType" + } + }, + "required": [ + "keyType" + ], + "description": "Parameters supplied to the Regenerate Authorization Rule operation, specifies which key needs to be reset." + } + }, + "parameters": {} +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/CheckNameAvailability.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/CheckNameAvailability.json new file mode 100644 index 000000000000..dcd81b5cf627 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/CheckNameAvailability.json @@ -0,0 +1,132 @@ +{ + "swagger": "2.0", + "info": { + "title": "EventHubManagementClient", + "description": "Azure Event Hubs client", + "version": "2021-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.EventHub/checkNameAvailability": { + "post": { + "tags": [ + "CheckNameAvailability Namespaces" + ], + "operationId": "Namespaces_CheckNameAvailability", + "x-ms-examples": { + "NamespacesCheckNameAvailability": { + "$ref": "./examples/NameSpaces/EHNameSpaceCheckNameAvailability.json" + } + }, + "description": "Check the give Namespace name availability.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityParameter" + }, + "description": "Parameters to check availability of the given Namespace name" + } + ], + "responses": { + "200": { + "description": "check availability returned successfully.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "UnavailableReason": { + "type": "string", + "enum": [ + "None", + "InvalidName", + "SubscriptionIsDisabled", + "NameInUse", + "NameInLockdown", + "TooManyNamespaceInCurrentSubscription" + ], + "x-ms-enum": { + "name": "UnavailableReason", + "modelAsString": false + }, + "description": "Specifies the reason for the unavailability of the service." + }, + "CheckNameAvailabilityParameter": { + "properties": { + "name": { + "type": "string", + "description": "Name to check the namespace name availability" + } + }, + "required": [ + "name" + ], + "description": "Parameter supplied to check Namespace name availability operation " + }, + "CheckNameAvailabilityResult": { + "properties": { + "message": { + "type": "string", + "readOnly": true, + "description": "The detailed info regarding the reason associated with the Namespace." + }, + "nameAvailable": { + "type": "boolean", + "description": "Value indicating Namespace is availability, true if the Namespace is available; otherwise, false." + }, + "reason": { + "$ref": "#/definitions/UnavailableReason", + "description": "The reason for unavailability of a Namespace." + } + }, + "description": "The Result of the CheckNameAvailability operation" + } + }, + "parameters": {} +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/consumergroups.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/consumergroups.json new file mode 100644 index 000000000000..03e7ed51d766 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/consumergroups.json @@ -0,0 +1,297 @@ +{ + "swagger": "2.0", + "info": { + "title": "EventHubManagementClient", + "description": "Azure Event Hubs client", + "version": "2021-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups/{consumerGroupName}": { + "put": { + "tags": [ + "ConsumerGroups" + ], + "operationId": "ConsumerGroups_CreateOrUpdate", + "x-ms-examples": { + "ConsumerGroupCreate": { + "$ref": "./examples/ConsumerGroup/EHConsumerGroupCreate.json" + } + }, + "description": "Creates or updates an Event Hubs consumer group as a nested resource within a Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/EventHubNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ConsumerGroupNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConsumerGroup" + }, + "description": "Parameters supplied to create or update a consumer group resource." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Consumer group successfully created.", + "schema": { + "$ref": "#/definitions/ConsumerGroup" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ConsumerGroups" + ], + "operationId": "ConsumerGroups_Delete", + "x-ms-examples": { + "ConsumerGroupDelete": { + "$ref": "./examples/ConsumerGroup/EHConsumerGroupDelete.json" + } + }, + "description": "Deletes a consumer group from the specified Event Hub and resource group.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/EventHubNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ConsumerGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Consumer group deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ConsumerGroups" + ], + "operationId": "ConsumerGroups_Get", + "x-ms-examples": { + "ConsumerGroupGet": { + "$ref": "./examples/ConsumerGroup/EHConsumerGroupGet.json" + } + }, + "description": "Gets a description for the specified consumer group.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/EventHubNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ConsumerGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the consumer group description.", + "schema": { + "$ref": "#/definitions/ConsumerGroup" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups": { + "get": { + "tags": [ + "ConsumerGroups" + ], + "operationId": "ConsumerGroups_ListByEventHub", + "x-ms-examples": { + "ConsumerGroupsListAll": { + "$ref": "./examples/ConsumerGroup/EHConsumerGroupListByEventHub.json" + } + }, + "description": "Gets all the consumer groups in a Namespace. An empty feed is returned if no consumer group exists in the Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/EventHubNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SkipParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of consumer groups.", + "schema": { + "$ref": "#/definitions/ConsumerGroupListResult" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ConsumerGroup": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "createdAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "Exact time the message was created." + }, + "updatedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the message was updated." + }, + "userMetadata": { + "type": "string", + "description": "User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored." + } + }, + "description": "Single item in List or Get Consumer group operation" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Single item in List or Get Consumer group operation" + }, + "ConsumerGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ConsumerGroup" + }, + "description": "Result of the List Consumer Group operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of Consumer Group" + } + }, + "description": "The result to the List Consumer Group operation." + } + }, + "parameters": {} +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/disasterRecoveryConfigs.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/disasterRecoveryConfigs.json new file mode 100644 index 000000000000..e0901c9318c3 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/disasterRecoveryConfigs.json @@ -0,0 +1,487 @@ +{ + "swagger": "2.0", + "info": { + "title": "EventHubManagementClient", + "description": "Azure Event Hubs client", + "version": "2021-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/checkNameAvailability": { + "post": { + "tags": [ + "CheckNameAvailability DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_CheckNameAvailability", + "x-ms-examples": { + "NamespacesCheckNameAvailability": { + "$ref": "./examples/disasterRecoveryConfigs/EHAliasCheckNameAvailability.json" + } + }, + "description": "Check the give Namespace name availability.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityParameter" + }, + "description": "Parameters to check availability of the given Alias name" + } + ], + "responses": { + "200": { + "description": "check availability returned successfully.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs": { + "get": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_List", + "x-ms-examples": { + "EHAliasList": { + "$ref": "./examples/disasterRecoveryConfigs/EHAliasList.json" + } + }, + "description": "Gets all Alias(Disaster Recovery configurations)", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of Alias(Disaster Recovery configurations) for eventhub namespace", + "schema": { + "$ref": "#/definitions/ArmDisasterRecoveryListResult" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}": { + "put": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_CreateOrUpdate", + "x-ms-examples": { + "EHAliasCreate": { + "$ref": "./examples/disasterRecoveryConfigs/EHAliasCreate.json" + } + }, + "description": "Creates or updates a new Alias(Disaster Recovery configuration)", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArmDisasterRecovery" + }, + "description": "Parameters required to create an Alias(Disaster Recovery configuration)" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Alias(Disaster Recovery configuration) successfully created", + "schema": { + "$ref": "#/definitions/ArmDisasterRecovery" + } + }, + "201": { + "description": "Alias(Disaster Recovery configuration) creation request received" + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_Delete", + "x-ms-examples": { + "EHAliasDelete": { + "$ref": "./examples/disasterRecoveryConfigs/EHAliasDelete.json" + } + }, + "description": "Deletes an Alias(Disaster Recovery configuration)", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete Alias(Disaster Recovery configuration) request accepted" + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_Get", + "x-ms-examples": { + "EHAliasGet": { + "$ref": "./examples/disasterRecoveryConfigs/EHAliasGet.json" + } + }, + "description": "Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the Alias(Disaster Recovery configurations)", + "schema": { + "$ref": "#/definitions/ArmDisasterRecovery" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/breakPairing": { + "post": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_BreakPairing", + "x-ms-examples": { + "EHAliasBreakPairing": { + "$ref": "./examples/disasterRecoveryConfigs/EHAliasBreakPairing.json" + } + }, + "description": "This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Break-Pairing operation is successful." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/failover": { + "post": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_FailOver", + "x-ms-examples": { + "EHAliasFailOver": { + "$ref": "./examples/disasterRecoveryConfigs/EHAliasFailOver.json" + } + }, + "description": "Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Failover operation is successful." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "UnavailableReason": { + "type": "string", + "enum": [ + "None", + "InvalidName", + "SubscriptionIsDisabled", + "NameInUse", + "NameInLockdown", + "TooManyNamespaceInCurrentSubscription" + ], + "x-ms-enum": { + "name": "UnavailableReason", + "modelAsString": false + }, + "description": "Specifies the reason for the unavailability of the service." + }, + "CheckNameAvailabilityParameter": { + "properties": { + "name": { + "type": "string", + "description": "Name to check the namespace name availability" + } + }, + "required": [ + "name" + ], + "description": "Parameter supplied to check Namespace name availability operation " + }, + "CheckNameAvailabilityResult": { + "properties": { + "message": { + "type": "string", + "readOnly": true, + "description": "The detailed info regarding the reason associated with the Namespace." + }, + "nameAvailable": { + "type": "boolean", + "description": "Value indicating Namespace is availability, true if the Namespace is available; otherwise, false." + }, + "reason": { + "$ref": "#/definitions/UnavailableReason", + "description": "The reason for unavailability of a Namespace." + } + }, + "description": "The Result of the CheckNameAvailability operation" + }, + "ArmDisasterRecovery": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed'", + "enum": [ + "Accepted", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningStateDR", + "modelAsString": false + } + }, + "partnerNamespace": { + "type": "string", + "description": "ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing" + }, + "alternateName": { + "type": "string", + "description": "Alternate name specified when alias and namespace names are same." + }, + "role": { + "readOnly": true, + "type": "string", + "description": "role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary'", + "enum": [ + "Primary", + "PrimaryNotReplicating", + "Secondary" + ], + "x-ms-enum": { + "name": "RoleDisasterRecovery", + "modelAsString": false + } + }, + "pendingReplicationOperationsCount": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "Number of entities pending to be replicated." + } + }, + "description": "Properties required to the Create Or Update Alias(Disaster Recovery configurations)" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Single item in List or Get Alias(Disaster Recovery configuration) operation" + }, + "ArmDisasterRecoveryListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ArmDisasterRecovery" + }, + "description": "List of Alias(Disaster Recovery configurations)" + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if Value contains incomplete list of Alias(Disaster Recovery configuration)" + } + }, + "description": "The result of the List Alias(Disaster Recovery configuration) operation." + } + }, + "parameters": {} +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/eventhubs.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/eventhubs.json new file mode 100644 index 000000000000..7358d881becb --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/eventhubs.json @@ -0,0 +1,394 @@ +{ + "swagger": "2.0", + "info": { + "title": "EventHubManagementClient", + "description": "Azure Event Hubs client", + "version": "2021-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs": { + "get": { + "tags": [ + "EventHubs" + ], + "operationId": "EventHubs_ListByNamespace", + "x-ms-examples": { + "EventHubsListAll": { + "$ref": "./examples/EventHubs/EHEventHubListByNameSpace.json" + } + }, + "description": "Gets all the Event Hubs in a Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SkipParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of Event Hubs.", + "schema": { + "$ref": "#/definitions/EventHubListResult" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}": { + "put": { + "tags": [ + "EventHubs" + ], + "operationId": "EventHubs_CreateOrUpdate", + "x-ms-examples": { + "EventHubCreate": { + "$ref": "./examples/EventHubs/EHEventHubCreate.json" + } + }, + "description": "Creates or updates a new Event Hub as a nested resource within a Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/EventHubNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Eventhub" + }, + "description": "Parameters supplied to create an Event Hub resource." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Event Hub successfully created.", + "schema": { + "$ref": "#/definitions/Eventhub" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "EventHubs" + ], + "operationId": "EventHubs_Delete", + "x-ms-examples": { + "EventHubDelete": { + "$ref": "./examples/EventHubs/EHEventHubDelete.json" + } + }, + "description": "Deletes an Event Hub from the specified Namespace and resource group.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/EventHubNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Event Hub successfully deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "EventHubs" + ], + "operationId": "EventHubs_Get", + "x-ms-examples": { + "EventHubGet": { + "$ref": "./examples/EventHubs/EHEventHubGet.json" + } + }, + "description": "Gets an Event Hubs description for the specified Event Hub.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/EventHubNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the Event Hub description.", + "schema": { + "$ref": "#/definitions/Eventhub" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "CaptureDescription": { + "properties": { + "enabled": { + "type": "boolean", + "description": "A value that indicates whether capture description is enabled. " + }, + "encoding": { + "type": "string", + "description": "Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version", + "enum": [ + "Avro", + "AvroDeflate" + ], + "x-ms-enum": { + "name": "EncodingCaptureDescription", + "modelAsString": false + } + }, + "intervalInSeconds": { + "format": "int32", + "type": "integer", + "maximum": 900, + "minimum": 60, + "description": "The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds" + }, + "sizeLimitInBytes": { + "format": "int32", + "type": "integer", + "maximum": 524288000, + "minimum": 10485760, + "description": "The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes" + }, + "destination": { + "$ref": "#/definitions/Destination", + "description": "Properties of Destination where capture will be stored. (Storage Account, Blob Names)" + }, + "skipEmptyArchives": { + "type": "boolean", + "description": "A value that indicates whether to Skip Empty Archives" + } + }, + "description": "Properties to configure capture description for eventhub" + }, + "Eventhub": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "partitionIds": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "Current number of shards on the Event Hub." + }, + "createdAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "Exact time the Event Hub was created." + }, + "updatedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the message was updated." + }, + "messageRetentionInDays": { + "format": "int64", + "type": "integer", + "minimum": 1, + "description": "Number of days to retain the events for this Event Hub, value should be 1 to 7 days" + }, + "partitionCount": { + "format": "int64", + "type": "integer", + "minimum": 1, + "description": "Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions." + }, + "status": { + "type": "string", + "description": "Enumerates the possible values for the status of the Event Hub.", + "enum": [ + "Active", + "Disabled", + "Restoring", + "SendDisabled", + "ReceiveDisabled", + "Creating", + "Deleting", + "Renaming", + "Unknown" + ], + "x-ms-enum": { + "name": "EntityStatus", + "modelAsString": false + } + }, + "captureDescription": { + "$ref": "#/definitions/CaptureDescription", + "description": "Properties of capture description" + } + }, + "description": "Properties supplied to the Create Or Update Event Hub operation." + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Single item in List or Get Event Hub operation" + }, + "EventHubListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Eventhub" + }, + "description": "Result of the List EventHubs operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of EventHubs." + } + }, + "description": "The result of the List EventHubs operation." + }, + "Destination": { + "properties": { + "name": { + "type": "string", + "description": "Name for capture destination" + }, + "properties": { + "x-ms-client-flatten": true, + "properties": { + "storageAccountResourceId": { + "type": "string", + "description": "Resource id of the storage account to be used to create the blobs" + }, + "blobContainer": { + "type": "string", + "description": "Blob container Name" + }, + "archiveNameFormat": { + "type": "string", + "description": "Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order" + } + }, + "description": "Properties describing the storage account, blob container and archive name format for capture destination" + } + }, + "description": "Capture storage details for capture description" + } + }, + "parameters": {} +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/ConsumerGroup/EHConsumerGroupCreate.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/ConsumerGroup/EHConsumerGroupCreate.json new file mode 100644 index 000000000000..255a140555b6 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/ConsumerGroup/EHConsumerGroupCreate.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-Namespace-2661", + "eventHubName": "sdk-EventHub-6681", + "consumerGroupName": "sdk-ConsumerGroup-5563", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "properties": { + "userMetadata": "New consumergroup" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-2661/eventhubs/sdk-EventHub-6681/consumergroups/sdk-ConsumerGroup-5563", + "name": "sdk-ConsumerGroup-5563", + "type": "Microsoft.EventHub/Namespaces/EventHubs/ConsumerGroups", + "properties": { + "createdAt": "2017-05-25T03:43:09.4536234Z", + "updatedAt": "2017-05-25T03:43:09.4536234Z" + } + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/ConsumerGroup/EHConsumerGroupDelete.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/ConsumerGroup/EHConsumerGroupDelete.json new file mode 100644 index 000000000000..d98c7f893c62 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/ConsumerGroup/EHConsumerGroupDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-Namespace-2661", + "eventHubName": "sdk-EventHub-6681", + "consumerGroupName": "sdk-ConsumerGroup-5563", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/ConsumerGroup/EHConsumerGroupGet.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/ConsumerGroup/EHConsumerGroupGet.json new file mode 100644 index 000000000000..35a01a3cea90 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/ConsumerGroup/EHConsumerGroupGet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-Namespace-2661", + "eventHubName": "sdk-EventHub-6681", + "consumerGroupName": "sdk-ConsumerGroup-5563", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-2661/eventhubs/sdk-EventHub-6681/consumergroups/sdk-ConsumerGroup-5563", + "name": "sdk-ConsumerGroup-5563", + "type": "Microsoft.EventHub/Namespaces/EventHubs/ConsumerGroups", + "properties": { + "createdAt": "2017-05-25T03:43:08.7152556Z", + "updatedAt": "2017-05-25T03:43:08.7152556Z" + } + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/ConsumerGroup/EHConsumerGroupListByEventHub.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/ConsumerGroup/EHConsumerGroupListByEventHub.json new file mode 100644 index 000000000000..124dc4fb7eea --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/ConsumerGroup/EHConsumerGroupListByEventHub.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-Namespace-2661", + "eventHubName": "sdk-EventHub-6681", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-2661/eventhubs/sdk-EventHub-6681/consumergroups/$Default", + "name": "$Default", + "type": "Microsoft.EventHub/Namespaces/EventHubs/ConsumerGroups", + "properties": { + "createdAt": "2017-05-25T03:42:52.287Z", + "updatedAt": "2017-05-25T03:42:52.287Z" + } + }, + { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-2661/eventhubs/sdk-EventHub-6681/consumergroups/sdk-consumergroup-5563", + "name": "sdk-consumergroup-5563", + "type": "Microsoft.EventHub/Namespaces/EventHubs/ConsumerGroups", + "properties": { + "createdAt": "2017-05-25T03:43:09.314Z", + "updatedAt": "2017-05-25T03:43:09.314Z" + } + } + ] + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EHOperations_List.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EHOperations_List.json new file mode 100644 index 000000000000..87b2a2f3a793 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EHOperations_List.json @@ -0,0 +1,213 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.EventHub/checkNameAvailability/action", + "display": { + "provider": "Microsoft Azure EventHub", + "resource": "Non Resource Operation", + "operation": "Get namespace availability." + } + }, + { + "name": "Microsoft.EventHub/register/action", + "display": { + "provider": "Microsoft Azure EventHub", + "resource": "EventHub Resource Provider", + "operation": "Registers the EventHub Resource Provider" + } + }, + { + "name": "Microsoft.EventHub/namespaces/write", + "display": { + "provider": "Microsoft Azure EventHub", + "resource": "Namespace", + "operation": "Create Or Update Namespace " + } + }, + { + "name": "Microsoft.EventHub/namespaces/read", + "display": { + "provider": "Microsoft Azure EventHub", + "resource": "Namespace", + "operation": "Get Namespace Resource" + } + }, + { + "name": "Microsoft.EventHub/namespaces/Delete", + "display": { + "provider": "Microsoft Azure EventHub", + "resource": "Namespace", + "operation": "Delete Namespace" + } + }, + { + "name": "Microsoft.EventHub/namespaces/authorizationRules/read", + "display": { + "provider": "Microsoft Azure EventHub", + "resource": "AuthorizationRules", + "operation": "Get Namespace Authorization Rules" + } + }, + { + "name": "Microsoft.EventHub/namespaces/authorizationRules/write", + "display": { + "provider": "Microsoft Azure EventHub", + "resource": "AuthorizationRules", + "operation": "Create or Update Namespace Authorization Rules" + } + }, + { + "name": "Microsoft.EventHub/namespaces/authorizationRules/delete", + "display": { + "provider": "Microsoft Azure EventHub", + "resource": "AuthorizationRules", + "operation": "Delete Namespace Authorization Rule" + } + }, + { + "name": "Microsoft.EventHub/namespaces/authorizationRules/listkeys/action", + "display": { + "provider": "Microsoft Azure EventHub", + "resource": "AuthorizationRules", + "operation": "Get Namespace Listkeys" + } + }, + { + "name": "Microsoft.EventHub/namespaces/authorizationRules/regenerateKeys/action", + "display": { + "provider": "Microsoft Azure EventHub", + "resource": "AuthorizationRules", + "operation": "Resource Regeneratekeys" + } + }, + { + "name": "Microsoft.EventHub/namespaces/eventhubs/write", + "display": { + "provider": "Microsoft Azure EventHub", + "resource": "EventHub", + "operation": "Create or Update EventHub" + } + }, + { + "name": "Microsoft.EventHub/namespaces/eventhubs/read", + "display": { + "provider": "Microsoft Azure EventHub", + "resource": "EventHub", + "operation": "Get EventHub" + } + }, + { + "name": "Microsoft.EventHub/namespaces/eventhubs/Delete", + "display": { + "provider": "Microsoft Azure EventHub", + "resource": "EventHub", + "operation": "Delete EventHub" + } + }, + { + "name": "Microsoft.EventHub/namespaces/eventhubs/authorizationRules/read", + "display": { + "provider": "Microsoft Azure EventHub", + "resource": "EventHub AuthorizationRules", + "operation": " Get EventHub Authorization Rules" + } + }, + { + "name": "Microsoft.EventHub/namespaces/eventhubs/authorizationRules/write", + "display": { + "provider": "Microsoft Azure EventHub", + "resource": "EventHub AuthorizationRules", + "operation": "Create or Update EventHub Authorization Rule" + } + }, + { + "name": "Microsoft.EventHub/namespaces/eventhubs/authorizationRules/delete", + "display": { + "provider": "Microsoft Azure EventHub", + "resource": "EventHub AuthorizationRules", + "operation": "Delete EventHub Authorization Rules" + } + }, + { + "name": "Microsoft.EventHub/namespaces/eventhubs/authorizationRules/listkeys/action", + "display": { + "provider": "Microsoft Azure EventHub", + "resource": "EventHub AuthorizationRules", + "operation": "List EventHub keys" + } + }, + { + "name": "Microsoft.EventHub/namespaces/eventhubs/authorizationRules/regenerateKeys/action", + "display": { + "provider": "Microsoft Azure EventHub", + "resource": "EventHub AuthorizationRules", + "operation": "Resource Regeneratekeys" + } + }, + { + "name": "Microsoft.EventHub/namespaces/eventHubs/consumergroups/write", + "display": { + "provider": "Microsoft Azure EventHub", + "resource": "ConsumerGroup", + "operation": "Create or Update ConsumerGroup" + } + }, + { + "name": "Microsoft.EventHub/namespaces/eventHubs/consumergroups/read", + "display": { + "provider": "Microsoft Azure EventHub", + "resource": "ConsumerGroup", + "operation": "Get ConsumerGroup" + } + }, + { + "name": "Microsoft.EventHub/namespaces/eventHubs/consumergroups/Delete", + "display": { + "provider": "Microsoft Azure EventHub", + "resource": "ConsumerGroup", + "operation": "Delete ConsumerGroup" + } + }, + { + "name": "Microsoft.EventHub/namespaces/metricDefinitions/read", + "display": { + "provider": "Microsoft Azure EventHub", + "resource": "Namespace metrics", + "operation": "Get Namespace metrics" + } + }, + { + "name": "Microsoft.EventHub/namespaces/diagnosticSettings/read", + "display": { + "provider": "Microsoft Azure EventHub", + "resource": "Namespace diagnostic settings", + "operation": "Get Namespace diagnostic settings" + } + }, + { + "name": "Microsoft.EventHub/namespaces/diagnosticSettings/write", + "display": { + "provider": "Microsoft Azure EventHub", + "resource": "Namespace diagnostic settings", + "operation": "Create or Update Namespace diagnostic settings" + } + }, + { + "name": "Microsoft.EventHub/namespaces/logDefinitions/read", + "display": { + "provider": "Microsoft Azure EventHub", + "resource": "Namespace logs", + "operation": "Get Namespace logs" + } + } + ] + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EventHubs/EHEventHubAuthorizationRuleCreate.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EventHubs/EHEventHubAuthorizationRuleCreate.json new file mode 100644 index 000000000000..61d5347f1af7 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EventHubs/EHEventHubAuthorizationRuleCreate.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-Namespace-960", + "eventHubName": "sdk-EventHub-532", + "authorizationRuleName": "sdk-Authrules-2513", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-960/eventhubs/sdk-EventHub-532/authorizationRules/sdk-Authrules-2513", + "name": "sdk-Authrules-2513", + "type": "Microsoft.EventHub/Namespaces/EventHubs/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EventHubs/EHEventHubAuthorizationRuleDelete.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EventHubs/EHEventHubAuthorizationRuleDelete.json new file mode 100644 index 000000000000..c0b2911a041b --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EventHubs/EHEventHubAuthorizationRuleDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-Namespace-960", + "eventHubName": "sdk-EventHub-532", + "authorizationRuleName": "sdk-Authrules-2513", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EventHubs/EHEventHubAuthorizationRuleGet.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EventHubs/EHEventHubAuthorizationRuleGet.json new file mode 100644 index 000000000000..11ad7b5e2824 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EventHubs/EHEventHubAuthorizationRuleGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-Namespace-960", + "eventHubName": "sdk-EventHub-532", + "authorizationRuleName": "sdk-Authrules-2513", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-960/eventhubs/sdk-EventHub-532/authorizationRules/sdk-Authrules-2513", + "name": "sdk-Authrules-2513", + "type": "Microsoft.EventHub/Namespaces/EventHubs/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EventHubs/EHEventHubAuthorizationRuleListAll.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EventHubs/EHEventHubAuthorizationRuleListAll.json new file mode 100644 index 000000000000..0e0cf8dc8ae9 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EventHubs/EHEventHubAuthorizationRuleListAll.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-Namespace-960", + "eventHubName": "sdk-EventHub-532", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-960/eventhubs/sdk-EventHub-532/authorizationRules/sdk-Authrules-2513", + "name": "sdk-Authrules-2513", + "type": "Microsoft.EventHub/Namespaces/EventHubs/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + ] + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EventHubs/EHEventHubAuthorizationRuleListKey.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EventHubs/EHEventHubAuthorizationRuleListKey.json new file mode 100644 index 000000000000..e8333e37993c --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EventHubs/EHEventHubAuthorizationRuleListKey.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-namespace-960", + "eventHubName": "sdk-EventHub-532", + "authorizationRuleName": "sdk-Authrules-2513", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "primaryConnectionString": "Endpoint=sb://sdk-namespace-960.servicebus.windows-int.net/;SharedAccessKeyName=sdk-Authrules-2513;SharedAccessKey=############################################;EntityPath=sdk-EventHub-532", + "secondaryConnectionString": "Endpoint=sb://sdk-namespace-960.servicebus.windows-int.net/;SharedAccessKeyName=sdk-Authrules-2513;SharedAccessKey=############################################;EntityPath=sdk-EventHub-532", + "primaryKey": "############################################", + "secondaryKey": "############################################", + "keyName": "sdk-Authrules-2513" + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EventHubs/EHEventHubAuthorizationRuleRegenerateKey.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EventHubs/EHEventHubAuthorizationRuleRegenerateKey.json new file mode 100644 index 000000000000..d5a453a9727e --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EventHubs/EHEventHubAuthorizationRuleRegenerateKey.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-namespace-960", + "eventHubName": "sdk-EventHub-532", + "authorizationRuleName": "sdk-Authrules-1534", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "keyType": "PrimaryKey" + } + }, + "responses": { + "200": { + "body": { + "primaryConnectionString": "Endpoint=sb://sdk-namespace-9027.servicebus.windows-int.net/;SharedAccessKeyName=sdk-Authrules-1534;SharedAccessKey=#############################################;EntityPath=sdk-EventHub-1647", + "secondaryConnectionString": "Endpoint=sb://sdk-namespace-9027.servicebus.windows-int.net/;SharedAccessKeyName=sdk-Authrules-1534;SharedAccessKey=#############################################;EntityPath=sdk-EventHub-1647", + "primaryKey": "#############################################", + "secondaryKey": "#############################################", + "keyName": "sdk-Authrules-1534" + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EventHubs/EHEventHubCreate.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EventHubs/EHEventHubCreate.json new file mode 100644 index 000000000000..8da3ef2218fe --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EventHubs/EHEventHubCreate.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5357", + "resourceGroupName": "Default-NotificationHubs-AustraliaEast", + "eventHubName": "sdk-EventHub-6547", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "properties": { + "messageRetentionInDays": 4, + "partitionCount": 4, + "status": "Active", + "captureDescription": { + "enabled": true, + "encoding": "Avro", + "intervalInSeconds": 120, + "sizeLimitInBytes": 10485763, + "destination": { + "name": "EventHubArchive.AzureBlockBlob", + "properties": { + "storageAccountResourceId": "/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-Storage-SouthCentralUS/providers/Microsoft.ClassicStorage/storageAccounts/arjunteststorage", + "blobContainer": "container", + "archiveNameFormat": "{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-NotificationHubs-AustraliaEast/providers/Microsoft.EventHub/namespaces/sdk-Namespace-716/eventhubs/sdk-EventHub-10", + "name": "sdk-EventHub-10", + "type": "Microsoft.EventHub/Namespaces/EventHubs", + "properties": { + "messageRetentionInDays": 4, + "partitionCount": 4, + "status": "Active", + "createdAt": "2017-06-28T02:45:55.877Z", + "updatedAt": "2017-06-28T02:46:05.877Z", + "partitionIds": [ + "0", + "1", + "2", + "3" + ], + "captureDescription": { + "enabled": true, + "encoding": "Avro", + "destination": { + "name": "EventHubArchive.AzureBlockBlob", + "properties": { + "storageAccountResourceId": "/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-Storage-SouthCentralUS/providers/Microsoft.ClassicStorage/storageAccounts/arjunteststorage", + "blobContainer": "container", + "archiveNameFormat": "{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}" + } + }, + "intervalInSeconds": 120, + "sizeLimitInBytes": 10485763 + } + } + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EventHubs/EHEventHubDelete.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EventHubs/EHEventHubDelete.json new file mode 100644 index 000000000000..81e15cf93422 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EventHubs/EHEventHubDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5357", + "resourceGroupName": "ArunMonocle", + "eventHubName": "sdk-EventHub-6547", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EventHubs/EHEventHubGet.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EventHubs/EHEventHubGet.json new file mode 100644 index 000000000000..7e92cca06784 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EventHubs/EHEventHubGet.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-716", + "resourceGroupName": "Default-NotificationHubs-AustraliaEast", + "eventHubName": "sdk-EventHub-10", + "api-version": "2021-06-01-preview", + "subscriptionId": "e2f361f0-3b27-4503-a9cc-21cfba380093" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-NotificationHubs-AustraliaEast/providers/Microsoft.EventHub/namespaces/sdk-Namespace-716/eventhubs/sdk-EventHub-10", + "name": "sdk-EventHub-10", + "type": "Microsoft.EventHub/Namespaces/EventHubs", + "properties": { + "messageRetentionInDays": 4, + "partitionCount": 4, + "status": "Active", + "createdAt": "2017-06-28T02:45:55.877Z", + "updatedAt": "2017-06-28T02:46:05.877Z", + "partitionIds": [ + "0", + "1", + "2", + "3" + ], + "captureDescription": { + "enabled": true, + "encoding": "Avro", + "destination": { + "name": "EventHubArchive.AzureBlockBlob", + "properties": { + "storageAccountResourceId": "/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-Storage-SouthCentralUS/providers/Microsoft.ClassicStorage/storageAccounts/arjunteststorage", + "blobContainer": "container", + "archiveNameFormat": "{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}" + } + }, + "intervalInSeconds": 120, + "sizeLimitInBytes": 10485763 + } + } + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EventHubs/EHEventHubListByNameSpace.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EventHubs/EHEventHubListByNameSpace.json new file mode 100644 index 000000000000..18d529883898 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/EventHubs/EHEventHubListByNameSpace.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5357", + "resourceGroupName": "Default-NotificationHubs-AustraliaEast", + "api-version": "2021-06-01-preview", + "eventHubName": "sdk-eventhub-10", + "subscriptionId": "e2f361f0-3b27-4503-a9cc-21cfba380093" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-NotificationHubs-AustraliaEast/providers/Microsoft.EventHub/namespaces/sdk-Namespace-716/eventhubs/sdk-eventhub-10", + "name": "sdk-eventhub-10", + "type": "Microsoft.EventHub/Namespaces/EventHubs", + "properties": { + "messageRetentionInDays": 4, + "partitionCount": 4, + "status": "Active", + "createdAt": "2017-06-28T02:45:55.877Z", + "updatedAt": "2017-06-28T02:46:05.877Z", + "partitionIds": [ + "0", + "1", + "2", + "3" + ], + "captureDescription": { + "enabled": true, + "encoding": "Avro", + "destination": { + "name": "EventHubArchive.AzureBlockBlob", + "properties": { + "storageAccountResourceId": "/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-Storage-SouthCentralUS/providers/Microsoft.ClassicStorage/storageAccounts/arjunteststorage", + "blobContainer": "container", + "archiveNameFormat": "{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}" + } + }, + "intervalInSeconds": 120, + "sizeLimitInBytes": 10485763 + } + } + } + ] + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceAuthorizationRuleCreate.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceAuthorizationRuleCreate.json new file mode 100644 index 000000000000..f5c3834d12db --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceAuthorizationRuleCreate.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-2702", + "authorizationRuleName": "sdk-Authrules-1746", + "resourceGroupName": "ArunMonocle", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-2702/AuthorizationRules/sdk-Authrules-1746", + "name": "sdk-Authrules-1746", + "type": "Microsoft.EventHub/Namespaces/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceAuthorizationRuleDelete.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceAuthorizationRuleDelete.json new file mode 100644 index 000000000000..d4b4aa728754 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceAuthorizationRuleDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-8980", + "authorizationRuleName": "sdk-Authrules-8929", + "resourceGroupName": "ArunMonocle", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceAuthorizationRuleGet.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceAuthorizationRuleGet.json new file mode 100644 index 000000000000..8ac18ec69b19 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceAuthorizationRuleGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-2702", + "authorizationRuleName": "sdk-Authrules-1746", + "resourceGroupName": "ArunMonocle", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-2702/AuthorizationRules/sdk-Authrules-1746", + "name": "sdk-Authrules-1746", + "type": "Microsoft.EventHub/Namespaces/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceAuthorizationRuleListAll.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceAuthorizationRuleListAll.json new file mode 100644 index 000000000000..a7fdca1276da --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceAuthorizationRuleListAll.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-2702", + "resourceGroupName": "ArunMonocle", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-2702/AuthorizationRules?api-version=2017-04-01/RootManageSharedAccessKey", + "name": "RootManageSharedAccessKey", + "type": "Microsoft.EventHub/Namespaces/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Manage", + "Send" + ] + } + }, + { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-2702/AuthorizationRules?api-version=2017-04-01/sdk-Authrules-1746", + "name": "sdk-Authrules-1746", + "type": "Microsoft.EventHub/Namespaces/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + ] + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceAuthorizationRuleListKey.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceAuthorizationRuleListKey.json new file mode 100644 index 000000000000..1222e51cfd82 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceAuthorizationRuleListKey.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-2702", + "authorizationRuleName": "sdk-Authrules-1746", + "resourceGroupName": "ArunMonocle", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "primaryConnectionString": "Endpoint=sb://sdk-namespace-2702.servicebus.windows-int.net/;SharedAccessKeyName=sdk-Authrules-1746;SharedAccessKey=############################################", + "secondaryConnectionString": "Endpoint=sb://sdk-namespace-2702.servicebus.windows-int.net/;SharedAccessKeyName=sdk-Authrules-1746;SharedAccessKey=############################################", + "primaryKey": "############################################", + "secondaryKey": "############################################", + "keyName": "sdk-Authrules-1746" + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceAuthorizationRuleRegenerateKey.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceAuthorizationRuleRegenerateKey.json new file mode 100644 index 000000000000..79ddb11ef97a --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceAuthorizationRuleRegenerateKey.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-8980", + "authorizationRuleName": "sdk-Authrules-8929", + "resourceGroupName": "ArunMonocle", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "keyType": "PrimaryKey" + } + }, + "responses": { + "200": { + "body": { + "primaryConnectionString": "Endpoint=sb://sdk-namespace-8980.servicebus.windows-int.net/;SharedAccessKeyName=sdk-Authrules-8929;SharedAccessKey=############################################", + "secondaryConnectionString": "Endpoint=sb://sdk-namespace-8980.servicebus.windows-int.net/;SharedAccessKeyName=sdk-Authrules-8929;SharedAccessKey=############################################", + "primaryKey": "############################################", + "secondaryKey": "############################################", + "keyName": "sdk-Authrules-8929" + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceCheckNameAvailability.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceCheckNameAvailability.json new file mode 100644 index 000000000000..c05db6978e98 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceCheckNameAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "name": "sdk-Namespace-8458" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "reason": "None", + "message": "" + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceCreate.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceCreate.json new file mode 100644 index 000000000000..6f61f018b3f7 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceCreate.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "namespaceName": "NamespaceSample", + "resourceGroupName": "ResurceGroupSample", + "api-version": "2021-06-01-preview", + "subscriptionId": "SampleSubscription", + "parameters": { + "location": "East US", + "identity": { + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1": {}, + "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud2": {} + } + }, + "properties": { + "encryption": { + "keyVaultProperties": [ + { + "keyName": "Samplekey", + "keyVaultUri": "https://aprao-keyvault-user.vault-int.azure-int.net/", + "identity": { + "userAssignedIdentity": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1" + } + } + ], + "keySource": "Microsoft.KeyVault" + }, + "clusterArmId": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/clusters/enc-test" + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample", + "name": "NamespaceSample", + "type": "Microsoft.EventHub/Namespaces", + "location": "East US", + "tags": {}, + "identity": { + "principalId": "PrincipalIdGUID", + "tenantId": "TenantIdGUID", + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1": { + "clientId": "ClientIdGUID", + "principalId": "PrincipalIdGUID" + }, + "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud2": { + "clientId": "6a35400f-6ccb-4817-8f1a-ce19ea4523bc", + "principalId": "ce2d5953-5c15-40ca-9d51-cc3f4a63b0f5" + } + } + }, + "properties": { + "zoneRedundant": false, + "isAutoInflateEnabled": false, + "disableLocalAuth": false, + "maximumThroughputUnits": 0, + "encryption": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": [ + { + "keyName": "Samplekey", + "keyVaultUri": "https://sample-keyvault-user.vault-int.azure-int.net", + "keyVersion": "", + "identity": { + "userAssignedIdentity": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1" + } + } + ], + "requireInfrastructureEncryption": false + }, + "clusterArmId": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/clusters/enc-test", + "kafkaEnabled": false, + "provisioningState": "Succeeded", + "metricId": "MetricGUID:NamespaceSample", + "createdAt": "2021-02-16T22:36:06.107Z", + "updatedAt": "2021-02-16T22:37:42.29Z", + "serviceBusEndpoint": "https://NamespaceSample.servicebus.windows-int.net:443/" + } + } + }, + "201": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample", + "name": "NamespaceSample", + "type": "Microsoft.EventHub/Namespaces", + "location": "East US", + "tags": {}, + "identity": { + "principalId": "PrincipalIdGUID", + "tenantId": "TenantIdGUID", + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1": { + "clientId": "ClientIdGUID", + "principalId": "PrincipalIdGUID" + }, + "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud2": { + "clientId": "6a35400f-6ccb-4817-8f1a-ce19ea4523bc", + "principalId": "ce2d5953-5c15-40ca-9d51-cc3f4a63b0f5" + } + } + }, + "properties": { + "zoneRedundant": false, + "isAutoInflateEnabled": false, + "disableLocalAuth": false, + "maximumThroughputUnits": 0, + "encryption": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": [ + { + "keyName": "Samplekey", + "keyVaultUri": "https://sample-keyvault-user.vault-int.azure-int.net", + "keyVersion": "", + "identity": { + "userAssignedIdentity": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1" + } + } + ], + "requireInfrastructureEncryption": false + }, + "clusterArmId": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/clusters/enc-test", + "kafkaEnabled": false, + "provisioningState": "Succeeded", + "metricId": "MetricGUID:NamespaceSample", + "createdAt": "2021-02-16T22:36:06.107Z", + "updatedAt": "2021-02-16T22:37:42.29Z", + "serviceBusEndpoint": "https://NamespaceSample.servicebus.windows-int.net:443/" + } + } + }, + "202": {} + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceDelete.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceDelete.json new file mode 100644 index 000000000000..20ad8440c9dd --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "namespaceName": "NamespaceSample", + "resourceGroupName": "ResurceGroupSample", + "api-version": "2021-06-01-preview", + "subscriptionId": "SampleSubscription" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceGet.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceGet.json new file mode 100644 index 000000000000..3d222c312ab1 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceGet.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "namespaceName": "NamespaceSample", + "resourceGroupName": "ResurceGroupSample", + "api-version": "2021-06-01-preview", + "subscriptionId": "SampleSubscription" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample", + "name": "NamespaceSample", + "type": "Microsoft.EventHub/Namespaces", + "location": "East US", + "tags": {}, + "identity": { + "principalId": "PrincipalIdGUID", + "tenantId": "TenantIdGUID", + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1": { + "clientId": "ClientIdGUID", + "principalId": "PrincipalIdGUID" + }, + "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud2": { + "clientId": "6a35400f-6ccb-4817-8f1a-ce19ea4523bc", + "principalId": "ce2d5953-5c15-40ca-9d51-cc3f4a63b0f5" + } + } + }, + "properties": { + "isAutoInflateEnabled": false, + "disableLocalAuth": false, + "maximumThroughputUnits": 0, + "zoneRedundant": false, + "encryption": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": [ + { + "keyName": "Samplekey", + "keyVaultUri": "https://sample-keyvault-user.vault-int.azure-int.net", + "keyVersion": "", + "identity": { + "userAssignedIdentity": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1" + } + } + ], + "requireInfrastructureEncryption": false + }, + "privateEndpointConnections": [ + { + "id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample/privateEndpointConnections/privateEndpointConnectionName", + "name": "privateEndpointConnectionName", + "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.Network/privateEndpoints/NamespaceSample" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + ], + "provisioningState": "Succeeded", + "clusterArmId": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/clusters/enc-test", + "metricId": "MetricGUID:NamespaceSample", + "createdAt": "2021-01-30T00:28:38.963Z", + "updatedAt": "2021-01-30T00:30:55.143Z", + "serviceBusEndpoint": "https://NamespaceSample.servicebus.windows-int.net:443" + } + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceList.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceList.json new file mode 100644 index 000000000000..d323e3c8adcf --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceList.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "SampleSubscription" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 0 + }, + "id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample", + "name": "NamespaceSample", + "type": "Microsoft.EventHub/Namespaces", + "location": "East US", + "tags": {}, + "identity": { + "principalId": "PrincipalIdGUID", + "tenantId": "TenantIdGUID", + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1": { + "clientId": "ClientIdGUID", + "principalId": "PrincipalIdGUID" + }, + "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud2": { + "clientId": "6a35400f-6ccb-4817-8f1a-ce19ea4523bc", + "principalId": "ce2d5953-5c15-40ca-9d51-cc3f4a63b0f5" + } + } + }, + "properties": { + "isAutoInflateEnabled": false, + "disableLocalAuth": false, + "maximumThroughputUnits": 0, + "zoneRedundant": false, + "encryption": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": [ + { + "keyName": "Samplekey", + "keyVaultUri": "https://sample-keyvault-user.vault-int.azure-int.net", + "keyVersion": "", + "identity": { + "userAssignedIdentity": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1" + } + } + ], + "requireInfrastructureEncryption": false + }, + "clusterArmId": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/clusters/enc-test", + "provisioningState": "Succeeded", + "metricId": "MetricGUID:NamespaceSample", + "createdAt": "2021-01-30T00:28:38.963Z", + "updatedAt": "2021-01-30T00:30:55.143Z", + "serviceBusEndpoint": "https://NamespaceSample.servicebus.windows-int.net:443/" + } + } + ] + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceListByResourceGroup.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceListByResourceGroup.json new file mode 100644 index 000000000000..c9a1d76af344 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceListByResourceGroup.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "SampleSubscription", + "resourceGroupName": "ResurceGroupSample" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample", + "name": "NamespaceSample", + "type": "Microsoft.EventHub/Namespaces", + "location": "East US", + "tags": {}, + "identity": { + "principalId": "PrincipalIdGUID", + "tenantId": "TenantIdGUID", + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1": { + "clientId": "ClientIdGUID", + "principalId": "PrincipalIdGUID" + }, + "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud2": { + "clientId": "6a35400f-6ccb-4817-8f1a-ce19ea4523bc", + "principalId": "ce2d5953-5c15-40ca-9d51-cc3f4a63b0f5" + } + } + }, + "properties": { + "isAutoInflateEnabled": false, + "disableLocalAuth": false, + "maximumThroughputUnits": 0, + "zoneRedundant": false, + "encryption": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": [ + { + "keyName": "Samplekey", + "keyVaultUri": "https://sample-keyvault-user.vault-int.azure-int.net", + "keyVersion": "", + "identity": { + "userAssignedIdentity": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1" + } + } + ], + "requireInfrastructureEncryption": false + }, + "clusterArmId": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/clusters/enc-test", + "provisioningState": "Succeeded", + "metricId": "MetricGUID:NamespaceSample", + "createdAt": "2021-01-30T00:28:38.963Z", + "updatedAt": "2021-01-30T00:30:55.143Z", + "serviceBusEndpoint": "https://NamespaceSample.servicebus.windows-int.net:443/" + } + } + ] + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceUpdate.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceUpdate.json new file mode 100644 index 000000000000..68a8e3359d41 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/EHNameSpaceUpdate.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "namespaceName": "NamespaceSample", + "resourceGroupName": "ResurceGroupSample", + "api-version": "2021-06-01-preview", + "subscriptionId": "SampleSubscription", + "parameters": { + "location": "East US", + "identity": { + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud2": null + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample", + "name": "NamespaceSample", + "type": "Microsoft.EventHub/Namespaces", + "location": "East US", + "tags": {}, + "identity": { + "principalId": "PrincipalIdGUID", + "tenantId": "TenantIdGUID", + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1": { + "clientId": "ClientIdGUID", + "principalId": "PrincipalIdGUID" + } + } + }, + "properties": { + "isAutoInflateEnabled": false, + "disableLocalAuth": false, + "maximumThroughputUnits": 0, + "zoneRedundant": false, + "encryption": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": [ + { + "keyName": "Samplekey", + "keyVaultUri": "https://sample-keyvault-user.vault-int.azure-int.net", + "keyVersion": "", + "identity": { + "userAssignedIdentity": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1" + } + } + ], + "requireInfrastructureEncryption": false + }, + "provisioningState": "ActivatingIdentity", + "metricId": "MetricGUID:NamespaceSample", + "createdAt": "2021-01-30T00:28:38.963Z", + "updatedAt": "2021-01-30T00:31:13.657Z", + "serviceBusEndpoint": "https://NamespaceSample.servicebus.windows-int.net:443/" + } + } + }, + "201": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample", + "name": "NamespaceSample", + "type": "Microsoft.EventHub/Namespaces", + "location": "East US", + "tags": {}, + "identity": { + "principalId": "PrincipalIdGUID", + "tenantId": "TenantIdGUID", + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1": { + "clientId": "ClientIdGUID", + "principalId": "PrincipalIdGUID" + } + } + }, + "properties": { + "isAutoInflateEnabled": false, + "disableLocalAuth": false, + "maximumThroughputUnits": 0, + "zoneRedundant": false, + "encryption": { + "keySource": "Microsoft.KeyVault", + "keyVaultProperties": [ + { + "keyName": "Samplekey", + "keyVaultUri": "https://sample-keyvault-user.vault-int.azure-int.net", + "keyVersion": "", + "identity": { + "userAssignedIdentity": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1" + } + } + ], + "requireInfrastructureEncryption": false + }, + "provisioningState": "ActivatingIdentity", + "metricId": "MetricGUID:NamespaceSample", + "createdAt": "2021-01-30T00:28:38.963Z", + "updatedAt": "2021-01-30T00:31:13.657Z", + "serviceBusEndpoint": "https://NamespaceSample.servicebus.windows-int.net:443/" + } + } + }, + "202": {} + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/PrivateEndPointConnectionCreate.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/PrivateEndPointConnectionCreate.json new file mode 100644 index 000000000000..e7d1d75d4169 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/PrivateEndPointConnectionCreate.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-2924", + "resourceGroupName": "ArunMonocle", + "api-version": "2021-06-01-preview", + "subscriptionId": "subID", + "privateEndpointConnectionName": "privateEndpointConnectionName", + "parameters": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-8396/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-2847" + }, + "privateLinkServiceConnectionState": { + "status": "Rejected", + "description": "testing" + }, + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/PrivateEndPointConnectionDelete.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/PrivateEndPointConnectionDelete.json new file mode 100644 index 000000000000..4b705e98710b --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/PrivateEndPointConnectionDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-3285", + "resourceGroupName": "ArunMonocle", + "privateEndpointConnectionName": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/PrivateEndPointConnectionGet.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/PrivateEndPointConnectionGet.json new file mode 100644 index 000000000000..0f01a1974f97 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/PrivateEndPointConnectionGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5828", + "resourceGroupName": "SDK-EventHub-4794", + "privateEndpointConnectionName": "privateEndpointConnectionName", + "api-version": "2021-06-01-preview", + "subscriptionId": "subID" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5828/privateEndpointConnections/privateEndpointConnectionName", + "name": "privateEndpointConnectionName", + "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/PrivateEndPointConnectionList.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/PrivateEndPointConnectionList.json new file mode 100644 index 000000000000..3a46e3a81b28 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/PrivateEndPointConnectionList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5828", + "resourceGroupName": "SDK-EventHub-4794", + "api-version": "2021-06-01-preview", + "subscriptionId": "subID" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-7182/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5705-new/privateEndpointConnections/5dc668b3-70e4-437f-b61c-a3c1e594be7a", + "name": "5dc668b3-70e4-437f-b61c-a3c1e594be7a", + "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-7182/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5705-new" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + ] + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/PrivateLinkResourcesGet.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/PrivateLinkResourcesGet.json new file mode 100644 index 000000000000..9f660479e22d --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/PrivateLinkResourcesGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-2924", + "resourceGroupName": "ArunMonocle", + "api-version": "2021-06-01-preview", + "subscriptionId": "subID" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/subID/resourceGroups/SDK-EventHub-4794/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5828/privateLinkResources/namespace", + "name": "namespace", + "type": "Microsoft.EventHub/namespaces/privateLinkResources", + "properties": { + "groupId": "namespace", + "requiredMembers": [ + "namespace" + ], + "requiredZoneNames": [ + "privatelink.EventHub.windows.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetCreate.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetCreate.json new file mode 100644 index 000000000000..c3c70fec0a0c --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetCreate.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6019", + "resourceGroupName": "ResourceGroup", + "api-version": "2021-06-01-preview", + "subscriptionId": "Subscription", + "parameters": { + "properties": { + "defaultAction": "Deny", + "virtualNetworkRules": [ + { + "subnet": { + "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2" + }, + "ignoreMissingVnetServiceEndpoint": true + }, + { + "subnet": { + "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3" + }, + "ignoreMissingVnetServiceEndpoint": false + }, + { + "subnet": { + "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6" + }, + "ignoreMissingVnetServiceEndpoint": false + } + ], + "ipRules": [ + { + "ipMask": "1.1.1.1", + "action": "Allow" + }, + { + "ipMask": "1.1.1.2", + "action": "Allow" + }, + { + "ipMask": "1.1.1.3", + "action": "Allow" + }, + { + "ipMask": "1.1.1.4", + "action": "Allow" + }, + { + "ipMask": "1.1.1.5", + "action": "Allow" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/resourcegroupid/providers/Microsoft.EventHub/namespaces/sdk-Namespace-9659/networkruleset/default", + "name": "default", + "type": "Microsoft.EventHub/Namespaces/NetworkRuleSet", + "properties": { + "defaultAction": "Deny", + "virtualNetworkRules": [ + { + "subnet": { + "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2" + }, + "ignoreMissingVnetServiceEndpoint": true + }, + { + "subnet": { + "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3" + }, + "ignoreMissingVnetServiceEndpoint": false + }, + { + "subnet": { + "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6" + }, + "ignoreMissingVnetServiceEndpoint": false + } + ], + "ipRules": [ + { + "ipMask": "1.1.1.1", + "action": "Allow" + }, + { + "ipMask": "1.1.1.2", + "action": "Allow" + }, + { + "ipMask": "1.1.1.3", + "action": "Allow" + }, + { + "ipMask": "1.1.1.4", + "action": "Allow" + }, + { + "ipMask": "1.1.1.5", + "action": "Allow" + } + ] + } + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetGet.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetGet.json new file mode 100644 index 000000000000..4fa99e95009f --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetGet.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6019", + "resourceGroupName": "ResourceGroup", + "api-version": "2021-06-01-preview", + "subscriptionId": "Subscription" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionid/resourceGroups/resourcegroupid/providers/Microsoft.EventHub/namespaces/sdk-Namespace-9659/networkruleset/default", + "name": "default", + "type": "Microsoft.EventHub/Namespaces/NetworkRuleSet", + "properties": { + "defaultAction": "Deny", + "virtualNetworkRules": [ + { + "subnet": { + "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2" + }, + "ignoreMissingVnetServiceEndpoint": true + }, + { + "subnet": { + "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3" + }, + "ignoreMissingVnetServiceEndpoint": false + }, + { + "subnet": { + "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6" + }, + "ignoreMissingVnetServiceEndpoint": false + } + ], + "ipRules": [ + { + "ipMask": "1.1.1.1", + "action": "Allow" + }, + { + "ipMask": "1.1.1.2", + "action": "Allow" + }, + { + "ipMask": "1.1.1.3", + "action": "Allow" + }, + { + "ipMask": "1.1.1.4", + "action": "Allow" + }, + { + "ipMask": "1.1.1.5", + "action": "Allow" + } + ] + } + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/EHAliasAuthorizationRuleGet.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/EHAliasAuthorizationRuleGet.json new file mode 100644 index 000000000000..aff119039086 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/EHAliasAuthorizationRuleGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-9080", + "authorizationRuleName": "sdk-Authrules-4879", + "resourceGroupName": "exampleResourceGroup", + "alias": "sdk-DisasterRecovery-4879", + "api-version": "2021-06-01-preview", + "subscriptionId": "exampleSubscriptionId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/exampleSubscriptionId/resourceGroups/exampleResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-9080/disasterRecoveryConfigs/sdk-DisasterRecovery-4047/AuthorizationRules/sdk-Authrules-4879", + "name": "sdk-Authrules-4879", + "type": "Microsoft.EventHub/Namespaces/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/EHAliasAuthorizationRuleListAll.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/EHAliasAuthorizationRuleListAll.json new file mode 100644 index 000000000000..340255dc3e90 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/EHAliasAuthorizationRuleListAll.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-9080", + "resourceGroupName": "exampleResourceGroup", + "alias": "sdk-DisasterRecovery-4047", + "api-version": "2021-06-01-preview", + "subscriptionId": "exampleSubscriptionId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/exampleSubscriptionId/resourceGroups/exampleResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-9080/disasterRecoveryConfigs/sdk-DisasterRecovery-4047/AuthorizationRules/RootManageSharedAccessKey", + "name": "RootManageSharedAccessKey", + "type": "Microsoft.EventHub/Namespaces/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Manage", + "Send" + ] + } + }, + { + "id": "/subscriptions/exampleSubscriptionId/resourceGroups/exampleResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-9080/disasterRecoveryConfigs/sdk-DisasterRecovery-4047/AuthorizationRules/sdk-Authrules-1067", + "name": "sdk-Authrules-1067", + "type": "Microsoft.EventHub/Namespaces/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + }, + { + "id": "/subscriptions/exampleSubscriptionId/resourceGroups/exampleResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-9080/disasterRecoveryConfigs/sdk-DisasterRecovery-4047/AuthorizationRules/sdk-Authrules-1684", + "name": "sdk-Authrules-1684", + "type": "Microsoft.EventHub/Namespaces/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + }, + { + "id": "/subscriptions/exampleSubscriptionId/resourceGroups/exampleResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-9080/disasterRecoveryConfigs/sdk-DisasterRecovery-4047/AuthorizationRules/sdk-Authrules-4879", + "name": "sdk-Authrules-4879", + "type": "Microsoft.EventHub/Namespaces/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + ] + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/EHAliasAuthorizationRuleListKey.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/EHAliasAuthorizationRuleListKey.json new file mode 100644 index 000000000000..9aa48545d854 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/EHAliasAuthorizationRuleListKey.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-2702", + "authorizationRuleName": "sdk-Authrules-1746", + "resourceGroupName": "exampleResourceGroup", + "alias": "sdk-DisasterRecovery-4047", + "api-version": "2021-06-01-preview", + "subscriptionId": "exampleSubscriptionId" + }, + "responses": { + "200": { + "body": { + "aliasPrimaryConnectionString": "Endpoint=sb://sdk-disasterrecovery-4047.servicebus.windows-int.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=############################################", + "aliasSecondaryConnectionString": "Endpoint=sb://sdk-disasterrecovery-4047.servicebus.windows-int.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=############################################", + "primaryKey": "############################################", + "secondaryKey": "############################################", + "keyName": "sdk-Authrules-1746" + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/EHAliasBreakPairing.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/EHAliasBreakPairing.json new file mode 100644 index 000000000000..10039f048ee9 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/EHAliasBreakPairing.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-8859", + "resourceGroupName": "exampleResourceGroup", + "alias": "sdk-DisasterRecovery-3814", + "api-version": "2021-06-01-preview", + "subscriptionId": "exampleSubscriptionId" + }, + "responses": { + "200": {} + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/EHAliasCheckNameAvailability.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/EHAliasCheckNameAvailability.json new file mode 100644 index 000000000000..854546cc867f --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/EHAliasCheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "exampleSubscriptionId", + "namespaceName": "sdk-Namespace-9080", + "resourceGroupName": "exampleResourceGroup", + "parameters": { + "name": "sdk-DisasterRecovery-9474" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "reason": "None", + "message": "" + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/EHAliasCreate.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/EHAliasCreate.json new file mode 100644 index 000000000000..dfc226d5e534 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/EHAliasCreate.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-8859", + "resourceGroupName": "exampleResourceGroup", + "alias": "sdk-DisasterRecovery-3814", + "api-version": "2021-06-01-preview", + "subscriptionId": "exampleSubscriptionId", + "parameters": { + "properties": { + "partnerNamespace": "sdk-Namespace-37" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/exampleResourceGroup/resourceGroups/exampleResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-8859/disasterRecoveryConfig/sdk-DisasterRecovery-3814", + "name": "sdk-DisasterRecovery-3814", + "type": "Microsoft.EventHub/Namespaces/DisasterRecoveryConfig", + "properties": { + "provisioningState": "Accepted", + "partnerNamespace": "sdk-Namespace-37", + "role": "Primary" + } + } + }, + "201": {} + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/EHAliasDelete.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/EHAliasDelete.json new file mode 100644 index 000000000000..f88865d6f1a4 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/EHAliasDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5849", + "resourceGroupName": "exampleResourceGroup", + "alias": "sdk-DisasterRecovery-3814", + "api-version": "2021-06-01-preview", + "subscriptionId": "exampleSubscriptionId" + }, + "responses": { + "200": {} + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/EHAliasFailOver.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/EHAliasFailOver.json new file mode 100644 index 000000000000..10039f048ee9 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/EHAliasFailOver.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-8859", + "resourceGroupName": "exampleResourceGroup", + "alias": "sdk-DisasterRecovery-3814", + "api-version": "2021-06-01-preview", + "subscriptionId": "exampleSubscriptionId" + }, + "responses": { + "200": {} + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/EHAliasGet.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/EHAliasGet.json new file mode 100644 index 000000000000..1739689593bc --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/EHAliasGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-8859", + "resourceGroupName": "exampleResourceGroup", + "alias": "sdk-DisasterRecovery-3814", + "api-version": "2021-06-01-preview", + "subscriptionId": "exampleSubscriptionId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/exampleSubscriptionId/resourceGroups/exampleResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-37/disasterRecoveryConfig/sdk-DisasterRecovery-3814", + "name": "sdk-DisasterRecovery-3814", + "type": "Microsoft.EventHub/Namespaces/DisasterRecoveryConfig", + "properties": { + "provisioningState": "Accepted", + "partnerNamespace": "sdk-Namespace-8859", + "role": "Secondary", + "pendingReplicationOperationsCount": 0 + } + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/EHAliasList.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/EHAliasList.json new file mode 100644 index 000000000000..f103739a6c8a --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/EHAliasList.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-8859", + "resourceGroupName": "exampleResourceGroup", + "alias": "sdk-DisasterRecovery-3814", + "api-version": "2021-06-01-preview", + "subscriptionId": "exampleSubscriptionId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/exampleSubscriptionId/resourceGroups/exampleResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-8859/disasterRecoveryConfig/sdk-DisasterRecovery-3814", + "name": "sdk-DisasterRecovery-3814", + "type": "Microsoft.EventHub/Namespaces/DisasterRecoveryConfig", + "properties": { + "provisioningState": "Accepted", + "partnerNamespace": "sdk-Namespace-37", + "role": "Primary" + } + } + ] + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/namespaces-preview.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/namespaces-preview.json new file mode 100644 index 000000000000..3974547f8d99 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/namespaces-preview.json @@ -0,0 +1,1012 @@ +{ + "swagger": "2.0", + "info": { + "title": "EventHubManagementClient", + "description": "Azure Event Hubs client for managing namespaces.", + "version": "2021-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.EventHub/namespaces": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_List", + "x-ms-examples": { + "NamespacesListBySubscription": { + "$ref": "./examples/NameSpaces/EHNameSpaceList.json" + } + }, + "description": "Lists all the available Namespaces within a subscription, irrespective of the resource groups.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespaces returned successfully.", + "schema": { + "$ref": "#/definitions/EHNamespaceListResult" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_ListByResourceGroup", + "x-ms-examples": { + "NamespaceListByResourceGroup": { + "$ref": "./examples/NameSpaces/EHNameSpaceListByResourceGroup.json" + } + }, + "description": "Lists the available Namespaces within a resource group.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespaces returned successfully.", + "schema": { + "$ref": "#/definitions/EHNamespaceListResult" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}": { + "put": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_CreateOrUpdate", + "x-ms-examples": { + "NamespaceCreate": { + "$ref": "./examples/NameSpaces/EHNameSpaceCreate.json" + } + }, + "description": "Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EHNamespace", + "required": [ + "location" + ] + }, + "description": "Parameters for creating a namespace resource." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace successfully created.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "201": { + "description": "Namespace create request accepted.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "202": { + "description": "Namespace create or update request accepted." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Delete", + "x-ms-examples": { + "NameSpaceDelete": { + "$ref": "./examples/NameSpaces/EHNameSpaceDelete.json" + } + }, + "description": "Deletes an existing namespace. This operation also removes all associated resources under the namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace successfully deleted." + }, + "202": { + "description": "Namespace delete request accepted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Get", + "x-ms-examples": { + "NameSpaceGet": { + "$ref": "./examples/NameSpaces/EHNameSpaceGet.json" + } + }, + "description": "Gets the description of the specified namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace returned successfully.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Update", + "x-ms-examples": { + "NamespacesUpdate": { + "$ref": "./examples/NameSpaces/EHNameSpaceUpdate.json" + } + }, + "description": "Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EHNamespace" + }, + "description": "Parameters for updating a namespace resource." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace successfully updated.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "201": { + "description": "Namespace update request accepted.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "202": { + "description": "Namespace create or update request accepted." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/privateEndpointConnections": { + "get": { + "tags": [ + "Namespaces PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "x-ms-examples": { + "NameSpaceCreate": { + "$ref": "./examples/NameSpaces/PrivateEndPointConnectionList.json" + } + }, + "description": "Gets the available PrivateEndpointConnections within a namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "PrivateEndpointConnections successfully returned.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "EventHubEventHub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "put": { + "tags": [ + "Namespaces PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "x-ms-examples": { + "NameSpacePrivateEndPointConnectionCreate": { + "$ref": "./examples/NameSpaces/PrivateEndPointConnectionCreate.json" + } + }, + "description": "Creates or updates PrivateEndpointConnections of service namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639408.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "Parameters supplied to update Status of PrivateEndPoint Connection to namespace resource." + } + ], + "responses": { + "200": { + "description": "Status of PrivateEndPoint Connection Created successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "Request to update Status of PrivateEndPoint Connection accepted.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Namespaces PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "x-ms-examples": { + "NameSpacePrivateEndPointConnectionDelete": { + "$ref": "./examples/NameSpaces/PrivateEndPointConnectionDelete.json" + } + }, + "description": "Deletes an existing namespace. This operation also removes all associated resources under the namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639389.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/PrivateEndpointConnectionNameParameter" + } + ], + "responses": { + "200": { + "description": "Private Endpoint Connection successfully deleted." + }, + "202": { + "description": "Private Endpoint Connection delete request accepted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Namespaces PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "x-ms-examples": { + "NameSpacePrivateEndPointConnectionGet": { + "$ref": "./examples/NameSpaces/PrivateEndPointConnectionGet.json" + } + }, + "description": "Gets a description for the specified Private Endpoint Connection name.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Private Endpoint Connection successfully returned.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/privateLinkResources": { + "get": { + "tags": [ + "Namespaces PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_Get", + "x-ms-examples": { + "NameSpacePrivateLinkResourcesGet": { + "$ref": "./examples/NameSpaces/PrivateLinkResourcesGet.json" + } + }, + "description": "Gets lists of resources that supports Privatelinks.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Private Link resource List", + "schema": { + "$ref": "#/definitions/PrivateLinkResourcesListResult" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "EHNamespaceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EHNamespace" + }, + "description": "Result of the List Namespace operation" + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of namespaces." + } + }, + "description": "The response of the List Namespace operation" + }, + "EHNamespace": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "Properties of sku resource" + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "Properties of BYOK Identity description" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + }, + "properties": { + "x-ms-client-flatten": true, + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the Namespace." + }, + "status": { + "readOnly": true, + "type": "string", + "description": "Status of the Namespace." + }, + "createdAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The time the Namespace was created." + }, + "updatedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The time the Namespace was updated." + }, + "serviceBusEndpoint": { + "readOnly": true, + "type": "string", + "description": "Endpoint you can use to perform Service Bus operations." + }, + "clusterArmId": { + "type": "string", + "description": "Cluster ARM ID of the Namespace." + }, + "metricId": { + "readOnly": true, + "type": "string", + "description": "Identifier for Azure Insights metrics." + }, + "isAutoInflateEnabled": { + "type": "boolean", + "description": "Value that indicates whether AutoInflate is enabled for eventhub namespace." + }, + "maximumThroughputUnits": { + "format": "int32", + "type": "integer", + "maximum": 20, + "minimum": 0, + "description": "Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)" + }, + "kafkaEnabled": { + "type": "boolean", + "description": "Value that indicates whether Kafka is enabled for eventhub namespace." + }, + "zoneRedundant": { + "type": "boolean", + "description": "Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones." + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "Properties of BYOK Encryption description" + }, + "privateEndpointConnections": { + "description": "List of private endpoint connections.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "disableLocalAuth": { + "type": "boolean", + "description": "This property disables SAS authentication for the Event Hubs namespace." + } + }, + "description": "Namespace properties supplied for create namespace operation." + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/TrackedResource" + } + ], + "description": "Single Namespace item in List or Get Operation" + }, + "Sku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of this SKU.", + "enum": [ + "Basic", + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "The billing tier of this particular SKU.", + "enum": [ + "Basic", + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + }, + "capacity": { + "format": "int32", + "minimum": 0, + "type": "integer", + "description": "The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units." + } + }, + "required": [ + "name" + ], + "description": "SKU parameters supplied to the create namespace operation" + }, + "Identity": { + "x-ms-client-flatten": true, + "properties": { + "principalId": { + "type": "string", + "description": "ObjectId from the KeyVault", + "readOnly": true + }, + "tenantId": { + "type": "string", + "description": "TenantId from the KeyVault", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Type of managed service identity.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ManagedServiceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + }, + "description": "Properties for User Assigned Identities" + } + }, + "description": "Properties to configure Identity for Bring your Own Keys" + }, + "UserAssignedIdentity": { + "description": "Recognized Dictionary value.", + "type": "object", + "properties": { + "principalId": { + "description": "Principal Id of user assigned identity", + "type": "string", + "x-ms-client-name": "PrincipalId", + "readOnly": true + }, + "clientId": { + "description": "Client Id of user assigned identity", + "type": "string", + "x-ms-client-name": "ClientId", + "readOnly": true + } + } + }, + "Encryption": { + "x-ms-client-flatten": true, + "properties": { + "keyVaultProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/KeyVaultProperties" + }, + "x-ms-client-name": "KeyVaultProperties", + "description": "Properties of KeyVault" + }, + "keySource": { + "type": "string", + "description": "Enumerates the possible value of keySource for Encryption", + "default": "Microsoft.KeyVault", + "enum": [ + "Microsoft.KeyVault" + ], + "x-ms-enum": { + "name": "keySource", + "modelAsString": false + } + }, + "requireInfrastructureEncryption": { + "type": "boolean", + "description": "Enable Infrastructure Encryption (Double Encryption)" + } + }, + "description": "Properties to configure Encryption" + }, + "KeyVaultProperties": { + "properties": { + "keyName": { + "type": "string", + "description": "Name of the Key from KeyVault", + "x-ms-client-name": "KeyName" + }, + "keyVaultUri": { + "type": "string", + "description": "Uri of KeyVault", + "x-ms-client-name": "KeyVaultUri" + }, + "keyVersion": { + "type": "string", + "description": "Key Version", + "x-ms-client-name": "KeyVersion" + }, + "identity": { + "$ref": "#/definitions/userAssignedIdentityProperties" + } + }, + "description": "Properties to configure keyVault Properties" + }, + "PrivateEndpointConnection": { + "description": "Properties of the PrivateEndpointConnection.", + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Properties of the PrivateEndpointConnection.", + "x-ms-client-flatten": true + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + } + }, + "PrivateEndpointConnectionProperties": { + "description": "Properties of the private endpoint connection resource.", + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The Private Endpoint resource for this Connection." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/ConnectionState", + "description": "Details about the state of the connection." + }, + "provisioningState": { + "description": "Provisioning state of the Private Endpoint Connection.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Canceled", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "EndPointProvisioningState", + "modelAsString": true + } + } + } + }, + "PrivateEndpoint": { + "description": "PrivateEndpoint information.", + "properties": { + "id": { + "description": "The ARM identifier for Private Endpoint.", + "type": "string" + } + } + }, + "ConnectionState": { + "description": "ConnectionState information.", + "properties": { + "status": { + "description": "Status of the connection.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateLinkConnectionStatus", + "modelAsString": true + } + }, + "description": { + "description": "Description of the connection state.", + "type": "string" + } + } + }, + "PrivateEndpointConnectionListResult": { + "description": "Result of the list of all private endpoint connections operation.", + "properties": { + "value": { + "description": "A collection of private endpoint connection resources.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "description": "A link for the next page of private endpoint connection resources.", + "type": "string" + } + } + }, + "PrivateLinkResource": { + "description": "Information of the private link resource.", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Properties of the private link resource.", + "x-ms-client-flatten": true + }, + "id": { + "description": "Fully qualified identifier of the resource.", + "type": "string" + }, + "name": { + "description": "Name of the resource", + "type": "string" + }, + "type": { + "description": "Type of the resource", + "type": "string" + } + } + }, + "PrivateLinkResourceProperties": { + "description": "Properties of PrivateLinkResource", + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string" + }, + "requiredMembers": { + "type": "array", + "description": "The private link resource required member names.", + "items": { + "type": "string" + } + }, + "requiredZoneNames": { + "type": "array", + "description": "The private link resource Private link DNS zone name.", + "items": { + "type": "string" + } + } + } + }, + "PrivateLinkResourcesListResult": { + "description": "Result of the List private link resources operation.", + "properties": { + "value": { + "description": "A collection of private link resources", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "description": "A link for the next page of private link resources.", + "type": "string" + } + } + }, + "userAssignedIdentityProperties": { + "x-ms-client-flatten": true, + "type": "object", + "properties": { + "userAssignedIdentity": { + "type": "string", + "description": "ARM ID of user Identity selected for encryption" + } + } + } + }, + "parameters": {} +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/networkrulessets-preview.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/networkrulessets-preview.json new file mode 100644 index 000000000000..96be2dbc0787 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/networkrulessets-preview.json @@ -0,0 +1,240 @@ +{ + "swagger": "2.0", + "info": { + "title": "EventHubManagementClient", + "description": "Azure Event Hubs client for managing Event Hubs Cluster, IPFilter Rules and VirtualNetworkRules resources.", + "version": "2021-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/networkRuleSets/default": { + "put": { + "tags": [ + "NetworkRuleSets" + ], + "x-ms-examples": { + "NameSpaceNetworkRuleSetCreate": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetCreate.json" + } + }, + "operationId": "Namespaces_CreateOrUpdateNetworkRuleSet", + "description": "Create or update NetworkRuleSet for a Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkRuleSet" + }, + "description": "The Namespace IpFilterRule." + } + ], + "responses": { + "200": { + "description": "Namespace NetworkRuleSet successfully returned.", + "schema": { + "$ref": "#/definitions/NetworkRuleSet" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "NetworkRuleSets" + ], + "x-ms-examples": { + "NameSpaceNetworkRuleSetGet": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetGet.json" + } + }, + "operationId": "Namespaces_GetNetworkRuleSet", + "description": "Gets NetworkRuleSet for a Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace NetworkRuleSet successfully returned.", + "schema": { + "$ref": "#/definitions/NetworkRuleSet" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "Subnet": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID of Virtual Network Subnet" + } + }, + "description": "Properties supplied for Subnet" + }, + "NWRuleSetIpRules": { + "x-ms-client-flatten": true, + "properties": { + "ipMask": { + "type": "string", + "description": "IP Mask" + }, + "action": { + "type": "string", + "description": "The IP Filter Action", + "enum": [ + "Allow" + ], + "x-ms-enum": { + "name": "NetworkRuleIPAction", + "modelAsString": true + } + } + }, + "description": "The response from the List namespace operation." + }, + "NWRuleSetVirtualNetworkRules": { + "x-ms-client-flatten": true, + "properties": { + "subnet": { + "$ref": "#/definitions/Subnet", + "description": "Subnet properties" + }, + "ignoreMissingVnetServiceEndpoint": { + "type": "boolean", + "description": "Value that indicates whether to ignore missing Vnet Service Endpoint" + } + }, + "description": "The response from the List namespace operation." + }, + "NetworkRuleSet": { + "properties": { + "properties": { + "description": "NetworkRuleSet properties", + "x-ms-client-flatten": true, + "properties": { + "trustedServiceAccessEnabled": { + "type": "boolean", + "description": "Value that indicates whether Trusted Service Access is Enabled or not." + }, + "defaultAction": { + "type": "string", + "description": "Default Action for Network Rule Set", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "DefaultAction", + "modelAsString": true + } + }, + "virtualNetworkRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NWRuleSetVirtualNetworkRules" + }, + "description": "List VirtualNetwork Rules" + }, + "ipRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NWRuleSetIpRules" + }, + "description": "List of IpRules" + }, + "publicNetworkAccess": { + "description": "This determines if traffic is allowed over public network. By default it is enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccessFlag", + "modelAsString": true + }, + "default": "Enabled" + } + } + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Description of topic resource." + } + }, + "parameters": {} +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/operations.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/operations.json new file mode 100644 index 000000000000..25689096809e --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/operations.json @@ -0,0 +1,126 @@ +{ + "swagger": "2.0", + "info": { + "title": "EventHubManagementClient", + "description": "Azure Event Hubs client", + "version": "2021-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.EventHub/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "EHOperations_List": { + "$ref": "./examples/EHOperations_List.json" + } + }, + "description": "Lists all of the available Event Hub REST API operations.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Event Hub operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "List of Event Hub operations supported by the Microsoft.EventHub resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "A Event Hub REST API operation", + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Operation name: {provider}/{resource}/{operation}" + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "readOnly": true, + "type": "string", + "description": "Service provider: Microsoft.EventHub" + }, + "resource": { + "readOnly": true, + "type": "string", + "description": "Resource on which the operation is performed: Invoice, etc." + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "Operation type: Read, write, delete, etc." + } + } + } + } + } + }, + "parameters": {} +} diff --git a/specification/eventhub/resource-manager/readme.md b/specification/eventhub/resource-manager/readme.md index 25d78e03d8fb..d8172ead515d 100644 --- a/specification/eventhub/resource-manager/readme.md +++ b/specification/eventhub/resource-manager/readme.md @@ -90,6 +90,21 @@ input-file: - Microsoft.EventHub/preview/2021-01-01-preview/CheckNameAvailability.json ``` +### Tag: package-2021-06-preview + +These settings apply only when `--tag=package-2021-06-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2021-06-preview' +input-file: +- Microsoft.EventHub/preview/2021-06-01-preview/namespaces-preview.json +- Microsoft.EventHub/preview/2021-06-01-preview/operations.json +- Microsoft.EventHub/preview/2021-06-01-preview/eventhubs.json +- Microsoft.EventHub/preview/2021-06-01-preview/disasterRecoveryConfigs.json +- Microsoft.EventHub/preview/2021-06-01-preview/networkrulessets-preview.json +- Microsoft.EventHub/preview/2021-06-01-preview/AuthorizationRules.json +- Microsoft.EventHub/preview/2021-06-01-preview/consumergroups.json +- Microsoft.EventHub/preview/2021-06-01-preview/CheckNameAvailability.json +``` ### Tag: package-2018-01-preview diff --git a/specification/eventhub/resource-manager/readme.typescript.md b/specification/eventhub/resource-manager/readme.typescript.md index 718d2424d623..4270eaf12fc9 100644 --- a/specification/eventhub/resource-manager/readme.typescript.md +++ b/specification/eventhub/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) && !$(profile) +``` yaml $(typescript) && !$(profile-content) typescript: azure-arm: true package-name: "@azure/arm-eventhub" @@ -14,9 +14,9 @@ typescript: ### Profile: profile-hybrid-2020-09-01 -These settings apply only when `--profile=profile-hybrid-2020-09-01` is specified on the command line. +These settings apply only when `--profile-content=profile-hybrid-2020-09-01` is specified on the command line. -``` yaml $(profile)=='profile-hybrid-2020-09-01' +``` yaml $(profile-content)=='profile-hybrid-2020-09-01' typescript: package-name: "@azure/arm-eventhub-profile-2020-09-01-hybrid" output-folder: "$(typescript-sdks-folder)/sdk/eventhub/arm-eventhub-profile-2020-09-01-hybrid" diff --git a/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview/examples/FluidRelayServerOperations.json b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview/examples/FluidRelayServerOperations.json new file mode 100644 index 000000000000..641bd75a3f61 --- /dev/null +++ b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview/examples/FluidRelayServerOperations.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2021-03-12-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.FluidRelay/fluidRelayServers/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.FluidRelay", + "resource": "fluidRelayServers", + "operation": "Get/List fluid relay server resources", + "description": "Read fluid relay server" + } + }, + { + "name": "Microsoft.FluidRelay/fluidRelayServers/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.FluidRelay", + "resource": "fluidRelayServers", + "operation": "Create/Update fluid relay server resources", + "description": "Write fluid relay server" + } + }, + { + "name": "Microsoft.FluidRelay/fluidRelayServers/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.FluidRelay", + "resource": "fluidRelayServers", + "operation": "Delete fluid relay server resources", + "description": "Delete fluid relay server" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview/examples/FluidRelayServers_CreateOrUpdate.json b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview/examples/FluidRelayServers_CreateOrUpdate.json new file mode 100644 index 000000000000..57593977cfb2 --- /dev/null +++ b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview/examples/FluidRelayServers_CreateOrUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "xxxx-xxxx-xxxx-xxxx", + "resourceGroup": "myResourceGroup", + "name": "myFluidRelayServer", + "api-version": "2021-03-12", + "resource": { + "location": "west-us", + "tags": { + "Category": "sales" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/myResourceGroup/Microsoft.FluidRelay/fluidRelayServers/myFluidRelayServer", + "name": "myFluidRelayServer", + "type": "Microsoft.FluidRelay/fluidRelayServers", + "location": "west-us", + "properties": { + "frsTenantId": "yyyy-yyyy-yyyyy-yyyy", + "fluidRelayEndpoints": { + "ordererEndpoints": [ + "https://www.contoso.org/orderer" + ], + "storageEndpoints": [ + "https://www.contoso.org/storage" + ] + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview/examples/FluidRelayServers_Delete.json b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview/examples/FluidRelayServers_Delete.json new file mode 100644 index 000000000000..00a2a0bc50a1 --- /dev/null +++ b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview/examples/FluidRelayServers_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "xxxx-xxxx-xxxx-xxxx", + "resourceGroup": "myResourceGroup", + "name": "myFluidRelayServer", + "api-version": "2021-03-12" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview/examples/FluidRelayServers_Get.json b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview/examples/FluidRelayServers_Get.json new file mode 100644 index 000000000000..1b5e124323de --- /dev/null +++ b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview/examples/FluidRelayServers_Get.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "xxxx-xxxx-xxxx-xxxx", + "resourceGroup": "myResourceGroup", + "name": "myFluidRelayServer", + "api-version": "2021-03-12" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/myResourceGroup/Microsoft.FluidRelay/fluidRelayServers/myFluidRelayServer", + "name": "myFluidRelayServer", + "type": "Microsoft.FluidRelay/fluidRelayServers", + "location": "west-us", + "properties": { + "frsTenantId": "yyyy-yyyy-yyyyy-yyyy", + "fluidRelayEndpoints": { + "ordererEndpoints": [ + "https://www.contoso.org/orderer" + ], + "storageEndpoints": [ + "https://www.contoso.org/storage" + ] + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview/examples/FluidRelayServers_GetKeys.json b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview/examples/FluidRelayServers_GetKeys.json new file mode 100644 index 000000000000..56afddca2d2f --- /dev/null +++ b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview/examples/FluidRelayServers_GetKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "xxxx-xxxx-xxxx-xxxx", + "resourceGroup": "myResourceGroup", + "name": "myFluidRelayServer", + "api-version": "2021-03-12" + }, + "responses": { + "200": { + "body": { + "key1": "xxx-xxxx-xxxxx-xxxx", + "key2": "yyy-yyyy-yyyyy-yyyy" + } + } + } +} diff --git a/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview/examples/FluidRelayServers_ListByResourceGroup.json b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview/examples/FluidRelayServers_ListByResourceGroup.json new file mode 100644 index 000000000000..66b93693ed9f --- /dev/null +++ b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview/examples/FluidRelayServers_ListByResourceGroup.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "xxxx-xxxx-xxxx-xxxx", + "resourceGroup": "myResourceGroup", + "api-version": "2021-03-12" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/myResourceGroup/Microsoft.FluidRelay/fluidRelayServers/myFluidRelayServer", + "name": "myFluidRelayServer", + "type": "Microsoft.FluidRelay/fluidRelayServers", + "location": "west-us", + "properties": { + "frsTenantId": "yyyy-yyyy-yyyyy-yyyy", + "fluidRelayEndpoints": { + "ordererEndpoints": [ + "https://www.contoso.org/orderer" + ], + "storageEndpoints": [ + "https://www.contoso.org/storage" + ] + }, + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview/examples/FluidRelayServers_ListBySubscription.json b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview/examples/FluidRelayServers_ListBySubscription.json new file mode 100644 index 000000000000..c9c6f17cef00 --- /dev/null +++ b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview/examples/FluidRelayServers_ListBySubscription.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "xxxx-xxxx-xxxx-xxxx", + "api-version": "2021-03-12" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/myResourceGroup/Microsoft.FluidRelay/fluidRelayServers/myFluidRelayServer", + "name": "myFluidRelayServer", + "type": "Microsoft.FluidRelay/fluidRelayServers", + "location": "west-us", + "properties": { + "frsTenantId": "yyyy-yyyy-yyyyy-yyyy", + "fluidRelayEndpoints": { + "ordererEndpoints": [ + "https://www.contoso.org/orderer" + ], + "storageEndpoints": [ + "https://www.contoso.org/storage" + ] + }, + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview/examples/FluidRelayServers_RegenerateKeys.json b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview/examples/FluidRelayServers_RegenerateKeys.json new file mode 100644 index 000000000000..9ebefbce902d --- /dev/null +++ b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview/examples/FluidRelayServers_RegenerateKeys.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "xxxx-xxxx-xxxx-xxxx", + "resourceGroup": "myResourceGroup", + "name": "myFluidRelayServer", + "api-version": "2021-03-12", + "parameters": { + "keyName": "key1" + } + }, + "responses": { + "200": { + "body": { + "key1": "xxx-xxxx-xxxxx-xxxx", + "key2": "yyy-yyyy-yyyyy-yyyy" + } + } + } +} diff --git a/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview/examples/FluidRelayServers_Update.json b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview/examples/FluidRelayServers_Update.json new file mode 100644 index 000000000000..5da7acddedd5 --- /dev/null +++ b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview/examples/FluidRelayServers_Update.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "xxxx-xxxx-xxxx-xxxx", + "resourceGroup": "myResourceGroup", + "name": "myFluidRelayServer", + "api-version": "2021-03-12", + "resource": { + "tags": { + "Category": "sales" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/myResourceGroup/Microsoft.FluidRelay/fluidRelayServers/myFluidRelayServer", + "name": "myFluidRelayServer", + "type": "Microsoft.FluidRelay/fluidRelayServers", + "location": "west-us", + "properties": { + "frsTenantId": "yyyy-yyyy-yyyyy-yyyy", + "fluidRelayEndpoints": { + "ordererEndpoints": [ + "https://www.contoso.org/orderer" + ], + "storageEndpoints": [ + "https://www.contoso.org/storage" + ] + }, + "provisioningState": "Succeeded" + }, + "tags": { + "Category": "sales" + } + } + } + } +} diff --git a/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview/fluidrelay.json b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview/fluidrelay.json new file mode 100644 index 000000000000..fe9779896abc --- /dev/null +++ b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-03-12-preview/fluidrelay.json @@ -0,0 +1,718 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Fluid Relay", + "version": "2021-03-12-preview" + }, + "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.FluidRelay/operations": { + "get": { + "tags": [ + "FluidRelayOperations" + ], + "summary": "List all operations provided by Microsoft.FluidRelay.", + "operationId": "FluidRelayOperations_List", + "x-ms-examples": { + "List Fluid Relay server operations": { + "$ref": "./examples/FluidRelayServerOperations.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed synchronously.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "Error in operation." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.FluidRelay/fluidRelayServers/{name}": { + "get": { + "operationId": "FluidRelayServers_Get", + "tags": [ + "FluidRelayServers" + ], + "summary": "Get a Fluid Relay server.", + "x-ms-examples": { + "Get Fluid Relay server details": { + "$ref": "./examples/FluidRelayServers_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/FluidRelayServer" + }, + "description": "Request completed synchronously." + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "Error in operation." + } + } + }, + "put": { + "operationId": "FluidRelayServers_CreateOrUpdate", + "tags": [ + "FluidRelayServers" + ], + "summary": "Create or Update a Fluid Relay server.", + "x-ms-examples": { + "Create a Fluid Relay server": { + "$ref": "./examples/FluidRelayServers_CreateOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "resource", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FluidRelayServer" + }, + "description": "The details of the Fluid Relay server resource." + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/FluidRelayServer" + }, + "description": "Request completed synchronously.", + "headers": { + "x-ms-client-request-id": { + "type": "string" + }, + "x-ms-correlation-request-id": { + "type": "string" + } + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "Error in operation." + } + } + }, + "patch": { + "operationId": "FluidRelayServers_Update", + "tags": [ + "FluidRelayServers" + ], + "summary": "Update a Fluid Relay server.", + "x-ms-examples": { + "Create a Fluid Relay server": { + "$ref": "./examples/FluidRelayServers_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "resource", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FluidRelayServerUpdate" + }, + "description": "The updatable details of the Fluid Relay server resource." + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/FluidRelayServer" + }, + "description": "Request Completed Synchronously.", + "headers": { + "x-ms-client-request-id": { + "type": "string" + }, + "x-ms-correlation-request-id": { + "type": "string" + } + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "Error in operation." + } + } + }, + "delete": { + "operationId": "FluidRelayServers_Delete", + "tags": [ + "FluidRelayServers" + ], + "summary": "Delete a Fluid Relay server.", + "x-ms-examples": { + "Delete a Fluid Relay server": { + "$ref": "./examples/FluidRelayServers_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request completed Synchronously.", + "headers": { + "x-ms-client-request-id": { + "type": "string" + }, + "x-ms-correlation-request-id": { + "type": "string" + } + } + }, + "204": { + "description": "Request completed Synchronously.", + "headers": { + "x-ms-client-request-id": { + "type": "string" + }, + "x-ms-correlation-request-id": { + "type": "string" + } + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "Error in operation." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.FluidRelay/fluidRelayServers/{name}/regenerateKey": { + "post": { + "operationId": "FluidRelayServers_RegenerateKey", + "summary": "Regenerate the primary or secondary key for this server.", + "x-ms-examples": { + "Regenerate keys for a Fluid Relay server": { + "$ref": "./examples/FluidRelayServers_RegenerateKeys.json" + } + }, + "tags": [ + "FluidRelayServers" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateKeyRequest" + }, + "description": "The details of which keys to generate." + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/FluidRelayServerKeys" + }, + "description": "Request Completed Synchronously.", + "headers": { + "x-ms-client-request-id": { + "type": "string" + }, + "x-ms-correlation-request-id": { + "type": "string" + } + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "Error in operation." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.FluidRelay/fluidRelayServers/{name}/getKeys": { + "post": { + "operationId": "FluidRelayServers_GetKeys", + "summary": "Regenerate the primary or secondary key for this server.", + "x-ms-examples": { + "Get keys for a Fluid Relay server": { + "$ref": "./examples/FluidRelayServers_GetKeys.json" + } + }, + "tags": [ + "FluidRelayServers" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/FluidRelayServerKeys" + }, + "description": "Request Completed Synchronously.", + "headers": { + "x-ms-client-request-id": { + "type": "string" + }, + "x-ms-correlation-request-id": { + "type": "string" + } + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "Error in operation." + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.FluidRelay/fluidRelayServers": { + "get": { + "operationId": "FluidRelayServers_ListBySubscription", + "summary": "List all Fluid Relay servers in a subscription.", + "x-ms-examples": { + "List all Fluid Relay servers in a subscription": { + "$ref": "./examples/FluidRelayServers_ListBySubscription.json" + } + }, + "tags": [ + "FluidRelayServers" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/FluidRelayServerList" + }, + "description": "Paged response" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "Error in operation." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.FluidRelay/fluidRelayServers": { + "get": { + "operationId": "FluidRelayServers_ListByResourceGroup", + "tags": [ + "FluidRelayServers" + ], + "summary": "List all Fluid Relay servers in a resource group.", + "x-ms-examples": { + "List all Fluid Relay servers in a resource group": { + "$ref": "./examples/FluidRelayServers_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/FluidRelayServerList" + }, + "description": "Paged response" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "Error in operation." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "OperationDisplay": { + "description": "The object that represents the operation.", + "type": "object", + "properties": { + "provider": { + "description": "Service provider: Microsoft.FluidRelay", + "type": "string" + }, + "resource": { + "description": "Type on which the operation is performed, e.g., 'servers'.", + "type": "string" + }, + "operation": { + "description": "Operation type, e.g., read, write, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of the operation, e.g., 'Write confluent'.", + "type": "string" + } + } + }, + "OperationResult": { + "description": "A FluidRelay REST API operation.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "The object that represents the operation.", + "$ref": "#/definitions/OperationDisplay" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + } + } + }, + "OperationListResult": { + "description": "Result of GET request to list FluidRelay operations.", + "type": "object", + "properties": { + "value": { + "description": "List of FluidRelay operations supported by the Microsoft.FluidRelay provider.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationResult" + } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string" + } + } + }, + "FluidRelayServerUpdate": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": false, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + } + }, + "description": "The updatable properties of a Fluid Relay server" + }, + "FluidRelayServerList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FluidRelayServer" + }, + "description": "A sequence of FluidRelay servers.", + "x-adl-name": "FluidRelayServer[]" + }, + "nextLink": { + "type": "string", + "description": "A link to the next page of results, if any." + } + }, + "description": "Paged response", + "required": [ + "value" + ], + "x-adl-name": "Page" + }, + "FluidRelayServer": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FluidRelayServerProperties", + "description": "The resource-specific properties for this resource.", + "readOnly": false, + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "System meta data for this resource, including creation and modification information.", + "readOnly": true + } + }, + "description": "A FluidRelay Server.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "FluidRelayServerKeys": { + "type": "object", + "properties": { + "key1": { + "type": "string", + "format": "password", + "description": "The primary key for this server", + "readOnly": true + }, + "key2": { + "type": "string", + "format": "password", + "description": "The secondary key for this server", + "readOnly": true + } + }, + "description": "The set of available keys for this server." + }, + "RegenerateKeyRequest": { + "type": "object", + "properties": { + "keyName": { + "type": "string", + "enum": [ + "key1", + "key2" + ], + "x-ms-enum": { + "modelAsString": false, + "name": "KeyName" + }, + "x-adl-name": "key1 | key2", + "description": "The key to regenerate." + } + }, + "description": "Specifies which key should be generated.", + "required": [ + "keyName" + ] + }, + "FluidRelayServerProperties": { + "type": "object", + "properties": { + "frsTenantId": { + "type": "string", + "description": "The Fluid tenantId for this server", + "readOnly": true + }, + "fluidRelayEndpoints": { + "$ref": "#/definitions/FluidRelayEndpoints", + "description": "The Fluid Relay Service endpoints for this server.", + "readOnly": true + }, + "provisioningState": { + "enum": [ + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "description": "Provision states for FluidRelay RP", + "title": "ProvisioningState", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + } + }, + "description": "The properties of a Fluid Relay Service resource." + }, + "FluidRelayEndpoints": { + "type": "object", + "properties": { + "ordererEndpoints": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The Fluid Relay Orderer endpoints.", + "readOnly": true + }, + "storageEndpoints": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The Fluid Relay storage endpoints.", + "readOnly": true + } + }, + "description": "The Fluid Relay endpoints for this server" + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "type": "string", + "required": true, + "description": "The subscription id (GUID) for this resource." + }, + "ResourceGroup": { + "name": "resourceGroup", + "in": "path", + "type": "string", + "required": true, + "description": "The resource group containing the resource.", + "x-ms-parameter-location": "method" + }, + "ResourceName": { + "name": "name", + "in": "path", + "type": "string", + "required": true, + "description": "The resource name.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-06-15-preview/examples/FluidRelayServerOperations.json b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-06-15-preview/examples/FluidRelayServerOperations.json new file mode 100644 index 000000000000..251313c16cb6 --- /dev/null +++ b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-06-15-preview/examples/FluidRelayServerOperations.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2021-06-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.FluidRelay/fluidRelayServers/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.FluidRelay", + "resource": "fluidRelayServers", + "operation": "Get/List fluid relay server resources", + "description": "Read fluid relay server" + } + }, + { + "name": "Microsoft.FluidRelay/fluidRelayServers/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.FluidRelay", + "resource": "fluidRelayServers", + "operation": "Create/Update fluid relay server resources", + "description": "Write fluid relay server" + } + }, + { + "name": "Microsoft.FluidRelay/fluidRelayServers/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.FluidRelay", + "resource": "fluidRelayServers", + "operation": "Delete fluid relay server resources", + "description": "Delete fluid relay server" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-06-15-preview/examples/FluidRelayServers_CreateOrUpdate.json b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-06-15-preview/examples/FluidRelayServers_CreateOrUpdate.json new file mode 100644 index 000000000000..1987050bb71e --- /dev/null +++ b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-06-15-preview/examples/FluidRelayServers_CreateOrUpdate.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "xxxx-xxxx-xxxx-xxxx", + "resourceGroup": "myResourceGroup", + "name": "myFluidRelayServer", + "api-version": "2021-06-15", + "resource": { + "location": "west-us", + "identity": { + "type": "SystemAssigned" + }, + "tags": { + "Category": "sales" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/myResourceGroup/Microsoft.FluidRelay/fluidRelayServers/myFluidRelayServer", + "name": "myFluidRelayServer", + "type": "Microsoft.FluidRelay/fluidRelayServers", + "location": "west-us", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "properties": { + "frsTenantId": "yyyy-yyyy-yyyyy-yyyy", + "fluidRelayEndpoints": { + "ordererEndpoints": [ + "https://www.contoso.org/orderer" + ], + "storageEndpoints": [ + "https://www.contoso.org/storage" + ] + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-06-15-preview/examples/FluidRelayServers_Delete.json b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-06-15-preview/examples/FluidRelayServers_Delete.json new file mode 100644 index 000000000000..1762d4372c30 --- /dev/null +++ b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-06-15-preview/examples/FluidRelayServers_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "xxxx-xxxx-xxxx-xxxx", + "resourceGroup": "myResourceGroup", + "name": "myFluidRelayServer", + "api-version": "2021-06-15" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-06-15-preview/examples/FluidRelayServers_Get.json b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-06-15-preview/examples/FluidRelayServers_Get.json new file mode 100644 index 000000000000..064effbcdfbe --- /dev/null +++ b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-06-15-preview/examples/FluidRelayServers_Get.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "xxxx-xxxx-xxxx-xxxx", + "resourceGroup": "myResourceGroup", + "name": "myFluidRelayServer", + "api-version": "2021-06-15" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/myResourceGroup/Microsoft.FluidRelay/fluidRelayServers/myFluidRelayServer", + "name": "myFluidRelayServer", + "type": "Microsoft.FluidRelay/fluidRelayServers", + "location": "west-us", + "properties": { + "frsTenantId": "yyyy-yyyy-yyyyy-yyyy", + "fluidRelayEndpoints": { + "ordererEndpoints": [ + "https://www.contoso.org/orderer" + ], + "storageEndpoints": [ + "https://www.contoso.org/storage" + ] + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-06-15-preview/examples/FluidRelayServers_GetKeys.json b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-06-15-preview/examples/FluidRelayServers_GetKeys.json new file mode 100644 index 000000000000..4fba06f060f0 --- /dev/null +++ b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-06-15-preview/examples/FluidRelayServers_GetKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "xxxx-xxxx-xxxx-xxxx", + "resourceGroup": "myResourceGroup", + "name": "myFluidRelayServer", + "api-version": "2021-06-15" + }, + "responses": { + "200": { + "body": { + "key1": "xxx-xxxx-xxxxx-xxxx", + "key2": "yyy-yyyy-yyyyy-yyyy" + } + } + } +} diff --git a/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-06-15-preview/examples/FluidRelayServers_ListByResourceGroup.json b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-06-15-preview/examples/FluidRelayServers_ListByResourceGroup.json new file mode 100644 index 000000000000..1475dfdad975 --- /dev/null +++ b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-06-15-preview/examples/FluidRelayServers_ListByResourceGroup.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "xxxx-xxxx-xxxx-xxxx", + "resourceGroup": "myResourceGroup", + "api-version": "2021-06-15" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/myResourceGroup/Microsoft.FluidRelay/fluidRelayServers/myFluidRelayServer", + "name": "myFluidRelayServer", + "type": "Microsoft.FluidRelay/fluidRelayServers", + "location": "west-us", + "properties": { + "frsTenantId": "yyyy-yyyy-yyyyy-yyyy", + "fluidRelayEndpoints": { + "ordererEndpoints": [ + "https://www.contoso.org/orderer" + ], + "storageEndpoints": [ + "https://www.contoso.org/storage" + ] + }, + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-06-15-preview/examples/FluidRelayServers_ListBySubscription.json b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-06-15-preview/examples/FluidRelayServers_ListBySubscription.json new file mode 100644 index 000000000000..9de4f8549caa --- /dev/null +++ b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-06-15-preview/examples/FluidRelayServers_ListBySubscription.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "xxxx-xxxx-xxxx-xxxx", + "api-version": "2021-06-15" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/myResourceGroup/Microsoft.FluidRelay/fluidRelayServers/myFluidRelayServer", + "name": "myFluidRelayServer", + "type": "Microsoft.FluidRelay/fluidRelayServers", + "location": "west-us", + "properties": { + "frsTenantId": "yyyy-yyyy-yyyyy-yyyy", + "fluidRelayEndpoints": { + "ordererEndpoints": [ + "https://www.contoso.org/orderer" + ], + "storageEndpoints": [ + "https://www.contoso.org/storage" + ] + }, + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-06-15-preview/examples/FluidRelayServers_RegenerateKeys.json b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-06-15-preview/examples/FluidRelayServers_RegenerateKeys.json new file mode 100644 index 000000000000..4289e93b21f7 --- /dev/null +++ b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-06-15-preview/examples/FluidRelayServers_RegenerateKeys.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "xxxx-xxxx-xxxx-xxxx", + "resourceGroup": "myResourceGroup", + "name": "myFluidRelayServer", + "api-version": "2021-06-15", + "parameters": { + "keyName": "key1" + } + }, + "responses": { + "200": { + "body": { + "key1": "xxx-xxxx-xxxxx-xxxx", + "key2": "yyy-yyyy-yyyyy-yyyy" + } + } + } +} diff --git a/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-06-15-preview/examples/FluidRelayServers_Update.json b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-06-15-preview/examples/FluidRelayServers_Update.json new file mode 100644 index 000000000000..d196b1cb5f1a --- /dev/null +++ b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-06-15-preview/examples/FluidRelayServers_Update.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "xxxx-xxxx-xxxx-xxxx", + "resourceGroup": "myResourceGroup", + "name": "myFluidRelayServer", + "api-version": "2021-06-15", + "resource": { + "tags": { + "Category": "sales" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourceGroups/myResourceGroup/Microsoft.FluidRelay/fluidRelayServers/myFluidRelayServer", + "name": "myFluidRelayServer", + "type": "Microsoft.FluidRelay/fluidRelayServers", + "location": "west-us", + "properties": { + "frsTenantId": "yyyy-yyyy-yyyyy-yyyy", + "fluidRelayEndpoints": { + "ordererEndpoints": [ + "https://www.contoso.org/orderer" + ], + "storageEndpoints": [ + "https://www.contoso.org/storage" + ] + }, + "provisioningState": "Succeeded" + }, + "tags": { + "Category": "sales" + } + } + } + } +} diff --git a/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-06-15-preview/fluidrelay.json b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-06-15-preview/fluidrelay.json new file mode 100644 index 000000000000..989b0254c064 --- /dev/null +++ b/specification/fluidrelay/resource-manager/Microsoft.FluidRelay/preview/2021-06-15-preview/fluidrelay.json @@ -0,0 +1,754 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Fluid Relay", + "version": "2021-06-15-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.FluidRelay/operations": { + "get": { + "tags": [ + "FluidRelayOperations" + ], + "summary": "List all operations provided by Microsoft.FluidRelay.", + "operationId": "FluidRelayOperations_List", + "x-ms-examples": { + "List Fluid Relay server operations": { + "$ref": "./examples/FluidRelayServerOperations.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed synchronously.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "Error in operation." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.FluidRelay/fluidRelayServers/{name}": { + "get": { + "operationId": "FluidRelayServers_Get", + "tags": [ + "FluidRelayServers" + ], + "summary": "Get a Fluid Relay server.", + "x-ms-examples": { + "Get Fluid Relay server details": { + "$ref": "./examples/FluidRelayServers_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/FluidRelayServer" + }, + "description": "Request completed synchronously." + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "Error in operation." + } + } + }, + "put": { + "operationId": "FluidRelayServers_CreateOrUpdate", + "tags": [ + "FluidRelayServers" + ], + "summary": "Create or Update a Fluid Relay server.", + "x-ms-examples": { + "Create a Fluid Relay server": { + "$ref": "./examples/FluidRelayServers_CreateOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "resource", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FluidRelayServer" + }, + "description": "The details of the Fluid Relay server resource." + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/FluidRelayServer" + }, + "description": "Request completed synchronously.", + "headers": { + "x-ms-client-request-id": { + "type": "string" + }, + "x-ms-correlation-request-id": { + "type": "string" + } + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "Error in operation." + } + } + }, + "patch": { + "operationId": "FluidRelayServers_Update", + "tags": [ + "FluidRelayServers" + ], + "summary": "Update a Fluid Relay server.", + "x-ms-examples": { + "Create a Fluid Relay server": { + "$ref": "./examples/FluidRelayServers_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "resource", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FluidRelayServerUpdate" + }, + "description": "The updatable details of the Fluid Relay server resource." + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/FluidRelayServer" + }, + "description": "Request Completed Synchronously.", + "headers": { + "x-ms-client-request-id": { + "type": "string" + }, + "x-ms-correlation-request-id": { + "type": "string" + } + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "Error in operation." + } + } + }, + "delete": { + "operationId": "FluidRelayServers_Delete", + "tags": [ + "FluidRelayServers" + ], + "summary": "Delete a Fluid Relay server.", + "x-ms-examples": { + "Delete a Fluid Relay server": { + "$ref": "./examples/FluidRelayServers_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request completed Synchronously.", + "headers": { + "x-ms-client-request-id": { + "type": "string" + }, + "x-ms-correlation-request-id": { + "type": "string" + } + } + }, + "204": { + "description": "Request completed Synchronously.", + "headers": { + "x-ms-client-request-id": { + "type": "string" + }, + "x-ms-correlation-request-id": { + "type": "string" + } + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "Error in operation." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.FluidRelay/fluidRelayServers/{name}/regenerateKey": { + "post": { + "operationId": "FluidRelayServers_RegenerateKey", + "summary": "Regenerate the primary or secondary key for this server.", + "x-ms-examples": { + "Regenerate keys for a Fluid Relay server": { + "$ref": "./examples/FluidRelayServers_RegenerateKeys.json" + } + }, + "tags": [ + "FluidRelayServers" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateKeyRequest" + }, + "description": "The details of which keys to generate." + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/FluidRelayServerKeys" + }, + "description": "Request Completed Synchronously.", + "headers": { + "x-ms-client-request-id": { + "type": "string" + }, + "x-ms-correlation-request-id": { + "type": "string" + } + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "Error in operation." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.FluidRelay/fluidRelayServers/{name}/getKeys": { + "post": { + "operationId": "FluidRelayServers_GetKeys", + "summary": "Regenerate the primary or secondary key for this server.", + "x-ms-examples": { + "Get keys for a Fluid Relay server": { + "$ref": "./examples/FluidRelayServers_GetKeys.json" + } + }, + "tags": [ + "FluidRelayServers" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/FluidRelayServerKeys" + }, + "description": "Request Completed Synchronously.", + "headers": { + "x-ms-client-request-id": { + "type": "string" + }, + "x-ms-correlation-request-id": { + "type": "string" + } + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "Error in operation." + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.FluidRelay/fluidRelayServers": { + "get": { + "operationId": "FluidRelayServers_ListBySubscription", + "summary": "List all Fluid Relay servers in a subscription.", + "x-ms-examples": { + "List all Fluid Relay servers in a subscription": { + "$ref": "./examples/FluidRelayServers_ListBySubscription.json" + } + }, + "tags": [ + "FluidRelayServers" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/FluidRelayServerList" + }, + "description": "Paged response" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "Error in operation." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.FluidRelay/fluidRelayServers": { + "get": { + "operationId": "FluidRelayServers_ListByResourceGroup", + "tags": [ + "FluidRelayServers" + ], + "summary": "List all Fluid Relay servers in a resource group.", + "x-ms-examples": { + "List all Fluid Relay servers in a resource group": { + "$ref": "./examples/FluidRelayServers_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/FluidRelayServerList" + }, + "description": "Paged response" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "Error in operation." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "OperationDisplay": { + "description": "The object that represents the operation.", + "type": "object", + "properties": { + "provider": { + "description": "Service provider: Microsoft.FluidRelay", + "type": "string" + }, + "resource": { + "description": "Type on which the operation is performed, e.g., 'servers'.", + "type": "string" + }, + "operation": { + "description": "Operation type, e.g., read, write, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of the operation, e.g., 'Write confluent'.", + "type": "string" + } + } + }, + "OperationResult": { + "description": "A FluidRelay REST API operation.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "The object that represents the operation.", + "$ref": "#/definitions/OperationDisplay" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + } + } + }, + "OperationListResult": { + "description": "Result of GET request to list FluidRelay operations.", + "type": "object", + "properties": { + "value": { + "description": "List of FluidRelay operations supported by the Microsoft.FluidRelay provider.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationResult" + } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string" + } + } + }, + "FluidRelayServerUpdate": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": false, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "The type of identity used for the resource." + } + }, + "description": "The updatable properties of a Fluid Relay server" + }, + "FluidRelayServerList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FluidRelayServer" + }, + "description": "A sequence of FluidRelay servers.", + "x-adl-name": "FluidRelayServer[]" + }, + "nextLink": { + "type": "string", + "description": "A link to the next page of results, if any." + } + }, + "description": "Paged response", + "required": [ + "value" + ], + "x-adl-name": "Page" + }, + "FluidRelayServer": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FluidRelayServerProperties", + "description": "The resource-specific properties for this resource.", + "readOnly": false, + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "System meta data for this resource, including creation and modification information.", + "readOnly": true + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "The type of identity used for the resource." + } + }, + "description": "A FluidRelay Server.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ] + }, + "FluidRelayServerKeys": { + "type": "object", + "properties": { + "key1": { + "type": "string", + "format": "password", + "description": "The primary key for this server", + "readOnly": true + }, + "key2": { + "type": "string", + "format": "password", + "description": "The secondary key for this server", + "readOnly": true + } + }, + "description": "The set of available keys for this server." + }, + "RegenerateKeyRequest": { + "type": "object", + "properties": { + "keyName": { + "type": "string", + "enum": [ + "key1", + "key2" + ], + "x-ms-enum": { + "modelAsString": false, + "name": "KeyName" + }, + "x-adl-name": "key1 | key2", + "description": "The key to regenerate." + } + }, + "description": "Specifies which key should be generated.", + "required": [ + "keyName" + ] + }, + "Identity": { + "description": "Identity for the resource.", + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of resource identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID of resource." + }, + "type": { + "enum": [ + "SystemAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": true + }, + "type": "string", + "description": "The identity type." + } + } + }, + "FluidRelayServerProperties": { + "type": "object", + "properties": { + "frsTenantId": { + "type": "string", + "description": "The Fluid tenantId for this server", + "readOnly": true + }, + "fluidRelayEndpoints": { + "$ref": "#/definitions/FluidRelayEndpoints", + "description": "The Fluid Relay Service endpoints for this server.", + "readOnly": true + }, + "provisioningState": { + "enum": [ + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "description": "Provision states for FluidRelay RP", + "title": "ProvisioningState", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + } + }, + "description": "The properties of a Fluid Relay Service resource." + }, + "FluidRelayEndpoints": { + "type": "object", + "properties": { + "ordererEndpoints": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The Fluid Relay Orderer endpoints.", + "readOnly": true + }, + "storageEndpoints": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The Fluid Relay storage endpoints.", + "readOnly": true + } + }, + "description": "The Fluid Relay endpoints for this server" + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "type": "string", + "required": true, + "description": "The subscription id (GUID) for this resource." + }, + "ResourceGroup": { + "name": "resourceGroup", + "in": "path", + "type": "string", + "required": true, + "description": "The resource group containing the resource.", + "x-ms-parameter-location": "method" + }, + "ResourceName": { + "name": "name", + "in": "path", + "type": "string", + "required": true, + "description": "The resource name.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/fluidrelay/resource-manager/readme.csharp.md b/specification/fluidrelay/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..af83703c9e40 --- /dev/null +++ b/specification/fluidrelay/resource-manager/readme.csharp.md @@ -0,0 +1,15 @@ +## C + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true + client-side-validation: false + namespace: Microsoft.FluidRelay + output-folder: $(csharp-sdks-folder)/fluidrelay/management/Microsoft.FluidRelay/GeneratedProtocol +``` diff --git a/specification/fluidrelay/resource-manager/readme.go.md b/specification/fluidrelay/resource-manager/readme.go.md new file mode 100644 index 000000000000..6619e71cc2ee --- /dev/null +++ b/specification/fluidrelay/resource-manager/readme.go.md @@ -0,0 +1,37 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + clear-output-folder: true +``` + +### Go multi-api + +```yaml $(go) && $(multiapi) +batch: + - tag: package-2021-03-12-preview + - tag: package-2021-06-15-preview +``` + +### Tag: package-2021-03-12-preview and go + +These settings apply only when `--tag=package-2021-03-12-preview --go` is specified on the command line. +Please also specify `--go-sdks-folder=`. + +```yaml $(tag) == 'package-2021-03-12-preview' && $(go) +namespace: fluidrelay +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2021-03-12-preview/$(namespace) +``` + +### Tag: package-2021-06-15-preview and go + +These settings apply only when `--tag=package-2021-06-15-preview --go` is specified on the command line. +Please also specify `--go-sdks-folder=`. + +```yaml $(tag) == 'package-2021-06-15-preview' && $(go) +namespace: fluidrelay +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2021-06-15-preview/$(namespace) +``` diff --git a/specification/fluidrelay/resource-manager/readme.md b/specification/fluidrelay/resource-manager/readme.md new file mode 100644 index 000000000000..dedd4c3ddfd4 --- /dev/null +++ b/specification/fluidrelay/resource-manager/readme.md @@ -0,0 +1,100 @@ +# fluidrelay + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for adp. + +## 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 adp. + +```yaml +title: FluidRelayManagementClient +openapi-type: arm +openapi-subtype: rpaas +tag: package-2021-03-12-preview +``` + +### Tag: package-2021-03-12-preview + +These settings apply only when `--tag=package-2021-03-12-preview` is specified on the command line. + +```yaml $(tag) == 'package-2021-03-12-preview' +input-file: + - Microsoft.FluidRelay/preview/2021-03-12-preview/fluidrelay.json +``` + +### Tag: package-2021-06-15-preview + +These settings apply only when `--tag=package-2021-06-15-preview` is specified on the command line. + +```yaml $(tag) == 'package-2021-06-15-preview' +input-file: + - Microsoft.FluidRelay/preview/2021-06-15-preview/fluidrelay.json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_fluidrelay'] +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Ruby + +See configuration in [readme.ruby.md](./readme.ruby.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true + client-side-validation: false + namespace: Microsoft.FluidRelay + output-folder: $(csharp-sdks-folder)/fluidrelay/management/Microsoft.FluidRelay/GeneratedProtocol +``` + diff --git a/specification/fluidrelay/resource-manager/readme.python.md b/specification/fluidrelay/resource-manager/readme.python.md new file mode 100644 index 000000000000..8d8959856cf3 --- /dev/null +++ b/specification/fluidrelay/resource-manager/readme.python.md @@ -0,0 +1,23 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-fluidrelay +no-namespace-folders: true +package-version: 1.0.0b1 +clear-output-folder: true +``` + +``` yaml $(python-mode) == 'update' && $(track2) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/fluidrelay/azure-mgmt-fluidrelay/azure/mgmt/fluidrelay +``` + +``` yaml $(python-mode) == 'create' && $(track2) +basic-setup-py: true +output-folder: $(python-sdks-folder)/fluidrelay/azure-mgmt-fluidrelay +``` diff --git a/specification/fluidrelay/resource-manager/readme.ruby.md b/specification/fluidrelay/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..edb40cb281af --- /dev/null +++ b/specification/fluidrelay/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_adp +package-version: 2021-03-12-preview +azure-arm: true +``` + +### Tag: package-2021-03-12-preview and ruby + +These settings apply only when `--tag=package-2021-03-12-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +```yaml $(tag) == 'package-2020-07-01-preview' && $(ruby) +namespace: Microsoft.FluidRelay +output-folder: $(ruby-sdks-folder)/fluidrelay +``` diff --git a/specification/fluidrelay/resource-manager/readme.typescript.md b/specification/fluidrelay/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..f028a6dc4399 --- /dev/null +++ b/specification/fluidrelay/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: "fluidrelay" + output-folder: "$(typescript-sdks-folder)/packages/fluidrelay" + payload-flattening-threshold: 1 + generate-metadata: true +``` diff --git a/specification/frontdoor/resource-manager/readme.md b/specification/frontdoor/resource-manager/readme.md index 67f4b29079ab..7c8ee22c7658 100644 --- a/specification/frontdoor/resource-manager/readme.md +++ b/specification/frontdoor/resource-manager/readme.md @@ -203,7 +203,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-libraries-for-java - repo: azure-sdk-for-go diff --git a/specification/frontdoor/resource-manager/readme.python.md b/specification/frontdoor/resource-manager/readme.python.md index ebc9d5d70838..bc5e26c8a89d 100644 --- a/specification/frontdoor/resource-manager/readme.python.md +++ b/specification/frontdoor/resource-manager/readme.python.md @@ -4,36 +4,16 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.frontdoor - package-name: azure-mgmt-frontdoor - package-version: 0.1.0 - clear-output-folder: true -``` ``` yaml $(python) && $(track2) python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.frontdoor package-name: azure-mgmt-frontdoor -package-version: 0.1.0 +package-version: 1.0.0b1 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/network/azure-mgmt-frontdoor/azure/mgmt/frontdoor -``` -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/network/azure-mgmt-frontdoor -``` + ``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/network/azure-mgmt-frontdoor/azure/mgmt/frontdoor diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/createOrUpdateGuestConfigurationAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/createOrUpdateGuestConfigurationAssignment.json index 13e8b863c2d9..1a3a7f075bf6 100644 --- a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/createOrUpdateGuestConfigurationAssignment.json +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/createOrUpdateGuestConfigurationAssignment.json @@ -13,18 +13,15 @@ "guestConfiguration": { "name": "WhitelistedApplication", "version": "1.*", + "contentUri": "https://thisisfake/pacakge", + "contentHash": "123contenthash", + "assignmentType": "ApplyAndAutoCorrect", "configurationParameter": [ { "name": "[InstalledApplication]bwhitelistedapp;Name", "value": "NotePad,sql" } - ], - "configurationSetting": { - "rebootIfNeeded": false, - "actionAfterReboot": "ContinueConfiguration", - "configurationModeFrequencyMins": 15, - "configurationMode": "MonitorOnly" - } + ] } } } @@ -53,13 +50,7 @@ "name": "[InstalledApplication]bwhitelistedapp;Name", "value": "NotePad,sql" } - ], - "configurationSetting": { - "rebootIfNeeded": false, - "actionAfterReboot": "ContinueConfiguration", - "configurationModeFrequencyMins": 15, - "configurationMode": "MonitorOnly" - } + ] }, "provisioningState": "Succeeded" } @@ -88,13 +79,7 @@ "name": "[InstalledApplication]bwhitelistedapp;Name", "value": "NotePad,sql" } - ], - "configurationSetting": { - "rebootIfNeeded": false, - "actionAfterReboot": "ContinueConfiguration", - "configurationModeFrequencyMins": 15, - "configurationMode": "MonitorOnly" - } + ] }, "provisioningState": "Succeeded" } diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/createOrUpdateGuestConfigurationHCRPAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/createOrUpdateGuestConfigurationHCRPAssignment.json index 1e767f4eb152..8af99ac345bc 100644 --- a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/createOrUpdateGuestConfigurationHCRPAssignment.json +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/createOrUpdateGuestConfigurationHCRPAssignment.json @@ -13,18 +13,15 @@ "guestConfiguration": { "name": "WhitelistedApplication", "version": "1.*", + "contentUri": "https://thisisfake/pacakge", + "contentHash": "123contenthash", + "assignmentType": "ApplyAndAutoCorrect", "configurationParameter": [ { "name": "[InstalledApplication]bwhitelistedapp;Name", "value": "NotePad,sql" } - ], - "configurationSetting": { - "rebootIfNeeded": false, - "actionAfterReboot": "ContinueConfiguration", - "configurationModeFrequencyMins": 15, - "configurationMode": "MonitorOnly" - } + ] } } } @@ -53,13 +50,7 @@ "name": "[InstalledApplication]bwhitelistedapp;Name", "value": "NotePad,sql" } - ], - "configurationSetting": { - "rebootIfNeeded": false, - "actionAfterReboot": "ContinueConfiguration", - "configurationModeFrequencyMins": 15, - "configurationMode": "MonitorOnly" - } + ] }, "provisioningState": "Succeeded" } @@ -88,13 +79,7 @@ "name": "[InstalledApplication]bwhitelistedapp;Name", "value": "NotePad,sql" } - ], - "configurationSetting": { - "rebootIfNeeded": false, - "actionAfterReboot": "ContinueConfiguration", - "configurationModeFrequencyMins": 15, - "configurationMode": "MonitorOnly" - } + ] }, "provisioningState": "Succeeded" } diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json index 239870a2cec5..2374f0f1f542 100644 --- a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json @@ -803,15 +803,27 @@ "description": "Version of the guest configuration." }, "contentUri": { - "readOnly": true, "type": "string", "description": "Uri of the storage where guest configuration package is uploaded." }, "contentHash": { - "readOnly": true, "type": "string", "description": "Combined hash of the guest configuration package and configuration parameters." }, + "assignmentType": { + "type": "string", + "description": "Specifies the assignment type and execution of the configuration. Possible values are Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect and ApplyAndMonitor.", + "x-ms-enum": { + "name": "assignmentType", + "modelAsString": true + }, + "enum": [ + "Audit", + "DeployAndAutoCorrect", + "ApplyAndAutoCorrect", + "ApplyAndMonitor" + ] + }, "configurationParameter": { "type": "array", "items": { diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/createOrUpdateGuestConfigurationAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/createOrUpdateGuestConfigurationAssignment.json index 44db64b95018..8a6d3b851d16 100644 --- a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/createOrUpdateGuestConfigurationAssignment.json +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/createOrUpdateGuestConfigurationAssignment.json @@ -13,18 +13,15 @@ "guestConfiguration": { "name": "WhitelistedApplication", "version": "1.*", + "contentUri": "https://thisisfake/pacakge", + "contentHash": "123contenthash", + "assignmentType": "ApplyAndAutoCorrect", "configurationParameter": [ { "name": "[InstalledApplication]bwhitelistedapp;Name", "value": "NotePad,sql" } - ], - "configurationSetting": { - "rebootIfNeeded": false, - "actionAfterReboot": "ContinueConfiguration", - "configurationModeFrequencyMins": 15, - "configurationMode": "MonitorOnly" - } + ] } } } @@ -53,13 +50,7 @@ "name": "[InstalledApplication]bwhitelistedapp;Name", "value": "NotePad,sql" } - ], - "configurationSetting": { - "rebootIfNeeded": false, - "actionAfterReboot": "ContinueConfiguration", - "configurationModeFrequencyMins": 15, - "configurationMode": "MonitorOnly" - } + ] }, "provisioningState": "Succeeded" } @@ -88,13 +79,7 @@ "name": "[InstalledApplication]bwhitelistedapp;Name", "value": "NotePad,sql" } - ], - "configurationSetting": { - "rebootIfNeeded": false, - "actionAfterReboot": "ContinueConfiguration", - "configurationModeFrequencyMins": 15, - "configurationMode": "MonitorOnly" - } + ] }, "provisioningState": "Succeeded" } diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/createOrUpdateGuestConfigurationHCRPAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/createOrUpdateGuestConfigurationHCRPAssignment.json index 330a83431816..d133b2386eca 100644 --- a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/createOrUpdateGuestConfigurationHCRPAssignment.json +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/createOrUpdateGuestConfigurationHCRPAssignment.json @@ -13,18 +13,15 @@ "guestConfiguration": { "name": "WhitelistedApplication", "version": "1.*", + "contentUri": "https://thisisfake/pacakge", + "contentHash": "123contenthash", + "assignmentType": "ApplyAndAutoCorrect", "configurationParameter": [ { "name": "[InstalledApplication]bwhitelistedapp;Name", "value": "NotePad,sql" } - ], - "configurationSetting": { - "rebootIfNeeded": false, - "actionAfterReboot": "ContinueConfiguration", - "configurationModeFrequencyMins": 15, - "configurationMode": "MonitorOnly" - } + ] } } } @@ -53,13 +50,7 @@ "name": "[InstalledApplication]bwhitelistedapp;Name", "value": "NotePad,sql" } - ], - "configurationSetting": { - "rebootIfNeeded": false, - "actionAfterReboot": "ContinueConfiguration", - "configurationModeFrequencyMins": 15, - "configurationMode": "MonitorOnly" - } + ] }, "provisioningState": "Succeeded" } @@ -88,13 +79,7 @@ "name": "[InstalledApplication]bwhitelistedapp;Name", "value": "NotePad,sql" } - ], - "configurationSetting": { - "rebootIfNeeded": false, - "actionAfterReboot": "ContinueConfiguration", - "configurationModeFrequencyMins": 15, - "configurationMode": "MonitorOnly" - } + ] }, "provisioningState": "Succeeded" } diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json index 7f896d2ac18a..7164a0b561fc 100644 --- a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json @@ -803,15 +803,27 @@ "description": "Version of the guest configuration." }, "contentUri": { - "readOnly": true, "type": "string", "description": "Uri of the storage where guest configuration package is uploaded." }, "contentHash": { - "readOnly": true, "type": "string", "description": "Combined hash of the guest configuration package and configuration parameters." }, + "assignmentType": { + "type": "string", + "description": "Specifies the assignment type and execution of the configuration. Possible values are Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect and ApplyAndMonitor.", + "x-ms-enum": { + "name": "assignmentType", + "modelAsString": true + }, + "enum": [ + "Audit", + "DeployAndAutoCorrect", + "ApplyAndAutoCorrect", + "ApplyAndMonitor" + ] + }, "configurationParameter": { "type": "array", "items": { diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2021-01-25/examples/createOrUpdateGuestConfigurationAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2021-01-25/examples/createOrUpdateGuestConfigurationAssignment.json index 473c44588a2b..0934af5013d4 100644 --- a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2021-01-25/examples/createOrUpdateGuestConfigurationAssignment.json +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2021-01-25/examples/createOrUpdateGuestConfigurationAssignment.json @@ -13,18 +13,15 @@ "guestConfiguration": { "name": "WhitelistedApplication", "version": "1.*", + "contentUri": "https://thisisfake/pacakge", + "contentHash": "123contenthash", + "assignmentType": "ApplyAndAutoCorrect", "configurationParameter": [ { "name": "[InstalledApplication]bwhitelistedapp;Name", "value": "NotePad,sql" } - ], - "configurationSetting": { - "rebootIfNeeded": false, - "actionAfterReboot": "ContinueConfiguration", - "configurationModeFrequencyMins": 15, - "configurationMode": "MonitorOnly" - } + ] } } } @@ -53,13 +50,7 @@ "name": "[InstalledApplication]bwhitelistedapp;Name", "value": "NotePad,sql" } - ], - "configurationSetting": { - "rebootIfNeeded": false, - "actionAfterReboot": "ContinueConfiguration", - "configurationModeFrequencyMins": 15, - "configurationMode": "MonitorOnly" - } + ] }, "provisioningState": "Succeeded" } @@ -88,13 +79,7 @@ "name": "[InstalledApplication]bwhitelistedapp;Name", "value": "NotePad,sql" } - ], - "configurationSetting": { - "rebootIfNeeded": false, - "actionAfterReboot": "ContinueConfiguration", - "configurationModeFrequencyMins": 15, - "configurationMode": "MonitorOnly" - } + ] }, "provisioningState": "Succeeded" } diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2021-01-25/examples/createOrUpdateGuestConfigurationHCRPAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2021-01-25/examples/createOrUpdateGuestConfigurationHCRPAssignment.json index 74fd35a92a7f..e32a405adb8a 100644 --- a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2021-01-25/examples/createOrUpdateGuestConfigurationHCRPAssignment.json +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2021-01-25/examples/createOrUpdateGuestConfigurationHCRPAssignment.json @@ -13,18 +13,15 @@ "guestConfiguration": { "name": "WhitelistedApplication", "version": "1.*", + "contentUri": "https://thisisfake/pacakge", + "contentHash": "123contenthash", + "assignmentType": "ApplyAndAutoCorrect", "configurationParameter": [ { "name": "[InstalledApplication]bwhitelistedapp;Name", "value": "NotePad,sql" } - ], - "configurationSetting": { - "rebootIfNeeded": false, - "actionAfterReboot": "ContinueConfiguration", - "configurationModeFrequencyMins": 15, - "configurationMode": "MonitorOnly" - } + ] } } } @@ -53,13 +50,7 @@ "name": "[InstalledApplication]bwhitelistedapp;Name", "value": "NotePad,sql" } - ], - "configurationSetting": { - "rebootIfNeeded": false, - "actionAfterReboot": "ContinueConfiguration", - "configurationModeFrequencyMins": 15, - "configurationMode": "MonitorOnly" - } + ] }, "provisioningState": "Succeeded" } @@ -88,13 +79,7 @@ "name": "[InstalledApplication]bwhitelistedapp;Name", "value": "NotePad,sql" } - ], - "configurationSetting": { - "rebootIfNeeded": false, - "actionAfterReboot": "ContinueConfiguration", - "configurationModeFrequencyMins": 15, - "configurationMode": "MonitorOnly" - } + ] }, "provisioningState": "Succeeded" } diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2021-01-25/guestconfiguration.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2021-01-25/guestconfiguration.json index fac640dcaa9b..ec65d21e12ba 100644 --- a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2021-01-25/guestconfiguration.json +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2021-01-25/guestconfiguration.json @@ -1088,15 +1088,27 @@ "description": "Version of the guest configuration." }, "contentUri": { - "readOnly": true, "type": "string", "description": "Uri of the storage where guest configuration package is uploaded." }, "contentHash": { - "readOnly": true, "type": "string", "description": "Combined hash of the guest configuration package and configuration parameters." }, + "assignmentType": { + "type": "string", + "description": "Specifies the assignment type and execution of the configuration. Possible values are Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect and ApplyAndMonitor.", + "x-ms-enum": { + "name": "assignmentType", + "modelAsString": true + }, + "enum": [ + "Audit", + "DeployAndAutoCorrect", + "ApplyAndAutoCorrect", + "ApplyAndMonitor" + ] + }, "configurationParameter": { "type": "array", "items": { diff --git a/specification/guestconfiguration/resource-manager/readme.md b/specification/guestconfiguration/resource-manager/readme.md index 2b9c959faa0e..cda2933b8b16 100644 --- a/specification/guestconfiguration/resource-manager/readme.md +++ b/specification/guestconfiguration/resource-manager/readme.md @@ -121,11 +121,15 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-go - repo: azure-cli-extensions - repo: azure-resource-manager-schemas ``` +## Python + +See configuration in [readme.python.md](./readme.python.md) ## C# diff --git a/specification/guestconfiguration/resource-manager/readme.python.md b/specification/guestconfiguration/resource-manager/readme.python.md index ed4130e79a26..bd040ac8456d 100644 --- a/specification/guestconfiguration/resource-manager/readme.python.md +++ b/specification/guestconfiguration/resource-manager/readme.python.md @@ -6,22 +6,18 @@ Use `--python-mode=update` if you already have a setup.py and just want to updat ``` yaml $(python) python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.guestconfig - package-name: azure-mgmt-guestconfig - package-version: 0.1.0 - clear-output-folder: true +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +namespace: azure.mgmt.guestconfig +package-name: azure-mgmt-guestconfig +package-version: 1.0.0b1 +clear-output-folder: true ``` ``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/machinelearning/azure-mgmt-guestconfig/azure/mgmt/guestconfig +no-namespace-folders: true +output-folder: $(python-sdks-folder)/machinelearning/azure-mgmt-guestconfig/azure/mgmt/guestconfig ``` ``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/machinelearning/azure-mgmt-guestconfig +basic-setup-py: true +output-folder: $(python-sdks-folder)/machinelearning/azure-mgmt-guestconfig ``` diff --git a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_Create.json b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_Create.json index 3555d12b18c2..8b1cb629aca6 100644 --- a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_Create.json +++ b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_Create.json @@ -10,33 +10,18 @@ "key": "value" }, "properties": { - "hanaInstanceId": "00000000-0000-0000-0000-000000000000", - "powerState": "started", - "proximityPlacementGroup": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myplacementgroup", - "hwRevision": "Rev 3", - "hardwareProfile": { - "hardwareType": "Cisco_UCS", - "hanaInstanceSize": "S72" - }, "networkProfile": { "networkInterfaces": [ { "ipAddress": "100.100.100.100" } - ], - "circuitId": "/subscriptions/00000000-0000-0000-0000-000000000000/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/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.HanaOnAzure/hanaInstances/myHanaInstance2", - "provisioningState": "Succeeded" + "partnerNodeId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.HanaOnAzure/hanaInstances/myHanaInstance2" } } }, diff --git a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_Get.json b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_Get.json index 035ae003bfbd..44f63ad98207 100644 --- a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_Get.json +++ b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_Get.json @@ -33,7 +33,23 @@ "circuitId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/expressRouteCircuit" }, "storageProfile": { - "nfsIpAddress": "200.200.200.200" + "nfsIpAddress": "200.200.200.200", + "hanaSids": [ + { + "gid": "1001", + "memoryAllocation": "60", + "sid": "mysid1", + "username": "myuser1", + "uid": "101010101" + }, + { + "gid": "1002", + "memoryAllocation": "40", + "sid": "mysid2", + "username": "myuser2", + "uid": "101010102" + } + ] }, "osProfile": { "computerName": "myComputerName", diff --git a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_List.json b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_List.json index cc15e823b4fd..f84977f23e14 100644 --- a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_List.json +++ b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_List.json @@ -33,7 +33,23 @@ "circuitId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/expressRouteCircuit" }, "storageProfile": { - "nfsIpAddress": "200.200.200.200" + "nfsIpAddress": "200.200.200.200", + "hanaSids": [ + { + "gid": "1001", + "memoryAllocation": "60", + "sid": "mysid1", + "username": "myuser1", + "uid": "101010101" + }, + { + "gid": "1002", + "memoryAllocation": "40", + "sid": "mysid2", + "username": "myuser2", + "uid": "101010102" + } + ] }, "osProfile": { "computerName": "myComputerName1", @@ -70,7 +86,16 @@ "circuitId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/expressRouteCircuit" }, "storageProfile": { - "nfsIpAddress": "200.200.200.201" + "nfsIpAddress": "200.200.200.201", + "hanaSids": [ + { + "gid": "1001", + "memoryAllocation": "100", + "sid": "mysid", + "username": "myuser", + "uid": "101010101" + } + ] }, "osProfile": { "computerName": "myComputerName2", @@ -105,7 +130,16 @@ "circuitId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup2/providers/Microsoft.Network/expressRouteCircuit" }, "storageProfile": { - "nfsIpAddress": "200.200.200.202" + "nfsIpAddress": "200.200.200.202", + "hanaSids": [ + { + "gid": "1001", + "memoryAllocation": "100", + "sid": "mysid", + "username": "myuser", + "uid": "101010101" + } + ] }, "osProfile": { "computerName": "myComputerName3", @@ -140,7 +174,16 @@ "circuitId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup2/providers/Microsoft.Network/expressRouteCircuit" }, "storageProfile": { - "nfsIpAddress": "200.200.200.203" + "nfsIpAddress": "200.200.200.203", + "hanaSids": [ + { + "gid": "1101", + "memoryAllocation": "100", + "sid": "mysid101", + "username": "myuser", + "uid": "10000101" + } + ] }, "osProfile": { "computerName": "myComputerName4", diff --git a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_ListByResourceGroup.json b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_ListByResourceGroup.json index ba6ed1493dd4..0176e7e3a39c 100644 --- a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_ListByResourceGroup.json +++ b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_ListByResourceGroup.json @@ -34,7 +34,23 @@ "circuitId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/expressRouteCircuit" }, "storageProfile": { - "nfsIpAddress": "200.200.200.200" + "nfsIpAddress": "200.200.200.200", + "hanaSids": [ + { + "gid": "1001", + "memoryAllocation": "60", + "sid": "mysid1", + "username": "myuser1", + "uid": "101010101" + }, + { + "gid": "1002", + "memoryAllocation": "40", + "sid": "mysid2", + "username": "myuser2", + "uid": "101010102" + } + ] }, "osProfile": { "computerName": "myComputerName1", @@ -71,7 +87,16 @@ "circuitId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/expressRouteCircuit" }, "storageProfile": { - "nfsIpAddress": "200.200.200.201" + "nfsIpAddress": "200.200.200.201", + "hanaSids": [ + { + "gid": "1100", + "memoryAllocation": "100", + "sid": "mysid100", + "username": "myuser", + "uid": "10000100" + } + ] }, "osProfile": { "computerName": "myComputerName2", diff --git a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaOperations_List.json b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaOperations_List.json index 13867924b9cb..dcd37ea12692 100644 --- a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaOperations_List.json +++ b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaOperations_List.json @@ -14,7 +14,8 @@ "operation": "HanaOp1OperationName", "description": "HanaOp1Description", "origin": "HanaOp1Origin" - } + }, + "isDataAction": false }, { "name": "HanaOp2", @@ -24,7 +25,8 @@ "operation": "HanaOp2OperationName", "description": "HanaOp2Description", "origin": "HanaOp2Origin" - } + }, + "isDataAction": false } ] } diff --git a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json index 30a83a6712aa..0d98906e3b61 100644 --- a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json +++ b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json @@ -203,7 +203,7 @@ "summary": "Creates a SAP HANA instance.", "description": "Creates a SAP HANA instance for the specified subscription, resource group, and instance name.", "x-ms-examples": { - "Get properties of a HANA instance": { + "Create a HANA instance": { "$ref": "./examples/HanaInstances_Create.json" } }, @@ -254,7 +254,7 @@ "summary": "Deletes a SAP HANA instance.", "description": "Deletes a SAP HANA instance with the specified subscription, resource group, and instance name.", "x-ms-examples": { - "Get properties of a HANA instance": { + "Delete a HANA instance": { "$ref": "./examples/HanaInstances_Delete.json" } }, @@ -569,10 +569,12 @@ "description": "Specifies the network settings for the HANA instance." }, "hanaInstanceId": { + "readOnly": true, "type": "string", "description": "Specifies the HANA instance unique ID." }, "powerState": { + "readOnly": true, "type": "string", "enum": [ "starting", @@ -589,10 +591,12 @@ "description": "Resource power state" }, "proximityPlacementGroup": { + "readOnly": true, "type": "string", "description": "Resource proximity placement group" }, "hwRevision": { + "readOnly": true, "type": "string", "description": "Hardware revision of a HANA instance" }, @@ -601,6 +605,7 @@ "description": "ARM ID of another HanaInstance that will share a network with this HanaInstance" }, "provisioningState": { + "readOnly": true, "type": "string", "enum": [ "Accepted", @@ -623,6 +628,7 @@ "HardwareProfile": { "properties": { "hardwareType": { + "readOnly": true, "type": "string", "enum": [ "Cisco_UCS", @@ -635,6 +641,7 @@ "description": "Name of the hardware type (vendor and/or their product name)" }, "hanaInstanceSize": { + "readOnly": true, "type": "string", "enum": [ "S72m", @@ -708,11 +715,39 @@ "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 HANA instance" + "description": "Specifies the disk information for the HANA instance" + }, + "SAPSystemID": { + "type": "object", + "properties": { + "gid": { + "type": "string", + "description": "Group ID of the HANA database user." + }, + "memoryAllocation": { + "readOnly": true, + "type": "string", + "description": "Percent of memory to allocate to this SID." + }, + "sid": { + "type": "string", + "description": "SAP system ID as database identifier." + }, + "username": { + "type": "string", + "description": "Name of the HANA database user." + }, + "uid": { + "type": "string", + "description": "User ID of the HANA database user." + } + }, + "description": "Specifies information related to a SAP system ID" }, "StorageProfile": { "properties": { "nfsIpAddress": { + "readOnly": true, "type": "string", "description": "IP Address to connect to storage." }, @@ -722,6 +757,13 @@ "$ref": "#/definitions/Disk" }, "description": "Specifies information about the operating system disk used by the hana instance." + }, + "hanaSids": { + "type": "array", + "items": { + "$ref": "#/definitions/SAPSystemID" + }, + "description": "Specifies information related to SAP system IDs for the hana instance." } }, "description": "Specifies the storage settings for the HANA instance disks." @@ -733,10 +775,12 @@ "description": "Specifies the host OS name of the HANA 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." }, @@ -757,6 +801,7 @@ "description": "Specifies the network interfaces for the HANA instance." }, "circuitId": { + "readOnly": true, "type": "string", "description": "Specifies the circuit id for connecting to express route." } @@ -796,6 +841,11 @@ "display": { "$ref": "#/definitions/Display", "description": "Displayed HANA operation information" + }, + "isDataAction": { + "readOnly": true, + "type": "boolean", + "description": "Indicates whether the operation applies to data-plane." } }, "description": "HANA operation information" diff --git a/specification/hanaonazure/resource-manager/readme.md b/specification/hanaonazure/resource-manager/readme.md index 94f530067662..aa685af66e2b 100644 --- a/specification/hanaonazure/resource-manager/readme.md +++ b/specification/hanaonazure/resource-manager/readme.md @@ -63,7 +63,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-powershell - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/hanaonazure/resource-manager/readme.python.md b/specification/hanaonazure/resource-manager/readme.python.md index 7bcd12fae479..87d51938acd4 100644 --- a/specification/hanaonazure/resource-manager/readme.python.md +++ b/specification/hanaonazure/resource-manager/readme.python.md @@ -4,36 +4,15 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.hanaonazure - package-name: azure-mgmt-hanaonazure - clear-output-folder: true - package-version: 0.6.0 -``` ``` yaml $(python) && $(track2) -python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.hanaonazure package-name: azure-mgmt-hanaonazure clear-output-folder: true -package-version: 0.6.0 -``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/hanaonazure/azure-mgmt-hanaonazure/azure/mgmt/hanaonazure -``` -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/hanaonazure/azure-mgmt-hanaonazure +package-version: 1.0.0b1 ``` + ``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/hanaonazure/azure-mgmt-hanaonazure/azure/mgmt/hanaonazure diff --git a/specification/hardwaresecuritymodules/resource-manager/readme.md b/specification/hardwaresecuritymodules/resource-manager/readme.md index a6448f232a65..982fd5ee4dd6 100644 --- a/specification/hardwaresecuritymodules/resource-manager/readme.md +++ b/specification/hardwaresecuritymodules/resource-manager/readme.md @@ -56,5 +56,6 @@ This is not used by Autorest itself. swagger-to-sdk: - repo: azure-cli-extensions - repo: azure-resource-manager-schemas + - repo: azure-sdk-for-go ``` diff --git a/specification/hdinsight/resource-manager/readme.md b/specification/hdinsight/resource-manager/readme.md index f57b04ba69ec..b111b0a5dc92 100644 --- a/specification/hdinsight/resource-manager/readme.md +++ b/specification/hdinsight/resource-manager/readme.md @@ -155,7 +155,7 @@ swagger-to-sdk: - repo: azure-sdk-for-net - repo: azure-sdk-for-go - repo: azure-sdk-for-java - - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-js - repo: azure-sdk-for-node - repo: azure-resource-manager-schemas diff --git a/specification/hdinsight/resource-manager/readme.python.md b/specification/hdinsight/resource-manager/readme.python.md index 9cdf16de73ac..dd3b1248b22c 100644 --- a/specification/hdinsight/resource-manager/readme.python.md +++ b/specification/hdinsight/resource-manager/readme.python.md @@ -4,24 +4,26 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) +``` yaml $(python) && $(track2) python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.hdinsight - package-name: azure-mgmt-hdinsight - package-version: 0.1.0 - clear-output-folder: true +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +namespace: azure.mgmt.hdinsight +package-name: azure-mgmt-hdinsight +package-version: 1.0.0b1 +clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/hdinsight/azure-mgmt-hdinsight/azure/mgmt/hdinsight + +``` yaml $(python) && $(python-mode) == 'update' && $(track2) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/hdinsight/azure-mgmt-hdinsight/azure/mgmt/hdinsight ``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/hdinsight/azure-mgmt-hdinsight +``` yaml $(python) && $(python-mode) == 'create' && $(track2) +basic-setup-py: true +output-folder: $(python-sdks-folder)/hdinsight/azure-mgmt-hdinsight ``` + +``` yaml $(python) && $(track2) +modelerfour: + lenient-model-deduplication: true +``` \ No newline at end of file diff --git a/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2021-06-10/examples/GetOperations.json b/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2021-06-10/examples/GetOperations.json new file mode 100644 index 000000000000..531948d470bb --- /dev/null +++ b/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2021-06-10/examples/GetOperations.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2021-06-10" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Healthbot/healthbots/read", + "display": { + "provider": "Azure Health Bot", + "resource": "Azure Health Bot", + "operation": "Read Azure Health Bot", + "description": "Read Azure Health Bot" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Healthbot/healthbots/write", + "display": { + "provider": "Azure Health Bot", + "resource": "Azure Health Bot", + "operation": "Write Azure Health Bot", + "description": "Writes Azure Health Bot" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Healthbot/healthbots/delete", + "display": { + "provider": "Azure Health Bot", + "resource": "Azure Health Bot", + "operation": "Delete Azure Health Bot", + "description": "Deletes Azure Health Bot" + }, + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2021-06-10/examples/ListBotsByResourceGroup.json b/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2021-06-10/examples/ListBotsByResourceGroup.json new file mode 100644 index 000000000000..a79f77c13c8e --- /dev/null +++ b/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2021-06-10/examples/ListBotsByResourceGroup.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2021-06-10" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "East US", + "name": "samplebotname", + "type": "Microsoft.HealthBot/healthBots", + "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.HealthBot/healthBots/samplebotname", + "sku": { + "name": "F0" + }, + "properties": { + "botManagementPortalLink": "https://us.healthbot.microsoft.com/account/samplebotname-1yhd91k" + }, + "systemData": { + "createdBy": "jack@outlook.com", + "createdByType": "User", + "createdAt": "2020-05-05T17:18:19.1234567Z", + "lastModifiedBy": "ryan@outlook.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-05-06T17:18:19.1234567Z" + } + }, + { + "location": "East US", + "name": "samplebotname2", + "type": "Microsoft.HealthBot/healthBots", + "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.HealthBot/healthBots/samplebotname2", + "sku": { + "name": "S1" + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/subscription-id/resourcegroups/myrg/providers/microsoft.managedidentity/userassignedidentities/my-mi": {}, + "/subscriptions/subscription-id/resourcegroups/myrg/providers/microsoft.managedidentity/userassignedidentities/my-mi2": {} + }, + "principalId": "principalId", + "tenantId": "tenantId", + "type": "SystemAssigned, UserAssigned" + }, + "properties": { + "botManagementPortalLink": "https://us.healthbot.microsoft.com/account/samplebotname2-hdi1osc" + }, + "systemData": { + "createdBy": "jack@outlook.com", + "createdByType": "User", + "createdAt": "2020-05-05T17:18:19.1234567Z", + "lastModifiedBy": "ryan@outlook.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-05-06T17:18:19.1234567Z" + } + } + ] + } + } + } +} diff --git a/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2021-06-10/examples/ListBotsBySubscription.json b/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2021-06-10/examples/ListBotsBySubscription.json new file mode 100644 index 000000000000..9f5eeaa15447 --- /dev/null +++ b/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2021-06-10/examples/ListBotsBySubscription.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2021-06-10" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "East US", + "name": "samplebotname2", + "type": "Microsoft.HealthBot/healthBots", + "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.HealthBot/healthBots/samplebotname2", + "sku": { + "name": "S1" + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/subscription-id/resourcegroups/myrg/providers/microsoft.managedidentity/userassignedidentities/my-mi": {}, + "/subscriptions/subscription-id/resourcegroups/myrg/providers/microsoft.managedidentity/userassignedidentities/my-mi2": {} + }, + "principalId": "principalId", + "tenantId": "tenantId", + "type": "SystemAssigned, UserAssigned" + }, + "properties": { + "botManagementPortalLink": "https://us.healthbot.microsoft.com/account/samplebotname2-hdi1osc" + }, + "systemData": { + "createdBy": "jack@outlook.com", + "createdByType": "User", + "createdAt": "2020-05-05T17:18:19.1234567Z", + "lastModifiedBy": "ryan@outlook.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-05-06T17:18:19.1234567Z" + } + } + ] + } + } + } +} diff --git a/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2021-06-10/examples/ResourceCreationPut.json b/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2021-06-10/examples/ResourceCreationPut.json new file mode 100644 index 000000000000..9a502252c081 --- /dev/null +++ b/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2021-06-10/examples/ResourceCreationPut.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "resourceGroupName": "healthbotClient", + "api-version": "2021-06-10", + "subscriptionId": "subid", + "botName": "samplebotname", + "parameters": { + "location": "East US", + "sku": { + "name": "F0" + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/subscription-id/resourcegroups/myrg/providers/microsoft.managedidentity/userassignedidentities/my-mi": {}, + "/subscriptions/subscription-id/resourcegroups/myrg/providers/microsoft.managedidentity/userassignedidentities/my-mi2": {} + }, + "type": "SystemAssigned, UserAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "location": "East US", + "name": "samplebotname", + "type": "Microsoft.HealthBot/healthBots", + "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.HealthBot/healthBots/samplebotname", + "sku": { + "name": "F0" + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/subscription-id/resourcegroups/myrg/providers/microsoft.managedidentity/userassignedidentities/my-mi": {}, + "/subscriptions/subscription-id/resourcegroups/myrg/providers/microsoft.managedidentity/userassignedidentities/my-mi2": {} + }, + "principalId": "principalId", + "tenantId": "tenantId", + "type": "SystemAssigned, UserAssigned" + }, + "properties": { + "botManagementPortalLink": "https://us.healthbot.microsoft.com/account/contoso" + }, + "systemData": { + "createdBy": "jack@outlook.com", + "createdByType": "User", + "createdAt": "2020-05-05T17:18:19.1234567Z", + "lastModifiedBy": "ryan@outlook.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-05-06T17:18:19.1234567Z" + } + } + }, + "201": { + "body": { + "location": "East US", + "name": "samplebotname", + "type": "Microsoft.HealthBot/healthBots", + "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.HealthBot/healthBots/samplebotname", + "sku": { + "name": "F0" + }, + "properties": { + "botManagementPortalLink": "https://us.healthbot.microsoft.com/account/contoso", + "provisioningState": "Provisioning" + }, + "systemData": { + "createdBy": "jack@outlook.com", + "createdByType": "User", + "createdAt": "2020-05-05T17:18:19.1234567Z", + "lastModifiedBy": "ryan@outlook.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-05-06T17:18:19.1234567Z" + } + } + } + } +} diff --git a/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2021-06-10/examples/ResourceDeletionDelete.json b/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2021-06-10/examples/ResourceDeletionDelete.json new file mode 100644 index 000000000000..3fd35e661e06 --- /dev/null +++ b/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2021-06-10/examples/ResourceDeletionDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "resourceGroupName": "healthbotClient", + "api-version": "2021-06-10", + "subscriptionId": "subid", + "botName": "samplebotname" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2021-06-10/examples/ResourceInfoGet.json b/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2021-06-10/examples/ResourceInfoGet.json new file mode 100644 index 000000000000..154f43070638 --- /dev/null +++ b/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2021-06-10/examples/ResourceInfoGet.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "resourceGroupName": "healthbotClient", + "api-version": "2021-06-10", + "subscriptionId": "subid", + "botName": "samplebotname" + }, + "responses": { + "200": { + "body": { + "location": "East US", + "name": "samplebotname", + "type": "Microsoft.HealthBot/healthBots", + "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.HealthBot/healthBots/samplebotname", + "sku": { + "name": "F0" + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/subscription-id/resourcegroups/myrg/providers/microsoft.managedidentity/userassignedidentities/my-mi": {}, + "/subscriptions/subscription-id/resourcegroups/myrg/providers/microsoft.managedidentity/userassignedidentities/my-mi2": {} + }, + "principalId": "principalId", + "tenantId": "tenantId", + "type": "SystemAssigned, UserAssigned" + }, + "properties": { + "botManagementPortalLink": "https://us.healthbot.microsoft.com/account/contoso" + }, + "systemData": { + "createdBy": "jack@outlook.com", + "createdByType": "User", + "createdAt": "2020-05-05T17:18:19.1234567Z", + "lastModifiedBy": "ryan@outlook.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-05-06T17:18:19.1234567Z" + } + } + } + } +} diff --git a/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2021-06-10/examples/ResourceUpdatePatch.json b/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2021-06-10/examples/ResourceUpdatePatch.json new file mode 100644 index 000000000000..0d42e7d6f5bd --- /dev/null +++ b/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2021-06-10/examples/ResourceUpdatePatch.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "resourceGroupName": "healthbotClient", + "api-version": "2021-06-10", + "subscriptionId": "subid", + "botName": "samplebotname", + "identity": { + "userAssignedIdentities": { + "/subscriptions/subscription-id/resourcegroups/myrg/providers/microsoft.managedidentity/userassignedidentities/my-mi": {}, + "/subscriptions/subscription-id/resourcegroups/myrg/providers/microsoft.managedidentity/userassignedidentities/my-mi2": {} + }, + "type": "SystemAssigned, UserAssigned" + }, + "parameters": { + "sku": { + "name": "F0" + } + } + }, + "responses": { + "200": { + "body": { + "location": "East US", + "name": "samplebotname", + "type": "Microsoft.HealthBot/healthBots", + "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.HealthBot/healthBots/samplebotname", + "sku": { + "name": "F0" + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/subscription-id/resourcegroups/myrg/providers/microsoft.managedidentity/userassignedidentities/my-mi": {}, + "/subscriptions/subscription-id/resourcegroups/myrg/providers/microsoft.managedidentity/userassignedidentities/my-mi2": {} + }, + "principalId": "principalId", + "tenantId": "tenantId", + "type": "SystemAssigned, UserAssigned" + }, + "properties": { + "botManagementPortalLink": "https://us.healthbot.microsoft.com/account/contoso" + }, + "systemData": { + "createdBy": "jack@outlook.com", + "createdByType": "User", + "createdAt": "2020-05-05T17:18:19.1234567Z", + "lastModifiedBy": "ryan@outlook.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-05-06T17:18:19.1234567Z" + } + } + }, + "201": { + "body": { + "location": "East US", + "name": "samplebotname", + "type": "Microsoft.HealthBot/healthBots", + "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.HealthBot/healthBots/samplebotname", + "sku": { + "name": "F0" + }, + "properties": { + "botManagementPortalLink": "https://us.healthbot.microsoft.com/account/contoso" + }, + "systemData": { + "createdBy": "jack@outlook.com", + "createdByType": "User", + "createdAt": "2020-05-05T17:18:19.1234567Z", + "lastModifiedBy": "ryan@outlook.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-05-06T17:18:19.1234567Z" + } + } + } + } +} diff --git a/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2021-06-10/healthbot.json b/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2021-06-10/healthbot.json new file mode 100644 index 000000000000..3e9b3d2f3283 --- /dev/null +++ b/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2021-06-10/healthbot.json @@ -0,0 +1,791 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-10", + "title": "Azure Health Bot", + "description": "Azure Health Bot is a cloud platform that empowers developers in Healthcare organizations to build and deploy their compliant, AI-powered virtual health assistants and health bots, that help them improve processes and reduce costs.", + "x-ms-code-generation-settings": { + "name": "healthbotClient" + } + }, + "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.HealthBot/healthBots/{botName}": { + "put": { + "operationId": "Bots_Create", + "x-ms-examples": { + "BotCreate": { + "$ref": "./examples/ResourceCreationPut.json" + } + }, + "description": "Create a new Azure Health Bot.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/HealthBot" + }, + "description": "The parameters to provide for the created Azure Health Bot." + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "If resource is updated successfully, the service should return 200.", + "schema": { + "$ref": "#/definitions/HealthBot" + } + }, + "201": { + "description": "If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously.", + "schema": { + "$ref": "#/definitions/HealthBot" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "operationId": "Bots_Get", + "x-ms-examples": { + "ResourceInfoGet": { + "$ref": "./examples/ResourceInfoGet.json" + } + }, + "description": "Get a HealthBot.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "If resource is got successfully, the service should return 200.", + "schema": { + "$ref": "#/definitions/HealthBot" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "patch": { + "operationId": "Bots_Update", + "x-ms-examples": { + "BotUpdate": { + "$ref": "./examples/ResourceUpdatePatch.json" + } + }, + "description": "Patch a HealthBot.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/HealthBotUpdateParameters" + }, + "description": "The parameters to provide for the required Azure Health Bot." + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "If resource is patched successfully, the service should return 200.", + "schema": { + "$ref": "#/definitions/HealthBot" + } + }, + "201": { + "description": "If resource is received update request successfully, the service should return 201 (Created). Execution to continue asynchronously.", + "schema": { + "$ref": "#/definitions/HealthBot" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "delete": { + "operationId": "Bots_Delete", + "x-ms-examples": { + "BotDelete": { + "$ref": "./examples/ResourceDeletionDelete.json" + } + }, + "description": "Delete a HealthBot.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "If resource is deleted successfully, the service should return 200." + }, + "202": { + "description": "Accepted - Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "No content." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthBot/healthBots": { + "get": { + "description": "Returns all the resources of a particular type belonging to a resource group", + "operationId": "Bots_ListByResourceGroup", + "x-ms-examples": { + "List Bots by Resource Group": { + "$ref": "./examples/ListBotsByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses here. If a resource provider does not support paging, it should return the same body (JSON object with “value” property) but omit nextLink entirely (or set to null, *not* empty string) for future compatibility.\nThe nextLink should be implemented using following query parameters:\n· skipToken: opaque token that allows the resource provider to skip resources already enumerated. This value is defined and returned by the RP after first request via nextLink.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients must fetch records until the nextLink is not returned back / null. Clients should never rely on number of returned records to determinate if pagination is completed.", + "schema": { + "$ref": "#/definitions/BotResponseList" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HealthBot/healthBots": { + "get": { + "description": "Returns all the resources of a particular type belonging to a subscription.", + "operationId": "Bots_List", + "x-ms-examples": { + "List Bots by Subscription": { + "$ref": "./examples/ListBotsBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses. If a resource provider does not support paging, it should return the same body but leave nextLink empty for future compatibility.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. ", + "schema": { + "$ref": "#/definitions/BotResponseList" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.HealthBot/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all the available Azure Health Bot operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "Get Operations": { + "$ref": "./examples/GetOperations.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/AvailableOperations" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Identity": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of resource identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID of resource. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The identity type. 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 Azure Health Bot", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "$ref": "#/definitions/UserAssignedIdentityMap", + "description": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.\n" + } + }, + "description": "Identity for the resource." + }, + "UserAssignedIdentityMap": { + "type": "object", + "description": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.\n", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + } + }, + "UserAssignedIdentity": { + "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." + } + }, + "type": "object", + "description": "The details of the user assigned managed identity used by the Video Analyzer resource." + }, + "Sku": { + "type": "object", + "description": "The resource model definition representing SKU", + "properties": { + "name": { + "type": "string", + "description": "The name of the Azure Health Bot SKU", + "enum": [ + "F0", + "S1", + "C0" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": false + } + } + }, + "required": [ + "name" + ] + }, + "Resource": { + "type": "object", + "description": "The resource model definition for a ARM tracked top level resource", + "x-ms-azure-resource": true, + "properties": { + "id": { + "description": "Fully qualified resource Id for the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "systemData": { + "$ref": "#/definitions/SystemData", + "readOnly": true, + "description": "Metadata pertaining to creation and last modification of the resource" + } + } + }, + "TrackedResource": { + "type": "object", + "description": "The resource model definition for a ARM tracked top level resource", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + } + }, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "HealthBot": { + "type": "object", + "description": "Azure Health Bot resource definition", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "SKU of the Azure Health Bot." + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the Azure Health Bot." + }, + "properties": { + "$ref": "#/definitions/HealthBotProperties", + "description": "The set of properties specific to Azure Health Bot resource." + } + }, + "required": [ + "sku" + ] + }, + "HealthBotProperties": { + "type": "object", + "title": "HealthBotProperties", + "description": "The properties of a Azure Health Bot. The Health Bot Service is a cloud platform that empowers developers in Healthcare organizations to build and deploy their compliant, AI-powered virtual health assistants and health bots, that help them improve processes and reduce costs.", + "properties": { + "provisioningState": { + "type": "string", + "description": "The provisioning state of the Azure Health Bot resource.", + "readOnly": true + }, + "botManagementPortalLink": { + "type": "string", + "description": "The link.", + "readOnly": true + } + } + }, + "HealthBotUpdateParameters": { + "type": "object", + "description": "Parameters for updating a Azure Health Bot.", + "properties": { + "tags": { + "type": "object", + "description": "Tags for a Azure Health Bot.", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ] + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "SKU of the Azure Health Bot." + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the Azure Health Bot." + } + } + }, + "SystemData": { + "description": "Read only system data", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "$ref": "#/definitions/IdentityType", + "description": "The type of identity that created the resource" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)" + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "$ref": "#/definitions/IdentityType", + "description": "The type of identity that last modified the resource" + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)" + } + } + }, + "IdentityType": { + "description": "The type of identity that creates/modifies resources", + "type": "string", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": true + } + }, + "ValidationResult": { + "type": "object", + "title": "ValidationResult", + "description": "The response returned from validation process", + "properties": { + "status": { + "type": "string", + "description": "The status code of the response validation." + } + } + }, + "Error": { + "type": "object", + "properties": { + "error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "The error code." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "The error message." + }, + "target": { + "readOnly": true, + "type": "string", + "description": "The error target." + }, + "details": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Error" + }, + "description": "The error details." + }, + "additionalInfo": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ErrorAdditionalInfo" + }, + "description": "The error additional info." + } + } + } + }, + "description": "The resource management error response." + }, + "ErrorAdditionalInfo": { + "type": "object", + "properties": { + "type": { + "readOnly": true, + "type": "string", + "description": "The additional info type." + }, + "info": { + "readOnly": true, + "type": "object", + "description": "The additional info." + } + }, + "description": "The resource management error additional info." + }, + "AvailableOperations": { + "description": "Available operations of the service", + "type": "object", + "properties": { + "value": { + "description": "Collection of available operation details", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/OperationDetail" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "OperationDetail": { + "description": "Operation detail payload", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation", + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "Display of the operation" + }, + "origin": { + "description": "Origin of the operation", + "type": "string" + }, + "properties": { + "description": "Additional properties.", + "type": "object" + } + } + }, + "OperationDisplay": { + "description": "Operation display payload", + "type": "object", + "properties": { + "provider": { + "description": "Resource provider of the operation", + "type": "string" + }, + "resource": { + "description": "Resource of the operation", + "type": "string" + }, + "operation": { + "description": "Localized friendly name for the operation", + "type": "string" + }, + "description": { + "description": "Localized friendly description for the operation", + "type": "string" + } + } + }, + "BotResponseList": { + "type": "object", + "properties": { + "nextLink": { + "readOnly": true, + "description": "The link used to get the next page of bot service resources.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/HealthBot" + }, + "description": "Gets the list of Azure Health Bot results and their properties." + } + }, + "description": "The list of Azure Health Bot operation response." + } + }, + "parameters": { + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "maxLength": 64, + "minLength": 2, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the Bot resource group in the user subscription." + }, + "resourceNameParameter": { + "name": "botName", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "maxLength": 64, + "minLength": 2, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the Bot resource." + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request." + } + } +} diff --git a/specification/healthbot/resource-manager/readme.go.md b/specification/healthbot/resource-manager/readme.go.md index 3a70a7bf310a..0815fce1224e 100644 --- a/specification/healthbot/resource-manager/readme.go.md +++ b/specification/healthbot/resource-manager/readme.go.md @@ -13,9 +13,19 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2021-06-10 - tag: package-2020-12-08 ``` +### Tag: package-2021-06-10 and go + +These settings apply only when `--tag=package-2021-06-10 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2021-06-10' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2021-06-10/$(namespace) +``` + ### Tag: package-2020-12-08 and go These settings apply only when `--tag=package-2020-12-08 --go` is specified on the command line. diff --git a/specification/healthbot/resource-manager/readme.java.md b/specification/healthbot/resource-manager/readme.java.md index 81351e731f19..1c26d269e24c 100644 --- a/specification/healthbot/resource-manager/readme.java.md +++ b/specification/healthbot/resource-manager/readme.java.md @@ -12,6 +12,27 @@ payload-flattening-threshold: 1 output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-healthbot ``` +### Java multi-api + +```yaml $(java) && $(multiapi) +batch: + - tag: package-2021-06-10 + - tag: package-2020-12-08 +``` + +### Tag: package-2021-06-10 and java + +These settings apply only when `--tag=package-2021-06-10 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2021-06-10' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.healthbot.v2021-06-10 + output-folder: $(azure-libraries-for-java-folder)/sdk/healthbot/mgmt-v2021-06-10 +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-2020-12-08 and java These settings apply only when `--tag=package-2020-12-08 --java` is specified on the command line. diff --git a/specification/healthbot/resource-manager/readme.md b/specification/healthbot/resource-manager/readme.md index 55bd2650f2a1..8c56ec316eb2 100644 --- a/specification/healthbot/resource-manager/readme.md +++ b/specification/healthbot/resource-manager/readme.md @@ -28,9 +28,19 @@ These are the global settings for the healthbot. title: HealthbotClient openapi-type: arm openapi-subtype: rpaas -tag: package-2020-12-08 +tag: package-2021-06-10 ``` +### Tag: package-2021-06-10 + +These settings apply only when `--tag=package-2021-06-10` is specified on the command line. + +```yaml $(tag) == 'package-2021-06-10' +input-file: + - Microsoft.HealthBot/stable/2021-06-10/healthbot.json +``` + +--- ### Tag: package-2020-10-20-preview @@ -43,7 +53,7 @@ input-file: --- -### Tag2: package-2020-10-20 +### Tag: package-2020-10-20 These settings apply only when `--tag=package-2020-10-20` is specified on the command line. @@ -54,7 +64,7 @@ input-file: --- -### Tag3: package-2020-12-08-preview +### Tag: package-2020-12-08-preview These settings apply only when `--tag=package-2020-12-08-preview` is specified on the command line. @@ -65,7 +75,7 @@ input-file: --- -### Tag3: package-2020-12-08 +### Tag: package-2020-12-08 These settings apply only when `--tag=package-2020-12-08` is specified on the command line. diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/CheckNameAvailabilityPost.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/CheckNameAvailabilityPost.json new file mode 100644 index 000000000000..52dff91ae6e9 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/CheckNameAvailabilityPost.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "subid", + "checkNameAvailabilityInputs": { + "type": "Microsoft.HealthcareApis/services", + "name": "serviceName" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "Service name is not available." + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/OperationResultsGet.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/OperationResultsGet.json new file mode 100644 index 000000000000..9af381cb7573 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/OperationResultsGet.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "subid", + "locationName": "westus", + "operationResultId": "exampleid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.HealthcareApis/locations/westus/operationresults/exampleid", + "name": "servicename", + "status": "Requested", + "startTime": "2019-01-21T06:03:30.2716301Z", + "properties": {} + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/OperationsList.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/OperationsList.json new file mode 100644 index 000000000000..fef96a7fa07c --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/OperationsList.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.HealthcareApis/services/read", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/services/write", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/services/delete", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/locations/operationresults/read", + "display": { + "provider": "Microsoft.HealthcareApis", + "resource": "operationresults", + "operation": "read", + "description": "Get the status of an asynchronous operation" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/workspaces/read", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/workspaces/write", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/workspaces/delete", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/workspaces/dicomservices/read", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/workspaces/dicomservices/write", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/workspaces/dicomservices/delete", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/workspaces/iotconnectors/read", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/workspaces/iotconnectors/write", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/workspaces/iotconnectors/delete", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/workspaces/fhirservices/read", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/workspaces/fhirservices/write", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/workspaces/fhirservices/delete", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/checkNameAvailability/post", + "display": {}, + "origin": "user" + }, + { + "name": "Microsoft.HealthcareApis/Operations/read", + "display": { + "provider": "Microsoft.HealthcareApis", + "resource": "operations", + "operation": "read", + "description": "Get the list of operations supported by this Resource Provider." + }, + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/dicomservices/DicomServices_Create.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/dicomservices/DicomServices_Create.json new file mode 100644 index 000000000000..d4ba4e966eda --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/dicomservices/DicomServices_Create.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "dicomServiceName": "blue", + "api-version": "2021-06-01-preview", + "dicomservice": { + "location": "westus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "name": "blue", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/dicomservices/blue", + "location": "westus", + "type": "Microsoft.HealthcareApis/workspaces/dicomservices", + "properties": { + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audiences": [ + "https://azurehealthcareapis.com/", + "https://azurehealthcareapis.com" + ] + }, + "provisioningState": "Succeeded", + "serviceUrl": null + } + } + }, + "201": { + "body": { + "name": "blue", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/dicomservices/blue", + "location": "westus", + "type": "Microsoft.HealthcareApis/workspaces/dicomservices", + "properties": { + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audiences": [ + "https://azurehealthcareapis.com/", + "https://azurehealthcareapis.com" + ] + }, + "provisioningState": "Creating", + "serviceUrl": null + } + } + }, + "202": { + "body": { + "name": "blue", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/dicomservices/blue", + "location": "westus", + "type": "Microsoft.HealthcareApis/workspaces/dicomservices", + "properties": { + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audiences": [ + "https://azurehealthcareapis.com/", + "https://azurehealthcareapis.com" + ] + }, + "provisioningState": "Accepted", + "serviceUrl": null + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/dicomservices/DicomServices_Delete.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/dicomservices/DicomServices_Delete.json new file mode 100644 index 000000000000..03509c46c093 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/dicomservices/DicomServices_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "dicomServiceName": "blue", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/dicomservices/DicomServices_Get.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/dicomservices/DicomServices_Get.json new file mode 100644 index 000000000000..f25e33e465ed --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/dicomservices/DicomServices_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "dicomServiceName": "blue", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "blue", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/dicomservices/blue", + "type": "Microsoft.HealthcareApis/workspaces/dicomservices", + "properties": { + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audiences": [ + "https://azurehealthcareapis.com/", + "https://azurehealthcareapis.com" + ] + }, + "provisioningState": "Succeeded", + "serviceUrl": "https://workspace1-blue.dicom.azurehealthcareapis.com" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/dicomservices/DicomServices_List.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/dicomservices/DicomServices_List.json new file mode 100644 index 000000000000..ff85a26bad5e --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/dicomservices/DicomServices_List.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "nextLink": "string", + "value": [ + { + "name": "blue", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/dicomservices/blue", + "type": "Microsoft.HealthcareApis/workspaces/dicomservices", + "properties": { + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audiences": [ + "https://azurehealthcareapis.com/", + "https://azurehealthcareapis.com" + ] + }, + "provisioningState": "Succeeded", + "serviceUrl": "https://workspace1-blue.dicom.azurehealthcareapis.com" + } + }, + { + "name": "red", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/dicomservices/red", + "type": "Microsoft.HealthcareApis/workspaces/dicomservices", + "properties": { + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audiences": [ + "https://azurehealthcareapis.com/", + "https://azurehealthcareapis.com" + ] + }, + "provisioningState": "Succeeded", + "serviceUrl": "https://workspace1-red.dicom.azurehealthcareapis.com" + } + } + ] + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/dicomservices/DicomServices_Patch.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/dicomservices/DicomServices_Patch.json new file mode 100644 index 000000000000..118ebb2caae7 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/dicomservices/DicomServices_Patch.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "dicomServiceName": "blue", + "api-version": "2021-06-01-preview", + "dicomservicePatchResource": { + "tags": { + "tagKey": "tagValue" + } + } + }, + "responses": { + "200": { + "body": { + "name": "blue", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/dicomservices/blue", + "type": "Microsoft.HealthcareApis/workspaces/dicomservices", + "tags": { + "tagKey": "tagValue" + }, + "properties": { + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audiences": [ + "https://azurehealthcareapis.com/", + "https://azurehealthcareapis.com" + ] + }, + "provisioningState": "Succeeded", + "serviceUrl": "https://workspace1-blue.dicom.azurehealthcareapis.com" + } + } + }, + "202": { + "body": { + "name": "blue", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/dicomservices/blue", + "type": "Microsoft.HealthcareApis/workspaces/dicomservices", + "tags": { + "tagKey": "tagValue" + }, + "properties": { + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audiences": [ + "https://azurehealthcareapis.com/", + "https://azurehealthcareapis.com" + ] + }, + "provisioningState": "Succeeded", + "serviceUrl": "https://workspace1-blue.dicom.azurehealthcareapis.com" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/fhirservices/FhirServices_Create.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/fhirservices/FhirServices_Create.json new file mode 100644 index 000000000000..eb26aa7cee09 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/fhirservices/FhirServices_Create.json @@ -0,0 +1,220 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "fhirServiceName": "fhirservice1", + "api-version": "2021-06-01-preview", + "fhirservice": { + "location": "westus", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "kind": "fhir-R4", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + }, + { + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" + } + ], + "acrConfiguration": { + "loginServers": [ + "test1.azurecr.io" + ] + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "exportConfiguration": { + "storageAccountName": "existingStorageAccount" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "fhirservice1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/fhirservices/fhirservice1", + "location": "westus", + "type": "Microsoft.HealthcareApis/workspaces/fhirservices", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "kind": "fhir-R4", + "etag": "etagvalue", + "properties": { + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + }, + { + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" + } + ], + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "exportConfiguration": { + "storageAccountName": "existingStorageAccount" + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "fhirservice1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/fhirservices/fhirservice1", + "location": "westus", + "type": "Microsoft.HealthcareApis/workspaces/fhirservices", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "kind": "fhir-R4", + "etag": "etagvalue", + "properties": { + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + }, + { + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" + } + ], + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "exportConfiguration": { + "storageAccountName": "existingStorageAccount" + }, + "provisioningState": "Creating" + } + } + }, + "202": { + "body": { + "name": "fhirservice1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/fhirservices/fhirservice1", + "location": "westus", + "type": "Microsoft.HealthcareApis/workspaces/fhirservices", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "kind": "fhir-R4", + "etag": "etagvalue", + "properties": { + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + }, + { + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" + } + ], + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "exportConfiguration": { + "storageAccountName": "existingStorageAccount" + }, + "provisioningState": "Accepted" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/fhirservices/FhirServices_Delete.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/fhirservices/FhirServices_Delete.json new file mode 100644 index 000000000000..93faedd54739 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/fhirservices/FhirServices_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "fhirServiceName": "fhirservice1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/fhirservices/FhirServices_Get.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/fhirservices/FhirServices_Get.json new file mode 100644 index 000000000000..87160ebdeffe --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/fhirservices/FhirServices_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "fhirServiceName": "fhirservices1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "fhirservices1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/fhirservices/fhirservices1", + "type": "Microsoft.HealthcareApis/workspaces/fhirservices", + "properties": { + "provisioningState": "Creating" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/fhirservices/FhirServices_List.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/fhirservices/FhirServices_List.json new file mode 100644 index 000000000000..9f978a3cb1ce --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/fhirservices/FhirServices_List.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "nextLink": "string", + "value": [ + { + "name": "fhirservice1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/fhirservices/fhirservice1", + "type": "Microsoft.HealthcareApis/workspaces/fhirservices", + "properties": { + "provisioningState": "Creating" + } + }, + { + "name": "fhirservice2", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/fhirservices/fhirservice2", + "type": "Microsoft.HealthcareApis/workspaces/fhirservices", + "properties": { + "provisioningState": "Creating" + } + } + ] + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/fhirservices/FhirServices_Patch.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/fhirservices/FhirServices_Patch.json new file mode 100644 index 000000000000..081a9e180014 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/fhirservices/FhirServices_Patch.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "fhirServiceName": "fhirservice1", + "api-version": "2021-06-01-preview", + "fhirservicePatchResource": { + "tags": { + "tagKey": "tagValue" + } + } + }, + "responses": { + "200": { + "body": { + "name": "fhirservice1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/fhirservices/fhirservice1", + "type": "Microsoft.HealthcareApis/workspaces/fhirservices", + "tags": { + "tagKey": "tagValue" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "202": { + "body": { + "name": "fhirservice1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/fhirservices/fhirservice1", + "type": "Microsoft.HealthcareApis/workspaces/fhirservices", + "tags": { + "tagKey": "tagValue" + }, + "properties": { + "provisioningState": "Accepted" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/iotconnectors/iotconnector_Create.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/iotconnectors/iotconnector_Create.json new file mode 100644 index 000000000000..cba016aef79f --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/iotconnectors/iotconnector_Create.json @@ -0,0 +1,214 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "iotConnectorName": "blue", + "api-version": "2021-06-01-preview", + "iotConnector": { + "location": "westus", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "ingestionEndpointConfiguration": { + "eventHubName": "MyEventHubName", + "consumerGroup": "ConsumerGroupA", + "fullyQualifiedEventHubNamespace": "myeventhub.servicesbus.windows.net" + }, + "deviceMapping": { + "content": { + "templateType": "CollectionContent", + "template": [ + { + "templateType": "JsonPathContent", + "template": { + "typeName": "heartrate", + "typeMatchExpression": "$..[?(@heartrate)]", + "deviceIdExpression": "$.deviceid", + "timestampExpression": "$.measurementdatetime", + "values": [ + { + "required": "true", + "valueExpression": "$.heartrate", + "valueName": "hr" + } + ] + } + } + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "blue", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue", + "type": "Microsoft.HealthcareApis/workspaces/iotconnectors", + "location": "westus", + "etag": "00000000-0000-0000-f5ac-912ca49e01d6", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Succeeded", + "ingestionEndpointConfiguration": { + "eventHubName": "MyEventHubName", + "consumerGroup": "ConsumerGroupA", + "fullyQualifiedEventHubNamespace": "myeventhub.servicesbus.windows.net" + }, + "deviceMapping": { + "content": { + "templateType": "CollectionContent", + "template": [ + { + "templateType": "JsonPathContent", + "template": { + "typeName": "heartrate", + "typeMatchExpression": "$..[?(@heartrate)]", + "deviceIdExpression": "$.deviceid", + "timestampExpression": "$.measurementdatetime", + "values": [ + { + "required": "true", + "valueExpression": "$.heartrate", + "valueName": "hr" + } + ] + } + } + ] + } + } + }, + "systemData": { + "createdBy": "string", + "createdAt": "2021-01-28T19:26:24.072Z", + "lastModifiedBy": "string", + "lastModifiedAt": "2021-01-28T19:26:24.072Z" + } + } + }, + "201": { + "body": { + "name": "blue", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue", + "type": "Microsoft.HealthcareApis/workspaces/iotconnectors", + "location": "westus", + "etag": "00000000-0000-0000-f5ac-912ca49e01d6", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Creating", + "ingestionEndpointConfiguration": { + "eventHubName": "MyEventHubName", + "consumerGroup": "ConsumerGroupA", + "fullyQualifiedEventHubNamespace": "myeventhub.servicesbus.windows.net" + }, + "deviceMapping": { + "content": { + "templateType": "CollectionContent", + "template": [ + { + "templateType": "JsonPathContent", + "template": { + "typeName": "heartrate", + "typeMatchExpression": "$..[?(@heartrate)]", + "deviceIdExpression": "$.deviceid", + "timestampExpression": "$.measurementdatetime", + "values": [ + { + "required": "true", + "valueExpression": "$.heartrate", + "valueName": "hr" + } + ] + } + } + ] + } + } + }, + "systemData": { + "createdBy": "string", + "createdAt": "2021-01-28T19:26:24.072Z", + "lastModifiedBy": "string", + "lastModifiedAt": "2021-01-28T19:26:24.072Z" + } + } + }, + "202": { + "body": { + "name": "blue", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue", + "type": "Microsoft.HealthcareApis/workspaces/iotconnectors", + "location": "westus", + "etag": "00000000-0000-0000-f5ac-912ca49e01d6", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Accepted", + "ingestionEndpointConfiguration": { + "eventHubName": "MyEventHubName", + "consumerGroup": "ConsumerGroupA", + "fullyQualifiedEventHubNamespace": "myeventhub.servicesbus.windows.net" + }, + "deviceMapping": { + "content": { + "templateType": "CollectionContent", + "template": [ + { + "templateType": "JsonPathContent", + "template": { + "typeName": "heartrate", + "typeMatchExpression": "$..[?(@heartrate)]", + "deviceIdExpression": "$.deviceid", + "timestampExpression": "$.measurementdatetime", + "values": [ + { + "required": "true", + "valueExpression": "$.heartrate", + "valueName": "hr" + } + ] + } + } + ] + } + } + }, + "systemData": { + "createdBy": "string", + "createdAt": "2021-01-28T19:26:24.072Z", + "lastModifiedBy": "string", + "lastModifiedAt": "2021-01-28T19:26:24.072Z" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/iotconnectors/iotconnector_Delete.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/iotconnectors/iotconnector_Delete.json new file mode 100644 index 000000000000..6485ba31503e --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/iotconnectors/iotconnector_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "iotConnectorName": "blue", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/iotconnectors/iotconnector_Get.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/iotconnectors/iotconnector_Get.json new file mode 100644 index 000000000000..f3947d86908e --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/iotconnectors/iotconnector_Get.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "iotConnectorName": "blue", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "blue", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue", + "type": "Microsoft.HealthcareApis/workspaces/iotconnectors", + "location": "westus", + "etag": "00000000-0000-0000-f5ac-912ca49e01d6", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Creating", + "ingestionEndpointConfiguration": { + "eventHubName": "MyEventHubName", + "consumerGroup": "ConsumerGroupA", + "fullyQualifiedEventHubNamespace": "myeventhub.servicesbus.windows.net" + }, + "deviceMapping": { + "content": { + "templateType": "CollectionContent", + "template": [ + { + "templateType": "JsonPathContent", + "template": { + "typeName": "heartrate", + "typeMatchExpression": "$..[?(@heartrate)]", + "deviceIdExpression": "$.deviceid", + "timestampExpression": "$.measurementdatetime", + "values": [ + { + "required": "true", + "valueExpression": "$.heartrate", + "valueName": "hr" + } + ] + } + } + ] + } + } + }, + "systemData": { + "createdBy": "string", + "createdAt": "2021-01-28T19:26:24.072Z", + "lastModifiedBy": "string", + "lastModifiedAt": "2021-01-28T19:26:24.072Z" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/iotconnectors/iotconnector_List.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/iotconnectors/iotconnector_List.json new file mode 100644 index 000000000000..9a8934cb8592 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/iotconnectors/iotconnector_List.json @@ -0,0 +1,121 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "nextLink": "string", + "value": [ + { + "name": "blue", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue", + "type": "Microsoft.HealthcareApis/workspaces/iotconnectors", + "location": "westus", + "etag": "00000000-0000-0000-f5ac-912ca49e01d6", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Creating", + "ingestionEndpointConfiguration": { + "eventHubName": "MyEventHubName", + "consumerGroup": "ConsumerGroupA", + "fullyQualifiedEventHubNamespace": "myeventhub.servicesbus.windows.net" + }, + "deviceMapping": { + "content": { + "templateType": "CollectionContent", + "template": [ + { + "templateType": "JsonPathContent", + "template": { + "typeName": "heartrate", + "typeMatchExpression": "$..[?(@heartrate)]", + "deviceIdExpression": "$.deviceid", + "timestampExpression": "$.measurementdatetime", + "values": [ + { + "required": "true", + "valueExpression": "$.heartrate", + "valueName": "hr" + } + ] + } + } + ] + } + } + }, + "systemData": { + "createdBy": "string", + "createdAt": "2021-01-28T19:26:24.072Z", + "lastModifiedBy": "string", + "lastModifiedAt": "2021-01-28T19:26:24.072Z" + } + }, + { + "name": "red", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/red", + "type": "Microsoft.HealthcareApis/workspaces/iotconnectors", + "location": "westus", + "etag": "00000000-0000-0000-f6ac-912ca49e01d6", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Suceeded", + "ingestionEndpointConfiguration": { + "eventHubName": "MyEventHubName", + "consumerGroup": "ConsumerGroupA", + "fullyQualifiedEventHubNamespace": "myeventhub.servicesbus.windows.net" + }, + "deviceMapping": { + "content": { + "templateType": "CollectionContent", + "template": [ + { + "templateType": "JsonPathContent", + "template": { + "typeName": "steps", + "typeMatchExpression": "$..[?(@steps)]", + "deviceIdExpression": "$.deviceid", + "timestampExpression": "$.measurementdatetime", + "values": [ + { + "required": "true", + "valueExpression": "$.steps", + "valueName": "steps" + } + ] + } + } + ] + } + } + }, + "systemData": { + "createdBy": "string", + "createdAt": "2021-01-27T19:26:24.072Z", + "lastModifiedBy": "string", + "lastModifiedAt": "2021-01-27T19:26:24.072Z" + } + } + ] + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/iotconnectors/iotconnector_Patch.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/iotconnectors/iotconnector_Patch.json new file mode 100644 index 000000000000..082bcc55b967 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/iotconnectors/iotconnector_Patch.json @@ -0,0 +1,129 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "iotConnectorName": "blue", + "api-version": "2021-06-01-preview", + "iotConnectorPatchResource": { + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "name": "blue", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue", + "type": "Microsoft.HealthcareApis/workspaces/iotconnectors", + "location": "westus", + "etag": "00000000-0000-0000-f5ac-912ca49e01d6", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Succeeded", + "ingestionEndpointConfiguration": { + "eventHubName": "MyEventHubName", + "consumerGroup": "ConsumerGroupA", + "fullyQualifiedEventHubNamespace": "myeventhub.servicesbus.windows.net" + }, + "deviceMapping": { + "content": { + "templateType": "CollectionContent", + "template": [ + { + "templateType": "JsonPathContent", + "template": { + "typeName": "heartrate", + "typeMatchExpression": "$..[?(@heartrate)]", + "deviceIdExpression": "$.deviceid", + "timestampExpression": "$.measurementdatetime", + "values": [ + { + "required": "true", + "valueExpression": "$.heartrate", + "valueName": "hr" + } + ] + } + } + ] + } + } + }, + "systemData": { + "createdBy": "string", + "createdAt": "2021-01-28T19:26:24.072Z", + "lastModifiedBy": "string", + "lastModifiedAt": "2021-01-28T19:26:24.072Z" + } + } + }, + "202": { + "body": { + "name": "blue", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue", + "type": "Microsoft.HealthcareApis/workspaces/iotconnectors", + "location": "westus", + "etag": "00000000-0000-0000-f5ac-912ca49e01d6", + "tags": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Accepted", + "ingestionEndpointConfiguration": { + "eventHubName": "MyEventHubName", + "consumerGroup": "ConsumerGroupA", + "fullyQualifiedEventHubNamespace": "myeventhub.servicesbus.windows.net" + }, + "deviceMapping": { + "content": { + "templateType": "CollectionContent", + "template": [ + { + "templateType": "JsonPathContent", + "template": { + "typeName": "heartrate", + "typeMatchExpression": "$..[?(@heartrate)]", + "deviceIdExpression": "$.deviceid", + "timestampExpression": "$.measurementdatetime", + "values": [ + { + "required": "true", + "valueExpression": "$.heartrate", + "valueName": "hr" + } + ] + } + } + ] + } + } + }, + "systemData": { + "createdBy": "string", + "createdAt": "2021-01-28T19:26:24.072Z", + "lastModifiedBy": "string", + "lastModifiedAt": "2021-01-28T19:26:24.072Z" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/iotconnectors/iotconnector_fhirdestination_Create.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/iotconnectors/iotconnector_fhirdestination_Create.json new file mode 100644 index 000000000000..402525343551 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/iotconnectors/iotconnector_fhirdestination_Create.json @@ -0,0 +1,187 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "iotConnectorName": "blue", + "fhirDestinationName": "dest1", + "api-version": "2021-06-01-preview", + "iotFhirDestination": { + "location": "westus", + "properties": { + "resourceIdentityResolutionType": "Create", + "fhirServiceResourceId": "subscriptions/11111111-2222-3333-4444-555566667777/resourceGroups/myrg/providers/Microsoft.HealthcareApis/workspaces/myworkspace/fhirservices/myfhirservice", + "fhirMapping": { + "content": { + "templateType": "CollectionFhirTemplate", + "template": [ + { + "templateType": "CodeValueFhir", + "template": { + "codes": [ + { + "code": "8867-4", + "system": "http://loinc.org", + "display": "Heart rate" + } + ], + "periodInterval": 60, + "typeName": "heartrate", + "value": { + "defaultPeriod": 5000, + "unit": "count/min", + "valueName": "hr", + "valueType": "SampledData" + } + } + } + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "dest1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue/fhirdestinations/dest1", + "type": "Microsoft.HealthcareApis/workspaces/iotconnectors/fhirdestinations", + "location": "West US 2", + "etag": "00000000-0000-0000-f5ac-912ca49e01d6", + "properties": { + "provisioningState": "Succeeded", + "resourceIdentityResolutionType": "Create", + "fhirServiceResourceId": "subscriptions/11111111-2222-3333-4444-555566667777/resourceGroups/myrg/providers/Microsoft.HealthcareApis/workspaces/myworkspace/fhirservices/myfhirservice", + "fhirMapping": { + "content": { + "templateType": "CollectionFhirTemplate", + "template": [ + { + "templateType": "CodeValueFhir", + "template": { + "codes": [ + { + "code": "8867-4", + "system": "http://loinc.org", + "display": "Heart rate" + } + ], + "periodInterval": 60, + "typeName": "heartrate", + "value": { + "defaultPeriod": 5000, + "unit": "count/min", + "valueName": "hr", + "valueType": "SampledData" + } + } + } + ] + } + } + }, + "systemData": { + "createdBy": "string", + "createdAt": "2021-01-28T19:26:24.072Z", + "lastModifiedBy": "string", + "lastModifiedAt": "2021-01-28T19:26:24.072Z" + } + } + }, + "201": { + "body": { + "name": "dest1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue/fhirdestinations/dest1", + "type": "Microsoft.HealthcareApis/workspaces/iotconnectors/fhirdestinations", + "location": "West US 2", + "etag": "00000000-0000-0000-f5ac-912ca49e01d6", + "properties": { + "provisioningState": "Creating", + "resourceIdentityResolutionType": "Create", + "fhirServiceResourceId": "subscriptions/11111111-2222-3333-4444-555566667777/resourceGroups/myrg/providers/Microsoft.HealthcareApis/workspaces/myworkspace/fhirservices/myfhirservice", + "fhirMapping": { + "content": { + "templateType": "CollectionFhirTemplate", + "template": [ + { + "templateType": "CodeValueFhir", + "template": { + "codes": [ + { + "code": "8867-4", + "system": "http://loinc.org", + "display": "Heart rate" + } + ], + "periodInterval": 60, + "typeName": "heartrate", + "value": { + "defaultPeriod": 5000, + "unit": "count/min", + "valueName": "hr", + "valueType": "SampledData" + } + } + } + ] + } + } + }, + "systemData": { + "createdBy": "string", + "createdAt": "2021-01-28T19:26:24.072Z", + "lastModifiedBy": "string", + "lastModifiedAt": "2021-01-28T19:26:24.072Z" + } + } + }, + "202": { + "body": { + "name": "dest1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue/fhirdestinations/dest1", + "type": "Microsoft.HealthcareApis/workspaces/iotconnectors/fhirdestinations", + "location": "West US 2", + "etag": "00000000-0000-0000-f5ac-912ca49e01d6", + "properties": { + "provisioningState": "Accepted", + "resourceIdentityResolutionType": "Create", + "fhirServiceResourceId": "subscriptions/11111111-2222-3333-4444-555566667777/resourceGroups/myrg/providers/Microsoft.HealthcareApis/workspaces/myworkspace/fhirservices/myfhirservice", + "fhirMapping": { + "content": { + "templateType": "CollectionFhirTemplate", + "template": [ + { + "templateType": "CodeValueFhir", + "template": { + "codes": [ + { + "code": "8867-4", + "system": "http://loinc.org", + "display": "Heart rate" + } + ], + "periodInterval": 60, + "typeName": "heartrate", + "value": { + "defaultPeriod": 5000, + "unit": "count/min", + "valueName": "hr", + "valueType": "SampledData" + } + } + } + ] + } + } + }, + "systemData": { + "createdBy": "string", + "createdAt": "2021-01-28T19:26:24.072Z", + "lastModifiedBy": "string", + "lastModifiedAt": "2021-01-28T19:26:24.072Z" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/iotconnectors/iotconnector_fhirdestination_Delete.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/iotconnectors/iotconnector_fhirdestination_Delete.json new file mode 100644 index 000000000000..4ed8f8fb0e0b --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/iotconnectors/iotconnector_fhirdestination_Delete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "iotConnectorName": "blue", + "fhirDestinationName": "dest1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/iotconnectors/iotconnector_fhirdestination_Get.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/iotconnectors/iotconnector_fhirdestination_Get.json new file mode 100644 index 000000000000..01c11a2661b9 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/iotconnectors/iotconnector_fhirdestination_Get.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "iotConnectorName": "blue", + "fhirDestinationName": "dest1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "dest1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue/fhirdestinations/dest1", + "type": "Microsoft.HealthcareApis/workspaces/iotconnectors/fhirdestinations", + "location": "westus", + "etag": "00000000-0000-0000-f5ac-912ca49e01d6", + "properties": { + "provisioningState": "Suceeded", + "resourceIdentityResolutionType": "Create", + "fhirServiceResourceId": "subscriptions/11111111-2222-3333-4444-555566667777/resourceGroups/myrg/providers/Microsoft.HealthcareApis/workspaces/myworkspace/fhirservices/myfhirservice", + "fhirMapping": { + "content": { + "templateType": "CollectionFhirTemplate", + "template": [ + { + "templateType": "CodeValueFhir", + "template": { + "codes": [ + { + "code": "8867-4", + "system": "http://loinc.org", + "display": "Heart rate" + } + ], + "periodInterval": 60, + "typeName": "heartrate", + "value": { + "defaultPeriod": 5000, + "unit": "count/min", + "valueName": "hr", + "valueType": "SampledData" + } + } + } + ] + } + } + }, + "systemData": { + "createdBy": "string", + "createdAt": "2021-01-28T19:26:24.072Z", + "lastModifiedBy": "string", + "lastModifiedAt": "2021-01-28T19:26:24.072Z" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/iotconnectors/iotconnector_fhirdestination_List.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/iotconnectors/iotconnector_fhirdestination_List.json new file mode 100644 index 000000000000..27b50a7057ba --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/iotconnectors/iotconnector_fhirdestination_List.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "iotConnectorName": "blue", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "nextLink": "string", + "value": [ + { + "name": "dest1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue/fhirdestinations/dest1", + "type": "Microsoft.HealthcareApis/workspaces/iotconnectors/fhirdestinations", + "location": "westus", + "etag": "00000000-0000-0000-f5ac-912ca49e01d6", + "properties": { + "provisioningState": "Succeeded", + "resourceIdentityResolutionType": "Create", + "fhirServiceResourceId": "subscriptions/11111111-2222-3333-4444-555566667777/resourceGroups/myrg/providers/Microsoft.HealthcareApis/workspaces/myworkspace/fhirservices/myfhirservice", + "fhirMapping": { + "content": { + "templateType": "CollectionFhirTemplate", + "template": [ + { + "templateType": "CodeValueFhir", + "template": { + "codes": [ + { + "code": "8867-4", + "system": "http://loinc.org", + "display": "Heart rate" + } + ], + "periodInterval": 60, + "typeName": "heartrate", + "value": { + "defaultPeriod": 5000, + "unit": "count/min", + "valueName": "hr", + "valueType": "SampledData" + } + } + } + ] + } + } + }, + "systemData": { + "createdBy": "string", + "createdAt": "2021-01-28T19:26:24.072Z", + "lastModifiedBy": "string", + "lastModifiedAt": "2021-01-28T19:26:24.072Z" + } + }, + { + "name": "dest2", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue/fhirdestinations/dest2", + "type": "Microsoft.HealthcareApis/workspaces/iotconnectors/fhirdestinations", + "location": "westus", + "etag": "00000000-0000-0000-f6ac-912ca49e01d6", + "properties": { + "provisioningState": "Suceeded", + "resourceIdentityResolutionType": "Lookup", + "fhirServiceResourceId": "subscriptions/11111111-2222-3333-4444-555566667777/resourceGroups/myrg/providers/Microsoft.HealthcareApis/workspaces/myworkspace/fhirservices/myfhirservice", + "fhirMapping": { + "content": { + "templateType": "CollectionFhirTemplate", + "template": [ + { + "templateType": "CodeValueFhir", + "template": { + "codes": [ + { + "code": "8867-4", + "system": "http://loinc.org", + "display": "Heart rate" + } + ], + "periodInterval": 60, + "typeName": "heartrate", + "value": { + "defaultPeriod": 5000, + "unit": "count/min", + "valueName": "hr", + "valueType": "SampledData" + } + } + } + ] + } + } + }, + "systemData": { + "createdBy": "string", + "createdAt": "2021-01-27T19:26:24.072Z", + "lastModifiedBy": "string", + "lastModifiedAt": "2021-01-27T19:26:24.072Z" + } + } + ] + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/PrivateLinkResourceGet.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/PrivateLinkResourceGet.json new file mode 100644 index 000000000000..f0f66565847f --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/PrivateLinkResourceGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgname", + "resourceName": "service1", + "groupName": "fhir" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1/privateLinkResources/fhir", + "name": "fhir", + "type": "Microsoft.HealthcareApis/services/privateLinkResources", + "properties": { + "groupId": "fhir", + "requiredMembers": [ + "fhir" + ], + "requiredZoneNames": [ + "privatelink.azurehealthcareapis.com" + ] + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/PrivateLinkResourcesListByService.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/PrivateLinkResourcesListByService.json new file mode 100644 index 000000000000..16cb791b3e6f --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/PrivateLinkResourcesListByService.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgname", + "resourceName": "service1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1/privateLinkResources/fhir", + "name": "fhir", + "type": "Microsoft.HealthcareApis/services/privateLinkResources", + "properties": { + "groupId": "fhir", + "requiredMembers": [ + "fhir" + ], + "requiredZoneNames": [ + "privatelink.azurehealthcareapis.com" + ] + } + } + ] + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServiceCreate.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServiceCreate.json new file mode 100644 index 000000000000..dad159b0dde9 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServiceCreate.json @@ -0,0 +1,177 @@ +{ + "parameters": { + "resourceName": "service1", + "resourceGroupName": "rg1", + "api-version": "2021-06-01-preview", + "subscriptionId": "subid", + "serviceDescription": { + "location": "westus2", + "tags": {}, + "kind": "fhir-R4", + "properties": { + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + }, + { + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000, + "keyVaultKeyUri": "https://my-vault.vault.azure.net/keys/my-key" + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "exportConfiguration": { + "storageAccountName": "existingStorageAccount" + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1", + "name": "service1", + "location": "West US 2", + "type": "Microsoft.HealthcareApis/services", + "kind": "fhir-R4", + "etag": "etagvalue", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + }, + { + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000, + "keyVaultKeyUri": "https://my-vault.vault.azure.net/keys/my-key" + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "exportConfiguration": { + "storageAccountName": "existingStorageAccount" + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + }, + "identity": { + "principalId": "03fe6ae0-952c-4e4b-954b-cc0364dd252e", + "tenantId": "72f988bf-86f1-41af-91ab-2d8cd011db47", + "type": "SystemAssigned" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1", + "name": "service1", + "location": "West US 2", + "type": "Microsoft.HealthcareApis/services", + "kind": "fhir-R4", + "etag": "etagvalue", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + }, + { + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000 + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "exportConfiguration": { + "storageAccountName": "existingStorageAccount" + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + }, + "identity": { + "principalId": "03fe6ae0-952c-4e4b-954b-cc0364dd252e", + "tenantId": "72f988bf-86f1-41af-91ab-2d8cd011db47", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServiceCreateMinimum.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServiceCreateMinimum.json new file mode 100644 index 000000000000..be5b63608c23 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServiceCreateMinimum.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "resourceName": "service2", + "resourceGroupName": "rg1", + "api-version": "2021-06-01-preview", + "subscriptionId": "subid", + "serviceDescription": { + "location": "westus2", + "tags": {}, + "kind": "fhir-R4", + "properties": { + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service2", + "name": "service2", + "type": "Microsoft.HealthcareApis/services", + "etag": "etagvalue", + "location": "westus2", + "kind": "fhir-R4", + "tags": {}, + "properties": { + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000 + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": false + }, + "corsConfiguration": { + "origins": [], + "headers": [], + "methods": [], + "maxAge": null, + "allowCredentials": false + }, + "provisioningState": "Creating", + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service2", + "name": "service2", + "type": "Microsoft.HealthcareApis/services", + "etag": "etagvalue", + "location": "westus2", + "kind": "fhir-R4", + "tags": {}, + "properties": { + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000, + "keyVaultKeyUri": null + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": false + }, + "corsConfiguration": { + "origins": [], + "headers": [], + "methods": [], + "maxAge": null, + "allowCredentials": false + }, + "provisioningState": "Creating", + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServiceCreatePrivateEndpointConnection.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServiceCreatePrivateEndpointConnection.json new file mode 100644 index 000000000000..47f78a2ab37c --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServiceCreatePrivateEndpointConnection.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgname", + "resourceName": "service1", + "privateEndpointConnectionName": "myConnection", + "properties": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1/privateEndpointConnections/myConnection", + "name": "myConnection", + "type": "Microsoft.HealthcareApis/services/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/peexample01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServiceDelete.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServiceDelete.json new file mode 100644 index 000000000000..cd8df7a9cfa4 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServiceDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "resourceName": "service1", + "resourceGroupName": "rg1", + "api-version": "2021-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServiceDeletePrivateEndpointConnection.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServiceDeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..05e8858bf351 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServiceDeletePrivateEndpointConnection.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgname", + "resourceName": "service1", + "privateEndpointConnectionName": "myConnection" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServiceGet.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServiceGet.json new file mode 100644 index 000000000000..aca5ee906fa7 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServiceGet.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "resourceName": "service1", + "resourceGroupName": "rg1", + "api-version": "2021-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1", + "name": "service1", + "location": "West US", + "type": "Microsoft.HealthcareApis/services", + "kind": "fhir-R4", + "etag": "etagvalue", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + }, + { + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000, + "keyVaultKeyUri": "https://my-vault.vault.azure.net/keys/my-key" + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServiceGetPrivateEndpointConnection.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServiceGetPrivateEndpointConnection.json new file mode 100644 index 000000000000..18cb27c28db1 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServiceGetPrivateEndpointConnection.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgname", + "resourceName": "service1", + "privateEndpointConnectionName": "myConnection" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1/privateEndpointConnections/myConnection", + "name": "myConnection", + "type": "Microsoft.HealthcareApis/services/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/peexample01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServiceList.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServiceList.json new file mode 100644 index 000000000000..36ac4a962989 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServiceList.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1", + "name": "service1", + "location": "West US", + "type": "Microsoft.HealthcareApis/services", + "kind": "fhir-R4", + "etag": "etag", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + }, + { + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000, + "keyVaultKeyUri": "https://my-vault.vault.azure.net/keys/my-key" + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + } + } + ], + "nextLink": "https://host/subscriptions/subid/providers/Microsoft.HealthcareApis/services?api-version=2018-08-20-preview&%24skipToken=e30%3d" + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServiceListByResourceGroup.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServiceListByResourceGroup.json new file mode 100644 index 000000000000..bd8d514d7940 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServiceListByResourceGroup.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgname" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/dddb8dcb-effb-4290-bb47-ce1e8440c729", + "name": "service1", + "location": "westus", + "type": "Microsoft.HealthcareApis/services", + "kind": "fhir-R4", + "tags": {}, + "etag": "etagvalue", + "properties": { + "provisioningState": "Creating", + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + }, + { + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000, + "keyVaultKeyUri": "https://my-vault.vault.azure.net/keys/my-key" + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + } + } + ], + "nextLink": "https://host/subscriptions/subid/resourceGroups/rgname/providers/Microsoft.HealthcareApis/services?api-version=2018-08-20-preview&%24skipToken=e30%3d" + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServiceListPrivateEndpointConnections.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServiceListPrivateEndpointConnections.json new file mode 100644 index 000000000000..b161199768c1 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServiceListPrivateEndpointConnections.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgname", + "resourceName": "service1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1/privateEndpointConnections/myConnection", + "name": "myConnection", + "type": "Microsoft.HealthcareApis/services/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/peexample01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServicePatch.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServicePatch.json new file mode 100644 index 000000000000..2dc3f6264117 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/legacy/ServicePatch.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "resourceName": "service1", + "resourceGroupName": "rg1", + "api-version": "2021-06-01-preview", + "subscriptionId": "subid", + "servicePatchDescription": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1", + "name": "service1", + "location": "West US", + "type": "Microsoft.HealthcareApis/services", + "kind": "fhir-R4", + "etag": "etagvalue", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Creating", + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + }, + { + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000, + "keyVaultKeyUri": "https://my-vault.vault.azure.net/keys/my-key" + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/workspaces/Workspaces_Create.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/workspaces/Workspaces_Create.json new file mode 100644 index 000000000000..8e5323819095 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/workspaces/Workspaces_Create.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "api-version": "2021-06-01-preview", + "workspace": { + "location": "westus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1", + "type": "Microsoft.HealthcareApis/workspaces", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "workspace1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1", + "type": "Microsoft.HealthcareApis/workspaces", + "location": "westus", + "properties": { + "provisioningState": "Creating" + } + } + }, + "202": { + "body": { + "name": "workspace1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1", + "type": "Microsoft.HealthcareApis/workspaces", + "location": "westus", + "properties": { + "provisioningState": "Accepted" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/workspaces/Workspaces_Delete.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/workspaces/Workspaces_Delete.json new file mode 100644 index 000000000000..7da7470e9ad7 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/workspaces/Workspaces_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/workspaces/Workspaces_Get.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/workspaces/Workspaces_Get.json new file mode 100644 index 000000000000..d82a4fbd33ac --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/workspaces/Workspaces_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1", + "type": "Microsoft.HealthcareApis/workspaces", + "location": "westus", + "properties": { + "provisioningState": "Creating" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/workspaces/Workspaces_ListByResourceGroup.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/workspaces/Workspaces_ListByResourceGroup.json new file mode 100644 index 000000000000..bb50819bcc8c --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/workspaces/Workspaces_ListByResourceGroup.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "nextLink": "string", + "value": [ + { + "name": "workspace1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1", + "type": "Microsoft.HealthcareApis/workspaces", + "location": "eastus", + "properties": { + "provisioningState": "Creating" + } + } + ] + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/workspaces/Workspaces_ListBySubscription.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/workspaces/Workspaces_ListBySubscription.json new file mode 100644 index 000000000000..8f19fcd76c4b --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/workspaces/Workspaces_ListBySubscription.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "nextLink": "string", + "value": [ + { + "name": "workspace1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1", + "type": "Microsoft.HealthcareApis/workspaces", + "location": "eastus", + "properties": { + "provisioningState": "Creating" + } + } + ] + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/workspaces/Workspaces_Patch.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/workspaces/Workspaces_Patch.json new file mode 100644 index 000000000000..6ea5f4070bc0 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/examples/workspaces/Workspaces_Patch.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testRG", + "workspaceName": "workspace1", + "api-version": "2021-06-01-preview", + "workspacePatchResource": { + "tags": { + "tagKey": "tagValue" + } + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1", + "type": "Microsoft.HealthcareApis/workspaces", + "location": "westus", + "tags": { + "tagKey": "tagValue" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "202": { + "body": { + "name": "workspace1", + "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1", + "type": "Microsoft.HealthcareApis/workspaces", + "location": "westus", + "tags": { + "tagKey": "tagValue" + }, + "properties": { + "provisioningState": "Accepted" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/healthcare-apis.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/healthcare-apis.json new file mode 100644 index 000000000000..7a1ad8ce513e --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2021-06-01-preview/healthcare-apis.json @@ -0,0 +1,3415 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01-preview", + "title": "HealthcareApisClient", + "description": "Use this API to manage Microsoft HealthcareApis services in your Azure subscription." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}": { + "get": { + "tags": [ + "Resource" + ], + "description": "Get the metadata of a service instance.", + "operationId": "Services_Get", + "x-ms-examples": { + "Get metadata": { + "$ref": "./examples/legacy/ServiceGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "The body contains all of the properties of the service instance.", + "schema": { + "$ref": "#/definitions/ServicesDescription" + } + }, + "default": { + "description": "Default error response", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "put": { + "tags": [ + "Resource" + ], + "description": "Create or update the metadata of a service instance.", + "operationId": "Services_CreateOrUpdate", + "x-ms-examples": { + "Create or Update a service with all parameters": { + "$ref": "./examples/legacy/ServiceCreate.json" + }, + "Create or Update a service with minimum parameters": { + "$ref": "./examples/legacy/ServiceCreateMinimum.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "serviceDescription", + "in": "body", + "description": "The service instance metadata.", + "required": true, + "schema": { + "$ref": "#/definitions/ServicesDescription" + } + } + ], + "responses": { + "200": { + "description": "Updated - Put request accepted and an existing resource is being updated; the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ServicesDescription" + } + }, + "201": { + "description": "Created - Put request accepted and a new resource was created; the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ServicesDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "patch": { + "tags": [ + "Resource" + ], + "description": "Update the metadata of a service instance.", + "operationId": "Services_Update", + "x-ms-examples": { + "Patch service": { + "$ref": "./examples/legacy/ServicePatch.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "servicePatchDescription", + "in": "body", + "description": "The service instance metadata and security metadata.", + "required": true, + "schema": { + "$ref": "#/definitions/ServicesPatchDescription" + } + } + ], + "responses": { + "200": { + "description": "The tags for the resource were updated successfully.", + "schema": { + "$ref": "#/definitions/ServicesDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "delete": { + "tags": [ + "Resource" + ], + "description": "Delete a service instance.", + "operationId": "Services_Delete", + "x-ms-examples": { + "Delete service": { + "$ref": "./examples/legacy/ServiceDelete.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "202": { + "description": "Accepted - Delete request accepted; the operation will complete asynchronously." + }, + "204": { + "description": "The resource does not exist." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/services": { + "get": { + "tags": [ + "Collection" + ], + "description": "Get all the service instances in a subscription.", + "operationId": "Services_List", + "x-ms-examples": { + "List all services in subscription": { + "$ref": "./examples/legacy/ServiceList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the service instances in the subscription.", + "schema": { + "$ref": "#/definitions/ServicesDescriptionListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services": { + "get": { + "tags": [ + "Collection" + ], + "description": "Get all the service instances in a resource group.", + "operationId": "Services_ListByResourceGroup", + "x-ms-examples": { + "List all services in resource group": { + "$ref": "./examples/legacy/ServiceListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the service instances in the resource group.", + "schema": { + "$ref": "#/definitions/ServicesDescriptionListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/checkNameAvailability": { + "post": { + "tags": [ + "Proxy" + ], + "description": "Check if a service instance name is available.", + "operationId": "Services_CheckNameAvailability", + "x-ms-examples": { + "Check name availability": { + "$ref": "./examples/CheckNameAvailabilityPost.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "checkNameAvailabilityInputs", + "in": "body", + "description": "Set the name parameter in the CheckNameAvailabilityParameters structure to the name of the service instance to check.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityParameters" + } + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the service name is available. If the name is not available, the body contains the reason.", + "schema": { + "$ref": "#/definitions/ServicesNameAvailabilityInfo" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_ListByService", + "description": "Lists all private endpoint connections for a service.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResultDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnection_List": { + "$ref": "./examples/legacy/ServiceListPrivateEndpointConnections.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "description": "Gets the specified private endpoint connection associated with the service.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnection_GetConnection": { + "$ref": "./examples/legacy/ServiceGetPrivateEndpointConnection.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "description": "Update the state of the specified private endpoint connection associated with the service.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "description": "The private endpoint connection properties." + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnection_CreateOrUpdate": { + "$ref": "./examples/legacy/ServiceCreatePrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Deletes a private endpoint connection.", + "operationId": "PrivateEndpointConnections_Delete", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "The request was successful; the operation will complete asynchronously." + }, + "204": { + "description": "No Content - The private endpoint connection does not exist." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_Delete": { + "$ref": "./examples/legacy/ServiceDeletePrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_ListByService", + "description": "Gets the private link resources that need to be created for a service.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResultDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-examples": { + "PrivateLinkResources_ListGroupIds": { + "$ref": "./examples/legacy/PrivateLinkResourcesListByService.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateLinkResources/{groupName}": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_Get", + "description": "Gets a private link resource that need to be created for a service.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "groupName", + "in": "path", + "description": "The name of the private link resource group.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-examples": { + "PrivateLinkResources_Get": { + "$ref": "./examples/legacy/PrivateLinkResourceGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Lists all the available workspaces under the specified subscription.", + "operationId": "Workspaces_ListBySubscription", + "x-ms-examples": { + "Get workspaces by subscription": { + "$ref": "./examples/workspaces/Workspaces_ListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the workspaces in the subscription.", + "schema": { + "$ref": "#/definitions/WorkspaceList" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Lists all the available workspaces under the specified resource group.", + "operationId": "Workspaces_ListByResourceGroup", + "x-ms-examples": { + "Get workspaces by resource group": { + "$ref": "./examples/workspaces/Workspaces_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the workspaces in the resource group.", + "schema": { + "$ref": "#/definitions/WorkspaceList" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Gets the properties of the specified workspace.", + "operationId": "Workspaces_Get", + "x-ms-examples": { + "Get workspace": { + "$ref": "./examples/workspaces/Workspaces_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/workspaceName" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "put": { + "tags": [ + "Workspaces" + ], + "description": "Creates or updates a workspace resource with the specified parameters.", + "operationId": "Workspaces_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update a workspace": { + "$ref": "./examples/workspaces/Workspaces_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "name": "workspace", + "description": "The parameters for creating or updating a healthcare workspace.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Workspace" + } + } + ], + "responses": { + "200": { + "description": "Updated - Put request accepted and an existing resource is updated.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "201": { + "description": "Created - Put request accepted and an existing resource is being created asynchronously.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "202": { + "description": "Accepted - Put request accepted and an existing resource is being updated asynchronously.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "patch": { + "tags": [ + "Workspaces" + ], + "description": "Patch workspace details.", + "operationId": "Workspaces_Update", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a workspace": { + "$ref": "./examples/workspaces/Workspaces_Patch.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "name": "workspacePatchResource", + "description": "The parameters for updating a specified workspace.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspacePatchResource" + } + } + ], + "responses": { + "200": { + "description": "Updated - Patch request accepted and an existing resource is updated.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "202": { + "description": "Accepted - Patch request accepted and an existing resource is being updated asynchronously.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "delete": { + "tags": [ + "Workspaces" + ], + "description": "Deletes a specified workspace.", + "operationId": "Workspaces_Delete", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a workspace": { + "$ref": "./examples/workspaces/Workspaces_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/workspaceName" + } + ], + "responses": { + "200": { + "description": "Resource deleted." + }, + "202": { + "description": "Delete request accepted; the operation will complete asynchronously." + }, + "204": { + "description": "The resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/dicomservices": { + "get": { + "tags": [ + "DicomServices" + ], + "description": "Lists all DICOM Services for the given workspace", + "operationId": "DicomServices_ListByWorkspace", + "x-ms-examples": { + "List dicomservices": { + "$ref": "./examples/dicomservices/DicomServices_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/workspaceName" + } + ], + "responses": { + "200": { + "description": "List of DICOM Services.", + "schema": { + "$ref": "#/definitions/DicomServiceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/dicomservices/{dicomServiceName}": { + "get": { + "tags": [ + "DicomServices" + ], + "description": "Gets the properties of the specified DICOM Service.", + "operationId": "DicomServices_Get", + "x-ms-examples": { + "Get a dicomservice": { + "$ref": "./examples/dicomservices/DicomServices_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "$ref": "#/parameters/dicomServiceName" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/DicomService" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "put": { + "tags": [ + "DicomServices" + ], + "description": "Creates or updates a DICOM Service resource with the specified parameters.", + "operationId": "DicomServices_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update a Dicom Service": { + "$ref": "./examples/dicomservices/DicomServices_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "$ref": "#/parameters/dicomServiceName" + }, + { + "name": "dicomservice", + "description": "The parameters for creating or updating a Dicom Service resource.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DicomService" + } + } + ], + "responses": { + "200": { + "description": "Updated - Put request accepted and an existing resource is updated.", + "schema": { + "$ref": "#/definitions/DicomService" + } + }, + "201": { + "description": "Created - Put request accepted and an existing resource is being created asynchronously.", + "schema": { + "$ref": "#/definitions/DicomService" + } + }, + "202": { + "description": "Accepted - Put request accepted and an existing resource is being updated asynchronously.", + "schema": { + "$ref": "#/definitions/DicomService" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "patch": { + "tags": [ + "DicomServices" + ], + "description": "Patch DICOM Service details.", + "operationId": "DicomServices_Update", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a dicomservice": { + "$ref": "./examples/dicomservices/DicomServices_Patch.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/dicomServiceName" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "name": "dicomservicePatchResource", + "description": "The parameters for updating a Dicom Service.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DicomServicePatchResource" + } + } + ], + "responses": { + "200": { + "description": "Updated - Patch request accepted and an existing resource is updated.", + "schema": { + "$ref": "#/definitions/DicomService" + } + }, + "202": { + "description": "Accepted - Patch request accepted and an existing resource is being updated asynchronously.", + "schema": { + "$ref": "#/definitions/DicomService" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "delete": { + "tags": [ + "DicomServices" + ], + "description": "Deletes a DICOM Service.", + "operationId": "DicomServices_Delete", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a dicomservice": { + "$ref": "./examples/dicomservices/DicomServices_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/dicomServiceName" + }, + { + "$ref": "#/parameters/workspaceName" + } + ], + "responses": { + "200": { + "description": "Resource deleted." + }, + "202": { + "description": "Delete request accepted; the operation will complete asynchronously." + }, + "204": { + "description": "The resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors": { + "get": { + "tags": [ + "IotConnectors" + ], + "description": "Lists all IoT Connectors for the given workspace", + "operationId": "IotConnectors_ListByWorkspace", + "x-ms-examples": { + "List iotconnectors": { + "$ref": "./examples/iotconnectors/iotconnector_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/workspaceName" + } + ], + "responses": { + "200": { + "description": "List of IoT Connectors.", + "schema": { + "$ref": "#/definitions/IotConnectorCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}": { + "get": { + "tags": [ + "IotConnectors" + ], + "description": "Gets the properties of the specified IoT Connector.", + "operationId": "IotConnectors_Get", + "x-ms-examples": { + "Get an IoT Connector": { + "$ref": "./examples/iotconnectors/iotconnector_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "$ref": "#/parameters/iotConnectorName" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/IotConnector" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "put": { + "tags": [ + "IotConnectors" + ], + "description": "Creates or updates an IoT Connector resource with the specified parameters.", + "operationId": "IotConnectors_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create an IoT Connector": { + "$ref": "./examples/iotconnectors/iotconnector_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "$ref": "#/parameters/iotConnectorName" + }, + { + "name": "iotConnector", + "description": "The parameters for creating or updating an IoT Connectors resource.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IotConnector" + } + } + ], + "responses": { + "200": { + "description": "Updated - Put request accepted and an existing resource is updated.", + "schema": { + "$ref": "#/definitions/IotConnector" + } + }, + "201": { + "description": "Created - Put request accepted and an existing resource is being created asynchronously.", + "schema": { + "$ref": "#/definitions/IotConnector" + } + }, + "202": { + "description": "Accepted - Put request accepted and an existing resource is being updated asynchronously.", + "schema": { + "$ref": "#/definitions/IotConnector" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "patch": { + "tags": [ + "IotConnectors" + ], + "description": "Patch an IoT Connector.", + "operationId": "IotConnectors_Update", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Patch an IoT Connector": { + "$ref": "./examples/iotconnectors/iotconnector_Patch.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/iotConnectorName" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "name": "iotConnectorPatchResource", + "description": "The parameters for updating an IoT Connector.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IotConnectorPatchResource" + } + } + ], + "responses": { + "200": { + "description": "Updated - Patch request accepted and an existing resource is updated.", + "schema": { + "$ref": "#/definitions/IotConnector" + } + }, + "202": { + "description": "Accepted - Patch request accepted and an existing resource is being updated asynchronously.", + "schema": { + "$ref": "#/definitions/IotConnector" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "delete": { + "tags": [ + "IotConnectors" + ], + "description": "Deletes an IoT Connector.", + "operationId": "IotConnectors_Delete", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete an IoT Connector": { + "$ref": "./examples/iotconnectors/iotconnector_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/iotConnectorName" + }, + { + "$ref": "#/parameters/workspaceName" + } + ], + "responses": { + "200": { + "description": "Resource deleted." + }, + "202": { + "description": "Delete request accepted; the operation will complete asynchronously." + }, + "204": { + "description": "The resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}/fhirdestinations": { + "get": { + "tags": [ + "IotConnectors" + ], + "description": "Lists all FHIR destinations for the given IoT Connector", + "operationId": "FhirDestinations_ListByIotConnector", + "x-ms-examples": { + "List IoT Connectors": { + "$ref": "./examples/iotconnectors/iotconnector_fhirdestination_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "$ref": "#/parameters/iotConnectorName" + } + ], + "responses": { + "200": { + "description": "List of IoT Connector FHIR destinations.", + "schema": { + "$ref": "#/definitions/IotFhirDestinationCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}/fhirdestinations/{fhirDestinationName}": { + "get": { + "tags": [ + "IotConnectors" + ], + "description": "Gets the properties of the specified Iot Connector FHIR destination.", + "operationId": "IotConnectorFhirDestination_Get", + "x-ms-examples": { + "Get an IoT Connector destination": { + "$ref": "./examples/iotconnectors/iotconnector_fhirdestination_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "$ref": "#/parameters/iotConnectorName" + }, + { + "$ref": "#/parameters/fhirDestinationName" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/IotFhirDestination" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "put": { + "tags": [ + "IotConnectors" + ], + "description": "Creates or updates an IoT Connector FHIR destination resource with the specified parameters.", + "operationId": "IotConnectorFhirDestination_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update an Iot Connector FHIR destination": { + "$ref": "./examples/iotconnectors/iotconnector_fhirdestination_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "$ref": "#/parameters/iotConnectorName" + }, + { + "$ref": "#/parameters/fhirDestinationName" + }, + { + "name": "iotFhirDestination", + "description": "The parameters for creating or updating an IoT Connector FHIR destination resource.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IotFhirDestination" + } + } + ], + "responses": { + "200": { + "description": "Updated - Put request accepted and an existing resource is updated.", + "schema": { + "$ref": "#/definitions/IotFhirDestination" + } + }, + "201": { + "description": "Created - Put request accepted and an existing resource is being created asynchronously.", + "schema": { + "$ref": "#/definitions/IotFhirDestination" + } + }, + "202": { + "description": "Accepted - Put request accepted and an existing resource is being updated asynchronously.", + "schema": { + "$ref": "#/definitions/IotFhirDestination" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "delete": { + "tags": [ + "IotConnectors" + ], + "description": "Deletes an IoT Connector FHIR destination.", + "operationId": "IotConnectorFhirDestination_Delete", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete an IoT Connector destination": { + "$ref": "./examples/iotconnectors/iotconnector_fhirdestination_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "$ref": "#/parameters/iotConnectorName" + }, + { + "$ref": "#/parameters/fhirDestinationName" + } + ], + "responses": { + "200": { + "description": "Resource deleted." + }, + "202": { + "description": "Delete request accepted; the operation will complete asynchronously." + }, + "204": { + "description": "The resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/fhirservices": { + "get": { + "tags": [ + "FhirServices" + ], + "description": "Lists all FHIR Services for the given workspace", + "operationId": "FhirServices_ListByWorkspace", + "x-ms-examples": { + "List fhirservices": { + "$ref": "./examples/fhirservices/FhirServices_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/workspaceName" + } + ], + "responses": { + "200": { + "description": "List of FHIR Services.", + "schema": { + "$ref": "#/definitions/FhirServiceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/fhirservices/{fhirServiceName}": { + "get": { + "tags": [ + "FhirServices" + ], + "description": "Gets the properties of the specified FHIR Service.", + "operationId": "FhirServices_Get", + "x-ms-examples": { + "Get a Fhir Service": { + "$ref": "./examples/fhirservices/FhirServices_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "$ref": "#/parameters/fhirServiceName" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/FhirService" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "put": { + "tags": [ + "FhirServices" + ], + "description": "Creates or updates a FHIR Service resource with the specified parameters.", + "operationId": "FhirServices_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update a Fhir Service": { + "$ref": "./examples/fhirservices/FhirServices_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "$ref": "#/parameters/fhirServiceName" + }, + { + "name": "fhirservice", + "description": "The parameters for creating or updating a Fhir Service resource.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FhirService" + } + } + ], + "responses": { + "200": { + "description": "Updated - Put request accepted and an existing resource is updated.", + "schema": { + "$ref": "#/definitions/FhirService" + } + }, + "201": { + "description": "Created - Put request accepted and an existing resource is being created asynchronously.", + "schema": { + "$ref": "#/definitions/FhirService" + } + }, + "202": { + "description": "Accepted - Put request accepted and an existing resource is being updated asynchronously.", + "schema": { + "$ref": "#/definitions/FhirService" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "patch": { + "tags": [ + "FhirServices" + ], + "description": "Patch FHIR Service details.", + "operationId": "FhirServices_Update", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a Fhir Service": { + "$ref": "./examples/fhirservices/FhirServices_Patch.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/fhirServiceName" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "name": "fhirservicePatchResource", + "description": "The parameters for updating a Fhir Service.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FhirServicePatchResource" + } + } + ], + "responses": { + "200": { + "description": "Updated - Patch request accepted and an existing resource is updated.", + "schema": { + "$ref": "#/definitions/FhirService" + } + }, + "202": { + "description": "Accepted - Patch request accepted and an existing resource is being updated asynchronously.", + "schema": { + "$ref": "#/definitions/FhirService" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "delete": { + "tags": [ + "FhirServices" + ], + "description": "Deletes a FHIR Service.", + "operationId": "FhirServices_Delete", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a Fhir Service": { + "$ref": "./examples/fhirservices/FhirServices_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/fhirServiceName" + }, + { + "$ref": "#/parameters/workspaceName" + } + ], + "responses": { + "200": { + "description": "Resource deleted." + }, + "202": { + "description": "Delete request accepted; the operation will complete asynchronously." + }, + "204": { + "description": "The resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/providers/Microsoft.HealthcareApis/operations": { + "get": { + "tags": [ + "Proxy" + ], + "description": "Lists all of the available operations supported by Microsoft Healthcare resource provider.", + "operationId": "Operations_List", + "x-ms-examples": { + "List operations": { + "$ref": "./examples/OperationsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ListOperations" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/locations/{locationName}/operationresults/{operationResultId}": { + "get": { + "tags": [ + "Proxy" + ], + "description": "Get the operation result for a long running operation.", + "operationId": "OperationResults_Get", + "x-ms-examples": { + "Get operation result": { + "$ref": "./examples/OperationResultsGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/locationName" + }, + { + "$ref": "#/parameters/operationResultId" + } + ], + "responses": { + "200": { + "description": "The body contains all of the properties of the operation result.", + "schema": { + "$ref": "#/definitions/OperationResultsDescription" + } + }, + "default": { + "description": "Default error response", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + } + }, + "definitions": { + "ServicesProperties": { + "description": "The properties of a service instance.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state.", + "enum": [ + "Deleting", + "Succeeded", + "Creating", + "Accepted", + "Verifying", + "Updating", + "Failed", + "Canceled", + "Deprovisioned" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } + }, + "accessPolicies": { + "$ref": "#/definitions/ServiceAccessPoliciesInfo", + "description": "The access policies of the service instance." + }, + "cosmosDbConfiguration": { + "$ref": "#/definitions/ServiceCosmosDbConfigurationInfo", + "description": "The settings for the Cosmos DB database backing the service." + }, + "authenticationConfiguration": { + "$ref": "#/definitions/ServiceAuthenticationConfigurationInfo", + "description": "The authentication configuration for the service instance." + }, + "corsConfiguration": { + "$ref": "#/definitions/ServiceCorsConfigurationInfo", + "description": "The settings for the CORS configuration of the service instance." + }, + "exportConfiguration": { + "$ref": "#/definitions/ServiceExportConfigurationInfo", + "description": "The settings for the export operation of the service instance." + }, + "privateEndpointConnections": { + "description": "The list of private endpoint connections that are set up for this resource.", + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "publicNetworkAccess": { + "description": "Control permission for data plane traffic coming from public networks while private endpoint is enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + }, + "acrConfiguration": { + "$ref": "#/definitions/ServiceAcrConfigurationInfo", + "description": "The azure container registry settings used for convert data operation of the service instance." + } + } + }, + "ServiceAccessPoliciesInfo": { + "description": "The access policies of the service instance.", + "type": "array", + "items": { + "$ref": "#/definitions/ServiceAccessPolicyEntry" + } + }, + "ServiceAccessPolicyEntry": { + "description": "An access policy entry.", + "properties": { + "objectId": { + "description": "An Azure AD object ID (User or Apps) that is allowed access to the FHIR service.", + "type": "string", + "pattern": "^(([0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}){1})+$" + } + }, + "required": [ + "objectId" + ] + }, + "ServiceCosmosDbConfigurationInfo": { + "description": "The settings for the Cosmos DB database backing the service.", + "type": "object", + "properties": { + "offerThroughput": { + "type": "integer", + "description": "The provisioned throughput for the backing database.", + "readOnly": false, + "minimum": 400, + "maximum": 10000 + }, + "keyVaultKeyUri": { + "type": "string", + "description": "The URI of the customer-managed key for the backing database.", + "readOnly": false + } + } + }, + "ServiceAuthenticationConfigurationInfo": { + "description": "Authentication configuration information", + "type": "object", + "properties": { + "authority": { + "type": "string", + "description": "The authority url for the service", + "readOnly": false + }, + "audience": { + "type": "string", + "description": "The audience url for the service", + "readOnly": false + }, + "smartProxyEnabled": { + "type": "boolean", + "description": "If the SMART on FHIR proxy is enabled", + "readOnly": false + } + } + }, + "ServiceCorsConfigurationInfo": { + "description": "The settings for the CORS configuration of the service instance.", + "type": "object", + "properties": { + "origins": { + "type": "array", + "description": "The origins to be allowed via CORS.", + "readOnly": false, + "items": { + "$ref": "#/definitions/ServiceCorsConfigurationOriginEntry" + } + }, + "headers": { + "type": "array", + "description": "The headers to be allowed via CORS.", + "readOnly": false, + "items": { + "$ref": "#/definitions/ServiceCorsConfigurationHeaderEntry" + } + }, + "methods": { + "type": "array", + "description": "The methods to be allowed via CORS.", + "readOnly": false, + "items": { + "$ref": "#/definitions/ServiceCorsConfigurationMethodEntry" + } + }, + "maxAge": { + "type": "integer", + "description": "The max age to be allowed via CORS.", + "readOnly": false, + "minimum": 0, + "maximum": 99999 + }, + "allowCredentials": { + "type": "boolean", + "description": "If credentials are allowed via CORS.", + "readOnly": false + } + } + }, + "ServiceExportConfigurationInfo": { + "description": "Export operation configuration information", + "type": "object", + "properties": { + "storageAccountName": { + "type": "string", + "description": "The name of the default export storage account.", + "readOnly": false + } + } + }, + "ServiceAcrConfigurationInfo": { + "description": "Azure container registry configuration information", + "type": "object", + "properties": { + "loginServers": { + "type": "array", + "description": "The list of the ACR login servers.", + "readOnly": false, + "items": { + "type": "string" + } + } + } + }, + "ServiceCorsConfigurationOriginEntry": { + "description": "An origin for CORS.", + "type": "string", + "pattern": "^(?:(?:(?:[hH][tT][tT][pP](?:[sS]|))\\:\\/\\/(?:[a-zA-Z0-9-]+[.]?)+(?:\\:[0-9]{1,5})?|[*]))$" + }, + "ServiceCorsConfigurationHeaderEntry": { + "description": "A header for CORS.", + "type": "string" + }, + "ServiceCorsConfigurationMethodEntry": { + "description": "A method for CORS.", + "type": "string" + }, + "ServicesDescription": { + "description": "The description of the service.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": false, + "description": "The common properties of a service.", + "$ref": "#/definitions/ServicesProperties" + }, + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ServicesResource" + } + ] + }, + "ServicesPatchDescription": { + "description": "The description of the service.", + "type": "object", + "properties": { + "tags": { + "description": "Instance tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/ServicesPropertiesUpdateParameters", + "description": "The properties for updating a service instance.", + "x-ms-client-flatten": true + } + } + }, + "ServicesResource": { + "description": "The common properties of a service.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name.", + "pattern": "^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "kind": { + "readOnly": false, + "type": "string", + "description": "The kind of the service.", + "enum": [ + "fhir", + "fhir-Stu3", + "fhir-R4" + ], + "x-ms-enum": { + "name": "kind", + "modelAsString": false + } + }, + "location": { + "type": "string", + "description": "The resource location.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + }, + "etag": { + "description": "An etag associated with the resource, used for optimistic concurrency when editing it.", + "type": "string" + }, + "identity": { + "type": "object", + "description": "Setting indicating whether the service has a managed identity associated with it.", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of the resource identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID of the resource." + }, + "type": { + "description": "Type of identity being specified, currently SystemAssigned and None are allowed.", + "type": "string", + "enum": [ + "SystemAssigned", + "None" + ], + "x-ms-enum": { + "name": "ManagedServiceIdentityType", + "modelAsString": true + } + } + } + } + }, + "x-ms-azure-resource": true, + "required": [ + "location", + "kind" + ] + }, + "ServicesDescriptionListResult": { + "description": "A list of service description objects with a next link.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of service description objects.", + "type": "string" + }, + "value": { + "description": "A list of service description objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ServicesDescription" + } + } + } + }, + "ServicesPropertiesUpdateParameters": { + "description": "The properties for updating a service instance.", + "type": "object", + "properties": { + "publicNetworkAccess": { + "description": "Control permission for data plane traffic coming from public networks while private endpoint is enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + } + } + }, + "CheckNameAvailabilityParameters": { + "description": "Input values.", + "type": "object", + "properties": { + "name": { + "description": "The name of the service instance to check.", + "type": "string" + }, + "type": { + "description": "The fully qualified resource type which includes provider namespace.", + "type": "string" + } + }, + "required": [ + "name", + "type" + ] + }, + "ServicesNameAvailabilityInfo": { + "description": "The properties indicating whether a given service name is available.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "The value which indicates whether the provided name is available.", + "type": "boolean", + "readOnly": true + }, + "reason": { + "description": "The reason for unavailability.", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ServiceNameUnavailabilityReason", + "modelAsString": false + } + }, + "message": { + "description": "The detailed reason message.", + "type": "string" + } + } + }, + "PrivateEndpointConnectionDescription": { + "properties": { + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + } + ], + "description": "The Private Endpoint Connection resource." + }, + "PrivateLinkResourceDescription": { + "properties": { + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateLinkResource" + } + ], + "description": "The Private Endpoint Connection resource." + }, + "PrivateEndpointConnectionListResultDescription": { + "properties": { + "value": { + "type": "array", + "description": "Array of private endpoint connections", + "items": { + "$ref": "#/definitions/PrivateEndpointConnectionDescription" + } + } + }, + "description": "List of private endpoint connection associated with the specified storage account" + }, + "PrivateLinkResourceListResultDescription": { + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResourceDescription" + } + } + }, + "description": "A list of private link resources" + }, + "Error": { + "description": "Error details.", + "type": "object", + "properties": { + "error": { + "description": "Error details", + "$ref": "#/definitions/ErrorDetailsInternal" + } + } + }, + "ErrorDetails": { + "description": "Error details.", + "type": "object", + "properties": { + "error": { + "description": "Error details", + "$ref": "#/definitions/ErrorDetailsInternal" + } + } + }, + "ErrorDetailsInternal": { + "description": "Error details.", + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "The target of the particular error.", + "type": "string", + "readOnly": true + } + } + }, + "ListOperations": { + "description": "Available operations of the service", + "type": "object", + "properties": { + "value": { + "description": "Collection of available operation details", + "uniqueItems": false, + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OperationDetail" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "OperationDetail": { + "description": "Service REST API operation.", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation", + "type": "string", + "readOnly": true + }, + "isDataAction": { + "description": "Whether the operation applies to data-plane. This is \"true\" for data-plane operations and \"false\" for ARM/control-plane operations.", + "type": "boolean", + "readOnly": true + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "Display of the operation" + }, + "origin": { + "readOnly": true, + "type": "string", + "description": "Default value is 'user,system'." + }, + "actionType": { + "description": "Enum. Indicates the action type. \"Internal\" refers to actions that are for internal only APIs.", + "type": "string", + "readOnly": true, + "enum": [ + "Internal" + ], + "x-ms-enum": { + "name": "ActionType", + "modelAsString": true + } + } + } + }, + "OperationDisplay": { + "description": "The object that represents the operation.", + "type": "object", + "properties": { + "provider": { + "readOnly": true, + "type": "string", + "description": "Service provider: Microsoft.HealthcareApis" + }, + "resource": { + "readOnly": true, + "type": "string", + "description": "Resource Type: Services" + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "Name of the operation" + }, + "description": { + "readOnly": true, + "type": "string", + "description": "Friendly description for the operation," + } + } + }, + "OperationResultsDescription": { + "description": "The properties indicating the operation result of an operation on a service.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the operation returned.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the operation result.", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "The status of the operation being performed.", + "enum": [ + "Canceled", + "Succeeded", + "Failed", + "Requested", + "Running" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "name": "OperationResultStatus", + "modelAsString": true + } + }, + "startTime": { + "description": "The time that the operation was started.", + "readOnly": true, + "type": "string" + }, + "properties": { + "x-ms-client-flatten": false, + "description": "Additional properties of the operation result.", + "type": "object" + } + } + }, + "ProvisioningState": { + "description": "The provisioning state.", + "enum": [ + "Deleting", + "Succeeded", + "Creating", + "Accepted", + "Verifying", + "Updating", + "Failed", + "Canceled", + "Deprovisioned", + "Moving", + "Suspended", + "Warned", + "SystemMaintenance" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "ResourceTags": { + "type": "object", + "description": "List of key value pairs that describe the resource. This will overwrite the existing tags.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + } + } + }, + "ResourceCore": { + "type": "object", + "description": "The common properties for any resource, tracked or proxy.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name.", + "pattern": "^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "etag": { + "description": "An etag associated with the resource, used for optimistic concurrency when editing it.", + "type": "string" + } + }, + "x-ms-azure-resource": true + }, + "LocationBasedResource": { + "type": "object", + "description": "The common properties for any location based resource, tracked or proxy.", + "allOf": [ + { + "$ref": "#/definitions/ResourceCore" + } + ], + "properties": { + "location": { + "type": "string", + "description": "The resource location.", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "x-ms-azure-resource": true + }, + "TaggedResource": { + "type": "object", + "description": "The common properties of tracked resources in the service.", + "allOf": [ + { + "$ref": "#/definitions/ResourceTags" + }, + { + "$ref": "#/definitions/LocationBasedResource" + } + ], + "x-ms-azure-resource": true + }, + "ServiceManagedIdentity": { + "type": "object", + "description": "The managed identity of a service.", + "properties": { + "identity": { + "type": "object", + "description": "Setting indicating whether the service has a managed identity associated with it.", + "properties": { + "type": { + "description": "Type of identity being specified, currently SystemAssigned and None are allowed.", + "type": "string", + "enum": [ + "SystemAssigned", + "None" + ], + "x-ms-enum": { + "name": "ManagedServiceIdentityType", + "modelAsString": true + } + } + } + } + } + }, + "Workspace": { + "type": "object", + "description": "Workspace resource.", + "allOf": [ + { + "$ref": "#/definitions/TaggedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": false, + "description": "Workspaces resource specific properties.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "provisioningState": { + "description": "The provisioning state.", + "$ref": "#/definitions/ProvisioningState" + } + } + }, + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" + } + } + }, + "WorkspacePatchResource": { + "type": "object", + "description": "Workspace patch properties", + "allOf": [ + { + "$ref": "#/definitions/ResourceTags" + } + ] + }, + "WorkspaceList": { + "description": "Collection of workspace object with a next link", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page.", + "type": "string" + }, + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Workspace" + } + } + } + }, + "DicomService": { + "type": "object", + "description": "The description of Dicom Service", + "allOf": [ + { + "$ref": "#/definitions/TaggedResource" + } + ], + "properties": { + "properties": { + "description": "Dicom Service configuration.", + "$ref": "#/definitions/DicomServiceProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" + } + } + }, + "DicomServicePatchResource": { + "type": "object", + "description": "Dicom Service patch properties", + "allOf": [ + { + "$ref": "#/definitions/ResourceTags" + } + ] + }, + "DicomServiceCollection": { + "description": "The collection of Dicom Services.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of Dicom Services.", + "type": "string" + }, + "value": { + "description": "The list of Dicom Services.", + "type": "array", + "items": { + "$ref": "#/definitions/DicomService" + } + } + } + }, + "DicomServiceProperties": { + "description": "Dicom Service properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state.", + "$ref": "#/definitions/ProvisioningState" + }, + "authenticationConfiguration": { + "description": "Dicom Service authentication configuration.", + "$ref": "#/definitions/DicomServiceAuthenticationConfiguration" + }, + "serviceUrl": { + "description": "The url of the Dicom Services.", + "type": "string", + "readOnly": true + } + } + }, + "DicomServiceAuthenticationConfiguration": { + "description": "Authentication configuration information", + "type": "object", + "properties": { + "authority": { + "type": "string", + "description": "The authority url for the service", + "readOnly": true + }, + "audiences": { + "type": "array", + "description": "The audiences for the service", + "items": { + "$ref": "#/definitions/DicomAudience" + }, + "readOnly": true + } + } + }, + "DicomAudience": { + "description": "The audience for Dicom Service", + "type": "string", + "readOnly": true + }, + "IotConnector": { + "type": "object", + "description": "IoT Connector definition.", + "allOf": [ + { + "$ref": "#/definitions/TaggedResource" + }, + { + "$ref": "#/definitions/ServiceManagedIdentity" + } + ], + "properties": { + "properties": { + "description": "IoT Connector configuration.", + "$ref": "#/definitions/IotConnectorProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" + } + } + }, + "IotConnectorPatchResource": { + "type": "object", + "description": "Iot Connector patch properties", + "allOf": [ + { + "$ref": "#/definitions/ResourceTags" + }, + { + "$ref": "#/definitions/ServiceManagedIdentity" + } + ] + }, + "IotConnectorCollection": { + "description": "A collection of IoT Connectors.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of IoT Connectors.", + "type": "string" + }, + "value": { + "description": "The list of IoT Connectors.", + "type": "array", + "items": { + "$ref": "#/definitions/IotConnector" + } + } + } + }, + "IotConnectorProperties": { + "description": "IoT Connector properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state.", + "$ref": "#/definitions/ProvisioningState" + }, + "ingestionEndpointConfiguration": { + "description": "Source configuration.", + "$ref": "#/definitions/IotEventHubIngestionEndpointConfiguration" + }, + "deviceMapping": { + "description": "Device Mappings.", + "$ref": "#/definitions/IotMappingProperties" + } + } + }, + "IotEventHubIngestionEndpointConfiguration": { + "type": "object", + "properties": { + "eventHubName": { + "type": "string", + "description": "Event Hub name to connect to." + }, + "consumerGroup": { + "type": "string", + "description": "Consumer group of the event hub to connected to." + }, + "fullyQualifiedEventHubNamespace": { + "type": "string", + "description": "Fully qualified namespace of the Event Hub to connect to." + } + }, + "description": "Event Hub ingestion endpoint configuration" + }, + "IotMappingProperties": { + "description": "The mapping content.", + "type": "object", + "properties": { + "content": { + "description": "The mapping.", + "type": "object" + } + } + }, + "IotIdentityResolutionType": { + "description": "The type of IoT identity resolution to use with the destination.", + "enum": [ + "Create", + "Lookup" + ], + "type": "string", + "x-ms-enum": { + "name": "IotIdentityResolutionType", + "modelAsString": true + } + }, + "IotDestinationProperties": { + "type": "object", + "description": "Common IoT Connector destination properties.", + "properties": { + "provisioningState": { + "description": "The provisioning state.", + "$ref": "#/definitions/ProvisioningState", + "x-ms-client-flatten": true + } + } + }, + "IotFhirDestinationProperties": { + "required": [ + "resourceIdentityResolutionType", + "fhirServiceResourceId", + "fhirMapping" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IotDestinationProperties" + } + ], + "description": "IoT Connector destination properties for an Azure FHIR service.", + "properties": { + "resourceIdentityResolutionType": { + "description": "Determines how resource identity is resolved on the destination.", + "$ref": "#/definitions/IotIdentityResolutionType" + }, + "fhirServiceResourceId": { + "type": "string", + "description": "Fully qualified resource id of the FHIR service to connect to." + }, + "fhirMapping": { + "description": "FHIR Mappings", + "$ref": "#/definitions/IotMappingProperties" + } + } + }, + "IotFhirDestination": { + "required": [ + "properties" + ], + "type": "object", + "description": "IoT Connector FHIR destination definition.", + "allOf": [ + { + "$ref": "#/definitions/LocationBasedResource" + } + ], + "properties": { + "properties": { + "description": "IoT FHIR Destination settings.", + "$ref": "#/definitions/IotFhirDestinationProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" + } + } + }, + "IotFhirDestinationCollection": { + "description": "A collection of IoT Connector FHIR destinations.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of IoT FHIR destinations.", + "type": "string" + }, + "value": { + "description": "The list of IoT Connector FHIR destinations.", + "type": "array", + "items": { + "$ref": "#/definitions/IotFhirDestination" + } + } + } + }, + "FhirServiceCollection": { + "description": "A collection of Fhir services.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of Fhir Services.", + "type": "string" + }, + "value": { + "description": "The list of Fhir Services.", + "type": "array", + "items": { + "$ref": "#/definitions/FhirService" + } + } + } + }, + "FhirService": { + "type": "object", + "description": "The description of Fhir Service", + "allOf": [ + { + "$ref": "#/definitions/TaggedResource" + }, + { + "$ref": "#/definitions/ServiceManagedIdentity" + } + ], + "properties": { + "kind": { + "readOnly": false, + "type": "string", + "description": "The kind of the service.", + "enum": [ + "fhir-Stu3", + "fhir-R4" + ], + "x-ms-enum": { + "name": "fhirServiceKind", + "modelAsString": true + } + }, + "properties": { + "description": "Fhir Service configuration.", + "$ref": "#/definitions/FhirServiceProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" + } + } + }, + "FhirServicePatchResource": { + "type": "object", + "description": "FhirService patch properties", + "allOf": [ + { + "$ref": "#/definitions/ResourceTags" + }, + { + "$ref": "#/definitions/ServiceManagedIdentity" + } + ] + }, + "FhirServiceProperties": { + "description": "Fhir Service properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state.", + "$ref": "#/definitions/ProvisioningState" + }, + "accessPolicies": { + "description": "Fhir Service access policies.", + "$ref": "#/definitions/FhirServiceAccessPolicies" + }, + "acrConfiguration": { + "description": "Fhir Service Azure container registry configuration.", + "$ref": "#/definitions/FhirServiceAcrConfiguration" + }, + "authenticationConfiguration": { + "description": "Fhir Service authentication configuration.", + "$ref": "#/definitions/FhirServiceAuthenticationConfiguration" + }, + "corsConfiguration": { + "description": "Fhir Service Cors configuration.", + "$ref": "#/definitions/FhirServiceCorsConfiguration" + }, + "exportConfiguration": { + "description": "Fhir Service export configuration.", + "$ref": "#/definitions/FhirServiceExportConfiguration" + } + } + }, + "FhirServiceAccessPolicies": { + "description": "The access policies of the service instance.", + "type": "array", + "items": { + "$ref": "#/definitions/FhirServiceAccessPolicyEntry" + } + }, + "FhirServiceAccessPolicyEntry": { + "type": "object", + "description": "An access policy entry.", + "properties": { + "objectId": { + "description": "An Azure AD object ID (User or Apps) that is allowed access to the FHIR service.", + "type": "string", + "pattern": "^(([0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}){1})+$" + } + }, + "required": [ + "objectId" + ] + }, + "FhirServiceAcrConfiguration": { + "description": "Azure container registry configuration information", + "type": "object", + "properties": { + "loginServers": { + "type": "array", + "description": "The list of the Azure container registry login servers.", + "readOnly": false, + "items": { + "type": "string" + } + } + } + }, + "FhirServiceAuthenticationConfiguration": { + "description": "Authentication configuration information", + "type": "object", + "properties": { + "authority": { + "type": "string", + "description": "The authority url for the service", + "readOnly": false + }, + "audience": { + "type": "string", + "description": "The audience url for the service", + "readOnly": false + }, + "smartProxyEnabled": { + "type": "boolean", + "description": "If the SMART on FHIR proxy is enabled", + "readOnly": false + } + } + }, + "FhirServiceCorsConfiguration": { + "description": "The settings for the CORS configuration of the service instance.", + "type": "object", + "properties": { + "origins": { + "type": "array", + "description": "The origins to be allowed via CORS.", + "readOnly": false, + "items": { + "$ref": "#/definitions/CorsConfigurationOriginEntry" + } + }, + "headers": { + "type": "array", + "description": "The headers to be allowed via CORS.", + "readOnly": false, + "items": { + "$ref": "#/definitions/CorsConfigurationHeaderEntry" + } + }, + "methods": { + "type": "array", + "description": "The methods to be allowed via CORS.", + "readOnly": false, + "items": { + "$ref": "#/definitions/CorsConfigurationMethodEntry" + } + }, + "maxAge": { + "type": "integer", + "format": "int32", + "description": "The max age to be allowed via CORS.", + "readOnly": false, + "minimum": 0, + "maximum": 99999 + }, + "allowCredentials": { + "type": "boolean", + "description": "If credentials are allowed via CORS.", + "readOnly": false + } + } + }, + "CorsConfigurationOriginEntry": { + "description": "An origin for CORS.", + "type": "string", + "pattern": "^(?:(?:(?:[hH][tT][tT][pP](?:[sS]|))\\:\\/\\/(?:[a-zA-Z0-9-]+[.]?)+(?:\\:[0-9]{1,5})?|[*]))$" + }, + "CorsConfigurationHeaderEntry": { + "description": "A header for CORS.", + "type": "string" + }, + "CorsConfigurationMethodEntry": { + "description": "A method for CORS.", + "type": "string" + }, + "FhirServiceExportConfiguration": { + "description": "Export operation configuration information", + "type": "object", + "properties": { + "storageAccountName": { + "type": "string", + "description": "The name of the default export storage account.", + "readOnly": false + } + } + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription identifier.", + "required": true, + "type": "string" + }, + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the service instance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + "locationName": { + "name": "locationName", + "in": "path", + "description": "The location of the operation.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "operationResultId": { + "name": "operationResultId", + "in": "path", + "description": "The ID of the operation result to get.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "workspaceName": { + "name": "workspaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of workspace resource.", + "x-ms-parameter-location": "method", + "minLength": 3, + "maxLength": 24 + }, + "dicomServiceName": { + "name": "dicomServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of DICOM Service resource.", + "x-ms-parameter-location": "method", + "minLength": 3, + "maxLength": 24 + }, + "iotConnectorName": { + "name": "iotConnectorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of IoT Connector resource.", + "x-ms-parameter-location": "method", + "minLength": 3, + "maxLength": 24 + }, + "fhirDestinationName": { + "name": "fhirDestinationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of IoT Connector FHIR destination resource.", + "x-ms-parameter-location": "method", + "minLength": 3, + "maxLength": 24 + }, + "fhirServiceName": { + "name": "fhirServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of FHIR Service resource.", + "x-ms-parameter-location": "method", + "minLength": 3, + "maxLength": 24 + }, + "resourceName": { + "name": "resourceName", + "in": "path", + "description": "The name of the service instance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "minLength": 3, + "maxLength": 24 + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } +} diff --git a/specification/healthcareapis/resource-manager/readme.md b/specification/healthcareapis/resource-manager/readme.md index a4385e2dff98..4f545ae574d7 100644 --- a/specification/healthcareapis/resource-manager/readme.md +++ b/specification/healthcareapis/resource-manager/readme.md @@ -28,19 +28,28 @@ These are the global settings for HealthcareApis service. title: HealthcareApisManagementClient description: Azure Healthcare APIs Client openapi-type: arm -tag: package-2021-01 +tag: package-preview-2021-06 azure-arm: true ``` +### Tag: package-preview-2021-06 + +These settings apply only when `--tag=package-preview-2021-06` is specified on the command line. + +```yaml $(tag) == 'package-preview-2021-06' +input-file: + - Microsoft.HealthcareApis/preview/2021-06-01-preview/healthcare-apis.json +``` ### Tag: package-2021-01 These settings apply only when `--tag=package-2021-01` is specified on the command line. -```yaml $(tag) == 'package-2021-01' +``` yaml $(tag) == 'package-2021-01' input-file: - Microsoft.HealthcareApis/stable/2021-01-11/healthcare-apis.json ``` + ### Tag: package-2020-03-30 These settings apply only when `--tag=package-2020-03-30` is specified on the command line. @@ -87,7 +96,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go @@ -125,5 +133,3 @@ See configuration in [readme.go.md](./readme.go.md) ## Java See configuration in [readme.java.md](./readme.java.md) - - diff --git a/specification/healthcareapis/resource-manager/readme.python.md b/specification/healthcareapis/resource-manager/readme.python.md index b33f50d11c85..fff0f012ba04 100644 --- a/specification/healthcareapis/resource-manager/readme.python.md +++ b/specification/healthcareapis/resource-manager/readme.python.md @@ -4,36 +4,15 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.healthcareapis - package-name: azure-mgmt-healthcareapis - clear-output-folder: true - package-version: 0.1.0 -``` ``` yaml $(python) && $(track2) -python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.healthcareapis package-name: azure-mgmt-healthcareapis clear-output-folder: true -package-version: 0.1.0 -``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/healthcareapis/azure-mgmt-healthcareapis/azure/mgmt/healthcareapis -``` -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/healthcareapis/azure-mgmt-healthcareapis +package-version: 1.0.0b1 ``` + ``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/healthcareapis/azure-mgmt-healthcareapis/azure/mgmt/healthcareapis diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/HybridCompute.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/HybridCompute.json new file mode 100644 index 000000000000..40b028a62848 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/HybridCompute.json @@ -0,0 +1,1202 @@ +{ + "swagger": "2.0", + "info": { + "title": "HybridComputeManagementClient", + "description": "The Hybrid Compute Management Client.", + "version": "2021-05-17-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.HybridCompute/machines/{machineName}": { + "put": { + "tags": [ + "machines" + ], + "operationId": "Machines_CreateOrUpdate", + "description": "The operation to create or update a hybrid machine resource identity in Azure.", + "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" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the hybrid machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Machine" + }, + "description": "Parameters supplied to the Create hybrid machine operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Machine" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update a Machine": { + "$ref": "./examples/Machines_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "machines" + ], + "operationId": "Machines_Update", + "description": "The operation to update a hybrid machine.", + "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" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the hybrid machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MachineUpdate" + }, + "description": "Parameters supplied to the Update hybrid machine operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Machine" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update a Machine": { + "$ref": "./examples/Machines_Update.json" + } + } + }, + "delete": { + "tags": [ + "machines" + ], + "operationId": "Machines_Delete", + "description": "The operation to remove a hybrid machine identity in Azure.", + "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" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the hybrid machine." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a Machine": { + "$ref": "./examples/Machines_Delete.json" + } + } + }, + "get": { + "tags": [ + "machines" + ], + "operationId": "Machines_Get", + "description": "Retrieves information about the model view or the instance view of a hybrid machine.", + "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" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the hybrid machine." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation.", + "enum": [ + "instanceView" + ], + "x-ms-enum": { + "name": "InstanceViewTypes", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Machine" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Machine": { + "$ref": "./examples/Machines_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines": { + "get": { + "tags": [ + "machines" + ], + "operationId": "Machines_ListByResourceGroup", + "description": "Lists all the hybrid machines in the specified resource group. Use the nextLink property in the response to get the next page of hybrid machines.", + "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" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Machines by resource group": { + "$ref": "./examples/Machines_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/machines": { + "get": { + "tags": [ + "machines" + ], + "operationId": "Machines_ListBySubscription", + "description": "Lists all the hybrid machines in the specified subscription. Use the nextLink property in the response to get the next page of hybrid machines.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Machines by resource group": { + "$ref": "./examples/Machines_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions/{extensionName}": { + "put": { + "tags": [ + "MachineExtensions" + ], + "operationId": "MachineExtensions_CreateOrUpdate", + "description": "The operation to create or update the extension.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the machine where the extension should be created or updated." + }, + { + "name": "extensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MachineExtension" + }, + "description": "Parameters supplied to the Create Machine Extension operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineExtension" + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update a Machine Extension": { + "$ref": "./examples/PUTExtension.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "MachineExtensions" + ], + "operationId": "MachineExtensions_Update", + "description": "The operation to create or update the extension.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the machine where the extension should be created or updated." + }, + { + "name": "extensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MachineExtensionUpdate" + }, + "description": "Parameters supplied to the Create Machine Extension operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineExtension" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update a Machine Extension": { + "$ref": "./examples/UpdateExtension.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "MachineExtensions" + ], + "operationId": "MachineExtensions_Delete", + "description": "The operation to delete the extension.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the machine where the extension should be deleted." + }, + { + "name": "extensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the machine extension." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.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/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a Machine Extension": { + "$ref": "./examples/DELETEExtension.json" + } + } + }, + "get": { + "tags": [ + "MachineExtensions" + ], + "operationId": "MachineExtensions_Get", + "description": "The operation to get the extension.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the machine containing the extension." + }, + { + "name": "extensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the machine extension." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineExtension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GET Machine Extension": { + "$ref": "./examples/GETExtension.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions": { + "get": { + "tags": [ + "MachineExtensions" + ], + "operationId": "MachineExtensions_List", + "description": "The operation to get all extensions of a non-Azure machine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the machine containing the extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineExtensionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GET all Machine Extensions": { + "$ref": "./examples/LISTExtension.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/upgradeExtensions": { + "post": { + "tags": [ + "MachineExtensions Upgrade" + ], + "operationId": "UpgradeExtensions", + "description": "The operation to Upgrade Machine Extensions.", + "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" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the hybrid machine." + }, + { + "name": "extensionUpgradeParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MachineExtensionUpgrade" + }, + "description": "Parameters supplied to the Upgrade Extensions operation." + } + ], + "responses": { + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Upgrade Machine Extensions": { + "$ref": "./examples/Extensions_Upgrade.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/providers/Microsoft.HybridCompute/operations": { + "get": { + "tags": [ + "operations" + ], + "operationId": "Operations_List", + "description": "Gets a list of hybrid compute operations.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + } + }, + "definitions": { + "OperationListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OperationValue" + }, + "description": "The list of compute operations" + } + }, + "description": "The List Compute Operation operation response." + }, + "OperationValue": { + "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": { + "$ref": "#/definitions/OperationValueDisplay", + "description": "Display properties" + } + }, + "description": "Describes the properties of a Compute Operation value." + }, + "OperationValueDisplay": { + "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 Hybrid Compute Operation Value Display." + }, + "OSProfile": { + "readOnly": true, + "properties": { + "computerName": { + "type": "string", + "readOnly": true, + "description": "Specifies the host OS name of the hybrid machine." + } + }, + "description": "Specifies the operating system settings for the hybrid machine." + }, + "DetectedProperties": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Detected properties from the machine." + }, + "MachineProperties": { + "properties": { + "locationData": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/locationData" + }, + "osProfile": { + "$ref": "#/definitions/OSProfile", + "description": "Specifies the operating system settings for the hybrid machine." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "status": { + "readOnly": true, + "type": "string", + "description": "The status of the hybrid machine agent.", + "enum": [ + "Connected", + "Disconnected", + "Error" + ], + "x-ms-enum": { + "name": "StatusTypes", + "modelAsString": true + } + }, + "lastStatusChange": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time of the last status change." + }, + "errorDetails": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorDetail" + }, + "description": "Details about the error state." + }, + "agentVersion": { + "readOnly": true, + "type": "string", + "description": "The hybrid machine agent full version." + }, + "vmId": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Specifies the hybrid machine unique ID." + }, + "displayName": { + "readOnly": true, + "type": "string", + "description": "Specifies the hybrid machine display name." + }, + "machineFqdn": { + "readOnly": true, + "type": "string", + "description": "Specifies the hybrid machine FQDN." + }, + "clientPublicKey": { + "type": "string", + "description": "Public Key that the client provides to be used during initial resource onboarding" + }, + "osName": { + "readOnly": true, + "type": "string", + "description": "The Operating System running on the hybrid machine." + }, + "osVersion": { + "readOnly": true, + "type": "string", + "description": "The version of Operating System running on the hybrid machine." + }, + "vmUuid": { + "readOnly": true, + "type": "string", + "description": "Specifies the Arc Machine's unique SMBIOS ID" + }, + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/MachineExtensionInstanceView" + }, + "description": "Machine Extensions information" + }, + "osSku": { + "readOnly": true, + "type": "string", + "description": "Specifies the Operating System product SKU." + }, + "domainName": { + "readOnly": true, + "type": "string", + "description": "Specifies the Windows domain name." + }, + "adFqdn": { + "readOnly": true, + "type": "string", + "description": "Specifies the AD fully qualified display name." + }, + "dnsFqdn": { + "readOnly": true, + "type": "string", + "description": "Specifies the DNS fully qualified display name." + }, + "privateLinkScopeResourceId": { + "type": "string", + "description": "The resource id of the private link scope this machine is assigned to, if any." + }, + "parentClusterResourceId": { + "type": "string", + "description": "The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any." + }, + "detectedProperties": { + "$ref": "#/definitions/DetectedProperties", + "description": "Detected properties from the machine." + } + }, + "description": "Describes the properties of a hybrid machine." + }, + "MachineUpdateProperties": { + "properties": { + "locationData": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/locationData" + }, + "parentClusterResourceId": { + "type": "string", + "description": "The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any." + }, + "privateLinkScopeResourceId": { + "type": "string", + "description": "The resource id of the private link scope this machine is assigned to, if any." + } + }, + "description": "Describes the ARM updatable properties of a hybrid machine." + }, + "Machine": { + "properties": { + "properties": { + "$ref": "#/definitions/MachineProperties", + "description": "Hybrid Compute Machine properties" + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Identity" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "description": "Describes a hybrid machine." + }, + "MachineUpdate": { + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Identity" + }, + "properties": { + "$ref": "#/definitions/MachineUpdateProperties", + "description": "Hybrid Compute Machine properties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceUpdate" + } + ], + "description": "Describes a hybrid machine Update." + }, + "MachineListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Machine" + }, + "description": "The list of hybrid machines." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of Machines. Call ListNext() with this URI to fetch the next page of hybrid machines." + } + }, + "required": [ + "value" + ], + "description": "The List hybrid machine operation response." + }, + "ResourceUpdate": { + "description": "The Update Resource model definition.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + } + }, + "MachineExtension": { + "properties": { + "properties": { + "$ref": "#/definitions/MachineExtensionProperties", + "description": "Describes Machine Extension Properties." + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "description": "Describes a Machine Extension." + }, + "MachineExtensionUpdate": { + "properties": { + "properties": { + "$ref": "#/definitions/MachineExtensionUpdateProperties", + "description": "Describes Machine Extension Update Properties." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceUpdate" + } + ], + "description": "Describes a Machine Extension Update." + }, + "MachineExtensionProperties": { + "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." + }, + "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/MachineExtensionInstanceView", + "description": "The machine extension instance view." + } + }, + "description": "Describes the properties of a Machine Extension." + }, + "MachineExtensionUpdateProperties": { + "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." + }, + "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." + } + }, + "description": "Describes the properties of a Machine Extension." + }, + "MachineExtensionInstanceView": { + "properties": { + "name": { + "type": "string", + "description": "The 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." + }, + "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." + } + }, + "description": "Instance view status." + } + }, + "description": "Describes the Machine Extension Instance View." + }, + "MachineExtensionsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MachineExtension" + }, + "description": "The list of extensions" + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of machine extensions. Call ListNext() with this to fetch the next page of extensions." + } + }, + "description": "Describes the Machine Extensions List Result." + }, + "TargetVersion": { + "type": "string", + "description": "Extension Upgrade Target Version." + }, + "ExtensionTargetProperties": { + "properties": { + "targetVersion": { + "type": "object", + "$ref": "#/definitions/TargetVersion", + "description": "Properties for the specified Extension to Upgrade." + } + }, + "description": "Describes the Machine Extension Target Version Properties" + }, + "ExtensionTarget": { + "additionalProperties": { + "type": "object", + "$ref": "#/definitions/ExtensionTargetProperties" + }, + "description": "Describes the Machine Extension Target Properties" + }, + "MachineExtensionUpgrade": { + "properties": { + "extensionTargets": { + "$ref": "#/definitions/ExtensionTarget", + "description": "Describes the Extension Target Properties." + } + }, + "description": "Describes the Machine Extension Upgrade Properties" + } + }, + "parameters": {} +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/DELETEExtension.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/DELETEExtension.json new file mode 100644 index 000000000000..7874e53eaf97 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/DELETEExtension.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "extensionName": "MMA", + "api-version": "2021-05-17-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/Extensions_Upgrade.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/Extensions_Upgrade.json new file mode 100644 index 000000000000..a273dc5efe58 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/Extensions_Upgrade.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "api-version": "2021-05-17-preview", + "extensionUpgradeParameters": { + "extensionTargets": { + "Microsoft.Compute.CustomScriptExtension": { + "targetVersion": "1.10" + }, + "Microsoft.Azure.Monitoring": { + "targetVersion": "2.0" + } + } + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/GETExtension.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/GETExtension.json new file mode 100644 index 000000000000..8f1c5c4e44f1 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/GETExtension.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "extensionName": "CustomScriptExtension", + "api-version": "2021-05-17-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/Extensions/CustomScriptExtension", + "name": "CustomScriptExtension", + "type": "Microsoft.HybridCompute/machines/extensions", + "location": "eastus2euap", + "properties": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10.3", + "autoUpgradeMinorVersion": false, + "settings": "@{commandToExecute=powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"}", + "protectedSettings": {}, + "provisioningState": "Succeeded", + "instanceView": { + "name": "CustomScriptExtension", + "type": "CustomScriptExtension", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "success", + "level": "Information", + "displayStatus": "Provisioning succeeded", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/LISTExtension.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/LISTExtension.json new file mode 100644 index 000000000000..95a4b7771930 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/LISTExtension.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "api-version": "2021-05-17-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/Extensions/CustomScriptExtension", + "name": "CustomScriptExtension", + "location": "eastus2euap", + "type": "Microsoft.HybridCompute/machines/extensions", + "properties": { + "publisher": "Microsoft.Compute", + "type": "CustomScriptExtension", + "typeHandlerVersion": "1.10.3", + "autoUpgradeMinorVersion": false, + "settings": { + "commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"" + }, + "provisioningState": "Succeeded", + "instanceView": { + "name": "CustomScriptExtension", + "type": "CustomScriptExtension", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "success", + "level": "Information", + "displayStatus": "Provisioning succeeded", + "message": "formattedMessage: Finished executing command, StdOut: , StdErr: ", + "time": "2020-08-13T17:18:57.405Z" + } + } + } + }, + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/Extensions/winosupdateextension", + "name": "winosupdateextension", + "location": "eastus2euap", + "type": "Microsoft.HybridCompute/machines/extensions", + "properties": { + "publisher": "microsoft.softwareupdatemanagement.test", + "type": "windowsosupdateextension", + "typeHandlerVersion": "1.0.0.0", + "autoUpgradeMinorVersion": false, + "settings": {}, + "provisioningState": "Creating", + "instanceView": { + "name": "winosupdateextension", + "type": "windowsosupdateextension", + "typeHandlerVersion": "1.0.0.0", + "status": {} + } + } + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/Machines_CreateOrUpdate.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/Machines_CreateOrUpdate.json new file mode 100644 index 000000000000..7f409f35329f --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/Machines_CreateOrUpdate.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "api-version": "2021-05-17-preview", + "parameters": { + "location": "eastus2euap", + "properties": { + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond" + }, + "clientPublicKey": "string", + "parentClusterResourceId": "{AzureStackHCIResourceId}", + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine", + "name": "myMachine", + "location": "eastus2euap", + "tags": null, + "identity": { + "type": "SystemAssigned", + "principalId": "string", + "tenantId": "string" + }, + "type": "Microsoft.HybridCompute/machines", + "properties": { + "provisioningState": "Succeeded", + "agentVersion": null, + "status": null, + "lastStatusChange": null, + "errorDetails": null, + "displayName": null, + "machineFqdn": null, + "vmUuid": null, + "osSku": null, + "domainName": null, + "adFqdn": null, + "dnsFqdn": null, + "osName": null, + "osVersion": null, + "osProfile": { + "computerName": null + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond", + "city": "redmond", + "district": null, + "countryOrRegion": "usa" + }, + "clientPublicKey": "string", + "parentClusterResourceId": "{AzureStackHCIResourceId}", + "detectedProperties": { + "cloudprovider": "N/A", + "manufacturer": "Microsoft Corporation", + "model": "Virtual Machine", + "mssqldiscovered": "false" + }, + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/Machines_Delete.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/Machines_Delete.json new file mode 100644 index 000000000000..058ce324b431 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/Machines_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "api-version": "2021-05-17-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/Machines_Get.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/Machines_Get.json new file mode 100644 index 000000000000..330755d7e657 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/Machines_Get.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "api-version": "2021-05-17-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine", + "name": "myMachine", + "location": "eastus2euap", + "tags": null, + "identity": { + "type": "SystemAssigned", + "principalId": "string", + "tenantId": "string" + }, + "type": "Microsoft.HybridCompute/machines", + "properties": { + "provisioningState": "Succeeded", + "agentVersion": null, + "status": null, + "lastStatusChange": null, + "errorDetails": null, + "displayName": null, + "machineFqdn": null, + "vmUuid": null, + "osSku": null, + "domainName": null, + "adFqdn": null, + "dnsFqdn": null, + "osName": null, + "osVersion": null, + "osProfile": { + "computerName": null + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond", + "city": "redmond", + "district": null, + "countryOrRegion": "usa" + }, + "clientPublicKey": "string", + "parentClusterResourceId": "{AzureStackHCIResourceId}", + "detectedProperties": { + "cloudprovider": "N/A", + "manufacturer": "Microsoft Corporation", + "model": "Virtual Machine", + "mssqldiscovered": "false" + }, + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/Machines_ListByResourceGroup.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/Machines_ListByResourceGroup.json new file mode 100644 index 000000000000..9731122f1df6 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/Machines_ListByResourceGroup.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-05-17-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine", + "name": "myMachine", + "location": "eastus2euap", + "tags": null, + "identity": { + "type": "SystemAssigned", + "principalId": "f7a068cc-b0b8-46e8-a203-22f301a62a8f", + "tenantId": "c4098cc-91b8-46c2-a205-d82ab1a62a8f" + }, + "type": "Microsoft.HybridCompute/machines", + "properties": { + "provisioningState": "Succeeded", + "agentVersion": null, + "status": null, + "lastStatusChange": null, + "errorDetails": null, + "displayName": null, + "machineFqdn": null, + "vmUuid": null, + "osSku": null, + "domainName": null, + "adFqdn": null, + "dnsFqdn": null, + "osName": null, + "osVersion": null, + "osProfile": { + "computerName": null + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond" + }, + "clientPublicKey": "string", + "parentClusterResourceId": null, + "detectedProperties": { + "cloudprovider": "N/A", + "manufacturer": "Microsoft Corporation", + "model": "Virtual Machine", + "mssqldiscovered": "false" + }, + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" + } + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine2", + "name": "myMachine2", + "location": "westus2", + "tags": null, + "identity": { + "type": "SystemAssigned", + "principalId": "e7a068cc-b0b8-46e8-a203-22f301a62a8f", + "tenantId": "c4098cc-91b8-46c2-a205-d82ab1a62a8f" + }, + "type": "Microsoft.HybridCompute/machines", + "properties": { + "provisioningState": "Succeeded", + "agentVersion": null, + "status": null, + "lastStatusChange": null, + "errorDetails": null, + "displayName": null, + "machineFqdn": null, + "osName": null, + "osVersion": null, + "osProfile": { + "computerName": null + }, + "vmId": "a4a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond" + }, + "clientPublicKey": "string", + "parentClusterResourceId": "{AzureStackHCIResourceId}", + "detectedProperties": { + "cloudprovider": "N/A", + "manufacturer": "Microsoft Corporation", + "model": "Surfacebook", + "mssqldiscovered": "true" + }, + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/Machines_ListBySubscription.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/Machines_ListBySubscription.json new file mode 100644 index 000000000000..3507847f2cc0 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/Machines_ListBySubscription.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2021-05-17-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine", + "name": "myMachine", + "location": "eastus2euap", + "tags": null, + "identity": { + "type": "SystemAssigned", + "principalId": "string", + "tenantId": "string" + }, + "type": "Microsoft.HybridCompute/machines", + "properties": { + "provisioningState": "Succeeded", + "agentVersion": null, + "status": null, + "lastStatusChange": null, + "errorDetails": null, + "displayName": null, + "machineFqdn": null, + "vmUuid": null, + "osSku": null, + "domainName": null, + "adFqdn": null, + "dnsFqdn": null, + "osName": null, + "osVersion": null, + "osProfile": { + "computerName": null + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond" + }, + "clientPublicKey": "string", + "parentClusterResourceId": null, + "detectedProperties": { + "cloudprovider": "N/A", + "manufacturer": "Microsoft Corporation", + "model": "Virtual Machine", + "mssqldiscovered": "false" + }, + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" + } + }, + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup2/providers/Microsoft.HybridCompute/machines/myMachine2", + "name": "myMachine2", + "location": "westus2", + "tags": null, + "identity": { + "type": "SystemAssigned", + "principalId": "e7a068cc-b0b8-46e8-a203-22f301a62a8f", + "tenantId": "c4098cc-91b8-46c2-a205-d82ab1a62a8f" + }, + "type": "Microsoft.HybridCompute/machines", + "properties": { + "provisioningState": "Succeeded", + "agentVersion": null, + "status": null, + "lastStatusChange": null, + "errorDetails": null, + "displayName": null, + "machineFqdn": null, + "osName": null, + "osVersion": null, + "osProfile": { + "computerName": null + }, + "vmId": "a4a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond" + }, + "clientPublicKey": "string", + "parentClusterResourceId": "{AzureStackHCIResourceId}", + "detectedProperties": { + "cloudprovider": "N/A", + "manufacturer": "Microsoft Corporation", + "model": "Surfacebook", + "mssqldiscovered": "true" + } + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/Machines_Update.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/Machines_Update.json new file mode 100644 index 000000000000..68b1898f6dec --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/Machines_Update.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "api-version": "2021-05-17-preview", + "location": "eastus2euap", + "parameters": { + "properties": { + "locationData": { + "name": "Redmond" + }, + "parentClusterResourceId": "{AzureStackHCIResourceId}", + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine", + "name": "myMachine", + "location": "eastus2euap", + "tags": null, + "identity": { + "type": "SystemAssigned", + "principalId": "string", + "tenantId": "string" + }, + "type": "Microsoft.HybridCompute/machines", + "properties": { + "provisioningState": "Succeeded", + "agentVersion": null, + "status": null, + "lastStatusChange": null, + "errorDetails": null, + "displayName": null, + "machineFqdn": null, + "vmUuid": null, + "osSku": null, + "domainName": null, + "adFqdn": null, + "dnsFqdn": null, + "osName": null, + "osVersion": null, + "osProfile": { + "computerName": null + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond" + }, + "clientPublicKey": "string", + "parentClusterResourceId": "{AzureStackHCIResourceId}", + "detectedProperties": null, + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PUTExtension.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PUTExtension.json new file mode 100644 index 000000000000..8954799c6f01 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PUTExtension.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "extensionName": "CustomScriptExtension", + "api-version": "2021-05-17-preview", + "extensionParameters": { + "location": "eastus2euap", + "properties": { + "publisher": "Microsoft.Compute", + "typeHandlerVersion": "1.10", + "type": "CustomScriptExtension", + "settings": { + "commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/Extensions/CustomScriptExtension", + "name": "CustomScriptExtension", + "type": "Microsoft.HybridCompute/machines/extensions", + "location": "eastus2euap", + "properties": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10.3", + "autoUpgradeMinorVersion": false, + "settings": "@{commandToExecute=powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"}", + "protectedSettings": {}, + "provisioningState": "Succeeded", + "instanceView": { + "name": "CustomScriptExtension", + "type": "CustomScriptExtension", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "success", + "level": "Information", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2020-08-08T20:42:10.999Z" + } + } + } + } + }, + "202": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateEndpointConnectionDelete.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateEndpointConnectionDelete.json new file mode 100644 index 000000000000..86424bd03156 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateEndpointConnectionDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "scopeName": "myPrivateLinkScope", + "privateEndpointConnectionName": "private-endpoint-connection-name", + "api-version": "2021-05-17-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateEndpointConnectionGet.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateEndpointConnectionGet.json new file mode 100644 index 000000000000..c4d1350621a9 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateEndpointConnectionGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "scopeName": "myPrivateLinkScope", + "privateEndpointConnectionName": "private-endpoint-connection-name", + "api-version": "2021-05-17-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateEndpointConnectionList.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateEndpointConnectionList.json new file mode 100644 index 000000000000..d7350e8b5a56 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateEndpointConnectionList.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "scopeName": "myPrivateLinkScope", + "api-version": "2021-05-17-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name-2", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name-2", + "name": "private-endpoint-connection-name-2", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name-2" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my connection.", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateEndpointConnectionUpdate.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateEndpointConnectionUpdate.json new file mode 100644 index 000000000000..7f309660c0e3 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateEndpointConnectionUpdate.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "scopeName": "myPrivateLinkScope", + "privateEndpointConnectionName": "private-endpoint-connection-name", + "api-version": "2021-05-17-preview", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com", + "actionsRequired": "None" + } + } + } + }, + "202": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopePrivateLinkResourceGet.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopePrivateLinkResourceGet.json new file mode 100644 index 000000000000..f6443d7aaf17 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopePrivateLinkResourceGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "scopeName": "myPrivateLinkScope", + "api-version": "2021-05-17-preview", + "groupName": "hybridcompute" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateLinkResources/hybridcompute", + "name": "hybridcompute", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateLinkResources", + "properties": { + "groupId": "hybridcompute", + "requiredMembers": [ + "HybridCompute.Server", + "HybridCompute.K8sConfiguration", + "GuestConfig.DP" + ], + "requiredZoneNames": [ + "privatelink.his.arc.azure.com", + "privatelink.kubernetesconfiguration.azure.com", + "privatelink.Guestconfiguration.azure.com" + ] + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopePrivateLinkResourceListGet.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopePrivateLinkResourceListGet.json new file mode 100644 index 000000000000..38ab69ef7bdf --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopePrivateLinkResourceListGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "scopeName": "myPrivateLinkScope", + "api-version": "2021-05-17-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateLinkResources/hybridcompute", + "name": "hybridcompute", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateLinkResources", + "properties": { + "groupId": "hybridcompute", + "requiredMembers": [ + "HybridCompute.ServerDP", + "HybridCompute.K8sConfigurationDP", + "HybridCompute.GuestConfigDP" + ], + "requiredZoneNames": [ + "privatelink.his.arc.azure.com", + "privatelink.kubernetesconfiguration.azure.com", + "privatelink.Guestconfiguration.azure.com" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopesCreate.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopesCreate.json new file mode 100644 index 000000000000..256fd49c6797 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopesCreate.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2021-05-17-preview", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope", + "parameters": { + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": {}, + "properties": { + "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": {}, + "properties": { + "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopesDelete.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopesDelete.json new file mode 100644 index 000000000000..8e7c615053d5 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopesDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-05-17-preview", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope" + }, + "responses": { + "200": {}, + "204": {}, + "202": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopesGet.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopesGet.json new file mode 100644 index 000000000000..e11ff572deaf --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopesGet.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2021-05-17-preview", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": {}, + "properties": { + "privateLinkScopeId": "f5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopesGetValidation.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopesGetValidation.json new file mode 100644 index 000000000000..7f05d9d68764 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopesGetValidation.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-05-17-preview", + "location": "wus2", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "privateLinkScopeId": "f5dc51d3-92ed-4d7e-947a-775ea79b4919" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "publicNetworkAccess": "Disabled", + "connectionDetails": [ + { + "id": "id", + "privateIpAddress": "ip", + "linkIdentifier": "linkId", + "groupId": "groupId", + "memberName": "memberName" + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopesGetValidationForMachine.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopesGetValidationForMachine.json new file mode 100644 index 000000000000..2009ac6eef47 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopesGetValidationForMachine.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2021-05-17-preview", + "location": "wus2", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group", + "machineName": "machineName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "publicNetworkAccess": "Disabled", + "connectionDetails": [ + { + "id": "id", + "privateIpAddress": "ip", + "linkIdentifier": "linkId", + "groupId": "groupId", + "memberName": "memberName" + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopesList.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopesList.json new file mode 100644 index 000000000000..9186b5292185 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopesList.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2019-10-17-preview", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": {}, + "properties": { + "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled" + } + }, + { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-other-privatelinkscope", + "name": "my-other-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": {}, + "properties": { + "privateLinkScopeId": "f5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopesListByResourceGroup.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopesListByResourceGroup.json new file mode 100644 index 000000000000..5c41a80050af --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopesListByResourceGroup.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2021-05-17-preview", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": {}, + "properties": { + "privateLinkScopeId": "f5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + }, + { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-other-privatelinkscope", + "name": "my-other-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": {}, + "properties": { + "privateLinkScopeId": "a5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopesUpdate.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopesUpdate.json new file mode 100644 index 000000000000..22968294d8d1 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopesUpdate.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2021-05-17-preview", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope", + "parameters": { + "location": "westus", + "tags": { + "Tag1": "Value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridCompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridCompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopesUpdateTagsOnly.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopesUpdateTagsOnly.json new file mode 100644 index 000000000000..20596dda09ad --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/PrivateLinkScopesUpdateTagsOnly.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2021-05-17-preview", + "subscriptionId": "subid", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope", + "PrivateLinkScopeTags": { + "tags": { + "Tag1": "Value1", + "Tag2": "Value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": { + "Tag1": "Value1", + "Tag2": "Value2" + }, + "properties": { + "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/UpdateExtension.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/UpdateExtension.json new file mode 100644 index 000000000000..92f2511fff14 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/examples/UpdateExtension.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "extensionName": "CustomScriptExtension", + "api-version": "2021-05-17-preview", + "extensionParameters": { + "properties": { + "publisher": "Microsoft.Compute", + "typeHandlerVersion": "1.10", + "type": "CustomScriptExtension", + "settings": { + "commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -lt 100 }\"" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/Extensions/CustomScriptExtension", + "name": "CustomScriptExtension", + "type": "Microsoft.HybridCompute/machines/extensions", + "location": "eastus2euap", + "properties": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10.3", + "autoUpgradeMinorVersion": false, + "settings": "@{commandToExecute=powershell.exe -c \"Get-Process | Where-Object { $_.CPU -lt 100 }\"}", + "protectedSettings": {}, + "provisioningState": "Succeeded", + "instanceView": { + "name": "CustomScriptExtension", + "type": "CustomScriptExtension", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "success", + "level": "Information", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2020-01-08T20:42:10.999Z" + } + } + } + } + }, + "202": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/privateLinkScopes.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/privateLinkScopes.json new file mode 100644 index 000000000000..2a0970385ef5 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-05-17-preview/privateLinkScopes.json @@ -0,0 +1,1083 @@ +{ + "swagger": "2.0", + "info": { + "title": "HybridComputeManagementClient", + "x-ms-code-generation-settings": { + "name": "HybridComputeManagementClient" + }, + "description": "Azure Arc( Servers and K8s Clusters) API reference for Private Link's Scopes management.", + "version": "2021-05-17-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/privateLinkScopes": { + "get": { + "description": "Gets a list of all Azure Arc PrivateLinkScopes within a subscription.", + "operationId": "PrivateLinkScopes_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A list containing 0 or more Azure Arc PrivateLinkScope definitions.", + "schema": { + "$ref": "#/definitions/HybridComputePrivateLinkScopeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopesList.json": { + "$ref": "./examples/PrivateLinkScopesList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes": { + "get": { + "description": "Gets a list of Azure Arc PrivateLinkScopes within a resource group.", + "operationId": "PrivateLinkScopes_ListByResourceGroup", + "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": "A list containing 0 or more Azure Arc PrivateLinkScope definitions.", + "schema": { + "$ref": "#/definitions/HybridComputePrivateLinkScopeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeListByResourceGroup": { + "$ref": "./examples/PrivateLinkScopesListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}": { + "delete": { + "description": "Deletes a Azure Arc PrivateLinkScope.", + "operationId": "PrivateLinkScopes_Delete", + "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" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + } + ], + "responses": { + "200": { + "description": "Successful request when deleting an Azure Arc PrivateLinkScope." + }, + "202": { + "description": "Accepted." + }, + "204": { + "description": "The specified PrivateLinkScope does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PrivateLinkScopesDelete": { + "$ref": "./examples/PrivateLinkScopesDelete.json" + } + } + }, + "get": { + "description": "Returns a Azure Arc PrivateLinkScope.", + "operationId": "PrivateLinkScopes_Get", + "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" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + } + ], + "responses": { + "200": { + "description": "Azure Arc PrivateLinkScope definition.", + "schema": { + "$ref": "#/definitions/HybridComputePrivateLinkScope" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeGet": { + "$ref": "./examples/PrivateLinkScopesGet.json" + } + } + }, + "put": { + "description": "Creates (or updates) a Azure Arc PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.", + "operationId": "PrivateLinkScopes_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "parameters", + "description": "Properties that need to be specified to create or update a Azure Arc for Servers and Clusters PrivateLinkScope.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/HybridComputePrivateLinkScope" + } + } + ], + "responses": { + "200": { + "description": "Successful request when creating or updating a Azure Arc PrivateLinkScope. The updated PrivateLinkScope is returned.", + "schema": { + "$ref": "#/definitions/HybridComputePrivateLinkScope" + } + }, + "201": { + "description": "Successful request when creating or updating a Azure Arc PrivateLinkScope. The updated PrivateLinkScope was created and is returned.", + "schema": { + "$ref": "#/definitions/HybridComputePrivateLinkScope" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeCreate": { + "$ref": "./examples/PrivateLinkScopesCreate.json" + }, + "PrivateLinkScopeUpdate": { + "$ref": "./examples/PrivateLinkScopesUpdate.json" + } + } + }, + "patch": { + "description": "Updates an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method.", + "operationId": "PrivateLinkScopes_UpdateTags", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "PrivateLinkScopeTags", + "description": "Updated tag information to set into the PrivateLinkScope instance.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsResource" + } + } + ], + "responses": { + "200": { + "description": "Updating the Azure Arc PrivateLinkScope's tags was successful. PrivateLinkScope tags are updated and returned with the rest of the PrivateLinkScope's object properties.", + "schema": { + "$ref": "#/definitions/HybridComputePrivateLinkScope" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeUpdateTagsOnly": { + "$ref": "./examples/PrivateLinkScopesUpdateTagsOnly.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "description": "Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope.", + "operationId": "PrivateLinkResources_ListByPrivateLinkScope", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "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/PrivateLinkScopeName" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/PrivateLinkScopePrivateLinkResourceListGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateLinkResources/{groupName}": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "description": "Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope.", + "operationId": "PrivateLinkResources_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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/PrivateLinkScopeName" + }, + { + "$ref": "#/parameters/GroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved a specified private link resource.", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/PrivateLinkScopePrivateLinkResourceGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/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/PrivateLinkScopeName" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved a specified private endpoint connection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/PrivateEndpointConnectionGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Approve or reject a private endpoint connection with a given name.", + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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/PrivateLinkScopeName" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "Successfully approved or rejected private endpoint connection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Approve or reject a private endpoint connection with a given name.": { + "$ref": "./examples/PrivateEndpointConnectionUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Deletes a private endpoint connection with a given name.", + "operationId": "PrivateEndpointConnections_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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/PrivateLinkScopeName" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successfully deleted private endpoint connection." + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "Private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes a private endpoint connection with a given name.": { + "$ref": "./examples/PrivateEndpointConnectionDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Gets all private endpoint connections on a private link scope.", + "operationId": "PrivateEndpointConnections_ListByPrivateLinkScope", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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/PrivateLinkScopeName" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private endpoint connections.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets list of private endpoint connections on a private link scope.": { + "$ref": "./examples/PrivateEndpointConnectionList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/locations/{location}/privateLinkScopes/{privateLinkScopeId}": { + "get": { + "description": "Returns a Azure Arc PrivateLinkScope's validation details.", + "operationId": "PrivateLinkScopes_GetValidationDetails", + "parameters": [ + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeId" + } + ], + "responses": { + "200": { + "description": "Azure Arc PrivateLinkScope validation details definition.", + "schema": { + "$ref": "#/definitions/PrivateLinkScopeValidationDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeGet": { + "$ref": "./examples/PrivateLinkScopesGetValidation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/privateLinkScopes/current": { + "get": { + "description": "Returns a Azure Arc PrivateLinkScope's validation details for a given machine.", + "operationId": "PrivateLinkScopes_GetValidationDetailsForMachine", + "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/MachineNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure Arc PrivateLinkScope validation details definition.", + "schema": { + "$ref": "#/definitions/PrivateLinkScopeValidationDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeGet": { + "$ref": "./examples/PrivateLinkScopesGetValidationForMachine.json" + } + } + } + } + }, + "definitions": { + "PrivateLinkScopesResource": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id" + }, + "name": { + "type": "string", + "description": "Azure resource name", + "readOnly": true + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Azure resource type" + }, + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true, + "description": "An azure resource object" + }, + "TagsResource": { + "properties": { + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "description": "A container holding only the Tags for a resource, allowing the user to update the tags on a PrivateLinkScope instance." + }, + "HybridComputePrivateLinkScope": { + "properties": { + "properties": { + "description": "Properties that define a Azure Arc PrivateLinkScope resource.", + "$ref": "#/definitions/HybridComputePrivateLinkScopeProperties" + }, + "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/PrivateLinkScopesResource" + } + ], + "description": "An Azure Arc PrivateLinkScope definition." + }, + "PrivateLinkScopeValidationDetails": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id" + }, + "publicNetworkAccess": { + "description": "Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints.", + "$ref": "#/definitions/PublicNetworkAccessType" + }, + "connectionDetails": { + "type": "array", + "description": "List of Private Endpoint Connection details.", + "items": { + "$ref": "#/definitions/ConnectionDetail" + } + } + } + }, + "ConnectionDetail": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id" + }, + "privateIpAddress": { + "type": "string", + "readOnly": true, + "description": "The private endpoint connection private ip address" + }, + "linkIdentifier": { + "type": "string", + "readOnly": true, + "description": "The private endpoint connection link identifier" + }, + "groupId": { + "type": "string", + "readOnly": true, + "description": "The private endpoint connection group id" + }, + "memberName": { + "type": "string", + "readOnly": true, + "description": "The private endpoint connection member name" + } + } + }, + "HybridComputePrivateLinkScopeProperties": { + "description": "Properties that define a Azure Arc PrivateLinkScope resource.", + "properties": { + "publicNetworkAccess": { + "description": "Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints.", + "$ref": "#/definitions/PublicNetworkAccessType" + }, + "provisioningState": { + "type": "string", + "description": "Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed.", + "readOnly": true + }, + "privateLinkScopeId": { + "readOnly": true, + "description": "The Guid id of the private link scope.", + "type": "string" + }, + "privateEndpointConnections": { + "readOnly": true, + "description": "The collection of associated Private Endpoint Connections.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnectionDataModel" + } + } + } + }, + "HybridComputePrivateLinkScopeListResult": { + "description": "Describes the list of Azure Arc PrivateLinkScope resources.", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of Azure Arc PrivateLinkScope definitions.", + "items": { + "$ref": "#/definitions/HybridComputePrivateLinkScope" + } + }, + "nextLink": { + "type": "string", + "description": "The URI to get the next set of Azure Arc PrivateLinkScope definitions if too many PrivateLinkScopes where returned in the result set." + } + } + }, + "PrivateLinkResourceListResult": { + "description": "A list of private link resources", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "PrivateLinkResource": { + "description": "A private link resource", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties." + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ] + }, + "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": "Required DNS zone names of the the private link resource.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "PrivateEndpointConnectionDataModel": { + "description": "The Data Model for a Private Endpoint Connection associated with a Private Link Scope", + "type": "object", + "properties": { + "id": { + "description": "The ARM Resource Id of the Private Endpoint.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The Name of the Private Endpoint.", + "type": "string", + "readOnly": true + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Azure resource type" + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The Private Endpoint Connection properties." + } + } + }, + "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." + }, + "provisioningState": { + "description": "State of the private endpoint connection.", + "type": "string", + "readOnly": true + } + } + }, + "PrivateEndpointProperty": { + "description": "Private endpoint which the connection belongs to.", + "type": "object", + "properties": { + "id": { + "description": "Resource id of the private endpoint.", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionStateProperty": { + "description": "State of the private endpoint connection.", + "type": "object", + "required": [ + "status", + "description" + ], + "properties": { + "status": { + "description": "The private link service connection status.", + "type": "string" + }, + "description": { + "description": "The private link service connection description.", + "type": "string" + }, + "actionsRequired": { + "description": "The actions required for private link service connection.", + "type": "string", + "readOnly": true + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Resource properties." + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" + } + } + }, + "PrivateEndpointConnectionListResult": { + "description": "A list of private endpoint connections.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "PublicNetworkAccessType": { + "type": "string", + "description": "The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link).", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccessType", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints." + }, + { + "value": "Disabled", + "description": "Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link." + } + ] + } + } + }, + "parameters": { + "PrivateLinkScopeName": { + "name": "scopeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure Arc PrivateLinkScope resource.", + "x-ms-parameter-location": "method" + }, + "PrivateLinkScopeId": { + "name": "privateLinkScopeId", + "in": "path", + "required": true, + "type": "string", + "description": "The id (Guid) of the Azure Arc PrivateLinkScope resource.", + "x-ms-parameter-location": "method" + }, + "GroupNameParameter": { + "name": "groupName", + "in": "path", + "description": "The name of the private link resource.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The location of the target resource.", + "minLength": 1 + }, + "MachineNameParameter": { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the target machine to get the private link scope validation details for.", + "minLength": 1, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/HybridCompute.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/HybridCompute.json new file mode 100644 index 000000000000..6153c1b0898d --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/HybridCompute.json @@ -0,0 +1,1242 @@ +{ + "swagger": "2.0", + "info": { + "title": "HybridComputeManagementClient", + "description": "The Hybrid Compute Management Client.", + "version": "2021-06-10-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.HybridCompute/machines/{machineName}": { + "put": { + "tags": [ + "machines" + ], + "operationId": "Machines_CreateOrUpdate", + "description": "The operation to create or update a hybrid machine resource identity in Azure.", + "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" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the hybrid machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Machine" + }, + "description": "Parameters supplied to the Create hybrid machine operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Machine" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update a Machine": { + "$ref": "./examples/Machines_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "machines" + ], + "operationId": "Machines_Update", + "description": "The operation to update a hybrid machine.", + "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" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the hybrid machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MachineUpdate" + }, + "description": "Parameters supplied to the Update hybrid machine operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Machine" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update a Machine": { + "$ref": "./examples/Machines_Update.json" + } + } + }, + "delete": { + "tags": [ + "machines" + ], + "operationId": "Machines_Delete", + "description": "The operation to remove a hybrid machine identity in Azure.", + "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" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the hybrid machine." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a Machine": { + "$ref": "./examples/Machines_Delete.json" + } + } + }, + "get": { + "tags": [ + "machines" + ], + "operationId": "Machines_Get", + "description": "Retrieves information about the model view or the instance view of a hybrid machine.", + "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" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the hybrid machine." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation.", + "enum": [ + "instanceView" + ], + "x-ms-enum": { + "name": "InstanceViewTypes", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Machine" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Machine": { + "$ref": "./examples/Machines_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines": { + "get": { + "tags": [ + "machines" + ], + "operationId": "Machines_ListByResourceGroup", + "description": "Lists all the hybrid machines in the specified resource group. Use the nextLink property in the response to get the next page of hybrid machines.", + "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" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Machines by resource group": { + "$ref": "./examples/Machines_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/machines": { + "get": { + "tags": [ + "machines" + ], + "operationId": "Machines_ListBySubscription", + "description": "Lists all the hybrid machines in the specified subscription. Use the nextLink property in the response to get the next page of hybrid machines.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Machines by resource group": { + "$ref": "./examples/Machines_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions/{extensionName}": { + "put": { + "tags": [ + "MachineExtensions" + ], + "operationId": "MachineExtensions_CreateOrUpdate", + "description": "The operation to create or update the extension.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the machine where the extension should be created or updated." + }, + { + "name": "extensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MachineExtension" + }, + "description": "Parameters supplied to the Create Machine Extension operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineExtension" + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update a Machine Extension": { + "$ref": "./examples/PUTExtension.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "MachineExtensions" + ], + "operationId": "MachineExtensions_Update", + "description": "The operation to create or update the extension.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the machine where the extension should be created or updated." + }, + { + "name": "extensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MachineExtensionUpdate" + }, + "description": "Parameters supplied to the Create Machine Extension operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineExtension" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update a Machine Extension": { + "$ref": "./examples/UpdateExtension.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "MachineExtensions" + ], + "operationId": "MachineExtensions_Delete", + "description": "The operation to delete the extension.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the machine where the extension should be deleted." + }, + { + "name": "extensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the machine extension." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.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/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a Machine Extension": { + "$ref": "./examples/DELETEExtension.json" + } + } + }, + "get": { + "tags": [ + "MachineExtensions" + ], + "operationId": "MachineExtensions_Get", + "description": "The operation to get the extension.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the machine containing the extension." + }, + { + "name": "extensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the machine extension." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineExtension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GET Machine Extension": { + "$ref": "./examples/GETExtension.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions": { + "get": { + "tags": [ + "MachineExtensions" + ], + "operationId": "MachineExtensions_List", + "description": "The operation to get all extensions of a non-Azure machine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the machine containing the extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineExtensionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GET all Machine Extensions": { + "$ref": "./examples/LISTExtension.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/upgradeExtensions": { + "post": { + "tags": [ + "MachineExtensions Upgrade" + ], + "operationId": "UpgradeExtensions", + "description": "The operation to Upgrade Machine Extensions.", + "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" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the hybrid machine." + }, + { + "name": "extensionUpgradeParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MachineExtensionUpgrade" + }, + "description": "Parameters supplied to the Upgrade Extensions operation." + } + ], + "responses": { + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Upgrade Machine Extensions": { + "$ref": "./examples/Extensions_Upgrade.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/providers/Microsoft.HybridCompute/operations": { + "get": { + "tags": [ + "operations" + ], + "operationId": "Operations_List", + "description": "Gets a list of hybrid compute operations.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + } + }, + "definitions": { + "OperationListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OperationValue" + }, + "description": "The list of compute operations" + } + }, + "description": "The List Compute Operation operation response." + }, + "OperationValue": { + "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": { + "$ref": "#/definitions/OperationValueDisplay", + "description": "Display properties" + } + }, + "description": "Describes the properties of a Compute Operation value." + }, + "OperationValueDisplay": { + "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 Hybrid Compute Operation Value Display." + }, + "PatchSettings": { + "type": "object", + "properties": { + "assessmentMode": { + "type": "string", + "description": "Specifies the assessment mode." + } + }, + "description": "Specifies the patch settings." + }, + "OSProfile": { + "properties": { + "computerName": { + "type": "string", + "readOnly": true, + "description": "Specifies the host OS name of the hybrid machine." + }, + "windowsConfiguration": { + "type": "object", + "properties": { + "patchSettings": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PatchSettings" + } + }, + "description": "Specifies the windows configuration for update management." + }, + "linuxConfiguration": { + "type": "object", + "properties": { + "patchSettings": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PatchSettings" + } + }, + "description": "Specifies the linux configuration for update management." + } + }, + "description": "Specifies the operating system settings for the hybrid machine." + }, + "DetectedProperties": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Detected properties from the machine." + }, + "MachineProperties": { + "properties": { + "locationData": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/locationData" + }, + "osProfile": { + "$ref": "#/definitions/OSProfile", + "description": "Specifies the operating system settings for the hybrid machine." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "status": { + "readOnly": true, + "type": "string", + "description": "The status of the hybrid machine agent.", + "enum": [ + "Connected", + "Disconnected", + "Error" + ], + "x-ms-enum": { + "name": "StatusTypes", + "modelAsString": true + } + }, + "lastStatusChange": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time of the last status change." + }, + "errorDetails": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorDetail" + }, + "description": "Details about the error state." + }, + "agentVersion": { + "readOnly": true, + "type": "string", + "description": "The hybrid machine agent full version." + }, + "vmId": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Specifies the hybrid machine unique ID." + }, + "displayName": { + "readOnly": true, + "type": "string", + "description": "Specifies the hybrid machine display name." + }, + "machineFqdn": { + "readOnly": true, + "type": "string", + "description": "Specifies the hybrid machine FQDN." + }, + "clientPublicKey": { + "type": "string", + "description": "Public Key that the client provides to be used during initial resource onboarding" + }, + "osName": { + "readOnly": true, + "type": "string", + "description": "The Operating System running on the hybrid machine." + }, + "osVersion": { + "readOnly": true, + "type": "string", + "description": "The version of Operating System running on the hybrid machine." + }, + "osType": { + "type": "string", + "description": "The type of Operating System (windows/linux)." + }, + "vmUuid": { + "readOnly": true, + "type": "string", + "description": "Specifies the Arc Machine's unique SMBIOS ID" + }, + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/MachineExtensionInstanceView" + }, + "description": "Machine Extensions information" + }, + "osSku": { + "readOnly": true, + "type": "string", + "description": "Specifies the Operating System product SKU." + }, + "domainName": { + "readOnly": true, + "type": "string", + "description": "Specifies the Windows domain name." + }, + "adFqdn": { + "readOnly": true, + "type": "string", + "description": "Specifies the AD fully qualified display name." + }, + "dnsFqdn": { + "readOnly": true, + "type": "string", + "description": "Specifies the DNS fully qualified display name." + }, + "privateLinkScopeResourceId": { + "type": "string", + "description": "The resource id of the private link scope this machine is assigned to, if any." + }, + "parentClusterResourceId": { + "type": "string", + "description": "The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any." + }, + "mssqlDiscovered": { + "type": "string", + "description": "Specifies whether any MS SQL instance is discovered on the machine." + }, + "detectedProperties": { + "$ref": "#/definitions/DetectedProperties", + "description": "Detected properties from the machine." + } + }, + "description": "Describes the properties of a hybrid machine." + }, + "MachineUpdateProperties": { + "properties": { + "locationData": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/locationData" + }, + "osProfile": { + "$ref": "#/definitions/OSProfile" + }, + "parentClusterResourceId": { + "type": "string", + "description": "The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any." + }, + "privateLinkScopeResourceId": { + "type": "string", + "description": "The resource id of the private link scope this machine is assigned to, if any." + } + }, + "description": "Describes the ARM updatable properties of a hybrid machine." + }, + "Machine": { + "properties": { + "properties": { + "$ref": "#/definitions/MachineProperties", + "description": "Hybrid Compute Machine properties" + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Identity" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "description": "Describes a hybrid machine." + }, + "MachineUpdate": { + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Identity" + }, + "properties": { + "$ref": "#/definitions/MachineUpdateProperties", + "description": "Hybrid Compute Machine properties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceUpdate" + } + ], + "description": "Describes a hybrid machine Update." + }, + "MachineListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Machine" + }, + "description": "The list of hybrid machines." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of Machines. Call ListNext() with this URI to fetch the next page of hybrid machines." + } + }, + "required": [ + "value" + ], + "description": "The List hybrid machine operation response." + }, + "ResourceUpdate": { + "description": "The Update Resource model definition.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + } + }, + "MachineExtension": { + "properties": { + "properties": { + "$ref": "#/definitions/MachineExtensionProperties", + "description": "Describes Machine Extension Properties." + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "description": "Describes a Machine Extension." + }, + "MachineExtensionUpdate": { + "properties": { + "properties": { + "$ref": "#/definitions/MachineExtensionUpdateProperties", + "description": "Describes Machine Extension Update Properties." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceUpdate" + } + ], + "description": "Describes a Machine Extension Update." + }, + "MachineExtensionProperties": { + "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." + }, + "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/MachineExtensionInstanceView", + "description": "The machine extension instance view." + } + }, + "description": "Describes the properties of a Machine Extension." + }, + "MachineExtensionUpdateProperties": { + "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." + }, + "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." + } + }, + "description": "Describes the properties of a Machine Extension." + }, + "MachineExtensionInstanceView": { + "properties": { + "name": { + "type": "string", + "description": "The 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." + }, + "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." + } + }, + "description": "Instance view status." + } + }, + "description": "Describes the Machine Extension Instance View." + }, + "MachineExtensionsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MachineExtension" + }, + "description": "The list of extensions" + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of machine extensions. Call ListNext() with this to fetch the next page of extensions." + } + }, + "description": "Describes the Machine Extensions List Result." + }, + "TargetVersion": { + "type": "string", + "description": "Extension Upgrade Target Version." + }, + "ExtensionTargetProperties": { + "properties": { + "targetVersion": { + "type": "object", + "$ref": "#/definitions/TargetVersion", + "description": "Properties for the specified Extension to Upgrade." + } + }, + "description": "Describes the Machine Extension Target Version Properties" + }, + "ExtensionTarget": { + "additionalProperties": { + "type": "object", + "$ref": "#/definitions/ExtensionTargetProperties" + }, + "description": "Describes the Machine Extension Target Properties" + }, + "MachineExtensionUpgrade": { + "properties": { + "extensionTargets": { + "$ref": "#/definitions/ExtensionTarget", + "description": "Describes the Extension Target Properties." + } + }, + "description": "Describes the Machine Extension Upgrade Properties" + } + }, + "parameters": {} +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/DELETEExtension.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/DELETEExtension.json new file mode 100644 index 000000000000..955efd87e235 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/DELETEExtension.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "extensionName": "MMA", + "api-version": "2021-06-10-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/Extensions_Upgrade.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/Extensions_Upgrade.json new file mode 100644 index 000000000000..08b0d70b1deb --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/Extensions_Upgrade.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "api-version": "2021-06-10-preview", + "extensionUpgradeParameters": { + "extensionTargets": { + "Microsoft.Compute.CustomScriptExtension": { + "targetVersion": "1.10" + }, + "Microsoft.Azure.Monitoring": { + "targetVersion": "2.0" + } + } + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/GETExtension.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/GETExtension.json new file mode 100644 index 000000000000..a0d417b553d2 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/GETExtension.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "extensionName": "CustomScriptExtension", + "api-version": "2021-06-10-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/Extensions/CustomScriptExtension", + "name": "CustomScriptExtension", + "type": "Microsoft.HybridCompute/machines/extensions", + "location": "eastus2euap", + "properties": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10.3", + "autoUpgradeMinorVersion": false, + "settings": "@{commandToExecute=powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"}", + "protectedSettings": {}, + "provisioningState": "Succeeded", + "instanceView": { + "name": "CustomScriptExtension", + "type": "CustomScriptExtension", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "success", + "level": "Information", + "displayStatus": "Provisioning succeeded", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/LISTExtension.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/LISTExtension.json new file mode 100644 index 000000000000..5c5914080bdc --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/LISTExtension.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "api-version": "2021-06-10-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/Extensions/CustomScriptExtension", + "name": "CustomScriptExtension", + "location": "eastus2euap", + "type": "Microsoft.HybridCompute/machines/extensions", + "properties": { + "publisher": "Microsoft.Compute", + "type": "CustomScriptExtension", + "typeHandlerVersion": "1.10.3", + "autoUpgradeMinorVersion": false, + "settings": { + "commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"" + }, + "provisioningState": "Succeeded", + "instanceView": { + "name": "CustomScriptExtension", + "type": "CustomScriptExtension", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "success", + "level": "Information", + "displayStatus": "Provisioning succeeded", + "message": "formattedMessage: Finished executing command, StdOut: , StdErr: ", + "time": "2020-08-13T17:18:57.405Z" + } + } + } + }, + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/Extensions/winosupdateextension", + "name": "winosupdateextension", + "location": "eastus2euap", + "type": "Microsoft.HybridCompute/machines/extensions", + "properties": { + "publisher": "microsoft.softwareupdatemanagement.test", + "type": "windowsosupdateextension", + "typeHandlerVersion": "1.0.0.0", + "autoUpgradeMinorVersion": false, + "settings": {}, + "provisioningState": "Creating", + "instanceView": { + "name": "winosupdateextension", + "type": "windowsosupdateextension", + "typeHandlerVersion": "1.0.0.0", + "status": {} + } + } + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/Machines_CreateOrUpdate.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/Machines_CreateOrUpdate.json new file mode 100644 index 000000000000..60e5c8ffad72 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/Machines_CreateOrUpdate.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "api-version": "2021-06-10-preview", + "parameters": { + "location": "eastus2euap", + "properties": { + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond" + }, + "clientPublicKey": "string", + "parentClusterResourceId": "{AzureStackHCIResourceId}", + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine", + "name": "myMachine", + "location": "eastus2euap", + "tags": null, + "identity": { + "type": "SystemAssigned", + "principalId": "string", + "tenantId": "string" + }, + "type": "Microsoft.HybridCompute/machines", + "properties": { + "provisioningState": "Succeeded", + "agentVersion": null, + "status": null, + "lastStatusChange": null, + "errorDetails": null, + "displayName": null, + "machineFqdn": null, + "vmUuid": null, + "osSku": null, + "domainName": null, + "adFqdn": null, + "dnsFqdn": null, + "osName": null, + "osVersion": null, + "osType": null, + "osProfile": { + "computerName": null, + "windowsConfiguration": { + "patchSettings": { + "assessmentMode": null + } + }, + "linuxConfiguration": { + "patchSettings": { + "assessmentMode": null + } + } + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond", + "city": "redmond", + "district": null, + "countryOrRegion": "usa" + }, + "clientPublicKey": "string", + "parentClusterResourceId": "{AzureStackHCIResourceId}", + "mssqlDiscovered": "false", + "detectedProperties": { + "cloudprovider": "N/A", + "manufacturer": "Microsoft Corporation", + "model": "Virtual Machine" + }, + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/Machines_Delete.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/Machines_Delete.json new file mode 100644 index 000000000000..e1afec697b12 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/Machines_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "api-version": "2021-06-10-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/Machines_Get.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/Machines_Get.json new file mode 100644 index 000000000000..55163fb1f7e7 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/Machines_Get.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "api-version": "2021-06-10-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine", + "name": "myMachine", + "location": "eastus2euap", + "tags": null, + "identity": { + "type": "SystemAssigned", + "principalId": "string", + "tenantId": "string" + }, + "type": "Microsoft.HybridCompute/machines", + "properties": { + "provisioningState": "Succeeded", + "agentVersion": null, + "status": null, + "lastStatusChange": null, + "errorDetails": null, + "displayName": null, + "machineFqdn": null, + "vmUuid": null, + "osSku": null, + "domainName": null, + "adFqdn": null, + "dnsFqdn": null, + "osName": null, + "osVersion": null, + "osType": null, + "osProfile": { + "computerName": null, + "windowsConfiguration": { + "patchSettings": { + "assessmentMode": null + } + }, + "linuxConfiguration": { + "patchSettings": { + "assessmentMode": null + } + } + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond", + "city": "redmond", + "district": null, + "countryOrRegion": "usa" + }, + "clientPublicKey": "string", + "parentClusterResourceId": "{AzureStackHCIResourceId}", + "mssqlDiscovered": "false", + "detectedProperties": { + "cloudprovider": "N/A", + "manufacturer": "Microsoft Corporation", + "model": "Virtual Machine" + }, + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/Machines_ListByResourceGroup.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/Machines_ListByResourceGroup.json new file mode 100644 index 000000000000..1ab4d07cae7b --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/Machines_ListByResourceGroup.json @@ -0,0 +1,121 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-06-10-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine", + "name": "myMachine", + "location": "eastus2euap", + "tags": null, + "identity": { + "type": "SystemAssigned", + "principalId": "f7a068cc-b0b8-46e8-a203-22f301a62a8f", + "tenantId": "c4098cc-91b8-46c2-a205-d82ab1a62a8f" + }, + "type": "Microsoft.HybridCompute/machines", + "properties": { + "provisioningState": "Succeeded", + "agentVersion": null, + "status": null, + "lastStatusChange": null, + "errorDetails": null, + "displayName": null, + "machineFqdn": null, + "vmUuid": null, + "osSku": null, + "domainName": null, + "adFqdn": null, + "dnsFqdn": null, + "osName": null, + "osVersion": null, + "osType": null, + "osProfile": { + "computerName": null, + "windowsConfiguration": { + "patchSettings": { + "assessmentMode": null + } + }, + "linuxConfiguration": { + "patchSettings": { + "assessmentMode": null + } + } + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond" + }, + "clientPublicKey": "string", + "parentClusterResourceId": null, + "mssqlDiscovered": "false", + "detectedProperties": { + "cloudprovider": "N/A", + "manufacturer": "Microsoft Corporation", + "model": "Virtual Machine" + }, + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" + } + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine2", + "name": "myMachine2", + "location": "westus2", + "tags": null, + "identity": { + "type": "SystemAssigned", + "principalId": "e7a068cc-b0b8-46e8-a203-22f301a62a8f", + "tenantId": "c4098cc-91b8-46c2-a205-d82ab1a62a8f" + }, + "type": "Microsoft.HybridCompute/machines", + "properties": { + "provisioningState": "Succeeded", + "agentVersion": null, + "status": null, + "lastStatusChange": null, + "errorDetails": null, + "displayName": null, + "machineFqdn": null, + "osName": null, + "osVersion": null, + "osType": null, + "osProfile": { + "computerName": null, + "windowsConfiguration": { + "patchSettings": { + "assessmentMode": null + } + }, + "linuxConfiguration": { + "patchSettings": { + "assessmentMode": null + } + } + }, + "vmId": "a4a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond" + }, + "clientPublicKey": "string", + "parentClusterResourceId": "{AzureStackHCIResourceId}", + "mssqlDiscovered": "true", + "detectedProperties": { + "cloudprovider": "N/A", + "manufacturer": "Microsoft Corporation", + "model": "Surfacebook" + }, + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/Machines_ListBySubscription.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/Machines_ListBySubscription.json new file mode 100644 index 000000000000..8098750e2a97 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/Machines_ListBySubscription.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2021-06-10-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine", + "name": "myMachine", + "location": "eastus2euap", + "tags": null, + "identity": { + "type": "SystemAssigned", + "principalId": "string", + "tenantId": "string" + }, + "type": "Microsoft.HybridCompute/machines", + "properties": { + "provisioningState": "Succeeded", + "agentVersion": null, + "status": null, + "lastStatusChange": null, + "errorDetails": null, + "displayName": null, + "machineFqdn": null, + "vmUuid": null, + "osSku": null, + "domainName": null, + "adFqdn": null, + "dnsFqdn": null, + "osName": null, + "osVersion": null, + "osType": null, + "osProfile": { + "computerName": null, + "windowsConfiguration": { + "patchSettings": { + "assessmentMode": null + } + }, + "linuxConfiguration": { + "patchSettings": { + "assessmentMode": null + } + } + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond" + }, + "clientPublicKey": "string", + "parentClusterResourceId": null, + "mssqlDiscovered": "false", + "detectedProperties": { + "cloudprovider": "N/A", + "manufacturer": "Microsoft Corporation", + "model": "Virtual Machine" + }, + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" + } + }, + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup2/providers/Microsoft.HybridCompute/machines/myMachine2", + "name": "myMachine2", + "location": "westus2", + "tags": null, + "identity": { + "type": "SystemAssigned", + "principalId": "e7a068cc-b0b8-46e8-a203-22f301a62a8f", + "tenantId": "c4098cc-91b8-46c2-a205-d82ab1a62a8f" + }, + "type": "Microsoft.HybridCompute/machines", + "properties": { + "provisioningState": "Succeeded", + "agentVersion": null, + "status": null, + "lastStatusChange": null, + "errorDetails": null, + "displayName": null, + "machineFqdn": null, + "osName": null, + "osVersion": null, + "osType": null, + "osProfile": { + "computerName": null, + "windowsConfiguration": { + "patchSettings": { + "assessmentMode": null + } + }, + "linuxConfiguration": { + "patchSettings": { + "assessmentMode": null + } + } + }, + "vmId": "a4a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond" + }, + "clientPublicKey": "string", + "parentClusterResourceId": "{AzureStackHCIResourceId}", + "mssqlDiscovered": "true", + "detectedProperties": { + "cloudprovider": "N/A", + "manufacturer": "Microsoft Corporation", + "model": "Surfacebook" + } + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/Machines_Update.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/Machines_Update.json new file mode 100644 index 000000000000..921515546f2d --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/Machines_Update.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "api-version": "2021-06-10-preview", + "location": "eastus2euap", + "parameters": { + "properties": { + "locationData": { + "name": "Redmond" + }, + "osProfile": { + "windowsConfiguration": { + "patchSettings": { + "assessmentMode": "ImageDefault" + } + }, + "linuxConfiguration": { + "patchSettings": { + "assessmentMode": "ImageDefault" + } + } + }, + "parentClusterResourceId": "{AzureStackHCIResourceId}", + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine", + "name": "myMachine", + "location": "eastus2euap", + "tags": null, + "identity": { + "type": "SystemAssigned", + "principalId": "string", + "tenantId": "string" + }, + "type": "Microsoft.HybridCompute/machines", + "properties": { + "provisioningState": "Succeeded", + "agentVersion": null, + "status": null, + "lastStatusChange": null, + "errorDetails": null, + "displayName": null, + "machineFqdn": null, + "vmUuid": null, + "osSku": null, + "domainName": null, + "adFqdn": null, + "dnsFqdn": null, + "osName": null, + "osVersion": null, + "osType": null, + "osProfile": { + "computerName": null, + "windowsConfiguration": { + "patchSettings": { + "assessmentMode": "ImageDefault" + } + }, + "linuxConfiguration": { + "patchSettings": { + "assessmentMode": "ImageDefault" + } + } + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond" + }, + "clientPublicKey": "string", + "parentClusterResourceId": "{AzureStackHCIResourceId}", + "detectedProperties": null, + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PUTExtension.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PUTExtension.json new file mode 100644 index 000000000000..165e996cc573 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PUTExtension.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "extensionName": "CustomScriptExtension", + "api-version": "2021-06-10-preview", + "extensionParameters": { + "location": "eastus2euap", + "properties": { + "publisher": "Microsoft.Compute", + "typeHandlerVersion": "1.10", + "type": "CustomScriptExtension", + "settings": { + "commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/Extensions/CustomScriptExtension", + "name": "CustomScriptExtension", + "type": "Microsoft.HybridCompute/machines/extensions", + "location": "eastus2euap", + "properties": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10.3", + "autoUpgradeMinorVersion": false, + "settings": "@{commandToExecute=powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"}", + "protectedSettings": {}, + "provisioningState": "Succeeded", + "instanceView": { + "name": "CustomScriptExtension", + "type": "CustomScriptExtension", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "success", + "level": "Information", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2020-08-08T20:42:10.999Z" + } + } + } + } + }, + "202": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateEndpointConnectionDelete.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateEndpointConnectionDelete.json new file mode 100644 index 000000000000..694472485356 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateEndpointConnectionDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "scopeName": "myPrivateLinkScope", + "privateEndpointConnectionName": "private-endpoint-connection-name", + "api-version": "2021-06-10-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateEndpointConnectionGet.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateEndpointConnectionGet.json new file mode 100644 index 000000000000..7439c0aa3059 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateEndpointConnectionGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "scopeName": "myPrivateLinkScope", + "privateEndpointConnectionName": "private-endpoint-connection-name", + "api-version": "2021-06-10-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateEndpointConnectionList.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateEndpointConnectionList.json new file mode 100644 index 000000000000..db45abba8e4e --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateEndpointConnectionList.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "scopeName": "myPrivateLinkScope", + "api-version": "2021-06-10-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name-2", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name-2", + "name": "private-endpoint-connection-name-2", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name-2" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my connection.", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateEndpointConnectionUpdate.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateEndpointConnectionUpdate.json new file mode 100644 index 000000000000..4cd5bb76c673 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateEndpointConnectionUpdate.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "scopeName": "myPrivateLinkScope", + "privateEndpointConnectionName": "private-endpoint-connection-name", + "api-version": "2021-06-10-preview", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com", + "actionsRequired": "None" + } + } + } + }, + "202": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopePrivateLinkResourceGet.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopePrivateLinkResourceGet.json new file mode 100644 index 000000000000..efe87237a3d4 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopePrivateLinkResourceGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "scopeName": "myPrivateLinkScope", + "api-version": "2021-06-10-preview", + "groupName": "hybridcompute" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateLinkResources/hybridcompute", + "name": "hybridcompute", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateLinkResources", + "properties": { + "groupId": "hybridcompute", + "requiredMembers": [ + "HybridCompute.Server", + "HybridCompute.K8sConfiguration", + "GuestConfig.DP" + ], + "requiredZoneNames": [ + "privatelink.his.arc.azure.com", + "privatelink.kubernetesconfiguration.azure.com", + "privatelink.Guestconfiguration.azure.com" + ] + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopePrivateLinkResourceListGet.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopePrivateLinkResourceListGet.json new file mode 100644 index 000000000000..9f0074f3b02e --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopePrivateLinkResourceListGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "scopeName": "myPrivateLinkScope", + "api-version": "2021-06-10-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateLinkResources/hybridcompute", + "name": "hybridcompute", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateLinkResources", + "properties": { + "groupId": "hybridcompute", + "requiredMembers": [ + "HybridCompute.ServerDP", + "HybridCompute.K8sConfigurationDP", + "HybridCompute.GuestConfigDP" + ], + "requiredZoneNames": [ + "privatelink.his.arc.azure.com", + "privatelink.kubernetesconfiguration.azure.com", + "privatelink.Guestconfiguration.azure.com" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopesCreate.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopesCreate.json new file mode 100644 index 000000000000..38f0428a9539 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopesCreate.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2021-06-10-preview", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope", + "parameters": { + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": {}, + "properties": { + "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": {}, + "properties": { + "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopesDelete.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopesDelete.json new file mode 100644 index 000000000000..c1bbd1deef52 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopesDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-06-10-preview", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope" + }, + "responses": { + "200": {}, + "204": {}, + "202": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopesGet.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopesGet.json new file mode 100644 index 000000000000..1f4201f39f09 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopesGet.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2021-06-10-preview", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": {}, + "properties": { + "privateLinkScopeId": "f5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopesGetValidation.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopesGetValidation.json new file mode 100644 index 000000000000..6249fe2a8a92 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopesGetValidation.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-06-10-preview", + "location": "wus2", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "privateLinkScopeId": "f5dc51d3-92ed-4d7e-947a-775ea79b4919" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "publicNetworkAccess": "Disabled", + "connectionDetails": [ + { + "id": "id", + "privateIpAddress": "ip", + "linkIdentifier": "linkId", + "groupId": "groupId", + "memberName": "memberName" + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopesGetValidationForMachine.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopesGetValidationForMachine.json new file mode 100644 index 000000000000..94906d4cd6eb --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopesGetValidationForMachine.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2021-06-10-preview", + "location": "wus2", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group", + "machineName": "machineName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "publicNetworkAccess": "Disabled", + "connectionDetails": [ + { + "id": "id", + "privateIpAddress": "ip", + "linkIdentifier": "linkId", + "groupId": "groupId", + "memberName": "memberName" + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopesList.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopesList.json new file mode 100644 index 000000000000..9186b5292185 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopesList.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2019-10-17-preview", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": {}, + "properties": { + "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled" + } + }, + { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-other-privatelinkscope", + "name": "my-other-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": {}, + "properties": { + "privateLinkScopeId": "f5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopesListByResourceGroup.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopesListByResourceGroup.json new file mode 100644 index 000000000000..21d55b135ba3 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopesListByResourceGroup.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2021-06-10-preview", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": {}, + "properties": { + "privateLinkScopeId": "f5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + }, + { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-other-privatelinkscope", + "name": "my-other-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": {}, + "properties": { + "privateLinkScopeId": "a5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopesUpdate.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopesUpdate.json new file mode 100644 index 000000000000..780591408dda --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopesUpdate.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2021-06-10-preview", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope", + "parameters": { + "location": "westus", + "tags": { + "Tag1": "Value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridCompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridCompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopesUpdateTagsOnly.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopesUpdateTagsOnly.json new file mode 100644 index 000000000000..d644f28ae825 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/PrivateLinkScopesUpdateTagsOnly.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2021-06-10-preview", + "subscriptionId": "subid", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope", + "PrivateLinkScopeTags": { + "tags": { + "Tag1": "Value1", + "Tag2": "Value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": { + "Tag1": "Value1", + "Tag2": "Value2" + }, + "properties": { + "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/UpdateExtension.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/UpdateExtension.json new file mode 100644 index 000000000000..16681a7acb0d --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/examples/UpdateExtension.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "extensionName": "CustomScriptExtension", + "api-version": "2021-06-10-preview", + "extensionParameters": { + "properties": { + "publisher": "Microsoft.Compute", + "typeHandlerVersion": "1.10", + "type": "CustomScriptExtension", + "settings": { + "commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -lt 100 }\"" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/Extensions/CustomScriptExtension", + "name": "CustomScriptExtension", + "type": "Microsoft.HybridCompute/machines/extensions", + "location": "eastus2euap", + "properties": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10.3", + "autoUpgradeMinorVersion": false, + "settings": "@{commandToExecute=powershell.exe -c \"Get-Process | Where-Object { $_.CPU -lt 100 }\"}", + "protectedSettings": {}, + "provisioningState": "Succeeded", + "instanceView": { + "name": "CustomScriptExtension", + "type": "CustomScriptExtension", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "success", + "level": "Information", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2020-01-08T20:42:10.999Z" + } + } + } + } + }, + "202": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/privateLinkScopes.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/privateLinkScopes.json new file mode 100644 index 000000000000..946e7ee35e9d --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2021-06-10-preview/privateLinkScopes.json @@ -0,0 +1,1083 @@ +{ + "swagger": "2.0", + "info": { + "title": "HybridComputeManagementClient", + "x-ms-code-generation-settings": { + "name": "HybridComputeManagementClient" + }, + "description": "Azure Arc( Servers and K8s Clusters) API reference for Private Link's Scopes management.", + "version": "2021-06-10-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/privateLinkScopes": { + "get": { + "description": "Gets a list of all Azure Arc PrivateLinkScopes within a subscription.", + "operationId": "PrivateLinkScopes_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A list containing 0 or more Azure Arc PrivateLinkScope definitions.", + "schema": { + "$ref": "#/definitions/HybridComputePrivateLinkScopeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopesList.json": { + "$ref": "./examples/PrivateLinkScopesList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes": { + "get": { + "description": "Gets a list of Azure Arc PrivateLinkScopes within a resource group.", + "operationId": "PrivateLinkScopes_ListByResourceGroup", + "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": "A list containing 0 or more Azure Arc PrivateLinkScope definitions.", + "schema": { + "$ref": "#/definitions/HybridComputePrivateLinkScopeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeListByResourceGroup": { + "$ref": "./examples/PrivateLinkScopesListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}": { + "delete": { + "description": "Deletes a Azure Arc PrivateLinkScope.", + "operationId": "PrivateLinkScopes_Delete", + "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" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + } + ], + "responses": { + "200": { + "description": "Successful request when deleting an Azure Arc PrivateLinkScope." + }, + "202": { + "description": "Accepted." + }, + "204": { + "description": "The specified PrivateLinkScope does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PrivateLinkScopesDelete": { + "$ref": "./examples/PrivateLinkScopesDelete.json" + } + } + }, + "get": { + "description": "Returns a Azure Arc PrivateLinkScope.", + "operationId": "PrivateLinkScopes_Get", + "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" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + } + ], + "responses": { + "200": { + "description": "Azure Arc PrivateLinkScope definition.", + "schema": { + "$ref": "#/definitions/HybridComputePrivateLinkScope" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeGet": { + "$ref": "./examples/PrivateLinkScopesGet.json" + } + } + }, + "put": { + "description": "Creates (or updates) a Azure Arc PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.", + "operationId": "PrivateLinkScopes_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "parameters", + "description": "Properties that need to be specified to create or update a Azure Arc for Servers and Clusters PrivateLinkScope.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/HybridComputePrivateLinkScope" + } + } + ], + "responses": { + "200": { + "description": "Successful request when creating or updating a Azure Arc PrivateLinkScope. The updated PrivateLinkScope is returned.", + "schema": { + "$ref": "#/definitions/HybridComputePrivateLinkScope" + } + }, + "201": { + "description": "Successful request when creating or updating a Azure Arc PrivateLinkScope. The updated PrivateLinkScope was created and is returned.", + "schema": { + "$ref": "#/definitions/HybridComputePrivateLinkScope" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeCreate": { + "$ref": "./examples/PrivateLinkScopesCreate.json" + }, + "PrivateLinkScopeUpdate": { + "$ref": "./examples/PrivateLinkScopesUpdate.json" + } + } + }, + "patch": { + "description": "Updates an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method.", + "operationId": "PrivateLinkScopes_UpdateTags", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "PrivateLinkScopeTags", + "description": "Updated tag information to set into the PrivateLinkScope instance.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsResource" + } + } + ], + "responses": { + "200": { + "description": "Updating the Azure Arc PrivateLinkScope's tags was successful. PrivateLinkScope tags are updated and returned with the rest of the PrivateLinkScope's object properties.", + "schema": { + "$ref": "#/definitions/HybridComputePrivateLinkScope" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeUpdateTagsOnly": { + "$ref": "./examples/PrivateLinkScopesUpdateTagsOnly.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "description": "Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope.", + "operationId": "PrivateLinkResources_ListByPrivateLinkScope", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "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/PrivateLinkScopeName" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/PrivateLinkScopePrivateLinkResourceListGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateLinkResources/{groupName}": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "description": "Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope.", + "operationId": "PrivateLinkResources_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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/PrivateLinkScopeName" + }, + { + "$ref": "#/parameters/GroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved a specified private link resource.", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/PrivateLinkScopePrivateLinkResourceGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/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/PrivateLinkScopeName" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved a specified private endpoint connection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/PrivateEndpointConnectionGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Approve or reject a private endpoint connection with a given name.", + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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/PrivateLinkScopeName" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "Successfully approved or rejected private endpoint connection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Approve or reject a private endpoint connection with a given name.": { + "$ref": "./examples/PrivateEndpointConnectionUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Deletes a private endpoint connection with a given name.", + "operationId": "PrivateEndpointConnections_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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/PrivateLinkScopeName" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successfully deleted private endpoint connection." + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "Private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes a private endpoint connection with a given name.": { + "$ref": "./examples/PrivateEndpointConnectionDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Gets all private endpoint connections on a private link scope.", + "operationId": "PrivateEndpointConnections_ListByPrivateLinkScope", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/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/PrivateLinkScopeName" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private endpoint connections.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets list of private endpoint connections on a private link scope.": { + "$ref": "./examples/PrivateEndpointConnectionList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/locations/{location}/privateLinkScopes/{privateLinkScopeId}": { + "get": { + "description": "Returns a Azure Arc PrivateLinkScope's validation details.", + "operationId": "PrivateLinkScopes_GetValidationDetails", + "parameters": [ + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeId" + } + ], + "responses": { + "200": { + "description": "Azure Arc PrivateLinkScope validation details definition.", + "schema": { + "$ref": "#/definitions/PrivateLinkScopeValidationDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeGet": { + "$ref": "./examples/PrivateLinkScopesGetValidation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/privateLinkScopes/current": { + "get": { + "description": "Returns a Azure Arc PrivateLinkScope's validation details for a given machine.", + "operationId": "PrivateLinkScopes_GetValidationDetailsForMachine", + "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/MachineNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure Arc PrivateLinkScope validation details definition.", + "schema": { + "$ref": "#/definitions/PrivateLinkScopeValidationDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeGet": { + "$ref": "./examples/PrivateLinkScopesGetValidationForMachine.json" + } + } + } + } + }, + "definitions": { + "PrivateLinkScopesResource": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id" + }, + "name": { + "type": "string", + "description": "Azure resource name", + "readOnly": true + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Azure resource type" + }, + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true, + "description": "An azure resource object" + }, + "TagsResource": { + "properties": { + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "description": "A container holding only the Tags for a resource, allowing the user to update the tags on a PrivateLinkScope instance." + }, + "HybridComputePrivateLinkScope": { + "properties": { + "properties": { + "description": "Properties that define a Azure Arc PrivateLinkScope resource.", + "$ref": "#/definitions/HybridComputePrivateLinkScopeProperties" + }, + "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/PrivateLinkScopesResource" + } + ], + "description": "An Azure Arc PrivateLinkScope definition." + }, + "PrivateLinkScopeValidationDetails": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id" + }, + "publicNetworkAccess": { + "description": "Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints.", + "$ref": "#/definitions/PublicNetworkAccessType" + }, + "connectionDetails": { + "type": "array", + "description": "List of Private Endpoint Connection details.", + "items": { + "$ref": "#/definitions/ConnectionDetail" + } + } + } + }, + "ConnectionDetail": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id" + }, + "privateIpAddress": { + "type": "string", + "readOnly": true, + "description": "The private endpoint connection private ip address" + }, + "linkIdentifier": { + "type": "string", + "readOnly": true, + "description": "The private endpoint connection link identifier" + }, + "groupId": { + "type": "string", + "readOnly": true, + "description": "The private endpoint connection group id" + }, + "memberName": { + "type": "string", + "readOnly": true, + "description": "The private endpoint connection member name" + } + } + }, + "HybridComputePrivateLinkScopeProperties": { + "description": "Properties that define a Azure Arc PrivateLinkScope resource.", + "properties": { + "publicNetworkAccess": { + "description": "Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints.", + "$ref": "#/definitions/PublicNetworkAccessType" + }, + "provisioningState": { + "type": "string", + "description": "Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed.", + "readOnly": true + }, + "privateLinkScopeId": { + "readOnly": true, + "description": "The Guid id of the private link scope.", + "type": "string" + }, + "privateEndpointConnections": { + "readOnly": true, + "description": "The collection of associated Private Endpoint Connections.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnectionDataModel" + } + } + } + }, + "HybridComputePrivateLinkScopeListResult": { + "description": "Describes the list of Azure Arc PrivateLinkScope resources.", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of Azure Arc PrivateLinkScope definitions.", + "items": { + "$ref": "#/definitions/HybridComputePrivateLinkScope" + } + }, + "nextLink": { + "type": "string", + "description": "The URI to get the next set of Azure Arc PrivateLinkScope definitions if too many PrivateLinkScopes where returned in the result set." + } + } + }, + "PrivateLinkResourceListResult": { + "description": "A list of private link resources", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "PrivateLinkResource": { + "description": "A private link resource", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties." + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ] + }, + "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": "Required DNS zone names of the the private link resource.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "PrivateEndpointConnectionDataModel": { + "description": "The Data Model for a Private Endpoint Connection associated with a Private Link Scope", + "type": "object", + "properties": { + "id": { + "description": "The ARM Resource Id of the Private Endpoint.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The Name of the Private Endpoint.", + "type": "string", + "readOnly": true + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Azure resource type" + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The Private Endpoint Connection properties." + } + } + }, + "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." + }, + "provisioningState": { + "description": "State of the private endpoint connection.", + "type": "string", + "readOnly": true + } + } + }, + "PrivateEndpointProperty": { + "description": "Private endpoint which the connection belongs to.", + "type": "object", + "properties": { + "id": { + "description": "Resource id of the private endpoint.", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionStateProperty": { + "description": "State of the private endpoint connection.", + "type": "object", + "required": [ + "status", + "description" + ], + "properties": { + "status": { + "description": "The private link service connection status.", + "type": "string" + }, + "description": { + "description": "The private link service connection description.", + "type": "string" + }, + "actionsRequired": { + "description": "The actions required for private link service connection.", + "type": "string", + "readOnly": true + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Resource properties." + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" + } + } + }, + "PrivateEndpointConnectionListResult": { + "description": "A list of private endpoint connections.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "PublicNetworkAccessType": { + "type": "string", + "description": "The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link).", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccessType", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints." + }, + { + "value": "Disabled", + "description": "Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link." + } + ] + } + } + }, + "parameters": { + "PrivateLinkScopeName": { + "name": "scopeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure Arc PrivateLinkScope resource.", + "x-ms-parameter-location": "method" + }, + "PrivateLinkScopeId": { + "name": "privateLinkScopeId", + "in": "path", + "required": true, + "type": "string", + "description": "The id (Guid) of the Azure Arc PrivateLinkScope resource.", + "x-ms-parameter-location": "method" + }, + "GroupNameParameter": { + "name": "groupName", + "in": "path", + "description": "The name of the private link resource.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The location of the target resource.", + "minLength": 1 + }, + "MachineNameParameter": { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the target machine to get the private link scope validation details for.", + "minLength": 1, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/hybridcompute/resource-manager/readme.md b/specification/hybridcompute/resource-manager/readme.md index 297ae964e5c9..52bd31aafe81 100644 --- a/specification/hybridcompute/resource-manager/readme.md +++ b/specification/hybridcompute/resource-manager/readme.md @@ -26,19 +26,39 @@ These are the global settings for the HybridCompute API. ``` yaml openapi-type: arm -tag: package-2021-05 +tag: package-preview-2021-06 ``` +### Tag: package-preview-2021-06 + +These settings apply only when `--tag=package-preview-2021-06` is specified on the command line. + +```yaml $(tag) == 'package-preview-2021-06' +input-file: + - Microsoft.HybridCompute/preview/2021-06-10-preview/HybridCompute.json + - Microsoft.HybridCompute/preview/2021-06-10-preview/privateLinkScopes.json +``` +### Tag: package-preview-2021-05 + +These settings apply only when `--tag=package-preview-2021-05` is specified on the command line. + +``` yaml $(tag) == 'package-preview-2021-05' +input-file: + - Microsoft.HybridCompute/preview/2021-05-17-preview/HybridCompute.json + - Microsoft.HybridCompute/preview/2021-05-17-preview/privateLinkScopes.json +``` + ### Tag: package-2021-05 These settings apply only when `--tag=package-2021-05` is specified on the command line. -```yaml $(tag) == 'package-2021-05' +``` yaml $(tag) == 'package-2021-05' input-file: - Microsoft.HybridCompute/stable/2021-05-20/HybridCompute.json - Microsoft.HybridCompute/stable/2021-05-20/privateLinkScopes.json ``` + ### Tag: package-preview-2021-04 These settings apply only when `--tag=package-preview-2021-04` is specified on the command line. @@ -137,7 +157,6 @@ This is not used by Autorest itself. swagger-to-sdk: - repo: azure-powershell - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/hybridcompute/resource-manager/readme.python.md b/specification/hybridcompute/resource-manager/readme.python.md index 5e4d8f38a28d..d932975f6ab8 100644 --- a/specification/hybridcompute/resource-manager/readme.python.md +++ b/specification/hybridcompute/resource-manager/readme.python.md @@ -4,18 +4,7 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.hybridcompute - package-name: azure-mgmt-hybridcompute - clear-output-folder: true -``` ``` yaml $(python) && $(track2) -python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.hybridcompute @@ -23,38 +12,17 @@ package-name: azure-mgmt-hybridcompute package-version: 1.0.0b1 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/hybridcompute/azure-mgmt-hybridcompute/azure/mgmt/hybridcompute -directive: - - remove-operation: - - Machines_Reconnect - - Machines_CreateOrUpdate - - Machines_Update -``` -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-hybridcompute -directive: - - remove-operation: - - Machines_Reconnect - - Machines_CreateOrUpdate - - Machines_Update -``` + ``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/hybridcompute/azure-mgmt-hybridcompute/azure/mgmt/hybridcompute -directive: - - remove-operation: - - Machines_Reconnect - - Machines_CreateOrUpdate - - Machines_Update ``` ``` yaml $(python) && $(python-mode) == 'create' && $(track2) basic-setup-py: true output-folder: $(python-sdks-folder)/azure-mgmt-hybridcompute +``` + +``` yaml $(python) && $(track2) directive: - remove-operation: - Machines_Reconnect diff --git a/specification/hybridcompute/resource-manager/readme.typescript.md b/specification/hybridcompute/resource-manager/readme.typescript.md index f069d08bc706..c970fbe21fae 100644 --- a/specification/hybridcompute/resource-manager/readme.typescript.md +++ b/specification/hybridcompute/resource-manager/readme.typescript.md @@ -17,7 +17,7 @@ directive: - Machines_Update ``` -``` yaml $(typescript) && !$(profile) +``` yaml $(typescript) && !$(profile-content) package-name: "@azure/arm-hybridcompute" output-folder: "$(typescript-sdks-folder)/sdk/hybridcompute/arm-hybridcompute" clear-output-folder: true diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json index 697dadd4d694..c7d5d45112ec 100644 --- a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json @@ -143,11 +143,8 @@ "$ref": "#/definitions/ConnectedCluster" } }, - "201": { - "description": "Resource patch request accepted", - "schema": { - "$ref": "#/definitions/ConnectedCluster" - } + "202": { + "description": "Resource patch request accepted" }, "default": { "description": "Resource Provider error response describing why the operation failed.", @@ -155,6 +152,10 @@ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" } }, "get": { diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2021-04-01-preview/examples/UpdateClusterExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2021-04-01-preview/examples/UpdateClusterExample.json index 4a4bf7979fc0..ee5337d05d70 100644 --- a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2021-04-01-preview/examples/UpdateClusterExample.json +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2021-04-01-preview/examples/UpdateClusterExample.json @@ -43,36 +43,6 @@ } } }, - "201": { - "body": { - "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", - "name": "connectedCluster1", - "type": "Microsoft.Kubernetes/connectedClusters", - "location": "East US", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "systemData": { - "createdBy": "sikasire@microsoft.com", - "createdByType": "User", - "createdAt": "2020-12-17T07:06:33.9173186Z", - "lastModifiedBy": "2d2a754c-cade-4935-83d4-ce413c5a3910", - "lastModifiedByType": "Application", - "lastModifiedAt": "2020-12-17T07:14:58.865041Z" - }, - "identity": { - "type": "SystemAssigned" - }, - "properties": { - "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", - "kubernetesVersion": "1.17.0", - "totalNodeCount": 2, - "agentVersion": "0.1.0", - "privateLinkState": "Disabled", - "provisioningState": "Accepted" - } - } - } + "202": {} } } diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2021-04-01-preview/examples/UpdateClusterPrivateLinkExample.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2021-04-01-preview/examples/UpdateClusterPrivateLinkExample.json index 846de5613172..7c20d352e7b4 100644 --- a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2021-04-01-preview/examples/UpdateClusterPrivateLinkExample.json +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2021-04-01-preview/examples/UpdateClusterPrivateLinkExample.json @@ -45,34 +45,6 @@ } } }, - "201": { - "body": { - "id": "/subscriptions/1bfbb5d0-917e-4346-9026-1d3b344417f5/resourceGroups/akkeshar/providers/Microsoft.Kubernetes/connectedClusters/connectedCluster1", - "name": "connectedCluster1", - "type": "Microsoft.Kubernetes/connectedClusters", - "location": "East US", - "tags": {}, - "systemData": { - "createdBy": "sikasire@microsoft.com", - "createdByType": "User", - "createdAt": "2020-12-17T07:06:33.9173186Z", - "lastModifiedBy": "2d2a754c-cade-4935-83d4-ce413c5a3910", - "lastModifiedByType": "Application", - "lastModifiedAt": "2020-12-17T07:14:58.865041Z" - }, - "identity": { - "type": "SystemAssigned" - }, - "properties": { - "agentPublicKeyCertificate": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", - "kubernetesVersion": "1.17.0", - "totalNodeCount": 2, - "agentVersion": "0.1.0", - "privateLinkState": "Enabled", - "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName", - "provisioningState": "Accepted" - } - } - } + "202": {} } } diff --git a/specification/hybridkubernetes/resource-manager/readme.md b/specification/hybridkubernetes/resource-manager/readme.md index 4477c3eb8504..004cb9134f5f 100644 --- a/specification/hybridkubernetes/resource-manager/readme.md +++ b/specification/hybridkubernetes/resource-manager/readme.md @@ -28,7 +28,7 @@ These are the global settings for the Kubernetes Connect RP. ```yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2021-03-01 +tag: package-2021-04-01-preview ``` ### Tag: package-2020-01-01-preview diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/common.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/common.json new file mode 100644 index 000000000000..14bd18db5dd7 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/common.json @@ -0,0 +1,260 @@ +{ + "swagger": "2.0", + "info": { + "title": "HybridNetworkManagementClient", + "description": "The definitions in this swagger specification will be used to manage the Hybrid Network resources.", + "version": "2021-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "SubResource": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + }, + "description": "Reference to another sub resource.", + "x-ms-azure-resource": true + }, + "ProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Unknown", + "Succeeded", + "Accepted", + "Deleting", + "Failed", + "Canceled", + "Deleted" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "VendorProvisioningState": { + "type": "string", + "description": "The current vendor provisioning state.", + "enum": [ + "Unknown", + "NotProvisioned", + "Provisioning", + "Provisioned", + "Deprovisioned", + "UserDataValidationFailed" + ], + "x-ms-enum": { + "name": "VendorProvisioningState", + "modelAsString": true + } + }, + "TagsObject": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + }, + "NetworkInterface": { + "description": "Network interface properties.", + "properties": { + "networkInterfaceName": { + "type": "string", + "description": "The name of the network interface." + }, + "macAddress": { + "type": "string", + "description": "The MAC address of the network interface." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceIPConfiguration" + }, + "description": "A list of IP configurations of the network interface." + }, + "vmSwitchType": { + "type": "string", + "description": "The type of the VM switch.", + "enum": [ + "Unknown", + "Management", + "Wan", + "Lan" + ], + "x-ms-enum": { + "name": "VMSwitchType", + "modelAsString": true + } + } + } + }, + "NetworkInterfaceIPConfiguration": { + "description": "Network interface IP configuration properties.", + "properties": { + "ipAllocationMethod": { + "type": "string", + "description": "IP address allocation method.", + "enum": [ + "Unknown", + "Static", + "Dynamic" + ], + "x-ms-enum": { + "name": "IPAllocationMethod", + "modelAsString": true + } + }, + "ipAddress": { + "type": "string", + "description": "The value of the IP address." + }, + "subnet": { + "type": "string", + "description": "The value of the subnet." + }, + "gateway": { + "type": "string", + "description": "The value of the gateway." + }, + "ipVersion": { + "type": "string", + "description": "IP address version.", + "enum": [ + "Unknown", + "IPv4" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true + } + }, + "dnsServers": { + "type": "array", + "description": "The list of DNS servers IP addresses.", + "items": { + "type": "string" + } + } + } + }, + "UserDataTemplate": { + "type": "object", + "description": "The user data template." + }, + "UserDataParameters": { + "type": "object", + "description": "The user data parameters." + }, + "ManagedApplicationParameters": { + "type": "object", + "description": "The parameters for the managed application." + }, + "SkuType": { + "type": "string", + "description": "Sku type.", + "enum": [ + "Unknown", + "EvolvedPacketCore", + "SDWAN", + "Firewall" + ], + "x-ms-enum": { + "name": "SkuType", + "modelAsString": true + } + }, + "OsProfile": { + "properties": { + "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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "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/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "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.

    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/en-us/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/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "customDataRequired": { + "type": "boolean", + "default": true, + "description": "Indicates if custom data is required to deploy this role." + } + }, + "description": "Specifies the operating system settings for the role instance." + }, + "LinuxConfiguration": { + "properties": { + "ssh": { + "$ref": "#/definitions/SshConfiguration", + "description": "Specifies the ssh key configuration for a Linux OS." + } + }, + "description": "Specifies the Linux operating system settings on the virtual machine." + }, + "SshConfiguration": { + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKey" + }, + "description": "The list of SSH public keys used to authenticate with linux based VMs." + } + }, + "description": "SSH configuration for Linux based VMs running on Azure" + }, + "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/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + } + }, + "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed." + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/device.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/device.json new file mode 100644 index 000000000000..d4692cac491c --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/device.json @@ -0,0 +1,481 @@ +{ + "swagger": "2.0", + "info": { + "title": "HybridNetworkManagementClient", + "description": "The resources in this swagger specification will be used to manage the Hybrid Network device.", + "version": "2021-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/devices/{deviceName}": { + "delete": { + "tags": [ + "Devices" + ], + "operationId": "Devices_Delete", + "description": "Deletes the specified device.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "deviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the device resource." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation is successful." + }, + "202": { + "description": "Accepted. Sets the provisioningState to 'Deleting' until the operation is completed. Returns an operation URI that can be queried to find the current state of the operation." + }, + "204": { + "description": "Request is successful. Resource with the specified name does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete device resource": { + "$ref": "./examples/DeviceDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Devices" + ], + "operationId": "Devices_Get", + "description": "Gets information about the specified device.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "deviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the device resource." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns the resulting device resource.", + "schema": { + "$ref": "#/definitions/Device" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get device resource": { + "$ref": "./examples/DeviceGet.json" + } + } + }, + "put": { + "tags": [ + "Devices" + ], + "operationId": "Devices_CreateOrUpdate", + "description": "Creates or updates a device.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "deviceName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource name for the device resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Device" + }, + "description": "Parameters supplied to the create or update device operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Creation or update is successful.", + "schema": { + "$ref": "#/definitions/Device" + } + }, + "201": { + "description": "Creation or update is successful. The header contains 'Azure-AsyncOperation' header pointing to an operations resource. The operation URI can be queried to find the current state of the operation.", + "schema": { + "$ref": "#/definitions/Device" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update device": { + "$ref": "./examples/DeviceCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "Devices" + ], + "operationId": "Devices_UpdateTags", + "description": "Updates device tags.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "deviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the device resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./common.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to the update device tags operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update is successful. The operation returns the resulting device resource.", + "schema": { + "$ref": "#/definitions/Device" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update hybrid network device tags": { + "$ref": "./examples/DeviceUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridNetwork/devices": { + "get": { + "tags": [ + "Devices" + ], + "operationId": "Devices_ListBySubscription", + "description": "Lists all the devices in a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns a list of device resources.", + "schema": { + "$ref": "#/definitions/DeviceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List all devices in a subscription.": { + "$ref": "./examples/DeviceListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/devices": { + "get": { + "tags": [ + "Devices" + ], + "operationId": "Devices_ListByResourceGroup", + "description": "Lists all the device resource in a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns a list of device resources.", + "schema": { + "$ref": "#/definitions/DeviceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List all devices in resource group": { + "$ref": "./examples/DeviceListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/devices/{deviceName}/listRegistrationKey": { + "post": { + "tags": [ + "Devices" + ], + "operationId": "Devices_ListRegistrationKey", + "description": "List the registration key for the device.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "deviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the device resource." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The registration key information for the device.", + "schema": { + "$ref": "#/definitions/DeviceRegistrationKey" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get device registration key": { + "$ref": "./examples/DeviceListRegistrationKey.json" + } + } + } + } + }, + "definitions": { + "Device": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DevicePropertiesFormat", + "description": "Device properties." + }, + "systemData": { + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "description": "Device resource." + }, + "DevicePropertiesFormat": { + "description": "Device properties.", + "required": [ + "deviceType" + ], + "discriminator": "deviceType", + "properties": { + "status": { + "type": "string", + "readOnly": true, + "description": "The current device status.", + "enum": [ + "Unknown", + "NotRegistered", + "Registered", + "Deleted" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true + } + }, + "provisioningState": { + "readOnly": true, + "$ref": "./common.json#/definitions/ProvisioningState", + "description": "The provisioning state of the device resource." + }, + "deviceType": { + "type": "string", + "description": "The type of the device.", + "enum": [ + "Unknown", + "AzureStackEdge" + ], + "x-ms-enum": { + "name": "DeviceType", + "modelAsString": true + } + }, + "azureStackEdge": { + "x-ms-discriminator-value": "AzureStackEdge", + "$ref": "./common.json#/definitions/SubResource", + "description": "The reference to the Azure stack edge device. Once set, it cannot be updated." + }, + "networkFunctions": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./common.json#/definitions/SubResource" + }, + "description": "The list of network functions deployed on the device." + } + } + }, + "DeviceRegistrationKey": { + "description": "The device registration key.", + "properties": { + "registrationKey": { + "readOnly": true, + "type": "string", + "description": "The registration key for the device." + } + } + }, + "DeviceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Device" + }, + "description": "A list of devices." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "Response for devices API service call." + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/DeviceCreate.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/DeviceCreate.json new file mode 100644 index 000000000000..f353b608a9c6 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/DeviceCreate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "deviceName": "TestDevice", + "parameters": { + "location": "eastus", + "properties": { + "deviceType": "AzureStackEdge", + "azureStackEdge": { + "id": "/subscriptions/subid1/resourcegroups/rg2/providers/Microsoft.DataboxEdge/DataboxEdgeDevices/TestDataboxEdgeDeviceName" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/devices/TestDevice", + "name": "TestDevice", + "type": "Microsoft.HybridNetwork/devices", + "location": "eastus", + "properties": { + "status": "NotRegistered", + "provisioningState": "Succeeded", + "deviceType": "AzureStackEdge", + "azureStackEdge": { + "id": "/subscriptions/subid1/resourcegroups/rg2/providers/Microsoft.DataboxEdge/DataboxEdgeDevices/TestDataboxEdgeDeviceName" + }, + "networkFunctions": null + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/devices/TestDevice", + "name": "TestDevice", + "type": "Microsoft.HybridNetwork/devices", + "location": "eastus", + "properties": { + "status": "NotRegistered", + "provisioningState": "Accepted", + "deviceType": "AzureStackEdge", + "azureStackEdge": { + "id": "/subscriptions/subid1/resourcegroups/rg2/providers/Microsoft.DataboxEdge/DataboxEdgeDevices/TestDataboxEdgeDeviceName" + }, + "networkFunctions": null + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/DeviceDelete.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/DeviceDelete.json new file mode 100644 index 000000000000..d7903ba0e891 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/DeviceDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "deviceName": "TestDevice" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/DeviceGet.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/DeviceGet.json new file mode 100644 index 000000000000..dfd79d2f2c9e --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/DeviceGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "deviceName": "TestDevice" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/devices/TestDevice", + "name": "TestDevice", + "type": "Microsoft.HybridNetwork/devices", + "location": "eastus", + "properties": { + "status": "NotRegistered", + "provisioningState": "Succeeded", + "deviceType": "AzureStackEdge", + "azureStackEdge": { + "id": "/subscriptions/subid1/resourcegroups/rg2/providers/Microsoft.DataboxEdge/DataboxEdgeDevices/TestDataboxEdgeDeviceName" + }, + "networkFunctions": [ + { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.HybridNetwork/networkFunctions/TestNetworkFunction" + } + ] + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/DeviceListByResourceGroup.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/DeviceListByResourceGroup.json new file mode 100644 index 000000000000..a3a110163dd1 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/DeviceListByResourceGroup.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/devices/TestDevice", + "name": "TestDevice", + "type": "Microsoft.HybridNetwork/devices", + "location": "eastus", + "properties": { + "status": "NotRegistered", + "provisioningState": "Succeeded", + "deviceType": "AzureStackEdge", + "azureStackEdge": { + "id": "/subscriptions/subid1/resourcegroups/rg2/providers/Microsoft.DataboxEdge/DataboxEdgeDevices/TestDataboxEdgeDeviceName" + }, + "networkFunctions": [ + { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.HybridNetwork/networkFunctions/TestVirtualNetworkFunction" + } + ] + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/DeviceListBySubscription.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/DeviceListBySubscription.json new file mode 100644 index 000000000000..3b653fded613 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/DeviceListBySubscription.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/devices/TestDevice", + "name": "TestDevice", + "type": "Microsoft.HybridNetwork/devices", + "location": "eastus", + "properties": { + "status": "NotRegistered", + "provisioningState": "Succeeded", + "deviceType": "AzureStackEdge", + "azureStackEdge": { + "id": "/subscriptions/subid1/resourcegroups/rg2/providers/Microsoft.DataboxEdge/DataboxEdgeDevices/TestDataboxEdgeDeviceName" + }, + "networkFunctions": [ + { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.HybridNetwork/networkFunctions/TestNetworkFunction" + } + ] + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/DeviceListRegistrationKey.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/DeviceListRegistrationKey.json new file mode 100644 index 000000000000..36bbbdd81343 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/DeviceListRegistrationKey.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "deviceName": "TestDevice" + }, + "responses": { + "200": { + "body": { + "registrationKey": "TestRegistartionKey" + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/DeviceUpdateTags.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/DeviceUpdateTags.json new file mode 100644 index 000000000000..8f9b0cfa2422 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/DeviceUpdateTags.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "deviceName": "TestDevice", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/devices/TestDevice", + "name": "TestDevice", + "type": "Microsoft.HybridNetwork/devices", + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "status": "NotRegistered", + "provisioningState": "Succeeded", + "deviceType": "AzureStackEdge", + "azureStackEdge": { + "id": "/subscriptions/subid1/resourcegroups/rg2/providers/Microsoft.DataboxEdge/DataboxEdgeDevices/TestDataboxEdgeDeviceName" + }, + "networkFunctions": [ + { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.HybridNetwork/networkFunctions/TestNetworkFunction" + } + ] + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/GetOperations.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/GetOperations.json new file mode 100644 index 000000000000..4371f25d9036 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/GetOperations.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "location": "westus", + "api-version": "2021-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.HybridNetwork/nfs/read", + "display": { + "provider": "Microsoft Hybrid Network", + "resource": "Nf", + "operation": "Get Nf", + "description": "Gets Nf" + } + } + ] + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/NetworkFunctionCreate.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/NetworkFunctionCreate.json new file mode 100644 index 000000000000..987652dec9c7 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/NetworkFunctionCreate.json @@ -0,0 +1,182 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "networkFunctionName": "testNf", + "parameters": { + "location": "eastus", + "properties": { + "device": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/devices/testDevice" + }, + "skuName": "testSku", + "skuType": "SDWAN", + "vendorName": "testVendor", + "managedApplicationParameters": {}, + "networkFunctionUserConfigurations": [ + { + "roleName": "testRole", + "userDataParameters": {}, + "networkInterfaces": [ + { + "networkInterfaceName": "nic1", + "macAddress": "", + "vmSwitchType": "Management", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + }, + { + "networkInterfaceName": "nic2", + "macAddress": "DC-97-F8-79-16-7D", + "vmSwitchType": "Wan", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf", + "name": "testNf", + "type": "Microsoft.HybridNetwork/networkFunctions", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "device": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/devices/testDevice" + }, + "skuName": "testSku", + "skuType": "SDWAN", + "vendorName": "testVendor", + "serviceKey": "testServiceKey", + "vendorProvisioningState": "NotProvisioned", + "managedApplication": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Solutions/applications/testServiceKey" + }, + "managedApplicationParameters": {}, + "networkFunctionUserConfigurations": [ + { + "roleName": "testRole", + "userDataParameters": {}, + "networkInterfaces": [ + { + "networkInterfaceName": "nic1", + "macAddress": "", + "vmSwitchType": "Management", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + }, + { + "networkInterfaceName": "nic2", + "macAddress": "DC-97-F8-79-16-7D", + "vmSwitchType": "Wan", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + } + ] + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf", + "name": "testNf", + "type": "Microsoft.HybridNetwork/networkFunctions", + "location": "eastus", + "properties": { + "provisioningState": "Accepted", + "device": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/devices/testDevice" + }, + "skuName": "testSku", + "skuType": "SDWAN", + "vendorName": "testVendor", + "serviceKey": "testServiceKey", + "vendorProvisioningState": "NotProvisioned", + "managedApplication": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Solutions/applications/testServiceKey" + }, + "managedApplicationParameters": {}, + "networkFunctionUserConfigurations": [ + { + "roleName": "testRole", + "userDataParameters": {}, + "networkInterfaces": [ + { + "networkInterfaceName": "nic1", + "macAddress": "", + "vmSwitchType": "Management", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + }, + { + "networkInterfaceName": "nic2", + "macAddress": "DC-97-F8-79-16-7D", + "vmSwitchType": "Wan", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/NetworkFunctionDelete.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/NetworkFunctionDelete.json new file mode 100644 index 000000000000..c81a9c018d45 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/NetworkFunctionDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "networkFunctionName": "testNf" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/NetworkFunctionGet.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/NetworkFunctionGet.json new file mode 100644 index 000000000000..e167385e8587 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/NetworkFunctionGet.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "networkFunctionName": "testNf" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf", + "name": "testNf", + "type": "Microsoft.HybridNetwork/networkFunctions", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "device": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/devices/testDevice" + }, + "skuName": "testSku", + "skuType": "SDWAN", + "vendorName": "testVendor", + "serviceKey": "testServiceKey", + "vendorProvisioningState": "NotProvisioned", + "managedApplication": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Solutions/applications/testServiceKey" + }, + "managedApplicationParameters": {}, + "networkFunctionUserConfigurations": [ + { + "roleName": "testRole", + "userDataParameters": {}, + "networkInterfaces": [ + { + "networkInterfaceName": "nic1", + "macAddress": "", + "vmSwitchType": "Management", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + }, + { + "networkInterfaceName": "nic2", + "macAddress": "DC-97-F8-79-16-7D", + "vmSwitchType": "Wan", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/NetworkFunctionListByResourceGroup.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/NetworkFunctionListByResourceGroup.json new file mode 100644 index 000000000000..80adbf2ce863 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/NetworkFunctionListByResourceGroup.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf", + "name": "testNf", + "type": "Microsoft.HybridNetwork/networkFunctions", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "device": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/devices/testDevice" + }, + "skuName": "testSku", + "skuType": "SDWAN", + "vendorName": "testVendor", + "serviceKey": "testServiceKey", + "vendorProvisioningState": "NotProvisioned", + "managedApplication": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Solutions/applications/testServiceKey" + }, + "managedApplicationParameters": {}, + "networkFunctionUserConfigurations": [ + { + "roleName": "testRole", + "userDataParameters": {}, + "networkInterfaces": [ + { + "networkInterfaceName": "nic1", + "macAddress": "", + "vmSwitchType": "Management", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + }, + { + "networkInterfaceName": "nic2", + "macAddress": "DC-97-F8-79-16-7D", + "vmSwitchType": "Wan", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + } + ] + } + ] + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/NetworkFunctionListBySubscription.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/NetworkFunctionListBySubscription.json new file mode 100644 index 000000000000..06c46d1bc7fe --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/NetworkFunctionListBySubscription.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf", + "name": "testNf", + "type": "Microsoft.HybridNetwork/networkFunctions", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "device": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/devices/testDevice" + }, + "skuName": "testSku", + "skuType": "SDWAN", + "vendorName": "testVendor", + "serviceKey": "testServiceKey", + "vendorProvisioningState": "NotProvisioned", + "managedApplication": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Solutions/applications/testServiceKey" + }, + "managedApplicationParameters": {}, + "networkFunctionUserConfigurations": [ + { + "roleName": "testRole", + "userDataParameters": {}, + "networkInterfaces": [ + { + "networkInterfaceName": "nic1", + "macAddress": "", + "vmSwitchType": "Management", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + }, + { + "networkInterfaceName": "nic2", + "macAddress": "DC-97-F8-79-16-7D", + "vmSwitchType": "Wan", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + } + ] + } + ] + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/NetworkFunctionSkuDetailsGet.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/NetworkFunctionSkuDetailsGet.json new file mode 100644 index 000000000000..ce0279fa6a28 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/NetworkFunctionSkuDetailsGet.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "vendorName": "testVendor", + "vendorSkuName": "testSku" + }, + "responses": { + "200": { + "body": { + "skuType": "SDWAN", + "value": [ + { + "roleName": "testRole", + "userDataTemplate": {}, + "userDataParameters": {}, + "networkInterfaces": [ + { + "networkInterfaceName": "nic1", + "macAddress": "", + "vmSwitchType": "Management", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + }, + { + "networkInterfaceName": "nic2", + "macAddress": "", + "vmSwitchType": "Wan", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + } + ] + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/NetworkFunctionSkuListByVendor.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/NetworkFunctionSkuListByVendor.json new file mode 100644 index 000000000000..3bd3e600b533 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/NetworkFunctionSkuListByVendor.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "vendorName": "testVendor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "skuName": "testSku", + "skuType": "SDWAN" + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/NetworkFunctionUpdateTags.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/NetworkFunctionUpdateTags.json new file mode 100644 index 000000000000..e3e0821fd0aa --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/NetworkFunctionUpdateTags.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "networkFunctionName": "testNf", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf", + "name": "testNf", + "type": "Microsoft.HybridNetwork/networkFunctions", + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "device": { + "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/devices/testDevice" + }, + "skuName": "testSku", + "skuType": "SDWAN", + "vendorName": "testVendor", + "serviceKey": "testServiceKey", + "vendorProvisioningState": "NotProvisioned", + "managedApplication": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Solutions/applications/testServiceKey" + }, + "managedApplicationParameters": {}, + "networkFunctionUserConfigurations": [ + { + "roleName": "testRole", + "userDataParameters": {}, + "networkInterfaces": [ + { + "networkInterfaceName": "nic1", + "macAddress": "", + "vmSwitchType": "Management", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + }, + { + "networkInterfaceName": "nic2", + "macAddress": "DC-97-F8-79-16-7D", + "vmSwitchType": "Wan", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/NetworkFunctionVendorAndSkuListBySubscription.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/NetworkFunctionVendorAndSkuListBySubscription.json new file mode 100644 index 000000000000..5ed4c0117e6c --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/NetworkFunctionVendorAndSkuListBySubscription.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "vendorName": "testVendor", + "skuList": [ + { + "skuName": "testSku", + "skuType": "SDWAN" + } + ] + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/RoleInstanceGet.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/RoleInstanceGet.json new file mode 100644 index 000000000000..22887e9522e8 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/RoleInstanceGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "locationName": "eastus", + "vendorName": "testVendor", + "serviceKey": "testServiceKey", + "roleInstanceName": "mrm" + }, + "responses": { + "200": { + "body": { + "name": "mrm", + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/locations/eastus/vendors/testVendor/networkFunctions/testServiceKey/roleInstances/mrm", + "type": "Microsoft.HybridNetwork/locations/vendors/networkFunctions/roleInstances", + "properties": { + "operationalState": "Running" + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/RoleInstanceListByVendorNetworkFunction.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/RoleInstanceListByVendorNetworkFunction.json new file mode 100644 index 000000000000..60c694b2cd07 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/RoleInstanceListByVendorNetworkFunction.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "locationName": "eastus", + "vendorName": "testVendor", + "serviceKey": "testServiceKey" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mrm", + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/locations/eastus/vendors/testVendor/networkFunctions/testServiceKey/roleInstances/mrm", + "type": "Microsoft.HybridNetwork/locations/vendors/networkFunctions/roleInstances", + "properties": { + "operationalState": "Running" + } + }, + { + "name": "msm", + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/locations/eastus/vendors/testVendor/networkFunctions/testServiceKey/roleInstances/msm", + "type": "Microsoft.HybridNetwork/locations/vendors/networkFunctions/roleInstances", + "properties": { + "operationalState": "Stopped" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/RoleInstanceRestart.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/RoleInstanceRestart.json new file mode 100644 index 000000000000..d37564dc805b --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/RoleInstanceRestart.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "locationName": "eastus", + "vendorName": "testVendor", + "serviceKey": "testServiceKey", + "roleInstanceName": "mrm" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/RoleInstanceStart.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/RoleInstanceStart.json new file mode 100644 index 000000000000..d37564dc805b --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/RoleInstanceStart.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "locationName": "eastus", + "vendorName": "testVendor", + "serviceKey": "testServiceKey", + "roleInstanceName": "mrm" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/RoleInstanceStop.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/RoleInstanceStop.json new file mode 100644 index 000000000000..d37564dc805b --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/RoleInstanceStop.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "locationName": "eastus", + "vendorName": "testVendor", + "serviceKey": "testServiceKey", + "roleInstanceName": "mrm" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorCreate.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorCreate.json new file mode 100644 index 000000000000..9388b2e941dd --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorCreate.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "vendorName": "TestVendor", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "name": "TestVendor", + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/vendors/TestVendor", + "type": "Microsoft.HybridNetwork/vendors", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "TestVendor", + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/vendors/TestVendor", + "type": "Microsoft.HybridNetwork/vendors", + "properties": { + "provisioningState": "Accepted" + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorDelete.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorDelete.json new file mode 100644 index 000000000000..f0caa7c311fd --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "vendorName": "TestVendor" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorGet.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorGet.json new file mode 100644 index 000000000000..83f18e17d174 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "vendorName": "TestVendor" + }, + "responses": { + "200": { + "body": { + "name": "TestVendor", + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/vendors/TestVendor", + "type": "Microsoft.HybridNetwork/vendors", + "properties": { + "provisioningState": "Succeeded", + "skus": [ + { + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/vendors/TestVendor/skus/TestVendorSku" + } + ] + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorListBySubscription.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorListBySubscription.json new file mode 100644 index 000000000000..fb7911aba9eb --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorListBySubscription.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestVendor", + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/vendors/TestVendor", + "type": "Microsoft.HybridNetwork/vendors", + "properties": { + "provisioningState": "Succeeded", + "skus": [ + { + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/vendors/TestVendor/vendorskus/TestVendorSku1" + } + ] + } + }, + { + "name": "TestVendor2", + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/vendors/TestVendor2", + "type": "Microsoft.HybridNetwork/vendors", + "properties": { + "provisioningState": "Succeeded", + "skus": [ + { + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/vendors/TestVendor/vendorskus/TestVendorSku2" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorNfCreate.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorNfCreate.json new file mode 100644 index 000000000000..ef15f4a561c6 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorNfCreate.json @@ -0,0 +1,199 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "locationName": "eastus", + "vendorName": "testVendor", + "serviceKey": "testServiceKey", + "parameters": { + "properties": { + "skuType": "SDWAN", + "vendorProvisioningState": "Provisioning", + "networkFunctionVendorConfigurations": [ + { + "roleName": "testRole", + "osProfile": { + "adminUsername": "dummyuser", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "home/user/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAgEAwrr66r8n6B8Y0zMF3dOpXEapIQD9DiYQ6D6/zwor9o39jSkHNiMMER/GETBbzP83LOcekm02aRjo55ArO7gPPVvCXbrirJu9pkm4AC4BBre5xSLS= user@constoso-DSH" + } + ] + } + }, + "customData": "base-64 encoded string of custom data" + }, + "userDataParameters": {}, + "networkInterfaces": [ + { + "networkInterfaceName": "nic1", + "macAddress": "", + "vmSwitchType": "Management", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + }, + { + "networkInterfaceName": "nic2", + "macAddress": "DC-97-F8-79-16-7D", + "vmSwitchType": "Wan", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/locations/eastus/vendors/testVendor/networkFunctions/testServiceKey", + "name": "testServiceKey", + "type": "Microsoft.HybridNetwork/locations/vendors/networkFunctions", + "properties": { + "provisioningState": "Succeeded", + "vendorProvisioningState": "Provisioning", + "skuName": "testSku", + "skuType": "SDWAN", + "networkFunctionVendorConfigurations": [ + { + "roleName": "testRole", + "osProfile": { + "adminUsername": "dummyuser", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "home/user/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAgEAwrr66r8n6B8Y0zMF3dOpXEapIQD9DiYQ6D6/zwor9o39jSkHNiMMER/GETBbzP83LOcekm02aRjo55ArO7gPPVvCXbrirJu9pkm4AC4BBre5xSLS= user@constoso-DSH" + } + ] + } + }, + "customData": "base-64 encoded string of custom data" + }, + "userDataParameters": {}, + "networkInterfaces": [ + { + "networkInterfaceName": "nic1", + "macAddress": "", + "vmSwitchType": "Management", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + }, + { + "networkInterfaceName": "nic2", + "macAddress": "DC-97-F8-79-16-7D", + "vmSwitchType": "Wan", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + } + ] + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/locations/eastus/vendors/testVendor/networkFunctions/testServiceKey", + "name": "testServiceKey", + "type": "Microsoft.HybridNetwork/locations/vendors/networkFunctions", + "properties": { + "provisioningState": "Accepted", + "vendorProvisioningState": "Provisioning", + "skuName": "testSku", + "skuType": "SDWAN", + "networkFunctionVendorConfigurations": [ + { + "roleName": "testRole", + "osProfile": { + "adminUsername": "dummyuser", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "home/user/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAgEAwrr66r8n6B8Y0zMF3dOpXEapIQD9DiYQ6D6/zwor9o39jSkHNiMMER/GETBbzP83LOcekm02aRjo55ArO7gPPVvCXbrirJu9pkm4AC4BBre5xSLS= user@constoso-DSH" + } + ] + } + }, + "customData": "base-64 encoded string of custom data" + }, + "userDataParameters": {}, + "networkInterfaces": [ + { + "networkInterfaceName": "nic1", + "macAddress": "", + "vmSwitchType": "Management", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + }, + { + "networkInterfaceName": "nic2", + "macAddress": "DC-97-F8-79-16-7D", + "vmSwitchType": "Wan", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorNfGet.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorNfGet.json new file mode 100644 index 000000000000..c4b37936af95 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorNfGet.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "locationName": "eastus", + "vendorName": "testVendor", + "serviceKey": "testServiceKey" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/locations/eastus/vendors/testVendor/networkFunctions/testServiceKey", + "name": "testServiceKey", + "type": "Microsoft.HybridNetwork/locations/vendors/networkFunctions", + "properties": { + "provisioningState": "Succeeded", + "vendorProvisioningState": "Provisioning", + "skuName": "testSku", + "skuType": "SDWAN", + "networkFunctionVendorConfigurations": [ + { + "roleName": "testRole", + "osProfile": { + "adminUsername": "dummyuser", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "home/user/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAgEAwrr66r8n6B8Y0zMF3dOpXEapIQD9DiYQ6D6/zwor9o39jSkHNiMMER/GETBbzP83LOcekm02aRjo55ArO7gPPVvCXbrirJu9pkm4AC4BBre5xSLS= user@constoso-DSH" + } + ] + } + }, + "customData": "base-64 encoded string of custom data" + }, + "userDataParameters": {}, + "networkInterfaces": [ + { + "networkInterfaceName": "nic1", + "macAddress": "", + "vmSwitchType": "Management", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + }, + { + "networkInterfaceName": "nic2", + "macAddress": "DC-97-F8-79-16-7D", + "vmSwitchType": "Wan", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorNfListByVendor.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorNfListByVendor.json new file mode 100644 index 000000000000..e556d8660caf --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorNfListByVendor.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "locationName": "eastus", + "vendorName": "testVendor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/locations/eastus/vendors/testVendor/networkFunctions/testServiceKey", + "name": "TestServiceKey", + "type": "Microsoft.HybridNetwork/locations/vendors/networkFunctions", + "properties": { + "provisioningState": "Succeeded", + "vendorProvisioningState": "Provisioning", + "skuName": "testSku", + "skuType": "SDWAN", + "networkFunctionVendorConfigurations": [ + { + "roleName": "testRole", + "osProfile": { + "adminUsername": "dummyuser", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "home/user/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAgEAwrr66r8n6B8Y0zMF3dOpXEapIQD9DiYQ6D6/zwor9o39jSkHNiMMER/GETBbzP83LOcekm02aRjo55ArO7gPPVvCXbrirJu9pkm4AC4BBre5xSLS= user@constoso-DSH" + } + ] + } + }, + "customData": "base-64 encoded string of custom data" + }, + "userDataParameters": {}, + "networkInterfaces": [ + { + "networkInterfaceName": "nic1", + "macAddress": "", + "vmSwitchType": "Management", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + }, + { + "networkInterfaceName": "nic2", + "macAddress": "DC-97-F8-79-16-7D", + "vmSwitchType": "Wan", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + } + ] + } + ] + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorSkuCreate.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorSkuCreate.json new file mode 100644 index 000000000000..af345708be81 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorSkuCreate.json @@ -0,0 +1,282 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "vendorName": "TestVendor", + "skuName": "TestSku", + "parameters": { + "properties": { + "deploymentMode": "PrivateEdgeZone", + "preview": true, + "managedApplicationTemplate": {}, + "networkFunctionTemplate": { + "networkFunctionRoleConfigurations": [ + { + "roleName": "test", + "roleType": "VirtualMachine", + "virtualMachineSize": "Standard_D3_v2", + "storageProfile": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "18.04-LTS", + "version": "18.04.201804262" + }, + "osDisk": { + "osType": "Linux", + "name": "vhdName", + "diskSizeGB": 30, + "vhd": { + "uri": "https://contoso.net/link/vnd.vhd?sp=rl&st=2020-10-08T20:38:19Z&se=2020-12-09T19:38:00Z&sv=2019-12-12&sr=b&sig=7BM2f4yOw%3D" + } + }, + "dataDisks": [ + { + "createOption": "Empty", + "name": "DataDisk1", + "diskSizeGB": 10 + } + ] + }, + "osProfile": { + "adminUsername": "dummyuser", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "home/user/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAgEAwrr66r8n6B8Y0zMF3dOpXEapIQD9DiYQ6D6/zwor9o39jSkHNiMMER/GETBbzP83LOcekm02aRjo55ArO7gPPVvCXbrirJu9pkm4AC4BBre5xSLS= user@constoso-DSH" + } + ] + } + }, + "customData": "base-64 encoded string of custom data" + }, + "customProfile": { + "metadataConfigurationPath": "/var/logs/network.cfg" + }, + "networkInterfaces": [ + { + "networkInterfaceName": "nic1", + "macAddress": "", + "vmSwitchType": "Wan", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + }, + { + "networkInterfaceName": "nic2", + "macAddress": "", + "vmSwitchType": "Management", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + } + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "TestSku", + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/vendors/TestVendor/vendorskus/TestSku", + "type": "Microsoft.HybridNetwork/vendors/vendorskus", + "properties": { + "deploymentMode": "PrivateEdgeZone", + "preview": true, + "provisioningState": "Succeeded", + "managedApplicationTemplate": {}, + "networkFunctionTemplate": { + "networkFunctionRoleConfigurations": [ + { + "roleName": "test", + "roleType": "VirtualMachine", + "virtualMachineSize": "Standard_D3_v2", + "storageProfile": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "18.04-LTS", + "version": "18.04.201804262" + }, + "osDisk": { + "osType": "Linux", + "name": "vhdName", + "diskSizeGB": 30, + "vhd": {} + }, + "dataDisks": [ + { + "createOption": "Empty", + "name": "DataDisk1", + "diskSizeGB": 10 + } + ] + }, + "osProfile": { + "adminUsername": "dummyuser", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "home/user/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAgEAwrr66r8n6B8Y0zMF3dOpXEapIQD9DiYQ6D6/zwor9o39jSkHNiMMER/GETBbzP83LOcekm02aRjo55ArO7gPPVvCXbrirJu9pkm4AC4BBre5xSLS= user@constoso-DSH" + } + ] + } + }, + "customData": "base-64 encoded string of custom data" + }, + "customProfile": { + "metadataConfigurationPath": "/var/logs/network.cfg" + }, + "networkInterfaces": [ + { + "networkInterfaceName": "nic1", + "macAddress": "", + "vmSwitchType": "Wan", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + }, + { + "networkInterfaceName": "nic2", + "macAddress": "", + "vmSwitchType": "Management", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + } + ] + } + ] + } + } + } + }, + "201": { + "body": { + "name": "TestSku", + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/vendors/TestVendor/vendorskus/TestSku", + "type": "Microsoft.HybridNetwork/vendors/vendorskus", + "properties": { + "deploymentMode": "PrivateEdgeZone", + "preview": true, + "provisioningState": "Accepted", + "managedApplicationTemplate": {}, + "networkFunctionTemplate": { + "networkFunctionRoleConfigurations": [ + { + "roleName": "test", + "roleType": "VirtualMachine", + "virtualMachineSize": "Standard_D3_v2", + "storageProfile": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "18.04-LTS", + "version": "18.04.201804262" + }, + "osDisk": { + "osType": "Linux", + "name": "vhdName", + "diskSizeGB": 30, + "vhd": {} + }, + "dataDisks": [ + { + "createOption": "Empty", + "name": "DataDisk1", + "diskSizeGB": 10 + } + ] + }, + "osProfile": { + "adminUsername": "dummyuser", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "home/user/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAgEAwrr66r8n6B8Y0zMF3dOpXEapIQD9DiYQ6D6/zwor9o39jSkHNiMMER/GETBbzP83LOcekm02aRjo55ArO7gPPVvCXbrirJu9pkm4AC4BBre5xSLS= user@constoso-DSH" + } + ] + } + }, + "customData": "base-64 encoded string of custom data" + }, + "customProfile": { + "metadataConfigurationPath": "/var/logs/network.cfg" + }, + "networkInterfaces": [ + { + "networkInterfaceName": "nic1", + "macAddress": "", + "vmSwitchType": "", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + }, + { + "networkInterfaceName": "nic2", + "macAddress": "", + "vmSwitchType": "", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + } + ] + } + ] + } + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorSkuDelete.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorSkuDelete.json new file mode 100644 index 000000000000..036dce6f1a6b --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorSkuDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "vendorName": "TestVendor", + "skuName": "TestSku" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorSkuGet.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorSkuGet.json new file mode 100644 index 000000000000..e75c8dfeef0a --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorSkuGet.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "vendorName": "TestVendor", + "skuName": "TestSku" + }, + "responses": { + "200": { + "body": { + "name": "TestSku", + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/vendors/TestVendor/vendorskus/TestSku", + "type": "Microsoft.HybridNetwork/vendors/vendorskus", + "properties": { + "deploymentMode": "PrivateEdgeZone", + "preview": true, + "provisioningState": "Succeeded", + "managedApplicationTemplate": {}, + "networkFunctionTemplate": { + "networkFunctionRoleConfigurations": [ + { + "roleName": "test", + "roleType": "VirtualMachine", + "virtualMachineSize": "Standard_D3_v2", + "storageProfile": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "18.04-LTS", + "version": "18.04.201804262" + }, + "osDisk": { + "osType": "Linux", + "name": "vhdName", + "diskSizeGB": 30, + "vhd": {} + }, + "dataDisks": [ + { + "createOption": "Empty", + "name": "DataDisk1", + "diskSizeGB": 10 + } + ] + }, + "osProfile": { + "adminUsername": "dummyuser", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "home/user/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAgEAwrr66r8n6B8Y0zMF3dOpXEapIQD9DiYQ6D6/zwor9o39jSkHNiMMER/GETBbzP83LOcekm02aRjo55ArO7gPPVvCXbrirJu9pkm4AC4BBre5xSLS= user@constoso-DSH" + } + ] + } + }, + "customData": "base-64 encoded string of custom data" + }, + "customProfile": { + "metadataConfigurationPath": "/var/logs/network.cfg" + }, + "networkInterfaces": [ + { + "networkInterfaceName": "nic1", + "macAddress": "", + "vmSwitchType": "", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + }, + { + "networkInterfaceName": "nic2", + "macAddress": "", + "vmSwitchType": "", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + } + ] + } + ] + } + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorSkuListByVendor.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorSkuListByVendor.json new file mode 100644 index 000000000000..cf6a781f6697 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorSkuListByVendor.json @@ -0,0 +1,195 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "vendorName": "TestVendor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestSku1", + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/vendors/TestVendor/vendorskus/TestSku1", + "type": "Microsoft.HybridNetwork/vendors/vendorskus", + "properties": { + "deploymentMode": "PrivateEdgeZone", + "preview": true, + "provisioningState": "Succeeded", + "managedApplicationTemplate": {}, + "networkFunctionTemplate": { + "networkFunctionRoleConfigurations": [ + { + "roleName": "test", + "roleType": "VirtualMachine", + "virtualMachineSize": "Standard_D3_v2", + "storageProfile": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "18.04-LTS", + "version": "18.04.201804262" + }, + "osDisk": { + "osType": "Linux", + "name": "vhdName", + "diskSizeGB": 30, + "vhd": {} + }, + "dataDisks": [ + { + "createOption": "Empty", + "name": "DataDisk1", + "diskSizeGB": 10 + } + ] + }, + "osProfile": { + "adminUsername": "dummyuser", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "home/user/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAgEAwrr66r8n6B8Y0zMF3dOpXEapIQD9DiYQ6D6/zwor9o39jSkHNiMMER/GETBbzP83LOcekm02aRjo55ArO7gPPVvCXbrirJu9pkm4AC4BBre5xSLS= user@constoso-DSH" + } + ] + } + }, + "customData": "base-64 encoded string of custom data" + }, + "customProfile": { + "metadataConfigurationPath": "/var/logs/network.cfg" + }, + "networkInterfaces": [ + { + "networkInterfaceName": "nic1", + "macAddress": "", + "vmSwitchType": "", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + }, + { + "networkInterfaceName": "nic2", + "macAddress": "", + "vmSwitchType": "", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + } + ] + } + ] + } + } + }, + { + "name": "TestSku2", + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/vendors/TestVendor/vendorskus/TestSku2", + "type": "Microsoft.HybridNetwork/vendors/vendorskus", + "properties": { + "deploymentMode": "PrivateEdgeZone", + "preview": true, + "provisioningState": "Succeeded", + "managedApplicationTemplate": {}, + "networkFunctionTemplate": { + "networkFunctionRoleConfigurations": [ + { + "roleName": "test", + "roleType": "VirtualMachine", + "virtualMachineSize": "Standard_D3_v2", + "storageProfile": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "18.04-LTS", + "version": "18.04.201804262" + }, + "osDisk": { + "osType": "Linux", + "name": "vhdName", + "diskSizeGB": 30, + "vhd": {} + }, + "dataDisks": [ + { + "createOption": "Empty", + "name": "DataDisk1", + "diskSizeGB": 10 + } + ] + }, + "osProfile": { + "adminUsername": "dummyuser", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "home/user/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAgEAwrr66r8n6B8Y0zMF3dOpXEapIQD9DiYQ6D6/zwor9o39jSkHNiMMER/GETBbzP83LOcekm02aRjo55ArO7gPPVvCXbrirJu9pkm4AC4BBre5xSLS= user@constoso-DSH" + } + ] + } + }, + "customData": "base-64 encoded string of custom data" + }, + "customProfile": { + "metadataConfigurationPath": "/var/logs/network.cfg" + }, + "networkInterfaces": [ + { + "networkInterfaceName": "nic1", + "macAddress": "", + "vmSwitchType": "", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + }, + { + "networkInterfaceName": "nic2", + "macAddress": "", + "vmSwitchType": "", + "ipConfigurations": [ + { + "ipAllocationMethod": "Dynamic", + "ipAddress": "", + "subnet": "", + "gateway": "", + "ipVersion": "IPv4", + "dnsServers": null + } + ] + } + ] + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorSkuPreviewCreate.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorSkuPreviewCreate.json new file mode 100644 index 000000000000..6bc6b23f3a55 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorSkuPreviewCreate.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "vendorName": "TestVendor", + "skuName": "TestSku", + "previewSubscription": "previewSub", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/vendors/TestVendor/vendorskus/TestSku/previewsubscriptions/previewSub", + "name": "previewSub", + "type": "Microsoft.HybridNetwork/vendors/vendorskus/previewsubscriptions" + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/vendors/TestVendor/vendorskus/TestSku/previewsubscriptions/previewSub", + "name": "previewSub", + "type": "Microsoft.HybridNetwork/vendors/vendorskus/previewsubscriptions" + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorSkuPreviewDelete.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorSkuPreviewDelete.json new file mode 100644 index 000000000000..0b284b876bc2 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorSkuPreviewDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "vendorName": "TestVendor", + "skuName": "TestSku", + "previewSubscription": "previewSub" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorSkuPreviewGet.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorSkuPreviewGet.json new file mode 100644 index 000000000000..371999c3a320 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorSkuPreviewGet.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "vendorName": "TestVendor", + "skuName": "TestSku", + "previewSubscription": "previewSub" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/vendors/TestVendor/vendorskus/TestSku/previewsubscriptions/previewSub", + "name": "previewSub", + "type": "Microsoft.HybridNetwork/vendors/vendorskus/previewsubscriptions" + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorSkuPreviewListBySku.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorSkuPreviewListBySku.json new file mode 100644 index 000000000000..18e0c03fb2f6 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/examples/VendorSkuPreviewListBySku.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "subscriptionId": "subid", + "vendorName": "TestVendor", + "skuName": "TestSku" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/vendors/TestVendor/vendorskus/TestSku/previewsubscriptions/previewSub1", + "name": "previewSub1", + "type": "Microsoft.HybridNetwork/vendors/vendorskus/previewsubscriptions" + }, + { + "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/vendors/TestVendor/vendorskus/TestSku/previewsubscriptions/previewSub2", + "name": "previewSub2", + "type": "Microsoft.HybridNetwork/vendors/vendorskus/previewsubscriptions" + } + ] + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/networkFunction.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/networkFunction.json new file mode 100644 index 000000000000..2c4bf170ac3c --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/networkFunction.json @@ -0,0 +1,461 @@ +{ + "swagger": "2.0", + "info": { + "title": "HybridNetworkManagementClient", + "description": "The resources in this swagger specification will be used to manage the network function deployment in a Hybrid Network resource provider.", + "version": "2021-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/networkFunctions/{networkFunctionName}": { + "delete": { + "tags": [ + "NetworkFunctions" + ], + "operationId": "NetworkFunctions_Delete", + "description": "Deletes the specified network function resource. This operation can take up to 1 hour to complete. This is expected service behavior.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFunctionName", + "description": "The name of the network function.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed successfully." + }, + "202": { + "description": "Accepted. The header contains 'Azure-AsyncOperation' header pointing to an operations resource. The operation URI can be queried to find the current state of the operation." + }, + "204": { + "description": "Request is successful. Resource with the specified name does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete network function resource": { + "$ref": "./examples/NetworkFunctionDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "NetworkFunctions" + ], + "operationId": "NetworkFunctions_Get", + "description": "Gets information about the specified network function resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFunctionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network function resource." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation is successful. The operation returns the resulting network function resource.", + "schema": { + "$ref": "#/definitions/NetworkFunction" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get network function resource": { + "$ref": "./examples/NetworkFunctionGet.json" + } + } + }, + "put": { + "tags": [ + "NetworkFunctions" + ], + "operationId": "NetworkFunctions_CreateOrUpdate", + "description": "Creates or updates a network function resource. This operation can take up to 6 hours to complete. This is expected service behavior.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFunctionName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource name for the network function resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkFunction" + }, + "description": "Parameters supplied in the body to the create or update network function operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFunction" + } + }, + "201": { + "description": "Created or Updated. The header contains 'Azure-AsyncOperation' header pointing to an operation resource. The operation URI can be queried to find the current state of the operation.", + "schema": { + "$ref": "#/definitions/NetworkFunction" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create network function resource": { + "$ref": "./examples/NetworkFunctionCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "NetworkFunctions" + ], + "operationId": "NetworkFunctions_UpdateTags", + "description": "Updates the tags for the network function resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFunctionName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource name for the network function resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./common.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to the update network function tags operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update is completed successfully. The operation returns the resulting network function resource.", + "schema": { + "$ref": "#/definitions/NetworkFunction" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update tags for network function resource": { + "$ref": "./examples/NetworkFunctionUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridNetwork/networkFunctions": { + "get": { + "description": "Lists all the network functions in a subscription.", + "operationId": "NetworkFunctions_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns a list of network function resources.", + "schema": { + "$ref": "#/definitions/NetworkFunctionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "tags": [ + "NetworkFunctions" + ], + "x-ms-examples": { + "List all network function resources in subscription.": { + "$ref": "./examples/NetworkFunctionListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/networkFunctions": { + "get": { + "tags": [ + "NetworkFunctions" + ], + "operationId": "NetworkFunctions_ListByResourceGroup", + "description": "Lists all the network function resources in a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns a list of network function resources.", + "schema": { + "$ref": "#/definitions/NetworkFunctionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List network function in resource group": { + "$ref": "./examples/NetworkFunctionListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "NetworkFunction": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkFunctionPropertiesFormat", + "description": "Network function properties." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "systemData": { + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "description": "Network function resource response." + }, + "NetworkFunctionPropertiesFormat": { + "description": "Network function properties.", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./common.json#/definitions/ProvisioningState", + "description": "The provisioning state of the network function resource." + }, + "device": { + "$ref": "./common.json#/definitions/SubResource", + "description": "The reference to the device resource. Once set, it cannot be updated." + }, + "skuName": { + "type": "string", + "description": "The sku name for the network function. Once set, it cannot be updated." + }, + "skuType": { + "readOnly": true, + "$ref": "./common.json#/definitions/SkuType", + "description": "The sku type for the network function." + }, + "vendorName": { + "type": "string", + "description": "The vendor name for the network function. Once set, it cannot be updated." + }, + "serviceKey": { + "type": "string", + "readOnly": true, + "description": "The service key for the network function resource." + }, + "vendorProvisioningState": { + "readOnly": true, + "$ref": "./common.json#/definitions/VendorProvisioningState", + "description": "The vendor provisioning state for the network function resource." + }, + "managedApplication": { + "readOnly": true, + "$ref": "./common.json#/definitions/SubResource", + "description": "The resource URI of the managed application." + }, + "managedApplicationParameters": { + "$ref": "./common.json#/definitions/ManagedApplicationParameters", + "description": "The parameters for the managed application." + }, + "networkFunctionContainerConfigurations": { + "type": "object", + "description": "The network function container configurations from the user." + }, + "networkFunctionUserConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkFunctionUserConfiguration" + }, + "description": "The network function configurations from the user." + } + } + }, + "NetworkFunctionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkFunction" + }, + "description": "A list of network function resources in a subscription or resource group." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "Response for network function API service call." + }, + "NetworkFunctionUserConfiguration": { + "properties": { + "roleName": { + "type": "string", + "description": "The name of the network function role." + }, + "userDataParameters": { + "$ref": "./common.json#/definitions/UserDataParameters", + "description": "The user data parameters from the customer." + }, + "networkInterfaces": { + "type": "array", + "items": { + "$ref": "./common.json#/definitions/NetworkInterface" + }, + "description": "The network interface configuration." + }, + "osProfile": { + "properties": { + "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.

    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/en-us/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/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + } + }, + "description": "Specifies the operating system settings for the role instance." + } + }, + "description": "The network function user configuration." + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/networkFunctionVendor.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/networkFunctionVendor.json new file mode 100644 index 000000000000..2609050dc52c --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/networkFunctionVendor.json @@ -0,0 +1,296 @@ +{ + "swagger": "2.0", + "info": { + "title": "HybridNetworkManagementClient", + "description": "The resources in this swagger specification will be used to manage the network function vendor in a Hybrid Network resource provider.", + "version": "2021-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridNetwork/networkFunctionVendors": { + "get": { + "tags": [ + "networkFunctionVendors" + ], + "operationId": "networkFunctionVendors_List", + "description": "Lists all the available vendor and sku information.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns a list of vendors with available sku information.", + "schema": { + "$ref": "#/definitions/NetworkFunctionVendorListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List vendors and skus.": { + "$ref": "./examples/NetworkFunctionVendorAndSkuListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridNetwork/networkFunctionVendors/{vendorName}/vendorSkus": { + "get": { + "tags": [ + "networkFunctionVendors" + ], + "operationId": "NetworkFunctionVendorSkus_ListByVendor", + "description": "Lists all network function vendor sku details in a vendor.", + "parameters": [ + { + "name": "vendorName", + "description": "The name of the network function vendor.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns a list of network function vendor skus.", + "schema": { + "$ref": "#/definitions/NetworkFunctionSkuListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List vendors and skus.": { + "$ref": "./examples/NetworkFunctionSkuListByVendor.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridNetwork/networkFunctionVendors/{vendorName}/vendorSkus/{vendorSkuName}": { + "get": { + "tags": [ + "networkFunctionVendors" + ], + "operationId": "networkFunctionVendorSkus_ListBySku", + "description": "Lists information about network function vendor sku details.", + "parameters": [ + { + "name": "vendorName", + "description": "The name of the network function vendor.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "vendorSkuName", + "description": "The name of the network function sku.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns the resulting network function vendor sku details.", + "schema": { + "$ref": "#/definitions/NetworkFunctionSkuDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get network function sku details": { + "$ref": "./examples/NetworkFunctionSkuDetailsGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "SkuOverview": { + "properties": { + "skuName": { + "type": "string", + "description": "The vendor sku name." + }, + "skuType": { + "$ref": "./common.json#/definitions/SkuType", + "description": "The vendor sku type." + } + }, + "description": "The network function sku overview." + }, + "NetworkFunctionSkuDetails": { + "properties": { + "skuType": { + "$ref": "./common.json#/definitions/SkuType", + "description": "The network function sku type." + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkFunctionSkuRoleDetails" + }, + "description": "The network function sku role details." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "The network function sku details." + }, + "VendorDetails": { + "properties": { + "vendorName": { + "type": "string", + "description": "The network function vendor name." + }, + "skuList": { + "type": "array", + "items": { + "$ref": "#/definitions/SkuOverview" + }, + "description": "The network function sku list." + } + }, + "description": "The network function vendor details." + }, + "NetworkFunctionVendor": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VendorDetails", + "description": "Vendors of Hybrid Network service provider." + } + }, + "description": "The network function vendor." + }, + "NetworkFunctionVendorListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkFunctionVendor" + }, + "description": "A list of available network function vendors and skus." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "The network function vendor list result." + }, + "NetworkFunctionSkuRoleDetails": { + "properties": { + "roleName": { + "type": "string", + "description": "The name of the network function role." + }, + "userDataTemplate": { + "$ref": "./common.json#/definitions/UserDataTemplate", + "description": "The user data template for customers." + }, + "userDataParameters": { + "$ref": "./common.json#/definitions/UserDataParameters", + "description": "The user parameters for customers." + }, + "networkInterfaces": { + "type": "array", + "items": { + "$ref": "./common.json#/definitions/NetworkInterface" + }, + "description": "The network interface configuration." + } + }, + "description": "The network function user configuration." + }, + "NetworkFunctionSkuListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SkuOverview" + }, + "description": "The network function vendor sku overview properties." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "A list of available network function skus." + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/operation.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/operation.json new file mode 100644 index 000000000000..c819481c06c9 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/operation.json @@ -0,0 +1,128 @@ +{ + "swagger": "2.0", + "info": { + "title": "HybridNetworkManagementClient", + "description": "The resources in this swagger specification will be used to manage the operations.", + "version": "2021-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.HybridNetwork/operations": { + "get": { + "tags": [ + "operations" + ], + "operationId": "Operations_List", + "description": "Gets a list of the operations.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Returns a list of operations.", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Registration Operations": { + "$ref": "./examples/GetOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Operation": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Operation name: {provider}/{resource}/{operation}." + }, + "display": { + "readOnly": true, + "description": "The object that represents the operation.", + "properties": { + "provider": { + "type": "string", + "description": "Service provider: Microsoft.HybridNetwork." + }, + "resource": { + "type": "string", + "description": "Resource on which the operation is performed: Registration definition, registration assignment, etc." + }, + "operation": { + "type": "string", + "description": "Operation type: Read, write, delete, etc." + }, + "description": { + "type": "string", + "description": "Description of the operation." + } + } + } + }, + "type": "object", + "description": "Object that describes a single Microsoft.HybridNetwork operation." + }, + "OperationList": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "A list of Microsoft.HybridNetwork operations." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "type": "object", + "description": "A list of the operations." + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/vendor.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/vendor.json new file mode 100644 index 000000000000..faa0ce1866d0 --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/vendor.json @@ -0,0 +1,1122 @@ +{ + "swagger": "2.0", + "info": { + "title": "HybridNetworkManagementClient", + "description": "The resources in this swagger specification will be used by vendors to on-board offerings and manage network functions.", + "version": "2021-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridNetwork/vendors/{vendorName}": { + "delete": { + "tags": [ + "Vendors" + ], + "operationId": "Vendors_Delete", + "description": "Deletes the specified vendor.", + "parameters": [ + { + "name": "vendorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vendor." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. Request is successful." + }, + "202": { + "description": "Accepted. Sets provisioningState to 'Deleting' until the operation is completed. Returns an operation URI that can be queried to find the current state of the operation." + }, + "204": { + "description": "Request is successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete vendor resource": { + "$ref": "./examples/VendorDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Vendors" + ], + "operationId": "Vendors_Get", + "description": "Gets information about the specified vendor.", + "parameters": [ + { + "name": "vendorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vendor." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns the resulting vendor resource.", + "schema": { + "$ref": "#/definitions/Vendor" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Vendor resource": { + "$ref": "./examples/VendorGet.json" + } + } + }, + "put": { + "tags": [ + "Vendors" + ], + "operationId": "Vendors_CreateOrUpdate", + "description": "Creates or updates a vendor.", + "parameters": [ + { + "name": "vendorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vendor." + }, + { + "name": "parameters", + "in": "body", + "schema": { + "$ref": "#/definitions/Vendor" + }, + "description": "Parameters supplied to the create vendor operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. Request is successful.", + "schema": { + "$ref": "#/definitions/Vendor" + } + }, + "201": { + "description": "Created. The header contains 'Azure-AsyncOperation' header pointing to an operations resource. The operation URI can be queried to find the current state of the operation.", + "schema": { + "$ref": "#/definitions/Vendor" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update Vendor resource": { + "$ref": "./examples/VendorCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridNetwork/vendors": { + "get": { + "tags": [ + "Vendors" + ], + "operationId": "Vendors_ListBySubscription", + "description": "Lists all the vendors in a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns a list of vendor resources.", + "schema": { + "$ref": "#/definitions/VendorListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List all vendor resources in subscription": { + "$ref": "./examples/VendorListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridNetwork/vendors/{vendorName}/vendorSkus/{skuName}": { + "delete": { + "tags": [ + "VendorSkus" + ], + "operationId": "VendorSkus_Delete", + "description": "Deletes the specified sku. This operation can take up to 2 hours to complete. This is expected service behavior.", + "parameters": [ + { + "name": "vendorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vendor." + }, + { + "name": "skuName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the sku." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. Request is successful." + }, + "202": { + "description": "Accepted. Sets provisioningState to 'Deleting' until the operation is completed. Returns an operation URI that can be queried to find the current state of the operation." + }, + "204": { + "description": "Request is successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete the sku of vendor resource": { + "$ref": "./examples/VendorSkuDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "VendorSkus" + ], + "operationId": "VendorSkus_Get", + "description": "Gets information about the specified sku.", + "parameters": [ + { + "name": "vendorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vendor." + }, + { + "name": "skuName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the sku." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns the resulting vendor resource.", + "schema": { + "$ref": "#/definitions/VendorSku" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get the sku of vendor resource": { + "$ref": "./examples/VendorSkuGet.json" + } + } + }, + "put": { + "tags": [ + "VendorSkus" + ], + "operationId": "VendorSkus_CreateOrUpdate", + "description": "Creates or updates a sku. This operation can take up to 2 hours to complete. This is expected service behavior.", + "parameters": [ + { + "name": "vendorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vendor." + }, + { + "name": "skuName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the sku." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VendorSku" + }, + "description": "Parameters supplied to the create or update sku operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Creation or update is successful. The operation returns the resulting vendor sku sub resource.", + "schema": { + "$ref": "#/definitions/VendorSku" + } + }, + "201": { + "description": "Created. The operation returns the resulting vendor sku sub resource.", + "schema": { + "$ref": "#/definitions/VendorSku" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update the sku of vendor resource": { + "$ref": "./examples/VendorSkuCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridNetwork/vendors/{vendorName}/vendorSkus": { + "get": { + "tags": [ + "VendorSkus" + ], + "operationId": "VendorSkus_List", + "description": "Lists all the skus of a vendor.", + "parameters": [ + { + "name": "vendorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vendor." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns a list of vendor sku resources.", + "schema": { + "$ref": "#/definitions/VendorSkuListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List all the vendor skus of vendor resource": { + "$ref": "./examples/VendorSkuListByVendor.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridNetwork/vendors/{vendorName}/vendorSkus/{skuName}/previewSubscriptions": { + "get": { + "tags": [ + "VendorSkuPreview" + ], + "operationId": "VendorSkuPreview_List", + "description": "Lists all the preview information of a vendor sku.", + "parameters": [ + { + "name": "vendorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vendor." + }, + { + "name": "skuName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the sku." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns the preview information of the vendor sku sub resource.", + "schema": { + "$ref": "#/definitions/PreviewSubscriptionsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List all preview subscriptions of vendor sku sub resource": { + "$ref": "./examples/VendorSkuPreviewListBySku.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridNetwork/vendors/{vendorName}/vendorSkus/{skuName}/previewSubscriptions/{previewSubscription}": { + "put": { + "tags": [ + "VendorSkuPreview" + ], + "operationId": "VendorSkuPreview_CreateOrUpdate", + "description": "Creates or updates preview information of a vendor sku.", + "parameters": [ + { + "name": "vendorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vendor." + }, + { + "name": "skuName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vendor sku." + }, + { + "name": "previewSubscription", + "in": "path", + "required": true, + "type": "string", + "description": "Preview subscription ID." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PreviewSubscription" + }, + "description": "Parameters supplied to the create or update vendor preview subscription operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Request is accepted. The operation is updating or creating the preview information of the vendor sku sub resource.", + "schema": { + "$ref": "#/definitions/PreviewSubscription" + } + }, + "200": { + "description": "Request is successful. The operation updated the preview information of the vendor sku sub resource.", + "schema": { + "$ref": "#/definitions/PreviewSubscription" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create or update preview subscription of vendor sku sub resource": { + "$ref": "./examples/VendorSkuPreviewCreate.json" + } + } + }, + "get": { + "tags": [ + "VendorSkuPreview" + ], + "operationId": "VendorSkuPreview_Get", + "description": "Gets the preview information of a vendor sku.", + "parameters": [ + { + "name": "vendorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vendor." + }, + { + "name": "skuName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vendor sku." + }, + { + "name": "previewSubscription", + "in": "path", + "required": true, + "type": "string", + "description": "Preview subscription ID." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation updated the preview information of the vendor sku sub resource.", + "schema": { + "$ref": "#/definitions/PreviewSubscription" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get preview subscription of vendor sku sub resource": { + "$ref": "./examples/VendorSkuPreviewGet.json" + } + } + }, + "delete": { + "tags": [ + "VendorSkuPreview" + ], + "operationId": "VendorSkuPreview_Delete", + "description": "Deletes the preview information of a vendor sku.", + "parameters": [ + { + "name": "vendorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vendor." + }, + { + "name": "skuName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vendor sku." + }, + { + "name": "previewSubscription", + "in": "path", + "required": true, + "type": "string", + "description": "Preview subscription ID." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation deleted the vendor sku preview resource." + }, + "202": { + "description": "Request is accepted. The operation is deleting the vendor sku preview resource." + }, + "204": { + "description": "Request is successful. The vendor sku preview resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete preview subscription of vendor sku sub resource": { + "$ref": "./examples/VendorSkuPreviewDelete.json" + } + } + } + } + }, + "definitions": { + "Vendor": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VendorPropertiesFormat", + "description": "Vendor properties." + }, + "systemData": { + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Vendor resource." + }, + "VendorPropertiesFormat": { + "description": "Vendor properties.", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./common.json#/definitions/ProvisioningState", + "description": "The provisioning state of the vendor resource." + }, + "skus": { + "type": "array", + "items": { + "$ref": "./common.json#/definitions/SubResource" + }, + "readOnly": true, + "description": "A list of IDs of the vendor skus offered by the vendor." + } + } + }, + "VendorSku": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VendorSkuPropertiesFormat", + "description": "Vendor sku details." + }, + "systemData": { + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Sku sub resource." + }, + "VendorSkuPropertiesFormat": { + "description": "Sku properties", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./common.json#/definitions/ProvisioningState", + "description": "The provisioning state of the vendor sku sub resource." + }, + "skuType": { + "$ref": "./common.json#/definitions/SkuType", + "description": "The sku type." + }, + "deploymentMode": { + "type": "string", + "description": "The sku deployment mode.", + "enum": [ + "Unknown", + "Azure", + "PrivateEdgeZone" + ], + "x-ms-enum": { + "name": "SkuDeploymentMode", + "modelAsString": true + } + }, + "networkFunctionType": { + "type": "string", + "description": "The network function type.", + "enum": [ + "Unknown", + "VirtualNetworkFunction", + "ContainerizedNetworkFunction" + ], + "x-ms-enum": { + "name": "NetworkFunctionType", + "modelAsString": true + } + }, + "preview": { + "type": "boolean", + "description": "Indicates if the vendor sku is in preview mode." + }, + "managedApplicationParameters": { + "$ref": "./common.json#/definitions/ManagedApplicationParameters", + "description": "The parameters for the managed application to be supplied by the vendor." + }, + "managedApplicationTemplate": { + "type": "object", + "description": "The template for the managed application deployment." + }, + "networkFunctionTemplate": { + "$ref": "#/definitions/NetworkFunctionTemplate", + "description": "The template definition of the network function." + } + } + }, + "VendorSkuListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VendorSku" + }, + "description": "A list of vendor skus offered by the vendor." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to get the next set of results." + } + }, + "description": "Response for list vendor sku API service call." + }, + "VendorListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Vendor" + }, + "description": "A list of vendors." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for vendors API service call." + }, + "NetworkFunctionTemplate": { + "properties": { + "networkFunctionRoleConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkFunctionRoleConfiguration" + }, + "description": "An array of network function role definitions." + } + }, + "description": "The network function template." + }, + "NetworkFunctionRoleConfiguration": { + "description": "Network function role configuration.", + "properties": { + "roleName": { + "type": "string", + "description": "The name of the network function role." + }, + "roleType": { + "type": "string", + "description": "Role type.", + "enum": [ + "Unknown", + "VirtualMachine" + ], + "x-ms-enum": { + "name": "NetworkFunctionRoleConfigurationType", + "modelAsString": true + } + }, + "virtualMachineSize": { + "type": "string", + "description": "The size of the virtual machine.", + "enum": [ + "Unknown", + "Standard_D1_v2", + "Standard_D2_v2", + "Standard_D3_v2", + "Standard_D4_v2", + "Standard_D5_v2", + "Standard_D11_v2", + "Standard_D12_v2", + "Standard_D13_v2", + "Standard_DS1_v2", + "Standard_DS2_v2", + "Standard_DS3_v2", + "Standard_DS4_v2", + "Standard_DS5_v2", + "Standard_DS11_v2", + "Standard_DS12_v2", + "Standard_DS13_v2", + "Standard_F1", + "Standard_F2", + "Standard_F4", + "Standard_F8", + "Standard_F16", + "Standard_F1s", + "Standard_F2s", + "Standard_F4s", + "Standard_F8s", + "Standard_F16s" + ], + "x-ms-enum": { + "name": "VirtualMachineSizeTypes", + "modelAsString": true + } + }, + "osProfile": { + "description": "Specifies the operating system settings for the role instance. This value can be updated during the deployment of network function.", + "$ref": "./common.json#/definitions/OsProfile" + }, + "userDataTemplate": { + "$ref": "./common.json#/definitions/UserDataTemplate", + "description": "The user data template for customers. This is a json schema template describing the format and data type of user data parameters." + }, + "userDataParameters": { + "$ref": "./common.json#/definitions/UserDataParameters", + "description": "The user parameters for customers. The format of user data parameters has to be matched with the provided user data template." + }, + "networkInterfaces": { + "type": "array", + "items": { + "$ref": "./common.json#/definitions/NetworkInterface" + }, + "description": "The network interface configurations." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "customProfile": { + "$ref": "#/definitions/CustomProfile", + "description": "Specifies the custom settings for the virtual machine." + } + } + }, + "ImageReference": { + "properties": { + "publisher": { + "type": "string", + "description": "The image publisher." + }, + "offer": { + "type": "string", + "description": "Specifies the offer of the image used to create the virtual machine." + }, + "sku": { + "type": "string", + "description": "The image SKU." + }, + "version": { + "type": "string", + "description": "Specifies the version of the 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." + }, + "exactVersion": { + "type": "string", + "description": "Specifies in decimal numbers, the exact version of image used to create the virtual machine." + } + }, + "description": "The image reference properties." + }, + "StorageProfile": { + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "The image reference properties." + }, + "osDisk": { + "$ref": "#/definitions/OsDisk", + "description": "Specifies information about the operating system disk used by the virtual machine." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/DataDisk" + }, + "description": "Specifies the parameters that are used to add a data disk to a virtual machine." + } + }, + "description": "Specifies the storage settings for the virtual machine disks." + }, + "OsDisk": { + "properties": { + "osType": { + "type": "string", + "description": "The OS type.", + "enum": [ + "Unknown", + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": true + } + }, + "name": { + "type": "string", + "description": "The VHD name." + }, + "vhd": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The virtual hard disk." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of os disk in gigabytes. This is the fully expanded disk size needed of the VHD image on the ASE. This disk size should be greater than the size of the VHD provided in vhdUri." + } + }, + "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/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "VirtualHardDisk": { + "properties": { + "uri": { + "type": "string", + "x-ms-secret": true, + "x-ms-mutability": [ + "create", + "update" + ], + "description": "Specifies the virtual hard disk's uri." + } + }, + "description": "Describes the uri of a disk." + }, + "DataDisk": { + "properties": { + "createOption": { + "type": "string", + "description": "Specifies how the virtual machine should be created.", + "enum": [ + "Unknown", + "Empty" + ], + "x-ms-enum": { + "name": "DiskCreateOptionTypes", + "modelAsString": true + } + }, + "name": { + "type": "string", + "description": "The name of data disk." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image." + } + }, + "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/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "CustomProfile": { + "properties": { + "metadataConfigurationPath": { + "type": "string", + "description": "Path for metadata configuration." + } + }, + "description": "Specifies the custom settings for the virtual machine." + }, + "PreviewSubscription": { + "x-ms-azure-resource": true, + "description": "Customer subscription which can use a sku.", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The preview subscription ID." + }, + "id": { + "type": "string", + "readOnly": true, + "description": "The ARM ID of the resource." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The type of the resource." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PreviewSubscriptionProperties", + "description": "The Preview Subscription properties." + }, + "systemData": { + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + } + }, + "PreviewSubscriptionProperties": { + "description": "PreviewSubscription properties", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./common.json#/definitions/ProvisioningState", + "description": "The provisioning state of the PreviewSubscription resource." + } + } + }, + "PreviewSubscriptionsList": { + "description": "A list of customer subscriptions which can use a sku.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PreviewSubscription" + }, + "description": "A list of preview subscriptions." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + } + } + } +} diff --git a/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/vendorNetworkFunction.json b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/vendorNetworkFunction.json new file mode 100644 index 000000000000..7a9add24be7a --- /dev/null +++ b/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2021-05-01/vendorNetworkFunction.json @@ -0,0 +1,723 @@ +{ + "swagger": "2.0", + "info": { + "title": "HybridNetworkManagementClient", + "description": "The resources in this swagger specification will be used to manage the vendor network function deployment in the Microsoft.HybridNetwork resource provider.", + "version": "2021-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridNetwork/locations/{locationName}/vendors/{vendorName}/networkFunctions/{serviceKey}": { + "get": { + "tags": [ + "VendorNetworkFunctions" + ], + "operationId": "VendorNetworkFunctions_Get", + "description": "Gets information about the specified vendor network function.", + "parameters": [ + { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure region where the network function resource was created by the customer." + }, + { + "name": "vendorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vendor." + }, + { + "name": "serviceKey", + "in": "path", + "required": true, + "type": "string", + "description": "The GUID for the vendor network function." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns the resulting vendor network function sub resource.", + "schema": { + "$ref": "#/definitions/VendorNetworkFunction" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get vendor network function sub resource by service key of network function.": { + "$ref": "./examples/VendorNfGet.json" + } + } + }, + "put": { + "tags": [ + "VendorNetworkFunctions" + ], + "operationId": "VendorNetworkFunctions_CreateOrUpdate", + "description": "Creates or updates a vendor network function. This operation can take up to 6 hours to complete. This is expected service behavior.", + "parameters": [ + { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure region where the network function resource was created by the customer." + }, + { + "name": "vendorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vendor." + }, + { + "name": "serviceKey", + "in": "path", + "required": true, + "type": "string", + "description": "The GUID for the vendor network function." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VendorNetworkFunction" + }, + "description": "Parameters supplied to the create or update vendor network function operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Creation or update is successful. The operation returns the resulting vendor network function sub resource.", + "schema": { + "$ref": "#/definitions/VendorNetworkFunction" + } + }, + "201": { + "description": "Created. The operation returns the resulting vendor network function sub resource.", + "schema": { + "$ref": "#/definitions/VendorNetworkFunction" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update vendor network function sub resource": { + "$ref": "./examples/VendorNfCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridNetwork/locations/{locationName}/vendors/{vendorName}/networkFunctions/{serviceKey}/roleInstances/{roleInstanceName}/start": { + "post": { + "tags": [ + "RoleInstances" + ], + "operationId": "RoleInstances_Start", + "description": "Starts a role instance of a vendor network function.", + "parameters": [ + { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure region where the network function resource was created by customer." + }, + { + "name": "vendorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vendor." + }, + { + "name": "serviceKey", + "in": "path", + "required": true, + "type": "string", + "description": "The GUID for the vendor network function." + }, + { + "name": "roleInstanceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role instance of the vendor network function." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted. The header contains 'Azure-AsyncOperation' header which can be used to monitor the progress of the operation." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Start a role instance of a vendor network function": { + "$ref": "./examples/RoleInstanceStart.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridNetwork/locations/{locationName}/vendors/{vendorName}/networkFunctions/{serviceKey}/roleInstances/{roleInstanceName}/stop": { + "post": { + "tags": [ + "RoleInstances" + ], + "operationId": "RoleInstances_Stop", + "description": "Powers off (stop) a role instance of a vendor network function.", + "parameters": [ + { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure region where the network function resource was created by customer." + }, + { + "name": "vendorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vendor." + }, + { + "name": "serviceKey", + "in": "path", + "required": true, + "type": "string", + "description": "The GUID for the vendor network function." + }, + { + "name": "roleInstanceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role instance of the vendor network function." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted. The header contains 'Azure-AsyncOperation' header which can be used to monitor the progress of the operation." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Stop a role instance of a vendor network function": { + "$ref": "./examples/RoleInstanceStop.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridNetwork/locations/{locationName}/vendors/{vendorName}/networkFunctions/{serviceKey}/roleInstances/{roleInstanceName}/restart": { + "post": { + "tags": [ + "RoleInstances" + ], + "operationId": "RoleInstances_Restart", + "description": "Restarts a role instance of a vendor network function.", + "parameters": [ + { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure region where the network function resource was created by customer." + }, + { + "name": "vendorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vendor." + }, + { + "name": "serviceKey", + "in": "path", + "required": true, + "type": "string", + "description": "The GUID for the vendor network function." + }, + { + "name": "roleInstanceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role instance of the vendor network function." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted. The header contains 'Azure-AsyncOperation' header which can be used to monitor the progress of the operation." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Restart a role instance of a vendor network function": { + "$ref": "./examples/RoleInstanceRestart.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridNetwork/locations/{locationName}/vendors/{vendorName}/networkFunctions/{serviceKey}/roleInstances/{roleInstanceName}": { + "get": { + "tags": [ + "RoleInstances" + ], + "operationId": "RoleInstances_Get", + "description": "Gets the information of role instance of vendor network function.", + "parameters": [ + { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure region where the network function resource was created by customer." + }, + { + "name": "vendorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vendor." + }, + { + "name": "serviceKey", + "in": "path", + "required": true, + "type": "string", + "description": "The GUID for the vendor network function." + }, + { + "name": "roleInstanceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role instance of the vendor network function." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/RoleInstance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get the operational state of role instance of vendor network function": { + "$ref": "./examples/RoleInstanceGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridNetwork/locations/{locationName}/vendors/{vendorName}/networkFunctions": { + "get": { + "tags": [ + "VendorNetworkFunctions" + ], + "operationId": "VendorNetworkFunctions_List", + "description": "Lists all the vendor network function sub resources in an Azure region, filtered by skuType, skuName, vendorProvisioningState.", + "parameters": [ + { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure region where the network function resource was created by the customer." + }, + { + "name": "vendorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vendor." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. The properties you can use for eq (equals) are: skuType, skuName and vendorProvisioningState." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. The operation returns the resulting vendor network function sub resource.", + "schema": { + "$ref": "#/definitions/VendorNetworkFunctionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List all nfs of vendor resource": { + "$ref": "./examples/VendorNfListByVendor.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridNetwork/locations/{locationName}/vendors/{vendorName}/networkFunctions/{serviceKey}/roleInstances": { + "get": { + "tags": [ + "RoleInstances" + ], + "operationId": "RoleInstances_List", + "description": "Lists the information of role instances of vendor network function.", + "parameters": [ + { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure region where the network function resource was created by customer." + }, + { + "name": "vendorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vendor." + }, + { + "name": "serviceKey", + "in": "path", + "required": true, + "type": "string", + "description": "The GUID for the vendor network function." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/NetworkFunctionRoleInstanceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List all role instances of vendor network function": { + "$ref": "./examples/RoleInstanceListByVendorNetworkFunction.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "VendorNetworkFunctionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VendorNetworkFunction" + }, + "description": "A list of vendor network functions." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for vendors API service call." + }, + "VendorNetworkFunction": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VendorNetworkFunctionPropertiesFormat", + "description": "Network function details." + }, + "systemData": { + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Vendor network function sub resource." + }, + "VendorNetworkFunctionPropertiesFormat": { + "description": "Vendor network function properties.", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./common.json#/definitions/ProvisioningState", + "description": "The provisioning state of the vendor network function sub resource." + }, + "vendorProvisioningState": { + "$ref": "./common.json#/definitions/VendorProvisioningState", + "description": "The vendor controlled provisioning state of the vendor network function." + }, + "skuName": { + "readOnly": true, + "type": "string", + "description": "The name of the sku. Once set, it cannot be updated." + }, + "skuType": { + "$ref": "./common.json#/definitions/SkuType", + "description": "The sku type.", + "readOnly": true + }, + "networkFunctionVendorConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkFunctionVendorConfiguration" + }, + "description": "An array of network function vendor configurations." + } + } + }, + "NetworkFunctionVendorConfiguration": { + "properties": { + "roleName": { + "type": "string", + "description": "The name of the vendor network function role." + }, + "osProfile": { + "description": "Specifies the operating system settings for the role instance.", + "$ref": "./common.json#/definitions/OsProfile" + }, + "userDataParameters": { + "$ref": "./common.json#/definitions/UserDataParameters", + "readOnly": true, + "description": "The user parameters from the customer." + }, + "networkInterfaces": { + "type": "array", + "items": { + "$ref": "./common.json#/definitions/NetworkInterface" + }, + "description": "The network interface configurations." + } + }, + "description": "Network function vendor configuration." + }, + "NetworkFunctionRoleInstanceListResult": { + "description": "List of role instances of vendor network function.", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RoleInstance" + }, + "description": "A list of role instances." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + } + }, + "RoleInstance": { + "x-ms-azure-resource": true, + "properties": { + "name": { + "type": "string", + "description": "The role instance name." + }, + "id": { + "type": "string", + "description": "The ARM ID of the resource." + }, + "type": { + "type": "string", + "description": "The type of the resource." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoleInstanceProperties", + "description": "The role instance properties." + }, + "systemData": { + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + }, + "description": "The role instance sub resource." + }, + "RoleInstanceProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./common.json#/definitions/ProvisioningState", + "description": "The provisioning state of the RoleInstance resource." + }, + "operationalState": { + "type": "string", + "description": "The operational state of the role instance.", + "enum": [ + "Unknown", + "Stopped", + "Running", + "Stopping", + "Starting" + ], + "x-ms-enum": { + "name": "OperationalState", + "modelAsString": true + } + } + }, + "description": "The role instance properties of the network function." + } + } +} diff --git a/specification/hybridnetwork/resource-manager/readme.md b/specification/hybridnetwork/resource-manager/readme.md index 9b41f2939671..b589860110bd 100644 --- a/specification/hybridnetwork/resource-manager/readme.md +++ b/specification/hybridnetwork/resource-manager/readme.md @@ -27,7 +27,21 @@ These are the global settings for the hybridnetwork. ```yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2020-01-01-preview +tag: package-2021-05-01 +``` +### Tag: package-2021-05-01 + +These settings apply only when `--tag=package-2021-05-01` is specified on the command line. + +```yaml $(tag) == 'package-2021-05-01' +input-file: + - Microsoft.HybridNetwork/stable/2021-05-01/common.json + - Microsoft.HybridNetwork/stable/2021-05-01/networkFunction.json + - Microsoft.HybridNetwork/stable/2021-05-01/device.json + - Microsoft.HybridNetwork/stable/2021-05-01/operation.json + - Microsoft.HybridNetwork/stable/2021-05-01/vendor.json + - Microsoft.HybridNetwork/stable/2021-05-01/networkFunctionVendor.json + - Microsoft.HybridNetwork/stable/2021-05-01/vendorNetworkFunction.json ``` ### Tag: package-2020-01-01-preview @@ -83,5 +97,3 @@ See configuration in [readme.typescript.md](./readme.typescript.md) ## CSharp See configuration in [readme.csharp.md](./readme.csharp.md) - - diff --git a/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2021-02-01/examples/GetAttestedData.json b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2021-02-01/examples/GetAttestedData.json new file mode 100644 index 000000000000..8d4f2a66be2e --- /dev/null +++ b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2021-02-01/examples/GetAttestedData.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "nonce": "abcde12345", + "Metadata": "true" + }, + "responses": { + "200": { + "body": { + "encoding": "pkcs7", + "signature": "MIID2gYJKoZIhvcNAQcCoIIDyzCCA8cCAQExDzANBgkqhkiG9w0BAQsFADCBggYJKoZIhvcNAQcBoHUEc3sibm9uY2UiOiIxMTExMTExMTExIiwicGxhbiI6eyJuYW1lIjoiIiwicHJvZHVjdCI6IiIsInB1Ymxpc2hlciI6IiJ9LCJ2bUlkIjoiMDJhYWI4YTQtNzRlZi00NzZlLTgxODItZjZkMmJhNDE2NmE2In2gggI/MIICOzCCAaSgAwIBAgIQQWsFjXN35oBJKFXI3QrM3TANBgkqhkiG9w0BAQQFADArMSkwJwYDVQQDEyB0ZXN0c3ViZG9tYWluLm1ldGFkYXRhLmF6dXJlLmNvbTAeFw0xODExMDgxODUzMDRaFw0xODEyMDgxODUzMDNaMCsxKTAnBgNVBAMTIHRlc3RzdWJkb21haW4ubWV0YWRhdGEuYXp1cmUuY29tMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDEi0FVslYnUX+MneC7ERMU4ZM88z4J80r7RPgvzxCPNhXUQlWm3cmVRZMD8kKMv7brkvEsATP7Ak60/I/XEtOga4LGCvMaQa8I/MW8IhSyp2Vj015glAiV8TeUI5DuOIOS96lQvM+G7bt23swkIwVjm1u1ViTZiKKytwpY/EGqzQIDAQABo2AwXjBcBgNVHQEEVTBTgBAt3MRgJmEoUMiPy7k06cLfoS0wKzEpMCcGA1UEAxMgdGVzdHN1YmRvbWFpbi5tZXRhZGF0YS5henVyZS5jb22CEEFrBY1zd+aASShVyN0KzN0wDQYJKoZIhvcNAQEEBQADgYEAd87qiZnRlGIFQ5IEcL/A7ru23WSQAOBsNPt70Fg1GtaEHcYshKUJFhGwXOgZ11cY5wRfrSvEKuzvhAeIZwkvzkBjC04g8sRrjN5leLY5CsKzQhjN52TUMsHhqTM58tfAnICeTddQwn6LOgfqtYH5WO+F/VbFCwPstYUqjmQEYAoxgegwgeUCAQEwPzArMSkwJwYDVQQDEyB0ZXN0c3ViZG9tYWluLm1ldGFkYXRhLmF6dXJlLmNvbQIQQWsFjXN35oBJKFXI3QrM3TANBgkqhkiG9w0BAQsFADANBgkqhkiG9w0BAQEFAASBgCbkRKmQ1MdWZPVOrX7ZBKHQUWPFrQQNdjk3KB67GkY0W0Taxut4K7D2PmiflVEwxB92pTbaZZr/dldu1k1ab1YamHcVYdgZgxIkoOWohGR0ym8oL9JHjFMEqHUbEPtDwE8X+djtDd8TVdb6LYe77IXmz/VaX4whuejlSvQXjaL" + } + } + } +} diff --git a/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2021-02-01/examples/GetIdentityInfo.json b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2021-02-01/examples/GetIdentityInfo.json new file mode 100644 index 000000000000..c2cec409204d --- /dev/null +++ b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2021-02-01/examples/GetIdentityInfo.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "Metadata": "true" + }, + "responses": { + "200": { + "body": { + "tenantId": "abd8daee-d393-4239-9377-883adda3d40f" + } + } + } +} diff --git a/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2021-02-01/examples/GetIdentityToken.json b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2021-02-01/examples/GetIdentityToken.json new file mode 100644 index 000000000000..6129f4e4e462 --- /dev/null +++ b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2021-02-01/examples/GetIdentityToken.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "Metadata": "true", + "resource": "https://vault.azure.net" + }, + "responses": { + "200": { + "body": { + "access_token": "dummytoken", + "client_id": "be5947ed-3560-4afe-9504-59967a63f810", + "expires_in": "3599", + "expires_on": "1541705014", + "ext_expires_in": "262800", + "not_before": "1508961830", + "resource": "https://va" + } + } + } +} diff --git a/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2021-02-01/examples/GetInstanceMetadata.json b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2021-02-01/examples/GetInstanceMetadata.json new file mode 100644 index 000000000000..62c2943557e0 --- /dev/null +++ b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2021-02-01/examples/GetInstanceMetadata.json @@ -0,0 +1,129 @@ +{ + "parameters": { + "api-version": "2021-02-01", + "Metadata": "true" + }, + "responses": { + "200": { + "body": { + "compute": { + "azEnvironment": "AZUREPUBLICCLOUD", + "evictionPolicy": "deallocate", + "isHostCompatibilityLayerVm": "true", + "licenseType": "Windows_Server", + "location": "westus", + "name": "examplevmname", + "offer": "Windows", + "osProfile": { + "adminUsername": "admin", + "computerName": "examplevmname", + "disablePasswordAuthentication": "true" + }, + "osType": "linux", + "placementGroupId": "f67c14ab-e92c-408c-ae2d-da15866ec79a", + "plan": { + "name": "planName", + "product": "planProduct", + "publisher": "planPublisher" + }, + "platformFaultDomain": "36", + "platformUpdateDomain": "42", + "priority": "Spot", + "provider": "Microsoft.Compute", + "publicKeys": [ + { + "keyData": "ssh-rsa 0", + "path": "/home/user/.ssh/authorized_keys0" + }, + { + "keyData": "ssh-rsa 1", + "path": "/home/user/.ssh/authorized_keys1" + } + ], + "publisher": "RDFE-Test-Microsoft-Windows-Server-Group", + "resourceGroupName": "macikgo-test-may-23", + "resourceId": "/subscriptions/8d10da13-8125-4ba9-a717-bf7490507b3d/resourceGroups/macikgo-test-may-23/providers/Microsoft.Compute/virtualMachines/examplevmname", + "securityProfile": { + "secureBootEnabled": "true", + "virtualTpmEnabled": "false" + }, + "sku": "Windows-Server-2012-R2-Datacenter", + "storageProfile": { + "dataDisks": [ + { + "caching": "None", + "createOption": "Empty", + "diskSizeGB": "1024", + "image": { + "uri": "" + }, + "lun": "0", + "managedDisk": { + "id": "/subscriptions/8d10da13-8125-4ba9-a717-bf7490507b3d/resourceGroups/macikgo-test-may-23/providers/Microsoft.Compute/disks/exampledatadiskname", + "storageAccountType": "Standard_LRS" + }, + "name": "exampledatadiskname", + "vhd": { + "uri": "" + }, + "writeAcceleratorEnabled": "false" + } + ], + "imageReference": { + "id": "", + "offer": "UbuntuServer", + "publisher": "Canonical", + "sku": "16.04.0-LTS", + "version": "latest" + }, + "osDisk": { + "caching": "ReadWrite", + "createOption": "FromImage", + "diskSizeGB": "30", + "diffDiskSettings": { + "option": "Local" + }, + "encryptionSettings": { + "enabled": "false" + }, + "image": { + "uri": "" + }, + "managedDisk": { + "id": "/subscriptions/8d10da13-8125-4ba9-a717-bf7490507b3d/resourceGroups/macikgo-test-may-23/providers/Microsoft.Compute/disks/exampleosdiskname", + "storageAccountType": "Standard_LRS" + }, + "name": "exampleosdiskname", + "osType": "Linux", + "vhd": { + "uri": "" + }, + "writeAcceleratorEnabled": "false" + }, + "resourceDisk": { + "size": "4096" + } + }, + "subscriptionId": "8d10da13-8125-4ba9-a717-bf7490507b3d", + "tags": "baz:bash;foo:bar", + "tagsList": [ + { + "name": "baz", + "value": "bash" + }, + { + "name": "foo", + "value": "bar" + } + ], + "userData": "Zm9vYmFy", + "version": "15.05.22", + "vmId": "02aab8a4-74ef-476e-8182-f6d2ba4166a6", + "vmScaleSetName": "crpteste9vflji9", + "vmSize": "Standard_A3", + "zone": "" + } + } + } + } +} diff --git a/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2021-02-01/imds.json b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2021-02-01/imds.json new file mode 100644 index 000000000000..1d10d33765d1 --- /dev/null +++ b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2021-02-01/imds.json @@ -0,0 +1,932 @@ +{ + "swagger": "2.0", + "info": { + "title": "InstanceMetadataClient", + "description": "The Azure Instance Metadata Client", + "version": "2021-02-01" + }, + "host": "169.254.169.254", + "basePath": "/metadata", + "schemes": [ + "http", + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "basic_auth": { + "type": "basic", + "description": "A Basic authentication flow" + } + }, + "paths": { + "/instance": { + "get": { + "operationId": "Instances_GetMetadata", + "description": "Get Instance Metadata for the Virtual Machine.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/MetadataParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Instance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Instance Metadata for the VM": { + "$ref": "./examples/GetInstanceMetadata.json" + } + } + } + }, + "/attested/document": { + "get": { + "operationId": "Attested_GetDocument", + "description": "Get Attested Data for the Virtual Machine.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "nonce", + "in": "query", + "required": false, + "type": "string", + "description": "This is a string of up to 32 random alphanumeric characters." + }, + { + "$ref": "#/parameters/MetadataParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AttestedData" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Attested Data for the VM": { + "$ref": "./examples/GetAttestedData.json" + } + } + } + }, + "/identity/oauth2/token": { + "get": { + "tags": [ + "Get token" + ], + "description": "Get a Token from Azure AD", + "operationId": "Identity_GetToken", + "produces": [ + "application/json" + ], + "security": [ + {}, + { + "basic_auth": [] + } + ], + "parameters": [ + { + "$ref": "#/parameters/MetadataParameter" + }, + { + "name": "resource", + "in": "query", + "type": "string", + "description": "This is the urlencoded identifier URI of the sink resource for the requested Azure AD token. The resulting token contains the corresponding aud for this resource.", + "required": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "client_id", + "in": "query", + "type": "string", + "description": "This identifies, by Azure AD client id, a specific explicit identity to use when authenticating to Azure AD. Mutually exclusive with object_id and msi_res_id.", + "required": false + }, + { + "name": "object_id", + "in": "query", + "type": "string", + "description": "This identifies, by Azure AD object id, a specific explicit identity to use when authenticating to Azure AD. Mutually exclusive with client_id and msi_res_id.", + "required": false + }, + { + "name": "msi_res_id", + "in": "query", + "type": "string", + "description": "This identifies, by urlencoded ARM resource id, a specific explicit identity to use when authenticating to Azure AD. Mutually exclusive with client_id and object_id.", + "required": false + }, + { + "name": "authority", + "in": "query", + "type": "string", + "description": "This indicates the authority to request AAD tokens from. Defaults to the known authority of the identity to be used.", + "required": false + }, + { + "name": "bypass_cache", + "in": "query", + "type": "string", + "enum": [ + "true" + ], + "description": "If provided, the value must be 'true'. This indicates to the server that the token must be retrieved from Azure AD and cannot be retrieved from an internal cache.", + "required": false, + "x-ms-enum": { + "name": "BypassCache", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "$ref": "#/definitions/IdentityTokenResponse" + } + }, + "default": { + "headers": { + "Www-Authenticate": { + "type": "string", + "description": "This is the response header containing a challenge for the Basic scheme with a realm value" + } + }, + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/IdentityErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Identity Token for the VM": { + "$ref": "./examples/GetIdentityToken.json" + } + } + } + }, + "/identity/info": { + "get": { + "tags": [ + "Get metadata information" + ], + "description": "Get information about AAD Metadata", + "operationId": "Identity_GetInfo", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/MetadataParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "$ref": "#/definitions/IdentityInfoResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/IdentityErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Identity Info for the VM": { + "$ref": "./examples/GetIdentityInfo.json" + } + } + } + } + }, + "definitions": { + "Compute": { + "type": "object", + "properties": { + "azEnvironment": { + "type": "string", + "description": "This is the name of the environment in which the VM is running." + }, + "evictionPolicy": { + "type": "string", + "description": "Describes how the VM will be evicted if space needs to be freed up. Only applicable to Spot VMs. For a non-spot VM, this will be an empty string." + }, + "isHostCompatibilityLayerVm": { + "type": "string", + "description": "Identifies if the VM runs on the Host Compatibility Layer." + }, + "licenseType": { + "type": "string", + "description": "Type of license for Azure Hybrid Benefit. Note that this is only present for AHB-enabled VMs." + }, + "location": { + "type": "string", + "description": "This is the Azure Region in which the VM is running." + }, + "name": { + "type": "string", + "description": "This is the name of the VM." + }, + "offer": { + "type": "string", + "description": "This is the offer information for the VM image. This value is only present for images deployed from the Azure Image Gallery." + }, + "osProfile": { + "type": "object", + "description": "This contains the data about the OS.", + "$ref": "#/definitions/OsProfile" + }, + "osType": { + "type": "string", + "description": "This value indicates the type of OS the VM is running, either Linux or Windows." + }, + "placementGroupId": { + "type": "string", + "description": "This is the placement group of your Virtual Machine Scale Set." + }, + "plan": { + "type": "object", + "description": "This contains the data about the plan.", + "$ref": "#/definitions/PlanProperties" + }, + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/PublicKeysProperties" + }, + "description": "This is information about the SSH certificate" + }, + "platformFaultDomain": { + "type": "string", + "description": "This is the fault domain in which the VM." + }, + "platformUpdateDomain": { + "type": "string", + "description": "This is the update domain in which the VM." + }, + "priority": { + "type": "string", + "description": "This is the priority of the VM." + }, + "provider": { + "type": "string", + "description": "This is the provider of the VM." + }, + "publisher": { + "type": "string", + "description": "This is the publisher of the VM image." + }, + "resourceGroupName": { + "type": "string", + "description": "This is the resource group for the VM." + }, + "resourceId": { + "type": "string", + "description": "This is the fully qualified ID for the VM." + }, + "securityProfile": { + "description": "This contains the data about the security profile associated with the VM.", + "$ref": "#/definitions/SecurityProfile" + }, + "sku": { + "type": "string", + "description": "This is the specific SKU for the VM image." + }, + "storageProfile": { + "type": "object", + "description": "This contains the data about the storage disks associated with the VM.", + "$ref": "#/definitions/StorageProfile" + }, + "subscriptionId": { + "type": "string", + "description": "This is the Azure subscription for the VM." + }, + "tags": { + "type": "string", + "description": "This is the list of tags for your VM." + }, + "tagsList": { + "type": "array", + "items": { + "$ref": "#/definitions/TagsProperties" + }, + "description": "This is the list of tags for your VM formatted as a JSON array for easier programmatic parsing." + }, + "userData": { + "type": "string", + "description": "The set of data specified when the VM was created for use during or after provisioning (Base64 encoded)" + }, + "version": { + "type": "string", + "description": "This is the version of the VM image." + }, + "vmId": { + "type": "string", + "description": "This is the unique identifier for the VM." + }, + "vmScaleSetName": { + "type": "string", + "description": "This is the resource name of the VMSS." + }, + "vmSize": { + "type": "string", + "description": "This is the size of the VM." + }, + "zone": { + "type": "string", + "description": "This is the availability zone of the VM." + } + }, + "description": "Compute Metadata" + }, + "Network": { + "type": "object", + "properties": { + "interface": { + "type": "array", + "description": "This contains data about the network interface.", + "items": { + "type": "object", + "$ref": "#/definitions/NetworkInterface" + } + } + }, + "description": "Network Metadata" + }, + "NetworkInterface": { + "type": "object", + "description": "This contains data about the network interface.", + "properties": { + "ipv4": { + "type": "object", + "description": "This contains the IPv4 address.", + "properties": { + "ipAddress": { + "type": "array", + "description": "This is the IP address", + "items": { + "type": "object", + "description": "This contains the IPv4 properties.", + "$ref": "#/definitions/Ipv4Properties" + } + }, + "subnet": { + "type": "array", + "description": "This is the subnet", + "items": { + "type": "object", + "description": "This contains the subnet properties.", + "$ref": "#/definitions/SubnetProperties" + } + } + } + }, + "ipv6": { + "type": "object", + "description": "This contains the IPv6 address.", + "properties": { + "ipAddress": { + "type": "array", + "description": "This is the IP address", + "items": { + "type": "object", + "description": "This contains the IPv6 properties.", + "$ref": "#/definitions/Ipv6Properties" + } + } + } + }, + "macAddress": { + "type": "string", + "description": "This is the MAC address of the interface." + } + } + }, + "OsProfile": { + "type": "object", + "description": "This contains the data about the OS.", + "properties": { + "adminUsername": { + "type": "string", + "description": "This is admin account." + }, + "computerName": { + "type": "string", + "description": "This is the name of the VM." + }, + "disablePasswordAuthentication": { + "type": "string", + "description": "This specifies whether or not password authentication is disabled. Note that this is present only for Linux VMs. For a Windows VM, this value will be the empty string." + } + } + }, + "PlanProperties": { + "type": "object", + "description": "This contains the data about the plan.", + "properties": { + "name": { + "type": "string", + "description": "This is the Plan ID." + }, + "publisher": { + "type": "string", + "description": "This is the publisher ID." + }, + "product": { + "type": "string", + "description": "This is the product of the image from the Marketplace." + } + } + }, + "PublicKeysProperties": { + "type": "object", + "description": "This contains the data about the public key.", + "properties": { + "path": { + "type": "string", + "description": "This specifies the full path on the VM where the SSH public key is stored." + }, + "keyData": { + "type": "string", + "description": "This is the SSH public key certificate used to authenticate with the VM." + } + } + }, + "TagsProperties": { + "type": "object", + "description": "This contains the properties of the tags in a tagsList.", + "properties": { + "name": { + "type": "string", + "description": "This is the name of the tag. It is equivalent to the key in the key-value pair format." + }, + "value": { + "type": "string", + "description": "This is the value of the tag. It is, as expected, equivalent to the value in the key-value pair format." + } + } + }, + "Ipv4Properties": { + "type": "object", + "description": "This contains the IPv4 properties.", + "properties": { + "privateIpAddress": { + "type": "string", + "description": "This is the private IP address assigned to the interface." + }, + "publicIpAddress": { + "type": "string", + "description": "This is the public IP address assigned to the interface." + } + } + }, + "Ipv6Properties": { + "type": "object", + "description": "This contains the IPv6 properties.", + "properties": { + "privateIpAddress": { + "type": "string", + "description": "This is the private IPv6 address assigned to the interface." + } + } + }, + "SubnetProperties": { + "type": "object", + "description": "This contains the properties of the subnet.", + "properties": { + "address": { + "type": "string", + "description": "This is the address range of the subnet." + }, + "prefix": { + "type": "string", + "description": "This is the prefix of the subnet." + } + } + }, + "SecurityProfile": { + "type": "object", + "description": "This contains the data about the security profile associated with the VM.", + "properties": { + "secureBootEnabled": { + "type": "string", + "description": "Identifies if UEFI secure boot is enabled on the VM" + }, + "virtualTpmEnabled": { + "type": "string", + "description": "Identifies if the virtual Trusted Platform Module (TPM) is enabled on the VM" + } + } + }, + "StorageProfile": { + "type": "object", + "description": "This contains the data about the storage disks associated with the VM.", + "properties": { + "imageReference": { + "type": "object", + "$ref": "#/definitions/ImageReference", + "description": "Image information" + }, + "osDisk": { + "type": "object", + "$ref": "#/definitions/OsDisk", + "description": "OS disk information" + }, + "dataDisks": { + "type": "array", + "description": "Data disk information", + "items": { + "type": "object", + "description": "This contains information about the data disk.", + "$ref": "#/definitions/DataDisk" + } + }, + "resourceDisk": { + "type": "object", + "description": "This contains data for the size of local temp disk of the VM, if it exists.", + "properties": { + "size": { + "type": "string", + "description": "The size of the local temp disk of the VM if it exists, in kilobytes. If the VM has no local temp disk, this value is 0." + } + } + } + } + }, + "ImageReference": { + "type": "object", + "description": "This contains information about the OS image.", + "properties": { + "id": { + "type": "string", + "description": "This is the resource ID." + }, + "offer": { + "type": "string", + "description": "This is the offer of the platform or marketplace image." + }, + "publisher": { + "type": "string", + "description": "This is the image publisher." + }, + "sku": { + "type": "string", + "description": "This is the image SKU." + }, + "version": { + "type": "string", + "description": "This is the version of the platform or marketplace image." + } + } + }, + "OsDisk": { + "type": "object", + "description": "This contains information about the OS disk used by the VM.", + "properties": { + "caching": { + "type": "string", + "description": "This is the caching requirements." + }, + "createOption": { + "type": "string", + "description": "This is information about how the VM was created." + }, + "diffDiskSettings": { + "type": "object", + "description": "This is the ephemeral disk settings.", + "$ref": "#/definitions/DiffDiskSettings" + }, + "diskSizeGB": { + "type": "string", + "description": "This is the size of the disk in GB." + }, + "encryptionSettings": { + "type": "object", + "description": "This is the encryption settings for the disk.", + "$ref": "#/definitions/EncryptionSettings" + }, + "image": { + "type": "object", + "description": "This is the source user image virtual hard disk.", + "$ref": "#/definitions/DiskImage" + }, + "managedDisk": { + "type": "object", + "description": "This is managed disk parameters.", + "$ref": "#/definitions/ManagedDisk" + }, + "name": { + "type": "string", + "description": "This is the disk name." + }, + "osType": { + "type": "string", + "description": "This is the type of OS included in the disk." + }, + "vhd": { + "type": "object", + "description": "This is the virtual hard disk.", + "$ref": "#/definitions/VirtualHardDisk" + }, + "writeAcceleratorEnabled": { + "type": "string", + "description": "This specifies whether or not writeAccelerator is enabled on the disk." + } + } + }, + "DataDisk": { + "type": "object", + "description": "This contains information about the data disk.", + "properties": { + "caching": { + "type": "string", + "description": "This is the caching requirements." + }, + "createOption": { + "type": "string", + "description": "This is information about how the VM was created." + }, + "diskSizeGB": { + "type": "string", + "description": "This is the size of the disk in GB." + }, + "image": { + "type": "object", + "description": "This is the source user image virtual hard disk.", + "$ref": "#/definitions/DiskImage" + }, + "lun": { + "type": "string", + "description": "This is the logical unit number of the disk." + }, + "managedDisk": { + "type": "object", + "description": "This is managed disk parameters.", + "$ref": "#/definitions/ManagedDisk" + }, + "name": { + "type": "string", + "description": "This is the disk name." + }, + "vhd": { + "type": "object", + "description": "This is the virtual hard disk.", + "$ref": "#/definitions/VirtualHardDisk" + }, + "writeAcceleratorEnabled": { + "type": "string", + "description": "This specifies whether or not writeAccelerator is enabled on the disk." + } + } + }, + "EncryptionSettings": { + "type": "object", + "description": "This is the encryption settings for the disk.", + "properties": { + "enabled": { + "type": "string", + "description": "This specifies whether or not disk encryption is enabled on the VM." + } + } + }, + "DiffDiskSettings": { + "type": "object", + "description": "This is the ephemeral disk settings.", + "properties": { + "option": { + "type": "string", + "description": "This specifies the ephemeral disk settings." + } + } + }, + "DiskImage": { + "type": "object", + "description": "This is the source user image virtual hard disk.", + "properties": { + "uri": { + "type": "string", + "description": "This is the uri of the virtual hard disk." + } + } + }, + "ManagedDisk": { + "type": "object", + "description": "This is managed disk parameters.", + "properties": { + "id": { + "type": "string", + "description": "This is the resource ID." + }, + "storageAccountType": { + "type": "string", + "description": "This is the storage account type for the managed disk." + } + } + }, + "VirtualHardDisk": { + "type": "object", + "description": "This is the virtual hard disk.", + "properties": { + "uri": { + "type": "string", + "description": "This is the uri of the virtual hard disk." + } + } + }, + "ApplicationResponse": { + "type": "string", + "description": "This is a binary string containing the application." + }, + "Instance": { + "type": "object", + "description": "This is the response from the Instance_GetMetadata operation.", + "properties": { + "compute": { + "$ref": "#/definitions/Compute", + "description": "Compute Metadata" + }, + "network": { + "$ref": "#/definitions/Network", + "description": "Network Metadata" + } + } + }, + "AttestedData": { + "type": "object", + "description": "This is the response from the Attested_GetDocument operation.", + "properties": { + "signature": { + "type": "string", + "description": "This is the encoded string containing the VM ID, SKU, plan information, public key, timestamp, and nonce value." + }, + "encoding": { + "type": "string", + "description": "This is the encoding scheme of the signature." + } + } + }, + "ErrorResponse": { + "description": "This is the response from an operation in the case an error occurs.", + "type": "object", + "properties": { + "error": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + }, + "IdentityErrorResponse": { + "type": "object", + "description": "This is the response from an Identity operation in the case an error occurs.", + "properties": { + "error": { + "type": "string", + "description": "Error code", + "enum": [ + "invalid_request", + "unauthorized_client", + "access_denied", + "unsupported_response_type", + "invalid_scope", + "server_error", + "service_unavailable", + "bad_request", + "forbidden", + "not_found", + "method_not_allowed", + "too_many_requests" + ], + "x-ms-enum": { + "name": "Error", + "modelAsString": true + } + }, + "error_description": { + "type": "string", + "description": "Error message indicating why the operation failed." + } + } + }, + "IdentityTokenResponse": { + "type": "object", + "description": "This is the response from the Identity_GetToken operation.", + "properties": { + "access_token": { + "type": "string", + "description": "This is the requested access token. The app can use this token to authenticate to the sink resource." + }, + "expires_in": { + "type": "string", + "description": "This is how long the access token is valid (in seconds)." + }, + "expires_on": { + "type": "string", + "description": "This is the time when the access token expires. The date is represented as the number of seconds from 1970-01-01T0:0:0Z UTC until the expiration time. This value is used to determine the lifetime of cached tokens." + }, + "ext_expires_in": { + "type": "string", + "description": "This indicates the extended lifetime of the token (in seconds)." + }, + "not_before": { + "type": "string", + "description": "This is the time when the access token becomes effective. The date is represented as the number of seconds from 1970-01-01T0:0:0Z UTC until the expiration time." + }, + "resource": { + "type": "string", + "description": "This is the app ID URI of the sink resource." + }, + "token_type": { + "type": "string", + "description": "This indicates the token type value." + }, + "client_id": { + "type": "string", + "description": "This is the client_id specified in the request, if any." + }, + "object_id": { + "type": "string", + "description": "This is the object_id specified in the request, if any." + }, + "msi_res_id": { + "type": "string", + "description": "This is the msi_res_id specified in the request, if any." + } + } + }, + "IdentityInfoResponse": { + "type": "object", + "description": "This is the response from the Identity_GetInfo operation.", + "properties": { + "tenantId": { + "type": "string", + "description": "This is the AAD tenantId of the identity of the system assigned managed identity." + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "type": "string", + "enum": [ + "2018-10-01" + ], + "description": "This is the API version to use.", + "required": true, + "x-ms-enum": { + "name": "ApiVersion", + "modelAsString": true + } + }, + "MetadataParameter": { + "name": "Metadata", + "in": "header", + "type": "string", + "enum": [ + "true" + ], + "description": "This must be set to 'true'.", + "required": true, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/imds/data-plane/readme.md b/specification/imds/data-plane/readme.md index 909b82a53edc..05a3ec15a057 100644 --- a/specification/imds/data-plane/readme.md +++ b/specification/imds/data-plane/readme.md @@ -27,7 +27,7 @@ These are the global settings for the Instance Metadata Service API. ``` yaml openapi-type: data-plane azure-arm: false -tag: package-2021-01-01 +tag: package-2021-02-01 ``` ### Tag: package-2018-10-01 @@ -165,6 +165,15 @@ input-file: - Microsoft.InstanceMetadataService/stable/2021-01-01/imds.json ``` +### Tag: package-2021-02-01 + +These settings apply only when `--tag=package-2021-02-01` is specified on the command line. + +``` yaml $(tag) == 'package-2021-02-01' +input-file: + - Microsoft.InstanceMetadataService/stable/2021-02-01/imds.json +``` + ## Suppression ``` yaml @@ -414,8 +423,23 @@ directive: - $.definitions.IdentityTokenResponse.properties.object_id - $.definitions.IdentityTokenResponse.properties.msi_res_id - $.definitions.IdentityErrorResponse.properties.error_description -``` + - suppress: DefinitionsPropertiesNamesCamelCase + reason: The following properties follow the Oath2 spec, which does not use camelCase. + from: Microsoft.InstanceMetadataService/stable/2021-02-01/imds.json + where: + - $.definitions.IdentityTokenResponse.properties.access_token + - $.definitions.IdentityTokenResponse.properties.expires_in + - $.definitions.IdentityTokenResponse.properties.expires_on + - $.definitions.IdentityTokenResponse.properties.ext_expires_in + - $.definitions.IdentityTokenResponse.properties.not_before + - $.definitions.IdentityTokenResponse.properties.resource + - $.definitions.IdentityTokenResponse.properties.token_type + - $.definitions.IdentityTokenResponse.properties.client_id + - $.definitions.IdentityTokenResponse.properties.object_id + - $.definitions.IdentityTokenResponse.properties.msi_res_id + - $.definitions.IdentityErrorResponse.properties.error_description +``` --- @@ -477,8 +501,7 @@ input-file: - $(this-folder)/Microsoft.InstanceMetadataService/stable/2020-10-01/imds.json - $(this-folder)/Microsoft.InstanceMetadataService/stable/2020-12-01/imds.json - $(this-folder)/Microsoft.InstanceMetadataService/stable/2021-01-01/imds.json - - + - $(this-folder)/Microsoft.InstanceMetadataService/stable/2021-02-01/imds.json ``` diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/IotHub_ManualFailover.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/IotHub_ManualFailover.json new file mode 100644 index 000000000000..1d65a6848d47 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/IotHub_ManualFailover.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "iotHubName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "failoverInput": { + "failoverRegion": "testHub" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/checkNameAvailability.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/checkNameAvailability.json new file mode 100644 index 000000000000..e6ff55327c77 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/checkNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "operationInputs": { + "name": "test-request" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "reason": "Invalid", + "message": "" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_certificatescreateorupdate.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_certificatescreateorupdate.json new file mode 100644 index 000000000000..f7037bd4a0f7 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_certificatescreateorupdate.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "resourceName": "iothub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "certificateDescription": { + "properties": { + "certificate": "############################################" + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "subject": "CN=testdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:23:50 GMT", + "certificate": "############################################" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServives/myFirstProvisioningService/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/IotHubs/Certificates", + "etag": "AAAAAAExpNs=" + } + }, + "200": { + "body": { + "properties": { + "subject": "CN=testdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:23:50 GMT", + "certificate": "############################################" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServives/myFirstProvisioningService/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/IotHubs/Certificates", + "etag": "AAAAAAExpNs=" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_certificatesdelete.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_certificatesdelete.json new file mode 100644 index 000000000000..a5713a94276c --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_certificatesdelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceName": "myhub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "If-Match": "AAAAAAAADGk=" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_certverify.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_certverify.json new file mode 100644 index 000000000000..9b41efa91acf --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_certverify.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "resourceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "If-Match": "AAAAAAAADGk=", + "certificateVerificationBody": { + "certificate": "#####################################" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "subject": "CN=andbucdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25", + "isVerified": true, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:26:56 GMT" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/IotHubs/Certificates", + "etag": "AAAAAAExpTQ=" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_createOrUpdate.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_createOrUpdate.json new file mode 100644 index 000000000000..7c3613660947 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_createOrUpdate.json @@ -0,0 +1,296 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "iotHubDescription": { + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "ipFilterRules": [], + "networkRuleSets": { + "defaultAction": "Deny", + "applyToBuiltInEventHubEndpoint": true, + "ipRules": [ + { + "filterName": "rule1", + "action": "Allow", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Allow", + "ipMask": "157.55.59.128/25" + } + ] + }, + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2 + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "name": "$fallback", + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None", + "minTlsVersion": "1.2" + }, + "sku": { + "name": "S1", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [ + { + "filterName": "rule1", + "action": "Accept", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Accept", + "ipMask": "157.55.59.128/25" + } + ], + "networkRuleSets": { + "defaultAction": "Deny", + "applyToBuiltInEventHubEndpoint": true, + "ipRules": [ + { + "filterName": "rule1", + "action": "Allow", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Allow", + "ipMask": "157.55.59.128/25" + } + ] + }, + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "name": "$fallback", + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None", + "minTlsVersion": "1.2" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [ + { + "filterName": "rule1", + "action": "Accept", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Accept", + "ipMask": "157.55.59.128/25" + } + ], + "networkRuleSets": { + "defaultAction": "Deny", + "applyToBuiltInEventHubEndpoint": true, + "ipRules": [ + { + "filterName": "rule1", + "action": "Allow", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Allow", + "ipMask": "157.55.59.128/25" + } + ] + }, + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "name": "$fallback", + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None", + "minTlsVersion": "1.2" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_createconsumergroup.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_createconsumergroup.json new file mode 100644 index 000000000000..18cc97a1451a --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_createconsumergroup.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "eventHubEndpointName": "events", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "name": "test", + "consumerGroupBody": { + "properties": { + "name": "test" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "created": "Thu, 15 Jun 2017 19:20:58 GMT" + }, + "id": "/subscriptions/cmd-sub-1/resourceGroups/cmd-rg-1/providers/Microsoft.Devices/IotHubs/test-hub-2/eventHubEndpoints/events/ConsumerGroups/%24Default", + "name": "test", + "type": "Microsoft.Devices/IotHubs/EventHubEndpoints/ConsumerGroups", + "etag": "AAAAAAFD6M4=" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_delete.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_delete.json new file mode 100644 index 000000000000..b6d97699ea49 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_delete.json @@ -0,0 +1,218 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [ + { + "filterName": "rule1", + "action": "Accept", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Accept", + "ipMask": "157.55.59.128/25" + } + ], + "networkRuleSets": { + "defaultAction": "Deny", + "applyToBuiltInEventHubEndpoint": true, + "ipRules": [ + { + "filterName": "rule1", + "action": "Allow", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Allow", + "ipMask": "157.55.59.128/25" + } + ] + }, + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + }, + "204": {}, + "202": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [ + { + "filterName": "rule1", + "action": "Accept", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Accept", + "ipMask": "157.55.59.128/25" + } + ], + "networkRuleSets": { + "defaultAction": "Deny", + "applyToBuiltInEventHubEndpoint": true, + "ipRules": [ + { + "filterName": "rule1", + "action": "Allow", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Allow", + "ipMask": "157.55.59.128/25" + } + ] + }, + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + }, + "404": { + "body": {} + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_deleteconsumergroup.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_deleteconsumergroup.json new file mode 100644 index 000000000000..88ed6e0fb88e --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_deleteconsumergroup.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "eventHubEndpointName": "events", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "name": "test" + }, + "responses": { + "200": {} + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_deleteprivateendpointconnection.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_deleteprivateendpointconnection.json new file mode 100644 index 000000000000..d4406f95a125 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_deleteprivateendpointconnection.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "privateEndpointConnectionName": "myPrivateEndpointConnection" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/IotHubs/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Disconnected", + "description": "Deleted", + "actionsRequired": "None" + } + } + } + }, + "202": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/IotHubs/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Disconnected", + "description": "Deleted", + "actionsRequired": "None" + } + } + } + }, + "204": {} + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_exportdevices.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_exportdevices.json new file mode 100644 index 000000000000..c3fa85a6b3d0 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_exportdevices.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "exportDevicesParameters": { + "authenticationType": "identityBased", + "identity": { + "userAssignedIdentity": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1" + }, + "exportBlobContainerUri": "testBlob", + "excludeKeys": true + } + }, + "responses": { + "200": { + "body": { + "jobId": "test", + "startTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "endTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "type": "unknown", + "status": "unknown" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_generateverificationcode.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_generateverificationcode.json new file mode 100644 index 000000000000..73a5e01b4b21 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_generateverificationcode.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "If-Match": "AAAAAAAADGk=" + }, + "responses": { + "200": { + "body": { + "name": "cert", + "properties": { + "verificationCode": "##################################", + "subject": "CN=andbucdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "##############################", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:26:56 GMT" + } + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_get.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_get.json new file mode 100644 index 000000000000..3839dc0f69b4 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_get.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [ + { + "filterName": "rule1", + "action": "Accept", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Accept", + "ipMask": "157.55.59.128/25" + } + ], + "networkRuleSets": { + "defaultAction": "Deny", + "applyToBuiltInEventHubEndpoint": true, + "ipRules": [ + { + "filterName": "rule1", + "action": "Allow", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Allow", + "ipMask": "157.55.59.128/25" + } + ] + }, + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None", + "deviceStreams": { + "streamingEndpoints": [ + "https://streams.azure-devices-int.net:9443" + ] + }, + "locations": [ + { + "location": "West US", + "role": "primary" + }, + { + "location": "East US", + "role": "secondary" + } + ], + "minTlsVersion": "1.2" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_getcertificate.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_getcertificate.json new file mode 100644 index 000000000000..6cd53ac4a049 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_getcertificate.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "resourceName": "testhub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert" + }, + "responses": { + "200": { + "body": { + "properties": { + "subject": "CN=testdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:23:50 GMT", + "certificate": "############################################" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/andbuc-hub/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/IotHubs/Certificates", + "etag": "AAAAAAExpNs=" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_getconsumergroup.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_getconsumergroup.json new file mode 100644 index 000000000000..a38dfcc78825 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_getconsumergroup.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "eventHubEndpointName": "events", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "name": "test" + }, + "responses": { + "200": { + "body": { + "properties": { + "created": "Thu, 15 Jun 2017 19:20:58 GMT" + }, + "id": "/subscriptions/cmd-sub-1/resourceGroups/cmd-rg-1/providers/Microsoft.Devices/IotHubs/test-hub-2/eventHubEndpoints/events/ConsumerGroups/%24Default", + "name": "test", + "type": "Microsoft.Devices/IotHubs/EventHubEndpoints/ConsumerGroups", + "etag": "AAAAAAFD6M4=" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_getjob.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_getjob.json new file mode 100644 index 000000000000..a0ff33cf5925 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_getjob.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "jobId": "test" + }, + "responses": { + "200": { + "body": { + "jobId": "test", + "startTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "endTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "type": "unknown", + "status": "unknown" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_getkey.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_getkey.json new file mode 100644 index 000000000000..e4b07a4d1a7f --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_getkey.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "keyName": "iothubowner" + }, + "responses": { + "200": { + "body": { + "keyName": "iothubowner", + "primaryKey": "", + "secondaryKey": "", + "rights": "RegistryWrite, ServiceConnect, DeviceConnect" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_getprivateendpointconnection.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_getprivateendpointconnection.json new file mode 100644 index 000000000000..ab2f52a3b66a --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_getprivateendpointconnection.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "privateEndpointConnectionName": "myPrivateEndpointConnection" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/IotHubs/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my request!", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_getprivatelinkresources.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_getprivatelinkresources.json new file mode 100644 index 000000000000..3adf004a1b87 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_getprivatelinkresources.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "groupId": "iotHub" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateLinkResources/iotHub", + "name": "iotHub", + "type": "Microsoft.Devices/IotHubs/PrivateLinkResources", + "properties": { + "groupId": "iotHub", + "requiredMembers": [ + "iotHub" + ], + "requiredZoneNames": [ + "privatelink.azure-devices.net" + ] + } + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_getskus.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_getskus.json new file mode 100644 index 000000000000..1aa3c9950053 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_getskus.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.Devices/IotHubs", + "sku": { + "name": "S1", + "tier": "Standard" + }, + "capacity": { + "default": 1, + "scaleType": "Manual" + } + }, + { + "resourceType": "Microsoft.Devices/IotHubs", + "sku": { + "name": "S2", + "tier": "Standard" + }, + "capacity": { + "minimum": 1, + "maximum": 200, + "default": 1, + "scaleType": "Manual" + } + }, + { + "resourceType": "Microsoft.Devices/IotHubs", + "sku": { + "name": "S3", + "tier": "Standard" + }, + "capacity": { + "minimum": 1, + "maximum": 10, + "default": 1, + "scaleType": "Manual" + } + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_importdevices.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_importdevices.json new file mode 100644 index 000000000000..ac64e0b3d738 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_importdevices.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "importDevicesParameters": { + "inputBlobContainerUri": "testBlob", + "outputBlobContainerUri": "testBlob" + } + }, + "responses": { + "200": { + "body": { + "jobId": "test", + "startTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "endTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "type": "unknown", + "status": "unknown" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listbyrg.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listbyrg.json new file mode 100644 index 000000000000..c5ed4976efbc --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listbyrg.json @@ -0,0 +1,117 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [ + { + "filterName": "rule1", + "action": "Accept", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Accept", + "ipMask": "157.55.59.128/25" + } + ], + "networkRuleSets": { + "defaultAction": "Deny", + "applyToBuiltInEventHubEndpoint": true, + "ipRules": [ + { + "filterName": "rule1", + "action": "Allow", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Allow", + "ipMask": "157.55.59.128/25" + } + ] + }, + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "name": "$fallback", + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listbysubscription.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listbysubscription.json new file mode 100644 index 000000000000..14350742488e --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listbysubscription.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "resourceName": "testHub", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [ + { + "filterName": "rule1", + "action": "Accept", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Accept", + "ipMask": "157.55.59.128/25" + } + ], + "networkRuleSets": { + "defaultAction": "Deny", + "applyToBuiltInEventHubEndpoint": true, + "ipRules": [ + { + "filterName": "rule1", + "action": "Allow", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Allow", + "ipMask": "157.55.59.128/25" + } + ] + }, + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "name": "$fallback", + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listcertificates.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listcertificates.json new file mode 100644 index 000000000000..d7ef4e0c130c --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listcertificates.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "resourceName": "testhub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "subject": "CN=testdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:23:50 GMT", + "certificate": "############################################" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/andbuc-hub/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/IotHubs/Certificates", + "etag": "AAAAAAExpNs=" + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listehgroups.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listehgroups.json new file mode 100644 index 000000000000..f88a439377a6 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listehgroups.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "eventHubEndpointName": "events", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "created": "Thu, 15 Jun 2017 19:20:58 GMT" + }, + "id": "/subscriptions/cmd-sub-1/resourceGroups/cmd-rg-1/providers/Microsoft.Devices/IotHubs/test-hub-2/eventHubEndpoints/events/ConsumerGroups/%24Default", + "name": "$Default", + "type": "Microsoft.Devices/IotHubs/EventHubEndpoints/ConsumerGroups", + "etag": "AAAAAAFD6M4=" + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listjobs.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listjobs.json new file mode 100644 index 000000000000..c5794fa1242a --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listjobs.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "jobId": "test", + "startTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "endTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "type": "unknown", + "status": "unknown" + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listkeys.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listkeys.json new file mode 100644 index 000000000000..73bc257563d8 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listkeys.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "keyName": "iothubowner", + "primaryKey": "", + "secondaryKey": "", + "rights": "RegistryWrite, ServiceConnect, DeviceConnect" + }, + { + "keyName": "service", + "primaryKey": "", + "secondaryKey": "", + "rights": "ServiceConnect" + }, + { + "keyName": "device", + "primaryKey": "", + "secondaryKey": "", + "rights": "DeviceConnect" + }, + { + "keyName": "registryRead", + "primaryKey": "", + "secondaryKey": "", + "rights": "RegistryRead" + }, + { + "keyName": "registryReadWrite", + "primaryKey": "", + "secondaryKey": "", + "rights": "RegistryWrite" + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listprivateendpointconnections.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listprivateendpointconnections.json new file mode 100644 index 000000000000..6898e9369965 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listprivateendpointconnections.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": [ + { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/IotHubs/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my request!", + "actionsRequired": "None" + } + } + } + ] + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listprivatelinkresources.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listprivatelinkresources.json new file mode 100644 index 000000000000..afe9def02ea0 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_listprivatelinkresources.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateLinkResources/iotHub", + "name": "iotHub", + "type": "Microsoft.Devices/IotHubs/PrivateLinkResources", + "properties": { + "groupId": "iotHub", + "requiredMembers": [ + "iotHub" + ], + "requiredZoneNames": [ + "privatelink.azure-devices.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_operations.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_operations.json new file mode 100644 index 000000000000..33372b8d4106 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_operations.json @@ -0,0 +1,328 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Devices/register/action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Register Resource Provider", + "description": "Register the subscription for the IotHub resource provider and enables the creation of IotHub resources" + } + }, + { + "name": "Microsoft.Devices/IotHubs/diagnosticSettings/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Diagnostic Setting", + "description": "Gets the diagnostic setting for the resource" + } + }, + { + "name": "Microsoft.Devices/IotHubs/diagnosticSettings/write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Set Diagnostic Setting", + "description": "Creates or updates the diagnostic setting for the resource" + } + }, + { + "name": "Microsoft.Devices/IotHubs/metricDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read IotHub service metric definitions", + "description": "Gets the available metrics for the IotHub service" + } + }, + { + "name": "Microsoft.Devices/IotHubs/logDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read IotHub service log definitions", + "description": "Gets the available log definitions for the IotHub Service" + } + }, + { + "name": "Microsoft.Devices/operations/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get All ResourceProvider Operations", + "description": "Get All ResourceProvider Operations" + } + }, + { + "name": "Microsoft.Devices/checkNameAvailability/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Check If IotHub name is available", + "description": "Check If IotHub name is available" + } + }, + { + "name": "Microsoft.Devices/usages/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Subscription Usages", + "description": "Get subscription usage details for this provider." + } + }, + { + "name": "Microsoft.Devices/iotHubs/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get IotHub(s)", + "description": "Gets the IotHub resource(s)" + } + }, + { + "name": "Microsoft.Devices/iotHubs/Write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Create or update IotHub Resource", + "description": "Create or update IotHub Resource" + } + }, + { + "name": "Microsoft.Devices/iotHubs/Delete", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Delete IotHub Resource", + "description": "Delete IotHub Resource" + } + }, + { + "name": "Microsoft.Devices/iotHubs/iotHubStats/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get IotHub Statistics", + "description": "Get IotHub Statistics" + } + }, + { + "name": "Microsoft.Devices/iotHubs/skus/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get valid IotHub Skus", + "description": "Get valid IotHub Skus" + } + }, + { + "name": "Microsoft.Devices/iotHubs/listkeys/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get all IotHub Keys", + "description": "Get all IotHub Keys" + } + }, + { + "name": "Microsoft.Devices/iotHubs/iotHubKeys/listkeys/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get IotHub Key for the given name", + "description": "Get IotHub Key for the given name" + } + }, + { + "name": "Microsoft.Devices/iotHubs/eventHubEndpoints/consumerGroups/Write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Create EventHub Consumer Group", + "description": "Create EventHub Consumer Group" + } + }, + { + "name": "Microsoft.Devices/iotHubs/eventHubEndpoints/consumerGroups/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get EventHub Consumer Group(s)", + "description": "Get EventHub Consumer Group(s)" + } + }, + { + "name": "Microsoft.Devices/iotHubs/eventHubEndpoints/consumerGroups/Delete", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Delete EventHub Consumer Group", + "description": "Delete EventHub Consumer Group" + } + }, + { + "name": "Microsoft.Devices/iotHubs/exportDevices/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Export Devices", + "description": "Export Devices" + } + }, + { + "name": "Microsoft.Devices/iotHubs/importDevices/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Import Devices", + "description": "Import Devices" + } + }, + { + "name": "Microsoft.Devices/iotHubs/jobs/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get the Job(s) on IotHub", + "description": "Get Job(s) details submitted on given IotHub" + } + }, + { + "name": "Microsoft.Devices/iotHubs/quotaMetrics/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Quota Metrics", + "description": "Get Quota Metrics" + } + }, + { + "name": "Microsoft.Devices/iotHubs/routing/routes/$testall/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Routing Rule Test All", + "description": "Test a message against all existing Routes" + } + }, + { + "name": "Microsoft.Devices/iotHubs/routing/routes/$testnew/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Routing Rule Test Route", + "description": "Test a message against a provided test Route" + } + }, + { + "name": "Microsoft.Devices/iotHubs/routingEndpointsHealth/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Endpoint Health", + "description": "Gets the health of all routing Endpoints for an IotHub" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/diagnosticSettings/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Diagnostic Setting", + "description": "Gets the diagnostic setting for the resource" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/diagnosticSettings/write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Set Diagnostic Setting", + "description": "Creates or updates the diagnostic setting for the resource" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/metricDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read DPS service metric definitions", + "description": "Gets the available metrics for the DPS service" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/logDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read DPS service log definitions", + "description": "Gets the available log definitions for the DPS Service" + } + }, + { + "name": "Microsoft.Devices/checkProvisioningServiceNameAvailability/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServives", + "operation": "Check If Provisioning Service name is available", + "description": "Check If Provisioning Service name is available" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Get Provisioning Service resource", + "description": "Get Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/Write", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Create Provisioning Service resource", + "description": "Create Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/Delete", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Delete Provisioning Service resource", + "description": "Delete Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/skus/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Delete Provisioning Service resource", + "description": "Delete Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/listkeys/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "get security related metadata", + "description": "get security related metadata" + } + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_patch.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_patch.json new file mode 100644 index 000000000000..320e452e6ffe --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_patch.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "resourceName": "myHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "location": "East US", + "type": "Microsoft.Devices/IotHubs", + "IotHubTags": { + "tags": { + "foo": "bar" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": { + "foo": "bar" + }, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [ + { + "filterName": "rule1", + "action": "Accept", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Accept", + "ipMask": "157.55.59.128/25" + } + ], + "networkRuleSets": { + "defaultAction": "Deny", + "applyToBuiltInEventHubEndpoint": true, + "ipRules": [ + { + "filterName": "rule1", + "action": "Allow", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Allow", + "ipMask": "157.55.59.128/25" + } + ] + }, + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "name": "$fallback", + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_quotametrics.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_quotametrics.json new file mode 100644 index 000000000000..5151ac2a940e --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_quotametrics.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TotalMessages", + "currentValue": 0, + "maxValue": 400000 + }, + { + "name": "TotalDeviceCount", + "currentValue": 0, + "maxValue": 500000 + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_routingendpointhealth.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_routingendpointhealth.json new file mode 100644 index 000000000000..b54598780347 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_routingendpointhealth.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "iotHubName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "endpointId": "id1", + "healthStatus": "healthy", + "lastSuccessfulSendAttemptTime": "2020-03-26T21:20:57Z", + "lastSendAttemptTime": "2020-03-26T21:24:57Z" + }, + { + "endpointId": "id2", + "healthStatus": "unknown" + }, + { + "endpointId": "id3", + "healthStatus": "unhealthy", + "lastKnownError": "NotFound", + "lastKnownErrorTime": "2020-03-26T21:24:57Z", + "lastSuccessfulSendAttemptTime": "2020-03-26T21:20:57Z", + "lastSendAttemptTime": "2020-03-26T21:24:57Z" + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_stats.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_stats.json new file mode 100644 index 000000000000..1a7bcb918e7e --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_stats.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "totalDeviceCount": 0, + "enabledDeviceCount": 0, + "disabledDeviceCount": 0 + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_testallroutes.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_testallroutes.json new file mode 100644 index 000000000000..de87f522df41 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_testallroutes.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "iotHubName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "input": { + "routingSource": "DeviceMessages", + "message": { + "body": "Body of message", + "appProperties": { + "key1": "value1" + }, + "systemProperties": { + "key1": "value1" + } + } + } + }, + "responses": { + "200": { + "body": { + "routes": [ + { + "properties": { + "name": "Routeid", + "source": "DeviceMessages", + "endpointNames": [ + "id1" + ], + "isEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_testnewroute.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_testnewroute.json new file mode 100644 index 000000000000..0bfeefb5f260 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_testnewroute.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "iotHubName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "input": { + "message": { + "body": "Body of message", + "appProperties": { + "key1": "value1" + }, + "systemProperties": { + "key1": "value1" + } + }, + "route": { + "name": "Routeid", + "source": "DeviceMessages", + "endpointNames": [ + "id1" + ], + "isEnabled": true + } + } + }, + "responses": { + "200": { + "body": { + "result": "false", + "details": { + "compilationErrors": [ + { + "message": "string response", + "severity": "error", + "location": { + "start": { + "line": 12, + "column": 12 + }, + "end": { + "line": 12, + "column": 24 + } + } + } + ] + } + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_updateprivateendpointconnection.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_updateprivateendpointconnection.json new file mode 100644 index 000000000000..d8cbaa4ae2c7 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_updateprivateendpointconnection.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "privateEndpointConnectionName": "myPrivateEndpointConnection", + "privateEndpointConnection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/IotHubs/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com", + "actionsRequired": "None" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/IotHubs/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_usages.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_usages.json new file mode 100644 index 000000000000..48053d6c25b5 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/examples/iothub_usages.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscription/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/usages/freeHubCount", + "type": "/subscription/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/usages", + "unit": "count", + "currentValue": 1, + "limit": 1, + "name": { + "value": "FreeHubCount", + "localizedValue": "Free Hub Count" + } + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/iothub.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/iothub.json new file mode 100644 index 000000000000..20bcc3ebc997 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2021-07-01-preview/iothub.json @@ -0,0 +1,4451 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-07-01-preview", + "title": "iotHubClient", + "description": "Use this API to manage the IoT hubs in your Azure subscription.", + "x-ms-code-generation-settings": { + "header": "MICROSOFT_MIT_NO_VERSION" + } + }, + "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.Devices/operations": { + "get": { + "tags": [ + "Operations" + ], + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/iothub_operations.json" + } + }, + "operationId": "Operations_List", + "description": "Lists all of the available IoT Hub REST API operations.", + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the non-security related metadata of an IoT hub", + "description": "Get the non-security related metadata of an IoT hub.", + "operationId": "IotHubResource_Get", + "x-ms-examples": { + "IotHubResource_Get": { + "$ref": "./examples/iothub_get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "The body contains all the non-security properties of the IoT hub. Security-related properties are set to null.", + "schema": { + "$ref": "#/definitions/IotHubDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "PUT" + ], + "summary": "Create or update the metadata of an IoT hub.", + "description": "Create or update the metadata of an Iot hub. The usual pattern to modify a property is to retrieve the IoT hub metadata and security metadata, and then combine them with the modified values in a new body to update the IoT hub.", + "operationId": "IotHubResource_CreateOrUpdate", + "x-ms-examples": { + "IotHubResource_CreateOrUpdate": { + "$ref": "./examples/iothub_createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "iotHubDescription", + "in": "body", + "description": "The IoT hub metadata and security metadata.", + "required": true, + "schema": { + "$ref": "#/definitions/IotHubDescription" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the IoT Hub. Do not specify for creating a brand new IoT Hub. Required to update an existing IoT Hub." + } + ], + "responses": { + "201": { + "description": "This is a long running operation. The operation returns a 201 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation. If successful, the operation returns HTTP status code of 201 (OK).", + "schema": { + "$ref": "#/definitions/IotHubDescription" + } + }, + "200": { + "description": "This is returned as a response to the status polling request for the create or update operation. The body contains the resource representation that indicates a transitional provisioning state.", + "schema": { + "$ref": "#/definitions/IotHubDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "patch": { + "tags": [ + "PATCH" + ], + "summary": "Update an existing IoT Hubs tags.", + "description": "Update an existing IoT Hub tags. to update other fields use the CreateOrUpdate method", + "x-ms-long-running-operation": true, + "operationId": "IotHubResource_Update", + "x-ms-examples": { + "IotHubResource_Update": { + "$ref": "./examples/iothub_patch.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of iot hub to update." + }, + { + "name": "IotHubTags", + "in": "body", + "required": true, + "description": "Updated tag information to set into the iot hub instance.", + "schema": { + "$ref": "#/definitions/TagsResource" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Iot Hub was successfully updated", + "schema": { + "$ref": "#/definitions/IotHubDescription" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "tags": [ + "DELETE" + ], + "summary": "Delete an IoT hub", + "description": "Delete an IoT hub.", + "operationId": "IotHubResource_Delete", + "x-ms-examples": { + "IotHubResource_Delete": { + "$ref": "./examples/iothub_delete.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "202": { + "description": "The Iot Hub resource provider always returns a 202 Accepted status code with valid Location and Retry-After headers. The resource provider also sets the Azure-AsyncOperation header with a URL that points to the operation resource for this operation. Subsequent GET attempts on the resource after a DELETE operation return a resource representation that indicates a transitional provisioning state (such as Terminating). To retrieve the status of the operation, a client can either poll the URL returned in the Location header after the Retry-After interval, get the IoT Hub service status directly, or query the operation resource.", + "schema": { + "$ref": "#/definitions/IotHubDescription" + } + }, + "200": { + "description": "This is returned as a response to the status polling request for the delete operation. The body contains the resource representation that indicates a transitional provisioning state.", + "schema": { + "$ref": "#/definitions/IotHubDescription" + } + }, + "204": { + "description": "Once the long running delete operation completes successfully, a 204 No Content status code is returned when the status polling request finds the Iot hub metadata in the service and the status of the delete operation is set to a completed state." + }, + "404": { + "description": "After the long running delete operation completes successfully, a 404 Not Found is returned when the status polling request no longer finds the Iot hub metadata in the service.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Devices/IotHubs": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get all the IoT hubs in a subscription", + "description": "Get all the IoT hubs in a subscription.", + "operationId": "IotHubResource_ListBySubscription", + "x-ms-examples": { + "IotHubResource_ListBySubscription": { + "$ref": "./examples/iothub_listbysubscription.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the IoT hubs in the subscription.", + "schema": { + "$ref": "#/definitions/IotHubDescriptionListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get all the IoT hubs in a resource group", + "description": "Get all the IoT hubs in a resource group.", + "operationId": "IotHubResource_ListByResourceGroup", + "x-ms-examples": { + "IotHubResource_ListByResourceGroup": { + "$ref": "./examples/iothub_listbyrg.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the IoT hubs in the resource group.", + "schema": { + "$ref": "#/definitions/IotHubDescriptionListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubStats": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the statistics from an IoT hub", + "description": "Get the statistics from an IoT hub.", + "operationId": "IotHubResource_GetStats", + "x-ms-examples": { + "IotHubResource_GetStats": { + "$ref": "./examples/iothub_stats.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains JSON-serialized statistics from the identity registry in the IoT hub.", + "schema": { + "$ref": "#/definitions/RegistryStatistics" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/skus": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the list of valid SKUs for an IoT hub", + "description": "Get the list of valid SKUs for an IoT hub.", + "operationId": "IotHubResource_GetValidSkus", + "x-ms-examples": { + "IotHubResource_GetValidSkus": { + "$ref": "./examples/iothub_getskus.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the valid SKUs for this IoT hub.", + "schema": { + "$ref": "#/definitions/IotHubSkuDescriptionListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub", + "description": "Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub.", + "operationId": "IotHubResource_ListEventHubConsumerGroups", + "x-ms-examples": { + "IotHubResource_ListEventHubConsumerGroups": { + "$ref": "./examples/iothub_listehgroups.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "eventHubEndpointName", + "in": "path", + "description": "The name of the Event Hub-compatible endpoint.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized list of the consumer groups in the Event Hub-compatible endpoint in this IoT hub", + "schema": { + "$ref": "#/definitions/EventHubConsumerGroupsListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub", + "description": "Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub.", + "operationId": "IotHubResource_GetEventHubConsumerGroup", + "x-ms-examples": { + "IotHubResource_ListEventHubConsumerGroups": { + "$ref": "./examples/iothub_getconsumergroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "eventHubEndpointName", + "in": "path", + "description": "The name of the Event Hub-compatible endpoint in the IoT hub.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the consumer group to retrieve.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized consumer group.", + "schema": { + "$ref": "#/definitions/EventHubConsumerGroupInfo" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "PUT" + ], + "summary": "Add a consumer group to an Event Hub-compatible endpoint in an IoT hub", + "description": "Add a consumer group to an Event Hub-compatible endpoint in an IoT hub.", + "operationId": "IotHubResource_CreateEventHubConsumerGroup", + "x-ms-examples": { + "IotHubResource_CreateEventHubConsumerGroup": { + "$ref": "./examples/iothub_createconsumergroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "eventHubEndpointName", + "in": "path", + "description": "The name of the Event Hub-compatible endpoint in the IoT hub.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the consumer group to add.", + "required": true, + "type": "string" + }, + { + "name": "consumerGroupBody", + "in": "body", + "description": "The consumer group to add.", + "required": true, + "schema": { + "$ref": "#/definitions/EventHubConsumerGroupBodyDescription" + } + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation.", + "schema": { + "$ref": "#/definitions/EventHubConsumerGroupInfo" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "DELETE" + ], + "summary": "Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub", + "description": "Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub.", + "operationId": "IotHubResource_DeleteEventHubConsumerGroup", + "x-ms-examples": { + "IotHubResource_DeleteEventHubConsumerGroup": { + "$ref": "./examples/iothub_deleteconsumergroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "eventHubEndpointName", + "in": "path", + "description": "The name of the Event Hub-compatible endpoint in the IoT hub.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the consumer group to delete.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry", + "description": "Get a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.", + "operationId": "IotHubResource_ListJobs", + "x-ms-examples": { + "IotHubResource_ListJobs": { + "$ref": "./examples/iothub_listjobs.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The response contains a JSON-serialized array of all the jobs in the IoT hub.", + "schema": { + "$ref": "#/definitions/JobResponseListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs/{jobId}": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry", + "description": "Get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.", + "operationId": "IotHubResource_GetJob", + "x-ms-examples": { + "IotHubResource_GetJob": { + "$ref": "./examples/iothub_getjob.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "jobId", + "in": "path", + "description": "The job identifier.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The response contains a JSON-serialized description of the job in the IoT hub.", + "schema": { + "$ref": "#/definitions/JobResponse" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/quotaMetrics": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the quota metrics for an IoT hub", + "description": "Get the quota metrics for an IoT hub.", + "operationId": "IotHubResource_GetQuotaMetrics", + "x-ms-examples": { + "IotHubResource_GetQuotaMetrics": { + "$ref": "./examples/iothub_quotametrics.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The response contains a JSON-serialized array of the quota metrics for the IoT hub.", + "schema": { + "$ref": "#/definitions/IotHubQuotaMetricInfoListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routingEndpointsHealth": { + "get": { + "tags": [ + "GET" + ], + "operationId": "IotHubResource_GetEndpointHealth", + "summary": "Get the health for routing endpoints", + "description": "Get the health for routing endpoints.", + "x-ms-examples": { + "IotHubResource_GetEndpointHealth": { + "$ref": "./examples/iothub_routingendpointhealth.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "iotHubName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EndpointHealthDataListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkNameAvailability": { + "post": { + "tags": [ + "POST" + ], + "summary": "Check if an IoT hub name is available", + "description": "Check if an IoT hub name is available.", + "operationId": "IotHubResource_CheckNameAvailability", + "x-ms-examples": { + "IotHubResource_CheckNameAvailability": { + "$ref": "./examples/checkNameAvailability.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "operationInputs", + "in": "body", + "description": "Set the name parameter in the OperationInputs structure to the name of the IoT hub to check.", + "required": true, + "schema": { + "$ref": "#/definitions/OperationInputs" + } + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the IoT hub name is available. If the name is not available, the body contains the reason.", + "schema": { + "$ref": "#/definitions/IotHubNameAvailabilityInfo" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Devices/usages": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the number of iot hubs in the subscription", + "description": "Get the number of free and paid iot hubs in the subscription", + "operationId": "ResourceProviderCommon_GetSubscriptionQuota", + "x-ms-examples": { + "ResourceProviderCommon_GetSubscriptionQuota": { + "$ref": "./examples/iothub_usages.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UserSubscriptionQuotaListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testall": { + "post": { + "tags": [ + "POST" + ], + "operationId": "IotHubResource_TestAllRoutes", + "summary": "Test all routes", + "description": "Test all routes configured in this Iot Hub", + "x-ms-examples": { + "IotHubResource_TestAllRoutes": { + "$ref": "./examples/iothub_testallroutes.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "input", + "description": "Input for testing all routes", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TestAllRoutesInput" + } + }, + { + "name": "iotHubName", + "description": "IotHub to be tested", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "resource group which Iot Hub belongs to", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TestAllRoutesResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testnew": { + "post": { + "tags": [ + "POST" + ], + "operationId": "IotHubResource_TestRoute", + "summary": "Test the new route", + "description": "Test the new route for this Iot Hub", + "x-ms-examples": { + "IotHubResource_TestRoute": { + "$ref": "./examples/iothub_testnewroute.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "input", + "description": "Route that needs to be tested", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TestRouteInput" + } + }, + { + "name": "iotHubName", + "description": "IotHub to be tested", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "resource group which Iot Hub belongs to", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TestRouteResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/listkeys": { + "post": { + "tags": [ + "POST" + ], + "summary": "Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security", + "description": "Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.", + "operationId": "IotHubResource_ListKeys", + "x-ms-examples": { + "IotHubResource_ListKeys": { + "$ref": "./examples/iothub_listkeys.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of shared access policies, including keys, that you can use to access the IoT hub endpoints.", + "schema": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRuleListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubKeys/{keyName}/listkeys": { + "post": { + "tags": [ + "POST" + ], + "summary": "Get a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security", + "description": "Get a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.", + "operationId": "IotHubResource_GetKeysForKeyName", + "x-ms-examples": { + "IotHubResource_GetKeysForKeyName": { + "$ref": "./examples/iothub_getkey.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "keyName", + "in": "path", + "description": "The name of the shared access policy.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized shared access policy, including keys, that you can use to access one or more IoT hub endpoints.", + "schema": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRule" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/exportDevices": { + "post": { + "tags": [ + "POST" + ], + "summary": "Exports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities", + "description": "Exports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.", + "operationId": "IotHubResource_ExportDevices", + "x-ms-examples": { + "IotHubResource_ExportDevices": { + "$ref": "./examples/iothub_exportdevices.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "exportDevicesParameters", + "in": "body", + "description": "The parameters that specify the export devices operation.", + "required": true, + "schema": { + "$ref": "#/definitions/ExportDevicesRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobResponse" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/importDevices": { + "post": { + "tags": [ + "POST" + ], + "summary": "Import, update, or delete device identities in the IoT hub identity registry from a blob. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities", + "description": "Import, update, or delete device identities in the IoT hub identity registry from a blob. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.", + "operationId": "IotHubResource_ImportDevices", + "x-ms-examples": { + "IotHubResource_ImportDevices": { + "$ref": "./examples/iothub_importdevices.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "importDevicesParameters", + "in": "body", + "description": "The parameters that specify the import devices operation.", + "required": true, + "schema": { + "$ref": "#/definitions/ImportDevicesRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobResponse" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates": { + "get": { + "tags": [ + "Certificates" + ], + "summary": "Get the certificate list.", + "description": "Returns the list of certificates.", + "operationId": "Certificates_ListByIotHub", + "x-ms-examples": { + "Certificates_ListByIotHub": { + "$ref": "./examples/iothub_listcertificates.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "The body contains all the certificate list.", + "schema": { + "$ref": "#/definitions/CertificateListDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}": { + "get": { + "tags": [ + "Certificates" + ], + "summary": "Get the certificate.", + "description": "Returns the certificate.", + "operationId": "Certificates_Get", + "x-ms-examples": { + "Certificates_Get": { + "$ref": "./examples/iothub_getcertificate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/certificateName" + } + ], + "responses": { + "200": { + "description": "The body contains the certificate.", + "schema": { + "$ref": "#/definitions/CertificateDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Certificates" + ], + "summary": "Upload the certificate to the IoT hub.", + "description": "Adds new or replaces existing certificate.", + "operationId": "Certificates_CreateOrUpdate", + "x-ms-examples": { + "Certificates_CreateOrUpdate": { + "$ref": "./examples/iothub_certificatescreateorupdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/certificateName" + }, + { + "name": "certificateDescription", + "in": "body", + "description": "The certificate body.", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateDescription" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the Certificate. Do not specify for creating a brand new certificate. Required to update an existing certificate." + } + ], + "responses": { + "201": { + "description": "If certificate didn't exist creation was successful, the operation returns HTTP status code of 201 (OK).", + "schema": { + "$ref": "#/definitions/CertificateDescription" + } + }, + "200": { + "description": "If certificate already exist and update was successful, the operation returns HTTP status code of 201 (OK).", + "schema": { + "$ref": "#/definitions/CertificateDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "Certificates" + ], + "summary": "Delete an X509 certificate.", + "description": "Deletes an existing X509 certificate or does nothing if it does not exist.", + "operationId": "Certificates_Delete", + "x-ms-examples": { + "Certificates_Delete": { + "$ref": "./examples/iothub_certificatesdelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/certificateName" + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "ETag of the Certificate." + } + ], + "responses": { + "200": { + "description": "Certificate has been deleted." + }, + "204": { + "description": "Certificate does not exist." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}/generateVerificationCode": { + "post": { + "tags": [ + "Certificates" + ], + "summary": "Generate verification code for proof of possession flow.", + "description": "Generates verification code for proof of possession flow. The verification code will be used to generate a leaf certificate.", + "operationId": "Certificates_GenerateVerificationCode", + "x-ms-examples": { + "Certificates_GenerateVerificationCode": { + "$ref": "./examples/iothub_generateverificationcode.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/certificateName" + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "ETag of the Certificate." + } + ], + "responses": { + "200": { + "description": "The body contains the certificate.", + "schema": { + "$ref": "#/definitions/CertificateWithNonceDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}/verify": { + "post": { + "tags": [ + "Certificates" + ], + "summary": "Verify certificate's private key possession.", + "description": "Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.", + "operationId": "Certificates_Verify", + "x-ms-examples": { + "Certificates_Verify": { + "$ref": "./examples/iothub_certverify.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/certificateName" + }, + { + "name": "certificateVerificationBody", + "in": "body", + "description": "The name of the certificate", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateVerificationDescription" + } + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "ETag of the Certificate." + } + ], + "responses": { + "200": { + "description": "The body contains the certificate.", + "schema": { + "$ref": "#/definitions/CertificateDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/failover": { + "post": { + "tags": [ + "POST" + ], + "operationId": "IotHub_ManualFailover", + "summary": "Manually initiate a failover for the IoT Hub to its secondary region", + "description": "Manually initiate a failover for the IoT Hub to its secondary region. To learn more, see https://aka.ms/manualfailover", + "x-ms-examples": { + "IotHub_ManualFailover": { + "$ref": "./examples/IotHub_ManualFailover.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "parameters": [ + { + "name": "iotHubName", + "description": "Name of the IoT hub to failover", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "failoverInput", + "description": "Region to failover to. Must be the Azure paired region. Get the value from the secondary location in the locations property. To learn more, see https://aka.ms/manualfailover/region", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FailoverInput" + } + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "Name of the resource group containing the IoT hub resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Long running manual failover operation for the IoT hub completed" + }, + "202": { + "description": "Manual failover initiated" + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "GET" + ], + "summary": "List private link resources", + "description": "List private link resources for the given IotHub", + "operationId": "PrivateLinkResources_List", + "x-ms-examples": { + "PrivateLinkResources_List": { + "$ref": "./examples/iothub_listprivatelinkresources.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "The body contains the list of private link resources", + "schema": { + "$ref": "#/definitions/PrivateLinkResources" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateLinkResources/{groupId}": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the specified private link resource", + "description": "Get the specified private link resource for the given IotHub", + "operationId": "PrivateLinkResources_Get", + "x-ms-examples": { + "PrivateLinkResources_List": { + "$ref": "./examples/iothub_getprivatelinkresources.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/groupId" + } + ], + "responses": { + "200": { + "description": "The body contains the specified of private link resource", + "schema": { + "$ref": "#/definitions/GroupIdInformation" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "GET" + ], + "summary": "List private endpoint connections", + "description": "List private endpoint connection properties", + "operationId": "PrivateEndpointConnections_List", + "x-ms-examples": { + "PrivateEndpointConnections_List": { + "$ref": "./examples/iothub_listprivateendpointconnections.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "The body contains the list of private endpoint connection properties", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionsList" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get private endpoint connection", + "description": "Get private endpoint connection properties", + "operationId": "PrivateEndpointConnections_Get", + "x-ms-examples": { + "PrivateEndpointConnection_Get": { + "$ref": "./examples/iothub_getprivateendpointconnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/privateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "The body contains the private endpoint connection properties", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "PUT" + ], + "summary": "Update private endpoint connection", + "description": "Update the status of a private endpoint connection with the specified name", + "operationId": "PrivateEndpointConnections_Update", + "x-ms-examples": { + "PrivateEndpointConnection_Update": { + "$ref": "./examples/iothub_updateprivateendpointconnection.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/privateEndpointConnectionName" + }, + { + "name": "privateEndpointConnection", + "in": "body", + "description": "The private endpoint connection with updated properties", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "201": { + "description": "This is a long running operation. The operation returns a 201 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation. If successful, the operation returns HTTP status code of 201 (OK).", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "200": { + "description": "This is returned as a response to the status polling request for the update operation.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "DELETE" + ], + "summary": "Delete private endpoint connection", + "description": "Delete private endpoint connection with the specified name", + "operationId": "PrivateEndpointConnections_Delete", + "x-ms-examples": { + "PrivateEndpointConnection_Delete": { + "$ref": "./examples/iothub_deleteprivateendpointconnection.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/privateEndpointConnectionName" + } + ], + "responses": { + "202": { + "description": "This is a long running operation. The operation returns a 202 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "200": { + "description": "This is returned as a response to the status polling request for the delete operation.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "204": { + "description": "PrivateEndpoint does not exist." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + } + }, + "definitions": { + "CertificateVerificationDescription": { + "description": "The JSON-serialized leaf certificate", + "type": "object", + "properties": { + "certificate": { + "description": "base-64 representation of X509 certificate .cer file or just .pem file content.", + "type": "string" + } + } + }, + "CertificateListDescription": { + "description": "The JSON-serialized array of Certificate objects.", + "type": "object", + "properties": { + "value": { + "description": "The array of Certificate objects.", + "type": "array", + "items": { + "$ref": "#/definitions/CertificateDescription" + } + } + } + }, + "CertificateBodyDescription": { + "description": "The JSON-serialized X509 Certificate.", + "type": "object", + "properties": { + "certificate": { + "description": "base-64 representation of the X509 leaf certificate .cer file or just .pem file content.", + "type": "string" + }, + "isVerified": { + "description": "True indicates that the certificate will be created in verified state and proof of possession will not be required.", + "type": "boolean" + } + } + }, + "CertificateDescription": { + "description": "The X509 Certificate.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CertificateProperties" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "description": "The name of the certificate.", + "type": "string", + "readOnly": true + }, + "etag": { + "description": "The entity tag.", + "type": "string", + "readOnly": true + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + } + }, + "x-ms-azure-resource": true + }, + "CertificateWithNonceDescription": { + "description": "The X509 Certificate.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CertificatePropertiesWithNonce" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "description": "The name of the certificate.", + "type": "string", + "readOnly": true + }, + "etag": { + "description": "The entity tag.", + "type": "string", + "readOnly": true + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + } + }, + "x-ms-azure-resource": true + }, + "SharedAccessSignatureAuthorizationRule": { + "description": "The properties of an IoT hub shared access policy.", + "type": "object", + "properties": { + "keyName": { + "description": "The name of the shared access policy.", + "type": "string" + }, + "primaryKey": { + "description": "The primary key.", + "type": "string" + }, + "secondaryKey": { + "description": "The secondary key.", + "type": "string" + }, + "rights": { + "description": "The permissions assigned to the shared access policy.", + "enum": [ + "RegistryRead", + "RegistryWrite", + "ServiceConnect", + "DeviceConnect", + "RegistryRead, RegistryWrite", + "RegistryRead, ServiceConnect", + "RegistryRead, DeviceConnect", + "RegistryWrite, ServiceConnect", + "RegistryWrite, DeviceConnect", + "ServiceConnect, DeviceConnect", + "RegistryRead, RegistryWrite, ServiceConnect", + "RegistryRead, RegistryWrite, DeviceConnect", + "RegistryRead, ServiceConnect, DeviceConnect", + "RegistryWrite, ServiceConnect, DeviceConnect", + "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect" + ], + "type": "string", + "x-ms-enum": { + "name": "AccessRights", + "modelAsString": false + } + } + }, + "required": [ + "keyName", + "rights" + ] + }, + "CertificateProperties": { + "description": "The description of an X509 CA Certificate.", + "type": "object", + "properties": { + "subject": { + "description": "The certificate's subject name.", + "type": "string", + "readOnly": true + }, + "expiry": { + "description": "The certificate's expiration date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + }, + "thumbprint": { + "description": "The certificate's thumbprint.", + "type": "string", + "readOnly": true + }, + "isVerified": { + "description": "Determines whether certificate has been verified.", + "type": "boolean", + "readOnly": true + }, + "created": { + "description": "The certificate's create date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + }, + "updated": { + "description": "The certificate's last update date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + }, + "certificate": { + "description": "The certificate content", + "type": "string" + } + } + }, + "CertificatePropertiesWithNonce": { + "description": "The description of an X509 CA Certificate including the challenge nonce issued for the Proof-Of-Possession flow.", + "type": "object", + "properties": { + "subject": { + "description": "The certificate's subject name.", + "type": "string", + "readOnly": true + }, + "expiry": { + "description": "The certificate's expiration date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + }, + "thumbprint": { + "description": "The certificate's thumbprint.", + "type": "string", + "readOnly": true + }, + "isVerified": { + "description": "Determines whether certificate has been verified.", + "type": "boolean", + "readOnly": true + }, + "created": { + "description": "The certificate's create date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + }, + "updated": { + "description": "The certificate's last update date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + }, + "verificationCode": { + "description": "The certificate's verification code that will be used for proof of possession.", + "type": "string", + "readOnly": true + }, + "certificate": { + "description": "The certificate content", + "type": "string", + "readOnly": true + } + } + }, + "IotHubProperties": { + "description": "The properties of an IoT hub.", + "type": "object", + "properties": { + "authorizationPolicies": { + "description": "The shared access policies you can use to secure a connection to the IoT hub.", + "type": "array", + "items": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRule" + } + }, + "disableLocalAuth": { + "description": "If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication.", + "type": "boolean" + }, + "disableDeviceSAS": { + "description": "If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for authentication.", + "type": "boolean" + }, + "disableModuleSAS": { + "description": "If true, all module scoped SAS keys cannot be used for authentication.", + "type": "boolean" + }, + "restrictOutboundNetworkAccess": { + "description": "If true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList.", + "type": "boolean" + }, + "allowedFqdnList": { + "description": "List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub.", + "type": "array", + "items": { + "description": "FQDN to be allowed for egress. Example: my-eventhub.servicebus.windows.net", + "type": "string" + } + }, + "publicNetworkAccess": { + "type": "string", + "description": "Whether requests from Public Network are allowed", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "PublicNetworkAccess" + } + }, + "ipFilterRules": { + "description": "The IP filter rules.", + "type": "array", + "items": { + "$ref": "#/definitions/IpFilterRule" + } + }, + "networkRuleSets": { + "$ref": "#/definitions/NetworkRuleSetProperties" + }, + "minTlsVersion": { + "type": "string", + "description": "Specifies the minimum TLS version to support for this hub. Can be set to \"1.2\" to have clients that use a TLS version below 1.2 to be rejected." + }, + "privateEndpointConnections": { + "description": "Private endpoint connections created on this IotHub", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "provisioningState": { + "description": "The provisioning state.", + "type": "string", + "readOnly": true + }, + "state": { + "description": "The hub state.", + "type": "string", + "readOnly": true + }, + "hostName": { + "description": "The name of the host.", + "type": "string", + "readOnly": true + }, + "eventHubEndpoints": { + "description": "The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/EventHubProperties" + } + }, + "routing": { + "$ref": "#/definitions/RoutingProperties" + }, + "storageEndpoints": { + "description": "The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StorageEndpointProperties" + } + }, + "messagingEndpoints": { + "description": "The messaging endpoint properties for the file upload notification queue.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MessagingEndpointProperties" + } + }, + "enableFileUploadNotifications": { + "description": "If True, file upload notifications are enabled.", + "type": "boolean" + }, + "cloudToDevice": { + "$ref": "#/definitions/CloudToDeviceProperties" + }, + "comments": { + "description": "IoT hub comments.", + "type": "string" + }, + "deviceStreams": { + "description": "The device streams properties of iothub.", + "type": "object", + "properties": { + "streamingEndpoints": { + "description": "List of Device Streams Endpoints.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "features": { + "description": "The capabilities and features enabled for the IoT hub.", + "enum": [ + "None", + "DeviceManagement" + ], + "type": "string", + "x-ms-enum": { + "name": "Capabilities", + "modelAsString": true + } + }, + "encryption": { + "description": "The encryption properties for the IoT hub.", + "$ref": "#/definitions/EncryptionPropertiesDescription" + }, + "locations": { + "description": "Primary and secondary location for iot hub", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/IotHubLocationDescription" + } + } + } + }, + "IotHubSkuInfo": { + "description": "Information about the SKU of the IoT hub.", + "type": "object", + "properties": { + "name": { + "description": "The name of the SKU.", + "enum": [ + "F1", + "S1", + "S2", + "S3", + "B1", + "B2", + "B3" + ], + "type": "string", + "x-ms-enum": { + "name": "IotHubSku", + "modelAsString": true + } + }, + "tier": { + "description": "The billing tier for the IoT hub.", + "enum": [ + "Free", + "Standard", + "Basic" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "IotHubSkuTier", + "modelAsString": false + } + }, + "capacity": { + "format": "int64", + "description": "The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.", + "type": "integer" + } + }, + "required": [ + "name" + ] + }, + "EventHubProperties": { + "description": "The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.", + "type": "object", + "properties": { + "retentionTimeInDays": { + "format": "int64", + "description": "The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages", + "type": "integer" + }, + "partitionCount": { + "format": "int32", + "description": "The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.", + "type": "integer" + }, + "partitionIds": { + "description": "The partition ids in the Event Hub-compatible endpoint.", + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + }, + "path": { + "description": "The Event Hub-compatible name.", + "type": "string", + "readOnly": true + }, + "endpoint": { + "description": "The Event Hub-compatible endpoint.", + "type": "string", + "readOnly": true + } + } + }, + "StorageEndpointProperties": { + "description": "The properties of the Azure Storage endpoint for file upload.", + "type": "object", + "properties": { + "sasTtlAsIso8601": { + "description": "The period of time for which the SAS URI generated by IoT Hub for file upload is valid. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.", + "type": "string", + "format": "duration" + }, + "connectionString": { + "description": "The connection string for the Azure Storage account to which files are uploaded.", + "type": "string" + }, + "containerName": { + "description": "The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified.", + "type": "string" + }, + "authenticationType": { + "description": "Specifies authentication type being used for connecting to the storage account.", + "enum": [ + "keyBased", + "identityBased" + ], + "type": "string", + "x-ms-enum": { + "name": "AuthenticationType", + "modelAsString": true + } + }, + "identity": { + "description": "Managed identity properties of storage endpoint for file upload.", + "$ref": "#/definitions/ManagedIdentity" + } + }, + "required": [ + "connectionString", + "containerName" + ] + }, + "MessagingEndpointProperties": { + "description": "The properties of the messaging endpoints used by this IoT hub.", + "type": "object", + "properties": { + "lockDurationAsIso8601": { + "description": "The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.", + "type": "string", + "format": "duration" + }, + "ttlAsIso8601": { + "description": "The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.", + "type": "string", + "format": "duration" + }, + "maxDeliveryCount": { + "description": "The number of times the IoT hub attempts to deliver a message. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.", + "format": "int32", + "type": "integer", + "minimum": 1, + "maximum": 100 + } + } + }, + "CloudToDeviceProperties": { + "description": "The IoT hub cloud-to-device messaging properties.", + "type": "object", + "properties": { + "maxDeliveryCount": { + "description": "The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.", + "format": "int32", + "type": "integer", + "minimum": 1, + "maximum": 100 + }, + "defaultTtlAsIso8601": { + "description": "The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.", + "type": "string", + "format": "duration" + }, + "feedback": { + "$ref": "#/definitions/FeedbackProperties" + } + } + }, + "IpFilterRule": { + "description": "The IP filter rules for the IoT hub.", + "type": "object", + "properties": { + "filterName": { + "description": "The name of the IP filter rule.", + "type": "string" + }, + "action": { + "description": "The desired action for requests captured by this rule.", + "enum": [ + "Accept", + "Reject" + ], + "type": "string", + "x-ms-enum": { + "name": "IpFilterActionType", + "modelAsString": false + } + }, + "ipMask": { + "description": "A string that contains the IP address range in CIDR notation for the rule.", + "type": "string" + } + }, + "required": [ + "filterName", + "action", + "ipMask" + ] + }, + "NetworkRuleSetProperties": { + "description": "Network Rule Set Properties of IotHub", + "type": "object", + "properties": { + "defaultAction": { + "type": "string", + "description": "Default Action for Network Rule Set", + "enum": [ + "Deny", + "Allow" + ], + "x-ms-enum": { + "name": "DefaultAction", + "modelAsString": true + }, + "default": "Deny" + }, + "applyToBuiltInEventHubEndpoint": { + "type": "boolean", + "description": "If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub" + }, + "ipRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkRuleSetIpRule" + }, + "description": "List of IP Rules" + } + }, + "required": [ + "applyToBuiltInEventHubEndpoint", + "ipRules" + ] + }, + "NetworkRuleSetIpRule": { + "description": "IP Rule to be applied as part of Network Rule Set", + "type": "object", + "properties": { + "filterName": { + "type": "string", + "description": "Name of the IP filter rule." + }, + "action": { + "type": "string", + "description": "IP Filter Action", + "enum": [ + "Allow" + ], + "x-ms-enum": { + "name": "NetworkRuleIPAction", + "modelAsString": true + }, + "default": "Allow" + }, + "ipMask": { + "type": "string", + "description": "A string that contains the IP address range in CIDR notation for the rule." + } + }, + "required": [ + "filterName", + "ipMask" + ] + }, + "PrivateLinkResources": { + "description": "The available private link resources for an IotHub", + "type": "object", + "properties": { + "value": { + "description": "The list of available private link resources for an IotHub", + "type": "array", + "items": { + "$ref": "#/definitions/GroupIdInformation" + } + } + } + }, + "GroupIdInformation": { + "description": "The group information for creating a private endpoint on an IotHub", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "$ref": "#/definitions/GroupIdInformationProperties" + } + }, + "required": [ + "properties" + ] + }, + "GroupIdInformationProperties": { + "description": "The properties for a group information object", + "type": "object", + "properties": { + "groupId": { + "type": "string", + "description": "The group id" + }, + "requiredMembers": { + "description": "The required members for a specific group id", + "type": "array", + "items": { + "type": "string" + } + }, + "requiredZoneNames": { + "description": "The required DNS zones for a specific group id", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PrivateEndpointConnectionsList": { + "description": "The list of private endpoint connections for an IotHub", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "PrivateEndpointConnection": { + "description": "The private endpoint connection of an IotHub", + "x-ms-azure-resource": true, + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties" + } + }, + "required": [ + "properties" + ] + }, + "PrivateEndpointConnectionProperties": { + "description": "The properties of a private endpoint connection", + "type": "object", + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState" + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpoint": { + "description": "The private endpoint property of a private endpoint connection", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "The current state of a private endpoint connection", + "type": "object", + "properties": { + "status": { + "description": "The status of a private endpoint connection", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateLinkServiceConnectionStatus", + "modelAsString": true + } + }, + "description": { + "type": "string", + "description": "The description for the current state of a private endpoint connection" + }, + "actionsRequired": { + "type": "string", + "description": "Actions required for a private endpoint connection" + } + }, + "required": [ + "status", + "description" + ] + }, + "FeedbackProperties": { + "description": "The properties of the feedback queue for cloud-to-device messages.", + "type": "object", + "properties": { + "lockDurationAsIso8601": { + "description": "The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.", + "type": "string", + "format": "duration" + }, + "ttlAsIso8601": { + "description": "The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.", + "type": "string", + "format": "duration" + }, + "maxDeliveryCount": { + "description": "The number of times the IoT hub attempts to deliver a message on the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.", + "format": "int32", + "type": "integer", + "minimum": 1, + "maximum": 100 + } + } + }, + "RoutingProperties": { + "description": "The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging", + "type": "object", + "properties": { + "endpoints": { + "$ref": "#/definitions/RoutingEndpoints" + }, + "routes": { + "description": "The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.", + "type": "array", + "items": { + "$ref": "#/definitions/RouteProperties" + } + }, + "fallbackRoute": { + "description": "The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint.", + "$ref": "#/definitions/FallbackRouteProperties" + }, + "enrichments": { + "description": "The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid", + "type": "array", + "items": { + "$ref": "#/definitions/EnrichmentProperties" + } + } + } + }, + "RoutingEndpoints": { + "description": "The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs.", + "type": "object", + "properties": { + "serviceBusQueues": { + "description": "The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.", + "type": "array", + "items": { + "$ref": "#/definitions/RoutingServiceBusQueueEndpointProperties" + } + }, + "serviceBusTopics": { + "description": "The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.", + "type": "array", + "items": { + "$ref": "#/definitions/RoutingServiceBusTopicEndpointProperties" + } + }, + "eventHubs": { + "description": "The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/RoutingEventHubProperties" + } + }, + "storageContainers": { + "description": "The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.", + "type": "array", + "items": { + "$ref": "#/definitions/RoutingStorageContainerProperties" + } + } + } + }, + "RoutingServiceBusQueueEndpointProperties": { + "description": "The properties related to service bus queue endpoint types.", + "type": "object", + "properties": { + "id": { + "description": "Id of the service bus queue endpoint", + "type": "string" + }, + "connectionString": { + "description": "The connection string of the service bus queue endpoint.", + "type": "string" + }, + "endpointUri": { + "description": "The url of the service bus queue endpoint. It must include the protocol sb://", + "type": "string" + }, + "entityPath": { + "description": "Queue name on the service bus namespace", + "type": "string" + }, + "authenticationType": { + "description": "Method used to authenticate against the service bus queue endpoint", + "enum": [ + "keyBased", + "identityBased" + ], + "type": "string", + "x-ms-enum": { + "name": "authenticationType", + "modelAsString": true + } + }, + "identity": { + "description": "Managed identity properties of routing service bus queue endpoint.", + "$ref": "#/definitions/ManagedIdentity" + }, + "name": { + "description": "The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name.", + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$" + }, + "subscriptionId": { + "description": "The subscription identifier of the service bus queue endpoint.", + "type": "string" + }, + "resourceGroup": { + "description": "The name of the resource group of the service bus queue endpoint.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "RoutingServiceBusTopicEndpointProperties": { + "description": "The properties related to service bus topic endpoint types.", + "type": "object", + "properties": { + "id": { + "description": "Id of the service bus topic endpoint", + "type": "string" + }, + "connectionString": { + "description": "The connection string of the service bus topic endpoint.", + "type": "string" + }, + "endpointUri": { + "description": "The url of the service bus topic endpoint. It must include the protocol sb://", + "type": "string" + }, + "entityPath": { + "description": "Queue name on the service bus topic", + "type": "string" + }, + "authenticationType": { + "description": "Method used to authenticate against the service bus topic endpoint", + "enum": [ + "keyBased", + "identityBased" + ], + "type": "string", + "x-ms-enum": { + "name": "authenticationType", + "modelAsString": true + } + }, + "identity": { + "description": "Managed identity properties of routing service bus topic endpoint.", + "$ref": "#/definitions/ManagedIdentity" + }, + "name": { + "description": "The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name.", + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$" + }, + "subscriptionId": { + "description": "The subscription identifier of the service bus topic endpoint.", + "type": "string" + }, + "resourceGroup": { + "description": "The name of the resource group of the service bus topic endpoint.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "RoutingEventHubProperties": { + "description": "The properties related to an event hub endpoint.", + "type": "object", + "properties": { + "id": { + "description": "Id of the event hub endpoint", + "type": "string" + }, + "connectionString": { + "description": "The connection string of the event hub endpoint. ", + "type": "string" + }, + "endpointUri": { + "description": "The url of the event hub endpoint. It must include the protocol sb://", + "type": "string" + }, + "entityPath": { + "description": "Event hub name on the event hub namespace", + "type": "string" + }, + "authenticationType": { + "description": "Method used to authenticate against the event hub endpoint", + "enum": [ + "keyBased", + "identityBased" + ], + "type": "string", + "x-ms-enum": { + "name": "authenticationType", + "modelAsString": true + } + }, + "identity": { + "description": "Managed identity properties of routing event hub endpoint.", + "$ref": "#/definitions/ManagedIdentity" + }, + "name": { + "description": "The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.", + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$" + }, + "subscriptionId": { + "description": "The subscription identifier of the event hub endpoint.", + "type": "string" + }, + "resourceGroup": { + "description": "The name of the resource group of the event hub endpoint.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "RoutingStorageContainerProperties": { + "description": "The properties related to a storage container endpoint.", + "type": "object", + "properties": { + "id": { + "description": "Id of the storage container endpoint", + "type": "string" + }, + "connectionString": { + "description": "The connection string of the storage account.", + "type": "string" + }, + "endpointUri": { + "description": "The url of the storage endpoint. It must include the protocol https://", + "type": "string" + }, + "authenticationType": { + "description": "Method used to authenticate against the storage endpoint", + "enum": [ + "keyBased", + "identityBased" + ], + "type": "string", + "x-ms-enum": { + "name": "authenticationType", + "modelAsString": true + } + }, + "identity": { + "description": "Managed identity properties of routing storage endpoint.", + "$ref": "#/definitions/ManagedIdentity" + }, + "name": { + "description": "The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.", + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$" + }, + "subscriptionId": { + "description": "The subscription identifier of the storage account.", + "type": "string" + }, + "resourceGroup": { + "description": "The name of the resource group of the storage account.", + "type": "string" + }, + "containerName": { + "description": "The name of storage container in the storage account.", + "type": "string" + }, + "fileNameFormat": { + "description": "File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.", + "type": "string" + }, + "batchFrequencyInSeconds": { + "description": "Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.", + "format": "int32", + "type": "integer", + "maximum": 720, + "minimum": 60 + }, + "maxChunkSizeInBytes": { + "description": "Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).", + "format": "int32", + "type": "integer", + "maximum": 524288000, + "minimum": 10485760 + }, + "encoding": { + "description": "Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'.", + "type": "string", + "enum": [ + "Avro", + "AvroDeflate", + "JSON" + ] + } + }, + "required": [ + "name", + "containerName" + ] + }, + "RouteProperties": { + "description": "The properties of a routing rule that your IoT hub uses to route messages to endpoints.", + "type": "object", + "properties": { + "name": { + "description": "The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.", + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$" + }, + "source": { + "description": "The source that the routing rule is to be applied to, such as DeviceMessages.", + "enum": [ + "Invalid", + "DeviceMessages", + "TwinChangeEvents", + "DeviceLifecycleEvents", + "DeviceJobLifecycleEvents", + "DigitalTwinChangeEvents", + "DeviceConnectionStateEvents" + ], + "type": "string", + "x-ms-enum": { + "name": "RoutingSource", + "modelAsString": true + } + }, + "condition": { + "description": "The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language", + "type": "string" + }, + "endpointNames": { + "description": "The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.", + "minItems": 1, + "maxItems": 1, + "type": "array", + "items": { + "type": "string" + } + }, + "isEnabled": { + "description": "Used to specify whether a route is enabled.", + "type": "boolean" + } + }, + "required": [ + "name", + "endpointNames", + "source", + "isEnabled" + ] + }, + "FallbackRouteProperties": { + "description": "The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.", + "type": "object", + "properties": { + "name": { + "description": "The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.", + "type": "string" + }, + "source": { + "description": "The source to which the routing rule is to be applied to. For example, DeviceMessages", + "enum": [ + "DeviceMessages" + ], + "type": "string", + "x-ms-enum": { + "name": "RoutingSource", + "modelAsString": true + } + }, + "condition": { + "description": "The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language", + "type": "string" + }, + "endpointNames": { + "description": "The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.", + "minItems": 1, + "maxItems": 1, + "type": "array", + "items": { + "type": "string" + } + }, + "isEnabled": { + "description": "Used to specify whether the fallback route is enabled.", + "type": "boolean" + } + }, + "required": [ + "endpointNames", + "source", + "isEnabled" + ] + }, + "EnrichmentProperties": { + "description": "The properties of an enrichment that your IoT hub applies to messages delivered to endpoints.", + "type": "object", + "properties": { + "key": { + "description": "The key or name for the enrichment property.", + "type": "string" + }, + "value": { + "description": "The value for the enrichment property.", + "type": "string" + }, + "endpointNames": { + "description": "The list of endpoints for which the enrichment is applied to the message.", + "minItems": 1, + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "key", + "value", + "endpointNames" + ] + }, + "IotHubDescription": { + "description": "The description of the IoT hub.", + "type": "object", + "properties": { + "etag": { + "description": "The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.", + "type": "string" + }, + "properties": { + "description": "IotHub properties", + "$ref": "#/definitions/IotHubProperties" + }, + "sku": { + "description": "IotHub SKU info", + "$ref": "#/definitions/IotHubSkuInfo" + }, + "identity": { + "description": "The managed identities for the IotHub.", + "$ref": "#/definitions/ArmIdentity" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "sku" + ] + }, + "Resource": { + "description": "The common properties of an Azure resource.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name.", + "pattern": "^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "location": { + "type": "string", + "description": "The resource location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + } + }, + "x-ms-azure-resource": true, + "required": [ + "location" + ] + }, + "SharedAccessSignatureAuthorizationRuleListResult": { + "description": "The list of shared access policies with a next link.", + "type": "object", + "properties": { + "value": { + "description": "The list of shared access policies.", + "type": "array", + "items": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRule" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "OperationListResult": { + "description": "Result of the request to list IoT Hub operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "List of IoT Hub operations supported by the Microsoft.Devices resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "IoT Hub REST API operation", + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Operation name: {provider}/{resource}/{read | write | action | delete}" + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "readOnly": true, + "type": "string", + "description": "Service provider: Microsoft Devices" + }, + "resource": { + "readOnly": true, + "type": "string", + "description": "Resource Type: IotHubs" + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "Name of the operation" + }, + "description": { + "readOnly": true, + "type": "string", + "description": "Description of the operation" + } + } + } + } + }, + "ErrorDetails": { + "description": "Error details.", + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "httpStatusCode": { + "description": "The HTTP status code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "The error details.", + "type": "string", + "readOnly": true + } + } + }, + "IotHubQuotaMetricInfoListResult": { + "description": "The JSON-serialized array of IotHubQuotaMetricInfo objects with a next link.", + "type": "object", + "properties": { + "value": { + "description": "The array of quota metrics objects.", + "type": "array", + "items": { + "$ref": "#/definitions/IotHubQuotaMetricInfo" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "EndpointHealthDataListResult": { + "description": "The JSON-serialized array of EndpointHealthData objects with a next link.", + "type": "object", + "properties": { + "value": { + "description": "JSON-serialized array of Endpoint health data", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointHealthData" + } + }, + "nextLink": { + "description": "Link to more results", + "type": "string", + "readOnly": true + } + } + }, + "EndpointHealthData": { + "description": "The health data for an endpoint", + "type": "object", + "properties": { + "endpointId": { + "description": "Id of the endpoint", + "type": "string" + }, + "healthStatus": { + "description": "Health statuses have following meanings. The 'healthy' status shows that the endpoint is accepting messages as expected. The 'unhealthy' status shows that the endpoint is not accepting messages as expected and IoT Hub is retrying to send data to this endpoint. The status of an unhealthy endpoint will be updated to healthy when IoT Hub has established an eventually consistent state of health. The 'dead' status shows that the endpoint is not accepting messages, after IoT Hub retried sending messages for the retrial period. See IoT Hub metrics to identify errors and monitor issues with endpoints. The 'unknown' status shows that the IoT Hub has not established a connection with the endpoint. No messages have been delivered to or rejected from this endpoint", + "enum": [ + "unknown", + "healthy", + "degraded", + "unhealthy", + "dead" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointHealthStatus", + "modelAsString": true + } + }, + "lastKnownError": { + "description": "Last error obtained when a message failed to be delivered to iot hub", + "type": "string" + }, + "lastKnownErrorTime": { + "description": "Time at which the last known error occurred", + "type": "string", + "format": "date-time-rfc1123" + }, + "lastSuccessfulSendAttemptTime": { + "description": "Last time iot hub successfully sent a message to the endpoint", + "type": "string", + "format": "date-time-rfc1123" + }, + "lastSendAttemptTime": { + "description": "Last time iot hub tried to send a message to the endpoint", + "type": "string", + "format": "date-time-rfc1123" + } + } + }, + "RegistryStatistics": { + "description": "Identity registry statistics.", + "type": "object", + "properties": { + "totalDeviceCount": { + "format": "int64", + "description": "The total count of devices in the identity registry.", + "type": "integer", + "readOnly": true + }, + "enabledDeviceCount": { + "format": "int64", + "description": "The count of enabled devices in the identity registry.", + "type": "integer", + "readOnly": true + }, + "disabledDeviceCount": { + "format": "int64", + "description": "The count of disabled devices in the identity registry.", + "type": "integer", + "readOnly": true + } + } + }, + "JobResponseListResult": { + "description": "The JSON-serialized array of JobResponse objects with a next link.", + "type": "object", + "properties": { + "value": { + "description": "The array of JobResponse objects.", + "type": "array", + "items": { + "$ref": "#/definitions/JobResponse" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "IotHubSkuDescription": { + "description": "SKU properties.", + "type": "object", + "properties": { + "resourceType": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "sku": { + "description": "The type of the resource.", + "$ref": "#/definitions/IotHubSkuInfo" + }, + "capacity": { + "description": "IotHub capacity", + "$ref": "#/definitions/IotHubCapacity" + } + }, + "required": [ + "sku", + "capacity" + ] + }, + "TagsResource": { + "properties": { + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "description": "A container holding only the Tags for a resource, allowing the user to update the tags on an IoT Hub instance." + }, + "IotHubCapacity": { + "description": "IoT Hub capacity information.", + "type": "object", + "properties": { + "minimum": { + "format": "int64", + "description": "The minimum number of units.", + "type": "integer", + "minimum": 1, + "maximum": 1, + "readOnly": true + }, + "maximum": { + "format": "int64", + "description": "The maximum number of units.", + "type": "integer", + "readOnly": true + }, + "default": { + "format": "int64", + "description": "The default number of units.", + "type": "integer", + "readOnly": true + }, + "scaleType": { + "description": "The type of the scaling enabled.", + "enum": [ + "Automatic", + "Manual", + "None" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "name": "IotHubScaleType", + "modelAsString": false + } + } + } + }, + "EventHubConsumerGroupsListResult": { + "description": "The JSON-serialized array of Event Hub-compatible consumer group names with a next link.", + "type": "object", + "properties": { + "value": { + "description": "List of consumer groups objects", + "type": "array", + "items": { + "$ref": "#/definitions/EventHubConsumerGroupInfo" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "EventHubConsumerGroupBodyDescription": { + "description": "The EventHub consumer group.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/EventHubConsumerGroupName" + } + }, + "required": [ + "properties" + ] + }, + "EventHubConsumerGroupName": { + "description": "The EventHub consumer group name.", + "type": "object", + "properties": { + "name": { + "description": "EventHub consumer group name", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "EventHubConsumerGroupInfo": { + "description": "The properties of the EventHubConsumerGroupInfo object.", + "x-ms-azure-resource": true, + "type": "object", + "properties": { + "properties": { + "description": "The tags.", + "type": "object", + "additionalProperties": {} + }, + "id": { + "description": "The Event Hub-compatible consumer group identifier.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The Event Hub-compatible consumer group name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "the resource type.", + "type": "string", + "readOnly": true + }, + "etag": { + "description": "The etag.", + "type": "string", + "readOnly": true + } + } + }, + "IotHubSkuDescriptionListResult": { + "description": "The JSON-serialized array of IotHubSkuDescription objects with a next link.", + "type": "object", + "properties": { + "value": { + "description": "The array of IotHubSkuDescription.", + "type": "array", + "items": { + "$ref": "#/definitions/IotHubSkuDescription" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "JobResponse": { + "description": "The properties of the Job Response object.", + "type": "object", + "properties": { + "jobId": { + "description": "The job identifier.", + "type": "string", + "readOnly": true + }, + "startTimeUtc": { + "format": "date-time-rfc1123", + "description": "The start time of the job.", + "type": "string", + "readOnly": true + }, + "endTimeUtc": { + "format": "date-time-rfc1123", + "description": "The time the job stopped processing.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the job.", + "enum": [ + "unknown", + "export", + "import", + "backup", + "readDeviceProperties", + "writeDeviceProperties", + "updateDeviceConfiguration", + "rebootDevice", + "factoryResetDevice", + "firmwareUpdate" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobType", + "modelAsString": true + } + }, + "status": { + "description": "The status of the job.", + "enum": [ + "unknown", + "enqueued", + "running", + "completed", + "failed", + "cancelled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": false + } + }, + "failureReason": { + "description": "If status == failed, this string containing the reason for the failure.", + "type": "string", + "readOnly": true + }, + "statusMessage": { + "description": "The status message for the job.", + "type": "string", + "readOnly": true + }, + "parentJobId": { + "description": "The job identifier of the parent job, if any.", + "type": "string", + "readOnly": true + } + } + }, + "IotHubDescriptionListResult": { + "description": "The JSON-serialized array of IotHubDescription objects with a next link.", + "type": "object", + "properties": { + "value": { + "description": "The array of IotHubDescription objects.", + "type": "array", + "items": { + "$ref": "#/definitions/IotHubDescription" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "IotHubQuotaMetricInfo": { + "description": "Quota metrics properties.", + "type": "object", + "properties": { + "name": { + "description": "The name of the quota metric.", + "type": "string", + "readOnly": true + }, + "currentValue": { + "format": "int64", + "description": "The current value for the quota metric.", + "type": "integer", + "readOnly": true + }, + "maxValue": { + "format": "int64", + "description": "The maximum value of the quota metric.", + "type": "integer", + "readOnly": true + } + } + }, + "OperationInputs": { + "description": "Input values.", + "type": "object", + "properties": { + "name": { + "description": "The name of the IoT hub to check.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "IotHubNameAvailabilityInfo": { + "description": "The properties indicating whether a given IoT hub name is available.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "The value which indicates whether the provided name is available.", + "type": "boolean", + "readOnly": true + }, + "reason": { + "description": "The reason for unavailability.", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "IotHubNameUnavailabilityReason", + "modelAsString": false + } + }, + "message": { + "description": "The detailed reason message.", + "type": "string" + } + } + }, + "UserSubscriptionQuotaListResult": { + "type": "object", + "description": "Json-serialized array of User subscription quota response", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/UserSubscriptionQuota" + } + }, + "nextLink": { + "type": "string", + "readOnly": true + } + } + }, + "UserSubscriptionQuota": { + "description": "User subscription quota response", + "type": "object", + "properties": { + "id": { + "description": "IotHub type id", + "type": "string" + }, + "type": { + "description": "Response type", + "type": "string" + }, + "unit": { + "description": "Unit of IotHub type", + "type": "string" + }, + "currentValue": { + "description": "Current number of IotHub type", + "format": "int32", + "type": "integer" + }, + "limit": { + "description": "Numerical limit on IotHub type", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "IotHub type", + "$ref": "#/definitions/Name" + } + } + }, + "Name": { + "description": "Name of Iot Hub type", + "type": "object", + "properties": { + "value": { + "description": "IotHub type", + "type": "string" + }, + "localizedValue": { + "description": "Localized value of name", + "type": "string" + } + } + }, + "TestAllRoutesInput": { + "description": "Input for testing all routes", + "type": "object", + "properties": { + "routingSource": { + "description": "Routing source", + "enum": [ + "Invalid", + "DeviceMessages", + "TwinChangeEvents", + "DeviceLifecycleEvents", + "DeviceJobLifecycleEvents", + "DigitalTwinChangeEvents", + "DeviceConnectionStateEvents" + ], + "type": "string", + "x-ms-enum": { + "name": "RoutingSource", + "modelAsString": true + } + }, + "message": { + "description": "Routing message", + "$ref": "#/definitions/RoutingMessage" + }, + "twin": { + "description": "Routing Twin Reference", + "$ref": "#/definitions/RoutingTwin" + } + } + }, + "RoutingTwin": { + "description": "Twin reference input parameter. This is an optional parameter", + "type": "object", + "properties": { + "tags": { + "description": "Twin Tags", + "type": "object" + }, + "properties": { + "properties": { + "desired": { + "description": "Twin desired properties", + "type": "object" + }, + "reported": { + "description": "Twin desired properties", + "type": "object" + } + } + } + } + }, + "RoutingMessage": { + "description": "Routing message", + "type": "object", + "properties": { + "body": { + "description": "Body of routing message", + "type": "string" + }, + "appProperties": { + "description": "App properties", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "systemProperties": { + "description": "System properties", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "TestAllRoutesResult": { + "description": "Result of testing all routes", + "type": "object", + "properties": { + "routes": { + "description": "JSON-serialized array of matched routes", + "type": "array", + "items": { + "$ref": "#/definitions/MatchedRoute" + } + } + } + }, + "MatchedRoute": { + "description": "Routes that matched", + "type": "object", + "properties": { + "properties": { + "description": "Properties of routes that matched", + "$ref": "#/definitions/RouteProperties" + } + } + }, + "TestRouteInput": { + "required": [ + "route" + ], + "description": "Input for testing route", + "type": "object", + "properties": { + "message": { + "description": "Routing message", + "$ref": "#/definitions/RoutingMessage" + }, + "route": { + "description": "Route properties", + "$ref": "#/definitions/RouteProperties" + }, + "twin": { + "description": "Routing Twin Reference", + "$ref": "#/definitions/RoutingTwin" + } + } + }, + "TestRouteResult": { + "description": "Result of testing one route", + "type": "object", + "properties": { + "result": { + "description": "Result of testing route", + "enum": [ + "undefined", + "false", + "true" + ], + "type": "string", + "x-ms-enum": { + "name": "TestResultStatus", + "modelAsString": true + } + }, + "details": { + "description": "Detailed result of testing route", + "$ref": "#/definitions/TestRouteResultDetails" + } + } + }, + "TestRouteResultDetails": { + "description": "Detailed result of testing a route", + "type": "object", + "properties": { + "compilationErrors": { + "description": "JSON-serialized list of route compilation errors", + "type": "array", + "items": { + "$ref": "#/definitions/RouteCompilationError" + } + } + } + }, + "RouteCompilationError": { + "description": "Compilation error when evaluating route", + "type": "object", + "properties": { + "message": { + "description": "Route error message", + "type": "string" + }, + "severity": { + "description": "Severity of the route error", + "enum": [ + "error", + "warning" + ], + "type": "string", + "x-ms-enum": { + "name": "RouteErrorSeverity", + "modelAsString": true + } + }, + "location": { + "description": "Location where the route error happened", + "$ref": "#/definitions/RouteErrorRange" + } + } + }, + "RouteErrorRange": { + "description": "Range of route errors", + "type": "object", + "properties": { + "start": { + "description": "Start where the route error happened", + "$ref": "#/definitions/RouteErrorPosition" + }, + "end": { + "description": "End where the route error happened", + "$ref": "#/definitions/RouteErrorPosition" + } + } + }, + "RouteErrorPosition": { + "description": "Position where the route error happened", + "type": "object", + "properties": { + "line": { + "description": "Line where the route error happened", + "format": "int32", + "type": "integer" + }, + "column": { + "description": "Column where the route error happened", + "format": "int32", + "type": "integer" + } + } + }, + "ExportDevicesRequest": { + "description": "Use to provide parameters when requesting an export of all devices in the IoT hub.", + "type": "object", + "properties": { + "exportBlobContainerUri": { + "description": "The export blob container URI.", + "type": "string" + }, + "excludeKeys": { + "description": "The value indicating whether keys should be excluded during export.", + "type": "boolean" + }, + "exportBlobName": { + "description": "The name of the blob that will be created in the provided output blob container. This blob will contain the exported device registry information for the IoT Hub.", + "type": "string" + }, + "authenticationType": { + "description": "Specifies authentication type being used for connecting to the storage account.", + "enum": [ + "keyBased", + "identityBased" + ], + "type": "string", + "x-ms-enum": { + "name": "AuthenticationType", + "modelAsString": true + } + }, + "identity": { + "description": "Managed identity properties of storage endpoint for export devices.", + "$ref": "#/definitions/ManagedIdentity" + }, + "includeConfigurations": { + "description": "The value indicating whether configurations should be exported.", + "type": "boolean" + }, + "configurationsBlobName": { + "description": "The name of the blob that will be created in the provided output blob container. This blob will contain the exported configurations for the Iot Hub.", + "type": "string" + } + }, + "required": [ + "exportBlobContainerUri", + "excludeKeys" + ] + }, + "ImportDevicesRequest": { + "description": "Use to provide parameters when requesting an import of all devices in the hub.", + "type": "object", + "properties": { + "inputBlobContainerUri": { + "description": "The input blob container URI.", + "type": "string" + }, + "outputBlobContainerUri": { + "description": "The output blob container URI.", + "type": "string" + }, + "inputBlobName": { + "description": "The blob name to be used when importing from the provided input blob container.", + "type": "string" + }, + "outputBlobName": { + "description": "The blob name to use for storing the status of the import job.", + "type": "string" + }, + "authenticationType": { + "description": "Specifies authentication type being used for connecting to the storage account.", + "enum": [ + "keyBased", + "identityBased" + ], + "type": "string", + "x-ms-enum": { + "name": "AuthenticationType", + "modelAsString": true + } + }, + "identity": { + "description": "Managed identity properties of storage endpoint for import devices.", + "$ref": "#/definitions/ManagedIdentity" + }, + "includeConfigurations": { + "description": "The value indicating whether configurations should be imported.", + "type": "boolean" + }, + "configurationsBlobName": { + "description": "The blob name to be used when importing configurations from the provided input blob container.", + "type": "string" + } + }, + "required": [ + "inputBlobContainerUri", + "outputBlobContainerUri" + ] + }, + "FailoverInput": { + "description": "Use to provide failover region when requesting manual Failover for a hub.", + "type": "object", + "properties": { + "failoverRegion": { + "description": "Region the hub will be failed over to", + "type": "string" + } + }, + "required": [ + "failoverRegion" + ] + }, + "IotHubLocationDescription": { + "description": "Public representation of one of the locations where a resource is provisioned.", + "type": "object", + "properties": { + "location": { + "description": "The name of the Azure region", + "type": "string" + }, + "role": { + "description": "The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to.", + "enum": [ + "primary", + "secondary" + ], + "type": "string", + "x-ms-enum": { + "name": "IotHubReplicaRoleType", + "modelAsString": true + } + } + } + }, + "ArmIdentity": { + "type": "object", + "properties": { + "principalId": { + "description": "Principal Id", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "Tenant Id", + "type": "string", + "readOnly": true + }, + "type": { + "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.", + "type": "string", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ArmUserIdentity" + } + } + } + }, + "ArmUserIdentity": { + "type": "object", + "properties": { + "principalId": { + "type": "string", + "readOnly": true + }, + "clientId": { + "type": "string", + "readOnly": true + } + } + }, + "EncryptionPropertiesDescription": { + "description": "The encryption properties for the IoT hub.", + "type": "object", + "properties": { + "keySource": { + "description": "The source of the key.", + "type": "string" + }, + "keyVaultProperties": { + "description": "The properties of the KeyVault key.", + "type": "array", + "items": { + "$ref": "#/definitions/KeyVaultKeyProperties" + } + } + } + }, + "KeyVaultKeyProperties": { + "description": "The properties of the KeyVault key.", + "type": "object", + "properties": { + "keyIdentifier": { + "type": "string", + "description": "The identifier of the key." + }, + "identity": { + "description": "Managed identity properties of KeyVault Key.", + "$ref": "#/definitions/ManagedIdentity" + } + } + }, + "ManagedIdentity": { + "description": "The properties of the Managed identity.", + "type": "object", + "properties": { + "userAssignedIdentity": { + "type": "string", + "description": "The user assigned identity." + } + } + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription identifier.", + "required": true, + "type": "string" + }, + "api-version": { + "name": "api-version", + "in": "query", + "description": "The version of the API.", + "required": true, + "type": "string" + }, + "resourceGroupName": { + "name": "resourceGroupName", + "description": "The name of the resource group that contains the IoT hub.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceName": { + "name": "resourceName", + "in": "path", + "description": "The name of the IoT hub.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "certificateName": { + "name": "certificateName", + "in": "path", + "description": "The name of the certificate", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$", + "x-ms-parameter-location": "method" + }, + "groupId": { + "name": "groupId", + "in": "path", + "description": "The name of the private link resource", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "privateEndpointConnectionName": { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/IotHub_ManualFailover.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/IotHub_ManualFailover.json new file mode 100644 index 000000000000..8a00c9b35b95 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/IotHub_ManualFailover.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "iotHubName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "failoverInput": { + "failoverRegion": "testHub" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/checkNameAvailability.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/checkNameAvailability.json new file mode 100644 index 000000000000..2420eaf3f988 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/checkNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "operationInputs": { + "name": "test-request" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "reason": "Invalid", + "message": "" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_certificatescreateorupdate.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_certificatescreateorupdate.json new file mode 100644 index 000000000000..d4e352c78a77 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_certificatescreateorupdate.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "resourceName": "iothub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "certificateDescription": { + "properties": { + "certificate": "############################################" + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "subject": "CN=testdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:23:50 GMT", + "certificate": "############################################" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServives/myFirstProvisioningService/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/IotHubs/Certificates", + "etag": "AAAAAAExpNs=" + } + }, + "200": { + "body": { + "properties": { + "subject": "CN=testdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:23:50 GMT", + "certificate": "############################################" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServives/myFirstProvisioningService/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/IotHubs/Certificates", + "etag": "AAAAAAExpNs=" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_certificatesdelete.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_certificatesdelete.json new file mode 100644 index 000000000000..41f98ee760f6 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_certificatesdelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceName": "myhub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "If-Match": "AAAAAAAADGk=" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_certverify.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_certverify.json new file mode 100644 index 000000000000..566aa0135989 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_certverify.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "resourceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "If-Match": "AAAAAAAADGk=", + "certificateVerificationBody": { + "certificate": "#####################################" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "subject": "CN=andbucdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25", + "isVerified": true, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:26:56 GMT" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/IotHubs/Certificates", + "etag": "AAAAAAExpTQ=" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_createOrUpdate.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_createOrUpdate.json new file mode 100644 index 000000000000..d40b60942e62 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_createOrUpdate.json @@ -0,0 +1,296 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "iotHubDescription": { + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "ipFilterRules": [], + "networkRuleSets": { + "defaultAction": "Deny", + "applyToBuiltInEventHubEndpoint": true, + "ipRules": [ + { + "filterName": "rule1", + "action": "Allow", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Allow", + "ipMask": "157.55.59.128/25" + } + ] + }, + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2 + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "name": "$fallback", + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None", + "minTlsVersion": "1.2" + }, + "sku": { + "name": "S1", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [ + { + "filterName": "rule1", + "action": "Accept", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Accept", + "ipMask": "157.55.59.128/25" + } + ], + "networkRuleSets": { + "defaultAction": "Deny", + "applyToBuiltInEventHubEndpoint": true, + "ipRules": [ + { + "filterName": "rule1", + "action": "Allow", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Allow", + "ipMask": "157.55.59.128/25" + } + ] + }, + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "name": "$fallback", + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None", + "minTlsVersion": "1.2" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [ + { + "filterName": "rule1", + "action": "Accept", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Accept", + "ipMask": "157.55.59.128/25" + } + ], + "networkRuleSets": { + "defaultAction": "Deny", + "applyToBuiltInEventHubEndpoint": true, + "ipRules": [ + { + "filterName": "rule1", + "action": "Allow", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Allow", + "ipMask": "157.55.59.128/25" + } + ] + }, + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "name": "$fallback", + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None", + "minTlsVersion": "1.2" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_createconsumergroup.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_createconsumergroup.json new file mode 100644 index 000000000000..b7befa5277ff --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_createconsumergroup.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "eventHubEndpointName": "events", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "name": "test", + "consumerGroupBody": { + "properties": { + "name": "test" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "created": "Thu, 15 Jun 2017 19:20:58 GMT" + }, + "id": "/subscriptions/cmd-sub-1/resourceGroups/cmd-rg-1/providers/Microsoft.Devices/IotHubs/test-hub-2/eventHubEndpoints/events/ConsumerGroups/%24Default", + "name": "test", + "type": "Microsoft.Devices/IotHubs/EventHubEndpoints/ConsumerGroups", + "etag": "AAAAAAFD6M4=" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_delete.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_delete.json new file mode 100644 index 000000000000..14f425fe676b --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_delete.json @@ -0,0 +1,218 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [ + { + "filterName": "rule1", + "action": "Accept", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Accept", + "ipMask": "157.55.59.128/25" + } + ], + "networkRuleSets": { + "defaultAction": "Deny", + "applyToBuiltInEventHubEndpoint": true, + "ipRules": [ + { + "filterName": "rule1", + "action": "Allow", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Allow", + "ipMask": "157.55.59.128/25" + } + ] + }, + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + }, + "204": {}, + "202": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [ + { + "filterName": "rule1", + "action": "Accept", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Accept", + "ipMask": "157.55.59.128/25" + } + ], + "networkRuleSets": { + "defaultAction": "Deny", + "applyToBuiltInEventHubEndpoint": true, + "ipRules": [ + { + "filterName": "rule1", + "action": "Allow", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Allow", + "ipMask": "157.55.59.128/25" + } + ] + }, + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + }, + "404": { + "body": {} + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_deleteconsumergroup.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_deleteconsumergroup.json new file mode 100644 index 000000000000..750fd6b08122 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_deleteconsumergroup.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "eventHubEndpointName": "events", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "name": "test" + }, + "responses": { + "200": {} + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_deleteprivateendpointconnection.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_deleteprivateendpointconnection.json new file mode 100644 index 000000000000..90b2c67dd0fc --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_deleteprivateendpointconnection.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "privateEndpointConnectionName": "myPrivateEndpointConnection" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/IotHubs/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Disconnected", + "description": "Deleted", + "actionsRequired": "None" + } + } + } + }, + "202": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/IotHubs/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Disconnected", + "description": "Deleted", + "actionsRequired": "None" + } + } + } + }, + "204": {} + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_exportdevices.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_exportdevices.json new file mode 100644 index 000000000000..1cd24188c114 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_exportdevices.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "exportDevicesParameters": { + "exportBlobContainerUri": "testBlob", + "excludeKeys": true + } + }, + "responses": { + "200": { + "body": { + "jobId": "test", + "startTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "endTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "type": "unknown", + "status": "unknown" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_generateverificationcode.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_generateverificationcode.json new file mode 100644 index 000000000000..138939e4783c --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_generateverificationcode.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "If-Match": "AAAAAAAADGk=" + }, + "responses": { + "200": { + "body": { + "name": "cert", + "properties": { + "verificationCode": "##################################", + "subject": "CN=andbucdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "##############################", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:26:56 GMT" + } + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_get.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_get.json new file mode 100644 index 000000000000..9e9c14a97231 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_get.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [ + { + "filterName": "rule1", + "action": "Accept", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Accept", + "ipMask": "157.55.59.128/25" + } + ], + "networkRuleSets": { + "defaultAction": "Deny", + "applyToBuiltInEventHubEndpoint": true, + "ipRules": [ + { + "filterName": "rule1", + "action": "Allow", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Allow", + "ipMask": "157.55.59.128/25" + } + ] + }, + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None", + "locations": [ + { + "location": "West US", + "role": "primary" + }, + { + "location": "East US", + "role": "secondary" + } + ], + "minTlsVersion": "1.2" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_getcertificate.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_getcertificate.json new file mode 100644 index 000000000000..29680d78df24 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_getcertificate.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "resourceName": "testhub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert" + }, + "responses": { + "200": { + "body": { + "properties": { + "subject": "CN=testdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:23:50 GMT", + "certificate": "############################################" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/andbuc-hub/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/IotHubs/Certificates", + "etag": "AAAAAAExpNs=" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_getconsumergroup.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_getconsumergroup.json new file mode 100644 index 000000000000..4b296bd39307 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_getconsumergroup.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "eventHubEndpointName": "events", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "name": "test" + }, + "responses": { + "200": { + "body": { + "properties": { + "created": "Thu, 15 Jun 2017 19:20:58 GMT" + }, + "id": "/subscriptions/cmd-sub-1/resourceGroups/cmd-rg-1/providers/Microsoft.Devices/IotHubs/test-hub-2/eventHubEndpoints/events/ConsumerGroups/%24Default", + "name": "test", + "type": "Microsoft.Devices/IotHubs/EventHubEndpoints/ConsumerGroups", + "etag": "AAAAAAFD6M4=" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_getjob.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_getjob.json new file mode 100644 index 000000000000..ffc29adadd9e --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_getjob.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "jobId": "test" + }, + "responses": { + "200": { + "body": { + "jobId": "test", + "startTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "endTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "type": "unknown", + "status": "unknown" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_getkey.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_getkey.json new file mode 100644 index 000000000000..118de4af0cdb --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_getkey.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "keyName": "iothubowner" + }, + "responses": { + "200": { + "body": { + "keyName": "iothubowner", + "primaryKey": "", + "secondaryKey": "", + "rights": "RegistryWrite, ServiceConnect, DeviceConnect" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_getprivateendpointconnection.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_getprivateendpointconnection.json new file mode 100644 index 000000000000..71641d074c87 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_getprivateendpointconnection.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "privateEndpointConnectionName": "myPrivateEndpointConnection" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/IotHubs/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my request!", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_getprivatelinkresources.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_getprivatelinkresources.json new file mode 100644 index 000000000000..f291dc1a0d46 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_getprivatelinkresources.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "groupId": "iotHub" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateLinkResources/iotHub", + "name": "iotHub", + "type": "Microsoft.Devices/IotHubs/PrivateLinkResources", + "properties": { + "groupId": "iotHub", + "requiredMembers": [ + "iotHub" + ], + "requiredZoneNames": [ + "privatelink.azure-devices.net" + ] + } + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_getskus.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_getskus.json new file mode 100644 index 000000000000..9147429f118b --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_getskus.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.Devices/IotHubs", + "sku": { + "name": "S1", + "tier": "Standard" + }, + "capacity": { + "default": 1, + "scaleType": "Manual" + } + }, + { + "resourceType": "Microsoft.Devices/IotHubs", + "sku": { + "name": "S2", + "tier": "Standard" + }, + "capacity": { + "minimum": 1, + "maximum": 200, + "default": 1, + "scaleType": "Manual" + } + }, + { + "resourceType": "Microsoft.Devices/IotHubs", + "sku": { + "name": "S3", + "tier": "Standard" + }, + "capacity": { + "minimum": 1, + "maximum": 10, + "default": 1, + "scaleType": "Manual" + } + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_importdevices.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_importdevices.json new file mode 100644 index 000000000000..c9278c9ae9b2 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_importdevices.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "importDevicesParameters": { + "inputBlobContainerUri": "testBlob", + "outputBlobContainerUri": "testBlob" + } + }, + "responses": { + "200": { + "body": { + "jobId": "test", + "startTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "endTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "type": "unknown", + "status": "unknown" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_listbyrg.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_listbyrg.json new file mode 100644 index 000000000000..17831eed8713 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_listbyrg.json @@ -0,0 +1,117 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [ + { + "filterName": "rule1", + "action": "Accept", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Accept", + "ipMask": "157.55.59.128/25" + } + ], + "networkRuleSets": { + "defaultAction": "Deny", + "applyToBuiltInEventHubEndpoint": true, + "ipRules": [ + { + "filterName": "rule1", + "action": "Allow", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Allow", + "ipMask": "157.55.59.128/25" + } + ] + }, + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "name": "$fallback", + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_listbysubscription.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_listbysubscription.json new file mode 100644 index 000000000000..b10a0915b173 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_listbysubscription.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "resourceName": "testHub", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [ + { + "filterName": "rule1", + "action": "Accept", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Accept", + "ipMask": "157.55.59.128/25" + } + ], + "networkRuleSets": { + "defaultAction": "Deny", + "applyToBuiltInEventHubEndpoint": true, + "ipRules": [ + { + "filterName": "rule1", + "action": "Allow", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Allow", + "ipMask": "157.55.59.128/25" + } + ] + }, + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "name": "$fallback", + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_listcertificates.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_listcertificates.json new file mode 100644 index 000000000000..f657ad0294dd --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_listcertificates.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "resourceName": "testhub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "subject": "CN=testdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:23:50 GMT", + "certificate": "############################################" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/andbuc-hub/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/IotHubs/Certificates", + "etag": "AAAAAAExpNs=" + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_listehgroups.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_listehgroups.json new file mode 100644 index 000000000000..55eb12b82d72 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_listehgroups.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "eventHubEndpointName": "events", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "created": "Thu, 15 Jun 2017 19:20:58 GMT" + }, + "id": "/subscriptions/cmd-sub-1/resourceGroups/cmd-rg-1/providers/Microsoft.Devices/IotHubs/test-hub-2/eventHubEndpoints/events/ConsumerGroups/%24Default", + "name": "$Default", + "type": "Microsoft.Devices/IotHubs/EventHubEndpoints/ConsumerGroups", + "etag": "AAAAAAFD6M4=" + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_listjobs.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_listjobs.json new file mode 100644 index 000000000000..6024a11218d0 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_listjobs.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "jobId": "test", + "startTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "endTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "type": "unknown", + "status": "unknown" + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_listkeys.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_listkeys.json new file mode 100644 index 000000000000..724d0cf7b0c3 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_listkeys.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "keyName": "iothubowner", + "primaryKey": "", + "secondaryKey": "", + "rights": "RegistryWrite, ServiceConnect, DeviceConnect" + }, + { + "keyName": "service", + "primaryKey": "", + "secondaryKey": "", + "rights": "ServiceConnect" + }, + { + "keyName": "device", + "primaryKey": "", + "secondaryKey": "", + "rights": "DeviceConnect" + }, + { + "keyName": "registryRead", + "primaryKey": "", + "secondaryKey": "", + "rights": "RegistryRead" + }, + { + "keyName": "registryReadWrite", + "primaryKey": "", + "secondaryKey": "", + "rights": "RegistryWrite" + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_listprivateendpointconnections.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_listprivateendpointconnections.json new file mode 100644 index 000000000000..8800f4d5f5e3 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_listprivateendpointconnections.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": [ + { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/IotHubs/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my request!", + "actionsRequired": "None" + } + } + } + ] + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_listprivatelinkresources.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_listprivatelinkresources.json new file mode 100644 index 000000000000..e6147bb08985 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_listprivatelinkresources.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateLinkResources/iotHub", + "name": "iotHub", + "type": "Microsoft.Devices/IotHubs/PrivateLinkResources", + "properties": { + "groupId": "iotHub", + "requiredMembers": [ + "iotHub" + ], + "requiredZoneNames": [ + "privatelink.azure-devices.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_operations.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_operations.json new file mode 100644 index 000000000000..91b7a7184c80 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_operations.json @@ -0,0 +1,328 @@ +{ + "parameters": { + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Devices/register/action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Register Resource Provider", + "description": "Register the subscription for the IotHub resource provider and enables the creation of IotHub resources" + } + }, + { + "name": "Microsoft.Devices/IotHubs/diagnosticSettings/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Diagnostic Setting", + "description": "Gets the diagnostic setting for the resource" + } + }, + { + "name": "Microsoft.Devices/IotHubs/diagnosticSettings/write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Set Diagnostic Setting", + "description": "Creates or updates the diagnostic setting for the resource" + } + }, + { + "name": "Microsoft.Devices/IotHubs/metricDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read IotHub service metric definitions", + "description": "Gets the available metrics for the IotHub service" + } + }, + { + "name": "Microsoft.Devices/IotHubs/logDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read IotHub service log definitions", + "description": "Gets the available log definitions for the IotHub Service" + } + }, + { + "name": "Microsoft.Devices/operations/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get All ResourceProvider Operations", + "description": "Get All ResourceProvider Operations" + } + }, + { + "name": "Microsoft.Devices/checkNameAvailability/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Check If IotHub name is available", + "description": "Check If IotHub name is available" + } + }, + { + "name": "Microsoft.Devices/usages/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Subscription Usages", + "description": "Get subscription usage details for this provider." + } + }, + { + "name": "Microsoft.Devices/iotHubs/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get IotHub(s)", + "description": "Gets the IotHub resource(s)" + } + }, + { + "name": "Microsoft.Devices/iotHubs/Write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Create or update IotHub Resource", + "description": "Create or update IotHub Resource" + } + }, + { + "name": "Microsoft.Devices/iotHubs/Delete", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Delete IotHub Resource", + "description": "Delete IotHub Resource" + } + }, + { + "name": "Microsoft.Devices/iotHubs/iotHubStats/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get IotHub Statistics", + "description": "Get IotHub Statistics" + } + }, + { + "name": "Microsoft.Devices/iotHubs/skus/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get valid IotHub Skus", + "description": "Get valid IotHub Skus" + } + }, + { + "name": "Microsoft.Devices/iotHubs/listkeys/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get all IotHub Keys", + "description": "Get all IotHub Keys" + } + }, + { + "name": "Microsoft.Devices/iotHubs/iotHubKeys/listkeys/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get IotHub Key for the given name", + "description": "Get IotHub Key for the given name" + } + }, + { + "name": "Microsoft.Devices/iotHubs/eventHubEndpoints/consumerGroups/Write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Create EventHub Consumer Group", + "description": "Create EventHub Consumer Group" + } + }, + { + "name": "Microsoft.Devices/iotHubs/eventHubEndpoints/consumerGroups/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get EventHub Consumer Group(s)", + "description": "Get EventHub Consumer Group(s)" + } + }, + { + "name": "Microsoft.Devices/iotHubs/eventHubEndpoints/consumerGroups/Delete", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Delete EventHub Consumer Group", + "description": "Delete EventHub Consumer Group" + } + }, + { + "name": "Microsoft.Devices/iotHubs/exportDevices/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Export Devices", + "description": "Export Devices" + } + }, + { + "name": "Microsoft.Devices/iotHubs/importDevices/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Import Devices", + "description": "Import Devices" + } + }, + { + "name": "Microsoft.Devices/iotHubs/jobs/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get the Job(s) on IotHub", + "description": "Get Job(s) details submitted on given IotHub" + } + }, + { + "name": "Microsoft.Devices/iotHubs/quotaMetrics/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Quota Metrics", + "description": "Get Quota Metrics" + } + }, + { + "name": "Microsoft.Devices/iotHubs/routing/routes/$testall/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Routing Rule Test All", + "description": "Test a message against all existing Routes" + } + }, + { + "name": "Microsoft.Devices/iotHubs/routing/routes/$testnew/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Routing Rule Test Route", + "description": "Test a message against a provided test Route" + } + }, + { + "name": "Microsoft.Devices/iotHubs/routingEndpointsHealth/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Endpoint Health", + "description": "Gets the health of all routing Endpoints for an IotHub" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/diagnosticSettings/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Diagnostic Setting", + "description": "Gets the diagnostic setting for the resource" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/diagnosticSettings/write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Set Diagnostic Setting", + "description": "Creates or updates the diagnostic setting for the resource" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/metricDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read DPS service metric definitions", + "description": "Gets the available metrics for the DPS service" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/logDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read DPS service log definitions", + "description": "Gets the available log definitions for the DPS Service" + } + }, + { + "name": "Microsoft.Devices/checkProvisioningServiceNameAvailability/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServives", + "operation": "Check If Provisioning Service name is available", + "description": "Check If Provisioning Service name is available" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Get Provisioning Service resource", + "description": "Get Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/Write", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Create Provisioning Service resource", + "description": "Create Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/Delete", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Delete Provisioning Service resource", + "description": "Delete Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/skus/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Delete Provisioning Service resource", + "description": "Delete Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/listkeys/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "get security related metadata", + "description": "get security related metadata" + } + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_patch.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_patch.json new file mode 100644 index 000000000000..3515ff6d9ea6 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_patch.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "resourceName": "myHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "location": "East US", + "type": "Microsoft.Devices/IotHubs", + "IotHubTags": { + "tags": { + "foo": "bar" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": { + "foo": "bar" + }, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [ + { + "filterName": "rule1", + "action": "Accept", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Accept", + "ipMask": "157.55.59.128/25" + } + ], + "networkRuleSets": { + "defaultAction": "Deny", + "applyToBuiltInEventHubEndpoint": true, + "ipRules": [ + { + "filterName": "rule1", + "action": "Allow", + "ipMask": "131.117.159.53" + }, + { + "filterName": "rule2", + "action": "Allow", + "ipMask": "157.55.59.128/25" + } + ] + }, + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "name": "$fallback", + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_quotametrics.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_quotametrics.json new file mode 100644 index 000000000000..a479e6471900 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_quotametrics.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TotalMessages", + "currentValue": 0, + "maxValue": 400000 + }, + { + "name": "TotalDeviceCount", + "currentValue": 0, + "maxValue": 500000 + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_routingendpointhealth.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_routingendpointhealth.json new file mode 100644 index 000000000000..0715758aec19 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_routingendpointhealth.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "iotHubName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "endpointId": "id1", + "healthStatus": "healthy", + "lastSuccessfulSendAttemptTime": "2020-03-26T21:20:57Z", + "lastSendAttemptTime": "2020-03-26T21:24:57Z" + }, + { + "endpointId": "id2", + "healthStatus": "unknown" + }, + { + "endpointId": "id3", + "healthStatus": "unhealthy", + "lastKnownError": "NotFound", + "lastKnownErrorTime": "2020-03-26T21:24:57Z", + "lastSuccessfulSendAttemptTime": "2020-03-26T21:20:57Z", + "lastSendAttemptTime": "2020-03-26T21:24:57Z" + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_stats.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_stats.json new file mode 100644 index 000000000000..1a7bcb918e7e --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_stats.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "totalDeviceCount": 0, + "enabledDeviceCount": 0, + "disabledDeviceCount": 0 + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_testallroutes.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_testallroutes.json new file mode 100644 index 000000000000..be36af2a80b4 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_testallroutes.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "iotHubName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "input": { + "routingSource": "DeviceMessages", + "message": { + "body": "Body of message", + "appProperties": { + "key1": "value1" + }, + "systemProperties": { + "key1": "value1" + } + } + } + }, + "responses": { + "200": { + "body": { + "routes": [ + { + "properties": { + "name": "Routeid", + "source": "DeviceMessages", + "endpointNames": [ + "id1" + ], + "isEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_testnewroute.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_testnewroute.json new file mode 100644 index 000000000000..43924af26379 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_testnewroute.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "iotHubName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "input": { + "message": { + "body": "Body of message", + "appProperties": { + "key1": "value1" + }, + "systemProperties": { + "key1": "value1" + } + }, + "route": { + "name": "Routeid", + "source": "DeviceMessages", + "endpointNames": [ + "id1" + ], + "isEnabled": true + } + } + }, + "responses": { + "200": { + "body": { + "result": "false", + "details": { + "compilationErrors": [ + { + "message": "string response", + "severity": "error", + "location": { + "start": { + "line": 12, + "column": 12 + }, + "end": { + "line": 12, + "column": 24 + } + } + } + ] + } + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_updateprivateendpointconnection.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_updateprivateendpointconnection.json new file mode 100644 index 000000000000..56b6a75ed80a --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_updateprivateendpointconnection.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "privateEndpointConnectionName": "myPrivateEndpointConnection", + "privateEndpointConnection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/IotHubs/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com", + "actionsRequired": "None" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/IotHubs/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_usages.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_usages.json new file mode 100644 index 000000000000..dbf8d7531d50 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/examples/iothub_usages.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscription/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/usages/freeHubCount", + "type": "/subscription/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/usages", + "unit": "count", + "currentValue": 1, + "limit": 1, + "name": { + "value": "FreeHubCount", + "localizedValue": "Free Hub Count" + } + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/iothub.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/iothub.json new file mode 100644 index 000000000000..73f78477971d --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-07-01/iothub.json @@ -0,0 +1,4401 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-07-01", + "title": "iotHubClient", + "description": "Use this API to manage the IoT hubs in your Azure subscription.", + "x-ms-code-generation-settings": { + "header": "MICROSOFT_MIT_NO_VERSION" + } + }, + "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.Devices/operations": { + "get": { + "tags": [ + "Operations" + ], + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/iothub_operations.json" + } + }, + "operationId": "Operations_List", + "description": "Lists all of the available IoT Hub REST API operations.", + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the non-security related metadata of an IoT hub", + "description": "Get the non-security related metadata of an IoT hub.", + "operationId": "IotHubResource_Get", + "x-ms-examples": { + "IotHubResource_Get": { + "$ref": "./examples/iothub_get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "The body contains all the non-security properties of the IoT hub. Security-related properties are set to null.", + "schema": { + "$ref": "#/definitions/IotHubDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "PUT" + ], + "summary": "Create or update the metadata of an IoT hub.", + "description": "Create or update the metadata of an Iot hub. The usual pattern to modify a property is to retrieve the IoT hub metadata and security metadata, and then combine them with the modified values in a new body to update the IoT hub. If certain properties are missing in the JSON, updating IoT Hub may cause these values to fallback to default, which may lead to unexpected behavior.", + "operationId": "IotHubResource_CreateOrUpdate", + "x-ms-examples": { + "IotHubResource_CreateOrUpdate": { + "$ref": "./examples/iothub_createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "iotHubDescription", + "in": "body", + "description": "The IoT hub metadata and security metadata.", + "required": true, + "schema": { + "$ref": "#/definitions/IotHubDescription" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the IoT Hub. Do not specify for creating a brand new IoT Hub. Required to update an existing IoT Hub." + } + ], + "responses": { + "201": { + "description": "This is a long running operation. The operation returns a 201 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation. If successful, the operation returns HTTP status code of 201 (OK).", + "schema": { + "$ref": "#/definitions/IotHubDescription" + } + }, + "200": { + "description": "This is returned as a response to the status polling request for the create or update operation. The body contains the resource representation that indicates a transitional provisioning state.", + "schema": { + "$ref": "#/definitions/IotHubDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "patch": { + "tags": [ + "PATCH" + ], + "summary": "Update an existing IoT Hubs tags.", + "description": "Update an existing IoT Hub tags. to update other fields use the CreateOrUpdate method", + "x-ms-long-running-operation": true, + "operationId": "IotHubResource_Update", + "x-ms-examples": { + "IotHubResource_Update": { + "$ref": "./examples/iothub_patch.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of iot hub to update." + }, + { + "name": "IotHubTags", + "in": "body", + "required": true, + "description": "Updated tag information to set into the iot hub instance.", + "schema": { + "$ref": "#/definitions/TagsResource" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Iot Hub was successfully updated", + "schema": { + "$ref": "#/definitions/IotHubDescription" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "tags": [ + "DELETE" + ], + "summary": "Delete an IoT hub", + "description": "Delete an IoT hub.", + "operationId": "IotHubResource_Delete", + "x-ms-examples": { + "IotHubResource_Delete": { + "$ref": "./examples/iothub_delete.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "202": { + "description": "The Iot Hub resource provider always returns a 202 Accepted status code with valid Location and Retry-After headers. The resource provider also sets the Azure-AsyncOperation header with a URL that points to the operation resource for this operation. Subsequent GET attempts on the resource after a DELETE operation return a resource representation that indicates a transitional provisioning state (such as Terminating). To retrieve the status of the operation, a client can either poll the URL returned in the Location header after the Retry-After interval, get the IoT Hub service status directly, or query the operation resource.", + "schema": { + "$ref": "#/definitions/IotHubDescription" + } + }, + "200": { + "description": "This is returned as a response to the status polling request for the delete operation. The body contains the resource representation that indicates a transitional provisioning state.", + "schema": { + "$ref": "#/definitions/IotHubDescription" + } + }, + "204": { + "description": "Once the long running delete operation completes successfully, a 204 No Content status code is returned when the status polling request finds the Iot hub metadata in the service and the status of the delete operation is set to a completed state." + }, + "404": { + "description": "After the long running delete operation completes successfully, a 404 Not Found is returned when the status polling request no longer finds the Iot hub metadata in the service.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Devices/IotHubs": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get all the IoT hubs in a subscription", + "description": "Get all the IoT hubs in a subscription.", + "operationId": "IotHubResource_ListBySubscription", + "x-ms-examples": { + "IotHubResource_ListBySubscription": { + "$ref": "./examples/iothub_listbysubscription.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the IoT hubs in the subscription.", + "schema": { + "$ref": "#/definitions/IotHubDescriptionListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get all the IoT hubs in a resource group", + "description": "Get all the IoT hubs in a resource group.", + "operationId": "IotHubResource_ListByResourceGroup", + "x-ms-examples": { + "IotHubResource_ListByResourceGroup": { + "$ref": "./examples/iothub_listbyrg.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the IoT hubs in the resource group.", + "schema": { + "$ref": "#/definitions/IotHubDescriptionListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubStats": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the statistics from an IoT hub", + "description": "Get the statistics from an IoT hub.", + "operationId": "IotHubResource_GetStats", + "x-ms-examples": { + "IotHubResource_GetStats": { + "$ref": "./examples/iothub_stats.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains JSON-serialized statistics from the identity registry in the IoT hub.", + "schema": { + "$ref": "#/definitions/RegistryStatistics" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/skus": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the list of valid SKUs for an IoT hub", + "description": "Get the list of valid SKUs for an IoT hub.", + "operationId": "IotHubResource_GetValidSkus", + "x-ms-examples": { + "IotHubResource_GetValidSkus": { + "$ref": "./examples/iothub_getskus.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the valid SKUs for this IoT hub.", + "schema": { + "$ref": "#/definitions/IotHubSkuDescriptionListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub", + "description": "Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub.", + "operationId": "IotHubResource_ListEventHubConsumerGroups", + "x-ms-examples": { + "IotHubResource_ListEventHubConsumerGroups": { + "$ref": "./examples/iothub_listehgroups.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "eventHubEndpointName", + "in": "path", + "description": "The name of the Event Hub-compatible endpoint.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized list of the consumer groups in the Event Hub-compatible endpoint in this IoT hub", + "schema": { + "$ref": "#/definitions/EventHubConsumerGroupsListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub", + "description": "Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub.", + "operationId": "IotHubResource_GetEventHubConsumerGroup", + "x-ms-examples": { + "IotHubResource_ListEventHubConsumerGroups": { + "$ref": "./examples/iothub_getconsumergroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "eventHubEndpointName", + "in": "path", + "description": "The name of the Event Hub-compatible endpoint in the IoT hub.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the consumer group to retrieve.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized consumer group.", + "schema": { + "$ref": "#/definitions/EventHubConsumerGroupInfo" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "PUT" + ], + "summary": "Add a consumer group to an Event Hub-compatible endpoint in an IoT hub", + "description": "Add a consumer group to an Event Hub-compatible endpoint in an IoT hub.", + "operationId": "IotHubResource_CreateEventHubConsumerGroup", + "x-ms-examples": { + "IotHubResource_CreateEventHubConsumerGroup": { + "$ref": "./examples/iothub_createconsumergroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "eventHubEndpointName", + "in": "path", + "description": "The name of the Event Hub-compatible endpoint in the IoT hub.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the consumer group to add.", + "required": true, + "type": "string" + }, + { + "name": "consumerGroupBody", + "in": "body", + "description": "The consumer group to add.", + "required": true, + "schema": { + "$ref": "#/definitions/EventHubConsumerGroupBodyDescription" + } + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation.", + "schema": { + "$ref": "#/definitions/EventHubConsumerGroupInfo" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "DELETE" + ], + "summary": "Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub", + "description": "Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub.", + "operationId": "IotHubResource_DeleteEventHubConsumerGroup", + "x-ms-examples": { + "IotHubResource_DeleteEventHubConsumerGroup": { + "$ref": "./examples/iothub_deleteconsumergroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "eventHubEndpointName", + "in": "path", + "description": "The name of the Event Hub-compatible endpoint in the IoT hub.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the consumer group to delete.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry", + "description": "Get a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.", + "operationId": "IotHubResource_ListJobs", + "x-ms-examples": { + "IotHubResource_ListJobs": { + "$ref": "./examples/iothub_listjobs.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The response contains a JSON-serialized array of all the jobs in the IoT hub.", + "schema": { + "$ref": "#/definitions/JobResponseListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs/{jobId}": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry", + "description": "Get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.", + "operationId": "IotHubResource_GetJob", + "x-ms-examples": { + "IotHubResource_GetJob": { + "$ref": "./examples/iothub_getjob.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "jobId", + "in": "path", + "description": "The job identifier.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The response contains a JSON-serialized description of the job in the IoT hub.", + "schema": { + "$ref": "#/definitions/JobResponse" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/quotaMetrics": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the quota metrics for an IoT hub", + "description": "Get the quota metrics for an IoT hub.", + "operationId": "IotHubResource_GetQuotaMetrics", + "x-ms-examples": { + "IotHubResource_GetQuotaMetrics": { + "$ref": "./examples/iothub_quotametrics.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The response contains a JSON-serialized array of the quota metrics for the IoT hub.", + "schema": { + "$ref": "#/definitions/IotHubQuotaMetricInfoListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routingEndpointsHealth": { + "get": { + "tags": [ + "GET" + ], + "operationId": "IotHubResource_GetEndpointHealth", + "summary": "Get the health for routing endpoints", + "description": "Get the health for routing endpoints.", + "x-ms-examples": { + "IotHubResource_GetEndpointHealth": { + "$ref": "./examples/iothub_routingendpointhealth.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "iotHubName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EndpointHealthDataListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkNameAvailability": { + "post": { + "tags": [ + "POST" + ], + "summary": "Check if an IoT hub name is available", + "description": "Check if an IoT hub name is available.", + "operationId": "IotHubResource_CheckNameAvailability", + "x-ms-examples": { + "IotHubResource_CheckNameAvailability": { + "$ref": "./examples/checkNameAvailability.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "operationInputs", + "in": "body", + "description": "Set the name parameter in the OperationInputs structure to the name of the IoT hub to check.", + "required": true, + "schema": { + "$ref": "#/definitions/OperationInputs" + } + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the IoT hub name is available. If the name is not available, the body contains the reason.", + "schema": { + "$ref": "#/definitions/IotHubNameAvailabilityInfo" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Devices/usages": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the number of iot hubs in the subscription", + "description": "Get the number of free and paid iot hubs in the subscription", + "operationId": "ResourceProviderCommon_GetSubscriptionQuota", + "x-ms-examples": { + "ResourceProviderCommon_GetSubscriptionQuota": { + "$ref": "./examples/iothub_usages.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UserSubscriptionQuotaListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testall": { + "post": { + "tags": [ + "POST" + ], + "operationId": "IotHubResource_TestAllRoutes", + "summary": "Test all routes", + "description": "Test all routes configured in this Iot Hub", + "x-ms-examples": { + "IotHubResource_TestAllRoutes": { + "$ref": "./examples/iothub_testallroutes.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "input", + "description": "Input for testing all routes", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TestAllRoutesInput" + } + }, + { + "name": "iotHubName", + "description": "IotHub to be tested", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "resource group which Iot Hub belongs to", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TestAllRoutesResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testnew": { + "post": { + "tags": [ + "POST" + ], + "operationId": "IotHubResource_TestRoute", + "summary": "Test the new route", + "description": "Test the new route for this Iot Hub", + "x-ms-examples": { + "IotHubResource_TestRoute": { + "$ref": "./examples/iothub_testnewroute.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "input", + "description": "Route that needs to be tested", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TestRouteInput" + } + }, + { + "name": "iotHubName", + "description": "IotHub to be tested", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "resource group which Iot Hub belongs to", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TestRouteResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/listkeys": { + "post": { + "tags": [ + "POST" + ], + "summary": "Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security", + "description": "Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.", + "operationId": "IotHubResource_ListKeys", + "x-ms-examples": { + "IotHubResource_ListKeys": { + "$ref": "./examples/iothub_listkeys.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of shared access policies, including keys, that you can use to access the IoT hub endpoints.", + "schema": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRuleListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubKeys/{keyName}/listkeys": { + "post": { + "tags": [ + "POST" + ], + "summary": "Get a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security", + "description": "Get a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.", + "operationId": "IotHubResource_GetKeysForKeyName", + "x-ms-examples": { + "IotHubResource_GetKeysForKeyName": { + "$ref": "./examples/iothub_getkey.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "keyName", + "in": "path", + "description": "The name of the shared access policy.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized shared access policy, including keys, that you can use to access one or more IoT hub endpoints.", + "schema": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRule" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/exportDevices": { + "post": { + "tags": [ + "POST" + ], + "summary": "Exports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities", + "description": "Exports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.", + "operationId": "IotHubResource_ExportDevices", + "x-ms-examples": { + "IotHubResource_ExportDevices": { + "$ref": "./examples/iothub_exportdevices.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "exportDevicesParameters", + "in": "body", + "description": "The parameters that specify the export devices operation.", + "required": true, + "schema": { + "$ref": "#/definitions/ExportDevicesRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobResponse" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/importDevices": { + "post": { + "tags": [ + "POST" + ], + "summary": "Import, update, or delete device identities in the IoT hub identity registry from a blob. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities", + "description": "Import, update, or delete device identities in the IoT hub identity registry from a blob. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.", + "operationId": "IotHubResource_ImportDevices", + "x-ms-examples": { + "IotHubResource_ImportDevices": { + "$ref": "./examples/iothub_importdevices.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "importDevicesParameters", + "in": "body", + "description": "The parameters that specify the import devices operation.", + "required": true, + "schema": { + "$ref": "#/definitions/ImportDevicesRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobResponse" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates": { + "get": { + "tags": [ + "Certificates" + ], + "summary": "Get the certificate list.", + "description": "Returns the list of certificates.", + "operationId": "Certificates_ListByIotHub", + "x-ms-examples": { + "Certificates_ListByIotHub": { + "$ref": "./examples/iothub_listcertificates.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "The body contains all the certificate list.", + "schema": { + "$ref": "#/definitions/CertificateListDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}": { + "get": { + "tags": [ + "Certificates" + ], + "summary": "Get the certificate.", + "description": "Returns the certificate.", + "operationId": "Certificates_Get", + "x-ms-examples": { + "Certificates_Get": { + "$ref": "./examples/iothub_getcertificate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/certificateName" + } + ], + "responses": { + "200": { + "description": "The body contains the certificate.", + "schema": { + "$ref": "#/definitions/CertificateDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Certificates" + ], + "summary": "Upload the certificate to the IoT hub.", + "description": "Adds new or replaces existing certificate.", + "operationId": "Certificates_CreateOrUpdate", + "x-ms-examples": { + "Certificates_CreateOrUpdate": { + "$ref": "./examples/iothub_certificatescreateorupdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/certificateName" + }, + { + "name": "certificateDescription", + "in": "body", + "description": "The certificate body.", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateDescription" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the Certificate. Do not specify for creating a brand new certificate. Required to update an existing certificate." + } + ], + "responses": { + "201": { + "description": "If certificate didn't exist creation was successful, the operation returns HTTP status code of 201 (OK).", + "schema": { + "$ref": "#/definitions/CertificateDescription" + } + }, + "200": { + "description": "If certificate already exist and update was successful, the operation returns HTTP status code of 201 (OK).", + "schema": { + "$ref": "#/definitions/CertificateDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "Certificates" + ], + "summary": "Delete an X509 certificate.", + "description": "Deletes an existing X509 certificate or does nothing if it does not exist.", + "operationId": "Certificates_Delete", + "x-ms-examples": { + "Certificates_Delete": { + "$ref": "./examples/iothub_certificatesdelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/certificateName" + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "ETag of the Certificate." + } + ], + "responses": { + "200": { + "description": "Certificate has been deleted." + }, + "204": { + "description": "Certificate does not exist." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}/generateVerificationCode": { + "post": { + "tags": [ + "Certificates" + ], + "summary": "Generate verification code for proof of possession flow.", + "description": "Generates verification code for proof of possession flow. The verification code will be used to generate a leaf certificate.", + "operationId": "Certificates_GenerateVerificationCode", + "x-ms-examples": { + "Certificates_GenerateVerificationCode": { + "$ref": "./examples/iothub_generateverificationcode.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/certificateName" + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "ETag of the Certificate." + } + ], + "responses": { + "200": { + "description": "The body contains the certificate.", + "schema": { + "$ref": "#/definitions/CertificateWithNonceDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}/verify": { + "post": { + "tags": [ + "Certificates" + ], + "summary": "Verify certificate's private key possession.", + "description": "Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.", + "operationId": "Certificates_Verify", + "x-ms-examples": { + "Certificates_Verify": { + "$ref": "./examples/iothub_certverify.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/certificateName" + }, + { + "name": "certificateVerificationBody", + "in": "body", + "description": "The name of the certificate", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateVerificationDescription" + } + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "ETag of the Certificate." + } + ], + "responses": { + "200": { + "description": "The body contains the certificate.", + "schema": { + "$ref": "#/definitions/CertificateDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/failover": { + "post": { + "tags": [ + "POST" + ], + "operationId": "IotHub_ManualFailover", + "summary": "Manually initiate a failover for the IoT Hub to its secondary region", + "description": "Manually initiate a failover for the IoT Hub to its secondary region. To learn more, see https://aka.ms/manualfailover", + "x-ms-examples": { + "IotHub_ManualFailover": { + "$ref": "./examples/IotHub_ManualFailover.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "parameters": [ + { + "name": "iotHubName", + "description": "Name of the IoT hub to failover", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "failoverInput", + "description": "Region to failover to. Must be the Azure paired region. Get the value from the secondary location in the locations property. To learn more, see https://aka.ms/manualfailover/region", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FailoverInput" + } + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "Name of the resource group containing the IoT hub resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Long running manual failover operation for the IoT hub completed" + }, + "202": { + "description": "Manual failover initiated" + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "GET" + ], + "summary": "List private link resources", + "description": "List private link resources for the given IotHub", + "operationId": "PrivateLinkResources_List", + "x-ms-examples": { + "PrivateLinkResources_List": { + "$ref": "./examples/iothub_listprivatelinkresources.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "The body contains the list of private link resources", + "schema": { + "$ref": "#/definitions/PrivateLinkResources" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateLinkResources/{groupId}": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the specified private link resource", + "description": "Get the specified private link resource for the given IotHub", + "operationId": "PrivateLinkResources_Get", + "x-ms-examples": { + "PrivateLinkResources_List": { + "$ref": "./examples/iothub_getprivatelinkresources.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/groupId" + } + ], + "responses": { + "200": { + "description": "The body contains the specified of private link resource", + "schema": { + "$ref": "#/definitions/GroupIdInformation" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "GET" + ], + "summary": "List private endpoint connections", + "description": "List private endpoint connection properties", + "operationId": "PrivateEndpointConnections_List", + "x-ms-examples": { + "PrivateEndpointConnections_List": { + "$ref": "./examples/iothub_listprivateendpointconnections.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "The body contains the list of private endpoint connection properties", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionsList" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get private endpoint connection", + "description": "Get private endpoint connection properties", + "operationId": "PrivateEndpointConnections_Get", + "x-ms-examples": { + "PrivateEndpointConnection_Get": { + "$ref": "./examples/iothub_getprivateendpointconnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/privateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "The body contains the private endpoint connection properties", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "PUT" + ], + "summary": "Update private endpoint connection", + "description": "Update the status of a private endpoint connection with the specified name", + "operationId": "PrivateEndpointConnections_Update", + "x-ms-examples": { + "PrivateEndpointConnection_Update": { + "$ref": "./examples/iothub_updateprivateendpointconnection.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/privateEndpointConnectionName" + }, + { + "name": "privateEndpointConnection", + "in": "body", + "description": "The private endpoint connection with updated properties", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "201": { + "description": "This is a long running operation. The operation returns a 201 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation. If successful, the operation returns HTTP status code of 201 (OK).", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "200": { + "description": "This is returned as a response to the status polling request for the update operation.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "DELETE" + ], + "summary": "Delete private endpoint connection", + "description": "Delete private endpoint connection with the specified name", + "operationId": "PrivateEndpointConnections_Delete", + "x-ms-examples": { + "PrivateEndpointConnection_Delete": { + "$ref": "./examples/iothub_deleteprivateendpointconnection.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/privateEndpointConnectionName" + } + ], + "responses": { + "202": { + "description": "This is a long running operation. The operation returns a 202 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "200": { + "description": "This is returned as a response to the status polling request for the delete operation.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "204": { + "description": "PrivateEndpoint does not exist." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + } + }, + "definitions": { + "CertificateVerificationDescription": { + "description": "The JSON-serialized leaf certificate", + "type": "object", + "properties": { + "certificate": { + "description": "base-64 representation of X509 certificate .cer file or just .pem file content.", + "type": "string" + } + } + }, + "CertificateListDescription": { + "description": "The JSON-serialized array of Certificate objects.", + "type": "object", + "properties": { + "value": { + "description": "The array of Certificate objects.", + "type": "array", + "items": { + "$ref": "#/definitions/CertificateDescription" + } + } + } + }, + "CertificateBodyDescription": { + "description": "The JSON-serialized X509 Certificate.", + "type": "object", + "properties": { + "certificate": { + "description": "base-64 representation of the X509 leaf certificate .cer file or just .pem file content.", + "type": "string" + }, + "isVerified": { + "description": "True indicates that the certificate will be created in verified state and proof of possession will not be required.", + "type": "boolean" + } + } + }, + "CertificateDescription": { + "description": "The X509 Certificate.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CertificateProperties" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "description": "The name of the certificate.", + "type": "string", + "readOnly": true + }, + "etag": { + "description": "The entity tag.", + "type": "string", + "readOnly": true + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + } + }, + "x-ms-azure-resource": true + }, + "CertificateWithNonceDescription": { + "description": "The X509 Certificate.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CertificatePropertiesWithNonce" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "description": "The name of the certificate.", + "type": "string", + "readOnly": true + }, + "etag": { + "description": "The entity tag.", + "type": "string", + "readOnly": true + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + } + }, + "x-ms-azure-resource": true + }, + "SharedAccessSignatureAuthorizationRule": { + "description": "The properties of an IoT hub shared access policy.", + "type": "object", + "properties": { + "keyName": { + "description": "The name of the shared access policy.", + "type": "string" + }, + "primaryKey": { + "description": "The primary key.", + "type": "string" + }, + "secondaryKey": { + "description": "The secondary key.", + "type": "string" + }, + "rights": { + "description": "The permissions assigned to the shared access policy.", + "enum": [ + "RegistryRead", + "RegistryWrite", + "ServiceConnect", + "DeviceConnect", + "RegistryRead, RegistryWrite", + "RegistryRead, ServiceConnect", + "RegistryRead, DeviceConnect", + "RegistryWrite, ServiceConnect", + "RegistryWrite, DeviceConnect", + "ServiceConnect, DeviceConnect", + "RegistryRead, RegistryWrite, ServiceConnect", + "RegistryRead, RegistryWrite, DeviceConnect", + "RegistryRead, ServiceConnect, DeviceConnect", + "RegistryWrite, ServiceConnect, DeviceConnect", + "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect" + ], + "type": "string", + "x-ms-enum": { + "name": "AccessRights", + "modelAsString": false + } + } + }, + "required": [ + "keyName", + "rights" + ] + }, + "CertificateProperties": { + "description": "The description of an X509 CA Certificate.", + "type": "object", + "properties": { + "subject": { + "description": "The certificate's subject name.", + "type": "string", + "readOnly": true + }, + "expiry": { + "description": "The certificate's expiration date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + }, + "thumbprint": { + "description": "The certificate's thumbprint.", + "type": "string", + "readOnly": true + }, + "isVerified": { + "description": "Determines whether certificate has been verified.", + "type": "boolean", + "readOnly": true + }, + "created": { + "description": "The certificate's create date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + }, + "updated": { + "description": "The certificate's last update date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + }, + "certificate": { + "description": "The certificate content", + "type": "string" + } + } + }, + "CertificatePropertiesWithNonce": { + "description": "The description of an X509 CA Certificate including the challenge nonce issued for the Proof-Of-Possession flow.", + "type": "object", + "properties": { + "subject": { + "description": "The certificate's subject name.", + "type": "string", + "readOnly": true + }, + "expiry": { + "description": "The certificate's expiration date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + }, + "thumbprint": { + "description": "The certificate's thumbprint.", + "type": "string", + "readOnly": true + }, + "isVerified": { + "description": "Determines whether certificate has been verified.", + "type": "boolean", + "readOnly": true + }, + "created": { + "description": "The certificate's create date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + }, + "updated": { + "description": "The certificate's last update date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + }, + "verificationCode": { + "description": "The certificate's verification code that will be used for proof of possession.", + "type": "string", + "readOnly": true + }, + "certificate": { + "description": "The certificate content", + "type": "string", + "readOnly": true + } + } + }, + "IotHubProperties": { + "description": "The properties of an IoT hub.", + "type": "object", + "properties": { + "authorizationPolicies": { + "description": "The shared access policies you can use to secure a connection to the IoT hub.", + "type": "array", + "items": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRule" + } + }, + "disableLocalAuth": { + "description": "If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication.", + "type": "boolean" + }, + "disableDeviceSAS": { + "description": "If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for authentication.", + "type": "boolean" + }, + "disableModuleSAS": { + "description": "If true, all module scoped SAS keys cannot be used for authentication.", + "type": "boolean" + }, + "restrictOutboundNetworkAccess": { + "description": "If true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList.", + "type": "boolean" + }, + "allowedFqdnList": { + "description": "List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub.", + "type": "array", + "items": { + "description": "FQDN to be allowed for egress. Example: my-eventhub.servicebus.windows.net", + "type": "string" + } + }, + "publicNetworkAccess": { + "type": "string", + "description": "Whether requests from Public Network are allowed", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "PublicNetworkAccess" + } + }, + "ipFilterRules": { + "description": "The IP filter rules.", + "type": "array", + "items": { + "$ref": "#/definitions/IpFilterRule" + } + }, + "networkRuleSets": { + "$ref": "#/definitions/NetworkRuleSetProperties" + }, + "minTlsVersion": { + "type": "string", + "description": "Specifies the minimum TLS version to support for this hub. Can be set to \"1.2\" to have clients that use a TLS version below 1.2 to be rejected." + }, + "privateEndpointConnections": { + "description": "Private endpoint connections created on this IotHub", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "provisioningState": { + "description": "The provisioning state.", + "type": "string", + "readOnly": true + }, + "state": { + "description": "The hub state.", + "type": "string", + "readOnly": true + }, + "hostName": { + "description": "The name of the host.", + "type": "string", + "readOnly": true + }, + "eventHubEndpoints": { + "description": "The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/EventHubProperties" + } + }, + "routing": { + "$ref": "#/definitions/RoutingProperties" + }, + "storageEndpoints": { + "description": "The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StorageEndpointProperties" + } + }, + "messagingEndpoints": { + "description": "The messaging endpoint properties for the file upload notification queue.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MessagingEndpointProperties" + } + }, + "enableFileUploadNotifications": { + "description": "If True, file upload notifications are enabled.", + "type": "boolean" + }, + "cloudToDevice": { + "$ref": "#/definitions/CloudToDeviceProperties" + }, + "comments": { + "description": "IoT hub comments.", + "type": "string" + }, + "features": { + "description": "The capabilities and features enabled for the IoT hub.", + "enum": [ + "None", + "DeviceManagement" + ], + "type": "string", + "x-ms-enum": { + "name": "Capabilities", + "modelAsString": true + } + }, + "locations": { + "description": "Primary and secondary location for iot hub", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/IotHubLocationDescription" + } + } + } + }, + "IotHubSkuInfo": { + "description": "Information about the SKU of the IoT hub.", + "type": "object", + "properties": { + "name": { + "description": "The name of the SKU.", + "enum": [ + "F1", + "S1", + "S2", + "S3", + "B1", + "B2", + "B3" + ], + "type": "string", + "x-ms-enum": { + "name": "IotHubSku", + "modelAsString": true + } + }, + "tier": { + "description": "The billing tier for the IoT hub.", + "enum": [ + "Free", + "Standard", + "Basic" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "IotHubSkuTier", + "modelAsString": false + } + }, + "capacity": { + "format": "int64", + "description": "The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.", + "type": "integer" + } + }, + "required": [ + "name" + ] + }, + "EventHubProperties": { + "description": "The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.", + "type": "object", + "properties": { + "retentionTimeInDays": { + "format": "int64", + "description": "The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages", + "type": "integer" + }, + "partitionCount": { + "format": "int32", + "description": "The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.", + "type": "integer" + }, + "partitionIds": { + "description": "The partition ids in the Event Hub-compatible endpoint.", + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + }, + "path": { + "description": "The Event Hub-compatible name.", + "type": "string", + "readOnly": true + }, + "endpoint": { + "description": "The Event Hub-compatible endpoint.", + "type": "string", + "readOnly": true + } + } + }, + "StorageEndpointProperties": { + "description": "The properties of the Azure Storage endpoint for file upload.", + "type": "object", + "properties": { + "sasTtlAsIso8601": { + "description": "The period of time for which the SAS URI generated by IoT Hub for file upload is valid. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.", + "type": "string", + "format": "duration" + }, + "connectionString": { + "description": "The connection string for the Azure Storage account to which files are uploaded.", + "type": "string" + }, + "containerName": { + "description": "The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified.", + "type": "string" + }, + "authenticationType": { + "description": "Specifies authentication type being used for connecting to the storage account.", + "enum": [ + "keyBased", + "identityBased" + ], + "type": "string", + "x-ms-enum": { + "name": "AuthenticationType", + "modelAsString": true + } + }, + "identity": { + "description": "Managed identity properties of storage endpoint for file upload.", + "$ref": "#/definitions/ManagedIdentity" + } + }, + "required": [ + "connectionString", + "containerName" + ] + }, + "MessagingEndpointProperties": { + "description": "The properties of the messaging endpoints used by this IoT hub.", + "type": "object", + "properties": { + "lockDurationAsIso8601": { + "description": "The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.", + "type": "string", + "format": "duration" + }, + "ttlAsIso8601": { + "description": "The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.", + "type": "string", + "format": "duration" + }, + "maxDeliveryCount": { + "description": "The number of times the IoT hub attempts to deliver a message. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.", + "format": "int32", + "type": "integer", + "minimum": 1, + "maximum": 100 + } + } + }, + "CloudToDeviceProperties": { + "description": "The IoT hub cloud-to-device messaging properties.", + "type": "object", + "properties": { + "maxDeliveryCount": { + "description": "The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.", + "format": "int32", + "type": "integer", + "minimum": 1, + "maximum": 100 + }, + "defaultTtlAsIso8601": { + "description": "The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.", + "type": "string", + "format": "duration" + }, + "feedback": { + "$ref": "#/definitions/FeedbackProperties" + } + } + }, + "IpFilterRule": { + "description": "The IP filter rules for the IoT hub.", + "type": "object", + "properties": { + "filterName": { + "description": "The name of the IP filter rule.", + "type": "string" + }, + "action": { + "description": "The desired action for requests captured by this rule.", + "enum": [ + "Accept", + "Reject" + ], + "type": "string", + "x-ms-enum": { + "name": "IpFilterActionType", + "modelAsString": false + } + }, + "ipMask": { + "description": "A string that contains the IP address range in CIDR notation for the rule.", + "type": "string" + } + }, + "required": [ + "filterName", + "action", + "ipMask" + ] + }, + "NetworkRuleSetProperties": { + "description": "Network Rule Set Properties of IotHub", + "type": "object", + "properties": { + "defaultAction": { + "type": "string", + "description": "Default Action for Network Rule Set", + "enum": [ + "Deny", + "Allow" + ], + "x-ms-enum": { + "name": "DefaultAction", + "modelAsString": true + }, + "default": "Deny" + }, + "applyToBuiltInEventHubEndpoint": { + "type": "boolean", + "description": "If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub" + }, + "ipRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkRuleSetIpRule" + }, + "description": "List of IP Rules" + } + }, + "required": [ + "applyToBuiltInEventHubEndpoint", + "ipRules" + ] + }, + "NetworkRuleSetIpRule": { + "description": "IP Rule to be applied as part of Network Rule Set", + "type": "object", + "properties": { + "filterName": { + "type": "string", + "description": "Name of the IP filter rule." + }, + "action": { + "type": "string", + "description": "IP Filter Action", + "enum": [ + "Allow" + ], + "x-ms-enum": { + "name": "NetworkRuleIPAction", + "modelAsString": true + }, + "default": "Allow" + }, + "ipMask": { + "type": "string", + "description": "A string that contains the IP address range in CIDR notation for the rule." + } + }, + "required": [ + "filterName", + "ipMask" + ] + }, + "PrivateLinkResources": { + "description": "The available private link resources for an IotHub", + "type": "object", + "properties": { + "value": { + "description": "The list of available private link resources for an IotHub", + "type": "array", + "items": { + "$ref": "#/definitions/GroupIdInformation" + } + } + } + }, + "GroupIdInformation": { + "description": "The group information for creating a private endpoint on an IotHub", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "$ref": "#/definitions/GroupIdInformationProperties" + } + }, + "required": [ + "properties" + ] + }, + "GroupIdInformationProperties": { + "description": "The properties for a group information object", + "type": "object", + "properties": { + "groupId": { + "type": "string", + "description": "The group id" + }, + "requiredMembers": { + "description": "The required members for a specific group id", + "type": "array", + "items": { + "type": "string" + } + }, + "requiredZoneNames": { + "description": "The required DNS zones for a specific group id", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PrivateEndpointConnectionsList": { + "description": "The list of private endpoint connections for an IotHub", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "PrivateEndpointConnection": { + "description": "The private endpoint connection of an IotHub", + "x-ms-azure-resource": true, + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties" + } + }, + "required": [ + "properties" + ] + }, + "PrivateEndpointConnectionProperties": { + "description": "The properties of a private endpoint connection", + "type": "object", + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState" + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpoint": { + "description": "The private endpoint property of a private endpoint connection", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "The current state of a private endpoint connection", + "type": "object", + "properties": { + "status": { + "description": "The status of a private endpoint connection", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateLinkServiceConnectionStatus", + "modelAsString": true + } + }, + "description": { + "type": "string", + "description": "The description for the current state of a private endpoint connection" + }, + "actionsRequired": { + "type": "string", + "description": "Actions required for a private endpoint connection" + } + }, + "required": [ + "status", + "description" + ] + }, + "FeedbackProperties": { + "description": "The properties of the feedback queue for cloud-to-device messages.", + "type": "object", + "properties": { + "lockDurationAsIso8601": { + "description": "The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.", + "type": "string", + "format": "duration" + }, + "ttlAsIso8601": { + "description": "The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.", + "type": "string", + "format": "duration" + }, + "maxDeliveryCount": { + "description": "The number of times the IoT hub attempts to deliver a message on the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.", + "format": "int32", + "type": "integer", + "minimum": 1, + "maximum": 100 + } + } + }, + "RoutingProperties": { + "description": "The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging", + "type": "object", + "properties": { + "endpoints": { + "$ref": "#/definitions/RoutingEndpoints" + }, + "routes": { + "description": "The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.", + "type": "array", + "items": { + "$ref": "#/definitions/RouteProperties" + } + }, + "fallbackRoute": { + "description": "The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint.", + "$ref": "#/definitions/FallbackRouteProperties" + }, + "enrichments": { + "description": "The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid", + "type": "array", + "items": { + "$ref": "#/definitions/EnrichmentProperties" + } + } + } + }, + "RoutingEndpoints": { + "description": "The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs.", + "type": "object", + "properties": { + "serviceBusQueues": { + "description": "The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.", + "type": "array", + "items": { + "$ref": "#/definitions/RoutingServiceBusQueueEndpointProperties" + } + }, + "serviceBusTopics": { + "description": "The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.", + "type": "array", + "items": { + "$ref": "#/definitions/RoutingServiceBusTopicEndpointProperties" + } + }, + "eventHubs": { + "description": "The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/RoutingEventHubProperties" + } + }, + "storageContainers": { + "description": "The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.", + "type": "array", + "items": { + "$ref": "#/definitions/RoutingStorageContainerProperties" + } + } + } + }, + "RoutingServiceBusQueueEndpointProperties": { + "description": "The properties related to service bus queue endpoint types.", + "type": "object", + "properties": { + "id": { + "description": "Id of the service bus queue endpoint", + "type": "string" + }, + "connectionString": { + "description": "The connection string of the service bus queue endpoint.", + "type": "string" + }, + "endpointUri": { + "description": "The url of the service bus queue endpoint. It must include the protocol sb://", + "type": "string" + }, + "entityPath": { + "description": "Queue name on the service bus namespace", + "type": "string" + }, + "authenticationType": { + "description": "Method used to authenticate against the service bus queue endpoint", + "enum": [ + "keyBased", + "identityBased" + ], + "type": "string", + "x-ms-enum": { + "name": "authenticationType", + "modelAsString": true + } + }, + "identity": { + "description": "Managed identity properties of routing service bus queue endpoint.", + "$ref": "#/definitions/ManagedIdentity" + }, + "name": { + "description": "The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name.", + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$" + }, + "subscriptionId": { + "description": "The subscription identifier of the service bus queue endpoint.", + "type": "string" + }, + "resourceGroup": { + "description": "The name of the resource group of the service bus queue endpoint.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "RoutingServiceBusTopicEndpointProperties": { + "description": "The properties related to service bus topic endpoint types.", + "type": "object", + "properties": { + "id": { + "description": "Id of the service bus topic endpoint", + "type": "string" + }, + "connectionString": { + "description": "The connection string of the service bus topic endpoint.", + "type": "string" + }, + "endpointUri": { + "description": "The url of the service bus topic endpoint. It must include the protocol sb://", + "type": "string" + }, + "entityPath": { + "description": "Queue name on the service bus topic", + "type": "string" + }, + "authenticationType": { + "description": "Method used to authenticate against the service bus topic endpoint", + "enum": [ + "keyBased", + "identityBased" + ], + "type": "string", + "x-ms-enum": { + "name": "authenticationType", + "modelAsString": true + } + }, + "identity": { + "description": "Managed identity properties of routing service bus topic endpoint.", + "$ref": "#/definitions/ManagedIdentity" + }, + "name": { + "description": "The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name.", + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$" + }, + "subscriptionId": { + "description": "The subscription identifier of the service bus topic endpoint.", + "type": "string" + }, + "resourceGroup": { + "description": "The name of the resource group of the service bus topic endpoint.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "RoutingEventHubProperties": { + "description": "The properties related to an event hub endpoint.", + "type": "object", + "properties": { + "id": { + "description": "Id of the event hub endpoint", + "type": "string" + }, + "connectionString": { + "description": "The connection string of the event hub endpoint. ", + "type": "string" + }, + "endpointUri": { + "description": "The url of the event hub endpoint. It must include the protocol sb://", + "type": "string" + }, + "entityPath": { + "description": "Event hub name on the event hub namespace", + "type": "string" + }, + "authenticationType": { + "description": "Method used to authenticate against the event hub endpoint", + "enum": [ + "keyBased", + "identityBased" + ], + "type": "string", + "x-ms-enum": { + "name": "authenticationType", + "modelAsString": true + } + }, + "identity": { + "description": "Managed identity properties of routing event hub endpoint.", + "$ref": "#/definitions/ManagedIdentity" + }, + "name": { + "description": "The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.", + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$" + }, + "subscriptionId": { + "description": "The subscription identifier of the event hub endpoint.", + "type": "string" + }, + "resourceGroup": { + "description": "The name of the resource group of the event hub endpoint.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "RoutingStorageContainerProperties": { + "description": "The properties related to a storage container endpoint.", + "type": "object", + "properties": { + "id": { + "description": "Id of the storage container endpoint", + "type": "string" + }, + "connectionString": { + "description": "The connection string of the storage account.", + "type": "string" + }, + "endpointUri": { + "description": "The url of the storage endpoint. It must include the protocol https://", + "type": "string" + }, + "authenticationType": { + "description": "Method used to authenticate against the storage endpoint", + "enum": [ + "keyBased", + "identityBased" + ], + "type": "string", + "x-ms-enum": { + "name": "authenticationType", + "modelAsString": true + } + }, + "identity": { + "description": "Managed identity properties of routing storage endpoint.", + "$ref": "#/definitions/ManagedIdentity" + }, + "name": { + "description": "The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.", + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$" + }, + "subscriptionId": { + "description": "The subscription identifier of the storage account.", + "type": "string" + }, + "resourceGroup": { + "description": "The name of the resource group of the storage account.", + "type": "string" + }, + "containerName": { + "description": "The name of storage container in the storage account.", + "type": "string" + }, + "fileNameFormat": { + "description": "File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.", + "type": "string" + }, + "batchFrequencyInSeconds": { + "description": "Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.", + "format": "int32", + "type": "integer", + "maximum": 720, + "minimum": 60 + }, + "maxChunkSizeInBytes": { + "description": "Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).", + "format": "int32", + "type": "integer", + "maximum": 524288000, + "minimum": 10485760 + }, + "encoding": { + "description": "Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'.", + "type": "string", + "enum": [ + "Avro", + "AvroDeflate", + "JSON" + ] + } + }, + "required": [ + "name", + "containerName" + ] + }, + "RouteProperties": { + "description": "The properties of a routing rule that your IoT hub uses to route messages to endpoints.", + "type": "object", + "properties": { + "name": { + "description": "The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.", + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$" + }, + "source": { + "description": "The source that the routing rule is to be applied to, such as DeviceMessages.", + "enum": [ + "Invalid", + "DeviceMessages", + "TwinChangeEvents", + "DeviceLifecycleEvents", + "DeviceJobLifecycleEvents", + "DeviceConnectionStateEvents" + ], + "type": "string", + "x-ms-enum": { + "name": "RoutingSource", + "modelAsString": true + } + }, + "condition": { + "description": "The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language", + "type": "string" + }, + "endpointNames": { + "description": "The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.", + "minItems": 1, + "maxItems": 1, + "type": "array", + "items": { + "type": "string" + } + }, + "isEnabled": { + "description": "Used to specify whether a route is enabled.", + "type": "boolean" + } + }, + "required": [ + "name", + "endpointNames", + "source", + "isEnabled" + ] + }, + "FallbackRouteProperties": { + "description": "The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.", + "type": "object", + "properties": { + "name": { + "description": "The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.", + "type": "string" + }, + "source": { + "description": "The source to which the routing rule is to be applied to. For example, DeviceMessages", + "enum": [ + "DeviceMessages" + ], + "type": "string", + "x-ms-enum": { + "name": "RoutingSource", + "modelAsString": true + } + }, + "condition": { + "description": "The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language", + "type": "string" + }, + "endpointNames": { + "description": "The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.", + "minItems": 1, + "maxItems": 1, + "type": "array", + "items": { + "type": "string" + } + }, + "isEnabled": { + "description": "Used to specify whether the fallback route is enabled.", + "type": "boolean" + } + }, + "required": [ + "endpointNames", + "source", + "isEnabled" + ] + }, + "EnrichmentProperties": { + "description": "The properties of an enrichment that your IoT hub applies to messages delivered to endpoints.", + "type": "object", + "properties": { + "key": { + "description": "The key or name for the enrichment property.", + "type": "string" + }, + "value": { + "description": "The value for the enrichment property.", + "type": "string" + }, + "endpointNames": { + "description": "The list of endpoints for which the enrichment is applied to the message.", + "minItems": 1, + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "key", + "value", + "endpointNames" + ] + }, + "IotHubDescription": { + "description": "The description of the IoT hub.", + "type": "object", + "properties": { + "etag": { + "description": "The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.", + "type": "string" + }, + "properties": { + "description": "IotHub properties", + "$ref": "#/definitions/IotHubProperties" + }, + "sku": { + "description": "IotHub SKU info", + "$ref": "#/definitions/IotHubSkuInfo" + }, + "identity": { + "description": "The managed identities for the IotHub.", + "$ref": "#/definitions/ArmIdentity" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "sku" + ] + }, + "Resource": { + "description": "The common properties of an Azure resource.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name.", + "pattern": "^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "location": { + "type": "string", + "description": "The resource location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + } + }, + "x-ms-azure-resource": true, + "required": [ + "location" + ] + }, + "SharedAccessSignatureAuthorizationRuleListResult": { + "description": "The list of shared access policies with a next link.", + "type": "object", + "properties": { + "value": { + "description": "The list of shared access policies.", + "type": "array", + "items": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRule" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "OperationListResult": { + "description": "Result of the request to list IoT Hub operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "List of IoT Hub operations supported by the Microsoft.Devices resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "IoT Hub REST API operation", + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Operation name: {provider}/{resource}/{read | write | action | delete}" + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "readOnly": true, + "type": "string", + "description": "Service provider: Microsoft Devices" + }, + "resource": { + "readOnly": true, + "type": "string", + "description": "Resource Type: IotHubs" + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "Name of the operation" + }, + "description": { + "readOnly": true, + "type": "string", + "description": "Description of the operation" + } + } + } + } + }, + "ErrorDetails": { + "description": "Error details.", + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "httpStatusCode": { + "description": "The HTTP status code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "The error details.", + "type": "string", + "readOnly": true + } + } + }, + "IotHubQuotaMetricInfoListResult": { + "description": "The JSON-serialized array of IotHubQuotaMetricInfo objects with a next link.", + "type": "object", + "properties": { + "value": { + "description": "The array of quota metrics objects.", + "type": "array", + "items": { + "$ref": "#/definitions/IotHubQuotaMetricInfo" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "EndpointHealthDataListResult": { + "description": "The JSON-serialized array of EndpointHealthData objects with a next link.", + "type": "object", + "properties": { + "value": { + "description": "JSON-serialized array of Endpoint health data", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointHealthData" + } + }, + "nextLink": { + "description": "Link to more results", + "type": "string", + "readOnly": true + } + } + }, + "EndpointHealthData": { + "description": "The health data for an endpoint", + "type": "object", + "properties": { + "endpointId": { + "description": "Id of the endpoint", + "type": "string" + }, + "healthStatus": { + "description": "Health statuses have following meanings. The 'healthy' status shows that the endpoint is accepting messages as expected. The 'unhealthy' status shows that the endpoint is not accepting messages as expected and IoT Hub is retrying to send data to this endpoint. The status of an unhealthy endpoint will be updated to healthy when IoT Hub has established an eventually consistent state of health. The 'dead' status shows that the endpoint is not accepting messages, after IoT Hub retried sending messages for the retrial period. See IoT Hub metrics to identify errors and monitor issues with endpoints. The 'unknown' status shows that the IoT Hub has not established a connection with the endpoint. No messages have been delivered to or rejected from this endpoint", + "enum": [ + "unknown", + "healthy", + "degraded", + "unhealthy", + "dead" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointHealthStatus", + "modelAsString": true + } + }, + "lastKnownError": { + "description": "Last error obtained when a message failed to be delivered to iot hub", + "type": "string" + }, + "lastKnownErrorTime": { + "description": "Time at which the last known error occurred", + "type": "string", + "format": "date-time-rfc1123" + }, + "lastSuccessfulSendAttemptTime": { + "description": "Last time iot hub successfully sent a message to the endpoint", + "type": "string", + "format": "date-time-rfc1123" + }, + "lastSendAttemptTime": { + "description": "Last time iot hub tried to send a message to the endpoint", + "type": "string", + "format": "date-time-rfc1123" + } + } + }, + "RegistryStatistics": { + "description": "Identity registry statistics.", + "type": "object", + "properties": { + "totalDeviceCount": { + "format": "int64", + "description": "The total count of devices in the identity registry.", + "type": "integer", + "readOnly": true + }, + "enabledDeviceCount": { + "format": "int64", + "description": "The count of enabled devices in the identity registry.", + "type": "integer", + "readOnly": true + }, + "disabledDeviceCount": { + "format": "int64", + "description": "The count of disabled devices in the identity registry.", + "type": "integer", + "readOnly": true + } + } + }, + "JobResponseListResult": { + "description": "The JSON-serialized array of JobResponse objects with a next link.", + "type": "object", + "properties": { + "value": { + "description": "The array of JobResponse objects.", + "type": "array", + "items": { + "$ref": "#/definitions/JobResponse" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "IotHubSkuDescription": { + "description": "SKU properties.", + "type": "object", + "properties": { + "resourceType": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "sku": { + "description": "The type of the resource.", + "$ref": "#/definitions/IotHubSkuInfo" + }, + "capacity": { + "description": "IotHub capacity", + "$ref": "#/definitions/IotHubCapacity" + } + }, + "required": [ + "sku", + "capacity" + ] + }, + "TagsResource": { + "properties": { + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "description": "A container holding only the Tags for a resource, allowing the user to update the tags on an IoT Hub instance." + }, + "IotHubCapacity": { + "description": "IoT Hub capacity information.", + "type": "object", + "properties": { + "minimum": { + "format": "int64", + "description": "The minimum number of units.", + "type": "integer", + "minimum": 1, + "maximum": 1, + "readOnly": true + }, + "maximum": { + "format": "int64", + "description": "The maximum number of units.", + "type": "integer", + "readOnly": true + }, + "default": { + "format": "int64", + "description": "The default number of units.", + "type": "integer", + "readOnly": true + }, + "scaleType": { + "description": "The type of the scaling enabled.", + "enum": [ + "Automatic", + "Manual", + "None" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "name": "IotHubScaleType", + "modelAsString": false + } + } + } + }, + "EventHubConsumerGroupsListResult": { + "description": "The JSON-serialized array of Event Hub-compatible consumer group names with a next link.", + "type": "object", + "properties": { + "value": { + "description": "List of consumer groups objects", + "type": "array", + "items": { + "$ref": "#/definitions/EventHubConsumerGroupInfo" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "EventHubConsumerGroupBodyDescription": { + "description": "The EventHub consumer group.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/EventHubConsumerGroupName" + } + }, + "required": [ + "properties" + ] + }, + "EventHubConsumerGroupName": { + "description": "The EventHub consumer group name.", + "type": "object", + "properties": { + "name": { + "description": "EventHub consumer group name", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "EventHubConsumerGroupInfo": { + "description": "The properties of the EventHubConsumerGroupInfo object.", + "x-ms-azure-resource": true, + "type": "object", + "properties": { + "properties": { + "description": "The tags.", + "type": "object", + "additionalProperties": {} + }, + "id": { + "description": "The Event Hub-compatible consumer group identifier.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The Event Hub-compatible consumer group name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "the resource type.", + "type": "string", + "readOnly": true + }, + "etag": { + "description": "The etag.", + "type": "string", + "readOnly": true + } + } + }, + "IotHubSkuDescriptionListResult": { + "description": "The JSON-serialized array of IotHubSkuDescription objects with a next link.", + "type": "object", + "properties": { + "value": { + "description": "The array of IotHubSkuDescription.", + "type": "array", + "items": { + "$ref": "#/definitions/IotHubSkuDescription" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "JobResponse": { + "description": "The properties of the Job Response object.", + "type": "object", + "properties": { + "jobId": { + "description": "The job identifier.", + "type": "string", + "readOnly": true + }, + "startTimeUtc": { + "format": "date-time-rfc1123", + "description": "The start time of the job.", + "type": "string", + "readOnly": true + }, + "endTimeUtc": { + "format": "date-time-rfc1123", + "description": "The time the job stopped processing.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the job.", + "enum": [ + "unknown", + "export", + "import", + "backup", + "readDeviceProperties", + "writeDeviceProperties", + "updateDeviceConfiguration", + "rebootDevice", + "factoryResetDevice", + "firmwareUpdate" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobType", + "modelAsString": true + } + }, + "status": { + "description": "The status of the job.", + "enum": [ + "unknown", + "enqueued", + "running", + "completed", + "failed", + "cancelled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": false + } + }, + "failureReason": { + "description": "If status == failed, this string containing the reason for the failure.", + "type": "string", + "readOnly": true + }, + "statusMessage": { + "description": "The status message for the job.", + "type": "string", + "readOnly": true + }, + "parentJobId": { + "description": "The job identifier of the parent job, if any.", + "type": "string", + "readOnly": true + } + } + }, + "IotHubDescriptionListResult": { + "description": "The JSON-serialized array of IotHubDescription objects with a next link.", + "type": "object", + "properties": { + "value": { + "description": "The array of IotHubDescription objects.", + "type": "array", + "items": { + "$ref": "#/definitions/IotHubDescription" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "IotHubQuotaMetricInfo": { + "description": "Quota metrics properties.", + "type": "object", + "properties": { + "name": { + "description": "The name of the quota metric.", + "type": "string", + "readOnly": true + }, + "currentValue": { + "format": "int64", + "description": "The current value for the quota metric.", + "type": "integer", + "readOnly": true + }, + "maxValue": { + "format": "int64", + "description": "The maximum value of the quota metric.", + "type": "integer", + "readOnly": true + } + } + }, + "OperationInputs": { + "description": "Input values.", + "type": "object", + "properties": { + "name": { + "description": "The name of the IoT hub to check.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "IotHubNameAvailabilityInfo": { + "description": "The properties indicating whether a given IoT hub name is available.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "The value which indicates whether the provided name is available.", + "type": "boolean", + "readOnly": true + }, + "reason": { + "description": "The reason for unavailability.", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "IotHubNameUnavailabilityReason", + "modelAsString": false + } + }, + "message": { + "description": "The detailed reason message.", + "type": "string" + } + } + }, + "UserSubscriptionQuotaListResult": { + "type": "object", + "description": "Json-serialized array of User subscription quota response", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/UserSubscriptionQuota" + } + }, + "nextLink": { + "type": "string", + "readOnly": true + } + } + }, + "UserSubscriptionQuota": { + "description": "User subscription quota response", + "type": "object", + "properties": { + "id": { + "description": "IotHub type id", + "type": "string" + }, + "type": { + "description": "Response type", + "type": "string" + }, + "unit": { + "description": "Unit of IotHub type", + "type": "string" + }, + "currentValue": { + "description": "Current number of IotHub type", + "format": "int32", + "type": "integer" + }, + "limit": { + "description": "Numerical limit on IotHub type", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "IotHub type", + "$ref": "#/definitions/Name" + } + } + }, + "Name": { + "description": "Name of Iot Hub type", + "type": "object", + "properties": { + "value": { + "description": "IotHub type", + "type": "string" + }, + "localizedValue": { + "description": "Localized value of name", + "type": "string" + } + } + }, + "TestAllRoutesInput": { + "description": "Input for testing all routes", + "type": "object", + "properties": { + "routingSource": { + "description": "Routing source", + "enum": [ + "Invalid", + "DeviceMessages", + "TwinChangeEvents", + "DeviceLifecycleEvents", + "DeviceJobLifecycleEvents", + "DeviceConnectionStateEvents" + ], + "type": "string", + "x-ms-enum": { + "name": "RoutingSource", + "modelAsString": true + } + }, + "message": { + "description": "Routing message", + "$ref": "#/definitions/RoutingMessage" + }, + "twin": { + "description": "Routing Twin Reference", + "$ref": "#/definitions/RoutingTwin" + } + } + }, + "RoutingTwin": { + "description": "Twin reference input parameter. This is an optional parameter", + "type": "object", + "properties": { + "tags": { + "description": "Twin Tags", + "type": "object" + }, + "properties": { + "properties": { + "desired": { + "description": "Twin desired properties", + "type": "object" + }, + "reported": { + "description": "Twin desired properties", + "type": "object" + } + } + } + } + }, + "RoutingMessage": { + "description": "Routing message", + "type": "object", + "properties": { + "body": { + "description": "Body of routing message", + "type": "string" + }, + "appProperties": { + "description": "App properties", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "systemProperties": { + "description": "System properties", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "TestAllRoutesResult": { + "description": "Result of testing all routes", + "type": "object", + "properties": { + "routes": { + "description": "JSON-serialized array of matched routes", + "type": "array", + "items": { + "$ref": "#/definitions/MatchedRoute" + } + } + } + }, + "MatchedRoute": { + "description": "Routes that matched", + "type": "object", + "properties": { + "properties": { + "description": "Properties of routes that matched", + "$ref": "#/definitions/RouteProperties" + } + } + }, + "TestRouteInput": { + "required": [ + "route" + ], + "description": "Input for testing route", + "type": "object", + "properties": { + "message": { + "description": "Routing message", + "$ref": "#/definitions/RoutingMessage" + }, + "route": { + "description": "Route properties", + "$ref": "#/definitions/RouteProperties" + }, + "twin": { + "description": "Routing Twin Reference", + "$ref": "#/definitions/RoutingTwin" + } + } + }, + "TestRouteResult": { + "description": "Result of testing one route", + "type": "object", + "properties": { + "result": { + "description": "Result of testing route", + "enum": [ + "undefined", + "false", + "true" + ], + "type": "string", + "x-ms-enum": { + "name": "TestResultStatus", + "modelAsString": true + } + }, + "details": { + "description": "Detailed result of testing route", + "$ref": "#/definitions/TestRouteResultDetails" + } + } + }, + "TestRouteResultDetails": { + "description": "Detailed result of testing a route", + "type": "object", + "properties": { + "compilationErrors": { + "description": "JSON-serialized list of route compilation errors", + "type": "array", + "items": { + "$ref": "#/definitions/RouteCompilationError" + } + } + } + }, + "RouteCompilationError": { + "description": "Compilation error when evaluating route", + "type": "object", + "properties": { + "message": { + "description": "Route error message", + "type": "string" + }, + "severity": { + "description": "Severity of the route error", + "enum": [ + "error", + "warning" + ], + "type": "string", + "x-ms-enum": { + "name": "RouteErrorSeverity", + "modelAsString": true + } + }, + "location": { + "description": "Location where the route error happened", + "$ref": "#/definitions/RouteErrorRange" + } + } + }, + "RouteErrorRange": { + "description": "Range of route errors", + "type": "object", + "properties": { + "start": { + "description": "Start where the route error happened", + "$ref": "#/definitions/RouteErrorPosition" + }, + "end": { + "description": "End where the route error happened", + "$ref": "#/definitions/RouteErrorPosition" + } + } + }, + "RouteErrorPosition": { + "description": "Position where the route error happened", + "type": "object", + "properties": { + "line": { + "description": "Line where the route error happened", + "format": "int32", + "type": "integer" + }, + "column": { + "description": "Column where the route error happened", + "format": "int32", + "type": "integer" + } + } + }, + "ExportDevicesRequest": { + "description": "Use to provide parameters when requesting an export of all devices in the IoT hub.", + "type": "object", + "properties": { + "exportBlobContainerUri": { + "description": "The export blob container URI.", + "type": "string" + }, + "excludeKeys": { + "description": "The value indicating whether keys should be excluded during export.", + "type": "boolean" + }, + "exportBlobName": { + "description": "The name of the blob that will be created in the provided output blob container. This blob will contain the exported device registry information for the IoT Hub.", + "type": "string" + }, + "authenticationType": { + "description": "Specifies authentication type being used for connecting to the storage account.", + "enum": [ + "keyBased", + "identityBased" + ], + "type": "string", + "x-ms-enum": { + "name": "AuthenticationType", + "modelAsString": true + } + }, + "identity": { + "description": "Managed identity properties of storage endpoint for export devices.", + "$ref": "#/definitions/ManagedIdentity" + }, + "includeConfigurations": { + "description": "The value indicating whether configurations should be exported.", + "type": "boolean" + }, + "configurationsBlobName": { + "description": "The name of the blob that will be created in the provided output blob container. This blob will contain the exported configurations for the Iot Hub.", + "type": "string" + } + }, + "required": [ + "exportBlobContainerUri", + "excludeKeys" + ] + }, + "ImportDevicesRequest": { + "description": "Use to provide parameters when requesting an import of all devices in the hub.", + "type": "object", + "properties": { + "inputBlobContainerUri": { + "description": "The input blob container URI.", + "type": "string" + }, + "outputBlobContainerUri": { + "description": "The output blob container URI.", + "type": "string" + }, + "inputBlobName": { + "description": "The blob name to be used when importing from the provided input blob container.", + "type": "string" + }, + "outputBlobName": { + "description": "The blob name to use for storing the status of the import job.", + "type": "string" + }, + "authenticationType": { + "description": "Specifies authentication type being used for connecting to the storage account.", + "enum": [ + "keyBased", + "identityBased" + ], + "type": "string", + "x-ms-enum": { + "name": "AuthenticationType", + "modelAsString": true + } + }, + "identity": { + "description": "Managed identity properties of storage endpoint for import devices.", + "$ref": "#/definitions/ManagedIdentity" + }, + "includeConfigurations": { + "description": "The value indicating whether configurations should be imported.", + "type": "boolean" + }, + "configurationsBlobName": { + "description": "The blob name to be used when importing configurations from the provided input blob container.", + "type": "string" + } + }, + "required": [ + "inputBlobContainerUri", + "outputBlobContainerUri" + ] + }, + "FailoverInput": { + "description": "Use to provide failover region when requesting manual Failover for a hub.", + "type": "object", + "properties": { + "failoverRegion": { + "description": "Region the hub will be failed over to", + "type": "string" + } + }, + "required": [ + "failoverRegion" + ] + }, + "IotHubLocationDescription": { + "description": "Public representation of one of the locations where a resource is provisioned.", + "type": "object", + "properties": { + "location": { + "description": "The name of the Azure region", + "type": "string" + }, + "role": { + "description": "The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to.", + "enum": [ + "primary", + "secondary" + ], + "type": "string", + "x-ms-enum": { + "name": "IotHubReplicaRoleType", + "modelAsString": true + } + } + } + }, + "ArmIdentity": { + "type": "object", + "properties": { + "principalId": { + "description": "Principal Id", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "Tenant Id", + "type": "string", + "readOnly": true + }, + "type": { + "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.", + "type": "string", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ArmUserIdentity" + } + } + } + }, + "ArmUserIdentity": { + "type": "object", + "properties": { + "principalId": { + "type": "string", + "readOnly": true + }, + "clientId": { + "type": "string", + "readOnly": true + } + } + }, + "ManagedIdentity": { + "description": "The properties of the Managed identity.", + "type": "object", + "properties": { + "userAssignedIdentity": { + "type": "string", + "description": "The user assigned identity." + } + } + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription identifier.", + "required": true, + "type": "string" + }, + "api-version": { + "name": "api-version", + "in": "query", + "description": "The version of the API.", + "required": true, + "type": "string" + }, + "resourceGroupName": { + "name": "resourceGroupName", + "description": "The name of the resource group that contains the IoT hub.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceName": { + "name": "resourceName", + "in": "path", + "description": "The name of the IoT hub.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "certificateName": { + "name": "certificateName", + "in": "path", + "description": "The name of the certificate", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$", + "x-ms-parameter-location": "method" + }, + "groupId": { + "name": "groupId", + "in": "path", + "description": "The name of the private link resource", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "privateEndpointConnectionName": { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/iothub/resource-manager/readme.md b/specification/iothub/resource-manager/readme.md index f0ee9e72496d..1df4e18afad4 100644 --- a/specification/iothub/resource-manager/readme.md +++ b/specification/iothub/resource-manager/readme.md @@ -26,18 +26,36 @@ These are the global settings for the IotHub API. ``` yaml openapi-type: arm -tag: package-2021-03 +tag: package-2021-07 ``` +### Tag: package-2021-07 + +These settings apply only when `--tag=package-2021-07` is specified on the command line. + +```yaml $(tag) == 'package-2021-07' +input-file: + - Microsoft.Devices/stable/2021-07-01/iothub.json +``` +### Tag: package-preview-2021-07 + +These settings apply only when `--tag=package-preview-2021-07` is specified on the command line. + +``` yaml $(tag) == 'package-preview-2021-07' +input-file: + - Microsoft.Devices/preview/2021-07-01-preview/iothub.json +``` + ### Tag: package-2021-03 These settings apply only when `--tag=package-2021-03` is specified on the command line. -```yaml $(tag) == 'package-2021-03' +``` yaml $(tag) == 'package-2021-03' input-file: - Microsoft.Devices/stable/2021-03-31/iothub.json ``` + ### Tag: package-preview-2021-03 These settings apply only when `--tag=package-preview-2021-03` is specified on the command line. @@ -230,9 +248,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - after_scripts: - - python ./scripts/multiapi_init_gen.py azure-mgmt-iothub - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go @@ -269,5 +284,3 @@ See configuration in [readme.go.md](./readme.go.md) ## Java See configuration in [readme.java.md](./readme.go.md) - - diff --git a/specification/iothub/resource-manager/readme.python.md b/specification/iothub/resource-manager/readme.python.md index 52813f675475..cb21a2e16eff 100644 --- a/specification/iothub/resource-manager/readme.python.md +++ b/specification/iothub/resource-manager/readme.python.md @@ -4,24 +4,12 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.iothub - package-name: azure-mgmt-iothub - package-version: 0.8.2 - clear-output-folder: true - no-namespace-folders: true -``` - ``` yaml $(python) && $(track2) azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.iothub package-name: azure-mgmt-iothub -package-version: 0.8.2 +package-version: 1.0.0b1 clear-output-folder: true no-namespace-folders: true ``` @@ -30,23 +18,9 @@ no-namespace-folders: true Generate all API versions currently shipped for this package -```yaml $(python) && $(multiapi) && !$(track2) -batch: - - tag: package-2021-03 - - tag: package-preview-2021-03 - - tag: package-2020-03 - - tag: package-2019-11 - - tag: package-preview-2019-07 - - tag: package-2019-03 - - tag: package-2018-04 - - tag: package-2018-01 - - tag: package-2017-07 - - tag: package-2017-01 - - tag: package-2016-02 -``` - ```yaml $(python) && $(multiapi) && $(track2) batch: + - tag: package-2021-07 - tag: package-2021-03 - tag: package-preview-2021-03 - tag: package-2020-03 @@ -67,6 +41,16 @@ clear-output-folder: false perform-load: false ``` +### Tag: package-2021-07 and python + +These settings apply only when `--tag=package-2021-07 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2021-07' && $(python) +namespace: azure.mgmt.iothub.v2021_07_01 +output-folder: $(python-sdks-folder)/iothub/azure-mgmt-iothub/azure/mgmt/iothub/v2021_07_01 +``` + ### Tag: package-2021-03 and python These settings apply only when `--tag=package-2021-03 --python` is specified on the command line. @@ -75,9 +59,6 @@ Please also specify `--python-sdks-folder=`. -``` yaml $(typescript) && !$(profile) +``` yaml $(typescript) && !$(profile-content) typescript: azure-arm: true package-name: "@azure/arm-iothub" @@ -15,9 +15,9 @@ typescript: ### Profile: profile-hybrid-2020-09-01 -These settings apply only when `--profile=profile-hybrid-2020-09-01` is specified on the command line. +These settings apply only when `--profile-content=profile-hybrid-2020-09-01` is specified on the command line. -``` yaml $(profile)=='profile-hybrid-2020-09-01' +``` yaml $(profile-content)=='profile-hybrid-2020-09-01' typescript: package-name: "@azure/arm-iothub-profile-2020-09-01-hybrid" output-folder: "$(typescript-sdks-folder)/sdk/iothub/arm-iothub-profile-2020-09-01-hybrid" @@ -26,4 +26,4 @@ typescript: generate-metadata: true batch: - tag: profile-hybrid-2020-09-01 -``` \ No newline at end of file +``` diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/defenderSettings.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/defenderSettings.json index 44c03aeed500..e74810e5f41c 100644 --- a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/defenderSettings.json +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/defenderSettings.json @@ -312,13 +312,21 @@ "type": "string", "enum": [ "Default", - "MigratedToAzure" + "MigratedToAzure", + "Evaluation", + "Purchased" ], "description": "The kind of onboarding for the subscription", "x-ms-enum": { "name": "OnboardingKind", "modelAsString": true } + }, + "evaluationEndTime": { + "type": "string", + "format": "date-time", + "description": "End time of the evaluation period, if such exist", + "readOnly": true } }, "required": [ diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/devices.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/devices.json index 42c426802e0a..961fd2a64396 100644 --- a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/devices.json +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/devices.json @@ -643,6 +643,14 @@ "moduleAddress": { "type": "string", "description": "Firmware module address." + }, + "serial": { + "type": "string", + "description": "Firmware serial." + }, + "additionalFields": { + "type": "object", + "description": " A bag of fields which extends the firmware information." } } }, @@ -716,6 +724,7 @@ "OtSensor", "CorpSensor", "Mde", + "MicroAgent", "Other" ], "x-ms-enum": { diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/DefenderSettings/Get.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/DefenderSettings/Get.json index 1ba4a1396f7c..82bd85a5d93d 100644 --- a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/DefenderSettings/Get.json +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-02-01-preview/examples/DefenderSettings/Get.json @@ -14,7 +14,8 @@ "sentinelWorkspaceResourceIds": [ "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1" ], - "onboardingKind": "Default" + "onboardingKind": "Evaluation", + "evaluationEndTime": "2021-06-29T00:00:00.0000000Z" } } } diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/alertTypes.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/alertTypes.json new file mode 100644 index 000000000000..1b767d3ecda1 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/alertTypes.json @@ -0,0 +1,313 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Defender for IoT", + "description": "API spec for Microsoft.IoTSecurity (Azure Defender for IoT) resource provider", + "version": "2021-07-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTSecurity/alertTypes": { + "get": { + "x-ms-examples": { + "Get IoT Alert Types": { + "$ref": "./examples/AlertTypes/GetAlertTypeList.json" + } + }, + "tags": [ + "IoT Security Alert Types" + ], + "description": "List IoT alert types", + "operationId": "AlertTypes_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertTypeList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTSecurity/alertTypes/{alertTypeName}": { + "get": { + "x-ms-examples": { + "Get IoT Alert Type": { + "$ref": "./examples/AlertTypes/GetAlertType.json" + } + }, + "tags": [ + "IoT Security Alert Types" + ], + "operationId": "AlertTypes_Get", + "description": "Get IoT alert type", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "in": "path", + "name": "alertTypeName", + "required": true, + "type": "string", + "description": "Name of the alert type" + } + ], + "responses": { + "200": { + "description": "IoT alert type", + "schema": { + "$ref": "#/definitions/AlertType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "AlertTypeList": { + "type": "object", + "description": "List of alert types", + "properties": { + "value": { + "type": "array", + "description": "List data", + "items": { + "$ref": "#/definitions/AlertType" + } + } + } + }, + "AlertType": { + "type": "object", + "description": "IoT alert type.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Alert type properties", + "$ref": "#/definitions/AlertTypeProperties" + }, + "systemData": { + "readOnly": true, + "type": "object", + "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "AlertTypeProperties": { + "type": "object", + "description": "IoT alert type information.", + "properties": { + "alertDisplayName": { + "readOnly": true, + "type": "string", + "example": "Privileged container detected", + "description": "The display name of the alert" + }, + "severity": { + "readOnly": true, + "type": "string", + "example": "Medium", + "description": "The severity of the alert", + "enum": [ + "Informational", + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "alertSeverity", + "modelAsString": true, + "values": [ + { + "value": "Informational" + }, + { + "value": "Low" + }, + { + "value": "Medium" + }, + { + "value": "High" + } + ] + } + }, + "description": { + "readOnly": true, + "type": "string", + "description": "Description of the suspected vulnerability and meaning.", + "example": "Machine logs indicate that a privileged Docker container is running. A privileged container has full access to host resources. If compromised, a malicious actor can use the privileged container to gain access to the host machine." + }, + "providerName": { + "readOnly": true, + "type": "string", + "example": "IoTSecurity", + "description": "The name of the alert provider or internal partner" + }, + "productName": { + "readOnly": true, + "type": "string", + "example": "Azure Security Center for IoT", + "description": "The name of the product which published this alert" + }, + "productComponentName": { + "readOnly": true, + "type": "string", + "example": "IoT Hub", + "description": "The name of a component inside the product which generated the alert" + }, + "vendorName": { + "readOnly": true, + "type": "string", + "example": "Microsoft", + "description": "The name of the vendor that raise the alert" + }, + "intent": { + "readOnly": true, + "type": "string", + "example": "Exploitation,Execution", + "description": "Kill chain related intent behind the alert. Could contain multiple enum values (separated by commas)", + "enum": [ + "Unknown", + "PreAttack", + "InitialAccess", + "Persistence", + "PrivilegeEscalation", + "DefenseEvasion", + "CredentialAccess", + "Discovery", + "LateralMovement", + "Execution", + "Collection", + "Exfiltration", + "CommandAndControl", + "Impact", + "Probing", + "Exploitation" + ], + "x-ms-enum": { + "name": "alertIntent", + "modelAsString": true, + "values": [ + { + "value": "Unknown" + }, + { + "value": "PreAttack" + }, + { + "value": "InitialAccess" + }, + { + "value": "Persistence" + }, + { + "value": "PrivilegeEscalation" + }, + { + "value": "DefenseEvasion" + }, + { + "value": "CredentialAccess" + }, + { + "value": "Discovery" + }, + { + "value": "LateralMovement" + }, + { + "value": "Execution" + }, + { + "value": "Collection" + }, + { + "value": "Exfiltration" + }, + { + "value": "CommandAndControl" + }, + { + "value": "Impact" + }, + { + "value": "Probing" + }, + { + "value": "Exploitation" + } + ] + } + }, + "remediationSteps": { + "readOnly": true, + "description": "Manual action items to take to remediate the alert", + "type": "array", + "items": { + "type": "string", + "example": "If the container doesn't need to run in privileged mode, remove the privileges from the container." + } + } + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/alerts.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/alerts.json new file mode 100644 index 000000000000..ee6ef179e0a8 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/alerts.json @@ -0,0 +1,473 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Defender for IoT", + "description": "API spec for Microsoft.IoTSecurity (Azure Defender for IoT) resource provider", + "version": "2021-07-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTSecurity/locations/{iotDefenderLocation}/deviceGroups/{deviceGroupName}/alerts": { + "get": { + "x-ms-examples": { + "List IoT Alerts": { + "$ref": "./examples/Alerts/GetAlertList.json" + } + }, + "tags": [ + "IoT Security Alerts" + ], + "description": "List IoT alerts", + "operationId": "IotAlerts_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/IotDefenderLocation" + }, + { + "$ref": "#/parameters/DeviceGroupName" + }, + { + "in": "query", + "name": "$skipToken", + "required": false, + "type": "string", + "description": "Skip token used for pagination" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertListModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTSecurity/locations/{iotDefenderLocation}/deviceGroups/{deviceGroupName}/alerts/{alertId}": { + "get": { + "x-ms-examples": { + "Get IoT Alert": { + "$ref": "./examples/Alerts/GetAlert.json" + } + }, + "tags": [ + "IoT Security Alerts" + ], + "operationId": "IotAlerts_Get", + "description": "Get IoT alert", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/IotDefenderLocation" + }, + { + "$ref": "#/parameters/DeviceGroupName" + }, + { + "$ref": "#/parameters/AlertId" + } + ], + "responses": { + "200": { + "description": "IoT alert", + "schema": { + "$ref": "#/definitions/AlertModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "x-ms-examples": { + "Update IoT Alert": { + "$ref": "./examples/Alerts/PatchAlert.json" + } + }, + "tags": [ + "IoT Security Alerts" + ], + "operationId": "IotAlerts_Patch", + "description": "Update an existing alert", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/IotDefenderLocation" + }, + { + "$ref": "#/parameters/DeviceGroupName" + }, + { + "$ref": "#/parameters/AlertId" + }, + { + "$ref": "#/parameters/AlertPatchModel" + } + ], + "responses": { + "200": { + "description": "IoT alert", + "schema": { + "$ref": "#/definitions/AlertModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "AlertListModel": { + "description": "List of IoT alerts", + "type": "object", + "properties": { + "value": { + "description": "List data", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/AlertModel" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "When available, follow the URI to get the next page of data" + } + } + }, + "AlertModel": { + "type": "object", + "description": "IoT alert", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Alert properties", + "$ref": "#/definitions/AlertPropertiesModel" + }, + "systemData": { + "readOnly": true, + "type": "object", + "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "AlertSeverity": { + "type": "string", + "readOnly": false, + "description": "Alert Severity", + "enum": [ + "Informational", + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "alertSeverity", + "modelAsString": true + } + }, + "AlertStatus": { + "type": "string", + "readOnly": false, + "description": "Alert Status", + "enum": [ + "New", + "InProgress", + "Closed" + ], + "x-ms-enum": { + "name": "alertStatus", + "modelAsString": true, + "values": [ + { + "value": "New" + }, + { + "value": "InProgress" + }, + { + "value": "Closed" + } + ] + } + }, + "AlertPropertiesModel": { + "type": "object", + "description": "IoT alert properties", + "properties": { + "systemAlertId": { + "description": "Holds the product canonical identifier of the alert within the scope of a product", + "readOnly": true, + "type": "string", + "example": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8" + }, + "azureResourceId": { + "description": "Display name of the device entity being reported on", + "readOnly": true, + "type": "string", + "example": "device-1" + }, + "alertType": { + "description": "The type name of the alert", + "readOnly": true, + "type": "string", + "example": "IoT_PrivilegedContainer" + }, + "startTimeUtc": { + "description": "The impact start time of the alert (the time of the first event or activity included in the alert)", + "readOnly": true, + "type": "string", + "example": "2020-05-13T06:32:25Z" + }, + "endTimeUtc": { + "description": "The impact end time of the alert (the time of the last event or activity included in the alert)", + "readOnly": true, + "type": "string", + "example": "2020-05-13T06:32:25Z" + }, + "entities": { + "description": "A list of entities related to the alert", + "type": "array", + "items": { + "type": "object" + }, + "example": [ + { + "$id": "1", + "CommandLine": "docker run --privileged", + "Type": "process" + } + ] + }, + "extendedProperties": { + "type": "object", + "description": "A bag of fields which extends the alert information", + "example": { + "CommandLine": "docker run --privileged", + "User Name": "aUser", + "UserId": "", + "ParentProcessId": 1593, + "DeviceId": "device-1" + } + }, + "severity": { + "type": "string", + "example": "Medium", + "$ref": "#/definitions/AlertSeverity", + "description": "The severity of the alert" + }, + "intent": { + "readOnly": true, + "type": "string", + "example": "Exploitation,Execution", + "description": "Kill chain related intent behind the alert. Could contain multiple enum values (separated by commas)", + "enum": [ + "Unknown", + "PreAttack", + "InitialAccess", + "Persistence", + "PrivilegeEscalation", + "DefenseEvasion", + "CredentialAccess", + "Discovery", + "LateralMovement", + "Execution", + "Collection", + "Exfiltration", + "CommandAndControl", + "Impact", + "Probing", + "Exploitation" + ], + "x-ms-enum": { + "name": "alertIntent", + "modelAsString": true, + "values": [ + { + "value": "Unknown" + }, + { + "value": "PreAttack" + }, + { + "value": "InitialAccess" + }, + { + "value": "Persistence" + }, + { + "value": "PrivilegeEscalation" + }, + { + "value": "DefenseEvasion" + }, + { + "value": "CredentialAccess" + }, + { + "value": "Discovery" + }, + { + "value": "LateralMovement" + }, + { + "value": "Execution" + }, + { + "value": "Collection" + }, + { + "value": "Exfiltration" + }, + { + "value": "CommandAndControl" + }, + { + "value": "Impact" + }, + { + "value": "Probing" + }, + { + "value": "Exploitation" + } + ] + } + }, + "productComponentName": { + "readOnly": true, + "type": "string", + "example": "IoT Hub", + "description": "The name of a component inside the product which generated the alert" + }, + "status": { + "type": "string", + "example": "New", + "description": "The status of the alert", + "$ref": "#/definitions/AlertStatus" + } + } + }, + "AlertPatchPropertiesModel": { + "type": "object", + "description": "IoT alert properties", + "properties": { + "properties": { + "type": "object", + "description": "IoT alert properties", + "properties": { + "severity": { + "type": "string", + "example": "Medium", + "description": "The severity of the alert", + "$ref": "#/definitions/AlertSeverity" + }, + "status": { + "type": "string", + "example": "New", + "description": "The status of the alert", + "$ref": "#/definitions/AlertStatus" + } + } + } + } + } + }, + "parameters": { + "DeviceGroupName": { + "name": "deviceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Device group name", + "x-ms-parameter-location": "method" + }, + "AlertId": { + "name": "alertId", + "in": "path", + "required": true, + "description": "Alert Id", + "type": "string", + "x-ms-parameter-location": "method" + }, + "AlertPatchModel": { + "name": "alertPatchModel", + "in": "body", + "required": true, + "description": "IoT alert", + "schema": { + "$ref": "#/definitions/AlertPatchPropertiesModel" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/AlertTypes/GetAlertType.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/AlertTypes/GetAlertType.json new file mode 100644 index 000000000000..847067ecf311 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/AlertTypes/GetAlertType.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "alertTypeName": "IoT_PrivilegedContainer" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/alertTypes/IoT_PrivilegedContainer", + "name": "IoT_PrivilegedContainer", + "type": "Microsoft.IoTSecurity/alertTypes", + "properties": { + "alertDisplayName": "Privileged container detected", + "severity": "Medium", + "description": "Machine logs indicate that a privileged Docker container is running. A privileged container has full access to host resources. If compromised, a malicious actor can use the privileged container to gain access to the host machine.", + "providerName": "IoTSecurity", + "remediationSteps": [ + "If the container doesn't need to run in privileged mode, remove the privileges from the container." + ], + "intent": "Exploitation,Execution", + "vendorName": "Microsoft", + "productName": "Azure Defender for IoT", + "productComponentName": "IoT Hub" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/AlertTypes/GetAlertTypeList.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/AlertTypes/GetAlertTypeList.json new file mode 100644 index 000000000000..fc74b6951499 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/AlertTypes/GetAlertTypeList.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/alertTypes", + "name": "IoT_PrivilegedContainer", + "type": "Microsoft.IoTSecurity/alertTypes", + "properties": { + "alertDisplayName": "Privileged container detected", + "severity": "Medium", + "description": "Machine logs indicate that a privileged Docker container is running. A privileged container has full access to host resources. If compromised, a malicious actor can use the privileged container to gain access to the host machine.", + "providerName": "IoTSecurity", + "remediationSteps": [ + "If the container doesn't need to run in privileged mode, remove the privileges from the container." + ], + "intent": "Exploitation,Execution", + "vendorName": "Microsoft", + "productName": "Azure Defender for IoT", + "productComponentName": "IoT Hub" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + ] + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/Alerts/GetAlert.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/Alerts/GetAlert.json new file mode 100644 index 000000000000..cff658f59a40 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/Alerts/GetAlert.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "iotDefenderLocation": "eastus", + "deviceGroupName": "default", + "alertId": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus/deviceGroups/default/alerts/903e76ff-17eb-4bac-ac8a-2bc31ab68fd8", + "name": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8", + "type": "Microsoft.IoTSecurity/alerts", + "properties": { + "systemAlertId": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8", + "azureResourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus/deviceGroups/default/devices/device-1", + "alertType": "IoT_PrivilegedContainer", + "startTimeUtc": "2020-05-13T06:32:25Z", + "endTimeUtc": "2020-05-13T06:32:25Z", + "entities": [ + { + "$id": "1", + "CommandLine": "docker run --privileged", + "Type": "process" + } + ], + "extendedProperties": { + "CommandLine": "docker run --privileged", + "User Name": "aUser", + "UserId": "", + "ParentProcessId": 1593, + "DeviceId": "device-1" + }, + "severity": "Medium", + "intent": "PreAttack", + "productComponentName": "IoT Hub", + "status": "New" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/Alerts/GetAlertList.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/Alerts/GetAlertList.json new file mode 100644 index 000000000000..a9661c519cf2 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/Alerts/GetAlertList.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "iotDefenderLocation": "eastus", + "deviceGroupName": "default" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus/deviceGroups/default/alerts/903e76ff-17eb-4bac-ac8a-2bc31ab68fd8", + "name": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8", + "type": "Microsoft.IoTSecurity/alerts", + "properties": { + "systemAlertId": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8", + "azureResourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus/deviceGroups/default/devices/device-1", + "alertType": "IoT_PrivilegedContainer", + "startTimeUtc": "2020-05-13T06:32:25Z", + "endTimeUtc": "2020-05-13T06:32:25Z", + "entities": [ + { + "$id": "1", + "CommandLine": "docker run --privileged", + "Type": "process" + } + ], + "extendedProperties": { + "CommandLine": "docker run --privileged", + "User Name": "aUser", + "UserId": "", + "ParentProcessId": 1593, + "DeviceId": "device-1" + }, + "severity": "Medium", + "intent": "PreAttack", + "productComponentName": "IoT Hub", + "status": "New" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus/deviceGroups/default/alerts?api-version=2021-07-01-preview&$skipToken=903e76ff-17eb-4bac-ac8a-2bc31ab68fd8" + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/Alerts/PatchAlert.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/Alerts/PatchAlert.json new file mode 100644 index 000000000000..2d4a8c648457 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/Alerts/PatchAlert.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "iotDefenderLocation": "eastus", + "deviceGroupName": "default", + "alertId": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8", + "alertPatchModel": { + "properties": { + "severity": "Medium", + "status": "InProgress" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus/deviceGroups/default/alerts/903e76ff-17eb-4bac-ac8a-2bc31ab68fd8", + "name": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8", + "type": "Microsoft.IoTSecurity/alerts", + "properties": { + "systemAlertId": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8", + "azureResourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus/deviceGroups/default/devices/device-1", + "alertType": "IoT_PrivilegedContainer", + "startTimeUtc": "2020-05-13T06:32:25Z", + "endTimeUtc": "2020-05-13T06:32:25Z", + "entities": [ + { + "$id": "1", + "CommandLine": "docker run --privileged", + "Type": "process" + } + ], + "extendedProperties": { + "CommandLine": "docker run --privileged", + "User Name": "aUser", + "UserId": "", + "ParentProcessId": 1593, + "DeviceId": "device-1" + }, + "severity": "Medium", + "intent": "PreAttack", + "productComponentName": "IoT Hub", + "status": "InProgress" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/RecommendationTypes/GetRecommendationType.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/RecommendationTypes/GetRecommendationType.json new file mode 100644 index 000000000000..36f268aefd8f --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/RecommendationTypes/GetRecommendationType.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "recommendationTypeName": "IoT_VulnerableTLSCipherSuite" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/recommendationTypes/IoT_VulnerableTLSCipherSuite", + "name": "IoT_VulnerableTLSCipherSuite", + "type": "Microsoft.IoTSecurity/recommendationTypes", + "properties": { + "recommendationDisplayName": "TLS cipher suite upgrade needed", + "severity": "Medium", + "description": "Insecure TLS configurations detected. Immediate TLS cipher suite upgrade recommended.", + "remediationSteps": [ + "Upgrade your TLS cipher suite to a secure configuration. See the Guide to TLS Standards Compliance for more information." + ], + "vendorName": "Microsoft", + "control": "Communication between device and IoT Hub is not optimized", + "productName": "Azure Defender for IoT", + "productComponentName": "IoT Hub" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/RecommendationTypes/GetRecommendationTypeList.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/RecommendationTypes/GetRecommendationTypeList.json new file mode 100644 index 000000000000..271adf3f4c37 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/RecommendationTypes/GetRecommendationTypeList.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/recommendationTypes/IoT_VulnerableTLSCipherSuite", + "name": "IoT_VulnerableTLSCipherSuite", + "type": "Microsoft.IoTSecurity/recommendationTypes", + "properties": { + "recommendationDisplayName": "TLS cipher suite upgrade needed", + "severity": "Medium", + "description": "Insecure TLS configurations detected. Immediate TLS cipher suite upgrade recommended.", + "remediationSteps": [ + "Upgrade your TLS cipher suite to a secure configuration. See the Guide to TLS Standards Compliance for more information." + ], + "vendorName": "Microsoft", + "control": "Communication between device and IoT Hub is not optimized", + "productName": "Azure Defender for IoT", + "productComponentName": "IoT Hub" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + ] + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/Recommendations/GetRecommendation.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/Recommendations/GetRecommendation.json new file mode 100644 index 000000000000..2713d9b0ce4a --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/Recommendations/GetRecommendation.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "iotDefenderLocation": "eastus", + "deviceGroupName": "default", + "recommendationId": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8" + }, + "responses": { + "200": { + "body": { + "name": "IoT_Baseline|device-1", + "properties": { + "recommendationType": "IoT_Baseline", + "azureResourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus/deviceGroups/default/devices/device-1", + "discoveredTimeUtc": "2020-05-13T06:32:25Z", + "recommendationAdditionalData": { + "SnapshotId": "48519d58-4e35-46cd-aed5-6251af95ed50", + "TotalFailedRules": "7", + "TotalRulesFailedDuoToError": "1", + "TotalInformationalFailedRules": "2", + "TotalCriticalFailedRules": "3", + "TotalWarningFailedRules": "1" + }, + "severity": "Low", + "productComponentName": "IoT Hub", + "control": "Communication between device and IoT Hub is not optimized" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/Recommendations/GetRecommendationList.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/Recommendations/GetRecommendationList.json new file mode 100644 index 000000000000..0afa7dd4ed21 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/examples/Recommendations/GetRecommendationList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2021-07-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "iotDefenderLocation": "eastus", + "deviceGroupName": "default" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "IoT_Baseline|device-1", + "properties": { + "recommendationType": "IoT_Baseline", + "azureResourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus/deviceGroups/default/devices/device-1", + "discoveredTimeUtc": "2020-05-13T06:32:25Z", + "recommendationAdditionalData": { + "SnapshotId": "48519d58-4e35-46cd-aed5-6251af95ed50", + "TotalFailedRules": "7", + "TotalRulesFailedDuoToError": "1", + "TotalInformationalFailedRules": "2", + "TotalCriticalFailedRules": "3", + "TotalWarningFailedRules": "1" + }, + "severity": "Low", + "productComponentName": "IoT Hub", + "control": "Communication between device and IoT Hub is not optimized" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus/deviceGroups/default/recommendations?api-version=2021-07-01-preview&$skipToken=903e76ff-17eb-4bac-ac8a-2bc31ab68fd8" + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/recommendationTypes.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/recommendationTypes.json new file mode 100644 index 000000000000..b5bf14327085 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/recommendationTypes.json @@ -0,0 +1,253 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Defender for IoT", + "description": "API spec for Microsoft.IoTSecurity (Azure Defender for IoT) resource provider", + "version": "2021-07-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTSecurity/recommendationTypes": { + "get": { + "x-ms-examples": { + "Get IoT Recommendation Types": { + "$ref": "./examples/RecommendationTypes/GetRecommendationTypeList.json" + } + }, + "tags": [ + "IoT Security Recommendation Types" + ], + "description": "List IoT recommendation types", + "operationId": "RecommendationTypes_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecommendationTypeList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTSecurity/recommendationTypes/{recommendationTypeName}": { + "get": { + "x-ms-examples": { + "Get IoT Recommendation Type": { + "$ref": "./examples/RecommendationTypes/GetRecommendationType.json" + } + }, + "tags": [ + "IoT Security Recommendation Types" + ], + "operationId": "RecommendationTypes_Get", + "description": "Get IoT recommendation type", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "in": "path", + "name": "recommendationTypeName", + "required": true, + "type": "string", + "description": "Name of the recommendation type" + } + ], + "responses": { + "200": { + "description": "IoT recommendation type", + "schema": { + "$ref": "#/definitions/RecommendationType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "RecommendationTypeList": { + "type": "object", + "description": "List of recommendation types", + "properties": { + "value": { + "type": "array", + "description": "List data", + "items": { + "$ref": "#/definitions/RecommendationType" + } + } + } + }, + "RecommendationType": { + "type": "object", + "description": "IoT recommendation type.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Recommendation type properties", + "$ref": "#/definitions/RecommendationTypeProperties" + }, + "systemData": { + "readOnly": true, + "type": "object", + "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "RecommendationTypeProperties": { + "type": "object", + "description": "IoT recommendation type information.", + "properties": { + "recommendationDisplayName": { + "readOnly": true, + "type": "string", + "example": "TLS cipher suite upgrade needed", + "description": "The display name of the recommendation" + }, + "severity": { + "readOnly": true, + "type": "string", + "example": "Medium", + "description": "The severity of the recommendation", + "enum": [ + "Unknown", + "NotApplicable", + "Healthy", + "OffByPolicy", + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "recommendationSeverity", + "modelAsString": true, + "values": [ + { + "value": "Unknown" + }, + { + "value": "NotApplicable" + }, + { + "value": "Healthy" + }, + { + "value": "OffByPolicy" + }, + { + "value": "Low" + }, + { + "value": "Medium" + }, + { + "value": "High" + } + ] + } + }, + "description": { + "readOnly": true, + "type": "string", + "description": "Description of the suspected vulnerability and meaning.", + "example": "Insecure TLS configurations detected. Immediate TLS cipher suite upgrade recommended." + }, + "productName": { + "readOnly": true, + "type": "string", + "example": "Azure Security Center for IoT", + "description": "The name of the product which published this recommendation" + }, + "productComponentName": { + "readOnly": true, + "type": "string", + "example": "IoT Hub", + "description": "The name of a component inside the product which generated the recommendation" + }, + "vendorName": { + "readOnly": true, + "type": "string", + "example": "Microsoft", + "description": "The name of the vendor that raised the recommendation" + }, + "control": { + "readOnly": true, + "type": "string", + "example": "Communication between device and IoT Hub is not optimized", + "description": "The name of the recommendation's control category " + }, + "remediationSteps": { + "readOnly": true, + "description": "Manual action items to take to resolve the recommendation", + "type": "array", + "items": { + "type": "string", + "example": "Upgrade your TLS cipher suite to a secure configuration. See the Guide to TLS Standards Compliance for more information." + } + }, + "dataSource": { + "readOnly": true, + "description": "The alert's data source", + "type": "string", + "example": "IoT Hub" + } + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/recommendations.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/recommendations.json new file mode 100644 index 000000000000..71133ad0f520 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-07-01-preview/recommendations.json @@ -0,0 +1,286 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Defender for IoT", + "description": "API spec for Microsoft.IoTSecurity (Azure Defender for IoT) resource provider", + "version": "2021-07-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTSecurity/locations/{iotDefenderLocation}/deviceGroups/{deviceGroupName}/recommendations": { + "get": { + "x-ms-examples": { + "Get IoT Recommendations": { + "$ref": "./examples/Recommendations/GetRecommendationList.json" + } + }, + "tags": [ + "IoT Security Recommendations" + ], + "description": "List IoT recommendations", + "operationId": "IotRecommendations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/IotDefenderLocation" + }, + { + "$ref": "#/parameters/DeviceGroupName" + }, + { + "in": "query", + "name": "$skipToken", + "required": false, + "type": "string", + "description": "Skip token used for pagination" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecommendationListModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTSecurity/locations/{iotDefenderLocation}/deviceGroups/{deviceGroupName}/recommendations/{recommendationId}": { + "get": { + "x-ms-examples": { + "Get IoT Recommendation": { + "$ref": "./examples/Recommendations/GetRecommendation.json" + } + }, + "tags": [ + "IoT Security Recommendations" + ], + "operationId": "IotRecommendations_Get", + "description": "Get IoT recommendation", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/IotDefenderLocation" + }, + { + "$ref": "#/parameters/DeviceGroupName" + }, + { + "$ref": "#/parameters/RecommendationId" + } + ], + "responses": { + "200": { + "description": "IoT recommendation", + "schema": { + "$ref": "#/definitions/RecommendationModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "RecommendationListModel": { + "description": "List of IoT recommendations", + "type": "object", + "properties": { + "value": { + "description": "List data", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RecommendationModel" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "When available, follow the URI to get the next page of data" + } + } + }, + "RecommendationModel": { + "type": "object", + "description": "IoT recommendation", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Recommendation properties", + "$ref": "#/definitions/RecommendationPropertiesModel" + }, + "systemData": { + "readOnly": true, + "type": "object", + "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "RecommendationPropertiesModel": { + "type": "object", + "description": "IoT recommendation properties", + "properties": { + "azureResourceId": { + "description": "Azure Resource Identifier of the device being reported on", + "readOnly": true, + "type": "string", + "example": "device-1" + }, + "recommendationType": { + "description": "The type name of the recommendation", + "readOnly": true, + "type": "string", + "example": "IoT_PrivilegedContainer" + }, + "discoveredTimeUtc": { + "description": "The discovery time of the recommendation", + "readOnly": true, + "type": "string", + "example": "2020-05-13T06:32:25Z" + }, + "recommendationAdditionalData": { + "type": "object", + "description": "A bag of fields which extends the recommendation information", + "example": { + "SnapshotId": "48519d58-4e35-46cd-aed5-6251af95ed50", + "TotalFailedRules": "7", + "TotalRulesFailedDuoToError": "1", + "TotalInformationalFailedRules": "2", + "TotalCriticalFailedRules": "3", + "TotalWarningFailedRules": "1" + } + }, + "severity": { + "readOnly": true, + "type": "string", + "example": "Medium", + "description": "The severity of the recommendation", + "enum": [ + "Unknown", + "NotApplicable", + "Healthy", + "OffByPolicy", + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "recommendationSeverity", + "modelAsString": true, + "values": [ + { + "value": "Unknown" + }, + { + "value": "NotApplicable" + }, + { + "value": "Healthy" + }, + { + "value": "OffByPolicy" + }, + { + "value": "Low" + }, + { + "value": "Medium" + }, + { + "value": "High" + } + ] + } + }, + "productComponentName": { + "readOnly": true, + "type": "string", + "example": "IoT Hub", + "description": "The name of a component inside the product which generated the recommendation" + }, + "control": { + "readOnly": true, + "type": "string", + "example": "Communication between device and IoT Hub is not optimized", + "description": "The name of the recommendation's control category " + } + } + } + }, + "parameters": { + "DeviceGroupName": { + "name": "deviceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Device group name", + "x-ms-parameter-location": "method" + }, + "RecommendationId": { + "name": "recommendationId", + "in": "path", + "required": true, + "description": "Recommendation Id", + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Locations/Get.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Locations/Get.json new file mode 100644 index 000000000000..56eeb061163a --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Locations/Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "iotDefenderLocation": "eastus" + }, + "responses": { + "200": { + "body": { + "name": "eastus", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus", + "type": "Microsoft.IoTSecurity/locations", + "properties": {}, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Locations/List.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Locations/List.json new file mode 100644 index 000000000000..1808c6e91e67 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Locations/List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "eastus", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus", + "type": "Microsoft.IoTSecurity/locations", + "properties": {}, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + ] + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/Delete.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/Delete.json new file mode 100644 index 000000000000..185e11fbcad8 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "iotDefenderLocation": "eastus", + "siteName": "site", + "sensorName": "mySensor" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/DownloadActivation.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/DownloadActivation.json new file mode 100644 index 000000000000..58d27d7bd681 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/DownloadActivation.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "iotDefenderLocation": "eastus", + "siteName": "site", + "sensorName": "mySensor" + }, + "responses": { + "200": { + "headers": { + "content-type": "application/zip" + }, + "body": "{Binary}" + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/DownloadResetPassword.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/DownloadResetPassword.json new file mode 100644 index 000000000000..dcbfbaf13e90 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/DownloadResetPassword.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "iotDefenderLocation": "eastus", + "siteName": "site", + "sensorName": "mySensor", + "body": { + "applianceId": "3214-528AV23-D121-D3-E1" + } + }, + "responses": { + "200": { + "headers": { + "content-type": "application/zip" + }, + "body": "{Binary}" + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/Get.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/Get.json new file mode 100644 index 000000000000..29fbe0d08bcc --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "iotDefenderLocation": "eastus", + "siteName": "site", + "sensorName": "mySensor" + }, + "responses": { + "200": { + "body": { + "name": "mySensor", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus/sites/site/sensors/mySensor", + "type": "Microsoft.IoTSecurity/locations/sites/sensors", + "properties": { + "connectivityTime": "2020-11-17T12:31:25Z", + "dynamicLearning": true, + "learningMode": true, + "sensorStatus": "Ok", + "sensorVersion": "2020.11.01.1643", + "tiAutomaticUpdates": true, + "tiStatus": "Ok", + "tiVersion": "2020-11-17T12:31:25Z", + "zone": "Zone Name", + "sensorType": "Ot" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/Delete.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/Delete.json new file mode 100644 index 000000000000..e1d7a79a61d2 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub", + "sensorName": "mySensor" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/DownloadActivation.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/DownloadActivation.json new file mode 100644 index 000000000000..8baf6636651b --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/DownloadActivation.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub", + "sensorName": "mySensor" + }, + "responses": { + "200": { + "headers": { + "content-type": "application/zip" + }, + "body": "{Binary}" + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/DownloadResetPassword.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/DownloadResetPassword.json new file mode 100644 index 000000000000..72e17198b29d --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/DownloadResetPassword.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub", + "sensorName": "mySensor", + "body": { + "applianceId": "3214-528AV23-D121-D3-E1" + } + }, + "responses": { + "200": { + "headers": { + "content-type": "application/zip" + }, + "body": "{Binary}" + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/Get.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/Get.json new file mode 100644 index 000000000000..2c879b84d9fa --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub", + "sensorName": "mySensor" + }, + "responses": { + "200": { + "body": { + "name": "mySensor", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.IoTSecurity/sensors/mySensor", + "type": "Microsoft.IoTSecurity/sensors", + "properties": { + "connectivityTime": "2020-11-17T12:31:25Z", + "dynamicLearning": true, + "learningMode": true, + "sensorStatus": "Ok", + "sensorVersion": "2020.11.01.1643", + "tiAutomaticUpdates": true, + "tiStatus": "Ok", + "tiVersion": "2020-11-17T12:31:25Z", + "zone": "Zone Name", + "sensorType": "Ot" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/List.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/List.json new file mode 100644 index 000000000000..5c6d203121b9 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/List.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mySensor", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.IoTSecurity/sensors/mySensor", + "type": "Microsoft.IoTSecurity/sensors", + "properties": { + "connectivityTime": "2020-11-17T12:31:25Z", + "dynamicLearning": true, + "learningMode": true, + "sensorStatus": "Ok", + "sensorVersion": "2020.11.01.1643", + "tiAutomaticUpdates": true, + "tiStatus": "Ok", + "tiVersion": "2020-11-17T12:31:25Z", + "zone": "Zone Name", + "sensorType": "Ot" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + }, + { + "name": "otherSensor", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.IoTSecurity/sensors/otherSensor", + "type": "Microsoft.IoTSecurity/sensors", + "properties": { + "connectivityTime": "2020-11-17T12:31:25Z", + "dynamicLearning": false, + "learningMode": false, + "sensorStatus": "Disconnected", + "sensorVersion": "2020.11.01.1643", + "tiAutomaticUpdates": true, + "tiStatus": "Ok", + "tiVersion": "2020-11-17T12:31:25Z", + "zone": "Zone Name", + "sensorType": "Ot" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + ] + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/Put.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/Put.json new file mode 100644 index 000000000000..421900f4248f --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/Put.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub", + "sensorName": "mySensor", + "sensorModel": { + "properties": { + "tiAutomaticUpdates": true, + "zone": "Zone Name", + "sensorType": "Ot" + } + } + }, + "responses": { + "200": { + "body": { + "name": "mySensor", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.IoTSecurity/sensors/mySensor", + "type": "Microsoft.IoTSecurity/sensors", + "properties": { + "connectivityTime": "2020-11-17T12:31:25Z", + "dynamicLearning": true, + "learningMode": true, + "sensorStatus": "Ok", + "sensorVersion": "2020.11.01.1643", + "tiAutomaticUpdates": true, + "tiStatus": "Ok", + "tiVersion": "2020-11-17T12:31:25Z", + "zone": "Zone Name", + "sensorType": "Ot" + } + } + }, + "201": { + "body": { + "name": "mySensor", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.IoTSecurity/sensors/mySensor", + "type": "Microsoft.IoTSecurity/sensors", + "properties": { + "connectivityTime": "2020-11-17T12:31:25Z", + "dynamicLearning": true, + "learningMode": true, + "sensorStatus": "Ok", + "sensorVersion": "2020.11.01.1643", + "tiAutomaticUpdates": true, + "tiStatus": "Ok", + "tiVersion": "2020-11-17T12:31:25Z", + "zone": "Zone Name", + "sensorType": "Ot" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/TriggerTiPackageUpdate.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/TriggerTiPackageUpdate.json new file mode 100644 index 000000000000..aa72c8785c2d --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/IoTHub/TriggerTiPackageUpdate.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub", + "sensorName": "mySensor" + }, + "responses": { + "200": {} + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/List.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/List.json new file mode 100644 index 000000000000..2a3d81b9e84b --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/List.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "iotDefenderLocation": "eastus", + "siteName": "site" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mySensor", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus/sites/site/sensors/mySensor", + "type": "Microsoft.IoTSecurity/locations/sites/sensors", + "properties": { + "connectivityTime": "2020-11-17T12:31:25Z", + "dynamicLearning": true, + "learningMode": true, + "sensorStatus": "Ok", + "sensorVersion": "2020.11.01.1643", + "tiAutomaticUpdates": true, + "tiStatus": "Ok", + "tiVersion": "2020-11-17T12:31:25Z", + "zone": "Zone Name", + "sensorType": "Ot" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + }, + { + "name": "otherSensor", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus/sites/site/sensors/otherSensor", + "type": "Microsoft.IoTSecurity/locations/sites/sensors", + "properties": { + "connectivityTime": "2020-11-17T12:31:25Z", + "dynamicLearning": false, + "learningMode": false, + "sensorStatus": "Disconnected", + "sensorVersion": "2020.11.01.1643", + "tiAutomaticUpdates": true, + "tiStatus": "Ok", + "tiVersion": "2020-11-17T12:31:25Z", + "zone": "Zone Name", + "sensorType": "Ot" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + ] + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/Put.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/Put.json new file mode 100644 index 000000000000..f6b9f99b2158 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/Put.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "iotDefenderLocation": "eastus", + "siteName": "site", + "sensorName": "mySensor", + "sensorModel": { + "properties": { + "tiAutomaticUpdates": true, + "zone": "Zone Name", + "sensorType": "Ot" + } + } + }, + "responses": { + "200": { + "body": { + "name": "mySensor", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus/sites/site/sensors/mySensor", + "type": "Microsoft.IoTSecurity/locations/sites/sensors", + "properties": { + "connectivityTime": "2020-11-17T12:31:25Z", + "dynamicLearning": true, + "learningMode": true, + "sensorStatus": "Ok", + "sensorVersion": "2020.11.01.1643", + "tiAutomaticUpdates": true, + "tiStatus": "Ok", + "tiVersion": "2020-11-17T12:31:25Z", + "zone": "Zone Name", + "sensorType": "Ot" + } + } + }, + "201": { + "body": { + "name": "mySensor", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus/sites/site/sensors/mySensor", + "type": "Microsoft.IoTSecurity/locations/sites/sensors", + "properties": { + "connectivityTime": "2020-11-17T12:31:25Z", + "dynamicLearning": true, + "learningMode": true, + "sensorStatus": "Ok", + "sensorVersion": "2020.11.01.1643", + "tiAutomaticUpdates": true, + "tiStatus": "Ok", + "tiVersion": "2020-11-17T12:31:25Z", + "zone": "Zone Name", + "sensorType": "Ot" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/TriggerTiPackageUpdate.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/TriggerTiPackageUpdate.json new file mode 100644 index 000000000000..9dd0b146f876 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sensors/TriggerTiPackageUpdate.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "iotDefenderLocation": "eastus", + "siteName": "site", + "sensorName": "mySensor" + }, + "responses": { + "200": {} + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/Delete.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/Delete.json new file mode 100644 index 000000000000..4e5caff95116 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "iotDefenderLocation": "eastus", + "siteName": "site" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/Get.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/Get.json new file mode 100644 index 000000000000..5785d533bb5e --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "iotDefenderLocation": "eastus", + "siteName": "site" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus/sites/site", + "type": "Microsoft.IoTSecurity/locations/sites", + "name": "site", + "properties": { + "displayName": "IoT site name", + "tags": { + "key1": "value1", + "key2": "value2" + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/IoTHub/Delete.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/IoTHub/Delete.json new file mode 100644 index 000000000000..8c7bec2c91b7 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/IoTHub/Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/IoTHub/Get.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/IoTHub/Get.json new file mode 100644 index 000000000000..f01f09e6b032 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/IoTHub/Get.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.IoTSecurity/sites/default", + "type": "Microsoft.IoTSecurity/sites", + "name": "default", + "properties": { + "displayName": "IoT site name", + "tags": { + "key1": "value1", + "key2": "value2" + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/IoTHub/List.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/IoTHub/List.json new file mode 100644 index 000000000000..262e4243745e --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/IoTHub/List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/sites" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.IoTSecurity/sites/default", + "type": "Microsoft.IoTSecurity/sites", + "properties": { + "displayName": "IoT site name", + "tags": { + "key1": "value1", + "key2": "value2" + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + ] + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/IoTHub/Put.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/IoTHub/Put.json new file mode 100644 index 000000000000..d0844663fc24 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/IoTHub/Put.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub", + "siteModel": { + "properties": { + "displayName": "IoT site name", + "tags": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.IoTSecurity/sites/default", + "type": "Microsoft.IoTSecurity/sites", + "properties": { + "displayName": "IoT site name", + "tags": { + "key1": "value1", + "key2": "value2" + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + }, + "201": { + "body": { + "name": "default", + "id": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.IoTSecurity/sites/default", + "type": "Microsoft.IoTSecurity/sites", + "properties": { + "displayName": "IoT site name", + "tags": { + "key1": "value1", + "key2": "value2" + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/List.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/List.json new file mode 100644 index 000000000000..80ced4212195 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/List.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "iotDefenderLocation": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus/sites/site", + "type": "Microsoft.IoTSecurity/locations/sites", + "name": "site", + "properties": { + "displayName": "IoT site name", + "tags": { + "key1": "value1", + "key2": "value2" + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + ] + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/Put.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/Put.json new file mode 100644 index 000000000000..ceeb6649c21f --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/examples/Sites/Put.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "iotDefenderLocation": "eastus", + "siteName": "site", + "siteModel": { + "properties": { + "displayName": "IoT site name", + "tags": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus/sites/site", + "type": "Microsoft.IoTSecurity/locations/sites", + "name": "site", + "properties": { + "displayName": "IoT site name", + "tags": { + "key1": "value1", + "key2": "value2" + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.IoTSecurity/locations/eastus/sites/site", + "type": "Microsoft.IoTSecurity/locations/sites", + "name": "site", + "properties": { + "displayName": "IoT site name", + "tags": { + "key1": "value1", + "key2": "value2" + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/locations.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/locations.json new file mode 100644 index 000000000000..e492048bb089 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/locations.json @@ -0,0 +1,164 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Defender for IoT", + "description": "API spec for Microsoft.IoTSecurity (Azure Defender for IoT) resource provider", + "version": "2021-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTSecurity/locations": { + "get": { + "x-ms-examples": { + "List locations": { + "$ref": "./examples/Locations/List.json" + } + }, + "tags": [ + "Locations" + ], + "description": "Lists Defender for IoT locations associated with the given subscription.", + "operationId": "Locations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LocationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTSecurity/locations/{iotDefenderLocation}": { + "get": { + "x-ms-examples": { + "Get location": { + "$ref": "./examples/Locations/Get.json" + } + }, + "tags": [ + "Locations" + ], + "operationId": "Locations_Get", + "description": "Get a Defender for IoT location associated with the given subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/IotDefenderLocation" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LocationModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "LocationList": { + "description": "List of Defender for IoT locations", + "type": "object", + "properties": { + "value": { + "description": "List data", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/LocationModel" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "LocationModel": { + "type": "object", + "description": "IoT Defender location", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "IoT Defender location properties", + "$ref": "#/definitions/LocationProperties" + }, + "systemData": { + "readOnly": true, + "type": "object", + "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "LocationProperties": { + "type": "object", + "description": "Defender for IoT location properties", + "properties": {} + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/sensors.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/sensors.json new file mode 100644 index 000000000000..eee6f46e19f1 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/sensors.json @@ -0,0 +1,869 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Defender for IoT", + "description": "API spec for Microsoft.IoTSecurity (Azure Defender for IoT) resource provider", + "version": "2021-09-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": { + "/{scope}/providers/Microsoft.IoTSecurity/sensors": { + "get": { + "x-ms-examples": { + "List IoT sensors": { + "$ref": "./examples/Sensors/IoTHub/List.json" + } + }, + "tags": [ + "Sensors" + ], + "description": "List IoT sensors", + "operationId": "Sensors_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SensorScope" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SensorsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.IoTSecurity/sensors/{sensorName}": { + "get": { + "x-ms-examples": { + "Get IoT sensor": { + "$ref": "./examples/Sensors/IoTHub/Get.json" + } + }, + "tags": [ + "Sensors" + ], + "operationId": "Sensors_Get", + "description": "Get IoT sensor", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SensorScope" + }, + { + "$ref": "#/parameters/SensorName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SensorModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create or update IoT sensor": { + "$ref": "./examples/Sensors/IoTHub/Put.json" + } + }, + "tags": [ + "Sensors" + ], + "operationId": "Sensors_CreateOrUpdate", + "description": "Create or update IoT sensor", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SensorScope" + }, + { + "$ref": "#/parameters/SensorName" + }, + { + "$ref": "#/parameters/SensorModel" + } + ], + "responses": { + "200": { + "description": "Updated IoT sensor", + "schema": { + "$ref": "#/definitions/SensorModel" + } + }, + "201": { + "description": "Created IoT sensor", + "schema": { + "$ref": "#/definitions/SensorModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete IoT sensor": { + "$ref": "./examples/Sensors/IoTHub/Delete.json" + } + }, + "tags": [ + "Sensors" + ], + "operationId": "Sensors_Delete", + "description": "Delete IoT sensor", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SensorScope" + }, + { + "$ref": "#/parameters/SensorName" + } + ], + "responses": { + "200": { + "description": "Deleted IoT sensor" + }, + "204": { + "description": "IoT sensor does not exist" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.IoTSecurity/sensors/{sensorName}/downloadActivation": { + "post": { + "x-ms-examples": { + "Download activation file": { + "$ref": "./examples/Sensors/IoTHub/DownloadActivation.json" + } + }, + "tags": [ + "Sensors" + ], + "operationId": "Sensors_DownloadActivation", + "description": "Download sensor activation file", + "produces": [ + "application/zip" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SensorScope" + }, + { + "$ref": "#/parameters/SensorName" + } + ], + "responses": { + "200": { + "description": "Downloaded activation file", + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.IoTSecurity/sensors/{sensorName}/downloadResetPassword": { + "post": { + "x-ms-examples": { + "Download file for reset password of the sensor": { + "$ref": "./examples/Sensors/IoTHub/DownloadResetPassword.json" + } + }, + "tags": [ + "Sensors" + ], + "operationId": "Sensors_DownloadResetPassword", + "description": "Download file for reset password of the sensor", + "produces": [ + "application/zip" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SensorScope" + }, + { + "$ref": "#/parameters/SensorName" + }, + { + "in": "body", + "name": "body", + "required": true, + "description": "The reset password input.", + "schema": { + "$ref": "#/definitions/ResetPasswordInput" + }, + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "Downloaded reset password file", + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.IoTSecurity/sensors/{sensorName}/triggerTiPackageUpdate": { + "post": { + "x-ms-examples": { + "Trigger threat intelligence package update": { + "$ref": "./examples/Sensors/IoTHub/TriggerTiPackageUpdate.json" + } + }, + "tags": [ + "Sensors" + ], + "operationId": "Sensors_TriggerTiPackageUpdate", + "description": "Trigger threat intelligence package update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SensorScope" + }, + { + "$ref": "#/parameters/SensorName" + } + ], + "responses": { + "200": { + "description": "Triggered threat intelligence package update" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTSecurity/locations/{iotDefenderLocation}/sites/{siteName}/sensors": { + "get": { + "x-ms-examples": { + "List Sensors": { + "$ref": "./examples/Sensors/List.json" + } + }, + "tags": [ + "Sensors" + ], + "description": "List IoT sensors", + "operationId": "SiteSensors_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/IotDefenderLocation" + }, + { + "$ref": "#/parameters/SiteName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SensorsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTSecurity/locations/{iotDefenderLocation}/sites/{siteName}/sensors/{sensorName}": { + "get": { + "x-ms-examples": { + "Get Sensor": { + "$ref": "./examples/Sensors/Get.json" + } + }, + "tags": [ + "Sensors" + ], + "operationId": "SiteSensors_Get", + "description": "Get IoT sensor", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/IotDefenderLocation" + }, + { + "$ref": "#/parameters/SiteName" + }, + { + "$ref": "#/parameters/SensorName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SensorModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create or update sensor": { + "$ref": "./examples/Sensors/Put.json" + } + }, + "tags": [ + "Sensors" + ], + "operationId": "SiteSensors_CreateOrUpdate", + "description": "Create or update IoT sensor", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/IotDefenderLocation" + }, + { + "$ref": "#/parameters/SiteName" + }, + { + "$ref": "#/parameters/SensorName" + }, + { + "$ref": "#/parameters/SensorModel" + } + ], + "responses": { + "200": { + "description": "Updated IoT sensor", + "schema": { + "$ref": "#/definitions/SensorModel" + } + }, + "201": { + "description": "Created IoT sensor", + "schema": { + "$ref": "#/definitions/SensorModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete Sensor": { + "$ref": "./examples/Sensors/Delete.json" + } + }, + "tags": [ + "Sensors" + ], + "operationId": "SiteSensors_Delete", + "description": "Delete IoT sensor", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/IotDefenderLocation" + }, + { + "$ref": "#/parameters/SiteName" + }, + { + "$ref": "#/parameters/SensorName" + } + ], + "responses": { + "200": { + "description": "Deleted IoT sensor" + }, + "204": { + "description": "IoT sensor does not exist" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTSecurity/locations/{iotDefenderLocation}/sites/{siteName}/sensors/{sensorName}/downloadActivation": { + "post": { + "x-ms-examples": { + "Download sensor activation file": { + "$ref": "./examples/Sensors/DownloadActivation.json" + } + }, + "tags": [ + "Sensors" + ], + "operationId": "SiteSensors_DownloadActivation", + "description": "Download sensor activation file", + "produces": [ + "application/zip" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/IotDefenderLocation" + }, + { + "$ref": "#/parameters/SiteName" + }, + { + "$ref": "#/parameters/SensorName" + } + ], + "responses": { + "200": { + "description": "Downloaded activation file", + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTSecurity/locations/{iotDefenderLocation}/sites/{siteName}/sensors/{sensorName}/downloadResetPassword": { + "post": { + "x-ms-examples": { + "Download reset password file of the sensor": { + "$ref": "./examples/Sensors/DownloadResetPassword.json" + } + }, + "tags": [ + "Sensors" + ], + "operationId": "SiteSensors_DownloadResetPassword", + "description": "Download file for reset password of the sensor", + "produces": [ + "application/zip" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/IotDefenderLocation" + }, + { + "$ref": "#/parameters/SiteName" + }, + { + "$ref": "#/parameters/SensorName" + }, + { + "in": "body", + "name": "body", + "required": true, + "description": "The reset password input.", + "schema": { + "$ref": "#/definitions/ResetPasswordInput" + }, + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "Downloaded reset password file", + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTSecurity/locations/{iotDefenderLocation}/sites/{siteName}/sensors/{sensorName}/triggerTiPackageUpdate": { + "post": { + "x-ms-examples": { + "Trigger threat intelligence package sensor update": { + "$ref": "./examples/Sensors/TriggerTiPackageUpdate.json" + } + }, + "tags": [ + "Sensors" + ], + "operationId": "SiteSensors_TriggerTiPackageUpdate", + "description": "Trigger threat intelligence package update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/IotDefenderLocation" + }, + { + "$ref": "#/parameters/SiteName" + }, + { + "$ref": "#/parameters/SensorName" + } + ], + "responses": { + "200": { + "description": "Triggered threat intelligence package update" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "SensorsList": { + "description": "List of IoT sensors", + "type": "object", + "properties": { + "value": { + "description": "List data", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SensorModel" + } + } + } + }, + "SensorModel": { + "type": "object", + "description": "IoT sensor model", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "IoT sensor properties", + "$ref": "#/definitions/SensorProperties" + }, + "systemData": { + "readOnly": true, + "type": "object", + "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ] + }, + "SensorProperties": { + "type": "object", + "description": "IoT sensor properties", + "properties": { + "connectivityTime": { + "description": "Last connectivity time of the IoT sensor", + "readOnly": true, + "type": "string", + "example": "2020-11-17T12:31:25Z" + }, + "dynamicLearning": { + "description": "Dynamic mode status of the IoT sensor", + "example": true, + "readOnly": true, + "type": "boolean" + }, + "learningMode": { + "description": "Learning mode status of the IoT sensor", + "example": true, + "readOnly": true, + "type": "boolean" + }, + "sensorStatus": { + "readOnly": true, + "type": "string", + "example": "Ok", + "description": "Status of the IoT sensor", + "enum": [ + "Ok", + "Disconnected", + "Unavailable" + ], + "x-ms-enum": { + "name": "sensorStatus", + "modelAsString": true, + "values": [ + { + "value": "Ok" + }, + { + "value": "Disconnected" + }, + { + "value": "Unavailable" + } + ] + } + }, + "sensorVersion": { + "description": "Version of the IoT sensor", + "readOnly": true, + "type": "string", + "example": "2020.11.01.1643" + }, + "tiAutomaticUpdates": { + "description": "TI Automatic mode status of the IoT sensor", + "example": true, + "type": "boolean" + }, + "tiStatus": { + "readOnly": true, + "type": "string", + "example": "Ok", + "description": "TI Status of the IoT sensor", + "enum": [ + "Ok", + "Failed", + "InProgress", + "UpdateAvailable" + ], + "x-ms-enum": { + "name": "tiStatus", + "modelAsString": true, + "values": [ + { + "value": "Ok" + }, + { + "value": "Failed" + }, + { + "value": "InProgress" + }, + { + "value": "UpdateAvailable" + } + ] + } + }, + "tiVersion": { + "description": "TI Version of the IoT sensor", + "readOnly": true, + "type": "string", + "example": "2020-11-17T12:31:25Z" + }, + "zone": { + "type": "string", + "description": "Zone of the IoT sensor", + "example": "A12" + }, + "sensorType": { + "description": "Type of sensor", + "example": "Ot", + "type": "string", + "enum": [ + "Ot", + "Enterprise" + ], + "x-ms-enum": { + "name": "sensorType", + "modelAsString": true, + "values": [ + { + "value": "Ot" + }, + { + "value": "Enterprise" + } + ] + } + } + } + }, + "ResetPasswordInput": { + "type": "object", + "description": "Reset password input.", + "properties": { + "applianceId": { + "description": "The appliance id of the sensor.", + "type": "string" + } + } + } + }, + "parameters": { + "SensorScope": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "Scope of the query (IoT Hub, /providers/Microsoft.Devices/iotHubs/myHub)", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "SiteName": { + "name": "siteName", + "in": "path", + "required": true, + "type": "string", + "description": "Site Name", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "SensorName": { + "name": "sensorName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the IoT sensor", + "x-ms-parameter-location": "method" + }, + "SensorModel": { + "name": "sensorModel", + "in": "body", + "required": true, + "description": "The IoT sensor model", + "schema": { + "$ref": "#/definitions/SensorModel" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/sites.json b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/sites.json new file mode 100644 index 000000000000..940046a2e2c2 --- /dev/null +++ b/specification/iotsecurity/resource-manager/Microsoft.IoTSecurity/preview/2021-09-01-preview/sites.json @@ -0,0 +1,445 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Defender for IoT", + "description": "API spec for Microsoft.IoTSecurity (Azure Defender for IoT) resource provider", + "version": "2021-09-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": { + "/{scope}/providers/Microsoft.IoTSecurity/sites": { + "get": { + "x-ms-examples": { + "List IoT sites": { + "$ref": "./examples/Sites/IoTHub/List.json" + } + }, + "tags": [ + "Sites" + ], + "description": "List IoT sites", + "operationId": "Sites_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SiteScope" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SitesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.IoTSecurity/sites/default": { + "get": { + "x-ms-examples": { + "Get IoT site": { + "$ref": "./examples/Sites/IoTHub/Get.json" + } + }, + "tags": [ + "Sites" + ], + "operationId": "Sites_Get", + "description": "Get IoT site", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SiteScope" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create or update IoT site": { + "$ref": "./examples/Sites/IoTHub/Put.json" + } + }, + "tags": [ + "Sites" + ], + "operationId": "Sites_CreateOrUpdate", + "description": "Create or update IoT site", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SiteScope" + }, + { + "$ref": "#/parameters/SiteModel" + } + ], + "responses": { + "200": { + "description": "Updated IoT site", + "schema": { + "$ref": "#/definitions/SiteModel" + } + }, + "201": { + "description": "Created IoT site", + "schema": { + "$ref": "#/definitions/SiteModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete IoT site": { + "$ref": "./examples/Sites/IoTHub/Delete.json" + } + }, + "tags": [ + "Sites" + ], + "operationId": "Sites_Delete", + "description": "Delete IoT site", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SiteScope" + } + ], + "responses": { + "200": { + "description": "Deleted IoT site" + }, + "204": { + "description": "IoT site does not exist" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTSecurity/locations/{iotDefenderLocation}/sites": { + "get": { + "x-ms-examples": { + "List sites": { + "$ref": "./examples/Sites/List.json" + } + }, + "tags": [ + "Sites" + ], + "description": "List IoT sites", + "operationId": "LocationSites_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/IotDefenderLocation" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SitesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTSecurity/locations/{iotDefenderLocation}/sites/{siteName}": { + "get": { + "x-ms-examples": { + "Get site": { + "$ref": "./examples/Sites/Get.json" + } + }, + "tags": [ + "Sites" + ], + "operationId": "LocationSites_Get", + "description": "Get IoT site", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/IotDefenderLocation" + }, + { + "$ref": "#/parameters/SiteName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create or update site": { + "$ref": "./examples/Sites/Put.json" + } + }, + "tags": [ + "Sites" + ], + "operationId": "LocationSites_CreateOrUpdate", + "description": "Create or update IoT site", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/IotDefenderLocation" + }, + { + "$ref": "#/parameters/SiteName" + }, + { + "$ref": "#/parameters/SiteModel" + } + ], + "responses": { + "200": { + "description": "Updated IoT site", + "schema": { + "$ref": "#/definitions/SiteModel" + } + }, + "201": { + "description": "Created IoT site", + "schema": { + "$ref": "#/definitions/SiteModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete Site": { + "$ref": "./examples/Sites/Delete.json" + } + }, + "tags": [ + "Sites" + ], + "operationId": "LocationSites_Delete", + "description": "Delete IoT site", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/IotDefenderLocation" + }, + { + "$ref": "#/parameters/SiteName" + } + ], + "responses": { + "200": { + "description": "Deleted IoT site" + }, + "204": { + "description": "IoT site does not exist" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "SitesList": { + "description": "List of IoT sites", + "type": "object", + "properties": { + "value": { + "description": "List data", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SiteModel" + } + } + } + }, + "SiteModel": { + "type": "object", + "description": "IoT site model", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "IoT site properties", + "$ref": "#/definitions/SiteProperties" + }, + "systemData": { + "readOnly": true, + "type": "object", + "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "SiteProperties": { + "type": "object", + "description": "IoT site properties", + "properties": { + "displayName": { + "type": "string", + "description": "Display name of the IoT site" + }, + "tags": { + "type": "object", + "description": "Tags of the IoT site", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "displayName" + ] + } + }, + "parameters": { + "SiteScope": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "Scope of the query (IoT Hub, /providers/Microsoft.Devices/iotHubs/myHub)", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "SiteName": { + "name": "siteName", + "in": "path", + "required": true, + "type": "string", + "description": "Site Name", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "SiteModel": { + "name": "siteModel", + "in": "body", + "required": true, + "description": "The IoT sites model", + "schema": { + "$ref": "#/definitions/SiteModel" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/iotsecurity/resource-manager/readme.md b/specification/iotsecurity/resource-manager/readme.md index 2c31d6faad9b..bc2661df88a5 100644 --- a/specification/iotsecurity/resource-manager/readme.md +++ b/specification/iotsecurity/resource-manager/readme.md @@ -69,6 +69,46 @@ input-file: - Microsoft.IoTSecurity/preview/2021-02-01-preview/devices.json ``` +``` yaml +title: IoTSecurity +description: API spec for Microsoft.IoTSecurity (Azure Defender for IoT) resource provider +openapi-type: arm +tag: 2021-07-01-preview +``` + +### Tag: 2021-07-01-preview + +These settings apply only when `--tag=2021-07-01-preview` is specified on the command line. + +``` yaml $(tag) == '2021-07-01-preview' +input-file: +- Microsoft.IoTSecurity/preview/2021-02-01-preview/operations.json +- Microsoft.IoTSecurity/preview/2021-07-01-preview/alerts.json +- Microsoft.IoTSecurity/preview/2021-07-01-preview/alertTypes.json +- Microsoft.IoTSecurity/preview/2021-07-01-preview/recommendations.json +- Microsoft.IoTSecurity/preview/2021-07-01-preview/recommendationTypes.json +``` + + +``` yaml +title: IoTSecurity +description: API spec for Microsoft.IoTSecurity (Azure Defender for IoT) resource provider +openapi-type: arm +tag: 2021-09-01-preview +``` + +### Tag: 2021-09-01-preview + +These settings apply only when `--tag=2021-09-01-preview` is specified on the command line. + +``` yaml $(tag) == '2021-09-01-preview' +input-file: +- Microsoft.IoTSecurity/preview/2021-02-01-preview/operations.json +- Microsoft.IoTSecurity/preview/2021-09-01-preview/locations.json +- Microsoft.IoTSecurity/preview/2021-09-01-preview/sites.json +- Microsoft.IoTSecurity/preview/2021-09-01-preview/sensors.json +``` + --- # Code Generation diff --git a/specification/iotspaces/resource-manager/Microsoft.IoTSpaces/preview/2017-10-01-preview/examples/IoTSpacesCheckNameAvailability_example.json b/specification/iotspaces/resource-manager/Microsoft.IoTSpaces/preview/2017-10-01-preview/examples/IoTSpacesCheckNameAvailability_example.json deleted file mode 100644 index 7f5fd5b4760c..000000000000 --- a/specification/iotspaces/resource-manager/Microsoft.IoTSpaces/preview/2017-10-01-preview/examples/IoTSpacesCheckNameAvailability_example.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2017-10-01-preview", - "operationInputs": { - "name": "myIoTSpacesService" - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "nameAvailable": true - } - } - } -} diff --git a/specification/iotspaces/resource-manager/Microsoft.IoTSpaces/preview/2017-10-01-preview/examples/IoTSpacesDelete_example.json b/specification/iotspaces/resource-manager/Microsoft.IoTSpaces/preview/2017-10-01-preview/examples/IoTSpacesDelete_example.json deleted file mode 100644 index f4a39d522fed..000000000000 --- a/specification/iotspaces/resource-manager/Microsoft.IoTSpaces/preview/2017-10-01-preview/examples/IoTSpacesDelete_example.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "resourceName": "myIoTSpacesService", - "api-version": "2017-10-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTSpaces/IoTSpacesService/myIoTSpacesService", - "location": "westus", - "type": "Microsoft.IoTSpaces/IoTSpacesService", - "name": "myIoTSpacesService", - "properties": { - "provisioningState": "Deleting", - "managementApiUrl": "myIoTSpacesService-management.AzureIoTSpaces.net", - "webPortalUrl": "myIoTSpacesService-webportal.AzureIoTSpaces.net", - "storageContainer": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroup": "resReg", - "containerName": "myStorageContainer" - } - }, - "sku": { - "name": "F1" - } - } - }, - "202": {}, - "204": {} - } -} diff --git a/specification/iotspaces/resource-manager/Microsoft.IoTSpaces/preview/2017-10-01-preview/examples/IoTSpacesGet_example.json b/specification/iotspaces/resource-manager/Microsoft.IoTSpaces/preview/2017-10-01-preview/examples/IoTSpacesGet_example.json deleted file mode 100644 index 5f3878221c6a..000000000000 --- a/specification/iotspaces/resource-manager/Microsoft.IoTSpaces/preview/2017-10-01-preview/examples/IoTSpacesGet_example.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "resourceName": "myIoTSpacesService", - "api-version": "2017-10-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTSpaces/IoTSpacesService/myIoTSpacesService", - "location": "westus", - "type": "Microsoft.IoTSpaces/IoTSpacesService", - "name": "myIoTSpacesService", - "properties": { - "provisioningState": "Provisioning", - "managementApiUrl": "myIoTSpacesService-management.AzureIoTSpaces.net", - "webPortalUrl": "myIoTSpacesService-webportal.AzureIoTSpaces.net", - "storageContainer": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroup": "resReg", - "containerName": "myStorageContainer" - } - }, - "sku": { - "name": "F1" - } - } - } - } -} diff --git a/specification/iotspaces/resource-manager/Microsoft.IoTSpaces/preview/2017-10-01-preview/examples/IoTSpacesListByResourceGroup_example.json b/specification/iotspaces/resource-manager/Microsoft.IoTSpaces/preview/2017-10-01-preview/examples/IoTSpacesListByResourceGroup_example.json deleted file mode 100644 index 3c592d97dbf7..000000000000 --- a/specification/iotspaces/resource-manager/Microsoft.IoTSpaces/preview/2017-10-01-preview/examples/IoTSpacesListByResourceGroup_example.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2017-10-01-preview", - "resourceGroupName": "resRg" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTSpaces/IoTSpacesService/myIoTSpacesService", - "location": "westus", - "type": "Microsoft.IoTSpaces/IoTSpacesService", - "name": "myIoTSpacesService", - "properties": { - "provisioningState": "Provisioning", - "managementApiUrl": "myIoTSpacesService-management.AzureIoTSpaces.net", - "webPortalUrl": "myIoTSpacesService-webportal.AzureIoTSpaces.net", - "storageContainer": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroup": "resReg", - "containerName": "myStorageContainer" - } - }, - "sku": { - "name": "F1" - } - } - ] - } - } - } -} diff --git a/specification/iotspaces/resource-manager/Microsoft.IoTSpaces/preview/2017-10-01-preview/examples/IoTSpacesList_example.json b/specification/iotspaces/resource-manager/Microsoft.IoTSpaces/preview/2017-10-01-preview/examples/IoTSpacesList_example.json deleted file mode 100644 index 2b493a821085..000000000000 --- a/specification/iotspaces/resource-manager/Microsoft.IoTSpaces/preview/2017-10-01-preview/examples/IoTSpacesList_example.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2017-10-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTSpaces/IoTSpacesService/myIoTSpacesService", - "location": "westus", - "type": "Microsoft.IoTSpaces/IoTSpacesService", - "name": "myIoTSpacesService", - "properties": { - "provisioningState": "Provisioning", - "managementApiUrl": "myIoTSpacesService-management.AzureIoTSpaces.net", - "webPortalUrl": "myIoTSpacesService-webportal.AzureIoTSpaces.net", - "storageContainer": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroup": "resReg", - "containerName": "myStorageContainer" - } - }, - "sku": { - "name": "F1" - } - } - ] - } - } - } -} diff --git a/specification/iotspaces/resource-manager/Microsoft.IoTSpaces/preview/2017-10-01-preview/examples/IoTSpacesOperationsList_example.json b/specification/iotspaces/resource-manager/Microsoft.IoTSpaces/preview/2017-10-01-preview/examples/IoTSpacesOperationsList_example.json deleted file mode 100644 index 1ac3e47c971c..000000000000 --- a/specification/iotspaces/resource-manager/Microsoft.IoTSpaces/preview/2017-10-01-preview/examples/IoTSpacesOperationsList_example.json +++ /dev/null @@ -1,50 +0,0 @@ -{ - "parameters": { - "api-version": "2017-10-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "name": "Microsoft.IoTSpaces/checkNameAvailability/action", - "display": { - "provider": "Microsoft IoT Spaces Service", - "resource": "Microsoft IoT Spaces Service instance", - "operation": "Check IoT Spaces Service name availability.", - "description": "Check IoT Spaces Service name availability." - } - }, - { - "name": "Microsoft.IoTSpaces/Graph/write", - "display": { - "provider": "Microsoft IoT Spaces Service", - "resource": "Microsoft IoT Spaces Service instance", - "operation": "Create or update a IoT Spaces Service instance.", - "description": "Create or update a IoT Spaces Service instance." - } - }, - { - "name": "Microsoft.IoTSpaces/Graph/read", - "display": { - "provider": "Microsoft IoT Spaces Service", - "resource": "Microsoft IoT Spaces Service instance", - "operation": "Get a IoT Spaces Service instance.", - "description": "Get a IoT Spaces Service instance." - } - }, - { - "name": "Microsoft.IoTSpaces/Graph/delete", - "display": { - "provider": "Microsoft IoT Spaces Service", - "resource": "Microsoft IoT Spaces Service instance", - "operation": "Delete a IoT Spaces Service instance.", - "description": "Delete a IoT Spaces Service instance." - } - } - ] - } - } - } -} diff --git a/specification/iotspaces/resource-manager/Microsoft.IoTSpaces/preview/2017-10-01-preview/examples/IoTSpacesPatch_example.json b/specification/iotspaces/resource-manager/Microsoft.IoTSpaces/preview/2017-10-01-preview/examples/IoTSpacesPatch_example.json deleted file mode 100644 index 904a31a02c43..000000000000 --- a/specification/iotspaces/resource-manager/Microsoft.IoTSpaces/preview/2017-10-01-preview/examples/IoTSpacesPatch_example.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "resourceName": "myIoTSpacesService", - "api-version": "2017-10-01-preview", - "iotSpacePatchDescription": { - "properties": { - "storageContainer": { - "connectionString": "string", - "subscriptionId": "string", - "resourceGroup": "string", - "containerName": "string" - } - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTSpaces/IoTSpacesService/myIoTSpacesService", - "location": "westus", - "type": "Microsoft.IoTSpaces/IoTSpacesService", - "name": "myIoTSpacesService", - "properties": { - "provisioningState": "Succeeded", - "managementApiUrl": "myIoTSpacesService-management.AzureIoTSpaces.net", - "webPortalUrl": "myIoTSpacesService-webportal.AzureIoTSpaces.net", - "storageContainer": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroup": "resReg", - "containerName": "myStorageContainer" - } - }, - "sku": { - "name": "F1" - } - } - }, - "202": {} - } -} diff --git a/specification/iotspaces/resource-manager/Microsoft.IoTSpaces/preview/2017-10-01-preview/examples/IoTSpacesPut_example.json b/specification/iotspaces/resource-manager/Microsoft.IoTSpaces/preview/2017-10-01-preview/examples/IoTSpacesPut_example.json deleted file mode 100644 index 72e8dbaaeb3b..000000000000 --- a/specification/iotspaces/resource-manager/Microsoft.IoTSpaces/preview/2017-10-01-preview/examples/IoTSpacesPut_example.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "resourceName": "myIoTSpacesService", - "api-version": "2017-10-01-preview", - "iotSpaceDescription": { - "location": "string", - "properties": { - "storageContainer": { - "connectionString": "string", - "subscriptionId": "string", - "resourceGroup": "string", - "containerName": "string" - } - }, - "sku": { - "name": "F1" - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTSpaces/IoTSpacesService/myIoTSpacesService", - "location": "westus", - "type": "Microsoft.IoTSpaces/IoTSpacesService", - "name": "myIoTSpacesService", - "properties": { - "provisioningState": "Provisioning", - "managementApiUrl": "myIoTSpacesService-management.AzureIoTSpaces.net", - "webPortalUrl": "myIoTSpacesService-webportal.AzureIoTSpaces.net", - "storageContainer": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroup": "resReg", - "containerName": "myStorageContainer" - } - }, - "sku": { - "name": "F1" - } - } - }, - "202": {} - } -} diff --git a/specification/iotspaces/resource-manager/Microsoft.IoTSpaces/preview/2017-10-01-preview/iotspaces.json b/specification/iotspaces/resource-manager/Microsoft.IoTSpaces/preview/2017-10-01-preview/iotspaces.json index b18f464bb626..3e0d00468129 100644 --- a/specification/iotspaces/resource-manager/Microsoft.IoTSpaces/preview/2017-10-01-preview/iotspaces.json +++ b/specification/iotspaces/resource-manager/Microsoft.IoTSpaces/preview/2017-10-01-preview/iotspaces.json @@ -36,671 +36,8 @@ } } }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTSpaces/Graph/{resourceName}": { - "get": { - "tags": [ - "Resource" - ], - "description": "Get the metadata of a IoTSpaces instance.", - "operationId": "IoTSpaces_Get", - "x-ms-examples": { - "Get a IoT spaces service": { - "$ref": "./examples/IoTSpacesGet_example.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/resourceName" - } - ], - "responses": { - "200": { - "description": "The body contains all the non-security properties of the IoTSpaces instance. Security-related properties are set to null.", - "schema": { - "$ref": "#/definitions/IoTSpacesDescription" - } - }, - "default": { - "description": "Default error response", - "schema": { - "$ref": "#/definitions/ErrorDetails" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Resource" - ], - "description": "Create or update the metadata of an IoTSpaces instance. The usual pattern to modify a property is to retrieve the IoTSpaces instance metadata and security metadata, and then combine them with the modified values in a new body to update the IoTSpaces instance.", - "operationId": "IoTSpaces_CreateOrUpdate", - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Put an IoT spaces service": { - "$ref": "./examples/IoTSpacesPut_example.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/resourceName" - }, - { - "name": "iotSpaceDescription", - "in": "body", - "description": "The IoTSpaces instance metadata and security metadata.", - "required": true, - "schema": { - "$ref": "#/definitions/IoTSpacesDescription" - } - } - ], - "responses": { - "200": { - "description": "This is returned as a response to the status polling request for the create or update operation. The body contains the resource representation that indicates a transitional provisioning state.", - "schema": { - "$ref": "#/definitions/IoTSpacesDescription" - } - }, - "202": { - "description": "Accepted - Put request accepted; the operation will complete asynchronously." - }, - "default": { - "description": "DefaultErrorResponse", - "schema": { - "$ref": "#/definitions/ErrorDetails" - } - } - }, - "deprecated": false - }, - "patch": { - "tags": [ - "Resource" - ], - "description": "Update the metadata of a IoTSpaces instance.", - "operationId": "IoTSpaces_Update", - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Patch an IoT spaces service": { - "$ref": "./examples/IoTSpacesPatch_example.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/resourceName" - }, - { - "name": "iotSpacePatchDescription", - "in": "body", - "description": "The IoTSpaces instance metadata and security metadata.", - "required": true, - "schema": { - "$ref": "#/definitions/IoTSpacesPatchDescription" - } - } - ], - "responses": { - "200": { - "description": "This is returned as a response to the status polling request for the create or update operation. The body contains the resource representation that indicates a transitional provisioning state.", - "schema": { - "$ref": "#/definitions/IoTSpacesDescription" - } - }, - "202": { - "description": "Accepted - Put request accepted; the operation will complete asynchronously." - }, - "default": { - "description": "DefaultErrorResponse", - "schema": { - "$ref": "#/definitions/ErrorDetails" - } - } - }, - "deprecated": false - }, - "delete": { - "tags": [ - "Resource" - ], - "description": "Delete an IoTSpaces instance.", - "operationId": "IoTSpaces_Delete", - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Delete an IoT spaces service": { - "$ref": "./examples/IoTSpacesDelete_example.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/resourceName" - } - ], - "responses": { - "200": { - "description": "This is returned as a response to the status polling request for the delete operation. The body contains the resource representation that indicates a transitional provisioning state.", - "schema": { - "$ref": "#/definitions/IoTSpacesDescription" - } - }, - "202": { - "description": "Accepted - Delete request accepted; the operation will complete asynchronously." - }, - "204": { - "description": "Once the long running delete operation completes successfully, a 204 No Content status code is returned when the status polling request finds the IoTSpaces service metadata in the service and the status of the delete operation is set to a completed state." - }, - "default": { - "description": "DefaultErrorResponse", - "schema": { - "$ref": "#/definitions/ErrorDetails" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.IoTSpaces/Graph": { - "get": { - "tags": [ - "Collection" - ], - "description": "Get all the IoTSpaces instances in a subscription.", - "operationId": "IoTSpaces_List", - "x-ms-examples": { - "Get IoT spaces services by subscription": { - "$ref": "./examples/IoTSpacesList_example.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "parameters": [ - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "200": { - "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the IoTSpaces instances in the subscription.", - "schema": { - "$ref": "#/definitions/IoTSpacesDescriptionListResult" - } - }, - "default": { - "description": "DefaultErrorResponse", - "schema": { - "$ref": "#/definitions/ErrorDetails" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTSpaces/Graph": { - "get": { - "tags": [ - "Collection" - ], - "description": "Get all the IoTSpaces instances in a resource group.", - "operationId": "IoTSpaces_ListByResourceGroup", - "x-ms-examples": { - "Get IoT spaces services by resource group": { - "$ref": "./examples/IoTSpacesListByResourceGroup_example.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "parameters": [ - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - } - ], - "responses": { - "200": { - "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the IoTSpaces instances in the resource group.", - "schema": { - "$ref": "#/definitions/IoTSpacesDescriptionListResult" - } - }, - "default": { - "description": "DefaultErrorResponse", - "schema": { - "$ref": "#/definitions/ErrorDetails" - } - } - }, - "deprecated": false - } - }, - "/providers/Microsoft.IoTSpaces/operations": { - "get": { - "tags": [ - "Proxy" - ], - "description": "Lists all of the available IoTSpaces service REST API operations.", - "operationId": "Operations_List", - "x-ms-examples": { - "Get available operations": { - "$ref": "./examples/IoTSpacesOperationsList_example.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "parameters": [ - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - }, - "default": { - "description": "DefaultErrorResponse", - "schema": { - "$ref": "#/definitions/ErrorDetails" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.IoTSpaces/checkNameAvailability": { - "post": { - "tags": [ - "Proxy" - ], - "description": "Check if an IoTSpaces instance name is available.", - "operationId": "IoTSpaces_CheckNameAvailability", - "x-ms-examples": { - "Check name Availability": { - "$ref": "./examples/IoTSpacesCheckNameAvailability_example.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "operationInputs", - "in": "body", - "description": "Set the name parameter in the OperationInputs structure to the name of the IoTSpaces instance to check.", - "required": true, - "schema": { - "$ref": "#/definitions/OperationInputs" - } - } - ], - "responses": { - "200": { - "description": "This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the IoTSpaces service name is available. If the name is not available, the body contains the reason.", - "schema": { - "$ref": "#/definitions/IoTSpacesNameAvailabilityInfo" - } - }, - "default": { - "description": "DefaultErrorResponse", - "schema": { - "$ref": "#/definitions/ErrorDetails" - } - } - }, - "deprecated": false - } - } - }, - "definitions": { - "IoTSpacesProperties": { - "description": "The properties of an IoTSpaces instance.", - "type": "object", - "properties": { - "provisioningState": { - "description": "The provisioning state.", - "enum": [ - "Provisioning", - "Deleting", - "Succeeded", - "Failed", - "Canceled" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "provisioningState", - "modelAsString": true - } - }, - "managementApiUrl": { - "description": "The management Api endpoint.", - "type": "string", - "readOnly": true - }, - "webPortalUrl": { - "description": "The management UI endpoint.", - "type": "string", - "readOnly": true - }, - "storageContainer": { - "description": "The properties of the designated storage container.", - "$ref": "#/definitions/StorageContainerProperties" - } - } - }, - "StorageContainerProperties": { - "description": "The properties of the Azure Storage Container for file archive.", - "type": "object", - "properties": { - "connectionString": { - "description": "The connection string of the storage account.", - "type": "string" - }, - "subscriptionId": { - "description": "The subscription identifier of the storage account.", - "type": "string" - }, - "resourceGroup": { - "description": "The name of the resource group of the storage account.", - "type": "string" - }, - "containerName": { - "description": "The name of storage container in the storage account.", - "type": "string" - } - } - }, - "IoTSpacesSkuInfo": { - "description": "Information about the SKU of the IoTSpaces instance.", - "type": "object", - "properties": { - "name": { - "description": "The name of the SKU.", - "enum": [ - "F1", - "S1", - "S2", - "S3" - ], - "type": "string", - "x-ms-enum": { - "name": "IoTSpacesSku", - "modelAsString": true - } - } - }, - "required": [ - "name" - ] - }, - "IoTSpacesDescription": { - "description": "The description of the IoTSpaces service.", - "type": "object", - "properties": { - "properties": { - "description": "The common properties of a IoTSpaces service.", - "$ref": "#/definitions/IoTSpacesProperties" - }, - "sku": { - "description": "A valid instance SKU.", - "$ref": "#/definitions/IoTSpacesSkuInfo" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "required": [ - "sku" - ] - }, - "IoTSpacesPatchDescription": { - "description": "The description of the IoTSpaces service.", - "type": "object", - "properties": { - "tags": { - "description": "Instance tags", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "description": "The common properties of an IoTSpaces service.", - "$ref": "#/definitions/IoTSpacesProperties" - } - } - }, - "Resource": { - "description": "The common properties of an IoTSpaces service.", - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "The resource identifier." - }, - "name": { - "readOnly": true, - "type": "string", - "description": "The resource name.", - "pattern": "^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$" - }, - "type": { - "readOnly": true, - "type": "string", - "description": "The resource type." - }, - "location": { - "type": "string", - "description": "The resource location.", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "The resource tags." - } - }, - "x-ms-azure-resource": true, - "required": [ - "location" - ] - }, - "ErrorDetails": { - "description": "Error details.", - "type": "object", - "properties": { - "code": { - "description": "The error code.", - "type": "string", - "readOnly": true - }, - "message": { - "description": "The error message.", - "type": "string", - "readOnly": true - }, - "target": { - "description": "The target of the particular error.", - "type": "string", - "readOnly": true - } - } - }, - "IoTSpacesDescriptionListResult": { - "description": "A list of IoTSpaces description objects with a next link.", - "type": "object", - "properties": { - "nextLink": { - "description": "The link used to get the next page of IoTSpaces description objects.", - "type": "string" - }, - "value": { - "description": "A list of IoTSpaces description objects.", - "type": "array", - "items": { - "$ref": "#/definitions/IoTSpacesDescription" - } - } - } - }, - "OperationListResult": { - "description": "A list of IoTSpaces service operations. It contains a list of operations and a URL link to get the next set of results.", - "type": "object", - "properties": { - "nextLink": { - "description": "The link used to get the next page of IoTSpaces description objects.", - "type": "string" - }, - "value": { - "description": "A list of IoT spaces operations supported by the Microsoft.IoTSpaces resource provider.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Operation" - } - } - } - }, - "Operation": { - "description": "IoTSpaces service REST API operation", - "type": "object", - "properties": { - "name": { - "readOnly": true, - "type": "string", - "description": "Operation name: {provider}/{resource}/{read | write | action | delete}" - }, - "display": { - "$ref": "#/definitions/OperationDisplay" - } - } - }, - "OperationDisplay": { - "description": "The object that represents the operation.", - "type": "object", - "properties": { - "provider": { - "readOnly": true, - "type": "string", - "description": "Service provider: Microsoft IoTSpaces" - }, - "resource": { - "readOnly": true, - "type": "string", - "description": "Resource Type: IoTSpaces" - }, - "operation": { - "readOnly": true, - "type": "string", - "description": "Name of the operation" - }, - "description": { - "readOnly": true, - "type": "string", - "description": "Friendly description for the operation," - } - } - }, - "OperationInputs": { - "description": "Input values.", - "type": "object", - "properties": { - "name": { - "description": "The name of the IoTSpaces service instance to check.", - "type": "string" - } - }, - "required": [ - "name" - ] - }, - "IoTSpacesNameAvailabilityInfo": { - "description": "The properties indicating whether a given IoTSpaces service name is available.", - "type": "object", - "properties": { - "nameAvailable": { - "description": "The value which indicates whether the provided name is available.", - "type": "boolean", - "readOnly": true - }, - "reason": { - "description": "The reason for unavailability.", - "enum": [ - "Invalid", - "AlreadyExists" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "IoTSpacesNameUnavailabilityReason", - "modelAsString": false - } - }, - "message": { - "description": "The detailed reason message.", - "type": "string" - } - } - } - }, + "paths": {}, + "definitions": {}, "parameters": { "subscriptionId": { "name": "subscriptionId", diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/examples/GetKeyRotationPolicy-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/examples/GetKeyRotationPolicy-example.json new file mode 100644 index 000000000000..a811e1a71e74 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/examples/GetKeyRotationPolicy-example.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "key-name": "key01", + "api-version": "7.3-preview" + }, + "responses": { + "200": { + "body": { + "id": "https://myvault.vault.azure.net/keys/key01/rotationpolicy", + "lifetimeActions": [ + { + "trigger": { + "timeAfterCreate": "P90D" + }, + "action": { + "type": "rotate" + } + }, + { + "trigger": { + "timeBeforeExpiry": "P30D" + }, + "action": { + "type": "notify" + } + } + ], + "attributes": { + "expiryTime": "P2Y", + "created": 1482188947, + "updated": 1482188948 + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/examples/RotateKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/examples/RotateKey-example.json new file mode 100644 index 000000000000..9446ddf7bb9e --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/examples/RotateKey-example.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "key-name": "Key01", + "api-version": "7.3-preview" + }, + "responses": { + "200": { + "body": { + "key": { + "kid": "https://myvault.vault.azure.net/keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71", + "kty": "RSA", + "key_ops": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "n": "2HJAE5fU3Cw2Rt9hEuq-F6XjINKGa-zskfISVqopqUy60GOs2eyhxbWbJBeUXNor_gf-tXtNeuqeBgitLeVa640UDvnEjYTKWjCniTxZRaU7ewY8BfTSk-7KxoDdLsPSpX_MX4rwlAx-_1UGk5t4sQgTbm9T6Fm2oqFd37dsz5-Gj27UP2GTAShfJPFD7MqU_zIgOI0pfqsbNL5xTQVM29K6rX4jSPtylZV3uWJtkoQIQnrIHhk1d0SC0KwlBV3V7R_LVYjiXLyIXsFzSNYgQ68ZjAwt8iL7I8Osa-ehQLM13DVvLASaf7Jnu3sC3CWl3Gyirgded6cfMmswJzY87w", + "e": "AQAB" + }, + "attributes": { + "enabled": true, + "created": 1493942451, + "updated": 1493942451, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags": { + "purpose": "unit test", + "test name ": "CreateGetDeleteKeyTest" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/examples/UpdateKeyRotationPolicy-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/examples/UpdateKeyRotationPolicy-example.json new file mode 100644 index 000000000000..5de3b4d2eac9 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/examples/UpdateKeyRotationPolicy-example.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "key-name": "updateKey01", + "api-version": "7.3-preview", + "keyRotationPolicy": { + "lifetimeActions": [ + { + "trigger": { + "timeAfterCreate": "P90D" + }, + "action": { + "type": "rotate" + } + }, + { + "trigger": { + "timeBeforeExpiry": "P30D" + }, + "action": { + "type": "notify" + } + } + ], + "attributes": { + "expirationTime": "P2Y" + } + } + }, + "responses": { + "200": { + "body": { + "id": "https://myvault.vault.azure.net/keys/updateKey01/rotationpolicy", + "lifetimeActions": [ + { + "trigger": { + "timeAfterCreate": "P90D" + }, + "action": { + "type": "rotate" + } + }, + { + "trigger": { + "timeBeforeExpiry": "P30D" + }, + "action": { + "type": "notify" + } + } + ], + "attributes": { + "expiryTime": "P2Y", + "created": 1482188947, + "updated": 1482188948 + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/keys.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/keys.json index d44b16b7b785..9bbf7753554d 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/keys.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/keys.json @@ -79,6 +79,48 @@ } } }, + "/keys/{key-name}/rotate": { + "post": { + "tags": [ + "Keys" + ], + "operationId": "RotateKey", + "summary": "Creates a new key version, stores it, then returns key parameters, attributes and policy to the client.", + "description": "The operation will rotate the key based on the key policy. It requires the keys/rotate permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z-]+$", + "description": "The name of key to be rotated. The system will generate a new version in the specified key." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A key bundle containing the result of the rotate key request.", + "schema": { + "$ref": "#/definitions/KeyBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Rotate key": { + "$ref": "./examples/RotateKey-example.json" + } + } + } + }, "/keys/{key-name}": { "put": { "tags": [ @@ -1089,6 +1131,95 @@ } } }, + "/keys/{key-name}/rotationpolicy": { + "get": { + "tags": [ + "Keys" + ], + "operationId": "GetKeyRotationPolicy", + "summary": "Lists the policy for a key.", + "description": "The GetKeyRotationPolicy operation returns the specified key policy resources in the specified key vault. This operation requires the keys/get permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key in a given key vault." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The key rotation policy.", + "schema": { + "$ref": "#/definitions/KeyRotationPolicy" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "GetKeyRotationPolicy": { + "$ref": "./examples/GetKeyRotationPolicy-example.json" + } + } + }, + "put": { + "tags": [ + "keys" + ], + "operationId": "UpdateKeyRotationPolicy", + "summary": "Updates the rotation policy for a key.", + "description": "Set specified members in the key policy. Leave others as undefined. This operation requires the keys/update permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key in the given vault." + }, + { + "name": "keyRotationPolicy", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/KeyRotationPolicy" + }, + "description": "The policy for the key." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The policy for the key.", + "schema": { + "$ref": "#/definitions/KeyRotationPolicy" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "UpdateKeyRotationPolicy": { + "$ref": "./examples/UpdateKeyRotationPolicy-example.json" + } + } + } + }, "/rng": { "post": { "tags": [ @@ -1158,6 +1289,9 @@ "description": "The bytes encoded as a base64url string." } }, + "required": [ + "value" + ], "description": "The get random bytes response object containing the bytes." }, "KeyReleasePolicy": { @@ -2060,6 +2194,101 @@ }, "description": "The backup key result, containing the backup blob." }, + "KeyRotationPolicy": { + "properties": { + "id": { + "type": "string", + "description": "The key policy id.", + "readOnly": true + }, + "lifetimeActions": { + "type": "array", + "items": { + "$ref": "#/definitions/LifetimeActions" + }, + "description": "Actions that will be performed by Key Vault over the lifetime of a key. For preview, lifetimeActions can only have two items at maximum: one for rotate, one for notify. Notification time would be default to 30 days before expiry and it is not configurable." + }, + "attributes": { + "$ref": "#/definitions/KeyRotationPolicyAttributes", + "description": "The key rotation policy attributes." + } + }, + "description": "Management policy for a key." + }, + "LifetimeActions": { + "properties": { + "trigger": { + "$ref": "#/definitions/LifetimeActionsTrigger", + "description": "The condition that will execute the action." + }, + "action": { + "$ref": "#/definitions/LifetimeActionsType", + "description": "The action that will be executed." + } + }, + "description": "Action and its trigger that will be performed by Key Vault over the lifetime of a key." + }, + "LifetimeActionsTrigger": { + "properties": { + "timeAfterCreate": { + "type": "string", + "description": "Time after creation to attempt rotate. It will be in ISO 8601 format. Example: 90 days : \"P90D\" " + }, + "timeBeforeExpiry": { + "type": "string", + "description": "Time before expiry to attempt rotate. It will be in ISO 8601 format. Example: 90 days : \"P90D\"" + } + }, + "description": "A condition to be satisfied for an action to be executed." + }, + "LifetimeActionsType": { + "properties": { + "type": { + "type": "string", + "description": "The type of the action.", + "enum": [ + "rotate", + "notify" + ], + "x-ms-enum": { + "name": "ActionType", + "modelAsString": false, + "values": [ + { + "value": "rotate", + "description": "Rotate the key based on the key policy." + }, + { + "value": "notify", + "description": "Trigger event grid events. For preview, the notification time is not configurable and it is default to 30 days before expiry." + } + ] + } + } + }, + "description": "The action that will be executed." + }, + "KeyRotationPolicyAttributes": { + "properties": { + "expiryTime": { + "type": "string", + "description": "The expiryTime will be applied on the new key version. It should be at least 28 days. It will be in ISO 8601 Format. Examples: 90 days: P90D, 3 months: P3M, 48 hours: PT48H, 1 year and 10 days: P1Y10D" + }, + "created": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The key rotation policy created time in UTC." + }, + "updated": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The key rotation policy's last updated time in UTC." + } + }, + "description": "The key rotation policy attributes." + }, "KeyReleaseResult": { "properties": { "value": { diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/rbac.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/rbac.json index d4d03e0c151b..be47595f94bd 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/rbac.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/rbac.json @@ -443,8 +443,7 @@ "RoleAssignmentPropertiesWithScope": { "properties": { "scope": { - "type": "string", - "description": "The role assignment scope." + "$ref": "#/definitions/RoleScope" }, "roleDefinitionId": { "type": "string", @@ -524,7 +523,7 @@ "required": [ "properties" ], - "description": "Role definition creation parameters." + "description": "Role definition create parameters." }, "RoleAssignmentCreateParameters": { "properties": { @@ -536,7 +535,7 @@ "required": [ "properties" ], - "description": "Role assignment creation parameters." + "description": "Role assignment create parameters." }, "RoleDefinitionFilter": { "properties": { @@ -551,31 +550,32 @@ "properties": { "actions": { "type": "array", + "description": "Action permissions that are granted.", "items": { "type": "string" - }, - "description": "Allowed actions." + } }, "notActions": { "type": "array", + "description": "Action permissions that are excluded but not denied. They may be granted by other role definitions assigned to a principal.", "items": { - "type": "string" - }, - "description": "Denied actions." + "type": "string", + "description": "Not actions." + } }, "dataActions": { "type": "array", + "description": "Data action permissions that are granted.", "items": { - "type": "string" - }, - "description": "Allowed Data actions." + "$ref": "#/definitions/DataAction" + } }, "notDataActions": { "type": "array", + "description": "Data action permissions that are excluded but not denied. They may be granted by other role definitions assigned to a principal.", "items": { - "type": "string" - }, - "description": "Denied Data actions." + "$ref": "#/definitions/DataAction" + } } }, "description": "Role definition permissions." @@ -593,6 +593,25 @@ "type": { "type": "string", "description": "The role type.", + "enum": [ + "AKVBuiltInRole", + "CustomRole" + ], + "x-ms-enum": { + "name": "RoleType", + "modelAsString": true, + "values": [ + { + "name": "BuiltInRole", + "value": "AKVBuiltInRole", + "description": "Built in role." + }, + { + "value": "CustomRole", + "description": "Custom role." + } + ] + }, "x-ms-client-name": "roleType" }, "permissions": { @@ -605,7 +624,7 @@ "assignableScopes": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/RoleScope" }, "description": "Role definition assignable scopes." } @@ -626,8 +645,15 @@ }, "type": { "type": "string", + "description": "The role definition type.", "readOnly": true, - "description": "The role definition type." + "enum": [ + "Microsoft.Authorization/roleDefinitions" + ], + "x-ms-enum": { + "name": "RoleDefinitionType", + "modelAsString": true + } }, "properties": { "x-ms-client-flatten": true, @@ -652,6 +678,246 @@ } }, "description": "Role definition list operation result." + }, + "RoleScope": { + "type": "string", + "description": "The role scope.", + "enum": [ + "/", + "/keys" + ], + "x-ms-enum": { + "name": "RoleScope", + "modelAsString": true, + "values": [ + { + "name": "Global", + "value": "/", + "description": "Global scope" + }, + { + "name": "Keys", + "value": "/keys", + "description": "Keys scope" + } + ] + } + }, + "DataAction": { + "type": "string", + "description": "Supported permissions for data actions.", + "enum": [ + "Microsoft.KeyVault/managedHsm/keys/read/action", + "Microsoft.KeyVault/managedHsm/keys/write/action", + "Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action", + "Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action", + "Microsoft.KeyVault/managedHsm/keys/backup/action", + "Microsoft.KeyVault/managedHsm/keys/restore/action", + "Microsoft.KeyVault/managedHsm/roleAssignments/delete/action", + "Microsoft.KeyVault/managedHsm/roleAssignments/read/action", + "Microsoft.KeyVault/managedHsm/roleAssignments/write/action", + "Microsoft.KeyVault/managedHsm/roleDefinitions/read/action", + "Microsoft.KeyVault/managedHsm/roleDefinitions/write/action", + "Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action", + "Microsoft.KeyVault/managedHsm/keys/encrypt/action", + "Microsoft.KeyVault/managedHsm/keys/decrypt/action", + "Microsoft.KeyVault/managedHsm/keys/wrap/action", + "Microsoft.KeyVault/managedHsm/keys/unwrap/action", + "Microsoft.KeyVault/managedHsm/keys/sign/action", + "Microsoft.KeyVault/managedHsm/keys/verify/action", + "Microsoft.KeyVault/managedHsm/keys/create", + "Microsoft.KeyVault/managedHsm/keys/delete", + "Microsoft.KeyVault/managedHsm/keys/export/action", + "Microsoft.KeyVault/managedHsm/keys/release/action", + "Microsoft.KeyVault/managedHsm/keys/import/action", + "Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete", + "Microsoft.KeyVault/managedHsm/securitydomain/download/action", + "Microsoft.KeyVault/managedHsm/securitydomain/download/read", + "Microsoft.KeyVault/managedHsm/securitydomain/upload/action", + "Microsoft.KeyVault/managedHsm/securitydomain/upload/read", + "Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read", + "Microsoft.KeyVault/managedHsm/backup/start/action", + "Microsoft.KeyVault/managedHsm/restore/start/action", + "Microsoft.KeyVault/managedHsm/backup/status/action", + "Microsoft.KeyVault/managedHsm/restore/status/action", + "Microsoft.KeyVault/managedHsm/rng/action" + ], + "x-ms-enum": { + "name": "DataAction", + "modelAsString": true, + "values": [ + { + "name": "ReadHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/read/action", + "description": "Read HSM key metadata." + }, + { + "name": "WriteHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/write/action", + "description": "Update an HSM key." + }, + { + "name": "ReadDeletedHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action", + "description": "Read deleted HSM key." + }, + { + "name": "RecoverDeletedHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action", + "description": "Recover deleted HSM key." + }, + { + "name": "BackupHsmKeys", + "value": "Microsoft.KeyVault/managedHsm/keys/backup/action", + "description": "Backup HSM keys." + }, + { + "name": "RestoreHsmKeys", + "value": "Microsoft.KeyVault/managedHsm/keys/restore/action", + "description": "Restore HSM keys." + }, + { + "name": "DeleteRoleAssignment", + "value": "Microsoft.KeyVault/managedHsm/roleAssignments/delete/action", + "description": "Delete role assignment." + }, + { + "name": "GetRoleAssignment", + "value": "Microsoft.KeyVault/managedHsm/roleAssignments/read/action", + "description": "Get role assignment." + }, + { + "name": "WriteRoleAssignment", + "value": "Microsoft.KeyVault/managedHsm/roleAssignments/write/action", + "description": "Create or update role assignment." + }, + { + "name": "ReadRoleDefinition", + "value": "Microsoft.KeyVault/managedHsm/roleDefinitions/read/action", + "description": "Get role definition." + }, + { + "name": "WriteRoleDefinition", + "value": "Microsoft.KeyVault/managedHsm/roleDefinitions/write/action", + "description": "Create or update role definition." + }, + { + "name": "DeleteRoleDefinition", + "value": "Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action", + "description": "Delete role definition." + }, + { + "name": "EncryptHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/encrypt/action", + "description": "Encrypt using an HSM key." + }, + { + "name": "DecryptHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/decrypt/action", + "description": "Decrypt using an HSM key." + }, + { + "name": "WrapHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/wrap/action", + "description": "Wrap using an HSM key." + }, + { + "name": "UnwrapHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/unwrap/action", + "description": "Unwrap using an HSM key." + }, + { + "name": "SignHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/sign/action", + "description": "Sign using an HSM key." + }, + { + "name": "VerifyHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/verify/action", + "description": "Verify using an HSM key." + }, + { + "name": "CreateHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/create", + "description": "Create an HSM key." + }, + { + "name": "DeleteHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/delete", + "description": "Delete an HSM key." + }, + { + "name": "ExportHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/export/action", + "description": "Export an HSM key." + }, + { + "name": "ReleaseKey", + "value": "Microsoft.KeyVault/managedHsm/keys/release/action", + "description": "Release an HSM key using Secure Key Release." + }, + { + "name": "ImportHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/import/action", + "description": "Import an HSM key." + }, + { + "name": "PurgeDeletedHsmKey", + "value": "Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete", + "description": "Purge a deleted HSM key." + }, + { + "name": "DownloadHsmSecurityDomain", + "value": "Microsoft.KeyVault/managedHsm/securitydomain/download/action", + "description": "Download an HSM security domain." + }, + { + "name": "DownloadHsmSecurityDomainStatus", + "value": "Microsoft.KeyVault/managedHsm/securitydomain/download/read", + "description": "Check status of HSM security domain download." + }, + { + "name": "UploadHsmSecurityDomain", + "value": "Microsoft.KeyVault/managedHsm/securitydomain/upload/action", + "description": "Upload an HSM security domain." + }, + { + "name": "ReadHsmSecurityDomainStatus", + "value": "Microsoft.KeyVault/managedHsm/securitydomain/upload/read", + "description": "Check the status of the HSM security domain exchange file." + }, + { + "name": "ReadHsmSecurityDomainTransferKey", + "value": "Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read", + "description": "Download an HSM security domain transfer key." + }, + { + "name": "StartHsmBackup", + "value": "Microsoft.KeyVault/managedHsm/backup/start/action", + "description": "Start an HSM backup." + }, + { + "name": "StartHsmRestore", + "value": "Microsoft.KeyVault/managedHsm/restore/start/action", + "description": "Start an HSM restore." + }, + { + "name": "ReadHsmBackupStatus", + "value": "Microsoft.KeyVault/managedHsm/backup/status/action", + "description": "Read an HSM backup status." + }, + { + "name": "ReadHsmRestoreStatus", + "value": "Microsoft.KeyVault/managedHsm/restore/status/action", + "description": "Read an HSM restore status." + }, + { + "name": "RandomNumbersGenerate", + "value": "Microsoft.KeyVault/managedHsm/rng/action", + "description": "Generate random numbers." + } + ] + } } }, "parameters": { diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.2/rbac.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.2/rbac.json index 2a14101e482f..9869b2c145b0 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.2/rbac.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.2/rbac.json @@ -717,6 +717,8 @@ "Microsoft.KeyVault/managedHsm/roleAssignments/read/action", "Microsoft.KeyVault/managedHsm/roleAssignments/write/action", "Microsoft.KeyVault/managedHsm/roleDefinitions/read/action", + "Microsoft.KeyVault/managedHsm/roleDefinitions/write/action", + "Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action", "Microsoft.KeyVault/managedHsm/keys/encrypt/action", "Microsoft.KeyVault/managedHsm/keys/decrypt/action", "Microsoft.KeyVault/managedHsm/keys/wrap/action", @@ -791,6 +793,16 @@ "value": "Microsoft.KeyVault/managedHsm/roleDefinitions/read/action", "description": "Get role definition." }, + { + "name": "WriteRoleDefinition", + "value": "Microsoft.KeyVault/managedHsm/roleDefinitions/write/action", + "description": "Create or update role definition." + }, + { + "name": "DeleteRoleDefinition", + "value": "Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action", + "description": "Delete role definition." + }, { "name": "EncryptHsmKey", "value": "Microsoft.KeyVault/managedHsm/keys/encrypt/action", diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2020-04-01-preview/keyvault.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2020-04-01-preview/keyvault.json index 877528deed41..e9052649a12d 100644 --- a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2020-04-01-preview/keyvault.json +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2020-04-01-preview/keyvault.json @@ -1260,7 +1260,7 @@ "enableRbacAuthorization": { "type": "boolean", "default": false, - "description": "Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored (warning: this is a preview feature). When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the vault is created with the default value of false. Note that management actions are always authorized with RBAC." + "description": "Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored. When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the vault is created with the default value of false. Note that management actions are always authorized with RBAC." }, "createMode": { "type": "string", @@ -1345,7 +1345,7 @@ }, "enableRbacAuthorization": { "type": "boolean", - "description": "Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored (warning: this is a preview feature). When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the value of this property will not change." + "description": "Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored. When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the value of this property will not change." }, "softDeleteRetentionInDays": { "type": "integer", @@ -1783,6 +1783,10 @@ "type": "string", "description": "Id of private endpoint connection." }, + "etag": { + "type": "string", + "description": "Modified whenever there is a change in the state of private endpoint connection." + }, "properties": { "$ref": "#/definitions/PrivateEndpointConnectionProperties", "x-ms-client-flatten": true, diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/createKey.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/createKey.json new file mode 100644 index 000000000000..5524232b01bf --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/createKey.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "vaultName": "sample-vault-name", + "keyName": "sample-key-name", + "api-version": "2021-04-01-preview", + "parameters": { + "properties": { + "kty": "RSA" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault-name/keys/sample-key-name", + "name": "sample-key-name", + "type": "Microsoft.KeyVault/vaults/keys", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1598533051, + "updated": 1598533051, + "recoveryLevel": "Purgeable" + }, + "kty": "RSA", + "keyOps": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "keySize": 2048, + "keyUri": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name", + "keyUriWithVersion": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name/fd618d9519b74f9aae94ade66b876acc" + } + } + }, + "default": { + "headers": {}, + "body": { + "error": { + "code": "", + "message": "" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/createVault.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/createVault.json index 11ff6d983fef..100de9b5c198 100644 --- a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/createVault.json +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/createVault.json @@ -265,24 +265,6 @@ "provisioningState": "Succeeded" } } - }, - "400": { - "headers": {}, - "body": { - "error": { - "code": "", - "message": "" - } - } - }, - "409": { - "headers": {}, - "body": { - "error": { - "code": "", - "message": "" - } - } } } } diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/createVaultWithNetworkAcls.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/createVaultWithNetworkAcls.json index 2694b2d4a3db..c247e3597eb4 100644 --- a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/createVaultWithNetworkAcls.json +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/createVaultWithNetworkAcls.json @@ -127,24 +127,6 @@ "vaultUri": "https://sample-vault.vault.azure.net" } } - }, - "400": { - "headers": {}, - "body": { - "error": { - "code": "", - "message": "" - } - } - }, - "409": { - "headers": {}, - "body": { - "error": { - "code": "", - "message": "" - } - } } } } diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/deleteVault.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/deleteVault.json index c33aa9dbd5de..73f9b5320d62 100644 --- a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/deleteVault.json +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/deleteVault.json @@ -11,15 +11,6 @@ }, "204": { "headers": {} - }, - "400": { - "headers": {}, - "body": { - "error": { - "code": "", - "message": "" - } - } } } } diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/getKey.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/getKey.json new file mode 100644 index 000000000000..042d8d8276cd --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/getKey.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "vaultName": "sample-vault-name", + "keyName": "sample-key-name", + "api-version": "2021-04-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault-name/keys/sample-key-name", + "name": "sample-key-name", + "type": "Microsoft.KeyVault/vaults/keys", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1598533051, + "updated": 1598533051, + "recoveryLevel": "Purgeable" + }, + "kty": "RSA", + "keyOps": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "keySize": 2048, + "keyUri": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name", + "keyUriWithVersion": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name/fd618d9519b74f9aae94ade66b876acc" + } + } + }, + "default": { + "headers": {}, + "body": { + "error": { + "code": "", + "message": "" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/getKeyVersion.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/getKeyVersion.json new file mode 100644 index 000000000000..5ac40ea13ce2 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/getKeyVersion.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "vaultName": "sample-vault-name", + "keyName": "sample-key-name", + "keyVersion": "fd618d9519b74f9aae94ade66b876acc", + "api-version": "2021-04-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault-name/keys/sample-key-name/versions/fd618d9519b74f9aae94ade66b876acc", + "name": "fd618d9519b74f9aae94ade66b876acc", + "type": "Microsoft.KeyVault/vaults/keys/versions", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1598533051, + "updated": 1598533051, + "recoveryLevel": "Purgeable" + }, + "kty": "RSA", + "keyOps": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "keySize": 2048, + "keyUri": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name", + "keyUriWithVersion": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name/fd618d9519b74f9aae94ade66b876acc" + } + } + }, + "default": { + "headers": {}, + "body": { + "error": { + "code": "", + "message": "" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/listKeyVersions.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/listKeyVersions.json new file mode 100644 index 000000000000..207aa53a9a1e --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/listKeyVersions.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "vaultName": "sample-vault-name", + "keyName": "sample-key-name", + "api-version": "2021-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault-name/keys/sample-key-name/versions/c2296aa24acf4daf86942bff5aca73dd", + "name": "c2296aa24acf4daf86942bff5aca73dd", + "type": "Microsoft.KeyVault/vaults/keys/versions", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1598641074, + "updated": 1598641074, + "recoveryLevel": "Purgeable" + }, + "keyUri": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name", + "keyUriWithVersion": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name/c2296aa24acf4daf86942bff5aca73dd" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault-name/keys/sample-key-name/versions/d5a04667b6f44b0ca62825f5eae93da6", + "name": "d5a04667b6f44b0ca62825f5eae93da6", + "type": "Microsoft.KeyVault/vaults/keys/versions", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1598641295, + "updated": 1598641295, + "recoveryLevel": "Purgeable" + }, + "keyUri": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name", + "keyUriWithVersion": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name/d5a04667b6f44b0ca62825f5eae93da6" + } + } + ] + } + }, + "default": { + "headers": {}, + "body": { + "error": { + "code": "", + "message": "" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/listKeys.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/listKeys.json new file mode 100644 index 000000000000..c64851348641 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/listKeys.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "vaultName": "sample-vault-name", + "api-version": "2021-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault-name/keys/sample-key-name-1", + "name": "sample-key-name-1", + "type": "Microsoft.KeyVault/vaults/keys", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1596493796, + "updated": 1596493796, + "recoveryLevel": "Purgeable" + }, + "keyUri": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name-1" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault-name/keys/sample-key-name-2", + "name": "sample-key-name-2", + "type": "Microsoft.KeyVault/vaults/keys", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1596493797, + "updated": 1596493797, + "recoveryLevel": "Purgeable" + }, + "keyUri": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name-2" + } + } + ] + } + }, + "default": { + "headers": {}, + "body": { + "error": { + "code": "", + "message": "" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/purgeDeletedVault.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/purgeDeletedVault.json index 1b3308e1ae9a..7141f4f20424 100644 --- a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/purgeDeletedVault.json +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/purgeDeletedVault.json @@ -12,15 +12,6 @@ "202": { "headers": {} }, - "400": { - "headers": {}, - "body": { - "error": { - "code": "", - "message": "" - } - } - }, "404": { "headers": {}, "body": { diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/updateAccessPoliciesAdd.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/updateAccessPoliciesAdd.json index eb488048b3f3..97c20be93866 100644 --- a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/updateAccessPoliciesAdd.json +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/updateAccessPoliciesAdd.json @@ -78,15 +78,6 @@ } } }, - "400": { - "headers": {}, - "body": { - "error": { - "code": "", - "message": "" - } - } - }, "404": { "headers": {}, "body": { @@ -95,15 +86,6 @@ "message": "" } } - }, - "409": { - "headers": {}, - "body": { - "error": { - "code": "", - "message": "" - } - } } } } diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/updateVault.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/updateVault.json index cc307b3f0ca4..b52c06bb7df8 100644 --- a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/updateVault.json +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/examples/updateVault.json @@ -263,24 +263,6 @@ "provisioningState": "Succeeded" } } - }, - "400": { - "headers": {}, - "body": { - "error": { - "code": "", - "message": "" - } - } - }, - "409": { - "headers": {}, - "body": { - "error": { - "code": "", - "message": "" - } - } } } } diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/keys.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/keys.json new file mode 100644 index 000000000000..31deba9a7489 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/keys.json @@ -0,0 +1,636 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-04-01-preview", + "title": "KeyVaultManagementClient", + "description": "The Azure management API provides a RESTful set of web services that interact with Azure Key Vault." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/keys/{keyName}": { + "put": { + "tags": [ + "Keys" + ], + "operationId": "Keys_CreateIfNotExist", + "description": "Creates the first version of a new key if it does not exist. If it already exists, then the existing key is returned without any write operations being performed. This API does not create subsequent versions, and does not update existing keys.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group which contains the specified key vault." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$", + "description": "The name of the key vault which contains the key to be created." + }, + { + "name": "keyName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{1,127}$", + "description": "The name of the key to be created." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/KeyCreateParameters" + }, + "description": "The parameters used to create the specified key." + } + ], + "responses": { + "200": { + "description": "The created key.", + "schema": { + "$ref": "#/definitions/Key" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a key": { + "$ref": "./examples/createKey.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "get": { + "tags": [ + "Keys" + ], + "operationId": "Keys_Get", + "description": "Gets the current version of the specified key from the specified key vault.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group which contains the specified key vault." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$", + "description": "The name of the vault which contains the key to be retrieved." + }, + { + "name": "keyName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{1,127}$", + "description": "The name of the key to be retrieved." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved key.", + "schema": { + "$ref": "#/definitions/Key" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a key": { + "$ref": "./examples/getKey.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/keys": { + "get": { + "tags": [ + "Keys" + ], + "operationId": "Keys_List", + "description": "Lists the keys in the specified key vault.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group which contains the specified key vault." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$", + "description": "The name of the vault which contains the keys to be retrieved." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved page of keys.", + "schema": { + "$ref": "#/definitions/KeyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List keys in the vault": { + "$ref": "./examples/listKeys.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/keys/{keyName}/versions/{keyVersion}": { + "get": { + "tags": [ + "Keys" + ], + "operationId": "Keys_GetVersion", + "description": "Gets the specified version of the specified key in the specified key vault.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group which contains the specified key vault." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$", + "description": "The name of the vault which contains the key version to be retrieved." + }, + { + "name": "keyName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{1,127}$", + "description": "The name of the key version to be retrieved." + }, + { + "name": "keyVersion", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-fA-F0-9]{32}$", + "description": "The version of the key to be retrieved." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved key version.", + "schema": { + "$ref": "#/definitions/Key" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a key version": { + "$ref": "./examples/getKeyVersion.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/keys/{keyName}/versions": { + "get": { + "tags": [ + "Keys" + ], + "operationId": "Keys_ListVersions", + "description": "Lists the versions of the specified key in the specified key vault.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group which contains the specified key vault." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$", + "description": "The name of the vault which contains the key versions to be retrieved." + }, + { + "name": "keyName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{1,127}$", + "description": "The name of the key versions to be retrieved." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved page of key versions.", + "schema": { + "$ref": "#/definitions/KeyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List key versions in the vault": { + "$ref": "./examples/listKeyVersions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + } + }, + "definitions": { + "KeyProperties": { + "properties": { + "attributes": { + "$ref": "#/definitions/KeyAttributes", + "description": "The attributes of the key." + }, + "kty": { + "type": "string", + "minLength": 1, + "description": "The type of the key. For valid values, see JsonWebKeyType.", + "enum": [ + "EC", + "EC-HSM", + "RSA", + "RSA-HSM" + ], + "x-ms-enum": { + "name": "JsonWebKeyType", + "modelAsString": true + } + }, + "keyOps": { + "type": "array", + "items": { + "type": "string", + "description": "The permitted JSON web key operations of the key. For more information, see JsonWebKeyOperation.", + "enum": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey", + "import" + ], + "x-ms-enum": { + "name": "JsonWebKeyOperation", + "modelAsString": true + } + } + }, + "keySize": { + "type": "integer", + "format": "int32", + "description": "The key size in bits. For example: 2048, 3072, or 4096 for RSA." + }, + "curveName": { + "type": "string", + "description": "The elliptic curve name. For valid values, see JsonWebKeyCurveName.", + "enum": [ + "P-256", + "P-384", + "P-521", + "P-256K" + ], + "x-ms-enum": { + "name": "JsonWebKeyCurveName", + "modelAsString": true + } + }, + "keyUri": { + "type": "string", + "description": "The URI to retrieve the current version of the key.", + "readOnly": true + }, + "keyUriWithVersion": { + "type": "string", + "description": "The URI to retrieve the specific version of the key.", + "readOnly": true + }, + "rotationPolicy": { + "$ref": "#/definitions/RotationPolicy", + "description": "Key rotation policy in response. It will be used for both output and input. Omitted if empty" + } + }, + "description": "The properties of the key." + }, + "KeyAttributes": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Determines whether or not the object is enabled." + }, + "nbf": { + "x-ms-client-name": "NotBefore", + "type": "integer", + "format": "int64", + "description": "Not before date in seconds since 1970-01-01T00:00:00Z." + }, + "exp": { + "x-ms-client-name": "Expires", + "type": "integer", + "format": "int64", + "description": "Expiry date in seconds since 1970-01-01T00:00:00Z." + }, + "created": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Creation time in seconds since 1970-01-01T00:00:00Z." + }, + "updated": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Last updated time in seconds since 1970-01-01T00:00:00Z." + }, + "recoveryLevel": { + "type": "string", + "description": "The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval.", + "enum": [ + "Purgeable", + "Recoverable+Purgeable", + "Recoverable", + "Recoverable+ProtectedSubscription" + ], + "x-ms-enum": { + "name": "DeletionRecoveryLevel", + "modelAsString": true + }, + "readOnly": true, + "x-nullable": false + } + }, + "description": "The object attributes managed by the Azure Key Vault service." + }, + "KeyCreateParameters": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags that will be assigned to the key." + }, + "properties": { + "$ref": "#/definitions/KeyProperties", + "description": "The properties of the key to be created." + } + }, + "description": "The parameters used to create a key.", + "required": [ + "properties" + ], + "x-ms-azure-resource": true + }, + "Key": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/KeyProperties", + "description": "The properties of the key." + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "./keyvault.json#/definitions/Resource" + } + ], + "description": "The key resource." + }, + "KeyListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Key" + }, + "description": "The key resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next page of keys." + } + }, + "description": "The page of keys." + }, + "RotationPolicy": { + "properties": { + "attributes": { + "$ref": "#/definitions/KeyRotationPolicyAttributes", + "description": "The attributes of key rotation policy." + }, + "lifetimeActions": { + "type": "array", + "items": { + "$ref": "#/definitions/LifetimeAction" + }, + "description": "The lifetimeActions for key rotation action." + } + } + }, + "KeyRotationPolicyAttributes": { + "properties": { + "created": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Creation time in seconds since 1970-01-01T00:00:00Z." + }, + "updated": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Last updated time in seconds since 1970-01-01T00:00:00Z." + }, + "expiryTime": { + "type": "string", + "description": "The expiration time for the new key version. It should be in ISO8601 format. Eg: 'P90D', 'P1Y'." + } + } + }, + "LifetimeAction": { + "properties": { + "trigger": { + "$ref": "#/definitions/Trigger", + "description": "The trigger of key rotation policy lifetimeAction." + }, + "action": { + "$ref": "#/definitions/Action", + "description": "The action of key rotation policy lifetimeAction." + } + } + }, + "Trigger": { + "properties": { + "timeAfterCreate": { + "type": "string", + "description": "The time duration after key creation to rotate the key. It should be in ISO8601 format. Eg: 'P90D', 'P1Y'." + }, + "timeBeforeExpiry": { + "type": "string", + "description": "The time duration before key expiring to rotate the key. It should be in ISO8601 format. Eg: 'P90D', 'P1Y'." + } + } + }, + "Action": { + "properties": { + "type": { + "type": "string", + "description": "The type of action.", + "enum": [ + "rotate", + "notify" + ], + "x-ms-enum": { + "name": "KeyRotationPolicyActionType", + "modelAsString": false + } + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + }, + "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" + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json index b262450c4d41..30e1f92f72a5 100644 --- a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json @@ -63,20 +63,6 @@ "$ref": "#/definitions/Vault" } }, - "400": { - "description": "Bad request.", - "schema": { - "$ref": "common.json#/definitions/CloudError" - }, - "x-ms-error-response": true - }, - "409": { - "description": "A conflict occurred to prevent the operation from completing.", - "schema": { - "$ref": "common.json#/definitions/CloudError" - }, - "x-ms-error-response": true - }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -150,20 +136,6 @@ "$ref": "#/definitions/Vault" } }, - "400": { - "description": "Bad request.", - "schema": { - "$ref": "common.json#/definitions/CloudError" - }, - "x-ms-error-response": true - }, - "409": { - "description": "A conflict occurred to prevent the operation from completing.", - "schema": { - "$ref": "common.json#/definitions/CloudError" - }, - "x-ms-error-response": true - }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -218,13 +190,6 @@ "204": { "description": "No Content." }, - "400": { - "description": "Bad request.", - "schema": { - "$ref": "common.json#/definitions/CloudError" - }, - "x-ms-error-response": true - }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -367,13 +332,6 @@ "$ref": "#/definitions/VaultAccessPolicyParameters" } }, - "400": { - "description": "Bad request.", - "schema": { - "$ref": "common.json#/definitions/CloudError" - }, - "x-ms-error-response": true - }, "404": { "description": "The specified resource does not exist.", "schema": { @@ -381,13 +339,6 @@ }, "x-ms-error-response": true }, - "409": { - "description": "A conflict occurred to prevent the operation from completing.", - "schema": { - "$ref": "common.json#/definitions/CloudError" - }, - "x-ms-error-response": true - }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -657,13 +608,6 @@ "202": { "description": "Vault is being purged." }, - "400": { - "description": "Bad request.", - "schema": { - "$ref": "common.json#/definitions/CloudError" - }, - "x-ms-error-response": true - }, "404": { "description": "The specified resource does not exist.", "schema": { @@ -1171,7 +1115,8 @@ "backup", "restore", "recover", - "purge" + "purge", + "release" ], "x-ms-enum": { "name": "KeyPermissions", @@ -1313,7 +1258,7 @@ "enableRbacAuthorization": { "type": "boolean", "default": false, - "description": "Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored (warning: this is a preview feature). When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the vault is created with the default value of false. Note that management actions are always authorized with RBAC." + "description": "Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored. When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the vault is created with the default value of false. Note that management actions are always authorized with RBAC." }, "createMode": { "type": "string", @@ -1402,7 +1347,7 @@ }, "enableRbacAuthorization": { "type": "boolean", - "description": "Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored (warning: this is a preview feature). When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the value of this property will not change." + "description": "Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored. When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the value of this property will not change." }, "softDeleteRetentionInDays": { "type": "integer", diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/common.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/common.json new file mode 100644 index 000000000000..f96384a3b2d8 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/common.json @@ -0,0 +1,91 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01-preview", + "title": "KeyVaultManagementClient", + "description": "The Azure management API provides a RESTful set of web services that interact with Azure Key Vault." + }, + "paths": {}, + "definitions": { + "CloudError": { + "description": "An error response from Key Vault resource provider", + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "x-ms-external": true + }, + "CloudErrorBody": { + "description": "An error response from Key Vault resource provider", + "properties": { + "code": { + "type": "string", + "description": "Error code. This is a mnemonic that can be consumed programmatically." + }, + "message": { + "type": "string", + "description": "User friendly error message. The message is typically localized and may vary with service version." + } + }, + "x-ms-external": true + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the key vault resource.", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the key vault resource." + }, + "createdByType": { + "description": "The type of identity that created the key vault resource.", + "$ref": "#/definitions/IdentityType" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the key vault resource creation (UTC)." + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the key vault resource." + }, + "lastModifiedByType": { + "description": "The type of identity that last modified the key vault resource.", + "$ref": "#/definitions/IdentityType" + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the key vault resource last modification (UTC)." + } + } + }, + "IdentityType": { + "type": "string", + "description": "The type of identity.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "identityType", + "modelAsString": true + } + } + }, + "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" + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/DeletedManagedHsm_Get.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/DeletedManagedHsm_Get.json new file mode 100644 index 000000000000..13afc05dba55 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/DeletedManagedHsm_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "name": "hsm1", + "location": "westus", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/deletedManagedHSMs/hsm1", + "name": "vault-agile-drawer-6404", + "type": "Microsoft.KeyVault/deletedManagedHSMs", + "properties": { + "mhsmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1", + "location": "westus", + "deletionDate": "2021-04-01T00:00:59Z", + "scheduledPurgeDate": "2021-04-01T00:00:59Z", + "purgeProtectionEnabled": true, + "tags": { + "Dept": "hsm", + "Environment": "production" + } + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/DeletedManagedHsm_List.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/DeletedManagedHsm_List.json new file mode 100644 index 000000000000..32dc0e88162e --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/DeletedManagedHsm_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/deletedManagedHSMs/hsm1", + "name": "vault-agile-drawer-6404", + "type": "Microsoft.KeyVault/deletedManagedHSMs", + "properties": { + "mhsmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1", + "location": "westus", + "deletionDate": "2021-04-01T00:00:59Z", + "scheduledPurgeDate": "2021-04-01T00:00:59Z", + "purgeProtectionEnabled": true, + "tags": { + "Dept": "hsm", + "Environment": "production" + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/deletedManagedHSMs/hsm2", + "name": "vault-agile-drawer-6404", + "type": "Microsoft.KeyVault/deletedManagedHSMs", + "properties": { + "mhsmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm2", + "location": "westus", + "deletionDate": "2021-04-01T00:00:59Z", + "scheduledPurgeDate": "2021-04-01T00:00:59Z", + "purgeProtectionEnabled": true, + "tags": { + "Dept": "hsm", + "Environment": "production" + } + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/deletedManagedHSMs?api-version=2021-06-01-preview&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng==" + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/DeletedManagedHsm_Purge.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/DeletedManagedHsm_Purge.json new file mode 100644 index 000000000000..78fb0cc8e1ba --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/DeletedManagedHsm_Purge.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "name": "hsm1", + "location": "westus", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": {} + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_CreateOrUpdate.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_CreateOrUpdate.json new file mode 100644 index 000000000000..4a274071cf20 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_CreateOrUpdate.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "resourceGroupName": "hsm-group", + "name": "hsm1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01-preview", + "parameters": { + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "initialAdminObjectIds": [ + "00000000-0000-0000-0000-000000000000" + ], + "enableSoftDelete": true, + "softDeleteRetentionInDays": 90, + "enablePurgeProtection": true + }, + "location": "westus", + "sku": { + "family": "B", + "name": "Standard_B1" + }, + "tags": { + "Dept": "hsm", + "Environment": "dogfood" + } + } + }, + "responses": { + "202": { + "body": { + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "initialAdminObjectIds": [ + "00000000-0000-0000-0000-000000000000" + ], + "enableSoftDelete": true, + "softDeleteRetentionInDays": 90, + "enablePurgeProtection": true, + "hsmUri": null, + "provisioningState": "Provisioning", + "statusMessage": "Allocating hardware" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1", + "name": "hsm1", + "type": "Microsoft.KeyVault/managedHSMs", + "location": "westus", + "sku": { + "family": "B", + "name": "Standard_B1" + }, + "tags": { + "Dept": "hsm", + "Environment": "dogfood" + } + } + }, + "200": { + "body": { + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "initialAdminObjectIds": [ + "00000000-0000-0000-0000-000000000000" + ], + "enableSoftDelete": true, + "softDeleteRetentionInDays": 90, + "enablePurgeProtection": true, + "hsmUri": "https://westus.hsm1.managedhsm.azure.net", + "provisioningState": "Succeeded", + "statusMessage": "ManagedHsm is functional." + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1", + "name": "hsm1", + "type": "Microsoft.KeyVault/managedHSMs", + "location": "westus", + "sku": { + "family": "B", + "name": "Standard_B1" + }, + "tags": { + "Dept": "hsm", + "Environment": "dogfood" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_Delete.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_Delete.json new file mode 100644 index 000000000000..caea168ce0a7 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "resourceGroupName": "hsm-group", + "name": "hsm1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_Get.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_Get.json new file mode 100644 index 000000000000..8d4221f09c6a --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_Get.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "resourceGroupName": "hsm-group", + "name": "hsm1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "initialAdminObjectIds": [ + "00000000-0000-0000-0000-000000000000" + ], + "enableSoftDelete": true, + "softDeleteRetentionInDays": 90, + "enablePurgeProtection": true, + "hsmUri": "https://westus.hsm1.managedhsm.azure.net", + "provisioningState": "Succeeded", + "statusMessage": "ManagedHsm is functional." + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1", + "name": "hsm1", + "type": "Microsoft.KeyVault/managedHSMs", + "location": "westus", + "sku": { + "family": "B", + "name": "Standard_B1" + }, + "tags": { + "Dept": "hsm", + "Environment": "dogfood" + } + } + }, + "202": { + "headers": { + "Retry-After": "60", + "Location": "https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1?api-version=2021-06-01-preview&kv-operation=abJjb2RkIjoiAGVsZXRlTWFuYWdlZEhzbUFzeW5jYm9" + } + }, + "204": {} + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_ListByResourceGroup.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_ListByResourceGroup.json new file mode 100644 index 000000000000..017a0148f1db --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_ListByResourceGroup.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "resourceGroupName": "hsm-group", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "initialAdminObjectIds": [ + "00000000-0000-0000-0000-000000000000" + ], + "enableSoftDelete": true, + "softDeleteRetentionInDays": 90, + "enablePurgeProtection": true, + "hsmUri": "https://westus.hsm1.managedhsm.azure.net", + "provisioningState": "Succeeded", + "statusMessage": "ManagedHsm is functional." + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1", + "name": "hsm1", + "type": "Microsoft.KeyVault/managedHSMs", + "location": "westus", + "sku": { + "family": "B", + "name": "Standard_B1" + }, + "tags": { + "Dept": "hsm", + "Environment": "dogfood" + } + }, + { + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "initialAdminObjectIds": [ + "00000000-0000-0000-0000-000000000000" + ], + "enableSoftDelete": true, + "softDeleteRetentionInDays": 90, + "enablePurgeProtection": true, + "hsmUri": "https://westus.hsm2.managedhsm.azure.net", + "provisioningState": "Succeeded", + "statusMessage": "ManagedHsm is functional." + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm2", + "name": "hsm2", + "type": "Microsoft.KeyVault/managedHSMs", + "location": "westus", + "sku": { + "family": "B", + "name": "Standard_B1" + }, + "tags": { + "Dept": "hsm", + "Environment": "production" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs?api-version=2021-06-01-preview&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng==" + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_ListBySubscription.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_ListBySubscription.json new file mode 100644 index 000000000000..d2eb11bd7714 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_ListBySubscription.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "initialAdminObjectIds": [ + "00000000-0000-0000-0000-000000000000" + ], + "enableSoftDelete": true, + "softDeleteRetentionInDays": 90, + "enablePurgeProtection": true, + "hsmUri": "https://westus.hsm1.managedhsm.azure.net", + "provisioningState": "Succeeded", + "statusMessage": "ManagedHsm is functional." + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1", + "name": "hsm1", + "type": "Microsoft.KeyVault/managedHSMs", + "location": "westus", + "sku": { + "family": "B", + "name": "Standard_B1" + }, + "tags": { + "Dept": "hsm", + "Environment": "dogfood" + } + }, + { + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "initialAdminObjectIds": [ + "00000000-0000-0000-0000-000000000000" + ], + "enableSoftDelete": true, + "softDeleteRetentionInDays": 90, + "enablePurgeProtection": true, + "hsmUri": "https://westus.hsm2.managedhsm.azure.net", + "provisioningState": "Succeeded", + "statusMessage": "ManagedHsm is functional." + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm2", + "name": "hsm2", + "type": "Microsoft.KeyVault/managedHSMs", + "location": "westus", + "sku": { + "family": "B", + "name": "Standard_B1" + }, + "tags": { + "Dept": "hsm", + "Environment": "production" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/managedHSMs?api-version=2021-06-01-preview&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng==" + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_ListPrivateEndpointConnectionsByResource.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_ListPrivateEndpointConnectionsByResource.json new file mode 100644 index 000000000000..7b40e225d9d3 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_ListPrivateEndpointConnectionsByResource.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "name": "sample-mhsm", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateEndpointConnections/sample-pec1", + "name": "sample-pec1", + "type": "Microsoft.KeyVault/managedhsms/privateEndpointConnections", + "etag": "", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "This was automatically approved by user1234@contoso.com", + "actionsRequired": "None" + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateEndpointConnections/sample-pec2", + "name": "sample-pec2", + "type": "Microsoft.KeyVault/managedhsms/privateEndpointConnections", + "etag": "", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "This was automatically approved by user1234@contoso.com", + "actionsRequired": "None" + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_Update.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_Update.json new file mode 100644 index 000000000000..0d672d316c09 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_Update.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "resourceGroupName": "hsm-group", + "name": "hsm1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01-preview", + "parameters": { + "tags": { + "Dept": "hsm", + "Environment": "dogfood", + "Slice": "A" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "initialAdminObjectIds": [ + "00000000-0000-0000-0000-000000000000" + ], + "enableSoftDelete": true, + "softDeleteRetentionInDays": 90, + "enablePurgeProtection": true, + "hsmUri": "https://westus.hsm1.managedhsm.azure.net", + "provisioningState": "Succeeded", + "statusMessage": "ManagedHsm is functional." + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1", + "name": "hsm1", + "type": "Microsoft.KeyVault/managedHSMs", + "location": "westus", + "sku": { + "family": "B", + "name": "Standard_B1" + }, + "tags": { + "Dept": "hsm", + "Environment": "dogfood", + "Slice": "A" + } + } + }, + "202": { + "body": { + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "initialAdminObjectIds": [ + "00000000-0000-0000-0000-000000000000" + ], + "enableSoftDelete": true, + "softDeleteRetentionInDays": 90, + "enablePurgeProtection": true, + "hsmUri": "https://westus.hsm1.managedhsm.azure.net", + "provisioningState": "Updating", + "statusMessage": "ManagedHsm is updating." + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1", + "name": "hsm1", + "type": "Microsoft.KeyVault/managedHSMs", + "location": "westus", + "sku": { + "family": "B", + "name": "Standard_B1" + }, + "tags": { + "Dept": "hsm", + "Environment": "dogfood", + "Slice": "A" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_deletePrivateEndpointConnection.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_deletePrivateEndpointConnection.json new file mode 100644 index 000000000000..26cb8a7ec717 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_deletePrivateEndpointConnection.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "name": "sample-mhsm", + "privateEndpointConnectionName": "sample-pec", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedhsms/sample-vault/privateEndpointConnections/sample-pec", + "name": "sample-pec", + "type": "Microsoft.KeyVault/managedhsms/privateEndpointConnections", + "properties": { + "provisioningState": "Disconnected" + } + } + }, + "202": { + "headers": { + "Retry-After": "60", + "Location": "https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateEndpointConnections/sample-pec?operationid=25334578" + } + }, + "204": {} + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_getPrivateEndpointConnection.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_getPrivateEndpointConnection.json new file mode 100644 index 000000000000..97f62db7fc23 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_getPrivateEndpointConnection.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "name": "sample-mhsm", + "privateEndpointConnectionName": "sample-pec", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateEndpointConnections/sample-pec", + "name": "sample-pec", + "type": "Microsoft.KeyVault/managedhsms/privateEndpointConnections", + "etag": "", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "This was automatically approved by user1234@contoso.com", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_listPrivateLinkResources.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_listPrivateLinkResources.json new file mode 100644 index 000000000000..f58039b8ef71 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_listPrivateLinkResources.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "name": "sample-mhsm", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateLinkResources/managedhsm", + "name": "managedhsm", + "type": "Microsoft.KeyVault/managedhsms/privateLinkResources", + "properties": { + "groupId": "managedhsms", + "requiredMembers": [ + "default" + ], + "requiredZoneNames": [ + "privatelink.managedhsm.azure.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_putPrivateEndpointConnection.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_putPrivateEndpointConnection.json new file mode 100644 index 000000000000..7af66bc5b2dd --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/ManagedHsm_putPrivateEndpointConnection.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "name": "sample-mhsm", + "privateEndpointConnectionName": "sample-pec", + "api-version": "2021-06-01-preview", + "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/sample-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateEndpointConnections/sample-pec", + "name": "sample-pec", + "type": "Microsoft.KeyVault/managedhsms/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "My name is Joe and I'm approving this.", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/checkVaultNameAvailability.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/checkVaultNameAvailability.json new file mode 100644 index 000000000000..a66191914482 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/checkVaultNameAvailability.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01-preview", + "vaultName": { + "name": "sample-vault", + "type": "Microsoft.KeyVault/vaults" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/createKey.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/createKey.json new file mode 100644 index 000000000000..b23ebb680953 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/createKey.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "vaultName": "sample-vault-name", + "keyName": "sample-key-name", + "api-version": "2021-06-01-preview", + "parameters": { + "properties": { + "kty": "RSA" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault-name/keys/sample-key-name", + "name": "sample-key-name", + "type": "Microsoft.KeyVault/vaults/keys", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1598533051, + "updated": 1598533051, + "recoveryLevel": "Purgeable" + }, + "kty": "RSA", + "keyOps": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "keySize": 2048, + "keyUri": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name", + "keyUriWithVersion": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name/fd618d9519b74f9aae94ade66b876acc" + } + } + }, + "default": { + "headers": {}, + "body": { + "error": { + "code": "", + "message": "" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/createSecret.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/createSecret.json new file mode 100644 index 000000000000..3651841bb53a --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/createSecret.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "resourceGroupName": "sample-group", + "vaultName": "sample-vault", + "secretName": "secret-name", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01-preview", + "parameters": { + "properties": { + "value": "secret-value" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/secrets/secret-name", + "name": "secret-name", + "type": "Microsoft.KeyVault/vaults/secrets", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1514938738, + "updated": 1514938738 + }, + "secretUri": "https://sample-vault.vault.azure.net/secrets/secret-name", + "secretUriWithVersion": "https:/sample-vault.vault.azure.net/secrets/secret-name/baf6de32c4774c7c81345f6476cf90a4" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/secrets/secret-name", + "name": "secret-name", + "type": "Microsoft.KeyVault/vaults/secrets", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1514938738, + "updated": 1514938738 + }, + "secretUri": "https://sample-vault.vault.azure.net/secrets/secret-name", + "secretUriWithVersion": "https:/sample-vault.vault.azure.net/secrets/secret-name/baf6de32c4774c7c81345f6476cf90a4" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/createVault.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/createVault.json new file mode 100644 index 000000000000..d5ab4dd24d0a --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/createVault.json @@ -0,0 +1,273 @@ +{ + "parameters": { + "resourceGroupName": "sample-resource-group", + "vaultName": "sample-vault", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01-preview", + "parameters": { + "location": "westus", + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "sku": { + "family": "A", + "name": "standard" + }, + "accessPolicies": [ + { + "tenantId": "00000000-0000-0000-0000-000000000000", + "objectId": "00000000-0000-0000-0000-000000000000", + "permissions": { + "keys": [ + "encrypt", + "decrypt", + "wrapKey", + "unwrapKey", + "sign", + "verify", + "get", + "list", + "create", + "update", + "import", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "secrets": [ + "get", + "list", + "set", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "certificates": [ + "get", + "list", + "delete", + "create", + "import", + "update", + "managecontacts", + "getissuers", + "listissuers", + "setissuers", + "deleteissuers", + "manageissuers", + "recover", + "purge" + ] + } + } + ], + "enabledForDeployment": true, + "enabledForDiskEncryption": true, + "enabledForTemplateDeployment": true, + "publicNetworkAccess": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault", + "name": "sample-vault", + "type": "Microsoft.KeyVault/vaults", + "location": "westus", + "tags": {}, + "systemData": { + "createdBy": "keyVaultUser1", + "createdByType": "User", + "createdAt": "2020-01-01T12:00:00.0000000Z", + "lastModifiedBy": "keyVaultUser2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-01T12:00:00.0000000Z" + }, + "properties": { + "sku": { + "family": "A", + "name": "standard" + }, + "tenantId": "00000000-0000-0000-0000-000000000000", + "networkAcls": { + "bypass": "AzureServices", + "defaultAction": "Deny", + "ipRules": [ + { + "value": "" + } + ], + "virtualNetworkRules": [ + { + "id": "", + "ignoreMissingVnetServiceEndpoint": false + } + ] + }, + "accessPolicies": [ + { + "tenantId": "00000000-0000-0000-0000-000000000000", + "objectId": "00000000-0000-0000-0000-000000000000", + "permissions": { + "keys": [ + "encrypt", + "decrypt", + "wrapKey", + "unwrapKey", + "sign", + "verify", + "get", + "list", + "create", + "update", + "import", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "secrets": [ + "get", + "list", + "set", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "certificates": [ + "get", + "list", + "delete", + "create", + "import", + "update", + "managecontacts", + "getissuers", + "listissuers", + "setissuers", + "deleteissuers", + "manageissuers", + "recover", + "purge" + ] + } + } + ], + "privateEndpointConnections": [ + { + "id": "", + "etag": "", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + } + } + ], + "enabledForDeployment": true, + "enabledForDiskEncryption": true, + "enabledForTemplateDeployment": true, + "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000", + "vaultUri": "https://sample-vault.vault.azure.net", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault", + "name": "sample-vault", + "type": "Microsoft.KeyVault/vaults", + "location": "westus", + "tags": {}, + "systemData": { + "createdBy": "keyVaultUser1", + "createdByType": "User", + "createdAt": "2020-01-01T12:00:00.0000000Z", + "lastModifiedBy": "keyVaultUser2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-01T12:00:00.0000000Z" + }, + "properties": { + "sku": { + "family": "A", + "name": "standard" + }, + "tenantId": "00000000-0000-0000-0000-000000000000", + "accessPolicies": [ + { + "tenantId": "00000000-0000-0000-0000-000000000000", + "objectId": "00000000-0000-0000-0000-000000000000", + "permissions": { + "keys": [ + "encrypt", + "decrypt", + "wrapKey", + "unwrapKey", + "sign", + "verify", + "get", + "list", + "create", + "update", + "import", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "secrets": [ + "get", + "list", + "set", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "certificates": [ + "get", + "list", + "delete", + "create", + "import", + "update", + "managecontacts", + "getissuers", + "listissuers", + "setissuers", + "deleteissuers", + "manageissuers", + "recover", + "purge" + ] + } + } + ], + "enabledForDeployment": true, + "enabledForDiskEncryption": true, + "enabledForTemplateDeployment": true, + "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000", + "vaultUri": "https://sample-vault.vault.azure.net", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/createVaultWithNetworkAcls.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/createVaultWithNetworkAcls.json new file mode 100644 index 000000000000..436dda5d59ef --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/createVaultWithNetworkAcls.json @@ -0,0 +1,132 @@ +{ + "parameters": { + "resourceGroupName": "sample-resource-group", + "vaultName": "sample-vault", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01-preview", + "parameters": { + "location": "westus", + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "sku": { + "family": "A", + "name": "standard" + }, + "networkAcls": { + "defaultAction": "Deny", + "bypass": "AzureServices", + "ipRules": [ + { + "value": "124.56.78.91" + }, + { + "value": "'10.91.4.0/24'" + } + ], + "virtualNetworkRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "enabledForDeployment": true, + "enabledForDiskEncryption": true, + "enabledForTemplateDeployment": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault", + "name": "sample-vault", + "type": "Microsoft.KeyVault/vaults", + "location": "westus", + "tags": {}, + "systemData": { + "createdBy": "keyVaultUser1", + "createdByType": "User", + "createdAt": "2020-01-01T12:00:00.0000000Z", + "lastModifiedBy": "keyVaultUser2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-01T12:00:00.0000000Z" + }, + "properties": { + "sku": { + "family": "A", + "name": "standard" + }, + "tenantId": "00000000-0000-0000-0000-000000000000", + "networkAcls": { + "defaultAction": "Deny", + "bypass": "AzureServices", + "ipRules": [ + { + "value": "124.56.78.91/32" + }, + { + "value": "'10.91.4.0/24'" + } + ], + "virtualNetworkRules": [ + { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.network/virtualnetworks/test-vnet/subnets/subnet1" + } + ] + }, + "enabledForDeployment": true, + "enabledForDiskEncryption": true, + "enabledForTemplateDeployment": true, + "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000", + "vaultUri": "https://sample-vault.vault.azure.net" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault", + "name": "sample-vault", + "type": "Microsoft.KeyVault/vaults", + "location": "westus", + "tags": {}, + "systemData": { + "createdBy": "keyVaultUser1", + "createdByType": "User", + "createdAt": "2020-01-01T12:00:00.0000000Z", + "lastModifiedBy": "keyVaultUser2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-01T12:00:00.0000000Z" + }, + "properties": { + "sku": { + "family": "A", + "name": "standard" + }, + "tenantId": "00000000-0000-0000-0000-000000000000", + "networkAcls": { + "defaultAction": "Deny", + "bypass": "AzureServices", + "ipRules": [ + { + "value": "124.56.78.91/32" + }, + { + "value": "'10.91.4.0/24'" + } + ], + "virtualNetworkRules": [ + { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.network/virtualnetworks/test-vnet/subnets/subnet1" + } + ] + }, + "enabledForDeployment": true, + "enabledForDiskEncryption": true, + "enabledForTemplateDeployment": true, + "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000", + "vaultUri": "https://sample-vault.vault.azure.net" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/deletePrivateEndpointConnection.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/deletePrivateEndpointConnection.json new file mode 100644 index 000000000000..2e927897cf70 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/deletePrivateEndpointConnection.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "vaultName": "sample-vault", + "privateEndpointConnectionName": "sample-pec", + "api-version": "2018-02-14" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections/sample-pec", + "name": "sample-pec", + "type": "Microsoft.KeyVault/vaults/privateEndpointConnections", + "properties": { + "provisioningState": "Disconnected" + } + } + }, + "202": { + "headers": { + "Retry-After": "60", + "Location": "https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections/sample-pec?operationid=25334578" + } + }, + "204": {} + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/deleteVault.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/deleteVault.json new file mode 100644 index 000000000000..80f53fdf1dcd --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/deleteVault.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "sample-resource-group", + "vaultName": "sample-vault", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "headers": {} + }, + "204": { + "headers": {} + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/getDeletedVault.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/getDeletedVault.json new file mode 100644 index 000000000000..a43a96aef6ec --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/getDeletedVault.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "vaultName": "sample-vault", + "location": "westus", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/deletedVaults/sample-vault", + "name": "sample-vault", + "type": "Microsoft.KeyVault/deletedVaults", + "properties": { + "vaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault", + "location": "westus", + "tags": {}, + "deletionDate": "2017-01-01T00:00:59Z", + "scheduledPurgeDate": "2017-04-01T00:00:59Z", + "purgeProtectionEnabled": true + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/getKey.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/getKey.json new file mode 100644 index 000000000000..0353e8b14d3e --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/getKey.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "vaultName": "sample-vault-name", + "keyName": "sample-key-name", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault-name/keys/sample-key-name", + "name": "sample-key-name", + "type": "Microsoft.KeyVault/vaults/keys", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1598533051, + "updated": 1598533051, + "recoveryLevel": "Purgeable" + }, + "kty": "RSA", + "keyOps": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "keySize": 2048, + "keyUri": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name", + "keyUriWithVersion": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name/fd618d9519b74f9aae94ade66b876acc" + } + } + }, + "default": { + "headers": {}, + "body": { + "error": { + "code": "", + "message": "" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/getKeyVersion.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/getKeyVersion.json new file mode 100644 index 000000000000..d2e7b8d2a245 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/getKeyVersion.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "vaultName": "sample-vault-name", + "keyName": "sample-key-name", + "keyVersion": "fd618d9519b74f9aae94ade66b876acc", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault-name/keys/sample-key-name/versions/fd618d9519b74f9aae94ade66b876acc", + "name": "fd618d9519b74f9aae94ade66b876acc", + "type": "Microsoft.KeyVault/vaults/keys/versions", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1598533051, + "updated": 1598533051, + "recoveryLevel": "Purgeable" + }, + "kty": "RSA", + "keyOps": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "keySize": 2048, + "keyUri": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name", + "keyUriWithVersion": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name/fd618d9519b74f9aae94ade66b876acc" + } + } + }, + "default": { + "headers": {}, + "body": { + "error": { + "code": "", + "message": "" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/getPrivateEndpointConnection.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/getPrivateEndpointConnection.json new file mode 100644 index 000000000000..287caee88a94 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/getPrivateEndpointConnection.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "vaultName": "sample-vault", + "privateEndpointConnectionName": "sample-pec", + "api-version": "2018-02-14" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections/sample-pec", + "name": "sample-pec", + "type": "Microsoft.KeyVault/vaults/privateEndpointConnections", + "etag": "", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "This was automatically approved by user1234@contoso.com", + "actionsRequired": "None" + } + } + } + }, + "204": { + "headers": {} + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/getSecret.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/getSecret.json new file mode 100644 index 000000000000..b39619cd2a94 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/getSecret.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "resourceGroupName": "sample-group", + "vaultName": "sample-vault", + "secretName": "secret-name", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/secrets/secret-name", + "name": "secret-name", + "type": "Microsoft.KeyVault/vaults/secrets", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1514940950, + "updated": 1514940950 + }, + "secretUri": "https://sample-vault.vault.azure.net/secrets/secret-name", + "secretUriWithVersion": "https://sample-vault.vault.azure.net/secrets/secret-name/77445834f7de41bab81d0723bf996860" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/getVault.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/getVault.json new file mode 100644 index 000000000000..3cf52a182e9a --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/getVault.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "resourceGroupName": "sample-resource-group", + "vaultName": "sample-vault", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault", + "name": "sample-vault", + "type": "Microsoft.KeyVault/vaults", + "location": "westus", + "tags": {}, + "systemData": { + "createdBy": "keyVaultUser1", + "createdByType": "User", + "createdAt": "2020-01-01T12:00:00.0000000Z", + "lastModifiedBy": "keyVaultUser2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-01T12:00:00.0000000Z" + }, + "properties": { + "sku": { + "family": "A", + "name": "standard" + }, + "tenantId": "00000000-0000-0000-0000-000000000000", + "accessPolicies": [ + { + "tenantId": "00000000-0000-0000-0000-000000000000", + "objectId": "00000000-0000-0000-0000-000000000000", + "permissions": { + "keys": [ + "encrypt", + "decrypt", + "wrapKey", + "unwrapKey", + "sign", + "verify", + "get", + "list", + "create", + "update", + "import", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "secrets": [ + "get", + "list", + "set", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "certificates": [ + "get", + "list", + "delete", + "create", + "import", + "update", + "managecontacts", + "getissuers", + "listissuers", + "setissuers", + "deleteissuers", + "manageissuers", + "recover", + "purge" + ] + } + } + ], + "enabledForDeployment": true, + "enabledForDiskEncryption": true, + "enabledForTemplateDeployment": true, + "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000", + "vaultUri": "https://sample-vault.vault.azure.net", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/listDeletedVaults.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/listDeletedVaults.json new file mode 100644 index 000000000000..b522cbe89354 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/listDeletedVaults.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "$top": 1, + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/deletedVaults/sample-vault", + "name": "vault-agile-drawer-6404", + "type": "Microsoft.KeyVault/deletedVaults", + "properties": { + "vaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault", + "location": "westus", + "tags": {}, + "deletionDate": "2017-01-01T00:00:59Z", + "scheduledPurgeDate": "2017-04-01T00:00:59Z", + "purgeProtectionEnabled": true + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/deletedVaults?api-version=2021-06-01-preview&%24skiptoken=HY3RaoMwAEX%2fRcbeYhJrnRXKYNWOuqpME0sfNcYui0Yxade19N8ne7hcDlzOvVuKX81eKKmt4G4dooLQwgqsL2NGHUDYV6o68Z4rY1e388RtNvRQn2vNJjEaMSgNvcbneMUcsKg8BFwft8DndQ0w9hu2QOiFLRs4TsNFNHzSMBFsGvTQGvuD%2f5bVuTOw4R03vPkH%2fVqNAlzm5SxfOwh7ACOA8POTlvPjILlaU1ke8jImOc23JCppQVfZnna0DXc4ISc3vSVuRo5zJE6%2bj25C3vwk2v2kEV2mMn7PyOc1DbtNGkonnzuLym1G400uI5QRZj0efw%3d%3d" + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/listKeyVersions.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/listKeyVersions.json new file mode 100644 index 000000000000..7f7e3730eaf7 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/listKeyVersions.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "vaultName": "sample-vault-name", + "keyName": "sample-key-name", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault-name/keys/sample-key-name/versions/c2296aa24acf4daf86942bff5aca73dd", + "name": "c2296aa24acf4daf86942bff5aca73dd", + "type": "Microsoft.KeyVault/vaults/keys/versions", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1598641074, + "updated": 1598641074, + "recoveryLevel": "Purgeable" + }, + "keyUri": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name", + "keyUriWithVersion": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name/c2296aa24acf4daf86942bff5aca73dd" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault-name/keys/sample-key-name/versions/d5a04667b6f44b0ca62825f5eae93da6", + "name": "d5a04667b6f44b0ca62825f5eae93da6", + "type": "Microsoft.KeyVault/vaults/keys/versions", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1598641295, + "updated": 1598641295, + "recoveryLevel": "Purgeable" + }, + "keyUri": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name", + "keyUriWithVersion": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name/d5a04667b6f44b0ca62825f5eae93da6" + } + } + ] + } + }, + "default": { + "headers": {}, + "body": { + "error": { + "code": "", + "message": "" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/listKeys.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/listKeys.json new file mode 100644 index 000000000000..3a461d961963 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/listKeys.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "vaultName": "sample-vault-name", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault-name/keys/sample-key-name-1", + "name": "sample-key-name-1", + "type": "Microsoft.KeyVault/vaults/keys", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1596493796, + "updated": 1596493796, + "recoveryLevel": "Purgeable" + }, + "keyUri": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name-1" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault-name/keys/sample-key-name-2", + "name": "sample-key-name-2", + "type": "Microsoft.KeyVault/vaults/keys", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1596493797, + "updated": 1596493797, + "recoveryLevel": "Purgeable" + }, + "keyUri": "https://sample-vault-name.vault.azure.net:443/keys/sample-key-name-2" + } + } + ] + } + }, + "default": { + "headers": {}, + "body": { + "error": { + "code": "", + "message": "" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/listOperations.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/listOperations.json new file mode 100644 index 000000000000..b579c093fe9f --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/listOperations.json @@ -0,0 +1,332 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.KeyVault/vaults/read", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Key Vault", + "operation": "View Key Vault", + "description": "View the properties of a key vault" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/vaults/write", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Key Vault", + "operation": "Update Key Vault", + "description": "Create a new key vault or update the properties of an existing key vault" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/vaults/delete", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Key Vault", + "operation": "Delete Key Vault", + "description": "Delete a key vault" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/vaults/deploy/action", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Key Vault", + "operation": "Use Vault for Azure Deployments", + "description": "Enables access to secrets in a key vault when deploying Azure resources" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/vaults/secrets/read", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Secret", + "operation": "View Secret Properties", + "description": "View the properties of a secret, but not its value" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/vaults/secrets/write", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Secret", + "operation": "Update Secret", + "description": "Create a new secret or update the value of an existing secret" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/vaults/accessPolicies/write", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Access Policy", + "operation": "Update Access Policy", + "description": "Update an existing access policy by merging or replacing, or add a new access policy to a vault." + }, + "isDataAction": false + }, + { + "origin": "system", + "name": "Microsoft.KeyVault/vaults/providers/Microsoft.Insights/logDefinitions/read", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Key Vault Log Definition", + "operation": "Read log definition", + "description": "Gets the available logs for a key vault" + }, + "isDataAction": false, + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "AuditEvent", + "displayName": "Audit Logs", + "blobDuration": "PT1H" + } + ], + "metricSpecifications": [ + { + "name": "ServiceApiHit", + "displayName": "", + "displayDescription": "", + "unit": "", + "aggregationType": "", + "supportedAggregationTypes": [ + "" + ], + "supportedTimeGrainTypes": [ + "" + ], + "lockAggregationType": "", + "dimensions": [ + { + "name": "ActivityType", + "displayName": "", + "toBeExportedForShoebox": true + }, + { + "name": "ActivityName", + "displayName": "", + "toBeExportedForShoebox": true + } + ], + "fillGapWithZero": false, + "internalMetricName": "AuditEvent" + } + ] + } + } + }, + { + "origin": "system", + "name": "Microsoft.KeyVault/vaults/providers/Microsoft.Insights/diagnosticSettings/Read", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Key Vault Diagnostic Settings", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource" + }, + "isDataAction": false + }, + { + "origin": "system", + "name": "Microsoft.KeyVault/vaults/providers/Microsoft.Insights/diagnosticSettings/Write", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Key Vault Diagnostic Settings", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/register/action", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Subscription", + "operation": "Register Subscription", + "description": "Registers a subscription" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/unregister/action", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Subscription", + "operation": "Unregister Subscription", + "description": "Unregisters a subscription" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/operations/read", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Operations", + "operation": "Available Key Vault Operations", + "description": "Lists operations available on Microsoft.KeyVault resource provider" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/checkNameAvailability/read", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Name Availability", + "operation": "Check Name Availability", + "description": "Checks that a key vault name is valid and is not in use" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/deletedVaults/read", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Soft Deleted Key Vault", + "operation": "View Soft Deleted Vaults", + "description": "View the properties of soft deleted key vaults" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/locations/deletedVaults/read", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Soft Deleted Key Vault", + "operation": "View Soft Deleted Key Vault", + "description": "View the properties of a soft deleted key vault" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/locations/deletedVaults/purge/action", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Soft Deleted Key Vault", + "operation": "Purge Soft Deleted Key Vault", + "description": "Purge a soft deleted key vault" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/locations/operationResults/read", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Long Run Operation Result", + "operation": "Check Operation Result", + "description": "Check the result of a long run operation" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/hsmPools/read", + "display": { + "provider": "Microsoft Key Vault", + "resource": "HSM pool", + "operation": "View HSM pool", + "description": "View the properties of an HSM pool" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/hsmPools/write", + "display": { + "provider": "Microsoft Key Vault", + "resource": "HSM pool", + "operation": "Create or Update HSM pool", + "description": "Create a new HSM pool of update the properties of an existing HSM pool" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/hsmPools/delete", + "display": { + "provider": "Microsoft Key Vault", + "resource": "HSM pool", + "operation": "Delete HSM pool", + "description": "Delete an HSM pool" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/hsmPools/joinVault/action", + "display": { + "provider": "Microsoft Key Vault", + "resource": "HSM pool", + "operation": "Join KeyVault to HSM pool", + "description": "Join a key vault to an HSM pool" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/managedHSMs/read", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Managed HSM", + "operation": "View Managed HSM", + "description": "View the properties of a Managed HSM" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/managedHSMs/write", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Managed HSM", + "operation": "Create or Update Managed HSM", + "description": "Create a new Managed HSM of update the properties of an existing Managed HSM" + }, + "isDataAction": false + }, + { + "name": "Microsoft.KeyVault/managedHSMs/delete", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Managed HSM", + "operation": "Delete Managed HSM", + "description": "Delete a Managed HSM" + }, + "isDataAction": false + }, + { + "origin": "system", + "name": "Microsoft.KeyVault/vaults/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Key Vault Metric Definition", + "operation": "Read metric definition", + "description": "Gets the available metrics for a key vault" + }, + "isDataAction": false, + "properties": { + "serviceSpecification": {} + } + }, + { + "origin": "system", + "name": "Microsoft.KeyVault/locations/deleteVirtualNetworkOrSubnets/action", + "display": { + "provider": "Microsoft Key Vault", + "resource": "Location", + "operation": "Modify Network ACLs containing the deleted Vitual Network or Subnet ", + "description": "Notifies Microsoft.KeyVault that a virtual network or subnet is being deleted" + }, + "isDataAction": false + } + ] + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/listPrivateEndpointConnection.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/listPrivateEndpointConnection.json new file mode 100644 index 000000000000..eedc4e0dca4a --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/listPrivateEndpointConnection.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "vaultName": "sample-vault", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections/sample-pec", + "name": "sample-pec", + "type": "Microsoft.KeyVault/vaults/privateEndpointConnections", + "etag": "", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "This was automatically approved by user1234@contoso.com", + "actionsRequired": "None" + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections/sample-pec", + "name": "sample-pec", + "type": "Microsoft.KeyVault/vaults/privateEndpointConnections", + "etag": "", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "This was automatically approved by user1234@contoso.com", + "actionsRequired": "None" + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/listPrivateLinkResources.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/listPrivateLinkResources.json new file mode 100644 index 000000000000..f76786fad20e --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/listPrivateLinkResources.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "vaultName": "sample-vault", + "api-version": "2018-02-14" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateLinkResources/vault", + "name": "vault", + "type": "Microsoft.KeyVault/vaults/privateLinkResources", + "properties": { + "groupId": "vault", + "requiredMembers": [ + "default" + ], + "requiredZoneNames": [ + "privatelink.vaultcore.azure.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/listSecrets.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/listSecrets.json new file mode 100644 index 000000000000..c291de45ce80 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/listSecrets.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "resourceGroupName": "sample-group", + "vaultName": "sample-vault", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/secrets/secret-name", + "name": "secret-name", + "type": "Microsoft.KeyVault/vaults/secrets", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1514941476, + "updated": 1514941476 + }, + "secretUri": "https://sample-vault.vault.azure.net/secrets/secret-name", + "secretUriWithVersion": "https://sample-vault.vault.azure.net/secrets/secret-name/40af42fbc10047f8a756a73211492f56" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/secrets/secret-name2", + "name": "secret-name2", + "type": "Microsoft.KeyVault/vaults/secrets", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1514941476, + "updated": 1514941476 + }, + "secretUri": "https://sample-vault.vault.azure.net/secrets/secret-name2", + "secretUriWithVersion": "https://sample-vault.vault.azure.net/secrets/secret-name2/cd7264a6f56c44d1b594423c80609aae" + } + } + ] + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/listVault.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/listVault.json new file mode 100644 index 000000000000..3397baaa9f83 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/listVault.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "$filter": "resourceType eq 'Microsoft.KeyVault/vaults'", + "$top": 1, + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2015-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault", + "name": "sample-vault", + "type": "Microsoft.KeyVault/vaults", + "location": "westus", + "tags": {} + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resources?%24filter=resourceType+eq+%27Microsoft.KeyVault%2fvaults%27&%24top=4&api-version=2015-11-01&%24skiptoken=eyJuZXh0UGFydGl0aW9uS2V5IjoiMSE4IVEwTTJNVGMtIiwibmV4dFJvd0tleSI6IjEhMTMyIU5rUTRSVEU1UXpJelFUWXdORGd4UmpoRlFrSXhNVGhFUXpNd01EZEROVVJmVkVkT1RDMU5TVU5TVDFOUFJsUTZNa1ZMUlZsV1FWVk1WRG95UmxaQlZVeFVVeTFUVTFKSExVcEpUVG95UkZSRlUxUTZNa1JXUVZWTVZDMVhSVk5VVlZNLSJ9" + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/listVaultByResourceGroup.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/listVaultByResourceGroup.json new file mode 100644 index 000000000000..86a52342adf2 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/listVaultByResourceGroup.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "$top": 1, + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault", + "name": "sample-vault", + "type": "Microsoft.KeyVault/vaults", + "location": "westus", + "tags": {}, + "systemData": { + "createdBy": "keyVaultUser1", + "createdByType": "User", + "createdAt": "2020-01-01T12:00:00.0000000Z", + "lastModifiedBy": "keyVaultUser2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-01T12:00:00.0000000Z" + }, + "properties": { + "sku": { + "family": "A", + "name": "premium" + }, + "tenantId": "00000000-0000-0000-0000-000000000000", + "accessPolicies": [ + { + "tenantId": "00000000-0000-0000-0000-000000000000", + "objectId": "00000000-0000-0000-0000-000000000000", + "permissions": { + "keys": [ + "encrypt", + "decrypt", + "wrapKey", + "unwrapKey", + "sign", + "verify", + "get", + "list", + "create", + "update", + "import", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "secrets": [ + "get", + "list", + "set", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "certificates": [ + "get", + "list", + "delete", + "create", + "import", + "update", + "managecontacts", + "getissuers", + "listissuers", + "setissuers", + "deleteissuers", + "manageissuers", + "recover", + "purge" + ] + } + } + ], + "enabledForDeployment": true, + "enabledForDiskEncryption": true, + "enabledForTemplateDeployment": true, + "enableSoftDelete": true, + "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000", + "vaultUri": "https://sample-vault.vault.azure.net/", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults?api-version=2021-06-01-preview&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng==" + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/listVaultBySubscription.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/listVaultBySubscription.json new file mode 100644 index 000000000000..208772c9e89c --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/listVaultBySubscription.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "$top": 1, + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault", + "name": "sample-vault", + "type": "Microsoft.KeyVault/vaults", + "location": "westus", + "tags": {}, + "systemData": { + "createdBy": "keyVaultUser1", + "createdByType": "User", + "createdAt": "2020-01-01T12:00:00.0000000Z", + "lastModifiedBy": "keyVaultUser2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-01T12:00:00.0000000Z" + }, + "properties": { + "sku": { + "family": "A", + "name": "premium" + }, + "tenantId": "00000000-0000-0000-0000-000000000000", + "accessPolicies": [ + { + "tenantId": "00000000-0000-0000-0000-000000000000", + "objectId": "00000000-0000-0000-0000-000000000000", + "permissions": { + "keys": [ + "encrypt", + "decrypt", + "wrapKey", + "unwrapKey", + "sign", + "verify", + "get", + "list", + "create", + "update", + "import", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "secrets": [ + "get", + "list", + "set", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "certificates": [ + "get", + "list", + "delete", + "create", + "import", + "update", + "managecontacts", + "getissuers", + "listissuers", + "setissuers", + "deleteissuers", + "manageissuers", + "recover", + "purge" + ] + } + } + ], + "enabledForDeployment": true, + "enabledForDiskEncryption": true, + "enabledForTemplateDeployment": true, + "enableSoftDelete": true, + "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000", + "vaultUri": "https://sample-vault.vault.azure.net/", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resources?api-version=22021-06-01-preview&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng==" + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/purgeDeletedVault.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/purgeDeletedVault.json new file mode 100644 index 000000000000..f39a347c1094 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/purgeDeletedVault.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "vaultName": "sample-vault", + "location": "westus", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "headers": {} + }, + "202": { + "headers": {} + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "", + "message": "" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/putPrivateEndpointConnection.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/putPrivateEndpointConnection.json new file mode 100644 index 000000000000..1a33f385b23d --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/putPrivateEndpointConnection.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sample-group", + "vaultName": "sample-vault", + "privateEndpointConnectionName": "sample-pec", + "api-version": "2018-02-14", + "properties": { + "etag": "", + "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/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections/sample-pec", + "name": "sample-pec", + "type": "Microsoft.KeyVault/vaults/privateEndpointConnections", + "etag": "", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "My name is Joe and I'm approving this.", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/updateAccessPoliciesAdd.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/updateAccessPoliciesAdd.json new file mode 100644 index 000000000000..58c13c9dd8ec --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/updateAccessPoliciesAdd.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "resourceGroupName": "sample-group", + "vaultName": "sample-vault", + "operationKind": "add", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01-preview", + "parameters": { + "properties": { + "accessPolicies": [ + { + "tenantId": "00000000-0000-0000-0000-000000000000", + "objectId": "00000000-0000-0000-0000-000000000000", + "permissions": { + "keys": [ + "encrypt" + ], + "secrets": [ + "get" + ], + "certificates": [ + "get" + ] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/accessPolicies/", + "type": "Microsoft.KeyVault/vaults/accessPolicies", + "properties": { + "accessPolicies": [ + { + "tenantId": "00000000-0000-0000-0000-000000000000", + "objectId": "00000000-0000-0000-0000-000000000000", + "permissions": { + "keys": [ + "encrypt" + ], + "secrets": [ + "get" + ], + "certificates": [ + "get" + ] + } + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/accessPolicies/", + "type": "Microsoft.KeyVault/vaults/accessPolicies", + "properties": { + "accessPolicies": [ + { + "tenantId": "00000000-0000-0000-0000-000000000000", + "objectId": "00000000-0000-0000-0000-000000000000", + "permissions": { + "keys": [ + "encrypt" + ], + "secrets": [ + "get" + ], + "certificates": [ + "get" + ] + } + } + ] + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "", + "message": "" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/updateSecret.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/updateSecret.json new file mode 100644 index 000000000000..30e58d38a376 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/updateSecret.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "resourceGroupName": "sample-group", + "vaultName": "sample-vault", + "secretName": "secret-name", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01-preview", + "parameters": { + "properties": { + "value": "secret-value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/secrets/secret-name", + "name": "secret-name", + "type": "Microsoft.KeyVault/vaults/secrets", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1514940684, + "updated": 1514940698 + }, + "secretUri": "https://sample-vault.vault.azure.net/secrets/secret-name", + "secretUriWithVersion": "https://sample-vault.vault.azure.net/secrets/secret-name/b8c802f549764f2d97885d152f92ee9d" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/secrets/secret-name", + "name": "secret-name", + "type": "Microsoft.KeyVault/vaults/secrets", + "location": "westus", + "properties": { + "attributes": { + "enabled": true, + "created": 1514940684, + "updated": 1514940698 + }, + "secretUri": "https://sample-vault.vault.azure.net/secrets/secret-name", + "secretUriWithVersion": "https://sample-vault.vault.azure.net/secrets/secret-name/b8c802f549764f2d97885d152f92ee9d" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/updateVault.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/updateVault.json new file mode 100644 index 000000000000..ee3b22db99e4 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/examples/updateVault.json @@ -0,0 +1,271 @@ +{ + "parameters": { + "resourceGroupName": "sample-resource-group", + "vaultName": "sample-vault", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01-preview", + "parameters": { + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "sku": { + "family": "A", + "name": "standard" + }, + "accessPolicies": [ + { + "tenantId": "00000000-0000-0000-0000-000000000000", + "objectId": "00000000-0000-0000-0000-000000000000", + "permissions": { + "keys": [ + "encrypt", + "decrypt", + "wrapKey", + "unwrapKey", + "sign", + "verify", + "get", + "list", + "create", + "update", + "import", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "secrets": [ + "get", + "list", + "set", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "certificates": [ + "get", + "list", + "delete", + "create", + "import", + "update", + "managecontacts", + "getissuers", + "listissuers", + "setissuers", + "deleteissuers", + "manageissuers", + "recover", + "purge" + ] + } + } + ], + "enabledForDeployment": true, + "enabledForDiskEncryption": true, + "enabledForTemplateDeployment": true, + "publicNetworkAccess": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault", + "name": "sample-vault", + "type": "Microsoft.KeyVault/vaults", + "location": "westus", + "tags": {}, + "systemData": { + "createdBy": "keyVaultUser1", + "createdByType": "User", + "createdAt": "2020-01-01T12:00:00.0000000Z", + "lastModifiedBy": "keyVaultUser2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-01T12:00:00.0000000Z" + }, + "properties": { + "sku": { + "family": "A", + "name": "standard" + }, + "tenantId": "00000000-0000-0000-0000-000000000000", + "networkAcls": { + "bypass": "AzureServices", + "defaultAction": "Deny", + "ipRules": [ + { + "value": "" + } + ], + "virtualNetworkRules": [ + { + "id": "", + "ignoreMissingVnetServiceEndpoint": false + } + ] + }, + "accessPolicies": [ + { + "tenantId": "00000000-0000-0000-0000-000000000000", + "objectId": "00000000-0000-0000-0000-000000000000", + "permissions": { + "keys": [ + "encrypt", + "decrypt", + "wrapKey", + "unwrapKey", + "sign", + "verify", + "get", + "list", + "create", + "update", + "import", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "secrets": [ + "get", + "list", + "set", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "certificates": [ + "get", + "list", + "delete", + "create", + "import", + "update", + "managecontacts", + "getissuers", + "listissuers", + "setissuers", + "deleteissuers", + "manageissuers", + "recover", + "purge" + ] + } + } + ], + "privateEndpointConnections": [ + { + "id": "", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + } + } + ], + "enabledForDeployment": true, + "enabledForDiskEncryption": true, + "enabledForTemplateDeployment": true, + "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000", + "vaultUri": "https://sample-vault.vault.azure.net", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault", + "name": "sample-vault", + "type": "Microsoft.KeyVault/vaults", + "location": "westus", + "tags": {}, + "systemData": { + "createdBy": "keyVaultUser1", + "createdByType": "User", + "createdAt": "2020-01-01T12:00:00.0000000Z", + "lastModifiedBy": "keyVaultUser2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-01T12:00:00.0000000Z" + }, + "properties": { + "sku": { + "family": "A", + "name": "standard" + }, + "tenantId": "00000000-0000-0000-0000-000000000000", + "accessPolicies": [ + { + "tenantId": "00000000-0000-0000-0000-000000000000", + "objectId": "00000000-0000-0000-0000-000000000000", + "permissions": { + "keys": [ + "encrypt", + "decrypt", + "wrapKey", + "unwrapKey", + "sign", + "verify", + "get", + "list", + "create", + "update", + "import", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "secrets": [ + "get", + "list", + "set", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "certificates": [ + "get", + "list", + "delete", + "create", + "import", + "update", + "managecontacts", + "getissuers", + "listissuers", + "setissuers", + "deleteissuers", + "manageissuers", + "recover", + "purge" + ] + } + } + ], + "enabledForDeployment": true, + "enabledForDiskEncryption": true, + "enabledForTemplateDeployment": true, + "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000", + "vaultUri": "https://sample-vault.vault.azure.net", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled" + } + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/keys.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/keys.json new file mode 100644 index 000000000000..2f89167ed638 --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/keys.json @@ -0,0 +1,646 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01-preview", + "title": "KeyVaultManagementClient", + "description": "The Azure management API provides a RESTful set of web services that interact with Azure Key Vault." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/keys/{keyName}": { + "put": { + "tags": [ + "Keys" + ], + "operationId": "Keys_CreateIfNotExist", + "description": "Creates the first version of a new key if it does not exist. If it already exists, then the existing key is returned without any write operations being performed. This API does not create subsequent versions, and does not update existing keys.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group which contains the specified key vault." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$", + "description": "The name of the key vault which contains the key to be created." + }, + { + "name": "keyName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{1,127}$", + "description": "The name of the key to be created." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/KeyCreateParameters" + }, + "description": "The parameters used to create the specified key." + } + ], + "responses": { + "200": { + "description": "The created key.", + "schema": { + "$ref": "#/definitions/Key" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a key": { + "$ref": "./examples/createKey.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "get": { + "tags": [ + "Keys" + ], + "operationId": "Keys_Get", + "description": "Gets the current version of the specified key from the specified key vault.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group which contains the specified key vault." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$", + "description": "The name of the vault which contains the key to be retrieved." + }, + { + "name": "keyName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{1,127}$", + "description": "The name of the key to be retrieved." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved key.", + "schema": { + "$ref": "#/definitions/Key" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a key": { + "$ref": "./examples/getKey.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/keys": { + "get": { + "tags": [ + "Keys" + ], + "operationId": "Keys_List", + "description": "Lists the keys in the specified key vault.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group which contains the specified key vault." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$", + "description": "The name of the vault which contains the keys to be retrieved." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved page of keys.", + "schema": { + "$ref": "#/definitions/KeyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List keys in the vault": { + "$ref": "./examples/listKeys.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/keys/{keyName}/versions/{keyVersion}": { + "get": { + "tags": [ + "Keys" + ], + "operationId": "Keys_GetVersion", + "description": "Gets the specified version of the specified key in the specified key vault.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group which contains the specified key vault." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$", + "description": "The name of the vault which contains the key version to be retrieved." + }, + { + "name": "keyName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{1,127}$", + "description": "The name of the key version to be retrieved." + }, + { + "name": "keyVersion", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-fA-F0-9]{32}$", + "description": "The version of the key to be retrieved." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved key version.", + "schema": { + "$ref": "#/definitions/Key" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a key version": { + "$ref": "./examples/getKeyVersion.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/keys/{keyName}/versions": { + "get": { + "tags": [ + "Keys" + ], + "operationId": "Keys_ListVersions", + "description": "Lists the versions of the specified key in the specified key vault.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group which contains the specified key vault." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$", + "description": "The name of the vault which contains the key versions to be retrieved." + }, + { + "name": "keyName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{1,127}$", + "description": "The name of the key versions to be retrieved." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved page of key versions.", + "schema": { + "$ref": "#/definitions/KeyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List key versions in the vault": { + "$ref": "./examples/listKeyVersions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + } + }, + "definitions": { + "KeyProperties": { + "properties": { + "attributes": { + "$ref": "#/definitions/KeyAttributes", + "description": "The attributes of the key." + }, + "kty": { + "type": "string", + "minLength": 1, + "description": "The type of the key. For valid values, see JsonWebKeyType.", + "enum": [ + "EC", + "EC-HSM", + "RSA", + "RSA-HSM" + ], + "x-ms-enum": { + "name": "JsonWebKeyType", + "modelAsString": true + } + }, + "keyOps": { + "type": "array", + "items": { + "type": "string", + "description": "The permitted JSON web key operations of the key. For more information, see JsonWebKeyOperation.", + "enum": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey", + "import" + ], + "x-ms-enum": { + "name": "JsonWebKeyOperation", + "modelAsString": true + } + } + }, + "keySize": { + "type": "integer", + "format": "int32", + "description": "The key size in bits. For example: 2048, 3072, or 4096 for RSA." + }, + "curveName": { + "type": "string", + "description": "The elliptic curve name. For valid values, see JsonWebKeyCurveName.", + "enum": [ + "P-256", + "P-384", + "P-521", + "P-256K" + ], + "x-ms-enum": { + "name": "JsonWebKeyCurveName", + "modelAsString": true + } + }, + "keyUri": { + "type": "string", + "description": "The URI to retrieve the current version of the key.", + "readOnly": true + }, + "keyUriWithVersion": { + "type": "string", + "description": "The URI to retrieve the specific version of the key.", + "readOnly": true + }, + "rotationPolicy": { + "$ref": "#/definitions/RotationPolicy", + "description": "Key rotation policy in response. It will be used for both output and input. Omitted if empty" + } + }, + "description": "The properties of the key.", + "type": "object" + }, + "KeyAttributes": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Determines whether or not the object is enabled." + }, + "nbf": { + "x-ms-client-name": "NotBefore", + "type": "integer", + "format": "int64", + "description": "Not before date in seconds since 1970-01-01T00:00:00Z." + }, + "exp": { + "x-ms-client-name": "Expires", + "type": "integer", + "format": "int64", + "description": "Expiry date in seconds since 1970-01-01T00:00:00Z." + }, + "created": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Creation time in seconds since 1970-01-01T00:00:00Z." + }, + "updated": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Last updated time in seconds since 1970-01-01T00:00:00Z." + }, + "recoveryLevel": { + "type": "string", + "description": "The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval.", + "enum": [ + "Purgeable", + "Recoverable+Purgeable", + "Recoverable", + "Recoverable+ProtectedSubscription" + ], + "x-ms-enum": { + "name": "DeletionRecoveryLevel", + "modelAsString": true + }, + "readOnly": true, + "x-nullable": false + } + }, + "description": "The object attributes managed by the Azure Key Vault service.", + "type": "object" + }, + "KeyCreateParameters": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags that will be assigned to the key." + }, + "properties": { + "$ref": "#/definitions/KeyProperties", + "description": "The properties of the key to be created." + } + }, + "description": "The parameters used to create a key.", + "required": [ + "properties" + ], + "x-ms-azure-resource": true, + "type": "object" + }, + "Key": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/KeyProperties", + "description": "The properties of the key." + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "./keyvault.json#/definitions/Resource" + } + ], + "description": "The key resource.", + "type": "object" + }, + "KeyListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Key" + }, + "description": "The key resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next page of keys." + } + }, + "description": "The page of keys.", + "type": "object" + }, + "RotationPolicy": { + "properties": { + "attributes": { + "$ref": "#/definitions/KeyRotationPolicyAttributes", + "description": "The attributes of key rotation policy." + }, + "lifetimeActions": { + "type": "array", + "items": { + "$ref": "#/definitions/LifetimeAction" + }, + "description": "The lifetimeActions for key rotation action." + } + }, + "type": "object" + }, + "KeyRotationPolicyAttributes": { + "properties": { + "created": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Creation time in seconds since 1970-01-01T00:00:00Z." + }, + "updated": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Last updated time in seconds since 1970-01-01T00:00:00Z." + }, + "expiryTime": { + "type": "string", + "description": "The expiration time for the new key version. It should be in ISO8601 format. Eg: 'P90D', 'P1Y'." + } + }, + "type": "object" + }, + "LifetimeAction": { + "properties": { + "trigger": { + "$ref": "#/definitions/Trigger", + "description": "The trigger of key rotation policy lifetimeAction." + }, + "action": { + "$ref": "#/definitions/Action", + "description": "The action of key rotation policy lifetimeAction." + } + }, + "type": "object" + }, + "Trigger": { + "properties": { + "timeAfterCreate": { + "type": "string", + "description": "The time duration after key creation to rotate the key. It should be in ISO8601 format. Eg: 'P90D', 'P1Y'." + }, + "timeBeforeExpiry": { + "type": "string", + "description": "The time duration before key expiring to rotate the key. It should be in ISO8601 format. Eg: 'P90D', 'P1Y'." + } + }, + "type": "object" + }, + "Action": { + "properties": { + "type": { + "type": "string", + "description": "The type of action.", + "enum": [ + "rotate", + "notify" + ], + "x-ms-enum": { + "name": "KeyRotationPolicyActionType", + "modelAsString": false + } + } + }, + "type": "object" + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + }, + "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" + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/keyvault.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/keyvault.json new file mode 100644 index 000000000000..cacd456d6aef --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/keyvault.json @@ -0,0 +1,2036 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01-preview", + "title": "KeyVaultManagementClient", + "description": "The Azure management API provides a RESTful set of web services that interact with Azure Key Vault." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}": { + "put": { + "tags": [ + "Vaults" + ], + "operationId": "Vaults_CreateOrUpdate", + "x-ms-long-running-operation": true, + "description": "Create or update a key vault in the specified subscription.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Resource Group to which the server belongs." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$", + "description": "Name of the vault" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VaultCreateOrUpdateParameters" + }, + "description": "Parameters to create or update the vault" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Created or updated vault", + "schema": { + "$ref": "#/definitions/Vault" + } + }, + "200": { + "description": "Created or updated vault", + "schema": { + "$ref": "#/definitions/Vault" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a new vault or update an existing vault": { + "$ref": "./examples/createVault.json" + }, + "Create or update a vault with network acls": { + "$ref": "./examples/createVaultWithNetworkAcls.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "patch": { + "tags": [ + "Vaults" + ], + "operationId": "Vaults_Update", + "description": "Update a key vault in the specified subscription.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Resource Group to which the server belongs." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$", + "description": "Name of the vault" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VaultPatchParameters" + }, + "description": "Parameters to patch the vault" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Patched vault", + "schema": { + "$ref": "#/definitions/Vault" + } + }, + "200": { + "description": "Patched vault", + "schema": { + "$ref": "#/definitions/Vault" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update an existing vault": { + "$ref": "./examples/updateVault.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "tags": [ + "Vaults" + ], + "operationId": "Vaults_Delete", + "description": "Deletes the specified Azure key vault.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Resource Group to which the vault belongs." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vault to delete" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK Response." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete a vault": { + "$ref": "./examples/deleteVault.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "get": { + "tags": [ + "Vaults" + ], + "operationId": "Vaults_Get", + "description": "Gets the specified Azure key vault.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Resource Group to which the vault belongs." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vault." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Retrieved vault", + "schema": { + "$ref": "#/definitions/Vault" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Retrieve a vault": { + "$ref": "./examples/getVault.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/accessPolicies/{operationKind}": { + "put": { + "tags": [ + "Vaults" + ], + "operationId": "Vaults_UpdateAccessPolicy", + "description": "Update access policies in a key vault in the specified subscription.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Resource Group to which the vault belongs." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$", + "description": "Name of the vault" + }, + { + "name": "operationKind", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "add", + "replace", + "remove" + ], + "x-ms-enum": { + "name": "AccessPolicyUpdateKind", + "modelAsString": false + }, + "description": "Name of the operation" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VaultAccessPolicyParameters" + }, + "description": "Access policy to merge into the vault" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The updated access policies", + "schema": { + "$ref": "#/definitions/VaultAccessPolicyParameters" + } + }, + "200": { + "description": "The updated access policies", + "schema": { + "$ref": "#/definitions/VaultAccessPolicyParameters" + } + }, + "404": { + "description": "The specified resource does not exist.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + }, + "x-ms-error-response": true + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Add an access policy, or update an access policy with new permissions": { + "$ref": "./examples/updateAccessPoliciesAdd.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults": { + "get": { + "tags": [ + "Vaults" + ], + "operationId": "Vaults_ListByResourceGroup", + "description": "The List operation gets information about the vaults associated with the subscription and within the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Resource Group to which the vault belongs." + }, + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "Maximum number of results to return." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Get information about all key vaults in the specified resource group.", + "schema": { + "$ref": "#/definitions/VaultListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List vaults in the specified resource group": { + "$ref": "./examples/listVaultByResourceGroup.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/vaults": { + "get": { + "tags": [ + "Vaults" + ], + "operationId": "Vaults_ListBySubscription", + "description": "The List operation gets information about the vaults associated with the subscription.", + "parameters": [ + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "Maximum number of results to return." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Get information about all key vaults in the specified subscription.", + "schema": { + "$ref": "#/definitions/VaultListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List vaults in the specified subscription": { + "$ref": "./examples/listVaultBySubscription.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/deletedVaults": { + "get": { + "tags": [ + "Vaults" + ], + "operationId": "Vaults_ListDeleted", + "description": "Gets information about the deleted vaults in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Retrieved information about all deleted key vaults in a subscription.", + "schema": { + "$ref": "#/definitions/DeletedVaultListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List deleted vaults in the specified subscription": { + "$ref": "./examples/listDeletedVaults.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/locations/{location}/deletedVaults/{vaultName}": { + "get": { + "tags": [ + "Vaults" + ], + "operationId": "Vaults_GetDeleted", + "description": "Gets the deleted Azure key vault.", + "parameters": [ + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vault." + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the deleted vault." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Retrieved information about the deleted vault.", + "schema": { + "$ref": "#/definitions/DeletedVault" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Retrieve a deleted vault": { + "$ref": "./examples/getDeletedVault.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/locations/{location}/deletedVaults/{vaultName}/purge": { + "post": { + "tags": [ + "Vaults" + ], + "operationId": "Vaults_PurgeDeleted", + "x-ms-long-running-operation": true, + "description": "Permanently deletes the specified vault. aka Purges the deleted Azure key vault.", + "parameters": [ + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the soft-deleted vault." + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the soft-deleted vault." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The vault is purged." + }, + "202": { + "description": "Vault is being purged." + }, + "404": { + "description": "The specified resource does not exist.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + }, + "x-ms-error-response": true + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Purge a deleted vault": { + "$ref": "./examples/purgeDeletedVault.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resources": { + "get": { + "tags": [ + "Vaults" + ], + "operationId": "Vaults_List", + "description": "The List operation gets information about the vaults associated with the subscription.", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "resourceType eq 'Microsoft.KeyVault/vaults'" + ], + "description": "The filter to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "Maximum number of results to return." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "x-ms-api-version": false, + "type": "string", + "enum": [ + "2015-11-01" + ], + "description": "Azure Resource Manager Api Version." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Get information about all key vaults in the subscription.", + "schema": { + "$ref": "#/definitions/ResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List vaults in the specified subscription": { + "$ref": "./examples/listVault.json" + } + }, + "produces": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/checkNameAvailability": { + "post": { + "tags": [ + "Vaults" + ], + "operationId": "Vaults_CheckNameAvailability", + "description": "Checks that the vault name is valid and is not already in use.", + "parameters": [ + { + "name": "vaultName", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VaultCheckNameAvailabilityParameters" + }, + "description": "The name of the vault." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Operation to check the vault name availability was successful.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Validate a vault name": { + "$ref": "./examples/checkVaultNameAvailability.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "description": "Gets the specified private endpoint connection associated with the key vault.", + "x-ms-examples": { + "KeyVaultGetPrivateEndpointConnection": { + "$ref": "./examples/getPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Private endpoint connection successfully returned.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "204": { + "description": "The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Put", + "description": "Updates the specified private endpoint connection associated with the key vault.", + "x-ms-examples": { + "KeyVaultPutPrivateEndpointConnection": { + "$ref": "./examples/putPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The intended state of private endpoint connection." + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The state of private endpoint connection was updated successfully.", + "headers": { + "Retry-After": { + "description": "(specified only if operation does not finish synchronously) The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int32" + }, + "Azure-AsyncOperation": { + "description": "(specified only if operation does not finish synchronously) The URI to poll for completion status. The response of this URI may be synchronous or asynchronous.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "description": "Deletes the specified private endpoint connection associated with the key vault.", + "x-ms-examples": { + "KeyVaultDeletePrivateEndpointConnection": { + "$ref": "./examples/deletePrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The private endpoint connection was successfully deleted.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "202": { + "description": "The private endpoint connection is being deleted.", + "headers": { + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in the location header.", + "type": "integer", + "format": "int32" + }, + "Location": { + "description": "The URI to poll for completion status.", + "type": "string" + } + } + }, + "204": { + "description": "The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_ListByResource", + "description": "The List operation gets information about the private endpoint connections associated with the vault.", + "x-ms-examples": { + "KeyVaultListPrivateEndpointConnection": { + "$ref": "./examples/listPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Get information about all private endpoint connections in the specified resource group.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_ListByVault", + "description": "Gets the private link resources supported for the key vault.", + "x-ms-examples": { + "KeyVaultListPrivateLinkResources": { + "$ref": "./examples/listPrivateLinkResources.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "Sku": { + "properties": { + "family": { + "type": "string", + "description": "SKU family name", + "enum": [ + "A" + ], + "x-ms-client-default": "A", + "x-ms-enum": { + "name": "SkuFamily", + "modelAsString": true + } + }, + "name": { + "type": "string", + "description": "SKU name to specify whether the key vault is a standard vault or a premium vault.", + "enum": [ + "standard", + "premium" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": false + } + } + }, + "description": "SKU details", + "required": [ + "name", + "family" + ] + }, + "AccessPolicyEntry": { + "properties": { + "tenantId": { + "type": "string", + "format": "uuid", + "description": "The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault." + }, + "objectId": { + "type": "string", + "description": "The object ID of a user, service principal or security group in the Azure Active Directory tenant for the vault. The object ID must be unique for the list of access policies." + }, + "applicationId": { + "type": "string", + "format": "uuid", + "description": " Application ID of the client making request on behalf of a principal" + }, + "permissions": { + "$ref": "#/definitions/Permissions", + "description": "Permissions the identity has for keys, secrets and certificates." + } + }, + "description": "An identity that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID.", + "required": [ + "tenantId", + "objectId", + "permissions" + ] + }, + "Permissions": { + "properties": { + "keys": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "all", + "encrypt", + "decrypt", + "wrapKey", + "unwrapKey", + "sign", + "verify", + "get", + "list", + "create", + "update", + "import", + "delete", + "backup", + "restore", + "recover", + "purge", + "release" + ], + "x-ms-enum": { + "name": "KeyPermissions", + "modelAsString": true + } + }, + "description": "Permissions to keys" + }, + "secrets": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "all", + "get", + "list", + "set", + "delete", + "backup", + "restore", + "recover", + "purge" + ], + "x-ms-enum": { + "name": "SecretPermissions", + "modelAsString": true + } + }, + "description": "Permissions to secrets" + }, + "certificates": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "all", + "get", + "list", + "delete", + "create", + "import", + "update", + "managecontacts", + "getissuers", + "listissuers", + "setissuers", + "deleteissuers", + "manageissuers", + "recover", + "purge", + "backup", + "restore" + ], + "x-ms-enum": { + "name": "CertificatePermissions", + "modelAsString": true + } + }, + "description": "Permissions to certificates" + }, + "storage": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "all", + "get", + "list", + "delete", + "set", + "update", + "regeneratekey", + "recover", + "purge", + "backup", + "restore", + "setsas", + "listsas", + "getsas", + "deletesas" + ], + "x-ms-enum": { + "name": "StoragePermissions", + "modelAsString": true + } + }, + "description": "Permissions to storage accounts" + } + }, + "description": "Permissions the identity has for keys, secrets, certificates and storage." + }, + "VaultProperties": { + "properties": { + "tenantId": { + "type": "string", + "format": "uuid", + "description": "The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault." + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "SKU details" + }, + "accessPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/AccessPolicyEntry" + }, + "description": "An array of 0 to 1024 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID. When `createMode` is set to `recover`, access policies are not required. Otherwise, access policies are required." + }, + "vaultUri": { + "type": "string", + "description": "The URI of the vault for performing operations on keys and secrets." + }, + "hsmPoolResourceId": { + "type": "string", + "description": "The resource id of HSM Pool.", + "readOnly": true + }, + "enabledForDeployment": { + "type": "boolean", + "description": "Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault." + }, + "enabledForDiskEncryption": { + "type": "boolean", + "description": "Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys." + }, + "enabledForTemplateDeployment": { + "type": "boolean", + "description": "Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault." + }, + "enableSoftDelete": { + "type": "boolean", + "default": true, + "description": "Property to specify whether the 'soft delete' functionality is enabled for this key vault. If it's not set to any value(true or false) when creating new key vault, it will be set to true by default. Once set to true, it cannot be reverted to false." + }, + "softDeleteRetentionInDays": { + "type": "integer", + "format": "int32", + "default": 90, + "description": "softDelete data retention days. It accepts >=7 and <=90." + }, + "enableRbacAuthorization": { + "type": "boolean", + "default": false, + "description": "Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored (warning: this is a preview feature). When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the vault is created with the default value of false. Note that management actions are always authorized with RBAC." + }, + "createMode": { + "type": "string", + "description": "The vault's create mode to indicate whether the vault need to be recovered or not.", + "enum": [ + "recover", + "default" + ], + "x-ms-enum": { + "name": "CreateMode", + "modelAsString": false + }, + "x-ms-mutability": [ + "create", + "update" + ] + }, + "enablePurgeProtection": { + "type": "boolean", + "description": "Property specifying whether protection against purge is enabled for this vault. Setting this property to true activates protection against purge for this vault and its content - only the Key Vault service may initiate a hard, irrecoverable deletion. The setting is effective only if soft delete is also enabled. Enabling this functionality is irreversible - that is, the property does not accept false as its value." + }, + "networkAcls": { + "$ref": "#/definitions/NetworkRuleSet", + "description": "Rules governing the accessibility of the key vault from specific network locations." + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the vault.", + "enum": [ + "Succeeded", + "RegisteringDns" + ], + "x-ms-enum": { + "name": "VaultProvisioningState", + "modelAsString": true + } + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnectionItem" + }, + "description": "List of private endpoint connections associated with the key vault." + }, + "publicNetworkAccess": { + "type": "string", + "default": "enabled", + "description": "Property to specify whether the vault will accept traffic from public internet. If set to 'disabled' all traffic except private endpoint traffic and that that originates from trusted services will be blocked. This will override the set firewall rules, meaning that even if the firewall rules are present we will not honor the rules." + } + }, + "required": [ + "tenantId", + "sku" + ], + "description": "Properties of the vault" + }, + "VaultPatchProperties": { + "properties": { + "tenantId": { + "type": "string", + "format": "uuid", + "description": "The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault." + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "SKU details" + }, + "accessPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/AccessPolicyEntry" + }, + "description": "An array of 0 to 16 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID." + }, + "enabledForDeployment": { + "type": "boolean", + "description": "Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault." + }, + "enabledForDiskEncryption": { + "type": "boolean", + "description": "Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys." + }, + "enabledForTemplateDeployment": { + "type": "boolean", + "description": "Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault." + }, + "enableSoftDelete": { + "type": "boolean", + "description": "Property to specify whether the 'soft delete' functionality is enabled for this key vault. Once set to true, it cannot be reverted to false." + }, + "enableRbacAuthorization": { + "type": "boolean", + "description": "Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored (warning: this is a preview feature). When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the value of this property will not change." + }, + "softDeleteRetentionInDays": { + "type": "integer", + "format": "int32", + "description": "softDelete data retention days. It accepts >=7 and <=90." + }, + "createMode": { + "type": "string", + "description": "The vault's create mode to indicate whether the vault need to be recovered or not.", + "enum": [ + "recover", + "default" + ], + "x-ms-enum": { + "name": "CreateMode", + "modelAsString": false + } + }, + "enablePurgeProtection": { + "type": "boolean", + "description": "Property specifying whether protection against purge is enabled for this vault. Setting this property to true activates protection against purge for this vault and its content - only the Key Vault service may initiate a hard, irrecoverable deletion. The setting is effective only if soft delete is also enabled. Enabling this functionality is irreversible - that is, the property does not accept false as its value." + }, + "networkAcls": { + "$ref": "#/definitions/NetworkRuleSet", + "description": "A collection of rules governing the accessibility of the vault from specific network locations." + }, + "publicNetworkAccess": { + "type": "string", + "description": "Property to specify whether the vault will accept traffic from public internet. If set to 'disabled' all traffic except private endpoint traffic and that that originates from trusted services will be blocked. This will override the set firewall rules, meaning that even if the firewall rules are present we will not honor the rules." + } + }, + "description": "Properties of the vault" + }, + "VaultAccessPolicyProperties": { + "properties": { + "accessPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/AccessPolicyEntry" + }, + "description": "An array of 0 to 16 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID." + } + }, + "required": [ + "accessPolicies" + ], + "description": "Properties of the vault access policy" + }, + "DeletedVaultProperties": { + "properties": { + "vaultId": { + "readOnly": true, + "type": "string", + "description": "The resource id of the original vault." + }, + "location": { + "readOnly": true, + "type": "string", + "description": "The location of the original vault." + }, + "deletionDate": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The deleted date." + }, + "scheduledPurgeDate": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The scheduled purged date." + }, + "tags": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Tags of the original vault." + }, + "purgeProtectionEnabled": { + "readOnly": true, + "type": "boolean", + "description": "Purge protection status of the original vault." + } + }, + "description": "Properties of the deleted vault." + }, + "VaultCreateOrUpdateParameters": { + "properties": { + "location": { + "type": "string", + "description": "The supported Azure location where the key vault should be created." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags that will be assigned to the key vault." + }, + "properties": { + "$ref": "#/definitions/VaultProperties", + "description": "Properties of the vault" + } + }, + "description": "Parameters for creating or updating a vault", + "required": [ + "location", + "properties" + ], + "x-ms-azure-resource": true + }, + "VaultPatchParameters": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags that will be assigned to the key vault. " + }, + "properties": { + "$ref": "#/definitions/VaultPatchProperties", + "description": "Properties of the vault" + } + }, + "description": "Parameters for creating or updating a vault", + "x-ms-azure-resource": true + }, + "VaultAccessPolicyParameters": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource id of the access policy." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name of the access policy." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource name of the access policy." + }, + "location": { + "readOnly": true, + "type": "string", + "description": "The resource type of the access policy." + }, + "properties": { + "$ref": "#/definitions/VaultAccessPolicyProperties", + "description": "Properties of the access policy" + } + }, + "description": "Parameters for updating the access policy in a vault", + "required": [ + "properties" + ], + "x-ms-azure-resource": true + }, + "Vault": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified identifier of the key vault resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the key vault resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type of the key vault resource." + }, + "location": { + "type": "string", + "description": "Azure location of the key vault resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Tags assigned to the key vault resource." + }, + "systemData": { + "description": "System metadata for the key vault.", + "$ref": "common.json#/definitions/SystemData" + }, + "properties": { + "$ref": "#/definitions/VaultProperties", + "description": "Properties of the vault" + } + }, + "required": [ + "properties" + ], + "description": "Resource information with extended details.", + "x-ms-azure-resource": true + }, + "DeletedVault": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource ID for the deleted key vault." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the key vault." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type of the key vault." + }, + "properties": { + "$ref": "#/definitions/DeletedVaultProperties", + "description": "Properties of the vault" + } + }, + "description": "Deleted vault information with extended details." + }, + "VaultListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Vault" + }, + "description": "The list of vaults." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of vaults." + } + }, + "description": "List of vaults" + }, + "DeletedVaultListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DeletedVault" + }, + "description": "The list of deleted vaults." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of deleted vaults." + } + }, + "description": "List of vaults" + }, + "ResourceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Resource" + }, + "description": "The list of vault resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of vault resources." + } + }, + "description": "List of vault resources." + }, + "Resource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified identifier of the key vault resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the key vault resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type of the key vault resource." + }, + "location": { + "readOnly": true, + "type": "string", + "description": "Azure location of the key vault resource." + }, + "tags": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Tags assigned to the key vault resource." + } + }, + "description": "Key Vault resource", + "x-ms-azure-resource": true + }, + "VaultCheckNameAvailabilityParameters": { + "properties": { + "name": { + "type": "string", + "description": "The vault name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.KeyVault/vaults" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": false + }, + "description": "The type of resource, Microsoft.KeyVault/vaults" + } + }, + "required": [ + "name", + "type" + ], + "description": "The parameters used to check the availability of the vault name." + }, + "CheckNameAvailabilityResult": { + "properties": { + "nameAvailable": { + "readOnly": true, + "type": "boolean", + "description": "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 is invalid and cannot be used." + }, + "reason": { + "readOnly": true, + "type": "string", + "description": "The reason that a vault name could not be used. The Reason element is only returned if NameAvailable is false.", + "enum": [ + "AccountNameInvalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "Reason", + "modelAsString": false + } + }, + "message": { + "readOnly": true, + "type": "string", + "description": "An error message explaining the Reason value in more detail." + } + }, + "description": "The CheckNameAvailability operation response." + }, + "NetworkRuleSet": { + "properties": { + "bypass": { + "type": "string", + "description": "Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'.", + "enum": [ + "AzureServices", + "None" + ], + "x-ms-enum": { + "name": "NetworkRuleBypassOptions", + "modelAsString": true + } + }, + "defaultAction": { + "type": "string", + "description": "The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "NetworkRuleAction", + "modelAsString": true + } + }, + "ipRules": { + "type": "array", + "items": { + "$ref": "#/definitions/IPRule" + }, + "description": "The list of IP address rules." + }, + "virtualNetworkRules": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkRule" + }, + "description": "The list of virtual network rules." + } + }, + "description": "A set of rules governing the network accessibility of a vault." + }, + "IPRule": { + "properties": { + "value": { + "type": "string", + "description": "An IPv4 address range in CIDR notation, such as '124.56.78.91' (simple IP address) or '124.56.78.0/24' (all addresses that start with 124.56.78)." + } + }, + "required": [ + "value" + ], + "description": "A rule governing the accessibility of a vault from a specific ip address or ip range." + }, + "VirtualNetworkRule": { + "properties": { + "id": { + "type": "string", + "description": "Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'." + }, + "ignoreMissingVnetServiceEndpoint": { + "type": "boolean", + "description": "Property to specify whether NRP will ignore the check if parent subnet has serviceEndpoints configured." + } + }, + "required": [ + "id" + ], + "description": "A rule governing the accessibility of a vault from a specific virtual network." + }, + "PrivateEndpointConnectionItem": { + "properties": { + "id": { + "type": "string", + "description": "Id of private endpoint connection." + }, + "etag": { + "type": "string", + "description": "Modified whenever there is a change in the state of private endpoint connection." + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "x-ms-client-flatten": true, + "description": "Private endpoint connection properties." + } + }, + "description": "Private endpoint connection item." + }, + "PrivateEndpointConnection": { + "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": "#/definitions/Resource" + } + ], + "description": "Private endpoint connection resource.", + "x-ms-azure-resource": true + }, + "PrivateEndpointConnectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The list of private endpoint connections." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of private endpoint connections." + } + }, + "description": "List of private endpoint connections." + }, + "PrivateEndpointConnectionProperties": { + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "Properties of the private endpoint object." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "Approval state of the private link connection." + }, + "provisioningState": { + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState", + "description": "Provisioning state of the private endpoint connection." + } + }, + "description": "Properties of the private endpoint connection resource." + }, + "PrivateEndpoint": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Full identifier of the private endpoint resource." + } + }, + "description": "Private endpoint object properties." + }, + "PrivateLinkServiceConnectionState": { + "properties": { + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", + "description": "Indicates whether the connection has been approved, rejected or removed by the key vault owner." + }, + "description": { + "type": "string", + "description": "The reason for approval or rejection." + }, + "actionsRequired": { + "type": "string", + "description": "A message indicating if changes on the service provider require any updates on the consumer.", + "enum": [ + "None" + ], + "x-ms-enum": { + "name": "ActionsRequired", + "modelAsString": true + } + } + }, + "description": "An object that represents the approval state of the private link connection." + }, + "PrivateEndpointServiceConnectionStatus": { + "type": "string", + "description": "The private endpoint connection status.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "x-ms-enum": { + "name": "PrivateEndpointServiceConnectionStatus", + "modelAsString": true + } + }, + "PrivateEndpointConnectionProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Updating", + "Deleting", + "Failed", + "Disconnected" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "PrivateLinkResourceListResult": { + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + }, + "description": "A list of private link resources" + }, + "PrivateLinkResource": { + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "A private link resource" + }, + "PrivateLinkResourceProperties": { + "properties": { + "groupId": { + "description": "Group identifier of private link resource.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "Required member names of private link resource.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Required DNS zone names of the the private link resource." + } + }, + "description": "Properties of a private link resource." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the resource group that contains the key vault.", + "x-ms-parameter-location": "method" + }, + "VaultName": { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$", + "description": "The name of the key vault.", + "x-ms-parameter-location": "method" + }, + "PrivateEndpointConnectionName": { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the private endpoint connection associated with the key vault.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + }, + "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" + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/managedHsm.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/managedHsm.json new file mode 100644 index 000000000000..5db534b75d8e --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/managedHsm.json @@ -0,0 +1,1426 @@ +{ + "swagger": "2.0", + "info": { + "title": "KeyVaultManagementClient", + "description": "The Azure management API provides a RESTful set of web services that interact with Azure Key Vault.", + "version": "2021-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs/{name}": { + "put": { + "tags": [ + "ManagedHsms" + ], + "operationId": "ManagedHsms_CreateOrUpdate", + "x-ms-long-running-operation": true, + "description": "Create or update a managed HSM Pool in the specified subscription.", + "parameters": [ + { + "$ref": "#/parameters/ManagedHsmResourceGroupName" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the managed HSM Pool" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedHsm" + }, + "description": "Parameters to create or update the managed HSM Pool" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ManagedHsm" + } + }, + "200": { + "description": "Created or updated managed HSM Pool", + "schema": { + "$ref": "#/definitions/ManagedHsm" + } + }, + "default": { + "description": "The error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ManagedHsmError" + } + } + }, + "x-ms-examples": { + "Create a new managed HSM Pool or update an existing managed HSM Pool": { + "$ref": "./examples/ManagedHsm_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "ManagedHsms" + ], + "operationId": "ManagedHsms_Update", + "x-ms-long-running-operation": true, + "description": "Update a managed HSM Pool in the specified subscription.", + "parameters": [ + { + "$ref": "#/parameters/ManagedHsmResourceGroupName" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the managed HSM Pool" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedHsm" + }, + "description": "Parameters to patch the managed HSM Pool" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ManagedHsm" + } + }, + "200": { + "description": "Patched managed HSM Pool", + "schema": { + "$ref": "#/definitions/ManagedHsm" + } + }, + "default": { + "description": "The error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ManagedHsmError" + } + } + }, + "x-ms-examples": { + "Update an existing managed HSM Pool": { + "$ref": "./examples/ManagedHsm_Update.json" + } + } + }, + "delete": { + "tags": [ + "ManagedHsms" + ], + "operationId": "ManagedHsms_Delete", + "description": "Deletes the specified managed HSM Pool.", + "parameters": [ + { + "$ref": "#/parameters/ManagedHsmResourceGroupName" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed HSM Pool to delete" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "The error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ManagedHsmError" + } + } + }, + "x-ms-examples": { + "Delete a managed HSM Pool": { + "$ref": "./examples/ManagedHsm_Delete.json" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "ManagedHsms" + ], + "operationId": "ManagedHsms_Get", + "description": "Gets the specified managed HSM Pool.", + "parameters": [ + { + "$ref": "#/parameters/ManagedHsmResourceGroupName" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed HSM Pool." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Retrieved managed HSM Pool", + "schema": { + "$ref": "#/definitions/ManagedHsm" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "The error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ManagedHsmError" + } + } + }, + "x-ms-examples": { + "Retrieve a managed HSM Pool": { + "$ref": "./examples/ManagedHsm_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs": { + "get": { + "tags": [ + "ManagedHsms" + ], + "operationId": "ManagedHsms_ListByResourceGroup", + "description": "The List operation gets information about the managed HSM Pools associated with the subscription and within the specified resource group.", + "parameters": [ + { + "$ref": "#/parameters/ManagedHsmResourceGroupName" + }, + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "Maximum number of results to return." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Get information about all managed HSM Pools in the specified resource group.", + "schema": { + "$ref": "#/definitions/ManagedHsmListResult" + } + }, + "default": { + "description": "The error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ManagedHsmError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List managed HSM Pools in a resource group": { + "$ref": "./examples/ManagedHsm_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/managedHSMs": { + "get": { + "tags": [ + "ManagedHsms" + ], + "operationId": "ManagedHsms_ListBySubscription", + "description": "The List operation gets information about the managed HSM Pools associated with the subscription.", + "parameters": [ + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "Maximum number of results to return." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Get information about all managed HSM Pools in the specified subscription.", + "schema": { + "$ref": "#/definitions/ManagedHsmListResult" + } + }, + "default": { + "description": "The error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ManagedHsmError" + } + } + }, + "x-ms-examples": { + "List managed HSM Pools in a subscription": { + "$ref": "./examples/ManagedHsm_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs/{name}/privateEndpointConnections": { + "get": { + "tags": [ + "MHSMListPrivateEndpointConnections" + ], + "operationId": "MHSMPrivateEndpointConnections_ListByResource", + "description": "The List operation gets information about the private endpoint connections associated with the managed HSM Pool.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ManagedHsmResourceGroupName" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the managed HSM Pool" + } + ], + "responses": { + "200": { + "description": "Get information about all managed HSM Pools in the specified subscription.", + "schema": { + "$ref": "#/definitions/MHSMPrivateEndpointConnectionsListResult" + } + }, + "default": { + "description": "The error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ManagedHsmError" + } + } + }, + "x-ms-examples": { + "List managed HSM Pools in a subscription": { + "$ref": "./examples/ManagedHsm_ListPrivateEndpointConnectionsByResource.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/deletedManagedHSMs": { + "get": { + "tags": [ + "ManagedHsms" + ], + "operationId": "ManagedHsms_ListDeleted", + "description": "The List operation gets information about the deleted managed HSMs associated with the subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Retrieved information about all managed HSMs in the specified subscription.", + "schema": { + "$ref": "#/definitions/DeletedManagedHsmListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ManagedHsmError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List deleted managed HSMs in the specified subscription": { + "$ref": "./examples/DeletedManagedHsm_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/locations/{location}/deletedManagedHSMs/{name}": { + "get": { + "tags": [ + "ManagedHsms" + ], + "operationId": "ManagedHsms_GetDeleted", + "description": "Gets the specified deleted managed HSM.", + "parameters": [ + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deleted managed HSM." + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the deleted managed HSM." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Retrieved information about the specified deleted managed HSM.", + "schema": { + "$ref": "#/definitions/DeletedManagedHsm" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ManagedHsmError" + } + } + }, + "x-ms-examples": { + "Retrieve a deleted managed HSM": { + "$ref": "./examples/DeletedManagedHsm_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/locations/{location}/deletedManagedHSMs/{name}/purge": { + "post": { + "tags": [ + "ManagedHsms" + ], + "operationId": "ManagedHsms_PurgeDeleted", + "description": "Permanently deletes the specified managed HSM.", + "parameters": [ + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the soft-deleted managed HSM." + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the soft-deleted managed HSM." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "The error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ManagedHsmError" + } + } + }, + "x-ms-examples": { + "Purge a managed HSM Pool": { + "$ref": "./examples/DeletedManagedHsm_Purge.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs/{name}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "MHSMPrivateEndpointConnections" + ], + "operationId": "MHSMPrivateEndpointConnections_Get", + "description": "Gets the specified private endpoint connection associated with the managed HSM Pool.", + "x-ms-examples": { + "ManagedHsmGetPrivateEndpointConnection": { + "$ref": "./examples/ManagedHsm_getPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ManagedHsmResourceGroupName" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the managed HSM Pool" + }, + { + "$ref": "#/parameters/MHSMPrivateEndpointConnectionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Private endpoint connection successfully returned.", + "schema": { + "$ref": "#/definitions/MHSMPrivateEndpointConnection" + } + }, + "default": { + "description": "The error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ManagedHsmError" + } + } + } + }, + "put": { + "tags": [ + "MHSMPrivateEndpointConnections" + ], + "operationId": "MHSMPrivateEndpointConnections_Put", + "description": "Updates the specified private endpoint connection associated with the managed hsm pool.", + "x-ms-examples": { + "ManagedHsmPutPrivateEndpointConnection": { + "$ref": "./examples/ManagedHsm_putPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ManagedHsmResourceGroupName" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the managed HSM Pool" + }, + { + "$ref": "#/parameters/MHSMPrivateEndpointConnectionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MHSMPrivateEndpointConnection" + }, + "description": "The intended state of private endpoint connection." + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The state of private endpoint connection was updated successfully.", + "headers": { + "Retry-After": { + "description": "(specified only if operation does not finish synchronously) The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int32" + }, + "Azure-AsyncOperation": { + "description": "(specified only if operation does not finish synchronously) The URI to poll for completion status. The response of this URI may be synchronous or asynchronous.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/MHSMPrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "MHSMPrivateEndpointConnections" + ], + "operationId": "MHSMPrivateEndpointConnections_Delete", + "description": "Deletes the specified private endpoint connection associated with the managed hsm pool.", + "x-ms-examples": { + "ManagedHsmDeletePrivateEndpointConnection": { + "$ref": "./examples/ManagedHsm_deletePrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ManagedHsmResourceGroupName" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the managed HSM Pool" + }, + { + "$ref": "#/parameters/MHSMPrivateEndpointConnectionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The private endpoint connection was successfully deleted.", + "schema": { + "$ref": "#/definitions/MHSMPrivateEndpointConnection" + } + }, + "202": { + "description": "The private endpoint connection is being deleted.", + "headers": { + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in the location header.", + "type": "integer", + "format": "int32" + }, + "Location": { + "description": "The URI to poll for completion status.", + "type": "string" + } + } + }, + "204": { + "description": "The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs/{name}/privateLinkResources": { + "get": { + "tags": [ + "MHSMPrivateLinkResources" + ], + "operationId": "MHSMPrivateLinkResources_ListByMHSMResource", + "description": "Gets the private link resources supported for the managed hsm pool.", + "x-ms-examples": { + "KeyVaultListPrivateLinkResources": { + "$ref": "./examples/ManagedHsm_listPrivateLinkResources.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ManagedHsmResourceGroupName" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the managed HSM Pool" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "#/definitions/MHSMPrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "ManagedHsmSku": { + "properties": { + "family": { + "type": "string", + "description": "SKU Family of the managed HSM Pool", + "enum": [ + "B" + ], + "x-ms-client-default": "B", + "x-ms-enum": { + "name": "ManagedHsmSkuFamily", + "modelAsString": true + } + }, + "name": { + "type": "string", + "description": "SKU of the managed HSM Pool", + "enum": [ + "Standard_B1", + "Custom_B32" + ], + "x-ms-enum": { + "name": "ManagedHsmSkuName", + "modelAsString": false + } + } + }, + "description": "SKU details", + "required": [ + "name", + "family" + ] + }, + "ManagedHsmProperties": { + "properties": { + "tenantId": { + "type": "string", + "format": "uuid", + "description": "The Azure Active Directory tenant ID that should be used for authenticating requests to the managed HSM pool." + }, + "initialAdminObjectIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of initial administrators object ids for this managed hsm pool." + }, + "hsmUri": { + "type": "string", + "readOnly": true, + "description": "The URI of the managed hsm pool for performing operations on keys." + }, + "enableSoftDelete": { + "type": "boolean", + "default": true, + "description": "Property to specify whether the 'soft delete' functionality is enabled for this managed HSM pool. If it's not set to any value(true or false) when creating new managed HSM pool, it will be set to true by default. Once set to true, it cannot be reverted to false." + }, + "softDeleteRetentionInDays": { + "type": "integer", + "format": "int32", + "default": 90, + "description": "softDelete data retention days. It accepts >=7 and <=90." + }, + "enablePurgeProtection": { + "type": "boolean", + "default": true, + "description": "Property specifying whether protection against purge is enabled for this managed HSM pool. Setting this property to true activates protection against purge for this managed HSM pool and its content - only the Managed HSM service may initiate a hard, irrecoverable deletion. The setting is effective only if soft delete is also enabled. Enabling this functionality is irreversible." + }, + "createMode": { + "type": "string", + "description": "The create mode to indicate whether the resource is being created or is being recovered from a deleted resource.", + "enum": [ + "recover", + "default" + ], + "x-ms-enum": { + "name": "CreateMode", + "modelAsString": false, + "values": [ + { + "value": "recover", + "description": "Recover the managed HSM pool from a soft-deleted resource." + }, + { + "value": "default", + "description": "Create a new managed HSM pool. This is the default option." + } + ] + } + }, + "statusMessage": { + "readOnly": true, + "type": "string", + "description": "Resource Status Message." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state.", + "enum": [ + "Succeeded", + "Provisioning", + "Failed", + "Updating", + "Deleting", + "Activated", + "SecurityDomainRestore", + "Restoring" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Succeeded", + "description": "The managed HSM Pool has been full provisioned." + }, + { + "value": "Provisioning", + "description": "The managed HSM Pool is currently being provisioned." + }, + { + "value": "Failed", + "description": "Provisioning of the managed HSM Pool has failed." + }, + { + "value": "Updating", + "description": "The managed HSM Pool is currently being updated." + }, + { + "value": "Deleting", + "description": "The managed HSM Pool is currently being deleted." + }, + { + "value": "Activated", + "description": "The managed HSM pool is ready for normal use." + }, + { + "value": "SecurityDomainRestore", + "description": "The managed HSM pool is waiting for a security domain restore action." + }, + { + "value": "Restoring", + "description": "The managed HSM pool is being restored from full HSM backup." + } + ] + } + }, + "networkAcls": { + "$ref": "#/definitions/MHSMNetworkRuleSet", + "description": "Rules governing the accessibility of the key vault from specific network locations." + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/MHSMPrivateEndpointConnectionItem" + }, + "description": "List of private endpoint connections associated with the managed hsm pool." + }, + "publicNetworkAccess": { + "description": "Control permission for data plane traffic coming from public networks while private endpoint is enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + }, + "scheduledPurgeDate": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The scheduled purge date in UTC." + } + }, + "description": "Properties of the managed HSM Pool" + }, + "ManagedHsm": { + "properties": { + "properties": { + "$ref": "#/definitions/ManagedHsmProperties", + "description": "Properties of the managed HSM" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ManagedHsmResource" + } + ], + "description": "Resource information with extended details." + }, + "ManagedHsmResource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The Azure Resource Manager resource ID for the managed HSM Pool." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the managed HSM Pool." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type of the managed HSM Pool." + }, + "location": { + "type": "string", + "description": "The supported Azure location where the managed HSM Pool should be created.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "sku": { + "$ref": "#/definitions/ManagedHsmSku", + "description": "SKU details" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "systemData": { + "$ref": "common.json#/definitions/SystemData" + } + }, + "description": "Managed HSM resource", + "x-ms-azure-resource": true + }, + "ManagedHsmListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedHsm" + }, + "description": "The list of managed HSM Pools." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of managed HSM Pools." + } + }, + "description": "List of managed HSM Pools" + }, + "MHSMPrivateEndpointConnectionsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MHSMPrivateEndpointConnection" + }, + "description": "The private endpoint connection associated with a managed HSM Pools." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of managed HSM Pools." + } + }, + "description": "List of private endpoint connections associated with a managed HSM Pools" + }, + "ManagedHsmError": { + "properties": { + "error": { + "readOnly": true, + "description": "The server error.", + "$ref": "#/definitions/Error" + } + }, + "description": "The error exception." + }, + "Error": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "The error code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The error message." + }, + "innererror": { + "x-ms-client-name": "innerError", + "readOnly": true, + "description": "The inner error, contains a more specific error code.", + "$ref": "#/definitions/Error" + } + }, + "description": "The server error." + }, + "DeletedManagedHsm": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The Azure Resource Manager resource ID for the deleted managed HSM Pool." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the managed HSM Pool." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type of the managed HSM Pool." + }, + "properties": { + "$ref": "#/definitions/DeletedManagedHsmProperties", + "description": "Properties of the deleted managed HSM" + } + } + }, + "DeletedManagedHsmProperties": { + "properties": { + "mhsmId": { + "readOnly": true, + "type": "string", + "description": "The resource id of the original managed HSM." + }, + "location": { + "readOnly": true, + "type": "string", + "description": "The location of the original managed HSM." + }, + "deletionDate": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The deleted date." + }, + "scheduledPurgeDate": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The scheduled purged date." + }, + "purgeProtectionEnabled": { + "readOnly": true, + "type": "boolean", + "description": "Purge protection status of the original managed HSM." + }, + "tags": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Tags of the original managed HSM." + } + }, + "description": "Properties of the deleted managed HSM." + }, + "DeletedManagedHsmListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DeletedManagedHsm" + }, + "description": "The list of deleted managed HSM Pools." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of deleted managed HSM Pools." + } + }, + "description": "List of deleted managed HSM Pools" + }, + "MHSMNetworkRuleSet": { + "properties": { + "bypass": { + "type": "string", + "description": "Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'.", + "enum": [ + "AzureServices", + "None" + ], + "x-ms-enum": { + "name": "NetworkRuleBypassOptions", + "modelAsString": true + } + }, + "defaultAction": { + "type": "string", + "description": "The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "NetworkRuleAction", + "modelAsString": true + } + }, + "ipRules": { + "type": "array", + "items": { + "$ref": "#/definitions/MHSMIPRule" + }, + "description": "The list of IP address rules." + }, + "virtualNetworkRules": { + "type": "array", + "items": { + "$ref": "#/definitions/MHSMVirtualNetworkRule" + }, + "description": "The list of virtual network rules." + } + }, + "description": "A set of rules governing the network accessibility of a managed hsm pool." + }, + "MHSMIPRule": { + "properties": { + "value": { + "type": "string", + "description": "An IPv4 address range in CIDR notation, such as '124.56.78.91' (simple IP address) or '124.56.78.0/24' (all addresses that start with 124.56.78)." + } + }, + "required": [ + "value" + ], + "description": "A rule governing the accessibility of a managed hsm pool from a specific ip address or ip range." + }, + "MHSMVirtualNetworkRule": { + "properties": { + "id": { + "type": "string", + "description": "Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'." + } + }, + "required": [ + "id" + ], + "description": "A rule governing the accessibility of a managed hsm pool from a specific virtual network." + }, + "MHSMPrivateEndpointConnectionItem": { + "properties": { + "properties": { + "$ref": "#/definitions/MHSMPrivateEndpointConnectionProperties", + "x-ms-client-flatten": true, + "description": "Private endpoint connection properties." + } + }, + "description": "Private endpoint connection item." + }, + "MHSMPrivateEndpointConnection": { + "properties": { + "properties": { + "$ref": "#/definitions/MHSMPrivateEndpointConnectionProperties", + "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": "#/definitions/ManagedHsmResource" + } + ], + "description": "Private endpoint connection resource.", + "x-ms-azure-resource": true + }, + "MHSMPrivateEndpointConnectionProperties": { + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/MHSMPrivateEndpoint", + "description": "Properties of the private endpoint object." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/MHSMPrivateLinkServiceConnectionState", + "description": "Approval state of the private link connection." + }, + "provisioningState": { + "$ref": "#/definitions/MHSMPrivateEndpointConnectionProvisioningState", + "description": "Provisioning state of the private endpoint connection." + } + }, + "description": "Properties of the private endpoint connection resource." + }, + "MHSMPrivateEndpoint": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Full identifier of the private endpoint resource." + } + }, + "description": "Private endpoint object properties." + }, + "MHSMPrivateLinkServiceConnectionState": { + "properties": { + "status": { + "$ref": "#/definitions/MHSMPrivateEndpointServiceConnectionStatus", + "description": "Indicates whether the connection has been approved, rejected or removed by the key vault owner." + }, + "description": { + "type": "string", + "description": "The reason for approval or rejection." + }, + "actionsRequired": { + "type": "string", + "description": "A message indicating if changes on the service provider require any updates on the consumer.", + "enum": [ + "None" + ], + "x-ms-enum": { + "name": "ActionsRequired", + "modelAsString": true + } + } + }, + "description": "An object that represents the approval state of the private link connection." + }, + "MHSMPrivateEndpointServiceConnectionStatus": { + "type": "string", + "description": "The private endpoint connection status.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "x-ms-enum": { + "name": "PrivateEndpointServiceConnectionStatus", + "modelAsString": true + } + }, + "MHSMPrivateEndpointConnectionProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Updating", + "Deleting", + "Failed", + "Disconnected" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "MHSMPrivateLinkResourceListResult": { + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/MHSMPrivateLinkResource" + } + } + }, + "description": "A list of private link resources" + }, + "MHSMPrivateLinkResource": { + "properties": { + "properties": { + "$ref": "#/definitions/MHSMPrivateLinkResourceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ManagedHsmResource" + } + ], + "description": "A private link resource" + }, + "MHSMPrivateLinkResourceProperties": { + "properties": { + "groupId": { + "description": "Group identifier of private link resource.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "Required member names of private link resource.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Required DNS zone names of the the private link resource." + } + }, + "description": "Properties of a private link resource." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ManagedHsmResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the resource group that contains the managed HSM pool.", + "x-ms-parameter-location": "method" + }, + "MHSMPrivateEndpointConnectionName": { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the private endpoint connection associated with the managed hsm pool.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/providers.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/providers.json new file mode 100644 index 000000000000..da8190233d9f --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/providers.json @@ -0,0 +1,272 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01-preview", + "title": "KeyVaultManagementClient", + "description": "The Azure management API provides a RESTful set of web services that interact with Azure Key Vault." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.KeyVault/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available Key Vault Rest API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/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": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Lists available Rest API operations.": { + "$ref": "./examples/listOperations.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Storage 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 Storage operations supported by the Storage resource provider." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of operations." + } + } + }, + "Operation": { + "description": "Key Vault 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 Key Vault.", + "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": "Description of operation.", + "type": "string" + } + } + }, + "origin": { + "type": "string", + "description": "The origin of operations." + }, + "properties": { + "description": "Properties of operation, include metric specifications.", + "x-ms-client-flatten": true, + "x-ms-client-name": "OperationProperties", + "$ref": "#/definitions/OperationProperties" + }, + "isDataAction": { + "type": "boolean", + "description": "Property to specify whether the action is a data action." + } + } + }, + "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 log specifications.", + "properties": { + "logSpecifications": { + "description": "Log specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + } + }, + "metricSpecifications": { + "description": "Metric specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + } + } + } + }, + "LogSpecification": { + "description": "Log specification of operation.", + "properties": { + "name": { + "type": "string", + "description": "Name of log specification." + }, + "displayName": { + "type": "string", + "description": "Display name of log specification." + }, + "blobDuration": { + "type": "string", + "description": "Blob duration of specification." + } + } + }, + "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": "The metric unit. Possible values include: 'Bytes', 'Count', 'Milliseconds'." + }, + "aggregationType": { + "type": "string", + "description": "The metric aggregation type. Possible values include: 'Average', 'Count', 'Total'." + }, + "supportedAggregationTypes": { + "type": "array", + "description": "The supported aggregation types for the metrics.", + "items": { + "type": "string" + } + }, + "supportedTimeGrainTypes": { + "type": "array", + "description": "The supported time grain types for the metrics.", + "items": { + "type": "string" + } + }, + "lockAggregationType": { + "type": "string", + "description": "The metric lock aggregation type." + }, + "dimensions": { + "type": "array", + "description": "The dimensions of metric", + "items": { + "$ref": "#/definitions/DimensionProperties" + } + }, + "fillGapWithZero": { + "type": "boolean", + "description": "Property to specify whether to fill gap with zero." + }, + "internalMetricName": { + "type": "string", + "description": "The internal metric name." + } + } + }, + "DimensionProperties": { + "description": "Type of operation: get, read, delete, etc.", + "properties": { + "name": { + "type": "string", + "description": "Name of dimension." + }, + "displayName": { + "type": "string", + "description": "Display name of dimension." + }, + "toBeExportedForShoebox": { + "type": "boolean", + "description": "Property to specify whether the dimension should be exported for Shoebox." + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + }, + "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" + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/secrets.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/secrets.json new file mode 100644 index 000000000000..b32dd869af2f --- /dev/null +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/secrets.json @@ -0,0 +1,491 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01-preview", + "title": "KeyVaultManagementClient", + "description": "The Azure management API provides a RESTful set of web services that interact with Azure Key Vault." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}": { + "put": { + "tags": [ + "Secrets" + ], + "operationId": "Secrets_CreateOrUpdate", + "description": "Create or update a secret in a key vault in the specified subscription. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Resource Group to which the vault belongs." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$", + "description": "Name of the vault" + }, + { + "name": "secretName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{1,127}$", + "description": "Name of the secret" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SecretCreateOrUpdateParameters" + }, + "description": "Parameters to create or update the secret" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Created or updated vault", + "schema": { + "$ref": "#/definitions/Secret" + } + }, + "200": { + "description": "Created or updated secret", + "schema": { + "$ref": "#/definitions/Secret" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a secret": { + "$ref": "./examples/createSecret.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "patch": { + "tags": [ + "Secrets" + ], + "operationId": "Secrets_Update", + "description": "Update a secret in the specified subscription. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Resource Group to which the vault belongs." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$", + "description": "Name of the vault" + }, + { + "name": "secretName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{1,127}$", + "description": "Name of the secret" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SecretPatchParameters" + }, + "description": "Parameters to patch the secret" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Patched secret", + "schema": { + "$ref": "#/definitions/Secret" + } + }, + "200": { + "description": "Patched secret", + "schema": { + "$ref": "#/definitions/Secret" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update a secret": { + "$ref": "./examples/updateSecret.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "get": { + "tags": [ + "Secrets" + ], + "operationId": "Secrets_Get", + "description": "Gets the specified secret. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Resource Group to which the vault belongs." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vault." + }, + { + "name": "secretName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the secret." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Retrieved secret", + "schema": { + "$ref": "#/definitions/Secret" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a secret": { + "$ref": "./examples/getSecret.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets": { + "get": { + "tags": [ + "Secrets" + ], + "operationId": "Secrets_List", + "description": "The List operation gets information about the secrets in a vault. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Resource Group to which the vault belongs." + }, + { + "name": "vaultName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vault." + }, + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "Maximum number of results to return." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Get information about secrets in the specified vault.", + "schema": { + "$ref": "#/definitions/SecretListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List secrets in the vault": { + "$ref": "./examples/listSecrets.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + } + }, + "definitions": { + "Attributes": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Determines whether the object is enabled." + }, + "nbf": { + "x-ms-client-name": "NotBefore", + "type": "integer", + "format": "unixtime", + "description": "Not before date in seconds since 1970-01-01T00:00:00Z." + }, + "exp": { + "x-ms-client-name": "Expires", + "type": "integer", + "format": "unixtime", + "description": "Expiry date in seconds since 1970-01-01T00:00:00Z." + }, + "created": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "Creation time in seconds since 1970-01-01T00:00:00Z." + }, + "updated": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "Last updated time in seconds since 1970-01-01T00:00:00Z." + } + }, + "description": "The object attributes managed by the KeyVault service.", + "type": "object" + }, + "SecretProperties": { + "properties": { + "value": { + "type": "string", + "description": "The value of the secret. NOTE: 'value' will never be returned from the service, as APIs using this model are is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets." + }, + "contentType": { + "type": "string", + "description": "The content type of the secret." + }, + "attributes": { + "$ref": "#/definitions/SecretAttributes", + "description": "The attributes of the secret." + }, + "secretUri": { + "type": "string", + "description": "The URI to retrieve the current version of the secret.", + "readOnly": true + }, + "secretUriWithVersion": { + "type": "string", + "description": "The URI to retrieve the specific version of the secret.", + "readOnly": true + } + }, + "description": "Properties of the secret", + "type": "object" + }, + "SecretPatchProperties": { + "properties": { + "value": { + "type": "string", + "description": "The value of the secret." + }, + "contentType": { + "type": "string", + "description": "The content type of the secret." + }, + "attributes": { + "$ref": "#/definitions/SecretAttributes", + "description": "The attributes of the secret." + } + }, + "description": "Properties of the secret", + "type": "object" + }, + "SecretAttributes": { + "allOf": [ + { + "$ref": "#/definitions/Attributes" + } + ], + "description": "The secret management attributes.", + "type": "object" + }, + "SecretCreateOrUpdateParameters": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags that will be assigned to the secret. " + }, + "properties": { + "$ref": "#/definitions/SecretProperties", + "description": "Properties of the secret" + } + }, + "description": "Parameters for creating or updating a secret", + "required": [ + "properties" + ], + "x-ms-azure-resource": true, + "type": "object" + }, + "SecretPatchParameters": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags that will be assigned to the secret. " + }, + "properties": { + "$ref": "#/definitions/SecretPatchProperties", + "description": "Properties of the secret" + } + }, + "description": "Parameters for patching a secret", + "x-ms-azure-resource": true, + "type": "object" + }, + "Secret": { + "properties": { + "properties": { + "$ref": "#/definitions/SecretProperties", + "description": "Properties of the secret" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "./keyvault.json#/definitions/Resource" + } + ], + "description": "Resource information with extended details.", + "type": "object" + }, + "SecretListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Secret" + }, + "description": "The list of secrets." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of secrets." + } + }, + "description": "List of secrets", + "type": "object" + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + }, + "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" + } + } + } +} diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/keyvault.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/keyvault.json index 362650353068..24a6776af21c 100644 --- a/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/keyvault.json +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/keyvault.json @@ -1292,7 +1292,7 @@ "enableRbacAuthorization": { "type": "boolean", "default": false, - "description": "Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored (warning: this is a preview feature). When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the vault is created with the default value of false. Note that management actions are always authorized with RBAC." + "description": "Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored. When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the vault is created with the default value of false. Note that management actions are always authorized with RBAC." }, "createMode": { "type": "string", @@ -1381,7 +1381,7 @@ }, "enableRbacAuthorization": { "type": "boolean", - "description": "Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored (warning: this is a preview feature). When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the value of this property will not change." + "description": "Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored. When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the value of this property will not change." }, "softDeleteRetentionInDays": { "type": "integer", diff --git a/specification/keyvault/resource-manager/readme.md b/specification/keyvault/resource-manager/readme.md index a2d08ff4dd57..9554836c3673 100644 --- a/specification/keyvault/resource-manager/readme.md +++ b/specification/keyvault/resource-manager/readme.md @@ -26,22 +26,48 @@ These are the global settings for the KeyVault API. ``` yaml openapi-type: arm -tag: package-preview-2021-04 +tag: package-preview-2021-06 ``` +### Tag: package-preview-2021-06 + +These settings apply only when `--tag=package-preview-2021-06` is specified on the command line. + +```yaml $(tag) == 'package-preview-2021-06' +input-file: + - Microsoft.KeyVault/preview/2021-06-01-preview/common.json + - Microsoft.KeyVault/preview/2021-06-01-preview/keys.json + - Microsoft.KeyVault/preview/2021-06-01-preview/keyvault.json + - Microsoft.KeyVault/preview/2021-06-01-preview/managedHsm.json + - Microsoft.KeyVault/preview/2021-06-01-preview/providers.json + - Microsoft.KeyVault/preview/2021-06-01-preview/secrets.json +``` ### Tag: package-preview-2021-04 These settings apply only when `--tag=package-preview-2021-04` is specified on the command line. -```yaml $(tag) == 'package-preview-2021-04' +``` yaml $(tag) == 'package-preview-2021-04' +input-file: + - Microsoft.KeyVault/preview/2021-04-01-preview/common.json + - Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json + - Microsoft.KeyVault/preview/2021-04-01-preview/managedHsm.json + - Microsoft.KeyVault/preview/2021-04-01-preview/providers.json +``` +### Tag: package-preview-2021-04-full + +These settings apply only when `--tag=package-preview-2021-04` is specified on the command line. + +```yaml $(tag) == 'package-preview-2021-04-full' input-file: - Microsoft.KeyVault/preview/2021-04-01-preview/common.json - Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json - Microsoft.KeyVault/preview/2021-04-01-preview/managedHsm.json - Microsoft.KeyVault/preview/2021-04-01-preview/providers.json + - Microsoft.KeyVault/preview/2021-04-01-preview/keys.json - Microsoft.KeyVault/preview/2021-04-01-preview/secrets.json ``` + ### Tag: package-preview-2020-04 These settings apply only when `--tag=package-preview-2020-04` is specified on the command line. @@ -175,5 +201,3 @@ See configuration in [readme.python.md](./readme.python.md) ## Java See configuration in [readme.java.md](./readme.java.md) - - diff --git a/specification/keyvault/resource-manager/readme.typescript.md b/specification/keyvault/resource-manager/readme.typescript.md index 005215e63a45..9eab59c85c02 100644 --- a/specification/keyvault/resource-manager/readme.typescript.md +++ b/specification/keyvault/resource-manager/readme.typescript.md @@ -12,7 +12,7 @@ typescript: generate-readme-md: true ``` -``` yaml $(typescript) && !$(profile) +``` yaml $(typescript) && !$(profile-content) typescript: package-name: "@azure/arm-keyvault" output-folder: "$(typescript-sdks-folder)/sdk/keyvault/arm-keyvault" @@ -22,9 +22,9 @@ typescript: ### Profile: profile-hybrid-2019-03-01 -These settings apply only when `--profile=profile-hybrid-2019-03-01` is specified on the command line. +These settings apply only when `--profile-content=profile-hybrid-2019-03-01` is specified on the command line. -``` yaml $(profile)=='profile-hybrid-2019-03-01' +``` yaml $(profile-content)=='profile-hybrid-2019-03-01' typescript: package-name: "@azure/arm-keyvault-profile-2019-03-01-hybrid" output-folder: "$(typescript-sdks-folder)/sdk/keyvault/arm-keyvault-profile-2019-03-01-hybrid" @@ -35,9 +35,9 @@ typescript: ### Profile: profile-hybrid-2020-09-01 -These settings apply only when `--profile=profile-hybrid-2020-09-01` is specified on the command line. +These settings apply only when `--profile-content=profile-hybrid-2020-09-01` is specified on the command line. -``` yaml $(profile)=='profile-hybrid-2020-09-01' +``` yaml $(profile-content)=='profile-hybrid-2020-09-01' typescript: package-name: "@azure/arm-keyvault-profile-2020-09-01-hybrid" output-folder: "$(typescript-sdks-folder)/sdk/keyvault/arm-keyvault-profile-2020-09-01-hybrid" @@ -46,4 +46,4 @@ typescript: generate-metadata: true batch: - tag: profile-hybrid-2020-09-01 -``` \ No newline at end of file +``` diff --git a/specification/labservices/resource-manager/readme.md b/specification/labservices/resource-manager/readme.md index 5bd1a1501470..ab3823b5f1b3 100644 --- a/specification/labservices/resource-manager/readme.md +++ b/specification/labservices/resource-manager/readme.md @@ -51,7 +51,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/labservices/resource-manager/readme.python.md b/specification/labservices/resource-manager/readme.python.md index 6b206e0b7f9f..2d72bc2ff597 100644 --- a/specification/labservices/resource-manager/readme.python.md +++ b/specification/labservices/resource-manager/readme.python.md @@ -4,19 +4,7 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.labservices - package-name: azure-mgmt-labservices - package-version: 1.0.0b1 - clear-output-folder: true -``` ``` yaml $(python) && $(track2) -python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.labservices @@ -24,16 +12,7 @@ package-name: azure-mgmt-labservices package-version: 1.0.0b1 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/labservices/azure-mgmt-labservices/azure/mgmt/labservices -``` -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/labservices/azure-mgmt-labservices -``` + ``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/labservices/azure-mgmt-labservices/azure/mgmt/labservices diff --git a/specification/logic/resource-manager/readme.md b/specification/logic/resource-manager/readme.md index 49d696dc92cc..de6d61a19038 100644 --- a/specification/logic/resource-manager/readme.md +++ b/specification/logic/resource-manager/readme.md @@ -126,7 +126,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-trenton - repo: azure-sdk-for-go @@ -155,32 +155,7 @@ csharp: ## Python -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.logic - package-name: azure-mgmt-logic - clear-output-folder: true -``` - -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/logic/azure-mgmt-logic/azure/mgmt/logic -``` - -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/logic/azure-mgmt-logic -``` +See configuration in [readme.python.md](./readme.python.md) ## Go diff --git a/specification/logic/resource-manager/readme.python.md b/specification/logic/resource-manager/readme.python.md index 78519d024972..a413cf47db30 100644 --- a/specification/logic/resource-manager/readme.python.md +++ b/specification/logic/resource-manager/readme.python.md @@ -3,34 +3,15 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. -```yaml $(python) && !$(track2) -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: azure.mgmt.logic - package-name: azure-mgmt-logic - package-version: 2019-05-01 - clear-output-folder: true -``` ```yaml $(python) && $(track2) azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.logic package-name: azure-mgmt-logic -package-version: 2019-05-01 +package-version: 1.0.0b1 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/logic/azure-mgmt-logic/azure/mgmt/logic -``` -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/logic/azure-mgmt-logic -``` ``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/logic/azure-mgmt-logic/azure/mgmt/logic diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/examples/MachineLearningService/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/examples/MachineLearningService/createOrUpdate.json deleted file mode 100644 index 325f3a42f14e..000000000000 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/examples/MachineLearningService/createOrUpdate.json +++ /dev/null @@ -1,225 +0,0 @@ -{ - "parameters": { - "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "resourceGroupName": "testrg123", - "workspaceName": "workspaces123", - "api-version": "2021-03-01-preview", - "serviceName": "service456", - "properties": { - "computeType": "ACI", - "environmentImageRequest": { - "driverProgram": "score.py", - "assets": [ - { - "id": null, - "mimeType": "application/x-python", - "url": "aml://storage/azureml/score.py", - "unpack": false - } - ], - "models": [ - { - "name": "sklearn_regression_model.pkl", - "url": "aml://storage/azureml/sklearn_regression_model.pkl", - "mimeType": "application/x-python" - } - ], - "environment": { - "name": "AzureML-Scikit-learn-0.20.3", - "version": "3", - "python": { - "interpreterPath": "python", - "userManagedDependencies": false, - "condaDependencies": { - "channels": [ - "conda-forge" - ], - "dependencies": [ - "python=3.6.2", - { - "pip": [ - "azureml-core==1.0.69", - "azureml-defaults==1.0.69", - "azureml-telemetry==1.0.69", - "azureml-train-restclients-hyperdrive==1.0.69", - "azureml-train-core==1.0.69", - "scikit-learn==0.20.3", - "scipy==1.2.1", - "numpy==1.16.2", - "joblib==0.13.2" - ] - } - ], - "name": "azureml_ae1acbe6e1e6aabbad900b53c491a17c" - }, - "baseCondaEnvironment": null - }, - "environmentVariables": { - "EXAMPLE_ENV_VAR": "EXAMPLE_VALUE" - }, - "docker": { - "baseImage": "mcr.microsoft.com/azureml/base:openmpi3.1.2-ubuntu16.04", - "baseDockerfile": null, - "baseImageRegistry": { - "address": null, - "username": null, - "password": null - } - }, - "spark": { - "repositories": [], - "packages": [], - "precachePackages": true - }, - "inferencingStackVersion": null - } - }, - "containerResourceRequirements": { - "cpu": 1, - "memoryInGB": 1 - }, - "location": "eastus2", - "authEnabled": true, - "appInsightsEnabled": true - } - }, - "responses": { - "200": { - "body": { - "id": "subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/services/service456", - "type": "Microsoft.MachineLearningServices/workspaces/services", - "name": "service456", - "systemData": { - "createdBy": "string", - "createdByType": "Application", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "Application", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "properties": { - "computeType": "ACI", - "containerResourceRequirements": { - "cpu": 0.1, - "memoryInGB": 0.5, - "gpu": null, - "fpga": null - }, - "scoringUri": "http://ddde8e29-3e3a-42d2-980d-8fb7e005ab81.eastus2.azurecontainer.io/score", - "location": "eastus2", - "authEnabled": true, - "sslEnabled": false, - "appInsightsEnabled": true, - "dataCollection": { - "eventHubEnabled": false, - "storageEnabled": false - }, - "sslCertificate": "", - "sslKey": "", - "cname": null, - "publicIp": "52.177.232.98", - "publicFqdn": "ddde8e29-3e3a-42d2-980d-8fb7e005ab81.eastus2.azurecontainer.io", - "modelConfigMap": { - "accountContext": { - "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "resourceGroupName": "testrg123", - "accountName": "workspaces123", - "workspaceId": "57b243e8-3d24-4427-90e0-8dc47f41c387" - }, - "models": { - "sklearn_regression_model1.pkl": { - "version": 2, - "id": "sklearn_regression_model1.pkl:2", - "internalId": "3ab27a5b0d0e48d99f18a5195cc258bc" - } - }, - "modelsInfo": { - "sklearn_regression_model1.pkl": { - "2": { - "version": 2, - "id": "sklearn_regression_model1.pkl:2", - "internalId": "3ab27a5b0d0e48d99f18a5195cc258bc", - "dataCollectorStoragePath": "/modeldata/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/testrg123/workspaces123/service123/sklearn_regression_model1.pkl/2/" - } - } - } - }, - "environmentImageRequest": { - "driverProgram": "score.py", - "assets": [ - { - "id": null, - "mimeType": "application/x-python", - "url": "aml://artifact/LocalUpload/200518T200218a1a8c0af/score.py", - "unpack": false - } - ], - "modelIds": [ - "sklearn_regression_model1.pkl:2" - ], - "environment": { - "name": "AzureML-Scikit-learn-0.20.3", - "version": "3", - "python": { - "interpreterPath": "python", - "userManagedDependencies": false, - "condaDependencies": { - "channels": [ - "conda-forge" - ], - "dependencies": [ - "python=3.6.2", - { - "pip": [ - "azureml-core==1.0.69", - "azureml-defaults==1.0.69", - "azureml-telemetry==1.0.69", - "azureml-train-restclients-hyperdrive==1.0.69", - "azureml-train-core==1.0.69", - "scikit-learn==0.20.3", - "scipy==1.2.1", - "numpy==1.16.2", - "joblib==0.13.2" - ] - } - ], - "name": "azureml_ae1acbe6e1e6aabbad900b53c491a17c" - }, - "baseCondaEnvironment": null - }, - "environmentVariables": { - "EXAMPLE_ENV_VAR": "EXAMPLE_VALUE" - }, - "docker": { - "baseImage": "mcr.microsoft.com/azureml/base:openmpi3.1.2-ubuntu16.04", - "baseDockerfile": null, - "baseImageRegistry": { - "address": null - } - }, - "spark": { - "repositories": [], - "packages": [], - "precachePackages": true - }, - "inferencingStackVersion": null - } - }, - "description": null, - "kvTags": {}, - "properties": { - "hasInferenceSchema": "False", - "hasHttps": "False" - }, - "state": "Transitioning" - } - } - }, - "201": { - "description": "The request was accepted.", - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." - } - } - } -} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/examples/MachineLearningService/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/examples/MachineLearningService/delete.json deleted file mode 100644 index bea1a68fa41a..000000000000 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/examples/MachineLearningService/delete.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "parameters": { - "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "resourceGroupName": "testrg123", - "workspaceName": "workspaces123", - "serviceName": "service123", - "api-version": "2021-03-01-preview" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/examples/MachineLearningService/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/examples/MachineLearningService/get.json deleted file mode 100644 index 97943860d3eb..000000000000 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/examples/MachineLearningService/get.json +++ /dev/null @@ -1,157 +0,0 @@ -{ - "parameters": { - "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "resourceGroupName": "testrg123", - "workspaceName": "workspaces123", - "api-version": "2021-03-01-preview", - "serviceName": "service123" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/services/service123", - "type": "Microsoft.MachineLearningServices/workspaces/services", - "name": "service123", - "systemData": { - "createdBy": "string", - "createdByType": "Application", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "Application", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "properties": { - "computeType": "AKS", - "containerResourceRequirements": { - "cpu": 0.1, - "memoryInGB": 0.5, - "gpu": null, - "fpga": null - }, - "maxConcurrentRequestsPerContainer": 1, - "maxQueueWaitMs": 500, - "computeName": "my-aks-compute", - "namespace": "azureml-workspaces123", - "numReplicas": 1, - "dataCollection": { - "eventHubEnabled": false, - "storageEnabled": false - }, - "appInsightsEnabled": true, - "autoScaler": { - "autoscaleEnabled": false, - "minReplicas": null, - "maxReplicas": null, - "targetUtilization": null, - "refreshPeriodInSeconds": null - }, - "scoringUri": "http://192.168.1.5:80/api/v1/service/service123/score", - "scoringTimeoutMs": null, - "livenessProbeRequirements": { - "failureThreshold": 3, - "successThreshold": 1, - "timeoutSeconds": 120, - "periodSeconds": 5, - "initialDelaySeconds": 310 - }, - "authEnabled": true, - "aadAuthEnabled": false, - "swaggerUri": "http://192.168.1.5/api/v1/service/service123/swagger.json", - "modelConfigMap": { - "accountContext": { - "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "resourceGroupName": "testrg123", - "accountName": "workspaces123", - "workspaceId": "57b243e8-3d24-4427-90e0-8dc47f41c387" - }, - "models": { - "sklearn_regression_model1.pkl": { - "version": 2, - "id": "sklearn_regression_model1.pkl:2", - "internalId": "3ab27a5b0d0e48d99f18a5195cc258bc" - } - }, - "modelsInfo": { - "sklearn_regression_model1.pkl": { - "2": { - "version": 2, - "id": "sklearn_regression_model1.pkl:2", - "internalId": "3ab27a5b0d0e48d99f18a5195cc258bc", - "dataCollectorStoragePath": "/modeldata/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/testrg123/workspaces123/service123/sklearn_regression_model1.pkl/2/" - } - } - } - }, - "environmentImageRequest": { - "driverProgram": "score.py", - "assets": [ - { - "id": null, - "mimeType": "application/x-python", - "url": "aml://artifact/LocalUpload/200518T200218a1a8c0af/score.py", - "unpack": false - } - ], - "modelIds": [ - "sklearn_regression_model1.pkl:2" - ], - "environment": { - "name": "AzureML-Scikit-learn-0.20.3", - "version": "3", - "python": { - "interpreterPath": "python", - "userManagedDependencies": false, - "condaDependencies": { - "channels": [ - "conda-forge" - ], - "dependencies": [ - "python=3.6.2", - { - "pip": [ - "azureml-core==1.0.69", - "azureml-defaults==1.0.69", - "azureml-telemetry==1.0.69", - "azureml-train-restclients-hyperdrive==1.0.69", - "azureml-train-core==1.0.69", - "scikit-learn==0.20.3", - "scipy==1.2.1", - "numpy==1.16.2", - "joblib==0.13.2" - ] - } - ], - "name": "azureml_ae1acbe6e1e6aabbad900b53c491a17c" - }, - "baseCondaEnvironment": null - }, - "environmentVariables": { - "EXAMPLE_ENV_VAR": "EXAMPLE_VALUE" - }, - "docker": { - "baseImage": "mcr.microsoft.com/azureml/base:openmpi3.1.2-ubuntu16.04", - "baseDockerfile": null, - "baseImageRegistry": { - "address": null - } - }, - "spark": { - "repositories": [], - "packages": [], - "precachePackages": true - }, - "inferencingStackVersion": null - } - }, - "description": null, - "kvTags": {}, - "properties": { - "hasInferenceSchema": "False", - "hasHttps": "False" - }, - "state": "Healthy" - } - } - } - } -} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/examples/MachineLearningService/listByWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/examples/MachineLearningService/listByWorkspace.json deleted file mode 100644 index 57a28523a5a7..000000000000 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/examples/MachineLearningService/listByWorkspace.json +++ /dev/null @@ -1,282 +0,0 @@ -{ - "parameters": { - "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "resourceGroupName": "testrg123", - "workspaceName": "workspaces123", - "api-version": "2021-03-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/services/service123", - "type": "Microsoft.MachineLearningServices/workspaces/services", - "name": "service123", - "systemData": { - "createdBy": "string", - "createdByType": "Application", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "Application", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "properties": { - "computeType": "AKS", - "containerResourceRequirements": { - "cpu": 0.1, - "memoryInGB": 0.5, - "gpu": null, - "fpga": null - }, - "maxConcurrentRequestsPerContainer": 1, - "maxQueueWaitMs": 500, - "computeName": "my-aks-compute", - "namespace": "azureml-workspaces123", - "numReplicas": 1, - "dataCollection": { - "eventHubEnabled": false, - "storageEnabled": false - }, - "appInsightsEnabled": true, - "autoScaler": { - "autoscaleEnabled": false, - "minReplicas": null, - "maxReplicas": null, - "targetUtilization": null, - "refreshPeriodInSeconds": null - }, - "scoringUri": "http://192.168.1.5:80/api/v1/service/service123/score", - "scoringTimeoutMs": null, - "livenessProbeRequirements": { - "failureThreshold": 3, - "successThreshold": 1, - "timeoutSeconds": 120, - "periodSeconds": 5, - "initialDelaySeconds": 310 - }, - "authEnabled": true, - "aadAuthEnabled": false, - "swaggerUri": "http://192.168.1.5/api/v1/service/service123/swagger.json", - "modelConfigMap": { - "accountContext": { - "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "resourceGroupName": "testrg123", - "accountName": "workspaces123", - "workspaceId": "57b243e8-3d24-4427-90e0-8dc47f41c387" - }, - "models": { - "sklearn_regression_model1.pkl": { - "version": 2, - "id": "sklearn_regression_model1.pkl:2", - "internalId": "3ab27a5b0d0e48d99f18a5195cc258bc" - } - }, - "modelsInfo": { - "sklearn_regression_model1.pkl": { - "2": { - "version": 2, - "id": "sklearn_regression_model1.pkl:2", - "internalId": "3ab27a5b0d0e48d99f18a5195cc258bc", - "dataCollectorStoragePath": "/modeldata/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/testrg123/workspaces123/service123/sklearn_regression_model1.pkl/2/" - } - } - } - }, - "environmentImageRequest": { - "driverProgram": "score.py", - "assets": [ - { - "id": null, - "mimeType": "application/x-python", - "url": "aml://artifact/LocalUpload/200518T200218a1a8c0af/score.py", - "unpack": false - } - ], - "modelIds": [ - "sklearn_regression_model1.pkl:2" - ], - "environment": { - "name": "AzureML-Scikit-learn-0.20.3", - "version": "3", - "python": { - "interpreterPath": "python", - "userManagedDependencies": false, - "condaDependencies": { - "channels": [ - "conda-forge" - ], - "dependencies": [ - "python=3.6.2", - { - "pip": [ - "azureml-core==1.0.69", - "azureml-defaults==1.0.69", - "azureml-telemetry==1.0.69", - "azureml-train-restclients-hyperdrive==1.0.69", - "azureml-train-core==1.0.69", - "scikit-learn==0.20.3", - "scipy==1.2.1", - "numpy==1.16.2", - "joblib==0.13.2" - ] - } - ], - "name": "azureml_ae1acbe6e1e6aabbad900b53c491a17c" - }, - "baseCondaEnvironment": null - }, - "environmentVariables": { - "EXAMPLE_ENV_VAR": "EXAMPLE_VALUE" - }, - "docker": { - "baseImage": "mcr.microsoft.com/azureml/base:openmpi3.1.2-ubuntu16.04", - "baseDockerfile": null, - "baseImageRegistry": { - "address": null - } - }, - "spark": { - "repositories": [], - "packages": [], - "precachePackages": true - }, - "inferencingStackVersion": null - } - }, - "description": null, - "kvTags": {}, - "properties": { - "hasInferenceSchema": "False", - "hasHttps": "False" - }, - "state": "Healthy" - } - }, - { - "id": "subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/services/service456", - "type": "Microsoft.MachineLearningServices/workspaces/services", - "name": "service456", - "properties": { - "computeType": "ACI", - "containerResourceRequirements": { - "cpu": 0.1, - "memoryInGB": 0.5, - "gpu": null, - "fpga": null - }, - "scoringUri": "http://ddde8e29-3e3a-42d2-980d-8fb7e005ab81.eastus2.azurecontainer.io/score", - "location": "eastus2", - "authEnabled": true, - "sslEnabled": false, - "appInsightsEnabled": true, - "dataCollection": { - "eventHubEnabled": false, - "storageEnabled": false - }, - "sslCertificate": "", - "sslKey": "", - "cname": null, - "publicIp": "52.177.232.98", - "publicFqdn": "ddde8e29-3e3a-42d2-980d-8fb7e005ab81.eastus2.azurecontainer.io", - "modelConfigMap": { - "accountContext": { - "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "resourceGroupName": "testrg123", - "accountName": "workspaces123", - "workspaceId": "57b243e8-3d24-4427-90e0-8dc47f41c387" - }, - "models": { - "sklearn_regression_model1.pkl": { - "version": 2, - "id": "sklearn_regression_model1.pkl:2", - "internalId": "3ab27a5b0d0e48d99f18a5195cc258bc" - } - }, - "modelsInfo": { - "sklearn_regression_model1.pkl": { - "2": { - "version": 2, - "id": "sklearn_regression_model1.pkl:2", - "internalId": "3ab27a5b0d0e48d99f18a5195cc258bc", - "dataCollectorStoragePath": "/modeldata/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/testrg123/workspaces123/service123/sklearn_regression_model1.pkl/2/" - } - } - } - }, - "environmentImageRequest": { - "driverProgram": "score.py", - "assets": [ - { - "id": null, - "mimeType": "application/x-python", - "url": "aml://artifact/LocalUpload/200518T200218a1a8c0af/score.py", - "unpack": false - } - ], - "modelIds": [ - "sklearn_regression_model1.pkl:2" - ], - "environment": { - "name": "AzureML-Scikit-learn-0.20.3", - "version": "3", - "python": { - "interpreterPath": "python", - "userManagedDependencies": false, - "condaDependencies": { - "channels": [ - "conda-forge" - ], - "dependencies": [ - "python=3.6.2", - { - "pip": [ - "azureml-core==1.0.69", - "azureml-defaults==1.0.69", - "azureml-telemetry==1.0.69", - "azureml-train-restclients-hyperdrive==1.0.69", - "azureml-train-core==1.0.69", - "scikit-learn==0.20.3", - "scipy==1.2.1", - "numpy==1.16.2", - "joblib==0.13.2" - ] - } - ], - "name": "azureml_ae1acbe6e1e6aabbad900b53c491a17c" - }, - "baseCondaEnvironment": null - }, - "environmentVariables": { - "EXAMPLE_ENV_VAR": "EXAMPLE_VALUE" - }, - "docker": { - "baseImage": "mcr.microsoft.com/azureml/base:openmpi3.1.2-ubuntu16.04", - "baseDockerfile": null, - "baseImageRegistry": { - "address": null - } - }, - "spark": { - "repositories": [], - "packages": [], - "precachePackages": true - }, - "inferencingStackVersion": null - } - }, - "description": null, - "kvTags": {}, - "properties": { - "hasInferenceSchema": "False", - "hasHttps": "False" - }, - "state": "Healthy" - } - } - ], - "nextLink": "nextLink" - } - } - } -} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/examples/VirtualMachineSize/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/examples/VirtualMachineSize/list.json index c592abfa96ae..cfc64546bfe0 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/examples/VirtualMachineSize/list.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/examples/VirtualMachineSize/list.json @@ -7,7 +7,7 @@ "responses": { "200": { "body": { - "amlCompute": [ + "value": [ { "name": "Standard_D1_v2", "family": "standardDv2Family", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/examples/WorkspaceConnection/create.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/examples/WorkspaceConnection/create.json index 93a1b75e8794..b9ac8aba6f9c 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/examples/WorkspaceConnection/create.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/examples/WorkspaceConnection/create.json @@ -6,7 +6,6 @@ "connectionName": "connection-1", "api-version": "2021-03-01-preview", "parameters": { - "name": "connection-1", "properties": { "category": "ACR", "target": "www.facebook.com", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/machineLearningServices.json index 0761b7b2c7cf..43d70cc024d5 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/machineLearningServices.json @@ -1448,7 +1448,7 @@ "tags": [ "ProxyOperations" ], - "operationId": "Notebooks_Prepare", + "operationId": "Workspaces_PrepareNotebook", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" @@ -1537,7 +1537,7 @@ "tags": [ "ProxyOperations" ], - "operationId": "Notebooks_ListKeys", + "operationId": "Workspaces_ListNotebookKeys", "x-ms-examples": { "List Workspace Keys": { "$ref": "./examples/Notebook/listKeys.json" @@ -1658,7 +1658,7 @@ "description": "The object for creating or updating a new workspace connection", "required": true, "schema": { - "$ref": "#/definitions/WorkspaceConnectionDto" + "$ref": "#/definitions/WorkspaceConnection" } } ], @@ -1982,7 +1982,8 @@ }, "containerRegistry": { "description": "ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created", - "type": "string" + "type": "string", + "x-nullable": true }, "storageAccount": { "description": "ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created", @@ -2363,7 +2364,7 @@ }, "VirtualMachineSizeListResult": { "properties": { - "amlCompute": { + "value": { "type": "array", "items": { "$ref": "#/definitions/VirtualMachineSize" @@ -4378,7 +4379,8 @@ }, "notebookPreparationError": { "$ref": "#/definitions/NotebookPreparationError", - "description": "The error that occurs when preparing notebook." + "description": "The error that occurs when preparing notebook.", + "x-nullable": true } } }, @@ -4464,22 +4466,6 @@ } } }, - "WorkspaceConnectionDto": { - "type": "object", - "description": "object used for creating workspace connection.", - "properties": { - "name": { - "description": "Friendly name of the workspace connection", - "type": "string" - }, - "properties": { - "type": "object", - "description": "Properties of workspace connection.", - "$ref": "#/definitions/WorkspaceConnectionProps", - "x-ms-client-flatten": true - } - } - }, "WorkspaceConnectionProps": { "type": "object", "description": "Workspace Connection specific properties.", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json index 1b4f163670f0..3555e5553b49 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json @@ -4943,6 +4943,7 @@ }, "targetUtilizationPercentage": { "format": "int32", + "description": "Target CPU usage for the autoscaler.", "type": "integer" } }, @@ -5292,7 +5293,7 @@ "additionalProperties": false }, "BanditPolicy": { - "description": "Defines an early termination policy based on slack criteria, and a frequency and delay interval for evaluation", + "description": "Defines an early termination policy based on slack criteria, and a frequency and delay interval for evaluation.", "type": "object", "allOf": [ { @@ -5302,10 +5303,12 @@ "properties": { "slackAmount": { "format": "float", + "description": "Absolute distance allowed from the best performing run.", "type": "number" }, "slackFactor": { "format": "float", + "description": "Ratio of the allowed distance from the best performing run.", "type": "number" } }, @@ -5399,6 +5402,7 @@ "$ref": "#/definitions/ResourceIdentity" }, "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", "type": "string" }, "properties": { @@ -5421,6 +5425,7 @@ "type": "object", "properties": { "nextLink": { + "description": "The link to the next page of BatchDeployment objects. If null, there are no additional pages.", "type": "string" }, "value": { @@ -5506,6 +5511,7 @@ "$ref": "#/definitions/ResourceIdentity" }, "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", "type": "string" }, "properties": { @@ -5528,6 +5534,7 @@ "type": "object", "properties": { "nextLink": { + "description": "The link to the next page of BatchEndpoint objects. If null, there are no additional pages.", "type": "string" }, "value": { @@ -5779,6 +5786,7 @@ "type": "object", "properties": { "nextLink": { + "description": "The link to the next page of CodeContainer objects. If null, there are no additional pages.", "type": "string" }, "value": { @@ -5868,6 +5876,7 @@ "type": "object", "properties": { "nextLink": { + "description": "The link to the next page of CodeVersion objects. If null, there are no additional pages.", "type": "string" }, "value": { @@ -6229,6 +6238,7 @@ "type": "object", "properties": { "nextLink": { + "description": "The link to the next page of DataContainer objects. If null, there are no additional pages.", "type": "string" }, "value": { @@ -6343,6 +6353,7 @@ "type": "object", "properties": { "nextLink": { + "description": "The link to the next page of DataVersion objects. If null, there are no additional pages.", "type": "string" }, "value": { @@ -6495,6 +6506,7 @@ "type": "object", "properties": { "nextLink": { + "description": "The link to the next page of DatastoreProperties objects. If null, there are no additional pages.", "type": "string" }, "value": { @@ -6525,6 +6537,7 @@ "type": "object", "properties": { "content": { + "description": "The retrieved online deployment logs.", "type": "string" } }, @@ -6702,7 +6715,7 @@ "additionalProperties": false }, "EarlyTerminationPolicy": { - "description": "Early termination policies enable canceling poor-performing runs before they complete", + "description": "Early termination policies enable canceling poor-performing runs before they complete.", "required": [ "policyType" ], @@ -6710,10 +6723,12 @@ "properties": { "delayEvaluation": { "format": "int32", + "description": "Number of intervals by which to delay the first evaluation.", "type": "integer" }, "evaluationInterval": { "format": "int32", + "description": "Interval (number of runs) between policy evaluations.", "type": "integer" }, "policyType": { @@ -6886,6 +6901,7 @@ "type": "object", "properties": { "nextLink": { + "description": "The link to the next page of EnvironmentContainer objects. If null, there are no additional pages.", "type": "string" }, "value": { @@ -6996,6 +7012,7 @@ "type": "object", "properties": { "nextLink": { + "description": "The link to the next page of EnvironmentSpecificationVersion objects. If null, there are no additional pages.", "type": "string" }, "value": { @@ -7078,6 +7095,7 @@ "type": "object", "properties": { "data": { + "description": "Model flavor-specific data.", "type": "object", "additionalProperties": { "type": "string" @@ -7286,6 +7304,7 @@ } }, "provisioningState": { + "description": "Specifies the job provisioning state.", "$ref": "#/definitions/JobProvisioningState", "readOnly": true, "x-ms-mutability": [ @@ -7334,6 +7353,7 @@ "type": "object", "properties": { "nextLink": { + "description": "The link to the next page of JobBase objects. If null, there are no additional pages.", "type": "string" }, "value": { @@ -7376,6 +7396,7 @@ ] }, "properties": { + "description": "Additional properties to set on the endpoint.", "type": "object", "additionalProperties": { "type": "string" @@ -7469,6 +7490,7 @@ ], "properties": { "containerResourceRequirements": { + "description": "Resource requirements for each container instance within an online deployment.", "$ref": "machineLearningServices.json#/definitions/ContainerResourceRequirements" } }, @@ -7687,6 +7709,7 @@ } }, "provisioningState": { + "description": "Specifies the labeling job provisioning state.", "$ref": "#/definitions/JobProvisioningState", "readOnly": true, "x-ms-mutability": [ @@ -7809,6 +7832,7 @@ "type": "object", "properties": { "nextLink": { + "description": "The link to the next page of LabelingJob objects. If null, there are no additional pages.", "type": "string" }, "value": { @@ -7938,6 +7962,7 @@ ], "properties": { "instanceType": { + "description": "Compute instance type.", "type": "string", "x-ms-mutability": [ "create", @@ -7945,6 +7970,7 @@ ] }, "readinessProbe": { + "description": "Deployment container liveness/readiness probe configuration.", "$ref": "#/definitions/ProbeSettings" } }, @@ -7961,6 +7987,7 @@ "properties": { "instanceCount": { "format": "int32", + "description": "Fixed number of instances for this deployment.", "type": "integer" } }, @@ -7981,7 +8008,7 @@ "additionalProperties": false }, "MedianStoppingPolicy": { - "description": "Defines an early termination policy based on running averages of the primary metric of all runs", + "description": "Defines an early termination policy based on running averages of the primary metric of all runs.", "type": "object", "allOf": [ { @@ -8047,6 +8074,7 @@ "type": "object", "properties": { "nextLink": { + "description": "The link to the next page of ModelContainer objects. If null, there are no additional pages.", "type": "string" }, "value": { @@ -8143,6 +8171,7 @@ "type": "object", "properties": { "nextLink": { + "description": "The link to the next page of ModelVersion objects. If null, there are no additional pages.", "type": "string" }, "value": { @@ -8166,6 +8195,7 @@ "properties": { "processCountPerInstance": { "format": "int32", + "description": "Number of processes per MPI node.", "type": "integer", "x-ms-mutability": [ "create", @@ -8210,6 +8240,7 @@ "additionalProperties": false }, "Objective": { + "description": "Optimization objective.", "required": [ "goal", "primaryMetric" @@ -8221,6 +8252,7 @@ "$ref": "#/definitions/Goal" }, "primaryMetric": { + "description": "Name of the metric to optimize.", "pattern": "[a-zA-Z0-9_]", "type": "string" } @@ -8261,6 +8293,7 @@ } }, "livenessProbe": { + "description": "Deployment container liveness/readiness probe configuration.", "$ref": "#/definitions/ProbeSettings" }, "model": { @@ -8283,9 +8316,11 @@ ] }, "requestSettings": { + "description": "Online deployment scoring requests configuration.", "$ref": "#/definitions/OnlineRequestSettings" }, "scaleSettings": { + "description": "Online deployment scaling configuration.", "$ref": "#/definitions/OnlineScaleSettings" } }, @@ -8308,6 +8343,7 @@ "$ref": "#/definitions/ResourceIdentity" }, "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", "type": "string" }, "properties": { @@ -8330,6 +8366,7 @@ "type": "object", "properties": { "nextLink": { + "description": "The link to the next page of OnlineDeployment objects. If null, there are no additional pages.", "type": "string" }, "value": { @@ -8430,6 +8467,7 @@ "$ref": "#/definitions/ResourceIdentity" }, "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", "type": "string" }, "properties": { @@ -8452,6 +8490,7 @@ "type": "object", "properties": { "nextLink": { + "description": "The link to the next page of OnlineEndpoint objects. If null, there are no additional pages.", "type": "string" }, "value": { @@ -8465,10 +8504,12 @@ "additionalProperties": false }, "OnlineRequestSettings": { + "description": "Online deployment scoring requests configuration.", "type": "object", "properties": { "maxConcurrentRequestsPerInstance": { "format": "int32", + "description": "The number of requests allowed to queue at once for this deployment.", "type": "integer" }, "maxQueueWait": { @@ -8485,6 +8526,7 @@ "additionalProperties": false }, "OnlineScaleSettings": { + "description": "Online deployment scaling configuration.", "required": [ "scaleType" ], @@ -8492,13 +8534,16 @@ "properties": { "maxInstances": { "format": "int32", + "description": "Maximum number of instances for this deployment.", "type": "integer" }, "minInstances": { "format": "int32", + "description": "Minimum number of instances for this deployment.", "type": "integer" }, "scaleType": { + "description": "Type of deployment scaling algorithm", "$ref": "#/definitions/ScaleType" } }, @@ -8611,6 +8656,7 @@ ], "properties": { "containerResourceRequirements": { + "description": "Resource requirements for each container instance within an online deployment.", "$ref": "machineLearningServices.json#/definitions/ContainerResourceRequirements" } }, @@ -8637,9 +8683,11 @@ "$ref": "#/definitions/ResourceIdentity" }, "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", "type": "string" }, "location": { + "description": "The geo-location where the resource lives.", "type": "string" }, "properties": { @@ -8647,6 +8695,7 @@ "$ref": "#/definitions/PartialBatchDeployment" }, "tags": { + "description": "Resource tags.", "type": "object", "additionalProperties": { "type": "string" @@ -8679,9 +8728,11 @@ "$ref": "#/definitions/ResourceIdentity" }, "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", "type": "string" }, "location": { + "description": "The geo-location where the resource lives.", "type": "string" }, "properties": { @@ -8689,6 +8740,7 @@ "$ref": "#/definitions/PartialBatchEndpoint" }, "tags": { + "description": "Resource tags.", "type": "object", "additionalProperties": { "type": "string" @@ -8706,6 +8758,7 @@ ], "properties": { "readinessProbe": { + "description": "Deployment container liveness/readiness probe configuration.", "$ref": "#/definitions/ProbeSettings" } }, @@ -8720,19 +8773,23 @@ "type": "object", "properties": { "appInsightsEnabled": { + "description": "Whether AppInsights telemetry is enabled for this online deployment.", "type": "boolean" }, "endpointComputeType": { - "description": "Enum to determine endpoint compute type.", + "description": "The compute type of the endpoint.", "$ref": "#/definitions/EndpointComputeType" }, "livenessProbe": { + "description": "Deployment container liveness/readiness probe configuration.", "$ref": "#/definitions/ProbeSettings" }, "requestSettings": { + "description": "Online deployment scoring requests configuration.", "$ref": "#/definitions/OnlineRequestSettings" }, "scaleSettings": { + "description": "Online deployment scaling configuration.", "$ref": "#/definitions/OnlineScaleSettings" } }, @@ -8747,9 +8804,11 @@ "$ref": "#/definitions/ResourceIdentity" }, "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", "type": "string" }, "location": { + "description": "The geo-location where the resource lives.", "type": "string" }, "properties": { @@ -8757,6 +8816,7 @@ "$ref": "#/definitions/PartialOnlineDeployment" }, "tags": { + "description": "Resource tags.", "type": "object", "additionalProperties": { "type": "string" @@ -8789,9 +8849,11 @@ "$ref": "#/definitions/ResourceIdentity" }, "kind": { + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.", "type": "string" }, "location": { + "description": "The geo-location where the resource lives.", "type": "string" }, "properties": { @@ -8799,6 +8861,7 @@ "$ref": "#/definitions/PartialOnlineEndpoint" }, "tags": { + "description": "Resource tags.", "type": "object", "additionalProperties": { "type": "string" @@ -8808,6 +8871,7 @@ "additionalProperties": false }, "ProbeSettings": { + "description": "Deployment container liveness/readiness probe configuration.", "type": "object", "properties": { "failureThreshold": { @@ -9269,7 +9333,7 @@ ] }, "earlyTermination": { - "description": "Early termination policies enable canceling poor-performing runs before they complete", + "description": "Early termination policies enable canceling poor-performing runs before they complete.", "$ref": "#/definitions/EarlyTerminationPolicy" }, "experimentName": { @@ -9290,13 +9354,16 @@ }, "maxConcurrentTrials": { "format": "int32", + "description": "An upper bound on the number of trials performed in parallel.", "type": "integer" }, "maxTotalTrials": { "format": "int32", + "description": "An upper bound on the number of trials to perform.", "type": "integer" }, "objective": { + "description": "Optimization objective.", "$ref": "#/definitions/Objective" }, "output": { @@ -9355,6 +9422,7 @@ "properties": { "parameterServerCount": { "format": "int32", + "description": "Number of parameter server tasks.", "type": "integer", "x-ms-mutability": [ "create", @@ -9479,6 +9547,7 @@ "properties": { "truncationPercentage": { "format": "int32", + "description": "The percentage of runs to cancel at each evaluation interval.", "type": "integer" } }, diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/services.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/services.json deleted file mode 100644 index 08ff3461ab86..000000000000 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2021-03-01-preview/services.json +++ /dev/null @@ -1,1832 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Machine Learning Workspaces", - "version": "2021-03-01-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/services": { - "get": { - "tags": [ - "MachineLearningServices" - ], - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "operationId": "MachineLearningServices_ListByWorkspace", - "description": "Gets services in specified workspace.", - "x-ms-examples": { - "Get Services": { - "$ref": "./examples/MachineLearningService/listByWorkspace.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "machineLearningServices.json#/parameters/PaginationParameter" - }, - { - "$ref": "#/parameters/ModelIdParameter" - }, - { - "$ref": "#/parameters/ModelNameParameter" - }, - { - "$ref": "#/parameters/WebServiceTagParameter" - }, - { - "$ref": "#/parameters/WebServiceTagsParameter" - }, - { - "$ref": "#/parameters/WebServicePropertiesParameter" - }, - { - "$ref": "#/parameters/WebServiceRunIdParameter" - }, - { - "$ref": "#/parameters/WebServiceExpandParameter" - }, - { - "$ref": "#/parameters/WebServiceOrderByParameter" - } - ], - "responses": { - "200": { - "description": "The response includes a paginated array of Machine Learning services and a URI to the next set of results, if any. For the more information the limits of the number of items in a resource group, see https://azure.microsoft.com/en-us/documentation/articles/azure-subscription-service-limits/.", - "schema": { - "$ref": "#/definitions/PaginatedServiceList" - } - }, - "default": { - "description": "Error response describing why the request failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/services/{serviceName}": { - "get": { - "tags": [ - "MachineLearningServices" - ], - "operationId": "MachineLearningServices_Get", - "description": "Get a Service by name.", - "x-ms-examples": { - "Get Service": { - "$ref": "./examples/MachineLearningService/get.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/WebServiceNameParameter" - }, - { - "in": "query", - "name": "expand", - "description": "Set to True to include Model details.", - "type": "boolean", - "default": false - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ServiceResource" - } - }, - "default": { - "description": "Error response describing why the request failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "MachineLearningServices" - ], - "operationId": "MachineLearningServices_Delete", - "description": "Delete a specific Service..", - "x-ms-examples": { - "Delete Service": { - "$ref": "./examples/MachineLearningService/delete.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/WebServiceNameParameter" - } - ], - "responses": { - "200": { - "description": "The resource exists and was deleted successfully." - }, - "204": { - "description": "The resource does not exist and the request was well formed." - }, - "default": { - "description": "Error response describing why the request failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "MachineLearningServices" - ], - "description": "Creates or updates service. This call will update a service if it exists. This is a nonrecoverable operation. If your intent is to create a new service, do a GET first to verify that it does not exist yet.", - "operationId": "MachineLearningServices_CreateOrUpdate", - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Create Or Update service": { - "$ref": "./examples/MachineLearningService/createOrUpdate.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/WebServiceNameParameter" - }, - { - "in": "body", - "name": "properties", - "description": "The payload that is used to create or update the Service.", - "required": true, - "schema": { - "$ref": "#/definitions/CreateServiceRequest" - } - } - ], - "responses": { - "200": { - "description": "Service creation or update initiated.", - "schema": { - "$ref": "#/definitions/ServiceResource" - } - }, - "201": { - "description": "Service creation or update initiated.", - "headers": { - "Azure-AsyncOperation": { - "description": "URI to poll for asynchronous operation status.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - } - } - } - } - }, - "parameters": { - "ModelIdParameter": { - "in": "query", - "name": "modelId", - "type": "string", - "description": "The Model Id.", - "required": false, - "x-ms-parameter-location": "method" - }, - "ModelNameParameter": { - "in": "query", - "name": "modelName", - "type": "string", - "description": "The Model name.", - "required": false, - "x-ms-parameter-location": "method" - }, - "WebServiceNameParameter": { - "name": "serviceName", - "description": "Name of the Azure Machine Learning service.", - "in": "path", - "type": "string", - "required": true, - "x-ms-parameter-location": "method" - }, - "WebServiceTagParameter": { - "in": "query", - "name": "tag", - "type": "string", - "description": "The object tag.", - "required": false, - "x-ms-parameter-location": "method" - }, - "WebServiceCountParameter": { - "in": "query", - "name": "count", - "type": "integer", - "format": "int32", - "description": "The number of items to retrieve in a page.", - "required": false, - "x-ms-parameter-location": "method" - }, - "WebServiceTagsParameter": { - "in": "query", - "name": "tags", - "type": "string", - "description": "A set of tags with which to filter the returned services. It is a comma separated string of tags key or tags key=value Example: tagKey1,tagKey2,tagKey3=value3 .", - "required": false, - "x-ms-parameter-location": "method" - }, - "WebServicePropertiesParameter": { - "in": "query", - "name": "properties", - "type": "string", - "description": "A set of properties with which to filter the returned services. It is a comma separated string of properties key and/or properties key=value Example: propKey1,propKey2,propKey3=value3 .", - "required": false, - "x-ms-parameter-location": "method" - }, - "WebServiceRunIdParameter": { - "in": "query", - "name": "runId", - "type": "string", - "description": "runId for model associated with service.", - "required": false, - "x-ms-parameter-location": "method" - }, - "WebServiceExpandParameter": { - "in": "query", - "name": "expand", - "type": "boolean", - "description": "Set to True to include Model details.", - "required": false, - "x-ms-parameter-location": "method" - }, - "WebServiceOrderByParameter": { - "in": "query", - "name": "orderby", - "type": "string", - "description": "The option to order the response.", - "required": false, - "default": "UpdatedAtDesc", - "enum": [ - "CreatedAtDesc", - "CreatedAtAsc", - "UpdatedAtDesc", - "UpdatedAtAsc" - ], - "x-ms-enum": { - "name": "OrderString", - "modelAsString": true - }, - "x-ms-parameter-location": "method" - } - }, - "definitions": { - "ServiceResource": { - "type": "object", - "description": "Machine Learning service object wrapped into ARM resource envelope.", - "properties": { - "identity": { - "$ref": "machineLearningServices.json#/definitions/Identity", - "description": "The identity of the resource." - }, - "location": { - "description": "Specifies the location of the resource.", - "type": "string" - }, - "tags": { - "description": "Contains resource tags defined as key/value pairs.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "sku": { - "$ref": "machineLearningServices.json#/definitions/Sku", - "description": "The sku of the workspace." - }, - "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" - } - }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" - }, - { - "type": "object", - "properties": { - "properties": { - "description": "Service properties", - "$ref": "#/definitions/ServiceResponseBase" - } - } - } - ] - }, - "ServiceResponseBase": { - "description": "The base service response. The correct inherited response based on computeType will be returned (ex. ACIServiceResponse)", - "required": [ - "computeType" - ], - "type": "object", - "properties": { - "description": { - "description": "The service description.", - "type": "string" - }, - "kvTags": { - "description": "The service tag dictionary. Tags are mutable.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "description": "The service property dictionary. Properties are immutable.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "state": { - "description": "The current state of the service.", - "enum": [ - "Transitioning", - "Healthy", - "Unhealthy", - "Failed", - "Unschedulable" - ], - "type": "string", - "example": "Healthy", - "x-ms-enum": { - "name": "WebServiceState", - "modelAsString": true - }, - "readOnly": true - }, - "error": { - "description": "The error details.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - ], - "readOnly": true - }, - "computeType": { - "description": "The compute environment type for the service.", - "enum": [ - "ACI", - "AKS" - ], - "type": "string", - "example": "AKS", - "x-ms-enum": { - "name": "ComputeEnvironmentType", - "modelAsString": true - } - }, - "deploymentType": { - "description": "The deployment type for the service.", - "enum": [ - "GRPCRealtimeEndpoint", - "HttpRealtimeEndpoint", - "Batch" - ], - "type": "string", - "example": "HttpRealtimeEndpoint", - "x-ms-enum": { - "name": "DeploymentType", - "modelAsString": true - } - } - }, - "discriminator": "computeType" - }, - "PaginatedServiceList": { - "type": "object", - "description": "Paginated list of Machine Learning service objects wrapped in ARM resource envelope.", - "properties": { - "value": { - "readOnly": true, - "type": "array", - "description": "An array of Machine Learning compute objects wrapped in ARM resource envelope.", - "items": { - "$ref": "#/definitions/ServiceResource" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "A continuation link (absolute URI) to the next page of results in the list." - } - } - }, - "ACIServiceResponse": { - "description": "The response for an ACI service.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ServiceResponseBase" - }, - { - "type": "object", - "properties": { - "containerResourceRequirements": { - "description": "The container resource requirements.", - "$ref": "machineLearningServices.json#/definitions/ContainerResourceRequirements" - }, - "scoringUri": { - "description": "The Uri for sending scoring requests.", - "type": "string", - "readOnly": true - }, - "location": { - "description": "The name of the Azure location/region.", - "type": "string" - }, - "authEnabled": { - "description": "Whether or not authentication is enabled on the service.", - "type": "boolean" - }, - "sslEnabled": { - "description": "Whether or not SSL is enabled.", - "type": "boolean" - }, - "appInsightsEnabled": { - "description": "Whether or not Application Insights is enabled.", - "type": "boolean" - }, - "dataCollection": { - "description": "Details of the data collection options specified.", - "allOf": [ - { - "$ref": "#/definitions/ModelDataCollection" - } - ] - }, - "sslCertificate": { - "description": "The public SSL certificate in PEM format to use if SSL is enabled.", - "type": "string" - }, - "sslKey": { - "description": "The public SSL key in PEM format for the certificate.", - "type": "string" - }, - "cname": { - "description": "The CName for the service.", - "type": "string" - }, - "publicIp": { - "description": "The public IP address for the service.", - "type": "string" - }, - "publicFqdn": { - "description": "The public Fqdn for the service.", - "type": "string" - }, - "swaggerUri": { - "description": "The Uri for sending swagger requests.", - "type": "string", - "readOnly": true - }, - "modelConfigMap": { - "description": "Details on the models and configurations.", - "type": "object", - "additionalProperties": { - "type": "object" - }, - "readOnly": true - }, - "models": { - "description": "The list of models.", - "type": "array", - "items": { - "$ref": "#/definitions/Model" - } - }, - "environmentImageRequest": { - "description": "The Environment, models and assets used for inferencing.", - "allOf": [ - { - "$ref": "#/definitions/EnvironmentImageResponse" - } - ] - }, - "vnetConfiguration": { - "description": "The virtual network configuration.", - "allOf": [ - { - "$ref": "#/definitions/VnetConfiguration" - } - ] - }, - "encryptionProperties": { - "description": "The encryption properties.", - "allOf": [ - { - "$ref": "#/definitions/EncryptionProperties" - } - ] - } - } - } - ], - "x-ms-discriminator-value": "ACI" - }, - "ModelDataCollection": { - "description": "The Model data collection properties.", - "type": "object", - "properties": { - "eventHubEnabled": { - "description": "Option for enabling/disabling Event Hub.", - "type": "boolean" - }, - "storageEnabled": { - "description": "Option for enabling/disabling storage.", - "type": "boolean" - } - } - }, - "VnetConfiguration": { - "type": "object", - "properties": { - "vnetName": { - "description": "The name of the virtual network.", - "type": "string" - }, - "subnetName": { - "description": "The name of the virtual network subnet.", - "type": "string" - } - } - }, - "EncryptionProperties": { - "type": "object", - "properties": { - "vaultBaseUrl": { - "description": "vault base Url", - "type": "string" - }, - "keyName": { - "description": "Encryption Key name", - "type": "string" - }, - "keyVersion": { - "description": "Encryption Key Version", - "type": "string" - } - }, - "required": [ - "vaultBaseUrl", - "keyName", - "keyVersion" - ] - }, - "Model": { - "description": "An Azure Machine Learning Model.", - "required": [ - "mimeType", - "name", - "url" - ], - "type": "object", - "properties": { - "id": { - "description": "The Model Id.", - "type": "string", - "example": "sklearn_mnist:1" - }, - "name": { - "description": "The Model name.", - "type": "string", - "example": "sklearn_mnist" - }, - "framework": { - "description": "The Model framework.", - "type": "string" - }, - "frameworkVersion": { - "description": "The Model framework version.", - "type": "string" - }, - "version": { - "format": "int64", - "description": "The Model version assigned by Model Management Service.", - "type": "integer", - "example": 1 - }, - "datasets": { - "description": "The list of datasets associated with the model.", - "type": "array", - "items": { - "$ref": "#/definitions/DatasetReference" - } - }, - "url": { - "description": "The URL of the Model. Usually a SAS URL.", - "type": "string" - }, - "mimeType": { - "description": "The MIME type of Model content. For more details about MIME type, please open https://www.iana.org/assignments/media-types/media-types.xhtml", - "type": "string" - }, - "description": { - "description": "The Model description text.", - "type": "string", - "example": "A mnist model, first version." - }, - "createdTime": { - "format": "date-time", - "description": "The Model creation time (UTC).", - "type": "string" - }, - "modifiedTime": { - "format": "date-time", - "description": "The Model last modified time (UTC).", - "type": "string" - }, - "unpack": { - "description": "Indicates whether we need to unpack the Model during docker Image creation.", - "type": "boolean" - }, - "parentModelId": { - "description": "The Parent Model Id.", - "type": "string", - "example": "sklearn_mnist_root:1" - }, - "runId": { - "description": "The RunId that created this model.", - "type": "string" - }, - "experimentName": { - "description": "The name of the experiment where this model was created.", - "type": "string" - }, - "kvTags": { - "description": "The Model tag dictionary. Items are mutable.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "description": "The Model property dictionary. Properties are immutable.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "derivedModelIds": { - "description": "Models derived from this model", - "type": "array", - "items": { - "type": "string" - } - }, - "sampleInputData": { - "description": "Sample Input Data for the Model. A reference to a dataset in the workspace in the format aml://dataset/{datasetId}", - "type": "string" - }, - "sampleOutputData": { - "description": "Sample Output Data for the Model. A reference to a dataset in the workspace in the format aml://dataset/{datasetId}", - "type": "string" - }, - "resourceRequirements": { - "description": "Resource requirements for the model", - "$ref": "machineLearningServices.json#/definitions/ContainerResourceRequirements" - } - } - }, - "EnvironmentImageRequest": { - "description": "Request to create a Docker image based on Environment.", - "type": "object", - "properties": { - "driverProgram": { - "description": "The name of the driver file.", - "type": "string" - }, - "assets": { - "description": "The list of assets.", - "type": "array", - "items": { - "$ref": "#/definitions/ImageAsset" - } - }, - "modelIds": { - "description": "The list of model Ids.", - "type": "array", - "items": { - "type": "string" - } - }, - "models": { - "description": "The list of models.", - "type": "array", - "items": { - "$ref": "#/definitions/Model" - } - }, - "environment": { - "description": "The details of the AZURE ML environment.", - "allOf": [ - { - "$ref": "#/definitions/ModelEnvironmentDefinition" - } - ] - }, - "environmentReference": { - "description": "The unique identifying details of the AZURE ML environment.", - "allOf": [ - { - "$ref": "#/definitions/EnvironmentReference" - } - ] - } - } - }, - "EnvironmentImageResponse": { - "description": "Request to create a Docker image based on Environment.", - "type": "object", - "properties": { - "driverProgram": { - "description": "The name of the driver file.", - "type": "string" - }, - "assets": { - "description": "The list of assets.", - "type": "array", - "items": { - "$ref": "#/definitions/ImageAsset" - } - }, - "modelIds": { - "description": "The list of model Ids.", - "type": "array", - "items": { - "type": "string" - } - }, - "models": { - "description": "The list of models.", - "type": "array", - "items": { - "$ref": "#/definitions/Model" - } - }, - "environment": { - "description": "The details of the AZURE ML environment.", - "allOf": [ - { - "$ref": "#/definitions/ModelEnvironmentDefinitionResponse" - } - ] - }, - "environmentReference": { - "description": "The unique identifying details of the AZURE ML environment.", - "allOf": [ - { - "$ref": "#/definitions/EnvironmentReference" - } - ] - } - } - }, - "ImageAsset": { - "description": "An Image asset.", - "type": "object", - "properties": { - "id": { - "description": "The Asset Id.", - "type": "string" - }, - "mimeType": { - "description": "The mime type.", - "type": "string" - }, - "url": { - "description": "The Url of the Asset.", - "type": "string" - }, - "unpack": { - "description": "Whether the Asset is unpacked.", - "type": "boolean" - } - } - }, - "ModelEnvironmentDefinition": { - "type": "object", - "properties": { - "name": { - "description": "The name of the environment.", - "type": "string", - "example": "mydevenvironment" - }, - "version": { - "description": "The environment version.", - "type": "string", - "example": "1" - }, - "python": { - "description": "Settings for a Python environment.", - "allOf": [ - { - "$ref": "#/definitions/ModelPythonSection" - } - ] - }, - "environmentVariables": { - "description": "Definition of environment variables to be defined in the environment.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "docker": { - "description": "The definition of a Docker container.", - "allOf": [ - { - "$ref": "#/definitions/ModelDockerSection" - } - ] - }, - "spark": { - "description": "The configuration for a Spark environment.", - "allOf": [ - { - "$ref": "#/definitions/ModelSparkSection" - } - ] - }, - "r": { - "description": "Settings for a R environment.", - "allOf": [ - { - "$ref": "#/definitions/RSection" - } - ] - }, - "inferencingStackVersion": { - "description": "The inferencing stack version added to the image. To avoid adding an inferencing stack, do not set this value. Valid values: \"latest\".", - "type": "string", - "example": "latest" - } - } - }, - "ModelEnvironmentDefinitionResponse": { - "type": "object", - "properties": { - "name": { - "description": "The name of the environment.", - "type": "string", - "example": "mydevenvironment" - }, - "version": { - "description": "The environment version.", - "type": "string", - "example": "1" - }, - "python": { - "description": "Settings for a Python environment.", - "allOf": [ - { - "$ref": "#/definitions/ModelPythonSection" - } - ] - }, - "environmentVariables": { - "description": "Definition of environment variables to be defined in the environment.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "docker": { - "description": "The definition of a Docker container.", - "allOf": [ - { - "$ref": "#/definitions/ModelDockerSectionResponse" - } - ] - }, - "spark": { - "description": "The configuration for a Spark environment.", - "allOf": [ - { - "$ref": "#/definitions/ModelSparkSection" - } - ] - }, - "r": { - "description": "Settings for a R environment.", - "allOf": [ - { - "$ref": "#/definitions/RSectionResponse" - } - ] - }, - "inferencingStackVersion": { - "description": "The inferencing stack version added to the image. To avoid adding an inferencing stack, do not set this value. Valid values: \"latest\".", - "type": "string", - "example": "latest" - } - } - }, - "EnvironmentReference": { - "type": "object", - "properties": { - "name": { - "description": "Name of the environment.", - "type": "string" - }, - "version": { - "description": "Version of the environment.", - "type": "string" - } - } - }, - "ModelPythonSection": { - "type": "object", - "properties": { - "interpreterPath": { - "description": "The python interpreter path to use if an environment build is not required. The path specified gets used to call the user script.", - "type": "string" - }, - "userManagedDependencies": { - "description": "True means that AzureML reuses an existing python environment; False means that AzureML will create a python environment based on the Conda dependencies specification.", - "type": "boolean" - }, - "condaDependencies": { - "description": "A JObject containing Conda dependencies.", - "type": "object" - }, - "baseCondaEnvironment": { - "type": "string" - } - } - }, - "ContainerRegistry": { - "type": "object", - "properties": { - "address": { - "type": "string" - }, - "username": { - "type": "string", - "x-ms-secret": true - }, - "password": { - "type": "string", - "x-ms-secret": true - } - } - }, - "ContainerRegistryResponse": { - "type": "object", - "properties": { - "address": { - "type": "string" - } - } - }, - "ModelDockerSection": { - "type": "object", - "properties": { - "baseImage": { - "description": "Base image used for Docker-based runs. Mutually exclusive with BaseDockerfile.", - "type": "string", - "example": "ubuntu:latest" - }, - "baseDockerfile": { - "description": "Base Dockerfile used for Docker-based runs. Mutually exclusive with BaseImage.", - "type": "string", - "example": "FROM ubuntu:latest\r\nRUN echo \"Hello world!\"" - }, - "baseImageRegistry": { - "description": "Image registry that contains the base image.", - "allOf": [ - { - "$ref": "#/definitions/ContainerRegistry" - } - ] - } - } - }, - "ModelDockerSectionResponse": { - "type": "object", - "properties": { - "baseImage": { - "description": "Base image used for Docker-based runs. Mutually exclusive with BaseDockerfile.", - "type": "string", - "example": "ubuntu:latest" - }, - "baseDockerfile": { - "description": "Base Dockerfile used for Docker-based runs. Mutually exclusive with BaseImage.", - "type": "string", - "example": "FROM ubuntu:latest\r\nRUN echo \"Hello world!\"" - }, - "baseImageRegistry": { - "description": "Image registry that contains the base image.", - "allOf": [ - { - "$ref": "#/definitions/ContainerRegistryResponse" - } - ] - } - } - }, - "SparkMavenPackage": { - "type": "object", - "properties": { - "group": { - "type": "string" - }, - "artifact": { - "type": "string" - }, - "version": { - "type": "string" - } - } - }, - "ModelSparkSection": { - "type": "object", - "properties": { - "repositories": { - "description": "The list of spark repositories.", - "type": "array", - "items": { - "type": "string" - } - }, - "packages": { - "description": "The Spark packages to use.", - "type": "array", - "items": { - "$ref": "#/definitions/SparkMavenPackage" - } - }, - "precachePackages": { - "description": "Whether to precache the packages.", - "type": "boolean" - } - } - }, - "RCranPackage": { - "type": "object", - "properties": { - "name": { - "description": "The package name.", - "type": "string" - }, - "repository": { - "description": "The repository name.", - "type": "string" - } - } - }, - "RGitHubPackage": { - "type": "object", - "properties": { - "repository": { - "description": "Repository address in the format username/repo[/subdir][@ref|#pull].", - "type": "string" - }, - "authToken": { - "description": "Personal access token to install from a private repo", - "type": "string", - "x-ms-secret": true - } - } - }, - "RGitHubPackageResponse": { - "type": "object", - "properties": { - "repository": { - "description": "Repository address in the format username/repo[/subdir][@ref|#pull].", - "type": "string" - } - } - }, - "RSection": { - "type": "object", - "properties": { - "rVersion": { - "description": "The version of R to be installed", - "type": "string" - }, - "userManaged": { - "description": "Indicates whether the environment is managed by user or by AzureML.", - "type": "boolean" - }, - "rscriptPath": { - "description": "The Rscript path to use if an environment build is not required.\r\nThe path specified gets used to call the user script.", - "type": "string" - }, - "snapshotDate": { - "description": "Date of MRAN snapshot to use in YYYY-MM-DD format, e.g. \"2019-04-17\"", - "type": "string" - }, - "cranPackages": { - "description": "The CRAN packages to use.", - "type": "array", - "items": { - "$ref": "#/definitions/RCranPackage" - } - }, - "gitHubPackages": { - "description": "The packages directly from GitHub.", - "type": "array", - "items": { - "$ref": "#/definitions/RGitHubPackage" - } - }, - "customUrlPackages": { - "description": "The packages from custom urls.", - "type": "array", - "items": { - "type": "string" - } - }, - "bioConductorPackages": { - "description": "The packages from Bioconductor.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "RSectionResponse": { - "type": "object", - "properties": { - "rVersion": { - "description": "The version of R to be installed", - "type": "string" - }, - "userManaged": { - "description": "Indicates whether the environment is managed by user or by AzureML.", - "type": "boolean" - }, - "rscriptPath": { - "description": "The Rscript path to use if an environment build is not required.\r\nThe path specified gets used to call the user script.", - "type": "string" - }, - "snapshotDate": { - "description": "Date of MRAN snapshot to use in YYYY-MM-DD format, e.g. \"2019-04-17\"", - "type": "string" - }, - "cranPackages": { - "description": "The CRAN packages to use.", - "type": "array", - "items": { - "$ref": "#/definitions/RCranPackage" - } - }, - "gitHubPackages": { - "description": "The packages directly from GitHub.", - "type": "array", - "items": { - "$ref": "#/definitions/RGitHubPackageResponse" - } - }, - "customUrlPackages": { - "description": "The packages from custom urls.", - "type": "array", - "items": { - "type": "string" - } - }, - "bioConductorPackages": { - "description": "The packages from Bioconductor.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "DatasetReference": { - "description": "The dataset reference object.", - "type": "object", - "properties": { - "name": { - "description": "The name of the dataset reference.", - "type": "string" - }, - "id": { - "description": "The id of the dataset reference.", - "type": "string" - } - } - }, - "AKSVariantResponse": { - "description": "The response for an AKS variant.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ServiceResponseBase" - }, - { - "type": "object", - "properties": { - "isDefault": { - "description": "Is this the default variant.", - "type": "boolean" - }, - "trafficPercentile": { - "format": "float", - "description": "The amount of traffic variant receives.", - "type": "number", - "example": 100 - }, - "type": { - "description": "The type of the variant.", - "enum": [ - "Control", - "Treatment" - ], - "type": "string", - "example": "Control", - "x-ms-enum": { - "name": "VariantType", - "modelAsString": true - } - } - } - } - ], - "x-ms-discriminator-value": "Custom" - }, - "AutoScaler": { - "description": "The Auto Scaler properties.", - "type": "object", - "properties": { - "autoscaleEnabled": { - "description": "Option to enable/disable auto scaling.", - "type": "boolean" - }, - "minReplicas": { - "format": "int32", - "description": "The minimum number of replicas to scale down to.", - "type": "integer", - "example": 1 - }, - "maxReplicas": { - "format": "int32", - "description": "The maximum number of replicas in the cluster.", - "type": "integer", - "example": 3 - }, - "targetUtilization": { - "format": "int32", - "description": "The target utilization percentage to use for determining whether to scale the cluster.", - "type": "integer", - "example": 70 - }, - "refreshPeriodInSeconds": { - "format": "int32", - "description": "The amount of seconds to wait between auto scale updates.", - "type": "integer", - "example": 120 - } - } - }, - "AKSReplicaStatus": { - "type": "object", - "properties": { - "desiredReplicas": { - "format": "int32", - "description": "The desired number of replicas.", - "type": "integer", - "example": 2 - }, - "updatedReplicas": { - "format": "int32", - "description": "The number of updated replicas.", - "type": "integer", - "example": 1 - }, - "availableReplicas": { - "format": "int32", - "description": "The number of available replicas.", - "type": "integer", - "example": 1 - }, - "error": { - "description": "The error details.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" - } - ] - } - } - }, - "LivenessProbeRequirements": { - "description": "The liveness probe requirements.", - "type": "object", - "properties": { - "failureThreshold": { - "format": "int32", - "description": "The number of failures to allow before returning an unhealthy status.", - "type": "integer" - }, - "successThreshold": { - "format": "int32", - "description": "The number of successful probes before returning a healthy status.", - "type": "integer" - }, - "timeoutSeconds": { - "format": "int32", - "description": "The probe timeout in seconds.", - "type": "integer" - }, - "periodSeconds": { - "format": "int32", - "description": "The length of time between probes in seconds.", - "type": "integer" - }, - "initialDelaySeconds": { - "format": "int32", - "description": "The delay before the first probe in seconds.", - "type": "integer" - } - } - }, - "AKSServiceResponse": { - "description": "The response for an AKS service.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/AKSVariantResponse" - }, - { - "type": "object", - "properties": { - "models": { - "description": "The list of models.", - "type": "array", - "items": { - "$ref": "#/definitions/Model" - } - }, - "containerResourceRequirements": { - "description": "The container resource requirements.", - "$ref": "machineLearningServices.json#/definitions/ContainerResourceRequirements" - }, - "maxConcurrentRequestsPerContainer": { - "format": "int32", - "description": "The maximum number of concurrent requests per container.", - "type": "integer", - "example": 100 - }, - "maxQueueWaitMs": { - "format": "int32", - "description": "Maximum time a request will wait in the queue (in milliseconds). After this time, the service will return 503 (Service Unavailable)", - "type": "integer", - "example": 250 - }, - "computeName": { - "description": "The name of the compute resource.", - "type": "string" - }, - "namespace": { - "description": "The Kubernetes namespace of the deployment.", - "type": "string", - "example": "default" - }, - "numReplicas": { - "format": "int32", - "description": "The number of replicas on the cluster.", - "type": "integer", - "example": 1 - }, - "dataCollection": { - "description": "Details of the data collection options specified.", - "allOf": [ - { - "$ref": "#/definitions/ModelDataCollection" - } - ] - }, - "appInsightsEnabled": { - "description": "Whether or not Application Insights is enabled.", - "type": "boolean" - }, - "autoScaler": { - "description": "The auto scaler properties.", - "allOf": [ - { - "$ref": "#/definitions/AutoScaler" - } - ] - }, - "scoringUri": { - "description": "The Uri for sending scoring requests.", - "type": "string", - "readOnly": true - }, - "deploymentStatus": { - "description": "The deployment status.", - "readOnly": true, - "allOf": [ - { - "$ref": "#/definitions/AKSReplicaStatus" - } - ] - }, - "scoringTimeoutMs": { - "format": "int32", - "description": "The scoring timeout in milliseconds.", - "type": "integer", - "example": 100 - }, - "livenessProbeRequirements": { - "description": "The liveness probe requirements.", - "allOf": [ - { - "$ref": "#/definitions/LivenessProbeRequirements" - } - ] - }, - "authEnabled": { - "description": "Whether or not authentication is enabled.", - "type": "boolean" - }, - "aadAuthEnabled": { - "description": "Whether or not AAD authentication is enabled.", - "type": "boolean" - }, - "swaggerUri": { - "description": "The Uri for sending swagger requests.", - "type": "string", - "readOnly": true - }, - "modelConfigMap": { - "description": "Details on the models and configurations.", - "type": "object", - "additionalProperties": { - "type": "object" - }, - "readOnly": true - }, - "environmentImageRequest": { - "description": "The Environment, models and assets used for inferencing.", - "allOf": [ - { - "$ref": "#/definitions/EnvironmentImageResponse" - } - ] - } - } - } - ], - "x-ms-discriminator-value": "AKS" - }, - "AuthKeys": { - "type": "object", - "properties": { - "primaryKey": { - "description": "The primary key.", - "type": "string" - }, - "secondaryKey": { - "description": "The secondary key.", - "type": "string" - } - } - }, - "CreateServiceRequest": { - "description": "The base class for creating a service.", - "required": [ - "computeType" - ], - "type": "object", - "properties": { - "description": { - "description": "The description of the service.", - "type": "string" - }, - "kvTags": { - "description": "The service tag dictionary. Tags are mutable.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "description": "The service properties dictionary. Properties are immutable.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "keys": { - "description": "The authentication keys.", - "allOf": [ - { - "$ref": "#/definitions/AuthKeys" - } - ] - }, - "computeType": { - "description": "The compute environment type for the service.", - "enum": [ - "ACI", - "AKS" - ], - "type": "string", - "example": "AKS", - "x-ms-enum": { - "name": "ComputeEnvironmentType", - "modelAsString": true - } - }, - "environmentImageRequest": { - "description": "The Environment, models and assets needed for inferencing.", - "allOf": [ - { - "$ref": "#/definitions/EnvironmentImageRequest" - } - ] - }, - "location": { - "description": "The name of the Azure location/region.", - "type": "string" - } - }, - "discriminator": "computeType" - }, - "ACIServiceCreateRequest": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CreateServiceRequest" - }, - { - "type": "object", - "properties": { - "containerResourceRequirements": { - "description": "The container resource requirements.", - "$ref": "machineLearningServices.json#/definitions/ContainerResourceRequirements" - }, - "authEnabled": { - "description": "Whether or not authentication is enabled on the service.", - "default": false, - "type": "boolean" - }, - "sslEnabled": { - "description": "Whether or not SSL is enabled.", - "default": false, - "type": "boolean" - }, - "appInsightsEnabled": { - "description": "Whether or not Application Insights is enabled.", - "default": false, - "type": "boolean" - }, - "dataCollection": { - "description": "Details of the data collection options specified.", - "allOf": [ - { - "$ref": "#/definitions/ModelDataCollection" - } - ] - }, - "sslCertificate": { - "description": "The public SSL certificate in PEM format to use if SSL is enabled.", - "type": "string" - }, - "sslKey": { - "description": "The public SSL key in PEM format for the certificate.", - "type": "string" - }, - "cname": { - "description": "The CName for the service.", - "type": "string" - }, - "dnsNameLabel": { - "description": "The Dns label for the service.", - "type": "string" - }, - "vnetConfiguration": { - "description": "The virtual network configuration.", - "allOf": [ - { - "$ref": "#/definitions/VnetConfiguration" - } - ] - }, - "encryptionProperties": { - "description": "The encryption properties.", - "allOf": [ - { - "$ref": "#/definitions/EncryptionProperties" - } - ] - } - } - } - ], - "x-ms-discriminator-value": "ACI" - }, - "AKSServiceCreateRequest": { - "description": "The request to create an AKS service.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CreateEndpointVariantRequest" - }, - { - "type": "object", - "properties": { - "numReplicas": { - "format": "int32", - "description": "The number of replicas on the cluster.", - "type": "integer", - "example": 1 - }, - "dataCollection": { - "description": "Details of the data collection options specified.", - "allOf": [ - { - "$ref": "#/definitions/ModelDataCollection" - } - ] - }, - "computeName": { - "description": "The name of the compute resource.", - "type": "string" - }, - "appInsightsEnabled": { - "description": "Whether or not Application Insights is enabled.", - "type": "boolean" - }, - "autoScaler": { - "description": "The auto scaler properties.", - "allOf": [ - { - "$ref": "#/definitions/AutoScaler" - } - ] - }, - "containerResourceRequirements": { - "description": "The container resource requirements.", - "$ref": "machineLearningServices.json#/definitions/ContainerResourceRequirements" - }, - "maxConcurrentRequestsPerContainer": { - "format": "int32", - "description": "The maximum number of concurrent requests per container.", - "type": "integer", - "example": 100 - }, - "maxQueueWaitMs": { - "format": "int32", - "description": "Maximum time a request will wait in the queue (in milliseconds). After this time, the service will return 503 (Service Unavailable)", - "type": "integer", - "example": 250 - }, - "namespace": { - "description": "Kubernetes namespace for the service.", - "type": "string", - "example": "default" - }, - "scoringTimeoutMs": { - "format": "int32", - "description": "The scoring timeout in milliseconds.", - "type": "integer", - "example": 100 - }, - "authEnabled": { - "description": "Whether or not authentication is enabled.", - "type": "boolean" - }, - "livenessProbeRequirements": { - "description": "The liveness probe requirements.", - "allOf": [ - { - "$ref": "#/definitions/LivenessProbeRequirements" - } - ] - }, - "aadAuthEnabled": { - "description": "Whether or not AAD authentication is enabled.", - "type": "boolean" - } - } - } - ], - "x-ms-discriminator-value": "AKS" - }, - "CreateEndpointVariantRequest": { - "description": "The Variant properties.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CreateServiceRequest" - }, - { - "type": "object", - "properties": { - "isDefault": { - "description": "Is this the default variant.", - "type": "boolean" - }, - "trafficPercentile": { - "format": "float", - "description": "The amount of traffic variant receives.", - "type": "number", - "example": 100 - }, - "type": { - "description": "The type of the variant.", - "enum": [ - "Control", - "Treatment" - ], - "type": "string", - "example": "Control", - "x-ms-enum": { - "name": "VariantType", - "modelAsString": true - } - } - } - } - ], - "x-ms-discriminator-value": "Custom" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow." - } - } -} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-01-01/examples/ListVMSizesResult.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-01-01/examples/ListVMSizesResult.json index 877cb1dba436..fbd7d336afcf 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-01-01/examples/ListVMSizesResult.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-01-01/examples/ListVMSizesResult.json @@ -9,26 +9,21 @@ "body": { "amlCompute": [ { - "name": "Standard_D1_v2", - "family": "standardDv2Family", + "name": "Standard_DS1_v2", + "family": "standardDSv2Family", "vCPUs": 1, "gpus": 0, "osVhdSizeMB": 1047552, - "maxResourceVolumeMB": 51200, + "maxResourceVolumeMB": 7168, "memoryGB": 3.5, "lowPriorityCapable": true, - "premiumIO": false, + "premiumIO": true, "estimatedVMPrices": { "billingCurrency": "USD", "unitOfMeasure": "OneHour", "values": [ { - "retailPrice": 0.05, - "osType": "Windows", - "vmTier": "LowPriority" - }, - { - "retailPrice": 0.12, + "retailPrice": 0.13, "osType": "Windows", "vmTier": "Standard" }, @@ -38,95 +33,114 @@ "vmTier": "LowPriority" }, { - "retailPrice": 0.06, + "retailPrice": 0.07, "osType": "Linux", "vmTier": "Standard" + }, + { + "retailPrice": 0.05, + "osType": "Windows", + "vmTier": "LowPriority" } ] - } + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] }, { - "name": "Standard_D2_v2", - "family": "standardDv2Family", + "name": "Standard_DS2_v2", + "family": "standardDSv2Family", "vCPUs": 2, "gpus": 0, "osVhdSizeMB": 1047552, - "maxResourceVolumeMB": 102400, - "memoryGB": 7, + "maxResourceVolumeMB": 14336, + "memoryGB": 7.0, "lowPriorityCapable": true, - "premiumIO": false, + "premiumIO": true, "estimatedVMPrices": { "billingCurrency": "USD", "unitOfMeasure": "OneHour", "values": [ { - "retailPrice": 0.09, - "osType": "Windows", + "retailPrice": 0.03, + "osType": "Linux", "vmTier": "LowPriority" }, { - "retailPrice": 0.23, - "osType": "Windows", - "vmTier": "Standard" - }, - { - "retailPrice": 0.11, + "retailPrice": 0.15, "osType": "Linux", "vmTier": "Standard" }, { - "retailPrice": 0.02, - "osType": "Linux", + "retailPrice": 0.1, + "osType": "Windows", "vmTier": "LowPriority" + }, + { + "retailPrice": 0.25, + "osType": "Windows", + "vmTier": "Standard" } ] - } + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance", + "MIR" + ] }, { - "name": "Standard_D11_v2", - "family": "standardDv2Family", - "vCPUs": 2, + "name": "Standard_DS3_v2", + "family": "standardDSv2Family", + "vCPUs": 4, "gpus": 0, "osVhdSizeMB": 1047552, - "maxResourceVolumeMB": 102400, - "memoryGB": 14, + "maxResourceVolumeMB": 28672, + "memoryGB": 14.0, "lowPriorityCapable": true, - "premiumIO": false, + "premiumIO": true, "estimatedVMPrices": { "billingCurrency": "USD", "unitOfMeasure": "OneHour", "values": [ { - "retailPrice": 0.15, - "osType": "Linux", - "vmTier": "Standard" - }, - { - "retailPrice": 0.1, + "retailPrice": 0.2, "osType": "Windows", "vmTier": "LowPriority" }, { - "retailPrice": 0.03, + "retailPrice": 0.06, "osType": "Linux", "vmTier": "LowPriority" }, { - "retailPrice": 0.24, + "retailPrice": 0.5, "osType": "Windows", "vmTier": "Standard" + }, + { + "retailPrice": 0.29, + "osType": "Linux", + "vmTier": "Standard" } ] - } + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance", + "MIR" + ] }, { - "name": "Standard_DS1_v2", + "name": "Standard_DS4_v2", "family": "standardDSv2Family", - "vCPUs": 1, + "vCPUs": 8, "gpus": 0, "osVhdSizeMB": 1047552, - "maxResourceVolumeMB": 7168, - "memoryGB": 3.5, + "maxResourceVolumeMB": 57344, + "memoryGB": 28.0, "lowPriorityCapable": true, "premiumIO": true, "estimatedVMPrices": { @@ -134,36 +148,41 @@ "unitOfMeasure": "OneHour", "values": [ { - "retailPrice": 0.05, - "osType": "Windows", + "retailPrice": 0.12, + "osType": "Linux", "vmTier": "LowPriority" }, { - "retailPrice": 0.12, + "retailPrice": 0.4, "osType": "Windows", - "vmTier": "Standard" + "vmTier": "LowPriority" }, { - "retailPrice": 0.01, - "osType": "Linux", - "vmTier": "LowPriority" + "retailPrice": 1.01, + "osType": "Windows", + "vmTier": "Standard" }, { - "retailPrice": 0.06, + "retailPrice": 0.58, "osType": "Linux", "vmTier": "Standard" } ] - } + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance", + "MIR" + ] }, { - "name": "Standard_F2s_v2", - "family": "standardFSv2Family", - "vCPUs": 2, + "name": "Standard_DS5_v2", + "family": "standardDSv2Family", + "vCPUs": 16, "gpus": 0, "osVhdSizeMB": 1047552, - "maxResourceVolumeMB": 16384, - "memoryGB": 4, + "maxResourceVolumeMB": 114688, + "memoryGB": 56.0, "lowPriorityCapable": true, "premiumIO": true, "estimatedVMPrices": { @@ -171,36 +190,41 @@ "unitOfMeasure": "OneHour", "values": [ { - "retailPrice": 0.02, - "osType": "Linux", - "vmTier": "LowPriority" - }, - { - "retailPrice": 0.08, + "retailPrice": 1.17, "osType": "Linux", "vmTier": "Standard" }, { - "retailPrice": 0.06, + "retailPrice": 0.81, "osType": "Windows", "vmTier": "LowPriority" }, { - "retailPrice": 0.16, + "retailPrice": 2.02, "osType": "Windows", "vmTier": "Standard" + }, + { + "retailPrice": 0.23, + "osType": "Linux", + "vmTier": "LowPriority" } ] - } + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance", + "MIR" + ] }, { - "name": "Standard_M32-8ms", - "family": "standardMSFamily", - "vCPUs": 32, + "name": "Standard_DS11_v2", + "family": "standardDSv2Family", + "vCPUs": 2, "gpus": 0, "osVhdSizeMB": 1047552, - "maxResourceVolumeMB": 1024000, - "memoryGB": 875, + "maxResourceVolumeMB": 28672, + "memoryGB": 14.0, "lowPriorityCapable": true, "premiumIO": true, "estimatedVMPrices": { @@ -208,110 +232,122 @@ "unitOfMeasure": "OneHour", "values": [ { - "retailPrice": 8.43, + "retailPrice": 0.26, "osType": "Windows", "vmTier": "Standard" }, { - "retailPrice": 1.23, + "retailPrice": 0.18, "osType": "Linux", - "vmTier": "LowPriority" + "vmTier": "Standard" }, { - "retailPrice": 3.37, + "retailPrice": 0.11, "osType": "Windows", "vmTier": "LowPriority" }, { - "retailPrice": 6.15, + "retailPrice": 0.04, "osType": "Linux", - "vmTier": "Standard" + "vmTier": "LowPriority" } ] - } + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] }, { - "name": "Standard_NC6", - "family": "standardNCFamily", - "vCPUs": 6, - "gpus": 1, + "name": "Standard_DS12_v2", + "family": "standardDSv2Family", + "vCPUs": 4, + "gpus": 0, "osVhdSizeMB": 1047552, - "maxResourceVolumeMB": 389120, - "memoryGB": 56, + "maxResourceVolumeMB": 57344, + "memoryGB": 28.0, "lowPriorityCapable": true, - "premiumIO": false, + "premiumIO": true, "estimatedVMPrices": { "billingCurrency": "USD", "unitOfMeasure": "OneHour", "values": [ { - "retailPrice": 0.18, + "retailPrice": 0.37, "osType": "Linux", - "vmTier": "LowPriority" + "vmTier": "Standard" }, { - "retailPrice": 0.43, + "retailPrice": 0.53, "osType": "Windows", - "vmTier": "LowPriority" - }, - { - "retailPrice": 0.9, - "osType": "Linux", "vmTier": "Standard" }, { - "retailPrice": 1.08, + "retailPrice": 0.21, "osType": "Windows", - "vmTier": "Standard" + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.07, + "osType": "Linux", + "vmTier": "LowPriority" } ] - } + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] }, { - "name": "Standard_NV6", - "family": "standardNVFamily", - "vCPUs": 6, - "gpus": 1, + "name": "Standard_DS13_v2", + "family": "standardDSv2Family", + "vCPUs": 8, + "gpus": 0, "osVhdSizeMB": 1047552, - "maxResourceVolumeMB": 389120, - "memoryGB": 56, + "maxResourceVolumeMB": 114688, + "memoryGB": 56.0, "lowPriorityCapable": true, - "premiumIO": false, + "premiumIO": true, "estimatedVMPrices": { "billingCurrency": "USD", "unitOfMeasure": "OneHour", "values": [ { - "retailPrice": 1.28, - "osType": "Windows", - "vmTier": "Standard" + "retailPrice": 0.15, + "osType": "Linux", + "vmTier": "LowPriority" }, { - "retailPrice": 0.51, + "retailPrice": 0.42, "osType": "Windows", "vmTier": "LowPriority" }, { - "retailPrice": 0.22, + "retailPrice": 0.74, "osType": "Linux", - "vmTier": "LowPriority" + "vmTier": "Standard" }, { - "retailPrice": 1.09, - "osType": "Linux", + "retailPrice": 1.06, + "osType": "Windows", "vmTier": "Standard" } ] - } + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] }, { - "name": "Standard_ND6s", - "family": "standardNDSFamily", - "vCPUs": 6, - "gpus": 1, + "name": "Standard_DS14_v2", + "family": "standardDSv2Family", + "vCPUs": 16, + "gpus": 0, "osVhdSizeMB": 1047552, - "maxResourceVolumeMB": 344064, - "memoryGB": 112, + "maxResourceVolumeMB": 229376, + "memoryGB": 112.0, "lowPriorityCapable": true, "premiumIO": true, "estimatedVMPrices": { @@ -319,27 +355,31 @@ "unitOfMeasure": "OneHour", "values": [ { - "retailPrice": 2.07, + "retailPrice": 0.3, "osType": "Linux", - "vmTier": "Standard" + "vmTier": "LowPriority" }, { - "retailPrice": 0.36, + "retailPrice": 1.48, "osType": "Linux", - "vmTier": "LowPriority" + "vmTier": "Standard" }, { - "retailPrice": 0.87, + "retailPrice": 0.84, "osType": "Windows", "vmTier": "LowPriority" }, { - "retailPrice": 2.49, + "retailPrice": 2.11, "osType": "Windows", "vmTier": "Standard" } ] - } + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] } ] } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-01-01/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-01-01/machineLearningServices.json index 6c701fbd1e2c..fa15a52c1a8c 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-01-01/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-01-01/machineLearningServices.json @@ -2607,6 +2607,14 @@ "title": "Estimated VM prices", "description": "The estimated price information for using a VM.", "$ref": "#/definitions/EstimatedVMPrices" + }, + "supportedComputeTypes": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Supported Compute Types", + "description": "Specifies the compute types supported by the virtual machine size." } }, "description": "Describes the properties of a VM size." diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-04-01/examples/ListVMSizesResult.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-04-01/examples/ListVMSizesResult.json index 67c43915df17..1cadc7af992b 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-04-01/examples/ListVMSizesResult.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-04-01/examples/ListVMSizesResult.json @@ -9,26 +9,21 @@ "body": { "amlCompute": [ { - "name": "Standard_D1_v2", - "family": "standardDv2Family", + "name": "Standard_DS1_v2", + "family": "standardDSv2Family", "vCPUs": 1, "gpus": 0, "osVhdSizeMB": 1047552, - "maxResourceVolumeMB": 51200, + "maxResourceVolumeMB": 7168, "memoryGB": 3.5, "lowPriorityCapable": true, - "premiumIO": false, + "premiumIO": true, "estimatedVMPrices": { "billingCurrency": "USD", "unitOfMeasure": "OneHour", "values": [ { - "retailPrice": 0.05, - "osType": "Windows", - "vmTier": "LowPriority" - }, - { - "retailPrice": 0.12, + "retailPrice": 0.13, "osType": "Windows", "vmTier": "Standard" }, @@ -38,95 +33,114 @@ "vmTier": "LowPriority" }, { - "retailPrice": 0.06, + "retailPrice": 0.07, "osType": "Linux", "vmTier": "Standard" + }, + { + "retailPrice": 0.05, + "osType": "Windows", + "vmTier": "LowPriority" } ] - } + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] }, { - "name": "Standard_D2_v2", - "family": "standardDv2Family", + "name": "Standard_DS2_v2", + "family": "standardDSv2Family", "vCPUs": 2, "gpus": 0, "osVhdSizeMB": 1047552, - "maxResourceVolumeMB": 102400, - "memoryGB": 7, + "maxResourceVolumeMB": 14336, + "memoryGB": 7.0, "lowPriorityCapable": true, - "premiumIO": false, + "premiumIO": true, "estimatedVMPrices": { "billingCurrency": "USD", "unitOfMeasure": "OneHour", "values": [ { - "retailPrice": 0.09, - "osType": "Windows", + "retailPrice": 0.03, + "osType": "Linux", "vmTier": "LowPriority" }, { - "retailPrice": 0.23, - "osType": "Windows", - "vmTier": "Standard" - }, - { - "retailPrice": 0.11, + "retailPrice": 0.15, "osType": "Linux", "vmTier": "Standard" }, { - "retailPrice": 0.02, - "osType": "Linux", + "retailPrice": 0.1, + "osType": "Windows", "vmTier": "LowPriority" + }, + { + "retailPrice": 0.25, + "osType": "Windows", + "vmTier": "Standard" } ] - } + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance", + "MIR" + ] }, { - "name": "Standard_D11_v2", - "family": "standardDv2Family", - "vCPUs": 2, + "name": "Standard_DS3_v2", + "family": "standardDSv2Family", + "vCPUs": 4, "gpus": 0, "osVhdSizeMB": 1047552, - "maxResourceVolumeMB": 102400, - "memoryGB": 14, + "maxResourceVolumeMB": 28672, + "memoryGB": 14.0, "lowPriorityCapable": true, - "premiumIO": false, + "premiumIO": true, "estimatedVMPrices": { "billingCurrency": "USD", "unitOfMeasure": "OneHour", "values": [ { - "retailPrice": 0.15, - "osType": "Linux", - "vmTier": "Standard" - }, - { - "retailPrice": 0.1, + "retailPrice": 0.2, "osType": "Windows", "vmTier": "LowPriority" }, { - "retailPrice": 0.03, + "retailPrice": 0.06, "osType": "Linux", "vmTier": "LowPriority" }, { - "retailPrice": 0.24, + "retailPrice": 0.5, "osType": "Windows", "vmTier": "Standard" + }, + { + "retailPrice": 0.29, + "osType": "Linux", + "vmTier": "Standard" } ] - } + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance", + "MIR" + ] }, { - "name": "Standard_DS1_v2", + "name": "Standard_DS4_v2", "family": "standardDSv2Family", - "vCPUs": 1, + "vCPUs": 8, "gpus": 0, "osVhdSizeMB": 1047552, - "maxResourceVolumeMB": 7168, - "memoryGB": 3.5, + "maxResourceVolumeMB": 57344, + "memoryGB": 28.0, "lowPriorityCapable": true, "premiumIO": true, "estimatedVMPrices": { @@ -134,36 +148,41 @@ "unitOfMeasure": "OneHour", "values": [ { - "retailPrice": 0.05, - "osType": "Windows", + "retailPrice": 0.12, + "osType": "Linux", "vmTier": "LowPriority" }, { - "retailPrice": 0.12, + "retailPrice": 0.4, "osType": "Windows", - "vmTier": "Standard" + "vmTier": "LowPriority" }, { - "retailPrice": 0.01, - "osType": "Linux", - "vmTier": "LowPriority" + "retailPrice": 1.01, + "osType": "Windows", + "vmTier": "Standard" }, { - "retailPrice": 0.06, + "retailPrice": 0.58, "osType": "Linux", "vmTier": "Standard" } ] - } + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance", + "MIR" + ] }, { - "name": "Standard_F2s_v2", - "family": "standardFSv2Family", - "vCPUs": 2, + "name": "Standard_DS5_v2", + "family": "standardDSv2Family", + "vCPUs": 16, "gpus": 0, "osVhdSizeMB": 1047552, - "maxResourceVolumeMB": 16384, - "memoryGB": 4, + "maxResourceVolumeMB": 114688, + "memoryGB": 56.0, "lowPriorityCapable": true, "premiumIO": true, "estimatedVMPrices": { @@ -171,36 +190,41 @@ "unitOfMeasure": "OneHour", "values": [ { - "retailPrice": 0.02, - "osType": "Linux", - "vmTier": "LowPriority" - }, - { - "retailPrice": 0.08, + "retailPrice": 1.17, "osType": "Linux", "vmTier": "Standard" }, { - "retailPrice": 0.06, + "retailPrice": 0.81, "osType": "Windows", "vmTier": "LowPriority" }, { - "retailPrice": 0.16, + "retailPrice": 2.02, "osType": "Windows", "vmTier": "Standard" + }, + { + "retailPrice": 0.23, + "osType": "Linux", + "vmTier": "LowPriority" } ] - } + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance", + "MIR" + ] }, { - "name": "Standard_M32-8ms", - "family": "standardMSFamily", - "vCPUs": 32, + "name": "Standard_DS11_v2", + "family": "standardDSv2Family", + "vCPUs": 2, "gpus": 0, "osVhdSizeMB": 1047552, - "maxResourceVolumeMB": 1024000, - "memoryGB": 875, + "maxResourceVolumeMB": 28672, + "memoryGB": 14.0, "lowPriorityCapable": true, "premiumIO": true, "estimatedVMPrices": { @@ -208,110 +232,122 @@ "unitOfMeasure": "OneHour", "values": [ { - "retailPrice": 8.43, + "retailPrice": 0.26, "osType": "Windows", "vmTier": "Standard" }, { - "retailPrice": 1.23, + "retailPrice": 0.18, "osType": "Linux", - "vmTier": "LowPriority" + "vmTier": "Standard" }, { - "retailPrice": 3.37, + "retailPrice": 0.11, "osType": "Windows", "vmTier": "LowPriority" }, { - "retailPrice": 6.15, + "retailPrice": 0.04, "osType": "Linux", - "vmTier": "Standard" + "vmTier": "LowPriority" } ] - } + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] }, { - "name": "Standard_NC6", - "family": "standardNCFamily", - "vCPUs": 6, - "gpus": 1, + "name": "Standard_DS12_v2", + "family": "standardDSv2Family", + "vCPUs": 4, + "gpus": 0, "osVhdSizeMB": 1047552, - "maxResourceVolumeMB": 389120, - "memoryGB": 56, + "maxResourceVolumeMB": 57344, + "memoryGB": 28.0, "lowPriorityCapable": true, - "premiumIO": false, + "premiumIO": true, "estimatedVMPrices": { "billingCurrency": "USD", "unitOfMeasure": "OneHour", "values": [ { - "retailPrice": 0.18, + "retailPrice": 0.37, "osType": "Linux", - "vmTier": "LowPriority" + "vmTier": "Standard" }, { - "retailPrice": 0.43, + "retailPrice": 0.53, "osType": "Windows", - "vmTier": "LowPriority" - }, - { - "retailPrice": 0.9, - "osType": "Linux", "vmTier": "Standard" }, { - "retailPrice": 1.08, + "retailPrice": 0.21, "osType": "Windows", - "vmTier": "Standard" + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.07, + "osType": "Linux", + "vmTier": "LowPriority" } ] - } + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] }, { - "name": "Standard_NV6", - "family": "standardNVFamily", - "vCPUs": 6, - "gpus": 1, + "name": "Standard_DS13_v2", + "family": "standardDSv2Family", + "vCPUs": 8, + "gpus": 0, "osVhdSizeMB": 1047552, - "maxResourceVolumeMB": 389120, - "memoryGB": 56, + "maxResourceVolumeMB": 114688, + "memoryGB": 56.0, "lowPriorityCapable": true, - "premiumIO": false, + "premiumIO": true, "estimatedVMPrices": { "billingCurrency": "USD", "unitOfMeasure": "OneHour", "values": [ { - "retailPrice": 1.28, - "osType": "Windows", - "vmTier": "Standard" + "retailPrice": 0.15, + "osType": "Linux", + "vmTier": "LowPriority" }, { - "retailPrice": 0.51, + "retailPrice": 0.42, "osType": "Windows", "vmTier": "LowPriority" }, { - "retailPrice": 0.22, + "retailPrice": 0.74, "osType": "Linux", - "vmTier": "LowPriority" + "vmTier": "Standard" }, { - "retailPrice": 1.09, - "osType": "Linux", + "retailPrice": 1.06, + "osType": "Windows", "vmTier": "Standard" } ] - } + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] }, { - "name": "Standard_ND6s", - "family": "standardNDSFamily", - "vCPUs": 6, - "gpus": 1, + "name": "Standard_DS14_v2", + "family": "standardDSv2Family", + "vCPUs": 16, + "gpus": 0, "osVhdSizeMB": 1047552, - "maxResourceVolumeMB": 344064, - "memoryGB": 112, + "maxResourceVolumeMB": 229376, + "memoryGB": 112.0, "lowPriorityCapable": true, "premiumIO": true, "estimatedVMPrices": { @@ -319,27 +355,31 @@ "unitOfMeasure": "OneHour", "values": [ { - "retailPrice": 2.07, + "retailPrice": 0.3, "osType": "Linux", - "vmTier": "Standard" + "vmTier": "LowPriority" }, { - "retailPrice": 0.36, + "retailPrice": 1.48, "osType": "Linux", - "vmTier": "LowPriority" + "vmTier": "Standard" }, { - "retailPrice": 0.87, + "retailPrice": 0.84, "osType": "Windows", "vmTier": "LowPriority" }, { - "retailPrice": 2.49, + "retailPrice": 2.11, "osType": "Windows", "vmTier": "Standard" } ] - } + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] } ] } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-04-01/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-04-01/machineLearningServices.json index 2f6b62c632cf..ba1aca996436 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-04-01/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-04-01/machineLearningServices.json @@ -2615,6 +2615,14 @@ "title": "Estimated VM prices", "description": "The estimated price information for using a VM.", "$ref": "#/definitions/EstimatedVMPrices" + }, + "supportedComputeTypes": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Supported Compute Types", + "description": "Specifies the compute types supported by the virtual machine size." } }, "description": "Describes the properties of a VM size." diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/createOrUpdate/AKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/createOrUpdate/AKSCompute.json new file mode 100644 index 000000000000..02611046de3b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/createOrUpdate/AKSCompute.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2021-07-01", + "parameters": { + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "properties": { + "agentCount": 4 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Succeeded", + "properties": { + "agentCount": 4 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Updating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/createOrUpdate/AmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/createOrUpdate/AmlCompute.json new file mode 100644 index 000000000000..ac555ff18eb2 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/createOrUpdate/AmlCompute.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2021-07-01", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "AmlCompute", + "description": "some compute", + "properties": { + "scaleSettings": { + "maxNodeCount": 4, + "minNodeCount": 4, + "nodeIdleTimeBeforeScaleDown": "PT5M" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "createdOn": "2021-04-01T22:00:00.0000000+00:00", + "modifiedOn": "2021-04-01T22:00:00.0000000+00:00", + "computeType": "AmlCompute", + "provisioningState": "Succeeded", + "properties": { + "vmSize": "STANDARD_NC6", + "vmPriority": "Dedicated", + "osType": "Windows", + "virtualMachineImage": null, + "isolatedNetwork": false, + "subnet": "test-subnet-resource-id", + "scaleSettings": { + "maxNodeCount": 1, + "minNodeCount": 0, + "nodeIdleTimeBeforeScaleDown": "PT5M" + }, + "remoteLoginPortPublicAccess": "Enabled", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-09-27T22:28:08.998Z", + "errors": null, + "currentNodeCount": 0, + "targetNodeCount": 1, + "nodeStateCounts": { + "preparingNodeCount": 0, + "runningNodeCount": 0, + "idleNodeCount": 0, + "unusableNodeCount": 0, + "leavingNodeCount": 0, + "preemptedNodeCount": 0 + }, + "enableNodePublicIp": true + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "computeType": "AmlCompute", + "provisioningState": "Updating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/createOrUpdate/BasicAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/createOrUpdate/BasicAKSCompute.json new file mode 100644 index 000000000000..8275f639cb76 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/createOrUpdate/BasicAKSCompute.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2021-07-01", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "AKS" + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "AKS", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "AKS", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/createOrUpdate/BasicAmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/createOrUpdate/BasicAmlCompute.json new file mode 100644 index 000000000000..69edafb6cfd5 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/createOrUpdate/BasicAmlCompute.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2021-07-01", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "AmlCompute", + "properties": { + "vmSize": "STANDARD_NC6", + "vmPriority": "Dedicated", + "osType": "Windows", + "virtualMachineImage": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myImageGallery/images/myImageDefinition/versions/0.0.1" + }, + "isolatedNetwork": false, + "scaleSettings": { + "maxNodeCount": 1, + "minNodeCount": 0, + "nodeIdleTimeBeforeScaleDown": "PT5M" + }, + "remoteLoginPortPublicAccess": "NotSpecified", + "enableNodePublicIp": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "AmlCompute", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "AmlCompute", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/createOrUpdate/BasicDataFactoryCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/createOrUpdate/BasicDataFactoryCompute.json new file mode 100644 index 000000000000..a8caa00c4095 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/createOrUpdate/BasicDataFactoryCompute.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2021-07-01", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "DataFactory" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "DataFactory", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "DataFactory", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/createOrUpdate/ComputeInstance.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/createOrUpdate/ComputeInstance.json new file mode 100644 index 000000000000..2b7d9a5f608f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/createOrUpdate/ComputeInstance.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2021-07-01", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "properties": { + "vmSize": "STANDARD_NC6", + "subnet": "test-subnet-resource-id", + "applicationSharingPolicy": "Personal", + "sshSettings": { + "sshPublicAccess": "Disabled" + }, + "computeInstanceAuthorizationType": "personal", + "personalComputeInstanceSettings": { + "assignedUser": { + "objectId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/createOrUpdate/ComputeInstanceMinimal.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/createOrUpdate/ComputeInstanceMinimal.json new file mode 100644 index 000000000000..5f3f4f5f7e89 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/createOrUpdate/ComputeInstanceMinimal.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2021-07-01", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "properties": { + "vmSize": "STANDARD_NC6" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/createOrUpdate/KubernetesCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/createOrUpdate/KubernetesCompute.json new file mode 100644 index 000000000000..a06657a2dc9a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/createOrUpdate/KubernetesCompute.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2021-07-01", + "parameters": { + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "Kubernetes", + "properties": { + "namespace": "default", + "defaultInstanceType": "defaultInstanceType", + "instanceTypes": { + "defaultInstanceType": { + "nodeSelector": null, + "resources": { + "requests": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + }, + "limits": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "Kubernetes", + "provisioningState": "Creating", + "properties": { + "relayConnectionString": null, + "serviceBusConnectionString": null, + "extensionPrincipalId": null, + "extensionInstanceReleaseTrain": "stable", + "vcName": null, + "namespace": "default", + "defaultInstanceType": "defaultInstanceType", + "instanceTypes": { + "defaultInstanceType": { + "nodeSelector": null, + "resources": { + "requests": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + }, + "limits": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + } + } + } + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "Kubernetes", + "provisioningState": "Creating", + "properties": { + "relayConnectionString": null, + "serviceBusConnectionString": null, + "extensionPrincipalId": null, + "extensionInstanceReleaseTrain": "stable", + "vcName": null, + "namespace": "default", + "defaultInstanceType": "defaultInstanceType", + "instanceTypes": { + "defaultInstanceType": { + "nodeSelector": null, + "resources": { + "requests": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + }, + "limits": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + } + } + } + } + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/delete.json new file mode 100644 index 000000000000..acb29eb23e03 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2021-07-01", + "underlyingResourceAction": "Delete" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/...pathToOperationResult..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/get/AKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/get/AKSCompute.json new file mode 100644 index 000000000000..2fb95a55a5c1 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/get/AKSCompute.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "createdOn": "2021-04-01T22:00:00.0000000+00:00", + "modifiedOn": "2021-04-01T22:00:00.0000000+00:00", + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/get/AmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/get/AmlCompute.json new file mode 100644 index 000000000000..ac34921c93d3 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/get/AmlCompute.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "createdOn": "2021-04-01T22:00:00.0000000+00:00", + "modifiedOn": "2021-04-01T22:00:00.0000000+00:00", + "computeType": "AmlCompute", + "provisioningState": "Succeeded", + "properties": { + "vmSize": "STANDARD_NC6", + "vmPriority": "Dedicated", + "osType": "Windows", + "virtualMachineImage": null, + "isolatedNetwork": false, + "subnet": "test-subnet-resource-id", + "scaleSettings": { + "maxNodeCount": 1, + "minNodeCount": 0, + "nodeIdleTimeBeforeScaleDown": "PT5M" + }, + "remoteLoginPortPublicAccess": "Enabled", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-09-27T22:28:08.998Z", + "errors": null, + "currentNodeCount": 0, + "targetNodeCount": 1, + "nodeStateCounts": { + "preparingNodeCount": 0, + "runningNodeCount": 0, + "idleNodeCount": 0, + "unusableNodeCount": 0, + "leavingNodeCount": 0, + "preemptedNodeCount": 0 + }, + "enableNodePublicIp": true + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/get/ComputeInstance.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/get/ComputeInstance.json new file mode 100644 index 000000000000..ba8e8b560f9f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/get/ComputeInstance.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "createdOn": "2021-04-01T22:00:00.0000000+00:00", + "modifiedOn": "2021-04-01T22:00:00.0000000+00:00", + "computeType": "ComputeInstance", + "provisioningState": "Succeeded", + "properties": { + "vmSize": "STANDARD_NC6", + "subnet": "test-subnet-resource-id", + "applicationSharingPolicy": "Shared", + "sshSettings": { + "sshPublicAccess": "Enabled", + "adminUserName": "azureuser", + "sshPort": 22 + }, + "computeInstanceAuthorizationType": "personal", + "personalComputeInstanceSettings": { + "assignedUser": { + "objectId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + } + }, + "createdBy": { + "userName": "foobar@microsoft.com", + "userOrgId": "00000000-0000-0000-0000-000000000000", + "userId": "00000000-0000-0000-0000-000000000000" + }, + "connectivityEndpoints": { + "publicIpAddress": "10.0.0.1", + "privateIpAddress": "10.0.0.1" + }, + "applications": [ + { + "displayName": "Jupyter", + "endpointUri": "https://compute123.eastus2.azureml.net/jupyter" + } + ], + "errors": null, + "state": "Running" + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/get/KubernetesCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/get/KubernetesCompute.json new file mode 100644 index 000000000000..f13fa52091bf --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/get/KubernetesCompute.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "createdOn": "2021-04-01T22:00:00.0000000+00:00", + "modifiedOn": "2021-04-01T22:00:00.0000000+00:00", + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "Kubernetes", + "provisioningState": "Succeeded", + "isAttachedCompute": true, + "properties": { + "relayConnectionString": null, + "serviceBusConnectionString": null, + "extensionPrincipalId": null, + "extensionInstanceReleaseTrain": "stable", + "vcName": null, + "namespace": "default", + "defaultInstanceType": "defaultInstanceType", + "instanceTypes": { + "defaultInstanceType": { + "nodeSelector": null, + "resources": { + "requests": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + }, + "limits": { + "cpu": "1", + "memory": "4Gi", + "nvidia.com/gpu": null + } + } + } + } + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/list.json new file mode 100644 index 000000000000..657146bbdf03 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/list.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2021-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "createdOn": "2021-04-01T22:00:00.0000000+00:00", + "modifiedOn": "2021-04-01T22:00:00.0000000+00:00", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute1234", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute1234", + "location": "eastus", + "properties": { + "description": "some compute", + "createdOn": "2021-04-01T22:00:00.0000000+00:00", + "modifiedOn": "2021-04-01T22:00:00.0000000+00:00", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute1234-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/listKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/listKeys.json new file mode 100644 index 000000000000..ff5eb1395a78 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/listKeys.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "body": { + "computeType": "AKS", + "userKubeConfig": "user kube config...", + "adminKubeConfig": "admin kube config...", + "imagePullSecretName": "the image pull secret name" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/listNodes.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/listNodes.json new file mode 100644 index 000000000000..398b809a3900 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/listNodes.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "body": { + "nodes": [ + { + "nodeId": "tvm-3601533753_1-20170719t162906z", + "privateIpAddress": "13.84.190.124", + "publicIpAddress": "13.84.190.134", + "port": 50000, + "nodeState": "running", + "runId": "2f378a44-38f2-443a-9f0d-9909d0b47890" + }, + { + "nodeId": "tvm-3601533753_2-20170719t162906z", + "privateIpAddress": "13.84.190.124", + "publicIpAddress": "13.84.190.134", + "port": 50001, + "nodeState": "idle" + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/patch.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/patch.json new file mode 100644 index 000000000000..018da04bec51 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/patch.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2021-07-01", + "parameters": { + "properties": { + "properties": { + "scaleSettings": { + "maxNodeCount": 4, + "minNodeCount": 4, + "nodeIdleTimeBeforeScaleDown": "PT5M" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "computeType": "AmlCompute", + "provisioningState": "Updating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/restart.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/restart.json new file mode 100644 index 000000000000..7326f11d534a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/restart.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2021-07-01" + }, + "responses": { + "202": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/start.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/start.json new file mode 100644 index 000000000000..7326f11d534a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/start.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2021-07-01" + }, + "responses": { + "202": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/stop.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/stop.json new file mode 100644 index 000000000000..7326f11d534a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Compute/stop.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2021-07-01" + }, + "responses": { + "202": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/ExternalFQDN/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/ExternalFQDN/get.json new file mode 100644 index 000000000000..591626f1fa3f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/ExternalFQDN/get.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "category": "Azure Active Directory", + "endpoints": [ + { + "domainName": "login.microsoftonline.com", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + } + }, + { + "properties": { + "category": "Azure portal", + "endpoints": [ + { + "domainName": "management.azure.com", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Notebook/listKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Notebook/listKeys.json new file mode 100644 index 000000000000..3daff45dffe0 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Notebook/listKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "body": { + "primaryAccessKey": null, + "secondaryAccessKey": null + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Notebook/prepare.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Notebook/prepare.json new file mode 100644 index 000000000000..5bd461d2b336 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Notebook/prepare.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "body": { + "resourceId": "aabbccddee112233445566778899", + "fqdn": "testnotebook.notebooks.azure.com", + "notebookPreparationError": { + "statusCode": 500, + "errorMessage": "general error" + } + } + }, + "202": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/PrivateEndpointConnection/createOrUpdate.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/PrivateEndpointConnection/createOrUpdate.json new file mode 100644 index 000000000000..56a0760417e8 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/PrivateEndpointConnection/createOrUpdate.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg-1234", + "workspaceName": "testworkspace", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2021-07-01", + "monitor": "true", + "properties": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/PrivateEndpointConnection/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/PrivateEndpointConnection/delete.json new file mode 100644 index 000000000000..ea2f5adcec32 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/PrivateEndpointConnection/delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg-1234", + "workspaceName": "testworkspace", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2021-07-01", + "monitor": "true" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/PrivateEndpointConnection/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/PrivateEndpointConnection/get.json new file mode 100644 index 000000000000..dbe9336b1a69 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/PrivateEndpointConnection/get.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg-1234", + "workspaceName": "testworkspace", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2021-07-01", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/PrivateEndpointConnection/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/PrivateEndpointConnection/list.json new file mode 100644 index 000000000000..a19dbfe54820 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/PrivateEndpointConnection/list.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg-1234", + "workspaceName": "testworkspace", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2021-07-01", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/PrivateLinkResource/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/PrivateLinkResource/list.json new file mode 100644 index 000000000000..7b12b961de22 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/PrivateLinkResource/list.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg-1234", + "workspaceName": "testworkspace", + "api-version": "2021-07-01", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateLinkResources/amlworkspace", + "name": "amlworkspace", + "type": "Microsoft.MachineLearningServices/workspaces/privateLinkResources", + "properties": { + "groupId": "amlworkspace", + "requiredMembers": [ + "default" + ] + } + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Quota/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Quota/list.json new file mode 100644 index 000000000000..68875002eba2 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Quota/list.json @@ -0,0 +1,415 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_D_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 48, + "name": { + "localizedValue": "Standard D Family Cluster Dedicated vCPUs", + "value": "Standard D Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_D_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 12, + "name": { + "value": "Standard D Family Cluster Dedicated vCPUs", + "localizedValue": "Standard D Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_D_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 12, + "name": { + "value": "Standard D Family Cluster Dedicated vCPUs", + "localizedValue": "Standard D Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_D_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard D Family Cluster Dedicated vCPUs", + "localizedValue": "Standard D Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quota", + "limit": 24, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 12, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 12, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_Dv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 24, + "name": { + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs", + "value": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_Dv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard Dv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_Dv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard Dv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_Dv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard Dv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_FSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 24, + "name": { + "value": "Standard FSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_FSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard FSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_FSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard FSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_FSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 12, + "name": { + "value": "Standard FSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 24, + "name": { + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs", + "value": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard NC Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard NC Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard NC Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_NCv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 0, + "name": { + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs", + "value": "Standard NCv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_NCv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NCv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_NCv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NCv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_NCv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NCv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_NCv3_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 0, + "name": { + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs", + "value": "Standard NCv3 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_NCv3_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NCv3 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_NCv3_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NCv3 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_NCv3_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NCv3 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_ND_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 0, + "name": { + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs", + "value": "Standard ND Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_ND_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard ND Family Cluster Dedicated vCPUs", + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_ND_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard ND Family Cluster Dedicated vCPUs", + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_ND_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard ND Family Cluster Dedicated vCPUs", + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_NDv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 0, + "name": { + "value": "Standard NDv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_NDv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NDv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_NDv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NDv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_NDv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NDv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_NV_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 24, + "name": { + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs", + "value": "Standard NV Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_NV_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard NV Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_NV_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard NV Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_NV_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard NV Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Quota/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Quota/update.json new file mode 100644 index 000000000000..669f01c82d19 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Quota/update.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2021-07-01", + "parameters": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 100, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 200, + "unit": "Count" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 100, + "unit": "Count", + "status": "Success" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 200, + "unit": "Count", + "status": "Success" + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Usage/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Usage/list.json new file mode 100644 index 000000000000..cdd29efeb5d4 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Usage/list.json @@ -0,0 +1,400 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages", + "type": "Microsoft.MachineLearningServices/totalCores/usages", + "currentValue": 7, + "limit": 100, + "name": { + "localizedValue": "Clusters", + "value": "Clusters" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages", + "type": "Microsoft.MachineLearningServices/dedicatedCores/usages", + "currentValue": 14, + "limit": 24, + "name": { + "localizedValue": "Total Cluster Dedicated Regional vCPUs", + "value": "Total Cluster Dedicated Regional vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_D_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 48, + "name": { + "localizedValue": "Standard D Family Cluster Dedicated vCPUs", + "value": "Standard D Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 2, + "limit": 24, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/usages/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/usages", + "currentValue": 2, + "limit": 24, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/computes/demo_cluster1_dsv2/usages/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/computes/usages", + "currentValue": 2, + "limit": 24, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/computes/demo_cluster2_dsv2/usages/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/computes/usages", + "currentValue": 0, + "limit": 24, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_Dv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 24, + "name": { + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs", + "value": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_FSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 24, + "name": { + "value": "Standard FSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 12, + "limit": 24, + "name": { + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs", + "value": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/usages/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/usages", + "currentValue": 6, + "limit": 24, + "name": { + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs", + "value": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/computes/demo_cluster1_nc/usages/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/computes/usages", + "currentValue": 6, + "limit": 24, + "name": { + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs", + "value": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/usages/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/usages", + "currentValue": 6, + "limit": 24, + "name": { + "value": "Standard NC Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/computes/demo_cluser1_nc/usages/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/computes/usages", + "currentValue": 6, + "limit": 24, + "name": { + "value": "Standard NC Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NCv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 0, + "name": { + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs", + "value": "Standard NCv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NCv3_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 0, + "name": { + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs", + "value": "Standard NCv3 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_ND_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 0, + "name": { + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs", + "value": "Standard ND Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NDv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 0, + "name": { + "value": "Standard NDv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NV_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 24, + "name": { + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs", + "value": "Standard NV Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages", + "type": "Microsoft.MachineLearningServices/lowPriorityCores/usages", + "currentValue": 18, + "limit": 50, + "name": { + "localizedValue": "Total Cluster LowPriority Regional vCPUs", + "value": "Total Cluster LowPriority Regional vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_D_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "value": "Standard D Family Cluster LowPriority vCPUs", + "localizedValue": "Standard D Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_DSv2_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard DSv2 Family Cluster LowPriority vCPUs", + "value": "Standard DSv2 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_Dv2_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard Dv2 Family Cluster LowPriority vCPUs", + "value": "Standard Dv2 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_FSv2_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard FSv2 Family Cluster LowPriority vCPUs", + "value": "Standard FSv2 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 18, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/usages", + "currentValue": 6, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/computes/demo_cluster1_lowPriority_nc/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/computes/usages", + "currentValue": 6, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/usages", + "currentValue": 12, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/computes/demo_cluster2_lowPriority_nc/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/computes/usages", + "currentValue": 6, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/computes/demo_cluster3_lowPriority_nc/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/computes/usages", + "currentValue": 6, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NCv2_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard NCv2 Family Cluster LowPriority vCPUs", + "value": "Standard NCv2 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NCv3_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard NCv3 Family Cluster LowPriority vCPUs", + "value": "Standard NCv3 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_ND_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard ND Family Cluster LowPriority vCPUs", + "value": "Standard ND Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NDv2_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard NDv2 Family Cluster LowPriority vCPUs", + "value": "Standard NDv2 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NV_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard NV Family Cluster LowPriority vCPUs", + "value": "Standard NV Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/VirtualMachineSize/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/VirtualMachineSize/list.json new file mode 100644 index 000000000000..f4d7b56926ca --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/VirtualMachineSize/list.json @@ -0,0 +1,388 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "api-version": "2021-07-01", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Standard_DS1_v2", + "family": "standardDSv2Family", + "vCPUs": 1, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 7168, + "memoryGB": 3.5, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.13, + "osType": "Windows", + "vmTier": "Standard" + }, + { + "retailPrice": 0.01, + "osType": "Linux", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.07, + "osType": "Linux", + "vmTier": "Standard" + }, + { + "retailPrice": 0.05, + "osType": "Windows", + "vmTier": "LowPriority" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] + }, + { + "name": "Standard_DS2_v2", + "family": "standardDSv2Family", + "vCPUs": 2, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 14336, + "memoryGB": 7.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.03, + "osType": "Linux", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.15, + "osType": "Linux", + "vmTier": "Standard" + }, + { + "retailPrice": 0.1, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.25, + "osType": "Windows", + "vmTier": "Standard" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance", + "MIR" + ] + }, + { + "name": "Standard_DS3_v2", + "family": "standardDSv2Family", + "vCPUs": 4, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 28672, + "memoryGB": 14.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.2, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.06, + "osType": "Linux", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.5, + "osType": "Windows", + "vmTier": "Standard" + }, + { + "retailPrice": 0.29, + "osType": "Linux", + "vmTier": "Standard" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance", + "MIR" + ] + }, + { + "name": "Standard_DS4_v2", + "family": "standardDSv2Family", + "vCPUs": 8, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 57344, + "memoryGB": 28.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.12, + "osType": "Linux", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.4, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 1.01, + "osType": "Windows", + "vmTier": "Standard" + }, + { + "retailPrice": 0.58, + "osType": "Linux", + "vmTier": "Standard" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance", + "MIR" + ] + }, + { + "name": "Standard_DS5_v2", + "family": "standardDSv2Family", + "vCPUs": 16, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 114688, + "memoryGB": 56.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 1.17, + "osType": "Linux", + "vmTier": "Standard" + }, + { + "retailPrice": 0.81, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 2.02, + "osType": "Windows", + "vmTier": "Standard" + }, + { + "retailPrice": 0.23, + "osType": "Linux", + "vmTier": "LowPriority" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance", + "MIR" + ] + }, + { + "name": "Standard_DS11_v2", + "family": "standardDSv2Family", + "vCPUs": 2, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 28672, + "memoryGB": 14.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.26, + "osType": "Windows", + "vmTier": "Standard" + }, + { + "retailPrice": 0.18, + "osType": "Linux", + "vmTier": "Standard" + }, + { + "retailPrice": 0.11, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.04, + "osType": "Linux", + "vmTier": "LowPriority" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] + }, + { + "name": "Standard_DS12_v2", + "family": "standardDSv2Family", + "vCPUs": 4, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 57344, + "memoryGB": 28.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.37, + "osType": "Linux", + "vmTier": "Standard" + }, + { + "retailPrice": 0.53, + "osType": "Windows", + "vmTier": "Standard" + }, + { + "retailPrice": 0.21, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.07, + "osType": "Linux", + "vmTier": "LowPriority" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] + }, + { + "name": "Standard_DS13_v2", + "family": "standardDSv2Family", + "vCPUs": 8, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 114688, + "memoryGB": 56.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.15, + "osType": "Linux", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.42, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 0.74, + "osType": "Linux", + "vmTier": "Standard" + }, + { + "retailPrice": 1.06, + "osType": "Windows", + "vmTier": "Standard" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] + }, + { + "name": "Standard_DS14_v2", + "family": "standardDSv2Family", + "vCPUs": 16, + "gpus": 0, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 229376, + "memoryGB": 112.0, + "lowPriorityCapable": true, + "premiumIO": true, + "estimatedVMPrices": { + "billingCurrency": "USD", + "unitOfMeasure": "OneHour", + "values": [ + { + "retailPrice": 0.3, + "osType": "Linux", + "vmTier": "LowPriority" + }, + { + "retailPrice": 1.48, + "osType": "Linux", + "vmTier": "Standard" + }, + { + "retailPrice": 0.84, + "osType": "Windows", + "vmTier": "LowPriority" + }, + { + "retailPrice": 2.11, + "osType": "Windows", + "vmTier": "Standard" + } + ] + }, + "supportedComputeTypes": [ + "AmlCompute", + "ComputeInstance" + ] + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/create.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/create.json new file mode 100644 index 000000000000..ca0db7b5834e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/create.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2021-07-01", + "parameters": { + "location": "eastus2euap", + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuai": {} + } + }, + "properties": { + "friendlyName": "HelloName", + "description": "test description", + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "encryption": { + "status": "Enabled", + "identity": { + "userAssignedIdentity": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuai" + }, + "keyVaultProperties": { + "keyVaultArmId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "keyIdentifier": "https://testkv.vault.azure.net/keys/testkey/aabbccddee112233445566778899aabb", + "identityClientId": "" + } + }, + "hbiWorkspace": false, + "sharedPrivateLinkResources": [ + { + "name": "testdbresource", + "properties": { + "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.DocumentDB/databaseAccounts/testdbresource/privateLinkResources/Sql", + "groupId": "Sql", + "requestMessage": "Please approve", + "status": "Approved" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "identity": { + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuai": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "friendlyName": "HelloName", + "description": "test description", + "encryption": { + "status": "Enabled", + "identity": { + "userAssignedIdentity": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuai" + }, + "keyVaultProperties": { + "keyVaultArmId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "keyIdentifier": "https://testkv.vault.azure.net/keys/testkey/aabbccddee112233445566778899aabb", + "identityClientId": "" + } + }, + "hbiWorkspace": false, + "allowPublicAccessWhenBehindVnet": false, + "publicNetworkAccess": "Disabled", + "sharedPrivateLinkResources": [ + { + "name": "testdbresource", + "properties": { + "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.DocumentDB/databaseAccounts/testdbresource/privateLinkResources/Sql", + "groupId": "Sql", + "requestMessage": "Please approve", + "status": "Approved" + } + } + ] + } + } + }, + "202": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/delete.json new file mode 100644 index 000000000000..c042b38277bd --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2021-07-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/diagnose.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/diagnose.json new file mode 100644 index 000000000000..c2a838aab424 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/diagnose.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2021-07-01", + "parameters": { + "value": { + "udr": {}, + "nsg": {}, + "resourceLock": {}, + "dnsResolution": {}, + "storageAccount": {}, + "keyVault": {}, + "containerRegistry": {}, + "applicationInsights": {}, + "others": {} + } + } + }, + "responses": { + "200": { + "body": { + "value": { + "userDefinedRouteResults": [], + "networkSecurityRuleResults": [], + "resourceLockResults": [], + "dnsResolutionResults": [ + { + "code": "CustomDNSInUse", + "level": "Warning", + "message": "We have detected an on-premise dns server is configured. Please make sure conditional forwarding is configured correctly according to doc https://foo" + } + ], + "storageAccountResults": [], + "keyVaultResults": [], + "containerRegistryResults": [], + "applicationInsightsResults": [], + "otherResults": [] + } + } + }, + "202": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/get.json new file mode 100644 index 000000000000..5fdd566b54b6 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/get.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "identity": { + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuai": { + "principalId": "00000000-1111-2222-3333-444444444444", + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444" + } + } + }, + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "friendlyName": "HelloName", + "description": "test description", + "encryption": { + "status": "Enabled", + "identity": { + "userAssignedIdentity": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testuai" + }, + "keyVaultProperties": { + "keyVaultArmId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "keyIdentifier": "https://testkv.vault.azure.net/keys/testkey/aabbccddee112233445566778899aabb", + "identityClientId": "" + } + }, + "hbiWorkspace": false, + "serviceProvisionedResourceGroup": "testworkspace_0000111122223333", + "privateLinkCount": 0, + "allowPublicAccessWhenBehindVnet": false, + "publicNetworkAccess": "Disabled", + "imageBuildCompute": "testcompute", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/testprivatelinkconnection", + "name": "testprivatelinkconnection", + "type": "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ], + "sharedPrivateLinkResources": [ + { + "name": "testcosmosdbresource", + "properties": { + "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.DocumentDB/databaseAccounts/testcosmosdbresource/privateLinkResources/Sql", + "groupId": "Sql", + "requestMessage": "Please approve", + "status": "Approved" + } + } + ] + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/listByResourceGroup.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/listByResourceGroup.json new file mode 100644 index 000000000000..ddee8f105a76 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/listByResourceGroup.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "friendlyName": "HelloName", + "description": "test description" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace1", + "name": "testworkspace1", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistryNew", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkvNew", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccountOld", + "discoveryUrl": "http://example.com", + "friendlyName": "HelloName 1", + "description": "test description" + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/listBySubscription.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/listBySubscription.json new file mode 100644 index 000000000000..d903527db353 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/listBySubscription.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "friendlyName": "HelloName", + "description": "test description" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-5678/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistryNew", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkvNew", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccountOld", + "discoveryUrl": "http://example.com", + "friendlyName": "HelloName", + "description": "test description" + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/listKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/listKeys.json new file mode 100644 index 000000000000..e4459a79f7da --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/listKeys.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "body": { + "userStorageKey": null, + "userStorageResourceId": "/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/ragargeastus2euap/providers/Microsoft.Storage/storageAccounts/testdemoworkazashomr", + "appInsightsInstrumentationKey": null, + "containerRegistryCredentials": { + "location": null, + "username": "testdemoworkjmjmeykp", + "passwords": [ + { + "name": "password", + "value": "" + }, + { + "name": "password2", + "value": "0KARRQoQHSUq1yViPWg7YFernOS=Ic/t" + } + ] + }, + "notebookAccessKeys": { + "primaryAccessKey": null, + "secondaryAccessKey": null + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/listNotebookAccessToken.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/listNotebookAccessToken.json new file mode 100644 index 000000000000..28a0fdb63450 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/listNotebookAccessToken.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "body": { + "notebookResourceId": "94350843095843059", + "hostName": "Host product name", + "publicDns": "resource.notebooks.azure.net", + "tokenType": "Bearer", + "expiresIn": 28800.0, + "scope": "aznb_identity" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/listStorageAccountKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/listStorageAccountKeys.json new file mode 100644 index 000000000000..a03c0eb31d98 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/listStorageAccountKeys.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "body": { + "userStorageKey": null + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/resyncKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/resyncKeys.json new file mode 100644 index 000000000000..774ba026b870 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/resyncKeys.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2021-07-01" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/update.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/update.json new file mode 100644 index 000000000000..b278f987068b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/Workspace/update.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2021-07-01", + "parameters": { + "properties": { + "friendlyName": "New friendly name", + "description": "new description", + "publicNetworkAccess": "Disabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "identity": { + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "type": "SystemAssigned" + }, + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "friendlyName": "New friendly name", + "description": "new description", + "publicNetworkAccess": "Disabled" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/WorkspaceConnection/create.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/WorkspaceConnection/create.json new file mode 100644 index 000000000000..c1df092c9e30 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/WorkspaceConnection/create.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "workspaceName": "workspace-1", + "connectionName": "connection-1", + "api-version": "2021-07-01", + "parameters": { + "properties": { + "category": "ACR", + "target": "www.facebook.com", + "authType": "PAT", + "value": "secrets" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/connections/connection-1", + "name": "connection-1", + "type": "Microsoft.MachineLearningServices/workspaces/connections", + "properties": { + "category": "ACR", + "target": "www.facebook.com", + "authType": "PAT", + "value": "secrets" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/WorkspaceConnection/delete.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/WorkspaceConnection/delete.json new file mode 100644 index 000000000000..34cee2db7fe6 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/WorkspaceConnection/delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "workspaceName": "workspace-1", + "connectionName": "connection-1", + "api-version": "2021-07-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/WorkspaceConnection/get.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/WorkspaceConnection/get.json new file mode 100644 index 000000000000..27dc5e29e5f2 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/WorkspaceConnection/get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "workspaceName": "workspace-1", + "connectionName": "connection-1", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/connections/connection-1", + "name": "connection-1", + "type": "Microsoft.MachineLearningServices/workspaces/connections", + "properties": { + "category": "ACR", + "target": "www.facebook.com", + "authType": "PAT", + "value": "secrets" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/WorkspaceConnection/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/WorkspaceConnection/list.json new file mode 100644 index 000000000000..82869701c230 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/WorkspaceConnection/list.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "workspaceName": "workspace-1", + "api-version": "2021-07-01", + "target": "www.facebook.com", + "category": "ACR" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/linkedWorkspaces/connection-1", + "name": "connection-1", + "type": "Microsoft.MachineLearningServices/workspaces/connections", + "properties": { + "category": "ACR", + "target": "www.facebook.com", + "authType": "PAT", + "value": "secrets" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/linkedWorkspaces/connection-2", + "name": "connection-2", + "type": "Microsoft.MachineLearningServices/workspaces/connections", + "properties": { + "category": "ACR", + "target": "www.facebook.com", + "authType": "PAT", + "value": "secrets" + } + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/WorkspaceFeature/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/WorkspaceFeature/list.json new file mode 100644 index 000000000000..fc6ba633a28b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/WorkspaceFeature/list.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "testworkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "automatedml_createeditexperimentsui", + "displayName": "Create edit experiments UI", + "description": "Create, edit or delete AutoML experiments in the SDK" + }, + { + "id": "workspace_upgradeworkspaceui", + "displayName": "Upgrade workspace UI", + "description": "Upgrade workspace from Basic to enterprise from the UI" + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/WorkspaceSku/list.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/WorkspaceSku/list.json new file mode 100644 index 000000000000..2ee3416b711b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/examples/WorkspaceSku/list.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "workspaces", + "name": "Basic", + "tier": "Basic", + "locations": [ + "westus" + ], + "locationInfo": [ + { + "location": "westus", + "zones": [ + "westus-AZ02", + "westus-AZ01" + ] + } + ], + "capabilities": [ + { + "name": "automatedml_readhyperdrivesdk", + "value": "{\n \"id\": \"automatedml_ readhyperdrivesdk\",\n \"name\": \"Read hyperdrive SDK\",\n \"description\": \"Read only access to Hyperdrive in the SDK\"\n}" + }, + { + "name": "workspace_upgradeworkspacesdk", + "value": "{\n \"id\": \"workspace_upgradeworkspacesdk\",\n \"name\": \"Upgrade workspace SDK\",\n \"description\": \"Upgrade workspace from Basic to enterprise from the SDK\"\n}" + } + ], + "restrictions": [] + }, + { + "resourceType": "workspaces", + "name": "Enterprise", + "tier": "Enterprise", + "locations": [ + "westus" + ], + "locationInfo": [ + { + "location": "westus", + "zones": [ + "westus-AZ01" + ], + "zoneDetails": [ + { + "name": [ + "westus-AZ01" + ], + "capabilities": [ + { + "name": "automatedml_createeditexperimentssdk", + "value": "{\n \"id\": \"automatedml_createeditexperimentssdk\",\n \"name\": \"Create edit experiments SDK\",\n \"description\": \"Create, edit or delete AutoML experiments in the SDK\"\n}" + } + ] + } + ] + } + ], + "capabilities": [ + { + "name": "automatedml_createeditexperimentssdk", + "value": "{\n \"id\": \"automatedml_createeditexperimentssdk\",\n \"name\": \"Create edit experiments SDK\",\n \"description\": \"Create, edit or delete AutoML experiments in the SDK\"\n}" + } + ], + "restrictions": [] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/machineLearningServices.json new file mode 100644 index 000000000000..85c1831db462 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/machineLearningServices.json @@ -0,0 +1,5077 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Machine Learning Workspaces", + "description": "These APIs allow end users to operate on Azure Machine Learning Workspace resources.", + "version": "2021-07-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.MachineLearningServices/operations": { + "get": { + "tags": [ + "Operation" + ], + "description": "Lists all of the available Azure Machine Learning Workspaces REST API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Gets the properties of the specified machine learning workspace.", + "operationId": "Workspaces_Get", + "x-ms-examples": { + "Get Workspace": { + "$ref": "./examples/Workspace/get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Workspaces" + ], + "description": "Creates or updates a workspace with the specified parameters.", + "operationId": "Workspaces_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create Workspace": { + "$ref": "./examples/Workspace/create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The parameters for creating or updating a machine learning workspace.", + "required": true, + "schema": { + "$ref": "#/definitions/Workspace" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "202": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Workspaces" + ], + "description": "Deletes a machine learning workspace.", + "operationId": "Workspaces_Delete", + "x-ms-examples": { + "Delete Workspace": { + "$ref": "./examples/Workspace/delete.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "The request was accepted; the request was well-formed and received properly." + }, + "204": { + "description": "The machine learning workspace does not exist in the subscription." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Workspaces" + ], + "description": "Updates a machine learning workspace with the specified parameters.", + "operationId": "Workspaces_Update", + "x-ms-examples": { + "Update Workspace": { + "$ref": "./examples/Workspace/update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The parameters for updating a machine learning workspace.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspaceUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Lists all the available machine learning workspaces under the specified resource group.", + "operationId": "Workspaces_ListByResourceGroup", + "x-ms-examples": { + "Get Workspaces by Resource Group": { + "$ref": "./examples/Workspace/listByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/diagnose": { + "post": { + "tags": [ + "Workspaces" + ], + "summary": "Diagnose workspace setup issue.", + "operationId": "Workspaces_Diagnose", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The parameter of diagnosing workspace health", + "schema": { + "$ref": "#/definitions/DiagnoseWorkspaceParameters" + } + } + ], + "responses": { + "202": { + "description": "Success", + "headers": { + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + }, + "Retry-After": { + "description": "Duration the client should wait between requests, in seconds.", + "type": "integer", + "format": "int32", + "maximum": 600, + "minimum": 10 + } + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DiagnoseResponseResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Diagnose Workspace": { + "$ref": "./examples/Workspace/diagnose.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listKeys": { + "post": { + "tags": [ + "Workspaces" + ], + "description": "Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry", + "operationId": "Workspaces_ListKeys", + "x-ms-examples": { + "List Workspace Keys": { + "$ref": "./examples/Workspace/listKeys.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ListWorkspaceKeysResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/resyncKeys": { + "post": { + "tags": [ + "Workspaces" + ], + "description": "Resync all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry", + "operationId": "Workspaces_ResyncKeys", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Resync Workspace Keys": { + "$ref": "./examples/Workspace/resyncKeys.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "The request was accepted; the request was well-formed and received properly." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/usages": { + "get": { + "tags": [ + "Usage" + ], + "operationId": "Usages_List", + "description": "Gets the current usage information as well as limits for AML resources for given subscription and location.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which resource usage is queried.", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListUsagesResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Usages": { + "$ref": "./examples/Usage/list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/vmSizes": { + "get": { + "tags": [ + "VirtualMachineSizes" + ], + "operationId": "VirtualMachineSizes_List", + "description": "Returns supported VM Sizes in a location", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which virtual-machine-sizes is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + } + }, + "x-ms-examples": { + "List VM Sizes": { + "$ref": "./examples/VirtualMachineSize/list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/updateQuotas": { + "post": { + "tags": [ + "Quota" + ], + "operationId": "Quotas_Update", + "description": "Update quota for each VM family in workspace.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for update quota is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/QuotaUpdateParameters" + }, + "description": "Quota update parameters." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful.", + "schema": { + "$ref": "#/definitions/UpdateWorkspaceQuotasResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "update quotas": { + "$ref": "./examples/Quota/update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/quotas": { + "get": { + "tags": [ + "Quota" + ], + "operationId": "Quotas_List", + "description": "Gets the currently assigned Workspace Quotas based on VMFamily.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which resource usage is queried.", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListWorkspaceQuotas" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List workspace quotas by VMFamily": { + "$ref": "./examples/Quota/list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Lists all the available machine learning workspaces under the specified subscription.", + "operationId": "Workspaces_ListBySubscription", + "x-ms-examples": { + "Get Workspaces by subscription": { + "$ref": "./examples/Workspace/listBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes": { + "get": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "operationId": "Compute_List", + "description": "Gets computes in specified workspace.", + "x-ms-examples": { + "Get Computes": { + "$ref": "./examples/Compute/list.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "The response includes a paginated array of Machine Learning computes and a URI to the next set of results, if any. For the more information the limits of the number of items in a resource group, see https://azure.microsoft.com/en-us/documentation/articles/azure-subscription-service-limits/.", + "schema": { + "$ref": "#/definitions/PaginatedComputeResourcesList" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}": { + "get": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_Get", + "description": "Gets compute definition by its name. Any secrets (storage keys, service credentials, etc) are not returned - use 'keys' nested resource to get them.", + "x-ms-examples": { + "Get a AKS Compute": { + "$ref": "./examples/Compute/get/AKSCompute.json" + }, + "Get a AML Compute": { + "$ref": "./examples/Compute/get/AmlCompute.json" + }, + "Get an ComputeInstance": { + "$ref": "./examples/Compute/get/ComputeInstance.json" + }, + "Get a Kubernetes Compute": { + "$ref": "./examples/Compute/get/KubernetesCompute.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_CreateOrUpdate", + "description": "Creates or updates compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation. If your intent is to create a new compute, do a GET first to verify that it does not exist yet.", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a AML Compute": { + "$ref": "./examples/Compute/createOrUpdate/BasicAmlCompute.json" + }, + "Create an ComputeInstance Compute with minimal inputs": { + "$ref": "./examples/Compute/createOrUpdate/ComputeInstanceMinimal.json" + }, + "Create an ComputeInstance Compute": { + "$ref": "./examples/Compute/createOrUpdate/ComputeInstance.json" + }, + "Create an AKS Compute": { + "$ref": "./examples/Compute/createOrUpdate/BasicAKSCompute.json" + }, + "Create a DataFactory Compute": { + "$ref": "./examples/Compute/createOrUpdate/BasicDataFactoryCompute.json" + }, + "Update a AML Compute": { + "$ref": "./examples/Compute/createOrUpdate/AmlCompute.json" + }, + "Update an AKS Compute": { + "$ref": "./examples/Compute/createOrUpdate/AKSCompute.json" + }, + "Attach a Kubernetes Compute": { + "$ref": "./examples/Compute/createOrUpdate/KubernetesCompute.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ComputeDefinitionParameter" + } + ], + "responses": { + "200": { + "description": "Compute creation or update initiated.", + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "201": { + "description": "Compute creation or update initiated.", + "headers": { + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_Update", + "description": "Updates properties of a compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation.", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a AmlCompute Compute": { + "$ref": "./examples/Compute/patch.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterUpdateParameters" + }, + "description": "Additional parameters for cluster update." + } + ], + "responses": { + "200": { + "description": "Compute update initiated.", + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_Delete", + "description": "Deletes specified Machine Learning compute.", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Compute": { + "$ref": "./examples/Compute/delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/UnderlyingResourceActionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "Compute deletion initiated.", + "headers": { + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/listNodes": { + "post": { + "tags": [ + "MachineLearningComputes" + ], + "operationId": "Compute_ListNodes", + "description": "Get the details (e.g IP address, port etc) of all the compute nodes in the compute.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the list of IP addresses.", + "schema": { + "$ref": "#/definitions/AmlComputeNodesInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "nodes" + }, + "x-ms-examples": { + "Get compute nodes information for a compute": { + "$ref": "./examples/Compute/listNodes.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listNotebookAccessToken": { + "post": { + "tags": [ + "Workspaces" + ], + "description": "return notebook access token and refresh token", + "operationId": "Workspaces_ListNotebookAccessToken", + "x-ms-examples": { + "List Workspace Keys": { + "$ref": "./examples/Workspace/listNotebookAccessToken.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/NotebookAccessTokenResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/listKeys": { + "post": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_ListKeys", + "description": "Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).", + "x-ms-examples": { + "List AKS Compute Keys": { + "$ref": "./examples/Compute/listKeys.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/ComputeSecrets" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/start": { + "post": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_Start", + "description": "Posts a start action to a compute instance", + "x-ms-examples": { + "Start ComputeInstance Compute": { + "$ref": "./examples/Compute/start.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Success." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/stop": { + "post": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_Stop", + "description": "Posts a stop action to a compute instance", + "x-ms-examples": { + "Stop ComputeInstance Compute": { + "$ref": "./examples/Compute/stop.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Success." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/restart": { + "post": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "Compute_Restart", + "description": "Posts a restart action to a compute instance", + "x-ms-examples": { + "Restart ComputeInstance Compute": { + "$ref": "./examples/Compute/restart.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Success." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "description": "List all the private endpoint connections associated with the workspace.", + "x-ms-examples": { + "StorageAccountListPrivateEndpointConnections": { + "$ref": "./examples/PrivateEndpointConnection/list.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Successfully retrieved private endpoint connections.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "description": "Gets the specified private endpoint connection associated with the workspace.", + "x-ms-examples": { + "WorkspaceGetPrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the private endpoint connection properties successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "description": "Update the state of specified private endpoint connection associated with the workspace.", + "x-ms-examples": { + "WorkspacePutPrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/createOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The private endpoint connection properties." + } + ], + "responses": { + "200": { + "description": "OK -- Update the private endpoint connection properties successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "description": "Deletes the specified private endpoint connection associated with the workspace.", + "x-ms-examples": { + "WorkspaceDeletePrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Delete the private endpoint connection successfully." + }, + "204": { + "description": "No Content -- The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateLinkResources": { + "get": { + "tags": [ + "WorkspacePrivateLinkResources" + ], + "operationId": "PrivateLinkResources_List", + "description": "Gets the private link resources that need to be created for a workspace.", + "x-ms-examples": { + "WorkspaceListPrivateLinkResources": { + "$ref": "./examples/PrivateLinkResource/list.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/prepareNotebook": { + "post": { + "tags": [ + "ProxyOperations" + ], + "operationId": "Workspaces_PrepareNotebook", + "description": "Prepare a notebook.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Prepare Notebook": { + "$ref": "./examples/Notebook/prepare.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NotebookResourceInfo" + } + }, + "202": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listStorageAccountKeys": { + "post": { + "tags": [ + "ProxyOperations" + ], + "operationId": "Workspaces_ListStorageAccountKeys", + "description": "List storage account keys of a workspace.", + "x-ms-examples": { + "List Workspace Keys": { + "$ref": "./examples/Workspace/listStorageAccountKeys.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ListStorageAccountKeysResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listNotebookKeys": { + "post": { + "tags": [ + "ProxyOperations" + ], + "operationId": "Workspaces_ListNotebookKeys", + "description": "List keys of a notebook.", + "x-ms-examples": { + "List Workspace Keys": { + "$ref": "./examples/Notebook/listKeys.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ListNotebookKeysResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections": { + "get": { + "tags": [ + "WorkspaceConnections" + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "ListWorkspaceConnections": { + "$ref": "./examples/WorkspaceConnection/list.json" + } + }, + "operationId": "WorkspaceConnections_List", + "description": "List all connections under a AML workspace.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TargetParameter" + }, + { + "$ref": "#/parameters/CategoryParameter" + } + ], + "responses": { + "200": { + "description": "The response includes a paginated array of Workspace connections and a URI to the next set of results, if any. For the more information the limits of the number of items in a resource group, see https://azure.microsoft.com/en-us/documentation/articles/azure-subscription-service-limits/.", + "schema": { + "$ref": "#/definitions/PaginatedWorkspaceConnectionsList" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}": { + "put": { + "tags": [ + "WorkspaceConnections" + ], + "operationId": "WorkspaceConnections_Create", + "description": "Add a new workspace connection.", + "x-ms-examples": { + "CreateWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The object for creating or updating a new workspace connection", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspaceConnection" + } + } + ], + "responses": { + "200": { + "description": "Successfully created the workspace connection.", + "schema": { + "$ref": "#/definitions/WorkspaceConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "WorkspaceConnections" + ], + "operationId": "WorkspaceConnections_Get", + "description": "Get the detail of a workspace connection.", + "x-ms-examples": { + "GetWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the detail of the linked workspace.", + "schema": { + "$ref": "#/definitions/WorkspaceConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WorkspaceConnections" + ], + "operationId": "WorkspaceConnections_Delete", + "description": "Delete a workspace connection.", + "x-ms-examples": { + "DeleteWorkspaceConnection": { + "$ref": "./examples/WorkspaceConnection/delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the workspace connection." + }, + "204": { + "description": "Specific workspace connection not found." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/outboundNetworkDependenciesEndpoints": { + "get": { + "tags": [ + "OutboundNetworkDependenciesEndpoints" + ], + "summary": "Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically.", + "operationId": "Workspaces_ListOutboundNetworkDependenciesEndpoints", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ExternalFQDNResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListOutboundNetworkDependenciesEndpoints": { + "$ref": "./examples/ExternalFQDN/get.json" + } + } + } + } + }, + "parameters": { + "WorkspaceNameParameter": { + "name": "workspaceName", + "description": "Name of Azure Machine Learning workspace.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "ComputeNameParameter": { + "name": "computeName", + "description": "Name of the Azure Machine Learning compute.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "AsyncOperationIdParameter": { + "name": "asyncOperationId", + "description": "Identifier of an asynchronous Azure Machine Learning compute operation.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "name": "location", + "description": "The name of the Azure location/region.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "PaginationParameter": { + "in": "query", + "name": "$skip", + "type": "string", + "description": "Continuation token for pagination.", + "required": false, + "x-ms-parameter-location": "method" + }, + "ComputeDefinitionParameter": { + "in": "body", + "name": "parameters", + "description": "Payload with Machine Learning compute definition.", + "required": true, + "schema": { + "$ref": "#/definitions/ComputeResource" + }, + "x-ms-parameter-location": "method" + }, + "ComputeTypeParameter": { + "in": "query", + "name": "compute-type", + "type": "string", + "description": "Type of compute to filter by.", + "required": false, + "x-ms-parameter-location": "method" + }, + "UnderlyingResourceActionParameter": { + "in": "query", + "name": "underlyingResourceAction", + "type": "string", + "description": "Delete the underlying compute if 'Delete', or detach the underlying compute from workspace if 'Detach'.", + "required": true, + "enum": [ + "Delete", + "Detach" + ], + "x-ms-enum": { + "name": "UnderlyingResourceAction", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + }, + "PrivateEndpointConnectionName": { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection associated with the workspace", + "x-ms-parameter-location": "method" + }, + "ConnectionName": { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "Friendly name of the workspace connection", + "x-ms-parameter-location": "method" + }, + "TargetParameter": { + "in": "query", + "name": "target", + "type": "string", + "description": "Target of the workspace connection.", + "required": false, + "x-ms-parameter-location": "method" + }, + "CategoryParameter": { + "in": "query", + "name": "category", + "type": "string", + "description": "Category of the workspace connection.", + "required": false, + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "Operation": { + "description": "Azure Machine Learning workspace REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "Display name of operation", + "properties": { + "provider": { + "description": "The resource provider name: Microsoft.MachineLearningExperimentation", + "type": "string" + }, + "resource": { + "description": "The resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "The operation that users can perform.", + "type": "string" + }, + "description": { + "description": "The description for the operation.", + "type": "string" + } + } + } + } + }, + "OperationListResult": { + "description": "An array of operations supported by the resource provider.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of AML workspace operations supported by the AML workspace resource provider." + } + } + }, + "Workspace": { + "type": "object", + "description": "An object that represents a machine learning workspace.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/WorkspaceProperties", + "description": "The properties of the machine learning workspace.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the resource." + }, + "location": { + "description": "Specifies the location of the resource.", + "type": "string" + }, + "tags": { + "description": "Contains resource tags defined as key/value pairs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku of the workspace." + }, + "systemData": { + "description": "System data", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + } + }, + "WorkspaceProperties": { + "type": "object", + "description": "The properties of a machine learning workspace.", + "properties": { + "workspaceId": { + "description": "The immutable id associated with this workspace.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The description of this workspace.", + "type": "string" + }, + "friendlyName": { + "description": "The friendly name for this workspace. This name in mutable", + "type": "string" + }, + "keyVault": { + "description": "ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created", + "type": "string" + }, + "applicationInsights": { + "description": "ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created", + "type": "string" + }, + "containerRegistry": { + "description": "ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created", + "type": "string", + "x-nullable": true + }, + "storageAccount": { + "description": "ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created", + "type": "string" + }, + "discoveryUrl": { + "description": "Url for the discovery service to identify regional endpoints for machine learning experimentation services", + "type": "string" + }, + "provisioningState": { + "type": "string", + "enum": [ + "Unknown", + "Updating", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true, + "description": "The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning." + }, + "encryption": { + "$ref": "#/definitions/EncryptionProperty", + "description": "The encryption settings of Azure ML workspace." + }, + "hbiWorkspace": { + "type": "boolean", + "description": "The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service", + "default": false + }, + "serviceProvisionedResourceGroup": { + "type": "string", + "description": "The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace", + "readOnly": true + }, + "privateLinkCount": { + "type": "integer", + "format": "int32", + "description": "Count of private connections in the workspace", + "readOnly": true + }, + "imageBuildCompute": { + "description": "The compute name for image build", + "type": "string" + }, + "allowPublicAccessWhenBehindVnet": { + "type": "boolean", + "description": "The flag to indicate whether to allow public access when behind VNet.", + "default": false + }, + "publicNetworkAccess": { + "type": "string", + "description": "Whether requests from Public Network are allowed.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "PublicNetworkAccess" + } + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The list of private endpoint connections in the workspace." + }, + "sharedPrivateLinkResources": { + "type": "array", + "items": { + "$ref": "#/definitions/SharedPrivateLinkResource" + }, + "description": "The list of shared private link resources in this workspace." + }, + "notebookInfo": { + "readOnly": true, + "$ref": "#/definitions/NotebookResourceInfo", + "description": "The notebook info of Azure ML workspace." + }, + "serviceManagedResourcesSettings": { + "$ref": "#/definitions/ServiceManagedResourcesSettings", + "description": "The service managed resource settings." + }, + "primaryUserAssignedIdentity": { + "description": "The user assigned identity resource id that represents the workspace identity.", + "type": "string" + }, + "tenantId": { + "description": "The tenant id associated with this workspace.", + "type": "string", + "readOnly": true + }, + "storageHnsEnabled": { + "description": "If the storage associated with the workspace has hierarchical namespace(HNS) enabled.", + "type": "boolean", + "readOnly": true + }, + "mlFlowTrackingUri": { + "description": "The URI associated with this workspace that machine learning flow must point at to set up tracking.", + "type": "string", + "readOnly": true + } + } + }, + "WorkspaceUpdateParameters": { + "description": "The parameters for updating a machine learning workspace.", + "properties": { + "tags": { + "description": "The resource tags for the machine learning workspace.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku of the workspace." + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the resource." + }, + "properties": { + "$ref": "#/definitions/WorkspacePropertiesUpdateParameters", + "description": "The properties that the machine learning workspace will be updated with.", + "x-ms-client-flatten": true + } + } + }, + "WorkspacePropertiesUpdateParameters": { + "description": "The parameters for updating the properties of a machine learning workspace.", + "properties": { + "description": { + "description": "The description of this workspace.", + "type": "string" + }, + "friendlyName": { + "description": "The friendly name for this workspace.", + "type": "string" + }, + "imageBuildCompute": { + "description": "The compute name for image build", + "type": "string" + }, + "serviceManagedResourcesSettings": { + "$ref": "#/definitions/ServiceManagedResourcesSettings", + "description": "The service managed resource settings." + }, + "primaryUserAssignedIdentity": { + "description": "The user assigned identity resource id that represents the workspace identity.", + "type": "string" + }, + "publicNetworkAccess": { + "type": "string", + "description": "Whether requests from Public Network are allowed.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "PublicNetworkAccess" + } + } + } + }, + "UsageName": { + "properties": { + "value": { + "readOnly": true, + "type": "string", + "description": "The name of the resource." + }, + "localizedValue": { + "readOnly": true, + "type": "string", + "description": "The localized name of the resource." + } + }, + "description": "The Usage Names." + }, + "Usage": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource ID." + }, + "amlWorkspaceLocation": { + "readOnly": true, + "type": "string", + "description": "Region of the AML workspace in the id." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource type." + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "An enum describing the unit of usage measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": true + } + }, + "currentValue": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The current usage of the resource." + }, + "limit": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The maximum permitted usage of the resource." + }, + "name": { + "readOnly": true, + "$ref": "#/definitions/UsageName", + "description": "The name of the type of usage." + } + }, + "description": "Describes AML Resource Usage." + }, + "ListUsagesResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "The list of AML resource usages." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page of AML resource usage information. Call ListNext() with this to fetch the next page of AML resource usage information." + } + }, + "description": "The List Usages operation response." + }, + "VirtualMachineSize": { + "properties": { + "name": { + "type": "string", + "title": "Virtual Machine size name", + "description": "The name of the virtual machine size.", + "readOnly": true + }, + "family": { + "type": "string", + "title": "Virtual Machine family name", + "description": "The family name of the virtual machine size.", + "readOnly": true + }, + "vCPUs": { + "type": "integer", + "format": "int32", + "title": "Number of vPUs", + "description": "The number of vCPUs supported by the virtual machine size.", + "readOnly": true + }, + "gpus": { + "type": "integer", + "format": "int32", + "title": "Number of gPUs", + "description": "The number of gPUs supported by the virtual machine size.", + "readOnly": true + }, + "osVhdSizeMB": { + "type": "integer", + "format": "int32", + "title": "OS VHD Disk size", + "description": "The OS VHD disk size, in MB, allowed by the virtual machine size.", + "readOnly": true + }, + "maxResourceVolumeMB": { + "type": "integer", + "format": "int32", + "title": "Resource volume size", + "description": "The resource volume size, in MB, allowed by the virtual machine size.", + "readOnly": true + }, + "memoryGB": { + "type": "number", + "format": "double", + "title": "Memory size", + "description": "The amount of memory, in GB, supported by the virtual machine size.", + "readOnly": true + }, + "lowPriorityCapable": { + "type": "boolean", + "title": "Low priority capable", + "description": "Specifies if the virtual machine size supports low priority VMs.", + "readOnly": true + }, + "premiumIO": { + "type": "boolean", + "title": "Premium IO supported", + "description": "Specifies if the virtual machine size supports premium IO.", + "readOnly": true + }, + "estimatedVMPrices": { + "title": "Estimated VM prices", + "description": "The estimated price information for using a VM.", + "$ref": "#/definitions/EstimatedVMPrices" + }, + "supportedComputeTypes": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Supported Compute Types", + "description": "Specifies the compute types supported by the virtual machine size." + } + }, + "description": "Describes the properties of a VM size." + }, + "EstimatedVMPrices": { + "properties": { + "billingCurrency": { + "type": "string", + "title": "Billing currency", + "description": "Three lettered code specifying the currency of the VM price. Example: USD", + "enum": [ + "USD" + ], + "x-ms-enum": { + "name": "BillingCurrency", + "modelAsString": true + } + }, + "unitOfMeasure": { + "type": "string", + "title": "Unit of time measure", + "description": "The unit of time measurement for the specified VM price. Example: OneHour", + "enum": [ + "OneHour" + ], + "x-ms-enum": { + "name": "UnitOfMeasure", + "modelAsString": true + } + }, + "values": { + "type": "array", + "items": { + "$ref": "#/definitions/EstimatedVMPrice" + }, + "title": "List of estimated VM prices.", + "description": "The list of estimated prices for using a VM of a particular OS type, tier, etc." + } + }, + "required": [ + "billingCurrency", + "unitOfMeasure", + "values" + ], + "description": "The estimated price info for using a VM." + }, + "EstimatedVMPrice": { + "type": "object", + "properties": { + "retailPrice": { + "type": "number", + "format": "double", + "title": "Retail price", + "description": "The price charged for using the VM." + }, + "osType": { + "type": "string", + "title": "OS type", + "description": "Operating system type used by the VM.", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "VMPriceOSType", + "modelAsString": true + } + }, + "vmTier": { + "type": "string", + "title": "VM tier", + "description": "The type of the VM.", + "enum": [ + "Standard", + "LowPriority", + "Spot" + ], + "x-ms-enum": { + "name": "VMTier", + "modelAsString": true + } + } + }, + "required": [ + "retailPrice", + "osType", + "vmTier" + ], + "description": "The estimated price info for using a VM of a particular OS type, tier, etc." + }, + "VirtualMachineSizeListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineSize" + }, + "description": "The list of virtual machine sizes supported by AmlCompute." + } + }, + "description": "The List Virtual Machine size operation response." + }, + "WorkspaceListResult": { + "description": "The result of a request to list machine learning workspaces.", + "properties": { + "value": { + "description": "The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces.", + "type": "array", + "items": { + "$ref": "#/definitions/Workspace" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next list of machine learning workspaces.", + "type": "string" + } + } + }, + "QuotaBaseProperties": { + "properties": { + "id": { + "type": "string", + "description": "Specifies the resource ID." + }, + "type": { + "type": "string", + "description": "Specifies the resource type." + }, + "limit": { + "type": "integer", + "format": "int64", + "title": "Limit.", + "description": "The maximum permitted quota of the resource." + }, + "unit": { + "type": "string", + "description": "An enum describing the unit of quota measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "QuotaUnit", + "modelAsString": true + } + } + }, + "description": "The properties for Quota update or retrieval." + }, + "QuotaUpdateParameters": { + "properties": { + "value": { + "description": "The list for update quota.", + "type": "array", + "items": { + "$ref": "#/definitions/QuotaBaseProperties" + } + }, + "location": { + "description": "Region of workspace quota to be updated.", + "type": "string" + } + }, + "description": "Quota update parameters." + }, + "DiagnoseRequestProperties": { + "type": "object", + "properties": { + "udr": { + "description": "Setting for diagnosing user defined routing", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "nsg": { + "description": "Setting for diagnosing network security group", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "resourceLock": { + "description": "Setting for diagnosing resource lock", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "dnsResolution": { + "description": "Setting for diagnosing dns resolution", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "storageAccount": { + "description": "Setting for diagnosing dependent storage account", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "keyVault": { + "description": "Setting for diagnosing dependent key vault", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "containerRegistry": { + "description": "Setting for diagnosing dependent container registry", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "applicationInsights": { + "description": "Setting for diagnosing dependent application insights", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "others": { + "description": "Setting for diagnosing unclassified category of problems", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + }, + "DiagnoseWorkspaceParameters": { + "type": "object", + "description": "Parameters to diagnose a workspace", + "properties": { + "value": { + "description": "Value of Parameters", + "$ref": "#/definitions/DiagnoseRequestProperties" + } + } + }, + "DiagnoseResult": { + "type": "object", + "description": "Result of Diagnose", + "properties": { + "code": { + "description": "Code for workspace setup error", + "type": "string", + "readOnly": true + }, + "level": { + "description": "Level of workspace setup error", + "enum": [ + "Warning", + "Error", + "Information" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DiagnoseResultLevel", + "modelAsString": true + } + }, + "message": { + "description": "Message of workspace setup error", + "type": "string", + "readOnly": true + } + } + }, + "DiagnoseResponseResult": { + "type": "object", + "properties": { + "value": { + "type": "object", + "properties": { + "userDefinedRouteResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + } + }, + "networkSecurityRuleResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + } + }, + "resourceLockResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + } + }, + "dnsResolutionResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + } + }, + "storageAccountResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + } + }, + "keyVaultResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + } + }, + "containerRegistryResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + } + }, + "applicationInsightsResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + } + }, + "otherResults": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnoseResult" + } + } + } + } + } + }, + "UpdateWorkspaceQuotasResult": { + "properties": { + "value": { + "description": "The list of workspace quota update result.", + "items": { + "$ref": "#/definitions/UpdateWorkspaceQuotas" + }, + "readOnly": true, + "type": "array" + }, + "nextLink": { + "description": "The URI to fetch the next page of workspace quota update result. Call ListNext() with this to fetch the next page of Workspace Quota update result.", + "readOnly": true, + "type": "string" + } + }, + "description": "The result of update workspace quota." + }, + "UpdateWorkspaceQuotas": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource ID." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource type." + }, + "limit": { + "type": "integer", + "format": "int64", + "title": "Limit.", + "description": "The maximum permitted quota of the resource." + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "An enum describing the unit of quota measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "QuotaUnit", + "modelAsString": true + } + }, + "status": { + "type": "string", + "readOnly": false, + "title": "Update Workspace Quota Status.", + "description": "Status of update workspace quota.", + "enum": [ + "Undefined", + "Success", + "Failure", + "InvalidQuotaBelowClusterMinimum", + "InvalidQuotaExceedsSubscriptionLimit", + "InvalidVMFamilyName", + "OperationNotSupportedForSku", + "OperationNotEnabledForRegion" + ], + "x-ms-enum": { + "name": "status", + "modelAsString": true + } + } + }, + "description": "The properties for update Quota response." + }, + "ResourceName": { + "properties": { + "value": { + "readOnly": true, + "type": "string", + "description": "The name of the resource." + }, + "localizedValue": { + "readOnly": true, + "type": "string", + "description": "The localized name of the resource." + } + }, + "description": "The Resource Name." + }, + "ResourceQuota": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource ID." + }, + "amlWorkspaceLocation": { + "readOnly": true, + "type": "string", + "description": "Region of the AML workspace in the id." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource type." + }, + "name": { + "$ref": "#/definitions/ResourceName", + "description": "Name of the resource.", + "readOnly": true + }, + "limit": { + "readOnly": true, + "type": "integer", + "format": "int64", + "title": "Limit.", + "description": "The maximum permitted quota of the resource." + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "An enum describing the unit of quota measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "QuotaUnit", + "modelAsString": true + } + } + }, + "description": "The quota assigned to a resource." + }, + "ListWorkspaceQuotas": { + "properties": { + "value": { + "description": "The list of Workspace Quotas by VM Family", + "items": { + "$ref": "#/definitions/ResourceQuota" + }, + "readOnly": true, + "type": "array" + }, + "nextLink": { + "description": "The URI to fetch the next page of workspace quota information by VM Family. Call ListNext() with this to fetch the next page of Workspace Quota information.", + "readOnly": true, + "type": "string" + } + }, + "description": "The List WorkspaceQuotasByVMFamily operation response." + }, + "Identity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of resource identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID of resource." + }, + "type": { + "type": "string", + "description": "The identity type.", + "enum": [ + "SystemAssigned", + "SystemAssigned,UserAssigned", + "UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "$ref": "#/definitions/UserAssignedIdentities", + "description": "The user assigned identities associated with the resource." + } + }, + "description": "Identity for the resource." + }, + "UserAssignedIdentities": { + "description": "dictionary containing all the user assigned identities, with resourceId of the UAI as key.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + } + }, + "UserAssignedIdentity": { + "description": "User Assigned Identity", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of the user assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID of the user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The clientId(aka appId) of the user assigned identity." + } + } + }, + "ResourceId": { + "properties": { + "id": { + "type": "string", + "description": "The ID of the resource" + } + }, + "required": [ + "id" + ], + "description": "Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.", + "x-ms-azure-resource": true + }, + "ListWorkspaceKeysResult": { + "type": "object", + "properties": { + "userStorageKey": { + "readOnly": true, + "type": "string", + "x-ms-secret": true + }, + "userStorageResourceId": { + "readOnly": true, + "type": "string" + }, + "appInsightsInstrumentationKey": { + "readOnly": true, + "type": "string", + "x-ms-secret": true + }, + "containerRegistryCredentials": { + "readOnly": true, + "$ref": "#/definitions/RegistryListCredentialsResult" + }, + "notebookAccessKeys": { + "readOnly": true, + "$ref": "#/definitions/ListNotebookKeysResult" + } + } + }, + "NotebookAccessTokenResult": { + "type": "object", + "properties": { + "notebookResourceId": { + "readOnly": true, + "type": "string" + }, + "hostName": { + "readOnly": true, + "type": "string" + }, + "publicDns": { + "readOnly": true, + "type": "string" + }, + "accessToken": { + "readOnly": true, + "type": "string", + "x-ms-secret": true + }, + "tokenType": { + "readOnly": true, + "type": "string" + }, + "expiresIn": { + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "refreshToken": { + "readOnly": true, + "type": "string", + "x-ms-secret": true + }, + "scope": { + "readOnly": true, + "type": "string" + } + } + }, + "RegistryListCredentialsResult": { + "type": "object", + "properties": { + "location": { + "readOnly": true, + "type": "string" + }, + "username": { + "readOnly": true, + "type": "string" + }, + "passwords": { + "type": "array", + "items": { + "$ref": "#/definitions/Password" + } + } + } + }, + "Password": { + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string" + }, + "value": { + "readOnly": true, + "type": "string" + } + } + }, + "PaginatedComputeResourcesList": { + "type": "object", + "description": "Paginated list of Machine Learning compute objects wrapped in ARM resource envelope.", + "properties": { + "value": { + "type": "array", + "description": "An array of Machine Learning compute objects wrapped in ARM resource envelope.", + "items": { + "$ref": "#/definitions/ComputeResource" + } + }, + "nextLink": { + "type": "string", + "description": "A continuation link (absolute URI) to the next page of results in the list." + } + } + }, + "ComputeResource": { + "type": "object", + "description": "Machine Learning compute object wrapped into ARM resource envelope.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + }, + { + "type": "object", + "properties": { + "properties": { + "description": "Compute properties", + "$ref": "#/definitions/Compute" + } + } + } + ], + "properties": { + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the resource." + }, + "location": { + "description": "Specifies the location of the resource.", + "type": "string" + }, + "tags": { + "description": "Contains resource tags defined as key/value pairs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku of the workspace." + }, + "systemData": { + "description": "System data", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + } + }, + "Compute": { + "type": "object", + "description": "Machine Learning compute object.", + "discriminator": "computeType", + "properties": { + "computeType": { + "description": "The type of compute", + "$ref": "#/definitions/ComputeType" + }, + "computeLocation": { + "description": "Location for the underlying compute", + "type": "string" + }, + "provisioningState": { + "type": "string", + "description": "The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.", + "enum": [ + "Unknown", + "Updating", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "description": { + "type": "string", + "description": "The description of the Machine Learning compute." + }, + "createdOn": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The time at which the compute was created." + }, + "modifiedOn": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The time at which the compute was last modified." + }, + "resourceId": { + "type": "string", + "description": "ARM resource id of the underlying compute" + }, + "provisioningErrors": { + "type": "array", + "description": "Errors during provisioning", + "items": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "readOnly": true + }, + "isAttachedCompute": { + "type": "boolean", + "description": "Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.", + "readOnly": true + }, + "disableLocalAuth": { + "type": "boolean", + "description": "Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication." + } + }, + "required": [ + "computeType" + ] + }, + "AKS": { + "description": "A Machine Learning compute based on AKS.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "type": "object", + "properties": { + "properties": { + "type": "object", + "description": "AKS properties", + "properties": { + "clusterFqdn": { + "description": "Cluster full qualified domain name", + "type": "string" + }, + "systemServices": { + "type": "array", + "description": "System services", + "items": { + "$ref": "#/definitions/SystemService" + }, + "readOnly": true + }, + "agentCount": { + "description": "Number of agents", + "type": "integer", + "format": "int32", + "minimum": 0 + }, + "agentVmSize": { + "description": "Agent virtual machine size", + "type": "string" + }, + "clusterPurpose": { + "description": "Intended usage of the cluster", + "type": "string", + "default": "FastProd", + "enum": [ + "FastProd", + "DenseProd", + "DevTest" + ], + "x-ms-enum": { + "name": "ClusterPurpose", + "modelAsString": true + } + }, + "sslConfiguration": { + "description": "SSL configuration", + "$ref": "#/definitions/SslConfiguration" + }, + "aksNetworkingConfiguration": { + "description": "AKS networking configuration for vnet", + "$ref": "#/definitions/AksNetworkingConfiguration" + }, + "loadBalancerType": { + "description": "Load Balancer Type", + "type": "string", + "default": "PublicIp", + "enum": [ + "PublicIp", + "InternalLoadBalancer" + ], + "x-ms-enum": { + "name": "LoadBalancerType", + "modelAsString": true + } + }, + "loadBalancerSubnet": { + "description": "Load Balancer Subnet", + "type": "string" + } + } + } + } + } + ], + "x-ms-discriminator-value": "AKS" + }, + "Kubernetes": { + "description": "A Machine Learning compute based on Kubernetes Compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "$ref": "#/definitions/KubernetesSchema" + } + ], + "x-ms-discriminator-value": "Kubernetes" + }, + "KubernetesSchema": { + "type": "object", + "description": "Kubernetes Compute Schema", + "properties": { + "properties": { + "description": "Properties of Kubernetes", + "$ref": "#/definitions/KubernetesProperties" + } + } + }, + "KubernetesProperties": { + "type": "object", + "description": "Kubernetes properties", + "properties": { + "relayConnectionString": { + "description": "Relay connection string.", + "type": "string", + "x-ms-secret": true + }, + "serviceBusConnectionString": { + "description": "ServiceBus connection string.", + "type": "string", + "x-ms-secret": true + }, + "extensionPrincipalId": { + "description": "Extension principal-id.", + "type": "string" + }, + "extensionInstanceReleaseTrain": { + "description": "Extension instance release train.", + "type": "string" + }, + "vcName": { + "description": "VC name.", + "type": "string" + }, + "namespace": { + "description": "Compute namespace", + "type": "string", + "default": "default" + }, + "defaultInstanceType": { + "description": "Default instance type", + "type": "string" + }, + "instanceTypes": { + "description": "Instance Type Schema", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/InstanceTypeSchema" + } + } + } + }, + "AmlComputeProperties": { + "type": "object", + "description": "AML Compute properties", + "properties": { + "osType": { + "description": "Compute OS Type", + "type": "string", + "default": "Linux", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OsType", + "modelAsString": true + } + }, + "vmSize": { + "description": "Virtual Machine Size", + "type": "string" + }, + "vmPriority": { + "description": "Virtual Machine priority", + "type": "string", + "enum": [ + "Dedicated", + "LowPriority" + ], + "x-ms-enum": { + "name": "VmPriority", + "modelAsString": true + } + }, + "virtualMachineImage": { + "description": "Virtual Machine image for AML Compute - windows only", + "$ref": "#/definitions/VirtualMachineImage" + }, + "isolatedNetwork": { + "description": "Network is isolated or not", + "type": "boolean" + }, + "scaleSettings": { + "description": "Scale settings for AML Compute", + "$ref": "#/definitions/ScaleSettings" + }, + "userAccountCredentials": { + "title": "User account credentials.", + "description": "Credentials for an administrator user account that will be created on each compute node.", + "$ref": "#/definitions/UserAccountCredentials" + }, + "subnet": { + "title": "Subnet.", + "description": "Virtual network subnet resource ID the compute nodes belong to.", + "$ref": "#/definitions/ResourceId" + }, + "remoteLoginPortPublicAccess": { + "type": "string", + "default": "NotSpecified", + "title": "Close remote Login Access Port", + "description": "State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on all nodes of the cluster. Enabled - Indicates that the public ssh port is open on all nodes of the cluster. NotSpecified - Indicates that the public ssh port is closed on all nodes of the cluster if VNet is defined, else is open all public nodes. It can be default only during cluster creation time, after creation it will be either enabled or disabled.", + "enum": [ + "Enabled", + "Disabled", + "NotSpecified" + ], + "x-ms-enum": { + "name": "remoteLoginPortPublicAccess", + "modelAsString": true + } + }, + "allocationState": { + "type": "string", + "readOnly": true, + "title": "Allocation state.", + "description": "Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute.", + "enum": [ + "Steady", + "Resizing" + ], + "x-ms-enum": { + "name": "AllocationState", + "modelAsString": true + } + }, + "allocationStateTransitionTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "title": "Allocation state transition time.", + "description": "The time at which the compute entered its current allocation state." + }, + "errors": { + "readOnly": true, + "title": "Errors.", + "description": "Collection of errors encountered by various compute nodes during node setup.", + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + }, + "currentNodeCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "title": "Current node count.", + "description": "The number of compute nodes currently assigned to the compute." + }, + "targetNodeCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "title": "Target node count.", + "description": "The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation." + }, + "nodeStateCounts": { + "title": "Node state counts.", + "description": "Counts of various node states on the compute.", + "readOnly": true, + "$ref": "#/definitions/NodeStateCounts" + }, + "enableNodePublicIp": { + "type": "boolean", + "default": true, + "title": "Enable node public IP.", + "description": "Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs." + } + } + }, + "AmlCompute": { + "description": "An Azure Machine Learning compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "type": "object", + "description": "Properties(top level) of AmlCompute", + "properties": { + "properties": { + "description": "Properties of AmlCompute", + "$ref": "#/definitions/AmlComputeProperties" + } + } + } + ], + "x-ms-discriminator-value": "AmlCompute" + }, + "ComputeInstanceProperties": { + "description": "Compute Instance properties", + "type": "object", + "properties": { + "vmSize": { + "description": "Virtual Machine Size", + "type": "string" + }, + "subnet": { + "title": "Subnet.", + "description": "Virtual network subnet resource ID the compute nodes belong to.", + "$ref": "#/definitions/ResourceId" + }, + "applicationSharingPolicy": { + "type": "string", + "default": "Shared", + "title": "Sharing policy for applications on this compute instance", + "description": "Policy for sharing applications on this compute instance among users of parent workspace. If Personal, only the creator can access applications on this compute instance. When Shared, any workspace user can access applications on this instance depending on his/her assigned role.", + "enum": [ + "Personal", + "Shared" + ], + "x-ms-enum": { + "name": "applicationSharingPolicy", + "modelAsString": true + } + }, + "sshSettings": { + "description": "Specifies policy and settings for SSH access.", + "$ref": "#/definitions/ComputeInstanceSshSettings" + }, + "connectivityEndpoints": { + "readOnly": true, + "description": "Describes all connectivity endpoints available for this ComputeInstance.", + "$ref": "#/definitions/ComputeInstanceConnectivityEndpoints" + }, + "applications": { + "type": "array", + "readOnly": true, + "description": "Describes available applications and their endpoints on this ComputeInstance.", + "items": { + "$ref": "#/definitions/ComputeInstanceApplication" + } + }, + "createdBy": { + "readOnly": true, + "description": "Describes information on user who created this ComputeInstance.", + "$ref": "#/definitions/ComputeInstanceCreatedBy" + }, + "errors": { + "readOnly": true, + "title": "Errors.", + "description": "Collection of errors encountered on this ComputeInstance.", + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + }, + "state": { + "description": "The current state of this ComputeInstance.", + "$ref": "#/definitions/ComputeInstanceState", + "readOnly": true + }, + "computeInstanceAuthorizationType": { + "type": "string", + "title": "Compute Instance Authorization type.", + "description": "The Compute Instance Authorization type. Available values are personal (default).", + "default": "personal", + "enum": [ + "personal" + ], + "x-ms-enum": { + "name": "ComputeInstanceAuthorizationType", + "modelAsString": true + } + }, + "personalComputeInstanceSettings": { + "title": "Personal Compute Instance settings.", + "description": "Settings for a personal compute instance.", + "$ref": "#/definitions/PersonalComputeInstanceSettings" + }, + "setupScripts": { + "description": "Details of customized scripts to execute for setting up the cluster.", + "$ref": "#/definitions/SetupScripts" + }, + "lastOperation": { + "description": "The last operation on ComputeInstance.", + "$ref": "#/definitions/ComputeInstanceLastOperation", + "readOnly": true + } + } + }, + "ComputeInstance": { + "description": "An Azure Machine Learning compute instance.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "type": "object", + "description": "Properties(top level) of ComputeInstance", + "properties": { + "properties": { + "description": "Properties of ComputeInstance", + "$ref": "#/definitions/ComputeInstanceProperties" + } + } + } + ], + "x-ms-discriminator-value": "ComputeInstance" + }, + "VirtualMachine": { + "description": "A Machine Learning compute based on Azure Virtual Machines.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "virtualMachineSize": { + "description": "Virtual Machine size", + "type": "string" + }, + "sshPort": { + "description": "Port open for ssh connections.", + "type": "integer", + "format": "int32" + }, + "address": { + "description": "Public IP address of the virtual machine.", + "type": "string" + }, + "administratorAccount": { + "description": "Admin credentials for virtual machine", + "$ref": "#/definitions/VirtualMachineSshCredentials" + }, + "isNotebookInstanceCompute": { + "description": "Indicates whether this compute will be used for running notebooks.", + "type": "boolean" + } + } + } + } + } + ], + "x-ms-discriminator-value": "VirtualMachine" + }, + "HDInsightProperties": { + "type": "object", + "description": "HDInsight compute properties", + "properties": { + "sshPort": { + "description": "Port open for ssh connections on the master node of the cluster.", + "type": "integer", + "format": "int32" + }, + "address": { + "description": "Public IP address of the master node of the cluster.", + "type": "string" + }, + "administratorAccount": { + "description": "Admin credentials for master node of the cluster", + "$ref": "#/definitions/VirtualMachineSshCredentials" + } + } + }, + "HDInsight": { + "description": "A HDInsight compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/HDInsightProperties" + } + } + } + ], + "x-ms-discriminator-value": "HDInsight" + }, + "DataFactory": { + "description": "A DataFactory compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + } + ], + "x-ms-discriminator-value": "DataFactory" + }, + "DatabricksProperties": { + "type": "object", + "description": "Properties of Databricks", + "properties": { + "databricksAccessToken": { + "description": "Databricks access token", + "type": "string" + }, + "workspaceUrl": { + "description": "Workspace Url", + "type": "string" + } + } + }, + "Databricks": { + "description": "A DataFactory compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/DatabricksProperties" + } + } + } + ], + "x-ms-discriminator-value": "Databricks" + }, + "DataLakeAnalytics": { + "description": "A DataLakeAnalytics compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "dataLakeStoreAccountName": { + "description": "DataLake Store Account Name", + "type": "string" + } + } + } + } + } + ], + "x-ms-discriminator-value": "DataLakeAnalytics" + }, + "SynapseSpark": { + "type": "object", + "description": "A SynapseSpark compute.", + "properties": { + "properties": { + "type": "object", + "properties": { + "autoScaleProperties": { + "description": "Auto scale properties.", + "$ref": "#/definitions/AutoScaleProperties" + }, + "autoPauseProperties": { + "description": "Auto pause properties.", + "$ref": "#/definitions/AutoPauseProperties" + }, + "sparkVersion": { + "description": "Spark version.", + "type": "string" + }, + "nodeCount": { + "description": "The number of compute nodes currently assigned to the compute.", + "type": "integer", + "format": "int32" + }, + "nodeSize": { + "description": "Node size.", + "type": "string" + }, + "nodeSizeFamily": { + "description": "Node size family.", + "type": "string" + }, + "subscriptionId": { + "description": "Azure subscription identifier.", + "type": "string" + }, + "resourceGroup": { + "description": "Name of the resource group in which workspace is located.", + "type": "string" + }, + "workspaceName": { + "description": "Name of Azure Machine Learning workspace.", + "type": "string" + }, + "poolName": { + "description": "Pool name.", + "type": "string" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/Compute" + } + ], + "x-ms-discriminator-value": "SynapseSpark" + }, + "ServicePrincipalCredentials": { + "type": "object", + "description": "Service principal credentials.", + "properties": { + "clientId": { + "description": "Client Id", + "type": "string" + }, + "clientSecret": { + "description": "Client secret", + "type": "string" + } + }, + "required": [ + "clientId", + "clientSecret" + ] + }, + "SystemService": { + "type": "object", + "description": "A system service running on a compute.", + "properties": { + "systemServiceType": { + "description": "The type of this system service.", + "readOnly": true, + "type": "string" + }, + "publicIpAddress": { + "type": "string", + "description": "Public IP address", + "readOnly": true + }, + "version": { + "description": "The version for this type.", + "readOnly": true, + "type": "string" + } + } + }, + "SslConfiguration": { + "type": "object", + "description": "The ssl configuration for scoring", + "properties": { + "status": { + "description": "Enable or disable ssl for scoring", + "type": "string", + "enum": [ + "Disabled", + "Enabled", + "Auto" + ] + }, + "cert": { + "description": "Cert data", + "type": "string" + }, + "key": { + "description": "Key data", + "type": "string" + }, + "cname": { + "description": "CNAME of the cert", + "type": "string" + }, + "leafDomainLabel": { + "description": "Leaf domain label of public endpoint", + "type": "string" + }, + "overwriteExistingDomain": { + "description": "Indicates whether to overwrite existing domain label.", + "type": "boolean" + } + } + }, + "AksNetworkingConfiguration": { + "type": "object", + "description": "Advance configuration for AKS networking", + "properties": { + "subnetId": { + "description": "Virtual network subnet resource ID the compute nodes belong to", + "type": "string" + }, + "serviceCidr": { + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.", + "type": "string" + }, + "dnsServiceIP": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.", + "type": "string" + }, + "dockerBridgeCidr": { + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "description": "A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range.", + "type": "string" + } + } + }, + "UserAccountCredentials": { + "properties": { + "adminUserName": { + "type": "string", + "title": "User name.", + "description": "Name of the administrator user account which can be used to SSH to nodes." + }, + "adminUserSshPublicKey": { + "type": "string", + "title": "SSH public key.", + "description": "SSH public key of the administrator user account." + }, + "adminUserPassword": { + "type": "string", + "title": "Password.", + "description": "Password of the administrator user account." + } + }, + "required": [ + "adminUserName" + ], + "description": "Settings for user account that gets created on each on the nodes of a compute." + }, + "ScaleSettings": { + "type": "object", + "description": "scale settings for AML Compute", + "properties": { + "maxNodeCount": { + "description": "Max number of nodes to use", + "type": "integer", + "format": "int32" + }, + "minNodeCount": { + "description": "Min number of nodes to use", + "type": "integer", + "format": "int32", + "default": 0 + }, + "nodeIdleTimeBeforeScaleDown": { + "type": "string", + "format": "duration", + "description": "Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format." + } + }, + "required": [ + "maxNodeCount" + ] + }, + "VirtualMachineImage": { + "type": "object", + "description": "Virtual Machine image for Windows AML Compute", + "properties": { + "id": { + "description": "Virtual Machine image path", + "type": "string" + } + }, + "required": [ + "id" + ] + }, + "NodeStateCounts": { + "properties": { + "idleNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Idle node count.", + "description": "Number of compute nodes in idle state." + }, + "runningNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Running node count.", + "description": "Number of compute nodes which are running jobs." + }, + "preparingNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Preparing node count.", + "description": "Number of compute nodes which are being prepared." + }, + "unusableNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Unusable node count.", + "description": "Number of compute nodes which are in unusable state." + }, + "leavingNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Leaving node count.", + "description": "Number of compute nodes which are leaving the amlCompute." + }, + "preemptedNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Preempted node count.", + "description": "Number of compute nodes which are in preempted state." + } + }, + "description": "Counts of various compute node states on the amlCompute." + }, + "ScaleSettingsInformation": { + "type": "object", + "properties": { + "scaleSettings": { + "$ref": "#/definitions/ScaleSettings", + "title": "Scale settings." + } + }, + "description": "Desired scale settings for the amlCompute." + }, + "ClusterUpdateProperties": { + "properties": { + "properties": { + "description": "Properties of ClusterUpdate", + "$ref": "#/definitions/ScaleSettingsInformation" + } + }, + "description": "The properties of a amlCompute that need to be updated." + }, + "ClusterUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ClusterUpdateProperties", + "description": "The properties of the amlCompute." + } + }, + "description": "AmlCompute update parameters." + }, + "AmlComputeNodesInformation": { + "type": "object", + "description": "Result of AmlCompute Nodes", + "properties": { + "nodes": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/AmlComputeNodeInformation" + }, + "description": "The collection of returned AmlCompute nodes details." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The continuation token." + } + } + }, + "AmlComputeNodeInformation": { + "description": "Compute node information related to a AmlCompute.", + "properties": { + "nodeId": { + "readOnly": true, + "type": "string", + "title": "Node ID.", + "description": "ID of the compute node." + }, + "privateIpAddress": { + "readOnly": true, + "type": "string", + "title": "Private IP address.", + "description": "Private IP address of the compute node." + }, + "publicIpAddress": { + "readOnly": true, + "type": "string", + "title": "Public IP address.", + "description": "Public IP address of the compute node." + }, + "port": { + "readOnly": true, + "type": "number", + "format": "int32", + "title": "Port.", + "description": "SSH port number of the node." + }, + "nodeState": { + "readOnly": true, + "type": "string", + "enum": [ + "idle", + "running", + "preparing", + "unusable", + "leaving", + "preempted" + ], + "description": "State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted.", + "x-ms-enum": { + "name": "nodeState", + "modelAsString": true + } + }, + "runId": { + "readOnly": true, + "type": "string", + "title": "Run ID.", + "description": "ID of the Experiment running on the node, if any else null." + } + } + }, + "VirtualMachineSshCredentials": { + "type": "object", + "description": "Admin credentials for virtual machine", + "properties": { + "username": { + "description": "Username of admin account", + "type": "string" + }, + "password": { + "description": "Password of admin account", + "type": "string" + }, + "publicKeyData": { + "description": "Public key data", + "type": "string" + }, + "privateKeyData": { + "description": "Private key data", + "type": "string" + } + } + }, + "ComputeSecrets": { + "type": "object", + "description": "Secrets related to a Machine Learning compute. Might differ for every type of compute.", + "discriminator": "computeType", + "properties": { + "computeType": { + "description": "The type of compute", + "$ref": "#/definitions/ComputeType" + } + }, + "required": [ + "computeType" + ] + }, + "AksComputeSecretsProperties": { + "type": "object", + "description": "Properties of AksComputeSecrets", + "properties": { + "userKubeConfig": { + "type": "string", + "description": "Content of kubeconfig file that can be used to connect to the Kubernetes cluster." + }, + "adminKubeConfig": { + "type": "string", + "description": "Content of kubeconfig file that can be used to connect to the Kubernetes cluster." + }, + "imagePullSecretName": { + "type": "string", + "description": "Image registry pull secret." + } + } + }, + "AksComputeSecrets": { + "description": "Secrets related to a Machine Learning compute based on AKS.", + "allOf": [ + { + "$ref": "#/definitions/ComputeSecrets" + }, + { + "$ref": "#/definitions/AksComputeSecretsProperties" + } + ], + "x-ms-discriminator-value": "AKS" + }, + "VirtualMachineSecrets": { + "description": "Secrets related to a Machine Learning compute based on AKS.", + "allOf": [ + { + "$ref": "#/definitions/ComputeSecrets" + }, + { + "type": "object", + "properties": { + "administratorAccount": { + "description": "Admin credentials for virtual machine.", + "$ref": "#/definitions/VirtualMachineSshCredentials" + } + } + } + ], + "x-ms-discriminator-value": "VirtualMachine" + }, + "DatabricksComputeSecretsProperties": { + "type": "object", + "description": "Properties of Databricks Compute Secrets", + "properties": { + "databricksAccessToken": { + "description": "access token for databricks account.", + "type": "string" + } + } + }, + "DatabricksComputeSecrets": { + "description": "Secrets related to a Machine Learning compute based on Databricks.", + "allOf": [ + { + "$ref": "#/definitions/ComputeSecrets" + }, + { + "$ref": "#/definitions/DatabricksComputeSecretsProperties" + } + ], + "x-ms-discriminator-value": "Databricks" + }, + "ComputeType": { + "type": "string", + "description": "The type of compute", + "enum": [ + "AKS", + "Kubernetes", + "AmlCompute", + "ComputeInstance", + "DataFactory", + "VirtualMachine", + "HDInsight", + "Databricks", + "DataLakeAnalytics", + "SynapseSpark" + ], + "x-ms-enum": { + "name": "ComputeType", + "modelAsString": true + } + }, + "Sku": { + "description": "Sku of the resource", + "type": "object", + "properties": { + "name": { + "description": "Name of the sku", + "type": "string" + }, + "tier": { + "description": "Tier of the sku like Basic or Enterprise", + "type": "string" + } + } + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private endpoint connections", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + }, + "description": "List of private endpoint connection associated with the specified workspace" + }, + "PrivateEndpointConnection": { + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "x-ms-client-flatten": true, + "description": "Resource properties." + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the resource." + }, + "location": { + "description": "Specifies the location of the resource.", + "type": "string" + }, + "tags": { + "description": "Contains resource tags defined as key/value pairs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku of the workspace." + }, + "systemData": { + "description": "System data", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ], + "description": "The Private Endpoint Connection resource." + }, + "PrivateEndpointConnectionProperties": { + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private end point." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "provisioningState": { + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState", + "description": "The provisioning state of the private endpoint connection resource." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ], + "description": "Properties of the PrivateEndpointConnectProperties." + }, + "PrivateEndpoint": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ARM identifier for Private Endpoint" + }, + "subnetArmId": { + "readOnly": true, + "type": "string", + "description": "The ARM identifier for Subnet resource that private endpoint links to" + } + }, + "description": "The Private Endpoint resource." + }, + "PrivateLinkServiceConnectionState": { + "properties": { + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + }, + "description": { + "type": "string", + "description": "The reason for approval/rejection of the connection." + }, + "actionsRequired": { + "type": "string", + "description": "A message indicating if changes on the service provider require any updates on the consumer." + } + }, + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "PrivateEndpointServiceConnectionStatus": { + "type": "string", + "description": "The private endpoint connection status.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected", + "Timeout" + ], + "x-ms-enum": { + "name": "PrivateEndpointServiceConnectionStatus", + "modelAsString": true + } + }, + "PrivateEndpointConnectionProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "PrivateLinkResourceListResult": { + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + }, + "description": "A list of private link resources" + }, + "PrivateLinkResource": { + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the resource." + }, + "location": { + "description": "Specifies the location of the resource.", + "type": "string" + }, + "tags": { + "description": "Contains resource tags defined as key/value pairs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku of the workspace." + }, + "systemData": { + "description": "System data", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ], + "description": "A private link resource" + }, + "PrivateLinkResourceProperties": { + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private link resource Private link DNS zone name." + } + }, + "description": "Properties of a private link resource." + }, + "SharedPrivateLinkResource": { + "properties": { + "name": { + "description": "Unique name of the private link.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/SharedPrivateLinkResourceProperty", + "x-ms-client-flatten": true, + "description": "Resource properties." + } + } + }, + "SharedPrivateLinkResourceProperty": { + "properties": { + "privateLinkResourceId": { + "description": "The resource id that private link links to.", + "type": "string" + }, + "groupId": { + "description": "The private link resource group id.", + "type": "string" + }, + "requestMessage": { + "description": "Request message.", + "type": "string" + }, + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + } + }, + "description": "Properties of a shared private link resource." + }, + "EncryptionProperty": { + "properties": { + "status": { + "description": "Indicates whether or not the encryption is enabled for the workspace.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EncryptionStatus", + "modelAsString": true + } + }, + "identity": { + "$ref": "#/definitions/IdentityForCmk", + "description": "The identity that will be used to access the key vault for encryption at rest." + }, + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Customer Key vault properties." + } + }, + "required": [ + "status", + "keyVaultProperties" + ], + "type": "object" + }, + "KeyVaultProperties": { + "properties": { + "keyVaultArmId": { + "description": "The ArmId of the keyVault where the customer owned encryption key is present.", + "type": "string" + }, + "keyIdentifier": { + "description": "Key vault uri to access the encryption key.", + "type": "string" + }, + "identityClientId": { + "description": "For future use - The client id of the identity which will be used to access key vault.", + "type": "string" + } + }, + "required": [ + "keyIdentifier", + "keyVaultArmId" + ], + "type": "object" + }, + "IdentityForCmk": { + "description": "Identity that will be used to access key vault for encryption at rest", + "type": "object", + "properties": { + "userAssignedIdentity": { + "description": "The ArmId of the user assigned identity that will be used to access the customer managed key vault", + "type": "string" + } + } + }, + "ContainerResourceRequirements": { + "description": "The resource requirements for the container (cpu and memory).", + "type": "object", + "properties": { + "cpu": { + "format": "double", + "description": "The minimum amount of CPU cores to be used by the container. More info:\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", + "type": "number", + "example": 4 + }, + "cpuLimit": { + "format": "double", + "description": "The maximum amount of CPU cores allowed to be used by the container. More info:\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", + "type": "number", + "example": 4 + }, + "memoryInGB": { + "format": "double", + "description": "The minimum amount of memory (in GB) to be used by the container. More info:\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", + "type": "number", + "example": 64 + }, + "memoryInGBLimit": { + "format": "double", + "description": "The maximum amount of memory (in GB) allowed to be used by the container. More info:\nhttps://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/", + "type": "number", + "example": 64 + }, + "gpu": { + "format": "int32", + "description": "The number of GPU cores in the container.", + "type": "integer" + }, + "fpga": { + "format": "int32", + "description": "The number of FPGA PCIE devices exposed to the container. Must be multiple of 2.", + "type": "integer" + } + } + }, + "ComputeInstanceSshSettings": { + "type": "object", + "description": "Specifies policy and settings for SSH access.", + "properties": { + "sshPublicAccess": { + "type": "string", + "default": "Disabled", + "title": "Access policy for SSH", + "description": "State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "sshPublicAccess", + "modelAsString": true + } + }, + "adminUserName": { + "type": "string", + "readOnly": true, + "description": "Describes the admin user name." + }, + "sshPort": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "Describes the port for connecting through SSH." + }, + "adminPublicKey": { + "type": "string", + "description": "Specifies the SSH rsa public key file as a string. Use \"ssh-keygen -t rsa -b 2048\" to generate your SSH key pairs." + } + } + }, + "ComputeInstanceState": { + "type": "string", + "description": "Current state of an ComputeInstance.", + "enum": [ + "Creating", + "CreateFailed", + "Deleting", + "Running", + "Restarting", + "JobRunning", + "SettingUp", + "SetupFailed", + "Starting", + "Stopped", + "Stopping", + "UserSettingUp", + "UserSetupFailed", + "Unknown", + "Unusable" + ], + "x-ms-enum": { + "name": "ComputeInstanceState", + "modelAsString": true + } + }, + "ComputeInstanceLastOperation": { + "type": "object", + "description": "The last operation on ComputeInstance.", + "properties": { + "operationName": { + "type": "string", + "description": "Name of the last operation.", + "enum": [ + "Create", + "Start", + "Stop", + "Restart", + "Reimage", + "Delete" + ], + "x-ms-enum": { + "name": "OperationName", + "modelAsString": true + } + }, + "operationTime": { + "type": "string", + "format": "date-time", + "description": "Time of the last operation." + }, + "operationStatus": { + "type": "string", + "description": "Operation status.", + "enum": [ + "InProgress", + "Succeeded", + "CreateFailed", + "StartFailed", + "StopFailed", + "RestartFailed", + "ReimageFailed", + "DeleteFailed" + ], + "x-ms-enum": { + "name": "OperationStatus", + "modelAsString": true + } + } + } + }, + "ComputeInstanceApplication": { + "type": "object", + "description": "Defines an Aml Instance application and its connectivity endpoint URI.", + "properties": { + "displayName": { + "type": "string", + "description": "Name of the ComputeInstance application." + }, + "endpointUri": { + "type": "string", + "description": "Application' endpoint URI." + } + } + }, + "ComputeInstanceConnectivityEndpoints": { + "type": "object", + "readOnly": true, + "description": "Defines all connectivity endpoints and properties for an ComputeInstance.", + "properties": { + "publicIpAddress": { + "type": "string", + "readOnly": true, + "description": "Public IP Address of this ComputeInstance." + }, + "privateIpAddress": { + "type": "string", + "readOnly": true, + "description": "Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed)." + } + } + }, + "ComputeInstanceCreatedBy": { + "type": "object", + "readOnly": true, + "description": "Describes information on user who created this ComputeInstance.", + "properties": { + "userName": { + "type": "string", + "readOnly": true, + "description": "Name of the user." + }, + "userOrgId": { + "type": "string", + "readOnly": true, + "description": "Uniquely identifies user' Azure Active Directory organization." + }, + "userId": { + "type": "string", + "readOnly": true, + "description": "Uniquely identifies the user within his/her organization." + } + } + }, + "PersonalComputeInstanceSettings": { + "type": "object", + "properties": { + "assignedUser": { + "$ref": "#/definitions/AssignedUser", + "title": "Assigned User.", + "description": "A user explicitly assigned to a personal compute instance." + } + }, + "description": "Settings for a personal compute instance." + }, + "AssignedUser": { + "type": "object", + "description": "A user that can be assigned to a compute instance.", + "properties": { + "objectId": { + "type": "string", + "description": "User’s AAD Object Id." + }, + "tenantId": { + "type": "string", + "description": "User’s AAD Tenant Id." + } + }, + "required": [ + "objectId", + "tenantId" + ] + }, + "ServiceManagedResourcesSettings": { + "type": "object", + "properties": { + "cosmosDb": { + "$ref": "#/definitions/CosmosDbSettings", + "description": "The settings for the service managed cosmosdb account." + } + } + }, + "CosmosDbSettings": { + "type": "object", + "properties": { + "collectionsThroughput": { + "type": "integer", + "format": "int32", + "description": "The throughput of the collections in cosmosdb database" + } + } + }, + "NotebookResourceInfo": { + "type": "object", + "properties": { + "fqdn": { + "type": "string" + }, + "resourceId": { + "type": "string", + "description": "the data plane resourceId that used to initialize notebook component" + }, + "notebookPreparationError": { + "$ref": "#/definitions/NotebookPreparationError", + "description": "The error that occurs when preparing notebook.", + "x-nullable": true + } + } + }, + "NotebookPreparationError": { + "type": "object", + "properties": { + "errorMessage": { + "type": "string" + }, + "statusCode": { + "format": "int32", + "type": "integer" + } + } + }, + "ListNotebookKeysResult": { + "type": "object", + "properties": { + "primaryAccessKey": { + "readOnly": true, + "type": "string", + "x-ms-secret": true + }, + "secondaryAccessKey": { + "readOnly": true, + "type": "string", + "x-ms-secret": true + } + } + }, + "ListStorageAccountKeysResult": { + "type": "object", + "properties": { + "userStorageKey": { + "readOnly": true, + "type": "string", + "x-ms-secret": true + } + } + }, + "PaginatedWorkspaceConnectionsList": { + "type": "object", + "description": "Paginated list of Workspace connection objects.", + "properties": { + "value": { + "type": "array", + "description": "An array of Workspace connection objects.", + "items": { + "$ref": "#/definitions/WorkspaceConnection" + } + }, + "nextLink": { + "type": "string", + "description": "A continuation link (absolute URI) to the next page of results in the list." + } + } + }, + "WorkspaceConnection": { + "x-ms-azure-resource": true, + "description": "Workspace connection.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ResourceId of the workspace connection.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Friendly name of the workspace connection.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Resource type of workspace connection.", + "readOnly": true + }, + "properties": { + "type": "object", + "description": "Properties of workspace connection.", + "$ref": "#/definitions/WorkspaceConnectionProps", + "x-ms-client-flatten": true + } + } + }, + "WorkspaceConnectionProps": { + "type": "object", + "description": "Workspace Connection specific properties.", + "properties": { + "category": { + "description": "Category of the workspace connection.", + "type": "string" + }, + "target": { + "description": "Target of the workspace connection.", + "type": "string" + }, + "authType": { + "description": "Authorization type of the workspace connection.", + "type": "string" + }, + "value": { + "description": "Value details of the workspace connection.", + "type": "string" + }, + "valueFormat": { + "description": "format for the workspace connection value", + "type": "string", + "enum": [ + "JSON" + ], + "x-ms-enum": { + "name": "ValueFormat", + "modelAsString": true + } + } + } + }, + "SetupScripts": { + "type": "object", + "description": "Details of customized scripts to execute for setting up the cluster.", + "properties": { + "scripts": { + "description": "Customized setup scripts", + "$ref": "#/definitions/ScriptsToExecute" + } + } + }, + "ScriptsToExecute": { + "type": "object", + "description": "Customized setup scripts", + "properties": { + "startupScript": { + "description": "Script that's run every time the machine starts.", + "$ref": "#/definitions/ScriptReference" + }, + "creationScript": { + "description": "Script that's run only once during provision of the compute.", + "$ref": "#/definitions/ScriptReference" + } + } + }, + "ScriptReference": { + "type": "object", + "description": "Script reference", + "properties": { + "scriptSource": { + "description": "The storage source of the script: inline, workspace.", + "type": "string" + }, + "scriptData": { + "description": "The location of scripts in the mounted volume.", + "type": "string" + }, + "scriptArguments": { + "description": "Optional command line arguments passed to the script to run.", + "type": "string" + }, + "timeout": { + "description": "Optional time period passed to timeout command.", + "type": "string" + } + } + }, + "AutoScaleProperties": { + "type": "object", + "description": "Auto scale properties", + "properties": { + "minNodeCount": { + "format": "int32", + "type": "integer" + }, + "enabled": { + "type": "boolean" + }, + "maxNodeCount": { + "format": "int32", + "type": "integer" + } + } + }, + "AutoPauseProperties": { + "type": "object", + "description": "Auto pause properties", + "properties": { + "delayInMinutes": { + "format": "int32", + "type": "integer" + }, + "enabled": { + "type": "boolean" + } + } + }, + "InstanceTypeSchema": { + "type": "object", + "description": "Instance type schema.", + "properties": { + "nodeSelector": { + "type": "object", + "description": "Node Selector", + "additionalProperties": { + "type": "string" + } + }, + "resources": { + "type": "object", + "description": "Resource requests/limits for this instance type", + "properties": { + "requests": { + "description": "Resource requests for this instance type", + "$ref": "#/definitions/InstanceResourceSchema" + }, + "limits": { + "description": "Resource limits for this instance type", + "$ref": "#/definitions/InstanceResourceSchema" + } + } + } + } + }, + "InstanceResourceSchema": { + "type": "object", + "description": "Resource requests/limits for this instance type", + "additionalProperties": { + "type": "string" + } + }, + "FQDNEndpointDetail": { + "type": "object", + "properties": { + "port": { + "format": "int32", + "type": "integer" + } + } + }, + "FQDNEndpoint": { + "type": "object", + "properties": { + "domainName": { + "type": "string" + }, + "endpointDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/FQDNEndpointDetail" + } + } + } + }, + "FQDNEndpointsProperties": { + "type": "object", + "properties": { + "category": { + "type": "string" + }, + "endpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/FQDNEndpoint" + } + } + } + }, + "FQDNEndpoints": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FQDNEndpointsProperties" + } + } + }, + "ExternalFQDNResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FQDNEndpoints" + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/workspaceFeatures.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/workspaceFeatures.json new file mode 100644 index 000000000000..ff5b04f12c6e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/workspaceFeatures.json @@ -0,0 +1,113 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Machine Learning Workspaces", + "version": "2021-07-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/features": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Lists all enabled features for a workspace", + "operationId": "WorkspaceFeatures_List", + "x-ms-examples": { + "List Workspace features": { + "$ref": "./examples/WorkspaceFeature/list.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "machineLearningServices.json#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ListAmlUserFeatureResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AmlUserFeature": { + "description": "Features enabled for a workspace", + "type": "object", + "properties": { + "id": { + "description": "Specifies the feature ID", + "type": "string" + }, + "displayName": { + "description": "Specifies the feature name ", + "type": "string" + }, + "description": { + "description": "Describes the feature for user experience", + "type": "string" + } + } + }, + "ListAmlUserFeatureResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/AmlUserFeature" + }, + "description": "The list of AML user facing features." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page of AML user features information. Call ListNext() with this to fetch the next page of AML user features information." + } + }, + "description": "The List Aml user feature operation response." + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/workspaceSkus.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/workspaceSkus.json new file mode 100644 index 000000000000..0355e1e3a729 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/workspaceSkus.json @@ -0,0 +1,230 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Machine Learning Workspaces", + "version": "2021-07-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/workspaces/skus": { + "get": { + "tags": [ + "WorkspaceSkus" + ], + "description": "Lists all skus with associated features", + "operationId": "WorkspaceSkus_List", + "x-ms-examples": { + "List Skus": { + "$ref": "./examples/WorkspaceSku/list.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/SkuListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "SkuListResult": { + "description": "List of skus with features", + "type": "object", + "properties": { + "value": { + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/WorkspaceSku" + } + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of Workspace Skus. Call ListNext() with this URI to fetch the next page of Workspace Skus" + } + } + }, + "SKUCapability": { + "description": "Features/user capabilities associated with the sku", + "type": "object", + "properties": { + "name": { + "description": "Capability/Feature ID", + "type": "string" + }, + "value": { + "description": "Details about the feature/capability", + "type": "string" + } + } + }, + "Restriction": { + "properties": { + "type": { + "readOnly": true, + "type": "string", + "description": "The type of restrictions. As of now 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. This would be different locations where the SKU is restricted." + }, + "reasonCode": { + "type": "string", + "enum": [ + "NotSpecified", + "NotAvailableForRegion", + "NotAvailableForSubscription" + ], + "x-ms-enum": { + "name": "ReasonCode", + "modelAsString": true + }, + "description": "The reason for the restriction." + } + }, + "description": "The restriction because of which SKU cannot be used." + }, + "ResourceSkuLocationInfo": { + "properties": { + "location": { + "readOnly": true, + "type": "string", + "description": "Location of the SKU" + }, + "zones": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "List of availability zones where the SKU is supported." + }, + "zoneDetails": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ResourceSkuZoneDetails" + }, + "description": "Details of capabilities available to a SKU in specific zones." + } + } + }, + "ResourceSkuZoneDetails": { + "properties": { + "name": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "The set of zones that the SKU is available in with the specified capabilities." + }, + "capabilities": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SKUCapability" + }, + "description": "A list of capabilities that are available for the SKU in the specified list of zones." + } + }, + "description": "Describes The zonal capabilities of a SKU." + }, + "WorkspaceSku": { + "description": "Describes Workspace Sku details and features", + "type": "object", + "properties": { + "locations": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.)." + }, + "locationInfo": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ResourceSkuLocationInfo" + }, + "description": "A list of locations and availability zones in those locations where the SKU is available." + }, + "tier": { + "description": "Sku Tier like Basic or Enterprise", + "type": "string", + "readOnly": true + }, + "resourceType": { + "type": "string", + "readOnly": true + }, + "name": { + "type": "string", + "readOnly": true + }, + "capabilities": { + "description": "List of features/user capabilities associated with the sku", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SKUCapability" + }, + "readOnly": true + }, + "restrictions": { + "type": "array", + "items": { + "$ref": "#/definitions/Restriction" + }, + "description": "The restrictions because of which SKU cannot be used. This is empty if there are no restrictions." + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + } +} diff --git a/specification/machinelearningservices/resource-manager/readme.go.md b/specification/machinelearningservices/resource-manager/readme.go.md index dce4e4fc53d2..df23738c614e 100644 --- a/specification/machinelearningservices/resource-manager/readme.go.md +++ b/specification/machinelearningservices/resource-manager/readme.go.md @@ -13,6 +13,8 @@ go: ```yaml $(go) && $(multiapi) batch: + - tag: package-2021-07-01 + - tag: package-2021-04-01 - tag: package-2021-03-01-preview - tag: package-2020-04-01 - tag: package-2020-03-01 @@ -24,6 +26,25 @@ batch: - tag: package-2020-02-18-preview - tag: package-2018-03-preview ``` + +## Tag: package-2021-07-01 and go + +These settings apply only when `--tag=package-2021-07-01 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +```yaml $(tag)=='package-2021-07-01' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2021-07-01/$(namespace) +``` + +## Tag: package-2021-04-01 and go + +These settings apply only when `--tag=package-2021-04-01 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +```yaml $(tag)=='package-2021-04-01' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2021-04-01/$(namespace) +``` + ## Tag: package-2021-03-01-preview and go These settings apply only when `--tag=package-2021-03-01-preview --go` is specified on the command line. diff --git a/specification/machinelearningservices/resource-manager/readme.java.md b/specification/machinelearningservices/resource-manager/readme.java.md index 38010227dd0b..01fd170edcd0 100644 --- a/specification/machinelearningservices/resource-manager/readme.java.md +++ b/specification/machinelearningservices/resource-manager/readme.java.md @@ -18,6 +18,7 @@ service-name: MachineLearningServices ``` yaml $(java) && $(multiapi) batch: + - tag: package-2021-07-01 - tag: package-2021-03-01-preview - tag: package-2021-04-01 - tag: package-2021-01-01 @@ -38,6 +39,19 @@ batch: ``` ### Tag: package-2021-03-01-preview and java +These settings apply only when `--tag=package-2021-07-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2021-07-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.machinelearningservices.v2021_07_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/machinelearningservices/mgmt-v2021_07_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2021-03-01-preview and java + These settings apply only when `--tag=package-2021-03-01-preview --java` is specified on the command line. Please also specify `--azure-libraries-for-java=`. diff --git a/specification/machinelearningservices/resource-manager/readme.md b/specification/machinelearningservices/resource-manager/readme.md index 3429e0c1672d..b42c40ec35aa 100644 --- a/specification/machinelearningservices/resource-manager/readme.md +++ b/specification/machinelearningservices/resource-manager/readme.md @@ -27,7 +27,18 @@ These are the global settings for the Machine Learning Services API. ``` yaml openapi-type: arm -tag: package-2021-04-01 +tag: package-2021-07-01 +``` + +### Tag: package-2021-07-01 + +These settings apply only when `--tag=package-2021-07` is specified on the command line. + +```yaml $(tag) == 'package-2021-07-01' +input-file: + - Microsoft.MachineLearningServices/stable/2021-07-01/machineLearningServices.json + - Microsoft.MachineLearningServices/stable/2021-07-01/workspaceFeatures.json + - Microsoft.MachineLearningServices/stable/2021-07-01/workspaceSkus.json ``` ### Tag: package-2021-04-01 @@ -57,7 +68,6 @@ These settings apply only when `--tag=package-2021-03-01-preview` is specified o input-file: - Microsoft.MachineLearningServices/preview/2021-03-01-preview/machineLearningServices.json - Microsoft.MachineLearningServices/preview/2021-03-01-preview/mfe.json - - Microsoft.MachineLearningServices/preview/2021-03-01-preview/services.json - Microsoft.MachineLearningServices/preview/2021-03-01-preview/workspaceFeatures.json - Microsoft.MachineLearningServices/preview/2021-03-01-preview/workspaceSkus.json ``` diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2021-04-01-preview/Maintenance.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2021-04-01-preview/Maintenance.json index 180a2b168dcd..c11ddda1815d 100644 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2021-04-01-preview/Maintenance.json +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2021-04-01-preview/Maintenance.json @@ -2044,6 +2044,10 @@ "type": "string" }, "description": "Classification category of patches to be patched" + }, + "excludeKbsRequiringReboot": { + "type": "boolean", + "description": "Exclude patches which need reboot" } }, "description": "Input properties for patching a Windows machine." diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2021-04-01-preview/examples/MaintenanceConfigurations_GetForResource_GuestOSPatchWindows.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2021-04-01-preview/examples/MaintenanceConfigurations_GetForResource_GuestOSPatchWindows.json index d086d50096dc..1775062b8793 100644 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2021-04-01-preview/examples/MaintenanceConfigurations_GetForResource_GuestOSPatchWindows.json +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2021-04-01-preview/examples/MaintenanceConfigurations_GetForResource_GuestOSPatchWindows.json @@ -32,7 +32,8 @@ ], "kbNumbersToExclude": [ "KB234567" - ] + ], + "excludeKbsRequiringReboot": false }, "tasks": { "preTasks": [ diff --git a/specification/maintenance/resource-manager/readme.md b/specification/maintenance/resource-manager/readme.md index 105ccf603947..cbb0fce36a73 100644 --- a/specification/maintenance/resource-manager/readme.md +++ b/specification/maintenance/resource-manager/readme.md @@ -85,7 +85,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-libraries-for-java - repo: azure-sdk-for-go diff --git a/specification/maintenance/resource-manager/readme.python.md b/specification/maintenance/resource-manager/readme.python.md index f942a856620e..17bd37335d01 100644 --- a/specification/maintenance/resource-manager/readme.python.md +++ b/specification/maintenance/resource-manager/readme.python.md @@ -4,38 +4,15 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.maintenance - package-name: azure-mgmt-maintenance - package-version: 1.1.0 - clear-output-folder: true -``` ``` yaml $(python) && $(track2) -python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.maintenance package-name: azure-mgmt-maintenance -package-version: 1.1.0 +package-version: 1.0.0b1 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/maintenance/azure-mgmt-maintenance/azure/mgmt/maintenance -``` - -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/maintenance/azure-mgmt-maintenance -``` ``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true diff --git a/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json index bc65be70cb12..caaac95ed665 100644 --- a/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json +++ b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json @@ -3,7 +3,7 @@ "info": { "title": "ManagedServicesClient", "version": "2020-02-01-preview", - "description": "Specification for ManagedServices." + "description": "The specification for ManagedServices." }, "host": "management.azure.com", "schemes": [ @@ -27,7 +27,7 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", + "description": "The Azure Active Directory OAuth2 Flow", "scopes": { "user_impersonation": "impersonate your user account" } @@ -60,7 +60,7 @@ } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "The error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } @@ -94,10 +94,10 @@ "description": "OK - The registration definition is deleted." }, "204": { - "description": "No Content- The registration definition does not exist." + "description": "No Content - The registration definition does not exist." }, "default": { - "description": "Error response describing why the operation failed.", + "description": "The error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } @@ -130,7 +130,7 @@ "name": "requestBody", "in": "body", "required": true, - "description": "The parameters required to create new registration definition.", + "description": "The parameters required to create a new registration definition.", "schema": { "$ref": "#/definitions/RegistrationDefinition" } @@ -150,7 +150,7 @@ } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "The error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } @@ -169,7 +169,7 @@ "RegistrationAssignments" ], "operationId": "RegistrationAssignments_Get", - "description": "Gets the details of specified registration assignment.", + "description": "Gets the details of the specified registration assignment.", "parameters": [ { "$ref": "#/parameters/ScopeParameter" @@ -192,7 +192,7 @@ } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "The error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } @@ -230,10 +230,10 @@ "description": "Accepted - The registration assignment deletion operation is accepted." }, "204": { - "description": "No Content- The registration assignment does not exist." + "description": "No Content - The registration assignment does not exist." }, "default": { - "description": "Error response describing why the operation failed.", + "description": "The error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } @@ -286,7 +286,7 @@ } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "The error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } @@ -322,7 +322,7 @@ } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "The error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } @@ -364,7 +364,7 @@ } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "The error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } @@ -406,7 +406,7 @@ } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "The error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } @@ -445,7 +445,7 @@ } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "The error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } @@ -487,7 +487,7 @@ } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "The error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } @@ -523,7 +523,7 @@ } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "The error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } @@ -556,7 +556,7 @@ } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "The error response describing why the operation failed.", "schema": { "$ref": "#/definitions/ErrorResponse" } @@ -574,65 +574,65 @@ "RegistrationDefinition": { "properties": { "properties": { - "description": "Properties of a registration definition.", + "description": "The properties of a registration definition.", "$ref": "#/definitions/RegistrationDefinitionProperties" }, "plan": { - "description": "Plan details for the managed services.", + "description": "The details for the Managed Services offer’s plan in Azure Marketplace.", "$ref": "#/definitions/Plan" }, "id": { "readOnly": true, "type": "string", - "description": "Fully qualified path of the registration definition." + "description": "The fully qualified path of the registration definition." }, "type": { "readOnly": true, "type": "string", - "description": "Type of the resource." + "description": "The type of the Azure resource (Microsoft.ManagedServices/registrationDefinitions)." }, "name": { "readOnly": true, "type": "string", - "description": "Name of the registration definition." + "description": "The name of the registration definition." } }, "x-ms-azure-resource": true, "type": "object", - "description": "Registration definition." + "description": "The registration definition." }, "RegistrationDefinitionProperties": { "properties": { "description": { "type": "string", - "description": "Description of the registration definition." + "description": "The description of the registration definition." }, "authorizations": { "type": "array", "items": { "$ref": "#/definitions/Authorization" }, - "description": "Authorization tuple containing principal id of the user/security group or service principal and id of the build-in role." + "description": "The collection of authorization objects describing the access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant." }, "eligibleAuthorizations": { "type": "array", "items": { "$ref": "#/definitions/EligibleAuthorization" }, - "description": "Eligible PIM authorization tuple containing principal id of the user/security group or service principal, id of the built-in role, and just-in-time access policy setting" + "description": "The collection of eligible authorization objects describing the just-in-time access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant." }, "registrationDefinitionName": { "type": "string", - "description": "Name of the registration definition." + "description": "The name of the registration definition." }, "managedByTenantId": { "type": "string", - "description": "Id of the managedBy tenant." + "description": "The identifier of the managedBy tenant." }, "provisioningState": { "type": "string", "readOnly": true, - "description": "Current state of the registration definition.", + "description": "The current provisioning state of the registration definition.", "enum": [ "NotSpecified", "Accepted", @@ -655,7 +655,7 @@ "managedByTenantName": { "readOnly": true, "type": "string", - "description": "Name of the managedBy tenant." + "description": "The name of the managedBy tenant." } }, "required": [ @@ -663,7 +663,7 @@ "authorizations" ], "type": "object", - "description": "Properties of a registration definition." + "description": "The properties of a registration definition." }, "RegistrationDefinitionList": { "properties": { @@ -673,20 +673,20 @@ "items": { "$ref": "#/definitions/RegistrationDefinition" }, - "description": "List of registration definitions." + "description": "The list of registration definitions." }, "nextLink": { - "description": "Link to next page of registration definitions.", + "description": "The link to the next page of registration definitions.", "type": "string", "readOnly": true } }, - "description": "List of registration definitions." + "description": "The list of registration definitions." }, "RegistrationAssignment": { "properties": { "properties": { - "description": "Properties of a registration assignment.", + "description": "The properties of a registration assignment.", "$ref": "#/definitions/RegistrationAssignmentProperties" }, "id": { @@ -697,28 +697,28 @@ "type": { "readOnly": true, "type": "string", - "description": "Type of the resource." + "description": "The type of the Azure resource (Microsoft.ManagedServices/registrationAssignments)." }, "name": { "readOnly": true, "type": "string", - "description": "Name of the registration assignment." + "description": "The name of the registration assignment." } }, "x-ms-azure-resource": true, "type": "object", - "description": "Registration assignment." + "description": "The registration assignment." }, "RegistrationAssignmentProperties": { "properties": { "registrationDefinitionId": { "type": "string", - "description": "Fully qualified path of the registration definition." + "description": "The fully qualified path of the registration definition." }, "provisioningState": { "readOnly": true, "type": "string", - "description": "Current state of the registration assignment.", + "description": "The current provisioning state of the registration assignment.", "enum": [ "NotSpecified", "Accepted", @@ -745,29 +745,29 @@ "properties": { "description": { "type": "string", - "description": "Description of the registration definition." + "description": "The description of the registration definition." }, "authorizations": { "type": "array", "items": { "$ref": "#/definitions/Authorization" }, - "description": "Authorization tuple containing principal id of the user/security group or service principal and id of the build-in role." + "description": "The collection of authorization objects describing the access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant." }, "eligibleAuthorizations": { "type": "array", "items": { "$ref": "#/definitions/EligibleAuthorization" }, - "description": "Eligible PIM authorization tuple containing principal id of the user/security group or service principal, id of the built-in role, and just-in-time access policy setting" + "description": "The collection of eligible authorization objects describing the just-in-time access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant." }, "registrationDefinitionName": { "type": "string", - "description": "Name of the registration definition." + "description": "The name of the registration definition." }, "provisioningState": { "type": "string", - "description": "Current state of the registration definition.", + "description": "The current provisioning state of the registration definition.", "enum": [ "NotSpecified", "Accepted", @@ -789,52 +789,52 @@ }, "manageeTenantId": { "type": "string", - "description": "Id of the home tenant." + "description": "The identifier of the managed tenant." }, "manageeTenantName": { "type": "string", - "description": "Name of the home tenant." + "description": "The name of the managed tenant." }, "managedByTenantId": { "type": "string", - "description": "Id of the managedBy tenant." + "description": "The identifier of the managedBy tenant." }, "managedByTenantName": { "type": "string", - "description": "Name of the managedBy tenant." + "description": "The name of the managedBy tenant." } }, - "description": "Properties of registration definition inside registration assignment." + "description": "The properties of the registration definition associated with the registration assignment." }, "plan": { - "description": "Plan details for the managed services.", + "description": "The details for the Managed Services offer’s plan in Azure Marketplace.", "$ref": "#/definitions/Plan" }, "id": { "readOnly": true, "type": "string", - "description": "Fully qualified path of the registration definition." + "description": "The fully qualified path of the registration definition." }, "type": { "readOnly": true, "type": "string", - "description": "Type of the resource (Microsoft.ManagedServices/registrationDefinitions)." + "description": "The type of the Azure resource (Microsoft.ManagedServices/registrationDefinitions)." }, "name": { "readOnly": true, "type": "string", - "description": "Name of the registration definition." + "description": "The name of the registration definition." } }, "type": "object", - "description": "Registration definition inside registration assignment." + "description": "The registration definition associated with the registration assignment." } }, "required": [ "registrationDefinitionId" ], "type": "object", - "description": "Properties of a registration assignment." + "description": "The properties of the registration assignment." }, "RegistrationAssignmentList": { "properties": { @@ -844,40 +844,40 @@ "items": { "$ref": "#/definitions/RegistrationAssignment" }, - "description": "List of registration assignments." + "description": "The list of registration assignments." }, "nextLink": { - "description": "Link to next page of registration assignments.", + "description": "The link to the next page of registration assignments.", "type": "string", "readOnly": true } }, - "description": "List of registration assignments." + "description": "The list of registration assignments." }, "MarketplaceRegistrationDefinition": { "properties": { "properties": { - "description": "Properties of a marketplace registration definition.", + "description": "The properties of the marketplace registration definition.", "$ref": "#/definitions/MarketplaceRegistrationDefinitionProperties" }, "plan": { - "description": "Plan details for the managed services.", + "description": "The details for the Managed Services offer’s plan in Azure Marketplace.", "$ref": "#/definitions/Plan" }, "id": { "readOnly": true, "type": "string", - "description": "Fully qualified path of the marketplace registration definition." + "description": "The fully qualified path of the marketplace registration definition." }, "type": { "readOnly": true, "type": "string", - "description": "Type of the resource." + "description": "The type of the Azure resource (Microsoft.ManagedServices/marketplaceRegistrationDefinitions)." }, "name": { "readOnly": true, "type": "string", - "description": "Name of the marketplace registration definition." + "description": "The name of the marketplace registration definition." } }, "x-ms-azure-resource": true, @@ -887,21 +887,21 @@ "properties": { "managedByTenantId": { "type": "string", - "description": "Id of the managedBy tenant." + "description": "The identifier of the managedBy tenant." }, "authorizations": { "type": "array", "items": { "$ref": "#/definitions/Authorization" }, - "description": "Authorization tuple containing principal id of the user/security group or service principal and id of the build-in role." + "description": "The collection of authorization objects describing the access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant." }, "eligibleAuthorizations": { "type": "array", "items": { "$ref": "#/definitions/EligibleAuthorization" }, - "description": "Eligible PIM authorization tuple containing principal id of the user/security group or service principal, id of the built-in role, and just-in-time access policy setting" + "description": "The collection of eligible authorization objects describing the just-in-time access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant." }, "offerDisplayName": { "type": "string", @@ -921,7 +921,7 @@ "authorizations" ], "type": "object", - "description": "Properties of a marketplace registration definition." + "description": "The properties of the marketplace registration definition." }, "MarketplaceRegistrationDefinitionList": { "properties": { @@ -931,33 +931,33 @@ "items": { "$ref": "#/definitions/MarketplaceRegistrationDefinition" }, - "description": "List of marketplace registration definitions." + "description": "The list of marketplace registration definitions." }, "nextLink": { - "description": "Link to next page of marketplace registration definitions.", + "description": "The link to the next page of marketplace registration definitions.", "type": "string", "readOnly": true } }, - "description": "List of marketplace registration definitions." + "description": "The list of marketplace registration definitions." }, "Plan": { "properties": { "name": { "type": "string", - "description": "The plan name." + "description": "Azure Marketplace plan name." }, "publisher": { "type": "string", - "description": "The publisher ID." + "description": "Azure Marketplace publisher ID." }, "product": { "type": "string", - "description": "The product code." + "description": "Azure Marketplace product code." }, "version": { "type": "string", - "description": "The plan's version." + "description": "Azure Marketplace plan's version." } }, "required": [ @@ -967,14 +967,14 @@ "version" ], "type": "object", - "description": "Plan details for the managed services." + "description": "The details for the Managed Services offer’s plan in Azure Marketplace." }, "Operation": { "properties": { "name": { "readOnly": true, "type": "string", - "description": "Operation name: {provider}/{resource}/{operation}" + "description": "The operation name with the format: {provider}/{resource}/{operation}" }, "display": { "readOnly": true, @@ -982,25 +982,25 @@ "properties": { "provider": { "type": "string", - "description": "Service provider: Microsoft.ManagedServices" + "description": "The service provider." }, "resource": { "type": "string", - "description": "Resource on which the operation is performed: Registration definition, registration assignment etc." + "description": "The resource on which the operation is performed." }, "operation": { "type": "string", - "description": "Operation type: Read, write, delete, etc." + "description": "The operation type." }, "description": { "type": "string", - "description": "Description of the operation." + "description": "The description of the operation." } } } }, "type": "object", - "description": "Object that describes a single Microsoft.ManagedServices operation." + "description": "The object that describes a single Microsoft.ManagedServices operation." }, "OperationList": { "properties": { @@ -1010,29 +1010,29 @@ "items": { "$ref": "#/definitions/Operation" }, - "description": "List of Microsoft.ManagedServices operations." + "description": "The list of Microsoft.ManagedServices operations." } }, "type": "object", - "description": "List of the operations." + "description": "The list of the operations." }, "Authorization": { "properties": { "principalId": { "type": "string", - "description": "Principal Id of the security group/service principal/user that would be assigned permissions to the projected subscription" + "description": "The identifier of the Azure Active Directory principal." }, "principalIdDisplayName": { "type": "string", - "description": "Display name of the principal Id." + "description": "The display name of the Azure Active Directory principal." }, "roleDefinitionId": { "type": "string", - "description": "The role definition identifier. This role will define all the permissions that the security group/service principal/user must have on the projected subscription. This role cannot be an owner role." + "description": "The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope." }, "delegatedRoleDefinitionIds": { "type": "array", - "description": "The delegatedRoleDefinitionIds field is required when the roleDefinitionId refers to the User Access Administrator Role. It is the list of role definition ids which define all the permissions that the user in the authorization can assign to other security groups/service principals/users.", + "description": "The delegatedRoleDefinitionIds field is required when the roleDefinitionId refers to the User Access Administrator Role. It is the list of role definition ids which define all the permissions that the user in the authorization can assign to other principals.", "items": { "format": "uuid", "type": "string" @@ -1044,24 +1044,24 @@ "roleDefinitionId" ], "type": "object", - "description": "Authorization tuple containing principal Id (of user/service principal/security group) and role definition id." + "description": "The Azure Active Directory principal identifier and Azure built-in role that describes the access the principal will receive on the delegated resource in the managed tenant." }, "EligibleAuthorization": { "properties": { "principalId": { "type": "string", - "description": "Principal Id of the security group/service principal/user that would be delegated permissions to the projected subscription" + "description": "The identifier of the Azure Active Directory principal." }, "principalIdDisplayName": { "type": "string", - "description": "Display name of the principal Id." + "description": "The display name of the Azure Active Directory principal." }, "roleDefinitionId": { "type": "string", - "description": "The role definition identifier. This role will delegate all the permissions that the security group/service principal/user must have on the projected subscription. This role cannot be an owner role." + "description": "The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope." }, "justInTimeAccessPolicy": { - "description": "Just-in-time access policy setting.", + "description": "The just-in-time access policy setting.", "$ref": "#/definitions/JustInTimeAccessPolicy" } }, @@ -1070,30 +1070,30 @@ "roleDefinitionId" ], "type": "object", - "description": "Eligible authorization tuple containing principle Id (of user/service principal/security group), role definition id, and the just-in-time access setting." + "description": "The Azure Active Directory principal identifier, Azure built-in role, and just-in-time access policy that describes the just-in-time access the principal will receive on the delegated resource in the managed tenant." }, "EligibleApprover": { "properties": { "principalId": { "type": "string", - "description": "Principal Id of the user or security group that will approve JIT activation requests for the eligible authorization." + "description": "The identifier of the Azure Active Directory principal." }, "principalIdDisplayName": { "type": "string", - "description": "Display name of the principal Id." + "description": "The display name of the Azure Active Directory principal." } }, "required": [ "principalId" ], "type": "object", - "description": "A principal Id and user-friendly display name representing an eligible authorization approver." + "description": "Defines the Azure Active Directory principal that can approve any just-in-time access requests by the principal defined in the EligibleAuthorization." }, "JustInTimeAccessPolicy": { "properties": { "multiFactorAuthProvider": { "type": "string", - "description": "MFA provider.", + "description": "The multi-factor authorization provider to be used for just-in-time access requests.", "enum": [ "Azure", "None" @@ -1107,7 +1107,7 @@ "maximumActivationDuration": { "type": "string", "format": "duration", - "description": "Maximum access duration in ISO 8601 format.", + "description": "The maximum access duration in ISO 8601 format for just-in-time access requests.", "default": "PT8H" }, "managedByTenantApprovers": { @@ -1128,14 +1128,14 @@ "properties": { "code": { "type": "string", - "description": "Error code." + "description": "The error code." }, "message": { "type": "string", - "description": "Error message indicating why the operation failed." + "description": "The error message indicating why the operation failed." }, "details": { - "description": "Internal error details.", + "description": "The internal error details.", "type": "array", "items": { "$ref": "#/definitions/ErrorDefinition" @@ -1147,7 +1147,7 @@ "message" ], "type": "object", - "description": "Error response indicates Azure Resource Manager is not able to process the incoming request. The reason is provided in the error message." + "description": "The error response indicating why the incoming request wasn’t able to be processed" }, "ErrorResponse": { "description": "Error response.", @@ -1168,7 +1168,7 @@ "x-ms-parameter-location": "method", "x-ms-skip-url-encoding": true, "type": "string", - "description": "Scope of the resource." + "description": "The scope of the resource." }, "MarketplaceIdentifier": { "name": "marketplaceIdentifier", @@ -1176,7 +1176,7 @@ "required": true, "x-ms-parameter-location": "method", "type": "string", - "description": "Market place identifier. Expected Formats - {publisher}.{product[-preview]}.{planName}.{version} or {publisher}.{product[-preview]}.{planName} or {publisher}.{product[-preview]} or {publisher})." + "description": "The Azure Marketplace identifier. Expected formats: {publisher}.{product[-preview]}.{planName}.{version} or {publisher}.{product[-preview]}.{planName} or {publisher}.{product[-preview]} or {publisher})." }, "ApiVersionParameter": { "name": "api-version", @@ -1191,7 +1191,7 @@ "required": true, "x-ms-parameter-location": "method", "type": "string", - "description": "Guid of the registration assignment." + "description": "The GUID of the registration assignment." }, "RegistrationDefinitionIdParameter": { "name": "registrationDefinitionId", @@ -1199,21 +1199,21 @@ "required": true, "x-ms-parameter-location": "method", "type": "string", - "description": "Guid of the registration definition." + "description": "The GUID of the registration definition." }, "ExpandRegistrationDefinition": { "name": "$expandRegistrationDefinition", "in": "query", "x-ms-parameter-location": "method", "type": "boolean", - "description": "Tells whether to return registration definition details also along with registration assignment details." + "description": "The flag indicating whether to return the registration definition details along with the registration assignment details." }, "Filter": { "name": "$filter", "in": "query", "x-ms-parameter-location": "method", "type": "string", - "description": "The filter query parameter. Might be used to filter marketplace registration definition by plan identifier, publisher, version etc." + "description": "The filter query parameter to filter marketplace registration definitions by plan identifier, publisher, version etc." } } } diff --git a/specification/maps/data-plane/Common/preview/1.0/common.json b/specification/maps/data-plane/Common/preview/1.0/common.json new file mode 100644 index 000000000000..c860dab1333f --- /dev/null +++ b/specification/maps/data-plane/Common/preview/1.0/common.json @@ -0,0 +1,678 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Common Types", + "version": "1.0" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{geography}.atlas.microsoft.com", + "parameters": [ + { + "$ref": "#/parameters/GeographicResourceLocation" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "paths": {}, + "definitions": { + "LongRunningOperationResult": { + "description": "The response model for a Long-Running Operations API.", + "type": "object", + "properties": { + "operationId": { + "description": "The Id for this long-running operation.", + "type": "string" + }, + "status": { + "description": "The status state of the request.", + "type": "string", + "enum": [ + "NotStarted", + "Running", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "name": "LroStatus", + "modelAsString": true, + "values": [ + { + "value": "NotStarted", + "description": "The request has not started processing yet." + }, + { + "value": "Running", + "description": "The request has started processing." + }, + { + "value": "Failed", + "description": "The request has one or more failures." + }, + { + "value": "Succeeded", + "description": "The request has successfully completed." + } + ] + }, + "readOnly": true + }, + "created": { + "description": "The created timestamp.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "error": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorDetail" + }, + "warning": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorDetail" + } + } + }, + "BatchRequestBody": { + "description": "This type represents the request body for the Batch service.", + "type": "object", + "properties": { + "batchItems": { + "description": "The list of queries to process.", + "type": "array", + "items": { + "description": "Batch Query object", + "type": "object", + "properties": { + "query": { + "description": "Partial query string.", + "type": "string", + "example": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3" + } + } + } + } + } + }, + "BatchResponse": { + "description": "This object is returned from a successful Batch service call. Extend with 'batchItems' property.", + "type": "object", + "properties": { + "summary": { + "description": "Summary for the batch request", + "type": "object", + "readOnly": true, + "properties": { + "successfulRequests": { + "description": "Number of successful requests in the batch", + "type": "integer", + "readOnly": true + }, + "totalRequests": { + "description": "Total number of requests in the batch", + "type": "integer", + "readOnly": true + } + } + } + } + }, + "BatchItem": { + "description": "An item returned from Batch API. Extend with 'response' property.", + "type": "object", + "properties": { + "statusCode": { + "description": "HTTP request status code.", + "type": "number", + "readOnly": true, + "example": 200 + } + } + }, + "CoordinatesPair": { + "description": "A location represented as a latitude and longitude.", + "type": "object", + "properties": { + "latitude": { + "description": "Latitude property", + "type": "number", + "format": "double" + }, + "longitude": { + "description": "Longitude property", + "type": "number", + "format": "double" + } + } + }, + "CoordinatesPairAbbreviated": { + "description": "A location represented as a latitude and longitude using short names 'lat' & 'lon'.", + "type": "object", + "properties": { + "lat": { + "description": "Latitude property", + "type": "number", + "format": "double" + }, + "lon": { + "description": "Longitude property", + "type": "number", + "format": "double" + } + } + }, + "GeoJsonPosition": { + "description": "A `Position` is an array of numbers with two or more elements. The first two elements are _longitude_ and _latitude_, precisely in that order. _Altitude/Elevation_ is an optional third element. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.1) for details.", + "type": "array", + "items": { + "type": "number", + "format": "double" + } + }, + "GeoJsonLinearRing": { + "description": "Though a linear ring is not explicitly represented as a GeoJSON geometry type, it helps in defining the polygon as an array of linear rings. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.6) for details.", + "type": "array", + "items": { + "$ref": "#/definitions/GeoJsonPosition" + } + }, + "GeoJsonObject": { + "description": "A valid `GeoJSON` object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3) for details.", + "type": "object", + "discriminator": "type", + "required": [ + "type" + ], + "properties": { + "type": { + "description": "Specifies the `GeoJSON` type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.", + "type": "string", + "enum": [ + "Point", + "MultiPoint", + "LineString", + "MultiLineString", + "Polygon", + "MultiPolygon", + "GeometryCollection", + "Feature", + "FeatureCollection" + ], + "x-ms-enum": { + "name": "GeoJsonObjectType", + "modelAsString": true, + "values": [ + { + "value": "Point", + "description": "`GeoJSON Point` geometry.", + "name": "GeoJsonPoint" + }, + { + "value": "MultiPoint", + "description": "`GeoJSON MultiPoint` geometry.", + "name": "GeoJsonMultiPoint" + }, + { + "value": "LineString", + "description": "`GeoJSON LineString` geometry.", + "name": "GeoJsonLineString" + }, + { + "value": "MultiLineString", + "description": "`GeoJSON MultiLineString` geometry.", + "name": "GeoJsonMultiLineString" + }, + { + "value": "Polygon", + "description": "`GeoJSON Polygon` geometry.", + "name": "GeoJsonPolygon" + }, + { + "value": "MultiPolygon", + "description": "`GeoJSON MultiPolygon` geometry.", + "name": "GeoJsonMultiPolygon" + }, + { + "value": "GeometryCollection", + "description": "`GeoJSON GeometryCollection` geometry.", + "name": "GeoJsonGeometryCollection" + }, + { + "value": "Feature", + "description": "`GeoJSON Feature` object.", + "name": "GeoJsonFeature" + }, + { + "value": "FeatureCollection", + "description": "`GeoJSON FeatureCollection` object.", + "name": "GeoJsonFeatureCollection" + } + ] + } + } + } + }, + "GeoJsonGeometry": { + "description": "A valid `GeoJSON` geometry object. The type must be one of the seven valid GeoJSON geometry types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon and GeometryCollection. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1) for details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJsonObject" + } + ] + }, + "GeoJsonPoint": { + "description": "A valid `GeoJSON Point` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.2) for details.", + "x-ms-discriminator-value": "Point", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJsonGeometry" + }, + { + "$ref": "#/definitions/GeoJsonPointData" + } + ] + }, + "GeoJsonPointData": { + "description": "Data contained by a `GeoJson Point`.", + "type": "object", + "properties": { + "coordinates": { + "$ref": "#/definitions/GeoJsonPosition" + } + }, + "required": [ + "coordinates" + ] + }, + "GeoJsonMultiPoint": { + "description": "A valid `GeoJSON MultiPoint` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.3) for details.", + "x-ms-discriminator-value": "MultiPoint", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJsonGeometry" + }, + { + "$ref": "#/definitions/GeoJsonMultiPointData" + } + ] + }, + "GeoJsonMultiPointData": { + "type": "object", + "description": "Data contained by a `GeoJson MultiPoint`.", + "properties": { + "coordinates": { + "description": "Coordinates for the `GeoJson MultiPoint` geometry.", + "type": "array", + "items": { + "$ref": "#/definitions/GeoJsonPosition" + } + } + }, + "required": [ + "coordinates" + ] + }, + "GeoJsonLineString": { + "description": "A valid `GeoJSON LineString` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.4) for details.", + "x-ms-discriminator-value": "LineString", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJsonGeometry" + }, + { + "$ref": "#/definitions/GeoJsonLineStringData" + } + ] + }, + "GeoJsonLineStringData": { + "type": "object", + "properties": { + "coordinates": { + "description": "Coordinates for the `GeoJson LineString` geometry.", + "type": "array", + "items": { + "$ref": "#/definitions/GeoJsonPosition" + } + } + }, + "required": [ + "coordinates" + ] + }, + "GeoJsonMultiLineString": { + "description": "A valid `GeoJSON MultiLineString` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.5) for details.", + "x-ms-discriminator-value": "MultiLineString", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJsonGeometry" + }, + { + "$ref": "#/definitions/GeoJsonMultiLineStringData" + } + ] + }, + "GeoJsonMultiLineStringData": { + "type": "object", + "properties": { + "coordinates": { + "description": "Coordinates for the `GeoJson MultiLineString` geometry.", + "type": "array", + "items": { + "$ref": "#/definitions/GeoJsonLinearRing" + } + } + }, + "required": [ + "coordinates" + ] + }, + "GeoJsonPolygon": { + "description": "A valid `GeoJSON Polygon` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.6) for details.", + "x-ms-discriminator-value": "Polygon", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJsonGeometry" + }, + { + "$ref": "#/definitions/GeoJsonPolygonData" + } + ] + }, + "GeoJsonPolygonData": { + "type": "object", + "properties": { + "coordinates": { + "description": "Coordinates for the `GeoJson Polygon` geometry type.", + "type": "array", + "items": { + "$ref": "#/definitions/GeoJsonLinearRing" + } + } + }, + "required": [ + "coordinates" + ] + }, + "GeoJsonMultiPolygon": { + "description": "A valid `GeoJSON MultiPolygon` object type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.7) for details.", + "x-ms-discriminator-value": "MultiPolygon", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJsonGeometry" + }, + { + "$ref": "#/definitions/GeoJsonMultiPolygonData" + } + ] + }, + "GeoJsonMultiPolygonData": { + "type": "object", + "properties": { + "coordinates": { + "description": "Contains a list of valid `GeoJSON Polygon` objects. **Note** that coordinates in GeoJSON are in x, y order (longitude, latitude).", + "type": "array", + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/GeoJsonLinearRing" + } + } + } + }, + "required": [ + "coordinates" + ] + }, + "GeoJsonGeometryCollection": { + "description": "A valid `GeoJSON GeometryCollection` object type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.8) for details.", + "x-ms-discriminator-value": "GeometryCollection", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJsonGeometry" + }, + { + "$ref": "#/definitions/GeoJsonGeometryCollectionData" + } + ] + }, + "GeoJsonGeometryCollectionData": { + "type": "object", + "properties": { + "geometries": { + "description": "Contains a list of valid `GeoJSON` geometry objects. **Note** that coordinates in GeoJSON are in x, y order (longitude, latitude).", + "type": "array", + "items": { + "$ref": "#/definitions/GeoJsonGeometry" + } + } + }, + "required": [ + "geometries" + ] + }, + "GeoJsonFeature": { + "description": "A valid `GeoJSON Feature` object type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.2) for details.", + "x-ms-discriminator-value": "Feature", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJsonObject" + }, + { + "$ref": "#/definitions/GeoJsonFeatureData" + } + ] + }, + "GeoJsonFeatureData": { + "type": "object", + "properties": { + "geometry": { + "$ref": "#/definitions/GeoJsonGeometry" + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Properties can contain any additional metadata about the `Feature`. Value can be any JSON object or a JSON null value", + "type": "object" + }, + "id": { + "description": "Identifier for the feature.", + "type": "string" + }, + "featureType": { + "description": "The type of the feature. The value depends on the data model the current feature is part of. Some data models may have an empty value.", + "type": "string" + } + }, + "required": [ + "geometry" + ] + }, + "GeoJsonFeatureCollection": { + "description": "A valid `GeoJSON FeatureCollection` object type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details.", + "x-ms-discriminator-value": "FeatureCollection", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJsonObject" + }, + { + "$ref": "#/definitions/GeoJsonFeatureCollectionData" + } + ] + }, + "GeoJsonFeatureCollectionData": { + "type": "object", + "properties": { + "features": { + "description": "Contains a list of valid `GeoJSON Feature` objects.", + "type": "array", + "items": { + "$ref": "#/definitions/GeoJsonFeature" + } + } + }, + "required": [ + "features" + ] + }, + "Ontology": { + "type": "string", + "description": "The ontology version of this dataset.", + "readOnly": true + } + }, + "parameters": { + "ClientId": { + "name": "x-ms-client-id", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "type": "string", + "in": "header", + "x-ms-parameter-location": "client" + }, + "ResponseFormat": { + "name": "format", + "description": "Desired format of the response. Only `json` format is supported.", + "type": "string", + "in": "path", + "required": true, + "enum": [ + "json" + ], + "x-ms-enum": { + "name": "ResponseFormat", + "modelAsString": true, + "values": [ + { + "value": "json", + "description": "[The JavaScript Object Notation Data Interchange Format](https://tools.ietf.org/html/rfc8259)" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "TextFormat": { + "name": "format", + "description": "Desired format of the response. Value can be either _json_ or _xml_.", + "type": "string", + "in": "path", + "required": true, + "enum": [ + "json", + "xml" + ], + "x-ms-enum": { + "name": "TextFormat", + "modelAsString": true, + "values": [ + { + "value": "json", + "description": "[The JavaScript Object Notation Data Interchange Format](https://tools.ietf.org/html/rfc8259)" + }, + { + "value": "xml", + "description": "[The Extensible Markup Language](https://www.w3.org/TR/xml/)" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "GeographicResourceLocation": { + "name": "geography", + "description": "This parameter specifies where the Azure Maps Creator resource is located. Valid values are us and eu.", + "in": "path", + "required": true, + "type": "string", + "default": "us", + "enum": [ + "us", + "eu" + ], + "x-ms-enum": { + "name": "GeographicResourceLocation", + "modelAsString": true, + "values": [ + { + "value": "us", + "description": "Used to access an Azure Maps Creator resource in the United States" + }, + { + "value": "eu", + "description": "Used to access an Azure Maps Creator resource in Europe" + } + ] + }, + "x-ms-parameter-location": "client" + } + }, + "responses": { + "200AsyncV2": { + "description": "The operation is running or complete. If the operation was successful, use the Resource-Location header to obtain the path to the result.", + "schema": { + "$ref": "#/definitions/LongRunningOperationResult" + }, + "headers": { + "Resource-Location": { + "type": "string", + "description": "If successful, a URI where details on the newly created resource can be found." + } + } + }, + "202Async": { + "description": "**Supported only for async request.**\nRequest Accepted: The request has been accepted for processing. Please use the URL in the Location Header to retry or access the results.", + "headers": { + "Location": { + "type": "string", + "description": "New URL to check for the results of the long running process." + } + } + }, + "202AsyncV2": { + "description": "Request Accepted: The request has been accepted for processing. Please use the URL in the Operation-Location Header to obtain status.", + "headers": { + "Operation-Location": { + "type": "string", + "description": "New URL to check for the results of the long running process." + } + } + }, + "408": { + "description": "Timeout: The request took longer to finish than the maximum amount of time defined in the api.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + }, + "x-ms-error-response": true + }, + "409": { + "description": "The request could not be completed due to a conflict with the current state of the resource. Likely caused by a parallel update to the same resource.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + }, + "x-ms-error-response": true + }, + "409StorageLimit": { + "description": "The [data storage limit](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#azure-maps-limits) is reached on the Azure Maps account. You can always use the [Data Delete API](https://docs.microsoft.com/en-us/rest/api/maps/data/deletepreview) to delete old/unused content and create space for new uploads.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + }, + "x-ms-error-response": true + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + }, + "x-ms-error-response": true + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetBuffer.json b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetBuffer.json new file mode 100644 index 000000000000..f0cdf649b353 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetBuffer.json @@ -0,0 +1,170 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "udid": "[udid]", + "distances": "176.3" + }, + "responses": { + "200": { + "body": { + "summary": { + "udid": "[udid from request]", + "information": "1 feature processed in user data" + }, + "result": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "properties": { + "geometryId": "ExampleId", + "bufferDist": 176.3 + }, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + -111.92483859605078, + 33.5362475 + ], + [ + -111.92487510409389, + 33.53587682761772 + ], + [ + -111.92498322523961, + 33.535520399967204 + ], + [ + -111.92515880445296, + 33.535191914363196 + ], + [ + -111.92539509432322, + 33.53490399432323 + ], + [ + -111.92568301436319, + 33.534667704452971 + ], + [ + -111.9260114999672, + 33.53449212523963 + ], + [ + -111.9263679276177, + 33.5343840040939 + ], + [ + -111.9267386, + 33.534347496050785 + ], + [ + -111.92710927238228, + 33.5343840040939 + ], + [ + -111.92746570003278, + 33.53449212523963 + ], + [ + -111.9277941856368, + 33.534667704452971 + ], + [ + -111.92808210567676, + 33.53490399432323 + ], + [ + -111.92831839554702, + 33.535191914363196 + ], + [ + -111.92849397476037, + 33.535520399967204 + ], + [ + -111.9286020959061, + 33.53587682761772 + ], + [ + -111.92863860394921, + 33.5362475 + ], + [ + -111.9286020959061, + 33.536618172382283 + ], + [ + -111.92849397476037, + 33.5369746000328 + ], + [ + -111.92831839554702, + 33.537303085636808 + ], + [ + -111.92808210567676, + 33.537591005676774 + ], + [ + -111.9277941856368, + 33.537827295547032 + ], + [ + -111.92746570003278, + 33.538002874760373 + ], + [ + -111.92710927238228, + 33.5381109959061 + ], + [ + -111.9267386, + 33.538147503949219 + ], + [ + -111.9263679276177, + 33.5381109959061 + ], + [ + -111.9260114999672, + 33.538002874760373 + ], + [ + -111.92568301436319, + 33.537827295547032 + ], + [ + -111.92539509432322, + 33.537591005676774 + ], + [ + -111.92515880445296, + 33.537303085636808 + ], + [ + -111.92498322523961, + 33.5369746000328 + ], + [ + -111.92487510409389, + 33.536618172382283 + ], + [ + -111.92483859605078, + 33.5362475 + ] + ] + ] + } + } + ] + } + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetClosestPoint.json b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetClosestPoint.json new file mode 100644 index 000000000000..426ebeaf3725 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetClosestPoint.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "udid": "[udid]", + "lat": 47.622942, + "lon": -122.316456 + }, + "responses": { + "200": { + "body": { + "summary": { + "sourcePoint": { + "lat": 47.622942, + "lon": -122.316456 + }, + "udid": "[udid from request]", + "information": "10 points processed in user data" + }, + "result": [ + { + "distanceInMeters": 1587492.66, + "position": { + "lat": 40.516153406773952, + "lon": -105.02860293715861 + }, + "geometryId": "1001" + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetGeofence.json b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetGeofence.json new file mode 100644 index 000000000000..774de28742a6 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetGeofence.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "deviceId": "unique_device_name_under_account", + "udid": "[udId]", + "lat": 48.36, + "lon": -124.63, + "searchBuffer": 50, + "userTime": "2017-07-21T17:32:28Z", + "isAsync": true, + "mode": "EnterAndExit" + }, + "responses": { + "200": { + "body": { + "geometries": [ + { + "deviceId": "unique_device_name_under_account", + "udId": "[udId]", + "geometryId": "2", + "distance": 999, + "nearestLat": 47.621954, + "nearestLon": -122.131841 + }, + { + "deviceId": "unique_device_name_under_account", + "udId": "[udId]", + "geometryId": "1", + "distance": -999, + "nearestLat": 47.609833, + "nearestLon": -122.148274 + } + ], + "expiredGeofenceGeometryId": [ + "5" + ], + "invalidPeriodGeofenceGeometryId": [ + "3", + "4" + ], + "isEventPublished": true + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetGreatCircleDistance.json b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetGreatCircleDistance.json new file mode 100644 index 000000000000..0565252283f3 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetGreatCircleDistance.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "query": "47.622942,-122.316456:47.610378,-122.200676" + }, + "responses": { + "200": { + "body": { + "summary": { + "sourcePoint": { + "lat": 47.622942, + "lon": -122.316456 + }, + "targetPoint": { + "lat": 47.610378, + "lon": -122.200676 + } + }, + "result": { + "distanceInMeters": 8797.62 + } + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetPointInPolygon.json b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetPointInPolygon.json new file mode 100644 index 000000000000..5d94dd13c8c0 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_GetPointInPolygon.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "udid": "[udid]", + "lat": 47.622942, + "lon": -122.316456 + }, + "responses": { + "200": { + "body": { + "summary": { + "sourcePoint": { + "lat": 33.5362475, + "lon": -111.9267386 + }, + "udid": "[udid from request]", + "information": "4 polygons processed in user data" + }, + "result": { + "pointInPolygons": true, + "intersectingGeometries": [ + "1001", + "1003" + ] + } + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostBuffer.json b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostBuffer.json new file mode 100644 index 000000000000..201618ac2347 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostBuffer.json @@ -0,0 +1,191 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "bufferRequestBody": { + "geometries": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "properties": { + "geometryId": "ExampleId" + }, + "geometry": { + "type": "Point", + "coordinates": [ + -111.9267386, + 33.5362475 + ] + } + } + ] + }, + "distances": [ + 176.3 + ] + } + }, + "responses": { + "200": { + "body": { + "summary": { + "udid": null, + "information": "1 feature processed in user data" + }, + "result": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "properties": { + "geometryId": "ExampleId", + "bufferDist": 176.3 + }, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + -111.92483859605078, + 33.5362475 + ], + [ + -111.92487510409389, + 33.53587682761772 + ], + [ + -111.92498322523961, + 33.535520399967204 + ], + [ + -111.92515880445296, + 33.535191914363196 + ], + [ + -111.92539509432322, + 33.53490399432323 + ], + [ + -111.92568301436319, + 33.534667704452971 + ], + [ + -111.9260114999672, + 33.53449212523963 + ], + [ + -111.9263679276177, + 33.5343840040939 + ], + [ + -111.9267386, + 33.534347496050785 + ], + [ + -111.92710927238228, + 33.5343840040939 + ], + [ + -111.92746570003278, + 33.53449212523963 + ], + [ + -111.9277941856368, + 33.534667704452971 + ], + [ + -111.92808210567676, + 33.53490399432323 + ], + [ + -111.92831839554702, + 33.535191914363196 + ], + [ + -111.92849397476037, + 33.535520399967204 + ], + [ + -111.9286020959061, + 33.53587682761772 + ], + [ + -111.92863860394921, + 33.5362475 + ], + [ + -111.9286020959061, + 33.536618172382283 + ], + [ + -111.92849397476037, + 33.5369746000328 + ], + [ + -111.92831839554702, + 33.537303085636808 + ], + [ + -111.92808210567676, + 33.537591005676774 + ], + [ + -111.9277941856368, + 33.537827295547032 + ], + [ + -111.92746570003278, + 33.538002874760373 + ], + [ + -111.92710927238228, + 33.5381109959061 + ], + [ + -111.9267386, + 33.538147503949219 + ], + [ + -111.9263679276177, + 33.5381109959061 + ], + [ + -111.9260114999672, + 33.538002874760373 + ], + [ + -111.92568301436319, + 33.537827295547032 + ], + [ + -111.92539509432322, + 33.537591005676774 + ], + [ + -111.92515880445296, + 33.537303085636808 + ], + [ + -111.92498322523961, + 33.5369746000328 + ], + [ + -111.92487510409389, + 33.536618172382283 + ], + [ + -111.92483859605078, + 33.5362475 + ] + ] + ] + } + } + ] + } + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostClosestPoint.json b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostClosestPoint.json new file mode 100644 index 000000000000..c47be26bac17 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostClosestPoint.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "lat": 47.622942, + "lon": -122.316456, + "closestPointRequestBody": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "properties": { + "geometryId": 1001 + }, + "geometry": { + "type": "Point", + "coordinates": [ + -105.02860293715861, + 40.516153406773952 + ] + } + }, + { + "type": "Feature", + "properties": { + "geometryId": 1002 + }, + "geometry": { + "type": "Point", + "coordinates": [ + -105.02860381672178, + 40.515990990037309 + ] + } + }, + { + "type": "Feature", + "properties": { + "geometryId": 1003 + }, + "geometry": { + "type": "Point", + "coordinates": [ + -105.02812292879467, + 40.516058678088562 + ] + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "summary": { + "sourcePoint": { + "lat": 47.622942, + "lon": -122.316456 + }, + "udid": null, + "information": "3 points processed in user data" + }, + "result": [ + { + "distanceInMeters": 1587492.66, + "position": { + "lat": 40.516153406773952, + "lon": -105.02860293715861 + }, + "geometryId": "1001" + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostGeofence.json b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostGeofence.json new file mode 100644 index 000000000000..11c4fe5176c7 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostGeofence.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "deviceId": "unique_device_name_under_account", + "lat": 48.36, + "lon": -124.63, + "searchBuffer": 50, + "usertime": "2017-07-21T17:32:28Z", + "isAsync": true, + "mode": "EnterAndExit", + "searchGeofenceRequestBody": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + -122.13241226662022, + 47.61701140091722 + ], + [ + -122.12810106940353, + 47.6169969269402 + ], + [ + -122.12824948956276, + 47.61907683751349 + ], + [ + -122.12833297981392, + 47.621929787055336 + ], + [ + -122.12971398040168, + 47.62184100705295 + ], + [ + -122.1318413862121, + 47.62195364373008 + ], + [ + -122.13231034769727, + 47.61716332618121 + ], + [ + -122.13241226662022, + 47.61701140091722 + ] + ] + ] + }, + "properties": { + "geometryId": "2", + "name": "Crossroad Mall" + } + }, + { + "type": "Feature", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + -122.1534220563239, + 47.60981818546625 + ], + [ + -122.153451623509, + 47.60628733146004 + ], + [ + -122.14971782206638, + 47.606250040787046 + ], + [ + -122.14817354810637, + 47.606391046012305 + ], + [ + -122.1482735128807, + 47.60983316796356 + ], + [ + -122.15225500989803, + 47.60982613678752 + ], + [ + -122.1534220563239, + 47.60981818546625 + ] + ] + ] + }, + "properties": { + "geometryId": "1", + "name": "Sammamish High school" + } + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "geometries": [ + { + "deviceId": "unique_device_name_under_account", + "geometryId": "2", + "distance": -999, + "nearestLat": 47.621954, + "nearestLon": -122.131841 + }, + { + "deviceId": "unique_device_name_under_account", + "geometryId": "1", + "distance": 999, + "nearestLat": 47.609833, + "nearestLon": -122.148274 + } + ], + "expiredGeofenceGeometryId": [], + "invalidPeriodGeofenceGeometryId": [], + "isEventPublished": true + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostPointInPolygon.json b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostPointInPolygon.json new file mode 100644 index 000000000000..fc0ce0e8d71e --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/1.0/examples/spatial/Spatial_PostPointInPolygon.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "lat": 33.5362475, + "lon": -111.9267386, + "pointInPolygonRequestBody": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "properties": { + "geometryId": 1001 + }, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + -111.9267386, + 33.5362475 + ], + [ + -111.9627875, + 33.5104882 + ], + [ + -111.9027061, + 33.5004686 + ], + [ + -111.9267386, + 33.5362475 + ] + ] + ] + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "summary": { + "sourcePoint": { + "lat": 33.5362475, + "lon": -111.9267386 + }, + "udid": null, + "information": "1 polygons processed in user data" + }, + "result": { + "pointInPolygons": true, + "intersectingGeometries": [ + "1001" + ] + } + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/1.0/spatial.json b/specification/maps/data-plane/Creator/preview/1.0/spatial.json new file mode 100644 index 000000000000..7e0af17046ac --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/1.0/spatial.json @@ -0,0 +1,923 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Spatial Service", + "version": "1.0", + "description": "Azure Maps Spatial REST APIs" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{geography}.atlas.microsoft.com", + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "AzureKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "AzureKey": [] + } + ], + "responses": {}, + "parameters": { + "SpatialApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API.", + "type": "string", + "in": "query", + "required": true, + "default": "1.0", + "x-ms-parameter-location": "client" + }, + "GeofenceMode": { + "name": "mode", + "in": "query", + "description": "Mode of the geofencing async event mechanism.", + "type": "string", + "enum": [ + "All", + "EnterAndExit" + ], + "x-ms-enum": { + "name": "GeofenceMode", + "modelAsString": true, + "values": [ + { + "value": "All", + "description": "Publish all the query results to Azure Maps account event subscription." + }, + { + "value": "EnterAndExit", + "description": "Only publish result when user location is considered as crossing geofencing boarder." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "SpatialUploadUdid": { + "name": "udid", + "in": "query", + "description": "The unique id returned from [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) after uploading a valid GeoJSON FeatureCollection object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SpatialUploadDataFormat": { + "name": "dataFormat", + "description": "Data format of the content being uploaded. Currently, only `geojson` format is supported.", + "type": "string", + "in": "query", + "required": true, + "enum": [ + "geojson" + ], + "x-ms-enum": { + "name": "SpatialUploadDataFormat", + "modelAsString": true, + "values": [ + { + "value": "geojson", + "description": "[GeoJSON](https://tools.ietf.org/html/rfc7946) is a JSON based geospatial data interchange format." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "SpatialLatitude": { + "name": "lat", + "x-ms-client-name": "Latitude", + "description": "The latitude of the location being passed. Example: 48.36.", + "type": "number", + "in": "query", + "required": true, + "x-ms-parameter-location": "method" + }, + "SpatialLongitude": { + "name": "lon", + "x-ms-client-name": "Longitude", + "description": "The longitude of the location being passed. Example: -124.63.", + "type": "number", + "in": "query", + "required": true, + "x-ms-parameter-location": "method" + }, + "SearchGeofenceRequestBody": { + "name": "searchGeofenceRequestBody", + "in": "body", + "description": "The geofencing GeoJSON data.", + "required": true, + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonFeatureCollection" + }, + "x-ms-parameter-location": "method" + }, + "ClosestPointRequestBody": { + "name": "closestPointRequestBody", + "in": "body", + "description": "The FeatureCollection of Point geometries from which closest point to source point should be determined. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.", + "required": true, + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonFeatureCollection" + }, + "x-ms-parameter-location": "method" + }, + "PointInPolygonRequestBody": { + "name": "pointInPolygonRequestBody", + "in": "body", + "description": "A FeatureCollection with a set of Polygon/MultiPolygon geometries. The maximum number of vertices accepted to form a Polygon is 10,000. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.", + "required": true, + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonFeatureCollection" + }, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/spatial/geofence/{format}": { + "get": { + "description": "**Search Geofence Get API**\n\n**Applies to:** S1 Pricing tier.\n\nThe Geofence Get API allows you to retrieve the proximity of a coordinate to a \ngeofence that has been uploaded to the Data service. You can use the \n[Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) to upload \na geofence or set of fences. See [Geofencing GeoJSON data](https://docs.microsoft.com/en-us/azure/azure-maps/geofence-geojson) \nfor more details on the geofence data format. To query the proximity of a coordinate, you supply the location of the object you are tracking as well\nas the ID for the fence or set of fences, and the response will contain information about\nthe distance from the outer edge of the geofence. A negative value signifies that the \ncoordinate is inside of the fence while a positive value means that it is outside of the\nfence.

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

    This API can be used for a variety of scenarios that include things like asset tracking, fleet management, or setting up alerts for moving objects.\n\nThe API supports [integration with Event Grid](https://docs.microsoft.com/azure/azure-maps/azure-maps-event-grid-integration). The isAsync parameter is used to enable integration with Event Grid (disabled by default).", + "operationId": "Spatial_PostGeofence", + "x-ms-examples": { + "PostGeofence": { + "$ref": "./examples/spatial/Spatial_PostGeofence.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SpatialApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "deviceId", + "in": "query", + "description": "ID of the device", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SpatialLatitude" + }, + { + "$ref": "#/parameters/SpatialLongitude" + }, + { + "name": "z", + "in": "query", + "description": "The sea level in meter of the location being passed. If this parameter is presented, 2D extrusion geofencing is applied. Example: 200.", + "type": "number" + }, + { + "name": "userTime", + "in": "query", + "format": "date-time", + "description": "The user request time. If not presented in the request, the default value is DateTime.UtcNow.", + "type": "string" + }, + { + "name": "searchBuffer", + "in": "query", + "description": "The radius of the buffer around the geofence in meters that defines how far to search inside and outside the border of the fence against the coordinate that was provided when calculating the result. The minimum value is 0, and the maximum is 500. The default value is 50.", + "type": "number", + "minimum": 0, + "maximum": 500 + }, + { + "name": "isAsync", + "in": "query", + "description": "If true, the request will use async event mechanism; if false, the request will be synchronized and do not trigger any event. The default value is false.", + "type": "boolean" + }, + { + "$ref": "#/parameters/GeofenceMode" + }, + { + "$ref": "#/parameters/SearchGeofenceRequestBody" + } + ], + "responses": { + "200": { + "description": "OK The X-Correlation-id header value is present in an async call's response and the Event Grid event data. It helps correlate the async call’s response with the corresponding Event Grid event.", + "headers": { + "X-Correlation-id": { + "description": "Value present in an async call's response and the Event Grid event data. It helps correlate the async call’s response with the corresponding Event Grid event.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/GeofenceResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/spatial/buffer/{format}": { + "post": { + "description": "**Applies to**: S1 pricing tier.\n\nThis API returns a FeatureCollection where each Feature is a buffer around the corresponding indexed Feature of the input. The buffer could be either on the outside or the inside of the provided Feature, depending on the distance provided in the input. There must be either one distance provided per Feature in the FeatureCollection input, or if only one distance is provided, then that distance is applied to every Feature in the collection. The positive (or negative) buffer of a geometry is defined as the Minkowski sum (or difference) of the geometry with a circle of radius equal to the absolute value of the buffer distance. The buffer API always returns a polygonal result. The negative or zero-distance buffer of lines and points is always an empty polygon. The input may contain a collection of Point, MultiPoint, Polygon, MultiPolygon, LineString and MultiLineString. GeometryCollection will be ignored if provided.", + "operationId": "Spatial_PostBuffer", + "x-ms-examples": { + "PostBuffer": { + "$ref": "./examples/spatial/Spatial_PostBuffer.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SpatialApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "bufferRequestBody", + "in": "body", + "description": "The FeatureCollection and the list of distances (one per feature or one for all features).", + "required": true, + "schema": { + "$ref": "#/definitions/BufferRequestBody" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BufferResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "description": "**Applies to**: S1 pricing tier.\n\nThis API returns a FeatureCollection where each Feature is a buffer around the corresponding indexed Feature of the input. The buffer could be either on the outside or the inside of the provided Feature, depending on the distance provided in the input. There must be either one distance provided per Feature in the FeatureCollection input, or if only one distance is provided, then that distance is applied to every Feature in the collection. The positive (or negative) buffer of a geometry is defined as the Minkowski sum (or difference) of the geometry with a circle of radius equal to the absolute value of the buffer distance. The buffer API always returns a polygonal result. The negative or zero-distance buffer of lines and points is always an empty polygon. The input features are provided by a GeoJSON file which is uploaded via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and referenced by a unique udid. The GeoJSON file may contain a collection of Point, MultiPoint, Polygon, MultiPolygon, LineString and MultiLineString. GeometryCollection will be ignored if provided. \n\nTo test this API, you can upload the sample data from [Post Buffer API](https://docs.microsoft.com/en-us/rest/api/maps/spatial/postbuffer#examples) examples(Request Body without distances array) via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and replace the [udid] from the [sample request below](https://docs.microsoft.com/en-us/rest/api/maps/spatial/getbuffer#examples) with the udid returned by Data Upload API.", + "operationId": "Spatial_GetBuffer", + "x-ms-examples": { + "GetBuffer": { + "$ref": "./examples/spatial/Spatial_GetBuffer.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SpatialApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "$ref": "#/parameters/SpatialUploadUdid" + }, + { + "name": "distances", + "in": "query", + "description": "The list of distances (one per feature or one for all features), delimited by semicolons. For example, 12.34;-56.78. Positive distance will generate a buffer outside of the feature, whereas negative distance will generate a buffer inside of the feature. If the negative distance larger than the geometry itself, an empty polygon will be returned.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BufferResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/spatial/closestPoint/{format}": { + "post": { + "description": "**Applies to**: S1 pricing tier.\n\nThis API returns the closest point between a base point and a given set of target points. The set of target points is provided by user data in post request body. The user data may only contain a collection of Point geometry. MultiPoint or other geometries will be ignored if provided. The algorithm does not take into account routing or traffic. The maximum number of points accepted is 100,000. Information returned includes closest point latitude, longitude, and distance in meters from the closest point.", + "operationId": "Spatial_PostClosestPoint", + "x-ms-examples": { + "PostClosestPoint": { + "$ref": "./examples/spatial/Spatial_PostClosestPoint.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SpatialApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "$ref": "#/parameters/SpatialLatitude" + }, + { + "$ref": "#/parameters/SpatialLongitude" + }, + { + "name": "numberOfClosestPoints", + "in": "query", + "description": "The number of closest points expected from response. Default: 1, minimum: 1 and maximum: 50", + "type": "integer" + }, + { + "$ref": "#/parameters/ClosestPointRequestBody" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClosestPointResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "description": "**Applies to**: S1 pricing tier.\n\nThis API returns the closest point between a base point and a given set of points in the user uploaded data set identified by udid. The set of target points is provided by a GeoJSON file which is uploaded via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and referenced by a unique udid. The GeoJSON file may only contain a collection of Point geometry. MultiPoint or other geometries will be ignored if provided. The maximum number of points accepted is 100,000. The algorithm does not take into account routing or traffic. Information returned includes closest point latitude, longitude, and distance in meters from the closest point.\n\nTo test this API, you can upload the sample data from [Post Closest Point API](https://docs.microsoft.com/en-us/rest/api/maps/spatial/postclosestpoint#examples) examples(Request Body) via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and replace the [udid] from the [sample request below](https://docs.microsoft.com/en-us/rest/api/maps/spatial/getclosestpoint#examples) with the udid returned by Data Upload API.", + "operationId": "Spatial_GetClosestPoint", + "x-ms-examples": { + "GetClosestPoint": { + "$ref": "./examples/spatial/Spatial_GetClosestPoint.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SpatialApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "$ref": "#/parameters/SpatialUploadUdid" + }, + { + "$ref": "#/parameters/SpatialLatitude" + }, + { + "$ref": "#/parameters/SpatialLongitude" + }, + { + "name": "numberOfClosestPoints", + "in": "query", + "description": "The number of closest points expected from response. Default: 1, minimum: 1 and maximum: 50", + "type": "integer" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClosestPointResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/spatial/pointInPolygon/{format}": { + "post": { + "description": "**Applies to**: S1 pricing tier.\n\nThis API returns a boolean value indicating whether a point is inside a set of polygons. The user data may contain Polygon and MultiPolygon geometries, other geometries will be ignored if provided. If the point is inside or on the boundary of one of these polygons, the value returned is true. In all other cases, the value returned is false. When the point is inside multiple polygons, the result will give intersecting geometries section to show all valid geometries (referenced by geometryId) in user data. The maximum number of vertices accepted to form a Polygon is 10,000.", + "operationId": "Spatial_PostPointInPolygon", + "x-ms-examples": { + "PostPointInPolygon": { + "$ref": "./examples/spatial/Spatial_PostPointInPolygon.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SpatialApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "$ref": "#/parameters/SpatialLatitude" + }, + { + "$ref": "#/parameters/SpatialLongitude" + }, + { + "$ref": "#/parameters/PointInPolygonRequestBody" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PointInPolygonResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "description": "**Applies to**: S1 pricing tier.\n\nThis API returns a boolean value indicating whether a point is inside a set of polygons. The set of polygons is provided by a GeoJSON file which is uploaded via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and referenced by a unique udid. The GeoJSON file may contain Polygon and MultiPolygon geometries, other geometries will be ignored if provided. If the point is inside or on the boundary of one of these polygons, the value returned is true. In all other cases, the value returned is false. When the point is inside multiple polygons, the result will give intersecting geometries section to show all valid geometries(referenced by geometryId) in user data. The maximum number of vertices accepted to form a Polygon is 10,000.\n\n \nTo test this API, you can upload the sample data from [Post Point In Polygon API](https://docs.microsoft.com/en-us/rest/api/maps/spatial/postpointinpolygon#examples) examples(Request Body) via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and replace the [udid] from the [sample request below](https://docs.microsoft.com/en-us/rest/api/maps/spatial/getpointinpolygon#examples) with the udid returned by Data Upload API.", + "operationId": "Spatial_GetPointInPolygon", + "x-ms-examples": { + "GetPointInPolygon": { + "$ref": "./examples/spatial/Spatial_GetPointInPolygon.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SpatialApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "$ref": "#/parameters/SpatialUploadUdid" + }, + { + "$ref": "#/parameters/SpatialLatitude" + }, + { + "$ref": "#/parameters/SpatialLongitude" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PointInPolygonResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/spatial/greatCircleDistance/{format}": { + "get": { + "description": "**Applies to**: S1 pricing tier.\n\nThis API will return the great-circle or shortest distance between two points on the surface of a sphere, measured along the surface of the sphere. This differs from calculating a straight line through the sphere's interior. This method is helpful for estimating travel distances for airplanes by calculating the shortest distance between airports.", + "operationId": "Spatial_GetGreatCircleDistance", + "x-ms-examples": { + "GetGreatCircleDistance": { + "$ref": "./examples/spatial/Spatial_GetGreatCircleDistance.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SpatialApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "query", + "in": "query", + "description": "The Coordinates through which the distance is calculated, delimited by a colon. Two coordinates are required. The first one is the source point coordinate and the last is the target point coordinate. For example, 47.622942,122.316456:57.673988,127.121513", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GreatCircleDistanceResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + } + }, + "definitions": { + "SpatialCoordinate": { + "description": "A location represented as a latitude and longitude", + "type": "object", + "properties": { + "lat": { + "description": "Latitude property", + "type": "number", + "format": "double", + "readOnly": true + }, + "lon": { + "description": "Longitude property", + "type": "number", + "format": "double", + "readOnly": true + } + } + }, + "GeofenceGeometry": { + "description": "The geofencing geometry.", + "type": "object", + "readOnly": true, + "properties": { + "deviceId": { + "description": "ID of the device.", + "type": "string", + "readOnly": true + }, + "udId": { + "description": "The unique id returned from [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) after uploading a valid GeoJSON FeatureCollection object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.", + "type": "string", + "readOnly": true + }, + "geometryId": { + "description": "The unique id identifies a geometry.", + "type": "string", + "readOnly": true + }, + "distance": { + "description": "Distance from the coordinate to the closest border of the geofence. Positive means the coordinate is outside of the geofence. If the coordinate is outside of the geofence, but more than the value of searchBuffer away from the closest geofence border, then the value is 999. Negative means the coordinate is inside of the geofence. If the coordinate is inside the polygon, but more than the value of searchBuffer away from the closest geofencing border, then the value is -999. A value of 999 means that there is great confidence the coordinate is well outside the geofence. A value of -999 means that there is great confidence the coordinate is well within the geofence.", + "type": "number", + "readOnly": true + }, + "nearestLat": { + "description": "Latitude of the nearest point of the geometry.", + "type": "number", + "readOnly": true + }, + "nearestLon": { + "description": "Longitude of the nearest point of the geometry.", + "type": "number", + "readOnly": true + }, + "nearestZ": { + "description": "Sea level in meter of the nearest point on the 2D extrusion geometry. This will only be presented in response when value is provided for 'zInMeter' in the request.", + "type": "number", + "readOnly": true + } + } + }, + "GeofenceResponse": { + "description": "This object is returned from a geofence proximity call.", + "type": "object", + "properties": { + "geometries": { + "description": "Lists the fence geometries that contain the coordinate position or overlap the searchBuffer around the position.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/GeofenceGeometry" + } + }, + "expiredGeofenceGeometryId": { + "description": "Lists of the geometry ID of the geofence which is expired relative to the user time in the request.", + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } + }, + "invalidPeriodGeofenceGeometryId": { + "description": "Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.", + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } + }, + "isEventPublished": { + "description": "True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber. This will only be presented in response when 'isAsync' query parameter is set to true.", + "type": "boolean", + "readOnly": true + } + } + }, + "BufferRequestBody": { + "description": "An object with a FeatureCollection and a list of distances. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.", + "type": "object", + "properties": { + "geometries": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonFeatureCollection" + }, + "distances": { + "description": "List of the distances to compute the buffer for, one-to-one per Feature in the collection, or one for all Features in the collection.", + "type": "array", + "items": { + "type": "number" + } + } + } + }, + "BufferResponse": { + "description": "This object is returned from a successful Spatial Buffer call.", + "type": "object", + "properties": { + "summary": { + "description": "Summary of the call.", + "type": "object", + "readOnly": true, + "properties": { + "udid": { + "description": "The udid for the user data if one exists", + "type": "string", + "readOnly": true + }, + "information": { + "description": "The information about what happened during the call.", + "type": "string", + "readOnly": true + } + } + }, + "result": { + "description": "The FeatureCollection of buffers for the input.", + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonFeatureCollection" + } + } + }, + "ClosestPointResponse": { + "description": "This object is returned from a successful Spatial Closest Point call", + "type": "object", + "properties": { + "summary": { + "$ref": "#/definitions/ClosestPointSummary" + }, + "result": { + "$ref": "#/definitions/ClosestPointResult" + } + } + }, + "ClosestPointSummary": { + "description": "Closest Point Summary object", + "type": "object", + "readOnly": true, + "properties": { + "sourcePoint": { + "$ref": "#/definitions/SpatialCoordinate" + }, + "udid": { + "description": "A unique data id (udid) for the uploaded content", + "type": "string", + "readOnly": true + }, + "information": { + "description": "Processing information", + "type": "string", + "readOnly": true + } + } + }, + "ClosestPointResult": { + "description": "Closest Point Result Array", + "type": "array", + "items": { + "$ref": "#/definitions/ClosestPointResultEntry" + } + }, + "ClosestPointResultEntry": { + "description": "Closest Point Result Entry Object", + "type": "object", + "readOnly": true, + "properties": { + "distanceInMeters": { + "description": "The distance in meters from the source point to the closest point", + "type": "number", + "readOnly": true + }, + "position": { + "$ref": "#/definitions/SpatialCoordinate" + }, + "geometryId": { + "description": "The unique id identifies a geometry", + "type": "string", + "readOnly": true + } + } + }, + "PointInPolygonResponse": { + "description": "Returns true if point is within the polygon, false otherwise", + "type": "object", + "properties": { + "summary": { + "$ref": "#/definitions/PointInPolygonSummary" + }, + "result": { + "$ref": "#/definitions/PointInPolygonResult" + } + } + }, + "PointInPolygonSummary": { + "description": "Point In Polygon Summary object", + "type": "object", + "readOnly": true, + "properties": { + "sourcePoint": { + "$ref": "#/definitions/SpatialCoordinate" + }, + "udid": { + "description": "A unique data id (udid) for the uploaded content. Udid is not applicable for POST spatial operations(set to null)", + "type": "string", + "readOnly": true + }, + "information": { + "description": "Processing information", + "type": "string", + "readOnly": true + } + } + }, + "PointInPolygonResult": { + "description": "Point In Polygon Result Object", + "type": "object", + "properties": { + "pointInPolygons": { + "description": "Point In Polygons Property", + "type": "boolean", + "readOnly": true + }, + "intersectingGeometries": { + "description": "Geometries array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/GeometryId" + } + } + } + }, + "GeometryId": { + "description": "The Spatial geometry", + "type": "string", + "readOnly": true + }, + "GreatCircleDistanceResponse": { + "description": "This object is returned from a successful Great Circle Distance call", + "type": "object", + "properties": { + "summary": { + "description": "Summary object", + "type": "object", + "readOnly": true, + "properties": { + "sourcePoint": { + "$ref": "#/definitions/SpatialCoordinate" + }, + "targetPoint": { + "$ref": "#/definitions/SpatialCoordinate" + } + } + }, + "result": { + "description": "Result Object", + "type": "object", + "readOnly": true, + "properties": { + "distanceInMeters": { + "description": "The great circle distance in meters from the source point to the target point", + "type": "number", + "readOnly": true + } + } + } + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/alias.json b/specification/maps/data-plane/Creator/preview/2.0/alias.json new file mode 100644 index 000000000000..5072e87c483b --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/alias.json @@ -0,0 +1,315 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Alias Service", + "version": "2.0", + "description": "APIs for managing aliases in Azure Maps." + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{geography}.atlas.microsoft.com", + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" + } + ] + }, + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "AzureKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "AzureKey": [] + } + ], + "responses": {}, + "parameters": { + "AliasApiVersionV2": { + "name": "api-version", + "description": "Version number of Azure Maps API.", + "type": "string", + "in": "query", + "required": true, + "default": "2.0", + "x-ms-parameter-location": "client" + }, + "CreateCreatorDataItemId": { + "name": "creatorDataItemId", + "description": "The unique id that references a creator data item to be aliased.", + "type": "string", + "in": "query", + "x-ms-parameter-location": "method" + }, + "AssignCreatorDataItemId": { + "name": "creatorDataItemId", + "description": "The unique id that references a creator data item to be aliased.", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "method" + }, + "AliasId": { + "name": "aliasId", + "description": "The unique id that references an existing alias.", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/aliases": { + "post": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to create an alias. You can also assign the alias during the create request. An alias can reference an ID generated by a creator service, but cannot reference another alias ID.\n\n### Submit Create Request\n\nTo create your alias, you will use a `POST` request. If you would like to assign the alias during the creation, you will pass the `resourceId` query parameter.\n\n### Create Alias Response\n\nThe Create API returns a HTTP `201 Created` response with the alias resource in the body.\n\nA sample response from creating an alias:\n\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", + "operationId": "Alias_Create", + "x-ms-examples": { + "Create an alias that does not reference any resource": { + "$ref": "./examples/alias/Alias_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/AliasApiVersionV2" + }, + { + "$ref": "#/parameters/CreateCreatorDataItemId" + } + ], + "responses": { + "201": { + "description": "Content created successfully. The response body contains the newly created alias id `aliasId`.", + "schema": { + "$ref": "#/definitions/AliasesCreateResponse" + }, + "headers": { + "Access-Control-Expose-Headers": { + "type": "string", + "description": "The list of response headers that can be read by the client." + } + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a list of all previously successfully created aliases.\n\n### Submit List Request\n\nTo list all your aliases, you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe List API returns the complete list of all aliases in `json` format. The response contains the following details for each alias resource:\n > createdTimestamp - The timestamp that the alias was created. Format yyyy-MM-ddTHH:mm:ss.sssZ\n > aliasId - The id for the alias.\n > creatorDataItemId - The id for the creator data item that this alias references (could be null if the alias has not been assigned).\n > lastUpdatedTimestamp - The last time the alias was assigned to a resource. Format yyyy-MM-ddTHH:mm:ss.sssZ\n\nA sample response returning 2 alias resources:\n\n```json\n{\n \"aliases\": [\n {\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n },\n {\n \"createdTimestamp\": \"2020-02-18T19:53:33.123Z\",\n \"aliasId\": \"1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6\",\n \"creatorDataItemId\": null,\n \"lastUpdatedTimestamp\": \"2020-02-18T19:53:33.123Z\"\n }\n ]\n}\n```", + "operationId": "Alias_List", + "x-ms-examples": { + "List all the previously created aliases": { + "$ref": "./examples/alias/Alias_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/AliasApiVersionV2" + } + ], + "x-ms-pageable": { + "itemName": "aliases", + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "List alias request completed successfully. The response body contains a list of all the previously created aliases.", + "schema": { + "$ref": "#/definitions/AliasListResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/aliases/{aliasId}": { + "put": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to assign an alias to reference a resource.\n\n### Submit Assign Request\n\nTo assign your alias to a resource, you will use a `PUT` request with the `aliasId` in the path and the `creatorDataItemId` passed as a query parameter.\n\n### Assign Alias Response\n\nThe Assign API returns a HTTP `200 OK` response with the updated alias resource in the body, if the alias was assigned successfully. A sample of the assign response is\n\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", + "operationId": "Alias_Assign", + "x-ms-examples": { + "Assign an alias to a resource": { + "$ref": "./examples/alias/Alias_Assign.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/AliasId" + }, + { + "$ref": "#/parameters/AliasApiVersionV2" + }, + { + "$ref": "#/parameters/AssignCreatorDataItemId" + } + ], + "responses": { + "200": { + "description": "Alias was assigned successfully.", + "schema": { + "$ref": "#/definitions/AliasListItem" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "delete": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to delete a previously created alias. You can also use this API to delete old/unused aliases to create space for new content.This API does not delete the references resource, only the alias referencing the resource.\n\n### Submit Delete Request\n\nTo delete your alias you will issue a `DELETE` request where the path will contain the `aliasId` of the alias to delete.\n\n### Delete Alias Response\n\nThe Delete API returns a HTTP `204 No Content` response with an empty body, if the alias was deleted successfully.", + "operationId": "Alias_Delete", + "x-ms-examples": { + "Delete previously created alias": { + "$ref": "./examples/alias/Alias_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/AliasId" + }, + { + "$ref": "#/parameters/AliasApiVersionV2" + } + ], + "responses": { + "204": { + "description": "Alias delete request completed successfully. The content for `aliasId` was deleted on the server." + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch the details of a previously created alias.\n\n### Submit Get Details Request\n\nTo get the details of your alias, you will issue a `GET` request with the `aliasId` in the path.\n\n### Get Details Response\n\nThe Get Details API returns the previously created alias in `json` format. The response contains the following details for the alias resource:\n > createdTimestamp - The timestamp that the alias was created.\n > aliasId - The id for the alias.\n > creatorDataItemId - The id for the creator data item that this alias references (could be null if the alias has not been assigned).\n > lastUpdatedTimestamp - The last time the alias was assigned to a resource.\n\nHere's a sample response:\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", + "operationId": "Alias_GetDetails", + "x-ms-examples": { + "Get a previously created alias": { + "$ref": "./examples/alias/Alias_GetDetails.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/AliasId" + }, + { + "$ref": "#/parameters/AliasApiVersionV2" + } + ], + "responses": { + "200": { + "description": "Get alias request completed successfully. The response body contains the previously created alias.", + "schema": { + "$ref": "#/definitions/AliasListItem" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + } + }, + "definitions": { + "AliasesCreateResponse": { + "description": "The response model for the Alias Create API for the case when the alias was successfully created.", + "type": "object", + "properties": { + "createdTimestamp": { + "description": "The created timestamp for the alias.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "aliasId": { + "description": "The id for the alias.", + "type": "string", + "readOnly": true + }, + "creatorDataItemId": { + "description": "The id for the creator data item that this alias references (could be null if the alias has not been assigned).", + "type": "string", + "readOnly": true + }, + "lastUpdatedTimestamp": { + "description": "The timestamp of the last time the alias was assigned.", + "type": "string", + "format": "date-time", + "readOnly": true + } + } + }, + "AliasListResponse": { + "description": "The response model for the List API. Returns a list of all the previously created aliases.", + "type": "object", + "properties": { + "aliases": { + "description": "A list of all the previously created aliases.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AliasListItem" + } + }, + "nextLink": { + "description": "If present, the location of the next page of data.", + "type": "string", + "readOnly": true + } + } + }, + "AliasListItem": { + "description": "Detailed information for the alias.", + "type": "object", + "properties": { + "createdTimestamp": { + "description": "The created timestamp for the alias.", + "type": "string", + "readOnly": true + }, + "aliasId": { + "description": "The id for the alias.", + "type": "string", + "readOnly": true + }, + "creatorDataItemId": { + "description": "The id for the creator data item that this alias references (could be null if the alias has not been assigned).", + "type": "string", + "x-nullable": true, + "readOnly": true + }, + "lastUpdatedTimestamp": { + "description": "The timestamp of the last time the alias was assigned.", + "type": "string", + "format": "date-time", + "readOnly": true + } + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/data.json b/specification/maps/data-plane/Creator/preview/2.0/data.json new file mode 100644 index 000000000000..b184f4d448b7 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/data.json @@ -0,0 +1,414 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Data Service", + "version": "2.0", + "description": "APIs for uploading map data to Azure Maps." + }, + "x-ms-parameterized-host": { + "hostTemplate": "{geography}.atlas.microsoft.com", + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "AzureKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "AzureKey": [] + } + ], + "responses": {}, + "parameters": { + "DataApiVersionV2": { + "name": "api-version", + "description": "Version number of Azure Maps API.", + "type": "string", + "in": "query", + "required": true, + "default": "2.0", + "x-ms-parameter-location": "client" + }, + "UploadDataFormat": { + "name": "dataFormat", + "x-ms-client-name": "UploadDataFormat", + "description": "Data format of the content being uploaded.", + "type": "string", + "in": "query", + "required": true, + "enum": [ + "geojson", + "zip", + "dwgzippackage" + ], + "x-ms-enum": { + "name": "UploadDataFormat", + "modelAsString": true, + "values": [ + { + "value": "geojson", + "description": "[GeoJSON](https://tools.ietf.org/html/rfc7946) is a JSON based geospatial data interchange format." + }, + { + "value": "zip", + "description": "Compressed data format." + }, + { + "value": "dwgzippackage", + "description": "ZIP package containing DWG file." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "UniqueDataId": { + "name": "udid", + "x-ms-client-name": "UniqueDataId", + "description": "The unique data id for the content. The `udid` must have been obtained from a successful [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data%20v2/uploadpreview) call.", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "UploadDataDescription": { + "name": "description", + "x-ms-client-name": "UploadDataDescription", + "description": "The description to be given to the upload.", + "type": "string", + "in": "query", + "x-ms-parameter-location": "method" + }, + "DataUploadOperationId": { + "name": "operationId", + "type": "string", + "in": "path", + "description": "The ID to query the status for the data upload request.", + "required": true, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/mapData": { + "post": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Data Upload API allows the caller to upload data content to the Azure Maps service.\nYou can use this API in a scenario like uploading a collection of Geofences in `GeoJSON` \nformat, for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial).\n\n## Submit Upload Request\n\nTo upload your content you will use a `POST` request. The request body will contain the data to upload. The \n`dataFormat` query parameter will contain the format for the data, the `dataSharingLevel` query parameter \ncan contain the sharing level for the data. The `Content-Type` header will be set to the content type of the \ndata.\n\nFor example, to upload a collection of geofences in `GeoJSON` format, set the request body to the geofence \ncontent. Set the `dataFormat` query parameter to _geojson_, and set the `Content-Type` header to either one \nof the following media types:\n\n- `application/json`\n- `application/vnd.geo+json`\n- `application/octet-stream`\n\nHere's a sample request body for uploading a simple Geofence represented as a circle geometry using a center \npoint and a radius. The sample below is in `GeoJSON`:\n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```\n\nThe Data Upload API performs a \n[long-running request](https://aka.ms/am-creator-lrt-v2).\n\n## Data Upload Limits\n\nPlease, be aware that currently every Azure Maps account has a [data storage limit](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#azure-maps-limits). \nOnce the storage limit is reached, all the new upload API calls will return a `409 Conflict` http error response. \nYou can always use the [Data Delete API](https://docs.microsoft.com/rest/api/maps/data%20v2/deletepreview) to \ndelete old/unused content and create space for new uploads.", + "operationId": "Data_UploadPreview", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Upload GeoJSON data containing geometries that represent a collection of geofences": { + "$ref": "./examples/data/Data_Upload.json" + } + }, + "consumes": [ + "application/json", + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/DataApiVersionV2" + }, + { + "$ref": "#/parameters/UploadDataDescription" + }, + { + "$ref": "#/parameters/UploadDataFormat" + }, + { + "name": "UploadContent", + "in": "body", + "description": "The content to upload.", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" + }, + "202": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/202AsyncV2" + }, + "409": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/409StorageLimit" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to fetch a list of all content uploaded previously using the [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data%20v2/uploadpreview). \n\n\n### Submit List Request\n\nTo list all your map data content you will issue a `GET` request with no additional parameters.\n\n\n### List Data Response\n\nThe Data List API returns the complete list of all data in `json` format. The response contains the following details for each data resource:\n\n > udid - The unique data id for the data resource.\n\n > location - The location of the data resource. Execute a HTTP `GET` on this location to download the data.\n\n\nHere's a sample response returning the `udid` and `location` of 3 data resources: \n\n
    \n\n```json\n{\n \"mapDataList\": \n [\n {\n \"udid\": \"9a1288fa-1858-4a3b-b68d-13a8j5af7d7c\",\n \"location\": \"https://us.atlas.microsoft.com/mapData/9a1288fa-1858-4a3b-b68d-13a8j5af7d7c?api-version=1.0\",\n \"sizeInBytes\": 29920,\n \"uploadStatus\": \"Completed\"\n },\n {\n \"udid\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"location\": \"https://us.atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0\",\n \"sizeInBytes\": 1339,\n \"uploadStatus\": \"Completed\"\n },\n {\n \"udid\": \"7c1288fa-2058-4a1b-b68f-13a6h5af7d7c\",\n \"location\": \"https://us.atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0\",\n \"sizeInBytes\": 1650,\n \"uploadStatus\": \"Pending\"\n }]\n}\n```\n\n
    ", + "operationId": "Data_ListPreview", + "x-ms-examples": { + "List all the previously uploaded data": { + "$ref": "./examples/data/Data_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/DataApiVersionV2" + } + ], + "responses": { + "200": { + "description": "List data request completed successfully. The response body contains a list of all the previously uploaded data.", + "schema": { + "$ref": "#/definitions/MapDataListResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/mapData/{udid}": { + "put": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Data Update API allows the caller to update a previously uploaded data content.\n\nYou can use this API in a scenario like adding or removing geofences to or from an existing collection of geofences. \nGeofences are uploaded using the [Data Upload API](https://docs.microsoft.com/rest/api/maps/data%20v2/uploadpreview), for \nuse in the [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial).\n\nPlease note that the Update API will *replace* and *override* the existing data content.\n\n## Submit Update Request\n\nTo update your content you will use a `PUT` request. The request body will contain the new data that will replace \nthe existing data. The `Content-Type` header will be set to the content type of the data, and the path will contain \nthe `udid` of the data to be update.\n\nFor example, to update a collection of geofences that were previously uploaded using the Upload API, place the new \ngeofence content in the request body. Set the `udid` parameter in the path to the `udid` of the data received \npreviously in the upload API response. And set the `Content-Type` header to one of the following media types:\n\n- `application/json`\n- `application/vnd.geo+json`\n- `application/octet-stream`\n\nHere's a sample request body for updating a simple Geofence. It's represented as a circle geometry using a center \npoint and a radius. The sample below is in `GeoJSON`:\n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```\n\nThe previously uploaded geofence had a radius of 100m. The above request will update it to 500m.\n\nThe Data Update API performs a \n[long-running request](https://aka.ms/am-creator-lrt-v2).\n\n## Data Update Limits\n\nPlease, be aware that currently every Azure Maps account has a [data storage limit](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#azure-maps-limits). \nOnce the storage limit is reached, all the new upload API calls will return a `409 Conflict` http error response. \nYou can always use the [Data Delete API](https://docs.microsoft.com/rest/api/maps/data%20v2/deletepreview) to \ndelete old/unused content and create space for new uploads.", + "operationId": "Data_UpdatePreview", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Update previously uploaded GeoJSON data containing geometries that represent a collection of geofences": { + "$ref": "./examples/data/Data_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/DataApiVersionV2" + }, + { + "$ref": "#/parameters/UniqueDataId" + }, + { + "$ref": "#/parameters/UploadDataDescription" + }, + { + "name": "UpdateContent", + "in": "body", + "description": "The new content that will update/replace the previously uploaded content.", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" + }, + "202": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/202AsyncV2" + }, + "409": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/409StorageLimit" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to download a previously uploaded data content.
    \nYou can use this API in a scenario like downloading an existing collection of geofences uploaded previously using the [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data%20v2/uploadpreview) for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/en-us/rest/api/maps/spatial). \n\n\n### Submit Download Request\n\nTo download your content you will use a `GET` request where the path will contain the `udid` of the data to download. Optionally, you can also pass in an `Accept` header to specify a preference for the `Content-Type` of the data response.
    \nFor example, to download a collection of geofences previously uploaded using the Upload API, set the `udid` parameter in the path to the `udid` of the data received previously in the upload API response and set the `Accept` header to either one of the following media types: \n \n - `application/json`\n - `application/vnd.geo+json`\n - `application/octet-stream`\n\n\n### Download Data Response\n\nThe Download API will return a HTTP `200 OK` response if the data resource with the passed-in `udid` is found, where the response body will contain the content of the data resource.
    \nA HTTP `400 Bad Request` error response will be returned if the data resource with the passed-in `udid` is not found.
    \n\nHere's a sample response body for a simple geofence represented in `GeoJSON` uploaded previously using the Upload API:\n
    \n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```", + "operationId": "Data_DownloadPreview", + "x-ms-examples": { + "Download previously uploaded GeoJSON data containing geometries that represent a collection of geofences": { + "$ref": "./examples/data/Data_Download.json" + } + }, + "produces": [ + "application/json", + "application/vnd.geo+json", + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/DataApiVersionV2" + }, + { + "$ref": "#/parameters/UniqueDataId" + } + ], + "responses": { + "200": { + "description": "Data download request completed successfully. The response body will contain the content for the passed in `udid`.", + "schema": { + "type": "file" + }, + "headers": { + "Content-Type": { + "type": "string", + "description": "The content-type for the Download API response." + } + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "delete": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to delete a previously uploaded data content.
    \nYou can use this API in a scenario like removing geofences previously uploaded using the [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data%20v2/uploadpreview) for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/en-us/rest/api/maps/spatial). You can also use this API to delete old/unused uploaded content and create space for new content.\n\n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `udid` of the data to delete.
    \nFor example, to delete a collection of geofences previously uploaded using the Upload API, set the `udid` parameter in the path to the `udid` of the data received previously in the upload API response. \n\n\n### Delete Data Response\n\nThe Data Delete API returns a HTTP `204 No Content` response with an empty body, if the data resource was deleted successfully.
    \nA HTTP `400 Bad Request` error response will be returned if the data resource with the passed-in `udid` is not found. ", + "operationId": "Data_DeletePreview", + "x-ms-examples": { + "Delete previously uploaded GeoJSON data containing geometries that represent a collection of geofences": { + "$ref": "./examples/data/Data_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/DataApiVersionV2" + }, + { + "$ref": "#/parameters/UniqueDataId" + } + ], + "responses": { + "204": { + "description": "Data delete request completed successfully. The content for `udid` was deleted on the server." + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/mapData/operations/{operationId}": { + "get": { + "description": "This path will be obtained from a call to POST /mapData. While in progress, an http200 will be returned with no extra headers - followed by an http200 with Resource-Location header once completed.", + "operationId": "Data_GetOperationPreview", + "x-ms-examples": { + "Get the status of an operation which is still running": { + "$ref": "./examples/data/Data_GetOperationStillRunning.json" + }, + "Get the status of an operation which has finished successfully": { + "$ref": "./examples/data/Data_GetOperation.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/DataApiVersionV2" + }, + { + "$ref": "#/parameters/DataUploadOperationId" + } + ], + "responses": { + "200": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + } + }, + "definitions": { + "MapDataDownloadResponse": { + "description": "The response model for the Data Download API. The response body will contain the content for the passed in `udid`.", + "type": "object" + }, + "MapDataListResponse": { + "description": "The response model for the Data List API. Returns a list of all the previously uploaded data.", + "type": "object", + "properties": { + "mapDataList": { + "description": "A list of all the previously uploaded data.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/MapDataDetailInfo" + } + } + } + }, + "MapDataDetailInfo": { + "description": "Detail information for the data.", + "type": "object", + "properties": { + "udid": { + "description": "The unique data id for the data.", + "type": "string", + "readOnly": true + }, + "location": { + "description": "The location of the data. Execute a HTTP `GET` on this location to download the data.", + "type": "string", + "readOnly": true + }, + "sizeInBytes": { + "description": "The size of the content in bytes.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "uploadStatus": { + "description": "The current upload status of the content.", + "type": "string", + "readOnly": true + }, + "dataFormat": { + "description": "The current data format.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The current description.", + "type": "string", + "readOnly": true + } + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/dataset.json b/specification/maps/data-plane/Creator/preview/2.0/dataset.json new file mode 100644 index 000000000000..463388b43673 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/dataset.json @@ -0,0 +1,329 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Dataset Service", + "version": "2.0", + "description": "APIs for managing datasets from uploaded data in Azure Maps." + }, + "x-ms-parameterized-host": { + "hostTemplate": "{geography}.atlas.microsoft.com", + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "AzureKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "AzureKey": [] + } + ], + "responses": {}, + "parameters": { + "DatasetApiVersionV2": { + "name": "api-version", + "description": "Version number of Azure Maps API.", + "type": "string", + "in": "query", + "required": true, + "default": "2.0", + "x-ms-parameter-location": "client" + }, + "ConversionIdQuery": { + "name": "conversionId", + "description": "The unique ID used to create the dataset. The `conversionId` must have been obtained from a successful call to the Conversion Service Convert API and may be provided with multiple query parameters with same name (if more than one is provided).", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "method" + }, + "DescriptionDataset": { + "name": "description", + "x-ms-client-name": "DescriptionDataset", + "description": "The description to be given to the dataset.", + "type": "string", + "in": "query", + "x-ms-parameter-location": "method" + }, + "DatasetId": { + "name": "datasetId", + "type": "string", + "in": "path", + "description": "The identifier for the dataset to query from.", + "required": true, + "x-ms-parameter-location": "method" + }, + "AppendDatasetId": { + "name": "datasetId", + "type": "string", + "in": "query", + "description": "The ID for the dataset to append with. The dataset must originate from a previous dataset creation call that matches the datasetId", + "x-ms-parameter-location": "method" + }, + "DatasetOperationId": { + "name": "operationId", + "type": "string", + "in": "path", + "description": "The ID to query the status for the dataset create/import request.", + "required": true, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/datasets": { + "post": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n This API allows the caller to create a dataset from data that was uploaded to the Azure Maps Data Service and converted using the Azure Maps Conversion Service.\n\nYou can use this API in a scenario like uploading a DWG zip package for a building, converting the zip package using the Azure Maps Conversion Service, and creating a dataset from the converted zip package. The created dataset can be used to create tilesets using the Azure Maps Tileset Service and can be queried via the Azure Maps WFS Service.\n\n### Submit Create Request\n\nTo create your dataset, you will use a `POST` request where the `conversionId` query parameter is an ID that represents the converted DWG zip package, the `datasetId` parameter will be the ID of a previously created dataset to append with the current dataset and, optionally, the `description` query parameter will contain a description (if description is not provided a default description will be given).\n\nThe Create API is a [long-running request](https://aka.ms/am-creator-lrt-v2).", + "operationId": "Dataset_Create", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Create dataset from a converted CAD file provided by conversionId": { + "$ref": "./examples/dataset/Dataset_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/DatasetApiVersionV2" + }, + { + "$ref": "#/parameters/ConversionIdQuery" + }, + { + "$ref": "#/parameters/AppendDatasetId" + }, + { + "$ref": "#/parameters/DescriptionDataset" + } + ], + "responses": { + "200": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" + }, + "202": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/202AsyncV2" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a list of all previously successfully created datasets.\n\n### Submit List Request\n\nTo list all your datasets, you will issue a `GET` request with no additional parameters.\n\n\n### List Data Response\n\nThe List API returns the complete list of all datasets in `json` format. The response contains the following fields (if they are not null or empty):\n> created - The timestamp the dataset was created.\n> datasetId - The id for the dataset.\n> description - The description for the dataset.\n> datasetSources - The source data that was used when the create request was issued.\n> ontology - The source [ontology](https://docs.microsoft.com/en-us/azure/azure-maps/creator-facility-ontology) that was used in the conversion service for the input data.
    \n\nThe `datasetSources` describes the source data that was used when the create request was issued and contains the following elements (if they are not null or empty):\n\n> conversionIds - The list of `conversionId` (null if none were provided).\n> appendDatasetId - The `datasetId` that was used for an append operation (null if none was used).\n>featureCounts - The counts for each feature type in the dataset.
    \n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, `datasetSources`, and `ontology` of 3 dataset resources:\n\n\n```json\n{\n \"datasets\": [\n {\n \"timestamp\": \"2020-01-01T22:50:48.123Z\",\n \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n \"description\": \"Some description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ], },\n \"ontology\": \"facility-2.0\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n },\n {\n \"timestamp\": \"2020-01-01T22:57:53.123Z\",\n \"datasetId\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"description\": \"Create from upload '0c1288fa-2058-4a1b-b68d-13a5f5af7d7c'.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"0c1288fa-2058-4a1b-b68d-13a5f5af7d7c\"\n ],\n \"appendDatasetId\": \"46d1edb6-d29e-4786-9589-dbd4efd7a977\"\n },\n \"ontology\": \"facility-2.0\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n }\n ]\n}\n```", + "operationId": "Dataset_List", + "x-ms-examples": { + "List all the previously created datasets": { + "$ref": "./examples/dataset/Dataset_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/DatasetApiVersionV2" + } + ], + "x-ms-pageable": { + "itemName": "datasets", + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "The dataset request completed successfully. The response body contains the previously created dataset.", + "schema": { + "$ref": "#/definitions/DatasetListResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/datasets/{datasetId}": { + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a previously successfully created dataset.\n\n### Submit Get Details Request\n\nTo get the details for a previously created dataset, you will issue a `GET` request with the `datasetId` in the path.\n\n### Get Details Response\n\nThe Get Details API returns the details for a dataset in `json` format. The response contains the following fields (if they are not null or empty):\n> created - The timestamp the dataset was created.\n> datasetId - The id for the dataset.\n> description - The description for the dataset.\n> datasetSources - The source data that was used when the create request was issued.\n> ontology - The source [ontology](https://docs.microsoft.com/en-us/azure/azure-maps/creator-facility-ontology) that was used in the conversion service for the input data.
    \n\nThe `datasetSources` describes the source data that was used when the create request was issued and contains the following elements (if they are not null or empty):\n> conversionIds - The list of `conversionId` (null if none were provided).\n> appendDatasetId - The `datasetId` that was used for an append operation (null if none was used).\n>featureCounts - The counts for each feature type in the dataset.
    \n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, `datasetSources`, and `ontology` of a dataset resource:\n\n```json\n{\n \"timestamp\": \"2020-01-01T22:50:48.123Z\",\n \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n \"description\": \"Some description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ],\n },\n \"ontology\": \"facility-2.0\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n }\n```", + "operationId": "Dataset_Get", + "x-ms-examples": { + "Get details for a previously created dataset": { + "$ref": "./examples/dataset/Dataset_GetDetails.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/DatasetId" + }, + { + "$ref": "#/parameters/DatasetApiVersionV2" + } + ], + "responses": { + "200": { + "description": "The get dataset request completed successfully.", + "schema": { + "$ref": "#/definitions/DatasetDetailInfo" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "delete": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nYou can also use this API to delete old/unused datasets to create space for new Creator content.\n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `datasetId` of the dataset to delete.", + "operationId": "Dataset_Delete", + "x-ms-examples": { + "Delete previously created dataset": { + "$ref": "./examples/dataset/Dataset_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/DatasetApiVersionV2" + }, + { + "$ref": "#/parameters/DatasetId" + } + ], + "responses": { + "204": { + "description": "The dataset delete request completed successfully. The resource referenced by the `datasetId` was deleted from the server." + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/datasets/operations/{operationId}": { + "get": { + "description": "This API allows the caller to view the current progress of a dataset operation and the path is obtained from a call to the Create API.\n\n### Submit Operations Request\n\nTo view the current progress of a dataset operation, you will use a `GET` request where the `operationId` given the path is the ID that represents the operation.\n\n### Operation Response\n\nWhile in progress, a `200-OK` http status code will be returned with no extra headers. If the operation succeeds, a `200-OK` http status code with Resource-Location header will be returned.", + "operationId": "Dataset_GetOperation", + "x-ms-examples": { + "Get the status of an operation which is still running": { + "$ref": "./examples/dataset/Dataset_GetOperationStillRunning.json" + }, + "Get the status of an operation which has finished successfully": { + "$ref": "./examples/dataset/Dataset_GetOperation.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/DatasetApiVersionV2" + }, + { + "$ref": "#/parameters/DatasetOperationId" + } + ], + "responses": { + "200": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + } + }, + "definitions": { + "DatasetListResponse": { + "description": "The response model for the Dataset List API. The response body will contain a list of all the previously created datasets.", + "type": "object", + "properties": { + "datasets": { + "description": "A list of all the previously created datasets.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/DatasetDetailInfo" + } + }, + "nextLink": { + "description": "If present, the location of the next page of data.", + "type": "string", + "readOnly": true + } + } + }, + "DatasetDetailInfo": { + "description": "Detail information for the dataset.", + "type": "object", + "properties": { + "created": { + "description": "The created timestamp for the dataset.", + "type": "string", + "readOnly": true + }, + "datasetId": { + "description": "The id for the dataset.", + "type": "string", + "readOnly": true + }, + "ontology": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" + }, + "description": { + "description": "The description for the dataset.", + "type": "string", + "readOnly": true + }, + "datasetSources": { + "$ref": "#/definitions/DatasetSources" + }, + "featureCounts": { + "description": "The feature counts for the dataset.", + "type": "object", + "readOnly": true + } + } + }, + "DatasetSources": { + "description": "Information about the details of the create request for the dataset.", + "type": "object", + "properties": { + "conversionIds": { + "description": "The list of `conversionId` that were used to create the dataset.", + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } + }, + "appendDatasetId": { + "description": "The dataset that was appended to to create the current dataset.", + "type": "string", + "readOnly": true + } + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/dwgconversion.json b/specification/maps/data-plane/Creator/preview/2.0/dwgconversion.json new file mode 100644 index 000000000000..f0cd1a3de06b --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/dwgconversion.json @@ -0,0 +1,324 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Conversion Service", + "version": "2.0", + "description": "APIs for converting DWG Packages in Azure Maps." + }, + "x-ms-parameterized-host": { + "hostTemplate": "{geography}.atlas.microsoft.com", + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "AzureKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "AzureKey": [] + } + ], + "responses": {}, + "parameters": { + "ConversionApiVersionV2": { + "name": "api-version", + "description": "Version number of Azure Maps API.", + "type": "string", + "in": "query", + "required": true, + "default": "2.0", + "x-ms-parameter-location": "client" + }, + "UdidQuery": { + "name": "udid", + "description": "The unique data id for the content. The `udid` must have been obtained from a successful [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data%20v2/uploadpreview) call.", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "method" + }, + "ConversionId": { + "name": "conversionId", + "description": "The conversion id for the content. The `conversionId` must have been obtained from a successful [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion/convert) call.", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "OutputOntology": { + "name": "outputOntology", + "description": "Output ontology version. \"facility-2.0\" is the only supported value at this time. Please refer to this [article](https://docs.microsoft.com/en-us/azure/azure-maps/creator-facility-ontology) for more information about Azure Maps Creator ontologies.", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "method" + }, + "DescriptionDwgConversion": { + "name": "description", + "description": "User provided description of the content being converted.", + "type": "string", + "in": "query", + "x-ms-parameter-location": "method" + }, + "ConversionOperationId": { + "name": "operationId", + "type": "string", + "in": "path", + "description": "The ID to query the status for the dataset create/import request.", + "required": true, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/conversions": { + "post": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe Conversion API lets the caller import a set of DWG design files as a zipped [Drawing Package](https://aka.ms/am-drawing-package) into Azure Maps. The [Drawing Package](https://aka.ms/am-drawing-package) should first be uploaded using the [Azure Maps Data Service](https://docs.microsoft.com/rest/api/maps/data). Once uploaded, use the `udid` returned by the [Data Upload API](https://docs.microsoft.com/rest/api/maps/data/uploadpreview) to call this Conversion API.\n\n## Convert DWG package\n\nThe Conversion API performs a [long-running request](https://aka.ms/am-creator-lrt-v2).\n\n## Debug DWG package issues\n\n\nDuring the Conversion process, if there are any issues with the DWG package [errors and warnings](https://aka.ms/am-conversion-errors) are provided in the response along with a *diagnostic package* to visualize and diagnose these issues. In case any issues are encountered with your DWG package, the Conversion operation status process as detailed [here](https://aka.ms/am-creator-lrt-v2) returns the location of the *diagnostic package* that can be downloaded by the caller to help them visualize and diagnose these issues. The *diagnostic package* location can be found in the properties section of the conversion operation status response and looks like the following:\n\n```json\n{\n \"properties\": {\n \"diagnosticPackageLocation\": \"https://us.atlas.microsoft.com/mapdata/{DiagnosticPackageId}?api-version=1.0\" \n } \n}\n```\n\nThe *diagnostic package* can be downloaded by executing a `HTTP GET` request on the `diagnosticPackageLocation`.\nFor more details on how to use the tool to visualize and diagnose all the errors and warnings see [Drawing Error Visualizer](https://aka.ms/am-drawing-errors-visualizer).
    \n\nA conversion operation will be marked as *success* if there are zero or more warnings but will be marked as *failed* if any errors are encountered. ", + "operationId": "Conversion_Convert", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Convert previously uploaded DWG Package": { + "$ref": "./examples/conversion/Conversion_Conversion.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ConversionApiVersionV2" + }, + { + "$ref": "#/parameters/UdidQuery" + }, + { + "$ref": "#/parameters/OutputOntology" + }, + { + "$ref": "#/parameters/DescriptionDwgConversion" + } + ], + "responses": { + "200": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" + }, + "202": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/202AsyncV2" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a list of all successful data conversions submitted previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/conversion/convertpreview). \n\n### Submit List Request\n\nTo list all successful conversions you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe Conversion List API returns the complete list of all conversion details in `json` format.
    \n\nHere is a sample response returning the details of two successful conversion requests: \n\n
    \n\n```json\n{\n \"conversions\": \n [\n {\n \"conversionId\": \"54398242-ea6c-1f31-4fa6-79b1ae0fc24d\",\n \"udid\": \"31838736-8b84-11ea-bc55-0242ac130003\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n },\n {\n \"conversionId\": \"2acf7d32-8b84-11ea-bc55-0242ac130003\",\n \"udid\": \"1214bc58-8b84-11ea-bc55-0242ac1300039\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n }\n ]\n}\n```\n\n
    ", + "operationId": "Conversion_List", + "x-ms-examples": { + "Returns a list of all the data processed by the Conversion Service for the account": { + "$ref": "./examples/conversion/Conversion_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ConversionApiVersionV2" + } + ], + "x-ms-pageable": { + "itemName": "conversions", + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "List request completed successfully.", + "schema": { + "$ref": "#/definitions/ConversionListResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/conversions/{conversionId}": { + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a successful data conversion submitted previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/conversion/convertpreview). ", + "operationId": "Conversion_Get", + "x-ms-examples": { + "Get the details for one conversion operation": { + "$ref": "./examples/conversion/Conversion_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ConversionApiVersionV2" + }, + { + "$ref": "#/parameters/ConversionId" + } + ], + "responses": { + "200": { + "description": "Returns details of the specified conversion.", + "schema": { + "$ref": "#/definitions/ConversionListDetailInfo" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "delete": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to delete any data conversions created previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/conversion/convertpreview).\n\n### Submit Delete Request\n\nTo delete your conversion data you will issue a `DELETE` request where the path will contain the `conversionId` of the data to delete.\n\n### Conversion Delete Response\n\nThe Conversion Delete API returns a HTTP `204 No Content` response with an empty body, if the converted data resources were deleted successfully.
    \nA HTTP `400 Bad Request` error response will be returned if no resource associated with the passed-in `conversionId` is found. ", + "operationId": "Conversion_Delete", + "x-ms-examples": { + "Delete previously converted content": { + "$ref": "./examples/conversion/Conversion_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ConversionApiVersionV2" + }, + { + "$ref": "#/parameters/ConversionId" + } + ], + "responses": { + "204": { + "description": "Conversion delete request completed successfully. The content for `conversionId` was deleted on the server." + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/conversions/operations/{operationId}": { + "get": { + "description": "This path will be obtained from a call to POST /conversions. While in progress, an http200 will be returned with no extra headers - followed by an http200 with Resource-Location header once successfully completed.", + "operationId": "Conversion_GetOperation", + "x-ms-examples": { + "Get the status of an operation which is still running": { + "$ref": "./examples/conversion/Conversion_GetOperationStillRunning.json" + }, + "Get the status of an operation which has finished successfully, with non-fatal warnings": { + "$ref": "./examples/conversion/Conversion_GetOperation.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ConversionApiVersionV2" + }, + { + "$ref": "#/parameters/ConversionOperationId" + } + ], + "responses": { + "200": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + } + }, + "definitions": { + "ConversionListResponse": { + "description": "The response model for the Conversion List API.", + "type": "object", + "properties": { + "conversions": { + "description": "A list of all the previously submitted conversion requests.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ConversionListDetailInfo" + } + }, + "nextLink": { + "description": "If present, the location of the next page of data.", + "type": "string", + "readOnly": true + } + } + }, + "ConversionListDetailInfo": { + "description": "Detail information for the conversion requests.", + "type": "object", + "properties": { + "conversionId": { + "description": "A unique id that represents the artifact of a _successfully_ completed conversion process.", + "type": "string", + "readOnly": true + }, + "ontology": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" + }, + "udid": { + "description": "The unique id of the content provided to create this conversion.", + "type": "string", + "readOnly": true + }, + "created": { + "description": "The date and time of this conversion.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "User provided description of the content being converted.", + "type": "string", + "readOnly": true + }, + "featureCounts": { + "description": "A summary of feature counts in this conversion.", + "type": "object", + "readOnly": true + } + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/alias/Alias_Assign.json b/specification/maps/data-plane/Creator/preview/2.0/examples/alias/Alias_Assign.json new file mode 100644 index 000000000000..08e05a94045e --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/alias/Alias_Assign.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "aliasId": "[aliasId]", + "creatorDataItemId": "[creatorDataItemId]" + }, + "responses": { + "200": { + "body": { + "createdTimestamp": "2021-05-01T01:02:03.456Z", + "aliasId": "25084fb7-307a-4720-8f91-7952a0b91012", + "creatorDataItemId": "633a009a-dfa2-4d51-a419-420122e11c94", + "lastUpdatedTimestamp": "2021-05-01T01:02:03.456Z" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/alias/Alias_Create.json b/specification/maps/data-plane/Creator/preview/2.0/examples/alias/Alias_Create.json new file mode 100644 index 000000000000..c1fff0412624 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/alias/Alias_Create.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "createdTimestamp": "2021-05-01T01:02:03.456Z", + "aliasId": "25084fb7-307a-4720-8f91-7952a0b91012", + "creatorDataItemId": null, + "lastUpdatedTimestamp": "2021-05-01T01:02:03.456Z" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/alias/Alias_Delete.json b/specification/maps/data-plane/Creator/preview/2.0/examples/alias/Alias_Delete.json new file mode 100644 index 000000000000..1fc205ce43c3 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/alias/Alias_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "aliasId": "[aliasId]" + }, + "responses": { + "204": {} + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/alias/Alias_GetDetails.json b/specification/maps/data-plane/Creator/preview/2.0/examples/alias/Alias_GetDetails.json new file mode 100644 index 000000000000..55034a1c734f --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/alias/Alias_GetDetails.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "aliasId": "[aliasId]" + }, + "responses": { + "200": { + "body": { + "createdTimestamp": "2020-02-13T21:19:11+00:00", + "aliasId": "a8a4b8bb-ecf4-fb27-a618-f41721552766", + "creatorDataItemId": "e89aebb9-70a3-8fe1-32bb-1fbd0c725f14", + "lastUpdatedTimestamp": "2020-02-13T21:19:22+00:00" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/alias/Alias_List.json b/specification/maps/data-plane/Creator/preview/2.0/examples/alias/Alias_List.json new file mode 100644 index 000000000000..12612ec5ff9c --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/alias/Alias_List.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0" + }, + "responses": { + "200": { + "body": { + "aliases": [ + { + "createdTimestamp": "2020-02-13T21:19:11+00:00", + "aliasId": "a8a4b8bb-ecf4-fb27-a618-f41721552766", + "creatorDataItemId": "e89aebb9-70a3-8fe1-32bb-1fbd0c725f14", + "lastUpdatedTimestamp": "2020-02-13T21:19:22+00:00" + }, + { + "createdTimestamp": "2020-02-13T21:19:11+00:00", + "aliasId": "1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6", + "creatorDataItemId": null, + "lastUpdatedTimestamp": "2020-02-13T21:19:11+00:00" + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/conversion/Conversion_Conversion.json b/specification/maps/data-plane/Creator/preview/2.0/examples/conversion/Conversion_Conversion.json new file mode 100644 index 000000000000..149a34a8eda2 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/conversion/Conversion_Conversion.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "udid": "25084fb7-307a-4720-8f91-7952a0b91012", + "outputOntology": "facility-2.0" + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-20T22:43:14.9401559+00:00", + "status": "Succeeded" + }, + "headers": { + "Resource-Location": "https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0" + } + }, + "202": { + "headers": { + "Operation-Location": "https://us.atlas.microsoft.com/conversions/operations/{operationId}?api-version=2.0", + "Access-Control-Expose-Headers": "Operation-Location" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/conversion/Conversion_Delete.json b/specification/maps/data-plane/Creator/preview/2.0/examples/conversion/Conversion_Delete.json new file mode 100644 index 000000000000..5cf093ae5d8a --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/conversion/Conversion_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "conversionId": "99884fb7-87a9-0920-7f93-7952a0b91012" + }, + "responses": { + "204": {} + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/conversion/Conversion_Get.json b/specification/maps/data-plane/Creator/preview/2.0/examples/conversion/Conversion_Get.json new file mode 100644 index 000000000000..f081d3945f4e --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/conversion/Conversion_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "conversionId": "54398242-ea6c-1f31-4fa6-79b1ae0fc24d" + }, + "responses": { + "200": { + "body": { + "conversionId": "54398242-ea6c-1f31-4fa6-79b1ae0fc24d", + "udid": "31838736-8b84-11ea-bc55-0242ac130003", + "created": "5/19/2020 9:00:00 AM +00:00", + "description": "User provided description.", + "featureCounts": { + "directoryInfo": 1, + "level": 3, + "facility": 1, + "unit": 150, + "category": 8, + "areaElement": 0, + "opening": 10 + } + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/conversion/Conversion_GetOperation.json b/specification/maps/data-plane/Creator/preview/2.0/examples/conversion/Conversion_GetOperation.json new file mode 100644 index 000000000000..0b718ab1da2e --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/conversion/Conversion_GetOperation.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-20T22:43:14.9401559+00:00", + "status": "Succeeded", + "warning": { + "code": "dwgConversionProblem", + "details": [ + { + "code": "warning", + "details": [ + { + "code": "manifestWarning", + "message": "Ignoring unexpected JSON property: unitProperties[0].nonWheelchairAccessible with value False" + } + ] + } + ] + } + }, + "headers": { + "Resource-Location": "https://us.atlas.microsoft.com/conversions/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/conversion/Conversion_GetOperationStillRunning.json b/specification/maps/data-plane/Creator/preview/2.0/examples/conversion/Conversion_GetOperationStillRunning.json new file mode 100644 index 000000000000..52d48d34f311 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/conversion/Conversion_GetOperationStillRunning.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-23T19:14:03.2452596+00:00", + "status": "Running" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/conversion/Conversion_List.json b/specification/maps/data-plane/Creator/preview/2.0/examples/conversion/Conversion_List.json new file mode 100644 index 000000000000..158b416cefb8 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/conversion/Conversion_List.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0" + }, + "responses": { + "200": { + "body": { + "conversions": [ + { + "conversionId": "54398242-ea6c-1f31-4fa6-79b1ae0fc24d", + "udid": "31838736-8b84-11ea-bc55-0242ac130003", + "created": "5/19/2020 9:00:00 AM +00:00", + "description": "User provided description.", + "featureCounts": { + "directoryInfo": 1, + "level": 3, + "facility": 1, + "unit": 150, + "category": 8, + "areaElement": 0, + "opening": 10 + } + }, + { + "conversionId": "2acf7d32-8b84-11ea-bc55-0242ac130003", + "udid": "1214bc58-8b84-11ea-bc55-0242ac1300039", + "created": "5/19/2020 9:00:00 AM +00:00", + "description": "User provided description.", + "featureCounts": { + "directoryInfo": 1, + "level": 3, + "facility": 1, + "unit": 150, + "category": 8, + "areaElement": 0, + "opening": 10 + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/data/Data_Delete.json b/specification/maps/data-plane/Creator/preview/2.0/examples/data/Data_Delete.json new file mode 100644 index 000000000000..2e897dae615d --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/data/Data_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "udid": "25084fb7-307a-4720-8f91-7952a0b91012" + }, + "responses": { + "204": {} + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/data/Data_Download.json b/specification/maps/data-plane/Creator/preview/2.0/examples/data/Data_Download.json new file mode 100644 index 000000000000..8c6658d7bbe2 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/data/Data_Download.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "udid": "25084fb7-307a-4720-8f91-7952a0b91012" + }, + "responses": { + "200": { + "body": "{file}" + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/data/Data_GetOperation.json b/specification/maps/data-plane/Creator/preview/2.0/examples/data/Data_GetOperation.json new file mode 100644 index 000000000000..d200cddb0cf6 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/data/Data_GetOperation.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-20T22:43:14.9401559+00:00", + "status": "Succeeded" + }, + "headers": { + "Resource-Location": "https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/data/Data_GetOperationStillRunning.json b/specification/maps/data-plane/Creator/preview/2.0/examples/data/Data_GetOperationStillRunning.json new file mode 100644 index 000000000000..52d48d34f311 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/data/Data_GetOperationStillRunning.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-23T19:14:03.2452596+00:00", + "status": "Running" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/data/Data_List.json b/specification/maps/data-plane/Creator/preview/2.0/examples/data/Data_List.json new file mode 100644 index 000000000000..132cab23e1b5 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/data/Data_List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0" + }, + "responses": { + "200": { + "body": { + "mapDataList": [ + { + "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2", + "location": "https://us.atlas.microsoft.com/mapData/f6495f62-94f8-0ec2-c252-45626f82fcb2?api-version=1.0", + "sizeInBytes": 29920, + "uploadStatus": "Completed" + }, + { + "udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "location": "https://us.atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0", + "sizeInBytes": 1339, + "uploadStatus": "Completed" + }, + { + "udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c", + "location": "https://us.atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0", + "sizeInBytes": 1650, + "uploadStatus": "Pending" + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/data/Data_Update.json b/specification/maps/data-plane/Creator/preview/2.0/examples/data/Data_Update.json new file mode 100644 index 000000000000..a6057f3ec929 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/data/Data_Update.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "udid": "25084fb7-307a-4720-8f91-7952a0b91012", + "UpdateContent": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + -122.126986, + 47.639754 + ] + }, + "properties": { + "geometryId": "001", + "radius": 500 + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-20T22:43:14.9401559+00:00", + "status": "Succeeded" + }, + "headers": { + "Resource-Location": "https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0" + } + }, + "202": { + "headers": { + "Operation-Location": "https://us.atlas.microsoft.com/mapData/operations/{operationId}?api-version=1.0", + "Access-Control-Expose-Headers": "Operation-Location" + } + }, + "409": { + "headers": {}, + "body": { + "error": { + "code": "409 Conflict", + "message": "The data storage limit is reached on the Azure Maps account. You can always use the Data Delete API to delete old/unused content and create space for new uploads." + } + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/data/Data_Upload.json b/specification/maps/data-plane/Creator/preview/2.0/examples/data/Data_Upload.json new file mode 100644 index 000000000000..f1736046f20f --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/data/Data_Upload.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "dataFormat": "geojson", + "UploadContent": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + -122.126986, + 47.639754 + ] + }, + "properties": { + "geometryId": "001", + "radius": 500 + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-20T22:43:14.9401559+00:00", + "status": "Succeeded" + }, + "headers": { + "Resource-Location": "https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0" + } + }, + "202": { + "headers": { + "Operation-Location": "https://us.atlas.microsoft.com/mapData/operations/{udid}?api-version=2.0", + "Access-Control-Expose-Headers": "Operation-Location" + } + }, + "409": { + "headers": {}, + "body": { + "error": { + "code": "409 Conflict", + "message": "The data storage limit is reached on the Azure Maps account. You can always use the Data Delete API to delete old/unused content and create space for new uploads." + } + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/dataset/Dataset_Create.json b/specification/maps/data-plane/Creator/preview/2.0/examples/dataset/Dataset_Create.json new file mode 100644 index 000000000000..df5d8e659524 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/dataset/Dataset_Create.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "conversionId": "[conversionId]" + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-20T22:43:14.9401559+00:00", + "status": "Succeeded" + }, + "headers": { + "Resource-Location": "https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0" + } + }, + "202": { + "headers": { + "Operation-Location": "https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2.0", + "Access-Control-Expose-Headers": "Operation-Location" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/dataset/Dataset_Delete.json b/specification/maps/data-plane/Creator/preview/2.0/examples/dataset/Dataset_Delete.json new file mode 100644 index 000000000000..b2193a7993db --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/dataset/Dataset_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "datasetId": "[datasetId]" + }, + "responses": { + "204": {} + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/dataset/Dataset_GetDetails.json b/specification/maps/data-plane/Creator/preview/2.0/examples/dataset/Dataset_GetDetails.json new file mode 100644 index 000000000000..33836ce57754 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/dataset/Dataset_GetDetails.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "datasetId": "[datasetId]" + }, + "responses": { + "200": { + "headers": { + "Location": "https://us.atlas.microsoft.com/dataset/{datasetId}?api-version=1.0", + "Access-Control-Expose-Headers": "Resource-Location" + }, + "body": { + "created": "2021-05-21T01:02:03.456Z", + "datasetId": "[datasetId]", + "description": "Some description or comment about the dataset", + "datasetSources": { + "conversionIds": [ + "15d21452-c9bb-27b6-5e79-743ca5c3205d", + "c39de51c-b4f5-4733-aeeb-d8cb6f8b2f1d" + ], + "appendDatasetId": "6a49a490-1d9c-4f05-bf1e-51998fbc4733" + }, + "featureCounts": { + "directoryInfo": 2, + "category": 10, + "facility": 1, + "level": 3, + "unit": 183, + "zone": 3, + "verticalPenetration": 6, + "opening": 48, + "areaElement": 108 + }, + "ontology": "facility-2.0" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/dataset/Dataset_GetOperation.json b/specification/maps/data-plane/Creator/preview/2.0/examples/dataset/Dataset_GetOperation.json new file mode 100644 index 000000000000..8ea9c0cb5da0 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/dataset/Dataset_GetOperation.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-20T22:43:14.9401559+00:00", + "status": "Succeeded" + }, + "headers": { + "Resource-Location": "https://us.atlas.microsoft.com/datasets/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/dataset/Dataset_GetOperationStillRunning.json b/specification/maps/data-plane/Creator/preview/2.0/examples/dataset/Dataset_GetOperationStillRunning.json new file mode 100644 index 000000000000..52d48d34f311 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/dataset/Dataset_GetOperationStillRunning.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-23T19:14:03.2452596+00:00", + "status": "Running" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/dataset/Dataset_List.json b/specification/maps/data-plane/Creator/preview/2.0/examples/dataset/Dataset_List.json new file mode 100644 index 000000000000..13e4eda45125 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/dataset/Dataset_List.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0" + }, + "responses": { + "200": { + "body": { + "datasets": [ + { + "created": "2021-05-21T03:04:05.678Z", + "datasetId": "f6495f62-94f8-0ec2-c252-45626f82fcb2", + "description": "Some description or comment for the dataset.", + "datasetSources": { + "conversionIds": [ + "db63843c-3c70-4b4e-94ff-dfcf4013c4a9" + ] + }, + "featureCounts": { + "directoryInfo": 1, + "category": 18, + "facility": 1, + "level": 6, + "unit": 775, + "opening": 471, + "areaElement": 496 + }, + "ontology": "facility-2.0" + }, + { + "created": "2021-05-21T03:04:05.678Z", + "datasetId": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c", + "description": "Some other description or comment for the dataset.", + "datasetSources": { + "conversionIds": [ + "15d21452-c9bb-27b6-5e79-743ca5c3205d" + ], + "appendDatasetId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" + }, + "featureCounts": { + "directoryInfo": 2, + "category": 10, + "facility": 1, + "level": 3, + "unit": 183, + "zone": 3, + "verticalPenetration": 6, + "opening": 48, + "areaElement": 108 + }, + "ontology": "facility-2.0" + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/featurestate/Featurestate_CreateStateset.json b/specification/maps/data-plane/Creator/preview/2.0/examples/featurestate/Featurestate_CreateStateset.json new file mode 100644 index 000000000000..880d8ffa2a42 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/featurestate/Featurestate_CreateStateset.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "description": "Stateset for Azure Maps POC.", + "datasetId": "5d34fbe8-87b7-f7c0-3144-c50e003a3c75", + "statesetCreateRequestBody": { + "styles": [ + { + "keyName": "s1", + "type": "boolean", + "rules": [ + { + "true": "#FF0000", + "false": "#00FF00" + } + ] + }, + { + "keyName": "s2", + "type": "number", + "rules": [ + { + "range": { + "exclusiveMaximum": 50 + }, + "color": "#343deb" + }, + { + "range": { + "minimum": 50, + "exclusiveMaximum": 70 + }, + "color": "#34ebb1" + }, + { + "range": { + "minimum": 70, + "exclusiveMaximum": 90 + }, + "color": "#eba834" + }, + { + "range": { + "minimum": 90 + }, + "color": "#eb3434" + } + ] + }, + { + "keyName": "s3", + "type": "string", + "rules": [ + { + "stateValue1": "#FF0000", + "stateValue2": "#FF00AA", + "stateValueN": "#00FF00" + } + ] + } + ] + } + }, + "responses": { + "200": { + "body": { + "statesetId": "b24bdb73-1305-3212-1909-a428d937b64f" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/featurestate/Featurestate_DeleteFeatureState.json b/specification/maps/data-plane/Creator/preview/2.0/examples/featurestate/Featurestate_DeleteFeatureState.json new file mode 100644 index 000000000000..1b5f29227d13 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/featurestate/Featurestate_DeleteFeatureState.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "statesetId": "b24bdb73-1305-3212-1909-a428d937b64", + "featureId": "SPC4709", + "stateKeyName": "keyName1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/featurestate/Featurestate_DeleteStateset.json b/specification/maps/data-plane/Creator/preview/2.0/examples/featurestate/Featurestate_DeleteStateset.json new file mode 100644 index 000000000000..ae9a27be981f --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/featurestate/Featurestate_DeleteStateset.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "statesetId": "b24bdb73-1305-3212-1909-a428d937b64f" + }, + "responses": { + "204": {} + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/featurestate/Featurestate_GetStates.json b/specification/maps/data-plane/Creator/preview/2.0/examples/featurestate/Featurestate_GetStates.json new file mode 100644 index 000000000000..24af0a5fc1cc --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/featurestate/Featurestate_GetStates.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "statesetId": "b24bdb73-1305-3212-1909-a428d937b64", + "featureId": "SPC4709" + }, + "responses": { + "200": { + "body": { + "states": [ + { + "keyName": "s1", + "value": "true", + "eventTimestamp": "2019-08-16 13:01" + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/featurestate/Featurestate_GetStateset.json b/specification/maps/data-plane/Creator/preview/2.0/examples/featurestate/Featurestate_GetStateset.json new file mode 100644 index 000000000000..e853a767027e --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/featurestate/Featurestate_GetStateset.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "statesetId": "b24bdb73-1305-3212-1909-a428d937b64" + }, + "responses": { + "200": { + "body": { + "description": "Stateset for Azure Maps POC.", + "datasetIds": [ + "8d700cc7-fd2c-4e21-b402-ad3f5e524f36" + ], + "statesetStyle": { + "styles": [ + { + "keyName": "s1", + "type": "boolean", + "rules": [ + { + "true": "#FFFF00", + "false": "#FFFFFF" + } + ] + }, + { + "keyName": "s2", + "type": "number", + "rules": [ + { + "range": { + "minimum": null, + "maximum": null, + "exclusiveMinimum": null, + "exclusiveMaximum": 50 + }, + "color": "#343deb" + }, + { + "range": { + "minimum": 50, + "maximum": null, + "exclusiveMinimum": null, + "exclusiveMaximum": 69 + }, + "color": "#34ebb1" + }, + { + "range": { + "minimum": 69, + "maximum": null, + "exclusiveMinimum": null, + "exclusiveMaximum": 90 + }, + "color": "#eba834" + }, + { + "range": { + "minimum": 90, + "maximum": null, + "exclusiveMinimum": null, + "exclusiveMaximum": null + }, + "color": "#eb3434" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/featurestate/Featurestate_List.json b/specification/maps/data-plane/Creator/preview/2.0/examples/featurestate/Featurestate_List.json new file mode 100644 index 000000000000..555e8e54f3e7 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/featurestate/Featurestate_List.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0" + }, + "responses": { + "200": { + "body": { + "statesets": [ + { + "statesetId": "09abcdf8-cad0-b3dd-a38f-d5ee3cff5eea", + "description": "Stateset for Main campus.", + "datasetIds": [ + "8d700cc7-fd2c-4e21-b402-ad3f5e524f36" + ], + "statesetStyle": { + "styles": [ + { + "keyName": "s1", + "type": "boolean", + "rules": [ + { + "true": "#0FFF00", + "false": "#00FFF0" + } + ] + }, + { + "keyName": "s2", + "type": "number", + "rules": [ + { + "range": { + "minimum": null, + "maximum": null, + "exclusiveMinimum": null, + "exclusiveMaximum": 50 + }, + "color": "#343deb" + }, + { + "range": { + "minimum": 50, + "maximum": null, + "exclusiveMinimum": null, + "exclusiveMaximum": 69 + }, + "color": "#34ebb1" + }, + { + "range": { + "minimum": 69, + "maximum": null, + "exclusiveMinimum": null, + "exclusiveMaximum": 90 + }, + "color": "#eba834" + }, + { + "range": { + "minimum": 90, + "maximum": null, + "exclusiveMinimum": null, + "exclusiveMaximum": null + }, + "color": "#eb3434" + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/featurestate/Featurestate_UpdateStates.json b/specification/maps/data-plane/Creator/preview/2.0/examples/featurestate/Featurestate_UpdateStates.json new file mode 100644 index 000000000000..ef821c9a0fbe --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/featurestate/Featurestate_UpdateStates.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "statesetId": "b24bdb73-1305-3212-1909-a428d937b64", + "featureId": "SPC4709", + "featureStateUpdateRequestBody": { + "states": [ + { + "keyName": "s1", + "value": "true", + "eventTimestamp": "2019-08-16 13:01" + } + ] + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/featurestate/Featurestate_UpdateStateset.json b/specification/maps/data-plane/Creator/preview/2.0/examples/featurestate/Featurestate_UpdateStateset.json new file mode 100644 index 000000000000..9c3e9e62f2d3 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/featurestate/Featurestate_UpdateStateset.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "statesetId": "b24bdb73-1305-3212-1909-a428d937b64", + "statesetStyleUpdateRequestBody": { + "styles": [ + { + "keyName": "s1", + "type": "boolean", + "rules": [ + { + "true": "#FFFF00", + "false": "#FFFFFF" + } + ] + }, + { + "keyName": "s2", + "type": "number", + "rules": [ + { + "range": { + "exclusiveMaximum": 50 + }, + "color": "#343deb" + }, + { + "range": { + "minimum": 50, + "exclusiveMaximum": 69 + }, + "color": "#34ebb1" + }, + { + "range": { + "minimum": 69, + "exclusiveMaximum": 90 + }, + "color": "#eba834" + }, + { + "range": { + "minimum": 90 + }, + "color": "#eb3434" + } + ] + } + ] + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/tileset/Tileset_Create.json b/specification/maps/data-plane/Creator/preview/2.0/examples/tileset/Tileset_Create.json new file mode 100644 index 000000000000..0ca2acebc8d8 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/tileset/Tileset_Create.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "datasetId": "[dataset-Id]" + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-20T22:43:14.9401559+00:00", + "status": "Succeeded" + }, + "headers": { + "Resource-Location": "https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0" + } + }, + "202": { + "headers": { + "Operation-Location": "https://us.atlas.microsoft.com/tilesets/operations/{operationId}?api-version=2.0", + "Access-Control-Expose-Headers": "Operation-Location" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/tileset/Tileset_Delete.json b/specification/maps/data-plane/Creator/preview/2.0/examples/tileset/Tileset_Delete.json new file mode 100644 index 000000000000..71049ceba9d2 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/tileset/Tileset_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "tilesetId": "25084fb7-307a-4720-8f91-7952a0b91012" + }, + "responses": { + "204": {} + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/tileset/Tileset_Get.json b/specification/maps/data-plane/Creator/preview/2.0/examples/tileset/Tileset_Get.json new file mode 100644 index 000000000000..f4078cebc0b9 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/tileset/Tileset_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "tilesetId": "d8fa86de-bb0f-4a02-a6ff-62ae7545dd84" + }, + "responses": { + "200": { + "body": { + "tilesetId": "d8fa86de-bb0f-4a02-a6ff-62ae7545dd84", + "datasetId": "63b18a6b-ac35-4b23-a1d9-ffa1003ad50b", + "description": "My first tileset", + "minZoom": 16, + "maxZoom": 18, + "bbox": [ + -122.13595, + 47.636524, + -122.1329, + 47.637525 + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/tileset/Tileset_GetOperation.json b/specification/maps/data-plane/Creator/preview/2.0/examples/tileset/Tileset_GetOperation.json new file mode 100644 index 000000000000..671289b480bb --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/tileset/Tileset_GetOperation.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-20T22:43:14.9401559+00:00", + "status": "Succeeded" + }, + "headers": { + "Resource-Location": "https://us.atlas.microsoft.com/tilesets/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/tileset/Tileset_GetOperationStillRunning.json b/specification/maps/data-plane/Creator/preview/2.0/examples/tileset/Tileset_GetOperationStillRunning.json new file mode 100644 index 000000000000..52d48d34f311 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/tileset/Tileset_GetOperationStillRunning.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-23T19:14:03.2452596+00:00", + "status": "Running" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/tileset/Tileset_List.json b/specification/maps/data-plane/Creator/preview/2.0/examples/tileset/Tileset_List.json new file mode 100644 index 000000000000..93cf5ac3c2d2 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/tileset/Tileset_List.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0" + }, + "responses": { + "200": { + "body": { + "tilesets": [ + { + "tilesetId": "d8fa86de-bb0f-4a02-a6ff-62ae7545dd84", + "datasetId": "63b18a6b-ac35-4b23-a1d9-ffa1003ad50b", + "description": "My first tileset", + "minZoom": 16, + "maxZoom": 18, + "bbox": [ + -122.13595, + 47.636524, + -122.1329, + 47.637525 + ] + }, + { + "tilesetId": "b8dca8b3-8aad-4afe-abd6-0efe37b5a2e3", + "datasetId": "c0a01139-662e-4d5a-bf5f-92ea4a292aad", + "description": "My second tileset", + "minZoom": 19, + "maxZoom": 19, + "bbox": [ + -122.13595, + 47.636524, + -122.1329, + 47.637525 + ] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/wfs/WFS_DeleteFeature.json b/specification/maps/data-plane/Creator/preview/2.0/examples/wfs/WFS_DeleteFeature.json new file mode 100644 index 000000000000..e27d3eff14bf --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/wfs/WFS_DeleteFeature.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "datasetId": "218fda98-e638-0edf-5ef7-28491ff3bed4", + "collectionId": "facility", + "featureId": "FCL39" + }, + "responses": { + "204": {} + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/wfs/WFS_GetCollection.json b/specification/maps/data-plane/Creator/preview/2.0/examples/wfs/WFS_GetCollection.json new file mode 100644 index 000000000000..9f263859487b --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/wfs/WFS_GetCollection.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "datasetId": "218fda98-e638-0edf-5ef7-28491ff3bed4", + "collectionId": "unit" + }, + "responses": { + "200": { + "body": { + "name": "unit", + "description": "A physical and non-overlapping area which might be occupied and traversed by a navigating agent. Can be a hallway, a room, a courtyard, etc. It is surrounded by physical obstruction (wall), unless the isOpenArea attribute is equal to true, and one must add openings where the obstruction shouldn't be there. If isOpenArea attribute is equal to true, all the sides are assumed open to the surroundings and walls are to be added where needed. Walls for open areas are represented as a lineElement or areaElement with isObstruction equal to true.", + "ontology": "Facility-2.0", + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition?api-version=2.0", + "rel": "describedBy", + "title": "Metadata catalogue for unit" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2.0", + "rel": "data", + "title": "unit" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2.0", + "rel": "self", + "title": "Metadata catalogue for unit" + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/wfs/WFS_GetCollectionDefinition.json b/specification/maps/data-plane/Creator/preview/2.0/examples/wfs/WFS_GetCollectionDefinition.json new file mode 100644 index 000000000000..e2e020b432c8 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/wfs/WFS_GetCollectionDefinition.json @@ -0,0 +1,152 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "datasetId": "218fda98-e638-0edf-5ef7-28491ff3bed4", + "collectionId": "unit" + }, + "responses": { + "200": { + "body": { + "idPrefix": "UNIT", + "name": "unit", + "description": "A physical and non-overlapping area which might be occupied and traversed by a navigating agent. Can be a hallway, a room, a courtyard, etc. It is surrounded by physical obstruction (wall), unless the isOpenArea attribute is equal to true, and one must add openings where the obstruction shouldn't be there. If isOpenArea attribute is equal to true, all the sides are assumed open to the surroundings and walls are to be added where needed. Walls for open areas are represented as a lineElement or areaElement with isObstruction equal to true.", + "ontology": "Facility-2.0", + "geometryType": "Polygon", + "featureTypes": [], + "properties": [ + { + "name": "externalId", + "required": false, + "type": "text" + }, + { + "name": "originalId", + "required": false, + "type": "text" + }, + { + "name": "categoryId", + "required": true, + "type": { + "featureId": "category" + } + }, + { + "name": "isOpenArea", + "required": false, + "type": "boolean" + }, + { + "name": "navigableBy", + "required": false, + "type": { + "array": { + "enum": [ + "pedestrian", + "wheelchair", + "machine", + "bicycle", + "automobile", + "hiredAuto", + "bus", + "railcar", + "emergency", + "ferry", + "boat" + ] + } + } + }, + { + "name": "isRoutable", + "required": false, + "type": "boolean" + }, + { + "name": "routeThroughBehavior", + "required": false, + "type": { + "enum": [ + "disallowed", + "allowed", + "preferred" + ] + } + }, + { + "name": "nonPublic", + "required": false, + "type": "boolean" + }, + { + "name": "levelId", + "required": true, + "type": { + "featureId": "level" + } + }, + { + "name": "occupants", + "required": false, + "type": { + "array": { + "featureId": "directoryInfo" + } + } + }, + { + "name": "addressId", + "required": false, + "type": { + "featureId": "directoryInfo" + } + }, + { + "name": "addressRoomNumber", + "required": false, + "type": "text" + }, + { + "name": "name", + "required": false, + "type": "text" + }, + { + "name": "nameSubtitle", + "required": false, + "type": "text" + }, + { + "name": "nameAlt", + "required": false, + "type": "text" + }, + { + "name": "anchorPoint", + "required": false, + "type": { + "geometry": [ + "Point" + ], + "isFragmented": false, + "srid": 4326 + } + } + ], + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition?api-version=2.0", + "rel": "self", + "title": "Metadata catalogue for unit" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2.0", + "rel": "data", + "title": "unit" + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/wfs/WFS_GetCollections.json b/specification/maps/data-plane/Creator/preview/2.0/examples/wfs/WFS_GetCollections.json new file mode 100644 index 000000000000..ab9196a76fc6 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/wfs/WFS_GetCollections.json @@ -0,0 +1,253 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "datasetId": "218fda98-e638-0edf-5ef7-28491ff3bed4" + }, + "responses": { + "200": { + "body": { + "ontology": "Facility-2.0", + "collections": [ + { + "name": "unit", + "description": "A physical and non-overlapping area which might be occupied and traversed by a navigating agent. Can be a hallway, a room, a courtyard, etc. It is surrounded by physical obstruction (wall), unless the isOpenArea attribute is equal to true, and one must add openings where the obstruction shouldn't be there. If isOpenArea attribute is equal to true, all the sides are assumed open to the surroundings and walls are to be added where needed. Walls for open areas are represented as a lineElement or areaElement with isObstruction equal to true.", + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition?api-version=2.0", + "rel": "describedBy", + "title": "Metadata catalogue for unit" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2.0", + "rel": "data", + "title": "unit" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2.0", + "rel": "self", + "title": "Metadata catalogue for unit" + } + ] + }, + { + "name": "zone", + "description": "A virtual area. ex, wifi zone, emergency assembly area. Zones can be used as destinations but not meant for through traffic.", + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/zone/definition?api-version=2.0", + "rel": "describedBy", + "title": "Metadata catalogue for zone" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/zone/items?api-version=2.0", + "rel": "data", + "title": "zone" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/zone?api-version=2.0", + "rel": "self", + "title": "Metadata catalogue for zone" + } + ] + }, + { + "name": "level", + "description": "An indication of the extent and vertical position of a set of features.", + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/level/definition?api-version=2.0", + "rel": "describedBy", + "title": "Metadata catalogue for level" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/level/items?api-version=2.0", + "rel": "data", + "title": "level" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/level?api-version=2.0", + "rel": "self", + "title": "Metadata catalogue for level" + } + ] + }, + { + "name": "facility", + "description": "Area of the site, building footprint etc.", + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/facility/definition?api-version=2.0", + "rel": "describedBy", + "title": "Metadata catalogue for facility" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/facility/items?api-version=2.0", + "rel": "data", + "title": "facility" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/facility?api-version=2.0", + "rel": "self", + "title": "Metadata catalogue for facility" + } + ] + }, + { + "name": "verticalPenetration", + "description": "An area that, when used in a set, represents a method of navigating vertically between levels. It can be used to model stairs, elevators etc. Geometry can overlap units and other vertical penetration features.", + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/verticalPenetration/definition?api-version=2.0", + "rel": "describedBy", + "title": "Metadata catalogue for verticalPenetration" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/verticalPenetration/items?api-version=2.0", + "rel": "data", + "title": "verticalPenetration" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/verticalPenetration?api-version=2.0", + "rel": "self", + "title": "Metadata catalogue for verticalPenetration" + } + ] + }, + { + "name": "opening", + "description": "A usually-traversable boundary between two units, or a unit and verticalPenetration.", + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/opening/definition?api-version=2.0", + "rel": "describedBy", + "title": "Metadata catalogue for opening" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/opening/items?api-version=2.0", + "rel": "data", + "title": "opening" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/opening?api-version=2.0", + "rel": "self", + "title": "Metadata catalogue for opening" + } + ] + }, + { + "name": "directoryInfo", + "description": "Name, address, phone number, website, and hours of operation for a unit, facility, or an occupant of a unit or facility.", + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/directoryInfo/definition?api-version=2.0", + "rel": "describedBy", + "title": "Metadata catalogue for directoryInfo" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/directoryInfo/items?api-version=2.0", + "rel": "data", + "title": "directoryInfo" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/directoryInfo?api-version=2.0", + "rel": "self", + "title": "Metadata catalogue for directoryInfo" + } + ] + }, + { + "name": "pointElement", + "description": "A point feature in a unit, such as a first aid kit or a sprinkler head.", + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/pointElement/definition?api-version=2.0", + "rel": "describedBy", + "title": "Metadata catalogue for pointElement" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/pointElement/items?api-version=2.0", + "rel": "data", + "title": "pointElement" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/pointElement?api-version=2.0", + "rel": "self", + "title": "Metadata catalogue for pointElement" + } + ] + }, + { + "name": "lineElement", + "description": "A line feature in a unit, such as a dividing wall, window.", + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/lineElement/definition?api-version=2.0", + "rel": "describedBy", + "title": "Metadata catalogue for lineElement" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/lineElement/items?api-version=2.0", + "rel": "data", + "title": "lineElement" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/lineElement?api-version=2.0", + "rel": "self", + "title": "Metadata catalogue for lineElement" + } + ] + }, + { + "name": "areaElement", + "description": "A polygon feature in a unit, such as an area open to below, an obstruction like an island in a unit.", + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/areaElement/definition?api-version=2.0", + "rel": "describedBy", + "title": "Metadata catalogue for areaElement" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/areaElement/items?api-version=2.0", + "rel": "data", + "title": "areaElement" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/areaElement?api-version=2.0", + "rel": "self", + "title": "Metadata catalogue for areaElement" + } + ] + }, + { + "name": "category", + "description": "Category names. e.g. \"room.conference\". The isRoutable attribute puts a feature with that category on the routing graph. The routeThroughBehavior attribute determines whether a feature can be used for through traffic or not.", + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/category/definition?api-version=2.0", + "rel": "describedBy", + "title": "Metadata catalogue for category" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/category/items?api-version=2.0", + "rel": "data", + "title": "category" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/category?api-version=2.0", + "rel": "self", + "title": "Metadata catalogue for category" + } + ] + } + ], + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections?api-version=2.0", + "rel": "self" + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/wfs/WFS_GetConformance.json b/specification/maps/data-plane/Creator/preview/2.0/examples/wfs/WFS_GetConformance.json new file mode 100644 index 000000000000..00fc7956f640 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/wfs/WFS_GetConformance.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "datasetId": "218fda98-e638-0edf-5ef7-28491ff3bed4" + }, + "responses": { + "200": { + "body": { + "conformsTo": [ + "http://www.opengis.net/spec/wfs-1/3.0/req/core", + "http://www.opengis.net/spec/wfs-1/3.0/req/oas30", + "http://www.opengis.net/spec/wfs-1/3.0/req/geojson", + "http://tempuri.org/wfs/3.0/edit" + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/wfs/WFS_GetFeature.json b/specification/maps/data-plane/Creator/preview/2.0/examples/wfs/WFS_GetFeature.json new file mode 100644 index 000000000000..2d90e3409188 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/wfs/WFS_GetFeature.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "datasetId": "218fda98-e638-0edf-5ef7-28491ff3bed4", + "collectionId": "unit", + "featureId": "UNIT39" + }, + "responses": { + "200": { + "body": { + "ontology": "Facility-2.0", + "feature": { + "type": "Feature", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 139.63304057829211, + 35.457686686108559 + ], + [ + 139.63296283234274, + 35.457783904258683 + ], + [ + 139.63308672404617, + 35.457850229062018 + ], + [ + 139.63314516916711, + 35.457777145699858 + ], + [ + 139.63312747036289, + 35.457767670747167 + ], + [ + 139.63314677109963, + 35.457743535881377 + ], + [ + 139.63304057829211, + 35.457686686108559 + ] + ] + ] + }, + "properties": { + "originalId": "ddbbb583-4621-4e11-8859-299d1057e843", + "categoryId": "CTG10", + "isOpenArea": false, + "navigableBy": [ + "pedestrian" + ], + "isRoutable": false, + "routeThroughBehavior": "allowed", + "nonPublic": false, + "levelId": "LVL18", + "occupants": [], + "addressId": "DIR16", + "addressRoomNumber": "", + "name": "21N13", + "nameSubtitle": "", + "nameAlt": "" + }, + "id": "UNIT39", + "featureType": "" + }, + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items/UNIT39?api-version=2.0", + "rel": "self" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2.0", + "rel": "data" + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/wfs/WFS_GetFeatures.json b/specification/maps/data-plane/Creator/preview/2.0/examples/wfs/WFS_GetFeatures.json new file mode 100644 index 000000000000..baadf9b72821 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/wfs/WFS_GetFeatures.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "datasetId": "018fda98-e638-0edf-5ef7-28491ff3bed4", + "collectionId": "unit", + "limit": 1, + "bbox": "-122, 47, -120, 46" + }, + "responses": { + "200": { + "body": { + "type": "FeatureCollection", + "ontology": "Facility-2.0", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 139.63304057829211, + 35.457686686108559 + ], + [ + 139.63296283234274, + 35.457783904258683 + ], + [ + 139.63308672404617, + 35.457850229062018 + ], + [ + 139.63314516916711, + 35.457777145699858 + ], + [ + 139.63312747036289, + 35.457767670747167 + ], + [ + 139.63314677109963, + 35.457743535881377 + ], + [ + 139.63304057829211, + 35.457686686108559 + ] + ] + ] + }, + "properties": { + "originalId": "ddbbb583-4621-4e11-8859-299d1057e843", + "categoryId": "CTG10", + "isOpenArea": false, + "navigableBy": [ + "pedestrian" + ], + "isRoutable": false, + "routeThroughBehavior": "allowed", + "nonPublic": false, + "levelId": "LVL18", + "occupants": [], + "addressId": "DIR16", + "addressRoomNumber": "", + "name": "21N13", + "nameSubtitle": "", + "nameAlt": "" + }, + "id": "UNIT39", + "featureType": "" + } + ], + "numberReturned": 1, + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2.0&limit=1", + "rel": "self" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2.0", + "rel": "data" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?n=PMRG4ZLYOQRDUMJMEJYHEZLWEI5C2ML5&api-version=2.0&limit=1", + "rel": "next" + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/examples/wfs/WFS_GetLandingPage.json b/specification/maps/data-plane/Creator/preview/2.0/examples/wfs/WFS_GetLandingPage.json new file mode 100644 index 000000000000..488dc128f5fc --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/examples/wfs/WFS_GetLandingPage.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "datasetId": "218fda98-e638-0edf-5ef7-28491ff3bed4" + }, + "responses": { + "200": { + "body": { + "ontology": "Facility-2.0", + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4", + "rel": "self", + "title": "Azure Maps WFS" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/api", + "rel": "service", + "title": "The API definition" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/conformance", + "rel": "conformance", + "title": "WFS 3.0 conformance classes implemented by this server" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/version", + "rel": "data", + "title": "The version information" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections", + "rel": "data", + "title": "Metadata about the feature collections" + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/featurestate.json b/specification/maps/data-plane/Creator/preview/2.0/featurestate.json new file mode 100644 index 000000000000..51bc9cbbb415 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/featurestate.json @@ -0,0 +1,674 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Feature State Service", + "version": "2.0", + "description": "APIs for managing the dynamic feature states in Azure Maps." + }, + "x-ms-parameterized-host": { + "hostTemplate": "{geography}.atlas.microsoft.com", + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "AzureKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "AzureKey": [] + } + ], + "responses": {}, + "parameters": { + "FeaturestateApiVersionV2": { + "name": "api-version", + "description": "Version number of Azure Maps API.", + "type": "string", + "in": "query", + "required": true, + "default": "2.0", + "x-ms-parameter-location": "client" + }, + "FeatureStateSetDescription": { + "name": "description", + "description": "Description for the stateset. Max length allowed is 1000.", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method" + }, + "DatasetIdForCreate": { + "name": "datasetId", + "description": "The datasetId must have been obtained from a successful [Dataset Create API](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create) call.", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "method" + }, + "StatesetIdInPath": { + "name": "statesetId", + "description": "The stateset id that was created.", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "FeatureIdSet": { + "name": "featureId", + "description": "The id of a feature in the given dataset. If the featureId is not present in the dataset, Bad Request response will be returned.", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "FeatureIdGet": { + "name": "featureId", + "description": "The id of a feature in the given stateset. If no state was set for the featureId in the stateset earlier, Bad Request response will be returned.", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "FeatureIdDelete": { + "name": "featureId", + "description": "The id of a feature in the given stateset. If no state was set for the featureId in the stateset earlier, Bad Request response will be returned.", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "StateKeyNameDelete": { + "name": "stateKeyName", + "description": "The Name of the state to be deleted.", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/featureStateSets": { + "post": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis POST API allows the user to create a new Stateset and define stateset style using request body.\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Feature State API is part of Creator. \n\nThe Feature State service allows the user to update the states of a feature and query them to be used in other services. The dynamic properties of a feature that don't belong to the dataset are referred to as *states* here.\n\nThis Feature State service pivot on the Stateset. Like Tileset, Stateset encapsulates the storage mechanism for feature states for a dataset.\n\nOnce the stateset is created, users can use that statesetId to post feature state updates and retrieve the current feature states. A feature can have only one state at a given point in time. \n\nFeature state is defined by the key name, value and the timestamp. When a feature state update is posted to Azure Maps, the state value gets updated only if the provided state’s timestamp is later than the stored timestamp. \n\nAzure Maps MapControl provides a way to use these feature states to style the features. Please refer to the State Tile documentation for more information.", + "operationId": "FeatureState_CreateStateset", + "x-ms-examples": { + "Create a new stateset with a datasetId": { + "$ref": "./examples/featurestate/Featurestate_CreateStateset.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/FeaturestateApiVersionV2" + }, + { + "$ref": "#/parameters/DatasetIdForCreate" + }, + { + "$ref": "#/parameters/FeatureStateSetDescription" + }, + { + "name": "statesetCreateRequestBody", + "in": "body", + "description": "The stateset style JSON data.", + "required": true, + "schema": { + "$ref": "#/definitions/StylesObject" + } + } + ], + "responses": { + "200": { + "description": "Stateset created.", + "schema": { + "$ref": "#/definitions/StatesetCreatedResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n This API allows the caller to fetch a list of all previously successfully created statesets.", + "operationId": "FeatureState_ListStateset", + "x-ms-examples": { + "List all the previously created statesets": { + "$ref": "./examples/featurestate/Featurestate_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/FeaturestateApiVersionV2" + } + ], + "x-ms-pageable": { + "itemName": "statesets", + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "The list stateset request completed successfully. The response body contains a list of all the previously created statesets.", + "schema": { + "$ref": "#/definitions/StatesetListResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/featureStateSets/{statesetId}": { + "put": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis PUT API allows the user to update the stateset style rules.", + "operationId": "FeatureState_PutStateset", + "x-ms-examples": { + "Update stateset style rules with a statesetId": { + "$ref": "./examples/featurestate/Featurestate_UpdateStateset.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/FeaturestateApiVersionV2" + }, + { + "$ref": "#/parameters/StatesetIdInPath" + }, + { + "name": "statesetStyleUpdateRequestBody", + "in": "body", + "description": "The stateset style JSON data. Only style rules are allowed to be updated, update on keyname and type is not allowed.", + "required": true, + "schema": { + "$ref": "#/definitions/StylesObject" + } + } + ], + "responses": { + "200": { + "description": "Stateset styles are updated successfully." + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "delete": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n This DELETE API allows the user to delete the stateset and the associated data.", + "operationId": "FeatureState_DeleteStateset", + "x-ms-examples": { + "Delete an existing stateset": { + "$ref": "./examples/featurestate/Featurestate_DeleteStateset.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/FeaturestateApiVersionV2" + }, + { + "$ref": "#/parameters/StatesetIdInPath" + } + ], + "responses": { + "204": { + "description": "Stateset Deleted." + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis GET API allows the user to get the stateset Information.\n\nThe stateset Information includes the datasetId associated to the stateset, and the styles of that stateset.", + "operationId": "FeatureState_GetStateset", + "x-ms-examples": { + "Get stateset information with a statesetId": { + "$ref": "./examples/featurestate/Featurestate_GetStateset.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/FeaturestateApiVersionV2" + }, + { + "$ref": "#/parameters/StatesetIdInPath" + } + ], + "responses": { + "200": { + "description": "Get request completed successfully.", + "schema": { + "$ref": "#/definitions/StatesetGetResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/featureStateSets/{statesetId}/featureStates/{featureId}": { + "put": { + "operationId": "FeatureState_UpdateStates", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis PUT API allows the user to update the state of the given feature in the given stateset.", + "x-ms-examples": { + "Update the states of a feature": { + "$ref": "./examples/featurestate/Featurestate_UpdateStates.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/FeaturestateApiVersionV2" + }, + { + "$ref": "#/parameters/StatesetIdInPath" + }, + { + "$ref": "#/parameters/FeatureIdSet" + }, + { + "name": "featureStateUpdateRequestBody", + "in": "body", + "description": "The feature state JSON data. A feature can have only one state at a given point in time. The specified state keyname must have been defined during the stateset creation.", + "required": true, + "schema": { + "$ref": "#/definitions/FeatureStatesStructure" + } + } + ], + "responses": { + "200": { + "description": "Feature states are updated successfully." + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "delete": { + "operationId": "FeatureState_DeleteState", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n This API deletes the state information identified by the StateKeyName parameter for the feature identified by the FeatureId parameter in the the stateset.", + "x-ms-examples": { + "Delete the given feature state": { + "$ref": "./examples/featurestate/Featurestate_DeleteFeatureState.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/FeaturestateApiVersionV2" + }, + { + "$ref": "#/parameters/StatesetIdInPath" + }, + { + "$ref": "#/parameters/FeatureIdDelete" + }, + { + "$ref": "#/parameters/StateKeyNameDelete" + } + ], + "responses": { + "204": { + "description": "Feature states deleted successfully." + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "operationId": "FeatureState_GetStates", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n This API returns the current state information associated with the given feature in the given stateset.", + "x-ms-examples": { + "Get the current states of a feature": { + "$ref": "./examples/featurestate/Featurestate_GetStates.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/FeaturestateApiVersionV2" + }, + { + "$ref": "#/parameters/StatesetIdInPath" + }, + { + "$ref": "#/parameters/FeatureIdGet" + } + ], + "responses": { + "200": { + "description": "Get request completed successfully.", + "schema": { + "$ref": "#/definitions/FeatureStatesStructure" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + } + }, + "definitions": { + "StatesetGetResponse": { + "description": "The response model for the successful Stateset Get API.", + "type": "object", + "properties": { + "description": { + "description": "Description associated with the stateset.", + "type": "string", + "readOnly": true + }, + "datasetIds": { + "description": "Dataset ID associated with the stateset.", + "type": "array", + "items": { + "type": "string" + } + }, + "statesetStyle": { + "$ref": "#/definitions/StylesObject" + } + } + }, + "StatesetListResponse": { + "description": "The response model for the successful Stateset List API.", + "type": "object", + "properties": { + "statesets": { + "description": "A list of statesets information.", + "type": "array", + "items": { + "$ref": "#/definitions/StatesetInfoObject" + } + }, + "nextLink": { + "description": "If present, the location of the next page of data.", + "type": "string", + "readOnly": true + } + } + }, + "StatesetInfoObject": { + "description": "The stateset information detail.", + "type": "object", + "properties": { + "statesetId": { + "description": "The stateset ID of this stateset.", + "type": "string" + }, + "description": { + "description": "Description associated with the stateset.", + "type": "string", + "readOnly": true + }, + "datasetIds": { + "description": "Dataset ID associated with the stateset.", + "type": "array", + "items": { + "type": "string" + } + }, + "statesetStyle": { + "$ref": "#/definitions/StylesObject" + } + } + }, + "StatesetCreatedResponse": { + "description": "The response model for the successful Stateset Create API.", + "type": "object", + "properties": { + "statesetId": { + "description": "The ID for the new stateset created.", + "type": "string", + "readOnly": true + } + } + }, + "FeatureStatesStructure": { + "description": "The feature states model for a feature.", + "type": "object", + "properties": { + "states": { + "description": "The feature states array.", + "type": "array", + "items": { + "$ref": "#/definitions/FeatureStateObject" + } + } + } + }, + "FeatureStateObject": { + "description": "Single feature state model.", + "type": "object", + "properties": { + "keyName": { + "description": "Feature state Keyname. Maximum length allowed is 1000.", + "type": "string" + }, + "value": { + "description": "Value for the feature state. Type should comply with the style definition attached to the featurestate. Maximum length allowed for string type is 1024.", + "type": "string" + }, + "eventTimestamp": { + "description": "Valid Timestamp when the feature state was captured.", + "type": "string" + } + } + }, + "StylesObject": { + "description": "The styles model.", + "type": "object", + "properties": { + "styles": { + "description": "An array of stateset styles. The style rule could be a numeric or string or a boolean type style rule. Refer to NumberRuleObject, StringRuleObject and BooleanRuleObject definitions [here](https://aka.ms/AzureMapsStatesetStylesObject). ", + "type": "array", + "items": { + "$ref": "#/definitions/StyleObject" + } + } + } + }, + "NumberRuleObject": { + "description": "The numeric rule. The color is selected from the first range it falls into.", + "type": "object", + "properties": { + "range": { + "$ref": "#/definitions/RangeObject" + }, + "color": { + "description": "The color when value is within the range. Color is a JSON string in a variety of permitted formats, HTML-style hex values, RGB (\"#ff0\", \"#ffff00\", \"rgb(255, 255, 0)\"), RGBA (\"rgba(255, 255, 0, 1)\"), HSL(\"hsl(100, 50%, 50%)\"), and HSLA(\"hsla(100, 50%, 50%, 1)\"). Predefined HTML colors names, like yellow and blue, are also permitted.", + "type": "string" + } + } + }, + "RangeObject": { + "description": "The numeric value range for this style rule. If the value is in the range, all the conditions must hold true.", + "type": "object", + "properties": { + "minimum": { + "description": "All the number x that x ≥ minimum.", + "type": "number", + "format": "double" + }, + "maximum": { + "description": "All the number x that x ≤ maximum.", + "type": "number", + "format": "double" + }, + "exclusiveMinimum": { + "description": "All the number x that x > exclusiveMinimum.", + "type": "number", + "format": "double" + }, + "exclusiveMaximum": { + "description": "All the number x that x < exclusiveMaximum.", + "type": "number", + "format": "double" + } + } + }, + "BooleanRuleObject": { + "description": "The boolean rule. The color is selected based on the logic value of the key.", + "type": "object", + "properties": { + "true": { + "description": "The color when value is true. Color is a JSON string in a variety of permitted formats, HTML-style hex values, RGB (\"#ff0\", \"#ffff00\", \"rgb(255, 255, 0)\"), RGBA (\"rgba(255, 255, 0, 1)\"), HSL(\"hsl(100, 50%, 50%)\"), and HSLA(\"hsla(100, 50%, 50%, 1)\"). Predefined HTML colors names, like yellow and blue, are also permitted.", + "type": "string" + }, + "false": { + "description": "The color when value is false. Color is a JSON string in a variety of permitted formats, HTML-style hex values, RGB (\"#ff0\", \"#ffff00\", \"rgb(255, 255, 0)\"), RGBA (\"rgba(255, 255, 0, 1)\"), HSL(\"hsl(100, 50%, 50%)\"), and HSLA(\"hsla(100, 50%, 50%, 1)\"). Predefined HTML colors names, like yellow and blue, are also permitted.", + "type": "string" + } + } + }, + "StringRuleObject": { + "description": "The string rule. The string value matching is case sensitive. If a feature's state doesn't match any of the values defined here, that feature will not have any dynamic style. If duplicate string values are given, the first one takes precedence.", + "type": "object", + "additionalProperties": { + "description": "The color when the keyName value string is equal to this property name. Color is a JSON string in a variety of permitted formats, HTML-style hex values, RGB (\"#ff0\", \"#ffff00\", \"rgb(255, 255, 0)\"), RGBA (\"rgba(255, 255, 0, 1)\"), HSL(\"hsl(100, 50%, 50%)\"), and HSLA(\"hsla(100, 50%, 50%, 1)\"). Predefined HTML colors names, like yellow and blue, are also permitted.", + "type": "string" + } + }, + "StyleObject": { + "description": "The stateset style model. The style rule could be a numeric type style rule or a boolean type style rule. Refer to NumberRuleObject, StringRuleObject and BooleanRuleObject definitions [here](https://aka.ms/AzureMapsStatesetStylesObject). ", + "discriminator": "type", + "type": "object", + "required": [ + "keyName", + "type" + ], + "properties": { + "keyName": { + "description": "Stateset style key name. Key names are random strings but they should be unique inside style array.", + "type": "string" + }, + "type": { + "description": "The type of stateset style.", + "type": "string", + "enum": [ + "boolean", + "number", + "string" + ], + "x-ms-enum": { + "name": "StyleObjectType", + "modelAsString": true, + "values": [ + { + "value": "boolean", + "description": "Boolean type of stateset style.", + "name": "BooleanTypeStyleRule" + }, + { + "value": "number", + "description": "Number type of stateset style.", + "name": "NumberTypeStyleRule" + }, + { + "value": "string", + "description": "String type of stateset style.", + "name": "StringTypeStyleRule" + } + ] + } + } + } + }, + "BooleanTypeStyleRule": { + "description": "The boolean type style rule object.", + "x-ms-discriminator-value": "boolean", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StyleObject" + } + ], + "properties": { + "rules": { + "description": "Boolean style rules.", + "type": "array", + "items": { + "$ref": "#/definitions/BooleanRuleObject" + } + } + }, + "required": [ + "rules" + ] + }, + "NumberTypeStyleRule": { + "description": "The numeric type style rule object.", + "x-ms-discriminator-value": "number", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StyleObject" + } + ], + "properties": { + "rules": { + "description": "Numeric style rules.", + "type": "array", + "items": { + "$ref": "#/definitions/NumberRuleObject" + } + } + }, + "required": [ + "rules" + ] + }, + "StringTypeStyleRule": { + "description": "The string type style rule object.", + "x-ms-discriminator-value": "string", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StyleObject" + } + ], + "properties": { + "rules": { + "description": "String style rules.", + "type": "array", + "items": { + "$ref": "#/definitions/StringRuleObject" + } + } + }, + "required": [ + "rules" + ] + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/tileset.json b/specification/maps/data-plane/Creator/preview/2.0/tileset.json new file mode 100644 index 000000000000..9fce23346941 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/tileset.json @@ -0,0 +1,321 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Tileset Service", + "version": "2.0", + "description": "APIs for managing Tilesets." + }, + "x-ms-parameterized-host": { + "hostTemplate": "{geography}.atlas.microsoft.com", + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "AzureKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "AzureKey": [] + } + ], + "responses": {}, + "parameters": { + "TilesetApiVersionV2": { + "name": "api-version", + "description": "Version number of Azure Maps API.", + "type": "string", + "in": "query", + "required": true, + "default": "2.0", + "x-ms-parameter-location": "client" + }, + "DatasetIdQuery": { + "name": "datasetId", + "description": "The unique `datasetId` that the tileset create API uses to retrieve features to generate tiles. The `datasetId` must have been obtained from a successful [Dataset Create API](/en-us/rest/api/maps/dataset/createpreview) call.", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "method" + }, + "TilesetId": { + "name": "tilesetId", + "description": "The Tileset Id", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "DescriptionTileset": { + "name": "description", + "description": "User provided description of the tileset.", + "type": "string", + "in": "query", + "x-ms-parameter-location": "method" + }, + "TilesetOperationId": { + "name": "operationId", + "type": "string", + "in": "path", + "description": "The ID to query the status for the dataset create/import request.", + "required": true, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/tilesets": { + "post": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe Tileset Create API allows the caller to create a tileset from a dataset. A tileset contains a set of tiles that can be consumed \nfrom the [Get Map Tile](/rest/api/maps/render/getmaptile) to retrieve custom tiles. To make a dataset, use the \n[DataSet Create API](/rest/api/maps/dataset/createpreview).\n\n## Submit Create Request\n\nTo create your tileset you will make a `POST` request with an empty body. The `datasetId` query parameter will be \nused as the source of the tileset data.\n\nThe Create Tileset API is a \n[long-running request](https://aka.ms/am-creator-lrt-v2).", + "operationId": "Tileset_Create", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Create Tileset by providing a Dataset Id": { + "$ref": "./examples/tileset/Tileset_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/TilesetApiVersionV2" + }, + { + "$ref": "#/parameters/DatasetIdQuery" + }, + { + "$ref": "#/parameters/DescriptionTileset" + } + ], + "responses": { + "200": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" + }, + "202": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/202AsyncV2" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a list of all tilesets created. \n
    ", + "operationId": "Tileset_List", + "x-ms-examples": { + "Get a list of all tilesets": { + "$ref": "./examples/tileset/Tileset_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/TilesetApiVersionV2" + } + ], + "x-ms-pageable": { + "itemName": "tilesets", + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "List tileset request completed successfully. The response body contains a list of all tilesets.", + "schema": { + "$ref": "#/definitions/TilesetListResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/tilesets/{tilesetId}": { + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a tileset.", + "operationId": "Tileset_Get", + "x-ms-examples": { + "Gets the details for a single tileset": { + "$ref": "./examples/tileset/Tileset_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/TilesetApiVersionV2" + }, + { + "$ref": "#/parameters/TilesetId" + } + ], + "responses": { + "200": { + "description": "List tileset request completed successfully. The response body contains a list of all tilesets.", + "schema": { + "$ref": "#/definitions/TilesetDetailInfo" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "delete": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to delete a created tileset.
    \nYou can use this API if a tileset is no longer needed. \n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `tilesetId` of the tileset to delete.
    \n\n#### Delete request \"Successful\"\n\nThe Tileset Delete API returns a HTTP `204 No Content` response with an empty body, if the tileset was deleted successfully.
    \n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the tileset with the passed-in `tilesetId` is not found. \n\nHere is a sample error response:\n\n
    \n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - Tileset Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", + "operationId": "Tileset_Delete", + "x-ms-examples": { + "Delete a created tileset": { + "$ref": "./examples/tileset/Tileset_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/TilesetApiVersionV2" + }, + { + "$ref": "#/parameters/TilesetId" + } + ], + "responses": { + "204": { + "description": "Tileset delete request completed successfully." + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/tilesets/operations/{operationId}": { + "get": { + "description": "This path will be obtained from a call to /tilesets/create. While in progress, an http200 will be returned with no extra headers - followed by an http200 with Resource-Location header once successfully completed.", + "operationId": "Tileset_GetOperation", + "x-ms-examples": { + "Get the status of an operation which is still running": { + "$ref": "./examples/tileset/Tileset_GetOperationStillRunning.json" + }, + "Get the status of an operation which has finished successfully": { + "$ref": "./examples/tileset/Tileset_GetOperation.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/TilesetApiVersionV2" + }, + { + "$ref": "#/parameters/TilesetOperationId" + } + ], + "responses": { + "200": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + } + }, + "definitions": { + "TilesetListResponse": { + "description": "The response model for the Tileset List API. Returns a list of all tilesets.", + "type": "object", + "properties": { + "tilesets": { + "description": "A list of all tilesets.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TilesetDetailInfo" + } + }, + "nextLink": { + "description": "If present, the location of the next page of data.", + "type": "string", + "readOnly": true + } + } + }, + "TilesetDetailInfo": { + "description": "Detail information for the data.", + "type": "object", + "properties": { + "tilesetId": { + "description": "The unique tileset id for the tileset.", + "type": "string", + "readOnly": true + }, + "ontology": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" + }, + "datasetId": { + "description": "The unique dataset Id used to create the tileset.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The description the caller provided when creating the tileset. Maximum length 1024 characters.", + "type": "string", + "readOnly": true + }, + "minZoom": { + "description": "The lowest tile zoom level tile generated for the tileset.", + "type": "integer", + "readOnly": true + }, + "maxZoom": { + "description": "The highest tile zoom level tile generated for the tileset.", + "type": "integer", + "readOnly": true + }, + "bbox": { + "description": "Bounding box which all features of the tileset lay within. Projection used - EPSG:3857. Format : 'minLon, minLat, maxLon, maxLat'.", + "type": "array", + "readOnly": true, + "items": { + "type": "number" + } + } + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2.0/wfs.json b/specification/maps/data-plane/Creator/preview/2.0/wfs.json new file mode 100644 index 000000000000..ee4f3714c9ff --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2.0/wfs.json @@ -0,0 +1,739 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Web Feature Service", + "version": "2.0", + "description": "Azure Maps Web Feature REST APIs" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{geography}.atlas.microsoft.com", + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "AzureKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "AzureKey": [] + } + ], + "responses": {}, + "parameters": { + "WFSApiVersionV2": { + "name": "api-version", + "description": "Version number of Azure Maps API.", + "type": "string", + "in": "query", + "required": true, + "default": "2.0", + "x-ms-parameter-location": "client" + }, + "LimitWfs": { + "name": "limit", + "in": "query", + "type": "integer", + "minimum": 1, + "maximum": 50, + "description": "The optional limit parameter limits the number of features that are presented in the response document.\nOnly features that are on the first level of the collection in the response document are counted. Nested objects contained within the explicitly requested features shall not be counted.\n* Minimum = 1 * Maximum = 50 * Default = 10", + "x-ms-parameter-location": "method" + }, + "Filter": { + "name": "filter", + "in": "query", + "type": "string", + "description": "Filter expression to search for features with specific property values in a given collection. Only feature properties of scalar type and equals operator are supported.\nThis is a special parameter where the parameter name is a case sensitive property name. The scheme for this parameter is {property name}={property value}. Unless \"filter\" is one of the property names in the collection, \"filter\" should not be used as a parameter name. To search for features with \"name\" property value \"21N13\", use \"name=21N13\".\nMultiple filters are supported and should be represented as multiple query parameters. E.g., =&= String values are case sensitive.", + "x-ms-parameter-location": "method" + }, + "Bbox": { + "name": "bbox", + "in": "query", + "type": "string", + "description": "Only features that have a geometry that intersects the supplied bounding box are selected.\n* Lower left corner, coordinate axis 1 * Lower left corner, coordinate axis 2 * Upper right corner, coordinate axis 1 * Upper right corner, coordinate axis 2\nThe coordinate reference system of the values is WGS84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless a different coordinate reference system is specified in the parameter `bbox-crs`.\nFor WGS84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge).", + "x-ms-parameter-location": "method" + }, + "CollectionId": { + "name": "collectionId", + "in": "path", + "type": "string", + "required": true, + "description": "Identifier (name) of a specific collection", + "x-ms-parameter-location": "method" + }, + "FeatureId": { + "name": "featureId", + "in": "path", + "type": "string", + "description": "Local identifier of a specific feature", + "required": true, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/wfs/datasets/{datasetId}/": { + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Landing Page API provides links to the API definition, the Conformance statements and the metadata about the feature data in this dataset.", + "operationId": "WFS_GetLandingPage", + "x-ms-examples": { + "GetLandingPage": { + "$ref": "./examples/wfs/WFS_GetLandingPage.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/WFSApiVersionV2" + }, + { + "$ref": "dataset.json#/parameters/DatasetId" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/LandingPageResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/wfs/datasets/{datasetId}/conformance": { + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Requirements Classes lists all requirements classes specified in the standard that the server conforms to.", + "operationId": "WFS_GetConformance", + "x-ms-examples": { + "GetConformance": { + "$ref": "./examples/wfs/WFS_GetConformance.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/WFSApiVersionV2" + }, + { + "$ref": "dataset.json#/parameters/DatasetId" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/ConformanceResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/wfs/datasets/{datasetId}/collections": { + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Collections Description API provides descriptions of all the collections in a given dataset.", + "operationId": "WFS_GetCollections", + "x-ms-examples": { + "GetCollections": { + "$ref": "./examples/wfs/WFS_GetCollections.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/WFSApiVersionV2" + }, + { + "$ref": "dataset.json#/parameters/DatasetId" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/CollectionsResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/wfs/datasets/{datasetId}/collections/{collectionId}": { + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n \nThe Collection Description API provides the description of a given collection. It includes the links to the operations that can be performed on the collection.", + "operationId": "WFS_GetCollection", + "x-ms-examples": { + "GetCollection": { + "$ref": "./examples/wfs/WFS_GetCollection.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/WFSApiVersionV2" + }, + { + "$ref": "dataset.json#/parameters/DatasetId" + }, + { + "$ref": "#/parameters/CollectionId" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/CollectionInfo" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/wfs/datasets/{datasetId}/collections/{collectionId}/definition": { + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n \nThe Collection Definition API provides the detailed data model of a given collection.", + "operationId": "WFS_GetCollectionDefinition", + "x-ms-examples": { + "GetCollectionDefinition": { + "$ref": "./examples/wfs/WFS_GetCollectionDefinition.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/WFSApiVersionV2" + }, + { + "$ref": "dataset.json#/parameters/DatasetId" + }, + { + "$ref": "#/parameters/CollectionId" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/CollectionDefinitionResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/wfs/datasets/{datasetId}/collections/{collectionId}/items": { + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Features API returns the list of features in the given collection.", + "operationId": "WFS_GetFeatures", + "x-ms-examples": { + "GetFeatures": { + "$ref": "./examples/wfs/WFS_GetFeatures.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/WFSApiVersionV2" + }, + { + "$ref": "dataset.json#/parameters/DatasetId" + }, + { + "$ref": "#/parameters/CollectionId" + }, + { + "$ref": "#/parameters/LimitWfs" + }, + { + "$ref": "#/parameters/Bbox" + }, + { + "$ref": "#/parameters/Filter" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/ExtendedGeoJsonFeatureCollection" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/wfs/datasets/{datasetId}/collections/{collectionId}/items/{featureId}": { + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Feature API returns the feature identified by the provided id in the given collection.", + "operationId": "WFS_GetFeature", + "x-ms-examples": { + "GetFeature": { + "$ref": "./examples/wfs/WFS_GetFeature.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/WFSApiVersionV2" + }, + { + "$ref": "dataset.json#/parameters/DatasetId" + }, + { + "$ref": "#/parameters/CollectionId" + }, + { + "$ref": "#/parameters/FeatureId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FeatureResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "delete": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Delete Feature API deletes the feature identified by the provided id in the given collection. At this point this API supports only facility features. Deleting a facility feature deletes all the child features of that facility recursively.", + "operationId": "WFS_DeleteFeature", + "x-ms-examples": { + "DeleteFeature": { + "$ref": "./examples/wfs/WFS_DeleteFeature.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/WFSApiVersionV2" + }, + { + "$ref": "dataset.json#/parameters/DatasetId" + }, + { + "$ref": "#/parameters/CollectionId" + }, + { + "$ref": "#/parameters/FeatureId" + } + ], + "responses": { + "204": { + "description": "Feature Deleted." + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + } + }, + "definitions": { + "LandingPageResponse": { + "type": "object", + "required": [ + "links" + ], + "properties": { + "ontology": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" + }, + "links": { + "description": "Links to other WFS endpoints.", + "type": "array", + "items": { + "$ref": "#/definitions/WfsEndpointLink" + } + } + } + }, + "ConformanceResponse": { + "type": "object", + "required": [ + "conformsTo" + ], + "properties": { + "conformsTo": { + "description": "List of requirements classes that the server conforms to.", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "http://www.opengis.net/spec/wfs-1/3.0/req/core", + "http://www.opengis.net/spec/wfs-1/3.0/req/oas30", + "http://www.opengis.net/spec/wfs-1/3.0/req/html", + "http://www.opengis.net/spec/wfs-1/3.0/req/geojson" + ] + } + } + }, + "WfsEndpointLink": { + "description": "Links to other WFS endpoints", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "The link target.", + "type": "string" + }, + "rel": { + "description": "The relation type.", + "type": "string", + "example": "prev" + }, + "type": { + "description": "A hint indicating what the media type of the result of dereferencing the link should be.", + "type": "string", + "example": "application/geo+json" + }, + "hreflang": { + "description": "A hint indicating what the language of the result of dereferencing the link should be.", + "type": "string", + "example": "en" + }, + "title": { + "description": "Used to label the destination of a link such that it can be used as a human-readable identifier (e.g., a menu entry) in the language indicated by the Content-Language header field (if present).", + "type": "string" + } + } + }, + "CollectionsResponse": { + "type": "object", + "required": [ + "links", + "collections" + ], + "properties": { + "ontology": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" + }, + "links": { + "description": "Links to other WFS endpoints.", + "type": "array", + "items": { + "$ref": "#/definitions/WfsEndpointLink" + }, + "example": [ + { + "href": "http://data.example.org/collections.json", + "rel": "self", + "type": "application/json", + "title": "this document" + }, + { + "href": "http://data.example.org/collections.html", + "rel": "alternate", + "type": "text/html", + "title": "this document as HTML" + }, + { + "href": "http://schemas.example.org/1.0/foobar.xsd", + "rel": "describedBy", + "type": "application/xml", + "title": "XML schema for Acme Corporation data" + } + ] + }, + "collections": { + "description": "All the collections in a given dataset.", + "type": "array", + "items": { + "$ref": "#/definitions/CollectionInfo" + } + } + } + }, + "CollectionInfo": { + "type": "object", + "required": [ + "name", + "links" + ], + "properties": { + "name": { + "description": "identifier of the collection used, for example, in URIs", + "type": "string", + "example": "buildings" + }, + "title": { + "description": "human readable title of the collection", + "type": "string", + "example": "Buildings" + }, + "ontology": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" + }, + "description": { + "description": "a description of the features in the collection", + "type": "string", + "example": "Buildings in the city of Bonn." + }, + "links": { + "description": "Links to other WFS endpoints.", + "type": "array", + "items": { + "$ref": "#/definitions/WfsEndpointLink" + }, + "example": [ + { + "href": "http://data.example.org/collections/buildings/items", + "rel": "item", + "type": "application/geo+json", + "title": "Buildings" + }, + { + "href": "http://example.org/concepts/building.html", + "rel": "describedBy", + "type": "text/html", + "title": "Feature catalogue for buildings" + } + ] + } + } + }, + "CollectionDefinitionResponse": { + "description": "collection of GeoJSON features", + "type": "object", + "required": [ + "idPrefix", + "name", + "geometryType", + "featureTypes" + ], + "properties": { + "description": { + "description": "describes the collection", + "type": "string" + }, + "idPrefix": { + "description": "prefix of the collection used", + "type": "string", + "example": "BLD" + }, + "name": { + "description": "identifier of the collection used, for example, in URIs", + "type": "string", + "example": "buildings" + }, + "title": { + "description": "title of collection", + "type": "string", + "example": "Feature Class buildings" + }, + "ontology": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" + }, + "geometryType": { + "description": "type of geometry returned", + "type": "string", + "enum": [ + "Point", + "MultiPoint", + "LineString", + "MultiLineString", + "Polygon", + "MultiPolygon", + "GeometryCollection" + ], + "x-ms-enum": { + "name": "GeoJsonGeometryType", + "modelAsString": true, + "values": [ + { + "value": "Point", + "description": "`GeoJSON Point` geometry.", + "name": "GeoJsonPoint" + }, + { + "value": "MultiPoint", + "description": "`GeoJSON MultiPoint` geometry.", + "name": "GeoJsonMultiPoint" + }, + { + "value": "LineString", + "description": "`GeoJSON LineString` geometry.", + "name": "GeoJsonLineString" + }, + { + "value": "MultiLineString", + "description": "`GeoJSON MultiLineString` geometry.", + "name": "GeoJsonMultiLineString" + }, + { + "value": "Polygon", + "description": "`GeoJSON Polygon` geometry.", + "name": "GeoJsonPolygon" + }, + { + "value": "MultiPolygon", + "description": "`GeoJSON MultiPolygon` geometry.", + "name": "GeoJsonMultiPolygon" + }, + { + "value": "GeometryCollection", + "description": "`GeoJSON GeometryCollection` geometry.", + "name": "GeoJsonGeometryCollection" + } + ] + } + }, + "featureTypes": { + "description": "type of features returned", + "type": "array", + "items": { + "type": "string" + } + }, + "properties": { + "x-ms-client-flatten": true, + "description": "attributes of the collection used", + "type": "array", + "items": { + "$ref": "#/definitions/DefinitionProperties" + } + }, + "links": { + "description": "Links to other WFS endpoints.", + "type": "array", + "items": { + "$ref": "#/definitions/WfsEndpointLink" + } + } + } + }, + "DefinitionProperties": { + "type": "object", + "required": [ + "name", + "required", + "type" + ], + "properties": { + "name": { + "description": "name of attribute", + "type": "string", + "example": "external_id" + }, + "required": { + "description": "is attribute required", + "type": "boolean" + }, + "type": { + "description": "type of attribute", + "type": "object" + } + } + }, + "ExtendedGeoJsonFeatureCollection": { + "description": "A valid `GeoJSON FeatureCollection` object type extended with numberReturned and links array. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details.", + "x-ms-discriminator-value": "FeatureCollection", + "type": "object", + "allOf": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonFeatureCollection" + }, + { + "$ref": "#/definitions/ExtendedGeoJsonFeatureCollectionData" + } + ] + }, + "ExtendedGeoJsonFeatureCollectionData": { + "type": "object", + "properties": { + "ontology": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" + }, + "numberReturned": { + "description": "Number of returned features.", + "type": "integer" + }, + "links": { + "description": "Links to other WFS endpoints.", + "type": "array", + "items": { + "$ref": "#/definitions/WfsEndpointLink" + } + } + } + }, + "FeatureResponse": { + "type": "object", + "required": [ + "feature" + ], + "properties": { + "ontology": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" + }, + "feature": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonFeature" + }, + "links": { + "description": "Links to other WFS endpoints.", + "type": "array", + "items": { + "$ref": "#/definitions/WfsEndpointLink" + } + } + } + } + } +} diff --git a/specification/maps/data-plane/Creator/readme.csharp.md b/specification/maps/data-plane/Creator/readme.csharp.md new file mode 100644 index 000000000000..aa39958689da --- /dev/null +++ b/specification/maps/data-plane/Creator/readme.csharp.md @@ -0,0 +1,13 @@ +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +sync-methods: None +license-header: MICROSOFT_MIT_NO_VERSION +namespace: Azure.Maps.Creator +output-folder: $(csharp-sdks-folder)/maps/Azure.Maps.Creator/src/Generated +clear-output-folder: true +public-clients: true +``` \ No newline at end of file diff --git a/specification/maps/data-plane/Creator/readme.go.md b/specification/maps/data-plane/Creator/readme.go.md new file mode 100644 index 000000000000..77fa1c39476c --- /dev/null +++ b/specification/maps/data-plane/Creator/readme.go.md @@ -0,0 +1,26 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +license-header: MICROSOFT_MIT_NO_VERSION +namespace: creator +clear-output-folder: true +export-clients: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: 2.0-preview +``` + +### Tag: 2.0-preview and go + +These settings apply only when `--tag=2.0-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == '2.0-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/maps/2.0/$(namespace) +``` \ No newline at end of file diff --git a/specification/maps/data-plane/Creator/readme.java.md b/specification/maps/data-plane/Creator/readme.java.md new file mode 100644 index 000000000000..a60e52a050f0 --- /dev/null +++ b/specification/maps/data-plane/Creator/readme.java.md @@ -0,0 +1,9 @@ +## Java + +``` yaml $(java) +java: + namespace: com.azure.maps.creator + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 0 + output-folder: $(azure-libraries-for-java-folder)/azure-maps-creator +``` \ No newline at end of file diff --git a/specification/maps/data-plane/Creator/readme.md b/specification/maps/data-plane/Creator/readme.md new file mode 100644 index 000000000000..21e84387e125 --- /dev/null +++ b/specification/maps/data-plane/Creator/readme.md @@ -0,0 +1,96 @@ +# Azure Creator + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Creator Client + +--- + +## Getting Started + +To build the SDK for Creator, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +### Basic Information + +These are the global settings for Creator Client. + +``` yaml +title: CreatorClient +openapi-type: data-plane +tag: 2.0-preview +# at some point those credentials will move away to Swagger according to [this](https://github.com/Azure/autorest/issues/3718) +add-credentials: true +credential-default-policy-type: BearerTokenCredentialPolicy +credential-scopes: https://atlas.microsoft.com/.default +``` + + +### Tag: 2.0-preview + +These settings apply only when `--tag=2.0-preview` is specified on the command line. + +``` yaml $(tag) == '2.0-preview' +input-file: + - preview/2.0/alias.json + - preview/2.0/data.json + - preview/2.0/dataset.json + - preview/2.0/dwgconversion.json + - preview/2.0/featurestate.json + - preview/1.0/spatial.json + - preview/2.0/tileset.json + - preview/2.0/wfs.json +``` + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-java + + #track1 doesn't support data-plane for go + #manually generate for now with track2 + #- repo: azure-sdk-for-go + + #track1 doesn't support features needed for typescript + #manually generate for now with track2 + #- repo: azure-sdk-for-js + + #should be azure-sdk-for-net-track2, but SDK has not yet onboarded + #manually generate for now with track2 + - repo: azure-sdk-for-net +``` +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Java + +See configuration in [readme.java.md](./readme.java.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) diff --git a/specification/maps/data-plane/Creator/readme.python.md b/specification/maps/data-plane/Creator/readme.python.md new file mode 100644 index 000000000000..e21d59809285 --- /dev/null +++ b/specification/maps/data-plane/Creator/readme.python.md @@ -0,0 +1,22 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +license-header: MICROSOFT_MIT_NO_VERSION +namespace: azure.maps.creator +package-name: azure-maps-creator +package-version: 2.0-preview +clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +no-namespace-folders: true +output-folder: $(python-sdks-folder)/maps/azure-maps-creator/azure/maps/creator +``` +``` yaml $(python) && $(python-mode) == 'create' +basic-setup-py: true +output-folder: $(python-sdks-folder)/maps/azure-maps-creator +``` diff --git a/specification/maps/data-plane/Creator/readme.typescript.md b/specification/maps/data-plane/Creator/readme.typescript.md new file mode 100644 index 000000000000..2e8a6b4035a6 --- /dev/null +++ b/specification/maps/data-plane/Creator/readme.typescript.md @@ -0,0 +1,44 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +azure-arm: false +package-name: "@azure/maps-creator" +license-header: MICROSOFT_MIT_NO_VERSION +output-folder: "$(typescript-sdks-folder)/sdk/maps/maps-creator" +source-code-folder-path: "" +clear-output-folder: false +generate-metadata: false +directive: + - from: spatial.json + where: $.parameters.SearchGeofenceRequestBody.schema + transform: > + $ = { + "type": "object" + }; + reason: Autorest TS codegen does not deserialize array of base class objects as an operation parameter properly -> https://github.com/Azure/autorest.typescript/issues/1040 + - from: spatial.json + where: $.parameters.ClosestPointRequestBody.schema + transform: > + $ = { + "type": "object" + }; + reason: Autorest TS codegen does not deserialize array of base class objects as an operation parameter properly -> https://github.com/Azure/autorest.typescript/issues/1040 + - from: spatial.json + where: $.parameters.PointInPolygonRequestBody.schema + transform: > + $ = { + "type": "object" + }; + reason: Autorest TS codegen does not deserialize array of base class objects as an operation parameter properly -> https://github.com/Azure/autorest.typescript/issues/1040 + - from: spatial.json + where: $.definitions.BufferRequestBody.properties.geometries + transform: > + $ = { + "description": "A valid `GeoJSON FeatureCollection` object type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details.", + "type": "object" + }; + reason: Autorest TS codegen does not deserialize array of base class objects as an operation parameter properly -> https://github.com/Azure/autorest.typescript/issues/1040 +``` diff --git a/specification/maps/data-plane/DEM/preview/1.0/elevation.json b/specification/maps/data-plane/DEM/preview/1.0/elevation.json new file mode 100644 index 000000000000..94f0caf75028 --- /dev/null +++ b/specification/maps/data-plane/DEM/preview/1.0/elevation.json @@ -0,0 +1,399 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Elevation API", + "version": "1.0", + "description": "The Azure Maps Elevation API provides an HTTP interface to query elevation data on the surface of the Earth. Elevation data can be retrieved at specific locations by sending lat/lon coordinates, by defining an ordered set of vertices that form a Polyline and a number of sample points along the length of a Polyline, or by defining a bounding box that consists of equally spaced vertices as rows and columns. The vertical datum is EPSG:3855. This datum uses the EGM2008 geoid model applied to the WGS84 ellipsoid as its zero height reference surface. The vertical unit is measured in meters, the spatial resolution of the elevation data is 0.8 arc-second for global coverage (~24 meters)." + }, + "x-ms-parameterized-host": { + "hostTemplate": "{geography}.atlas.microsoft.com", + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "AzureKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "AzureKey": [] + } + ], + "responses": {}, + "parameters": { + "ElevationApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API.", + "type": "string", + "in": "query", + "required": true, + "default": "1.0", + "x-ms-parameter-location": "client" + } + }, + "paths": { + "/elevation/point/{format}": { + "get": { + "summary": "Get Elevation Data on One or More Points", + "description": "**Applies to**: S1 pricing tier.\n\nThe Get Data for Points API provides elevation data for one or more points. A point is defined in lat,long coordinate format.\n\n Due to the URL character length limit of 2048, it's not possible to pass more than 100 coordinates as a pipeline delimited string in a URL GET request. If you intend to pass more than 100 coordinates as a pipeline delimited string, use the [POST Data\n For Points](https://docs.microsoft.com/en-us/rest/api/maps/elevation/postdataforpoints).", + "operationId": "Elevation_GetDataForPoints", + "x-ms-examples": { + "GetDataForPoints": { + "$ref": "./examples/GetDataForPoints.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ElevationApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "points", + "in": "query", + "description": "The string representation of a list of points. A point is defined in lon/lat WGS84 coordinate reference system format. If multiple points are requested, each of the points in a list should be separated by the pipe ('|') character. The maximum number of points that can be requested in a single request is 2,000. The resolution of the elevation data will be the highest for a single point and will decrease if multiple points are spread further apart. ", + "required": true, + "type": "array", + "collectionFormat": "pipes", + "x-ms-skip-url-encoding": true, + "items": { + "type": "string", + "pattern": "\\s*[-]?\\d+[.]\\d+\\s*[,]\\s*[-]?\\d+[.]\\d+\\s*" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PointsResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "post": { + "summary": "Query Elevation Data for Multiple Points", + "description": "**Applies to**: S1 pricing tier.\n\nThe Post Data for Points API provides elevation data for multiple points. A point is defined lon/lat coordinate format. Use the POST endpoint only if you intend to pass multiple points in the request. If you intend to pass a single coordinate into the API, use the [GET Data For Points API](https://docs.microsoft.com/en-us/rest/api/maps/elevation/getdataforpoints).", + "operationId": "Elevation_PostDataForPoints", + "x-ms-examples": { + "PostDataForPoints": { + "$ref": "./examples/PostDataForPoints.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ElevationApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "pointsRequestBody", + "in": "body", + "description": "The string representation of a list of points. A point is defined in lon/lat WGS84 coordinate reference system format. Each points in a list should be separated by the pipe ('|') character. The number of points that can be requested in a POST request ranges from 2 to 2,000. The resolution of the elevation data will be the highest for a single point and will decrease if multiple points are spread further apart. ", + "required": true, + "schema": { + "$ref": "#/definitions/PointsInRequestBody" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PointsResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/elevation/line/{format}": { + "get": { + "summary": "Get Elevation Data Along a Polyline", + "description": "**Applies to**: S1 pricing tier.\n\nThe Get Data for Polyline API provides elevation data along a polyline.\n\n A polyline is defined by passing in between 2 and N endpoint coordinates separated by a pipe ('|') character. In addition to passing in endpoints, customers can specify the number of sample points that will be used to divide polyline into equally spaced segments. Elevation data at both start and endpoints and equally spaced points along the polyline will be returned.\n\n A line between two endpoints is a straight Cartesian line, the shortest line between those two points in the coordinate reference system. Note that the point is chosen based on Euclidean distance and may markedly differ from the geodesic path along the curved surface of the reference ellipsoid.", + "operationId": "Elevation_GetDataForPolyline", + "x-ms-examples": { + "GetDataForPolyLine": { + "$ref": "./examples/GetDataForPolyline.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ElevationApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "lines", + "in": "query", + "description": "The string representation of a polyline path. A polyline is defined by endpoint coordinates, with each endpoint separated by a pipe ('|') character. The polyline should be defined in the following format: `[longitude_point1, latitude_point1 | longitude_point2, latitude_point2, ..., longitude_pointN, latitude_pointN]`.\n\n The longitude and latitude values refer to the World Geodetic System (WGS84) coordinate reference system. The resolution of the data used to compute the elevation depends on the distance between the endpoints.", + "required": true, + "type": "array", + "collectionFormat": "pipes", + "x-ms-skip-url-encoding": true, + "items": { + "type": "string", + "pattern": "\\s*[-]?\\d+[.]\\d+\\s*[,]\\s*[-]?\\d+[.]\\d+\\s*" + } + }, + { + "name": "samples", + "in": "query", + "description": "The samples parameter specifies the number of equally spaced points at which elevation values should be provided along a polyline path. The number of samples should range from 2 to 2,000. Default value is 10.", + "type": "integer", + "minimum": 2, + "maximum": 2000 + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LinesResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "post": { + "summary": "Query Elevation Data Along a Polyline", + "description": "**Applies to**: S1 pricing tier.\n\n The Post Data for Polyline API provides elevation data along a polyline. A polyline is defined by passing in between 2 and N endpoint coordinates separated by a pipe ('|') character. In addition to passing in endpoints, customers can specify the number of sample points that will be used to divide polyline into equally spaced segments.\n\n Elevation data at both start and end points and equally spaced points along the polyline will be returned. A line between two endpoints is a straight Cartesian line, the shortest line between those two points in the coordinate reference system. Note that the point is chosen based on Euclidean distance and may markedly differ from the geodesic path along the curved surface of the reference ellipsoid.", + "operationId": "Elevation_PostDataForPolyline", + "x-ms-examples": { + "PostDataForPolyLine": { + "$ref": "./examples/PostDataForPolyline.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ElevationApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "linesRequestBody", + "in": "body", + "description": "The string representation of a polyline path. A polyline is defined by endpoint coordinates, with each endpoint separated by a pipe ('|') character. The polyline should be defined in the following format: `[longitude_point1, latitude_point1 | longitude_point2, latitude_point2, ..., longitude_pointN, latitude_pointN]`. The longitude and latitude values refer to the World Geodetic System (WGS84) coordinate reference system. The resolution of the data used to compute the elevation will depend on the distance between the endpoints.", + "required": true, + "schema": { + "$ref": "#/definitions/LinesInRequestBody" + } + }, + { + "name": "samples", + "in": "query", + "description": "The samples parameter specifies the number of equally spaced points at which elevation values should be provided along a polyline path. The number of samples should range from 2 to 2,000. Default value is 10.", + "type": "integer", + "minimum": 2, + "maximum": 2000 + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LinesResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/elevation/lattice/{format}": { + "get": { + "summary": "Get Elevation Data at Equally Spaced Locations Within a Bounding Box", + "description": "**Applies to**: S1 pricing tier.\n\nThe Get Data for Bounding Box API provides elevation data at equally spaced locations within a bounding box. A bounding box is defined by the coordinates for two corners (southwest, northeast) and then subsequently divided into rows and columns.\n\n Elevations are returned for the vertices of the grid created by the rows and columns. Up to 2,000 elevations can be returned in a single request. The returned elevation values are ordered, starting at the southwest corner, and then proceeding west to east along the row. At the end of the row, it moves north to the next row, and repeats the process until it reaches the far northeast corner.", + "operationId": "Elevation_GetDataForBoundingBox", + "x-ms-examples": { + "GetDataForBoundingBox": { + "$ref": "./examples/GetDataForBoundingBox.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ElevationApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "bounds", + "in": "query", + "description": "The string that represents the rectangular area of a bounding box. The bounds parameter is defined by the 4 bounding box coordinates, with WGS84 longitude and latitude of the southwest corner followed by WGS84 longitude and latitude of the northeast corner. The string is presented in the following format: `[SouthwestCorner_Longitude, SouthwestCorner_Latitude, NortheastCorner_Longitude, NortheastCorner_Latitude]`.", + "required": true, + "type": "array", + "items": { + "type": "string" + } + }, + { + "name": "rows", + "in": "query", + "description": "Specifies the number of rows to use to divide the bounding box area into a grid. The number of vertices in the grid should be less than 2,000. ", + "type": "integer", + "minimum": 2, + "maximum": 1000, + "required": true + }, + { + "name": "columns", + "in": "query", + "description": "Specifies the number of columns to use to divide the bounding box area into a grid. The number of vertices in the grid should be less than 2,000. ", + "type": "integer", + "minimum": 2, + "maximum": 1000, + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BoundingBoxResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + } + }, + "definitions": { + "ElevationPointResponse": { + "description": "The response for point/points elevation API. The result will be in same sequence of points listed in request.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/PointElevationResult" + } + }, + "PointElevationResult": { + "type": "object", + "description": "The elevation data.", + "properties": { + "coordinate": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/CoordinatesPair" + }, + "elevationInMeter": { + "description": "The elevation value in meters.", + "type": "number", + "readOnly": true + } + } + }, + "ElevationLineResponse": { + "description": "The response from the Get Data for Polyline API. The results will be listed in the direction from the first endpoint towards the last endpoint.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/PointElevationResult" + } + }, + "ElevationLatticeResponse": { + "description": "The response from the Get Data for Bounding Box API. The results are ordered starting with the southwest corner, and then proceed west to east and south to north.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/PointElevationResult" + } + }, + "PointsResult": { + "type": "object", + "description": "The response from a successful Elevation Points request.", + "properties": { + "data": { + "$ref": "#/definitions/ElevationPointResponse" + } + } + }, + "LinesResult": { + "type": "object", + "description": "The response from a successful Elevation Polyline request.", + "properties": { + "data": { + "$ref": "#/definitions/ElevationLineResponse" + } + } + }, + "BoundingBoxResult": { + "type": "object", + "description": "The response from a successful Get Data for Bounding Box API.", + "properties": { + "data": { + "$ref": "#/definitions/ElevationLatticeResponse" + } + } + }, + "PointsInRequestBody": { + "type": "array", + "description": "The post elevation points array request body. The length of the array ranges from 2 to 2000.", + "items": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/CoordinatesPairAbbreviated" + } + }, + "LinesInRequestBody": { + "type": "array", + "description": "The post elevation lines request body.", + "items": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/CoordinatesPairAbbreviated" + } + } + } +} diff --git a/specification/maps/data-plane/DEM/preview/1.0/examples/GetDataForBoundingBox.json b/specification/maps/data-plane/DEM/preview/1.0/examples/GetDataForBoundingBox.json new file mode 100644 index 000000000000..fdb2508355c7 --- /dev/null +++ b/specification/maps/data-plane/DEM/preview/1.0/examples/GetDataForBoundingBox.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "bounds": "-121.66853362143818, 46.84646479863713,-121.65853362143818, 46.85646479863713", + "rows": 2, + "columns": 3 + }, + "responses": { + "200": { + "body": { + "data": [ + { + "coordinate": { + "latitude": 46.846464798637129, + "longitude": -121.66853362143819 + }, + "elevationInMeter": 2314.4534201722422 + }, + { + "coordinate": { + "latitude": 46.846464798637129, + "longitude": -121.66353362143818 + }, + "elevationInMeter": 2269.6199778812925 + }, + { + "coordinate": { + "latitude": 46.846464798637129, + "longitude": -121.65853362143818 + }, + "elevationInMeter": 2146.04531663472 + }, + { + "coordinate": { + "latitude": 46.856464798637127, + "longitude": -121.66853362143819 + }, + "elevationInMeter": 2319.0975721859922 + }, + { + "coordinate": { + "latitude": 46.856464798637127, + "longitude": -121.66353362143818 + }, + "elevationInMeter": 2109.324863225469 + }, + { + "coordinate": { + "latitude": 46.856464798637127, + "longitude": -121.65853362143818 + }, + "elevationInMeter": 1998.6391324692017 + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/DEM/preview/1.0/examples/GetDataForPoints.json b/specification/maps/data-plane/DEM/preview/1.0/examples/GetDataForPoints.json new file mode 100644 index 000000000000..fde68073dbe8 --- /dev/null +++ b/specification/maps/data-plane/DEM/preview/1.0/examples/GetDataForPoints.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "points": "-121.66853362143818, 46.84646479863713|-121.68853362143818, 46.856464798637127" + }, + "responses": { + "200": { + "body": { + "data": [ + { + "coordinate": { + "latitude": 46.846464798637129, + "longitude": -121.66853362143819 + }, + "elevationInMeter": 2314.4534201722422 + }, + { + "coordinate": { + "latitude": 46.856464798637127, + "longitude": -121.68853362143818 + }, + "elevationInMeter": 2506.1430038793778 + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/DEM/preview/1.0/examples/GetDataForPolyline.json b/specification/maps/data-plane/DEM/preview/1.0/examples/GetDataForPolyline.json new file mode 100644 index 000000000000..5ca4133edee3 --- /dev/null +++ b/specification/maps/data-plane/DEM/preview/1.0/examples/GetDataForPolyline.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "lines": "-121.66853362143818, 46.84646479863713|-121.67853362143818, 46.85646479863713", + "samples": 5 + }, + "responses": { + "200": { + "body": { + "data": [ + { + "coordinate": { + "latitude": 46.846464798637129, + "longitude": -121.66853362143819 + }, + "elevationInMeter": 2298.6581875651746 + }, + { + "coordinate": { + "latitude": 46.848964798637127, + "longitude": -121.67103362143818 + }, + "elevationInMeter": 2466.4058976953679 + }, + { + "coordinate": { + "latitude": 46.851464798637124, + "longitude": -121.67353362143818 + }, + "elevationInMeter": 2504.8855800948654 + }, + { + "coordinate": { + "latitude": 46.853964798637129, + "longitude": -121.67603362143818 + }, + "elevationInMeter": 2477.8929009638578 + }, + { + "coordinate": { + "latitude": 46.856464798637127, + "longitude": -121.67853362143818 + }, + "elevationInMeter": 2394.5290079897059 + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/DEM/preview/1.0/examples/PostDataForPoints.json b/specification/maps/data-plane/DEM/preview/1.0/examples/PostDataForPoints.json new file mode 100644 index 000000000000..75541a1da2f1 --- /dev/null +++ b/specification/maps/data-plane/DEM/preview/1.0/examples/PostDataForPoints.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "pointsRequestBody": [ + { + "lon": -121.66853362143818, + "lat": 46.84646479863713 + }, + { + "lon": -121.68853362143818, + "lat": 46.856464798637127 + } + ] + }, + "responses": { + "200": { + "body": { + "data": [ + { + "coordinate": { + "latitude": 46.846464798637129, + "longitude": -121.66853362143819 + }, + "elevationInMeter": 2314.4534201722422 + }, + { + "coordinate": { + "latitude": 46.856464798637127, + "longitude": -121.68853362143818 + }, + "elevationInMeter": 2506.1430038793778 + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/DEM/preview/1.0/examples/PostDataForPolyline.json b/specification/maps/data-plane/DEM/preview/1.0/examples/PostDataForPolyline.json new file mode 100644 index 000000000000..dd20977f9124 --- /dev/null +++ b/specification/maps/data-plane/DEM/preview/1.0/examples/PostDataForPolyline.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "linesRequestBody": [ + { + "lon": -121.66853362143818, + "lat": 46.84646479863713 + }, + { + "lon": -121.67853362143818, + "lat": 46.85646479863713 + } + ], + "samples": 5 + }, + "responses": { + "200": { + "body": { + "data": [ + { + "coordinate": { + "latitude": 46.846464798637129, + "longitude": -121.66853362143819 + }, + "elevationInMeter": 2298.6581875651746 + }, + { + "coordinate": { + "latitude": 46.848964798637127, + "longitude": -121.67103362143818 + }, + "elevationInMeter": 2466.4058976953679 + }, + { + "coordinate": { + "latitude": 46.851464798637124, + "longitude": -121.67353362143818 + }, + "elevationInMeter": 2504.8855800948654 + }, + { + "coordinate": { + "latitude": 46.853964798637129, + "longitude": -121.67603362143818 + }, + "elevationInMeter": 2477.8929009638578 + }, + { + "coordinate": { + "latitude": 46.856464798637127, + "longitude": -121.67853362143818 + }, + "elevationInMeter": 2394.5290079897059 + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/DEM/readme.csharp.md b/specification/maps/data-plane/DEM/readme.csharp.md new file mode 100644 index 000000000000..e964272e7965 --- /dev/null +++ b/specification/maps/data-plane/DEM/readme.csharp.md @@ -0,0 +1,13 @@ +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +sync-methods: None +license-header: MICROSOFT_MIT_NO_VERSION +namespace: Azure.Maps.Elevation +output-folder: $(csharp-sdks-folder)/maps/Azure.Maps.Elevation/src/Generated +clear-output-folder: true +public-clients: true +``` \ No newline at end of file diff --git a/specification/maps/data-plane/DEM/readme.go.md b/specification/maps/data-plane/DEM/readme.go.md new file mode 100644 index 000000000000..e3100ff9dd32 --- /dev/null +++ b/specification/maps/data-plane/DEM/readme.go.md @@ -0,0 +1,26 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +license-header: MICROSOFT_MIT_NO_VERSION +namespace: elevation +clear-output-folder: true +export-clients: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: 1.0-preview +``` + +### Tag: 1.0-preview and go + +These settings apply only when `--tag=1.0-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == '1.0-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/maps/1.0/$(namespace) +``` \ No newline at end of file diff --git a/specification/maps/data-plane/DEM/readme.java.md b/specification/maps/data-plane/DEM/readme.java.md new file mode 100644 index 000000000000..0e934460dc71 --- /dev/null +++ b/specification/maps/data-plane/DEM/readme.java.md @@ -0,0 +1,9 @@ +## Java + +``` yaml $(java) +java: + namespace: com.azure.maps.elevation + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 0 + output-folder: $(azure-libraries-for-java-folder)/azure-maps-elevation +``` \ No newline at end of file diff --git a/specification/maps/data-plane/DEM/readme.md b/specification/maps/data-plane/DEM/readme.md new file mode 100644 index 000000000000..a109db4ab92b --- /dev/null +++ b/specification/maps/data-plane/DEM/readme.md @@ -0,0 +1,89 @@ +# Azure Elevation + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Elevation Client + +--- + +## Getting Started + +To build the SDK for Elevation, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +### Basic Information + +These are the global settings for Elevation Client. + +``` yaml +title: ElevationClient +openapi-type: data-plane +tag: 1.0-preview +# at some point those credentials will move away to Swagger according to [this](https://github.com/Azure/autorest/issues/3718) +add-credentials: true +credential-default-policy-type: BearerTokenCredentialPolicy +credential-scopes: https://atlas.microsoft.com/.default +``` + + +### Tag: 1.0-preview + +These settings apply only when `--tag=1.0-preview` is specified on the command line. + +``` yaml $(tag) == '1.0-preview' +input-file: + - preview/1.0/elevation.json +``` + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-java + + #track1 doesn't support data-plane for go + #manually generate for now with track2 + #- repo: azure-sdk-for-go + + #track1 doesn't support features needed for typescript + #manually generate for now with track2 + #- repo: azure-sdk-for-js + + #should be azure-sdk-for-net-track2, but SDK has not yet onboarded + #manually generate for now with track2 + - repo: azure-sdk-for-net +``` +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Java + +See configuration in [readme.java.md](./readme.java.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) diff --git a/specification/maps/data-plane/DEM/readme.python.md b/specification/maps/data-plane/DEM/readme.python.md new file mode 100644 index 000000000000..a4de636f8430 --- /dev/null +++ b/specification/maps/data-plane/DEM/readme.python.md @@ -0,0 +1,22 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +license-header: MICROSOFT_MIT_NO_VERSION +namespace: azure.maps.elevation +package-name: azure-maps-elevation +package-version: 1.0-preview +clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +no-namespace-folders: true +output-folder: $(python-sdks-folder)/maps/azure-maps-elevation/azure/maps/elevation +``` +``` yaml $(python) && $(python-mode) == 'create' +basic-setup-py: true +output-folder: $(python-sdks-folder)/maps/azure-maps-elevation +``` diff --git a/specification/maps/data-plane/DEM/readme.typescript.md b/specification/maps/data-plane/DEM/readme.typescript.md new file mode 100644 index 000000000000..9648e5343e41 --- /dev/null +++ b/specification/maps/data-plane/DEM/readme.typescript.md @@ -0,0 +1,14 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +azure-arm: false +package-name: "@azure/maps-elevation" +license-header: MICROSOFT_MIT_NO_VERSION +output-folder: "$(typescript-sdks-folder)/sdk/maps/maps-elevation" +source-code-folder-path: "" +clear-output-folder: false +generate-metadata: false +``` diff --git a/specification/maps/data-plane/Geolocation/preview/1.0/examples/GetLocationByIpAddress.json b/specification/maps/data-plane/Geolocation/preview/1.0/examples/GetLocationByIpAddress.json new file mode 100644 index 000000000000..33c30b016801 --- /dev/null +++ b/specification/maps/data-plane/Geolocation/preview/1.0/examples/GetLocationByIpAddress.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "geography": "us", + "api-version": "1.0", + "format": "json", + "ip": "2001:4898:80e8:b::189" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "countryRegion": { + "isoCode": "US" + }, + "ipAddress": "2001:4898:80e8:b::189" + } + } + } +} diff --git a/specification/maps/data-plane/Geolocation/preview/1.0/geolocation.json b/specification/maps/data-plane/Geolocation/preview/1.0/geolocation.json new file mode 100644 index 000000000000..91bca4f35ad4 --- /dev/null +++ b/specification/maps/data-plane/Geolocation/preview/1.0/geolocation.json @@ -0,0 +1,133 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Geolocation Service", + "version": "1.0", + "description": "Azure Maps Geolocation REST APIs" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{geography}.atlas.microsoft.com", + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "AzureKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "AzureKey": [] + } + ], + "responses": {}, + "parameters": { + "GeolocationApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API.", + "type": "string", + "in": "query", + "required": true, + "default": "1.0", + "x-ms-parameter-location": "client" + } + }, + "paths": { + "/geolocation/ip/{format}": { + "get": { + "description": "\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThis service will return the ISO country code for the provided IP address. Developers can use this information to block or alter certain content based on geographical locations where the application is being viewed from. \n\n\n__Note:__ This service returns results from IANA and does not necessarily reflect the views of Microsoft Corporation.", + "operationId": "Geolocation_GetIPToLocationPreview", + "x-ms-examples": { + "GetLocationByIpAddress": { + "$ref": "./examples/GetLocationByIpAddress.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/GeolocationApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "ip", + "in": "query", + "description": "The IP address. Both IPv4 and IPv6 are allowed.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IpAddressToLocationResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + } + }, + "definitions": { + "IpAddressToLocationResult": { + "description": "This object is returned from a successful call to IP Address to country/region API", + "type": "object", + "readOnly": true, + "properties": { + "countryRegion": { + "$ref": "#/definitions/CountryRegion" + }, + "ipAddress": { + "description": "The IP Address of the request.", + "type": "string", + "readOnly": true + } + } + }, + "CountryRegion": { + "description": "The object containing the country/region information.", + "type": "object", + "readOnly": true, + "properties": { + "isoCode": { + "description": "The IP Address's 2-character code [(ISO 3166-1)](https://www.iso.org/iso-3166-country-codes.html) of the country or region as assigned by IANA and regional internet authorities. Please note, IP address in ranges reserved for special purpose will return Null for country/region.", + "type": "string", + "readOnly": true + } + } + } + } +} diff --git a/specification/maps/data-plane/Geolocation/readme.csharp.md b/specification/maps/data-plane/Geolocation/readme.csharp.md new file mode 100644 index 000000000000..b44c474911d3 --- /dev/null +++ b/specification/maps/data-plane/Geolocation/readme.csharp.md @@ -0,0 +1,13 @@ +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +sync-methods: None +license-header: MICROSOFT_MIT_NO_VERSION +namespace: Azure.Maps.Geolocation +output-folder: $(csharp-sdks-folder)/maps/Azure.Maps.Geolocation/src/Generated +clear-output-folder: true +public-clients: true +``` \ No newline at end of file diff --git a/specification/maps/data-plane/Geolocation/readme.go.md b/specification/maps/data-plane/Geolocation/readme.go.md new file mode 100644 index 000000000000..f6ed1f0e411d --- /dev/null +++ b/specification/maps/data-plane/Geolocation/readme.go.md @@ -0,0 +1,26 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +license-header: MICROSOFT_MIT_NO_VERSION +namespace: geolocation +clear-output-folder: true +export-clients: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: 1.0-preview +``` + +### Tag: 1.0-preview and go + +These settings apply only when `--tag=1.0-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == '1.0-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/maps/1.0/$(namespace) +``` \ No newline at end of file diff --git a/specification/maps/data-plane/Geolocation/readme.java.md b/specification/maps/data-plane/Geolocation/readme.java.md new file mode 100644 index 000000000000..08147203fb24 --- /dev/null +++ b/specification/maps/data-plane/Geolocation/readme.java.md @@ -0,0 +1,9 @@ +## Java + +``` yaml $(java) +java: + namespace: com.azure.maps.geolocation + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 0 + output-folder: $(azure-libraries-for-java-folder)/azure-maps-geolocation +``` \ No newline at end of file diff --git a/specification/maps/data-plane/Geolocation/readme.md b/specification/maps/data-plane/Geolocation/readme.md new file mode 100644 index 000000000000..189310f995a4 --- /dev/null +++ b/specification/maps/data-plane/Geolocation/readme.md @@ -0,0 +1,89 @@ +# Azure Geolocation + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Geolocation Client + +--- + +## Getting Started + +To build the SDK for Geolocation, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +### Basic Information + +These are the global settings for Geolocation Client. + +``` yaml +title: GeolocationClient +openapi-type: data-plane +tag: 1.0-preview +# at some point those credentials will move away to Swagger according to [this](https://github.com/Azure/autorest/issues/3718) +add-credentials: true +credential-default-policy-type: BearerTokenCredentialPolicy +credential-scopes: https://atlas.microsoft.com/.default +``` + + +### Tag: 1.0-preview + +These settings apply only when `--tag=1.0-preview` is specified on the command line. + +``` yaml $(tag) == '1.0-preview' +input-file: + - preview/1.0/geolocation.json +``` + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-java + + #track1 doesn't support data-plane for go + #manually generate for now with track2 + #- repo: azure-sdk-for-go + + #track1 doesn't support features needed for typescript + #manually generate for now with track2 + #- repo: azure-sdk-for-js + + #should be azure-sdk-for-net-track2, but SDK has not yet onboarded + #manually generate for now with track2 + - repo: azure-sdk-for-net +``` +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Java + +See configuration in [readme.java.md](./readme.java.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) diff --git a/specification/maps/data-plane/Geolocation/readme.python.md b/specification/maps/data-plane/Geolocation/readme.python.md new file mode 100644 index 000000000000..52c2c17b7339 --- /dev/null +++ b/specification/maps/data-plane/Geolocation/readme.python.md @@ -0,0 +1,22 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +license-header: MICROSOFT_MIT_NO_VERSION +namespace: azure.maps.geolocation +package-name: azure-maps-geolocation +package-version: 1.0-preview +clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +no-namespace-folders: true +output-folder: $(python-sdks-folder)/maps/azure-maps-geolocation/azure/maps/geolocation +``` +``` yaml $(python) && $(python-mode) == 'create' +basic-setup-py: true +output-folder: $(python-sdks-folder)/maps/azure-maps-geolocation +``` diff --git a/specification/maps/data-plane/Geolocation/readme.typescript.md b/specification/maps/data-plane/Geolocation/readme.typescript.md new file mode 100644 index 000000000000..6e2696f40461 --- /dev/null +++ b/specification/maps/data-plane/Geolocation/readme.typescript.md @@ -0,0 +1,14 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +azure-arm: false +package-name: "@azure/maps-geolocation" +license-header: MICROSOFT_MIT_NO_VERSION +output-folder: "$(typescript-sdks-folder)/sdk/maps/maps-geolocation" +source-code-folder-path: "" +clear-output-folder: false +generate-metadata: false +``` diff --git a/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/alias.json b/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/alias.json index 5f6ef30ed777..4dcb41ce7393 100644 --- a/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/alias.json +++ b/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/alias.json @@ -26,14 +26,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", "scopes": { "user_impersonation": "Impersonates a user's Azure Active Directory account." } }, "apiKeyQuery": { "type": "apiKey", - "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", "name": "subscription-key", "in": "query" } @@ -63,7 +63,7 @@ } }, "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory (Azure AD) bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Azure AD bearer token.", "schema": { "$ref": "#/definitions/ODataErrorResponse" }, @@ -167,7 +167,7 @@ "/alias": { "post": { "x-publish": true, - "description": "**Alias - Create API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
    \n\nThis API allows the caller to create an alias.
    \nYou can also assign the alias during the create request as well.\n\n\n### Submit Create Request\n\nTo create your alias, you will use a `POST` request. If you would like to assign the alias during the creation, you will pass the `resourceId` query parameter.
    \n\n\n### Create Alias Response\n\nThe Create API returns a HTTP `201 Created` response the id of the alias, `aliasId`, in the body.\nThe response will look something like:\n\n```json\n{\n \"aliasId\" : \"d7e5efc8-2239-4387-a286-5bb51aa804e3\"\n}\n```\n\n
    ", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Alias - Create API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
    \n\nThis API allows the caller to create an alias.
    \nYou can also assign the alias during the create request as well.\n\n\n### Submit Create Request\n\nTo create your alias, you will use a `POST` request. If you would like to assign the alias during the creation, you will pass the `resourceId` query parameter.
    \n\n\n### Create Alias Response\n\nThe Create API returns a HTTP `201 Created` response the id of the alias, `aliasId`, in the body.\nThe response will look something like:\n\n```json\n{\n \"aliasId\" : \"d7e5efc8-2239-4387-a286-5bb51aa804e3\"\n}\n```\n\n
    ", "operationId": "Alias_CreatePreview", "x-ms-examples": { "Create an alias that does not reference any resource": { @@ -214,7 +214,7 @@ }, "get": { "x-publish": true, - "description": "**Alias - List API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
    \n\nThis API allows the caller to fetch a list of all previously successfully created aliases.\n\n\n### Submit List Request\n\nTo list all your aliases, you will issue a `GET` request with no additional parameters.
    \n\n\n### List Data Response\n\nThe List API returns the complete list of all aliases in `json` format. The response contains the following details for each alias resource:\n\n > createdTimestamp - The timestamp that the alias was created.\n > aliasId - The id for the alias.\n > resourceId - The id for the resource that this alias references (could be null if the alias has not been assigned).\n > lastUpdatedTimestamp - The last time the alias was assigned to a resource.\n\n\nHere's a sample response returning 2 alias resources: \n\n
    \n\n```json\n{\n \"aliases\": [\n {\n \"createdTimestamp\": \"2020-02-13T21:19:11+00:00\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"resourceId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22+00:00\"\n },\n {\n \"createdTimestamp\": \"2020-02-18T19:53:33+00:00\",\n \"aliasId\": \"1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6\",\n \"resourceId\": null,\n \"lastUpdatedTimestamp\": \"2020-02-18T19:53:33+00:00\"\n }\n ]\n}\n```\n\n
    ", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Alias - List API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
    \n\nThis API allows the caller to fetch a list of all previously successfully created aliases.\n\n\n### Submit List Request\n\nTo list all your aliases, you will issue a `GET` request with no additional parameters.
    \n\n\n### List Data Response\n\nThe List API returns the complete list of all aliases in `json` format. The response contains the following details for each alias resource:\n\n > createdTimestamp - The timestamp that the alias was created.\n > aliasId - The id for the alias.\n > resourceId - The id for the resource that this alias references (could be null if the alias has not been assigned).\n > lastUpdatedTimestamp - The last time the alias was assigned to a resource.\n\n\nHere's a sample response returning 2 alias resources: \n\n
    \n\n```json\n{\n \"aliases\": [\n {\n \"createdTimestamp\": \"2020-02-13T21:19:11+00:00\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"resourceId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22+00:00\"\n },\n {\n \"createdTimestamp\": \"2020-02-18T19:53:33+00:00\",\n \"aliasId\": \"1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6\",\n \"resourceId\": null,\n \"lastUpdatedTimestamp\": \"2020-02-18T19:53:33+00:00\"\n }\n ]\n}\n```\n\n
    ", "operationId": "Alias_ListPreview", "x-ms-examples": { "List all the previously created aliases": { @@ -257,7 +257,7 @@ "/alias/assign/{aliasId}": { "patch": { "x-publish": true, - "description": "**Alias - Assign API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
    \n\nThis API allows the caller to assign an alias to reference a resource.
    \n\n\n### Submit Assign Request\n\nTo assign your alias to a resource, you will use a `PATCH` request with the `aliasId` in the path and the `resourceId` passed as a query parameter.
    \n\n\n### Create Alias Response\n\nThe Assign API returns a HTTP `204 No Content` response with an empty body, if the alias was assigned successfully.
    ", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Alias - Assign API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
    \n\nThis API allows the caller to assign an alias to reference a resource.
    \n\n\n### Submit Assign Request\n\nTo assign your alias to a resource, you will use a `PATCH` request with the `aliasId` in the path and the `resourceId` passed as a query parameter.
    \n\n\n### Create Alias Response\n\nThe Assign API returns a HTTP `204 No Content` response with an empty body, if the alias was assigned successfully.
    ", "operationId": "Alias_AssignPreview", "x-ms-examples": { "Assign an alias to a resource": { @@ -306,7 +306,7 @@ "/alias/{aliasId}": { "delete": { "x-publish": true, - "description": "**Alias - Delete API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
    \n\nThis API allows the caller to delete a previously created alias.
    \nYou can also use this API to delete old/unused aliases to create space for new content.\nThis API does not delete the references resource, only the alias referencing the resource.\n\n\n### Submit Delete Request\n\nTo delete your alias you will issue a `DELETE` request where the path will contain the `aliasId` of the alias to delete.
    \n\n\n### Delete Alias Response\n\nThe Delete API returns a HTTP `204 No Content` response with an empty body, if the alias was deleted successfully.
    \nA HTTP `400 Bad Request` error response will be returned if the alias with the passed-in `aliasId` is not found. ", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Alias - Delete API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
    \n\nThis API allows the caller to delete a previously created alias.
    \nYou can also use this API to delete old/unused aliases to create space for new content.\nThis API does not delete the references resource, only the alias referencing the resource.\n\n\n### Submit Delete Request\n\nTo delete your alias you will issue a `DELETE` request where the path will contain the `aliasId` of the alias to delete.
    \n\n\n### Delete Alias Response\n\nThe Delete API returns a HTTP `204 No Content` response with an empty body, if the alias was deleted successfully.
    \nA HTTP `400 Bad Request` error response will be returned if the alias with the passed-in `aliasId` is not found. ", "operationId": "Alias_DeletePreview", "x-ms-examples": { "Delete previously created alias": { @@ -353,7 +353,7 @@ "definitions": { "ODataErrorResponse": { "type": "object", - "description": "This response object is returned when an error occurs in the Maps API.", + "description": "This response object is returned when an error occurs in the Azure Maps API.", "properties": { "error": { "$ref": "#/definitions/ODataError" @@ -362,7 +362,7 @@ }, "ODataError": { "type": "object", - "description": "This object is returned when an error occurs in the Maps API.", + "description": "This object is returned when an error occurs in the Azure Maps API.", "properties": { "code": { "type": "string", @@ -372,7 +372,7 @@ "message": { "type": "string", "readOnly": true, - "description": "If available, a human readable description of the error." + "description": "If available, a human-readable description of the error." }, "details": { "type": "array", diff --git a/specification/maps/data-plane/Microsoft.Maps/Alias/preview/2.0/alias.json b/specification/maps/data-plane/Microsoft.Maps/Alias/preview/2.0/alias.json index c90b224da3d1..e90893e81a35 100644 --- a/specification/maps/data-plane/Microsoft.Maps/Alias/preview/2.0/alias.json +++ b/specification/maps/data-plane/Microsoft.Maps/Alias/preview/2.0/alias.json @@ -26,14 +26,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", "scopes": { "user_impersonation": "Impersonates a user's Azure Active Directory account." } }, "apiKeyQuery": { "type": "apiKey", - "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", "name": "subscription-key", "in": "query" } @@ -57,7 +57,7 @@ } }, "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory (Azure AD) bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Azure AD bearer token.", "schema": { "$ref": "#/definitions/ODataErrorResponse" }, @@ -389,7 +389,7 @@ "definitions": { "ODataErrorResponse": { "type": "object", - "description": "This response object is returned when an error occurs in the Maps API.", + "description": "This response object is returned when an error occurs in the Azure Maps API.", "properties": { "error": { "$ref": "#/definitions/ODataError" @@ -398,7 +398,7 @@ }, "ODataError": { "type": "object", - "description": "This object is returned when an error occurs in the Maps API.", + "description": "This object is returned when an error occurs in the Azure Maps API.", "properties": { "code": { "type": "string", @@ -408,7 +408,7 @@ "message": { "type": "string", "readOnly": true, - "description": "If available, a human readable description of the error." + "description": "If available, a human-readable description of the error." }, "details": { "type": "array", diff --git a/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/data.json b/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/data.json index 329cb1ec6e98..df595c8d592c 100644 --- a/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/data.json +++ b/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/data.json @@ -25,14 +25,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", "scopes": { "user_impersonation": "Impersonates a user's Azure Active Directory account." } }, "apiKeyQuery": { "type": "apiKey", - "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", "name": "subscription-key", "in": "query" } @@ -53,7 +53,7 @@ } }, "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory (Azure AD) bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Azure AD bearer token.", "schema": { "$ref": "#/definitions/ODataErrorResponse" }, @@ -134,7 +134,7 @@ }, "ClientId": { "name": "x-ms-client-id", - "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", "type": "string", "in": "header", "required": false, @@ -217,7 +217,7 @@ "/mapData/upload": { "post": { "x-publish": true, - "description": "**Data Upload API**\n\n**Applies to:** S1 pricing tier.\n\nThe Data Upload API allows the caller to upload data content to the Azure Maps service.\nYou can use this API in a scenario like uploading a collection of Geofences in `GeoJSON` \nformat, for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial).\n\n## Submit Upload Request\n\nTo upload your content you will use a `POST` request. The request body will contain the data to upload. The \n`dataFormat` query parameter will contain the format for the data, the `dataSharingLevel` query parameter \ncan contain the sharing level for the data. The `Content-Type` header will be set to the content type of the \ndata.\n\nFor example, to upload a collection of geofences in `GeoJSON` format, set the request body to the geofence \ncontent. Set the `dataFormat` query parameter to _geojson_, and set the `Content-Type` header to either one \nof the following media types:\n\n- `application/json`\n- `application/vnd.geo+json`\n- `application/octet-stream`\n\nHere's a sample request body for uploading a simple Geofence represented as a circle geometry using a center \npoint and a radius. The sample below is in `GeoJSON`:\n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```\n\nThe Data Upload API performs a \n[long-running request](https://docs.microsoft.com/azure/azure-maps/private-atlas-long-running-operation).\n\n## Data Upload Limits\n\nPlease, be aware that currently every Azure Maps account has a [data storage limit](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#azure-maps-limits). \nOnce the storage limit is reached, all the new upload API calls will return a `409 Conflict` http error response. \nYou can always use the [Data Delete API](https://docs.microsoft.com/rest/api/maps/data/deletepreview) to \ndelete old/unused content and create space for new uploads.", + "description": "**Data Upload API**\n\n**Applies to:** S1 pricing tier.\n\nThe Data Upload API allows the caller to upload data content to the Azure Maps service.\nYou can use this API in a scenario like uploading a collection of Geofences in `GeoJSON` \nformat, for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial).\n\n## Submit Upload Request\n\nTo upload your content you will use a `POST` request. The request body will contain the data to upload. The `Content-Type` header will be set to the content type of the \ndata.\n\nFor example, to upload a collection of geofences in `GeoJSON` format, set the request body to the geofence \ncontent. Set the `dataFormat` query parameter to _geojson_, and set the `Content-Type` header to either one \nof the following media types:\n\n- `application/json`\n- `application/vnd.geo+json`\n- `application/octet-stream`\n\nHere's a sample request body for uploading a simple Geofence represented as a circle geometry using a center \npoint and a radius. The sample below is in `GeoJSON`:\n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```\n\nThe Data Upload API performs a \n[long-running request](https://docs.microsoft.com/azure/azure-maps/private-atlas-long-running-operation).\n\n## Data Upload Limits\n\nPlease, be aware that currently every Azure Maps account has a [data storage limit](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#azure-maps-limits). \nOnce the storage limit is reached, all the new upload API calls will return a `409 Conflict` http error response. \nYou can always use the [Data Delete API](https://docs.microsoft.com/rest/api/maps/data/deletepreview) to \ndelete old/unused content and create space for new uploads.", "operationId": "Data_UploadPreview", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -506,7 +506,7 @@ "definitions": { "ODataErrorResponse": { "type": "object", - "description": "This response object is returned when an error occurs in the Maps API.", + "description": "This response object is returned when an error occurs in the Azure Maps API.", "properties": { "error": { "$ref": "#/definitions/ODataError" @@ -515,7 +515,7 @@ }, "ODataError": { "type": "object", - "description": "This object is returned when an error occurs in the Maps API.", + "description": "This object is returned when an error occurs in the Azure Maps API.", "properties": { "code": { "type": "string", @@ -525,7 +525,7 @@ "message": { "type": "string", "readOnly": true, - "description": "If available, a human readable description of the error." + "description": "If available, a human-readable description of the error." }, "details": { "type": "array", diff --git a/specification/maps/data-plane/Microsoft.Maps/Data/preview/2.0/data.json b/specification/maps/data-plane/Microsoft.Maps/Data/preview/2.0/data.json index 858e1943bf5b..283d5bde47c5 100644 --- a/specification/maps/data-plane/Microsoft.Maps/Data/preview/2.0/data.json +++ b/specification/maps/data-plane/Microsoft.Maps/Data/preview/2.0/data.json @@ -25,14 +25,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", "scopes": { "user_impersonation": "Impersonates a user's Azure Active Directory account." } }, "apiKeyQuery": { "type": "apiKey", - "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", "name": "subscription-key", "in": "query" } @@ -53,7 +53,7 @@ } }, "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory (Azure AD) bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Azure AD bearer token.", "schema": { "$ref": "#/definitions/ODataErrorResponse" }, @@ -134,7 +134,7 @@ }, "ClientId": { "name": "x-ms-client-id", - "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", "type": "string", "in": "header", "required": false, @@ -211,7 +211,7 @@ }, "Udid": { "name": "udid", - "description": "The unique data id for the content. The `udid` must have been obtained from a successful [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data%20v2/uploadpreview) call.", + "description": "The unique data id for the content. The `udid` must have been obtained from a successful [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data-v2/upload-preview) call.", "type": "string", "in": "path", "required": true, @@ -238,7 +238,7 @@ "/mapData": { "post": { "x-publish": true, - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Data Upload API allows the caller to upload data content to the Azure Maps service.\nYou can use this API in a scenario like uploading a collection of Geofences in `GeoJSON` \nformat, for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial).\n\n## Submit Upload Request\n\nTo upload your content you will use a `POST` request. The request body will contain the data to upload. The \n`dataFormat` query parameter will contain the format for the data, the `dataSharingLevel` query parameter \ncan contain the sharing level for the data. The `Content-Type` header will be set to the content type of the \ndata.\n\nFor example, to upload a collection of geofences in `GeoJSON` format, set the request body to the geofence \ncontent. Set the `dataFormat` query parameter to _geojson_, and set the `Content-Type` header to either one \nof the following media types:\n\n- `application/json`\n- `application/vnd.geo+json`\n- `application/octet-stream`\n\nHere's a sample request body for uploading a simple Geofence represented as a circle geometry using a center \npoint and a radius. The sample below is in `GeoJSON`:\n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```\n\nThe Data Upload API performs a \n[long-running request](https://aka.ms/am-creator-lrt-v2).\n\n## Data Upload Limits\n\nPlease, be aware that currently every Azure Maps account has a [data storage limit](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#azure-maps-limits). \nOnce the storage limit is reached, all the new upload API calls will return a `409 Conflict` http error response. \nYou can always use the [Data Delete API](https://docs.microsoft.com/rest/api/maps/data%20v2/deletepreview) to \ndelete old/unused content and create space for new uploads.", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Data Upload API allows the caller to upload data content to the Azure Maps service.\nYou can use this API in a scenario like uploading a collection of Geofences in `GeoJSON` \nformat, for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial).\n\n## Submit Upload Request\n\nTo upload your content you will use a `POST` request. The request body will contain the data to upload. The `Content-Type` header will be set to the content type of the \ndata.\n\nFor example, to upload a collection of geofences in `GeoJSON` format, set the request body to the geofence \ncontent. Set the `dataFormat` query parameter to _geojson_, and set the `Content-Type` header to either one \nof the following media types:\n\n- `application/json`\n- `application/vnd.geo+json`\n- `application/octet-stream`\n\nHere's a sample request body for uploading a simple Geofence represented as a circle geometry using a center \npoint and a radius. The sample below is in `GeoJSON`:\n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```\n\nThe Data Upload API performs a \n[long-running request](https://aka.ms/am-creator-lrt-v2).\n\n## Data Upload Limits\n\nPlease, be aware that currently every Azure Maps account has a [data storage limit](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#azure-maps-limits). \nOnce the storage limit is reached, all the new upload API calls will return a `409 Conflict` http error response. \nYou can always use the [Data Delete API](https://docs.microsoft.com/rest/api/maps/data-v2/delete-preview) to \ndelete old/unused content and create space for new uploads.", "operationId": "Data_UploadPreview", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -304,7 +304,7 @@ }, "get": { "x-publish": true, - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to fetch a list of all content uploaded previously using the [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data%20v2/uploadpreview). \n\n\n### Submit List Request\n\nTo list all your map data content you will issue a `GET` request with no additional parameters.\n\n\n### List Data Response\n\nThe Data List API returns the complete list of all data in `json` format. The response contains the following details for each data resource:\n\n > udid - The unique data id for the data resource.\n\n > location - The location of the data resource. Execute a HTTP `GET` on this location to download the data.\n\n\nHere's a sample response returning the `udid` and `location` of 3 data resources: \n\n
    \n\n```json\n{\n \"mapDataList\": \n [\n {\n \"udid\": \"9a1288fa-1858-4a3b-b68d-13a8j5af7d7c\",\n \"location\": \"https://us.atlas.microsoft.com/mapData/9a1288fa-1858-4a3b-b68d-13a8j5af7d7c?api-version=1.0\",\n \"sizeInBytes\": 29920,\n \"uploadStatus\": \"Completed\"\n },\n {\n \"udid\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"location\": \"https://us.atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0\",\n \"sizeInBytes\": 1339,\n \"uploadStatus\": \"Completed\"\n },\n {\n \"udid\": \"7c1288fa-2058-4a1b-b68f-13a6h5af7d7c\",\n \"location\": \"https://us.atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0\",\n \"sizeInBytes\": 1650,\n \"uploadStatus\": \"Pending\"\n }]\n}\n```\n\n
    ", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to fetch a list of all content uploaded previously using the [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data-v2/upload-preview). \n\n\n### Submit List Request\n\nTo list all your map data content you will issue a `GET` request with no additional parameters.\n\n\n### List Data Response\n\nThe Data List API returns the complete list of all data in `json` format. The response contains the following details for each data resource:\n\n > udid - The unique data id for the data resource.\n\n > location - The location of the data resource. Execute a HTTP `GET` on this location to download the data.\n\n\nHere's a sample response returning the `udid` and `location` of 3 data resources: \n\n
    \n\n```json\n{\n \"mapDataList\": \n [\n {\n \"udid\": \"9a1288fa-1858-4a3b-b68d-13a8j5af7d7c\",\n \"location\": \"https://us.atlas.microsoft.com/mapData/9a1288fa-1858-4a3b-b68d-13a8j5af7d7c?api-version=1.0\",\n \"sizeInBytes\": 29920,\n \"uploadStatus\": \"Completed\"\n },\n {\n \"udid\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"location\": \"https://us.atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0\",\n \"sizeInBytes\": 1339,\n \"uploadStatus\": \"Completed\"\n },\n {\n \"udid\": \"7c1288fa-2058-4a1b-b68f-13a6h5af7d7c\",\n \"location\": \"https://us.atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0\",\n \"sizeInBytes\": 1650,\n \"uploadStatus\": \"Pending\"\n }]\n}\n```\n\n
    ", "operationId": "Data_ListPreview", "x-ms-examples": { "List all the previously uploaded data": { @@ -356,7 +356,7 @@ "/mapData/{udid}": { "put": { "x-publish": true, - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Data Update API allows the caller to update a previously uploaded data content.\n\nYou can use this API in a scenario like adding or removing geofences to or from an existing collection of geofences. \nGeofences are uploaded using the [Data Upload API](https://docs.microsoft.com/rest/api/maps/data%20v2/uploadpreview), for \nuse in the [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial).\n\nPlease note that the Update API will *replace* and *override* the existing data content.\n\n## Submit Update Request\n\nTo update your content you will use a `PUT` request. The request body will contain the new data that will replace \nthe existing data. The `Content-Type` header will be set to the content type of the data, and the path will contain \nthe `udid` of the data to be update.\n\nFor example, to update a collection of geofences that were previously uploaded using the Upload API, place the new \ngeofence content in the request body. Set the `udid` parameter in the path to the `udid` of the data received \npreviously in the upload API response. And set the `Content-Type` header to one of the following media types:\n\n- `application/json`\n- `application/vnd.geo+json`\n- `application/octet-stream`\n\nHere's a sample request body for updating a simple Geofence. It's represented as a circle geometry using a center \npoint and a radius. The sample below is in `GeoJSON`:\n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```\n\nThe previously uploaded geofence had a radius of 100m. The above request will update it to 500m.\n\nThe Data Update API performs a \n[long-running request](https://aka.ms/am-creator-lrt-v2).\n\n## Data Update Limits\n\nPlease, be aware that currently every Azure Maps account has a [data storage limit](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#azure-maps-limits). \nOnce the storage limit is reached, all the new upload API calls will return a `409 Conflict` http error response. \nYou can always use the [Data Delete API](https://docs.microsoft.com/rest/api/maps/data%20v2/deletepreview) to \ndelete old/unused content and create space for new uploads.", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Data Update API allows the caller to update a previously uploaded data content.\n\nYou can use this API in a scenario like adding or removing geofences to or from an existing collection of geofences. \nGeofences are uploaded using the [Data Upload API](https://docs.microsoft.com/rest/api/maps/data-v2/upload-preview), for \nuse in the [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial).\n\nPlease note that the Update API will *replace* and *override* the existing data content.\n\n## Submit Update Request\n\nTo update your content you will use a `PUT` request. The request body will contain the new data that will replace \nthe existing data. The `Content-Type` header will be set to the content type of the data, and the path will contain \nthe `udid` of the data to be update.\n\nFor example, to update a collection of geofences that were previously uploaded using the Upload API, place the new \ngeofence content in the request body. Set the `udid` parameter in the path to the `udid` of the data received \npreviously in the upload API response. And set the `Content-Type` header to one of the following media types:\n\n- `application/json`\n- `application/vnd.geo+json`\n- `application/octet-stream`\n\nHere's a sample request body for updating a simple Geofence. It's represented as a circle geometry using a center \npoint and a radius. The sample below is in `GeoJSON`:\n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```\n\nThe previously uploaded geofence had a radius of 100m. The above request will update it to 500m.\n\nThe Data Update API performs a \n[long-running request](https://aka.ms/am-creator-lrt-v2).\n\n## Data Update Limits\n\nPlease, be aware that currently every Azure Maps account has a [data storage limit](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#azure-maps-limits). \nOnce the storage limit is reached, all the new upload API calls will return a `409 Conflict` http error response. \nYou can always use the [Data Delete API](https://docs.microsoft.com/rest/api/maps/data-v2/delete-preview) to \ndelete old/unused content and create space for new uploads.", "operationId": "Data_UpdatePreview", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -422,7 +422,7 @@ }, "get": { "x-publish": true, - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to download a previously uploaded data content.
    \nYou can use this API in a scenario like downloading an existing collection of geofences uploaded previously using the [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data%20v2/uploadpreview) for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/en-us/rest/api/maps/spatial). \n\n\n### Submit Download Request\n\nTo download your content you will use a `GET` request where the path will contain the `udid` of the data to download. Optionally, you can also pass in an `Accept` header to specify a preference for the `Content-Type` of the data response.
    \nFor example, to download a collection of geofences previously uploaded using the Upload API, set the `udid` parameter in the path to the `udid` of the data received previously in the upload API response and set the `Accept` header to either one of the following media types: \n \n - `application/json`\n - `application/vnd.geo+json`\n - `application/octet-stream`\n\n\n### Download Data Response\n\nThe Download API will return a HTTP `200 OK` response if the data resource with the passed-in `udid` is found, where the response body will contain the content of the data resource.
    \nA HTTP `400 Bad Request` error response will be returned if the data resource with the passed-in `udid` is not found.
    \n\nHere's a sample response body for a simple geofence represented in `GeoJSON` uploaded previously using the Upload API:\n
    \n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to download a previously uploaded data content.
    \nYou can use this API in a scenario like downloading an existing collection of geofences uploaded previously using the [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data-v2/upload-preview) for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/en-us/rest/api/maps/spatial). \n\n\n### Submit Download Request\n\nTo download your content you will use a `GET` request where the path will contain the `udid` of the data to download. Optionally, you can also pass in an `Accept` header to specify a preference for the `Content-Type` of the data response.
    \nFor example, to download a collection of geofences previously uploaded using the Upload API, set the `udid` parameter in the path to the `udid` of the data received previously in the upload API response and set the `Accept` header to either one of the following media types: \n \n - `application/json`\n - `application/vnd.geo+json`\n - `application/octet-stream`\n\n\n### Download Data Response\n\nThe Download API will return a HTTP `200 OK` response if the data resource with the passed-in `udid` is found, where the response body will contain the content of the data resource.
    \nA HTTP `400 Bad Request` error response will be returned if the data resource with the passed-in `udid` is not found.
    \n\nHere's a sample response body for a simple geofence represented in `GeoJSON` uploaded previously using the Upload API:\n
    \n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```", "operationId": "Data_DownloadPreview", "x-ms-examples": { "Download previously uploaded GeoJSON data containing geometries that represent a collection of geofences": { @@ -475,7 +475,7 @@ }, "delete": { "x-publish": true, - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to delete a previously uploaded data content.
    \nYou can use this API in a scenario like removing geofences previously uploaded using the [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data%20v2/uploadpreview) for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/en-us/rest/api/maps/spatial). You can also use this API to delete old/unused uploaded content and create space for new content.\n\n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `udid` of the data to delete.
    \nFor example, to delete a collection of geofences previously uploaded using the Upload API, set the `udid` parameter in the path to the `udid` of the data received previously in the upload API response. \n\n\n### Delete Data Response\n\nThe Data Delete API returns a HTTP `204 No Content` response with an empty body, if the data resource was deleted successfully.
    \nA HTTP `400 Bad Request` error response will be returned if the data resource with the passed-in `udid` is not found. ", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to delete a previously uploaded data content.
    \nYou can use this API in a scenario like removing geofences previously uploaded using the [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data-v2/upload-preview) for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/en-us/rest/api/maps/spatial). You can also use this API to delete old/unused uploaded content and create space for new content.\n\n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `udid` of the data to delete.
    \nFor example, to delete a collection of geofences previously uploaded using the Upload API, set the `udid` parameter in the path to the `udid` of the data received previously in the upload API response. \n\n\n### Delete Data Response\n\nThe Data Delete API returns a HTTP `204 No Content` response with an empty body, if the data resource was deleted successfully.
    \nA HTTP `400 Bad Request` error response will be returned if the data resource with the passed-in `udid` is not found. ", "operationId": "Data_DeletePreview", "x-ms-examples": { "Delete previously uploaded GeoJSON data containing geometries that represent a collection of geofences": { @@ -555,7 +555,7 @@ "definitions": { "ODataErrorResponse": { "type": "object", - "description": "This response object is returned when an error occurs in the Maps API.", + "description": "This response object is returned when an error occurs in the Azure Maps API.", "properties": { "error": { "$ref": "#/definitions/ODataError" @@ -564,7 +564,7 @@ }, "ODataError": { "type": "object", - "description": "This object is returned when an error occurs in the Maps API.", + "description": "This object is returned when an error occurs in the Azure Maps API.", "properties": { "code": { "type": "string", @@ -574,7 +574,7 @@ "message": { "type": "string", "readOnly": true, - "description": "If available, a human readable description of the error." + "description": "If available, a human-readable description of the error." }, "details": { "type": "array", @@ -687,12 +687,12 @@ "readOnly": true }, "dataFormat": { - "description": "", + "description": "The current data format.", "type": "string", "readOnly": true }, "description": { - "description": "", + "description": "The current description.", "type": "string", "readOnly": true } diff --git a/specification/maps/data-plane/Microsoft.Maps/Dataset/preview/1.0/dataset.json b/specification/maps/data-plane/Microsoft.Maps/Dataset/preview/1.0/dataset.json index 629ca82f3036..272cdc992bb5 100644 --- a/specification/maps/data-plane/Microsoft.Maps/Dataset/preview/1.0/dataset.json +++ b/specification/maps/data-plane/Microsoft.Maps/Dataset/preview/1.0/dataset.json @@ -26,14 +26,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", "scopes": { "user_impersonation": "Impersonates a user's Azure Active Directory account." } }, "apiKeyQuery": { "type": "apiKey", - "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", "name": "subscription-key", "in": "query" } @@ -54,7 +54,7 @@ } }, "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory (Azure AD) bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Azure AD bearer token.", "schema": { "$ref": "#/definitions/ODataErrorResponse" }, @@ -259,7 +259,7 @@ "/dataset/create": { "post": { "x-publish": true, - "description": "**Dataset Create API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API \nand SDK. The Dataset APIs are part of Creator. This API allows the caller to create a dataset from data that \nwas uploaded to the Azure Maps Data Service.\n\nYou can use this API in a scenario like uploading a DWG zip package for a building, converting the zip package using \nthe Azure Maps Conversion Service, creating a dataset from the converted zip package. The created dataset can be \nused to create tilesets using the Azure Maps Tileset Service and can be queried via the Azure Maps WFS Service.\n\n## Submit Create Request\n\nTo create your dataset, you will use a `POST` request where the `conversionId` query parameter is an id that represents \nthe converted DWG zip package, the `type` parameter will describe the data type to use for the dataset, the `datasetId`\nparameter will describe if the provided data should be appended to a current dataset and, optionally, the \n`description` query parameter will contain a description (if description is not provided a default description will be \ngiven).\n\nThe Create API is a \n[long-running request](https://aka.ms/am-creator-lrt).", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Dataset Create API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API \nand SDK. The Dataset APIs are part of Creator. This API allows the caller to create a dataset from data that \nwas uploaded to the Azure Maps Data Service.\n\nYou can use this API in a scenario like uploading a DWG zip package for a building, converting the zip package using \nthe Azure Maps Conversion Service, creating a dataset from the converted zip package. The created dataset can be \nused to create tilesets using the Azure Maps Tileset Service and can be queried via the Azure Maps WFS Service.\n\n## Submit Create Request\n\nTo create your dataset, you will use a `POST` request where the `conversionId` query parameter is an id that represents \nthe converted DWG zip package, the `type` parameter will describe the data type to use for the dataset, the `datasetId`\nparameter will describe if the provided data should be appended to a current dataset and, optionally, the \n`description` query parameter will contain a description (if description is not provided a default description will be \ngiven).\n\nThe Create API is a \n[long-running request](https://aka.ms/am-creator-lrt).", "operationId": "Dataset_CreatePreview", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -321,7 +321,7 @@ "/dataset/import/{datasetId}": { "patch": { "x-publish": true, - "description": "**Dataset Import API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
    \n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API \nand SDK. The Dataset APIs are part of Creator. This API allows the caller to bulk import data into a dataset \nfrom data that was uploaded to the Azure Maps Data service.
    \n\n### Submit Import Request\n\nTo import data into your dataset, you will use a `PATCH` request where the `datasetId` query parameter is the \ndataset you want to import your data into, the `udid` query parameter is the data you want to import, and the `type` \nparameter will describe the data type to use for the import data.
    \n\nThe Import API is a \n[long-running request](https://aka.ms/am-creator-lrt).", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Dataset Import API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
    \n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API \nand SDK. The Dataset APIs are part of Creator. This API allows the caller to bulk import data into a dataset \nfrom data that was uploaded to the Azure Maps Data service.
    \n\n### Submit Import Request\n\nTo import data into your dataset, you will use a `PATCH` request where the `datasetId` query parameter is the \ndataset you want to import your data into, the `udid` query parameter is the data you want to import, and the `type` \nparameter will describe the data type to use for the import data.
    \n\nThe Import API is a \n[long-running request](https://aka.ms/am-creator-lrt).", "operationId": "Dataset_ImportPreview", "x-ms-examples": { "Import data into previously created dataset": { @@ -373,7 +373,7 @@ "/dataset/{datasetId}": { "delete": { "x-publish": true, - "description": "**Dataset Delete API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
    \n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Dataset APIs are part of Creator.\nThis API allows the caller to delete a previously created dataset.
    \nYou can also use this API to delete old/unused datasets to create space for new Creator content.\n\n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `datasetId` of the dataset to delete.
    \n\n\n### Delete Data Response\n\nThe Delete API returns a HTTP `204 No Content` response if the dataset resource was deleted successfully.
    ", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Dataset Delete API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
    \n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Dataset APIs are part of Creator.\nThis API allows the caller to delete a previously created dataset.
    \nYou can also use this API to delete old/unused datasets to create space for new Creator content.\n\n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `datasetId` of the dataset to delete.
    \n\n\n### Delete Data Response\n\nThe Delete API returns a HTTP `204 No Content` response if the dataset resource was deleted successfully.
    ", "operationId": "Dataset_DeletePreview", "x-ms-examples": { "Delete previously created dataset": { @@ -419,7 +419,7 @@ "/dataset": { "get": { "x-publish": true, - "description": "**Dataset List API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
    \n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Dataset APIs are part of Creator.\nThis API allows the caller to fetch a list of all previously successfully created datasets.\n\n\n### Submit List Request\n\nTo list all your datasets, you will issue a `GET` request with no additional parameters.
    \n\n\n### List Data Response\n\nThe List API returns the complete list of all datasets in `json` format. The response contains the following fields (if they are not null or empty):\n > created - The timestamp the dataset was created.\n > datasetId - The id for the dataset.\n > description - The description for the dataset.\n > datasetSources - The source data that was used when the create request was issued.\n\nThe `datasetSources` describes the source data that was used when the create request was issued and contains the following elements (if they are not null or empty):\n > conversionIds - The list of `conversionId` (null if none were provided).\n > udids - The list of `udid` (null if none were provided).\n > appendDatasetId - The `datasetId` that was used for an append operation (null if none was used).\n > type - The type of data stored in the dataset that was created.\n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, and `datasetSources` of 3 dataset resources:\n\n
    \n\n```json\n{\n \"datasets\": [\n {\n \"timestamp\": \"2020-01-01T22:50:48+00:00\",\n \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n \"description\": \"Some description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ],\n \"type\": \"facility\"\n },\n \"status\": \"Succeeded\"\n },\n {\n \"timestamp\": \"2020-01-01T22:57:53+00:00\",\n \"datasetId\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"description\": \"Create from upload '0c1288fa-2058-4a1b-b68d-13a5f5af7d7c'.\",\n \"datasetSources\": {\n \"udids\": [\n \"0c1288fa-2058-4a1b-b68d-13a5f5af7d7c\"\n ],\n \"type\": \"facility\"\n },\n \"status\": \"Succeeded\"\n },\n {\n \"timestamp\": \"2020-01-01T20:39:36+00:00\",\n \"datasetId\": \"7c1288fa-2058-4a1b-b68f-13a6h5af7d7c\",\n \"description\": \"Some other description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ],\n \"appendDatasetId\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"type\": \"facility\"\n },\n \"status\": \"Succeeded\"\n }\n ]\n}\n```\n
    ", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Dataset List API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
    \n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Dataset APIs are part of Creator.\nThis API allows the caller to fetch a list of all previously successfully created datasets.\n\n\n### Submit List Request\n\nTo list all your datasets, you will issue a `GET` request with no additional parameters.
    \n\n\n### List Data Response\n\nThe List API returns the complete list of all datasets in `json` format. The response contains the following fields (if they are not null or empty):\n > created - The timestamp the dataset was created.\n > datasetId - The id for the dataset.\n > description - The description for the dataset.\n > datasetSources - The source data that was used when the create request was issued.\n\nThe `datasetSources` describes the source data that was used when the create request was issued and contains the following elements (if they are not null or empty):\n > conversionIds - The list of `conversionId` (null if none were provided).\n > udids - The list of `udid` (null if none were provided).\n > appendDatasetId - The `datasetId` that was used for an append operation (null if none was used).\n > type - The type of data stored in the dataset that was created.\n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, and `datasetSources` of 3 dataset resources:\n\n
    \n\n```json\n{\n \"datasets\": [\n {\n \"timestamp\": \"2020-01-01T22:50:48+00:00\",\n \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n \"description\": \"Some description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ],\n \"type\": \"facility\"\n },\n \"status\": \"Succeeded\"\n },\n {\n \"timestamp\": \"2020-01-01T22:57:53+00:00\",\n \"datasetId\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"description\": \"Create from upload '0c1288fa-2058-4a1b-b68d-13a5f5af7d7c'.\",\n \"datasetSources\": {\n \"udids\": [\n \"0c1288fa-2058-4a1b-b68d-13a5f5af7d7c\"\n ],\n \"type\": \"facility\"\n },\n \"status\": \"Succeeded\"\n },\n {\n \"timestamp\": \"2020-01-01T20:39:36+00:00\",\n \"datasetId\": \"7c1288fa-2058-4a1b-b68f-13a6h5af7d7c\",\n \"description\": \"Some other description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ],\n \"appendDatasetId\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"type\": \"facility\"\n },\n \"status\": \"Succeeded\"\n }\n ]\n}\n```\n
    ", "operationId": "Dataset_ListPreview", "x-ms-examples": { "List all the previously created datasets": { @@ -463,7 +463,7 @@ "definitions": { "ODataErrorResponse": { "type": "object", - "description": "This response object is returned when an error occurs in the Maps API.", + "description": "This response object is returned when an error occurs in the Azure Maps API.", "properties": { "error": { "$ref": "#/definitions/ODataError" @@ -472,7 +472,7 @@ }, "ODataError": { "type": "object", - "description": "This object is returned when an error occurs in the Maps API.", + "description": "This object is returned when an error occurs in the Azure Maps API.", "properties": { "code": { "type": "string", @@ -482,7 +482,7 @@ "message": { "type": "string", "readOnly": true, - "description": "If available, a human readable description of the error." + "description": "If available, a human-readable description of the error." }, "details": { "type": "array", diff --git a/specification/maps/data-plane/Microsoft.Maps/Dataset/preview/2.0/dataset.json b/specification/maps/data-plane/Microsoft.Maps/Dataset/preview/2.0/dataset.json index 28318cb9aa31..6d0f4eae2b24 100644 --- a/specification/maps/data-plane/Microsoft.Maps/Dataset/preview/2.0/dataset.json +++ b/specification/maps/data-plane/Microsoft.Maps/Dataset/preview/2.0/dataset.json @@ -26,14 +26,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", "scopes": { "user_impersonation": "Impersonates a user's Azure Active Directory account." } }, "apiKeyQuery": { "type": "apiKey", - "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", "name": "subscription-key", "in": "query" } @@ -54,7 +54,7 @@ } }, "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory (Azure AD) bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Azure AD bearer token.", "schema": { "$ref": "#/definitions/ODataErrorResponse" }, @@ -152,7 +152,7 @@ }, "ConversionIdQuery": { "name": "conversionId", - "description": "The unique ID used to create the dataset. The `conversionId` must have been obtained from a successful call to the Conversion Service Convert API and may be provided with multiple query parameters with same name (if more than one is provided).", + "description": "The unique ID used to create the dataset. The `conversionId` must have been obtained from a successful call to the Conversion Service [Convert API](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion/convert) and may be provided with multiple query parameters with same name (if more than one is provided).", "type": "string", "in": "query", "required": true, @@ -406,7 +406,7 @@ "definitions": { "ODataErrorResponse": { "type": "object", - "description": "This response object is returned when an error occurs in the Maps API.", + "description": "This response object is returned when an error occurs in the Azure Maps API.", "properties": { "error": { "$ref": "#/definitions/ODataError" @@ -415,7 +415,7 @@ }, "ODataError": { "type": "object", - "description": "This object is returned when an error occurs in the Maps API.", + "description": "This object is returned when an error occurs in the Azure Maps API.", "properties": { "code": { "type": "string", @@ -425,7 +425,7 @@ "message": { "type": "string", "readOnly": true, - "description": "If available, a human readable description of the error." + "description": "If available, a human-readable description of the error." }, "details": { "type": "array", @@ -528,7 +528,7 @@ "readOnly": true }, "ontology": { - "description": "", + "description": "The ontology version of this dataset.", "type": "string", "readOnly": true }, diff --git a/specification/maps/data-plane/Microsoft.Maps/DwgConversion/preview/1.0/dwgconversion.json b/specification/maps/data-plane/Microsoft.Maps/DwgConversion/preview/1.0/dwgconversion.json index 227ec56ce6ce..1c058347349c 100644 --- a/specification/maps/data-plane/Microsoft.Maps/DwgConversion/preview/1.0/dwgconversion.json +++ b/specification/maps/data-plane/Microsoft.Maps/DwgConversion/preview/1.0/dwgconversion.json @@ -25,14 +25,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", "scopes": { "user_impersonation": "Impersonates a user's Azure Active Directory account." } }, "apiKeyQuery": { "type": "apiKey", - "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", "name": "subscription-key", "in": "query" } @@ -53,7 +53,7 @@ } }, "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory (Azure AD) bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Azure AD bearer token.", "schema": { "$ref": "#/definitions/ODataErrorResponse" }, @@ -134,7 +134,7 @@ }, "ClientId": { "name": "x-ms-client-id", - "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", "type": "string", "in": "header", "required": false, @@ -207,7 +207,7 @@ "/conversion/convert": { "post": { "x-publish": true, - "description": "**Conversion Create API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
    \n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and \nSDK. [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.
    \n\nThe Conversion API lets the caller import a set of DWG design files as a zipped [Drawing Package](https://aka.ms/am-drawing-package) into Azure Maps. The [Drawing Package](https://aka.ms/am-drawing-package) should first be \nuploaded using the [Azure Maps Data Service](https://docs.microsoft.com/rest/api/maps/data). Once uploaded, use the \n`udid` returned by the [Data Upload API](https://docs.microsoft.com/rest/api/maps/data/uploadpreview) to call \nthis Conversion API.\n\n## Convert DWG package\n\nThe Conversion API performs a \n[long-running request](https://aka.ms/am-creator-lrt).\n\n## Debug DWG package issues\n\n\nDuring the Conversion process, if there are any issues with the DWG package [errors and warnings](https://aka.ms/am-conversion-errors) are provided in the response along with a *diagnostic package* to visualize \nand diagnose these issues. In case any issues are encountered with your DWG package, the Conversion operation status process as detailed \n[here](https://aka.ms/am-creator-lrt) returns the location of the *diagnostic\npackage* that can be downloaded by the caller to help them visualize and diagnose these issues. The *diagnostic package* location\ncan be found in the properties section of the conversion operation status response and looks like the following:\n\n```json\n{\n \"properties\": {\n \"diagnosticPackageLocation\": \"https://us.atlas.microsoft.com/mapdata/{DiagnosticPackageId}?api-version=1.0\" \n } \n}\n```\n\nThe *diagnostic package* can be downloaded by executing a `HTTP GET` request on the `diagnosticPackageLocation`.\nFor more details on how to use the tool to visualize and diagnose all the errors and warnings see [Drawing Error Visualizer](https://aka.ms/am-drawing-errors-visualizer).
    \n\nA conversion operation will be marked as *success* if there are zero or more warnings but will be marked as *failed* if any errors are encountered. ", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Conversion Create API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
    \n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and \nSDK. [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.
    \n\nThe Conversion API lets the caller import a set of DWG design files as a zipped [Drawing Package](https://aka.ms/am-drawing-package) into Azure Maps. The [Drawing Package](https://aka.ms/am-drawing-package) should first be \nuploaded using the [Azure Maps Data Service](https://docs.microsoft.com/rest/api/maps/data). Once uploaded, use the \n`udid` returned by the [Data Upload API](https://docs.microsoft.com/rest/api/maps/data/uploadpreview) to call \nthis Conversion API.\n\n## Convert DWG package\n\nThe Conversion API performs a \n[long-running request](https://aka.ms/am-creator-lrt).\n\n## Debug DWG package issues\n\n\nDuring the Conversion process, if there are any issues with the DWG package [errors and warnings](https://aka.ms/am-conversion-errors) are provided in the response along with a *diagnostic package* to visualize \nand diagnose these issues. In case any issues are encountered with your DWG package, the Conversion operation status process as detailed \n[here](https://aka.ms/am-creator-lrt) returns the location of the *diagnostic\npackage* that can be downloaded by the caller to help them visualize and diagnose these issues. The *diagnostic package* location\ncan be found in the properties section of the conversion operation status response and looks like the following:\n\n```json\n{\n \"properties\": {\n \"diagnosticPackageLocation\": \"https://us.atlas.microsoft.com/mapdata/{DiagnosticPackageId}?api-version=1.0\" \n } \n}\n```\n\nThe *diagnostic package* can be downloaded by executing a `HTTP GET` request on the `diagnosticPackageLocation`.\nFor more details on how to use the tool to visualize and diagnose all the errors and warnings see [Drawing Error Visualizer](https://aka.ms/am-drawing-errors-visualizer).
    \n\nA conversion operation will be marked as *success* if there are zero or more warnings but will be marked as *failed* if any errors are encountered. ", "operationId": "Conversion_ConvertPreview", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -266,7 +266,7 @@ "/conversion": { "get": { "x-publish": true, - "description": "**Conversion List API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
    \n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.
    \n\nThis API allows the caller to fetch a list of all successful data conversions submitted previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/conversion/convertpreview). \n\n### Submit List Request\n\nTo list all successful conversions you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe Conversion List API returns the complete list of all conversion details in `json` format.
    \n\nHere is a sample response returning the details of two successful conversion requests: \n\n
    \n\n```json\n{\n \"conversions\": \n [\n {\n \"conversionId\": \"54398242-ea6c-1f31-4fa6-79b1ae0fc24d\",\n \"udid\": \"31838736-8b84-11ea-bc55-0242ac130003\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n },\n {\n \"conversionId\": \"2acf7d32-8b84-11ea-bc55-0242ac130003\",\n \"udid\": \"1214bc58-8b84-11ea-bc55-0242ac1300039\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n }\n ]\n}\n```\n\n
    ", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Conversion List API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
    \n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.
    \n\nThis API allows the caller to fetch a list of all successful data conversions submitted previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/conversion/convertpreview). \n\n### Submit List Request\n\nTo list all successful conversions you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe Conversion List API returns the complete list of all conversion details in `json` format.
    \n\nHere is a sample response returning the details of two successful conversion requests: \n\n
    \n\n```json\n{\n \"conversions\": \n [\n {\n \"conversionId\": \"54398242-ea6c-1f31-4fa6-79b1ae0fc24d\",\n \"udid\": \"31838736-8b84-11ea-bc55-0242ac130003\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n },\n {\n \"conversionId\": \"2acf7d32-8b84-11ea-bc55-0242ac130003\",\n \"udid\": \"1214bc58-8b84-11ea-bc55-0242ac1300039\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n }\n ]\n}\n```\n\n
    ", "operationId": "Conversion_ListPreview", "x-ms-examples": { "Returns a list of all the data processed by the Conversion Service for the account": { @@ -312,7 +312,7 @@ "/conversion/{conversionId}": { "delete": { "x-publish": true, - "description": "**Conversion Delete API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
    \n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.
    \n\nThis API allows the caller to delete any data conversions created previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/conversion/convertpreview).\n\n### Submit Delete Request\n\nTo delete your conversion data you will issue a `DELETE` request where the path will contain the `conversionId` of the data to delete.\n\n### Conversion Delete Response\n\nThe Conversion Delete API returns a HTTP `204 No Content` response with an empty body, if the converted data resources were deleted successfully.
    \nA HTTP `400 Bad Request` error response will be returned if no resource associated with the passed-in `conversionId` is found. ", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Conversion Delete API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
    \n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.
    \n\nThis API allows the caller to delete any data conversions created previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/conversion/convertpreview).\n\n### Submit Delete Request\n\nTo delete your conversion data you will issue a `DELETE` request where the path will contain the `conversionId` of the data to delete.\n\n### Conversion Delete Response\n\nThe Conversion Delete API returns a HTTP `204 No Content` response with an empty body, if the converted data resources were deleted successfully.
    \nA HTTP `400 Bad Request` error response will be returned if no resource associated with the passed-in `conversionId` is found. ", "operationId": "Conversion_DeletePreview", "x-ms-examples": { "Delete previously converted content": { @@ -362,7 +362,7 @@ "definitions": { "ODataErrorResponse": { "type": "object", - "description": "This response object is returned when an error occurs in the Maps API.", + "description": "This response object is returned when an error occurs in the Azure Maps API.", "properties": { "error": { "$ref": "#/definitions/ODataError" @@ -371,7 +371,7 @@ }, "ODataError": { "type": "object", - "description": "This object is returned when an error occurs in the Maps API.", + "description": "This object is returned when an error occurs in the Azure Maps API.", "properties": { "code": { "type": "string", @@ -381,7 +381,7 @@ "message": { "type": "string", "readOnly": true, - "description": "If available, a human readable description of the error." + "description": "If available, a human-readable description of the error." }, "details": { "type": "array", diff --git a/specification/maps/data-plane/Microsoft.Maps/DwgConversion/preview/2.0/dwgconversion.json b/specification/maps/data-plane/Microsoft.Maps/DwgConversion/preview/2.0/dwgconversion.json index 013f51c645f5..7aee6aea4ce0 100644 --- a/specification/maps/data-plane/Microsoft.Maps/DwgConversion/preview/2.0/dwgconversion.json +++ b/specification/maps/data-plane/Microsoft.Maps/DwgConversion/preview/2.0/dwgconversion.json @@ -25,14 +25,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", "scopes": { "user_impersonation": "Impersonates a user's Azure Active Directory account." } }, "apiKeyQuery": { "type": "apiKey", - "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", "name": "subscription-key", "in": "query" } @@ -53,7 +53,7 @@ } }, "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory (Azure AD) bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Azure AD bearer token.", "schema": { "$ref": "#/definitions/ODataErrorResponse" }, @@ -134,7 +134,7 @@ }, "ClientId": { "name": "x-ms-client-id", - "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", "type": "string", "in": "header", "required": false, @@ -159,7 +159,7 @@ }, "UdidQuery": { "name": "udid", - "description": "The unique data id for the content. The `udid` must have been obtained from a successful [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data%20v2/uploadpreview) call.", + "description": "The unique data id for the content. The `udid` must have been obtained from a successful [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data-v2/upload-preview) call.", "type": "string", "in": "query", "required": true, @@ -193,7 +193,7 @@ "name": "operationId", "type": "string", "in": "path", - "description": "The ID to query the status for the dataset create/import request.", + "description": "The ID to query the status for the Conversion create/import request.", "required": true, "x-ms-parameter-location": "method" } @@ -202,7 +202,7 @@ "/conversions": { "post": { "x-publish": true, - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe Conversion API lets the caller import a set of DWG design files as a zipped [Drawing Package](https://aka.ms/am-drawing-package) into Azure Maps. The [Drawing Package](https://aka.ms/am-drawing-package) should first be uploaded using the [Azure Maps Data Service](https://docs.microsoft.com/rest/api/maps/data). Once uploaded, use the `udid` returned by the [Data Upload API](https://docs.microsoft.com/rest/api/maps/data/uploadpreview) to call this Conversion API.\n\n## Convert DWG package\n\nThe Conversion API performs a [long-running request](https://aka.ms/am-creator-lrt-v2).\n\n## Debug DWG package issues\n\n\nDuring the Conversion process, if there are any issues with the DWG package [errors and warnings](https://aka.ms/am-conversion-errors) are provided in the response along with a *diagnostic package* to visualize and diagnose these issues. In case any issues are encountered with your DWG package, the Conversion operation status process as detailed [here](https://aka.ms/am-creator-lrt-v2) returns the location of the *diagnostic package* that can be downloaded by the caller to help them visualize and diagnose these issues. The *diagnostic package* location can be found in the properties section of the conversion operation status response and looks like the following:\n\n```json\n{\n \"properties\": {\n \"diagnosticPackageLocation\": \"https://us.atlas.microsoft.com/mapdata/{DiagnosticPackageId}?api-version=1.0\" \n } \n}\n```\n\nThe *diagnostic package* can be downloaded by executing a `HTTP GET` request on the `diagnosticPackageLocation`.\nFor more details on how to use the tool to visualize and diagnose all the errors and warnings see [Drawing Error Visualizer](https://aka.ms/am-drawing-errors-visualizer).
    \n\nA conversion operation will be marked as *success* if there are zero or more warnings but will be marked as *failed* if any errors are encountered. ", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe Conversion API lets the caller import a set of DWG design files as a zipped [Drawing Package](https://aka.ms/am-drawing-package) into Azure Maps. The [Drawing Package](https://aka.ms/am-drawing-package) should first be uploaded using the [Azure Maps Data Service](https://docs.microsoft.com/rest/api/maps/data). Once uploaded, use the `udid` returned by the [Data Upload API](https://docs.microsoft.com/rest/api/maps/data-v2/upload-preview) to call this Conversion API.\n\n## Convert DWG package\n\nThe Conversion API performs a [long-running request](https://aka.ms/am-creator-lrt-v2).\n\n## Debug DWG package issues\n\n\nDuring the Conversion process, if there are any issues with the DWG package [errors and warnings](https://aka.ms/am-conversion-errors) are provided in the response along with a *diagnostic package* to visualize and diagnose these issues. In case any issues are encountered with your DWG package, the Conversion operation status process as detailed [here](https://aka.ms/am-creator-lrt-v2) returns the location of the *diagnostic package* that can be downloaded by the caller to help them visualize and diagnose these issues. The *diagnostic package* location can be found in the properties section of the conversion operation status response and looks like the following:\n\n```json\n{\n \"properties\": {\n \"diagnosticPackageLocation\": \"https://us.atlas.microsoft.com/mapdata/{DiagnosticPackageId}?api-version=1.0\" \n } \n}\n```\n\nThe *diagnostic package* can be downloaded by executing a `HTTP GET` request on the `diagnosticPackageLocation`.\nFor more details on how to use the tool to visualize and diagnose all the errors and warnings see [Drawing Error Visualizer](https://aka.ms/am-drawing-errors-visualizer).
    \n\nA conversion operation will be marked as *success* if there are zero or more warnings but will be marked as *failed* if any errors are encountered. ", "operationId": "Conversion_Convert", "x-ms-examples": { "Convert previously uploaded DWG Package": { @@ -252,7 +252,7 @@ }, "get": { "x-publish": true, - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a list of all successful data conversions submitted previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/conversion/convertpreview). \n\n### Submit List Request\n\nTo list all successful conversions you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe Conversion List API returns the complete list of all conversion details in `json` format.
    \n\nHere is a sample response returning the details of two successful conversion requests: \n\n
    \n\n```json\n{\n \"conversions\": \n [\n {\n \"conversionId\": \"54398242-ea6c-1f31-4fa6-79b1ae0fc24d\",\n \"udid\": \"31838736-8b84-11ea-bc55-0242ac130003\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n },\n {\n \"conversionId\": \"2acf7d32-8b84-11ea-bc55-0242ac130003\",\n \"udid\": \"1214bc58-8b84-11ea-bc55-0242ac1300039\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n }\n ]\n}\n```\n\n
    ", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a list of all successful data conversions submitted previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion/convert). \n\n### Submit List Request\n\nTo list all successful conversions you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe Conversion List API returns the complete list of all conversion details in `json` format.
    \n\nHere is a sample response returning the details of two successful conversion requests: \n\n
    \n\n```json\n{\n \"conversions\": \n [\n {\n \"conversionId\": \"54398242-ea6c-1f31-4fa6-79b1ae0fc24d\",\n \"udid\": \"31838736-8b84-11ea-bc55-0242ac130003\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n },\n {\n \"conversionId\": \"2acf7d32-8b84-11ea-bc55-0242ac130003\",\n \"udid\": \"1214bc58-8b84-11ea-bc55-0242ac1300039\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n }\n ]\n}\n```\n\n
    ", "operationId": "Conversion_List", "x-ms-examples": { "Returns a list of all the data processed by the Conversion Service for the account": { @@ -298,7 +298,7 @@ "/conversions/{conversionId}": { "get": { "x-publish": true, - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a successful data conversion submitted previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/conversion/convertpreview). ", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a successful data conversion submitted previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion/convert). ", "operationId": "Conversion_Get", "x-ms-examples": { "Get the details for one conversion operation": { @@ -345,7 +345,7 @@ }, "delete": { "x-publish": true, - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to delete any data conversions created previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/conversion/convertpreview).\n\n### Submit Delete Request\n\nTo delete your conversion data you will issue a `DELETE` request where the path will contain the `conversionId` of the data to delete.\n\n### Conversion Delete Response\n\nThe Conversion Delete API returns a HTTP `204 No Content` response with an empty body, if the converted data resources were deleted successfully.
    \nA HTTP `400 Bad Request` error response will be returned if no resource associated with the passed-in `conversionId` is found. ", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to delete any data conversions created previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion/convert).\n\n### Submit Delete Request\n\nTo delete your conversion data you will issue a `DELETE` request where the path will contain the `conversionId` of the data to delete.\n\n### Conversion Delete Response\n\nThe Conversion Delete API returns a HTTP `204 No Content` response with an empty body, if the converted data resources were deleted successfully.
    \nA HTTP `400 Bad Request` error response will be returned if no resource associated with the passed-in `conversionId` is found. ", "operationId": "Conversion_Delete", "x-ms-examples": { "Delete previously converted content": { @@ -425,7 +425,7 @@ "definitions": { "ODataErrorResponse": { "type": "object", - "description": "This response object is returned when an error occurs in the Maps API.", + "description": "This response object is returned when an error occurs in the Azure Maps API.", "properties": { "error": { "$ref": "#/definitions/ODataError" @@ -434,7 +434,7 @@ }, "ODataError": { "type": "object", - "description": "This object is returned when an error occurs in the Maps API.", + "description": "This object is returned when an error occurs in the Azure Maps API.", "properties": { "code": { "type": "string", @@ -444,7 +444,7 @@ "message": { "type": "string", "readOnly": true, - "description": "If available, a human readable description of the error." + "description": "If available, a human-readable description of the error." }, "details": { "type": "array", @@ -542,7 +542,7 @@ "readOnly": true }, "ontology": { - "description": "", + "description": "The ontology version of this dataset.", "type": "string", "readOnly": true }, diff --git a/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/featurestate.json b/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/featurestate.json index df8b036ffb72..2ba054df55af 100644 --- a/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/featurestate.json +++ b/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/featurestate.json @@ -25,14 +25,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", "scopes": { "user_impersonation": "Impersonates a user's Azure Active Directory account." } }, "apiKeyQuery": { "type": "apiKey", - "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", "name": "subscription-key", "in": "query" } @@ -53,7 +53,7 @@ } }, "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory (Azure AD) bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Azure AD bearer token.", "schema": { "$ref": "#/definitions/ODataErrorResponse" }, @@ -195,7 +195,7 @@ "/featureState/stateset/{statesetId}": { "get": { "x-publish": true, - "description": "**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
    \n\nThis GET API allows the user to get the stateset Information.\n\nThe stateset Information includes the datasetId associated to the stateset, and the styles of that stateset.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
    \n\nThis GET API allows the user to get the stateset Information.\n\nThe stateset Information includes the datasetId associated to the stateset, and the styles of that stateset.", "operationId": "FeatureState_GetStatesetPreview", "x-ms-examples": { "Get stateset information with a statesetId": { @@ -239,7 +239,7 @@ }, "delete": { "x-publish": true, - "description": "**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
    This DELETE API allows the user to delete the stateset and the associated data.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
    This DELETE API allows the user to delete the stateset and the associated data.", "operationId": "FeatureState_DeleteStatesetPreview", "x-ms-examples": { "Delete an existing stateset": { @@ -280,7 +280,7 @@ }, "put": { "x-publish": true, - "description": "**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
    \n\nThis PUT API allows the user to update the stateset style rules.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
    \n\nThis PUT API allows the user to update the stateset style rules.", "operationId": "FeatureState_PutStatesetPreview", "x-ms-examples": { "Update stateset style rules with a statesetId": { @@ -332,7 +332,7 @@ "/featureState/stateset": { "post": { "x-publish": true, - "description": "**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
    \n\nThis POST API allows the user to create a new Stateset and define stateset style using request body.\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Feature State API is part of Creator. \n\nThe Feature State service allows the user to update the states of a feature and query them to be used in other services. The dynamic properties of a feature that don't belong to the dataset are referred to as *states* here.\n\nThis Feature State service pivot on the Stateset. Like Tileset, Stateset encapsulates the storage mechanism for feature states for a dataset.\n\nOnce the stateset is created, users can use that statesetId to post feature state updates and retrieve the current feature states. A feature can have only one state at a given point in time. \n\nFeature state is defined by the key name, value and the timestamp. When a feature state update is posted to Azure Maps, the state value gets updated only if the provided state’s timestamp is later than the stored timestamp. \n\nAzure Maps MapControl provides a way to use these feature states to style the features. Please refer to the State Tile documentation for more information.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
    \n\nThis POST API allows the user to create a new Stateset and define stateset style using request body.\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Feature State API is part of Creator. \n\nThe Feature State service allows the user to update the states of a feature and query them to be used in other services. The dynamic properties of a feature that don't belong to the dataset are referred to as *states* here.\n\nThis Feature State service pivot on the Stateset. Like Tileset, Stateset encapsulates the storage mechanism for feature states for a dataset.\n\nOnce the stateset is created, users can use that statesetId to post feature state updates and retrieve the current feature states. A feature can have only one state at a given point in time. \n\nFeature state is defined by the key name, value and the timestamp. When a feature state update is posted to Azure Maps, the state value gets updated only if the provided state’s timestamp is later than the stored timestamp. \n\nAzure Maps MapControl provides a way to use these feature states to style the features. Please refer to the State Tile documentation for more information.", "operationId": "FeatureState_CreateStatesetPreview", "x-ms-examples": { "Create a new stateset with a datasetId": { @@ -385,7 +385,7 @@ }, "get": { "x-publish": true, - "description": "**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
    This API allows the caller to fetch a list of all previously successfully created statesets.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
    This API allows the caller to fetch a list of all previously successfully created statesets.", "operationId": "FeatureState_ListStatesetPreview", "x-ms-examples": { "List all the previously created statesets": { @@ -429,7 +429,7 @@ "get": { "x-publish": true, "operationId": "FeatureState_GetStatesPreview", - "description": "**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
    This API returns the current state information associated with the given feature in the given stateset.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
    This API returns the current state information associated with the given feature in the given stateset.", "x-ms-examples": { "Get the current states of a feature": { "$ref": "./examples/GetStates.json" @@ -476,7 +476,7 @@ "post": { "x-publish": true, "operationId": "FeatureState_UpdateStatesPreview", - "description": "**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
    \nThis POST API allows the user to update the state of the given feature in the given stateset.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
    \nThis POST API allows the user to update the state of the given feature in the given stateset.", "x-ms-examples": { "Update the states of a feature": { "$ref": "./examples/UpdateStates.json" @@ -529,7 +529,7 @@ "delete": { "x-publish": true, "operationId": "FeatureState_DeleteStatePreview", - "description": "**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
    This API deletes the state information identified by the StateKeyName parameter for the feature identified by the FeatureId parameter in the the stateset.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).
    This API deletes the state information identified by the StateKeyName parameter for the feature identified by the FeatureId parameter in the the stateset.", "x-ms-examples": { "Delete the given feature state": { "$ref": "./examples/DeleteFeatureState.json" @@ -581,7 +581,7 @@ "definitions": { "ODataErrorResponse": { "type": "object", - "description": "This response object is returned when an error occurs in the Maps API.", + "description": "This response object is returned when an error occurs in the Azure Maps API.", "properties": { "error": { "$ref": "#/definitions/ODataError" @@ -590,7 +590,7 @@ }, "ODataError": { "type": "object", - "description": "This object is returned when an error occurs in the Maps API.", + "description": "This object is returned when an error occurs in the Azure Maps API.", "properties": { "code": { "type": "string", @@ -600,7 +600,7 @@ "message": { "type": "string", "readOnly": true, - "description": "If available, a human readable description of the error." + "description": "If available, a human-readable description of the error." }, "details": { "type": "array", diff --git a/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/2.0/featurestate.json b/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/2.0/featurestate.json index 7398a11f654f..5a3cb74172c4 100644 --- a/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/2.0/featurestate.json +++ b/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/2.0/featurestate.json @@ -25,14 +25,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", "scopes": { "user_impersonation": "Impersonates a user's Azure Active Directory account." } }, "apiKeyQuery": { "type": "apiKey", - "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", "name": "subscription-key", "in": "query" } @@ -53,7 +53,7 @@ } }, "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory (Azure AD) bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Azure AD bearer token.", "schema": { "$ref": "#/definitions/ODataErrorResponse" }, @@ -195,7 +195,7 @@ "/featureStateSets": { "post": { "x-publish": true, - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis POST API allows the user to create a new Stateset and define stateset style using request body.\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Feature State API is part of Creator. \n\nThe Feature State service allows the user to update the states of a feature and query them to be used in other services. The dynamic properties of a feature that don't belong to the dataset are referred to as *states* here.\n\nThis Feature State service pivot on the Stateset. Like Tileset, Stateset encapsulates the storage mechanism for feature states for a dataset.\n\nOnce the stateset is created, users can use that statesetId to post feature state updates and retrieve the current feature states. A feature can have only one state at a given point in time. \n\nFeature state is defined by the key name, value and the timestamp. When a feature state update is posted to Azure Maps, the state value gets updated only if the provided state’s timestamp is later than the stored timestamp. \n\nAzure Maps MapControl provides a way to use these feature states to style the features. Please refer to the State Tile documentation for more information.", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis POST API allows the user to create a new Stateset and define stateset style using request body.\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Feature State API is part of Creator. \n\nThe Feature State service allows the user to update the states of a feature and query them to be used in other services. The dynamic properties of a feature that don't belong to the dataset are referred to as *states* here.\n\nThis Feature State service pivot on the Stateset. Like Tileset, Stateset encapsulates the storage mechanism for feature states for a dataset.\n\nOnce the stateset is created, users can use that statesetId to post feature state updates and retrieve the current feature states. A feature can have only one state at a given point in time. \n\nFeature state is defined by the key name, value and the timestamp. When a feature state update is posted to Azure Maps, the state value gets updated only if the provided state’s timestamp is later than the stored timestamp. \n\nAzure Maps MapControl provides a way to use these feature states to style the features. Please refer to the [State Tile documentation](https://docs.microsoft.com/en-us/rest/api/maps/render/get-map-state-tile-preview) for more information.", "operationId": "FeatureState_CreateStateset", "x-ms-examples": { "Create a new stateset with a datasetId": { @@ -584,7 +584,7 @@ "definitions": { "ODataErrorResponse": { "type": "object", - "description": "This response object is returned when an error occurs in the Maps API.", + "description": "This response object is returned when an error occurs in the Azure Maps API.", "properties": { "error": { "$ref": "#/definitions/ODataError" @@ -593,7 +593,7 @@ }, "ODataError": { "type": "object", - "description": "This object is returned when an error occurs in the Maps API.", + "description": "This object is returned when an error occurs in the Azure Maps API.", "properties": { "code": { "type": "string", @@ -603,7 +603,7 @@ "message": { "type": "string", "readOnly": true, - "description": "If available, a human readable description of the error." + "description": "If available, a human-readable description of the error." }, "details": { "type": "array", diff --git a/specification/maps/data-plane/Microsoft.Maps/Feedback/preview/1.0/feedback.json b/specification/maps/data-plane/Microsoft.Maps/Feedback/preview/1.0/feedback.json index e32a48a67715..ee3fcae13137 100644 --- a/specification/maps/data-plane/Microsoft.Maps/Feedback/preview/1.0/feedback.json +++ b/specification/maps/data-plane/Microsoft.Maps/Feedback/preview/1.0/feedback.json @@ -18,14 +18,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", "scopes": { "user_impersonation": "Impersonates a user's Azure Active Directory account." } }, "apiKeyQuery": { "type": "apiKey", - "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", "name": "subscription-key", "in": "query" } @@ -46,7 +46,7 @@ } }, "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory (Azure AD) bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Azure AD bearer token.", "schema": { "$ref": "#/definitions/ODataErrorResponse" }, @@ -79,7 +79,7 @@ "parameters": { "ClientId": { "name": "x-ms-client-id", - "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", "type": "string", "in": "header", "required": false, @@ -107,7 +107,7 @@ "definitions": { "ODataErrorResponse": { "type": "object", - "description": "This response object is returned when an error occurs in the Maps API.", + "description": "This response object is returned when an error occurs in the Azure Maps API.", "properties": { "error": { "$ref": "#/definitions/ODataError" @@ -116,7 +116,7 @@ }, "ODataError": { "type": "object", - "description": "This object is returned when an error occurs in the Maps API.", + "description": "This object is returned when an error occurs in the Azure Maps API.", "properties": { "code": { "type": "string", @@ -126,7 +126,7 @@ "message": { "type": "string", "readOnly": true, - "description": "If available, a human readable description of the error." + "description": "If available, a human-readable description of the error." }, "details": { "type": "array", diff --git a/specification/maps/data-plane/Microsoft.Maps/Geolocation/preview/1.0/geolocation.json b/specification/maps/data-plane/Microsoft.Maps/Geolocation/preview/1.0/geolocation.json index 237abbe0d7c6..d5540b97f505 100644 --- a/specification/maps/data-plane/Microsoft.Maps/Geolocation/preview/1.0/geolocation.json +++ b/specification/maps/data-plane/Microsoft.Maps/Geolocation/preview/1.0/geolocation.json @@ -18,14 +18,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", "scopes": { "user_impersonation": "Impersonates a user's Azure Active Directory account." } }, "apiKeyQuery": { "type": "apiKey", - "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", "name": "subscription-key", "in": "query" } @@ -46,7 +46,7 @@ } }, "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory (Azure AD) bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Azure AD bearer token.", "schema": { "$ref": "#/definitions/ODataErrorResponse" }, @@ -79,7 +79,7 @@ "parameters": { "ClientId": { "name": "x-ms-client-id", - "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", "type": "string", "in": "header", "required": false, @@ -185,7 +185,7 @@ "definitions": { "ODataErrorResponse": { "type": "object", - "description": "This response object is returned when an error occurs in the Maps API.", + "description": "This response object is returned when an error occurs in the Azure Maps API.", "properties": { "error": { "$ref": "#/definitions/ODataError" @@ -194,7 +194,7 @@ }, "ODataError": { "type": "object", - "description": "This object is returned when an error occurs in the Maps API.", + "description": "This object is returned when an error occurs in the Azure Maps API.", "properties": { "code": { "type": "string", @@ -204,7 +204,7 @@ "message": { "type": "string", "readOnly": true, - "description": "If available, a human readable description of the error." + "description": "If available, a human-readable description of the error." }, "details": { "type": "array", diff --git a/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/mobility.json b/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/mobility.json index 82686274d07f..01fbad524e40 100644 --- a/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/mobility.json +++ b/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/mobility.json @@ -17,14 +17,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", "scopes": { "user_impersonation": "Impersonates a user's Azure Active Directory account." } }, "apiKeyQuery": { "type": "apiKey", - "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", "name": "subscription-key", "in": "query" } @@ -45,7 +45,7 @@ } }, "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory (Azure AD) bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Azure AD bearer token.", "schema": { "$ref": "#/definitions/ODataErrorResponse" }, @@ -78,7 +78,7 @@ "parameters": { "ClientId": { "name": "x-ms-client-id", - "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", "type": "string", "in": "header", "required": false, @@ -143,9 +143,10 @@ "paths": { "/mobility/metroArea/id/{format}": { "get": { + "deprecated": true, "x-publish": true, "operationId": "Mobility_GetMetroAreaPreview", - "description": "**Metro Area API**\n\n**Applies to**: S1 pricing tier.\n\nService allows users to request metro areas in which the Azure Maps Mobility Service is available. The service supports filtering results by country or coordinate location. Information returned includes Metro Area details such as metro Id, name and a representation of the metro area geometry in GeoJSON format.", + "description": ">[!Important]\n>The Azure Maps Mobility Services Preview has been retired and will no longer be available and supported after October 5, 2021. All other Azure Maps API and Services are unaffected by this retirement announcement.\n>For details, see [Azure Maps Mobility Preview Retirement](https://azure.microsoft.com/updates/azure-maps-mobility-services-preview-retirement/).\n\n\n**Metro Area API**\n\n**Applies to**: S1 pricing tier.\n\nService allows users to request metro areas in which the Azure Maps Mobility Service is available. The service supports filtering results by country or coordinate location. Information returned includes Metro Area details such as metro Id, name and a representation of the metro area geometry in GeoJSON format.", "x-ms-examples": { "MetroArea": { "$ref": "./examples/GetMetroArea.json" @@ -229,9 +230,10 @@ }, "/mobility/metroArea/info/{format}": { "get": { + "deprecated": true, "x-publish": true, "operationId": "Mobility_GetMetroAreaInfoPreview", - "description": "**Metro Area Info API**\n\n**Applies to**: S1 pricing tier.\n\nService allows users to request additional information for metro areas in which the Azure Maps Mobility services are available. Information such as supported transit types, transit agencies and active alerts is available, depending on the options selected. Also, the service returns information if the public transit fare information is available for the requested metro area.", + "description": ">[!Important]\n>The Azure Maps Mobility Services Preview has been retired and will no longer be available and supported after October 5, 2021. All other Azure Maps API and Services are unaffected by this retirement announcement.\n>For details, see [Azure Maps Mobility Preview Retirement](https://azure.microsoft.com/updates/azure-maps-mobility-services-preview-retirement/).\n\n\n**Metro Area Info API**\n\n**Applies to**: S1 pricing tier.\n\nService allows users to request additional information for metro areas in which the Azure Maps Mobility services are available. Information such as supported transit types, transit agencies and active alerts is available, depending on the options selected. Also, the service returns information if the public transit fare information is available for the requested metro area.", "x-ms-examples": { "MetroAreaInfo": { "$ref": "./examples/GetMetroAreaInfo.json" @@ -328,9 +330,10 @@ }, "/mobility/transit/nearby/{format}": { "get": { + "deprecated": true, "x-publish": true, "operationId": "Mobility_GetNearbyTransitPreview", - "description": "**Find Nearby Transit API**\n\n**Applies to**: S1 pricing tier.\n\nGet Nearby Transit service allows you to search public transit stops around a given location returning the transit object details. Service allows users to search for public transit stops within a given radius returning a set of stops with stop details. Additional information such as transit operator information is returned depending on the options selected. The returned information can be used for further processing such as requesting [real-time arrivals](https://aka.ms/AzureMapsMobilityRealTimeArrivals) for the stop or [transit stop details](https://aka.ms/AzureMapsMobilityTransitStop) such as main transit type of most lines stopping for a given public, active service alerts or main transport agency.", + "description": ">[!Important]\n>The Azure Maps Mobility Services Preview has been retired and will no longer be available and supported after October 5, 2021. All other Azure Maps API and Services are unaffected by this retirement announcement.\n>For details, see [Azure Maps Mobility Preview Retirement](https://azure.microsoft.com/updates/azure-maps-mobility-services-preview-retirement/).\n\n\n**Find Nearby Transit API**\n\n**Applies to**: S1 pricing tier.\n\nGet Nearby Transit service allows you to search public transit stops around a given location returning the transit object details. Service allows users to search for public transit stops within a given radius returning a set of stops with stop details. Additional information such as transit operator information is returned depending on the options selected. The returned information can be used for further processing such as requesting [real-time arrivals](https://aka.ms/AzureMapsMobilityRealTimeArrivals) for the stop or [transit stop details](https://aka.ms/AzureMapsMobilityTransitStop) such as main transit type of most lines stopping for a given public, active service alerts or main transport agency.", "x-ms-examples": { "NearbyTransit": { "$ref": "./examples/GetNearbyTransit.json" @@ -414,9 +417,10 @@ }, "/mobility/transit/line/{format}": { "get": { + "deprecated": true, "x-publish": true, "operationId": "Mobility_GetTransitLineInfoPreview", - "description": "**Transit Line Info API**\n\n**Applies to**: S1 pricing tier.\n\nYour scenario might require requesting transit line specific data such as stops and line geometry. Transit Line Info service allows you to request line group by line group id returning a line group comprised a set of lines. Additional information such as 24 hours static schedule, active alerts for the line group and line patterns is also available, depending on the options selected. Mobility services uses a parallel data model for public transit lines and line groups. Usually line group contains 2 lines, one going from A to B, and the other returning from B to A, both operating by the same Public Transport Agency having the same line number. We recommend you review our guidance [article](https://aka.ms/AMapsPublicTRansitConcepts) to understand the concepts of lines and line groups.", + "description": ">[!Important]\n>The Azure Maps Mobility Services Preview has been retired and will no longer be available and supported after October 5, 2021. All other Azure Maps API and Services are unaffected by this retirement announcement.\n>For details, see [Azure Maps Mobility Preview Retirement](https://azure.microsoft.com/updates/azure-maps-mobility-services-preview-retirement/).\n\n\n**Transit Line Info API**\n\n**Applies to**: S1 pricing tier.\n\nYour scenario might require requesting transit line specific data such as stops and line geometry. Transit Line Info service allows you to request line group by line group id returning a line group comprised a set of lines. Additional information such as 24 hours static schedule, active alerts for the line group and line patterns is also available, depending on the options selected. Mobility services uses a parallel data model for public transit lines and line groups. Usually line group contains 2 lines, one going from A to B, and the other returning from B to A, both operating by the same Public Transport Agency having the same line number. We recommend you review our guidance [article](https://aka.ms/AMapsPublicTRansitConcepts) to understand the concepts of lines and line groups.", "x-ms-examples": { "TransitLineInfo": { "$ref": "./examples/GetTransitLineInfo.json" @@ -524,9 +528,10 @@ }, "/mobility/transit/stop/{format}": { "get": { + "deprecated": true, "x-publish": true, "operationId": "Mobility_GetTransitStopInfoPreview", - "description": "**Transit Stop Info API**\n\n**Applies to**: S1 pricing tier.\n\nGet Transit Stop Info service allows you to request information for a given public transit stop. Basic information returned includes details such as main transit type of most lines stopping for a given public and main transport agency. Additional details such as stop lines and active service alerts for specified stop are also available, depending on the options selected.", + "description": ">[!Important]\n>The Azure Maps Mobility Services Preview has been retired and will no longer be available and supported after October 5, 2021. All other Azure Maps API and Services are unaffected by this retirement announcement.\n>For details, see [Azure Maps Mobility Preview Retirement](https://azure.microsoft.com/updates/azure-maps-mobility-services-preview-retirement/).\n\n\n**Transit Stop Info API**\n\n**Applies to**: S1 pricing tier.\n\nGet Transit Stop Info service allows you to request information for a given public transit stop. Basic information returned includes details such as main transit type of most lines stopping for a given public and main transport agency. Additional details such as stop lines and active service alerts for specified stop are also available, depending on the options selected.", "x-ms-examples": { "TransitStopInfo": { "$ref": "./examples/GetTransitStopInfo.json" @@ -651,9 +656,10 @@ }, "/mobility/transit/route/{format}": { "get": { + "deprecated": true, "x-publish": true, "operationId": "Mobility_GetTransitRoutePreview", - "description": "**Transit Route API**\n\n**Applies to**: S1 pricing tier.\n\nGet Transit Route API will allow trip planning returning the best possible route options between an origin and destination by using multi-modal search. Service provides a variety of travel modes, including walk, bike, and public transit. The API supports parameters to request one or multiple public transit types such as bus, tram and subway, and prefer a specific transit agency operating in the area. Also, service provides transit fare details and options to choose optimal route with least walk or transfers and specify arrival or departure times when user need to be at a specific destination by a certain time.", + "description": ">[!Important]\n>The Azure Maps Mobility Services Preview has been retired and will no longer be available and supported after October 5, 2021. All other Azure Maps API and Services are unaffected by this retirement announcement.\n>For details, see [Azure Maps Mobility Preview Retirement](https://azure.microsoft.com/updates/azure-maps-mobility-services-preview-retirement/).\n\n\n**Transit Route API**\n\n**Applies to**: S1 pricing tier.\n\nGet Transit Route API will allow trip planning returning the best possible route options between an origin and destination by using multi-modal search. Service provides a variety of travel modes, including walk, bike, and public transit. The API supports parameters to request one or multiple public transit types such as bus, tram and subway, and prefer a specific transit agency operating in the area. Also, service provides transit fare details and options to choose optimal route with least walk or transfers and specify arrival or departure times when user need to be at a specific destination by a certain time.", "x-ms-examples": { "TransitRoute": { "$ref": "./examples/GetTransitRoute.json" @@ -996,9 +1002,10 @@ }, "/mobility/transit/itinerary/{format}": { "get": { + "deprecated": true, "x-publish": true, "operationId": "Mobility_GetTransitItineraryPreview", - "description": "**Transit Itinerary API**\n\n**Applies to**: S1 pricing tier.\n\nReturns data according to an itinerary Id previously returned by [Transit Route API](https://aka.ms/AzureMapsMobilityTransitRoute). The basic info contains data as to the various legs comprising the itinerary, including the locations, public transit lines, start and end times and fare information. Users can request additional routing information such as the shape of the itinerary and detailed itinerary schedules is also available, depending on the options selected. An itinerary is available up to 24 hours following a search request.", + "description": ">[!Important]\n>The Azure Maps Mobility Services Preview has been retired and will no longer be available and supported after October 5, 2021. All other Azure Maps API and Services are unaffected by this retirement announcement.\n>For details, see [Azure Maps Mobility Preview Retirement](https://azure.microsoft.com/updates/azure-maps-mobility-services-preview-retirement/).\n\n\n**Transit Itinerary API**\n\n**Applies to**: S1 pricing tier.\n\nReturns data according to an itinerary Id previously returned by [Transit Route API](https://aka.ms/AzureMapsMobilityTransitRoute). The basic info contains data as to the various legs comprising the itinerary, including the locations, public transit lines, start and end times and fare information. Users can request additional routing information such as the shape of the itinerary and detailed itinerary schedules is also available, depending on the options selected. An itinerary is available up to 24 hours following a search request.", "x-ms-examples": { "TransitItinerary": { "$ref": "./examples/GetTransitItinerary.json" @@ -1084,9 +1091,10 @@ }, "/mobility/realtime/arrivals/{format}": { "get": { + "deprecated": true, "x-publish": true, "operationId": "Mobility_GetRealTimeArrivalsPreview", - "description": "**Real-time Arrivals API**\n\n**Applies to**: S1 pricing tier.\n\nGet Real Time Arrivals API returns for a given a stop, line or location the requested number of real-time arrivals. Endpoint support different modes to request real-time arrivals such as number of live arrivals for all lines arriving at the specified stop or all arrivals of a line to stops near the user’s location. The API supports parameters to request one or multiple public transit types such as bus, tram and subway, maximum number if arrivals, and prefer a specific transit agency operating in the area. In some cases real-time arrivals may not be available, for example, if arrival is too far in the future or transit vehicle does not have capability to share the real-time location. This is symbolized in a scheduleType field present in all responses.", + "description": ">[!Important]\n>The Azure Maps Mobility Services Preview has been retired and will no longer be available and supported after October 5, 2021. All other Azure Maps API and Services are unaffected by this retirement announcement.\n>For details, see [Azure Maps Mobility Preview Retirement](https://azure.microsoft.com/updates/azure-maps-mobility-services-preview-retirement/).\n\n\n**Real-time Arrivals API**\n\n**Applies to**: S1 pricing tier.\n\nGet Real Time Arrivals API returns for a given a stop, line or location the requested number of real-time arrivals. Endpoint support different modes to request real-time arrivals such as number of live arrivals for all lines arriving at the specified stop or all arrivals of a line to stops near the user’s location. The API supports parameters to request one or multiple public transit types such as bus, tram and subway, maximum number if arrivals, and prefer a specific transit agency operating in the area. In some cases real-time arrivals may not be available, for example, if arrival is too far in the future or transit vehicle does not have capability to share the real-time location. This is symbolized in a scheduleType field present in all responses.", "x-ms-examples": { "RealTimeArrivals": { "$ref": "./examples/GetRealTimeArrivals.json" @@ -1337,7 +1345,7 @@ "definitions": { "ODataErrorResponse": { "type": "object", - "description": "This response object is returned when an error occurs in the Maps API.", + "description": "This response object is returned when an error occurs in the Azure Maps API.", "properties": { "error": { "$ref": "#/definitions/ODataError" @@ -1346,7 +1354,7 @@ }, "ODataError": { "type": "object", - "description": "This object is returned when an error occurs in the Maps API.", + "description": "This object is returned when an error occurs in the Azure Maps API.", "properties": { "code": { "type": "string", @@ -1356,7 +1364,7 @@ "message": { "type": "string", "readOnly": true, - "description": "If available, a human readable description of the error." + "description": "If available, a human-readable description of the error." }, "details": { "type": "array", diff --git a/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/render.json b/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/render.json index 3fe229eaf2f9..640b24eb7549 100644 --- a/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/render.json +++ b/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/render.json @@ -19,14 +19,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", "scopes": { "user_impersonation": "Impersonates a user's Azure Active Directory account." } }, "apiKeyQuery": { "type": "apiKey", - "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", "name": "subscription-key", "in": "query" } @@ -47,7 +47,7 @@ } }, "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory (Azure AD) bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Azure AD bearer token.", "schema": { "$ref": "#/definitions/ODataErrorResponse" }, @@ -80,7 +80,7 @@ "parameters": { "ClientId": { "name": "x-ms-client-id", - "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", "type": "string", "in": "header", "required": false, @@ -266,7 +266,7 @@ "/map/static/{format}": { "get": { "x-publish": true, - "description": "**Applies to**: S0 and S1 pricing tiers.\n\n\nThe static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20. The static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20. The supported resolution range for the map image is from 1x1 to 8192x8192. If you are deciding when to use the static image service over the map tile service, you may want to consider how you would like to interact with the rendered map. If the map contents will be relatively unchanging, a static map is a good choice. If you want to support a lot of zooming, panning and changing of the map content, the map tile service would be a better choice. \n\nService also provides Image Composition functionality to get a static image back with additional data like; pushpins and geometry overlays with following S0 and S1 capabilities. \n\nIn S0 you can:\n- Render up to 5 pushpins specified in the request\n- Provide one custom image for the pins referenced in the request\n- Add labels to the pushpins\n\nIn S1 you can:\n- Render pushpins through [Azure Maps Data Service](https://aka.ms/AzureMapsMapDataService)\n- Specify multiple pushpin styles\n- Provide custom pushpin images stored in [Azure Maps Data Service](https://aka.ms/AzureMapsMapDataService)\n- Render circle, polyline and polygon geometry types.\n- Render of supported GeoJSON geometry types uploaded through [Azure Maps Data Service](https://aka.ms/AzureMapsMapDataService)\n\nPlease see [How-to-Guide](https://aka.ms/AzureMapsHowToGuideImageCompositor) for detailed examples.\n\n_Note_ : Either **center** or **bbox** parameter must be supplied to the\nAPI.\n

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

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

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

    \n\n |Zoom Level | Max Lon Range | Max Lat Range|\n |:----------|:----------------|:-------------|\n |0 | 360.0 | 170.0 | \n |1 | 360.0 | 170.0 |\n |2 | 360.0 | 170.0 |\n |3 | 360.0 | 170.0 |\n |4 | 360.0 | 170.0 |\n |5 | 180.0 | 85.0 |\n |6 | 90.0 | 42.5 |\n |7 | 45.0 | 21.25 |\n |8 | 22.5 | 10.625 |\n |9 | 11.25 | 5.3125 |\n |10 | 5.625 | 2.62625 |\n |11 | 2.8125 | 1.328125 |\n |12 | 1.40625 | 0.6640625 |\n |13 | 0.703125 | 0.33203125 |\n |14 | 0.3515625 | 0.166015625 |\n |15 | 0.17578125 | 0.0830078125 | \n |16 | 0.087890625 | 0.0415039063 | \n |17 | 0.0439453125 | 0.0207519531 |\n |18 | 0.0219726563 | 0.0103759766 |\n |19 | 0.0109863281 | 0.0051879883 |\n |20 | 0.0054931641 | 0.0025939941 |", "operationId": "Render_GetMapImage", "x-ms-examples": { "GetMapStaticImage": { @@ -398,7 +398,7 @@ }, { "name": "pins", - "description": "Pushpin style and instances. Use this parameter to optionally add pushpins to the image.\nThe pushpin style describes the appearance of the pushpins, and the instances specify\nthe coordinates of the pushpins and optional labels for each pin. (Be sure to properly URL-encode values of this\nparameter since it will contain reserved characters such as pipes and punctuation.)\n\nThe Azure Maps account S0 SKU only supports a single instance of the pins parameter. Other SKUs\nallow multiple instances of the pins parameter to specify multiple pin styles.\n\nTo render a pushpin at latitude 45°N and longitude 122°W using the default built-in pushpin style, add the\nquerystring parameter \n\n`pins=default||-122 45` \n\nNote that the longitude comes before the latitude.\nAfter URL encoding this will look like\n\n`pins=default%7C%7C-122+45`\n\nAll of the examples here show the pins\nparameter without URL encoding, for clarity.\n\nTo render a pin at multiple locations, separate each location with a pipe character. For example, use\n\n`pins=default||-122 45|-119.5 43.2|-121.67 47.12`\n\nThe S0 Azure Maps account SKU only allows five pushpins. Other account SKUs do not have this limitation.\n\n### Style Modifiers\n\nYou can modify the appearance of the pins by adding style modifiers. These are added after the style but before\nthe locations and labels. Style modifiers each have a two-letter name. These abbreviated names are used to help\nreduce the length of the URL.\n\nTo change the color of the pushpin, use the 'co' style modifier and specify the color using the HTML/CSS RGB color\nformat which is a six-digit hexadecimal number (the three-digit form is not supported). For example, to use\na deep pink color which you would specify as #FF1493 in CSS, use\n\n`pins=default|coFF1493||-122 45`\n\n### Pushpin Labels\n\nTo add a label to the pins, put the label in single quotes just before the coordinates. For example, to label\nthree pins with the values '1', '2', and '3', use\n\n`pins=default||'1'-122 45|'2'-119.5 43.2|'3'-121.67 47.12`\n\nThere is a built in pushpin style called 'none' that does not display a pushpin image. You can use this if\nyou want to display labels without any pin image. For example,\n\n`pins=none||'A'-122 45|'B'-119.5 43.2`\n\nTo change the color of the pushpin labels, use the 'lc' label color style modifier. For example, to use pink\npushpins with black labels, use\n\n`pins=default|coFF1493|lc000000||-122 45`\n\nTo change the size of the labels, use the 'ls' label size style modifier. The label size represents the approximate\nheight of the label text in pixels. For example, to increase the label size to 12, use\n\n`pins=default|ls12||'A'-122 45|'B'-119 43`\n\nThe labels are centered at the pushpin 'label anchor.' The anchor location is predefined for built-in pushpins and\nis at the top center of custom pushpins (see below). To override the label anchor, using the 'la' style modifier\nand provide X and Y pixel coordinates for the anchor. These coordinates are relative to the top left corner of the\npushpin image. Positive X values move the anchor to the right, and positive Y values move the anchor down. For example,\nto position the label anchor 10 pixels right and 4 pixels above the top left corner of the pushpin image,\nuse\n\n`pins=default|la10 -4||'A'-122 45|'B'-119 43`\n\n### Custom Pushpins\n\nTo use a custom pushpin image, use the word 'custom' as the pin style name, and then specify a URL after the\nlocation and label information. Use two pipe characters to indicate that you're done specifying locations and are\nstarting the URL. For example,\n\n`pins=custom||-122 45||http://contoso.com/pushpins/red.png`\n\nAfter URL encoding, this would look like\n\n`pins=custom%7C%7C-122+45%7C%7Chttp%3A%2F%2Fcontoso.com%2Fpushpins%2Fred.png`\n\nBy default, custom pushpin images are drawn centered at the pin coordinates. This usually isn't ideal as it obscures\nthe location that you're trying to highlight. To override the anchor location of the pin image, use the 'an'\nstyle modifier. This uses the same format as the 'la' label anchor style modifier. For example, if your custom\npin image has the tip of the pin at the top left corner of the image, you can set the anchor to that spot by\nusing\n\n`pins=custom|an0 0||-122 45||http://contoso.com/pushpins/red.png`\n\nNote: If you use the 'co' color modifier with a custom pushpin image, the specified color will replace the RGB \nchannels of the pixels in the image but will leave the alpha (opacity) channel unchanged. This would usually\nonly be done with a solid-color custom image.\n\n### Getting Pushpins from Azure Maps Data Storage\n\nFor all Azure Maps account SKUs other than S0,\nthe pushpin image and location information can be obtained from Azure Maps Data Storage. After uploading a pushpin image\nor a GeoJSON document containing pin locations, the Data Storage service returns a Unique Data ID (UDID) that you can use\nto reference the data in the pins parameter.\n\nTo use a custom pushpin image from Azure Maps Data Storage, specify the UDID prefixed by 'udid-' as the name of the\npushpin style. For example,\n\n`pins=udid-fe22c504-3a81-4fcd-adc6-a3507ce866c1||-122 45`\n\nTo use the point geometry from an uploaded GeoJSON document as the pin locations, specify the UDID in the locations\nsection of the pins parameter. For example,\n\n`pins=default||udid-29dc105a-dee7-409f-a3f9-22b066ae4713`\n\nNote that\nonly point and multipoint geometry, points and multipoints from geometry collections, and point geometry from features\nwill be used. Linestring and polygon geometry will be ignored. If the point comes from a feature and the feature\nhas a string property called \"label\", the value of that property will be used as the label for the pin.\n\nYou can mix pin locations from Data Storage and pin locations specified in the pins parameter. Any of the pipe-delimited\npin locations can be a longitude and latitude or a UDID. For example,\n\n`pins=default||-122 45|udid-29dc105a-dee7-409f-a3f9-22b066ae4713|-119 43`\n\n### Scale, Rotation, and Opacity\n\nYou can make pushpins and their labels larger or smaller by using the 'sc' scale style modifier. This is a\nvalue greater than zero. A value of 1 is the standard scale. Values larger than 1 will make the pins larger, and\nvalues smaller than 1 will make them smaller. For example, to draw the pushpins 50% larger than normal, use\n\n`pins=default|sc1.5||-122 45`\n\nYou can rotate pushpins and their labels by using the 'ro' rotation style modifier. This is a number of degrees\nof clockwise rotation. Use a negative number to rotate counter-clockwise. For example, to rotate the pushpins\n90 degrees clockwise and double their size, use\n\n`pins=default|ro90|sc2||-122 45`\n\nYou can make pushpins and their labels partially transparent by specifying the 'al' alpha style modifier.\nThis is a number between 0 and 1 indicating the opacity of the pushpins. Zero makes them completely transparent\n(and not visible) and 1 makes them completely opaque (which is the default). For example, to make pushpins\nand their labels only 67% opaque, use\n\n`pins=default|al.67||-122 45`\n\n### Style Modifier Summary\n\nModifier | Description | Range \n:--------:|-----------------|------------------\nal | Alpha (opacity) | 0 to 1 \nan | Pin anchor | * \nco | Pin color | 000000 to FFFFFF \nla | Label anchor | * \nlc | Label color | 000000 to FFFFFF \nls | Label size | Greater than 0 \nro | Rotation | -360 to 360 \nsc | Scale | Greater than 0 \n\n* X and Y coordinates can be anywhere within pin image or a margin around it.\nThe margin size is the minimum of the pin width and height.", + "description": "Pushpin style and instances. Use this parameter to optionally add pushpins to the image.\nThe pushpin style describes the appearance of the pushpins, and the instances specify\nthe coordinates of the pushpins and optional labels for each pin. (Be sure to properly URL-encode values of this\nparameter since it will contain reserved characters such as pipes and punctuation.)\n\nThe Azure Maps account S0 SKU only supports a single instance of the pins parameter. Other SKUs\nallow multiple instances of the pins parameter to specify multiple pin styles.\n\nTo render a pushpin at latitude 45°N and longitude 122°W using the default built-in pushpin style, add the\nquerystring parameter \n\n`pins=default||-122 45` \n\nNote that the longitude comes before the latitude.\nAfter URL encoding this will look like\n\n`pins=default%7C%7C-122+45`\n\nAll of the examples here show the pins\nparameter without URL encoding, for clarity.\n\nTo render a pin at multiple locations, separate each location with a pipe character. For example, use\n\n`pins=default||-122 45|-119.5 43.2|-121.67 47.12`\n\nThe S0 Azure Maps account SKU only allows five pushpins. Other account SKUs do not have this limitation.\n\n### Style Modifiers\n\nYou can modify the appearance of the pins by adding style modifiers. These are added after the style but before\nthe locations and labels. Style modifiers each have a two-letter name. These abbreviated names are used to help\nreduce the length of the URL.\n\nTo change the color of the pushpin, use the 'co' style modifier and specify the color using the HTML/CSS RGB color\nformat which is a six-digit hexadecimal number (the three-digit form is not supported). For example, to use\na deep pink color which you would specify as #FF1493 in CSS, use\n\n`pins=default|coFF1493||-122 45`\n\n### Pushpin Labels\n\nTo add a label to the pins, put the label in single quotes just before the coordinates. For example, to label\nthree pins with the values '1', '2', and '3', use\n\n`pins=default||'1'-122 45|'2'-119.5 43.2|'3'-121.67 47.12`\n\nThere is a built in pushpin style called 'none' that does not display a pushpin image. You can use this if\nyou want to display labels without any pin image. For example,\n\n`pins=none||'A'-122 45|'B'-119.5 43.2`\n\nTo change the color of the pushpin labels, use the 'lc' label color style modifier. For example, to use pink\npushpins with black labels, use\n\n`pins=default|coFF1493|lc000000||-122 45`\n\nTo change the size of the labels, use the 'ls' label size style modifier. The label size represents the approximate\nheight of the label text in pixels. For example, to increase the label size to 12, use\n\n`pins=default|ls12||'A'-122 45|'B'-119 43`\n\nThe labels are centered at the pushpin 'label anchor.' The anchor location is predefined for built-in pushpins and\nis at the top center of custom pushpins (see below). To override the label anchor, using the 'la' style modifier\nand provide X and Y pixel coordinates for the anchor. These coordinates are relative to the top left corner of the\npushpin image. Positive X values move the anchor to the right, and positive Y values move the anchor down. For example,\nto position the label anchor 10 pixels right and 4 pixels above the top left corner of the pushpin image,\nuse\n\n`pins=default|la10 -4||'A'-122 45|'B'-119 43`\n\n### Custom Pushpins\n\nTo use a custom pushpin image, use the word 'custom' as the pin style name, and then specify a URL after the\nlocation and label information. Use two pipe characters to indicate that you're done specifying locations and are\nstarting the URL. For example,\n\n`pins=custom||-122 45||http://contoso.com/pushpins/red.png`\n\nAfter URL encoding, this would look like\n\n`pins=custom%7C%7C-122+45%7C%7Chttp%3A%2F%2Fcontoso.com%2Fpushpins%2Fred.png`\n\nBy default, custom pushpin images are drawn centered at the pin coordinates. This usually isn't ideal as it obscures\nthe location that you're trying to highlight. To override the anchor location of the pin image, use the 'an'\nstyle modifier. This uses the same format as the 'la' label anchor style modifier. For example, if your custom\npin image has the tip of the pin at the top left corner of the image, you can set the anchor to that spot by\nusing\n\n`pins=custom|an0 0||-122 45||http://contoso.com/pushpins/red.png`\n\nNote: If you use the 'co' color modifier with a custom pushpin image, the specified color will replace the RGB \nchannels of the pixels in the image but will leave the alpha (opacity) channel unchanged. This would usually\nonly be done with a solid-color custom image.\n\n### Getting Pushpins from Azure Maps Data Storage\n\nFor all Azure Maps account SKUs other than S0,\nthe pushpin location information can be obtained from Azure Maps Data Storage. After uploading a GeoJSON document containing pin locations, the Data Storage service returns a Unique Data ID (UDID) that you can use\nto reference the data in the pins parameter.\n\nTo use the point geometry from an uploaded GeoJSON document as the pin locations, specify the UDID in the locations\nsection of the pins parameter. For example,\n\n`pins=default||udid-29dc105a-dee7-409f-a3f9-22b066ae4713`\n\nNote that\nonly point and multipoint geometry, points and multipoints from geometry collections, and point geometry from features\nwill be used. Linestring and polygon geometry will be ignored. If the point comes from a feature and the feature\nhas a string property called \"label\", the value of that property will be used as the label for the pin.\n\nYou can mix pin locations from Data Storage and pin locations specified in the pins parameter. Any of the pipe-delimited\npin locations can be a longitude and latitude or a UDID. For example,\n\n`pins=default||-122 45|udid-29dc105a-dee7-409f-a3f9-22b066ae4713|-119 43`\n\n### Scale, Rotation, and Opacity\n\nYou can make pushpins and their labels larger or smaller by using the 'sc' scale style modifier. This is a\nvalue greater than zero. A value of 1 is the standard scale. Values larger than 1 will make the pins larger, and\nvalues smaller than 1 will make them smaller. For example, to draw the pushpins 50% larger than normal, use\n\n`pins=default|sc1.5||-122 45`\n\nYou can rotate pushpins and their labels by using the 'ro' rotation style modifier. This is a number of degrees\nof clockwise rotation. Use a negative number to rotate counter-clockwise. For example, to rotate the pushpins\n90 degrees clockwise and double their size, use\n\n`pins=default|ro90|sc2||-122 45`\n\nYou can make pushpins and their labels partially transparent by specifying the 'al' alpha style modifier.\nThis is a number between 0 and 1 indicating the opacity of the pushpins. Zero makes them completely transparent\n(and not visible) and 1 makes them completely opaque (which is the default). For example, to make pushpins\nand their labels only 67% opaque, use\n\n`pins=default|al.67||-122 45`\n\n### Style Modifier Summary\n\nModifier | Description | Range \n:--------:|-----------------|------------------\nal | Alpha (opacity) | 0 to 1 \nan | Pin anchor | * \nco | Pin color | 000000 to FFFFFF \nla | Label anchor | * \nlc | Label color | 000000 to FFFFFF \nls | Label size | Greater than 0 \nro | Rotation | -360 to 360 \nsc | Scale | Greater than 0 \n\n* X and Y coordinates can be anywhere within pin image or a margin around it.\nThe margin size is the minimum of the pin width and height.", "in": "query", "required": false, "type": "array", @@ -993,7 +993,7 @@ "definitions": { "ODataErrorResponse": { "type": "object", - "description": "This response object is returned when an error occurs in the Maps API.", + "description": "This response object is returned when an error occurs in the Azure Maps API.", "properties": { "error": { "$ref": "#/definitions/ODataError" @@ -1002,7 +1002,7 @@ }, "ODataError": { "type": "object", - "description": "This object is returned when an error occurs in the Maps API.", + "description": "This object is returned when an error occurs in the Azure Maps API.", "properties": { "code": { "type": "string", @@ -1012,7 +1012,7 @@ "message": { "type": "string", "readOnly": true, - "description": "If available, a human readable description of the error." + "description": "If available, a human-readable description of the error." }, "details": { "type": "array", diff --git a/specification/maps/data-plane/Microsoft.Maps/Render/preview/2.0/render.json b/specification/maps/data-plane/Microsoft.Maps/Render/preview/2.0/render.json index 3035ae4e980e..78c92b9c46e1 100644 --- a/specification/maps/data-plane/Microsoft.Maps/Render/preview/2.0/render.json +++ b/specification/maps/data-plane/Microsoft.Maps/Render/preview/2.0/render.json @@ -19,14 +19,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", "scopes": { "user_impersonation": "Impersonates a user's Azure Active Directory account." } }, "apiKeyQuery": { "type": "apiKey", - "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", "name": "subscription-key", "in": "query" } @@ -47,7 +47,7 @@ } }, "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory (Azure AD) bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Azure AD bearer token.", "schema": { "$ref": "#/definitions/ODataErrorResponse" }, @@ -80,7 +80,7 @@ "parameters": { "ClientId": { "name": "x-ms-client-id", - "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", "type": "string", "in": "header", "required": false, @@ -121,7 +121,8 @@ "microsoft.imagery", "microsoft.weather.radar.main", "microsoft.weather.infrared.main", - "microsoft.dem" + "microsoft.dem", + "microsoft.dem.contours" ], "x-ms-enum": { "name": "TilesetID", @@ -174,6 +175,10 @@ { "value": "microsoft.dem", "description": "Digital Elevation Model tiles. The tiles are in the GeoTIFF format with a single 32-bit floating point band. The tiles cover the whole landmass of Earth. Some small islands (e.g., atolls) might not be represented accurately.
    \n* The vertical unit for measurement of elevation height is meters. An elevation value of -32767.0 is used for points that have no data value, most often returned where there isn't landmass (i.e. water).
    \n* The horizontal reference datum is the World Geodetic System 1984 (WGS84-G1150) and the vertical reference datum is the Earth Gravitational Model 2008 (EGM2008).
    \n* Tiles are 258x258 pixel squares rather than the standard 256 x 256. This is done to allow for accurate interpolation of values at the tile edges. As such adjacent tiles overlap by 1 pixel along all edges.
    \n* Tile data comes from the [Airbus WorldDEM4Ortho product](https://www.intelligence-airbusds.com/worlddem-streaming/). Urban areas are approximately leveled down to ground level. All other areas are represented by the object surface level (e.g., trees).
    \n\nSupports zoom level 13 only. Format: raster (tiff)." + }, + { + "value": "microsoft.dem.contours", + "description": "Digital elevation contour line tiles. Compared to the microsoft.dem option, these tiles are in vector format and intended for visualization purpose. The tiles cover the whole landmass of Earth. Some small islands (e.g., atolls) might not be represented accurately.
    \n* The vertical unit for measurement of elevation height is meters.
    \n* The horizontal reference datum is the World Geodetic System 1984 (WGS84-G1150) and the vertical reference datum is the Earth Gravitational Model 2008 (EGM2008).
    \n* Tile data comes from the [Airbus WorldDEM4Ortho product](https://www.intelligence-airbusds.com/worlddem-streaming/). Urban areas are approximately leveled down to ground level. All other areas are represented by the object surface level (e.g., trees).
    \n\nSupports zoom levels 9 through 14. Format: vector (pbf)." } ] }, @@ -342,7 +347,7 @@ "definitions": { "ODataErrorResponse": { "type": "object", - "description": "This response object is returned when an error occurs in the Maps API.", + "description": "This response object is returned when an error occurs in the Azure Maps API.", "properties": { "error": { "$ref": "#/definitions/ODataError" @@ -351,7 +356,7 @@ }, "ODataError": { "type": "object", - "description": "This object is returned when an error occurs in the Maps API.", + "description": "This object is returned when an error occurs in the Azure Maps API.", "properties": { "code": { "type": "string", @@ -361,7 +366,7 @@ "message": { "type": "string", "readOnly": true, - "description": "If available, a human readable description of the error." + "description": "If available, a human-readable description of the error." }, "details": { "type": "array", diff --git a/specification/maps/data-plane/Microsoft.Maps/Render/preview/2.1/examples/GetMapAttributionV2.json b/specification/maps/data-plane/Microsoft.Maps/Render/preview/2.1/examples/GetMapAttributionV2.json new file mode 100644 index 000000000000..d677febc417d --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Render/preview/2.1/examples/GetMapAttributionV2.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2.1", + "tilesetId": "microsoft.base", + "zoom": 6, + "bounds": "-122.414162,47.579490,-122.247157,47.668372", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "copyrights": [ + "© 2021 TomTom" + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Render/preview/2.1/examples/GetMapTileV2.json b/specification/maps/data-plane/Microsoft.Maps/Render/preview/2.1/examples/GetMapTileV2.json new file mode 100644 index 000000000000..59137b0f97a9 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Render/preview/2.1/examples/GetMapTileV2.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2.1", + "tilesetId": "microsoft.base", + "zoom": 6, + "x": 10, + "y": 22, + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "headers": {}, + "body": "binary string image" + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Render/preview/2.1/examples/GetMapTilesetV2.json b/specification/maps/data-plane/Microsoft.Maps/Render/preview/2.1/examples/GetMapTilesetV2.json new file mode 100644 index 000000000000..ef4c8fe5b517 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Render/preview/2.1/examples/GetMapTilesetV2.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2.1", + "tilesetId": "microsoft.base", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "tilejson": "2.2.0", + "version": "1.0.0", + "attribution": "© 2021 TomTom", + "scheme": "xyz", + "tiles": [ + "https://atlas.microsoft.com/map/tile?api-version=2.0&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}" + ], + "minzoom": 0, + "maxzoom": 22, + "bounds": [ + -180, + -90, + 180, + 90 + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Render/preview/2.1/render.json b/specification/maps/data-plane/Microsoft.Maps/Render/preview/2.1/render.json new file mode 100644 index 000000000000..4117a291531c --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Render/preview/2.1/render.json @@ -0,0 +1,609 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Render Service", + "version": "2.1", + "description": "Azure Maps Render REST APIs" + }, + "host": "atlas.microsoft.com", + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json", + "application/xml" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "user_impersonation": "Impersonates a user's Azure Active Directory account." + } + }, + "apiKeyQuery": { + "type": "apiKey", + "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "query" + } + }, + "security": [ + { + "azure_auth": [] + }, + { + "apiKeyQuery": [] + } + ], + "responses": { + "400": { + "description": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "401": { + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + }, + "headers": { + "WWW-Authenticate": { + "type": "string", + "description": "Bearer realm=\"https://atlas.microsoft.com/\", error=\"invalid_token\", error_description=\"The access token expired\"" + } + } + }, + "403": { + "description": "Permission, capacity, or authentication issues.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "404": { + "description": "Not Found: the requested resource could not be found, but it may be available again in the future.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "500": { + "description": "An error occurred while processing the request. Please try again later.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + } + }, + "parameters": { + "ClientId": { + "name": "x-ms-client-id", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "type": "string", + "in": "header", + "required": false, + "x-ms-parameter-location": "client" + }, + "SubscriptionKey": { + "name": "subscription-key", + "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication.", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "client" + }, + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API. Current version is 2.1", + "type": "string", + "in": "query", + "required": true, + "default": "2.0", + "x-ms-parameter-location": "client" + }, + "TilesetId_rv2": { + "name": "tilesetId", + "description": "A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/en-us/rest/api/maps/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base.", + "type": "string", + "in": "query", + "required": true, + "enum": [ + "microsoft.base", + "microsoft.base.labels", + "microsoft.base.hybrid", + "microsoft.terra.main", + "microsoft.base.road", + "microsoft.base.darkgrey", + "microsoft.base.labels.road", + "microsoft.base.hybrid.road", + "microsoft.imagery", + "microsoft.weather.radar.main", + "microsoft.weather.infrared.main", + "microsoft.dem", + "microsoft.dem.contours" + ], + "x-ms-enum": { + "name": "TilesetID", + "modelAsString": true, + "values": [ + { + "value": "microsoft.base", + "description": "A base map is a standard map that displays roads, natural and artificial features along with the labels for those features in a vector tile.
    \n\nSupports zoom levels 0 through 22. Format: vector (pbf)." + }, + { + "value": "microsoft.base.labels", + "description": "Displays labels for roads, natural and artificial features in a vector tile.
    \n\nSupports zoom levels 0 through 22. Format: vector (pbf)." + }, + { + "value": "microsoft.base.hybrid", + "description": "Displays road, boundary and label data in a vector tile.
    \n\nSupports zoom levels 0 through 22. Format: vector (pbf)." + }, + { + "value": "microsoft.terra.main", + "description": "Shaded relief and terra layers.
    \n\nSupports zoom levels 0 through 6. Format: raster (png)." + }, + { + "value": "microsoft.base.road", + "description": "All layers with our main style.
    \n\nSupports zoom levels 0 through 22. Format: raster (png)." + }, + { + "value": "microsoft.base.darkgrey", + "description": "All layers with our dark grey style.
    \n\nSupports zoom levels 0 through 22. Format: raster (png)." + }, + { + "value": "microsoft.base.labels.road", + "description": "Label data in our main style.
    \n\nSupports zoom levels 0 through 22. Format: raster (png)." + }, + { + "value": "microsoft.base.hybrid.road", + "description": "Road, boundary and label data in our main style.
    \n\nSupports zoom levels 0 through 22. Format: raster (png)." + }, + { + "value": "microsoft.imagery", + "description": "A combination of satellite and aerial imagery. Only available in S1 pricing SKU.
    \n\nSupports zoom levels 1 through 19. Format: raster (jpeg)." + }, + { + "value": "microsoft.weather.radar.main", + "description": "Weather radar tiles. Latest weather radar images including areas of rain, snow, ice and mixed conditions. Please see [coverage information](https://aka.ms/AzureMapsWeatherCoverage) for Azure Maps Weather service. To learn more about the Radar data, please see [Weather concepts](https://aka.ms/AzureMapsWeatherConcepts).
    \n\nSupports zoom levels 0 through 15. Format: raster (png)." + }, + { + "value": "microsoft.weather.infrared.main", + "description": "Weather infrared tiles. Latest Infrared Satellite images shows clouds by their temperature. Please see [coverage information](https://aka.ms/AzureMapsWeatherCoverage) for Azure Maps Weather service. To learn more about the returned Satellite data, please see [Weather concepts](https://aka.ms/AzureMapsWeatherConcepts).
    \n\nSupports zoom levels 0 through 15. Format: raster (png)." + }, + { + "value": "microsoft.dem", + "description": "Digital Elevation Model tiles. The tiles are in the GeoTIFF format with a single 32-bit floating point band. The tiles cover the whole landmass of Earth. Some small islands (e.g., atolls) might not be represented accurately.
    \n* The vertical unit for measurement of elevation height is meters. An elevation value of -32767.0 is used for points that have no data value, most often returned where there isn't landmass (i.e. water).
    \n* The horizontal reference datum is the World Geodetic System 1984 (WGS84-G1150) and the vertical reference datum is the Earth Gravitational Model 2008 (EGM2008).
    \n* Tiles are 258x258 pixel squares rather than the standard 256 x 256. This is done to allow for accurate interpolation of values at the tile edges. As such adjacent tiles overlap by 1 pixel along all edges.
    \n* Tile data comes from the [Airbus WorldDEM4Ortho product](https://www.intelligence-airbusds.com/worlddem-streaming/). Urban areas are approximately leveled down to ground level. All other areas are represented by the object surface level (e.g., trees).
    \n\nSupports zoom level 13 only. Format: raster (tiff)." + }, + { + "value": "microsoft.dem.contours", + "description": "Digital elevation contour line tiles. Compared to the microsoft.dem option, these tiles are in vector format and intended for visualization purpose. The tiles cover the whole landmass of Earth. Some small islands (e.g., atolls) might not be represented accurately.
    \n* The vertical unit for measurement of elevation height is meters.
    \n* The horizontal reference datum is the World Geodetic System 1984 (WGS84-G1150) and the vertical reference datum is the Earth Gravitational Model 2008 (EGM2008).
    \n* Tile data comes from the [Airbus WorldDEM4Ortho product](https://www.intelligence-airbusds.com/worlddem-streaming/). Urban areas are approximately leveled down to ground level. All other areas are represented by the object surface level (e.g., trees).
    \n\nSupports zoom levels 9 through 14. Format: vector (pbf)." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "xTileIndex": { + "name": "x", + "x-ms-client-name": "xTileIndex", + "in": "query", + "description": "X coordinate of the tile on zoom grid. Value must be in the range [0, 2`zoom` -1].\n\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.", + "required": true, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "yTileIndex": { + "name": "y", + "x-ms-client-name": "yTileIndex", + "in": "query", + "description": "Y coordinate of the tile on zoom grid. Value must be in the range [0, 2`zoom` -1].\n\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.", + "required": true, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "MapTileV2Zoom": { + "name": "zoom", + "in": "query", + "description": "Zoom level for the desired tile. Please find TilesetID list below for more details on supported zoom level for each tilesetId.
    \n\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.", + "required": true, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "Language": { + "name": "language", + "in": "query", + "description": "Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used.\n\nPlease refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Text": { + "name": "text", + "in": "query", + "description": "Yes/no value to exclude textual data from response. Only images and country names will be in response.", + "required": false, + "type": "string", + "enum": [ + "yes", + "no" + ], + "default": "yes", + "x-ms-parameter-location": "method" + }, + "View": { + "name": "view", + "in": "query", + "description": "The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.\n\nPlease refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/map/tile": { + "get": { + "description": "**Applies to**: S0 and S1 pricing tiers.\n\nThe Get Map Tiles API allows users to request map tiles in vector or raster formats typically to be integrated into a map control or SDK. Some example tiles that can be requested are Azure Maps road tiles, real-time Weather Radar tiles or the map tiles created using [Azure Maps Creator](https://aka.ms/amcreator). By default, Azure Maps uses vector tiles for its web map control (Web SDK) and Android SDK.", + "operationId": "RenderV2_GetMapTile", + "x-ms-examples": { + "GetMapTile": { + "$ref": "./examples/GetMapTileV2.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TilesetId_rv2" + }, + { + "$ref": "#/parameters/MapTileV2Zoom" + }, + { + "$ref": "#/parameters/xTileIndex" + }, + { + "$ref": "#/parameters/yTileIndex" + }, + { + "name": "timeStamp", + "in": "query", + "description": "The desired date and time of the requested tile. This parameter must be specified in the standard date-time format (e.g. 2019-11-14T16:03:00-08:00), as defined by [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). This parameter is only supported when tilesetId parameter is set to one of the values below.\n \n* microsoft.weather.infrared.main: We provide tiles up to 3 hours in the past. Tiles are available in 10-minute intervals. We round the timeStamp value to the nearest 10-minute time frame.\n* microsoft.weather.radar.main: We provide tiles up to 1.5 hours in the past and up to 2 hours in the future. Tiles are available in 5-minute intervals. We round the timeStamp value to the nearest 5-minute time frame.", + "required": false, + "type": "string" + }, + { + "name": "tileSize", + "in": "query", + "description": "The size of the returned map tile in pixels.", + "required": false, + "type": "string", + "default": "256", + "enum": [ + "256", + "512" + ], + "x-ms-enum": { + "name": "TileSize", + "modelAsString": true, + "values": [ + { + "value": "256", + "description": "Return a 256 by 256 pixel tile. Available for all tilesetIds except for\n* microsoft.terra.main" + }, + { + "value": "512", + "description": "Return a 512 by 512 pixel tile. Available for all tilesetIds except for \n* microsoft.weather.radar.main\n* microsoft.weather.infrared.main\n* microsoft.base.hybrid\n* microsoft.dem\n* microsoft.imagery" + } + ] + } + }, + { + "$ref": "#/parameters/Language" + }, + { + "$ref": "#/parameters/View" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MapTileResultv2" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/map/tileset": { + "get": { + "description": "**Applies to**: S0 and S1 pricing tiers.\n\nThe Get Map Tileset API allows users to request metadata for a tileset.", + "operationId": "RenderV2_GetMapTileset", + "x-ms-examples": { + "GetMapTile": { + "$ref": "./examples/GetMapTilesetV2.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TilesetId_rv2" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MapTilesetResultV2" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/map/attribution": { + "get": { + "description": "**Applies to**: S0 and S1 pricing tiers.\n\nThe Get Map Attribution API allows users to request map copyright attribution information for a section of a tileset.", + "operationId": "RenderV2_GetMapAttribution", + "x-ms-examples": { + "GetMapTile": { + "$ref": "./examples/GetMapAttributionV2.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TilesetId_rv2" + }, + { + "$ref": "#/parameters/MapTileV2Zoom" + }, + { + "name": "bounds", + "in": "query", + "description": "The string that represents the rectangular area of a bounding box. The bounds parameter is defined by the 4 bounding box coordinates, with WGS84 longitude and latitude of the southwest corner followed by WGS84 longitude and latitude of the northeast corner. The string is presented in the following format: `[SouthwestCorner_Longitude, SouthwestCorner_Latitude, NortheastCorner_Longitude, NortheastCorner_Latitude]`.", + "required": true, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MapAttributionResultV2" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + } + }, + "definitions": { + "ODataErrorResponse": { + "type": "object", + "description": "This response object is returned when an error occurs in the Maps API.", + "properties": { + "error": { + "$ref": "#/definitions/ODataError" + } + } + }, + "ODataError": { + "type": "object", + "description": "This object is returned when an error occurs in the Maps API.", + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "The ODataError code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "If available, a human readable description of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ODataError" + } + }, + "target": { + "type": "string", + "readOnly": true, + "description": "If available, the target causing the error." + } + } + }, + "MapTileResultv2": { + "description": "The tile returned from a successful API call.", + "type": "string", + "format": "binary", + "readOnly": true + }, + "MapTilesetResultV2": { + "description": "Metadata for a tileset in the TileJSON format.", + "type": "object", + "readOnly": true, + "properties": { + "tilejson": { + "type": "string", + "pattern": "\\d+\\.\\d+\\.\\d+\\w?[\\w\\d]*", + "description": "Version of the TileJSON spec." + }, + "name": { + "type": "string", + "description": "Name of the tileset." + }, + "description": { + "type": "string", + "description": "Text description of the tileset." + }, + "version": { + "type": "string", + "pattern": "\\d+\\.\\d+\\.\\d+\\w?[\\w\\d]*", + "description": "A semver.org style version number for the tiles contained within the tileset." + }, + "attribution": { + "type": "string", + "description": "Copyright attribution to be displayed on the map." + }, + "template": { + "type": "string", + "description": "A mustache template to be used to format data from grids for interaction." + }, + "legend": { + "type": "string", + "description": "A legend to be displayed with the map." + }, + "scheme": { + "type": "string", + "description": "Default: \"xyz\". Either \"xyz\" or \"tms\". Influences the y direction of the tile coordinates." + }, + "tiles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of tile endpoints." + }, + "grids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of interactivity endpoints." + }, + "data": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of data files in GeoJSON format." + }, + "minzoom": { + "minimum": 0, + "maximum": 30, + "type": "integer", + "description": "The minimum zoom level." + }, + "maxzoom": { + "minimum": 0, + "maximum": 30, + "type": "integer", + "description": "The maximum zoom level." + }, + "bounds": { + "type": "array", + "items": { + "type": "number" + }, + "description": "The WGS84 bounds of the tileset." + }, + "center": { + "type": "array", + "items": { + "type": "number" + }, + "description": "The default location of the tileset in the form [longitude, latitude, zoom]." + } + } + }, + "MapAttributionResultV2": { + "description": "Copyright attribution for the requested section of a tileset.", + "type": "object", + "readOnly": true, + "properties": { + "copyrights": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of copyright strings." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Route/preview/1.0/route.json b/specification/maps/data-plane/Microsoft.Maps/Route/preview/1.0/route.json index 2a974720a1c5..941c0bc0de55 100644 --- a/specification/maps/data-plane/Microsoft.Maps/Route/preview/1.0/route.json +++ b/specification/maps/data-plane/Microsoft.Maps/Route/preview/1.0/route.json @@ -19,14 +19,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", "scopes": { "user_impersonation": "Impersonates a user's Azure Active Directory account." } }, "apiKeyQuery": { "type": "apiKey", - "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", "name": "subscription-key", "in": "query" } @@ -56,7 +56,7 @@ } }, "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory (Azure AD) bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Azure AD bearer token.", "schema": { "$ref": "#/definitions/ODataErrorResponse" }, @@ -98,7 +98,7 @@ "parameters": { "ClientId": { "name": "x-ms-client-id", - "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", "type": "string", "in": "header", "required": false, @@ -1608,7 +1608,7 @@ "/route/directions/batch/{format}": { "post": { "x-publish": true, - "description": "**Route Directions Batch API**\n\n\n**Applies to**: S1 pricing tier.\n\n\n\nThe Route Directions Batch API sends batches of queries to [Route Directions API](https://docs.microsoft.com/en-us/rest/api/maps/route/getroutedirections) using just a single API call. You can call Route Directions Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex route requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **700** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running request. Here's a typical sequence of operations:\n1. Client sends a Route Directions Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n``` GET https://atlas.microsoft.com/batch/{batch-id}?api-version=1.0 ```\nNote:- Please remember to add AUTH information (subscription-key/azure_auth - See [Security](#security)) to the _status URI_ before running it.
    \n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _route directions_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 3 _route directions_ queries:\n\n\n```json\n{\n \"batchItems\": [\n { \"query\": \"?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false\" },\n { \"query\": \"?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest\" },\n { \"query\": \"?query=48.923159,-122.557362:32.621279,-116.840362\" }\n ]\n}\n```\n\nA _route directions_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _route directions_ [URI parameters](https://docs.microsoft.com/en-us/rest/api/maps/route/getroutedirections#uri-parameters). The string values in the _route directions_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **700** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n \n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`RouteDirectionsResponse`](https://docs.microsoft.com/en-us/rest/api/maps/route/getroutedirections#routedirectionsresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 1,\n \"totalRequests\": 2\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\": {\n \"routes\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"legs\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"points\": [\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.34892\n },\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.3485\n },\n {\n \"latitude\": 47.62095,\n \"longitude\": -122.3476\n }\n ]\n }\n ],\n \"sections\": [\n {\n \"startPointIndex\": 0,\n \"endPointIndex\": 40,\n \"sectionType\": \"TRAVEL_MODE\",\n \"travelMode\": \"bicycle\"\n }\n ]\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "description": "**Route Directions Batch API**\n\n\n**Applies to**: S1 pricing tier.\n\n\n\nThe Route Directions Batch API sends batches of queries to [Route Directions API](https://docs.microsoft.com/en-us/rest/api/maps/route/getroutedirections) using just a single API call. You can call Route Directions Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex route requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **700** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running request. Here's a typical sequence of operations:\n1. Client sends a Route Directions Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n``` GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0 ```\nNote:- Please remember to add AUTH information (subscription-key/azure_auth - See [Security](#security)) to the _status URI_ before running it.
    \n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _route directions_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 3 _route directions_ queries:\n\n\n```json\n{\n \"batchItems\": [\n { \"query\": \"?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false\" },\n { \"query\": \"?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest\" },\n { \"query\": \"?query=48.923159,-122.557362:32.621279,-116.840362\" }\n ]\n}\n```\n\nA _route directions_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _route directions_ [URI parameters](https://docs.microsoft.com/en-us/rest/api/maps/route/getroutedirections#uri-parameters). The string values in the _route directions_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **700** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n \n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`RouteDirectionsResponse`](https://docs.microsoft.com/en-us/rest/api/maps/route/getroutedirections#routedirectionsresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 1,\n \"totalRequests\": 2\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\": {\n \"routes\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"legs\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"points\": [\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.34892\n },\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.3485\n },\n {\n \"latitude\": 47.62095,\n \"longitude\": -122.3476\n }\n ]\n }\n ],\n \"sections\": [\n {\n \"startPointIndex\": 0,\n \"endPointIndex\": 40,\n \"sectionType\": \"TRAVEL_MODE\",\n \"travelMode\": \"bicycle\"\n }\n ]\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", "operationId": "Route_PostRouteDirectionsBatch", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -1677,7 +1677,7 @@ "definitions": { "ODataErrorResponse": { "type": "object", - "description": "This response object is returned when an error occurs in the Maps API.", + "description": "This response object is returned when an error occurs in the Azure Maps API.", "properties": { "error": { "$ref": "#/definitions/ODataError" @@ -1686,7 +1686,7 @@ }, "ODataError": { "type": "object", - "description": "This object is returned when an error occurs in the Maps API.", + "description": "This object is returned when an error occurs in the Azure Maps API.", "properties": { "code": { "type": "string", @@ -1696,7 +1696,7 @@ "message": { "type": "string", "readOnly": true, - "description": "If available, a human readable description of the error." + "description": "If available, a human-readable description of the error." }, "details": { "type": "array", diff --git a/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/search.json b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/search.json index 55803cc5462c..b864387d1263 100644 --- a/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/search.json +++ b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/search.json @@ -19,14 +19,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", "scopes": { "user_impersonation": "Impersonates a user's Azure Active Directory account." } }, "apiKeyQuery": { "type": "apiKey", - "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", "name": "subscription-key", "in": "query" } @@ -56,7 +56,7 @@ } }, "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory (Azure AD) bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Azure AD bearer token.", "schema": { "$ref": "#/definitions/ODataErrorResponse" }, @@ -98,7 +98,7 @@ "parameters": { "ClientId": { "name": "x-ms-client-id", - "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", "type": "string", "in": "header", "required": false, @@ -1696,7 +1696,7 @@ "/search/fuzzy/batch/{format}": { "post": { "x-publish": true, - "description": "**Search Fuzzy Batch API**\n\n\n**Applies to**: S1 pricing tier.\n\n\n\nThe Search Address Batch API sends batches of queries to [Search Fuzzy API](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchfuzzy) using just a single API call. You can call Search Address Fuzzy Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running request. Here's a typical sequence of operations:\n1. Client sends a Search Address Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search fuzzy_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search fuzzy_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5\"},\n {\"query\": \"?query=Statue Of Liberty&limit=2\"},\n {\"query\": \"?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000\"},\n {\"query\": \"?query=Space Needle\"},\n {\"query\": \"?query=pizza&limit=10\"}\n ]\n}\n```\n\nA _search fuzzy_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search fuzzy_ [URI parameters](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchfuzzy#uri-parameters). The string values in the _search fuzzy_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchFuzzyResponse`](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchfuzzy#searchfuzzyresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"atm\"\n },\n \"results\": [\n {\n \"type\": \"POI\",\n \"poi\": {\n \"name\": \"ATM at Wells Fargo\"\n },\n \"address\": {\n \"country\": \"United States Of America\",\n \"freeformAddress\": \"3240 157th Ave NE, Redmond, WA 98052\"\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"statue of liberty\"\n },\n \"results\": [\n {\n \"type\": \"POI\",\n \"poi\": {\n \"name\": \"Statue of Liberty\"\n },\n \"address\": {\n \"country\": \"United States Of America\",\n \"freeformAddress\": \"New York, NY 10004\"\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "description": "**Search Fuzzy Batch API**\n\n\n**Applies to**: S1 pricing tier.\n\n\n\nThe Search Address Batch API sends batches of queries to [Search Fuzzy API](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchfuzzy) using just a single API call. You can call Search Address Fuzzy Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running request. Here's a typical sequence of operations:\n1. Client sends a Search Address Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search fuzzy_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search fuzzy_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5\"},\n {\"query\": \"?query=Statue Of Liberty&limit=2\"},\n {\"query\": \"?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000\"},\n {\"query\": \"?query=Space Needle\"},\n {\"query\": \"?query=pizza&limit=10\"}\n ]\n}\n```\n\nA _search fuzzy_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search fuzzy_ [URI parameters](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchfuzzy#uri-parameters). The string values in the _search fuzzy_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchFuzzyResponse`](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchfuzzy#searchfuzzyresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"atm\"\n },\n \"results\": [\n {\n \"type\": \"POI\",\n \"poi\": {\n \"name\": \"ATM at Wells Fargo\"\n },\n \"address\": {\n \"country\": \"United States Of America\",\n \"freeformAddress\": \"3240 157th Ave NE, Redmond, WA 98052\"\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"statue of liberty\"\n },\n \"results\": [\n {\n \"type\": \"POI\",\n \"poi\": {\n \"name\": \"Statue of Liberty\"\n },\n \"address\": {\n \"country\": \"United States Of America\",\n \"freeformAddress\": \"New York, NY 10004\"\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", "operationId": "Search_PostSearchFuzzyBatch", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -1764,7 +1764,7 @@ "/search/address/batch/{format}": { "post": { "x-publish": true, - "description": "**Search Address Batch API**\n\n\n**Applies to**: S1 pricing tier.\n\n\n\nThe Search Address Batch API sends batches of queries to [Search Address API](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddress) using just a single API call. You can call Search Address Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running request. Here's a typical sequence of operations:\n1. Client sends a Search Address Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search address_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search address_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=400 Broad St, Seattle, WA 98109&limit=3\"},\n {\"query\": \"?query=One, Microsoft Way, Redmond, WA 98052&limit=3\"},\n {\"query\": \"?query=350 5th Ave, New York, NY 10118&limit=1\"},\n {\"query\": \"?query=Pike Pl, Seattle, WA 98101&lat=47.610970&lon=-122.342469&radius=1000\"},\n {\"query\": \"?query=Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France&limit=1\"}\n ]\n}\n```\n\nA _search address_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search address_ [URI parameters](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddress#uri-parameters). The string values in the _search address_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchAddressResponse`](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddress#searchaddressresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"one microsoft way redmond wa 98052\"\n },\n \"results\": [\n {\n \"position\": {\n \"lat\": 47.63989,\n \"lon\": -122.12509\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"pike pl seattle wa 98101\"\n },\n \"results\": [\n {\n \"position\": {\n \"lat\": 47.60963,\n \"lon\": -122.34215\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "description": "**Search Address Batch API**\n\n\n**Applies to**: S1 pricing tier.\n\n\n\nThe Search Address Batch API sends batches of queries to [Search Address API](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddress) using just a single API call. You can call Search Address Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running request. Here's a typical sequence of operations:\n1. Client sends a Search Address Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search address_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search address_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=400 Broad St, Seattle, WA 98109&limit=3\"},\n {\"query\": \"?query=One, Microsoft Way, Redmond, WA 98052&limit=3\"},\n {\"query\": \"?query=350 5th Ave, New York, NY 10118&limit=1\"},\n {\"query\": \"?query=Pike Pl, Seattle, WA 98101&lat=47.610970&lon=-122.342469&radius=1000\"},\n {\"query\": \"?query=Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France&limit=1\"}\n ]\n}\n```\n\nA _search address_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search address_ [URI parameters](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddress#uri-parameters). The string values in the _search address_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchAddressResponse`](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddress#searchaddressresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"one microsoft way redmond wa 98052\"\n },\n \"results\": [\n {\n \"position\": {\n \"lat\": 47.63989,\n \"lon\": -122.12509\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"pike pl seattle wa 98101\"\n },\n \"results\": [\n {\n \"position\": {\n \"lat\": 47.60963,\n \"lon\": -122.34215\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", "operationId": "Search_PostSearchAddressBatch", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -1832,7 +1832,7 @@ "/search/address/reverse/batch/{format}": { "post": { "x-publish": true, - "description": "**Search Address Reverse Batch API**\n\n\n**Applies to**: S1 pricing tier.\n\n\n\nThe Search Address Batch API sends batches of queries to [Search Address Reverse API](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddressreverse) using just a single API call. You can call Search Address Reverse Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/address/reverse/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running request. Here's a typical sequence of operations:\n1. Client sends a Search Address Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search address reverse_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search address reverse_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=48.858561,2.294911\"},\n {\"query\": \"?query=47.639765,-122.127896&radius=5000&limit=2\"},\n {\"query\": \"?query=47.621028,-122.348170\"},\n {\"query\": \"?query=43.722990,10.396695\"},\n {\"query\": \"?query=40.750958,-73.982336\"}\n ]\n}\n```\n\nA _search address reverse_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search address reverse_ [URI parameters](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddressreverse#uri-parameters). The string values in the _search address reverse_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchAddressReverseResponse`](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddressreverse#searchaddressreverseresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"queryTime\": 11\n },\n \"addresses\": [\n {\n \"address\": {\n \"country\": \"France\",\n \"freeformAddress\": \"Avenue Anatole France, 75007 Paris\"\n },\n \"position\": \"48.858490,2.294820\"\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"queryTime\": 1\n },\n \"addresses\": [\n {\n \"address\": {\n \"country\": \"United States of America\",\n \"freeformAddress\": \"157th Pl NE, Redmond WA 98052\"\n },\n \"position\": \"47.640470,-122.129430\"\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "description": "**Search Address Reverse Batch API**\n\n\n**Applies to**: S1 pricing tier.\n\n\n\nThe Search Address Batch API sends batches of queries to [Search Address Reverse API](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddressreverse) using just a single API call. You can call Search Address Reverse Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/address/reverse/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running request. Here's a typical sequence of operations:\n1. Client sends a Search Address Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search address reverse_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search address reverse_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=48.858561,2.294911\"},\n {\"query\": \"?query=47.639765,-122.127896&radius=5000&limit=2\"},\n {\"query\": \"?query=47.621028,-122.348170\"},\n {\"query\": \"?query=43.722990,10.396695\"},\n {\"query\": \"?query=40.750958,-73.982336\"}\n ]\n}\n```\n\nA _search address reverse_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search address reverse_ [URI parameters](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddressreverse#uri-parameters). The string values in the _search address reverse_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchAddressReverseResponse`](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddressreverse#searchaddressreverseresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"queryTime\": 11\n },\n \"addresses\": [\n {\n \"address\": {\n \"country\": \"France\",\n \"freeformAddress\": \"Avenue Anatole France, 75007 Paris\"\n },\n \"position\": \"48.858490,2.294820\"\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"queryTime\": 1\n },\n \"addresses\": [\n {\n \"address\": {\n \"country\": \"United States of America\",\n \"freeformAddress\": \"157th Pl NE, Redmond WA 98052\"\n },\n \"position\": \"47.640470,-122.129430\"\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", "operationId": "Search_PostSearchAddressReverseBatch", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -1901,7 +1901,7 @@ "definitions": { "ODataErrorResponse": { "type": "object", - "description": "This response object is returned when an error occurs in the Maps API.", + "description": "This response object is returned when an error occurs in the Azure Maps API.", "properties": { "error": { "$ref": "#/definitions/ODataError" @@ -1910,7 +1910,7 @@ }, "ODataError": { "type": "object", - "description": "This object is returned when an error occurs in the Maps API.", + "description": "This object is returned when an error occurs in the Azure Maps API.", "properties": { "code": { "type": "string", @@ -1920,7 +1920,7 @@ "message": { "type": "string", "readOnly": true, - "description": "If available, a human readable description of the error." + "description": "If available, a human-readable description of the error." }, "details": { "type": "array", diff --git a/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/spatial.json b/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/spatial.json index 6b3c8366926e..d72f6961b1ba 100644 --- a/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/spatial.json +++ b/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/spatial.json @@ -19,14 +19,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", "scopes": { "user_impersonation": "Impersonates a user's Azure Active Directory account." } }, "apiKeyQuery": { "type": "apiKey", - "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", "name": "subscription-key", "in": "query" } @@ -56,7 +56,7 @@ } }, "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory (Azure AD) bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Azure AD bearer token.", "schema": { "$ref": "#/definitions/ODataErrorResponse" }, @@ -89,7 +89,7 @@ "parameters": { "ClientId": { "name": "x-ms-client-id", - "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", "type": "string", "in": "header", "required": false, @@ -940,7 +940,7 @@ "definitions": { "ODataErrorResponse": { "type": "object", - "description": "This response object is returned when an error occurs in the Maps API.", + "description": "This response object is returned when an error occurs in the Azure Maps API.", "properties": { "error": { "$ref": "#/definitions/ODataError" @@ -949,7 +949,7 @@ }, "ODataError": { "type": "object", - "description": "This object is returned when an error occurs in the Maps API.", + "description": "This object is returned when an error occurs in the Azure Maps API.", "properties": { "code": { "type": "string", @@ -959,7 +959,7 @@ "message": { "type": "string", "readOnly": true, - "description": "If available, a human readable description of the error." + "description": "If available, a human-readable description of the error." }, "details": { "type": "array", @@ -1015,6 +1015,7 @@ "$ref": "#/definitions/GeoJSONGeometry" }, "properties": { + "x-ms-client-flatten": true, "description": "Properties can contain any additional metadata about the `Feature`. Value can be any JSON object or a JSON null value", "type": "object" } diff --git a/specification/maps/data-plane/Microsoft.Maps/Tileset/preview/1.0/tileset.json b/specification/maps/data-plane/Microsoft.Maps/Tileset/preview/1.0/tileset.json index 804c435ff954..f194ce77bb42 100644 --- a/specification/maps/data-plane/Microsoft.Maps/Tileset/preview/1.0/tileset.json +++ b/specification/maps/data-plane/Microsoft.Maps/Tileset/preview/1.0/tileset.json @@ -25,14 +25,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", "scopes": { "user_impersonation": "Impersonates a user's Azure Active Directory account." } }, "apiKeyQuery": { "type": "apiKey", - "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", "name": "subscription-key", "in": "query" } @@ -53,7 +53,7 @@ } }, "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory (Azure AD) bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Azure AD bearer token.", "schema": { "$ref": "#/definitions/ODataErrorResponse" }, @@ -134,7 +134,7 @@ }, "ClientId": { "name": "x-ms-client-id", - "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", "type": "string", "in": "header", "required": false, @@ -207,7 +207,7 @@ "/tileset/create/vector": { "post": { "x-publish": true, - "description": "**Tileset Create API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API \nand SDK. [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe Tileset Create API allows the caller to create a tileset from a dataset. A tileset contains a set of tiles that can be consumed \nfrom the [Get Map Tile](/rest/api/maps/render/getmaptile) to retrieve custom tiles. To make a dataset, use the \n[DataSet Create API](/rest/api/maps/dataset/createpreview).\n\n## Submit Create Request\n\nTo create your tileset you will make a `POST` request with an empty body. The `datasetId` query parameter will be \nused as the source of the tileset data.\n\nThe Create Tileset API is a \n[long-running request](https://aka.ms/am-creator-lrt).", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Tileset Create API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API \nand SDK. [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe Tileset Create API allows the caller to create a tileset from a dataset. A tileset contains a set of tiles that can be consumed \nfrom the [Get Map Tile](/rest/api/maps/render/getmaptile) to retrieve custom tiles. To make a dataset, use the \n[DataSet Create API](/rest/api/maps/dataset/createpreview).\n\n## Submit Create Request\n\nTo create your tileset you will make a `POST` request with an empty body. The `datasetId` query parameter will be \nused as the source of the tileset data.\n\nThe Create Tileset API is a \n[long-running request](https://aka.ms/am-creator-lrt).", "operationId": "Tileset_CreatePreview", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -263,7 +263,7 @@ "/tileset": { "get": { "x-publish": true, - "description": "**Tileset List API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
    \n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\nThis API allows the caller to fetch a list of all tilesets created. \n
    ", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Tileset List API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
    \n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\nThis API allows the caller to fetch a list of all tilesets created. \n
    ", "operationId": "Tileset_ListPreview", "x-ms-examples": { "Get a list of all tilesets": { @@ -309,7 +309,7 @@ "/tileset/{tilesetId}": { "delete": { "x-publish": true, - "description": "**Tileset Delete API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
    \n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\nThis API allows the caller to delete a created tileset.
    \nYou can use this API if a tileset is no longer needed. \n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `tilesetId` of the tileset to delete.
    \n\n#### Delete request \"Successful\"\n\nThe Tileset Delete API returns a HTTP `204 No Content` response with an empty body, if the tileset was deleted successfully.
    \n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the tileset with the passed-in `tilesetId` is not found. \n\nHere is a sample error response:\n\n
    \n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - Tileset Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\n**Tileset Delete API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n
    \n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\nThis API allows the caller to delete a created tileset.
    \nYou can use this API if a tileset is no longer needed. \n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `tilesetId` of the tileset to delete.
    \n\n#### Delete request \"Successful\"\n\nThe Tileset Delete API returns a HTTP `204 No Content` response with an empty body, if the tileset was deleted successfully.
    \n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the tileset with the passed-in `tilesetId` is not found. \n\nHere is a sample error response:\n\n
    \n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - Tileset Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", "operationId": "Tileset_DeletePreview", "x-ms-examples": { "Delete a created tileset": { @@ -359,7 +359,7 @@ "definitions": { "ODataErrorResponse": { "type": "object", - "description": "This response object is returned when an error occurs in the Maps API.", + "description": "This response object is returned when an error occurs in the Azure Maps API.", "properties": { "error": { "$ref": "#/definitions/ODataError" @@ -368,7 +368,7 @@ }, "ODataError": { "type": "object", - "description": "This object is returned when an error occurs in the Maps API.", + "description": "This object is returned when an error occurs in the Azure Maps API.", "properties": { "code": { "type": "string", @@ -378,7 +378,7 @@ "message": { "type": "string", "readOnly": true, - "description": "If available, a human readable description of the error." + "description": "If available, a human-readable description of the error." }, "details": { "type": "array", diff --git a/specification/maps/data-plane/Microsoft.Maps/Tileset/preview/2.0/tileset.json b/specification/maps/data-plane/Microsoft.Maps/Tileset/preview/2.0/tileset.json index 5c44d0fe5382..526919d98048 100644 --- a/specification/maps/data-plane/Microsoft.Maps/Tileset/preview/2.0/tileset.json +++ b/specification/maps/data-plane/Microsoft.Maps/Tileset/preview/2.0/tileset.json @@ -25,14 +25,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", "scopes": { "user_impersonation": "Impersonates a user's Azure Active Directory account." } }, "apiKeyQuery": { "type": "apiKey", - "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", "name": "subscription-key", "in": "query" } @@ -53,7 +53,7 @@ } }, "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory (Azure AD) bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Azure AD bearer token.", "schema": { "$ref": "#/definitions/ODataErrorResponse" }, @@ -134,7 +134,7 @@ }, "ClientId": { "name": "x-ms-client-id", - "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", "type": "string", "in": "header", "required": false, @@ -180,7 +180,7 @@ }, "DatasetIdQuery": { "name": "datasetId", - "description": "The unique `datasetId` that the tileset create API uses to retrieve features to generate tiles. The `datasetId` must have been obtained from a successful [Dataset Create API](/en-us/rest/api/maps/dataset/createpreview) call.", + "description": "The unique `datasetId` that the tileset create API uses to retrieve features to generate tiles. The `datasetId` must have been obtained from a successful [Dataset Create API](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create) call.", "type": "string", "in": "query", "required": true, @@ -206,7 +206,7 @@ "name": "operationId", "type": "string", "in": "path", - "description": "The ID to query the status for the dataset create/import request.", + "description": "The ID to query the status for the tileset create/import request.", "required": true, "x-ms-parameter-location": "method" } @@ -435,7 +435,7 @@ "definitions": { "ODataErrorResponse": { "type": "object", - "description": "This response object is returned when an error occurs in the Maps API.", + "description": "This response object is returned when an error occurs in the Azure Maps API.", "properties": { "error": { "$ref": "#/definitions/ODataError" @@ -444,7 +444,7 @@ }, "ODataError": { "type": "object", - "description": "This object is returned when an error occurs in the Maps API.", + "description": "This object is returned when an error occurs in the Azure Maps API.", "properties": { "code": { "type": "string", @@ -454,7 +454,7 @@ "message": { "type": "string", "readOnly": true, - "description": "If available, a human readable description of the error." + "description": "If available, a human-readable description of the error." }, "details": { "type": "array", diff --git a/specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/timezone.json b/specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/timezone.json index 057164c29159..278fe7eb72ca 100644 --- a/specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/timezone.json +++ b/specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/timezone.json @@ -19,14 +19,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", "scopes": { "user_impersonation": "Impersonates a user's Azure Active Directory account." } }, "apiKeyQuery": { "type": "apiKey", - "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", "name": "subscription-key", "in": "query" } @@ -47,7 +47,7 @@ } }, "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory (Azure AD) bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Azure AD bearer token.", "schema": { "$ref": "#/definitions/ODataErrorResponse" }, @@ -80,7 +80,7 @@ "parameters": { "ClientId": { "name": "x-ms-client-id", - "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", "type": "string", "in": "header", "required": false, @@ -571,7 +571,7 @@ "definitions": { "ODataErrorResponse": { "type": "object", - "description": "This response object is returned when an error occurs in the Maps API.", + "description": "This response object is returned when an error occurs in the Azure Maps API.", "properties": { "error": { "$ref": "#/definitions/ODataError" @@ -580,7 +580,7 @@ }, "ODataError": { "type": "object", - "description": "This object is returned when an error occurs in the Maps API.", + "description": "This object is returned when an error occurs in the Azure Maps API.", "properties": { "code": { "type": "string", @@ -590,7 +590,7 @@ "message": { "type": "string", "readOnly": true, - "description": "If available, a human readable description of the error." + "description": "If available, a human-readable description of the error." }, "details": { "type": "array", diff --git a/specification/maps/data-plane/Microsoft.Maps/Traffic/preview/1.0/traffic.json b/specification/maps/data-plane/Microsoft.Maps/Traffic/preview/1.0/traffic.json index 627c49762551..380c7b6caeee 100644 --- a/specification/maps/data-plane/Microsoft.Maps/Traffic/preview/1.0/traffic.json +++ b/specification/maps/data-plane/Microsoft.Maps/Traffic/preview/1.0/traffic.json @@ -19,14 +19,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", "scopes": { "user_impersonation": "Impersonates a user's Azure Active Directory account." } }, "apiKeyQuery": { "type": "apiKey", - "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", "name": "subscription-key", "in": "query" } @@ -56,7 +56,7 @@ } }, "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory (Azure AD) bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Azure AD bearer token.", "schema": { "$ref": "#/definitions/ODataErrorResponse" }, @@ -89,7 +89,7 @@ "parameters": { "ClientId": { "name": "x-ms-client-id", - "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", "type": "string", "in": "header", "required": false, @@ -840,7 +840,7 @@ "definitions": { "ODataErrorResponse": { "type": "object", - "description": "This response object is returned when an error occurs in the Maps API.", + "description": "This response object is returned when an error occurs in the Azure Maps API.", "properties": { "error": { "$ref": "#/definitions/ODataError" @@ -849,7 +849,7 @@ }, "ODataError": { "type": "object", - "description": "This object is returned when an error occurs in the Maps API.", + "description": "This object is returned when an error occurs in the Azure Maps API.", "properties": { "code": { "type": "string", @@ -859,7 +859,7 @@ "message": { "type": "string", "readOnly": true, - "description": "If available, a human readable description of the error." + "description": "If available, a human-readable description of the error." }, "details": { "type": "array", diff --git a/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/wfs.json b/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/wfs.json index b3f019323d54..dfb4d2b6d180 100644 --- a/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/wfs.json +++ b/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/wfs.json @@ -26,14 +26,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", "scopes": { "user_impersonation": "Impersonates a user's Azure Active Directory account." } }, "apiKeyQuery": { "type": "apiKey", - "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", "name": "subscription-key", "in": "query" } @@ -63,7 +63,7 @@ } }, "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory (Azure AD) bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Azure AD bearer token.", "schema": { "$ref": "#/definitions/ODataErrorResponse" }, @@ -123,7 +123,7 @@ }, "ClientId": { "name": "x-ms-client-id", - "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", "type": "string", "in": "header", "required": false, @@ -200,7 +200,7 @@ "/wfs/datasets/{datasetid}/": { "get": { "x-publish": true, - "description": "Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Landing Page API provides links to the API definition, the Conformance statements and the metadata about the feature data in this dataset.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Landing Page API provides links to the API definition, the Conformance statements and the metadata about the feature data in this dataset.", "operationId": "WFS_GetLandingPagePreview", "x-ms-examples": { "GetLandingPage": { @@ -248,7 +248,7 @@ }, "/wfs/datasets/{datasetid}/conformance": { "get": { - "description": "Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Requirements Classes lists all requirements classes specified in the standard that the server conforms to.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Requirements Classes lists all requirements classes specified in the standard that the server conforms to.", "x-publish": true, "operationId": "WFS_GetRequirementsClassesPreview", "x-ms-examples": { @@ -297,7 +297,7 @@ }, "/wfs/datasets/{datasetid}/collections": { "get": { - "description": "Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Collections Description API provides descriptions of all the collections in a given dataset.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Collections Description API provides descriptions of all the collections in a given dataset.", "operationId": "WFS_CollectionsDescriptionPreview", "x-publish": true, "x-ms-examples": { @@ -346,7 +346,7 @@ }, "/wfs/datasets/{datasetid}/collections/{collectionId}": { "get": { - "description": "Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n \nThe Collection Description API provides the description of a given collection. It includes the links to the operations that can be performed on the collection.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n \nThe Collection Description API provides the description of a given collection. It includes the links to the operations that can be performed on the collection.", "operationId": "WFS_CollectionDescriptionPreview", "x-publish": true, "x-ms-examples": { @@ -398,7 +398,7 @@ }, "/wfs/datasets/{datasetid}/collections/{collectionId}/definition": { "get": { - "description": "Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n \nThe Collection Definition API provides the detailed data model of a given collection.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n \nThe Collection Definition API provides the detailed data model of a given collection.", "operationId": "WFS_CollectionDefinitionPreview", "x-publish": true, "x-ms-examples": { @@ -450,7 +450,7 @@ }, "/wfs/datasets/{datasetid}/collections/{collectionId}/items": { "get": { - "description": "Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Features API returns the list of features in the given collection.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Features API returns the list of features in the given collection.", "operationId": "WFS_GetFeaturesPreview", "x-publish": true, "x-ms-examples": { @@ -511,7 +511,7 @@ }, "/wfs/datasets/{datasetid}/collections/{collectionId}/items/{featureId}": { "get": { - "description": "Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Feature API returns the feature identified by the provided id in the given collection.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Feature API returns the feature identified by the provided id in the given collection.", "x-publish": true, "operationId": "WFS_GetFeaturePreview", "x-ms-examples": { @@ -561,7 +561,7 @@ } }, "delete": { - "description": "Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Delete Feature API deletes the feature identified by the provided id in the given collection. At this point this API supports only facility features. Deleting a facility feature deletes all the child features of that facility recursively.", + "description": ">[!Important]\n>The Azure Maps Creator services (Preview) version 1.0 will retire on 6 September 2021. Please transition to using version 2.0 by that date.\n>For details, see [Azure Maps Creator V1 Retirement](https://azure.microsoft.com/en-us/updates/azure-maps-creator-v1-will-be-retired-on-6-september-2021/).\n\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Delete Feature API deletes the feature identified by the provided id in the given collection. At this point this API supports only facility features. Deleting a facility feature deletes all the child features of that facility recursively.", "x-publish": true, "operationId": "WFS_DeleteFeaturePreview", "x-ms-examples": { @@ -612,7 +612,7 @@ "definitions": { "ODataErrorResponse": { "type": "object", - "description": "This response object is returned when an error occurs in the Maps API.", + "description": "This response object is returned when an error occurs in the Azure Maps API.", "properties": { "error": { "$ref": "#/definitions/ODataError" @@ -621,7 +621,7 @@ }, "ODataError": { "type": "object", - "description": "This object is returned when an error occurs in the Maps API.", + "description": "This object is returned when an error occurs in the Azure Maps API.", "properties": { "code": { "type": "string", @@ -631,7 +631,7 @@ "message": { "type": "string", "readOnly": true, - "description": "If available, a human readable description of the error." + "description": "If available, a human-readable description of the error." }, "details": { "type": "array", @@ -902,6 +902,7 @@ } }, "properties": { + "x-ms-client-flatten": true, "description": "attributes of the collection used", "type": "array", "items": { @@ -1001,6 +1002,7 @@ "type": "object" }, "properties": { + "x-ms-client-flatten": true, "description": "Additional properties of the feature.", "type": "object" }, diff --git a/specification/maps/data-plane/Microsoft.Maps/WFS/preview/2.0/wfs.json b/specification/maps/data-plane/Microsoft.Maps/WFS/preview/2.0/wfs.json index dbd9c75202c5..ee95b8709fa3 100644 --- a/specification/maps/data-plane/Microsoft.Maps/WFS/preview/2.0/wfs.json +++ b/specification/maps/data-plane/Microsoft.Maps/WFS/preview/2.0/wfs.json @@ -26,14 +26,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", "scopes": { "user_impersonation": "Impersonates a user's Azure Active Directory account." } }, "apiKeyQuery": { "type": "apiKey", - "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", "name": "subscription-key", "in": "query" } @@ -54,7 +54,7 @@ } }, "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory (Azure AD) bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Azure AD bearer token.", "schema": { "$ref": "#/definitions/ODataErrorResponse" }, @@ -114,7 +114,7 @@ }, "ClientId": { "name": "x-ms-client-id", - "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", "type": "string", "in": "header", "required": false, @@ -191,7 +191,7 @@ "/wfs/datasets/{datasetid}/": { "get": { "x-publish": true, - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Landing Page API provides links to the API definition, the Conformance statements and the metadata about the feature data in this dataset.", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Landing Page API provides links to the API definition, the Conformance statements and the metadata about the feature data in this dataset.", "operationId": "WFS_GetLandingPage", "x-ms-examples": { "GetLandingPage": { @@ -239,7 +239,7 @@ }, "/wfs/datasets/{datasetid}/conformance": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Requirements Classes lists all requirements classes specified in the standard that the server conforms to.", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Requirements Classes lists all requirements classes specified in the standard that the server conforms to.", "x-publish": true, "operationId": "WFS_GetRequirementsClasses", "x-ms-examples": { @@ -288,7 +288,7 @@ }, "/wfs/datasets/{datasetid}/collections": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Collections Description API provides descriptions of all the collections in a given dataset.", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Collections Description API provides descriptions of all the collections in a given dataset.", "operationId": "WFS_CollectionsDescription", "x-publish": true, "x-ms-examples": { @@ -337,7 +337,7 @@ }, "/wfs/datasets/{datasetid}/collections/{collectionId}": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n \nThe Collection Description API provides the description of a given collection. It includes the links to the operations that can be performed on the collection.", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n \nThe Collection Description API provides the description of a given collection. It includes the links to the operations that can be performed on the collection.", "operationId": "WFS_CollectionDescription", "x-publish": true, "x-ms-examples": { @@ -389,7 +389,7 @@ }, "/wfs/datasets/{datasetid}/collections/{collectionId}/definition": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n \nThe Collection Definition API provides the detailed data model of a given collection.", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n \nThe Collection Definition API provides the detailed data model of a given collection.", "operationId": "WFS_CollectionDefinition", "x-publish": true, "x-ms-examples": { @@ -441,7 +441,7 @@ }, "/wfs/datasets/{datasetid}/collections/{collectionId}/items": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Features API returns the list of features in the given collection.", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Features API returns the list of features in the given collection.", "operationId": "WFS_GetFeatures", "x-publish": true, "x-ms-examples": { @@ -502,7 +502,7 @@ }, "/wfs/datasets/{datasetid}/collections/{collectionId}/items/{featureId}": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Feature API returns the feature identified by the provided id in the given collection.", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Feature API returns the feature identified by the provided id in the given collection.", "x-publish": true, "operationId": "WFS_GetFeature", "x-ms-examples": { @@ -552,7 +552,7 @@ } }, "delete": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Delete Feature API deletes the feature identified by the provided id in the given collection. At this point this API supports only facility features. Deleting a facility feature deletes all the child features of that facility recursively.", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Delete Feature API deletes the feature identified by the provided id in the given collection. At this point this API supports only facility features. Deleting a facility feature deletes all the child features of that facility recursively.", "x-publish": true, "operationId": "WFS_DeleteFeature", "x-ms-examples": { @@ -603,7 +603,7 @@ "definitions": { "ODataErrorResponse": { "type": "object", - "description": "This response object is returned when an error occurs in the Maps API.", + "description": "This response object is returned when an error occurs in the Azure Maps API.", "properties": { "error": { "$ref": "#/definitions/ODataError" @@ -612,7 +612,7 @@ }, "ODataError": { "type": "object", - "description": "This object is returned when an error occurs in the Maps API.", + "description": "This object is returned when an error occurs in the Azure Maps API.", "properties": { "code": { "type": "string", @@ -622,7 +622,7 @@ "message": { "type": "string", "readOnly": true, - "description": "If available, a human readable description of the error." + "description": "If available, a human-readable description of the error." }, "details": { "type": "array", @@ -905,6 +905,7 @@ } }, "properties": { + "x-ms-client-flatten": true, "description": "attributes of the collection used", "type": "array", "items": { @@ -1010,6 +1011,7 @@ "type": "object" }, "properties": { + "x-ms-client-flatten": true, "description": "Additional properties of the feature.", "type": "object" }, diff --git a/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/weather.json b/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/weather.json index 16dc39630f47..2e6416f391f9 100644 --- a/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/weather.json +++ b/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/weather.json @@ -17,14 +17,14 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", "scopes": { "user_impersonation": "Impersonates a user's Azure Active Directory account." } }, "apiKeyQuery": { "type": "apiKey", - "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", "name": "subscription-key", "in": "query" } @@ -45,7 +45,7 @@ } }, "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory (Azure AD) bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Azure AD bearer token.", "schema": { "$ref": "#/definitions/ODataErrorResponse" }, @@ -78,7 +78,7 @@ "parameters": { "ClientId": { "name": "x-ms-client-id", - "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", "type": "string", "in": "header", "required": false, @@ -707,7 +707,7 @@ "definitions": { "ODataErrorResponse": { "type": "object", - "description": "This response object is returned when an error occurs in the Maps API.", + "description": "This response object is returned when an error occurs in the Azure Maps API.", "properties": { "error": { "$ref": "#/definitions/ODataError" @@ -716,7 +716,7 @@ }, "ODataError": { "type": "object", - "description": "This object is returned when an error occurs in the Maps API.", + "description": "This object is returned when an error occurs in the Azure Maps API.", "properties": { "code": { "type": "string", @@ -726,7 +726,7 @@ "message": { "type": "string", "readOnly": true, - "description": "If available, a human readable description of the error." + "description": "If available, a human-readable description of the error." }, "details": { "type": "array", diff --git a/specification/maps/data-plane/Render/preview/1.0/examples/GetCopyrightCaption.json b/specification/maps/data-plane/Render/preview/1.0/examples/GetCopyrightCaption.json new file mode 100644 index 000000000000..5168f6a0fe19 --- /dev/null +++ b/specification/maps/data-plane/Render/preview/1.0/examples/GetCopyrightCaption.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "geography": "us", + "api-version": "1.0", + "format": "json" + }, + "responses": { + "200": { + "body": { + "formatVersion": "0.0.1", + "copyrightsCaption": "© 1992 - 2017 TomTom." + } + } + } +} diff --git a/specification/maps/data-plane/Render/preview/1.0/examples/GetCopyrightForTile.json b/specification/maps/data-plane/Render/preview/1.0/examples/GetCopyrightForTile.json new file mode 100644 index 000000000000..18e9b9644d2b --- /dev/null +++ b/specification/maps/data-plane/Render/preview/1.0/examples/GetCopyrightForTile.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "geography": "us", + "api-version": "1.0", + "format": "json", + "zoom": 6, + "x": 9, + "y": 22 + }, + "responses": { + "200": { + "body": { + "formatVersion": "0.0.1", + "generalCopyrights": [ + "© 1992 - 2018 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection, database right protection and other intellectual property rights owned by TomTom or its suppliers. The use of this material is subject to the terms of a license agreement. Any unauthorized copying or disclosure of this material will lead to criminal and civil liabilities.", + "Data Source © 2018 TomTom", + "based on" + ], + "regions": [ + { + "copyrights": [ + "© 2006 – 2018 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection and other intellectual property rights owned or licensed to TomTom. The product includes information copied with permission from Canadian authorities, including © Canada Post Corporation and Department of Natural Resources Canada, All rights reserved. The use of this material is subject to the terms of a License Agreement. You will be held liable for any unauthorized copying or disclosure of this material. Adapted from Statistics Canada: Boundary Files, 2016 Census; Road Network File, 2016; and Census Population and Dwelling Count Highlight Tables, 2016 Census. This does not constitute an endorsement by Statistics Canada of this product", + "The following copyright notice applies to the use of Administrative Area: © 2006 – 2018 TomTom. All rights reserved. Adapted from Statistics Canada: Boundary Files, 2016 Census: Census Population and Dwelling Count Highlight Tables, 2016. This does not constitute an endorsement by Statistics Canada of this product.", + "The following copyright notice applies to the use of Post- FSA layer and 6-digit layer: © 2006 – 2018 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection and other intellectual property rights owned or licensed to TomTom. The product includes information copied with permission from Canadian authorities, including © Canada Post Corporation, All rights reserved. The use of this material is subject to the terms of a License Agreement. You will be held liable for any unauthorized copying or disclosure of this material", + "The following copyright notice applies to the use of Points of Interest: © 2006 – 2018 TomTom. All rights reserved. Portions of the POI database contained in Points of Interest North America have been provided by Neustar Localeze", + "The following copyright notice applies to the use of Telecommunications: © 2017 Pitney Bowes. All rights reserved. In addition, for the following product layers Wire Center Boundaries, ILEC Boundaries, and Rate Center Boundaries, the following also applies: This product contains information and/or data of Telcordia Technologies, Inc. (Telcordia) licensed to be included herein.", + "The following copyright notice applies to the use of TomTom Traffic: Portions of the data have been provided by Total Traffic & Weather Network, a division of iHeartMedia + Entertainment, Inc. © 2017. Total Traffic & Weather Network, a division of iHeartMedia + Entertainment, Inc. All rights reserved.", + "This product contains address point data made available under the city of Vancouver’s Open Data framework as documented on August 6, 2012 in: vancouver.ca/open-government-licence Contains public sector Datasets made available under the City of Toronto's Open Data Licence v2.0. This is specified in their terms available here: http://www1.toronto.ca/wps/portal/contentonly?vgnextoid=4a37e03bb8d1e310VgnVCM10000071d60f89RCRD", + "Contains information licensed under the Open Government Licence – Strathcona County. For specifics, please reference: https://data.strathcona.ca/licence", + "Contains information licensed under the Open Government Licence – County of Grande Prairie. For specifics, please reference: http://www.countygp.ab.ca/EN/main/community/maps-gis/open-data/open-data-licence.html", + "Contains information licensed under the Open Government Licence – Canada. For specifics, please reference: http://open.canada.ca/en/open-government-licence-canada", + "Contains information licensed under the Calgary Regional Partnership Open Data Licence. For specifics, please reference: http://calgaryregion.ca/dam/Website/reports/General/GIS/Public-documents/Calgary-Regional-Partnership-Open-Data-Licence/Calgary%20Regional%20Partnership%20Open%20Data%20Licence.pdf Contains information licensed under the Open Government Licence – Banff. For specifics, please reference: http://www.banffopendata.ca/Home/About", + "Contains information licensed under the Open Data License – City of Grande Prairie. For specifics, please reference: http://www.cityofgp.com/index.aspx?page=2332", + "Contains information licensed under the Open Government Licence – City of Victoria. For specifics, please reference: http://www.victoria.ca/EN/main/city/open-data-catalogue/open-data-licence.html", + "Contains information licenced under the Open Government Licence - Halifax. For specifics, please reference: http://www.halifax.ca/opendata/OD_TermsOfUse.php", + "Contains information provided by the City of Guelph under an open government license. For specifics, please reference: http://data.open.guelph.ca/pages/open-government-licence", + "Contains information licensed under the Open Government Licence – Haldimand County. For specifics, please reference: http://opendata.haldimandcounty.on.ca/", + "Contains information provided by the City of Hamilton under an open government license. For specifics, please reference: http://www2.hamilton.ca/NR/rdonlyres/C58984A4-FE11-40B9-A231-8572EB922AAA/0/OpenDataTermsAndConditions_Final.html Contains information licensed under the Open Government Licence - Niagara Region. For specifics, please reference: http://www.niagararegion.ca/government/opendata/terms-of-use.aspx", + "Contains information licensed under the Open Government Licence — Town of Oakville. For specifics, please reference: http://www.oakville.ca/data/open_data_licence.html", + "Contains information licensed under the Open Government Licence - The Corporation of the City of Windsor. For specifics, please reference: http://www.citywindsor.ca/opendata/Documents/OpenDataTermsofUse.pdf", + "Contains information licensed under the Open Government Licence – City of Regina. For specifics, please reference: https://www.regina.ca/residents/open-government/open-government-licence/", + "Contains information licensed under the Open Government License - British Columbia. Contains information licensed under the Open Government License - City of Surrey. Contains public sector datasets made available under the City of Brandon's Open Data License. For specifics, please reference: http://opengov.brandon.ca/terms.aspx", + "Contains information licensed under the Open Government License - Winnipeg. For specifics, please reference: https://data.winnipeg.ca/open-data-licence", + "Contains information licensed under the GeoNB Open Data Licence. For specifics, please reference: http://geonb.snb.ca/documents/license/geonb-odl_en.pdf", + "Contains information licensed under the Open Government Licence - The Corporation of the Municipality of Chatham-Kent. Contains information licensed under the Open Government Licence - Niagara Region. For specifics, please referec: https://niagaraopendata.ca/pages/open-government-license-2-0-niagara-region", + "Contains information licensed under the Open Government Licence - City of Welland. Contains information licensed under the Open Government Licence - Prince Edward Island. For specifics, please reference: https://www.princeedwardisland.ca/en/information/finance/open-government-licence-prince-edward-island", + "Contains information licensed under the Open Government License - Kamloops. For specifics, please reference: http://www.kamloops.ca/maps/disclaimer.html", + "Contains information licensed under the Open Government License - Nanaimo. For specifics, please reference: http://www.nanaimo.ca/EN/main/departments/information-technology/DataCatalogue/Licence.html Contains information licensed under the Open Government License – City of New Westminster. For specifics, please reference: http://opendata.newwestcity.ca/licence", + "Contains information licensed under the Open Government License – City of Prince George. For specifics, please reference: http://pgmap.princegeorge.ca/opendata/CityofPrinceGeorge_Open_Government_License_Open_Data.pdf", + "Contains Information licensed under the Open Government Licence – Brantford. For specifics, please reference: http://www.brantford.ca/govt/projects/opendata/Pages/OpenDataLicence.aspx", + "Contains data for Gatineau, QC made available through Creative Commons Attribution 4.0 International. For specifics, please reference: https://creativecommons.org/licenses/by/4.0/legalcode", + "Contains data for Laval, QC made available through Creative Commons Attribution 4.0 International. For specifics, please reference: https://creativecommons.org/licenses/by/4.0/legalcode", + "Contains data for Longueuil, QC made available through Creative Commons Attribution 4.0 International. For specifics, please reference: https://creativecommons.org/licenses/by/4.0/legalcode", + "Contains data for Montreal, QC made available through Creative Commons Attribution 4.0 International. For specifics, please reference: https://creativecommons.org/licenses/by/4.0/legalcode", + "Contains data for Rimouski, QC made available through Creative Commons Attribution 4.0 International. For specifics, please reference: https://creativecommons.org/licenses/by/4.0/legalcode" + ], + "country": { + "ISO3": "CAN", + "label": "Canada" + } + }, + { + "copyrights": [ + "The following copyright notice applies to the use of Points of Interest: © 2006 – 2018 TomTom. All rights reserved. Portions of the POI database contained in Points of Interest North America have been provided by Neustar Localeze", + "The following copyright notice applies to the use of Telecommunications: © 2017 Pitney Bowes. All rights reserved. In addition, for the following product layers Wire Center Boundaries, ILEC Boundaries, and Rate Center Boundaries, the following also applies: This product contains information and/or data of Telcordia Technologies, Inc. (Telcordia) licensed to be included herein.", + "The following copyright notice applies to the use of TomTom Traffic: Portions of the data have been provided by Total Traffic & Weather Network, a division of iHeartMedia + Entertainment, Inc. © 2017. Total Traffic & Weather Network, a division of iHeartMedia + Entertainment, Inc. All rights reserved.", + "© United States Postal Service 2017", + "Contains data made available by the Rhode Island Geographic Information System (RIGIS) consortium, the State of Rhode Island, and the University of Rhode Island. For specifics, please reference: http://www.rigis.org/information", + "Contains Address Points data made available by State of Maryland and MD iMAP. For specifics, please reference: http://imap.maryland.gov." + ], + "country": { + "ISO3": "USA", + "label": "United States" + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Render/preview/1.0/examples/GetCopyrightForWorld.json b/specification/maps/data-plane/Render/preview/1.0/examples/GetCopyrightForWorld.json new file mode 100644 index 000000000000..7a55e043297c --- /dev/null +++ b/specification/maps/data-plane/Render/preview/1.0/examples/GetCopyrightForWorld.json @@ -0,0 +1,339 @@ +{ + "parameters": { + "geography": "us", + "api-version": "1.0", + "format": "json" + }, + "responses": { + "200": { + "body": { + "formatVersion": "0.0.1", + "generalCopyrights": [ + "© 1992 - 2018 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection, database right protection and other intellectual property rights owned by TomTom or its suppliers. The use of this material is subject to the terms of a license agreement. Any unauthorized copying or disclosure of this material will lead to criminal and civil liabilities.", + "Data Source © 2018 TomTom", + "based on" + ], + "regions": [ + { + "copyrights": [ + "This product contains cartographic information (geometry, street names, traffic flow, address points) made available by Govern d’Andorra under legal terms available here; https://www.govern.ad/avis-legal" + ], + "country": { + "ISO3": "AND", + "label": "Andorra" + } + }, + { + "copyrights": [ + "In New South Wales this product contains road centerline geometry from NSW Land Property Information licensed under CC-BY 3.0 AU. © Land and Property Information [2015]. Further information available here: http://spatialservices.finance.nsw.gov.au/mapping_and_imagery/lpi_web_services", + "In Queensland this product contains road centerline geometry from QLD Transport and Main Roads authority made available by the Queensland open data portal and licensed under CC-BY 3.0 AU. Further information available here: https://data.qld.gov.au/dataset/state-controlled-roads-queensland", + "In South Australia this product contains road centerline geometry from SA Department of Planning Transport and Infrastructure made available by the South Australian government and licensed under CC-BY 4.0. Further information available here: http://data.sa.gov.au/data/organization/department-of-planning-transport-and-infrastructure https://data.sa.gov.au/copyright", + "In Tasmania this product contains road centerline attribution from the Tasmanian Government Transport agency. http://www.transport.tas.gov.au/roadsafety/speed", + "In Victoria this product contains cartographic information (roads, speed restriction, vehicle restrictions) made available by the Victorian Government open data portal licensed under CC-BY 4.0. Further information here: http://vicroadsopendata.vicroadsmaps.opendata.arcgis.com/ https://www.data.vic.gov.au/data/dataset", + "In Western Australia this product contains medium scale road centerline geometry from Landgate made available by the Western Australian Government via their open that portal licensed under CC-BY 4.0 http://catalogue.beta.data.wa.gov.au/dataset/roads-lgate-012 http://opendefinition.org/od/2.0/en/", + "This product contains address point data made available in the PSMA Geocoded National Address File (G- NAF) offered via the Australian Federal Government open data portal under EULA terms based on Creative Commons license CC BY 4.0 with the following special restriction. For Specifics please reference: https://data.gov.au/dataset/geocoded-national-address-file-g-naf/resource/09f74802-08b1-4214-a6ea-3591b2753d30" + ], + "country": { + "ISO3": "AUS", + "label": "Australia" + } + }, + { + "copyrights": [ + "© BEV, GZ 1368/2017" + ], + "country": { + "ISO3": "AUT", + "label": "Austria" + } + }, + { + "copyrights": [ + "© Source data. State committee on property of the Republic of Belarus, 2015 © Republic unitary organization <>, 2016" + ], + "country": { + "ISO3": "BLR", + "label": "Belarus" + } + }, + { + "copyrights": [ + "© 2006 – 2018 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection and other intellectual property rights owned or licensed to TomTom. The product includes information copied with permission from Canadian authorities, including © Canada Post Corporation and Department of Natural Resources Canada, All rights reserved. The use of this material is subject to the terms of a License Agreement. You will be held liable for any unauthorized copying or disclosure of this material. Adapted from Statistics Canada: Boundary Files, 2016 Census; Road Network File, 2016; and Census Population and Dwelling Count Highlight Tables, 2016 Census. This does not constitute an endorsement by Statistics Canada of this product", + "The following copyright notice applies to the use of Administrative Area: © 2006 – 2018 TomTom. All rights reserved. Adapted from Statistics Canada: Boundary Files, 2016 Census: Census Population and Dwelling Count Highlight Tables, 2016. This does not constitute an endorsement by Statistics Canada of this product.", + "The following copyright notice applies to the use of Post- FSA layer and 6-digit layer: © 2006 – 2018 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection and other intellectual property rights owned or licensed to TomTom. The product includes information copied with permission from Canadian authorities, including © Canada Post Corporation, All rights reserved. The use of this material is subject to the terms of a License Agreement. You will be held liable for any unauthorized copying or disclosure of this material", + "The following copyright notice applies to the use of Points of Interest: © 2006 – 2018 TomTom. All rights reserved. Portions of the POI database contained in Points of Interest North America have been provided by Neustar Localeze", + "The following copyright notice applies to the use of Telecommunications: © 2017 Pitney Bowes. All rights reserved. In addition, for the following product layers Wire Center Boundaries, ILEC Boundaries, and Rate Center Boundaries, the following also applies: This product contains information and/or data of Telcordia Technologies, Inc. (Telcordia) licensed to be included herein.", + "The following copyright notice applies to the use of TomTom Traffic: Portions of the data have been provided by Total Traffic & Weather Network, a division of iHeartMedia + Entertainment, Inc. © 2017. Total Traffic & Weather Network, a division of iHeartMedia + Entertainment, Inc. All rights reserved.", + "This product contains address point data made available under the city of Vancouver’s Open Data framework as documented on August 6, 2012 in: vancouver.ca/open-government-licence Contains public sector Datasets made available under the City of Toronto's Open Data Licence v2.0. This is specified in their terms available here: http://www1.toronto.ca/wps/portal/contentonly?vgnextoid=4a37e03bb8d1e310VgnVCM10000071d60f89RCRD", + "Contains information licensed under the Open Government Licence – Strathcona County. For specifics, please reference: https://data.strathcona.ca/licence", + "Contains information licensed under the Open Government Licence – County of Grande Prairie. For specifics, please reference: http://www.countygp.ab.ca/EN/main/community/maps-gis/open-data/open-data-licence.html", + "Contains information licensed under the Open Government Licence – Canada. For specifics, please reference: http://open.canada.ca/en/open-government-licence-canada", + "Contains information licensed under the Calgary Regional Partnership Open Data Licence. For specifics, please reference: http://calgaryregion.ca/dam/Website/reports/General/GIS/Public-documents/Calgary-Regional-Partnership-Open-Data-Licence/Calgary%20Regional%20Partnership%20Open%20Data%20Licence.pdf Contains information licensed under the Open Government Licence – Banff. For specifics, please reference: http://www.banffopendata.ca/Home/About", + "Contains information licensed under the Open Data License – City of Grande Prairie. For specifics, please reference: http://www.cityofgp.com/index.aspx?page=2332", + "Contains information licensed under the Open Government Licence – City of Victoria. For specifics, please reference: http://www.victoria.ca/EN/main/city/open-data-catalogue/open-data-licence.html", + "Contains information licenced under the Open Government Licence - Halifax. For specifics, please reference: http://www.halifax.ca/opendata/OD_TermsOfUse.php", + "Contains information provided by the City of Guelph under an open government license. For specifics, please reference: http://data.open.guelph.ca/pages/open-government-licence", + "Contains information licensed under the Open Government Licence – Haldimand County. For specifics, please reference: http://opendata.haldimandcounty.on.ca/", + "Contains information provided by the City of Hamilton under an open government license. For specifics, please reference: http://www2.hamilton.ca/NR/rdonlyres/C58984A4-FE11-40B9-A231-8572EB922AAA/0/OpenDataTermsAndConditions_Final.html Contains information licensed under the Open Government Licence - Niagara Region. For specifics, please reference: http://www.niagararegion.ca/government/opendata/terms-of-use.aspx", + "Contains information licensed under the Open Government Licence — Town of Oakville. For specifics, please reference: http://www.oakville.ca/data/open_data_licence.html", + "Contains information licensed under the Open Government Licence - The Corporation of the City of Windsor. For specifics, please reference: http://www.citywindsor.ca/opendata/Documents/OpenDataTermsofUse.pdf", + "Contains information licensed under the Open Government Licence – City of Regina. For specifics, please reference: https://www.regina.ca/residents/open-government/open-government-licence/", + "Contains information licensed under the Open Government License - British Columbia. Contains information licensed under the Open Government License - City of Surrey. Contains public sector datasets made available under the City of Brandon's Open Data License. For specifics, please reference: http://opengov.brandon.ca/terms.aspx", + "Contains information licensed under the Open Government License - Winnipeg. For specifics, please reference: https://data.winnipeg.ca/open-data-licence", + "Contains information licensed under the GeoNB Open Data Licence. For specifics, please reference: http://geonb.snb.ca/documents/license/geonb-odl_en.pdf", + "Contains information licensed under the Open Government Licence - The Corporation of the Municipality of Chatham-Kent. Contains information licensed under the Open Government Licence - Niagara Region. For specifics, please referec: https://niagaraopendata.ca/pages/open-government-license-2-0-niagara-region", + "Contains information licensed under the Open Government Licence - City of Welland. Contains information licensed under the Open Government Licence - Prince Edward Island. For specifics, please reference: https://www.princeedwardisland.ca/en/information/finance/open-government-licence-prince-edward-island", + "Contains information licensed under the Open Government License - Kamloops. For specifics, please reference: http://www.kamloops.ca/maps/disclaimer.html", + "Contains information licensed under the Open Government License - Nanaimo. For specifics, please reference: http://www.nanaimo.ca/EN/main/departments/information-technology/DataCatalogue/Licence.html Contains information licensed under the Open Government License – City of New Westminster. For specifics, please reference: http://opendata.newwestcity.ca/licence", + "Contains information licensed under the Open Government License – City of Prince George. For specifics, please reference: http://pgmap.princegeorge.ca/opendata/CityofPrinceGeorge_Open_Government_License_Open_Data.pdf", + "Contains Information licensed under the Open Government Licence – Brantford. For specifics, please reference: http://www.brantford.ca/govt/projects/opendata/Pages/OpenDataLicence.aspx", + "Contains data for Gatineau, QC made available through Creative Commons Attribution 4.0 International. For specifics, please reference: https://creativecommons.org/licenses/by/4.0/legalcode", + "Contains data for Laval, QC made available through Creative Commons Attribution 4.0 International. For specifics, please reference: https://creativecommons.org/licenses/by/4.0/legalcode", + "Contains data for Longueuil, QC made available through Creative Commons Attribution 4.0 International. For specifics, please reference: https://creativecommons.org/licenses/by/4.0/legalcode", + "Contains data for Montreal, QC made available through Creative Commons Attribution 4.0 International. For specifics, please reference: https://creativecommons.org/licenses/by/4.0/legalcode", + "Contains data for Rimouski, QC made available through Creative Commons Attribution 4.0 International. For specifics, please reference: https://creativecommons.org/licenses/by/4.0/legalcode" + ], + "country": { + "ISO3": "CAN", + "label": "Canada" + } + }, + { + "copyrights": [ + "© Swisstopo" + ], + "country": { + "ISO3": "CHE", + "label": "Switzerland" + } + }, + { + "copyrights": [ + "GeoBasis-DE/Geobasis NRW 2017" + ], + "country": { + "ISO3": "DEU", + "label": "Germany" + } + }, + { + "copyrights": [ + "© DAV, violation of these copyrights shall cause legal proceedings" + ], + "country": { + "ISO3": "DNK", + "label": "Denmark" + } + }, + { + "copyrights": [ + "© 2013-2018 TomTom-Nomago" + ], + "country": { + "ISO3": "DZA", + "label": "Algeria" + } + }, + { + "copyrights": [ + "This product contains cartographic information (geometry, street names, traffic flow) made available by Ajuntament de Lleida under legal terms available here: http://www.paeria.es/cas/avisLegal.asp", + "This product contains cartographic information (geometry, street names, traffic flow) made available by Ayuntamiento de Logroño under legal terms available here: http://web.logro-o.org/giswebpgm/ayuda/condicionesuso.html", + "This product contains address point data made available under the Gobierno de Navarra and offered under Creative Commons- Attribution (CC-by 3.0) license in: http://idena.navarra.es/busquedas/catalog/descargas/descargas.page", + "This product contains address point data made available by la Comunidad de Madrid with the product NomeCalles offered by El Instituto de Estadística de la Comunidad de Madrid in: http://www.madrid.org/nomecalles/DescargaBDTCorte.icm", + "This product contains address point data made available by la Dirección General del Catastro del Ministerio de Economía y Hacienda in: https://www.sedecatastro.gob.es/OVCFrames.aspx?TIPO=TIT&a=masiv", + "This product contains cartographic information (geometry, street names, traffic flow, address points) made available by Ajuntament de El Prat de Llobregat under legal terms available here: http://www.elprat.cat/plantilles/pr_re_mactfill_1c_imfl/_uGU6aDOKh21PMmm2WqoT4ZOhxsiMHAS0S7PZC2PCFqo", + "This product contains cartographic information (geometry, street names, traffic flow, address points) made available by Ayuntamiento de Valencia under legal terms available here: http://www.valencia.es/ayuntamiento/DatosAbiertos.nsf/vDocumentosTituloAux/Condiciones%20de%20uso?opendocument&lang=1&nivel=5&seccion=1", + "This product contains cartographic information (geometry, street names, traffic flow, address points) made available by Ajuntament de Sant Feu de Llobregat under legal terms available here: https://www.santfeliu.cat/common/misc/widget_container.faces?xmid=11796", + "This product contains cartographic information (geometry, street names, traffic flow) made available by Ayuntamiento de Vitoria-Gasteiz under Creative Commons Reconocimiento 3.0 España available here: TT#0041606-16 http://creativecommons.org/licenses/by/3.0/es/legalcode.es" + ], + "country": { + "ISO3": "ESP", + "label": "Spain" + } + }, + { + "copyrights": [ + "(navigation devices only) Michelin data © Michelin 2017 The following copyright applies to the Advanced Navigable MAP, Address Points, 2D City Map and Buildings: Source: Direction générale des Finances Publiques – Cadastre; Updated 2017" + ], + "country": { + "ISO3": "FRA", + "label": "France" + } + }, + { + "copyrights": [ + "Ordnance Survey of Northern Ireland", + "Contains Ordnance Survey data © Crown copyright and database right 2017", + "Code-Point® Open data; Contains Royal Mail data © Royal Mail copyright and database right 2017 Contains National Statistics data © Crown copyright and database right 2017" + ], + "country": { + "ISO3": "GBR", + "label": "United Kingdom" + } + }, + { + "copyrights": [ + "© Base data Bakosurtanal" + ], + "country": { + "ISO3": "IDN", + "label": "Indonesia" + } + }, + { + "copyrights": [ + "This product contains cartographic information (street names, address points) made available by the Regione Lombardia and offered under Italian Open Data License (IODL 2.0) http://www.dati.gov.it/iodl/2.0/) available at the following address: http://www.geoportale.regione.lombardia.it/en/i.i.t.-della-lombardia", + "This product contains cartographic information from Comune di Milano 1)– Servizio Sit e Statistica made available at https://geoportale.comune.milano.it/sit/open-data/ under license Creative Commons Attribution (CC BY 2,5) 2) Web portal available at https://www.comune.milano.it/wps/portal/ist/it/vivicitta/verde/parchi Under license Creative Commons Attribution (CC BY 3.0) (http://www.comune.milano.it/wps/portal/ist/it/extra/others/footer/legal)", + "This product contains cartographic information (street names, address points) made available by Regione Emilia Romagna and offered under Creative Commons Attribution (CC BY 2.5) available at following address http://geoportale.regione.emilia-romagna.it/it/catalogo/dati-cartografici/cartografia-di-base/database-topografico-regionale/gestione-viabilita-indirizzi/toponimi-e-numeri-civici This product contains cartographic information (street names, address points) made available by Comune di Torino and offered under Italian Open Data License (IODL 2.0) available at following address http://aperto.comune.torino.it/?q=node/504", + "This product contains cartographic information (street names, address points) made available by Regione Veneto and offered offered under Italian Open Data License (IODL 2.0) available at following address http://dati.veneto.it/dataset", + "This product contains cartographic information (street names, address points) made available by Regione Toscana and offered offered under under Creative Commons Attribution (CC BY 2.5), according to the legislation available at http://www.regione.toscana.it/documents/10180/492172/Decreto-2014_02_25n663.pdf/162db905-95fd-4b5e-bc41-88a629b5a3e5 and Regolamento http://raccoltanormativa.consiglio.regione.toscana.it/articolo?urndoc=urn:nir:regione.toscana:regolamento.giunta:2007-02-09;6/R&pr=idx,0;artic,1;articparziale,0, data available at following address http://dati.toscana.it/dataset/grafo-civici", + "This product contains cartographic information (area info) made available by Comune di Roma at http://dati.comune.roma.it/cms/it/dettaglio_ambiente.page?contentId=DTS5931 under license Creative Commons Attribution (CC BY 4.0)", + "This product contains data (house numbers, geographical and statistical info on administrative areas) made available under the Istituto Nazionale di Statistica and offered under Creative Commons- Attribution (CC-by 3.0) license in: http://www.istat.it/it/archivio/678 and http://datiopen.istat.it/", + "This product contains address point data made available under the Comune di Verona in: http://www.comune.verona.it/nqcontent.cfm?a_id=37426", + "This product contains address point data made available under the Comune di Vicenza in: http://www.comune.vicenza.it/servizi/opendata.php/76184", + "This product contains address point data from Comune di Milano – Servizio Sit e Statistica This product contains address point data made available under the Provincia di Biella in: http://cartografia.provincia.biella.it/on-line/Home/Repertorio/Consultazione/articolo3000217.html", + "This product contains address point data made available by Comune di Torino and offered under Italian Open Data License (IODL 2.0) available at following address http://aperto.comune.torino.it/?q=node/504", + "This product contains address point data made available under the Comune di Firenze and offered under Creative Commons- Attribution (CC-by 3.0) license in: http://opendata.comune.fi.it/statistica_territorio/dataset_0040.html", + "This product contains address point data made available by Regione Emilia Romagna and offered under Creative Commons Attribution (CC BY 2.5) available at following address http://geoportale.regione.emilia-romagna.it/it/catalogo/dati-cartografici/cartografia-di-base/database-topografico-regionale/gestione-viabilita-indirizzi/toponimi-e-numeri-civici", + "This product contains address point data made available by Regione Toscana and offered under Creative Commons Attribution (CC BY 2.5), according to the legislation available at http://www.regione.toscana.it/documents/10180/492172/Decreto-2014_02_25n663.pdf/162db905-95fd-4b5e-bc41-88a629b5a3e5 and Regolamento http://raccoltanormativa.consiglio.regione.toscana.it/articolo?urndoc=urn:nir:regione.toscana:regolamento.giunta:2007-02-09;6/R&pr=idx,0;artic,1;articparziale,0, data available at following address http://dati.toscana.it/dataset/grafo-civici", + "This product contains address point data made available by Regione Veneto and offered offered under Italian Open Data License (IODL 2.0) available at following address http://dati.veneto.it/dataset", + "This product contains address point data made available by Regione Autonoma Friuli Venezia Giulia and offered under ITALIA OPEN DATA LICENSE V2.0 (IODL 2.0). Data are available at following address : http://www.regione.fvg.it/rafvg/cms/RAFVG/ambiente-territorio/conoscere-ambiente-territorio/", + "This product contains address point data made available by Regione Umbria and offered under CCBY License. Data are available at following address : http://www.umbriageo.regione.umbria.it/pagine/servizi-wms-attivi?permalink=servizi-wms-attivi&permalink=servizi-wms-attivi This product contains address point data made available by Regione Lombardia and offered under Italian Open Data License (IODL 2.0 http://www.dati.gov.it/iodl/2.0/) available at the following address: http://www.geoportale.regione.lombardia.it/en/i.i.t.-della-lombardia" + ], + "country": { + "ISO3": "ITA", + "label": "Italy" + } + }, + { + "copyrights": [ + "© Royal Jordanian Geographic center" + ], + "country": { + "ISO3": "JOR", + "label": "Jordan" + } + }, + { + "copyrights": [ + "© Shobunsha Publications, Inc. © Shobunsha" + ], + "country": { + "ISO3": "JPN", + "label": "Japan" + } + }, + { + "copyrights": [ + "Based upon electronic data © Mappers Co., Ltd. All rights reserved" + ], + "country": { + "ISO3": "KOR", + "label": "Republic of Korea" + } + }, + { + "copyrights": [ + "© FICHIER DE BASE DES ADRESSES GEOCODEES : ADM. DU CADASTRE ET DE LA TOPOGRAPHIE (2017) [© File taken from the database of geocoded addresses: Land Registry and Topography Administration (2017)]" + ], + "country": { + "ISO3": "LUX", + "label": "Luxembourg" + } + }, + { + "copyrights": [ + "Macao Special Administrative Region Government – Cartography and Cadastre Bureau", + "This product contains Road Geometry data made available by Macao Special Administrative Region Government – Cartography and Cadastre Bureau: http://www.dscc.gov.mo/ENG/copyright.html" + ], + "country": { + "ISO3": "MAC", + "label": "Macao" + } + }, + { + "copyrights": [ + "The following copyright notice applies to the use of TomTom Traffic: Portions of the data have been provided by Total Traffic & Weather Network, a division of iHeartMedia + Entertainment, Inc. © 2017. Total Traffic & Weather Network, a division of iHeartMedia + Entertainment, Inc. All rights reserved." + ], + "country": { + "ISO3": "MEX", + "label": "Mexico" + } + }, + { + "copyrights": [ + "This product includes data from Mapping Unit, Malta Environment and Planning Authority and licensed on behalf of them or © Mapping Unit, Malta Environment and Planning Authority" + ], + "country": { + "ISO3": "MLT", + "label": "Malta" + } + }, + { + "copyrights": [ + "Topografische onderground Copyright © dienst voor het kadaster en de openbare registers, Apeldoorn 2017" + ], + "country": { + "ISO3": "NLD", + "label": "Netherlands" + } + }, + { + "copyrights": [ + "Contains data under the Norwegian licence for Open Government data (NLOD) distributed by Statens Vegvesen" + ], + "country": { + "ISO3": "NOR", + "label": "Norway" + } + }, + { + "copyrights": [ + "This product contains cartographic information (geometry, street names) made available by LINZ and sourced from the LINZ Data Service and licensed under the Creative Commons Attribution 3.0 New Zealand license", + "This product contains cartographic information (geometry) made with the help of Aerial Imagery made available by LINZ and sourced from the LINZ Data Service and licensed by various government agencies for re-use under the Creative Commons Attribution 3.0 New Zealand license", + "This product contains cartographic information (crash data) made available by New Zealand Transport Agency licensed under CC-BY 3.0 NZL. Further information here: http://www.nzta.govt.nz/resources/grouped-crash-sites", + "This product contains cartographic information (geometry, lane information, street names) made available by New Zealand Transport Agency on agreement on a case by case basis. Further information here: https://www.nzta.govt.nz/about-us/about-this-site#privacy https://www.nzta.govt.nz/projects/", + "This product contains address point data made available in the New Zealand Address Dataset which is sourced from New Zealand Post and Land Information New Zealand (LINZ). New Zealand Post copyright reserved. Data sourced from LINZ Data Service is subject to Creative Commons Attribution 3.0 New Zealand license" + ], + "country": { + "ISO3": "NZL", + "label": "New Zealand" + } + }, + { + "copyrights": [ + "This product contains postal code data of Poşta Română made available under Open Government License: http://data.gov.ro/base/images/logoinst/OGL-ROU-1.0.pdf http://data.gov.ro/dataset/coduri-postale-romania" + ], + "country": { + "ISO3": "ROU", + "label": "Romania" + } + }, + { + "copyrights": [ + "© ROSREESTR" + ], + "country": { + "ISO3": "RUS", + "label": "Russian Federation" + } + }, + { + "copyrights": [ + "The following copyright notice applies to the use of Points of Interest: © 2006 – 2018 TomTom. All rights reserved. Portions of the POI database contained in Points of Interest North America have been provided by Neustar Localeze", + "The following copyright notice applies to the use of Telecommunications: © 2017 Pitney Bowes. All rights reserved. In addition, for the following product layers Wire Center Boundaries, ILEC Boundaries, and Rate Center Boundaries, the following also applies: This product contains information and/or data of Telcordia Technologies, Inc. (Telcordia) licensed to be included herein.", + "The following copyright notice applies to the use of TomTom Traffic: Portions of the data have been provided by Total Traffic & Weather Network, a division of iHeartMedia + Entertainment, Inc. © 2017. Total Traffic & Weather Network, a division of iHeartMedia + Entertainment, Inc. All rights reserved.", + "© United States Postal Service 2017", + "Contains data made available by the Rhode Island Geographic Information System (RIGIS) consortium, the State of Rhode Island, and the University of Rhode Island. For specifics, please reference: http://www.rigis.org/information", + "Contains Address Points data made available by State of Maryland and MD iMAP. For specifics, please reference: http://imap.maryland.gov." + ], + "country": { + "ISO3": "USA", + "label": "United States" + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Render/preview/1.0/examples/GetCopyrightFromBoundingBox.json b/specification/maps/data-plane/Render/preview/1.0/examples/GetCopyrightFromBoundingBox.json new file mode 100644 index 000000000000..392a6ef6eda9 --- /dev/null +++ b/specification/maps/data-plane/Render/preview/1.0/examples/GetCopyrightFromBoundingBox.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "geography": "us", + "api-version": "1.0", + "format": "json", + "mincoordinates": "52.41064,4.84228", + "maxcoordinates": "52.41072,4.84239", + "text": "yes" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "formatVersion": "0.0.1", + "generalCopyrights": [ + "© 1992 – 2016 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection, database right protection and other intellectual property rights owned by TomTom or its suppliers. The use of this material is subject to the terms of a license agreement. Any unauthorized copying or disclosure of this material will lead to criminal and civil liabilities.", + "Data Source © 2016 TomTom", + "based on" + ], + "regions": [ + { + "copyrights": [ + "Topografische onderground Copyright © dienst voor het kadaster en de openbare registers, Apeldoorn 2016." + ], + "country": { + "ISO3": "NLD", + "label": "Netherlands" + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Render/preview/1.0/examples/GetMapImageryTile.json b/specification/maps/data-plane/Render/preview/1.0/examples/GetMapImageryTile.json new file mode 100644 index 000000000000..ba3242718b24 --- /dev/null +++ b/specification/maps/data-plane/Render/preview/1.0/examples/GetMapImageryTile.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "geography": "us", + "api-version": "1.0", + "format": "png", + "style": "satellite", + "zoom": 6, + "x": 10, + "y": 22 + }, + "responses": { + "200": { + "headers": { + "Content-Type": "image/png" + }, + "body": "{file}" + } + } +} diff --git a/specification/maps/data-plane/Render/preview/1.0/examples/GetMapStateTile.json b/specification/maps/data-plane/Render/preview/1.0/examples/GetMapStateTile.json new file mode 100644 index 000000000000..72ef3cb5deed --- /dev/null +++ b/specification/maps/data-plane/Render/preview/1.0/examples/GetMapStateTile.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "geography": "us", + "api-version": "1.0", + "statesetId": "[statesetId]", + "zoom": 6, + "x": 10, + "y": 22 + }, + "responses": { + "200": { + "headers": { + "Content-Type": "application/vnd.mapbox-vector-tile" + }, + "body": "{file}" + } + } +} diff --git a/specification/maps/data-plane/Render/preview/1.0/examples/GetMapStaticImage.json b/specification/maps/data-plane/Render/preview/1.0/examples/GetMapStaticImage.json new file mode 100644 index 000000000000..2ff157d8f994 --- /dev/null +++ b/specification/maps/data-plane/Render/preview/1.0/examples/GetMapStaticImage.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "geography": "us", + "api-version": "1.0", + "format": "png", + "zoom": 2, + "bbox": "1.355233,42.982261,24.980233,56.526017", + "layer": "basic", + "style": "main" + }, + "responses": { + "200": { + "headers": { + "Content-Type": "image/png" + }, + "body": "{file}" + } + } +} diff --git a/specification/maps/data-plane/Render/preview/1.0/examples/GetMapTile.json b/specification/maps/data-plane/Render/preview/1.0/examples/GetMapTile.json new file mode 100644 index 000000000000..e96464d77c53 --- /dev/null +++ b/specification/maps/data-plane/Render/preview/1.0/examples/GetMapTile.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "geography": "us", + "api-version": "1.0", + "format": "png", + "layer": "basic", + "style": "main", + "zoom": 6, + "x": 10, + "y": 22, + "tilesize": 512 + }, + "responses": { + "200": { + "headers": { + "Content-Type": "image/png" + }, + "body": "{file}" + } + } +} diff --git a/specification/maps/data-plane/Render/preview/1.0/render.json b/specification/maps/data-plane/Render/preview/1.0/render.json new file mode 100644 index 000000000000..b3551dd7c2b8 --- /dev/null +++ b/specification/maps/data-plane/Render/preview/1.0/render.json @@ -0,0 +1,940 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Render Service", + "version": "1.0", + "description": "Azure Maps Render REST APIs" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{geography}.atlas.microsoft.com", + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "AzureKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "AzureKey": [] + } + ], + "responses": {}, + "parameters": { + "RenderApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API.", + "type": "string", + "in": "query", + "required": true, + "default": "1.0", + "x-ms-parameter-location": "client" + }, + "RasterTileFormat": { + "name": "format", + "description": "Desired format of the response. Possible value: png.", + "type": "string", + "in": "path", + "required": true, + "enum": [ + "png" + ], + "x-ms-enum": { + "name": "RasterTileFormat", + "modelAsString": true, + "values": [ + { + "value": "png", + "description": "An image in the png format. Supports zoom levels 0 through 18." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "TileFormat": { + "name": "format", + "description": "Desired format of the response. Possible values are png & pbf.", + "type": "string", + "in": "path", + "required": true, + "enum": [ + "png", + "pbf" + ], + "x-ms-enum": { + "name": "TileFormat", + "modelAsString": true, + "values": [ + { + "value": "png", + "description": "An image in the png format. Supports zoom levels 0 through 18." + }, + { + "value": "pbf", + "description": "Vector graphic in the pbf format. Supports zoom levels 0 through 22." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "xTileIndex": { + "name": "x", + "x-ms-client-name": "xTileIndex", + "in": "query", + "description": "X coordinate of the tile on zoom grid. Value must be in the range [0, 2`zoom` -1].\n\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.", + "required": true, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "yTileIndex": { + "name": "y", + "x-ms-client-name": "yTileIndex", + "in": "query", + "description": "Y coordinate of the tile on zoom grid. Value must be in the range [0, 2`zoom` -1].\n\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.", + "required": true, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "RasterZoom18": { + "name": "zoom", + "in": "query", + "description": "Zoom level for the desired tile. Zoom value must be in the range: 0-18 (inclusive).\n\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.", + "required": true, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "VectorZoom": { + "name": "zoom", + "in": "query", + "description": "Zoom level for the desired tile. Zoom value must be in the range: 0-20 (inclusive).\n\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.", + "required": true, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "ImageryRasterZoom": { + "name": "zoom", + "in": "query", + "description": "Zoom level for the desired tile. Zoom value must be in the range: 1-19 (inclusive).\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.", + "required": true, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "RasterVectorNaturalEarthZoom": { + "name": "zoom", + "in": "query", + "description": "Zoom level for the desired tile. For _raster_ tiles, value must be in the range: 0-18 (inclusive). Terra raster tiles, values must be in the range 0-6 (inclusive). For _vector_ tiles, value must be in the range: 0-22 (inclusive).\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.", + "required": true, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "IncludeText": { + "name": "text", + "in": "query", + "description": "Yes/no value to exclude textual data from response. Only images and country names will be in response.", + "type": "string", + "enum": [ + "yes", + "no" + ], + "x-ms-enum": { + "name": "IncludeText", + "modelAsString": true, + "values": [ + { + "value": "yes", + "description": "Include all textual data in response." + }, + { + "value": "no", + "description": "Exclude textual data from response. Only images and country names will be in response." + } + ] + }, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/map/static/{format}": { + "get": { + "description": "**Applies to**: S0 and S1 pricing tiers.\n\n\nThe static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20. The static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20. The supported resolution range for the map image is from 1x1 to 8192x8192. If you are deciding when to use the static image service over the map tile service, you may want to consider how you would like to interact with the rendered map. If the map contents will be relatively unchanging, a static map is a good choice. If you want to support a lot of zooming, panning and changing of the map content, the map tile service would be a better choice. \n\nService also provides Image Composition functionality to get a static image back with additional data like; pushpins and geometry overlays with following S0 and S1 capabilities. \n\nIn S0 you can:\n- Render up to 5 pushpins specified in the request\n- Provide one custom image for the pins referenced in the request\n- Add labels to the pushpins\n\nIn S1 you can:\n- Render pushpins through [Azure Maps Data Service](https://aka.ms/AzureMapsMapDataService)\n- Specify multiple pushpin styles\n- Provide custom pushpin images stored in [Azure Maps Data Service](https://aka.ms/AzureMapsMapDataService)\n- Render circle, polyline and polygon geometry types.\n- Render of supported GeoJSON geometry types uploaded through [Azure Maps Data Service](https://aka.ms/AzureMapsMapDataService)\n\nPlease see [How-to-Guide](https://aka.ms/AzureMapsHowToGuideImageCompositor) for detailed examples.\n\n_Note_ : Either **center** or **bbox** parameter must be supplied to the\nAPI.\n

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

    \n\n |Zoom Level | Max Lon Range | Max Lat Range|\n |:----------|:----------------|:-------------|\n |0 | 360.0 | 170.0 | \n |1 | 360.0 | 170.0 |\n |2 | 360.0 | 170.0 |\n |3 | 360.0 | 170.0 |\n |4 | 360.0 | 170.0 |\n |5 | 180.0 | 85.0 |\n |6 | 90.0 | 42.5 |\n |7 | 45.0 | 21.25 |\n |8 | 22.5 | 10.625 |\n |9 | 11.25 | 5.3125 |\n |10 | 5.625 | 2.62625 |\n |11 | 2.8125 | 1.328125 |\n |12 | 1.40625 | 0.6640625 |\n |13 | 0.703125 | 0.33203125 |\n |14 | 0.3515625 | 0.166015625 |\n |15 | 0.17578125 | 0.0830078125 | \n |16 | 0.087890625 | 0.0415039063 | \n |17 | 0.0439453125 | 0.0207519531 |\n |18 | 0.0219726563 | 0.0103759766 |\n |19 | 0.0109863281 | 0.0051879883 |\n |20 | 0.0054931641 | 0.0025939941 |", + "operationId": "Render_GetMapStaticImage", + "x-ms-examples": { + "GetMapStaticImage": { + "$ref": "./examples/GetMapStaticImage.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/RenderApiVersion" + }, + { + "$ref": "#/parameters/RasterTileFormat" + }, + { + "name": "layer", + "in": "query", + "description": "Map layer requested. If layer is set to labels or hybrid, the format should be png.", + "type": "string", + "enum": [ + "basic", + "hybrid", + "labels" + ], + "x-ms-enum": { + "name": "StaticMapLayer", + "modelAsString": true, + "values": [ + { + "value": "basic", + "description": "Returns an image containing all map features including polygons, borders, roads and labels." + }, + { + "value": "hybrid", + "description": "Returns an image containing borders, roads, and labels, and can be overlaid on other tiles (such as satellite imagery) to produce hybrid tiles." + }, + { + "value": "labels", + "description": "Returns an image of just the map's label information." + } + ] + } + }, + { + "name": "style", + "in": "query", + "description": "Map style to be returned. Possible values are main and dark.", + "type": "string", + "enum": [ + "main", + "dark" + ], + "x-ms-enum": { + "name": "MapImageStyle", + "modelAsString": true, + "values": [ + { + "value": "main", + "description": "Azure Maps main style" + }, + { + "value": "dark", + "description": "Dark grey version of the Azure Maps main style" + } + ] + } + }, + { + "name": "zoom", + "in": "query", + "description": "Desired zoom level of the map. Zoom value must be in the range: 0-20 (inclusive). Default value is 12.

    Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.", + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 20 + }, + { + "name": "center", + "in": "query", + "description": "Coordinates of the center point. Format: 'lon,lat'. Projection used\n- EPSG:3857. Longitude range: -180 to 180. Latitude range: -85 to 85. \n\nNote: Either center or bbox are required parameters. They are\nmutually exclusive.", + "type": "string" + }, + { + "name": "bbox", + "in": "query", + "description": "Bounding box. Projection used - EPSG:3857. Format : 'minLon, minLat,\nmaxLon, maxLat'. \n\nNote: Either bbox or center are required\nparameters. They are mutually exclusive. It shouldn’t be used with\nheight or width.\n\nThe maximum allowed ranges for Lat and Lon are defined for each zoom level\nin the table at the top of this page.", + "type": "string" + }, + { + "name": "height", + "in": "query", + "description": "Height of the resulting image in pixels. Range is 1 to 8192. Default\nis 512. It shouldn’t be used with bbox.", + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 8192 + }, + { + "name": "width", + "in": "query", + "description": "Width of the resulting image in pixels. Range is 1 to 8192. Default is 512. It shouldn’t be used with bbox.", + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 8192 + }, + { + "$ref": "../../../Search/preview/1.0/search.json#/parameters/Language" + }, + { + "$ref": "../../../Search/preview/1.0/search.json#/parameters/View" + }, + { + "name": "pins", + "description": "Pushpin style and instances. Use this parameter to optionally add pushpins to the image.\nThe pushpin style describes the appearance of the pushpins, and the instances specify\nthe coordinates of the pushpins and optional labels for each pin. (Be sure to properly URL-encode values of this\nparameter since it will contain reserved characters such as pipes and punctuation.)\n\nThe Azure Maps account S0 SKU only supports a single instance of the pins parameter. Other SKUs\nallow multiple instances of the pins parameter to specify multiple pin styles.\n\nTo render a pushpin at latitude 45°N and longitude 122°W using the default built-in pushpin style, add the\nquerystring parameter \n\n`pins=default||-122 45` \n\nNote that the longitude comes before the latitude.\nAfter URL encoding this will look like\n\n`pins=default%7C%7C-122+45`\n\nAll of the examples here show the pins\nparameter without URL encoding, for clarity.\n\nTo render a pin at multiple locations, separate each location with a pipe character. For example, use\n\n`pins=default||-122 45|-119.5 43.2|-121.67 47.12`\n\nThe S0 Azure Maps account SKU only allows five pushpins. Other account SKUs do not have this limitation.\n\n### Style Modifiers\n\nYou can modify the appearance of the pins by adding style modifiers. These are added after the style but before\nthe locations and labels. Style modifiers each have a two-letter name. These abbreviated names are used to help\nreduce the length of the URL.\n\nTo change the color of the pushpin, use the 'co' style modifier and specify the color using the HTML/CSS RGB color\nformat which is a six-digit hexadecimal number (the three-digit form is not supported). For example, to use\na deep pink color which you would specify as #FF1493 in CSS, use\n\n`pins=default|coFF1493||-122 45`\n\n### Pushpin Labels\n\nTo add a label to the pins, put the label in single quotes just before the coordinates. For example, to label\nthree pins with the values '1', '2', and '3', use\n\n`pins=default||'1'-122 45|'2'-119.5 43.2|'3'-121.67 47.12`\n\nThere is a built in pushpin style called 'none' that does not display a pushpin image. You can use this if\nyou want to display labels without any pin image. For example,\n\n`pins=none||'A'-122 45|'B'-119.5 43.2`\n\nTo change the color of the pushpin labels, use the 'lc' label color style modifier. For example, to use pink\npushpins with black labels, use\n\n`pins=default|coFF1493|lc000000||-122 45`\n\nTo change the size of the labels, use the 'ls' label size style modifier. The label size represents the approximate\nheight of the label text in pixels. For example, to increase the label size to 12, use\n\n`pins=default|ls12||'A'-122 45|'B'-119 43`\n\nThe labels are centered at the pushpin 'label anchor.' The anchor location is predefined for built-in pushpins and\nis at the top center of custom pushpins (see below). To override the label anchor, using the 'la' style modifier\nand provide X and Y pixel coordinates for the anchor. These coordinates are relative to the top left corner of the\npushpin image. Positive X values move the anchor to the right, and positive Y values move the anchor down. For example,\nto position the label anchor 10 pixels right and 4 pixels above the top left corner of the pushpin image,\nuse\n\n`pins=default|la10 -4||'A'-122 45|'B'-119 43`\n\n### Custom Pushpins\n\nTo use a custom pushpin image, use the word 'custom' as the pin style name, and then specify a URL after the\nlocation and label information. Use two pipe characters to indicate that you're done specifying locations and are\nstarting the URL. For example,\n\n`pins=custom||-122 45||http://contoso.com/pushpins/red.png`\n\nAfter URL encoding, this would look like\n\n`pins=custom%7C%7C-122+45%7C%7Chttp%3A%2F%2Fcontoso.com%2Fpushpins%2Fred.png`\n\nBy default, custom pushpin images are drawn centered at the pin coordinates. This usually isn't ideal as it obscures\nthe location that you're trying to highlight. To override the anchor location of the pin image, use the 'an'\nstyle modifier. This uses the same format as the 'la' label anchor style modifier. For example, if your custom\npin image has the tip of the pin at the top left corner of the image, you can set the anchor to that spot by\nusing\n\n`pins=custom|an0 0||-122 45||http://contoso.com/pushpins/red.png`\n\nNote: If you use the 'co' color modifier with a custom pushpin image, the specified color will replace the RGB \nchannels of the pixels in the image but will leave the alpha (opacity) channel unchanged. This would usually\nonly be done with a solid-color custom image.\n\n### Getting Pushpins from Azure Maps Data Storage\n\nFor all Azure Maps account SKUs other than S0,\nthe pushpin image and location information can be obtained from Azure Maps Data Storage. After uploading a pushpin image\nor a GeoJSON document containing pin locations, the Data Storage service returns a Unique Data ID (UDID) that you can use\nto reference the data in the pins parameter.\n\nTo use a custom pushpin image from Azure Maps Data Storage, specify the UDID prefixed by 'udid-' as the name of the\npushpin style. For example,\n\n`pins=udid-fe22c504-3a81-4fcd-adc6-a3507ce866c1||-122 45`\n\nTo use the point geometry from an uploaded GeoJSON document as the pin locations, specify the UDID in the locations\nsection of the pins parameter. For example,\n\n`pins=default||udid-29dc105a-dee7-409f-a3f9-22b066ae4713`\n\nNote that\nonly point and multipoint geometry, points and multipoints from geometry collections, and point geometry from features\nwill be used. Linestring and polygon geometry will be ignored. If the point comes from a feature and the feature\nhas a string property called \"label\", the value of that property will be used as the label for the pin.\n\nYou can mix pin locations from Data Storage and pin locations specified in the pins parameter. Any of the pipe-delimited\npin locations can be a longitude and latitude or a UDID. For example,\n\n`pins=default||-122 45|udid-29dc105a-dee7-409f-a3f9-22b066ae4713|-119 43`\n\n### Scale, Rotation, and Opacity\n\nYou can make pushpins and their labels larger or smaller by using the 'sc' scale style modifier. This is a\nvalue greater than zero. A value of 1 is the standard scale. Values larger than 1 will make the pins larger, and\nvalues smaller than 1 will make them smaller. For example, to draw the pushpins 50% larger than normal, use\n\n`pins=default|sc1.5||-122 45`\n\nYou can rotate pushpins and their labels by using the 'ro' rotation style modifier. This is a number of degrees\nof clockwise rotation. Use a negative number to rotate counter-clockwise. For example, to rotate the pushpins\n90 degrees clockwise and double their size, use\n\n`pins=default|ro90|sc2||-122 45`\n\nYou can make pushpins and their labels partially transparent by specifying the 'al' alpha style modifier.\nThis is a number between 0 and 1 indicating the opacity of the pushpins. Zero makes them completely transparent\n(and not visible) and 1 makes them completely opaque (which is the default). For example, to make pushpins\nand their labels only 67% opaque, use\n\n`pins=default|al.67||-122 45`\n\n### Style Modifier Summary\n\nModifier | Description | Range \n:--------:|-----------------|------------------\nal | Alpha (opacity) | 0 to 1 \nan | Pin anchor | * \nco | Pin color | 000000 to FFFFFF \nla | Label anchor | * \nlc | Label color | 000000 to FFFFFF \nls | Label size | Greater than 0 \nro | Rotation | -360 to 360 \nsc | Scale | Greater than 0 \n\n* X and Y coordinates can be anywhere within pin image or a margin around it.\nThe margin size is the minimum of the pin width and height.", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + } + }, + { + "name": "path", + "description": "Path style and locations. Use this parameter to optionally add lines, polygons or circles to the image.\nThe path style describes the appearance of the line and fill. (Be sure to properly URL-encode values of this\nparameter since it will contain reserved characters such as pipes and punctuation.)\n\nPath parameter is supported in Azure Maps account SKU starting with S1. Multiple instances of the path parameter \nallow to specify multiple geometries with their styles. Number of parameters per request is limited to 10 and\nnumber of locations is limited to 100 per path.\n\nTo render a circle with radius 100 meters and center point at latitude 45°N and longitude 122°W using the default style, add the\nquerystring parameter \n\n`path=ra100||-122 45` \n\nNote that the longitude comes before the latitude.\nAfter URL encoding this will look like\n\n`path=ra100%7C%7C-122+45`\n\nAll of the examples here show the path parameter without URL encoding, for clarity.\n\nTo render a line, separate each location with a pipe character. For example, use\n\n`path=||-122 45|-119.5 43.2|-121.67 47.12`\n\nTo render a polygon, last location must be equal to the start location. For example, use\n\n`path=||-122 45|-119.5 43.2|-121.67 47.12|-122 45`\n\nLongitude and latitude values for locations of lines and polygons can be in the range from -360 to 360 to allow for rendering of geometries crossing the anti-meridian.\n\n### Style Modifiers\n\nYou can modify the appearance of the path by adding style modifiers. These are added before the locations. \nStyle modifiers each have a two-letter name. These abbreviated names are used to help reduce the length\nof the URL.\n\nTo change the color of the outline, use the 'lc' style modifier and specify the color using the HTML/CSS RGB color\nformat which is a six-digit hexadecimal number (the three-digit form is not supported). For example, to use\na deep pink color which you would specify as #FF1493 in CSS, use\n\n`path=lcFF1493||-122 45|-119.5 43.2`\n\nMultiple style modifiers may be combined together to create a more complex visual style.\n\n`lc0000FF|lw3|la0.60|fa0.50||-122.2 47.6|-122.2 47.7|-122.3 47.7|-122.3 47.6|-122.2 47.6`\n\n### Getting Path locations from Azure Maps Data Storage\n\nFor all Azure Maps account SKUs other than S0, the path location information can be obtained from Azure Maps Data Storage. \nAfter uploading a GeoJSON document containing path locations, the Data Storage service returns a Unique Data ID (UDID) that you can use\nto reference the data in the path parameter.\n\nTo use the point geometry from an uploaded GeoJSON document as the path locations, specify the UDID in the locations\nsection of the path parameter. For example,\n\n`path=||udid-29dc105a-dee7-409f-a3f9-22b066ae4713`\n\nNote the it is not allowed to mix path locations from Data Storage with locations specified in the path parameter. \n\n### Style Modifier Summary\n\nModifier | Description | Range \n:--------:|------------------------|------------------\nlc | Line color | 000000 to FFFFFF\nfc | Fill color | 000000 to FFFFFF\nla | Line alpha (opacity) | 0 to 1 \nfa | Fill alpha (opacity) | 0 to 1 \nlw | Line width | Greater than 0 \nra | Circle radius (meters) | Greater than 0", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + } + } + ], + "produces": [ + "application/json", + "image/jpeg", + "image/png", + "image/pbf", + "application/vnd.mapbox-vector-tile" + ], + "responses": { + "200": { + "description": "This image is returned from a successful Get Map Static Image call", + "schema": { + "type": "object", + "format": "file", + "readOnly": true + }, + "headers": { + "Content-Type": { + "type": "string", + "description": "The content-type for the response." + } + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/map/tile/{format}": { + "get": { + "description": "**Applies to**: S0 and S1 pricing tiers.\n\n\nFetches map tiles in vector or raster format typically to be integrated into a new map control or SDK. By default, Azure uses vector map tiles for its web map control (see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid))\n\n**Note**: Weather tiles are only available via [Get Map Tile V2 API](https://aka.ms/AzureMapsWeatherTiles). We recommend to start to use the new [Get Map Tile V2 API](https://aka.ms/GetMapTileV2).", + "operationId": "Render_GetMapTile", + "x-ms-examples": { + "GetMapTile": { + "$ref": "./examples/GetMapTile.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/RenderApiVersion" + }, + { + "$ref": "#/parameters/TileFormat" + }, + { + "name": "layer", + "in": "query", + "description": "Map layer requested. Possible values are basic, hybrid, labels and terra.", + "required": true, + "enum": [ + "basic", + "hybrid", + "labels", + "terra" + ], + "type": "string", + "x-ms-enum": { + "name": "MapTileLayer", + "modelAsString": true, + "values": [ + { + "value": "basic", + "description": "Returns a tile containing all map features including polygons, borders, roads and labels." + }, + { + "value": "hybrid", + "description": "Returns a tile containing borders, roads, and labels, and can be overlaid on other tiles (such as satellite imagery) to produce hybrid tiles." + }, + { + "value": "labels", + "description": "Returns a tile of just the map's label information." + }, + { + "value": "terra", + "description": "Map canvas complete with shaded relief tiles. Zoom levels 0-6 (inclusive) are supported. Png is the only supported TileFormat and only available MapTileSize is 512." + } + ] + } + }, + { + "name": "style", + "in": "query", + "description": "Map style to be returned. Possible values are main, dark, and shaded_relief.", + "required": true, + "type": "string", + "enum": [ + "main", + "dark", + "shaded_relief" + ], + "x-ms-enum": { + "name": "MapTileStyle", + "modelAsString": true, + "values": [ + { + "value": "main", + "description": "Azure Maps main style" + }, + { + "value": "dark", + "description": "Dark grey version of the Azure Maps main style. PNG is the only supported TileFormat." + }, + { + "value": "shaded_relief", + "description": "Azure Maps main style completed with shaded relief. Supported by Layer terra." + } + ] + } + }, + { + "$ref": "#/parameters/RasterVectorNaturalEarthZoom" + }, + { + "$ref": "#/parameters/xTileIndex" + }, + { + "$ref": "#/parameters/yTileIndex" + }, + { + "name": "tileSize", + "in": "query", + "description": "The size of the returned map tile in pixels.", + "type": "string", + "enum": [ + "256", + "512" + ], + "x-ms-enum": { + "name": "MapTileSize", + "modelAsString": true, + "values": [ + { + "value": "256", + "description": "Return a 256 by 256 pixel tile." + }, + { + "value": "512", + "description": "Return a 512 by 512 pixel tile." + } + ] + } + }, + { + "$ref": "../../../Search/preview/1.0/search.json#/parameters/Language" + }, + { + "$ref": "../../../Search/preview/1.0/search.json#/parameters/View" + } + ], + "produces": [ + "application/json", + "image/jpeg", + "image/png", + "image/pbf", + "application/vnd.mapbox-vector-tile" + ], + "responses": { + "200": { + "description": "This image is returned from a successful Get Map Tile call", + "schema": { + "type": "object", + "format": "file", + "readOnly": true + }, + "headers": { + "Content-Type": { + "type": "string", + "description": "The content-type for the response." + } + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/map/statetile": { + "get": { + "description": "**Applies to**: S0 and S1 pricing tiers.\n\n\nFetches state tiles in vector format typically to be integrated into indoor maps module of map control or SDK. The map control will call this API after user turns on dynamic styling (see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid))", + "operationId": "Render_GetMapStateTilePreview", + "x-ms-examples": { + "GetMapStateTile": { + "$ref": "./examples/GetMapStateTile.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/RenderApiVersion" + }, + { + "$ref": "#/parameters/VectorZoom" + }, + { + "$ref": "#/parameters/xTileIndex" + }, + { + "$ref": "#/parameters/yTileIndex" + }, + { + "name": "statesetId", + "in": "query", + "description": "The stateset id.", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/vnd.mapbox-vector-tile", + "application/json" + ], + "responses": { + "200": { + "description": "This tile is returned from a successful Get Map State Tile call", + "schema": { + "type": "object", + "format": "file", + "readOnly": true + }, + "headers": { + "Content-Type": { + "type": "string", + "description": "The content-type for the response." + } + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/map/copyright/caption/{format}": { + "get": { + "description": "**Applies to**: S0 and S1 pricing tiers.\n\n\n\nCopyrights API is designed to serve copyright information for Render Tile \nservice. In addition to basic copyright for the whole map, API is serving \nspecific groups of copyrights for some countries.\n\nAs an alternative to copyrights for map request, one can receive captions\nfor displaying the map provider information on the map.", + "operationId": "Render_GetCopyrightCaption", + "x-ms-examples": { + "GetCopyrightCaption": { + "$ref": "./examples/GetCopyrightCaption.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/RenderApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/TextFormat" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GetCopyrightCaptionResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/map/imagery/{format}": { + "get": { + "description": "**Applies to:** S1 pricing tier.\n\n\nThis service returns a map image tile with size 256x256, given the x and y coordinates and zoom\nlevel. Zoom level ranges from 1 to 19. The current available style value is 'satellite' which provides satellite\nimagery alone.\n\n\n**Note**: We recommend to start to use the new [Get Map Tile V2 API](https://aka.ms/GetMapTileV2).", + "operationId": "Render_GetMapImageryTile", + "x-ms-examples": { + "GetMapImageryTile": { + "$ref": "./examples/GetMapImageryTile.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/RenderApiVersion" + }, + { + "$ref": "#/parameters/RasterTileFormat" + }, + { + "name": "style", + "in": "query", + "description": "Map style to be returned. __Possible values:__ satellite.", + "required": true, + "type": "string", + "enum": [ + "satellite" + ], + "x-ms-enum": { + "name": "MapImageryStyle", + "modelAsString": true, + "values": [ + { + "value": "satellite", + "description": "Satellite imagery" + } + ] + } + }, + { + "$ref": "#/parameters/ImageryRasterZoom" + }, + { + "$ref": "#/parameters/xTileIndex" + }, + { + "$ref": "#/parameters/yTileIndex" + } + ], + "produces": [ + "application/json", + "image/jpeg", + "image/png" + ], + "responses": { + "200": { + "description": "This image is returned from a successful Get Map Imagery Tile call", + "schema": { + "type": "object", + "format": "file", + "readOnly": true + }, + "headers": { + "Content-Type": { + "type": "string", + "description": "The content-type for the response." + } + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/map/copyright/bounding/{format}": { + "get": { + "description": "**Applies to**: S0 and S1 pricing tiers.\n\n\nReturns copyright information for a given bounding box. Bounding-box requests should specify the minimum and maximum longitude and latitude (EPSG-3857) coordinates", + "operationId": "Render_GetCopyrightFromBoundingBox", + "x-ms-examples": { + "GetCopyrightFromBoundingBox": { + "$ref": "./examples/GetCopyrightFromBoundingBox.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/RenderApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/TextFormat" + }, + { + "name": "mincoordinates", + "in": "query", + "description": "Minimum coordinates of bounding box in latitude longitude coordinate system. E.g. 52.41064,4.84228", + "required": true, + "type": "string" + }, + { + "name": "maxcoordinates", + "in": "query", + "description": "Maximum coordinates of bounding box in latitude longitude coordinate system. E.g. 52.41064,4.84228", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/IncludeText" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GetCopyrightFromBoundingBoxResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/map/copyright/tile/{format}": { + "get": { + "description": "**Applies to**: S0 and S1 pricing tiers.\n\n\n\nCopyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries.\nReturns the copyright information for a given tile. To obtain the copyright information for a particular tile, the request should specify the tile's zoom level and x and y coordinates (see: Zoom Levels and Tile Grid).", + "operationId": "Render_GetCopyrightForTile", + "x-ms-examples": { + "GetCopyrightForTile": { + "$ref": "./examples/GetCopyrightForTile.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/RenderApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/TextFormat" + }, + { + "$ref": "#/parameters/RasterZoom18" + }, + { + "$ref": "#/parameters/xTileIndex" + }, + { + "$ref": "#/parameters/yTileIndex" + }, + { + "$ref": "#/parameters/IncludeText" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GetCopyrightForTileResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/map/copyright/world/{format}": { + "get": { + "description": "**Applies to**: S0 and S1 pricing tiers.\n\n\nCopyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries.\nReturns the copyright information for the world. To obtain the default copyright information for the whole world, do not specify a tile or bounding box.", + "operationId": "Render_GetCopyrightForWorld", + "x-ms-examples": { + "GetCopyrightForWorld": { + "$ref": "./examples/GetCopyrightForWorld.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/RenderApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/TextFormat" + }, + { + "$ref": "#/parameters/IncludeText" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GetCopyrightForWorldResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + } + }, + "definitions": { + "GetCopyrightFromBoundingBoxResult": { + "description": "This object is returned from a successful Get Copyright From Bounding Box call", + "type": "object", + "properties": { + "formatVersion": { + "description": "Format Version property", + "type": "string", + "readOnly": true + }, + "generalCopyrights": { + "description": "General Copyrights array", + "type": "array", + "readOnly": true, + "items": { + "type": "string", + "readOnly": true + } + }, + "regions": { + "description": "Regions array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RegionCopyrights" + } + } + } + }, + "RegionCopyrights": { + "type": "object", + "properties": { + "copyrights": { + "description": "Copyrights array", + "type": "array", + "readOnly": true, + "items": { + "type": "string", + "readOnly": true + } + }, + "country": { + "description": "Country property", + "type": "object", + "readOnly": true, + "properties": { + "ISO3": { + "description": "ISO3 property", + "type": "string", + "readOnly": true + }, + "label": { + "description": "Label property", + "type": "string", + "readOnly": true + } + } + } + } + }, + "GetCopyrightCaptionResult": { + "description": "This object is returned from a successful Get Copyright Caption call", + "type": "object", + "properties": { + "formatVersion": { + "description": "Format Version property", + "type": "string", + "readOnly": true + }, + "copyrightsCaption": { + "description": "Copyrights Caption property", + "type": "string", + "readOnly": true + } + } + }, + "GetCopyrightForWorldResult": { + "description": "This object is returned from a successful Get Copyright For World call", + "type": "object", + "properties": { + "formatVersion": { + "description": "Format Version property", + "type": "string", + "readOnly": true + }, + "generalCopyrights": { + "description": "General Copyrights array", + "type": "array", + "readOnly": true, + "items": { + "type": "string", + "readOnly": true + } + }, + "regions": { + "description": "Regions array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RegionCopyrights" + } + } + } + }, + "GetCopyrightForTileResult": { + "description": "This object is returned from a successful Get Copyright For Tile call", + "type": "object", + "properties": { + "formatVersion": { + "description": "Format Version property", + "type": "string", + "readOnly": true + }, + "generalCopyrights": { + "description": "General Copyrights array", + "type": "array", + "readOnly": true, + "items": { + "type": "string", + "readOnly": true + } + }, + "regions": { + "description": "Regions array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RegionCopyrights" + } + } + } + } + } +} diff --git a/specification/maps/data-plane/Render/preview/2.0/examples/GetMapTileV2.json b/specification/maps/data-plane/Render/preview/2.0/examples/GetMapTileV2.json new file mode 100644 index 000000000000..589af57c24fe --- /dev/null +++ b/specification/maps/data-plane/Render/preview/2.0/examples/GetMapTileV2.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "tilesetId": "microsoft.base", + "zoom": 6, + "x": 10, + "y": 22 + }, + "responses": { + "200": { + "headers": { + "Content-Type": "application/vnd.mapbox-vector-tile" + }, + "body": "{file}" + } + } +} diff --git a/specification/maps/data-plane/Render/preview/2.0/render.json b/specification/maps/data-plane/Render/preview/2.0/render.json new file mode 100644 index 000000000000..80e8b03b3116 --- /dev/null +++ b/specification/maps/data-plane/Render/preview/2.0/render.json @@ -0,0 +1,243 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Render Service", + "version": "2.0", + "description": "Azure Maps Render REST APIs" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{geography}.atlas.microsoft.com", + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "AzureKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "AzureKey": [] + } + ], + "responses": {}, + "parameters": { + "RenderApiVersionV2": { + "name": "api-version", + "description": "Version number of Azure Maps API.", + "type": "string", + "in": "query", + "required": true, + "default": "2.0", + "x-ms-parameter-location": "client" + }, + "TilesetId_rv2": { + "name": "tilesetId", + "description": "A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/en-us/rest/api/maps/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base.", + "type": "string", + "in": "query", + "required": true, + "enum": [ + "microsoft.base", + "microsoft.base.labels", + "microsoft.base.hybrid", + "microsoft.terra.main", + "microsoft.base.road", + "microsoft.base.darkgrey", + "microsoft.base.labels.road", + "microsoft.base.hybrid.road", + "microsoft.imagery", + "microsoft.weather.radar.main", + "microsoft.weather.infrared.main", + "microsoft.dem" + ], + "x-ms-enum": { + "name": "TilesetID", + "modelAsString": true, + "values": [ + { + "value": "microsoft.base", + "description": "A base map is a standard map that displays roads, natural and artificial features along with the labels for those features in a vector tile.
    \n\nSupports zoom levels 0 through 22. Format: vector (pbf)." + }, + { + "value": "microsoft.base.labels", + "description": "Displays labels for roads, natural and artificial features in a vector tile.
    \n\nSupports zoom levels 0 through 22. Format: vector (pbf)." + }, + { + "value": "microsoft.base.hybrid", + "description": "Displays road, boundary and label data in a vector tile.
    \n\nSupports zoom levels 0 through 22. Format: vector (pbf)." + }, + { + "value": "microsoft.terra.main", + "description": "Shaded relief and terra layers.
    \n\nSupports zoom levels 0 through 6. Format: raster (png)." + }, + { + "value": "microsoft.base.road", + "description": "All layers with our main style.
    \n\nSupports zoom levels 0 through 22. Format: raster (png)." + }, + { + "value": "microsoft.base.darkgrey", + "description": "All layers with our dark grey style.
    \n\nSupports zoom levels 0 through 22. Format: raster (png)." + }, + { + "value": "microsoft.base.labels.road", + "description": "Label data in our main style.
    \n\nSupports zoom levels 0 through 22. Format: raster (png)." + }, + { + "value": "microsoft.base.hybrid.road", + "description": "Road, boundary and label data in our main style.
    \n\nSupports zoom levels 0 through 22. Format: raster (png)." + }, + { + "value": "microsoft.imagery", + "description": "A combination of satellite and aerial imagery. Only available in S1 pricing SKU.
    \n\nSupports zoom levels 1 through 19. Format: raster (jpeg)." + }, + { + "value": "microsoft.weather.radar.main", + "description": "Weather radar tiles. Latest weather radar images including areas of rain, snow, ice and mixed conditions. Please see [coverage information](https://aka.ms/AzureMapsWeatherCoverage) for Azure Maps Weather service. To learn more about the Radar data, please see [Weather concepts](https://aka.ms/AzureMapsWeatherConcepts).
    \n\nSupports zoom levels 0 through 15. Format: raster (png)." + }, + { + "value": "microsoft.weather.infrared.main", + "description": "Weather infrared tiles. Latest Infrared Satellite images shows clouds by their temperature. Please see [coverage information](https://aka.ms/AzureMapsWeatherCoverage) for Azure Maps Weather service. To learn more about the returned Satellite data, please see [Weather concepts](https://aka.ms/AzureMapsWeatherConcepts).
    \n\nSupports zoom levels 0 through 15. Format: raster (png)." + }, + { + "value": "microsoft.dem", + "description": "Digital Elevation Model tiles. The tiles are in the GeoTIFF format with a single 32-bit floating point band. The tiles cover the whole landmass of Earth. Some small islands (e.g., atolls) might not be represented accurately.
    \n* The vertical unit for measurement of elevation height is meters. An elevation value of -32767.0 is used for points that have no data value, most often returned where there isn't landmass (i.e. water).
    \n* The horizontal reference datum is the World Geodetic System 1984 (WGS84-G1150) and the vertical reference datum is the Earth Gravitational Model 2008 (EGM2008).
    \n* Tiles are 258x258 pixel squares rather than the standard 256 x 256. This is done to allow for accurate interpolation of values at the tile edges. As such adjacent tiles overlap by 1 pixel along all edges.
    \n* Tile data comes from the [Airbus WorldDEM4Ortho product](https://www.intelligence-airbusds.com/worlddem-streaming/). Urban areas are approximately leveled down to ground level. All other areas are represented by the object surface level (e.g., trees).
    \n\nSupports zoom level 13 only. Format: raster (tiff)." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "MapTileV2Zoom": { + "name": "zoom", + "in": "query", + "description": "Zoom level for the desired tile. Please find TilesetID list below for more details on supported zoom level for each tilesetId.
    \n\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.", + "required": true, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/map/tile": { + "get": { + "description": "**Applies to**: S0 and S1 pricing tiers.\n\nThe Get Map Tiles API allows users to request map tiles in vector or raster formats typically to be integrated into a map control or SDK. Some example tiles that can be requested are Azure Maps road tiles, real-time Weather Radar tiles or the map tiles created using [Azure Maps Creator](https://aka.ms/amcreator). By default, Azure Maps uses vector tiles for its web map control (Web SDK) and Android SDK.", + "operationId": "RenderV2_GetMapTilePreview", + "x-ms-examples": { + "GetMapTile": { + "$ref": "./examples/GetMapTileV2.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/RenderApiVersionV2" + }, + { + "$ref": "#/parameters/TilesetId_rv2" + }, + { + "$ref": "#/parameters/MapTileV2Zoom" + }, + { + "$ref": "../1.0/render.json#/parameters/xTileIndex" + }, + { + "$ref": "../1.0/render.json#/parameters/yTileIndex" + }, + { + "name": "timeStamp", + "in": "query", + "description": "The desired date and time of the requested tile. This parameter must be specified in the standard date-time format (e.g. 2019-11-14T16:03:00-08:00), as defined by [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). This parameter is only supported when tilesetId parameter is set to one of the values below.\n \n* microsoft.weather.infrared.main: We provide tiles up to 3 hours in the past. Tiles are available in 10-minute intervals. We round the timeStamp value to the nearest 10-minute time frame.\n* microsoft.weather.radar.main: We provide tiles up to 1.5 hours in the past and up to 2 hours in the future. Tiles are available in 5-minute intervals. We round the timeStamp value to the nearest 5-minute time frame.", + "type": "string", + "format": "date-time" + }, + { + "name": "tileSize", + "in": "query", + "description": "The size of the returned map tile in pixels.", + "type": "string", + "enum": [ + "256", + "512" + ], + "x-ms-enum": { + "name": "TileSize", + "modelAsString": true, + "values": [ + { + "value": "256", + "description": "Return a 256 by 256 pixel tile. Available for all tilesetIds except for\n* microsoft.terra.main" + }, + { + "value": "512", + "description": "Return a 512 by 512 pixel tile. Available for all tilesetIds except for \n* microsoft.weather.radar.main\n* microsoft.weather.infrared.main\n* microsoft.base.hybrid\n* microsoft.dem\n* microsoft.imagery" + } + ] + } + }, + { + "$ref": "../../../Search/preview/1.0/search.json#/parameters/Language" + }, + { + "$ref": "../../../Search/preview/1.0/search.json#/parameters/View" + } + ], + "produces": [ + "application/json", + "image/jpeg", + "image/png", + "image/pbf", + "application/vnd.mapbox-vector-tile" + ], + "responses": { + "200": { + "description": "The tile returned from a successful API call.", + "schema": { + "type": "object", + "format": "file", + "readOnly": true + }, + "headers": { + "Content-Type": { + "type": "string", + "description": "The content-type for the response." + } + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + } + } +} diff --git a/specification/maps/data-plane/Render/readme.csharp.md b/specification/maps/data-plane/Render/readme.csharp.md new file mode 100644 index 000000000000..0748772fc5b9 --- /dev/null +++ b/specification/maps/data-plane/Render/readme.csharp.md @@ -0,0 +1,13 @@ +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +sync-methods: None +license-header: MICROSOFT_MIT_NO_VERSION +namespace: Azure.Maps.Render +output-folder: $(csharp-sdks-folder)/maps/Azure.Maps.Render/src/Generated +clear-output-folder: true +public-clients: true +``` \ No newline at end of file diff --git a/specification/maps/data-plane/Render/readme.go.md b/specification/maps/data-plane/Render/readme.go.md new file mode 100644 index 000000000000..d7a8bb1a3b80 --- /dev/null +++ b/specification/maps/data-plane/Render/readme.go.md @@ -0,0 +1,26 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +license-header: MICROSOFT_MIT_NO_VERSION +namespace: render +clear-output-folder: true +export-clients: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: 2.0-preview +``` + +### Tag: 2.0-preview and go + +These settings apply only when `--tag=2.0-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == '2.0-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/maps/2.0/$(namespace) +``` \ No newline at end of file diff --git a/specification/maps/data-plane/Render/readme.java.md b/specification/maps/data-plane/Render/readme.java.md new file mode 100644 index 000000000000..d29cb26ee591 --- /dev/null +++ b/specification/maps/data-plane/Render/readme.java.md @@ -0,0 +1,9 @@ +## Java + +``` yaml $(java) +java: + namespace: com.azure.maps.render + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 0 + output-folder: $(azure-libraries-for-java-folder)/azure-maps-render +``` \ No newline at end of file diff --git a/specification/maps/data-plane/Render/readme.md b/specification/maps/data-plane/Render/readme.md new file mode 100644 index 000000000000..ef50275bae4f --- /dev/null +++ b/specification/maps/data-plane/Render/readme.md @@ -0,0 +1,90 @@ +# Azure Render + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Render Client + +--- + +## Getting Started + +To build the SDK for Render, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +### Basic Information + +These are the global settings for Render Client. + +``` yaml +title: RenderClient +openapi-type: data-plane +tag: 2.0-preview +# at some point those credentials will move away to Swagger according to [this](https://github.com/Azure/autorest/issues/3718) +add-credentials: true +credential-default-policy-type: BearerTokenCredentialPolicy +credential-scopes: https://atlas.microsoft.com/.default +``` + + +### Tag: 2.0-preview + +These settings apply only when `--tag=2.0-preview` is specified on the command line. + +``` yaml $(tag) == '2.0-preview' +input-file: + - preview/1.0/render.json + - preview/2.0/render.json +``` + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-java + + #track1 doesn't support data-plane for go + #manually generate for now with track2 + #- repo: azure-sdk-for-go + + #track1 doesn't support features needed for typescript + #manually generate for now with track2 + #- repo: azure-sdk-for-js + + #should be azure-sdk-for-net-track2, but SDK has not yet onboarded + #manually generate for now with track2 + - repo: azure-sdk-for-net +``` +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Java + +See configuration in [readme.java.md](./readme.java.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) diff --git a/specification/maps/data-plane/Render/readme.python.md b/specification/maps/data-plane/Render/readme.python.md new file mode 100644 index 000000000000..7e61eefced21 --- /dev/null +++ b/specification/maps/data-plane/Render/readme.python.md @@ -0,0 +1,22 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +license-header: MICROSOFT_MIT_NO_VERSION +namespace: azure.maps.render +package-name: azure-maps-render +package-version: 2.0-preview +clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +no-namespace-folders: true +output-folder: $(python-sdks-folder)/maps/azure-maps-render/azure/maps/render +``` +``` yaml $(python) && $(python-mode) == 'create' +basic-setup-py: true +output-folder: $(python-sdks-folder)/maps/azure-maps-render +``` diff --git a/specification/maps/data-plane/Render/readme.typescript.md b/specification/maps/data-plane/Render/readme.typescript.md new file mode 100644 index 000000000000..7ef8034eeed4 --- /dev/null +++ b/specification/maps/data-plane/Render/readme.typescript.md @@ -0,0 +1,14 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +azure-arm: false +package-name: "@azure/maps-render" +license-header: MICROSOFT_MIT_NO_VERSION +output-folder: "$(typescript-sdks-folder)/sdk/maps/maps-render" +source-code-folder-path: "" +clear-output-folder: false +generate-metadata: false +``` diff --git a/specification/maps/data-plane/Route/preview/1.0/examples/GetRouteDirections.json b/specification/maps/data-plane/Route/preview/1.0/examples/GetRouteDirections.json new file mode 100644 index 000000000000..942b27eba948 --- /dev/null +++ b/specification/maps/data-plane/Route/preview/1.0/examples/GetRouteDirections.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "query": "52.50931,13.42936:52.50274,13.43872" + }, + "responses": { + "200": { + "body": { + "formatVersion": "0.0.12", + "routes": [ + { + "summary": { + "lengthInMeters": 1147, + "travelTimeInSeconds": 162, + "trafficDelayInSeconds": 0, + "departureTime": "2017-09-07T16:56:58+00:00", + "arrivalTime": "2017-09-07T16:59:40+00:00" + }, + "legs": [ + { + "summary": { + "lengthInMeters": 1147, + "travelTimeInSeconds": 162, + "trafficDelayInSeconds": 0, + "departureTime": "2017-09-07T16:56:58+00:00", + "arrivalTime": "2017-09-07T16:59:40+00:00" + }, + "points": [ + { + "latitude": 52.50931, + "longitude": 13.42937 + }, + { + "latitude": 52.50904, + "longitude": 13.42912 + }, + { + "latitude": 52.50894, + "longitude": 13.42904 + }, + { + "latitude": 52.50867, + "longitude": 13.42879 + }, + { + "latitude": 52.5084, + "longitude": 13.42857 + }, + { + "latitude": 52.50791, + "longitude": 13.42824 + }, + { + "latitude": 52.50757, + "longitude": 13.42772 + }, + { + "latitude": 52.50735, + "longitude": 13.42823 + }, + { + "latitude": 52.5073, + "longitude": 13.42836 + }, + { + "latitude": 52.50573, + "longitude": 13.43194 + }, + { + "latitude": 52.50512, + "longitude": 13.43336 + }, + { + "latitude": 52.50464, + "longitude": 13.43451 + }, + { + "latitude": 52.5045, + "longitude": 13.43481 + }, + { + "latitude": 52.50443, + "longitude": 13.43498 + }, + { + "latitude": 52.50343, + "longitude": 13.43737 + }, + { + "latitude": 52.50274, + "longitude": 13.43872 + } + ] + } + ], + "sections": [ + { + "startPointIndex": 0, + "endPointIndex": 15, + "sectionType": "TRAVEL_MODE", + "travelMode": "car" + } + ] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Route/preview/1.0/examples/GetRouteDirectionsBatch.json b/specification/maps/data-plane/Route/preview/1.0/examples/GetRouteDirectionsBatch.json new file mode 100644 index 000000000000..c07f0afe9931 --- /dev/null +++ b/specification/maps/data-plane/Route/preview/1.0/examples/GetRouteDirectionsBatch.json @@ -0,0 +1,152 @@ +{ + "parameters": { + "geography": "us", + "format": "11111111-2222-3333-4444-555555555555", + "api-version": "1.0" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "batchItems": [ + { + "statusCode": 400, + "response": { + "error": { + "code": "400 BadRequest", + "message": "maxAlternatives parameter value should be between 0 and 5 inclusive" + } + } + }, + { + "statusCode": 200, + "response": { + "formatVersion": "0.0.12", + "routes": [ + { + "summary": { + "lengthInMeters": 1754, + "travelTimeInSeconds": 386, + "trafficDelayInSeconds": 0, + "departureTime": "2019-06-21T22:56:23+00:00", + "arrivalTime": "2019-06-21T23:02:49+00:00" + }, + "legs": [ + { + "summary": { + "lengthInMeters": 1754, + "travelTimeInSeconds": 386, + "trafficDelayInSeconds": 0, + "departureTime": "2019-06-21T22:56:23+00:00", + "arrivalTime": "2019-06-21T23:02:49+00:00" + }, + "points": [ + { + "latitude": 47.62094, + "longitude": -122.34892 + }, + { + "latitude": 47.62094, + "longitude": -122.3485 + }, + { + "latitude": 47.62095, + "longitude": -122.3476 + }, + { + "latitude": 47.60995, + "longitude": -122.34174 + }, + { + "latitude": 47.61011, + "longitude": -122.342 + } + ] + } + ], + "sections": [ + { + "startPointIndex": 0, + "endPointIndex": 44, + "sectionType": "TRAVEL_MODE", + "travelMode": "bicycle" + } + ] + } + ] + } + }, + { + "statusCode": 200, + "response": { + "formatVersion": "0.0.12", + "routes": [ + { + "summary": { + "lengthInMeters": 1772, + "travelTimeInSeconds": 1276, + "trafficDelayInSeconds": 0, + "departureTime": "2019-06-21T22:56:23+00:00", + "arrivalTime": "2019-06-21T23:17:38+00:00" + }, + "legs": [ + { + "summary": { + "lengthInMeters": 1772, + "travelTimeInSeconds": 1276, + "trafficDelayInSeconds": 0, + "departureTime": "2019-06-21T22:56:23+00:00", + "arrivalTime": "2019-06-21T23:17:38+00:00" + }, + "points": [ + { + "latitude": 40.75982, + "longitude": -73.98493 + }, + { + "latitude": 40.7601, + "longitude": -73.98483 + }, + { + "latitude": 40.75984, + "longitude": -73.98417 + }, + { + "latitude": 40.76047, + "longitude": -73.9837 + }, + { + "latitude": 40.77095, + "longitude": -73.9736 + }, + { + "latitude": 40.77114, + "longitude": -73.97356 + } + ] + } + ], + "sections": [ + { + "startPointIndex": 0, + "endPointIndex": 47, + "sectionType": "TRAVEL_MODE", + "travelMode": "pedestrian" + } + ] + } + ] + } + } + ], + "summary": { + "successfulRequests": 2, + "totalRequests": 3 + } + } + }, + "202": { + "description": "Batch request was accepted but is still being processed. Please try again in some time." + } + } +} diff --git a/specification/maps/data-plane/Route/preview/1.0/examples/GetRouteMatrix.json b/specification/maps/data-plane/Route/preview/1.0/examples/GetRouteMatrix.json new file mode 100644 index 000000000000..207804bf7ae6 --- /dev/null +++ b/specification/maps/data-plane/Route/preview/1.0/examples/GetRouteMatrix.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "geography": "us", + "format": "11111111-2222-3333-4444-555555555555", + "api-version": "1.0" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "formatVersion": "0.0.1", + "matrix": [ + [ + { + "statusCode": 200, + "response": { + "routeSummary": { + "lengthInMeters": 495, + "travelTimeInSeconds": 134, + "trafficDelayInSeconds": 0, + "departureTime": "2018-07-27T22:55:29+00:00", + "arrivalTime": "2018-07-27T22:57:43+00:00" + } + } + }, + { + "statusCode": 200, + "response": { + "routeSummary": { + "lengthInMeters": 647651, + "travelTimeInSeconds": 26835, + "trafficDelayInSeconds": 489, + "departureTime": "2018-07-27T22:55:29+00:00", + "arrivalTime": "2018-07-28T06:22:44+00:00" + } + } + } + ], + [ + { + "statusCode": 200, + "response": { + "routeSummary": { + "lengthInMeters": 338, + "travelTimeInSeconds": 104, + "trafficDelayInSeconds": 0, + "departureTime": "2018-07-27T22:55:29+00:00", + "arrivalTime": "2018-07-27T22:57:13+00:00" + } + } + }, + { + "statusCode": 200, + "response": { + "routeSummary": { + "lengthInMeters": 647494, + "travelTimeInSeconds": 26763, + "trafficDelayInSeconds": 469, + "departureTime": "2018-07-27T22:55:29+00:00", + "arrivalTime": "2018-07-28T06:21:32+00:00" + } + } + } + ] + ], + "summary": { + "successfulRoutes": 4, + "totalRoutes": 4 + } + } + }, + "202": { + "headers": {} + } + } +} diff --git a/specification/maps/data-plane/Route/preview/1.0/examples/GetRouteRange.json b/specification/maps/data-plane/Route/preview/1.0/examples/GetRouteRange.json new file mode 100644 index 000000000000..868987b7241e --- /dev/null +++ b/specification/maps/data-plane/Route/preview/1.0/examples/GetRouteRange.json @@ -0,0 +1,224 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "query": "50.97452,5.86605", + "timeBudgetInSec": 6000 + }, + "responses": { + "200": { + "body": { + "formatVersion": "0.0.1", + "reachableRange": { + "center": { + "latitude": 50.9745, + "longitude": 5.86605 + }, + "boundary": [ + { + "latitude": 52.03704, + "longitude": 5.73602 + }, + { + "latitude": 52.09456, + "longitude": 5.59435 + }, + { + "latitude": 52.16815, + "longitude": 5.42279 + }, + { + "latitude": 52.25047, + "longitude": 5.21276 + }, + { + "latitude": 52.21374, + "longitude": 5.15355 + }, + { + "latitude": 52.25674, + "longitude": 4.96687 + }, + { + "latitude": 52.07834, + "longitude": 4.739 + }, + { + "latitude": 52.05647, + "longitude": 4.72513 + }, + { + "latitude": 51.94553, + "longitude": 4.53237 + }, + { + "latitude": 51.70119, + "longitude": 4.31165 + }, + { + "latitude": 51.5837, + "longitude": 4.28917 + }, + { + "latitude": 51.48463, + "longitude": 3.82685 + }, + { + "latitude": 51.21096, + "longitude": 3.62838 + }, + { + "latitude": 50.681399999999996, + "longitude": 3.89244 + }, + { + "latitude": 50.66791, + "longitude": 3.93493 + }, + { + "latitude": 50.49042, + "longitude": 3.98156 + }, + { + "latitude": 50.30944, + "longitude": 4.47995 + }, + { + "latitude": 50.24448, + "longitude": 4.60502 + }, + { + "latitude": 50.24467, + "longitude": 4.89999 + }, + { + "latitude": 50.08735, + "longitude": 5.04206 + }, + { + "latitude": 49.99214, + "longitude": 5.23042 + }, + { + "latitude": 49.88478, + "longitude": 5.40994 + }, + { + "latitude": 49.85797, + "longitude": 5.46178 + }, + { + "latitude": 49.86279, + "longitude": 5.7196 + }, + { + "latitude": 49.83259, + "longitude": 5.74151 + }, + { + "latitude": 50.22239, + "longitude": 5.9387 + }, + { + "latitude": 50.0011, + "longitude": 6.08535 + }, + { + "latitude": 50.04616, + "longitude": 6.12089 + }, + { + "latitude": 50.09472, + "longitude": 6.28373 + }, + { + "latitude": 49.95863, + "longitude": 6.51654 + }, + { + "latitude": 50.00485, + "longitude": 6.61034 + }, + { + "latitude": 50.00587, + "longitude": 6.70295 + }, + { + "latitude": 50.2947, + "longitude": 6.65865 + }, + { + "latitude": 50.36903, + "longitude": 6.79276 + }, + { + "latitude": 50.31614, + "longitude": 7.32163 + }, + { + "latitude": 50.36737, + "longitude": 7.58782 + }, + { + "latitude": 50.46919, + "longitude": 7.7626 + }, + { + "latitude": 50.96246, + "longitude": 7.9826 + }, + { + "latitude": 51.07086, + "longitude": 7.55924 + }, + { + "latitude": 51.36614, + "longitude": 7.58138 + }, + { + "latitude": 51.52015, + "longitude": 7.67861 + }, + { + "latitude": 51.65781, + "longitude": 7.35175 + }, + { + "latitude": 51.81916, + "longitude": 7.21664 + }, + { + "latitude": 51.9587, + "longitude": 7.0467 + }, + { + "latitude": 51.82713, + "longitude": 6.67267 + }, + { + "latitude": 51.81133, + "longitude": 6.48424 + }, + { + "latitude": 51.9368, + "longitude": 6.27316 + }, + { + "latitude": 52.01701, + "longitude": 6.14452 + }, + { + "latitude": 52.20847, + "longitude": 6.09312 + }, + { + "latitude": 52.23705, + "longitude": 6.01297 + } + ] + } + } + } + } +} diff --git a/specification/maps/data-plane/Route/preview/1.0/examples/PostRouteDirections.json b/specification/maps/data-plane/Route/preview/1.0/examples/PostRouteDirections.json new file mode 100644 index 000000000000..d114884cbb3e --- /dev/null +++ b/specification/maps/data-plane/Route/preview/1.0/examples/PostRouteDirections.json @@ -0,0 +1,189 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "query": "52.50931,13.42936:52.50274,13.43872", + "postRouteDirectionsRequestBody": { + "supportingPoints": { + "type": "GeometryCollection", + "geometries": [ + { + "type": "Point", + "coordinates": [ + 13.42936, + 52.5093 + ] + }, + { + "type": "Point", + "coordinates": [ + 13.42859, + 52.50844 + ] + } + ] + }, + "avoidVignette": [ + "AUS", + "CHE" + ], + "avoidAreas": { + "type": "MultiPolygon", + "coordinates": [ + [ + [ + [ + -122.39456176757811, + 47.489368981370724 + ], + [ + -122.00454711914061, + 47.489368981370724 + ], + [ + -122.00454711914061, + 47.65151268066222 + ], + [ + -122.39456176757811, + 47.65151268066222 + ], + [ + -122.39456176757811, + 47.489368981370724 + ] + ] + ], + [ + [ + [ + 100.0, + 0.0 + ], + [ + 101.0, + 0.0 + ], + [ + 101.0, + 1.0 + ], + [ + 100.0, + 1.0 + ], + [ + 100.0, + 0.0 + ] + ] + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "formatVersion": "0.0.12", + "routes": [ + { + "summary": { + "lengthInMeters": 1147, + "travelTimeInSeconds": 162, + "trafficDelayInSeconds": 0, + "departureTime": "2017-09-07T16:56:58+00:00", + "arrivalTime": "2017-09-07T16:59:40+00:00" + }, + "legs": [ + { + "summary": { + "lengthInMeters": 1147, + "travelTimeInSeconds": 162, + "trafficDelayInSeconds": 0, + "departureTime": "2017-09-07T16:56:58+00:00", + "arrivalTime": "2017-09-07T16:59:40+00:00" + }, + "points": [ + { + "latitude": 52.50931, + "longitude": 13.42937 + }, + { + "latitude": 52.50904, + "longitude": 13.42912 + }, + { + "latitude": 52.50894, + "longitude": 13.42904 + }, + { + "latitude": 52.50867, + "longitude": 13.42879 + }, + { + "latitude": 52.5084, + "longitude": 13.42857 + }, + { + "latitude": 52.50791, + "longitude": 13.42824 + }, + { + "latitude": 52.50757, + "longitude": 13.42772 + }, + { + "latitude": 52.50735, + "longitude": 13.42823 + }, + { + "latitude": 52.5073, + "longitude": 13.42836 + }, + { + "latitude": 52.50573, + "longitude": 13.43194 + }, + { + "latitude": 52.50512, + "longitude": 13.43336 + }, + { + "latitude": 52.50464, + "longitude": 13.43451 + }, + { + "latitude": 52.5045, + "longitude": 13.43481 + }, + { + "latitude": 52.50443, + "longitude": 13.43498 + }, + { + "latitude": 52.50343, + "longitude": 13.43737 + }, + { + "latitude": 52.50274, + "longitude": 13.43872 + } + ] + } + ], + "sections": [ + { + "startPointIndex": 0, + "endPointIndex": 15, + "sectionType": "TRAVEL_MODE", + "travelMode": "car" + } + ] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Route/preview/1.0/examples/PostRouteDirectionsBatch.json b/specification/maps/data-plane/Route/preview/1.0/examples/PostRouteDirectionsBatch.json new file mode 100644 index 000000000000..595bd039a4a3 --- /dev/null +++ b/specification/maps/data-plane/Route/preview/1.0/examples/PostRouteDirectionsBatch.json @@ -0,0 +1,167 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "postRouteDirectionsBatchRequestBody": { + "batchItems": [ + { + "query": "?query=47.639987,-122.128384:47.621252,-122.184408:47.596437,-122.332000&routeType=fastest&travelMode=car&maxAlternatives=99" + }, + { + "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false" + }, + { + "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest" + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "batchItems": [ + { + "statusCode": 400, + "response": { + "error": { + "code": "400 BadRequest", + "message": "maxAlternatives parameter value should be between 0 and 5 inclusive" + } + } + }, + { + "statusCode": 200, + "response": { + "formatVersion": "0.0.12", + "routes": [ + { + "summary": { + "lengthInMeters": 1754, + "travelTimeInSeconds": 386, + "trafficDelayInSeconds": 0, + "departureTime": "2019-06-21T22:56:23+00:00", + "arrivalTime": "2019-06-21T23:02:49+00:00" + }, + "legs": [ + { + "summary": { + "lengthInMeters": 1754, + "travelTimeInSeconds": 386, + "trafficDelayInSeconds": 0, + "departureTime": "2019-06-21T22:56:23+00:00", + "arrivalTime": "2019-06-21T23:02:49+00:00" + }, + "points": [ + { + "latitude": 47.62094, + "longitude": -122.34892 + }, + { + "latitude": 47.62094, + "longitude": -122.3485 + }, + { + "latitude": 47.62095, + "longitude": -122.3476 + }, + { + "latitude": 47.60995, + "longitude": -122.34174 + }, + { + "latitude": 47.61011, + "longitude": -122.342 + } + ] + } + ], + "sections": [ + { + "startPointIndex": 0, + "endPointIndex": 44, + "sectionType": "TRAVEL_MODE", + "travelMode": "bicycle" + } + ] + } + ] + } + }, + { + "statusCode": 200, + "response": { + "formatVersion": "0.0.12", + "routes": [ + { + "summary": { + "lengthInMeters": 1772, + "travelTimeInSeconds": 1276, + "trafficDelayInSeconds": 0, + "departureTime": "2019-06-21T22:56:23+00:00", + "arrivalTime": "2019-06-21T23:17:38+00:00" + }, + "legs": [ + { + "summary": { + "lengthInMeters": 1772, + "travelTimeInSeconds": 1276, + "trafficDelayInSeconds": 0, + "departureTime": "2019-06-21T22:56:23+00:00", + "arrivalTime": "2019-06-21T23:17:38+00:00" + }, + "points": [ + { + "latitude": 40.75982, + "longitude": -73.98493 + }, + { + "latitude": 40.7601, + "longitude": -73.98483 + }, + { + "latitude": 40.75984, + "longitude": -73.98417 + }, + { + "latitude": 40.76047, + "longitude": -73.9837 + }, + { + "latitude": 40.77095, + "longitude": -73.9736 + }, + { + "latitude": 40.77114, + "longitude": -73.97356 + } + ] + } + ], + "sections": [ + { + "startPointIndex": 0, + "endPointIndex": 47, + "sectionType": "TRAVEL_MODE", + "travelMode": "pedestrian" + } + ] + } + ] + } + } + ], + "summary": { + "successfulRequests": 2, + "totalRequests": 3 + } + } + }, + "202": { + "headers": { + "Location": "URL to download the results of the long-running batch request." + } + } + } +} diff --git a/specification/maps/data-plane/Route/preview/1.0/examples/PostRouteDirectionsBatchSync.json b/specification/maps/data-plane/Route/preview/1.0/examples/PostRouteDirectionsBatchSync.json new file mode 100644 index 000000000000..eab66ded6b79 --- /dev/null +++ b/specification/maps/data-plane/Route/preview/1.0/examples/PostRouteDirectionsBatchSync.json @@ -0,0 +1,171 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "postRouteDirectionsBatchRequestBody": { + "batchItems": [ + { + "query": "?query=47.639987,-122.128384:47.621252,-122.184408:47.596437,-122.332000&routeType=fastest&travelMode=car&maxAlternatives=99" + }, + { + "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false" + }, + { + "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest" + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "batchItems": [ + { + "statusCode": 400, + "response": { + "error": { + "code": "400 BadRequest", + "message": "maxAlternatives parameter value should be between 0 and 5 inclusive" + } + } + }, + { + "statusCode": 200, + "response": { + "formatVersion": "0.0.12", + "routes": [ + { + "summary": { + "lengthInMeters": 1754, + "travelTimeInSeconds": 386, + "trafficDelayInSeconds": 0, + "departureTime": "2019-06-21T22:56:23+00:00", + "arrivalTime": "2019-06-21T23:02:49+00:00" + }, + "legs": [ + { + "summary": { + "lengthInMeters": 1754, + "travelTimeInSeconds": 386, + "trafficDelayInSeconds": 0, + "departureTime": "2019-06-21T22:56:23+00:00", + "arrivalTime": "2019-06-21T23:02:49+00:00" + }, + "points": [ + { + "latitude": 47.62094, + "longitude": -122.34892 + }, + { + "latitude": 47.62094, + "longitude": -122.3485 + }, + { + "latitude": 47.62095, + "longitude": -122.3476 + }, + { + "latitude": 47.60995, + "longitude": -122.34174 + }, + { + "latitude": 47.61011, + "longitude": -122.342 + } + ] + } + ], + "sections": [ + { + "startPointIndex": 0, + "endPointIndex": 44, + "sectionType": "TRAVEL_MODE", + "travelMode": "bicycle" + } + ] + } + ] + } + }, + { + "statusCode": 200, + "response": { + "formatVersion": "0.0.12", + "routes": [ + { + "summary": { + "lengthInMeters": 1772, + "travelTimeInSeconds": 1276, + "trafficDelayInSeconds": 0, + "departureTime": "2019-06-21T22:56:23+00:00", + "arrivalTime": "2019-06-21T23:17:38+00:00" + }, + "legs": [ + { + "summary": { + "lengthInMeters": 1772, + "travelTimeInSeconds": 1276, + "trafficDelayInSeconds": 0, + "departureTime": "2019-06-21T22:56:23+00:00", + "arrivalTime": "2019-06-21T23:17:38+00:00" + }, + "points": [ + { + "latitude": 40.75982, + "longitude": -73.98493 + }, + { + "latitude": 40.7601, + "longitude": -73.98483 + }, + { + "latitude": 40.75984, + "longitude": -73.98417 + }, + { + "latitude": 40.76047, + "longitude": -73.9837 + }, + { + "latitude": 40.77095, + "longitude": -73.9736 + }, + { + "latitude": 40.77114, + "longitude": -73.97356 + } + ] + } + ], + "sections": [ + { + "startPointIndex": 0, + "endPointIndex": 47, + "sectionType": "TRAVEL_MODE", + "travelMode": "pedestrian" + } + ] + } + ] + } + } + ], + "summary": { + "successfulRequests": 2, + "totalRequests": 3 + } + } + }, + "408": { + "headers": {}, + "body": { + "error": { + "code": "408 Timeout", + "message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api." + } + } + } + } +} diff --git a/specification/maps/data-plane/Route/preview/1.0/examples/PostRouteMatrix.json b/specification/maps/data-plane/Route/preview/1.0/examples/PostRouteMatrix.json new file mode 100644 index 000000000000..9798e3389e4f --- /dev/null +++ b/specification/maps/data-plane/Route/preview/1.0/examples/PostRouteMatrix.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "routeType": "shortest", + "postRouteMatrixRequestBody": { + "origins": { + "type": "MultiPoint", + "coordinates": [ + [ + 4.85106, + 52.36006 + ], + [ + 4.85056, + 52.36187 + ] + ] + }, + "destinations": { + "type": "MultiPoint", + "coordinates": [ + [ + 4.85003, + 52.36241 + ], + [ + 13.42937, + 52.50931 + ] + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "formatVersion": "0.0.1", + "matrix": [ + [ + { + "statusCode": 200, + "response": { + "routeSummary": { + "lengthInMeters": 495, + "travelTimeInSeconds": 134, + "trafficDelayInSeconds": 0, + "departureTime": "2018-07-27T22:55:29+00:00", + "arrivalTime": "2018-07-27T22:57:43+00:00" + } + } + }, + { + "statusCode": 200, + "response": { + "routeSummary": { + "lengthInMeters": 647651, + "travelTimeInSeconds": 26835, + "trafficDelayInSeconds": 489, + "departureTime": "2018-07-27T22:55:29+00:00", + "arrivalTime": "2018-07-28T06:22:44+00:00" + } + } + } + ], + [ + { + "statusCode": 200, + "response": { + "routeSummary": { + "lengthInMeters": 338, + "travelTimeInSeconds": 104, + "trafficDelayInSeconds": 0, + "departureTime": "2018-07-27T22:55:29+00:00", + "arrivalTime": "2018-07-27T22:57:13+00:00" + } + } + }, + { + "statusCode": 200, + "response": { + "routeSummary": { + "lengthInMeters": 647494, + "travelTimeInSeconds": 26763, + "trafficDelayInSeconds": 469, + "departureTime": "2018-07-27T22:55:29+00:00", + "arrivalTime": "2018-07-28T06:21:32+00:00" + } + } + } + ] + ], + "summary": { + "successfulRoutes": 4, + "totalRoutes": 4 + } + } + }, + "202": { + "headers": { + "Location": "New URL to check the status of the long running request." + } + } + } +} diff --git a/specification/maps/data-plane/Route/preview/1.0/examples/PostRouteMatrixSync.json b/specification/maps/data-plane/Route/preview/1.0/examples/PostRouteMatrixSync.json new file mode 100644 index 000000000000..488cf4aa9c1e --- /dev/null +++ b/specification/maps/data-plane/Route/preview/1.0/examples/PostRouteMatrixSync.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "routeType": "shortest", + "postRouteMatrixRequestBody": { + "origins": { + "type": "MultiPoint", + "coordinates": [ + [ + 4.85106, + 52.36006 + ], + [ + 4.85056, + 52.36187 + ] + ] + }, + "destinations": { + "type": "MultiPoint", + "coordinates": [ + [ + 4.85003, + 52.36241 + ], + [ + 13.42937, + 52.50931 + ] + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "formatVersion": "0.0.1", + "matrix": [ + [ + { + "statusCode": 200, + "response": { + "routeSummary": { + "lengthInMeters": 495, + "travelTimeInSeconds": 134, + "trafficDelayInSeconds": 0, + "departureTime": "2018-07-27T22:55:29+00:00", + "arrivalTime": "2018-07-27T22:57:43+00:00" + } + } + }, + { + "statusCode": 200, + "response": { + "routeSummary": { + "lengthInMeters": 647651, + "travelTimeInSeconds": 26835, + "trafficDelayInSeconds": 489, + "departureTime": "2018-07-27T22:55:29+00:00", + "arrivalTime": "2018-07-28T06:22:44+00:00" + } + } + } + ], + [ + { + "statusCode": 200, + "response": { + "routeSummary": { + "lengthInMeters": 338, + "travelTimeInSeconds": 104, + "trafficDelayInSeconds": 0, + "departureTime": "2018-07-27T22:55:29+00:00", + "arrivalTime": "2018-07-27T22:57:13+00:00" + } + } + }, + { + "statusCode": 200, + "response": { + "routeSummary": { + "lengthInMeters": 647494, + "travelTimeInSeconds": 26763, + "trafficDelayInSeconds": 469, + "departureTime": "2018-07-27T22:55:29+00:00", + "arrivalTime": "2018-07-28T06:21:32+00:00" + } + } + } + ] + ], + "summary": { + "successfulRoutes": 4, + "totalRoutes": 4 + } + } + }, + "408": { + "headers": {}, + "body": { + "error": { + "code": "408 Timeout", + "message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api." + } + } + } + } +} diff --git a/specification/maps/data-plane/Route/preview/1.0/route.json b/specification/maps/data-plane/Route/preview/1.0/route.json new file mode 100644 index 000000000000..4b6d685c88ab --- /dev/null +++ b/specification/maps/data-plane/Route/preview/1.0/route.json @@ -0,0 +1,2563 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Route Service", + "version": "1.0", + "description": "Azure Maps Route REST APIs" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{geography}.atlas.microsoft.com", + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "AzureKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "AzureKey": [] + } + ], + "responses": {}, + "parameters": { + "RouteApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API.", + "type": "string", + "in": "query", + "required": true, + "default": "1.0", + "x-ms-parameter-location": "client" + }, + "VehicleLoadType": { + "name": "vehicleLoadType", + "in": "query", + "description": "Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck.", + "type": "string", + "enum": [ + "USHazmatClass1", + "USHazmatClass2", + "USHazmatClass3", + "USHazmatClass4", + "USHazmatClass5", + "USHazmatClass6", + "USHazmatClass7", + "USHazmatClass8", + "USHazmatClass9", + "otherHazmatExplosive", + "otherHazmatGeneral", + "otherHazmatHarmfulToWater" + ], + "x-ms-enum": { + "name": "VehicleLoadType", + "modelAsString": true, + "values": [ + { + "value": "USHazmatClass1", + "description": "Explosives" + }, + { + "value": "USHazmatClass2", + "description": "Compressed gas" + }, + { + "value": "USHazmatClass3", + "description": "Flammable liquids" + }, + { + "value": "USHazmatClass4", + "description": "Flammable solids" + }, + { + "value": "USHazmatClass5", + "description": "Oxidizers" + }, + { + "value": "USHazmatClass6", + "description": "Poisons" + }, + { + "value": "USHazmatClass7", + "description": "Radioactive" + }, + { + "value": "USHazmatClass8", + "description": "Corrosives" + }, + { + "value": "USHazmatClass9", + "description": "Miscellaneous" + }, + { + "value": "otherHazmatExplosive", + "description": "Explosives" + }, + { + "value": "otherHazmatGeneral", + "description": "Miscellaneous" + }, + { + "value": "otherHazmatHarmfulToWater", + "description": "Harmful to water" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "RouteType": { + "name": "routeType", + "in": "query", + "description": "The type of route requested.", + "type": "string", + "enum": [ + "fastest", + "shortest", + "eco", + "thrilling" + ], + "x-ms-enum": { + "name": "RouteType", + "modelAsString": true, + "values": [ + { + "value": "fastest", + "description": "The fastest route." + }, + { + "value": "shortest", + "description": "The shortest route by distance." + }, + { + "value": "eco", + "description": "A route balanced by economy and speed." + }, + { + "value": "thrilling", + "description": "Includes interesting or challenging roads and uses as few motorways as possible. You can choose the level of turns included and also the degree of hilliness. See the hilliness and windingness parameters for how to set this. There is a limit of 900 km on routes planned with `routeType`=thrilling" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "WindingnessLevel": { + "name": "windingness", + "in": "query", + "description": "Level of turns for thrilling route. This parameter can only be used in conjunction with `routeType`=thrilling.", + "type": "string", + "enum": [ + "low", + "normal", + "high" + ], + "x-ms-enum": { + "name": "WindingnessLevel", + "modelAsString": true, + "values": [ + { + "value": "low", + "description": "low" + }, + { + "value": "normal", + "description": "normal" + }, + { + "value": "high", + "description": "high" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "HillinessDegree": { + "name": "hilliness", + "in": "query", + "description": "Degree of hilliness for thrilling route. This parameter can only be used in conjunction with `routeType`=thrilling.", + "type": "string", + "enum": [ + "low", + "normal", + "high" + ], + "x-ms-enum": { + "name": "HillinessDegree", + "modelAsString": true, + "values": [ + { + "value": "low", + "description": "low" + }, + { + "value": "normal", + "description": "normal" + }, + { + "value": "high", + "description": "high" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "TravelMode": { + "name": "travelMode", + "in": "query", + "description": "The mode of travel for the requested route. If not defined, default is 'car'. Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the travelMode element of the response for that section will be \"other\". Note that travel modes bus, motorcycle, taxi and van are BETA functionality. Full restriction data is not available in all areas. In **calculateReachableRange** requests, the values bicycle and pedestrian must not be used.", + "type": "string", + "enum": [ + "car", + "truck", + "taxi", + "bus", + "van", + "motorcycle", + "bicycle", + "pedestrian" + ], + "x-ms-enum": { + "name": "TravelMode", + "modelAsString": true, + "values": [ + { + "value": "car", + "description": "The returned routes are optimized for cars." + }, + { + "value": "truck", + "description": "The returned routes are optimized for commercial vehicles, like for trucks." + }, + { + "value": "taxi", + "description": "The returned routes are optimized for taxis. BETA functionality." + }, + { + "value": "bus", + "description": "The returned routes are optimized for buses, including the use of bus only lanes. BETA functionality." + }, + { + "value": "van", + "description": "The returned routes are optimized for vans. BETA functionality." + }, + { + "value": "motorcycle", + "description": "The returned routes are optimized for motorcycles. BETA functionality." + }, + { + "value": "bicycle", + "description": "The returned routes are optimized for bicycles, including use of bicycle lanes." + }, + { + "value": "pedestrian", + "description": "The returned routes are optimized for pedestrians, including the use of sidewalks." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "RouteAvoidList": { + "name": "avoid", + "in": "query", + "description": "Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple times in one request, for example, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. In calculateReachableRange requests, the value alreadyUsedRoads must not be used.", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "tollRoads", + "motorways", + "ferries", + "unpavedRoads", + "carpools", + "alreadyUsedRoads", + "borderCrossings" + ], + "x-ms-enum": { + "name": "RouteAvoidType", + "modelAsString": true, + "values": [ + { + "value": "tollRoads", + "description": "Avoids toll roads." + }, + { + "value": "motorways", + "description": "Avoids motorways" + }, + { + "value": "ferries", + "description": "Avoids ferries" + }, + { + "value": "unpavedRoads", + "description": "Avoids unpaved roads" + }, + { + "value": "carpools", + "description": "Avoids routes that require the use of carpool (HOV/High Occupancy Vehicle) lanes." + }, + { + "value": "alreadyUsedRoads", + "description": "Avoids using the same road multiple times. Most useful in conjunction with `routeType`=thrilling." + }, + { + "value": "borderCrossings", + "description": "Avoids border crossings in route calculation." + } + ] + } + }, + "x-ms-parameter-location": "method" + }, + "VehicleEngineType": { + "name": "vehicleEngineType", + "in": "query", + "description": "Engine type of the vehicle. When a detailed Consumption Model is specified, it must be consistent with the value of **vehicleEngineType**.", + "type": "string", + "enum": [ + "combustion", + "electric" + ], + "x-ms-enum": { + "name": "VehicleEngineType", + "modelAsString": true, + "values": [ + { + "value": "combustion", + "description": "Internal combustion engine." + }, + { + "value": "electric", + "description": "Electric engine." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "ConstantSpeedConsumptionInLitersPerHundredkm": { + "name": "constantSpeedConsumptionInLitersPerHundredkm", + "in": "query", + "description": "\n\nSpecifies the speed-dependent component of consumption.\n\nProvided as an unordered list of colon-delimited speed & consumption-rate pairs. The list defines points on a consumption curve. Consumption rates for speeds not in the list are found as follows:\n\n * by linear interpolation, if the given speed lies in between two speeds in the list\n\n * by linear extrapolation otherwise, assuming a constant (ΔConsumption/ΔSpeed) determined by the nearest two points in the list\n\nThe list must contain between 1 and 25 points (inclusive), and may not contain duplicate points for the same speed. If it only contains a single point, then the consumption rate of that point is used without further processing.\n\nConsumption specified for the largest speed must be greater than or equal to that of the penultimate largest speed. This ensures that extrapolation does not lead to negative consumption rates.\n\nSimilarly, consumption values specified for the two smallest speeds in the list cannot lead to a negative consumption rate for any smaller speed.\n\nThe valid range for the consumption values(expressed in l/100km) is between 0.01 and 100000.0.\n\nSensible Values : 50,6.3:130,11.5\n\n**Note** : This parameter is required for **The Combustion Consumption Model**.", + "type": "number", + "format": "float", + "x-ms-parameter-location": "method" + }, + "CurrentFuelInLiters": { + "name": "currentFuelInLiters", + "in": "query", + "description": "Specifies the current supply of fuel in liters.\n\nSensible Values : 55", + "type": "number", + "format": "float", + "x-ms-parameter-location": "method" + }, + "AuxiliaryPowerInLitersPerHour": { + "name": "auxiliaryPowerInLitersPerHour", + "in": "query", + "description": "Specifies the amount of fuel consumed for sustaining auxiliary systems of the vehicle, in liters per hour.\n\nIt can be used to specify consumption due to devices and systems such as AC systems, radio, heating, etc.\n\nSensible Values : 0.2", + "type": "number", + "format": "float", + "x-ms-parameter-location": "method" + }, + "FuelEnergyDensityInMJoulesPerLiter": { + "name": "fuelEnergyDensityInMJoulesPerLiter", + "in": "query", + "description": "Specifies the amount of chemical energy stored in one liter of fuel in megajoules (MJ). It is used in conjunction with the ***Efficiency** parameters for conversions between saved or consumed energy and fuel. For example, energy density is 34.2 MJ/l for gasoline, and 35.8 MJ/l for Diesel fuel.\n\nThis parameter is required if any ***Efficiency** parameter is set.\n\nSensible Values : 34.2", + "type": "number", + "format": "float", + "x-ms-parameter-location": "method" + }, + "AccelerationEfficiency": { + "name": "accelerationEfficiency", + "in": "query", + "description": "Specifies the efficiency of converting chemical energy stored in fuel to kinetic energy when the vehicle accelerates _(i.e. KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed_ is obtained by converting consumed fuel to chemical energy using **fuelEnergyDensityInMJoulesPerLiter**.\n\nMust be paired with **decelerationEfficiency**.\n\nThe range of values allowed are 0.0 to 1/**decelerationEfficiency**.\n\nSensible Values : for **Combustion Model** : 0.33, for **Electric Model** : 0.66", + "type": "number", + "format": "float", + "x-ms-parameter-location": "method" + }, + "DecelerationEfficiency": { + "name": "decelerationEfficiency", + "in": "query", + "description": "Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the vehicle decelerates _(i.e. ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved_ is obtained by converting saved (not consumed) fuel to energy using **fuelEnergyDensityInMJoulesPerLiter**.\n\nMust be paired with **accelerationEfficiency**.\n\nThe range of values allowed are 0.0 to 1/**accelerationEfficiency**.\n\nSensible Values : for **Combustion Model** : 0.83, for **Electric Model** : 0.91", + "type": "number", + "format": "float", + "x-ms-parameter-location": "method" + }, + "UphillEfficiency": { + "name": "uphillEfficiency", + "in": "query", + "description": "Specifies the efficiency of converting chemical energy stored in fuel to potential energy when the vehicle gains elevation _(i.e. PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed_ is obtained by converting consumed fuel to chemical energy using **fuelEnergyDensityInMJoulesPerLiter**.\n\nMust be paired with **downhillEfficiency**.\n\nThe range of values allowed are 0.0 to 1/**downhillEfficiency**.\n\nSensible Values : for **Combustion Model** : 0.27, for **Electric Model** : 0.74", + "type": "number", + "format": "float", + "x-ms-parameter-location": "method" + }, + "DownhillEfficiency": { + "name": "downhillEfficiency", + "in": "query", + "description": "Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the vehicle loses elevation _(i.e. ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved_ is obtained by converting saved (not consumed) fuel to energy using **fuelEnergyDensityInMJoulesPerLiter**.\n\nMust be paired with **uphillEfficiency**.\n\nThe range of values allowed are 0.0 to 1/**uphillEfficiency**.\n\nSensible Values : for **Combustion Model** : 0.51, for **Electric Model** : 0.73", + "type": "number", + "format": "float", + "x-ms-parameter-location": "method" + }, + "ConstantSpeedConsumptionInkWhPerHundredkm": { + "name": "constantSpeedConsumptionInkWhPerHundredkm", + "in": "query", + "description": "Specifies the speed-dependent component of consumption.\n\nProvided as an unordered list of speed/consumption-rate pairs. The list defines points on a consumption curve. Consumption rates for speeds not in the list are found as follows:\n\n* by linear interpolation, if the given speed lies in between two speeds in the list\n\n* by linear extrapolation otherwise, assuming a constant (ΔConsumption/ΔSpeed) determined by the nearest two points in the list\n\nThe list must contain between 1 and 25 points (inclusive), and may not contain duplicate points for the same speed. If it only contains a single point, then the consumption rate of that point is used without further processing.\n\nConsumption specified for the largest speed must be greater than or equal to that of the penultimate largest speed. This ensures that extrapolation does not lead to negative consumption rates.\n\nSimilarly, consumption values specified for the two smallest speeds in the list cannot lead to a negative consumption rate for any smaller speed.\n\nThe valid range for the consumption values(expressed in kWh/100km) is between 0.01 and 100000.0.\n\nSensible Values : 50,8.2:130,21.3\n\nThis parameter is required for **Electric consumption model**.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "CurrentChargeInkWh": { + "name": "currentChargeInkWh", + "in": "query", + "description": "Specifies the current electric energy supply in kilowatt hours (kWh).\n\nThis parameter co-exists with **maxChargeInkWh** parameter.\n\nThe range of values allowed are 0.0 to **maxChargeInkWh**.\n\nSensible Values : 43", + "type": "string", + "x-ms-parameter-location": "method" + }, + "MaxChargeInkWh": { + "name": "maxChargeInkWh", + "in": "query", + "description": "Specifies the maximum electric energy supply in kilowatt hours (kWh) that may be stored in the vehicle's battery.\n\nThis parameter co-exists with **currentChargeInkWh** parameter.\n\nMinimum value has to be greater than or equal to **currentChargeInkWh**.\n\nSensible Values : 85", + "type": "string", + "x-ms-parameter-location": "method" + }, + "AuxiliaryPowerInkW": { + "name": "auxiliaryPowerInkW", + "in": "query", + "description": "Specifies the amount of power consumed for sustaining auxiliary systems, in kilowatts (kW).\n\nIt can be used to specify consumption due to devices and systems such as AC systems, radio, heating, etc.\n\nSensible Values : 1.7", + "type": "string", + "x-ms-parameter-location": "method" + }, + "VehicleWeightMatrix": { + "name": "vehicleWeight", + "in": "query", + "description": "Weight of the vehicle in kilograms.", + "type": "integer", + "x-ms-parameter-location": "method" + }, + "VehicleWeight": { + "name": "vehicleWeight", + "in": "query", + "description": "Weight of the vehicle in kilograms.\n\n* It is mandatory if any of the *Efficiency parameters are set.\n\n* It must be strictly positive when used in the context of the Consumption Model. Weight restrictions are considered.\n\n* If no detailed **Consumption Model** is specified and the value of **vehicleWeight** is non-zero, then weight restrictions are considered.\n\n* In all other cases, this parameter is ignored.\n\nSensible Values : for **Combustion Model** : 1600, for **Electric Model** : 1900", + "type": "integer", + "x-ms-parameter-location": "method" + }, + "VehicleMaxSpeed": { + "name": "vehicleMaxSpeed", + "in": "query", + "description": "Maximum speed of the vehicle in km/hour. The max speed in the vehicle profile is used to check whether a vehicle is allowed on motorways. \n\n* A value of 0 means that an appropriate value for the vehicle will be determined and applied during route planning.\n\n* A non-zero value may be overridden during route planning. For example, the current traffic flow is 60 km/hour. If the vehicle maximum speed is set to 50 km/hour, the routing engine will consider 60 km/hour as this is the current situation. If the maximum speed of the vehicle is provided as 80 km/hour but the current traffic flow is 60 km/hour, then routing engine will again use 60 km/hour.", + "type": "integer", + "x-ms-parameter-location": "method" + }, + "VehicleLength": { + "name": "vehicleLength", + "in": "query", + "description": "Length of the vehicle in meters. A value of 0 means that length restrictions are not considered.", + "type": "number", + "format": "float", + "x-ms-parameter-location": "method" + }, + "VehicleHeight": { + "name": "vehicleHeight", + "in": "query", + "description": "Height of the vehicle in meters. A value of 0 means that height restrictions are not considered.", + "type": "number", + "format": "float", + "x-ms-parameter-location": "method" + }, + "VehicleWidth": { + "name": "vehicleWidth", + "in": "query", + "description": "Width of the vehicle in meters. A value of 0 means that width restrictions are not considered.", + "type": "number", + "format": "float", + "x-ms-parameter-location": "method" + }, + "VehicleAxleWeight": { + "name": "vehicleAxleWeight", + "in": "query", + "description": "Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered.", + "type": "integer", + "x-ms-parameter-location": "method" + }, + "VehicleCommercial": { + "name": "vehicleCommercial", + "in": "query", + "description": "Vehicle is used for commercial purposes and thus may not be allowed to drive on some roads.", + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "DepartAt": { + "name": "departAt", + "in": "query", + "description": "The date and time of departure from the origin point. Departure times apart from now must be specified as a dateTime. When a time zone offset is not specified, it will be assumed to be that of the origin point. The departAt value must be in the future in the date-time format (1996-12-19T16:39:57-08:00).", + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ArriveAt": { + "name": "arriveAt", + "in": "query", + "description": "The date and time of arrival at the destination point. It must be specified as a dateTime. When a time zone offset is not specified it will be assumed to be that of the destination point. The arriveAt value must be in the future. The arriveAt parameter cannot be used in conjunction with departAt, minDeviationDistance or minDeviationTime.", + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "SectionType": { + "name": "sectionType", + "in": "query", + "description": "Specifies which of the section types is reported in the route response.

    For example if sectionType = pedestrian the sections which are suited for pedestrians only are returned. Multiple types can be used. The default sectionType refers to the travelMode input. By default travelMode is set to car", + "type": "string", + "enum": [ + "carTrain", + "country", + "ferry", + "motorway", + "pedestrian", + "tollRoad", + "tollVignette", + "traffic", + "travelMode", + "tunnel" + ], + "x-ms-enum": { + "name": "SectionType", + "modelAsString": true, + "values": [ + { + "value": "carTrain", + "description": "Get sections if the route includes car trains." + }, + { + "value": "country", + "description": "Countries the route has parts in." + }, + { + "value": "ferry", + "description": "Get sections if the route includes ferries." + }, + { + "value": "motorway", + "description": "Get sections if the route includes motorways." + }, + { + "value": "pedestrian", + "description": "Get sections which are suited for pedestrians." + }, + { + "value": "tollRoad", + "description": "Get sections which require a toll to be payed." + }, + { + "value": "tollVignette", + "description": "Get sections which require a toll vignette to be present." + }, + { + "value": "traffic", + "description": "Get sections which contain traffic information." + }, + { + "value": "travelMode", + "description": "Get sections in relation to the request parameter `travelMode`." + }, + { + "value": "tunnel", + "description": "Get sections if the route includes tunnels." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "ComputeBestOrder": { + "name": "computeBestOrder", + "in": "query", + "description": "Re-order the route waypoints using a fast heuristic algorithm to reduce the route length. Yields best results when used in conjunction with routeType _shortest_. Notice that origin and destination are excluded from the optimized waypoint indices. To include origin and destination in the response, please increase all the indices by 1 to account for the origin, and then add the destination as the final index. Possible values are true or false. True computes a better order if possible, but is not allowed to be used in conjunction with maxAlternatives value greater than 0 or in conjunction with circle waypoints. False will use the locations in the given order and not allowed to be used in conjunction with routeRepresentation _none_.", + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "RouteRepresentation": { + "name": "routeRepresentation", + "in": "query", + "description": "Specifies the representation of the set of routes provided as response. This parameter value can only be used in conjunction with computeBestOrder=true.", + "type": "string", + "enum": [ + "polyline", + "summaryOnly", + "none" + ], + "x-ms-enum": { + "name": "RouteRepresentation", + "modelAsString": true, + "values": [ + { + "value": "polyline", + "description": "Includes route geometry in the response." + }, + { + "value": "summaryOnly", + "description": "Summary as per polyline but excluding the point geometry elements for the routes in the response." + }, + { + "value": "none", + "description": "Includes only the optimized waypoint indices but does not include the route geometry in the response." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "ComputeTravelTimeFor": { + "name": "computeTravelTimeFor", + "in": "query", + "description": "Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time.", + "type": "string", + "enum": [ + "none", + "all" + ], + "x-ms-enum": { + "name": "ComputeTravelTimeFor", + "modelAsString": true, + "values": [ + { + "value": "none", + "description": "Does not compute additional travel times." + }, + { + "value": "all", + "description": "Computes travel times for all types of traffic information and specifies all results in the fields noTrafficTravelTimeInSeconds, historicTrafficTravelTimeInSeconds and liveTrafficIncidentsTravelTimeInSeconds being included in the summaries in the route response." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "VehicleHeading": { + "name": "vehicleHeading", + "in": "query", + "description": "The directional heading of the vehicle in degrees starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359", + "type": "integer", + "minimum": 0, + "maximum": 359, + "x-ms-parameter-location": "method" + }, + "Report": { + "name": "report", + "in": "query", + "description": "Specifies which data should be reported for diagnosis purposes. The only possible value is _effectiveSettings_. Reports the effective parameters or data used when calling the API. In the case of defaulted parameters the default will be reflected where the parameter was not specified by the caller.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "Traffic": { + "name": "traffic", + "in": "query", + "description": "Possible values: \n * true - Do consider all available traffic information during routing\n * false - Ignore current traffic data during routing. Note that although the current traffic data is ignored \n during routing, the effect of historic traffic on effective road speeds is still incorporated.", + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "AlternativeRouteType": { + "name": "alternativeType", + "in": "query", + "description": "Controls the optimality, with respect to the given planning criteria, of the calculated alternatives compared to the reference route.", + "type": "string", + "enum": [ + "anyRoute", + "betterRoute" + ], + "x-ms-enum": { + "name": "AlternativeRouteType", + "modelAsString": true, + "values": [ + { + "value": "anyRoute", + "description": "Allow any alternative route to be returned irrespective of how it compares to the reference route in terms of optimality." + }, + { + "value": "betterRoute", + "description": "Return an alternative route only if it is better than the reference route according to the given planning criteria." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "RouteInstructionsType": { + "name": "instructionsType", + "in": "query", + "description": "If specified, guidance instructions will be returned. Note that the instructionsType parameter cannot be used in conjunction with routeRepresentation=none", + "type": "string", + "enum": [ + "coded", + "text", + "tagged" + ], + "x-ms-enum": { + "name": "RouteInstructionsType", + "modelAsString": true, + "values": [ + { + "value": "coded", + "description": "Returns raw instruction data without human-readable messages." + }, + { + "value": "text", + "description": "Returns raw instructions data with human-readable messages in plain text." + }, + { + "value": "tagged", + "description": "Returns raw instruction data with tagged human-readable messages to permit formatting. A human-readable message is built up from repeatable identified elements. These are tagged to allow client applications to format them correctly. The following message components are tagged when instructionsType=tagged: street, roadNumber, signpostText, exitNumber, roundaboutExitNumber.\n\nExample of tagged 'Turn left' message:​\n\n```\nTurn left onto A4/E19\ntowards Den Haag\n```" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "MatrixId": { + "name": "format", + "description": "Matrix id received after the Matrix Route request was accepted successfully.", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "BatchId": { + "name": "format", + "description": "Batch id for querying the operation.", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/route/matrix/{format}": { + "post": { + "description": "\n\n**Applies to**: S1 pricing tier.\n\nThe Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) POST request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nPOST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", + "operationId": "Route_PostRouteMatrix", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "PostRouteMatrix": { + "$ref": "./examples/PostRouteMatrix.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/RouteApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "waitForResults", + "in": "query", + "description": "Boolean to indicate whether to execute the request synchronously. If set to true, user will get a 200 response if the request is finished under 120 seconds. Otherwise, user will get a 202 response right away. Please refer to the API description for more details on 202 response. **Supported only for async request**.", + "type": "boolean" + }, + { + "$ref": "#/parameters/ComputeTravelTimeFor" + }, + { + "$ref": "#/parameters/SectionType" + }, + { + "$ref": "#/parameters/ArriveAt" + }, + { + "$ref": "#/parameters/DepartAt" + }, + { + "$ref": "#/parameters/VehicleAxleWeight" + }, + { + "$ref": "#/parameters/VehicleLength" + }, + { + "$ref": "#/parameters/VehicleHeight" + }, + { + "$ref": "#/parameters/VehicleWidth" + }, + { + "$ref": "#/parameters/VehicleMaxSpeed" + }, + { + "$ref": "#/parameters/VehicleWeightMatrix" + }, + { + "$ref": "#/parameters/WindingnessLevel" + }, + { + "$ref": "#/parameters/HillinessDegree" + }, + { + "$ref": "#/parameters/TravelMode" + }, + { + "$ref": "#/parameters/RouteAvoidList" + }, + { + "$ref": "#/parameters/Traffic" + }, + { + "$ref": "#/parameters/RouteType" + }, + { + "$ref": "#/parameters/VehicleLoadType" + }, + { + "name": "postRouteMatrixRequestBody", + "description": "The matrix of origin and destination coordinates to compute the route distance, travel time and other summary for each cell of the matrix based on the input parameters. The minimum and the maximum cell count supported are 1 and **700** for async and **100** for sync respectively. For example, it can be 35 origins and 20 destinations or 25 origins and 25 destinations for async API.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PostRouteMatrixRequestBody" + } + } + ], + "responses": { + "200": { + "description": "Matrix request successfully processed. The response body contains all of the results.", + "schema": { + "$ref": "#/definitions/RouteMatrixResponse" + } + }, + "202": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/202Async" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "description": "If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", + "operationId": "Route_GetRouteMatrix", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + }, + "x-ms-examples": { + "GetRouteMatrix": { + "$ref": "./examples/GetRouteMatrix.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/RouteApiVersion" + }, + { + "$ref": "#/parameters/MatrixId" + } + ], + "responses": { + "200": { + "description": "Matrix request successfully processed. The response body contains all of the results.", + "schema": { + "$ref": "#/definitions/RouteMatrixResponse" + } + }, + "202": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/202Async" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/route/matrix/sync/{format}": { + "post": { + "description": "\n\n**Applies to**: S1 pricing tier.\n\nThe Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) POST request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nPOST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", + "operationId": "Route_PostRouteMatrixSync", + "x-ms-examples": { + "PostRouteMatrixSync": { + "$ref": "./examples/PostRouteMatrixSync.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/RouteApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "waitForResults", + "in": "query", + "description": "Boolean to indicate whether to execute the request synchronously. If set to true, user will get a 200 response if the request is finished under 120 seconds. Otherwise, user will get a 202 response right away. Please refer to the API description for more details on 202 response. **Supported only for async request**.", + "type": "boolean" + }, + { + "$ref": "#/parameters/ComputeTravelTimeFor" + }, + { + "$ref": "#/parameters/SectionType" + }, + { + "$ref": "#/parameters/ArriveAt" + }, + { + "$ref": "#/parameters/DepartAt" + }, + { + "$ref": "#/parameters/VehicleAxleWeight" + }, + { + "$ref": "#/parameters/VehicleLength" + }, + { + "$ref": "#/parameters/VehicleHeight" + }, + { + "$ref": "#/parameters/VehicleWidth" + }, + { + "$ref": "#/parameters/VehicleMaxSpeed" + }, + { + "$ref": "#/parameters/VehicleWeightMatrix" + }, + { + "$ref": "#/parameters/WindingnessLevel" + }, + { + "$ref": "#/parameters/HillinessDegree" + }, + { + "$ref": "#/parameters/TravelMode" + }, + { + "$ref": "#/parameters/RouteAvoidList" + }, + { + "$ref": "#/parameters/Traffic" + }, + { + "$ref": "#/parameters/RouteType" + }, + { + "$ref": "#/parameters/VehicleLoadType" + }, + { + "name": "postRouteMatrixRequestBody", + "description": "The matrix of origin and destination coordinates to compute the route distance, travel time and other summary for each cell of the matrix based on the input parameters. The minimum and the maximum cell count supported are 1 and **700** for async and **100** for sync respectively. For example, it can be 35 origins and 20 destinations or 25 origins and 25 destinations for async API.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PostRouteMatrixRequestBody" + } + } + ], + "responses": { + "200": { + "description": "Matrix request successfully processed. The response body contains all of the results.", + "schema": { + "$ref": "#/definitions/RouteMatrixResponse" + } + }, + "408": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/408" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/route/directions/{format}": { + "get": { + "description": "**Applies to**: S0 and S1 pricing tiers.\n\n\nReturns a route between an origin and a destination, passing through waypoints if they are specified. The route will take into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day.\n\nInformation returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected.\n\nRouting service provides a set of parameters for a detailed description of vehicle-specific Consumption Model. Please check [Consumption Model](https://docs.microsoft.com/azure/azure-maps/consumption-model) for detailed explanation of the concepts and parameters involved.", + "operationId": "Route_GetRouteDirections", + "x-ms-examples": { + "GetRouteDirections": { + "$ref": "./examples/GetRouteDirections.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/RouteApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/TextFormat" + }, + { + "name": "query", + "in": "query", + "description": "The Coordinates through which the route is calculated, delimited by a colon. A minimum of two coordinates is required. The first one is the origin and the last is the destination of the route. Optional coordinates in-between act as WayPoints in the route. You can pass up to 150 WayPoints.", + "required": true, + "type": "string" + }, + { + "name": "maxAlternatives", + "in": "query", + "description": "Number of desired alternative routes to be calculated. Default: 0, minimum: 0 and maximum: 5", + "type": "integer", + "minimum": 0, + "maximum": 5 + }, + { + "$ref": "#/parameters/AlternativeRouteType" + }, + { + "name": "minDeviationDistance", + "in": "query", + "description": "All alternative routes returned will follow the reference route (see section POST Requests) from the origin point of the calculateRoute request for at least this number of meters. Can only be used when reconstructing a route. The minDeviationDistance parameter cannot be used in conjunction with arriveAt", + "type": "integer" + }, + { + "$ref": "#/parameters/ArriveAt" + }, + { + "$ref": "#/parameters/DepartAt" + }, + { + "name": "minDeviationTime", + "in": "query", + "description": "All alternative routes returned will follow the reference route (see section POST Requests) from the origin point of the calculateRoute request for at least this number of seconds. Can only be used when reconstructing a route. The minDeviationTime parameter cannot be used in conjunction with arriveAt. Default value is 0. Setting )minDeviationTime_ to a value greater than zero has the following consequences:\n - The origin point of the _calculateRoute_ Request must be on\n (or very near) the input reference route.\n - If this is not the case, an error is returned.\n - However, the origin point does not need to be at the beginning\n of the input reference route (it can be thought of as the current\n vehicle position on the reference route).\n - The reference route, returned as the first route in the _calculateRoute_\n Response, will start at the origin point specified in the _calculateRoute_\n Request. The initial part of the input reference route up until the origin\n point will be excluded from the Response.\n - The values of _minDeviationDistance_ and _minDeviationTime_ determine\n how far alternative routes will be guaranteed to follow the reference\n route from the origin point onwards.\n - The route must use _departAt_.\n - The _vehicleHeading_ is ignored.", + "type": "integer" + }, + { + "$ref": "#/parameters/RouteInstructionsType" + }, + { + "name": "language", + "in": "query", + "description": "The language parameter determines the language of the guidance messages. Proper nouns (the names of streets, plazas, etc.) are returned in the specified language, or if that is not available, they are returned in an available language that is close to it. Allowed values are (a subset of) the IETF language tags. The currently supported languages are listed in the [Supported languages section](https://docs.microsoft.com/azure/azure-maps/supported-languages).\n\nDefault value: en-GB", + "type": "string" + }, + { + "$ref": "#/parameters/ComputeBestOrder" + }, + { + "$ref": "#/parameters/RouteRepresentation" + }, + { + "$ref": "#/parameters/ComputeTravelTimeFor" + }, + { + "$ref": "#/parameters/VehicleHeading" + }, + { + "$ref": "#/parameters/Report" + }, + { + "$ref": "#/parameters/SectionType" + }, + { + "$ref": "#/parameters/VehicleAxleWeight" + }, + { + "$ref": "#/parameters/VehicleWidth" + }, + { + "$ref": "#/parameters/VehicleHeight" + }, + { + "$ref": "#/parameters/VehicleLength" + }, + { + "$ref": "#/parameters/VehicleMaxSpeed" + }, + { + "$ref": "#/parameters/VehicleWeight" + }, + { + "$ref": "#/parameters/VehicleCommercial" + }, + { + "$ref": "#/parameters/WindingnessLevel" + }, + { + "$ref": "#/parameters/HillinessDegree" + }, + { + "$ref": "#/parameters/TravelMode" + }, + { + "$ref": "#/parameters/RouteAvoidList" + }, + { + "$ref": "#/parameters/Traffic" + }, + { + "$ref": "#/parameters/RouteType" + }, + { + "$ref": "#/parameters/VehicleLoadType" + }, + { + "$ref": "#/parameters/VehicleEngineType" + }, + { + "$ref": "#/parameters/ConstantSpeedConsumptionInLitersPerHundredkm" + }, + { + "$ref": "#/parameters/CurrentFuelInLiters" + }, + { + "$ref": "#/parameters/AuxiliaryPowerInLitersPerHour" + }, + { + "$ref": "#/parameters/FuelEnergyDensityInMJoulesPerLiter" + }, + { + "$ref": "#/parameters/AccelerationEfficiency" + }, + { + "$ref": "#/parameters/DecelerationEfficiency" + }, + { + "$ref": "#/parameters/UphillEfficiency" + }, + { + "$ref": "#/parameters/DownhillEfficiency" + }, + { + "$ref": "#/parameters/ConstantSpeedConsumptionInkWhPerHundredkm" + }, + { + "$ref": "#/parameters/CurrentChargeInkWh" + }, + { + "$ref": "#/parameters/MaxChargeInkWh" + }, + { + "$ref": "#/parameters/AuxiliaryPowerInkW" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RouteDirectionsResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "post": { + "description": "**Applies to**: S0 and S1 pricing tiers.\n\n\nReturns a route between an origin and a destination, passing through waypoints if they are specified. The route will take into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day.\n\nInformation returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected.\n\nRouting service provides a set of parameters for a detailed description of a vehicle-specific Consumption Model. Please check [Consumption Model](https://docs.microsoft.com/azure/azure-maps/consumption-model) for detailed explanation of the concepts and parameters involved.", + "operationId": "Route_PostRouteDirections", + "x-ms-examples": { + "PostRouteDirections": { + "$ref": "./examples/PostRouteDirections.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/RouteApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/TextFormat" + }, + { + "name": "query", + "in": "query", + "description": "The Coordinates through which the route is calculated. Needs two coordinates at least. Delimited by colon. First one is the origin and the last is the destination of the route. The coordinates are in a lat,long format. Optional coordinates in between act as WayPoints in the route.", + "required": true, + "type": "string" + }, + { + "name": "maxAlternatives", + "in": "query", + "description": "Number of desired alternative routes to be calculated. Default: 0, minimum: 0 and maximum: 5", + "type": "integer", + "minimum": 0, + "maximum": 5 + }, + { + "$ref": "#/parameters/AlternativeRouteType" + }, + { + "name": "minDeviationDistance", + "in": "query", + "description": "All alternative routes returned will follow the reference route (see section POST Requests) from the origin point of the calculateRoute request for at least this number of meters. Can only be used when reconstructing a route. The minDeviationDistance parameter cannot be used in conjunction with arriveAt", + "type": "integer" + }, + { + "name": "minDeviationTime", + "in": "query", + "description": "All alternative routes returned will follow the reference route (see section POST Requests) from the origin point of the calculateRoute request for at least this number of seconds. Can only be used when reconstructing a route. The minDeviationTime parameter cannot be used in conjunction with arriveAt. Default value is 0. Setting )minDeviationTime_ to a value greater than zero has the following consequences:\n - The origin point of the _calculateRoute_ Request must be on\n (or very near) the input reference route.\n - If this is not the case, an error is returned.\n - However, the origin point does not need to be at the beginning\n of the input reference route (it can be thought of as the current\n vehicle position on the reference route).\n - The reference route, returned as the first route in the _calculateRoute_\n Response, will start at the origin point specified in the _calculateRoute_\n Request. The initial part of the input reference route up until the origin\n point will be excluded from the Response.\n - The values of _minDeviationDistance_ and _minDeviationTime_ determine\n how far alternative routes will be guaranteed to follow the reference\n route from the origin point onwards.\n - The route must use _departAt_.\n - The _vehicleHeading_ is ignored.", + "type": "integer" + }, + { + "$ref": "#/parameters/RouteInstructionsType" + }, + { + "name": "language", + "in": "query", + "description": "The language parameter determines the language of the guidance messages. It does not affect proper nouns (the names of streets, plazas, etc.) It has no effect when instructionsType=coded. Allowed values are (a subset of) the IETF language tags described", + "type": "string" + }, + { + "$ref": "#/parameters/ComputeBestOrder" + }, + { + "$ref": "#/parameters/RouteRepresentation" + }, + { + "$ref": "#/parameters/ComputeTravelTimeFor" + }, + { + "$ref": "#/parameters/VehicleHeading" + }, + { + "$ref": "#/parameters/Report" + }, + { + "$ref": "#/parameters/SectionType" + }, + { + "$ref": "#/parameters/ArriveAt" + }, + { + "$ref": "#/parameters/DepartAt" + }, + { + "$ref": "#/parameters/VehicleAxleWeight" + }, + { + "$ref": "#/parameters/VehicleLength" + }, + { + "$ref": "#/parameters/VehicleHeight" + }, + { + "$ref": "#/parameters/VehicleWidth" + }, + { + "$ref": "#/parameters/VehicleMaxSpeed" + }, + { + "$ref": "#/parameters/VehicleWeight" + }, + { + "$ref": "#/parameters/VehicleCommercial" + }, + { + "$ref": "#/parameters/WindingnessLevel" + }, + { + "$ref": "#/parameters/HillinessDegree" + }, + { + "$ref": "#/parameters/TravelMode" + }, + { + "$ref": "#/parameters/RouteAvoidList" + }, + { + "$ref": "#/parameters/Traffic" + }, + { + "$ref": "#/parameters/RouteType" + }, + { + "$ref": "#/parameters/VehicleLoadType" + }, + { + "$ref": "#/parameters/VehicleEngineType" + }, + { + "$ref": "#/parameters/ConstantSpeedConsumptionInLitersPerHundredkm" + }, + { + "$ref": "#/parameters/CurrentFuelInLiters" + }, + { + "$ref": "#/parameters/AuxiliaryPowerInLitersPerHour" + }, + { + "$ref": "#/parameters/FuelEnergyDensityInMJoulesPerLiter" + }, + { + "$ref": "#/parameters/AccelerationEfficiency" + }, + { + "$ref": "#/parameters/DecelerationEfficiency" + }, + { + "$ref": "#/parameters/UphillEfficiency" + }, + { + "$ref": "#/parameters/DownhillEfficiency" + }, + { + "$ref": "#/parameters/ConstantSpeedConsumptionInkWhPerHundredkm" + }, + { + "$ref": "#/parameters/CurrentChargeInkWh" + }, + { + "$ref": "#/parameters/MaxChargeInkWh" + }, + { + "$ref": "#/parameters/AuxiliaryPowerInkW" + }, + { + "name": "postRouteDirectionsRequestBody", + "description": "Used for reconstructing a route and for calculating zero or more alternative routes to this reference route. The provided sequence of coordinates is used as input for route reconstruction. The alternative routes are calculated between the origin and destination points specified in the base path parameter locations. If both minDeviationDistance and minDeviationTime are set to zero, then these origin and destination points are expected to be at (or very near) the beginning and end of the reference route, respectively. Intermediate locations (waypoints) are not supported when using supportingPoints.\n\nSetting at least one of minDeviationDistance or minDeviationTime to a value greater than zero has the following consequences:\n\n* The origin point of the calculateRoute request must be on (or very near) the input reference route. If this is not the case, an error is returned. However, the origin point does not need to be at the beginning of the input reference route (it can be thought of as the current vehicle position on the reference route).\n* The reference route, returned as the first route in the calculateRoute response, will start at the origin point specified in the calculateRoute request. The initial part of the input reference route up until the origin point will be excluded from the response.\n* The values of minDeviationDistance and minDeviationTime determine how far alternative routes will be guaranteed to follow the reference route from the origin point onwards.\n* The route must use departAt.\n* The vehicleHeading is ignored.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PostRouteDirectionsRequestBody" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RouteDirectionsResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/route/range/{format}": { + "get": { + "description": "__Route Range (Isochrone) API__\n\n\n**Applies to**: S1 pricing tier.\n\nThis service will calculate a set of locations that can be reached from the origin point based on fuel, energy, time or distance budget that is specified. A polygon boundary (or Isochrone) is returned in a counterclockwise orientation as well as the precise polygon center which was the result of the origin point.\n\nThe returned polygon can be used for further processing such as [Search Inside Geometry](https://docs.microsoft.com/rest/api/maps/search/postsearchinsidegeometry) to search for POIs within the provided Isochrone.", + "operationId": "Route_GetRouteRange", + "x-ms-examples": { + "GetRouteRange": { + "$ref": "./examples/GetRouteRange.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/RouteApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/TextFormat" + }, + { + "name": "query", + "in": "query", + "description": "The Coordinate from which the range calculation should start.", + "required": true, + "type": "string" + }, + { + "name": "fuelBudgetInLiters", + "in": "query", + "description": "Fuel budget in liters that determines maximal range which can be travelled using the specified Combustion Consumption Model.
    When fuelBudgetInLiters is used, it is mandatory to specify a detailed Combustion Consumption Model.
    Exactly one budget (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec, or distanceBudgetInMeters) must be used.", + "type": "number", + "format": "float" + }, + { + "name": "energyBudgetInkWh", + "in": "query", + "description": "Electric energy budget in kilowatt hours (kWh) that determines maximal range which can be travelled using the specified Electric Consumption Model.
    When energyBudgetInkWh is used, it is mandatory to specify a detailed Electric Consumption Model.
    Exactly one budget (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec, or distanceBudgetInMeters) must be used.", + "type": "number", + "format": "float" + }, + { + "name": "timeBudgetInSec", + "in": "query", + "description": "Time budget in seconds that determines maximal range which can be travelled using driving time. The Consumption Model will only affect the range when routeType is eco.
    Exactly one budget (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec, or distanceBudgetInMeters) must be used.", + "type": "number", + "format": "float" + }, + { + "name": "distanceBudgetInMeters", + "in": "query", + "description": "Distance budget in meters that determines maximal range which can be travelled using driving distance. The Consumption Model will only affect the range when routeType is eco.
    Exactly one budget (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec, or distanceBudgetInMeters) must be used.", + "type": "number", + "format": "float" + }, + { + "$ref": "#/parameters/DepartAt" + }, + { + "$ref": "#/parameters/RouteType" + }, + { + "$ref": "#/parameters/Traffic" + }, + { + "$ref": "#/parameters/RouteAvoidList" + }, + { + "$ref": "#/parameters/TravelMode" + }, + { + "$ref": "#/parameters/HillinessDegree" + }, + { + "$ref": "#/parameters/WindingnessLevel" + }, + { + "$ref": "#/parameters/VehicleAxleWeight" + }, + { + "$ref": "#/parameters/VehicleWidth" + }, + { + "$ref": "#/parameters/VehicleHeight" + }, + { + "$ref": "#/parameters/VehicleLength" + }, + { + "$ref": "#/parameters/VehicleMaxSpeed" + }, + { + "$ref": "#/parameters/VehicleWeight" + }, + { + "$ref": "#/parameters/VehicleCommercial" + }, + { + "$ref": "#/parameters/VehicleLoadType" + }, + { + "$ref": "#/parameters/VehicleEngineType" + }, + { + "$ref": "#/parameters/ConstantSpeedConsumptionInLitersPerHundredkm" + }, + { + "$ref": "#/parameters/CurrentFuelInLiters" + }, + { + "$ref": "#/parameters/AuxiliaryPowerInLitersPerHour" + }, + { + "$ref": "#/parameters/FuelEnergyDensityInMJoulesPerLiter" + }, + { + "$ref": "#/parameters/AccelerationEfficiency" + }, + { + "$ref": "#/parameters/DecelerationEfficiency" + }, + { + "$ref": "#/parameters/UphillEfficiency" + }, + { + "$ref": "#/parameters/DownhillEfficiency" + }, + { + "$ref": "#/parameters/ConstantSpeedConsumptionInkWhPerHundredkm" + }, + { + "$ref": "#/parameters/CurrentChargeInkWh" + }, + { + "$ref": "#/parameters/MaxChargeInkWh" + }, + { + "$ref": "#/parameters/AuxiliaryPowerInkW" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GetRouteRangeResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/route/directions/batch/{format}": { + "post": { + "description": "**Route Directions Batch API**\n\n\n**Applies to**: S1 pricing tier.\n\n\n\nThe Route Directions Batch API sends batches of queries to [Route Directions API](https://docs.microsoft.com/en-us/rest/api/maps/route/getroutedirections) using just a single API call. You can call Route Directions Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex route requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **700** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running request. Here's a typical sequence of operations:\n1. Client sends a Route Directions Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n``` GET https://atlas.microsoft.com/batch/{batch-id}?api-version=1.0 ```\nNote:- Please remember to add AUTH information (subscription-key/azure_auth - See [Security](#security)) to the _status URI_ before running it.
    \n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _route directions_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 3 _route directions_ queries:\n\n\n```json\n{\n \"batchItems\": [\n { \"query\": \"?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false\" },\n { \"query\": \"?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest\" },\n { \"query\": \"?query=48.923159,-122.557362:32.621279,-116.840362\" }\n ]\n}\n```\n\nA _route directions_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _route directions_ [URI parameters](https://docs.microsoft.com/en-us/rest/api/maps/route/getroutedirections#uri-parameters). The string values in the _route directions_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **700** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n \n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`RouteDirectionsResponse`](https://docs.microsoft.com/en-us/rest/api/maps/route/getroutedirections#routedirectionsresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 1,\n \"totalRequests\": 2\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\": {\n \"routes\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"legs\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"points\": [\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.34892\n },\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.3485\n },\n {\n \"latitude\": 47.62095,\n \"longitude\": -122.3476\n }\n ]\n }\n ],\n \"sections\": [\n {\n \"startPointIndex\": 0,\n \"endPointIndex\": 40,\n \"sectionType\": \"TRAVEL_MODE\",\n \"travelMode\": \"bicycle\"\n }\n ]\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "operationId": "Route_PostRouteDirectionsBatch", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "PostRouteDirectionsBatch": { + "$ref": "./examples/PostRouteDirectionsBatch.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/RouteApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "postRouteDirectionsBatchRequestBody", + "in": "body", + "description": "The list of route directions queries/requests to process. The list can contain a max of 700 queries for async and 100 queries for sync version and must contain at least 1 query.", + "required": true, + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/BatchRequestBody" + } + } + ], + "responses": { + "200": { + "description": "Batch request successfully processed. The response body contains all the batch results.", + "schema": { + "$ref": "#/definitions/RouteDirectionsBatchResponse" + } + }, + "202": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/202Async" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "description": "### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n \n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`RouteDirectionsResponse`](https://docs.microsoft.com/en-us/rest/api/maps/route/getroutedirections#routedirectionsresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 1,\n \"totalRequests\": 2\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\": {\n \"routes\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"legs\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"points\": [\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.34892\n },\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.3485\n },\n {\n \"latitude\": 47.62095,\n \"longitude\": -122.3476\n }\n ]\n }\n ],\n \"sections\": [\n {\n \"startPointIndex\": 0,\n \"endPointIndex\": 40,\n \"sectionType\": \"TRAVEL_MODE\",\n \"travelMode\": \"bicycle\"\n }\n ]\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "operationId": "Route_GetRouteDirectionsBatch", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + }, + "x-ms-examples": { + "GetRouteDirectionsBatch": { + "$ref": "./examples/GetRouteDirectionsBatch.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/RouteApiVersion" + }, + { + "$ref": "#/parameters/BatchId" + } + ], + "responses": { + "200": { + "description": "Batch request successfully processed. The response body contains all the batch results.", + "schema": { + "$ref": "#/definitions/RouteDirectionsBatchResponse" + } + }, + "202": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/202Async" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/route/directions/batch/sync/{format}": { + "post": { + "description": "**Route Directions Batch API**\n\n\n**Applies to**: S1 pricing tier.\n\n\n\nThe Route Directions Batch API sends batches of queries to [Route Directions API](https://docs.microsoft.com/en-us/rest/api/maps/route/getroutedirections) using just a single API call. You can call Route Directions Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex route requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **700** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running request. Here's a typical sequence of operations:\n1. Client sends a Route Directions Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n``` GET https://atlas.microsoft.com/batch/{batch-id}?api-version=1.0 ```\nNote:- Please remember to add AUTH information (subscription-key/azure_auth - See [Security](#security)) to the _status URI_ before running it.
    \n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _route directions_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 3 _route directions_ queries:\n\n\n```json\n{\n \"batchItems\": [\n { \"query\": \"?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false\" },\n { \"query\": \"?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest\" },\n { \"query\": \"?query=48.923159,-122.557362:32.621279,-116.840362\" }\n ]\n}\n```\n\nA _route directions_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _route directions_ [URI parameters](https://docs.microsoft.com/en-us/rest/api/maps/route/getroutedirections#uri-parameters). The string values in the _route directions_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **700** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n \n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`RouteDirectionsResponse`](https://docs.microsoft.com/en-us/rest/api/maps/route/getroutedirections#routedirectionsresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 1,\n \"totalRequests\": 2\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\": {\n \"routes\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"legs\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"points\": [\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.34892\n },\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.3485\n },\n {\n \"latitude\": 47.62095,\n \"longitude\": -122.3476\n }\n ]\n }\n ],\n \"sections\": [\n {\n \"startPointIndex\": 0,\n \"endPointIndex\": 40,\n \"sectionType\": \"TRAVEL_MODE\",\n \"travelMode\": \"bicycle\"\n }\n ]\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "operationId": "Route_PostRouteDirectionsBatchSync", + "x-ms-examples": { + "PostRouteDirectionsBatchSync": { + "$ref": "./examples/PostRouteDirectionsBatchSync.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/RouteApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "postRouteDirectionsBatchRequestBody", + "in": "body", + "description": "The list of route directions queries/requests to process. The list can contain a max of 700 queries for async and 100 queries for sync version and must contain at least 1 query.", + "required": true, + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/BatchRequestBody" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RouteDirectionsBatchResponse" + } + }, + "408": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/408" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + } + }, + "definitions": { + "PostRouteDirectionsRequestBody": { + "type": "object", + "description": "Post body parameters for Route directions.", + "properties": { + "supportingPoints": { + "description": "A GeoJSON Geometry collection representing sequence of coordinates used as input for route reconstruction and for calculating zero or more alternative routes to this reference route.\n - The provided sequence of supporting points is used as input for route reconstruction.\n - The alternative routes are calculated between the origin and destination points specified in the base path parameter locations.\n - If both _minDeviationDistance_ and _minDeviationTime_ are set to zero, then these origin and destination points are\n expected to be at (or very near) the beginning and end of the reference route, respectively.\n - Intermediate locations (_waypoints_) are not supported when using <_supportingPoints_>.\n - The reference route may contain traffic incidents of type _ROAD_CLOSURE_, which are\n ignored for the calculation of the reference route's travel time and traffic delay.", + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonGeometryCollection" + }, + "avoidVignette": { + "description": "This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries in which all toll roads with vignettes are to be avoided, e.g. \"AUS,CHE\". Toll roads with vignettes in countries not in the list are unaffected. Note: It is an error to specify both **avoidVignette** and **allowVignette**.", + "type": "array", + "items": { + "type": "string" + } + }, + "allowVignette": { + "description": "This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries in which toll roads with vignettes are allowed, e.g. \"AUS,CHE\". Specifying **allowVignette** with some countries X is equivalent to specifying **avoidVignette** with all countries but X. Specifying **allowVignette** with an empty list is the same as avoiding all toll roads with vignettes. Note: It is an error to specify both **avoidVignette** and **allowVignette**.", + "type": "array", + "items": { + "type": "string" + } + }, + "avoidAreas": { + "description": "A GeoJSON MultiPolygon representing list of areas to avoid. Only rectangle polygons are supported. The maximum size of a rectangle is about 160x160 km. Maximum number of avoided areas is **10**. It cannot cross the 180th meridian. It must be between -80 and +80 degrees of latitude.", + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonMultiPolygon" + } + } + }, + "RouteDirectionsResponse": { + "description": "This object is returned from a successful Route Directions call", + "type": "object", + "properties": { + "formatVersion": { + "description": "Format Version property", + "type": "string", + "readOnly": true + }, + "routes": { + "description": "Routes array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RouteDirectionsResult" + } + }, + "optimizedWaypoints": { + "description": "Optimized sequence of waypoints. It shows the index from the user provided waypoint sequence for the original and optimized list. For instance, a response: \n\n```\n\n\n\n\n\n```\n\nmeans that the original sequence is [0, 1, 2] and optimized sequence is [1, 2, 0]. Since the index starts by 0 the original is \"first, second, third\" while the optimized is \"second, third, first\".", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RouteOptimizedWaypoint" + } + }, + "report": { + "$ref": "#/definitions/RouteResponseReport" + } + } + }, + "RouteDirectionsResult": { + "type": "object", + "properties": { + "summary": { + "$ref": "#/definitions/RouteDirectionsSummary" + }, + "legs": { + "description": "Legs array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RouteResultLeg" + } + }, + "sections": { + "description": "Sections array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RouteResultSection" + } + }, + "guidance": { + "$ref": "#/definitions/RouteResultGuidance" + } + } + }, + "RouteDirectionsSummary": { + "description": "Summary object", + "type": "object", + "readOnly": true, + "properties": { + "lengthInMeters": { + "description": "Length In Meters property", + "type": "integer", + "readOnly": true + }, + "travelTimeInSeconds": { + "description": "Estimated travel time in seconds property that includes the delay due to real-time traffic. Note that even when traffic=false travelTimeInSeconds still includes the delay due to traffic. If DepartAt is in the future, travel time is calculated using time-dependent historic traffic data.", + "type": "integer", + "readOnly": true + }, + "trafficDelayInSeconds": { + "description": "Estimated delay in seconds caused by the real-time incident(s) according to traffic information. For routes planned with departure time in the future, delays is always 0. To return additional travel times using different types of traffic information, parameter computeTravelTimeFor=all needs to be added.", + "type": "integer", + "readOnly": true + }, + "departureTime": { + "description": "Departure Time property", + "type": "string", + "readOnly": true + }, + "arrivalTime": { + "description": "Arrival Time property", + "type": "string", + "readOnly": true + } + } + }, + "RouteOptimizedWaypoint": { + "description": "Optimized way point object.", + "type": "object", + "properties": { + "providedIndex": { + "description": "Way point index provided by the user.", + "type": "integer", + "readOnly": true + }, + "optimizedIndex": { + "description": "Optimized way point index from the system.", + "type": "integer", + "readOnly": true + } + } + }, + "RouteResultLeg": { + "type": "object", + "properties": { + "summary": { + "$ref": "#/definitions/RouteResultLegSummary" + }, + "points": { + "description": "Points array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/CoordinatesPair" + } + } + } + }, + "RouteResultLegSummary": { + "description": "Summary object for route section.", + "type": "object", + "readOnly": true, + "properties": { + "lengthInMeters": { + "description": "Length In Meters property", + "type": "integer", + "readOnly": true + }, + "travelTimeInSeconds": { + "description": "Estimated travel time in seconds property that includes the delay due to real-time traffic. Note that even when traffic=false travelTimeInSeconds still includes the delay due to traffic. If DepartAt is in the future, travel time is calculated using time-dependent historic traffic data.", + "type": "integer", + "readOnly": true + }, + "trafficDelayInSeconds": { + "description": "Estimated delay in seconds caused by the real-time incident(s) according to traffic information. For routes planned with departure time in the future, delays is always 0. To return additional travel times using different types of traffic information, parameter computeTravelTimeFor=all needs to be added.", + "type": "integer", + "readOnly": true + }, + "departureTime": { + "description": "Departure Time property", + "type": "string", + "readOnly": true + }, + "arrivalTime": { + "description": "Arrival Time property", + "type": "string", + "readOnly": true + }, + "noTrafficTravelTimeInSeconds": { + "description": "Estimated travel time calculated as if there are no delays on the route due to traffic conditions (e.g. congestion). Included only if computeTravelTimeFor = all is used in the query.", + "type": "integer", + "readOnly": true + }, + "historicTrafficTravelTimeInSeconds": { + "description": "Estimated travel time calculated using time-dependent historic traffic data. Included only if computeTravelTimeFor = all is used in the query.", + "type": "integer", + "readOnly": true + }, + "liveTrafficIncidentsTravelTimeInSeconds": { + "description": "Estimated travel time calculated using real-time speed data. Included only if computeTravelTimeFor = all is used in the query.", + "type": "integer", + "readOnly": true + }, + "fuelConsumptionInLiters": { + "description": "Estimated fuel consumption in liters using the Combustion Consumption Model. Included if vehicleEngineType is set to _combustion_ and constantSpeedConsumptionInLitersPerHundredkm is specified. The value will be non-negative.", + "type": "number", + "format": "float", + "readOnly": true + }, + "batteryConsumptionInkWh": { + "description": "Estimated electric energy consumption in kilowatt hours (kWh) using the Electric Consumption Model. Included if vehicleEngineType is set to electric and constantSpeedConsumptionInkWhPerHundredkm is specified. The value of batteryConsumptionInkWh includes the recuperated electric energy and can therefore be negative (which indicates gaining energy). If both maxChargeInkWh and currentChargeInkWh are specified, recuperation will be capped to ensure that the battery charge level never exceeds maxChargeInkWh. If neither maxChargeInkWh nor currentChargeInkWh are specified, unconstrained recuperation is assumed in the consumption calculation.", + "type": "number", + "format": "float", + "readOnly": true + } + } + }, + "RouteResultSection": { + "type": "object", + "properties": { + "startPointIndex": { + "description": "Start Point Index property", + "type": "integer", + "readOnly": true + }, + "endPointIndex": { + "description": "End Point Index property", + "type": "integer", + "readOnly": true + }, + "sectionType": { + "description": "Section Type property", + "type": "string", + "readOnly": true + }, + "travelMode": { + "description": "Travel Mode property", + "type": "string", + "readOnly": true + }, + "simpleCategory": { + "description": "Type of the incident. Can currently be JAM, ROAD_WORK, ROAD_CLOSURE, or OTHER. See \"tec\" for detailed information.", + "type": "string", + "readOnly": true + }, + "effectiveSpeedInKmh": { + "description": "Effective speed of the incident in km/h, averaged over its entire length.", + "type": "integer", + "readOnly": true + }, + "delayInSeconds": { + "description": "Delay in seconds caused by the incident.", + "type": "integer", + "readOnly": true + }, + "magnitudeOfDelay": { + "description": "The magnitude of delay caused by the incident. These values correspond to the values of the response field ty of the [Get Traffic Incident Detail API](https://docs.microsoft.com/rest/api/maps/traffic/gettrafficincidentdetail). ", + "readOnly": true, + "type": "string", + "enum": [ + "0", + "1", + "2", + "3", + "4" + ], + "x-ms-enum": { + "name": "MagnitudeOfDelay", + "modelAsString": true, + "values": [ + { + "value": "0", + "description": "Unknown." + }, + { + "value": "1", + "description": "Minor." + }, + { + "value": "2", + "description": "Moderate." + }, + { + "value": "3", + "description": "Major." + }, + { + "value": "4", + "description": "Undefined, used for road closures and other indefinite delays." + } + ] + } + }, + "tec": { + "$ref": "#/definitions/RouteResultSectionTec" + } + } + }, + "RouteResultSectionTec": { + "description": "Details of the traffic event, using definitions in the [TPEG2-TEC](https://www.iso.org/standard/63116.html) standard. Can contain effectCode and causes elements.", + "type": "object", + "properties": { + "effectCode": { + "description": "The effect on the traffic flow. Contains a value in the tec001:EffectCode table, as defined in the [TPEG2-TEC](https://www.iso.org/standard/63116.html) standard. Can be used to color-code traffic events according to severity.", + "type": "integer", + "readOnly": true + }, + "causes": { + "description": "Causes array", + "type": "array", + "items": { + "$ref": "#/definitions/RouteResultSectionTecCause" + } + } + } + }, + "RouteResultSectionTecCause": { + "description": "The cause of the traffic event. Can contain mainCauseCode and subCauseCode elements. Can be used to define iconography and descriptions.", + "type": "object", + "properties": { + "mainCauseCode": { + "description": "The main cause of the traffic event. Contains a value in the tec002:CauseCode table, as defined in the [TPEG2-TEC](https://www.iso.org/standard/63116.html) standard.", + "type": "integer", + "readOnly": true + }, + "subCauseCode": { + "description": "The subcause of the traffic event. Contains a value in the sub cause table defined by the mainCauseCode, as defined in the [TPEG2-TEC](https://www.iso.org/standard/63116.html) standard.", + "type": "integer", + "readOnly": true + } + } + }, + "RouteResultInstruction": { + "description": "A set of attributes describing a maneuver, e.g. 'Turn right', 'Keep left', 'Take the ferry', 'Take the motorway', 'Arrive'.", + "type": "object", + "properties": { + "routeOffsetInMeters": { + "description": "Distance from the start of the route to the point of the instruction.", + "type": "integer", + "readOnly": true + }, + "travelTimeInSeconds": { + "description": "Estimated travel time up to the point corresponding to routeOffsetInMeters.", + "type": "integer", + "readOnly": true + }, + "point": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/CoordinatesPair" + }, + "pointIndex": { + "description": "The index of the point in the list of polyline \"points\" corresponding to the point of the instruction.", + "type": "integer", + "readOnly": true + }, + "instructionType": { + "description": "Type of the instruction, e.g., turn or change of road form.", + "type": "string", + "enum": [ + "TURN", + "ROAD_CHANGE", + "LOCATION_DEPARTURE", + "LOCATION_ARRIVAL", + "DIRECTION_INFO", + "LOCATION_WAYPOINT" + ], + "x-ms-enum": { + "name": "GuidanceInstructionType", + "modelAsString": true, + "values": [ + { + "value": "TURN", + "description": "Turn." + }, + { + "value": "ROAD_CHANGE", + "description": "Road Change." + }, + { + "value": "LOCATION_DEPARTURE", + "description": "Departure location." + }, + { + "value": "LOCATION_ARRIVAL", + "description": "Arrival location." + }, + { + "value": "DIRECTION_INFO", + "description": "Direction information." + }, + { + "value": "LOCATION_WAYPOINT", + "description": "Way point location." + } + ] + } + }, + "roadNumbers": { + "description": "The road number(s) of the next significant road segment(s) after the maneuver, or of the road(s) to be followed. Example: [\"E34\", \"N205\"]", + "type": "array", + "items": { + "type": "string", + "readOnly": true + }, + "readOnly": true + }, + "exitNumber": { + "description": "The number(s) of a highway exit taken by the current maneuver. If an exit has multiple exit numbers, they will be separated by \",\" and possibly aggregated by \"-\", e.g., \"10, 13-15\".", + "type": "string", + "readOnly": true + }, + "street": { + "description": "Street name of the next significant road segment after the maneuver, or of the street that should be followed.", + "type": "string", + "readOnly": true + }, + "signpostText": { + "description": "The text on a signpost which is most relevant to the maneuver, or to the direction that should be followed.", + "type": "string", + "readOnly": true + }, + "countryCode": { + "description": "3-character [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) alpha-3 country code. E.g. USA.", + "type": "string", + "readOnly": true + }, + "stateCode": { + "description": "A subdivision (e.g., state) of the country, represented by the second part of an [ISO 3166-2](https://www.iso.org/standard/63546.html) code. This is only available for some countries like the US, Canada, and Mexico.", + "type": "string", + "readOnly": true + }, + "junctionType": { + "description": "The type of the junction where the maneuver takes place. For larger roundabouts, two separate instructions are generated for entering and leaving the roundabout.", + "type": "string", + "readOnly": true, + "enum": [ + "REGULAR", + "ROUNDABOUT", + "BIFURCATION" + ], + "x-ms-enum": { + "name": "JunctionType", + "modelAsString": true, + "values": [ + { + "value": "REGULAR", + "description": "regular" + }, + { + "value": "ROUNDABOUT", + "description": "roundabout" + }, + { + "value": "BIFURCATION", + "description": "bifurcation" + } + ] + } + }, + "turnAngleInDecimalDegrees": { + "description": "Indicates the direction of an instruction. If junctionType indicates a turn instruction:\n\n * 180 = U-turn\n * [-179, -1] = Left turn\n * 0 = Straight on (a '0 degree' turn)\n * [1, 179] = Right turn\n\nIf junctionType indicates a bifurcation instruction:\n\n * <0 - keep left\n * \\>0 - keep right", + "type": "integer", + "readOnly": true + }, + "roundaboutExitNumber": { + "description": "This indicates which exit to take at a roundabout.", + "type": "string", + "readOnly": true + }, + "possibleCombineWithNext": { + "description": "It is possible to optionally combine the instruction with the next one. This can be used to build messages like \"Turn left and then turn right\".", + "type": "boolean", + "readOnly": true + }, + "drivingSide": { + "description": "Indicates left-hand vs. right-hand side driving at the point of the maneuver.", + "type": "string", + "readOnly": true, + "enum": [ + "LEFT", + "RIGHT" + ], + "x-ms-enum": { + "name": "DrivingSide", + "modelAsString": true, + "values": [ + { + "value": "LEFT", + "description": "Left side." + }, + { + "value": "RIGHT", + "description": "Right side." + } + ] + } + }, + "maneuver": { + "description": "A code identifying the maneuver.", + "type": "string", + "readOnly": true, + "enum": [ + "ARRIVE", + "ARRIVE_LEFT", + "ARRIVE_RIGHT", + "DEPART", + "STRAIGHT", + "KEEP_RIGHT", + "BEAR_RIGHT", + "TURN_RIGHT", + "SHARP_RIGHT", + "KEEP_LEFT", + "BEAR_LEFT", + "TURN_LEFT", + "SHARP_LEFT", + "MAKE_UTURN", + "ENTER_MOTORWAY", + "ENTER_FREEWAY", + "ENTER_HIGHWAY", + "TAKE_EXIT", + "MOTORWAY_EXIT_LEFT", + "MOTORWAY_EXIT_RIGHT", + "TAKE_FERRY", + "ROUNDABOUT_CROSS", + "ROUNDABOUT_RIGHT", + "ROUNDABOUT_LEFT", + "ROUNDABOUT_BACK", + "TRY_MAKE_UTURN", + "FOLLOW", + "SWITCH_PARALLEL_ROAD", + "SWITCH_MAIN_ROAD", + "ENTRANCE_RAMP", + "WAYPOINT_LEFT", + "WAYPOINT_RIGHT", + "WAYPOINT_REACHED" + ], + "x-ms-enum": { + "name": "GuidanceManeuver", + "modelAsString": true, + "values": [ + { + "value": "ARRIVE", + "description": "You have arrived." + }, + { + "value": "ARRIVE_LEFT", + "description": "You have arrived. Your destination is on the left." + }, + { + "value": "ARRIVE_RIGHT", + "description": "You have arrived. Your destination is on the right." + }, + { + "value": "DEPART", + "description": "Leave." + }, + { + "value": "STRAIGHT", + "description": "Keep straight on." + }, + { + "value": "KEEP_RIGHT", + "description": "Keep right." + }, + { + "value": "BEAR_RIGHT", + "description": "Bear right." + }, + { + "value": "TURN_RIGHT", + "description": "Turn right." + }, + { + "value": "SHARP_RIGHT", + "description": "Turn sharp right." + }, + { + "value": "KEEP_LEFT", + "description": "Keep left." + }, + { + "value": "BEAR_LEFT", + "description": "Bear left." + }, + { + "value": "TURN_LEFT", + "description": "Turn left." + }, + { + "value": "SHARP_LEFT", + "description": "Turn sharp left." + }, + { + "value": "MAKE_UTURN", + "description": "Make a U-turn." + }, + { + "value": "ENTER_MOTORWAY", + "description": "Take the motorway." + }, + { + "value": "ENTER_FREEWAY", + "description": "Take the freeway." + }, + { + "value": "ENTER_HIGHWAY", + "description": "Take the highway." + }, + { + "value": "TAKE_EXIT", + "description": "Take the exit." + }, + { + "value": "MOTORWAY_EXIT_LEFT", + "description": "Take the left exit." + }, + { + "value": "MOTORWAY_EXIT_RIGHT", + "description": "Take the right exit." + }, + { + "value": "TAKE_FERRY", + "description": "Take the ferry." + }, + { + "value": "ROUNDABOUT_CROSS", + "description": "Cross the roundabout." + }, + { + "value": "ROUNDABOUT_RIGHT", + "description": "At the roundabout take the exit on the right." + }, + { + "value": "ROUNDABOUT_LEFT", + "description": "At the roundabout take the exit on the left." + }, + { + "value": "ROUNDABOUT_BACK", + "description": "Go around the roundabout." + }, + { + "value": "TRY_MAKE_UTURN", + "description": "Try to make a U-turn." + }, + { + "value": "FOLLOW", + "description": "Follow." + }, + { + "value": "SWITCH_PARALLEL_ROAD", + "description": "Switch to the parallel road." + }, + { + "value": "SWITCH_MAIN_ROAD", + "description": "Switch to the main road." + }, + { + "value": "ENTRANCE_RAMP", + "description": "Take the ramp." + }, + { + "value": "WAYPOINT_LEFT", + "description": "You have reached the waypoint. It is on the left." + }, + { + "value": "WAYPOINT_RIGHT", + "description": "You have reached the waypoint. It is on the right." + }, + { + "value": "WAYPOINT_REACHED", + "description": "You have reached the waypoint." + } + ] + } + }, + "message": { + "description": "A human-readable message for the maneuver.", + "type": "string", + "readOnly": true + }, + "combinedMessage": { + "description": "A human-readable message for the maneuver combined with the message from the next instruction. Sometimes it is possible to combine two successive instructions into a single instruction making it easier to follow. When this is the case the possibleCombineWithNext flag will be true. For example:\n\n```\n10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam\n11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam\n```\n\nThe possibleCombineWithNext flag on instruction 10 is true. This indicates to the clients of coded guidance that it can be combined with instruction 11. The instructions will be combined automatically for clients requesting human-readable guidance. The combinedMessage field contains the combined message:\n\n```\nTurn left onto Einsteinweg/A10/E22 towards Ring Amsterdam\nthen follow Einsteinweg/A10/E22 towards Ring Amsterdam.\n```", + "type": "string", + "readOnly": true + } + } + }, + "RouteResultInstructionGroup": { + "description": "Groups a sequence of instruction elements which are related to each other. The sequence range is constrained with firstInstructionIndex and lastInstructionIndex. When human-readable text messages are requested for guidance (instructionType=text or tagged), then the instructionGroup has a summary message returned when available.", + "type": "object", + "properties": { + "firstInstructionIndex": { + "description": "Index of the first instruction.", + "type": "integer", + "readOnly": true + }, + "lastInstructionIndex": { + "description": "Index of the last instruction.", + "type": "integer", + "readOnly": true + }, + "groupLengthInMeters": { + "description": "Length of the group.", + "type": "integer", + "readOnly": true + }, + "groupMessage": { + "description": "Summary message when human-readable text messages are requested for guidance (instructionType=text or tagged).", + "type": "string", + "readOnly": true + } + } + }, + "RouteResultGuidance": { + "description": "Contains guidance related elements. This field is present only when guidance was requested and is available.", + "type": "object", + "readOnly": true, + "properties": { + "instructions": { + "description": "A list of instructions describing maneuvers.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RouteResultInstruction" + } + }, + "instructionGroups": { + "description": "Groups a sequence of instruction elements which are related to each other.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RouteResultInstructionGroup" + } + } + } + }, + "GetRouteRangeResponse": { + "description": "This object is returned from a successful Route Reachable Range call", + "type": "object", + "properties": { + "formatVersion": { + "description": "Format Version property", + "type": "string", + "readOnly": true + }, + "reachableRange": { + "$ref": "#/definitions/RouteRange" + }, + "report": { + "$ref": "#/definitions/RouteResponseReport" + } + } + }, + "RouteRange": { + "description": "Reachable Range", + "type": "object", + "properties": { + "center": { + "description": "Center point of the reachable range", + "$ref": "../../../Common/preview/1.0/common.json#/definitions/CoordinatesPair" + }, + "boundary": { + "description": "Polygon boundary of the reachable range represented as a list of points.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/CoordinatesPair" + } + } + } + }, + "RouteResponseReport": { + "description": "Reports the effective settings used in the current call.", + "type": "object", + "properties": { + "effectiveSettings": { + "description": "Effective parameters or data used when calling this Route API.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RouteResponseReportEffectiveSetting" + } + } + } + }, + "RouteResponseReportEffectiveSetting": { + "description": "Effective parameter or data used when calling this Route API.", + "type": "object", + "properties": { + "key": { + "description": "Name of the parameter used.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "Value of the parameter used.", + "type": "string", + "readOnly": true + } + } + }, + "RouteMatrixResponse": { + "description": "This object is returned from a successful Route Matrix call. For ex, if 2 origins and 3 destinations are provided, there are going to 2 arrays with 3 elements in each. Each element's content depends on the options provided in the query.", + "type": "object", + "properties": { + "formatVersion": { + "description": "Format Version property", + "type": "string", + "readOnly": true + }, + "matrix": { + "description": "Results as a 2 dimensional array of route summaries.", + "type": "array", + "readOnly": true, + "items": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RouteMatrixResult" + } + } + }, + "summary": { + "$ref": "#/definitions/RouteMatrixSummary" + } + } + }, + "RouteMatrixSummary": { + "description": "Summary object", + "type": "object", + "readOnly": true, + "properties": { + "successfulRoutes": { + "description": "Number of successful routes in the response.", + "type": "integer", + "readOnly": true + }, + "totalRoutes": { + "description": "Total number of routes requested. Number of cells in the input matrix.", + "type": "integer", + "readOnly": true + } + } + }, + "RouteMatrixResult": { + "description": "Matrix result object", + "type": "object", + "readOnly": true, + "properties": { + "statusCode": { + "description": "StatusCode property for the current cell in the input matrix.", + "type": "integer", + "readOnly": true + }, + "response": { + "$ref": "#/definitions/RouteMatrixResultResponse" + } + } + }, + "RouteMatrixResultResponse": { + "description": "Response object of the current cell in the input matrix.", + "type": "object", + "readOnly": true, + "properties": { + "routeSummary": { + "$ref": "#/definitions/RouteResultLegSummary" + } + } + }, + "PostRouteMatrixRequestBody": { + "description": "An object with a matrix of coordinates.", + "type": "object", + "properties": { + "origins": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonMultiPoint" + }, + "destinations": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonMultiPoint" + } + } + }, + "RouteDirectionsBatchResponse": { + "description": "This object is returned from a successful Route Directions Batch service call.", + "type": "object", + "allOf": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/BatchResponse" + } + ], + "properties": { + "batchItems": { + "description": "Array containing the batch results.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RouteDirectionsBatchItem" + } + } + } + }, + "RouteDirectionsBatchItem": { + "description": "An item returned from Route Directions Batch service call.", + "type": "object", + "allOf": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/BatchItem" + } + ], + "properties": { + "response": { + "description": "The result of the query. RouteDirectionsResponse if the query completed successfully, ErrorResponse otherwise.", + "type": "object", + "readOnly": true, + "allOf": [ + { + "$ref": "#/definitions/RouteDirectionsResponse" + }, + { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + ] + } + } + } + } +} diff --git a/specification/maps/data-plane/Route/readme.csharp.md b/specification/maps/data-plane/Route/readme.csharp.md new file mode 100644 index 000000000000..2ad98464080b --- /dev/null +++ b/specification/maps/data-plane/Route/readme.csharp.md @@ -0,0 +1,13 @@ +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +sync-methods: None +license-header: MICROSOFT_MIT_NO_VERSION +namespace: Azure.Maps.Route +output-folder: $(csharp-sdks-folder)/maps/Azure.Maps.Route/src/Generated +clear-output-folder: true +public-clients: true +``` \ No newline at end of file diff --git a/specification/maps/data-plane/Route/readme.go.md b/specification/maps/data-plane/Route/readme.go.md new file mode 100644 index 000000000000..086f16518e90 --- /dev/null +++ b/specification/maps/data-plane/Route/readme.go.md @@ -0,0 +1,26 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +license-header: MICROSOFT_MIT_NO_VERSION +namespace: route +clear-output-folder: true +export-clients: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: 1.0-preview +``` + +### Tag: 1.0-preview and go + +These settings apply only when `--tag=1.0-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == '1.0-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/maps/1.0/$(namespace) +``` \ No newline at end of file diff --git a/specification/maps/data-plane/Route/readme.java.md b/specification/maps/data-plane/Route/readme.java.md new file mode 100644 index 000000000000..cc6d4cd306fc --- /dev/null +++ b/specification/maps/data-plane/Route/readme.java.md @@ -0,0 +1,9 @@ +## Java + +``` yaml $(java) +java: + namespace: com.azure.maps.route + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 0 + output-folder: $(azure-libraries-for-java-folder)/azure-maps-route +``` \ No newline at end of file diff --git a/specification/maps/data-plane/Route/readme.md b/specification/maps/data-plane/Route/readme.md new file mode 100644 index 000000000000..de4e872281cd --- /dev/null +++ b/specification/maps/data-plane/Route/readme.md @@ -0,0 +1,89 @@ +# Azure Route + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Route Client + +--- + +## Getting Started + +To build the SDK for Route, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +### Basic Information + +These are the global settings for Route Client. + +``` yaml +title: RouteClient +openapi-type: data-plane +tag: 1.0-preview +# at some point those credentials will move away to Swagger according to [this](https://github.com/Azure/autorest/issues/3718) +add-credentials: true +credential-default-policy-type: BearerTokenCredentialPolicy +credential-scopes: https://atlas.microsoft.com/.default +``` + + +### Tag: 1.0-preview + +These settings apply only when `--tag=1.0-preview` is specified on the command line. + +``` yaml $(tag) == '1.0-preview' +input-file: + - preview/1.0/route.json +``` + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-java + + #track1 doesn't support data-plane for go + #manually generate for now with track2 + #- repo: azure-sdk-for-go + + #track1 doesn't support features needed for typescript + #manually generate for now with track2 + #- repo: azure-sdk-for-js + + #should be azure-sdk-for-net-track2, but SDK has not yet onboarded + #manually generate for now with track2 + - repo: azure-sdk-for-net +``` +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Java + +See configuration in [readme.java.md](./readme.java.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) diff --git a/specification/maps/data-plane/Route/readme.python.md b/specification/maps/data-plane/Route/readme.python.md new file mode 100644 index 000000000000..e49ab788707b --- /dev/null +++ b/specification/maps/data-plane/Route/readme.python.md @@ -0,0 +1,22 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +license-header: MICROSOFT_MIT_NO_VERSION +namespace: azure.maps.route +package-name: azure-maps-route +package-version: 1.0-preview +clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +no-namespace-folders: true +output-folder: $(python-sdks-folder)/maps/azure-maps-route/azure/maps/route +``` +``` yaml $(python) && $(python-mode) == 'create' +basic-setup-py: true +output-folder: $(python-sdks-folder)/maps/azure-maps-route +``` diff --git a/specification/maps/data-plane/Route/readme.typescript.md b/specification/maps/data-plane/Route/readme.typescript.md new file mode 100644 index 000000000000..3239505647af --- /dev/null +++ b/specification/maps/data-plane/Route/readme.typescript.md @@ -0,0 +1,27 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +azure-arm: false +package-name: "@azure/maps-route" +license-header: MICROSOFT_MIT_NO_VERSION +output-folder: "$(typescript-sdks-folder)/sdk/maps/maps-route" +source-code-folder-path: "" +clear-output-folder: false +generate-metadata: false +directive: + - from: route.json + where: $.definitions.PostRouteDirectionsRequestBody.properties.supportingPoints + transform: > + $ = { + "description": "A GeoJSON Geometry collection representing sequence of coordinates used as input for route reconstruction and for calculating zero or more alternative routes to this reference route.\n - The provided sequence of supporting points is used as input for route reconstruction.\n - The alternative routes are calculated between the origin and destination points specified in the base path parameter locations.\n - If both _minDeviationDistance_ and _minDeviationTime_ are set to zero, then these origin and destination points are\n expected to be at (or very near) the beginning and end of the reference route, respectively.\n - Intermediate locations (_waypoints_) are not supported when using <_supportingPoints_>.\n - The reference route may contain traffic incidents of type _ROAD_CLOSURE_, which are\n ignored for the calculation of the reference route's travel time and traffic delay.", + "type": "object" + }; + reason: Autorest TS codegen does not deserialize array of base class objects as an operation parameter properly -> https://github.com/Azure/autorest.typescript/issues/1040 + - remove-operation: Route_GetRouteMatrix + reason: This operation is created for Java SDK that has no LRO poller implementation + - remove-operation: Route_GetRouteDirectionsBatch + reason: This operation is created for Java SDK that has no LRO poller implementation +``` diff --git a/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchAddress.json b/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchAddress.json new file mode 100644 index 000000000000..8aa456d648f1 --- /dev/null +++ b/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchAddress.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "query": "15127 NE 24th Street, Redmond, WA 98052" + }, + "responses": { + "200": { + "body": { + "summary": { + "query": "15127 NE 24th Street, Redmond, WA 98052", + "queryType": "NON_NEAR", + "queryTime": 58, + "numResults": 1, + "offset": 0, + "totalResults": 1, + "fuzzyLevel": 1 + }, + "results": [ + { + "type": "Point Address", + "id": "US/PAD/p0/19173426", + "score": 14.51, + "address": { + "streetNumber": "15127", + "streetName": "NE 24th St", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond, Adelaide, Ames Lake, Avondale, Earlmount", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980525544", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "15127 NE 24th St, Redmond, WA 980525544", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.6308, + "lon": -122.1385 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.6317, + "lon": -122.13983 + }, + "btmRightPoint": { + "lat": 47.6299, + "lon": -122.13717 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.6315, + "lon": -122.13852 + } + } + ] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchAddressBatch.json b/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchAddressBatch.json new file mode 100644 index 000000000000..987e58519b62 --- /dev/null +++ b/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchAddressBatch.json @@ -0,0 +1,291 @@ +{ + "parameters": { + "geography": "us", + "format": "11111111-2222-3333-4444-555555555555", + "api-version": "1.0" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "summary": { + "successfulRequests": 3, + "totalRequests": 3 + }, + "batchItems": [ + { + "statusCode": 200, + "response": { + "summary": { + "query": "400 broad st seattle wa 98109", + "queryType": "NON_NEAR", + "queryTime": 127, + "numResults": 3, + "offset": 0, + "totalResults": 9, + "fuzzyLevel": 1 + }, + "results": [ + { + "type": "Point Address", + "id": "US/PAD/p0/20843845", + "score": 11.966, + "address": { + "streetNumber": "400", + "streetName": "Broad Street", + "municipalitySubdivision": "Seattle, South Lake Union, Lower Queen Anne", + "municipality": "Seattle", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle", + "countrySubdivision": "WA", + "postalCode": "98109", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "400 Broad Street, Seattle, WA 98109", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.62039, + "lon": -122.34928 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.62129, + "lon": -122.35061 + }, + "btmRightPoint": { + "lat": 47.61949, + "lon": -122.34795 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.61982, + "lon": -122.34886 + } + } + ] + }, + { + "type": "Street", + "id": "US/STR/p0/388442", + "score": 10.225, + "address": { + "streetName": "Broad Street", + "municipalitySubdivision": "Seattle, South Lake Union", + "municipality": "Seattle", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle", + "countrySubdivision": "WA", + "postalCode": "98109", + "extendedPostalCode": "981094612", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "Broad Street, Seattle, WA 98109", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.62001, + "lon": -122.34843 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.61965, + "lon": -122.34761 + }, + "btmRightPoint": { + "lat": 47.62066, + "lon": -122.349 + } + } + }, + { + "type": "Street", + "id": "US/STR/p0/388680", + "score": 10.225, + "address": { + "streetName": "Broad Street", + "municipalitySubdivision": "Seattle, Belltown", + "municipality": "Seattle", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle", + "countrySubdivision": "WA", + "postalCode": "98109,98121", + "extendedPostalCode": "981094991,981211117,981211237,981213206", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "Broad Street, Seattle, WA", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.61691, + "lon": -122.35251 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.61502, + "lon": -122.35041 + }, + "btmRightPoint": { + "lat": 47.61857, + "lon": -122.35484 + } + } + } + ] + } + }, + { + "statusCode": 200, + "response": { + "summary": { + "query": "one microsoft way redmond wa 98052", + "queryType": "NON_NEAR", + "queryTime": 169, + "numResults": 2, + "offset": 0, + "totalResults": 3292, + "fuzzyLevel": 2 + }, + "results": [ + { + "type": "Street", + "id": "US/STR/p0/1692663", + "score": 10.225, + "address": { + "streetName": "Microsoft Way", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980526399,980528300", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "Microsoft Way, Redmond, WA 98052", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.63989, + "lon": -122.12509 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.63748, + "lon": -122.12309 + }, + "btmRightPoint": { + "lat": 47.64223, + "lon": -122.13061 + } + } + }, + { + "type": "Cross Street", + "id": "US/XSTR/p1/4779971", + "score": 8.506, + "address": { + "streetName": "Microsoft Way & 157th Avenue Northeast, Microsoft Way", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "Microsoft Way & 157th Avenue Northeast, Redmond, WA 98052", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.63962, + "lon": -122.13061 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.64052, + "lon": -122.13194 + }, + "btmRightPoint": { + "lat": 47.63872, + "lon": -122.12928 + } + } + } + ] + } + }, + { + "statusCode": 200, + "response": { + "summary": { + "query": "350 5th ave new york ny 10118", + "queryType": "NON_NEAR", + "queryTime": 233, + "numResults": 1, + "offset": 0, + "totalResults": 8032, + "fuzzyLevel": 1 + }, + "results": [ + { + "type": "Point Address", + "id": "US/PAD/p0/48052000", + "score": 14.334, + "address": { + "streetNumber": "350", + "streetName": "5th Avenue", + "municipalitySubdivision": "New York, Midtown South", + "municipality": "New York, Manhattan", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10118", + "extendedPostalCode": "1011800", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "350 5th Avenue, NYC, NY 10118", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.74817, + "lon": -73.985 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.74907, + "lon": -73.98619 + }, + "btmRightPoint": { + "lat": 40.74727, + "lon": -73.98381 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.74808, + "lon": -73.98482 + } + } + ] + } + ] + } + } + ] + } + }, + "202": { + "description": "Batch request was accepted but is still being processed. Please try again in some time." + } + } +} diff --git a/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchAddressReverse.json b/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchAddressReverse.json new file mode 100644 index 000000000000..ad5ad9cd0568 --- /dev/null +++ b/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchAddressReverse.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "query": "37.337,-121.89" + }, + "responses": { + "200": { + "body": { + "summary": { + "queryTime": 5, + "numResults": 1 + }, + "addresses": [ + { + "address": { + "buildingNumber": "31", + "streetNumber": "31", + "routeNumbers": [], + "street": "N 2nd St", + "streetName": "N 2nd St", + "streetNameAndNumber": "31 N 2nd St", + "countryCode": "US", + "countrySubdivision": "CA", + "countrySubdivisionName": "California", + "municipality": "San Jose", + "postalCode": "95113", + "country": "United States of America", + "countryCodeISO3": "USA", + "freeformAddress": "31 N 2nd St, San Jose CA 95113", + "extendedPostalCode": "951131217" + }, + "position": "37.337090,-121.889820" + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchAddressReverseBatch.json b/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchAddressReverseBatch.json new file mode 100644 index 000000000000..a9b1667e9418 --- /dev/null +++ b/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchAddressReverseBatch.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "geography": "us", + "format": "11111111-2222-3333-4444-555555555555", + "api-version": "1.0" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "summary": { + "successfulRequests": 3, + "totalRequests": 3 + }, + "batchItems": [ + { + "statusCode": 200, + "response": { + "summary": { + "queryTime": 8, + "numResults": 1 + }, + "addresses": [ + { + "address": { + "buildingNumber": "7", + "streetNumber": "7", + "routeNumbers": [], + "street": "Avenue Anatole France", + "streetName": "Avenue Anatole France", + "streetNameAndNumber": "7 Avenue Anatole France", + "countryCode": "FR", + "countrySubdivision": "Île-de-France", + "countrySecondarySubdivision": "Paris", + "municipality": "Paris", + "postalCode": "75007", + "municipalitySubdivision": "7ème Arrondissement", + "country": "France", + "countryCodeISO3": "FRA", + "freeformAddress": "7 Avenue Anatole France, Paris, 75007", + "boundingBox": { + "northEast": "48.858321,2.295167", + "southWest": "48.858136,2.295027", + "entity": "position" + } + }, + "position": "48.858231,2.295089" + } + ] + } + }, + { + "statusCode": 200, + "response": { + "summary": { + "queryTime": 8, + "numResults": 1 + }, + "addresses": [ + { + "address": { + "routeNumbers": [], + "countryCode": "US", + "countrySubdivision": "WA", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "municipality": "Redmond", + "postalCode": "98052", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "Redmond, WA 98052", + "boundingBox": { + "northEast": "47.639765,-122.128661", + "southWest": "47.639502,-122.129456", + "entity": "position" + }, + "countrySubdivisionName": "Washington" + }, + "position": "47.639687,-122.128677" + } + ] + } + }, + { + "statusCode": 200, + "response": { + "summary": { + "queryTime": 19, + "numResults": 1 + }, + "addresses": [ + { + "address": { + "buildingNumber": "410", + "streetNumber": "410", + "routeNumbers": [], + "street": "Thomas Street", + "streetName": "Thomas Street", + "streetNameAndNumber": "410 Thomas Street", + "countryCode": "US", + "countrySubdivision": "WA", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle", + "municipality": "Seattle", + "postalCode": "98109", + "municipalitySubdivision": "Seattle, Lower Queen Anne", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "410 Thomas Street, Seattle, WA 98109", + "boundingBox": { + "northEast": "47.620954,-122.347601", + "southWest": "47.620944,-122.348498", + "entity": "position" + }, + "extendedPostalCode": "981094621", + "countrySubdivisionName": "Washington" + }, + "position": "47.620945,-122.348175" + } + ] + } + } + ] + } + }, + "202": { + "description": "Batch request was accepted but is still being processed. Please try again in some time." + } + } +} diff --git a/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchAddressReverseCrossStreet.json b/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchAddressReverseCrossStreet.json new file mode 100644 index 000000000000..f37eed7e5ed5 --- /dev/null +++ b/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchAddressReverseCrossStreet.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "query": "37.337,-121.89" + }, + "responses": { + "200": { + "body": { + "summary": { + "numResults": 1, + "queryTime": 41 + }, + "addresses": [ + { + "address": { + "streetName": "East Santa Clara Street & North 2nd Street", + "crossStreet": "East Santa Clara Street", + "municipalitySubdivision": "San Jose, Downtown San Jose", + "municipality": "San Jose", + "countrySecondarySubdivision": "Santa Clara", + "countryTertiarySubdivision": "San Jose", + "countrySubdivision": "CA", + "postalCode": "95113", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "East Santa Clara Street & North 2nd Street, San Jose, CA 95113", + "countrySubdivisionName": "California", + "street": "North 2nd Street" + }, + "position": "37.33666,-121.88951" + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchAddressStructured.json b/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchAddressStructured.json new file mode 100644 index 000000000000..9c0e09610c0d --- /dev/null +++ b/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchAddressStructured.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "countryCode": "US", + "streetName": "NE%2024th%20Street", + "streetNumber": "15127", + "municipality": "Redmond", + "countrySubdivision": "WA", + "postalCode": "98052" + }, + "responses": { + "200": { + "body": { + "summary": { + "query": "15127 98052 ne redmond wa", + "queryType": "NON_NEAR", + "queryTime": 57, + "numResults": 1, + "offset": 0, + "totalResults": 34, + "fuzzyLevel": 1, + "geoBias": { + "lat": 47.30129317913035, + "lon": -120.88247999999997 + } + }, + "results": [ + { + "type": "Point Address", + "id": "US/PAD/p0/37974392", + "score": 8.074, + "dist": 101274.64693865852, + "address": { + "streetNumber": "15127", + "streetName": "NE 24th St", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond, Earlmount, Avondale, Ames Lake, Adelaide", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980525544", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "15127 NE 24th St, Redmond, WA 98052", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.6308, + "lon": -122.1385 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.6317, + "lon": -122.13983 + }, + "btmRightPoint": { + "lat": 47.6299, + "lon": -122.13717 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.6315, + "lon": -122.13852 + } + } + ] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchFuzzy.json b/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchFuzzy.json new file mode 100644 index 000000000000..7c65cebe967e --- /dev/null +++ b/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchFuzzy.json @@ -0,0 +1,658 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "query": "seattle" + }, + "responses": { + "200": { + "body": { + "summary": { + "query": "seattle", + "queryType": "NON_NEAR", + "queryTime": 66, + "numResults": 10, + "offset": 0, + "totalResults": 3720, + "fuzzyLevel": 1 + }, + "results": [ + { + "type": "Geography", + "id": "US/GEO/p0/188055", + "score": 2.531, + "entityType": "Municipality", + "address": { + "municipality": "Seattle", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle", + "countrySubdivision": "WA", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "Seattle, WA", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.60323, + "lon": -122.33028 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.7344, + "lon": -122.4594 + }, + "btmRightPoint": { + "lat": 47.48106, + "lon": -122.22497 + } + }, + "dataSources": { + "geometry": { + "id": "00005557-4100-3c00-0000-0000596ae8ed" + } + } + }, + { + "type": "Geography", + "id": "US/GEO/p0/183911", + "score": 2.382, + "entityType": "Municipality", + "address": { + "municipality": "Seattle", + "countrySecondarySubdivision": "King", + "countrySubdivision": "WA", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "Seattle, WA", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.55342, + "lon": -122.25007 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.58995, + "lon": -122.26723 + }, + "btmRightPoint": { + "lat": 47.5169, + "lon": -122.23291 + } + }, + "dataSources": { + "geometry": { + "id": "00005557-4100-3c00-0000-00006553f33d" + } + } + }, + { + "type": "POI", + "id": "ZA/POI/p0/449288", + "score": 2.226, + "info": "search:ta:710009004165863-ZA", + "poi": { + "name": "Seattle Coffee Co - Groote Kerk Sentrum", + "brands": [ + { + "name": "Seattle Coffee Company" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.seattlecoffeecompany.co.za", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetName": "Kloof Street", + "municipalitySubdivision": "Cape Town", + "municipality": "Cape Town", + "countrySecondarySubdivision": "City of Cape Town", + "countrySubdivision": "Western Cape", + "postalCode": "8001", + "countryCode": "ZA", + "country": "South Africa", + "countryCodeISO3": "ZAF", + "freeformAddress": "Kloof Street, Gardens, City of Cape Town, Western Cape, 8001", + "localName": "Gardens" + }, + "position": { + "lat": -33.92917, + "lon": 18.41178 + }, + "viewport": { + "topLeftPoint": { + "lat": -33.92827, + "lon": 18.4107 + }, + "btmRightPoint": { + "lat": -33.93007, + "lon": 18.41286 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": -33.92907, + "lon": 18.41162 + } + } + ] + }, + { + "type": "POI", + "id": "ZA/POI/p0/449396", + "score": 2.226, + "info": "search:ta:710009004163591-ZA", + "poi": { + "name": "Seattle Coffee Co - Pietermaritzburg", + "phone": "+(27)-(33)-3458486", + "brands": [ + { + "name": "Seattle Coffee Company" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.seattlecoffeecompany.co.za", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "9", + "streetName": "Armitage Road", + "municipalitySubdivision": "Pietermaritzburg City, Pietermaritzburg", + "municipality": "Pietermaritzburg", + "countrySecondarySubdivision": "The Msunduzi", + "countrySubdivision": "KwaZulu-Natal", + "postalCode": "3201", + "countryCode": "ZA", + "country": "South Africa", + "countryCodeISO3": "ZAF", + "freeformAddress": "Armitage Road 9, Athlone, The Msunduzi, KwaZulu-Natal, 3201", + "localName": "Athlone" + }, + "position": { + "lat": -29.58611, + "lon": 30.37508 + }, + "viewport": { + "topLeftPoint": { + "lat": -29.58521, + "lon": 30.37405 + }, + "btmRightPoint": { + "lat": -29.58701, + "lon": 30.37611 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": -29.58668, + "lon": 30.37531 + } + } + ] + }, + { + "type": "POI", + "id": "ZA/POI/p0/451868", + "score": 2.226, + "info": "search:ta:710009002195538-ZA", + "poi": { + "name": "Seattle Coffee Co - Bedford Village", + "phone": "+(27)-(84)-5451111", + "brands": [ + { + "name": "Seattle Coffee Company" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.seattlecoffeecompany.co.za", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetName": "Van Buuren Road", + "municipalitySubdivision": "Bedfordview", + "municipality": "Germiston", + "countrySecondarySubdivision": "Ekurhuleni", + "countrySubdivision": "Gauteng", + "postalCode": "2007", + "countryCode": "ZA", + "country": "South Africa", + "countryCodeISO3": "ZAF", + "freeformAddress": "Van Buuren Road, Bedfordview, Ekurhuleni, Gauteng, 2007", + "localName": "Bedfordview" + }, + "position": { + "lat": -26.18009, + "lon": 28.13544 + }, + "viewport": { + "topLeftPoint": { + "lat": -26.17919, + "lon": 28.13444 + }, + "btmRightPoint": { + "lat": -26.18099, + "lon": 28.13644 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": -26.18006, + "lon": 28.13636 + } + } + ] + }, + { + "type": "POI", + "id": "ZA/POI/p0/488888", + "score": 2.226, + "info": "search:ta:710009002102639-ZA", + "poi": { + "name": "Seattle Coffee Co - Caltex Starstop Milly's", + "phone": "+(27)-(13)-2560340", + "brands": [ + { + "name": "Seattle Coffee Company" + } + ], + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "municipality": "Wonderfontein", + "countrySecondarySubdivision": "Emakhazeni", + "countrySubdivision": "Mpumalanga", + "countryCode": "ZA", + "country": "South Africa", + "countryCodeISO3": "ZAF", + "freeformAddress": "Wonderfontein, Emakhazeni, Mpumalanga" + }, + "position": { + "lat": -25.68842, + "lon": 30.21291 + }, + "viewport": { + "topLeftPoint": { + "lat": -25.68752, + "lon": 30.21191 + }, + "btmRightPoint": { + "lat": -25.68932, + "lon": 30.21391 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": -25.68913, + "lon": 30.21343 + } + } + ] + }, + { + "type": "POI", + "id": "ZA/POI/p0/489433", + "score": 2.226, + "info": "search:ta:710009002184068-ZA", + "poi": { + "name": "Seattle Coffee Co - Southcoast Mall", + "phone": "+(27)-(39)-3150816", + "brands": [ + { + "name": "Seattle Coffee Company" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.seattlecoffeecompany.co.za", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "municipalitySubdivision": "Shelly Beach", + "municipality": "Shelly Beach", + "countrySecondarySubdivision": "Hibiscus Coast", + "countrySubdivision": "KwaZulu-Natal", + "postalCode": "4265", + "countryCode": "ZA", + "country": "South Africa", + "countryCodeISO3": "ZAF", + "freeformAddress": "Shelly Beach, Hibiscus Coast, KwaZulu-Natal, 4265", + "localName": "Shelly Beach" + }, + "position": { + "lat": -30.79937, + "lon": 30.40569 + }, + "viewport": { + "topLeftPoint": { + "lat": -30.79847, + "lon": 30.40464 + }, + "btmRightPoint": { + "lat": -30.80027, + "lon": 30.40674 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": -30.7994, + "lon": 30.40618 + } + } + ] + }, + { + "type": "POI", + "id": "ZA/POI/p0/489976", + "score": 2.226, + "info": "search:ta:710009004261897-ZA", + "poi": { + "name": "Seattle Cofee Co", + "phone": "+(27)-(39)-3150816", + "brands": [ + { + "name": "Seattle Coffee Company" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.seattlecoffeecompany.co.za", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "municipalitySubdivision": "Shelly Beach", + "municipality": "Shelly Beach", + "countrySecondarySubdivision": "Hibiscus Coast", + "countrySubdivision": "KwaZulu-Natal", + "postalCode": "4265", + "countryCode": "ZA", + "country": "South Africa", + "countryCodeISO3": "ZAF", + "freeformAddress": "Shelly Beach, Hibiscus Coast, KwaZulu-Natal, 4265", + "localName": "Shelly Beach" + }, + "position": { + "lat": -30.79801, + "lon": 30.40557 + }, + "viewport": { + "topLeftPoint": { + "lat": -30.79711, + "lon": 30.40452 + }, + "btmRightPoint": { + "lat": -30.79891, + "lon": 30.40662 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": -30.79784, + "lon": 30.40523 + } + } + ] + }, + { + "type": "POI", + "id": "ZA/POI/p0/490056", + "score": 2.226, + "info": "search:ta:710009004149612-ZA", + "poi": { + "name": "Seattle Coffee Co - Constantia Village", + "brands": [ + { + "name": "Seattle Coffee Company" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.seattlecoffeecompany.co.za", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetName": "Constantia Main Road", + "municipalitySubdivision": "Cape Town", + "municipality": "Cape Town", + "countrySecondarySubdivision": "City of Cape Town", + "countrySubdivision": "Western Cape", + "postalCode": "7708", + "countryCode": "ZA", + "country": "South Africa", + "countryCodeISO3": "ZAF", + "freeformAddress": "Constantia Main Road, Constantia, City of Cape Town, Western Cape, 7708", + "localName": "Constantia" + }, + "position": { + "lat": -34.02087, + "lon": 18.44503 + }, + "viewport": { + "topLeftPoint": { + "lat": -34.01997, + "lon": 18.44394 + }, + "btmRightPoint": { + "lat": -34.02177, + "lon": 18.44612 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": -34.02017, + "lon": 18.44476 + } + } + ] + }, + { + "type": "POI", + "id": "ZA/POI/p0/494340", + "score": 2.226, + "info": "search:ta:710009004152570-ZA", + "poi": { + "name": "Seattle Coffee Co - Canal Walk Shopping Centre", + "brands": [ + { + "name": "Seattle Coffee Company" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.seattlecoffeecompany.co.za", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetName": "Century Boulevard", + "municipalitySubdivision": "Milnerton", + "municipality": "Cape Town", + "countrySecondarySubdivision": "City of Cape Town", + "countrySubdivision": "Western Cape", + "postalCode": "7441", + "countryCode": "ZA", + "country": "South Africa", + "countryCodeISO3": "ZAF", + "freeformAddress": "Century Boulevard, Century City, City of Cape Town, Western Cape, 7441", + "localName": "Century City" + }, + "position": { + "lat": -33.89348, + "lon": 18.5122 + }, + "viewport": { + "topLeftPoint": { + "lat": -33.89258, + "lon": 18.51112 + }, + "btmRightPoint": { + "lat": -33.89438, + "lon": 18.51328 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": -33.8943, + "lon": 18.51328 + } + } + ] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchFuzzyBatch.json b/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchFuzzyBatch.json new file mode 100644 index 000000000000..91836d244612 --- /dev/null +++ b/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchFuzzyBatch.json @@ -0,0 +1,1394 @@ +{ + "parameters": { + "geography": "us", + "format": "11111111-2222-3333-4444-555555555555", + "api-version": "1.0" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "batchItems": [ + { + "statusCode": 200, + "response": { + "summary": { + "query": "atm", + "queryType": "NON_NEAR", + "queryTime": 5, + "numResults": 5, + "offset": 0, + "totalResults": 262, + "fuzzyLevel": 1, + "geoBias": { + "lat": 47.639769, + "lon": -122.128362 + } + }, + "results": [ + { + "type": "POI", + "id": "US/POI/p0/3656546", + "score": 2.671, + "dist": 1336.1815386162032, + "info": "search:ta:840539002005905-US", + "poi": { + "name": "US Bank ATM-MONEYPASS", + "brands": [ + { + "name": "US Bank ATM" + } + ], + "categorySet": [ + { + "id": 7397 + } + ], + "classifications": [ + { + "code": "CASH_DISPENSER", + "names": [ + { + "nameLocale": "en-US", + "name": "cash dispenser" + } + ] + } + ] + }, + "address": { + "streetNumber": "14808", + "streetName": "NE 24th St", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "14808 NE 24th St, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.63229, + "lon": -122.14232 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.63319, + "lon": -122.14365 + }, + "btmRightPoint": { + "lat": 47.63139, + "lon": -122.14099 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.63154, + "lon": -122.1423 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/8673325", + "score": 2.671, + "dist": 1206.8488178244172, + "info": "search:ta:840539002022072-US", + "poi": { + "name": "US Bank ATM NATIONAL ASSOCIATION", + "brands": [ + { + "name": "US Bank ATM" + } + ], + "categorySet": [ + { + "id": 7397 + } + ], + "classifications": [ + { + "code": "CASH_DISPENSER", + "names": [ + { + "nameLocale": "en-US", + "name": "cash dispenser" + } + ] + } + ] + }, + "address": { + "streetNumber": "15000", + "streetName": "Northeast 24Th Street", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980525522", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "15000 Northeast 24Th Street, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.63265, + "lon": -122.14052 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.63355, + "lon": -122.14185 + }, + "btmRightPoint": { + "lat": 47.63175, + "lon": -122.13919 + } + }, + "entryPoints": [ + { + "type": "minor", + "position": { + "lat": 47.63156, + "lon": -122.14056 + } + }, + { + "type": "minor", + "position": { + "lat": 47.63156, + "lon": -122.14058 + } + }, + { + "type": "main", + "position": { + "lat": 47.63156, + "lon": -122.14048 + } + }, + { + "type": "main", + "position": { + "lat": 47.6324, + "lon": -122.13938 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/2736315", + "score": 2.671, + "dist": 864.75917765198585, + "info": "search:ta:840539002187855-US", + "poi": { + "name": "US Bank ATM-MONEYPASS", + "brands": [ + { + "name": "US Bank ATM" + } + ], + "categorySet": [ + { + "id": 7397 + } + ], + "classifications": [ + { + "code": "CASH_DISPENSER", + "names": [ + { + "nameLocale": "en-US", + "name": "cash dispenser" + } + ] + } + ] + }, + "address": { + "streetNumber": "15521", + "streetName": "Bel Red Rd", + "municipalitySubdivision": "Redmond, Northeast Bellevue, Bellevue", + "municipality": "Redmond, Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980525501", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "15521 Bel Red Rd, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.63259, + "lon": -122.1328 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.63349, + "lon": -122.13413 + }, + "btmRightPoint": { + "lat": 47.63169, + "lon": -122.13147 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.63255, + "lon": -122.13275 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/3656412", + "score": 2.67, + "dist": 2140.1985385809412, + "info": "search:ta:840539001998867-US", + "poi": { + "name": "US Bank ATM NATIONAL ASSOCIATION", + "brands": [ + { + "name": "US Bank ATM" + } + ], + "categorySet": [ + { + "id": 7397 + } + ], + "classifications": [ + { + "code": "CASH_DISPENSER", + "names": [ + { + "nameLocale": "en-US", + "name": "cash dispenser" + } + ] + } + ] + }, + "address": { + "streetNumber": "1128", + "streetName": "156th Ave NE", + "municipalitySubdivision": "Crossroads, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98007", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "1128 156th Ave NE, Bellevue, WA 98007", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.62069, + "lon": -122.13213 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.62159, + "lon": -122.13346 + }, + "btmRightPoint": { + "lat": 47.61979, + "lon": -122.1308 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.62069, + "lon": -122.13236 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/2736876", + "score": 2.67, + "dist": 2140.1985385809412, + "info": "search:ta:840539001396789-US", + "poi": { + "name": "US Bank ATM", + "phone": "+(1)-(800)-8722657", + "brands": [ + { + "name": "US Bank ATM" + } + ], + "categorySet": [ + { + "id": 7397 + } + ], + "url": "www.usbank.com", + "classifications": [ + { + "code": "CASH_DISPENSER", + "names": [ + { + "nameLocale": "en-US", + "name": "cash dispenser" + } + ] + } + ] + }, + "address": { + "streetNumber": "1128", + "streetName": "156th Ave NE", + "municipalitySubdivision": "Crossroads, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98007", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "1128 156th Ave NE, Bellevue, WA 98007", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.62069, + "lon": -122.13213 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.62159, + "lon": -122.13346 + }, + "btmRightPoint": { + "lat": 47.61979, + "lon": -122.1308 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.62069, + "lon": -122.13236 + } + } + ] + } + ] + } + }, + { + "statusCode": 200, + "response": { + "summary": { + "query": "statue of liberty", + "queryType": "NON_NEAR", + "queryTime": 37, + "numResults": 2, + "offset": 0, + "totalResults": 18, + "fuzzyLevel": 1 + }, + "results": [ + { + "type": "POI", + "id": "US/POI/p0/9189660", + "score": 6.942, + "info": "search:ta:840369001174316-US", + "poi": { + "name": "Statue of Liberty", + "categorySet": [ + { + "id": 7376003 + } + ], + "classifications": [ + { + "code": "IMPORTANT_TOURIST_ATTRACTION", + "names": [ + { + "nameLocale": "en-US", + "name": "monument" + }, + { + "nameLocale": "en-US", + "name": "important tourist attraction" + } + ] + } + ] + }, + "address": { + "municipalitySubdivision": "New York", + "municipality": "New York", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10004", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "New York, NY 10004", + "localName": "New York", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.68955, + "lon": -74.04483 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.69045, + "lon": -74.04602 + }, + "btmRightPoint": { + "lat": 40.68865, + "lon": -74.04364 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.69001, + "lon": -74.04683 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/3264566", + "score": 6.942, + "info": "search:ta:840019000670588-US", + "poi": { + "name": "Statue of Liberty", + "phone": "+(1)-(205)-9700251", + "categorySet": [ + { + "id": 7376003 + } + ], + "url": "www.1bsa.org", + "classifications": [ + { + "code": "IMPORTANT_TOURIST_ATTRACTION", + "names": [ + { + "nameLocale": "en-US", + "name": "important tourist attraction" + } + ] + } + ] + }, + "address": { + "streetNumber": "516", + "streetName": "Liberty Pkwy", + "municipalitySubdivision": "Vestavia Hills", + "municipality": "Vestavia Hills, Birmingham", + "countrySecondarySubdivision": "Jefferson", + "countryTertiarySubdivision": "Leeds", + "countrySubdivision": "AL", + "postalCode": "35242", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "516 Liberty Pkwy, Vestavia Hills, AL 35242", + "localName": "Vestavia Hills", + "countrySubdivisionName": "Alabama" + }, + "position": { + "lat": 33.48234, + "lon": -86.70719 + }, + "viewport": { + "topLeftPoint": { + "lat": 33.48324, + "lon": -86.70827 + }, + "btmRightPoint": { + "lat": 33.48144, + "lon": -86.70611 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 33.48129, + "lon": -86.7065 + } + } + ] + } + ] + } + }, + { + "statusCode": 200, + "response": { + "summary": { + "query": "starbucks", + "queryType": "NON_NEAR", + "queryTime": 35, + "numResults": 10, + "offset": 0, + "totalResults": 17, + "fuzzyLevel": 1, + "geoBias": { + "lat": 47.639769, + "lon": -122.128362 + } + }, + "results": [ + { + "type": "POI", + "id": "US/POI/p0/153678", + "score": 2.671, + "dist": 1206.8488178244172, + "info": "search:ta:840531000006554-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-8695816", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/site-selector", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "15000", + "streetName": "NE 24th St", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980525522", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "15000 NE 24th St, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.63265, + "lon": -122.14052 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.63355, + "lon": -122.14185 + }, + "btmRightPoint": { + "lat": 47.63175, + "lon": -122.13919 + } + }, + "entryPoints": [ + { + "type": "minor", + "position": { + "lat": 47.63156, + "lon": -122.14056 + } + }, + { + "type": "minor", + "position": { + "lat": 47.63156, + "lon": -122.14058 + } + }, + { + "type": "main", + "position": { + "lat": 47.63156, + "lon": -122.14048 + } + }, + { + "type": "main", + "position": { + "lat": 47.6324, + "lon": -122.13938 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/152316", + "score": 2.67, + "dist": 2315.294397491255, + "info": "search:ta:840539000484552-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-6436471", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/store/15097", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "15600", + "streetName": "NE 8th St", + "municipalitySubdivision": "Crossroads, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98008", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "15600 NE 8th St, Bellevue, WA 98008", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.61896, + "lon": -122.12945 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.61986, + "lon": -122.13078 + }, + "btmRightPoint": { + "lat": 47.61806, + "lon": -122.12812 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.619, + "lon": -122.12945 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/167545", + "score": 2.67, + "dist": 1979.2222952267998, + "info": "search:ta:840539001950429-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-7470690", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/site-selector", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "1350", + "streetName": "156th Ave NE", + "municipalitySubdivision": "Crossroads, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98007", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "1350 156th Ave NE, Bellevue, WA 98007", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.62212, + "lon": -122.13179 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.62302, + "lon": -122.13312 + }, + "btmRightPoint": { + "lat": 47.62122, + "lon": -122.13046 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.62213, + "lon": -122.13236 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/168519", + "score": 2.67, + "dist": 2490.3337046455963, + "info": "search:ta:840539001015090-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-4556500", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "https://www.starbucks.com/store-locator/store/15901", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "1645", + "streetName": "140th Ave NE", + "municipalitySubdivision": "Crossroads, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98005", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "1645 140th Ave NE, Bellevue, WA 98005", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.62626, + "lon": -122.15487 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.62716, + "lon": -122.1562 + }, + "btmRightPoint": { + "lat": 47.62536, + "lon": -122.15354 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.62645, + "lon": -122.15446 + } + }, + { + "type": "minor", + "position": { + "lat": 47.62579, + "lon": -122.15377 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/152428", + "score": 2.668, + "dist": 3529.7080738812224, + "info": "search:ta:840539001033722-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-3789496", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/site-selector", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "180", + "streetName": "148th Ave SE", + "municipalitySubdivision": "West Lake Hills, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98007", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "180 148th Ave SE, Bellevue, WA 98007", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.60901, + "lon": -122.14 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.60991, + "lon": -122.14133 + }, + "btmRightPoint": { + "lat": 47.60811, + "lon": -122.13867 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.60901, + "lon": -122.14008 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/167147", + "score": 2.668, + "dist": 3479.393294615887, + "info": "search:ta:840539000326896-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-8619198", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/site-selector", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "7425", + "streetName": "166th Ave NE", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980526288", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "7425 166th Ave NE, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.67055, + "lon": -122.12001 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.67145, + "lon": -122.12135 + }, + "btmRightPoint": { + "lat": 47.66965, + "lon": -122.11867 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.67069, + "lon": -122.11889 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/153695", + "score": 2.667, + "dist": 3622.4410746187291, + "info": "search:ta:840531000006551-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-8822881", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/store/15022", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "7625", + "streetName": "170th Ave NE", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980520910", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "7625 170th Ave NE, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.67086, + "lon": -122.11392 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.67176, + "lon": -122.11526 + }, + "btmRightPoint": { + "lat": 47.66996, + "lon": -122.11258 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.67073, + "lon": -122.1135 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/167420", + "score": 2.667, + "dist": 3818.293513029088, + "info": "search:ta:840539000640782-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-8853323", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/site-selector", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "17246", + "streetName": "Redmond Way", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980524403", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "17246 Redmond Way, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.67174, + "lon": -122.10976 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.67264, + "lon": -122.1111 + }, + "btmRightPoint": { + "lat": 47.67084, + "lon": -122.10842 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.6706, + "lon": -122.11026 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/153686", + "score": 2.666, + "dist": 4009.9222051470738, + "info": "search:ta:840531000006548-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-8859590", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/site-selector", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "15738", + "streetName": "Redmond Way Pad 3 Redmond Center", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980523873", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "15738 Redmond Way Pad 3 Redmond Center, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.67583, + "lon": -122.12877 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.67673, + "lon": -122.13011 + }, + "btmRightPoint": { + "lat": 47.67493, + "lon": -122.12743 + } + }, + "entryPoints": [ + { + "type": "minor", + "position": { + "lat": 47.67456, + "lon": -122.12887 + } + }, + { + "type": "main", + "position": { + "lat": 47.67668, + "lon": -122.12829 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/168511", + "score": 2.666, + "dist": 3987.80992387863, + "info": "search:ta:840531000006669-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-8818265", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/site-selector", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "6617", + "streetName": "132Nd Ave Ne Bridle Trails Shopping Center", + "municipalitySubdivision": "Kirkland, Bridle Trails", + "municipality": "Kirkland", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98033", + "extendedPostalCode": "980338234", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "6617 132Nd Ave Ne Bridle Trails Shopping Center, Kirkland, WA 98033", + "localName": "Kirkland", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.66514, + "lon": -122.16599 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.66604, + "lon": -122.16733 + }, + "btmRightPoint": { + "lat": 47.66424, + "lon": -122.16465 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.666, + "lon": -122.16669 + } + }, + { + "type": "minor", + "position": { + "lat": 47.66553, + "lon": -122.16405 + } + } + ] + } + ] + } + } + ], + "summary": { + "successfulRequests": 3, + "totalRequests": 3 + } + } + }, + "202": { + "description": "Batch request was accepted but is still being processed. Please try again in some time." + } + } +} diff --git a/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchNearby.json b/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchNearby.json new file mode 100644 index 000000000000..c8954152fcc2 --- /dev/null +++ b/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchNearby.json @@ -0,0 +1,718 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "lat": 40.706270, + "lon": -74.011454, + "radius": 8046, + "limit": 10 + }, + "responses": { + "200": { + "body": { + "summary": { + "queryType": "NEARBY", + "queryTime": 137, + "numResults": 10, + "offset": 0, + "totalResults": 256620, + "fuzzyLevel": 1, + "geoBias": { + "lat": 40.70627, + "lon": -74.011454 + } + }, + "results": [ + { + "type": "POI", + "id": "US/POI/p1/7652731", + "score": 1, + "dist": 14.736843483489132, + "info": "search:ta:840369002225435-US", + "poi": { + "name": "Ycd Multimedia", + "phone": "+(1)-(212)-5091049", + "categorySet": [ + { + "id": 9152 + } + ], + "classifications": [ + { + "code": "NON_GOVERNMENTAL_ORGANIZATION", + "names": [ + { + "nameLocale": "en-US", + "name": "non governmental organization" + } + ] + } + ] + }, + "address": { + "streetNumber": "55", + "streetName": "Exchange Pl", + "municipalitySubdivision": "New York City, NYC, New York, Financial District", + "municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10004", + "extendedPostalCode": "100042320", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "55 Exchange Pl, New York, NY 10004", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.7064, + "lon": -74.01142 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.7073, + "lon": -74.01261 + }, + "btmRightPoint": { + "lat": 40.7055, + "lon": -74.01023 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.70636, + "lon": -74.01145 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/7652732", + "score": 1, + "dist": 14.736843483489132, + "info": "search:ta:840369001882610-US", + "poi": { + "name": "Grubb & Ellis Management Services", + "phone": "+(1)-(212)-7851619", + "categorySet": [ + { + "id": 9352039 + } + ], + "classifications": [ + { + "code": "COMPANY", + "names": [ + { + "nameLocale": "en-US", + "name": "company" + }, + { + "nameLocale": "en-US", + "name": "services" + } + ] + } + ] + }, + "address": { + "streetNumber": "55", + "streetName": "Exchange Pl", + "municipalitySubdivision": "New York City, NYC, New York, Financial District", + "municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10004", + "extendedPostalCode": "100042320", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "55 Exchange Pl, New York, NY 10004", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.7064, + "lon": -74.01142 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.7073, + "lon": -74.01261 + }, + "btmRightPoint": { + "lat": 40.7055, + "lon": -74.01023 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.70636, + "lon": -74.01145 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/7652735", + "score": 1, + "dist": 14.736843483489132, + "info": "search:ta:840369001322824-US", + "poi": { + "name": "Hispanic Federation", + "phone": "+(1)-(212)-7420480", + "categorySet": [ + { + "id": 9910004 + } + ], + "url": "Hispanicfederation.org", + "classifications": [ + { + "code": "AUTOMOTIVE_DEALER", + "names": [ + { + "nameLocale": "en-US", + "name": "boat" + }, + { + "nameLocale": "en-US", + "name": "automotive dealer" + } + ] + } + ] + }, + "address": { + "streetNumber": "55", + "streetName": "Exchange Pl", + "municipalitySubdivision": "New York City, NYC, New York, Financial District", + "municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10004", + "extendedPostalCode": "100042320", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "55 Exchange Pl, New York, NY 10004", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.7064, + "lon": -74.01142 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.7073, + "lon": -74.01261 + }, + "btmRightPoint": { + "lat": 40.7055, + "lon": -74.01023 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.70636, + "lon": -74.01145 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/7652736", + "score": 1, + "dist": 14.736843483489132, + "info": "search:ta:840369000631230-US", + "poi": { + "name": "Edwin Gould Foundation", + "phone": "+(1)-(212)-9825200", + "categorySet": [ + { + "id": 9152 + } + ], + "url": "edwingouldfoundation.org", + "classifications": [ + { + "code": "NON_GOVERNMENTAL_ORGANIZATION", + "names": [ + { + "nameLocale": "en-US", + "name": "non governmental organization" + } + ] + } + ] + }, + "address": { + "streetNumber": "55", + "streetName": "Exchange Pl", + "municipalitySubdivision": "New York City, NYC, New York, Financial District", + "municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10004", + "extendedPostalCode": "100042320", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "55 Exchange Pl, New York, NY 10004", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.7064, + "lon": -74.01142 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.7073, + "lon": -74.01261 + }, + "btmRightPoint": { + "lat": 40.7055, + "lon": -74.01023 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.70636, + "lon": -74.01145 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/7652737", + "score": 1, + "dist": 14.736843483489132, + "info": "search:ta:840369001196585-US", + "poi": { + "name": "Newmark Grubb Knight Frank", + "phone": "+(1)-(646)-6951990", + "categorySet": [ + { + "id": 9361015 + } + ], + "url": "www.newmarkkf.com", + "classifications": [ + { + "code": "SHOP", + "names": [ + { + "nameLocale": "en-US", + "name": "shop" + }, + { + "nameLocale": "en-US", + "name": "real estate agents" + } + ] + } + ] + }, + "address": { + "streetNumber": "55", + "streetName": "Exchange Pl", + "municipalitySubdivision": "New York City, NYC, New York, Financial District", + "municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10004", + "extendedPostalCode": "100042320", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "55 Exchange Pl, New York, NY 10004", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.7064, + "lon": -74.01142 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.7073, + "lon": -74.01261 + }, + "btmRightPoint": { + "lat": 40.7055, + "lon": -74.01023 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.70636, + "lon": -74.01145 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/7652738", + "score": 1, + "dist": 14.736843483489132, + "info": "search:ta:840369002164164-US", + "poi": { + "name": "Sponsors For Educational Opportunity", + "phone": "+(1)-(212)-7851361", + "categorySet": [ + { + "id": 9152 + } + ], + "url": "www.seo-usa.org", + "classifications": [ + { + "code": "NON_GOVERNMENTAL_ORGANIZATION", + "names": [ + { + "nameLocale": "en-US", + "name": "non governmental organization" + } + ] + } + ] + }, + "address": { + "streetNumber": "55", + "streetName": "Exchange Pl", + "municipalitySubdivision": "New York City, NYC, New York, Financial District", + "municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10004", + "extendedPostalCode": "100042320", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "55 Exchange Pl, New York, NY 10004", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.7064, + "lon": -74.01142 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.7073, + "lon": -74.01261 + }, + "btmRightPoint": { + "lat": 40.7055, + "lon": -74.01023 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.70636, + "lon": -74.01145 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/7373205", + "score": 1, + "dist": 14.736843483489132, + "info": "search:ta:840361001736646-US", + "poi": { + "name": "Visiting Nurse Service", + "phone": "+(1)-(212)-7428259", + "categorySet": [ + { + "id": 9663 + } + ], + "url": "www.vnsny.org", + "classifications": [ + { + "code": "HEALTH_CARE_SERVICE", + "names": [ + { + "nameLocale": "en-US", + "name": "health care service" + } + ] + } + ] + }, + "address": { + "streetNumber": "55", + "streetName": "Exchange Pl", + "municipalitySubdivision": "New York City, NYC, New York, Financial District", + "municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10004", + "extendedPostalCode": "100042320", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "55 Exchange Pl, New York, NY 10004", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.7064, + "lon": -74.01142 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.7073, + "lon": -74.01261 + }, + "btmRightPoint": { + "lat": 40.7055, + "lon": -74.01023 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.70636, + "lon": -74.01145 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/7373206", + "score": 1, + "dist": 14.736843483489132, + "info": "search:ta:840361001326915-US", + "poi": { + "name": "Hispanic In Philanthropy", + "phone": "+(1)-(646)-2777101", + "categorySet": [ + { + "id": 9152 + } + ], + "url": "www.hiponline.org", + "classifications": [ + { + "code": "NON_GOVERNMENTAL_ORGANIZATION", + "names": [ + { + "nameLocale": "en-US", + "name": "non governmental organization" + } + ] + } + ] + }, + "address": { + "streetNumber": "55", + "streetName": "Exchange Pl", + "municipalitySubdivision": "New York City, NYC, New York, Financial District", + "municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10004", + "extendedPostalCode": "100042320", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "55 Exchange Pl, New York, NY 10004", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.7064, + "lon": -74.01142 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.7073, + "lon": -74.01261 + }, + "btmRightPoint": { + "lat": 40.7055, + "lon": -74.01023 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.70636, + "lon": -74.01145 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/7373207", + "score": 1, + "dist": 14.736843483489132, + "info": "search:ta:840369002316633-US", + "poi": { + "name": "Advantage Technical Resourcing", + "phone": "+(1)-(212)-2691140", + "categorySet": [ + { + "id": 9352039 + } + ], + "classifications": [ + { + "code": "COMPANY", + "names": [ + { + "nameLocale": "en-US", + "name": "company" + }, + { + "nameLocale": "en-US", + "name": "services" + } + ] + } + ] + }, + "address": { + "streetNumber": "55", + "streetName": "Exchange Pl", + "municipalitySubdivision": "New York City, NYC, New York, Financial District", + "municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10004", + "extendedPostalCode": "100042320", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "55 Exchange Pl, New York, NY 10004", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.7064, + "lon": -74.01142 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.7073, + "lon": -74.01261 + }, + "btmRightPoint": { + "lat": 40.7055, + "lon": -74.01023 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.70636, + "lon": -74.01145 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/7373208", + "score": 1, + "dist": 14.736843483489132, + "info": "search:ta:840369002031974-US", + "poi": { + "name": "Workshop In Bus Opportunities", + "phone": "+(1)-(212)-6840854", + "categorySet": [ + { + "id": 9352039 + } + ], + "url": "www.wibo.org", + "classifications": [ + { + "code": "COMPANY", + "names": [ + { + "nameLocale": "en-US", + "name": "company" + }, + { + "nameLocale": "en-US", + "name": "services" + } + ] + } + ] + }, + "address": { + "streetNumber": "55", + "streetName": "Exchange Pl", + "municipalitySubdivision": "New York City, NYC, New York, Financial District", + "municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10004", + "extendedPostalCode": "100042320", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "55 Exchange Pl, New York, NY 10004", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.7064, + "lon": -74.01142 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.7073, + "lon": -74.01261 + }, + "btmRightPoint": { + "lat": 40.7055, + "lon": -74.01023 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.70636, + "lon": -74.01145 + } + } + ] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchPOI.json b/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchPOI.json new file mode 100644 index 000000000000..155e4b217e23 --- /dev/null +++ b/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchPOI.json @@ -0,0 +1,412 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "query": "juice bars", + "limit": 5, + "lat": 47.606038, + "lon": -122.333345, + "radius": 8046 + }, + "responses": { + "200": { + "body": { + "summary": { + "query": "juice bars", + "queryType": "NON_NEAR", + "queryTime": 36, + "numResults": 5, + "offset": 0, + "totalResults": 12, + "fuzzyLevel": 1, + "geoBias": { + "lat": 47.606038, + "lon": -122.333345 + } + }, + "results": [ + { + "type": "POI", + "id": "US/POI/p0/9223158", + "score": 5.664, + "dist": 667.2710170950347, + "info": "search:ta:840539001755244-US", + "poi": { + "name": "Pressed Juicery", + "phone": "+(1)-(206)-6240804", + "brands": [ + { + "name": "Pressed Juicery" + } + ], + "categorySet": [ + { + "id": 7315149 + } + ], + "url": "www.pressedjuicery.com", + "classifications": [ + { + "code": "RESTAURANT", + "names": [ + { + "nameLocale": "en-US", + "name": "yogurt/juice bar" + }, + { + "nameLocale": "en-US", + "name": "restaurant" + } + ] + } + ] + }, + "address": { + "streetNumber": "400", + "streetName": "Pine St", + "municipalitySubdivision": "Seattle, Central Business District", + "municipality": "Seattle", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle", + "countrySubdivision": "WA", + "postalCode": "98101", + "extendedPostalCode": "981011628", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "400 Pine St, Seattle, WA 98101", + "localName": "Seattle", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.61138, + "lon": -122.3374 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.61228, + "lon": -122.33873 + }, + "btmRightPoint": { + "lat": 47.61048, + "lon": -122.33607 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.61134, + "lon": -122.33737 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/9222534", + "score": 5.663, + "dist": 1101.6849025777728, + "info": "search:ta:840539001760125-US", + "poi": { + "name": "Pressed Juicery", + "phone": "+(1)-(206)-4533785", + "brands": [ + { + "name": "Pressed Juicery" + } + ], + "categorySet": [ + { + "id": 7315149 + } + ], + "url": "www.pressedjuicery.com", + "classifications": [ + { + "code": "RESTAURANT", + "names": [ + { + "nameLocale": "en-US", + "name": "yogurt/juice bar" + }, + { + "nameLocale": "en-US", + "name": "restaurant" + } + ] + } + ] + }, + "address": { + "streetNumber": "315", + "streetName": "E Pine St", + "municipalitySubdivision": "Seattle, Broadway", + "municipality": "Seattle", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle", + "countrySubdivision": "WA", + "postalCode": "98122", + "extendedPostalCode": "9812200", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "315 E Pine St, Seattle, WA 98122", + "localName": "Seattle", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.61518, + "lon": -122.32768 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.61608, + "lon": -122.32901 + }, + "btmRightPoint": { + "lat": 47.61428, + "lon": -122.32635 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.61523, + "lon": -122.32768 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/9133689", + "score": 5.659, + "dist": 2649.8700791555398, + "info": "search:ta:840539001339220-US", + "poi": { + "name": "Pressed Juicery", + "phone": "+(1)-(206)-2820651", + "brands": [ + { + "name": "Pressed Juicery" + } + ], + "categorySet": [ + { + "id": 7315149 + } + ], + "url": "www.pressedjuicery.com", + "classifications": [ + { + "code": "RESTAURANT", + "names": [ + { + "nameLocale": "en-US", + "name": "yogurt/juice bar" + }, + { + "nameLocale": "en-US", + "name": "restaurant" + } + ] + } + ] + }, + "address": { + "streetNumber": "604", + "streetName": "1st Ave N", + "municipalitySubdivision": "Seattle, Lower Queen Anne", + "municipality": "Seattle", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle", + "countrySubdivision": "WA", + "postalCode": "98109", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "604 1st Ave N, Seattle, WA 98109", + "localName": "Seattle", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.6247, + "lon": -122.35533 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.6256, + "lon": -122.35666 + }, + "btmRightPoint": { + "lat": 47.6238, + "lon": -122.354 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.6247, + "lon": -122.3554 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/9131285", + "score": 5.646, + "dist": 5097.757019046541, + "info": "search:ta:840539001743255-US", + "poi": { + "name": "Custom Smoothie & Sports Nutrition", + "phone": "+(1)-(206)-5475522", + "categorySet": [ + { + "id": 7315149 + } + ], + "url": "www.customsmoothie.com", + "classifications": [ + { + "code": "RESTAURANT", + "names": [ + { + "nameLocale": "en-US", + "name": "yogurt/juice bar" + }, + { + "nameLocale": "en-US", + "name": "restaurant" + } + ] + } + ] + }, + "address": { + "streetNumber": "462", + "streetName": "N 34th St", + "municipalitySubdivision": "Seattle, Fremont", + "municipality": "Seattle", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle", + "countrySubdivision": "WA", + "postalCode": "98103", + "extendedPostalCode": "981038600", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "462 N 34th St, Seattle, WA 98103", + "localName": "Seattle", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.65016, + "lon": -122.35182 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.65106, + "lon": -122.35315 + }, + "btmRightPoint": { + "lat": 47.64926, + "lon": -122.35049 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.64991, + "lon": -122.3519 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/9228250", + "score": 5.637, + "dist": 6235.798481758295, + "info": "search:ta:840531000416784-US", + "poi": { + "name": "Jamba Juice", + "phone": "+(1)-(206)-6322060", + "brands": [ + { + "name": "Jamba Juice" + } + ], + "categorySet": [ + { + "id": 7315149 + } + ], + "url": "www.jambajuice.com", + "classifications": [ + { + "code": "RESTAURANT", + "names": [ + { + "nameLocale": "en-US", + "name": "yogurt/juice bar" + }, + { + "nameLocale": "en-US", + "name": "restaurant" + } + ] + } + ] + }, + "address": { + "streetNumber": "4555", + "streetName": "Stone Way N", + "municipalitySubdivision": "Wallingford, Seattle", + "municipality": "Seattle", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle", + "countrySubdivision": "WA", + "postalCode": "98103", + "extendedPostalCode": "981036600", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "4555 Stone Way N, Seattle, WA 98103", + "localName": "Seattle", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.66179, + "lon": -122.34233 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.66269, + "lon": -122.34367 + }, + "btmRightPoint": { + "lat": 47.66089, + "lon": -122.34099 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.66188, + "lon": -122.34211 + } + } + ] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchPOICategory.json b/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchPOICategory.json new file mode 100644 index 000000000000..bde6d68ce490 --- /dev/null +++ b/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchPOICategory.json @@ -0,0 +1,230 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "query": "atm", + "limit": 3, + "lat": 40.758953, + "lon": -73.985263, + "radius": 3200 + }, + "responses": { + "200": { + "body": { + "summary": { + "query": "atm", + "queryType": "NON_NEAR", + "queryTime": 28, + "numResults": 3, + "offset": 0, + "totalResults": 3696, + "fuzzyLevel": 1, + "geoBias": { + "lat": 40.758953, + "lon": -73.985263 + } + }, + "results": [ + { + "type": "POI", + "id": "US/POI/p0/7014613", + "score": 2.575, + "dist": 10.743802093311858, + "info": "search:ta:840369001846523-US", + "poi": { + "name": "FISERV MASTERMONEY", + "categorySet": [ + { + "id": 7397 + } + ], + "classifications": [ + { + "code": "CASH_DISPENSER", + "names": [ + { + "nameLocale": "en-US", + "name": "cash dispenser" + } + ] + } + ] + }, + "address": { + "streetNumber": "1560", + "streetName": "Broadway", + "municipalitySubdivision": "Times Square, New York, Midtown", + "municipality": "New York, Manhattan", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10036", + "extendedPostalCode": "100361517", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "1560 Broadway, New York, NY 10036", + "localName": "New York", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.75901, + "lon": -73.98516 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.75991, + "lon": -73.98635 + }, + "btmRightPoint": { + "lat": 40.75811, + "lon": -73.98397 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.75902, + "lon": -73.98522 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/6830011", + "score": 2.575, + "dist": 58.68107354501256, + "info": "search:ta:840369011803697-US", + "poi": { + "name": "METABANK", + "categorySet": [ + { + "id": 7397 + } + ], + "classifications": [ + { + "code": "CASH_DISPENSER", + "names": [ + { + "nameLocale": "en-US", + "name": "cash dispenser" + } + ] + } + ] + }, + "address": { + "streetNumber": "1567", + "streetName": "Broadway", + "municipalitySubdivision": "Times Square, New York, Midtown", + "municipality": "New York, Manhattan", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10036", + "extendedPostalCode": "100361517", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "1567 Broadway, New York, NY 10036", + "localName": "New York", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.75937, + "lon": -73.98569 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.76027, + "lon": -73.98688 + }, + "btmRightPoint": { + "lat": 40.75847, + "lon": -73.9845 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.75924, + "lon": -73.98513 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/6830013", + "score": 2.575, + "dist": 55.009653221373966, + "info": "search:ta:840369010525390-US", + "poi": { + "name": "ATM", + "categorySet": [ + { + "id": 7397 + } + ], + "classifications": [ + { + "code": "CASH_DISPENSER", + "names": [ + { + "nameLocale": "en-US", + "name": "cash dispenser" + } + ] + } + ] + }, + "address": { + "streetNumber": "1552", + "streetName": "Broadway", + "municipalitySubdivision": "Times Square, New York, Midtown", + "municipality": "New York, Manhattan", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10036", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "1552 Broadway, New York, NY 10036", + "localName": "New York", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.75873, + "lon": -73.98468 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.75963, + "lon": -73.98587 + }, + "btmRightPoint": { + "lat": 40.75783, + "lon": -73.98349 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.7588, + "lon": -73.98492 + } + } + ] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchPOICategoryTree.json b/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchPOICategoryTree.json new file mode 100644 index 000000000000..df132151b25d --- /dev/null +++ b/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchPOICategoryTree.json @@ -0,0 +1,207 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0" + }, + "responses": { + "200": { + "body": { + "poiCategories": [ + { + "id": 7320, + "name": "Sports Center", + "childCategoryIds": [ + 7320002, + 7320003, + 7320005 + ], + "synonyms": [ + "Gym", + "Indoors Sports", + "Sports Centre" + ] + }, + { + "id": 7374, + "name": "Stadium", + "childCategoryIds": [ + 7374002, + 7374009, + 7374012, + 7374003, + 7374010, + 7374005, + 7374008, + 7374011, + 7374006, + 7374014, + 7374013, + 7374007, + 7374004 + ], + "synonyms": [ + "Arena", + "Gymnasium", + "Sports Ground", + "Sports Stadium" + ] + }, + { + "id": 7315, + "name": "Restaurant", + "childCategoryIds": [ + 7315081, + 7315002, + 7315082, + 7315003, + 7315083, + 7315084, + 7315085, + 7315062, + 7315086, + 7315004, + 7315146, + 7315005, + 7315087, + 7315006, + 7315007, + 7315088, + 7315089, + 7315072, + 7315008, + 7315142, + 7315090, + 7315091, + 7315147, + 7315009, + 7315092, + 7315010, + 7315011, + 7315070, + 7315093, + 7315012, + 7315094, + 7315095, + 7315063, + 7315013, + 7315096, + 7315097, + 7315068, + 7315098, + 7315099, + 7315057, + 7315079, + 7315014, + 7315100, + 7315101, + 7315132, + 7315102, + 7315133, + 7315015, + 7315016, + 7315104, + 7315134, + 7315017, + 7315071, + 7315018, + 7315019, + 7315020, + 7315054, + 7315069, + 7315021, + 7315058, + 7315052, + 7315022, + 7315078, + 7315023, + 7315024, + 7315073, + 7315105, + 7315065, + 7315106, + 7315025, + 7315066, + 7315026, + 7315027, + 7315028, + 7315067, + 7315029, + 7315030, + 7315107, + 7315135, + 7315108, + 7315031, + 7315109, + 7315032, + 7315033, + 7315034, + 7315110, + 7315074, + 7315136, + 7315111, + 7315112, + 7315075, + 7315035, + 7315127, + 7315061, + 7315036, + 7315037, + 7315129, + 7315038, + 7315130, + 7315039, + 7315041, + 7315131, + 7315040, + 7315143, + 7315042, + 7315113, + 7315114, + 7315115, + 7315043, + 7315053, + 7315055, + 7315056, + 7315116, + 7315117, + 7315080, + 7315139, + 7315064, + 7315140, + 7315044, + 7315045, + 7315118, + 7315046, + 7315148, + 7315119, + 7315047, + 7315120, + 7315059, + 7315145, + 7315076, + 7315121, + 7315048, + 7315122, + 7315123, + 7315049, + 7315124, + 7315050, + 7315125, + 7315051, + 7315126, + 7315060, + 7315149 + ], + "synonyms": [ + "Dining", + "Eatery", + "Eating House", + "Eating Place" + ] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchPolygon.json b/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchPolygon.json new file mode 100644 index 000000000000..53f4bb118953 --- /dev/null +++ b/specification/maps/data-plane/Search/preview/1.0/examples/GetSearchPolygon.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "geometries": "[geometry-ids]" + }, + "responses": { + "200": { + "body": { + "additionalData": [ + { + "providerID": "1111-2222-32-4444444444444", + "geometryData": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "properties": {}, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + -122.0665062, + 47.6496252 + ], + [ + -122.0664863, + 47.6496113 + ], + [ + -122.0664843, + 47.6496014 + ], + [ + -122.0663693, + 47.6495247 + ], + [ + -122.0663017, + 47.6494664 + ], + [ + -122.0662679, + 47.6494247 + ], + [ + -122.0661647, + 47.6493314 + ], + [ + -122.067177, + 47.649298 + ], + [ + -122.090715, + 47.6543598 + ], + [ + -122.0907846, + 47.6542921 + ], + [ + -122.0908284, + 47.6542603 + ] + ] + ] + }, + "id": "1111-2222-32-4444444444444" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Search/preview/1.0/examples/PostSearchAddressBatch.json b/specification/maps/data-plane/Search/preview/1.0/examples/PostSearchAddressBatch.json new file mode 100644 index 000000000000..43b6a41bfe5a --- /dev/null +++ b/specification/maps/data-plane/Search/preview/1.0/examples/PostSearchAddressBatch.json @@ -0,0 +1,306 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "searchAddressBatchRequestBody": { + "batchItems": [ + { + "query": "?query=400 Broad St, Seattle, WA 98109&limit=3" + }, + { + "query": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3" + }, + { + "query": "?query=350 5th Ave, New York, NY 10118&limit=1" + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "summary": { + "successfulRequests": 3, + "totalRequests": 3 + }, + "batchItems": [ + { + "statusCode": 200, + "response": { + "summary": { + "query": "400 broad st seattle wa 98109", + "queryType": "NON_NEAR", + "queryTime": 127, + "numResults": 3, + "offset": 0, + "totalResults": 9, + "fuzzyLevel": 1 + }, + "results": [ + { + "type": "Point Address", + "id": "US/PAD/p0/20843845", + "score": 11.966, + "address": { + "streetNumber": "400", + "streetName": "Broad Street", + "municipalitySubdivision": "Seattle, South Lake Union, Lower Queen Anne", + "municipality": "Seattle", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle", + "countrySubdivision": "WA", + "postalCode": "98109", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "400 Broad Street, Seattle, WA 98109", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.62039, + "lon": -122.34928 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.62129, + "lon": -122.35061 + }, + "btmRightPoint": { + "lat": 47.61949, + "lon": -122.34795 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.61982, + "lon": -122.34886 + } + } + ] + }, + { + "type": "Street", + "id": "US/STR/p0/388442", + "score": 10.225, + "address": { + "streetName": "Broad Street", + "municipalitySubdivision": "Seattle, South Lake Union", + "municipality": "Seattle", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle", + "countrySubdivision": "WA", + "postalCode": "98109", + "extendedPostalCode": "981094612", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "Broad Street, Seattle, WA 98109", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.62001, + "lon": -122.34843 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.61965, + "lon": -122.34761 + }, + "btmRightPoint": { + "lat": 47.62066, + "lon": -122.349 + } + } + }, + { + "type": "Street", + "id": "US/STR/p0/388680", + "score": 10.225, + "address": { + "streetName": "Broad Street", + "municipalitySubdivision": "Seattle, Belltown", + "municipality": "Seattle", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle", + "countrySubdivision": "WA", + "postalCode": "98109,98121", + "extendedPostalCode": "981094991,981211117,981211237,981213206", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "Broad Street, Seattle, WA", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.61691, + "lon": -122.35251 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.61502, + "lon": -122.35041 + }, + "btmRightPoint": { + "lat": 47.61857, + "lon": -122.35484 + } + } + } + ] + } + }, + { + "statusCode": 200, + "response": { + "summary": { + "query": "one microsoft way redmond wa 98052", + "queryType": "NON_NEAR", + "queryTime": 169, + "numResults": 2, + "offset": 0, + "totalResults": 3292, + "fuzzyLevel": 2 + }, + "results": [ + { + "type": "Street", + "id": "US/STR/p0/1692663", + "score": 10.225, + "address": { + "streetName": "Microsoft Way", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980526399,980528300", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "Microsoft Way, Redmond, WA 98052", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.63989, + "lon": -122.12509 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.63748, + "lon": -122.12309 + }, + "btmRightPoint": { + "lat": 47.64223, + "lon": -122.13061 + } + } + }, + { + "type": "Cross Street", + "id": "US/XSTR/p1/4779971", + "score": 8.506, + "address": { + "streetName": "Microsoft Way & 157th Avenue Northeast, Microsoft Way", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "Microsoft Way & 157th Avenue Northeast, Redmond, WA 98052", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.63962, + "lon": -122.13061 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.64052, + "lon": -122.13194 + }, + "btmRightPoint": { + "lat": 47.63872, + "lon": -122.12928 + } + } + } + ] + } + }, + { + "statusCode": 200, + "response": { + "summary": { + "query": "350 5th ave new york ny 10118", + "queryType": "NON_NEAR", + "queryTime": 233, + "numResults": 1, + "offset": 0, + "totalResults": 8032, + "fuzzyLevel": 1 + }, + "results": [ + { + "type": "Point Address", + "id": "US/PAD/p0/48052000", + "score": 14.334, + "address": { + "streetNumber": "350", + "streetName": "5th Avenue", + "municipalitySubdivision": "New York, Midtown South", + "municipality": "New York, Manhattan", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10118", + "extendedPostalCode": "1011800", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "350 5th Avenue, NYC, NY 10118", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.74817, + "lon": -73.985 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.74907, + "lon": -73.98619 + }, + "btmRightPoint": { + "lat": 40.74727, + "lon": -73.98381 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.74808, + "lon": -73.98482 + } + } + ] + } + ] + } + } + ] + } + }, + "202": { + "headers": { + "Location": "URL to download the results of the long-running batch request." + } + } + } +} diff --git a/specification/maps/data-plane/Search/preview/1.0/examples/PostSearchAddressBatchSync.json b/specification/maps/data-plane/Search/preview/1.0/examples/PostSearchAddressBatchSync.json new file mode 100644 index 000000000000..267ac482af32 --- /dev/null +++ b/specification/maps/data-plane/Search/preview/1.0/examples/PostSearchAddressBatchSync.json @@ -0,0 +1,310 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "searchAddressBatchRequestBody": { + "batchItems": [ + { + "query": "?query=400 Broad St, Seattle, WA 98109&limit=3" + }, + { + "query": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3" + }, + { + "query": "?query=350 5th Ave, New York, NY 10118&limit=1" + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "summary": { + "successfulRequests": 3, + "totalRequests": 3 + }, + "batchItems": [ + { + "statusCode": 200, + "response": { + "summary": { + "query": "400 broad st seattle wa 98109", + "queryType": "NON_NEAR", + "queryTime": 127, + "numResults": 3, + "offset": 0, + "totalResults": 9, + "fuzzyLevel": 1 + }, + "results": [ + { + "type": "Point Address", + "id": "US/PAD/p0/20843845", + "score": 11.966, + "address": { + "streetNumber": "400", + "streetName": "Broad Street", + "municipalitySubdivision": "Seattle, South Lake Union, Lower Queen Anne", + "municipality": "Seattle", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle", + "countrySubdivision": "WA", + "postalCode": "98109", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "400 Broad Street, Seattle, WA 98109", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.62039, + "lon": -122.34928 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.62129, + "lon": -122.35061 + }, + "btmRightPoint": { + "lat": 47.61949, + "lon": -122.34795 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.61982, + "lon": -122.34886 + } + } + ] + }, + { + "type": "Street", + "id": "US/STR/p0/388442", + "score": 10.225, + "address": { + "streetName": "Broad Street", + "municipalitySubdivision": "Seattle, South Lake Union", + "municipality": "Seattle", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle", + "countrySubdivision": "WA", + "postalCode": "98109", + "extendedPostalCode": "981094612", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "Broad Street, Seattle, WA 98109", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.62001, + "lon": -122.34843 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.61965, + "lon": -122.34761 + }, + "btmRightPoint": { + "lat": 47.62066, + "lon": -122.349 + } + } + }, + { + "type": "Street", + "id": "US/STR/p0/388680", + "score": 10.225, + "address": { + "streetName": "Broad Street", + "municipalitySubdivision": "Seattle, Belltown", + "municipality": "Seattle", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle", + "countrySubdivision": "WA", + "postalCode": "98109,98121", + "extendedPostalCode": "981094991,981211117,981211237,981213206", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "Broad Street, Seattle, WA", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.61691, + "lon": -122.35251 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.61502, + "lon": -122.35041 + }, + "btmRightPoint": { + "lat": 47.61857, + "lon": -122.35484 + } + } + } + ] + } + }, + { + "statusCode": 200, + "response": { + "summary": { + "query": "one microsoft way redmond wa 98052", + "queryType": "NON_NEAR", + "queryTime": 169, + "numResults": 2, + "offset": 0, + "totalResults": 3292, + "fuzzyLevel": 2 + }, + "results": [ + { + "type": "Street", + "id": "US/STR/p0/1692663", + "score": 10.225, + "address": { + "streetName": "Microsoft Way", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980526399,980528300", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "Microsoft Way, Redmond, WA 98052", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.63989, + "lon": -122.12509 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.63748, + "lon": -122.12309 + }, + "btmRightPoint": { + "lat": 47.64223, + "lon": -122.13061 + } + } + }, + { + "type": "Cross Street", + "id": "US/XSTR/p1/4779971", + "score": 8.506, + "address": { + "streetName": "Microsoft Way & 157th Avenue Northeast, Microsoft Way", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "Microsoft Way & 157th Avenue Northeast, Redmond, WA 98052", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.63962, + "lon": -122.13061 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.64052, + "lon": -122.13194 + }, + "btmRightPoint": { + "lat": 47.63872, + "lon": -122.12928 + } + } + } + ] + } + }, + { + "statusCode": 200, + "response": { + "summary": { + "query": "350 5th ave new york ny 10118", + "queryType": "NON_NEAR", + "queryTime": 233, + "numResults": 1, + "offset": 0, + "totalResults": 8032, + "fuzzyLevel": 1 + }, + "results": [ + { + "type": "Point Address", + "id": "US/PAD/p0/48052000", + "score": 14.334, + "address": { + "streetNumber": "350", + "streetName": "5th Avenue", + "municipalitySubdivision": "New York, Midtown South", + "municipality": "New York, Manhattan", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10118", + "extendedPostalCode": "1011800", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "350 5th Avenue, NYC, NY 10118", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.74817, + "lon": -73.985 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.74907, + "lon": -73.98619 + }, + "btmRightPoint": { + "lat": 40.74727, + "lon": -73.98381 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.74808, + "lon": -73.98482 + } + } + ] + } + ] + } + } + ] + } + }, + "408": { + "headers": {}, + "body": { + "error": { + "code": "408 Timeout", + "message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api." + } + } + } + } +} diff --git a/specification/maps/data-plane/Search/preview/1.0/examples/PostSearchAddressReverseBatch.json b/specification/maps/data-plane/Search/preview/1.0/examples/PostSearchAddressReverseBatch.json new file mode 100644 index 000000000000..3995aeb565fd --- /dev/null +++ b/specification/maps/data-plane/Search/preview/1.0/examples/PostSearchAddressReverseBatch.json @@ -0,0 +1,145 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "searchAddressReverseBatchRequestBody": { + "batchItems": [ + { + "query": "?query=48.858561,2.294911" + }, + { + "query": "?query=47.639765,-122.127896&radius=5000&limit=2" + }, + { + "query": "?query=47.621028,-122.348170" + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "summary": { + "successfulRequests": 3, + "totalRequests": 3 + }, + "batchItems": [ + { + "statusCode": 200, + "response": { + "summary": { + "queryTime": 8, + "numResults": 1 + }, + "addresses": [ + { + "address": { + "buildingNumber": "7", + "streetNumber": "7", + "routeNumbers": [], + "street": "Avenue Anatole France", + "streetName": "Avenue Anatole France", + "streetNameAndNumber": "7 Avenue Anatole France", + "countryCode": "FR", + "countrySubdivision": "Île-de-France", + "countrySecondarySubdivision": "Paris", + "municipality": "Paris", + "postalCode": "75007", + "municipalitySubdivision": "7ème Arrondissement", + "country": "France", + "countryCodeISO3": "FRA", + "freeformAddress": "7 Avenue Anatole France, Paris, 75007", + "boundingBox": { + "northEast": "48.858321,2.295167", + "southWest": "48.858136,2.295027", + "entity": "position" + } + }, + "position": "48.858231,2.295089" + } + ] + } + }, + { + "statusCode": 200, + "response": { + "summary": { + "queryTime": 8, + "numResults": 1 + }, + "addresses": [ + { + "address": { + "routeNumbers": [], + "countryCode": "US", + "countrySubdivision": "WA", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "municipality": "Redmond", + "postalCode": "98052", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "Redmond, WA 98052", + "boundingBox": { + "northEast": "47.639765,-122.128661", + "southWest": "47.639502,-122.129456", + "entity": "position" + }, + "countrySubdivisionName": "Washington" + }, + "position": "47.639687,-122.128677" + } + ] + } + }, + { + "statusCode": 200, + "response": { + "summary": { + "queryTime": 19, + "numResults": 1 + }, + "addresses": [ + { + "address": { + "buildingNumber": "410", + "streetNumber": "410", + "routeNumbers": [], + "street": "Thomas Street", + "streetName": "Thomas Street", + "streetNameAndNumber": "410 Thomas Street", + "countryCode": "US", + "countrySubdivision": "WA", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle", + "municipality": "Seattle", + "postalCode": "98109", + "municipalitySubdivision": "Seattle, Lower Queen Anne", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "410 Thomas Street, Seattle, WA 98109", + "boundingBox": { + "northEast": "47.620954,-122.347601", + "southWest": "47.620944,-122.348498", + "entity": "position" + }, + "extendedPostalCode": "981094621", + "countrySubdivisionName": "Washington" + }, + "position": "47.620945,-122.348175" + } + ] + } + } + ] + } + }, + "202": { + "headers": { + "Location": "URL to download the results of the long-running batch request." + } + } + } +} diff --git a/specification/maps/data-plane/Search/preview/1.0/examples/PostSearchAddressReverseBatchSync.json b/specification/maps/data-plane/Search/preview/1.0/examples/PostSearchAddressReverseBatchSync.json new file mode 100644 index 000000000000..b4836b3c7afd --- /dev/null +++ b/specification/maps/data-plane/Search/preview/1.0/examples/PostSearchAddressReverseBatchSync.json @@ -0,0 +1,149 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "searchAddressReverseBatchRequestBody": { + "batchItems": [ + { + "query": "?query=48.858561,2.294911" + }, + { + "query": "?query=47.639765,-122.127896&radius=5000&limit=2" + }, + { + "query": "?query=47.621028,-122.348170" + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "summary": { + "successfulRequests": 3, + "totalRequests": 3 + }, + "batchItems": [ + { + "statusCode": 200, + "response": { + "summary": { + "queryTime": 8, + "numResults": 1 + }, + "addresses": [ + { + "address": { + "buildingNumber": "7", + "streetNumber": "7", + "routeNumbers": [], + "street": "Avenue Anatole France", + "streetName": "Avenue Anatole France", + "streetNameAndNumber": "7 Avenue Anatole France", + "countryCode": "FR", + "countrySubdivision": "Île-de-France", + "countrySecondarySubdivision": "Paris", + "municipality": "Paris", + "postalCode": "75007", + "municipalitySubdivision": "7ème Arrondissement", + "country": "France", + "countryCodeISO3": "FRA", + "freeformAddress": "7 Avenue Anatole France, Paris, 75007", + "boundingBox": { + "northEast": "48.858321,2.295167", + "southWest": "48.858136,2.295027", + "entity": "position" + } + }, + "position": "48.858231,2.295089" + } + ] + } + }, + { + "statusCode": 200, + "response": { + "summary": { + "queryTime": 8, + "numResults": 1 + }, + "addresses": [ + { + "address": { + "routeNumbers": [], + "countryCode": "US", + "countrySubdivision": "WA", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "municipality": "Redmond", + "postalCode": "98052", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "Redmond, WA 98052", + "boundingBox": { + "northEast": "47.639765,-122.128661", + "southWest": "47.639502,-122.129456", + "entity": "position" + }, + "countrySubdivisionName": "Washington" + }, + "position": "47.639687,-122.128677" + } + ] + } + }, + { + "statusCode": 200, + "response": { + "summary": { + "queryTime": 19, + "numResults": 1 + }, + "addresses": [ + { + "address": { + "buildingNumber": "410", + "streetNumber": "410", + "routeNumbers": [], + "street": "Thomas Street", + "streetName": "Thomas Street", + "streetNameAndNumber": "410 Thomas Street", + "countryCode": "US", + "countrySubdivision": "WA", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle", + "municipality": "Seattle", + "postalCode": "98109", + "municipalitySubdivision": "Seattle, Lower Queen Anne", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "410 Thomas Street, Seattle, WA 98109", + "boundingBox": { + "northEast": "47.620954,-122.347601", + "southWest": "47.620944,-122.348498", + "entity": "position" + }, + "extendedPostalCode": "981094621", + "countrySubdivisionName": "Washington" + }, + "position": "47.620945,-122.348175" + } + ] + } + } + ] + } + }, + "408": { + "headers": {}, + "body": { + "error": { + "code": "408 Timeout", + "message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api." + } + } + } + } +} diff --git a/specification/maps/data-plane/Search/preview/1.0/examples/PostSearchAlongRoute.json b/specification/maps/data-plane/Search/preview/1.0/examples/PostSearchAlongRoute.json new file mode 100644 index 000000000000..2c14d8ad0e95 --- /dev/null +++ b/specification/maps/data-plane/Search/preview/1.0/examples/PostSearchAlongRoute.json @@ -0,0 +1,204 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "query": "burger", + "maxDetourTime": 1000, + "limit": 2, + "searchAlongRouteRequestBody": { + "route": { + "type": "LineString", + "coordinates": [ + [ + -122.143035, + 47.653536 + ], + [ + -122.187164, + 47.617556 + ], + [ + -122.114981, + 47.570599 + ], + [ + -122.132756, + 47.654009 + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "summary": { + "query": "burger", + "queryType": "NON_NEAR", + "queryTime": 394, + "numResults": 2, + "offset": 0, + "totalResults": 2, + "fuzzyLevel": 1 + }, + "results": [ + { + "type": "POI", + "id": "US/POI/p0/8596348", + "score": 3.104, + "dist": 1754.9604168059973, + "info": "search:ta:840531000465150-US", + "poi": { + "name": "BURGER KING", + "phone": "+(1)-(425)-7467508", + "brands": [ + { + "name": "BURGER KING" + } + ], + "categorySet": [ + { + "id": 7315015 + } + ], + "url": "www.burgerking.com", + "classifications": [ + { + "code": "RESTAURANT", + "names": [ + { + "nameLocale": "en-US", + "name": "restaurant" + }, + { + "nameLocale": "en-US", + "name": "fast food" + } + ] + } + ] + }, + "address": { + "streetNumber": "14620", + "streetName": "NE 24th St", + "municipalitySubdivision": "Crossroads, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98007", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "14620 NE 24th St, Bellevue, WA 98007", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.63188, + "lon": -122.14462 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.63278, + "lon": -122.14595 + }, + "btmRightPoint": { + "lat": 47.63098, + "lon": -122.14329 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.63155, + "lon": -122.14462 + } + } + ], + "detourTime": -55 + }, + { + "type": "POI", + "id": "US/POI/p0/8596112", + "score": 3.111, + "dist": 161.17565489389224, + "info": "search:ta:840531000465149-US", + "poi": { + "name": "BURGER KING", + "phone": "+(1)-(425)-4535775", + "brands": [ + { + "name": "BURGER KING" + } + ], + "categorySet": [ + { + "id": 7315015 + } + ], + "url": "www.burgerking.com", + "classifications": [ + { + "code": "RESTAURANT", + "names": [ + { + "nameLocale": "en-US", + "name": "restaurant" + }, + { + "nameLocale": "en-US", + "name": "fast food" + } + ] + } + ] + }, + "address": { + "streetNumber": "11723", + "streetName": "NE 8th St", + "municipalitySubdivision": "Willburton, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98005", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "11723 NE 8th St, Bellevue, WA 98005", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.61683, + "lon": -122.18338 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.61773, + "lon": -122.18471 + }, + "btmRightPoint": { + "lat": 47.61593, + "lon": -122.18205 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.61723, + "lon": -122.1834 + } + } + ], + "detourTime": 12 + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Search/preview/1.0/examples/PostSearchFuzzyBatch.json b/specification/maps/data-plane/Search/preview/1.0/examples/PostSearchFuzzyBatch.json new file mode 100644 index 000000000000..4aa500c09fe2 --- /dev/null +++ b/specification/maps/data-plane/Search/preview/1.0/examples/PostSearchFuzzyBatch.json @@ -0,0 +1,1410 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "searchFuzzyBatchRequestBody": { + "batchItems": [ + { + "query": "?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5" + }, + { + "query": "?query=Statue Of Liberty&limit=2" + }, + { + "query": "?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000" + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "batchItems": [ + { + "statusCode": 200, + "response": { + "summary": { + "query": "atm", + "queryType": "NON_NEAR", + "queryTime": 5, + "numResults": 5, + "offset": 0, + "totalResults": 262, + "fuzzyLevel": 1, + "geoBias": { + "lat": 47.639769, + "lon": -122.128362 + } + }, + "results": [ + { + "type": "POI", + "id": "US/POI/p0/3656546", + "score": 2.671, + "dist": 1336.1815386162032, + "info": "search:ta:840539002005905-US", + "poi": { + "name": "US Bank ATM-MONEYPASS", + "brands": [ + { + "name": "US Bank ATM" + } + ], + "categorySet": [ + { + "id": 7397 + } + ], + "classifications": [ + { + "code": "CASH_DISPENSER", + "names": [ + { + "nameLocale": "en-US", + "name": "cash dispenser" + } + ] + } + ] + }, + "address": { + "streetNumber": "14808", + "streetName": "NE 24th St", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "14808 NE 24th St, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.63229, + "lon": -122.14232 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.63319, + "lon": -122.14365 + }, + "btmRightPoint": { + "lat": 47.63139, + "lon": -122.14099 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.63154, + "lon": -122.1423 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/8673325", + "score": 2.671, + "dist": 1206.8488178244172, + "info": "search:ta:840539002022072-US", + "poi": { + "name": "US Bank ATM NATIONAL ASSOCIATION", + "brands": [ + { + "name": "US Bank ATM" + } + ], + "categorySet": [ + { + "id": 7397 + } + ], + "classifications": [ + { + "code": "CASH_DISPENSER", + "names": [ + { + "nameLocale": "en-US", + "name": "cash dispenser" + } + ] + } + ] + }, + "address": { + "streetNumber": "15000", + "streetName": "Northeast 24Th Street", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980525522", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "15000 Northeast 24Th Street, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.63265, + "lon": -122.14052 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.63355, + "lon": -122.14185 + }, + "btmRightPoint": { + "lat": 47.63175, + "lon": -122.13919 + } + }, + "entryPoints": [ + { + "type": "minor", + "position": { + "lat": 47.63156, + "lon": -122.14056 + } + }, + { + "type": "minor", + "position": { + "lat": 47.63156, + "lon": -122.14058 + } + }, + { + "type": "main", + "position": { + "lat": 47.63156, + "lon": -122.14048 + } + }, + { + "type": "main", + "position": { + "lat": 47.6324, + "lon": -122.13938 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/2736315", + "score": 2.671, + "dist": 864.75917765198585, + "info": "search:ta:840539002187855-US", + "poi": { + "name": "US Bank ATM-MONEYPASS", + "brands": [ + { + "name": "US Bank ATM" + } + ], + "categorySet": [ + { + "id": 7397 + } + ], + "classifications": [ + { + "code": "CASH_DISPENSER", + "names": [ + { + "nameLocale": "en-US", + "name": "cash dispenser" + } + ] + } + ] + }, + "address": { + "streetNumber": "15521", + "streetName": "Bel Red Rd", + "municipalitySubdivision": "Redmond, Northeast Bellevue, Bellevue", + "municipality": "Redmond, Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980525501", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "15521 Bel Red Rd, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.63259, + "lon": -122.1328 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.63349, + "lon": -122.13413 + }, + "btmRightPoint": { + "lat": 47.63169, + "lon": -122.13147 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.63255, + "lon": -122.13275 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/3656412", + "score": 2.67, + "dist": 2140.1985385809412, + "info": "search:ta:840539001998867-US", + "poi": { + "name": "US Bank ATM NATIONAL ASSOCIATION", + "brands": [ + { + "name": "US Bank ATM" + } + ], + "categorySet": [ + { + "id": 7397 + } + ], + "classifications": [ + { + "code": "CASH_DISPENSER", + "names": [ + { + "nameLocale": "en-US", + "name": "cash dispenser" + } + ] + } + ] + }, + "address": { + "streetNumber": "1128", + "streetName": "156th Ave NE", + "municipalitySubdivision": "Crossroads, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98007", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "1128 156th Ave NE, Bellevue, WA 98007", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.62069, + "lon": -122.13213 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.62159, + "lon": -122.13346 + }, + "btmRightPoint": { + "lat": 47.61979, + "lon": -122.1308 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.62069, + "lon": -122.13236 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/2736876", + "score": 2.67, + "dist": 2140.1985385809412, + "info": "search:ta:840539001396789-US", + "poi": { + "name": "US Bank ATM", + "phone": "+(1)-(800)-8722657", + "brands": [ + { + "name": "US Bank ATM" + } + ], + "categorySet": [ + { + "id": 7397 + } + ], + "url": "www.usbank.com", + "classifications": [ + { + "code": "CASH_DISPENSER", + "names": [ + { + "nameLocale": "en-US", + "name": "cash dispenser" + } + ] + } + ] + }, + "address": { + "streetNumber": "1128", + "streetName": "156th Ave NE", + "municipalitySubdivision": "Crossroads, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98007", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "1128 156th Ave NE, Bellevue, WA 98007", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.62069, + "lon": -122.13213 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.62159, + "lon": -122.13346 + }, + "btmRightPoint": { + "lat": 47.61979, + "lon": -122.1308 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.62069, + "lon": -122.13236 + } + } + ] + } + ] + } + }, + { + "statusCode": 200, + "response": { + "summary": { + "query": "statue of liberty", + "queryType": "NON_NEAR", + "queryTime": 37, + "numResults": 2, + "offset": 0, + "totalResults": 18, + "fuzzyLevel": 1 + }, + "results": [ + { + "type": "POI", + "id": "US/POI/p0/9189660", + "score": 6.942, + "info": "search:ta:840369001174316-US", + "poi": { + "name": "Statue of Liberty", + "categorySet": [ + { + "id": 7376003 + } + ], + "classifications": [ + { + "code": "IMPORTANT_TOURIST_ATTRACTION", + "names": [ + { + "nameLocale": "en-US", + "name": "monument" + }, + { + "nameLocale": "en-US", + "name": "important tourist attraction" + } + ] + } + ] + }, + "address": { + "municipalitySubdivision": "New York", + "municipality": "New York", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10004", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "New York, NY 10004", + "localName": "New York", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.68955, + "lon": -74.04483 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.69045, + "lon": -74.04602 + }, + "btmRightPoint": { + "lat": 40.68865, + "lon": -74.04364 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.69001, + "lon": -74.04683 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/3264566", + "score": 6.942, + "info": "search:ta:840019000670588-US", + "poi": { + "name": "Statue of Liberty", + "phone": "+(1)-(205)-9700251", + "categorySet": [ + { + "id": 7376003 + } + ], + "url": "www.1bsa.org", + "classifications": [ + { + "code": "IMPORTANT_TOURIST_ATTRACTION", + "names": [ + { + "nameLocale": "en-US", + "name": "important tourist attraction" + } + ] + } + ] + }, + "address": { + "streetNumber": "516", + "streetName": "Liberty Pkwy", + "municipalitySubdivision": "Vestavia Hills", + "municipality": "Vestavia Hills, Birmingham", + "countrySecondarySubdivision": "Jefferson", + "countryTertiarySubdivision": "Leeds", + "countrySubdivision": "AL", + "postalCode": "35242", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "516 Liberty Pkwy, Vestavia Hills, AL 35242", + "localName": "Vestavia Hills", + "countrySubdivisionName": "Alabama" + }, + "position": { + "lat": 33.48234, + "lon": -86.70719 + }, + "viewport": { + "topLeftPoint": { + "lat": 33.48324, + "lon": -86.70827 + }, + "btmRightPoint": { + "lat": 33.48144, + "lon": -86.70611 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 33.48129, + "lon": -86.7065 + } + } + ] + } + ] + } + }, + { + "statusCode": 200, + "response": { + "summary": { + "query": "starbucks", + "queryType": "NON_NEAR", + "queryTime": 35, + "numResults": 10, + "offset": 0, + "totalResults": 17, + "fuzzyLevel": 1, + "geoBias": { + "lat": 47.639769, + "lon": -122.128362 + } + }, + "results": [ + { + "type": "POI", + "id": "US/POI/p0/153678", + "score": 2.671, + "dist": 1206.8488178244172, + "info": "search:ta:840531000006554-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-8695816", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/site-selector", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "15000", + "streetName": "NE 24th St", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980525522", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "15000 NE 24th St, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.63265, + "lon": -122.14052 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.63355, + "lon": -122.14185 + }, + "btmRightPoint": { + "lat": 47.63175, + "lon": -122.13919 + } + }, + "entryPoints": [ + { + "type": "minor", + "position": { + "lat": 47.63156, + "lon": -122.14056 + } + }, + { + "type": "minor", + "position": { + "lat": 47.63156, + "lon": -122.14058 + } + }, + { + "type": "main", + "position": { + "lat": 47.63156, + "lon": -122.14048 + } + }, + { + "type": "main", + "position": { + "lat": 47.6324, + "lon": -122.13938 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/152316", + "score": 2.67, + "dist": 2315.294397491255, + "info": "search:ta:840539000484552-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-6436471", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/store/15097", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "15600", + "streetName": "NE 8th St", + "municipalitySubdivision": "Crossroads, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98008", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "15600 NE 8th St, Bellevue, WA 98008", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.61896, + "lon": -122.12945 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.61986, + "lon": -122.13078 + }, + "btmRightPoint": { + "lat": 47.61806, + "lon": -122.12812 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.619, + "lon": -122.12945 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/167545", + "score": 2.67, + "dist": 1979.2222952267998, + "info": "search:ta:840539001950429-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-7470690", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/site-selector", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "1350", + "streetName": "156th Ave NE", + "municipalitySubdivision": "Crossroads, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98007", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "1350 156th Ave NE, Bellevue, WA 98007", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.62212, + "lon": -122.13179 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.62302, + "lon": -122.13312 + }, + "btmRightPoint": { + "lat": 47.62122, + "lon": -122.13046 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.62213, + "lon": -122.13236 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/168519", + "score": 2.67, + "dist": 2490.3337046455963, + "info": "search:ta:840539001015090-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-4556500", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "https://www.starbucks.com/store-locator/store/15901", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "1645", + "streetName": "140th Ave NE", + "municipalitySubdivision": "Crossroads, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98005", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "1645 140th Ave NE, Bellevue, WA 98005", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.62626, + "lon": -122.15487 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.62716, + "lon": -122.1562 + }, + "btmRightPoint": { + "lat": 47.62536, + "lon": -122.15354 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.62645, + "lon": -122.15446 + } + }, + { + "type": "minor", + "position": { + "lat": 47.62579, + "lon": -122.15377 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/152428", + "score": 2.668, + "dist": 3529.7080738812224, + "info": "search:ta:840539001033722-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-3789496", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/site-selector", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "180", + "streetName": "148th Ave SE", + "municipalitySubdivision": "West Lake Hills, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98007", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "180 148th Ave SE, Bellevue, WA 98007", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.60901, + "lon": -122.14 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.60991, + "lon": -122.14133 + }, + "btmRightPoint": { + "lat": 47.60811, + "lon": -122.13867 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.60901, + "lon": -122.14008 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/167147", + "score": 2.668, + "dist": 3479.393294615887, + "info": "search:ta:840539000326896-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-8619198", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/site-selector", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "7425", + "streetName": "166th Ave NE", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980526288", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "7425 166th Ave NE, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.67055, + "lon": -122.12001 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.67145, + "lon": -122.12135 + }, + "btmRightPoint": { + "lat": 47.66965, + "lon": -122.11867 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.67069, + "lon": -122.11889 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/153695", + "score": 2.667, + "dist": 3622.4410746187291, + "info": "search:ta:840531000006551-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-8822881", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/store/15022", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "7625", + "streetName": "170th Ave NE", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980520910", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "7625 170th Ave NE, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.67086, + "lon": -122.11392 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.67176, + "lon": -122.11526 + }, + "btmRightPoint": { + "lat": 47.66996, + "lon": -122.11258 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.67073, + "lon": -122.1135 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/167420", + "score": 2.667, + "dist": 3818.293513029088, + "info": "search:ta:840539000640782-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-8853323", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/site-selector", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "17246", + "streetName": "Redmond Way", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980524403", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "17246 Redmond Way, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.67174, + "lon": -122.10976 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.67264, + "lon": -122.1111 + }, + "btmRightPoint": { + "lat": 47.67084, + "lon": -122.10842 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.6706, + "lon": -122.11026 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/153686", + "score": 2.666, + "dist": 4009.9222051470738, + "info": "search:ta:840531000006548-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-8859590", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/site-selector", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "15738", + "streetName": "Redmond Way Pad 3 Redmond Center", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980523873", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "15738 Redmond Way Pad 3 Redmond Center, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.67583, + "lon": -122.12877 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.67673, + "lon": -122.13011 + }, + "btmRightPoint": { + "lat": 47.67493, + "lon": -122.12743 + } + }, + "entryPoints": [ + { + "type": "minor", + "position": { + "lat": 47.67456, + "lon": -122.12887 + } + }, + { + "type": "main", + "position": { + "lat": 47.67668, + "lon": -122.12829 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/168511", + "score": 2.666, + "dist": 3987.80992387863, + "info": "search:ta:840531000006669-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-8818265", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/site-selector", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "6617", + "streetName": "132Nd Ave Ne Bridle Trails Shopping Center", + "municipalitySubdivision": "Kirkland, Bridle Trails", + "municipality": "Kirkland", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98033", + "extendedPostalCode": "980338234", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "6617 132Nd Ave Ne Bridle Trails Shopping Center, Kirkland, WA 98033", + "localName": "Kirkland", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.66514, + "lon": -122.16599 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.66604, + "lon": -122.16733 + }, + "btmRightPoint": { + "lat": 47.66424, + "lon": -122.16465 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.666, + "lon": -122.16669 + } + }, + { + "type": "minor", + "position": { + "lat": 47.66553, + "lon": -122.16405 + } + } + ] + } + ] + } + } + ], + "summary": { + "successfulRequests": 3, + "totalRequests": 3 + } + } + }, + "202": { + "headers": { + "Location": "URL to download the results of the long-running batch request." + } + } + } +} diff --git a/specification/maps/data-plane/Search/preview/1.0/examples/PostSearchFuzzyBatchSync.json b/specification/maps/data-plane/Search/preview/1.0/examples/PostSearchFuzzyBatchSync.json new file mode 100644 index 000000000000..0cbd7b3bdcb3 --- /dev/null +++ b/specification/maps/data-plane/Search/preview/1.0/examples/PostSearchFuzzyBatchSync.json @@ -0,0 +1,1414 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "searchFuzzyBatchRequestBody": { + "batchItems": [ + { + "query": "?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5" + }, + { + "query": "?query=Statue Of Liberty&limit=2" + }, + { + "query": "?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000" + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "batchItems": [ + { + "statusCode": 200, + "response": { + "summary": { + "query": "atm", + "queryType": "NON_NEAR", + "queryTime": 5, + "numResults": 5, + "offset": 0, + "totalResults": 262, + "fuzzyLevel": 1, + "geoBias": { + "lat": 47.639769, + "lon": -122.128362 + } + }, + "results": [ + { + "type": "POI", + "id": "US/POI/p0/3656546", + "score": 2.671, + "dist": 1336.1815386162032, + "info": "search:ta:840539002005905-US", + "poi": { + "name": "US Bank ATM-MONEYPASS", + "brands": [ + { + "name": "US Bank ATM" + } + ], + "categorySet": [ + { + "id": 7397 + } + ], + "classifications": [ + { + "code": "CASH_DISPENSER", + "names": [ + { + "nameLocale": "en-US", + "name": "cash dispenser" + } + ] + } + ] + }, + "address": { + "streetNumber": "14808", + "streetName": "NE 24th St", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "14808 NE 24th St, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.63229, + "lon": -122.14232 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.63319, + "lon": -122.14365 + }, + "btmRightPoint": { + "lat": 47.63139, + "lon": -122.14099 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.63154, + "lon": -122.1423 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/8673325", + "score": 2.671, + "dist": 1206.8488178244172, + "info": "search:ta:840539002022072-US", + "poi": { + "name": "US Bank ATM NATIONAL ASSOCIATION", + "brands": [ + { + "name": "US Bank ATM" + } + ], + "categorySet": [ + { + "id": 7397 + } + ], + "classifications": [ + { + "code": "CASH_DISPENSER", + "names": [ + { + "nameLocale": "en-US", + "name": "cash dispenser" + } + ] + } + ] + }, + "address": { + "streetNumber": "15000", + "streetName": "Northeast 24Th Street", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980525522", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "15000 Northeast 24Th Street, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.63265, + "lon": -122.14052 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.63355, + "lon": -122.14185 + }, + "btmRightPoint": { + "lat": 47.63175, + "lon": -122.13919 + } + }, + "entryPoints": [ + { + "type": "minor", + "position": { + "lat": 47.63156, + "lon": -122.14056 + } + }, + { + "type": "minor", + "position": { + "lat": 47.63156, + "lon": -122.14058 + } + }, + { + "type": "main", + "position": { + "lat": 47.63156, + "lon": -122.14048 + } + }, + { + "type": "main", + "position": { + "lat": 47.6324, + "lon": -122.13938 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/2736315", + "score": 2.671, + "dist": 864.75917765198585, + "info": "search:ta:840539002187855-US", + "poi": { + "name": "US Bank ATM-MONEYPASS", + "brands": [ + { + "name": "US Bank ATM" + } + ], + "categorySet": [ + { + "id": 7397 + } + ], + "classifications": [ + { + "code": "CASH_DISPENSER", + "names": [ + { + "nameLocale": "en-US", + "name": "cash dispenser" + } + ] + } + ] + }, + "address": { + "streetNumber": "15521", + "streetName": "Bel Red Rd", + "municipalitySubdivision": "Redmond, Northeast Bellevue, Bellevue", + "municipality": "Redmond, Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980525501", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "15521 Bel Red Rd, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.63259, + "lon": -122.1328 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.63349, + "lon": -122.13413 + }, + "btmRightPoint": { + "lat": 47.63169, + "lon": -122.13147 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.63255, + "lon": -122.13275 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/3656412", + "score": 2.67, + "dist": 2140.1985385809412, + "info": "search:ta:840539001998867-US", + "poi": { + "name": "US Bank ATM NATIONAL ASSOCIATION", + "brands": [ + { + "name": "US Bank ATM" + } + ], + "categorySet": [ + { + "id": 7397 + } + ], + "classifications": [ + { + "code": "CASH_DISPENSER", + "names": [ + { + "nameLocale": "en-US", + "name": "cash dispenser" + } + ] + } + ] + }, + "address": { + "streetNumber": "1128", + "streetName": "156th Ave NE", + "municipalitySubdivision": "Crossroads, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98007", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "1128 156th Ave NE, Bellevue, WA 98007", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.62069, + "lon": -122.13213 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.62159, + "lon": -122.13346 + }, + "btmRightPoint": { + "lat": 47.61979, + "lon": -122.1308 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.62069, + "lon": -122.13236 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/2736876", + "score": 2.67, + "dist": 2140.1985385809412, + "info": "search:ta:840539001396789-US", + "poi": { + "name": "US Bank ATM", + "phone": "+(1)-(800)-8722657", + "brands": [ + { + "name": "US Bank ATM" + } + ], + "categorySet": [ + { + "id": 7397 + } + ], + "url": "www.usbank.com", + "classifications": [ + { + "code": "CASH_DISPENSER", + "names": [ + { + "nameLocale": "en-US", + "name": "cash dispenser" + } + ] + } + ] + }, + "address": { + "streetNumber": "1128", + "streetName": "156th Ave NE", + "municipalitySubdivision": "Crossroads, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98007", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "1128 156th Ave NE, Bellevue, WA 98007", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.62069, + "lon": -122.13213 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.62159, + "lon": -122.13346 + }, + "btmRightPoint": { + "lat": 47.61979, + "lon": -122.1308 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.62069, + "lon": -122.13236 + } + } + ] + } + ] + } + }, + { + "statusCode": 200, + "response": { + "summary": { + "query": "statue of liberty", + "queryType": "NON_NEAR", + "queryTime": 37, + "numResults": 2, + "offset": 0, + "totalResults": 18, + "fuzzyLevel": 1 + }, + "results": [ + { + "type": "POI", + "id": "US/POI/p0/9189660", + "score": 6.942, + "info": "search:ta:840369001174316-US", + "poi": { + "name": "Statue of Liberty", + "categorySet": [ + { + "id": 7376003 + } + ], + "classifications": [ + { + "code": "IMPORTANT_TOURIST_ATTRACTION", + "names": [ + { + "nameLocale": "en-US", + "name": "monument" + }, + { + "nameLocale": "en-US", + "name": "important tourist attraction" + } + ] + } + ] + }, + "address": { + "municipalitySubdivision": "New York", + "municipality": "New York", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10004", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "New York, NY 10004", + "localName": "New York", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.68955, + "lon": -74.04483 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.69045, + "lon": -74.04602 + }, + "btmRightPoint": { + "lat": 40.68865, + "lon": -74.04364 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.69001, + "lon": -74.04683 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/3264566", + "score": 6.942, + "info": "search:ta:840019000670588-US", + "poi": { + "name": "Statue of Liberty", + "phone": "+(1)-(205)-9700251", + "categorySet": [ + { + "id": 7376003 + } + ], + "url": "www.1bsa.org", + "classifications": [ + { + "code": "IMPORTANT_TOURIST_ATTRACTION", + "names": [ + { + "nameLocale": "en-US", + "name": "important tourist attraction" + } + ] + } + ] + }, + "address": { + "streetNumber": "516", + "streetName": "Liberty Pkwy", + "municipalitySubdivision": "Vestavia Hills", + "municipality": "Vestavia Hills, Birmingham", + "countrySecondarySubdivision": "Jefferson", + "countryTertiarySubdivision": "Leeds", + "countrySubdivision": "AL", + "postalCode": "35242", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "516 Liberty Pkwy, Vestavia Hills, AL 35242", + "localName": "Vestavia Hills", + "countrySubdivisionName": "Alabama" + }, + "position": { + "lat": 33.48234, + "lon": -86.70719 + }, + "viewport": { + "topLeftPoint": { + "lat": 33.48324, + "lon": -86.70827 + }, + "btmRightPoint": { + "lat": 33.48144, + "lon": -86.70611 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 33.48129, + "lon": -86.7065 + } + } + ] + } + ] + } + }, + { + "statusCode": 200, + "response": { + "summary": { + "query": "starbucks", + "queryType": "NON_NEAR", + "queryTime": 35, + "numResults": 10, + "offset": 0, + "totalResults": 17, + "fuzzyLevel": 1, + "geoBias": { + "lat": 47.639769, + "lon": -122.128362 + } + }, + "results": [ + { + "type": "POI", + "id": "US/POI/p0/153678", + "score": 2.671, + "dist": 1206.8488178244172, + "info": "search:ta:840531000006554-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-8695816", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/site-selector", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "15000", + "streetName": "NE 24th St", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980525522", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "15000 NE 24th St, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.63265, + "lon": -122.14052 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.63355, + "lon": -122.14185 + }, + "btmRightPoint": { + "lat": 47.63175, + "lon": -122.13919 + } + }, + "entryPoints": [ + { + "type": "minor", + "position": { + "lat": 47.63156, + "lon": -122.14056 + } + }, + { + "type": "minor", + "position": { + "lat": 47.63156, + "lon": -122.14058 + } + }, + { + "type": "main", + "position": { + "lat": 47.63156, + "lon": -122.14048 + } + }, + { + "type": "main", + "position": { + "lat": 47.6324, + "lon": -122.13938 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/152316", + "score": 2.67, + "dist": 2315.294397491255, + "info": "search:ta:840539000484552-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-6436471", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/store/15097", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "15600", + "streetName": "NE 8th St", + "municipalitySubdivision": "Crossroads, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98008", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "15600 NE 8th St, Bellevue, WA 98008", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.61896, + "lon": -122.12945 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.61986, + "lon": -122.13078 + }, + "btmRightPoint": { + "lat": 47.61806, + "lon": -122.12812 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.619, + "lon": -122.12945 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/167545", + "score": 2.67, + "dist": 1979.2222952267998, + "info": "search:ta:840539001950429-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-7470690", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/site-selector", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "1350", + "streetName": "156th Ave NE", + "municipalitySubdivision": "Crossroads, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98007", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "1350 156th Ave NE, Bellevue, WA 98007", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.62212, + "lon": -122.13179 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.62302, + "lon": -122.13312 + }, + "btmRightPoint": { + "lat": 47.62122, + "lon": -122.13046 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.62213, + "lon": -122.13236 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/168519", + "score": 2.67, + "dist": 2490.3337046455963, + "info": "search:ta:840539001015090-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-4556500", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "https://www.starbucks.com/store-locator/store/15901", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "1645", + "streetName": "140th Ave NE", + "municipalitySubdivision": "Crossroads, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98005", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "1645 140th Ave NE, Bellevue, WA 98005", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.62626, + "lon": -122.15487 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.62716, + "lon": -122.1562 + }, + "btmRightPoint": { + "lat": 47.62536, + "lon": -122.15354 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.62645, + "lon": -122.15446 + } + }, + { + "type": "minor", + "position": { + "lat": 47.62579, + "lon": -122.15377 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/152428", + "score": 2.668, + "dist": 3529.7080738812224, + "info": "search:ta:840539001033722-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-3789496", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/site-selector", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "180", + "streetName": "148th Ave SE", + "municipalitySubdivision": "West Lake Hills, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98007", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "180 148th Ave SE, Bellevue, WA 98007", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.60901, + "lon": -122.14 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.60991, + "lon": -122.14133 + }, + "btmRightPoint": { + "lat": 47.60811, + "lon": -122.13867 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.60901, + "lon": -122.14008 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/167147", + "score": 2.668, + "dist": 3479.393294615887, + "info": "search:ta:840539000326896-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-8619198", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/site-selector", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "7425", + "streetName": "166th Ave NE", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980526288", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "7425 166th Ave NE, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.67055, + "lon": -122.12001 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.67145, + "lon": -122.12135 + }, + "btmRightPoint": { + "lat": 47.66965, + "lon": -122.11867 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.67069, + "lon": -122.11889 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/153695", + "score": 2.667, + "dist": 3622.4410746187291, + "info": "search:ta:840531000006551-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-8822881", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/store/15022", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "7625", + "streetName": "170th Ave NE", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980520910", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "7625 170th Ave NE, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.67086, + "lon": -122.11392 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.67176, + "lon": -122.11526 + }, + "btmRightPoint": { + "lat": 47.66996, + "lon": -122.11258 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.67073, + "lon": -122.1135 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/167420", + "score": 2.667, + "dist": 3818.293513029088, + "info": "search:ta:840539000640782-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-8853323", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/site-selector", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "17246", + "streetName": "Redmond Way", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980524403", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "17246 Redmond Way, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.67174, + "lon": -122.10976 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.67264, + "lon": -122.1111 + }, + "btmRightPoint": { + "lat": 47.67084, + "lon": -122.10842 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.6706, + "lon": -122.11026 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/153686", + "score": 2.666, + "dist": 4009.9222051470738, + "info": "search:ta:840531000006548-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-8859590", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/site-selector", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "15738", + "streetName": "Redmond Way Pad 3 Redmond Center", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980523873", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "15738 Redmond Way Pad 3 Redmond Center, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.67583, + "lon": -122.12877 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.67673, + "lon": -122.13011 + }, + "btmRightPoint": { + "lat": 47.67493, + "lon": -122.12743 + } + }, + "entryPoints": [ + { + "type": "minor", + "position": { + "lat": 47.67456, + "lon": -122.12887 + } + }, + { + "type": "main", + "position": { + "lat": 47.67668, + "lon": -122.12829 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/168511", + "score": 2.666, + "dist": 3987.80992387863, + "info": "search:ta:840531000006669-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-8818265", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/site-selector", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "6617", + "streetName": "132Nd Ave Ne Bridle Trails Shopping Center", + "municipalitySubdivision": "Kirkland, Bridle Trails", + "municipality": "Kirkland", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98033", + "extendedPostalCode": "980338234", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "6617 132Nd Ave Ne Bridle Trails Shopping Center, Kirkland, WA 98033", + "localName": "Kirkland", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.66514, + "lon": -122.16599 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.66604, + "lon": -122.16733 + }, + "btmRightPoint": { + "lat": 47.66424, + "lon": -122.16465 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.666, + "lon": -122.16669 + } + }, + { + "type": "minor", + "position": { + "lat": 47.66553, + "lon": -122.16405 + } + } + ] + } + ] + } + } + ], + "summary": { + "successfulRequests": 3, + "totalRequests": 3 + } + } + }, + "408": { + "headers": {}, + "body": { + "error": { + "code": "408 Timeout", + "message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api." + } + } + } + } +} diff --git a/specification/maps/data-plane/Search/preview/1.0/examples/PostSearchInsideFeatureCollection.json b/specification/maps/data-plane/Search/preview/1.0/examples/PostSearchInsideFeatureCollection.json new file mode 100644 index 000000000000..0f083c1ece65 --- /dev/null +++ b/specification/maps/data-plane/Search/preview/1.0/examples/PostSearchInsideFeatureCollection.json @@ -0,0 +1,216 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "query": "pizza", + "limit": 2, + "searchInsideGeometryRequestBody": { + "geometry": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + -122.143035, + 47.653536 + ], + [ + -122.187164, + 47.617556 + ], + [ + -122.114981, + 47.570599 + ], + [ + -122.132756, + 47.654009 + ], + [ + -122.143035, + 47.653536 + ] + ] + ] + }, + "properties": {} + }, + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + -122.126986, + 47.639754 + ] + }, + "properties": { + "subType": "Circle", + "radius": 100 + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "summary": { + "query": "pizza", + "queryType": "NON_NEAR", + "queryTime": 45, + "numResults": 2, + "offset": 0, + "totalResults": 18, + "fuzzyLevel": 1 + }, + "results": [ + { + "type": "POI", + "id": "US/POI/p1/199865", + "score": 4, + "info": "search:decarta:ta:840539000519519-US", + "poi": { + "name": "Tutta Bella", + "phone": "+(1)-(425)-5027402", + "categorySet": [ + { + "id": 7315036 + } + ], + "url": "TuttaBella.com", + "classifications": [ + { + "code": "RESTAURANT", + "names": [ + { + "nameLocale": "en-US", + "name": "restaurant" + }, + { + "nameLocale": "en-US", + "name": "pizza" + } + ] + } + ] + }, + "address": { + "streetNumber": "15600", + "streetName": "NE 8th St", + "municipalitySubdivision": "Bellevue, Crossroads", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98008", + "extendedPostalCode": "980084084", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "15600 NE 8th St, Bellevue, WA 98008", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.61705, + "lon": -122.13228 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.61795, + "lon": -122.13361 + }, + "btmRightPoint": { + "lat": 47.61615, + "lon": -122.13095 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.61701, + "lon": -122.13228 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/205464", + "score": 4, + "info": "search:decarta:ta:840539000714286-US", + "poi": { + "name": "Q & S Food Co LLC", + "phone": "+(1)-(425)-7464764", + "categorySet": [ + { + "id": 7315036 + } + ], + "classifications": [ + { + "code": "RESTAURANT", + "names": [ + { + "nameLocale": "en-US", + "name": "restaurant" + }, + { + "nameLocale": "en-US", + "name": "pizza" + } + ] + } + ] + }, + "address": { + "streetNumber": "511", + "streetName": "141st Ave SE", + "municipalitySubdivision": "Bellevue, West Lake Hills", + "municipality": "Bellevue, Eastgate", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98007", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "511 141st Ave SE, Bellevue, WA 98007", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.6051, + "lon": -122.15226 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.606, + "lon": -122.15359 + }, + "btmRightPoint": { + "lat": 47.6042, + "lon": -122.15093 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.6051, + "lon": -122.15219 + } + } + ] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Search/preview/1.0/examples/PostSearchInsideGeometry.json b/specification/maps/data-plane/Search/preview/1.0/examples/PostSearchInsideGeometry.json new file mode 100644 index 000000000000..ea801e775cfa --- /dev/null +++ b/specification/maps/data-plane/Search/preview/1.0/examples/PostSearchInsideGeometry.json @@ -0,0 +1,202 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "query": "burger", + "limit": 2, + "searchInsideGeometryRequestBody": { + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + -122.43576049804686, + 37.7524152343544 + ], + [ + -122.43301391601562, + 37.70660472542312 + ], + [ + -122.36434936523438, + 37.712059855877314 + ], + [ + -122.43576049804686, + 37.7524152343544 + ] + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "summary": { + "query": "pizza", + "queryType": "NON_NEAR", + "queryTime": 9, + "numResults": 2, + "offset": 0, + "totalResults": 18, + "fuzzyLevel": 1 + }, + "results": [ + { + "type": "POI", + "id": "US/POI/p0/8596331", + "score": 2.226, + "info": "search:ta:840539000722333-US", + "poi": { + "name": "Mod Pizza", + "phone": "+(1)-(425)-2149903", + "brands": [ + { + "name": "Mod Pizza" + } + ], + "categorySet": [ + { + "id": 7315036 + } + ], + "url": "https://modpizza.com/locations/bellevue-overlake", + "classifications": [ + { + "code": "RESTAURANT", + "names": [ + { + "nameLocale": "en-US", + "name": "pizza" + }, + { + "nameLocale": "en-US", + "name": "restaurant" + } + ] + } + ] + }, + "address": { + "streetNumber": "14309", + "streetName": "NE 20th St", + "municipalitySubdivision": "Crossroads, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98007", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "14309 NE 20th St, Bellevue, WA 98007", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.62779, + "lon": -122.14971 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.62869, + "lon": -122.15104 + }, + "btmRightPoint": { + "lat": 47.62689, + "lon": -122.14838 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.62789, + "lon": -122.14977 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/8596385", + "score": 2.226, + "info": "search:ta:840539000366535-US", + "poi": { + "name": "Pizza Hut", + "phone": "+(1)-(425)-8619900", + "brands": [ + { + "name": "Pizza Hut" + } + ], + "categorySet": [ + { + "id": 7315036 + } + ], + "url": "www.pizzahut.com", + "classifications": [ + { + "code": "RESTAURANT", + "names": [ + { + "nameLocale": "en-US", + "name": "pizza" + }, + { + "nameLocale": "en-US", + "name": "restaurant" + } + ] + } + ] + }, + "address": { + "streetNumber": "2560", + "streetName": "152nd Ave NE", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "9805207", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "2560 152nd Ave NE, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.63255, + "lon": -122.137 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.63345, + "lon": -122.13833 + }, + "btmRightPoint": { + "lat": 47.63165, + "lon": -122.13567 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.63255, + "lon": -122.1377 + } + } + ] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Search/preview/1.0/examples/PostSearchInsideGeometryCollection.json b/specification/maps/data-plane/Search/preview/1.0/examples/PostSearchInsideGeometryCollection.json new file mode 100644 index 000000000000..9ad0a2b0cdc3 --- /dev/null +++ b/specification/maps/data-plane/Search/preview/1.0/examples/PostSearchInsideGeometryCollection.json @@ -0,0 +1,230 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "query": "pizza", + "limit": 2, + "searchInsideGeometryRequestBody": { + "geometry": { + "type": "GeometryCollection", + "geometries": [ + { + "type": "Polygon", + "coordinates": [ + [ + [ + -122.43576049804686, + 37.7524152343544 + ], + [ + -122.43301391601563, + 37.706604725423119 + ], + [ + -122.36434936523438, + 37.712059855877314 + ], + [ + -122.43576049804686, + 37.7524152343544 + ] + ] + ] + }, + { + "type": "Polygon", + "coordinates": [ + [ + [ + -123.43576049804686, + 37.7524152343544 + ], + [ + -123.43301391601563, + 37.706604725423119 + ], + [ + -123.36434936523438, + 37.712059855877314 + ], + [ + -123.43576049804686, + 37.7524152343544 + ] + ] + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "summary": { + "query": "pizza", + "queryType": "NON_NEAR", + "queryTime": 9, + "numResults": 2, + "offset": 0, + "totalResults": 18, + "fuzzyLevel": 1 + }, + "results": [ + { + "type": "POI", + "id": "US/POI/p0/8596331", + "score": 2.226, + "info": "search:ta:840539000722333-US", + "poi": { + "name": "Mod Pizza", + "phone": "+(1)-(425)-2149903", + "brands": [ + { + "name": "Mod Pizza" + } + ], + "categorySet": [ + { + "id": 7315036 + } + ], + "url": "https://modpizza.com/locations/bellevue-overlake", + "classifications": [ + { + "code": "RESTAURANT", + "names": [ + { + "nameLocale": "en-US", + "name": "pizza" + }, + { + "nameLocale": "en-US", + "name": "restaurant" + } + ] + } + ] + }, + "address": { + "streetNumber": "14309", + "streetName": "NE 20th St", + "municipalitySubdivision": "Crossroads, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98007", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "14309 NE 20th St, Bellevue, WA 98007", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.62779, + "lon": -122.14971 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.62869, + "lon": -122.15104 + }, + "btmRightPoint": { + "lat": 47.62689, + "lon": -122.14838 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.62789, + "lon": -122.14977 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/8596385", + "score": 2.226, + "info": "search:ta:840539000366535-US", + "poi": { + "name": "Pizza Hut", + "phone": "+(1)-(425)-8619900", + "brands": [ + { + "name": "Pizza Hut" + } + ], + "categorySet": [ + { + "id": 7315036 + } + ], + "url": "www.pizzahut.com", + "classifications": [ + { + "code": "RESTAURANT", + "names": [ + { + "nameLocale": "en-US", + "name": "pizza" + }, + { + "nameLocale": "en-US", + "name": "restaurant" + } + ] + } + ] + }, + "address": { + "streetNumber": "2560", + "streetName": "152nd Ave NE", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "9805207", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "2560 152nd Ave NE, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.63255, + "lon": -122.137 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.63345, + "lon": -122.13833 + }, + "btmRightPoint": { + "lat": 47.63165, + "lon": -122.13567 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.63255, + "lon": -122.1377 + } + } + ] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Search/preview/1.0/search.json b/specification/maps/data-plane/Search/preview/1.0/search.json new file mode 100644 index 000000000000..4da5c6519b15 --- /dev/null +++ b/specification/maps/data-plane/Search/preview/1.0/search.json @@ -0,0 +1,2631 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Search Service", + "version": "1.0", + "description": "Azure Maps Search REST APIs" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{geography}.atlas.microsoft.com", + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "AzureKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "AzureKey": [] + } + ], + "responses": {}, + "parameters": { + "SearchApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API.", + "type": "string", + "in": "query", + "required": true, + "default": "1.0", + "x-ms-parameter-location": "client" + }, + "BatchId": { + "name": "format", + "description": "Batch id for querying the operation.", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "LimitSearch": { + "name": "limit", + "in": "query", + "description": "Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100", + "type": "integer", + "minimum": 1, + "maximum": 100, + "x-ms-parameter-location": "method" + }, + "Offset": { + "name": "ofs", + "in": "query", + "description": "Starting offset of the returned results within the full result set. Default: 0, minimum: 0 and maximum: 1900", + "type": "integer", + "minimum": 0, + "maximum": 1900, + "x-ms-parameter-location": "method" + }, + "OptionalBiasLat": { + "name": "lat", + "in": "query", + "description": "Latitude where results should be biased. E.g. 37.337", + "type": "number", + "x-ms-parameter-location": "method" + }, + "OptionalBiasLon": { + "name": "lon", + "in": "query", + "description": "Longitude where results should be biased. E.g. -121.89", + "type": "number", + "x-ms-parameter-location": "method" + }, + "BoundingBoxTopLeft": { + "x-client-name": "BoundingBoxTopLeft", + "name": "topLeft", + "in": "query", + "description": "Top left position of the bounding box. E.g. 37.553,-122.453", + "type": "string", + "x-ms-parameter-location": "method" + }, + "BoundingBoxBottomRight": { + "x-client-name": "BoundingBoxBottomRight", + "name": "btmRight", + "in": "query", + "description": "Bottom right position of the bounding box. E.g. 37.553,-122.453", + "type": "string", + "x-ms-parameter-location": "method" + }, + "RequiredBiasLat": { + "name": "lat", + "in": "query", + "description": "Latitude where results should be biased. E.g. 37.337.", + "required": true, + "type": "number", + "x-ms-parameter-location": "method" + }, + "RequiredBiasLon": { + "name": "lon", + "in": "query", + "description": "Longitude where results should be biased. E.g. -121.89.", + "required": true, + "type": "number", + "x-ms-parameter-location": "method" + }, + "Language": { + "name": "language", + "in": "query", + "description": "Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used.\n\nPlease refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "Query": { + "name": "query", + "in": "query", + "description": "The applicable query string. Must be properly URL encoded.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Position": { + "name": "query", + "in": "query", + "description": "The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "View": { + "name": "view", + "in": "query", + "description": "The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.\n\nPlease refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "SearchIndexSet": { + "name": "idxSet", + "in": "query", + "description": "A comma separated list of indexes which should be utilized for the search. Item order does not matter. Available indexes are: Addr = Address range interpolation, Geo = Geographies, PAD = Point Addresses, POI = Points of interest, Str = Streets, Xstr = Cross Streets (intersections)", + "type": "array", + "items": { + "type": "string", + "enum": [ + "Addr", + "Geo", + "PAD", + "POI", + "Str", + "Xstr" + ], + "x-ms-enum": { + "name": "SearchIndexSet", + "modelAsString": true, + "values": [ + { + "value": "Addr", + "description": "Address range interpolation" + }, + { + "value": "Geo", + "description": "Geographies" + }, + { + "value": "PAD", + "description": "Point Addresses" + }, + { + "value": "POI", + "description": "Points of interest" + }, + { + "value": "Str", + "description": "Streets" + }, + { + "value": "Xstr", + "description": "Cross Streets (Intersections)" + } + ] + } + }, + "collectionFormat": "csv", + "x-ms-parameter-location": "method" + }, + "ExtendedPostalCodesFor": { + "name": "extendedPostalCodesFor", + "in": "query", + "description": "Indexes for which extended postal codes should be included in the results.\n\nAvailable indexes are: \n\n **Addr** = Address ranges \n\n **Geo** = Geographies \n\n **PAD** = Point Addresses \n\n **POI** = Points of Interest \n\n **Str** = Streets \n\n **XStr** = Cross Streets (intersections)\n\nValue should be a comma separated list of index types (in any order) or **None** for no indexes.\n\nBy default extended postal codes are included for all indexes except Geo. Extended postal code lists for geographies can be quite long so they have to be explicitly requested when needed.\n\nUsage examples:\n\n extendedPostalCodesFor=POI \n\n extendedPostalCodesFor=PAD,Addr,POI \n\n extendedPostalCodesFor=None\n\nExtended postal code is returned as an **extendedPostalCode** property of an address. Availability is region-dependent.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "ExtendedPostalCodesForPoi": { + "name": "extendedPostalCodesFor", + "in": "query", + "description": "Indexes for which extended postal codes should be included in the results.\n\nAvailable indexes are: \n\n **POI** = Points of Interest \n\nValue should be **POI** or **None** to disable extended postal codes.\n\nBy default extended postal codes are included.\n\nUsage examples:\n\n extendedPostalCodesFor=POI \n\n extendedPostalCodesFor=None\n\nExtended postal code is returned as an **extendedPostalCode** property of an address. Availability is region-dependent.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "Typeahead": { + "name": "typeahead", + "in": "query", + "description": "Boolean. If the typeahead flag is set, the query will be interpreted as a partial input and the search will enter predictive mode", + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "CategorySet": { + "name": "categorySet", + "in": "query", + "description": "A comma-separated list of category set IDs which could be used to restrict the result to specific Points of Interest categories. ID order does not matter. When multiple category identifiers are provided, only POIs that belong to (at least) one of the categories from the provided list will be returned. The list of supported categories can be discovered using  [POI Categories API](https://aka.ms/AzureMapsPOICategoryTree). Usage examples: \n\n* **categorySet=7315** (Search Points of Interest from category Restaurant)\n\n* **categorySet=7315025,7315017** (Search Points of Interest of category either Italian or French Restaurant) ", + "type": "array", + "items": { + "type": "integer" + }, + "collectionFormat": "csv", + "x-ms-parameter-location": "method" + }, + "CountrySet": { + "name": "countrySet", + "in": "query", + "description": "Comma separated string of country codes, e.g. FR,ES. This will limit the search to the specified countries", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv", + "x-ms-parameter-location": "method" + }, + "Radius": { + "name": "radius", + "in": "query", + "description": "The radius in meters to for the results to be constrained to the defined area", + "type": "number", + "x-ms-parameter-location": "method" + }, + "PoiQuery": { + "name": "query", + "in": "query", + "description": "The POI name to search for (e.g., \"statue of liberty\", \"starbucks\", \"pizza\"). Must be properly URL encoded.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "BrandSet": { + "name": "brandSet", + "in": "query", + "description": "A comma-separated list of brand names which could be used to restrict the result to specific brands. Item order does not matter. When multiple brands are provided, only results that belong to (at least) one of the provided list will be returned. Brands that contain a \",\" in their name should be put into quotes.\n\nUsage examples:\n\n brandSet=Foo\n\n brandSet=Foo,Bar\n\n brandSet=\"A,B,C Comma\",Bar", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv", + "x-ms-parameter-location": "method" + }, + "ConnectorSet": { + "name": "connectorSet", + "in": "query", + "description": "A comma-separated list of connector types which could be used to restrict the result to Electric Vehicle Station supporting specific connector types. Item order does not matter. When multiple connector types are provided, only results that belong to (at least) one of the provided list will be returned.\n\nAvailable connector types are:\n * `StandardHouseholdCountrySpecific` - These are the standard household connectors for a certain region. They are all AC single phase and the standard Voltage and standard Amperage. See also: [Plug & socket types - World Standards](https://www.worldstandards.eu/electricity/plugs-and-sockets).\n * `IEC62196Type1` - Type 1 connector as defined in the IEC 62196-2 standard. Also called Yazaki after the original manufacturer or SAE J1772 after the standard that first published it. Mostly used in combination with 120V single phase or up to 240V single phase infrastructure.\n * `IEC62196Type1CCS` - Type 1 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 1 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging.\n * `IEC62196Type2CableAttached` - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a cable and plug attached to the charging point.\n * `IEC62196Type2Outlet` - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a socket set into the charging point.\n * `IEC62196Type2CCS` - Type 2 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 2 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging.\n * `IEC62196Type3` - Type 3 connector as defined in the IEC 62196-2 standard. Also called Scame after the original manufacturer. Mostly used in combination with up to 240V single phase or up to 420V three phase infrastructure.\n * `Chademo` - CHAdeMO connector named after an association formed by the Tokyo Electric Power Company and industrial partners. Because of this is is also known as the TEPCO's connector. It supports fast DC charging.\n * `IEC60309AC1PhaseBlue` - Industrial Blue connector is a connector defined in the IEC 60309 standard. It is sometime referred to as by some combination of the standard, the color and the fact that is a single phase connector. The connector usually has the \"P+N+E, 6h\" configuration.\n * `IEC60309DCWhite` - Industrial White connector is a DC connector defined in the IEC 60309 standard.\n * `Tesla` - The Tesla connector is the regionally specific Tesla Supercharger connector. I.e. it refers to either Tesla's proprietary connector, sometimes referred to as Tesla Port mostly limited to North America or the modified Type 2 (DC over Type 2) in Europe.\n\nUsage examples:\n\n connectorSet=IEC62196Type2CableAttached\n connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached", + "type": "array", + "items": { + "type": "string", + "enum": [ + "StandardHouseholdCountrySpecific", + "IEC62196Type1", + "IEC62196Type1CCS", + "IEC62196Type2CableAttached", + "IEC62196Type2Outlet", + "IEC62196Type2CCS", + "IEC62196Type3", + "Chademo", + "IEC60309AC1PhaseBlue", + "IEC60309DCWhite", + "Tesla" + ], + "x-ms-enum": { + "name": "ConnectorSet", + "modelAsString": true, + "values": [ + { + "value": "StandardHouseholdCountrySpecific", + "description": "These are the standard household connectors for a certain region. They are all AC single phase and the standard Voltage and standard Amperage.\n\nSee also: [Plug & socket types - World Standards](https://www.worldstandards.eu/electricity/plugs-and-sockets)" + }, + { + "value": "IEC62196Type1", + "description": "Type 1 connector as defined in the IEC 62196-2 standard. Also called Yazaki after the original manufacturer or SAE J1772 after the standard that first published it. Mostly used in combination with 120V single phase or up to 240V single phase infrastructure." + }, + { + "value": "IEC62196Type1CCS", + "description": "Type 1 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 1 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging." + }, + { + "value": "IEC62196Type2CableAttached", + "description": "Type 2 connector as defined in the IEC 62196-2 standard. Provided as a cable and plug attached to the charging point" + }, + { + "value": "IEC62196Type2Outlet", + "description": "Type 2 connector as defined in the IEC 62196-2 standard. Provided as a socket set into the charging point." + }, + { + "value": "IEC62196Type2CCS", + "description": "Type 2 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 2 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging." + }, + { + "value": "IEC62196Type3", + "description": "Type 3 connector as defined in the IEC 62196-2 standard. Also called Scame after the original manufacturer. Mostly used in combination with up to 240V single phase or up to 420V three phase infrastructure." + }, + { + "value": "Chademo", + "description": "CHAdeMO connector named after an association formed by the Tokyo Electric Power Company and industrial partners. Because of this is is also known as the TEPCO's connector. It supports fast DC charging." + }, + { + "value": "IEC60309AC1PhaseBlue", + "description": "Industrial Blue connector is a connector defined in the IEC 60309 standard. It is sometime referred to as by some combination of the standard, the color and the fact that is a single phase connector. The connector usually has the \"P+N+E, 6h\" configuration." + }, + { + "value": "IEC60309DCWhite", + "description": "Industrial White connector is a DC connector defined in the IEC 60309 standard." + }, + { + "value": "Tesla", + "description": "The Tesla connector is the regionally specific Tesla Supercharger connector. I.e. it refers to either Tesla's proprietary connector, sometimes referred to as Tesla Port mostly limited to North America or the modified Type 2 (DC over Type 2) in Europe." + } + ] + } + }, + "collectionFormat": "csv", + "x-ms-parameter-location": "method" + }, + "OpeningHours": { + "name": "openingHours", + "description": "Hours of operation for a POI (Points of Interest). The availability of hours of operation will vary based on the data available.\nSupported value: nextSevenDays", + "type": "string", + "in": "query", + "enum": [ + "nextSevenDays" + ], + "x-ms-enum": { + "name": "OpeningHours", + "modelAsString": true, + "values": [ + { + "value": "nextSevenDays", + "description": "Shows the hours of operation for the next week, starting with the current day in the local time of the POI." + } + ] + }, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/search/polygon/{format}": { + "get": { + "description": "**Get Polygon**\n\n\n**Applies to**: S1 pricing tier.\n\n\nThe Get Polygon service allows you to request the geometry data such as a city or country outline for a set of entities, previously retrieved from an Online Search request in GeoJSON format. The geometry ID is returned in the dataSources object under \"geometry\" and \"id\" in either a Search Address or Search Fuzzy call.\n\nPlease note that any geometry ID retrieved from an Online Search endpoint has a limited lifetime. The client should not store geometry IDs in persistent storage for later referral, as the stability of these identifiers is not guaranteed for a long period of time. It is expected that a request to the Polygon method is made within a few minutes of the request to the Online Search method that provided the ID. The service allows for batch requests up to 20 identifiers.", + "operationId": "Search_GetSearchPolygon", + "x-ms-examples": { + "Get the Geometry using the geometry id returned by the previous Search": { + "$ref": "./examples/GetSearchPolygon.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SearchApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "geometries", + "in": "query", + "description": "Comma separated list of geometry UUIDs, previously retrieved from an Online Search request.", + "required": true, + "type": "array", + "items": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchPolygonResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/search/fuzzy/{format}": { + "get": { + "description": "\n**Free Form Search**\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThe basic default API is Free Form Search which handles the most fuzzy of inputs handling any combination of address or POI tokens. This search API is the canonical 'single line search'. The Free Form Search API is a seamless combination of POI search and geocoding. The API can also be weighted with a contextual position (lat./lon. pair), or fully constrained by a coordinate and radius, or it can be executed more generally without any geo biasing anchor point.

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

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

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

    Most Search queries default to `maxFuzzyLevel`=2 to gain performance and also reduce unusual results. This new default can be overridden as needed per request by passing in the query param `maxFuzzyLevel`=3 or 4.", + "operationId": "Search_GetSearchFuzzy", + "x-ms-examples": { + "Search City Seattle": { + "$ref": "./examples/GetSearchFuzzy.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SearchApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/TextFormat" + }, + { + "name": "query", + "in": "query", + "description": "The applicable query string (e.g., \"seattle\", \"pizza\"). Can _also_ be specified as a comma separated string composed by latitude followed by longitude (e.g., \"47.641268, -122.125679\"). Must be properly URL encoded.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/Typeahead" + }, + { + "$ref": "#/parameters/LimitSearch" + }, + { + "$ref": "#/parameters/Offset" + }, + { + "$ref": "#/parameters/CategorySet" + }, + { + "$ref": "#/parameters/CountrySet" + }, + { + "$ref": "#/parameters/OptionalBiasLat" + }, + { + "$ref": "#/parameters/OptionalBiasLon" + }, + { + "$ref": "#/parameters/Radius" + }, + { + "$ref": "#/parameters/BoundingBoxTopLeft" + }, + { + "$ref": "#/parameters/BoundingBoxBottomRight" + }, + { + "$ref": "#/parameters/Language" + }, + { + "$ref": "#/parameters/ExtendedPostalCodesFor" + }, + { + "name": "minFuzzyLevel", + "in": "query", + "description": "Minimum fuzziness level to be used. Default: 1, minimum: 1 and maximum: 4\n\n* Level 1 has no spell checking.\n\n* Level 2 uses normal n-gram spell checking. For example, query \"restrant\" can be matched to \"restaurant.\"\n\n* Level 3 uses sound-like spell checking, and shingle spell checking. Sound-like spell checking is for \"rstrnt\" to \"restaurant\" matching. Shingle spell checking is for \"mountainview\" to \"mountain view\" matching.\n\n* Level 4 doesn’t add any more spell checking functions.\n\n\n\nThe search engine will start looking for a match on the level defined by minFuzzyLevel, and will stop searching at the level specified by maxFuzzyLevel.", + "type": "integer", + "minimum": 1, + "maximum": 4 + }, + { + "name": "maxFuzzyLevel", + "in": "query", + "description": "Maximum fuzziness level to be used. Default: 2, minimum: 1 and maximum: 4\n\n* Level 1 has no spell checking.\n\n* Level 2 uses normal n-gram spell checking. For example, query \"restrant\" can be matched to \"restaurant.\"\n\n* Level 3 uses sound-like spell checking, and shingle spell checking. Sound-like spell checking is for \"rstrnt\" to \"restaurant\" matching. Shingle spell checking is for \"mountainview\" to \"mountain view\" matching.\n\n* Level 4 doesn’t add any more spell checking functions.\n\n\n\nThe search engine will start looking for a match on the level defined by minFuzzyLevel, and will stop searching at the level specified by maxFuzzyLevel.", + "type": "integer", + "minimum": 1, + "maximum": 4 + }, + { + "$ref": "#/parameters/SearchIndexSet" + }, + { + "$ref": "#/parameters/BrandSet" + }, + { + "$ref": "#/parameters/ConnectorSet" + }, + { + "$ref": "#/parameters/View" + }, + { + "$ref": "#/parameters/OpeningHours" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchCommonResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/search/poi/{format}": { + "get": { + "description": "**Get POI by Name**\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nPoints of Interest (POI) Search allows you to request POI results by name. Search supports additional query parameters such as language and filtering results by area of interest driven by country or bounding box. Endpoint will return only POI results matching the query string. Response includes POI details such as address, coordinate location and category.", + "operationId": "Search_GetSearchPOI", + "x-ms-examples": { + "Search for juice bars within 5 miles of Seattle Downtown and limit the response to 5 results": { + "$ref": "./examples/GetSearchPOI.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SearchApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/TextFormat" + }, + { + "name": "query", + "in": "query", + "description": "The POI name to search for (e.g., \"statue of liberty\", \"starbucks\"), must be properly URL encoded.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/Typeahead" + }, + { + "$ref": "#/parameters/LimitSearch" + }, + { + "$ref": "#/parameters/Offset" + }, + { + "$ref": "#/parameters/CategorySet" + }, + { + "$ref": "#/parameters/CountrySet" + }, + { + "$ref": "#/parameters/OptionalBiasLat" + }, + { + "$ref": "#/parameters/OptionalBiasLon" + }, + { + "$ref": "#/parameters/Radius" + }, + { + "$ref": "#/parameters/BoundingBoxTopLeft" + }, + { + "$ref": "#/parameters/BoundingBoxBottomRight" + }, + { + "$ref": "#/parameters/Language" + }, + { + "$ref": "#/parameters/ExtendedPostalCodesForPoi" + }, + { + "$ref": "#/parameters/BrandSet" + }, + { + "$ref": "#/parameters/ConnectorSet" + }, + { + "$ref": "#/parameters/View" + }, + { + "$ref": "#/parameters/OpeningHours" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchCommonResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/search/nearby/{format}": { + "get": { + "description": "**Nearby Search**\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nIf you have a use case for only retrieving POI results around a specific location, the nearby search method may be the right choice. This endpoint will only return POI results, and does not take in a search query parameter.", + "operationId": "Search_GetSearchNearby", + "x-ms-examples": { + "Search for any points of interest (POI) within 5 miles of Manhattan NY and return the top 10 results": { + "$ref": "./examples/GetSearchNearby.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SearchApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/TextFormat" + }, + { + "$ref": "#/parameters/RequiredBiasLat" + }, + { + "$ref": "#/parameters/RequiredBiasLon" + }, + { + "$ref": "#/parameters/LimitSearch" + }, + { + "$ref": "#/parameters/Offset" + }, + { + "$ref": "#/parameters/CategorySet" + }, + { + "$ref": "#/parameters/CountrySet" + }, + { + "name": "radius", + "in": "query", + "description": "The radius in meters to for the results to be constrained to the defined area, Min value is 1, Max Value is 50000.", + "type": "number" + }, + { + "$ref": "#/parameters/Language" + }, + { + "$ref": "#/parameters/ExtendedPostalCodesFor" + }, + { + "$ref": "#/parameters/BrandSet" + }, + { + "$ref": "#/parameters/ConnectorSet" + }, + { + "$ref": "#/parameters/View" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchCommonResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/search/poi/category/{format}": { + "get": { + "description": "**Get POI by Category**\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nPoints of Interest (POI) Category Search allows you to request POI results from given category. Search allows to query POIs from one category at a time. Endpoint will only return POI results which are categorized as specified. Response includes POI details such as address, coordinate location and classification.", + "operationId": "Search_GetSearchPOICategory", + "x-ms-examples": { + "Search for atm's within 2 miles of Times Square NY and return the top 3 results": { + "$ref": "./examples/GetSearchPOICategory.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SearchApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/TextFormat" + }, + { + "name": "query", + "in": "query", + "description": "The POI category to search for (e.g., \"AIRPORT\", \"RESTAURANT\"), must be properly URL encoded. Supported main categories can be requested by calling [Get Search POI Category Tree API](https://aka.ms/AzureMapsPOICategoryTree). List of available categories can also be found [here](https://docs.microsoft.com/azure/azure-maps/supported-search-categories). We recommend to use POI Search Category Tree API to request the supported categories.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/Typeahead" + }, + { + "$ref": "#/parameters/LimitSearch" + }, + { + "$ref": "#/parameters/Offset" + }, + { + "$ref": "#/parameters/CategorySet" + }, + { + "$ref": "#/parameters/CountrySet" + }, + { + "$ref": "#/parameters/OptionalBiasLat" + }, + { + "$ref": "#/parameters/OptionalBiasLon" + }, + { + "$ref": "#/parameters/Radius" + }, + { + "$ref": "#/parameters/BoundingBoxTopLeft" + }, + { + "$ref": "#/parameters/BoundingBoxBottomRight" + }, + { + "$ref": "#/parameters/Language" + }, + { + "$ref": "#/parameters/ExtendedPostalCodesFor" + }, + { + "$ref": "#/parameters/BrandSet" + }, + { + "$ref": "#/parameters/ConnectorSet" + }, + { + "$ref": "#/parameters/View" + }, + { + "$ref": "#/parameters/OpeningHours" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchCommonResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/search/poi/category/tree/{format}": { + "get": { + "description": "**Get POI Category Tree**\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nPOI Category API provides a full list of supported Points of Interest (POI) categories and subcategories together with their translations and synonyms. The returned content can be used to provide more meaningful results through other Search Service APIs, like [Get Search POI](https://docs.microsoft.com/rest/api/maps/search/getsearchpoi).", + "operationId": "Search_GetSearchPOICategoryTreePreview", + "x-ms-examples": { + "Get the POI Category Tree (only partial response shown below)": { + "$ref": "./examples/GetSearchPOICategoryTree.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SearchApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "language", + "in": "query", + "description": "Language in which search results should be returned. Should be one of supported IETF language tags, except NGT and NGT-Latn. Language tag is case insensitive. When data in specified language is not available for a specific field, default language is used (English).\n\nPlease refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchPoiCategoryTreeResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/search/address/{format}": { + "get": { + "description": "**Address Geocoding**\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nIn many cases, the complete search service might be too much, for instance if you are only interested in traditional geocoding. Search can also be accessed for address look up exclusively. The geocoding is performed by hitting the geocode endpoint with just the address or partial address in question. The geocoding search index will be queried for everything above the street level data. No POIs will be returned. Note that the geocoder is very tolerant of typos and incomplete addresses. It will also handle everything from exact street addresses or street or intersections as well as higher level geographies such as city centers, counties, states etc.", + "operationId": "Search_GetSearchAddress", + "x-ms-examples": { + "Search detail address 15127 NE 24th Street, Redmond, WA 98052": { + "$ref": "./examples/GetSearchAddress.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SearchApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/TextFormat" + }, + { + "name": "query", + "in": "query", + "description": "The address to search for (e.g., \"1 Microsoft way, Redmond, WA\"), must be properly URL encoded.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/Typeahead" + }, + { + "$ref": "#/parameters/LimitSearch" + }, + { + "$ref": "#/parameters/Offset" + }, + { + "$ref": "#/parameters/CountrySet" + }, + { + "$ref": "#/parameters/OptionalBiasLat" + }, + { + "$ref": "#/parameters/OptionalBiasLon" + }, + { + "$ref": "#/parameters/Radius" + }, + { + "$ref": "#/parameters/BoundingBoxTopLeft" + }, + { + "$ref": "#/parameters/BoundingBoxBottomRight" + }, + { + "$ref": "#/parameters/Language" + }, + { + "$ref": "#/parameters/ExtendedPostalCodesFor" + }, + { + "$ref": "#/parameters/View" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchCommonResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/search/address/reverse/{format}": { + "get": { + "description": "**Reverse Geocode to an Address**\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThere may be times when you need to translate a coordinate (example: 37.786505, -122.3862) into a human understandable street address. Most often this is needed in tracking applications where you receive a GPS feed from the device or asset and wish to know what address where the coordinate is located. This endpoint will return address information for a given coordinate.", + "operationId": "Search_GetSearchAddressReverse", + "x-ms-examples": { + "GetSearchAddressReverse": { + "$ref": "./examples/GetSearchAddressReverse.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SearchApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/TextFormat" + }, + { + "$ref": "#/parameters/Position" + }, + { + "$ref": "#/parameters/Language" + }, + { + "name": "returnSpeedLimit", + "in": "query", + "description": "Boolean. To enable return of the posted speed limit", + "type": "boolean" + }, + { + "name": "heading", + "in": "query", + "description": "The directional heading of the vehicle in degrees, for travel along a segment of roadway. 0 is North, 90 is East and so on, values range from -360 to 360. The precision can include upto one decimal place", + "type": "number", + "minimum": -360, + "maximum": 360 + }, + { + "$ref": "#/parameters/Radius" + }, + { + "name": "number", + "in": "query", + "description": "If a number is sent in along with the request, the response may include the side of the street (Left/Right) and also an offset position for that number", + "type": "string" + }, + { + "name": "returnRoadUse", + "in": "query", + "description": "Boolean. To enable return of the road use array for reverse geocodes at street level", + "type": "boolean" + }, + { + "name": "roadUse", + "in": "query", + "description": "To restrict reverse geocodes to a certain type of road use. The road use array for reverse geocodes can be one or more of LimitedAccess, Arterial, Terminal, Ramp, Rotary, LocalStreet", + "type": "string" + }, + { + "name": "allowFreeformNewline", + "in": "query", + "description": "Format of newlines in the formatted address.\n\nIf true, the address will contain newlines.\nIf false, newlines will be converted to commas.", + "type": "boolean" + }, + { + "name": "returnMatchType", + "in": "query", + "description": "Include information on the type of match the geocoder achieved in the response.", + "type": "boolean" + }, + { + "name": "entityType", + "in": "query", + "description": "Specifies the level of filtering performed on geographies. Narrows the search for specified geography entity types, e.g. return only municipality. The resulting response will contain the geography ID as well as the entity type matched. If you provide more than one entity as a comma separated list, endpoint will return the 'smallest entity available'. Returned Geometry ID can be used to get the geometry of that geography via [Get Search Polygon](https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon) API. The following parameters are ignored when entityType is set:\n\n* heading\n* number\n* returnRoadUse\n* returnSpeedLimit\n* roadUse\n* returnMatchType", + "type": "string", + "enum": [ + "Country", + "CountrySubdivision", + "CountrySecondarySubdivision", + "CountryTertiarySubdivision", + "Municipality", + "MunicipalitySubdivision", + "Neighbourhood", + "PostalCodeArea" + ], + "x-ms-enum": { + "name": "EntityType", + "modelAsString": true, + "values": [ + { + "value": "Country", + "description": "Country name" + }, + { + "value": "CountrySubdivision", + "description": "State or Province" + }, + { + "value": "CountrySecondarySubdivision", + "description": "County" + }, + { + "value": "CountryTertiarySubdivision", + "description": "Named Area" + }, + { + "value": "Municipality", + "description": "City / Town" + }, + { + "value": "MunicipalitySubdivision", + "description": "Sub / Super City" + }, + { + "value": "Neighbourhood", + "description": "Neighbourhood" + }, + { + "value": "PostalCodeArea", + "description": "Postal Code / Zip Code" + } + ] + } + }, + { + "$ref": "#/parameters/View" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchAddressReverseResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/search/address/reverse/crossStreet/{format}": { + "get": { + "description": "**Reverse Geocode to a Cross Street**\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThere may be times when you need to translate a coordinate (example: 37.786505, -122.3862) into a human understandable cross street. Most often this is needed in tracking applications where you receive a GPS feed from the device or asset and wish to know what address where the coordinate is located.\nThis endpoint will return cross street information for a given coordinate.", + "operationId": "Search_GetSearchAddressReverseCrossStreet", + "x-ms-examples": { + "GetSearchAddressReverseCrossStreet": { + "$ref": "./examples/GetSearchAddressReverseCrossStreet.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SearchApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/TextFormat" + }, + { + "$ref": "#/parameters/Position" + }, + { + "$ref": "#/parameters/LimitSearch" + }, + { + "name": "heading", + "in": "query", + "description": "The directional heading of the vehicle in degrees, for travel along a segment of roadway. 0 is North, 90 is East and so on, values range from -360 to 360. The precision can include upto one decimal place", + "type": "number", + "minimum": -360, + "maximum": 360 + }, + { + "$ref": "#/parameters/Radius" + }, + { + "$ref": "#/parameters/Language" + }, + { + "$ref": "#/parameters/View" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchAddressReverseCrossStreetResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/search/address/structured/{format}": { + "get": { + "description": "**Structured Address Geocoding**\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nAzure Address Geocoding can also be accessed for structured address look up exclusively. The geocoding search index will be queried for everything above the street level data. No POIs will be returned. Note that the geocoder is very tolerant of typos and incomplete addresses. It will also handle everything from exact street addresses or street or intersections as well as higher level geographies such as city centers, counties, states etc.", + "operationId": "Search_GetSearchAddressStructured", + "x-ms-examples": { + "GetSearchAddressStructured": { + "$ref": "./examples/GetSearchAddressStructured.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SearchApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/TextFormat" + }, + { + "$ref": "#/parameters/Language" + }, + { + "name": "countryCode", + "in": "query", + "description": "The 2 or 3 letter [ISO3166-1](https://www.iso.org/iso-3166-country-codes.html) country code portion of an address. E.g. US.", + "default": "US", + "type": "string" + }, + { + "$ref": "#/parameters/LimitSearch" + }, + { + "$ref": "#/parameters/Offset" + }, + { + "name": "streetNumber", + "in": "query", + "description": "The street number portion of an address", + "type": "string" + }, + { + "name": "streetName", + "in": "query", + "description": "The street name portion of an address", + "type": "string" + }, + { + "name": "crossStreet", + "in": "query", + "description": "The cross street name for the structured address", + "type": "string" + }, + { + "name": "municipality", + "in": "query", + "description": "The municipality portion of an address", + "type": "string" + }, + { + "name": "municipalitySubdivision", + "in": "query", + "description": "The municipality subdivision (sub/super city) for the structured address", + "type": "string" + }, + { + "name": "countryTertiarySubdivision", + "in": "query", + "description": "The named area for the structured address", + "type": "string" + }, + { + "name": "countrySecondarySubdivision", + "in": "query", + "description": "The county for the structured address", + "type": "string" + }, + { + "name": "countrySubdivision", + "in": "query", + "description": "The country subdivision portion of an address", + "type": "string" + }, + { + "name": "postalCode", + "in": "query", + "description": "The postal code portion of an address", + "type": "string" + }, + { + "$ref": "#/parameters/ExtendedPostalCodesFor" + }, + { + "$ref": "#/parameters/View" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchCommonResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/search/geometry/{format}": { + "post": { + "description": "**Applies to**: S0 and S1 pricing tiers.\n\nThe Search Geometry endpoint allows you to perform a free form search inside a single geometry or many of them. The search results that fall inside the geometry/geometries will be returned.

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

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

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

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

    .

    ", + "operationId": "Search_PostSearchInsideGeometry", + "x-ms-examples": { + "Search for pizza places inside a geometry represented as a GeoJSON FeatureCollection type": { + "$ref": "./examples/PostSearchInsideFeatureCollection.json" + }, + "Search for burger joints inside a geometry represented as a GeoJSON GeometryCollection type": { + "$ref": "./examples/PostSearchInsideGeometryCollection.json" + }, + "Search for subs joints inside a geometry represented as a GeoJSON Polygon type": { + "$ref": "./examples/PostSearchInsideGeometry.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SearchApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/TextFormat" + }, + { + "$ref": "#/parameters/PoiQuery" + }, + { + "$ref": "#/parameters/LimitSearch" + }, + { + "$ref": "#/parameters/Language" + }, + { + "$ref": "#/parameters/CategorySet" + }, + { + "$ref": "#/parameters/ExtendedPostalCodesFor" + }, + { + "$ref": "#/parameters/SearchIndexSet" + }, + { + "name": "searchInsideGeometryRequestBody", + "in": "body", + "description": "This represents the geometry for one or more geographical features (parks, state boundary etc.) to search in and should be a GeoJSON compliant type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946) for details.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchInsideGeometryRequestBody" + } + }, + { + "$ref": "#/parameters/View" + }, + { + "$ref": "#/parameters/OpeningHours" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchCommonResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/search/alongRoute/{format}": { + "post": { + "description": "**Applies to**: S0 and S1 pricing tiers.\n\n\nThe Search Along Route endpoint allows you to perform a fuzzy search for POIs along a specified route. This search is constrained by specifying the `maxDetourTime` limiting measure.

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

    It is possible that original route will be altered, some of it's points may be skipped. If the route that passes through the found point is faster than the original one, the `detourTime` value in the response is negative.", + "operationId": "Search_PostSearchAlongRoute", + "x-ms-examples": { + "Search for burger joints along a route": { + "$ref": "./examples/PostSearchAlongRoute.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SearchApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/TextFormat" + }, + { + "$ref": "#/parameters/PoiQuery" + }, + { + "$ref": "#/parameters/CategorySet" + }, + { + "name": "maxDetourTime", + "description": "Maximum detour time of the point of interest in seconds. Max value is 3600 seconds", + "required": true, + "type": "integer", + "in": "query", + "maximum": 3600 + }, + { + "name": "limit", + "description": "Maximum number of responses that will be returned. Default value is 10. Max value is 20", + "type": "integer", + "in": "query", + "maximum": 20 + }, + { + "$ref": "#/parameters/BrandSet" + }, + { + "$ref": "#/parameters/ConnectorSet" + }, + { + "$ref": "#/parameters/View" + }, + { + "$ref": "#/parameters/OpeningHours" + }, + { + "name": "searchAlongRouteRequestBody", + "in": "body", + "description": "This represents the route to search along and should be a valid `GeoJSON LineString` type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.4) for details.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchAlongRouteRequestBody" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchCommonResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/search/fuzzy/batch/sync/{format}": { + "post": { + "description": "**Search Fuzzy Batch API**\n\n\n**Applies to**: S1 pricing tier.\n\n\n\nThe Search Address Batch API sends batches of queries to [Search Fuzzy API](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchfuzzy) using just a single API call. You can call Search Address Fuzzy Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running request. Here's a typical sequence of operations:\n1. Client sends a Search Address Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search fuzzy_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search fuzzy_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5\"},\n {\"query\": \"?query=Statue Of Liberty&limit=2\"},\n {\"query\": \"?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000\"},\n {\"query\": \"?query=Space Needle\"},\n {\"query\": \"?query=pizza&limit=10\"}\n ]\n}\n```\n\nA _search fuzzy_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search fuzzy_ [URI parameters](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchfuzzy#uri-parameters). The string values in the _search fuzzy_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchCommonResponse`](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchfuzzy#searchcommonresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"atm\"\n },\n \"results\": [\n {\n \"type\": \"POI\",\n \"poi\": {\n \"name\": \"ATM at Wells Fargo\"\n },\n \"address\": {\n \"country\": \"United States Of America\",\n \"freeformAddress\": \"3240 157th Ave NE, Redmond, WA 98052\"\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"statue of liberty\"\n },\n \"results\": [\n {\n \"type\": \"POI\",\n \"poi\": {\n \"name\": \"Statue of Liberty\"\n },\n \"address\": {\n \"country\": \"United States Of America\",\n \"freeformAddress\": \"New York, NY 10004\"\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "operationId": "Search_PostSearchFuzzyBatchSync", + "x-ms-examples": { + "A Sync Search Fuzzy Batch API call containing 5 Search Fuzzy API queries": { + "$ref": "./examples/PostSearchFuzzyBatchSync.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SearchApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "searchFuzzyBatchRequestBody", + "in": "body", + "description": "The list of search fuzzy queries/requests to process. The list can contain a max of 10,000 queries and must contain at least 1 query.", + "required": true, + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/BatchRequestBody" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchFuzzyBatchResponse" + } + }, + "408": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/408" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/search/fuzzy/batch/{format}": { + "post": { + "description": "**Search Fuzzy Batch API**\n\n\n**Applies to**: S1 pricing tier.\n\n\n\nThe Search Address Batch API sends batches of queries to [Search Fuzzy API](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchfuzzy) using just a single API call. You can call Search Address Fuzzy Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running request. Here's a typical sequence of operations:\n1. Client sends a Search Address Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search fuzzy_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search fuzzy_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5\"},\n {\"query\": \"?query=Statue Of Liberty&limit=2\"},\n {\"query\": \"?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000\"},\n {\"query\": \"?query=Space Needle\"},\n {\"query\": \"?query=pizza&limit=10\"}\n ]\n}\n```\n\nA _search fuzzy_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search fuzzy_ [URI parameters](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchfuzzy#uri-parameters). The string values in the _search fuzzy_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchCommonResponse`](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchfuzzy#searchcommonresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"atm\"\n },\n \"results\": [\n {\n \"type\": \"POI\",\n \"poi\": {\n \"name\": \"ATM at Wells Fargo\"\n },\n \"address\": {\n \"country\": \"United States Of America\",\n \"freeformAddress\": \"3240 157th Ave NE, Redmond, WA 98052\"\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"statue of liberty\"\n },\n \"results\": [\n {\n \"type\": \"POI\",\n \"poi\": {\n \"name\": \"Statue of Liberty\"\n },\n \"address\": {\n \"country\": \"United States Of America\",\n \"freeformAddress\": \"New York, NY 10004\"\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "operationId": "Search_PostSearchFuzzyBatch", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "A Search Fuzzy Batch API call containing 5 Search Fuzzy API queries": { + "$ref": "./examples/PostSearchFuzzyBatch.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SearchApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "searchFuzzyBatchRequestBody", + "in": "body", + "description": "The list of search fuzzy queries/requests to process. The list can contain a max of 10,000 queries and must contain at least 1 query.", + "required": true, + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/BatchRequestBody" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchFuzzyBatchResponse" + } + }, + "202": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/202Async" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "description": "**Search Fuzzy Batch API**\n\n\n**Applies to**: S1 pricing tier.\n\n\n\nThe Search Address Batch API sends batches of queries to [Search Fuzzy API](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchfuzzy) using just a single API call. You can call Search Address Fuzzy Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running request. Here's a typical sequence of operations:\n1. Client sends a Search Address Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search fuzzy_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search fuzzy_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5\"},\n {\"query\": \"?query=Statue Of Liberty&limit=2\"},\n {\"query\": \"?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000\"},\n {\"query\": \"?query=Space Needle\"},\n {\"query\": \"?query=pizza&limit=10\"}\n ]\n}\n```\n\nA _search fuzzy_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search fuzzy_ [URI parameters](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchfuzzy#uri-parameters). The string values in the _search fuzzy_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchCommonResponse`](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchfuzzy#searchcommonresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"atm\"\n },\n \"results\": [\n {\n \"type\": \"POI\",\n \"poi\": {\n \"name\": \"ATM at Wells Fargo\"\n },\n \"address\": {\n \"country\": \"United States Of America\",\n \"freeformAddress\": \"3240 157th Ave NE, Redmond, WA 98052\"\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"statue of liberty\"\n },\n \"results\": [\n {\n \"type\": \"POI\",\n \"poi\": {\n \"name\": \"Statue of Liberty\"\n },\n \"address\": {\n \"country\": \"United States Of America\",\n \"freeformAddress\": \"New York, NY 10004\"\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "operationId": "Search_GetSearchFuzzyBatch", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + }, + "x-ms-examples": { + "A Search Fuzzy Batch API GET call containing 5 Search Fuzzy API queries": { + "$ref": "./examples/GetSearchFuzzyBatch.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SearchApiVersion" + }, + { + "$ref": "#/parameters/BatchId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchFuzzyBatchResponse" + } + }, + "202": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/202Async" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/search/address/batch/sync/{format}": { + "post": { + "description": "**Search Address Batch API**\n\n\n**Applies to**: S1 pricing tier.\n\n\n\nThe Search Address Batch API sends batches of queries to [Search Address API](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddress) using just a single API call. You can call Search Address Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running request. Here's a typical sequence of operations:\n1. Client sends a Search Address Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search address_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search address_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=400 Broad St, Seattle, WA 98109&limit=3\"},\n {\"query\": \"?query=One, Microsoft Way, Redmond, WA 98052&limit=3\"},\n {\"query\": \"?query=350 5th Ave, New York, NY 10118&limit=1\"},\n {\"query\": \"?query=Pike Pl, Seattle, WA 98101&lat=47.610970&lon=-122.342469&radius=1000\"},\n {\"query\": \"?query=Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France&limit=1\"}\n ]\n}\n```\n\nA _search address_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search address_ [URI parameters](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddress#uri-parameters). The string values in the _search address_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchCommonResponse`](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddress#SearchCommonResponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"one microsoft way redmond wa 98052\"\n },\n \"results\": [\n {\n \"position\": {\n \"lat\": 47.63989,\n \"lon\": -122.12509\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"pike pl seattle wa 98101\"\n },\n \"results\": [\n {\n \"position\": {\n \"lat\": 47.60963,\n \"lon\": -122.34215\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "operationId": "Search_PostSearchAddressBatchSync", + "x-ms-examples": { + "A Sync Address Geocoding Batch API call containing 5 Address Geocoding API queries": { + "$ref": "./examples/PostSearchAddressBatchSync.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SearchApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "searchAddressBatchRequestBody", + "in": "body", + "description": "The list of address geocoding queries/requests to process. The list can contain a max of 10,000 queries and must contain at least 1 query.", + "required": true, + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/BatchRequestBody" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchAddressBatchResponse" + } + }, + "408": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/408" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/search/address/batch/{format}": { + "post": { + "description": "**Search Address Batch API**\n\n\n**Applies to**: S1 pricing tier.\n\n\n\nThe Search Address Batch API sends batches of queries to [Search Address API](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddress) using just a single API call. You can call Search Address Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running request. Here's a typical sequence of operations:\n1. Client sends a Search Address Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search address_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search address_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=400 Broad St, Seattle, WA 98109&limit=3\"},\n {\"query\": \"?query=One, Microsoft Way, Redmond, WA 98052&limit=3\"},\n {\"query\": \"?query=350 5th Ave, New York, NY 10118&limit=1\"},\n {\"query\": \"?query=Pike Pl, Seattle, WA 98101&lat=47.610970&lon=-122.342469&radius=1000\"},\n {\"query\": \"?query=Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France&limit=1\"}\n ]\n}\n```\n\nA _search address_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search address_ [URI parameters](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddress#uri-parameters). The string values in the _search address_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchCommonResponse`](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddress#SearchCommonResponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"one microsoft way redmond wa 98052\"\n },\n \"results\": [\n {\n \"position\": {\n \"lat\": 47.63989,\n \"lon\": -122.12509\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"pike pl seattle wa 98101\"\n },\n \"results\": [\n {\n \"position\": {\n \"lat\": 47.60963,\n \"lon\": -122.34215\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "operationId": "Search_PostSearchAddressBatch", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "An Address Geocoding Batch API call containing 5 Address Geocoding API queries": { + "$ref": "./examples/PostSearchAddressBatch.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SearchApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "searchAddressBatchRequestBody", + "in": "body", + "description": "The list of address geocoding queries/requests to process. The list can contain a max of 10,000 queries and must contain at least 1 query.", + "required": true, + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/BatchRequestBody" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchAddressBatchResponse" + } + }, + "202": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/202Async" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "description": "**Search Address Batch API**\n\n\n**Applies to**: S1 pricing tier.\n\n\n\nThe Search Address Batch API sends batches of queries to [Search Address API](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddress) using just a single API call. You can call Search Address Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running request. Here's a typical sequence of operations:\n1. Client sends a Search Address Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search address_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search address_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=400 Broad St, Seattle, WA 98109&limit=3\"},\n {\"query\": \"?query=One, Microsoft Way, Redmond, WA 98052&limit=3\"},\n {\"query\": \"?query=350 5th Ave, New York, NY 10118&limit=1\"},\n {\"query\": \"?query=Pike Pl, Seattle, WA 98101&lat=47.610970&lon=-122.342469&radius=1000\"},\n {\"query\": \"?query=Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France&limit=1\"}\n ]\n}\n```\n\nA _search address_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search address_ [URI parameters](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddress#uri-parameters). The string values in the _search address_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchCommonResponse`](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddress#SearchCommonResponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"one microsoft way redmond wa 98052\"\n },\n \"results\": [\n {\n \"position\": {\n \"lat\": 47.63989,\n \"lon\": -122.12509\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"pike pl seattle wa 98101\"\n },\n \"results\": [\n {\n \"position\": {\n \"lat\": 47.60963,\n \"lon\": -122.34215\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "operationId": "Search_GetSearchAddressBatch", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + }, + "x-ms-examples": { + "An Address Geocoding Batch API GET call containing 5 Address Geocoding API queries": { + "$ref": "./examples/GetSearchAddressBatch.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SearchApiVersion" + }, + { + "$ref": "#/parameters/BatchId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchAddressBatchResponse" + } + }, + "202": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/202Async" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/search/address/reverse/batch/sync/{format}": { + "post": { + "description": "**Search Address Reverse Batch API**\n\n\n**Applies to**: S1 pricing tier.\n\n\n\nThe Search Address Batch API sends batches of queries to [Search Address Reverse API](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddressreverse) using just a single API call. You can call Search Address Reverse Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/address/reverse/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running request. Here's a typical sequence of operations:\n1. Client sends a Search Address Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search address reverse_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search address reverse_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=48.858561,2.294911\"},\n {\"query\": \"?query=47.639765,-122.127896&radius=5000&limit=2\"},\n {\"query\": \"?query=47.621028,-122.348170\"},\n {\"query\": \"?query=43.722990,10.396695\"},\n {\"query\": \"?query=40.750958,-73.982336\"}\n ]\n}\n```\n\nA _search address reverse_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search address reverse_ [URI parameters](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddressreverse#uri-parameters). The string values in the _search address reverse_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchAddressReverseResponse`](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddressreverse#searchaddressreverseresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"queryTime\": 11\n },\n \"addresses\": [\n {\n \"address\": {\n \"country\": \"France\",\n \"freeformAddress\": \"Avenue Anatole France, 75007 Paris\"\n },\n \"position\": \"48.858490,2.294820\"\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"queryTime\": 1\n },\n \"addresses\": [\n {\n \"address\": {\n \"country\": \"United States of America\",\n \"freeformAddress\": \"157th Pl NE, Redmond WA 98052\"\n },\n \"position\": \"47.640470,-122.129430\"\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "operationId": "Search_PostSearchAddressReverseBatchSync", + "x-ms-examples": { + "A Reverse Geocoding Batch API Sync call containing 5 Reverse Geocoding API queries": { + "$ref": "./examples/PostSearchAddressReverseBatchSync.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SearchApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "searchAddressReverseBatchRequestBody", + "in": "body", + "description": "The list of reverse geocoding queries/requests to process. The list can contain a max of 10,000 queries and must contain at least 1 query.", + "required": true, + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/BatchRequestBody" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchAddressReverseBatchResponse" + } + }, + "408": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/408" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/search/address/reverse/batch/{format}": { + "post": { + "description": "**Search Address Reverse Batch API**\n\n\n**Applies to**: S1 pricing tier.\n\n\n\nThe Search Address Batch API sends batches of queries to [Search Address Reverse API](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddressreverse) using just a single API call. You can call Search Address Reverse Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/address/reverse/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running request. Here's a typical sequence of operations:\n1. Client sends a Search Address Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search address reverse_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search address reverse_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=48.858561,2.294911\"},\n {\"query\": \"?query=47.639765,-122.127896&radius=5000&limit=2\"},\n {\"query\": \"?query=47.621028,-122.348170\"},\n {\"query\": \"?query=43.722990,10.396695\"},\n {\"query\": \"?query=40.750958,-73.982336\"}\n ]\n}\n```\n\nA _search address reverse_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search address reverse_ [URI parameters](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddressreverse#uri-parameters). The string values in the _search address reverse_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchAddressReverseResponse`](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddressreverse#searchaddressreverseresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"queryTime\": 11\n },\n \"addresses\": [\n {\n \"address\": {\n \"country\": \"France\",\n \"freeformAddress\": \"Avenue Anatole France, 75007 Paris\"\n },\n \"position\": \"48.858490,2.294820\"\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"queryTime\": 1\n },\n \"addresses\": [\n {\n \"address\": {\n \"country\": \"United States of America\",\n \"freeformAddress\": \"157th Pl NE, Redmond WA 98052\"\n },\n \"position\": \"47.640470,-122.129430\"\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "operationId": "Search_PostSearchAddressReverseBatch", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "A Reverse Geocoding Batch API call containing 5 Reverse Geocoding API queries": { + "$ref": "./examples/PostSearchAddressReverseBatch.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SearchApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "searchAddressReverseBatchRequestBody", + "in": "body", + "description": "The list of reverse geocoding queries/requests to process. The list can contain a max of 10,000 queries and must contain at least 1 query.", + "required": true, + "schema": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/BatchRequestBody" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchAddressReverseBatchResponse" + } + }, + "202": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/202Async" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "description": "**Search Address Reverse Batch API**\n\n\n**Applies to**: S1 pricing tier.\n\n\n\nThe Search Address Batch API sends batches of queries to [Search Address Reverse API](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddressreverse) using just a single API call. You can call Search Address Reverse Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/address/reverse/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running request. Here's a typical sequence of operations:\n1. Client sends a Search Address Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search address reverse_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search address reverse_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=48.858561,2.294911\"},\n {\"query\": \"?query=47.639765,-122.127896&radius=5000&limit=2\"},\n {\"query\": \"?query=47.621028,-122.348170\"},\n {\"query\": \"?query=43.722990,10.396695\"},\n {\"query\": \"?query=40.750958,-73.982336\"}\n ]\n}\n```\n\nA _search address reverse_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search address reverse_ [URI parameters](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddressreverse#uri-parameters). The string values in the _search address reverse_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchAddressReverseResponse`](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddressreverse#searchaddressreverseresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"queryTime\": 11\n },\n \"addresses\": [\n {\n \"address\": {\n \"country\": \"France\",\n \"freeformAddress\": \"Avenue Anatole France, 75007 Paris\"\n },\n \"position\": \"48.858490,2.294820\"\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"queryTime\": 1\n },\n \"addresses\": [\n {\n \"address\": {\n \"country\": \"United States of America\",\n \"freeformAddress\": \"157th Pl NE, Redmond WA 98052\"\n },\n \"position\": \"47.640470,-122.129430\"\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "operationId": "Search_GetSearchAddressReverseBatch", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + }, + "x-ms-examples": { + "A Reverse Geocoding Batch API GET call containing 5 Reverse Geocoding API queries": { + "$ref": "./examples/GetSearchAddressReverseBatch.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SearchApiVersion" + }, + { + "$ref": "#/parameters/BatchId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchAddressReverseBatchResponse" + } + }, + "202": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/202Async" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + } + }, + "definitions": { + "SearchPolygonResponse": { + "description": "This object is returned from a successful Search Polygon call", + "type": "object", + "properties": { + "additionalData": { + "description": "Results array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchPolygonResult" + } + } + } + }, + "SearchPolygonResult": { + "type": "object", + "properties": { + "providerID": { + "description": "ID of the returned entity", + "type": "string", + "readOnly": true + }, + "error": { + "description": "Reason for the failure to obtain data for this provider.", + "type": "string", + "readOnly": true + }, + "geometryData": { + "description": "Geometry data in GeoJSON format. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946) for details. Present only if \"error\" is not present.", + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonObject" + } + } + }, + "SearchCommonResponse": { + "description": "This object is returned from a successful Search calls.", + "type": "object", + "properties": { + "summary": { + "description": "Summary object for a Search API response", + "readOnly": true, + "$ref": "#/definitions/SearchCommonSummary" + }, + "results": { + "description": "A list of Search API results.", + "type": "array", + "readOnly": true, + "items": { + "description": "This type represents the Search API result object.", + "readOnly": true, + "$ref": "#/definitions/SearchCommonResult" + } + } + } + }, + "SearchCommonSummary": { + "description": "Summary object for a Search API response.", + "type": "object", + "readOnly": true, + "properties": { + "query": { + "description": "Query property", + "type": "string", + "readOnly": true + }, + "queryType": { + "description": "QueryType property", + "type": "string", + "readOnly": true + }, + "queryTime": { + "description": "QueryTime property", + "type": "integer", + "readOnly": true + }, + "numResults": { + "description": "NumResults property", + "type": "integer", + "readOnly": true + }, + "limit": { + "description": "Maximum number of responses that will be returned", + "readOnly": true, + "type": "integer" + }, + "offset": { + "description": "Offset property", + "type": "integer", + "readOnly": true + }, + "totalResults": { + "description": "TotalResults property", + "type": "integer", + "readOnly": true + }, + "fuzzyLevel": { + "description": "FuzzyLevel property", + "type": "integer", + "readOnly": true + }, + "geoBias": { + "description": "Indication when the internal search engine has applied a geospatial bias to improve the ranking of results. In some methods, this can be affected by setting the lat and lon parameters where available. In other cases it is purely internal.", + "type": "object", + "readOnly": true, + "allOf": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/CoordinatesPairAbbreviated" + } + ] + } + } + }, + "SearchCommonResult": { + "description": "Result object for a Search API response.", + "type": "object", + "readOnly": true, + "properties": { + "type": { + "description": "One of:\n* POI\n* Street\n* Geography\n* Point Address\n* Address Range\n* Cross Street", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id property", + "type": "string", + "readOnly": true + }, + "score": { + "$ref": "#/definitions/SearchResultScore" + }, + "dist": { + "$ref": "#/definitions/SearchResultDistance" + }, + "info": { + "description": "Info property", + "type": "string", + "readOnly": true + }, + "entityType": { + "$ref": "#/definitions/EntityType" + }, + "poi": { + "$ref": "#/definitions/SearchResultPoi" + }, + "address": { + "$ref": "#/definitions/SearchResultAddress" + }, + "position": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/CoordinatesPairAbbreviated" + }, + "viewport": { + "$ref": "#/definitions/SearchResultViewport" + }, + "entryPoints": { + "description": "Entry Points array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchResultEntryPoint" + } + }, + "addressRanges": { + "$ref": "#/definitions/SearchResultAddressRanges" + }, + "dataSources": { + "$ref": "#/definitions/DataSources" + }, + "matchType": { + "type": "string", + "readOnly": true, + "description": "Information on the type of match.\n\nOne of:\n * AddressPoint\n * HouseNumberRange\n * Street" + }, + "detourTime": { + "description": "Detour time in seconds", + "type": "number", + "readOnly": true + } + } + }, + "SearchPoiCategoryTreeResponse": { + "description": "This object is returned from a successful POI Category Tree call", + "type": "object", + "properties": { + "poiCategories": { + "description": "Categories array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/PoiCategoryResult" + } + } + } + }, + "PoiCategoryResult": { + "description": "POI category result", + "type": "object", + "properties": { + "id": { + "description": "Unique ID for the category. ID can be used to restrict search results to specific categories through other Search Service APIs, like [Get Search POI](https://docs.microsoft.com/rest/api/maps/search/getsearchpoi).", + "type": "integer", + "readOnly": true + }, + "name": { + "description": "Name of the category", + "type": "string", + "readOnly": true + }, + "childCategoryIds": { + "description": "Array of child category ids", + "type": "array", + "items": { + "type": "integer", + "readOnly": true + }, + "readOnly": true + }, + "synonyms": { + "description": "Array of alternative names of the category", + "type": "array", + "items": { + "type": "string", + "readOnly": true + }, + "readOnly": true + } + } + }, + "SearchAddressReverseResponse": { + "description": "This object is returned from a successful Search Address Reverse call", + "type": "object", + "properties": { + "summary": { + "description": "Summary object for a Search Address Reverse response", + "readOnly": true, + "$ref": "#/definitions/SearchCommonSummary" + }, + "addresses": { + "description": "Addresses array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchAddressReverseResult" + } + } + } + }, + "SearchAddressReverseResult": { + "description": "Result object for a Search Address Reverse response", + "type": "object", + "properties": { + "address": { + "$ref": "#/definitions/SearchResultAddress" + }, + "position": { + "type": "string", + "readOnly": true, + "description": "Position property in the form of \"{latitude},{longitude}\"" + }, + "matchType": { + "type": "string", + "readOnly": true, + "description": "Information on the type of match.\n\nOne of:\n * AddressPoint\n * HouseNumberRange\n * Street" + } + } + }, + "SearchAddressReverseCrossStreetResponse": { + "description": "This object is returned from a successful Search Address Reverse CrossStreet call", + "type": "object", + "properties": { + "summary": { + "description": "Summary object for a Search Address Reverse Cross Street response", + "readOnly": true, + "$ref": "#/definitions/SearchCommonSummary" + }, + "addresses": { + "description": "Addresses array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchAddressReverseCrossStreetResult" + } + } + } + }, + "SearchAddressReverseCrossStreetResult": { + "description": "Result object for a Search Address Reverse Cross Street response", + "type": "object", + "properties": { + "address": { + "$ref": "#/definitions/SearchResultAddress" + }, + "position": { + "type": "string", + "readOnly": true, + "description": "Position property in the form of \"{latitude},{longitude}\"" + } + } + }, + "SearchInsideGeometryRequestBody": { + "description": "This type represents the request body for the Search Inside Geometry service.", + "type": "object", + "properties": { + "geometry": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonObject" + } + } + }, + "SearchAlongRouteRequestBody": { + "description": "This type represents the request body for the Search Along Route service.", + "type": "object", + "properties": { + "route": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonLineString" + } + } + }, + "SearchResultPoi": { + "description": "Details of the returned POI including information such as the name, phone, url address, and classifications.", + "type": "object", + "readOnly": true, + "properties": { + "name": { + "description": "Name of the POI property", + "type": "string", + "readOnly": true + }, + "phone": { + "description": "Telephone number property", + "type": "string", + "readOnly": true + }, + "url": { + "description": "Website URL property", + "type": "string", + "readOnly": true + }, + "categorySet": { + "description": "The list of the most specific POI categories", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchResultPoiCategorySet" + } + }, + "categories": { + "description": "__[Deprecated]__ Use classifications instead. Categories array", + "type": "array", + "readOnly": true, + "items": { + "type": "string", + "readOnly": true + } + }, + "classifications": { + "description": "Classification array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchResultPoiClassification" + } + }, + "brands": { + "description": "Brands array. The name of the brand for the POI being returned.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchResultPoiBrand" + } + }, + "openingHours": { + "$ref": "#/definitions/SearchResultPoiOpeningHours" + } + } + }, + "SearchResultPoiCategorySet": { + "description": "POI category", + "type": "object", + "properties": { + "id": { + "description": "Category ID", + "type": "integer", + "readOnly": true + } + } + }, + "SearchResultPoiClassification": { + "description": "The classification for the POI being returned", + "type": "object", + "properties": { + "code": { + "description": "Code property", + "type": "string", + "readOnly": true + }, + "names": { + "description": "Names array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchResultPoiClassificationName" + } + } + } + }, + "SearchResultPoiClassificationName": { + "description": "Name for the classification", + "type": "object", + "properties": { + "nameLocale": { + "description": "Name Locale property", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name property", + "type": "string", + "readOnly": true + } + } + }, + "SearchResultPoiOpeningHours": { + "description": "Opening hours for a POI (Points of Interest).", + "type": "object", + "properties": { + "mode": { + "description": "Value used in the Request", + "type": "string", + "readOnly": true + }, + "timeRanges": { + "description": "List of time ranges for the next 7 days", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchResultPoiOpeningHoursTimeRange" + } + } + } + }, + "SearchResultPoiOpeningHoursTimeRange": { + "description": "Open time range for a day", + "type": "object", + "properties": { + "startTime": { + "description": "The point in the next 7 days range when a given POI is being opened, or the beginning of the range if it was opened before the range.", + "$ref": "#/definitions/SearchResultPoiOpeningHoursTimeRangeTime" + }, + "endTime": { + "description": "The point in the next 7 days range when a given POI is being closed, or the beginning of the range if it was closed before the range.", + "$ref": "#/definitions/SearchResultPoiOpeningHoursTimeRangeTime" + } + } + }, + "SearchResultPoiOpeningHoursTimeRangeTime": { + "description": "Represents a date and time", + "type": "object", + "properties": { + "date": { + "description": "Represents current day in calendar year in POI time zone.", + "type": "string", + "readOnly": true + }, + "hour": { + "description": "Hours are in the 24 hour format in the local time of a POI; possible values are 0 - 23.", + "type": "integer", + "readOnly": true + }, + "minute": { + "description": "Minutes are in the local time of a POI; possible values are 0 - 59.", + "type": "integer", + "readOnly": true + } + } + }, + "SearchResultPoiBrand": { + "description": "The name of the brand for the POI being returned", + "type": "object", + "properties": { + "name": { + "description": "Name of the brand", + "type": "string", + "readOnly": true + } + } + }, + "SearchResultAddress": { + "description": "The address of the result", + "type": "object", + "readOnly": true, + "properties": { + "buildingNumber": { + "description": "Building Number property", + "type": "string", + "readOnly": true + }, + "street": { + "description": "Street property", + "type": "string", + "readOnly": true + }, + "crossStreet": { + "description": "Cross Street property", + "type": "string", + "readOnly": true + }, + "streetNumber": { + "description": "Street Number property", + "type": "string", + "readOnly": true + }, + "routeNumbers": { + "description": "number of routes", + "type": "array", + "items": { + "type": "integer", + "readOnly": true + }, + "readOnly": true + }, + "streetName": { + "description": "Street Name property", + "type": "string", + "readOnly": true + }, + "streetNameAndNumber": { + "description": "Street Name and Number property", + "type": "string", + "readOnly": true + }, + "municipality": { + "description": "Municipality property", + "type": "string", + "readOnly": true + }, + "municipalitySubdivision": { + "description": "Municipality Subdivision property", + "type": "string", + "readOnly": true + }, + "countryTertiarySubdivision": { + "description": "Country Tertiary Subdivision property", + "type": "string", + "readOnly": true + }, + "countrySecondarySubdivision": { + "description": "Country Secondary Subdivision property", + "type": "string", + "readOnly": true + }, + "countrySubdivision": { + "description": "Country Subdivision property", + "type": "string", + "readOnly": true + }, + "postalCode": { + "description": "Postal Code property", + "type": "string", + "readOnly": true + }, + "extendedPostalCode": { + "description": "Extended Postal Code property", + "type": "string", + "readOnly": true + }, + "countryCode": { + "description": "Country Code property", + "type": "string", + "readOnly": true + }, + "country": { + "description": "Country property", + "type": "string", + "readOnly": true + }, + "countryCodeISO3": { + "description": "Country Code ISO3 property", + "type": "string", + "readOnly": true + }, + "freeformAddress": { + "description": "Free form Address property", + "type": "string", + "readOnly": true + }, + "countrySubdivisionName": { + "description": "Country Subdivision Name property", + "type": "string", + "readOnly": true + }, + "localName": { + "description": "An address component which represents the name of a geographic area or locality that groups a number of addressable objects for addressing purposes, without being an administrative unit. This field is used to build the `freeformAddress` property.", + "type": "string", + "readOnly": true + }, + "boundingBox": { + "description": "Bounding box coordinates.", + "type": "object", + "readOnly": true + } + } + }, + "SearchResultViewport": { + "description": "The viewport that covers the result represented by the top-left and bottom-right coordinates of the viewport.", + "type": "object", + "readOnly": true, + "properties": { + "topLeftPoint": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/CoordinatesPairAbbreviated" + }, + "btmRightPoint": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/CoordinatesPairAbbreviated" + } + } + }, + "SearchResultEntryPoint": { + "description": "The entry point for the POI being returned.", + "type": "object", + "readOnly": true, + "properties": { + "type": { + "description": "The type of entry point. Value can be either _main_ or _minor_.", + "type": "string", + "readOnly": true, + "enum": [ + "main", + "minor" + ], + "x-ms-enum": { + "name": "EntryPointType", + "modelAsString": true + } + }, + "position": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/CoordinatesPairAbbreviated" + } + } + }, + "SearchResultAddressRanges": { + "description": "Describes the address range on both sides of the street for a search result. Coordinates for the start and end locations of the address range are included.", + "type": "object", + "readOnly": true, + "properties": { + "rangeLeft": { + "description": "Address range on the left side of the street.", + "type": "string" + }, + "rangeRight": { + "description": "Address range on the right side of the street.", + "type": "string" + }, + "from": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/CoordinatesPairAbbreviated" + }, + "to": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/CoordinatesPairAbbreviated" + } + } + }, + "SearchResultScore": { + "description": "The value within a result set to indicate the relative matching score between results. You can use this to determine that result x is twice as likely to be as relevant as result y if the value of x is 2x the value of y. The values vary between queries and is only meant as a relative value for one result set.", + "type": "number", + "readOnly": true + }, + "SearchResultDistance": { + "description": "Straight line distance between the result and geobias location in meters.", + "type": "number", + "readOnly": true + }, + "SearchSummaryGeoBias": { + "description": "Indication when the internal search engine has applied a geospatial bias to improve the ranking of results. In some methods, this can be affected by setting the lat and lon parameters where available. In other cases it is purely internal.", + "type": "object", + "readOnly": true, + "properties": { + "lat": { + "description": "Latitude property", + "type": "number", + "readOnly": true + }, + "lon": { + "description": "Longitude property", + "type": "number", + "readOnly": true + } + } + }, + "DataSources": { + "description": "Optional section. Reference ids for use with the [Get Search Polygon](https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon) API.", + "type": "object", + "readOnly": true, + "properties": { + "geometry": { + "$ref": "#/definitions/DataSourcesGeometry" + } + } + }, + "DataSourcesGeometry": { + "description": "Information about the geometric shape of the result. Only present if type == Geography.", + "type": "object", + "properties": { + "id": { + "description": "Pass this as geometryId to the [Get Search Polygon](https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon) API to fetch geometry information for this result.", + "type": "string", + "readOnly": true + } + } + }, + "EntityType": { + "description": "Geography entity type. Present only when entityType was requested and is available.", + "type": "string", + "readOnly": true, + "enum": [ + "Country", + "CountrySubdivision", + "CountrySecondarySubdivision", + "CountryTertiarySubdivision", + "Municipality", + "MunicipalitySubdivision", + "Neighbourhood", + "PostalCodeArea" + ], + "x-ms-enum": { + "name": "EntityType", + "modelAsString": true, + "values": [ + { + "value": "Country", + "description": "Country name" + }, + { + "value": "CountrySubdivision", + "description": "State or Province" + }, + { + "value": "CountrySecondarySubdivision", + "description": "County" + }, + { + "value": "CountryTertiarySubdivision", + "description": "Named Area" + }, + { + "value": "Municipality", + "description": "City / Town" + }, + { + "value": "MunicipalitySubdivision", + "description": "Sub / Super City" + }, + { + "value": "Neighbourhood", + "description": "Neighbourhood" + }, + { + "value": "PostalCodeArea", + "description": "Postal Code / Zip Code" + } + ] + } + }, + "SearchFuzzyBatchResponse": { + "description": "This object is returned from a successful Search Fuzzy Batch service call.", + "type": "object", + "allOf": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/BatchResponse" + } + ], + "properties": { + "batchItems": { + "description": "Array containing the batch results.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchFuzzyBatchItem" + } + } + } + }, + "SearchFuzzyBatchItem": { + "description": "An item returned from Search Fuzzy Batch service call.", + "type": "object", + "allOf": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/BatchItem" + } + ], + "properties": { + "response": { + "description": "The result of the query. SearchCommonResponse if the query completed successfully, ErrorResponse otherwise.", + "type": "object", + "readOnly": true, + "allOf": [ + { + "$ref": "#/definitions/SearchCommonResponse" + }, + { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + ] + } + } + }, + "SearchAddressBatchResponse": { + "description": "This object is returned from a successful Search Address Batch service call.", + "type": "object", + "allOf": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/BatchResponse" + } + ], + "properties": { + "batchItems": { + "description": "Array containing the batch results.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchAddressBatchItem" + } + } + } + }, + "SearchAddressBatchItem": { + "description": "An item returned from Search Address Batch service call.", + "type": "object", + "allOf": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/BatchItem" + } + ], + "properties": { + "response": { + "description": "The result of the query. SearchCommonResponse if the query completed successfully, ErrorResponse otherwise.", + "type": "object", + "readOnly": true, + "allOf": [ + { + "$ref": "#/definitions/SearchCommonResponse" + }, + { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + ] + } + } + }, + "SearchAddressReverseBatchResponse": { + "description": "This object is returned from a successful Search Address Reverse Batch service call.", + "type": "object", + "allOf": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/BatchResponse" + } + ], + "properties": { + "batchItems": { + "description": "Array containing the batch results.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchAddressReverseBatchItem" + } + } + } + }, + "SearchAddressReverseBatchItem": { + "description": "An item returned from Search Address Reverse Batch service call.", + "type": "object", + "allOf": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/BatchItem" + } + ], + "properties": { + "response": { + "description": "The result of the query. SearchAddressReverseResponse if the query completed successfully, ErrorResponse otherwise.", + "type": "object", + "readOnly": true, + "allOf": [ + { + "$ref": "#/definitions/SearchAddressReverseResponse" + }, + { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + ] + } + } + } + } +} diff --git a/specification/maps/data-plane/Search/readme.csharp.md b/specification/maps/data-plane/Search/readme.csharp.md new file mode 100644 index 000000000000..1893f54f0cdd --- /dev/null +++ b/specification/maps/data-plane/Search/readme.csharp.md @@ -0,0 +1,13 @@ +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +sync-methods: None +license-header: MICROSOFT_MIT_NO_VERSION +namespace: Azure.Maps.Search +output-folder: $(csharp-sdks-folder)/maps/Azure.Maps.Search/src/Generated +clear-output-folder: true +public-clients: true +``` \ No newline at end of file diff --git a/specification/maps/data-plane/Search/readme.go.md b/specification/maps/data-plane/Search/readme.go.md new file mode 100644 index 000000000000..14043c84447e --- /dev/null +++ b/specification/maps/data-plane/Search/readme.go.md @@ -0,0 +1,26 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +license-header: MICROSOFT_MIT_NO_VERSION +namespace: search +clear-output-folder: true +export-clients: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: 1.0-preview +``` + +### Tag: 1.0-preview and go + +These settings apply only when `--tag=1.0-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == '1.0-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/maps/1.0/$(namespace) +``` \ No newline at end of file diff --git a/specification/maps/data-plane/Search/readme.java.md b/specification/maps/data-plane/Search/readme.java.md new file mode 100644 index 000000000000..1c7182d89c56 --- /dev/null +++ b/specification/maps/data-plane/Search/readme.java.md @@ -0,0 +1,9 @@ +## Java + +``` yaml $(java) +java: + namespace: com.azure.maps.search + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 0 + output-folder: $(azure-libraries-for-java-folder)/azure-maps-search +``` \ No newline at end of file diff --git a/specification/maps/data-plane/Search/readme.md b/specification/maps/data-plane/Search/readme.md new file mode 100644 index 000000000000..a2cfe6b0f075 --- /dev/null +++ b/specification/maps/data-plane/Search/readme.md @@ -0,0 +1,89 @@ +# Azure Search + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Search Client + +--- + +## Getting Started + +To build the SDK for Search, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +### Basic Information + +These are the global settings for Search Client. + +``` yaml +title: SearchClient +openapi-type: data-plane +tag: 1.0-preview +# at some point those credentials will move away to Swagger according to [this](https://github.com/Azure/autorest/issues/3718) +add-credentials: true +credential-default-policy-type: BearerTokenCredentialPolicy +credential-scopes: https://atlas.microsoft.com/.default +``` + + +### Tag: 1.0-preview + +These settings apply only when `--tag=1.0-preview` is specified on the command line. + +``` yaml $(tag) == '1.0-preview' +input-file: + - preview/1.0/search.json +``` + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-java + + #track1 doesn't support data-plane for go + #manually generate for now with track2 + #- repo: azure-sdk-for-go + + #track1 doesn't support features needed for typescript + #manually generate for now with track2 + #- repo: azure-sdk-for-js + + #should be azure-sdk-for-net-track2, but SDK has not yet onboarded + #manually generate for now with track2 + - repo: azure-sdk-for-net +``` +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Java + +See configuration in [readme.java.md](./readme.java.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) diff --git a/specification/maps/data-plane/Search/readme.python.md b/specification/maps/data-plane/Search/readme.python.md new file mode 100644 index 000000000000..eff0dc04110c --- /dev/null +++ b/specification/maps/data-plane/Search/readme.python.md @@ -0,0 +1,22 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +license-header: MICROSOFT_MIT_NO_VERSION +namespace: azure.maps.search +package-name: azure-maps-search +package-version: 1.0-preview +clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +no-namespace-folders: true +output-folder: $(python-sdks-folder)/maps/azure-maps-search/azure/maps/search +``` +``` yaml $(python) && $(python-mode) == 'create' +basic-setup-py: true +output-folder: $(python-sdks-folder)/maps/azure-maps-search +``` diff --git a/specification/maps/data-plane/Search/readme.typescript.md b/specification/maps/data-plane/Search/readme.typescript.md new file mode 100644 index 000000000000..e4651762495b --- /dev/null +++ b/specification/maps/data-plane/Search/readme.typescript.md @@ -0,0 +1,29 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +azure-arm: false +package-name: "@azure/maps-search" +license-header: MICROSOFT_MIT_NO_VERSION +output-folder: "$(typescript-sdks-folder)/sdk/maps/maps-search" +source-code-folder-path: "" +clear-output-folder: false +generate-metadata: false +directive: + - from: search.json + where: $.definitions.SearchInsideGeometryRequestBody.properties.geometry + transform: > + $ = { + "description": "A valid `GeoJSON` object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3) for details.", + "type": "object" + }; + reason: Autorest TS codegen does not deserialize array of base class objects as an operation parameter properly -> https://github.com/Azure/autorest.typescript/issues/1040 + - remove-operation: Search_GetSearchFuzzyBatch + reason: This operation is created for Java SDK that has no LRO poller implementation + - remove-operation: Search_GetSearchAddressBatch + reason: This operation is created for Java SDK that has no LRO poller implementation + - remove-operation: Search_GetSearchAddressReverseBatch + reason: This operation is created for Java SDK that has no LRO poller implementation +``` diff --git a/specification/maps/data-plane/Timezone/preview/1.0/examples/GetTimezoneByCoordinates.json b/specification/maps/data-plane/Timezone/preview/1.0/examples/GetTimezoneByCoordinates.json new file mode 100644 index 000000000000..64063ac8ceee --- /dev/null +++ b/specification/maps/data-plane/Timezone/preview/1.0/examples/GetTimezoneByCoordinates.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "query": "47.0,-122", + "options": "all" + }, + "responses": { + "200": { + "body": { + "Version": "2019a", + "ReferenceUtcTimestamp": "2019-06-17T22:16:59.0765556Z", + "TimeZones": [ + { + "Id": "America/Los_Angeles", + "Aliases": [ + "US/Pacific", + "US/Pacific-New" + ], + "Countries": [ + { + "Name": "United States", + "Code": "US" + } + ], + "Names": { + "ISO6391LanguageCode": "en", + "Generic": "Pacific Time", + "Standard": "Pacific Standard Time", + "Daylight": "Pacific Daylight Time" + }, + "ReferenceTime": { + "Tag": "PDT", + "StandardOffset": "-08:00:00", + "DaylightSavings": "01:00:00", + "WallTime": "2019-06-17T15:16:59.0765556-07:00", + "PosixTzValidYear": 2019, + "PosixTz": "PST+8PDT,M3.2.0,M11.1.0", + "Sunrise": "2019-06-17T05:12:21.267-07:00", + "Sunset": "2019-06-17T21:05:18.017-07:00" + }, + "RepresentativePoint": { + "Latitude": 34.05222222222222, + "Longitude": -118.24277777777777 + }, + "TimeTransitions": [ + { + "Tag": "PDT", + "StandardOffset": "-08:00:00", + "DaylightSavings": "01:00:00", + "UtcStart": "2019-03-10T10:00:00Z", + "UtcEnd": "2019-11-03T09:00:00Z" + }, + { + "Tag": "PST", + "StandardOffset": "-08:00:00", + "DaylightSavings": "00:00:00", + "UtcStart": "2019-11-03T09:00:00Z", + "UtcEnd": "2020-03-08T10:00:00Z" + }, + { + "Tag": "PDT", + "StandardOffset": "-08:00:00", + "DaylightSavings": "01:00:00", + "UtcStart": "2020-03-08T10:00:00Z", + "UtcEnd": "2020-11-01T09:00:00Z" + } + ] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Timezone/preview/1.0/examples/GetTimezoneByID.json b/specification/maps/data-plane/Timezone/preview/1.0/examples/GetTimezoneByID.json new file mode 100644 index 000000000000..fbf24ec6e0dc --- /dev/null +++ b/specification/maps/data-plane/Timezone/preview/1.0/examples/GetTimezoneByID.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "query": "Asia/Bahrain", + "options": "all" + }, + "responses": { + "200": { + "body": { + "Version": "2018c", + "ReferenceUtcTimestamp": "2018-01-31T00:03:15.1349348Z", + "TimeZones": [ + { + "Id": "Asia/Qatar", + "Aliases": [ + "Asia/Bahrain" + ], + "Countries": [ + { + "Name": "Qatar", + "Code": "QA" + }, + { + "Name": "Bahrain", + "Code": "BH" + } + ], + "Names": { + "ISO6391LanguageCode": "en", + "Generic": "Arabian Time", + "Standard": "Arabian Standard Time", + "Daylight": "Arabian Daylight Time" + }, + "ReferenceTime": { + "Tag": "+03", + "StandardOffset": "03:00:00", + "DaylightSavings": "00:00:00", + "WallTime": "2018-01-31T03:03:15.1349348+03:00", + "PosixTzValidYear": 2018, + "PosixTz": "<+03>-3" + }, + "RepresentativePoint": { + "Latitude": 25.283333333333335, + "Longitude": 51.533333333333331 + }, + "TimeTransitions": [ + { + "Tag": "+03", + "StandardOffset": "03:00:00", + "DaylightSavings": "00:00:00", + "UtcStart": "1972-05-31T20:00:00Z", + "UtcEnd": "9999-12-31T23:59:59.9999999Z" + } + ] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Timezone/preview/1.0/examples/GetTimezoneEnumIANA.json b/specification/maps/data-plane/Timezone/preview/1.0/examples/GetTimezoneEnumIANA.json new file mode 100644 index 000000000000..ef36fd99830d --- /dev/null +++ b/specification/maps/data-plane/Timezone/preview/1.0/examples/GetTimezoneEnumIANA.json @@ -0,0 +1,3186 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0" + }, + "responses": { + "200": { + "body": [ + { + "id": "Africa/Bamako", + "isAlias": true, + "aliasOf": "Africa/Abidjan", + "hasZone1970Location": true + }, + { + "id": "Africa/Banjul", + "isAlias": true, + "aliasOf": "Africa/Abidjan", + "hasZone1970Location": true + }, + { + "id": "Africa/Conakry", + "isAlias": true, + "aliasOf": "Africa/Abidjan", + "hasZone1970Location": true + }, + { + "id": "Africa/Dakar", + "isAlias": true, + "aliasOf": "Africa/Abidjan", + "hasZone1970Location": true + }, + { + "id": "Africa/Freetown", + "isAlias": true, + "aliasOf": "Africa/Abidjan", + "hasZone1970Location": true + }, + { + "id": "Africa/Lome", + "isAlias": true, + "aliasOf": "Africa/Abidjan", + "hasZone1970Location": true + }, + { + "id": "Africa/Nouakchott", + "isAlias": true, + "aliasOf": "Africa/Abidjan", + "hasZone1970Location": true + }, + { + "id": "Africa/Ouagadougou", + "isAlias": true, + "aliasOf": "Africa/Abidjan", + "hasZone1970Location": true + }, + { + "id": "Africa/Sao_Tome", + "isAlias": true, + "aliasOf": "Africa/Abidjan", + "hasZone1970Location": true + }, + { + "id": "Atlantic/St_Helena", + "isAlias": true, + "aliasOf": "Africa/Abidjan", + "hasZone1970Location": true + }, + { + "id": "Africa/Addis_Ababa", + "isAlias": true, + "aliasOf": "Africa/Nairobi", + "hasZone1970Location": true + }, + { + "id": "Africa/Asmara", + "isAlias": true, + "aliasOf": "Africa/Nairobi", + "hasZone1970Location": true + }, + { + "id": "Africa/Dar_es_Salaam", + "isAlias": true, + "aliasOf": "Africa/Nairobi", + "hasZone1970Location": true + }, + { + "id": "Africa/Djibouti", + "isAlias": true, + "aliasOf": "Africa/Nairobi", + "hasZone1970Location": true + }, + { + "id": "Africa/Kampala", + "isAlias": true, + "aliasOf": "Africa/Nairobi", + "hasZone1970Location": true + }, + { + "id": "Africa/Mogadishu", + "isAlias": true, + "aliasOf": "Africa/Nairobi", + "hasZone1970Location": true + }, + { + "id": "Indian/Antananarivo", + "isAlias": true, + "aliasOf": "Africa/Nairobi", + "hasZone1970Location": true + }, + { + "id": "Indian/Comoro", + "isAlias": true, + "aliasOf": "Africa/Nairobi", + "hasZone1970Location": true + }, + { + "id": "Indian/Mayotte", + "isAlias": true, + "aliasOf": "Africa/Nairobi", + "hasZone1970Location": true + }, + { + "id": "Africa/Blantyre", + "isAlias": true, + "aliasOf": "Africa/Maputo", + "hasZone1970Location": true + }, + { + "id": "Africa/Bujumbura", + "isAlias": true, + "aliasOf": "Africa/Maputo", + "hasZone1970Location": true + }, + { + "id": "Africa/Gaborone", + "isAlias": true, + "aliasOf": "Africa/Maputo", + "hasZone1970Location": true + }, + { + "id": "Africa/Harare", + "isAlias": true, + "aliasOf": "Africa/Maputo", + "hasZone1970Location": true + }, + { + "id": "Africa/Kigali", + "isAlias": true, + "aliasOf": "Africa/Maputo", + "hasZone1970Location": true + }, + { + "id": "Africa/Lubumbashi", + "isAlias": true, + "aliasOf": "Africa/Maputo", + "hasZone1970Location": true + }, + { + "id": "Africa/Lusaka", + "isAlias": true, + "aliasOf": "Africa/Maputo", + "hasZone1970Location": true + }, + { + "id": "Africa/Bangui", + "isAlias": true, + "aliasOf": "Africa/Lagos", + "hasZone1970Location": true + }, + { + "id": "Africa/Brazzaville", + "isAlias": true, + "aliasOf": "Africa/Lagos", + "hasZone1970Location": true + }, + { + "id": "Africa/Douala", + "isAlias": true, + "aliasOf": "Africa/Lagos", + "hasZone1970Location": true + }, + { + "id": "Africa/Kinshasa", + "isAlias": true, + "aliasOf": "Africa/Lagos", + "hasZone1970Location": true + }, + { + "id": "Africa/Libreville", + "isAlias": true, + "aliasOf": "Africa/Lagos", + "hasZone1970Location": true + }, + { + "id": "Africa/Luanda", + "isAlias": true, + "aliasOf": "Africa/Lagos", + "hasZone1970Location": true + }, + { + "id": "Africa/Malabo", + "isAlias": true, + "aliasOf": "Africa/Lagos", + "hasZone1970Location": true + }, + { + "id": "Africa/Niamey", + "isAlias": true, + "aliasOf": "Africa/Lagos", + "hasZone1970Location": true + }, + { + "id": "Africa/Porto-Novo", + "isAlias": true, + "aliasOf": "Africa/Lagos", + "hasZone1970Location": true + }, + { + "id": "Africa/Maseru", + "isAlias": true, + "aliasOf": "Africa/Johannesburg", + "hasZone1970Location": true + }, + { + "id": "Africa/Mbabane", + "isAlias": true, + "aliasOf": "Africa/Johannesburg", + "hasZone1970Location": true + }, + { + "id": "Africa/Juba", + "isAlias": true, + "aliasOf": "Africa/Khartoum", + "hasZone1970Location": true + }, + { + "id": "Europe/Nicosia", + "isAlias": true, + "aliasOf": "Asia/Nicosia", + "hasZone1970Location": true + }, + { + "id": "Asia/Bahrain", + "isAlias": true, + "aliasOf": "Asia/Qatar", + "hasZone1970Location": true + }, + { + "id": "Asia/Aden", + "isAlias": true, + "aliasOf": "Asia/Riyadh", + "hasZone1970Location": true + }, + { + "id": "Asia/Kuwait", + "isAlias": true, + "aliasOf": "Asia/Riyadh", + "hasZone1970Location": true + }, + { + "id": "Asia/Phnom_Penh", + "isAlias": true, + "aliasOf": "Asia/Bangkok", + "hasZone1970Location": true + }, + { + "id": "Asia/Vientiane", + "isAlias": true, + "aliasOf": "Asia/Bangkok", + "hasZone1970Location": true + }, + { + "id": "Asia/Muscat", + "isAlias": true, + "aliasOf": "Asia/Dubai", + "hasZone1970Location": true + }, + { + "id": "Pacific/Saipan", + "isAlias": true, + "aliasOf": "Pacific/Guam", + "hasZone1970Location": true + }, + { + "id": "Antarctica/McMurdo", + "isAlias": true, + "aliasOf": "Pacific/Auckland", + "hasZone1970Location": true + }, + { + "id": "Pacific/Midway", + "isAlias": true, + "aliasOf": "Pacific/Pago_Pago", + "hasZone1970Location": true + }, + { + "id": "Europe/Jersey", + "isAlias": true, + "aliasOf": "Europe/London", + "hasZone1970Location": true + }, + { + "id": "Europe/Guernsey", + "isAlias": true, + "aliasOf": "Europe/London", + "hasZone1970Location": true + }, + { + "id": "Europe/Isle_of_Man", + "isAlias": true, + "aliasOf": "Europe/London", + "hasZone1970Location": true + }, + { + "id": "Europe/Mariehamn", + "isAlias": true, + "aliasOf": "Europe/Helsinki", + "hasZone1970Location": true + }, + { + "id": "Europe/Busingen", + "isAlias": true, + "aliasOf": "Europe/Zurich", + "hasZone1970Location": true + }, + { + "id": "Europe/Vatican", + "isAlias": true, + "aliasOf": "Europe/Rome", + "hasZone1970Location": true + }, + { + "id": "Europe/San_Marino", + "isAlias": true, + "aliasOf": "Europe/Rome", + "hasZone1970Location": true + }, + { + "id": "Europe/Vaduz", + "isAlias": true, + "aliasOf": "Europe/Zurich", + "hasZone1970Location": true + }, + { + "id": "Arctic/Longyearbyen", + "isAlias": true, + "aliasOf": "Europe/Oslo", + "hasZone1970Location": true + }, + { + "id": "Europe/Ljubljana", + "isAlias": true, + "aliasOf": "Europe/Belgrade", + "hasZone1970Location": true + }, + { + "id": "Europe/Podgorica", + "isAlias": true, + "aliasOf": "Europe/Belgrade", + "hasZone1970Location": true + }, + { + "id": "Europe/Sarajevo", + "isAlias": true, + "aliasOf": "Europe/Belgrade", + "hasZone1970Location": true + }, + { + "id": "Europe/Skopje", + "isAlias": true, + "aliasOf": "Europe/Belgrade", + "hasZone1970Location": true + }, + { + "id": "Europe/Zagreb", + "isAlias": true, + "aliasOf": "Europe/Belgrade", + "hasZone1970Location": true + }, + { + "id": "Europe/Bratislava", + "isAlias": true, + "aliasOf": "Europe/Prague", + "hasZone1970Location": true + }, + { + "id": "Asia/Istanbul", + "isAlias": true, + "aliasOf": "Europe/Istanbul", + "hasZone1970Location": true + }, + { + "id": "America/Cayman", + "isAlias": true, + "aliasOf": "America/Panama", + "hasZone1970Location": true + }, + { + "id": "America/Aruba", + "isAlias": true, + "aliasOf": "America/Curacao", + "hasZone1970Location": true + }, + { + "id": "America/Lower_Princes", + "isAlias": true, + "aliasOf": "America/Curacao", + "hasZone1970Location": true + }, + { + "id": "America/Kralendijk", + "isAlias": true, + "aliasOf": "America/Curacao", + "hasZone1970Location": true + }, + { + "id": "America/Anguilla", + "isAlias": true, + "aliasOf": "America/Port_of_Spain", + "hasZone1970Location": true + }, + { + "id": "America/Antigua", + "isAlias": true, + "aliasOf": "America/Port_of_Spain", + "hasZone1970Location": true + }, + { + "id": "America/Dominica", + "isAlias": true, + "aliasOf": "America/Port_of_Spain", + "hasZone1970Location": true + }, + { + "id": "America/Grenada", + "isAlias": true, + "aliasOf": "America/Port_of_Spain", + "hasZone1970Location": true + }, + { + "id": "America/Guadeloupe", + "isAlias": true, + "aliasOf": "America/Port_of_Spain", + "hasZone1970Location": true + }, + { + "id": "America/Marigot", + "isAlias": true, + "aliasOf": "America/Port_of_Spain", + "hasZone1970Location": true + }, + { + "id": "America/Montserrat", + "isAlias": true, + "aliasOf": "America/Port_of_Spain", + "hasZone1970Location": true + }, + { + "id": "America/St_Barthelemy", + "isAlias": true, + "aliasOf": "America/Port_of_Spain", + "hasZone1970Location": true + }, + { + "id": "America/St_Kitts", + "isAlias": true, + "aliasOf": "America/Port_of_Spain", + "hasZone1970Location": true + }, + { + "id": "America/St_Lucia", + "isAlias": true, + "aliasOf": "America/Port_of_Spain", + "hasZone1970Location": true + }, + { + "id": "America/St_Thomas", + "isAlias": true, + "aliasOf": "America/Port_of_Spain", + "hasZone1970Location": true + }, + { + "id": "America/St_Vincent", + "isAlias": true, + "aliasOf": "America/Port_of_Spain", + "hasZone1970Location": true + }, + { + "id": "America/Tortola", + "isAlias": true, + "aliasOf": "America/Port_of_Spain", + "hasZone1970Location": true + }, + { + "id": "US/Pacific-New", + "isAlias": true, + "aliasOf": "America/Los_Angeles", + "hasZone1970Location": true + }, + { + "id": "GMT", + "isAlias": true, + "aliasOf": "Etc/GMT", + "hasZone1970Location": false + }, + { + "id": "Etc/Universal", + "isAlias": true, + "aliasOf": "Etc/UTC", + "hasZone1970Location": false + }, + { + "id": "Etc/Zulu", + "isAlias": true, + "aliasOf": "Etc/UTC", + "hasZone1970Location": false + }, + { + "id": "Etc/Greenwich", + "isAlias": true, + "aliasOf": "Etc/GMT", + "hasZone1970Location": false + }, + { + "id": "Etc/GMT-0", + "isAlias": true, + "aliasOf": "Etc/GMT", + "hasZone1970Location": false + }, + { + "id": "Etc/GMT+0", + "isAlias": true, + "aliasOf": "Etc/GMT", + "hasZone1970Location": false + }, + { + "id": "Etc/GMT0", + "isAlias": true, + "aliasOf": "Etc/GMT", + "hasZone1970Location": false + }, + { + "id": "Africa/Asmera", + "isAlias": true, + "aliasOf": "Africa/Nairobi", + "hasZone1970Location": true + }, + { + "id": "Africa/Timbuktu", + "isAlias": true, + "aliasOf": "Africa/Abidjan", + "hasZone1970Location": true + }, + { + "id": "America/Argentina/ComodRivadavia", + "isAlias": true, + "aliasOf": "America/Argentina/Catamarca", + "hasZone1970Location": true + }, + { + "id": "America/Atka", + "isAlias": true, + "aliasOf": "America/Adak", + "hasZone1970Location": true + }, + { + "id": "America/Buenos_Aires", + "isAlias": true, + "aliasOf": "America/Argentina/Buenos_Aires", + "hasZone1970Location": true + }, + { + "id": "America/Catamarca", + "isAlias": true, + "aliasOf": "America/Argentina/Catamarca", + "hasZone1970Location": true + }, + { + "id": "America/Coral_Harbour", + "isAlias": true, + "aliasOf": "America/Atikokan", + "hasZone1970Location": true + }, + { + "id": "America/Cordoba", + "isAlias": true, + "aliasOf": "America/Argentina/Cordoba", + "hasZone1970Location": true + }, + { + "id": "America/Ensenada", + "isAlias": true, + "aliasOf": "America/Tijuana", + "hasZone1970Location": true + }, + { + "id": "America/Fort_Wayne", + "isAlias": true, + "aliasOf": "America/Indiana/Indianapolis", + "hasZone1970Location": true + }, + { + "id": "America/Indianapolis", + "isAlias": true, + "aliasOf": "America/Indiana/Indianapolis", + "hasZone1970Location": true + }, + { + "id": "America/Jujuy", + "isAlias": true, + "aliasOf": "America/Argentina/Jujuy", + "hasZone1970Location": true + }, + { + "id": "America/Knox_IN", + "isAlias": true, + "aliasOf": "America/Indiana/Knox", + "hasZone1970Location": true + }, + { + "id": "America/Louisville", + "isAlias": true, + "aliasOf": "America/Kentucky/Louisville", + "hasZone1970Location": true + }, + { + "id": "America/Mendoza", + "isAlias": true, + "aliasOf": "America/Argentina/Mendoza", + "hasZone1970Location": true + }, + { + "id": "America/Montreal", + "isAlias": true, + "aliasOf": "America/Toronto", + "hasZone1970Location": true + }, + { + "id": "America/Porto_Acre", + "isAlias": true, + "aliasOf": "America/Rio_Branco", + "hasZone1970Location": true + }, + { + "id": "America/Rosario", + "isAlias": true, + "aliasOf": "America/Argentina/Cordoba", + "hasZone1970Location": true + }, + { + "id": "America/Santa_Isabel", + "isAlias": true, + "aliasOf": "America/Tijuana", + "hasZone1970Location": true + }, + { + "id": "America/Shiprock", + "isAlias": true, + "aliasOf": "America/Denver", + "hasZone1970Location": true + }, + { + "id": "America/Virgin", + "isAlias": true, + "aliasOf": "America/Port_of_Spain", + "hasZone1970Location": true + }, + { + "id": "Antarctica/South_Pole", + "isAlias": true, + "aliasOf": "Pacific/Auckland", + "hasZone1970Location": true + }, + { + "id": "Asia/Ashkhabad", + "isAlias": true, + "aliasOf": "Asia/Ashgabat", + "hasZone1970Location": true + }, + { + "id": "Asia/Calcutta", + "isAlias": true, + "aliasOf": "Asia/Kolkata", + "hasZone1970Location": true + }, + { + "id": "Asia/Chongqing", + "isAlias": true, + "aliasOf": "Asia/Shanghai", + "hasZone1970Location": true + }, + { + "id": "Asia/Chungking", + "isAlias": true, + "aliasOf": "Asia/Shanghai", + "hasZone1970Location": true + }, + { + "id": "Asia/Dacca", + "isAlias": true, + "aliasOf": "Asia/Dhaka", + "hasZone1970Location": true + }, + { + "id": "Asia/Harbin", + "isAlias": true, + "aliasOf": "Asia/Shanghai", + "hasZone1970Location": true + }, + { + "id": "Asia/Kashgar", + "isAlias": true, + "aliasOf": "Asia/Urumqi", + "hasZone1970Location": true + }, + { + "id": "Asia/Katmandu", + "isAlias": true, + "aliasOf": "Asia/Kathmandu", + "hasZone1970Location": true + }, + { + "id": "Asia/Macao", + "isAlias": true, + "aliasOf": "Asia/Macau", + "hasZone1970Location": true + }, + { + "id": "Asia/Rangoon", + "isAlias": true, + "aliasOf": "Asia/Yangon", + "hasZone1970Location": true + }, + { + "id": "Asia/Saigon", + "isAlias": true, + "aliasOf": "Asia/Ho_Chi_Minh", + "hasZone1970Location": true + }, + { + "id": "Asia/Tel_Aviv", + "isAlias": true, + "aliasOf": "Asia/Jerusalem", + "hasZone1970Location": true + }, + { + "id": "Asia/Thimbu", + "isAlias": true, + "aliasOf": "Asia/Thimphu", + "hasZone1970Location": true + }, + { + "id": "Asia/Ujung_Pandang", + "isAlias": true, + "aliasOf": "Asia/Makassar", + "hasZone1970Location": true + }, + { + "id": "Asia/Ulan_Bator", + "isAlias": true, + "aliasOf": "Asia/Ulaanbaatar", + "hasZone1970Location": true + }, + { + "id": "Atlantic/Faeroe", + "isAlias": true, + "aliasOf": "Atlantic/Faroe", + "hasZone1970Location": true + }, + { + "id": "Atlantic/Jan_Mayen", + "isAlias": true, + "aliasOf": "Europe/Oslo", + "hasZone1970Location": true + }, + { + "id": "Australia/ACT", + "isAlias": true, + "aliasOf": "Australia/Sydney", + "hasZone1970Location": true + }, + { + "id": "Australia/Canberra", + "isAlias": true, + "aliasOf": "Australia/Sydney", + "hasZone1970Location": true + }, + { + "id": "Australia/LHI", + "isAlias": true, + "aliasOf": "Australia/Lord_Howe", + "hasZone1970Location": true + }, + { + "id": "Australia/NSW", + "isAlias": true, + "aliasOf": "Australia/Sydney", + "hasZone1970Location": true + }, + { + "id": "Australia/North", + "isAlias": true, + "aliasOf": "Australia/Darwin", + "hasZone1970Location": true + }, + { + "id": "Australia/Queensland", + "isAlias": true, + "aliasOf": "Australia/Brisbane", + "hasZone1970Location": true + }, + { + "id": "Australia/South", + "isAlias": true, + "aliasOf": "Australia/Adelaide", + "hasZone1970Location": true + }, + { + "id": "Australia/Tasmania", + "isAlias": true, + "aliasOf": "Australia/Hobart", + "hasZone1970Location": true + }, + { + "id": "Australia/Victoria", + "isAlias": true, + "aliasOf": "Australia/Melbourne", + "hasZone1970Location": true + }, + { + "id": "Australia/West", + "isAlias": true, + "aliasOf": "Australia/Perth", + "hasZone1970Location": true + }, + { + "id": "Australia/Yancowinna", + "isAlias": true, + "aliasOf": "Australia/Broken_Hill", + "hasZone1970Location": true + }, + { + "id": "Brazil/Acre", + "isAlias": true, + "aliasOf": "America/Rio_Branco", + "hasZone1970Location": true + }, + { + "id": "Brazil/DeNoronha", + "isAlias": true, + "aliasOf": "America/Noronha", + "hasZone1970Location": true + }, + { + "id": "Brazil/East", + "isAlias": true, + "aliasOf": "America/Sao_Paulo", + "hasZone1970Location": true + }, + { + "id": "Brazil/West", + "isAlias": true, + "aliasOf": "America/Manaus", + "hasZone1970Location": true + }, + { + "id": "Canada/Atlantic", + "isAlias": true, + "aliasOf": "America/Halifax", + "hasZone1970Location": true + }, + { + "id": "Canada/Central", + "isAlias": true, + "aliasOf": "America/Winnipeg", + "hasZone1970Location": true + }, + { + "id": "Canada/East-Saskatchewan", + "isAlias": true, + "aliasOf": "America/Regina", + "hasZone1970Location": true + }, + { + "id": "Canada/Eastern", + "isAlias": true, + "aliasOf": "America/Toronto", + "hasZone1970Location": true + }, + { + "id": "Canada/Mountain", + "isAlias": true, + "aliasOf": "America/Edmonton", + "hasZone1970Location": true + }, + { + "id": "Canada/Newfoundland", + "isAlias": true, + "aliasOf": "America/St_Johns", + "hasZone1970Location": true + }, + { + "id": "Canada/Pacific", + "isAlias": true, + "aliasOf": "America/Vancouver", + "hasZone1970Location": true + }, + { + "id": "Canada/Saskatchewan", + "isAlias": true, + "aliasOf": "America/Regina", + "hasZone1970Location": true + }, + { + "id": "Canada/Yukon", + "isAlias": true, + "aliasOf": "America/Whitehorse", + "hasZone1970Location": true + }, + { + "id": "Chile/Continental", + "isAlias": true, + "aliasOf": "America/Santiago", + "hasZone1970Location": true + }, + { + "id": "Chile/EasterIsland", + "isAlias": true, + "aliasOf": "Pacific/Easter", + "hasZone1970Location": true + }, + { + "id": "Cuba", + "isAlias": true, + "aliasOf": "America/Havana", + "hasZone1970Location": true + }, + { + "id": "Egypt", + "isAlias": true, + "aliasOf": "Africa/Cairo", + "hasZone1970Location": true + }, + { + "id": "Eire", + "isAlias": true, + "aliasOf": "Europe/Dublin", + "hasZone1970Location": true + }, + { + "id": "Europe/Belfast", + "isAlias": true, + "aliasOf": "Europe/London", + "hasZone1970Location": true + }, + { + "id": "Europe/Tiraspol", + "isAlias": true, + "aliasOf": "Europe/Chisinau", + "hasZone1970Location": true + }, + { + "id": "GB", + "isAlias": true, + "aliasOf": "Europe/London", + "hasZone1970Location": true + }, + { + "id": "GB-Eire", + "isAlias": true, + "aliasOf": "Europe/London", + "hasZone1970Location": true + }, + { + "id": "GMT+0", + "isAlias": true, + "aliasOf": "Etc/GMT", + "hasZone1970Location": false + }, + { + "id": "GMT-0", + "isAlias": true, + "aliasOf": "Etc/GMT", + "hasZone1970Location": false + }, + { + "id": "GMT0", + "isAlias": true, + "aliasOf": "Etc/GMT", + "hasZone1970Location": false + }, + { + "id": "Greenwich", + "isAlias": true, + "aliasOf": "Etc/GMT", + "hasZone1970Location": false + }, + { + "id": "Hongkong", + "isAlias": true, + "aliasOf": "Asia/Hong_Kong", + "hasZone1970Location": true + }, + { + "id": "Iceland", + "isAlias": true, + "aliasOf": "Atlantic/Reykjavik", + "hasZone1970Location": true + }, + { + "id": "Iran", + "isAlias": true, + "aliasOf": "Asia/Tehran", + "hasZone1970Location": true + }, + { + "id": "Israel", + "isAlias": true, + "aliasOf": "Asia/Jerusalem", + "hasZone1970Location": true + }, + { + "id": "Jamaica", + "isAlias": true, + "aliasOf": "America/Jamaica", + "hasZone1970Location": true + }, + { + "id": "Japan", + "isAlias": true, + "aliasOf": "Asia/Tokyo", + "hasZone1970Location": true + }, + { + "id": "Kwajalein", + "isAlias": true, + "aliasOf": "Pacific/Kwajalein", + "hasZone1970Location": true + }, + { + "id": "Libya", + "isAlias": true, + "aliasOf": "Africa/Tripoli", + "hasZone1970Location": true + }, + { + "id": "Mexico/BajaNorte", + "isAlias": true, + "aliasOf": "America/Tijuana", + "hasZone1970Location": true + }, + { + "id": "Mexico/BajaSur", + "isAlias": true, + "aliasOf": "America/Mazatlan", + "hasZone1970Location": true + }, + { + "id": "Mexico/General", + "isAlias": true, + "aliasOf": "America/Mexico_City", + "hasZone1970Location": true + }, + { + "id": "NZ", + "isAlias": true, + "aliasOf": "Pacific/Auckland", + "hasZone1970Location": true + }, + { + "id": "NZ-CHAT", + "isAlias": true, + "aliasOf": "Pacific/Chatham", + "hasZone1970Location": true + }, + { + "id": "Navajo", + "isAlias": true, + "aliasOf": "America/Denver", + "hasZone1970Location": true + }, + { + "id": "PRC", + "isAlias": true, + "aliasOf": "Asia/Shanghai", + "hasZone1970Location": true + }, + { + "id": "Pacific/Johnston", + "isAlias": true, + "aliasOf": "Pacific/Honolulu", + "hasZone1970Location": true + }, + { + "id": "Pacific/Ponape", + "isAlias": true, + "aliasOf": "Pacific/Pohnpei", + "hasZone1970Location": true + }, + { + "id": "Pacific/Samoa", + "isAlias": true, + "aliasOf": "Pacific/Pago_Pago", + "hasZone1970Location": true + }, + { + "id": "Pacific/Truk", + "isAlias": true, + "aliasOf": "Pacific/Chuuk", + "hasZone1970Location": true + }, + { + "id": "Pacific/Yap", + "isAlias": true, + "aliasOf": "Pacific/Chuuk", + "hasZone1970Location": true + }, + { + "id": "Poland", + "isAlias": true, + "aliasOf": "Europe/Warsaw", + "hasZone1970Location": true + }, + { + "id": "Portugal", + "isAlias": true, + "aliasOf": "Europe/Lisbon", + "hasZone1970Location": true + }, + { + "id": "ROC", + "isAlias": true, + "aliasOf": "Asia/Taipei", + "hasZone1970Location": true + }, + { + "id": "ROK", + "isAlias": true, + "aliasOf": "Asia/Seoul", + "hasZone1970Location": true + }, + { + "id": "Singapore", + "isAlias": true, + "aliasOf": "Asia/Singapore", + "hasZone1970Location": true + }, + { + "id": "Turkey", + "isAlias": true, + "aliasOf": "Europe/Istanbul", + "hasZone1970Location": true + }, + { + "id": "UCT", + "isAlias": true, + "aliasOf": "Etc/UCT", + "hasZone1970Location": false + }, + { + "id": "US/Alaska", + "isAlias": true, + "aliasOf": "America/Anchorage", + "hasZone1970Location": true + }, + { + "id": "US/Aleutian", + "isAlias": true, + "aliasOf": "America/Adak", + "hasZone1970Location": true + }, + { + "id": "US/Arizona", + "isAlias": true, + "aliasOf": "America/Phoenix", + "hasZone1970Location": true + }, + { + "id": "US/Central", + "isAlias": true, + "aliasOf": "America/Chicago", + "hasZone1970Location": true + }, + { + "id": "US/East-Indiana", + "isAlias": true, + "aliasOf": "America/Indiana/Indianapolis", + "hasZone1970Location": true + }, + { + "id": "US/Eastern", + "isAlias": true, + "aliasOf": "America/New_York", + "hasZone1970Location": true + }, + { + "id": "US/Hawaii", + "isAlias": true, + "aliasOf": "Pacific/Honolulu", + "hasZone1970Location": true + }, + { + "id": "US/Indiana-Starke", + "isAlias": true, + "aliasOf": "America/Indiana/Knox", + "hasZone1970Location": true + }, + { + "id": "US/Michigan", + "isAlias": true, + "aliasOf": "America/Detroit", + "hasZone1970Location": true + }, + { + "id": "US/Mountain", + "isAlias": true, + "aliasOf": "America/Denver", + "hasZone1970Location": true + }, + { + "id": "US/Pacific", + "isAlias": true, + "aliasOf": "America/Los_Angeles", + "hasZone1970Location": true + }, + { + "id": "US/Samoa", + "isAlias": true, + "aliasOf": "Pacific/Pago_Pago", + "hasZone1970Location": true + }, + { + "id": "UTC", + "isAlias": true, + "aliasOf": "Etc/UTC", + "hasZone1970Location": false + }, + { + "id": "Universal", + "isAlias": true, + "aliasOf": "Etc/UTC", + "hasZone1970Location": false + }, + { + "id": "W-SU", + "isAlias": true, + "aliasOf": "Europe/Moscow", + "hasZone1970Location": true + }, + { + "id": "Zulu", + "isAlias": true, + "aliasOf": "Etc/UTC", + "hasZone1970Location": false + }, + { + "id": "Africa/Abidjan", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Accra", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Algiers", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Bissau", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Cairo", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Casablanca", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Ceuta", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/El_Aaiun", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Johannesburg", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Khartoum", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Lagos", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Maputo", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Monrovia", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Nairobi", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Ndjamena", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Tripoli", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Tunis", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Windhoek", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Adak", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Anchorage", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Araguaina", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Argentina/Buenos_Aires", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Argentina/Catamarca", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Argentina/Cordoba", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Argentina/Jujuy", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Argentina/La_Rioja", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Argentina/Mendoza", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Argentina/Rio_Gallegos", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Argentina/Salta", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Argentina/San_Juan", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Argentina/San_Luis", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Argentina/Tucuman", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Argentina/Ushuaia", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Asuncion", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Atikokan", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Bahia", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Bahia_Banderas", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Barbados", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Belem", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Belize", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Blanc-Sablon", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Boa_Vista", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Bogota", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Boise", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Cambridge_Bay", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Campo_Grande", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Cancun", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Caracas", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Cayenne", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Chicago", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Chihuahua", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Costa_Rica", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Creston", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Cuiaba", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Curacao", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Danmarkshavn", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Dawson", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Dawson_Creek", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Denver", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Detroit", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Edmonton", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Eirunepe", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/El_Salvador", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Fort_Nelson", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Fortaleza", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Glace_Bay", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Godthab", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Goose_Bay", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Grand_Turk", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Guatemala", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Guayaquil", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Guyana", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Halifax", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Havana", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Hermosillo", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Indiana/Indianapolis", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Indiana/Knox", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Indiana/Marengo", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Indiana/Petersburg", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Indiana/Tell_City", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Indiana/Vevay", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Indiana/Vincennes", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Indiana/Winamac", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Inuvik", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Iqaluit", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Jamaica", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Juneau", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Kentucky/Louisville", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Kentucky/Monticello", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/La_Paz", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Lima", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Los_Angeles", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Maceio", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Managua", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Manaus", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Martinique", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Matamoros", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Mazatlan", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Menominee", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Merida", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Metlakatla", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Mexico_City", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Miquelon", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Moncton", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Monterrey", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Montevideo", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Nassau", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/New_York", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Nipigon", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Nome", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Noronha", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/North_Dakota/Beulah", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/North_Dakota/Center", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/North_Dakota/New_Salem", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Ojinaga", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Panama", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Pangnirtung", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Paramaribo", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Phoenix", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Port-au-Prince", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Port_of_Spain", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Porto_Velho", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Puerto_Rico", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Punta_Arenas", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Rainy_River", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Rankin_Inlet", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Recife", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Regina", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Resolute", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Rio_Branco", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Santarem", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Santiago", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Santo_Domingo", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Sao_Paulo", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Scoresbysund", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Sitka", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/St_Johns", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Swift_Current", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Tegucigalpa", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Thule", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Thunder_Bay", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Tijuana", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Toronto", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Vancouver", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Whitehorse", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Winnipeg", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Yakutat", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Yellowknife", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Antarctica/Casey", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Antarctica/Davis", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Antarctica/DumontDUrville", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Antarctica/Macquarie", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Antarctica/Mawson", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Antarctica/Palmer", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Antarctica/Rothera", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Antarctica/Syowa", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Antarctica/Troll", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Antarctica/Vostok", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Almaty", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Amman", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Anadyr", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Aqtau", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Aqtobe", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Ashgabat", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Atyrau", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Baghdad", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Baku", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Bangkok", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Barnaul", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Beirut", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Bishkek", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Brunei", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Chita", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Choibalsan", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Colombo", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Damascus", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Dhaka", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Dili", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Dubai", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Dushanbe", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Famagusta", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Gaza", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Hebron", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Ho_Chi_Minh", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Hong_Kong", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Hovd", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Irkutsk", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Jakarta", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Jayapura", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Jerusalem", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Kabul", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Kamchatka", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Karachi", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Kathmandu", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Khandyga", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Kolkata", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Krasnoyarsk", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Kuala_Lumpur", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Kuching", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Macau", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Magadan", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Makassar", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Manila", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Nicosia", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Novokuznetsk", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Novosibirsk", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Omsk", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Oral", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Pontianak", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Pyongyang", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Qatar", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Qyzylorda", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Riyadh", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Sakhalin", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Samarkand", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Seoul", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Shanghai", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Singapore", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Srednekolymsk", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Taipei", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Tashkent", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Tbilisi", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Tehran", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Thimphu", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Tokyo", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Tomsk", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Ulaanbaatar", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Urumqi", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Ust-Nera", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Vladivostok", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Yakutsk", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Yangon", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Yekaterinburg", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Yerevan", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Atlantic/Azores", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Atlantic/Bermuda", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Atlantic/Canary", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Atlantic/Cape_Verde", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Atlantic/Faroe", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Atlantic/Madeira", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Atlantic/Reykjavik", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Atlantic/South_Georgia", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Atlantic/Stanley", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Australia/Adelaide", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Australia/Brisbane", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Australia/Broken_Hill", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Australia/Currie", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Australia/Darwin", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Australia/Eucla", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Australia/Hobart", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Australia/Lindeman", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Australia/Lord_Howe", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Australia/Melbourne", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Australia/Perth", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Australia/Sydney", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "CET", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "CST6CDT", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "EET", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "EST", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "EST5EDT", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT+1", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT+10", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT+11", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT+12", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT+2", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT+3", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT+4", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT+5", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT+6", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT+7", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT+8", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT+9", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT-1", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT-10", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT-11", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT-12", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT-13", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT-14", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT-2", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT-3", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT-4", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT-5", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT-6", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT-7", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT-8", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT-9", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/UCT", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/UTC", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Europe/Amsterdam", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Andorra", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Astrakhan", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Athens", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Belgrade", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Berlin", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Brussels", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Bucharest", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Budapest", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Chisinau", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Copenhagen", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Dublin", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Gibraltar", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Helsinki", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Istanbul", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Kaliningrad", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Kiev", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Kirov", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Lisbon", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/London", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Luxembourg", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Madrid", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Malta", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Minsk", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Monaco", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Moscow", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Oslo", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Paris", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Prague", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Riga", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Rome", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Samara", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Saratov", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Simferopol", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Sofia", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Stockholm", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Tallinn", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Tirane", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Ulyanovsk", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Uzhgorod", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Vienna", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Vilnius", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Volgograd", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Warsaw", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Zaporozhye", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Zurich", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "HST", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Indian/Chagos", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Indian/Christmas", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Indian/Cocos", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Indian/Kerguelen", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Indian/Mahe", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Indian/Maldives", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Indian/Mauritius", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Indian/Reunion", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "MET", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "MST", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "MST7MDT", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "PST8PDT", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Pacific/Apia", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Auckland", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Bougainville", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Chatham", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Chuuk", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Easter", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Efate", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Enderbury", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Fakaofo", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Fiji", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Funafuti", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Galapagos", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Gambier", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Guadalcanal", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Guam", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Honolulu", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Kiritimati", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Kosrae", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Kwajalein", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Majuro", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Marquesas", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Nauru", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Niue", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Norfolk", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Noumea", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Pago_Pago", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Palau", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Pitcairn", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Pohnpei", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Port_Moresby", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Rarotonga", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Tahiti", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Tarawa", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Tongatapu", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Wake", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Wallis", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "WET", + "isAlias": false, + "hasZone1970Location": false + } + ] + } + } +} diff --git a/specification/maps/data-plane/Timezone/preview/1.0/examples/GetTimezoneEnumWindows.json b/specification/maps/data-plane/Timezone/preview/1.0/examples/GetTimezoneEnumWindows.json new file mode 100644 index 000000000000..cadaf5300931 --- /dev/null +++ b/specification/maps/data-plane/Timezone/preview/1.0/examples/GetTimezoneEnumWindows.json @@ -0,0 +1,3604 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0" + }, + "responses": { + "200": { + "body": [ + { + "WindowsId": "Dateline Standard Time", + "Territory": "001", + "IanaIds": [ + "Etc/GMT+12" + ] + }, + { + "WindowsId": "Dateline Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT+12" + ] + }, + { + "WindowsId": "UTC-11", + "Territory": "001", + "IanaIds": [ + "Etc/GMT+11" + ] + }, + { + "WindowsId": "UTC-11", + "Territory": "AS", + "IanaIds": [ + "Pacific/Pago_Pago" + ] + }, + { + "WindowsId": "UTC-11", + "Territory": "NU", + "IanaIds": [ + "Pacific/Niue" + ] + }, + { + "WindowsId": "UTC-11", + "Territory": "UM", + "IanaIds": [ + "Pacific/Midway" + ] + }, + { + "WindowsId": "UTC-11", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT+11" + ] + }, + { + "WindowsId": "Aleutian Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Adak" + ] + }, + { + "WindowsId": "Aleutian Standard Time", + "Territory": "US", + "IanaIds": [ + "America/Adak" + ] + }, + { + "WindowsId": "Hawaiian Standard Time", + "Territory": "001", + "IanaIds": [ + "Pacific/Honolulu" + ] + }, + { + "WindowsId": "Hawaiian Standard Time", + "Territory": "CK", + "IanaIds": [ + "Pacific/Rarotonga" + ] + }, + { + "WindowsId": "Hawaiian Standard Time", + "Territory": "PF", + "IanaIds": [ + "Pacific/Tahiti" + ] + }, + { + "WindowsId": "Hawaiian Standard Time", + "Territory": "UM", + "IanaIds": [ + "Pacific/Johnston" + ] + }, + { + "WindowsId": "Hawaiian Standard Time", + "Territory": "US", + "IanaIds": [ + "Pacific/Honolulu" + ] + }, + { + "WindowsId": "Hawaiian Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT+10" + ] + }, + { + "WindowsId": "Marquesas Standard Time", + "Territory": "001", + "IanaIds": [ + "Pacific/Marquesas" + ] + }, + { + "WindowsId": "Marquesas Standard Time", + "Territory": "PF", + "IanaIds": [ + "Pacific/Marquesas" + ] + }, + { + "WindowsId": "Alaskan Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Anchorage" + ] + }, + { + "WindowsId": "Alaskan Standard Time", + "Territory": "US", + "IanaIds": [ + "America/Anchorage", + "America/Juneau", + "America/Metlakatla", + "America/Nome", + "America/Sitka", + "America/Yakutat" + ] + }, + { + "WindowsId": "UTC-09", + "Territory": "001", + "IanaIds": [ + "Etc/GMT+9" + ] + }, + { + "WindowsId": "UTC-09", + "Territory": "PF", + "IanaIds": [ + "Pacific/Gambier" + ] + }, + { + "WindowsId": "UTC-09", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT+9" + ] + }, + { + "WindowsId": "Pacific Standard Time (Mexico)", + "Territory": "001", + "IanaIds": [ + "America/Tijuana" + ] + }, + { + "WindowsId": "Pacific Standard Time (Mexico)", + "Territory": "MX", + "IanaIds": [ + "America/Tijuana", + "America/Santa_Isabel" + ] + }, + { + "WindowsId": "UTC-08", + "Territory": "001", + "IanaIds": [ + "Etc/GMT+8" + ] + }, + { + "WindowsId": "UTC-08", + "Territory": "PN", + "IanaIds": [ + "Pacific/Pitcairn" + ] + }, + { + "WindowsId": "UTC-08", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT+8" + ] + }, + { + "WindowsId": "Pacific Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Los_Angeles" + ] + }, + { + "WindowsId": "Pacific Standard Time", + "Territory": "CA", + "IanaIds": [ + "America/Vancouver", + "America/Dawson", + "America/Whitehorse" + ] + }, + { + "WindowsId": "Pacific Standard Time", + "Territory": "US", + "IanaIds": [ + "America/Los_Angeles" + ] + }, + { + "WindowsId": "Pacific Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "PST8PDT" + ] + }, + { + "WindowsId": "US Mountain Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Phoenix" + ] + }, + { + "WindowsId": "US Mountain Standard Time", + "Territory": "CA", + "IanaIds": [ + "America/Dawson_Creek", + "America/Creston", + "America/Fort_Nelson" + ] + }, + { + "WindowsId": "US Mountain Standard Time", + "Territory": "MX", + "IanaIds": [ + "America/Hermosillo" + ] + }, + { + "WindowsId": "US Mountain Standard Time", + "Territory": "US", + "IanaIds": [ + "America/Phoenix" + ] + }, + { + "WindowsId": "US Mountain Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT+7" + ] + }, + { + "WindowsId": "Mountain Standard Time (Mexico)", + "Territory": "001", + "IanaIds": [ + "America/Chihuahua" + ] + }, + { + "WindowsId": "Mountain Standard Time (Mexico)", + "Territory": "MX", + "IanaIds": [ + "America/Chihuahua", + "America/Mazatlan" + ] + }, + { + "WindowsId": "Mountain Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Denver" + ] + }, + { + "WindowsId": "Mountain Standard Time", + "Territory": "CA", + "IanaIds": [ + "America/Edmonton", + "America/Cambridge_Bay", + "America/Inuvik", + "America/Yellowknife" + ] + }, + { + "WindowsId": "Mountain Standard Time", + "Territory": "MX", + "IanaIds": [ + "America/Ojinaga" + ] + }, + { + "WindowsId": "Mountain Standard Time", + "Territory": "US", + "IanaIds": [ + "America/Denver", + "America/Boise" + ] + }, + { + "WindowsId": "Mountain Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "MST7MDT" + ] + }, + { + "WindowsId": "Central America Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Guatemala" + ] + }, + { + "WindowsId": "Central America Standard Time", + "Territory": "BZ", + "IanaIds": [ + "America/Belize" + ] + }, + { + "WindowsId": "Central America Standard Time", + "Territory": "CR", + "IanaIds": [ + "America/Costa_Rica" + ] + }, + { + "WindowsId": "Central America Standard Time", + "Territory": "EC", + "IanaIds": [ + "Pacific/Galapagos" + ] + }, + { + "WindowsId": "Central America Standard Time", + "Territory": "GT", + "IanaIds": [ + "America/Guatemala" + ] + }, + { + "WindowsId": "Central America Standard Time", + "Territory": "HN", + "IanaIds": [ + "America/Tegucigalpa" + ] + }, + { + "WindowsId": "Central America Standard Time", + "Territory": "NI", + "IanaIds": [ + "America/Managua" + ] + }, + { + "WindowsId": "Central America Standard Time", + "Territory": "SV", + "IanaIds": [ + "America/El_Salvador" + ] + }, + { + "WindowsId": "Central America Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT+6" + ] + }, + { + "WindowsId": "Central Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Chicago" + ] + }, + { + "WindowsId": "Central Standard Time", + "Territory": "CA", + "IanaIds": [ + "America/Winnipeg", + "America/Rainy_River", + "America/Rankin_Inlet", + "America/Resolute" + ] + }, + { + "WindowsId": "Central Standard Time", + "Territory": "MX", + "IanaIds": [ + "America/Matamoros" + ] + }, + { + "WindowsId": "Central Standard Time", + "Territory": "US", + "IanaIds": [ + "America/Chicago", + "America/Indiana/Knox", + "America/Indiana/Tell_City", + "America/Menominee", + "America/North_Dakota/Beulah", + "America/North_Dakota/Center", + "America/North_Dakota/New_Salem" + ] + }, + { + "WindowsId": "Central Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "CST6CDT" + ] + }, + { + "WindowsId": "Easter Island Standard Time", + "Territory": "001", + "IanaIds": [ + "Pacific/Easter" + ] + }, + { + "WindowsId": "Easter Island Standard Time", + "Territory": "CL", + "IanaIds": [ + "Pacific/Easter" + ] + }, + { + "WindowsId": "Central Standard Time (Mexico)", + "Territory": "001", + "IanaIds": [ + "America/Mexico_City" + ] + }, + { + "WindowsId": "Central Standard Time (Mexico)", + "Territory": "MX", + "IanaIds": [ + "America/Mexico_City", + "America/Bahia_Banderas", + "America/Merida", + "America/Monterrey" + ] + }, + { + "WindowsId": "Canada Central Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Regina" + ] + }, + { + "WindowsId": "Canada Central Standard Time", + "Territory": "CA", + "IanaIds": [ + "America/Regina", + "America/Swift_Current" + ] + }, + { + "WindowsId": "SA Pacific Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Bogota" + ] + }, + { + "WindowsId": "SA Pacific Standard Time", + "Territory": "BR", + "IanaIds": [ + "America/Rio_Branco", + "America/Eirunepe" + ] + }, + { + "WindowsId": "SA Pacific Standard Time", + "Territory": "CA", + "IanaIds": [ + "America/Coral_Harbour" + ] + }, + { + "WindowsId": "SA Pacific Standard Time", + "Territory": "CO", + "IanaIds": [ + "America/Bogota" + ] + }, + { + "WindowsId": "SA Pacific Standard Time", + "Territory": "EC", + "IanaIds": [ + "America/Guayaquil" + ] + }, + { + "WindowsId": "SA Pacific Standard Time", + "Territory": "JM", + "IanaIds": [ + "America/Jamaica" + ] + }, + { + "WindowsId": "SA Pacific Standard Time", + "Territory": "KY", + "IanaIds": [ + "America/Cayman" + ] + }, + { + "WindowsId": "SA Pacific Standard Time", + "Territory": "PA", + "IanaIds": [ + "America/Panama" + ] + }, + { + "WindowsId": "SA Pacific Standard Time", + "Territory": "PE", + "IanaIds": [ + "America/Lima" + ] + }, + { + "WindowsId": "SA Pacific Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT+5" + ] + }, + { + "WindowsId": "Eastern Standard Time (Mexico)", + "Territory": "001", + "IanaIds": [ + "America/Cancun" + ] + }, + { + "WindowsId": "Eastern Standard Time (Mexico)", + "Territory": "MX", + "IanaIds": [ + "America/Cancun" + ] + }, + { + "WindowsId": "Eastern Standard Time", + "Territory": "001", + "IanaIds": [ + "America/New_York" + ] + }, + { + "WindowsId": "Eastern Standard Time", + "Territory": "BS", + "IanaIds": [ + "America/Nassau" + ] + }, + { + "WindowsId": "Eastern Standard Time", + "Territory": "CA", + "IanaIds": [ + "America/Toronto", + "America/Iqaluit", + "America/Montreal", + "America/Nipigon", + "America/Pangnirtung", + "America/Thunder_Bay" + ] + }, + { + "WindowsId": "Eastern Standard Time", + "Territory": "US", + "IanaIds": [ + "America/New_York", + "America/Detroit", + "America/Indiana/Petersburg", + "America/Indiana/Vincennes", + "America/Indiana/Winamac", + "America/Kentucky/Monticello", + "America/Louisville" + ] + }, + { + "WindowsId": "Eastern Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "EST5EDT" + ] + }, + { + "WindowsId": "Haiti Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Port-au-Prince" + ] + }, + { + "WindowsId": "Haiti Standard Time", + "Territory": "HT", + "IanaIds": [ + "America/Port-au-Prince" + ] + }, + { + "WindowsId": "Cuba Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Havana" + ] + }, + { + "WindowsId": "Cuba Standard Time", + "Territory": "CU", + "IanaIds": [ + "America/Havana" + ] + }, + { + "WindowsId": "US Eastern Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Indianapolis" + ] + }, + { + "WindowsId": "US Eastern Standard Time", + "Territory": "US", + "IanaIds": [ + "America/Indianapolis", + "America/Indiana/Marengo", + "America/Indiana/Vevay" + ] + }, + { + "WindowsId": "Paraguay Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Asuncion" + ] + }, + { + "WindowsId": "Paraguay Standard Time", + "Territory": "PY", + "IanaIds": [ + "America/Asuncion" + ] + }, + { + "WindowsId": "Atlantic Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Halifax" + ] + }, + { + "WindowsId": "Atlantic Standard Time", + "Territory": "BM", + "IanaIds": [ + "Atlantic/Bermuda" + ] + }, + { + "WindowsId": "Atlantic Standard Time", + "Territory": "CA", + "IanaIds": [ + "America/Halifax", + "America/Glace_Bay", + "America/Goose_Bay", + "America/Moncton" + ] + }, + { + "WindowsId": "Atlantic Standard Time", + "Territory": "GL", + "IanaIds": [ + "America/Thule" + ] + }, + { + "WindowsId": "Venezuela Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Caracas" + ] + }, + { + "WindowsId": "Venezuela Standard Time", + "Territory": "VE", + "IanaIds": [ + "America/Caracas" + ] + }, + { + "WindowsId": "Central Brazilian Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Cuiaba" + ] + }, + { + "WindowsId": "Central Brazilian Standard Time", + "Territory": "BR", + "IanaIds": [ + "America/Cuiaba", + "America/Campo_Grande" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "001", + "IanaIds": [ + "America/La_Paz" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "AG", + "IanaIds": [ + "America/Antigua" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "AI", + "IanaIds": [ + "America/Anguilla" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "AW", + "IanaIds": [ + "America/Aruba" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "BB", + "IanaIds": [ + "America/Barbados" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "BL", + "IanaIds": [ + "America/St_Barthelemy" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "BO", + "IanaIds": [ + "America/La_Paz" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "BQ", + "IanaIds": [ + "America/Kralendijk" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "BR", + "IanaIds": [ + "America/Manaus", + "America/Boa_Vista", + "America/Porto_Velho" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "CA", + "IanaIds": [ + "America/Blanc-Sablon" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "CW", + "IanaIds": [ + "America/Curacao" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "DM", + "IanaIds": [ + "America/Dominica" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "DO", + "IanaIds": [ + "America/Santo_Domingo" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "GD", + "IanaIds": [ + "America/Grenada" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "GP", + "IanaIds": [ + "America/Guadeloupe" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "GY", + "IanaIds": [ + "America/Guyana" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "KN", + "IanaIds": [ + "America/St_Kitts" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "LC", + "IanaIds": [ + "America/St_Lucia" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "MF", + "IanaIds": [ + "America/Marigot" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "MQ", + "IanaIds": [ + "America/Martinique" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "MS", + "IanaIds": [ + "America/Montserrat" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "PR", + "IanaIds": [ + "America/Puerto_Rico" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "SX", + "IanaIds": [ + "America/Lower_Princes" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "TT", + "IanaIds": [ + "America/Port_of_Spain" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "VC", + "IanaIds": [ + "America/St_Vincent" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "VG", + "IanaIds": [ + "America/Tortola" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "VI", + "IanaIds": [ + "America/St_Thomas" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT+4" + ] + }, + { + "WindowsId": "Pacific SA Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Santiago" + ] + }, + { + "WindowsId": "Pacific SA Standard Time", + "Territory": "CL", + "IanaIds": [ + "America/Santiago" + ] + }, + { + "WindowsId": "Turks And Caicos Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Grand_Turk" + ] + }, + { + "WindowsId": "Turks And Caicos Standard Time", + "Territory": "TC", + "IanaIds": [ + "America/Grand_Turk" + ] + }, + { + "WindowsId": "Newfoundland Standard Time", + "Territory": "001", + "IanaIds": [ + "America/St_Johns" + ] + }, + { + "WindowsId": "Newfoundland Standard Time", + "Territory": "CA", + "IanaIds": [ + "America/St_Johns" + ] + }, + { + "WindowsId": "Tocantins Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Araguaina" + ] + }, + { + "WindowsId": "Tocantins Standard Time", + "Territory": "BR", + "IanaIds": [ + "America/Araguaina" + ] + }, + { + "WindowsId": "E. South America Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Sao_Paulo" + ] + }, + { + "WindowsId": "E. South America Standard Time", + "Territory": "BR", + "IanaIds": [ + "America/Sao_Paulo" + ] + }, + { + "WindowsId": "SA Eastern Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Cayenne" + ] + }, + { + "WindowsId": "SA Eastern Standard Time", + "Territory": "AQ", + "IanaIds": [ + "Antarctica/Rothera" + ] + }, + { + "WindowsId": "SA Eastern Standard Time", + "Territory": "BR", + "IanaIds": [ + "America/Fortaleza", + "America/Belem", + "America/Maceio", + "America/Recife", + "America/Santarem" + ] + }, + { + "WindowsId": "SA Eastern Standard Time", + "Territory": "FK", + "IanaIds": [ + "Atlantic/Stanley" + ] + }, + { + "WindowsId": "SA Eastern Standard Time", + "Territory": "GF", + "IanaIds": [ + "America/Cayenne" + ] + }, + { + "WindowsId": "SA Eastern Standard Time", + "Territory": "SR", + "IanaIds": [ + "America/Paramaribo" + ] + }, + { + "WindowsId": "SA Eastern Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT+3" + ] + }, + { + "WindowsId": "Argentina Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Buenos_Aires" + ] + }, + { + "WindowsId": "Argentina Standard Time", + "Territory": "AR", + "IanaIds": [ + "America/Buenos_Aires", + "America/Argentina/La_Rioja", + "America/Argentina/Rio_Gallegos", + "America/Argentina/Salta", + "America/Argentina/San_Juan", + "America/Argentina/San_Luis", + "America/Argentina/Tucuman", + "America/Argentina/Ushuaia", + "America/Catamarca", + "America/Cordoba", + "America/Jujuy", + "America/Mendoza" + ] + }, + { + "WindowsId": "Greenland Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Godthab" + ] + }, + { + "WindowsId": "Greenland Standard Time", + "Territory": "GL", + "IanaIds": [ + "America/Godthab" + ] + }, + { + "WindowsId": "Montevideo Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Montevideo" + ] + }, + { + "WindowsId": "Montevideo Standard Time", + "Territory": "UY", + "IanaIds": [ + "America/Montevideo" + ] + }, + { + "WindowsId": "Magallanes Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Punta_Arenas" + ] + }, + { + "WindowsId": "Magallanes Standard Time", + "Territory": "AQ", + "IanaIds": [ + "Antarctica/Palmer" + ] + }, + { + "WindowsId": "Magallanes Standard Time", + "Territory": "CL", + "IanaIds": [ + "America/Punta_Arenas" + ] + }, + { + "WindowsId": "Saint Pierre Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Miquelon" + ] + }, + { + "WindowsId": "Saint Pierre Standard Time", + "Territory": "PM", + "IanaIds": [ + "America/Miquelon" + ] + }, + { + "WindowsId": "Bahia Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Bahia" + ] + }, + { + "WindowsId": "Bahia Standard Time", + "Territory": "BR", + "IanaIds": [ + "America/Bahia" + ] + }, + { + "WindowsId": "UTC-02", + "Territory": "001", + "IanaIds": [ + "Etc/GMT+2" + ] + }, + { + "WindowsId": "UTC-02", + "Territory": "BR", + "IanaIds": [ + "America/Noronha" + ] + }, + { + "WindowsId": "UTC-02", + "Territory": "GS", + "IanaIds": [ + "Atlantic/South_Georgia" + ] + }, + { + "WindowsId": "UTC-02", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT+2" + ] + }, + { + "WindowsId": "Azores Standard Time", + "Territory": "001", + "IanaIds": [ + "Atlantic/Azores" + ] + }, + { + "WindowsId": "Azores Standard Time", + "Territory": "GL", + "IanaIds": [ + "America/Scoresbysund" + ] + }, + { + "WindowsId": "Azores Standard Time", + "Territory": "PT", + "IanaIds": [ + "Atlantic/Azores" + ] + }, + { + "WindowsId": "Cape Verde Standard Time", + "Territory": "001", + "IanaIds": [ + "Atlantic/Cape_Verde" + ] + }, + { + "WindowsId": "Cape Verde Standard Time", + "Territory": "CV", + "IanaIds": [ + "Atlantic/Cape_Verde" + ] + }, + { + "WindowsId": "Cape Verde Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT+1" + ] + }, + { + "WindowsId": "UTC", + "Territory": "001", + "IanaIds": [ + "Etc/GMT" + ] + }, + { + "WindowsId": "UTC", + "Territory": "GL", + "IanaIds": [ + "America/Danmarkshavn" + ] + }, + { + "WindowsId": "UTC", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT", + "Etc/UTC" + ] + }, + { + "WindowsId": "Morocco Standard Time", + "Territory": "001", + "IanaIds": [ + "Africa/Casablanca" + ] + }, + { + "WindowsId": "Morocco Standard Time", + "Territory": "EH", + "IanaIds": [ + "Africa/El_Aaiun" + ] + }, + { + "WindowsId": "Morocco Standard Time", + "Territory": "MA", + "IanaIds": [ + "Africa/Casablanca" + ] + }, + { + "WindowsId": "GMT Standard Time", + "Territory": "001", + "IanaIds": [ + "Europe/London" + ] + }, + { + "WindowsId": "GMT Standard Time", + "Territory": "ES", + "IanaIds": [ + "Atlantic/Canary" + ] + }, + { + "WindowsId": "GMT Standard Time", + "Territory": "FO", + "IanaIds": [ + "Atlantic/Faeroe" + ] + }, + { + "WindowsId": "GMT Standard Time", + "Territory": "GB", + "IanaIds": [ + "Europe/London" + ] + }, + { + "WindowsId": "GMT Standard Time", + "Territory": "GG", + "IanaIds": [ + "Europe/Guernsey" + ] + }, + { + "WindowsId": "GMT Standard Time", + "Territory": "IE", + "IanaIds": [ + "Europe/Dublin" + ] + }, + { + "WindowsId": "GMT Standard Time", + "Territory": "IM", + "IanaIds": [ + "Europe/Isle_of_Man" + ] + }, + { + "WindowsId": "GMT Standard Time", + "Territory": "JE", + "IanaIds": [ + "Europe/Jersey" + ] + }, + { + "WindowsId": "GMT Standard Time", + "Territory": "PT", + "IanaIds": [ + "Europe/Lisbon", + "Atlantic/Madeira" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "001", + "IanaIds": [ + "Atlantic/Reykjavik" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "BF", + "IanaIds": [ + "Africa/Ouagadougou" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "CI", + "IanaIds": [ + "Africa/Abidjan" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "GH", + "IanaIds": [ + "Africa/Accra" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "GM", + "IanaIds": [ + "Africa/Banjul" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "GN", + "IanaIds": [ + "Africa/Conakry" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "GW", + "IanaIds": [ + "Africa/Bissau" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "IS", + "IanaIds": [ + "Atlantic/Reykjavik" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "LR", + "IanaIds": [ + "Africa/Monrovia" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "ML", + "IanaIds": [ + "Africa/Bamako" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "MR", + "IanaIds": [ + "Africa/Nouakchott" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "SH", + "IanaIds": [ + "Atlantic/St_Helena" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "SL", + "IanaIds": [ + "Africa/Freetown" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "SN", + "IanaIds": [ + "Africa/Dakar" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "ST", + "IanaIds": [ + "Africa/Sao_Tome" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "TG", + "IanaIds": [ + "Africa/Lome" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "001", + "IanaIds": [ + "Europe/Berlin" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "AD", + "IanaIds": [ + "Europe/Andorra" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "AT", + "IanaIds": [ + "Europe/Vienna" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "CH", + "IanaIds": [ + "Europe/Zurich" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "DE", + "IanaIds": [ + "Europe/Berlin", + "Europe/Busingen" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "GI", + "IanaIds": [ + "Europe/Gibraltar" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "IT", + "IanaIds": [ + "Europe/Rome" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "LI", + "IanaIds": [ + "Europe/Vaduz" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "LU", + "IanaIds": [ + "Europe/Luxembourg" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "MC", + "IanaIds": [ + "Europe/Monaco" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "MT", + "IanaIds": [ + "Europe/Malta" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "NL", + "IanaIds": [ + "Europe/Amsterdam" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "NO", + "IanaIds": [ + "Europe/Oslo" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "SE", + "IanaIds": [ + "Europe/Stockholm" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "SJ", + "IanaIds": [ + "Arctic/Longyearbyen" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "SM", + "IanaIds": [ + "Europe/San_Marino" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "VA", + "IanaIds": [ + "Europe/Vatican" + ] + }, + { + "WindowsId": "Central Europe Standard Time", + "Territory": "001", + "IanaIds": [ + "Europe/Budapest" + ] + }, + { + "WindowsId": "Central Europe Standard Time", + "Territory": "AL", + "IanaIds": [ + "Europe/Tirane" + ] + }, + { + "WindowsId": "Central Europe Standard Time", + "Territory": "CZ", + "IanaIds": [ + "Europe/Prague" + ] + }, + { + "WindowsId": "Central Europe Standard Time", + "Territory": "HU", + "IanaIds": [ + "Europe/Budapest" + ] + }, + { + "WindowsId": "Central Europe Standard Time", + "Territory": "ME", + "IanaIds": [ + "Europe/Podgorica" + ] + }, + { + "WindowsId": "Central Europe Standard Time", + "Territory": "RS", + "IanaIds": [ + "Europe/Belgrade" + ] + }, + { + "WindowsId": "Central Europe Standard Time", + "Territory": "SI", + "IanaIds": [ + "Europe/Ljubljana" + ] + }, + { + "WindowsId": "Central Europe Standard Time", + "Territory": "SK", + "IanaIds": [ + "Europe/Bratislava" + ] + }, + { + "WindowsId": "Romance Standard Time", + "Territory": "001", + "IanaIds": [ + "Europe/Paris" + ] + }, + { + "WindowsId": "Romance Standard Time", + "Territory": "BE", + "IanaIds": [ + "Europe/Brussels" + ] + }, + { + "WindowsId": "Romance Standard Time", + "Territory": "DK", + "IanaIds": [ + "Europe/Copenhagen" + ] + }, + { + "WindowsId": "Romance Standard Time", + "Territory": "ES", + "IanaIds": [ + "Europe/Madrid", + "Africa/Ceuta" + ] + }, + { + "WindowsId": "Romance Standard Time", + "Territory": "FR", + "IanaIds": [ + "Europe/Paris" + ] + }, + { + "WindowsId": "Central European Standard Time", + "Territory": "001", + "IanaIds": [ + "Europe/Warsaw" + ] + }, + { + "WindowsId": "Central European Standard Time", + "Territory": "BA", + "IanaIds": [ + "Europe/Sarajevo" + ] + }, + { + "WindowsId": "Central European Standard Time", + "Territory": "HR", + "IanaIds": [ + "Europe/Zagreb" + ] + }, + { + "WindowsId": "Central European Standard Time", + "Territory": "MK", + "IanaIds": [ + "Europe/Skopje" + ] + }, + { + "WindowsId": "Central European Standard Time", + "Territory": "PL", + "IanaIds": [ + "Europe/Warsaw" + ] + }, + { + "WindowsId": "W. Central Africa Standard Time", + "Territory": "001", + "IanaIds": [ + "Africa/Lagos" + ] + }, + { + "WindowsId": "W. Central Africa Standard Time", + "Territory": "AO", + "IanaIds": [ + "Africa/Luanda" + ] + }, + { + "WindowsId": "W. Central Africa Standard Time", + "Territory": "BJ", + "IanaIds": [ + "Africa/Porto-Novo" + ] + }, + { + "WindowsId": "W. Central Africa Standard Time", + "Territory": "CD", + "IanaIds": [ + "Africa/Kinshasa" + ] + }, + { + "WindowsId": "W. Central Africa Standard Time", + "Territory": "CF", + "IanaIds": [ + "Africa/Bangui" + ] + }, + { + "WindowsId": "W. Central Africa Standard Time", + "Territory": "CG", + "IanaIds": [ + "Africa/Brazzaville" + ] + }, + { + "WindowsId": "W. Central Africa Standard Time", + "Territory": "CM", + "IanaIds": [ + "Africa/Douala" + ] + }, + { + "WindowsId": "W. Central Africa Standard Time", + "Territory": "DZ", + "IanaIds": [ + "Africa/Algiers" + ] + }, + { + "WindowsId": "W. Central Africa Standard Time", + "Territory": "GA", + "IanaIds": [ + "Africa/Libreville" + ] + }, + { + "WindowsId": "W. Central Africa Standard Time", + "Territory": "GQ", + "IanaIds": [ + "Africa/Malabo" + ] + }, + { + "WindowsId": "W. Central Africa Standard Time", + "Territory": "NE", + "IanaIds": [ + "Africa/Niamey" + ] + }, + { + "WindowsId": "W. Central Africa Standard Time", + "Territory": "NG", + "IanaIds": [ + "Africa/Lagos" + ] + }, + { + "WindowsId": "W. Central Africa Standard Time", + "Territory": "TD", + "IanaIds": [ + "Africa/Ndjamena" + ] + }, + { + "WindowsId": "W. Central Africa Standard Time", + "Territory": "TN", + "IanaIds": [ + "Africa/Tunis" + ] + }, + { + "WindowsId": "W. Central Africa Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT-1" + ] + }, + { + "WindowsId": "Namibia Standard Time", + "Territory": "001", + "IanaIds": [ + "Africa/Windhoek" + ] + }, + { + "WindowsId": "Namibia Standard Time", + "Territory": "NA", + "IanaIds": [ + "Africa/Windhoek" + ] + }, + { + "WindowsId": "Jordan Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Amman" + ] + }, + { + "WindowsId": "Jordan Standard Time", + "Territory": "JO", + "IanaIds": [ + "Asia/Amman" + ] + }, + { + "WindowsId": "GTB Standard Time", + "Territory": "001", + "IanaIds": [ + "Europe/Bucharest" + ] + }, + { + "WindowsId": "GTB Standard Time", + "Territory": "CY", + "IanaIds": [ + "Asia/Nicosia" + ] + }, + { + "WindowsId": "GTB Standard Time", + "Territory": "GR", + "IanaIds": [ + "Europe/Athens" + ] + }, + { + "WindowsId": "GTB Standard Time", + "Territory": "RO", + "IanaIds": [ + "Europe/Bucharest" + ] + }, + { + "WindowsId": "Middle East Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Beirut" + ] + }, + { + "WindowsId": "Middle East Standard Time", + "Territory": "LB", + "IanaIds": [ + "Asia/Beirut" + ] + }, + { + "WindowsId": "Egypt Standard Time", + "Territory": "001", + "IanaIds": [ + "Africa/Cairo" + ] + }, + { + "WindowsId": "Egypt Standard Time", + "Territory": "EG", + "IanaIds": [ + "Africa/Cairo" + ] + }, + { + "WindowsId": "E. Europe Standard Time", + "Territory": "001", + "IanaIds": [ + "Europe/Chisinau" + ] + }, + { + "WindowsId": "E. Europe Standard Time", + "Territory": "MD", + "IanaIds": [ + "Europe/Chisinau" + ] + }, + { + "WindowsId": "Syria Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Damascus" + ] + }, + { + "WindowsId": "Syria Standard Time", + "Territory": "SY", + "IanaIds": [ + "Asia/Damascus" + ] + }, + { + "WindowsId": "West Bank Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Hebron" + ] + }, + { + "WindowsId": "West Bank Standard Time", + "Territory": "PS", + "IanaIds": [ + "Asia/Hebron", + "Asia/Gaza" + ] + }, + { + "WindowsId": "South Africa Standard Time", + "Territory": "001", + "IanaIds": [ + "Africa/Johannesburg" + ] + }, + { + "WindowsId": "South Africa Standard Time", + "Territory": "BI", + "IanaIds": [ + "Africa/Bujumbura" + ] + }, + { + "WindowsId": "South Africa Standard Time", + "Territory": "BW", + "IanaIds": [ + "Africa/Gaborone" + ] + }, + { + "WindowsId": "South Africa Standard Time", + "Territory": "CD", + "IanaIds": [ + "Africa/Lubumbashi" + ] + }, + { + "WindowsId": "South Africa Standard Time", + "Territory": "LS", + "IanaIds": [ + "Africa/Maseru" + ] + }, + { + "WindowsId": "South Africa Standard Time", + "Territory": "MW", + "IanaIds": [ + "Africa/Blantyre" + ] + }, + { + "WindowsId": "South Africa Standard Time", + "Territory": "MZ", + "IanaIds": [ + "Africa/Maputo" + ] + }, + { + "WindowsId": "South Africa Standard Time", + "Territory": "RW", + "IanaIds": [ + "Africa/Kigali" + ] + }, + { + "WindowsId": "South Africa Standard Time", + "Territory": "SZ", + "IanaIds": [ + "Africa/Mbabane" + ] + }, + { + "WindowsId": "South Africa Standard Time", + "Territory": "ZA", + "IanaIds": [ + "Africa/Johannesburg" + ] + }, + { + "WindowsId": "South Africa Standard Time", + "Territory": "ZM", + "IanaIds": [ + "Africa/Lusaka" + ] + }, + { + "WindowsId": "South Africa Standard Time", + "Territory": "ZW", + "IanaIds": [ + "Africa/Harare" + ] + }, + { + "WindowsId": "South Africa Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT-2" + ] + }, + { + "WindowsId": "FLE Standard Time", + "Territory": "001", + "IanaIds": [ + "Europe/Kiev" + ] + }, + { + "WindowsId": "FLE Standard Time", + "Territory": "AX", + "IanaIds": [ + "Europe/Mariehamn" + ] + }, + { + "WindowsId": "FLE Standard Time", + "Territory": "BG", + "IanaIds": [ + "Europe/Sofia" + ] + }, + { + "WindowsId": "FLE Standard Time", + "Territory": "EE", + "IanaIds": [ + "Europe/Tallinn" + ] + }, + { + "WindowsId": "FLE Standard Time", + "Territory": "FI", + "IanaIds": [ + "Europe/Helsinki" + ] + }, + { + "WindowsId": "FLE Standard Time", + "Territory": "LT", + "IanaIds": [ + "Europe/Vilnius" + ] + }, + { + "WindowsId": "FLE Standard Time", + "Territory": "LV", + "IanaIds": [ + "Europe/Riga" + ] + }, + { + "WindowsId": "FLE Standard Time", + "Territory": "UA", + "IanaIds": [ + "Europe/Kiev", + "Europe/Uzhgorod", + "Europe/Zaporozhye" + ] + }, + { + "WindowsId": "Israel Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Jerusalem" + ] + }, + { + "WindowsId": "Israel Standard Time", + "Territory": "IL", + "IanaIds": [ + "Asia/Jerusalem" + ] + }, + { + "WindowsId": "Kaliningrad Standard Time", + "Territory": "001", + "IanaIds": [ + "Europe/Kaliningrad" + ] + }, + { + "WindowsId": "Kaliningrad Standard Time", + "Territory": "RU", + "IanaIds": [ + "Europe/Kaliningrad" + ] + }, + { + "WindowsId": "Libya Standard Time", + "Territory": "001", + "IanaIds": [ + "Africa/Tripoli" + ] + }, + { + "WindowsId": "Libya Standard Time", + "Territory": "LY", + "IanaIds": [ + "Africa/Tripoli" + ] + }, + { + "WindowsId": "Arabic Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Baghdad" + ] + }, + { + "WindowsId": "Arabic Standard Time", + "Territory": "IQ", + "IanaIds": [ + "Asia/Baghdad" + ] + }, + { + "WindowsId": "Turkey Standard Time", + "Territory": "001", + "IanaIds": [ + "Europe/Istanbul" + ] + }, + { + "WindowsId": "Turkey Standard Time", + "Territory": "CY", + "IanaIds": [ + "Asia/Famagusta" + ] + }, + { + "WindowsId": "Turkey Standard Time", + "Territory": "TR", + "IanaIds": [ + "Europe/Istanbul" + ] + }, + { + "WindowsId": "Arab Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Riyadh" + ] + }, + { + "WindowsId": "Arab Standard Time", + "Territory": "BH", + "IanaIds": [ + "Asia/Bahrain" + ] + }, + { + "WindowsId": "Arab Standard Time", + "Territory": "KW", + "IanaIds": [ + "Asia/Kuwait" + ] + }, + { + "WindowsId": "Arab Standard Time", + "Territory": "QA", + "IanaIds": [ + "Asia/Qatar" + ] + }, + { + "WindowsId": "Arab Standard Time", + "Territory": "SA", + "IanaIds": [ + "Asia/Riyadh" + ] + }, + { + "WindowsId": "Arab Standard Time", + "Territory": "YE", + "IanaIds": [ + "Asia/Aden" + ] + }, + { + "WindowsId": "Belarus Standard Time", + "Territory": "001", + "IanaIds": [ + "Europe/Minsk" + ] + }, + { + "WindowsId": "Belarus Standard Time", + "Territory": "BY", + "IanaIds": [ + "Europe/Minsk" + ] + }, + { + "WindowsId": "Russian Standard Time", + "Territory": "001", + "IanaIds": [ + "Europe/Moscow" + ] + }, + { + "WindowsId": "Russian Standard Time", + "Territory": "RU", + "IanaIds": [ + "Europe/Moscow", + "Europe/Kirov", + "Europe/Volgograd" + ] + }, + { + "WindowsId": "Russian Standard Time", + "Territory": "UA", + "IanaIds": [ + "Europe/Simferopol" + ] + }, + { + "WindowsId": "E. Africa Standard Time", + "Territory": "001", + "IanaIds": [ + "Africa/Nairobi" + ] + }, + { + "WindowsId": "E. Africa Standard Time", + "Territory": "AQ", + "IanaIds": [ + "Antarctica/Syowa" + ] + }, + { + "WindowsId": "E. Africa Standard Time", + "Territory": "DJ", + "IanaIds": [ + "Africa/Djibouti" + ] + }, + { + "WindowsId": "E. Africa Standard Time", + "Territory": "ER", + "IanaIds": [ + "Africa/Asmera" + ] + }, + { + "WindowsId": "E. Africa Standard Time", + "Territory": "ET", + "IanaIds": [ + "Africa/Addis_Ababa" + ] + }, + { + "WindowsId": "E. Africa Standard Time", + "Territory": "KE", + "IanaIds": [ + "Africa/Nairobi" + ] + }, + { + "WindowsId": "E. Africa Standard Time", + "Territory": "KM", + "IanaIds": [ + "Indian/Comoro" + ] + }, + { + "WindowsId": "E. Africa Standard Time", + "Territory": "MG", + "IanaIds": [ + "Indian/Antananarivo" + ] + }, + { + "WindowsId": "E. Africa Standard Time", + "Territory": "SD", + "IanaIds": [ + "Africa/Khartoum" + ] + }, + { + "WindowsId": "E. Africa Standard Time", + "Territory": "SO", + "IanaIds": [ + "Africa/Mogadishu" + ] + }, + { + "WindowsId": "E. Africa Standard Time", + "Territory": "SS", + "IanaIds": [ + "Africa/Juba" + ] + }, + { + "WindowsId": "E. Africa Standard Time", + "Territory": "TZ", + "IanaIds": [ + "Africa/Dar_es_Salaam" + ] + }, + { + "WindowsId": "E. Africa Standard Time", + "Territory": "UG", + "IanaIds": [ + "Africa/Kampala" + ] + }, + { + "WindowsId": "E. Africa Standard Time", + "Territory": "YT", + "IanaIds": [ + "Indian/Mayotte" + ] + }, + { + "WindowsId": "E. Africa Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT-3" + ] + }, + { + "WindowsId": "Iran Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Tehran" + ] + }, + { + "WindowsId": "Iran Standard Time", + "Territory": "IR", + "IanaIds": [ + "Asia/Tehran" + ] + }, + { + "WindowsId": "Arabian Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Dubai" + ] + }, + { + "WindowsId": "Arabian Standard Time", + "Territory": "AE", + "IanaIds": [ + "Asia/Dubai" + ] + }, + { + "WindowsId": "Arabian Standard Time", + "Territory": "OM", + "IanaIds": [ + "Asia/Muscat" + ] + }, + { + "WindowsId": "Arabian Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT-4" + ] + }, + { + "WindowsId": "Astrakhan Standard Time", + "Territory": "001", + "IanaIds": [ + "Europe/Astrakhan" + ] + }, + { + "WindowsId": "Astrakhan Standard Time", + "Territory": "RU", + "IanaIds": [ + "Europe/Astrakhan", + "Europe/Ulyanovsk" + ] + }, + { + "WindowsId": "Azerbaijan Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Baku" + ] + }, + { + "WindowsId": "Azerbaijan Standard Time", + "Territory": "AZ", + "IanaIds": [ + "Asia/Baku" + ] + }, + { + "WindowsId": "Russia Time Zone 3", + "Territory": "001", + "IanaIds": [ + "Europe/Samara" + ] + }, + { + "WindowsId": "Russia Time Zone 3", + "Territory": "RU", + "IanaIds": [ + "Europe/Samara" + ] + }, + { + "WindowsId": "Mauritius Standard Time", + "Territory": "001", + "IanaIds": [ + "Indian/Mauritius" + ] + }, + { + "WindowsId": "Mauritius Standard Time", + "Territory": "MU", + "IanaIds": [ + "Indian/Mauritius" + ] + }, + { + "WindowsId": "Mauritius Standard Time", + "Territory": "RE", + "IanaIds": [ + "Indian/Reunion" + ] + }, + { + "WindowsId": "Mauritius Standard Time", + "Territory": "SC", + "IanaIds": [ + "Indian/Mahe" + ] + }, + { + "WindowsId": "Saratov Standard Time", + "Territory": "001", + "IanaIds": [ + "Europe/Saratov" + ] + }, + { + "WindowsId": "Saratov Standard Time", + "Territory": "RU", + "IanaIds": [ + "Europe/Saratov" + ] + }, + { + "WindowsId": "Georgian Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Tbilisi" + ] + }, + { + "WindowsId": "Georgian Standard Time", + "Territory": "GE", + "IanaIds": [ + "Asia/Tbilisi" + ] + }, + { + "WindowsId": "Caucasus Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Yerevan" + ] + }, + { + "WindowsId": "Caucasus Standard Time", + "Territory": "AM", + "IanaIds": [ + "Asia/Yerevan" + ] + }, + { + "WindowsId": "Afghanistan Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Kabul" + ] + }, + { + "WindowsId": "Afghanistan Standard Time", + "Territory": "AF", + "IanaIds": [ + "Asia/Kabul" + ] + }, + { + "WindowsId": "West Asia Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Tashkent" + ] + }, + { + "WindowsId": "West Asia Standard Time", + "Territory": "AQ", + "IanaIds": [ + "Antarctica/Mawson" + ] + }, + { + "WindowsId": "West Asia Standard Time", + "Territory": "KZ", + "IanaIds": [ + "Asia/Oral", + "Asia/Aqtau", + "Asia/Aqtobe", + "Asia/Atyrau" + ] + }, + { + "WindowsId": "West Asia Standard Time", + "Territory": "MV", + "IanaIds": [ + "Indian/Maldives" + ] + }, + { + "WindowsId": "West Asia Standard Time", + "Territory": "TF", + "IanaIds": [ + "Indian/Kerguelen" + ] + }, + { + "WindowsId": "West Asia Standard Time", + "Territory": "TJ", + "IanaIds": [ + "Asia/Dushanbe" + ] + }, + { + "WindowsId": "West Asia Standard Time", + "Territory": "TM", + "IanaIds": [ + "Asia/Ashgabat" + ] + }, + { + "WindowsId": "West Asia Standard Time", + "Territory": "UZ", + "IanaIds": [ + "Asia/Tashkent", + "Asia/Samarkand" + ] + }, + { + "WindowsId": "West Asia Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT-5" + ] + }, + { + "WindowsId": "Ekaterinburg Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Yekaterinburg" + ] + }, + { + "WindowsId": "Ekaterinburg Standard Time", + "Territory": "RU", + "IanaIds": [ + "Asia/Yekaterinburg" + ] + }, + { + "WindowsId": "Pakistan Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Karachi" + ] + }, + { + "WindowsId": "Pakistan Standard Time", + "Territory": "PK", + "IanaIds": [ + "Asia/Karachi" + ] + }, + { + "WindowsId": "India Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Calcutta" + ] + }, + { + "WindowsId": "India Standard Time", + "Territory": "IN", + "IanaIds": [ + "Asia/Calcutta" + ] + }, + { + "WindowsId": "Sri Lanka Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Colombo" + ] + }, + { + "WindowsId": "Sri Lanka Standard Time", + "Territory": "LK", + "IanaIds": [ + "Asia/Colombo" + ] + }, + { + "WindowsId": "Nepal Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Katmandu" + ] + }, + { + "WindowsId": "Nepal Standard Time", + "Territory": "NP", + "IanaIds": [ + "Asia/Katmandu" + ] + }, + { + "WindowsId": "Central Asia Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Almaty" + ] + }, + { + "WindowsId": "Central Asia Standard Time", + "Territory": "AQ", + "IanaIds": [ + "Antarctica/Vostok" + ] + }, + { + "WindowsId": "Central Asia Standard Time", + "Territory": "CN", + "IanaIds": [ + "Asia/Urumqi" + ] + }, + { + "WindowsId": "Central Asia Standard Time", + "Territory": "IO", + "IanaIds": [ + "Indian/Chagos" + ] + }, + { + "WindowsId": "Central Asia Standard Time", + "Territory": "KG", + "IanaIds": [ + "Asia/Bishkek" + ] + }, + { + "WindowsId": "Central Asia Standard Time", + "Territory": "KZ", + "IanaIds": [ + "Asia/Almaty", + "Asia/Qyzylorda" + ] + }, + { + "WindowsId": "Central Asia Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT-6" + ] + }, + { + "WindowsId": "Bangladesh Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Dhaka" + ] + }, + { + "WindowsId": "Bangladesh Standard Time", + "Territory": "BD", + "IanaIds": [ + "Asia/Dhaka" + ] + }, + { + "WindowsId": "Bangladesh Standard Time", + "Territory": "BT", + "IanaIds": [ + "Asia/Thimphu" + ] + }, + { + "WindowsId": "Omsk Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Omsk" + ] + }, + { + "WindowsId": "Omsk Standard Time", + "Territory": "RU", + "IanaIds": [ + "Asia/Omsk" + ] + }, + { + "WindowsId": "Myanmar Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Rangoon" + ] + }, + { + "WindowsId": "Myanmar Standard Time", + "Territory": "CC", + "IanaIds": [ + "Indian/Cocos" + ] + }, + { + "WindowsId": "Myanmar Standard Time", + "Territory": "MM", + "IanaIds": [ + "Asia/Rangoon" + ] + }, + { + "WindowsId": "SE Asia Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Bangkok" + ] + }, + { + "WindowsId": "SE Asia Standard Time", + "Territory": "AQ", + "IanaIds": [ + "Antarctica/Davis" + ] + }, + { + "WindowsId": "SE Asia Standard Time", + "Territory": "CX", + "IanaIds": [ + "Indian/Christmas" + ] + }, + { + "WindowsId": "SE Asia Standard Time", + "Territory": "ID", + "IanaIds": [ + "Asia/Jakarta", + "Asia/Pontianak" + ] + }, + { + "WindowsId": "SE Asia Standard Time", + "Territory": "KH", + "IanaIds": [ + "Asia/Phnom_Penh" + ] + }, + { + "WindowsId": "SE Asia Standard Time", + "Territory": "LA", + "IanaIds": [ + "Asia/Vientiane" + ] + }, + { + "WindowsId": "SE Asia Standard Time", + "Territory": "TH", + "IanaIds": [ + "Asia/Bangkok" + ] + }, + { + "WindowsId": "SE Asia Standard Time", + "Territory": "VN", + "IanaIds": [ + "Asia/Saigon" + ] + }, + { + "WindowsId": "SE Asia Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT-7" + ] + }, + { + "WindowsId": "Altai Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Barnaul" + ] + }, + { + "WindowsId": "Altai Standard Time", + "Territory": "RU", + "IanaIds": [ + "Asia/Barnaul" + ] + }, + { + "WindowsId": "W. Mongolia Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Hovd" + ] + }, + { + "WindowsId": "W. Mongolia Standard Time", + "Territory": "MN", + "IanaIds": [ + "Asia/Hovd" + ] + }, + { + "WindowsId": "North Asia Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Krasnoyarsk" + ] + }, + { + "WindowsId": "North Asia Standard Time", + "Territory": "RU", + "IanaIds": [ + "Asia/Krasnoyarsk", + "Asia/Novokuznetsk" + ] + }, + { + "WindowsId": "N. Central Asia Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Novosibirsk" + ] + }, + { + "WindowsId": "N. Central Asia Standard Time", + "Territory": "RU", + "IanaIds": [ + "Asia/Novosibirsk" + ] + }, + { + "WindowsId": "Tomsk Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Tomsk" + ] + }, + { + "WindowsId": "Tomsk Standard Time", + "Territory": "RU", + "IanaIds": [ + "Asia/Tomsk" + ] + }, + { + "WindowsId": "China Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Shanghai" + ] + }, + { + "WindowsId": "China Standard Time", + "Territory": "CN", + "IanaIds": [ + "Asia/Shanghai" + ] + }, + { + "WindowsId": "China Standard Time", + "Territory": "HK", + "IanaIds": [ + "Asia/Hong_Kong" + ] + }, + { + "WindowsId": "China Standard Time", + "Territory": "MO", + "IanaIds": [ + "Asia/Macau" + ] + }, + { + "WindowsId": "North Asia East Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Irkutsk" + ] + }, + { + "WindowsId": "North Asia East Standard Time", + "Territory": "RU", + "IanaIds": [ + "Asia/Irkutsk" + ] + }, + { + "WindowsId": "Singapore Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Singapore" + ] + }, + { + "WindowsId": "Singapore Standard Time", + "Territory": "BN", + "IanaIds": [ + "Asia/Brunei" + ] + }, + { + "WindowsId": "Singapore Standard Time", + "Territory": "ID", + "IanaIds": [ + "Asia/Makassar" + ] + }, + { + "WindowsId": "Singapore Standard Time", + "Territory": "MY", + "IanaIds": [ + "Asia/Kuala_Lumpur", + "Asia/Kuching" + ] + }, + { + "WindowsId": "Singapore Standard Time", + "Territory": "PH", + "IanaIds": [ + "Asia/Manila" + ] + }, + { + "WindowsId": "Singapore Standard Time", + "Territory": "SG", + "IanaIds": [ + "Asia/Singapore" + ] + }, + { + "WindowsId": "Singapore Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT-8" + ] + }, + { + "WindowsId": "W. Australia Standard Time", + "Territory": "001", + "IanaIds": [ + "Australia/Perth" + ] + }, + { + "WindowsId": "W. Australia Standard Time", + "Territory": "AU", + "IanaIds": [ + "Australia/Perth" + ] + }, + { + "WindowsId": "Taipei Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Taipei" + ] + }, + { + "WindowsId": "Taipei Standard Time", + "Territory": "TW", + "IanaIds": [ + "Asia/Taipei" + ] + }, + { + "WindowsId": "Ulaanbaatar Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Ulaanbaatar" + ] + }, + { + "WindowsId": "Ulaanbaatar Standard Time", + "Territory": "MN", + "IanaIds": [ + "Asia/Ulaanbaatar", + "Asia/Choibalsan" + ] + }, + { + "WindowsId": "North Korea Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Pyongyang" + ] + }, + { + "WindowsId": "North Korea Standard Time", + "Territory": "KP", + "IanaIds": [ + "Asia/Pyongyang" + ] + }, + { + "WindowsId": "Aus Central W. Standard Time", + "Territory": "001", + "IanaIds": [ + "Australia/Eucla" + ] + }, + { + "WindowsId": "Aus Central W. Standard Time", + "Territory": "AU", + "IanaIds": [ + "Australia/Eucla" + ] + }, + { + "WindowsId": "Transbaikal Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Chita" + ] + }, + { + "WindowsId": "Transbaikal Standard Time", + "Territory": "RU", + "IanaIds": [ + "Asia/Chita" + ] + }, + { + "WindowsId": "Tokyo Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Tokyo" + ] + }, + { + "WindowsId": "Tokyo Standard Time", + "Territory": "ID", + "IanaIds": [ + "Asia/Jayapura" + ] + }, + { + "WindowsId": "Tokyo Standard Time", + "Territory": "JP", + "IanaIds": [ + "Asia/Tokyo" + ] + }, + { + "WindowsId": "Tokyo Standard Time", + "Territory": "PW", + "IanaIds": [ + "Pacific/Palau" + ] + }, + { + "WindowsId": "Tokyo Standard Time", + "Territory": "TL", + "IanaIds": [ + "Asia/Dili" + ] + }, + { + "WindowsId": "Tokyo Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT-9" + ] + }, + { + "WindowsId": "Korea Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Seoul" + ] + }, + { + "WindowsId": "Korea Standard Time", + "Territory": "KR", + "IanaIds": [ + "Asia/Seoul" + ] + }, + { + "WindowsId": "Yakutsk Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Yakutsk" + ] + }, + { + "WindowsId": "Yakutsk Standard Time", + "Territory": "RU", + "IanaIds": [ + "Asia/Yakutsk", + "Asia/Khandyga" + ] + }, + { + "WindowsId": "Cen. Australia Standard Time", + "Territory": "001", + "IanaIds": [ + "Australia/Adelaide" + ] + }, + { + "WindowsId": "Cen. Australia Standard Time", + "Territory": "AU", + "IanaIds": [ + "Australia/Adelaide", + "Australia/Broken_Hill" + ] + }, + { + "WindowsId": "AUS Central Standard Time", + "Territory": "001", + "IanaIds": [ + "Australia/Darwin" + ] + }, + { + "WindowsId": "AUS Central Standard Time", + "Territory": "AU", + "IanaIds": [ + "Australia/Darwin" + ] + }, + { + "WindowsId": "E. Australia Standard Time", + "Territory": "001", + "IanaIds": [ + "Australia/Brisbane" + ] + }, + { + "WindowsId": "E. Australia Standard Time", + "Territory": "AU", + "IanaIds": [ + "Australia/Brisbane", + "Australia/Lindeman" + ] + }, + { + "WindowsId": "AUS Eastern Standard Time", + "Territory": "001", + "IanaIds": [ + "Australia/Sydney" + ] + }, + { + "WindowsId": "AUS Eastern Standard Time", + "Territory": "AU", + "IanaIds": [ + "Australia/Sydney", + "Australia/Melbourne" + ] + }, + { + "WindowsId": "West Pacific Standard Time", + "Territory": "001", + "IanaIds": [ + "Pacific/Port_Moresby" + ] + }, + { + "WindowsId": "West Pacific Standard Time", + "Territory": "AQ", + "IanaIds": [ + "Antarctica/DumontDUrville" + ] + }, + { + "WindowsId": "West Pacific Standard Time", + "Territory": "FM", + "IanaIds": [ + "Pacific/Truk" + ] + }, + { + "WindowsId": "West Pacific Standard Time", + "Territory": "GU", + "IanaIds": [ + "Pacific/Guam" + ] + }, + { + "WindowsId": "West Pacific Standard Time", + "Territory": "MP", + "IanaIds": [ + "Pacific/Saipan" + ] + }, + { + "WindowsId": "West Pacific Standard Time", + "Territory": "PG", + "IanaIds": [ + "Pacific/Port_Moresby" + ] + }, + { + "WindowsId": "West Pacific Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT-10" + ] + }, + { + "WindowsId": "Tasmania Standard Time", + "Territory": "001", + "IanaIds": [ + "Australia/Hobart" + ] + }, + { + "WindowsId": "Tasmania Standard Time", + "Territory": "AU", + "IanaIds": [ + "Australia/Hobart", + "Australia/Currie" + ] + }, + { + "WindowsId": "Vladivostok Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Vladivostok" + ] + }, + { + "WindowsId": "Vladivostok Standard Time", + "Territory": "RU", + "IanaIds": [ + "Asia/Vladivostok", + "Asia/Ust-Nera" + ] + }, + { + "WindowsId": "Lord Howe Standard Time", + "Territory": "001", + "IanaIds": [ + "Australia/Lord_Howe" + ] + }, + { + "WindowsId": "Lord Howe Standard Time", + "Territory": "AU", + "IanaIds": [ + "Australia/Lord_Howe" + ] + }, + { + "WindowsId": "Bougainville Standard Time", + "Territory": "001", + "IanaIds": [ + "Pacific/Bougainville" + ] + }, + { + "WindowsId": "Bougainville Standard Time", + "Territory": "PG", + "IanaIds": [ + "Pacific/Bougainville" + ] + }, + { + "WindowsId": "Russia Time Zone 10", + "Territory": "001", + "IanaIds": [ + "Asia/Srednekolymsk" + ] + }, + { + "WindowsId": "Russia Time Zone 10", + "Territory": "RU", + "IanaIds": [ + "Asia/Srednekolymsk" + ] + }, + { + "WindowsId": "Magadan Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Magadan" + ] + }, + { + "WindowsId": "Magadan Standard Time", + "Territory": "RU", + "IanaIds": [ + "Asia/Magadan" + ] + }, + { + "WindowsId": "Norfolk Standard Time", + "Territory": "001", + "IanaIds": [ + "Pacific/Norfolk" + ] + }, + { + "WindowsId": "Norfolk Standard Time", + "Territory": "NF", + "IanaIds": [ + "Pacific/Norfolk" + ] + }, + { + "WindowsId": "Sakhalin Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Sakhalin" + ] + }, + { + "WindowsId": "Sakhalin Standard Time", + "Territory": "RU", + "IanaIds": [ + "Asia/Sakhalin" + ] + }, + { + "WindowsId": "Central Pacific Standard Time", + "Territory": "001", + "IanaIds": [ + "Pacific/Guadalcanal" + ] + }, + { + "WindowsId": "Central Pacific Standard Time", + "Territory": "AQ", + "IanaIds": [ + "Antarctica/Casey" + ] + }, + { + "WindowsId": "Central Pacific Standard Time", + "Territory": "AU", + "IanaIds": [ + "Antarctica/Macquarie" + ] + }, + { + "WindowsId": "Central Pacific Standard Time", + "Territory": "FM", + "IanaIds": [ + "Pacific/Ponape", + "Pacific/Kosrae" + ] + }, + { + "WindowsId": "Central Pacific Standard Time", + "Territory": "NC", + "IanaIds": [ + "Pacific/Noumea" + ] + }, + { + "WindowsId": "Central Pacific Standard Time", + "Territory": "SB", + "IanaIds": [ + "Pacific/Guadalcanal" + ] + }, + { + "WindowsId": "Central Pacific Standard Time", + "Territory": "VU", + "IanaIds": [ + "Pacific/Efate" + ] + }, + { + "WindowsId": "Central Pacific Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT-11" + ] + }, + { + "WindowsId": "Russia Time Zone 11", + "Territory": "001", + "IanaIds": [ + "Asia/Kamchatka" + ] + }, + { + "WindowsId": "Russia Time Zone 11", + "Territory": "RU", + "IanaIds": [ + "Asia/Kamchatka", + "Asia/Anadyr" + ] + }, + { + "WindowsId": "New Zealand Standard Time", + "Territory": "001", + "IanaIds": [ + "Pacific/Auckland" + ] + }, + { + "WindowsId": "New Zealand Standard Time", + "Territory": "AQ", + "IanaIds": [ + "Antarctica/McMurdo" + ] + }, + { + "WindowsId": "New Zealand Standard Time", + "Territory": "NZ", + "IanaIds": [ + "Pacific/Auckland" + ] + }, + { + "WindowsId": "UTC+12", + "Territory": "001", + "IanaIds": [ + "Etc/GMT-12" + ] + }, + { + "WindowsId": "UTC+12", + "Territory": "KI", + "IanaIds": [ + "Pacific/Tarawa" + ] + }, + { + "WindowsId": "UTC+12", + "Territory": "MH", + "IanaIds": [ + "Pacific/Majuro", + "Pacific/Kwajalein" + ] + }, + { + "WindowsId": "UTC+12", + "Territory": "NR", + "IanaIds": [ + "Pacific/Nauru" + ] + }, + { + "WindowsId": "UTC+12", + "Territory": "TV", + "IanaIds": [ + "Pacific/Funafuti" + ] + }, + { + "WindowsId": "UTC+12", + "Territory": "UM", + "IanaIds": [ + "Pacific/Wake" + ] + }, + { + "WindowsId": "UTC+12", + "Territory": "WF", + "IanaIds": [ + "Pacific/Wallis" + ] + }, + { + "WindowsId": "UTC+12", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT-12" + ] + }, + { + "WindowsId": "Fiji Standard Time", + "Territory": "001", + "IanaIds": [ + "Pacific/Fiji" + ] + }, + { + "WindowsId": "Fiji Standard Time", + "Territory": "FJ", + "IanaIds": [ + "Pacific/Fiji" + ] + }, + { + "WindowsId": "Chatham Islands Standard Time", + "Territory": "001", + "IanaIds": [ + "Pacific/Chatham" + ] + }, + { + "WindowsId": "Chatham Islands Standard Time", + "Territory": "NZ", + "IanaIds": [ + "Pacific/Chatham" + ] + }, + { + "WindowsId": "UTC+13", + "Territory": "001", + "IanaIds": [ + "Etc/GMT-13" + ] + }, + { + "WindowsId": "UTC+13", + "Territory": "KI", + "IanaIds": [ + "Pacific/Enderbury" + ] + }, + { + "WindowsId": "UTC+13", + "Territory": "TK", + "IanaIds": [ + "Pacific/Fakaofo" + ] + }, + { + "WindowsId": "UTC+13", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT-13" + ] + }, + { + "WindowsId": "Tonga Standard Time", + "Territory": "001", + "IanaIds": [ + "Pacific/Tongatapu" + ] + }, + { + "WindowsId": "Tonga Standard Time", + "Territory": "TO", + "IanaIds": [ + "Pacific/Tongatapu" + ] + }, + { + "WindowsId": "Samoa Standard Time", + "Territory": "001", + "IanaIds": [ + "Pacific/Apia" + ] + }, + { + "WindowsId": "Samoa Standard Time", + "Territory": "WS", + "IanaIds": [ + "Pacific/Apia" + ] + }, + { + "WindowsId": "Line Islands Standard Time", + "Territory": "001", + "IanaIds": [ + "Pacific/Kiritimati" + ] + }, + { + "WindowsId": "Line Islands Standard Time", + "Territory": "KI", + "IanaIds": [ + "Pacific/Kiritimati" + ] + }, + { + "WindowsId": "Line Islands Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT-14" + ] + } + ] + } + } +} diff --git a/specification/maps/data-plane/Timezone/preview/1.0/examples/GetTimezoneIANAVersion.json b/specification/maps/data-plane/Timezone/preview/1.0/examples/GetTimezoneIANAVersion.json new file mode 100644 index 000000000000..110b1eeea6c0 --- /dev/null +++ b/specification/maps/data-plane/Timezone/preview/1.0/examples/GetTimezoneIANAVersion.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0" + }, + "responses": { + "200": { + "body": { + "version": "2017b" + } + } + } +} diff --git a/specification/maps/data-plane/Timezone/preview/1.0/examples/GetTimezoneWindowsToIANA.json b/specification/maps/data-plane/Timezone/preview/1.0/examples/GetTimezoneWindowsToIANA.json new file mode 100644 index 000000000000..d62af4a7f4a7 --- /dev/null +++ b/specification/maps/data-plane/Timezone/preview/1.0/examples/GetTimezoneWindowsToIANA.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "geography": "us", + "format": "json", + "api-version": "1.0", + "query": "pacific standard time" + }, + "responses": { + "200": { + "body": [ + { + "id": "America/Los_Angeles", + "isAlias": false, + "hasZone1970Location": true + } + ] + } + } +} diff --git a/specification/maps/data-plane/Timezone/preview/1.0/timezone.json b/specification/maps/data-plane/Timezone/preview/1.0/timezone.json new file mode 100644 index 000000000000..6a37f46b3b92 --- /dev/null +++ b/specification/maps/data-plane/Timezone/preview/1.0/timezone.json @@ -0,0 +1,786 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Time Zone Service", + "version": "1.0", + "description": "Azure Maps Time Zone REST APIs" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{geography}.atlas.microsoft.com", + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "AzureKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "AzureKey": [] + } + ], + "responses": {}, + "parameters": { + "TimezoneApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API.", + "type": "string", + "in": "query", + "required": true, + "default": "1.0", + "x-ms-parameter-location": "client" + }, + "TimezoneAcceptLanguage": { + "name": "Accept-Language", + "in": "header", + "description": "Specifies the language code in which the timezone names should be returned. If no language code is provided, the response will be in \"EN\". Please refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "TimezoneOptions": { + "name": "options", + "in": "query", + "description": "Alternatively, use alias \"o\". Options available for types of information returned in the result.", + "type": "string", + "enum": [ + "none", + "zoneInfo", + "transitions", + "all" + ], + "x-ms-enum": { + "name": "TimezoneOptions", + "modelAsString": true, + "values": [ + { + "value": "none", + "description": "Do not include zoneinfo or transitions in the result." + }, + { + "value": "zoneInfo", + "description": "Include additional time zone info in the result." + }, + { + "value": "transitions", + "description": "Include transition information in the result (The number of transitions is currently capped at 250)." + }, + { + "value": "all", + "description": "Include both zoneinfo and transitions in the result." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "TimezoneTimeStamp": { + "name": "timeStamp", + "in": "query", + "description": "Alternatively, use alias \"stamp\", or \"s\". Reference time, if omitted, the API will use the machine time serving the request.", + "type": "string", + "x-ms-parameter-location": "method", + "format": "date-time" + }, + "TimezoneTransitionsFrom": { + "name": "transitionsFrom", + "in": "query", + "description": "Alternatively, use alias \"tf\". The start date from which daylight savings time (DST) transitions are requested, only applies when \"options\" = all or \"options\" = transitions.", + "type": "string", + "x-ms-parameter-location": "method", + "format": "date-time" + }, + "TimezoneTransitionsYears": { + "name": "transitionsYears", + "in": "query", + "description": "Alternatively, use alias \"ty\". The number of years from \"transitionsFrom\" for which DST transitions are requested, only applies when \"options\" = all or \"options\" = transitions.", + "type": "integer", + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/timezone/byId/{format}": { + "get": { + "description": "__Time Zone by Id__\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThis API returns current, historical, and future time zone information for the specified IANA time zone ID.", + "operationId": "Timezone_GetTimezoneByID", + "x-ms-examples": { + "GetTimezoneByID": { + "$ref": "./examples/GetTimezoneByID.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/TimezoneApiVersion" + }, + { + "$ref": "#/parameters/TimezoneAcceptLanguage" + }, + { + "$ref": "#/parameters/TimezoneOptions" + }, + { + "$ref": "#/parameters/TimezoneTimeStamp" + }, + { + "$ref": "#/parameters/TimezoneTransitionsFrom" + }, + { + "$ref": "#/parameters/TimezoneTransitionsYears" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "query", + "in": "query", + "description": "The IANA time zone ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TimezoneByIdResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/timezone/byCoordinates/{format}": { + "get": { + "description": "__Time Zone by Coordinates__\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThis API returns current, historical, and future time zone information for a specified latitude-longitude pair. In addition, the API provides sunset and sunrise times for a given location.", + "operationId": "Timezone_GetTimezoneByCoordinates", + "x-ms-examples": { + "GetTimezoneByCoordinates": { + "$ref": "./examples/GetTimezoneByCoordinates.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/TimezoneApiVersion" + }, + { + "$ref": "#/parameters/TimezoneAcceptLanguage" + }, + { + "$ref": "#/parameters/TimezoneOptions" + }, + { + "$ref": "#/parameters/TimezoneTimeStamp" + }, + { + "$ref": "#/parameters/TimezoneTransitionsFrom" + }, + { + "$ref": "#/parameters/TimezoneTransitionsYears" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "query", + "in": "query", + "description": "Coordinates of the point for which time zone information is requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TimezoneByCoordinatesResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/timezone/enumWindows/{format}": { + "get": { + "description": "__Enumerate Windows Time Zones__\n\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThis API returns a full list of Windows Time Zone IDs.", + "operationId": "Timezone_GetTimezoneEnumWindows", + "x-ms-examples": { + "GetTimezoneEnumWindows": { + "$ref": "./examples/GetTimezoneEnumWindows.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/TimezoneApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TimezoneEnumWindowsResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/timezone/enumIana/{format}": { + "get": { + "description": "__Enumerate IANA Time Zones__\n\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThis API returns a full list of IANA time zone IDs. Updates to the IANA service will be reflected in the system within one day.", + "operationId": "Timezone_GetTimezoneEnumIANA", + "x-ms-examples": { + "GetTimezoneEnumIANA": { + "$ref": "./examples/GetTimezoneEnumIANA.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/TimezoneApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TimezoneEnumIanaResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/timezone/ianaVersion/{format}": { + "get": { + "description": "__Time Zone IANA Version__\n\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThis API returns the current IANA version number.", + "operationId": "Timezone_GetTimezoneIANAVersion", + "x-ms-examples": { + "GetTimezoneIANAVersion": { + "$ref": "./examples/GetTimezoneIANAVersion.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/TimezoneApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TimezoneIanaVersionResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/timezone/windowsToIana/{format}": { + "get": { + "description": "__Windows to IANA Time Zone__\n\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThis API returns a corresponding IANA ID, given a valid Windows Time Zone ID. Multiple IANA IDs may be returned for a single Windows ID. It is possible to narrow these results by adding an optional territory parameter.", + "operationId": "Timezone_GetTimezoneWindowsToIANA", + "x-ms-examples": { + "GetTimezoneWindowsToIANA": { + "$ref": "./examples/GetTimezoneWindowsToIANA.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/TimezoneApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "query", + "in": "query", + "description": "The Windows time zone ID.", + "required": true, + "type": "string" + }, + { + "name": "territory", + "in": "query", + "description": "Windows Time Zone territory code.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TimezoneWindowsToIanaResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + } + }, + "definitions": { + "CountryRecord": { + "type": "object", + "description": "A country record.", + "properties": { + "Name": { + "description": "Country Name", + "type": "string", + "readOnly": true + }, + "Code": { + "description": "ISO-3166 2-letter country code for the country.", + "type": "string", + "readOnly": true + } + } + }, + "TimeTransition": { + "type": "object", + "readOnly": true, + "properties": { + "Tag": { + "description": "Tag property", + "type": "string", + "readOnly": true + }, + "StandardOffset": { + "description": "StandardOffset property", + "type": "string", + "readOnly": true + }, + "DaylightSavings": { + "description": "DaylightSavings property", + "type": "string", + "readOnly": true + }, + "UtcStart": { + "description": "Start date, start time for this transition period", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "UtcEnd": { + "description": "End date, end time for this transition period", + "type": "string", + "readOnly": true, + "format": "date-time" + } + } + }, + "TimezoneByIdResult": { + "description": "This object is returned from a successful Timezone By ID call", + "type": "object", + "properties": { + "Version": { + "description": "Version property", + "type": "string", + "readOnly": true + }, + "ReferenceUtcTimestamp": { + "description": "Reference Utc Timestamp property", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "TimeZones": { + "$ref": "#/definitions/TimeZonesById" + } + } + }, + "TimezoneByCoordinatesResult": { + "description": "This object is returned from a successful Timezone By Coordinates call", + "type": "object", + "properties": { + "Version": { + "description": "Version property", + "type": "string", + "readOnly": true + }, + "ReferenceUtcTimestamp": { + "description": "Reference Utc Timestamp property", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "TimeZones": { + "$ref": "#/definitions/TimeZonesByCoordinates" + } + } + }, + "TimezoneEnumWindowsResult": { + "description": "This object is returned from a successful Timezone Enum Windows call", + "type": "array", + "items": { + "$ref": "#/definitions/TimezoneEnumWindow" + } + }, + "TimezoneEnumWindow": { + "type": "object", + "properties": { + "WindowsId": { + "description": "Windows Id property", + "type": "string", + "readOnly": true + }, + "Territory": { + "description": "Territory property", + "type": "string", + "readOnly": true + }, + "IanaIds": { + "description": "IanaIds array", + "type": "array", + "items": { + "type": "string", + "readOnly": true + } + } + } + }, + "TimezoneEnumIanaResult": { + "description": "This object is returned from a successful Timezone Enum IANA call", + "type": "array", + "items": { + "$ref": "#/definitions/IanaId" + } + }, + "TimezoneIanaVersionResult": { + "description": "This object is returned from a successful Timezone IANA Version call", + "type": "object", + "properties": { + "version": { + "description": "Version property", + "type": "string", + "readOnly": true + } + } + }, + "TimezoneWindowsToIanaResult": { + "description": "This object is returned from a successful Timezone Windows To IANA call", + "type": "array", + "items": { + "$ref": "#/definitions/IanaId" + } + }, + "IanaId": { + "type": "object", + "properties": { + "id": { + "description": "Id property", + "type": "string", + "readOnly": true + }, + "isAlias": { + "description": "IsAlias property", + "type": "boolean", + "readOnly": true + }, + "aliasOf": { + "description": "AliasOf property", + "type": "string", + "readOnly": true + }, + "hasZone1970Location": { + "description": "HasZone1970Location property", + "type": "boolean", + "readOnly": true + } + } + }, + "TimeZonesById": { + "description": "TimeZoneById array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TimezoneById" + } + }, + "TimeZonesByCoordinates": { + "description": "TimeZoneByCoordinates array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TimeZoneByCoordinates" + } + }, + "TimezoneById": { + "type": "object", + "properties": { + "Id": { + "description": "Id property", + "type": "string", + "readOnly": true + }, + "Aliases": { + "description": "An array of time zone ID aliases.  Only returned when [options]=*zoneinfo* or *all*.\n\nNote: may be null.", + "type": "array", + "readOnly": true, + "items": { + "type": "string", + "readOnly": true + } + }, + "Countries": { + "description": "An array of country records. Only returned when [options]=*zoneinfo* or *all*.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CountryRecord" + } + }, + "Names": { + "$ref": "#/definitions/TimezoneNames" + }, + "ReferenceTime": { + "$ref": "#/definitions/ReferenceTimeById" + }, + "RepresentativePoint": { + "$ref": "#/definitions/RepresentativePoint" + }, + "TimeTransitions": { + "description": "Time zone DST transitions from [transitionsFrom] until timestamp + 1 year.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TimeTransition" + } + } + } + }, + "TimeZoneByCoordinates": { + "type": "object", + "properties": { + "Id": { + "description": "Id property", + "type": "string", + "readOnly": true + }, + "Aliases": { + "description": "An array of time zone ID aliases.  Only returned when [options]=*zoneinfo* or *all*.\n\nNote: may be null.", + "type": "array", + "readOnly": true, + "items": { + "type": "string", + "readOnly": true + } + }, + "Countries": { + "description": "An array of country records. Only returned when [options]=*zoneinfo* or *all*.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CountryRecord" + } + }, + "Names": { + "$ref": "#/definitions/TimezoneNames" + }, + "ReferenceTime": { + "$ref": "#/definitions/ReferenceTimeByCoordinates" + }, + "RepresentativePoint": { + "$ref": "#/definitions/RepresentativePoint" + }, + "TimeTransitions": { + "description": "Time zone DST transitions from [transitionsFrom] until timestamp + 1 year.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TimeTransition" + } + } + } + }, + "TimezoneNames": { + "type": "object", + "description": "Timezone names object.", + "properties": { + "ISO6391LanguageCode": { + "description": "The ISO 639-1 language code of the Names", + "type": "string", + "readOnly": true + }, + "Generic": { + "description": "Generic Name", + "type": "string", + "readOnly": true + }, + "Standard": { + "description": "Standard Name", + "type": "string", + "readOnly": true + }, + "Daylight": { + "description": "Daylight Name", + "type": "string", + "readOnly": true + } + } + }, + "ReferenceTimeById": { + "description": "Details in effect at the local time.", + "type": "object", + "readOnly": true, + "properties": { + "Tag": { + "description": "Time zone name in effect at the reference timestamp (i.e. PST or PDT depending whether Daylight Savings Time is in effect).", + "type": "string", + "readOnly": true + }, + "StandardOffset": { + "description": "UTC offset in effect at the `ReferenceUTCTimestamp`.", + "type": "string", + "readOnly": true + }, + "DaylightSavings": { + "description": "Time saving in minutes in effect at the `ReferenceUTCTimestamp`.", + "type": "string", + "readOnly": true + }, + "WallTime": { + "description": "Current wall time at the given time zone as shown in the `Tag` property.", + "type": "string", + "readOnly": true + }, + "PosixTzValidYear": { + "description": "The year this POSIX string is valid for. Note: A POSIX string will only be valid in the given year.", + "type": "integer", + "readOnly": true + }, + "PosixTz": { + "description": "POSIX string used to set the time zone environment variable.", + "type": "string", + "readOnly": true + } + } + }, + "ReferenceTimeByCoordinates": { + "description": "Details in effect at the local time.", + "type": "object", + "readOnly": true, + "properties": { + "Tag": { + "description": "Time zone name in effect at the reference timestamp (i.e. PST or PDT depending whether Daylight Savings Time is in effect).", + "type": "string", + "readOnly": true + }, + "StandardOffset": { + "description": "UTC offset in effect at the `ReferenceUTCTimestamp`.", + "type": "string", + "readOnly": true + }, + "DaylightSavings": { + "description": "Time saving in minutes in effect at the `ReferenceUTCTimestamp`.", + "type": "string", + "readOnly": true + }, + "WallTime": { + "description": "Current wall time at the given time zone as shown in the `Tag` property.", + "type": "string", + "readOnly": true + }, + "PosixTzValidYear": { + "description": "The year this POSIX string is valid for. Note: A POSIX string will only be valid in the given year.", + "type": "integer", + "readOnly": true + }, + "PosixTz": { + "description": "POSIX string used to set the time zone environment variable.", + "type": "string", + "readOnly": true + }, + "Sunrise": { + "description": "Sunrise at the given time zone as shown in the `Tag` property.", + "type": "string", + "readOnly": true + }, + "Sunset": { + "description": "Sunset at the given time zone as shown in the `Tag` property.", + "type": "string", + "readOnly": true + } + } + }, + "RepresentativePoint": { + "description": "Representative point property", + "type": "object", + "readOnly": true, + "properties": { + "Latitude": { + "description": "Latitude property", + "type": "number", + "readOnly": true + }, + "Longitude": { + "description": "Longitude property", + "type": "number", + "readOnly": true + } + } + } + } +} diff --git a/specification/maps/data-plane/Timezone/readme.csharp.md b/specification/maps/data-plane/Timezone/readme.csharp.md new file mode 100644 index 000000000000..adbe7fc020dd --- /dev/null +++ b/specification/maps/data-plane/Timezone/readme.csharp.md @@ -0,0 +1,13 @@ +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +sync-methods: None +license-header: MICROSOFT_MIT_NO_VERSION +namespace: Azure.Maps.Timezone +output-folder: $(csharp-sdks-folder)/maps/Azure.Maps.Timezone/src/Generated +clear-output-folder: true +public-clients: true +``` \ No newline at end of file diff --git a/specification/maps/data-plane/Timezone/readme.go.md b/specification/maps/data-plane/Timezone/readme.go.md new file mode 100644 index 000000000000..400d249a239f --- /dev/null +++ b/specification/maps/data-plane/Timezone/readme.go.md @@ -0,0 +1,26 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +license-header: MICROSOFT_MIT_NO_VERSION +namespace: timezone +clear-output-folder: true +export-clients: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: 1.0-preview +``` + +### Tag: 1.0-preview and go + +These settings apply only when `--tag=1.0-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == '1.0-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/maps/1.0/$(namespace) +``` \ No newline at end of file diff --git a/specification/maps/data-plane/Timezone/readme.java.md b/specification/maps/data-plane/Timezone/readme.java.md new file mode 100644 index 000000000000..4745318f640c --- /dev/null +++ b/specification/maps/data-plane/Timezone/readme.java.md @@ -0,0 +1,9 @@ +## Java + +``` yaml $(java) +java: + namespace: com.azure.maps.timezone + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 0 + output-folder: $(azure-libraries-for-java-folder)/azure-maps-timezone +``` \ No newline at end of file diff --git a/specification/maps/data-plane/Timezone/readme.md b/specification/maps/data-plane/Timezone/readme.md new file mode 100644 index 000000000000..acd3dd915a1d --- /dev/null +++ b/specification/maps/data-plane/Timezone/readme.md @@ -0,0 +1,99 @@ +# Azure Timezone + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Timezone Client + +--- + +## Getting Started + +To build the SDK for Timezone, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +### Basic Information + +These are the global settings for Timezone Client. + +``` yaml +title: TimezoneClient +openapi-type: data-plane +tag: 1.0-preview +# at some point those credentials will move away to Swagger according to [this](https://github.com/Azure/autorest/issues/3718) +add-credentials: true +credential-default-policy-type: BearerTokenCredentialPolicy +credential-scopes: https://atlas.microsoft.com/.default +``` + +### Suppression + +``` yaml +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + from: timezone.json + reason: It will break existing clients if we change the name + +``` + + +### Tag: 1.0-preview + +These settings apply only when `--tag=1.0-preview` is specified on the command line. + +``` yaml $(tag) == '1.0-preview' +input-file: + - preview/1.0/timezone.json +``` + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-java + + #track1 doesn't support data-plane for go + #manually generate for now with track2 + #- repo: azure-sdk-for-go + + #track1 doesn't support features needed for typescript + #manually generate for now with track2 + #- repo: azure-sdk-for-js + + #should be azure-sdk-for-net-track2, but SDK has not yet onboarded + #manually generate for now with track2 + - repo: azure-sdk-for-net +``` +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Java + +See configuration in [readme.java.md](./readme.java.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) diff --git a/specification/maps/data-plane/Timezone/readme.python.md b/specification/maps/data-plane/Timezone/readme.python.md new file mode 100644 index 000000000000..627dbb2e2847 --- /dev/null +++ b/specification/maps/data-plane/Timezone/readme.python.md @@ -0,0 +1,22 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +license-header: MICROSOFT_MIT_NO_VERSION +namespace: azure.maps.timezone +package-name: azure-maps-timezone +package-version: 1.0-preview +clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +no-namespace-folders: true +output-folder: $(python-sdks-folder)/maps/azure-maps-timezone/azure/maps/timezone +``` +``` yaml $(python) && $(python-mode) == 'create' +basic-setup-py: true +output-folder: $(python-sdks-folder)/maps/azure-maps-timezone +``` diff --git a/specification/maps/data-plane/Timezone/readme.typescript.md b/specification/maps/data-plane/Timezone/readme.typescript.md new file mode 100644 index 000000000000..57a01a3916ae --- /dev/null +++ b/specification/maps/data-plane/Timezone/readme.typescript.md @@ -0,0 +1,14 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +azure-arm: false +package-name: "@azure/maps-timezone" +license-header: MICROSOFT_MIT_NO_VERSION +output-folder: "$(typescript-sdks-folder)/sdk/maps/maps-timezone" +source-code-folder-path: "" +clear-output-folder: false +generate-metadata: false +``` diff --git a/specification/maps/data-plane/Traffic/preview/1.0/examples/GetTrafficFlowSegment.json b/specification/maps/data-plane/Traffic/preview/1.0/examples/GetTrafficFlowSegment.json new file mode 100644 index 000000000000..fc6142d1769d --- /dev/null +++ b/specification/maps/data-plane/Traffic/preview/1.0/examples/GetTrafficFlowSegment.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "geography": "us", + "api-version": "1.0", + "format": "json", + "style": "absolute", + "zoom": 10, + "query": "52.41072,4.84239" + }, + "responses": { + "200": { + "body": { + "flowSegmentData": { + "frc": "FRC3", + "currentSpeed": 79, + "freeFlowSpeed": 79, + "currentTravelTime": 33, + "freeFlowTravelTime": 33, + "confidence": 0.5, + "coordinates": { + "coordinate": [ + { + "latitude": 52.404648, + "longitude": 4.8442388 + }, + { + "latitude": 52.408447, + "longitude": 4.8357286 + } + ] + }, + "openlr": null, + "@version": "1.0.53-mascoma" + } + } + } + } +} diff --git a/specification/maps/data-plane/Traffic/preview/1.0/examples/GetTrafficFlowTile.json b/specification/maps/data-plane/Traffic/preview/1.0/examples/GetTrafficFlowTile.json new file mode 100644 index 000000000000..aba69f220abe --- /dev/null +++ b/specification/maps/data-plane/Traffic/preview/1.0/examples/GetTrafficFlowTile.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "geography": "us", + "api-version": "1.0", + "format": "png", + "style": "absolute", + "zoom": 12, + "x": 2044, + "y": 1360 + }, + "responses": { + "200": { + "body": "binary string image" + } + } +} diff --git a/specification/maps/data-plane/Traffic/preview/1.0/examples/GetTrafficIncidentDetail.json b/specification/maps/data-plane/Traffic/preview/1.0/examples/GetTrafficIncidentDetail.json new file mode 100644 index 000000000000..45d2368fe3e3 --- /dev/null +++ b/specification/maps/data-plane/Traffic/preview/1.0/examples/GetTrafficIncidentDetail.json @@ -0,0 +1,338 @@ +{ + "parameters": { + "geography": "us", + "api-version": "1.0", + "format": "json", + "style": "s3", + "boundingbox": "6841263.950712,511972.674418,6886056.049288,582676.925582", + "boundingZoom": 11, + "trafficmodelid": "1335294634919" + }, + "responses": { + "200": { + "body": { + "tm": { + "@id": "1521671948910", + "poi": [ + { + "id": "europe_HD_NL_TTR116377227776064", + "p": { + "x": 538636.9, + "y": 6842004.5 + }, + "ic": 9, + "ty": 1, + "cs": 0, + "d": "roadworks", + "c": "new roadworks layout", + "f": "Amstelveen/Vinkeveen - N201 (N196)", + "t": "Uithoorn-Centrum (N196)", + "l": 220, + "dl": 14, + "r": "N196" + }, + { + "id": "europe_CLUSTER_11_-34959639", + "p": { + "x": 528668.6, + "y": 6848897.9 + }, + "ic": 8, + "ty": 0, + "cbl": { + "x": 528622.5, + "y": 6848661.2 + }, + "ctr": { + "x": 528714.7, + "y": 6849134.6 + }, + "cs": 2, + "l": 190 + }, + { + "id": "europe_CLUSTER_11_-1540737434", + "p": { + "x": 518277, + "y": 6852206.8 + }, + "ic": 9, + "ty": 1, + "cbl": { + "x": 517421.3, + "y": 6851776.4 + }, + "ctr": { + "x": 519132.8, + "y": 6852637.2 + }, + "cs": 2, + "l": 1620 + }, + { + "id": "europe_CLUSTER_11_-26712906", + "p": { + "x": 529902.2, + "y": 6855622.4 + }, + "ic": 8, + "ty": 0, + "cbl": { + "x": 529524.6, + "y": 6855377.2 + }, + "ctr": { + "x": 530279.9, + "y": 6855867.7 + }, + "cs": 4, + "l": 660 + }, + { + "id": "europe_HD_NL_TTR116367997504816", + "p": { + "x": 568216, + "y": 6851287.6 + }, + "ic": 9, + "ty": 1, + "cs": 0, + "d": "roadworks", + "c": "new roadworks layout", + "f": "Ankeveen (N236)", + "t": "Weesp (N236)", + "l": 2760, + "dl": 73, + "r": "N236" + }, + { + "id": "europe_HD_NL_TTR116367997261488", + "p": { + "x": 561973.7, + "y": 6854259.4 + }, + "ic": 9, + "ty": 3, + "cs": 0, + "d": "roadworks", + "c": "new roadworks layout", + "f": "Weesp (N236)", + "t": "Ankeveen (N236)", + "l": 2650, + "r": "N236" + }, + { + "id": "europe_HD_NL_TTR116331064819392", + "p": { + "x": 571268.5, + "y": 6858435.4 + }, + "ic": 8, + "ty": 4, + "cs": 0, + "d": "closed", + "f": "IJsselmeerweg", + "t": "A6", + "l": 370 + }, + { + "id": "europe_CLUSTER_11_-1442937814", + "p": { + "x": 563934, + "y": 6859271.3 + }, + "ic": 9, + "ty": 1, + "cbl": { + "x": 563726.1, + "y": 6859250.4 + }, + "ctr": { + "x": 564141.9, + "y": 6859292.2 + }, + "cs": 2, + "l": 460 + }, + { + "id": "europe_CLUSTER_11_258400781", + "p": { + "x": 558055.6, + "y": 6861147.1 + }, + "ic": 13, + "ty": 1, + "cbl": { + "x": 557493.3, + "y": 6860514.8 + }, + "ctr": { + "x": 558618, + "y": 6861779.4 + }, + "cs": 3, + "l": 1030 + }, + { + "id": "europe_HD_NL_TTR116100227865681", + "p": { + "x": 542665, + "y": 6861959.7 + }, + "ic": 8, + "ty": 4, + "cs": 0, + "d": "closed", + "f": "Strawinskylaan", + "t": "Matthijs Vermeulenpad", + "l": 110 + }, + { + "id": "europe_CLUSTER_11_1438243625", + "p": { + "x": 545058.7, + "y": 6864571.6 + }, + "ic": 8, + "ty": 0, + "cbl": { + "x": 543779.5, + "y": 6864070.7 + }, + "ctr": { + "x": 546337.8, + "y": 6865072.6 + }, + "cs": 5, + "l": 1590 + }, + { + "id": "europe_HD_NL_TTR116081762316976", + "p": { + "x": 547507.8, + "y": 6866259.3 + }, + "ic": 8, + "ty": 4, + "cs": 0, + "d": "closed", + "f": "Alexanderplein (s113)", + "t": "Stadhouderskade", + "l": 390, + "r": "S100" + }, + { + "id": "europe_CLUSTER_11_691732516", + "p": { + "x": 541448.7, + "y": 6867162.1 + }, + "ic": 8, + "ty": 0, + "cbl": { + "x": 541160.1, + "y": 6866710.7 + }, + "ctr": { + "x": 541737.2, + "y": 6867613.5 + }, + "cs": 4, + "l": 430 + }, + { + "id": "europe_CLUSTER_11_1582351486", + "p": { + "x": 534709.6, + "y": 6865174.7 + }, + "ic": 8, + "ty": 0, + "cbl": { + "x": 534562.2, + "y": 6865025.3 + }, + "ctr": { + "x": 534856.9, + "y": 6865324.2 + }, + "cs": 2, + "l": 380 + }, + { + "id": "europe_CLUSTER_11_-2070222267", + "p": { + "x": 536813.1, + "y": 6868188.3 + }, + "ic": 8, + "ty": 0, + "cbl": { + "x": 536191.1, + "y": 6867699.7 + }, + "ctr": { + "x": 537435.1, + "y": 6868677 + }, + "cs": 7, + "l": 1380 + }, + { + "id": "europe_CLUSTER_11_-496866890", + "p": { + "x": 516025.5, + "y": 6871606.3 + }, + "ic": 8, + "ty": 0, + "cbl": { + "x": 514115.1, + "y": 6870216.9 + }, + "ctr": { + "x": 517935.9, + "y": 6872995.7 + }, + "cs": 7, + "l": 1510 + }, + { + "id": "europe_HD_NL_TTR115675492352160", + "p": { + "x": 517835.3, + "y": 6883216.3 + }, + "ic": 8, + "ty": 4, + "cs": 0, + "d": "closed", + "f": "Amsterdamseweg", + "t": "A22", + "l": 710 + }, + { + "id": "europe_CLUSTER_11_834920993", + "p": { + "x": 543803.8, + "y": 6875659.8 + }, + "ic": 8, + "ty": 0, + "cbl": { + "x": 543474.7, + "y": 6875602.7 + }, + "ctr": { + "x": 544133, + "y": 6875716.9 + }, + "cs": 2, + "l": 760 + } + ] + } + } + } + } +} diff --git a/specification/maps/data-plane/Traffic/preview/1.0/examples/GetTrafficIncidentTile.json b/specification/maps/data-plane/Traffic/preview/1.0/examples/GetTrafficIncidentTile.json new file mode 100644 index 000000000000..e36448b48f16 --- /dev/null +++ b/specification/maps/data-plane/Traffic/preview/1.0/examples/GetTrafficIncidentTile.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "geography": "us", + "api-version": "1.0", + "format": "png", + "style": "night", + "zoom": 10, + "x": 175, + "y": 408 + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/maps/data-plane/Traffic/preview/1.0/examples/GetTrafficIncidentViewport.json b/specification/maps/data-plane/Traffic/preview/1.0/examples/GetTrafficIncidentViewport.json new file mode 100644 index 000000000000..231a3b4700ca --- /dev/null +++ b/specification/maps/data-plane/Traffic/preview/1.0/examples/GetTrafficIncidentViewport.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "geography": "us", + "api-version": "1.0", + "format": "json", + "boundingbox": "-939584.4813015489,-23954526.723651607,14675583.153020501,25043442.895825107", + "boundingzoom": 2, + "overviewbox": "-939584.4813018347,-23954526.723651607,14675583.153020501,25043442.8958229083", + "overviewzoom": 2, + "copyright": true + }, + "responses": { + "200": { + "body": { + "viewpResp": { + "trafficState": { + "@trafficAge": 18895, + "@trafficModelId": "1504808593298" + }, + "copyrightIds": "© 2017 GeoSmart^© 2017 TomTom^© 2017 Whereis", + "@version": "1.0.51-mascoma", + "@maps": "europe,taiwan,latam,northamerica,israel,middleeast,iraq,guam,australia,newzealand,india,africa,world,southeastasia" + } + } + } + } +} diff --git a/specification/maps/data-plane/Traffic/preview/1.0/traffic.json b/specification/maps/data-plane/Traffic/preview/1.0/traffic.json new file mode 100644 index 000000000000..55d16316e516 --- /dev/null +++ b/specification/maps/data-plane/Traffic/preview/1.0/traffic.json @@ -0,0 +1,900 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Traffic Service", + "version": "1.0", + "description": "Azure Maps Traffic REST APIs" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{geography}.atlas.microsoft.com", + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "AzureKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "AzureKey": [] + } + ], + "responses": {}, + "parameters": { + "TrafficApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API.", + "type": "string", + "in": "query", + "required": true, + "default": "1.0", + "x-ms-parameter-location": "client" + }, + "TileFormat": { + "name": "format", + "description": "Desired format of the response. Possible values are png & pbf.", + "type": "string", + "in": "path", + "required": true, + "enum": [ + "png", + "pbf" + ], + "x-ms-enum": { + "name": "TileFormat", + "modelAsString": true, + "values": [ + { + "value": "png", + "description": "An image in the png format. Supports zoom levels 0 through 18." + }, + { + "value": "pbf", + "description": "Vector graphic in the pbf format. Supports zoom levels 0 through 22." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "RasterZoom": { + "name": "zoom", + "in": "query", + "description": "Zoom level for the desired tile. Zoom value must be in the range: 0-22 (inclusive).\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.", + "required": true, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "RasterVectorZoom": { + "name": "zoom", + "in": "query", + "description": "Zoom level for the desired tile. For _raster_ tiles, value must be in the range: 0-22 (inclusive). For _vector_ tiles, value must be in the range: 0-22 (inclusive).\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.", + "required": true, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/traffic/flow/tile/{format}": { + "get": { + "description": "__Traffic Flow Tile__\n\n\n**Applies to**: S0 and S1 pricing tiers.\n\nThe Azure Flow Tile API serves 256 x 256 pixel tiles showing traffic flow. All tiles use the same grid system. Because the traffic tiles use transparent images, they can be layered on top of map tiles to create a compound display. The Flow tiles use colors to indicate either the speed of traffic on different road segments, or the difference between that speed and the free-flow speed on the road segment in question.", + "operationId": "Traffic_GetTrafficFlowTile", + "x-ms-examples": { + "GetTrafficFlowTile": { + "$ref": "./examples/GetTrafficFlowTile.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/TrafficApiVersion" + }, + { + "$ref": "#/parameters/TileFormat" + }, + { + "name": "style", + "in": "query", + "description": "

    The style to be used to render the tile.

    ", + "required": true, + "type": "string", + "enum": [ + "absolute", + "relative", + "relative-delay", + "reduced-sensitivity" + ], + "x-ms-enum": { + "name": "TrafficFlowTileStyle", + "modelAsString": true, + "values": [ + { + "value": "absolute", + "description": "Colors will reflect the absolute speed measured. Absolute speed is the capability to access the full speed." + }, + { + "value": "relative", + "description": "This is the speed relative to free-flow, highlighting areas of congestion visualizing the traffic flow. Free-flow refers to conditions where there is no congestion and traffic can follow the speed limits. The most used option to visualize traffic flow on a map." + }, + { + "value": "relative-delay", + "description": "Displays relative colors only where they are different from the free-flow speeds. This option will only highlights areas of congestion." + }, + { + "value": "reduced-sensitivity", + "description": "Displays relative colors but a larger difference from freeflow is required for segments to change the color. This mode only valid when format is png." + } + ] + } + }, + { + "$ref": "#/parameters/RasterVectorZoom" + }, + { + "$ref": "../../../Render/preview/1.0/render.json#/parameters/xTileIndex" + }, + { + "$ref": "../../../Render/preview/1.0/render.json#/parameters/yTileIndex" + }, + { + "name": "thickness", + "in": "query", + "description": "The value of the width of the line representing traffic. This value is a multiplier and the accepted values range from 1 - 20. The default value is 10. This parameter is not valid when format is pbf.", + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 20 + } + ], + "produces": [ + "application/json", + "image/jpeg", + "image/png", + "image/pbf", + "application/vnd.mapbox-vector-tile" + ], + "responses": { + "200": { + "description": "This image is returned from a successful Traffic Flow Tile call", + "schema": { + "type": "object", + "format": "file", + "readOnly": true + }, + "headers": { + "Content-Type": { + "type": "string", + "description": "The content-type for the response." + } + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/traffic/flow/segment/{format}": { + "get": { + "description": "__Traffic Flow Segment__\n\n\n**Applies to**: S0 and S1 pricing tiers.\n\nThis service provides information about the speeds and travel times of the road fragment closest to the given coordinates. It is designed to work alongside the Flow layer of the Render Service to support clickable flow data visualizations. With this API, the client side can connect any place in the map with flow data on the closest road and present it to the user.", + "operationId": "Traffic_GetTrafficFlowSegment", + "x-ms-examples": { + "GetTrafficFlowSegment": { + "$ref": "./examples/GetTrafficFlowSegment.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/TrafficApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/TextFormat" + }, + { + "name": "style", + "in": "query", + "description": "The style to be used to render the tile. Valid values are absolute which returns colors reflecting the absolute speed measured, relative which returns the speed relative to free-flow, Relative-delay which displays relative speeds only where they are different from the freeflow speeds", + "required": true, + "type": "string", + "enum": [ + "absolute", + "relative", + "relative-delay" + ], + "x-ms-enum": { + "name": "TrafficFlowSegmentStyle", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/RasterZoom" + }, + { + "name": "query", + "in": "query", + "description": "Coordinates of the point close to the road segment. They have to be comma-separated and calculated using EPSG4326 projection.", + "required": true, + "type": "string" + }, + { + "name": "unit", + "in": "query", + "description": "Unit of speed in KMPH or MPH", + "type": "string", + "enum": [ + "KMPH", + "MPH" + ], + "x-ms-enum": { + "name": "SpeedUnit", + "modelAsString": true, + "values": [ + { + "value": "KMPH", + "description": "Kilometers Per Hour" + }, + { + "value": "MPH", + "description": "Miles Per Hour" + } + ] + } + }, + { + "name": "thickness", + "in": "query", + "description": "The value of the width of the line representing traffic. This value is a multiplier and the accepted values range from 1 - 20. The default value is 10.", + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 20 + }, + { + "name": "openLr", + "in": "query", + "description": "Boolean on whether the response should include OpenLR code", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrafficFlowSegmentResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/traffic/incident/tile/{format}": { + "get": { + "description": "__Traffic Incident Tile__\n\n\n**Applies to**: S0 and S1 pricing tiers.\n\nThis service serves 256 x 256 pixel tiles showing traffic incidents. All tiles use the same grid system. Because the traffic tiles use transparent images, they can be layered on top of map tiles to create a compound display. Traffic tiles render graphics to indicate traffic on the roads in the specified area.", + "operationId": "Traffic_GetTrafficIncidentTile", + "x-ms-examples": { + "GetTrafficIncidentTile": { + "$ref": "./examples/GetTrafficIncidentTile.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/TrafficApiVersion" + }, + { + "$ref": "#/parameters/TileFormat" + }, + { + "name": "style", + "in": "query", + "description": "The style to be used to render the tile. This parameter is not valid when format is pbf.", + "required": true, + "type": "string", + "enum": [ + "s1", + "s2", + "s3", + "night" + ], + "x-ms-enum": { + "name": "TrafficIncidentTileStyle", + "modelAsString": true, + "values": [ + { + "value": "s1", + "description": "Creates traffic lines with colored chevrons indicating severity." + }, + { + "value": "s2", + "description": "Creates plain lines with certain degree of glow." + }, + { + "value": "s3", + "description": "Creates plain lines with certain degree of glow." + }, + { + "value": "night", + "description": "Night style." + } + ] + } + }, + { + "$ref": "#/parameters/RasterVectorZoom" + }, + { + "$ref": "../../../Render/preview/1.0/render.json#/parameters/xTileIndex" + }, + { + "$ref": "../../../Render/preview/1.0/render.json#/parameters/yTileIndex" + }, + { + "name": "t", + "x-ms-client-name": "trafficState", + "in": "query", + "description": "Reference value for the state of traffic at a particular time, obtained from the Viewport API call, trafficModelId attribute in trafficState field. It is updated every minute, and is valid for two minutes before it times out. Use -1 to get the most recent traffic information. Default: most recent traffic information.", + "type": "string" + } + ], + "produces": [ + "application/json", + "image/jpeg", + "image/png", + "image/pbf", + "application/vnd.mapbox-vector-tile" + ], + "responses": { + "200": { + "description": "This object is returned from a successful Traffic Incident Tile call", + "schema": { + "type": "object", + "format": "file", + "readOnly": true + }, + "headers": { + "Content-Type": { + "type": "string", + "description": "The content-type for the response." + } + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/traffic/incident/detail/{format}": { + "get": { + "description": "__Traffic Incident Detail__ \n\n\n\n**Applies to**: S0 and S1 pricing tiers.\n\nThis API provides information on traffic incidents inside a given bounding box, based on the current Traffic Model ID. The Traffic Model ID is available to grant synchronization of data between calls and API's. The Traffic Model ID is a key value for determining the currency of traffic incidents. It is updated every minute, and is valid for two minutes before it times out. It is used in rendering [incident tiles](https://docs.microsoft.com/en-us/rest/api/maps/traffic/gettrafficincidenttile). It can be obtained from the [Viewport API](https://docs.microsoft.com/en-us/rest/api/maps/traffic/gettrafficincidentviewport).", + "operationId": "Traffic_GetTrafficIncidentDetail", + "x-ms-examples": { + "GetTrafficIncidentDetail": { + "$ref": "./examples/GetTrafficIncidentDetail.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/TrafficApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/TextFormat" + }, + { + "name": "style", + "in": "query", + "description": "The style that will be used to render the tile in Traffic [Incident Tile API](https://docs.microsoft.com/en-us/rest/api/maps/traffic/gettrafficincidenttile). This will have an effect on the coordinates of traffic incidents in the reply.", + "required": true, + "type": "string", + "enum": [ + "s1", + "s2", + "s3", + "night" + ], + "x-ms-enum": { + "name": "TrafficIncidentDetailStyle", + "modelAsString": true, + "values": [ + { + "value": "s1", + "description": "Creates traffic lines with colored chevrons indicating severity." + }, + { + "value": "s2", + "description": "Creates plain lines with certain degree of glow." + }, + { + "value": "s3", + "description": "Creates plain lines with certain degree of glow." + }, + { + "value": "night", + "description": "Night style." + } + ] + } + }, + { + "name": "boundingbox", + "in": "query", + "description": "The `boundingbox` is represented by two value pairs describing it's corners (first pair for lower left corner and second for upper right). The pairs can either be specified using any of the `projection`'s specified below (e.g., _minY,minX,maxY,maxX_) or by two latitude-longitude pairs (e.g., _minLat,minLon,maxLat,maxLon_).

    NOTE: If latitude/longitude pairs are used, then the `projection` parameter must be set to \"EPSG4326\".", + "required": true, + "type": "string" + }, + { + "name": "boundingZoom", + "in": "query", + "description": "Zoom level for desired tile. 0 to 22 for raster tiles, 0 through 22 for vector tiles", + "required": true, + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 22 + }, + { + "name": "trafficmodelid", + "in": "query", + "description": "Number referencing traffic model. This can be obtained from the [Viewport API](https://docs.microsoft.com/en-us/rest/api/maps/traffic/gettrafficincidentviewport). It is updated every minute, and is valid for two minutes before it times out. If the wrong Traffic Model ID is specified, the correct one will be returned by the interface. A value of -1 will always invoke the most recent traffic model", + "required": true, + "type": "string" + }, + { + "name": "language", + "in": "query", + "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for the output language. Supported languages are ar, ca, cs, da, de, el, en, en-GB, en-US, es, et, fi, fr, he, hu, id, in*, it, lt, lv, nb, nl, no, pl, pt, ro, ru, sk, sv, th, tr, zh.\n\nPlease refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details. When invalid language code is provided response is returned in English. When incident cause or description does not have translation, English description is returned.", + "type": "string" + }, + { + "name": "projection", + "in": "query", + "description": "The projection used to specify the coordinates in the request and response. [EPSG900913](http://docs.openlayers.org/library/spherical_mercator.html) (default) or [EPSG4326](http://spatialreference.org/ref/epsg/4326/)", + "type": "string", + "enum": [ + "EPSG900913", + "EPSG4326" + ], + "x-ms-enum": { + "name": "ProjectionStandard", + "modelAsString": true, + "values": [ + { + "value": "EPSG900913", + "description": "[EPSG900913](http://docs.openlayers.org/library/spherical_mercator.html)" + }, + { + "value": "EPSG4326", + "description": "[EPSG4326](http://spatialreference.org/ref/epsg/4326/)" + } + ] + } + }, + { + "name": "geometries", + "in": "query", + "description": "The type of vector geometry added to incidents (returned in the element of the response).", + "type": "string", + "enum": [ + "original", + "shifted" + ], + "x-ms-enum": { + "name": "IncidentGeometryType", + "modelAsString": true, + "values": [ + { + "value": "original", + "description": "Places incidents precisely on the road." + }, + { + "value": "shifted", + "description": "Moves the incident slightly (depending on zoom level) to indicate specific road lanes." + } + ] + } + }, + { + "name": "expandCluster", + "in": "query", + "description": "Boolean to indicate whether to list all traffic incidents in a cluster separately", + "type": "boolean" + }, + { + "name": "originalPosition", + "in": "query", + "description": "Boolean on whether to return the original position of the incident () as well as the one shifted to the beginning of the traffic tube ()", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrafficIncidentDetailResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/traffic/incident/viewport/{format}": { + "get": { + "description": "__Traffic Incident Viewport__\n\n\n**Applies to**: S0 and S1 pricing tiers.\n\nThis API returns legal and technical information for the viewport described in the request. It should be called by client applications whenever the viewport changes (for instance, through zooming, panning, going to a location, or displaying a route). The request should contain the bounding box and zoom level of the viewport whose information is needed. The return will contain map version information, as well as the current Traffic Model ID and copyright IDs. The Traffic Model ID returned by the Viewport Description is used by other APIs to retrieve last traffic information for further processing.", + "operationId": "Traffic_GetTrafficIncidentViewport", + "x-ms-examples": { + "GetTrafficIncidentViewport": { + "$ref": "./examples/GetTrafficIncidentViewport.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/TrafficApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/TextFormat" + }, + { + "name": "boundingbox", + "in": "query", + "description": "Bounding box of the map viewport in [EPSG900913](http://docs.openlayers.org/library/spherical_mercator.html) projection. The `boundingbox` is represented by two value pairs describing it's corners (first pair for lower left corner and second for upper right). All values should be separated by commas (e.g., _minY,minX,maxY,maxX_). The maximum size of the bounding box that can be passed is dependent on the requested zoom level. The width and height cannot exceed 4092 pixels when rendered on the given zoom level.

    NOTE: Bounding boxes that cross the 180° meridian require special treatment. For such boxes, the eastern _maxX_ value will be negative, and thus less than the _minX_ value west of the 180° meridian. To address that, the value 40075016.6855874 should be added to the true _maxX_ value before it is passed in the request.", + "required": true, + "type": "string" + }, + { + "name": "boundingzoom", + "in": "query", + "description": "Zoom level of the map viewport. Used to determine whether the view can be zoomed in.", + "required": true, + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 22 + }, + { + "name": "overviewbox", + "in": "query", + "description": "Bounding box of the overview map in [EPSG900913](http://docs.openlayers.org/library/spherical_mercator.html) projection.

    Used in case the overview box/mini map has different copyright data than the main map. If there is no mini map, the same coordinates as `boundingBox` is used.", + "required": true, + "type": "string" + }, + { + "name": "overviewzoom", + "in": "query", + "description": "Zoom level of the overview map. If there is no mini map, use the same zoom level as boundingZoom.", + "required": true, + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 22 + }, + { + "name": "copyright", + "in": "query", + "description": "Determines what copyright information to return. When true the copyright text is returned; when false only the copyright index is returned.", + "type": "boolean", + "default": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrafficIncidentViewportResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + } + }, + "definitions": { + "TrafficFlowSegmentResult": { + "description": "This object is returned from a successful Traffic Flow Segment call", + "type": "object", + "properties": { + "flowSegmentData": { + "description": "Flow Segment Data property", + "type": "object", + "readOnly": true, + "properties": { + "frc": { + "description": "Functional Road Class. This indicates the road type:\n 0: Motorway, freeway or other major road.\n 1: Major road, less important than a motorway.\n 2: Other major road.\n 3: Secondary road.\n 4: Local connecting road.\n 5: Local road of high importance.\n 6: Local road.", + "type": "string", + "readOnly": true + }, + "currentSpeed": { + "description": "The current average speed at the selected point, in the units requested. This is calculated from the currentTravelTime and the length of the selected segment.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "freeFlowSpeed": { + "description": "The free flow speed expected under ideal conditions, expressed in the units requested. This is related to the freeFlowTravelTime.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "currentTravelTime": { + "description": "Current travel time in seconds based on fused real-time measurements between the defined locations in the specified direction.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "freeFlowTravelTime": { + "description": "The travel time in seconds which would be expected under ideal free flow conditions.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "confidence": { + "description": "The confidence is a measure of the quality of the provided travel time and speed. A value of 1 means full confidence, that the response contains the highest quality data. Lower values indicate the degree that the response may vary from the actual conditions on the road. Any value greater than 0.6 means the information was based on real-time probe input. A value of 0.5 means the reported speed is based on historical info. A value between 0.5 and 0.6 has a calculated weighted average between historical and live speeds.", + "type": "number", + "readOnly": true + }, + "coordinates": { + "description": "Includes the coordinates describing the shape of the segment. Coordinates are shifted from the road depending on the zoom level to support high quality visualization in every scale.", + "type": "object", + "properties": { + "coordinate": { + "description": "Coordinate array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/CoordinatesPair" + } + } + } + }, + "@version": { + "description": "This indicates the software version that generated the response.", + "type": "string", + "readOnly": true + }, + "openlr": { + "description": "OpenLR code for segment", + "type": "number", + "readOnly": true + } + } + } + } + }, + "TrafficIncidentDetailResult": { + "description": "This object is returned from a successful Traffic incident Detail call", + "type": "object", + "properties": { + "tm": { + "description": "Main response element", + "type": "object", + "readOnly": true, + "properties": { + "@id": { + "description": "ID of the traffic incident", + "type": "string", + "readOnly": true + }, + "poi": { + "description": "A single traffic incident, or a cluster of traffic incidents", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TrafficIncidentPoi" + } + } + } + } + } + }, + "TrafficIncidentPoi": { + "type": "object", + "readOnly": true, + "properties": { + "id": { + "description": "ID of the traffic incident", + "type": "string", + "readOnly": true + }, + "p": { + "description": "The point where an icon of the cluster or raw incident should be drawn, expressed in the requested projection. This is affected by traffic style, zoom level and road type", + "type": "object", + "readOnly": true, + "properties": { + "x": { + "description": "x coordinate", + "type": "number", + "readOnly": true + }, + "y": { + "description": "y coordinate", + "type": "number", + "readOnly": true + } + } + }, + "ic": { + "description": "The icon category associated with this incident. Values are numbers in the range 0-13, with the following meanings -- 0: Unknown, 1: Accident, 2: Fog, 3: Dangerous Conditions, 4: Rain, 5: Ice, 6: Jam, 7: Lane Closed, 8: Road Closed, 9: Road Works, 10: Wind, 11: Flooding, 12: Detour, 13: Cluster", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "ty": { + "description": "The magnitude of delay associated with incident. These values correspond to incident colors in the traffic tiles", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "cbl": { + "description": "Bottom left coordinate of the cluster in the projection of the request", + "type": "object", + "readOnly": true, + "properties": { + "x": { + "description": "x coordinate", + "type": "number", + "readOnly": true + }, + "y": { + "description": "y coordinate", + "type": "number", + "readOnly": true + } + } + }, + "ctr": { + "description": "Top right coordinate of the cluster in the projection of the request", + "type": "object", + "readOnly": true, + "properties": { + "x": { + "description": "x coordinate", + "type": "number", + "readOnly": true + }, + "y": { + "description": "y coordinate", + "type": "number", + "readOnly": true + } + } + }, + "cs": { + "description": "Cluster size: the number of incidents in the cluster", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "l": { + "description": "Length of the incident in meters", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "r": { + "description": "The road number(s) affected by the incident. Multiple road numbers will delimited by slashes", + "type": "string", + "readOnly": true + }, + "dl": { + "description": "Delay caused by the incident in seconds (except in road closures)", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "t": { + "description": "To: the name of the intersection or location where the traffic due to the incident ends", + "type": "string", + "readOnly": true + }, + "f": { + "description": "From: the name of the intersection or location where the traffic due to the incident starts", + "type": "string", + "readOnly": true + }, + "d": { + "description": "Description of the incident in the language requested", + "type": "string", + "readOnly": true + }, + "c": { + "description": "Cause of the incident, where available, in the language requested", + "type": "string", + "readOnly": true + } + } + }, + "TrafficIncidentViewportResult": { + "description": "This object is returned from a successful Traffic Incident Viewport call", + "type": "object", + "properties": { + "viewpResp": { + "description": "Viewport Response object", + "type": "object", + "readOnly": true, + "properties": { + "trafficState": { + "description": "Traffic State array", + "type": "object", + "readOnly": true, + "properties": { + "@trafficAge": { + "description": "@Traffic Age property", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "@trafficModelId": { + "description": "@Traffic Model Id property", + "type": "string", + "readOnly": true + } + } + }, + "copyrightIds": { + "description": "Copyright Ids property", + "type": "string", + "readOnly": true + }, + "@version": { + "description": "@Version property", + "type": "string", + "readOnly": true + }, + "@maps": { + "description": "@maps property", + "type": "string", + "readOnly": true + } + } + } + } + } + } +} diff --git a/specification/maps/data-plane/Traffic/readme.csharp.md b/specification/maps/data-plane/Traffic/readme.csharp.md new file mode 100644 index 000000000000..8f227f4502ec --- /dev/null +++ b/specification/maps/data-plane/Traffic/readme.csharp.md @@ -0,0 +1,13 @@ +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +sync-methods: None +license-header: MICROSOFT_MIT_NO_VERSION +namespace: Azure.Maps.Traffic +output-folder: $(csharp-sdks-folder)/maps/Azure.Maps.Traffic/src/Generated +clear-output-folder: true +public-clients: true +``` \ No newline at end of file diff --git a/specification/maps/data-plane/Traffic/readme.go.md b/specification/maps/data-plane/Traffic/readme.go.md new file mode 100644 index 000000000000..87296d917896 --- /dev/null +++ b/specification/maps/data-plane/Traffic/readme.go.md @@ -0,0 +1,26 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +license-header: MICROSOFT_MIT_NO_VERSION +namespace: traffic +clear-output-folder: true +export-clients: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: 1.0-preview +``` + +### Tag: 1.0-preview and go + +These settings apply only when `--tag=1.0-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == '1.0-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/maps/1.0/$(namespace) +``` \ No newline at end of file diff --git a/specification/maps/data-plane/Traffic/readme.java.md b/specification/maps/data-plane/Traffic/readme.java.md new file mode 100644 index 000000000000..3003e18b3b82 --- /dev/null +++ b/specification/maps/data-plane/Traffic/readme.java.md @@ -0,0 +1,9 @@ +## Java + +``` yaml $(java) +java: + namespace: com.azure.maps.traffic + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 0 + output-folder: $(azure-libraries-for-java-folder)/azure-maps-traffic +``` \ No newline at end of file diff --git a/specification/maps/data-plane/Traffic/readme.md b/specification/maps/data-plane/Traffic/readme.md new file mode 100644 index 000000000000..4c3ccde25e11 --- /dev/null +++ b/specification/maps/data-plane/Traffic/readme.md @@ -0,0 +1,89 @@ +# Azure Traffic + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Traffic Client + +--- + +## Getting Started + +To build the SDK for Traffic, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +### Basic Information + +These are the global settings for Traffic Client. + +``` yaml +title: TrafficClient +openapi-type: data-plane +tag: 1.0-preview +# at some point those credentials will move away to Swagger according to [this](https://github.com/Azure/autorest/issues/3718) +add-credentials: true +credential-default-policy-type: BearerTokenCredentialPolicy +credential-scopes: https://atlas.microsoft.com/.default +``` + + +### Tag: 1.0-preview + +These settings apply only when `--tag=1.0-preview` is specified on the command line. + +``` yaml $(tag) == '1.0-preview' +input-file: + - preview/1.0/traffic.json +``` + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-java + + #track1 doesn't support data-plane for go + #manually generate for now with track2 + #- repo: azure-sdk-for-go + + #track1 doesn't support features needed for typescript + #manually generate for now with track2 + #- repo: azure-sdk-for-js + + #should be azure-sdk-for-net-track2, but SDK has not yet onboarded + #manually generate for now with track2 + - repo: azure-sdk-for-net +``` +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Java + +See configuration in [readme.java.md](./readme.java.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) diff --git a/specification/maps/data-plane/Traffic/readme.python.md b/specification/maps/data-plane/Traffic/readme.python.md new file mode 100644 index 000000000000..c633df954c2e --- /dev/null +++ b/specification/maps/data-plane/Traffic/readme.python.md @@ -0,0 +1,22 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +license-header: MICROSOFT_MIT_NO_VERSION +namespace: azure.maps.traffic +package-name: azure-maps-traffic +package-version: 1.0-preview +clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +no-namespace-folders: true +output-folder: $(python-sdks-folder)/maps/azure-maps-traffic/azure/maps/traffic +``` +``` yaml $(python) && $(python-mode) == 'create' +basic-setup-py: true +output-folder: $(python-sdks-folder)/maps/azure-maps-traffic +``` diff --git a/specification/maps/data-plane/Traffic/readme.typescript.md b/specification/maps/data-plane/Traffic/readme.typescript.md new file mode 100644 index 000000000000..27f1e86cab38 --- /dev/null +++ b/specification/maps/data-plane/Traffic/readme.typescript.md @@ -0,0 +1,14 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +azure-arm: false +package-name: "@azure/maps-traffic" +license-header: MICROSOFT_MIT_NO_VERSION +output-folder: "$(typescript-sdks-folder)/sdk/maps/maps-traffic" +source-code-folder-path: "" +clear-output-folder: false +generate-metadata: false +``` diff --git a/specification/maps/data-plane/Weather/preview/1.0/examples/GetCurrentConditions.json b/specification/maps/data-plane/Weather/preview/1.0/examples/GetCurrentConditions.json new file mode 100644 index 000000000000..46c29b7b55af --- /dev/null +++ b/specification/maps/data-plane/Weather/preview/1.0/examples/GetCurrentConditions.json @@ -0,0 +1,180 @@ +{ + "parameters": { + "geography": "us", + "api-version": "1.0", + "format": "json", + "query": "47.641268,-122.125679" + }, + "responses": { + "200": { + "body": { + "results": [ + { + "dateTime": "2019-11-14T15:08:00-08:00", + "phrase": "Cloudy", + "iconCode": 7, + "hasPrecipitation": false, + "isDayTime": true, + "temperature": { + "value": 13.7, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 13.6, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperatureShade": { + "value": 13.6, + "unit": "C", + "unitType": 17 + }, + "relativeHumidity": 75, + "dewPoint": { + "value": 9.2, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 315, + "localizedDescription": "NW" + }, + "speed": { + "value": 3.6, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 4.9, + "unit": "km/h", + "unitType": 7 + } + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "visibility": { + "value": 8, + "unit": "km", + "unitType": 6 + }, + "obstructionsToVisibility": "", + "cloudCover": 95, + "ceiling": { + "value": 4359, + "unit": "m", + "unitType": 5 + }, + "pressure": { + "value": 1014.9, + "unit": "mb", + "unitType": 14 + }, + "pressureTendency": { + "localizedDescription": "Steady", + "code": "S" + }, + "past24HourTemperatureDeparture": { + "value": 1.8, + "unit": "C", + "unitType": 17 + }, + "apparentTemperature": { + "value": 16.1, + "unit": "C", + "unitType": 17 + }, + "windChillTemperature": { + "value": 13.9, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 11.4, + "unit": "C", + "unitType": 17 + }, + "precipitationSummary": { + "pastHour": { + "value": 0.5, + "unit": "mm", + "unitType": 3 + }, + "past3Hours": { + "value": 0.8, + "unit": "mm", + "unitType": 3 + }, + "past6Hours": { + "value": 0.8, + "unit": "mm", + "unitType": 3 + }, + "past9Hours": { + "value": 0.8, + "unit": "mm", + "unitType": 3 + }, + "past12Hours": { + "value": 0.8, + "unit": "mm", + "unitType": 3 + }, + "past18Hours": { + "value": 0.8, + "unit": "mm", + "unitType": 3 + }, + "past24Hours": { + "value": 0.8, + "unit": "mm", + "unitType": 3 + } + }, + "temperatureSummary": { + "past6Hours": { + "minimum": { + "value": 8.3, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 13.7, + "unit": "C", + "unitType": 17 + } + }, + "past12Hours": { + "minimum": { + "value": 5.9, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 13.7, + "unit": "C", + "unitType": 17 + } + }, + "past24Hours": { + "minimum": { + "value": 5.9, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 13.7, + "unit": "C", + "unitType": 17 + } + } + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/preview/1.0/examples/GetDailyForecast.json b/specification/maps/data-plane/Weather/preview/1.0/examples/GetDailyForecast.json new file mode 100644 index 000000000000..70f70f61f1b6 --- /dev/null +++ b/specification/maps/data-plane/Weather/preview/1.0/examples/GetDailyForecast.json @@ -0,0 +1,240 @@ +{ + "parameters": { + "geography": "us", + "api-version": "1.0", + "format": "json", + "query": "62.6490341,30.0734812", + "duration": 5 + }, + "responses": { + "200": { + "body": { + "summary": { + "startDate": "2019-11-17T09:00:00-08:00", + "endDate": "2019-11-17T15:00:00-08:00", + "severity": 5, + "phrase": "Rain Sunday evening", + "category": "rain" + }, + "forecasts": [ + { + "date": "2019-11-13T21:00:00-08:00", + "temperature": { + "minimum": { + "value": 0.8, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 5.3, + "unit": "C", + "unitType": 17 + } + }, + "realFeelTemperature": { + "minimum": { + "value": -3.4, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 1.3, + "unit": "C", + "unitType": 17 + } + }, + "realFeelTemperatureShade": { + "minimum": { + "value": -3.4, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 1.6, + "unit": "C", + "unitType": 17 + } + }, + "hoursOfSun": 1.1, + "degreeDaySummary": { + "heating": { + "value": 15, + "unit": "C", + "unitType": 17 + }, + "cooling": { + "value": 0, + "unit": "C", + "unitType": 17 + } + }, + "airAndPollen": [ + { + "name": "AirQuality", + "value": 0, + "category": "Good", + "categoryValue": 1, + "type": "Ozone" + }, + { + "name": "Grass", + "value": 0, + "category": "Low", + "categoryValue": 1 + }, + { + "name": "Mold", + "value": 0, + "category": "Low", + "categoryValue": 1 + }, + { + "name": "Ragweed", + "value": 0, + "category": "Low", + "categoryValue": 1 + }, + { + "name": "Tree", + "value": 0, + "category": "Low", + "categoryValue": 1 + }, + { + "name": "UVIndex", + "value": 0, + "category": "Low", + "categoryValue": 1 + } + ], + "day": { + "iconCode": 12, + "iconPhrase": "Showers", + "hasPrecipitation": true, + "precipitationType": "Rain", + "precipitationIntensity": "Light", + "shortPhrase": "Cloudy with a few showers", + "longPhrase": "Cloudy with a couple of showers, mainly later", + "precipitationProbability": 75, + "thunderstormProbability": 20, + "rainProbability": 75, + "snowProbability": 40, + "iceProbability": 0, + "wind": { + "direction": { + "degrees": 160, + "localizedDescription": "SSE" + }, + "speed": { + "value": 16.7, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "direction": { + "degrees": 160, + "localizedDescription": "SSE" + }, + "speed": { + "value": 48.2, + "unit": "km/h", + "unitType": 7 + } + }, + "totalLiquid": { + "value": 6.1, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 6.1, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "hoursOfPrecipitation": 3.5, + "hoursOfRain": 3.5, + "hoursOfSnow": 0, + "hoursOfIce": 0, + "cloudCover": 100 + }, + "night": { + "iconCode": 12, + "iconPhrase": "Showers", + "hasPrecipitation": true, + "precipitationType": "Rain", + "precipitationIntensity": "Light", + "shortPhrase": "Breezy early; cloudy", + "longPhrase": "Breezy this evening; otherwise, low clouds", + "precipitationProbability": 65, + "thunderstormProbability": 0, + "rainProbability": 64, + "snowProbability": 40, + "iceProbability": 0, + "wind": { + "direction": { + "degrees": 181, + "localizedDescription": "S" + }, + "speed": { + "value": 20.4, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "direction": { + "degrees": 170, + "localizedDescription": "S" + }, + "speed": { + "value": 42.6, + "unit": "km/h", + "unitType": 7 + } + }, + "totalLiquid": { + "value": 4, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 4, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "hoursOfPrecipitation": 2.5, + "hoursOfRain": 2.5, + "hoursOfSnow": 0, + "hoursOfIce": 0, + "cloudCover": 98 + }, + "sources": [ + "AccuWeather" + ] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/preview/1.0/examples/GetDailyIndices.json b/specification/maps/data-plane/Weather/preview/1.0/examples/GetDailyIndices.json new file mode 100644 index 000000000000..9220885d2504 --- /dev/null +++ b/specification/maps/data-plane/Weather/preview/1.0/examples/GetDailyIndices.json @@ -0,0 +1,207 @@ +{ + "parameters": { + "geography": "us", + "api-version": "1.0", + "format": "json", + "query": "43.84745,-79.37849", + "indexGroupId": 11 + }, + "responses": { + "200": { + "body": { + "results": [ + { + "indexName": "Running Forecast", + "indexId": 1, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 9.2, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "This is an excellent day for outdoor running!" + }, + { + "indexName": "Jogging Forecast", + "indexId": 2, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 9.4, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "Conditions are excellent for jogging outdoors!" + }, + { + "indexName": "Hiking Forecast", + "indexId": 3, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 9.8, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "Conditions are excellent for hiking!" + }, + { + "indexName": "Bicycling Forecast", + "indexId": 4, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 9.9, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "Conditions are excellent for bicycling outdoors!" + }, + { + "indexName": "Golf Weather Forecast", + "indexId": 5, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 10.0, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "This is a great day for golf." + }, + { + "indexName": "Tennis Forecast", + "indexId": 6, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 9.2, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "This is an excellent day for playing tennis!" + }, + { + "indexName": "Skateboarding Forecast", + "indexId": 7, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 9.9, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "This is an excellent day for skateboarding!" + }, + { + "indexName": "Outdoor Concert Forecast", + "indexId": 8, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 9.7, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "Conditions are excellent for attending an outdoor concert!" + }, + { + "indexName": "Kite Flying Forecast", + "indexId": 9, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 8.5, + "category": "Very Good", + "categoryValue": 4, + "ascending": true, + "description": "Conditions are very good today for kite-flying." + }, + { + "indexName": "Beach & Pool Forecast", + "indexId": 10, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 8.6, + "category": "Very Good", + "categoryValue": 4, + "ascending": true, + "description": "Conditons will be very good for a visit to the beach or pool." + }, + { + "indexName": "Sailing Forecast", + "indexId": 11, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 8.3, + "category": "Very Good", + "categoryValue": 4, + "ascending": true, + "description": "Conditions will be very good for sailing." + }, + { + "indexName": "Stargazing Forecast", + "indexId": 12, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 9.5, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "This is a great night to be stargazing!" + }, + { + "indexName": "Fishing Forecast", + "indexId": 13, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 3.5, + "category": "Fair", + "categoryValue": 2, + "ascending": true, + "description": "Expect only fair conditions for fishing." + }, + { + "indexName": "Ski Weather Forecast", + "indexId": 15, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 0.0, + "category": "Poor", + "categoryValue": 1, + "ascending": true, + "description": "Expect poor conditions for skiing." + }, + { + "indexName": "Mosquito Activity Forecast", + "indexId": 17, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 7.0, + "category": "Very High", + "categoryValue": 4, + "ascending": true, + "description": "The weather is favorable for a very high level of mosquito activity. Plan activities and insect repellents accordingly." + }, + { + "indexName": "Hunting Forecast", + "indexId": 20, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 4.5, + "category": "Fair", + "categoryValue": 2, + "ascending": true, + "description": "Expect only fair conditions for hunting." + }, + { + "indexName": "Outdoor Barbecue", + "indexId": 24, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 9.8, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "This is a great day for an outdoor barbecue!" + }, + { + "indexName": "Lawn Mowing Forecast", + "indexId": 28, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 9.6, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "This is a great day for lawn mowing!" + }, + { + "indexName": "Outdoor Activity Forecast", + "indexId": 29, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 8.7, + "category": "Very Good", + "categoryValue": 4, + "ascending": true, + "description": "Conditions will be very good for outdoor activities." + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/preview/1.0/examples/GetHourlyForecast.json b/specification/maps/data-plane/Weather/preview/1.0/examples/GetHourlyForecast.json new file mode 100644 index 000000000000..7f4150359173 --- /dev/null +++ b/specification/maps/data-plane/Weather/preview/1.0/examples/GetHourlyForecast.json @@ -0,0 +1,1013 @@ +{ + "parameters": { + "geography": "us", + "api-version": "1.0", + "format": "json", + "query": "47.632346,-122.138874", + "duration": 12 + }, + "responses": { + "200": { + "body": { + "forecasts": [ + { + "date": "2019-11-14T16:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": true, + "temperature": { + "value": 13.4, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 14.1, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 10.9, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 8.4, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 311, + "localizedDescription": "NW" + }, + "speed": { + "value": 3.7, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 5.6, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 72, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 100, + "ceiling": { + "value": 3901, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 39, + "rainProbability": 39, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-14T17:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 12.5, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 12.8, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 10.2, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 7.8, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 281, + "localizedDescription": "W" + }, + "speed": { + "value": 5.6, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 7.4, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 73, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 94, + "ceiling": { + "value": 4054, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 34, + "rainProbability": 34, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-14T18:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 11.3, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 11.3, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 9.5, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 7.4, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 206, + "localizedDescription": "SSW" + }, + "speed": { + "value": 7.4, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 77, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 94, + "ceiling": { + "value": 4176, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 29, + "rainProbability": 29, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-14T19:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 10.4, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 9.8, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 8.8, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 7, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 169, + "localizedDescription": "S" + }, + "speed": { + "value": 7.4, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 11.1, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 79, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 93, + "ceiling": { + "value": 4542, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 20, + "rainProbability": 20, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-14T20:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 10.1, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 9.2, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 8.6, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 6.9, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 170, + "localizedDescription": "S" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 11.1, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 80, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 92, + "ceiling": { + "value": 4389, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 20, + "rainProbability": 20, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-14T21:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 10.1, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 9, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 8.8, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 7.1, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 170, + "localizedDescription": "S" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 13, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 82, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 91, + "ceiling": { + "value": 4481, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 20, + "rainProbability": 20, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-14T22:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 9.8, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 8.5, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 8.6, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 7.2, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 174, + "localizedDescription": "S" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 13, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 84, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 92, + "ceiling": { + "value": 4481, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 20, + "rainProbability": 20, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-14T23:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 9.8, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 8.5, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 8.5, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 7, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 175, + "localizedDescription": "S" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 13, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 82, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 94, + "ceiling": { + "value": 3688, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 20, + "rainProbability": 20, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-15T00:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 10.1, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 8.8, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 8.6, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 6.9, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 176, + "localizedDescription": "S" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 13, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 81, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 97, + "ceiling": { + "value": 2926, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 20, + "rainProbability": 20, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-15T01:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 9.9, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 8.5, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 8.5, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 6.8, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 177, + "localizedDescription": "S" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 13, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 81, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 99, + "ceiling": { + "value": 2164, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 21, + "rainProbability": 21, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-15T02:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 9.8, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 8.5, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 8.4, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 6.8, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 172, + "localizedDescription": "S" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 13, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 82, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 100, + "ceiling": { + "value": 1737, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 21, + "rainProbability": 21, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-15T03:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 9.7, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 8.6, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 8.4, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 6.9, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 161, + "localizedDescription": "SSE" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 13, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 83, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 100, + "ceiling": { + "value": 1311, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 26, + "rainProbability": 26, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/preview/1.0/examples/GetMinuteForecast.json b/specification/maps/data-plane/Weather/preview/1.0/examples/GetMinuteForecast.json new file mode 100644 index 000000000000..089479b97981 --- /dev/null +++ b/specification/maps/data-plane/Weather/preview/1.0/examples/GetMinuteForecast.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "geography": "us", + "api-version": "1.0", + "format": "json", + "query": "47.632346,-122.138874", + "interval": 15 + }, + "responses": { + "200": { + "body": { + "summary": { + "briefPhrase60": "Rain ending in 25 min", + "shortPhrase": "Rain ending in 25 min", + "briefPhrase": "Rain ending in 25 min", + "longPhrase": "Rain ending in 25 min", + "iconCode": 12 + }, + "intervalSummaries": [ + { + "startMinute": 0, + "endMinute": 24, + "totalMinutes": 25, + "shortPhrase": "Rain ending in %minute_value min", + "briefPhrase": "Rain ending in %minute_value min", + "longPhrase": "Rain ending in %minute_value min", + "iconCode": 12 + }, + { + "startMinute": 25, + "endMinute": 119, + "totalMinutes": 95, + "shortPhrase": "No precip for %MINUTE_VALUE min", + "briefPhrase": "No precipitation for at least %MINUTE_VALUE min", + "longPhrase": "No precipitation for at least %MINUTE_VALUE min", + "iconCode": 7 + } + ], + "intervals": [ + { + "startTime": "2019-11-14T15:18:00-08:00", + "minute": 0, + "dbz": 23, + "shortPhrase": "Light Rain", + "threshold": "LIGHT", + "color": { + "red": 8, + "green": 98, + "blue": 2, + "hex": "#086202" + }, + "simplifiedColor": { + "red": 35, + "green": 190, + "blue": 39, + "hex": "#23BE27" + }, + "precipitationType": "rain", + "iconCode": 12, + "cloudCover": 100 + }, + { + "startTime": "2019-11-14T15:33:00-08:00", + "minute": 15, + "dbz": 18, + "shortPhrase": "Light Rain", + "threshold": "LIGHT", + "color": { + "red": 32, + "green": 133, + "blue": 9, + "hex": "#208509" + }, + "simplifiedColor": { + "red": 35, + "green": 190, + "blue": 39, + "hex": "#23BE27" + }, + "precipitationType": "rain", + "iconCode": 12, + "cloudCover": 100 + }, + { + "startTime": "2019-11-14T15:48:00-08:00", + "minute": 30, + "dbz": 0, + "shortPhrase": "No Precipitation", + "iconCode": 7, + "cloudCover": 100 + }, + { + "startTime": "2019-11-14T16:03:00-08:00", + "minute": 45, + "dbz": 0, + "shortPhrase": "No Precipitation", + "iconCode": 7, + "cloudCover": 100 + }, + { + "startTime": "2019-11-14T16:18:00-08:00", + "minute": 60, + "dbz": 0, + "shortPhrase": "No Precipitation", + "iconCode": 7, + "cloudCover": 100 + }, + { + "startTime": "2019-11-14T16:33:00-08:00", + "minute": 75, + "dbz": 0, + "shortPhrase": "No Precipitation", + "iconCode": 7, + "cloudCover": 100 + }, + { + "startTime": "2019-11-14T16:48:00-08:00", + "minute": 90, + "dbz": 0, + "shortPhrase": "No Precipitation", + "iconCode": 7, + "cloudCover": 100 + }, + { + "startTime": "2019-11-14T17:03:00-08:00", + "minute": 105, + "dbz": 0, + "shortPhrase": "No Precipitation", + "iconCode": 7, + "cloudCover": 100 + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/preview/1.0/examples/GetQuarterDayForecast.json b/specification/maps/data-plane/Weather/preview/1.0/examples/GetQuarterDayForecast.json new file mode 100644 index 000000000000..052f229eed32 --- /dev/null +++ b/specification/maps/data-plane/Weather/preview/1.0/examples/GetQuarterDayForecast.json @@ -0,0 +1,379 @@ +{ + "parameters": { + "geography": "us", + "api-version": "1.0", + "format": "json", + "query": "47.632346,-122.138874", + "duration": 1 + }, + "responses": { + "200": { + "body": { + "forecasts": [ + { + "date": "2019-11-14T00:00:00", + "effectiveDate": "2019-11-14T07:00:00-08:00", + "quarter": 0, + "iconCode": 12, + "iconPhrase": "Showers", + "phrase": "Mostly cloudy with a shower in spots", + "temperature": { + "minimum": { + "value": 6.9, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 11.1, + "unit": "C", + "unitType": 17 + } + }, + "realFeelTemperature": { + "minimum": { + "value": 7.9, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 11.2, + "unit": "C", + "unitType": 17 + } + }, + "dewPoint": { + "value": 7.5, + "unit": "C", + "unitType": 17 + }, + "relativeHumidity": 90, + "wind": { + "direction": { + "degrees": 206, + "localizedDescription": "SSW" + }, + "speed": { + "value": 3.7, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "direction": { + "degrees": 192, + "localizedDescription": "SSW" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "visibility": { + "value": 2, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 99, + "hasPrecipitation": true, + "precipitationType": "Rain", + "precipitationIntensity": "Light", + "precipitationProbability": 55, + "thunderstormProbability": 20, + "totalLiquid": { + "value": 0.6, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0.6, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-14T00:00:00", + "effectiveDate": "2019-11-14T13:00:00-08:00", + "quarter": 1, + "iconCode": 12, + "iconPhrase": "Showers", + "phrase": "Mostly cloudy with a shower in spots", + "temperature": { + "minimum": { + "value": 11.3, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 13.7, + "unit": "C", + "unitType": 17 + } + }, + "realFeelTemperature": { + "minimum": { + "value": 11.3, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 14.7, + "unit": "C", + "unitType": 17 + } + }, + "dewPoint": { + "value": 8.4, + "unit": "C", + "unitType": 17 + }, + "relativeHumidity": 76, + "wind": { + "direction": { + "degrees": 296, + "localizedDescription": "WNW" + }, + "speed": { + "value": 3.7, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "direction": { + "degrees": 206, + "localizedDescription": "SSW" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "visibility": { + "value": 8, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 96, + "hasPrecipitation": true, + "precipitationType": "Rain", + "precipitationIntensity": "Light", + "precipitationProbability": 50, + "thunderstormProbability": 20, + "totalLiquid": { + "value": 0.3, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0.3, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-14T00:00:00", + "effectiveDate": "2019-11-14T19:00:00-08:00", + "quarter": 2, + "iconCode": 7, + "iconPhrase": "Cloudy", + "phrase": "Cloudy", + "temperature": { + "minimum": { + "value": 9.8, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 10.4, + "unit": "C", + "unitType": 17 + } + }, + "realFeelTemperature": { + "minimum": { + "value": 8.5, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 9.8, + "unit": "C", + "unitType": 17 + } + }, + "dewPoint": { + "value": 7, + "unit": "C", + "unitType": 17 + }, + "relativeHumidity": 81, + "wind": { + "direction": { + "degrees": 172, + "localizedDescription": "S" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "direction": { + "degrees": 174, + "localizedDescription": "S" + }, + "speed": { + "value": 13, + "unit": "km/h", + "unitType": 7 + } + }, + "visibility": { + "value": 10, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 93, + "hasPrecipitation": false, + "precipitationProbability": 25, + "thunderstormProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-14T00:00:00", + "effectiveDate": "2019-11-15T01:00:00-08:00", + "quarter": 3, + "iconCode": 12, + "iconPhrase": "Showers", + "phrase": "Cloudy with a little rain", + "temperature": { + "minimum": { + "value": 8.9, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 9.9, + "unit": "C", + "unitType": 17 + } + }, + "realFeelTemperature": { + "minimum": { + "value": 6.2, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 8.6, + "unit": "C", + "unitType": 17 + } + }, + "dewPoint": { + "value": 6.9, + "unit": "C", + "unitType": 17 + }, + "relativeHumidity": 84, + "wind": { + "direction": { + "degrees": 164, + "localizedDescription": "SSE" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "direction": { + "degrees": 165, + "localizedDescription": "SSE" + }, + "speed": { + "value": 14.8, + "unit": "km/h", + "unitType": 7 + } + }, + "visibility": { + "value": 9, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 99, + "hasPrecipitation": true, + "precipitationType": "Rain", + "precipitationIntensity": "Light", + "precipitationProbability": 59, + "thunderstormProbability": 0, + "totalLiquid": { + "value": 1.4, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 1.4, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/preview/1.0/examples/GetSevereWeatherAlerts.json b/specification/maps/data-plane/Weather/preview/1.0/examples/GetSevereWeatherAlerts.json new file mode 100644 index 000000000000..2d687d1bcf63 --- /dev/null +++ b/specification/maps/data-plane/Weather/preview/1.0/examples/GetSevereWeatherAlerts.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "geography": "us", + "api-version": "1.0", + "format": "json", + "query": "48.057,-81.091" + }, + "responses": { + "200": { + "body": { + "results": [ + { + "countryCode": "CA", + "alertId": 242621, + "description": { + "localized": "Heat Warning", + "english": "Heat Warning" + }, + "category": "NON-PRECIPITATION", + "priority": 31, + "source": "Environment Canada", + "sourceId": 3, + "alertAreas": [ + { + "name": "Kirkland Lake - Englehart", + "summary": "Heat Warning in effect until Thursday, 3:16 AM EDT. Source: Environment Canada", + "startTime": "2020-06-29T19:44:00+00:00", + "endTime": "2020-07-02T07:16:03+00:00", + "latestStatus": { + "localized": "Continue", + "english": "Continue" + }, + "alertDetails": "\nA heat event continues through Thursday.\n\nDaytime high temperatures in the low thirties with overnight lows near 18 degrees Celsius are expected to continue until Thursday. Humidex values are expected to reach between 36 and 40 today. Cooler air will move into the region Thursday night. \n\nPlease refer to your public forecast for further details on expected temperatures.\n\nHot and humid air can also bring deteriorating air quality and can result in the air quality health index to approach the high risk category.\n\n###\n\nExtreme heat affects everyone.\n\nThe risks are greater for young children, pregnant women, older adults, people with chronic illnesses and people working or exercising outdoors.\n\nWatch for the effects of heat illness: swelling, rash, cramps, fainting, heat exhaustion, heat stroke and the worsening of some health conditions.\n\nPlease continue to monitor alerts and forecasts issued by Environment Canada. To report severe weather, send an email to ONstorm@canada.ca or tweet reports using #ONStorm.\n", + "alertDetailsLanguageCode": "en-CA" + } + ] + }, + { + "countryCode": "CA", + "alertId": 242633, + "description": { + "localized": "Heat Warning", + "english": "Heat Warning" + }, + "category": "NON-PRECIPITATION", + "priority": 31, + "source": "Environment Canada", + "sourceId": 3, + "alertAreas": [ + { + "name": "Kirkland Lake - Englehart", + "summary": "Heat Warning in effect until 9:25 PM EDT. Source: Environment Canada", + "startTime": "2020-07-01T09:25:59+00:00", + "endTime": "2020-07-02T01:25:59+00:00", + "latestStatus": { + "localized": "New", + "english": "New" + }, + "alertDetails": "\nA heat event is expected through Thursday. \n\nDaytime high temperatures in the low thirties on Wednesday and Thursday with overnight lows near 18 degrees Celsius are expected. This heat event may be extended into the weekend with daytime high temperatures near 30 degrees Celsius. \n\nPlease refer to your public forecast for further details on expected temperatures. \n\nHot and humid air can also bring deteriorating air quality and can result in the Air Quality Health Index to approach the high risk category.\n\n###\n\nExtreme heat affects everyone.\n\nThe risks are greater for young children, pregnant women, older adults, people with chronic illnesses and people working or exercising outdoors.\n\nPlease continue to monitor alerts and forecasts issued by Environment Canada. To report severe weather, send an email to ONstorm@canada.ca or tweet reports using #ONStorm.\n", + "alertDetailsLanguageCode": "en-CA" + } + ] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/preview/1.0/examples/GetWeatherAlongRoute.json b/specification/maps/data-plane/Weather/preview/1.0/examples/GetWeatherAlongRoute.json new file mode 100644 index 000000000000..ca54d81a45c1 --- /dev/null +++ b/specification/maps/data-plane/Weather/preview/1.0/examples/GetWeatherAlongRoute.json @@ -0,0 +1,309 @@ +{ + "parameters": { + "geography": "us", + "api-version": "1.0", + "format": "json", + "query": "38.907,-77.037,0:38.907,-77.009,10:38.926,-76.928,20:39.033,-76.852,30:39.168,-76.732,40:39.269,-76.634,50:39.287,-76.612,60" + }, + "responses": { + "200": { + "body": { + "summary": { + "iconCode": 35, + "hazards": { + "maxHazardIndex": 0 + } + }, + "waypoints": [ + { + "iconCode": 38, + "shortPhrase": "Mostly cloudy", + "isDayTime": false, + "cloudCover": 70, + "temperature": { + "value": 3.4, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 142 + }, + "speed": { + "value": 2, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 3, + "unit": "km/h", + "unitType": 7 + } + }, + "precipitation": { + "dbz": 0, + "type": "SNOW" + }, + "lightningCount": 0, + "sunGlare": { + "calculatedVehicleHeading": 90, + "glareIndex": 0 + }, + "hazards": { + "maxHazardIndex": 0 + }, + "notifications": [] + }, + { + "iconCode": 38, + "shortPhrase": "Mostly cloudy", + "isDayTime": false, + "cloudCover": 65, + "temperature": { + "value": 3.4, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 166 + }, + "speed": { + "value": 1, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 2, + "unit": "km/h", + "unitType": 7 + } + }, + "precipitation": { + "dbz": 0, + "type": "SNOW" + }, + "lightningCount": 0, + "sunGlare": { + "calculatedVehicleHeading": 77, + "glareIndex": 0 + }, + "hazards": { + "maxHazardIndex": 0 + }, + "notifications": [] + }, + { + "iconCode": 35, + "shortPhrase": "Partly cloudy", + "isDayTime": false, + "cloudCover": 43, + "temperature": { + "value": 3.2, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 163 + }, + "speed": { + "value": 2, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 2, + "unit": "km/h", + "unitType": 7 + } + }, + "precipitation": { + "dbz": 0, + "type": "SNOW" + }, + "lightningCount": 0, + "sunGlare": { + "calculatedVehicleHeading": 44, + "glareIndex": 0 + }, + "hazards": { + "maxHazardIndex": 0 + }, + "notifications": [] + }, + { + "iconCode": 35, + "shortPhrase": "Partly cloudy", + "isDayTime": false, + "cloudCover": 34, + "temperature": { + "value": 1.6, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 189 + }, + "speed": { + "value": 2, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 4, + "unit": "km/h", + "unitType": 7 + } + }, + "precipitation": { + "dbz": 0, + "type": "SNOW" + }, + "lightningCount": 0, + "sunGlare": { + "calculatedVehicleHeading": 32, + "glareIndex": 0 + }, + "hazards": { + "maxHazardIndex": 0 + }, + "notifications": [] + }, + { + "iconCode": 38, + "shortPhrase": "Mostly cloudy", + "isDayTime": false, + "cloudCover": 54, + "temperature": { + "value": 0.5, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 202 + }, + "speed": { + "value": 4, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 5, + "unit": "km/h", + "unitType": 7 + } + }, + "precipitation": { + "dbz": 0, + "type": "SNOW" + }, + "lightningCount": 0, + "sunGlare": { + "calculatedVehicleHeading": 36, + "glareIndex": 0 + }, + "hazards": { + "maxHazardIndex": 0 + }, + "notifications": [] + }, + { + "iconCode": 35, + "shortPhrase": "Partly cloudy", + "isDayTime": false, + "cloudCover": 46, + "temperature": { + "value": 2.4, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 222 + }, + "speed": { + "value": 4, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 5, + "unit": "km/h", + "unitType": 7 + } + }, + "precipitation": { + "dbz": 0, + "type": "SNOW" + }, + "lightningCount": 0, + "sunGlare": { + "calculatedVehicleHeading": 38, + "glareIndex": 0 + }, + "hazards": { + "maxHazardIndex": 0 + }, + "notifications": [] + }, + { + "iconCode": 35, + "shortPhrase": "Partly cloudy", + "isDayTime": false, + "cloudCover": 39, + "temperature": { + "value": 2.3, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 231 + }, + "speed": { + "value": 4, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 5, + "unit": "km/h", + "unitType": 7 + } + }, + "precipitation": { + "dbz": 0, + "type": "SNOW" + }, + "lightningCount": 0, + "sunGlare": { + "calculatedVehicleHeading": 43, + "glareIndex": 0 + }, + "hazards": { + "maxHazardIndex": 0 + }, + "notifications": [] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Weather/preview/1.0/weather.json b/specification/maps/data-plane/Weather/preview/1.0/weather.json new file mode 100644 index 000000000000..6cbd62b09082 --- /dev/null +++ b/specification/maps/data-plane/Weather/preview/1.0/weather.json @@ -0,0 +1,1925 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Weather Service", + "version": "1.0" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{geography}.atlas.microsoft.com", + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "AzureKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "AzureKey": [] + } + ], + "responses": {}, + "parameters": { + "WeatherApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API.", + "type": "string", + "in": "query", + "required": true, + "default": "1.0", + "x-ms-parameter-location": "client" + }, + "WeatherLanguage": { + "name": "language", + "description": "Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Default value is en-us. \n\nPlease refer to [Supported languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.", + "type": "string", + "in": "query", + "x-ms-parameter-location": "method" + }, + "WeatherDataUnit": { + "name": "unit", + "description": "Specifies to return the data in either metric units or imperial units. Default value is metric.", + "in": "query", + "type": "string", + "enum": [ + "metric", + "imperial" + ], + "x-ms-enum": { + "name": "WeatherDataUnit", + "modelAsString": true, + "values": [ + { + "value": "metric", + "description": "Return data in metric units. Some example units of metric system are Celsius and kilometer." + }, + { + "value": "imperial", + "description": "Return data in imperial units. Some example units of imperial system are Fahrenheit and mile." + } + ] + }, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/weather/forecast/hourly/{format}": { + "get": { + "description": "**Get Hourly Forecast**\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nRequest detailed weather forecast by the hour for the next 1, 12, 24 (1 day), 72 (3 days), 120 (5 days), and 240 hours (10 days) for the given the given coordinate location. The API returns details such as temperature, humidity, wind, precipitation, and ultraviolet (UV) index.\n\nIn S0 you can request hourly forecast for the next 1, 12, 24 hours (1 day), and 72 hours (3 days). In S1 you can also request hourly forecast for the next 120 (5 days) and 240 hours (10 days).", + "operationId": "Weather_GetHourlyForecast", + "x-ms-examples": { + "GetHourlyForecast": { + "$ref": "./examples/GetHourlyForecast.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/WeatherApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "query", + "description": "Coordinates of the location for which hourly forecast information is requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".", + "in": "query", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/WeatherDataUnit" + }, + { + "name": "duration", + "description": "Time frame of the returned weather forecast. By default, the forecast data for next hour will be returned. Available values are\n * `1` - Return forecast data for the next hour. Default value.\n * `12` - Return hourly forecast for next 12 hours.\n * `24` - Return hourly forecast for next 24 hours.\n * `72` - Return hourly forecast for next 72 hours (3 days).\n * `120` - Return hourly forecast for next 120 hours (5 days). Only available in S1 SKU. \n * `240` - Return hourly forecast for next 240 hours (10 days). Only available in S1 SKU.", + "in": "query", + "type": "integer" + }, + { + "$ref": "#/parameters/WeatherLanguage" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HourlyForecastResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/weather/forecast/minute/{format}": { + "get": { + "description": "**Get Minute Forecast**\n \n \n**Applies to**: S1 pricing tier.\n\n\nGet Minute Forecast service returns minute-by-minute forecasts for a given location for the next 120 minutes. Users can request weather forecasts in the interval of 1, 5 and 15 minutes. The response will include details such as the type of precipitation (including rain, snow, or a mixture of both), start time, and precipitation intensity value (dBZ).", + "operationId": "Weather_GetMinuteForecast", + "x-ms-examples": { + "GetMinuteForecast": { + "$ref": "./examples/GetMinuteForecast.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/WeatherApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "query", + "description": "Coordinates of the location for which minute forecast information is requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".", + "in": "query", + "type": "string", + "required": true + }, + { + "name": "interval", + "description": "Specifies time interval in minutes for the returned weather forecast. Supported values are\n * `1` - Retrieve forecast for 1-minute intervals. Returned by default.\n * `5` - Retrieve forecasts for 5-minute intervals.\n * `15` - Retrieve forecasts for 15-minute intervals.", + "in": "query", + "type": "integer" + }, + { + "$ref": "#/parameters/WeatherLanguage" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MinuteForecastResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/weather/forecast/quarterDay/{format}": { + "get": { + "description": "**Get Quarter-Day Forecast**\n \n \n**Applies to**: S0 and S1 pricing tiers.\n\n\nService returns detailed weather forecast by quarter-day for the next 1, 5, 10, or 15 days for a given location. Response data is presented by quarters of the day - morning, afternoon, evening, and overnight. Details such as temperature, humidity, wind, precipitation, and UV index are returned.", + "operationId": "Weather_GetQuarterDayForecast", + "x-ms-examples": { + "GetQuarterDayForecast": { + "$ref": "./examples/GetQuarterDayForecast.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/WeatherApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "query", + "description": "Coordinates of the location for which quarter-day forecast information is requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".", + "in": "query", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/WeatherDataUnit" + }, + { + "name": "duration", + "description": "Specifies for how many days the quester-day forecast responses are returned. Supported values are:\n * `1` - Return forecast data for the next day. Returned by default.\n * `5` - Return forecast data for the next 5 days.\n * `10` - Return forecast data for next 10 days.\n * `15` - Return forecast data for the next 15 days.", + "in": "query", + "type": "integer" + }, + { + "$ref": "#/parameters/WeatherLanguage" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/QuarterDayForecastResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/weather/currentConditions/{format}": { + "get": { + "description": "**Get Current Conditions**\n \n \n**Applies to**: S0 and S1 pricing tiers.\n\n\nGet Current Conditions service returns detailed current weather conditions such as precipitation, temperature and wind for a given coordinate location. Also, observations from the past 6 or 24 hours for a particular location can be retrieved. The basic information returned with the response include details such as observation date and time, brief description of the weather conditions, weather icon, precipitation indicator flags, and temperature. Additional details such as RealFeel™ Temperature and UV index are also returned.", + "operationId": "Weather_GetCurrentConditions", + "x-ms-examples": { + "GetCurrentConditions": { + "$ref": "./examples/GetCurrentConditions.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/WeatherApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "query", + "description": "Coordinates of the location for which current conditions information is requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".", + "in": "query", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/WeatherDataUnit" + }, + { + "name": "details", + "description": "Return full details for the current conditions. Available values are\n * `true` - Returns full details. By default all details are returned.\n * `false` - Returns a truncated version of the current condition data, which includes observation date time, weather phrase, icon code, precipitation indicator flag, and temperature.", + "in": "query", + "type": "string" + }, + { + "name": "duration", + "description": "Time frame of the returned weather conditions. By default, the most current weather conditions will be returned. Default value is 0. Supported values are:\n * `0` - Return the most current weather conditions.\n * `6` - Return weather conditions from past 6 hours.\n * `24` - Return weather conditions from past 24 hours.", + "in": "query", + "type": "integer" + }, + { + "$ref": "#/parameters/WeatherLanguage" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CurrentConditionsResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/weather/forecast/daily/{format}": { + "get": { + "description": "**Get Daily Forecast**\n \n \n**Applies to**: S0 and S1 pricing tiers.\n\n\nThe service returns detailed weather forecast such as temperature and wind by day for the next 1, 5, 10, 15, 25, or 45 days for a given coordinate location. The response include details such as temperature, wind, precipitation, air quality, and UV index.\n\nIn S0 you can request daily forecast for the next 1, 5, 10, and 15 days. In S1 you can also request daily forecast for the next 25 days, and 45 days.", + "operationId": "Weather_GetDailyForecast", + "x-ms-examples": { + "GetDailyForecast": { + "$ref": "./examples/GetDailyForecast.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/WeatherApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "query", + "description": "Coordinates of the location for which current conditions information is requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".", + "in": "query", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/WeatherDataUnit" + }, + { + "name": "duration", + "description": "Specifies for how many days the daily forecast responses are returned. Available values are\n * `1` - Return forecast data for the next day. Returned by default.\n * `5` - Return forecast data for the next 5 days.\n * `10` - Return forecast data for the next 10 days.\n * `25` - Return forecast data for the next 25 days. Only available in S1 SKU.\n * `45` - Return forecast data for the next 45 days. Only available in S1 SKU.", + "in": "query", + "type": "integer" + }, + { + "$ref": "#/parameters/WeatherLanguage" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DailyForecastResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/weather/route/{format}": { + "get": { + "description": "**Get Weather along route**\n \n \n **Applies to**: S1 pricing tier.\n\n Weather along a route API returns hyper local (one kilometer or less), up-to-the-minute weather nowcasts, weather hazard assessments, and notifications along a route described as a sequence of waypoints. \n This includes a list of weather hazards affecting the waypoint or route, and the aggregated hazard index for each waypoint might be used to paint each portion of a route according to how safe it is for the driver. When submitting the waypoints, it is recommended to stay within, or close to, the distance that can be traveled within 120-mins or shortly after. Data is updated every five minutes. \n \n The service supplements Azure Maps [Route Service](https://docs.microsoft.com/rest/api/maps/route) that allows you to first request a route between an origin and a destination and use that as an input for Weather Along Route endpoint.\n \n In addition, the service supports scenarios to generate weather notifications for waypoints that experience an increase in intensity of a weather hazard. For example, if the vehicle is expected to begin experiencing heavy rain as it reaches a waypoint, a weather notification for heavy rain will be generated for that waypoint allowing the end product to display a heavy rain notification before the driver reaches that waypoint. \n The trigger for when to display the notification for a waypoint could be based, for example, on a [geofence](https://docs.microsoft.com/azure/azure-maps/tutorial-iot-hub-maps), or selectable distance to the waypoint.\n\n The API covers all regions of the planet except latitudes above Greenland and Antarctica.", + "operationId": "Weather_GetWeatherAlongRoute", + "x-ms-examples": { + "GetWeatherAlongRoute": { + "$ref": "./examples/GetWeatherAlongRoute.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/WeatherApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "query", + "description": "Coordinates through which the route is calculated, separated by colon (:) and entered in chronological order. A minimum of two waypoints is required. A single API call may contain up to 60 waypoints. \nA waypoint indicates location, ETA, and optional heading: latitude,longitude,ETA,heading, where\n * `Latitude` - Latitude coordinate in decimal degrees.\n * `Longitude` - Longitude coordinate in decimal degrees.\n * `ETA (estimated time of arrival)` - The number of minutes from the present time that it will take for the vehicle to reach the waypoint. Allowed range is from 0.0 to 120.0 minutes.\n * `Heading` - An optional value indicating the vehicle heading as it passes the waypoint. Expressed in clockwise degrees relative to true north. This is issued to calculate sun glare as a driving hazard. Allowed range is from 0.0 to 360.0 degrees. If not provided, a heading will automatically be derived based on the position of neighboring waypoints.\n\nIt is recommended to stay within, or close to, the distance that can be traveled within 120-mins or shortly after. This way a more accurate assessment can be provided for the trip and prevent isolated events not being captured between waypoints. Information can and should be updated along the route (especially for trips greater than 2 hours) to continuously pull new waypoints moving forward, but also to ensure that forecast information for content such as precipitation type and intensity is accurate as storms develop and dissipate over time.", + "in": "query", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/WeatherLanguage" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WeatherAlongRouteResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/weather/severe/alerts/{format}": { + "get": { + "description": "**Get Severe Weather Alerts**\n\n**Applies to**: S0 and S1 pricing tiers.\n\nSevere weather phenomenon can significantly impact our everyday life and business operations. For example, severe weather conditions such as tropical storms, high winds or flooding can close roads and force logistics companies to reroute their fleet causing delays in reaching destinations and breaking the cold chain of refrigerated food products.  Azure Maps Severe Weather Alerts API returns the severe weather alerts that are available worldwide from both official Government Meteorological Agencies and leading global to regional weather alert providers. The service can return details such as alert type, category, level and detailed description about the active severe alerts for the requested location, like hurricanes, thunderstorms, lightning, heat waves or forest fires.", + "operationId": "Weather_GetSevereWeatherAlerts", + "x-ms-examples": { + "GetSevereWeatherAlerts": { + "$ref": "./examples/GetSevereWeatherAlerts.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/WeatherApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "query", + "description": "Coordinates of the location for which severe weather alerts are requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".", + "in": "query", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/WeatherLanguage" + }, + { + "name": "details", + "description": "Return full details for the severe weather alerts. Available values are\n * `true` - Returns full details. By default all details are returned.\n * `false` - Returns a truncated version of the alerts data, which excludes the area-specific full description of alert details (`alertDetails`).", + "in": "query", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK,", + "schema": { + "$ref": "#/definitions/SevereWeatherAlertsResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/weather/indices/daily/{format}": { + "get": { + "description": "**Get Daily Indices**\n\n**Applies to**: S0 and S1 pricing tiers.\n\nThere may be times when you want to know if the weather conditions are optimal for a specific activity, for example, for outdoor construction, indoor activities, running or farming including soil moisture information. Azure Maps Indices API returns index values that will guide end users to plan future activities. For example, a health mobile application can notify users that today is good weather for running or for other outdoors activities like for playing golf, and retail stores can optimize their digital marketing campaigns based on predicted index values. The service returns in daily indices values for current and next 5, 10 and 15 days starting from current day.", + "operationId": "Weather_GetDailyIndices", + "x-ms-examples": { + "GetDailyIndices": { + "$ref": "./examples/GetDailyIndices.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/WeatherApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "name": "query", + "description": "Coordinates of the location for which daily indices are requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".", + "in": "query", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/WeatherLanguage" + }, + { + "name": "duration", + "description": "Specifies for how many days the daily indices are returned. By default, the indices data for the current day will be returned. When requesting future indices data, the current day is included in the response as day 1. Available values are\n * `1` - Return daily index data for the current day. Default value.\n * `5` - Return 5 days of daily index data starting from the current day.\n * `10` - Return 10 days of daily index data starting from the current day.\n * `15` - Return 15 days of daily index data starting from the current day.", + "in": "query", + "type": "integer" + }, + { + "name": "indexId", + "description": "Numeric index identifier that can be used for restricting returned results to the corresponding index type. Cannot be paired with `indexGroupId`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported indices.", + "in": "query", + "type": "integer" + }, + { + "name": "indexGroupId", + "description": "Numeric index group identifier that can be used for restricting returned results to the corresponding subset of indices (index group). Cannot be paired with `indexId`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported index groups.", + "in": "query", + "type": "integer" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DailyIndicesResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + } + }, + "definitions": { + "WeatherUnit": { + "description": "Specific value of a given unit related to weather.", + "type": "object", + "properties": { + "value": { + "type": "number", + "format": "float", + "description": "Rounded value." + }, + "unit": { + "type": "string", + "description": "Type of unit for the returned value." + }, + "unitType": { + "type": "integer", + "format": "int32", + "description": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details." + } + } + }, + "WindDetails": { + "type": "object", + "description": "Wind details being returned including speed and direction.", + "properties": { + "direction": { + "$ref": "#/definitions/WindDirection", + "description": "Wind direction" + }, + "speed": { + "$ref": "#/definitions/WindSpeed", + "description": "Speed of the wind in specified unit." + } + } + }, + "WindDirection": { + "type": "object", + "properties": { + "degrees": { + "type": "integer", + "format": "int32", + "description": "Wind direction in Azimuth degrees, starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359." + }, + "localizedDescription": { + "type": "string", + "description": "Direction abbreviation in the specified language." + } + }, + "description": "Wind direction" + }, + "WindSpeed": { + "type": "object", + "description": "Speed of wind in specified unit.", + "properties": { + "value": { + "type": "number", + "format": "float", + "description": "Rounded value of the speed." + }, + "unit": { + "type": "string", + "description": "Type of unit for the speed value." + }, + "unitType": { + "type": "integer", + "format": "int32", + "description": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details." + } + } + }, + "WeatherUnitRange": { + "type": "object", + "description": "Returned temperature values.", + "properties": { + "minimum": { + "$ref": "#/definitions/WeatherUnit", + "description": "Minimum temperature for the time period." + }, + "maximum": { + "$ref": "#/definitions/WeatherUnit", + "description": "Maximum temperature for the time period" + } + } + }, + "UVIndex": { + "type": "integer", + "format": "int32", + "description": "Measure of the strength of the ultraviolet radiation from the sun. Supported values are:\n * `0-2` - Low danger from the sun's UV rays or the average person.\n * `3-5` - Moderate risk of harm from unprotected sun exposure.\n * `6-7` - High risk of harm from unprotected sun exposure.\n * `8-10` - Very high risk of harm from unprotected sun exposure.\n * `11+` - Extreme risk of harm from unprotected sun exposure." + }, + "HazardIndex": { + "type": "integer", + "format": "int32", + "description": "A severity/hazard index.\n * `0` - No hazard.\n * `1` - Be informed, be aware.\n * `2` - Pay attention, be prepared.\n * `3` - Take action.\n * `4` - Life threatening, emergency." + }, + "HourlyForecast": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "Date and time of the forecast in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00.", + "format": "date-time" + }, + "iconCode": { + "type": "integer", + "format": "int32", + "description": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details." + }, + "iconPhrase": { + "type": "string", + "description": "Phrase description of the weather icon." + }, + "hasPrecipitation": { + "type": "boolean", + "description": "Indicates the presence or absence of precipitation. True indicates the presence of precipitation, false indicates the absence of precipitation." + }, + "isDaylight": { + "type": "boolean", + "description": "Specifies whether or not it is daylight. True indicates day light." + }, + "temperature": { + "$ref": "#/definitions/WeatherUnit", + "description": "Temperature being returned." + }, + "realFeelTemperature": { + "$ref": "#/definitions/WeatherUnit", + "description": "RealFeel™ Temperature being returned. Describes what the temperature really feels like in the shade." + }, + "wetBulbTemperature": { + "$ref": "#/definitions/WeatherUnit", + "description": "The temperature to which air may be cooled by evaporating water into it at constant pressure until it reaches saturation." + }, + "dewPoint": { + "$ref": "#/definitions/WeatherUnit", + "description": "The dewpoint temperature in specified unit. The dewpoint temperature is the temperature that the air must be cooled to in order to reach saturation." + }, + "wind": { + "$ref": "#/definitions/WindDetails", + "description": "Wind details being returned including speed and direction." + }, + "windGust": { + "$ref": "#/definitions/WindDetails", + "description": "Wind gust. Wind gust is a sudden, brief increase in speed of the wind." + }, + "relativeHumidity": { + "type": "integer", + "format": "int32", + "description": "Relative humidity is the amount of water vapor present in air expressed as a percentage of the amount needed for saturation at the same temperature." + }, + "visibility": { + "$ref": "#/definitions/WeatherUnit", + "description": "Visibility in specified unit. A measure of the distance at which an object or light can be clearly discerned." + }, + "ceiling": { + "$ref": "#/definitions/WeatherUnit", + "description": "Cloud ceiling in specified unit. The ceiling is a measurement of the height of the base of the lowest clouds." + }, + "uvIndex": { + "$ref": "#/definitions/UVIndex" + }, + "uvIndexPhrase": { + "type": "string", + "description": "Phrase associated with the `uvIndex`." + }, + "precipitationProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of precipitation. For example, '20'." + }, + "rainProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of rain. For example, '50'." + }, + "snowProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of snow. For example, '50'." + }, + "iceProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of snow. For example, '5'." + }, + "totalLiquid": { + "$ref": "#/definitions/WeatherUnit", + "description": "Total liquid equivalent of precipitation during the forecast period." + }, + "rain": { + "$ref": "#/definitions/WeatherUnit", + "description": "Rain" + }, + "snow": { + "$ref": "#/definitions/WeatherUnit", + "description": "Snow" + }, + "ice": { + "$ref": "#/definitions/WeatherUnit", + "description": "Ice" + }, + "cloudCover": { + "type": "integer", + "format": "int32", + "description": "Percent representing cloud cover." + } + } + }, + "HourlyForecastResponse": { + "type": "object", + "properties": { + "forecasts": { + "type": "array", + "description": "Forecast data for each returned hour.", + "items": { + "$ref": "#/definitions/HourlyForecast" + } + } + } + }, + "MinuteForecastSummary": { + "type": "object", + "properties": { + "briefPhrase60": { + "type": "string", + "description": "Summary phrase for the next 60 minutes. Phrase length is approximately 60 characters." + }, + "shortPhrase": { + "type": "string", + "description": "Short summary phrase for the next 120 minutes. Phrase length is approximately 25 characters." + }, + "briefPhrase": { + "type": "string", + "description": "Summary phrase for the next 120 minutes. Phrase length is approximately 60 characters." + }, + "longPhrase": { + "type": "string", + "description": "Long summary phrase for the next 120 minutes. Phrase length is 60+ characters." + }, + "iconCode": { + "type": "integer", + "format": "int32", + "description": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details." + } + }, + "description": "Phrase summaries for the entire forecast period." + }, + "IntervalSummary": { + "type": "object", + "properties": { + "startMinute": { + "type": "integer", + "format": "int32", + "description": "The first minute to which the summary applies." + }, + "endMinute": { + "type": "integer", + "format": "int32", + "description": "The last minute to which the summary applies." + }, + "totalMinutes": { + "type": "integer", + "format": "int32", + "description": "The number of minutes for which the summary applies." + }, + "shortPhrase": { + "type": "string", + "description": "Short summary phrase. Phrase length is approximately 25 characters." + }, + "briefPhrase": { + "type": "string", + "description": "Brief summary phrase. Phrase length is approximately 60 characters." + }, + "longPhrase": { + "type": "string", + "description": "Long summary phrase. Phrase length is 60+ characters." + }, + "iconCode": { + "type": "integer", + "format": "int32", + "description": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details." + } + } + }, + "ForecastInterval": { + "type": "object", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "The date and time for the start of the interval in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "minute": { + "type": "integer", + "format": "int32", + "description": "The first minute for the interval." + }, + "dbz": { + "type": "number", + "format": "double", + "description": "A unit that represents forecasted precipitation intensity." + }, + "shortPhrase": { + "type": "string", + "description": "A short phrase describing precipitation condition for the interval." + }, + "threshold": { + "type": "string", + "description": "Key that specifies the threshold value. Along with precipitationType, can be used to determine the simplifiedColor. If dbz is zero, not present in the response." + }, + "color": { + "$ref": "#/definitions/ColorValue", + "description": "The full spectrum color that maps to the dBZ (decibel relative to Z). If dbz is zero, color is not present in the response." + }, + "simplifiedColor": { + "$ref": "#/definitions/ColorValue", + "description": "The band color that maps to the precipitation type and threshold. If dbz is zero, not present in the response." + }, + "precipitationType": { + "type": "string", + "description": "Specifies the type of precipitation (\"rain\" \"snow\" \"ice\" or \"mix\"). If dbz is zero, precipitationType is not present in the response." + }, + "iconCode": { + "type": "integer", + "format": "int32", + "description": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details." + }, + "cloudCover": { + "type": "integer", + "format": "int32", + "description": "Percent representing cloud cover." + } + } + }, + "MinuteForecastResponse": { + "type": "object", + "properties": { + "summary": { + "$ref": "#/definitions/MinuteForecastSummary" + }, + "intervalSummaries": { + "type": "array", + "items": { + "$ref": "#/definitions/IntervalSummary" + }, + "description": "Summary information for each interval in the forecast. The Summaries breaks down each potential interval where precipitation starts and stops." + }, + "intervals": { + "type": "array", + "description": "Forecast data for each interval in the forecast.", + "items": { + "$ref": "#/definitions/ForecastInterval" + } + } + } + }, + "ColorValue": { + "type": "object", + "properties": { + "red": { + "type": "integer", + "format": "int32", + "description": "Red component of the RGB value." + }, + "green": { + "type": "integer", + "format": "int32", + "description": "Green component of the RGB value." + }, + "blue": { + "type": "integer", + "format": "int32", + "description": "Blue component of the RGB value" + }, + "hex": { + "type": "string", + "description": "Hexadecimal color value." + } + } + }, + "QuarterDayForecast": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "Date of the forecast as example, 2019-10-27T00:00:00" + }, + "effectiveDate": { + "type": "string", + "format": "date-time", + "description": "Date and time of the beginning of the forecast quarter displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "quarter": { + "description": "Quarter of the day.", + "type": "integer", + "format": "int32", + "enum": [ + 0, + 1, + 2, + 3 + ], + "x-ms-enum": { + "name": "DayQuarter", + "modelAsString": true, + "values": [ + { + "value": 0, + "description": "7:00 am - 1:00 pm / 7:00- 13:00" + }, + { + "value": 1, + "description": "1:00 pm - 7:00 pm/ 13:00- 19:00" + }, + { + "value": 2, + "description": "7:00 pm - 1:00 am/ 19:00 - 01:00" + }, + { + "value": 3, + "description": "1:00 am - 7:00 am/ 01:00 - 07:00" + } + ] + } + }, + "iconCode": { + "type": "integer", + "format": "int32", + "description": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details." + }, + "iconPhrase": { + "type": "string", + "description": "Phrase description of the icon. Displayed in specified language. For example, 'Sunny'." + }, + "phrase": { + "type": "string", + "description": "Short summary phrase summary for quarter." + }, + "temperature": { + "$ref": "#/definitions/WeatherUnitRange", + "description": "Temperature values for the quarter." + }, + "realFeelTemperature": { + "$ref": "#/definitions/WeatherUnitRange", + "description": "RealFeel™ Temperature values for the quarter." + }, + "dewPoint": { + "$ref": "#/definitions/WeatherUnit", + "description": "The dewpoint temperature in specified unit. The dewpoint temperature is the temperature that the air must be cooled to in order to reach saturation." + }, + "relativeHumidity": { + "type": "integer", + "format": "int32", + "description": "Relative humidity is the amount of water vapor present in air expressed as a percentage of the amount needed for saturation at the same temperature." + }, + "wind": { + "$ref": "#/definitions/WindDetails", + "description": "Wind details being returned including speed and direction." + }, + "windGust": { + "$ref": "#/definitions/WindDetails", + "description": "Wind gust. Wind gust is a sudden, brief increase in speed of the wind." + }, + "visibility": { + "$ref": "#/definitions/WeatherUnit", + "description": "Visibility in specified unit. A measure of the distance at which an object or light can be clearly discerned." + }, + "cloudCover": { + "type": "integer", + "format": "int32", + "description": "Percent representing cloud cover." + }, + "hasPrecipitation": { + "type": "boolean", + "description": "Indicates the presence or absence of precipitation. True indicates the presence of precipitation, false indicates the absence of precipitation." + }, + "precipitationType": { + "type": "string", + "description": "Specifies the type of precipitation (\"rain\" \"snow\" \"ice\" or \"mix\"). If dbz = zero, precipitationType is not present in the response." + }, + "precipitationIntensity": { + "type": "string", + "description": "Description of the intensity." + }, + "precipitationProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of precipitation. For example, '20'." + }, + "thunderstormProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of a thunderstorm. For example, '10'." + }, + "totalLiquid": { + "$ref": "#/definitions/WeatherUnit", + "description": "Total liquid equivalent of precipitation during the forecast period." + }, + "rain": { + "$ref": "#/definitions/WeatherUnit", + "description": "Rain" + }, + "snow": { + "$ref": "#/definitions/WeatherUnit", + "description": "Snow" + }, + "ice": { + "$ref": "#/definitions/WeatherUnit", + "description": "Ice" + } + } + }, + "QuarterDayForecastResponse": { + "type": "object", + "properties": { + "forecasts": { + "type": "array", + "description": "Forecast data for each quarter in the response.", + "items": { + "$ref": "#/definitions/QuarterDayForecast" + } + } + } + }, + "CurrentConditionsResponse": { + "type": "object", + "properties": { + "results": { + "description": "Detailed current weather conditions.", + "type": "array", + "items": { + "$ref": "#/definitions/CurrentConditions" + } + } + } + }, + "PressureTendency": { + "type": "object", + "properties": { + "localizedDescription": { + "type": "string", + "description": "Description of the pressure tendency in specified language" + }, + "code": { + "type": "string", + "description": "Pressure tendency code regardless of language. One of F=Falling, S=Steady, R=Rising." + } + } + }, + "PrecipitationSummary": { + "type": "object", + "properties": { + "pastHour": { + "$ref": "#/definitions/WeatherUnit", + "description": "The amount of precipitation (liquid equivalent) that has fallen in the past hour." + }, + "past3Hours": { + "$ref": "#/definitions/WeatherUnit", + "description": "The amount of precipitation (liquid equivalent) that has fallen in the past three hours." + }, + "past6Hours": { + "$ref": "#/definitions/WeatherUnit", + "description": "The amount of precipitation (liquid equivalent) that has fallen in the past six hours. Contains Metric and Imperial Values." + }, + "past9Hours": { + "$ref": "#/definitions/WeatherUnit", + "description": "The amount of precipitation (liquid equivalent) that has fallen in the past nine hours." + }, + "past12Hours": { + "$ref": "#/definitions/WeatherUnit", + "description": "The amount of precipitation (liquid equivalent) that has fallen in the past 12 hours." + }, + "past18Hours": { + "$ref": "#/definitions/WeatherUnit", + "description": "The amount of precipitation (liquid equivalent) that has fallen in the past 18 hours." + }, + "past24Hours": { + "$ref": "#/definitions/WeatherUnit", + "description": "The amount of precipitation (liquid equivalent) that has fallen in the past 24 hours." + } + } + }, + "TemperatureSummary": { + "type": "object", + "properties": { + "past6Hours": { + "type": "object", + "properties": { + "minimum": { + "$ref": "#/definitions/WeatherUnit", + "description": "minimum" + }, + "maximum": { + "$ref": "#/definitions/WeatherUnit", + "description": "maximum" + } + }, + "description": "Summary of temperature fluctuations over the past 6 hours." + }, + "past12Hours": { + "type": "object", + "properties": { + "minimum": { + "$ref": "#/definitions/WeatherUnit", + "description": "minimum" + }, + "maximum": { + "$ref": "#/definitions/WeatherUnit", + "description": "maximum" + } + }, + "description": "Summary of temperature fluctuations over the past 12 hours." + }, + "past24Hours": { + "type": "object", + "properties": { + "minimum": { + "$ref": "#/definitions/WeatherUnit", + "description": "minimum" + }, + "maximum": { + "$ref": "#/definitions/WeatherUnit", + "description": "maximum" + } + }, + "description": "Summary of temperature fluctuations over the past 24 hours." + } + } + }, + "CurrentConditions": { + "type": "object", + "properties": { + "dateTime": { + "type": "string", + "format": "date-time", + "description": "Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "phrase": { + "type": "string", + "description": "Phrase description of the current weather condition. Displayed in specified language." + }, + "iconCode": { + "type": "integer", + "format": "int32", + "description": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details." + }, + "hasPrecipitation": { + "type": "boolean", + "description": "Indicates the presence or absence of precipitation. True indicates the presence of precipitation, false indicates the absence of precipitation." + }, + "isDayTime": { + "type": "boolean", + "description": "Indicates the time of the day. True indicates 'day',', false indicates 'night." + }, + "temperature": { + "$ref": "#/definitions/WeatherUnit", + "description": "Temperature being returned." + }, + "realFeelTemperature": { + "$ref": "#/definitions/WeatherUnit", + "description": "RealFeel™ Temperature being returned." + }, + "realFeelTemperatureShade": { + "$ref": "#/definitions/WeatherUnit", + "description": "RealFeel™ Temperature being returned. Describes what the temperature really feels like in the shade." + }, + "relativeHumidity": { + "type": "integer", + "format": "int32", + "description": "Relative humidity is the amount of water vapor present in air expressed as a percentage of the amount needed for saturation at the same temperature." + }, + "dewPoint": { + "$ref": "#/definitions/WeatherUnit", + "description": "The dewpoint temperature in specified unit. The dewpoint temperature is the temperature that the air must be cooled to in order to reach saturation." + }, + "wind": { + "$ref": "#/definitions/WindDetails", + "description": "Wind details being returned including speed and direction." + }, + "windGust": { + "$ref": "#/definitions/WindDetails", + "description": "Wind gust. Wind gust is a sudden, brief increase in speed of the wind." + }, + "uvIndex": { + "$ref": "#/definitions/UVIndex" + }, + "uvIndexPhrase": { + "type": "string", + "description": "Phrase associated with the `uvIndex`." + }, + "visibility": { + "$ref": "#/definitions/WeatherUnit", + "description": "Visibility in specified unit. A measure of the distance at which an object or light can be clearly discerned." + }, + "obstructionsToVisibility": { + "type": "string", + "description": "Cause of limited visibility." + }, + "cloudCover": { + "type": "integer", + "format": "int32", + "description": "Percent representing cloud cover." + }, + "ceiling": { + "$ref": "#/definitions/WeatherUnit", + "description": "Cloud ceiling in specified unit. The ceiling is a measurement of the height of the base of the lowest clouds." + }, + "pressure": { + "$ref": "#/definitions/WeatherUnit", + "description": "Atmospheric pressure in specified unit." + }, + "pressureTendency": { + "$ref": "#/definitions/PressureTendency", + "description": "Atmospheric pressure change." + }, + "past24HourTemperatureDeparture": { + "$ref": "#/definitions/WeatherUnit", + "description": "Departure from the temperature observed 24 hours ago in specified unit." + }, + "apparentTemperature": { + "$ref": "#/definitions/WeatherUnit", + "description": "Perceived outdoor temperature caused by the combination of air temperature, relative humidity, and wind speed in specified unit." + }, + "windChillTemperature": { + "$ref": "#/definitions/WeatherUnit", + "description": "Perceived air temperature on exposed skin due to wind." + }, + "wetBulbTemperature": { + "$ref": "#/definitions/WeatherUnit", + "description": "The temperature to which air may be cooled by evaporating water into it at constant pressure until it reaches saturation." + }, + "precipitationSummary": { + "$ref": "#/definitions/PrecipitationSummary", + "description": "Summary of precipitation amounts over the past 24 hours." + }, + "temperatureSummary": { + "$ref": "#/definitions/TemperatureSummary", + "description": "Summary of temperature fluctuations over the past 6, 12, and 24 hours." + } + } + }, + "DailyForecastSummary": { + "type": "object", + "properties": { + "startDate": { + "type": "string", + "format": "date-time", + "description": "Date and time that the summary is in effect, displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "endDate": { + "type": "string", + "format": "date-time", + "description": "Date and time that the summary period ends, displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "severity": { + "type": "integer", + "format": "int32", + "description": "severity" + }, + "phrase": { + "type": "string", + "description": "Summary phrase of the daily forecast. Displayed in specified language." + }, + "category": { + "type": "string", + "description": "one or 2 word(s) to summarize the phrase." + } + }, + "description": "Summary for the main conditions for the requested time period. Notice that summary can cover only part of the time period." + }, + "DegreeDaySummary": { + "type": "object", + "properties": { + "heating": { + "$ref": "#/definitions/WeatherUnit", + "description": "Number of degrees that the mean temperature is below 65 degrees F/ 18 degree C." + }, + "cooling": { + "$ref": "#/definitions/WeatherUnit", + "description": "Number of degrees that the mean temperature is above 65 degrees F/ 18 degree C." + } + } + }, + "AirAndPollen": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the pollen or pollutant. For example, grass, mold, weed, air quality, tree and UV index." + }, + "value": { + "type": "integer", + "format": "int32", + "description": "Value of the given type above. Values associated with mold, grass, weed and tree are in units of parts per cubic meter. Both air quality and UV are indices, so they are unitless." + }, + "category": { + "type": "string", + "description": "Category of the air quality or pollution type. For example, low, high, good, moderate, unhealthy, hazardous." + }, + "categoryValue": { + "type": "integer", + "format": "int32", + "description": "Value associated with the air quality or pollution category. These values range from 1 to 6. 1 implying good conditions, 6 implying hazardous conditions." + }, + "type": { + "type": "string", + "description": "Only exists for air quality. Examples include ozone and particle pollution." + } + } + }, + "DailyForecast": { + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time", + "description": "Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "temperature": { + "$ref": "#/definitions/WeatherUnitRange", + "description": "Temperature values for the day." + }, + "realFeelTemperature": { + "$ref": "#/definitions/WeatherUnitRange", + "description": "RealFeel™ Temperature being returned." + }, + "realFeelTemperatureShade": { + "$ref": "#/definitions/WeatherUnitRange", + "description": "RealFeel™ Temperature being returned. Describes what the temperature really feels like in the shade." + }, + "hoursOfSun": { + "type": "number", + "format": "float", + "description": "Hours of sun." + }, + "degreeDaySummary": { + "$ref": "#/definitions/DegreeDaySummary", + "description": "Summary of Heating Degree Day or Cooling Degree Day information" + }, + "airAndPollen": { + "type": "array", + "items": { + "$ref": "#/definitions/AirAndPollen" + }, + "description": "airAndPollen" + }, + "day": { + "$ref": "#/definitions/DayOrNight", + "description": "Day" + }, + "night": { + "$ref": "#/definitions/DayOrNight", + "description": "Night" + }, + "sources": { + "description": "Source(s) of the forecast data.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DailyForecastResponse": { + "type": "object", + "properties": { + "summary": { + "$ref": "#/definitions/DailyForecastSummary" + }, + "forecasts": { + "type": "array", + "description": "Forecast data for each requested day.", + "items": { + "$ref": "#/definitions/DailyForecast" + } + } + } + }, + "LocalSource": { + "description": "Local weather data provider information.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "Numeric identifier, unique to the local data provider." + }, + "name": { + "type": "string", + "description": "Name of the local data provider. Name is displayed in the language specified by language code in URL, if available. Otherwise, Name is displayed in English or the language in which the name was provided." + }, + "weatherCode": { + "type": "string", + "description": "Weather code provided by the local data provider. This weather code allows the forecast to be matched to icons provided by the local data provider instead of Azure Maps icons." + } + } + }, + "DayOrNight": { + "type": "object", + "properties": { + "iconCode": { + "type": "integer", + "format": "int32", + "description": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details." + }, + "iconPhrase": { + "type": "string", + "description": "Phrase description of the icon. Displayed in specified language. For example, 'Sunny'." + }, + "localSource": { + "$ref": "#/definitions/LocalSource" + }, + "hasPrecipitation": { + "type": "boolean", + "description": "Indicates the presence or absence of precipitation. True indicates the presence of precipitation, false indicates the absence of precipitation." + }, + "precipitationType": { + "type": "string", + "description": "Specifies the type of precipitation (\"rain\" \"snow\" \"ice\" or \"mix\"). If dbz = zero, precipitationType is not present in the response." + }, + "precipitationIntensity": { + "type": "string", + "description": "Description of the intensity." + }, + "shortPhrase": { + "type": "string", + "description": "Phrase description of the forecast in specified language. Azure Maps attempts to keep this phrase under 30 characters in length, but some languages/weather events may result in a longer phrase length, exceeding 30 characters." + }, + "longPhrase": { + "type": "string", + "description": "Phrase description of the forecast in specified language. Azure Maps attempts to keep this phrase under 100 characters in length, but some languages/weather events may result in a longer phrase length, exceeding 100 characters." + }, + "precipitationProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of precipitation. For example, '20'." + }, + "thunderstormProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of a thunderstorm. For example, '80'." + }, + "rainProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of rain. For example, '40'." + }, + "snowProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of snow. For example, '30'." + }, + "iceProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of ice. For example, '30'." + }, + "wind": { + "$ref": "#/definitions/WindDetails", + "description": "Wind details being returned including speed and direction." + }, + "windGust": { + "$ref": "#/definitions/WindDetails", + "description": "Wind gust. Wind gust is a sudden, brief increase in speed of the wind." + }, + "totalLiquid": { + "$ref": "#/definitions/WeatherUnit", + "description": "Total liquid equivalent of precipitation during the forecast period." + }, + "rain": { + "$ref": "#/definitions/WeatherUnit", + "description": "Rain" + }, + "snow": { + "$ref": "#/definitions/WeatherUnit", + "description": "Snow" + }, + "ice": { + "$ref": "#/definitions/WeatherUnit", + "description": "Ice" + }, + "hoursOfPrecipitation": { + "type": "number", + "format": "float", + "description": "Hours of precipitation" + }, + "hoursOfRain": { + "type": "number", + "format": "float", + "description": "Hours of rain." + }, + "hoursOfSnow": { + "type": "number", + "format": "float", + "description": "Hours of snow." + }, + "hoursOfIce": { + "type": "number", + "format": "float", + "description": "Hours of ice." + }, + "cloudCover": { + "type": "integer", + "format": "int32", + "description": "Percent representing cloud cover." + } + } + }, + "WeatherAlongRouteSummary": { + "description": "Short summary of the weather along the route.", + "type": "object", + "properties": { + "iconCode": { + "type": "integer", + "format": "int32", + "description": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details." + }, + "hazards": { + "$ref": "#/definitions/WeatherHazards" + } + } + }, + "WeatherAlongRouteResponse": { + "type": "object", + "description": "This object is returned from a successful Weather Along Route.", + "properties": { + "summary": { + "$ref": "#/definitions/WeatherAlongRouteSummary" + }, + "waypoints": { + "type": "array", + "description": "Data for each waypoint returned in the same order as specified in the request.", + "items": { + "$ref": "#/definitions/WeatherWaypoint" + } + } + } + }, + "WeatherAlongRoutePrecipitation": { + "description": "Precipitation forecast of the weather along the route.", + "type": "object", + "properties": { + "dbz": { + "type": "number", + "format": "double", + "description": "The forecasted precipitation intensity in dBZ (decibels relative to Z) from 0.0 to 100.0." + }, + "type": { + "type": "string", + "description": "Precipitation type. If precipitation should occur, the type that it will be: \"RAIN,\" \"HAIL,\" \"SNOW,\" \"ICE,\" or \"MIX.\"" + } + } + }, + "SunGlare": { + "type": "object", + "description": "A rating that indicates how blinding the sun is for the driver.", + "properties": { + "calculatedVehicleHeading": { + "type": "integer", + "format": "int32", + "description": "If the vehicle heading value is not provided for a waypoint, then the service will calculate a heading based upon the location of neighboring waypoints if provided." + }, + "glareIndex": { + "type": "integer", + "format": "int32", + "description": "An index from 0 to 100 indicating sun glare intensity for a driver. A value of 50 and above can be considered a hazard for some drivers and a value of 100 signifies the driver is driving straight into the sun and atmospheric conditions are clear allowing for the full intensity of the sun to blind the driver." + } + } + }, + "WeatherWaypoint": { + "type": "object", + "properties": { + "iconCode": { + "type": "integer", + "format": "int32", + "description": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details." + }, + "shortPhrase": { + "type": "string", + "description": "A displayable short phrase describing the forecasted conditions and precipitation intensity/type." + }, + "isDayTime": { + "type": "boolean", + "description": "Indicates the time of the day. True indicates 'day',', false indicates 'night." + }, + "cloudCover": { + "type": "integer", + "format": "int32", + "description": "Percent representing cloud cover." + }, + "temperature": { + "$ref": "#/definitions/WeatherUnit" + }, + "wind": { + "$ref": "#/definitions/WindDetails" + }, + "windGust": { + "$ref": "#/definitions/WindDetails" + }, + "precipitation": { + "$ref": "#/definitions/WeatherAlongRoutePrecipitation" + }, + "lightningCount": { + "type": "integer", + "format": "int32", + "description": "Estimation of thunderstorm intensity on an open scale. A value of 0 means there is no thunderstorm; values of 1 and higher mean there is a thunderstorm in increasing intensity." + }, + "sunGlare": { + "$ref": "#/definitions/SunGlare", + "description": "A rating that indicates how blinding the sun is for the driver." + }, + "hazards": { + "$ref": "#/definitions/WeatherHazards" + }, + "notifications": { + "description": "List of weather hazard notifications.", + "type": "array", + "items": { + "$ref": "#/definitions/WeatherNotification" + } + } + } + }, + "WeatherHazards": { + "description": "Description of the weather hazard affecting the trip.", + "type": "object", + "properties": { + "maxHazardIndex": { + "$ref": "#/definitions/HazardIndex" + }, + "hazardDetails": { + "type": "array", + "description": "Details of the weather hazards affecting the trip.", + "items": { + "$ref": "#/definitions/HazardDetail" + } + } + } + }, + "HazardDetail": { + "type": "object", + "properties": { + "hazardIndex": { + "$ref": "#/definitions/HazardIndex" + }, + "hazardCode": { + "type": "string", + "description": "A unique identifier (non-displayable) for each type of hazard: LightRain, ModerateRain, HeavyRain, LightMix, ModerateMix, HeavyMix, LightSnow, ModerateSnow, HeavySnow, LightIce, ModerateIce, HeavyIce, Hail, LargeHail, SunGlare, SunGlareHigh, Lightning, SevereLightning, WindModerate, WindHigh, WindExtreme, FloodWarning, FlashFloodWarning, TornadoWarning, TsunamiWarning, SevereThunderstormWarning." + }, + "shortPhrase": { + "type": "string", + "description": "A displayable short phrase describing the forecasted conditions and precipitation intensity/type." + } + } + }, + "WeatherNotification": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "A type of notification generated to warn drivers of the onset of a hazard, or increase in intensity of a hazard." + }, + "hazardIndex": { + "$ref": "#/definitions/HazardIndex" + }, + "hazardCode": { + "type": "string", + "description": "A unique identifier (non-displayable) for each type of hazard: LightRain, ModerateRain, HeavyRain, LightMix, ModerateMix, HeavyMix, LightSnow, ModerateSnow, HeavySnow, LightIce, ModerateIce, HeavyIce, Hail, LargeHail, SunGlare, SunGlareHigh, Lightning, SevereLightning, WindModerate, WindHigh, WindExtreme, FloodWarning, FlashFloodWarning, TornadoWarning, TsunamiWarning, SevereThunderstormWarning." + }, + "shortPhrase": { + "type": "string", + "description": "A displayable short phrase describing the forecasted conditions and precipitation intensity/type." + } + } + }, + "SevereWeatherAlertsResponse": { + "type": "object", + "description": "This object is returned from a successful Get Severe Weather Alerts call.", + "properties": { + "results": { + "type": "array", + "items": { + "$ref": "#/definitions/SevereWeatherAlert" + }, + "description": "A list of all severe weather alerts for the queried location." + } + } + }, + "SevereWeatherAlert": { + "type": "object", + "description": "Information about a severe weather alert.", + "properties": { + "countryCode": { + "type": "string", + "description": "2-character ISO 3166-1 Alpha-2 country code, for example, \"US\"." + }, + "alertId": { + "type": "integer", + "format": "int32", + "description": "A unique numerical identifier for a weather alert." + }, + "description": { + "$ref": "#/definitions/SevereWeatherAlertDescription", + "description": "Description of the alert." + }, + "category": { + "type": "string", + "description": "Category of the alert." + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "Number signifying the importance or ranking order of the given alert within the country/region it has originated. A lower number signifies a higher priority. For example, 1 is the highest priority. The number varies by country/region and can change over time as each country/region evolves their alert systems." + }, + "class": { + "type": "string", + "description": "Classification of the alert. This field is not available for all countries and therefore not always returned." + }, + "level": { + "type": "string", + "description": "Severity level of the alert. This field is not available for all countries and therefore not always returned." + }, + "source": { + "type": "string", + "description": "The provider of the alert information. By default the source is returned in English (en-US). The alerts are from official Government Meteorological Agencies and leading global weather alert providers." + }, + "sourceId": { + "type": "integer", + "format": "int32", + "description": "A numerical identifier associated with the source provider name of the alert data." + }, + "disclaimer": { + "type": "string", + "description": "A disclaimer regarding the source of the alert information. This field is not always available. For example, disclaimer may include details about the delays or potential issues related to the alarm." + }, + "alertAreas": { + "type": "array", + "items": { + "$ref": "#/definitions/AlertArea" + }, + "description": "Information about the alert specific to the affected area(s)." + } + } + }, + "SevereWeatherAlertDescription": { + "type": "object", + "description": "Description of a severe weather alert.", + "properties": { + "localized": { + "type": "string", + "description": "Description of the alert in the specified language. By default English (en-US) is returned if the language parameter is not specified in the request." + }, + "english": { + "type": "string", + "description": "Description of the alert in English (en-US)." + } + } + }, + "AlertArea": { + "type": "object", + "description": "Information about a severe weather alert issued within an affected area(s). If multiple alerts are active for the same location, the alerts will be returned in order of `priority` within the API response, with the highest priority alert being returned at the top of the response.", + "properties": { + "name": { + "type": "string", + "description": "The name of an area which is affected by the alert. The location that was requested falls under the alert area." + }, + "summary": { + "type": "string", + "description": "Text summarizing the alert in the returned area." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start date and time of the alert in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. If the alert crosses multiple time zones the returned time in the response is the local time to the requested coordinate location." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end date and time of the alert in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. If the alert crosses multiple time zones the returned time in the response is the local time to the requested coordinate location." + }, + "latestStatus": { + "$ref": "#/definitions/LatestStatus", + "description": "The latest status of the alert in the current area." + }, + "alertDetails": { + "type": "string", + "description": "Full details associated with the alert. Returned if `details`=True. This field is always returned in the language(s) of choice by the issuing provider and Azure Maps only returns what is created by the provider. Please note, some countries/regions may offer their native language and English. Language parameter won’t apply to this field." + }, + "alertDetailsLanguageCode": { + "type": "string", + "description": "Language of the `alertDetails`. This field helps to point out that the language of the `alertDetails` may differ from the requested language parameter. Returned if `details`=True. Language code has been derived from the ISO 639-1 Alpha-2 codes." + } + } + }, + "LatestStatus": { + "type": "object", + "description": "The latest status on the alert in the current area.", + "properties": { + "localized": { + "type": "string", + "description": "The latest status keyword for the alert, in the specified language. By default, returned in English (en-US)." + }, + "english": { + "$ref": "#/definitions/LatestStatusKeyword", + "description": "Latest status keyword for the alert, in English (en-US)." + } + } + }, + "LatestStatusKeyword": { + "type": "string", + "description": "Keyword for the latest status of the alert.", + "enum": [ + "New", + "Extend", + "Cancel", + "Correct", + "Expire", + "Upgrade", + "Continue", + "Update" + ], + "x-ms-enum": { + "name": "LatestStatusKeyword", + "modelAsString": true, + "values": [ + { + "value": "New", + "description": "\"New\" - the status of an alert upon initial issuance." + }, + { + "value": "Extend", + "description": "\"Extend\" - the alert has been extended in time, in area, or both since its initial issuance." + }, + { + "value": "Cancel", + "description": "\"Cancel\" - the alert has been canceled prior to its original expiration time." + }, + { + "value": "Correct", + "description": "\"Correct\" - the alert has been modified to correct a previous error." + }, + { + "value": "Expire", + "description": "\"Expire\" - the alert has expired and is no longer active." + }, + { + "value": "Upgrade", + "description": "\"Upgrade\" - the alert has been upgraded to a higher class or category since its initial issuance." + }, + { + "value": "Continue", + "description": "\"Continue\" - the alert has been updated since its initial issuance, but no changes were made to `alertAreas`, `startTime`, `endTime`, or `class`." + }, + { + "value": "Update", + "description": "\"Update\" - the alert has been updated since its initial issuance." + } + ] + } + }, + "DailyIndicesResponse": { + "type": "object", + "description": "This object is returned from a successful Get Daily Indices call.", + "properties": { + "results": { + "type": "array", + "items": { + "$ref": "#/definitions/DailyIndex" + }, + "description": "A list of all daily indices for the queried location." + } + } + }, + "DailyIndex": { + "type": "object", + "description": "Information about a daily index.", + "properties": { + "indexName": { + "type": "string", + "description": "Name of the index, for example, \"Construction\", \"Outdoor Activity\", \"Flight Delays\"." + }, + "indexId": { + "type": "integer", + "format": "int32", + "description": "Numeric ID used to identify the specific index. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported index IDs. For example, the index ID can support UI visualization scenarios." + }, + "dateTime": { + "type": "string", + "format": "date-time", + "description": "Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "value": { + "type": "number", + "format": "float", + "description": "Index value. Ranges from 0.0 to 10.0. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported ranges." + }, + "category": { + "type": "string", + "description": "Textual description for `categoryValue` corresponding to the level that the index value falls under, for example \"Very Good\"." + }, + "categoryValue": { + "type": "integer", + "format": "int32", + "description": "Level that the index value falls under, represented by an integer. This value can be 1 through 5 and should be used in combination with the `ascending` flag because it can differ among indices. For example, the following values apply for Mosquito Activity: Low=1, Moderate=2, High=3, Very High=4, and Extreme=5." + }, + "ascending": { + "type": "boolean", + "description": "Describes the direction of the `value` and `categoryValue`. For example, when `ascending`=True, the poorest index value is 0 and the best index value is 10. When `ascending`=True, the poorest index value is 10 and the best index value is 0." + }, + "description": { + "type": "string", + "description": "A textual explanation that can be used for display purposes to summarize the index value and category. For example, when the index value for Flight Delays is very good, the description will be \"Conditions are excellent for flying!\"." + } + } + } + } +} diff --git a/specification/maps/data-plane/Weather/readme.csharp.md b/specification/maps/data-plane/Weather/readme.csharp.md new file mode 100644 index 000000000000..2635a9fba1ed --- /dev/null +++ b/specification/maps/data-plane/Weather/readme.csharp.md @@ -0,0 +1,13 @@ +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +sync-methods: None +license-header: MICROSOFT_MIT_NO_VERSION +namespace: Azure.Maps.Weather +output-folder: $(csharp-sdks-folder)/maps/Azure.Maps.Weather/src/Generated +clear-output-folder: true +public-clients: true +``` \ No newline at end of file diff --git a/specification/maps/data-plane/Weather/readme.go.md b/specification/maps/data-plane/Weather/readme.go.md new file mode 100644 index 000000000000..23eab3b04570 --- /dev/null +++ b/specification/maps/data-plane/Weather/readme.go.md @@ -0,0 +1,26 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +license-header: MICROSOFT_MIT_NO_VERSION +namespace: weather +clear-output-folder: true +export-clients: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: 1.0-preview +``` + +### Tag: 1.0-preview and go + +These settings apply only when `--tag=1.0-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == '1.0-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/maps/1.0/$(namespace) +``` \ No newline at end of file diff --git a/specification/maps/data-plane/Weather/readme.java.md b/specification/maps/data-plane/Weather/readme.java.md new file mode 100644 index 000000000000..cc5ac4273531 --- /dev/null +++ b/specification/maps/data-plane/Weather/readme.java.md @@ -0,0 +1,9 @@ +## Java + +``` yaml $(java) +java: + namespace: com.azure.maps.weather + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 0 + output-folder: $(azure-libraries-for-java-folder)/azure-maps-weather +``` \ No newline at end of file diff --git a/specification/maps/data-plane/Weather/readme.md b/specification/maps/data-plane/Weather/readme.md new file mode 100644 index 000000000000..bdcee5b6b223 --- /dev/null +++ b/specification/maps/data-plane/Weather/readme.md @@ -0,0 +1,89 @@ +# Azure Weather + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Weather Client + +--- + +## Getting Started + +To build the SDK for Weather, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +### Basic Information + +These are the global settings for Weather Client. + +``` yaml +title: WeatherClient +openapi-type: data-plane +tag: 1.0-preview +# at some point those credentials will move away to Swagger according to [this](https://github.com/Azure/autorest/issues/3718) +add-credentials: true +credential-default-policy-type: BearerTokenCredentialPolicy +credential-scopes: https://atlas.microsoft.com/.default +``` + + +### Tag: 1.0-preview + +These settings apply only when `--tag=1.0-preview` is specified on the command line. + +``` yaml $(tag) == '1.0-preview' +input-file: + - preview/1.0/weather.json +``` + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-java + + #track1 doesn't support data-plane for go + #manually generate for now with track2 + #- repo: azure-sdk-for-go + + #track1 doesn't support features needed for typescript + #manually generate for now with track2 + #- repo: azure-sdk-for-js + + #should be azure-sdk-for-net-track2, but SDK has not yet onboarded + #manually generate for now with track2 + - repo: azure-sdk-for-net +``` +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Java + +See configuration in [readme.java.md](./readme.java.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) diff --git a/specification/maps/data-plane/Weather/readme.python.md b/specification/maps/data-plane/Weather/readme.python.md new file mode 100644 index 000000000000..cc6dc945e5ce --- /dev/null +++ b/specification/maps/data-plane/Weather/readme.python.md @@ -0,0 +1,22 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +license-header: MICROSOFT_MIT_NO_VERSION +namespace: azure.maps.weather +package-name: azure-maps-weather +package-version: 1.0-preview +clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +no-namespace-folders: true +output-folder: $(python-sdks-folder)/maps/azure-maps-weather/azure/maps/weather +``` +``` yaml $(python) && $(python-mode) == 'create' +basic-setup-py: true +output-folder: $(python-sdks-folder)/maps/azure-maps-weather +``` diff --git a/specification/maps/data-plane/Weather/readme.typescript.md b/specification/maps/data-plane/Weather/readme.typescript.md new file mode 100644 index 000000000000..e162fd5d6fbe --- /dev/null +++ b/specification/maps/data-plane/Weather/readme.typescript.md @@ -0,0 +1,14 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +azure-arm: false +package-name: "@azure/maps-weather" +license-header: MICROSOFT_MIT_NO_VERSION +output-folder: "$(typescript-sdks-folder)/sdk/maps/maps-weather" +source-code-folder-path: "" +clear-output-folder: false +generate-metadata: false +``` diff --git a/specification/maps/resource-manager/readme.md b/specification/maps/resource-manager/readme.md index 37d96a20a3ee..dd4f68353760 100644 --- a/specification/maps/resource-manager/readme.md +++ b/specification/maps/resource-manager/readme.md @@ -88,7 +88,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-go - repo: azure-sdk-for-js diff --git a/specification/maps/resource-manager/readme.python.md b/specification/maps/resource-manager/readme.python.md index 3982b3230525..d4591dab403f 100644 --- a/specification/maps/resource-manager/readme.python.md +++ b/specification/maps/resource-manager/readme.python.md @@ -4,36 +4,17 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.maps - package-name: azure-mgmt-maps - package-version: 0.1.0 - clear-output-folder: true -``` + ``` yaml $(python) && $(track2) python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.maps package-name: azure-mgmt-maps -package-version: 0.1.0 +package-version: 1.0.0b1 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/maps/azure-mgmt-maps/azure/mgmt/maps -``` -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/maps/azure-mgmt-maps -``` + ``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/maps/azure-mgmt-maps/azure/mgmt/maps diff --git a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/mariadb.json b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/mariadb.json index 7e38b7986939..bca12c6c71fa 100644 --- a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/mariadb.json +++ b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/mariadb.json @@ -34,7 +34,7 @@ } }, "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}": { "put": { "tags": [ "Servers" @@ -217,7 +217,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers": { "get": { "tags": [ "Servers" @@ -253,7 +253,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMariaDB/servers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMariaDB/servers": { "get": { "tags": [ "Servers" @@ -286,7 +286,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/restart": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/restart": { "post": { "tags": [ "ServerRestart" @@ -329,7 +329,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/replicas": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/replicas": { "get": { "tags": [ "Replicas" @@ -368,7 +368,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/firewallRules/{firewallRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/firewallRules/{firewallRuleName}": { "put": { "tags": [ "FirewallRules" @@ -504,7 +504,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/firewallRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/firewallRules": { "get": { "tags": [ "FirewallRules" @@ -543,7 +543,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { "get": { "tags": [ "VirtualNetworkRules" @@ -688,7 +688,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/virtualNetworkRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/virtualNetworkRules": { "get": { "tags": [ "VirtualNetworkRules" @@ -730,7 +730,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/databases/{databaseName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/databases/{databaseName}": { "put": { "tags": [ "Databases" @@ -866,7 +866,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/databases": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/databases": { "get": { "tags": [ "Databases" @@ -905,7 +905,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/configurations/{configurationName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/configurations/{configurationName}": { "put": { "tags": [ "Configurations" @@ -994,7 +994,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/configurations": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/configurations": { "get": { "tags": [ "Configurations" @@ -1033,7 +1033,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/updateConfigurations": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/updateConfigurations": { "post": { "tags": [ "UpdateConfigurations" @@ -1091,7 +1091,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/logFiles": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/logFiles": { "get": { "tags": [ "LogFiles" @@ -1130,7 +1130,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/recoverableServers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/recoverableServers": { "get": { "tags": [ "RecoverableServers" @@ -1172,7 +1172,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/performanceTiers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/performanceTiers": { "get": { "tags": [ "ServerBasedPerformanceTier" @@ -1217,7 +1217,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMariaDB/locations/{locationName}/performanceTiers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMariaDB/locations/{locationName}/performanceTiers": { "get": { "tags": [ "LocationBasedPerformanceTier" @@ -1253,7 +1253,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMariaDB/checkNameAvailability": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMariaDB/checkNameAvailability": { "post": { "tags": [ "CheckNameAvailability" @@ -1292,7 +1292,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { "get": { "tags": [ "ServerSecurityAlertPolicies" @@ -1454,7 +1454,7 @@ } } }, - "/providers/Microsoft.DBForMariaDB/operations": { + "/providers/Microsoft.DBforMariaDB/operations": { "get": { "tags": [ "Operations" diff --git a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-privatepreview/mariadb.json b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-privatepreview/mariadb.json index 60fe0cbad06f..c3d3eba2c250 100644 --- a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-privatepreview/mariadb.json +++ b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-privatepreview/mariadb.json @@ -34,7 +34,7 @@ } }, "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}": { "put": { "tags": [ "Servers" @@ -217,7 +217,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers": { "get": { "tags": [ "Servers" @@ -253,7 +253,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMariaDB/servers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMariaDB/servers": { "get": { "tags": [ "Servers" @@ -286,7 +286,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/restart": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/restart": { "post": { "tags": [ "ServerRestart" @@ -329,7 +329,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/replicas": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/replicas": { "get": { "tags": [ "Replicas" @@ -368,7 +368,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/firewallRules/{firewallRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/firewallRules/{firewallRuleName}": { "put": { "tags": [ "FirewallRules" @@ -504,7 +504,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/firewallRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/firewallRules": { "get": { "tags": [ "FirewallRules" @@ -543,7 +543,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { "get": { "tags": [ "VirtualNetworkRules" @@ -688,7 +688,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/virtualNetworkRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/virtualNetworkRules": { "get": { "tags": [ "VirtualNetworkRules" @@ -730,7 +730,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/databases/{databaseName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/databases/{databaseName}": { "put": { "tags": [ "Databases" @@ -866,7 +866,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/databases": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/databases": { "get": { "tags": [ "Databases" @@ -905,7 +905,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/configurations/{configurationName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/configurations/{configurationName}": { "put": { "tags": [ "Configurations" @@ -994,7 +994,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/configurations": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/configurations": { "get": { "tags": [ "Configurations" @@ -1033,7 +1033,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/logFiles": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/logFiles": { "get": { "tags": [ "LogFiles" @@ -1072,7 +1072,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMariaDB/locations/{locationName}/performanceTiers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMariaDB/locations/{locationName}/performanceTiers": { "get": { "tags": [ "LocationBasedPerformanceTier" @@ -1108,7 +1108,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMariaDB/checkNameAvailability": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMariaDB/checkNameAvailability": { "post": { "tags": [ "CheckNameAvailability" @@ -1147,7 +1147,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { "get": { "tags": [ "ServerSecurityAlertPolicies" @@ -1267,7 +1267,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/queryTexts/{queryId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/queryTexts/{queryId}": { "get": { "tags": [ "QueryTexts" @@ -1306,7 +1306,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/queryTexts": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/queryTexts": { "get": { "tags": [ "QueryTexts" @@ -1356,7 +1356,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/topQueryStatistics/{queryStatisticId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/topQueryStatistics/{queryStatisticId}": { "get": { "tags": [ "TopQueryStatistics" @@ -1395,7 +1395,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/topQueryStatistics": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/topQueryStatistics": { "get": { "tags": [ "TopQueryStatistics" @@ -1443,7 +1443,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/waitStatistics/{waitStatisticsId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/waitStatistics/{waitStatisticsId}": { "get": { "tags": [ "WaitStatistics" @@ -1482,7 +1482,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/waitStatistics": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/waitStatistics": { "get": { "tags": [ "WaitStatistics" @@ -1530,7 +1530,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/advisors/{advisorName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/advisors/{advisorName}": { "get": { "tags": [ "Advisors" @@ -1569,7 +1569,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/advisors": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/advisors": { "get": { "tags": [ "Advisors" @@ -1608,7 +1608,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/advisors/{advisorName}/createRecommendedActionSession": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/advisors/{advisorName}/createRecommendedActionSession": { "post": { "tags": [ "RecommendedActionSessions" @@ -1655,7 +1655,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/advisors/{advisorName}/recommendedActions/{recommendedActionName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/advisors/{advisorName}/recommendedActions/{recommendedActionName}": { "get": { "tags": [ "RecommendedActions" @@ -1697,7 +1697,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/advisors/{advisorName}/recommendedActions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/advisors/{advisorName}/recommendedActions": { "get": { "tags": [ "RecommendedActions" @@ -1746,7 +1746,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMariaDB/locations/{locationName}/recommendedActionSessionsAzureAsyncOperation/{operationId}": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMariaDB/locations/{locationName}/recommendedActionSessionsAzureAsyncOperation/{operationId}": { "get": { "tags": [ "LocationBasedRecommendedActionSessionsOperationStatus" @@ -1782,7 +1782,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMariaDB/locations/{locationName}/recommendedActionSessionsOperationResults/{operationId}": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMariaDB/locations/{locationName}/recommendedActionSessionsOperationResults/{operationId}": { "get": { "tags": [ "LocationBasedRecommendedActionSessionsResult" @@ -1827,7 +1827,7 @@ } } }, - "/providers/Microsoft.DBForMariaDB/operations": { + "/providers/Microsoft.DBforMariaDB/operations": { "get": { "tags": [ "Operations" diff --git a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2018-06-01/mariadb.json b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2018-06-01/mariadb.json index eb3707e782e9..0821e2db08b4 100644 --- a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2018-06-01/mariadb.json +++ b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2018-06-01/mariadb.json @@ -34,7 +34,7 @@ } }, "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}": { "put": { "tags": [ "Servers" @@ -241,7 +241,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers": { "get": { "tags": [ "Servers" @@ -283,7 +283,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMariaDB/servers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMariaDB/servers": { "get": { "tags": [ "Servers" @@ -322,7 +322,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/restart": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/restart": { "post": { "tags": [ "ServerRestart" @@ -365,7 +365,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/replicas": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/replicas": { "get": { "tags": [ "Replicas" @@ -410,7 +410,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/firewallRules/{firewallRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/firewallRules/{firewallRuleName}": { "put": { "tags": [ "FirewallRules" @@ -564,7 +564,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/firewallRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/firewallRules": { "get": { "tags": [ "FirewallRules" @@ -609,7 +609,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { "get": { "tags": [ "VirtualNetworkRules" @@ -754,7 +754,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/virtualNetworkRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/virtualNetworkRules": { "get": { "tags": [ "VirtualNetworkRules" @@ -796,7 +796,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/databases/{databaseName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/databases/{databaseName}": { "put": { "tags": [ "Databases" @@ -950,7 +950,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/databases": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/databases": { "get": { "tags": [ "Databases" @@ -995,7 +995,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/configurations/{configurationName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/configurations/{configurationName}": { "put": { "tags": [ "Configurations" @@ -1096,7 +1096,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/configurations": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/configurations": { "get": { "tags": [ "Configurations" @@ -1141,7 +1141,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/updateConfigurations": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/updateConfigurations": { "post": { "tags": [ "ConfigurationsUpdate" @@ -1199,7 +1199,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/logFiles": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/logFiles": { "get": { "tags": [ "LogFiles" @@ -1244,7 +1244,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/recoverableServers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/recoverableServers": { "get": { "tags": [ "RecoverableServers" @@ -1286,7 +1286,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/performanceTiers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/performanceTiers": { "get": { "tags": [ "ServerBasedPerformanceTier" @@ -1331,7 +1331,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMariaDB/locations/{locationName}/performanceTiers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMariaDB/locations/{locationName}/performanceTiers": { "get": { "tags": [ "LocationBasedPerformanceTier" @@ -1373,7 +1373,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMariaDB/checkNameAvailability": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMariaDB/checkNameAvailability": { "post": { "tags": [ "CheckNameAvailability" @@ -1418,7 +1418,7 @@ } } }, - "/providers/Microsoft.DBForMariaDB/operations": { + "/providers/Microsoft.DBforMariaDB/operations": { "get": { "tags": [ "Operations" diff --git a/specification/mariadb/resource-manager/readme.md b/specification/mariadb/resource-manager/readme.md index d66cf11b7e12..ecc148f8d3fc 100644 --- a/specification/mariadb/resource-manager/readme.md +++ b/specification/mariadb/resource-manager/readme.md @@ -112,7 +112,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js @@ -138,48 +138,7 @@ csharp: ## Python -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.rdbms.mariadb - package-name: azure-mgmt-rdbms - clear-output-folder: true -``` -``` yaml $(python) && $(track2) -python-mode: create -azure-arm: true -license-header: MICROSOFT_MIT_NO_VERSION -namespace: azure.mgmt.rdbms.mariadb -package-name: azure-mgmt-rdbms -clear-output-folder: true -modelerfour: - lenient-model-deduplication: true -``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms/azure/mgmt/rdbms/mariadb -``` -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms -``` -``` yaml $(python) && $(python-mode) == 'update' && $(track2) -no-namespace-folders: true -output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms/azure/mgmt/rdbms/mariadb -``` -``` yaml $(python) && $(python-mode) == 'create' && $(track2) -basic-setup-py: true -output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms -``` +See configuration in [readme.python.md](./readme.python.md) ## Go diff --git a/specification/mariadb/resource-manager/readme.python.md b/specification/mariadb/resource-manager/readme.python.md new file mode 100644 index 000000000000..6a0735e0f490 --- /dev/null +++ b/specification/mariadb/resource-manager/readme.python.md @@ -0,0 +1,27 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) && $(track2) +python-mode: create +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +namespace: azure.mgmt.rdbms.mariadb +package-name: azure-mgmt-rdbms +package-version: 1.0.0b1 +clear-output-folder: true +modelerfour: + lenient-model-deduplication: true +``` + + +``` yaml $(python) && $(python-mode) == 'update' && $(track2) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms/azure/mgmt/rdbms/mariadb +``` +``` yaml $(python) && $(python-mode) == 'create' && $(track2) +basic-setup-py: true +output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms +``` \ No newline at end of file diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2019-12-01/Marketplace.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2019-12-01/Marketplace.json deleted file mode 100644 index 76d987df9829..000000000000 --- a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2019-12-01/Marketplace.json +++ /dev/null @@ -1,174 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2019-12-01", - "title": "Marketplace RP Service" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/privateStoreClient/isPrivateClient": { - "get": { - "tags": [ - "isPrivateClient" - ], - "description": "Check if client is private or not.", - "operationId": "PrivateStoreClient_Get", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded." - } - }, - "x-ms-examples": { - "GetPrivateStoreClient": { - "$ref": "./examples/GetPrivateStoreClient.json" - } - }, - "produces": [ - "application/json" - ], - "consumes": [ - "application/json" - ] - } - }, - "/providers/Microsoft.Marketplace/operations": { - "get": { - "tags": [ - "Operations" - ], - "description": "Lists all of the available Microsoft.Marketplace REST API operations.", - "operationId": "Operations_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - }, - "default": { - "description": "Microsoft.Marketplace error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - } - }, - "parameters": { - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request." - }, - "subscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "The Azure subscription ID.", - "required": true, - "type": "string" - } - }, - "definitions": { - "ErrorResponse": { - "description": "Error response indicates Microsoft.Marketplace service is not able to process the incoming request. The reason is provided in the error message.", - "type": "object", - "properties": { - "error": { - "description": "The details of the error.", - "properties": { - "code": { - "description": "Error code.", - "type": "string", - "readOnly": true - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string", - "readOnly": true - } - } - } - } - }, - "Operation": { - "description": "Microsoft.Marketplace REST API operation", - "type": "object", - "properties": { - "name": { - "description": "Operation name: {provider}/{resource}/{operation}", - "type": "string" - }, - "display": { - "description": "The object that represents the operation.", - "properties": { - "provider": { - "description": "Service provider: Microsoft.Marketplace", - "type": "string" - }, - "resource": { - "description": "Resource on which the operation is performed: Amendments", - "type": "string" - }, - "operation": { - "description": "Operation type: Get Amendments etc.", - "type": "string" - } - } - } - } - }, - "OperationListResult": { - "description": "Result of the request to list Marketplace 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 Microsoft.Marketplace operations supported by the Microsoft.Marketplace resource provider." - }, - "nextLink": { - "type": "string", - "description": "URL to get the next set of operation list results if there are any.", - "readOnly": true - } - } - } - }, - "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" - } - } - } -} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2019-12-01/examples/GetPrivateStoreClient.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2019-12-01/examples/GetPrivateStoreClient.json deleted file mode 100644 index 8458e8864299..000000000000 --- a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2019-12-01/examples/GetPrivateStoreClient.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "api-version": "2019-12-01" - }, - "responses": { - "200": { - "description": "OK. The request has succeeded." - } - } -} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2020-01-01/Marketplace.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2020-01-01/Marketplace.json index 4bf90e4eea96..83ee490aa16a 100644 --- a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2020-01-01/Marketplace.json +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2020-01-01/Marketplace.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "version": "2020-01-01", - "title": "MarketplaceManagementClient", + "title": "Marketplace RP Service", "description": "REST APIs for Azure Marketplace" }, "host": "management.azure.com", diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2020-12-01/Marketplace.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2020-12-01/Marketplace.json index 31e1786825ce..88be9353ebef 100644 --- a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2020-12-01/Marketplace.json +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2020-12-01/Marketplace.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "version": "2020-12-01", - "title": "MarketplaceManagementClient", + "title": "Marketplace RP Service", "description": "REST APIs for Azure Marketplace" }, "host": "management.azure.com", diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/Marketplace.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/Marketplace.json new file mode 100644 index 000000000000..66059897c269 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/Marketplace.json @@ -0,0 +1,2529 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01", + "title": "Marketplace RP Service", + "description": "REST APIs for Private Marketplace" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.Marketplace/privateStores": { + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/UseCacheParameter" + } + ], + "get": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_List", + "description": "Gets the list of available private stores.", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PrivateStoreList" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetPrivateStores": { + "$ref": "./examples/GetPrivateStores.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_Get", + "description": "Get information about the private store", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PrivateStore" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetPrivateStore": { + "$ref": "./examples/GetPrivateStore.json" + } + } + }, + "put": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_CreateOrUpdate", + "description": "Changes private store properties", + "parameters": [ + { + "in": "body", + "name": "payload", + "schema": { + "$ref": "#/definitions/PrivateStore" + } + } + ], + "responses": { + "200": { + "description": "Change successful" + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateStores_update": { + "$ref": "./examples/PrivateStores_update.json" + } + } + }, + "delete": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_Delete", + "description": "Deletes the private store. All that is not saved will be lost.", + "responses": { + "200": { + "description": "Private store was deleted successfully." + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeletePrivateStores": { + "$ref": "./examples/DeletePrivateStore.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/queryOffers": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "post": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_QueryOffers", + "description": "List of offers, regardless the collections", + "responses": { + "200": { + "description": "List of offers", + "schema": { + "$ref": "#/definitions/QueryOffers" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "QueryOffers": { + "$ref": "./examples/QueryOffers.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/billingAccounts": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "post": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_BillingAccounts", + "description": "Tenant billing accounts names", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BillingAccountsResponse" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingAccounts": { + "$ref": "./examples/BillingAccounts.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collectionsToSubscriptionsMapping": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "post": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_CollectionsToSubscriptionsMapping", + "description": "For a given subscriptions list, the API will return a map of collections and the related subscriptions from the supplied list.", + "parameters": [ + { + "in": "body", + "name": "payload", + "schema": { + "$ref": "#/definitions/CollectionsToSubscriptionsMappingPayload" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CollectionsToSubscriptionsMappingResponse" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CollectionsToSubscriptionsMapping": { + "$ref": "./examples/CollectionsToSubscriptionsMapping.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collections": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStoreCollection_List", + "description": "Gets private store collections list", + "responses": { + "200": { + "description": "Collections list information retrieved", + "schema": { + "$ref": "#/definitions/CollectionsList" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetPrivateStoreCollectionsList": { + "$ref": "./examples/GetPrivateStoreCollectionsList.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collections/{collectionId}": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/CollectionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStoreCollection_Get", + "description": "Gets private store collection", + "responses": { + "200": { + "description": "Collection information retrieved", + "schema": { + "$ref": "#/definitions/Collection" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetPrivateStoreCollection": { + "$ref": "./examples/GetPrivateStoreCollection.json" + } + } + }, + "put": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStoreCollection_CreateOrUpdate", + "description": "Create or update private store collection", + "parameters": [ + { + "in": "body", + "name": "payload", + "schema": { + "$ref": "#/definitions/Collection" + } + } + ], + "responses": { + "200": { + "description": "Create or update collection properties", + "schema": { + "$ref": "#/definitions/Collection" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreatePrivateStoreCollection": { + "$ref": "./examples/CreatePrivateStoreCollection.json" + } + } + }, + "delete": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStoreCollection_Delete", + "description": "Delete a collection from the given private store.", + "responses": { + "200": { + "description": "Collection was deleted successfully" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeletePrivateStoreCollection": { + "$ref": "./examples/DeletePrivateStoreCollection.json" + } + } + }, + "post": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStoreCollection_Post", + "description": "Delete Private store collection. This is a workaround.", + "parameters": [ + { + "in": "body", + "name": "payload", + "schema": { + "$ref": "#/definitions/PrivateStoreOperation" + } + } + ], + "responses": { + "200": { + "description": "Operation succeeded" + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PostPrivateStoreCollection": { + "$ref": "./examples/PostPrivateStoreCollection.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collections/{collectionId}/transferOffers": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/CollectionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "post": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStoreCollection_TransferOffers", + "description": "transferring offers (copy or move) from source collection to target collection(s)", + "parameters": [ + { + "in": "body", + "name": "payload", + "schema": { + "$ref": "#/definitions/TransferOffersProperties" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TransferOffersResponse" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TransferOffers": { + "$ref": "./examples/TransferOffers.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/queryApprovedPlans": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "post": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_QueryApprovedPlans", + "description": "Get map of plans and related approved subscriptions.", + "parameters": [ + { + "in": "body", + "name": "payload", + "schema": { + "$ref": "#/definitions/QueryApprovedPlansPayload" + } + } + ], + "responses": { + "200": { + "description": "Map of plan ids and their related approved subscriptions.", + "schema": { + "$ref": "#/definitions/QueryApprovedPlansResponse" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "QueryApprovedPlans": { + "$ref": "./examples/QueryApprovedPlans.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/bulkCollectionsAction": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "post": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_BulkCollectionsAction", + "description": "Perform an action on bulk collections", + "parameters": [ + { + "in": "body", + "name": "payload", + "schema": { + "$ref": "#/definitions/BulkCollectionsPayload" + } + } + ], + "responses": { + "200": { + "description": "The collections id and name that the action was performed on", + "schema": { + "$ref": "#/definitions/BulkCollectionsResponse" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BulkCollectionsAction": { + "$ref": "./examples/BulkCollectionsAction.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collections/{collectionId}/offers": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/CollectionIdParameter" + } + ], + "get": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStoreCollectionOffer_List", + "description": "Get a list of all private offers in the given private store and collection", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OfferListResponse" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetPrivateStoreOffers": { + "$ref": "./examples/GetPrivateStoreOffers.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collections/{collectionId}/offers/{offerId}": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/OfferIdPathParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/CollectionIdParameter" + } + ], + "get": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStoreCollectionOffer_Get", + "description": "Gets information about a specific offer.", + "responses": { + "200": { + "description": "Offer information retrieved", + "schema": { + "$ref": "#/definitions/Offer" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetPrivateStoreCollectionOffer": { + "$ref": "./examples/GetPrivateStoreCollectionOffer.json" + } + } + }, + "put": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStoreCollectionOffer_CreateOrUpdate", + "description": "Update or add an offer to a specific collection of the private store.", + "parameters": [ + { + "in": "body", + "name": "payload", + "schema": { + "$ref": "#/definitions/Offer" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Offer" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateStoreOffer_update": { + "$ref": "./examples/PrivateStoreOffer_update.json" + } + } + }, + "delete": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStoreCollectionOffer_Delete", + "description": "Deletes an offer from the given collection of private store.", + "responses": { + "200": { + "description": "Offer was deleted successfully" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeletePrivateStoreOffer": { + "$ref": "./examples/DeletePrivateStoreOffer.json" + } + } + }, + "post": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStoreCollectionOffer_Post", + "description": "Delete Private store offer. This is a workaround.", + "parameters": [ + { + "in": "body", + "name": "payload", + "schema": { + "$ref": "#/definitions/PrivateStoreOperation" + } + } + ], + "responses": { + "200": { + "description": "Operation succeeded" + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PostPrivateStoreCollectionOffer": { + "$ref": "./examples/PostPrivateStoreCollectionOffer.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/requestApprovals": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_GetApprovalRequestsList", + "description": "Get all open approval requests of current user", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RequestApprovalsList" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetApprovalRequestsList": { + "$ref": "./examples/GetApprovalRequestsList.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/requestApprovals/{requestApprovalId}": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/RequestApprovalIdPathParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_GetRequestApproval", + "description": "Get open request approval details", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RequestApprovalResource" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetApprovalRequest": { + "$ref": "./examples/GetRequestApproval.json" + } + } + }, + "put": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_CreateApprovalRequest", + "description": "Create approval request", + "parameters": [ + { + "in": "body", + "name": "payload", + "schema": { + "$ref": "#/definitions/RequestApprovalResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RequestApprovalResource" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateApprovalRequest": { + "$ref": "./examples/CreateApprovalRequest.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/requestApprovals/{requestApprovalId}/query": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/RequestApprovalIdPathParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "post": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_QueryRequestApproval", + "description": "Get request statuses foreach plan, this api is used as a complex GET action.", + "parameters": [ + { + "in": "body", + "name": "payload", + "schema": { + "$ref": "#/definitions/QueryRequestApprovalProperties" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/QueryRequestApproval" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "QueryRequestApproval": { + "$ref": "./examples/QueryRequestApproval.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/adminRequestApprovals": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_AdminRequestApprovalsList", + "description": "Get list of admin request approvals", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AdminRequestApprovalsList" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AdminRequestApprovalsList": { + "$ref": "./examples/AdminRequestApprovalsList.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/adminRequestApprovals/{adminRequestApprovalId}": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/AdminRequestApprovalIdPathParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_GetAdminRequestApproval", + "description": "Get open approval requests", + "parameters": [ + { + "$ref": "#/parameters/PublisherIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AdminRequestApprovalsResource" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetAdminRequestApproval": { + "$ref": "./examples/GetAdminRequestApproval.json" + } + } + }, + "put": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_UpdateAdminRequestApproval", + "description": "Update the admin action, weather the request is approved or rejected and the approved plans", + "parameters": [ + { + "in": "body", + "name": "payload", + "schema": { + "$ref": "#/definitions/AdminRequestApprovalsResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AdminRequestApprovalsResource" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateAdminRequestApproval": { + "$ref": "./examples/UpdateAdminRequestApproval.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/queryNotificationsState": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "post": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_QueryNotificationsState", + "description": "Get private store notifications state", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateStoreNotificationsState" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NotificationsState": { + "$ref": "./examples/NotificationsState.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers/{offerId}/acknowledgeNotification": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/OfferIdPathParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "post": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_AcknowledgeOfferNotification", + "description": "Acknowledge notification for offer", + "parameters": [ + { + "in": "body", + "name": "payload", + "schema": { + "$ref": "#/definitions/AcknowledgeOfferNotificationProperties" + } + } + ], + "responses": { + "200": { + "description": "OK, notification was acknowledged by the RP" + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AcknowledgeNotification": { + "$ref": "./examples/AcknowledgeNotification.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/requestApprovals/{requestApprovalId}/withdrawPlan": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/RequestApprovalIdPathParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "post": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_WithdrawPlan", + "description": "Withdraw a user request approval on specific plan", + "parameters": [ + { + "in": "body", + "name": "payload", + "schema": { + "$ref": "#/definitions/WithdrawProperties" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WithdrawPlan": { + "$ref": "./examples/WithdrawPlan.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available Microsoft.Marketplace REST API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "parameters": { + "PrivateStoreIdParameter": { + "name": "privateStoreId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The store ID - must use the tenant ID" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request." + }, + "CollectionIdParameter": { + "name": "collectionId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The collection ID" + }, + "OfferIdPathParameter": { + "in": "path", + "name": "offerId", + "type": "string", + "x-ms-parameter-location": "method", + "required": true, + "description": "The offer ID to update or delete" + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "type": "string", + "x-ms-parameter-location": "method", + "required": true, + "description": "Subscription id of the private offers" + }, + "UseCacheParameter": { + "name": "use-cache", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Determines if to use cache or DB for serving this request" + }, + "AdminRequestApprovalIdPathParameter": { + "in": "path", + "name": "adminRequestApprovalId", + "type": "string", + "x-ms-parameter-location": "method", + "required": true, + "description": "The admin request approval ID to get create or update" + }, + "RequestApprovalIdPathParameter": { + "in": "path", + "name": "requestApprovalId", + "type": "string", + "x-ms-parameter-location": "method", + "required": true, + "description": "The request approval ID to get create or update" + }, + "PublisherIdParameter": { + "name": "publisherId", + "in": "query", + "required": true, + "x-ms-parameter-location": "method", + "type": "string", + "description": "The publisher id of this offer." + } + }, + "definitions": { + "PrivateStoreList": { + "description": "Describes the json payload for the list of available private stores (between zero and one, inclusive)", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateStore" + } + }, + "nextLink": { + "description": "URL to get the next set of PrivateStore list results if there are any.", + "type": "string" + } + } + }, + "PrivateStore": { + "description": "The PrivateStore data structure.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateStoreProperties", + "description": "The PrivateStore data structure.", + "x-ms-client-flatten": true + } + } + }, + "PrivateStoreProperties": { + "description": "Describes the json payload on whether or not the private store is enabled for a given tenant", + "type": "object", + "properties": { + "availability": { + "description": "Indicates private store availability", + "type": "string", + "enum": [ + "enabled", + "disabled" + ], + "x-ms-enum": { + "name": "Availability", + "modelAsString": true + } + }, + "privateStoreId": { + "description": "Private Store id", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "Identifier for purposes of race condition", + "type": "string" + }, + "privateStoreName": { + "description": "Private Store Name", + "type": "string" + }, + "tenantId": { + "description": "Tenant id", + "type": "string" + }, + "isGov": { + "description": "Is government", + "type": "boolean" + }, + "collectionIds": { + "description": "Gets list of associated collection ids", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "branding": { + "description": "Gets or sets list of branding characteristics", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "CollectionsList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Collection" + } + }, + "nextLink": { + "description": "URL to get the next set of offer list results if there are any.", + "type": "string" + } + } + }, + "Collection": { + "description": "The Collection data structure.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/CollectionProperties", + "description": "The collection data structure.", + "x-ms-client-flatten": true + } + } + }, + "CollectionProperties": { + "description": "The collection details", + "type": "object", + "properties": { + "collectionId": { + "description": "Gets collection Id.", + "type": "string", + "readOnly": true + }, + "collectionName": { + "description": "Gets or sets collection name.", + "type": "string" + }, + "claim": { + "description": "Gets or sets the association with Commercial's Billing Account.", + "type": "string" + }, + "allSubscriptions": { + "description": "Indicating whether all subscriptions are selected (=true) or not (=false).", + "type": "boolean" + }, + "subscriptionsList": { + "description": "Gets or sets subscription ids list. Empty list indicates all subscriptions are selected, null indicates no update is done, explicit list indicates the explicit selected subscriptions. On insert, null is considered as bad request", + "type": "array", + "items": { + "type": "string" + } + }, + "enabled": { + "description": "Indicating whether the collection is enabled or disabled.", + "type": "boolean" + }, + "numberOfOffers": { + "description": "Gets the number of offers associated with the collection.", + "type": "integer", + "format": "int64", + "readOnly": true + } + } + }, + "OfferListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Offer" + } + }, + "nextLink": { + "description": "URL to get the next set of offer list results if there are any.", + "type": "string" + } + } + }, + "QueryOffers": { + "description": "List of offers", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/OfferProperties" + } + }, + "nextLink": { + "description": "URL to get the next set of PrivateStore list results if there are any.", + "type": "string" + } + } + }, + "Offer": { + "description": "The privateStore offer data structure.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/OfferProperties", + "description": "The privateStore offer data structure.", + "x-ms-client-flatten": true + } + } + }, + "OfferProperties": { + "type": "object", + "properties": { + "uniqueOfferId": { + "description": "Offers unique id", + "type": "string", + "readOnly": true + }, + "offerDisplayName": { + "description": "It will be displayed prominently in the marketplace", + "type": "string", + "readOnly": true + }, + "publisherDisplayName": { + "description": "Publisher name that will be displayed prominently in the marketplace", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "Identifier for purposes of race condition", + "type": "string" + }, + "privateStoreId": { + "readOnly": true, + "description": "Private store unique id", + "type": "string" + }, + "createdAt": { + "readOnly": true, + "description": "Private store offer creation date", + "type": "string" + }, + "modifiedAt": { + "readOnly": true, + "description": "Private store offer modification date", + "type": "string" + }, + "specificPlanIdsLimitation": { + "description": "Plan ids limitation for this offer", + "type": "array", + "items": { + "type": "string" + } + }, + "updateSuppressedDueIdempotence": { + "description": "Indicating whether the offer was not updated to db (true = not updated). If the allow list is identical to the existed one in db, the offer would not be updated.", + "type": "boolean" + }, + "iconFileUris": { + "description": "Icon File Uris", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "plans": { + "description": "Offer plans", + "type": "array", + "items": { + "$ref": "#/definitions/Plan" + } + } + } + }, + "Plan": { + "type": "object", + "properties": { + "skuId": { + "description": "Identifier for this plan", + "type": "string", + "readOnly": true + }, + "planId": { + "description": "Text identifier for this plan", + "type": "string", + "readOnly": true + }, + "planDisplayName": { + "description": "Friendly name for the plan for display in the marketplace", + "type": "string", + "readOnly": true + }, + "accessibility": { + "description": "Plan accessibility", + "type": "string", + "enum": [ + "Unknown", + "Public", + "PrivateTenantOnLevel", + "PrivateSubscriptionOnLevel" + ], + "x-ms-enum": { + "name": "accessibility", + "modelAsString": true + } + }, + "altStackReference": { + "description": "Alternative stack type", + "type": "string", + "readOnly": true + }, + "stackType": { + "description": "Stack type (classic or arm)", + "type": "string", + "readOnly": true + } + } + }, + "AdminRequestApprovalsList": { + "description": "List of admin request approval resources", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AdminRequestApprovalsResource" + } + }, + "nextLink": { + "description": "URL to get the next set of notifications list results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "AdminRequestApprovalsResource": { + "description": "Admin request approval resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AdminRequestApprovalProperties", + "description": "The privateStore admin Approval request data structure.", + "x-ms-client-flatten": true + } + } + }, + "AdminRequestApprovalProperties": { + "description": "Admin approval request resource properties", + "type": "object", + "properties": { + "offerId": { + "description": "Gets or sets offer Id", + "type": "string" + }, + "displayName": { + "description": "Gets display name", + "type": "string", + "readOnly": true + }, + "publisherId": { + "description": "Gets or sets publisher Id", + "type": "string" + }, + "adminAction": { + "description": "Gets or sets admin action", + "type": "string", + "enum": [ + "Approved", + "Rejected" + ], + "x-ms-enum": { + "name": "adminAction", + "modelAsString": true + } + }, + "approvedPlans": { + "description": "Gets or sets Approved plans ids, empty in case of rejected", + "type": "array", + "items": { + "type": "string" + } + }, + "comment": { + "description": "Gets or sets admin comment", + "type": "string" + }, + "administrator": { + "description": "Gets or sets admin details", + "type": "string" + }, + "plans": { + "description": "Gets list of plans with requesters details", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/PlanRequesterDetails" + } + }, + "collectionIds": { + "description": "Gets or sets list of associated collection ids", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PlanRequesterDetails": { + "description": "Plan with requesters details", + "properties": { + "planId": { + "description": "Gets the plan id", + "type": "string", + "readOnly": true + }, + "planDisplayName": { + "description": "Gets the plan display name", + "type": "string", + "readOnly": true + }, + "requesters": { + "description": "Gets requesters details list", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/UserRequestDetails" + } + } + } + }, + "UserRequestDetails": { + "description": "user request details", + "type": "object", + "properties": { + "user": { + "description": "Gets user id", + "type": "string", + "readOnly": true + }, + "date": { + "description": "Gets request date", + "type": "string", + "readOnly": true + }, + "justification": { + "description": "Gets justification", + "type": "string", + "readOnly": true + }, + "subscriptionId": { + "description": "Gets the subscription id that the user is requesting to add the plan to", + "type": "string" + }, + "subscriptionName": { + "description": "Gets the subscription name that the user is requesting to add the plan to", + "type": "string" + } + } + }, + "RequestApprovalsList": { + "description": "List of admin request approval resources", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RequestApprovalResource" + } + }, + "nextLink": { + "description": "URL to get the next set of notifications list results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "RequestApprovalResource": { + "description": "Request approval resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RequestApprovalProperties", + "description": "The privateStore approval request data structure.", + "x-ms-client-flatten": true + } + } + }, + "RequestApprovalProperties": { + "description": "Approval request resource properties", + "type": "object", + "properties": { + "offerId": { + "description": "Gets or sets unique offer id.", + "type": "string" + }, + "offerDisplayName": { + "description": "Gets offer display name", + "type": "string", + "readOnly": true + }, + "publisherId": { + "description": "The offer's publisher id", + "type": "string" + }, + "plansDetails": { + "description": "Gets or sets the plans details", + "type": "array", + "items": { + "$ref": "#/definitions/planDetails" + } + }, + "isClosed": { + "description": "Gets a value indicating whether the request is closed", + "type": "boolean", + "readOnly": true + }, + "messageCode": { + "description": "Gets or sets the request approval message code", + "type": "integer", + "format": "int64" + } + } + }, + "planDetails": { + "description": "Return plan with request details", + "type": "object", + "properties": { + "planId": { + "description": "Gets or sets Plan Id ", + "type": "string" + }, + "status": { + "description": "Gets the plan status", + "type": "string", + "readOnly": true, + "enum": [ + "Pending", + "Rejected", + "Approved", + "None" + ], + "x-ms-enum": { + "name": "status", + "modelAsString": true + } + }, + "requestDate": { + "description": "Gets request date", + "format": "date-time", + "readOnly": true + }, + "justification": { + "description": "Gets or sets user's justification for the plan's request", + "type": "string" + }, + "subscriptionId": { + "description": "Gets or sets the subscription id that the user is requesting to add the plan to", + "type": "string" + }, + "subscriptionName": { + "description": "Gets or sets the subscription name that the user is requesting to add the plan to", + "type": "string" + } + } + }, + "QueryRequestApproval": { + "description": "Gets the request plans with indication on each plan whether is approved by the admin, has pending request or not requested yet", + "type": "object", + "properties": { + "uniqueOfferId": { + "description": "Gets or sets unique offer id.", + "type": "string" + }, + "plansDetails": { + "description": "Gets or sets the plans details", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/planDetails" + } + }, + "etag": { + "description": "Gets or sets e-tag field ", + "type": "string" + }, + "messageCode": { + "description": "Gets or sets the notification message id", + "type": "integer", + "format": "int64" + } + } + }, + "QueryRequestApprovalProperties": { + "description": "The details to get the request plans statuses", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RequestDetails", + "description": "The details to get the request plans statuses" + } + } + }, + "RequestDetails": { + "description": "Request details needed to get the plans statuses", + "type": "object", + "properties": { + "publisherId": { + "description": "The offer's publisher id", + "type": "string" + }, + "planIds": { + "description": "Current plans list", + "type": "array", + "items": { + "type": "string" + } + }, + "subscriptionId": { + "description": "Gets or sets the subscription id", + "type": "string" + } + } + }, + "PrivateStoreNotificationsState": { + "description": "Get private store notifications state", + "type": "object", + "properties": { + "stopSellNotifications": { + "type": "array", + "items": { + "$ref": "#/definitions/StopSellNotifications" + } + }, + "newNotifications": { + "type": "array", + "items": { + "$ref": "#/definitions/NewNotifications" + } + }, + "approvalRequests": { + "type": "array", + "items": { + "$ref": "#/definitions/RequestApprovalsDetails" + } + } + } + }, + "NewNotifications": { + "description": "New plans notification details", + "type": "object", + "properties": { + "offerId": { + "description": "Gets offer id", + "type": "string" + }, + "displayName": { + "description": "Gets offer display name", + "type": "string" + }, + "isFuturePlansEnabled": { + "description": "Gets a value indicating whether future plans is enabled.", + "type": "boolean" + }, + "messageCode": { + "description": "Gets or sets the notification message id", + "type": "integer", + "format": "int64" + }, + "icon": { + "description": "Gets or sets the icon url", + "type": "string" + }, + "plans": { + "description": "Gets or sets removed plans notifications", + "type": "array", + "items": { + "$ref": "#/definitions/PlanNotificationDetails" + } + } + } + }, + "StopSellNotifications": { + "description": "Stop sell notification details", + "type": "object", + "properties": { + "offerId": { + "description": "Gets offer id", + "type": "string" + }, + "displayName": { + "description": "Gets offer display name", + "type": "string" + }, + "isEntire": { + "description": "Gets a value indicating whether entire offer is in stop sell or only few of its plans", + "type": "boolean" + }, + "messageCode": { + "description": "Gets or sets the notification message id", + "type": "integer", + "format": "int64" + }, + "icon": { + "description": "Gets or sets the icon url", + "type": "string" + }, + "plans": { + "description": "Gets or sets removed plans notifications", + "type": "array", + "items": { + "$ref": "#/definitions/PlanNotificationDetails" + } + } + } + }, + "PlanNotificationDetails": { + "description": "Plan notification details", + "type": "object", + "properties": { + "planId": { + "description": "Gets or sets the plan id", + "type": "string" + }, + "planDisplayName": { + "description": "Gets or sets the plan display name", + "type": "string" + } + } + }, + "RequestApprovalsDetails": { + "description": "Request approvals details", + "type": "object", + "properties": { + "offerId": { + "description": "Gets offer id", + "type": "string" + }, + "displayName": { + "description": "Gets offer display name", + "type": "string" + }, + "publisherId": { + "description": "Gets or sets publisher id", + "type": "string" + }, + "messageCode": { + "description": "Gets or sets the notification message id", + "type": "integer", + "format": "int64" + }, + "icon": { + "description": "Gets or sets the icon url", + "type": "string" + }, + "plans": { + "description": "Gets or sets removed plans notifications", + "type": "array", + "items": { + "$ref": "#/definitions/PlanNotificationDetails" + } + } + } + }, + "AcknowledgeOfferNotificationProperties": { + "description": "Notification update request payload", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AcknowledgeOfferNotificationDetails", + "description": "Notification update request payload details", + "x-ms-client-flatten": true + } + } + }, + "AcknowledgeOfferNotificationDetails": { + "description": "Notification update request payload details", + "type": "object", + "properties": { + "acknowledge": { + "description": "Gets or sets a value indicating whether acknowledge action flag is enabled", + "type": "boolean" + }, + "dismiss": { + "description": "Gets or sets a value indicating whether dismiss action flag is enabled", + "type": "boolean" + }, + "removeOffer": { + "description": "Gets or sets a value indicating whether remove offer action flag is enabled", + "type": "boolean" + }, + "addPlans": { + "description": "Gets or sets added plans", + "type": "array", + "items": { + "type": "string" + } + }, + "removePlans": { + "description": "Gets or sets remove plans", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "WithdrawProperties": { + "description": "Withdraw properties", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/WithdrawDetails", + "description": "Withdraw properties details", + "x-ms-client-flatten": true + } + } + }, + "WithdrawDetails": { + "description": "Withdraw properties details", + "type": "object", + "properties": { + "planId": { + "description": "Gets or sets Plan Id ", + "type": "string" + }, + "publisherId": { + "description": "The offer's publisher id", + "type": "string" + } + } + }, + "BillingAccountsResponse": { + "description": "Billing accounts response object", + "type": "object", + "properties": { + "billingAccounts": { + "description": "Billing accounts list", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "TransferOffersProperties": { + "description": "Transfer offers properties", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/TransferOffersDetails", + "description": "transfer offers properties details", + "x-ms-client-flatten": true + } + } + }, + "TransferOffersResponse": { + "description": "The transfer items response. The response contains two lists that indicate for each collection whether the operation succeeded or failed", + "type": "object", + "properties": { + "succeeded": { + "description": "Succeeded collections", + "type": "array", + "items": { + "$ref": "#/definitions/CollectionsDetails" + } + }, + "failed": { + "description": "Failed collections", + "type": "array", + "items": { + "$ref": "#/definitions/CollectionsDetails" + } + } + } + }, + "BulkCollectionsPayload": { + "description": "Bulk collections action properties", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/BulkCollectionsDetails", + "description": "bulk collections properties details", + "x-ms-client-flatten": true + } + } + }, + "BulkCollectionsDetails": { + "description": "Bulk collection details", + "type": "object", + "properties": { + "collectionIds": { + "description": "collection ids list that the action is performed on", + "type": "array", + "items": { + "type": "string" + } + }, + "action": { + "description": "Action to perform (For example: EnableCollections, DisableCollections)", + "type": "string" + } + } + }, + "BulkCollectionsResponse": { + "description": "The bulk collections response. The response contains two lists that indicate for each collection whether the operation succeeded or failed", + "type": "object", + "properties": { + "succeeded": { + "description": "Succeeded collections", + "type": "array", + "items": { + "$ref": "#/definitions/CollectionsDetails" + } + }, + "failed": { + "description": "Failed collections", + "type": "array", + "items": { + "$ref": "#/definitions/CollectionsDetails" + } + } + } + }, + "QueryApprovedPlansPayload": { + "description": "Query approved plans payload", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/QueryApprovedPlans", + "description": "Query approved plans details", + "x-ms-client-flatten": true + } + } + }, + "QueryApprovedPlans": { + "description": "Query approved plans details", + "type": "object", + "properties": { + "offerId": { + "description": "Offer id", + "type": "string" + }, + "planIds": { + "description": "Offer plan ids", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "QueryApprovedPlansResponse": { + "description": "Query approved plans response", + "type": "object", + "properties": { + "details": { + "$ref": "#/definitions/QueryApprovedPlansResponseDetails" + } + } + }, + "QueryApprovedPlansResponseDetails": { + "description": "A list indicating for each plan which subscriptions are approved. Plan Id is unique", + "type": "array", + "items": { + "$ref": "#/definitions/QueryApprovedPlansDetails" + } + }, + "QueryApprovedPlansDetails": { + "description": "Query approved plans response", + "type": "object", + "properties": { + "planId": { + "description": "Plan id", + "type": "string" + }, + "subscriptionIds": { + "description": "Approved subscription ids list. In case all subscriptions are approved for a plan, allSubscriptions flag is true and list is empty ( else flag is set to false). In case both subscriptions list is empty and allSubscriptions flag is false, the plan is not approved for any subscription.", + "type": "array", + "items": { + "type": "string" + } + }, + "allSubscriptions": { + "description": "Indicates whether all subscriptions are approved for this plan", + "type": "boolean" + } + } + }, + "CollectionsDetails": { + "description": "Collection name and id.", + "type": "object", + "properties": { + "collectionName": { + "description": "Collection name.", + "type": "string" + }, + "collectionId": { + "description": "Collection id.", + "type": "string" + } + } + }, + "TransferOffersDetails": { + "description": "Transfer offers response details", + "type": "object", + "properties": { + "targetCollections": { + "description": "Target collections ids", + "type": "array", + "items": { + "type": "string" + } + }, + "operation": { + "description": "Operation to perform (For example: Copy or Move)", + "type": "string" + }, + "offerIdsList": { + "description": "Offers ids list to transfer from source collection to target collection(s)", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "CollectionsToSubscriptionsMappingPayload": { + "description": "The subscriptions list to get the related collections", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CollectionsToSubscriptionsMappingProperties", + "description": "Subscriptions ids list" + } + } + }, + "CollectionsToSubscriptionsMappingProperties": { + "description": "The subscriptions list to get the related collections", + "type": "object", + "properties": { + "subscriptionIds": { + "description": "Subscriptions ids list", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "CollectionsToSubscriptionsMappingResponse": { + "description": "A map of collections subscriptions details", + "type": "object", + "properties": { + "details": { + "$ref": "#/definitions/CollectionsToSubscriptionsMappingResponseProperties", + "description": "The map of collections subscriptions" + } + } + }, + "CollectionsToSubscriptionsMappingResponseProperties": { + "description": "Collections - subscriptions mapping details, map key is collectionId. In case subscriptions list is null or empty: no subscription from the list is related to that collection.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/collectionsSubscriptionsMappingDetails" + } + }, + "collectionsSubscriptionsMappingDetails": { + "description": "Collection name and related subscriptions list", + "type": "object", + "properties": { + "collectionName": { + "description": "Collection name", + "type": "string" + }, + "subscriptions": { + "description": "Subscriptions ids list", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PrivateStoreOperation": { + "description": "Set the Operation for the POST method. Ping or Delete", + "type": "string", + "enum": [ + "DeletePrivateStoreOffer", + "DeletePrivateStoreCollection", + "DeletePrivateStoreCollectionOffer", + "Ping" + ], + "x-ms-enum": { + "name": "Operation", + "modelAsString": true + } + }, + "OperationListResult": { + "description": "Result of the request to list Marketplace 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/SingleOperation" + }, + "description": "List of Microsoft.Marketplace operations supported by the Microsoft.Marketplace resource provider." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any.", + "readOnly": true + } + } + }, + "SingleOperation": { + "description": "Microsoft.Marketplace REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {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.", + "properties": { + "provider": { + "readOnly": true, + "description": "Service provider: Microsoft.Marketplace", + "type": "string" + }, + "resource": { + "readOnly": true, + "description": "Resource on which the operation is performed", + "type": "string" + }, + "operation": { + "readOnly": true, + "description": "Operation type", + "type": "string" + }, + "description": { + "readOnly": true, + "type": "string", + "description": "Friendly description for the operation," + } + } + }, + "origin": { + "description": "Origin of the operation", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Properties of the operation" + } + } + }, + "OperationProperties": { + "description": "Operation properties.", + "type": "object", + "properties": {} + }, + "ErrorResponse": { + "description": "Error response indicates Microsoft.Marketplace service is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "error": { + "description": "The details of the error.", + "properties": { + "code": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string", + "readOnly": true + } + } + } + } + }, + "Resource": { + "description": "An Azure resource.", + "properties": { + "id": { + "description": "The resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "systemData": { + "$ref": "#/definitions/SystemData", + "readOnly": true, + "description": "Metadata pertaining to creation and last modification of the resource" + } + }, + "x-ms-azure-resource": true + }, + "SystemData": { + "description": "Read only system data", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "$ref": "#/definitions/IdentityType", + "description": "The type of identity that created the resource" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)" + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "$ref": "#/definitions/IdentityType", + "description": "The type of identity that last modified the resource" + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)" + } + } + }, + "IdentityType": { + "description": "The type of identity that creates/modifies resources", + "type": "string", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": true + } + } + }, + "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" + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/AcknowledgeNotification.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/AcknowledgeNotification.json new file mode 100644 index 000000000000..f137c4adc7ee --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/AcknowledgeNotification.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "offerId": "marketplacetestthirdparty.md-test-third-party-2", + "api-version": "2021-06-01", + "payload": { + "properties": { + "removePlans": [ + "testPlanA" + ], + "addPlans": null, + "acknowledge": false, + "dismiss": false, + "removeOffer": false + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/AdminRequestApprovalsList.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/AdminRequestApprovalsList.json new file mode 100644 index 000000000000..b0c503b942aa --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/AdminRequestApprovalsList.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "systemData": { + "createdBy": "user@somedoamin.com", + "createdByType": "User", + "createdAt": "2021-02-01T10:23:17.6571572+02:00", + "lastModifiedBy": "user@somedoamin.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-02-01T10:23:17.6571572+02:00" + }, + "id": "/providers/Microsoft.Marketplace/privateStores/a0e28e55-90c4-41d8-8e34-bb7ef7775406/adminRequestApprovals/marketplacetestthirdparty.md-test-third-party-2", + "name": "marketplacetestthirdparty.md-test-third-party-2", + "type": "/providers/Microsoft.Marketplace/privateStores/adminRequestApprovals", + "properties": { + "publisherId": "marketplacetestthirdparty", + "offerId": "marketplacetestthirdparty.md-test-third-party-2", + "displayName": "Offer display name", + "plans": [ + { + "planId": "testA", + "planDisplayName": "Plan display name A", + "requesters": [ + { + "user": "testUser3", + "date": "2021-02-01T11:42:12.9526511+02:00", + "justification": "Because I want to....", + "subscriptionId": "404a1952-706a-453a-989b-647cc4ca5f9c", + "subscriptionName": "Test subscription" + } + ] + }, + { + "planId": "*", + "planDisplayName": "* (this means the user requested any plan, here you will get only *)", + "requesters": [ + { + "user": "testUser3", + "date": "2021-02-01T11:42:12.9526511+02:00", + "justification": "try me :)", + "subscriptionId": "4ca4753c-5a1e-4913-b849-2c68880e03c2", + "subscriptionName": "Test subscription 2" + } + ] + } + ], + "adminAction": "Pending", + "collectionIds": [], + "approvedPlans": null, + "comment": null, + "administrator": null + } + } + ] + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/BillingAccounts.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/BillingAccounts.json new file mode 100644 index 000000000000..a47233b0f34b --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/BillingAccounts.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "billingAccounts": [ + "Billing Account 1", + "Billing Account 2" + ] + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/BulkCollectionsAction.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/BulkCollectionsAction.json new file mode 100644 index 000000000000..73ecabd1936a --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/BulkCollectionsAction.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "api-version": "2021-06-01", + "payload": { + "properties": { + "collectionIds": [ + "c752f021-1c37-4af5-b82f-74c51c27b44a", + "f47ef1c7-e908-4f39-ae29-db181634ad8d" + ], + "action": "EnableCollections" + } + } + }, + "responses": { + "200": { + "body": { + "succeeded": [ + { + "collectionId": "c752f021-1c37-4af5-b82f-74c51c27b44a", + "collectionName": "Test collection" + } + ], + "failed": [ + { + "collectionId": "f47ef1c7-e908-4f39-ae29-db181634ad8d", + "collectionName": "Test collection 2" + } + ] + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/CollectionsToSubscriptionsMapping.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/CollectionsToSubscriptionsMapping.json new file mode 100644 index 000000000000..c746ec91b65e --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/CollectionsToSubscriptionsMapping.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "api-version": "2021-06-01", + "payload": { + "properties": { + "subscriptionIds": [ + "b340914e-353d-453a-85fb-8f9b65b51f91", + "f2baa04d-5bfc-461b-b6d8-61b403c9ec48" + ] + } + } + }, + "responses": { + "200": { + "body": { + "details": { + "4eb49758-f591-486f-bd58-dff00fb7a8d8": { + "collectionName": "Test Collection", + "subscriptions": [ + "b340914e-353d-453a-85fb-8f9b65b51f91", + "f2baa04d-5bfc-461b-b6d8-61b403c9ec48" + ] + }, + "74c02e27-2524-436c-831d-d64565f31153": { + "collectionName": "Test Collection 2", + "subscriptions": null + } + } + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/CreateApprovalRequest.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/CreateApprovalRequest.json new file mode 100644 index 000000000000..bba8ec0901b7 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/CreateApprovalRequest.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "requestApprovalId": "marketplacetestthirdparty.md-test-third-party-2", + "api-version": "2021-06-01", + "RequestApprovalResource": { + "parameters": { + "properties": { + "publisherId": "marketplacetestthirdparty", + "plansDetails": [ + { + "planId": "testPlanA", + "justification": "Because I want to....", + "subscriptionId": "4ca4753c-5a1e-4913-b849-2c68880e03c2", + "subscriptionName": "Test subscription 2" + }, + { + "planId": "*", + "justification": "try me :)", + "subscriptionId": "4ca4753c-5a1e-4913-b849-2c68880e03c2", + "subscriptionName": "Test subscription 2" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "systemData": { + "createdBy": "user@somedoamin.com", + "createdByType": "User", + "lastModifiedBy": "user@somedoamin.com", + "lastModifiedByType": "User", + "createdAt": "2021-02-01T10:23:17.6571572+02:00", + "lastModifiedAt": "2021-02-01T10:23:17.6571572+02:00" + }, + "id": "/providers/Microsoft.Marketplace/privateStores/9afd3c45-5230-4d58-9469-2cacc00bba68/requestApprovals/marketplacetestthirdparty.md-test-third-party-2", + "name": "marketplacetestthirdparty.md-test-third-party-2", + "type": "Microsoft.Marketplace/privateStores/requestApprovals", + "properties": { + "offerId": "marketplacetestthirdparty.md-test-third-party-2", + "publisherId": "marketplacetestthirdparty", + "offerDisplayName": "Offer Display name", + "plansDetails": [ + { + "planId": "testPlanA", + "requestDate": "2021-02-01T10:23:17.6571572+02:00", + "justification": "Because I want to....", + "status": "Pending", + "subscriptionId": "4ca4753c-5a1e-4913-b849-2c68880e03c2", + "subscriptionName": "Test subscription 2" + }, + { + "planId": "*", + "requestDate": "2021-02-01T10:23:17.6571572+02:00", + "justification": "try me :)", + "status": "Pending", + "subscriptionId": "4ca4753c-5a1e-4913-b849-2c68880e03c2", + "subscriptionName": "Test subscription 2" + } + ], + "isClosed": false, + "messageCode": 0 + } + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/CreatePrivateStoreCollection.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/CreatePrivateStoreCollection.json new file mode 100644 index 000000000000..96227de205f7 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/CreatePrivateStoreCollection.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "collectionId": "d0f5aa2c-ecc3-4d87-906a-f8c486dcc4f1", + "api-version": "2020-01-01", + "payload": { + "properties": { + "collectionName": "Test Collection", + "claim": "", + "allSubscriptions": false, + "subscriptionsList": [ + "b340914e-353d-453a-85fb-8f9b65b51f91", + "f2baa04d-5bfc-461b-b6d8-61b403c9ec48" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Marketplace/privateStores/a0e28e55-90c4-41d8-8e34-bb7ef7775406/collections/d0f5aa2c-ecc3-4d87-906a-f8c486dcc4f1", + "type": "Microsoft.Marketplace/privateStores/collections", + "name": "d0f5aa2c-ecc3-4d87-906a-f8c486dcc4f1", + "properties": { + "collectionName": "Test Collection", + "claim": "", + "allSubscriptions": false, + "subscriptionsList": [ + "b340914e-353d-453a-85fb-8f9b65b51f91", + "f2baa04d-5bfc-461b-b6d8-61b403c9ec48" + ] + }, + "systemData": { + "createdBy": "user@somedoamin.com", + "createdByType": "User", + "createdAt": "2021-04-01T10:23:17.6571572+02:00", + "lastModifiedBy": "user@somedoamin.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-04-01T10:23:17.6571572+02:00" + } + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/DeletePrivateStore.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/DeletePrivateStore.json new file mode 100644 index 000000000000..ebd18418a757 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/DeletePrivateStore.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "api-version": "2021-06-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/DeletePrivateStoreCollection.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/DeletePrivateStoreCollection.json new file mode 100644 index 000000000000..abbcf1c3f409 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/DeletePrivateStoreCollection.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "collectionId": "d0f5aa2c-ecc3-4d87-906a-f8c486dcc4f1", + "api-version": "2020-06-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/DeletePrivateStoreOffer.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/DeletePrivateStoreOffer.json new file mode 100644 index 000000000000..18d270636eef --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/DeletePrivateStoreOffer.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "offerId": "marketplacetestthirdparty.md-test-third-party-2", + "collectionId": "56a1a02d-8cf8-45df-bf37-d5f7120fcb3d", + "api-version": "2021-06-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetAdminRequestApproval.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetAdminRequestApproval.json new file mode 100644 index 000000000000..c8f500036c7a --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetAdminRequestApproval.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "adminRequestApprovalId": "marketplacetestthirdparty.md-test-third-party-2", + "publisherId": "marketplacetestthirdparty", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "systemData": { + "createdBy": "user@somedoamin.com", + "createdByType": "User", + "createdAt": "2021-02-01T10:23:17.6571572+02:00", + "lastModifiedBy": "user@somedoamin.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-02-01T10:23:17.6571572+02:00" + }, + "id": "/providers/Microsoft.Marketplace/privateStores/a0e28e55-90c4-41d8-8e34-bb7ef7775406/adminRequestApprovals/marketplacetestthirdparty.md-test-third-party-2", + "name": "marketplacetestthirdparty.md-test-third-party-2", + "type": "/providers/Microsoft.Marketplace/privateStores/adminRequestApprovals", + "properties": { + "publisherId": "marketplacetestthirdparty", + "offerId": "marketplacetestthirdparty.md-test-third-party-2", + "displayName": "Offer display name", + "plans": [ + { + "planId": "testA", + "planDisplayName": "Plan display name A", + "requesters": [ + { + "user": "testUser3", + "date": "2021-02-01T11:42:12.9526511+02:00", + "justification": "Because I want to....", + "subscriptionId": "1fs4r5t6-5a1e-4913-b849-2c68880e03c2", + "subscriptionName": "Test subscription 1" + } + ] + }, + { + "planId": "*", + "planDisplayName": "* (this means the user requested any plan, here you will get only *)", + "requesters": [ + { + "user": "testUser3", + "date": "2021-02-01T11:42:12.9526511+02:00", + "justification": "try me :)", + "subscriptionId": "4ca4753c-5a1e-4913-b849-2c68880e03c2", + "subscriptionName": "Test subscription 2" + } + ] + } + ], + "adminAction": "Pending", + "approvedPlans": null, + "comment": null, + "administrator": null, + "collectionIds": [] + } + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetApprovalRequestsList.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetApprovalRequestsList.json new file mode 100644 index 000000000000..bca9c63a358e --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetApprovalRequestsList.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "offerId": "marketplacetestthirdparty.md-test-third-party-2", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "systemData": { + "createdBy": "user@somedoamin.com", + "createdByType": "User", + "lastModifiedBy": "user@somedoamin.com", + "lastModifiedByType": "User", + "createdAt": "2021-02-01T10:23:17.6571572+02:00", + "lastModifiedAt": "2021-02-01T10:23:17.6571572+02:00" + }, + "id": "/providers/Microsoft.Marketplace/privateStores/9afd3c45-5230-4d58-9469-2cacc00bba68/requestApprovals/marketplacetestthirdparty.md-test-third-party-2", + "name": "marketplacetestthirdparty.md-test-third-party-2", + "type": "Microsoft.Marketplace/privateStores/requestApprovals", + "properties": { + "offerId": "marketplacetestthirdparty.md-test-third-party-2", + "publisherId": "marketplacetestthirdparty", + "offerDisplayName": "Offer Display name", + "plansDetails": [ + { + "planId": "testPlanA", + "requestDate": "2021-02-01T10:23:17.6571572+02:00", + "justification": "Because I want to....", + "status": "Pending", + "subscriptionId": "", + "subscriptionName": "" + }, + { + "planId": "*", + "requestDate": "2021-02-01T10:23:17.6571572+02:00", + "justification": "try me :)", + "status": "Pending", + "subscriptionId": "", + "subscriptionName": "" + } + ], + "isClosed": false, + "messageCode": 0 + } + } + ] + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStore.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStore.json new file mode 100644 index 000000000000..7072c63294a8 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStore.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Marketplace/privateStores/a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "type": "Microsoft.Marketplace/privateStores", + "name": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "properties": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "availability": "enabled", + "eTag": "\"9301f4fd-0000-0100-0000-5e248b350345\"", + "tenantId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "isGov": false, + "collectionIds": [ + "ab80ed4-c5de-4593-b3c1-c46d4a3a56c7", + "a09107d4-c585-4594-b3c6-c46d4a3a56c8" + ], + "branding": { + "iconUrl": "https://some-images.someDomail.com/image/stroeIcon.12345678-4321", + "color": "blue" + } + } + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStoreCollection.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStoreCollection.json new file mode 100644 index 000000000000..b22ddf888ee6 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStoreCollection.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "collectionId": "56a1a02d-8cf8-45df-bf37-d5f7120fcb3d", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Marketplace/privateStores/a0e28e55-90c4-41d8-8e34-bb7ef7775406/collections/56a1a02d-8cf8-45df-bf37-d5f7120fcb3d", + "type": "Microsoft.Marketplace/privateStores/collections", + "name": "56a1a02d-8cf8-45df-bf37-d5f7120fcb3d", + "properties": { + "collectionId": "56a1a02d-8cf8-45df-bf37-d5f7120fcb3d", + "collectionName": "Default Collection", + "claim": "", + "allSubscriptions": true, + "subscriptionsList": [] + }, + "systemData": { + "createdBy": "user@somedoamin.com", + "createdByType": "User", + "createdAt": "2021-02-01T10:23:17.6571572+02:00", + "lastModifiedBy": "user@somedoamin.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-02-01T10:23:17.6571572+02:00" + } + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStoreCollectionOffer.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStoreCollectionOffer.json new file mode 100644 index 000000000000..42f75801c08e --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStoreCollectionOffer.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "offerId": "marketplacetestthirdparty.md-test-third-party-2", + "collectionId": "56a1a02d-8cf8-45df-bf37-d5f7120fcb3d", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Marketplace/privateStores/a0e28e55-90c4-41d8-8e34-bb7ef7775406/collections/56a1a02d-8cf8-45df-bf37-d5f7120fcb3d/offers/marketplacetestthirdparty.md-test-third-party-2", + "type": "Microsoft.Marketplace/privateStores/collections/offers", + "name": "marketplacetestthirdparty.md-test-third-party-2", + "properties": { + "uniqueOfferId": "marketplacetestthirdparty.md-test-third-party-2", + "offerDisplayName": "md-test-third-party-2", + "publisherDisplayName": "Marketplace Test Third Party", + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "eTag": "\"9301f4fd-0000-0100-0000-5e248b350000\"", + "specificPlanIdsLimitation": [ + "0001", + "0002", + "0003" + ], + "modifiedAt": "05/29/2015 5:50", + "createdAt": "05/28/2015 5:50" + } + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStoreCollectionsList.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStoreCollectionsList.json new file mode 100644 index 000000000000..eb3a1a5eb662 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStoreCollectionsList.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "id": "providers/Microsoft.Marketplace/privateStores/a0e28e55-90c4-41d8-8e34-bb7ef7775406/collections", + "type": "Microsoft.Marketplace/privateStores/collections", + "name": "56a1a02d-8cf8-45df-bf37-d5f7120fcb3d", + "properties": { + "collectionId": "56a1a02d-8cf8-45df-bf37-d5f7120fcb3d", + "collectionName": "Default Collection", + "claim": "", + "allSubscriptions": true, + "subscriptionsList": [] + }, + "systemData": { + "createdBy": "user@somedoamin.com", + "createdByType": "User", + "createdAt": "2021-02-01T10:23:17.6571572+02:00", + "lastModifiedBy": "user@somedoamin.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-02-01T10:23:17.6571572+02:00" + } + }, + { + "id": "providers/Microsoft.Marketplace/privateStores/a0e28e55-90c4-41d8-8e34-bb7ef7775406/collections", + "type": "Microsoft.Marketplace/privateStores/collections", + "name": "fba3f52c-874a-4010-87cf-c1cfa6ed3490", + "properties": { + "collectionId": "56a1a02d-8cf8-45df-bf37-d5f7120fcb3d", + "collectionName": "Dev collection", + "claim": "", + "allSubscriptions": false, + "subscriptionsList": [ + "7c927b63-59cf-4a0f-9d13-41e11f1ddf76" + ] + }, + "systemData": { + "createdBy": "user@somedoamin.com", + "createdByType": "User", + "createdAt": "2021-02-01T10:23:17.6571572+02:00", + "lastModifiedBy": "user@somedoamin.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-02-01T10:23:17.6571572+02:00" + } + } + ] + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStoreOffers.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStoreOffers.json new file mode 100644 index 000000000000..2f5b918a97f6 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStoreOffers.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "collectionId": "56a1a02d-8cf8-45df-bf37-d5f7120fcb3d", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "id": "/providers/Microsoft.Marketplace/privateStores/a0e28e55-90c4-41d8-8e34-bb7ef7775406/collections/56a1a02d-8cf8-45df-bf37-d5f7120fcb3d/offers/marketplacetestthirdparty.md-test-third-party-2", + "type": "Microsoft.Marketplace/privateStores/collections/offers", + "name": "marketplacetestthirdparty.md-test-third-party-2", + "properties": { + "uniqueOfferId": "marketplacetestthirdparty.md-test-third-party-2", + "offerDisplayName": "md-test-third-party-2", + "publisherDisplayName": "Marketplace Test Third Party", + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "eTag": "\"9301f4fd-0000-0100-0000-5e248b350000\"", + "specificPlanIdsLimitation": [ + "0001", + "0002", + "0003" + ], + "modifiedAt": "05/29/2015 5:50", + "createdAt": "05/28/2015 5:50" + } + }, + { + "id": "/providers/Microsoft.Marketplace/privateStores/a0e28e55-90c4-41d8-8e34-bb7ef7775406/collections/56a1a02d-8cf8-45df-bf37-d5f7120fcb3d/offers/marketplacetestthirdparty.md-test-third-party-3", + "type": "Microsoft.Marketplace/privateStores/collections/offers", + "name": "marketplacetestthirdparty.md-test-third-party-2", + "properties": { + "uniqueOfferId": "marketplacetestthirdparty.md-test-third-party-3", + "offerDisplayName": "md-test-third-party-3", + "publisherDisplayName": "Marketplace Test Third Party", + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "eTag": "\"9301f4fd-0000-0100-0304-5e248b350043\"", + "specificPlanIdsLimitation": [ + "0001", + "0002" + ], + "modifiedAt": "05/29/2015 5:50", + "createdAt": "05/28/2015 5:50" + } + } + ] + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStores.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStores.json new file mode 100644 index 000000000000..b282178aafcc --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStores.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "id": "/providers/Microsoft.Marketplace/privateStores/a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "type": "Microsoft.Marketplace/privateStores", + "name": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "properties": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "availability": "enabled", + "eTag": "\"9301f4fd-0000-0100-0000-5e248b350332\"", + "tenantId": "f686d426-123a-42db-81b7-ab578e110ccd", + "isGov": false, + "collectionIds": [ + "ab80ed4-c5de-4593-b3c1-c46d4a3a56c7", + "a09107d4-c585-4594-b3c6-c46d4a3a56c8" + ], + "branding": { + "iconUrl": "https://some-images.someDomail.com/image/stroeIcon.12345678-4321", + "color": "blue" + } + } + } + ] + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetRequestApproval.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetRequestApproval.json new file mode 100644 index 000000000000..b34c25f9d4eb --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetRequestApproval.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "requestApprovalId": "marketplacetestthirdparty.md-test-third-party-2", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Marketplace/privateStores/a0e28e55-90c4-41d8-8e34-bb7ef7775406/requestApprovals/marketplacetestthirdparty.md-test-third-party-2", + "name": "marketplacetestthirdparty.md-test-third-party-2", + "type": "Microsoft.Marketplace/privateStores/requestApprovals", + "systemData": { + "createdBy": "test@somedomain.com", + "createdByType": "User", + "createdAt": "2020-10-05T17:18:19.1234567Z", + "lastModifiedBy": "testuser@somedomail.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-10-05T17:18:19.1234567Z" + }, + "properties": { + "offerId": "marketplacetestthirdparty.md-test-third-party-2", + "publisherId": "marketplacetestthirdparty", + "offerDisplayName": "Offer display Name", + "plansDetails": [ + { + "planId": "testPlanA", + "justification": "Because I want to....", + "requestDate": "2020-10-05T17:18:19.1234567Z", + "status": "Pending", + "subscriptionId": "", + "subscriptionName": "" + }, + { + "planId": "testPlanB", + "justification": "Because I want to....", + "requestDate": "2020-10-05T17:18:19.1234567Z", + "status": "Pending", + "subscriptionId": "", + "subscriptionName": "" + } + ], + "isClosed": false, + "messageCode": 0 + } + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/NotificationsState.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/NotificationsState.json new file mode 100644 index 000000000000..ae0eefc41f1c --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/NotificationsState.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "stopSellNotifications": [ + { + "offerId": "publisherId.legacyId", + "displayName": "Offer display name", + "isEntire": false, + "plans": [ + { + "planDisplayName": "test123", + "planId": "aaa" + } + ], + "messageCode": 10002, + "icon": "https://some-images.someDomail.com/image/apps.12345678-4321" + }, + { + "offerId": "publisherIdB.legacyIdB", + "displayName": "Offer display name B", + "isEntire": true, + "plans": null, + "messageCode": 10003, + "icon": "https://some-images.someDomail.com/image/apps.12345678-7654" + } + ], + "newNotifications": [ + { + "offerId": "publisherIdC.legacyIdC", + "displayName": "Offer display name C", + "isFuturePlansEnabled": false, + "plans": [ + { + "planDisplayName": "Display Name Test", + "planId": "plan-test" + } + ], + "messageCode": 10000, + "icon": "https://some-images.someDomail.com/image/apps.12345678-76545678" + } + ], + "approvalRequests": [ + { + "publisherId": "publisherId", + "offerId": "publisherId.legacyId", + "displayName": "Offer display name", + "plans": [ + { + "planDisplayName": "Plan Test display name", + "planId": "test-plan" + }, + { + "planDisplayName": "Plan Test display name B", + "planId": "test-planB" + } + ], + "icon": "https://some-images.someDomail.com/image/apps.12345678-09876567894321", + "messageCode": 0 + } + ] + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/PostPrivateStoreCollection.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/PostPrivateStoreCollection.json new file mode 100644 index 000000000000..64651d20ebf4 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/PostPrivateStoreCollection.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "collectionId": "56a1a02d-8cf8-45df-bf37-d5f7120fcb3d", + "api-version": "2021-06-01", + "Operation": "DeletePrivateStoreCollection" + }, + "responses": { + "200": {} + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/PostPrivateStoreCollectionOffer.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/PostPrivateStoreCollectionOffer.json new file mode 100644 index 000000000000..bafcf4549639 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/PostPrivateStoreCollectionOffer.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "collectionId": "56a1a02d-8cf8-45df-bf37-d5f7120fcb3d", + "offerId": "marketplacetestthirdparty.md-test-third-party-2", + "api-version": "2021-06-01", + "Operation": "DeletePrivateStoreCollectionOffer" + }, + "responses": { + "200": {} + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/PrivateStoreOffer_update.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/PrivateStoreOffer_update.json new file mode 100644 index 000000000000..9b8b29d39878 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/PrivateStoreOffer_update.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "collectionId": "56a1a02d-8cf8-45df-bf37-d5f7120fcb3d", + "offerId": "marketplacetestthirdparty.md-test-third-party-2", + "api-version": "2021-06-01", + "payload": { + "properties": { + "specificPlanIdsLimitation": [ + "0001", + "0002" + ], + "eTag": "\"9301f4fd-0000-0100-0000-5e248b350666\"" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Marketplace/privateStores/a0e28e55-90c4-41d8-8e34-bb7ef7775406/collections/56a1a02d-8cf8-45df-bf37-d5f7120fcb3d/offers/marketplacetestthirdparty.md-test-third-party-2", + "type": "Microsoft.Marketplace/privateStores/collections/offers", + "name": "marketplacetestthirdparty.md-test-third-party-2", + "properties": { + "uniqueOfferId": "marketplacetestthirdparty.md-test-third-party-2", + "offerDisplayName": "md-test-third-party-2", + "publisherDisplayName": "Marketplace Test Third Party", + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "eTag": "\"9301f4fd-0000-0100-0000-5e248b350666\"", + "specificPlanIdsLimitation": [ + "0001", + "0002" + ], + "modifiedAt": "05/29/2015 5:50", + "createdAt": "05/28/2015 5:50" + } + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/PrivateStores_update.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/PrivateStores_update.json new file mode 100644 index 000000000000..645637a74268 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/PrivateStores_update.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "api-version": "2021-06-01", + "payload": { + "properties": { + "availability": "disabled", + "eTag": "\"9301f4fd-0000-0100-0000-5e248b350345\"" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/QueryApprovedPlans.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/QueryApprovedPlans.json new file mode 100644 index 000000000000..9991d3554dbd --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/QueryApprovedPlans.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "api-version": "2021-06-01", + "payload": { + "properties": { + "offerId": "marketplacetestthirdparty.md-test-third-party-2", + "planIds": [ + "testPlanA", + "testPlanB", + "testPlanC" + ] + } + } + }, + "responses": { + "200": { + "body": { + "details": [ + { + "planId": "testPlanA", + "subscriptionIds": [ + "85e3e079-c718-4e4c-abbe-f72fceba8305", + "7752d461-4bf1-4185-8b56-8a3f11486ac6" + ], + "allSubscriptions": false + }, + { + "planId": "testPlanB", + "subscriptionIds": [], + "allSubscriptions": true + }, + { + "planId": "testPlanC", + "subscriptionIds": [], + "allSubscriptions": false + } + ] + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/QueryOffers.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/QueryOffers.json new file mode 100644 index 000000000000..3705158dfb11 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/QueryOffers.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "uniqueOfferId": "marketplacetestthirdparty.md-test-third-party-2", + "offerDisplayName": "md-test-third-party-2", + "publisherDisplayName": "Marketplace Test Third Party", + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "eTag": "\"9301f4fd-0000-0100-0000-5e248b350000\"", + "specificPlanIdsLimitation": [ + "0001", + "0002", + "0003" + ], + "modifiedAt": "05/29/2015 5:50", + "createdAt": "05/28/2015 5:50" + }, + { + "uniqueOfferId": "marketplacetestthirdparty.md-test-third-party-3", + "offerDisplayName": "md-test-third-party-3", + "publisherDisplayName": "Marketplace Test Third Party", + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "eTag": "\"9301f4fd-0000-0100-0304-5e248b350043\"", + "specificPlanIdsLimitation": [ + "0001", + "0002" + ], + "modifiedAt": "05/29/2015 5:50", + "createdAt": "05/28/2015 5:50" + } + ] + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/QueryRequestApproval.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/QueryRequestApproval.json new file mode 100644 index 000000000000..5241f6ec23d6 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/QueryRequestApproval.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "requestApprovalId": "marketplacetestthirdparty.md-test-third-party-2", + "api-version": "2021-06-01", + "payload": { + "properties": { + "publisherId": "marketplacetestthirdparty", + "planIds": [ + "testPlanA", + "testPlanB", + "*" + ] + } + } + }, + "responses": { + "200": { + "body": { + "uniqueOfferId": "marketplacetestthirdparty.md-test-third-party-2", + "plansDetails": { + "*": { + "planId": "*", + "status": "None", + "requestDate": null, + "justification": null, + "subscriptionId": "", + "subscriptionName": "" + }, + "byol": { + "planId": "testPlanA", + "status": "None", + "requestDate": null, + "justification": "", + "subscriptionId": "", + "subscriptionName": "" + }, + "hourly": { + "planId": "testPlanB", + "status": "ApprovedByAdmin", + "requestDate": null, + "justification": "", + "subscriptionId": "4ca4753c-5a1e-4913-b849-2c68880e03c2", + "subscriptionName": "Test subscription 2" + } + }, + "etag": null, + "messageCode": 0 + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/TransferOffers.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/TransferOffers.json new file mode 100644 index 000000000000..30d11e8a37bb --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/TransferOffers.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "collectionId": "56a1a02d-8cf8-45df-bf37-d5f7120fcb3d", + "api-version": "2021-06-01", + "payload": { + "properties": { + "targetCollections": [ + "c752f021-1c37-4af5-b82f-74c51c27b44a", + "f47ef1c7-e908-4f39-ae29-db181634ad8d" + ], + "operation": "copy", + "offerIdsList": [ + "marketplacetestthirdparty.md-test-third-party-2", + "marketplacetestthirdparty.md-test-third-party-3" + ] + } + } + }, + "responses": { + "200": { + "body": { + "succeeded": [ + { + "collectionId": "c752f021-1c37-4af5-b82f-74c51c27b44a", + "collectionName": "Test collection" + } + ], + "failed": [ + { + "collectionId": "f47ef1c7-e908-4f39-ae29-db181634ad8d", + "collectionName": "Test collection 2" + } + ] + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/UpdateAdminRequestApproval.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/UpdateAdminRequestApproval.json new file mode 100644 index 000000000000..a0f9c0fbb757 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/UpdateAdminRequestApproval.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "adminRequestApprovalId": "marketplacetestthirdparty.md-test-third-party-2", + "api-version": "2021-06-01", + "payload": { + "properties": { + "publisherId": "marketplacetestthirdparty", + "adminAction": "Approved", + "approvedPlans": [ + "testPlan" + ], + "comment": "I'm ok with that", + "collectionIds": [ + "f8ee227e-85d7-477d-abbf-854d6decaf70", + "39246ad6-c521-4fed-8de7-77dede2e873f" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Marketplace/privateStores/a0e28e55-90c4-41d8-8e34-bb7ef7775406/adminRequestApprovals/marketplacetestthirdparty.md-test-third-party-2", + "name": "marketplacetestthirdparty.md-test-third-party-2", + "type": "/providers/Microsoft.Marketplace/privateStores/adminRequestApprovals", + "systemData": { + "createdBy": "test@somedomain.com", + "createdByType": "User", + "createdAt": "2020-10-05T17:18:19.1234567Z", + "lastModifiedBy": "testuser@somedomail.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-10-05T17:18:19.1234567Z" + }, + "properties": { + "publisherId": "marketplacetestthirdparty", + "offerId": "marketplacetestthirdparty.md-test-third-party-2", + "displayName": "Offer display name", + "plans": null, + "adminAction": "Approved", + "approvedPlans": [ + "testPlan" + ], + "collectionIds": [ + "f8ee227e-85d7-477d-abbf-854d6decaf70", + "39246ad6-c521-4fed-8de7-77dede2e873f" + ], + "comment": "I'm ok with that", + "administrator": "admin@someDomain.com" + } + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/WithdrawPlan.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/WithdrawPlan.json new file mode 100644 index 000000000000..9aabe2f18dc1 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/WithdrawPlan.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "requestApprovalId": "marketplacetestthirdparty.md-test-third-party-2", + "api-version": "2021-06-01", + "payload": { + "properties": { + "publisherId": "marketplacetestthirdparty", + "planId": "*" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/marketplace/resource-manager/readme.md b/specification/marketplace/resource-manager/readme.md index 06a8de6c4d7d..c33d257083e0 100644 --- a/specification/marketplace/resource-manager/readme.md +++ b/specification/marketplace/resource-manager/readme.md @@ -26,12 +26,25 @@ These are the global settings for the Marketplace API. ``` yaml openapi-type: arm -tag: package-2020-01-01 +tag: package-2021-06-01 ``` ### Composite packages The following packages may be composed from multiple api-versions. +### Tag: package-composite-v2 + +These settings apply only when `--tag=package-composite-v2` is specified on the command line. + +This section contains the "composite-v2" set of APIs, which is composed from a selection of api-versions that will remain backwards compatible with "v1" clients. + +APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. + +``` yaml $(tag) == 'package-composite-v2' +input-file: +- Microsoft.Marketplace/stable/2021-06-01/Marketplace.json +``` + ### Tag: package-composite-v1 These settings apply only when `--tag=package-composite-v1` is specified on the command line. @@ -50,22 +63,31 @@ override-info: title: MarketplaceManagementClient ``` -### Tag: package-2019-12-01 +### Tag: package-2020-01-01 -These settings apply only when `--tag=package-2019-12-01` is specified on the command line. +These settings apply only when `--tag=package-2020-01-01` is specified on the command line. -``` yaml $(tag) == 'package-2019-12-01' +``` yaml $(tag) == 'package-2020-01-01' input-file: - - Microsoft.Marketplace/stable/2019-12-01/Marketplace.json + - Microsoft.Marketplace/stable/2020-01-01/Marketplace.json ``` -### Tag: package-2020-01-01 +### Tag: package-2020-12-01 -These settings apply only when `--tag=package-2020-01-01` is specified on the command line. +These settings apply only when `--tag=package-2020-12-01` is specified on the command line. -``` yaml $(tag) == 'package-2020-01-01' +``` yaml $(tag) == 'package-2020-12-01' input-file: - - Microsoft.Marketplace/stable/2020-01-01/Marketplace.json + - Microsoft.Marketplace/stable/2020-12-01/Marketplace.json +``` + +### Tag: package-2021-06-01 + +These settings apply only when `--tag=package-2021-06-01` is specified on the command line. + +``` yaml $(tag) == 'package-2021-06-01' +input-file: + - Microsoft.Marketplace/stable/2021-06-01/Marketplace.json ``` # Code Generation diff --git a/specification/marketplacenotifications/resource-manager/Microsoft.MarketplaceNotifications/stable/2021-03-03/MarketplaceNotifications.json b/specification/marketplacenotifications/resource-manager/Microsoft.MarketplaceNotifications/stable/2021-03-03/MarketplaceNotifications.json new file mode 100644 index 000000000000..46c53b7f0a21 --- /dev/null +++ b/specification/marketplacenotifications/resource-manager/Microsoft.MarketplaceNotifications/stable/2021-03-03/MarketplaceNotifications.json @@ -0,0 +1,369 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Marketplace Blueprint API", + "description": "Microsoft Marketplace Blueprint API", + "version": "2021-03-03" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscription}/providers/Microsoft.MarketplaceNotifications/reviewsNotifications": { + "get": { + "tags": [ + "Notification" + ], + "operationId": "Notifications_GetWithAuthorization", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/PrincipalId" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/NotificationList" + } + }, + "default": { + "description": "Microsoft.MarketplaceNotifications error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetReviewsNotifications": { + "$ref": "./examples/GetReviewsNotifications.json" + } + } + } + }, + "/subscriptions/{subscription}/providers/Microsoft.MarketplaceNotifications/reviewsNotification/{notification}": { + "get": { + "tags": [ + "Notification" + ], + "operationId": "Notification_GetWithAuthorization", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/NotificationId" + }, + { + "$ref": "#/parameters/PrincipalId" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Notification" + } + }, + "default": { + "description": "Microsoft.MarketplaceNotifications error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetReviewsNotifications": { + "$ref": "./examples/GetReviewsNotification.json" + } + } + } + }, + "/providers/Microsoft.MarketplaceNotifications/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Notification_GetOperations", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AvailableOperations" + } + }, + "default": { + "description": "Microsoft.MarketplaceNotifications error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetReviewsNotificationsOperations": { + "$ref": "./examples/GetReviewsNotificationsOperations.json" + } + } + } + } + }, + "parameters": { + "NotificationId": { + "description": "the notification id", + "type": "string", + "name": "notification", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "SubscriptionId": { + "description": "user's subscription id", + "type": "string", + "name": "subscription", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "PrincipalId": { + "description": "user's principal id", + "type": "string", + "name": "principalId", + "in": "query", + "required": true, + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request.", + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "NotificationList": { + "description": "Notifications List", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Notification" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "Notification": { + "description": "Review notification", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/OfferProperties", + "description": "The offer data structure.", + "x-ms-client-flatten": true + } + } + }, + "DiagnosticsInfoDto": { + "description": "Diagnostics Info", + "type": "object", + "properties": { + "ms-cv": { + "description": "MS CV", + "type": "string" + }, + "buildNumber": { + "description": "build number", + "type": "string" + } + } + }, + "ErrorResponse": { + "description": "Error response indicates Microsoft.MarketplaceNotifications service is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "error": { + "description": "The details of the error.", + "properties": { + "code": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string", + "readOnly": true + } + } + } + } + }, + "AvailableOperations": { + "description": "Available operations of the service", + "type": "object", + "properties": { + "value": { + "description": "Collection of available operation details", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/OperationDetail" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string", + "readOnly": true + } + } + }, + "OperationDetail": { + "description": "Operation detail payload", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation", + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "Display of the operation" + }, + "origin": { + "description": "operation origin", + "type": "string" + }, + "properties": { + "description": "operation properties", + "type": "object" + } + } + }, + "OperationDisplay": { + "description": "Operation display payload", + "type": "object", + "properties": { + "resource": { + "description": "Resource of the operation", + "type": "string" + }, + "provider": { + "description": "Name of the provider for display purposes", + "type": "string" + }, + "operation": { + "description": "Name of the operation for display purposes", + "type": "string" + }, + "description": { + "description": "Localized friendly description for the operation", + "type": "string" + } + } + }, + "Resource": { + "description": "An Azure resource.", + "properties": { + "id": { + "description": "The resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "OfferProperties": { + "type": "object", + "properties": { + "offerId": { + "description": "legacy offer id of the notification (publisher.offer)", + "type": "string", + "readOnly": true + }, + "createdDate": { + "description": "date for creating the notification", + "format": "date-time", + "type": "string", + "readOnly": true + }, + "offerDisplayName": { + "description": "offer display name", + "type": "string", + "readOnly": true + }, + "principalId": { + "description": "user's principal id", + "type": "string", + "readOnly": true + } + } + } + }, + "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" + } + } + } +} diff --git a/specification/marketplacenotifications/resource-manager/Microsoft.MarketplaceNotifications/stable/2021-03-03/examples/GetReviewsNotification.json b/specification/marketplacenotifications/resource-manager/Microsoft.MarketplaceNotifications/stable/2021-03-03/examples/GetReviewsNotification.json new file mode 100644 index 000000000000..ee066f1a2f61 --- /dev/null +++ b/specification/marketplacenotifications/resource-manager/Microsoft.MarketplaceNotifications/stable/2021-03-03/examples/GetReviewsNotification.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "notification": "5654d099-303d-4196-9d79-0334246f9edb", + "subscription": "5654d099-303d-4196-9d79-0334246f9edb", + "principalId": "0b12389c-5e1d-4b67-880c-71d0d4a8d751", + "api-version": "03-03-2021" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.MarketplaceNotifications/9b001c71-cb1f-4d0a-bafd-8fa62c978288", + "type": "Microsoft.MarketplaceNotifications/reviewsNotification", + "name": "9b001c71-cb1f-4d0a-bafd-8fa62c978288", + "properties": { + "offerId": "publisher.offer", + "createdDate": "2020-10-04T00:00:00+00:00", + "offerDisplayName": "Offer Name", + "principalId": "0b12389c-5e1d-4b67-880c-71d0d4a8d751" + } + } + } + } +} diff --git a/specification/marketplacenotifications/resource-manager/Microsoft.MarketplaceNotifications/stable/2021-03-03/examples/GetReviewsNotifications.json b/specification/marketplacenotifications/resource-manager/Microsoft.MarketplaceNotifications/stable/2021-03-03/examples/GetReviewsNotifications.json new file mode 100644 index 000000000000..7b24e8f2fead --- /dev/null +++ b/specification/marketplacenotifications/resource-manager/Microsoft.MarketplaceNotifications/stable/2021-03-03/examples/GetReviewsNotifications.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscription": "5654d099-303d-4196-9d79-0334246f9edb", + "principalId": "0b12389c-5e1d-4b67-880c-71d0d4a8d751", + "api-version": "03-03-2021" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "id": "/providers/Microsoft.MarketplaceNotifications/9b001c71-cb1f-4d0a-bafd-8fa62c978288", + "type": "Microsoft.MarketplaceNotifications/reviewsNotification", + "name": "9b001c71-cb1f-4d0a-bafd-8fa62c978288", + "properties": { + "offerId": "publisher.offer", + "createdDate": "2020-10-04T00:00:00+00:00", + "offerDisplayName": "Offer Name", + "principalId": "0b12389c-5e1d-4b67-880c-71d0d4a8d751" + } + } + ] + } + } + } +} diff --git a/specification/marketplacenotifications/resource-manager/Microsoft.MarketplaceNotifications/stable/2021-03-03/examples/GetReviewsNotificationsOperations.json b/specification/marketplacenotifications/resource-manager/Microsoft.MarketplaceNotifications/stable/2021-03-03/examples/GetReviewsNotificationsOperations.json new file mode 100644 index 000000000000..109c0d97d7fa --- /dev/null +++ b/specification/marketplacenotifications/resource-manager/Microsoft.MarketplaceNotifications/stable/2021-03-03/examples/GetReviewsNotificationsOperations.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "03-03-2021" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "operation name", + "isDataAction": true, + "display": { + "description": "operation description", + "resource": "notifications", + "operation": "operation display name", + "provider": "operation provider" + }, + "origin": "user|system|user,system", + "properties": {} + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/marketplacenotifications/resource-manager/readme.azureresourceschema.md b/specification/marketplacenotifications/resource-manager/readme.azureresourceschema.md new file mode 100644 index 000000000000..8b2c8b4db7e5 --- /dev/null +++ b/specification/marketplacenotifications/resource-manager/readme.azureresourceschema.md @@ -0,0 +1,24 @@ +## AzureResourceSchema + +These settings apply only when `--azureresourceschema` is specified on the command line. + +### AzureResourceSchema multi-api + +``` yaml $(azureresourceschema) && $(multiapi) +batch: + - tag: schema-marketplacenotifications-2021-03-03 + +``` + +Please also specify `--azureresourceschema-folder=`. + +### Tag: schema-marketplacenotifications-2021-03-03 and azureresourceschema + +``` yaml $(tag) == 'schema-marketplacenotifications-2021-03-03' && $(azureresourceschema) +output-folder: $(azureresourceschema-folder)/schemas + +# all the input files in this apiVersion +input-file: + - Microsoft.MarketplaceNotifications/stable/2021-03-03/MarketplaceNotifications.json + +``` diff --git a/specification/marketplacenotifications/resource-manager/readme.md b/specification/marketplacenotifications/resource-manager/readme.md new file mode 100644 index 000000000000..3bfaa28a8f61 --- /dev/null +++ b/specification/marketplacenotifications/resource-manager/readme.md @@ -0,0 +1,95 @@ +# marketplace + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Marketplace. + +--- + +## Getting Started + +To build the SDK for Marketplace notifications, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +### Basic Information + +These are the global settings for the Marketplace notifications API. + +``` yaml +openapi-type: arm +tag: package-2021-03-03 +``` +### Composite packages + +The following packages may be composed from multiple api-versions. + +### Tag: package-composite-v1 + +These settings apply only when `--tag=package-composite-v1` is specified on the command line. + +This section contains the "composite-v1" set of APIs, which is composed from a selection of api-versions that will remain backwards compatible with "v1" clients. + +APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. + +``` yaml $(tag) == 'package-composite-v1' +input-file: +- Microsoft.MarketplaceNotifications/stable/2021-03-03/MarketplaceNotifications.json + +# Needed when there is more than one input file +override-info: + title: MarketplaceManagementClient +``` + +### Tag: package-2021-03-03 + +These settings apply only when `--tag=package-2021-03-03` is specified on the command line. + +``` yaml $(tag) == 'package-2021-03-03' +input-file: + - Microsoft.MarketplaceNotifications/stable/2021-03-03/MarketplaceNotifications.json +``` + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-net + - repo: azure-resource-manager-schemas + after_scripts: + - node sdkauto_afterscript.js marketplacenotifications/resource-manager +``` + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.MarketplaceNotifications + output-folder: $(csharp-sdks-folder)/marketplacenotifications/Microsoft.Azure.Management.MarketplaceNotifications/src/Generated + clear-output-folder: true + modelerfour: + lenient-model-deduplication: true +``` + +## AzureResourceSchema + +See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) + diff --git a/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/Agreements.json b/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/Agreements.json index af4d8bb66ac6..2566c843184b 100644 --- a/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/Agreements.json +++ b/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/Agreements.json @@ -70,6 +70,13 @@ "$ref": "#/definitions/AgreementTerms" } }, + "415": { + "description": "Unsupported Media Type", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/UnsupportedMediaTypeErrorResponse" + } + }, "default": { "description": "Microsoft.MarketplaceOrdering error response describing why the operation failed.", "schema": { @@ -122,6 +129,13 @@ "$ref": "#/definitions/AgreementTerms" } }, + "415": { + "description": "Unsupported Media Type", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/UnsupportedMediaTypeErrorResponse" + } + }, "default": { "description": "Microsoft.MarketplaceOrdering error response describing why the operation failed.", "schema": { @@ -150,6 +164,13 @@ "$ref": "#/definitions/OperationListResult" } }, + "415": { + "description": "Unsupported Media Type", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/UnsupportedMediaTypeErrorResponse" + } + }, "default": { "description": "Microsoft.MarketplaceOrdering error response describing why the operation failed.", "schema": { @@ -192,7 +213,14 @@ "200": { "description": "OK. The request was successfully processed and the terms were accepted.", "schema": { - "$ref": "#/definitions/AgreementTerms" + "$ref": "#/definitions/OldAgreementTerms" + } + }, + "415": { + "description": "Unsupported Media Type", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/UnsupportedMediaTypeErrorResponse" } }, "default": { @@ -234,7 +262,14 @@ "200": { "description": "OK. The request was successfully processed and the terms were rejected.", "schema": { - "$ref": "#/definitions/AgreementTerms" + "$ref": "#/definitions/OldAgreementTerms" + } + }, + "415": { + "description": "Unsupported Media Type", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/UnsupportedMediaTypeErrorResponse" } }, "default": { @@ -276,7 +311,14 @@ "200": { "description": "Terms returned successfully", "schema": { - "$ref": "#/definitions/AgreementTerms" + "$ref": "#/definitions/OldAgreementTerms" + } + }, + "415": { + "description": "Unsupported Media Type", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/UnsupportedMediaTypeErrorResponse" } }, "default": { @@ -309,10 +351,14 @@ "200": { "description": "Terms returned successfully", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/AgreementTerms" - } + "$ref": "#/definitions/AgreementTermsList" + } + }, + "415": { + "description": "Unsupported Media Type", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/UnsupportedMediaTypeErrorResponse" } }, "default": { @@ -381,7 +427,21 @@ } }, "definitions": { + "AgreementTermsList": { + "type": "object", + "description": "Represents the list of AgreementTerms objects", + "properties": { + "value": { + "description": "The value of the array.", + "type": "array", + "items": { + "$ref": "#/definitions/OldAgreementTerms" + } + } + } + }, "AgreementTerms": { + "type": "object", "properties": { "properties": { "$ref": "#/definitions/AgreementProperties", @@ -397,6 +457,7 @@ "description": "Terms properties for provided Publisher/Offer/Plan tuple" }, "AgreementProperties": { + "type": "object", "properties": { "publisher": { "type": "string", @@ -434,11 +495,78 @@ }, "description": "Agreement Terms definition" }, + "OldAgreementTerms": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/OldAgreementProperties", + "description": "Represents the properties of the resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Terms properties for provided Publisher/Offer/Plan tuple" + }, + "OldAgreementProperties": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "A unique identifier of the agreement." + }, + "publisher": { + "type": "string", + "description": "Publisher identifier string of image being deployed." + }, + "offer": { + "type": "string", + "description": "Offer identifier string of image being deployed." + }, + "signDate": { + "type": "string", + "format": "date-time", + "description": "Date and time in UTC of when the terms were accepted. This is empty if state is cancelled." + }, + "cancelDate": { + "type": "string", + "format": "date-time", + "description": "Date and time in UTC of when the terms were cancelled. This is empty if state is active." + }, + "state": { + "type": "string", + "enum": [ + "Active", + "Canceled" + ], + "description": "Whether the agreement is active or cancelled", + "x-ms-enum": { + "name": "state", + "modelAsString": true + } + } + }, + "description": "Old Agreement Terms definition" + }, + "UnsupportedMediaTypeErrorResponse": { + "description": "Error response that indicates the media type in the request is unsupported.", + "type": "object", + "properties": { + "Message": { + "type": "string", + "description": "The details of the error." + } + } + }, "ErrorResponse": { "description": "Error response indicates Microsoft.MarketplaceOrdering service is not able to process the incoming request. The reason is provided in the error message.", "type": "object", "properties": { "error": { + "type": "object", "description": "The details of the error.", "properties": { "code": { @@ -465,6 +593,7 @@ }, "display": { "description": "The object that represents the operation.", + "type": "object", "properties": { "provider": { "description": "Service provider: Microsoft.MarketplaceOrdering", @@ -477,6 +606,10 @@ "operation": { "description": "Operation type: Get Agreement, Sign Agreement, Cancel Agreement etc.", "type": "string" + }, + "description": { + "description": "The description of the operation", + "type": "string" } } } @@ -484,9 +617,11 @@ }, "OperationListResult": { "description": "Result of the request to list MarketplaceOrdering operations. It contains a list of operations and a URL link to get the next set of results.", + "type": "object", "properties": { "value": { "type": "array", + "uniqueItems": false, "items": { "$ref": "#/definitions/Operation" }, @@ -501,6 +636,7 @@ }, "Resource": { "description": "ARM resource.", + "type": "object", "properties": { "id": { "readOnly": true, diff --git a/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/CancelMarketplaceTerms.json b/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/CancelMarketplaceTerms.json index c0550167f7d7..e45b6c83751b 100644 --- a/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/CancelMarketplaceTerms.json +++ b/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/CancelMarketplaceTerms.json @@ -13,16 +13,19 @@ "name": "planid", "type": "Microsoft.MarketplaceOrdering/offertypes", "properties": { + "id": "11111111-1111-1111-1111-111111111111", "publisher": "pubid", - "product": "offid", - "plan": "planid", - "licenseTextLink": "test.licenseLink", - "privacyPolicyLink": "test.privacyPolicyLink", - "retrieveDatetime": "2017-08-15T11:33:07.12132Z", - "signature": "ASDFSDAFWEFASDGWERLWER", - "accepted": false + "offer": "offid", + "signDate": "2017-08-15T11:33:07.12132Z", + "cancelDate": "2017-08-16T11:33:07.12132Z", + "state": "Canceled" } } + }, + "415": { + "body": { + "Message": "media type unsupported" + } } } } diff --git a/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/GetAgreementMarketplaceTerms.json b/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/GetAgreementMarketplaceTerms.json index fa5ce79fb0cd..e45b6c83751b 100644 --- a/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/GetAgreementMarketplaceTerms.json +++ b/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/GetAgreementMarketplaceTerms.json @@ -13,16 +13,19 @@ "name": "planid", "type": "Microsoft.MarketplaceOrdering/offertypes", "properties": { + "id": "11111111-1111-1111-1111-111111111111", "publisher": "pubid", - "product": "offid", - "plan": "planid", - "licenseTextLink": "test.licenseLink", - "privacyPolicyLink": "test.privacyPolicyLink", - "retrieveDatetime": "2017-08-15T11:33:07.12132Z", - "signature": "ASDFSDAFWEFASDGWERLWER", - "accepted": true + "offer": "offid", + "signDate": "2017-08-15T11:33:07.12132Z", + "cancelDate": "2017-08-16T11:33:07.12132Z", + "state": "Canceled" } } + }, + "415": { + "body": { + "Message": "media type unsupported" + } } } } diff --git a/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/GetMarketplaceTerms.json b/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/GetMarketplaceTerms.json index 1c8b01a0329a..95b51e760a59 100644 --- a/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/GetMarketplaceTerms.json +++ b/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/GetMarketplaceTerms.json @@ -24,6 +24,11 @@ "accepted": true } } + }, + "415": { + "body": { + "Message": "media type unsupported" + } } } } diff --git a/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/ListMarketplaceTerms.json b/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/ListMarketplaceTerms.json index 29624d82e540..2e5c80bf94bc 100644 --- a/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/ListMarketplaceTerms.json +++ b/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/ListMarketplaceTerms.json @@ -5,23 +5,27 @@ }, "responses": { "200": { - "body": [ - { - "id": "id", - "name": "planid", - "type": "Microsoft.MarketplaceOrdering/offertypes", - "properties": { - "publisher": "pubid", - "product": "offid", - "plan": "planid", - "licenseTextLink": "test.licenseLink", - "privacyPolicyLink": "test.privacyPolicyLink", - "retrieveDatetime": "2017-08-15T11:33:07.12132Z", - "signature": "ASDFSDAFWEFASDGWERLWER", - "accepted": true + "body": { + "value": [ + { + "id": "id", + "name": "planid", + "type": "Microsoft.MarketplaceOrdering/offertypes", + "properties": { + "publisher": "pubid", + "offer": "offid", + "signDate": "2019-04-26T05:57:25.3013164Z", + "cancelDate": "2019-04-27T05:57:25.3013164Z", + "state": "Active" + } } - } - ] + ] + } + }, + "415": { + "body": { + "Message": "media type unsupported" + } } } } diff --git a/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/SetMarketplaceTerms.json b/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/SetMarketplaceTerms.json index cc1cbbdbb02e..2a12ce8d3143 100644 --- a/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/SetMarketplaceTerms.json +++ b/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/SetMarketplaceTerms.json @@ -37,6 +37,11 @@ "accepted": true } } + }, + "415": { + "body": { + "Message": "media type unsupported" + } } } } diff --git a/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/SignMarketplaceTerms.json b/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/SignMarketplaceTerms.json index fa5ce79fb0cd..e45b6c83751b 100644 --- a/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/SignMarketplaceTerms.json +++ b/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/examples/SignMarketplaceTerms.json @@ -13,16 +13,19 @@ "name": "planid", "type": "Microsoft.MarketplaceOrdering/offertypes", "properties": { + "id": "11111111-1111-1111-1111-111111111111", "publisher": "pubid", - "product": "offid", - "plan": "planid", - "licenseTextLink": "test.licenseLink", - "privacyPolicyLink": "test.privacyPolicyLink", - "retrieveDatetime": "2017-08-15T11:33:07.12132Z", - "signature": "ASDFSDAFWEFASDGWERLWER", - "accepted": true + "offer": "offid", + "signDate": "2017-08-15T11:33:07.12132Z", + "cancelDate": "2017-08-16T11:33:07.12132Z", + "state": "Canceled" } } + }, + "415": { + "body": { + "Message": "media type unsupported" + } } } } diff --git a/specification/marketplaceordering/resource-manager/readme.md b/specification/marketplaceordering/resource-manager/readme.md index 97a75484d98f..1ec1afdcc45e 100644 --- a/specification/marketplaceordering/resource-manager/readme.md +++ b/specification/marketplaceordering/resource-manager/readme.md @@ -67,6 +67,11 @@ These settings apply only when `--tag=package-2015-06-01` is specified on the co ``` yaml $(tag) == 'package-2015-06-01' input-file: - Microsoft.MarketplaceOrdering/stable/2015-06-01/Agreements.json +directive: + # suppress each RPC 3016 error +- where: $.definitions.UnsupportedMediaTypeErrorResponse.properties.Message + suppress: R3016 + reason: This requires a change in code thats in production for several years ``` diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/AccountFilters.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/AccountFilters.json new file mode 100644 index 000000000000..733ba040b867 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/AccountFilters.json @@ -0,0 +1,516 @@ +{ + "schemes": [ + "https" + ], + "swagger": "2.0", + "info": { + "title": "Azure Media Services", + "description": "This Swagger was generated by the API Framework.", + "version": "2021-06-01" + }, + "host": "management.azure.com", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "definitions": { + "PresentationTimeRange": { + "properties": { + "startTimestamp": { + "type": "integer", + "format": "int64", + "description": "The absolute start time boundary." + }, + "endTimestamp": { + "type": "integer", + "format": "int64", + "description": "The absolute end time boundary." + }, + "presentationWindowDuration": { + "type": "integer", + "format": "int64", + "description": "The relative to end sliding window." + }, + "liveBackoffDuration": { + "type": "integer", + "format": "int64", + "description": "The relative to end right edge." + }, + "timescale": { + "type": "integer", + "format": "int64", + "description": "The time scale of time stamps." + }, + "forceEndTimestamp": { + "type": "boolean", + "description": "The indicator of forcing existing of end time stamp." + } + }, + "type": "object", + "description": "The presentation time range, this is asset related and not recommended for Account Filter." + }, + "FilterTrackPropertyCondition": { + "properties": { + "property": { + "type": "string", + "enum": [ + "Unknown", + "Type", + "Name", + "Language", + "FourCC", + "Bitrate" + ], + "x-ms-enum": { + "name": "FilterTrackPropertyType", + "values": [ + { + "value": "Unknown", + "description": "The unknown track property type." + }, + { + "value": "Type", + "description": "The type." + }, + { + "value": "Name", + "description": "The name." + }, + { + "value": "Language", + "description": "The language." + }, + { + "value": "FourCC", + "description": "The fourCC." + }, + { + "value": "Bitrate", + "description": "The bitrate." + } + ], + "modelAsString": true + }, + "description": "The track property type." + }, + "value": { + "type": "string", + "description": "The track property value." + }, + "operation": { + "type": "string", + "enum": [ + "Equal", + "NotEqual" + ], + "x-ms-enum": { + "name": "FilterTrackPropertyCompareOperation", + "values": [ + { + "value": "Equal", + "description": "The equal operation." + }, + { + "value": "NotEqual", + "description": "The not equal operation." + } + ], + "modelAsString": true + }, + "description": "The track property condition operation." + } + }, + "type": "object", + "required": [ + "property", + "value", + "operation" + ], + "description": "The class to specify one track property condition." + }, + "FirstQuality": { + "properties": { + "bitrate": { + "type": "integer", + "format": "int32", + "description": "The first quality bitrate." + } + }, + "type": "object", + "required": [ + "bitrate" + ], + "description": "Filter First Quality" + }, + "FilterTrackSelection": { + "properties": { + "trackSelections": { + "type": "array", + "items": { + "$ref": "#/definitions/FilterTrackPropertyCondition" + }, + "description": "The track selections." + } + }, + "type": "object", + "required": [ + "trackSelections" + ], + "description": "Representing a list of FilterTrackPropertyConditions to select a track. The filters are combined using a logical AND operation." + }, + "MediaFilterProperties": { + "properties": { + "presentationTimeRange": { + "$ref": "#/definitions/PresentationTimeRange", + "description": "The presentation time range." + }, + "firstQuality": { + "$ref": "#/definitions/FirstQuality", + "description": "The first quality." + }, + "tracks": { + "type": "array", + "items": { + "$ref": "#/definitions/FilterTrackSelection" + }, + "description": "The tracks selection conditions." + } + }, + "type": "object", + "description": "The Media Filter properties." + }, + "AccountFilter": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MediaFilterProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "The system metadata relating to this resource.", + "readOnly": true + } + }, + "type": "object", + "description": "An Account Filter." + }, + "AccountFilterCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AccountFilter" + }, + "description": "A collection of AccountFilter items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of AccountFilter items." + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/accountFilters": { + "get": { + "summary": "List Account Filters", + "description": "List Account Filters in the Media Services account.", + "operationId": "AccountFilters_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AccountFilterCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-examples": { + "List all Account Filters": { + "$ref": "examples/accountFilters-list-all.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/accountFilters/{filterName}": { + "get": { + "summary": "Get an Account Filter.", + "description": "Get the details of an Account Filter in the Media Services account.", + "operationId": "AccountFilters_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AccountFilter" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "filterName", + "in": "path", + "required": true, + "type": "string", + "description": "The Account Filter name" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get an Account Filter by name": { + "$ref": "examples/accountFilters-get-by-name.json" + } + } + }, + "put": { + "summary": "Create or update an Account Filter", + "description": "Creates or updates an Account Filter in the Media Services account.", + "operationId": "AccountFilters_CreateOrUpdate", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AccountFilter" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/AccountFilter" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "filterName", + "in": "path", + "required": true, + "type": "string", + "description": "The Account Filter name" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AccountFilter" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Create an Account Filter": { + "$ref": "examples/accountFilters-create.json" + } + } + }, + "delete": { + "summary": "Delete an Account Filter.", + "description": "Deletes an Account Filter in the Media Services account.", + "operationId": "AccountFilters_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "filterName", + "in": "path", + "required": true, + "type": "string", + "description": "The Account Filter name" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete an Account Filter": { + "$ref": "examples/accountFilters-delete.json" + } + } + }, + "patch": { + "summary": "Update an Account Filter", + "description": "Updates an existing Account Filter in the Media Services account.", + "operationId": "AccountFilters_Update", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AccountFilter" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "filterName", + "in": "path", + "required": true, + "type": "string", + "description": "The Account Filter name" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AccountFilter" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Update an Account Filter": { + "$ref": "examples/accountFilters-update.json" + } + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The unique identifier for a Microsoft Azure subscription." + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the Azure subscription.", + "x-ms-parameter-location": "method" + }, + "MediaServicesAccountName": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name.", + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The version of the API to be used with the client request." + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/Accounts.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/Accounts.json new file mode 100644 index 000000000000..a97ceddf5a99 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/Accounts.json @@ -0,0 +1,1569 @@ +{ + "schemes": [ + "https" + ], + "swagger": "2.0", + "info": { + "title": "Azure Media Services", + "description": "This Swagger was generated by the API Framework.", + "version": "2021-06-01" + }, + "host": "management.azure.com", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "definitions": { + "OperationDisplay": { + "properties": { + "provider": { + "type": "string", + "description": "The service provider." + }, + "resource": { + "type": "string", + "description": "Resource on which the operation is performed." + }, + "operation": { + "type": "string", + "description": "The operation type." + }, + "description": { + "type": "string", + "description": "The operation description." + } + }, + "type": "object", + "description": "Operation details." + }, + "MetricDimension": { + "properties": { + "name": { + "type": "string", + "description": "The metric dimension name.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The display name for the dimension.", + "readOnly": true + }, + "toBeExportedForShoebox": { + "type": "boolean", + "description": "Whether to export metric to shoebox.", + "readOnly": true, + "x-nullable": false + } + }, + "type": "object", + "description": "A metric dimension." + }, + "MetricSpecification": { + "properties": { + "name": { + "type": "string", + "description": "The metric name.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The metric display name.", + "readOnly": true + }, + "displayDescription": { + "type": "string", + "description": "The metric display description.", + "readOnly": true + }, + "unit": { + "type": "string", + "enum": [ + "Bytes", + "Count", + "Milliseconds" + ], + "x-ms-enum": { + "name": "MetricUnit", + "values": [ + { + "value": "Bytes", + "description": "The number of bytes." + }, + { + "value": "Count", + "description": "The count." + }, + { + "value": "Milliseconds", + "description": "The number of milliseconds." + } + ], + "modelAsString": true + }, + "description": "The metric unit", + "readOnly": true, + "x-nullable": false + }, + "aggregationType": { + "type": "string", + "enum": [ + "Average", + "Count", + "Total" + ], + "x-ms-enum": { + "name": "MetricAggregationType", + "values": [ + { + "value": "Average", + "description": "The average." + }, + { + "value": "Count", + "description": "The count of a number of items, usually requests." + }, + { + "value": "Total", + "description": "The sum." + } + ], + "modelAsString": true + }, + "description": "The metric aggregation type", + "readOnly": true, + "x-nullable": false + }, + "lockAggregationType": { + "type": "string", + "enum": [ + "Average", + "Count", + "Total" + ], + "x-ms-enum": { + "name": "MetricAggregationType", + "values": [ + { + "value": "Average", + "description": "The average." + }, + { + "value": "Count", + "description": "The count of a number of items, usually requests." + }, + { + "value": "Total", + "description": "The sum." + } + ], + "modelAsString": true + }, + "description": "The metric lock aggregation type", + "readOnly": true, + "x-nullable": true + }, + "supportedAggregationTypes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Supported aggregation types." + }, + "dimensions": { + "type": "array", + "items": { + "$ref": "#/definitions/MetricDimension" + }, + "description": "The metric dimensions.", + "readOnly": true + }, + "enableRegionalMdmAccount": { + "type": "boolean", + "description": "Indicates whether regional MDM account is enabled.", + "readOnly": true, + "x-nullable": false + }, + "sourceMdmAccount": { + "type": "string", + "description": "The source MDM account.", + "readOnly": true + }, + "sourceMdmNamespace": { + "type": "string", + "description": "The source MDM namespace.", + "readOnly": true + }, + "supportedTimeGrainTypes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The supported time grain types.", + "readOnly": true + } + }, + "type": "object", + "description": "A metric emitted by service." + }, + "Properties": { + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "The service specifications.", + "readOnly": true + } + }, + "type": "object", + "description": "The service specification property." + }, + "ServiceSpecification": { + "properties": { + "logSpecifications": { + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "description": "List of log specifications.", + "readOnly": true + }, + "metricSpecifications": { + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "description": "List of metric specifications.", + "readOnly": true + } + }, + "type": "object", + "description": "The service metric specifications." + }, + "LogSpecification": { + "properties": { + "name": { + "type": "string", + "description": "The diagnostic log category name.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The diagnostic log category display name.", + "readOnly": true + }, + "blobDuration": { + "type": "string", + "description": "The time range for requests in each blob.", + "readOnly": true + } + }, + "type": "object", + "description": "A diagnostic log emitted by service." + }, + "Operation": { + "description": "An operation.", + "properties": { + "name": { + "type": "string", + "description": "The operation name." + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "The operation display name." + }, + "origin": { + "type": "string", + "description": "Origin of the operation." + }, + "properties": { + "$ref": "#/definitions/Properties", + "description": "Operation properties format." + }, + "isDataAction": { + "type": "boolean", + "description": "Whether the operation applies to data-plane.", + "x-nullable": true + }, + "actionType": { + "type": "string", + "enum": [ + "Internal" + ], + "x-ms-enum": { + "name": "ActionType", + "values": [ + { + "value": "Internal", + "description": "An internal action." + } + ], + "modelAsString": true + }, + "description": "Indicates the action type.", + "x-nullable": true + } + }, + "type": "object", + "required": [ + "name" + ] + }, + "EntityNameAvailabilityCheckOutput": { + "properties": { + "nameAvailable": { + "type": "boolean", + "description": "Specifies if the name is available." + }, + "reason": { + "type": "string", + "description": "Specifies the reason if the name is not available." + }, + "message": { + "type": "string", + "description": "Specifies the detailed reason if the name is not available." + } + }, + "type": "object", + "required": [ + "nameAvailable" + ], + "description": "The response from the check name availability request." + }, + "StorageAccount": { + "properties": { + "id": { + "type": "string", + "description": "The ID of the storage account resource. Media Services relies on tables and queues as well as blobs, so the primary storage account must be a Standard Storage account (either Microsoft.ClassicStorage or Microsoft.Storage). Blob only storage accounts can be added as secondary storage accounts." + }, + "type": { + "type": "string", + "enum": [ + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "StorageAccountType", + "values": [ + { + "value": "Primary", + "description": "The primary storage account for the Media Services account." + }, + { + "value": "Secondary", + "description": "A secondary storage account for the Media Services account." + } + ], + "modelAsString": true + }, + "description": "The type of the storage account." + }, + "identity": { + "$ref": "#/definitions/ResourceIdentity", + "description": "The storage account identity." + }, + "status": { + "type": "string", + "description": "The current status of the storage account mapping.", + "readOnly": true + } + }, + "type": "object", + "required": [ + "type" + ], + "description": "The storage account details." + }, + "SyncStorageKeysInput": { + "properties": { + "id": { + "type": "string", + "description": "The ID of the storage account resource." + } + }, + "type": "object", + "description": "The input to the sync storage keys request." + }, + "MediaServiceProperties": { + "properties": { + "mediaServiceId": { + "type": "string", + "format": "uuid", + "description": "The Media Services account ID.", + "readOnly": true, + "x-nullable": false + }, + "storageAccounts": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccount" + }, + "description": "The storage accounts for this resource." + }, + "storageAuthentication": { + "type": "string", + "enum": [ + "System", + "ManagedIdentity" + ], + "x-ms-enum": { + "name": "StorageAuthentication", + "values": [ + { + "value": "System", + "description": "System authentication." + }, + { + "value": "ManagedIdentity", + "description": "Managed Identity authentication." + } + ], + "modelAsString": true + }, + "x-nullable": true + }, + "encryption": { + "$ref": "#/definitions/AccountEncryption", + "description": "The account encryption properties." + }, + "keyDelivery": { + "$ref": "#/definitions/KeyDelivery", + "description": "The Key Delivery properties for Media Services account." + }, + "publicNetworkAccess": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "values": [ + { + "value": "Enabled", + "description": "Public network access is enabled." + }, + { + "value": "Disabled", + "description": "Public network access is disabled." + } + ], + "modelAsString": true + }, + "description": "Whether or not public network access is allowed for resources under the Media Services account.", + "x-nullable": true + } + }, + "type": "object", + "description": "Properties of the Media Services account." + }, + "MediaService": { + "description": "A Media Services account.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MediaServiceProperties", + "description": "The resource properties.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "#/definitions/MediaServiceIdentity", + "description": "The Managed Identity for the Media Services account." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "The system metadata relating to this resource.", + "readOnly": true + } + }, + "type": "object" + }, + "MediaServiceUpdate": { + "description": "A Media Services account update.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "properties": { + "$ref": "#/definitions/MediaServiceProperties", + "description": "The resource properties.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "#/definitions/MediaServiceIdentity", + "description": "The Managed Identity for the Media Services account." + } + }, + "type": "object" + }, + "ListEdgePoliciesInput": { + "properties": { + "deviceId": { + "type": "string", + "description": "Unique identifier of the edge device." + } + }, + "type": "object" + }, + "EdgeUsageDataEventHub": { + "properties": { + "name": { + "type": "string", + "description": "Name of the Event Hub where usage will be reported." + }, + "namespace": { + "type": "string", + "description": "Namespace of the Event Hub where usage will be reported." + }, + "token": { + "type": "string", + "description": "SAS token needed to interact with Event Hub." + } + }, + "type": "object" + }, + "EdgeUsageDataCollectionPolicy": { + "properties": { + "dataCollectionFrequency": { + "type": "string", + "description": "Usage data collection frequency in ISO 8601 duration format e.g. PT10M , PT5H." + }, + "dataReportingFrequency": { + "type": "string", + "description": "Usage data reporting frequency in ISO 8601 duration format e.g. PT10M , PT5H." + }, + "maxAllowedUnreportedUsageDuration": { + "type": "string", + "description": "Maximum time for which the functionality of the device will not be hampered for not reporting the usage data." + }, + "eventHubDetails": { + "$ref": "#/definitions/EdgeUsageDataEventHub", + "description": "Details of Event Hub where the usage will be reported." + } + }, + "type": "object" + }, + "EdgePolicies": { + "properties": { + "usageDataCollectionPolicy": { + "$ref": "#/definitions/EdgeUsageDataCollectionPolicy" + } + }, + "type": "object" + }, + "MediaServiceIdentity": { + "properties": { + "type": { + "type": "string", + "description": "The identity type." + }, + "principalId": { + "type": "string", + "format": "uuid", + "description": "The Principal ID of the identity.", + "readOnly": true, + "x-nullable": true + }, + "tenantId": { + "type": "string", + "format": "uuid", + "description": "The Tenant ID of the identity.", + "readOnly": true, + "x-nullable": true + }, + "userAssignedIdentities": { + "$ref": "#/definitions/UserAssignedManagedIdentities", + "description": "The user assigned managed identities." + } + }, + "type": "object", + "required": [ + "type" + ] + }, + "UserAssignedManagedIdentity": { + "properties": { + "clientId": { + "type": "string", + "format": "uuid", + "description": "The client ID.", + "readOnly": true, + "x-nullable": true + }, + "principalId": { + "type": "string", + "format": "uuid", + "description": "The principal ID.", + "readOnly": true, + "x-nullable": true + } + }, + "type": "object" + }, + "UserAssignedManagedIdentities": { + "type": "object", + "description": "The User Assigned Managed Identities.", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedManagedIdentity" + } + }, + "KeyVaultProperties": { + "properties": { + "keyIdentifier": { + "type": "string", + "description": "The URL of the Key Vault key used to encrypt the account. The key may either be versioned (for example https://vault/keys/mykey/version1) or reference a key without a version (for example https://vault/keys/mykey)." + }, + "currentKeyIdentifier": { + "type": "string", + "description": "The current key used to encrypt the Media Services account, including the key version.", + "readOnly": true + } + }, + "type": "object" + }, + "ResourceIdentity": { + "properties": { + "userAssignedIdentity": { + "type": "string", + "description": "The user assigned managed identity's ARM ID to use when accessing a resource." + }, + "useSystemAssignedIdentity": { + "type": "boolean", + "description": "Indicates whether to use System Assigned Managed Identity. Mutual exclusive with User Assigned Managed Identity." + } + }, + "type": "object", + "required": [ + "useSystemAssignedIdentity" + ] + }, + "AccountEncryption": { + "properties": { + "type": { + "type": "string", + "enum": [ + "SystemKey", + "CustomerKey" + ], + "x-ms-enum": { + "name": "AccountEncryptionKeyType", + "values": [ + { + "value": "SystemKey", + "description": "The Account Key is encrypted with a System Key." + }, + { + "value": "CustomerKey", + "description": "The Account Key is encrypted with a Customer Key." + } + ], + "modelAsString": true + }, + "description": "The type of key used to encrypt the Account Key." + }, + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "The properties of the key used to encrypt the account." + }, + "identity": { + "$ref": "#/definitions/ResourceIdentity", + "description": "The Key Vault identity." + }, + "status": { + "type": "string", + "description": "The current status of the Key Vault mapping.", + "readOnly": true + } + }, + "type": "object", + "required": [ + "type" + ] + }, + "AccessControl": { + "properties": { + "defaultAction": { + "type": "string", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "DefaultAction", + "values": [ + { + "value": "Allow", + "description": "All public IP addresses are allowed." + }, + { + "value": "Deny", + "description": "Public IP addresses are blocked." + } + ], + "modelAsString": true + }, + "description": "The behavior for IP access control in Key Delivery." + }, + "ipAllowList": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IP allow list for access control in Key Delivery. If the default action is set to 'Allow', the IP allow list must be empty." + } + }, + "type": "object" + }, + "KeyDelivery": { + "properties": { + "accessControl": { + "$ref": "#/definitions/AccessControl", + "description": "The access control properties for Key Delivery." + } + }, + "type": "object" + }, + "OperationCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "A collection of Operation items." + } + }, + "type": "object", + "description": "A collection of Operation items." + }, + "MediaServiceCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MediaService" + }, + "description": "A collection of MediaService items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of MediaService items." + }, + "CheckNameAvailabilityInput": { + "description": "The input to the check name availability request.", + "properties": { + "name": { + "description": "The account name.", + "type": "string" + }, + "type": { + "description": "The account type. For a Media Services account, this should be 'MediaServices'.", + "type": "string" + } + }, + "type": "object" + } + }, + "paths": { + "/providers/Microsoft.Media/operations": { + "get": { + "summary": "List Operations", + "description": "Lists all the Media Services operations.", + "operationId": "Operations_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "List Operations": { + "$ref": "examples/operations-list-all.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices": { + "get": { + "summary": "List Media Services accounts", + "description": "List Media Services accounts in the resource group", + "operationId": "Mediaservices_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MediaServiceCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-examples": { + "List all Media Services accounts": { + "$ref": "examples/accounts-list-all-accounts.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}": { + "get": { + "summary": "Get a Media Services account", + "description": "Get the details of a Media Services account", + "operationId": "Mediaservices_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MediaService" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get a Media Services account by name": { + "$ref": "examples/accounts-get-by-name.json" + } + } + }, + "put": { + "summary": "Create or update a Media Services account", + "description": "Creates or updates a Media Services account", + "operationId": "Mediaservices_CreateOrUpdate", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MediaService" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/MediaService" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MediaService" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Create a Media Services account": { + "$ref": "examples/accounts-create.json" + } + } + }, + "delete": { + "summary": "Delete a Media Services account.", + "description": "Deletes a Media Services account", + "operationId": "Mediaservices_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete a Media Services account": { + "$ref": "examples/accounts-delete.json" + } + } + }, + "patch": { + "summary": "Update a Media Services account", + "description": "Updates an existing Media Services account", + "operationId": "Mediaservices_Update", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MediaService" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MediaServiceUpdate" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Update a Media Services accounts": { + "$ref": "examples/accounts-update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/syncStorageKeys": { + "post": { + "summary": "Synchronizes Storage Account Keys", + "description": "Synchronizes storage account keys for a storage account associated with the Media Service account.", + "operationId": "Mediaservices_SyncStorageKeys", + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SyncStorageKeysInput" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Synchronizes Storage Account Keys": { + "$ref": "examples/accounts-sync-storage-keys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/listEdgePolicies": { + "post": { + "summary": "List the media edge policies associated with the Media Services account.", + "description": "List the media edge policies associated with the Media Services account.", + "operationId": "Mediaservices_ListEdgePolicies", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EdgePolicies" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ListEdgePoliciesInput" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "List the media edge policies.": { + "$ref": "examples/accounts-list-media-edge-policies.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/privateLinkResources": { + "get": { + "summary": "Get list of group IDs.", + "description": "Get list of group IDs.", + "operationId": "PrivateLinkResources_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get list of all group IDs.": { + "$ref": "examples/private-link-resources-list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/privateLinkResources/{name}": { + "get": { + "summary": "Get group ID.", + "description": "Get group ID.", + "operationId": "PrivateLinkResources_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get details of a group ID.": { + "$ref": "examples/private-link-resources-get-by-name.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/privateEndpointConnections": { + "get": { + "summary": "Get all private endpoint connections.", + "description": "Get all private endpoint connections.", + "operationId": "PrivateEndpointConnections_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get all private endpoint connections.": { + "$ref": "examples/private-endpoint-connection-list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/privateEndpointConnections/{name}": { + "get": { + "summary": "Get private endpoint connection.", + "description": "Get private endpoint connection.", + "operationId": "PrivateEndpointConnections_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get private endpoint connection.": { + "$ref": "examples/private-endpoint-connection-get-by-name.json" + } + } + }, + "put": { + "summary": "Update private endpoint connection.", + "description": "Update private endpoint connection.", + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Update private endpoint connection.": { + "$ref": "examples/private-endpoint-connection-put.json" + } + } + }, + "delete": { + "summary": "Delete private endpoint connection.", + "description": "Delete private endpoint connection.", + "operationId": "PrivateEndpointConnections_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete private endpoint connection.": { + "$ref": "examples/private-endpoint-connection-delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Media/locations/{locationName}/checkNameAvailability": { + "post": { + "summary": "Check Name Availability", + "description": "Checks whether the Media Service resource name is available.", + "operationId": "Locations_CheckNameAvailability", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EntityNameAvailabilityCheckOutput" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the location" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityInput" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Check Name Availability": { + "$ref": "examples/accounts-check-name-availability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Media/mediaservices": { + "get": { + "summary": "List Media Services accounts", + "description": "List Media Services accounts in the subscription.", + "operationId": "Mediaservices_ListBySubscription", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MediaServiceCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-examples": { + "List all Media Services accounts": { + "$ref": "examples/accounts-subscription-list-all-accounts.json" + } + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The unique identifier for a Microsoft Azure subscription." + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the Azure subscription.", + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The version of the API to be used with the client request." + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/AssetsAndAssetFilters.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/AssetsAndAssetFilters.json new file mode 100644 index 000000000000..19977db7e6e2 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/AssetsAndAssetFilters.json @@ -0,0 +1,1243 @@ +{ + "schemes": [ + "https" + ], + "swagger": "2.0", + "info": { + "title": "Azure Media Services", + "description": "This Swagger was generated by the API Framework.", + "version": "2021-06-01" + }, + "host": "management.azure.com", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "definitions": { + "AssetProperties": { + "properties": { + "assetId": { + "type": "string", + "format": "uuid", + "description": "The Asset ID.", + "readOnly": true, + "x-nullable": false + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The creation date of the Asset.", + "readOnly": true, + "x-nullable": false + }, + "lastModified": { + "type": "string", + "format": "date-time", + "description": "The last modified date of the Asset.", + "readOnly": true, + "x-nullable": false + }, + "alternateId": { + "type": "string", + "description": "The alternate ID of the Asset." + }, + "description": { + "type": "string", + "description": "The Asset description." + }, + "container": { + "type": "string", + "description": "The name of the asset blob container." + }, + "storageAccountName": { + "type": "string", + "description": "The name of the storage account." + }, + "storageEncryptionFormat": { + "type": "string", + "enum": [ + "None", + "MediaStorageClientEncryption" + ], + "x-ms-enum": { + "name": "AssetStorageEncryptionFormat", + "values": [ + { + "value": "None", + "description": "The Asset does not use client-side storage encryption (this is the only allowed value for new Assets)." + }, + { + "value": "MediaStorageClientEncryption", + "description": "The Asset is encrypted with Media Services client-side encryption." + } + ], + "modelAsString": true + }, + "description": "The Asset encryption format. One of None or MediaStorageEncryption.", + "readOnly": true, + "x-nullable": false + } + }, + "type": "object", + "description": "The Asset properties." + }, + "AssetContainerSas": { + "properties": { + "assetContainerSasUrls": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of Asset container SAS URLs." + } + }, + "type": "object", + "description": "The Asset Storage container SAS URLs." + }, + "AssetFileEncryptionMetadata": { + "properties": { + "initializationVector": { + "type": "string", + "description": "The Asset File initialization vector." + }, + "assetFileName": { + "type": "string", + "description": "The Asset File name." + }, + "assetFileId": { + "type": "string", + "format": "uuid", + "description": "The Asset File Id." + } + }, + "type": "object", + "required": [ + "assetFileId" + ], + "description": "The Asset File Storage encryption metadata." + }, + "StorageEncryptedAssetDecryptionData": { + "properties": { + "key": { + "type": "string", + "format": "byte", + "description": "The Asset File storage encryption key." + }, + "assetFileEncryptionMetadata": { + "type": "array", + "items": { + "$ref": "#/definitions/AssetFileEncryptionMetadata" + }, + "description": "Asset File encryption metadata." + } + }, + "type": "object", + "description": "Data needed to decrypt asset files encrypted with legacy storage encryption." + }, + "ListStreamingLocatorsResponse": { + "properties": { + "streamingLocators": { + "type": "array", + "items": { + "$ref": "#/definitions/AssetStreamingLocator" + }, + "description": "The list of Streaming Locators.", + "readOnly": true + } + }, + "type": "object", + "description": "The Streaming Locators associated with this Asset." + }, + "AssetStreamingLocator": { + "properties": { + "name": { + "type": "string", + "description": "Streaming Locator name.", + "readOnly": true + }, + "assetName": { + "type": "string", + "description": "Asset Name.", + "readOnly": true + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The creation time of the Streaming Locator.", + "readOnly": true, + "x-nullable": false + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the Streaming Locator.", + "readOnly": true, + "x-nullable": false + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the Streaming Locator.", + "readOnly": true, + "x-nullable": false + }, + "streamingLocatorId": { + "type": "string", + "format": "uuid", + "description": "StreamingLocatorId of the Streaming Locator.", + "readOnly": true, + "x-nullable": false + }, + "streamingPolicyName": { + "type": "string", + "description": "Name of the Streaming Policy used by this Streaming Locator.", + "readOnly": true + }, + "defaultContentKeyPolicyName": { + "type": "string", + "description": "Name of the default ContentKeyPolicy used by this Streaming Locator.", + "readOnly": true + } + }, + "type": "object", + "description": "Properties of the Streaming Locator." + }, + "Asset": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AssetProperties", + "description": "The resource properties.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "The system metadata relating to this resource.", + "readOnly": true + } + }, + "type": "object", + "description": "An Asset." + }, + "PresentationTimeRange": { + "properties": { + "startTimestamp": { + "type": "integer", + "format": "int64", + "description": "The absolute start time boundary." + }, + "endTimestamp": { + "type": "integer", + "format": "int64", + "description": "The absolute end time boundary." + }, + "presentationWindowDuration": { + "type": "integer", + "format": "int64", + "description": "The relative to end sliding window." + }, + "liveBackoffDuration": { + "type": "integer", + "format": "int64", + "description": "The relative to end right edge." + }, + "timescale": { + "type": "integer", + "format": "int64", + "description": "The time scale of time stamps." + }, + "forceEndTimestamp": { + "type": "boolean", + "description": "The indicator of forcing existing of end time stamp." + } + }, + "type": "object", + "description": "The presentation time range, this is asset related and not recommended for Account Filter." + }, + "FilterTrackPropertyCondition": { + "properties": { + "property": { + "type": "string", + "enum": [ + "Unknown", + "Type", + "Name", + "Language", + "FourCC", + "Bitrate" + ], + "x-ms-enum": { + "name": "FilterTrackPropertyType", + "values": [ + { + "value": "Unknown", + "description": "The unknown track property type." + }, + { + "value": "Type", + "description": "The type." + }, + { + "value": "Name", + "description": "The name." + }, + { + "value": "Language", + "description": "The language." + }, + { + "value": "FourCC", + "description": "The fourCC." + }, + { + "value": "Bitrate", + "description": "The bitrate." + } + ], + "modelAsString": true + }, + "description": "The track property type." + }, + "value": { + "type": "string", + "description": "The track property value." + }, + "operation": { + "type": "string", + "enum": [ + "Equal", + "NotEqual" + ], + "x-ms-enum": { + "name": "FilterTrackPropertyCompareOperation", + "values": [ + { + "value": "Equal", + "description": "The equal operation." + }, + { + "value": "NotEqual", + "description": "The not equal operation." + } + ], + "modelAsString": true + }, + "description": "The track property condition operation." + } + }, + "type": "object", + "required": [ + "property", + "value", + "operation" + ], + "description": "The class to specify one track property condition." + }, + "FirstQuality": { + "properties": { + "bitrate": { + "type": "integer", + "format": "int32", + "description": "The first quality bitrate." + } + }, + "type": "object", + "required": [ + "bitrate" + ], + "description": "Filter First Quality" + }, + "FilterTrackSelection": { + "properties": { + "trackSelections": { + "type": "array", + "items": { + "$ref": "#/definitions/FilterTrackPropertyCondition" + }, + "description": "The track selections." + } + }, + "type": "object", + "required": [ + "trackSelections" + ], + "description": "Representing a list of FilterTrackPropertyConditions to select a track. The filters are combined using a logical AND operation." + }, + "MediaFilterProperties": { + "properties": { + "presentationTimeRange": { + "$ref": "#/definitions/PresentationTimeRange", + "description": "The presentation time range." + }, + "firstQuality": { + "$ref": "#/definitions/FirstQuality", + "description": "The first quality." + }, + "tracks": { + "type": "array", + "items": { + "$ref": "#/definitions/FilterTrackSelection" + }, + "description": "The tracks selection conditions." + } + }, + "type": "object", + "description": "The Media Filter properties." + }, + "AssetFilter": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MediaFilterProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "The system metadata relating to this resource.", + "readOnly": true + } + }, + "type": "object", + "description": "An Asset Filter." + }, + "AssetCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Asset" + }, + "description": "A collection of Asset items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of Asset items." + }, + "ListContainerSasInput": { + "description": "The parameters to the list SAS request.", + "properties": { + "permissions": { + "description": "The permissions to set on the SAS URL.", + "type": "string", + "enum": [ + "Read", + "ReadWrite", + "ReadWriteDelete" + ], + "x-ms-enum": { + "name": "AssetContainerPermission", + "values": [ + { + "value": "Read", + "description": "The SAS URL will allow read access to the container." + }, + { + "value": "ReadWrite", + "description": "The SAS URL will allow read and write access to the container." + }, + { + "value": "ReadWriteDelete", + "description": "The SAS URL will allow read, write and delete access to the container." + } + ], + "modelAsString": true + } + }, + "expiryTime": { + "description": "The SAS URL expiration time. This must be less than 24 hours from the current time.", + "type": "string", + "format": "date-time" + } + }, + "type": "object" + }, + "AssetFilterCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AssetFilter" + }, + "description": "A collection of AssetFilter items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of AssetFilter items." + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets": { + "get": { + "summary": "List Assets", + "description": "List Assets in the Media Services account with optional filtering and ordering", + "operationId": "Assets_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AssetCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Restricts the set of items returned." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Specifies the key by which the result collection should be ordered." + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-odata": "#/definitions/Asset", + "x-ms-examples": { + "List all Assets": { + "$ref": "examples/assets-list-all.json" + }, + "List Asset ordered by date": { + "$ref": "examples/assets-list-by-date.json" + }, + "List Asset created in a date range": { + "$ref": "examples/assets-list-in-date-range.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}": { + "get": { + "summary": "Get an Asset", + "description": "Get the details of an Asset in the Media Services account", + "operationId": "Assets_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Asset" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get an Asset by name": { + "$ref": "examples/assets-get-by-name.json" + } + } + }, + "put": { + "summary": "Create or update an Asset", + "description": "Creates or updates an Asset in the Media Services account", + "operationId": "Assets_CreateOrUpdate", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Asset" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Asset" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Asset" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Create an Asset": { + "$ref": "examples/assets-create.json" + } + } + }, + "delete": { + "summary": "Delete an Asset.", + "description": "Deletes an Asset in the Media Services account", + "operationId": "Assets_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete an Asset": { + "$ref": "examples/assets-delete.json" + } + } + }, + "patch": { + "summary": "Update an Asset", + "description": "Updates an existing Asset in the Media Services account", + "operationId": "Assets_Update", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Asset" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Asset" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Update an Asset": { + "$ref": "examples/assets-update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}/listContainerSas": { + "post": { + "summary": "List the Asset URLs", + "description": "Lists storage container URLs with shared access signatures (SAS) for uploading and downloading Asset content. The signatures are derived from the storage account keys.", + "operationId": "Assets_ListContainerSas", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AssetContainerSas" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ListContainerSasInput" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "List Asset SAS URLs": { + "$ref": "examples/assets-list-sas-urls.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}/getEncryptionKey": { + "post": { + "summary": "Gets the Asset storage key", + "description": "Gets the Asset storage encryption keys used to decrypt content created by version 2 of the Media Services API", + "operationId": "Assets_GetEncryptionKey", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageEncryptedAssetDecryptionData" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get Asset Storage Encryption Keys": { + "$ref": "examples/assets-get-encryption-keys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}/listStreamingLocators": { + "post": { + "summary": "List Streaming Locators", + "description": "Lists Streaming Locators which are associated with this asset.", + "operationId": "Assets_ListStreamingLocators", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListStreamingLocatorsResponse" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "List Asset SAS URLs": { + "$ref": "examples/assets-list-streaming-locators.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}/assetFilters": { + "get": { + "summary": "List Asset Filters", + "description": "List Asset Filters associated with the specified Asset.", + "operationId": "AssetFilters_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AssetFilterCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-examples": { + "List all Asset Filters": { + "$ref": "examples/assetFilters-list-all.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}/assetFilters/{filterName}": { + "get": { + "summary": "Get an Asset Filter.", + "description": "Get the details of an Asset Filter associated with the specified Asset.", + "operationId": "AssetFilters_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AssetFilter" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "name": "filterName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset Filter name" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get an Asset Filter by name": { + "$ref": "examples/assetFilters-get-by-name.json" + } + } + }, + "put": { + "summary": "Create or update an Asset Filter", + "description": "Creates or updates an Asset Filter associated with the specified Asset.", + "operationId": "AssetFilters_CreateOrUpdate", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AssetFilter" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/AssetFilter" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "name": "filterName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset Filter name" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AssetFilter" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Create an Asset Filter": { + "$ref": "examples/assetFilters-create.json" + } + } + }, + "delete": { + "summary": "Delete an Asset Filter.", + "description": "Deletes an Asset Filter associated with the specified Asset.", + "operationId": "AssetFilters_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "name": "filterName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset Filter name" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete an Asset Filter": { + "$ref": "examples/assetFilters-delete.json" + } + } + }, + "patch": { + "summary": "Update an Asset Filter", + "description": "Updates an existing Asset Filter associated with the specified Asset.", + "operationId": "AssetFilters_Update", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AssetFilter" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "name": "filterName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset Filter name" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AssetFilter" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Update an Asset Filter": { + "$ref": "examples/assetFilters-update.json" + } + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The unique identifier for a Microsoft Azure subscription." + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the Azure subscription.", + "x-ms-parameter-location": "method" + }, + "MediaServicesAccountName": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name.", + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The version of the API to be used with the client request." + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/ContentKeyPolicies.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/ContentKeyPolicies.json new file mode 100644 index 000000000000..4a7551a27e8a --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/ContentKeyPolicies.json @@ -0,0 +1,1169 @@ +{ + "schemes": [ + "https" + ], + "swagger": "2.0", + "info": { + "title": "Azure Media Services", + "description": "This Swagger was generated by the API Framework.", + "version": "2021-06-01" + }, + "host": "management.azure.com", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "definitions": { + "ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction": { + "properties": { + "bestEffort": { + "type": "boolean", + "description": "Indicates whether this restriction is enforced on a Best Effort basis." + }, + "configurationData": { + "type": "integer", + "format": "int32", + "description": "Configures the restriction control bits. Must be between 0 and 3 inclusive." + } + }, + "type": "object", + "required": [ + "bestEffort", + "configurationData" + ], + "description": "Configures the Explicit Analog Television Output Restriction control bits. For further details see the PlayReady Compliance Rules." + }, + "ContentKeyPolicyPlayReadyContentKeyLocation": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base class for content key ID location. A derived class must be used to represent the location." + }, + "ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyPlayReadyContentKeyLocation" + } + ], + "properties": {}, + "type": "object", + "description": "Specifies that the content key ID is in the PlayReady header." + }, + "ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyPlayReadyContentKeyLocation" + } + ], + "properties": { + "keyId": { + "type": "string", + "format": "uuid", + "description": "The content key ID.", + "x-nullable": true + } + }, + "type": "object", + "required": [ + "keyId" + ], + "description": "Specifies that the content key ID is specified in the PlayReady configuration." + }, + "ContentKeyPolicyPlayReadyPlayRight": { + "properties": { + "firstPlayExpiration": { + "type": "string", + "format": "duration", + "description": "The amount of time that the license is valid after the license is first used to play content." + }, + "scmsRestriction": { + "type": "integer", + "format": "int32", + "description": "Configures the Serial Copy Management System (SCMS) in the license. Must be between 0 and 3 inclusive." + }, + "agcAndColorStripeRestriction": { + "type": "integer", + "format": "int32", + "description": "Configures Automatic Gain Control (AGC) and Color Stripe in the license. Must be between 0 and 3 inclusive." + }, + "explicitAnalogTelevisionOutputRestriction": { + "$ref": "#/definitions/ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction", + "description": "Configures the Explicit Analog Television Output Restriction in the license. Configuration data must be between 0 and 3 inclusive." + }, + "digitalVideoOnlyContentRestriction": { + "type": "boolean", + "description": "Enables the Image Constraint For Analog Component Video Restriction in the license." + }, + "imageConstraintForAnalogComponentVideoRestriction": { + "type": "boolean", + "description": "Enables the Image Constraint For Analog Component Video Restriction in the license." + }, + "imageConstraintForAnalogComputerMonitorRestriction": { + "type": "boolean", + "description": "Enables the Image Constraint For Analog Component Video Restriction in the license." + }, + "allowPassingVideoContentToUnknownOutput": { + "type": "string", + "enum": [ + "Unknown", + "NotAllowed", + "Allowed", + "AllowedWithVideoConstriction" + ], + "x-ms-enum": { + "name": "ContentKeyPolicyPlayReadyUnknownOutputPassingOption", + "values": [ + { + "value": "Unknown", + "description": "Represents a ContentKeyPolicyPlayReadyUnknownOutputPassingOption that is unavailable in current API version." + }, + { + "value": "NotAllowed", + "description": "Passing the video portion of protected content to an Unknown Output is not allowed." + }, + { + "value": "Allowed", + "description": "Passing the video portion of protected content to an Unknown Output is allowed." + }, + { + "value": "AllowedWithVideoConstriction", + "description": "Passing the video portion of protected content to an Unknown Output is allowed but with constrained resolution." + } + ], + "modelAsString": true + }, + "description": "Configures Unknown output handling settings of the license." + }, + "uncompressedDigitalVideoOpl": { + "type": "integer", + "format": "int32", + "description": "Specifies the output protection level for uncompressed digital video." + }, + "compressedDigitalVideoOpl": { + "type": "integer", + "format": "int32", + "description": "Specifies the output protection level for compressed digital video." + }, + "analogVideoOpl": { + "type": "integer", + "format": "int32", + "description": "Specifies the output protection level for compressed digital audio." + }, + "compressedDigitalAudioOpl": { + "type": "integer", + "format": "int32", + "description": "Specifies the output protection level for compressed digital audio." + }, + "uncompressedDigitalAudioOpl": { + "type": "integer", + "format": "int32", + "description": "Specifies the output protection level for uncompressed digital audio." + } + }, + "type": "object", + "required": [ + "digitalVideoOnlyContentRestriction", + "imageConstraintForAnalogComponentVideoRestriction", + "imageConstraintForAnalogComputerMonitorRestriction", + "allowPassingVideoContentToUnknownOutput" + ], + "description": "Configures the Play Right in the PlayReady license." + }, + "ContentKeyPolicyTokenClaim": { + "properties": { + "claimType": { + "type": "string", + "description": "Token claim type." + }, + "claimValue": { + "type": "string", + "description": "Token claim value." + } + }, + "type": "object", + "description": "Represents a token claim." + }, + "ContentKeyPolicyPlayReadyLicense": { + "properties": { + "allowTestDevices": { + "type": "boolean", + "description": "A flag indicating whether test devices can use the license." + }, + "beginDate": { + "type": "string", + "format": "date-time", + "description": "The begin date of license" + }, + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "The expiration date of license." + }, + "relativeBeginDate": { + "type": "string", + "format": "duration", + "description": "The relative begin date of license." + }, + "relativeExpirationDate": { + "type": "string", + "format": "duration", + "description": "The relative expiration date of license." + }, + "gracePeriod": { + "type": "string", + "format": "duration", + "description": "The grace period of license." + }, + "playRight": { + "$ref": "#/definitions/ContentKeyPolicyPlayReadyPlayRight", + "description": "The license PlayRight" + }, + "licenseType": { + "type": "string", + "enum": [ + "Unknown", + "NonPersistent", + "Persistent" + ], + "x-ms-enum": { + "name": "ContentKeyPolicyPlayReadyLicenseType", + "values": [ + { + "value": "Unknown", + "description": "Represents a ContentKeyPolicyPlayReadyLicenseType that is unavailable in current API version." + }, + { + "value": "NonPersistent", + "description": "Non persistent license." + }, + { + "value": "Persistent", + "description": "Persistent license. Allows offline playback." + } + ], + "modelAsString": true + }, + "description": "The license type." + }, + "contentKeyLocation": { + "$ref": "#/definitions/ContentKeyPolicyPlayReadyContentKeyLocation", + "description": "The content key location." + }, + "contentType": { + "type": "string", + "enum": [ + "Unknown", + "Unspecified", + "UltraVioletDownload", + "UltraVioletStreaming" + ], + "x-ms-enum": { + "name": "ContentKeyPolicyPlayReadyContentType", + "values": [ + { + "value": "Unknown", + "description": "Represents a ContentKeyPolicyPlayReadyContentType that is unavailable in current API version." + }, + { + "value": "Unspecified", + "description": "Unspecified content type." + }, + { + "value": "UltraVioletDownload", + "description": "Ultraviolet download content type." + }, + { + "value": "UltraVioletStreaming", + "description": "Ultraviolet streaming content type." + } + ], + "modelAsString": true + }, + "description": "The PlayReady content type." + } + }, + "type": "object", + "required": [ + "allowTestDevices", + "licenseType", + "contentKeyLocation", + "contentType" + ], + "description": "The PlayReady license" + }, + "ContentKeyPolicyRestriction": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base class for Content Key Policy restrictions. A derived class must be used to create a restriction." + }, + "ContentKeyPolicyOpenRestriction": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyOpenRestriction", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyRestriction" + } + ], + "properties": {}, + "type": "object", + "description": "Represents an open restriction. License or key will be delivered on every request." + }, + "ContentKeyPolicyUnknownRestriction": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyUnknownRestriction", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyRestriction" + } + ], + "properties": {}, + "type": "object", + "description": "Represents a ContentKeyPolicyRestriction that is unavailable in the current API version." + }, + "ContentKeyPolicyConfiguration": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base class for Content Key Policy configuration. A derived class must be used to create a configuration." + }, + "ContentKeyPolicyRestrictionTokenKey": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base class for Content Key Policy key for token validation. A derived class must be used to create a token key." + }, + "ContentKeyPolicySymmetricTokenKey": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyRestrictionTokenKey" + } + ], + "properties": { + "keyValue": { + "type": "string", + "format": "byte", + "description": "The key value of the key", + "x-nullable": true + } + }, + "type": "object", + "required": [ + "keyValue" + ], + "description": "Specifies a symmetric key for token validation." + }, + "ContentKeyPolicyRsaTokenKey": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyRsaTokenKey", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyRestrictionTokenKey" + } + ], + "properties": { + "exponent": { + "type": "string", + "format": "byte", + "description": "The RSA Parameter exponent", + "x-nullable": true + }, + "modulus": { + "type": "string", + "format": "byte", + "description": "The RSA Parameter modulus", + "x-nullable": true + } + }, + "type": "object", + "required": [ + "exponent", + "modulus" + ], + "description": "Specifies a RSA key for token validation" + }, + "ContentKeyPolicyX509CertificateTokenKey": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyX509CertificateTokenKey", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyRestrictionTokenKey" + } + ], + "properties": { + "rawBody": { + "type": "string", + "format": "byte", + "description": "The raw data field of a certificate in PKCS 12 format (X509Certificate2 in .NET)", + "x-nullable": true + } + }, + "type": "object", + "required": [ + "rawBody" + ], + "description": "Specifies a certificate for token validation." + }, + "ContentKeyPolicyTokenRestriction": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyRestriction" + } + ], + "properties": { + "issuer": { + "type": "string", + "description": "The token issuer." + }, + "audience": { + "type": "string", + "description": "The audience for the token." + }, + "primaryVerificationKey": { + "$ref": "#/definitions/ContentKeyPolicyRestrictionTokenKey", + "description": "The primary verification key." + }, + "alternateVerificationKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/ContentKeyPolicyRestrictionTokenKey" + }, + "description": "A list of alternative verification keys." + }, + "requiredClaims": { + "type": "array", + "items": { + "$ref": "#/definitions/ContentKeyPolicyTokenClaim" + }, + "description": "A list of required token claims." + }, + "restrictionTokenType": { + "type": "string", + "enum": [ + "Unknown", + "Swt", + "Jwt" + ], + "x-ms-enum": { + "name": "ContentKeyPolicyRestrictionTokenType", + "values": [ + { + "value": "Unknown", + "description": "Represents a ContentKeyPolicyRestrictionTokenType that is unavailable in current API version." + }, + { + "value": "Swt", + "description": "Simple Web Token." + }, + { + "value": "Jwt", + "description": "JSON Web Token." + } + ], + "modelAsString": true + }, + "description": "The type of token." + }, + "openIdConnectDiscoveryDocument": { + "type": "string", + "description": "The OpenID connect discovery document." + } + }, + "type": "object", + "required": [ + "issuer", + "audience", + "primaryVerificationKey", + "restrictionTokenType" + ], + "description": "Represents a token restriction. Provided token must match these requirements for successful license or key delivery." + }, + "ContentKeyPolicyClearKeyConfiguration": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyConfiguration" + } + ], + "properties": {}, + "type": "object", + "description": "Represents a configuration for non-DRM keys." + }, + "ContentKeyPolicyUnknownConfiguration": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyUnknownConfiguration", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyConfiguration" + } + ], + "properties": {}, + "type": "object", + "description": "Represents a ContentKeyPolicyConfiguration that is unavailable in the current API version." + }, + "ContentKeyPolicyWidevineConfiguration": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyConfiguration" + } + ], + "properties": { + "widevineTemplate": { + "type": "string", + "description": "The Widevine template." + } + }, + "type": "object", + "required": [ + "widevineTemplate" + ], + "description": "Specifies a configuration for Widevine licenses." + }, + "ContentKeyPolicyPlayReadyConfiguration": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyConfiguration" + } + ], + "properties": { + "licenses": { + "type": "array", + "items": { + "$ref": "#/definitions/ContentKeyPolicyPlayReadyLicense" + }, + "description": "The PlayReady licenses." + }, + "responseCustomData": { + "type": "string", + "description": "The custom response data." + } + }, + "type": "object", + "required": [ + "licenses" + ], + "description": "Specifies a configuration for PlayReady licenses." + }, + "ContentKeyPolicyFairPlayOfflineRentalConfiguration": { + "properties": { + "playbackDurationSeconds": { + "type": "integer", + "format": "int64", + "description": "Playback duration" + }, + "storageDurationSeconds": { + "type": "integer", + "format": "int64", + "description": "Storage duration" + } + }, + "type": "object", + "required": [ + "playbackDurationSeconds", + "storageDurationSeconds" + ] + }, + "ContentKeyPolicyFairPlayConfiguration": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyFairPlayConfiguration", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyConfiguration" + } + ], + "properties": { + "ask": { + "type": "string", + "format": "byte", + "description": "The key that must be used as FairPlay Application Secret key.", + "x-nullable": true + }, + "fairPlayPfxPassword": { + "type": "string", + "description": "The password encrypting FairPlay certificate in PKCS 12 (pfx) format.", + "x-nullable": true + }, + "fairPlayPfx": { + "type": "string", + "description": "The Base64 representation of FairPlay certificate in PKCS 12 (pfx) format (including private key).", + "x-nullable": true + }, + "rentalAndLeaseKeyType": { + "type": "string", + "enum": [ + "Unknown", + "Undefined", + "DualExpiry", + "PersistentUnlimited", + "PersistentLimited" + ], + "x-ms-enum": { + "name": "ContentKeyPolicyFairPlayRentalAndLeaseKeyType", + "values": [ + { + "value": "Unknown", + "description": "Represents a ContentKeyPolicyFairPlayRentalAndLeaseKeyType that is unavailable in current API version." + }, + { + "value": "Undefined", + "description": "Key duration is not specified." + }, + { + "value": "DualExpiry", + "description": "Dual expiry for offline rental." + }, + { + "value": "PersistentUnlimited", + "description": "Content key can be persisted with an unlimited duration" + }, + { + "value": "PersistentLimited", + "description": "Content key can be persisted and the valid duration is limited by the Rental Duration value" + } + ], + "modelAsString": true + }, + "description": "The rental and lease key type." + }, + "rentalDuration": { + "type": "integer", + "format": "int64", + "description": "The rental duration. Must be greater than or equal to 0." + }, + "offlineRentalConfiguration": { + "$ref": "#/definitions/ContentKeyPolicyFairPlayOfflineRentalConfiguration", + "description": "Offline rental policy" + } + }, + "type": "object", + "required": [ + "ask", + "fairPlayPfxPassword", + "fairPlayPfx", + "rentalAndLeaseKeyType", + "rentalDuration" + ], + "description": "Specifies a configuration for FairPlay licenses." + }, + "ContentKeyPolicyOption": { + "properties": { + "policyOptionId": { + "type": "string", + "format": "uuid", + "description": "The legacy Policy Option ID.", + "readOnly": true, + "x-nullable": false + }, + "name": { + "type": "string", + "description": "The Policy Option description." + }, + "configuration": { + "$ref": "#/definitions/ContentKeyPolicyConfiguration", + "description": "The key delivery configuration." + }, + "restriction": { + "$ref": "#/definitions/ContentKeyPolicyRestriction", + "description": "The requirements that must be met to deliver keys with this configuration" + } + }, + "type": "object", + "required": [ + "configuration", + "restriction" + ], + "description": "Represents a policy option." + }, + "ContentKeyPolicyProperties": { + "properties": { + "policyId": { + "type": "string", + "format": "uuid", + "description": "The legacy Policy ID.", + "readOnly": true, + "x-nullable": false + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The creation date of the Policy", + "readOnly": true, + "x-nullable": false + }, + "lastModified": { + "type": "string", + "format": "date-time", + "description": "The last modified date of the Policy", + "readOnly": true, + "x-nullable": false + }, + "description": { + "type": "string", + "description": "A description for the Policy." + }, + "options": { + "type": "array", + "items": { + "$ref": "#/definitions/ContentKeyPolicyOption" + }, + "description": "The Key Policy options." + } + }, + "type": "object", + "required": [ + "options" + ], + "description": "The properties of the Content Key Policy." + }, + "ContentKeyPolicy": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ContentKeyPolicyProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "The system metadata relating to this resource.", + "readOnly": true + } + }, + "type": "object", + "description": "A Content Key Policy resource." + }, + "ContentKeyPolicyCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ContentKeyPolicy" + }, + "description": "A collection of ContentKeyPolicy items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of ContentKeyPolicy items." + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/contentKeyPolicies": { + "get": { + "summary": "List Content Key Policies", + "description": "Lists the Content Key Policies in the account", + "operationId": "ContentKeyPolicies_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContentKeyPolicyCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Restricts the set of items returned." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Specifies the key by which the result collection should be ordered." + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-odata": "#/definitions/ContentKeyPolicy", + "x-ms-examples": { + "Lists all Content Key Policies": { + "$ref": "examples/content-key-policies-list-all.json" + }, + "Lists Content Key Policies ordered by last modified.": { + "$ref": "examples/content-key-policies-list-by-lastModified.json" + }, + "Lists Content Key Policies with created and last modified filters.": { + "$ref": "examples/content-key-policies-list-in-date-range.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/contentKeyPolicies/{contentKeyPolicyName}": { + "get": { + "summary": "Get a Content Key Policy", + "description": "Get the details of a Content Key Policy in the Media Services account", + "operationId": "ContentKeyPolicies_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContentKeyPolicy" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "contentKeyPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Content Key Policy name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get a Content Key Policy by name": { + "$ref": "examples/content-key-policies-get-by-name.json" + } + } + }, + "put": { + "summary": "Create or update an Content Key Policy", + "description": "Create or update a Content Key Policy in the Media Services account", + "operationId": "ContentKeyPolicies_CreateOrUpdate", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContentKeyPolicy" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ContentKeyPolicy" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "contentKeyPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Content Key Policy name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ContentKeyPolicy" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Creates a Content Key Policy with PlayReady option and Open Restriction": { + "$ref": "examples/content-key-policies-create-playready-open.json" + }, + "Creates a Content Key Policy with Widevine option and Token Restriction": { + "$ref": "examples/content-key-policies-create-widevine-token.json" + }, + "Creates a Content Key Policy with ClearKey option and Token Restriction": { + "$ref": "examples/content-key-policies-create-nodrm-token.json" + }, + "Creates a Content Key Policy with multiple options": { + "$ref": "examples/content-key-policies-create-multiple-options.json" + } + } + }, + "delete": { + "summary": "Delete a Content Key Policy", + "description": "Deletes a Content Key Policy in the Media Services account", + "operationId": "ContentKeyPolicies_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "contentKeyPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Content Key Policy name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete a Key Policy": { + "$ref": "examples/content-key-policies-delete.json" + } + } + }, + "patch": { + "summary": "Update a Content Key Policy", + "description": "Updates an existing Content Key Policy in the Media Services account", + "operationId": "ContentKeyPolicies_Update", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContentKeyPolicy" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "contentKeyPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Content Key Policy name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ContentKeyPolicy" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Update a Content Key Policy": { + "$ref": "examples/content-key-policies-update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/contentKeyPolicies/{contentKeyPolicyName}/getPolicyPropertiesWithSecrets": { + "post": { + "summary": "Get a Content Key Policy with secrets", + "description": "Get a Content Key Policy including secret values", + "operationId": "ContentKeyPolicies_GetPolicyPropertiesWithSecrets", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContentKeyPolicyProperties" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "contentKeyPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Content Key Policy name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get an Content Key Policy with secrets": { + "$ref": "examples/content-key-policies-get-with-secrets.json" + } + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The unique identifier for a Microsoft Azure subscription." + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the Azure subscription.", + "x-ms-parameter-location": "method" + }, + "MediaServicesAccountName": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name.", + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The version of the API to be used with the client request." + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/Encoding.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/Encoding.json new file mode 100644 index 000000000000..7677a3a1ac0a --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/Encoding.json @@ -0,0 +1,3186 @@ +{ + "schemes": [ + "https" + ], + "swagger": "2.0", + "info": { + "title": "Azure Media Services", + "description": "This Swagger was generated by the API Framework.", + "version": "2021-06-01" + }, + "host": "management.azure.com", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "definitions": { + "Preset": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base type for all Presets, which define the recipe or instructions on how the input media files should be processed." + }, + "Codec": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + }, + "label": { + "type": "string", + "description": "An optional label for the codec. The label can be used to control muxing behavior." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Describes the basic properties of all codecs." + }, + "Audio": { + "x-ms-discriminator-value": "#Microsoft.Media.Audio", + "allOf": [ + { + "$ref": "#/definitions/Codec" + } + ], + "properties": { + "channels": { + "type": "integer", + "format": "int32", + "description": "The number of channels in the audio." + }, + "samplingRate": { + "type": "integer", + "format": "int32", + "description": "The sampling rate to use for encoding in hertz." + }, + "bitrate": { + "type": "integer", + "format": "int32", + "description": "The bitrate, in bits per second, of the output encoded audio." + } + }, + "type": "object", + "description": "Defines the common properties for all audio codecs." + }, + "AacAudio": { + "x-ms-discriminator-value": "#Microsoft.Media.AacAudio", + "allOf": [ + { + "$ref": "#/definitions/Audio" + } + ], + "properties": { + "profile": { + "type": "string", + "enum": [ + "AacLc", + "HeAacV1", + "HeAacV2" + ], + "x-ms-enum": { + "name": "AacAudioProfile", + "values": [ + { + "value": "AacLc", + "description": "Specifies that the output audio is to be encoded into AAC Low Complexity profile (AAC-LC)." + }, + { + "value": "HeAacV1", + "description": "Specifies that the output audio is to be encoded into HE-AAC v1 profile." + }, + { + "value": "HeAacV2", + "description": "Specifies that the output audio is to be encoded into HE-AAC v2 profile." + } + ], + "modelAsString": true + }, + "description": "The encoding profile to be used when encoding audio with AAC." + } + }, + "type": "object", + "description": "Describes Advanced Audio Codec (AAC) audio encoding settings." + }, + "Layer": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + }, + "width": { + "type": "string", + "description": "The width of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in width as the input." + }, + "height": { + "type": "string", + "description": "The height of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in height as the input." + }, + "label": { + "type": "string", + "description": "The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "The encoder can be configured to produce video and/or images (thumbnails) at different resolutions, by specifying a layer for each desired resolution. A layer represents the properties for the video or image at a resolution." + }, + "H265VideoLayer": { + "x-ms-discriminator-value": "#Microsoft.Media.H265VideoLayer", + "allOf": [ + { + "$ref": "#/definitions/Layer" + } + ], + "properties": { + "bitrate": { + "type": "integer", + "format": "int32", + "description": "The average bitrate in bits per second at which to encode the input video when generating this layer. For example: a target bitrate of 3000Kbps or 3Mbps means this value should be 3000000 This is a required field." + }, + "maxBitrate": { + "type": "integer", + "format": "int32", + "description": "The maximum bitrate (in bits per second), at which the VBV buffer should be assumed to refill. If not specified, defaults to the same value as bitrate." + }, + "bFrames": { + "type": "integer", + "format": "int32", + "description": "The number of B-frames to be used when encoding this layer. If not specified, the encoder chooses an appropriate number based on the video profile and level." + }, + "frameRate": { + "type": "string", + "description": "The frame rate (in frames per second) at which to encode this layer. The value can be in the form of M/N where M and N are integers (For example, 30000/1001), or in the form of a number (For example, 30, or 29.97). The encoder enforces constraints on allowed frame rates based on the profile and level. If it is not specified, the encoder will use the same frame rate as the input video." + }, + "slices": { + "type": "integer", + "format": "int32", + "description": "The number of slices to be used when encoding this layer. If not specified, default is zero, which means that encoder will use a single slice for each frame." + }, + "adaptiveBFrame": { + "type": "boolean", + "description": "Specifies whether or not adaptive B-frames are to be used when encoding this layer. If not specified, the encoder will turn it on whenever the video profile permits its use." + } + }, + "type": "object", + "required": [ + "bitrate" + ], + "description": "Describes the settings to be used when encoding the input video into a desired output bitrate layer." + }, + "H265Layer": { + "x-ms-discriminator-value": "#Microsoft.Media.H265Layer", + "allOf": [ + { + "$ref": "#/definitions/H265VideoLayer" + } + ], + "properties": { + "profile": { + "type": "string", + "enum": [ + "Auto", + "Main" + ], + "x-ms-enum": { + "name": "H265VideoProfile", + "values": [ + { + "value": "Auto", + "description": "Tells the encoder to automatically determine the appropriate H.265 profile." + }, + { + "value": "Main", + "description": "Main profile (https://x265.readthedocs.io/en/default/cli.html?highlight=profile#profile-level-tier)" + } + ], + "modelAsString": true + }, + "description": "We currently support Main. Default is Auto." + }, + "level": { + "type": "string", + "description": "We currently support Level up to 6.2. The value can be Auto, or a number that matches the H.265 profile. If not specified, the default is Auto, which lets the encoder choose the Level that is appropriate for this layer." + }, + "bufferWindow": { + "type": "string", + "format": "duration", + "description": "The VBV buffer window length. The value should be in ISO 8601 format. The value should be in the range [0.1-100] seconds. The default is 5 seconds (for example, PT5S)." + }, + "referenceFrames": { + "type": "integer", + "format": "int32", + "description": "The number of reference frames to be used when encoding this layer. If not specified, the encoder determines an appropriate number based on the encoder complexity setting." + } + }, + "type": "object", + "description": "Describes the settings to be used when encoding the input video into a desired output bitrate layer with the H.265 video codec." + }, + "Video": { + "x-ms-discriminator-value": "#Microsoft.Media.Video", + "allOf": [ + { + "$ref": "#/definitions/Codec" + } + ], + "properties": { + "keyFrameInterval": { + "type": "string", + "format": "duration", + "description": "The distance between two key frames. The value should be non-zero in the range [0.5, 20] seconds, specified in ISO 8601 format. The default is 2 seconds(PT2S). Note that this setting is ignored if VideoSyncMode.Passthrough is set, where the KeyFrameInterval value will follow the input source setting." + }, + "stretchMode": { + "type": "string", + "enum": [ + "None", + "AutoSize", + "AutoFit" + ], + "x-ms-enum": { + "name": "StretchMode", + "values": [ + { + "value": "None", + "description": "Strictly respect the output resolution without considering the pixel aspect ratio or display aspect ratio of the input video." + }, + { + "value": "AutoSize", + "description": "Override the output resolution, and change it to match the display aspect ratio of the input, without padding. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the value in the preset is overridden, and the output will be at 1280x720, which maintains the input aspect ratio of 16:9." + }, + { + "value": "AutoFit", + "description": "Pad the output (with either letterbox or pillar box) to honor the output resolution, while ensuring that the active video region in the output has the same aspect ratio as the input. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the output will be at 1280x1280, which contains an inner rectangle of 1280x720 at aspect ratio of 16:9, and pillar box regions 280 pixels wide at the left and right." + } + ], + "modelAsString": true + }, + "description": "The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize" + }, + "syncMode": { + "type": "string", + "enum": [ + "Auto", + "Passthrough", + "Cfr", + "Vfr" + ], + "x-ms-enum": { + "name": "VideoSyncMode", + "values": [ + { + "value": "Auto", + "description": "This is the default method. Chooses between Cfr and Vfr depending on muxer capabilities. For output format MP4, the default mode is Cfr." + }, + { + "value": "Passthrough", + "description": "The presentation timestamps on frames are passed through from the input file to the output file writer. Recommended when the input source has variable frame rate, and are attempting to produce multiple layers for adaptive streaming in the output which have aligned GOP boundaries. Note: if two or more frames in the input have duplicate timestamps, then the output will also have the same behavior" + }, + { + "value": "Cfr", + "description": "Input frames will be repeated and/or dropped as needed to achieve exactly the requested constant frame rate. Recommended when the output frame rate is explicitly set at a specified value" + }, + { + "value": "Vfr", + "description": "Similar to the Passthrough mode, but if the input has frames that have duplicate timestamps, then only one frame is passed through to the output, and others are dropped. Recommended when the number of output frames is expected to be equal to the number of input frames. For example, the output is used to calculate a quality metric like PSNR against the input" + } + ], + "modelAsString": true + }, + "description": "The Video Sync Mode" + } + }, + "type": "object", + "description": "Describes the basic properties for encoding the input video." + }, + "H265Video": { + "x-ms-discriminator-value": "#Microsoft.Media.H265Video", + "allOf": [ + { + "$ref": "#/definitions/Video" + } + ], + "properties": { + "sceneChangeDetection": { + "type": "boolean", + "description": "Specifies whether or not the encoder should insert key frames at scene changes. If not specified, the default is false. This flag should be set to true only when the encoder is being configured to produce a single output video." + }, + "complexity": { + "type": "string", + "enum": [ + "Speed", + "Balanced", + "Quality" + ], + "x-ms-enum": { + "name": "H265Complexity", + "values": [ + { + "value": "Speed", + "description": "Tells the encoder to use settings that are optimized for faster encoding. Quality is sacrificed to decrease encoding time." + }, + { + "value": "Balanced", + "description": "Tells the encoder to use settings that achieve a balance between speed and quality." + }, + { + "value": "Quality", + "description": "Tells the encoder to use settings that are optimized to produce higher quality output at the expense of slower overall encode time." + } + ], + "modelAsString": true + }, + "description": "Tells the encoder how to choose its encoding settings. Quality will provide for a higher compression ratio but at a higher cost and longer compute time. Speed will produce a relatively larger file but is faster and more economical. The default value is Balanced." + }, + "layers": { + "type": "array", + "items": { + "$ref": "#/definitions/H265Layer" + }, + "description": "The collection of output H.265 layers to be produced by the encoder." + } + }, + "type": "object", + "description": "Describes all the properties for encoding a video with the H.265 codec." + }, + "TrackDescriptor": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base type for all TrackDescriptor types, which define the metadata and selection for tracks that should be processed by a Job" + }, + "AudioTrackDescriptor": { + "x-ms-discriminator-value": "#Microsoft.Media.AudioTrackDescriptor", + "allOf": [ + { + "$ref": "#/definitions/TrackDescriptor" + } + ], + "properties": { + "channelMapping": { + "type": "string", + "enum": [ + "FrontLeft", + "FrontRight", + "Center", + "LowFrequencyEffects", + "BackLeft", + "BackRight", + "StereoLeft", + "StereoRight" + ], + "x-ms-enum": { + "name": "ChannelMapping", + "values": [ + { + "value": "FrontLeft", + "description": "The Front Left Channel." + }, + { + "value": "FrontRight", + "description": "The Front Right Channel." + }, + { + "value": "Center", + "description": "The Center Channel." + }, + { + "value": "LowFrequencyEffects", + "description": "Low Frequency Effects Channel. Sometimes referred to as the Subwoofer." + }, + { + "value": "BackLeft", + "description": "The Back Left Channel. Sometimes referred to as the Left Surround Channel." + }, + { + "value": "BackRight", + "description": "The Back Right Channel. Sometimes referred to as the Right Surround Channel." + }, + { + "value": "StereoLeft", + "description": "The Left Stereo channel. Sometimes referred to as Down Mix Left." + }, + { + "value": "StereoRight", + "description": "The Right Stereo channel. Sometimes referred to as Down Mix Right." + } + ], + "modelAsString": true + }, + "description": "Optional designation for single channel audio tracks. Can be used to combine the tracks into stereo or multi-channel audio tracks." + } + }, + "type": "object", + "description": "A TrackSelection to select audio tracks." + }, + "SelectAudioTrackByAttribute": { + "x-ms-discriminator-value": "#Microsoft.Media.SelectAudioTrackByAttribute", + "allOf": [ + { + "$ref": "#/definitions/AudioTrackDescriptor" + } + ], + "properties": { + "attribute": { + "type": "string", + "enum": [ + "Bitrate", + "Language" + ], + "x-ms-enum": { + "name": "TrackAttribute", + "values": [ + { + "value": "Bitrate", + "description": "The bitrate of the track." + }, + { + "value": "Language", + "description": "The language of the track." + } + ], + "modelAsString": true + }, + "description": "The TrackAttribute to filter the tracks by." + }, + "filter": { + "type": "string", + "enum": [ + "All", + "Top", + "Bottom", + "ValueEquals" + ], + "x-ms-enum": { + "name": "AttributeFilter", + "values": [ + { + "value": "All", + "description": "All tracks will be included." + }, + { + "value": "Top", + "description": "The first track will be included when the attribute is sorted in descending order. Generally used to select the largest bitrate." + }, + { + "value": "Bottom", + "description": "The first track will be included when the attribute is sorted in ascending order. Generally used to select the smallest bitrate." + }, + { + "value": "ValueEquals", + "description": "Any tracks that have an attribute equal to the value given will be included." + } + ], + "modelAsString": true + }, + "description": "The type of AttributeFilter to apply to the TrackAttribute in order to select the tracks." + }, + "filterValue": { + "type": "string", + "description": "The value to filter the tracks by. Only used when AttributeFilter.ValueEquals is specified for the Filter property." + } + }, + "type": "object", + "required": [ + "attribute", + "filter" + ], + "description": "Select audio tracks from the input by specifying an attribute and an attribute filter." + }, + "SelectAudioTrackById": { + "x-ms-discriminator-value": "#Microsoft.Media.SelectAudioTrackById", + "allOf": [ + { + "$ref": "#/definitions/AudioTrackDescriptor" + } + ], + "properties": { + "trackId": { + "type": "integer", + "format": "int64", + "description": "Track identifier to select" + } + }, + "type": "object", + "required": [ + "trackId" + ], + "description": "Select audio tracks from the input by specifying a track identifier." + }, + "InputDefinition": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + }, + "includedTracks": { + "type": "array", + "items": { + "$ref": "#/definitions/TrackDescriptor" + }, + "description": "The list of TrackDescriptors which define the metadata and selection of tracks in the input." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base class for defining an input. Use sub classes of this class to specify tracks selections and related metadata." + }, + "FromAllInputFile": { + "x-ms-discriminator-value": "#Microsoft.Media.FromAllInputFile", + "allOf": [ + { + "$ref": "#/definitions/InputDefinition" + } + ], + "properties": {}, + "type": "object", + "description": "An InputDefinition that looks across all of the files provided to select tracks specified by the IncludedTracks property. Generally used with the AudioTrackByAttribute and VideoTrackByAttribute to allow selection of a single track across a set of input files." + }, + "FromEachInputFile": { + "x-ms-discriminator-value": "#Microsoft.Media.FromEachInputFile", + "allOf": [ + { + "$ref": "#/definitions/InputDefinition" + } + ], + "properties": {}, + "type": "object", + "description": "An InputDefinition that looks at each input file provided to select tracks specified by the IncludedTracks property. Generally used with the AudioTrackByAttribute and VideoTrackByAttribute to select tracks from each file given." + }, + "InputFile": { + "x-ms-discriminator-value": "#Microsoft.Media.InputFile", + "allOf": [ + { + "$ref": "#/definitions/InputDefinition" + } + ], + "properties": { + "filename": { + "type": "string", + "description": "Name of the file that this input definition applies to." + } + }, + "type": "object", + "description": "An InputDefinition for a single file. TrackSelections are scoped to the file specified." + }, + "FaceDetectorPreset": { + "x-ms-discriminator-value": "#Microsoft.Media.FaceDetectorPreset", + "allOf": [ + { + "$ref": "#/definitions/Preset" + } + ], + "properties": { + "resolution": { + "type": "string", + "enum": [ + "SourceResolution", + "StandardDefinition" + ], + "x-ms-enum": { + "name": "AnalysisResolution", + "values": [ + { + "value": "SourceResolution" + }, + { + "value": "StandardDefinition" + } + ], + "modelAsString": true + }, + "description": "Specifies the maximum resolution at which your video is analyzed. The default behavior is \"SourceResolution,\" which will keep the input video at its original resolution when analyzed. Using \"StandardDefinition\" will resize input videos to standard definition while preserving the appropriate aspect ratio. It will only resize if the video is of higher resolution. For example, a 1920x1080 input would be scaled to 640x360 before processing. Switching to \"StandardDefinition\" will reduce the time it takes to process high resolution video. It may also reduce the cost of using this component (see https://azure.microsoft.com/en-us/pricing/details/media-services/#analytics for details). However, faces that end up being too small in the resized video may not be detected." + }, + "mode": { + "type": "string", + "enum": [ + "Analyze", + "Redact", + "Combined" + ], + "x-ms-enum": { + "name": "FaceRedactorMode", + "values": [ + { + "value": "Analyze", + "description": "Analyze mode detects faces and outputs a metadata file with the results. Allows editing of the metadata file before faces are blurred with Redact mode." + }, + { + "value": "Redact", + "description": "Redact mode consumes the metadata file from Analyze mode and redacts the faces found." + }, + { + "value": "Combined", + "description": "Combined mode does the Analyze and Redact steps in one pass when editing the analyzed faces is not desired." + } + ], + "modelAsString": true + }, + "description": "This mode provides the ability to choose between the following settings: 1) Analyze - For detection only.This mode generates a metadata JSON file marking appearances of faces throughout the video.Where possible, appearances of the same person are assigned the same ID. 2) Combined - Additionally redacts(blurs) detected faces. 3) Redact - This enables a 2-pass process, allowing for selective redaction of a subset of detected faces.It takes in the metadata file from a prior analyze pass, along with the source video, and a user-selected subset of IDs that require redaction." + }, + "blurType": { + "type": "string", + "enum": [ + "Box", + "Low", + "Med", + "High", + "Black" + ], + "x-ms-enum": { + "name": "BlurType", + "values": [ + { + "value": "Box", + "description": "Box: debug filter, bounding box only" + }, + { + "value": "Low", + "description": "Low: box-car blur filter" + }, + { + "value": "Med", + "description": "Med: Gaussian blur filter" + }, + { + "value": "High", + "description": "High: Confuse blur filter" + }, + { + "value": "Black", + "description": "Black: Black out filter" + } + ], + "modelAsString": true + }, + "description": "Blur type" + }, + "experimentalOptions": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Dictionary containing key value pairs for parameters not exposed in the preset itself" + } + }, + "type": "object", + "description": "Describes all the settings to be used when analyzing a video in order to detect (and optionally redact) all the faces present." + }, + "AudioAnalyzerPreset": { + "x-ms-discriminator-value": "#Microsoft.Media.AudioAnalyzerPreset", + "allOf": [ + { + "$ref": "#/definitions/Preset" + } + ], + "properties": { + "audioLanguage": { + "type": "string", + "description": "The language for the audio payload in the input using the BCP-47 format of 'language tag-region' (e.g: 'en-US'). If you know the language of your content, it is recommended that you specify it. The language must be specified explicitly for AudioAnalysisMode::Basic, since automatic language detection is not included in basic mode. If the language isn't specified or set to null, automatic language detection will choose the first language detected and process with the selected language for the duration of the file. It does not currently support dynamically switching between languages after the first language is detected. The automatic detection works best with audio recordings with clearly discernable speech. If automatic detection fails to find the language, transcription would fallback to 'en-US'.\" The list of supported languages is available here: https://go.microsoft.com/fwlink/?linkid=2109463" + }, + "mode": { + "type": "string", + "enum": [ + "Standard", + "Basic" + ], + "x-ms-enum": { + "name": "AudioAnalysisMode", + "values": [ + { + "value": "Standard", + "description": "Performs all operations included in the Basic mode, additionally performing language detection and speaker diarization." + }, + { + "value": "Basic", + "description": "This mode performs speech-to-text transcription and generation of a VTT subtitle/caption file. The output of this mode includes an Insights JSON file including only the keywords, transcription,and timing information. Automatic language detection and speaker diarization are not included in this mode." + } + ], + "modelAsString": true + }, + "description": "Determines the set of audio analysis operations to be performed. If unspecified, the Standard AudioAnalysisMode would be chosen." + }, + "experimentalOptions": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Dictionary containing key value pairs for parameters not exposed in the preset itself" + } + }, + "type": "object", + "description": "The Audio Analyzer preset applies a pre-defined set of AI-based analysis operations, including speech transcription. Currently, the preset supports processing of content with a single audio track." + }, + "Overlay": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + }, + "inputLabel": { + "type": "string", + "description": "The label of the job input which is to be used as an overlay. The Input must specify exactly one file. You can specify an image file in JPG, PNG, GIF or BMP format, or an audio file (such as a WAV, MP3, WMA or M4A file), or a video file. See https://aka.ms/mesformats for the complete list of supported audio and video file formats." + }, + "start": { + "type": "string", + "format": "duration", + "description": "The start position, with reference to the input video, at which the overlay starts. The value should be in ISO 8601 format. For example, PT05S to start the overlay at 5 seconds into the input video. If not specified the overlay starts from the beginning of the input video." + }, + "end": { + "type": "string", + "format": "duration", + "description": "The end position, with reference to the input video, at which the overlay ends. The value should be in ISO 8601 format. For example, PT30S to end the overlay at 30 seconds into the input video. If not specified or the value is greater than the input video duration, the overlay will be applied until the end of the input video if the overlay media duration is greater than the input video duration, else the overlay will last as long as the overlay media duration." + }, + "fadeInDuration": { + "type": "string", + "format": "duration", + "description": "The duration over which the overlay fades in onto the input video. The value should be in ISO 8601 duration format. If not specified the default behavior is to have no fade in (same as PT0S)." + }, + "fadeOutDuration": { + "type": "string", + "format": "duration", + "description": "The duration over which the overlay fades out of the input video. The value should be in ISO 8601 duration format. If not specified the default behavior is to have no fade out (same as PT0S)." + }, + "audioGainLevel": { + "type": "number", + "format": "double", + "description": "The gain level of audio in the overlay. The value should be in the range [0, 1.0]. The default is 1.0." + } + }, + "type": "object", + "required": [ + "@odata.type", + "inputLabel" + ], + "description": "Base type for all overlays - image, audio or video." + }, + "AudioOverlay": { + "x-ms-discriminator-value": "#Microsoft.Media.AudioOverlay", + "allOf": [ + { + "$ref": "#/definitions/Overlay" + } + ], + "properties": {}, + "type": "object", + "description": "Describes the properties of an audio overlay." + }, + "CopyVideo": { + "x-ms-discriminator-value": "#Microsoft.Media.CopyVideo", + "allOf": [ + { + "$ref": "#/definitions/Codec" + } + ], + "properties": {}, + "type": "object", + "description": "A codec flag, which tells the encoder to copy the input video bitstream without re-encoding." + }, + "Image": { + "x-ms-discriminator-value": "#Microsoft.Media.Image", + "allOf": [ + { + "$ref": "#/definitions/Video" + } + ], + "properties": { + "start": { + "type": "string", + "description": "The position in the input video from where to start generating thumbnails. The value can be in ISO 8601 format (For example, PT05S to start at 5 seconds), or a frame count (For example, 10 to start at the 10th frame), or a relative value to stream duration (For example, 10% to start at 10% of stream duration). Also supports a macro {Best}, which tells the encoder to select the best thumbnail from the first few seconds of the video and will only produce one thumbnail, no matter what other settings are for Step and Range. The default value is macro {Best}." + }, + "step": { + "type": "string", + "description": "The intervals at which thumbnails are generated. The value can be in ISO 8601 format (For example, PT05S for one image every 5 seconds), or a frame count (For example, 30 for one image every 30 frames), or a relative value to stream duration (For example, 10% for one image every 10% of stream duration). Note: Step value will affect the first generated thumbnail, which may not be exactly the one specified at transform preset start time. This is due to the encoder, which tries to select the best thumbnail between start time and Step position from start time as the first output. As the default value is 10%, it means if stream has long duration, the first generated thumbnail might be far away from the one specified at start time. Try to select reasonable value for Step if the first thumbnail is expected close to start time, or set Range value at 1 if only one thumbnail is needed at start time." + }, + "range": { + "type": "string", + "description": "The position relative to transform preset start time in the input video at which to stop generating thumbnails. The value can be in ISO 8601 format (For example, PT5M30S to stop at 5 minutes and 30 seconds from start time), or a frame count (For example, 300 to stop at the 300th frame from the frame at start time. If this value is 1, it means only producing one thumbnail at start time), or a relative value to the stream duration (For example, 50% to stop at half of stream duration from start time). The default value is 100%, which means to stop at the end of the stream." + } + }, + "type": "object", + "required": [ + "start" + ], + "description": "Describes the basic properties for generating thumbnails from the input video" + }, + "Format": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + }, + "filenamePattern": { + "type": "string", + "description": "The pattern of the file names for the generated output files. The following macros are supported in the file name: {Basename} - An expansion macro that will use the name of the input video file. If the base name(the file suffix is not included) of the input video file is less than 32 characters long, the base name of input video files will be used. If the length of base name of the input video file exceeds 32 characters, the base name is truncated to the first 32 characters in total length. {Extension} - The appropriate extension for this format. {Label} - The label assigned to the codec/layer. {Index} - A unique index for thumbnails. Only applicable to thumbnails. {Bitrate} - The audio/video bitrate. Not applicable to thumbnails. {Codec} - The type of the audio/video codec. {Resolution} - The video resolution. Any unsubstituted macros will be collapsed and removed from the filename." + } + }, + "type": "object", + "required": [ + "@odata.type", + "filenamePattern" + ], + "description": "Base class for output." + }, + "ImageFormat": { + "x-ms-discriminator-value": "#Microsoft.Media.ImageFormat", + "allOf": [ + { + "$ref": "#/definitions/Format" + } + ], + "properties": {}, + "type": "object", + "description": "Describes the properties for an output image file." + }, + "JpgFormat": { + "x-ms-discriminator-value": "#Microsoft.Media.JpgFormat", + "allOf": [ + { + "$ref": "#/definitions/ImageFormat" + } + ], + "properties": {}, + "type": "object", + "description": "Describes the settings for producing JPEG thumbnails." + }, + "PngFormat": { + "x-ms-discriminator-value": "#Microsoft.Media.PngFormat", + "allOf": [ + { + "$ref": "#/definitions/ImageFormat" + } + ], + "properties": {}, + "type": "object", + "description": "Describes the settings for producing PNG thumbnails." + }, + "CopyAudio": { + "x-ms-discriminator-value": "#Microsoft.Media.CopyAudio", + "allOf": [ + { + "$ref": "#/definitions/Codec" + } + ], + "properties": {}, + "type": "object", + "description": "A codec flag, which tells the encoder to copy the input audio bitstream." + }, + "Deinterlace": { + "properties": { + "parity": { + "type": "string", + "enum": [ + "Auto", + "TopFieldFirst", + "BottomFieldFirst" + ], + "x-ms-enum": { + "name": "DeinterlaceParity", + "values": [ + { + "value": "Auto", + "description": "Automatically detect the order of fields" + }, + { + "value": "TopFieldFirst", + "description": "Apply top field first processing of input video." + }, + { + "value": "BottomFieldFirst", + "description": "Apply bottom field first processing of input video." + } + ], + "modelAsString": true + }, + "description": "The field parity for de-interlacing, defaults to Auto." + }, + "mode": { + "type": "string", + "enum": [ + "Off", + "AutoPixelAdaptive" + ], + "x-ms-enum": { + "name": "DeinterlaceMode", + "values": [ + { + "value": "Off", + "description": "Disables de-interlacing of the source video." + }, + { + "value": "AutoPixelAdaptive", + "description": "Apply automatic pixel adaptive de-interlacing on each frame in the input video." + } + ], + "modelAsString": true + }, + "description": "The deinterlacing mode. Defaults to AutoPixelAdaptive." + } + }, + "type": "object", + "description": "Describes the de-interlacing settings." + }, + "Rectangle": { + "properties": { + "left": { + "type": "string", + "description": "The number of pixels from the left-margin. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%)." + }, + "top": { + "type": "string", + "description": "The number of pixels from the top-margin. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%)." + }, + "width": { + "type": "string", + "description": "The width of the rectangular region in pixels. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%)." + }, + "height": { + "type": "string", + "description": "The height of the rectangular region in pixels. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%)." + } + }, + "type": "object", + "description": "Describes the properties of a rectangular window applied to the input media before processing it." + }, + "Filters": { + "properties": { + "deinterlace": { + "$ref": "#/definitions/Deinterlace", + "description": "The de-interlacing settings." + }, + "rotation": { + "type": "string", + "enum": [ + "Auto", + "None", + "Rotate0", + "Rotate90", + "Rotate180", + "Rotate270" + ], + "x-ms-enum": { + "name": "Rotation", + "values": [ + { + "value": "Auto", + "description": "Automatically detect and rotate as needed." + }, + { + "value": "None", + "description": "Do not rotate the video. If the output format supports it, any metadata about rotation is kept intact." + }, + { + "value": "Rotate0", + "description": "Do not rotate the video but remove any metadata about the rotation." + }, + { + "value": "Rotate90", + "description": "Rotate 90 degrees clockwise." + }, + { + "value": "Rotate180", + "description": "Rotate 180 degrees clockwise." + }, + { + "value": "Rotate270", + "description": "Rotate 270 degrees clockwise." + } + ], + "modelAsString": true + }, + "description": "The rotation, if any, to be applied to the input video, before it is encoded. Default is Auto" + }, + "crop": { + "$ref": "#/definitions/Rectangle", + "description": "The parameters for the rectangular window with which to crop the input video." + }, + "overlays": { + "type": "array", + "items": { + "$ref": "#/definitions/Overlay" + }, + "description": "The properties of overlays to be applied to the input video. These could be audio, image or video overlays." + } + }, + "type": "object", + "description": "Describes all the filtering operations, such as de-interlacing, rotation etc. that are to be applied to the input media before encoding." + }, + "VideoLayer": { + "x-ms-discriminator-value": "#Microsoft.Media.VideoLayer", + "allOf": [ + { + "$ref": "#/definitions/Layer" + } + ], + "properties": { + "bitrate": { + "type": "integer", + "format": "int32", + "description": "The average bitrate in bits per second at which to encode the input video when generating this layer. This is a required field." + }, + "maxBitrate": { + "type": "integer", + "format": "int32", + "description": "The maximum bitrate (in bits per second), at which the VBV buffer should be assumed to refill. If not specified, defaults to the same value as bitrate." + }, + "bFrames": { + "type": "integer", + "format": "int32", + "description": "The number of B-frames to be used when encoding this layer. If not specified, the encoder chooses an appropriate number based on the video profile and level." + }, + "frameRate": { + "type": "string", + "description": "The frame rate (in frames per second) at which to encode this layer. The value can be in the form of M/N where M and N are integers (For example, 30000/1001), or in the form of a number (For example, 30, or 29.97). The encoder enforces constraints on allowed frame rates based on the profile and level. If it is not specified, the encoder will use the same frame rate as the input video." + }, + "slices": { + "type": "integer", + "format": "int32", + "description": "The number of slices to be used when encoding this layer. If not specified, default is zero, which means that encoder will use a single slice for each frame." + }, + "adaptiveBFrame": { + "type": "boolean", + "description": "Whether or not adaptive B-frames are to be used when encoding this layer. If not specified, the encoder will turn it on whenever the video profile permits its use." + } + }, + "type": "object", + "required": [ + "bitrate" + ], + "description": "Describes the settings to be used when encoding the input video into a desired output bitrate layer." + }, + "H264Layer": { + "x-ms-discriminator-value": "#Microsoft.Media.H264Layer", + "allOf": [ + { + "$ref": "#/definitions/VideoLayer" + } + ], + "properties": { + "profile": { + "type": "string", + "enum": [ + "Auto", + "Baseline", + "Main", + "High", + "High422", + "High444" + ], + "x-ms-enum": { + "name": "H264VideoProfile", + "values": [ + { + "value": "Auto", + "description": "Tells the encoder to automatically determine the appropriate H.264 profile." + }, + { + "value": "Baseline", + "description": "Baseline profile" + }, + { + "value": "Main", + "description": "Main profile" + }, + { + "value": "High", + "description": "High profile." + }, + { + "value": "High422", + "description": "High 4:2:2 profile." + }, + { + "value": "High444", + "description": "High 4:4:4 predictive profile." + } + ], + "modelAsString": true + }, + "description": "We currently support Baseline, Main, High, High422, High444. Default is Auto." + }, + "level": { + "type": "string", + "description": "We currently support Level up to 6.2. The value can be Auto, or a number that matches the H.264 profile. If not specified, the default is Auto, which lets the encoder choose the Level that is appropriate for this layer." + }, + "bufferWindow": { + "type": "string", + "format": "duration", + "description": "The VBV buffer window length. The value should be in ISO 8601 format. The value should be in the range [0.1-100] seconds. The default is 5 seconds (for example, PT5S)." + }, + "referenceFrames": { + "type": "integer", + "format": "int32", + "description": "The number of reference frames to be used when encoding this layer. If not specified, the encoder determines an appropriate number based on the encoder complexity setting." + }, + "entropyMode": { + "type": "string", + "enum": [ + "Cabac", + "Cavlc" + ], + "x-ms-enum": { + "name": "EntropyMode", + "values": [ + { + "value": "Cabac", + "description": "Context Adaptive Binary Arithmetic Coder (CABAC) entropy encoding." + }, + { + "value": "Cavlc", + "description": "Context Adaptive Variable Length Coder (CAVLC) entropy encoding." + } + ], + "modelAsString": true + }, + "description": "The entropy mode to be used for this layer. If not specified, the encoder chooses the mode that is appropriate for the profile and level." + } + }, + "type": "object", + "description": "Describes the settings to be used when encoding the input video into a desired output bitrate layer with the H.264 video codec." + }, + "H264Video": { + "x-ms-discriminator-value": "#Microsoft.Media.H264Video", + "allOf": [ + { + "$ref": "#/definitions/Video" + } + ], + "properties": { + "sceneChangeDetection": { + "type": "boolean", + "description": "Whether or not the encoder should insert key frames at scene changes. If not specified, the default is false. This flag should be set to true only when the encoder is being configured to produce a single output video." + }, + "complexity": { + "type": "string", + "enum": [ + "Speed", + "Balanced", + "Quality" + ], + "x-ms-enum": { + "name": "H264Complexity", + "values": [ + { + "value": "Speed", + "description": "Tells the encoder to use settings that are optimized for faster encoding. Quality is sacrificed to decrease encoding time." + }, + { + "value": "Balanced", + "description": "Tells the encoder to use settings that achieve a balance between speed and quality." + }, + { + "value": "Quality", + "description": "Tells the encoder to use settings that are optimized to produce higher quality output at the expense of slower overall encode time." + } + ], + "modelAsString": true + }, + "description": "Tells the encoder how to choose its encoding settings. The default value is Balanced." + }, + "layers": { + "type": "array", + "items": { + "$ref": "#/definitions/H264Layer" + }, + "description": "The collection of output H.264 layers to be produced by the encoder." + } + }, + "type": "object", + "description": "Describes all the properties for encoding a video with the H.264 codec." + }, + "JpgImage": { + "x-ms-discriminator-value": "#Microsoft.Media.JpgImage", + "allOf": [ + { + "$ref": "#/definitions/Image" + } + ], + "properties": { + "layers": { + "type": "array", + "items": { + "$ref": "#/definitions/JpgLayer" + }, + "description": "A collection of output JPEG image layers to be produced by the encoder." + }, + "spriteColumn": { + "type": "integer", + "format": "int32", + "description": "Sets the number of columns used in thumbnail sprite image. The number of rows are automatically calculated and a VTT file is generated with the coordinate mappings for each thumbnail in the sprite. Note: this value should be a positive integer and a proper value is recommended so that the output image resolution will not go beyond JPEG maximum pixel resolution limit 65535x65535." + } + }, + "type": "object", + "description": "Describes the properties for producing a series of JPEG images from the input video." + }, + "JpgLayer": { + "x-ms-discriminator-value": "#Microsoft.Media.JpgLayer", + "allOf": [ + { + "$ref": "#/definitions/Layer" + } + ], + "properties": { + "quality": { + "type": "integer", + "format": "int32", + "description": "The compression quality of the JPEG output. Range is from 0-100 and the default is 70." + } + }, + "type": "object", + "description": "Describes the settings to produce a JPEG image from the input video." + }, + "MultiBitrateFormat": { + "x-ms-discriminator-value": "#Microsoft.Media.MultiBitrateFormat", + "allOf": [ + { + "$ref": "#/definitions/Format" + } + ], + "properties": { + "outputFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/OutputFile" + }, + "description": "The list of output files to produce. Each entry in the list is a set of audio and video layer labels to be muxed together ." + } + }, + "type": "object", + "description": "Describes the properties for producing a collection of GOP aligned multi-bitrate files. The default behavior is to produce one output file for each video layer which is muxed together with all the audios. The exact output files produced can be controlled by specifying the outputFiles collection." + }, + "OutputFile": { + "properties": { + "labels": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of labels that describe how the encoder should multiplex video and audio into an output file. For example, if the encoder is producing two video layers with labels v1 and v2, and one audio layer with label a1, then an array like '[v1, a1]' tells the encoder to produce an output file with the video track represented by v1 and the audio track represented by a1." + } + }, + "type": "object", + "required": [ + "labels" + ], + "description": "Represents an output file produced." + }, + "Mp4Format": { + "x-ms-discriminator-value": "#Microsoft.Media.Mp4Format", + "allOf": [ + { + "$ref": "#/definitions/MultiBitrateFormat" + } + ], + "properties": {}, + "type": "object", + "description": "Describes the properties for an output ISO MP4 file." + }, + "PngImage": { + "x-ms-discriminator-value": "#Microsoft.Media.PngImage", + "allOf": [ + { + "$ref": "#/definitions/Image" + } + ], + "properties": { + "layers": { + "type": "array", + "items": { + "$ref": "#/definitions/PngLayer" + }, + "description": "A collection of output PNG image layers to be produced by the encoder." + } + }, + "type": "object", + "description": "Describes the properties for producing a series of PNG images from the input video." + }, + "PngLayer": { + "x-ms-discriminator-value": "#Microsoft.Media.PngLayer", + "allOf": [ + { + "$ref": "#/definitions/Layer" + } + ], + "properties": {}, + "type": "object", + "description": "Describes the settings to produce a PNG image from the input video." + }, + "BuiltInStandardEncoderPreset": { + "x-ms-discriminator-value": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "allOf": [ + { + "$ref": "#/definitions/Preset" + } + ], + "properties": { + "configurations": { + "$ref": "#/definitions/PresetConfigurations", + "description": "PresetConfigurations are only supported for the ContentAwareEncoding and H265ContentAwareEncoding built-in presets. These settings will not affect other built-in or custom defined presets." + }, + "presetName": { + "type": "string", + "enum": [ + "H264SingleBitrateSD", + "H264SingleBitrate720p", + "H264SingleBitrate1080p", + "AdaptiveStreaming", + "AACGoodQualityAudio", + "ContentAwareEncodingExperimental", + "ContentAwareEncoding", + "CopyAllBitrateNonInterleaved", + "H264MultipleBitrate1080p", + "H264MultipleBitrate720p", + "H264MultipleBitrateSD", + "H265ContentAwareEncoding", + "H265AdaptiveStreaming", + "H265SingleBitrate720p", + "H265SingleBitrate1080p", + "H265SingleBitrate4K" + ], + "x-ms-enum": { + "name": "EncoderNamedPreset", + "values": [ + { + "value": "H264SingleBitrateSD", + "description": "Produces an MP4 file where the video is encoded with H.264 codec at 2200 kbps and a picture height of 480 pixels, and the stereo audio is encoded with AAC-LC codec at 128 kbps." + }, + { + "value": "H264SingleBitrate720p", + "description": "Produces an MP4 file where the video is encoded with H.264 codec at 4500 kbps and a picture height of 720 pixels, and the stereo audio is encoded with AAC-LC codec at 128 kbps." + }, + { + "value": "H264SingleBitrate1080p", + "description": "Produces an MP4 file where the video is encoded with H.264 codec at 6750 kbps and a picture height of 1080 pixels, and the stereo audio is encoded with AAC-LC codec at 128 kbps." + }, + { + "value": "AdaptiveStreaming", + "description": "Produces a set of GOP aligned MP4 files with H.264 video and stereo AAC audio. Auto-generates a bitrate ladder based on the input resolution, bitrate and frame rate. The auto-generated preset will never exceed the input resolution. For example, if the input is 720p, output will remain 720p at best." + }, + { + "value": "AACGoodQualityAudio", + "description": "Produces a single MP4 file containing only stereo audio encoded at 192 kbps." + }, + { + "value": "ContentAwareEncodingExperimental", + "description": "Exposes an experimental preset for content-aware encoding. Given any input content, the service attempts to automatically determine the optimal number of layers, appropriate bitrate and resolution settings for delivery by adaptive streaming. The underlying algorithms will continue to evolve over time. The output will contain MP4 files with video and audio interleaved." + }, + { + "value": "ContentAwareEncoding", + "description": "Produces a set of GOP-aligned MP4s by using content-aware encoding. Given any input content, the service performs an initial lightweight analysis of the input content, and uses the results to determine the optimal number of layers, appropriate bitrate and resolution settings for delivery by adaptive streaming. This preset is particularly effective for low and medium complexity videos, where the output files will be at lower bitrates but at a quality that still delivers a good experience to viewers. The output will contain MP4 files with video and audio interleaved." + }, + { + "value": "CopyAllBitrateNonInterleaved", + "description": "Copy all video and audio streams from the input asset as non-interleaved video and audio output files. This preset can be used to clip an existing asset or convert a group of key frame (GOP) aligned MP4 files as an asset that can be streamed." + }, + { + "value": "H264MultipleBitrate1080p", + "description": "Produces a set of 8 GOP-aligned MP4 files, ranging from 6000 kbps to 400 kbps, and stereo AAC audio. Resolution starts at 1080p and goes down to 180p." + }, + { + "value": "H264MultipleBitrate720p", + "description": "Produces a set of 6 GOP-aligned MP4 files, ranging from 3400 kbps to 400 kbps, and stereo AAC audio. Resolution starts at 720p and goes down to 180p." + }, + { + "value": "H264MultipleBitrateSD", + "description": "Produces a set of 5 GOP-aligned MP4 files, ranging from 1900kbps to 400 kbps, and stereo AAC audio. Resolution starts at 480p and goes down to 240p." + }, + { + "value": "H265ContentAwareEncoding", + "description": "Produces a set of GOP-aligned MP4s by using content-aware encoding. Given any input content, the service performs an initial lightweight analysis of the input content, and uses the results to determine the optimal number of layers, appropriate bitrate and resolution settings for delivery by adaptive streaming. This preset is particularly effective for low and medium complexity videos, where the output files will be at lower bitrates but at a quality that still delivers a good experience to viewers. The output will contain MP4 files with video and audio interleaved." + }, + { + "value": "H265AdaptiveStreaming", + "description": "Produces a set of GOP aligned MP4 files with H.265 video and stereo AAC audio. Auto-generates a bitrate ladder based on the input resolution, bitrate and frame rate. The auto-generated preset will never exceed the input resolution. For example, if the input is 720p, output will remain 720p at best." + }, + { + "value": "H265SingleBitrate720p", + "description": "Produces an MP4 file where the video is encoded with H.265 codec at 1800 kbps and a picture height of 720 pixels, and the stereo audio is encoded with AAC-LC codec at 128 kbps." + }, + { + "value": "H265SingleBitrate1080p", + "description": "Produces an MP4 file where the video is encoded with H.265 codec at 3500 kbps and a picture height of 1080 pixels, and the stereo audio is encoded with AAC-LC codec at 128 kbps." + }, + { + "value": "H265SingleBitrate4K", + "description": "Produces an MP4 file where the video is encoded with H.265 codec at 9500 kbps and a picture height of 2160 pixels, and the stereo audio is encoded with AAC-LC codec at 128 kbps." + } + ], + "modelAsString": true + }, + "description": "The built-in preset to be used for encoding videos." + } + }, + "type": "object", + "required": [ + "presetName" + ], + "description": "Describes a built-in preset for encoding the input video with the Standard Encoder." + }, + "StandardEncoderPreset": { + "x-ms-discriminator-value": "#Microsoft.Media.StandardEncoderPreset", + "allOf": [ + { + "$ref": "#/definitions/Preset" + } + ], + "properties": { + "filters": { + "$ref": "#/definitions/Filters", + "description": "One or more filtering operations that are applied to the input media before encoding." + }, + "codecs": { + "type": "array", + "items": { + "$ref": "#/definitions/Codec" + }, + "description": "The list of codecs to be used when encoding the input video." + }, + "formats": { + "type": "array", + "items": { + "$ref": "#/definitions/Format" + }, + "description": "The list of outputs to be produced by the encoder." + } + }, + "type": "object", + "required": [ + "codecs", + "formats" + ], + "description": "Describes all the settings to be used when encoding the input video with the Standard Encoder." + }, + "VideoAnalyzerPreset": { + "x-ms-discriminator-value": "#Microsoft.Media.VideoAnalyzerPreset", + "allOf": [ + { + "$ref": "#/definitions/AudioAnalyzerPreset" + } + ], + "properties": { + "insightsToExtract": { + "type": "string", + "enum": [ + "AudioInsightsOnly", + "VideoInsightsOnly", + "AllInsights" + ], + "x-ms-enum": { + "name": "InsightsType", + "values": [ + { + "value": "AudioInsightsOnly", + "description": "Generate audio only insights. Ignore video even if present. Fails if no audio is present." + }, + { + "value": "VideoInsightsOnly", + "description": "Generate video only insights. Ignore audio if present. Fails if no video is present." + }, + { + "value": "AllInsights", + "description": "Generate both audio and video insights. Fails if either audio or video Insights fail." + } + ], + "modelAsString": true + }, + "description": "Defines the type of insights that you want the service to generate. The allowed values are 'AudioInsightsOnly', 'VideoInsightsOnly', and 'AllInsights'. The default is AllInsights. If you set this to AllInsights and the input is audio only, then only audio insights are generated. Similarly if the input is video only, then only video insights are generated. It is recommended that you not use AudioInsightsOnly if you expect some of your inputs to be video only; or use VideoInsightsOnly if you expect some of your inputs to be audio only. Your Jobs in such conditions would error out." + } + }, + "type": "object", + "description": "A video analyzer preset that extracts insights (rich metadata) from both audio and video, and outputs a JSON format file." + }, + "TransportStreamFormat": { + "x-ms-discriminator-value": "#Microsoft.Media.TransportStreamFormat", + "allOf": [ + { + "$ref": "#/definitions/MultiBitrateFormat" + } + ], + "properties": {}, + "type": "object", + "description": "Describes the properties for generating an MPEG-2 Transport Stream (ISO/IEC 13818-1) output video file(s)." + }, + "VideoOverlay": { + "x-ms-discriminator-value": "#Microsoft.Media.VideoOverlay", + "allOf": [ + { + "$ref": "#/definitions/Overlay" + } + ], + "properties": { + "position": { + "$ref": "#/definitions/Rectangle", + "description": "The location in the input video where the overlay is applied." + }, + "opacity": { + "type": "number", + "format": "double", + "description": "The opacity of the overlay. This is a value in the range [0 - 1.0]. Default is 1.0 which mean the overlay is opaque." + }, + "cropRectangle": { + "$ref": "#/definitions/Rectangle", + "description": "An optional rectangular window used to crop the overlay image or video." + } + }, + "type": "object", + "description": "Describes the properties of a video overlay." + }, + "VideoTrackDescriptor": { + "x-ms-discriminator-value": "#Microsoft.Media.VideoTrackDescriptor", + "allOf": [ + { + "$ref": "#/definitions/TrackDescriptor" + } + ], + "properties": {}, + "type": "object", + "description": "A TrackSelection to select video tracks." + }, + "SelectVideoTrackByAttribute": { + "x-ms-discriminator-value": "#Microsoft.Media.SelectVideoTrackByAttribute", + "allOf": [ + { + "$ref": "#/definitions/VideoTrackDescriptor" + } + ], + "properties": { + "attribute": { + "type": "string", + "enum": [ + "Bitrate", + "Language" + ], + "x-ms-enum": { + "name": "TrackAttribute", + "values": [ + { + "value": "Bitrate", + "description": "The bitrate of the track." + }, + { + "value": "Language", + "description": "The language of the track." + } + ], + "modelAsString": true + }, + "description": "The TrackAttribute to filter the tracks by." + }, + "filter": { + "type": "string", + "enum": [ + "All", + "Top", + "Bottom", + "ValueEquals" + ], + "x-ms-enum": { + "name": "AttributeFilter", + "values": [ + { + "value": "All", + "description": "All tracks will be included." + }, + { + "value": "Top", + "description": "The first track will be included when the attribute is sorted in descending order. Generally used to select the largest bitrate." + }, + { + "value": "Bottom", + "description": "The first track will be included when the attribute is sorted in ascending order. Generally used to select the smallest bitrate." + }, + { + "value": "ValueEquals", + "description": "Any tracks that have an attribute equal to the value given will be included." + } + ], + "modelAsString": true + }, + "description": "The type of AttributeFilter to apply to the TrackAttribute in order to select the tracks." + }, + "filterValue": { + "type": "string", + "description": "The value to filter the tracks by. Only used when AttributeFilter.ValueEquals is specified for the Filter property. For TrackAttribute.Bitrate, this should be an integer value in bits per second (e.g: '1500000'). The TrackAttribute.Language is not supported for video tracks." + } + }, + "type": "object", + "required": [ + "attribute", + "filter" + ], + "description": "Select video tracks from the input by specifying an attribute and an attribute filter." + }, + "SelectVideoTrackById": { + "x-ms-discriminator-value": "#Microsoft.Media.SelectVideoTrackById", + "allOf": [ + { + "$ref": "#/definitions/VideoTrackDescriptor" + } + ], + "properties": { + "trackId": { + "type": "integer", + "format": "int64", + "description": "Track identifier to select" + } + }, + "type": "object", + "required": [ + "trackId" + ], + "description": "Select video tracks from the input by specifying a track identifier." + }, + "TransformOutput": { + "properties": { + "onError": { + "type": "string", + "enum": [ + "StopProcessingJob", + "ContinueJob" + ], + "x-ms-enum": { + "name": "OnErrorType", + "values": [ + { + "value": "StopProcessingJob", + "description": "Tells the service that if this TransformOutput fails, then any other incomplete TransformOutputs can be stopped." + }, + { + "value": "ContinueJob", + "description": "Tells the service that if this TransformOutput fails, then allow any other TransformOutput to continue." + } + ], + "modelAsString": true + }, + "description": "A Transform can define more than one outputs. This property defines what the service should do when one output fails - either continue to produce other outputs, or, stop the other outputs. The overall Job state will not reflect failures of outputs that are specified with 'ContinueJob'. The default is 'StopProcessingJob'." + }, + "relativePriority": { + "type": "string", + "enum": [ + "Low", + "Normal", + "High" + ], + "x-ms-enum": { + "name": "Priority", + "values": [ + { + "value": "Low", + "description": "Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs." + }, + { + "value": "Normal", + "description": "Used for TransformOutputs that can be generated at Normal priority." + }, + { + "value": "High", + "description": "Used for TransformOutputs that should take precedence over others." + } + ], + "modelAsString": true + }, + "description": "Sets the relative priority of the TransformOutputs within a Transform. This sets the priority that the service uses for processing TransformOutputs. The default priority is Normal." + }, + "preset": { + "$ref": "#/definitions/Preset", + "description": "Preset that describes the operations that will be used to modify, transcode, or extract insights from the source file to generate the output." + } + }, + "type": "object", + "required": [ + "preset" + ], + "description": "Describes the properties of a TransformOutput, which are the rules to be applied while generating the desired output." + }, + "TransformProperties": { + "properties": { + "created": { + "type": "string", + "format": "date-time", + "description": "The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format.", + "readOnly": true, + "x-nullable": false + }, + "description": { + "type": "string", + "description": "An optional verbose description of the Transform." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "description": "The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format.", + "readOnly": true, + "x-nullable": false + }, + "outputs": { + "type": "array", + "items": { + "$ref": "#/definitions/TransformOutput" + }, + "description": "An array of one or more TransformOutputs that the Transform should generate." + } + }, + "type": "object", + "required": [ + "outputs" + ], + "description": "A Transform." + }, + "Transform": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TransformProperties", + "description": "The resource properties.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "The system metadata relating to this resource.", + "readOnly": true + } + }, + "type": "object", + "description": "A Transform encapsulates the rules or instructions for generating desired outputs from input media, such as by transcoding or by extracting insights. After the Transform is created, it can be applied to input media by creating Jobs." + }, + "JobInput": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base class for inputs to a Job." + }, + "JobInputClip": { + "x-ms-discriminator-value": "#Microsoft.Media.JobInputClip", + "allOf": [ + { + "$ref": "#/definitions/JobInput" + } + ], + "properties": { + "files": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of files. Required for JobInputHttp. Maximum of 4000 characters each. Query strings will not be returned in service responses to prevent sensitive data exposure." + }, + "start": { + "$ref": "#/definitions/ClipTime", + "description": "Defines a point on the timeline of the input media at which processing will start. Defaults to the beginning of the input media." + }, + "end": { + "$ref": "#/definitions/ClipTime", + "description": "Defines a point on the timeline of the input media at which processing will end. Defaults to the end of the input media." + }, + "label": { + "type": "string", + "description": "A label that is assigned to a JobInputClip, that is used to satisfy a reference used in the Transform. For example, a Transform can be authored so as to take an image file with the label 'xyz' and apply it as an overlay onto the input video before it is encoded. When submitting a Job, exactly one of the JobInputs should be the image file, and it should have the label 'xyz'." + }, + "inputDefinitions": { + "type": "array", + "items": { + "$ref": "#/definitions/InputDefinition" + }, + "description": "Defines a list of InputDefinitions. For each InputDefinition, it defines a list of track selections and related metadata." + } + }, + "type": "object", + "description": "Represents input files for a Job." + }, + "ClipTime": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base class for specifying a clip time. Use sub classes of this class to specify the time position in the media." + }, + "AbsoluteClipTime": { + "x-ms-discriminator-value": "#Microsoft.Media.AbsoluteClipTime", + "allOf": [ + { + "$ref": "#/definitions/ClipTime" + } + ], + "properties": { + "time": { + "type": "string", + "format": "duration", + "description": "The time position on the timeline of the input media. It is usually specified as an ISO8601 period. e.g PT30S for 30 seconds." + } + }, + "type": "object", + "required": [ + "time" + ], + "description": "Specifies the clip time as an absolute time position in the media file. The absolute time can point to a different position depending on whether the media file starts from a timestamp of zero or not." + }, + "UtcClipTime": { + "x-ms-discriminator-value": "#Microsoft.Media.UtcClipTime", + "allOf": [ + { + "$ref": "#/definitions/ClipTime" + } + ], + "properties": { + "time": { + "type": "string", + "format": "date-time", + "description": "The time position on the timeline of the input media based on Utc time." + } + }, + "type": "object", + "required": [ + "time" + ], + "description": "Specifies the clip time as a Utc time position in the media file. The Utc time can point to a different position depending on whether the media file starts from a timestamp of zero or not." + }, + "JobInputs": { + "x-ms-discriminator-value": "#Microsoft.Media.JobInputs", + "allOf": [ + { + "$ref": "#/definitions/JobInput" + } + ], + "properties": { + "inputs": { + "type": "array", + "items": { + "$ref": "#/definitions/JobInput" + }, + "description": "List of inputs to a Job." + } + }, + "type": "object", + "description": "Describes a list of inputs to a Job." + }, + "JobInputAsset": { + "x-ms-discriminator-value": "#Microsoft.Media.JobInputAsset", + "allOf": [ + { + "$ref": "#/definitions/JobInputClip" + } + ], + "properties": { + "assetName": { + "type": "string", + "description": "The name of the input Asset." + } + }, + "type": "object", + "required": [ + "assetName" + ], + "description": "Represents an Asset for input into a Job." + }, + "JobInputHttp": { + "x-ms-discriminator-value": "#Microsoft.Media.JobInputHttp", + "allOf": [ + { + "$ref": "#/definitions/JobInputClip" + } + ], + "properties": { + "baseUri": { + "type": "string", + "description": "Base URI for HTTPS job input. It will be concatenated with provided file names. If no base uri is given, then the provided file list is assumed to be fully qualified uris. Maximum length of 4000 characters. The query strings will not be returned in service responses to prevent sensitive data exposure." + } + }, + "type": "object", + "description": "Represents HTTPS job input." + }, + "JobOutput": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + }, + "error": { + "$ref": "#/definitions/JobError", + "description": "If the JobOutput is in the Error state, it contains the details of the error.", + "readOnly": true + }, + "presetOverride": { + "$ref": "#/definitions/Preset", + "description": "A preset used to override the preset in the corresponding transform output." + }, + "state": { + "type": "string", + "enum": [ + "Canceled", + "Canceling", + "Error", + "Finished", + "Processing", + "Queued", + "Scheduled" + ], + "x-ms-enum": { + "name": "JobState", + "values": [ + { + "value": "Canceled", + "description": "The job was canceled. This is a final state for the job." + }, + { + "value": "Canceling", + "description": "The job is in the process of being canceled. This is a transient state for the job." + }, + { + "value": "Error", + "description": "The job has encountered an error. This is a final state for the job." + }, + { + "value": "Finished", + "description": "The job is finished. This is a final state for the job." + }, + { + "value": "Processing", + "description": "The job is processing. This is a transient state for the job." + }, + { + "value": "Queued", + "description": "The job is in a queued state, waiting for resources to become available. This is a transient state." + }, + { + "value": "Scheduled", + "description": "The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states." + } + ], + "modelAsString": true + }, + "description": "Describes the state of the JobOutput.", + "readOnly": true, + "x-nullable": false + }, + "progress": { + "type": "integer", + "format": "int32", + "description": "If the JobOutput is in a Processing state, this contains the Job completion percentage. The value is an estimate and not intended to be used to predict Job completion times. To determine if the JobOutput is complete, use the State property.", + "readOnly": true, + "x-nullable": false + }, + "label": { + "type": "string", + "description": "A label that is assigned to a JobOutput in order to help uniquely identify it. This is useful when your Transform has more than one TransformOutput, whereby your Job has more than one JobOutput. In such cases, when you submit the Job, you will add two or more JobOutputs, in the same order as TransformOutputs in the Transform. Subsequently, when you retrieve the Job, either through events or on a GET request, you can use the label to easily identify the JobOutput. If a label is not provided, a default value of '{presetName}_{outputIndex}' will be used, where the preset name is the name of the preset in the corresponding TransformOutput and the output index is the relative index of the this JobOutput within the Job. Note that this index is the same as the relative index of the corresponding TransformOutput within its Transform." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The UTC date and time at which this Job Output began processing.", + "readOnly": true, + "x-nullable": true + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The UTC date and time at which this Job Output finished processing.", + "readOnly": true, + "x-nullable": true + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Describes all the properties of a JobOutput." + }, + "JobError": { + "properties": { + "code": { + "type": "string", + "enum": [ + "ServiceError", + "ServiceTransientError", + "DownloadNotAccessible", + "DownloadTransientError", + "UploadNotAccessible", + "UploadTransientError", + "ConfigurationUnsupported", + "ContentMalformed", + "ContentUnsupported" + ], + "x-ms-enum": { + "name": "JobErrorCode", + "values": [ + { + "value": "ServiceError", + "description": "Fatal service error, please contact support." + }, + { + "value": "ServiceTransientError", + "description": "Transient error, please retry, if retry is unsuccessful, please contact support." + }, + { + "value": "DownloadNotAccessible", + "description": "While trying to download the input files, the files were not accessible, please check the availability of the source." + }, + { + "value": "DownloadTransientError", + "description": "While trying to download the input files, there was an issue during transfer (storage service, network errors), see details and check your source." + }, + { + "value": "UploadNotAccessible", + "description": "While trying to upload the output files, the destination was not reachable, please check the availability of the destination." + }, + { + "value": "UploadTransientError", + "description": "While trying to upload the output files, there was an issue during transfer (storage service, network errors), see details and check your destination." + }, + { + "value": "ConfigurationUnsupported", + "description": "There was a problem with the combination of input files and the configuration settings applied, fix the configuration settings and retry with the same input, or change input to match the configuration." + }, + { + "value": "ContentMalformed", + "description": "There was a problem with the input content (for example: zero byte files, or corrupt/non-decodable files), check the input files." + }, + { + "value": "ContentUnsupported", + "description": "There was a problem with the format of the input (not valid media file, or an unsupported file/codec), check the validity of the input files." + } + ], + "modelAsString": true + }, + "description": "Error code describing the error.", + "readOnly": true, + "x-nullable": false + }, + "message": { + "type": "string", + "description": "A human-readable language-dependent representation of the error.", + "readOnly": true + }, + "category": { + "type": "string", + "enum": [ + "Service", + "Download", + "Upload", + "Configuration", + "Content" + ], + "x-ms-enum": { + "name": "JobErrorCategory", + "values": [ + { + "value": "Service", + "description": "The error is service related." + }, + { + "value": "Download", + "description": "The error is download related." + }, + { + "value": "Upload", + "description": "The error is upload related." + }, + { + "value": "Configuration", + "description": "The error is configuration related." + }, + { + "value": "Content", + "description": "The error is related to data in the input files." + } + ], + "modelAsString": true + }, + "description": "Helps with categorization of errors.", + "readOnly": true, + "x-nullable": false + }, + "retry": { + "type": "string", + "enum": [ + "DoNotRetry", + "MayRetry" + ], + "x-ms-enum": { + "name": "JobRetry", + "values": [ + { + "value": "DoNotRetry", + "description": "Issue needs to be investigated and then the job resubmitted with corrections or retried once the underlying issue has been corrected." + }, + { + "value": "MayRetry", + "description": "Issue may be resolved after waiting for a period of time and resubmitting the same Job." + } + ], + "modelAsString": true + }, + "description": "Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal.", + "readOnly": true, + "x-nullable": false + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/JobErrorDetail" + }, + "description": "An array of details about specific errors that led to this reported error.", + "readOnly": true + } + }, + "type": "object", + "description": "Details of JobOutput errors." + }, + "JobOutputAsset": { + "x-ms-discriminator-value": "#Microsoft.Media.JobOutputAsset", + "allOf": [ + { + "$ref": "#/definitions/JobOutput" + } + ], + "properties": { + "assetName": { + "type": "string", + "description": "The name of the output Asset." + } + }, + "type": "object", + "required": [ + "assetName" + ], + "description": "Represents an Asset used as a JobOutput." + }, + "JobErrorDetail": { + "properties": { + "code": { + "type": "string", + "description": "Code describing the error detail.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error.", + "readOnly": true + } + }, + "type": "object", + "description": "Details of JobOutput errors." + }, + "JobProperties": { + "properties": { + "created": { + "type": "string", + "format": "date-time", + "description": "The UTC date and time when the customer has created the Job, in 'YYYY-MM-DDThh:mm:ssZ' format.", + "readOnly": true, + "x-nullable": false + }, + "state": { + "type": "string", + "enum": [ + "Canceled", + "Canceling", + "Error", + "Finished", + "Processing", + "Queued", + "Scheduled" + ], + "x-ms-enum": { + "name": "JobState", + "values": [ + { + "value": "Canceled", + "description": "The job was canceled. This is a final state for the job." + }, + { + "value": "Canceling", + "description": "The job is in the process of being canceled. This is a transient state for the job." + }, + { + "value": "Error", + "description": "The job has encountered an error. This is a final state for the job." + }, + { + "value": "Finished", + "description": "The job is finished. This is a final state for the job." + }, + { + "value": "Processing", + "description": "The job is processing. This is a transient state for the job." + }, + { + "value": "Queued", + "description": "The job is in a queued state, waiting for resources to become available. This is a transient state." + }, + { + "value": "Scheduled", + "description": "The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states." + } + ], + "modelAsString": true + }, + "description": "The current state of the job.", + "readOnly": true, + "x-nullable": false + }, + "description": { + "type": "string", + "description": "Optional customer supplied description of the Job." + }, + "input": { + "$ref": "#/definitions/JobInput", + "description": "The inputs for the Job." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "description": "The UTC date and time when the customer has last updated the Job, in 'YYYY-MM-DDThh:mm:ssZ' format.", + "readOnly": true, + "x-nullable": false + }, + "outputs": { + "type": "array", + "items": { + "$ref": "#/definitions/JobOutput" + }, + "description": "The outputs for the Job." + }, + "priority": { + "type": "string", + "enum": [ + "Low", + "Normal", + "High" + ], + "x-ms-enum": { + "name": "Priority", + "values": [ + { + "value": "Low", + "description": "Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs." + }, + { + "value": "Normal", + "description": "Used for TransformOutputs that can be generated at Normal priority." + }, + { + "value": "High", + "description": "Used for TransformOutputs that should take precedence over others." + } + ], + "modelAsString": true + }, + "description": "Priority with which the job should be processed. Higher priority jobs are processed before lower priority jobs. If not set, the default is normal." + }, + "correlationData": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Customer provided key, value pairs that will be returned in Job and JobOutput state events." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The UTC date and time at which this Job began processing.", + "readOnly": true, + "x-nullable": true + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The UTC date and time at which this Job finished processing.", + "readOnly": true, + "x-nullable": true + } + }, + "type": "object", + "required": [ + "input", + "outputs" + ], + "description": "Properties of the Job." + }, + "JobInputSequence": { + "x-ms-discriminator-value": "#Microsoft.Media.JobInputSequence", + "allOf": [ + { + "$ref": "#/definitions/JobInput" + } + ], + "properties": { + "inputs": { + "type": "array", + "items": { + "$ref": "#/definitions/JobInputClip" + }, + "description": "JobInputs that make up the timeline." + } + }, + "type": "object", + "description": "A Sequence contains an ordered list of Clips where each clip is a JobInput. The Sequence will be treated as a single input." + }, + "Job": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "The resource properties.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "The system metadata relating to this resource.", + "readOnly": true + } + }, + "type": "object", + "description": "A Job resource type. The progress and state can be obtained by polling a Job or subscribing to events using EventGrid." + }, + "PresetConfigurations": { + "description": "An object of optional configuration settings for encoder.", + "properties": { + "complexity": { + "description": "Allows you to configure the encoder settings to control the balance between speed and quality. Example: set Complexity as Speed for faster encoding but less compression efficiency.", + "enum": [ + "Speed", + "Balanced", + "Quality" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "Complexity", + "values": [ + { + "description": "Configures the encoder to use settings optimized for faster encoding. Quality is sacrificed to decrease encoding time.", + "value": "Speed" + }, + { + "description": "Configures the encoder to use settings that achieve a balance between speed and quality.", + "value": "Balanced" + }, + { + "description": "Configures the encoder to use settings optimized to produce higher quality output at the expense of slower overall encode time.", + "value": "Quality" + } + ] + } + }, + "interleaveOutput": { + "description": "Sets the interleave mode of the output to control how audio and video are stored in the container format. Example: set InterleavedOutput as NonInterleavedOutput to produce audio-only and video-only outputs in separate MP4 files.", + "enum": [ + "NonInterleavedOutput", + "InterleavedOutput" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "InterleaveOutput", + "values": [ + { + "description": "The output is video-only or audio-only.", + "value": "NonInterleavedOutput" + }, + { + "description": "The output includes both audio and video.", + "value": "InterleavedOutput" + } + ] + } + }, + "keyFrameIntervalInSeconds": { + "description": "The key frame interval in seconds. Example: set KeyFrameIntervalInSeconds as 2 to reduce the playback buffering for some players.", + "format": "float", + "type": "number" + }, + "maxBitrateBps": { + "description": "The maximum bitrate in bits per second (threshold for the top video layer). Example: set MaxBitrateBps as 6000000 to avoid producing very high bitrate outputs for contents with high complexity.", + "format": "int32", + "type": "integer" + }, + "maxHeight": { + "description": "The maximum height of output video layers. Example: set MaxHeight as 720 to produce output layers up to 720P even if the input is 4K.", + "format": "int32", + "type": "integer" + }, + "maxLayers": { + "description": "The maximum number of output video layers. Example: set MaxLayers as 4 to make sure at most 4 output layers are produced to control the overall cost of the encoding job.", + "format": "int32", + "type": "integer" + }, + "minBitrateBps": { + "description": "The minimum bitrate in bits per second (threshold for the bottom video layer). Example: set MinBitrateBps as 200000 to have a bottom layer that covers users with low network bandwidth.", + "format": "int32", + "type": "integer" + }, + "minHeight": { + "description": "The minimum height of output video layers. Example: set MinHeight as 360 to avoid output layers of smaller resolutions like 180P.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "TransformCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Transform" + }, + "description": "A collection of Transform items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of Transform items." + }, + "JobCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Job" + }, + "description": "A collection of Job items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of Job items." + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms": { + "get": { + "summary": "List Transforms", + "description": "Lists the Transforms in the account.", + "operationId": "Transforms_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TransformCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Restricts the set of items returned." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Specifies the key by which the result collection should be ordered." + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-odata": "#/definitions/Transform", + "x-ms-examples": { + "Lists the Transforms": { + "$ref": "examples/transforms-list-all.json" + }, + "Lists the Transforms filter by name": { + "$ref": "examples/transforms-list-all-filter-by-name.json" + }, + "Lists the Transforms filter by created": { + "$ref": "examples/transforms-list-all-filter-by-created.json" + }, + "Lists the Transforms filter by lastmodified": { + "$ref": "examples/transforms-list-all-filter-by-lastmodified.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}": { + "get": { + "summary": "Get Transform", + "description": "Gets a Transform.", + "operationId": "Transforms_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Transform" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get a Transform by name": { + "$ref": "examples/transforms-get-by-name.json" + } + } + }, + "put": { + "summary": "Create or Update Transform", + "description": "Creates or updates a new Transform.", + "operationId": "Transforms_CreateOrUpdate", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Transform" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Transform" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Transform" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Create or update a Transform": { + "$ref": "examples/transforms-create.json" + } + } + }, + "delete": { + "summary": "Delete Transform", + "description": "Deletes a Transform.", + "operationId": "Transforms_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete a Transform": { + "$ref": "examples/transforms-delete.json" + } + } + }, + "patch": { + "summary": "Update Transform", + "description": "Updates a Transform.", + "operationId": "Transforms_Update", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Transform" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Transform" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Update a Transform.": { + "$ref": "examples/transforms-update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}/jobs": { + "get": { + "summary": "List Jobs", + "description": "Lists all of the Jobs for the Transform.", + "operationId": "Jobs_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Restricts the set of items returned." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Specifies the key by which the result collection should be ordered." + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-odata": "#/definitions/Job", + "x-ms-examples": { + "Lists all of the Jobs for the Transform.": { + "$ref": "examples/jobs-list-all.json" + }, + "Lists Jobs for the Transform filter by name.": { + "$ref": "examples/jobs-list-all-filter-by-name.json" + }, + "Lists Jobs for the Transform filter by state equal.": { + "$ref": "examples/jobs-list-all-filter-by-state-eq.json" + }, + "Lists Jobs for the Transform filter by state not equal.": { + "$ref": "examples/jobs-list-all-filter-by-state-ne.json" + }, + "Lists Jobs for the Transform filter by name and state.": { + "$ref": "examples/jobs-list-all-filter-by-name-and-state.json" + }, + "Lists Jobs for the Transform filter by created.": { + "$ref": "examples/jobs-list-all-filter-by-created.json" + }, + "Lists Jobs for the Transform filter by lastmodified.": { + "$ref": "examples/jobs-list-all-filter-by-lastmodified.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}/jobs/{jobName}": { + "get": { + "summary": "Get Job", + "description": "Gets a Job.", + "operationId": "Jobs_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The Job name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get a Job by name": { + "$ref": "examples/jobs-get-by-name.json" + } + } + }, + "put": { + "summary": "Create Job", + "description": "Creates a Job.", + "operationId": "Jobs_Create", + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The Job name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Job" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Create a Job": { + "$ref": "examples/jobs-create.json" + } + } + }, + "delete": { + "summary": "Delete Job", + "description": "Deletes a Job.", + "operationId": "Jobs_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The Job name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete a Job": { + "$ref": "examples/jobs-delete.json" + } + } + }, + "patch": { + "summary": "Update Job", + "description": "Update is only supported for description and priority. Updating Priority will take effect when the Job state is Queued or Scheduled and depending on the timing the priority update may be ignored.", + "operationId": "Jobs_Update", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The Job name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Job" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Update a Job": { + "$ref": "examples/jobs-update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}/jobs/{jobName}/cancelJob": { + "post": { + "summary": "Cancel Job", + "description": "Cancel a Job.", + "operationId": "Jobs_CancelJob", + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The Job name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Cancel a Job": { + "$ref": "examples/jobs-cancel.json" + } + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The unique identifier for a Microsoft Azure subscription." + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the Azure subscription.", + "x-ms-parameter-location": "method" + }, + "MediaServicesAccountName": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name.", + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The version of the API to be used with the client request." + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/StreamingPoliciesAndStreamingLocators.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/StreamingPoliciesAndStreamingLocators.json new file mode 100644 index 000000000000..aa12f16d26e1 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/StreamingPoliciesAndStreamingLocators.json @@ -0,0 +1,1260 @@ +{ + "schemes": [ + "https" + ], + "swagger": "2.0", + "info": { + "title": "Azure Media Services", + "description": "This Swagger was generated by the API Framework.", + "version": "2021-06-01" + }, + "host": "management.azure.com", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "definitions": { + "TrackPropertyCondition": { + "properties": { + "property": { + "type": "string", + "enum": [ + "Unknown", + "FourCC" + ], + "x-ms-enum": { + "name": "TrackPropertyType", + "values": [ + { + "value": "Unknown", + "description": "Unknown track property" + }, + { + "value": "FourCC", + "description": "Track FourCC" + } + ], + "modelAsString": true + }, + "description": "Track property type" + }, + "operation": { + "type": "string", + "enum": [ + "Unknown", + "Equal" + ], + "x-ms-enum": { + "name": "TrackPropertyCompareOperation", + "values": [ + { + "value": "Unknown", + "description": "Unknown track property compare operation" + }, + { + "value": "Equal", + "description": "Equal operation" + } + ], + "modelAsString": true + }, + "description": "Track property condition operation" + }, + "value": { + "type": "string", + "description": "Track property value" + } + }, + "type": "object", + "required": [ + "property", + "operation" + ], + "description": "Class to specify one track property condition" + }, + "TrackSelection": { + "properties": { + "trackSelections": { + "type": "array", + "items": { + "$ref": "#/definitions/TrackPropertyCondition" + }, + "description": "TrackSelections is a track property condition list which can specify track(s)" + } + }, + "type": "object", + "description": "Class to select a track" + }, + "DefaultKey": { + "properties": { + "label": { + "type": "string", + "description": "Label can be used to specify Content Key when creating a Streaming Locator" + }, + "policyName": { + "type": "string", + "description": "Policy used by Default Key" + } + }, + "type": "object", + "description": "Class to specify properties of default content key for each encryption scheme" + }, + "StreamingPolicyContentKey": { + "properties": { + "label": { + "type": "string", + "description": "Label can be used to specify Content Key when creating a Streaming Locator" + }, + "policyName": { + "type": "string", + "description": "Policy used by Content Key" + }, + "tracks": { + "type": "array", + "items": { + "$ref": "#/definitions/TrackSelection" + }, + "description": "Tracks which use this content key" + } + }, + "type": "object", + "description": "Class to specify properties of content key" + }, + "StreamingPolicyContentKeys": { + "properties": { + "defaultKey": { + "$ref": "#/definitions/DefaultKey", + "description": "Default content key for an encryption scheme" + }, + "keyToTrackMappings": { + "type": "array", + "items": { + "$ref": "#/definitions/StreamingPolicyContentKey" + }, + "description": "Representing tracks needs separate content key" + } + }, + "type": "object", + "description": "Class to specify properties of all content keys in Streaming Policy" + }, + "StreamingPolicyPlayReadyConfiguration": { + "properties": { + "customLicenseAcquisitionUrlTemplate": { + "type": "string", + "description": "Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested." + }, + "playReadyCustomAttributes": { + "type": "string", + "description": "Custom attributes for PlayReady" + } + }, + "type": "object", + "description": "Class to specify configurations of PlayReady in Streaming Policy" + }, + "StreamingPolicyWidevineConfiguration": { + "properties": { + "customLicenseAcquisitionUrlTemplate": { + "type": "string", + "description": "Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested." + } + }, + "type": "object", + "description": "Class to specify configurations of Widevine in Streaming Policy" + }, + "StreamingPolicyFairPlayConfiguration": { + "properties": { + "customLicenseAcquisitionUrlTemplate": { + "type": "string", + "description": "Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested." + }, + "allowPersistentLicense": { + "type": "boolean", + "description": "All license to be persistent or not" + } + }, + "type": "object", + "required": [ + "allowPersistentLicense" + ], + "description": "Class to specify configurations of FairPlay in Streaming Policy" + }, + "CbcsDrmConfiguration": { + "properties": { + "fairPlay": { + "$ref": "#/definitions/StreamingPolicyFairPlayConfiguration", + "description": "FairPlay configurations" + }, + "playReady": { + "$ref": "#/definitions/StreamingPolicyPlayReadyConfiguration", + "description": "PlayReady configurations" + }, + "widevine": { + "$ref": "#/definitions/StreamingPolicyWidevineConfiguration", + "description": "Widevine configurations" + } + }, + "type": "object", + "description": "Class to specify DRM configurations of CommonEncryptionCbcs scheme in Streaming Policy" + }, + "CencDrmConfiguration": { + "properties": { + "playReady": { + "$ref": "#/definitions/StreamingPolicyPlayReadyConfiguration", + "description": "PlayReady configurations" + }, + "widevine": { + "$ref": "#/definitions/StreamingPolicyWidevineConfiguration", + "description": "Widevine configurations" + } + }, + "type": "object", + "description": "Class to specify DRM configurations of CommonEncryptionCenc scheme in Streaming Policy" + }, + "EnabledProtocols": { + "properties": { + "download": { + "type": "boolean", + "description": "Enable Download protocol or not" + }, + "dash": { + "type": "boolean", + "description": "Enable DASH protocol or not" + }, + "hls": { + "type": "boolean", + "description": "Enable HLS protocol or not" + }, + "smoothStreaming": { + "type": "boolean", + "description": "Enable SmoothStreaming protocol or not" + } + }, + "type": "object", + "required": [ + "download", + "dash", + "hls", + "smoothStreaming" + ], + "description": "Class to specify which protocols are enabled" + }, + "NoEncryption": { + "properties": { + "enabledProtocols": { + "$ref": "#/definitions/EnabledProtocols", + "description": "Representing supported protocols" + } + }, + "type": "object", + "description": "Class for NoEncryption scheme" + }, + "EnvelopeEncryption": { + "properties": { + "enabledProtocols": { + "$ref": "#/definitions/EnabledProtocols", + "description": "Representing supported protocols" + }, + "clearTracks": { + "type": "array", + "items": { + "$ref": "#/definitions/TrackSelection" + }, + "description": "Representing which tracks should not be encrypted" + }, + "contentKeys": { + "$ref": "#/definitions/StreamingPolicyContentKeys", + "description": "Representing default content key for each encryption scheme and separate content keys for specific tracks" + }, + "customKeyAcquisitionUrlTemplate": { + "type": "string", + "description": "Template for the URL of the custom service delivering keys to end user players. Not required when using Azure Media Services for issuing keys. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested." + } + }, + "type": "object", + "description": "Class for EnvelopeEncryption encryption scheme" + }, + "CommonEncryptionCenc": { + "properties": { + "enabledProtocols": { + "$ref": "#/definitions/EnabledProtocols", + "description": "Representing supported protocols" + }, + "clearTracks": { + "type": "array", + "items": { + "$ref": "#/definitions/TrackSelection" + }, + "description": "Representing which tracks should not be encrypted" + }, + "contentKeys": { + "$ref": "#/definitions/StreamingPolicyContentKeys", + "description": "Representing default content key for each encryption scheme and separate content keys for specific tracks" + }, + "drm": { + "$ref": "#/definitions/CencDrmConfiguration", + "description": "Configuration of DRMs for CommonEncryptionCenc encryption scheme" + } + }, + "type": "object", + "description": "Class for envelope encryption scheme" + }, + "CommonEncryptionCbcs": { + "properties": { + "enabledProtocols": { + "$ref": "#/definitions/EnabledProtocols", + "description": "Representing supported protocols" + }, + "clearTracks": { + "type": "array", + "items": { + "$ref": "#/definitions/TrackSelection" + }, + "description": "Representing which tracks should not be encrypted" + }, + "contentKeys": { + "$ref": "#/definitions/StreamingPolicyContentKeys", + "description": "Representing default content key for each encryption scheme and separate content keys for specific tracks" + }, + "drm": { + "$ref": "#/definitions/CbcsDrmConfiguration", + "description": "Configuration of DRMs for current encryption scheme" + } + }, + "type": "object", + "description": "Class for CommonEncryptionCbcs encryption scheme" + }, + "StreamingPolicyProperties": { + "properties": { + "created": { + "type": "string", + "format": "date-time", + "description": "Creation time of Streaming Policy", + "readOnly": true, + "x-nullable": false + }, + "defaultContentKeyPolicyName": { + "type": "string", + "description": "Default ContentKey used by current Streaming Policy" + }, + "envelopeEncryption": { + "$ref": "#/definitions/EnvelopeEncryption", + "description": "Configuration of EnvelopeEncryption" + }, + "commonEncryptionCenc": { + "$ref": "#/definitions/CommonEncryptionCenc", + "description": "Configuration of CommonEncryptionCenc" + }, + "commonEncryptionCbcs": { + "$ref": "#/definitions/CommonEncryptionCbcs", + "description": "Configuration of CommonEncryptionCbcs" + }, + "noEncryption": { + "$ref": "#/definitions/NoEncryption", + "description": "Configurations of NoEncryption" + } + }, + "type": "object", + "description": "Class to specify properties of Streaming Policy" + }, + "StreamingPolicy": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StreamingPolicyProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "The system metadata relating to this resource.", + "readOnly": true + } + }, + "type": "object", + "description": "A Streaming Policy resource" + }, + "StreamingLocatorContentKey": { + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "ID of Content Key" + }, + "type": { + "type": "string", + "enum": [ + "CommonEncryptionCenc", + "CommonEncryptionCbcs", + "EnvelopeEncryption" + ], + "x-ms-enum": { + "name": "StreamingLocatorContentKeyType", + "values": [ + { + "value": "CommonEncryptionCenc", + "description": "Common Encryption using CENC" + }, + { + "value": "CommonEncryptionCbcs", + "description": "Common Encryption using CBCS" + }, + { + "value": "EnvelopeEncryption", + "description": "Envelope Encryption" + } + ], + "modelAsString": true + }, + "description": "Encryption type of Content Key", + "readOnly": true, + "x-nullable": false + }, + "labelReferenceInStreamingPolicy": { + "type": "string", + "description": "Label of Content Key as specified in the Streaming Policy" + }, + "value": { + "type": "string", + "description": "Value of Content Key" + }, + "policyName": { + "type": "string", + "description": "ContentKeyPolicy used by Content Key", + "readOnly": true + }, + "tracks": { + "type": "array", + "items": { + "$ref": "#/definitions/TrackSelection" + }, + "description": "Tracks which use this Content Key", + "readOnly": true + } + }, + "type": "object", + "required": [ + "id" + ], + "description": "Class for content key in Streaming Locator" + }, + "StreamingPath": { + "properties": { + "streamingProtocol": { + "type": "string", + "enum": [ + "Hls", + "Dash", + "SmoothStreaming", + "Download" + ], + "x-ms-enum": { + "name": "StreamingPolicyStreamingProtocol", + "values": [ + { + "value": "Hls", + "description": "HLS protocol" + }, + { + "value": "Dash", + "description": "DASH protocol" + }, + { + "value": "SmoothStreaming", + "description": "SmoothStreaming protocol" + }, + { + "value": "Download", + "description": "Download protocol" + } + ], + "modelAsString": true + }, + "description": "Streaming protocol" + }, + "encryptionScheme": { + "type": "string", + "enum": [ + "NoEncryption", + "EnvelopeEncryption", + "CommonEncryptionCenc", + "CommonEncryptionCbcs" + ], + "x-ms-enum": { + "name": "EncryptionScheme", + "values": [ + { + "value": "NoEncryption", + "description": "NoEncryption scheme" + }, + { + "value": "EnvelopeEncryption", + "description": "EnvelopeEncryption scheme" + }, + { + "value": "CommonEncryptionCenc", + "description": "CommonEncryptionCenc scheme" + }, + { + "value": "CommonEncryptionCbcs", + "description": "CommonEncryptionCbcs scheme" + } + ], + "modelAsString": true + }, + "description": "Encryption scheme" + }, + "paths": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Streaming paths for each protocol and encryptionScheme pair" + } + }, + "type": "object", + "required": [ + "streamingProtocol", + "encryptionScheme" + ], + "description": "Class of paths for streaming" + }, + "StreamingLocatorProperties": { + "properties": { + "assetName": { + "type": "string", + "description": "Asset Name" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The creation time of the Streaming Locator.", + "readOnly": true, + "x-nullable": false + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the Streaming Locator." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the Streaming Locator." + }, + "streamingLocatorId": { + "type": "string", + "format": "uuid", + "description": "The StreamingLocatorId of the Streaming Locator." + }, + "streamingPolicyName": { + "type": "string", + "description": "Name of the Streaming Policy used by this Streaming Locator. Either specify the name of Streaming Policy you created or use one of the predefined Streaming Policies. The predefined Streaming Policies available are: 'Predefined_DownloadOnly', 'Predefined_ClearStreamingOnly', 'Predefined_DownloadAndClearStreaming', 'Predefined_ClearKey', 'Predefined_MultiDrmCencStreaming' and 'Predefined_MultiDrmStreaming'" + }, + "defaultContentKeyPolicyName": { + "type": "string", + "description": "Name of the default ContentKeyPolicy used by this Streaming Locator." + }, + "contentKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/StreamingLocatorContentKey" + }, + "description": "The ContentKeys used by this Streaming Locator." + }, + "alternativeMediaId": { + "type": "string", + "description": "Alternative Media ID of this Streaming Locator" + }, + "filters": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of asset or account filters which apply to this streaming locator" + } + }, + "type": "object", + "required": [ + "assetName", + "streamingPolicyName" + ], + "description": "Properties of the Streaming Locator." + }, + "ListContentKeysResponse": { + "properties": { + "contentKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/StreamingLocatorContentKey" + }, + "description": "ContentKeys used by current Streaming Locator" + } + }, + "type": "object", + "description": "Class of response for listContentKeys action" + }, + "ListPathsResponse": { + "properties": { + "streamingPaths": { + "type": "array", + "items": { + "$ref": "#/definitions/StreamingPath" + }, + "description": "Streaming Paths supported by current Streaming Locator" + }, + "downloadPaths": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Download Paths supported by current Streaming Locator" + } + }, + "type": "object", + "description": "Class of response for listPaths action" + }, + "StreamingLocator": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StreamingLocatorProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "The system metadata relating to this resource.", + "readOnly": true + } + }, + "type": "object", + "description": "A Streaming Locator resource" + }, + "StreamingPolicyCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/StreamingPolicy" + }, + "description": "A collection of StreamingPolicy items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of StreamingPolicy items." + }, + "StreamingLocatorCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/StreamingLocator" + }, + "description": "A collection of StreamingLocator items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of StreamingLocator items." + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingPolicies": { + "get": { + "summary": "List Streaming Policies", + "description": "Lists the Streaming Policies in the account", + "operationId": "StreamingPolicies_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StreamingPolicyCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Restricts the set of items returned." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Specifies the key by which the result collection should be ordered." + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-odata": "#/definitions/StreamingPolicy", + "x-ms-examples": { + "Lists Streaming Policies": { + "$ref": "examples/streaming-policies-list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingPolicies/{streamingPolicyName}": { + "get": { + "summary": "Get a Streaming Policy", + "description": "Get the details of a Streaming Policy in the Media Services account", + "operationId": "StreamingPolicies_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StreamingPolicy" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Policy name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get a Streaming Policy by name": { + "$ref": "examples/streaming-policy-get-by-name.json" + } + } + }, + "put": { + "summary": "Create a Streaming Policy", + "description": "Create a Streaming Policy in the Media Services account", + "operationId": "StreamingPolicies_Create", + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/StreamingPolicy" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Policy name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StreamingPolicy" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Creates a Streaming Policy with clear streaming": { + "$ref": "examples/streaming-policies-create-clear.json" + }, + "Creates a Streaming Policy with envelopeEncryption only": { + "$ref": "examples/streaming-policies-create-envelopeEncryption-only.json" + }, + "Creates a Streaming Policy with commonEncryptionCenc only": { + "$ref": "examples/streaming-policies-create-commonEncryptionCenc-only.json" + }, + "Creates a Streaming Policy with commonEncryptionCbcs only": { + "$ref": "examples/streaming-policies-create-commonEncryptionCbcs-only.json" + }, + "Creates a Streaming Policy with secure streaming": { + "$ref": "examples/streaming-policies-create-secure-streaming.json" + } + } + }, + "delete": { + "summary": "Delete a Streaming Policy", + "description": "Deletes a Streaming Policy in the Media Services account", + "operationId": "StreamingPolicies_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Policy name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete a Streaming Policy": { + "$ref": "examples/streaming-policies-delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators": { + "get": { + "summary": "List Streaming Locators", + "description": "Lists the Streaming Locators in the account", + "operationId": "StreamingLocators_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StreamingLocatorCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Restricts the set of items returned." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Specifies the key by which the result collection should be ordered." + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-odata": "#/definitions/StreamingLocator", + "x-ms-examples": { + "Lists Streaming Locators": { + "$ref": "examples/streaming-locators-list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators/{streamingLocatorName}": { + "get": { + "summary": "Get a Streaming Locator", + "description": "Get the details of a Streaming Locator in the Media Services account", + "operationId": "StreamingLocators_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StreamingLocator" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingLocatorName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Locator name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get a Streaming Locator by name": { + "$ref": "examples/streaming-locators-get-by-name.json" + } + } + }, + "put": { + "summary": "Create a Streaming Locator", + "description": "Create a Streaming Locator in the Media Services account", + "operationId": "StreamingLocators_Create", + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/StreamingLocator" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingLocatorName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Locator name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StreamingLocator" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Creates a Streaming Locator with clear streaming": { + "$ref": "examples/streaming-locators-create-clear.json" + }, + "Creates a Streaming Locator with secure streaming": { + "$ref": "examples/streaming-locators-create-secure.json" + }, + "Creates a Streaming Locator with user defined content keys": { + "$ref": "examples/streaming-locators-create-secure-userDefinedContentKeys.json" + } + } + }, + "delete": { + "summary": "Delete a Streaming Locator", + "description": "Deletes a Streaming Locator in the Media Services account", + "operationId": "StreamingLocators_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingLocatorName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Locator name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete a Streaming Locator": { + "$ref": "examples/streaming-locators-delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators/{streamingLocatorName}/listContentKeys": { + "post": { + "summary": "List Content Keys", + "description": "List Content Keys used by this Streaming Locator", + "operationId": "StreamingLocators_ListContentKeys", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListContentKeysResponse" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingLocatorName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Locator name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "List Content Keys": { + "$ref": "examples/streaming-locators-list-content-keys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators/{streamingLocatorName}/listPaths": { + "post": { + "summary": "List Paths", + "description": "List Paths supported by this Streaming Locator", + "operationId": "StreamingLocators_ListPaths", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListPathsResponse" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingLocatorName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Locator name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "List Paths which has streaming paths only": { + "$ref": "examples/streaming-locators-list-paths-streaming-only.json" + }, + "List Paths which has streaming paths and download paths": { + "$ref": "examples/streaming-locators-list-paths-streaming-and-download.json" + } + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The unique identifier for a Microsoft Azure subscription." + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the Azure subscription.", + "x-ms-parameter-location": "method" + }, + "MediaServicesAccountName": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name.", + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The version of the API to be used with the client request." + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accountFilters-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accountFilters-create.json new file mode 100644 index 000000000000..3678d57c53a7 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accountFilters-create.json @@ -0,0 +1,171 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "filterName": "newAccountFilter", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "presentationTimeRange": { + "startTimestamp": 0, + "endTimestamp": 170000000, + "presentationWindowDuration": 9223372036854774806, + "liveBackoffDuration": 0, + "timescale": 10000000, + "forceEndTimestamp": false + }, + "firstQuality": { + "bitrate": 128000 + }, + "tracks": [ + { + "trackSelections": [ + { + "property": "Type", + "operation": "Equal", + "value": "Audio" + }, + { + "property": "Language", + "operation": "NotEqual", + "value": "en" + }, + { + "property": "FourCC", + "operation": "NotEqual", + "value": "EC-3" + } + ] + }, + { + "trackSelections": [ + { + "property": "Type", + "operation": "Equal", + "value": "Video" + }, + { + "property": "Bitrate", + "operation": "Equal", + "value": "3000000-5000000" + } + ] + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "name": "newAccountFilter", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/accountFilters/newAccountFilter", + "type": "Microsoft.Media/mediaservices/accountFilters", + "properties": { + "presentationTimeRange": { + "startTimestamp": 0, + "endTimestamp": 170000000, + "presentationWindowDuration": 9223372036854774806, + "liveBackoffDuration": 0, + "timescale": 10000000, + "forceEndTimestamp": false + }, + "firstQuality": { + "bitrate": 128000 + }, + "tracks": [ + { + "trackSelections": [ + { + "property": "Type", + "value": "Audio", + "operation": "Equal" + }, + { + "property": "Language", + "value": "en", + "operation": "NotEqual" + }, + { + "property": "FourCC", + "value": "EC-3", + "operation": "NotEqual" + } + ] + }, + { + "trackSelections": [ + { + "property": "Type", + "value": "Video", + "operation": "Equal" + }, + { + "property": "Bitrate", + "value": "3000000-5000000", + "operation": "Equal" + } + ] + } + ] + } + } + }, + "200": { + "body": { + "name": "newAccountFilter", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/accountFilters/newAccountFilter", + "type": "Microsoft.Media/mediaservices/accountFilters", + "properties": { + "presentationTimeRange": { + "startTimestamp": 0, + "endTimestamp": 170000000, + "presentationWindowDuration": 9223372036854774806, + "liveBackoffDuration": 0, + "timescale": 10000000, + "forceEndTimestamp": false + }, + "firstQuality": { + "bitrate": 128000 + }, + "tracks": [ + { + "trackSelections": [ + { + "property": "Type", + "value": "Audio", + "operation": "Equal" + }, + { + "property": "Language", + "value": "en", + "operation": "NotEqual" + }, + { + "property": "FourCC", + "value": "EC-3", + "operation": "NotEqual" + } + ] + }, + { + "trackSelections": [ + { + "property": "Type", + "value": "Video", + "operation": "Equal" + }, + { + "property": "Bitrate", + "value": "3000000-5000000", + "operation": "Equal" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accountFilters-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accountFilters-delete.json new file mode 100644 index 000000000000..2708ca66dc8e --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accountFilters-delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "filterName": "accountFilterWithTimeWindowAndTrack", + "api-version": "2021-06-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accountFilters-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accountFilters-get-by-name.json new file mode 100644 index 000000000000..aad8c6732ec3 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accountFilters-get-by-name.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "filterName": "accountFilterWithTrack", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "name": "accountFilterWithTrack", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/accountFilters/accountFilterWithTrack", + "type": "Microsoft.Media/mediaservices/accountFilters", + "properties": { + "tracks": [ + { + "trackSelections": [ + { + "property": "Type", + "value": "Audio", + "operation": "Equal" + }, + { + "property": "Language", + "value": "en", + "operation": "NotEqual" + }, + { + "property": "FourCC", + "value": "EC-3", + "operation": "NotEqual" + } + ] + }, + { + "trackSelections": [ + { + "property": "Type", + "value": "Video", + "operation": "Equal" + }, + { + "property": "Bitrate", + "value": "3000000-5000000", + "operation": "Equal" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accountFilters-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accountFilters-list-all.json new file mode 100644 index 000000000000..ea5d73dccb1a --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accountFilters-list-all.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "accountFilterWithTimeWindowAndTrack", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/accountFilters/accountFilterWithTimeWindowAndTrack", + "type": "Microsoft.Media/mediaservices/accountFilters", + "properties": { + "presentationTimeRange": { + "startTimestamp": 0, + "endTimestamp": 170000000, + "presentationWindowDuration": 9223372036854774806, + "liveBackoffDuration": 0, + "timescale": 10000000, + "forceEndTimestamp": false + }, + "firstQuality": { + "bitrate": 128000 + }, + "tracks": [ + { + "trackSelections": [ + { + "property": "Type", + "value": "Audio", + "operation": "Equal" + }, + { + "property": "Language", + "value": "en", + "operation": "NotEqual" + }, + { + "property": "FourCC", + "value": "EC-3", + "operation": "NotEqual" + } + ] + }, + { + "trackSelections": [ + { + "property": "Type", + "value": "Video", + "operation": "Equal" + }, + { + "property": "Bitrate", + "value": "3000000-5000000", + "operation": "Equal" + } + ] + } + ] + } + }, + { + "name": "accountFilterWithTrack", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/accountFilters/accountFilterWithTrack", + "type": "Microsoft.Media/mediaservices/accountFilters", + "properties": { + "tracks": [ + { + "trackSelections": [ + { + "property": "Type", + "value": "Audio", + "operation": "Equal" + }, + { + "property": "Language", + "value": "en", + "operation": "NotEqual" + }, + { + "property": "FourCC", + "value": "EC-3", + "operation": "NotEqual" + } + ] + }, + { + "trackSelections": [ + { + "property": "Type", + "value": "Video", + "operation": "Equal" + }, + { + "property": "Bitrate", + "value": "3000000-5000000", + "operation": "Equal" + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accountFilters-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accountFilters-update.json new file mode 100644 index 000000000000..b372fd3dadf9 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accountFilters-update.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "filterName": "accountFilterWithTimeWindowAndTrack", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "presentationTimeRange": { + "startTimestamp": 10, + "endTimestamp": 170000000, + "presentationWindowDuration": 9223372036854774806, + "liveBackoffDuration": 0, + "timescale": 10000000, + "forceEndTimestamp": false + }, + "firstQuality": { + "bitrate": 128000 + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "accountFilterWithTimeWindowAndTrack", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/accountFilters/accountFilterWithTimeWindowAndTrack", + "type": "Microsoft.Media/mediaservices/accountFilters", + "properties": { + "presentationTimeRange": { + "startTimestamp": 10, + "endTimestamp": 170000000, + "presentationWindowDuration": 9223372036854774806, + "liveBackoffDuration": 0, + "timescale": 10000000, + "forceEndTimestamp": false + }, + "firstQuality": { + "bitrate": 128000 + }, + "tracks": [ + { + "trackSelections": [ + { + "property": "Type", + "value": "Audio", + "operation": "Equal" + }, + { + "property": "Language", + "value": "en", + "operation": "NotEqual" + }, + { + "property": "FourCC", + "value": "EC-3", + "operation": "NotEqual" + } + ] + }, + { + "trackSelections": [ + { + "property": "Type", + "value": "Video", + "operation": "Equal" + }, + { + "property": "Bitrate", + "value": "3000000-5000000", + "operation": "Equal" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accounts-check-name-availability.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accounts-check-name-availability.json new file mode 100644 index 000000000000..55d75347517e --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accounts-check-name-availability.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "locationName": "japanwest", + "api-version": "2021-06-01", + "parameters": { + "name": "contosotv", + "type": "videoAnalyzers" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "reason": "None", + "message": "" + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accounts-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accounts-create.json new file mode 100644 index 000000000000..1f4a2e1bdd15 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accounts-create.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "api-version": "2021-06-01", + "parameters": { + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {} + } + }, + "properties": { + "encryption": { + "type": "CustomerKey", + "keyVaultProperties": { + "keyIdentifier": "https://keyvault.vault.azure.net/keys/key1" + }, + "identity": { + "userAssignedIdentity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1", + "useSystemAssignedIdentity": false + } + }, + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contososportsstore", + "type": "Primary", + "identity": { + "userAssignedIdentity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1", + "useSystemAssignedIdentity": false + } + } + ], + "storageAuthentication": "ManagedIdentity" + } + } + }, + "responses": { + "200": { + "body": { + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {} + } + }, + "properties": { + "encryption": { + "type": "CustomerKey", + "keyVaultProperties": { + "keyIdentifier": "https://keyvault.vault.azure.net/keys/key1", + "currentKeyIdentifier": "https://keyvault.vault.azure.net/keys/key1/ver1" + }, + "identity": { + "userAssignedIdentity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1", + "useSystemAssignedIdentity": false + } + }, + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contososportsstore", + "type": "Primary", + "identity": { + "userAssignedIdentity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1", + "useSystemAssignedIdentity": false + } + } + ], + "storageAuthentication": "ManagedIdentity" + } + } + }, + "201": { + "body": { + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {} + } + }, + "properties": { + "encryption": { + "type": "CustomerKey", + "keyVaultProperties": { + "keyIdentifier": "https://keyvault.vault.azure.net/keys/key1", + "currentKeyIdentifier": "https://keyvault.vault.azure.net/keys/key1/ver1" + }, + "identity": { + "userAssignedIdentity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1", + "useSystemAssignedIdentity": false + } + }, + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contososportsstore", + "type": "Primary", + "identity": { + "userAssignedIdentity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1", + "useSystemAssignedIdentity": false + } + } + ], + "storageAuthentication": "ManagedIdentity" + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accounts-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accounts-delete.json new file mode 100644 index 000000000000..eb2c1a559aa6 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accounts-delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "api-version": "2021-06-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accounts-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accounts-get-by-name.json new file mode 100644 index 000000000000..8d00fd023c5f --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accounts-get-by-name.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosotv", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "location": "South Central US", + "tags": { + "key1": "value3" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000" + }, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": { + "principalId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "encryption": { + "type": "CustomerKey", + "keyVaultProperties": { + "keyIdentifier": "https://keyvault.vault.azure.net/keys/key1", + "currentKeyIdentifier": "https://keyvault.vault.azure.net/keys/key1/ver1" + }, + "identity": { + "userAssignedIdentity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1", + "useSystemAssignedIdentity": false + } + }, + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contososportsstore", + "type": "Primary", + "identity": { + "userAssignedIdentity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1", + "useSystemAssignedIdentity": false + } + } + ], + "storageAuthentication": "ManagedIdentity" + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accounts-list-all-accounts.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accounts-list-all-accounts.json new file mode 100644 index 000000000000..7bc12403e23c --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accounts-list-all-accounts.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "contosotv", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosotv", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "6ac94f91-283c-4492-85a7-57976928c17d", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contosotvstore", + "type": "Primary" + } + ] + } + }, + { + "name": "contosomovies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomovies", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "72681c0f-9dd1-4f1c-95c9-8a8d7d31c4ee", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contosomoviesstore", + "type": "Primary" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accounts-list-media-edge-policies.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accounts-list-media-edge-policies.json new file mode 100644 index 000000000000..fbf5f7de8f65 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accounts-list-media-edge-policies.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "api-version": "2021-06-01", + "parameters": { + "deviceId": "contosiothubhost_contosoiotdevice" + } + }, + "responses": { + "200": { + "body": { + "usageDataCollectionPolicy": { + "dataCollectionFrequency": "PT10M", + "dataReportingFrequency": "PT1H", + "maxAllowedUnreportedUsageDuration": "PT36H", + "eventHubDetails": { + "name": "ams-x", + "namespace": "ams-y-1-1", + "token": "SharedAccessSignature sr=sb%3a%2f%2fams-x.servicebus.windows.net%2fams-y-1-1%2fPublishers%2f96a510a1-0565-492a-a67f-83d1aed1d1f6_SampleDeviceId&sig=signature_value%3d&se=1584073736&skn=EdgeUsageData" + } + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accounts-subscription-list-all-accounts.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accounts-subscription-list-all-accounts.json new file mode 100644 index 000000000000..c57a2c7dd96b --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accounts-subscription-list-all-accounts.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "contosotv", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosotv", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "6ac94f91-283c-4492-85a7-57976928c17d", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contosotvstore", + "type": "Primary" + } + ] + } + }, + { + "name": "contosomovies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomovies", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "72681c0f-9dd1-4f1c-95c9-8a8d7d31c4ee", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contosomoviesstore", + "type": "Primary" + } + ] + } + }, + { + "name": "fabrikamnews", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/fabrikamnews", + "type": "Microsoft.Media/mediaservices", + "location": "East US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "d96036f9-4e37-491d-8c29-5bc53a29dfcd", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/fabrikam/providers/Microsoft.Storage/storageAccounts/fabrikamnewsstore", + "type": "Primary" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accounts-sync-storage-keys.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accounts-sync-storage-keys.json new file mode 100644 index 000000000000..bcbcf319a67d --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accounts-sync-storage-keys.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "api-version": "2021-06-01", + "parameters": { + "id": "contososportsstore" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accounts-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accounts-update.json new file mode 100644 index 000000000000..f996b5a181b4 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/accounts-update.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "api-version": "2021-06-01", + "parameters": { + "tags": { + "key1": "value3" + } + } + }, + "responses": { + "200": { + "body": { + "location": "South Central US", + "tags": { + "key1": "value3" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {} + } + }, + "properties": { + "encryption": { + "type": "CustomerKey", + "keyVaultProperties": { + "keyIdentifier": "https://keyvault.vault.azure.net/keys/key1", + "currentKeyIdentifier": "https://keyvault.vault.azure.net/keys/key1/ver1" + }, + "identity": { + "userAssignedIdentity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1", + "useSystemAssignedIdentity": false + } + }, + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contososportsstore", + "type": "Primary", + "identity": { + "userAssignedIdentity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1", + "useSystemAssignedIdentity": false + } + } + ], + "storageAuthentication": "ManagedIdentity" + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assetFilters-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assetFilters-create.json new file mode 100644 index 000000000000..7d3f99ccd248 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assetFilters-create.json @@ -0,0 +1,172 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountRainer", + "filterName": "newAssetFilter", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "presentationTimeRange": { + "startTimestamp": 0, + "endTimestamp": 170000000, + "presentationWindowDuration": 9223372036854774806, + "liveBackoffDuration": 0, + "timescale": 10000000, + "forceEndTimestamp": false + }, + "firstQuality": { + "bitrate": 128000 + }, + "tracks": [ + { + "trackSelections": [ + { + "property": "Type", + "operation": "Equal", + "value": "Audio" + }, + { + "property": "Language", + "operation": "NotEqual", + "value": "en" + }, + { + "property": "FourCC", + "operation": "NotEqual", + "value": "EC-3" + } + ] + }, + { + "trackSelections": [ + { + "property": "Type", + "operation": "Equal", + "value": "Video" + }, + { + "property": "Bitrate", + "operation": "Equal", + "value": "3000000-5000000" + } + ] + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "name": "newAssetFilter", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountRainer/assetFilters/newAssetFilter", + "type": "Microsoft.Media/mediaservices/assets/assetFilters", + "properties": { + "presentationTimeRange": { + "startTimestamp": 0, + "endTimestamp": 170000000, + "presentationWindowDuration": 9223372036854774806, + "liveBackoffDuration": 0, + "timescale": 10000000, + "forceEndTimestamp": false + }, + "firstQuality": { + "bitrate": 128000 + }, + "tracks": [ + { + "trackSelections": [ + { + "property": "Type", + "value": "Audio", + "operation": "Equal" + }, + { + "property": "Language", + "value": "en", + "operation": "NotEqual" + }, + { + "property": "FourCC", + "value": "EC-3", + "operation": "NotEqual" + } + ] + }, + { + "trackSelections": [ + { + "property": "Type", + "value": "Video", + "operation": "Equal" + }, + { + "property": "Bitrate", + "value": "3000000-5000000", + "operation": "Equal" + } + ] + } + ] + } + } + }, + "200": { + "body": { + "name": "newAssetFilter", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountRainer/assetFilters/newAssetFilter", + "type": "Microsoft.Media/mediaservices/assets/assetFilters", + "properties": { + "presentationTimeRange": { + "startTimestamp": 0, + "endTimestamp": 170000000, + "presentationWindowDuration": 9223372036854774806, + "liveBackoffDuration": 0, + "timescale": 10000000, + "forceEndTimestamp": false + }, + "firstQuality": { + "bitrate": 128000 + }, + "tracks": [ + { + "trackSelections": [ + { + "property": "Type", + "value": "Audio", + "operation": "Equal" + }, + { + "property": "Language", + "value": "en", + "operation": "NotEqual" + }, + { + "property": "FourCC", + "value": "EC-3", + "operation": "NotEqual" + } + ] + }, + { + "trackSelections": [ + { + "property": "Type", + "value": "Video", + "operation": "Equal" + }, + { + "property": "Bitrate", + "value": "3000000-5000000", + "operation": "Equal" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assetFilters-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assetFilters-delete.json new file mode 100644 index 000000000000..792eafa85141 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assetFilters-delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountRainer", + "filterName": "assetFilterWithTimeWindowAndTrack", + "api-version": "2021-06-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assetFilters-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assetFilters-get-by-name.json new file mode 100644 index 000000000000..7899a97b6912 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assetFilters-get-by-name.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountRainer", + "filterName": "assetFilterWithTimeWindowAndTrack", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "name": "assetFilterWithTimeWindowAndTrack", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountRainer/assetFilters/assetFilterWithTimeWindowAndTrack", + "type": "Microsoft.Media/mediaservices/assets/assetFilters", + "properties": { + "presentationTimeRange": { + "startTimestamp": 0, + "endTimestamp": 170000000, + "presentationWindowDuration": 9223372036854774806, + "liveBackoffDuration": 0, + "timescale": 10000000, + "forceEndTimestamp": false + }, + "firstQuality": { + "bitrate": 128000 + }, + "tracks": [ + { + "trackSelections": [ + { + "property": "Type", + "value": "Audio", + "operation": "Equal" + }, + { + "property": "Language", + "value": "en", + "operation": "NotEqual" + }, + { + "property": "FourCC", + "value": "EC-3", + "operation": "NotEqual" + } + ] + }, + { + "trackSelections": [ + { + "property": "Type", + "value": "Video", + "operation": "Equal" + }, + { + "property": "Bitrate", + "value": "3000000-5000000", + "operation": "Equal" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assetFilters-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assetFilters-list-all.json new file mode 100644 index 000000000000..3a9e30d6d8cf --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assetFilters-list-all.json @@ -0,0 +1,131 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountRainer", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "assetFilterWithTimeWindowAndTrack", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountRainer/assetFilters/assetFilterWithTimeWindowAndTrack", + "type": "Microsoft.Media/mediaservices/assets/assetFilters", + "properties": { + "presentationTimeRange": { + "startTimestamp": 0, + "endTimestamp": 170000000, + "presentationWindowDuration": 9223372036854774806, + "liveBackoffDuration": 0, + "timescale": 10000000, + "forceEndTimestamp": false + }, + "firstQuality": { + "bitrate": 128000 + }, + "tracks": [ + { + "trackSelections": [ + { + "property": "Type", + "value": "Audio", + "operation": "Equal" + }, + { + "property": "Language", + "value": "en", + "operation": "NotEqual" + }, + { + "property": "FourCC", + "value": "EC-3", + "operation": "NotEqual" + } + ] + }, + { + "trackSelections": [ + { + "property": "Type", + "value": "Video", + "operation": "Equal" + }, + { + "property": "Bitrate", + "value": "3000000-5000000", + "operation": "Equal" + } + ] + } + ] + } + }, + { + "name": "assetFilterWithTimeWindow", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountRainer/assetFilters/assetFilterWithTimeWindow", + "type": "Microsoft.Media/mediaservices/assets/assetFilters", + "properties": { + "presentationTimeRange": { + "startTimestamp": 0, + "endTimestamp": 170000000, + "presentationWindowDuration": 9223372036854774806, + "liveBackoffDuration": 0, + "timescale": 10000000, + "forceEndTimestamp": false + }, + "firstQuality": { + "bitrate": 128000 + }, + "tracks": [] + } + }, + { + "name": "assetFilterWithTrack", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountRainer/assetFilters/assetFilterWithTrack", + "type": "Microsoft.Media/mediaservices/assets/assetFilters", + "properties": { + "tracks": [ + { + "trackSelections": [ + { + "property": "Type", + "value": "Audio", + "operation": "Equal" + }, + { + "property": "Language", + "value": "en", + "operation": "NotEqual" + }, + { + "property": "FourCC", + "value": "EC-3", + "operation": "NotEqual" + } + ] + }, + { + "trackSelections": [ + { + "property": "Type", + "value": "Video", + "operation": "Equal" + }, + { + "property": "Bitrate", + "value": "3000000-5000000", + "operation": "Equal" + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assetFilters-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assetFilters-update.json new file mode 100644 index 000000000000..81a892f6d12a --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assetFilters-update.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountRainer", + "filterName": "assetFilterWithTimeWindowAndTrack", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "presentationTimeRange": { + "startTimestamp": 10, + "endTimestamp": 170000000, + "presentationWindowDuration": 9223372036854774806, + "liveBackoffDuration": 0, + "timescale": 10000000, + "forceEndTimestamp": false + }, + "firstQuality": { + "bitrate": 128000 + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "assetFilterWithTimeWindowAndTrack", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountRainer/assetFilters/assetFilterWithTimeWindowAndTrack", + "type": "Microsoft.Media/mediaservices/assets/assetFilters", + "properties": { + "presentationTimeRange": { + "startTimestamp": 10, + "endTimestamp": 170000000, + "presentationWindowDuration": 9223372036854774806, + "liveBackoffDuration": 0, + "timescale": 10000000, + "forceEndTimestamp": false + }, + "firstQuality": { + "bitrate": 128000 + }, + "tracks": [ + { + "trackSelections": [ + { + "property": "Type", + "value": "Audio", + "operation": "Equal" + }, + { + "property": "Language", + "value": "en", + "operation": "NotEqual" + }, + { + "property": "FourCC", + "value": "EC-3", + "operation": "NotEqual" + } + ] + }, + { + "trackSelections": [ + { + "property": "Type", + "value": "Video", + "operation": "Equal" + }, + { + "property": "Bitrate", + "value": "3000000-5000000", + "operation": "Equal" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assets-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assets-create.json new file mode 100644 index 000000000000..c674417d4263 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assets-create.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountLogan", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "description": "A documentary showing the ascent of Mount Logan", + "storageAccountName": "storage0" + } + } + }, + "responses": { + "201": { + "body": { + "name": "ClimbingMountLogan", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountLogan", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "09194258-36ba-4403-abb3-68780e6bc545", + "created": "2018-08-08T18:29:26.08Z", + "lastModified": "2018-08-08T18:29:26.08Z", + "description": "A documentary showing the ascent of Mount Logan", + "container": "asset-09194258-36ba-4403-abb3-68780e6bc545", + "storageAccountName": "storage0", + "storageEncryptionFormat": "None" + } + } + }, + "200": { + "body": { + "name": "ClimbingMountLogan", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountLogan", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "09194258-36ba-4403-abb3-68780e6bc545", + "created": "2018-08-08T18:29:26.08Z", + "lastModified": "2018-08-08T18:29:26.107Z", + "description": "A documentary showing the ascent of Mount Logan", + "container": "asset-09194258-36ba-4403-abb3-68780e6bc545", + "storageAccountName": "storage0", + "storageEncryptionFormat": "None" + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assets-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assets-delete.json new file mode 100644 index 000000000000..914fc78a525b --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assets-delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountAdams", + "api-version": "2021-06-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assets-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assets-get-by-name.json new file mode 100644 index 000000000000..3cc61ca03437 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assets-get-by-name.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountAdams", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "name": "ClimbingMountAdams", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountAdams", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "1b648c1a-2268-461d-a1da-742bde23db40", + "created": "2013-02-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00002", + "description": "A documentary showing the ascent of Mount Adams", + "container": "asset-1b648c1a-2268-461d-a1da-742bde23db40", + "storageEncryptionFormat": "None" + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assets-get-encryption-keys.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assets-get-encryption-keys.json new file mode 100644 index 000000000000..47dfc952ba80 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assets-get-encryption-keys.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountSaintHelens", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "key": "AAAAAAAAAAAAAAAAAAAAAA==", + "assetFileEncryptionMetadata": [ + { + "initializationVector": "-988929866", + "assetFileName": "AssetFile0", + "assetFileId": "a9536fa7-bd5d-4f84-a137-d1290982fe95" + }, + { + "initializationVector": "1604993689", + "assetFileName": "AssetFile1", + "assetFileId": "f4060046-94ac-422d-824c-3f1d6aa3ecf2" + }, + { + "initializationVector": "100082635", + "assetFileName": "AssetFile2", + "assetFileId": "485968d3-ddae-4b13-98e7-901201a9620b" + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assets-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assets-list-all.json new file mode 100644 index 000000000000..f7a9e90f6143 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assets-list-all.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ClimbingLittleTahoma", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingLittleTahoma", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "e6c7ee55-d1f5-48bc-9c36-2d2157aadbbe", + "created": "2012-04-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00003", + "description": "A documentary showing the ascent of Little Tahoma", + "container": "asset-e6c7ee55-d1f5-48bc-9c36-2d2157aadbbe", + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountAdams", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountAdams", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "1b648c1a-2268-461d-a1da-742bde23db40", + "created": "2013-02-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00002", + "description": "A documentary showing the ascent of Mount Adams", + "container": "asset-1b648c1a-2268-461d-a1da-742bde23db40", + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountBaker", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountBaker", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "89af1750-e681-4fbe-8c4c-9a5567867a6b", + "created": "2011-02-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00004", + "description": "A documentary showing the ascent of Mount Baker", + "container": "asset-89af1750-e681-4fbe-8c4c-9a5567867a6b", + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountRainer", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountRainer", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "258878ef-fe05-4518-988f-052e86dc19f6", + "created": "2018-08-08T18:29:24.3948982Z", + "lastModified": "2018-08-08T21:29:24.3948982Z", + "alternateId": "altClimbingMountRainer", + "description": "descClimbingMountRainer", + "container": "testasset0", + "storageAccountName": "storage0", + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountRainier", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountRainier", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "f8eea45c-b814-44c2-9c42-a5174ebdee4c", + "created": "2012-11-01T00:00:00Z", + "lastModified": "2012-11-01T00:00:00Z", + "alternateId": "CLIMB00001", + "description": "A documentary showing the ascent of Mount Rainier", + "container": "asset-f8eea45c-b814-44c2-9c42-a5174ebdee4c", + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountSaintHelens", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountSaintHelens", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "14d58c40-ec1f-446c-b041-f5cff949bd1d", + "created": "2013-03-01T00:00:00Z", + "lastModified": "2013-04-01T00:00:00Z", + "alternateId": "CLIMB00005", + "description": "A documentary showing the ascent of Saint Helens", + "container": "asset-14d58c40-ec1f-446c-b041-f5cff949bd1d", + "storageEncryptionFormat": "MediaStorageClientEncryption" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assets-list-by-date.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assets-list-by-date.json new file mode 100644 index 000000000000..387df1a9daea --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assets-list-by-date.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2021-06-01", + "$orderby": "properties/created" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ClimbingMountBaker", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountBaker", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "89af1750-e681-4fbe-8c4c-9a5567867a6b", + "created": "2011-02-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00004", + "description": "A documentary showing the ascent of Mount Baker", + "container": "asset-89af1750-e681-4fbe-8c4c-9a5567867a6b", + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingLittleTahoma", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingLittleTahoma", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "e6c7ee55-d1f5-48bc-9c36-2d2157aadbbe", + "created": "2012-04-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00003", + "description": "A documentary showing the ascent of Little Tahoma", + "container": "asset-e6c7ee55-d1f5-48bc-9c36-2d2157aadbbe", + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountRainier", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountRainier", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "f8eea45c-b814-44c2-9c42-a5174ebdee4c", + "created": "2012-11-01T00:00:00Z", + "lastModified": "2012-11-01T00:00:00Z", + "alternateId": "CLIMB00001", + "description": "A documentary showing the ascent of Mount Rainier", + "container": "asset-f8eea45c-b814-44c2-9c42-a5174ebdee4c", + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountAdams", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountAdams", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "1b648c1a-2268-461d-a1da-742bde23db40", + "created": "2013-02-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00002", + "description": "A documentary showing the ascent of Mount Adams", + "container": "asset-1b648c1a-2268-461d-a1da-742bde23db40", + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountSaintHelens", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountSaintHelens", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "14d58c40-ec1f-446c-b041-f5cff949bd1d", + "created": "2013-03-01T00:00:00Z", + "lastModified": "2013-04-01T00:00:00Z", + "alternateId": "CLIMB00005", + "description": "A documentary showing the ascent of Saint Helens", + "container": "asset-14d58c40-ec1f-446c-b041-f5cff949bd1d", + "storageEncryptionFormat": "MediaStorageClientEncryption" + } + }, + { + "name": "ClimbingMountRainer", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountRainer", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "8cdacfe5-8473-413a-9aec-dd2a478b37c8", + "created": "2018-08-08T18:29:25.0514734Z", + "lastModified": "2018-08-08T21:29:25.0514734Z", + "alternateId": "altClimbingMountRainer", + "description": "descClimbingMountRainer", + "container": "testasset0", + "storageAccountName": "storage0", + "storageEncryptionFormat": "None" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assets-list-in-date-range.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assets-list-in-date-range.json new file mode 100644 index 000000000000..8df197374f2a --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assets-list-in-date-range.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2021-06-01", + "$orderby": "properties/created", + "$filter": "properties/created gt 2012-06-01 and properties/created lt 2013-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ClimbingMountRainier", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountRainier", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "f8eea45c-b814-44c2-9c42-a5174ebdee4c", + "created": "2012-11-01T00:00:00Z", + "lastModified": "2012-11-01T00:00:00Z", + "alternateId": "CLIMB00001", + "description": "A documentary showing the ascent of Mount Rainier", + "container": "asset-f8eea45c-b814-44c2-9c42-a5174ebdee4c", + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountAdams", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountAdams", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "1b648c1a-2268-461d-a1da-742bde23db40", + "created": "2013-02-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00002", + "description": "A documentary showing the ascent of Mount Adams", + "container": "asset-1b648c1a-2268-461d-a1da-742bde23db40", + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountSaintHelens", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountSaintHelens", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "14d58c40-ec1f-446c-b041-f5cff949bd1d", + "created": "2013-03-01T00:00:00Z", + "lastModified": "2013-04-01T00:00:00Z", + "alternateId": "CLIMB00005", + "description": "A documentary showing the ascent of Saint Helens", + "container": "asset-14d58c40-ec1f-446c-b041-f5cff949bd1d", + "storageEncryptionFormat": "MediaStorageClientEncryption" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assets-list-sas-urls.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assets-list-sas-urls.json new file mode 100644 index 000000000000..161338c42b61 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assets-list-sas-urls.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountBaker", + "api-version": "2021-06-01", + "parameters": { + "permissions": "ReadWrite", + "expiryTime": "2018-01-01T10:00:00.007Z" + } + }, + "responses": { + "200": { + "body": { + "assetContainerSasUrls": [ + "https://storage0.blob.core.windows.net/asset-89af1750-e681-4fbe-8c4c-9a5567867a6b?sr=b&sig=&se=2018-01-01T10:00:00Z&sp=lrw", + "https://storage0.blob.core.windows.net/asset-89af1750-e681-4fbe-8c4c-9a5567867a6b?sr=b&sig=&se=2018-01-01T10:00:00Z&sp=lrw" + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assets-list-streaming-locators.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assets-list-streaming-locators.json new file mode 100644 index 000000000000..fb8ef0619d5b --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assets-list-streaming-locators.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountSaintHelens", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "streamingLocators": [ + { + "name": "secureStreamingLocator", + "assetName": "ClimbingMountSaintHelens", + "created": "2018-08-08T18:29:26.9729344Z", + "endTime": "9999-12-31T23:59:59.9999999Z", + "streamingLocatorId": "36b74ce3-20b4-4de0-84f1-97e9138e886c", + "streamingPolicyName": "secureStreamingPolicy" + }, + { + "name": "clearStreamingLocator", + "assetName": "ClimbingMountSaintHelens", + "created": "2018-08-08T18:29:26.9487636Z", + "endTime": "9999-12-31T23:59:59.9999999Z", + "streamingLocatorId": "3e8d9ac3-50f6-4f6d-8482-078ceb56f23a", + "streamingPolicyName": "clearStreamingPolicy" + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assets-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assets-update.json new file mode 100644 index 000000000000..ddd6e55d9ddb --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/assets-update.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountBaker", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "description": "A documentary showing the ascent of Mount Baker in HD" + } + } + }, + "responses": { + "200": { + "body": { + "name": "ClimbingMountBaker", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountBaker", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "89af1750-e681-4fbe-8c4c-9a5567867a6b", + "created": "2011-02-01T00:00:00Z", + "lastModified": "2018-08-08T18:29:26.503Z", + "alternateId": "CLIMB00004", + "description": "A documentary showing the ascent of Mount Baker in HD", + "container": "asset-89af1750-e681-4fbe-8c4c-9a5567867a6b", + "storageEncryptionFormat": "None" + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-create-multiple-options.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-create-multiple-options.json new file mode 100644 index 000000000000..84062f1454c9 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-create-multiple-options.json @@ -0,0 +1,134 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyCreatedWithMultipleOptions", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "description": "ArmPolicyDescription", + "options": [ + { + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "AAAAAAAAAAAAAAAAAAAAAA==" + }, + "restrictionTokenType": "Swt" + } + }, + { + "name": "widevineoption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "PolicyCreatedWithMultipleOptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyCreatedWithMultipleOptions", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "07ad673b-dc14-4230-adab-716622f33992", + "created": "2018-08-08T18:29:29.98Z", + "lastModified": "2018-08-08T18:29:29.98Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "8dac9510-770a-401f-8f2b-f72640977ed0", + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [], + "restrictionTokenType": "Swt" + } + }, + { + "policyOptionId": "fc121776-6ced-4135-be92-f928dedc029a", + "name": "widevineoption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + }, + "201": { + "body": { + "name": "PolicyCreatedWithMultipleOptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyCreatedWithMultipleOptions", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "07ad673b-dc14-4230-adab-716622f33992", + "created": "2018-08-08T18:29:29.98Z", + "lastModified": "2018-08-08T18:29:29.98Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "8dac9510-770a-401f-8f2b-f72640977ed0", + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [], + "restrictionTokenType": "Swt" + } + }, + { + "policyOptionId": "fc121776-6ced-4135-be92-f928dedc029a", + "name": "widevineoption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-create-nodrm-token.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-create-nodrm-token.json new file mode 100644 index 000000000000..ea8d89f56542 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-create-nodrm-token.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyWithClearKeyOptionAndSwtTokenRestriction", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "description": "ArmPolicyDescription", + "options": [ + { + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "AAAAAAAAAAAAAAAAAAAAAA==" + }, + "restrictionTokenType": "Swt" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "PolicyWithClearKeyOptionAndSwtTokenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithClearKeyOptionAndSwtTokenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "2926c1bc-4dec-4a11-9d19-3f99006530a9", + "created": "2018-08-08T18:29:29.837Z", + "lastModified": "2018-08-08T18:29:29.837Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "e7d4d465-b6f7-4830-9a21-74a7326ef797", + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [], + "restrictionTokenType": "Swt" + } + } + ] + } + } + }, + "201": { + "body": { + "name": "PolicyWithClearKeyOptionAndSwtTokenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithClearKeyOptionAndSwtTokenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "2926c1bc-4dec-4a11-9d19-3f99006530a9", + "created": "2018-08-08T18:29:29.837Z", + "lastModified": "2018-08-08T18:29:29.837Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "e7d4d465-b6f7-4830-9a21-74a7326ef797", + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [], + "restrictionTokenType": "Swt" + } + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-create-playready-open.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-create-playready-open.json new file mode 100644 index 000000000000..4cad352b5e18 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-create-playready-open.json @@ -0,0 +1,131 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyWithPlayReadyOptionAndOpenRestriction", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "description": "ArmPolicyDescription", + "options": [ + { + "name": "ArmPolicyOptionName", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration", + "licenses": [ + { + "allowTestDevices": true, + "beginDate": "2017-10-16T18:22:53.46Z", + "playRight": { + "scmsRestriction": 2, + "digitalVideoOnlyContentRestriction": false, + "imageConstraintForAnalogComponentVideoRestriction": true, + "imageConstraintForAnalogComputerMonitorRestriction": false, + "allowPassingVideoContentToUnknownOutput": "NotAllowed" + }, + "licenseType": "Persistent", + "contentKeyLocation": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader" + }, + "contentType": "UltraVioletDownload" + } + ] + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "PolicyWithPlayReadyOptionAndOpenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithPlayReadyOptionAndOpenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "a9bacd1d-60f5-4af3-8d2b-cf46ca5c9b04", + "created": "2012-11-01T00:00:00Z", + "lastModified": "2018-08-08T18:29:29.51Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "c52f9af0-1f53-4775-8edb-af2d9a6e28cd", + "name": "ArmPolicyOptionName", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration", + "licenses": [ + { + "allowTestDevices": true, + "beginDate": "2017-10-16T18:22:53.46Z", + "playRight": { + "scmsRestriction": 2, + "digitalVideoOnlyContentRestriction": false, + "imageConstraintForAnalogComponentVideoRestriction": true, + "imageConstraintForAnalogComputerMonitorRestriction": false, + "allowPassingVideoContentToUnknownOutput": "NotAllowed" + }, + "licenseType": "Persistent", + "contentKeyLocation": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader" + }, + "contentType": "UltraVioletDownload" + } + ] + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + }, + "201": { + "body": { + "name": "PolicyWithPlayReadyOptionAndOpenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithPlayReadyOptionAndOpenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "a9bacd1d-60f5-4af3-8d2b-cf46ca5c9b04", + "created": "2012-11-01T00:00:00Z", + "lastModified": "2018-08-08T18:29:29.51Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "c52f9af0-1f53-4775-8edb-af2d9a6e28cd", + "name": "ArmPolicyOptionName", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration", + "licenses": [ + { + "allowTestDevices": true, + "beginDate": "2017-10-16T18:22:53.46Z", + "playRight": { + "scmsRestriction": 2, + "digitalVideoOnlyContentRestriction": false, + "imageConstraintForAnalogComponentVideoRestriction": true, + "imageConstraintForAnalogComputerMonitorRestriction": false, + "allowPassingVideoContentToUnknownOutput": "NotAllowed" + }, + "licenseType": "Persistent", + "contentKeyLocation": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader" + }, + "contentType": "UltraVioletDownload" + } + ] + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-create-widevine-token.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-create-widevine-token.json new file mode 100644 index 000000000000..12680021b1f6 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-create-widevine-token.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyWithWidevineOptionAndJwtTokenRestriction", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "description": "ArmPolicyDescription", + "options": [ + { + "name": "widevineoption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyRsaTokenKey", + "exponent": "AQAB", + "modulus": "AQAD" + }, + "alternateVerificationKeys": [ + { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "AAAAAAAAAAAAAAAAAAAAAA==" + } + ], + "restrictionTokenType": "Jwt" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "PolicyWithWidevineOptionAndJwtTokenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithWidevineOptionAndJwtTokenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "bad1d030-7d5c-4643-8f1e-49807a4bf64c", + "created": "2018-08-08T18:29:29.663Z", + "lastModified": "2018-08-08T18:29:29.663Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "26fee004-8dfa-4828-bcad-5e63c637534f", + "name": "widevineoption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyRsaTokenKey", + "exponent": "", + "modulus": "" + }, + "alternateVerificationKeys": [ + { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + } + ], + "requiredClaims": [], + "restrictionTokenType": "Jwt" + } + } + ] + } + } + }, + "201": { + "body": { + "name": "PolicyWithWidevineOptionAndJwtTokenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithWidevineOptionAndJwtTokenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "bad1d030-7d5c-4643-8f1e-49807a4bf64c", + "created": "2018-08-08T18:29:29.663Z", + "lastModified": "2018-08-08T18:29:29.663Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "26fee004-8dfa-4828-bcad-5e63c637534f", + "name": "widevineoption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyRsaTokenKey", + "exponent": "", + "modulus": "" + }, + "alternateVerificationKeys": [ + { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + } + ], + "requiredClaims": [], + "restrictionTokenType": "Jwt" + } + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-delete.json new file mode 100644 index 000000000000..13644726aa70 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyWithPlayReadyOptionAndOpenRestriction", + "api-version": "2021-06-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-get-by-name.json new file mode 100644 index 000000000000..1b5402d59454 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-get-by-name.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyWithMultipleOptions", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "name": "PolicyWithMultipleOptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithMultipleOptions", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "ed7f3d1b-cfa7-4181-b966-e0b3027eec3a", + "created": "2015-12-01T00:00:00Z", + "lastModified": "2016-12-02T00:00:00Z", + "description": "A policy with multiple options.", + "options": [ + { + "policyOptionId": "caf1e28c-8288-4301-8c46-c0f9312c512f", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "http://testacs", + "audience": "urn:test", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [ + { + "claimType": "urn:microsoft:azure:mediaservices:contentkeyidentifier" + }, + { + "claimType": "DRM", + "claimValue": "Widevine" + } + ], + "restrictionTokenType": "Jwt" + } + }, + { + "policyOptionId": "da346259-0cd6-4609-89dc-15ac131bd92f", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-get-with-secrets.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-get-with-secrets.json new file mode 100644 index 000000000000..daea89237e7f --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-get-with-secrets.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyWithMultipleOptions", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "policyId": "ed7f3d1b-cfa7-4181-b966-e0b3027eec3a", + "created": "2015-12-01T00:00:00Z", + "lastModified": "2016-12-02T00:00:00Z", + "description": "A policy with multiple options.", + "options": [ + { + "policyOptionId": "caf1e28c-8288-4301-8c46-c0f9312c512f", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "http://testacs", + "audience": "urn:test", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "AAA=" + }, + "alternateVerificationKeys": [], + "requiredClaims": [ + { + "claimType": "urn:microsoft:azure:mediaservices:contentkeyidentifier" + }, + { + "claimType": "DRM", + "claimValue": "Widevine" + } + ], + "restrictionTokenType": "Jwt" + } + }, + { + "policyOptionId": "da346259-0cd6-4609-89dc-15ac131bd92f", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-list-all.json new file mode 100644 index 000000000000..6d87848bd9cf --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-list-all.json @@ -0,0 +1,165 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "PolicyWithClearKeyOptionAndTokenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithClearKeyOptionAndTokenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "8352435b-ebea-4681-aae7-e19277771f64", + "created": "2017-12-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "description": "A policy with one ClearKey option and Open Restriction.", + "options": [ + { + "policyOptionId": "a3448d09-567a-4642-8309-d17e846be59f", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "http://testacs", + "audience": "urn:test", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [ + { + "claimType": "urn:microsoft:azure:mediaservices:contentkeyidentifier", + "claimValue": null + }, + { + "claimType": "DRM", + "claimValue": "Widevine" + } + ], + "restrictionTokenType": "Jwt", + "openIdConnectDiscoveryDocument": null + } + } + ] + } + }, + { + "name": "PolicyWithMultipleOptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithMultipleOptions", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "ed7f3d1b-cfa7-4181-b966-e0b3027eec3a", + "created": "2015-12-01T00:00:00Z", + "lastModified": "2016-12-02T00:00:00Z", + "description": "A policy with multiple options.", + "options": [ + { + "policyOptionId": "caf1e28c-8288-4301-8c46-c0f9312c512f", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "http://testacs", + "audience": "urn:test", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [ + { + "claimType": "urn:microsoft:azure:mediaservices:contentkeyidentifier", + "claimValue": null + }, + { + "claimType": "DRM", + "claimValue": "Widevine" + } + ], + "restrictionTokenType": "Jwt", + "openIdConnectDiscoveryDocument": null + } + }, + { + "policyOptionId": "da346259-0cd6-4609-89dc-15ac131bd92f", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + }, + { + "name": "PolicyWithPlayReadyOptionAndOpenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithPlayReadyOptionAndOpenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "a9bacd1d-60f5-4af3-8d2b-cf46ca5c9b04", + "created": "2012-11-01T00:00:00Z", + "lastModified": "2012-11-01T00:00:00Z", + "description": "A policy with one PlayReady option and Open Restriction.", + "options": [ + { + "policyOptionId": "294a833f-f128-48be-9edf-8d1bb5b35ff3", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration", + "licenses": [ + { + "allowTestDevices": false, + "beginDate": null, + "expirationDate": null, + "relativeBeginDate": null, + "relativeExpirationDate": null, + "gracePeriod": null, + "playRight": { + "firstPlayExpiration": null, + "scmsRestriction": null, + "agcAndColorStripeRestriction": null, + "explicitAnalogTelevisionOutputRestriction": null, + "digitalVideoOnlyContentRestriction": false, + "imageConstraintForAnalogComponentVideoRestriction": false, + "imageConstraintForAnalogComputerMonitorRestriction": false, + "allowPassingVideoContentToUnknownOutput": "NotAllowed", + "uncompressedDigitalVideoOpl": null, + "compressedDigitalVideoOpl": null, + "analogVideoOpl": null, + "compressedDigitalAudioOpl": null, + "uncompressedDigitalAudioOpl": null + }, + "licenseType": "NonPersistent", + "contentKeyLocation": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader" + }, + "contentType": "Unspecified" + } + ], + "responseCustomData": "testCustomData" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-list-by-lastModified.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-list-by-lastModified.json new file mode 100644 index 000000000000..1353f23450b4 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-list-by-lastModified.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2021-06-01", + "$orderby": "properties/lastModified" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "PolicyWithPlayReadyOptionAndOpenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithPlayReadyOptionAndOpenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "a9bacd1d-60f5-4af3-8d2b-cf46ca5c9b04", + "created": "2012-11-01T00:00:00Z", + "lastModified": "2012-11-01T00:00:00Z", + "description": "A policy with one PlayReady option and Open Restriction.", + "options": [ + { + "policyOptionId": "294a833f-f128-48be-9edf-8d1bb5b35ff3", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration", + "licenses": [ + { + "allowTestDevices": false, + "playRight": { + "digitalVideoOnlyContentRestriction": false, + "imageConstraintForAnalogComponentVideoRestriction": false, + "imageConstraintForAnalogComputerMonitorRestriction": false, + "allowPassingVideoContentToUnknownOutput": "NotAllowed" + }, + "licenseType": "NonPersistent", + "contentKeyLocation": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader" + }, + "contentType": "Unspecified" + } + ], + "responseCustomData": "testCustomData" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + }, + { + "name": "PolicyWithMultipleOptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithMultipleOptions", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "ed7f3d1b-cfa7-4181-b966-e0b3027eec3a", + "created": "2015-12-01T00:00:00Z", + "lastModified": "2016-12-02T00:00:00Z", + "description": "A policy with multiple options.", + "options": [ + { + "policyOptionId": "caf1e28c-8288-4301-8c46-c0f9312c512f", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "http://testacs", + "audience": "urn:test", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [ + { + "claimType": "urn:microsoft:azure:mediaservices:contentkeyidentifier" + }, + { + "claimType": "DRM", + "claimValue": "Widevine" + } + ], + "restrictionTokenType": "Jwt" + } + }, + { + "policyOptionId": "da346259-0cd6-4609-89dc-15ac131bd92f", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + }, + { + "name": "PolicyWithClearKeyOptionAndTokenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithClearKeyOptionAndTokenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "8352435b-ebea-4681-aae7-e19277771f64", + "created": "2017-12-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "description": "A policy with one ClearKey option and Open Restriction.", + "options": [ + { + "policyOptionId": "a3448d09-567a-4642-8309-d17e846be59f", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "http://testacs", + "audience": "urn:test", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [ + { + "claimType": "urn:microsoft:azure:mediaservices:contentkeyidentifier" + }, + { + "claimType": "DRM", + "claimValue": "Widevine" + } + ], + "restrictionTokenType": "Jwt" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-list-in-date-range.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-list-in-date-range.json new file mode 100644 index 000000000000..52dbd3536d06 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-list-in-date-range.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2021-06-01", + "$filter": "properties/lastModified gt 2016-06-01 and properties/created lt 2013-07-01" + }, + "responses": { + "200": { + "body": { + "value": [] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-update.json new file mode 100644 index 000000000000..7a818eefc48e --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/content-key-policies-update.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyWithClearKeyOptionAndTokenRestriction", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "description": "Updated Policy", + "options": [ + { + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "PolicyWithClearKeyOptionAndTokenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithClearKeyOptionAndTokenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "8352435b-ebea-4681-aae7-e19277771f64", + "created": "2017-12-01T00:00:00Z", + "lastModified": "2018-08-08T18:29:30.303Z", + "description": "Updated Policy", + "options": [ + { + "policyOptionId": "7d3f4bc1-d2bf-43a3-b02e-a7e31ab15d43", + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-cancel.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-cancel.json new file mode 100644 index 000000000000..bdc89d0623b3 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-cancel.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "exampleTransform", + "jobName": "job1" + }, + "responses": { + "200": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-create.json new file mode 100644 index 000000000000..b4b7674a01de --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-create.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "exampleTransform", + "jobName": "job1", + "parameters": { + "properties": { + "input": { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "assetName": "job1-InputAsset" + }, + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "assetName": "job1-OutputAsset" + } + ], + "correlationData": { + "key1": "value1", + "Key 2": "Value 2" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "job1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job1", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2021-07-12T10:44:30.6393998Z", + "state": "Queued", + "input": { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "inputDefinitions": [], + "assetName": "job1-InputAsset" + }, + "lastModified": "2021-07-12T10:44:30.6393998Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Queued", + "progress": 0, + "label": "BuiltInStandardEncoderPreset_0", + "assetName": "job1-OutputAsset" + } + ], + "priority": "Normal", + "correlationData": { + "key1": "value1", + "Key 2": "Value 2" + } + }, + "systemData": { + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-12T10:44:30.6393998Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-12T10:44:30.6393998Z" + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-delete.json new file mode 100644 index 000000000000..c3b45361eadb --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "exampleTransform", + "jobName": "jobToDelete" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-get-by-name.json new file mode 100644 index 000000000000..6ca9306e13af --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-get-by-name.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "exampleTransform", + "jobName": "job1" + }, + "responses": { + "200": { + "body": { + "name": "job1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job1", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2021-06-01T00:00:00Z", + "state": "Queued", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "inputDefinitions": [], + "assetName": "job1-InputAsset" + } + ] + }, + "lastModified": "2021-06-01T00:00:00Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Queued", + "progress": 0, + "label": "example-custom-label", + "assetName": "job1-OutputAsset" + } + ], + "priority": "Low", + "correlationData": {} + }, + "systemData": { + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "createdAt": "2021-06-01T00:00:00Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-01T00:00:00Z" + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-list-all-filter-by-created.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-list-all-filter-by-created.json new file mode 100644 index 000000000000..473cd7dc00fd --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-list-all-filter-by-created.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "exampleTransform", + "$filter": "properties/created ge 2021-06-01T00:00:10.0000000Z and properties/created le 2021-06-01T00:00:20.0000000Z", + "$orderby": "properties/created" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "job2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job2", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2021-06-01T00:00:10Z", + "state": "Processing", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "inputDefinitions": [], + "assetName": "job2-InputAsset" + } + ] + }, + "lastModified": "2021-06-01T00:00:10Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Processing", + "progress": 50, + "label": "example-custom-label", + "startTime": "2021-07-12T10:34:30.4143905Z", + "assetName": "job2-OutputAsset" + } + ], + "priority": "Low", + "correlationData": {}, + "startTime": "2021-07-12T10:34:30.4143905Z" + }, + "systemData": { + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "createdAt": "2021-06-01T00:00:10Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-01T00:00:10Z" + } + }, + { + "name": "job3", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job3", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2021-06-01T00:00:20Z", + "state": "Finished", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "inputDefinitions": [], + "assetName": "job3-InputAsset" + } + ] + }, + "lastModified": "2021-06-01T00:00:20Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Finished", + "progress": 100, + "label": "example-custom-label", + "startTime": "2021-07-12T10:34:30.4143905Z", + "endTime": "2021-07-12T10:44:30.4143905Z", + "assetName": "job3-OutputAsset" + } + ], + "priority": "Low", + "correlationData": {}, + "startTime": "2021-07-12T10:34:30.4143905Z", + "endTime": "2021-07-12T10:44:30.4143905Z" + }, + "systemData": { + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "createdAt": "2021-06-01T00:00:20Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-01T00:00:20Z" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-list-all-filter-by-lastmodified.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-list-all-filter-by-lastmodified.json new file mode 100644 index 000000000000..496f89138580 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-list-all-filter-by-lastmodified.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "exampleTransform", + "$filter": "properties/lastmodified ge 2021-06-01T00:00:10.0000000Z and properties/lastmodified le 2021-06-01T00:00:20.0000000Z", + "$orderby": "properties/lastmodified desc" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "job3", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job3", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2021-06-01T00:00:20Z", + "state": "Finished", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "inputDefinitions": [], + "assetName": "job3-InputAsset" + } + ] + }, + "lastModified": "2021-06-01T00:00:20Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Finished", + "progress": 100, + "label": "example-custom-label", + "startTime": "2021-07-12T10:34:30.4893941Z", + "endTime": "2021-07-12T10:44:30.4893941Z", + "assetName": "job3-OutputAsset" + } + ], + "priority": "Low", + "correlationData": {}, + "startTime": "2021-07-12T10:34:30.4893941Z", + "endTime": "2021-07-12T10:44:30.4893941Z" + }, + "systemData": { + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "createdAt": "2021-06-01T00:00:20Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-01T00:00:20Z" + } + }, + { + "name": "job2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job2", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2021-06-01T00:00:10Z", + "state": "Processing", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "inputDefinitions": [], + "assetName": "job2-InputAsset" + } + ] + }, + "lastModified": "2021-06-01T00:00:10Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Processing", + "progress": 50, + "label": "example-custom-label", + "startTime": "2021-07-12T10:34:30.4893941Z", + "assetName": "job2-OutputAsset" + } + ], + "priority": "Low", + "correlationData": {}, + "startTime": "2021-07-12T10:34:30.4893941Z" + }, + "systemData": { + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "createdAt": "2021-06-01T00:00:10Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-01T00:00:10Z" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-list-all-filter-by-name-and-state.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-list-all-filter-by-name-and-state.json new file mode 100644 index 000000000000..ed9aa5682163 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-list-all-filter-by-name-and-state.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "exampleTransform", + "$filter": "name eq 'job3' and properties/state eq Microsoft.Media.JobState'finished'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "job3", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job3", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2021-06-01T00:00:00Z", + "state": "Finished", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "inputDefinitions": [], + "assetName": "job3-InputAsset" + } + ] + }, + "lastModified": "2021-06-01T00:00:00Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Finished", + "progress": 100, + "label": "example-custom-label", + "startTime": "2021-07-12T10:34:30.3393701Z", + "endTime": "2021-07-12T10:44:30.3393701Z", + "assetName": "job3-OutputAsset" + } + ], + "priority": "Low", + "correlationData": {}, + "startTime": "2021-07-12T10:34:30.3393701Z", + "endTime": "2021-07-12T10:44:30.3393701Z" + }, + "systemData": { + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "createdAt": "2021-06-01T00:00:00Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-01T00:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-list-all-filter-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-list-all-filter-by-name.json new file mode 100644 index 000000000000..b5d39e2ed042 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-list-all-filter-by-name.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "exampleTransform", + "$filter": "name eq 'job1' or name eq 'job2'", + "$orderby": "name" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "job1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job1", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2021-06-01T00:00:00Z", + "state": "Queued", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "inputDefinitions": [], + "assetName": "job1-InputAsset" + } + ] + }, + "lastModified": "2021-06-01T00:00:00Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Queued", + "progress": 0, + "label": "example-custom-label", + "assetName": "job1-OutputAsset" + } + ], + "priority": "Low", + "correlationData": {} + }, + "systemData": { + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "createdAt": "2021-06-01T00:00:00Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-01T00:00:00Z" + } + }, + { + "name": "job2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job2", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2021-06-01T00:00:00Z", + "state": "Processing", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "inputDefinitions": [], + "assetName": "job2-InputAsset" + } + ] + }, + "lastModified": "2021-06-01T00:00:00Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Processing", + "progress": 50, + "label": "example-custom-label", + "startTime": "2021-07-12T10:34:30.0631403Z", + "assetName": "job2-OutputAsset" + } + ], + "priority": "Low", + "correlationData": {}, + "startTime": "2021-07-12T10:34:30.0631403Z" + }, + "systemData": { + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "createdAt": "2021-06-01T00:00:00Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-01T00:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-list-all-filter-by-state-eq.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-list-all-filter-by-state-eq.json new file mode 100644 index 000000000000..d8c35415641d --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-list-all-filter-by-state-eq.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "exampleTransform", + "$filter": "properties/state eq Microsoft.Media.JobState'Processing'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "job2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job2", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2021-06-01T00:00:00Z", + "state": "Processing", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "inputDefinitions": [], + "assetName": "job2-InputAsset" + } + ] + }, + "lastModified": "2021-06-01T00:00:00Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Processing", + "progress": 50, + "label": "example-custom-label", + "startTime": "2021-07-12T10:34:30.1393325Z", + "assetName": "job2-OutputAsset" + } + ], + "priority": "Low", + "correlationData": {}, + "startTime": "2021-07-12T10:34:30.1393325Z" + }, + "systemData": { + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "createdAt": "2021-06-01T00:00:00Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-01T00:00:00Z" + } + }, + { + "name": "job3", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job3", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2021-06-01T00:00:00Z", + "state": "Processing", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "inputDefinitions": [], + "assetName": "job3-InputAsset" + } + ] + }, + "lastModified": "2021-06-01T00:00:00Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Processing", + "progress": 50, + "label": "example-custom-label", + "startTime": "2021-07-12T10:34:30.1393325Z", + "assetName": "job3-OutputAsset" + } + ], + "priority": "Low", + "correlationData": {}, + "startTime": "2021-07-12T10:34:30.1393325Z" + }, + "systemData": { + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "createdAt": "2021-06-01T00:00:00Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-01T00:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-list-all-filter-by-state-ne.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-list-all-filter-by-state-ne.json new file mode 100644 index 000000000000..291fd08f8403 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-list-all-filter-by-state-ne.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "exampleTransform", + "$filter": "properties/state ne Microsoft.Media.JobState'processing'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "job1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job1", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2021-06-01T00:00:00Z", + "state": "Queued", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "inputDefinitions": [], + "assetName": "job1-InputAsset" + } + ] + }, + "lastModified": "2021-06-01T00:00:00Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Queued", + "progress": 0, + "label": "example-custom-label", + "assetName": "job1-OutputAsset" + } + ], + "priority": "Low", + "correlationData": {} + }, + "systemData": { + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "createdAt": "2021-06-01T00:00:00Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-01T00:00:00Z" + } + }, + { + "name": "job4", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job4", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2021-06-01T00:00:00Z", + "state": "Finished", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "inputDefinitions": [], + "assetName": "job4-InputAsset" + } + ] + }, + "lastModified": "2021-06-01T00:00:00Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Finished", + "progress": 100, + "label": "example-custom-label", + "startTime": "2021-07-12T10:34:30.2743374Z", + "endTime": "2021-07-12T10:44:30.2743374Z", + "assetName": "job4-OutputAsset" + } + ], + "priority": "Low", + "correlationData": {}, + "startTime": "2021-07-12T10:34:30.2743374Z", + "endTime": "2021-07-12T10:44:30.2743374Z" + }, + "systemData": { + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "createdAt": "2021-06-01T00:00:00Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-01T00:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-list-all.json new file mode 100644 index 000000000000..1d1a99e44b4d --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-list-all.json @@ -0,0 +1,143 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "exampleTransform" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "job1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job1", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2021-06-01T00:00:00Z", + "state": "Queued", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "inputDefinitions": [], + "assetName": "job1-InputAsset" + } + ] + }, + "lastModified": "2021-06-01T00:00:00Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Queued", + "progress": 0, + "label": "example-custom-label", + "assetName": "job1-OutputAsset" + } + ], + "priority": "Low", + "correlationData": {} + }, + "systemData": { + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "createdAt": "2021-06-01T00:00:00Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-01T00:00:00Z" + } + }, + { + "name": "job2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job2", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2021-06-01T00:00:00Z", + "state": "Processing", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "inputDefinitions": [], + "assetName": "job2-InputAsset" + } + ] + }, + "lastModified": "2021-06-01T00:00:00Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Processing", + "progress": 50, + "label": "example-custom-label", + "startTime": "2021-07-12T10:34:29.691737Z", + "assetName": "job2-OutputAsset" + } + ], + "priority": "Low", + "correlationData": {}, + "startTime": "2021-07-12T10:34:29.691737Z" + }, + "systemData": { + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "createdAt": "2021-06-01T00:00:00Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-01T00:00:00Z" + } + }, + { + "name": "job3", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job3", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2021-06-01T00:00:00Z", + "state": "Finished", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "inputDefinitions": [], + "assetName": "job3-InputAsset" + } + ] + }, + "lastModified": "2021-06-01T00:00:00Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Finished", + "progress": 100, + "label": "example-custom-label", + "startTime": "2021-07-12T10:34:29.691737Z", + "endTime": "2021-07-12T10:44:29.691737Z", + "assetName": "job3-OutputAsset" + } + ], + "priority": "Low", + "correlationData": {}, + "startTime": "2021-07-12T10:34:29.691737Z", + "endTime": "2021-07-12T10:44:29.691737Z" + }, + "systemData": { + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "createdAt": "2021-06-01T00:00:00Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-01T00:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-update.json new file mode 100644 index 000000000000..441532797fa2 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/jobs-update.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "exampleTransform", + "jobName": "job1", + "parameters": { + "properties": { + "description": "Example job to illustrate update.", + "input": { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "assetName": "job1-InputAsset" + }, + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "assetName": "job1-OutputAsset" + } + ], + "priority": "High" + } + } + }, + "responses": { + "200": { + "body": { + "name": "job1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job1", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2021-06-01T00:00:00Z", + "state": "Queued", + "description": "Example job to illustrate update.", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "inputDefinitions": [], + "assetName": "job1-InputAsset" + } + ] + }, + "lastModified": "2021-07-12T10:44:30.9494087Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Queued", + "progress": 0, + "label": "example-custom-label", + "assetName": "job1-OutputAsset" + } + ], + "priority": "High", + "correlationData": {} + }, + "systemData": { + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "createdAt": "2021-06-01T00:00:00Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-12T10:44:30.9494087Z" + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveevent-allocate.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveevent-allocate.json new file mode 100644 index 000000000000..1805a4c690d8 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveevent-allocate.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2021-06-01" + }, + "responses": { + "202": {}, + "200": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveevent-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveevent-create.json new file mode 100644 index 000000000000..b04ac7db973d --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveevent-create.json @@ -0,0 +1,173 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2021-06-01", + "parameters": { + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "input": { + "streamingProtocol": "RTMP", + "keyFrameIntervalDuration": "PT6S", + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowAll", + "address": "0.0.0.0", + "subnetPrefixLength": 0 + } + ] + } + } + }, + "preview": { + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowAll", + "address": "0.0.0.0", + "subnetPrefixLength": 0 + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "myLiveEvent1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1", + "type": "Microsoft.Media/mediaservices/liveevents", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "resourceState": "Creating", + "provisioningState": "InProgress", + "created": "2018-03-03T02:25:06.0982751Z", + "lastModified": "2018-03-03T02:25:06.0982751Z", + "useStaticHostname": false, + "streamOptions": [], + "input": { + "keyFrameIntervalDuration": "PT6S", + "streamingProtocol": "FragmentedMP4", + "accessToken": "", + "endpoints": [], + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowAll", + "address": "0.0.0.0", + "subnetPrefixLength": 0 + } + ] + } + } + }, + "preview": { + "previewLocator": "c91726b4-880c-4090-94aa-e6ddb1384b37", + "streamingPolicyName": null, + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowAll", + "address": "0.0.0.0", + "subnetPrefixLength": 0 + } + ] + } + }, + "endpoints": [] + }, + "encoding": { + "encodingType": "None", + "presetName": null + }, + "crossSiteAccessPolicies": { + "clientAccessPolicy": null, + "crossDomainPolicy": null + } + } + } + }, + "200": { + "body": { + "name": "myLiveEvent1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1", + "type": "Microsoft.Media/mediaservices/liveevents", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "resourceState": "Stopped", + "provisioningState": "Succeeded", + "created": "2018-03-03T02:25:06.0982751Z", + "lastModified": "2018-03-03T02:25:06.0982751Z", + "useStaticHostname": false, + "streamOptions": [], + "input": { + "keyFrameIntervalDuration": "PT6S", + "streamingProtocol": "FragmentedMP4", + "accessToken": "", + "endpoints": [], + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowAll", + "address": "0.0.0.0", + "subnetPrefixLength": 0 + } + ] + } + } + }, + "preview": { + "previewLocator": "c91726b4-880c-4090-94aa-e6ddb1384b37", + "streamingPolicyName": null, + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowAll", + "address": "0.0.0.0", + "subnetPrefixLength": 0 + } + ] + } + }, + "endpoints": [] + }, + "encoding": { + "encodingType": "None", + "presetName": null + }, + "crossSiteAccessPolicies": { + "clientAccessPolicy": null, + "crossDomainPolicy": null + } + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveevent-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveevent-delete.json new file mode 100644 index 000000000000..8c3832b6fd79 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveevent-delete.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2021-06-01", + "parameters": { + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1", + "name": "myLiveEvent1", + "type": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourcegroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents", + "location": "West US", + "tags": { + "dynamicProperties": { + "tag1": "value1", + "tag2": "value2" + } + }, + "properties": { + "description": "test event updated", + "input": { + "streamingProtocol": "FragmentedMP4", + "keyFrameIntervalDuration": "PT6S", + "endpoints": [], + "accessToken": null + }, + "preview": { + "endpoints": [], + "accessControl": { + "iP": { + "allow": [ + { + "nName": "AllowOne", + "address": "192.1.1.0", + "subnetPrefixLength": null + } + ] + } + }, + "previewLocator": null, + "streamingPolicyName": null + }, + "encoding": { + "encodingType": "None", + "presetName": null + }, + "provisioningState": null, + "resourceState": "Stopped", + "crossSiteAccessPolicies": null, + "useStaticHostname": false, + "streamOptions": [], + "created": "2018-03-02T18:25:07.5748853-08:00", + "lastModified": "2018-03-02T18:25:07.5748853-08:00" + } + } + }, + "responses": { + "202": {}, + "200": {}, + "204": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveevent-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveevent-list-all.json new file mode 100644 index 000000000000..cbd42a4a5c07 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveevent-list-all.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myLiveEvent1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1", + "type": "Microsoft.Media/mediaservices/liveevents", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "resourceState": "Stopped", + "provisioningState": "Succeeded", + "created": "2018-03-03T02:25:08.5564064Z", + "lastModified": "2018-03-03T02:25:08.5564064Z", + "useStaticHostname": false, + "streamOptions": [], + "input": { + "keyFrameIntervalDuration": "PT6S", + "streamingProtocol": "FragmentedMP4", + "accessToken": "", + "endpoints": [ + { + "protocol": "FragmentedMP4", + "url": "http://clouddeployment.media-test.net/de153bb0814542d9b7e2339ce9430dc4/ingest.isml" + } + ] + }, + "preview": { + "previewLocator": "a220e223-faf8-4e03-b9a9-2c2432f48025", + "streamingPolicyName": null, + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowAll", + "address": "0.0.0.0", + "subnetPrefixLength": 0 + } + ] + } + }, + "endpoints": [ + { + "protocol": "FragmentedMP4", + "url": "https://myliveevent1-slitestmedia10.preview-usso.channel.mediaservices.windows.net/a220e223-faf8-4e03-b9a9-2c2432f48025/preview.ism/manifest" + } + ] + }, + "encoding": { + "encodingType": "None", + "presetName": null + }, + "crossSiteAccessPolicies": { + "clientAccessPolicy": null, + "crossDomainPolicy": null + } + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveevent-list-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveevent-list-by-name.json new file mode 100644 index 000000000000..0b4cdb9bb80a --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveevent-list-by-name.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "name": "myLiveEvent1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1", + "type": "Microsoft.Media/mediaservices/liveevents", + "location": "West US", + "tags": {}, + "properties": { + "description": "", + "resourceState": "Stopped", + "provisioningState": "Succeeded", + "created": "2018-03-03T02:25:08.3474032Z", + "lastModified": "2018-03-03T02:25:08.3474032Z", + "useStaticHostname": false, + "streamOptions": [ + "Default" + ], + "input": { + "keyFrameIntervalDuration": "PT6S", + "streamingProtocol": "FragmentedMP4", + "accessToken": null, + "endpoints": [ + { + "protocol": "FragmentedMP4", + "url": "http://clouddeployment.media-test.net/ingest.isml" + } + ] + }, + "preview": { + "previewLocator": "763f3ea4-d94f-441c-a634-c833f61a4e04", + "streamingPolicyName": null, + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowAll", + "address": "0.0.0.0", + "subnetPrefixLength": 0 + } + ] + } + }, + "endpoints": [ + { + "protocol": "FragmentedMP4", + "url": "https://testeventopito4idh2r-weibzmedia05.preview-ts051.channel.media-test.windows-int.net/763f3ea4-d94f-441c-a634-c833f61a4e04/preview.ism/manifest" + } + ] + }, + "encoding": { + "encodingType": "None", + "presetName": null + }, + "crossSiteAccessPolicies": { + "clientAccessPolicy": "", + "crossDomainPolicy": "" + } + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveevent-reset.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveevent-reset.json new file mode 100644 index 000000000000..1805a4c690d8 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveevent-reset.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2021-06-01" + }, + "responses": { + "202": {}, + "200": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveevent-start.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveevent-start.json new file mode 100644 index 000000000000..1805a4c690d8 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveevent-start.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2021-06-01" + }, + "responses": { + "202": {}, + "200": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveevent-stop.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveevent-stop.json new file mode 100644 index 000000000000..102ce595fa66 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveevent-stop.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2021-06-01", + "parameters": { + "removeOutputsOnStop": false + } + }, + "responses": { + "202": {}, + "200": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveevent-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveevent-update.json new file mode 100644 index 000000000000..7c933461ef94 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveevent-update.json @@ -0,0 +1,166 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2021-06-01", + "parameters": { + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "properties": { + "description": "test event updated", + "input": { + "streamingProtocol": "FragmentedMP4", + "keyFrameIntervalDuration": "PT6S", + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowOne", + "address": "192.1.1.0" + } + ] + } + } + }, + "preview": { + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowOne", + "address": "192.1.1.0" + } + ] + } + } + } + } + } + }, + "responses": { + "202": { + "body": { + "name": "myLiveEvent1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1", + "type": "Microsoft.Media/mediaservices/liveevents", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "properties": { + "description": "test event updated", + "resourceState": "Running", + "provisioningState": "InProgress", + "created": "0001-01-01T00:00:00Z", + "lastModified": "0001-01-01T00:00:00Z", + "useStaticHostname": false, + "streamOptions": [], + "input": { + "keyFrameIntervalDuration": "PT6S", + "streamingProtocol": "FragmentedMP4", + "accessToken": "", + "endpoints": [], + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowOne", + "address": "192.1.1.0", + "subnetPrefixLength": null + } + ] + } + } + }, + "preview": { + "previewLocator": "c10ea3fc-587f-4daf-b2b2-fa8f647a9ed2", + "streamingPolicyName": null, + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowOne", + "address": "192.1.1.0", + "subnetPrefixLength": null + } + ] + } + }, + "endpoints": [] + }, + "encoding": { + "encodingType": "None", + "presetName": null + } + } + } + }, + "200": { + "body": { + "name": "myLiveEvent1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1", + "type": "Microsoft.Media/mediaservices/liveevents", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "properties": { + "description": "test event updated", + "resourceState": "Running", + "provisioningState": "InProgress", + "created": "0001-01-01T00:00:00Z", + "lastModified": "0001-01-01T00:00:00Z", + "useStaticHostname": false, + "streamOptions": [], + "input": { + "keyFrameIntervalDuration": "PT6S", + "streamingProtocol": "FragmentedMP4", + "accessToken": "", + "endpoints": [], + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowOne", + "address": "192.1.1.0", + "subnetPrefixLength": null + } + ] + } + } + }, + "preview": { + "previewLocator": "c10ea3fc-587f-4daf-b2b2-fa8f647a9ed2", + "streamingPolicyName": null, + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowOne", + "address": "192.1.1.0", + "subnetPrefixLength": null + } + ] + } + }, + "endpoints": [] + }, + "encoding": { + "encodingType": "None", + "presetName": null + } + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveoutput-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveoutput-create.json new file mode 100644 index 000000000000..2c38d5f3cbcb --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveoutput-create.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "liveOutputName": "myLiveOutput1", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "description": "test live output 1", + "assetName": "6f3264f5-a189-48b4-a29a-a40f22575212", + "archiveWindowLength": "PT5M", + "manifestName": "testmanifest", + "hls": { + "fragmentsPerTsSegment": 5 + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myLiveOutput1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1/liveoutputs/myLiveOutput1", + "type": "Microsoft.Media/mediaservices/liveevents/liveoutputs", + "properties": { + "description": "test live output 1", + "assetName": "6f3264f5-a189-48b4-a29a-a40f22575212", + "archiveWindowLength": "PT5M", + "manifestName": "testmanifest", + "outputSnapTime": 0, + "resourceState": "Stopped", + "provisioningState": "Succeeded", + "created": "2018-03-03T02:25:09.9431835Z", + "lastModified": "2018-03-03T02:25:09.9431835Z", + "hls": { + "fragmentsPerTsSegment": 5 + } + } + } + }, + "201": { + "body": { + "name": "myLiveOutput1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1/liveoutputs/myLiveOutput1", + "type": "Microsoft.Media/mediaservices/liveevents/liveoutputs", + "properties": { + "description": "test live output 1", + "assetName": "6f3264f5-a189-48b4-a29a-a40f22575212", + "archiveWindowLength": "PT5M", + "manifestName": "testmanifest", + "outputSnapTime": 0, + "resourceState": "Creating", + "provisioningState": "InProgress", + "created": "2018-03-03T02:25:09.9431835Z", + "lastModified": "2018-03-03T02:25:09.9431835Z", + "hls": { + "fragmentsPerTsSegment": 5 + } + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveoutput-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveoutput-delete.json new file mode 100644 index 000000000000..7e466f91afb5 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveoutput-delete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "liveOutputName": "myLiveOutput1", + "api-version": "2021-06-01" + }, + "responses": { + "202": {}, + "200": {}, + "204": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveoutput-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveoutput-list-all.json new file mode 100644 index 000000000000..f7606a3be4cb --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveoutput-list-all.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "liveoutput1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1/liveoutputs/", + "type": "Microsoft.Media/mediaservices/liveevents/liveoutputs", + "properties": { + "description": null, + "assetName": "95dafce4-5320-464c-8597-909373854119", + "archiveWindowLength": "PT30S", + "manifestName": "c3a23d4b-02a6-4937-a1ad-6416f463fdca", + "outputSnapTime": 0, + "resourceState": "Running", + "provisioningState": "Succeeded", + "created": "0001-01-01T00:00:00-08:00", + "lastModified": "0001-01-01T00:00:00-08:00", + "hls": { + "fragmentsPerTsSegment": 5 + } + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveoutput-list-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveoutput-list-by-name.json new file mode 100644 index 000000000000..6efcbb3eee74 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/liveoutput-list-by-name.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "liveOutputName": "myLiveOutput1", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "name": "myLiveOutput1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1/liveoutputs/myLiveOutput1", + "type": "Microsoft.Media/mediaservices/liveevents/liveoutputs", + "properties": { + "description": null, + "assetName": "cb2ae0bc-677a-4830-9c8e-06ce4c4cb607", + "archiveWindowLength": "PT30S", + "manifestName": "fc7096f5-c488-4b86-8302-f3bfde53fc27", + "outputSnapTime": 0, + "resourceState": "Running", + "provisioningState": "Succeeded", + "created": "0001-01-01T00:00:00-08:00", + "lastModified": "0001-01-01T00:00:00-08:00", + "hls": { + "fragmentsPerTsSegment": 5 + } + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/operations-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/operations-list-all.json new file mode 100644 index 000000000000..b1cfcc14636c --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/operations-list-all.json @@ -0,0 +1,1395 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Media/register/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Microsoft Media Services", + "operation": "Registers the Media Services Resource Provider", + "description": "Registers the subscription for the Media Services resource provider and enables the creation of Media Services accounts" + } + }, + { + "name": "Microsoft.Media/unregister/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Microsoft Media Services", + "operation": "Unregisters the Media Services Resource Provider", + "description": "Unregisters the subscription for the Media Services resource provider" + } + }, + { + "name": "Microsoft.Media/checknameavailability/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Microsoft Media Services", + "operation": "Check Name Availability", + "description": "Checks if a Media Services account name is available" + } + }, + { + "name": "Microsoft.Media/operations/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Available Operations", + "operation": "Get Available Operations", + "description": "Get Available Operations" + } + }, + { + "name": "Microsoft.Media/mediaservices/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Media Services Account", + "operation": "Read Media Services Account", + "description": "Read any Media Services Account" + } + }, + { + "name": "Microsoft.Media/mediaservices/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Media Services Account", + "operation": "Create or Update Media Services Account", + "description": "Create or Update any Media Services Account" + } + }, + { + "name": "Microsoft.Media/mediaservices/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Media Services Account", + "operation": "Delete Media Services Account", + "description": "Delete any Media Services Account" + } + }, + { + "name": "Microsoft.Media/mediaservices/regenerateKey/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Media Services Account", + "operation": "Regenerate Key", + "description": "Regenerate a Media Services ACS key" + } + }, + { + "name": "Microsoft.Media/mediaservices/listKeys/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Media Services Account", + "operation": "List Keys", + "description": "List the ACS keys for the Media Services account" + } + }, + { + "name": "Microsoft.Media/mediaservices/syncStorageKeys/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Media Services Account", + "operation": "Synchronize Storage Keys", + "description": "Synchronize the Storage Keys for an attached Azure Storage account" + } + }, + { + "name": "Microsoft.Media/mediaservices/listEdgePolicies/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Media Services Account", + "operation": "List policies for an edge device.", + "description": "List policies for an edge device." + } + }, + { + "name": "Microsoft.Media/mediaservices/PrivateEndpointConnectionsApproval/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Media Services Account", + "operation": "Approve Private Endpoint Connections", + "description": "Approve Private Endpoint Connections" + } + }, + { + "name": "Microsoft.Media/mediaservices/eventGridFilters/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Event Grid Filter", + "operation": "Read Event Grid Filter", + "description": "Read any Event Grid Filter" + } + }, + { + "name": "Microsoft.Media/mediaservices/eventGridFilters/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Event Grid Filter", + "operation": "Create or Update Event Grid Filter", + "description": "Create or Update any Event Grid Filter" + } + }, + { + "name": "Microsoft.Media/mediaservices/eventGridFilters/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Event Grid Filter", + "operation": "Delete Event Grid Filter", + "description": "Delete any Event Grid Filter" + } + }, + { + "name": "Microsoft.Media/mediaservices/accountfilters/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Account Filter", + "operation": "Read Account Filter", + "description": "Read any Account Filter" + } + }, + { + "name": "Microsoft.Media/mediaservices/accountfilters/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Account Filter", + "operation": "Create or Update Account Filter", + "description": "Create or Update any Account Filter" + } + }, + { + "name": "Microsoft.Media/mediaservices/accountfilters/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Account Filter", + "operation": "Delete Account Filter", + "description": "Delete any Account Filter" + } + }, + { + "name": "Microsoft.Media/mediaservices/assets/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Asset", + "operation": "Read Asset", + "description": "Read any Asset" + } + }, + { + "name": "Microsoft.Media/mediaservices/assets/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Asset", + "operation": "Create or Update Asset", + "description": "Create or Update any Asset" + } + }, + { + "name": "Microsoft.Media/mediaservices/assets/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Asset", + "operation": "Delete Asset", + "description": "Delete any Asset" + } + }, + { + "name": "Microsoft.Media/mediaservices/assets/listContainerSas/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Asset", + "operation": "List Asset Container SAS URLs", + "description": "List Asset Container SAS URLs" + } + }, + { + "name": "Microsoft.Media/mediaservices/assets/getEncryptionKey/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Asset", + "operation": "Get Asset Encryption Key", + "description": "Get Asset Encryption Key" + } + }, + { + "name": "Microsoft.Media/mediaservices/assets/listStreamingLocators/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Asset", + "operation": "List Streaming Locators for Asset", + "description": "List Streaming Locators for Asset" + } + }, + { + "name": "Microsoft.Media/mediaservices/assets/assetfilters/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Asset Filter", + "operation": "Read Asset Filter", + "description": "Read any Asset Filter" + } + }, + { + "name": "Microsoft.Media/mediaservices/assets/assetfilters/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Asset Filter", + "operation": "Create or Update Asset Filter", + "description": "Create or Update any Asset Filter" + } + }, + { + "name": "Microsoft.Media/mediaservices/assets/assetfilters/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Asset Filter", + "operation": "Delete Asset Filter", + "description": "Delete any Asset Filter" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingPolicies/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Policy", + "operation": "Read Streaming Policy", + "description": "Read any Streaming Policy" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingPolicies/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Policy", + "operation": "Create or Update Streaming Policy", + "description": "Create or Update any Streaming Policy" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingPolicies/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Policy", + "operation": "Delete Streaming Policy", + "description": "Delete any Streaming Policy" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingLocators/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Locator", + "operation": "Read Streaming Locator", + "description": "Read any Streaming Locator" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingLocators/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Locator", + "operation": "Create or Update Streaming Locator", + "description": "Create or Update any Streaming Locator" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingLocators/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Locator", + "operation": "Delete Streaming Locator", + "description": "Delete any Streaming Locator" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingLocators/listContentKeys/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Locator", + "operation": "List Content Keys", + "description": "List Content Keys" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingLocators/listPaths/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Locator", + "operation": "List Paths", + "description": "List Paths" + } + }, + { + "name": "Microsoft.Media/mediaservices/contentKeyPolicies/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Content Key Policy", + "operation": "Read Content Key Policy", + "description": "Read any Content Key Policy" + } + }, + { + "name": "Microsoft.Media/mediaservices/contentKeyPolicies/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Content Key Policy", + "operation": "Create or Update Content Key Policy", + "description": "Create or Update any Content Key Policy" + } + }, + { + "name": "Microsoft.Media/mediaservices/contentKeyPolicies/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Content Key Policy", + "operation": "Delete Content Key Policy", + "description": "Delete any Content Key Policy" + } + }, + { + "name": "Microsoft.Media/mediaservices/contentKeyPolicies/getPolicyPropertiesWithSecrets/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Content Key Policy", + "operation": "Get Policy Properties With Secrets", + "description": "Get Policy Properties With Secrets" + } + }, + { + "name": "Microsoft.Media/mediaservices/transforms/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Transform", + "operation": "Read Transform", + "description": "Read any Transform" + } + }, + { + "name": "Microsoft.Media/mediaservices/transforms/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Transform", + "operation": "Create or Update Transform", + "description": "Create or Update any Transform" + } + }, + { + "name": "Microsoft.Media/mediaservices/transforms/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Transform", + "operation": "Delete Transform", + "description": "Delete any Transform" + } + }, + { + "name": "Microsoft.Media/mediaservices/transforms/jobs/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Job", + "operation": "Read Job", + "description": "Read any Job" + } + }, + { + "name": "Microsoft.Media/mediaservices/transforms/jobs/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Job", + "operation": "Create or Update Job", + "description": "Create or Update any Job" + } + }, + { + "name": "Microsoft.Media/mediaservices/transforms/jobs/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Job", + "operation": "Delete Job", + "description": "Delete any Job" + } + }, + { + "name": "Microsoft.Media/mediaservices/transforms/jobs/cancelJob/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Job", + "operation": "Cancel Job", + "description": "Cancel Job" + } + }, + { + "name": "Microsoft.Media/mediaservices/privateLinkResources/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "PrivateLinkResource", + "operation": "Read Private Link Resource", + "description": "Read any Private Link Resource" + } + }, + { + "name": "Microsoft.Media/mediaservices/privateEndpointConnectionProxies/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "PrivateEndpointConnectionProxy", + "operation": "Read Private Endpoint Connection Proxy", + "description": "Read any Private Endpoint Connection Proxy" + } + }, + { + "name": "Microsoft.Media/mediaservices/privateEndpointConnectionProxies/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "PrivateEndpointConnectionProxy", + "operation": "Create Private Endpoint Connection Proxy", + "description": "Create Private Endpoint Connection Proxy" + } + }, + { + "name": "Microsoft.Media/mediaservices/privateEndpointConnectionProxies/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "PrivateEndpointConnectionProxy", + "operation": "Delete Private Endpoint Connection Proxy", + "description": "Delete Private Endpoint Connection Proxy" + } + }, + { + "name": "Microsoft.Media/mediaservices/privateEndpointConnectionProxies/validate/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "PrivateEndpointConnectionProxy", + "operation": "Validate Private Endpoint Connection Proxy", + "description": "Validate Private Endpoint Connection Proxy" + } + }, + { + "name": "Microsoft.Media/mediaservices/privateEndpointConnections/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "PrivateEndpointConnection", + "operation": "Read Private Endpoint Connection", + "description": "Read any Private Endpoint Connection" + } + }, + { + "name": "Microsoft.Media/mediaservices/privateEndpointConnections/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "PrivateEndpointConnection", + "operation": "Create Private Endpoint Connection", + "description": "Create Private Endpoint Connection" + } + }, + { + "name": "Microsoft.Media/mediaservices/privateEndpointConnections/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "PrivateEndpointConnection", + "operation": "Delete Private Endpoint Connection", + "description": "Delete Private Endpoint Connection" + } + }, + { + "name": "Microsoft.Media/mediaservices/privateEndpointConnectionOperations/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Private Endpoint Connection Operation", + "operation": "Read Private Endpoint Connection Operation", + "description": "Read any Private Endpoint Connection Operation" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingEndpoints/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Endpoint", + "operation": "Read Streaming Endpoint", + "description": "Read any Streaming Endpoint" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingEndpoints/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Endpoint", + "operation": "Create or Update Streaming Endpoint", + "description": "Create or Update any Streaming Endpoint" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingEndpoints/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Endpoint", + "operation": "Delete Streaming Endpoint", + "description": "Delete any Streaming Endpoint" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingEndpoints/start/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Endpoint", + "operation": "Start Streaming Endpoint Operation", + "description": "Start any Streaming Endpoint Operation" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingEndpoints/stop/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Endpoint", + "operation": "Stop Streaming Endpoint Operation", + "description": "Stop any Streaming Endpoint Operation" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingEndpoints/scale/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Endpoint", + "operation": "Scale Streaming Endpoint Operation", + "description": "Scale any Streaming Endpoint Operation" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingEndpoints/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Endpoints", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Media/mediaservices/streamingEndpoints/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Endpoints", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Media/mediaservices/streamingEndpoints/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Endpoints", + "operation": "Get list of Media Services Streaming Endpoint Metrics definitions.", + "description": "Get list of Media Services Streaming Endpoint Metrics definitions." + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "Egress", + "displayName": "Egress", + "displayDescription": "The amount of Egress data, in bytes.", + "unit": "Bytes", + "aggregationType": "Total", + "dimensions": [ + { + "name": "OutputFormat", + "displayName": "Output Format", + "toBeExportedForShoebox": true + } + ], + "supportedAggregationTypes": [ + "Total" + ] + }, + { + "name": "SuccessE2ELatency", + "displayName": "Success end to end Latency", + "displayDescription": "The average latency for successful requests in milliseconds.", + "unit": "Milliseconds", + "aggregationType": "Average", + "dimensions": [ + { + "name": "OutputFormat", + "displayName": "Output Format", + "toBeExportedForShoebox": true + } + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "Requests", + "displayName": "Requests", + "displayDescription": "Requests to a Streaming Endpoint.", + "unit": "Count", + "aggregationType": "Total", + "dimensions": [ + { + "name": "OutputFormat", + "displayName": "Output Format", + "toBeExportedForShoebox": true + }, + { + "name": "HttpStatusCode", + "displayName": "HTTP Status Code", + "toBeExportedForShoebox": true + }, + { + "name": "ErrorCode", + "displayName": "Error Code", + "toBeExportedForShoebox": false + } + ], + "supportedAggregationTypes": [ + "Total" + ] + }, + { + "name": "EgressBandwidth", + "displayName": "Egress bandwidth", + "displayDescription": "Egress bandwidth in bits per second.", + "unit": "BitsPerSecond", + "aggregationType": "Average", + "lockAggregationType": "Total", + "dimensions": [], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "CPU", + "displayName": "CPU usage", + "displayDescription": "CPU usage for premium streaming endpoints. This data is not available for standard streaming endpoints.", + "unit": "Percent", + "aggregationType": "Average", + "dimensions": [], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + } + ] + } + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEvents/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Event", + "operation": "Read Live Event", + "description": "Read any Live Event" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEvents/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Event", + "operation": "Create or Update Live Event", + "description": "Create or Update any Live Event" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEvents/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Event", + "operation": "Delete Live Event", + "description": "Delete any Live Event" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEvents/start/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Event", + "operation": "Start Live Event Operation", + "description": "Start any Live Event Operation" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEvents/stop/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Event", + "operation": "Stop Live Event Operation", + "description": "Stop any Live Event Operation" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEvents/reset/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Event", + "operation": "Reset Live Event Operation", + "description": "Reset any Live Event Operation" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEvents/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Event", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Media/mediaservices/liveEvents/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Event", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Media/mediaservices/liveEvents/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Event", + "operation": "Get a list of Media Services Live Event Metrics definitions.", + "description": "Get a list of Media Services Live Event Metrics definitions." + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "IngestBitrate", + "displayName": "Live Event ingest bitrate", + "displayDescription": "The incoming bitrate ingested for a live event, in bits per second.", + "unit": "BitsPerSecond", + "aggregationType": "Average", + "dimensions": [ + { + "name": "TrackName", + "displayName": "Track name", + "toBeExportedForShoebox": true + } + ], + "enableRegionalMdmAccount": true, + "sourceMdmNamespace": "MicrosoftMediaLiveEvent", + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "IngestLastTimestamp", + "displayName": "Live Event ingest last timestamp", + "displayDescription": "Last timestamp ingested for a live event.", + "unit": "Milliseconds", + "aggregationType": "Maximum", + "dimensions": [ + { + "name": "TrackName", + "displayName": "Track name", + "toBeExportedForShoebox": true + } + ], + "enableRegionalMdmAccount": true, + "sourceMdmNamespace": "MicrosoftMediaLiveEvent", + "supportedAggregationTypes": [ + "Maximum" + ] + }, + { + "name": "IngestDriftValue", + "displayName": "Live Event ingest drift value", + "displayDescription": "Drift between the timestamp of the ingested content and the system clock, measured in seconds per minute. A non zero value indicates that the ingested content is arriving slower than system clock time.", + "unit": "Seconds", + "aggregationType": "Maximum", + "dimensions": [ + { + "name": "TrackName", + "displayName": "Track name", + "toBeExportedForShoebox": true + } + ], + "enableRegionalMdmAccount": true, + "sourceMdmNamespace": "MicrosoftMediaLiveEvent", + "supportedAggregationTypes": [ + "Maximum" + ] + }, + { + "name": "LiveOutputLastTimestamp", + "displayName": "Last output timestamp", + "displayDescription": "Timestamp of the last fragment uploaded to storage for a live event output.", + "unit": "Milliseconds", + "aggregationType": "Maximum", + "dimensions": [ + { + "name": "TrackName", + "displayName": "Track name", + "toBeExportedForShoebox": true + } + ], + "enableRegionalMdmAccount": true, + "sourceMdmNamespace": "MicrosoftMediaLiveEvent", + "supportedAggregationTypes": [ + "Maximum" + ] + } + ] + } + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEvents/liveOutputs/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Output", + "operation": "Read Live Output", + "description": "Read any Live Output" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEvents/liveOutputs/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Output", + "operation": "Create or Update Live Output", + "description": "Create or Update any Live Output" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEvents/liveOutputs/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Output", + "operation": "Delete Live Output", + "description": "Delete any Live Output" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingEndpointOperations/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Endpoint Operation", + "operation": "Read Streaming Endpoint Operation", + "description": "Read any Streaming Endpoint Operation" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEventOperations/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Event Operation", + "operation": "Read Live Event Operation", + "description": "Read any Live Event Operation" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveOutputOperations/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Output Operation", + "operation": "Read Live Output Operation", + "description": "Read any Live Output Operation" + } + }, + { + "name": "Microsoft.Media/mediaservices/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Media Services Account", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Media/mediaservices/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Media Services Account", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Media/mediaservices/providers/Microsoft.Insights/logDefinitions/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "The log definition of mediaservices", + "operation": "Read mediaservices log definitions", + "description": "Gets the available logs for a Media Services Account" + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "KeyDeliveryRequests", + "displayName": "Key Delivery Requests", + "blobDuration": "PT1H" + } + ] + } + } + }, + { + "name": "Microsoft.Media/mediaservices/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Media Service", + "operation": "Get list of Media Services Metric definitions.", + "description": "Get list of Media Services Metric definitions." + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "AssetQuota", + "displayName": "Asset quota", + "displayDescription": "How many assets are allowed for current media service account", + "unit": "Count", + "aggregationType": "Average", + "enableRegionalMdmAccount": true, + "sourceMdmNamespace": "MediaServiceQuotaAndUsage", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT1H", + "PT6H", + "PT12H", + "P1D" + ] + }, + { + "name": "AssetCount", + "displayName": "Asset count", + "displayDescription": "How many assets are already created in current media service account", + "unit": "Count", + "aggregationType": "Average", + "enableRegionalMdmAccount": true, + "sourceMdmNamespace": "MediaServiceQuotaAndUsage", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT1H", + "PT6H", + "PT12H", + "P1D" + ] + }, + { + "name": "AssetQuotaUsedPercentage", + "displayName": "Asset quota used percentage", + "displayDescription": "Asset used percentage in current media service account", + "unit": "Percent", + "aggregationType": "Average", + "enableRegionalMdmAccount": true, + "sourceMdmNamespace": "MediaServiceQuotaAndUsage", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT1H", + "PT6H", + "PT12H", + "P1D" + ] + }, + { + "name": "ContentKeyPolicyQuota", + "displayName": "Content Key Policy quota", + "displayDescription": "How many content key polices are allowed for current media service account", + "unit": "Count", + "aggregationType": "Average", + "enableRegionalMdmAccount": true, + "sourceMdmNamespace": "MediaServiceQuotaAndUsage", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT1H", + "PT6H", + "PT12H", + "P1D" + ] + }, + { + "name": "ContentKeyPolicyCount", + "displayName": "Content Key Policy count", + "displayDescription": "How many content key policies are already created in current media service account", + "unit": "Count", + "aggregationType": "Average", + "enableRegionalMdmAccount": true, + "sourceMdmNamespace": "MediaServiceQuotaAndUsage", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT1H", + "PT6H", + "PT12H", + "P1D" + ] + }, + { + "name": "ContentKeyPolicyQuotaUsedPercentage", + "displayName": "Content Key Policy quota used percentage", + "displayDescription": "Content Key Policy used percentage in current media service account", + "unit": "Percent", + "aggregationType": "Average", + "enableRegionalMdmAccount": true, + "sourceMdmNamespace": "MediaServiceQuotaAndUsage", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT1H", + "PT6H", + "PT12H", + "P1D" + ] + }, + { + "name": "StreamingPolicyQuota", + "displayName": "Streaming Policy quota", + "displayDescription": "How many streaming policies are allowed for current media service account", + "unit": "Count", + "aggregationType": "Average", + "enableRegionalMdmAccount": true, + "sourceMdmNamespace": "MediaServiceQuotaAndUsage", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT1H", + "PT6H", + "PT12H", + "P1D" + ] + }, + { + "name": "StreamingPolicyCount", + "displayName": "Streaming Policy count", + "displayDescription": "How many streaming policies are already created in current media service account", + "unit": "Count", + "aggregationType": "Average", + "enableRegionalMdmAccount": true, + "sourceMdmNamespace": "MediaServiceQuotaAndUsage", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT1H", + "PT6H", + "PT12H", + "P1D" + ] + }, + { + "name": "StreamingPolicyQuotaUsedPercentage", + "displayName": "Streaming Policy quota used percentage", + "displayDescription": "Streaming Policy used percentage in current media service account", + "unit": "Percent", + "aggregationType": "Average", + "enableRegionalMdmAccount": true, + "sourceMdmNamespace": "MediaServiceQuotaAndUsage", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT1H", + "PT6H", + "PT12H", + "P1D" + ] + }, + { + "name": "ChannelsAndLiveEventsCount", + "displayName": "Live event count", + "displayDescription": "The total number of live events in the current media services account", + "unit": "Count", + "aggregationType": "Average", + "enableRegionalMdmAccount": true, + "sourceMdmNamespace": "ClusterResource_ChannelsAndLiveEvents", + "supportedAggregationTypes": [ + "Average" + ] + }, + { + "name": "RunningChannelsAndLiveEventsCount", + "displayName": "Running live event count", + "displayDescription": "The total number of running live events in the current media services account", + "unit": "Count", + "aggregationType": "Average", + "enableRegionalMdmAccount": true, + "sourceMdmNamespace": "ClusterResource_ChannelsAndLiveEvents", + "supportedAggregationTypes": [ + "Average" + ] + }, + { + "name": "MaxChannelsAndLiveEventsCount", + "displayName": "Max live event quota", + "displayDescription": "The maximum number of live events allowed in the current media services account", + "unit": "Count", + "aggregationType": "Average", + "enableRegionalMdmAccount": true, + "sourceMdmNamespace": "ClusterResource_ChannelsAndLiveEvents", + "supportedAggregationTypes": [ + "Average" + ] + }, + { + "name": "MaxRunningChannelsAndLiveEventsCount", + "displayName": "Max running live event quota", + "displayDescription": "The maximum number of running live events allowed in the current media services account", + "unit": "Count", + "aggregationType": "Average", + "enableRegionalMdmAccount": true, + "sourceMdmNamespace": "ClusterResource_ChannelsAndLiveEvents", + "supportedAggregationTypes": [ + "Average" + ] + } + ] + } + } + }, + { + "name": "Microsoft.Media/videoAnalyzers/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Video Analyzer Account", + "operation": "Read a Video Analyzer Account", + "description": "Read a Video Analyzer Account" + } + }, + { + "name": "Microsoft.Media/videoAnalyzers/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Video Analyzer Account", + "operation": "Write a Video Analyzer Account", + "description": "Write a Video Analyzer Account" + } + }, + { + "name": "Microsoft.Media/videoAnalyzers/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Video Analyzer Account", + "operation": "Delete a Video Analyzer Account", + "description": "Delete a Video Analyzer Account" + } + }, + { + "name": "Microsoft.Media/videoAnalyzers/videos/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Video Resource", + "operation": "Read Video", + "description": "Read any Video" + } + }, + { + "name": "Microsoft.Media/videoAnalyzers/videos/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Video Resource", + "operation": "Create or Update Video", + "description": "Create or Update any Video" + } + }, + { + "name": "Microsoft.Media/videoAnalyzers/videos/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Video Resource", + "operation": "Delete Video", + "description": "Delete any Video" + } + }, + { + "name": "Microsoft.Media/videoAnalyzers/videos/listStreamingToken/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Video Resource", + "operation": "Generates a streaming token which can be used for video playback", + "description": "Generates a streaming token which can be used for video playback" + } + }, + { + "name": "Microsoft.Media/videoAnalyzers/accessPolicies/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Access Policy Resource", + "operation": "Read Access Policy", + "description": "Read any Access Policy" + } + }, + { + "name": "Microsoft.Media/videoAnalyzers/accessPolicies/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Access Policy Resource", + "operation": "Create or Update Access Policy", + "description": "Create or Update any Access Policy" + } + }, + { + "name": "Microsoft.Media/videoAnalyzers/accessPolicies/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Access Policy Resource", + "operation": "Delete Access Policy", + "description": "Delete any Access Policy" + } + }, + { + "name": "Microsoft.Media/videoAnalyzers/edgeModules/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Edge Module Resource", + "operation": "Read Edge Module", + "description": "Read any Edge Module" + } + }, + { + "name": "Microsoft.Media/videoAnalyzers/edgeModules/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Edge Module Resource", + "operation": "Create or Update Edge Module", + "description": "Create or Update any Edge Module" + } + }, + { + "name": "Microsoft.Media/videoAnalyzers/edgeModules/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Edge Module Resource", + "operation": "Delete Edge Module", + "description": "Delete any Edge Module" + } + }, + { + "name": "Microsoft.Media/videoAnalyzers/edgeModules/listProvisioningToken/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Edge Module Resource", + "operation": "Creates a new provisioning token", + "description": "Creates a new provisioning token. A provisioning token allows for a single instance of Azure Video analyzer IoT edge module to be initialized and authorized to the cloud account. The provisioning token itself is short lived and it is only used for the initial handshake between IoT edge module and the cloud. After the initial handshake, the IoT edge module will agree on a set of authentication keys which will be auto-rotated as long as the module is able to periodically connect to the cloud. A new provisioning token can be generated for the same IoT edge module in case the module state lost or reset" + } + }, + { + "name": "Microsoft.Media/videoAnalyzers/pipelineTopologies/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Pipeline Topology Resource", + "operation": "Read Pipeline Topology", + "description": "Read any Pipeline Topology" + } + }, + { + "name": "Microsoft.Media/videoAnalyzers/pipelineTopologies/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Pipeline Topology Resource", + "operation": "Create or Update Pipeline Topology", + "description": "Create or Update any Pipeline Topology" + } + }, + { + "name": "Microsoft.Media/videoAnalyzers/pipelineTopologies/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Pipeline Topology Resource", + "operation": "Delete Pipeline Topology", + "description": "Delete any Pipeline Topology" + } + }, + { + "name": "Microsoft.Media/videoAnalyzers/livePipelines/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Pipeline Resource", + "operation": "Read Live Pipeline", + "description": "Read any Live Pipeline" + } + }, + { + "name": "Microsoft.Media/videoAnalyzers/livePipelines/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Pipeline Resource", + "operation": "Create or Update Live Pipeline", + "description": "Create or Update any Live Pipeline" + } + }, + { + "name": "Microsoft.Media/videoAnalyzers/livePipelines/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Pipeline Resource", + "operation": "Delete Live Pipeline", + "description": "Delete any Live Pipeline" + } + }, + { + "name": "Microsoft.Media/videoAnalyzers/livePipelines/activate/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Pipeline Resource", + "operation": "Activate Live Pipeline", + "description": "Activate any Live Pipeline" + } + }, + { + "name": "Microsoft.Media/videoAnalyzers/livePipelines/deactivate/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Pipeline Resource", + "operation": "Deactivate Live Pipeline", + "description": "Deactivate any Live Pipeline" + } + }, + { + "name": "Microsoft.Media/videoAnalyzers/livePipelines/operationsStatus/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Pipeline operation status Resource", + "operation": "Read Live Pipeline operation status", + "description": "Read any Live Pipeline operation status" + } + }, + { + "name": "Microsoft.Media/locations/checkNameAvailability/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Microsoft Media Services", + "operation": "Check Name Availability", + "description": "Checks if a Media Services account name is available" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/private-endpoint-connection-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/private-endpoint-connection-delete.json new file mode 100644 index 000000000000..a981c65e9834 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/private-endpoint-connection-delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "name": "connectionName1", + "api-version": "2021-06-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/private-endpoint-connection-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/private-endpoint-connection-get-by-name.json new file mode 100644 index 000000000000..5b3a9531b729 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/private-endpoint-connection-get-by-name.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "name": "connectionName1", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "name": "connectionName1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/fabrikam/providers/Microsoft.Media/mediaservices/contososports/privateEndpointConnections/connectionName1", + "type": "Microsoft.Media/mediaservices/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Test description." + }, + "privateEndpoint": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/reosuceGroup1/providers/Microsoft.Network/privateEndpoints/privateEndpointName1" + } + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/private-endpoint-connection-list.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/private-endpoint-connection-list.json new file mode 100644 index 000000000000..f02d16f94862 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/private-endpoint-connection-list.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "cn1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/fabrikam/providers/Microsoft.Media/mediaservices/contososports/privateEndpointConnections/cn1", + "type": "Microsoft.Media/mediaservices/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Test description" + }, + "privateEndpoint": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/reosuceGroup1/providers/Microsoft.Network/privateEndpoints/pe1" + } + } + }, + { + "name": "cn2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/fabrikam/providers/Microsoft.Media/mediaservices/contososports/privateEndpointConnections/cn2", + "type": "Microsoft.Media/mediaservices/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Test description" + }, + "privateEndpoint": { + "id": "/subscriptions/22222222-2222-2222-2222-222222222222/resourceGroups/reosuceGroup2/providers/Microsoft.Network/privateEndpoints/pe2" + } + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/private-endpoint-connection-put.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/private-endpoint-connection-put.json new file mode 100644 index 000000000000..afa9980923dd --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/private-endpoint-connection-put.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "name": "connectionName1", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Test description." + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "connectionName1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/fabrikam/providers/Microsoft.Media/mediaservices/contososports/privateEndpointConnections/connectionName1", + "type": "Microsoft.Media/mediaservices/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Test description." + }, + "privateEndpoint": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/reosuceGroup1/providers/Microsoft.Network/privateEndpoints/privateEndpointName1" + } + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/private-link-resources-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/private-link-resources-get-by-name.json new file mode 100644 index 000000000000..341d2b19afc4 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/private-link-resources-get-by-name.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "name": "keydelivery", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "name": "keydelivery", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/fabrikam/providers/Microsoft.Media/mediaservices/contososports/privateLinkResources/keydelivery", + "type": "Microsoft.Media/mediaservices/privateLinkResources", + "properties": { + "groupId": "keydelivery", + "requiredMembers": [ + "keydelivery" + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/private-link-resources-list.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/private-link-resources-list.json new file mode 100644 index 000000000000..0c27ba8faba4 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/private-link-resources-list.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "keydelivery", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/fabrikam/providers/Microsoft.Media/mediaservices/contososports/privateLinkResources/keydelivery", + "type": "Microsoft.Media/mediaservices/privateLinkResources", + "properties": { + "groupId": "keydelivery", + "requiredMembers": [ + "keydelivery" + ] + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-locators-create-clear.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-locators-create-clear.json new file mode 100644 index 000000000000..cadbcba78463 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-locators-create-clear.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "UserCreatedClearStreamingLocator", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "streamingPolicyName": "clearStreamingPolicy", + "assetName": "ClimbingMountRainier" + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedClearStreamingLocator", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/UserCreatedClearStreamingLocator", + "type": "Microsoft.Media/mediaservices/streamingLocators", + "properties": { + "assetName": "ClimbingMountRainier", + "created": "2018-08-08T18:29:32.4323237Z", + "endTime": "9999-12-31T23:59:59.9999999Z", + "streamingLocatorId": "e34b0fc4-3be0-4a3c-9793-1f6b7be5b013", + "streamingPolicyName": "clearStreamingPolicy", + "contentKeys": [] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-locators-create-secure-userDefinedContentKeys.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-locators-create-secure-userDefinedContentKeys.json new file mode 100644 index 000000000000..77bda4e12bdc --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-locators-create-secure-userDefinedContentKeys.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "UserCreatedSecureStreamingLocatorWithUserDefinedContentKeys", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "assetName": "ClimbingMountRainier", + "streamingPolicyName": "secureStreamingPolicy", + "streamingLocatorId": "90000000-0000-0000-0000-00000000000A", + "contentKeys": [ + { + "labelReferenceInStreamingPolicy": "aesDefaultKey", + "id": "60000000-0000-0000-0000-000000000001", + "value": "1UqLohAfWsEGkULYxHjYZg==" + }, + { + "labelReferenceInStreamingPolicy": "cencDefaultKey", + "id": "60000000-0000-0000-0000-000000000004", + "value": "4UqLohAfWsEGkULYxHjYZg==" + }, + { + "labelReferenceInStreamingPolicy": "cbcsDefaultKey", + "id": "60000000-0000-0000-0000-000000000007", + "value": "7UqLohAfWsEGkULYxHjYZg==" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedSecureStreamingLocatorWithUserDefinedContentKeys", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/UserCreatedSecureStreamingLocatorWithUserDefinedContentKeys", + "type": "Microsoft.Media/mediaservices/streamingLocators", + "properties": { + "assetName": "ClimbingMountRainier", + "created": "2018-08-08T18:29:32.7859424Z", + "endTime": "9999-12-31T23:59:59.9999999Z", + "streamingLocatorId": "90000000-0000-0000-0000-00000000000a", + "streamingPolicyName": "secureStreamingPolicy", + "contentKeys": [ + { + "id": "60000000-0000-0000-0000-000000000007", + "type": "CommonEncryptionCbcs", + "labelReferenceInStreamingPolicy": "cbcsDefaultKey", + "tracks": [] + }, + { + "id": "60000000-0000-0000-0000-000000000004", + "type": "CommonEncryptionCenc", + "labelReferenceInStreamingPolicy": "cencDefaultKey", + "tracks": [] + }, + { + "id": "60000000-0000-0000-0000-000000000001", + "type": "EnvelopeEncryption", + "labelReferenceInStreamingPolicy": "aesDefaultKey", + "tracks": [] + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-locators-create-secure.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-locators-create-secure.json new file mode 100644 index 000000000000..fd0a0f7763a9 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-locators-create-secure.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "UserCreatedSecureStreamingLocator", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "streamingPolicyName": "secureStreamingPolicy", + "assetName": "ClimbingMountRainier", + "startTime": "2018-03-01T00:00:00Z", + "endTime": "2028-12-31T23:59:59.9999999Z" + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedSecureStreamingLocator", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/UserCreatedSecureStreamingLocator", + "type": "Microsoft.Media/mediaservices/streamingLocators", + "properties": { + "assetName": "ClimbingMountRainier", + "created": "2018-08-08T18:29:32.6243295Z", + "startTime": "2018-03-01T00:00:00Z", + "endTime": "2028-12-31T23:59:59.9999999Z", + "streamingLocatorId": "962775be-41fb-452a-b0dc-72ca2543a945", + "streamingPolicyName": "secureStreamingPolicy", + "contentKeys": [ + { + "id": "1b2d5581-4518-4a51-ad8a-f55d3bf993d4", + "type": "CommonEncryptionCbcs", + "labelReferenceInStreamingPolicy": "cbcsDefaultKey", + "tracks": [] + }, + { + "id": "1a9858b1-3566-4bf1-9fee-60f2fb98e7e4", + "type": "CommonEncryptionCenc", + "labelReferenceInStreamingPolicy": "cencDefaultKey", + "tracks": [] + }, + { + "id": "5faac86a-3aca-4d6b-99c0-6bb8cc3497a1", + "type": "EnvelopeEncryption", + "labelReferenceInStreamingPolicy": "aesDefaultKey", + "tracks": [] + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-locators-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-locators-delete.json new file mode 100644 index 000000000000..1fc67211d889 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-locators-delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "clearStreamingLocator", + "api-version": "2021-06-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-locators-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-locators-get-by-name.json new file mode 100644 index 000000000000..2dc8382a2342 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-locators-get-by-name.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "clearStreamingLocator", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "name": "clearStreamingLocator", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/clearStreamingLocator", + "type": "Microsoft.Media/mediaservices/streamingLocators", + "properties": { + "assetName": "ClimbingMountRainier", + "created": "2018-08-08T18:29:32.1154071Z", + "endTime": "9999-12-31T23:59:59.9999999Z", + "streamingLocatorId": "7684043b-f6d1-44a7-8bed-8a4aa474c5a4", + "streamingPolicyName": "clearStreamingPolicy", + "contentKeys": [] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-locators-list-content-keys.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-locators-list-content-keys.json new file mode 100644 index 000000000000..99a3c2288453 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-locators-list-content-keys.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "secureStreamingLocator", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "contentKeys": [ + { + "id": "9259eb06-eeee-4f77-987f-48f4ea5c649f", + "type": "EnvelopeEncryption", + "labelReferenceInStreamingPolicy": "aesDefaultKey", + "value": "QpiqeQROdN5xamnfUF2Wdw==", + "policyName": "PolicyWithMultipleOptions", + "tracks": [] + }, + { + "id": "06bfeff1-2bb6-4f58-af27-a2767f058bca", + "type": "CommonEncryptionCenc", + "labelReferenceInStreamingPolicy": "cencDefaultKey", + "value": "ZjgWhNnqnqcov/h+wrYusw==", + "policyName": "PolicyWithMultipleOptions", + "tracks": [] + }, + { + "id": "799e78a0-ed6f-4179-9222-ed4ec4223cec", + "type": "CommonEncryptionCbcs", + "labelReferenceInStreamingPolicy": "cbcsDefaultKey", + "value": "FjZ3n3yRcVxRFftdYFbe9g==", + "policyName": "PolicyWithMultipleOptions", + "tracks": [] + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-locators-list-paths-streaming-and-download.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-locators-list-paths-streaming-and-download.json new file mode 100644 index 000000000000..0b2b02358c67 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-locators-list-paths-streaming-and-download.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "clearStreamingLocator", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "streamingPaths": [ + { + "streamingProtocol": "Hls", + "encryptionScheme": "NoEncryption", + "paths": [ + "/262a87b6-b538-4657-bac1-b6897924471d/videoManifest1.ism/manifest(format=m3u8-aapl)", + "/262a87b6-b538-4657-bac1-b6897924471d/videoManifest2.ism/manifest(format=m3u8-aapl)", + "/262a87b6-b538-4657-bac1-b6897924471d/videoManifest3.ism/manifest(format=m3u8-aapl)" + ] + }, + { + "streamingProtocol": "Dash", + "encryptionScheme": "NoEncryption", + "paths": [ + "/262a87b6-b538-4657-bac1-b6897924471d/videoManifest1.ism/manifest(format=mpd-time-csf)", + "/262a87b6-b538-4657-bac1-b6897924471d/videoManifest2.ism/manifest(format=mpd-time-csf)", + "/262a87b6-b538-4657-bac1-b6897924471d/videoManifest3.ism/manifest(format=mpd-time-csf)" + ] + }, + { + "streamingProtocol": "SmoothStreaming", + "encryptionScheme": "NoEncryption", + "paths": [ + "/262a87b6-b538-4657-bac1-b6897924471d/videoManifest1.ism/manifest", + "/262a87b6-b538-4657-bac1-b6897924471d/videoManifest2.ism/manifest", + "/262a87b6-b538-4657-bac1-b6897924471d/videoManifest3.ism/manifest" + ] + } + ], + "downloadPaths": [ + "/262a87b6-b538-4657-bac1-b6897924471d/textTrack.vtt", + "/262a87b6-b538-4657-bac1-b6897924471d/video1.mp4", + "/262a87b6-b538-4657-bac1-b6897924471d/video2.mp4", + "/262a87b6-b538-4657-bac1-b6897924471d/video3.mp4" + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-locators-list-paths-streaming-only.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-locators-list-paths-streaming-only.json new file mode 100644 index 000000000000..3c1904b93db1 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-locators-list-paths-streaming-only.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "secureStreamingLocator", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "streamingPaths": [ + { + "streamingProtocol": "Hls", + "encryptionScheme": "EnvelopeEncryption", + "paths": [ + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest1.ism/manifest(format=m3u8-aapl,encryption=cbc)", + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest2.ism/manifest(format=m3u8-aapl,encryption=cbc)", + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest3.ism/manifest(format=m3u8-aapl,encryption=cbc)" + ] + }, + { + "streamingProtocol": "Dash", + "encryptionScheme": "EnvelopeEncryption", + "paths": [ + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest1.ism/manifest(format=mpd-time-csf,encryption=cbc)", + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest2.ism/manifest(format=mpd-time-csf,encryption=cbc)", + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest3.ism/manifest(format=mpd-time-csf,encryption=cbc)" + ] + }, + { + "streamingProtocol": "SmoothStreaming", + "encryptionScheme": "EnvelopeEncryption", + "paths": [ + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest1.ism/manifest(encryption=cbc)", + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest2.ism/manifest(encryption=cbc)", + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest3.ism/manifest(encryption=cbc)" + ] + }, + { + "streamingProtocol": "Dash", + "encryptionScheme": "CommonEncryptionCenc", + "paths": [ + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest1.ism/manifest(format=mpd-time-csf,encryption=cenc)", + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest2.ism/manifest(format=mpd-time-csf,encryption=cenc)", + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest3.ism/manifest(format=mpd-time-csf,encryption=cenc)" + ] + }, + { + "streamingProtocol": "SmoothStreaming", + "encryptionScheme": "CommonEncryptionCenc", + "paths": [ + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest1.ism/manifest(encryption=cenc)", + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest2.ism/manifest(encryption=cenc)", + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest3.ism/manifest(encryption=cenc)" + ] + }, + { + "streamingProtocol": "Hls", + "encryptionScheme": "CommonEncryptionCbcs", + "paths": [ + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest1.ism/manifest(format=m3u8-aapl,encryption=cbcs-aapl)", + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest2.ism/manifest(format=m3u8-aapl,encryption=cbcs-aapl)", + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest3.ism/manifest(format=m3u8-aapl,encryption=cbcs-aapl)" + ] + } + ], + "downloadPaths": [] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-locators-list.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-locators-list.json new file mode 100644 index 000000000000..5cc65d98291c --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-locators-list.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "clearStreamingLocator", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/clearStreamingLocator", + "type": "Microsoft.Media/mediaservices/streamingLocators", + "properties": { + "assetName": "ClimbingMountRainier", + "created": "2018-08-08T18:29:31.9341192Z", + "endTime": "9999-12-31T23:59:59.9999999Z", + "streamingLocatorId": "6a116ec6-0c85-441f-9c31-89a5bc3adf0a", + "streamingPolicyName": "clearStreamingPolicy", + "contentKeys": [] + } + }, + { + "name": "secureStreamingLocator", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/secureStreamingLocator", + "type": "Microsoft.Media/mediaservices/streamingLocators", + "properties": { + "assetName": "ClimbingMountRainier", + "created": "2018-08-08T18:29:31.9544387Z", + "endTime": "9999-12-31T23:59:59.9999999Z", + "streamingLocatorId": "7338ef90-ffc8-42de-8bff-de8f99973300", + "streamingPolicyName": "secureStreamingPolicy", + "contentKeys": [] + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-policies-create-clear.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-policies-create-clear.json new file mode 100644 index 000000000000..49387fc28ff7 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-policies-create-clear.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingPolicyName": "UserCreatedClearStreamingPolicy", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "noEncryption": { + "enabledProtocols": { + "download": true, + "dash": true, + "hls": true, + "smoothStreaming": true + } + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedClearStreamingPolicy", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/UserCreatedClearStreamingPolicy", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-08-08T18:29:31.1535417Z", + "noEncryption": { + "enabledProtocols": { + "download": true, + "dash": true, + "hls": true, + "smoothStreaming": true + } + } + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-policies-create-commonEncryptionCbcs-only.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-policies-create-commonEncryptionCbcs-only.json new file mode 100644 index 000000000000..bd9dcda73761 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-policies-create-commonEncryptionCbcs-only.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingPolicyName": "UserCreatedSecureStreamingPolicyWithCommonEncryptionCbcsOnly", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "defaultContentKeyPolicyName": "PolicyWithMultipleOptions", + "commonEncryptionCbcs": { + "enabledProtocols": { + "download": false, + "dash": false, + "hls": true, + "smoothStreaming": false + }, + "contentKeys": { + "defaultKey": { + "label": "cbcsDefaultKey" + } + }, + "drm": { + "fairPlay": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/fairplay/{ContentKeyId}", + "allowPersistentLicense": true + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedSecureStreamingPolicyWithCommonEncryptionCbcsOnly", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/UserCreatedSecureStreamingPolicyWithCommonEncryptionCbcsOnly", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-08-08T18:29:31.6197199Z", + "defaultContentKeyPolicyName": "PolicyWithMultipleOptions", + "commonEncryptionCbcs": { + "enabledProtocols": { + "download": false, + "dash": false, + "hls": true, + "smoothStreaming": false + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "cbcsDefaultKey" + }, + "keyToTrackMappings": [] + }, + "drm": { + "fairPlay": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/fairplay/{ContentKeyId}", + "allowPersistentLicense": true + } + } + } + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-policies-create-commonEncryptionCenc-only.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-policies-create-commonEncryptionCenc-only.json new file mode 100644 index 000000000000..3f9674d63380 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-policies-create-commonEncryptionCenc-only.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingPolicyName": "UserCreatedSecureStreamingPolicyWithCommonEncryptionCencOnly", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "defaultContentKeyPolicyName": "PolicyWithPlayReadyOptionAndOpenRestriction", + "commonEncryptionCenc": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": false, + "smoothStreaming": true + }, + "clearTracks": [ + { + "trackSelections": [ + { + "property": "FourCC", + "operation": "Equal", + "value": "hev1" + } + ] + } + ], + "contentKeys": { + "defaultKey": { + "label": "cencDefaultKey" + } + }, + "drm": { + "playReady": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/playready/{ContentKeyId}", + "playReadyCustomAttributes": "PlayReady CustomAttributes" + }, + "widevine": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/widevine/{ContentKeyId" + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedSecureStreamingPolicyWithCommonEncryptionCencOnly", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/UserCreatedSecureStreamingPolicyWithCommonEncryptionCencOnly", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-08-08T18:29:31.4678543Z", + "defaultContentKeyPolicyName": "PolicyWithPlayReadyOptionAndOpenRestriction", + "commonEncryptionCenc": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": false, + "smoothStreaming": true + }, + "clearTracks": [ + { + "trackSelections": [ + { + "property": "FourCC", + "operation": "Equal", + "value": "hev1" + } + ] + } + ], + "contentKeys": { + "defaultKey": { + "label": "cencDefaultKey" + }, + "keyToTrackMappings": [] + }, + "drm": { + "playReady": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/playready/{ContentKeyId}", + "playReadyCustomAttributes": "PlayReady CustomAttributes" + }, + "widevine": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/widevine/{ContentKeyId" + } + } + } + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-policies-create-envelopeEncryption-only.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-policies-create-envelopeEncryption-only.json new file mode 100644 index 000000000000..fcd9a75e8aff --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-policies-create-envelopeEncryption-only.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingPolicyName": "UserCreatedSecureStreamingPolicyWithEnvelopeEncryptionOnly", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "defaultContentKeyPolicyName": "PolicyWithClearKeyOptionAndTokenRestriction", + "envelopeEncryption": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": true, + "smoothStreaming": true + }, + "contentKeys": { + "defaultKey": { + "label": "aesDefaultKey" + } + }, + "customKeyAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/envelope/{ContentKeyId}" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedSecureStreamingPolicyWithEnvelopeEncryptionOnly", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/UserCreatedSecureStreamingPolicyWithEnvelopeEncryptionOnly", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-08-08T18:29:31.3055712Z", + "defaultContentKeyPolicyName": "PolicyWithClearKeyOptionAndTokenRestriction", + "envelopeEncryption": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": true, + "smoothStreaming": true + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "aesDefaultKey" + }, + "keyToTrackMappings": [] + }, + "customKeyAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/envelope/{ContentKeyId}" + } + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-policies-create-secure-streaming.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-policies-create-secure-streaming.json new file mode 100644 index 000000000000..849c67927d48 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-policies-create-secure-streaming.json @@ -0,0 +1,164 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingPolicyName": "UserCreatedSecureStreamingPolicy", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "defaultContentKeyPolicyName": "PolicyWithMultipleOptions", + "envelopeEncryption": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": true, + "smoothStreaming": true + }, + "contentKeys": { + "defaultKey": { + "label": "aesDefaultKey" + } + }, + "customKeyAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/envelope/{ContentKeyId}" + }, + "commonEncryptionCenc": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": false, + "smoothStreaming": true + }, + "clearTracks": [ + { + "trackSelections": [ + { + "property": "FourCC", + "operation": "Equal", + "value": "hev1" + } + ] + } + ], + "contentKeys": { + "defaultKey": { + "label": "cencDefaultKey" + } + }, + "drm": { + "playReady": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/playready/{ContentKeyId}", + "playReadyCustomAttributes": "PlayReady CustomAttributes" + }, + "widevine": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/widevine/{ContentKeyId" + } + } + }, + "commonEncryptionCbcs": { + "enabledProtocols": { + "download": false, + "dash": false, + "hls": true, + "smoothStreaming": false + }, + "contentKeys": { + "defaultKey": { + "label": "cbcsDefaultKey" + } + }, + "drm": { + "fairPlay": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/fairplay/{ContentKeyId}", + "allowPersistentLicense": true + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedSecureStreamingPolicy", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/UserCreatedSecureStreamingPolicy", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-08-08T18:29:31.7715696Z", + "defaultContentKeyPolicyName": "PolicyWithMultipleOptions", + "envelopeEncryption": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": true, + "smoothStreaming": true + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "aesDefaultKey" + }, + "keyToTrackMappings": [] + }, + "customKeyAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/envelope/{ContentKeyId}" + }, + "commonEncryptionCenc": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": false, + "smoothStreaming": true + }, + "clearTracks": [ + { + "trackSelections": [ + { + "property": "FourCC", + "operation": "Equal", + "value": "hev1" + } + ] + } + ], + "contentKeys": { + "defaultKey": { + "label": "cencDefaultKey" + }, + "keyToTrackMappings": [] + }, + "drm": { + "playReady": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/playready/{ContentKeyId}", + "playReadyCustomAttributes": "PlayReady CustomAttributes" + }, + "widevine": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/widevine/{ContentKeyId" + } + } + }, + "commonEncryptionCbcs": { + "enabledProtocols": { + "download": false, + "dash": false, + "hls": true, + "smoothStreaming": false + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "cbcsDefaultKey" + }, + "keyToTrackMappings": [] + }, + "drm": { + "fairPlay": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/fairplay/{ContentKeyId}", + "allowPersistentLicense": true + } + } + } + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-policies-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-policies-delete.json new file mode 100644 index 000000000000..f70ab454366a --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-policies-delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingPolicyName": "secureStreamingPolicyWithCommonEncryptionCbcsOnly", + "api-version": "2021-06-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-policies-list.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-policies-list.json new file mode 100644 index 000000000000..83478264e5b9 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-policies-list.json @@ -0,0 +1,211 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "clearStreamingPolicy", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/clearStreamingPolicy", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-08-08T18:29:30.676067Z", + "noEncryption": { + "enabledProtocols": { + "download": true, + "dash": true, + "hls": true, + "smoothStreaming": true + } + } + } + }, + { + "name": "secureStreamingPolicy", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/secureStreamingPolicy", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-08-08T18:29:30.6781134Z", + "defaultContentKeyPolicyName": "PolicyWithMultipleOptions", + "envelopeEncryption": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": true, + "smoothStreaming": true + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "aesDefaultKey" + }, + "keyToTrackMappings": [] + }, + "customKeyAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/envelope/{ContentKeyId}" + }, + "commonEncryptionCenc": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": false, + "smoothStreaming": true + }, + "clearTracks": [ + { + "trackSelections": [ + { + "property": "FourCC", + "operation": "Unknown", + "value": "hev1" + } + ] + } + ], + "contentKeys": { + "defaultKey": { + "label": "cencDefaultKey" + }, + "keyToTrackMappings": [] + }, + "drm": { + "playReady": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/playready/{ContentKeyId}", + "playReadyCustomAttributes": "PlayReady CustomAttributes" + }, + "widevine": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/widevine/{ContentKeyId" + } + } + }, + "commonEncryptionCbcs": { + "enabledProtocols": { + "download": false, + "dash": false, + "hls": true, + "smoothStreaming": false + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "cbcsDefaultKey" + }, + "keyToTrackMappings": [] + }, + "drm": { + "fairPlay": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/fairplay/{ContentKeyId}", + "allowPersistentLicense": true + } + } + } + } + }, + { + "name": "secureStreamingPolicyWithCommonEncryptionCbcsOnly", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/secureStreamingPolicyWithCommonEncryptionCbcsOnly", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-08-08T18:29:30.6781134Z", + "defaultContentKeyPolicyName": "PolicyWithMultipleOptions", + "commonEncryptionCbcs": { + "enabledProtocols": { + "download": false, + "dash": false, + "hls": true, + "smoothStreaming": false + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "cbcsDefaultKey" + }, + "keyToTrackMappings": [] + }, + "drm": { + "fairPlay": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/fairplay/{ContentKeyId}", + "allowPersistentLicense": true + } + } + } + } + }, + { + "name": "secureStreamingPolicyWithCommonEncryptionCencOnly", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/secureStreamingPolicyWithCommonEncryptionCencOnly", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-08-08T18:29:30.6781134Z", + "defaultContentKeyPolicyName": "PolicyWithMultipleOptions", + "commonEncryptionCenc": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": false, + "smoothStreaming": true + }, + "clearTracks": [ + { + "trackSelections": [ + { + "property": "FourCC", + "operation": "Unknown", + "value": "hev1" + } + ] + } + ], + "contentKeys": { + "defaultKey": { + "label": "cencDefaultKey" + }, + "keyToTrackMappings": [] + }, + "drm": { + "playReady": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/playready/{ContentKeyId}", + "playReadyCustomAttributes": "PlayReady CustomAttributes" + }, + "widevine": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/widevine/{ContentKeyId" + } + } + } + } + }, + { + "name": "secureStreamingPolicyWithEnvelopeEncryptionOnly", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/secureStreamingPolicyWithEnvelopeEncryptionOnly", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-08-08T18:29:30.6781134Z", + "defaultContentKeyPolicyName": "PolicyWithClearKeyOptionAndTokenRestriction", + "envelopeEncryption": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": true, + "smoothStreaming": true + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "aesDefaultKey" + }, + "keyToTrackMappings": [] + }, + "customKeyAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/envelope/{ContentKeyId}" + } + } + } + ], + "@odata.nextLink": "http://server/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaServices/contosomedia/streamingPolicies?api-version=2021-06-01&$skiptoken=secureStreamingPolicyWithEnvelopeEncryptionOnly" + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-policy-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-policy-get-by-name.json new file mode 100644 index 000000000000..43a7e555f098 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streaming-policy-get-by-name.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingPolicyName": "clearStreamingPolicy", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "name": "clearStreamingPolicy", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/clearStreamingPolicy", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-08-08T18:29:30.8501486Z", + "noEncryption": { + "enabledProtocols": { + "download": true, + "dash": true, + "hls": true, + "smoothStreaming": true + } + } + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streamingendpoint-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streamingendpoint-create.json new file mode 100644 index 000000000000..a1535e956ff6 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streamingendpoint-create.json @@ -0,0 +1,154 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "streamingEndpointName": "myStreamingEndpoint1", + "api-version": "2021-06-01", + "parameters": { + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "scaleUnits": 1, + "availabilitySetName": "availableset", + "accessControl": { + "akamai": { + "akamaiSignatureHeaderAuthenticationKeyList": [ + { + "identifier": "id1", + "expiration": "2029-12-31T16:00:00-08:00", + "base64Key": "dGVzdGlkMQ==" + }, + { + "identifier": "id2", + "expiration": "2030-12-31T16:00:00-08:00", + "base64Key": "dGVzdGlkMQ==" + } + ] + }, + "ip": { + "allow": [ + { + "name": "AllowedIp", + "address": "192.168.1.1" + } + ] + } + }, + "cdnEnabled": false + } + } + }, + "responses": { + "201": { + "body": { + "name": "myStreamingEndpoint1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1", + "type": "Microsoft.Media/mediaservices/streamingEndpoints", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "scaleUnits": 1, + "availabilitySetName": "availableset", + "cdnEnabled": false, + "cdnProvider": null, + "cdnProfile": "", + "customHostNames": [], + "accessControl": { + "akamai": { + "akamaiSignatureHeaderAuthenticationKeyList": [ + { + "identifier": "id1", + "expiration": "2030-01-01T00:00:00Z", + "base64Key": "dGVzdGlkMQ==" + }, + { + "identifier": "id2", + "expiration": "2031-01-01T00:00:00Z", + "base64Key": "dGVzdGlkMQ==" + } + ] + }, + "ip": { + "allow": [ + { + "name": "AllowedIp", + "address": "192.168.1.1", + "subnetPrefixLength": null + } + ] + } + }, + "maxCacheAge": null, + "hostName": "mystreamingendpoint1-slitestmedia10.streaming.mediaservices.windows.net", + "freeTrialEndTime": "0001-01-01T00:00:00-08:00", + "provisioningState": "InProgress", + "resourceState": "Creating", + "created": "2018-03-03T02:25:09.7561389Z", + "lastModified": "2018-03-03T02:25:09.7561389Z" + } + } + }, + "200": { + "body": { + "name": "myStreamingEndpoint1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1", + "type": "Microsoft.Media/mediaservices/streamingEndpoints", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "scaleUnits": 1, + "availabilitySetName": "availableset", + "cdnEnabled": false, + "cdnProvider": null, + "cdnProfile": "", + "customHostNames": [], + "accessControl": { + "akamai": { + "akamaiSignatureHeaderAuthenticationKeyList": [ + { + "identifier": "id1", + "expiration": "2030-01-01T00:00:00Z", + "base64Key": "dGVzdGlkMQ==" + }, + { + "identifier": "id2", + "expiration": "2031-01-01T00:00:00Z", + "base64Key": "dGVzdGlkMQ==" + } + ] + }, + "ip": { + "allow": [ + { + "name": "AllowedIp", + "address": "192.168.1.1", + "subnetPrefixLength": null + } + ] + } + }, + "maxCacheAge": null, + "hostName": "mystreamingendpoint1-slitestmedia10.streaming.mediaservices.windows.net", + "freeTrialEndTime": "0001-01-01T00:00:00-08:00", + "provisioningState": "Succeeded", + "resourceState": "Stopped", + "created": "2018-03-03T02:25:09.7561389Z", + "lastModified": "2018-03-03T02:25:09.7561389Z" + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streamingendpoint-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streamingendpoint-delete.json new file mode 100644 index 000000000000..cf370bd244ee --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streamingendpoint-delete.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "streamingEndpointName": "myStreamingEndpoint1", + "api-version": "2021-06-01", + "parameters": { + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1", + "name": "myStreamingEndpoint1", + "type": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourcegroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints", + "location": "West US", + "tags": { + "dynamicProperties": { + "tag1": "value1", + "tag2": "value2" + } + }, + "properties": { + "description": "test event 1", + "scaleUnits": 1, + "accessControl": null, + "availabilitySetName": "availableset", + "maxCacheAge": null, + "crossSiteAccessPolicies": null, + "customHostNames": [], + "hostName": null, + "cdnEnabled": false, + "cdnProvider": null, + "cdnProfile": null, + "freeTrialEndTime": "0001-01-01T00:00:00-08:00", + "provisioningState": null, + "resourceState": "Stopped", + "created": "2018-03-02T18:25:09.4897514-08:00", + "lastModified": "2018-03-02T18:25:09.4897514-08:00" + } + } + }, + "responses": { + "202": {}, + "200": {}, + "204": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streamingendpoint-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streamingendpoint-list-all.json new file mode 100644 index 000000000000..ff6d93f9ed6e --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streamingendpoint-list-all.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myStreamingEndpoint1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1", + "type": "Microsoft.Media/mediaservices/streamingEndpoints", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "scaleUnits": 1, + "availabilitySetName": "availableset", + "cdnEnabled": false, + "cdnProvider": null, + "cdnProfile": "", + "customHostNames": [], + "maxCacheAge": null, + "hostName": "mystreamingendpoint1-slitestmedia10.streaming.mediaservices.windows.net", + "freeTrialEndTime": "0001-01-01T08:00:00Z", + "provisioningState": "Succeeded", + "resourceState": "Stopped", + "created": "2018-03-03T02:25:09.202013Z", + "lastModified": "2018-03-03T02:25:09.202013Z" + } + }, + { + "name": "default", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/default", + "type": "Microsoft.Media/mediaservices/streamingEndpoints", + "location": "West US", + "tags": {}, + "properties": { + "description": "", + "scaleUnits": 0, + "availabilitySetName": null, + "cdnEnabled": true, + "cdnProvider": "StandardVerizon", + "cdnProfile": "AzureMediaStreamingPlatformCdnProfile-StandardVerizon", + "customHostNames": [], + "maxCacheAge": null, + "hostName": "slitestmedia10.streaming.mediaservices.windows.net", + "freeTrialEndTime": "0001-01-01T00:00:00-08:00", + "provisioningState": "InProgress", + "resourceState": "Starting", + "created": "2018-03-03T02:25:09.2310128Z", + "lastModified": "2018-03-03T02:25:09.2310128Z" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streamingendpoint-list-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streamingendpoint-list-by-name.json new file mode 100644 index 000000000000..87489eb49132 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streamingendpoint-list-by-name.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "streamingEndpointName": "myStreamingEndpoint1", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "name": "myStreamingEndpoint1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1", + "type": "Microsoft.Media/mediaservices/streamingEndpoints", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "scaleUnits": 1, + "availabilitySetName": "availableset", + "cdnEnabled": false, + "cdnProvider": null, + "cdnProfile": "", + "customHostNames": [], + "maxCacheAge": null, + "hostName": "mystreamingendpoint1-slitestmedia10.streaming.mediaservices.windows.net", + "freeTrialEndTime": "0001-01-01T08:00:00Z", + "provisioningState": "Succeeded", + "resourceState": "Stopped", + "created": "2018-03-03T02:25:09.3500423Z", + "lastModified": "2018-03-03T02:25:09.3500423Z" + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streamingendpoint-scale.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streamingendpoint-scale.json new file mode 100644 index 000000000000..5d2429609488 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streamingendpoint-scale.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "streamingEndpointName": "myStreamingEndpoint1", + "api-version": "2021-06-01", + "parameters": { + "scaleUnit": 5 + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streamingendpoint-start.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streamingendpoint-start.json new file mode 100644 index 000000000000..228bbfd0219f --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streamingendpoint-start.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "streamingEndpointName": "myStreamingEndpoint1", + "api-version": "2021-06-01" + }, + "responses": { + "202": {}, + "200": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streamingendpoint-stop.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streamingendpoint-stop.json new file mode 100644 index 000000000000..228bbfd0219f --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streamingendpoint-stop.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "streamingEndpointName": "myStreamingEndpoint1", + "api-version": "2021-06-01" + }, + "responses": { + "202": {}, + "200": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streamingendpoint-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streamingendpoint-update.json new file mode 100644 index 000000000000..dd5f6aa9a155 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/streamingendpoint-update.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "streamingEndpointName": "myStreamingEndpoint1", + "api-version": "2021-06-01", + "parameters": { + "location": "West US", + "tags": { + "tag3": "value3", + "tag5": "value5" + }, + "properties": { + "description": "test event 2", + "scaleUnits": 5, + "availabilitySetName": "availableset" + } + } + }, + "responses": { + "200": { + "body": { + "name": "myStreamingEndpoint1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1", + "type": "Microsoft.Media/mediaservices/streamingEndpoints", + "location": "West US", + "tags": { + "tag3": "value3", + "tag5": "value5" + }, + "properties": { + "description": "test event 2", + "scaleUnits": 5, + "availabilitySetName": "availableset", + "cdnEnabled": false, + "cdnProvider": null, + "cdnProfile": null, + "customHostNames": [], + "maxCacheAge": null, + "hostName": null, + "freeTrialEndTime": "0001-01-01T00:00:00Z", + "provisioningState": "Succeeded", + "resourceState": null, + "created": "0001-01-01T00:00:00Z", + "lastModified": "0001-01-01T00:00:00Z" + } + } + }, + "202": { + "body": { + "name": "myStreamingEndpoint1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1", + "type": "Microsoft.Media/mediaservices/streamingEndpoints", + "location": "West US", + "tags": { + "tag3": "value3", + "tag5": "value5" + }, + "properties": { + "description": "test event 2", + "scaleUnits": 5, + "availabilitySetName": "availableset", + "cdnEnabled": false, + "cdnProvider": null, + "cdnProfile": null, + "customHostNames": [], + "maxCacheAge": null, + "hostName": null, + "freeTrialEndTime": "0001-01-01T00:00:00Z", + "provisioningState": "Succeeded", + "resourceState": null, + "created": "0001-01-01T00:00:00Z", + "lastModified": "0001-01-01T00:00:00Z" + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/transforms-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/transforms-create.json new file mode 100644 index 000000000000..657ae4fba55a --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/transforms-create.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "createdTransform", + "parameters": { + "properties": { + "description": "Example Transform to illustrate create and update.", + "outputs": [ + { + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "AdaptiveStreaming" + } + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "name": "createdTransform", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/createdTransform", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2021-07-12T10:44:29.3367225Z", + "description": "Example Transform to illustrate create and update.", + "lastModified": "2021-07-12T10:44:29.3367225Z", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "AdaptiveStreaming" + } + } + ] + }, + "systemData": { + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-12T10:44:29.3367225Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-12T10:44:29.3367225Z" + } + } + }, + "200": { + "body": { + "name": "createdTransform", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/createdTransform", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2021-07-12T10:44:29.3367225Z", + "description": "Example Transform to illustrate create and update.", + "lastModified": "2021-07-12T10:44:29.3367225Z", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "AdaptiveStreaming" + } + } + ] + }, + "systemData": { + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-12T10:44:29.3367225Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-12T10:44:29.3367225Z" + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/transforms-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/transforms-delete.json new file mode 100644 index 000000000000..d493077038ac --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/transforms-delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "sampleTransform" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/transforms-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/transforms-get-by-name.json new file mode 100644 index 000000000000..8f62e35f2e71 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/transforms-get-by-name.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "sampleTransform" + }, + "responses": { + "200": { + "body": { + "name": "sampleTransform", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/sampleTransform", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2021-07-12T10:44:29.2267128Z", + "description": "A sample Transform using the Standard Encoder with a built in preset.", + "lastModified": "2021-07-12T10:44:29.2267128Z", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "H264MultipleBitrate1080p" + } + } + ] + }, + "systemData": { + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-12T10:44:29.2267128Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-12T10:44:29.2267128Z" + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/transforms-list-all-filter-by-created.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/transforms-list-all-filter-by-created.json new file mode 100644 index 000000000000..4dffd8dcacfa --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/transforms-list-all-filter-by-created.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "$filter": "properties/created gt 2021-06-01T00:00:00.0000000Z and properties/created le 2021-06-01T00:00:10.0000000Z", + "$orderby": "properties/created" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sampleEncodeAndVideoIndex", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/sampleEncodeAndVideoIndex", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2021-06-01T00:00:10Z", + "description": "A sample Transform using the Video Analyzer.", + "lastModified": "2021-06-01T00:00:10Z", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.VideoAnalyzerPreset", + "mode": "Standard", + "insightsToExtract": "AllInsights" + } + } + ] + }, + "systemData": { + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "createdAt": "2021-06-01T00:00:10Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-01T00:00:10Z" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/transforms-list-all-filter-by-lastmodified.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/transforms-list-all-filter-by-lastmodified.json new file mode 100644 index 000000000000..63599265dc18 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/transforms-list-all-filter-by-lastmodified.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "$filter": "properties/lastmodified gt 2021-06-01T00:00:00.0000000Z and properties/lastmodified le 2021-06-01T00:00:10.0000000Z", + "$orderby": "properties/lastmodified desc" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sampleEncodeAndVideoIndex", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/sampleEncodeAndVideoIndex", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2021-06-01T00:00:10Z", + "description": "A sample Transform using the Video Analyzer.", + "lastModified": "2021-06-01T00:00:10Z", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.VideoAnalyzerPreset", + "mode": "Standard", + "insightsToExtract": "AllInsights" + } + } + ] + }, + "systemData": { + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "createdAt": "2021-06-01T00:00:10Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-01T00:00:10Z" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/transforms-list-all-filter-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/transforms-list-all-filter-by-name.json new file mode 100644 index 000000000000..438f56c4998d --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/transforms-list-all-filter-by-name.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "$filter": "(name eq 'sampleEncode') or (name eq 'sampleEncodeAndVideoIndex')", + "$orderby": "name desc" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sampleEncodeAndVideoIndex", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/sampleEncodeAndVideoIndex", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2021-07-12T10:44:28.9563077Z", + "description": "A sample Transform using the Standard Encoder with a built-in preset, as well as the Video Analyzer.", + "lastModified": "2021-07-12T10:44:28.9563077Z", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "AdaptiveStreaming" + } + }, + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.VideoAnalyzerPreset", + "mode": "Standard", + "insightsToExtract": "AllInsights" + } + } + ] + }, + "systemData": { + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-12T10:44:28.9563077Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-12T10:44:28.9563077Z" + } + }, + { + "name": "sampleEncode", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/sampleEncode", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2021-07-12T10:44:28.9563077Z", + "description": "A sample Transform using the Standard Encoder with a built in preset.", + "lastModified": "2021-07-12T10:44:28.9563077Z", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "AdaptiveStreaming" + } + } + ] + }, + "systemData": { + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-12T10:44:28.9563077Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-12T10:44:28.9563077Z" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/transforms-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/transforms-list-all.json new file mode 100644 index 000000000000..5254c10de189 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/transforms-list-all.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sampleEncode", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/sampleEncode", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2021-07-12T10:44:28.1563119Z", + "description": "A sample Transform using the Standard Encoder with a built in preset.", + "lastModified": "2021-07-12T10:44:28.1563119Z", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "AdaptiveStreaming" + } + } + ] + }, + "systemData": { + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-12T10:44:28.1563119Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-12T10:44:28.1563119Z" + } + }, + { + "name": "sampleEncodeAndVideoIndex", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/sampleEncodeAndVideoIndex", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2021-07-12T10:44:28.281304Z", + "description": "A sample Transform using the Standard Encoder with a built-in preset, as well as the Video Analyzer.", + "lastModified": "2021-07-12T10:44:28.281304Z", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "AdaptiveStreaming" + } + }, + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.VideoAnalyzerPreset", + "mode": "Standard", + "insightsToExtract": "AllInsights" + } + } + ] + }, + "systemData": { + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-12T10:44:28.281304Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-12T10:44:28.281304Z" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/transforms-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/transforms-update.json new file mode 100644 index 000000000000..c31b656154da --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/examples/transforms-update.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "transformToUpdate", + "parameters": { + "properties": { + "description": "Example transform to illustrate update.", + "outputs": [ + { + "relativePriority": "High", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "H264MultipleBitrate720p" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "transformToUpdate", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/transformToUpdate", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2021-07-12T10:44:29.6217348Z", + "description": "Example transform to illustrate update.", + "lastModified": "2021-07-12T10:44:29.6267341Z", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "High", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "H264MultipleBitrate720p" + } + } + ] + }, + "systemData": { + "createdBy": "contoso@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-12T10:44:29.6217348Z", + "lastModifiedBy": "contoso@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-12T10:44:29.6267341Z" + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/streamingservice.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/streamingservice.json new file mode 100644 index 000000000000..a157ea33a196 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2021-06-01/streamingservice.json @@ -0,0 +1,2045 @@ +{ + "schemes": [ + "https" + ], + "swagger": "2.0", + "info": { + "title": "Azure Media Services", + "description": "Live event and streaming endpoint management APIs", + "version": "2021-06-01" + }, + "host": "management.azure.com", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents": { + "get": { + "tags": [ + "LiveEvents" + ], + "summary": "List live events", + "description": "Lists all the live events in the account.", + "operationId": "LiveEvents_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/LiveEventListResult" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-examples": { + "List all LiveEvents": { + "$ref": "examples/liveevent-list-all.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}": { + "get": { + "tags": [ + "LiveEvents" + ], + "summary": "Get Live Event", + "description": "Gets properties of a live event.", + "operationId": "LiveEvents_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/LiveEvent" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a LiveEvent by name": { + "$ref": "examples/liveevent-list-by-name.json" + } + } + }, + "put": { + "tags": [ + "LiveEvents" + ], + "summary": "Create Live Event", + "description": "Creates a new live event.", + "operationId": "LiveEvents_Create", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/StreamingResourceAutoStart" + }, + { + "name": "parameters", + "description": "Live event properties needed for creation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LiveEvent" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/LiveEvent" + } + }, + "201": { + "description": "Created. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on monitoring asynchronous Azure operations using the Azure-AsyncOperation response header.", + "schema": { + "$ref": "#/definitions/LiveEvent" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a LiveEvent": { + "$ref": "examples/liveevent-create.json" + } + } + }, + "patch": { + "tags": [ + "LiveEvents" + ], + "description": "Updates settings on an existing live event.", + "operationId": "LiveEvents_Update", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "parameters", + "description": "Live event properties needed for patch.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LiveEvent" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/LiveEvent" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on the monitoring asynchronous Azure Operations.", + "schema": { + "$ref": "#/definitions/LiveEvent" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a LiveEvent": { + "$ref": "examples/liveevent-update.json" + } + } + }, + "delete": { + "tags": [ + "LiveEvents" + ], + "summary": "Delete Live Event", + "description": "Deletes a live event.", + "operationId": "LiveEvents_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on the monitoring asynchronous Azure Operations." + }, + "204": { + "description": "No content. The request has been accepted but the live event was not found." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a LiveEvent": { + "$ref": "examples/liveevent-delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/allocate": { + "post": { + "tags": [ + "LiveEvents" + ], + "summary": "Allocate resources for a live event", + "description": "A live event is in StandBy state after allocation completes, and is ready to start.", + "operationId": "LiveEvents_Allocate", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on the monitoring asynchronous Azure Operations." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Allocate a LiveEvent": { + "$ref": "examples/liveevent-allocate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/start": { + "post": { + "tags": [ + "LiveEvents" + ], + "summary": "Start Live Event", + "description": "A live event in Stopped or StandBy state will be in Running state after the start operation completes.", + "operationId": "LiveEvents_Start", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on the monitoring asynchronous Azure Operations." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Start a LiveEvent": { + "$ref": "examples/liveevent-start.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/stop": { + "post": { + "tags": [ + "LiveEvents" + ], + "summary": "Stop Live Event", + "description": "Stops a running live event.", + "operationId": "LiveEvents_Stop", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "parameters", + "description": "LiveEvent stop parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LiveEventActionInput" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on the monitoring asynchronous Azure Operations." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Stop a LiveEvent": { + "$ref": "examples/liveevent-stop.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/reset": { + "post": { + "tags": [ + "LiveEvents" + ], + "summary": "Reset Live Event", + "description": "Resets an existing live event. All live outputs for the live event are deleted and the live event is stopped and will be started again. All assets used by the live outputs and streaming locators created on these assets are unaffected. ", + "operationId": "LiveEvents_Reset", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on the monitoring asynchronous Azure Operations." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Reset a LiveEvent": { + "$ref": "examples/liveevent-reset.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/liveOutputs": { + "get": { + "tags": [ + "LiveOutputs" + ], + "summary": "List Live Outputs", + "description": "Lists the live outputs of a live event.", + "operationId": "LiveOutputs_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/LiveOutputListResult" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-examples": { + "List all LiveOutputs": { + "$ref": "examples/liveoutput-list-all.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/liveOutputs/{liveOutputName}": { + "get": { + "tags": [ + "LiveOutputs" + ], + "summary": "Get Live Output", + "description": "Gets a live output.", + "operationId": "LiveOutputs_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/LiveOutputName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/LiveOutput" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a LiveOutput by name": { + "$ref": "examples/liveoutput-list-by-name.json" + } + } + }, + "put": { + "tags": [ + "LiveOutputs" + ], + "summary": "Create Live Output", + "description": "Creates a new live output.", + "operationId": "LiveOutputs_Create", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/LiveOutputName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "parameters", + "description": "Live Output properties needed for creation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LiveOutput" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/LiveOutput" + } + }, + "201": { + "description": "Created. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on monitoring asynchronous Azure operations using the Azure-AsyncOperation response header.", + "schema": { + "$ref": "#/definitions/LiveOutput" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a LiveOutput": { + "$ref": "examples/liveoutput-create.json" + } + } + }, + "delete": { + "tags": [ + "LiveOutputs" + ], + "summary": "Delete Live Output", + "description": "Deletes a live output. Deleting a live output does not delete the asset the live output is writing to.", + "operationId": "LiveOutputs_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/LiveOutputName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on the monitoring asynchronous Azure Operations." + }, + "204": { + "description": "No content. The request has been accepted but the live output was not found." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a LiveOutput": { + "$ref": "examples/liveoutput-delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints": { + "get": { + "tags": [ + "StreamingEndpoints" + ], + "summary": "List StreamingEndpoints", + "description": "Lists the streaming endpoints in the account.", + "operationId": "StreamingEndpoints_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/StreamingEndpointListResult" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-examples": { + "List all streaming endpoints": { + "$ref": "examples/streamingendpoint-list-all.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints/{streamingEndpointName}": { + "get": { + "tags": [ + "StreamingEndpoints" + ], + "summary": "Get StreamingEndpoint", + "description": "Gets a streaming endpoint.", + "operationId": "StreamingEndpoints_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/StreamingEndpointName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/StreamingEndpoint" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a streaming endpoint by name": { + "$ref": "examples/streamingendpoint-list-by-name.json" + } + } + }, + "put": { + "tags": [ + "StreamingEndpoints" + ], + "summary": "Create StreamingEndpoint", + "description": "Creates a streaming endpoint.", + "operationId": "StreamingEndpoints_Create", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/StreamingEndpointName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/StreamingResourceAutoStart" + }, + { + "name": "parameters", + "description": "Streaming endpoint properties needed for creation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StreamingEndpoint" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/StreamingEndpoint" + } + }, + "201": { + "description": "Created. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on monitoring asynchronous Azure operations using the Azure-AsyncOperation response header.", + "schema": { + "$ref": "#/definitions/StreamingEndpoint" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a streaming endpoint": { + "$ref": "examples/streamingendpoint-create.json" + } + } + }, + "patch": { + "tags": [ + "StreamingEndpoint" + ], + "summary": "Update StreamingEndpoint", + "description": "Updates a existing streaming endpoint.", + "operationId": "StreamingEndpoints_Update", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/StreamingEndpointName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "parameters", + "description": "Streaming endpoint properties needed for creation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StreamingEndpoint" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/StreamingEndpoint" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on the monitoring asynchronous Azure Operations.", + "schema": { + "$ref": "#/definitions/StreamingEndpoint" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a streaming endpoint": { + "$ref": "examples/streamingendpoint-update.json" + } + } + }, + "delete": { + "tags": [ + "StreamingEndpoints" + ], + "summary": "Delete StreamingEndpoint", + "description": "Deletes a streaming endpoint.", + "operationId": "StreamingEndpoints_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/StreamingEndpointName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on the monitoring asynchronous Azure Operations." + }, + "204": { + "description": "No content. The request has been accepted but the Streaming Endpoint was not found." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a streaming endpoint": { + "$ref": "examples/streamingendpoint-delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints/{streamingEndpointName}/start": { + "post": { + "tags": [ + "StreamingEndpoints" + ], + "summary": "Start StreamingEndpoint", + "description": "Starts an existing streaming endpoint.", + "operationId": "StreamingEndpoints_Start", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/StreamingEndpointName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on the monitoring asynchronous Azure Operations." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Start a streaming endpoint": { + "$ref": "examples/streamingendpoint-start.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints/{streamingEndpointName}/stop": { + "post": { + "tags": [ + "StreamingEndpoints" + ], + "summary": "Stop StreamingEndpoint", + "description": "Stops an existing streaming endpoint.", + "operationId": "StreamingEndpoints_Stop", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/StreamingEndpointName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on the monitoring asynchronous Azure Operations." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Stop a streaming endpoint": { + "$ref": "examples/streamingendpoint-stop.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints/{streamingEndpointName}/scale": { + "post": { + "tags": [ + "StreamingEndpoints" + ], + "summary": "Scale StreamingEndpoint", + "description": "Scales an existing streaming endpoint.", + "operationId": "StreamingEndpoints_Scale", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/StreamingEndpointName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "parameters", + "description": "Streaming endpoint scale parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StreamingEntityScaleUnit" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on the monitoring asynchronous Azure Operations." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Scale a StreamingEndpoint": { + "$ref": "examples/streamingendpoint-scale.json" + } + } + } + } + }, + "definitions": { + "Hls": { + "type": "object", + "properties": { + "fragmentsPerTsSegment": { + "format": "int32", + "type": "integer", + "description": "The number of fragments in an HTTP Live Streaming (HLS) TS segment in the output of the live event. This value does not affect the packing ratio for HLS CMAF output." + } + }, + "description": "HTTP Live Streaming (HLS) packing setting for the live output." + }, + "LiveOutputProperties": { + "type": "object", + "required": [ + "assetName", + "archiveWindowLength" + ], + "properties": { + "description": { + "type": "string", + "description": "The description of the live output." + }, + "assetName": { + "type": "string", + "description": "The asset that the live output will write to." + }, + "archiveWindowLength": { + "format": "duration", + "type": "string", + "description": "ISO 8601 time between 1 minute to 25 hours to indicate the maximum content length that can be archived in the asset for this live output. This also sets the maximum content length for the rewind window. For example, use PT1H30M to indicate 1 hour and 30 minutes of archive window." + }, + "manifestName": { + "type": "string", + "description": "The manifest file name. If not provided, the service will generate one automatically." + }, + "hls": { + "type": "object", + "$ref": "#/definitions/Hls", + "description": "HTTP Live Streaming (HLS) packing setting for the live output." + }, + "outputSnapTime": { + "type": "integer", + "format": "int64", + "description": "The initial timestamp that the live output will start at, any content before this value will not be archived." + }, + "created": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The creation time the live output." + }, + "lastModified": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The time the live output was last modified." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the live output." + }, + "resourceState": { + "description": "The resource state of the live output.", + "readOnly": true, + "type": "string", + "enum": [ + "Creating", + "Running", + "Deleting" + ], + "x-ms-enum": { + "name": "LiveOutputResourceState", + "values": [ + { + "value": "Creating", + "description": "Live output is being created. No content is archived in the asset until the live output is in running state." + }, + { + "value": "Running", + "description": "Live output is running and archiving live streaming content to the asset if there is valid input from a contribution encoder." + }, + { + "value": "Deleting", + "description": "Live output is being deleted. The live asset is being converted from live to on-demand asset. Any streaming URLs created on the live output asset continue to work." + } + ], + "modelAsString": true + } + } + }, + "description": "The JSON object that contains the properties required to create a live output." + }, + "LiveOutput": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LiveOutputProperties", + "description": "Live output properties." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "The system metadata relating to this resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "The Live Output." + }, + "LiveOutputListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LiveOutput" + }, + "description": "The result of the List LiveOutput operation." + }, + "@odata.count": { + "type": "integer", + "format": "int32", + "description": "The number of result." + }, + "@odata.nextLink": { + "type": "string", + "description": "The link to the next set of results. Not empty if value contains incomplete list of live outputs." + } + }, + "description": "The LiveOutput list result.", + "title": "LiveOutputListResult" + }, + "LiveEventEndpoint": { + "type": "object", + "properties": { + "protocol": { + "type": "string", + "description": "The endpoint protocol." + }, + "url": { + "type": "string", + "description": "The endpoint URL." + } + }, + "description": "The live event endpoint." + }, + "LiveEventInputAccessControl": { + "type": "object", + "properties": { + "ip": { + "type": "object", + "$ref": "#/definitions/IPAccessControl", + "description": "The IP access control properties." + } + }, + "description": "The IP access control for live event input." + }, + "LiveEventInput": { + "type": "object", + "required": [ + "streamingProtocol" + ], + "properties": { + "streamingProtocol": { + "type": "string", + "description": "The input protocol for the live event. This is specified at creation time and cannot be updated.", + "enum": [ + "FragmentedMP4", + "RTMP" + ], + "x-ms-enum": { + "name": "LiveEventInputProtocol", + "values": [ + { + "value": "FragmentedMP4", + "description": "Smooth Streaming input will be sent by the contribution encoder to the live event." + }, + { + "value": "RTMP", + "description": "RTMP input will be sent by the contribution encoder to the live event." + } + ], + "modelAsString": true + } + }, + "accessControl": { + "type": "object", + "$ref": "#/definitions/LiveEventInputAccessControl", + "description": "Access control for live event input." + }, + "keyFrameIntervalDuration": { + "type": "string", + "description": "ISO 8601 time duration of the key frame interval duration of the input. This value sets the EXT-X-TARGETDURATION property in the HLS output. For example, use PT2S to indicate 2 seconds. Leave the value empty for encoding live events." + }, + "accessToken": { + "type": "string", + "description": "A UUID in string form to uniquely identify the stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value." + }, + "endpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/LiveEventEndpoint" + }, + "description": "The input endpoints for the live event." + } + }, + "description": "The live event input." + }, + "IPRange": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The friendly name for the IP address range." + }, + "address": { + "type": "string", + "description": "The IP address." + }, + "subnetPrefixLength": { + "format": "int32", + "type": "integer", + "description": "The subnet mask prefix length (see CIDR notation)." + } + }, + "description": "The IP address range in the CIDR scheme." + }, + "IPAccessControl": { + "type": "object", + "properties": { + "allow": { + "type": "array", + "items": { + "$ref": "#/definitions/IPRange" + }, + "description": "The IP allow list." + } + }, + "description": "The IP access control." + }, + "LiveEventPreviewAccessControl": { + "type": "object", + "properties": { + "ip": { + "type": "object", + "$ref": "#/definitions/IPAccessControl", + "description": "The IP access control properties." + } + }, + "description": "The IP access control for the live event preview endpoint." + }, + "LiveEventPreview": { + "type": "object", + "properties": { + "endpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/LiveEventEndpoint" + }, + "description": "The endpoints for preview. Do not share the preview URL with the live event audience." + }, + "accessControl": { + "type": "object", + "$ref": "#/definitions/LiveEventPreviewAccessControl", + "description": "The access control for live event preview." + }, + "previewLocator": { + "type": "string", + "description": "The identifier of the preview locator in Guid format. Specifying this at creation time allows the caller to know the preview locator url before the event is created. If omitted, the service will generate a random identifier. This value cannot be updated once the live event is created." + }, + "streamingPolicyName": { + "type": "string", + "description": "The name of streaming policy used for the live event preview. This value is specified at creation time and cannot be updated." + }, + "alternativeMediaId": { + "type": "string", + "description": "An alternative media identifier associated with the streaming locator created for the preview. This value is specified at creation time and cannot be updated. The identifier can be used in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field." + } + }, + "description": "Live event preview settings." + }, + "LiveEventEncoding": { + "type": "object", + "properties": { + "encodingType": { + "type": "string", + "description": "Live event type. When encodingType is set to PassthroughBasic or PassthroughStandard, the service simply passes through the incoming video and audio layer(s) to the output. When encodingType is set to Standard or Premium1080p, a live encoder transcodes the incoming stream into multiple bitrates or layers. See https://go.microsoft.com/fwlink/?linkid=2095101 for more information. This property cannot be modified after the live event is created.", + "enum": [ + "None", + "Standard", + "Premium1080p", + "PassthroughBasic", + "PassthroughStandard" + ], + "x-ms-enum": { + "name": "LiveEventEncodingType", + "values": [ + { + "value": "None", + "description": "This is the same as PassthroughStandard, please see description below. This enumeration value is being deprecated." + }, + { + "value": "Standard", + "description": "A contribution live encoder sends a single bitrate stream to the live event and Media Services creates multiple bitrate streams. The output cannot exceed 720p in resolution." + }, + { + "value": "Premium1080p", + "description": "A contribution live encoder sends a single bitrate stream to the live event and Media Services creates multiple bitrate streams. The output cannot exceed 1080p in resolution." + }, + { + "value": "PassthroughBasic", + "description": "The ingested stream passes through the live event from the contribution encoder without any further processing. In the PassthroughBasic mode, ingestion is limited to up to 5Mbps and only 1 concurrent live output is allowed. Live transcription is not available." + }, + { + "value": "PassthroughStandard", + "description": "The ingested stream passes through the live event from the contribution encoder without any further processing. Live transcription is available. Ingestion bitrate limits are much higher and up to 3 concurrent live outputs are allowed." + } + ], + "modelAsString": true + } + }, + "presetName": { + "type": "string", + "description": "The optional encoding preset name, used when encodingType is not None. This value is specified at creation time and cannot be updated. If the encodingType is set to Standard, then the default preset name is ‘Default720p’. Else if the encodingType is set to Premium1080p, the default preset is ‘Default1080p’." + }, + "stretchMode": { + "type": "string", + "enum": [ + "None", + "AutoSize", + "AutoFit" + ], + "x-ms-enum": { + "name": "StretchMode", + "values": [ + { + "value": "None", + "description": "Strictly respects the output resolution specified in the encoding preset without considering the pixel aspect ratio or display aspect ratio of the input video." + }, + { + "value": "AutoSize", + "description": "Override the output resolution, and change it to match the display aspect ratio of the input, without padding. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the value in the preset is overridden, and the output will be at 1280x720, which maintains the input aspect ratio of 16:9." + }, + { + "value": "AutoFit", + "description": "Pad the output (with either letterbox or pillar box) to honor the output resolution, while ensuring that the active video region in the output has the same aspect ratio as the input. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the output will be at 1280x1280, which contains an inner rectangle of 1280x720 at aspect ratio of 16:9, and pillar box regions 280 pixels wide at the left and right." + } + ], + "modelAsString": true + }, + "description": "Specifies how the input video will be resized to fit the desired output resolution(s). Default is None" + }, + "keyFrameInterval": { + "type": "string", + "format": "duration", + "description": "Use an ISO 8601 time value between 0.5 to 20 seconds to specify the output fragment length for the video and audio tracks of an encoding live event. For example, use PT2S to indicate 2 seconds. For the video track it also defines the key frame interval, or the length of a GoP (group of pictures). If this value is not set for an encoding live event, the fragment duration defaults to 2 seconds. The value cannot be set for pass-through live events." + } + }, + "description": "Specifies the live event type and optional encoding settings for encoding live events." + }, + "LiveEventInputTrackSelection": { + "type": "object", + "properties": { + "property": { + "type": "string", + "description": "Property name to select. This property is reserved for future use, any value set on this property will be ignored." + }, + "operation": { + "type": "string", + "description": "Comparing operation. This property is reserved for future use, any value set on this property will be ignored." + }, + "value": { + "type": "string", + "description": "Property value to select. This property is reserved for future use, any value set on this property will be ignored." + } + }, + "description": "A track selection condition. This property is reserved for future use, any value set on this property will be ignored." + }, + "LiveEventOutputTranscriptionTrack": { + "type": "object", + "required": [ + "trackName" + ], + "properties": { + "trackName": { + "type": "string", + "description": "The output track name. This property is reserved for future use, any value set on this property will be ignored." + } + }, + "description": "Describes a transcription track in the output of a live event, generated using speech-to-text transcription. This property is reserved for future use, any value set on this property will be ignored." + }, + "LiveEventTranscription": { + "type": "object", + "properties": { + "language": { + "type": "string", + "description": "Specifies the language (locale) to be used for speech-to-text transcription – it should match the spoken language in the audio track. The value should be in BCP-47 format (e.g: 'en-US'). See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature and the list of supported languages." + }, + "inputTrackSelection": { + "type": "array", + "description": "Provides a mechanism to select the audio track in the input live feed, to which speech-to-text transcription is applied. This property is reserved for future use, any value set on this property will be ignored.", + "items": { + "$ref": "#/definitions/LiveEventInputTrackSelection" + } + }, + "outputTranscriptionTrack": { + "type": "object", + "$ref": "#/definitions/LiveEventOutputTranscriptionTrack", + "description": "Describes a transcription track in the output of a live event, generated using speech-to-text transcription. This property is reserved for future use, any value set on this property will be ignored." + } + }, + "description": "Describes the transcription tracks in the output of a live event, generated using speech-to-text transcription. This property is reserved for future use, any value set on this property will be ignored." + }, + "CrossSiteAccessPolicies": { + "type": "object", + "properties": { + "clientAccessPolicy": { + "type": "string", + "description": "The content of clientaccesspolicy.xml used by Silverlight." + }, + "crossDomainPolicy": { + "type": "string", + "description": "The content of crossdomain.xml used by Silverlight." + } + }, + "description": "The client access policy." + }, + "LiveEventActionInput": { + "type": "object", + "properties": { + "removeOutputsOnStop": { + "type": "boolean", + "description": "The flag indicates whether live outputs are automatically deleted when live event is being stopped. Deleting live outputs do not delete the underlying assets." + } + }, + "description": "The LiveEvent action input parameter definition." + }, + "LiveEventProperties": { + "type": "object", + "required": [ + "input" + ], + "properties": { + "description": { + "type": "string", + "description": "A description for the live event." + }, + "input": { + "type": "object", + "$ref": "#/definitions/LiveEventInput", + "description": "Live event input settings. It defines how the live event receives input from a contribution encoder." + }, + "preview": { + "type": "object", + "$ref": "#/definitions/LiveEventPreview", + "description": "Live event preview settings. Preview allows live event producers to preview the live streaming content without creating any live output." + }, + "encoding": { + "type": "object", + "$ref": "#/definitions/LiveEventEncoding", + "description": "Encoding settings for the live event. It configures whether a live encoder is used for the live event and settings for the live encoder if it is used." + }, + "transcriptions": { + "type": "array", + "items": { + "$ref": "#/definitions/LiveEventTranscription" + }, + "description": "Live transcription settings for the live event. See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the live event." + }, + "resourceState": { + "readOnly": true, + "type": "string", + "description": "The resource state of the live event. See https://go.microsoft.com/fwlink/?linkid=2139012 for more information.", + "enum": [ + "Stopped", + "Allocating", + "StandBy", + "Starting", + "Running", + "Stopping", + "Deleting" + ], + "x-ms-enum": { + "name": "LiveEventResourceState", + "values": [ + { + "value": "Stopped", + "description": "This is the initial state of the live event after creation (unless autostart was set to true.) No billing occurs in this state. In this state, the live event properties can be updated but streaming is not allowed." + }, + { + "value": "Allocating", + "description": "Allocate action was called on the live event and resources are being provisioned for this live event. Once allocation completes successfully, the live event will transition to StandBy state." + }, + { + "value": "StandBy", + "description": "Live event resources have been provisioned and is ready to start. Billing occurs in this state. Most properties can still be updated, however ingest or streaming is not allowed during this state." + }, + { + "value": "Starting", + "description": "The live event is being started and resources are being allocated. No billing occurs in this state. Updates or streaming are not allowed during this state. If an error occurs, the live event returns to the Stopped state." + }, + { + "value": "Running", + "description": "The live event resources have been allocated, ingest and preview URLs have been generated, and it is capable of receiving live streams. At this point, billing is active. You must explicitly call Stop on the live event resource to halt further billing." + }, + { + "value": "Stopping", + "description": "The live event is being stopped and resources are being de-provisioned. No billing occurs in this transient state. Updates or streaming are not allowed during this state." + }, + { + "value": "Deleting", + "description": "The live event is being deleted. No billing occurs in this transient state. Updates or streaming are not allowed during this state." + } + ], + "modelAsString": true + } + }, + "crossSiteAccessPolicies": { + "type": "object", + "$ref": "#/definitions/CrossSiteAccessPolicies", + "description": "Live event cross site access policies." + }, + "useStaticHostname": { + "type": "boolean", + "description": "Specifies whether a static hostname would be assigned to the live event preview and ingest endpoints. This value can only be updated if the live event is in Standby state" + }, + "hostnamePrefix": { + "type": "string", + "description": "When useStaticHostname is set to true, the hostnamePrefix specifies the first part of the hostname assigned to the live event preview and ingest endpoints. The final hostname would be a combination of this prefix, the media service account name and a short code for the Azure Media Services data center." + }, + "streamOptions": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Default", + "LowLatency" + ], + "x-ms-enum": { + "name": "StreamOptionsFlag", + "values": [ + { + "value": "Default", + "description": "Live streaming with no special latency optimizations." + }, + { + "value": "LowLatency", + "description": "The live event provides lower end to end latency by reducing its internal buffers. This could result in more client buffering during playback if network bandwidth is low." + } + ], + "modelAsString": true + } + }, + "description": "The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. The valid values for the array entry values are 'Default' and 'LowLatency'." + }, + "created": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The creation time for the live event" + }, + "lastModified": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The last modified time of the live event." + } + }, + "description": "The live event properties." + }, + "LiveEvent": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LiveEventProperties", + "description": "The live event properties." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "The system metadata relating to this resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "description": "The live event." + }, + "LiveEventListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LiveEvent" + }, + "description": "The result of the List Live Event operation." + }, + "@odata.count": { + "type": "integer", + "format": "int32", + "description": "The number of result." + }, + "@odata.nextLink": { + "type": "string", + "description": "The link to the next set of results. Not empty if value contains incomplete list of live outputs." + } + }, + "description": "The LiveEvent list result.", + "title": "LiveEventListResult" + }, + "AkamaiSignatureHeaderAuthenticationKey": { + "type": "object", + "properties": { + "identifier": { + "type": "string", + "description": "identifier of the key" + }, + "base64Key": { + "type": "string", + "description": "authentication key" + }, + "expiration": { + "format": "date-time", + "type": "string", + "description": "The expiration time of the authentication key." + } + }, + "description": "Akamai Signature Header authentication key." + }, + "AkamaiAccessControl": { + "type": "object", + "properties": { + "akamaiSignatureHeaderAuthenticationKeyList": { + "type": "array", + "items": { + "$ref": "#/definitions/AkamaiSignatureHeaderAuthenticationKey" + }, + "description": "authentication key list" + } + }, + "description": "Akamai access control" + }, + "StreamingEndpointAccessControl": { + "type": "object", + "properties": { + "akamai": { + "type": "object", + "$ref": "#/definitions/AkamaiAccessControl", + "description": "The access control of Akamai" + }, + "ip": { + "type": "object", + "$ref": "#/definitions/IPAccessControl", + "description": "The IP access control of the streaming endpoint." + } + }, + "description": "Streaming endpoint access control definition." + }, + "StreamingEntityScaleUnit": { + "type": "object", + "properties": { + "scaleUnit": { + "type": "integer", + "format": "int32", + "description": "The scale unit number of the streaming endpoint." + } + }, + "description": "scale units definition" + }, + "StreamingEndpointProperties": { + "type": "object", + "required": [ + "scaleUnits" + ], + "properties": { + "description": { + "type": "string", + "description": "The streaming endpoint description." + }, + "scaleUnits": { + "type": "integer", + "format": "int32", + "description": "The number of scale units. Use the Scale operation to adjust this value." + }, + "availabilitySetName": { + "type": "string", + "description": "This feature is deprecated, do not set a value for this property." + }, + "accessControl": { + "type": "object", + "$ref": "#/definitions/StreamingEndpointAccessControl", + "description": "The access control definition of the streaming endpoint." + }, + "maxCacheAge": { + "type": "integer", + "format": "int64", + "description": "Max cache age" + }, + "customHostNames": { + "type": "array", + "items": { + "type": "string", + "description": "custom host name" + }, + "description": "The custom host names of the streaming endpoint" + }, + "hostName": { + "readOnly": true, + "type": "string", + "description": "The streaming endpoint host name." + }, + "cdnEnabled": { + "type": "boolean", + "description": "The CDN enabled flag." + }, + "cdnProvider": { + "type": "string", + "description": "The CDN provider name." + }, + "cdnProfile": { + "type": "string", + "description": "The CDN profile name." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the streaming endpoint." + }, + "resourceState": { + "readOnly": true, + "type": "string", + "description": "The resource state of the streaming endpoint.", + "enum": [ + "Stopped", + "Starting", + "Running", + "Stopping", + "Deleting", + "Scaling" + ], + "x-ms-enum": { + "name": "StreamingEndpointResourceState", + "values": [ + { + "value": "Stopped", + "description": "The initial state of a streaming endpoint after creation. Content is not ready to be streamed from this endpoint." + }, + { + "value": "Starting", + "description": "The streaming endpoint is transitioning to the running state." + }, + { + "value": "Running", + "description": "The streaming endpoint is running. It is able to stream content to clients" + }, + { + "value": "Stopping", + "description": "The streaming endpoint is transitioning to the stopped state." + }, + { + "value": "Deleting", + "description": "The streaming endpoint is being deleted." + }, + { + "value": "Scaling", + "description": "The streaming endpoint is increasing or decreasing scale units." + } + ], + "modelAsString": true + } + }, + "crossSiteAccessPolicies": { + "type": "object", + "$ref": "#/definitions/CrossSiteAccessPolicies", + "description": "The streaming endpoint access policies." + }, + "freeTrialEndTime": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The free trial expiration time." + }, + "created": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the streaming endpoint was created." + }, + "lastModified": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the streaming endpoint was last modified." + } + }, + "description": "The streaming endpoint properties." + }, + "StreamingEndpoint": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StreamingEndpointProperties", + "description": "The streaming endpoint properties." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "The system metadata relating to this resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "description": "The streaming endpoint." + }, + "StreamingEndpointListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/StreamingEndpoint" + }, + "description": "The result of the List StreamingEndpoint operation." + }, + "@odata.count": { + "type": "integer", + "format": "int32", + "description": "The number of result." + }, + "@odata.nextLink": { + "type": "string", + "description": "The link to the next set of results. Not empty if value contains incomplete list of streaming endpoints." + } + }, + "description": "The streaming endpoint list result.", + "title": "StreamingEndpointListResult" + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "description": "The unique identifier for a Microsoft Azure subscription.", + "in": "path", + "required": true, + "type": "string" + }, + "ApiVersion": { + "name": "api-version", + "description": "The version of the API to be used with the client request.", + "in": "query", + "required": true, + "type": "string" + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "description": "The name of the resource group within the Azure subscription.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "MediaServicesAccountName": { + "name": "accountName", + "description": "The Media Services account name.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "LiveEventName": { + "name": "liveEventName", + "description": "The name of the live event, maximum length is 32.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$", + "minLength": 1, + "maxLength": 32, + "x-ms-parameter-location": "method" + }, + "StreamingResourceAutoStart": { + "name": "autoStart", + "description": "The flag indicates if the resource should be automatically started on creation.", + "in": "query", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "LiveOutputName": { + "name": "liveOutputName", + "description": "The name of the live output.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^([a-zA-Z0-9])+(-*[a-zA-Z0-9])*$", + "minLength": 1, + "maxLength": 256, + "x-ms-parameter-location": "method" + }, + "StreamingEndpointName": { + "name": "streamingEndpointName", + "description": "The name of the streaming endpoint, maximum length is 24.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$", + "minLength": 1, + "maxLength": 24, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/mediaservices/resource-manager/readme.go.md b/specification/mediaservices/resource-manager/readme.go.md index c788504d54bf..98beb9ed5ca3 100644 --- a/specification/mediaservices/resource-manager/readme.go.md +++ b/specification/mediaservices/resource-manager/readme.go.md @@ -13,6 +13,7 @@ go: ```yaml $(go) && $(multiapi) batch: + - tag: package-2021-06 - tag: package-2021-05 - tag: package-2020-05 - tag: package-2015-10 @@ -22,6 +23,15 @@ batch: - tag: package-2019-05-preview ``` +### Tag: package-2021-06 and go + +These settings apply only when `--tag=package-2021-06 --go` is specified on the command line. +Please also specify the `--go-sdk-folder=`. + +```yaml $(tag) == 'package-2021-06' && $(go) +output-folder: $(go-sdk-folder)/services/mediaservices/mgmt/2021-06-01/$(namespace) +``` + ### Tag: package-2021-05 and go These settings apply only when `--tag=package-2021-05 --go` is specified on the command line. diff --git a/specification/mediaservices/resource-manager/readme.md b/specification/mediaservices/resource-manager/readme.md index a929be237871..4381acc237a2 100644 --- a/specification/mediaservices/resource-manager/readme.md +++ b/specification/mediaservices/resource-manager/readme.md @@ -26,10 +26,29 @@ These are the global settings for the MediaServices API. ```yaml openapi-type: arm -tag: package-2021-05 +tag: package-2021-06 opt-in-extensible-enums: true ``` +### Tag: package-2021-06 + +These settings apply only when `--tag=package-2021-06` is specified on the command line. + +```yaml $(tag) == 'package-2021-06' +input-file: + - Microsoft.Media/stable/2021-06-01/Accounts.json + - Microsoft.Media/stable/2021-06-01/AccountFilters.json + - Microsoft.Media/stable/2021-06-01/AssetsAndAssetFilters.json + - Microsoft.Media/stable/2021-06-01/ContentKeyPolicies.json + - Microsoft.Media/stable/2021-06-01/Encoding.json + - Microsoft.Media/stable/2021-06-01/StreamingPoliciesAndStreamingLocators.json + - Microsoft.Media/stable/2021-06-01/streamingservice.json +directive: + - suppress: R2016 + where: $.definitions.TrackedResource.required + reason: location is a required property for our patch calls +``` + ### Tag: package-2021-05 These settings apply only when `--tag=package-2021-05` is specified on the command line. @@ -236,4 +255,3 @@ directive: where: $.definitions.JobProperties reason: Output not required for job update ``` - diff --git a/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/examples/CreateConversion.json b/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/examples/CreateConversion.json index b7e8545f0348..48b287907de8 100644 --- a/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/examples/CreateConversion.json +++ b/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/examples/CreateConversion.json @@ -7,12 +7,12 @@ "body": { "settings": { "inputLocation": { - "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrInput", + "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrinput", "blobPrefix": "models/", "relativeInputAssetPath": "house.fbx" }, "outputLocation": { - "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrOutput", + "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arroutput", "blobPrefix": "conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e", "outputAssetFilename": "convertedHouse.arrAsset" } @@ -29,12 +29,12 @@ "creationTime": "2021-01-01T11:11:11.111Z", "settings": { "inputLocation": { - "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrInput", + "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrinput", "blobPrefix": "models/", "relativeInputAssetPath": "house.fbx" }, "outputLocation": { - "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrOutput", + "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arroutput", "blobPrefix": "conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e", "outputAssetFilename": "convertedHouse.arrAsset" } @@ -52,12 +52,12 @@ "creationTime": "2021-01-01T11:11:11.111Z", "settings": { "inputLocation": { - "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrInput", + "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrinput", "blobPrefix": "models/", "relativeInputAssetPath": "house.fbx" }, "outputLocation": { - "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrOutput", + "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arroutput", "blobPrefix": "conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e", "outputAssetFilename": "convertedHouse.arrAsset" } diff --git a/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/examples/GetConversion.json b/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/examples/GetConversion.json index 0abfa0fd57c1..58652293ba3f 100644 --- a/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/examples/GetConversion.json +++ b/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/examples/GetConversion.json @@ -15,12 +15,12 @@ "creationTime": "2021-01-01T11:11:11.111Z", "settings": { "inputLocation": { - "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrInput", + "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrinput", "blobPrefix": "models/", "relativeInputAssetPath": "house.fbx" }, "outputLocation": { - "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrOutput", + "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arroutput", "blobPrefix": "conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e", "outputAssetFilename": "convertedHouse.arrAsset" } @@ -28,7 +28,7 @@ "status": "Succeeded", "error": null, "output": { - "outputAssetUri": "https://contosostorage01.blob.core.windows.net/arrOutput/conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e/convertedHouse.arrAsset" + "outputAssetUri": "https://contosostorage01.blob.core.windows.net/arroutput/conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e/convertedHouse.arrAsset" } } }, diff --git a/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/examples/ListConversions.json b/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/examples/ListConversions.json index 9a53c2ef3bc3..a41bf631d750 100644 --- a/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/examples/ListConversions.json +++ b/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/examples/ListConversions.json @@ -17,12 +17,12 @@ "creationTime": "2021-01-01T11:11:11.111Z", "settings": { "inputLocation": { - "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrInput", + "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrinput", "blobPrefix": "models/", "relativeInputAssetPath": "house.fbx" }, "outputLocation": { - "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrOutput", + "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arroutput", "blobPrefix": "conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e", "outputAssetFilename": "convertedHouse.arrAsset" } @@ -30,7 +30,7 @@ "status": "Succeeded", "error": null, "output": { - "outputAssetUri": "https://contosostorage01.blob.core.windows.net/arrOutput/conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e/convertedHouse.arrAsset" + "outputAssetUri": "https://contosostorage01.blob.core.windows.net/arroutput/conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e/convertedHouse.arrAsset" } }, { @@ -38,12 +38,12 @@ "creationTime": "2021-02-02T11:11:11.111Z", "settings": { "inputLocation": { - "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrInput", + "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrinput", "blobPrefix": "models/", "relativeInputAssetPath": "barrel.fbx" }, "outputLocation": { - "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrOutput", + "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arroutput", "blobPrefix": "conversionOutput/7da568fb-f3da-4b6d-ba75-d18c8e5a015e" } }, diff --git a/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json b/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json index 68c16774cb36..456ba6a3b372 100644 --- a/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json +++ b/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json @@ -966,7 +966,7 @@ "type": "string", "description": "The URI of the Azure blob storage container containing the input model.", "format": "uri", - "example": "https://contosostorage01.blob.core.windows.net/arrInput" + "example": "https://contosostorage01.blob.core.windows.net/arrinput" }, "storageContainerReadListSas": { "type": "string", @@ -996,7 +996,7 @@ "type": "string", "description": "The URI of the Azure blob storage container where the result of the conversion should be written to.", "format": "uri", - "example": "https://contosostorage01.blob.core.windows.net/arrOutput" + "example": "https://contosostorage01.blob.core.windows.net/arroutput" }, "storageContainerWriteSas": { "type": "string", diff --git a/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/CreateConversion.json b/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/CreateConversion.json index b883d2e0ef67..07fd05737714 100644 --- a/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/CreateConversion.json +++ b/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/CreateConversion.json @@ -7,12 +7,12 @@ "body": { "settings": { "inputLocation": { - "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrInput", + "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrinput", "blobPrefix": "models/", "relativeInputAssetPath": "house.fbx" }, "outputLocation": { - "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrOutput", + "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arroutput", "blobPrefix": "conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e", "outputAssetFilename": "convertedHouse.arrAsset" } @@ -29,12 +29,12 @@ "creationTime": "2021-01-01T11:11:11.111Z", "settings": { "inputLocation": { - "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrInput", + "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrinput", "blobPrefix": "models/", "relativeInputAssetPath": "house.fbx" }, "outputLocation": { - "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrOutput", + "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arroutput", "blobPrefix": "conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e", "outputAssetFilename": "convertedHouse.arrAsset" } @@ -52,12 +52,12 @@ "creationTime": "2021-01-01T11:11:11.111Z", "settings": { "inputLocation": { - "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrInput", + "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrinput", "blobPrefix": "models/", "relativeInputAssetPath": "house.fbx" }, "outputLocation": { - "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrOutput", + "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arroutput", "blobPrefix": "conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e", "outputAssetFilename": "convertedHouse.arrAsset" } diff --git a/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/GetConversion.json b/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/GetConversion.json index 8163c4a06823..0429fb17bb86 100644 --- a/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/GetConversion.json +++ b/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/GetConversion.json @@ -15,12 +15,12 @@ "creationTime": "2021-01-01T11:11:11.111Z", "settings": { "inputLocation": { - "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrInput", + "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrinput", "blobPrefix": "models/", "relativeInputAssetPath": "house.fbx" }, "outputLocation": { - "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrOutput", + "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arroutput", "blobPrefix": "conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e", "outputAssetFilename": "convertedHouse.arrAsset" } @@ -28,7 +28,7 @@ "status": "Succeeded", "error": null, "output": { - "outputAssetUri": "https://contosostorage01.blob.core.windows.net/arrOutput/conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e/convertedHouse.arrAsset" + "outputAssetUri": "https://contosostorage01.blob.core.windows.net/arroutput/conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e/convertedHouse.arrAsset" } } }, diff --git a/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/ListConversions.json b/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/ListConversions.json index e88e219e9686..bb2ee95ca517 100644 --- a/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/ListConversions.json +++ b/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/ListConversions.json @@ -17,12 +17,12 @@ "creationTime": "2021-01-01T11:11:11.111Z", "settings": { "inputLocation": { - "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrInput", + "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrinput", "blobPrefix": "models/", "relativeInputAssetPath": "house.fbx" }, "outputLocation": { - "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrOutput", + "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arroutput", "blobPrefix": "conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e", "outputAssetFilename": "convertedHouse.arrAsset" } @@ -30,7 +30,7 @@ "status": "Succeeded", "error": null, "output": { - "outputAssetUri": "https://contosostorage01.blob.core.windows.net/arrOutput/conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e/convertedHouse.arrAsset" + "outputAssetUri": "https://contosostorage01.blob.core.windows.net/arroutput/conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e/convertedHouse.arrAsset" } }, { @@ -38,12 +38,12 @@ "creationTime": "2021-02-02T11:11:11.111Z", "settings": { "inputLocation": { - "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrInput", + "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrinput", "blobPrefix": "models/", "relativeInputAssetPath": "barrel.fbx" }, "outputLocation": { - "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrOutput", + "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arroutput", "blobPrefix": "conversionOutput/7da568fb-f3da-4b6d-ba75-d18c8e5a015e" } }, diff --git a/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/mr-arr.json b/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/mr-arr.json index f7b57b0d7fb8..6af64c98b184 100644 --- a/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/mr-arr.json +++ b/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/mr-arr.json @@ -966,7 +966,7 @@ "type": "string", "description": "The URI of the Azure blob storage container containing the input model.", "format": "uri", - "example": "https://contosostorage01.blob.core.windows.net/arrInput" + "example": "https://contosostorage01.blob.core.windows.net/arrinput" }, "storageContainerReadListSas": { "type": "string", @@ -996,7 +996,7 @@ "type": "string", "description": "The URI of the Azure blob storage container where the result of the conversion should be written to.", "format": "uri", - "example": "https://contosostorage01.blob.core.windows.net/arrOutput" + "example": "https://contosostorage01.blob.core.windows.net/arroutput" }, "storageContainerWriteSas": { "type": "string", diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json index f45dd867b275..c2ec100a8bfd 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json @@ -36,7 +36,7 @@ } }, "paths": { - "/{resourceUri}/providers/microsoft.insights/diagnosticSettingsCategories/{name}": { + "/{resourceUri}/providers/Microsoft.Insights/diagnosticSettingsCategories/{name}": { "get": { "tags": [ "DiagnosticSettingsCategories" @@ -75,7 +75,7 @@ } } }, - "/{resourceUri}/providers/microsoft.insights/diagnosticSettingsCategories": { + "/{resourceUri}/providers/Microsoft.Insights/diagnosticSettingsCategories": { "get": { "tags": [ "DiagnosticSettingsCategories" diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json index 79337a4531f3..8c17d69446e6 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json @@ -36,7 +36,7 @@ } }, "paths": { - "/{resourceUri}/providers/microsoft.insights/diagnosticSettings/{name}": { + "/{resourceUri}/providers/Microsoft.Insights/diagnosticSettings/{name}": { "get": { "tags": [ "DiagnosticSettings" @@ -158,7 +158,7 @@ } } }, - "/{resourceUri}/providers/microsoft.insights/diagnosticSettings": { + "/{resourceUri}/providers/Microsoft.Insights/diagnosticSettings": { "get": { "tags": [ "DiagnosticSettings" diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/metrics_API.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/metrics_API.json index d6bd126f6e6f..ea858a43f2f5 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/metrics_API.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/metrics_API.json @@ -319,6 +319,10 @@ "type": "string", "description": "'Success' or the error details on query failures for this metric." }, + "errorMessage": { + "type": "string", + "description": "Error message encountered querying this specific metric." + }, "unit": { "$ref": "#/definitions/Unit", "description": "the unit of the metric." @@ -335,7 +339,6 @@ "id", "type", "name", - "displayDescription", "unit", "timeseries" ], diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-09-01-preview/examples/GetMetric.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-09-01-preview/examples/GetMetric.json new file mode 100644 index 000000000000..46ebbf135e7a --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-09-01-preview/examples/GetMetric.json @@ -0,0 +1,214 @@ +{ + "parameters": { + "resourceUri": "subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default", + "timespan": "2021-04-21T01:00:00.000Z/2021-04-24T02:00:00.000Z", + "metric": "BlobCapacity", + "$filter": "BlobType eq '*'", + "top": "3", + "orderby": "Average asc", + "aggregation": "Average,count", + "interval": "PT1H", + "api-version": "2017-05-01-preview" + }, + "responses": { + "200": { + "body": { + "cost": 659, + "timespan": "2021-04-21T01:00:00Z/2021-04-21T12:00:00Z", + "interval": "PT1H", + "value": [ + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default/providers/Microsoft.Insights/metrics/BlobCapacity", + "type": "Microsoft.Insights/metrics", + "name": { + "value": "BlobCapacity", + "localizedValue": "Blob Capacity" + }, + "displayDescription": "The amount of storage used by the storage account’s Blob service in bytes.", + "unit": "Bytes", + "timeseries": [ + { + "metadatavalues": [ + { + "name": { + "value": "blobtype", + "localizedValue": "blobtype" + }, + "value": "PageBlob" + } + ], + "data": [ + { + "timeStamp": "2021-04-21T01:00:00Z", + "average": 621492.0 + }, + { + "timeStamp": "2021-04-21T02:00:00Z", + "average": 621492.0 + }, + { + "timeStamp": "2021-04-21T03:00:00Z", + "average": 621492.0 + }, + { + "timeStamp": "2021-04-21T04:00:00Z", + "average": 621492.0 + }, + { + "timeStamp": "2021-04-21T05:00:00Z", + "average": 621492.0 + }, + { + "timeStamp": "2021-04-21T06:00:00Z", + "average": 621492.0 + }, + { + "timeStamp": "2021-04-21T07:00:00Z", + "average": 621492.0 + }, + { + "timeStamp": "2021-04-21T08:00:00Z", + "average": 621492.0 + }, + { + "timeStamp": "2021-04-21T09:00:00Z", + "average": 621492.0 + }, + { + "timeStamp": "2021-04-21T10:00:00Z", + "average": 621492.0 + }, + { + "timeStamp": "2021-04-21T11:00:00Z", + "average": 621492.0 + } + ] + }, + { + "metadatavalues": [ + { + "name": { + "value": "blobtype", + "localizedValue": "blobtype" + }, + "value": "BlockBlob" + } + ], + "data": [ + { + "timeStamp": "2021-04-21T01:00:00Z", + "average": 4733.0 + }, + { + "timeStamp": "2021-04-21T02:00:00Z", + "average": 4733.0 + }, + { + "timeStamp": "2021-04-21T03:00:00Z", + "average": 4733.0 + }, + { + "timeStamp": "2021-04-21T04:00:00Z", + "average": 4733.0 + }, + { + "timeStamp": "2021-04-21T05:00:00Z", + "average": 4733.0 + }, + { + "timeStamp": "2021-04-21T06:00:00Z", + "average": 4733.0 + }, + { + "timeStamp": "2021-04-21T07:00:00Z", + "average": 4733.0 + }, + { + "timeStamp": "2021-04-21T08:00:00Z", + "average": 4733.0 + }, + { + "timeStamp": "2021-04-21T09:00:00Z", + "average": 4733.0 + }, + { + "timeStamp": "2021-04-21T10:00:00Z", + "average": 4733.0 + }, + { + "timeStamp": "2021-04-21T11:00:00Z", + "average": 4733.0 + } + ] + }, + { + "metadatavalues": [ + { + "name": { + "value": "blobtype", + "localizedValue": "blobtype" + }, + "value": "Azure Data Lake Storage" + } + ], + "data": [ + { + "timeStamp": "2021-04-21T01:00:00Z", + "average": 0.0 + }, + { + "timeStamp": "2021-04-21T02:00:00Z", + "average": 0.0 + }, + { + "timeStamp": "2021-04-21T03:00:00Z", + "average": 0.0 + }, + { + "timeStamp": "2021-04-21T04:00:00Z", + "average": 0.0 + }, + { + "timeStamp": "2021-04-21T05:00:00Z", + "average": 0.0 + }, + { + "timeStamp": "2021-04-21T06:00:00Z", + "average": 0.0 + }, + { + "timeStamp": "2021-04-21T07:00:00Z", + "average": 0.0 + }, + { + "timeStamp": "2021-04-21T08:00:00Z", + "average": 0.0 + }, + { + "timeStamp": "2021-04-21T09:00:00Z", + "average": 0.0 + }, + { + "timeStamp": "2021-04-21T10:00:00Z", + "average": 0.0 + }, + { + "timeStamp": "2021-04-21T11:00:00Z", + "average": 0.0 + } + ] + } + ], + "errorCode": "Success" + } + ] + } + }, + "default": { + "body": { + "code": "BadRequest", + "message": "Failed to find metric configuration for provider: Microsoft.Storage, resource Type: storageAccounts/blobServices, metric: BlobCsdapacity, Valid metrics: BlobCapacity,BlobCount,ContainerCount,IndexCapacity,Transactions,Ingress,Egress,SuccessServerLatency,SuccessE2ELatency,Availability" + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-09-01-preview/examples/GetMetricDefinitions.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-09-01-preview/examples/GetMetricDefinitions.json new file mode 100644 index 000000000000..0b0758e98c8d --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-09-01-preview/examples/GetMetricDefinitions.json @@ -0,0 +1,2805 @@ +{ + "parameters": { + "resourceUri": "subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "metricNamespace": "microsoft.compute/virtualmachines", + "api-version": "2017-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/Percentage CPU", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "Percentage CPU", + "localizedValue": "Percentage CPU" + }, + "displayDescription": "The percentage of allocated compute units that are currently in use by the Virtual Machine(s)", + "isDimensionRequired": false, + "unit": "Percent", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/Network In", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "Network In", + "localizedValue": "Network In Billable (Deprecated)" + }, + "displayDescription": "The number of billable bytes received on all network interfaces by the Virtual Machine(s) (Incoming Traffic) (Deprecated)", + "isDimensionRequired": false, + "unit": "Bytes", + "primaryAggregationType": "Total", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/Network Out", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "Network Out", + "localizedValue": "Network Out Billable (Deprecated)" + }, + "displayDescription": "The number of billable bytes out on all network interfaces by the Virtual Machine(s) (Outgoing Traffic) (Deprecated)", + "isDimensionRequired": false, + "unit": "Bytes", + "primaryAggregationType": "Total", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/Disk Read Bytes", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "Disk Read Bytes", + "localizedValue": "Disk Read Bytes" + }, + "displayDescription": "Bytes read from disk during monitoring period", + "isDimensionRequired": false, + "unit": "Bytes", + "primaryAggregationType": "Total", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/Disk Write Bytes", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "Disk Write Bytes", + "localizedValue": "Disk Write Bytes" + }, + "displayDescription": "Bytes written to disk during monitoring period", + "isDimensionRequired": false, + "unit": "Bytes", + "primaryAggregationType": "Total", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/Disk Read Operations/Sec", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "Disk Read Operations/Sec", + "localizedValue": "Disk Read Operations/Sec" + }, + "displayDescription": "Disk Read IOPS", + "isDimensionRequired": false, + "unit": "CountPerSecond", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/Disk Write Operations/Sec", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "Disk Write Operations/Sec", + "localizedValue": "Disk Write Operations/Sec" + }, + "displayDescription": "Disk Write IOPS", + "isDimensionRequired": false, + "unit": "CountPerSecond", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/CPU Credits Remaining", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "CPU Credits Remaining", + "localizedValue": "CPU Credits Remaining" + }, + "displayDescription": "Total number of credits available to burst. Only available on B-series burstable VMs", + "isDimensionRequired": false, + "unit": "Count", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/CPU Credits Consumed", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "CPU Credits Consumed", + "localizedValue": "CPU Credits Consumed" + }, + "displayDescription": "Total number of credits consumed by the Virtual Machine. Only available on B-series burstable VMs", + "isDimensionRequired": false, + "unit": "Count", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/Data Disk Read Bytes/sec", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "Data Disk Read Bytes/sec", + "localizedValue": "Data Disk Read Bytes/Sec" + }, + "displayDescription": "Bytes/Sec read from a single disk during monitoring period", + "isDimensionRequired": false, + "unit": "BytesPerSecond", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "LUN", + "localizedValue": "LUN" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/Data Disk Write Bytes/sec", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "Data Disk Write Bytes/sec", + "localizedValue": "Data Disk Write Bytes/Sec" + }, + "displayDescription": "Bytes/Sec written to a single disk during monitoring period", + "isDimensionRequired": false, + "unit": "BytesPerSecond", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "LUN", + "localizedValue": "LUN" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/Data Disk Read Operations/Sec", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "Data Disk Read Operations/Sec", + "localizedValue": "Data Disk Read Operations/Sec" + }, + "displayDescription": "Read IOPS from a single disk during monitoring period", + "isDimensionRequired": false, + "unit": "CountPerSecond", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "LUN", + "localizedValue": "LUN" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/Data Disk Write Operations/Sec", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "Data Disk Write Operations/Sec", + "localizedValue": "Data Disk Write Operations/Sec" + }, + "displayDescription": "Write IOPS from a single disk during monitoring period", + "isDimensionRequired": false, + "unit": "CountPerSecond", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "LUN", + "localizedValue": "LUN" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/Data Disk Queue Depth", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "Data Disk Queue Depth", + "localizedValue": "Data Disk Queue Depth" + }, + "displayDescription": "Data Disk Queue Depth(or Queue Length)", + "isDimensionRequired": false, + "unit": "Count", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "LUN", + "localizedValue": "LUN" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/Data Disk Bandwidth Consumed Percentage", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "Data Disk Bandwidth Consumed Percentage", + "localizedValue": "Data Disk Bandwidth Consumed Percentage" + }, + "displayDescription": "Percentage of data disk bandwidth consumed per minute", + "isDimensionRequired": false, + "unit": "Percent", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "LUN", + "localizedValue": "LUN" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/Data Disk IOPS Consumed Percentage", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "Data Disk IOPS Consumed Percentage", + "localizedValue": "Data Disk IOPS Consumed Percentage" + }, + "displayDescription": "Percentage of data disk I/Os consumed per minute", + "isDimensionRequired": false, + "unit": "Percent", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "LUN", + "localizedValue": "LUN" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/Data Disk Target Bandwidth", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "Data Disk Target Bandwidth", + "localizedValue": "Data Disk Target Bandwidth" + }, + "displayDescription": "Baseline bytes per second throughput Data Disk can achieve without bursting", + "isDimensionRequired": false, + "unit": "Count", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "LUN", + "localizedValue": "LUN" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/Data Disk Target IOPS", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "Data Disk Target IOPS", + "localizedValue": "Data Disk Target IOPS" + }, + "displayDescription": "Baseline IOPS Data Disk can achieve without bursting", + "isDimensionRequired": false, + "unit": "Count", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "LUN", + "localizedValue": "LUN" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/Data Disk Max Burst Bandwidth", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "Data Disk Max Burst Bandwidth", + "localizedValue": "Data Disk Max Burst Bandwidth" + }, + "displayDescription": "Maximum bytes per second throughput Data Disk can achieve with bursting", + "isDimensionRequired": false, + "unit": "Count", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "LUN", + "localizedValue": "LUN" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/Data Disk Max Burst IOPS", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "Data Disk Max Burst IOPS", + "localizedValue": "Data Disk Max Burst IOPS" + }, + "displayDescription": "Maximum IOPS Data Disk can achieve with bursting", + "isDimensionRequired": false, + "unit": "Count", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "LUN", + "localizedValue": "LUN" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/Data Disk Used Burst BPS Credits Percentage", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "Data Disk Used Burst BPS Credits Percentage", + "localizedValue": "Data Disk Used Burst BPS Credits Percentage" + }, + "displayDescription": "Percentage of Data Disk burst bandwidth credits used so far", + "isDimensionRequired": false, + "unit": "Percent", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "LUN", + "localizedValue": "LUN" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/Data Disk Used Burst IO Credits Percentage", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "Data Disk Used Burst IO Credits Percentage", + "localizedValue": "Data Disk Used Burst IO Credits Percentage" + }, + "displayDescription": "Percentage of Data Disk burst I/O credits used so far", + "isDimensionRequired": false, + "unit": "Percent", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "LUN", + "localizedValue": "LUN" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/OS Disk Read Bytes/sec", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "OS Disk Read Bytes/sec", + "localizedValue": "OS Disk Read Bytes/Sec" + }, + "displayDescription": "Bytes/Sec read from a single disk during monitoring period for OS disk", + "isDimensionRequired": false, + "unit": "BytesPerSecond", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/OS Disk Write Bytes/sec", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "OS Disk Write Bytes/sec", + "localizedValue": "OS Disk Write Bytes/Sec" + }, + "displayDescription": "Bytes/Sec written to a single disk during monitoring period for OS disk", + "isDimensionRequired": false, + "unit": "BytesPerSecond", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/OS Disk Read Operations/Sec", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "OS Disk Read Operations/Sec", + "localizedValue": "OS Disk Read Operations/Sec" + }, + "displayDescription": "Read IOPS from a single disk during monitoring period for OS disk", + "isDimensionRequired": false, + "unit": "CountPerSecond", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/OS Disk Write Operations/Sec", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "OS Disk Write Operations/Sec", + "localizedValue": "OS Disk Write Operations/Sec" + }, + "displayDescription": "Write IOPS from a single disk during monitoring period for OS disk", + "isDimensionRequired": false, + "unit": "CountPerSecond", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/OS Disk Queue Depth", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "OS Disk Queue Depth", + "localizedValue": "OS Disk Queue Depth" + }, + "displayDescription": "OS Disk Queue Depth(or Queue Length)", + "isDimensionRequired": false, + "unit": "Count", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/OS Disk Bandwidth Consumed Percentage", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "OS Disk Bandwidth Consumed Percentage", + "localizedValue": "OS Disk Bandwidth Consumed Percentage" + }, + "displayDescription": "Percentage of operating system disk bandwidth consumed per minute", + "isDimensionRequired": false, + "unit": "Percent", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "LUN", + "localizedValue": "LUN" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/OS Disk IOPS Consumed Percentage", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "OS Disk IOPS Consumed Percentage", + "localizedValue": "OS Disk IOPS Consumed Percentage" + }, + "displayDescription": "Percentage of operating system disk I/Os consumed per minute", + "isDimensionRequired": false, + "unit": "Percent", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "LUN", + "localizedValue": "LUN" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/OS Disk Target Bandwidth", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "OS Disk Target Bandwidth", + "localizedValue": "OS Disk Target Bandwidth" + }, + "displayDescription": "Baseline bytes per second throughput OS Disk can achieve without bursting", + "isDimensionRequired": false, + "unit": "Count", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "LUN", + "localizedValue": "LUN" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/OS Disk Target IOPS", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "OS Disk Target IOPS", + "localizedValue": "OS Disk Target IOPS" + }, + "displayDescription": "Baseline IOPS OS Disk can achieve without bursting", + "isDimensionRequired": false, + "unit": "Count", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "LUN", + "localizedValue": "LUN" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/OS Disk Max Burst Bandwidth", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "OS Disk Max Burst Bandwidth", + "localizedValue": "OS Disk Max Burst Bandwidth" + }, + "displayDescription": "Maximum bytes per second throughput OS Disk can achieve with bursting", + "isDimensionRequired": false, + "unit": "Count", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "LUN", + "localizedValue": "LUN" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/OS Disk Max Burst IOPS", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "OS Disk Max Burst IOPS", + "localizedValue": "OS Disk Max Burst IOPS" + }, + "displayDescription": "Maximum IOPS OS Disk can achieve with bursting", + "isDimensionRequired": false, + "unit": "Count", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "LUN", + "localizedValue": "LUN" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/OS Disk Used Burst BPS Credits Percentage", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "OS Disk Used Burst BPS Credits Percentage", + "localizedValue": "OS Disk Used Burst BPS Credits Percentage" + }, + "displayDescription": "Percentage of OS Disk burst bandwidth credits used so far", + "isDimensionRequired": false, + "unit": "Percent", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "LUN", + "localizedValue": "LUN" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/OS Disk Used Burst IO Credits Percentage", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "OS Disk Used Burst IO Credits Percentage", + "localizedValue": "OS Disk Used Burst IO Credits Percentage" + }, + "displayDescription": "Percentage of OS Disk burst I/O credits used so far", + "isDimensionRequired": false, + "unit": "Percent", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "LUN", + "localizedValue": "LUN" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/Inbound Flows", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "Inbound Flows", + "localizedValue": "Inbound Flows" + }, + "displayDescription": "Inbound Flows are number of current flows in the inbound direction (traffic going into the VM)", + "isDimensionRequired": false, + "unit": "Count", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/Outbound Flows", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "Outbound Flows", + "localizedValue": "Outbound Flows" + }, + "displayDescription": "Outbound Flows are number of current flows in the outbound direction (traffic going out of the VM)", + "isDimensionRequired": false, + "unit": "Count", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/Inbound Flows Maximum Creation Rate", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "Inbound Flows Maximum Creation Rate", + "localizedValue": "Inbound Flows Maximum Creation Rate" + }, + "displayDescription": "The maximum creation rate of inbound flows (traffic going into the VM)", + "isDimensionRequired": false, + "unit": "CountPerSecond", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/Outbound Flows Maximum Creation Rate", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "Outbound Flows Maximum Creation Rate", + "localizedValue": "Outbound Flows Maximum Creation Rate" + }, + "displayDescription": "The maximum creation rate of outbound flows (traffic going out of the VM)", + "isDimensionRequired": false, + "unit": "CountPerSecond", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/Premium Data Disk Cache Read Hit", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "Premium Data Disk Cache Read Hit", + "localizedValue": "Premium Data Disk Cache Read Hit" + }, + "displayDescription": "Premium Data Disk Cache Read Hit", + "isDimensionRequired": false, + "unit": "Percent", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "LUN", + "localizedValue": "LUN" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/Premium Data Disk Cache Read Miss", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "Premium Data Disk Cache Read Miss", + "localizedValue": "Premium Data Disk Cache Read Miss" + }, + "displayDescription": "Premium Data Disk Cache Read Miss", + "isDimensionRequired": false, + "unit": "Percent", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "LUN", + "localizedValue": "LUN" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/Premium OS Disk Cache Read Hit", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "Premium OS Disk Cache Read Hit", + "localizedValue": "Premium OS Disk Cache Read Hit" + }, + "displayDescription": "Premium OS Disk Cache Read Hit", + "isDimensionRequired": false, + "unit": "Percent", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/Premium OS Disk Cache Read Miss", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "Premium OS Disk Cache Read Miss", + "localizedValue": "Premium OS Disk Cache Read Miss" + }, + "displayDescription": "Premium OS Disk Cache Read Miss", + "isDimensionRequired": false, + "unit": "Percent", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/VM Cached Bandwidth Consumed Percentage", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "VM Cached Bandwidth Consumed Percentage", + "localizedValue": "VM Cached Bandwidth Consumed Percentage" + }, + "displayDescription": "Percentage of cached disk bandwidth consumed by the VM", + "isDimensionRequired": false, + "unit": "Percent", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/VM Cached IOPS Consumed Percentage", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "VM Cached IOPS Consumed Percentage", + "localizedValue": "VM Cached IOPS Consumed Percentage" + }, + "displayDescription": "Percentage of cached disk IOPS consumed by the VM", + "isDimensionRequired": false, + "unit": "Percent", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/VM Uncached Bandwidth Consumed Percentage", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "VM Uncached Bandwidth Consumed Percentage", + "localizedValue": "VM Uncached Bandwidth Consumed Percentage" + }, + "displayDescription": "Percentage of uncached disk bandwidth consumed by the VM", + "isDimensionRequired": false, + "unit": "Percent", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/VM Uncached IOPS Consumed Percentage", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "VM Uncached IOPS Consumed Percentage", + "localizedValue": "VM Uncached IOPS Consumed Percentage" + }, + "displayDescription": "Percentage of uncached disk IOPS consumed by the VM", + "isDimensionRequired": false, + "unit": "Percent", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/Network In Total", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "Network In Total", + "localizedValue": "Network In Total" + }, + "displayDescription": "The number of bytes received on all network interfaces by the Virtual Machine(s) (Incoming Traffic)", + "isDimensionRequired": false, + "unit": "Bytes", + "primaryAggregationType": "Total", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2/providers/microsoft.insights/metricdefinitions/Network Out Total", + "resourceId": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Compute/virtualMachines/tkTestVM2", + "name": { + "value": "Network Out Total", + "localizedValue": "Network Out Total" + }, + "displayDescription": "The number of bytes out on all network interfaces by the Virtual Machine(s) (Outgoing Traffic)", + "isDimensionRequired": false, + "unit": "Bytes", + "primaryAggregationType": "Total", + "supportedAggregationTypes": [ + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + } + ] + } + }, + "default": { + "body": { + "code": "BadRequest", + "message": "Failed to find metric configuration for provider: Microsoft.Storage, resource Type: storageAccounts/blobServices, metric: BlobCsdapacity, Valid metrics: BlobCapacity,BlobCount,ContainerCount,IndexCapacity,Transactions,Ingress,Egress,SuccessServerLatency,SuccessE2ELatency,Availability" + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-09-01-preview/examples/GetMetricMetadata.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-09-01-preview/examples/GetMetricMetadata.json new file mode 100644 index 000000000000..614e48dd1c24 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-09-01-preview/examples/GetMetricMetadata.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "timespan": "2021-04-21T02:08:45.416Z/2021-04-24T02:08:45.416Z", + "metric": "BlobCapacity", + "metricNamespace": "microsoft.storage/storageaccounts/blobservices", + "$filter": "Tier eq '*'", + "resulttype": "metadata", + "resourceUri": "subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default", + "api-version": "2017-05-01-preview" + }, + "responses": { + "200": { + "body": { + "timespan": "2021-04-21T02:08:45Z/2021-04-24T02:08:45Z", + "interval": "PT1H", + "value": [ + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default/providers/Microsoft.Insights/metrics/BlobCapacity", + "type": "Microsoft.Insights/metrics", + "name": { + "value": "BlobCapacity", + "localizedValue": "Blob Capacity" + }, + "displayDescription": "The amount of storage used by the storage account’s Blob service in bytes.", + "unit": "Bytes", + "timeseries": [ + { + "metadatavalues": [ + { + "name": { + "value": "tier", + "localizedValue": "tier" + }, + "value": "Cool" + } + ] + }, + { + "metadatavalues": [ + { + "name": { + "value": "tier", + "localizedValue": "tier" + }, + "value": "Archive" + } + ] + }, + { + "metadatavalues": [ + { + "name": { + "value": "tier", + "localizedValue": "tier" + }, + "value": "Standard" + } + ] + }, + { + "metadatavalues": [ + { + "name": { + "value": "tier", + "localizedValue": "tier" + }, + "value": "Untiered" + } + ] + }, + { + "metadatavalues": [ + { + "name": { + "value": "tier", + "localizedValue": "tier" + }, + "value": "Hot" + } + ] + } + ] + } + ] + } + }, + "default": { + "body": { + "code": "BadRequest", + "message": "Failed to find metric configuration for provider: Microsoft.Storage, resource Type: storageAccounts/blobServices, metric: BlobCsdapacity, Valid metrics: BlobCapacity,BlobCount,ContainerCount,IndexCapacity,Transactions,Ingress,Egress,SuccessServerLatency,SuccessE2ELatency,Availability" + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-09-01-preview/examples/OperationList.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-09-01-preview/examples/OperationList.json new file mode 100644 index 000000000000..58639dc70904 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-09-01-preview/examples/OperationList.json @@ -0,0 +1,6886 @@ +{ + "parameters": { + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Insights/Operations/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Operations", + "operation": "Read operations", + "description": "Read operations" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Metrics/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Action", + "operation": "Metric Action", + "description": "Metric Action" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MetricDefinitions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Definitions", + "operation": "Read metric definitions", + "description": "Read metric definitions" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MetricDefinitions/Microsoft.Insights/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Definitions", + "operation": "Read metric definitions", + "description": "Read metric definitions" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MetricDefinitions/providers/Microsoft.Insights/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Definitions", + "operation": "Read metric definitions", + "description": "Read metric definitions" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Metrics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metrics", + "operation": "Read metrics", + "description": "Read metrics" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Metricnamespaces/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric namespaces", + "operation": "Metric namespaces read", + "description": "Read metric namespaces" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Metrics/Write", + "isDataAction": true, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metrics", + "operation": "Write metrics", + "description": "Write metrics" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Metrics/providers/Metrics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metrics", + "operation": "Read metrics", + "description": "Read metrics" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Metrics/Microsoft.Insights/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metrics", + "operation": "Read metrics", + "description": "Read metrics" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AlertRules/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Classic Metric Alerts", + "operation": "Create or update classic metric alert", + "description": "Create or update a classic metric alert" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AlertRules/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Classic Metric Alerts", + "operation": "Delete classic metric alert", + "description": "Delete a classic metric alert" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AlertRules/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Classic Metric Alerts", + "operation": "Read classic metric alert", + "description": "Read a classic metric alert" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MetricAlerts/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Alerts", + "operation": "Create or update metric alert", + "description": "Create or update a metric alert" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MetricAlerts/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Alerts", + "operation": "Delete metric alert", + "description": "Delete a metric alert" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MetricAlerts/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Alerts", + "operation": "Read metric alert", + "description": "Read a metric alert" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MetricAlerts/Status/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Alerts", + "operation": "Read metric alert status", + "description": "Read metric alert status" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Autoscale Setting", + "operation": "Create or update autoscale setting", + "description": "Create or update an autoscale setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Autoscale Setting", + "operation": "Delete autoscale setting", + "description": "Delete an autoscale setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Autoscale Setting", + "operation": "Read autoscale setting", + "description": "Read an autoscale setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AlertRules/Incidents/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Alert Rule Incident resource", + "operation": "Read classic metric alert incidents", + "description": "Read a classic metric alert incident" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/providers/Microsoft.Insights/MetricDefinitions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Definitions", + "operation": "Read metric definitions", + "description": "Read metric definitions" + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "ObservedMetricValue", + "displayName": "Observed Metric Value", + "internalMetricName": null, + "displayDescription": "The value computed by autoscale when executed", + "unit": "Count", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": null, + "dimensions": [ + { + "name": "MetricTriggerSource", + "displayName": "Metric Trigger Source", + "toBeExportedForShoebox": true, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": null, + "lockAggregationType": null + }, + { + "name": "MetricThreshold", + "displayName": "Metric Threshold", + "internalMetricName": null, + "displayDescription": "The configured autoscale threshold when autoscale ran.", + "unit": "Count", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": null, + "dimensions": [ + { + "name": "MetricTriggerRule", + "displayName": "Metric Trigger Rule", + "toBeExportedForShoebox": true, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": null, + "lockAggregationType": null + }, + { + "name": "ObservedCapacity", + "displayName": "Observed Capacity", + "internalMetricName": null, + "displayDescription": "The capacity reported to autoscale when it executed.", + "unit": "Count", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": null, + "dimensions": null, + "supportedAggregationTypes": null, + "lockAggregationType": null + }, + { + "name": "ScaleActionsInitiated", + "displayName": "Scale Actions Initiated", + "internalMetricName": null, + "displayDescription": "The direction of the scale operation.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": null, + "fillGapWithZero": true, + "category": null, + "dimensions": [ + { + "name": "ScaleDirection", + "displayName": "Scale Direction", + "toBeExportedForShoebox": true, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": null, + "lockAggregationType": null + } + ], + "logSpecifications": null, + "legacyMetricSpecifications": null + } + } + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/providers/Microsoft.Insights/logDefinitions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Log Definitions", + "operation": "Log Definitions read", + "description": "Read log definitions" + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": null, + "logSpecifications": [ + { + "name": "AutoscaleEvaluations", + "displayName": "Autoscale Evaluations", + "blobDuration": "PT1H" + }, + { + "name": "AutoscaleScaleActions", + "displayName": "Autoscale Scale Actions", + "blobDuration": "PT1H" + } + ], + "legacyMetricSpecifications": null + } + } + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/providers/Microsoft.Insights/diagnosticSettings/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Resource diagnostic settings", + "operation": "Read resource diagnostic setting", + "description": "Read a resource diagnostic setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/providers/Microsoft.Insights/diagnosticSettings/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Resource diagnostic settings", + "operation": "Create or update resource diagnostic setting", + "description": "Create or update a resource diagnostic setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ActionGroups/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Action Groups", + "operation": "Create or update action group", + "description": "Create or update an action group" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ActionGroups/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Action Groups", + "operation": "Delete action group", + "description": "Delete an action group" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ActionGroups/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Action Groups", + "operation": "Read action group", + "description": "Read an action group" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ActivityLogAlerts/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Activity Log Alert", + "operation": "Create or update activity log alert", + "description": "Create or update an activity log alert" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ActivityLogAlerts/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Activity Log Alert", + "operation": "Delete activity log alert", + "description": "Delete an activity log alert" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ActivityLogAlerts/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Activity Log Alert", + "operation": "Read activity log alert", + "description": "Read an activity log alert" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ActivityLogAlerts/Activated/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Activity Log Alert", + "operation": "Activity Log Alert activated", + "description": "Activity Log Alert activated" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/EventCategories/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Activity Log event category", + "operation": "Read Activity Log event categories", + "description": "Read available Activity Log event categories" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/eventtypes/values/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Activity Log Events", + "operation": "Read Activity Log", + "description": "Read Activity Log events" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/eventtypes/digestevents/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Digest events", + "operation": "Event types management digest read", + "description": "Read management event type digest" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DiagnosticSettings/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Resource diagnostic settings", + "operation": "Create or update resource diagnostic setting", + "description": "Create or update a resource diagnostic setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DiagnosticSettingsCategories/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Diagnostic settings categories resource", + "operation": "Read diagnostic settings categories", + "description": "Read diagnostic settings categories" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DiagnosticSettings/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Resource diagnostic settings", + "operation": "Delete resource diagnostic setting", + "description": "Delete a resource diagnostic setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DiagnosticSettings/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Resource diagnostic settings", + "operation": "Read resource diagnostic setting", + "description": "Read a resource diagnostic setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ExtendedDiagnosticSettings/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Network flow log diagnostic setting", + "operation": "Create or update network flow log diagnostic setting", + "description": "Create or update a network flow log diagnostic setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ExtendedDiagnosticSettings/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Network flow log diagnostic setting", + "operation": "Delete network flow log diagnostic setting", + "description": "Delete a network flow log diagnostic setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ExtendedDiagnosticSettings/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Network flow log diagnostic setting", + "operation": "Read network flow log diagnostic setting", + "description": "Read a network flow log diagnostic setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/LogProfiles/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Log Profiles", + "operation": "Create or update Activity Log log profile", + "description": "Create or update an Activity Log log profile" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/LogProfiles/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Log Profiles", + "operation": "Delete Activity Log log profile", + "description": "Delete an Activity Log log profile" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/LogProfiles/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Log Profiles", + "operation": "Read Activity Log log profile", + "description": "Read an Activity Log log profile" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/LogDefinitions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Log Definitions", + "operation": "Log Definitions read", + "description": "Read log definitions" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/Scaleup/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Autoscale Setting", + "operation": "Autoscale scale up initiated", + "description": "Autoscale scale up initiated" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/Scaledown/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Autoscale Setting", + "operation": "Autoscale scale down initiated", + "description": "Autoscale scale down initiated" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/ScaleupResult/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Autoscale Setting", + "operation": "Autoscale scale up completed", + "description": "Autoscale scale up completed" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/ScaledownResult/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Autoscale Setting", + "operation": "Autoscale scale down completed", + "description": "Autoscale scale down completed" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AlertRules/Activated/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Classic Metric Alerts", + "operation": "Classic metric alert activated", + "description": "Classic metric alert activated" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AlertRules/Resolved/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Classic Metric Alerts", + "operation": "Classic metric alert resolved", + "description": "Classic metric alert resolved" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AlertRules/Throttled/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Classic Metric Alerts", + "operation": "Classic metric alert rule throttled", + "description": "Classic metric alert rule throttled" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Register/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Microsoft.Insights", + "operation": "Register Microsoft.Insights", + "description": "Register the Microsoft Insights provider" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Unregister/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Microsoft.Insights", + "operation": "Register Microsoft.Insights", + "description": "Register the Microsoft Insights provider" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Tenants/Register/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Microsoft.Insights", + "operation": "Initialize Microsoft.Insights", + "description": "Initializes the Microsoft Insights provider" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/AnalyticsItems/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights analytics item", + "operation": "Application Insights analytics item delete", + "description": "Deleting an Application Insights analytics item" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/AnalyticsItems/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights analytics item", + "operation": "Application Insights analytics item read", + "description": "Reading an Application Insights analytics item" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/AnalyticsItems/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights analytics item", + "operation": "Application Insights analytics item write", + "description": "Writing an Application Insights analytics item" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/MyAnalyticsItems/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights analytics item", + "operation": "Application Insights personal analytics item delete", + "description": "Deleting an Application Insights personal analytics item" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/MyAnalyticsItems/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights analytics item", + "operation": "Application Insights personal analytics item write", + "description": "Writing an Application Insights personal analytics item" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/MyAnalyticsItems/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights analytics item", + "operation": "Application Insights personal analytics item read", + "description": "Reading an Application Insights personal analytics item" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/AnalyticsTables/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights analytics table", + "operation": "Application Insights analytics table action", + "description": "Application Insights analytics table action" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/AnalyticsTables/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights analytics table", + "operation": "Application Insights analytics table delete", + "description": "Deleting an Application Insights analytics table schema" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/AnalyticsTables/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights analytics table", + "operation": "Application Insights analytics table read", + "description": "Reading an Application Insights analytics table schema" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/AnalyticsTables/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights analytics table", + "operation": "Application Insights analytics table write", + "description": "Writing an Application Insights analytics table schema" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Annotations/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights annotations", + "operation": "Application Insights annotations delete", + "description": "Deleting an Application Insights annotation" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Annotations/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights annotations", + "operation": "Application Insights annotations read", + "description": "Reading an Application Insights annotation" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Annotations/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights annotations", + "operation": "Application Insights annotation write", + "description": "Writing an Application Insights annotation" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/ApiKeys/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights API key", + "operation": "Application Insights API key delete", + "description": "Deleting an Application Insights API key" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/ApiKeys/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights API key", + "operation": "Application Insights API key read", + "description": "Reading an Application Insights API key" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/ApiKeys/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights API key", + "operation": "Application Insights API key generate", + "description": "Generating an Application Insights API key" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Purge/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights Purge", + "operation": "Application Insights Purge Data action", + "description": "Purging data from Application Insights" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Operations/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights Operations", + "operation": "Application Insights Operations read", + "description": "Get status of long-running operations in Application Insights" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Events/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights Events", + "operation": "Application Insights Events read", + "description": "Get logs from Application Insights using OData query format" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Query/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights Query", + "operation": "Application Insights Query read", + "description": "Run queries against Application Insights logs" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/BillingPlanForComponent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Billing plan for Application Insights component", + "operation": "Billing plan for Application Insights component read", + "description": "Reading a billing plan for Application Insights component" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/CurrentBillingFeatures/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Current billing features for Application Insights component", + "operation": "Current billing features for Application Insights component read", + "description": "Reading current billing features for Application Insights component" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/CurrentBillingFeatures/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Current billing features for Application Insights component", + "operation": "Current billing features for Application Insights component write", + "description": "Writing current billing features for Application Insights component" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/FeatureCapabilities/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component feature capabilities", + "operation": "Application Insights component feature capabilities read", + "description": "Reading Application Insights component feature capabilities" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/GetAvailableBillingFeatures/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component available billing features", + "operation": "Application Insights component available billing features read", + "description": "Reading Application Insights component available billing features" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/PricingPlans/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component pricing plan", + "operation": "Application Insights component pricing plan read", + "description": "Reading an Application Insights component pricing plan" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/PricingPlans/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component pricing plan", + "operation": "Application Insights component pricing plan write", + "description": "Writing an Application Insights component pricing plan" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/QuotaStatus/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component quota status", + "operation": "Application Insights component quota status read", + "description": "Reading Application Insights component quota status" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/DailyCapReached/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component daily cap reached", + "operation": "Application Insights component daily cap reached", + "description": "Reached the daily cap for Application Insights component" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/DailyCapWarningThresholdReached/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component daily cap warning threshold reached", + "operation": "Application Insights component daily cap warning threshold reached", + "description": "Reached the daily cap warning threshold for Application Insights component" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application insights components", + "operation": "Application insights component write", + "description": "Writing to an application insights component configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application insights components", + "operation": "Application insights component delete", + "description": "Deleting an application insights component configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application insights components", + "operation": "Application insights component read", + "description": "Reading an application insights component configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Api/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component data API", + "operation": "Application Insights component data API read", + "description": "Reading Application Insights component data API" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/ExtendQueries/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component extended query results", + "operation": "Application Insights component extended query results read", + "description": "Reading Application Insights component extended query results" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/GetToken/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component token", + "operation": "Application Insights component token read", + "description": "Reading an Application Insights component token" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/MetricDefinitions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component metric definitions", + "operation": "Application Insights component metric definitions read", + "description": "Reading Application Insights component metric definitions" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Metrics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component metrics", + "operation": "Application Insights component metrics read", + "description": "Reading Application Insights component metrics" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/providers/Microsoft.Insights/logDefinitions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Log Definitions", + "operation": "Log Definitions read", + "description": "Read log definitions" + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": null, + "logSpecifications": [ + { + "name": "AppAvailabilityResults", + "displayName": "Availability results", + "blobDuration": "PT1H" + }, + { + "name": "AppBrowserTimings", + "displayName": "Browser timings", + "blobDuration": "PT1H" + }, + { + "name": "AppEvents", + "displayName": "Events", + "blobDuration": "PT1H" + }, + { + "name": "AppMetrics", + "displayName": "Metrics", + "blobDuration": "PT1H" + }, + { + "name": "AppDependencies", + "displayName": "Dependencies", + "blobDuration": "PT1H" + }, + { + "name": "AppExceptions", + "displayName": "Exceptions", + "blobDuration": "PT1H" + }, + { + "name": "AppPageViews", + "displayName": "Page views", + "blobDuration": "PT1H" + }, + { + "name": "AppPerformanceCounters", + "displayName": "Performance counters", + "blobDuration": "PT1H" + }, + { + "name": "AppRequests", + "displayName": "Requests", + "blobDuration": "PT1H" + }, + { + "name": "AppSystemEvents", + "displayName": "System events", + "blobDuration": "PT1H" + }, + { + "name": "AppTraces", + "displayName": "Traces", + "blobDuration": "PT1H" + } + ], + "legacyMetricSpecifications": null + } + } + }, + { + "name": "Microsoft.Insights/Components/providers/Microsoft.Insights/diagnosticSettings/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Resource diagnostic settings", + "operation": "Read resource diagnostic setting", + "description": "Read a resource diagnostic setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/providers/Microsoft.Insights/diagnosticSettings/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Resource diagnostic settings", + "operation": "Create or update resource diagnostic setting", + "description": "Create or update a resource diagnostic setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/ExportConfiguration/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights export settings", + "operation": "Application Insights export settings action", + "description": "Application Insights export settings action" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/ExportConfiguration/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights export settings", + "operation": "Application Insights export settings delete", + "description": "Deleting Application Insights export settings" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/ExportConfiguration/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights export settings", + "operation": "Application Insights export settings read", + "description": "Reading Application Insights export settings" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/ExportConfiguration/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights export settings", + "operation": "Application Insights export settings write", + "description": "Writing Application Insights export settings" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Favorites/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights favorites", + "operation": "Application Insights favorites delete", + "description": "Deleting an Application Insights favorite" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Favorites/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights favorites", + "operation": "Application Insights favorites read", + "description": "Reading an Application Insights favorite" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Favorites/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights favorites", + "operation": "Application Insights favorite write", + "description": "Writing an Application Insights favorite" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/MyFavorites/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights favorites", + "operation": "Application Insights personal favorites read", + "description": "Reading an Application Insights personal favorite" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/generateLiveToken/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights Live Metrics token", + "operation": "Get Live Metrics token", + "description": "Live Metrics get token" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/providers/Microsoft.Insights/MetricDefinitions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Definitions", + "operation": "Read metric definitions", + "description": "Read metric definitions" + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "availabilityResults/availabilityPercentage", + "displayName": "Availability", + "internalMetricName": null, + "displayDescription": "Percentage of successfully completed availability tests", + "unit": "Percent", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Availability", + "dimensions": [ + { + "name": "availabilityResult/name", + "displayName": "Test name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "availabilityResult/location", + "displayName": "Run location", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average" + ], + "lockAggregationType": null + }, + { + "name": "availabilityResults/count", + "displayName": "Availability tests", + "internalMetricName": "availabilityResults/duration", + "displayDescription": "Count of availability tests", + "unit": "Count", + "aggregationType": "Count", + "availabilities": null, + "fillGapWithZero": true, + "category": "Availability", + "dimensions": [ + { + "name": "availabilityResult/name", + "displayName": "Test name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "availabilityResult/location", + "displayName": "Run location", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "availabilityResult/success", + "displayName": "Test result", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Count" + ], + "lockAggregationType": null + }, + { + "name": "availabilityResults/duration", + "displayName": "Availability test duration", + "internalMetricName": null, + "displayDescription": "Availability test duration", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Availability", + "dimensions": [ + { + "name": "availabilityResult/name", + "displayName": "Test name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "availabilityResult/location", + "displayName": "Run location", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "availabilityResult/success", + "displayName": "Test result", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "browserTimings/networkDuration", + "displayName": "Page load network connect time", + "internalMetricName": null, + "displayDescription": "Time between user request and network connection. Includes DNS lookup and transport connection.", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Browser", + "dimensions": null, + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "browserTimings/processingDuration", + "displayName": "Client processing time", + "internalMetricName": null, + "displayDescription": "Time between receiving the last byte of a document until the DOM is loaded. Async requests may still be processing.", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Browser", + "dimensions": null, + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "browserTimings/receiveDuration", + "displayName": "Receiving response time", + "internalMetricName": null, + "displayDescription": "Time between the first and last bytes, or until disconnection.", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Browser", + "dimensions": null, + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "browserTimings/sendDuration", + "displayName": "Send request time", + "internalMetricName": null, + "displayDescription": "Time between network connection and receiving the first byte.", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Browser", + "dimensions": null, + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "browserTimings/totalDuration", + "displayName": "Browser page load time", + "internalMetricName": null, + "displayDescription": "Time from user request until DOM, stylesheets, scripts and images are loaded.", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Browser", + "dimensions": null, + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "dependencies/count", + "displayName": "Dependency calls", + "internalMetricName": "dependencies/duration", + "displayDescription": "Count of calls made by the application to external resources.", + "unit": "Count", + "aggregationType": "Count", + "availabilities": null, + "fillGapWithZero": true, + "category": "Server", + "dimensions": [ + { + "name": "dependency/type", + "displayName": "Dependency type", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/performanceBucket", + "displayName": "Dependency performance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/success", + "displayName": "Successful call", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/target", + "displayName": "Target of a dependency call", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/resultCode", + "displayName": "Result code", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "operation/synthetic", + "displayName": "Is traffic synthetic", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Count" + ], + "lockAggregationType": null + }, + { + "name": "dependencies/duration", + "displayName": "Dependency duration", + "internalMetricName": null, + "displayDescription": "Duration of calls made by the application to external resources.", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Server", + "dimensions": [ + { + "name": "dependency/type", + "displayName": "Dependency type", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/performanceBucket", + "displayName": "Dependency performance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/success", + "displayName": "Successful call", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/target", + "displayName": "Target of a dependency call", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/resultCode", + "displayName": "Result code", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "operation/synthetic", + "displayName": "Is traffic synthetic", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "dependencies/failed", + "displayName": "Dependency call failures", + "internalMetricName": "dependencies/duration", + "displayDescription": "Count of failed dependency calls made by the application to external resources.", + "unit": "Count", + "aggregationType": "Count", + "availabilities": null, + "fillGapWithZero": true, + "category": "Failures", + "dimensions": [ + { + "name": "dependency/type", + "displayName": "Dependency type", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/performanceBucket", + "displayName": "Dependency performance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/success", + "displayName": "Successful call", + "toBeExportedForShoebox": false, + "isHidden": true, + "defaultDimensionValues": [ + { + "value": "False" + } + ] + }, + { + "name": "dependency/target", + "displayName": "Target of a dependency call", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/resultCode", + "displayName": "Result code", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "operation/synthetic", + "displayName": "Is traffic synthetic", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Count" + ], + "lockAggregationType": null + }, + { + "name": "pageViews/count", + "displayName": "Page views", + "internalMetricName": null, + "displayDescription": "Count of page views.", + "unit": "Count", + "aggregationType": "Count", + "availabilities": null, + "fillGapWithZero": true, + "category": "Usage", + "dimensions": [ + { + "name": "operation/synthetic", + "displayName": "Is traffic synthetic", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Count" + ], + "lockAggregationType": null + }, + { + "name": "pageViews/duration", + "displayName": "Page view load time", + "internalMetricName": null, + "displayDescription": "Page view load time", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Usage", + "dimensions": [ + { + "name": "operation/synthetic", + "displayName": "Is traffic synthetic", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "performanceCounters/requestExecutionTime", + "displayName": "HTTP request execution time", + "internalMetricName": null, + "displayDescription": "Execution time of the most recent request.", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Performance counters", + "dimensions": [ + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "performanceCounters/requestsInQueue", + "displayName": "HTTP requests in application queue", + "internalMetricName": null, + "displayDescription": "Length of the application request queue.", + "unit": "Count", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": true, + "category": "Performance counters", + "dimensions": [ + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "performanceCounters/requestsPerSecond", + "displayName": "HTTP request rate", + "internalMetricName": null, + "displayDescription": "Rate of all requests to the application per second from ASP.NET.", + "unit": "CountPerSecond", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": true, + "category": "Performance counters", + "dimensions": [ + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "performanceCounters/exceptionsPerSecond", + "displayName": "Exception rate", + "internalMetricName": null, + "displayDescription": "Count of handled and unhandled exceptions reported to windows, including .NET exceptions and unmanaged exceptions that are converted into .NET exceptions.", + "unit": "CountPerSecond", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": true, + "category": "Performance counters", + "dimensions": [ + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "performanceCounters/processIOBytesPerSecond", + "displayName": "Process IO rate", + "internalMetricName": null, + "displayDescription": "Total bytes per second read and written to files, network and devices.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Performance counters", + "dimensions": [ + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "performanceCounters/processCpuPercentage", + "displayName": "Process CPU", + "internalMetricName": null, + "displayDescription": "The percentage of elapsed time that all process threads used the processor to execute instructions. This can vary between 0 to 100. This metric indicates the performance of w3wp process alone.", + "unit": "Percent", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Performance counters", + "dimensions": [ + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "performanceCounters/processorCpuPercentage", + "displayName": "Processor time", + "internalMetricName": null, + "displayDescription": "The percentage of time that the processor spends in non-idle threads.", + "unit": "Percent", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Performance counters", + "dimensions": [ + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "performanceCounters/memoryAvailableBytes", + "displayName": "Available memory", + "internalMetricName": null, + "displayDescription": "Physical memory immediately available for allocation to a process or for system use.", + "unit": "Bytes", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Performance counters", + "dimensions": [ + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "performanceCounters/processPrivateBytes", + "displayName": "Process private bytes", + "internalMetricName": null, + "displayDescription": "Memory exclusively assigned to the monitored application's processes.", + "unit": "Bytes", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Performance counters", + "dimensions": [ + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "requests/duration", + "displayName": "Server response time", + "internalMetricName": null, + "displayDescription": "Time between receiving an HTTP request and finishing sending the response.", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Server", + "dimensions": [ + { + "name": "request/performanceBucket", + "displayName": "Request performance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "request/resultCode", + "displayName": "Result code", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "operation/synthetic", + "displayName": "Is traffic synthetic", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "request/success", + "displayName": "Successful request", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "requests/count", + "displayName": "Server requests", + "internalMetricName": "requests/duration", + "displayDescription": "Count of HTTP requests completed.", + "unit": "Count", + "aggregationType": "Count", + "availabilities": null, + "fillGapWithZero": true, + "category": "Server", + "dimensions": [ + { + "name": "request/performanceBucket", + "displayName": "Request performance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "request/resultCode", + "displayName": "Result code", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "operation/synthetic", + "displayName": "Is traffic synthetic", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "request/success", + "displayName": "Successful request", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Count" + ], + "lockAggregationType": null + }, + { + "name": "requests/failed", + "displayName": "Failed requests", + "internalMetricName": "requests/duration", + "displayDescription": "Count of HTTP requests marked as failed. In most cases these are requests with a response code >= 400 and not equal to 401.", + "unit": "Count", + "aggregationType": "Count", + "availabilities": null, + "fillGapWithZero": true, + "category": "Failures", + "dimensions": [ + { + "name": "request/performanceBucket", + "displayName": "Request performance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "request/resultCode", + "displayName": "Result code", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "request/success", + "displayName": "Successful request", + "toBeExportedForShoebox": false, + "isHidden": true, + "defaultDimensionValues": [ + { + "value": "False" + } + ] + }, + { + "name": "operation/synthetic", + "displayName": "Is traffic synthetic", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Count" + ], + "lockAggregationType": null + }, + { + "name": "requests/rate", + "displayName": "Server request rate", + "internalMetricName": null, + "displayDescription": "Rate of server requests per second", + "unit": "CountPerSecond", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": true, + "category": "Server", + "dimensions": [ + { + "name": "request/performanceBucket", + "displayName": "Request performance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "request/resultCode", + "displayName": "Result code", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "operation/synthetic", + "displayName": "Is traffic synthetic", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "request/success", + "displayName": "Successful request", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average" + ], + "lockAggregationType": "Average" + }, + { + "name": "exceptions/count", + "displayName": "Exceptions", + "internalMetricName": null, + "displayDescription": "Combined count of all uncaught exceptions.", + "unit": "Count", + "aggregationType": "Count", + "availabilities": null, + "fillGapWithZero": true, + "category": "Failures", + "dimensions": [ + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "client/type", + "displayName": "Device type", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Count" + ], + "lockAggregationType": null + }, + { + "name": "exceptions/browser", + "displayName": "Browser exceptions", + "internalMetricName": "exceptions/count", + "displayDescription": "Count of uncaught exceptions thrown in the browser.", + "unit": "Count", + "aggregationType": "Count", + "availabilities": null, + "fillGapWithZero": true, + "category": "Failures", + "dimensions": [ + { + "name": "client/isServer", + "displayName": null, + "toBeExportedForShoebox": false, + "isHidden": true, + "defaultDimensionValues": [ + { + "value": "False" + } + ] + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Count" + ], + "lockAggregationType": null + }, + { + "name": "exceptions/server", + "displayName": "Server exceptions", + "internalMetricName": "exceptions/count", + "displayDescription": "Count of uncaught exceptions thrown in the server application.", + "unit": "Count", + "aggregationType": "Count", + "availabilities": null, + "fillGapWithZero": true, + "category": "Failures", + "dimensions": [ + { + "name": "client/isServer", + "displayName": null, + "toBeExportedForShoebox": false, + "isHidden": true, + "defaultDimensionValues": [ + { + "value": "True" + } + ] + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Count" + ], + "lockAggregationType": null + }, + { + "name": "traces/count", + "displayName": "Traces", + "internalMetricName": null, + "displayDescription": "Trace document count", + "unit": "Count", + "aggregationType": "Count", + "availabilities": null, + "fillGapWithZero": true, + "category": "Usage", + "dimensions": [ + { + "name": "trace/severityLevel", + "displayName": "Severity level", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "operation/synthetic", + "displayName": "Is traffic synthetic", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Count" + ], + "lockAggregationType": null + } + ], + "logSpecifications": null, + "legacyMetricSpecifications": null + } + } + }, + { + "name": "Microsoft.Insights/Components/ProactiveDetectionConfigs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights proactive detection configuration", + "operation": "Application Insights proactive detection configuration read", + "description": "Reading Application Insights proactive detection configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/ProactiveDetectionConfigs/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights proactive detection configuration", + "operation": "Application Insights proactive detection configuration read", + "description": "Writing Application Insights proactive detection configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/SyntheticMonitorLocations/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights webtest location", + "operation": "Application Insights webtest locations read", + "description": "Reading Application Insights webtest locations" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Webtests/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Web tests", + "operation": "Webtest read", + "description": "Reading a webtest configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Webtests/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Web tests", + "operation": "Webtest write", + "description": "Writing to a webtest configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Webtests/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Web tests", + "operation": "Webtest delete", + "description": "Deleting a webtest configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Webtests/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Web tests", + "operation": "Webtest read", + "description": "Reading a webtest configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Webtests/GetToken/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Webtest token", + "operation": "Webtest token read", + "description": "Reading a webtest token" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Webtests/MetricDefinitions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Webtest metric definitions", + "operation": "Webtest metric definitions read", + "description": "Reading a webtest metric definitions" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Webtests/Metrics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Webtest metrics", + "operation": "Webtest metrics read", + "description": "Reading a webtest metrics" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/WorkItemConfigs/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights ALM integration configuration", + "operation": "Application Insights ALM integration configuration delete", + "description": "Deleting an Application Insights ALM integration configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/WorkItemConfigs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights ALM integration configuration", + "operation": "Application Insights ALM integration configuration read", + "description": "Reading an Application Insights ALM integration configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/WorkItemConfigs/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights ALM integration configuration", + "operation": "Application Insights ALM integration configuration write", + "description": "Writing an Application Insights ALM integration configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/DefaultWorkItemConfig/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights ALM integration configuration", + "operation": "Application Insights default ALM integration configuration read", + "description": "Reading an Application Insights default ALM integration configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Move/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application insights components", + "operation": "Application Insights Component Move", + "description": "Move an Application Insights Component to another resource group or subscription" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ListMigrationDate/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "List Migration Date", + "operation": "Subscription migration date read", + "description": "Get back subscription migration date" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ListMigrationDate/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "List Migration Date", + "operation": "Subscription migration date read", + "description": "Get back Subscription migration date" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MigrateToNewpricingModel/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Migrate to new pricing model", + "operation": "Migrate subscription to new pricing model action", + "description": "Migrate subscription to new pricing model" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/RollbackToLegacyPricingModel/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Rollback legacy pricing model", + "operation": "Rollback subscription to legacy pricing model action", + "description": "Rollback subscription to legacy pricing model" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/topology/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights Topology", + "operation": "Read Topology", + "description": "Read Topology" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/transactions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights Transactions", + "operation": "Read Transactions", + "description": "Read Transactions" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ScheduledQueryRules/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Scheduled query rule", + "operation": "Scheduled query rule write", + "description": "Writing a scheduled query rule" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ScheduledQueryRules/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Scheduled query rule", + "operation": "Scheduled query rule read", + "description": "Reading a scheduled query rule" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ScheduledQueryRules/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Scheduled query rule", + "operation": "Scheduled query rule delete", + "description": "Deleting a scheduled query rule" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Logs", + "operation": "Read Logs", + "description": "Reading data from all your logs" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AADDomainServicesAccountLogon/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AADDomainServicesAccountLogon", + "operation": "Read AADDomainServicesAccountLogon data", + "description": "Read data from the AADDomainServicesAccountLogon table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AADDomainServicesAccountManagement/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AADDomainServicesAccountManagement", + "operation": "Read AADDomainServicesAccountManagement data", + "description": "Read data from the AADDomainServicesAccountManagement table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AADDomainServicesDirectoryServiceAccess/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AADDomainServicesDirectoryServiceAccess", + "operation": "Read AADDomainServicesDirectoryServiceAccess data", + "description": "Read data from the AADDomainServicesDirectoryServiceAccess table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AADDomainServicesLogonLogoff/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AADDomainServicesLogonLogoff", + "operation": "Read AADDomainServicesLogonLogoff data", + "description": "Read data from the AADDomainServicesLogonLogoff table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AADDomainServicesPolicyChange/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AADDomainServicesPolicyChange", + "operation": "Read AADDomainServicesPolicyChange data", + "description": "Read data from the AADDomainServicesPolicyChange table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AADDomainServicesPrivilegeUse/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AADDomainServicesPrivilegeUse", + "operation": "Read AADDomainServicesPrivilegeUse data", + "description": "Read data from the AADDomainServicesPrivilegeUse table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AADDomainServicesSystemSecurity/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AADDomainServicesSystemSecurity", + "operation": "Read AADDomainServicesSystemSecurity data", + "description": "Read data from the AADDomainServicesSystemSecurity table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AADManagedIdentitySignInLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AADManagedIdentitySignInLogs", + "operation": "Read AADManagedIdentitySignInLogs data", + "description": "Read data from the AADManagedIdentitySignInLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AADNonInteractiveUserSignInLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AADNonInteractiveUserSignInLogs", + "operation": "Read AADNonInteractiveUserSignInLogs data", + "description": "Read data from the AADNonInteractiveUserSignInLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AADServicePrincipalSignInLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AADServicePrincipalSignInLogs", + "operation": "Read AADServicePrincipalSignInLogs data", + "description": "Read data from the AADServicePrincipalSignInLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADAssessmentRecommendation", + "operation": "Read ADAssessmentRecommendation data", + "description": "Read data from the ADAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AddonAzureBackupAlerts/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AddonAzureBackupAlerts", + "operation": "Read AddonAzureBackupAlerts data", + "description": "Read data from the AddonAzureBackupAlerts table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AddonAzureBackupJobs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AddonAzureBackupJobs", + "operation": "Read AddonAzureBackupJobs data", + "description": "Read data from the AddonAzureBackupJobs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AddonAzureBackupPolicy/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AddonAzureBackupPolicy", + "operation": "Read AddonAzureBackupPolicy data", + "description": "Read data from the AddonAzureBackupPolicy table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AddonAzureBackupProtectedInstance/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AddonAzureBackupProtectedInstance", + "operation": "Read AddonAzureBackupProtectedInstance data", + "description": "Read data from the AddonAzureBackupProtectedInstance table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AddonAzureBackupStorage/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AddonAzureBackupStorage", + "operation": "Read AddonAzureBackupStorage data", + "description": "Read data from the AddonAzureBackupStorage table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADFActivityRun/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADFActivityRun", + "operation": "Read ADFActivityRun data", + "description": "Read data from the ADFActivityRun table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADFPipelineRun/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADFPipelineRun", + "operation": "Read ADFPipelineRun data", + "description": "Read data from the ADFPipelineRun table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADFSSISIntegrationRuntimeLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADFSSISIntegrationRuntimeLogs", + "operation": "Read ADFSSISIntegrationRuntimeLogs data", + "description": "Read data from the ADFSSISIntegrationRuntimeLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADFSSISPackageEventMessageContext/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADFSSISPackageEventMessageContext", + "operation": "Read ADFSSISPackageEventMessageContext data", + "description": "Read data from the ADFSSISPackageEventMessageContext table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADFSSISPackageEventMessages/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADFSSISPackageEventMessages", + "operation": "Read ADFSSISPackageEventMessages data", + "description": "Read data from the ADFSSISPackageEventMessages table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADFSSISPackageExecutableStatistics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADFSSISPackageExecutableStatistics", + "operation": "Read ADFSSISPackageExecutableStatistics data", + "description": "Read data from the ADFSSISPackageExecutableStatistics table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADFSSISPackageExecutionComponentPhases/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADFSSISPackageExecutionComponentPhases", + "operation": "Read ADFSSISPackageExecutionComponentPhases data", + "description": "Read data from the ADFSSISPackageExecutionComponentPhases table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADFSSISPackageExecutionDataStatistics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADFSSISPackageExecutionDataStatistics", + "operation": "Read ADFSSISPackageExecutionDataStatistics data", + "description": "Read data from the ADFSSISPackageExecutionDataStatistics table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADFTriggerRun/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADFTriggerRun", + "operation": "Read ADFTriggerRun data", + "description": "Read data from the ADFTriggerRun table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADReplicationResult/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADReplicationResult", + "operation": "Read ADReplicationResult data", + "description": "Read data from the ADReplicationResult table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADSecurityAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADSecurityAssessmentRecommendation", + "operation": "Read ADSecurityAssessmentRecommendation data", + "description": "Read data from the ADSecurityAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADTDigitalTwinsOperation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADTDigitalTwinsOperation", + "operation": "Read ADTDigitalTwinsOperation data", + "description": "Read data from the ADTDigitalTwinsOperation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADTEventRoutesOperation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADTEventRoutesOperation", + "operation": "Read ADTEventRoutesOperation data", + "description": "Read data from the ADTEventRoutesOperation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADTModelsOperation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADTModelsOperation", + "operation": "Read ADTModelsOperation data", + "description": "Read data from the ADTModelsOperation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADTQueryOperation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADTQueryOperation", + "operation": "Read ADTQueryOperation data", + "description": "Read data from the ADTQueryOperation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AegDeliveryFailureLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AegDeliveryFailureLogs", + "operation": "Read AegDeliveryFailureLogs data", + "description": "Read data from the AegDeliveryFailureLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AegPublishFailureLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AegPublishFailureLogs", + "operation": "Read AegPublishFailureLogs data", + "description": "Read data from the AegPublishFailureLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Alert/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Alert", + "operation": "Read Alert data", + "description": "Read data from the Alert table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AlertHistory/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AlertHistory", + "operation": "Read AlertHistory data", + "description": "Read data from the AlertHistory table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AmlComputeClusterEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AmlComputeClusterEvent", + "operation": "Read AmlComputeClusterEvent data", + "description": "Read data from the AmlComputeClusterEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AmlComputeClusterNodeEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AmlComputeClusterNodeEvent", + "operation": "Read AmlComputeClusterNodeEvent data", + "description": "Read data from the AmlComputeClusterNodeEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AmlComputeCpuGpuUtilization/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AmlComputeCpuGpuUtilization", + "operation": "Read AmlComputeCpuGpuUtilization data", + "description": "Read data from the AmlComputeCpuGpuUtilization table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AmlComputeJobEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AmlComputeJobEvent", + "operation": "Read AmlComputeJobEvent data", + "description": "Read data from the AmlComputeJobEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AmlRunStatusChangedEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AmlRunStatusChangedEvent", + "operation": "Read AmlRunStatusChangedEvent data", + "description": "Read data from the AmlRunStatusChangedEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ApiManagementGatewayLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ApiManagementGatewayLogs", + "operation": "Read ApiManagementGatewayLogs data", + "description": "Read data from the ApiManagementGatewayLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppAvailabilityResults/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppAvailabilityResults", + "operation": "Read AppAvailabilityResults data", + "description": "Read data from the AppAvailabilityResults table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppBrowserTimings/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppBrowserTimings", + "operation": "Read AppBrowserTimings data", + "description": "Read data from the AppBrowserTimings table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppCenterError/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppCenterError", + "operation": "Read AppCenterError data", + "description": "Read data from the AppCenterError table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppDependencies/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppDependencies", + "operation": "Read AppDependencies data", + "description": "Read data from the AppDependencies table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppEvents/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppEvents", + "operation": "Read AppEvents data", + "description": "Read data from the AppEvents table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppExceptions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppExceptions", + "operation": "Read AppExceptions data", + "description": "Read data from the AppExceptions table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ApplicationInsights/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ApplicationInsights", + "operation": "Read ApplicationInsights data", + "description": "Read data from the ApplicationInsights table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppMetrics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppMetrics", + "operation": "Read AppMetrics data", + "description": "Read data from the AppMetrics table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppPageViews/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppPageViews", + "operation": "Read AppPageViews data", + "description": "Read data from the AppPageViews table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppPerformanceCounters/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppPerformanceCounters", + "operation": "Read AppPerformanceCounters data", + "description": "Read data from the AppPerformanceCounters table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppPlatformLogsforSpring/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppPlatformLogsforSpring", + "operation": "Read AppPlatformLogsforSpring data", + "description": "Read data from the AppPlatformLogsforSpring table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppPlatformSystemLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppPlatformSystemLogs", + "operation": "Read AppPlatformSystemLogs data", + "description": "Read data from the AppPlatformSystemLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppRequests/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppRequests", + "operation": "Read AppRequests data", + "description": "Read data from the AppRequests table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppServiceAntivirusScanLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppServiceAntivirusScanLogs", + "operation": "Read AppServiceAntivirusScanLogs data", + "description": "Read data from the AppServiceAntivirusScanLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppServiceAppLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppServiceAppLogs", + "operation": "Read AppServiceAppLogs data", + "description": "Read data from the AppServiceAppLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppServiceAuditLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppServiceAuditLogs", + "operation": "Read AppServiceAuditLogs data", + "description": "Read data from the AppServiceAuditLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppServiceConsoleLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppServiceConsoleLogs", + "operation": "Read AppServiceConsoleLogs data", + "description": "Read data from the AppServiceConsoleLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppServiceEnvironmentPlatformLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppServiceEnvironmentPlatformLogs", + "operation": "Read AppServiceEnvironmentPlatformLogs data", + "description": "Read data from the AppServiceEnvironmentPlatformLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppServiceFileAuditLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppServiceFileAuditLogs", + "operation": "Read AppServiceFileAuditLogs data", + "description": "Read data from the AppServiceFileAuditLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppServiceHTTPLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppServiceHTTPLogs", + "operation": "Read AppServiceHTTPLogs data", + "description": "Read data from the AppServiceHTTPLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppServicePlatformLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppServicePlatformLogs", + "operation": "Read AppServicePlatformLogs data", + "description": "Read data from the AppServicePlatformLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppSystemEvents/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppSystemEvents", + "operation": "Read AppSystemEvents data", + "description": "Read data from the AppSystemEvents table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppTraces/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppTraces", + "operation": "Read AppTraces data", + "description": "Read data from the AppTraces table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AuditLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AuditLogs", + "operation": "Read AuditLogs data", + "description": "Read data from the AuditLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AutoscaleEvaluationsLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AutoscaleEvaluationsLog", + "operation": "Read AutoscaleEvaluationsLog data", + "description": "Read data from the AutoscaleEvaluationsLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AutoscaleScaleActionsLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AutoscaleScaleActionsLog", + "operation": "Read AutoscaleScaleActionsLog data", + "description": "Read data from the AutoscaleScaleActionsLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AWSCloudTrail/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AWSCloudTrail", + "operation": "Read AWSCloudTrail data", + "description": "Read data from the AWSCloudTrail table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AzureActivity/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AzureActivity", + "operation": "Read AzureActivity data", + "description": "Read data from the AzureActivity table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AzureAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AzureAssessmentRecommendation", + "operation": "Read AzureAssessmentRecommendation data", + "description": "Read data from the AzureAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AzureDevOpsAuditing/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AzureDevOpsAuditing", + "operation": "Read AzureDevOpsAuditing data", + "description": "Read data from the AzureDevOpsAuditing table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AzureDiagnostics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AzureDiagnostics", + "operation": "Read AzureDiagnostics data", + "description": "Read data from the AzureDiagnostics table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AzureMetrics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AzureMetrics", + "operation": "Read AzureMetrics data", + "description": "Read data from the AzureMetrics table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/BaiClusterEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "BaiClusterEvent", + "operation": "Read BaiClusterEvent data", + "description": "Read data from the BaiClusterEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/BaiClusterNodeEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "BaiClusterNodeEvent", + "operation": "Read BaiClusterNodeEvent data", + "description": "Read data from the BaiClusterNodeEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/BaiJobEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "BaiJobEvent", + "operation": "Read BaiJobEvent data", + "description": "Read data from the BaiJobEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/BehaviorAnalytics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "BehaviorAnalytics", + "operation": "Read BehaviorAnalytics data", + "description": "Read data from the BehaviorAnalytics table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/BlockchainApplicationLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "BlockchainApplicationLog", + "operation": "Read BlockchainApplicationLog data", + "description": "Read data from the BlockchainApplicationLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/BlockchainProxyLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "BlockchainProxyLog", + "operation": "Read BlockchainProxyLog data", + "description": "Read data from the BlockchainProxyLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/BoundPort/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "BoundPort", + "operation": "Read BoundPort data", + "description": "Read data from the BoundPort table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/CommonSecurityLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "CommonSecurityLog", + "operation": "Read CommonSecurityLog data", + "description": "Read data from the CommonSecurityLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ComputerGroup/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ComputerGroup", + "operation": "Read ComputerGroup data", + "description": "Read data from the ComputerGroup table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ConfigurationChange/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ConfigurationChange", + "operation": "Read ConfigurationChange data", + "description": "Read data from the ConfigurationChange table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ConfigurationData/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ConfigurationData", + "operation": "Read ConfigurationData data", + "description": "Read data from the ConfigurationData table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ContainerImageInventory/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ContainerImageInventory", + "operation": "Read ContainerImageInventory data", + "description": "Read data from the ContainerImageInventory table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ContainerInventory/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ContainerInventory", + "operation": "Read ContainerInventory data", + "description": "Read data from the ContainerInventory table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ContainerLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ContainerLog", + "operation": "Read ContainerLog data", + "description": "Read data from the ContainerLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ContainerNodeInventory/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ContainerNodeInventory", + "operation": "Read ContainerNodeInventory data", + "description": "Read data from the ContainerNodeInventory table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ContainerRegistryLoginEvents/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ContainerRegistryLoginEvents", + "operation": "Read ContainerRegistryLoginEvents data", + "description": "Read data from the ContainerRegistryLoginEvents table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ContainerRegistryRepositoryEvents/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ContainerRegistryRepositoryEvents", + "operation": "Read ContainerRegistryRepositoryEvents data", + "description": "Read data from the ContainerRegistryRepositoryEvents table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ContainerServiceLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ContainerServiceLog", + "operation": "Read ContainerServiceLog data", + "description": "Read data from the ContainerServiceLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Tables.Custom/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "CustomLogs", + "operation": "Read Custom Logs", + "description": "Reading data from any custom log" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/CoreAzureBackup/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "CoreAzureBackup", + "operation": "Read CoreAzureBackup data", + "description": "Read data from the CoreAzureBackup table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksAccounts/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksAccounts", + "operation": "Read DatabricksAccounts data", + "description": "Read data from the DatabricksAccounts table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksClusters/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksClusters", + "operation": "Read DatabricksClusters data", + "description": "Read data from the DatabricksClusters table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksDBFS/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksDBFS", + "operation": "Read DatabricksDBFS data", + "description": "Read data from the DatabricksDBFS table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksInstancePools/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksInstancePools", + "operation": "Read DatabricksInstancePools data", + "description": "Read data from the DatabricksInstancePools table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksJobs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksJobs", + "operation": "Read DatabricksJobs data", + "description": "Read data from the DatabricksJobs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksNotebook/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksNotebook", + "operation": "Read DatabricksNotebook data", + "description": "Read data from the DatabricksNotebook table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksSecrets/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksSecrets", + "operation": "Read DatabricksSecrets data", + "description": "Read data from the DatabricksSecrets table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksSQLPermissions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksSQLPermissions", + "operation": "Read DatabricksSQLPermissions data", + "description": "Read data from the DatabricksSQLPermissions table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksSSH/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksSSH", + "operation": "Read DatabricksSSH data", + "description": "Read data from the DatabricksSSH table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksTables/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksTables", + "operation": "Read DatabricksTables data", + "description": "Read data from the DatabricksTables table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksWorkspace/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksWorkspace", + "operation": "Read DatabricksWorkspace data", + "description": "Read data from the DatabricksWorkspace table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceAppCrash/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceAppCrash", + "operation": "Read DeviceAppCrash data", + "description": "Read data from the DeviceAppCrash table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceAppLaunch/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceAppLaunch", + "operation": "Read DeviceAppLaunch data", + "description": "Read data from the DeviceAppLaunch table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceCalendar/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceCalendar", + "operation": "Read DeviceCalendar data", + "description": "Read data from the DeviceCalendar table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceCleanup/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceCleanup", + "operation": "Read DeviceCleanup data", + "description": "Read data from the DeviceCleanup table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceConnectSession/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceConnectSession", + "operation": "Read DeviceConnectSession data", + "description": "Read data from the DeviceConnectSession table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceEtw/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceEtw", + "operation": "Read DeviceEtw data", + "description": "Read data from the DeviceEtw table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceHardwareHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceHardwareHealth", + "operation": "Read DeviceHardwareHealth data", + "description": "Read data from the DeviceHardwareHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceHealth", + "operation": "Read DeviceHealth data", + "description": "Read data from the DeviceHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceHeartbeat/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceHeartbeat", + "operation": "Read DeviceHeartbeat data", + "description": "Read data from the DeviceHeartbeat table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceSkypeHeartbeat/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceSkypeHeartbeat", + "operation": "Read DeviceSkypeHeartbeat data", + "description": "Read data from the DeviceSkypeHeartbeat table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceSkypeSignIn/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceSkypeSignIn", + "operation": "Read DeviceSkypeSignIn data", + "description": "Read data from the DeviceSkypeSignIn table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceSleepState/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceSleepState", + "operation": "Read DeviceSleepState data", + "description": "Read data from the DeviceSleepState table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DHAppFailure/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DHAppFailure", + "operation": "Read DHAppFailure data", + "description": "Read data from the DHAppFailure table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DHAppReliability/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DHAppReliability", + "operation": "Read DHAppReliability data", + "description": "Read data from the DHAppReliability table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DHCPActivity/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DHCPActivity", + "operation": "Read DHCPActivity data", + "description": "Read data from the DHCPActivity table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DHDriverReliability/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DHDriverReliability", + "operation": "Read DHDriverReliability data", + "description": "Read data from the DHDriverReliability table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DHLogonFailures/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DHLogonFailures", + "operation": "Read DHLogonFailures data", + "description": "Read data from the DHLogonFailures table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DHLogonMetrics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DHLogonMetrics", + "operation": "Read DHLogonMetrics data", + "description": "Read data from the DHLogonMetrics table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DHOSCrashData/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DHOSCrashData", + "operation": "Read DHOSCrashData data", + "description": "Read data from the DHOSCrashData table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DHOSReliability/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DHOSReliability", + "operation": "Read DHOSReliability data", + "description": "Read data from the DHOSReliability table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DHWipAppLearning/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DHWipAppLearning", + "operation": "Read DHWipAppLearning data", + "description": "Read data from the DHWipAppLearning table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DnsEvents/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DnsEvents", + "operation": "Read DnsEvents data", + "description": "Read data from the DnsEvents table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DnsInventory/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DnsInventory", + "operation": "Read DnsInventory data", + "description": "Read data from the DnsInventory table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Dynamics365Activity/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Dynamics365Activity", + "operation": "Read Dynamics365Activity data", + "description": "Read data from the Dynamics365Activity table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ETWEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ETWEvent", + "operation": "Read ETWEvent data", + "description": "Read data from the ETWEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Event/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Event", + "operation": "Read Event data", + "description": "Read data from the Event table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ExchangeAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ExchangeAssessmentRecommendation", + "operation": "Read ExchangeAssessmentRecommendation data", + "description": "Read data from the ExchangeAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ExchangeOnlineAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ExchangeOnlineAssessmentRecommendation", + "operation": "Read ExchangeOnlineAssessmentRecommendation data", + "description": "Read data from the ExchangeOnlineAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/FailedIngestion/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "FailedIngestion", + "operation": "Read FailedIngestion data", + "description": "Read data from the FailedIngestion table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/FunctionAppLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "FunctionAppLogs", + "operation": "Read FunctionAppLogs data", + "description": "Read data from the FunctionAppLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Heartbeat/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Heartbeat", + "operation": "Read Heartbeat data", + "description": "Read data from the Heartbeat table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/HuntingBookmark/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "HuntingBookmark", + "operation": "Read HuntingBookmark data", + "description": "Read data from the HuntingBookmark table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/IISAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "IISAssessmentRecommendation", + "operation": "Read IISAssessmentRecommendation data", + "description": "Read data from the IISAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/InboundConnection/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "InboundConnection", + "operation": "Read InboundConnection data", + "description": "Read data from the InboundConnection table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/InsightsMetrics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "InsightsMetrics", + "operation": "Read InsightsMetrics data", + "description": "Read data from the InsightsMetrics table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/IntuneAuditLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "IntuneAuditLogs", + "operation": "Read IntuneAuditLogs data", + "description": "Read data from the IntuneAuditLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/IntuneDeviceComplianceOrg/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "IntuneDeviceComplianceOrg", + "operation": "Read IntuneDeviceComplianceOrg data", + "description": "Read data from the IntuneDeviceComplianceOrg table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/IntuneOperationalLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "IntuneOperationalLogs", + "operation": "Read IntuneOperationalLogs data", + "description": "Read data from the IntuneOperationalLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/IoTHubDistributedTracing/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "IoTHubDistributedTracing", + "operation": "Read IoTHubDistributedTracing data", + "description": "Read data from the IoTHubDistributedTracing table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/KubeEvents/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "KubeEvents", + "operation": "Read KubeEvents data", + "description": "Read data from the KubeEvents table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/KubeHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "KubeHealth", + "operation": "Read KubeHealth data", + "description": "Read data from the KubeHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/KubeMonAgentEvents/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "KubeMonAgentEvents", + "operation": "Read KubeMonAgentEvents data", + "description": "Read data from the KubeMonAgentEvents table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/KubeNodeInventory/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "KubeNodeInventory", + "operation": "Read KubeNodeInventory data", + "description": "Read data from the KubeNodeInventory table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/KubePodInventory/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "KubePodInventory", + "operation": "Read KubePodInventory data", + "description": "Read data from the KubePodInventory table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/KubeServices/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "KubeServices", + "operation": "Read KubeServices data", + "description": "Read data from the KubeServices table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/LinuxAuditLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "LinuxAuditLog", + "operation": "Read LinuxAuditLog data", + "description": "Read data from the LinuxAuditLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAApplication/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAApplication", + "operation": "Read MAApplication data", + "description": "Read data from the MAApplication table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAApplicationHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAApplicationHealth", + "operation": "Read MAApplicationHealth data", + "description": "Read data from the MAApplicationHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAApplicationHealthAlternativeVersions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAApplicationHealthAlternativeVersions", + "operation": "Read MAApplicationHealthAlternativeVersions data", + "description": "Read data from the MAApplicationHealthAlternativeVersions table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAApplicationHealthIssues/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAApplicationHealthIssues", + "operation": "Read MAApplicationHealthIssues data", + "description": "Read data from the MAApplicationHealthIssues table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAApplicationInstance/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAApplicationInstance", + "operation": "Read MAApplicationInstance data", + "description": "Read data from the MAApplicationInstance table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAApplicationInstanceReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAApplicationInstanceReadiness", + "operation": "Read MAApplicationInstanceReadiness data", + "description": "Read data from the MAApplicationInstanceReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAApplicationReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAApplicationReadiness", + "operation": "Read MAApplicationReadiness data", + "description": "Read data from the MAApplicationReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MADeploymentPlan/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MADeploymentPlan", + "operation": "Read MADeploymentPlan data", + "description": "Read data from the MADeploymentPlan table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MADevice/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MADevice", + "operation": "Read MADevice data", + "description": "Read data from the MADevice table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MADeviceNotEnrolled/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MADeviceNotEnrolled", + "operation": "Read MADeviceNotEnrolled data", + "description": "Read data from the MADeviceNotEnrolled table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MADeviceNRT/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MADeviceNRT", + "operation": "Read MADeviceNRT data", + "description": "Read data from the MADeviceNRT table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MADevicePnPHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MADevicePnPHealth", + "operation": "Read MADevicePnPHealth data", + "description": "Read data from the MADevicePnPHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MADevicePnPHealthAlternativeVersions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MADevicePnPHealthAlternativeVersions", + "operation": "Read MADevicePnPHealthAlternativeVersions data", + "description": "Read data from the MADevicePnPHealthAlternativeVersions table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MADevicePnPHealthIssues/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MADevicePnPHealthIssues", + "operation": "Read MADevicePnPHealthIssues data", + "description": "Read data from the MADevicePnPHealthIssues table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MADeviceReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MADeviceReadiness", + "operation": "Read MADeviceReadiness data", + "description": "Read data from the MADeviceReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MADriverInstanceReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MADriverInstanceReadiness", + "operation": "Read MADriverInstanceReadiness data", + "description": "Read data from the MADriverInstanceReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MADriverReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MADriverReadiness", + "operation": "Read MADriverReadiness data", + "description": "Read data from the MADriverReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAddin/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAddin", + "operation": "Read MAOfficeAddin data", + "description": "Read data from the MAOfficeAddin table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAddinEntityHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAddinEntityHealth", + "operation": "Read MAOfficeAddinEntityHealth data", + "description": "Read data from the MAOfficeAddinEntityHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAddinHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAddinHealth", + "operation": "Read MAOfficeAddinHealth data", + "description": "Read data from the MAOfficeAddinHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAddinHealthEventNRT/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAddinHealthEventNRT", + "operation": "Read MAOfficeAddinHealthEventNRT data", + "description": "Read data from the MAOfficeAddinHealthEventNRT table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAddinHealthIssues/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAddinHealthIssues", + "operation": "Read MAOfficeAddinHealthIssues data", + "description": "Read data from the MAOfficeAddinHealthIssues table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAddinInstance/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAddinInstance", + "operation": "Read MAOfficeAddinInstance data", + "description": "Read data from the MAOfficeAddinInstance table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAddinInstanceReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAddinInstanceReadiness", + "operation": "Read MAOfficeAddinInstanceReadiness data", + "description": "Read data from the MAOfficeAddinInstanceReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAddinReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAddinReadiness", + "operation": "Read MAOfficeAddinReadiness data", + "description": "Read data from the MAOfficeAddinReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeApp/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeApp", + "operation": "Read MAOfficeApp data", + "description": "Read data from the MAOfficeApp table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAppCrashesNRT/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAppCrashesNRT", + "operation": "Read MAOfficeAppCrashesNRT data", + "description": "Read data from the MAOfficeAppCrashesNRT table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAppHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAppHealth", + "operation": "Read MAOfficeAppHealth data", + "description": "Read data from the MAOfficeAppHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAppInstance/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAppInstance", + "operation": "Read MAOfficeAppInstance data", + "description": "Read data from the MAOfficeAppInstance table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAppInstanceHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAppInstanceHealth", + "operation": "Read MAOfficeAppInstanceHealth data", + "description": "Read data from the MAOfficeAppInstanceHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAppReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAppReadiness", + "operation": "Read MAOfficeAppReadiness data", + "description": "Read data from the MAOfficeAppReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAppSessionsNRT/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAppSessionsNRT", + "operation": "Read MAOfficeAppSessionsNRT data", + "description": "Read data from the MAOfficeAppSessionsNRT table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeBuildInfo/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeBuildInfo", + "operation": "Read MAOfficeBuildInfo data", + "description": "Read data from the MAOfficeBuildInfo table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeCurrencyAssessment/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeCurrencyAssessment", + "operation": "Read MAOfficeCurrencyAssessment data", + "description": "Read data from the MAOfficeCurrencyAssessment table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeCurrencyAssessmentDailyCounts/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeCurrencyAssessmentDailyCounts", + "operation": "Read MAOfficeCurrencyAssessmentDailyCounts data", + "description": "Read data from the MAOfficeCurrencyAssessmentDailyCounts table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeDeploymentStatus/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeDeploymentStatus", + "operation": "Read MAOfficeDeploymentStatus data", + "description": "Read data from the MAOfficeDeploymentStatus table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeDeploymentStatusNRT/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeDeploymentStatusNRT", + "operation": "Read MAOfficeDeploymentStatusNRT data", + "description": "Read data from the MAOfficeDeploymentStatusNRT table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeMacroErrorNRT/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeMacroErrorNRT", + "operation": "Read MAOfficeMacroErrorNRT data", + "description": "Read data from the MAOfficeMacroErrorNRT table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeMacroGlobalHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeMacroGlobalHealth", + "operation": "Read MAOfficeMacroGlobalHealth data", + "description": "Read data from the MAOfficeMacroGlobalHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeMacroHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeMacroHealth", + "operation": "Read MAOfficeMacroHealth data", + "description": "Read data from the MAOfficeMacroHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeMacroHealthIssues/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeMacroHealthIssues", + "operation": "Read MAOfficeMacroHealthIssues data", + "description": "Read data from the MAOfficeMacroHealthIssues table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeMacroIssueInstanceReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeMacroIssueInstanceReadiness", + "operation": "Read MAOfficeMacroIssueInstanceReadiness data", + "description": "Read data from the MAOfficeMacroIssueInstanceReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeMacroIssueReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeMacroIssueReadiness", + "operation": "Read MAOfficeMacroIssueReadiness data", + "description": "Read data from the MAOfficeMacroIssueReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeMacroSummary/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeMacroSummary", + "operation": "Read MAOfficeMacroSummary data", + "description": "Read data from the MAOfficeMacroSummary table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeSuite/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeSuite", + "operation": "Read MAOfficeSuite data", + "description": "Read data from the MAOfficeSuite table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeSuiteInstance/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeSuiteInstance", + "operation": "Read MAOfficeSuiteInstance data", + "description": "Read data from the MAOfficeSuiteInstance table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAProposedPilotDevices/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAProposedPilotDevices", + "operation": "Read MAProposedPilotDevices data", + "description": "Read data from the MAProposedPilotDevices table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAWindowsBuildInfo/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAWindowsBuildInfo", + "operation": "Read MAWindowsBuildInfo data", + "description": "Read data from the MAWindowsBuildInfo table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAWindowsCurrencyAssessment/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAWindowsCurrencyAssessment", + "operation": "Read MAWindowsCurrencyAssessment data", + "description": "Read data from the MAWindowsCurrencyAssessment table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAWindowsCurrencyAssessmentDailyCounts/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAWindowsCurrencyAssessmentDailyCounts", + "operation": "Read MAWindowsCurrencyAssessmentDailyCounts data", + "description": "Read data from the MAWindowsCurrencyAssessmentDailyCounts table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAWindowsDeploymentStatus/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAWindowsDeploymentStatus", + "operation": "Read MAWindowsDeploymentStatus data", + "description": "Read data from the MAWindowsDeploymentStatus table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAWindowsDeploymentStatusNRT/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAWindowsDeploymentStatusNRT", + "operation": "Read MAWindowsDeploymentStatusNRT data", + "description": "Read data from the MAWindowsDeploymentStatusNRT table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAWindowsSysReqInstanceReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAWindowsSysReqInstanceReadiness", + "operation": "Read MAWindowsSysReqInstanceReadiness data", + "description": "Read data from the MAWindowsSysReqInstanceReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/McasShadowItReporting/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "McasShadowItReporting", + "operation": "Read McasShadowItReporting data", + "description": "Read data from the McasShadowItReporting table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MicrosoftAzureBastionAuditLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MicrosoftAzureBastionAuditLogs", + "operation": "Read MicrosoftAzureBastionAuditLogs data", + "description": "Read data from the MicrosoftAzureBastionAuditLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MicrosoftDataShareReceivedSnapshotLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MicrosoftDataShareReceivedSnapshotLog", + "operation": "Read MicrosoftDataShareReceivedSnapshotLog data", + "description": "Read data from the MicrosoftDataShareReceivedSnapshotLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MicrosoftDataShareSentSnapshotLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MicrosoftDataShareSentSnapshotLog", + "operation": "Read MicrosoftDataShareSentSnapshotLog data", + "description": "Read data from the MicrosoftDataShareSentSnapshotLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MicrosoftDataShareShareLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MicrosoftDataShareShareLog", + "operation": "Read MicrosoftDataShareShareLog data", + "description": "Read data from the MicrosoftDataShareShareLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MicrosoftDynamicsTelemetryPerformanceLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MicrosoftDynamicsTelemetryPerformanceLogs", + "operation": "Read MicrosoftDynamicsTelemetryPerformanceLogs data", + "description": "Read data from the MicrosoftDynamicsTelemetryPerformanceLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MicrosoftDynamicsTelemetrySystemMetricsLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MicrosoftDynamicsTelemetrySystemMetricsLogs", + "operation": "Read MicrosoftDynamicsTelemetrySystemMetricsLogs data", + "description": "Read data from the MicrosoftDynamicsTelemetrySystemMetricsLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MicrosoftHealthcareApisAuditLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MicrosoftHealthcareApisAuditLogs", + "operation": "Read MicrosoftHealthcareApisAuditLogs data", + "description": "Read data from the MicrosoftHealthcareApisAuditLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/NetworkMonitoring/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "NetworkMonitoring", + "operation": "Read NetworkMonitoring data", + "description": "Read data from the NetworkMonitoring table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/OfficeActivity/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "OfficeActivity", + "operation": "Read OfficeActivity data", + "description": "Read data from the OfficeActivity table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Operation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Operation", + "operation": "Read Operation data", + "description": "Read data from the Operation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/OutboundConnection/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "OutboundConnection", + "operation": "Read OutboundConnection data", + "description": "Read data from the OutboundConnection table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Perf/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Perf", + "operation": "Read Perf data", + "description": "Read data from the Perf table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ProtectionStatus/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ProtectionStatus", + "operation": "Read ProtectionStatus data", + "description": "Read data from the ProtectionStatus table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ReservedAzureCommonFields/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ReservedAzureCommonFields", + "operation": "Read ReservedAzureCommonFields data", + "description": "Read data from the ReservedAzureCommonFields table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ReservedCommonFields/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ReservedCommonFields", + "operation": "Read ReservedCommonFields data", + "description": "Read data from the ReservedCommonFields table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SCCMAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SCCMAssessmentRecommendation", + "operation": "Read SCCMAssessmentRecommendation data", + "description": "Read data from the SCCMAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SCOMAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SCOMAssessmentRecommendation", + "operation": "Read SCOMAssessmentRecommendation data", + "description": "Read data from the SCOMAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SecurityAlert/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SecurityAlert", + "operation": "Read SecurityAlert data", + "description": "Read data from the SecurityAlert table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SecurityBaseline/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SecurityBaseline", + "operation": "Read SecurityBaseline data", + "description": "Read data from the SecurityBaseline table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SecurityBaselineSummary/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SecurityBaselineSummary", + "operation": "Read SecurityBaselineSummary data", + "description": "Read data from the SecurityBaselineSummary table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SecurityDetection/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SecurityDetection", + "operation": "Read SecurityDetection data", + "description": "Read data from the SecurityDetection table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SecurityEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SecurityEvent", + "operation": "Read SecurityEvent data", + "description": "Read data from the SecurityEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SecurityIncident/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SecurityIncident", + "operation": "Read SecurityIncident data", + "description": "Read data from the SecurityIncident table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SecurityIoTRawEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SecurityIoTRawEvent", + "operation": "Read SecurityIoTRawEvent data", + "description": "Read data from the SecurityIoTRawEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SecurityNestedRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SecurityNestedRecommendation", + "operation": "Read SecurityNestedRecommendation data", + "description": "Read data from the SecurityNestedRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SecurityRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SecurityRecommendation", + "operation": "Read SecurityRecommendation data", + "description": "Read data from the SecurityRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ServiceFabricOperationalEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ServiceFabricOperationalEvent", + "operation": "Read ServiceFabricOperationalEvent data", + "description": "Read data from the ServiceFabricOperationalEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ServiceFabricReliableActorEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ServiceFabricReliableActorEvent", + "operation": "Read ServiceFabricReliableActorEvent data", + "description": "Read data from the ServiceFabricReliableActorEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ServiceFabricReliableServiceEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ServiceFabricReliableServiceEvent", + "operation": "Read ServiceFabricReliableServiceEvent data", + "description": "Read data from the ServiceFabricReliableServiceEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SfBAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SfBAssessmentRecommendation", + "operation": "Read SfBAssessmentRecommendation data", + "description": "Read data from the SfBAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SfBOnlineAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SfBOnlineAssessmentRecommendation", + "operation": "Read SfBOnlineAssessmentRecommendation data", + "description": "Read data from the SfBOnlineAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SharePointOnlineAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SharePointOnlineAssessmentRecommendation", + "operation": "Read SharePointOnlineAssessmentRecommendation data", + "description": "Read data from the SharePointOnlineAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SignalRServiceDiagnosticLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SignalRServiceDiagnosticLogs", + "operation": "Read SignalRServiceDiagnosticLogs data", + "description": "Read data from the SignalRServiceDiagnosticLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SigninLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SigninLogs", + "operation": "Read SigninLogs data", + "description": "Read data from the SigninLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SPAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SPAssessmentRecommendation", + "operation": "Read SPAssessmentRecommendation data", + "description": "Read data from the SPAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SQLAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SQLAssessmentRecommendation", + "operation": "Read SQLAssessmentRecommendation data", + "description": "Read data from the SQLAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SqlDataClassification/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SqlDataClassification", + "operation": "Read SqlDataClassification data", + "description": "Read data from the SqlDataClassification table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SQLQueryPerformance/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SQLQueryPerformance", + "operation": "Read SQLQueryPerformance data", + "description": "Read data from the SQLQueryPerformance table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SqlVulnerabilityAssessmentResult/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SqlVulnerabilityAssessmentResult", + "operation": "Read SqlVulnerabilityAssessmentResult data", + "description": "Read data from the SqlVulnerabilityAssessmentResult table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/StorageBlobLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "StorageBlobLogs", + "operation": "Read StorageBlobLogs data", + "description": "Read data from the StorageBlobLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/StorageFileLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "StorageFileLogs", + "operation": "Read StorageFileLogs data", + "description": "Read data from the StorageFileLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/StorageQueueLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "StorageQueueLogs", + "operation": "Read StorageQueueLogs data", + "description": "Read data from the StorageQueueLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/StorageTableLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "StorageTableLogs", + "operation": "Read StorageTableLogs data", + "description": "Read data from the StorageTableLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SucceededIngestion/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SucceededIngestion", + "operation": "Read SucceededIngestion data", + "description": "Read data from the SucceededIngestion table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Syslog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Syslog", + "operation": "Read Syslog data", + "description": "Read data from the Syslog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SysmonEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SysmonEvent", + "operation": "Read SysmonEvent data", + "description": "Read data from the SysmonEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ThreatIntelligenceIndicator/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ThreatIntelligenceIndicator", + "operation": "Read ThreatIntelligenceIndicator data", + "description": "Read data from the ThreatIntelligenceIndicator table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/TSIIngress/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "TSIIngress", + "operation": "Read TSIIngress data", + "description": "Read data from the TSIIngress table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UAApp/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UAApp", + "operation": "Read UAApp data", + "description": "Read data from the UAApp table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UAComputer/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UAComputer", + "operation": "Read UAComputer data", + "description": "Read data from the UAComputer table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UAComputerRank/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UAComputerRank", + "operation": "Read UAComputerRank data", + "description": "Read data from the UAComputerRank table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UADriver/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UADriver", + "operation": "Read UADriver data", + "description": "Read data from the UADriver table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UADriverProblemCodes/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UADriverProblemCodes", + "operation": "Read UADriverProblemCodes data", + "description": "Read data from the UADriverProblemCodes table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UAFeedback/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UAFeedback", + "operation": "Read UAFeedback data", + "description": "Read data from the UAFeedback table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UAHardwareSecurity/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UAHardwareSecurity", + "operation": "Read UAHardwareSecurity data", + "description": "Read data from the UAHardwareSecurity table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UAIESiteDiscovery/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UAIESiteDiscovery", + "operation": "Read UAIESiteDiscovery data", + "description": "Read data from the UAIESiteDiscovery table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UAOfficeAddIn/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UAOfficeAddIn", + "operation": "Read UAOfficeAddIn data", + "description": "Read data from the UAOfficeAddIn table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UAProposedActionPlan/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UAProposedActionPlan", + "operation": "Read UAProposedActionPlan data", + "description": "Read data from the UAProposedActionPlan table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UASysReqIssue/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UASysReqIssue", + "operation": "Read UASysReqIssue data", + "description": "Read data from the UASysReqIssue table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UAUpgradedComputer/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UAUpgradedComputer", + "operation": "Read UAUpgradedComputer data", + "description": "Read data from the UAUpgradedComputer table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Update/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Update", + "operation": "Read Update data", + "description": "Read data from the Update table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UpdateRunProgress/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UpdateRunProgress", + "operation": "Read UpdateRunProgress data", + "description": "Read data from the UpdateRunProgress table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UpdateSummary/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UpdateSummary", + "operation": "Read UpdateSummary data", + "description": "Read data from the UpdateSummary table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Usage/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Usage", + "operation": "Read Usage data", + "description": "Read data from the Usage table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UserAccessAnalytics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UserAccessAnalytics", + "operation": "Read UserAccessAnalytics data", + "description": "Read data from the UserAccessAnalytics table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UserPeerAnalytics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UserPeerAnalytics", + "operation": "Read UserPeerAnalytics data", + "description": "Read data from the UserPeerAnalytics table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/VMBoundPort/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "VMBoundPort", + "operation": "Read VMBoundPort data", + "description": "Read data from the VMBoundPort table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/VMComputer/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "VMComputer", + "operation": "Read VMComputer data", + "description": "Read data from the VMComputer table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/VMConnection/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "VMConnection", + "operation": "Read VMConnection data", + "description": "Read data from the VMConnection table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/VMProcess/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "VMProcess", + "operation": "Read VMProcess data", + "description": "Read data from the VMProcess table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/W3CIISLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "W3CIISLog", + "operation": "Read W3CIISLog data", + "description": "Read data from the W3CIISLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WaaSDeploymentStatus/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WaaSDeploymentStatus", + "operation": "Read WaaSDeploymentStatus data", + "description": "Read data from the WaaSDeploymentStatus table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WaaSInsiderStatus/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WaaSInsiderStatus", + "operation": "Read WaaSInsiderStatus data", + "description": "Read data from the WaaSInsiderStatus table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WaaSUpdateStatus/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WaaSUpdateStatus", + "operation": "Read WaaSUpdateStatus data", + "description": "Read data from the WaaSUpdateStatus table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WDAVStatus/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WDAVStatus", + "operation": "Read WDAVStatus data", + "description": "Read data from the WDAVStatus table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WDAVThreat/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WDAVThreat", + "operation": "Read WDAVThreat data", + "description": "Read data from the WDAVThreat table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WindowsClientAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WindowsClientAssessmentRecommendation", + "operation": "Read WindowsClientAssessmentRecommendation data", + "description": "Read data from the WindowsClientAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WindowsEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WindowsEvent", + "operation": "Read WindowsEvent data", + "description": "Read data from the WindowsEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WindowsFirewall/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WindowsFirewall", + "operation": "Read WindowsFirewall data", + "description": "Read data from the WindowsFirewall table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WindowsServerAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WindowsServerAssessmentRecommendation", + "operation": "Read WindowsServerAssessmentRecommendation data", + "description": "Read data from the WindowsServerAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WireData/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WireData", + "operation": "Read WireData data", + "description": "Read data from the WireData table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WorkloadMonitoringPerf/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WorkloadMonitoringPerf", + "operation": "Read WorkloadMonitoringPerf data", + "description": "Read data from the WorkloadMonitoringPerf table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WUDOAggregatedStatus/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WUDOAggregatedStatus", + "operation": "Read WUDOAggregatedStatus data", + "description": "Read data from the WUDOAggregatedStatus table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WUDOStatus/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WUDOStatus", + "operation": "Read WUDOStatus data", + "description": "Read data from the WUDOStatus table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WVDCheckpoints/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WVDCheckpoints", + "operation": "Read WVDCheckpoints data", + "description": "Read data from the WVDCheckpoints table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WVDConnections/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WVDConnections", + "operation": "Read WVDConnections data", + "description": "Read data from the WVDConnections table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WVDErrors/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WVDErrors", + "operation": "Read WVDErrors data", + "description": "Read data from the WVDErrors table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WVDFeeds/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WVDFeeds", + "operation": "Read WVDFeeds data", + "description": "Read data from the WVDFeeds table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WVDHostRegistrations/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WVDHostRegistrations", + "operation": "Read WVDHostRegistrations data", + "description": "Read data from the WVDHostRegistrations table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WVDManagement/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WVDManagement", + "operation": "Read WVDManagement data", + "description": "Read data from the WVDManagement table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Baseline/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Baseline", + "operation": "Read metric baseline", + "description": "Read a metric baseline (preview)" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/CalculateBaseline/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Baseline", + "operation": "Calculate baseline", + "description": "Calculate baseline for metric values (preview)" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MetricBaselines/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Baseline", + "operation": "Read metric baselines", + "description": "Read metric baselines" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionRules/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection rule", + "operation": "Read data collection rule", + "description": "Read a data collection rule" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionRules/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection rule", + "operation": "Create or update data collection rule", + "description": "Create or update a data collection rule" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionRules/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection rule", + "operation": "Delete data collection rule", + "description": "Delete a data collection rule" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionRules/Data/Write", + "isDataAction": true, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection rule", + "operation": "Send data to data collection rule", + "description": "Send data to a data collection rule" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionRuleAssociations/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection rule association", + "operation": "Read data collection rule association", + "description": "Read a resource's association with a data collection rule" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionRuleAssociations/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection rule association", + "operation": "Create or update data collection rule association", + "description": "Create or update a resource's association with a data collection rule" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionRuleAssociations/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection rule association", + "operation": "Delete data collection rule association", + "description": "Delete a resource's association with a data collection rule" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionEndpoints/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection endpoint", + "operation": "Read data collection endpoint", + "description": "Read a data collection endpoint" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionEndpoints/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection endpoint", + "operation": "Create or update data collection endpoint", + "description": "Create or update a data collection endpoint" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionEndpoints/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection endpoint", + "operation": "Delete data collection endpoint", + "description": "Delete a data collection endpoint" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionEndpoints/ScopedPrivateLinkProxies/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection endpoint scoped private link proxy", + "operation": "Read data collection endpoint private link proxy", + "description": "Read a data collection endpoint private link proxy" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionEndpoints/ScopedPrivateLinkProxies/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection endpoint scoped private link proxy", + "operation": "Create or update data collection endpoint private link proxy", + "description": "Create or update a data collection endpoint private link proxy" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionEndpoints/ScopedPrivateLinkProxies/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection endpoint scoped private link proxy", + "operation": "Delete data collection endpoint private link proxy", + "description": "Delete a data collection endpoint private link proxy" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private Link Scope", + "operation": "Read a private link scope", + "description": "Read a private link scope" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private Link Scope", + "operation": "Create or update a private link scope", + "description": "Create or update a private link scope" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private Link Scope", + "operation": "Delete a private link scope", + "description": "Delete a private link scope" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopeOperationStatuses/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private Link Scope operation status", + "operation": "Read a private link scoped operation status", + "description": "Read a private link scoped operation status" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/ScopedResources/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private Link Scoped Resource", + "operation": "Read a private link scoped resource", + "description": "Read a private link scoped resource" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/ScopedResources/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private Link Scoped Resource", + "operation": "Create or update a private link scoped resource", + "description": "Create or update a private link scoped resource" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/ScopedResources/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private Link Scoped Resource", + "operation": "Delete a private link scoped resource", + "description": "Delete a private link scoped resource" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/PrivateLinkResources/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private Link Resource", + "operation": "Read a private link resource", + "description": "Read a private link resource" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/PrivateEndpointConnections/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private endpoint connection", + "operation": "Read a private endpoint connection", + "description": "Read a private endpoint connection" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/PrivateEndpointConnections/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private endpoint connection", + "operation": "Create or update a private endpoint connection", + "description": "Create or update a private endpoint connection" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/PrivateEndpointConnections/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private endpoint connection", + "operation": "Delete a private endpoint connection", + "description": "Delete a private endpoint connection" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/PrivateEndpointConnectionProxies/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private endpoint connection proxy", + "operation": "Read a private endpoint connection proxy", + "description": "Read a private endpoint connection proxy" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/PrivateEndpointConnectionProxies/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private endpoint connection proxy", + "operation": "Create or update a private endpoint connection proxy", + "description": "Create or update a private endpoint connection proxy" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/PrivateEndpointConnectionProxies/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private endpoint connection proxy", + "operation": "Delete a private endpoint connection proxy", + "description": "Delete a private endpoint connection proxy" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/PrivateEndpointConnectionProxies/Validate/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private endpoint connection proxy", + "operation": "Validate a private endpoint connection proxy", + "description": "Validate a private endpoint connection proxy" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MyWorkbooks/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MyWorkbooks", + "operation": "Read private workbook", + "description": "Read a private Workbook" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MyWorkbooks/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MyWorkbooks", + "operation": "Create or update private workbook", + "description": "Create or update a private workbook" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MyWorkbooks/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MyWorkbooks", + "operation": "Delete private workbook", + "description": "Delete a private workbook" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Workbooks/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Workbooks", + "operation": "Create or update workbook", + "description": "Create or update a workbook" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Workbooks/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Workbooks", + "operation": "Delete workbook", + "description": "Delete a workbook" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Workbooks/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Workbooks", + "operation": "Read workbook", + "description": "Read a workbook" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Workbooks/Revisions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Workbooks", + "operation": "Workbook revisions", + "description": "Get the workbook revisions" + }, + "properties": {} + } + ] + } + }, + "default": { + "body": { + "error": { + "code": "InvalidResourceType", + "message": "The resource type 'operations' could not be found in the namespace 'microsoft.insights' for api version '2014-05-01'. The supported api-versions are '2014-04-01,2014-06-01,2015-04-01'." + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-09-01-preview/metricDefinitions_API.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-09-01-preview/metricDefinitions_API.json new file mode 100644 index 000000000000..2036d3b51506 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-09-01-preview/metricDefinitions_API.json @@ -0,0 +1,333 @@ +{ + "swagger": "2.0", + "info": { + "title": "MonitorManagementClient", + "version": "2017-09-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": { + "/{resourceUri}/providers/Microsoft.Insights/metricDefinitions": { + "get": { + "tags": [ + "MetricDefinitions" + ], + "operationId": "MetricDefinitions_List", + "description": "Lists the metric definitions for the resource.", + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request to get the list of metric definitions", + "schema": { + "$ref": "#/definitions/MetricDefinitionCollection" + }, + "examples": { + "application/json": { + "value": [ + { + "id": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest/providers/microsoft.insights/metricdefinitions/CpuTime", + "resourceId": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest", + "name": { + "value": "CpuTime", + "localizedValue": "CPU Time" + }, + "isDimensionRequired": false, + "unit": "Seconds", + "primaryAggregationType": "Total", + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P30D" + }, + { + "timeGrain": "PT1H", + "retention": "P30D" + } + ], + "dimensions": [ + { + "value": "Instance", + "localizedValue": "Instance" + } + ] + }, + { + "id": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest/providers/microsoft.insights/metricdefinitions/MemoryWorkingSet", + "resourceId": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest", + "name": { + "value": "MemoryWorkingSet", + "localizedValue": "Memory working set" + }, + "isDimensionRequired": false, + "unit": "Bytes", + "primaryAggregationType": "Average", + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P30D" + }, + { + "timeGrain": "PT1H", + "retention": "P30D" + } + ], + "dimensions": [ + { + "value": "Instance", + "localizedValue": "Instance" + } + ] + }, + { + "id": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest/providers/microsoft.insights/metricdefinitions/AverageMemoryWorkingSet", + "resourceId": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest", + "name": { + "value": "AverageMemoryWorkingSet", + "localizedValue": "Average memory working set" + }, + "isDimensionRequired": false, + "unit": "Bytes", + "primaryAggregationType": "Average", + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P30D" + }, + { + "timeGrain": "PT1H", + "retention": "P30D" + } + ], + "dimensions": [ + { + "value": "Instance", + "localizedValue": "Instance" + } + ] + } + ] + } + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Get Metric Definitions without filter": { + "$ref": "./examples/GetMetricDefinitions.json" + } + } + } + } + }, + "definitions": { + "LocalizableString": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "string", + "description": "the invariant value." + }, + "localizedValue": { + "type": "string", + "description": "the locale specific value." + } + }, + "description": "The localizable string class." + }, + "MetricAvailability": { + "type": "object", + "properties": { + "timeGrain": { + "type": "string", + "format": "duration", + "description": "the time grain specifies the aggregation interval for the metric. Expressed as a duration 'PT1M', 'P1D', etc." + }, + "retention": { + "type": "string", + "format": "duration", + "description": "the retention period for the metric at the specified timegrain. Expressed as a duration 'PT1M', 'P1D', etc." + } + }, + "description": "Metric availability specifies the time grain (aggregation interval or frequency) and the retention period for that time grain." + }, + "Unit": { + "type": "string", + "description": "the unit of the metric.", + "enum": [ + "Count", + "Bytes", + "Seconds", + "CountPerSecond", + "BytesPerSecond", + "Percent", + "MilliSeconds", + "ByteSeconds", + "Unspecified", + "Cores", + "MilliCores", + "NanoCores", + "BitsPerSecond" + ], + "x-ms-enum": { + "name": "Unit", + "modelAsString": false + } + }, + "AggregationType": { + "type": "string", + "description": "the aggregation type of the metric.", + "enum": [ + "None", + "Average", + "Count", + "Minimum", + "Maximum", + "Total" + ], + "x-ms-enum": { + "name": "AggregationType", + "modelAsString": false + } + }, + "MetricDefinition": { + "type": "object", + "properties": { + "isDimensionRequired": { + "type": "boolean", + "description": "Flag to indicate whether the dimension is required." + }, + "resourceId": { + "type": "string", + "description": "the resource identifier of the resource that emitted the metric." + }, + "name": { + "$ref": "#/definitions/LocalizableString", + "description": "the name and the display name of the metric, i.e. it is a localizable string." + }, + "displayDescription": { + "type": "string", + "description": "Detailed description of this metric." + }, + "unit": { + "$ref": "#/definitions/Unit", + "description": "the unit of the metric." + }, + "primaryAggregationType": { + "$ref": "#/definitions/AggregationType", + "description": "the primary aggregation type value defining how to use the values for display." + }, + "supportedAggregationTypes": { + "type": "array", + "items": { + "$ref": "#/definitions/AggregationType" + }, + "description": "the collection of what aggregation types are supported." + }, + "metricAvailabilities": { + "type": "array", + "items": { + "$ref": "#/definitions/MetricAvailability" + }, + "description": "the collection of what aggregation intervals are available to be queried." + }, + "id": { + "type": "string", + "description": "the resource identifier of the metric definition." + }, + "dimensions": { + "type": "array", + "items": { + "$ref": "#/definitions/LocalizableString" + }, + "description": "the name and the display name of the dimension, i.e. it is a localizable string." + } + }, + "description": "Metric definition class specifies the metadata for a metric." + }, + "MetricDefinitionCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MetricDefinition" + }, + "description": "the values for the metric definitions." + } + }, + "required": [ + "value" + ], + "description": "Represents collection of metric definitions." + }, + "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" + } + } + } + }, + "parameters": { + "ResourceUriParameter": { + "name": "resourceUri", + "in": "path", + "required": true, + "type": "string", + "description": "The identifier of the resource.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-09-01-preview/metrics_API.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-09-01-preview/metrics_API.json new file mode 100644 index 000000000000..8ae2df382fb7 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-09-01-preview/metrics_API.json @@ -0,0 +1,440 @@ +{ + "swagger": "2.0", + "info": { + "title": "MonitorManagementClient", + "version": "2017-09-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": { + "/{resourceUri}/providers/Microsoft.Insights/metrics": { + "get": { + "tags": [ + "Metrics" + ], + "operationId": "Metrics_List", + "description": "**Lists the metric values for a resource**.", + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "#/parameters/TimespanParameter" + }, + { + "$ref": "#/parameters/IntervalParameter" + }, + { + "$ref": "#/parameters/MetricParameter" + }, + { + "$ref": "#/parameters/AggregationsParameter" + }, + { + "$ref": "#/parameters/TopParameter" + }, + { + "$ref": "#/parameters/OrderByParameter" + }, + { + "name": "$filter", + "in": "query", + "type": "string", + "description": "The **$filter** is used to reduce the set of metric data returned.
    Example:
    Metric contains metadata A, B and C.
    - Return all time series of C where A = a1 and B = b1 or b2
    **$filter=A eq ‘a1’ and B eq ‘b1’ or B eq ‘b2’ and C eq ‘*’**
    - Invalid variant:
    **$filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘*’ or B = ‘b2’**
    This is invalid because the logical or operator cannot separate two different metadata names.
    - Return all time series where A = a1, B = b1 and C = c1:
    **$filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘c1’**
    - Return all time series where A = a1
    **$filter=A eq ‘a1’ and B eq ‘*’ and C eq ‘*’**.", + "required": false + }, + { + "$ref": "#/parameters/ResultTypeParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request to get the list of metric values.", + "schema": { + "$ref": "#/definitions/Response" + }, + "examples": { + "application/json": { + "cost": 0, + "timespan": "2017-08-10T21:44:34Z/2017-08-10T22:44:34Z", + "interval": "PT1M", + "value": [ + { + "id": "/subscriptions/07c0b09d-9f69-4e6e-8d05-f59f67299cb2/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/alertruleTest/providers/Microsoft.Insights/metrics/CpuTime", + "type": "Microsoft.Insights/metrics", + "name": { + "value": "CpuTime", + "localizedValue": "CPU Time" + }, + "unit": "Seconds", + "timeseries": [ + { + "metadatavalues": [], + "data": [ + { + "timeStamp": "2017-08-10T21:44:00Z", + "total": 0.0 + }, + { + "timeStamp": "2017-08-10T21:45:00Z", + "total": 0.0 + }, + { + "timeStamp": "2017-08-10T21:46:00Z", + "total": 0.0 + }, + { + "timeStamp": "2017-08-10T21:47:00Z", + "total": 0.0 + }, + { + "timeStamp": "2017-08-10T21:48:00Z", + "total": 0.0 + }, + { + "timeStamp": "2017-08-10T21:49:00Z", + "total": 0.0 + }, + { + "timeStamp": "2017-08-10T21:50:00Z", + "total": 0.0 + } + ] + } + ] + } + ] + } + } + } + }, + "x-ms-odata": "#/definitions/MetadataValue", + "x-ms-examples": { + "Get Metric for data": { + "$ref": "./examples/GetMetric.json" + }, + "Get Metric for metadata": { + "$ref": "./examples/GetMetricMetadata.json" + } + } + } + } + }, + "definitions": { + "LocalizableString": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "string", + "description": "the invariant value." + }, + "localizedValue": { + "type": "string", + "description": "the locale specific value." + } + }, + "description": "The localizable string class." + }, + "Unit": { + "type": "string", + "description": "the unit of the metric.", + "enum": [ + "Count", + "Bytes", + "Seconds", + "CountPerSecond", + "BytesPerSecond", + "Percent", + "MilliSeconds", + "ByteSeconds", + "Unspecified", + "Cores", + "MilliCores", + "NanoCores", + "BitsPerSecond" + ], + "x-ms-enum": { + "name": "Unit", + "modelAsString": false + } + }, + "MetricValue": { + "type": "object", + "required": [ + "timeStamp" + ], + "properties": { + "timeStamp": { + "type": "string", + "format": "date-time", + "description": "the timestamp for the metric value in ISO 8601 format." + }, + "average": { + "type": "number", + "format": "double", + "description": "the average value in the time range." + }, + "minimum": { + "type": "number", + "format": "double", + "description": "the least value in the time range." + }, + "maximum": { + "type": "number", + "format": "double", + "description": "the greatest value in the time range." + }, + "total": { + "type": "number", + "format": "double", + "description": "the sum of all of the values in the time range." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "the number of samples in the time range. Can be used to determine the number of values that contributed to the average value." + } + }, + "description": "Represents a metric value." + }, + "MetadataValue": { + "type": "object", + "properties": { + "name": { + "$ref": "#/definitions/LocalizableString", + "description": "the name of the metadata." + }, + "value": { + "type": "string", + "description": "the value of the metadata." + } + }, + "description": "Represents a metric metadata value." + }, + "Response": { + "type": "object", + "properties": { + "cost": { + "type": "number", + "format": "int32", + "minimum": 0, + "description": "The integer value representing the cost of the query, for data case." + }, + "timespan": { + "type": "string", + "description": "The timespan for which the data was retrieved. Its value consists of two datetimes concatenated, separated by '/'. This may be adjusted in the future and returned back from what was originally requested." + }, + "interval": { + "type": "string", + "format": "duration", + "description": "The interval (window size) for which the metric data was returned in. This may be adjusted in the future and returned back from what was originally requested. This is not present if a metadata request was made." + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Metric" + }, + "description": "the value of the collection." + } + }, + "required": [ + "timespan", + "value" + ], + "description": "The response to a metrics query." + }, + "Metric": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "the metric Id." + }, + "type": { + "type": "string", + "description": "the resource type of the metric resource." + }, + "name": { + "$ref": "#/definitions/LocalizableString", + "description": "the name and the display name of the metric, i.e. it is localizable string." + }, + "displayDescription": { + "type": "string", + "description": "Detailed description of this metric." + }, + "errorCode": { + "type": "string", + "description": "'Success' or the error details on query failures for this metric." + }, + "unit": { + "$ref": "#/definitions/Unit", + "description": "the unit of the metric." + }, + "timeseries": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeSeriesElement" + }, + "description": "the time series returned when a data query is performed." + } + }, + "required": [ + "id", + "type", + "name", + "unit", + "timeseries" + ], + "description": "The result data of a query." + }, + "TimeSeriesElement": { + "type": "object", + "properties": { + "metadatavalues": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataValue" + }, + "description": "the metadata values returned if $filter was specified in the call." + }, + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/MetricValue" + }, + "description": "An array of data points representing the metric values. This is only returned if a result type of data is specified." + } + }, + "description": "A time series result type. The discriminator value is always TimeSeries in this case." + }, + "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" + } + } + } + }, + "parameters": { + "ResourceUriParameter": { + "name": "resourceUri", + "in": "path", + "required": true, + "type": "string", + "description": "The identifier of the resource.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "TimespanParameter": { + "name": "timespan", + "in": "query", + "required": false, + "type": "string", + "description": "The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'.", + "x-ms-parameter-location": "method" + }, + "IntervalParameter": { + "name": "interval", + "in": "query", + "required": false, + "type": "string", + "format": "duration", + "description": "The interval (i.e. timegrain) of the query.", + "x-ms-parameter-location": "method" + }, + "MetricParameter": { + "name": "metric", + "in": "query", + "required": false, + "type": "string", + "description": "The name of the metric to retrieve.", + "x-ms-parameter-location": "method" + }, + "AggregationsParameter": { + "name": "aggregation", + "in": "query", + "required": false, + "type": "string", + "description": "The list of aggregation types (comma separated) to retrieve.", + "x-ms-parameter-location": "method" + }, + "TopParameter": { + "name": "$top", + "in": "query", + "required": false, + "type": "number", + "format": "int32", + "description": "The maximum number of records to retrieve.\nValid only if $filter is specified.\nDefaults to 10.", + "x-ms-parameter-location": "method" + }, + "OrderByParameter": { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "The aggregation to use for sorting results and the direction of the sort.\nOnly one order can be specified.\nExamples: sum asc.", + "x-ms-parameter-location": "method" + }, + "ResultTypeParameter": { + "name": "resultType", + "in": "query", + "type": "string", + "enum": [ + "Data", + "Metadata" + ], + "x-ms-enum": { + "name": "ResultType", + "modelAsString": false + }, + "description": "Reduces the set of data collected. The syntax allowed depends on the operation. See the operation's description for details.", + "x-ms-parameter-location": "method", + "required": false + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-09-01-preview/operations_API.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-09-01-preview/operations_API.json new file mode 100644 index 000000000000..c7a97e26a434 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-09-01-preview/operations_API.json @@ -0,0 +1,308 @@ +{ + "swagger": "2.0", + "info": { + "title": "MonitorManagementClient", + "version": "2017-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Insights/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available operations from Microsoft.Insights provider.", + "operationId": "Operations_List", + "x-ms-examples": { + "Get a list of operations for a resource provider": { + "$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": "BadRequest", + "schema": { + "$ref": "#/definitions/ErrorContract" + } + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Microsoft.Insights operations. It contains a list of operations and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of operations supported by the Microsoft.Insights provider." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "Microsoft Insights API operation definition.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "isDataAction": { + "type": "boolean", + "description": "Property to specify whether the action is a data action." + }, + "display": { + "description": "Display metadata associated with the operation.", + "type": "object", + "properties": { + "publisher": { + "description": "The publisher of this operation.", + "type": "string" + }, + "provider": { + "description": "Service provider: Microsoft.Insights", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed: AlertRules, Autoscale, etc.", + "type": "string" + }, + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "type": "string" + }, + "description": { + "description": "The description of the operation.", + "type": "string" + } + } + }, + "properties": { + "description": "Properties of operation, include metric specifications.", + "x-ms-client-flatten": true, + "x-ms-client-name": "OperationProperties", + "$ref": "#/definitions/OperationProperties" + } + } + }, + "OperationProperties": { + "description": "Properties of operation, include metric specifications.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "One property of operation, include metric specifications." + } + } + }, + "ServiceSpecification": { + "description": "One property of operation, include log specifications.", + "type": "object", + "properties": { + "logSpecifications": { + "description": "Log specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + } + }, + "metricSpecifications": { + "description": "Metric specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + } + }, + "legacyMetricSpecifications": { + "description": "Legacy Metric specifications for operation. Deprecated, do not use.", + "type": "object" + } + } + }, + "LogSpecification": { + "description": "Log specification of operation.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of log specification." + }, + "displayName": { + "type": "string", + "description": "Display name of log specification." + }, + "blobDuration": { + "type": "string", + "description": "Blob duration of specification." + } + } + }, + "MetricSpecification": { + "description": "Metric specification of operation.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the metric." + }, + "displayName": { + "type": "string", + "description": "Display name of the metric." + }, + "displayDescription": { + "type": "string", + "description": "Display description of the metric." + }, + "unit": { + "type": "string", + "description": "The metric unit. Possible values include: Count,Bytes,Seconds,Percent,CountPerSecond,BytesPerSecond,MilliSeconds,ByteSeconds,Unspecified,BitsPerSecond,Cores,MilliCores,NanoCores" + }, + "aggregationType": { + "type": "string", + "description": "The default metric aggregation type. Possible values include: Total,Average,Maximum,Minimum,Count" + }, + "supportedAggregationTypes": { + "type": "array", + "description": "The supported aggregation types for the metrics.", + "items": { + "type": "string" + } + }, + "supportedTimeGrainTypes": { + "type": "array", + "description": "The supported time grain types for the metrics.", + "items": { + "type": "string" + } + }, + "availabilities": { + "type": "array", + "description": "The supported time grain types for the metrics.", + "items": { + "type": "string" + } + }, + "lockAggregationType": { + "type": "string", + "description": "The metric lock aggregation type." + }, + "category": { + "type": "string", + "description": "Category or type of metric." + }, + "dimensions": { + "type": "array", + "description": "The dimensions of metric.", + "items": { + "$ref": "#/definitions/DimensionProperties" + } + }, + "fillGapWithZero": { + "type": "boolean", + "description": "Property to specify whether to fill empty gaps with zero." + }, + "internalMetricName": { + "type": "string", + "description": "The internal metric name." + } + } + }, + "DimensionProperties": { + "description": "Type of operation: get, read, delete, etc.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of dimension." + }, + "displayName": { + "type": "string", + "description": "Display name of dimension." + }, + "toBeExportedForShoebox": { + "type": "boolean", + "description": "Legacy usage, should not set." + }, + "isHidden": { + "type": "boolean", + "description": "When set, the dimension is hidden from the customer, used in conjunction with the defaultDimensionValues field below" + }, + "defaultDimensionValues": { + "type": "object", + "description": "Default dimension value to be sent down for the hidden dimension during query" + } + } + }, + "ErrorContract": { + "title": "Error Response", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)", + "type": "object", + "properties": { + "error": { + "description": "The error object.", + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "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" + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json index 37567b416cb7..1b999fa03926 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json @@ -2,9 +2,6 @@ "swagger": "2.0", "info": { "title": "MonitorManagementClient", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - }, "version": "2017-12-01-preview" }, "host": "management.azure.com", @@ -99,7 +96,7 @@ ], "x-ms-enum": { "name": "NamespaceClassification", - "modelAsString": false + "modelAsString": true } }, "MetricNamespace": { diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/examples/createOrUpdateScheduledQueryRule.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/examples/createOrUpdateScheduledQueryRule.json index a5f4a76a85e9..46f077b903c0 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/examples/createOrUpdateScheduledQueryRule.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/examples/createOrUpdateScheduledQueryRule.json @@ -5,7 +5,7 @@ "ruleName": "perf", "api-version": "2021-02-01-preview", "parameters": { - "location": "Global", + "location": "eastus", "properties": { "description": "Performance rule", "severity": 4, @@ -48,15 +48,18 @@ ] }, "muteActionsDuration": "PT30M", - "actions": [ - { - "actionGroupId": "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup", - "webHookProperties": { - "key11": "value11", - "key12": "value12" - } + "actions": { + "actionGroups": [ + "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup" + ], + "customProperties": { + "key11": "value11", + "key12": "value12" } - ] + }, + "autoMitigate": true, + "checkWorkspaceAlertsStorageConfigured": true, + "skipQueryValidation": true } } }, @@ -67,7 +70,7 @@ "id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/perf", "name": "perf", "type": "microsoft.insights/scheduledqueryrules", - "location": "Global", + "location": "eastus", "tags": {}, "properties": { "description": "Performance rule", @@ -111,15 +114,19 @@ ] }, "muteActionsDuration": "PT30M", - "actions": [ - { - "actionGroupId": "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup", - "webHookProperties": { - "key11": "value11", - "key12": "value12" - } + "actions": { + "actionGroups": [ + "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup" + ], + "customProperties": { + "key11": "value11", + "key12": "value12" } - ] + }, + "autoMitigate": true, + "isWorkspaceAlertsStorageConfigured": true, + "checkWorkspaceAlertsStorageConfigured": true, + "skipQueryValidation": true } } }, @@ -129,7 +136,7 @@ "id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/perf", "name": "perf", "type": "microsoft.insights/scheduledqueryrules", - "location": "Global", + "location": "eastus", "tags": {}, "properties": { "description": "Performance rule", @@ -173,15 +180,19 @@ ] }, "muteActionsDuration": "PT30M", - "actions": [ - { - "actionGroupId": "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup", - "webHookProperties": { - "key11": "value11", - "key12": "value12" - } + "actions": { + "actionGroups": [ + "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup" + ], + "customProperties": { + "key11": "value11", + "key12": "value12" } - ] + }, + "autoMitigate": true, + "isWorkspaceAlertsStorageConfigured": true, + "checkWorkspaceAlertsStorageConfigured": true, + "skipQueryValidation": true } } } diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/examples/createOrUpdateScheduledQueryRuleResourceGroup.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/examples/createOrUpdateScheduledQueryRuleResourceGroup.json index 808247601259..84a5638a36ec 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/examples/createOrUpdateScheduledQueryRuleResourceGroup.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/examples/createOrUpdateScheduledQueryRuleResourceGroup.json @@ -5,7 +5,7 @@ "ruleName": "heartbeat", "api-version": "2021-02-01-preview", "parameters": { - "location": "Global", + "location": "eastus", "properties": { "description": "Health check rule", "severity": 4, @@ -34,15 +34,18 @@ ] }, "muteActionsDuration": "PT30M", - "actions": [ - { - "actionGroupId": "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup", - "webHookProperties": { - "key11": "value11", - "key12": "value12" - } + "actions": { + "actionGroups": [ + "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup" + ], + "customProperties": { + "key11": "value11", + "key12": "value12" } - ] + }, + "autoMitigate": true, + "checkWorkspaceAlertsStorageConfigured": true, + "skipQueryValidation": true } } }, @@ -53,7 +56,7 @@ "id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/heartbeat", "name": "heartbeat", "type": "microsoft.insights/scheduledqueryrules", - "location": "Global", + "location": "eastus", "tags": {}, "properties": { "description": "Health check rule", @@ -83,15 +86,19 @@ ] }, "muteActionsDuration": "PT30M", - "actions": [ - { - "actionGroupId": "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup", - "webHookProperties": { - "key11": "value11", - "key12": "value12" - } + "actions": { + "actionGroups": [ + "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup" + ], + "customProperties": { + "key11": "value11", + "key12": "value12" } - ] + }, + "autoMitigate": true, + "isWorkspaceAlertsStorageConfigured": true, + "checkWorkspaceAlertsStorageConfigured": true, + "skipQueryValidation": true } } }, @@ -131,15 +138,19 @@ ] }, "muteActionsDuration": "PT30M", - "actions": [ - { - "actionGroupId": "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup", - "webHookProperties": { - "key11": "value11", - "key12": "value12" - } + "actions": { + "actionGroups": [ + "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup" + ], + "customProperties": { + "key11": "value11", + "key12": "value12" } - ] + }, + "autoMitigate": true, + "isWorkspaceAlertsStorageConfigured": true, + "checkWorkspaceAlertsStorageConfigured": true, + "skipQueryValidation": true } } } diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/examples/createOrUpdateScheduledQueryRuleSubscription.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/examples/createOrUpdateScheduledQueryRuleSubscription.json index bd3bfab4d0d7..3b1c6ea8345f 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/examples/createOrUpdateScheduledQueryRuleSubscription.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/examples/createOrUpdateScheduledQueryRuleSubscription.json @@ -5,7 +5,7 @@ "ruleName": "perf", "api-version": "2021-02-01-preview", "parameters": { - "location": "Global", + "location": "eastus", "properties": { "description": "Performance rule", "severity": 4, @@ -51,15 +51,18 @@ ] }, "muteActionsDuration": "PT30M", - "actions": [ - { - "actionGroupId": "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup", - "webHookProperties": { - "key11": "value11", - "key12": "value12" - } + "actions": { + "actionGroups": [ + "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup" + ], + "customProperties": { + "key11": "value11", + "key12": "value12" } - ] + }, + "autoMitigate": true, + "checkWorkspaceAlertsStorageConfigured": true, + "skipQueryValidation": true } } }, @@ -70,7 +73,7 @@ "id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/perf", "name": "perf", "type": "microsoft.insights/scheduledqueryrules", - "location": "Global", + "location": "eastus", "tags": {}, "properties": { "description": "Performance rule", @@ -117,15 +120,19 @@ ] }, "muteActionsDuration": "PT30M", - "actions": [ - { - "actionGroupId": "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup", - "webHookProperties": { - "key11": "value11", - "key12": "value12" - } + "actions": { + "actionGroups": [ + "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup" + ], + "customProperties": { + "key11": "value11", + "key12": "value12" } - ] + }, + "autoMitigate": true, + "isWorkspaceAlertsStorageConfigured": true, + "checkWorkspaceAlertsStorageConfigured": true, + "skipQueryValidation": true } } }, @@ -135,7 +142,7 @@ "id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/perf", "name": "perf", "type": "microsoft.insights/scheduledqueryrules", - "location": "Global", + "location": "eastus", "tags": {}, "properties": { "description": "Performance rule", @@ -182,15 +189,19 @@ ] }, "muteActionsDuration": "PT30M", - "actions": [ - { - "actionGroupId": "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup", - "webHookProperties": { - "key11": "value11", - "key12": "value12" - } + "actions": { + "actionGroups": [ + "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup" + ], + "customProperties": { + "key11": "value11", + "key12": "value12" } - ] + }, + "autoMitigate": true, + "isWorkspaceAlertsStorageConfigured": true, + "checkWorkspaceAlertsStorageConfigured": true, + "skipQueryValidation": true } } } diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/examples/getScheduledQueryRule.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/examples/getScheduledQueryRule.json index 01d24ea4ae94..c063745b8bc0 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/examples/getScheduledQueryRule.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/examples/getScheduledQueryRule.json @@ -12,7 +12,7 @@ "id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/perf", "name": "perf", "type": "microsoft.insights/scheduledqueryrules", - "location": "Global", + "location": "eastus", "tags": {}, "properties": { "description": "Performance rule", @@ -56,15 +56,19 @@ ] }, "muteActionsDuration": "PT30M", - "actions": [ - { - "actionGroupId": "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup", - "webHookProperties": { - "key11": "value11", - "key12": "value12" - } + "actions": { + "actionGroups": [ + "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup" + ], + "customProperties": { + "key11": "value11", + "key12": "value12" } - ] + }, + "autoMitigate": true, + "isWorkspaceAlertsStorageConfigured": true, + "checkWorkspaceAlertsStorageConfigured": true, + "skipQueryValidation": true } } } diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/examples/listScheduledQueryRulesByResourceGroup.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/examples/listScheduledQueryRulesByResourceGroup.json index 03b6e2d84f36..bb814ab98ac8 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/examples/listScheduledQueryRulesByResourceGroup.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/examples/listScheduledQueryRulesByResourceGroup.json @@ -13,7 +13,7 @@ "id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/perf", "name": "perf", "type": "microsoft.insights/scheduledqueryrules", - "location": "Global", + "location": "eastus", "tags": {}, "properties": { "description": "Performance rule", @@ -60,22 +60,26 @@ ] }, "muteActionsDuration": "PT30M", - "actions": [ - { - "actionGroupId": "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup", - "webHookProperties": { - "key11": "value11", - "key12": "value12" - } + "actions": { + "actionGroups": [ + "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup" + ], + "customProperties": { + "key11": "value11", + "key12": "value12" } - ] + }, + "autoMitigate": true, + "isWorkspaceAlertsStorageConfigured": true, + "checkWorkspaceAlertsStorageConfigured": true, + "skipQueryValidation": true } }, { "id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/heartbeat", "name": "heartbeat", "type": "microsoft.insights/scheduledqueryrules", - "location": "Global", + "location": "eastus", "tags": {}, "properties": { "description": "Health check rule", @@ -105,15 +109,19 @@ ] }, "muteActionsDuration": "PT30M", - "actions": [ - { - "actionGroupId": "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup", - "webHookProperties": { - "key11": "value11", - "key12": "value12" - } + "actions": { + "actionGroups": [ + "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup" + ], + "customProperties": { + "key11": "value11", + "key12": "value12" } - ] + }, + "autoMitigate": true, + "isWorkspaceAlertsStorageConfigured": true, + "checkWorkspaceAlertsStorageConfigured": true, + "skipQueryValidation": true } } ] diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/examples/listScheduledQueryRulesBySubscription.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/examples/listScheduledQueryRulesBySubscription.json index 16dacf228515..c996ce915607 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/examples/listScheduledQueryRulesBySubscription.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/examples/listScheduledQueryRulesBySubscription.json @@ -12,7 +12,7 @@ "id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/perf", "name": "perf", "type": "microsoft.insights/scheduledqueryrules", - "location": "Global", + "location": "eastus", "tags": {}, "properties": { "description": "Performance rule", @@ -59,22 +59,26 @@ ] }, "muteActionsDuration": "PT30M", - "actions": [ - { - "actionGroupId": "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup", - "webHookProperties": { - "key11": "value11", - "key12": "value12" - } + "actions": { + "actionGroups": [ + "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup" + ], + "customProperties": { + "key11": "value11", + "key12": "value12" } - ] + }, + "autoMitigate": true, + "isWorkspaceAlertsStorageConfigured": true, + "checkWorkspaceAlertsStorageConfigured": true, + "skipQueryValidation": true } }, { "id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/MyResourceGroupName2/providers/microsoft.insights/scheduledqueryrules/heartbeat", "name": "heartbeat", "type": "microsoft.insights/scheduledqueryrules", - "location": "Global", + "location": "eastus", "tags": {}, "properties": { "description": "Health check rule", @@ -104,15 +108,19 @@ ] }, "muteActionsDuration": "PT30M", - "actions": [ - { - "actionGroupId": "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup", - "webHookProperties": { - "key11": "value11", - "key12": "value12" - } + "actions": { + "actionGroups": [ + "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup" + ], + "customProperties": { + "key11": "value11", + "key12": "value12" } - ] + }, + "autoMitigate": true, + "isWorkspaceAlertsStorageConfigured": true, + "checkWorkspaceAlertsStorageConfigured": true, + "skipQueryValidation": true } } ] diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/examples/patchScheduledQueryRule.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/examples/patchScheduledQueryRule.json index 8d7dd8d59bb8..504697bb4e04 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/examples/patchScheduledQueryRule.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/examples/patchScheduledQueryRule.json @@ -17,7 +17,7 @@ "id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/heartbeat", "name": "heartbeat", "type": "microsoft.insights/scheduledqueryrules", - "location": "Global", + "location": "eastus", "tags": {}, "properties": { "description": "Health check rule", @@ -47,15 +47,19 @@ ] }, "muteActionsDuration": "PT30M", - "actions": [ - { - "actionGroupId": "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup", - "webHookProperties": { - "key11": "value11", - "key12": "value12" - } + "actions": { + "actionGroups": [ + "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup" + ], + "customProperties": { + "key11": "value11", + "key12": "value12" } - ] + }, + "autoMitigate": true, + "isWorkspaceAlertsStorageConfigured": true, + "checkWorkspaceAlertsStorageConfigured": true, + "skipQueryValidation": true } } } diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/scheduledQueryRule_API.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/scheduledQueryRule_API.json index 13e7d9b71576..67dcfbd16ce3 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/scheduledQueryRule_API.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-02-01-preview/scheduledQueryRule_API.json @@ -309,25 +309,29 @@ } }, "definitions": { - "Action": { + "Actions": { "type": "object", "description": "Actions to invoke when the alert fires.", "properties": { - "actionGroupId": { - "type": "string", - "description": "Action Group resource Id to invoke when the alert fires." + "actionGroups": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Action Group resource Ids to invoke when the alert fires." }, - "webHookProperties": { + "customProperties": { "type": "object", "additionalProperties": { "type": "string", - "description": "The dictionary of custom properties to include with the post operation. These data are appended to the webhook payload." + "description": "The dictionary of custom properties to include with the post operation. These data are appended to the alert payload." }, - "description": "The properties of a webhook object." + "description": "The properties of an alert payload." } } }, "ScheduledQueryRuleProperties": { + "type": "object", "properties": { "createdWithApiVersion": { "type": "string", @@ -405,9 +409,9 @@ "description": "Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired. Relevant only for rules of the kind LogAlert." }, "actions": { - "type": "array", + "type": "object", "items": { - "$ref": "#/definitions/Action" + "$ref": "#/definitions/Actions" }, "description": "Actions to invoke when the alert fires." }, @@ -481,6 +485,7 @@ "type": "object", "properties": { "tags": { + "type": "object", "additionalProperties": { "type": "string" }, @@ -495,6 +500,7 @@ "description": "The scheduled query rule resource for patch operations." }, "ScheduledQueryRuleResourceCollection": { + "type": "object", "properties": { "value": { "type": "array", @@ -599,12 +605,7 @@ "type": "string", "description": "The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric." } - }, - "required": [ - "operator", - "threshold", - "timeAggregation" - ] + } }, "Dimension": { "type": "object", diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettingsCategories_API.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettingsCategories_API.json new file mode 100644 index 000000000000..fc6a5a6514ae --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettingsCategories_API.json @@ -0,0 +1,214 @@ +{ + "swagger": "2.0", + "info": { + "title": "MonitorManagementClient", + "x-ms-code-generation-settings": { + "name": "MonitorManagementClient" + }, + "version": "2021-05-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": { + "/{resourceUri}/providers/Microsoft.Insights/diagnosticSettingsCategories/{name}": { + "get": { + "tags": [ + "DiagnosticSettingsCategories" + ], + "operationId": "DiagnosticSettingsCategory_Get", + "description": "Gets the diagnostic settings category for the specified resource.", + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/NameParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request to get more information about diagnostic setting category", + "schema": { + "$ref": "#/definitions/DiagnosticSettingsCategoryResource" + } + } + }, + "x-ms-examples": { + "Gets the diagnostic setting": { + "$ref": "./examples/getDiagnosticSettingsCategory.json" + } + } + } + }, + "/{resourceUri}/providers/Microsoft.Insights/diagnosticSettingsCategories": { + "get": { + "tags": [ + "DiagnosticSettingsCategories" + ], + "operationId": "DiagnosticSettingsCategory_List", + "description": "Lists the diagnostic settings categories for the specified resource.", + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request to get more information about diagnostic setting category", + "schema": { + "$ref": "#/definitions/DiagnosticSettingsCategoryResourceCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Gets the diagnostic setting": { + "$ref": "./examples/listDiagnosticSettingsCategories.json" + } + } + } + } + }, + "definitions": { + "DiagnosticSettingsCategory": { + "type": "object", + "readOnly": true, + "properties": { + "categoryType": { + "enum": [ + "Metrics", + "Logs" + ], + "type": "string", + "x-ms-enum": { + "name": "categoryType", + "modelAsString": true + }, + "x-nullable": false, + "description": "The type of the diagnostic settings category." + }, + "categoryGroups": { + "type": "array", + "items": { + "type": "string" + }, + "description": "the collection of what category groups are supported." + } + }, + "description": "The diagnostic settings Category." + }, + "DiagnosticSettingsCategoryResource": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DiagnosticSettingsCategory", + "description": "The properties of a Diagnostic Settings Category." + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "description": "The diagnostic settings category resource." + }, + "DiagnosticSettingsCategoryResourceCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnosticSettingsCategoryResource" + }, + "description": "The collection of diagnostic settings category resources." + } + }, + "description": "Represents a collection of diagnostic setting category resources." + }, + "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" + } + } + } + }, + "parameters": { + "ResourceUriParameter": { + "name": "resourceUri", + "in": "path", + "required": true, + "type": "string", + "description": "The identifier of the resource.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "NameParameter": { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the diagnostic setting.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettings_API.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettings_API.json new file mode 100644 index 000000000000..5489b5fb0239 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettings_API.json @@ -0,0 +1,389 @@ +{ + "swagger": "2.0", + "info": { + "title": "MonitorManagementClient", + "x-ms-code-generation-settings": { + "name": "MonitorManagementClient" + }, + "version": "2021-05-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": { + "/{resourceUri}/providers/Microsoft.Insights/diagnosticSettings/{name}": { + "get": { + "tags": [ + "DiagnosticSettings" + ], + "operationId": "DiagnosticSettings_Get", + "description": "Gets the active diagnostic settings for the specified resource.", + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/NameParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request to get more information about diagnostic setting", + "schema": { + "$ref": "#/definitions/DiagnosticSettingsResource" + } + } + }, + "x-ms-examples": { + "Gets the diagnostic setting": { + "$ref": "./examples/getDiagnosticSetting.json" + } + } + }, + "put": { + "tags": [ + "DiagnosticSettings" + ], + "operationId": "DiagnosticSettings_CreateOrUpdate", + "description": "Creates or updates diagnostic settings for the specified resource.", + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DiagnosticSettingsResource" + }, + "description": "Parameters supplied to the operation." + }, + { + "$ref": "#/parameters/NameParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request to create a diagnostic setting", + "schema": { + "$ref": "#/definitions/DiagnosticSettingsResource" + } + } + }, + "x-ms-examples": { + "Creates or Updates the diagnostic setting": { + "$ref": "./examples/createOrUpdateDiagnosticSetting.json" + } + } + }, + "delete": { + "tags": [ + "DiagnosticSettings" + ], + "operationId": "DiagnosticSettings_Delete", + "description": "Deletes existing diagnostic settings for the specified resource.", + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/NameParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request to remove a diagnostic setting" + }, + "204": { + "description": "Successful request to remove a diagnostic setting" + } + }, + "x-ms-examples": { + "Deletes the diagnostic setting": { + "$ref": "./examples/deleteDiagnosticSetting.json" + } + } + } + }, + "/{resourceUri}/providers/Microsoft.Insights/diagnosticSettings": { + "get": { + "tags": [ + "DiagnosticSettings" + ], + "operationId": "DiagnosticSettings_List", + "description": "Gets the active diagnostic settings list for the specified resource.", + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request to get more information about diagnostic setting", + "schema": { + "$ref": "#/definitions/DiagnosticSettingsResourceCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Gets the diagnostic setting": { + "$ref": "./examples/listDiagnosticSettings.json" + } + } + } + } + }, + "definitions": { + "RetentionPolicy": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "a value indicating whether the retention policy is enabled." + }, + "days": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "the number of days for the retention in days. A value of 0 will retain the events indefinitely." + } + }, + "required": [ + "enabled", + "days" + ], + "description": "Specifies the retention policy for the log." + }, + "MetricSettings": { + "type": "object", + "properties": { + "timeGrain": { + "type": "string", + "format": "duration", + "description": "the timegrain of the metric in ISO8601 format." + }, + "category": { + "type": "string", + "description": "Name of a Diagnostic Metric category for a resource type this setting is applied to. To obtain the list of Diagnostic metric categories for a resource, first perform a GET diagnostic settings operation." + }, + "enabled": { + "type": "boolean", + "description": "a value indicating whether this category is enabled." + }, + "retentionPolicy": { + "$ref": "#/definitions/RetentionPolicy", + "description": "the retention policy for this category." + } + }, + "required": [ + "enabled" + ], + "description": "Part of MultiTenantDiagnosticSettings. Specifies the settings for a particular metric." + }, + "LogSettings": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "Name of a Diagnostic Log category for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation." + }, + "categoryGroup": { + "type": "string", + "description": "Name of a Diagnostic Log category group for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation." + }, + "enabled": { + "type": "boolean", + "description": "a value indicating whether this log is enabled." + }, + "retentionPolicy": { + "$ref": "#/definitions/RetentionPolicy", + "description": "the retention policy for this log." + } + }, + "required": [ + "enabled" + ], + "description": "Part of MultiTenantDiagnosticSettings. Specifies the settings for a particular log." + }, + "DiagnosticSettings": { + "type": "object", + "properties": { + "storageAccountId": { + "type": "string", + "description": "The resource ID of the storage account to which you would like to send Diagnostic Logs." + }, + "serviceBusRuleId": { + "type": "string", + "description": "The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility." + }, + "eventHubAuthorizationRuleId": { + "type": "string", + "description": "The resource Id for the event hub authorization rule." + }, + "eventHubName": { + "type": "string", + "description": "The name of the event hub. If none is specified, the default event hub will be selected." + }, + "metrics": { + "type": "array", + "items": { + "$ref": "#/definitions/MetricSettings" + }, + "description": "The list of metric settings." + }, + "logs": { + "type": "array", + "items": { + "$ref": "#/definitions/LogSettings" + }, + "description": "The list of logs settings." + }, + "workspaceId": { + "type": "string", + "description": "The full ARM resource ID of the Log Analytics workspace to which you would like to send Diagnostic Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2" + }, + "marketplacePartnerId": { + "type": "string", + "description": "The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic Logs." + }, + "logAnalyticsDestinationType": { + "type": "string", + "description": "A string indicating whether the export to Log Analytics should use the default destination type, i.e. AzureDiagnostics, or use a destination type constructed as follows: _. Possible values are: Dedicated and null (null is default.)" + } + }, + "description": "The diagnostic settings." + }, + "DiagnosticSettingsResource": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DiagnosticSettings", + "description": "Properties of a Diagnostic Settings Resource." + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "description": "The diagnostic setting resource." + }, + "DiagnosticSettingsResourceCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnosticSettingsResource" + }, + "description": "The collection of diagnostic settings resources;." + } + }, + "description": "Represents a collection of alert rule resources." + }, + "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" + } + } + } + }, + "parameters": { + "ResourceUriParameter": { + "name": "resourceUri", + "in": "path", + "required": true, + "type": "string", + "description": "The identifier of the resource.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "NameParameter": { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the diagnostic setting.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/createOrUpdateDiagnosticSetting.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/createOrUpdateDiagnosticSetting.json new file mode 100644 index 000000000000..1022a325dc80 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/createOrUpdateDiagnosticSetting.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "resourceUri": "subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6", + "name": "mysetting", + "api-version": "2021-05-01-preview", + "parameters": { + "properties": { + "storageAccountId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1", + "workspaceId": "", + "eventHubAuthorizationRuleId": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/eventhubs/myeventhub/authorizationrules/myrule", + "eventHubName": "myeventhub", + "marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1", + "metrics": [ + { + "category": "WorkflowMetrics", + "enabled": true, + "retentionPolicy": { + "enabled": false, + "days": 0 + } + } + ], + "logs": [ + { + "categoryGroup": "allLogs", + "enabled": true, + "retentionPolicy": { + "enabled": false, + "days": 0 + } + } + ], + "logAnalyticsDestinationType": "Dedicated" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/microsoft.insights/diagnosticSettings/mysetting", + "type": "Microsoft.Insights/diagnosticSettings", + "name": "mysetting", + "properties": { + "storageAccountId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1", + "workspaceId": "", + "eventHubAuthorizationRuleId": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/eventhubs/myeventhub/authorizationrules/myrule", + "eventHubName": "myeventhub", + "marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1", + "metrics": [ + { + "category": "WorkflowMetrics", + "enabled": true, + "retentionPolicy": { + "enabled": false, + "days": 0 + } + } + ], + "logs": [ + { + "categoryGroup": "allLogs", + "enabled": true, + "retentionPolicy": { + "enabled": false, + "days": 0 + } + } + ], + "logAnalyticsDestinationType": "Dedicated" + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/createOrUpdateManagementGroupDiagnosticSetting.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/createOrUpdateManagementGroupDiagnosticSetting.json new file mode 100644 index 000000000000..f961d14f7cb4 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/createOrUpdateManagementGroupDiagnosticSetting.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "managementGroupId": "testChildMG7", + "name": "setting1", + "api-version": "2021-05-01-preview", + "parameters": { + "properties": { + "storageAccountId": "/subscriptions/bfaef57f-297e-4210-bfe5-27c18cc671f7/resourceGroups/FuncAppRunners/providers/Microsoft.Storage/storageAccounts/testpersonalb6a5", + "workspaceId": "/subscriptions/9cf7cc0a-0ba1-4624-bc82-97e1ee25dc45/resourceGroups/mgTest/providers/Microsoft.OperationalInsights/workspaces/mgTestWorkspace", + "eventHubAuthorizationRuleId": "/subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/eventhubs/myeventhub/authorizationrules/myrule", + "eventHubName": "myeventhub", + "marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1", + "logs": [ + { + "categoryGroup": "allLogs", + "enabled": true + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "providers/Microsoft.Management/managementGroups/testChildMG7/providers/microsoft.insights/diagnosticSettings/setting1", + "type": "Microsoft.Insights/diagnosticSettings", + "name": "setting1", + "properties": { + "storageAccountId": "/subscriptions/bfaef57f-297e-4210-bfe5-27c18cc671f7/resourceGroups/FuncAppRunners/providers/Microsoft.Storage/storageAccounts/testpersonalb6a5", + "workspaceId": "/subscriptions/9cf7cc0a-0ba1-4624-bc82-97e1ee25dc45/resourceGroups/mgTest/providers/Microsoft.OperationalInsights/workspaces/mgTestWorkspace", + "eventHubAuthorizationRuleId": "/subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/eventhubs/myeventhub/authorizationrules/myrule", + "marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1", + "logs": [ + { + "categoryGroup": "allLogs", + "enabled": true + } + ] + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/createOrUpdateSubscriptionDiagnosticSetting.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/createOrUpdateSubscriptionDiagnosticSetting.json new file mode 100644 index 000000000000..b89c868e139d --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/createOrUpdateSubscriptionDiagnosticSetting.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "fb9f25f9-5785-4510-a38f-a62f188eb9f8", + "name": "ds4", + "api-version": "2021-05-01-preview", + "parameters": { + "properties": { + "storageAccountId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1", + "workspaceId": "", + "eventHubAuthorizationRuleId": "/subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/eventhubs/myeventhub/authorizationrules/myrule", + "eventHubName": "myeventhub", + "marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1", + "logs": [ + { + "categoryGroup": "allLogs", + "enabled": true + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/providers/AzureResourceManager/diagnosticSettings/ds4", + "type": null, + "name": "ds4", + "properties": { + "storageAccountId": "/subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1", + "workspaceId": "/subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/resourceGroups/apptest/providers/Microsoft.OperationalInsights/workspaces/test1", + "eventHubAuthorizationRuleId": "/subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/resourceGroups/apptest/providers/microsoft.eventhub/namespaces/mynamespace/eventhubs/myeventhub/authorizationrules/myrule", + "marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1", + "logs": [ + { + "categoryGroup": "allLogs", + "enabled": true + } + ] + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/deleteDiagnosticSetting.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/deleteDiagnosticSetting.json new file mode 100644 index 000000000000..f77441e780c5 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/deleteDiagnosticSetting.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "resourceUri": "subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6", + "name": "mysetting", + "api-version": "2021-05-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/deleteManagementGroupDiagnosticSetting.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/deleteManagementGroupDiagnosticSetting.json new file mode 100644 index 000000000000..79a132233a49 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/deleteManagementGroupDiagnosticSetting.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "managementGroupId": "testChildMG7", + "name": "setting1", + "api-version": "2021-05-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/deleteSubscriptionDiagnosticSetting.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/deleteSubscriptionDiagnosticSetting.json new file mode 100644 index 000000000000..2c4f55cd0698 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/deleteSubscriptionDiagnosticSetting.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "1a66ce04-b633-4a0b-b2bc-a912ec8986a6", + "name": "ds4", + "api-version": "2021-05-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/getDiagnosticSetting.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/getDiagnosticSetting.json new file mode 100644 index 000000000000..d7df66a37f98 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/getDiagnosticSetting.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "resourceUri": "subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6", + "name": "mysetting", + "api-version": "2021-05-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/microsoft.insights/diagnosticSettings/mysetting", + "type": "Microsoft.Insights/diagnosticSettings", + "name": "mysetting", + "properties": { + "storageAccountId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1", + "workspaceId": "", + "eventHubAuthorizationRuleId": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/eventhubs/myeventhub/authorizationrules/myrule", + "marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1", + "metrics": [ + { + "category": "WorkflowMetrics", + "enabled": true, + "retentionPolicy": { + "enabled": false, + "days": 0 + } + } + ], + "logs": [ + { + "categoryGroup": "allLogs", + "enabled": true, + "retentionPolicy": { + "enabled": false, + "days": 0 + } + } + ] + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/getDiagnosticSettingsCategory.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/getDiagnosticSettingsCategory.json new file mode 100644 index 000000000000..5541e880348d --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/getDiagnosticSettingsCategory.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "resourceUri": "subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6", + "name": "WorkflowRuntime", + "api-version": "2021-05-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/microsoft.insights/diagnosticSettingsCategories/WorkflowRuntime", + "type": "microsoft.insights/diagnosticSettingsCategories", + "name": "WorkflowRuntime", + "properties": { + "categoryType": "Logs", + "categoryGroups": [ + "allLogs" + ] + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/getManagementGroupDiagnosticSetting.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/getManagementGroupDiagnosticSetting.json new file mode 100644 index 000000000000..79c5ccbe2bfe --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/getManagementGroupDiagnosticSetting.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "managementGroupId": "testChildMG7", + "name": "setting1", + "api-version": "2021-05-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "providers/Microsoft.Management/managementGroups/testChildMG7/providers/Microsoft.Insights/diagnosticSettings/setting1", + "type": "Microsoft.Insights/diagnosticSettings", + "name": "setting1", + "properties": { + "storageAccountId": "/subscriptions/bfaef57f-297e-4210-bfe5-27c18cc671f7/resourceGroups/FuncAppRunners/providers/Microsoft.Storage/storageAccounts/testpersonalb6a5", + "workspaceId": "/subscriptions/9cf7cc0a-0ba1-4624-bc82-97e1ee25dc45/resourceGroups/mgTest/providers/Microsoft.OperationalInsights/workspaces/mgTestWorkspace", + "eventHubAuthorizationRuleId": "/subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/eventhubs/myeventhub/authorizationrules/myrule", + "marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1", + "logs": [ + { + "categoryGroup": "allLogs", + "enabled": true + } + ] + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/getSubscriptionDiagnosticSetting.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/getSubscriptionDiagnosticSetting.json new file mode 100644 index 000000000000..3b43082b6a16 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/getSubscriptionDiagnosticSetting.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "fb9f25f9-5785-4510-a38f-a62f188eb9f8", + "name": "mysetting", + "api-version": "2021-05-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/providers/AzureResourceManager/diagnosticSettings/ds4", + "type": null, + "name": "ds4", + "properties": { + "storageAccountId": "/subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1", + "workspaceId": "/subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/resourceGroups/apptest/providers/Microsoft.OperationalInsights/workspaces/test1", + "eventHubAuthorizationRuleId": "/subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/resourceGroups/apptest/providers/microsoft.eventhub/namespaces/mynamespace/eventhubs/myeventhub/authorizationrules/myrule", + "marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1", + "logs": [ + { + "categoryGroup": "allLogs", + "enabled": true + } + ] + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/listDiagnosticSettings.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/listDiagnosticSettings.json new file mode 100644 index 000000000000..4c2174d3335c --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/listDiagnosticSettings.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "resourceUri": "subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6", + "api-version": "2021-05-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/microsoft.insights/diagnosticSettings/mysetting", + "type": "Microsoft.Insights/diagnosticSettings", + "name": "mysetting", + "properties": { + "storageAccountId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1", + "eventHubAuthorizationRuleId": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/andy1101/providers/Microsoft.EventHub/namespaces/andy1101/authorizationrules/RootManageSharedAccessKey", + "workspaceId": "", + "marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1", + "metrics": [ + { + "category": "WorkflowMetrics", + "enabled": true, + "retentionPolicy": { + "enabled": false, + "days": 0 + } + } + ], + "logs": [ + { + "categoryGroup": "allLogs", + "enabled": true, + "retentionPolicy": { + "enabled": false, + "days": 0 + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/listDiagnosticSettingsCategories.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/listDiagnosticSettingsCategories.json new file mode 100644 index 000000000000..b80de077bab2 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/listDiagnosticSettingsCategories.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "resourceUri": "subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6", + "api-version": "2021-05-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/microsoft.insights/diagnosticSettingsCategories/WorkflowRuntime", + "type": "microsoft.insights/diagnosticSettingsCategories", + "name": "WorkflowRuntime", + "properties": { + "categoryType": "Logs", + "categoryGroups": [ + "allLogs" + ] + } + }, + { + "id": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/microsoft.insights/diagnosticSettingsCategories/WorkflowMetric", + "type": "microsoft.insights/diagnosticSettingsCategories", + "name": "WorkflowMetric", + "properties": { + "categoryType": "Metrics" + } + } + ] + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/listManagementGroupDiagnosticSettings.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/listManagementGroupDiagnosticSettings.json new file mode 100644 index 000000000000..c57dda49002c --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/listManagementGroupDiagnosticSettings.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "managementGroupId": "testChildMG7", + "api-version": "2021-05-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "providers/Microsoft.Management/managementGroups/testChildMG7/providers/microsoft.insights/diagnosticSettings/setting1", + "type": "Microsoft.Insights/diagnosticSettings", + "name": "setting1", + "properties": { + "storageAccountId": "/subscriptions/bfaef57f-297e-4210-bfe5-27c18cc671f7/resourceGroups/FuncAppRunners/providers/Microsoft.Storage/storageAccounts/testpersonalb6a5", + "workspaceId": "/subscriptions/9cf7cc0a-0ba1-4624-bc82-97e1ee25dc45/resourceGroups/mgTest/providers/Microsoft.OperationalInsights/workspaces/mgTestWorkspace", + "eventHubAuthorizationRuleId": "/subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/eventhubs/myeventhub/authorizationrules/myrule", + "marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1", + "logs": [ + { + "categoryGroup": "allLogs", + "enabled": true + } + ] + } + } + ] + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/listSubscriptionDiagnosticSettings.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/listSubscriptionDiagnosticSettings.json new file mode 100644 index 000000000000..257da7f88c47 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/examples/listSubscriptionDiagnosticSettings.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "fb9f25f9-5785-4510-a38f-a62f188eb9f8", + "api-version": "2021-05-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/providers/AzureResourceManager/diagnosticSettings/ds4", + "type": null, + "name": "ds4", + "properties": { + "storageAccountId": "/subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1", + "workspaceId": "/subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/resourceGroups/apptest/providers/Microsoft.OperationalInsights/workspaces/test1", + "eventHubAuthorizationRuleId": "/subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/resourceGroups/apptest/providers/microsoft.eventhub/namespaces/mynamespace/eventhubs/myeventhub/authorizationrules/myrule", + "marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1", + "logs": [ + { + "categoryGroup": "allLogs", + "enabled": true + } + ] + } + } + ] + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/managementGroupDiagnosticSettings_API.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/managementGroupDiagnosticSettings_API.json new file mode 100644 index 000000000000..f71244209936 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/managementGroupDiagnosticSettings_API.json @@ -0,0 +1,328 @@ +{ + "swagger": "2.0", + "info": { + "title": "MonitorManagementClient", + "x-ms-code-generation-settings": { + "name": "MonitorManagementClient" + }, + "version": "2021-05-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Insights/diagnosticSettings/{name}": { + "get": { + "tags": [ + "ManagementGroupDiagnosticSettings" + ], + "operationId": "ManagementGroupDiagnosticSettings_Get", + "description": "Gets the active management group diagnostic settings for the specified resource.", + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/NameParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request to get more information about diagnostic setting.", + "schema": { + "$ref": "#/definitions/ManagementGroupDiagnosticSettingsResource" + } + } + }, + "x-ms-examples": { + "Gets the management group diagnostic setting": { + "$ref": "./examples/getManagementGroupDiagnosticSetting.json" + } + } + }, + "put": { + "tags": [ + "ManagementGroupDiagnosticSettings" + ], + "operationId": "ManagementGroupDiagnosticSettings_CreateOrUpdate", + "description": "Creates or updates management group diagnostic settings for the specified resource.", + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagementGroupDiagnosticSettingsResource" + }, + "description": "Parameters supplied to the operation." + }, + { + "$ref": "#/parameters/NameParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request to create a management group diagnostic setting", + "schema": { + "$ref": "#/definitions/ManagementGroupDiagnosticSettingsResource" + } + } + }, + "x-ms-examples": { + "Creates or Updates the management group diagnostic setting": { + "$ref": "./examples/createOrUpdateManagementGroupDiagnosticSetting.json" + } + } + }, + "delete": { + "tags": [ + "ManagementGroupDiagnosticSettings" + ], + "operationId": "ManagementGroupDiagnosticSettings_Delete", + "description": "Deletes existing management group diagnostic settings for the specified resource.", + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/NameParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request to remove a management group diagnostic setting" + }, + "204": { + "description": "Successful request to remove a management group diagnostic setting" + } + }, + "x-ms-examples": { + "Deletes the management group diagnostic setting": { + "$ref": "./examples/deleteManagementGroupDiagnosticSetting.json" + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Insights/diagnosticSettings": { + "get": { + "tags": [ + "ManagementGroupDiagnosticSettings" + ], + "operationId": "ManagementGroupDiagnosticSettings_List", + "description": "Gets the active management group diagnostic settings list for the specified management group.", + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request to get more information about management group diagnostic setting", + "schema": { + "$ref": "#/definitions/ManagementGroupDiagnosticSettingsResourceCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Gets the management group diagnostic setting": { + "$ref": "./examples/listManagementGroupDiagnosticSettings.json" + } + } + } + } + }, + "definitions": { + "ManagementGroupLogSettings": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "Name of a Management Group Diagnostic Log category for a resource type this setting is applied to." + }, + "categoryGroup": { + "type": "string", + "description": "Name of a Management Group Diagnostic Log category group for a resource type this setting is applied to." + }, + "enabled": { + "type": "boolean", + "description": "a value indicating whether this log is enabled." + } + }, + "required": [ + "enabled" + ], + "description": "Part of Management Group diagnostic setting. Specifies the settings for a particular log." + }, + "ManagementGroupDiagnosticSettings": { + "type": "object", + "properties": { + "storageAccountId": { + "type": "string", + "description": "The resource ID of the storage account to which you would like to send Diagnostic Logs." + }, + "serviceBusRuleId": { + "type": "string", + "description": "The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility." + }, + "eventHubAuthorizationRuleId": { + "type": "string", + "description": "The resource Id for the event hub authorization rule." + }, + "eventHubName": { + "type": "string", + "description": "The name of the event hub. If none is specified, the default event hub will be selected." + }, + "logs": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagementGroupLogSettings" + }, + "description": "The list of logs settings." + }, + "workspaceId": { + "type": "string", + "description": "The full ARM resource ID of the Log Analytics workspace to which you would like to send Diagnostic Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2" + }, + "marketplacePartnerId": { + "type": "string", + "description": "The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic Logs." + } + }, + "description": "The management group diagnostic settings." + }, + "ManagementGroupDiagnosticSettingsResource": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ManagementGroupDiagnosticSettings", + "description": "Properties of a Management Group Diagnostic Settings Resource." + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "description": "The management group diagnostic setting resource." + }, + "ManagementGroupDiagnosticSettingsResourceCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagementGroupDiagnosticSettingsResource" + }, + "description": "The collection of management group diagnostic settings resources." + } + }, + "description": "Represents a collection of management group diagnostic settings resources." + }, + "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" + } + } + } + }, + "parameters": { + "ManagementGroupIdParameter": { + "name": "managementGroupId", + "in": "path", + "required": true, + "type": "string", + "description": "The management group id.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "NameParameter": { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the diagnostic setting.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/subscriptionDiagnosticsSettings_API.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/subscriptionDiagnosticsSettings_API.json new file mode 100644 index 000000000000..7d0532a7a0f4 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/subscriptionDiagnosticsSettings_API.json @@ -0,0 +1,319 @@ +{ + "swagger": "2.0", + "info": { + "title": "MonitorManagementClient", + "x-ms-code-generation-settings": { + "name": "MonitorManagementClient" + }, + "version": "2021-05-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Insights/diagnosticSettings/{name}": { + "get": { + "tags": [ + "SubscriptionDiagnosticSettings" + ], + "operationId": "SubscriptionDiagnosticSettings_Get", + "description": "Gets the active subscription diagnostic settings for the specified resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/NameParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request to get more information about diagnostic setting.", + "schema": { + "$ref": "#/definitions/SubscriptionDiagnosticSettingsResource" + } + } + }, + "x-ms-examples": { + "Gets the subscription diagnostic setting": { + "$ref": "./examples/getSubscriptionDiagnosticSetting.json" + } + } + }, + "put": { + "tags": [ + "SubscriptionDiagnosticSettings" + ], + "operationId": "SubscriptionDiagnosticSettings_CreateOrUpdate", + "description": "Creates or updates subscription diagnostic settings for the specified resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SubscriptionDiagnosticSettingsResource" + }, + "description": "Parameters supplied to the operation." + }, + { + "$ref": "#/parameters/NameParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request to create a subscription diagnostic setting", + "schema": { + "$ref": "#/definitions/SubscriptionDiagnosticSettingsResource" + } + } + }, + "x-ms-examples": { + "Creates or Updates the subscription diagnostic setting": { + "$ref": "./examples/createOrUpdateSubscriptionDiagnosticSetting.json" + } + } + }, + "delete": { + "tags": [ + "SubscriptionDiagnosticSettings" + ], + "operationId": "SubscriptionDiagnosticSettings_Delete", + "description": "Deletes existing subscription diagnostic settings for the specified resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/NameParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request to remove a subscription diagnostic setting" + }, + "204": { + "description": "Successful request to remove a subscription diagnostic setting" + } + }, + "x-ms-examples": { + "Deletes the subscription diagnostic setting": { + "$ref": "./examples/deleteSubscriptionDiagnosticSetting.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Insights/diagnosticSettings": { + "get": { + "tags": [ + "SubscriptionDiagnosticSettings" + ], + "operationId": "SubscriptionDiagnosticSettings_List", + "description": "Gets the active subscription diagnostic settings list for the specified subscriptionId.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request to get more information about subscription diagnostic setting", + "schema": { + "$ref": "#/definitions/SubscriptionDiagnosticSettingsResourceCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Gets the subscription diagnostic setting": { + "$ref": "./examples/listSubscriptionDiagnosticSettings.json" + } + } + } + } + }, + "definitions": { + "SubscriptionLogSettings": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "Name of a Subscription Diagnostic Log category for a resource type this setting is applied to." + }, + "categoryGroup": { + "type": "string", + "description": "Name of a Subscription Diagnostic Log category group for a resource type this setting is applied to." + }, + "enabled": { + "type": "boolean", + "description": "a value indicating whether this log is enabled." + } + }, + "required": [ + "enabled" + ], + "description": "Part of Subscription diagnostic setting. Specifies the settings for a particular log." + }, + "SubscriptionDiagnosticSettings": { + "type": "object", + "properties": { + "storageAccountId": { + "type": "string", + "description": "The resource ID of the storage account to which you would like to send Diagnostic Logs." + }, + "serviceBusRuleId": { + "type": "string", + "description": "The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility." + }, + "eventHubAuthorizationRuleId": { + "type": "string", + "description": "The resource Id for the event hub authorization rule." + }, + "eventHubName": { + "type": "string", + "description": "The name of the event hub. If none is specified, the default event hub will be selected." + }, + "logs": { + "type": "array", + "items": { + "$ref": "#/definitions/SubscriptionLogSettings" + }, + "description": "The list of logs settings." + }, + "workspaceId": { + "type": "string", + "description": "The full ARM resource ID of the Log Analytics workspace to which you would like to send Diagnostic Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2" + }, + "marketplacePartnerId": { + "type": "string", + "description": "The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic Logs." + } + }, + "description": "The subscription diagnostic settings." + }, + "SubscriptionDiagnosticSettingsResource": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SubscriptionDiagnosticSettings", + "description": "Properties of a Subscription Diagnostic Settings Resource." + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "description": "The subscription diagnostic setting resource." + }, + "SubscriptionDiagnosticSettingsResourceCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SubscriptionDiagnosticSettingsResource" + }, + "description": "The collection of subscription diagnostic settings resources." + } + }, + "description": "Represents a collection of subscription diagnostic settings resources." + }, + "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" + } + } + } + }, + "parameters": { + "NameParameter": { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the diagnostic setting.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2014-04-01/autoscale_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2014-04-01/autoscale_API.json new file mode 100644 index 000000000000..e1d03b11ea28 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2014-04-01/autoscale_API.json @@ -0,0 +1,886 @@ +{ + "swagger": "2.0", + "info": { + "title": "MonitorManagementClient", + "x-ms-code-generation-settings": { + "name": "MonitorManagementClient" + }, + "version": "2014-04-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.Insights/autoscalesettings": { + "get": { + "description": "Lists the autoscale settings for a resource group", + "tags": [ + "AutoscaleSettings" + ], + "operationId": "AutoscaleSettings_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request for a list of autoscale settings", + "schema": { + "$ref": "#/definitions/AutoscaleSettingResourceCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List autoscale settings": { + "$ref": "./examples/listAutoscaleSetting.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/autoscalesettings/{autoscaleSettingName}": { + "put": { + "description": "Creates or updates an autoscale setting.", + "tags": [ + "AutoscaleSettings" + ], + "operationId": "AutoscaleSettings_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AutoscaleSettingNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AutoscaleSettingResource" + }, + "description": "Parameters supplied to the operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request to create or update an autoscale setting", + "schema": { + "$ref": "#/definitions/AutoscaleSettingResource" + } + }, + "201": { + "description": "Created autoscale setting", + "schema": { + "$ref": "#/definitions/AutoscaleSettingResource" + } + } + }, + "x-ms-examples": { + "Create or update an autoscale setting": { + "$ref": "./examples/createOrUpdateAutoscaleSetting.json" + } + } + }, + "delete": { + "description": "Deletes and autoscale setting", + "tags": [ + "AutoscaleSettings" + ], + "operationId": "AutoscaleSettings_Delete", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AutoscaleSettingNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request to delete an autoscale setting" + }, + "204": { + "description": "No content: Successful request to delete an autoscale setting, but the response is intentionally empty" + } + }, + "x-ms-examples": { + "Delete an autoscale setting": { + "$ref": "./examples/deleteAutoscaleSetting.json" + } + } + }, + "get": { + "description": "Gets an autoscale setting", + "tags": [ + "AutoscaleSettings" + ], + "operationId": "AutoscaleSettings_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AutoscaleSettingNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request to get one autoscale setting", + "schema": { + "$ref": "#/definitions/AutoscaleSettingResource" + } + } + }, + "x-ms-examples": { + "Get an autoscale setting": { + "$ref": "./examples/getAutoscaleSetting.json" + } + } + }, + "patch": { + "description": "Updates an existing AutoscaleSettingsResource. To update other fields use the CreateOrUpdate method.", + "operationId": "AutoscaleSettings_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AutoscaleSettingNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "autoscaleSettingResource", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AutoscaleSettingResourcePatch" + }, + "description": "Parameters supplied to the operation." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "An existing autoscale setting resource was successfully updated.", + "schema": { + "$ref": "#/definitions/AutoscaleSettingResource" + } + } + }, + "x-ms-examples": { + "Patch an autoscale setting": { + "$ref": "./examples/patchAutoscaleSetting.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Insights/autoscalesettings": { + "get": { + "description": "Lists the autoscale settings for a subscription", + "tags": [ + "AutoscaleSettings" + ], + "operationId": "AutoscaleSettings_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request for a list of autoscale settings", + "schema": { + "$ref": "#/definitions/AutoscaleSettingResourceCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List autoscale settings": { + "$ref": "./examples/listAutoscaleSettingBySubscription.json" + } + } + } + } + }, + "definitions": { + "Resource": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Azure resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Azure resource type" + }, + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true, + "description": "An azure resource object" + }, + "ScaleCapacity": { + "required": [ + "minimum", + "maximum", + "default" + ], + "properties": { + "minimum": { + "type": "string", + "description": "the minimum number of instances for the resource." + }, + "maximum": { + "type": "string", + "description": "the maximum number of instances for the resource. The actual maximum number of instances is limited by the cores that are available in the subscription." + }, + "default": { + "type": "string", + "description": "the number of instances that will be set if metrics are not available for evaluation. The default is only used if the current instance count is lower than the default." + } + }, + "description": "The number of instances that can be used during this profile." + }, + "MetricTrigger": { + "required": [ + "metricName", + "metricResourceUri", + "timeGrain", + "statistic", + "timeWindow", + "timeAggregation", + "operator", + "threshold" + ], + "properties": { + "metricName": { + "type": "string", + "description": "the name of the metric that defines what the rule monitors." + }, + "metricNamespace": { + "type": "string", + "description": "the namespace of the metric that defines what the rule monitors." + }, + "metricResourceUri": { + "type": "string", + "description": "the resource identifier of the resource the rule monitors." + }, + "metricResourceLocation": { + "type": "string", + "description": "the location of the resource the rule monitors." + }, + "timeGrain": { + "type": "string", + "format": "duration", + "description": "the granularity of metrics the rule monitors. Must be one of the predefined values returned from metric definitions for the metric. Must be between 12 hours and 1 minute." + }, + "statistic": { + "type": "string", + "description": "the metric statistic type. How the metrics from multiple instances are combined.", + "enum": [ + "Average", + "Min", + "Max", + "Sum", + "Count" + ], + "x-ms-enum": { + "name": "MetricStatisticType", + "modelAsString": false + } + }, + "timeWindow": { + "type": "string", + "format": "duration", + "description": "the range of time in which instance data is collected. This value must be greater than the delay in metric collection, which can vary from resource-to-resource. Must be between 12 hours and 5 minutes." + }, + "timeAggregation": { + "type": "string", + "description": "time aggregation type. How the data that is collected should be combined over time. The default value is Average.", + "enum": [ + "Average", + "Minimum", + "Maximum", + "Total", + "Count", + "Last" + ], + "x-ms-enum": { + "name": "TimeAggregationType", + "modelAsString": false + } + }, + "operator": { + "type": "string", + "description": "the operator that is used to compare the metric data and the threshold.", + "enum": [ + "Equals", + "NotEquals", + "GreaterThan", + "GreaterThanOrEqual", + "LessThan", + "LessThanOrEqual" + ], + "x-ms-enum": { + "name": "ComparisonOperationType", + "modelAsString": false + } + }, + "threshold": { + "type": "number", + "format": "double", + "description": "the threshold of the metric that triggers the scale action." + }, + "dimensions": { + "type": "array", + "items": { + "$ref": "#/definitions/ScaleRuleMetricDimension" + }, + "description": "List of dimension conditions. For example: [{\"DimensionName\":\"AppName\",\"Operator\":\"Equals\",\"Values\":[\"App1\"]},{\"DimensionName\":\"Deployment\",\"Operator\":\"Equals\",\"Values\":[\"default\"]}]." + }, + "dividePerInstance": { + "type": "boolean", + "description": "a value indicating whether metric should divide per instance." + } + }, + "description": "The trigger that results in a scaling action." + }, + "ScaleAction": { + "required": [ + "direction", + "type", + "cooldown" + ], + "properties": { + "direction": { + "type": "string", + "description": "the scale direction. Whether the scaling action increases or decreases the number of instances.", + "enum": [ + "None", + "Increase", + "Decrease" + ], + "x-ms-enum": { + "name": "ScaleDirection", + "modelAsString": false + } + }, + "type": { + "type": "string", + "description": "the type of action that should occur when the scale rule fires.", + "enum": [ + "ChangeCount", + "PercentChangeCount", + "ExactCount", + "ServiceAllowedNextValue" + ], + "x-ms-enum": { + "name": "ScaleType", + "modelAsString": false + } + }, + "value": { + "type": "string", + "description": "the number of instances that are involved in the scaling action. This value must be 1 or greater. The default value is 1.", + "default": "1" + }, + "cooldown": { + "type": "string", + "format": "duration", + "description": "the amount of time to wait since the last scaling action before this action occurs. It must be between 1 week and 1 minute in ISO 8601 format." + } + }, + "description": "The parameters for the scaling action." + }, + "ScaleRule": { + "required": [ + "scaleAction", + "metricTrigger" + ], + "properties": { + "metricTrigger": { + "$ref": "#/definitions/MetricTrigger", + "description": "the trigger that results in a scaling action." + }, + "scaleAction": { + "$ref": "#/definitions/ScaleAction", + "description": "the parameters for the scaling action." + } + }, + "description": "A rule that provide the triggers and parameters for the scaling action." + }, + "TimeWindow": { + "properties": { + "timeZone": { + "type": "string", + "description": "the timezone of the start and end times for the profile. Some examples of valid time zones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time" + }, + "start": { + "type": "string", + "format": "date-time", + "description": "the start time for the profile in ISO 8601 format." + }, + "end": { + "type": "string", + "format": "date-time", + "description": "the end time for the profile in ISO 8601 format." + } + }, + "required": [ + "start", + "end" + ], + "description": "A specific date-time for the profile." + }, + "RecurrentSchedule": { + "required": [ + "timeZone", + "days", + "hours", + "minutes" + ], + "properties": { + "timeZone": { + "type": "string", + "description": "the timezone for the hours of the profile. Some examples of valid time zones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time" + }, + "days": { + "type": "array", + "items": { + "type": "string" + }, + "description": "the collection of days that the profile takes effect on. Possible values are Sunday through Saturday." + }, + "hours": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "A collection of hours that the profile takes effect on. Values supported are 0 to 23 on the 24-hour clock (AM/PM times are not supported)." + }, + "minutes": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "A collection of minutes at which the profile takes effect at." + } + }, + "description": "The scheduling constraints for when the profile begins." + }, + "Recurrence": { + "required": [ + "frequency", + "schedule" + ], + "properties": { + "frequency": { + "type": "string", + "description": "the recurrence frequency. How often the schedule profile should take effect. This value must be Week, meaning each week will have the same set of profiles. For example, to set a daily schedule, set **schedule** to every day of the week. The frequency property specifies that the schedule is repeated weekly.", + "enum": [ + "None", + "Second", + "Minute", + "Hour", + "Day", + "Week", + "Month", + "Year" + ], + "x-ms-enum": { + "name": "RecurrenceFrequency", + "modelAsString": false + } + }, + "schedule": { + "$ref": "#/definitions/RecurrentSchedule", + "description": "the scheduling constraints for when the profile begins." + } + }, + "description": "The repeating times at which this profile begins. This element is not used if the FixedDate element is used." + }, + "AutoscaleProfile": { + "required": [ + "rules", + "name", + "capacity" + ], + "properties": { + "name": { + "type": "string", + "description": "the name of the profile." + }, + "capacity": { + "$ref": "#/definitions/ScaleCapacity", + "description": "the number of instances that can be used during this profile." + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/ScaleRule" + }, + "description": "the collection of rules that provide the triggers and parameters for the scaling action. A maximum of 10 rules can be specified." + }, + "fixedDate": { + "$ref": "#/definitions/TimeWindow", + "description": "the specific date-time for the profile. This element is not used if the Recurrence element is used." + }, + "recurrence": { + "$ref": "#/definitions/Recurrence", + "description": "the repeating times at which this profile begins. This element is not used if the FixedDate element is used." + } + }, + "description": "Autoscale profile." + }, + "EmailNotification": { + "properties": { + "sendToSubscriptionAdministrator": { + "type": "boolean", + "description": "a value indicating whether to send email to subscription administrator.", + "default": false + }, + "sendToSubscriptionCoAdministrators": { + "type": "boolean", + "description": "a value indicating whether to send email to subscription co-administrators.", + "default": false + }, + "customEmails": { + "type": "array", + "items": { + "type": "string" + }, + "description": "the custom e-mails list. This value can be null or empty, in which case this attribute will be ignored." + } + }, + "description": "Email notification of an autoscale event." + }, + "WebhookNotification": { + "properties": { + "serviceUri": { + "type": "string", + "description": "the service address to receive the notification." + }, + "properties": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "a property bag of settings. This value can be empty." + } + }, + "description": "Webhook notification of an autoscale event." + }, + "AutoscaleNotification": { + "required": [ + "operation" + ], + "properties": { + "operation": { + "type": "string", + "description": "the operation associated with the notification and its value must be \"scale\"", + "enum": [ + "Scale" + ], + "x-ms-enum": { + "name": "OperationType", + "modelAsString": false + } + }, + "email": { + "$ref": "#/definitions/EmailNotification", + "description": "the email notification." + }, + "webhooks": { + "type": "array", + "items": { + "$ref": "#/definitions/WebhookNotification" + }, + "description": "the collection of webhook notifications." + } + }, + "description": "Autoscale notification." + }, + "AutoscaleSetting": { + "required": [ + "profiles" + ], + "properties": { + "profiles": { + "type": "array", + "maxItems": 20, + "items": { + "$ref": "#/definitions/AutoscaleProfile" + }, + "description": "the collection of automatic scaling profiles that specify different scaling parameters for different time periods. A maximum of 20 profiles can be specified." + }, + "notifications": { + "type": "array", + "items": { + "$ref": "#/definitions/AutoscaleNotification" + }, + "description": "the collection of notifications." + }, + "enabled": { + "type": "boolean", + "description": "the enabled flag. Specifies whether automatic scaling is enabled for the resource. The default value is 'true'.", + "default": true + }, + "name": { + "type": "string", + "description": "the name of the autoscale setting." + }, + "targetResourceUri": { + "type": "string", + "description": "the resource identifier of the resource that the autoscale setting should be added to." + }, + "targetResourceLocation": { + "type": "string", + "description": "the location of the resource that the autoscale setting should be added to." + } + }, + "description": "A setting that contains all of the configuration for the automatic scaling of a resource." + }, + "AutoscaleSettingResource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AutoscaleSetting", + "description": "The autoscale setting of the resource." + } + }, + "description": "The autoscale setting resource." + }, + "AutoscaleSettingResourcePatch": { + "description": "The autoscale setting object for patch operations.", + "properties": { + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AutoscaleSetting", + "description": "The autoscale setting properties of the update operation." + } + } + }, + "AutoscaleSettingResourceCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AutoscaleSettingResource" + }, + "description": "the values for the autoscale setting resources." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "required": [ + "value" + ], + "description": "Represents a collection of autoscale setting resources." + }, + "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" + } + } + }, + "ScaleRuleMetricDimension": { + "required": [ + "DimensionName", + "Operator", + "Values" + ], + "properties": { + "DimensionName": { + "type": "string", + "description": "Name of the dimension." + }, + "Operator": { + "type": "string", + "description": "the dimension operator. Only 'Equals' and 'NotEquals' are supported. 'Equals' being equal to any of the values. 'NotEquals' being not equal to all of the values", + "enum": [ + "Equals", + "NotEquals" + ], + "x-ms-enum": { + "name": "ScaleRuleMetricDimensionOperationType", + "modelAsString": true + } + }, + "Values": { + "type": "array", + "items": { + "type": "string" + }, + "description": "list of dimension values. For example: [\"App1\",\"App2\"]." + } + }, + "description": "Specifies an auto scale rule metric dimension." + } + }, + "parameters": { + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "AutoscaleSettingNameParameter": { + "name": "autoscaleSettingName", + "in": "path", + "required": true, + "type": "string", + "description": "The autoscale setting name.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2014-04-01/examples/createOrUpdateAutoscaleSetting.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2014-04-01/examples/createOrUpdateAutoscaleSetting.json new file mode 100644 index 000000000000..7a292aee831d --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2014-04-01/examples/createOrUpdateAutoscaleSetting.json @@ -0,0 +1,451 @@ +{ + "parameters": { + "subscriptionId": "b67f7fec-69fc-4974-9099-a26bd6ffeda3", + "resourceGroupName": "TestingMetricsScaleSet", + "autoscaleSettingName": "MySetting", + "api-version": "2014-04-01", + "parameters": { + "location": "West US", + "tags": {}, + "properties": { + "profiles": [ + { + "name": "adios", + "capacity": { + "minimum": "1", + "maximum": "10", + "default": "1" + }, + "rules": [ + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT1M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 10.0 + }, + "scaleAction": { + "direction": "Increase", + "type": "ChangeCount", + "value": "1", + "cooldown": "PT5M" + } + }, + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT2M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 15.0 + }, + "scaleAction": { + "direction": "Decrease", + "type": "ChangeCount", + "value": "2", + "cooldown": "PT6M" + } + } + ], + "fixedDate": { + "timeZone": "UTC", + "start": "2015-03-05T14:00:00Z", + "end": "2015-03-05T14:30:00Z" + } + }, + { + "name": "saludos", + "capacity": { + "minimum": "1", + "maximum": "10", + "default": "1" + }, + "rules": [ + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT1M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 10.0 + }, + "scaleAction": { + "direction": "Increase", + "type": "ChangeCount", + "value": "1", + "cooldown": "PT5M" + } + }, + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT2M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 15.0 + }, + "scaleAction": { + "direction": "Decrease", + "type": "ChangeCount", + "value": "2", + "cooldown": "PT6M" + } + } + ], + "recurrence": { + "frequency": "Week", + "schedule": { + "timeZone": "UTC", + "days": [ + "1" + ], + "hours": [ + 5 + ], + "minutes": [ + 15 + ] + } + } + } + ], + "enabled": true, + "targetResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "notifications": [ + { + "operation": "Scale", + "email": { + "sendToSubscriptionAdministrator": true, + "sendToSubscriptionCoAdministrators": true, + "customEmails": [ + "gu@ms.com", + "ge@ns.net" + ] + }, + "webhooks": [ + { + "serviceUri": "http://myservice.com", + "properties": {} + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Insights/autoscalesettings/MySetting", + "name": "MySetting", + "type": "Microsoft.Insights/autoscaleSettings", + "location": "West US", + "tags": { + "$type": "Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage" + }, + "properties": { + "profiles": [ + { + "name": "adios", + "capacity": { + "minimum": "1", + "maximum": "10", + "default": "1" + }, + "rules": [ + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT1M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 10.0 + }, + "scaleAction": { + "direction": "Increase", + "type": "ChangeCount", + "value": "1", + "cooldown": "PT5M" + } + }, + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT2M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 15.0 + }, + "scaleAction": { + "direction": "Decrease", + "type": "ChangeCount", + "value": "2", + "cooldown": "PT6M" + } + } + ], + "fixedDate": { + "timeZone": "UTC", + "start": "2015-03-05T14:00:00Z", + "end": "2015-03-05T14:30:00Z" + } + }, + { + "name": "saludos", + "capacity": { + "minimum": "1", + "maximum": "10", + "default": "1" + }, + "rules": [ + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT1M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 10.0 + }, + "scaleAction": { + "direction": "Increase", + "type": "ChangeCount", + "value": "1", + "cooldown": "PT5M" + } + }, + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT2M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 15.0 + }, + "scaleAction": { + "direction": "Decrease", + "type": "ChangeCount", + "value": "2", + "cooldown": "PT6M" + } + } + ], + "recurrence": { + "frequency": "Week", + "schedule": { + "timeZone": "UTC", + "days": [ + "1" + ], + "hours": [ + 5 + ], + "minutes": [ + 15 + ] + } + } + } + ], + "enabled": true, + "name": "MySetting", + "targetResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "notifications": [ + { + "operation": "Scale", + "email": { + "sendToSubscriptionAdministrator": true, + "sendToSubscriptionCoAdministrators": true, + "customEmails": [ + "gu@ms.com", + "ge@ns.net" + ] + }, + "webhooks": [ + { + "serviceUri": "http://myservice.com", + "properties": {} + } + ] + } + ] + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/microsoft.insights/autoscalesettings/MySetting", + "name": "MySetting", + "type": "Microsoft.Insights/autoscaleSettings", + "location": "West US", + "tags": { + "$type": "Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage" + }, + "properties": { + "profiles": [ + { + "name": "adios", + "capacity": { + "minimum": "1", + "maximum": "10", + "default": "1" + }, + "rules": [ + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT1M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 10.0 + }, + "scaleAction": { + "direction": "Increase", + "type": "ChangeCount", + "value": "1", + "cooldown": "PT5M" + } + }, + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT2M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 15.0 + }, + "scaleAction": { + "direction": "Decrease", + "type": "ChangeCount", + "value": "2", + "cooldown": "PT6M" + } + } + ], + "fixedDate": { + "timeZone": "UTC", + "start": "2015-03-05T14:00:00Z", + "end": "2015-03-05T14:30:00Z" + } + }, + { + "name": "saludos", + "capacity": { + "minimum": "1", + "maximum": "10", + "default": "1" + }, + "rules": [ + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT1M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 10.0 + }, + "scaleAction": { + "direction": "Increase", + "type": "ChangeCount", + "value": "1", + "cooldown": "PT5M" + } + }, + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT2M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 15.0 + }, + "scaleAction": { + "direction": "Decrease", + "type": "ChangeCount", + "value": "2", + "cooldown": "PT6M" + } + } + ], + "recurrence": { + "frequency": "Week", + "schedule": { + "timeZone": "UTC", + "days": [ + "1" + ], + "hours": [ + 5 + ], + "minutes": [ + 15 + ] + } + } + } + ], + "enabled": true, + "name": "MySetting", + "targetResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "notifications": [ + { + "operation": "Scale", + "email": { + "sendToSubscriptionAdministrator": true, + "sendToSubscriptionCoAdministrators": true, + "customEmails": [ + "gu@ms.com", + "ge@ns.net" + ] + }, + "webhooks": [ + { + "serviceUri": "http://myservice.com", + "properties": {} + } + ] + } + ] + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2014-04-01/examples/deleteAutoscaleSetting.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2014-04-01/examples/deleteAutoscaleSetting.json new file mode 100644 index 000000000000..ab7fa641110a --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2014-04-01/examples/deleteAutoscaleSetting.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "b67f7fec-69fc-4974-9099-a26bd6ffeda3", + "resourceGroupName": "TestingMetricsScaleSet", + "autoscaleSettingName": "MySetting", + "api-version": "2014-04-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2014-04-01/examples/getAutoscaleSetting.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2014-04-01/examples/getAutoscaleSetting.json new file mode 100644 index 000000000000..16de6185ce23 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2014-04-01/examples/getAutoscaleSetting.json @@ -0,0 +1,160 @@ +{ + "parameters": { + "subscriptionId": "b67f7fec-69fc-4974-9099-a26bd6ffeda3", + "resourceGroupName": "TestingMetricsScaleSet", + "autoscaleSettingName": "MySetting", + "api-version": "2014-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/microsoft.insights/autoscalesettings/MySetting", + "name": "MySetting", + "type": "Microsoft.Insights/autoscaleSettings", + "location": "West US", + "tags": { + "$type": "Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage" + }, + "properties": { + "profiles": [ + { + "name": "adios", + "capacity": { + "minimum": "1", + "maximum": "10", + "default": "1" + }, + "rules": [ + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT1M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 10.0 + }, + "scaleAction": { + "direction": "Increase", + "type": "ChangeCount", + "value": "1", + "cooldown": "PT5M" + } + }, + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT2M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 15.0 + }, + "scaleAction": { + "direction": "Decrease", + "type": "ChangeCount", + "value": "2", + "cooldown": "PT6M" + } + } + ], + "fixedDate": { + "timeZone": "UTC", + "start": "2015-03-05T14:00:00Z", + "end": "2015-03-05T14:30:00Z" + } + }, + { + "name": "saludos", + "capacity": { + "minimum": "1", + "maximum": "10", + "default": "1" + }, + "rules": [ + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT1M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 10.0 + }, + "scaleAction": { + "direction": "Increase", + "type": "ChangeCount", + "value": "1", + "cooldown": "PT5M" + } + }, + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT2M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 15.0 + }, + "scaleAction": { + "direction": "Decrease", + "type": "ChangeCount", + "value": "2", + "cooldown": "PT6M" + } + } + ], + "recurrence": { + "frequency": "Week", + "schedule": { + "timeZone": "UTC", + "days": [ + "1" + ], + "hours": [ + 5 + ], + "minutes": [ + 15 + ] + } + } + } + ], + "enabled": true, + "name": "MySetting", + "targetResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "notifications": [ + { + "operation": "Scale", + "email": { + "sendToSubscriptionAdministrator": true, + "sendToSubscriptionCoAdministrators": true, + "customEmails": [ + "gu@ms.com", + "ge@ns.net" + ] + }, + "webhooks": [ + { + "serviceUri": "http://myservice.com", + "properties": {} + } + ] + } + ] + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2014-04-01/examples/listAutoscaleSetting.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2014-04-01/examples/listAutoscaleSetting.json new file mode 100644 index 000000000000..55a9bfda2f7c --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2014-04-01/examples/listAutoscaleSetting.json @@ -0,0 +1,164 @@ +{ + "parameters": { + "subscriptionId": "b67f7fec-69fc-4974-9099-a26bd6ffeda3", + "resourceGroupName": "TestingMetricsScaleSet", + "api-version": "2014-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/microsoft.insights/autoscalesettings/MySetting", + "name": "MySetting", + "type": "Microsoft.Insights/autoscaleSettings", + "location": "West US", + "tags": { + "$type": "Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage" + }, + "properties": { + "profiles": [ + { + "name": "adios", + "capacity": { + "minimum": "1", + "maximum": "10", + "default": "1" + }, + "rules": [ + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT1M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 10.0 + }, + "scaleAction": { + "direction": "Increase", + "type": "ChangeCount", + "value": "1", + "cooldown": "PT5M" + } + }, + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT2M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 15.0 + }, + "scaleAction": { + "direction": "Decrease", + "type": "ChangeCount", + "value": "2", + "cooldown": "PT6M" + } + } + ], + "fixedDate": { + "timeZone": "UTC", + "start": "2015-03-05T14:00:00Z", + "end": "2015-03-05T14:30:00Z" + } + }, + { + "name": "saludos", + "capacity": { + "minimum": "1", + "maximum": "10", + "default": "1" + }, + "rules": [ + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT1M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 10.0 + }, + "scaleAction": { + "direction": "Increase", + "type": "ChangeCount", + "value": "1", + "cooldown": "PT5M" + } + }, + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT2M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 15.0 + }, + "scaleAction": { + "direction": "Decrease", + "type": "ChangeCount", + "value": "2", + "cooldown": "PT6M" + } + } + ], + "recurrence": { + "frequency": "Week", + "schedule": { + "timeZone": "UTC", + "days": [ + "1" + ], + "hours": [ + 5 + ], + "minutes": [ + 15 + ] + } + } + } + ], + "enabled": true, + "name": "MySetting", + "targetResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "notifications": [ + { + "operation": "Scale", + "email": { + "sendToSubscriptionAdministrator": true, + "sendToSubscriptionCoAdministrators": true, + "customEmails": [ + "gu@ms.com", + "ge@ns.net" + ] + }, + "webhooks": [ + { + "serviceUri": "http://myservice.com", + "properties": {} + } + ] + } + ] + } + } + ], + "nextLink": "https://management.azure.com/########-####-####-####-############$skiptoken=######" + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2014-04-01/examples/listAutoscaleSettingBySubscription.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2014-04-01/examples/listAutoscaleSettingBySubscription.json new file mode 100644 index 000000000000..3f6eedc2bf5d --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2014-04-01/examples/listAutoscaleSettingBySubscription.json @@ -0,0 +1,163 @@ +{ + "parameters": { + "subscriptionId": "b67f7fec-69fc-4974-9099-a26bd6ffeda3", + "api-version": "2014-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/microsoft.insights/autoscalesettings/MySetting", + "name": "MySetting", + "type": "Microsoft.Insights/autoscaleSettings", + "location": "West US", + "tags": { + "$type": "Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage" + }, + "properties": { + "profiles": [ + { + "name": "adios", + "capacity": { + "minimum": "1", + "maximum": "10", + "default": "1" + }, + "rules": [ + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT1M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 10.0 + }, + "scaleAction": { + "direction": "Increase", + "type": "ChangeCount", + "value": "1", + "cooldown": "PT5M" + } + }, + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT2M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 15.0 + }, + "scaleAction": { + "direction": "Decrease", + "type": "ChangeCount", + "value": "2", + "cooldown": "PT6M" + } + } + ], + "fixedDate": { + "timeZone": "UTC", + "start": "2015-03-05T14:00:00Z", + "end": "2015-03-05T14:30:00Z" + } + }, + { + "name": "saludos", + "capacity": { + "minimum": "1", + "maximum": "10", + "default": "1" + }, + "rules": [ + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT1M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 10.0 + }, + "scaleAction": { + "direction": "Increase", + "type": "ChangeCount", + "value": "1", + "cooldown": "PT5M" + } + }, + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT2M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 15.0 + }, + "scaleAction": { + "direction": "Decrease", + "type": "ChangeCount", + "value": "2", + "cooldown": "PT6M" + } + } + ], + "recurrence": { + "frequency": "Week", + "schedule": { + "timeZone": "UTC", + "days": [ + "1" + ], + "hours": [ + 5 + ], + "minutes": [ + 15 + ] + } + } + } + ], + "enabled": true, + "name": "MySetting", + "targetResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "notifications": [ + { + "operation": "Scale", + "email": { + "sendToSubscriptionAdministrator": true, + "sendToSubscriptionCoAdministrators": true, + "customEmails": [ + "gu@ms.com", + "ge@ns.net" + ] + }, + "webhooks": [ + { + "serviceUri": "http://myservice.com", + "properties": {} + } + ] + } + ] + } + } + ], + "nextLink": "https://management.azure.com/########-####-####-####-############$skiptoken=######" + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2014-04-01/examples/patchAutoscaleSetting.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2014-04-01/examples/patchAutoscaleSetting.json new file mode 100644 index 000000000000..b33374520e7f --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2014-04-01/examples/patchAutoscaleSetting.json @@ -0,0 +1,302 @@ +{ + "parameters": { + "subscriptionId": "b67f7fec-69fc-4974-9099-a26bd6ffeda3", + "resourceGroupName": "TestingMetricsScaleSet", + "autoscaleSettingName": "MySetting", + "api-version": "2014-04-01", + "autoscaleSettingResource": { + "tags": { + "$type": "Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary" + }, + "properties": { + "profiles": [ + { + "name": "adios", + "capacity": { + "minimum": "1", + "maximum": "10", + "default": "1" + }, + "rules": [ + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT1M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 10.0 + }, + "scaleAction": { + "direction": "Increase", + "type": "ChangeCount", + "value": "1", + "cooldown": "PT5M" + } + }, + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT2M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 15.0 + }, + "scaleAction": { + "direction": "Decrease", + "type": "ChangeCount", + "value": "2", + "cooldown": "PT6M" + } + } + ], + "fixedDate": { + "timeZone": "UTC", + "start": "2015-03-05T14:00:00Z", + "end": "2015-03-05T14:30:00Z" + } + }, + { + "name": "saludos", + "capacity": { + "minimum": "1", + "maximum": "10", + "default": "1" + }, + "rules": [ + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT1M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 10.0 + }, + "scaleAction": { + "direction": "Increase", + "type": "ChangeCount", + "value": "1", + "cooldown": "PT5M" + } + }, + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT2M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 15.0 + }, + "scaleAction": { + "direction": "Decrease", + "type": "ChangeCount", + "value": "2", + "cooldown": "PT6M" + } + } + ], + "recurrence": { + "frequency": "Week", + "schedule": { + "timeZone": "UTC", + "days": [ + "1" + ], + "hours": [ + 5 + ], + "minutes": [ + 15 + ] + } + } + } + ], + "enabled": true, + "targetResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "notifications": [ + { + "operation": "Scale", + "email": { + "sendToSubscriptionAdministrator": true, + "sendToSubscriptionCoAdministrators": true, + "customEmails": [ + "gu@ms.com", + "ge@ns.net" + ] + }, + "webhooks": [ + { + "serviceUri": "http://myservice.com", + "properties": {} + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/microsoft.insights/autoscalesettings/MySetting", + "name": "MySetting", + "type": "Microsoft.Insights/autoscaleSettings", + "location": "West US", + "tags": { + "$type": "Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary" + }, + "properties": { + "profiles": [ + { + "name": "adios", + "capacity": { + "minimum": "1", + "maximum": "10", + "default": "1" + }, + "rules": [ + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT1M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 10.0 + }, + "scaleAction": { + "direction": "Increase", + "type": "ChangeCount", + "value": "1", + "cooldown": "PT5M" + } + }, + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT2M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 15.0 + }, + "scaleAction": { + "direction": "Decrease", + "type": "ChangeCount", + "value": "2", + "cooldown": "PT6M" + } + } + ], + "fixedDate": { + "timeZone": "UTC", + "start": "2015-03-05T14:00:00Z", + "end": "2015-03-05T14:30:00Z" + } + }, + { + "name": "saludos", + "capacity": { + "minimum": "1", + "maximum": "10", + "default": "1" + }, + "rules": [ + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT1M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 10.0 + }, + "scaleAction": { + "direction": "Increase", + "type": "ChangeCount", + "value": "1", + "cooldown": "PT5M" + } + }, + { + "metricTrigger": { + "metricName": "Percentage CPU", + "metricResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain": "PT2M", + "statistic": "Average", + "timeWindow": "PT5M", + "timeAggregation": "Average", + "operator": "GreaterThan", + "threshold": 15.0 + }, + "scaleAction": { + "direction": "Decrease", + "type": "ChangeCount", + "value": "2", + "cooldown": "PT6M" + } + } + ], + "recurrence": { + "frequency": "Week", + "schedule": { + "timeZone": "UTC", + "days": [ + "1" + ], + "hours": [ + 5 + ], + "minutes": [ + 15 + ] + } + } + } + ], + "enabled": true, + "name": "MySetting", + "targetResourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "notifications": [ + { + "operation": "Scale", + "email": { + "sendToSubscriptionAdministrator": true, + "sendToSubscriptionCoAdministrators": true, + "customEmails": [ + "gu@ms.com", + "ge@ns.net" + ] + }, + "webhooks": [ + { + "serviceUri": "http://myservice.com", + "properties": {} + } + ] + } + ] + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/activityLogs_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/activityLogs_API.json index dc48b4c7fa06..5e645cee8e67 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/activityLogs_API.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/activityLogs_API.json @@ -36,7 +36,7 @@ } }, "paths": { - "/subscriptions/{subscriptionId}/providers/microsoft.insights/eventtypes/management/values": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Insights/eventtypes/management/values": { "get": { "tags": [ "ActivityLogs" diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/autoscale_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/autoscale_API.json index 4029ceb5d841..9d8575d0e87c 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/autoscale_API.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/autoscale_API.json @@ -36,7 +36,7 @@ } }, "paths": { - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.insights/autoscalesettings": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/autoscalesettings": { "get": { "description": "Lists the autoscale settings for a resource group", "tags": [ @@ -78,7 +78,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.insights/autoscalesettings/{autoscaleSettingName}": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/autoscalesettings/{autoscaleSettingName}": { "put": { "description": "Creates or updates an autoscale setting.", "tags": [ @@ -261,7 +261,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/microsoft.insights/autoscalesettings": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Insights/autoscalesettings": { "get": { "description": "Lists the autoscale settings for a subscription", "tags": [ @@ -386,6 +386,10 @@ "type": "string", "description": "the resource identifier of the resource the rule monitors." }, + "metricResourceLocation": { + "type": "string", + "description": "the location of the resource the rule monitors." + }, "timeGrain": { "type": "string", "format": "duration", @@ -398,7 +402,8 @@ "Average", "Min", "Max", - "Sum" + "Sum", + "Count" ], "x-ms-enum": { "name": "MetricStatisticType", @@ -487,7 +492,8 @@ "enum": [ "ChangeCount", "PercentChangeCount", - "ExactCount" + "ExactCount", + "ServiceAllowedNextValue" ], "x-ms-enum": { "name": "ScaleType", @@ -653,11 +659,13 @@ "properties": { "sendToSubscriptionAdministrator": { "type": "boolean", - "description": "a value indicating whether to send email to subscription administrator." + "description": "a value indicating whether to send email to subscription administrator.", + "default": false }, "sendToSubscriptionCoAdministrators": { "type": "boolean", - "description": "a value indicating whether to send email to subscription co-administrators." + "description": "a value indicating whether to send email to subscription co-administrators.", + "default": false }, "customEmails": { "type": "array", @@ -747,6 +755,10 @@ "targetResourceUri": { "type": "string", "description": "the resource identifier of the resource that the autoscale setting should be added to." + }, + "targetResourceLocation": { + "type": "string", + "description": "the location of the resource that the autoscale setting should be added to." } }, "description": "A setting that contains all of the configuration for the automatic scaling of a resource." diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/eventCategories_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/eventCategories_API.json index cfacfc35653f..564bd12e9d0b 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/eventCategories_API.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/eventCategories_API.json @@ -36,7 +36,7 @@ } }, "paths": { - "/providers/microsoft.insights/eventcategories": { + "/providers/Microsoft.Insights/eventcategories": { "get": { "tags": [ "EventCategories" diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json index 0a54dc2eae66..a05bca3254d1 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json @@ -36,7 +36,7 @@ } }, "paths": { - "/providers/microsoft.insights/operations": { + "/providers/Microsoft.Insights/operations": { "get": { "tags": [ "Operations" diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json index 8c2c24624270..de44ec195bb7 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json @@ -36,7 +36,7 @@ } }, "paths": { - "/providers/microsoft.insights/eventtypes/management/values": { + "/providers/Microsoft.Insights/eventtypes/management/values": { "get": { "tags": [ "TenantActivityLogs" diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/logProfiles_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/logProfiles_API.json index da57ac850e46..dd7c6175f17a 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/logProfiles_API.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/logProfiles_API.json @@ -36,7 +36,7 @@ } }, "paths": { - "/subscriptions/{subscriptionId}/providers/microsoft.insights/logprofiles/{logProfileName}": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Insights/logprofiles/{logProfileName}": { "delete": { "tags": [ "LogProfiles" @@ -186,7 +186,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/microsoft.insights/logprofiles": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Insights/logprofiles": { "get": { "tags": [ "LogProfiles" diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-06-01/examples/GetMetric.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-06-01/examples/GetMetric.json new file mode 100644 index 000000000000..222046abfa22 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-06-01/examples/GetMetric.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "resourceUri": "subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default", + "$filter": "(name.value eq 'BlobCapacity') and aggregationType eq 'Average' and timeGrain eq duration'PT30M' and startTime eq 2021-04-21T10:37:24.0000028Z and endTime eq 2021-04-22T01:26:59.0000795Z", + "api-version": "2016-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "data": [ + { + "timeStamp": "2021-04-21T10:37:00Z", + "average": 78278.125 + }, + { + "timeStamp": "2021-04-21T11:07:00Z" + }, + { + "timeStamp": "2021-04-21T11:37:00Z", + "average": 78278.125 + }, + { + "timeStamp": "2021-04-21T12:07:00Z" + }, + { + "timeStamp": "2021-04-21T12:37:00Z", + "average": 78278.125 + }, + { + "timeStamp": "2021-04-21T13:07:00Z" + }, + { + "timeStamp": "2021-04-21T13:37:00Z", + "average": 78278.125 + }, + { + "timeStamp": "2021-04-21T14:07:00Z" + }, + { + "timeStamp": "2021-04-21T14:37:00Z", + "average": 78278.125 + }, + { + "timeStamp": "2021-04-21T15:07:00Z" + }, + { + "timeStamp": "2021-04-21T15:37:00Z", + "average": 78278.125 + }, + { + "timeStamp": "2021-04-21T16:07:00Z" + }, + { + "timeStamp": "2021-04-21T16:37:00Z", + "average": 78278.125 + }, + { + "timeStamp": "2021-04-21T17:07:00Z" + }, + { + "timeStamp": "2021-04-21T17:37:00Z", + "average": 78278.125 + }, + { + "timeStamp": "2021-04-21T18:07:00Z" + }, + { + "timeStamp": "2021-04-21T18:37:00Z", + "average": 78278.125 + }, + { + "timeStamp": "2021-04-21T19:07:00Z" + }, + { + "timeStamp": "2021-04-21T19:37:00Z", + "average": 78278.125 + }, + { + "timeStamp": "2021-04-21T20:07:00Z" + }, + { + "timeStamp": "2021-04-21T20:37:00Z", + "average": 78278.125 + }, + { + "timeStamp": "2021-04-21T21:07:00Z" + }, + { + "timeStamp": "2021-04-21T21:37:00Z", + "average": 78278.125 + }, + { + "timeStamp": "2021-04-21T22:07:00Z" + }, + { + "timeStamp": "2021-04-21T22:37:00Z", + "average": 78278.125 + }, + { + "timeStamp": "2021-04-21T23:07:00Z" + }, + { + "timeStamp": "2021-04-21T23:37:00Z", + "average": 78278.125 + }, + { + "timeStamp": "2021-04-22T00:07:00Z" + }, + { + "timeStamp": "2021-04-22T00:37:00Z", + "average": 78278.125 + }, + { + "timeStamp": "2021-04-22T01:07:00Z" + } + ], + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default/providers/Microsoft.Insights/metrics/BlobCapacity", + "name": { + "value": "BlobCapacity", + "localizedValue": "Blob Capacity" + }, + "type": "Microsoft.Insights/metrics", + "unit": "1" + } + ] + } + }, + "default": { + "body": { + "code": "BadRequest", + "message": "only conditions of the form ' eq ' are allowed, where = 'timeGrain', 'startTime', 'endTime', 'name.value', 'aggregationType', 'debugRegion' : invalid filter" + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-06-01/examples/OperationList.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-06-01/examples/OperationList.json new file mode 100644 index 000000000000..cf002bc4da34 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-06-01/examples/OperationList.json @@ -0,0 +1,6886 @@ +{ + "parameters": { + "api-version": "2016-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Insights/Operations/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Operations", + "operation": "Read operations", + "description": "Read operations" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Metrics/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Action", + "operation": "Metric Action", + "description": "Metric Action" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MetricDefinitions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Definitions", + "operation": "Read metric definitions", + "description": "Read metric definitions" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MetricDefinitions/Microsoft.Insights/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Definitions", + "operation": "Read metric definitions", + "description": "Read metric definitions" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MetricDefinitions/providers/Microsoft.Insights/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Definitions", + "operation": "Read metric definitions", + "description": "Read metric definitions" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Metrics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metrics", + "operation": "Read metrics", + "description": "Read metrics" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Metricnamespaces/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric namespaces", + "operation": "Metric namespaces read", + "description": "Read metric namespaces" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Metrics/Write", + "isDataAction": true, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metrics", + "operation": "Write metrics", + "description": "Write metrics" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Metrics/providers/Metrics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metrics", + "operation": "Read metrics", + "description": "Read metrics" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Metrics/Microsoft.Insights/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metrics", + "operation": "Read metrics", + "description": "Read metrics" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AlertRules/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Classic Metric Alerts", + "operation": "Create or update classic metric alert", + "description": "Create or update a classic metric alert" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AlertRules/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Classic Metric Alerts", + "operation": "Delete classic metric alert", + "description": "Delete a classic metric alert" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AlertRules/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Classic Metric Alerts", + "operation": "Read classic metric alert", + "description": "Read a classic metric alert" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MetricAlerts/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Alerts", + "operation": "Create or update metric alert", + "description": "Create or update a metric alert" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MetricAlerts/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Alerts", + "operation": "Delete metric alert", + "description": "Delete a metric alert" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MetricAlerts/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Alerts", + "operation": "Read metric alert", + "description": "Read a metric alert" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MetricAlerts/Status/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Alerts", + "operation": "Read metric alert status", + "description": "Read metric alert status" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Autoscale Setting", + "operation": "Create or update autoscale setting", + "description": "Create or update an autoscale setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Autoscale Setting", + "operation": "Delete autoscale setting", + "description": "Delete an autoscale setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Autoscale Setting", + "operation": "Read autoscale setting", + "description": "Read an autoscale setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AlertRules/Incidents/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Alert Rule Incident resource", + "operation": "Read classic metric alert incidents", + "description": "Read a classic metric alert incident" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/providers/Microsoft.Insights/MetricDefinitions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Definitions", + "operation": "Read metric definitions", + "description": "Read metric definitions" + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "ObservedMetricValue", + "displayName": "Observed Metric Value", + "internalMetricName": null, + "displayDescription": "The value computed by autoscale when executed", + "unit": "Count", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": null, + "dimensions": [ + { + "name": "MetricTriggerSource", + "displayName": "Metric Trigger Source", + "toBeExportedForShoebox": true, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": null, + "lockAggregationType": null + }, + { + "name": "MetricThreshold", + "displayName": "Metric Threshold", + "internalMetricName": null, + "displayDescription": "The configured autoscale threshold when autoscale ran.", + "unit": "Count", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": null, + "dimensions": [ + { + "name": "MetricTriggerRule", + "displayName": "Metric Trigger Rule", + "toBeExportedForShoebox": true, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": null, + "lockAggregationType": null + }, + { + "name": "ObservedCapacity", + "displayName": "Observed Capacity", + "internalMetricName": null, + "displayDescription": "The capacity reported to autoscale when it executed.", + "unit": "Count", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": null, + "dimensions": null, + "supportedAggregationTypes": null, + "lockAggregationType": null + }, + { + "name": "ScaleActionsInitiated", + "displayName": "Scale Actions Initiated", + "internalMetricName": null, + "displayDescription": "The direction of the scale operation.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": null, + "fillGapWithZero": true, + "category": null, + "dimensions": [ + { + "name": "ScaleDirection", + "displayName": "Scale Direction", + "toBeExportedForShoebox": true, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": null, + "lockAggregationType": null + } + ], + "logSpecifications": null, + "legacyMetricSpecifications": null + } + } + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/providers/Microsoft.Insights/logDefinitions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Log Definitions", + "operation": "Log Definitions read", + "description": "Read log definitions" + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": null, + "logSpecifications": [ + { + "name": "AutoscaleEvaluations", + "displayName": "Autoscale Evaluations", + "blobDuration": "PT1H" + }, + { + "name": "AutoscaleScaleActions", + "displayName": "Autoscale Scale Actions", + "blobDuration": "PT1H" + } + ], + "legacyMetricSpecifications": null + } + } + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/providers/Microsoft.Insights/diagnosticSettings/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Resource diagnostic settings", + "operation": "Read resource diagnostic setting", + "description": "Read a resource diagnostic setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/providers/Microsoft.Insights/diagnosticSettings/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Resource diagnostic settings", + "operation": "Create or update resource diagnostic setting", + "description": "Create or update a resource diagnostic setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ActionGroups/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Action Groups", + "operation": "Create or update action group", + "description": "Create or update an action group" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ActionGroups/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Action Groups", + "operation": "Delete action group", + "description": "Delete an action group" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ActionGroups/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Action Groups", + "operation": "Read action group", + "description": "Read an action group" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ActivityLogAlerts/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Activity Log Alert", + "operation": "Create or update activity log alert", + "description": "Create or update an activity log alert" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ActivityLogAlerts/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Activity Log Alert", + "operation": "Delete activity log alert", + "description": "Delete an activity log alert" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ActivityLogAlerts/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Activity Log Alert", + "operation": "Read activity log alert", + "description": "Read an activity log alert" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ActivityLogAlerts/Activated/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Activity Log Alert", + "operation": "Activity Log Alert activated", + "description": "Activity Log Alert activated" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/EventCategories/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Activity Log event category", + "operation": "Read Activity Log event categories", + "description": "Read available Activity Log event categories" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/eventtypes/values/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Activity Log Events", + "operation": "Read Activity Log", + "description": "Read Activity Log events" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/eventtypes/digestevents/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Digest events", + "operation": "Event types management digest read", + "description": "Read management event type digest" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DiagnosticSettings/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Resource diagnostic settings", + "operation": "Create or update resource diagnostic setting", + "description": "Create or update a resource diagnostic setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DiagnosticSettingsCategories/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Diagnostic settings categories resource", + "operation": "Read diagnostic settings categories", + "description": "Read diagnostic settings categories" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DiagnosticSettings/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Resource diagnostic settings", + "operation": "Delete resource diagnostic setting", + "description": "Delete a resource diagnostic setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DiagnosticSettings/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Resource diagnostic settings", + "operation": "Read resource diagnostic setting", + "description": "Read a resource diagnostic setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ExtendedDiagnosticSettings/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Network flow log diagnostic setting", + "operation": "Create or update network flow log diagnostic setting", + "description": "Create or update a network flow log diagnostic setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ExtendedDiagnosticSettings/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Network flow log diagnostic setting", + "operation": "Delete network flow log diagnostic setting", + "description": "Delete a network flow log diagnostic setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ExtendedDiagnosticSettings/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Network flow log diagnostic setting", + "operation": "Read network flow log diagnostic setting", + "description": "Read a network flow log diagnostic setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/LogProfiles/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Log Profiles", + "operation": "Create or update Activity Log log profile", + "description": "Create or update an Activity Log log profile" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/LogProfiles/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Log Profiles", + "operation": "Delete Activity Log log profile", + "description": "Delete an Activity Log log profile" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/LogProfiles/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Log Profiles", + "operation": "Read Activity Log log profile", + "description": "Read an Activity Log log profile" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/LogDefinitions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Log Definitions", + "operation": "Log Definitions read", + "description": "Read log definitions" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/Scaleup/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Autoscale Setting", + "operation": "Autoscale scale up initiated", + "description": "Autoscale scale up initiated" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/Scaledown/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Autoscale Setting", + "operation": "Autoscale scale down initiated", + "description": "Autoscale scale down initiated" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/ScaleupResult/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Autoscale Setting", + "operation": "Autoscale scale up completed", + "description": "Autoscale scale up completed" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/ScaledownResult/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Autoscale Setting", + "operation": "Autoscale scale down completed", + "description": "Autoscale scale down completed" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AlertRules/Activated/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Classic Metric Alerts", + "operation": "Classic metric alert activated", + "description": "Classic metric alert activated" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AlertRules/Resolved/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Classic Metric Alerts", + "operation": "Classic metric alert resolved", + "description": "Classic metric alert resolved" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AlertRules/Throttled/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Classic Metric Alerts", + "operation": "Classic metric alert rule throttled", + "description": "Classic metric alert rule throttled" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Register/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Microsoft.Insights", + "operation": "Register Microsoft.Insights", + "description": "Register the Microsoft Insights provider" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Unregister/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Microsoft.Insights", + "operation": "Register Microsoft.Insights", + "description": "Register the Microsoft Insights provider" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Tenants/Register/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Microsoft.Insights", + "operation": "Initialize Microsoft.Insights", + "description": "Initializes the Microsoft Insights provider" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/AnalyticsItems/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights analytics item", + "operation": "Application Insights analytics item delete", + "description": "Deleting an Application Insights analytics item" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/AnalyticsItems/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights analytics item", + "operation": "Application Insights analytics item read", + "description": "Reading an Application Insights analytics item" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/AnalyticsItems/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights analytics item", + "operation": "Application Insights analytics item write", + "description": "Writing an Application Insights analytics item" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/MyAnalyticsItems/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights analytics item", + "operation": "Application Insights personal analytics item delete", + "description": "Deleting an Application Insights personal analytics item" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/MyAnalyticsItems/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights analytics item", + "operation": "Application Insights personal analytics item write", + "description": "Writing an Application Insights personal analytics item" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/MyAnalyticsItems/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights analytics item", + "operation": "Application Insights personal analytics item read", + "description": "Reading an Application Insights personal analytics item" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/AnalyticsTables/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights analytics table", + "operation": "Application Insights analytics table action", + "description": "Application Insights analytics table action" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/AnalyticsTables/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights analytics table", + "operation": "Application Insights analytics table delete", + "description": "Deleting an Application Insights analytics table schema" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/AnalyticsTables/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights analytics table", + "operation": "Application Insights analytics table read", + "description": "Reading an Application Insights analytics table schema" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/AnalyticsTables/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights analytics table", + "operation": "Application Insights analytics table write", + "description": "Writing an Application Insights analytics table schema" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Annotations/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights annotations", + "operation": "Application Insights annotations delete", + "description": "Deleting an Application Insights annotation" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Annotations/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights annotations", + "operation": "Application Insights annotations read", + "description": "Reading an Application Insights annotation" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Annotations/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights annotations", + "operation": "Application Insights annotation write", + "description": "Writing an Application Insights annotation" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/ApiKeys/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights API key", + "operation": "Application Insights API key delete", + "description": "Deleting an Application Insights API key" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/ApiKeys/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights API key", + "operation": "Application Insights API key read", + "description": "Reading an Application Insights API key" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/ApiKeys/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights API key", + "operation": "Application Insights API key generate", + "description": "Generating an Application Insights API key" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Purge/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights Purge", + "operation": "Application Insights Purge Data action", + "description": "Purging data from Application Insights" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Operations/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights Operations", + "operation": "Application Insights Operations read", + "description": "Get status of long-running operations in Application Insights" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Events/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights Events", + "operation": "Application Insights Events read", + "description": "Get logs from Application Insights using OData query format" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Query/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights Query", + "operation": "Application Insights Query read", + "description": "Run queries against Application Insights logs" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/BillingPlanForComponent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Billing plan for Application Insights component", + "operation": "Billing plan for Application Insights component read", + "description": "Reading a billing plan for Application Insights component" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/CurrentBillingFeatures/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Current billing features for Application Insights component", + "operation": "Current billing features for Application Insights component read", + "description": "Reading current billing features for Application Insights component" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/CurrentBillingFeatures/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Current billing features for Application Insights component", + "operation": "Current billing features for Application Insights component write", + "description": "Writing current billing features for Application Insights component" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/FeatureCapabilities/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component feature capabilities", + "operation": "Application Insights component feature capabilities read", + "description": "Reading Application Insights component feature capabilities" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/GetAvailableBillingFeatures/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component available billing features", + "operation": "Application Insights component available billing features read", + "description": "Reading Application Insights component available billing features" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/PricingPlans/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component pricing plan", + "operation": "Application Insights component pricing plan read", + "description": "Reading an Application Insights component pricing plan" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/PricingPlans/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component pricing plan", + "operation": "Application Insights component pricing plan write", + "description": "Writing an Application Insights component pricing plan" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/QuotaStatus/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component quota status", + "operation": "Application Insights component quota status read", + "description": "Reading Application Insights component quota status" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/DailyCapReached/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component daily cap reached", + "operation": "Application Insights component daily cap reached", + "description": "Reached the daily cap for Application Insights component" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/DailyCapWarningThresholdReached/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component daily cap warning threshold reached", + "operation": "Application Insights component daily cap warning threshold reached", + "description": "Reached the daily cap warning threshold for Application Insights component" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application insights components", + "operation": "Application insights component write", + "description": "Writing to an application insights component configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application insights components", + "operation": "Application insights component delete", + "description": "Deleting an application insights component configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application insights components", + "operation": "Application insights component read", + "description": "Reading an application insights component configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Api/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component data API", + "operation": "Application Insights component data API read", + "description": "Reading Application Insights component data API" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/ExtendQueries/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component extended query results", + "operation": "Application Insights component extended query results read", + "description": "Reading Application Insights component extended query results" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/GetToken/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component token", + "operation": "Application Insights component token read", + "description": "Reading an Application Insights component token" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/MetricDefinitions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component metric definitions", + "operation": "Application Insights component metric definitions read", + "description": "Reading Application Insights component metric definitions" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Metrics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component metrics", + "operation": "Application Insights component metrics read", + "description": "Reading Application Insights component metrics" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/providers/Microsoft.Insights/logDefinitions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Log Definitions", + "operation": "Log Definitions read", + "description": "Read log definitions" + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": null, + "logSpecifications": [ + { + "name": "AppAvailabilityResults", + "displayName": "Availability results", + "blobDuration": "PT1H" + }, + { + "name": "AppBrowserTimings", + "displayName": "Browser timings", + "blobDuration": "PT1H" + }, + { + "name": "AppEvents", + "displayName": "Events", + "blobDuration": "PT1H" + }, + { + "name": "AppMetrics", + "displayName": "Metrics", + "blobDuration": "PT1H" + }, + { + "name": "AppDependencies", + "displayName": "Dependencies", + "blobDuration": "PT1H" + }, + { + "name": "AppExceptions", + "displayName": "Exceptions", + "blobDuration": "PT1H" + }, + { + "name": "AppPageViews", + "displayName": "Page views", + "blobDuration": "PT1H" + }, + { + "name": "AppPerformanceCounters", + "displayName": "Performance counters", + "blobDuration": "PT1H" + }, + { + "name": "AppRequests", + "displayName": "Requests", + "blobDuration": "PT1H" + }, + { + "name": "AppSystemEvents", + "displayName": "System events", + "blobDuration": "PT1H" + }, + { + "name": "AppTraces", + "displayName": "Traces", + "blobDuration": "PT1H" + } + ], + "legacyMetricSpecifications": null + } + } + }, + { + "name": "Microsoft.Insights/Components/providers/Microsoft.Insights/diagnosticSettings/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Resource diagnostic settings", + "operation": "Read resource diagnostic setting", + "description": "Read a resource diagnostic setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/providers/Microsoft.Insights/diagnosticSettings/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Resource diagnostic settings", + "operation": "Create or update resource diagnostic setting", + "description": "Create or update a resource diagnostic setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/ExportConfiguration/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights export settings", + "operation": "Application Insights export settings action", + "description": "Application Insights export settings action" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/ExportConfiguration/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights export settings", + "operation": "Application Insights export settings delete", + "description": "Deleting Application Insights export settings" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/ExportConfiguration/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights export settings", + "operation": "Application Insights export settings read", + "description": "Reading Application Insights export settings" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/ExportConfiguration/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights export settings", + "operation": "Application Insights export settings write", + "description": "Writing Application Insights export settings" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Favorites/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights favorites", + "operation": "Application Insights favorites delete", + "description": "Deleting an Application Insights favorite" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Favorites/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights favorites", + "operation": "Application Insights favorites read", + "description": "Reading an Application Insights favorite" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Favorites/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights favorites", + "operation": "Application Insights favorite write", + "description": "Writing an Application Insights favorite" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/MyFavorites/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights favorites", + "operation": "Application Insights personal favorites read", + "description": "Reading an Application Insights personal favorite" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/generateLiveToken/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights Live Metrics token", + "operation": "Get Live Metrics token", + "description": "Live Metrics get token" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/providers/Microsoft.Insights/MetricDefinitions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Definitions", + "operation": "Read metric definitions", + "description": "Read metric definitions" + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "availabilityResults/availabilityPercentage", + "displayName": "Availability", + "internalMetricName": null, + "displayDescription": "Percentage of successfully completed availability tests", + "unit": "Percent", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Availability", + "dimensions": [ + { + "name": "availabilityResult/name", + "displayName": "Test name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "availabilityResult/location", + "displayName": "Run location", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average" + ], + "lockAggregationType": null + }, + { + "name": "availabilityResults/count", + "displayName": "Availability tests", + "internalMetricName": "availabilityResults/duration", + "displayDescription": "Count of availability tests", + "unit": "Count", + "aggregationType": "Count", + "availabilities": null, + "fillGapWithZero": true, + "category": "Availability", + "dimensions": [ + { + "name": "availabilityResult/name", + "displayName": "Test name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "availabilityResult/location", + "displayName": "Run location", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "availabilityResult/success", + "displayName": "Test result", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Count" + ], + "lockAggregationType": null + }, + { + "name": "availabilityResults/duration", + "displayName": "Availability test duration", + "internalMetricName": null, + "displayDescription": "Availability test duration", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Availability", + "dimensions": [ + { + "name": "availabilityResult/name", + "displayName": "Test name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "availabilityResult/location", + "displayName": "Run location", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "availabilityResult/success", + "displayName": "Test result", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "browserTimings/networkDuration", + "displayName": "Page load network connect time", + "internalMetricName": null, + "displayDescription": "Time between user request and network connection. Includes DNS lookup and transport connection.", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Browser", + "dimensions": null, + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "browserTimings/processingDuration", + "displayName": "Client processing time", + "internalMetricName": null, + "displayDescription": "Time between receiving the last byte of a document until the DOM is loaded. Async requests may still be processing.", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Browser", + "dimensions": null, + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "browserTimings/receiveDuration", + "displayName": "Receiving response time", + "internalMetricName": null, + "displayDescription": "Time between the first and last bytes, or until disconnection.", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Browser", + "dimensions": null, + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "browserTimings/sendDuration", + "displayName": "Send request time", + "internalMetricName": null, + "displayDescription": "Time between network connection and receiving the first byte.", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Browser", + "dimensions": null, + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "browserTimings/totalDuration", + "displayName": "Browser page load time", + "internalMetricName": null, + "displayDescription": "Time from user request until DOM, stylesheets, scripts and images are loaded.", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Browser", + "dimensions": null, + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "dependencies/count", + "displayName": "Dependency calls", + "internalMetricName": "dependencies/duration", + "displayDescription": "Count of calls made by the application to external resources.", + "unit": "Count", + "aggregationType": "Count", + "availabilities": null, + "fillGapWithZero": true, + "category": "Server", + "dimensions": [ + { + "name": "dependency/type", + "displayName": "Dependency type", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/performanceBucket", + "displayName": "Dependency performance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/success", + "displayName": "Successful call", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/target", + "displayName": "Target of a dependency call", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/resultCode", + "displayName": "Result code", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "operation/synthetic", + "displayName": "Is traffic synthetic", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Count" + ], + "lockAggregationType": null + }, + { + "name": "dependencies/duration", + "displayName": "Dependency duration", + "internalMetricName": null, + "displayDescription": "Duration of calls made by the application to external resources.", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Server", + "dimensions": [ + { + "name": "dependency/type", + "displayName": "Dependency type", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/performanceBucket", + "displayName": "Dependency performance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/success", + "displayName": "Successful call", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/target", + "displayName": "Target of a dependency call", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/resultCode", + "displayName": "Result code", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "operation/synthetic", + "displayName": "Is traffic synthetic", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "dependencies/failed", + "displayName": "Dependency call failures", + "internalMetricName": "dependencies/duration", + "displayDescription": "Count of failed dependency calls made by the application to external resources.", + "unit": "Count", + "aggregationType": "Count", + "availabilities": null, + "fillGapWithZero": true, + "category": "Failures", + "dimensions": [ + { + "name": "dependency/type", + "displayName": "Dependency type", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/performanceBucket", + "displayName": "Dependency performance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/success", + "displayName": "Successful call", + "toBeExportedForShoebox": false, + "isHidden": true, + "defaultDimensionValues": [ + { + "value": "False" + } + ] + }, + { + "name": "dependency/target", + "displayName": "Target of a dependency call", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/resultCode", + "displayName": "Result code", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "operation/synthetic", + "displayName": "Is traffic synthetic", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Count" + ], + "lockAggregationType": null + }, + { + "name": "pageViews/count", + "displayName": "Page views", + "internalMetricName": null, + "displayDescription": "Count of page views.", + "unit": "Count", + "aggregationType": "Count", + "availabilities": null, + "fillGapWithZero": true, + "category": "Usage", + "dimensions": [ + { + "name": "operation/synthetic", + "displayName": "Is traffic synthetic", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Count" + ], + "lockAggregationType": null + }, + { + "name": "pageViews/duration", + "displayName": "Page view load time", + "internalMetricName": null, + "displayDescription": "Page view load time", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Usage", + "dimensions": [ + { + "name": "operation/synthetic", + "displayName": "Is traffic synthetic", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "performanceCounters/requestExecutionTime", + "displayName": "HTTP request execution time", + "internalMetricName": null, + "displayDescription": "Execution time of the most recent request.", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Performance counters", + "dimensions": [ + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "performanceCounters/requestsInQueue", + "displayName": "HTTP requests in application queue", + "internalMetricName": null, + "displayDescription": "Length of the application request queue.", + "unit": "Count", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": true, + "category": "Performance counters", + "dimensions": [ + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "performanceCounters/requestsPerSecond", + "displayName": "HTTP request rate", + "internalMetricName": null, + "displayDescription": "Rate of all requests to the application per second from ASP.NET.", + "unit": "CountPerSecond", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": true, + "category": "Performance counters", + "dimensions": [ + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "performanceCounters/exceptionsPerSecond", + "displayName": "Exception rate", + "internalMetricName": null, + "displayDescription": "Count of handled and unhandled exceptions reported to windows, including .NET exceptions and unmanaged exceptions that are converted into .NET exceptions.", + "unit": "CountPerSecond", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": true, + "category": "Performance counters", + "dimensions": [ + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "performanceCounters/processIOBytesPerSecond", + "displayName": "Process IO rate", + "internalMetricName": null, + "displayDescription": "Total bytes per second read and written to files, network and devices.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Performance counters", + "dimensions": [ + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "performanceCounters/processCpuPercentage", + "displayName": "Process CPU", + "internalMetricName": null, + "displayDescription": "The percentage of elapsed time that all process threads used the processor to execute instructions. This can vary between 0 to 100. This metric indicates the performance of w3wp process alone.", + "unit": "Percent", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Performance counters", + "dimensions": [ + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "performanceCounters/processorCpuPercentage", + "displayName": "Processor time", + "internalMetricName": null, + "displayDescription": "The percentage of time that the processor spends in non-idle threads.", + "unit": "Percent", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Performance counters", + "dimensions": [ + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "performanceCounters/memoryAvailableBytes", + "displayName": "Available memory", + "internalMetricName": null, + "displayDescription": "Physical memory immediately available for allocation to a process or for system use.", + "unit": "Bytes", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Performance counters", + "dimensions": [ + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "performanceCounters/processPrivateBytes", + "displayName": "Process private bytes", + "internalMetricName": null, + "displayDescription": "Memory exclusively assigned to the monitored application's processes.", + "unit": "Bytes", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Performance counters", + "dimensions": [ + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "requests/duration", + "displayName": "Server response time", + "internalMetricName": null, + "displayDescription": "Time between receiving an HTTP request and finishing sending the response.", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Server", + "dimensions": [ + { + "name": "request/performanceBucket", + "displayName": "Request performance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "request/resultCode", + "displayName": "Result code", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "operation/synthetic", + "displayName": "Is traffic synthetic", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "request/success", + "displayName": "Successful request", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "requests/count", + "displayName": "Server requests", + "internalMetricName": "requests/duration", + "displayDescription": "Count of HTTP requests completed.", + "unit": "Count", + "aggregationType": "Count", + "availabilities": null, + "fillGapWithZero": true, + "category": "Server", + "dimensions": [ + { + "name": "request/performanceBucket", + "displayName": "Request performance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "request/resultCode", + "displayName": "Result code", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "operation/synthetic", + "displayName": "Is traffic synthetic", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "request/success", + "displayName": "Successful request", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Count" + ], + "lockAggregationType": null + }, + { + "name": "requests/failed", + "displayName": "Failed requests", + "internalMetricName": "requests/duration", + "displayDescription": "Count of HTTP requests marked as failed. In most cases these are requests with a response code >= 400 and not equal to 401.", + "unit": "Count", + "aggregationType": "Count", + "availabilities": null, + "fillGapWithZero": true, + "category": "Failures", + "dimensions": [ + { + "name": "request/performanceBucket", + "displayName": "Request performance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "request/resultCode", + "displayName": "Result code", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "request/success", + "displayName": "Successful request", + "toBeExportedForShoebox": false, + "isHidden": true, + "defaultDimensionValues": [ + { + "value": "False" + } + ] + }, + { + "name": "operation/synthetic", + "displayName": "Is traffic synthetic", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Count" + ], + "lockAggregationType": null + }, + { + "name": "requests/rate", + "displayName": "Server request rate", + "internalMetricName": null, + "displayDescription": "Rate of server requests per second", + "unit": "CountPerSecond", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": true, + "category": "Server", + "dimensions": [ + { + "name": "request/performanceBucket", + "displayName": "Request performance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "request/resultCode", + "displayName": "Result code", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "operation/synthetic", + "displayName": "Is traffic synthetic", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "request/success", + "displayName": "Successful request", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average" + ], + "lockAggregationType": "Average" + }, + { + "name": "exceptions/count", + "displayName": "Exceptions", + "internalMetricName": null, + "displayDescription": "Combined count of all uncaught exceptions.", + "unit": "Count", + "aggregationType": "Count", + "availabilities": null, + "fillGapWithZero": true, + "category": "Failures", + "dimensions": [ + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "client/type", + "displayName": "Device type", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Count" + ], + "lockAggregationType": null + }, + { + "name": "exceptions/browser", + "displayName": "Browser exceptions", + "internalMetricName": "exceptions/count", + "displayDescription": "Count of uncaught exceptions thrown in the browser.", + "unit": "Count", + "aggregationType": "Count", + "availabilities": null, + "fillGapWithZero": true, + "category": "Failures", + "dimensions": [ + { + "name": "client/isServer", + "displayName": null, + "toBeExportedForShoebox": false, + "isHidden": true, + "defaultDimensionValues": [ + { + "value": "False" + } + ] + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Count" + ], + "lockAggregationType": null + }, + { + "name": "exceptions/server", + "displayName": "Server exceptions", + "internalMetricName": "exceptions/count", + "displayDescription": "Count of uncaught exceptions thrown in the server application.", + "unit": "Count", + "aggregationType": "Count", + "availabilities": null, + "fillGapWithZero": true, + "category": "Failures", + "dimensions": [ + { + "name": "client/isServer", + "displayName": null, + "toBeExportedForShoebox": false, + "isHidden": true, + "defaultDimensionValues": [ + { + "value": "True" + } + ] + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Count" + ], + "lockAggregationType": null + }, + { + "name": "traces/count", + "displayName": "Traces", + "internalMetricName": null, + "displayDescription": "Trace document count", + "unit": "Count", + "aggregationType": "Count", + "availabilities": null, + "fillGapWithZero": true, + "category": "Usage", + "dimensions": [ + { + "name": "trace/severityLevel", + "displayName": "Severity level", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "operation/synthetic", + "displayName": "Is traffic synthetic", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Count" + ], + "lockAggregationType": null + } + ], + "logSpecifications": null, + "legacyMetricSpecifications": null + } + } + }, + { + "name": "Microsoft.Insights/Components/ProactiveDetectionConfigs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights proactive detection configuration", + "operation": "Application Insights proactive detection configuration read", + "description": "Reading Application Insights proactive detection configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/ProactiveDetectionConfigs/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights proactive detection configuration", + "operation": "Application Insights proactive detection configuration read", + "description": "Writing Application Insights proactive detection configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/SyntheticMonitorLocations/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights webtest location", + "operation": "Application Insights webtest locations read", + "description": "Reading Application Insights webtest locations" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Webtests/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Web tests", + "operation": "Webtest read", + "description": "Reading a webtest configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Webtests/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Web tests", + "operation": "Webtest write", + "description": "Writing to a webtest configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Webtests/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Web tests", + "operation": "Webtest delete", + "description": "Deleting a webtest configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Webtests/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Web tests", + "operation": "Webtest read", + "description": "Reading a webtest configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Webtests/GetToken/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Webtest token", + "operation": "Webtest token read", + "description": "Reading a webtest token" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Webtests/MetricDefinitions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Webtest metric definitions", + "operation": "Webtest metric definitions read", + "description": "Reading a webtest metric definitions" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Webtests/Metrics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Webtest metrics", + "operation": "Webtest metrics read", + "description": "Reading a webtest metrics" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/WorkItemConfigs/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights ALM integration configuration", + "operation": "Application Insights ALM integration configuration delete", + "description": "Deleting an Application Insights ALM integration configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/WorkItemConfigs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights ALM integration configuration", + "operation": "Application Insights ALM integration configuration read", + "description": "Reading an Application Insights ALM integration configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/WorkItemConfigs/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights ALM integration configuration", + "operation": "Application Insights ALM integration configuration write", + "description": "Writing an Application Insights ALM integration configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/DefaultWorkItemConfig/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights ALM integration configuration", + "operation": "Application Insights default ALM integration configuration read", + "description": "Reading an Application Insights default ALM integration configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Move/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application insights components", + "operation": "Application Insights Component Move", + "description": "Move an Application Insights Component to another resource group or subscription" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ListMigrationDate/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "List Migration Date", + "operation": "Subscription migration date read", + "description": "Get back subscription migration date" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ListMigrationDate/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "List Migration Date", + "operation": "Subscription migration date read", + "description": "Get back Subscription migration date" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MigrateToNewpricingModel/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Migrate to new pricing model", + "operation": "Migrate subscription to new pricing model action", + "description": "Migrate subscription to new pricing model" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/RollbackToLegacyPricingModel/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Rollback legacy pricing model", + "operation": "Rollback subscription to legacy pricing model action", + "description": "Rollback subscription to legacy pricing model" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/topology/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights Topology", + "operation": "Read Topology", + "description": "Read Topology" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/transactions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights Transactions", + "operation": "Read Transactions", + "description": "Read Transactions" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ScheduledQueryRules/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Scheduled query rule", + "operation": "Scheduled query rule write", + "description": "Writing a scheduled query rule" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ScheduledQueryRules/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Scheduled query rule", + "operation": "Scheduled query rule read", + "description": "Reading a scheduled query rule" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ScheduledQueryRules/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Scheduled query rule", + "operation": "Scheduled query rule delete", + "description": "Deleting a scheduled query rule" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Logs", + "operation": "Read Logs", + "description": "Reading data from all your logs" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AADDomainServicesAccountLogon/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AADDomainServicesAccountLogon", + "operation": "Read AADDomainServicesAccountLogon data", + "description": "Read data from the AADDomainServicesAccountLogon table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AADDomainServicesAccountManagement/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AADDomainServicesAccountManagement", + "operation": "Read AADDomainServicesAccountManagement data", + "description": "Read data from the AADDomainServicesAccountManagement table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AADDomainServicesDirectoryServiceAccess/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AADDomainServicesDirectoryServiceAccess", + "operation": "Read AADDomainServicesDirectoryServiceAccess data", + "description": "Read data from the AADDomainServicesDirectoryServiceAccess table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AADDomainServicesLogonLogoff/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AADDomainServicesLogonLogoff", + "operation": "Read AADDomainServicesLogonLogoff data", + "description": "Read data from the AADDomainServicesLogonLogoff table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AADDomainServicesPolicyChange/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AADDomainServicesPolicyChange", + "operation": "Read AADDomainServicesPolicyChange data", + "description": "Read data from the AADDomainServicesPolicyChange table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AADDomainServicesPrivilegeUse/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AADDomainServicesPrivilegeUse", + "operation": "Read AADDomainServicesPrivilegeUse data", + "description": "Read data from the AADDomainServicesPrivilegeUse table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AADDomainServicesSystemSecurity/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AADDomainServicesSystemSecurity", + "operation": "Read AADDomainServicesSystemSecurity data", + "description": "Read data from the AADDomainServicesSystemSecurity table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AADManagedIdentitySignInLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AADManagedIdentitySignInLogs", + "operation": "Read AADManagedIdentitySignInLogs data", + "description": "Read data from the AADManagedIdentitySignInLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AADNonInteractiveUserSignInLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AADNonInteractiveUserSignInLogs", + "operation": "Read AADNonInteractiveUserSignInLogs data", + "description": "Read data from the AADNonInteractiveUserSignInLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AADServicePrincipalSignInLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AADServicePrincipalSignInLogs", + "operation": "Read AADServicePrincipalSignInLogs data", + "description": "Read data from the AADServicePrincipalSignInLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADAssessmentRecommendation", + "operation": "Read ADAssessmentRecommendation data", + "description": "Read data from the ADAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AddonAzureBackupAlerts/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AddonAzureBackupAlerts", + "operation": "Read AddonAzureBackupAlerts data", + "description": "Read data from the AddonAzureBackupAlerts table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AddonAzureBackupJobs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AddonAzureBackupJobs", + "operation": "Read AddonAzureBackupJobs data", + "description": "Read data from the AddonAzureBackupJobs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AddonAzureBackupPolicy/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AddonAzureBackupPolicy", + "operation": "Read AddonAzureBackupPolicy data", + "description": "Read data from the AddonAzureBackupPolicy table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AddonAzureBackupProtectedInstance/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AddonAzureBackupProtectedInstance", + "operation": "Read AddonAzureBackupProtectedInstance data", + "description": "Read data from the AddonAzureBackupProtectedInstance table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AddonAzureBackupStorage/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AddonAzureBackupStorage", + "operation": "Read AddonAzureBackupStorage data", + "description": "Read data from the AddonAzureBackupStorage table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADFActivityRun/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADFActivityRun", + "operation": "Read ADFActivityRun data", + "description": "Read data from the ADFActivityRun table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADFPipelineRun/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADFPipelineRun", + "operation": "Read ADFPipelineRun data", + "description": "Read data from the ADFPipelineRun table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADFSSISIntegrationRuntimeLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADFSSISIntegrationRuntimeLogs", + "operation": "Read ADFSSISIntegrationRuntimeLogs data", + "description": "Read data from the ADFSSISIntegrationRuntimeLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADFSSISPackageEventMessageContext/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADFSSISPackageEventMessageContext", + "operation": "Read ADFSSISPackageEventMessageContext data", + "description": "Read data from the ADFSSISPackageEventMessageContext table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADFSSISPackageEventMessages/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADFSSISPackageEventMessages", + "operation": "Read ADFSSISPackageEventMessages data", + "description": "Read data from the ADFSSISPackageEventMessages table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADFSSISPackageExecutableStatistics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADFSSISPackageExecutableStatistics", + "operation": "Read ADFSSISPackageExecutableStatistics data", + "description": "Read data from the ADFSSISPackageExecutableStatistics table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADFSSISPackageExecutionComponentPhases/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADFSSISPackageExecutionComponentPhases", + "operation": "Read ADFSSISPackageExecutionComponentPhases data", + "description": "Read data from the ADFSSISPackageExecutionComponentPhases table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADFSSISPackageExecutionDataStatistics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADFSSISPackageExecutionDataStatistics", + "operation": "Read ADFSSISPackageExecutionDataStatistics data", + "description": "Read data from the ADFSSISPackageExecutionDataStatistics table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADFTriggerRun/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADFTriggerRun", + "operation": "Read ADFTriggerRun data", + "description": "Read data from the ADFTriggerRun table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADReplicationResult/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADReplicationResult", + "operation": "Read ADReplicationResult data", + "description": "Read data from the ADReplicationResult table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADSecurityAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADSecurityAssessmentRecommendation", + "operation": "Read ADSecurityAssessmentRecommendation data", + "description": "Read data from the ADSecurityAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADTDigitalTwinsOperation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADTDigitalTwinsOperation", + "operation": "Read ADTDigitalTwinsOperation data", + "description": "Read data from the ADTDigitalTwinsOperation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADTEventRoutesOperation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADTEventRoutesOperation", + "operation": "Read ADTEventRoutesOperation data", + "description": "Read data from the ADTEventRoutesOperation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADTModelsOperation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADTModelsOperation", + "operation": "Read ADTModelsOperation data", + "description": "Read data from the ADTModelsOperation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADTQueryOperation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADTQueryOperation", + "operation": "Read ADTQueryOperation data", + "description": "Read data from the ADTQueryOperation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AegDeliveryFailureLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AegDeliveryFailureLogs", + "operation": "Read AegDeliveryFailureLogs data", + "description": "Read data from the AegDeliveryFailureLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AegPublishFailureLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AegPublishFailureLogs", + "operation": "Read AegPublishFailureLogs data", + "description": "Read data from the AegPublishFailureLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Alert/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Alert", + "operation": "Read Alert data", + "description": "Read data from the Alert table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AlertHistory/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AlertHistory", + "operation": "Read AlertHistory data", + "description": "Read data from the AlertHistory table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AmlComputeClusterEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AmlComputeClusterEvent", + "operation": "Read AmlComputeClusterEvent data", + "description": "Read data from the AmlComputeClusterEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AmlComputeClusterNodeEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AmlComputeClusterNodeEvent", + "operation": "Read AmlComputeClusterNodeEvent data", + "description": "Read data from the AmlComputeClusterNodeEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AmlComputeCpuGpuUtilization/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AmlComputeCpuGpuUtilization", + "operation": "Read AmlComputeCpuGpuUtilization data", + "description": "Read data from the AmlComputeCpuGpuUtilization table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AmlComputeJobEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AmlComputeJobEvent", + "operation": "Read AmlComputeJobEvent data", + "description": "Read data from the AmlComputeJobEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AmlRunStatusChangedEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AmlRunStatusChangedEvent", + "operation": "Read AmlRunStatusChangedEvent data", + "description": "Read data from the AmlRunStatusChangedEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ApiManagementGatewayLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ApiManagementGatewayLogs", + "operation": "Read ApiManagementGatewayLogs data", + "description": "Read data from the ApiManagementGatewayLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppAvailabilityResults/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppAvailabilityResults", + "operation": "Read AppAvailabilityResults data", + "description": "Read data from the AppAvailabilityResults table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppBrowserTimings/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppBrowserTimings", + "operation": "Read AppBrowserTimings data", + "description": "Read data from the AppBrowserTimings table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppCenterError/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppCenterError", + "operation": "Read AppCenterError data", + "description": "Read data from the AppCenterError table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppDependencies/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppDependencies", + "operation": "Read AppDependencies data", + "description": "Read data from the AppDependencies table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppEvents/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppEvents", + "operation": "Read AppEvents data", + "description": "Read data from the AppEvents table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppExceptions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppExceptions", + "operation": "Read AppExceptions data", + "description": "Read data from the AppExceptions table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ApplicationInsights/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ApplicationInsights", + "operation": "Read ApplicationInsights data", + "description": "Read data from the ApplicationInsights table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppMetrics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppMetrics", + "operation": "Read AppMetrics data", + "description": "Read data from the AppMetrics table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppPageViews/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppPageViews", + "operation": "Read AppPageViews data", + "description": "Read data from the AppPageViews table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppPerformanceCounters/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppPerformanceCounters", + "operation": "Read AppPerformanceCounters data", + "description": "Read data from the AppPerformanceCounters table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppPlatformLogsforSpring/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppPlatformLogsforSpring", + "operation": "Read AppPlatformLogsforSpring data", + "description": "Read data from the AppPlatformLogsforSpring table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppPlatformSystemLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppPlatformSystemLogs", + "operation": "Read AppPlatformSystemLogs data", + "description": "Read data from the AppPlatformSystemLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppRequests/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppRequests", + "operation": "Read AppRequests data", + "description": "Read data from the AppRequests table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppServiceAntivirusScanLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppServiceAntivirusScanLogs", + "operation": "Read AppServiceAntivirusScanLogs data", + "description": "Read data from the AppServiceAntivirusScanLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppServiceAppLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppServiceAppLogs", + "operation": "Read AppServiceAppLogs data", + "description": "Read data from the AppServiceAppLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppServiceAuditLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppServiceAuditLogs", + "operation": "Read AppServiceAuditLogs data", + "description": "Read data from the AppServiceAuditLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppServiceConsoleLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppServiceConsoleLogs", + "operation": "Read AppServiceConsoleLogs data", + "description": "Read data from the AppServiceConsoleLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppServiceEnvironmentPlatformLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppServiceEnvironmentPlatformLogs", + "operation": "Read AppServiceEnvironmentPlatformLogs data", + "description": "Read data from the AppServiceEnvironmentPlatformLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppServiceFileAuditLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppServiceFileAuditLogs", + "operation": "Read AppServiceFileAuditLogs data", + "description": "Read data from the AppServiceFileAuditLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppServiceHTTPLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppServiceHTTPLogs", + "operation": "Read AppServiceHTTPLogs data", + "description": "Read data from the AppServiceHTTPLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppServicePlatformLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppServicePlatformLogs", + "operation": "Read AppServicePlatformLogs data", + "description": "Read data from the AppServicePlatformLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppSystemEvents/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppSystemEvents", + "operation": "Read AppSystemEvents data", + "description": "Read data from the AppSystemEvents table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppTraces/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppTraces", + "operation": "Read AppTraces data", + "description": "Read data from the AppTraces table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AuditLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AuditLogs", + "operation": "Read AuditLogs data", + "description": "Read data from the AuditLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AutoscaleEvaluationsLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AutoscaleEvaluationsLog", + "operation": "Read AutoscaleEvaluationsLog data", + "description": "Read data from the AutoscaleEvaluationsLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AutoscaleScaleActionsLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AutoscaleScaleActionsLog", + "operation": "Read AutoscaleScaleActionsLog data", + "description": "Read data from the AutoscaleScaleActionsLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AWSCloudTrail/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AWSCloudTrail", + "operation": "Read AWSCloudTrail data", + "description": "Read data from the AWSCloudTrail table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AzureActivity/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AzureActivity", + "operation": "Read AzureActivity data", + "description": "Read data from the AzureActivity table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AzureAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AzureAssessmentRecommendation", + "operation": "Read AzureAssessmentRecommendation data", + "description": "Read data from the AzureAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AzureDevOpsAuditing/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AzureDevOpsAuditing", + "operation": "Read AzureDevOpsAuditing data", + "description": "Read data from the AzureDevOpsAuditing table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AzureDiagnostics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AzureDiagnostics", + "operation": "Read AzureDiagnostics data", + "description": "Read data from the AzureDiagnostics table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AzureMetrics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AzureMetrics", + "operation": "Read AzureMetrics data", + "description": "Read data from the AzureMetrics table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/BaiClusterEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "BaiClusterEvent", + "operation": "Read BaiClusterEvent data", + "description": "Read data from the BaiClusterEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/BaiClusterNodeEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "BaiClusterNodeEvent", + "operation": "Read BaiClusterNodeEvent data", + "description": "Read data from the BaiClusterNodeEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/BaiJobEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "BaiJobEvent", + "operation": "Read BaiJobEvent data", + "description": "Read data from the BaiJobEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/BehaviorAnalytics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "BehaviorAnalytics", + "operation": "Read BehaviorAnalytics data", + "description": "Read data from the BehaviorAnalytics table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/BlockchainApplicationLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "BlockchainApplicationLog", + "operation": "Read BlockchainApplicationLog data", + "description": "Read data from the BlockchainApplicationLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/BlockchainProxyLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "BlockchainProxyLog", + "operation": "Read BlockchainProxyLog data", + "description": "Read data from the BlockchainProxyLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/BoundPort/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "BoundPort", + "operation": "Read BoundPort data", + "description": "Read data from the BoundPort table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/CommonSecurityLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "CommonSecurityLog", + "operation": "Read CommonSecurityLog data", + "description": "Read data from the CommonSecurityLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ComputerGroup/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ComputerGroup", + "operation": "Read ComputerGroup data", + "description": "Read data from the ComputerGroup table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ConfigurationChange/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ConfigurationChange", + "operation": "Read ConfigurationChange data", + "description": "Read data from the ConfigurationChange table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ConfigurationData/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ConfigurationData", + "operation": "Read ConfigurationData data", + "description": "Read data from the ConfigurationData table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ContainerImageInventory/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ContainerImageInventory", + "operation": "Read ContainerImageInventory data", + "description": "Read data from the ContainerImageInventory table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ContainerInventory/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ContainerInventory", + "operation": "Read ContainerInventory data", + "description": "Read data from the ContainerInventory table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ContainerLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ContainerLog", + "operation": "Read ContainerLog data", + "description": "Read data from the ContainerLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ContainerNodeInventory/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ContainerNodeInventory", + "operation": "Read ContainerNodeInventory data", + "description": "Read data from the ContainerNodeInventory table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ContainerRegistryLoginEvents/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ContainerRegistryLoginEvents", + "operation": "Read ContainerRegistryLoginEvents data", + "description": "Read data from the ContainerRegistryLoginEvents table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ContainerRegistryRepositoryEvents/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ContainerRegistryRepositoryEvents", + "operation": "Read ContainerRegistryRepositoryEvents data", + "description": "Read data from the ContainerRegistryRepositoryEvents table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ContainerServiceLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ContainerServiceLog", + "operation": "Read ContainerServiceLog data", + "description": "Read data from the ContainerServiceLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Tables.Custom/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "CustomLogs", + "operation": "Read Custom Logs", + "description": "Reading data from any custom log" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/CoreAzureBackup/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "CoreAzureBackup", + "operation": "Read CoreAzureBackup data", + "description": "Read data from the CoreAzureBackup table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksAccounts/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksAccounts", + "operation": "Read DatabricksAccounts data", + "description": "Read data from the DatabricksAccounts table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksClusters/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksClusters", + "operation": "Read DatabricksClusters data", + "description": "Read data from the DatabricksClusters table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksDBFS/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksDBFS", + "operation": "Read DatabricksDBFS data", + "description": "Read data from the DatabricksDBFS table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksInstancePools/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksInstancePools", + "operation": "Read DatabricksInstancePools data", + "description": "Read data from the DatabricksInstancePools table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksJobs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksJobs", + "operation": "Read DatabricksJobs data", + "description": "Read data from the DatabricksJobs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksNotebook/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksNotebook", + "operation": "Read DatabricksNotebook data", + "description": "Read data from the DatabricksNotebook table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksSecrets/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksSecrets", + "operation": "Read DatabricksSecrets data", + "description": "Read data from the DatabricksSecrets table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksSQLPermissions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksSQLPermissions", + "operation": "Read DatabricksSQLPermissions data", + "description": "Read data from the DatabricksSQLPermissions table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksSSH/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksSSH", + "operation": "Read DatabricksSSH data", + "description": "Read data from the DatabricksSSH table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksTables/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksTables", + "operation": "Read DatabricksTables data", + "description": "Read data from the DatabricksTables table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksWorkspace/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksWorkspace", + "operation": "Read DatabricksWorkspace data", + "description": "Read data from the DatabricksWorkspace table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceAppCrash/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceAppCrash", + "operation": "Read DeviceAppCrash data", + "description": "Read data from the DeviceAppCrash table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceAppLaunch/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceAppLaunch", + "operation": "Read DeviceAppLaunch data", + "description": "Read data from the DeviceAppLaunch table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceCalendar/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceCalendar", + "operation": "Read DeviceCalendar data", + "description": "Read data from the DeviceCalendar table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceCleanup/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceCleanup", + "operation": "Read DeviceCleanup data", + "description": "Read data from the DeviceCleanup table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceConnectSession/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceConnectSession", + "operation": "Read DeviceConnectSession data", + "description": "Read data from the DeviceConnectSession table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceEtw/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceEtw", + "operation": "Read DeviceEtw data", + "description": "Read data from the DeviceEtw table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceHardwareHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceHardwareHealth", + "operation": "Read DeviceHardwareHealth data", + "description": "Read data from the DeviceHardwareHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceHealth", + "operation": "Read DeviceHealth data", + "description": "Read data from the DeviceHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceHeartbeat/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceHeartbeat", + "operation": "Read DeviceHeartbeat data", + "description": "Read data from the DeviceHeartbeat table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceSkypeHeartbeat/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceSkypeHeartbeat", + "operation": "Read DeviceSkypeHeartbeat data", + "description": "Read data from the DeviceSkypeHeartbeat table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceSkypeSignIn/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceSkypeSignIn", + "operation": "Read DeviceSkypeSignIn data", + "description": "Read data from the DeviceSkypeSignIn table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceSleepState/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceSleepState", + "operation": "Read DeviceSleepState data", + "description": "Read data from the DeviceSleepState table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DHAppFailure/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DHAppFailure", + "operation": "Read DHAppFailure data", + "description": "Read data from the DHAppFailure table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DHAppReliability/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DHAppReliability", + "operation": "Read DHAppReliability data", + "description": "Read data from the DHAppReliability table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DHCPActivity/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DHCPActivity", + "operation": "Read DHCPActivity data", + "description": "Read data from the DHCPActivity table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DHDriverReliability/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DHDriverReliability", + "operation": "Read DHDriverReliability data", + "description": "Read data from the DHDriverReliability table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DHLogonFailures/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DHLogonFailures", + "operation": "Read DHLogonFailures data", + "description": "Read data from the DHLogonFailures table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DHLogonMetrics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DHLogonMetrics", + "operation": "Read DHLogonMetrics data", + "description": "Read data from the DHLogonMetrics table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DHOSCrashData/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DHOSCrashData", + "operation": "Read DHOSCrashData data", + "description": "Read data from the DHOSCrashData table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DHOSReliability/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DHOSReliability", + "operation": "Read DHOSReliability data", + "description": "Read data from the DHOSReliability table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DHWipAppLearning/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DHWipAppLearning", + "operation": "Read DHWipAppLearning data", + "description": "Read data from the DHWipAppLearning table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DnsEvents/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DnsEvents", + "operation": "Read DnsEvents data", + "description": "Read data from the DnsEvents table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DnsInventory/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DnsInventory", + "operation": "Read DnsInventory data", + "description": "Read data from the DnsInventory table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Dynamics365Activity/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Dynamics365Activity", + "operation": "Read Dynamics365Activity data", + "description": "Read data from the Dynamics365Activity table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ETWEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ETWEvent", + "operation": "Read ETWEvent data", + "description": "Read data from the ETWEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Event/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Event", + "operation": "Read Event data", + "description": "Read data from the Event table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ExchangeAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ExchangeAssessmentRecommendation", + "operation": "Read ExchangeAssessmentRecommendation data", + "description": "Read data from the ExchangeAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ExchangeOnlineAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ExchangeOnlineAssessmentRecommendation", + "operation": "Read ExchangeOnlineAssessmentRecommendation data", + "description": "Read data from the ExchangeOnlineAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/FailedIngestion/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "FailedIngestion", + "operation": "Read FailedIngestion data", + "description": "Read data from the FailedIngestion table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/FunctionAppLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "FunctionAppLogs", + "operation": "Read FunctionAppLogs data", + "description": "Read data from the FunctionAppLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Heartbeat/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Heartbeat", + "operation": "Read Heartbeat data", + "description": "Read data from the Heartbeat table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/HuntingBookmark/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "HuntingBookmark", + "operation": "Read HuntingBookmark data", + "description": "Read data from the HuntingBookmark table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/IISAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "IISAssessmentRecommendation", + "operation": "Read IISAssessmentRecommendation data", + "description": "Read data from the IISAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/InboundConnection/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "InboundConnection", + "operation": "Read InboundConnection data", + "description": "Read data from the InboundConnection table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/InsightsMetrics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "InsightsMetrics", + "operation": "Read InsightsMetrics data", + "description": "Read data from the InsightsMetrics table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/IntuneAuditLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "IntuneAuditLogs", + "operation": "Read IntuneAuditLogs data", + "description": "Read data from the IntuneAuditLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/IntuneDeviceComplianceOrg/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "IntuneDeviceComplianceOrg", + "operation": "Read IntuneDeviceComplianceOrg data", + "description": "Read data from the IntuneDeviceComplianceOrg table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/IntuneOperationalLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "IntuneOperationalLogs", + "operation": "Read IntuneOperationalLogs data", + "description": "Read data from the IntuneOperationalLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/IoTHubDistributedTracing/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "IoTHubDistributedTracing", + "operation": "Read IoTHubDistributedTracing data", + "description": "Read data from the IoTHubDistributedTracing table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/KubeEvents/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "KubeEvents", + "operation": "Read KubeEvents data", + "description": "Read data from the KubeEvents table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/KubeHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "KubeHealth", + "operation": "Read KubeHealth data", + "description": "Read data from the KubeHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/KubeMonAgentEvents/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "KubeMonAgentEvents", + "operation": "Read KubeMonAgentEvents data", + "description": "Read data from the KubeMonAgentEvents table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/KubeNodeInventory/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "KubeNodeInventory", + "operation": "Read KubeNodeInventory data", + "description": "Read data from the KubeNodeInventory table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/KubePodInventory/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "KubePodInventory", + "operation": "Read KubePodInventory data", + "description": "Read data from the KubePodInventory table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/KubeServices/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "KubeServices", + "operation": "Read KubeServices data", + "description": "Read data from the KubeServices table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/LinuxAuditLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "LinuxAuditLog", + "operation": "Read LinuxAuditLog data", + "description": "Read data from the LinuxAuditLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAApplication/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAApplication", + "operation": "Read MAApplication data", + "description": "Read data from the MAApplication table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAApplicationHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAApplicationHealth", + "operation": "Read MAApplicationHealth data", + "description": "Read data from the MAApplicationHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAApplicationHealthAlternativeVersions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAApplicationHealthAlternativeVersions", + "operation": "Read MAApplicationHealthAlternativeVersions data", + "description": "Read data from the MAApplicationHealthAlternativeVersions table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAApplicationHealthIssues/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAApplicationHealthIssues", + "operation": "Read MAApplicationHealthIssues data", + "description": "Read data from the MAApplicationHealthIssues table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAApplicationInstance/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAApplicationInstance", + "operation": "Read MAApplicationInstance data", + "description": "Read data from the MAApplicationInstance table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAApplicationInstanceReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAApplicationInstanceReadiness", + "operation": "Read MAApplicationInstanceReadiness data", + "description": "Read data from the MAApplicationInstanceReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAApplicationReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAApplicationReadiness", + "operation": "Read MAApplicationReadiness data", + "description": "Read data from the MAApplicationReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MADeploymentPlan/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MADeploymentPlan", + "operation": "Read MADeploymentPlan data", + "description": "Read data from the MADeploymentPlan table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MADevice/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MADevice", + "operation": "Read MADevice data", + "description": "Read data from the MADevice table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MADeviceNotEnrolled/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MADeviceNotEnrolled", + "operation": "Read MADeviceNotEnrolled data", + "description": "Read data from the MADeviceNotEnrolled table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MADeviceNRT/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MADeviceNRT", + "operation": "Read MADeviceNRT data", + "description": "Read data from the MADeviceNRT table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MADevicePnPHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MADevicePnPHealth", + "operation": "Read MADevicePnPHealth data", + "description": "Read data from the MADevicePnPHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MADevicePnPHealthAlternativeVersions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MADevicePnPHealthAlternativeVersions", + "operation": "Read MADevicePnPHealthAlternativeVersions data", + "description": "Read data from the MADevicePnPHealthAlternativeVersions table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MADevicePnPHealthIssues/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MADevicePnPHealthIssues", + "operation": "Read MADevicePnPHealthIssues data", + "description": "Read data from the MADevicePnPHealthIssues table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MADeviceReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MADeviceReadiness", + "operation": "Read MADeviceReadiness data", + "description": "Read data from the MADeviceReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MADriverInstanceReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MADriverInstanceReadiness", + "operation": "Read MADriverInstanceReadiness data", + "description": "Read data from the MADriverInstanceReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MADriverReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MADriverReadiness", + "operation": "Read MADriverReadiness data", + "description": "Read data from the MADriverReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAddin/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAddin", + "operation": "Read MAOfficeAddin data", + "description": "Read data from the MAOfficeAddin table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAddinEntityHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAddinEntityHealth", + "operation": "Read MAOfficeAddinEntityHealth data", + "description": "Read data from the MAOfficeAddinEntityHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAddinHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAddinHealth", + "operation": "Read MAOfficeAddinHealth data", + "description": "Read data from the MAOfficeAddinHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAddinHealthEventNRT/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAddinHealthEventNRT", + "operation": "Read MAOfficeAddinHealthEventNRT data", + "description": "Read data from the MAOfficeAddinHealthEventNRT table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAddinHealthIssues/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAddinHealthIssues", + "operation": "Read MAOfficeAddinHealthIssues data", + "description": "Read data from the MAOfficeAddinHealthIssues table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAddinInstance/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAddinInstance", + "operation": "Read MAOfficeAddinInstance data", + "description": "Read data from the MAOfficeAddinInstance table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAddinInstanceReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAddinInstanceReadiness", + "operation": "Read MAOfficeAddinInstanceReadiness data", + "description": "Read data from the MAOfficeAddinInstanceReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAddinReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAddinReadiness", + "operation": "Read MAOfficeAddinReadiness data", + "description": "Read data from the MAOfficeAddinReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeApp/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeApp", + "operation": "Read MAOfficeApp data", + "description": "Read data from the MAOfficeApp table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAppCrashesNRT/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAppCrashesNRT", + "operation": "Read MAOfficeAppCrashesNRT data", + "description": "Read data from the MAOfficeAppCrashesNRT table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAppHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAppHealth", + "operation": "Read MAOfficeAppHealth data", + "description": "Read data from the MAOfficeAppHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAppInstance/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAppInstance", + "operation": "Read MAOfficeAppInstance data", + "description": "Read data from the MAOfficeAppInstance table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAppInstanceHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAppInstanceHealth", + "operation": "Read MAOfficeAppInstanceHealth data", + "description": "Read data from the MAOfficeAppInstanceHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAppReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAppReadiness", + "operation": "Read MAOfficeAppReadiness data", + "description": "Read data from the MAOfficeAppReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAppSessionsNRT/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAppSessionsNRT", + "operation": "Read MAOfficeAppSessionsNRT data", + "description": "Read data from the MAOfficeAppSessionsNRT table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeBuildInfo/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeBuildInfo", + "operation": "Read MAOfficeBuildInfo data", + "description": "Read data from the MAOfficeBuildInfo table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeCurrencyAssessment/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeCurrencyAssessment", + "operation": "Read MAOfficeCurrencyAssessment data", + "description": "Read data from the MAOfficeCurrencyAssessment table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeCurrencyAssessmentDailyCounts/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeCurrencyAssessmentDailyCounts", + "operation": "Read MAOfficeCurrencyAssessmentDailyCounts data", + "description": "Read data from the MAOfficeCurrencyAssessmentDailyCounts table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeDeploymentStatus/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeDeploymentStatus", + "operation": "Read MAOfficeDeploymentStatus data", + "description": "Read data from the MAOfficeDeploymentStatus table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeDeploymentStatusNRT/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeDeploymentStatusNRT", + "operation": "Read MAOfficeDeploymentStatusNRT data", + "description": "Read data from the MAOfficeDeploymentStatusNRT table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeMacroErrorNRT/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeMacroErrorNRT", + "operation": "Read MAOfficeMacroErrorNRT data", + "description": "Read data from the MAOfficeMacroErrorNRT table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeMacroGlobalHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeMacroGlobalHealth", + "operation": "Read MAOfficeMacroGlobalHealth data", + "description": "Read data from the MAOfficeMacroGlobalHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeMacroHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeMacroHealth", + "operation": "Read MAOfficeMacroHealth data", + "description": "Read data from the MAOfficeMacroHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeMacroHealthIssues/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeMacroHealthIssues", + "operation": "Read MAOfficeMacroHealthIssues data", + "description": "Read data from the MAOfficeMacroHealthIssues table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeMacroIssueInstanceReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeMacroIssueInstanceReadiness", + "operation": "Read MAOfficeMacroIssueInstanceReadiness data", + "description": "Read data from the MAOfficeMacroIssueInstanceReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeMacroIssueReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeMacroIssueReadiness", + "operation": "Read MAOfficeMacroIssueReadiness data", + "description": "Read data from the MAOfficeMacroIssueReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeMacroSummary/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeMacroSummary", + "operation": "Read MAOfficeMacroSummary data", + "description": "Read data from the MAOfficeMacroSummary table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeSuite/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeSuite", + "operation": "Read MAOfficeSuite data", + "description": "Read data from the MAOfficeSuite table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeSuiteInstance/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeSuiteInstance", + "operation": "Read MAOfficeSuiteInstance data", + "description": "Read data from the MAOfficeSuiteInstance table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAProposedPilotDevices/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAProposedPilotDevices", + "operation": "Read MAProposedPilotDevices data", + "description": "Read data from the MAProposedPilotDevices table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAWindowsBuildInfo/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAWindowsBuildInfo", + "operation": "Read MAWindowsBuildInfo data", + "description": "Read data from the MAWindowsBuildInfo table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAWindowsCurrencyAssessment/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAWindowsCurrencyAssessment", + "operation": "Read MAWindowsCurrencyAssessment data", + "description": "Read data from the MAWindowsCurrencyAssessment table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAWindowsCurrencyAssessmentDailyCounts/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAWindowsCurrencyAssessmentDailyCounts", + "operation": "Read MAWindowsCurrencyAssessmentDailyCounts data", + "description": "Read data from the MAWindowsCurrencyAssessmentDailyCounts table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAWindowsDeploymentStatus/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAWindowsDeploymentStatus", + "operation": "Read MAWindowsDeploymentStatus data", + "description": "Read data from the MAWindowsDeploymentStatus table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAWindowsDeploymentStatusNRT/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAWindowsDeploymentStatusNRT", + "operation": "Read MAWindowsDeploymentStatusNRT data", + "description": "Read data from the MAWindowsDeploymentStatusNRT table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAWindowsSysReqInstanceReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAWindowsSysReqInstanceReadiness", + "operation": "Read MAWindowsSysReqInstanceReadiness data", + "description": "Read data from the MAWindowsSysReqInstanceReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/McasShadowItReporting/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "McasShadowItReporting", + "operation": "Read McasShadowItReporting data", + "description": "Read data from the McasShadowItReporting table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MicrosoftAzureBastionAuditLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MicrosoftAzureBastionAuditLogs", + "operation": "Read MicrosoftAzureBastionAuditLogs data", + "description": "Read data from the MicrosoftAzureBastionAuditLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MicrosoftDataShareReceivedSnapshotLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MicrosoftDataShareReceivedSnapshotLog", + "operation": "Read MicrosoftDataShareReceivedSnapshotLog data", + "description": "Read data from the MicrosoftDataShareReceivedSnapshotLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MicrosoftDataShareSentSnapshotLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MicrosoftDataShareSentSnapshotLog", + "operation": "Read MicrosoftDataShareSentSnapshotLog data", + "description": "Read data from the MicrosoftDataShareSentSnapshotLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MicrosoftDataShareShareLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MicrosoftDataShareShareLog", + "operation": "Read MicrosoftDataShareShareLog data", + "description": "Read data from the MicrosoftDataShareShareLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MicrosoftDynamicsTelemetryPerformanceLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MicrosoftDynamicsTelemetryPerformanceLogs", + "operation": "Read MicrosoftDynamicsTelemetryPerformanceLogs data", + "description": "Read data from the MicrosoftDynamicsTelemetryPerformanceLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MicrosoftDynamicsTelemetrySystemMetricsLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MicrosoftDynamicsTelemetrySystemMetricsLogs", + "operation": "Read MicrosoftDynamicsTelemetrySystemMetricsLogs data", + "description": "Read data from the MicrosoftDynamicsTelemetrySystemMetricsLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MicrosoftHealthcareApisAuditLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MicrosoftHealthcareApisAuditLogs", + "operation": "Read MicrosoftHealthcareApisAuditLogs data", + "description": "Read data from the MicrosoftHealthcareApisAuditLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/NetworkMonitoring/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "NetworkMonitoring", + "operation": "Read NetworkMonitoring data", + "description": "Read data from the NetworkMonitoring table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/OfficeActivity/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "OfficeActivity", + "operation": "Read OfficeActivity data", + "description": "Read data from the OfficeActivity table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Operation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Operation", + "operation": "Read Operation data", + "description": "Read data from the Operation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/OutboundConnection/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "OutboundConnection", + "operation": "Read OutboundConnection data", + "description": "Read data from the OutboundConnection table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Perf/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Perf", + "operation": "Read Perf data", + "description": "Read data from the Perf table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ProtectionStatus/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ProtectionStatus", + "operation": "Read ProtectionStatus data", + "description": "Read data from the ProtectionStatus table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ReservedAzureCommonFields/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ReservedAzureCommonFields", + "operation": "Read ReservedAzureCommonFields data", + "description": "Read data from the ReservedAzureCommonFields table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ReservedCommonFields/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ReservedCommonFields", + "operation": "Read ReservedCommonFields data", + "description": "Read data from the ReservedCommonFields table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SCCMAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SCCMAssessmentRecommendation", + "operation": "Read SCCMAssessmentRecommendation data", + "description": "Read data from the SCCMAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SCOMAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SCOMAssessmentRecommendation", + "operation": "Read SCOMAssessmentRecommendation data", + "description": "Read data from the SCOMAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SecurityAlert/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SecurityAlert", + "operation": "Read SecurityAlert data", + "description": "Read data from the SecurityAlert table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SecurityBaseline/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SecurityBaseline", + "operation": "Read SecurityBaseline data", + "description": "Read data from the SecurityBaseline table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SecurityBaselineSummary/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SecurityBaselineSummary", + "operation": "Read SecurityBaselineSummary data", + "description": "Read data from the SecurityBaselineSummary table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SecurityDetection/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SecurityDetection", + "operation": "Read SecurityDetection data", + "description": "Read data from the SecurityDetection table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SecurityEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SecurityEvent", + "operation": "Read SecurityEvent data", + "description": "Read data from the SecurityEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SecurityIncident/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SecurityIncident", + "operation": "Read SecurityIncident data", + "description": "Read data from the SecurityIncident table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SecurityIoTRawEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SecurityIoTRawEvent", + "operation": "Read SecurityIoTRawEvent data", + "description": "Read data from the SecurityIoTRawEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SecurityNestedRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SecurityNestedRecommendation", + "operation": "Read SecurityNestedRecommendation data", + "description": "Read data from the SecurityNestedRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SecurityRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SecurityRecommendation", + "operation": "Read SecurityRecommendation data", + "description": "Read data from the SecurityRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ServiceFabricOperationalEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ServiceFabricOperationalEvent", + "operation": "Read ServiceFabricOperationalEvent data", + "description": "Read data from the ServiceFabricOperationalEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ServiceFabricReliableActorEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ServiceFabricReliableActorEvent", + "operation": "Read ServiceFabricReliableActorEvent data", + "description": "Read data from the ServiceFabricReliableActorEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ServiceFabricReliableServiceEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ServiceFabricReliableServiceEvent", + "operation": "Read ServiceFabricReliableServiceEvent data", + "description": "Read data from the ServiceFabricReliableServiceEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SfBAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SfBAssessmentRecommendation", + "operation": "Read SfBAssessmentRecommendation data", + "description": "Read data from the SfBAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SfBOnlineAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SfBOnlineAssessmentRecommendation", + "operation": "Read SfBOnlineAssessmentRecommendation data", + "description": "Read data from the SfBOnlineAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SharePointOnlineAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SharePointOnlineAssessmentRecommendation", + "operation": "Read SharePointOnlineAssessmentRecommendation data", + "description": "Read data from the SharePointOnlineAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SignalRServiceDiagnosticLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SignalRServiceDiagnosticLogs", + "operation": "Read SignalRServiceDiagnosticLogs data", + "description": "Read data from the SignalRServiceDiagnosticLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SigninLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SigninLogs", + "operation": "Read SigninLogs data", + "description": "Read data from the SigninLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SPAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SPAssessmentRecommendation", + "operation": "Read SPAssessmentRecommendation data", + "description": "Read data from the SPAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SQLAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SQLAssessmentRecommendation", + "operation": "Read SQLAssessmentRecommendation data", + "description": "Read data from the SQLAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SqlDataClassification/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SqlDataClassification", + "operation": "Read SqlDataClassification data", + "description": "Read data from the SqlDataClassification table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SQLQueryPerformance/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SQLQueryPerformance", + "operation": "Read SQLQueryPerformance data", + "description": "Read data from the SQLQueryPerformance table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SqlVulnerabilityAssessmentResult/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SqlVulnerabilityAssessmentResult", + "operation": "Read SqlVulnerabilityAssessmentResult data", + "description": "Read data from the SqlVulnerabilityAssessmentResult table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/StorageBlobLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "StorageBlobLogs", + "operation": "Read StorageBlobLogs data", + "description": "Read data from the StorageBlobLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/StorageFileLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "StorageFileLogs", + "operation": "Read StorageFileLogs data", + "description": "Read data from the StorageFileLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/StorageQueueLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "StorageQueueLogs", + "operation": "Read StorageQueueLogs data", + "description": "Read data from the StorageQueueLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/StorageTableLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "StorageTableLogs", + "operation": "Read StorageTableLogs data", + "description": "Read data from the StorageTableLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SucceededIngestion/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SucceededIngestion", + "operation": "Read SucceededIngestion data", + "description": "Read data from the SucceededIngestion table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Syslog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Syslog", + "operation": "Read Syslog data", + "description": "Read data from the Syslog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SysmonEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SysmonEvent", + "operation": "Read SysmonEvent data", + "description": "Read data from the SysmonEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ThreatIntelligenceIndicator/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ThreatIntelligenceIndicator", + "operation": "Read ThreatIntelligenceIndicator data", + "description": "Read data from the ThreatIntelligenceIndicator table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/TSIIngress/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "TSIIngress", + "operation": "Read TSIIngress data", + "description": "Read data from the TSIIngress table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UAApp/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UAApp", + "operation": "Read UAApp data", + "description": "Read data from the UAApp table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UAComputer/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UAComputer", + "operation": "Read UAComputer data", + "description": "Read data from the UAComputer table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UAComputerRank/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UAComputerRank", + "operation": "Read UAComputerRank data", + "description": "Read data from the UAComputerRank table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UADriver/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UADriver", + "operation": "Read UADriver data", + "description": "Read data from the UADriver table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UADriverProblemCodes/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UADriverProblemCodes", + "operation": "Read UADriverProblemCodes data", + "description": "Read data from the UADriverProblemCodes table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UAFeedback/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UAFeedback", + "operation": "Read UAFeedback data", + "description": "Read data from the UAFeedback table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UAHardwareSecurity/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UAHardwareSecurity", + "operation": "Read UAHardwareSecurity data", + "description": "Read data from the UAHardwareSecurity table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UAIESiteDiscovery/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UAIESiteDiscovery", + "operation": "Read UAIESiteDiscovery data", + "description": "Read data from the UAIESiteDiscovery table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UAOfficeAddIn/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UAOfficeAddIn", + "operation": "Read UAOfficeAddIn data", + "description": "Read data from the UAOfficeAddIn table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UAProposedActionPlan/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UAProposedActionPlan", + "operation": "Read UAProposedActionPlan data", + "description": "Read data from the UAProposedActionPlan table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UASysReqIssue/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UASysReqIssue", + "operation": "Read UASysReqIssue data", + "description": "Read data from the UASysReqIssue table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UAUpgradedComputer/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UAUpgradedComputer", + "operation": "Read UAUpgradedComputer data", + "description": "Read data from the UAUpgradedComputer table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Update/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Update", + "operation": "Read Update data", + "description": "Read data from the Update table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UpdateRunProgress/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UpdateRunProgress", + "operation": "Read UpdateRunProgress data", + "description": "Read data from the UpdateRunProgress table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UpdateSummary/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UpdateSummary", + "operation": "Read UpdateSummary data", + "description": "Read data from the UpdateSummary table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Usage/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Usage", + "operation": "Read Usage data", + "description": "Read data from the Usage table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UserAccessAnalytics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UserAccessAnalytics", + "operation": "Read UserAccessAnalytics data", + "description": "Read data from the UserAccessAnalytics table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UserPeerAnalytics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UserPeerAnalytics", + "operation": "Read UserPeerAnalytics data", + "description": "Read data from the UserPeerAnalytics table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/VMBoundPort/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "VMBoundPort", + "operation": "Read VMBoundPort data", + "description": "Read data from the VMBoundPort table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/VMComputer/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "VMComputer", + "operation": "Read VMComputer data", + "description": "Read data from the VMComputer table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/VMConnection/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "VMConnection", + "operation": "Read VMConnection data", + "description": "Read data from the VMConnection table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/VMProcess/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "VMProcess", + "operation": "Read VMProcess data", + "description": "Read data from the VMProcess table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/W3CIISLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "W3CIISLog", + "operation": "Read W3CIISLog data", + "description": "Read data from the W3CIISLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WaaSDeploymentStatus/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WaaSDeploymentStatus", + "operation": "Read WaaSDeploymentStatus data", + "description": "Read data from the WaaSDeploymentStatus table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WaaSInsiderStatus/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WaaSInsiderStatus", + "operation": "Read WaaSInsiderStatus data", + "description": "Read data from the WaaSInsiderStatus table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WaaSUpdateStatus/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WaaSUpdateStatus", + "operation": "Read WaaSUpdateStatus data", + "description": "Read data from the WaaSUpdateStatus table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WDAVStatus/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WDAVStatus", + "operation": "Read WDAVStatus data", + "description": "Read data from the WDAVStatus table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WDAVThreat/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WDAVThreat", + "operation": "Read WDAVThreat data", + "description": "Read data from the WDAVThreat table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WindowsClientAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WindowsClientAssessmentRecommendation", + "operation": "Read WindowsClientAssessmentRecommendation data", + "description": "Read data from the WindowsClientAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WindowsEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WindowsEvent", + "operation": "Read WindowsEvent data", + "description": "Read data from the WindowsEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WindowsFirewall/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WindowsFirewall", + "operation": "Read WindowsFirewall data", + "description": "Read data from the WindowsFirewall table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WindowsServerAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WindowsServerAssessmentRecommendation", + "operation": "Read WindowsServerAssessmentRecommendation data", + "description": "Read data from the WindowsServerAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WireData/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WireData", + "operation": "Read WireData data", + "description": "Read data from the WireData table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WorkloadMonitoringPerf/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WorkloadMonitoringPerf", + "operation": "Read WorkloadMonitoringPerf data", + "description": "Read data from the WorkloadMonitoringPerf table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WUDOAggregatedStatus/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WUDOAggregatedStatus", + "operation": "Read WUDOAggregatedStatus data", + "description": "Read data from the WUDOAggregatedStatus table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WUDOStatus/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WUDOStatus", + "operation": "Read WUDOStatus data", + "description": "Read data from the WUDOStatus table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WVDCheckpoints/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WVDCheckpoints", + "operation": "Read WVDCheckpoints data", + "description": "Read data from the WVDCheckpoints table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WVDConnections/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WVDConnections", + "operation": "Read WVDConnections data", + "description": "Read data from the WVDConnections table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WVDErrors/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WVDErrors", + "operation": "Read WVDErrors data", + "description": "Read data from the WVDErrors table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WVDFeeds/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WVDFeeds", + "operation": "Read WVDFeeds data", + "description": "Read data from the WVDFeeds table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WVDHostRegistrations/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WVDHostRegistrations", + "operation": "Read WVDHostRegistrations data", + "description": "Read data from the WVDHostRegistrations table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WVDManagement/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WVDManagement", + "operation": "Read WVDManagement data", + "description": "Read data from the WVDManagement table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Baseline/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Baseline", + "operation": "Read metric baseline", + "description": "Read a metric baseline (preview)" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/CalculateBaseline/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Baseline", + "operation": "Calculate baseline", + "description": "Calculate baseline for metric values (preview)" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MetricBaselines/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Baseline", + "operation": "Read metric baselines", + "description": "Read metric baselines" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionRules/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection rule", + "operation": "Read data collection rule", + "description": "Read a data collection rule" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionRules/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection rule", + "operation": "Create or update data collection rule", + "description": "Create or update a data collection rule" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionRules/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection rule", + "operation": "Delete data collection rule", + "description": "Delete a data collection rule" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionRules/Data/Write", + "isDataAction": true, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection rule", + "operation": "Send data to data collection rule", + "description": "Send data to a data collection rule" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionRuleAssociations/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection rule association", + "operation": "Read data collection rule association", + "description": "Read a resource's association with a data collection rule" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionRuleAssociations/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection rule association", + "operation": "Create or update data collection rule association", + "description": "Create or update a resource's association with a data collection rule" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionRuleAssociations/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection rule association", + "operation": "Delete data collection rule association", + "description": "Delete a resource's association with a data collection rule" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionEndpoints/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection endpoint", + "operation": "Read data collection endpoint", + "description": "Read a data collection endpoint" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionEndpoints/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection endpoint", + "operation": "Create or update data collection endpoint", + "description": "Create or update a data collection endpoint" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionEndpoints/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection endpoint", + "operation": "Delete data collection endpoint", + "description": "Delete a data collection endpoint" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionEndpoints/ScopedPrivateLinkProxies/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection endpoint scoped private link proxy", + "operation": "Read data collection endpoint private link proxy", + "description": "Read a data collection endpoint private link proxy" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionEndpoints/ScopedPrivateLinkProxies/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection endpoint scoped private link proxy", + "operation": "Create or update data collection endpoint private link proxy", + "description": "Create or update a data collection endpoint private link proxy" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionEndpoints/ScopedPrivateLinkProxies/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection endpoint scoped private link proxy", + "operation": "Delete data collection endpoint private link proxy", + "description": "Delete a data collection endpoint private link proxy" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private Link Scope", + "operation": "Read a private link scope", + "description": "Read a private link scope" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private Link Scope", + "operation": "Create or update a private link scope", + "description": "Create or update a private link scope" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private Link Scope", + "operation": "Delete a private link scope", + "description": "Delete a private link scope" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopeOperationStatuses/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private Link Scope operation status", + "operation": "Read a private link scoped operation status", + "description": "Read a private link scoped operation status" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/ScopedResources/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private Link Scoped Resource", + "operation": "Read a private link scoped resource", + "description": "Read a private link scoped resource" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/ScopedResources/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private Link Scoped Resource", + "operation": "Create or update a private link scoped resource", + "description": "Create or update a private link scoped resource" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/ScopedResources/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private Link Scoped Resource", + "operation": "Delete a private link scoped resource", + "description": "Delete a private link scoped resource" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/PrivateLinkResources/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private Link Resource", + "operation": "Read a private link resource", + "description": "Read a private link resource" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/PrivateEndpointConnections/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private endpoint connection", + "operation": "Read a private endpoint connection", + "description": "Read a private endpoint connection" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/PrivateEndpointConnections/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private endpoint connection", + "operation": "Create or update a private endpoint connection", + "description": "Create or update a private endpoint connection" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/PrivateEndpointConnections/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private endpoint connection", + "operation": "Delete a private endpoint connection", + "description": "Delete a private endpoint connection" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/PrivateEndpointConnectionProxies/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private endpoint connection proxy", + "operation": "Read a private endpoint connection proxy", + "description": "Read a private endpoint connection proxy" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/PrivateEndpointConnectionProxies/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private endpoint connection proxy", + "operation": "Create or update a private endpoint connection proxy", + "description": "Create or update a private endpoint connection proxy" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/PrivateEndpointConnectionProxies/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private endpoint connection proxy", + "operation": "Delete a private endpoint connection proxy", + "description": "Delete a private endpoint connection proxy" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/PrivateEndpointConnectionProxies/Validate/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private endpoint connection proxy", + "operation": "Validate a private endpoint connection proxy", + "description": "Validate a private endpoint connection proxy" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MyWorkbooks/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MyWorkbooks", + "operation": "Read private workbook", + "description": "Read a private Workbook" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MyWorkbooks/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MyWorkbooks", + "operation": "Create or update private workbook", + "description": "Create or update a private workbook" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MyWorkbooks/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MyWorkbooks", + "operation": "Delete private workbook", + "description": "Delete a private workbook" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Workbooks/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Workbooks", + "operation": "Create or update workbook", + "description": "Create or update a workbook" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Workbooks/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Workbooks", + "operation": "Delete workbook", + "description": "Delete a workbook" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Workbooks/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Workbooks", + "operation": "Read workbook", + "description": "Read a workbook" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Workbooks/Revisions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Workbooks", + "operation": "Workbook revisions", + "description": "Get the workbook revisions" + }, + "properties": {} + } + ] + } + }, + "default": { + "body": { + "error": { + "code": "InvalidResourceType", + "message": "The resource type 'operations' could not be found in the namespace 'microsoft.insights' for api version '2014-05-01'. The supported api-versions are '2014-04-01,2014-06-01,2015-04-01'." + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-06-01/metrics_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-06-01/metrics_API.json new file mode 100644 index 000000000000..ba323d9261ba --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-06-01/metrics_API.json @@ -0,0 +1,216 @@ +{ + "swagger": "2.0", + "info": { + "title": "MonitorClient", + "version": "2016-06-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": { + "/{resourceUri}/providers/Microsoft.Insights/metrics": { + "get": { + "tags": [ + "Metrics" + ], + "operationId": "Metrics_List", + "description": "Lists the metric values for a resource.", + "parameters": [ + { + "name": "resourceUri", + "in": "path", + "required": true, + "type": "string", + "description": "The identifier of the resource.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + { + "name": "$filter", + "in": "query", + "type": "string", + "description": "Specifies the set of data returned.
    The filter is optional. If present it must contain a list of metric names to retrieve of the form: *(name.value eq 'metricName' [or name.value eq 'metricName' or ...])*. Optionally, the filter can contain conditions for the following attributes *aggregationType*, *startTime*, *endTime*, and *timeGrain* of the form *attributeName operator value*. Where operator is one of *ne*, *eq*, *gt*, *lt*.
    Several conditions can be combined with parentheses and logical operators, e.g: *and*, *or*.
    Some example filter expressions are:
    - $filter=(name.value eq 'RunsSucceeded') and aggregationType eq 'Total' and startTime eq 2016-02-20 and endTime eq 2016-02-21 and timeGrain eq duration'PT1M',
    - $filter=(name.value eq 'RunsSucceeded') and (aggregationType eq 'Total' or aggregationType eq 'Average') and startTime eq 2016-02-20 and endTime eq 2016-02-21 and timeGrain eq duration'PT1H',
    - $filter=(name.value eq 'ActionsCompleted' or name.value eq 'RunsSucceeded') and (aggregationType eq 'Total' or aggregationType eq 'Average') and startTime eq 2016-02-20 and endTime eq 2016-02-21 and timeGrain eq duration'PT1M'.

    **NOTE**: When a metrics query comes in with multiple metrics, but with no aggregation types defined, the service will pick the Primary aggregation type of the first metrics to be used as the default aggregation type for all the metrics.", + "required": true + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request to get the list of metric values", + "schema": { + "$ref": "#/definitions/MetricCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-odata": "#/definitions/Metric", + "x-ms-examples": { + "Get Metric with filter": { + "$ref": "./examples/GetMetric.json" + } + } + } + } + }, + "definitions": { + "LocalizableString": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "string", + "description": "the invariant value." + }, + "localizedValue": { + "type": "string", + "description": "the locale specific value." + } + }, + "description": "The localizable string class." + }, + "Unit": { + "type": "string", + "description": "Number representing the unit of the metric. 0=Count, 1=Bytes, 2=Seconds, 3=CountPerSecond, 4=BytesPerSecond, 5=Percent, 6=MilliSeconds, 7=ByteSeconds" + }, + "MetricValue": { + "type": "object", + "required": [ + "timeStamp" + ], + "properties": { + "timeStamp": { + "type": "string", + "format": "date-time", + "description": "the timestamp for the metric value in ISO 8601 format." + }, + "average": { + "type": "number", + "format": "double", + "description": "the average value in the time range." + }, + "minimum": { + "type": "number", + "format": "double", + "description": "the least value in the time range." + }, + "maximum": { + "type": "number", + "format": "double", + "description": "the greatest value in the time range." + }, + "total": { + "type": "number", + "format": "double", + "description": "the sum of all of the values in the time range." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "the number of samples in the time range. Can be used to determine the number of values that contributed to the average value." + } + }, + "description": "Represents a metric value." + }, + "Metric": { + "type": "object", + "required": [ + "name", + "unit", + "data" + ], + "properties": { + "id": { + "type": "string", + "description": "the id, resourceId, of the metric." + }, + "type": { + "type": "string", + "description": "the resource type of the metric resource." + }, + "name": { + "$ref": "#/definitions/LocalizableString", + "description": "the name and the display name of the metric, i.e. it is localizable string." + }, + "unit": { + "$ref": "#/definitions/Unit", + "description": "the unit of the metric." + }, + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/MetricValue" + }, + "description": "Array of data points representing the metric values." + } + }, + "description": "A set of metric values in a time range." + }, + "MetricCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Metric" + }, + "description": "the value of the collection." + } + }, + "required": [ + "value" + ], + "description": "The collection of metric value sets." + }, + "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" + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-06-01/operations_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-06-01/operations_API.json new file mode 100644 index 000000000000..912d1aea3fef --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-06-01/operations_API.json @@ -0,0 +1,308 @@ +{ + "swagger": "2.0", + "info": { + "title": "MonitorManagementClient", + "version": "2016-06-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.Insights/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available operations from Microsoft.Insights provider.", + "operationId": "Operations_List", + "x-ms-examples": { + "Get a list of operations for a resource provider": { + "$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": "BadRequest", + "schema": { + "$ref": "#/definitions/ErrorContract" + } + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "type": "object", + "description": "Result of the request to list Microsoft.Insights 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 Microsoft.Insights provider." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "Microsoft Insights API operation definition.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "isDataAction": { + "type": "boolean", + "description": "Property to specify whether the action is a data action." + }, + "display": { + "description": "Display metadata associated with the operation.", + "type": "object", + "properties": { + "publisher": { + "description": "The publisher of this operation.", + "type": "string" + }, + "provider": { + "description": "Service provider: Microsoft.Insights", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed: AlertRules, Autoscale, etc.", + "type": "string" + }, + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "type": "string" + }, + "description": { + "description": "The description of the operation.", + "type": "string" + } + } + }, + "properties": { + "description": "Properties of operation, include metric specifications.", + "x-ms-client-flatten": true, + "x-ms-client-name": "OperationProperties", + "$ref": "#/definitions/OperationProperties" + } + } + }, + "OperationProperties": { + "description": "Properties of operation, include metric specifications.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "One property of operation, include metric specifications." + } + } + }, + "ServiceSpecification": { + "description": "One property of operation, include log specifications.", + "type": "object", + "properties": { + "logSpecifications": { + "description": "Log specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + } + }, + "metricSpecifications": { + "description": "Metric specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + } + }, + "legacyMetricSpecifications": { + "description": "Legacy Metric specifications for operation. Deprecated, do not use.", + "type": "object" + } + } + }, + "LogSpecification": { + "description": "Log specification of operation.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of log specification." + }, + "displayName": { + "type": "string", + "description": "Display name of log specification." + }, + "blobDuration": { + "type": "string", + "description": "Blob duration of specification." + } + } + }, + "MetricSpecification": { + "description": "Metric specification of operation.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the metric." + }, + "displayName": { + "type": "string", + "description": "Display name of the metric." + }, + "displayDescription": { + "type": "string", + "description": "Display description of the metric." + }, + "unit": { + "type": "string", + "description": "The metric unit. Possible values include: Count,Bytes,Seconds,Percent,CountPerSecond,BytesPerSecond,MilliSeconds,ByteSeconds,Unspecified,BitsPerSecond,Cores,MilliCores,NanoCores" + }, + "aggregationType": { + "type": "string", + "description": "The default metric aggregation type. Possible values include: Total,Average,Maximum,Minimum,Count" + }, + "supportedAggregationTypes": { + "type": "array", + "description": "The supported aggregation types for the metrics.", + "items": { + "type": "string" + } + }, + "supportedTimeGrainTypes": { + "type": "array", + "description": "The supported time grain types for the metrics.", + "items": { + "type": "string" + } + }, + "availabilities": { + "type": "array", + "description": "The supported time grain types for the metrics.", + "items": { + "type": "string" + } + }, + "lockAggregationType": { + "type": "string", + "description": "The metric lock aggregation type." + }, + "category": { + "type": "string", + "description": "Category or type of metric." + }, + "dimensions": { + "type": "array", + "description": "The dimensions of metric.", + "items": { + "$ref": "#/definitions/DimensionProperties" + } + }, + "fillGapWithZero": { + "type": "boolean", + "description": "Property to specify whether to fill empty gaps with zero." + }, + "internalMetricName": { + "type": "string", + "description": "The internal metric name." + } + } + }, + "DimensionProperties": { + "description": "Type of operation: get, read, delete, etc.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of dimension." + }, + "displayName": { + "type": "string", + "description": "Display name of dimension." + }, + "toBeExportedForShoebox": { + "type": "boolean", + "description": "Legacy usage, should not set." + }, + "isHidden": { + "type": "boolean", + "description": "When set, the dimension is hidden from the customer, used in conjunction with the defaultDimensionValues field below" + }, + "defaultDimensionValues": { + "type": "object", + "description": "Default dimension value to be sent down for the hidden dimension during query" + } + } + }, + "ErrorContract": { + "title": "Error Response", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)", + "type": "object", + "properties": { + "error": { + "description": "The error object.", + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "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" + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/examples/GetMetricDefinitions.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/examples/GetMetricDefinitions.json index 6b07e32cb0c9..d94389a3b730 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/examples/GetMetricDefinitions.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/examples/GetMetricDefinitions.json @@ -970,6 +970,12 @@ } ] } + }, + "default": { + "body": { + "code": "BadRequest", + "message": "ApiVersion: 2018-01-01 does not support query metricdefinitions at non Arm resource Id level" + } } } } diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/examples/GetMetricDefinitionsMetricClass.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/examples/GetMetricDefinitionsMetricClass.json new file mode 100644 index 000000000000..c64227d9be0b --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/examples/GetMetricDefinitionsMetricClass.json @@ -0,0 +1,1306 @@ +{ + "parameters": { + "resourceUri": "subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache", + "api-version": "2018-01-01", + "metricnamespace": "microsoft.storagecache/caches" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache/providers/microsoft.insights/metricdefinitions/ClientIOPS", + "resourceId": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache", + "namespace": "microsoft.storagecache/caches", + "metricClass": "Transactions", + "name": { + "value": "ClientIOPS", + "localizedValue": "Total Client IOPS" + }, + "displayDescription": "The rate of client file operations processed by the Cache.", + "isDimensionRequired": false, + "unit": "Count", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "Minimum", + "Maximum", + "Average" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache/providers/microsoft.insights/metricdefinitions/ClientLatency", + "resourceId": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache", + "namespace": "microsoft.storagecache/caches", + "metricClass": "Latency", + "name": { + "value": "ClientLatency", + "localizedValue": "Average Client Latency" + }, + "displayDescription": "Average latency of client file operations to the Cache.", + "isDimensionRequired": false, + "unit": "MilliSeconds", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "Minimum", + "Maximum", + "Average" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache/providers/microsoft.insights/metricdefinitions/ClientReadIOPS", + "resourceId": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache", + "namespace": "microsoft.storagecache/caches", + "metricClass": "Transactions", + "name": { + "value": "ClientReadIOPS", + "localizedValue": "Client Read IOPS" + }, + "displayDescription": "Client read operations per second.", + "isDimensionRequired": false, + "unit": "CountPerSecond", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "Minimum", + "Maximum", + "Average" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache/providers/microsoft.insights/metricdefinitions/ClientReadThroughput", + "resourceId": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache", + "namespace": "microsoft.storagecache/caches", + "metricClass": "Transactions", + "name": { + "value": "ClientReadThroughput", + "localizedValue": "Average Cache Read Throughput" + }, + "displayDescription": "Client read data transfer rate.", + "isDimensionRequired": false, + "unit": "BytesPerSecond", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "Minimum", + "Maximum", + "Average" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache/providers/microsoft.insights/metricdefinitions/ClientWriteIOPS", + "resourceId": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache", + "namespace": "microsoft.storagecache/caches", + "metricClass": "Transactions", + "name": { + "value": "ClientWriteIOPS", + "localizedValue": "Client Write IOPS" + }, + "displayDescription": "Client write operations per second.", + "isDimensionRequired": false, + "unit": "CountPerSecond", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "Minimum", + "Maximum", + "Average" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache/providers/microsoft.insights/metricdefinitions/ClientWriteThroughput", + "resourceId": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache", + "namespace": "microsoft.storagecache/caches", + "metricClass": "Transactions", + "name": { + "value": "ClientWriteThroughput", + "localizedValue": "Average Cache Write Throughput" + }, + "displayDescription": "Client write data transfer rate.", + "isDimensionRequired": false, + "unit": "BytesPerSecond", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "Minimum", + "Maximum", + "Average" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache/providers/microsoft.insights/metricdefinitions/ClientMetadataReadIOPS", + "resourceId": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache", + "namespace": "microsoft.storagecache/caches", + "metricClass": "Transactions", + "name": { + "value": "ClientMetadataReadIOPS", + "localizedValue": "Client Metadata Read IOPS" + }, + "displayDescription": "The rate of client file operations sent to the Cache, excluding data reads, that do not modify persistent state.", + "isDimensionRequired": false, + "unit": "CountPerSecond", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "Minimum", + "Maximum", + "Average" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache/providers/microsoft.insights/metricdefinitions/ClientMetadataWriteIOPS", + "resourceId": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache", + "namespace": "microsoft.storagecache/caches", + "metricClass": "Transactions", + "name": { + "value": "ClientMetadataWriteIOPS", + "localizedValue": "Client Metadata Write IOPS" + }, + "displayDescription": "The rate of client file operations sent to the Cache, excluding data writes, that modify persistent state.", + "isDimensionRequired": false, + "unit": "CountPerSecond", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "Minimum", + "Maximum", + "Average" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache/providers/microsoft.insights/metricdefinitions/ClientLockIOPS", + "resourceId": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache", + "namespace": "microsoft.storagecache/caches", + "metricClass": "Transactions", + "name": { + "value": "ClientLockIOPS", + "localizedValue": "Client Lock IOPS" + }, + "displayDescription": "Client file locking operations per second.", + "isDimensionRequired": false, + "unit": "CountPerSecond", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "Minimum", + "Maximum", + "Average" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache/providers/microsoft.insights/metricdefinitions/StorageTargetHealth", + "resourceId": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache", + "namespace": "microsoft.storagecache/caches", + "metricClass": "Errors", + "name": { + "value": "StorageTargetHealth", + "localizedValue": "Storage Target Health" + }, + "displayDescription": "Boolean results of connectivity test between the Cache and Storage Targets.", + "isDimensionRequired": false, + "unit": "Count", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "Minimum", + "Maximum", + "Average" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache/providers/microsoft.insights/metricdefinitions/Uptime", + "resourceId": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache", + "namespace": "microsoft.storagecache/caches", + "metricClass": "Availability", + "name": { + "value": "Uptime", + "localizedValue": "Uptime" + }, + "displayDescription": "Boolean results of connectivity test between the Cache and monitoring system.", + "isDimensionRequired": false, + "unit": "Count", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "Minimum", + "Maximum", + "Average" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ] + }, + { + "id": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache/providers/microsoft.insights/metricdefinitions/StorageTargetIOPS", + "resourceId": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache", + "namespace": "microsoft.storagecache/caches", + "metricClass": "Transactions", + "name": { + "value": "StorageTargetIOPS", + "localizedValue": "Total StorageTarget IOPS" + }, + "displayDescription": "The rate of all file operations the Cache sends to a particular StorageTarget.", + "isDimensionRequired": false, + "unit": "Count", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "Minimum", + "Maximum", + "Average" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "StorageTarget", + "localizedValue": "StorageTarget" + } + ] + }, + { + "id": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache/providers/microsoft.insights/metricdefinitions/StorageTargetWriteIOPS", + "resourceId": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache", + "namespace": "microsoft.storagecache/caches", + "metricClass": "Transactions", + "name": { + "value": "StorageTargetWriteIOPS", + "localizedValue": "StorageTarget Write IOPS" + }, + "displayDescription": "The rate of the file write operations the Cache sends to a particular StorageTarget.", + "isDimensionRequired": false, + "unit": "Count", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "Minimum", + "Maximum", + "Average" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "StorageTarget", + "localizedValue": "StorageTarget" + } + ] + }, + { + "id": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache/providers/microsoft.insights/metricdefinitions/StorageTargetAsyncWriteThroughput", + "resourceId": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache", + "namespace": "microsoft.storagecache/caches", + "metricClass": "Transactions", + "name": { + "value": "StorageTargetAsyncWriteThroughput", + "localizedValue": "StorageTarget Asynchronous Write Throughput" + }, + "displayDescription": "The rate the Cache asynchronously writes data to a particular StorageTarget. These are opportunistic writes that do not cause clients to block.", + "isDimensionRequired": false, + "unit": "BytesPerSecond", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "Minimum", + "Maximum", + "Average" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "StorageTarget", + "localizedValue": "StorageTarget" + } + ] + }, + { + "id": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache/providers/microsoft.insights/metricdefinitions/StorageTargetSyncWriteThroughput", + "resourceId": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache", + "namespace": "microsoft.storagecache/caches", + "metricClass": "Transactions", + "name": { + "value": "StorageTargetSyncWriteThroughput", + "localizedValue": "StorageTarget Synchronous Write Throughput" + }, + "displayDescription": "The rate the Cache synchronously writes data to a particular StorageTarget. These are writes that do cause clients to block.", + "isDimensionRequired": false, + "unit": "BytesPerSecond", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "Minimum", + "Maximum", + "Average" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "StorageTarget", + "localizedValue": "StorageTarget" + } + ] + }, + { + "id": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache/providers/microsoft.insights/metricdefinitions/StorageTargetTotalWriteThroughput", + "resourceId": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache", + "namespace": "microsoft.storagecache/caches", + "metricClass": "Transactions", + "name": { + "value": "StorageTargetTotalWriteThroughput", + "localizedValue": "StorageTarget Total Write Throughput" + }, + "displayDescription": "The total rate that the Cache writes data to a particular StorageTarget.", + "isDimensionRequired": false, + "unit": "BytesPerSecond", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "Minimum", + "Maximum", + "Average" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "StorageTarget", + "localizedValue": "StorageTarget" + } + ] + }, + { + "id": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache/providers/microsoft.insights/metricdefinitions/StorageTargetLatency", + "resourceId": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache", + "namespace": "microsoft.storagecache/caches", + "metricClass": "Transactions", + "name": { + "value": "StorageTargetLatency", + "localizedValue": "StorageTarget Latency" + }, + "displayDescription": "The average round trip latency of all the file operations the Cache sends to a partricular StorageTarget.", + "isDimensionRequired": false, + "unit": "MilliSeconds", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "Minimum", + "Maximum", + "Average" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "StorageTarget", + "localizedValue": "StorageTarget" + } + ] + }, + { + "id": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache/providers/microsoft.insights/metricdefinitions/StorageTargetMetadataReadIOPS", + "resourceId": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache", + "namespace": "microsoft.storagecache/caches", + "metricClass": "Transactions", + "name": { + "value": "StorageTargetMetadataReadIOPS", + "localizedValue": "StorageTarget Metadata Read IOPS" + }, + "displayDescription": "The rate of file operations that do not modify persistent state, and excluding the read operation, that the Cache sends to a particular StorageTarget.", + "isDimensionRequired": false, + "unit": "CountPerSecond", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "Minimum", + "Maximum", + "Average" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "StorageTarget", + "localizedValue": "StorageTarget" + } + ] + }, + { + "id": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache/providers/microsoft.insights/metricdefinitions/StorageTargetMetadataWriteIOPS", + "resourceId": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache", + "namespace": "microsoft.storagecache/caches", + "metricClass": "Transactions", + "name": { + "value": "StorageTargetMetadataWriteIOPS", + "localizedValue": "StorageTarget Metadata Write IOPS" + }, + "displayDescription": "The rate of file operations that do modify persistent state and excluding the write operation, that the Cache sends to a particular StorageTarget.", + "isDimensionRequired": false, + "unit": "CountPerSecond", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "Minimum", + "Maximum", + "Average" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "StorageTarget", + "localizedValue": "StorageTarget" + } + ] + }, + { + "id": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache/providers/microsoft.insights/metricdefinitions/StorageTargetReadIOPS", + "resourceId": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache", + "namespace": "microsoft.storagecache/caches", + "metricClass": "Transactions", + "name": { + "value": "StorageTargetReadIOPS", + "localizedValue": "StorageTarget Read IOPS" + }, + "displayDescription": "The rate of file read operations the Cache sends to a particular StorageTarget.", + "isDimensionRequired": false, + "unit": "CountPerSecond", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "Minimum", + "Maximum", + "Average" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "StorageTarget", + "localizedValue": "StorageTarget" + } + ] + }, + { + "id": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache/providers/microsoft.insights/metricdefinitions/StorageTargetReadAheadThroughput", + "resourceId": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache", + "namespace": "microsoft.storagecache/caches", + "metricClass": "Transactions", + "name": { + "value": "StorageTargetReadAheadThroughput", + "localizedValue": "StorageTarget Read Ahead Throughput" + }, + "displayDescription": "The rate the Cache opportunisticly reads data from the StorageTarget.", + "isDimensionRequired": false, + "unit": "BytesPerSecond", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "Minimum", + "Maximum", + "Average" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "StorageTarget", + "localizedValue": "StorageTarget" + } + ] + }, + { + "id": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache/providers/microsoft.insights/metricdefinitions/StorageTargetFillThroughput", + "resourceId": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache", + "namespace": "microsoft.storagecache/caches", + "metricClass": "Transactions", + "name": { + "value": "StorageTargetFillThroughput", + "localizedValue": "StorageTarget Fill Throughput" + }, + "displayDescription": "The rate the Cache reads data from the StorageTarget to handle a cache miss.", + "isDimensionRequired": false, + "unit": "BytesPerSecond", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "Minimum", + "Maximum", + "Average" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "StorageTarget", + "localizedValue": "StorageTarget" + } + ] + }, + { + "id": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache/providers/microsoft.insights/metricdefinitions/StorageTargetTotalReadThroughput", + "resourceId": "/subscriptions/46841c0e-69c8-4b17-af46-6626ecb15fc2/resourceGroups/adgarntptestrg/providers/Microsoft.StorageCache/caches/adgarntptestcache", + "namespace": "microsoft.storagecache/caches", + "metricClass": "Transactions", + "name": { + "value": "StorageTargetTotalReadThroughput", + "localizedValue": "StorageTarget Total Read Throughput" + }, + "displayDescription": "The total rate that the Cache reads data from a particular StorageTarget.", + "isDimensionRequired": false, + "unit": "BytesPerSecond", + "primaryAggregationType": "Average", + "supportedAggregationTypes": [ + "Minimum", + "Maximum", + "Average" + ], + "metricAvailabilities": [ + { + "timeGrain": "PT1M", + "retention": "P93D" + }, + { + "timeGrain": "PT5M", + "retention": "P93D" + }, + { + "timeGrain": "PT15M", + "retention": "P93D" + }, + { + "timeGrain": "PT30M", + "retention": "P93D" + }, + { + "timeGrain": "PT1H", + "retention": "P93D" + }, + { + "timeGrain": "PT6H", + "retention": "P93D" + }, + { + "timeGrain": "PT12H", + "retention": "P93D" + }, + { + "timeGrain": "P1D", + "retention": "P93D" + } + ], + "dimensions": [ + { + "value": "StorageTarget", + "localizedValue": "StorageTarget" + } + ] + } + ] + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/examples/GetMetricError.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/examples/GetMetricError.json new file mode 100644 index 000000000000..f14307c51dc0 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/examples/GetMetricError.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "resourceUri": "subscriptions/ac41e21f-afd6-4a79-8070-f01eba278f97/resourceGroups/todking/providers/Microsoft.DocumentDb/databaseAccounts/tk-cosmos-mongo", + "timespan": "2021-06-07T21:51:00Z/2021-06-08T01:51:00Z", + "metricnames": "MongoRequestsCount,MongoRequests", + "metricnamespace": "microsoft.documentdb/databaseaccounts", + "aggregation": "average", + "interval": "FULL", + "api-version": "2018-01-01" + }, + "responses": { + "200": { + "body": { + "cost": 239, + "timespan": "2021-06-07T21:51:00Z/2021-06-08T01:51:00Z", + "interval": "PT4H", + "value": [ + { + "id": "/subscriptions/ac41e21f-afd6-4a79-8070-f01eba278f97/resourceGroups/todking/providers/Microsoft.DocumentDb/databaseAccounts/tk-cosmos-mongo/providers/Microsoft.Insights/metrics/MongoRequestsCount", + "type": "Microsoft.Insights/metrics", + "name": { + "value": "MongoRequestsCount", + "localizedValue": "(deprecated) Mongo Request Rate" + }, + "unit": "CountPerSecond", + "timeseries": [], + "errorMessage": "Sampling type is not found. Metric:CosmosDBCustomer,AzureMonitor,MongoRequests, SamplingType:NullableAverage.", + "errorCode": "InvalidSamplingType" + }, + { + "id": "/subscriptions/ac41e21f-afd6-4a79-8070-f01eba278f97/resourceGroups/todking/providers/Microsoft.DocumentDb/databaseAccounts/tk-cosmos-mongo/providers/Microsoft.Insights/metrics/MongoRequests", + "type": "Microsoft.Insights/metrics", + "name": { + "value": "MongoRequests", + "localizedValue": "Mongo Requests" + }, + "displayDescription": "Number of Mongo Requests Made", + "unit": "Count", + "timeseries": [ + { + "metadatavalues": [], + "data": [ + { + "timeStamp": "2021-06-07T21:51:00Z", + "average": 0.0 + } + ] + } + ], + "errorCode": "Success" + } + ], + "namespace": "microsoft.documentdb/databaseaccounts", + "resourceregion": "westus2" + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json index ac4c7d13b005..2ee9ebc037ef 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json @@ -2,9 +2,6 @@ "swagger": "2.0", "info": { "title": "MonitorManagementClient", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - }, "version": "2018-01-01" }, "host": "management.azure.com", @@ -36,7 +33,7 @@ } }, "paths": { - "/{resourceUri}/providers/microsoft.insights/metricDefinitions": { + "/{resourceUri}/providers/Microsoft.Insights/metricDefinitions": { "get": { "tags": [ "MetricDefinitions" @@ -77,6 +74,9 @@ }, "Get Application Insights Metric Definitions without filter": { "$ref": "./examples/GetMetricDefinitionsApplicationInsights.json" + }, + "Get StorageCache Metric Definitions with metric class": { + "$ref": "./examples/GetMetricDefinitionsMetricClass.json" } } } @@ -100,6 +100,7 @@ "description": "The localizable string class." }, "MetricAvailability": { + "type": "object", "properties": { "timeGrain": { "type": "string", @@ -133,8 +134,8 @@ "BitsPerSecond" ], "x-ms-enum": { - "name": "Unit", - "modelAsString": false + "name": "MetricUnit", + "modelAsString": true } }, "AggregationType": { @@ -153,7 +154,23 @@ "modelAsString": false } }, + "MetricClass": { + "type": "string", + "description": "The class of the metric.", + "enum": [ + "Availability", + "Transactions", + "Errors", + "Latency", + "Saturation" + ], + "x-ms-enum": { + "name": "MetricClass", + "modelAsString": true + } + }, "MetricDefinition": { + "type": "object", "properties": { "isDimensionRequired": { "type": "boolean", @@ -179,9 +196,13 @@ "type": "string", "description": "Custom category name for this metric." }, + "metricClass": { + "$ref": "#/definitions/MetricClass", + "description": "The class of the metric." + }, "unit": { "$ref": "#/definitions/Unit", - "description": "the unit of the metric." + "description": "The unit of the metric." }, "primaryAggregationType": { "$ref": "#/definitions/AggregationType", @@ -216,6 +237,7 @@ "description": "Metric definition class specifies the metadata for a metric." }, "MetricDefinitionCollection": { + "type": "object", "properties": { "value": { "type": "array", diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/metrics_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/metrics_API.json index 8f531f663b66..e196cf744cf7 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/metrics_API.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/metrics_API.json @@ -2,9 +2,6 @@ "swagger": "2.0", "info": { "title": "MonitorManagementClient", - "x-ms-code-generation-settings": { - "name": "MonitorManagementClient" - }, "version": "2018-01-01" }, "host": "management.azure.com", @@ -36,7 +33,7 @@ } }, "paths": { - "/{resourceUri}/providers/microsoft.insights/metrics": { + "/{resourceUri}/providers/Microsoft.Insights/metrics": { "get": { "tags": [ "Metrics" @@ -69,7 +66,7 @@ "name": "$filter", "in": "query", "type": "string", - "description": "The **$filter** is used to reduce the set of metric data returned.
    Example:
    Metric contains metadata A, B and C.
    - Return all time series of C where A = a1 and B = b1 or b2
    **$filter=A eq ‘a1’ and B eq ‘b1’ or B eq ‘b2’ and C eq ‘*’**
    - Invalid variant:
    **$filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘*’ or B = ‘b2’**
    This is invalid because the logical or operator cannot separate two different metadata names.
    - Return all time series where A = a1, B = b1 and C = c1:
    **$filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘c1’**
    - Return all time series where A = a1
    **$filter=A eq ‘a1’ and B eq ‘*’ and C eq ‘*’**.", + "description": "The **$filter** is used to reduce the set of metric data returned. Example: Metric contains metadata A, B and C. - Return all time series of C where A = a1 and B = b1 or b2 **$filter=A eq 'a1' and B eq 'b1' or B eq 'b2' and C eq '*'** - Invalid variant: **$filter=A eq 'a1' and B eq 'b1' and C eq '*' or B = 'b2'** This is invalid because the logical or operator cannot separate two different metadata names. - Return all time series where A = a1, B = b1 and C = c1: **$filter=A eq 'a1' and B eq 'b1' and C eq 'c1'** - Return all time series where A = a1 **$filter=A eq 'a1' and B eq '*' and C eq '*'**. Special case: When dimension name or dimension value uses round brackets. Eg: When dimension name is **dim (test) 1** Instead of using $filter= \"dim (test) 1 eq '*' \" use **$filter= \"dim %2528test%2529 1 eq '*' \"** When dimension name is **dim (test) 3** and dimension value is **dim3 (test) val** Instead of using $filter= \"dim (test) 3 eq 'dim3 (test) val' \" use **$filter= \"dim %2528test%2529 3 eq 'dim3 %2528test%2529 val' \"**", "required": false }, { @@ -103,6 +100,9 @@ }, "Get Metric for metadata": { "$ref": "./examples/GetMetricMetadata.json" + }, + "Get Metric with error": { + "$ref": "./examples/GetMetricError.json" } } } @@ -144,11 +144,12 @@ "BitsPerSecond" ], "x-ms-enum": { - "name": "Unit", - "modelAsString": false + "name": "MetricUnit", + "modelAsString": true } }, "MetricValue": { + "type": "object", "required": [ "timeStamp" ], @@ -187,6 +188,7 @@ "description": "Represents a metric value." }, "MetadataValue": { + "type": "object", "properties": { "name": { "$ref": "#/definitions/LocalizableString", @@ -199,20 +201,6 @@ }, "description": "Represents a metric metadata value." }, - "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" - } - } - }, "Response": { "type": "object", "properties": { @@ -276,9 +264,13 @@ "type": "string", "description": "'Success' or the error details on query failures for this metric." }, + "errorMessage": { + "type": "string", + "description": "Error message encountered querying this specific metric." + }, "unit": { "$ref": "#/definitions/Unit", - "description": "the unit of the metric." + "description": "The unit of the metric." }, "timeseries": { "type": "array", @@ -292,7 +284,6 @@ "id", "type", "name", - "displayDescription", "unit", "timeseries" ], @@ -317,6 +308,20 @@ } }, "description": "A time series result type. The discriminator value is always TimeSeries in this case." + }, + "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" + } + } } }, "parameters": { @@ -351,7 +356,7 @@ "in": "query", "required": false, "type": "string", - "description": "The names of the metrics (comma separated) to retrieve.", + "description": "The names of the metrics (comma separated) to retrieve. Special case: If a metricname itself has a comma in it then use %2 to indicate it. Eg: 'Metric,Name1' should be **'Metric%2Name1'**", "x-ms-parameter-location": "method" }, "AggregationsParameter": { diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json index 6bd3f2400fd7..57f2b413cc3f 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json @@ -34,7 +34,7 @@ } }, "paths": { - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.insights/scheduledQueryRules/{ruleName}": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules/{ruleName}": { "put": { "description": "Creates or updates an log search rule.", "tags": [ @@ -226,7 +226,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/microsoft.insights/scheduledQueryRules": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Insights/scheduledQueryRules": { "get": { "tags": [ "scheduledQueryRules" @@ -269,7 +269,7 @@ "x-ms-odata": "#/definitions/LogSearchRuleResource" } }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.insights/scheduledQueryRules": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules": { "get": { "tags": [ "scheduledQueryRules" @@ -318,6 +318,7 @@ }, "definitions": { "Resource": { + "type": "object", "properties": { "id": { "type": "string", @@ -343,6 +344,7 @@ ] }, "tags": { + "type": "object", "additionalProperties": { "type": "string" }, @@ -385,8 +387,10 @@ "description": "The Log Search Rule resource." }, "LogSearchRuleResourcePatch": { + "type": "object", "properties": { "tags": { + "type": "object", "additionalProperties": { "type": "string" }, @@ -401,6 +405,7 @@ "description": "The log search rule resource for patch operations." }, "LogSearchRuleResourceCollection": { + "type": "object", "properties": { "value": { "type": "array", @@ -583,6 +588,7 @@ "description": "Set value to 'ResultAccount'" }, "LogSearchRule": { + "type": "object", "description": "Log Search Rule Definition", "properties": { "createdWithApiVersion": { @@ -660,6 +666,7 @@ ] }, "LogSearchRulePatch": { + "type": "object", "description": "Log Search Rule Definition for Patching", "properties": { "enabled": { diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/baseline_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/baseline_API.json index 1a9d8374b633..d2ba6d2ba226 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/baseline_API.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/baseline_API.json @@ -440,7 +440,7 @@ "in": "query", "required": false, "type": "string", - "description": "The names of the metrics (comma separated) to retrieve.", + "description": "The names of the metrics (comma separated) to retrieve. Special case: If a metricname itself has a comma in it then use %2 to indicate it. Eg: 'Metric,Name1' should be **'Metric%2Name1'**", "x-ms-parameter-location": "method" }, "AggregationParameter": { diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/metricBaselines_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/metricBaselines_API.json index cbf5493c2171..39a35c8d609e 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/metricBaselines_API.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/metricBaselines_API.json @@ -78,7 +78,7 @@ "name": "$filter", "in": "query", "type": "string", - "description": "The **$filter** is used to reduce the set of metric data returned.
    Example:
    Metric contains metadata A, B and C.
    - Return all time series of C where A = a1 and B = b1 or b2
    **$filter=A eq ‘a1’ and B eq ‘b1’ or B eq ‘b2’ and C eq ‘*’**
    - Invalid variant:
    **$filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘*’ or B = ‘b2’**
    This is invalid because the logical or operator cannot separate two different metadata names.
    - Return all time series where A = a1, B = b1 and C = c1:
    **$filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘c1’**
    - Return all time series where A = a1
    **$filter=A eq ‘a1’ and B eq ‘*’ and C eq ‘*’**.", + "description": "The **$filter** is used to reduce the set of metric data returned. Example: Metric contains metadata A, B and C. - Return all time series of C where A = a1 and B = b1 or b2 **$filter=A eq 'a1' and B eq 'b1' or B eq 'b2' and C eq '*'** - Invalid variant: **$filter=A eq 'a1' and B eq 'b1' and C eq '*' or B = 'b2'** This is invalid because the logical or operator cannot separate two different metadata names. - Return all time series where A = a1, B = b1 and C = c1: **$filter=A eq 'a1' and B eq 'b1' and C eq 'c1'** - Return all time series where A = a1 **$filter=A eq 'a1' and B eq '*' and C eq '*'**. Special case: When dimension name or dimension value uses round brackets. Eg: When dimension name is **dim (test) 1** Instead of using $filter= \"dim (test) 1 eq '*' \" use **$filter= \"dim %2528test%2529 1 eq '*' \"** When dimension name is **dim (test) 3** and dimension value is **dim3 (test) val** Instead of using $filter= \"dim (test) 3 eq 'dim3 (test) val' \" use **$filter= \"dim %2528test%2529 3 eq 'dim3 %2528test%2529 val' \"**", "required": false }, { @@ -334,7 +334,7 @@ "in": "query", "required": false, "type": "string", - "description": "The names of the metrics (comma separated) to retrieve.", + "description": "The names of the metrics (comma separated) to retrieve. Special case: If a metricname itself has a comma in it then use %2 to indicate it. Eg: 'Metric,Name1' should be **'Metric%2Name1'**", "x-ms-parameter-location": "method" }, "MetricNamespaceParameter": { diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json index af1167214569..42b89e85889e 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json @@ -78,7 +78,7 @@ "name": "$filter", "in": "query", "type": "string", - "description": "The **$filter** is used to reduce the set of metric data returned.
    Example:
    Metric contains metadata A, B and C.
    - Return all time series of C where A = a1 and B = b1 or b2
    **$filter=A eq ‘a1’ and B eq ‘b1’ or B eq ‘b2’ and C eq ‘*’**
    - Invalid variant:
    **$filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘*’ or B = ‘b2’**
    This is invalid because the logical or operator cannot separate two different metadata names.
    - Return all time series where A = a1, B = b1 and C = c1:
    **$filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘c1’**
    - Return all time series where A = a1
    **$filter=A eq ‘a1’ and B eq ‘*’ and C eq ‘*’**.", + "description": "The **$filter** is used to reduce the set of metric data returned. Example: Metric contains metadata A, B and C. - Return all time series of C where A = a1 and B = b1 or b2 **$filter=A eq 'a1' and B eq 'b1' or B eq 'b2' and C eq '*'** - Invalid variant: **$filter=A eq 'a1' and B eq 'b1' and C eq '*' or B = 'b2'** This is invalid because the logical or operator cannot separate two different metadata names. - Return all time series where A = a1, B = b1 and C = c1: **$filter=A eq 'a1' and B eq 'b1' and C eq 'c1'** - Return all time series where A = a1 **$filter=A eq 'a1' and B eq '*' and C eq '*'**. Special case: When dimension name or dimension value uses round brackets. Eg: When dimension name is **dim (test) 1** Instead of using $filter= \"dim (test) 1 eq '*' \" use **$filter= \"dim %2528test%2529 1 eq '*' \"** When dimension name is **dim (test) 3** and dimension value is **dim3 (test) val** Instead of using $filter= \"dim (test) 3 eq 'dim3 (test) val' \" use **$filter= \"dim %2528test%2529 3 eq 'dim3 %2528test%2529 val' \"**", "required": false }, { @@ -345,7 +345,7 @@ "in": "query", "required": false, "type": "string", - "description": "The names of the metrics (comma separated) to retrieve.", + "description": "The names of the metrics (comma separated) to retrieve. Special case: If a metricname itself has a comma in it then use %2 to indicate it. Eg: 'Metric,Name1' should be **'Metric%2Name1'**", "x-ms-parameter-location": "method" }, "MetricNamespaceParameter": { diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-07-01/examples/GetMetric.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-07-01/examples/GetMetric.json new file mode 100644 index 000000000000..64c7c25e2cf5 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-07-01/examples/GetMetric.json @@ -0,0 +1,485 @@ +{ + "parameters": { + "resourceUri": "subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default", + "timespan": "2021-04-20T09:00:00.000Z/2021-04-20T14:00:00.000Z", + "metricnames": "BlobCount,BlobCapacity", + "metricnamespace": "Microsoft.Storage/storageAccounts/blobServices", + "$filter": "Tier eq '*'", + "top": 5, + "orderby": "average asc", + "aggregation": "average,minimum,maximum", + "interval": "PT6H", + "AutoAdjustTimegrain": true, + "ValidateDimensions": false, + "api-version": "2019-07-01" + }, + "responses": { + "200": { + "body": { + "cost": 598, + "timespan": "2021-04-20T09:00:00Z/2021-04-20T14:00:00Z", + "interval": "PT1H", + "value": [ + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default/providers/Microsoft.Insights/metrics/BlobCount", + "type": "Microsoft.Insights/metrics", + "name": { + "value": "BlobCount", + "localizedValue": "Blob Count" + }, + "displayDescription": "The number of blob objects stored in the storage account.", + "unit": "Count", + "timeseries": [ + { + "metadatavalues": [ + { + "name": { + "value": "tier", + "localizedValue": "tier" + }, + "value": "Hot" + } + ], + "data": [ + { + "timeStamp": "2021-04-20T09:00:00Z", + "average": 7.0, + "minimum": 7.0, + "maximum": 7.0 + }, + { + "timeStamp": "2021-04-20T10:00:00Z", + "average": 7.0, + "minimum": 7.0, + "maximum": 7.0 + }, + { + "timeStamp": "2021-04-20T11:00:00Z", + "average": 7.0, + "minimum": 7.0, + "maximum": 7.0 + }, + { + "timeStamp": "2021-04-20T12:00:00Z", + "average": 7.0, + "minimum": 7.0, + "maximum": 7.0 + }, + { + "timeStamp": "2021-04-20T13:00:00Z", + "average": 7.0, + "minimum": 7.0, + "maximum": 7.0 + } + ] + }, + { + "metadatavalues": [ + { + "name": { + "value": "tier", + "localizedValue": "tier" + }, + "value": "Standard" + } + ], + "data": [ + { + "timeStamp": "2021-04-20T09:00:00Z", + "average": 2.0, + "minimum": 2.0, + "maximum": 2.0 + }, + { + "timeStamp": "2021-04-20T10:00:00Z", + "average": 2.0, + "minimum": 2.0, + "maximum": 2.0 + }, + { + "timeStamp": "2021-04-20T11:00:00Z", + "average": 2.0, + "minimum": 2.0, + "maximum": 2.0 + }, + { + "timeStamp": "2021-04-20T12:00:00Z", + "average": 2.0, + "minimum": 2.0, + "maximum": 2.0 + }, + { + "timeStamp": "2021-04-20T13:00:00Z", + "average": 2.0, + "minimum": 2.0, + "maximum": 2.0 + } + ] + }, + { + "metadatavalues": [ + { + "name": { + "value": "tier", + "localizedValue": "tier" + }, + "value": "Cool" + } + ], + "data": [ + { + "timeStamp": "2021-04-20T09:00:00Z", + "average": 0.0, + "minimum": 0.0, + "maximum": 0.0 + }, + { + "timeStamp": "2021-04-20T10:00:00Z", + "average": 0.0, + "minimum": 0.0, + "maximum": 0.0 + }, + { + "timeStamp": "2021-04-20T11:00:00Z", + "average": 0.0, + "minimum": 0.0, + "maximum": 0.0 + }, + { + "timeStamp": "2021-04-20T12:00:00Z", + "average": 0.0, + "minimum": 0.0, + "maximum": 0.0 + }, + { + "timeStamp": "2021-04-20T13:00:00Z", + "average": 0.0, + "minimum": 0.0, + "maximum": 0.0 + } + ] + }, + { + "metadatavalues": [ + { + "name": { + "value": "tier", + "localizedValue": "tier" + }, + "value": "Archive" + } + ], + "data": [ + { + "timeStamp": "2021-04-20T09:00:00Z", + "average": 0.0, + "minimum": 0.0, + "maximum": 0.0 + }, + { + "timeStamp": "2021-04-20T10:00:00Z", + "average": 0.0, + "minimum": 0.0, + "maximum": 0.0 + }, + { + "timeStamp": "2021-04-20T11:00:00Z", + "average": 0.0, + "minimum": 0.0, + "maximum": 0.0 + }, + { + "timeStamp": "2021-04-20T12:00:00Z", + "average": 0.0, + "minimum": 0.0, + "maximum": 0.0 + }, + { + "timeStamp": "2021-04-20T13:00:00Z", + "average": 0.0, + "minimum": 0.0, + "maximum": 0.0 + } + ] + }, + { + "metadatavalues": [ + { + "name": { + "value": "tier", + "localizedValue": "tier" + }, + "value": "Untiered" + } + ], + "data": [ + { + "timeStamp": "2021-04-20T09:00:00Z", + "average": 0.0, + "minimum": 0.0, + "maximum": 0.0 + }, + { + "timeStamp": "2021-04-20T10:00:00Z", + "average": 0.0, + "minimum": 0.0, + "maximum": 0.0 + }, + { + "timeStamp": "2021-04-20T11:00:00Z", + "average": 0.0, + "minimum": 0.0, + "maximum": 0.0 + }, + { + "timeStamp": "2021-04-20T12:00:00Z", + "average": 0.0, + "minimum": 0.0, + "maximum": 0.0 + }, + { + "timeStamp": "2021-04-20T13:00:00Z", + "average": 0.0, + "minimum": 0.0, + "maximum": 0.0 + } + ] + } + ], + "errorCode": "Success" + }, + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default/providers/Microsoft.Insights/metrics/BlobCapacity", + "type": "Microsoft.Insights/metrics", + "name": { + "value": "BlobCapacity", + "localizedValue": "Blob Capacity" + }, + "displayDescription": "The amount of storage used by the storage account’s Blob service in bytes.", + "unit": "Bytes", + "timeseries": [ + { + "metadatavalues": [ + { + "name": { + "value": "tier", + "localizedValue": "tier" + }, + "value": "Standard" + } + ], + "data": [ + { + "timeStamp": "2021-04-20T09:00:00Z", + "average": 621492.0, + "minimum": 621492.0, + "maximum": 621492.0 + }, + { + "timeStamp": "2021-04-20T10:00:00Z", + "average": 621492.0, + "minimum": 621492.0, + "maximum": 621492.0 + }, + { + "timeStamp": "2021-04-20T11:00:00Z", + "average": 621492.0, + "minimum": 621492.0, + "maximum": 621492.0 + }, + { + "timeStamp": "2021-04-20T12:00:00Z", + "average": 621492.0, + "minimum": 621492.0, + "maximum": 621492.0 + }, + { + "timeStamp": "2021-04-20T13:00:00Z", + "average": 621492.0, + "minimum": 621492.0, + "maximum": 621492.0 + } + ] + }, + { + "metadatavalues": [ + { + "name": { + "value": "tier", + "localizedValue": "tier" + }, + "value": "Hot" + } + ], + "data": [ + { + "timeStamp": "2021-04-20T09:00:00Z", + "average": 4733.0, + "minimum": 4733.0, + "maximum": 4733.0 + }, + { + "timeStamp": "2021-04-20T10:00:00Z", + "average": 4733.0, + "minimum": 4733.0, + "maximum": 4733.0 + }, + { + "timeStamp": "2021-04-20T11:00:00Z", + "average": 4733.0, + "minimum": 4733.0, + "maximum": 4733.0 + }, + { + "timeStamp": "2021-04-20T12:00:00Z", + "average": 4733.0, + "minimum": 4733.0, + "maximum": 4733.0 + }, + { + "timeStamp": "2021-04-20T13:00:00Z", + "average": 4733.0, + "minimum": 4733.0, + "maximum": 4733.0 + } + ] + }, + { + "metadatavalues": [ + { + "name": { + "value": "tier", + "localizedValue": "tier" + }, + "value": "Archive" + } + ], + "data": [ + { + "timeStamp": "2021-04-20T09:00:00Z", + "average": 0.0, + "minimum": 0.0, + "maximum": 0.0 + }, + { + "timeStamp": "2021-04-20T10:00:00Z", + "average": 0.0, + "minimum": 0.0, + "maximum": 0.0 + }, + { + "timeStamp": "2021-04-20T11:00:00Z", + "average": 0.0, + "minimum": 0.0, + "maximum": 0.0 + }, + { + "timeStamp": "2021-04-20T12:00:00Z", + "average": 0.0, + "minimum": 0.0, + "maximum": 0.0 + }, + { + "timeStamp": "2021-04-20T13:00:00Z", + "average": 0.0, + "minimum": 0.0, + "maximum": 0.0 + } + ] + }, + { + "metadatavalues": [ + { + "name": { + "value": "tier", + "localizedValue": "tier" + }, + "value": "Untiered" + } + ], + "data": [ + { + "timeStamp": "2021-04-20T09:00:00Z", + "average": 0.0, + "minimum": 0.0, + "maximum": 0.0 + }, + { + "timeStamp": "2021-04-20T10:00:00Z", + "average": 0.0, + "minimum": 0.0, + "maximum": 0.0 + }, + { + "timeStamp": "2021-04-20T11:00:00Z", + "average": 0.0, + "minimum": 0.0, + "maximum": 0.0 + }, + { + "timeStamp": "2021-04-20T12:00:00Z", + "average": 0.0, + "minimum": 0.0, + "maximum": 0.0 + }, + { + "timeStamp": "2021-04-20T13:00:00Z", + "average": 0.0, + "minimum": 0.0, + "maximum": 0.0 + } + ] + }, + { + "metadatavalues": [ + { + "name": { + "value": "tier", + "localizedValue": "tier" + }, + "value": "Cool" + } + ], + "data": [ + { + "timeStamp": "2021-04-20T09:00:00Z", + "average": 0.0, + "minimum": 0.0, + "maximum": 0.0 + }, + { + "timeStamp": "2021-04-20T10:00:00Z", + "average": 0.0, + "minimum": 0.0, + "maximum": 0.0 + }, + { + "timeStamp": "2021-04-20T11:00:00Z", + "average": 0.0, + "minimum": 0.0, + "maximum": 0.0 + }, + { + "timeStamp": "2021-04-20T12:00:00Z", + "average": 0.0, + "minimum": 0.0, + "maximum": 0.0 + }, + { + "timeStamp": "2021-04-20T13:00:00Z", + "average": 0.0, + "minimum": 0.0, + "maximum": 0.0 + } + ] + } + ], + "errorCode": "Success" + } + ], + "namespace": "microsoft.storage/storageaccounts/blobservices", + "resourceregion": "westus2" + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-07-01/examples/GetMetricError.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-07-01/examples/GetMetricError.json new file mode 100644 index 000000000000..cbee7bdacca4 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-07-01/examples/GetMetricError.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "resourceUri": "subscriptions/ac41e21f-afd6-4a79-8070-f01eba278f97/resourceGroups/todking/providers/Microsoft.DocumentDb/databaseAccounts/tk-cosmos-mongo", + "timespan": "2021-06-07T21:51:00Z/2021-06-08T01:51:00Z", + "metricnames": "MongoRequestsCount,MongoRequests", + "metricnamespace": "microsoft.documentdb/databaseaccounts", + "aggregation": "average", + "interval": "FULL", + "AutoAdjustTimegrain": true, + "ValidateDimensions": false, + "api-version": "2019-07-01" + }, + "responses": { + "200": { + "body": { + "cost": 239, + "timespan": "2021-06-07T21:51:00Z/2021-06-08T01:51:00Z", + "interval": "PT4H", + "value": [ + { + "id": "/subscriptions/ac41e21f-afd6-4a79-8070-f01eba278f97/resourceGroups/todking/providers/Microsoft.DocumentDb/databaseAccounts/tk-cosmos-mongo/providers/Microsoft.Insights/metrics/MongoRequestsCount", + "type": "Microsoft.Insights/metrics", + "name": { + "value": "MongoRequestsCount", + "localizedValue": "(deprecated) Mongo Request Rate" + }, + "unit": "CountPerSecond", + "timeseries": [], + "errorMessage": "Sampling type is not found. Metric:CosmosDBCustomer,AzureMonitor,MongoRequests, SamplingType:NullableAverage.", + "errorCode": "InvalidSamplingType" + }, + { + "id": "/subscriptions/ac41e21f-afd6-4a79-8070-f01eba278f97/resourceGroups/todking/providers/Microsoft.DocumentDb/databaseAccounts/tk-cosmos-mongo/providers/Microsoft.Insights/metrics/MongoRequests", + "type": "Microsoft.Insights/metrics", + "name": { + "value": "MongoRequests", + "localizedValue": "Mongo Requests" + }, + "displayDescription": "Number of Mongo Requests Made", + "unit": "Count", + "timeseries": [ + { + "metadatavalues": [], + "data": [ + { + "timeStamp": "2021-06-07T21:51:00Z", + "average": 0.0 + } + ] + } + ], + "errorCode": "Success" + } + ], + "namespace": "microsoft.documentdb/databaseaccounts", + "resourceregion": "westus2" + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-07-01/examples/GetMetricMetadata.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-07-01/examples/GetMetricMetadata.json new file mode 100644 index 000000000000..39f44291cfa3 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-07-01/examples/GetMetricMetadata.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "resourceUri": "subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default", + "timespan": "2017-04-14T02:20:00Z/2017-04-14T04:20:00Z", + "metric": "BlobCount", + "metricnamespace": "Microsoft.Storage/storageAccounts/blobServices", + "$filter": "Tier eq '*'", + "resulttype": "metadata", + "api-version": "2019-07-01" + }, + "responses": { + "200": { + "body": { + "timespan": "2021-04-15T02:18:00Z/2021-04-22T02:18:00Z", + "interval": "PT1H", + "value": [ + { + "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default/providers/Microsoft.Insights/metrics/BlobCount", + "type": "Microsoft.Insights/metrics", + "name": { + "value": "BlobCount", + "localizedValue": "Blob Count" + }, + "displayDescription": "The number of blob objects stored in the storage account.", + "unit": "Count", + "timeseries": [ + { + "metadatavalues": [ + { + "name": { + "value": "tier", + "localizedValue": "tier" + }, + "value": "Cool" + } + ] + }, + { + "metadatavalues": [ + { + "name": { + "value": "tier", + "localizedValue": "tier" + }, + "value": "Archive" + } + ] + }, + { + "metadatavalues": [ + { + "name": { + "value": "tier", + "localizedValue": "tier" + }, + "value": "Standard" + } + ] + }, + { + "metadatavalues": [ + { + "name": { + "value": "tier", + "localizedValue": "tier" + }, + "value": "Untiered" + } + ] + }, + { + "metadatavalues": [ + { + "name": { + "value": "tier", + "localizedValue": "tier" + }, + "value": "Hot" + } + ] + } + ] + } + ], + "namespace": "microsoft.storage/storageaccounts/blobservices", + "resourceregion": "westus2" + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-07-01/examples/OperationList.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-07-01/examples/OperationList.json new file mode 100644 index 000000000000..16931d6c5c14 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-07-01/examples/OperationList.json @@ -0,0 +1,6886 @@ +{ + "parameters": { + "api-version": "2019-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Insights/Operations/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Operations", + "operation": "Read operations", + "description": "Read operations" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Metrics/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Action", + "operation": "Metric Action", + "description": "Metric Action" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MetricDefinitions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Definitions", + "operation": "Read metric definitions", + "description": "Read metric definitions" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MetricDefinitions/Microsoft.Insights/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Definitions", + "operation": "Read metric definitions", + "description": "Read metric definitions" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MetricDefinitions/providers/Microsoft.Insights/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Definitions", + "operation": "Read metric definitions", + "description": "Read metric definitions" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Metrics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metrics", + "operation": "Read metrics", + "description": "Read metrics" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Metricnamespaces/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric namespaces", + "operation": "Metric namespaces read", + "description": "Read metric namespaces" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Metrics/Write", + "isDataAction": true, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metrics", + "operation": "Write metrics", + "description": "Write metrics" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Metrics/providers/Metrics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metrics", + "operation": "Read metrics", + "description": "Read metrics" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Metrics/Microsoft.Insights/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metrics", + "operation": "Read metrics", + "description": "Read metrics" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AlertRules/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Classic Metric Alerts", + "operation": "Create or update classic metric alert", + "description": "Create or update a classic metric alert" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AlertRules/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Classic Metric Alerts", + "operation": "Delete classic metric alert", + "description": "Delete a classic metric alert" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AlertRules/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Classic Metric Alerts", + "operation": "Read classic metric alert", + "description": "Read a classic metric alert" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MetricAlerts/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Alerts", + "operation": "Create or update metric alert", + "description": "Create or update a metric alert" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MetricAlerts/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Alerts", + "operation": "Delete metric alert", + "description": "Delete a metric alert" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MetricAlerts/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Alerts", + "operation": "Read metric alert", + "description": "Read a metric alert" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MetricAlerts/Status/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Alerts", + "operation": "Read metric alert status", + "description": "Read metric alert status" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Autoscale Setting", + "operation": "Create or update autoscale setting", + "description": "Create or update an autoscale setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Autoscale Setting", + "operation": "Delete autoscale setting", + "description": "Delete an autoscale setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Autoscale Setting", + "operation": "Read autoscale setting", + "description": "Read an autoscale setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AlertRules/Incidents/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Alert Rule Incident resource", + "operation": "Read classic metric alert incidents", + "description": "Read a classic metric alert incident" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/providers/Microsoft.Insights/MetricDefinitions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Definitions", + "operation": "Read metric definitions", + "description": "Read metric definitions" + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "ObservedMetricValue", + "displayName": "Observed Metric Value", + "internalMetricName": null, + "displayDescription": "The value computed by autoscale when executed", + "unit": "Count", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": null, + "dimensions": [ + { + "name": "MetricTriggerSource", + "displayName": "Metric Trigger Source", + "toBeExportedForShoebox": true, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": null, + "lockAggregationType": null + }, + { + "name": "MetricThreshold", + "displayName": "Metric Threshold", + "internalMetricName": null, + "displayDescription": "The configured autoscale threshold when autoscale ran.", + "unit": "Count", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": null, + "dimensions": [ + { + "name": "MetricTriggerRule", + "displayName": "Metric Trigger Rule", + "toBeExportedForShoebox": true, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": null, + "lockAggregationType": null + }, + { + "name": "ObservedCapacity", + "displayName": "Observed Capacity", + "internalMetricName": null, + "displayDescription": "The capacity reported to autoscale when it executed.", + "unit": "Count", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": null, + "dimensions": null, + "supportedAggregationTypes": null, + "lockAggregationType": null + }, + { + "name": "ScaleActionsInitiated", + "displayName": "Scale Actions Initiated", + "internalMetricName": null, + "displayDescription": "The direction of the scale operation.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": null, + "fillGapWithZero": true, + "category": null, + "dimensions": [ + { + "name": "ScaleDirection", + "displayName": "Scale Direction", + "toBeExportedForShoebox": true, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": null, + "lockAggregationType": null + } + ], + "logSpecifications": null, + "legacyMetricSpecifications": null + } + } + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/providers/Microsoft.Insights/logDefinitions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Log Definitions", + "operation": "Log Definitions read", + "description": "Read log definitions" + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": null, + "logSpecifications": [ + { + "name": "AutoscaleEvaluations", + "displayName": "Autoscale Evaluations", + "blobDuration": "PT1H" + }, + { + "name": "AutoscaleScaleActions", + "displayName": "Autoscale Scale Actions", + "blobDuration": "PT1H" + } + ], + "legacyMetricSpecifications": null + } + } + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/providers/Microsoft.Insights/diagnosticSettings/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Resource diagnostic settings", + "operation": "Read resource diagnostic setting", + "description": "Read a resource diagnostic setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/providers/Microsoft.Insights/diagnosticSettings/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Resource diagnostic settings", + "operation": "Create or update resource diagnostic setting", + "description": "Create or update a resource diagnostic setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ActionGroups/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Action Groups", + "operation": "Create or update action group", + "description": "Create or update an action group" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ActionGroups/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Action Groups", + "operation": "Delete action group", + "description": "Delete an action group" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ActionGroups/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Action Groups", + "operation": "Read action group", + "description": "Read an action group" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ActivityLogAlerts/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Activity Log Alert", + "operation": "Create or update activity log alert", + "description": "Create or update an activity log alert" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ActivityLogAlerts/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Activity Log Alert", + "operation": "Delete activity log alert", + "description": "Delete an activity log alert" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ActivityLogAlerts/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Activity Log Alert", + "operation": "Read activity log alert", + "description": "Read an activity log alert" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ActivityLogAlerts/Activated/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Activity Log Alert", + "operation": "Activity Log Alert activated", + "description": "Activity Log Alert activated" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/EventCategories/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Activity Log event category", + "operation": "Read Activity Log event categories", + "description": "Read available Activity Log event categories" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/eventtypes/values/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Activity Log Events", + "operation": "Read Activity Log", + "description": "Read Activity Log events" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/eventtypes/digestevents/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Digest events", + "operation": "Event types management digest read", + "description": "Read management event type digest" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DiagnosticSettings/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Resource diagnostic settings", + "operation": "Create or update resource diagnostic setting", + "description": "Create or update a resource diagnostic setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DiagnosticSettingsCategories/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Diagnostic settings categories resource", + "operation": "Read diagnostic settings categories", + "description": "Read diagnostic settings categories" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DiagnosticSettings/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Resource diagnostic settings", + "operation": "Delete resource diagnostic setting", + "description": "Delete a resource diagnostic setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DiagnosticSettings/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Resource diagnostic settings", + "operation": "Read resource diagnostic setting", + "description": "Read a resource diagnostic setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ExtendedDiagnosticSettings/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Network flow log diagnostic setting", + "operation": "Create or update network flow log diagnostic setting", + "description": "Create or update a network flow log diagnostic setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ExtendedDiagnosticSettings/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Network flow log diagnostic setting", + "operation": "Delete network flow log diagnostic setting", + "description": "Delete a network flow log diagnostic setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ExtendedDiagnosticSettings/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Network flow log diagnostic setting", + "operation": "Read network flow log diagnostic setting", + "description": "Read a network flow log diagnostic setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/LogProfiles/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Log Profiles", + "operation": "Create or update Activity Log log profile", + "description": "Create or update an Activity Log log profile" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/LogProfiles/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Log Profiles", + "operation": "Delete Activity Log log profile", + "description": "Delete an Activity Log log profile" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/LogProfiles/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Log Profiles", + "operation": "Read Activity Log log profile", + "description": "Read an Activity Log log profile" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/LogDefinitions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Log Definitions", + "operation": "Log Definitions read", + "description": "Read log definitions" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/Scaleup/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Autoscale Setting", + "operation": "Autoscale scale up initiated", + "description": "Autoscale scale up initiated" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/Scaledown/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Autoscale Setting", + "operation": "Autoscale scale down initiated", + "description": "Autoscale scale down initiated" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/ScaleupResult/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Autoscale Setting", + "operation": "Autoscale scale up completed", + "description": "Autoscale scale up completed" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AutoscaleSettings/ScaledownResult/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Autoscale Setting", + "operation": "Autoscale scale down completed", + "description": "Autoscale scale down completed" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AlertRules/Activated/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Classic Metric Alerts", + "operation": "Classic metric alert activated", + "description": "Classic metric alert activated" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AlertRules/Resolved/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Classic Metric Alerts", + "operation": "Classic metric alert resolved", + "description": "Classic metric alert resolved" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/AlertRules/Throttled/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Classic Metric Alerts", + "operation": "Classic metric alert rule throttled", + "description": "Classic metric alert rule throttled" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Register/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Microsoft.Insights", + "operation": "Register Microsoft.Insights", + "description": "Register the Microsoft Insights provider" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Unregister/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Microsoft.Insights", + "operation": "Register Microsoft.Insights", + "description": "Register the Microsoft Insights provider" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Tenants/Register/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Microsoft.Insights", + "operation": "Initialize Microsoft.Insights", + "description": "Initializes the Microsoft Insights provider" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/AnalyticsItems/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights analytics item", + "operation": "Application Insights analytics item delete", + "description": "Deleting an Application Insights analytics item" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/AnalyticsItems/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights analytics item", + "operation": "Application Insights analytics item read", + "description": "Reading an Application Insights analytics item" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/AnalyticsItems/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights analytics item", + "operation": "Application Insights analytics item write", + "description": "Writing an Application Insights analytics item" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/MyAnalyticsItems/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights analytics item", + "operation": "Application Insights personal analytics item delete", + "description": "Deleting an Application Insights personal analytics item" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/MyAnalyticsItems/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights analytics item", + "operation": "Application Insights personal analytics item write", + "description": "Writing an Application Insights personal analytics item" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/MyAnalyticsItems/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights analytics item", + "operation": "Application Insights personal analytics item read", + "description": "Reading an Application Insights personal analytics item" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/AnalyticsTables/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights analytics table", + "operation": "Application Insights analytics table action", + "description": "Application Insights analytics table action" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/AnalyticsTables/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights analytics table", + "operation": "Application Insights analytics table delete", + "description": "Deleting an Application Insights analytics table schema" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/AnalyticsTables/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights analytics table", + "operation": "Application Insights analytics table read", + "description": "Reading an Application Insights analytics table schema" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/AnalyticsTables/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights analytics table", + "operation": "Application Insights analytics table write", + "description": "Writing an Application Insights analytics table schema" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Annotations/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights annotations", + "operation": "Application Insights annotations delete", + "description": "Deleting an Application Insights annotation" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Annotations/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights annotations", + "operation": "Application Insights annotations read", + "description": "Reading an Application Insights annotation" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Annotations/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights annotations", + "operation": "Application Insights annotation write", + "description": "Writing an Application Insights annotation" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/ApiKeys/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights API key", + "operation": "Application Insights API key delete", + "description": "Deleting an Application Insights API key" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/ApiKeys/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights API key", + "operation": "Application Insights API key read", + "description": "Reading an Application Insights API key" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/ApiKeys/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights API key", + "operation": "Application Insights API key generate", + "description": "Generating an Application Insights API key" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Purge/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights Purge", + "operation": "Application Insights Purge Data action", + "description": "Purging data from Application Insights" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Operations/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights Operations", + "operation": "Application Insights Operations read", + "description": "Get status of long-running operations in Application Insights" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Events/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights Events", + "operation": "Application Insights Events read", + "description": "Get logs from Application Insights using OData query format" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Query/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights Query", + "operation": "Application Insights Query read", + "description": "Run queries against Application Insights logs" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/BillingPlanForComponent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Billing plan for Application Insights component", + "operation": "Billing plan for Application Insights component read", + "description": "Reading a billing plan for Application Insights component" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/CurrentBillingFeatures/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Current billing features for Application Insights component", + "operation": "Current billing features for Application Insights component read", + "description": "Reading current billing features for Application Insights component" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/CurrentBillingFeatures/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Current billing features for Application Insights component", + "operation": "Current billing features for Application Insights component write", + "description": "Writing current billing features for Application Insights component" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/FeatureCapabilities/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component feature capabilities", + "operation": "Application Insights component feature capabilities read", + "description": "Reading Application Insights component feature capabilities" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/GetAvailableBillingFeatures/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component available billing features", + "operation": "Application Insights component available billing features read", + "description": "Reading Application Insights component available billing features" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/PricingPlans/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component pricing plan", + "operation": "Application Insights component pricing plan read", + "description": "Reading an Application Insights component pricing plan" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/PricingPlans/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component pricing plan", + "operation": "Application Insights component pricing plan write", + "description": "Writing an Application Insights component pricing plan" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/QuotaStatus/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component quota status", + "operation": "Application Insights component quota status read", + "description": "Reading Application Insights component quota status" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/DailyCapReached/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component daily cap reached", + "operation": "Application Insights component daily cap reached", + "description": "Reached the daily cap for Application Insights component" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/DailyCapWarningThresholdReached/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component daily cap warning threshold reached", + "operation": "Application Insights component daily cap warning threshold reached", + "description": "Reached the daily cap warning threshold for Application Insights component" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application insights components", + "operation": "Application insights component write", + "description": "Writing to an application insights component configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application insights components", + "operation": "Application insights component delete", + "description": "Deleting an application insights component configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application insights components", + "operation": "Application insights component read", + "description": "Reading an application insights component configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Api/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component data API", + "operation": "Application Insights component data API read", + "description": "Reading Application Insights component data API" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/ExtendQueries/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component extended query results", + "operation": "Application Insights component extended query results read", + "description": "Reading Application Insights component extended query results" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/GetToken/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component token", + "operation": "Application Insights component token read", + "description": "Reading an Application Insights component token" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/MetricDefinitions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component metric definitions", + "operation": "Application Insights component metric definitions read", + "description": "Reading Application Insights component metric definitions" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Metrics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights component metrics", + "operation": "Application Insights component metrics read", + "description": "Reading Application Insights component metrics" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/providers/Microsoft.Insights/logDefinitions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Log Definitions", + "operation": "Log Definitions read", + "description": "Read log definitions" + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": null, + "logSpecifications": [ + { + "name": "AppAvailabilityResults", + "displayName": "Availability results", + "blobDuration": "PT1H" + }, + { + "name": "AppBrowserTimings", + "displayName": "Browser timings", + "blobDuration": "PT1H" + }, + { + "name": "AppEvents", + "displayName": "Events", + "blobDuration": "PT1H" + }, + { + "name": "AppMetrics", + "displayName": "Metrics", + "blobDuration": "PT1H" + }, + { + "name": "AppDependencies", + "displayName": "Dependencies", + "blobDuration": "PT1H" + }, + { + "name": "AppExceptions", + "displayName": "Exceptions", + "blobDuration": "PT1H" + }, + { + "name": "AppPageViews", + "displayName": "Page views", + "blobDuration": "PT1H" + }, + { + "name": "AppPerformanceCounters", + "displayName": "Performance counters", + "blobDuration": "PT1H" + }, + { + "name": "AppRequests", + "displayName": "Requests", + "blobDuration": "PT1H" + }, + { + "name": "AppSystemEvents", + "displayName": "System events", + "blobDuration": "PT1H" + }, + { + "name": "AppTraces", + "displayName": "Traces", + "blobDuration": "PT1H" + } + ], + "legacyMetricSpecifications": null + } + } + }, + { + "name": "Microsoft.Insights/Components/providers/Microsoft.Insights/diagnosticSettings/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Resource diagnostic settings", + "operation": "Read resource diagnostic setting", + "description": "Read a resource diagnostic setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/providers/Microsoft.Insights/diagnosticSettings/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Resource diagnostic settings", + "operation": "Create or update resource diagnostic setting", + "description": "Create or update a resource diagnostic setting" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/ExportConfiguration/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights export settings", + "operation": "Application Insights export settings action", + "description": "Application Insights export settings action" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/ExportConfiguration/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights export settings", + "operation": "Application Insights export settings delete", + "description": "Deleting Application Insights export settings" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/ExportConfiguration/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights export settings", + "operation": "Application Insights export settings read", + "description": "Reading Application Insights export settings" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/ExportConfiguration/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights export settings", + "operation": "Application Insights export settings write", + "description": "Writing Application Insights export settings" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Favorites/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights favorites", + "operation": "Application Insights favorites delete", + "description": "Deleting an Application Insights favorite" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Favorites/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights favorites", + "operation": "Application Insights favorites read", + "description": "Reading an Application Insights favorite" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Favorites/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights favorites", + "operation": "Application Insights favorite write", + "description": "Writing an Application Insights favorite" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/MyFavorites/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights favorites", + "operation": "Application Insights personal favorites read", + "description": "Reading an Application Insights personal favorite" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/generateLiveToken/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights Live Metrics token", + "operation": "Get Live Metrics token", + "description": "Live Metrics get token" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/providers/Microsoft.Insights/MetricDefinitions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Definitions", + "operation": "Read metric definitions", + "description": "Read metric definitions" + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "availabilityResults/availabilityPercentage", + "displayName": "Availability", + "internalMetricName": null, + "displayDescription": "Percentage of successfully completed availability tests", + "unit": "Percent", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Availability", + "dimensions": [ + { + "name": "availabilityResult/name", + "displayName": "Test name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "availabilityResult/location", + "displayName": "Run location", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average" + ], + "lockAggregationType": null + }, + { + "name": "availabilityResults/count", + "displayName": "Availability tests", + "internalMetricName": "availabilityResults/duration", + "displayDescription": "Count of availability tests", + "unit": "Count", + "aggregationType": "Count", + "availabilities": null, + "fillGapWithZero": true, + "category": "Availability", + "dimensions": [ + { + "name": "availabilityResult/name", + "displayName": "Test name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "availabilityResult/location", + "displayName": "Run location", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "availabilityResult/success", + "displayName": "Test result", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Count" + ], + "lockAggregationType": null + }, + { + "name": "availabilityResults/duration", + "displayName": "Availability test duration", + "internalMetricName": null, + "displayDescription": "Availability test duration", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Availability", + "dimensions": [ + { + "name": "availabilityResult/name", + "displayName": "Test name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "availabilityResult/location", + "displayName": "Run location", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "availabilityResult/success", + "displayName": "Test result", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "browserTimings/networkDuration", + "displayName": "Page load network connect time", + "internalMetricName": null, + "displayDescription": "Time between user request and network connection. Includes DNS lookup and transport connection.", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Browser", + "dimensions": null, + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "browserTimings/processingDuration", + "displayName": "Client processing time", + "internalMetricName": null, + "displayDescription": "Time between receiving the last byte of a document until the DOM is loaded. Async requests may still be processing.", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Browser", + "dimensions": null, + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "browserTimings/receiveDuration", + "displayName": "Receiving response time", + "internalMetricName": null, + "displayDescription": "Time between the first and last bytes, or until disconnection.", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Browser", + "dimensions": null, + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "browserTimings/sendDuration", + "displayName": "Send request time", + "internalMetricName": null, + "displayDescription": "Time between network connection and receiving the first byte.", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Browser", + "dimensions": null, + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "browserTimings/totalDuration", + "displayName": "Browser page load time", + "internalMetricName": null, + "displayDescription": "Time from user request until DOM, stylesheets, scripts and images are loaded.", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Browser", + "dimensions": null, + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "dependencies/count", + "displayName": "Dependency calls", + "internalMetricName": "dependencies/duration", + "displayDescription": "Count of calls made by the application to external resources.", + "unit": "Count", + "aggregationType": "Count", + "availabilities": null, + "fillGapWithZero": true, + "category": "Server", + "dimensions": [ + { + "name": "dependency/type", + "displayName": "Dependency type", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/performanceBucket", + "displayName": "Dependency performance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/success", + "displayName": "Successful call", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/target", + "displayName": "Target of a dependency call", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/resultCode", + "displayName": "Result code", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "operation/synthetic", + "displayName": "Is traffic synthetic", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Count" + ], + "lockAggregationType": null + }, + { + "name": "dependencies/duration", + "displayName": "Dependency duration", + "internalMetricName": null, + "displayDescription": "Duration of calls made by the application to external resources.", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Server", + "dimensions": [ + { + "name": "dependency/type", + "displayName": "Dependency type", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/performanceBucket", + "displayName": "Dependency performance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/success", + "displayName": "Successful call", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/target", + "displayName": "Target of a dependency call", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/resultCode", + "displayName": "Result code", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "operation/synthetic", + "displayName": "Is traffic synthetic", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "dependencies/failed", + "displayName": "Dependency call failures", + "internalMetricName": "dependencies/duration", + "displayDescription": "Count of failed dependency calls made by the application to external resources.", + "unit": "Count", + "aggregationType": "Count", + "availabilities": null, + "fillGapWithZero": true, + "category": "Failures", + "dimensions": [ + { + "name": "dependency/type", + "displayName": "Dependency type", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/performanceBucket", + "displayName": "Dependency performance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/success", + "displayName": "Successful call", + "toBeExportedForShoebox": false, + "isHidden": true, + "defaultDimensionValues": [ + { + "value": "False" + } + ] + }, + { + "name": "dependency/target", + "displayName": "Target of a dependency call", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "dependency/resultCode", + "displayName": "Result code", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "operation/synthetic", + "displayName": "Is traffic synthetic", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Count" + ], + "lockAggregationType": null + }, + { + "name": "pageViews/count", + "displayName": "Page views", + "internalMetricName": null, + "displayDescription": "Count of page views.", + "unit": "Count", + "aggregationType": "Count", + "availabilities": null, + "fillGapWithZero": true, + "category": "Usage", + "dimensions": [ + { + "name": "operation/synthetic", + "displayName": "Is traffic synthetic", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Count" + ], + "lockAggregationType": null + }, + { + "name": "pageViews/duration", + "displayName": "Page view load time", + "internalMetricName": null, + "displayDescription": "Page view load time", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Usage", + "dimensions": [ + { + "name": "operation/synthetic", + "displayName": "Is traffic synthetic", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "performanceCounters/requestExecutionTime", + "displayName": "HTTP request execution time", + "internalMetricName": null, + "displayDescription": "Execution time of the most recent request.", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Performance counters", + "dimensions": [ + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "performanceCounters/requestsInQueue", + "displayName": "HTTP requests in application queue", + "internalMetricName": null, + "displayDescription": "Length of the application request queue.", + "unit": "Count", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": true, + "category": "Performance counters", + "dimensions": [ + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "performanceCounters/requestsPerSecond", + "displayName": "HTTP request rate", + "internalMetricName": null, + "displayDescription": "Rate of all requests to the application per second from ASP.NET.", + "unit": "CountPerSecond", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": true, + "category": "Performance counters", + "dimensions": [ + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "performanceCounters/exceptionsPerSecond", + "displayName": "Exception rate", + "internalMetricName": null, + "displayDescription": "Count of handled and unhandled exceptions reported to windows, including .NET exceptions and unmanaged exceptions that are converted into .NET exceptions.", + "unit": "CountPerSecond", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": true, + "category": "Performance counters", + "dimensions": [ + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "performanceCounters/processIOBytesPerSecond", + "displayName": "Process IO rate", + "internalMetricName": null, + "displayDescription": "Total bytes per second read and written to files, network and devices.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Performance counters", + "dimensions": [ + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "performanceCounters/processCpuPercentage", + "displayName": "Process CPU", + "internalMetricName": null, + "displayDescription": "The percentage of elapsed time that all process threads used the processor to execute instructions. This can vary between 0 to 100. This metric indicates the performance of w3wp process alone.", + "unit": "Percent", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Performance counters", + "dimensions": [ + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "performanceCounters/processorCpuPercentage", + "displayName": "Processor time", + "internalMetricName": null, + "displayDescription": "The percentage of time that the processor spends in non-idle threads.", + "unit": "Percent", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Performance counters", + "dimensions": [ + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "performanceCounters/memoryAvailableBytes", + "displayName": "Available memory", + "internalMetricName": null, + "displayDescription": "Physical memory immediately available for allocation to a process or for system use.", + "unit": "Bytes", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Performance counters", + "dimensions": [ + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "performanceCounters/processPrivateBytes", + "displayName": "Process private bytes", + "internalMetricName": null, + "displayDescription": "Memory exclusively assigned to the monitored application's processes.", + "unit": "Bytes", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Performance counters", + "dimensions": [ + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "requests/duration", + "displayName": "Server response time", + "internalMetricName": null, + "displayDescription": "Time between receiving an HTTP request and finishing sending the response.", + "unit": "MilliSeconds", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": false, + "category": "Server", + "dimensions": [ + { + "name": "request/performanceBucket", + "displayName": "Request performance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "request/resultCode", + "displayName": "Result code", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "operation/synthetic", + "displayName": "Is traffic synthetic", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "request/success", + "displayName": "Successful request", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average", + "Maximum", + "Minimum" + ], + "lockAggregationType": null + }, + { + "name": "requests/count", + "displayName": "Server requests", + "internalMetricName": "requests/duration", + "displayDescription": "Count of HTTP requests completed.", + "unit": "Count", + "aggregationType": "Count", + "availabilities": null, + "fillGapWithZero": true, + "category": "Server", + "dimensions": [ + { + "name": "request/performanceBucket", + "displayName": "Request performance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "request/resultCode", + "displayName": "Result code", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "operation/synthetic", + "displayName": "Is traffic synthetic", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "request/success", + "displayName": "Successful request", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Count" + ], + "lockAggregationType": null + }, + { + "name": "requests/failed", + "displayName": "Failed requests", + "internalMetricName": "requests/duration", + "displayDescription": "Count of HTTP requests marked as failed. In most cases these are requests with a response code >= 400 and not equal to 401.", + "unit": "Count", + "aggregationType": "Count", + "availabilities": null, + "fillGapWithZero": true, + "category": "Failures", + "dimensions": [ + { + "name": "request/performanceBucket", + "displayName": "Request performance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "request/resultCode", + "displayName": "Result code", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "request/success", + "displayName": "Successful request", + "toBeExportedForShoebox": false, + "isHidden": true, + "defaultDimensionValues": [ + { + "value": "False" + } + ] + }, + { + "name": "operation/synthetic", + "displayName": "Is traffic synthetic", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Count" + ], + "lockAggregationType": null + }, + { + "name": "requests/rate", + "displayName": "Server request rate", + "internalMetricName": null, + "displayDescription": "Rate of server requests per second", + "unit": "CountPerSecond", + "aggregationType": "Average", + "availabilities": null, + "fillGapWithZero": true, + "category": "Server", + "dimensions": [ + { + "name": "request/performanceBucket", + "displayName": "Request performance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "request/resultCode", + "displayName": "Result code", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "operation/synthetic", + "displayName": "Is traffic synthetic", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "request/success", + "displayName": "Successful request", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Average" + ], + "lockAggregationType": "Average" + }, + { + "name": "exceptions/count", + "displayName": "Exceptions", + "internalMetricName": null, + "displayDescription": "Combined count of all uncaught exceptions.", + "unit": "Count", + "aggregationType": "Count", + "availabilities": null, + "fillGapWithZero": true, + "category": "Failures", + "dimensions": [ + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "client/type", + "displayName": "Device type", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Count" + ], + "lockAggregationType": null + }, + { + "name": "exceptions/browser", + "displayName": "Browser exceptions", + "internalMetricName": "exceptions/count", + "displayDescription": "Count of uncaught exceptions thrown in the browser.", + "unit": "Count", + "aggregationType": "Count", + "availabilities": null, + "fillGapWithZero": true, + "category": "Failures", + "dimensions": [ + { + "name": "client/isServer", + "displayName": null, + "toBeExportedForShoebox": false, + "isHidden": true, + "defaultDimensionValues": [ + { + "value": "False" + } + ] + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Count" + ], + "lockAggregationType": null + }, + { + "name": "exceptions/server", + "displayName": "Server exceptions", + "internalMetricName": "exceptions/count", + "displayDescription": "Count of uncaught exceptions thrown in the server application.", + "unit": "Count", + "aggregationType": "Count", + "availabilities": null, + "fillGapWithZero": true, + "category": "Failures", + "dimensions": [ + { + "name": "client/isServer", + "displayName": null, + "toBeExportedForShoebox": false, + "isHidden": true, + "defaultDimensionValues": [ + { + "value": "True" + } + ] + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Count" + ], + "lockAggregationType": null + }, + { + "name": "traces/count", + "displayName": "Traces", + "internalMetricName": null, + "displayDescription": "Trace document count", + "unit": "Count", + "aggregationType": "Count", + "availabilities": null, + "fillGapWithZero": true, + "category": "Usage", + "dimensions": [ + { + "name": "trace/severityLevel", + "displayName": "Severity level", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "operation/synthetic", + "displayName": "Is traffic synthetic", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleName", + "displayName": "Cloud role name", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + }, + { + "name": "cloud/roleInstance", + "displayName": "Cloud role instance", + "toBeExportedForShoebox": false, + "isHidden": false, + "defaultDimensionValues": null + } + ], + "supportedAggregationTypes": [ + "Count" + ], + "lockAggregationType": null + } + ], + "logSpecifications": null, + "legacyMetricSpecifications": null + } + } + }, + { + "name": "Microsoft.Insights/Components/ProactiveDetectionConfigs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights proactive detection configuration", + "operation": "Application Insights proactive detection configuration read", + "description": "Reading Application Insights proactive detection configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/ProactiveDetectionConfigs/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights proactive detection configuration", + "operation": "Application Insights proactive detection configuration read", + "description": "Writing Application Insights proactive detection configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/SyntheticMonitorLocations/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights webtest location", + "operation": "Application Insights webtest locations read", + "description": "Reading Application Insights webtest locations" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Webtests/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Web tests", + "operation": "Webtest read", + "description": "Reading a webtest configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Webtests/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Web tests", + "operation": "Webtest write", + "description": "Writing to a webtest configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Webtests/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Web tests", + "operation": "Webtest delete", + "description": "Deleting a webtest configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Webtests/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Web tests", + "operation": "Webtest read", + "description": "Reading a webtest configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Webtests/GetToken/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Webtest token", + "operation": "Webtest token read", + "description": "Reading a webtest token" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Webtests/MetricDefinitions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Webtest metric definitions", + "operation": "Webtest metric definitions read", + "description": "Reading a webtest metric definitions" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Webtests/Metrics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Webtest metrics", + "operation": "Webtest metrics read", + "description": "Reading a webtest metrics" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/WorkItemConfigs/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights ALM integration configuration", + "operation": "Application Insights ALM integration configuration delete", + "description": "Deleting an Application Insights ALM integration configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/WorkItemConfigs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights ALM integration configuration", + "operation": "Application Insights ALM integration configuration read", + "description": "Reading an Application Insights ALM integration configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/WorkItemConfigs/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights ALM integration configuration", + "operation": "Application Insights ALM integration configuration write", + "description": "Writing an Application Insights ALM integration configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/DefaultWorkItemConfig/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights ALM integration configuration", + "operation": "Application Insights default ALM integration configuration read", + "description": "Reading an Application Insights default ALM integration configuration" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Components/Move/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application insights components", + "operation": "Application Insights Component Move", + "description": "Move an Application Insights Component to another resource group or subscription" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ListMigrationDate/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "List Migration Date", + "operation": "Subscription migration date read", + "description": "Get back subscription migration date" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ListMigrationDate/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "List Migration Date", + "operation": "Subscription migration date read", + "description": "Get back Subscription migration date" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MigrateToNewpricingModel/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Migrate to new pricing model", + "operation": "Migrate subscription to new pricing model action", + "description": "Migrate subscription to new pricing model" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/RollbackToLegacyPricingModel/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Rollback legacy pricing model", + "operation": "Rollback subscription to legacy pricing model action", + "description": "Rollback subscription to legacy pricing model" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/topology/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights Topology", + "operation": "Read Topology", + "description": "Read Topology" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/transactions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Application Insights Transactions", + "operation": "Read Transactions", + "description": "Read Transactions" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ScheduledQueryRules/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Scheduled query rule", + "operation": "Scheduled query rule write", + "description": "Writing a scheduled query rule" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ScheduledQueryRules/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Scheduled query rule", + "operation": "Scheduled query rule read", + "description": "Reading a scheduled query rule" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/ScheduledQueryRules/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Scheduled query rule", + "operation": "Scheduled query rule delete", + "description": "Deleting a scheduled query rule" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Logs", + "operation": "Read Logs", + "description": "Reading data from all your logs" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AADDomainServicesAccountLogon/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AADDomainServicesAccountLogon", + "operation": "Read AADDomainServicesAccountLogon data", + "description": "Read data from the AADDomainServicesAccountLogon table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AADDomainServicesAccountManagement/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AADDomainServicesAccountManagement", + "operation": "Read AADDomainServicesAccountManagement data", + "description": "Read data from the AADDomainServicesAccountManagement table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AADDomainServicesDirectoryServiceAccess/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AADDomainServicesDirectoryServiceAccess", + "operation": "Read AADDomainServicesDirectoryServiceAccess data", + "description": "Read data from the AADDomainServicesDirectoryServiceAccess table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AADDomainServicesLogonLogoff/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AADDomainServicesLogonLogoff", + "operation": "Read AADDomainServicesLogonLogoff data", + "description": "Read data from the AADDomainServicesLogonLogoff table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AADDomainServicesPolicyChange/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AADDomainServicesPolicyChange", + "operation": "Read AADDomainServicesPolicyChange data", + "description": "Read data from the AADDomainServicesPolicyChange table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AADDomainServicesPrivilegeUse/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AADDomainServicesPrivilegeUse", + "operation": "Read AADDomainServicesPrivilegeUse data", + "description": "Read data from the AADDomainServicesPrivilegeUse table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AADDomainServicesSystemSecurity/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AADDomainServicesSystemSecurity", + "operation": "Read AADDomainServicesSystemSecurity data", + "description": "Read data from the AADDomainServicesSystemSecurity table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AADManagedIdentitySignInLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AADManagedIdentitySignInLogs", + "operation": "Read AADManagedIdentitySignInLogs data", + "description": "Read data from the AADManagedIdentitySignInLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AADNonInteractiveUserSignInLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AADNonInteractiveUserSignInLogs", + "operation": "Read AADNonInteractiveUserSignInLogs data", + "description": "Read data from the AADNonInteractiveUserSignInLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AADServicePrincipalSignInLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AADServicePrincipalSignInLogs", + "operation": "Read AADServicePrincipalSignInLogs data", + "description": "Read data from the AADServicePrincipalSignInLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADAssessmentRecommendation", + "operation": "Read ADAssessmentRecommendation data", + "description": "Read data from the ADAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AddonAzureBackupAlerts/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AddonAzureBackupAlerts", + "operation": "Read AddonAzureBackupAlerts data", + "description": "Read data from the AddonAzureBackupAlerts table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AddonAzureBackupJobs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AddonAzureBackupJobs", + "operation": "Read AddonAzureBackupJobs data", + "description": "Read data from the AddonAzureBackupJobs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AddonAzureBackupPolicy/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AddonAzureBackupPolicy", + "operation": "Read AddonAzureBackupPolicy data", + "description": "Read data from the AddonAzureBackupPolicy table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AddonAzureBackupProtectedInstance/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AddonAzureBackupProtectedInstance", + "operation": "Read AddonAzureBackupProtectedInstance data", + "description": "Read data from the AddonAzureBackupProtectedInstance table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AddonAzureBackupStorage/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AddonAzureBackupStorage", + "operation": "Read AddonAzureBackupStorage data", + "description": "Read data from the AddonAzureBackupStorage table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADFActivityRun/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADFActivityRun", + "operation": "Read ADFActivityRun data", + "description": "Read data from the ADFActivityRun table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADFPipelineRun/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADFPipelineRun", + "operation": "Read ADFPipelineRun data", + "description": "Read data from the ADFPipelineRun table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADFSSISIntegrationRuntimeLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADFSSISIntegrationRuntimeLogs", + "operation": "Read ADFSSISIntegrationRuntimeLogs data", + "description": "Read data from the ADFSSISIntegrationRuntimeLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADFSSISPackageEventMessageContext/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADFSSISPackageEventMessageContext", + "operation": "Read ADFSSISPackageEventMessageContext data", + "description": "Read data from the ADFSSISPackageEventMessageContext table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADFSSISPackageEventMessages/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADFSSISPackageEventMessages", + "operation": "Read ADFSSISPackageEventMessages data", + "description": "Read data from the ADFSSISPackageEventMessages table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADFSSISPackageExecutableStatistics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADFSSISPackageExecutableStatistics", + "operation": "Read ADFSSISPackageExecutableStatistics data", + "description": "Read data from the ADFSSISPackageExecutableStatistics table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADFSSISPackageExecutionComponentPhases/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADFSSISPackageExecutionComponentPhases", + "operation": "Read ADFSSISPackageExecutionComponentPhases data", + "description": "Read data from the ADFSSISPackageExecutionComponentPhases table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADFSSISPackageExecutionDataStatistics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADFSSISPackageExecutionDataStatistics", + "operation": "Read ADFSSISPackageExecutionDataStatistics data", + "description": "Read data from the ADFSSISPackageExecutionDataStatistics table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADFTriggerRun/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADFTriggerRun", + "operation": "Read ADFTriggerRun data", + "description": "Read data from the ADFTriggerRun table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADReplicationResult/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADReplicationResult", + "operation": "Read ADReplicationResult data", + "description": "Read data from the ADReplicationResult table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADSecurityAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADSecurityAssessmentRecommendation", + "operation": "Read ADSecurityAssessmentRecommendation data", + "description": "Read data from the ADSecurityAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADTDigitalTwinsOperation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADTDigitalTwinsOperation", + "operation": "Read ADTDigitalTwinsOperation data", + "description": "Read data from the ADTDigitalTwinsOperation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADTEventRoutesOperation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADTEventRoutesOperation", + "operation": "Read ADTEventRoutesOperation data", + "description": "Read data from the ADTEventRoutesOperation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADTModelsOperation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADTModelsOperation", + "operation": "Read ADTModelsOperation data", + "description": "Read data from the ADTModelsOperation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ADTQueryOperation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ADTQueryOperation", + "operation": "Read ADTQueryOperation data", + "description": "Read data from the ADTQueryOperation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AegDeliveryFailureLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AegDeliveryFailureLogs", + "operation": "Read AegDeliveryFailureLogs data", + "description": "Read data from the AegDeliveryFailureLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AegPublishFailureLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AegPublishFailureLogs", + "operation": "Read AegPublishFailureLogs data", + "description": "Read data from the AegPublishFailureLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Alert/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Alert", + "operation": "Read Alert data", + "description": "Read data from the Alert table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AlertHistory/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AlertHistory", + "operation": "Read AlertHistory data", + "description": "Read data from the AlertHistory table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AmlComputeClusterEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AmlComputeClusterEvent", + "operation": "Read AmlComputeClusterEvent data", + "description": "Read data from the AmlComputeClusterEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AmlComputeClusterNodeEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AmlComputeClusterNodeEvent", + "operation": "Read AmlComputeClusterNodeEvent data", + "description": "Read data from the AmlComputeClusterNodeEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AmlComputeCpuGpuUtilization/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AmlComputeCpuGpuUtilization", + "operation": "Read AmlComputeCpuGpuUtilization data", + "description": "Read data from the AmlComputeCpuGpuUtilization table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AmlComputeJobEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AmlComputeJobEvent", + "operation": "Read AmlComputeJobEvent data", + "description": "Read data from the AmlComputeJobEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AmlRunStatusChangedEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AmlRunStatusChangedEvent", + "operation": "Read AmlRunStatusChangedEvent data", + "description": "Read data from the AmlRunStatusChangedEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ApiManagementGatewayLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ApiManagementGatewayLogs", + "operation": "Read ApiManagementGatewayLogs data", + "description": "Read data from the ApiManagementGatewayLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppAvailabilityResults/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppAvailabilityResults", + "operation": "Read AppAvailabilityResults data", + "description": "Read data from the AppAvailabilityResults table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppBrowserTimings/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppBrowserTimings", + "operation": "Read AppBrowserTimings data", + "description": "Read data from the AppBrowserTimings table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppCenterError/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppCenterError", + "operation": "Read AppCenterError data", + "description": "Read data from the AppCenterError table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppDependencies/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppDependencies", + "operation": "Read AppDependencies data", + "description": "Read data from the AppDependencies table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppEvents/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppEvents", + "operation": "Read AppEvents data", + "description": "Read data from the AppEvents table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppExceptions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppExceptions", + "operation": "Read AppExceptions data", + "description": "Read data from the AppExceptions table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ApplicationInsights/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ApplicationInsights", + "operation": "Read ApplicationInsights data", + "description": "Read data from the ApplicationInsights table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppMetrics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppMetrics", + "operation": "Read AppMetrics data", + "description": "Read data from the AppMetrics table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppPageViews/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppPageViews", + "operation": "Read AppPageViews data", + "description": "Read data from the AppPageViews table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppPerformanceCounters/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppPerformanceCounters", + "operation": "Read AppPerformanceCounters data", + "description": "Read data from the AppPerformanceCounters table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppPlatformLogsforSpring/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppPlatformLogsforSpring", + "operation": "Read AppPlatformLogsforSpring data", + "description": "Read data from the AppPlatformLogsforSpring table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppPlatformSystemLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppPlatformSystemLogs", + "operation": "Read AppPlatformSystemLogs data", + "description": "Read data from the AppPlatformSystemLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppRequests/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppRequests", + "operation": "Read AppRequests data", + "description": "Read data from the AppRequests table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppServiceAntivirusScanLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppServiceAntivirusScanLogs", + "operation": "Read AppServiceAntivirusScanLogs data", + "description": "Read data from the AppServiceAntivirusScanLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppServiceAppLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppServiceAppLogs", + "operation": "Read AppServiceAppLogs data", + "description": "Read data from the AppServiceAppLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppServiceAuditLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppServiceAuditLogs", + "operation": "Read AppServiceAuditLogs data", + "description": "Read data from the AppServiceAuditLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppServiceConsoleLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppServiceConsoleLogs", + "operation": "Read AppServiceConsoleLogs data", + "description": "Read data from the AppServiceConsoleLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppServiceEnvironmentPlatformLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppServiceEnvironmentPlatformLogs", + "operation": "Read AppServiceEnvironmentPlatformLogs data", + "description": "Read data from the AppServiceEnvironmentPlatformLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppServiceFileAuditLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppServiceFileAuditLogs", + "operation": "Read AppServiceFileAuditLogs data", + "description": "Read data from the AppServiceFileAuditLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppServiceHTTPLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppServiceHTTPLogs", + "operation": "Read AppServiceHTTPLogs data", + "description": "Read data from the AppServiceHTTPLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppServicePlatformLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppServicePlatformLogs", + "operation": "Read AppServicePlatformLogs data", + "description": "Read data from the AppServicePlatformLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppSystemEvents/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppSystemEvents", + "operation": "Read AppSystemEvents data", + "description": "Read data from the AppSystemEvents table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AppTraces/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AppTraces", + "operation": "Read AppTraces data", + "description": "Read data from the AppTraces table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AuditLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AuditLogs", + "operation": "Read AuditLogs data", + "description": "Read data from the AuditLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AutoscaleEvaluationsLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AutoscaleEvaluationsLog", + "operation": "Read AutoscaleEvaluationsLog data", + "description": "Read data from the AutoscaleEvaluationsLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AutoscaleScaleActionsLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AutoscaleScaleActionsLog", + "operation": "Read AutoscaleScaleActionsLog data", + "description": "Read data from the AutoscaleScaleActionsLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AWSCloudTrail/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AWSCloudTrail", + "operation": "Read AWSCloudTrail data", + "description": "Read data from the AWSCloudTrail table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AzureActivity/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AzureActivity", + "operation": "Read AzureActivity data", + "description": "Read data from the AzureActivity table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AzureAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AzureAssessmentRecommendation", + "operation": "Read AzureAssessmentRecommendation data", + "description": "Read data from the AzureAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AzureDevOpsAuditing/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AzureDevOpsAuditing", + "operation": "Read AzureDevOpsAuditing data", + "description": "Read data from the AzureDevOpsAuditing table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AzureDiagnostics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AzureDiagnostics", + "operation": "Read AzureDiagnostics data", + "description": "Read data from the AzureDiagnostics table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/AzureMetrics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "AzureMetrics", + "operation": "Read AzureMetrics data", + "description": "Read data from the AzureMetrics table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/BaiClusterEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "BaiClusterEvent", + "operation": "Read BaiClusterEvent data", + "description": "Read data from the BaiClusterEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/BaiClusterNodeEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "BaiClusterNodeEvent", + "operation": "Read BaiClusterNodeEvent data", + "description": "Read data from the BaiClusterNodeEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/BaiJobEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "BaiJobEvent", + "operation": "Read BaiJobEvent data", + "description": "Read data from the BaiJobEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/BehaviorAnalytics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "BehaviorAnalytics", + "operation": "Read BehaviorAnalytics data", + "description": "Read data from the BehaviorAnalytics table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/BlockchainApplicationLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "BlockchainApplicationLog", + "operation": "Read BlockchainApplicationLog data", + "description": "Read data from the BlockchainApplicationLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/BlockchainProxyLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "BlockchainProxyLog", + "operation": "Read BlockchainProxyLog data", + "description": "Read data from the BlockchainProxyLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/BoundPort/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "BoundPort", + "operation": "Read BoundPort data", + "description": "Read data from the BoundPort table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/CommonSecurityLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "CommonSecurityLog", + "operation": "Read CommonSecurityLog data", + "description": "Read data from the CommonSecurityLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ComputerGroup/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ComputerGroup", + "operation": "Read ComputerGroup data", + "description": "Read data from the ComputerGroup table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ConfigurationChange/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ConfigurationChange", + "operation": "Read ConfigurationChange data", + "description": "Read data from the ConfigurationChange table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ConfigurationData/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ConfigurationData", + "operation": "Read ConfigurationData data", + "description": "Read data from the ConfigurationData table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ContainerImageInventory/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ContainerImageInventory", + "operation": "Read ContainerImageInventory data", + "description": "Read data from the ContainerImageInventory table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ContainerInventory/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ContainerInventory", + "operation": "Read ContainerInventory data", + "description": "Read data from the ContainerInventory table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ContainerLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ContainerLog", + "operation": "Read ContainerLog data", + "description": "Read data from the ContainerLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ContainerNodeInventory/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ContainerNodeInventory", + "operation": "Read ContainerNodeInventory data", + "description": "Read data from the ContainerNodeInventory table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ContainerRegistryLoginEvents/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ContainerRegistryLoginEvents", + "operation": "Read ContainerRegistryLoginEvents data", + "description": "Read data from the ContainerRegistryLoginEvents table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ContainerRegistryRepositoryEvents/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ContainerRegistryRepositoryEvents", + "operation": "Read ContainerRegistryRepositoryEvents data", + "description": "Read data from the ContainerRegistryRepositoryEvents table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ContainerServiceLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ContainerServiceLog", + "operation": "Read ContainerServiceLog data", + "description": "Read data from the ContainerServiceLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Tables.Custom/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "CustomLogs", + "operation": "Read Custom Logs", + "description": "Reading data from any custom log" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/CoreAzureBackup/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "CoreAzureBackup", + "operation": "Read CoreAzureBackup data", + "description": "Read data from the CoreAzureBackup table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksAccounts/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksAccounts", + "operation": "Read DatabricksAccounts data", + "description": "Read data from the DatabricksAccounts table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksClusters/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksClusters", + "operation": "Read DatabricksClusters data", + "description": "Read data from the DatabricksClusters table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksDBFS/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksDBFS", + "operation": "Read DatabricksDBFS data", + "description": "Read data from the DatabricksDBFS table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksInstancePools/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksInstancePools", + "operation": "Read DatabricksInstancePools data", + "description": "Read data from the DatabricksInstancePools table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksJobs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksJobs", + "operation": "Read DatabricksJobs data", + "description": "Read data from the DatabricksJobs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksNotebook/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksNotebook", + "operation": "Read DatabricksNotebook data", + "description": "Read data from the DatabricksNotebook table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksSecrets/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksSecrets", + "operation": "Read DatabricksSecrets data", + "description": "Read data from the DatabricksSecrets table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksSQLPermissions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksSQLPermissions", + "operation": "Read DatabricksSQLPermissions data", + "description": "Read data from the DatabricksSQLPermissions table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksSSH/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksSSH", + "operation": "Read DatabricksSSH data", + "description": "Read data from the DatabricksSSH table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksTables/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksTables", + "operation": "Read DatabricksTables data", + "description": "Read data from the DatabricksTables table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DatabricksWorkspace/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DatabricksWorkspace", + "operation": "Read DatabricksWorkspace data", + "description": "Read data from the DatabricksWorkspace table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceAppCrash/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceAppCrash", + "operation": "Read DeviceAppCrash data", + "description": "Read data from the DeviceAppCrash table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceAppLaunch/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceAppLaunch", + "operation": "Read DeviceAppLaunch data", + "description": "Read data from the DeviceAppLaunch table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceCalendar/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceCalendar", + "operation": "Read DeviceCalendar data", + "description": "Read data from the DeviceCalendar table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceCleanup/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceCleanup", + "operation": "Read DeviceCleanup data", + "description": "Read data from the DeviceCleanup table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceConnectSession/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceConnectSession", + "operation": "Read DeviceConnectSession data", + "description": "Read data from the DeviceConnectSession table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceEtw/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceEtw", + "operation": "Read DeviceEtw data", + "description": "Read data from the DeviceEtw table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceHardwareHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceHardwareHealth", + "operation": "Read DeviceHardwareHealth data", + "description": "Read data from the DeviceHardwareHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceHealth", + "operation": "Read DeviceHealth data", + "description": "Read data from the DeviceHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceHeartbeat/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceHeartbeat", + "operation": "Read DeviceHeartbeat data", + "description": "Read data from the DeviceHeartbeat table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceSkypeHeartbeat/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceSkypeHeartbeat", + "operation": "Read DeviceSkypeHeartbeat data", + "description": "Read data from the DeviceSkypeHeartbeat table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceSkypeSignIn/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceSkypeSignIn", + "operation": "Read DeviceSkypeSignIn data", + "description": "Read data from the DeviceSkypeSignIn table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DeviceSleepState/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DeviceSleepState", + "operation": "Read DeviceSleepState data", + "description": "Read data from the DeviceSleepState table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DHAppFailure/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DHAppFailure", + "operation": "Read DHAppFailure data", + "description": "Read data from the DHAppFailure table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DHAppReliability/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DHAppReliability", + "operation": "Read DHAppReliability data", + "description": "Read data from the DHAppReliability table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DHCPActivity/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DHCPActivity", + "operation": "Read DHCPActivity data", + "description": "Read data from the DHCPActivity table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DHDriverReliability/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DHDriverReliability", + "operation": "Read DHDriverReliability data", + "description": "Read data from the DHDriverReliability table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DHLogonFailures/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DHLogonFailures", + "operation": "Read DHLogonFailures data", + "description": "Read data from the DHLogonFailures table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DHLogonMetrics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DHLogonMetrics", + "operation": "Read DHLogonMetrics data", + "description": "Read data from the DHLogonMetrics table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DHOSCrashData/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DHOSCrashData", + "operation": "Read DHOSCrashData data", + "description": "Read data from the DHOSCrashData table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DHOSReliability/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DHOSReliability", + "operation": "Read DHOSReliability data", + "description": "Read data from the DHOSReliability table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DHWipAppLearning/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DHWipAppLearning", + "operation": "Read DHWipAppLearning data", + "description": "Read data from the DHWipAppLearning table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DnsEvents/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DnsEvents", + "operation": "Read DnsEvents data", + "description": "Read data from the DnsEvents table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/DnsInventory/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "DnsInventory", + "operation": "Read DnsInventory data", + "description": "Read data from the DnsInventory table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Dynamics365Activity/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Dynamics365Activity", + "operation": "Read Dynamics365Activity data", + "description": "Read data from the Dynamics365Activity table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ETWEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ETWEvent", + "operation": "Read ETWEvent data", + "description": "Read data from the ETWEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Event/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Event", + "operation": "Read Event data", + "description": "Read data from the Event table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ExchangeAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ExchangeAssessmentRecommendation", + "operation": "Read ExchangeAssessmentRecommendation data", + "description": "Read data from the ExchangeAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ExchangeOnlineAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ExchangeOnlineAssessmentRecommendation", + "operation": "Read ExchangeOnlineAssessmentRecommendation data", + "description": "Read data from the ExchangeOnlineAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/FailedIngestion/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "FailedIngestion", + "operation": "Read FailedIngestion data", + "description": "Read data from the FailedIngestion table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/FunctionAppLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "FunctionAppLogs", + "operation": "Read FunctionAppLogs data", + "description": "Read data from the FunctionAppLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Heartbeat/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Heartbeat", + "operation": "Read Heartbeat data", + "description": "Read data from the Heartbeat table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/HuntingBookmark/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "HuntingBookmark", + "operation": "Read HuntingBookmark data", + "description": "Read data from the HuntingBookmark table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/IISAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "IISAssessmentRecommendation", + "operation": "Read IISAssessmentRecommendation data", + "description": "Read data from the IISAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/InboundConnection/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "InboundConnection", + "operation": "Read InboundConnection data", + "description": "Read data from the InboundConnection table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/InsightsMetrics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "InsightsMetrics", + "operation": "Read InsightsMetrics data", + "description": "Read data from the InsightsMetrics table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/IntuneAuditLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "IntuneAuditLogs", + "operation": "Read IntuneAuditLogs data", + "description": "Read data from the IntuneAuditLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/IntuneDeviceComplianceOrg/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "IntuneDeviceComplianceOrg", + "operation": "Read IntuneDeviceComplianceOrg data", + "description": "Read data from the IntuneDeviceComplianceOrg table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/IntuneOperationalLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "IntuneOperationalLogs", + "operation": "Read IntuneOperationalLogs data", + "description": "Read data from the IntuneOperationalLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/IoTHubDistributedTracing/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "IoTHubDistributedTracing", + "operation": "Read IoTHubDistributedTracing data", + "description": "Read data from the IoTHubDistributedTracing table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/KubeEvents/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "KubeEvents", + "operation": "Read KubeEvents data", + "description": "Read data from the KubeEvents table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/KubeHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "KubeHealth", + "operation": "Read KubeHealth data", + "description": "Read data from the KubeHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/KubeMonAgentEvents/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "KubeMonAgentEvents", + "operation": "Read KubeMonAgentEvents data", + "description": "Read data from the KubeMonAgentEvents table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/KubeNodeInventory/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "KubeNodeInventory", + "operation": "Read KubeNodeInventory data", + "description": "Read data from the KubeNodeInventory table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/KubePodInventory/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "KubePodInventory", + "operation": "Read KubePodInventory data", + "description": "Read data from the KubePodInventory table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/KubeServices/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "KubeServices", + "operation": "Read KubeServices data", + "description": "Read data from the KubeServices table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/LinuxAuditLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "LinuxAuditLog", + "operation": "Read LinuxAuditLog data", + "description": "Read data from the LinuxAuditLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAApplication/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAApplication", + "operation": "Read MAApplication data", + "description": "Read data from the MAApplication table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAApplicationHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAApplicationHealth", + "operation": "Read MAApplicationHealth data", + "description": "Read data from the MAApplicationHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAApplicationHealthAlternativeVersions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAApplicationHealthAlternativeVersions", + "operation": "Read MAApplicationHealthAlternativeVersions data", + "description": "Read data from the MAApplicationHealthAlternativeVersions table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAApplicationHealthIssues/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAApplicationHealthIssues", + "operation": "Read MAApplicationHealthIssues data", + "description": "Read data from the MAApplicationHealthIssues table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAApplicationInstance/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAApplicationInstance", + "operation": "Read MAApplicationInstance data", + "description": "Read data from the MAApplicationInstance table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAApplicationInstanceReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAApplicationInstanceReadiness", + "operation": "Read MAApplicationInstanceReadiness data", + "description": "Read data from the MAApplicationInstanceReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAApplicationReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAApplicationReadiness", + "operation": "Read MAApplicationReadiness data", + "description": "Read data from the MAApplicationReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MADeploymentPlan/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MADeploymentPlan", + "operation": "Read MADeploymentPlan data", + "description": "Read data from the MADeploymentPlan table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MADevice/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MADevice", + "operation": "Read MADevice data", + "description": "Read data from the MADevice table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MADeviceNotEnrolled/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MADeviceNotEnrolled", + "operation": "Read MADeviceNotEnrolled data", + "description": "Read data from the MADeviceNotEnrolled table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MADeviceNRT/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MADeviceNRT", + "operation": "Read MADeviceNRT data", + "description": "Read data from the MADeviceNRT table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MADevicePnPHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MADevicePnPHealth", + "operation": "Read MADevicePnPHealth data", + "description": "Read data from the MADevicePnPHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MADevicePnPHealthAlternativeVersions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MADevicePnPHealthAlternativeVersions", + "operation": "Read MADevicePnPHealthAlternativeVersions data", + "description": "Read data from the MADevicePnPHealthAlternativeVersions table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MADevicePnPHealthIssues/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MADevicePnPHealthIssues", + "operation": "Read MADevicePnPHealthIssues data", + "description": "Read data from the MADevicePnPHealthIssues table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MADeviceReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MADeviceReadiness", + "operation": "Read MADeviceReadiness data", + "description": "Read data from the MADeviceReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MADriverInstanceReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MADriverInstanceReadiness", + "operation": "Read MADriverInstanceReadiness data", + "description": "Read data from the MADriverInstanceReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MADriverReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MADriverReadiness", + "operation": "Read MADriverReadiness data", + "description": "Read data from the MADriverReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAddin/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAddin", + "operation": "Read MAOfficeAddin data", + "description": "Read data from the MAOfficeAddin table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAddinEntityHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAddinEntityHealth", + "operation": "Read MAOfficeAddinEntityHealth data", + "description": "Read data from the MAOfficeAddinEntityHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAddinHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAddinHealth", + "operation": "Read MAOfficeAddinHealth data", + "description": "Read data from the MAOfficeAddinHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAddinHealthEventNRT/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAddinHealthEventNRT", + "operation": "Read MAOfficeAddinHealthEventNRT data", + "description": "Read data from the MAOfficeAddinHealthEventNRT table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAddinHealthIssues/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAddinHealthIssues", + "operation": "Read MAOfficeAddinHealthIssues data", + "description": "Read data from the MAOfficeAddinHealthIssues table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAddinInstance/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAddinInstance", + "operation": "Read MAOfficeAddinInstance data", + "description": "Read data from the MAOfficeAddinInstance table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAddinInstanceReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAddinInstanceReadiness", + "operation": "Read MAOfficeAddinInstanceReadiness data", + "description": "Read data from the MAOfficeAddinInstanceReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAddinReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAddinReadiness", + "operation": "Read MAOfficeAddinReadiness data", + "description": "Read data from the MAOfficeAddinReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeApp/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeApp", + "operation": "Read MAOfficeApp data", + "description": "Read data from the MAOfficeApp table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAppCrashesNRT/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAppCrashesNRT", + "operation": "Read MAOfficeAppCrashesNRT data", + "description": "Read data from the MAOfficeAppCrashesNRT table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAppHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAppHealth", + "operation": "Read MAOfficeAppHealth data", + "description": "Read data from the MAOfficeAppHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAppInstance/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAppInstance", + "operation": "Read MAOfficeAppInstance data", + "description": "Read data from the MAOfficeAppInstance table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAppInstanceHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAppInstanceHealth", + "operation": "Read MAOfficeAppInstanceHealth data", + "description": "Read data from the MAOfficeAppInstanceHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAppReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAppReadiness", + "operation": "Read MAOfficeAppReadiness data", + "description": "Read data from the MAOfficeAppReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeAppSessionsNRT/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeAppSessionsNRT", + "operation": "Read MAOfficeAppSessionsNRT data", + "description": "Read data from the MAOfficeAppSessionsNRT table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeBuildInfo/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeBuildInfo", + "operation": "Read MAOfficeBuildInfo data", + "description": "Read data from the MAOfficeBuildInfo table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeCurrencyAssessment/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeCurrencyAssessment", + "operation": "Read MAOfficeCurrencyAssessment data", + "description": "Read data from the MAOfficeCurrencyAssessment table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeCurrencyAssessmentDailyCounts/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeCurrencyAssessmentDailyCounts", + "operation": "Read MAOfficeCurrencyAssessmentDailyCounts data", + "description": "Read data from the MAOfficeCurrencyAssessmentDailyCounts table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeDeploymentStatus/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeDeploymentStatus", + "operation": "Read MAOfficeDeploymentStatus data", + "description": "Read data from the MAOfficeDeploymentStatus table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeDeploymentStatusNRT/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeDeploymentStatusNRT", + "operation": "Read MAOfficeDeploymentStatusNRT data", + "description": "Read data from the MAOfficeDeploymentStatusNRT table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeMacroErrorNRT/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeMacroErrorNRT", + "operation": "Read MAOfficeMacroErrorNRT data", + "description": "Read data from the MAOfficeMacroErrorNRT table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeMacroGlobalHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeMacroGlobalHealth", + "operation": "Read MAOfficeMacroGlobalHealth data", + "description": "Read data from the MAOfficeMacroGlobalHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeMacroHealth/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeMacroHealth", + "operation": "Read MAOfficeMacroHealth data", + "description": "Read data from the MAOfficeMacroHealth table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeMacroHealthIssues/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeMacroHealthIssues", + "operation": "Read MAOfficeMacroHealthIssues data", + "description": "Read data from the MAOfficeMacroHealthIssues table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeMacroIssueInstanceReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeMacroIssueInstanceReadiness", + "operation": "Read MAOfficeMacroIssueInstanceReadiness data", + "description": "Read data from the MAOfficeMacroIssueInstanceReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeMacroIssueReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeMacroIssueReadiness", + "operation": "Read MAOfficeMacroIssueReadiness data", + "description": "Read data from the MAOfficeMacroIssueReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeMacroSummary/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeMacroSummary", + "operation": "Read MAOfficeMacroSummary data", + "description": "Read data from the MAOfficeMacroSummary table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeSuite/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeSuite", + "operation": "Read MAOfficeSuite data", + "description": "Read data from the MAOfficeSuite table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAOfficeSuiteInstance/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAOfficeSuiteInstance", + "operation": "Read MAOfficeSuiteInstance data", + "description": "Read data from the MAOfficeSuiteInstance table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAProposedPilotDevices/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAProposedPilotDevices", + "operation": "Read MAProposedPilotDevices data", + "description": "Read data from the MAProposedPilotDevices table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAWindowsBuildInfo/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAWindowsBuildInfo", + "operation": "Read MAWindowsBuildInfo data", + "description": "Read data from the MAWindowsBuildInfo table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAWindowsCurrencyAssessment/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAWindowsCurrencyAssessment", + "operation": "Read MAWindowsCurrencyAssessment data", + "description": "Read data from the MAWindowsCurrencyAssessment table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAWindowsCurrencyAssessmentDailyCounts/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAWindowsCurrencyAssessmentDailyCounts", + "operation": "Read MAWindowsCurrencyAssessmentDailyCounts data", + "description": "Read data from the MAWindowsCurrencyAssessmentDailyCounts table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAWindowsDeploymentStatus/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAWindowsDeploymentStatus", + "operation": "Read MAWindowsDeploymentStatus data", + "description": "Read data from the MAWindowsDeploymentStatus table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAWindowsDeploymentStatusNRT/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAWindowsDeploymentStatusNRT", + "operation": "Read MAWindowsDeploymentStatusNRT data", + "description": "Read data from the MAWindowsDeploymentStatusNRT table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MAWindowsSysReqInstanceReadiness/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MAWindowsSysReqInstanceReadiness", + "operation": "Read MAWindowsSysReqInstanceReadiness data", + "description": "Read data from the MAWindowsSysReqInstanceReadiness table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/McasShadowItReporting/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "McasShadowItReporting", + "operation": "Read McasShadowItReporting data", + "description": "Read data from the McasShadowItReporting table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MicrosoftAzureBastionAuditLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MicrosoftAzureBastionAuditLogs", + "operation": "Read MicrosoftAzureBastionAuditLogs data", + "description": "Read data from the MicrosoftAzureBastionAuditLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MicrosoftDataShareReceivedSnapshotLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MicrosoftDataShareReceivedSnapshotLog", + "operation": "Read MicrosoftDataShareReceivedSnapshotLog data", + "description": "Read data from the MicrosoftDataShareReceivedSnapshotLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MicrosoftDataShareSentSnapshotLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MicrosoftDataShareSentSnapshotLog", + "operation": "Read MicrosoftDataShareSentSnapshotLog data", + "description": "Read data from the MicrosoftDataShareSentSnapshotLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MicrosoftDataShareShareLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MicrosoftDataShareShareLog", + "operation": "Read MicrosoftDataShareShareLog data", + "description": "Read data from the MicrosoftDataShareShareLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MicrosoftDynamicsTelemetryPerformanceLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MicrosoftDynamicsTelemetryPerformanceLogs", + "operation": "Read MicrosoftDynamicsTelemetryPerformanceLogs data", + "description": "Read data from the MicrosoftDynamicsTelemetryPerformanceLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MicrosoftDynamicsTelemetrySystemMetricsLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MicrosoftDynamicsTelemetrySystemMetricsLogs", + "operation": "Read MicrosoftDynamicsTelemetrySystemMetricsLogs data", + "description": "Read data from the MicrosoftDynamicsTelemetrySystemMetricsLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/MicrosoftHealthcareApisAuditLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MicrosoftHealthcareApisAuditLogs", + "operation": "Read MicrosoftHealthcareApisAuditLogs data", + "description": "Read data from the MicrosoftHealthcareApisAuditLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/NetworkMonitoring/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "NetworkMonitoring", + "operation": "Read NetworkMonitoring data", + "description": "Read data from the NetworkMonitoring table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/OfficeActivity/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "OfficeActivity", + "operation": "Read OfficeActivity data", + "description": "Read data from the OfficeActivity table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Operation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Operation", + "operation": "Read Operation data", + "description": "Read data from the Operation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/OutboundConnection/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "OutboundConnection", + "operation": "Read OutboundConnection data", + "description": "Read data from the OutboundConnection table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Perf/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Perf", + "operation": "Read Perf data", + "description": "Read data from the Perf table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ProtectionStatus/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ProtectionStatus", + "operation": "Read ProtectionStatus data", + "description": "Read data from the ProtectionStatus table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ReservedAzureCommonFields/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ReservedAzureCommonFields", + "operation": "Read ReservedAzureCommonFields data", + "description": "Read data from the ReservedAzureCommonFields table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ReservedCommonFields/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ReservedCommonFields", + "operation": "Read ReservedCommonFields data", + "description": "Read data from the ReservedCommonFields table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SCCMAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SCCMAssessmentRecommendation", + "operation": "Read SCCMAssessmentRecommendation data", + "description": "Read data from the SCCMAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SCOMAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SCOMAssessmentRecommendation", + "operation": "Read SCOMAssessmentRecommendation data", + "description": "Read data from the SCOMAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SecurityAlert/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SecurityAlert", + "operation": "Read SecurityAlert data", + "description": "Read data from the SecurityAlert table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SecurityBaseline/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SecurityBaseline", + "operation": "Read SecurityBaseline data", + "description": "Read data from the SecurityBaseline table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SecurityBaselineSummary/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SecurityBaselineSummary", + "operation": "Read SecurityBaselineSummary data", + "description": "Read data from the SecurityBaselineSummary table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SecurityDetection/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SecurityDetection", + "operation": "Read SecurityDetection data", + "description": "Read data from the SecurityDetection table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SecurityEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SecurityEvent", + "operation": "Read SecurityEvent data", + "description": "Read data from the SecurityEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SecurityIncident/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SecurityIncident", + "operation": "Read SecurityIncident data", + "description": "Read data from the SecurityIncident table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SecurityIoTRawEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SecurityIoTRawEvent", + "operation": "Read SecurityIoTRawEvent data", + "description": "Read data from the SecurityIoTRawEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SecurityNestedRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SecurityNestedRecommendation", + "operation": "Read SecurityNestedRecommendation data", + "description": "Read data from the SecurityNestedRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SecurityRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SecurityRecommendation", + "operation": "Read SecurityRecommendation data", + "description": "Read data from the SecurityRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ServiceFabricOperationalEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ServiceFabricOperationalEvent", + "operation": "Read ServiceFabricOperationalEvent data", + "description": "Read data from the ServiceFabricOperationalEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ServiceFabricReliableActorEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ServiceFabricReliableActorEvent", + "operation": "Read ServiceFabricReliableActorEvent data", + "description": "Read data from the ServiceFabricReliableActorEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ServiceFabricReliableServiceEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ServiceFabricReliableServiceEvent", + "operation": "Read ServiceFabricReliableServiceEvent data", + "description": "Read data from the ServiceFabricReliableServiceEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SfBAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SfBAssessmentRecommendation", + "operation": "Read SfBAssessmentRecommendation data", + "description": "Read data from the SfBAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SfBOnlineAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SfBOnlineAssessmentRecommendation", + "operation": "Read SfBOnlineAssessmentRecommendation data", + "description": "Read data from the SfBOnlineAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SharePointOnlineAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SharePointOnlineAssessmentRecommendation", + "operation": "Read SharePointOnlineAssessmentRecommendation data", + "description": "Read data from the SharePointOnlineAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SignalRServiceDiagnosticLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SignalRServiceDiagnosticLogs", + "operation": "Read SignalRServiceDiagnosticLogs data", + "description": "Read data from the SignalRServiceDiagnosticLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SigninLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SigninLogs", + "operation": "Read SigninLogs data", + "description": "Read data from the SigninLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SPAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SPAssessmentRecommendation", + "operation": "Read SPAssessmentRecommendation data", + "description": "Read data from the SPAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SQLAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SQLAssessmentRecommendation", + "operation": "Read SQLAssessmentRecommendation data", + "description": "Read data from the SQLAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SqlDataClassification/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SqlDataClassification", + "operation": "Read SqlDataClassification data", + "description": "Read data from the SqlDataClassification table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SQLQueryPerformance/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SQLQueryPerformance", + "operation": "Read SQLQueryPerformance data", + "description": "Read data from the SQLQueryPerformance table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SqlVulnerabilityAssessmentResult/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SqlVulnerabilityAssessmentResult", + "operation": "Read SqlVulnerabilityAssessmentResult data", + "description": "Read data from the SqlVulnerabilityAssessmentResult table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/StorageBlobLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "StorageBlobLogs", + "operation": "Read StorageBlobLogs data", + "description": "Read data from the StorageBlobLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/StorageFileLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "StorageFileLogs", + "operation": "Read StorageFileLogs data", + "description": "Read data from the StorageFileLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/StorageQueueLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "StorageQueueLogs", + "operation": "Read StorageQueueLogs data", + "description": "Read data from the StorageQueueLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/StorageTableLogs/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "StorageTableLogs", + "operation": "Read StorageTableLogs data", + "description": "Read data from the StorageTableLogs table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SucceededIngestion/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SucceededIngestion", + "operation": "Read SucceededIngestion data", + "description": "Read data from the SucceededIngestion table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Syslog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Syslog", + "operation": "Read Syslog data", + "description": "Read data from the Syslog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/SysmonEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "SysmonEvent", + "operation": "Read SysmonEvent data", + "description": "Read data from the SysmonEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/ThreatIntelligenceIndicator/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "ThreatIntelligenceIndicator", + "operation": "Read ThreatIntelligenceIndicator data", + "description": "Read data from the ThreatIntelligenceIndicator table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/TSIIngress/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "TSIIngress", + "operation": "Read TSIIngress data", + "description": "Read data from the TSIIngress table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UAApp/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UAApp", + "operation": "Read UAApp data", + "description": "Read data from the UAApp table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UAComputer/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UAComputer", + "operation": "Read UAComputer data", + "description": "Read data from the UAComputer table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UAComputerRank/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UAComputerRank", + "operation": "Read UAComputerRank data", + "description": "Read data from the UAComputerRank table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UADriver/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UADriver", + "operation": "Read UADriver data", + "description": "Read data from the UADriver table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UADriverProblemCodes/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UADriverProblemCodes", + "operation": "Read UADriverProblemCodes data", + "description": "Read data from the UADriverProblemCodes table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UAFeedback/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UAFeedback", + "operation": "Read UAFeedback data", + "description": "Read data from the UAFeedback table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UAHardwareSecurity/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UAHardwareSecurity", + "operation": "Read UAHardwareSecurity data", + "description": "Read data from the UAHardwareSecurity table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UAIESiteDiscovery/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UAIESiteDiscovery", + "operation": "Read UAIESiteDiscovery data", + "description": "Read data from the UAIESiteDiscovery table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UAOfficeAddIn/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UAOfficeAddIn", + "operation": "Read UAOfficeAddIn data", + "description": "Read data from the UAOfficeAddIn table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UAProposedActionPlan/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UAProposedActionPlan", + "operation": "Read UAProposedActionPlan data", + "description": "Read data from the UAProposedActionPlan table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UASysReqIssue/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UASysReqIssue", + "operation": "Read UASysReqIssue data", + "description": "Read data from the UASysReqIssue table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UAUpgradedComputer/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UAUpgradedComputer", + "operation": "Read UAUpgradedComputer data", + "description": "Read data from the UAUpgradedComputer table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Update/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Update", + "operation": "Read Update data", + "description": "Read data from the Update table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UpdateRunProgress/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UpdateRunProgress", + "operation": "Read UpdateRunProgress data", + "description": "Read data from the UpdateRunProgress table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UpdateSummary/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UpdateSummary", + "operation": "Read UpdateSummary data", + "description": "Read data from the UpdateSummary table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/Usage/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Usage", + "operation": "Read Usage data", + "description": "Read data from the Usage table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UserAccessAnalytics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UserAccessAnalytics", + "operation": "Read UserAccessAnalytics data", + "description": "Read data from the UserAccessAnalytics table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/UserPeerAnalytics/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "UserPeerAnalytics", + "operation": "Read UserPeerAnalytics data", + "description": "Read data from the UserPeerAnalytics table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/VMBoundPort/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "VMBoundPort", + "operation": "Read VMBoundPort data", + "description": "Read data from the VMBoundPort table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/VMComputer/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "VMComputer", + "operation": "Read VMComputer data", + "description": "Read data from the VMComputer table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/VMConnection/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "VMConnection", + "operation": "Read VMConnection data", + "description": "Read data from the VMConnection table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/VMProcess/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "VMProcess", + "operation": "Read VMProcess data", + "description": "Read data from the VMProcess table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/W3CIISLog/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "W3CIISLog", + "operation": "Read W3CIISLog data", + "description": "Read data from the W3CIISLog table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WaaSDeploymentStatus/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WaaSDeploymentStatus", + "operation": "Read WaaSDeploymentStatus data", + "description": "Read data from the WaaSDeploymentStatus table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WaaSInsiderStatus/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WaaSInsiderStatus", + "operation": "Read WaaSInsiderStatus data", + "description": "Read data from the WaaSInsiderStatus table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WaaSUpdateStatus/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WaaSUpdateStatus", + "operation": "Read WaaSUpdateStatus data", + "description": "Read data from the WaaSUpdateStatus table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WDAVStatus/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WDAVStatus", + "operation": "Read WDAVStatus data", + "description": "Read data from the WDAVStatus table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WDAVThreat/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WDAVThreat", + "operation": "Read WDAVThreat data", + "description": "Read data from the WDAVThreat table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WindowsClientAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WindowsClientAssessmentRecommendation", + "operation": "Read WindowsClientAssessmentRecommendation data", + "description": "Read data from the WindowsClientAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WindowsEvent/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WindowsEvent", + "operation": "Read WindowsEvent data", + "description": "Read data from the WindowsEvent table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WindowsFirewall/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WindowsFirewall", + "operation": "Read WindowsFirewall data", + "description": "Read data from the WindowsFirewall table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WindowsServerAssessmentRecommendation/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WindowsServerAssessmentRecommendation", + "operation": "Read WindowsServerAssessmentRecommendation data", + "description": "Read data from the WindowsServerAssessmentRecommendation table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WireData/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WireData", + "operation": "Read WireData data", + "description": "Read data from the WireData table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WorkloadMonitoringPerf/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WorkloadMonitoringPerf", + "operation": "Read WorkloadMonitoringPerf data", + "description": "Read data from the WorkloadMonitoringPerf table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WUDOAggregatedStatus/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WUDOAggregatedStatus", + "operation": "Read WUDOAggregatedStatus data", + "description": "Read data from the WUDOAggregatedStatus table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WUDOStatus/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WUDOStatus", + "operation": "Read WUDOStatus data", + "description": "Read data from the WUDOStatus table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WVDCheckpoints/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WVDCheckpoints", + "operation": "Read WVDCheckpoints data", + "description": "Read data from the WVDCheckpoints table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WVDConnections/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WVDConnections", + "operation": "Read WVDConnections data", + "description": "Read data from the WVDConnections table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WVDErrors/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WVDErrors", + "operation": "Read WVDErrors data", + "description": "Read data from the WVDErrors table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WVDFeeds/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WVDFeeds", + "operation": "Read WVDFeeds data", + "description": "Read data from the WVDFeeds table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WVDHostRegistrations/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WVDHostRegistrations", + "operation": "Read WVDHostRegistrations data", + "description": "Read data from the WVDHostRegistrations table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Logs/WVDManagement/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "WVDManagement", + "operation": "Read WVDManagement data", + "description": "Read data from the WVDManagement table" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Baseline/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Baseline", + "operation": "Read metric baseline", + "description": "Read a metric baseline (preview)" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/CalculateBaseline/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Baseline", + "operation": "Calculate baseline", + "description": "Calculate baseline for metric values (preview)" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MetricBaselines/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Metric Baseline", + "operation": "Read metric baselines", + "description": "Read metric baselines" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionRules/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection rule", + "operation": "Read data collection rule", + "description": "Read a data collection rule" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionRules/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection rule", + "operation": "Create or update data collection rule", + "description": "Create or update a data collection rule" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionRules/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection rule", + "operation": "Delete data collection rule", + "description": "Delete a data collection rule" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionRules/Data/Write", + "isDataAction": true, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection rule", + "operation": "Send data to data collection rule", + "description": "Send data to a data collection rule" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionRuleAssociations/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection rule association", + "operation": "Read data collection rule association", + "description": "Read a resource's association with a data collection rule" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionRuleAssociations/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection rule association", + "operation": "Create or update data collection rule association", + "description": "Create or update a resource's association with a data collection rule" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionRuleAssociations/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection rule association", + "operation": "Delete data collection rule association", + "description": "Delete a resource's association with a data collection rule" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionEndpoints/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection endpoint", + "operation": "Read data collection endpoint", + "description": "Read a data collection endpoint" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionEndpoints/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection endpoint", + "operation": "Create or update data collection endpoint", + "description": "Create or update a data collection endpoint" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionEndpoints/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection endpoint", + "operation": "Delete data collection endpoint", + "description": "Delete a data collection endpoint" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionEndpoints/ScopedPrivateLinkProxies/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection endpoint scoped private link proxy", + "operation": "Read data collection endpoint private link proxy", + "description": "Read a data collection endpoint private link proxy" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionEndpoints/ScopedPrivateLinkProxies/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection endpoint scoped private link proxy", + "operation": "Create or update data collection endpoint private link proxy", + "description": "Create or update a data collection endpoint private link proxy" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/DataCollectionEndpoints/ScopedPrivateLinkProxies/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Data collection endpoint scoped private link proxy", + "operation": "Delete data collection endpoint private link proxy", + "description": "Delete a data collection endpoint private link proxy" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private Link Scope", + "operation": "Read a private link scope", + "description": "Read a private link scope" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private Link Scope", + "operation": "Create or update a private link scope", + "description": "Create or update a private link scope" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private Link Scope", + "operation": "Delete a private link scope", + "description": "Delete a private link scope" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopeOperationStatuses/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private Link Scope operation status", + "operation": "Read a private link scoped operation status", + "description": "Read a private link scoped operation status" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/ScopedResources/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private Link Scoped Resource", + "operation": "Read a private link scoped resource", + "description": "Read a private link scoped resource" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/ScopedResources/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private Link Scoped Resource", + "operation": "Create or update a private link scoped resource", + "description": "Create or update a private link scoped resource" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/ScopedResources/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private Link Scoped Resource", + "operation": "Delete a private link scoped resource", + "description": "Delete a private link scoped resource" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/PrivateLinkResources/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private Link Resource", + "operation": "Read a private link resource", + "description": "Read a private link resource" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/PrivateEndpointConnections/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private endpoint connection", + "operation": "Read a private endpoint connection", + "description": "Read a private endpoint connection" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/PrivateEndpointConnections/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private endpoint connection", + "operation": "Create or update a private endpoint connection", + "description": "Create or update a private endpoint connection" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/PrivateEndpointConnections/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private endpoint connection", + "operation": "Delete a private endpoint connection", + "description": "Delete a private endpoint connection" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/PrivateEndpointConnectionProxies/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private endpoint connection proxy", + "operation": "Read a private endpoint connection proxy", + "description": "Read a private endpoint connection proxy" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/PrivateEndpointConnectionProxies/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private endpoint connection proxy", + "operation": "Create or update a private endpoint connection proxy", + "description": "Create or update a private endpoint connection proxy" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/PrivateEndpointConnectionProxies/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private endpoint connection proxy", + "operation": "Delete a private endpoint connection proxy", + "description": "Delete a private endpoint connection proxy" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/PrivateLinkScopes/PrivateEndpointConnectionProxies/Validate/Action", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Private endpoint connection proxy", + "operation": "Validate a private endpoint connection proxy", + "description": "Validate a private endpoint connection proxy" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MyWorkbooks/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MyWorkbooks", + "operation": "Read private workbook", + "description": "Read a private Workbook" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MyWorkbooks/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MyWorkbooks", + "operation": "Create or update private workbook", + "description": "Create or update a private workbook" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/MyWorkbooks/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "MyWorkbooks", + "operation": "Delete private workbook", + "description": "Delete a private workbook" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Workbooks/Write", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Workbooks", + "operation": "Create or update workbook", + "description": "Create or update a workbook" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Workbooks/Delete", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Workbooks", + "operation": "Delete workbook", + "description": "Delete a workbook" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Workbooks/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Workbooks", + "operation": "Read workbook", + "description": "Read a workbook" + }, + "properties": {} + }, + { + "name": "Microsoft.Insights/Workbooks/Revisions/Read", + "isDataAction": false, + "display": { + "publisher": "Microsoft", + "provider": "Microsoft Azure Monitor", + "resource": "Workbooks", + "operation": "Workbook revisions", + "description": "Get the workbook revisions" + }, + "properties": {} + } + ] + } + }, + "default": { + "body": { + "error": { + "code": "InvalidResourceType", + "message": "The resource type 'operations' could not be found in the namespace 'microsoft.insights' for api version '2014-05-01'. The supported api-versions are '2014-04-01,2014-06-01,2015-04-01'." + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-07-01/metrics_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-07-01/metrics_API.json new file mode 100644 index 000000000000..06aa27a6eab0 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-07-01/metrics_API.json @@ -0,0 +1,435 @@ +{ + "swagger": "2.0", + "info": { + "title": "MonitorManagementClient", + "version": "2019-07-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": { + "/{resourceUri}/providers/Microsoft.Insights/metrics": { + "get": { + "tags": [ + "Metrics" + ], + "operationId": "Metrics_List", + "description": "**Lists the metric values for a resource**.", + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "#/parameters/TimespanParameter" + }, + { + "$ref": "#/parameters/IntervalParameter" + }, + { + "$ref": "#/parameters/MetricNamesParameter" + }, + { + "$ref": "#/parameters/AggregationsParameter" + }, + { + "$ref": "#/parameters/TopParameter" + }, + { + "$ref": "#/parameters/OrderByParameter" + }, + { + "name": "$filter", + "in": "query", + "type": "string", + "description": "The **$filter** is used to reduce the set of metric data returned.
    Example:
    Metric contains metadata A, B and C.
    - Return all time series of C where A = a1 and B = b1 or b2
    **$filter=A eq ‘a1’ and B eq ‘b1’ or B eq ‘b2’ and C eq ‘*’**
    - Invalid variant:
    **$filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘*’ or B = ‘b2’**
    This is invalid because the logical or operator cannot separate two different metadata names.
    - Return all time series where A = a1, B = b1 and C = c1:
    **$filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘c1’**
    - Return all time series where A = a1
    **$filter=A eq ‘a1’ and B eq ‘*’ and C eq ‘*’**.", + "required": false + }, + { + "$ref": "#/parameters/ResultTypeParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/MetricNamespaceParameter" + }, + { + "$ref": "#/parameters/AutoAdjustTimegrain" + }, + { + "$ref": "#/parameters/ValidateDimensions" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request to get the list of metric values.", + "schema": { + "$ref": "#/definitions/Response" + } + } + }, + "x-ms-odata": "#/definitions/MetadataValue", + "x-ms-examples": { + "Get Metric for data": { + "$ref": "./examples/GetMetric.json" + }, + "Get Metric for metadata": { + "$ref": "./examples/GetMetricMetadata.json" + }, + "Get Metric with error": { + "$ref": "./examples/GetMetricError.json" + } + } + } + } + }, + "definitions": { + "LocalizableString": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "string", + "description": "the invariant value." + }, + "localizedValue": { + "type": "string", + "description": "the locale specific value." + } + }, + "description": "The localizable string class." + }, + "Unit": { + "type": "string", + "description": "The unit of the metric.", + "enum": [ + "Count", + "Bytes", + "Seconds", + "CountPerSecond", + "BytesPerSecond", + "Percent", + "MilliSeconds", + "ByteSeconds", + "Unspecified", + "Cores", + "MilliCores", + "NanoCores", + "BitsPerSecond" + ], + "x-ms-enum": { + "name": "Unit", + "modelAsString": false + } + }, + "MetricValue": { + "type": "object", + "required": [ + "timeStamp" + ], + "properties": { + "timeStamp": { + "type": "string", + "format": "date-time", + "description": "the timestamp for the metric value in ISO 8601 format." + }, + "average": { + "type": "number", + "format": "double", + "description": "the average value in the time range." + }, + "minimum": { + "type": "number", + "format": "double", + "description": "the least value in the time range." + }, + "maximum": { + "type": "number", + "format": "double", + "description": "the greatest value in the time range." + }, + "total": { + "type": "number", + "format": "double", + "description": "the sum of all of the values in the time range." + }, + "count": { + "type": "number", + "format": "double", + "description": "the number of samples in the time range. Can be used to determine the number of values that contributed to the average value." + } + }, + "description": "Represents a metric value." + }, + "MetadataValue": { + "type": "object", + "properties": { + "name": { + "$ref": "#/definitions/LocalizableString", + "description": "the name of the metadata." + }, + "value": { + "type": "string", + "description": "the value of the metadata." + } + }, + "description": "Represents a metric metadata value." + }, + "Response": { + "type": "object", + "properties": { + "cost": { + "type": "number", + "format": "int32", + "minimum": 0, + "description": "The integer value representing the relative cost of the query." + }, + "timespan": { + "type": "string", + "description": "The timespan for which the data was retrieved. Its value consists of two datetimes concatenated, separated by '/'. This may be adjusted in the future and returned back from what was originally requested." + }, + "interval": { + "type": "string", + "format": "duration", + "description": "The interval (window size) for which the metric data was returned in. This may be adjusted in the future and returned back from what was originally requested. This is not present if a metadata request was made." + }, + "namespace": { + "type": "string", + "description": "The namespace of the metrics being queried" + }, + "resourceregion": { + "type": "string", + "description": "The region of the resource being queried for metrics." + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Metric" + }, + "description": "the value of the collection." + } + }, + "required": [ + "timespan", + "value" + ], + "description": "The response to a metrics query." + }, + "Metric": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "the metric Id." + }, + "type": { + "type": "string", + "description": "the resource type of the metric resource." + }, + "name": { + "$ref": "#/definitions/LocalizableString", + "description": "the name and the display name of the metric, i.e. it is localizable string." + }, + "displayDescription": { + "type": "string", + "description": "Detailed description of this metric." + }, + "errorCode": { + "type": "string", + "description": "'Success' or the error details on query failures for this metric." + }, + "errorMessage": { + "type": "string", + "description": "Error message encountered querying this specific metric." + }, + "unit": { + "$ref": "#/definitions/Unit", + "description": "The unit of the metric." + }, + "timeseries": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeSeriesElement" + }, + "description": "the time series returned when a data query is performed." + } + }, + "required": [ + "id", + "type", + "name", + "unit", + "timeseries" + ], + "description": "The result data of a query." + }, + "TimeSeriesElement": { + "type": "object", + "properties": { + "metadatavalues": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataValue" + }, + "description": "the metadata values returned if $filter was specified in the call." + }, + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/MetricValue" + }, + "description": "An array of data points representing the metric values. This is only returned if a result type of data is specified." + } + }, + "description": "A time series result type. The discriminator value is always TimeSeries in this case." + }, + "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" + } + } + } + }, + "parameters": { + "ResourceUriParameter": { + "name": "resourceUri", + "in": "path", + "required": true, + "type": "string", + "description": "The identifier of the resource.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "TimespanParameter": { + "name": "timespan", + "in": "query", + "required": false, + "type": "string", + "description": "The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'.", + "x-ms-parameter-location": "method" + }, + "IntervalParameter": { + "name": "interval", + "in": "query", + "required": false, + "type": "string", + "format": "duration", + "description": "The interval (i.e. timegrain) of the query.", + "x-ms-parameter-location": "method" + }, + "MetricNamesParameter": { + "name": "metricnames", + "in": "query", + "required": false, + "type": "string", + "description": "The names of the metrics (comma separated) to retrieve.", + "x-ms-parameter-location": "method" + }, + "AggregationsParameter": { + "name": "aggregation", + "in": "query", + "required": false, + "type": "string", + "description": "The list of aggregation types (comma separated) to retrieve.", + "x-ms-parameter-location": "method" + }, + "TopParameter": { + "name": "top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of records to retrieve.\nValid only if $filter is specified.\nDefaults to 10.", + "x-ms-parameter-location": "method" + }, + "OrderByParameter": { + "name": "orderby", + "in": "query", + "required": false, + "type": "string", + "description": "The aggregation to use for sorting results and the direction of the sort.\nOnly one order can be specified.\nExamples: sum asc.", + "x-ms-parameter-location": "method" + }, + "ResultTypeParameter": { + "name": "resultType", + "in": "query", + "type": "string", + "enum": [ + "Data", + "Metadata" + ], + "x-ms-enum": { + "name": "ResultType", + "modelAsString": false + }, + "description": "Reduces the set of data collected. The syntax allowed depends on the operation. See the operation's description for details.", + "x-ms-parameter-location": "method", + "required": false + }, + "MetricNamespaceParameter": { + "name": "metricnamespace", + "in": "query", + "required": false, + "type": "string", + "description": "Metric namespace to query metric definitions for.", + "x-ms-parameter-location": "method" + }, + "AutoAdjustTimegrain": { + "name": "AutoAdjustTimegrain", + "in": "query", + "required": false, + "type": "boolean", + "description": "When set to true, if the timespan passed in is not supported by this metric, the API will return the result using the closest supported timespan. When set to false, an error is returned for invalid timespan parameters. Defaults to false.", + "x-ms-parameter-location": "method" + }, + "ValidateDimensions": { + "name": "ValidateDimensions", + "in": "query", + "required": false, + "type": "boolean", + "description": "When set to false, invalid filter parameter values will be ignored. When set to true, an error is returned for invalid filter parameters. Defaults to true.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-07-01/operations_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-07-01/operations_API.json new file mode 100644 index 000000000000..0020858bbbbb --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-07-01/operations_API.json @@ -0,0 +1,308 @@ +{ + "swagger": "2.0", + "info": { + "title": "MonitorManagementClient", + "version": "2019-07-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.Insights/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available operations from Microsoft.Insights provider.", + "operationId": "Operations_List", + "x-ms-examples": { + "Get a list of operations for a resource provider": { + "$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": "BadRequest", + "schema": { + "$ref": "#/definitions/ErrorContract" + } + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Microsoft.Insights operations. It contains a list of operations and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of operations supported by the Microsoft.Insights provider." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "Microsoft Insights API operation definition.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "isDataAction": { + "type": "boolean", + "description": "Property to specify whether the action is a data action." + }, + "display": { + "description": "Display metadata associated with the operation.", + "type": "object", + "properties": { + "publisher": { + "description": "The publisher of this operation.", + "type": "string" + }, + "provider": { + "description": "Service provider: Microsoft.Insights", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed: AlertRules, Autoscale, etc.", + "type": "string" + }, + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "type": "string" + }, + "description": { + "description": "The description of the operation.", + "type": "string" + } + } + }, + "properties": { + "description": "Properties of operation, include metric specifications.", + "x-ms-client-flatten": true, + "x-ms-client-name": "OperationProperties", + "$ref": "#/definitions/OperationProperties" + } + } + }, + "OperationProperties": { + "description": "Properties of operation, include metric specifications.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "One property of operation, include metric specifications." + } + } + }, + "ServiceSpecification": { + "description": "One property of operation, include log specifications.", + "type": "object", + "properties": { + "logSpecifications": { + "description": "Log specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + } + }, + "metricSpecifications": { + "description": "Metric specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + } + }, + "legacyMetricSpecifications": { + "description": "Legacy Metric specifications for operation. Deprecated, do not use.", + "type": "object" + } + } + }, + "LogSpecification": { + "description": "Log specification of operation.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of log specification." + }, + "displayName": { + "type": "string", + "description": "Display name of log specification." + }, + "blobDuration": { + "type": "string", + "description": "Blob duration of specification." + } + } + }, + "MetricSpecification": { + "description": "Metric specification of operation.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the metric." + }, + "displayName": { + "type": "string", + "description": "Display name of the metric." + }, + "displayDescription": { + "type": "string", + "description": "Display description of the metric." + }, + "unit": { + "type": "string", + "description": "The metric unit. Possible values include: Count,Bytes,Seconds,Percent,CountPerSecond,BytesPerSecond,MilliSeconds,ByteSeconds,Unspecified,BitsPerSecond,Cores,MilliCores,NanoCores" + }, + "aggregationType": { + "type": "string", + "description": "The default metric aggregation type. Possible values include: Total,Average,Maximum,Minimum,Count" + }, + "supportedAggregationTypes": { + "type": "array", + "description": "The supported aggregation types for the metrics.", + "items": { + "type": "string" + } + }, + "supportedTimeGrainTypes": { + "type": "array", + "description": "The supported time grain types for the metrics.", + "items": { + "type": "string" + } + }, + "availabilities": { + "type": "array", + "description": "The supported time grain types for the metrics.", + "items": { + "type": "string" + } + }, + "lockAggregationType": { + "type": "string", + "description": "The metric lock aggregation type." + }, + "category": { + "type": "string", + "description": "Category or type of metric." + }, + "dimensions": { + "type": "array", + "description": "The dimensions of metric.", + "items": { + "$ref": "#/definitions/DimensionProperties" + } + }, + "fillGapWithZero": { + "type": "boolean", + "description": "Property to specify whether to fill empty gaps with zero." + }, + "internalMetricName": { + "type": "string", + "description": "The internal metric name." + } + } + }, + "DimensionProperties": { + "description": "Type of operation: get, read, delete, etc.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of dimension." + }, + "displayName": { + "type": "string", + "description": "Display name of dimension." + }, + "toBeExportedForShoebox": { + "type": "boolean", + "description": "Legacy usage, should not set." + }, + "isHidden": { + "type": "boolean", + "description": "When set, the dimension is hidden from the customer, used in conjunction with the defaultDimensionValues field below" + }, + "defaultDimensionValues": { + "type": "object", + "description": "Default dimension value to be sent down for the hidden dimension during query" + } + } + }, + "ErrorContract": { + "title": "Error Response", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)", + "type": "object", + "properties": { + "error": { + "description": "The error object.", + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "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" + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-04-01/dataCollectionEndpoints_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-04-01/dataCollectionEndpoints_API.json index 77b785c40fa4..e801c79d733e 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-04-01/dataCollectionEndpoints_API.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-04-01/dataCollectionEndpoints_API.json @@ -50,7 +50,7 @@ "default": { "description": "Error", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "./dataCollectionRules_API.json#/definitions/ErrorResponseCommonV2" } } }, @@ -92,7 +92,7 @@ "default": { "description": "Error", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "./dataCollectionRules_API.json#/definitions/ErrorResponseCommonV2" } } }, @@ -140,7 +140,7 @@ "default": { "description": "Error", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "./dataCollectionRules_API.json#/definitions/ErrorResponseCommonV2" } } }, @@ -200,7 +200,7 @@ "default": { "description": "Error", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "./dataCollectionRules_API.json#/definitions/ErrorResponseCommonV2" } } }, @@ -254,7 +254,7 @@ "default": { "description": "Error", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "./dataCollectionRules_API.json#/definitions/ErrorResponseCommonV2" } } }, @@ -297,7 +297,7 @@ "default": { "description": "Error", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "./dataCollectionRules_API.json#/definitions/ErrorResponseCommonV2" } } }, diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-04-01/dataCollectionRuleAssociations_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-04-01/dataCollectionRuleAssociations_API.json index 61ae89f8e81e..f76cf64b8e04 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-04-01/dataCollectionRuleAssociations_API.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-04-01/dataCollectionRuleAssociations_API.json @@ -47,7 +47,7 @@ "default": { "description": "Error", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "./dataCollectionRules_API.json#/definitions/ErrorResponseCommonV2" } } }, @@ -95,7 +95,7 @@ "default": { "description": "Error", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "./dataCollectionRules_API.json#/definitions/ErrorResponseCommonV2" } } }, @@ -140,7 +140,7 @@ "default": { "description": "Error", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "./dataCollectionRules_API.json#/definitions/ErrorResponseCommonV2" } } }, @@ -197,7 +197,7 @@ "default": { "description": "Error", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "./dataCollectionRules_API.json#/definitions/ErrorResponseCommonV2" } } }, @@ -237,7 +237,7 @@ "default": { "description": "Error", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "./dataCollectionRules_API.json#/definitions/ErrorResponseCommonV2" } } }, diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-04-01/dataCollectionRules_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-04-01/dataCollectionRules_API.json index 35355020ccc7..c79465ce4dd1 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-04-01/dataCollectionRules_API.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2021-04-01/dataCollectionRules_API.json @@ -50,7 +50,7 @@ "default": { "description": "Error", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponseCommonV2" } } }, @@ -92,7 +92,7 @@ "default": { "description": "Error", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponseCommonV2" } } }, @@ -140,7 +140,7 @@ "default": { "description": "Error", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponseCommonV2" } } }, @@ -200,7 +200,7 @@ "default": { "description": "Error", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponseCommonV2" } } }, @@ -254,7 +254,7 @@ "default": { "description": "Error", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponseCommonV2" } } }, @@ -297,7 +297,7 @@ "default": { "description": "Error", "schema": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponseCommonV2" } } }, @@ -821,6 +821,17 @@ } } } + }, + "ErrorResponseCommonV2": { + "title": "Error response", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "type": "object", + "properties": { + "error": { + "description": "The error object.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorDetail" + } + } } }, "parameters": { diff --git a/specification/monitor/resource-manager/readme.csharp.md b/specification/monitor/resource-manager/readme.csharp.md index 4c45821ceb70..433c37d8dccc 100644 --- a/specification/monitor/resource-manager/readme.csharp.md +++ b/specification/monitor/resource-manager/readme.csharp.md @@ -44,4 +44,12 @@ output-folder: $(csharp-sdks-folder)/$(csharp-profile)/Monitor/Management.Monito batch: - tag: profile-hybrid-2020-09-01 - ``` \ No newline at end of file + ``` + +## Local Development + +### Auto Generation +- Fork https://github.com/Azure/azure-rest-api-specs, clone it (asumming at C:\Repos) +- Fork https://github.com/Azure/azure-sdk-for-net, clone it (asumming at C:\Repos) +- Make changes +- autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=C:\Repos\azure-sdk-for-net\sdk C:\Repos\azure-rest-api-specs\specification\monitor\resource-manager\readme.md --debug \ No newline at end of file diff --git a/specification/monitor/resource-manager/readme.go.md b/specification/monitor/resource-manager/readme.go.md index 518dbd0706d2..2cf5467d3de0 100644 --- a/specification/monitor/resource-manager/readme.go.md +++ b/specification/monitor/resource-manager/readme.go.md @@ -2,13 +2,30 @@ These settings apply only when `--go` is specified on the command line. -``` yaml $(go) +``` yaml $(go) && !$(track2) go: license-header: MICROSOFT_MIT_NO_VERSION namespace: insights clear-output-folder: true ``` +``` yaml $(go) && $(track2) +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/monitor/armmonitor +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) +azure-arm: true + +directive: + - from: scheduledQueryRule_API.json # this is to resolve the duplicated schema issue in this swagger + where: "$.definitions.Resource" + transform: > + $["x-ms-client-name"] = "TrackedEntityResource"; + +modelerfour: + lenient-model-deduplication: true +``` + ### Go multi-api ``` yaml $(go) && $(multiapi) @@ -21,6 +38,7 @@ batch: - tag: package-2019-06 - tag: package-2019-11 - tag: package-2020-10-only + - tag: package-2021-07 ``` ### Tag: package-2017-09 and go @@ -94,3 +112,53 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2021-07' && $(go) +output-folder: $(go-sdk-folder)/services/preview/monitor/mgmt/2021-07-01-preview/$(namespace) +directive: +- from: activityLogAlerts_API.json + where: $.parameters + transform: delete $["ResourceGroupNameParameter"] + reason: ResourceGroupNameParameter is taken from v2/types.json +- from: guestDiagnosticSettings_API.json + where: $.parameters + transform: delete $["ResourceGroupNameParameter"] + reason: ResourceGroupNameParameter is taken from v2/types.json +- from: guestDiagnosticSettingsAssociation_API.json + where: $.parameters + transform: delete $["ResourceGroupNameParameter"] + reason: ResourceGroupNameParameter is taken from v2/types.json +- from: privateLinkScopes_API.json + where: $.parameters + transform: delete $["ResourceGroupNameParameter"] + reason: ResourceGroupNameParameter is taken from v2/types.json +- from: scheduledQueryRule_API.json + where: $.parameters + transform: delete $["ResourceGroupNameParameter"] + reason: ResourceGroupNameParameter is taken from v2/types.json +- from: autoscale_API.json + where: $.parameters + transform: delete $["ResourceGroupNameParameter"] + reason: ResourceGroupNameParameter is taken from v2/types.json +- from: alertRules_API.json + where: $.parameters + transform: delete $["ResourceGroupNameParameter"] + reason: ResourceGroupNameParameter is taken from v2/types.json +- from: alertRulesIncidents_API.json + where: $.parameters + transform: delete $["ResourceGroupNameParameter"] + reason: ResourceGroupNameParameter is taken from v2/types.json +- from: actionGroups_API.json + where: $.parameters + transform: delete $["ResourceGroupNameParameter"] + reason: ResourceGroupNameParameter is taken from v2/types.json +- from: metricAlert_API.json + where: $.parameters + transform: delete $["ResourceGroupNameParameter"] + reason: ResourceGroupNameParameter is taken from v2/types.json +``` \ No newline at end of file diff --git a/specification/monitor/resource-manager/readme.md b/specification/monitor/resource-manager/readme.md index df76b99c2348..626c2bb08d37 100644 --- a/specification/monitor/resource-manager/readme.md +++ b/specification/monitor/resource-manager/readme.md @@ -22,16 +22,12 @@ To see additional help and options, run: ### Basic Information -There are the global settings for the Azure Monitor Control Service (AMCS) extension. -``` yaml $(AMCS) -tag: package-2021-04-only -``` - These are the global settings for the MonitorClient API. ``` yaml !$(python) || !$(track2) title: MonitorClient ``` + ``` yaml $(python) && $(track2) title: MonitorManagementClient ``` @@ -39,9 +35,81 @@ title: MonitorManagementClient ``` yaml description: Monitor Management Client openapi-type: arm -tag: package-2020-03 +tag: package-2021-07 ``` +### Tag: package-2021-07 + +These settings apply only when `--tag=package-2021-07` is specified on the command line + +``` yaml $(tag) == 'package-2021-07' +input-file: +- Microsoft.Insights/stable/2015-04-01/autoscale_API.json +- Microsoft.Insights/stable/2015-04-01/operations_API.json +- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json +- Microsoft.Insights/stable/2016-03-01/alertRules_API.json +- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json +- Microsoft.Insights/stable/2019-06-01/actionGroups_API.json +- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json +- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json +- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json +- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json +- Microsoft.Insights/stable/2018-01-01/metrics_API.json +- Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json +- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json +- Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json +- Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json +- Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json +- Microsoft.Insights/preview/2019-10-17-preview/privateLinkScopes_API.json +- Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json +- Microsoft.Insights/stable/2021-04-01/dataCollectionEndpoints_API.json +- Microsoft.Insights/stable/2021-04-01/dataCollectionRuleAssociations_API.json +- Microsoft.Insights/stable/2021-04-01/dataCollectionRules_API.json +``` + +### Tag: package-2021-04 + +These settings apply only when `--tag=package-2021-04` is specified on the command line. + +``` yaml $(tag) == 'package-2021-04' +input-file: +- Microsoft.Insights/stable/2015-04-01/autoscale_API.json +- Microsoft.Insights/stable/2015-04-01/operations_API.json +- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json +- Microsoft.Insights/stable/2016-03-01/alertRules_API.json +- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json +- Microsoft.Insights/stable/2019-06-01/actionGroups_API.json +- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json +- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json +- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json +- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json +- Microsoft.Insights/stable/2018-01-01/metrics_API.json +- Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json +- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json +- Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json +- Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json +- Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json +- Microsoft.Insights/preview/2019-10-17-preview/privateLinkScopes_API.json +- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json +- Microsoft.Insights/stable/2021-04-01/dataCollectionEndpoints_API.json +- Microsoft.Insights/stable/2021-04-01/dataCollectionRuleAssociations_API.json +- Microsoft.Insights/stable/2021-04-01/dataCollectionRules_API.json +``` +### Tag: package-2021-05-01-preview-only + +These settings apply only when `--tag=package-2021-05-01-preview-only` is specified on the command line. + +``` yaml $(tag) == 'package-2021-05-01-preview-only' +input-file: +- Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettings_API.json +- Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettingsCategories_API.json +- Microsoft.Insights/preview/2021-05-01-preview/managementGroupDiagnosticSettings_API.json +- Microsoft.Insights/preview/2021-05-01-preview/subscriptionDiagnosticsSettings_API.json +``` ### Tag: package-2021-04-only ``` yaml $(tag) == 'package-2021-04-only' @@ -66,7 +134,7 @@ These settings apply only when `--tag=package-2020-10-only` is specified on the ``` yaml $(tag) == 'package-2020-10-only' input-file: - - Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json +- Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json ``` ### Tag: package-2020-05-preview-only @@ -153,6 +221,16 @@ input-file: - Microsoft.Insights/preview/2019-10-17-preview/privateLinkScopes_API.json ``` +### Tag: package-2019-07-only + +These settings apply only when `--tag=package-2019-07-only` is specified on the command line. + +```yaml $(tag) == 'package-2019-07-only' +input-file: + - Microsoft.Insights/stable/2019-07-01/metrics_API.json + - Microsoft.Insights/stable/2019-07-01/operations_API.json +``` + ### Tag: package-2019-06 These settings apply only when `--tag=package-2019-06` is specified on the command line. @@ -360,6 +438,17 @@ input-file: - Microsoft.Insights/preview/2017-11-01-preview/calculateBaseline_API.json ``` +### Tag: package-2017-09-preview-only + +These settings apply only when `--tag=package-2017-09-preview-only` is specified on the command line. + +```yaml $(tag) == 'package-2017-09-preview-only' +input-file: + - Microsoft.Insights/preview/2017-09-01-preview/operations_API.json + - Microsoft.Insights/preview/2017-09-01-preview/metricDefinitions_API.json + - Microsoft.Insights/preview/2017-09-01-preview/metrics_API.json +``` + ### Tag: package-2017-08 These settings apply only when `--tag=package-2017-08` is specified on the command line. @@ -526,6 +615,16 @@ input-file: - Microsoft.Insights/stable/2016-09-01/serviceDiagnosticsSettings_API.json ``` +### Tag: package-2016-06-only + +These settings apply only when `--tag=package-2016-06-only` is specified on the command line. + +```yaml $(tag) == 'package-2016-06-only' +input-file: + - Microsoft.Insights/stable/2016-06-01/metrics_API.json + - Microsoft.Insights/stable/2016-06-01/operations_API.json +``` + ### Tag: package-2016-03-01-only These settings apply only when `--tag=package-2016-03-01-only` is specified on the command line. @@ -562,6 +661,16 @@ input-file: - Microsoft.Insights/stable/2014-04-01/alertRules_API.json ``` +### Tag: package-2014-04-01-only + +These settings apply only when `--tag=package-2014-04-01-only` is specified on the command line. + +``` yaml $(tag) == 'package-2014-04-01-only' +input-file: +- Microsoft.Insights/stable/2014-04-01/alertRules_API.json +- Microsoft.Insights/stable/2014-04-01/autoscale_API.json +``` + --- # Code Generation @@ -627,10 +736,29 @@ directive: from: dataCollectionRuleAssociations_API.json where: $.paths reason: 'Operations API is defined in a separate swagger spec for Microsoft.Insights namespace (https://github.com/Azure/azure-rest-api-specs/blob/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json)' + - suppress: MissingTypeObject + from: metrics_API.json + where: $.definitions.LocalizableString + reason: 'LocalizableString exists in other swaggers my team can not modify' + - suppress: MissingTypeObject + from: metricDefinitions_API.json + where: $.definitions.LocalizableString + reason: 'LocalizableString exists in other swaggers my team can not modify' - suppress: OperationsAPIImplementation where: $.paths from: activityLogAlerts_API.json reason: 'Operations API is defined in a separate swagger spec for Microsoft.Insights namespace (https://github.com/Azure/azure-rest-api-specs/blob/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json)' + - suppress: OperationsAPIImplementation + where: $.paths + from: scheduledQueryRule_API.json + reason: 'Operations API is defined in a separate swagger spec for Microsoft.Insights namespace (https://github.com/Azure/azure-rest-api-specs/blob/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json)' + - suppress: R4005 + where: $.definitions.Dimension.properties.operator + from: scheduledQueryRule_API.json + reason: 'The discrepancy in the enum values is with an enum which is defined for a different service of a different team' + - suppress: R3016 + where: $.definitions.Action.properties["odata.type"] + reason: 'This is an old field in a stable api version which is not camel cased' - suppress: EnumInsteadOfBoolean where: $.definitions.AlertRuleProperties.properties.enabled from: activityLogAlerts_API.json @@ -642,12 +770,94 @@ directive: - suppress: DefaultErrorResponseSchema from: activityLogAlerts_API.json reason: 'Updating the error response to the new format would be a breaking change.' + - suppress: DefaultErrorResponseSchema + from: metricNamespaces_API.json + reason: 'Updating the error response to the new format would be a breaking change.' + - suppress: DefaultErrorResponseSchema + from: metrics_API.json + reason: 'Updating the error response to the new format would be a breaking change.' + - suppress: DefaultErrorResponseSchema + from: metricDefinitions_API.json + reason: 'Updating the error response to the new format would be a breaking change.' + - suppress: OperationsAPIImplementation + from: subscriptionDiagnosticsSettings_API.json + where: $.paths + reason: 'Operations API is defined in a separate swagger spec for Microsoft.Insights namespace (https://github.com/Azure/azure-rest-api-specs/blob/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json)' + - suppress: OperationsAPIImplementation + from: autoscale_API.json + where: $.paths + reason: 'Operations API is defined in a separate swagger spec for Microsoft.Insights namespace (https://github.com/Azure/azure-rest-api-specs/blob/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json)' + +``` + +``` yaml ($(go) && !$(track2) && $(tag) == 'package-2021-07') || $(csharp) || $(validation) || $(typescript) +directive: +- from: activityLogAlerts_API.json + where: $.definitions + transform: delete $["Resource"] + reason: Missing kind, etag +- from: activityLogAlerts_API.json + where: $.definitions + transform: delete $["ErrorResponse"] + reason: Incompatible values (2020-10-01) +- from: activityLogAlerts_API.json + where: $.definitions + transform: delete $["AzureResource"] + reason: Incompatible values (2020-10-01) +- from: activityLogAlerts_API.json + where: $.definitions + transform: delete $["ActionGroup"] + reason: Incompatible values (2020-10-01) +``` + +``` yaml !$(python) && !$(go) && !$(java) && ($(tag) == 'package-2021-04' || $(tag) == 'package-2021-07') +directive: +- from: scheduledQueryRule_API.json + where: $.parameters + transform: delete $["ResourceGroupNameParameter"] + reason: ResourceGroupNameParameter is taken from v2/types.json +- from: activityLogAlerts_API.json + where: $.parameters + transform: delete $["ResourceGroupNameParameter"] + reason: ResourceGroupNameParameter is taken from v2/types.json +- from: guestDiagnosticSettings_API.json + where: $.parameters + transform: delete $["ResourceGroupNameParameter"] + reason: ResourceGroupNameParameter is taken from v2/types.json +- from: guestDiagnosticSettingsAssociation_API.json + where: $.parameters + transform: delete $["ResourceGroupNameParameter"] + reason: ResourceGroupNameParameter is taken from v2/types.json +- from: privateLinkScopes_API.json + where: $.parameters + transform: delete $["ResourceGroupNameParameter"] + reason: ResourceGroupNameParameter is taken from v2/types.json +- from: autoscale_API.json + where: $.parameters + transform: delete $["ResourceGroupNameParameter"] + reason: ResourceGroupNameParameter is taken from v2/types.json +- from: alertRules_API.json + where: $.parameters + transform: delete $["ResourceGroupNameParameter"] + reason: ResourceGroupNameParameter is taken from v2/types.json +- from: alertRulesIncidents_API.json + where: $.parameters + transform: delete $["ResourceGroupNameParameter"] + reason: ResourceGroupNameParameter is taken from v2/types.json +- from: actionGroups_API.json + where: $.parameters + transform: delete $["ResourceGroupNameParameter"] + reason: ResourceGroupNameParameter is taken from v2/types.json +- from: metricAlert_API.json + where: $.parameters + transform: delete $["ResourceGroupNameParameter"] + reason: ResourceGroupNameParameter is taken from v2/types.json ``` ### Tag: profile-hybrid-2019-03-01 These settings apply only when `--tag=profile-hybrid-2019-03-01` is specified on the command line. -Creating this tag to pick proper resources from the hybrid profile. +Creating this tag to pick proper resources from the hybrid profile. ``` yaml $(tag) == 'profile-hybrid-2019-03-01' input-file: diff --git a/specification/monitor/resource-manager/readme.python.md b/specification/monitor/resource-manager/readme.python.md index 39f8e259c4f8..58a0df297311 100644 --- a/specification/monitor/resource-manager/readme.python.md +++ b/specification/monitor/resource-manager/readme.python.md @@ -2,24 +2,13 @@ These settings apply only when `--track2` is specified on the command line. -``` yaml +``` yaml $(track2) azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-monitor no-namespace-folders: true +package-version: 1.0.0b1 python-base-folder: monitor/azure-mgmt-monitor/azure/mgmt/monitor -modelerfour: - lenient-model-deduplication: true -``` - -These settings apply when `--track2` and `--AMCS` is specified on the command line. - -``` yaml $(track2) && $(AMCS) -package-version: 0.1.0 -namespace: azure.mgmt.amcs -package-name: azure-mgmt-amcs -basic-setup-py: true -output-folder: $(python-sdks-folder)/amcs/azure-mgmt-amcs ``` ### Python multi-api @@ -29,6 +18,8 @@ Generate all API versions currently shipped for this package ```yaml $(multiapi) && $(track2) clear-output-folder: true batch: + - tag: package-2021-05-01-preview-only + - tag: package-2021-04-only - tag: package-2020-10-only - tag: package-2020-05-preview-only - tag: package-2020-01-01-preview-only @@ -59,6 +50,25 @@ output-folder: $(python-sdks-folder)/monitor/azure-mgmt-monitor/azure/mgmt/monit clear-output-folder: false perform-load: false ``` +### Tag: package-2021-05-01-preview-only and python + +These settings apply only when `--tag=package-2021-05-01-preview-only --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2021-05-01-preview-only' +namespace: $(python-base-namespace).v2021_05_01_preview +output-folder: $(python-sdks-folder)/$(python-base-folder)/v2021_05_01_preview +``` + +### Tag: package-2021-04-only and python + +These settings apply only when `--tag=package-2021-04-only --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2021-04-only' +namespace: $(python-base-namespace).v2021_04_01 +output-folder: $(python-sdks-folder)/$(python-base-folder)/v2021_04_01 +``` ### Tag: package-2020-10-only and python diff --git a/specification/monitor/resource-manager/readme.typescript.md b/specification/monitor/resource-manager/readme.typescript.md index 002921c345f7..1fbc76f28cc7 100644 --- a/specification/monitor/resource-manager/readme.typescript.md +++ b/specification/monitor/resource-manager/readme.typescript.md @@ -12,7 +12,7 @@ typescript: payload-flattening-threshold: 1 ``` -``` yaml $(typescript) && !$(profile) +``` yaml $(typescript) && !$(profile-content) typescript: package-name: "@azure/arm-monitor" output-folder: "$(typescript-sdks-folder)/sdk/monitor/arm-monitor" @@ -21,9 +21,9 @@ typescript: ### Profile: hybrid_2019_03_01 -These settings apply only when `--profile=profile-hybrid-2019-03-01` is specified on the command line. +These settings apply only when `--profile-content=profile-hybrid-2019-03-01` is specified on the command line. -``` yaml $(profile)=='profile-hybrid-2019-03-01' +``` yaml $(profile-content)=='profile-hybrid-2019-03-01' typescript: package-name: "@azure/arm-monitor-profile-2019-03-01-hybrid" output-folder: "$(typescript-sdks-folder)/sdk/monitor/arm-monitor-profile-2019-03-01-hybrid" @@ -34,13 +34,13 @@ typescript: ### Profile: profile-hybrid-2020-09-01 -These settings apply only when `--profile=profile-hybrid-2020-09-01` is specified on the command line. +These settings apply only when `--profile-content=profile-hybrid-2020-09-01` is specified on the command line. -``` yaml $(profile)=='profile-hybrid-2020-09-01' +``` yaml $(profile-content)=='profile-hybrid-2020-09-01' typescript: package-name: "@azure/arm-monitor-profile-2020-09-01-hybrid" output-folder: "$(typescript-sdks-folder)/sdk/monitor/arm-monitor-profile-2020-09-01-hybrid" clear-output-folder: true batch: - tag: profile-hybrid-2020-09-01 -``` \ No newline at end of file +``` diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/mysql.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/mysql.json index e54fc9b3bad0..48cd7c651c96 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/mysql.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/mysql.json @@ -34,7 +34,7 @@ } }, "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}": { "put": { "tags": [ "Servers" @@ -241,7 +241,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers": { "get": { "tags": [ "Servers" @@ -283,7 +283,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMySQL/servers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/servers": { "get": { "tags": [ "Servers" @@ -322,7 +322,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/restart": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/restart": { "post": { "tags": [ "ServerRestart" @@ -365,7 +365,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/replicas": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/replicas": { "get": { "tags": [ "Replicas" @@ -410,7 +410,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/firewallRules/{firewallRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/firewallRules/{firewallRuleName}": { "put": { "tags": [ "FirewallRules" @@ -564,7 +564,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/firewallRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/firewallRules": { "get": { "tags": [ "FirewallRules" @@ -609,7 +609,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { "get": { "tags": [ "VirtualNetworkRules" @@ -754,7 +754,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/virtualNetworkRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/virtualNetworkRules": { "get": { "tags": [ "VirtualNetworkRules" @@ -796,7 +796,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/databases/{databaseName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/databases/{databaseName}": { "put": { "tags": [ "Databases" @@ -950,7 +950,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/databases": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/databases": { "get": { "tags": [ "Databases" @@ -995,7 +995,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/configurations/{configurationName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/configurations/{configurationName}": { "put": { "tags": [ "Configurations" @@ -1096,7 +1096,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/configurations": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/configurations": { "get": { "tags": [ "Configurations" @@ -1141,7 +1141,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/updateConfigurations": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/updateConfigurations": { "post": { "tags": [ "ConfigurationsUpdate" @@ -1196,7 +1196,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/logFiles": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/logFiles": { "get": { "tags": [ "LogFiles" @@ -1241,7 +1241,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/administrators/activeDirectory": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/administrators/activeDirectory": { "get": { "tags": [ "ServerAdministrators" @@ -1383,7 +1383,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/administrators": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/administrators": { "get": { "tags": [ "ServerAdministrators" @@ -1428,7 +1428,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/recoverableServers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/recoverableServers": { "get": { "tags": [ "RecoverableServers" @@ -1470,7 +1470,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/performanceTiers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/performanceTiers": { "get": { "tags": [ "ServerBasedPerformanceTier" @@ -1515,7 +1515,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMySQL/locations/{locationName}/performanceTiers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/performanceTiers": { "get": { "tags": [ "LocationBasedPerformanceTier" @@ -1557,7 +1557,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMySQL/checkNameAvailability": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/checkNameAvailability": { "post": { "tags": [ "CheckNameAvailability" @@ -1602,7 +1602,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { "get": { "tags": [ "ServerSecurityAlertPolicies" @@ -1722,7 +1722,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/securityAlertPolicies": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/securityAlertPolicies": { "get": { "tags": [ "ServerSecurityAlertPolicies" @@ -1764,7 +1764,7 @@ } } }, - "/providers/Microsoft.DBForMySQL/operations": { + "/providers/Microsoft.DBforMySQL/operations": { "get": { "tags": [ "Operations" diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2018-06-01-privatepreview/mysql.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2018-06-01-privatepreview/mysql.json index 79e8e6e25313..76d24a923768 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2018-06-01-privatepreview/mysql.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2018-06-01-privatepreview/mysql.json @@ -34,7 +34,7 @@ } }, "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}": { "put": { "tags": [ "Servers" @@ -217,7 +217,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers": { "get": { "tags": [ "Servers" @@ -253,7 +253,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMySQL/servers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/servers": { "get": { "tags": [ "Servers" @@ -286,7 +286,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/restart": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/restart": { "post": { "tags": [ "ServerRestart" @@ -329,7 +329,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/replicas": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/replicas": { "get": { "tags": [ "Replicas" @@ -368,7 +368,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/firewallRules/{firewallRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/firewallRules/{firewallRuleName}": { "put": { "tags": [ "FirewallRules" @@ -504,7 +504,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/firewallRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/firewallRules": { "get": { "tags": [ "FirewallRules" @@ -543,7 +543,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { "get": { "tags": [ "VirtualNetworkRules" @@ -688,7 +688,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/virtualNetworkRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/virtualNetworkRules": { "get": { "tags": [ "VirtualNetworkRules" @@ -730,7 +730,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/databases/{databaseName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/databases/{databaseName}": { "put": { "tags": [ "Databases" @@ -866,7 +866,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/databases": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/databases": { "get": { "tags": [ "Databases" @@ -905,7 +905,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/configurations/{configurationName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/configurations/{configurationName}": { "put": { "tags": [ "Configurations" @@ -994,7 +994,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/configurations": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/configurations": { "get": { "tags": [ "Configurations" @@ -1033,7 +1033,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/logFiles": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/logFiles": { "get": { "tags": [ "LogFiles" @@ -1072,7 +1072,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/Administrators/activeDirectory": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/Administrators/activeDirectory": { "get": { "tags": [ "ServerAdministrators" @@ -1214,7 +1214,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/administrators": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/administrators": { "get": { "tags": [ "ServerAdministrators" @@ -1259,7 +1259,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMySQL/locations/{locationName}/performanceTiers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/performanceTiers": { "get": { "tags": [ "LocationBasedPerformanceTier" @@ -1295,7 +1295,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMySQL/checkNameAvailability": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/checkNameAvailability": { "post": { "tags": [ "CheckNameAvailability" @@ -1334,7 +1334,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { "get": { "tags": [ "ServerSecurityAlertPolicies" @@ -1454,7 +1454,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/queryTexts/{queryId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/queryTexts/{queryId}": { "get": { "tags": [ "QueryTexts" @@ -1493,7 +1493,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/queryTexts": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/queryTexts": { "get": { "tags": [ "QueryTexts" @@ -1543,7 +1543,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/topQueryStatistics/{queryStatisticId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/topQueryStatistics/{queryStatisticId}": { "get": { "tags": [ "TopQueryStatistics" @@ -1582,7 +1582,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/topQueryStatistics": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/topQueryStatistics": { "get": { "tags": [ "TopQueryStatistics" @@ -1630,7 +1630,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/waitStatistics/{waitStatisticsId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/waitStatistics/{waitStatisticsId}": { "get": { "tags": [ "WaitStatistics" @@ -1669,7 +1669,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/waitStatistics": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/waitStatistics": { "get": { "tags": [ "WaitStatistics" @@ -1717,7 +1717,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/advisors/{advisorName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/advisors/{advisorName}": { "get": { "tags": [ "Advisors" @@ -1756,7 +1756,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/advisors": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/advisors": { "get": { "tags": [ "Advisors" @@ -1795,7 +1795,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/advisors/{advisorName}/createRecommendedActionSession": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/advisors/{advisorName}/createRecommendedActionSession": { "post": { "tags": [ "RecommendedActionSessions" @@ -1842,7 +1842,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/advisors/{advisorName}/recommendedActions/{recommendedActionName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/advisors/{advisorName}/recommendedActions/{recommendedActionName}": { "get": { "tags": [ "RecommendedActions" @@ -1884,7 +1884,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/advisors/{advisorName}/recommendedActions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/advisors/{advisorName}/recommendedActions": { "get": { "tags": [ "RecommendedActions" @@ -1933,7 +1933,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMySQL/locations/{locationName}/recommendedActionSessionsAzureAsyncOperation/{operationId}": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/recommendedActionSessionsAzureAsyncOperation/{operationId}": { "get": { "tags": [ "LocationBasedRecommendedActionSessionsOperationStatus" @@ -1969,7 +1969,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMySQL/locations/{locationName}/recommendedActionSessionsOperationResults/{operationId}": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/recommendedActionSessionsOperationResults/{operationId}": { "get": { "tags": [ "LocationBasedRecommendedActionSessionsResult" @@ -2014,7 +2014,7 @@ } } }, - "/providers/Microsoft.DBForMySQL/operations": { + "/providers/Microsoft.DBforMySQL/operations": { "get": { "tags": [ "Operations" diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-preview/examples/ServerGet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-preview/examples/ServerGet.json index c516cf0ad055..a1bc80b169e9 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-preview/examples/ServerGet.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-preview/examples/ServerGet.json @@ -38,9 +38,6 @@ "startHour": 0, "startMinute": 0, "customWindow": "Disabled" - }, - "delegatedSubnetArguments": { - "subnetArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet" } }, "location": "westus", diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-preview/examples/ServerGetWithVnet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-preview/examples/ServerGetWithVnet.json index c017b9b7bdfb..61282d91d947 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-preview/examples/ServerGetWithVnet.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-preview/examples/ServerGetWithVnet.json @@ -32,6 +32,9 @@ "haEnabled": "Disabled", "delegatedSubnetArguments": { "subnetArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet" + }, + "privateDnsZoneArguments": { + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone" } }, "location": "westus", diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-preview/mysql.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-preview/mysql.json index c07f0e3043e4..9d7412d4dcdb 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-preview/mysql.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-preview/mysql.json @@ -1538,6 +1538,16 @@ }, "description": "Delegated subnet arguments of a server" }, + "privateDnsZoneArguments": { + "type": "object", + "description": "Private DNS zone arguments of a server", + "properties": { + "privateDnsZoneArmResourceId": { + "type": "string", + "description": "private dns zone arm resource id." + } + } + }, "MaintenanceWindow": { "type": "object", "description": "Maintenance window of a server.", @@ -1769,6 +1779,10 @@ "$ref": "#/definitions/DelegatedSubnetArguments", "description": "Delegated subnet arguments." }, + "privateDnsZoneArguments": { + "$ref": "#/definitions/privateDnsZoneArguments", + "description": "private dns zone arguments." + }, "createMode": { "type": "string", "description": "The mode to create a new MySQL server.", diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/BackupGet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/BackupGet.json new file mode 100644 index 000000000000..158e0dc04e9b --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/BackupGet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "backupName": "daily_20210615T160516", + "serverName": "mysqltestserver", + "resourceGroupName": "TestGroup", + "api-version": "2021-05-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "properties": { + "backupType": "FULL", + "source": "Automatic", + "completedTime": "2021-06-15T16:05:19.902522+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210615T160516", + "name": "daily_20210615T160516", + "type": "Microsoft.DBforMySQL/flexibleServers/backups" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/BackupsListByServer.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/BackupsListByServer.json new file mode 100644 index 000000000000..11eb4762e1e4 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/BackupsListByServer.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "serverName": "mysqltestserver", + "resourceGroupName": "TestGroup", + "api-version": "2021-05-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "backupType": "FULL", + "source": "Automatic", + "completedTime": "2021-06-15T16:05:19.902522+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210615T160516", + "name": "daily_20210615T160516", + "type": "Microsoft.DBforMySQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "FULL", + "source": "Automatic", + "completedTime": "2021-06-16T16:05:23.9243453+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210616T160520", + "name": "daily_20210616T160520", + "type": "Microsoft.DBforMySQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "FULL", + "source": "Automatic", + "completedTime": "2021-06-17T16:05:28.1247488+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210617T160525", + "name": "daily_20210617T160525", + "type": "Microsoft.DBforMySQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "FULL", + "source": "Automatic", + "completedTime": "2021-06-18T16:05:32.2736701+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210618T160529", + "name": "daily_20210618T160529", + "type": "Microsoft.DBforMySQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "FULL", + "source": "Automatic", + "completedTime": "2021-06-19T16:05:36.8603354+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210619T160533", + "name": "daily_20210619T160533", + "type": "Microsoft.DBforMySQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "FULL", + "source": "Automatic", + "completedTime": "2021-06-20T16:05:41.9200138+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210620T160538", + "name": "daily_20210620T160538", + "type": "Microsoft.DBforMySQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "FULL", + "source": "Automatic", + "completedTime": "2021-06-21T16:05:48.8528447+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210621T160543", + "name": "daily_20210621T160543", + "type": "Microsoft.DBforMySQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "FULL", + "source": "Automatic", + "completedTime": "2021-06-22T16:08:06.3121688+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210622T160803", + "name": "daily_20210622T160803", + "type": "Microsoft.DBforMySQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "FULL", + "source": "Automatic", + "completedTime": "2021-06-22T21:08:10.5057354+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210622T210807", + "name": "daily_20210622T210807", + "type": "Microsoft.DBforMySQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "FULL", + "source": "Automatic", + "completedTime": "2021-06-23T21:24:16.9401531+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210623T212413", + "name": "daily_20210623T212413", + "type": "Microsoft.DBforMySQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "FULL", + "source": "Automatic", + "completedTime": "2021-06-24T06:13:31.4962137+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210624T061328", + "name": "daily_20210624T061328", + "type": "Microsoft.DBforMySQL/flexibleServers/backups" + } + ] + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/CapabilitiesByLocationList.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/CapabilitiesByLocationList.json new file mode 100644 index 000000000000..54f9f406aa4f --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/CapabilitiesByLocationList.json @@ -0,0 +1,1159 @@ +{ + "parameters": { + "api-version": "2020-07-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "locationName": "WestUS" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "zone": "none", + "supportedHAMode": [ + "SameZone", + "ZoneRedundant" + ], + "supportedGeoBackupRegions": [], + "supportedFlexibleServerEditions": [ + { + "name": "Burstable", + "supportedStorageEditions": [ + { + "name": "Premium", + "minStorageSize": 20480, + "maxStorageSize": 16777216, + "minBackupRetentionDays": 7, + "maxBackupRetentionDays": 35 + } + ], + "supportedServerVersions": [ + { + "name": "5.7", + "supportedSkus": [ + { + "name": "Standard_B1s", + "vCores": 1, + "supportedIops": 400, + "supportedMemoryPerVCoreMB": 1024 + }, + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVCoreMB": 2048 + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVCoreMB": 2048 + } + ] + }, + { + "name": "8.0.21", + "supportedSkus": [ + { + "name": "Standard_B1s", + "vCores": 1, + "supportedIops": 400, + "supportedMemoryPerVCoreMB": 1024 + }, + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVCoreMB": 2048 + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVCoreMB": 2048 + } + ] + } + ] + }, + { + "name": "GeneralPurpose", + "supportedStorageEditions": [ + { + "name": "Premium", + "minStorageSize": 20480, + "maxStorageSize": 16777216, + "minBackupRetentionDays": 7, + "maxBackupRetentionDays": 35 + } + ], + "supportedServerVersions": [ + { + "name": "5.7", + "supportedSkus": [ + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + } + ] + }, + { + "name": "8.0.21", + "supportedSkus": [ + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + } + ] + } + ] + }, + { + "name": "MemoryOptimized", + "supportedStorageEditions": [ + { + "name": "Premium", + "minStorageSize": 20480, + "maxStorageSize": 16777216, + "minBackupRetentionDays": 7, + "maxBackupRetentionDays": 35 + } + ], + "supportedServerVersions": [ + { + "name": "5.7", + "supportedSkus": [ + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + } + ] + }, + { + "name": "8.0.21", + "supportedSkus": [ + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + } + ] + } + ] + } + ] + }, + { + "zone": "1", + "supportedHAMode": [ + "SameZone", + "ZoneRedundant" + ], + "supportedGeoBackupRegions": [], + "supportedFlexibleServerEditions": [ + { + "name": "Burstable", + "supportedStorageEditions": [ + { + "name": "Premium", + "minStorageSize": 20480, + "maxStorageSize": 16777216, + "minBackupRetentionDays": 7, + "maxBackupRetentionDays": 35 + } + ], + "supportedServerVersions": [ + { + "name": "5.7", + "supportedSkus": [ + { + "name": "Standard_B1s", + "vCores": 1, + "supportedIops": 400, + "supportedMemoryPerVCoreMB": 1024 + }, + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVCoreMB": 2048 + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVCoreMB": 2048 + } + ] + }, + { + "name": "8.0.21", + "supportedSkus": [ + { + "name": "Standard_B1s", + "vCores": 1, + "supportedIops": 400, + "supportedMemoryPerVCoreMB": 1024 + }, + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVCoreMB": 2048 + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVCoreMB": 2048 + } + ] + } + ] + }, + { + "name": "GeneralPurpose", + "supportedStorageEditions": [ + { + "name": "Premium", + "minStorageSize": 20480, + "maxStorageSize": 16777216, + "minBackupRetentionDays": 7, + "maxBackupRetentionDays": 35 + } + ], + "supportedServerVersions": [ + { + "name": "5.7", + "supportedSkus": [ + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + } + ] + }, + { + "name": "8.0.21", + "supportedSkus": [ + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + } + ] + } + ] + }, + { + "name": "MemoryOptimized", + "supportedStorageEditions": [ + { + "name": "Premium", + "minStorageSize": 20480, + "maxStorageSize": 16777216, + "minBackupRetentionDays": 7, + "maxBackupRetentionDays": 35 + } + ], + "supportedServerVersions": [ + { + "name": "5.7", + "supportedSkus": [ + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + } + ] + }, + { + "name": "8.0.21", + "supportedSkus": [ + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + } + ] + } + ] + } + ] + }, + { + "zone": "2", + "supportedHAMode": [ + "SameZone", + "ZoneRedundant" + ], + "supportedGeoBackupRegions": [], + "supportedFlexibleServerEditions": [ + { + "name": "Burstable", + "supportedStorageEditions": [ + { + "name": "Premium", + "minStorageSize": 20480, + "maxStorageSize": 16777216, + "minBackupRetentionDays": 7, + "maxBackupRetentionDays": 35 + } + ], + "supportedServerVersions": [ + { + "name": "5.7", + "supportedSkus": [ + { + "name": "Standard_B1s", + "vCores": 1, + "supportedIops": 400, + "supportedMemoryPerVCoreMB": 1024 + }, + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVCoreMB": 2048 + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVCoreMB": 2048 + } + ] + }, + { + "name": "8.0.21", + "supportedSkus": [ + { + "name": "Standard_B1s", + "vCores": 1, + "supportedIops": 400, + "supportedMemoryPerVCoreMB": 1024 + }, + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVCoreMB": 2048 + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVCoreMB": 2048 + } + ] + } + ] + }, + { + "name": "GeneralPurpose", + "supportedStorageEditions": [ + { + "name": "Premium", + "minStorageSize": 20480, + "maxStorageSize": 16777216, + "minBackupRetentionDays": 7, + "maxBackupRetentionDays": 35 + } + ], + "supportedServerVersions": [ + { + "name": "5.7", + "supportedSkus": [ + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + } + ] + }, + { + "name": "8.0.21", + "supportedSkus": [ + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + } + ] + } + ] + }, + { + "name": "MemoryOptimized", + "supportedStorageEditions": [ + { + "name": "Premium", + "minStorageSize": 20480, + "maxStorageSize": 16777216, + "minBackupRetentionDays": 7, + "maxBackupRetentionDays": 35 + } + ], + "supportedServerVersions": [ + { + "name": "5.7", + "supportedSkus": [ + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + } + ] + }, + { + "name": "8.0.21", + "supportedSkus": [ + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + } + ] + } + ] + } + ] + }, + { + "zone": "3", + "supportedHAMode": [ + "SameZone", + "ZoneRedundant" + ], + "supportedGeoBackupRegions": [], + "supportedFlexibleServerEditions": [ + { + "name": "Burstable", + "supportedStorageEditions": [ + { + "name": "Premium", + "minStorageSize": 20480, + "maxStorageSize": 16777216, + "minBackupRetentionDays": 7, + "maxBackupRetentionDays": 35 + } + ], + "supportedServerVersions": [ + { + "name": "5.7", + "supportedSkus": [ + { + "name": "Standard_B1s", + "vCores": 1, + "supportedIops": 400, + "supportedMemoryPerVCoreMB": 1024 + }, + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVCoreMB": 2048 + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVCoreMB": 2048 + } + ] + }, + { + "name": "8.0.21", + "supportedSkus": [ + { + "name": "Standard_B1s", + "vCores": 1, + "supportedIops": 400, + "supportedMemoryPerVCoreMB": 1024 + }, + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVCoreMB": 2048 + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVCoreMB": 2048 + } + ] + } + ] + }, + { + "name": "GeneralPurpose", + "supportedStorageEditions": [ + { + "name": "Premium", + "minStorageSize": 20480, + "maxStorageSize": 16777216, + "minBackupRetentionDays": 7, + "maxBackupRetentionDays": 35 + } + ], + "supportedServerVersions": [ + { + "name": "5.7", + "supportedSkus": [ + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + } + ] + }, + { + "name": "8.0.21", + "supportedSkus": [ + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 4096 + } + ] + } + ] + }, + { + "name": "MemoryOptimized", + "supportedStorageEditions": [ + { + "name": "Premium", + "minStorageSize": 20480, + "maxStorageSize": 16777216, + "minBackupRetentionDays": 7, + "maxBackupRetentionDays": 35 + } + ], + "supportedServerVersions": [ + { + "name": "5.7", + "supportedSkus": [ + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + } + ] + }, + { + "name": "8.0.21", + "supportedSkus": [ + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 20000, + "supportedMemoryPerVCoreMB": 8192 + } + ] + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/CheckNameAvailability.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..86946bffa15b --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/CheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2021-05-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "locationName": "SouthEastAsia", + "nameAvailabilityRequest": { + "name": "name1", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "message": "", + "reason": "" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/CheckVirtualNetworkSubnetUsage.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/CheckVirtualNetworkSubnetUsage.json new file mode 100644 index 000000000000..a00b0ba642f6 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/CheckVirtualNetworkSubnetUsage.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2021-05-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "locationName": "WestUS", + "parameters": { + "virtualNetworkResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/testvnet" + } + }, + "responses": { + "200": { + "body": { + "delegatedSubnetsUsage": [ + { + "subnetName": "test-subnet-1", + "usage": 2 + }, + { + "subnetName": "test-subnet-2", + "usage": 3 + } + ] + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ConfigurationGet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ConfigurationGet.json new file mode 100644 index 000000000000..94989134a6df --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ConfigurationGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "configurationName": "event_scheduler", + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2021-05-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "properties": { + "value": "OFF", + "description": "Indicates the status of the Event Scheduler. It is always OFF for a replica server to keep the replication consistency.", + "defaultValue": "OFF", + "dataType": "Enumeration", + "allowedValues": "ON,OFF", + "source": "system-default", + "isConfigPendingRestart": "False", + "isDynamicConfig": "True", + "isReadOnly": "False" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/testserver/configurations/event_scheduler", + "name": "event_scheduler", + "type": "Microsoft.DBforMySQL/flexibleServers/configurations" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ConfigurationUpdate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ConfigurationUpdate.json new file mode 100644 index 000000000000..92c5bf25de1d --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ConfigurationUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "serverName": "testserver", + "configurationName": "event_scheduler", + "resourceGroupName": "testrg", + "api-version": "2021-05-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "value": "on", + "source": "user-override" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "value": "ON", + "description": "Indicates the status of the Event Scheduler. It is always OFF for a replica server to keep the replication consistency.", + "defaultValue": "OFF", + "dataType": "Enumeration", + "allowedValues": "ON,OFF", + "source": "user-override", + "isConfigPendingRestart": "False", + "isDynamicConfig": "True", + "isReadOnly": "False" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/testserver/configurations/event_scheduler", + "name": "event_scheduler", + "type": "Microsoft.DBforMySQL/flexibleServers/configurations" + } + }, + "202": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ConfigurationsBatchUpdate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ConfigurationsBatchUpdate.json new file mode 100644 index 000000000000..29cd82ea35a8 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ConfigurationsBatchUpdate.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "serverName": "mysqltestserver", + "resourceGroupName": "testrg", + "api-version": "2021-05-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "value": [ + { + "name": "event_scheduler", + "properties": { + "value": "OFF" + } + }, + { + "name": "div_precision_increment", + "properties": { + "value": "8" + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "value": "ON", + "description": "Indicates the status of the Event Scheduler. It is always OFF for a replica server to keep the replication consistency.", + "defaultValue": "OFF", + "dataType": "Enumeration", + "allowedValues": "ON,OFF", + "source": "user-override", + "isConfigPendingRestart": "False", + "isDynamicConfig": "True", + "isReadOnly": "False" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/event_scheduler", + "name": "event_scheduler", + "type": "Microsoft.DBforMySQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "8", + "description": "Number of digits by which to increase the scale of the result of division operations.", + "defaultValue": "4", + "dataType": "Integer", + "allowedValues": "0-30", + "source": "user-override", + "isConfigPendingRestart": "False", + "isDynamicConfig": "True", + "isReadOnly": "False" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/div_precision_increment", + "name": "div_precision_increment", + "type": "Microsoft.DBforMySQL/flexibleServers/configurations" + } + ] + } + }, + "202": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ConfigurationsListByServer.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ConfigurationsListByServer.json new file mode 100644 index 000000000000..d28cd942a62a --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ConfigurationsListByServer.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "serverName": "mysqltestserver", + "resourceGroupName": "testrg", + "api-version": "2021-05-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "value": "OFF", + "description": "Tell the server to enable or disable archive engine.", + "defaultValue": "OFF", + "dataType": "Enumeration", + "allowedValues": "ON,OFF", + "source": "system-default", + "isConfigPendingRestart": "False", + "isDynamicConfig": "False", + "isReadOnly": "True" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/archive", + "name": "archive", + "type": "Microsoft.DBforMySQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "OFF", + "description": "Allow to audit the log.", + "defaultValue": "OFF", + "dataType": "Enumeration", + "allowedValues": "ON,OFF", + "source": "system-default", + "isConfigPendingRestart": "False", + "isDynamicConfig": "True", + "isReadOnly": "False" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/audit_log_enabled", + "name": "audit_log_enabled", + "type": "Microsoft.DBforMySQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "CONNECTION", + "description": "Select the events to audit logs.", + "defaultValue": "CONNECTION", + "dataType": "Set", + "allowedValues": "DDL,DML_SELECT,DML_NONSELECT,DCL,ADMIN,DML,GENERAL,CONNECTION,TABLE_ACCESS", + "source": "system-default", + "isConfigPendingRestart": "False", + "isDynamicConfig": "True", + "isReadOnly": "False" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/audit_log_events", + "name": "audit_log_events", + "type": "Microsoft.DBforMySQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "azure_superuser", + "description": "The comma-separated user list whose commands will not be in the audit logs.", + "defaultValue": "azure_superuser", + "dataType": "String", + "allowedValues": "", + "source": "system-default", + "isConfigPendingRestart": "False", + "isDynamicConfig": "True", + "isReadOnly": "False" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/audit_log_exclude_users", + "name": "audit_log_exclude_users", + "type": "Microsoft.DBforMySQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "", + "description": "The comma-separated user list whose commands will be in the audit logs. It takes higher priority if the same user name is found in audit_log_exclude_users.", + "defaultValue": "", + "dataType": "String", + "allowedValues": "", + "source": "system-default", + "isConfigPendingRestart": "False", + "isDynamicConfig": "True", + "isReadOnly": "False" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/audit_log_include_users", + "name": "audit_log_include_users", + "type": "Microsoft.DBforMySQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "ON", + "description": "Allow to audit the slow log.", + "defaultValue": "ON", + "dataType": "Enumeration", + "allowedValues": "ON,OFF", + "source": "system-default", + "isConfigPendingRestart": "False", + "isDynamicConfig": "True", + "isReadOnly": "True" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/audit_slow_log_enabled", + "name": "audit_slow_log_enabled", + "type": "Microsoft.DBforMySQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "OFF", + "description": "Controls whether the server autogenerates SSL key and certificate files in the data directory, if they do not already exist.", + "defaultValue": "OFF", + "dataType": "Enumeration", + "allowedValues": "ON,OFF", + "source": "system-default", + "isConfigPendingRestart": "False", + "isDynamicConfig": "False", + "isReadOnly": "True" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/auto_generate_certs", + "name": "auto_generate_certs", + "type": "Microsoft.DBforMySQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1", + "description": "The auto_increment_increment is intended for use with source-to-source replication, and can be used to control the operation of AUTO_INCREMENT columns.", + "defaultValue": "1", + "dataType": "Integer", + "allowedValues": "1-65535", + "source": "system-default", + "isConfigPendingRestart": "False", + "isDynamicConfig": "True", + "isReadOnly": "False" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/configurations/auto_increment_increment", + "name": "auto_increment_increment", + "type": "Microsoft.DBforMySQL/flexibleServers/configurations" + } + ] + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/DatabaseCreate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/DatabaseCreate.json new file mode 100644 index 000000000000..8de414cabc64 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/DatabaseCreate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "databaseName": "db1", + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2021-05-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "charset": "utf8", + "collation": "utf8_general_ci" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/testserver/databases/db1", + "name": "db1", + "type": "Microsoft.DBforMySQL/flexibleServers/databases", + "properties": { + "charset": "utf8", + "collation": "utf8_general_ci" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/testserver/databases/db1", + "name": "db1", + "type": "Microsoft.DBforMySQL/flexibleServers/databases", + "properties": { + "charset": "utf8", + "collation": "utf8_general_ci" + } + } + }, + "202": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/DatabaseDelete.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/DatabaseDelete.json new file mode 100644 index 000000000000..2059dcde4623 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/DatabaseDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "databaseName": "db1", + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2021-05-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/DatabaseGet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/DatabaseGet.json new file mode 100644 index 000000000000..af9e7ba14bea --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/DatabaseGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "databaseName": "db1", + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2021-05-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/testserver/databases/db1", + "name": "db1", + "type": "Microsoft.DBforMySQL/flexibleServers/databases", + "properties": { + "charset": "utf8", + "collation": "utf8_general_ci" + } + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/DatabasesListByServer.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/DatabasesListByServer.json new file mode 100644 index 000000000000..8f49cb7289e6 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/DatabasesListByServer.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2021-05-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/testserver/databases/db1", + "name": "db1", + "type": "Microsoft.DBforMySQL/flexibleServers/databases", + "properties": { + "charset": "utf8", + "collation": "utf8_general_ci" + } + }, + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/testserver/databases/db2", + "name": "db2", + "type": "Microsoft.DBforMySQL/flexibleServers/databases", + "properties": { + "charset": "utf8", + "collation": "utf8_general_ci" + } + } + ] + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/FirewallRuleCreate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/FirewallRuleCreate.json new file mode 100644 index 000000000000..d5d728a1f4d7 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/FirewallRuleCreate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "firewallRuleName": "rule1", + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2021-05-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/testserver/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.DBforMySQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/testserver/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.DBforMySQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + }, + "202": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/FirewallRuleDelete.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/FirewallRuleDelete.json new file mode 100644 index 000000000000..3236979a660b --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/FirewallRuleDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "firewallRuleName": "rule1", + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2021-05-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/FirewallRuleGet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/FirewallRuleGet.json new file mode 100644 index 000000000000..d3f55e62501c --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/FirewallRuleGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "firewallRuleName": "rule1", + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2021-05-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/testserver/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.DBforMySQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/FirewallRulesListByServer.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/FirewallRulesListByServer.json new file mode 100644 index 000000000000..87d8e5c9302f --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/FirewallRulesListByServer.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2021-05-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/testserver/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.DBforMySQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + }, + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/testserver/firewallRules/rule2", + "name": "rule2", + "type": "Microsoft.DBforMySQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "1.0.0.0", + "endIpAddress": "255.0.0.0" + } + } + ] + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/GetPrivateDnsZoneSuffix.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/GetPrivateDnsZoneSuffix.json new file mode 100644 index 000000000000..837c714448ab --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/GetPrivateDnsZoneSuffix.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2021-05-01-preview" + }, + "responses": { + "200": { + "body": { + "privateDnsZoneSuffix": "suffix-example" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/OperationsList.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/OperationsList.json new file mode 100644 index 000000000000..38466a7f0b6f --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/OperationsList.json @@ -0,0 +1,190 @@ +{ + "parameters": { + "api-version": "2021-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DBforMySQL/flexibleServers/firewallRules/read", + "display": { + "provider": "Microsoft DB for MySQL", + "resource": "Firewall Rules", + "operation": "List/Get Firewall Rules", + "description": "Return the list of firewall rules for a server or gets the properties for the specified firewall rule." + } + }, + { + "name": "Microsoft.DBforMySQL/flexibleServers/firewallRules/write", + "display": { + "provider": "Microsoft DB for MySQL", + "resource": "Firewall Rules", + "operation": "Create/Update Firewall Rule", + "description": "Creates a firewall rule with the specified parameters or update an existing rule." + } + }, + { + "name": "Microsoft.DBforMySQL/flexibleServers/firewallRules/delete", + "display": { + "provider": "Microsoft DB for MySQL", + "resource": "Firewall Rules", + "operation": "Delete Firewall Rule", + "description": "Deletes an existing firewall rule." + } + }, + { + "name": "Microsoft.DBforMySQL/flexibleServers/read", + "display": { + "provider": "Microsoft DB for MySQL", + "resource": "MySQL Server", + "operation": "List/Get MySQL Servers", + "description": "Return the list of servers or gets the properties for the specified server." + } + }, + { + "name": "Microsoft.DBforMySQL/flexibleServers/write", + "display": { + "provider": "Microsoft DB for MySQL", + "resource": "MySQL Server", + "operation": "Create/Update MySQL Server", + "description": "Creates a server with the specified parameters or update the properties or tags for the specified server." + } + }, + { + "name": "Microsoft.DBforMySQL/flexibleServers/delete", + "display": { + "provider": "Microsoft DB for MySQL", + "resource": "MySQL Server", + "operation": "Delete MySQL Server", + "description": "Deletes an existing server." + } + }, + { + "name": "Microsoft.DBforMySQL/flexibleServers/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft DB for MySQL", + "resource": "Database Metric Definition", + "operation": "Get database metric definitions", + "description": "Return types of metrics that are available for databases" + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "cpu_percent", + "displayName": "CPU percent", + "displayDescription": "CPU percent", + "unit": "Percent", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "memory_percent", + "displayName": "Memory percent", + "displayDescription": "Memory percent", + "unit": "Percent", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "io_consumption_percent", + "displayName": "IO percent", + "displayDescription": "IO percent", + "unit": "Percent", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "storage_percent", + "displayName": "Storage percentage", + "displayDescription": "Storage percentage", + "unit": "Percent", + "aggregationType": "Average" + }, + { + "name": "storage_used", + "displayName": "Storage used", + "displayDescription": "Storage used", + "unit": "Bytes", + "aggregationType": "Average" + }, + { + "name": "storage_limit", + "displayName": "Storage limit", + "displayDescription": "Storage limit", + "unit": "Bytes", + "aggregationType": "Average" + }, + { + "name": "serverlog_storage_percent", + "displayName": "Server Log storage percent", + "displayDescription": "Server Log storage percent", + "unit": "Percent", + "aggregationType": "Average" + }, + { + "name": "serverlog_storage_usage", + "displayName": "Server Log storage used", + "displayDescription": "Server Log storage used", + "unit": "Bytes", + "aggregationType": "Average" + }, + { + "name": "serverlog_storage_limit", + "displayName": "Server Log storage limit", + "displayDescription": "Server Log storage limit", + "unit": "Bytes", + "aggregationType": "Average" + }, + { + "name": "active_connections", + "displayName": "Total active connections", + "displayDescription": "Total active connections", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "connections_failed", + "displayName": "Total failed connections", + "displayDescription": "Total failed connections", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "seconds_behind_master", + "displayName": "Replication lag in seconds", + "displayDescription": "Replication lag in seconds", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": true + } + ] + } + } + }, + { + "name": "Microsoft.DBforMySQL/flexibleServers/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft DB for MySQL", + "resource": "Database Metric Definition", + "operation": "Read diagnostic setting", + "description": "Gets the disagnostic setting for the resource" + } + }, + { + "name": "Microsoft.DBforMySQL/flexibleServers/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft DB for MySQL", + "resource": "Database Metric Definition", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource" + } + } + ] + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ReplicasListByServer.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ReplicasListByServer.json new file mode 100644 index 000000000000..6205f229d9de --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ReplicasListByServer.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "serverName": "mysqltestserver", + "resourceGroupName": "TestGroup", + "api-version": "2020-07-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 20, + "iops": 360, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS" + }, + "version": "5.7", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver-repl.orcabrci-seas1-a.mscds.com", + "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver", + "availabilityZone": "1", + "replicationRole": "Replica", + "replicaCapacity": 0, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-24T08:19:18.00+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + } + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver-repl", + "name": "mysqltestserver-repl", + "type": "Microsoft.DBforMySQL/flexibleServers" + }, + { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 20, + "iops": 360, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS" + }, + "version": "5.7", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver-repl2.orcabrci-seas1-a.mscds.com", + "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver", + "availabilityZone": "1", + "replicationRole": "Replica", + "replicaCapacity": 0, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-23T08:19:18.00+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + } + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver-repl2", + "name": "mysqltestserver-repl", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + ] + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerCreate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerCreate.json new file mode 100644 index 000000000000..d4ff7e521614 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerCreate.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "serverName": "mysqltestserver", + "resourceGroupName": "testrg", + "api-version": "2021-05-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "administratorLoginPassword": "your_password", + "availabilityZone": "1", + "version": "5.7", + "createMode": "Default", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Disabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "standbyAvailabilityZone": "3" + } + }, + "location": "southeastasia", + "tags": { + "num": "1" + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS" + }, + "version": "5.7", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver.database.mysql.azure.com", + "availabilityZone": "1", + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "3" + } + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver", + "name": "mysqltestserver", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS" + }, + "version": "5.7", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver.database.mysql.azure.com", + "availabilityZone": "1", + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "3" + } + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver", + "name": "mysqltestserver", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerCreateReplica.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerCreateReplica.json new file mode 100644 index 000000000000..b8804b881ae6 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerCreateReplica.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "serverName": "replica-server", + "resourceGroupName": "testgr", + "api-version": "2021-05-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "SoutheastAsia", + "properties": { + "createMode": "Replica", + "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testgr/providers/Microsoft.DBforMySQL/flexibleServers/source-server" + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 20, + "iops": 360, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS" + }, + "version": "5.7", + "state": "Ready", + "fullyQualifiedDomainName": "replica-server.database.mysql.azure.com", + "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testgr/providers/Microsoft.DBforMySQL/flexibleServers/source-server", + "availabilityZone": "3", + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "Replica", + "replicaCapacity": 0, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-24T08:19:18.5729164+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + } + }, + "location": "Southeast Asia", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testgr/providers/Microsoft.DBforMySQL/flexibleServers/replica-server", + "name": "replica-server", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 20, + "iops": 360, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS" + }, + "version": "5.7", + "state": "Ready", + "fullyQualifiedDomainName": "replica-server.database.mysql.azure.com", + "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testgr/providers/Microsoft.DBforMySQL/flexibleServers/source-server", + "availabilityZone": "3", + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "Replica", + "replicaCapacity": 0, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-24T08:19:18.5729164+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + } + }, + "location": "Southeast Asia", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testgr/providers/Microsoft.DBforMySQL/flexibleServers/replica-server", + "name": "replica-server", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerCreateWithPointInTimeRestore.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerCreateWithPointInTimeRestore.json new file mode 100644 index 000000000000..0e2fa45c189d --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerCreateWithPointInTimeRestore.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "serverName": "targetserver", + "resourceGroupName": "TargetResourceGroup", + "api-version": "2020-07-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "SoutheastAsia", + "properties": { + "restorePointInTime": "2021-06-24T00:00:37.467Z", + "createMode": "PointInTimeRestore", + "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/SourceResourceGroup/providers/Microsoft.DBforMySQL/flexibleServers/sourceserver" + }, + "sku": { + "name": "Standard_D14_v2", + "tier": "GeneralPurpose" + }, + "tags": { + "num": "1" + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "adminuser", + "storage": { + "storageSizeGB": 20, + "iops": 360, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS" + }, + "version": "5.7", + "state": "Ready", + "fullyQualifiedDomainName": "targetserver.database.mysql.azure.com", + "availabilityZone": "1", + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-24T00:15:24.00+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + } + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TargetResourceGroup/providers/Microsoft.DBforMySQL/flexibleServers/targetserver", + "name": "targetserver", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "adminuser", + "storage": { + "storageSizeGB": 20, + "iops": 360, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS" + }, + "version": "5.7", + "state": "Ready", + "fullyQualifiedDomainName": "targetserver.database.mysql.azure.com", + "availabilityZone": "1", + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-24T00:15:24.00+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + } + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TargetResourceGroup/providers/Microsoft.DBforMySQL/flexibleServers/targetserver", + "name": "targetserver", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerDelete.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerDelete.json new file mode 100644 index 000000000000..5850f2c50c02 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2021-05-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerFailover.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerFailover.json new file mode 100644 index 000000000000..f14e448376d0 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerFailover.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2021-05-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerGet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerGet.json new file mode 100644 index 000000000000..7fda80181354 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerGet.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "serverName": "mysqltestserver", + "resourceGroupName": "testrg", + "api-version": "2021-05-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS" + }, + "version": "5.7", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver.database.mysql.azure.com", + "availabilityZone": "3", + "maintenanceWindow": { + "customWindow": "Enabled", + "dayOfWeek": 1, + "startHour": 1, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + } + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver", + "name": "mysqltestserver", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerGetWithVnet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerGetWithVnet.json new file mode 100644 index 000000000000..2a8c5e8f9ac1 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerGetWithVnet.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "serverName": "mysqltestserver", + "resourceGroupName": "testrg", + "api-version": "2020-07-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS" + }, + "version": "5.7", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver.database.mysql.azure.com", + "availabilityZone": "3", + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/2941a09d-7bcf-42fe-91ca-1765f521c829/resourceGroups/OrcabrCI-Vnet-Resource-Group/providers/Microsoft.Network/virtualNetworks/OrcabrCI-Vnet/subnets/mysql-subnet" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + } + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver", + "name": "mysqltestserver", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerRestart.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerRestart.json new file mode 100644 index 000000000000..3b359f1a50db --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerRestart.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2020-07-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "restartWithFailover": "Enabled", + "maxFailoverSeconds": 60 + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerStart.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerStart.json new file mode 100644 index 000000000000..2113645e4f96 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerStart.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2020-07-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerStop.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerStop.json new file mode 100644 index 000000000000..2113645e4f96 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerStop.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2020-07-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerUpdate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerUpdate.json new file mode 100644 index 000000000000..e8a96ca6dd47 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerUpdate.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "serverName": "mysqltestserver", + "resourceGroupName": "testrg", + "api-version": "2020-07-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "storage": { + "storageSizeGB": 30, + "iops": 200, + "autoGrow": "Disabled" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 30, + "iops": 200, + "autoGrow": "Disabled", + "storageSku": "Premium_LRS" + }, + "version": "5.7", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver.database.mysql.azure.com", + "availabilityZone": "3", + "maintenanceWindow": { + "customWindow": "Enabled", + "dayOfWeek": 1, + "startHour": 1, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + } + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver", + "name": "mysqltestserver", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerUpdateWithCustomerMaintenanceWindow.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerUpdateWithCustomerMaintenanceWindow.json new file mode 100644 index 000000000000..48a8f9858285 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServerUpdateWithCustomerMaintenanceWindow.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "serverName": "mysqltestserver", + "resourceGroupName": "testrg", + "api-version": "2021-05-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "maintenanceWindow": { + "customWindow": "Enabled", + "dayOfWeek": 1, + "startHour": 8, + "startMinute": 0 + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D2ds_v4", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS" + }, + "version": "5.7", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver.database.mysql.azure.com", + "availabilityZone": "3", + "maintenanceWindow": { + "customWindow": "Enabled", + "dayOfWeek": 1, + "startHour": 8, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T06:11:38.4150019+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + } + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver", + "name": "mysqltestserver", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServersList.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServersList.json new file mode 100644 index 000000000000..57f984ed91e7 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServersList.json @@ -0,0 +1,152 @@ +{ + "parameters": { + "api-version": "2021-05-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard_B1ms", + "tier": "Burstable" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 23, + "iops": 369, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS" + }, + "version": "5.7", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver1.database.mysql.azure.com", + "availabilityZone": "1", + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T07:08:17.4259886+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + } + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver1", + "name": "mysqltestserver1", + "type": "Microsoft.DBforMySQL/flexibleServers" + }, + { + "sku": { + "name": "Standard_B1ms", + "tier": "Burstable" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 23, + "iops": 369, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS" + }, + "version": "5.7", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver2.mysql.database.azure.com", + "availabilityZone": "2", + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T07:08:17.4259886+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + } + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup2/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver2", + "name": "mysqltestserver2", + "type": "Microsoft.DBforMySQL/flexibleServers" + }, + { + "sku": { + "name": "Standard_E2ds_v4", + "tier": "MemoryOptimized" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS" + }, + "version": "5.7", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver3.mysql.database.azure.com", + "availabilityZone": "1", + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-24T06:28:19.0611667+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + } + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup3/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver3", + "name": "mysqltestserver3", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + ] + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServersListByResourceGroup.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServersListByResourceGroup.json new file mode 100644 index 000000000000..a5d35c1f5391 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/examples/ServersListByResourceGroup.json @@ -0,0 +1,153 @@ +{ + "parameters": { + "resourceGroupName": "TestGroup", + "api-version": "2021-05-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard_B1ms", + "tier": "Burstable" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 23, + "iops": 369, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS" + }, + "version": "5.7", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver1.database.mysql.azure.com", + "availabilityZone": "1", + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T07:08:17.4259886+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + } + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver1", + "name": "mysqltestserver1", + "type": "Microsoft.DBforMySQL/flexibleServers" + }, + { + "sku": { + "name": "Standard_B1ms", + "tier": "Burstable" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 23, + "iops": 369, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS" + }, + "version": "5.7", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver2.mysql.database.azure.com", + "availabilityZone": "2", + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-17T07:08:17.4259886+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + } + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver2", + "name": "mysqltestserver2", + "type": "Microsoft.DBforMySQL/flexibleServers" + }, + { + "sku": { + "name": "Standard_E2ds_v4", + "tier": "MemoryOptimized" + }, + "properties": { + "administratorLogin": "cloudsa", + "storage": { + "storageSizeGB": 100, + "iops": 600, + "autoGrow": "Enabled", + "storageSku": "Premium_LRS" + }, + "version": "5.7", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestserver3.mysql.database.azure.com", + "availabilityZone": "1", + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "None", + "replicaCapacity": 10, + "network": { + "publicNetworkAccess": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-06-24T06:28:19.0611667+00:00" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + } + }, + "location": "Southeast Asia", + "tags": { + "num": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver3", + "name": "mysqltestserver3", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + ] + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/mysql.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/mysql.json new file mode 100644 index 000000000000..a5c9b960639b --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-05-01-preview/mysql.json @@ -0,0 +1,2599 @@ +{ + "swagger": "2.0", + "info": { + "title": "MySQLManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure MySQL resources including servers, databases, firewall rules and configurations.", + "version": "2021-05-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.DBforMySQL/flexibleServers/{serverName}": { + "put": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Create", + "x-ms-examples": { + "Create a new server": { + "$ref": "./examples/ServerCreate.json" + }, + "Create a server as a point in time restore": { + "$ref": "./examples/ServerCreateWithPointInTimeRestore.json" + }, + "Create a replica server": { + "$ref": "./examples/ServerCreateReplica.json" + } + }, + "description": "Creates a new server or updates an existing server. The update action will overwrite the existing server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json../../../../../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/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Server" + }, + "description": "The required parameters for creating or updating a server." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Update", + "x-ms-examples": { + "Update a server": { + "$ref": "./examples/ServerUpdate.json" + }, + "Update server customer maintenance window": { + "$ref": "./examples/ServerUpdateWithCustomerMaintenanceWindow.json" + } + }, + "description": "Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json../../../../../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/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ServerForUpdate" + }, + "description": "The required parameters for updating a server." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Delete", + "x-ms-examples": { + "Delete a server": { + "$ref": "./examples/ServerDelete.json" + } + }, + "description": "Deletes a server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json../../../../../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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Get", + "x-ms-examples": { + "Get a server": { + "$ref": "./examples/ServerGet.json" + }, + "Get a server with vnet": { + "$ref": "./examples/ServerGetWithVnet.json" + } + }, + "description": "Gets information about a server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json../../../../../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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers": { + "get": { + "tags": [ + "Servers" + ], + "operationId": "Servers_ListByResourceGroup", + "x-ms-examples": { + "List servers in a resource group": { + "$ref": "./examples/ServersListByResourceGroup.json" + } + }, + "description": "List all the servers in a given resource group.", + "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" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/flexibleServers": { + "get": { + "tags": [ + "Servers" + ], + "operationId": "Servers_List", + "x-ms-examples": { + "List servers in a subscription": { + "$ref": "./examples/ServersList.json" + } + }, + "description": "List all the servers in a given 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": "OK", + "schema": { + "$ref": "#/definitions/ServerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/failover": { + "post": { + "tags": [ + "ServerFailover" + ], + "operationId": "Servers_Failover", + "x-ms-examples": { + "Restart a server": { + "$ref": "./examples/ServerFailover.json" + } + }, + "description": "Manual failover a server.", + "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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/restart": { + "post": { + "tags": [ + "ServerRestart" + ], + "operationId": "Servers_Restart", + "x-ms-examples": { + "Restart a server": { + "$ref": "./examples/ServerRestart.json" + } + }, + "description": "Restarts a server.", + "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/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ServerRestartParameter" + }, + "description": "The required parameters for restarting a server." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/start": { + "post": { + "tags": [ + "ServerStart" + ], + "operationId": "Servers_Start", + "x-ms-examples": { + "Start a server": { + "$ref": "./examples/ServerStart.json" + } + }, + "description": "Starts a server.", + "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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/stop": { + "post": { + "tags": [ + "ServerStop" + ], + "operationId": "Servers_Stop", + "x-ms-examples": { + "Stop a server": { + "$ref": "./examples/ServerStop.json" + } + }, + "description": "Stops a server.", + "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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/replicas": { + "get": { + "tags": [ + "Servers" + ], + "operationId": "Replicas_ListByServer", + "x-ms-examples": { + "List replicas for a server": { + "$ref": "./examples/ReplicasListByServer.json" + } + }, + "description": "List all the replicas for a given server.", + "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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/backups/{backupName}": { + "get": { + "tags": [ + "Backups" + ], + "operationId": "Backups_Get", + "x-ms-examples": { + "Get a backup for a server": { + "$ref": "./examples/BackupGet.json" + } + }, + "description": "List all the backups for a given server.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/BackupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerBackup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/backups": { + "get": { + "tags": [ + "Backups" + ], + "operationId": "Backups_ListByServer", + "x-ms-examples": { + "List backups for a server": { + "$ref": "./examples/BackupsListByServer.json" + } + }, + "description": "List all the backups for a given server.", + "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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerBackupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/firewallRules/{firewallRuleName}": { + "put": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_CreateOrUpdate", + "x-ms-examples": { + "Create a firewall rule": { + "$ref": "./examples/FirewallRuleCreate.json" + } + }, + "description": "Creates a new firewall rule or updates an existing firewall rule.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/FirewallRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FirewallRule" + }, + "description": "The required parameters for creating or updating a firewall rule." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_Delete", + "x-ms-examples": { + "Delete a firewall rule": { + "$ref": "./examples/FirewallRuleDelete.json" + } + }, + "description": "Deletes a firewall rule.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/FirewallRuleNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_Get", + "x-ms-examples": { + "Get a firewall rule": { + "$ref": "./examples/FirewallRuleGet.json" + } + }, + "description": "Gets information about a server firewall rule.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/FirewallRuleNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/firewallRules": { + "get": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_ListByServer", + "x-ms-examples": { + "List all firewall rules in a server": { + "$ref": "./examples/FirewallRulesListByServer.json" + } + }, + "description": "List all the firewall rules in a given server.", + "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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FirewallRuleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/databases/{databaseName}": { + "put": { + "tags": [ + "Databases" + ], + "operationId": "Databases_CreateOrUpdate", + "x-ms-examples": { + "Create a database": { + "$ref": "./examples/DatabaseCreate.json" + } + }, + "description": "Creates a new database or updates an existing database.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Database" + }, + "description": "The required parameters for creating or updating a database." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Databases" + ], + "operationId": "Databases_Delete", + "x-ms-examples": { + "Delete a database": { + "$ref": "./examples/DatabaseDelete.json" + } + }, + "description": "Deletes a database.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Databases" + ], + "operationId": "Databases_Get", + "x-ms-examples": { + "Get a database": { + "$ref": "./examples/DatabaseGet.json" + } + }, + "description": "Gets information about a database.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/databases": { + "get": { + "tags": [ + "Databases" + ], + "operationId": "Databases_ListByServer", + "x-ms-examples": { + "List databases in a server": { + "$ref": "./examples/DatabasesListByServer.json" + } + }, + "description": "List all the databases in a given server.", + "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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DatabaseListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/configurations/{configurationName}": { + "patch": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_Update", + "x-ms-examples": { + "Update a user configuration": { + "$ref": "./examples/ConfigurationUpdate.json" + } + }, + "description": "Updates a configuration of a server.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Configuration" + }, + "description": "The required parameters for updating a server configuration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_Get", + "x-ms-examples": { + "Get a configuration": { + "$ref": "./examples/ConfigurationGet.json" + } + }, + "description": "Gets information about a configuration of server.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/updateConfigurations": { + "post": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_BatchUpdate", + "x-ms-examples": { + "ConfigurationList": { + "$ref": "./examples/ConfigurationsBatchUpdate.json" + } + }, + "description": "Update a list of configurations in a given server.", + "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/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationListForBatchUpdate" + }, + "description": "The parameters for updating a list of server configuration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationListResult" + } + }, + "202": { + "description": "Accepted" + }, + "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.DBforMySQL/flexibleServers/{serverName}/configurations": { + "get": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_ListByServer", + "x-ms-examples": { + "List all configurations for a server": { + "$ref": "./examples/ConfigurationsListByServer.json" + } + }, + "description": "List all the configurations in a given server.", + "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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/capabilities": { + "get": { + "tags": [ + "LocationBasedCapabilities" + ], + "operationId": "LocationBasedCapabilities_List", + "x-ms-examples": { + "CapabilitiesList": { + "$ref": "./examples/CapabilitiesByLocationList.json" + } + }, + "description": "Get capabilities at specified location in a given subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapabilitiesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/checkVirtualNetworkSubnetUsage": { + "post": { + "tags": [ + "CheckVirtualNetworkSubnetUsage" + ], + "operationId": "CheckVirtualNetworkSubnetUsage_Execute", + "x-ms-examples": { + "CheckVirtualNetworkSubnetUsage": { + "$ref": "./examples/CheckVirtualNetworkSubnetUsage.json" + } + }, + "description": "Get virtual network subnet usage for a given vNet resource id.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkSubnetUsageParameter" + }, + "description": "The required parameters for creating or updating a server." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualNetworkSubnetUsageResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/checkNameAvailability": { + "post": { + "tags": [ + "CheckNameAvailability" + ], + "operationId": "CheckNameAvailability_Execute", + "x-ms-examples": { + "Check name availability": { + "$ref": "./examples/CheckNameAvailability.json" + } + }, + "description": "Check the availability of name for server", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationNameParameter" + }, + { + "name": "nameAvailabilityRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NameAvailabilityRequest" + }, + "description": "The required parameters for checking if server name is available." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NameAvailability" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/providers/Microsoft.DBforMySQL/getPrivateDnsZoneSuffix": { + "post": { + "tags": [ + "GetPrivateDnsZoneSuffix" + ], + "operationId": "GetPrivateDnsZoneSuffix_Execute", + "x-ms-examples": { + "GetPrivateDnsZoneSuffix": { + "$ref": "./examples/GetPrivateDnsZoneSuffix.json" + } + }, + "description": "Get private DNS zone suffix in the cloud.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GetPrivateDnsZoneSuffixResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/providers/Microsoft.DBforMySQL/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "OperationList": { + "$ref": "./examples/OperationsList.json" + } + }, + "description": "Lists all of the available REST API operations.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ServerVersion": { + "type": "string", + "description": "The version of a server.", + "enum": [ + "5.7", + "8.0.21" + ], + "x-ms-enum": { + "name": "ServerVersion", + "modelAsString": true + } + }, + "EnableStatusEnum": { + "type": "string", + "description": "Enum to indicate whether value is 'Enabled' or 'Disabled'", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EnableStatusEnum", + "modelAsString": true + } + }, + "ReplicationRole": { + "type": "string", + "enum": [ + "None", + "Source", + "Replica" + ], + "x-ms-enum": { + "name": "ReplicationRole", + "modelAsString": true + }, + "description": "The replication role." + }, + "MaintenanceWindow": { + "type": "object", + "description": "Maintenance window of a server.", + "properties": { + "customWindow": { + "type": "string", + "description": "indicates whether custom window is enabled or disabled" + }, + "startHour": { + "type": "integer", + "format": "int32", + "description": "start hour for maintenance window" + }, + "startMinute": { + "type": "integer", + "format": "int32", + "description": "start minute for maintenance window" + }, + "dayOfWeek": { + "type": "integer", + "format": "int32", + "description": "day of week for maintenance window" + } + } + }, + "Backup": { + "type": "object", + "properties": { + "backupRetentionDays": { + "type": "integer", + "format": "int32", + "description": "Backup retention days for the server." + }, + "geoRedundantBackup": { + "$ref": "#/definitions/EnableStatusEnum", + "description": "Whether or not geo redundant backup is enabled." + }, + "earliestRestoreDate": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Earliest restore point creation time (ISO8601 format)" + } + }, + "description": "Storage Profile properties of a server" + }, + "Storage": { + "type": "object", + "properties": { + "storageSizeGB": { + "type": "integer", + "format": "int32", + "description": "Max storage size allowed for a server." + }, + "iops": { + "type": "integer", + "format": "int32", + "description": "Storage IOPS for a server." + }, + "autoGrow": { + "description": "Enable Storage Auto Grow or not.", + "$ref": "#/definitions/EnableStatusEnum" + }, + "storageSku": { + "type": "string", + "readOnly": true, + "description": "The sku name of the server storage." + } + }, + "description": "Storage Profile properties of a server" + }, + "Sku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the sku, e.g. Standard_D32s_v3." + }, + "tier": { + "type": "string", + "description": "The tier of the particular SKU, e.g. GeneralPurpose.", + "enum": [ + "Burstable", + "GeneralPurpose", + "MemoryOptimized" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + } + }, + "required": [ + "name", + "tier" + ], + "description": "Billing information related properties of a server." + }, + "Network": { + "type": "object", + "properties": { + "publicNetworkAccess": { + "$ref": "#/definitions/EnableStatusEnum", + "readOnly": true, + "description": "Whether or not public network access is allowed for this server. Value is 'Disabled' when server has VNet integration." + }, + "delegatedSubnetResourceId": { + "type": "string", + "description": "Delegated subnet resource id used to setup vnet for a server." + }, + "privateDnsZoneResourceId": { + "type": "string", + "description": "Private DNS zone resource id." + } + }, + "description": "Network related properties of a server" + }, + "HighAvailability": { + "type": "object", + "properties": { + "mode": { + "type": "string", + "enum": [ + "Enabled", + "Disabled", + "ZoneRedundant", + "SameZone" + ], + "x-ms-enum": { + "name": "HighAvailabilityMode", + "modelAsString": true + }, + "description": "High availability mode for a server." + }, + "state": { + "type": "string", + "readOnly": true, + "description": "The state of server high availability.", + "enum": [ + "NotEnabled", + "CreatingStandby", + "Healthy", + "FailingOver", + "RemovingStandby" + ], + "x-ms-enum": { + "name": "HighAvailabilityState", + "modelAsString": true + } + }, + "standbyAvailabilityZone": { + "type": "string", + "description": "Availability zone of the standby server." + } + }, + "description": "Network related properties of a server" + }, + "ServerProperties": { + "type": "object", + "properties": { + "administratorLogin": { + "type": "string", + "description": "The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "administratorLoginPassword": { + "type": "string", + "x-ms-secret": true, + "format": "password", + "description": "The password of the administrator login (required for server creation).", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "version": { + "$ref": "#/definitions/ServerVersion", + "description": "Server version." + }, + "availabilityZone": { + "type": "string", + "description": "availability Zone information of the server.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "createMode": { + "type": "string", + "description": "The mode to create a new MySQL server.", + "enum": [ + "Default", + "PointInTimeRestore", + "Replica", + "GeoRestore" + ], + "x-ms-enum": { + "name": "CreateMode", + "modelAsString": true + }, + "x-ms-mutability": [ + "create" + ] + }, + "sourceServerResourceId": { + "type": "string", + "description": "The source MySQL server id.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "restorePointInTime": { + "type": "string", + "format": "date-time", + "description": "Restore point creation time (ISO8601 format), specifying the time to restore from.", + "x-ms-mutability": [ + "create" + ] + }, + "replicationRole": { + "$ref": "#/definitions/ReplicationRole", + "description": "The replication role." + }, + "replicaCapacity": { + "type": "integer", + "format": "int32", + "minimum": 0, + "readOnly": true, + "description": "The maximum number of replicas that a primary server can have." + }, + "state": { + "type": "string", + "readOnly": true, + "description": "The state of a server.", + "enum": [ + "Ready", + "Dropping", + "Disabled", + "Starting", + "Stopping", + "Stopped", + "Updating" + ], + "x-ms-enum": { + "name": "ServerState", + "modelAsString": true + } + }, + "fullyQualifiedDomainName": { + "type": "string", + "description": "The fully qualified domain name of a server.", + "readOnly": true + }, + "storage": { + "$ref": "#/definitions/Storage", + "description": "Storage related properties of a server." + }, + "backup": { + "$ref": "#/definitions/Backup", + "description": "Backup related properties of a server." + }, + "highAvailability": { + "$ref": "#/definitions/HighAvailability", + "description": "High availability related properties of a server." + }, + "network": { + "$ref": "#/definitions/Network", + "description": "Network related properties of a server.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "description": "Maintenance window of a server.", + "x-ms-mutability": [ + "update", + "read" + ] + } + }, + "description": "The properties of a server." + }, + "Server": { + "type": "object", + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Identity", + "description": "The Azure Active Directory identity of the server." + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU (pricing tier) of the server." + }, + "properties": { + "$ref": "#/definitions/ServerProperties", + "x-ms-client-flatten": true, + "description": "Properties of the server." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true, + "description": "The system metadata relating to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "description": "Represents a server." + }, + "ServerPropertiesForUpdate": { + "type": "object", + "properties": { + "administratorLoginPassword": { + "type": "string", + "x-ms-secret": true, + "format": "password", + "description": "The password of the administrator login." + }, + "storage": { + "$ref": "#/definitions/Storage", + "description": "Storage related properties of a server." + }, + "backup": { + "$ref": "#/definitions/Backup", + "description": "Backup related properties of a server." + }, + "highAvailability": { + "$ref": "#/definitions/HighAvailability", + "description": "High availability related properties of a server." + }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "description": "Maintenance window of a server." + }, + "replicationRole": { + "$ref": "#/definitions/ReplicationRole", + "description": "The replication role of the server." + } + }, + "description": "The properties that can be updated for a server." + }, + "ServerForUpdate": { + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU (pricing tier) of the server." + }, + "properties": { + "$ref": "#/definitions/ServerPropertiesForUpdate", + "x-ms-client-flatten": true, + "description": "The properties that can be updated for a server." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application-specific metadata in the form of key-value pairs." + } + }, + "description": "Parameters allowed to update for a server." + }, + "ServerListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Server" + }, + "description": "The list of servers" + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of servers." + }, + "ServerRestartParameter": { + "type": "object", + "properties": { + "restartWithFailover": { + "$ref": "#/definitions/EnableStatusEnum", + "description": "Whether or not failover to standby server when restarting a server with high availability enabled." + }, + "maxFailoverSeconds": { + "type": "integer", + "format": "int32", + "description": "The maximum allowed failover time in seconds." + } + }, + "description": "Server restart parameters." + }, + "ServerBackupProperties": { + "type": "object", + "properties": { + "backupType": { + "type": "string", + "description": "Backup type." + }, + "completedTime": { + "type": "string", + "format": "date-time", + "description": "Backup completed time (ISO8601 format)." + }, + "source": { + "type": "string", + "description": "Backup source" + } + }, + "description": "The properties of a server backup." + }, + "ServerBackup": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ServerBackupProperties", + "x-ms-client-flatten": true, + "description": "The properties of a server backup." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true, + "description": "The system metadata relating to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "description": "Server backup properties" + }, + "ServerBackupListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServerBackup" + }, + "description": "The list of backups of a server." + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of server backups." + }, + "FirewallRuleProperties": { + "type": "object", + "properties": { + "startIpAddress": { + "type": "string", + "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$", + "description": "The start IP address of the server firewall rule. Must be IPv4 format." + }, + "endIpAddress": { + "type": "string", + "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$", + "description": "The end IP address of the server firewall rule. Must be IPv4 format." + } + }, + "required": [ + "startIpAddress", + "endIpAddress" + ], + "description": "The properties of a server firewall rule." + }, + "FirewallRule": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FirewallRuleProperties", + "x-ms-client-flatten": true, + "description": "The properties of a firewall rule." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true, + "description": "The system metadata relating to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "required": [ + "properties" + ], + "description": "Represents a server firewall rule." + }, + "FirewallRuleListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FirewallRule" + }, + "description": "The list of firewall rules in a server." + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of firewall rules." + }, + "DatabaseProperties": { + "type": "object", + "properties": { + "charset": { + "type": "string", + "description": "The charset of the database." + }, + "collation": { + "type": "string", + "description": "The collation of the database." + } + }, + "description": "The properties of a database." + }, + "Database": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/DatabaseProperties", + "x-ms-client-flatten": true, + "description": "The properties of a database." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true, + "description": "The system metadata relating to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "description": "Represents a Database." + }, + "DatabaseListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Database" + }, + "description": "The list of databases housed in a server" + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A List of databases." + }, + "ConfigurationProperties": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "Value of the configuration." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "Description of the configuration." + }, + "defaultValue": { + "type": "string", + "readOnly": true, + "description": "Default value of the configuration." + }, + "dataType": { + "type": "string", + "readOnly": true, + "description": "Data type of the configuration." + }, + "allowedValues": { + "type": "string", + "readOnly": true, + "description": "Allowed values of the configuration." + }, + "source": { + "type": "string", + "description": "Source of the configuration.", + "enum": [ + "system-default", + "user-override" + ], + "x-ms-enum": { + "name": "ConfigurationSource", + "modelAsString": true + } + }, + "isReadOnly": { + "type": "string", + "readOnly": true, + "description": "If is the configuration read only.", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "IsReadOnly", + "modelAsString": true + } + }, + "isConfigPendingRestart": { + "type": "string", + "readOnly": true, + "description": "If is the configuration pending restart or not.", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "IsConfigPendingRestart", + "modelAsString": true + } + }, + "isDynamicConfig": { + "type": "string", + "readOnly": true, + "description": "If is the configuration dynamic.", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "IsDynamicConfig", + "modelAsString": true + } + } + }, + "description": "The properties of a configuration." + }, + "Configuration": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ConfigurationProperties", + "x-ms-client-flatten": true, + "description": "The properties of a configuration." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true, + "description": "The system metadata relating to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "description": "Represents a Configuration." + }, + "ConfigurationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Configuration" + }, + "description": "The list of server configurations." + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of server configurations." + }, + "ConfigurationForBatchUpdate": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the configuration." + }, + "properties": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "Value of the configuration." + }, + "source": { + "type": "string", + "description": "Source of the configuration." + } + }, + "x-ms-client-flatten": true, + "description": "The properties can be updated for a configuration." + } + }, + "description": "Represents a Configuration." + }, + "ConfigurationListForBatchUpdate": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationForBatchUpdate" + }, + "description": "The list of server configurations." + } + }, + "description": "A list of server configurations to update." + }, + "VirtualNetworkSubnetUsageParameter": { + "type": "object", + "properties": { + "virtualNetworkResourceId": { + "type": "string", + "description": "Virtual network resource id." + } + }, + "description": "Virtual network subnet usage parameter" + }, + "DelegatedSubnetUsage": { + "type": "object", + "properties": { + "subnetName": { + "type": "string", + "readOnly": true, + "description": "name of the subnet" + }, + "usage": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Number of used delegated subnets" + } + }, + "description": "Delegated subnet usage data." + }, + "VirtualNetworkSubnetUsageResult": { + "type": "object", + "properties": { + "delegatedSubnetsUsage": { + "description": "A list of delegated subnet usage", + "type": "array", + "items": { + "$ref": "#/definitions/DelegatedSubnetUsage" + }, + "readOnly": true + } + }, + "description": "Virtual network subnet usage data." + }, + "SkuCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "vCore name", + "readOnly": true + }, + "vCores": { + "type": "integer", + "format": "int64", + "description": "supported vCores", + "readOnly": true + }, + "supportedIops": { + "type": "integer", + "format": "int64", + "description": "supported IOPS", + "readOnly": true + }, + "supportedMemoryPerVCoreMB": { + "type": "integer", + "format": "int64", + "description": "supported memory per vCore in MB", + "readOnly": true + } + }, + "description": "Sku capability" + }, + "ServerVersionCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "server version", + "readOnly": true + }, + "supportedSkus": { + "description": "A list of supported Skus", + "type": "array", + "items": { + "$ref": "#/definitions/SkuCapability" + }, + "readOnly": true + } + }, + "description": "Server version capabilities." + }, + "StorageEditionCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "storage edition name", + "readOnly": true + }, + "minStorageSize": { + "type": "integer", + "format": "int64", + "description": "The minimal supported storage size.", + "readOnly": true + }, + "maxStorageSize": { + "type": "integer", + "format": "int64", + "description": "The maximum supported storage size.", + "readOnly": true + }, + "minBackupRetentionDays": { + "type": "integer", + "format": "int64", + "description": "Minimal backup retention days", + "readOnly": true + }, + "maxBackupRetentionDays": { + "type": "integer", + "format": "int64", + "description": "Maximum backup retention days", + "readOnly": true + } + }, + "description": "storage edition capability" + }, + "ServerEditionCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Server edition name", + "readOnly": true + }, + "supportedStorageEditions": { + "description": "A list of supported storage editions", + "type": "array", + "items": { + "$ref": "#/definitions/StorageEditionCapability" + }, + "readOnly": true + }, + "supportedServerVersions": { + "description": "A list of supported server versions.", + "type": "array", + "items": { + "$ref": "#/definitions/ServerVersionCapability" + }, + "readOnly": true + } + }, + "description": "Server edition capabilities." + }, + "CapabilityProperties": { + "type": "object", + "properties": { + "zone": { + "type": "string", + "description": "zone name", + "readOnly": true + }, + "supportedHAMode": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Supported high availability mode", + "readOnly": true + }, + "supportedGeoBackupRegions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "supported geo backup regions", + "readOnly": true + }, + "supportedFlexibleServerEditions": { + "description": "A list of supported flexible server editions.", + "type": "array", + "items": { + "$ref": "#/definitions/ServerEditionCapability" + }, + "readOnly": true + } + }, + "description": "Location capabilities." + }, + "CapabilitiesListResult": { + "type": "object", + "properties": { + "value": { + "description": "A list of supported capabilities.", + "type": "array", + "items": { + "$ref": "#/definitions/CapabilityProperties" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + }, + "description": "location capability" + }, + "GetPrivateDnsZoneSuffixResponse": { + "type": "object", + "properties": { + "privateDnsZoneSuffix": { + "type": "string", + "description": "Represents the private DNS zone suffix." + } + }, + "description": "The response of get private dns zone suffix." + }, + "NameAvailabilityRequest": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "Resource name to verify." + }, + "type": { + "type": "string", + "description": "Resource type used for verification." + } + }, + "description": "Request from client to check resource name availability." + }, + "NameAvailability": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "Error Message." + }, + "nameAvailable": { + "type": "boolean", + "description": "Indicates whether the resource name is available." + }, + "reason": { + "type": "string", + "description": "Reason for name being unavailable." + } + }, + "description": "Represents a resource name availability." + }, + "OperationDisplay": { + "type": "object", + "properties": { + "provider": { + "type": "string", + "description": "Operation resource provider name." + }, + "resource": { + "type": "string", + "description": "Resource on which the operation is performed." + }, + "operation": { + "type": "string", + "description": "Localized friendly name for the operation." + }, + "description": { + "type": "string", + "description": "Operation description." + } + }, + "description": "Display metadata associated with the operation." + }, + "Operation": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the operation being performed on this particular object." + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "The localized display information for this particular operation or action." + }, + "origin": { + "type": "string", + "description": "The intended executor of the operation." + }, + "properties": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "x-ms-client-flatten": false, + "description": "Additional descriptions for the operation." + } + }, + "description": "REST API operation definition." + }, + "OperationListResult": { + "description": "A list of resource provider operations.", + "type": "object", + "properties": { + "value": { + "description": "Collection of available operation details", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).", + "type": "string" + } + } + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse", + "description": "The resource management error response." + } + }, + "description": "An error response from the Batch service." + } + }, + "parameters": { + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the server.", + "x-ms-parameter-location": "method" + }, + "FirewallRuleNameParameter": { + "name": "firewallRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the server firewall rule.", + "x-ms-parameter-location": "method" + }, + "DatabaseNameParameter": { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database.", + "x-ms-parameter-location": "method" + }, + "ConfigurationNameParameter": { + "name": "configurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the server configuration.", + "x-ms-parameter-location": "method" + }, + "LocationNameParameter": { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the location.", + "x-ms-parameter-location": "method" + }, + "BackupNameParameter": { + "name": "backupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the backup.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/mysql.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/mysql.json index d901f552b7de..28f881c8b798 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/mysql.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/mysql.json @@ -34,7 +34,7 @@ } }, "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}": { "put": { "tags": [ "Servers" @@ -241,7 +241,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers": { "get": { "tags": [ "Servers" @@ -283,7 +283,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMySQL/servers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/servers": { "get": { "tags": [ "Servers" @@ -322,7 +322,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/restart": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/restart": { "post": { "tags": [ "ServerRestart" @@ -365,7 +365,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/replicas": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/replicas": { "get": { "tags": [ "Replicas" @@ -410,7 +410,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/firewallRules/{firewallRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/firewallRules/{firewallRuleName}": { "put": { "tags": [ "FirewallRules" @@ -564,7 +564,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/firewallRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/firewallRules": { "get": { "tags": [ "FirewallRules" @@ -609,7 +609,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { "get": { "tags": [ "VirtualNetworkRules" @@ -754,7 +754,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/virtualNetworkRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/virtualNetworkRules": { "get": { "tags": [ "VirtualNetworkRules" @@ -796,7 +796,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/databases/{databaseName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/databases/{databaseName}": { "put": { "tags": [ "Databases" @@ -950,7 +950,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/databases": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/databases": { "get": { "tags": [ "Databases" @@ -995,7 +995,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/configurations/{configurationName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/configurations/{configurationName}": { "put": { "tags": [ "Configurations" @@ -1096,7 +1096,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/configurations": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/configurations": { "get": { "tags": [ "Configurations" @@ -1141,7 +1141,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/updateConfigurations": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/updateConfigurations": { "post": { "tags": [ "ConfigurationsUpdate" @@ -1199,7 +1199,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/logFiles": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/logFiles": { "get": { "tags": [ "LogFiles" @@ -1244,7 +1244,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/administrators/activeDirectory": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/administrators/activeDirectory": { "get": { "tags": [ "ServerAdministrators" @@ -1386,7 +1386,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/administrators": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/administrators": { "get": { "tags": [ "ServerAdministrators" @@ -1431,7 +1431,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/recoverableServers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/recoverableServers": { "get": { "tags": [ "RecoverableServers" @@ -1473,7 +1473,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/performanceTiers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/performanceTiers": { "get": { "tags": [ "ServerBasedPerformanceTier" @@ -1518,7 +1518,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMySQL/locations/{locationName}/performanceTiers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/performanceTiers": { "get": { "tags": [ "LocationBasedPerformanceTier" @@ -1560,7 +1560,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMySQL/checkNameAvailability": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/checkNameAvailability": { "post": { "tags": [ "CheckNameAvailability" @@ -1605,7 +1605,7 @@ } } }, - "/providers/Microsoft.DBForMySQL/operations": { + "/providers/Microsoft.DBforMySQL/operations": { "get": { "tags": [ "Operations" diff --git a/specification/mysql/resource-manager/readme.go.md b/specification/mysql/resource-manager/readme.go.md index 80d9daa37054..b36a6a7193d0 100644 --- a/specification/mysql/resource-manager/readme.go.md +++ b/specification/mysql/resource-manager/readme.go.md @@ -12,12 +12,24 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-flexibleserver-2021-05-01-preview - tag: package-2020-07-01-preview - tag: package-2020-01-01 - tag: package-2017-12-01-preview - tag: package-2017-12-01 ``` +### Tag: package-flexibleserver-2021-05-01-preview and go + +These settings apply only when `--tag=package-flexibleserver-2021-05-01-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-flexibleserver-2021-05-01-preview' && $(go) +rpname: mysql +namespace: mysqlflexibleservers +output-folder: $(go-sdk-folder)/services/preview/$(rpname)/mgmt/2021-05-01-preview/$(namespace) +``` + ### Tag: package-2020-07-01-preview and go These settings apply only when `--tag=package-2020-07-01-preview --go` is specified on the command line. diff --git a/specification/mysql/resource-manager/readme.md b/specification/mysql/resource-manager/readme.md index 8895615f5e4a..2cc6efe708eb 100644 --- a/specification/mysql/resource-manager/readme.md +++ b/specification/mysql/resource-manager/readme.md @@ -123,6 +123,15 @@ input-file: - Microsoft.DBforMySQL/preview/2020-07-01-preview/mysql.json ``` +### Tag: package-flexibleserver-2021-05-01-preview + +These settings apply only when `--tag=package-flexibleserver-2021-05-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-flexibleserver-2021-05-01-preview' +input-file: +- Microsoft.DBforMySQL/preview/2021-05-01-preview/mysql.json +``` + ## Suppression ``` yaml directive: @@ -145,7 +154,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js diff --git a/specification/mysql/resource-manager/readme.python.md b/specification/mysql/resource-manager/readme.python.md index f82c594bb1dd..527c587826b8 100644 --- a/specification/mysql/resource-manager/readme.python.md +++ b/specification/mysql/resource-manager/readme.python.md @@ -4,15 +4,7 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml !$(track2) -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - package-name: azure-mgmt-rdbms - clear-output-folder: true - no-namespace-folders: true -``` + These settings apply only when `--track2` is specified on the command line. @@ -21,25 +13,28 @@ azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-rdbms no-namespace-folders: true -modelerfour: - lenient-model-deduplication: true +package-version: 1.0.0b1 ``` ### Python multi-api Generate all API versions currently shipped for this package -```yaml !$(track2) -batch: - - tag: package-2020-01-01 - - tag: package-2020-07-01-preview -``` - ```yaml $(track2) clear-output-folder: true batch: + - tag: package-flexibleserver-2021-05-01-preview - tag: package-2020-01-01 - - tag: package-2020-07-01-preview +``` + +### Tag: package-flexibleserver-2021-05-01-preview and python + +These settings apply only when `--tag=package-flexibleserver-2021-05-01-preview --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-flexibleserver-2021-05-01-preview' && $(python) +namespace: azure.mgmt.rdbms.mysql_flexibleservers +output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms/azure/mgmt/rdbms/mysql_flexibleservers ``` ### Tag: package-2020-01-01 and python @@ -50,20 +45,9 @@ Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2020-07-01-preview' && $(python) -namespace: azure.mgmt.rdbms.mysql_flexibleservers -output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms/azure/mgmt/rdbms/mysql_flexibleservers -python: - namespace: azure.mgmt.rdbms.mysql_flexibleservers - output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms/azure/mgmt/rdbms/mysql_flexibleservers -``` \ No newline at end of file +``` yaml $(track2) +modelerfour: + lenient-model-deduplication: true +``` diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-02-01/examples/Accounts_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-02-01/examples/Accounts_Update.json index 3fe78d195256..b70f3685a310 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-02-01/examples/Accounts_Update.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-02-01/examples/Accounts_Update.json @@ -3,7 +3,7 @@ "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", "resourceGroupName": "myRG", "accountName": "account1", - "api-version": "2020-11-01", + "api-version": "2021-02-01", "body": { "tags": { "Tag1": "Value1" diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Accounts_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Accounts_CreateOrUpdate.json new file mode 100644 index 000000000000..615aa7169a3d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Accounts_CreateOrUpdate.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2021-04-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": "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" + } + } + }, + "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": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Accounts_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Accounts_Delete.json new file mode 100644 index 000000000000..8f81eac5ea8b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Accounts_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2021-04-01" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Accounts_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Accounts_Get.json new file mode 100644 index 000000000000..554fd687d582 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Accounts_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2021-04-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": "Engineering", + "statusDetails": "Status Details", + "aesEncryption": true, + "ldapSigning": true + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Accounts_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Accounts_List.json new file mode 100644 index 000000000000..d3f06681f96c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Accounts_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "api-version": "2021-04-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/2021-04-01/examples/Accounts_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Accounts_Update.json new file mode 100644 index 000000000000..3fe78d195256 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Accounts_Update.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2020-11-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": { + "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/2021-04-01/examples/BackupPolicies_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/BackupPolicies_Create.json new file mode 100644 index 000000000000..ca073378cb18 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/BackupPolicies_Create.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupPolicyName": "backupPolicyName", + "api-version": "2021-04-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/2021-04-01/examples/BackupPolicies_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/BackupPolicies_Delete.json new file mode 100644 index 000000000000..e49de172d151 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/BackupPolicies_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "backupPolicyName": "backupPolicyName", + "api-version": "2021-04-01" + }, + "responses": { + "204": {}, + "202": {}, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/BackupPolicies_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/BackupPolicies_Get.json new file mode 100644 index 000000000000..67084153faa7 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/BackupPolicies_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupPolicyName": "backupPolicyName", + "api-version": "2021-04-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": { + "name": "Policy 1", + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "yearlyBackupsToKeep": 10, + "volumesAssigned": 0, + "enabled": true, + "volumeBackups": [ + { + "volumeName": "volume 1", + "backupsCount": 5, + "policyEnabled": true + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/BackupPolicies_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/BackupPolicies_List.json new file mode 100644 index 000000000000..032a6d8d549d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/BackupPolicies_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2021-04-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": { + "name": "Policy 1", + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "yearlyBackupsToKeep": 10, + "volumesAssigned": 0, + "enabled": true + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/BackupPolicies_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/BackupPolicies_Update.json new file mode 100644 index 000000000000..5837f9571c24 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/BackupPolicies_Update.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupPolicyName": "backupPolicyName", + "api-version": "2021-04-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, + "yearlyBackupsToKeep": 0, + "volumesAssigned": 1, + "enabled": false, + "volumeBackups": [ + { + "volumeName": "volume 1", + "backupsCount": 5, + "policyEnabled": true + } + ] + } + } + }, + "202": { + "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, + "yearlyBackupsToKeep": 0, + "volumesAssigned": 1, + "enabled": false, + "volumeBackups": [ + { + "volumeName": "volume 1", + "backupsCount": 5, + "policyEnabled": true + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Backups_Account_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Backups_Account_Delete.json new file mode 100644 index 000000000000..11dc7cb9d3e3 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Backups_Account_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "backupName": "backupName", + "api-version": "2021-04-01" + }, + "responses": { + "204": {}, + "202": {}, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Backups_Account_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Backups_Account_Get.json new file mode 100644 index 000000000000..0a48f1dc79ea --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Backups_Account_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupName": "backup1", + "api-version": "2021-04-01" + }, + "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", + "location": "eastus", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Backups_Account_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Backups_Account_List.json new file mode 100644 index 000000000000..e107f7b7d9c7 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Backups_Account_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2021-04-01" + }, + "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", + "location": "eastus", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Backups_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Backups_Create.json new file mode 100644 index 000000000000..c62633643f97 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Backups_Create.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "backupName": "backup1", + "api-version": "2021-04-01", + "body": { + "location": "eastus", + "properties": { + "label": "myLabel" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/backups/backup1", + "name": "account1/pool1/volume1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups", + "location": "eastus", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/backups/backup1", + "name": "account1/pool1/volume1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups", + "location": "eastus", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual" + } + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Backups_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Backups_Delete.json new file mode 100644 index 000000000000..33158676812c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Backups_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "poolName": "poolName", + "volumeName": "volumeName", + "backupName": "backupName", + "api-version": "2021-04-01" + }, + "responses": { + "204": {}, + "202": {}, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Backups_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Backups_Get.json new file mode 100644 index 000000000000..9f33e2e521b0 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Backups_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "backupName": "backup1", + "api-version": "2021-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/backups/backup1", + "name": "account1/pool1/volume1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups", + "location": "eastus", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Backups_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Backups_List.json new file mode 100644 index 000000000000..61424ac4e811 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Backups_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2021-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/backups/backup1", + "name": "account1/pool1/volume1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups", + "location": "eastus", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Backups_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Backups_Update.json new file mode 100644 index 000000000000..410960e38559 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Backups_Update.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "backupName": "backup1", + "api-version": "2021-04-01", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/backups/backup1", + "name": "account1/pool1/volume1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups", + "location": "eastus", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/backups/backup1", + "name": "account1/pool1/volume1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups", + "location": "eastus", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/CheckFilePathAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/CheckFilePathAvailability.json new file mode 100644 index 000000000000..0b1b3db61426 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/CheckFilePathAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2021-04-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/2021-04-01/examples/CheckNameAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..1eece6639b01 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/CheckNameAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2021-04-01", + "body": { + "name": "accName", + "type": "netAppAccount", + "resourceGroup": "myRG" + } + }, + "responses": { + "200": { + "body": { + "isAvailable": true + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/CheckQuotaAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/CheckQuotaAvailability.json new file mode 100644 index 000000000000..811387250184 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/CheckQuotaAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2021-04-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/2021-04-01/examples/Pools_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Pools_CreateOrUpdate.json new file mode 100644 index 000000000000..5bb2a87b494f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Pools_CreateOrUpdate.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2021-04-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/2021-04-01/examples/Pools_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Pools_Delete.json new file mode 100644 index 000000000000..afc0c6e2f249 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Pools_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2021-04-01" + }, + "responses": { + "204": {}, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Pools_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Pools_Get.json new file mode 100644 index 000000000000..0b1220026991 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Pools_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2021-04-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/2021-04-01/examples/Pools_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Pools_List.json new file mode 100644 index 000000000000..7212dcc3d9f8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Pools_List.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2021-04-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/2021-04-01/examples/Pools_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Pools_Update.json new file mode 100644 index 000000000000..99556635430d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Pools_Update.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2021-04-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": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/SnapshotPolicies_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/SnapshotPolicies_Create.json new file mode 100644 index 000000000000..b7326d996335 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/SnapshotPolicies_Create.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2021-04-01", + "body": { + "location": "eastus", + "properties": { + "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/2021-04-01/examples/SnapshotPolicies_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/SnapshotPolicies_Delete.json new file mode 100644 index 000000000000..498e48cffe14 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/SnapshotPolicies_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2021-04-01" + }, + "responses": { + "204": {}, + "202": {}, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/SnapshotPolicies_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/SnapshotPolicies_Get.json new file mode 100644 index 000000000000..d78e1e1b3ba0 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/SnapshotPolicies_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2021-04-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/2021-04-01/examples/SnapshotPolicies_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/SnapshotPolicies_List.json new file mode 100644 index 000000000000..705a3c535b66 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/SnapshotPolicies_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2021-04-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/2021-04-01/examples/SnapshotPolicies_ListVolumes.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/SnapshotPolicies_ListVolumes.json new file mode 100644 index 000000000000..929736a85d41 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/SnapshotPolicies_ListVolumes.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2021-04-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/2021-04-01/examples/SnapshotPolicies_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/SnapshotPolicies_Update.json new file mode 100644 index 000000000000..0737c7d986d5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/SnapshotPolicies_Update.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2021-04-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": { + "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/2021-04-01/examples/Snapshots_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Snapshots_Create.json new file mode 100644 index 000000000000..750853fa2d2a --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/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": "2021-04-01", + "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/2021-04-01/examples/Snapshots_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Snapshots_Delete.json new file mode 100644 index 000000000000..7243b956f325 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Snapshots_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2021-04-01" + }, + "responses": { + "204": {}, + "202": {}, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Snapshots_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Snapshots_Get.json new file mode 100644 index 000000000000..d78e55311413 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-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": "2021-04-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/2021-04-01/examples/Snapshots_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Snapshots_List.json new file mode 100644 index 000000000000..b007a0ce9442 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-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": "2021-04-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/2021-04-01/examples/Snapshots_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Snapshots_Update.json new file mode 100644 index 000000000000..20b9e97ab0fd --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Snapshots_Update.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2021-04-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": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Vaults_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Vaults_List.json new file mode 100644 index 000000000000..4c729d0b10eb --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Vaults_List.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2021-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/vaults/vault1", + "name": "account1/vault1", + "type": "Microsoft.NetApp/netAppAccounts/vaults", + "location": "eastus", + "properties": { + "vaultName": "east US" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_AuthorizeReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_AuthorizeReplication.json new file mode 100644 index 000000000000..ccc9cde883b1 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_AuthorizeReplication.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2021-04-01", + "body": { + "remoteVolumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRemoteRG/providers/Microsoft.NetApp/netAppAccounts/remoteAccount1/capacityPools/remotePool1/volumes/remoteVolume1" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_BackupStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_BackupStatus.json new file mode 100644 index 000000000000..f1394dae0e8c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_BackupStatus.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2021-04-01" + }, + "responses": { + "200": { + "body": { + "healthy": true, + "relationshipStatus": "Idle", + "mirrorState": "Mirrored", + "unhealthyReason": "", + "errorMessage": "", + "lastTransferSize": 100000, + "lastTransferType": "", + "totalTransferBytes": 100000 + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_BreakReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_BreakReplication.json new file mode 100644 index 000000000000..ce1f5954648b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_BreakReplication.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2021-04-01", + "body": { + "forceBreakReplication": false + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_CreateOrUpdate.json new file mode 100644 index 000000000000..215c1ceabb72 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/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": "2021-04-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, + "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/stable/2021-04-01/examples/Volumes_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_Delete.json new file mode 100644 index 000000000000..c52b3d7a5b65 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2021-04-01" + }, + "responses": { + "204": {}, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_DeleteReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_DeleteReplication.json new file mode 100644 index 000000000000..e117ae0ffa7e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_DeleteReplication.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2021-04-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_Get.json new file mode 100644 index 000000000000..da1dca287fad --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2021-04-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" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_List.json new file mode 100644 index 000000000000..1a8c9f481c60 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2021-04-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" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_PoolChange.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_PoolChange.json new file mode 100644 index 000000000000..baaa7dfdf2f5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_PoolChange.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2021-04-01", + "body": { + "newPoolResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_ReInitializeReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_ReInitializeReplication.json new file mode 100644 index 000000000000..e117ae0ffa7e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_ReInitializeReplication.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2021-04-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_ReplicationStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_ReplicationStatus.json new file mode 100644 index 000000000000..00e77c6c4d11 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-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": "2021-04-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/2021-04-01/examples/Volumes_RestoreStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_RestoreStatus.json new file mode 100644 index 000000000000..2b1fbc4da9eb --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-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": "2021-04-01" + }, + "responses": { + "200": { + "body": { + "healthy": true, + "relationshipStatus": "Idle", + "mirrorState": "Uninitialized", + "unhealthyReason": "", + "errorMessage": "", + "totalTransferBytes": 100000 + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_ResyncReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_ResyncReplication.json new file mode 100644 index 000000000000..e117ae0ffa7e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_ResyncReplication.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2021-04-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_Revert.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_Revert.json new file mode 100644 index 000000000000..ac7604054078 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_Revert.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2021-04-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": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_Update.json new file mode 100644 index 000000000000..5aef14ab901e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/examples/Volumes_Update.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2021-04-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", + "dataProtection": { + "snapshot": { + "snapshotPolicyId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRP/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1" + } + } + } + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/netapp.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/netapp.json new file mode 100644 index 000000000000..954d9c687667 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2021-04-01/netapp.json @@ -0,0 +1,5337 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft NetApp", + "description": "Microsoft NetApp Azure Resource Provider specification", + "version": "2021-04-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/v2/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." + } + } + } + }, + "/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/location" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/location" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/location" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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}/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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" + } + } + }, + "delete": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_Delete", + "summary": "Delete a NetApp account", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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}/capacityPools": { + "get": { + "summary": "Describe all Capacity Pools", + "description": "List all capacity pools in the NetApp Account", + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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}/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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}/breakReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Break volume replication", + "description": "Break the replication connection on the destination volume", + "operationId": "Volumes_BreakReplication", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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}/replicationStatus": { + "get": { + "tags": [ + "Volumes Replication" + ], + "summary": "Get volume replication status", + "description": "Get the status of the replication", + "operationId": "Volumes_ReplicationStatus", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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}/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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}/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_List", + "summary": "Describe all snapshots", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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}/snapshotPolicies": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "Snapshot Policy" + ], + "operationId": "SnapshotPolicies_List", + "description": "List snapshot policy", + "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}": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "Snapshot Policy" + ], + "operationId": "SnapshotPolicies_Get", + "description": "Get a snapshot Policy", + "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": { + "tags": [ + "Snapshot Policy" + ], + "operationId": "SnapshotPolicies_Create", + "description": "Create a snapshot policy", + "parameters": [ + { + "name": "body", + "description": "Snapshot policy object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + } + ], + "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" + } + } + ], + "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": { + "tags": [ + "Snapshot Policy" + ], + "operationId": "SnapshotPolicies_Delete", + "description": "Delete snapshot policy", + "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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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}/backupStatus": { + "get": { + "tags": [ + "Backups" + ], + "summary": "Get volume's backup status", + "description": "Get the status of the backup for a volume", + "operationId": "Backups_GetStatus", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-examples": { + "Volumes_BackupStatus": { + "$ref": "examples/Volumes_BackupStatus.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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupsList" + } + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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": { + "AccountBackups_Delete": { + "$ref": "examples/Backups_Account_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/backups": { + "get": { + "tags": [ + "Backups" + ], + "summary": "List Backups", + "description": "List all backups for a volume", + "operationId": "Backups_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupsList" + } + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-examples": { + "Backups_List": { + "$ref": "examples/Backups_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/backups/{backupName}": { + "get": { + "tags": [ + "Backups" + ], + "summary": "Get a backup", + "description": "Gets the specified backup of the volume", + "operationId": "Backups_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-examples": { + "Backups_Get": { + "$ref": "examples/Backups_Get.json" + } + } + }, + "put": { + "tags": [ + "Backups" + ], + "summary": "Create a backup", + "description": "Create a backup for the volume", + "operationId": "Backups_Create", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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 created", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "201": { + "description": "Backup created", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "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": { + "Backups_Create": { + "$ref": "examples/Backups_Create.json" + } + } + }, + "patch": { + "tags": [ + "Backups" + ], + "summary": "Patch a backup", + "description": "Patch a backup for the volume", + "operationId": "Backups_Update", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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" + } + }, + "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_Update": { + "$ref": "examples/Backups_Update.json" + } + } + }, + "delete": { + "tags": [ + "Backups" + ], + "summary": "Delete backup", + "description": "Delete a backup of the volume", + "operationId": "Backups_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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/Backups_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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/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}/vaults": { + "get": { + "tags": [ + "Vaults" + ], + "summary": "List vaults", + "description": "List vaults for a Netapp Account", + "operationId": "Vaults_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroup" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/vaultList" + } + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-examples": { + "Vaults_List": { + "$ref": "examples/Vaults_List.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" + }, + "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" + } + } + } + }, + "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." + }, + "dimensions": { + "description": "Dimensions of blobs, including blob type and access tier.", + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + } + }, + "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." + } + } + }, + "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" + } + } + }, + "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" + } + } + }, + "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", + "x-ms-azure-resource": true, + "required": [ + "location" + ], + "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": "NetApp Account properties", + "$ref": "#/definitions/accountProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + } + }, + "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 + } + } + }, + "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" + } + }, + "encryption": { + "description": "Encryption settings", + "$ref": "#/definitions/accountEncryption" + } + } + }, + "activeDirectory": { + "description": "Active Directory", + "type": "object", + "properties": { + "activeDirectoryId": { + "type": "string", + "x-nullable": true, + "description": "Id of the Active Directory" + }, + "username": { + "type": "string", + "description": "Username of Active Directory domain administrator" + }, + "password": { + "type": "string", + "x-ms-secret": true, + "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." + } + } + }, + "accountEncryption": { + "type": "object", + "description": "Encryption settings", + "properties": { + "keySource": { + "type": "string", + "description": "Encryption Key Source. Possible values are: 'Microsoft.NetApp'." + } + } + }, + "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", + "x-ms-azure-resource": true, + "required": [ + "location", + "properties" + ], + "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": "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 4TiB chunks (value must be multiply of 4398046511104).", + "minimum": 4398046511104, + "maximum": 549755813888000 + }, + "serviceLevel": { + "title": "serviceLevel", + "type": "string", + "description": "The service level of the file system", + "enum": [ + "Standard", + "Premium", + "Ultra" + ], + "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" + } + ] + }, + "example": "Ultra", + "default": "Premium" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "totalThroughputMibps": { + "type": "number", + "description": "Total throughput of pool in Mibps", + "example": 164.221, + "readOnly": true + }, + "utilizedThroughputMibps": { + "type": "number", + "description": "Utilized throughput of pool in Mibps", + "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." + } + } + }, + "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 4TiB chunks (value must be multiply of 4398046511104).", + "minimum": 4398046511104, + "maximum": 549755813888000, + "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" + } + } + }, + "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", + "x-ms-azure-resource": true, + "required": [ + "location", + "properties" + ], + "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": "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", + "type": "string", + "description": "The service level of the file system", + "enum": [ + "Standard", + "Premium", + "Ultra" + ], + "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" + } + ] + }, + "example": "Ultra", + "default": "Premium" + }, + "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. Specified in bytes.", + "minimum": 107374182400, + "maximum": 109951162777600, + "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" + } + } + } + }, + "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, + "description": "UUID v4 or resource identifier 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" + }, + "backupId": { + "title": "Backup ID", + "type": "string", + "description": "UUID v4 or resource identifier 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" + }, + "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" + }, + "mountTargets": { + "title": "mountTargets", + "type": "array", + "readOnly": true, + "description": "List of mount targets", + "items": { + "$ref": "#/definitions/mountTargetProperties" + } + }, + "volumeType": { + "type": "string", + "description": "What type of volume is this", + "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" + } + } + }, + "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 (default to true)." + }, + "kerberosEnabled": { + "type": "boolean", + "description": "Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later", + "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 + }, + "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 Mibps that can be achieved by this volume", + "type": "number", + "default": 0.0, + "example": 128.22, + "maximum": 4500, + "minimum": 0 + }, + "encryptionKeySource": { + "description": "Encryption Key Source. Possible values are: 'Microsoft.NetApp'", + "type": "string" + }, + "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" + }, + "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" + } + } + }, + "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": true, + "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": true, + "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": true, + "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" + }, + "vaultId": { + "type": "string", + "description": "Vault Resource ID" + }, + "backupEnabled": { + "type": "boolean", + "description": "Backup Enabled" + } + } + }, + "replicationObject": { + "description": "Replication properties", + "type": "object", + "required": [ + "replicationSchedule", + "remoteVolumeResourceId" + ], + "properties": { + "replicationId": { + "type": "string", + "description": "Id" + }, + "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." + } + } + }, + "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" + } + } + }, + "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", + "type": "string", + "description": "The service level of the file system", + "enum": [ + "Standard", + "Premium", + "Ultra" + ], + "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" + } + ] + }, + "example": "Ultra", + "default": "Premium" + }, + "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. Specified in bytes.", + "minimum": 107374182400, + "maximum": 109951162777600, + "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" + } + } + } + }, + "throughputMibps": { + "title": "Maximum throughput in Mibps that can be achieved by this volume", + "type": "number", + "example": 128.22, + "maximum": 4500, + "minimum": 1 + }, + "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" + } + } + } + } + }, + "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", + "x-ms-azure-resource": true, + "required": [ + "location" + ], + "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": "Snapshot Properties", + "$ref": "#/definitions/snapshotProperties", + "x-ms-client-flatten": true + } + } + }, + "snapshotPatch": { + "description": "Snapshot patch", + "type": "object", + "x-ms-azure-resource": true, + "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", + "x-ms-azure-resource": true, + "required": [ + "location", + "properties" + ], + "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 + } + } + }, + "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": { + "type": "object", + "readOnly": true, + "description": "Associated volume resource Id" + } + } + } + }, + "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" + } + } + }, + "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" + } + } + } + }, + "backup": { + "description": "Backup of a Volume", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "location", + "properties" + ], + "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": "Backup Properties", + "$ref": "#/definitions/backupProperties", + "x-ms-client-flatten": true + } + } + }, + "backupPatch": { + "description": "Backup patch", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Backup Properties", + "$ref": "#/definitions/backupProperties", + "x-ms-client-flatten": true + } + } + }, + "backupProperties": { + "description": "Backup properties", + "type": "object", + "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": "name", + "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", + "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" + }, + "volumeName": { + "type": "string", + "readOnly": true, + "description": "Volume name" + }, + "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 + } + } + }, + "backupPolicyProperties": { + "description": "Backup policy properties", + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "Name of backup policy" + }, + "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" + }, + "yearlyBackupsToKeep": { + "type": "integer", + "description": "Yearly backups count to keep", + "format": "int32" + }, + "volumesAssigned": { + "type": "integer", + "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", + "type": "array", + "items": { + "$ref": "#/definitions/volumeBackups" + } + } + } + }, + "backupPolicy": { + "description": "Backup policy information", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "location", + "properties" + ], + "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 + } + } + }, + "backupPoliciesList": { + "description": "List of Backup Policies", + "type": "object", + "properties": { + "value": { + "description": "A list of backup policies", + "type": "array", + "items": { + "$ref": "#/definitions/backupPolicy" + } + } + } + }, + "backupPolicyDetails": { + "description": "Backup policy properties", + "x-ms-azure-resource": true, + "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": "Backup policy Properties", + "$ref": "#/definitions/backupPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "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" + } + } + }, + "vaultList": { + "description": "List of Vaults", + "type": "object", + "properties": { + "value": { + "description": "A list of vaults", + "type": "array", + "items": { + "$ref": "#/definitions/vault" + } + } + } + }, + "vault": { + "description": "Vault information", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "location", + "properties" + ], + "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": "Vault Properties", + "$ref": "#/definitions/vaultProperties", + "x-ms-client-flatten": true + } + } + }, + "vaultProperties": { + "description": "Vault properties", + "type": "object", + "properties": { + "vaultName": { + "type": "string", + "readOnly": false, + "description": "Vault Name" + } + } + }, + "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" + } + } + }, + "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" + } + } + }, + "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." + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "location": { + "name": "location", + "description": "The location", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ResourceGroup": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "AccountName": { + "name": "accountName", + "type": "string", + "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 mount target", + "x-ms-parameter-location": "method" + }, + "SnapshotPolicyName": { + "name": "snapshotPolicyName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the snapshot policy target", + "x-ms-parameter-location": "method" + }, + "BackupName": { + "name": "backupName", + "type": "string", + "in": "path", + "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" + } + } +} diff --git a/specification/netapp/resource-manager/readme.go.md b/specification/netapp/resource-manager/readme.go.md index f54d42d42df1..01d48c8ae243 100644 --- a/specification/netapp/resource-manager/readme.go.md +++ b/specification/netapp/resource-manager/readme.go.md @@ -13,6 +13,7 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-netapp-2021-04-01 - tag: package-netapp-2021-04-01-preview - tag: package-netapp-2021-02-01 - tag: package-netapp-2020-12-01 @@ -33,6 +34,15 @@ batch: - tag: package-2017-08-15 ``` +### Tag: package-netapp-2021-04-01 and go + +These settings apply only when `--tag=package-netapp-2021-04-01 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-netapp-2021-04-01' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2021-04-01/$(namespace) +``` + ### Tag: package-netapp-2021-04-01-preview and go These settings apply only when `--tag=package-netapp-2021-04-01-preview --go` is specified on the command line. diff --git a/specification/netapp/resource-manager/readme.java.md b/specification/netapp/resource-manager/readme.java.md index fb8e0cd139a5..698873ca5e6a 100644 --- a/specification/netapp/resource-manager/readme.java.md +++ b/specification/netapp/resource-manager/readme.java.md @@ -18,7 +18,8 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-netapp ``` yaml $(java) && $(multiapi) batch: - - tag: package-netapp-2021-02-01-preview + - tag: package-netapp-2021-04-01 + - tag: package-netapp-2021-04-01-preview - tag: package-netapp-2021-02-01 - tag: package-netapp-2020-12-01 - tag: package-netapp-2020-11-01 @@ -37,6 +38,19 @@ batch: - tag: package-netapp-2019-05-01 - tag: package-2017-08-15 ``` +### Tag: package-netapp-2021-04-01 and java + +These settings apply only when `--tag=package-netapp-2021-04-01 --java` is specified on the command line. +Please also specify the `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-netapp-2021-04-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.netapp.v2021_04_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/netapp/mgmt-v2021_04_01 +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-netapp-2021-04-01-preview and java diff --git a/specification/netapp/resource-manager/readme.md b/specification/netapp/resource-manager/readme.md index 43e549b630d2..be8bfacf90fd 100644 --- a/specification/netapp/resource-manager/readme.md +++ b/specification/netapp/resource-manager/readme.md @@ -28,7 +28,16 @@ These are the global settings for the Azure NetApp Files API. title: NetAppManagementClient description: Microsoft NetApp Files Azure Resource Provider specification openapi-type: arm -tag: package-netapp-2021-02-01 +tag: package-netapp-2021-04-01 +``` + +### Tag: package-netapp-2021-04-01 + +These settings apply only when `--tag=package-netapp-2021-04-01` is specified on the command line. + +``` yaml $(tag) == 'package-netapp-2021-04-01' +input-file: +- Microsoft.NetApp/stable/2021-04-01/netapp.json ``` ### Tag: package-netapp-2021-04-01-preview @@ -205,7 +214,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-net - repo: azure-sdk-for-js diff --git a/specification/netapp/resource-manager/readme.python.md b/specification/netapp/resource-manager/readme.python.md index 7745e61921a1..036ec8288f0c 100644 --- a/specification/netapp/resource-manager/readme.python.md +++ b/specification/netapp/resource-manager/readme.python.md @@ -4,39 +4,15 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.netapp - package-name: azure-mgmt-netapp - package-version: 1.0.0 - clear-output-folder: true -``` ``` yaml $(python) && $(track2) -python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.netapp package-name: azure-mgmt-netapp -package-version: 1.0.0 +package-version: 1.0.0b1 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/netapp/azure-mgmt-netapp/azure/mgmt/netapp -``` - -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/netapp/azure-mgmt-netapp -``` - ``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/netapp/azure-mgmt-netapp/azure/mgmt/netapp diff --git a/specification/network/resource-manager/Microsoft.Network/preview/2021-03-01-preview/examples/NetworkSecurityPerimeterDelete.json b/specification/network/resource-manager/Microsoft.Network/preview/2021-03-01-preview/examples/NetworkSecurityPerimeterDelete.json new file mode 100644 index 000000000000..cfb3addfd7fe --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/preview/2021-03-01-preview/examples/NetworkSecurityPerimeterDelete.json @@ -0,0 +1,13 @@ +{ + "title": "Delete Network Security Perimeter", + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "testNSP1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/preview/2021-03-01-preview/examples/NetworkSecurityPerimeterGet.json b/specification/network/resource-manager/Microsoft.Network/preview/2021-03-01-preview/examples/NetworkSecurityPerimeterGet.json new file mode 100644 index 000000000000..85a8addb1ca0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/preview/2021-03-01-preview/examples/NetworkSecurityPerimeterGet.json @@ -0,0 +1,23 @@ +{ + "title": "Get Network Security Perimeter", + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "nsp1" + }, + "responses": { + "200": { + "body": { + "name": "nsp1", + "id": "/subscriptions/subId/resourceGroup/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1", + "type": "Microsoft.Network/networkSecurityPerimeters", + "properties": { + "displayName": "nsp1", + "description": "Test Network Security Periemter", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/preview/2021-03-01-preview/examples/NetworkSecurityPerimeterList.json b/specification/network/resource-manager/Microsoft.Network/preview/2021-03-01-preview/examples/NetworkSecurityPerimeterList.json new file mode 100644 index 000000000000..37c63a2ee52d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/preview/2021-03-01-preview/examples/NetworkSecurityPerimeterList.json @@ -0,0 +1,37 @@ +{ + "title": "List Network Security Perimeter", + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "subId", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testNSP1", + "id": "/subscriptions/subId/resourceGroup/rg1/providers/Microsoft.Network/networkSecurityPerimeters/testNSP1", + "type": "Microsoft.Network/networkSecurityPerimeters", + "properties": { + "displayName": "TestNetworkSecurityPerimeter1", + "description": "Description for TestNetworkSecurityPerimeter1", + "provisioningState": "Succeeded" + } + }, + { + "name": "testNSP2", + "id": "/subscriptions/subId/resourceGroup/rg1/providers/Microsoft.Network/networkSecurityPerimeters/testNSP2", + "type": "Microsoft.Network/networkSecurityPerimeters", + "properties": { + "displayName": "TestNetworkSecurityPerimeter2", + "description": "Description for TestNetworkSecurityPerimeter2", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "{baseurl}/subscriptions/subId/resourceGroup/rg1/providers/Microsoft.Network/networkSecurityPerimeters?api-version=2021-03-01-preview&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/preview/2021-03-01-preview/examples/NetworkSecurityPerimeterListAll.json b/specification/network/resource-manager/Microsoft.Network/preview/2021-03-01-preview/examples/NetworkSecurityPerimeterListAll.json new file mode 100644 index 000000000000..15265c6a6baf --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/preview/2021-03-01-preview/examples/NetworkSecurityPerimeterListAll.json @@ -0,0 +1,36 @@ +{ + "title": "List all the Network Security Perimeters in a Subscription", + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testNSP1", + "id": "/subscriptions/subId/resourceGroup/rg1/providers/Microsoft.Network/networkSecurityPerimeters/testNSP1", + "type": "Microsoft.Network/networkSecurityPerimeters", + "properties": { + "displayName": "TestNetworkSecurityPerimeter1", + "description": "Description for TestNetworkSecurityPerimeter1", + "provisioningState": "Succeeded" + } + }, + { + "name": "testNSP2", + "id": "/subscriptions/subId/resourceGroup/rg1/providers/Microsoft.Network/networkSecurityPerimeters/testNSP2", + "type": "Microsoft.Network/networkSecurityPerimeters", + "properties": { + "displayName": "TestNetworkSecurityPerimeter2", + "description": "Description for TestNetworkSecurityPerimeter2", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "{baseurl}/subscriptions/subId/providers/Microsoft.Network/networkSecurityPerimeters?api-version=2021-03-01-preview&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/preview/2021-03-01-preview/examples/NetworkSecurityPerimeterPut.json b/specification/network/resource-manager/Microsoft.Network/preview/2021-03-01-preview/examples/NetworkSecurityPerimeterPut.json new file mode 100644 index 000000000000..e5aa0b4b31a4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/preview/2021-03-01-preview/examples/NetworkSecurityPerimeterPut.json @@ -0,0 +1,41 @@ +{ + "title": "Create/Update Network Security Perimeter", + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "nsp1", + "parameters": { + "properties": { + "displayName": "TestNetworkSecurityPerimeter", + "description": "Description of TestNetworkSecurityPerimeter" + } + } + }, + "responses": { + "200": { + "body": { + "name": "TestNetworkSecurityPerimeter", + "id": "/subscriptions/subId/resourceGroup/rg1/providers/Microsoft.Network/networkSecurityPerimeters/TestNetworkSecurityPerimeter", + "type": "Microsoft.Network/networkSecurityPerimeters", + "properties": { + "displayName": "TestNetworkSecurityPerimeter", + "description": "Description of TestNetworkSecurityPerimeter", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "TestNetworkSecurityPerimeter", + "id": "/subscriptions/subId/resourceGroup/rg1/providers/Microsoft.Network/networkSecurityPerimeters/TestNetworkSecurityPerimeter", + "type": "Microsoft.Network/networkSecurityPerimeters", + "properties": { + "displayName": "TestNetworkSecurityPerimeter", + "description": "Description of TestNetworkSecurityPerimeter", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/preview/2021-03-01-preview/examples/PerimeterAssociableResourcesList.json b/specification/network/resource-manager/Microsoft.Network/preview/2021-03-01-preview/examples/PerimeterAssociableResourcesList.json new file mode 100644 index 000000000000..1fb3df61055c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/preview/2021-03-01-preview/examples/PerimeterAssociableResourcesList.json @@ -0,0 +1,44 @@ +{ + "title": "List of resources onboarded for network security perimeter feature (perimeter associable resources).", + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "subId", + "location": "westus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Sql.servers", + "id": "/subscriptions/{subscriptionID}/providers/Microsoft.Network/perimeterAssociableResourceTypes/Microsoft.Sql.servers", + "type": "Microsoft.Network/PerimeterAssociableResourceTypes", + "properties": { + "resourceType": "Microsoft.Sql/servers", + "displayName": "Microsoft.Sql/servers", + "publicDnsZones": [ + "database.windows.net" + ] + } + }, + { + "name": "Microsoft.Storage.accounts", + "id": "/subscriptions/{subscriptionId}/providers/Microsoft.Network/perimeterAssociableResourceTypes/Microsoft.Storage.storageAccounts", + "type": "Microsoft.Network/PerimeterAssociableResourceTypes", + "properties": { + "resourceType": "Microsoft.Storage/accounts", + "displayName": "Microsoft.Storage/accounts", + "publicDnsZones": [ + "blob.core.windows.net", + "table.core.windows.net", + "queue.core.windows.net", + "file.core.windows.net" + ] + } + } + ], + "nextLink": "{baseurl}/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/perimeterAssociableResourceTypes?api-version=2021-03-01-preview&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/preview/2021-03-01-preview/network.json b/specification/network/resource-manager/Microsoft.Network/preview/2021-03-01-preview/network.json new file mode 100644 index 000000000000..4397fe7e1e47 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/preview/2021-03-01-preview/network.json @@ -0,0 +1,439 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2021-03-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": {}, + "definitions": { + "ErrorDetails": { + "properties": { + "code": { + "type": "string", + "description": "Error code." + }, + "target": { + "type": "string", + "description": "Error target." + }, + "message": { + "type": "string", + "description": "Error message." + } + }, + "description": "Common error details representation." + }, + "Error": { + "properties": { + "code": { + "type": "string", + "description": "Error code." + }, + "message": { + "type": "string", + "description": "Error message." + }, + "target": { + "type": "string", + "description": "Error target." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetails" + }, + "description": "Error details." + }, + "innerError": { + "type": "string", + "description": "Inner error message." + } + }, + "description": "Common error representation." + }, + "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." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the service." + }, + "AzureAsyncOperationResult": { + "properties": { + "status": { + "type": "string", + "description": "Status of the Azure async operation.", + "enum": [ + "InProgress", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "NetworkOperationStatus", + "modelAsString": true + } + }, + "error": { + "$ref": "#/definitions/Error", + "description": "Details of the error occurred during specified asynchronous operation." + } + }, + "description": "The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is in progress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure." + }, + "Resource": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + }, + "location": { + "type": "string", + "description": "Resource location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Common resource representation.", + "x-ms-azure-resource": true + }, + "ProxyResource": { + "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": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "description": "Proxy resource representation.", + "x-ms-azure-resource": true + }, + "SubResource": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + }, + "description": "Reference to another subresource.", + "x-ms-azure-resource": true + }, + "TagsObject": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "type": "string", + "description": "The type of identity that created the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)." + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "type": "string", + "description": "The type of identity that last modified the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The type of identity that last modified the resource." + } + } + }, + "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 virtual machine.", + "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 current provisioning state.", + "enum": [ + "Succeeded", + "Updating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "Access": { + "type": "string", + "description": "Access to be allowed or denied.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "Access", + "modelAsString": true + } + }, + "AuthenticationMethod": { + "type": "string", + "description": "VPN client authentication method.", + "enum": [ + "EAPTLS", + "EAPMSCHAPv2" + ], + "x-ms-enum": { + "name": "AuthenticationMethod", + "modelAsString": true + } + }, + "IPAllocationMethod": { + "type": "string", + "description": "IP address allocation method.", + "enum": [ + "Static", + "Dynamic" + ], + "x-ms-enum": { + "name": "IPAllocationMethod", + "modelAsString": true + } + }, + "IPVersion": { + "type": "string", + "description": "IP address version.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true + } + }, + "ExtendedLocationType": { + "type": "string", + "description": "The supported ExtendedLocation types. Currently only EdgeZone is supported in Microsoft.Network resources.", + "enum": [ + "EdgeZone" + ], + "x-ms-enum": { + "name": "ExtendedLocationTypes", + "modelAsString": true + } + }, + "ExtendedLocation": { + "description": "ExtendedLocation complex type.", + "properties": { + "name": { + "type": "string", + "description": "The name of the extended location." + }, + "type": { + "$ref": "#/definitions/ExtendedLocationType", + "description": "The type of the extended location." + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + }, + "ApiVersionVmssParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "2017-03-30" + ], + "x-ms-enum": { + "name": "ApiVersion", + "modelAsString": true + }, + "description": "Client API version." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/preview/2021-03-01-preview/networkSecurityPerimeter.json b/specification/network/resource-manager/Microsoft.Network/preview/2021-03-01-preview/networkSecurityPerimeter.json new file mode 100644 index 000000000000..995edc156847 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/preview/2021-03-01-preview/networkSecurityPerimeter.json @@ -0,0 +1,463 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkSecurityPerimeter", + "description": "The Network Security Perimeter API provides a RESTful set of web services that interact with network security perimeter resource.", + "version": "2021-03-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.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}": { + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkSecurityPerimeterNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "NetworkSecurityPerimeters" + ], + "operationId": "NetworkSecurityPerimeters_Get", + "description": "Gets the specified network security perimeter by the name.", + "responses": { + "200": { + "description": "Request is successful. Returns the resulting network security perimeter resource.", + "schema": { + "$ref": "#/definitions/NetworkSecurityPerimeter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkSecurityPerimeterGet": { + "$ref": "./examples/NetworkSecurityPerimeterGet.json" + } + } + }, + "put": { + "tags": [ + "NetworkSecurityPerimeters" + ], + "operationId": "NetworkSecurityPerimeters_CreateOrUpdate", + "description": "Creates or updates a Network Security Perimeter.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkSecurityPerimeter" + }, + "description": "Parameter supplied to create or update the network security perimeter." + } + ], + "responses": { + "200": { + "description": "Resource Updated. Returns the network security perimeter.", + "schema": { + "$ref": "#/definitions/NetworkSecurityPerimeter" + } + }, + "201": { + "description": "Resource Created. Returns the network security perimeter.", + "schema": { + "$ref": "#/definitions/NetworkSecurityPerimeter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Put Network Security Perimeter": { + "$ref": "./examples/NetworkSecurityPerimeterPut.json" + } + } + }, + "delete": { + "tags": [ + "NetworkSecurityPerimeters" + ], + "operationId": "NetworkSecurityPerimeters_Delete", + "description": "Deletes a network security perimeter.", + "responses": { + "200": { + "description": "Delete Succeed." + }, + "204": { + "description": "Request successful. The resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkSecurityPerimeterDelete": { + "$ref": "./examples/NetworkSecurityPerimeterDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkSecurityPerimeters": { + "get": { + "tags": [ + "NetworkSecurityPerimeters" + ], + "operationId": "NetworkSecurityPerimeters_ListBySubscription", + "description": "List all network security perimeters in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. Returns the list of the network security perimeters.", + "schema": { + "$ref": "#/definitions/NetworkSecurityPerimeterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "NetworkSecurityPerimetersList": { + "$ref": "./examples/NetworkSecurityPerimeterListAll.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters": { + "get": { + "tags": [ + "NetworkSecurityPerimeters" + ], + "operationId": "NetworkSecurityPerimeters_List", + "description": "List network security perimeters in a resource group.", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. Returns a list of network security perimeters.", + "schema": { + "$ref": "#/definitions/NetworkSecurityPerimeterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Network Security Perimeter": { + "$ref": "./examples/NetworkSecurityPerimeterList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/perimeterAssociableResourceTypes": { + "get": { + "operationId": "PerimeterAssociableResourceTypes_Get", + "description": "Gets the list of resources that are onboarded with NSP. These resources can be associated with a network security perimeter", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the where the association is present." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the list of resources that are onboarded with network security perimeter feature.", + "schema": { + "$ref": "#/definitions/PerimeterAssociableResourcesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Check Dns Name Availability": { + "$ref": "./examples/PerimeterAssociableResourcesList.json" + } + } + } + } + }, + "definitions": { + "NetworkSecurityPerimeter": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkSecurityPerimeterProperties", + "description": "The network security perimeter properties" + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "Network security perimeter identifier." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "The Network Security Perimeter resource" + }, + "NetworkSecurityPerimeterListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityPerimeter" + }, + "description": "Gets a page of NetworkSecurityPerimeter" + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next page of results." + } + }, + "description": "Result of the request to list NetworkSecurityPerimeter. It contains a list of network security perimeters and a URL link to get the next set of results." + }, + "NetworkSecurityPerimeterProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "A friendly name for the network security perimeter." + }, + "description": { + "type": "string", + "description": "A description of the network security perimeter." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the scope assignment resource." + } + }, + "description": "Properties of network security perimeter." + }, + "PerimeterAssociableResource": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PerimeterAssociableResourceProperties", + "description": "Properties of the perimeter associable resource." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "Identifier of the perimeter associable resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Resource that is onboarded to use network security perimeter. Also referred as perimeter associable resource." + }, + "PerimeterAssociableResourcesListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PerimeterAssociableResource" + }, + "description": "Gets paged list of perimeter associable resources." + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next page of results." + } + }, + "description": "Paged list of perimeter associable resources." + }, + "PerimeterAssociableResourceProperties": { + "type": "object", + "properties": { + "displayName": { + "readOnly": true, + "type": "string", + "description": "A friendly name for the properties of perimeter associable resources." + }, + "resourceType": { + "readOnly": true, + "type": "string", + "description": "Resource type/provider name." + }, + "publicDnsZones": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "Public DNS zone names of the resources." + } + }, + "description": "Properties of the perimeter associable resources." + } + }, + "parameters": { + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "NetworkSecurityPerimeterNameParameter": { + "name": "networkSecurityPerimeterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security perimeter.", + "x-ms-parameter-location": "method" + }, + "ListTopParameter": { + "name": "$top", + "description": "An optional query parameter which specifies the maximum number of records to be returned by the server.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 20, + "x-ms-parameter-location": "method" + }, + "ListSkipTokenParameter": { + "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", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/network/resource-manager/readme.md b/specification/network/resource-manager/readme.md index fbe2820005b1..b1f18785f0ef 100644 --- a/specification/network/resource-manager/readme.md +++ b/specification/network/resource-manager/readme.md @@ -213,6 +213,65 @@ input-file: - Microsoft.Network/stable/2020-11-01/webapplicationfirewall.json ``` +### Tag: package-2021-03-preview + +These settings apply only when `--tag=2021-03-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2021-03-preview' +input-file: + - Microsoft.Network/stable/2021-02-01/applicationGateway.json + - Microsoft.Network/stable/2021-02-01/applicationSecurityGroup.json + - Microsoft.Network/stable/2021-02-01/availableDelegations.json + - Microsoft.Network/stable/2021-02-01/availableServiceAliases.json + - Microsoft.Network/stable/2021-02-01/azureFirewall.json + - Microsoft.Network/stable/2021-02-01/azureFirewallFqdnTag.json + - Microsoft.Network/stable/2021-02-01/azureWebCategory.json + - Microsoft.Network/stable/2021-02-01/bastionHost.json + - Microsoft.Network/stable/2021-02-01/checkDnsAvailability.json + - Microsoft.Network/stable/2021-02-01/cloudServiceNetworkInterface.json + - Microsoft.Network/stable/2021-02-01/cloudServicePublicIpAddress.json + - Microsoft.Network/stable/2021-02-01/customIpPrefix.json + - Microsoft.Network/stable/2021-02-01/ddosCustomPolicy.json + - Microsoft.Network/stable/2021-02-01/ddosProtectionPlan.json + - Microsoft.Network/stable/2021-02-01/dscpConfiguration.json + - Microsoft.Network/stable/2021-02-01/endpointService.json + - Microsoft.Network/stable/2021-02-01/expressRouteCircuit.json + - Microsoft.Network/stable/2021-02-01/expressRouteCrossConnection.json + - Microsoft.Network/stable/2021-02-01/expressRoutePort.json + - Microsoft.Network/stable/2021-02-01/firewallPolicy.json + - Microsoft.Network/stable/2021-02-01/ipAllocation.json + - Microsoft.Network/stable/2021-02-01/ipGroups.json + - Microsoft.Network/stable/2021-02-01/loadBalancer.json + - Microsoft.Network/stable/2021-02-01/natGateway.json + - Microsoft.Network/preview/2021-03-01-preview/network.json + - Microsoft.Network/stable/2021-02-01/networkInterface.json + - Microsoft.Network/preview/2021-03-01-preview/networkSecurityPerimeter.json + - Microsoft.Network/stable/2021-02-01/networkProfile.json + - Microsoft.Network/stable/2021-02-01/networkSecurityGroup.json + - Microsoft.Network/stable/2021-02-01/networkVirtualAppliance.json + - Microsoft.Network/stable/2021-02-01/networkWatcher.json + - Microsoft.Network/stable/2021-02-01/operation.json + - Microsoft.Network/stable/2021-02-01/privateEndpoint.json + - Microsoft.Network/stable/2021-02-01/privateLinkService.json + - Microsoft.Network/stable/2021-02-01/publicIpAddress.json + - Microsoft.Network/stable/2021-02-01/publicIpPrefix.json + - Microsoft.Network/stable/2021-02-01/routeFilter.json + - Microsoft.Network/stable/2021-02-01/routeTable.json + - Microsoft.Network/stable/2021-02-01/securityPartnerProvider.json + - Microsoft.Network/stable/2021-02-01/serviceCommunity.json + - Microsoft.Network/stable/2021-02-01/serviceEndpointPolicy.json + - Microsoft.Network/stable/2021-02-01/serviceTags.json + - Microsoft.Network/stable/2021-02-01/usage.json + - Microsoft.Network/stable/2021-02-01/virtualNetwork.json + - Microsoft.Network/stable/2021-02-01/virtualNetworkGateway.json + - Microsoft.Network/stable/2021-02-01/virtualNetworkTap.json + - Microsoft.Network/stable/2021-02-01/virtualRouter.json + - Microsoft.Network/stable/2021-02-01/virtualWan.json + - Microsoft.Network/stable/2021-02-01/vmssNetworkInterface.json + - Microsoft.Network/stable/2021-02-01/vmssPublicIpAddress.json + - Microsoft.Network/stable/2021-02-01/webapplicationfirewall.json +``` + ### Tag: package-2020-08 These settings apply only when `--tag=package-2020-08` is specified on the command line. diff --git a/specification/network/resource-manager/readme.python.md b/specification/network/resource-manager/readme.python.md index 27f6761268d7..ed852eea9218 100644 --- a/specification/network/resource-manager/readme.python.md +++ b/specification/network/resource-manager/readme.python.md @@ -7,6 +7,7 @@ azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-network no-namespace-folders: true +package-version: 1.0.0b1 ``` ### Python multi-api diff --git a/specification/network/resource-manager/readme.typescript.md b/specification/network/resource-manager/readme.typescript.md index 10682e7ff19d..a3ceb115cdea 100644 --- a/specification/network/resource-manager/readme.typescript.md +++ b/specification/network/resource-manager/readme.typescript.md @@ -11,7 +11,7 @@ typescript: generate-metadata: true ``` -``` yaml $(typescript) && !$(profile) +``` yaml $(typescript) && !$(profile-content) typescript: package-name: "@azure/arm-network" output-folder: "$(typescript-sdks-folder)/sdk/network/arm-network" @@ -20,9 +20,9 @@ typescript: ### Profile: profile-hybrid-2019-03-01 -These settings apply only when `--profile=profile-hybrid-2019-03-01` is specified on the command line. +These settings apply only when `--profile-content=profile-hybrid-2019-03-01` is specified on the command line. -``` yaml $(profile)=='profile-hybrid-2019-03-01' +``` yaml $(profile-content)=='profile-hybrid-2019-03-01' typescript: package-name: "@azure/arm-network-profile-2019-03-01-hybrid" output-folder: "$(typescript-sdks-folder)/sdk/network/arm-network-profile-2019-03-01-hybrid" @@ -33,9 +33,9 @@ typescript: ### Profile: profile-hybrid-2020-09-01 -These settings apply only when `--profile=profile-hybrid-2020-09-01` is specified on the command line. +These settings apply only when `--profile-content=profile-hybrid-2020-09-01` is specified on the command line. -``` yaml $(profile)=='profile-hybrid-2020-09-01' +``` yaml $(profile-content)=='profile-hybrid-2020-09-01' typescript: package-name: "@azure/arm-network-profile-2020-09-01-hybrid" output-folder: "$(typescript-sdks-folder)/sdk/network/arm-network-profile-2020-09-01-hybrid" diff --git a/specification/notificationhubs/resource-manager/readme.md b/specification/notificationhubs/resource-manager/readme.md index 8ab47c141fbe..82e278e1d719 100644 --- a/specification/notificationhubs/resource-manager/readme.md +++ b/specification/notificationhubs/resource-manager/readme.md @@ -85,7 +85,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js @@ -114,45 +114,7 @@ csharp: ## Python -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.notificationhubs - package-name: azure-mgmt-notificationhubs - clear-output-folder: true -``` - -``` yaml $(python) && $(track2) -python-mode: create -azure-arm: true -license-header: MICROSOFT_MIT_NO_VERSION -namespace: azure.mgmt.notificationhubs -package-name: azure-mgmt-notificationhubs -package-version: 7.0.0b1 -clear-output-folder: true -``` - -``` yaml $(python) && $(python-mode) == 'update' -no-namespace-folders: true -output-folder: $(python-sdks-folder)/notificationhubs/azure-mgmt-notificationhubs/azure/mgmt/notificationhubs -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/notificationhubs/azure-mgmt-notificationhubs/azure/mgmt/notificationhubs -``` -``` yaml $(python) && $(python-mode) == 'create' -basic-setup-py: true -output-folder: $(python-sdks-folder)/notificationhubs/azure-mgmt-notificationhubs -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/notificationhubs/azure-mgmt-notificationhubs -``` +See configuration in [readme.python.md](./readme.python.md) ## Go diff --git a/specification/notificationhubs/resource-manager/readme.python.md b/specification/notificationhubs/resource-manager/readme.python.md new file mode 100644 index 000000000000..7eba098121ac --- /dev/null +++ b/specification/notificationhubs/resource-manager/readme.python.md @@ -0,0 +1,24 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + + +``` yaml $(python) && $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +namespace: azure.mgmt.notificationhubs +package-name: azure-mgmt-notificationhubs +package-version: 7.0.0b1 +clear-output-folder: true +``` + +``` yaml $(python) && $(python-mode) == 'update' && $(track2) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/notificationhubs/azure-mgmt-notificationhubs/azure/mgmt/notificationhubs +``` +``` yaml $(python) && $(python-mode) == 'create' && $(track2) +basic-setup-py: true +output-folder: $(python-sdks-folder)/notificationhubs/azure-mgmt-notificationhubs +``` \ No newline at end of file diff --git a/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2021-05-19_Preview/OperationalInsights.json b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2021-05-19_Preview/OperationalInsights.json new file mode 100644 index 000000000000..ce0df645a5bb --- /dev/null +++ b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2021-05-19_Preview/OperationalInsights.json @@ -0,0 +1,1436 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-05-19_Preview", + "title": "Azure Log Analytics", + "description": "This API exposes Azure Log Analytics query capabilities", + "termsOfService": "https://dev.loganalytics.io/tos", + "contact": { + "name": "AIAPI Team", + "url": "https://dev.loganalytics.io/support", + "email": "aiapi@microsoft.com" + }, + "license": { + "name": "Microsoft", + "url": "https://dev.loganalytics.io/license" + } + }, + "host": "api.loganalytics.io", + "basePath": "/v1", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "oauth2": { + "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" + } + } + }, + "security": [ + { + "oauth2": [ + "user_impersonation" + ] + } + ], + "paths": { + "/workspaces/{workspaceId}/query": { + "get": { + "operationId": "Query_Get", + "summary": "Execute an Analytics query", + "description": "Executes an Analytics query for data", + "x-ms-examples": { + "simple-query": { + "$ref": "examples/oms-get-example.json" + }, + "cross-workspace": { + "$ref": "examples/oms-get-cross-workspace-example.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/workspaceId" + }, + { + "$ref": "#/parameters/queryParam" + }, + { + "$ref": "#/parameters/timespanParam" + } + ], + "responses": { + "200": { + "description": "OK. The API call succeeded and the Analytics query result is in the response payload", + "schema": { + "$ref": "#/definitions/queryResults" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + } + }, + "post": { + "operationId": "Query_Execute", + "summary": "Execute an Analytics query", + "description": "Executes an Analytics query for data. [Here](https://dev.loganalytics.io/documentation/Using-the-API) is an example for using POST with an Analytics query.", + "x-ms-examples": { + "simple-query": { + "$ref": "examples/oms-post-example.json" + }, + "cross-workspace": { + "$ref": "examples/oms-post-cross-workspace-example.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/workspaceId" + }, + { + "$ref": "#/parameters/queryBody" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + } + ], + "responses": { + "200": { + "description": "OK. The API call succeeded and the Analytics query result is in the response payload", + "schema": { + "$ref": "#/definitions/queryResults" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + } + } + }, + "/workspaces/{workspaceId}/metadata": { + "get": { + "operationId": "Metadata_Get", + "summary": "Gets metadata information", + "description": "Retrieve the metadata information for the workspace, including its schema, functions, workspace info, categories etc.", + "x-ms-examples": { + "metadataGet": { + "$ref": "examples/metadata-get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/workspaceId" + } + ], + "responses": { + "200": { + "description": "OK. The API call succeeded and the metadata result is in the response payload", + "schema": { + "$ref": "#/definitions/metadataResults" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + } + }, + "post": { + "operationId": "Metadata_Post", + "summary": "Gets metadata information", + "description": "Retrieve the metadata information for the workspace, including its schema, functions, workspace info, categories etc.", + "x-ms-examples": { + "metadataPost": { + "$ref": "examples/metadata-post.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/workspaceId" + } + ], + "responses": { + "200": { + "description": "OK. The API call succeeded and the metadata result is in the response payload", + "schema": { + "$ref": "#/definitions/metadataResults" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + } + } + }, + "/$batch": { + "post": { + "operationId": "Query_Batch", + "summary": "Execute a batch of Analytics queries", + "description": "Executes a batch of Analytics queries for data. [Here](https://dev.loganalytics.io/documentation/Using-the-API) is an example for using POST with an Analytics query.", + "x-ms-examples": { + "metadataPost": { + "$ref": "examples/batch-query-example.json" + } + }, + "parameters": [ + { + "name": "body", + "in": "body", + "description": "The batch request body", + "required": true, + "schema": { + "type": "object", + "$ref": "#/definitions/batchRequest" + } + } + ], + "responses": { + "200": { + "description": "OK. The API call succeeded and the Analytics query result is in the response payload", + "schema": { + "$ref": "#/definitions/batchResponse" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + } + } + } + }, + "parameters": { + "workspaceId": { + "name": "workspaceId", + "description": "ID of the workspace. This is Workspace ID from the Properties blade in the Azure portal.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "workspacesParam": { + "name": "workspaces", + "description": "Comma separated workspace IDs to include in cross-workspace queries.", + "in": "query", + "collectionFormat": "csv", + "required": false, + "default": "", + "type": "string", + "x-ms-parameter-location": "method" + }, + "queryParam": { + "name": "query", + "in": "query", + "required": true, + "x-ms-parameter-location": "method", + "description": "The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)", + "type": "string" + }, + "queryBody": { + "name": "body", + "in": "body", + "description": "The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)", + "required": true, + "schema": { + "$ref": "#/definitions/queryBody" + }, + "x-ms-parameter-location": "method" + }, + "timespanParam": { + "name": "timespan", + "in": "query", + "required": false, + "format": "duration", + "x-ms-parameter-location": "method", + "description": "Optional. The timespan over which to query data. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the query expression.", + "type": "string" + }, + "PreferHeaderParameter": { + "name": "Prefer", + "in": "header", + "required": false, + "type": "string", + "description": "Optional. The prefer header to set server timeout, query statistics and visualization information.", + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "queryParam": { + "description": "The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)", + "type": "string" + }, + "timespanParam": { + "description": "Optional. The timespan over which to query data. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the query expression.", + "type": "string" + }, + "workspacesParam": { + "description": "Workspace names to include in cross-workspace queries.", + "type": "array", + "items": { + "type": "string" + } + }, + "queryBody": { + "description": "The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)", + "type": "object", + "properties": { + "query": { + "description": "The query to execute.", + "$ref": "#/definitions/queryParam" + }, + "timespan": { + "description": "Optional. The timespan over which to query data. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the query expression.", + "$ref": "#/definitions/timespanParam" + }, + "workspaces": { + "description": "A list of workspaces that are included in the query.", + "$ref": "#/definitions/workspacesParam" + } + }, + "required": [ + "query" + ] + }, + "queryResults": { + "title": "A query response.", + "description": "Contains the tables, columns & rows resulting from a query.", + "type": "object", + "properties": { + "tables": { + "description": "The list of tables, columns and rows.", + "type": "array", + "items": { + "$ref": "#/definitions/table" + } + }, + "statistics": { + "type": "object", + "description": "Statistics represented in JSON format.", + "properties": {} + }, + "render": { + "type": "object", + "description": "Visualization data in JSON format.", + "properties": {} + }, + "error": { + "$ref": "#/definitions/errorInfo" + } + }, + "required": [ + "tables" + ] + }, + "table": { + "title": "A query response table.", + "description": "Contains the columns and rows for one table in a query response.", + "type": "object", + "properties": { + "name": { + "description": "The name of the table.", + "type": "string" + }, + "columns": { + "description": "The list of columns in this table.", + "type": "array", + "items": { + "$ref": "#/definitions/column" + } + }, + "rows": { + "description": "The resulting rows from this query.", + "type": "array", + "items": { + "type": "array", + "items": { + "type": "object" + } + } + } + }, + "required": [ + "name", + "columns", + "rows" + ] + }, + "column": { + "title": "A table column.", + "description": "A column in a table.", + "type": "object", + "properties": { + "name": { + "description": "The name of this column.", + "type": "string" + }, + "type": { + "description": "The data type of this column.", + "$ref": "#/definitions/logsColumnType" + } + } + }, + "logsColumnType": { + "type": "string", + "description": "The data type of this column.", + "enum": [ + "bool", + "datetime", + "dynamic", + "int", + "long", + "real", + "string", + "guid", + "decimal", + "timespan" + ], + "x-ms-enum": { + "name": "logsColumnType", + "modelAsString": true + } + }, + "metadataResults": { + "title": "A metadata response.", + "description": "The metadata response for the app, including available tables, etc.", + "type": "object", + "properties": { + "categories": { + "description": "The list of categories that are referenced in this metadata response.", + "type": "array", + "items": { + "$ref": "#/definitions/metadataCategory" + }, + "uniqueItems": true + }, + "resourceTypes": { + "description": "The list of resource types that are referenced in this metadata response.", + "type": "array", + "items": { + "$ref": "#/definitions/metadataResourceType" + }, + "uniqueItems": true + }, + "solutions": { + "description": "The list of Log Analytics solutions installed on the workspace.", + "type": "array", + "items": { + "$ref": "#/definitions/metadataSolution" + }, + "uniqueItems": true + }, + "tables": { + "description": "The list of tables and columns that comprise the schema of the workspace.", + "type": "array", + "items": { + "$ref": "#/definitions/metadataTable" + }, + "uniqueItems": true + }, + "functions": { + "description": "The list of functions stored on the workspace, or introduced by solutions etc.", + "type": "array", + "items": { + "$ref": "#/definitions/metadataFunction" + }, + "uniqueItems": true + }, + "queries": { + "description": "The list of saved queries stored on the workspace, or introduced by solutions, resource types, etc.", + "type": "array", + "items": { + "$ref": "#/definitions/metadataQuery" + }, + "uniqueItems": true + }, + "applications": { + "description": "The list of Application Insights apps that were referenced in the metadata request.", + "type": "array", + "items": { + "$ref": "#/definitions/metadataApplication" + }, + "uniqueItems": true + }, + "workspaces": { + "description": "The list of Log Analytics workspaces that were referenced in the metadata request.", + "type": "array", + "items": { + "$ref": "#/definitions/metadataWorkspace" + }, + "uniqueItems": true + }, + "resources": { + "description": "The list of Azure resources that were referenced in the metadata request.", + "type": "array", + "items": { + "$ref": "#/definitions/metadataResource" + }, + "uniqueItems": true + }, + "permissions": { + "description": "The list of permission rules that affected the metadata request.", + "type": "array", + "items": { + "$ref": "#/definitions/metadataPermissions" + }, + "uniqueItems": true + } + } + }, + "metadataCategory": { + "title": "A metadata category.", + "description": "Categories are used to group other metadata entities.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the category", + "type": "string" + }, + "displayName": { + "description": "The display name of the category", + "type": "string" + }, + "description": { + "description": "The description of the category", + "type": "string" + }, + "related": { + "description": "The related metadata items for the category", + "type": "object", + "properties": { + "tables": { + "description": "The tables related to the category", + "type": "array", + "items": { + "type": "string" + } + }, + "functions": { + "description": "The functions related to the category", + "type": "array", + "items": { + "type": "string" + } + }, + "resourceTypes": { + "description": "The resource types related to the category", + "type": "array", + "items": { + "type": "string" + } + }, + "queries": { + "description": "The saved queries related to the category", + "type": "array", + "items": { + "type": "string" + } + }, + "solutions": { + "description": "The Log Analytics solutions related to the category", + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "required": [ + "id", + "displayName" + ] + }, + "metadataSolution": { + "title": "A Log Analytics solution.", + "description": "Solutions can group tables and functions that are associated with a certain Azure Log Analytics offering.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the Log Analytics solution", + "type": "string" + }, + "name": { + "description": "The name of the Log Analytics solution", + "type": "string" + }, + "displayName": { + "description": "The display name of the Log Analytics solution", + "type": "string" + }, + "description": { + "description": "The description of the Log Analytics solution", + "type": "string" + }, + "tags": { + "description": "The tags that are associated with the Log Analytics solution", + "$ref": "#/definitions/tags" + }, + "properties": { + "description": "The properties of the Log Analytics solution", + "type": "object" + }, + "related": { + "description": "The related metadata items for the Log Analytics solution", + "type": "object", + "properties": { + "tables": { + "description": "The tables related to the Log Analytics solution", + "type": "array", + "items": { + "type": "string" + } + }, + "functions": { + "description": "The functions related to the Log Analytics solution", + "type": "array", + "items": { + "type": "string" + } + }, + "categories": { + "description": "The categories related to the Log Analytics solution", + "type": "array", + "items": { + "type": "string" + } + }, + "queries": { + "description": "The saved queries related to the Log Analytics solution", + "type": "array", + "items": { + "type": "string" + } + }, + "workspaces": { + "description": "The Workspaces referenced in the metadata request that are related to the Log Analytics solution", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "tables" + ] + } + }, + "required": [ + "id", + "name", + "related" + ] + }, + "metadataResourceType": { + "title": "A type of resource in Azure.", + "description": "Metadata about types of Azure resources, containing relevant tables, functions, etc.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the resource-type", + "type": "string" + }, + "type": { + "description": "The type of the resource-type", + "type": "string" + }, + "displayName": { + "description": "The display name of the resource-type", + "type": "string" + }, + "description": { + "description": "The description of the resource-type", + "type": "string" + }, + "labels": { + "description": "The user-defined labels of the resource-type", + "type": "array", + "items": { + "type": "string" + } + }, + "tags": { + "description": "The tags associated with the resource-type", + "$ref": "#/definitions/tags" + }, + "properties": { + "description": "The properties of the resource-type", + "type": "object" + }, + "related": { + "description": "The related metadata items for the resource-type", + "type": "object", + "properties": { + "tables": { + "description": "The tables related to the resource-type", + "type": "array", + "items": { + "type": "string" + } + }, + "functions": { + "description": "The functions related to the resource-type", + "type": "array", + "items": { + "type": "string" + } + }, + "categories": { + "description": "The categories related to the resource-type", + "type": "array", + "items": { + "type": "string" + } + }, + "queries": { + "description": "The queries related to the resource-type", + "type": "array", + "items": { + "type": "string" + } + }, + "workspaces": { + "description": "The Log Analytics workspaces related to the resource-type", + "type": "array", + "items": { + "type": "string" + } + }, + "resources": { + "description": "The Azure resources related to the resource-type", + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "required": [ + "id", + "type" + ] + }, + "metadataTable": { + "title": "A data table that takes part in a workspace schema.", + "description": "Tables are part of the workspace schema, and contain a list of columns and a reference to other relevant metadata items.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the table", + "type": "string" + }, + "name": { + "description": "The name of the table", + "type": "string" + }, + "description": { + "description": "The description of the table", + "type": "string" + }, + "timespanColumn": { + "description": "The column associated with the timespan query parameter for the table", + "type": "string" + }, + "labels": { + "description": "The user defined labels of the table", + "type": "array", + "items": { + "type": "string" + } + }, + "tags": { + "description": "The tags associated with the table", + "$ref": "#/definitions/tags" + }, + "properties": { + "description": "The properties of the table", + "type": "object" + }, + "columns": { + "description": "The list of columns defined on the table", + "type": "array", + "items": { + "properties": { + "name": { + "description": "The name of the column", + "type": "string" + }, + "description": { + "description": "The description of the column", + "type": "string" + }, + "type": { + "description": "The data type of the column", + "type": "string", + "enum": [ + "bool", + "datetime", + "dynamic", + "int", + "long", + "real", + "string", + "guid", + "decimal", + "timespan" + ], + "x-ms-enum": { + "name": "MetadataColumnDataType", + "modelAsString": true + } + }, + "isPreferredFacet": { + "description": "A flag indicating this column is a preferred facet", + "type": "boolean" + }, + "source": { + "description": "an indication of the source of the column, used only when multiple workspaces have conflicting definition for the column", + "type": "object" + } + }, + "required": [ + "name", + "type" + ] + } + }, + "related": { + "description": "The related metadata items for the table", + "type": "object", + "properties": { + "categories": { + "description": "The related categories for the table", + "type": "array", + "items": { + "type": "string" + } + }, + "solutions": { + "description": "The related Log Analytics solutions for the table", + "type": "array", + "items": { + "type": "string" + } + }, + "resourceTypes": { + "description": "The related resource types for the table", + "type": "array", + "items": { + "type": "string" + } + }, + "workspaces": { + "description": "The related Log Analytics workspaces for the table", + "type": "array", + "items": { + "type": "string" + } + }, + "functions": { + "description": "The related functions for the table", + "type": "array", + "items": { + "type": "string" + } + }, + "queries": { + "description": "The related saved queries for the table", + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "required": [ + "id", + "name" + ] + }, + "metadataFunction": { + "title": "A stored function.", + "description": "Functions are stored Kusto queries that can be specified as part of queries by using their name.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the function.", + "type": "string" + }, + "name": { + "description": "The name of the function, to be used in queries.", + "type": "string" + }, + "parameters": { + "description": "The parameters/arguments of the function, if any.", + "type": "string" + }, + "displayName": { + "description": "The display name of the function.", + "type": "string" + }, + "description": { + "description": "The description of the function.", + "type": "string" + }, + "body": { + "description": "The KQL body of the function.", + "type": "string" + }, + "tags": { + "description": "The tags associated with the function.", + "$ref": "#/definitions/tags" + }, + "properties": { + "description": "The properties of the function.", + "type": "object" + }, + "related": { + "description": "The related metadata items for the function.", + "type": "object", + "properties": { + "tables": { + "description": "The related tables for the function.", + "type": "array", + "items": { + "type": "string" + } + }, + "solutions": { + "description": "The related Log Analytics solutions for the function.", + "type": "array", + "items": { + "type": "string" + } + }, + "resourceTypes": { + "description": "The related resource types for the function.", + "type": "array", + "items": { + "type": "string" + } + }, + "categories": { + "description": "The related categories for the function.", + "type": "array", + "items": { + "type": "string" + } + }, + "workspaces": { + "description": "The related workspaces for the function.", + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "required": [ + "id", + "name", + "body" + ] + }, + "metadataQuery": { + "title": "A stored query.", + "description": "Queries are stored pieces of KQL, along with a list of relevant metadata items.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the query.", + "type": "string" + }, + "displayName": { + "description": "The display name of the query.", + "type": "string" + }, + "description": { + "description": "The description of the query.", + "type": "string" + }, + "body": { + "description": "The KQL body of the query.", + "type": "string" + }, + "labels": { + "description": "The user defined labels associated with the query.", + "type": "array", + "items": { + "type": "string" + } + }, + "tags": { + "description": "The tags associated with the query.", + "$ref": "#/definitions/tags" + }, + "properties": { + "description": "The properties of the query.", + "type": "object" + }, + "related": { + "description": "The related metadata items for the query.", + "type": "object", + "properties": { + "categories": { + "description": "The related categories for the query.", + "type": "array", + "items": { + "type": "string" + } + }, + "solutions": { + "description": "The related Log Analytics solutions for the query.", + "type": "array", + "items": { + "type": "string" + } + }, + "resourceTypes": { + "description": "The related resource types for the query.", + "type": "array", + "items": { + "type": "string" + } + }, + "tables": { + "description": "The related tables for the query.", + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "required": [ + "id", + "body" + ] + }, + "metadataApplication": { + "title": "An Application Insights application.", + "description": "Application Insights apps that were part of the metadata request and that the user has access to.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the Application Insights app.", + "type": "string" + }, + "resourceId": { + "description": "The ARM resource ID of the Application Insights app.", + "type": "string" + }, + "name": { + "description": "The name of the Application Insights app.", + "type": "string" + }, + "region": { + "description": "The Azure region of the Application Insights app.", + "type": "string" + }, + "related": { + "description": "The related metadata items for the Application Insights app.", + "type": "object", + "properties": { + "tables": { + "description": "The related tables for the Application Insights app.", + "type": "array", + "items": { + "type": "string" + } + }, + "functions": { + "description": "The related functions for the Application Insights app.", + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "required": [ + "id", + "resourceId", + "name", + "region" + ] + }, + "metadataWorkspace": { + "title": "A Log Analytics workspace.", + "description": "Log Analytics workspaces that were part of the metadata request and that the user has access to.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the Log Analytics workspace.", + "type": "string" + }, + "resourceId": { + "description": "The ARM resource ID of the Log Analytics workspace.", + "type": "string" + }, + "name": { + "description": "The name of the Log Analytics workspace.", + "type": "string" + }, + "region": { + "description": "The Azure region of the Log Analytics workspace.", + "type": "string" + }, + "related": { + "description": "The related metadata items for the Log Analytics workspace.", + "type": "object", + "properties": { + "tables": { + "description": "The related tables for the Log Analytics workspace.", + "type": "array", + "items": { + "type": "string" + } + }, + "solutions": { + "description": "The related Log Analytics solutions for the Log Analytics workspace.", + "type": "array", + "items": { + "type": "string" + } + }, + "resourceTypes": { + "description": "The related resource types for the Log Analytics workspace.", + "type": "array", + "items": { + "type": "string" + } + }, + "functions": { + "description": "The related functions for the Log Analytics workspace.", + "type": "array", + "items": { + "type": "string" + } + }, + "resources": { + "description": "The related Azure resources for the Log Analytics workspace.", + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "required": [ + "id", + "resourceId", + "name", + "region" + ] + }, + "metadataResource": { + "title": "An Azure resource.", + "description": "Azure resources that were part of the metadata request and that the user has access to." + }, + "metadataPermissions": { + "title": "Permission information.", + "description": "Permission information for the metadata call, includes apps/workspaces/resource the user didn't have access to.", + "type": "object", + "properties": { + "workspaces": { + "description": "The permission indication for the workspaces on the metadata request.", + "type": "array", + "items": { + "type": "object", + "properties": { + "resourceId": { + "description": "The resource ID on the permission indication.", + "type": "string" + }, + "denyTables": { + "description": "The list of tables that were denied access for the resource ID.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "resourceId" + ] + } + }, + "resources": { + "description": "The permission indication for the Azure resources on the metadata request.", + "type": "array", + "items": { + "type": "object", + "properties": { + "resourceId": { + "description": "The resource ID on the permission indication.", + "type": "string" + }, + "denyTables": { + "description": "The list of tables that were denied access for the resource ID.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "resourceId" + ] + } + }, + "applications": { + "description": "The permission indication for the Application Insights apps on the metadata request.", + "type": "array", + "items": { + "type": "object", + "properties": { + "resourceId": { + "description": "The resource ID on the permission indication.", + "type": "string" + } + }, + "required": [ + "resourceId" + ] + } + } + }, + "required": [ + "workspaces" + ] + }, + "tags": { + "description": "String-based key-value tags", + "type": "object" + }, + "errorDetail": { + "title": "Error details.", + "type": "object", + "properties": { + "code": { + "description": "The error's code.", + "type": "string" + }, + "message": { + "description": "A human readable error message.", + "type": "string" + }, + "target": { + "description": "Indicates which property in the request is responsible for the error.", + "type": "string" + }, + "value": { + "description": "Indicates which value in 'target' is responsible for the error.", + "type": "string" + }, + "resources": { + "description": "Indicates resources which were responsible for the error.", + "type": "array", + "items": { + "type": "string" + } + }, + "additionalProperties": { + "description": "Additional properties that can be provided on the error details object", + "type": "object" + } + }, + "required": [ + "code", + "message" + ] + }, + "errorInfo": { + "title": "The code and message for an error.", + "type": "object", + "properties": { + "code": { + "description": "A machine readable error code.", + "type": "string" + }, + "message": { + "description": "A human readable error message.", + "type": "string" + }, + "details": { + "description": "error details.", + "type": "array", + "items": { + "$ref": "#/definitions/errorDetail" + } + }, + "innererror": { + "description": "Inner error details if they exist.", + "$ref": "#/definitions/errorInfo" + }, + "additionalProperties": { + "description": "Additional properties that can be provided on the error info object", + "type": "object" + } + }, + "required": [ + "code", + "message" + ] + }, + "errorResponse": { + "title": "Error details.", + "description": "Contains details when the response code indicates an error.", + "type": "object", + "properties": { + "error": { + "description": "The error details.", + "$ref": "#/definitions/errorInfo" + } + }, + "required": [ + "error" + ] + }, + "batchRequest": { + "type": "object", + "description": "An array of requests.", + "properties": { + "requests": { + "type": "array", + "description": "An single request in a batch.", + "items": { + "$ref": "#/definitions/batchQueryRequest" + } + } + }, + "required": [ + "requests" + ] + }, + "batchQueryRequest": { + "type": "object", + "description": "An single request in a batch.", + "properties": { + "id": { + "description": "The error details.", + "type": "string" + }, + "headers": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "body": { + "$ref": "#/definitions/queryBody" + }, + "path": { + "type": "string", + "enum": [ + "/query" + ] + }, + "method": { + "type": "string", + "enum": [ + "POST" + ] + }, + "workspace": { + "description": "Workspace Id to be included in the query", + "type": "string" + } + }, + "required": [ + "workspace", + "body", + "id" + ] + }, + "batchResponse": { + "type": "object", + "description": "Response to a batch query.", + "properties": { + "responses": { + "type": "array", + "description": "An array of responses corresponding to each individual request in a batch.", + "items": { + "$ref": "#/definitions/batchQueryResponse" + } + } + } + }, + "batchQueryResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "status": { + "type": "integer" + }, + "body": { + "type": "object", + "$ref": "#/definitions/batchQueryResults" + }, + "headers": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "batchQueryResults": { + "title": "A query response for a single query in a batch.", + "description": "Contains the tables, columns & rows resulting from a query.", + "type": "object", + "properties": { + "tables": { + "description": "The list of tables, columns and rows.", + "type": "array", + "items": { + "$ref": "#/definitions/table" + } + }, + "statistics": { + "type": "object", + "description": "Statistics represented in JSON format.", + "properties": {} + }, + "render": { + "type": "object", + "description": "Visualization data in JSON format.", + "properties": {} + }, + "error": { + "$ref": "#/definitions/errorInfo" + } + } + } + } +} diff --git a/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2021-05-19_Preview/examples/batch-query-example.json b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2021-05-19_Preview/examples/batch-query-example.json new file mode 100644 index 000000000000..d99beca7ea36 --- /dev/null +++ b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2021-05-19_Preview/examples/batch-query-example.json @@ -0,0 +1,609 @@ +{ + "title": "Batch Query", + "description": "A batch query that returns query results.", + "parameters": { + "body": { + "requests": [ + { + "id": "1", + "body": { + "query": "AppRequests | take 2" + }, + "path": "/query", + "method": "POST", + "workspace": "d2d0e126-fa1e-4b0a-b647-250cdd471e68" + }, + { + "id": "2", + "body": { + "query": "AppRequests | take 3" + }, + "path": "/query", + "method": "POST", + "workspace": "d2d0e126-fa1e-4b0a-b647-250cdd471e68" + } + ] + } + }, + "responses": { + "200": { + "body": { + "responses": [ + { + "id": "1", + "status": 200, + "body": { + "tables": [ + { + "name": "PrimaryResult", + "columns": [ + { + "name": "TenantId", + "type": "string" + }, + { + "name": "TimeGenerated", + "type": "datetime" + }, + { + "name": "Id", + "type": "string" + }, + { + "name": "Source", + "type": "string" + }, + { + "name": "Name", + "type": "string" + }, + { + "name": "Url", + "type": "string" + }, + { + "name": "Success", + "type": "bool" + }, + { + "name": "ResultCode", + "type": "string" + }, + { + "name": "DurationMs", + "type": "real" + }, + { + "name": "PerformanceBucket", + "type": "string" + }, + { + "name": "Properties", + "type": "dynamic" + }, + { + "name": "Measurements", + "type": "dynamic" + }, + { + "name": "OperationName", + "type": "string" + }, + { + "name": "OperationId", + "type": "string" + }, + { + "name": "OperationLinks", + "type": "dynamic" + }, + { + "name": "ParentId", + "type": "string" + }, + { + "name": "SyntheticSource", + "type": "string" + }, + { + "name": "SessionId", + "type": "string" + }, + { + "name": "UserId", + "type": "string" + }, + { + "name": "UserAuthenticatedId", + "type": "string" + }, + { + "name": "UserAccountId", + "type": "string" + }, + { + "name": "AppVersion", + "type": "string" + }, + { + "name": "AppRoleName", + "type": "string" + }, + { + "name": "AppRoleInstance", + "type": "string" + }, + { + "name": "ClientType", + "type": "string" + }, + { + "name": "ClientModel", + "type": "string" + }, + { + "name": "ClientOS", + "type": "string" + }, + { + "name": "ClientIP", + "type": "string" + }, + { + "name": "ClientCity", + "type": "string" + }, + { + "name": "ClientStateOrProvince", + "type": "string" + }, + { + "name": "ClientCountryOrRegion", + "type": "string" + }, + { + "name": "ClientBrowser", + "type": "string" + }, + { + "name": "ResourceGUID", + "type": "string" + }, + { + "name": "IKey", + "type": "string" + }, + { + "name": "SDKVersion", + "type": "string" + }, + { + "name": "ItemCount", + "type": "int" + }, + { + "name": "ReferencedItemId", + "type": "string" + }, + { + "name": "ReferencedType", + "type": "string" + }, + { + "name": "SourceSystem", + "type": "string" + }, + { + "name": "Type", + "type": "string" + }, + { + "name": "_ResourceId", + "type": "string" + } + ], + "rows": [ + [ + "d2d0e126-fa1e-4b0a-b647-250cdd471e68", + "2021-06-02T00:18:13.317Z", + "a3273b160f86b5c4", + "", + "ServiceBus.process", + "", + true, + "200", + 0, + "<250ms", + "{\"x-opt-enqueued-time\":\"1622593091\"}", + null, + "ServiceBus.process", + "e5d21caf619d4ef564a4b5920cadce47", + null, + "c6864f9d3649f302", + "", + "", + "", + "", + "", + "", + "", + "srikanta", + "PC", + "", + "", + "0.0.0.0", + "Edmonds", + "Washington", + "United States", + "", + "fc5f5a5d-d6d1-47f9-be1b-aa57185ec6be", + "b4f83947-968d-4e2f-82ad-804be07697ae", + "java:3.1.1-BETA.2", + 1, + "", + "", + "Azure", + "AppRequests", + "/subscriptions/faa080af-c1d8-40ad-9cce-e1a450ca5b57/resourcegroups/srnagar-azuresdkgroup/providers/microsoft.insights/components/srnagarappinsights" + ], + [ + "d2d0e126-fa1e-4b0a-b647-250cdd471e68", + "2021-06-02T00:19:13.44Z", + "bebb49e7a1344c07", + "", + "ServiceBus.process", + "", + true, + "200", + 0, + "<250ms", + "{\"x-opt-enqueued-time\":\"1622593091\"}", + null, + "ServiceBus.process", + "d76c6dec50d2c12267d7d3a246a0c237", + null, + "b68fff4775c77214", + "", + "", + "", + "", + "", + "", + "", + "srikanta", + "PC", + "", + "", + "0.0.0.0", + "Edmonds", + "Washington", + "United States", + "", + "fc5f5a5d-d6d1-47f9-be1b-aa57185ec6be", + "b4f83947-968d-4e2f-82ad-804be07697ae", + "java:3.1.1-BETA.2", + 1, + "", + "", + "Azure", + "AppRequests", + "/subscriptions/faa080af-c1d8-40ad-9cce-e1a450ca5b57/resourcegroups/srnagar-azuresdkgroup/providers/microsoft.insights/components/srnagarappinsights" + ] + ] + } + ] + } + }, + { + "id": "2", + "status": 200, + "body": { + "tables": [ + { + "name": "PrimaryResult", + "columns": [ + { + "name": "TenantId", + "type": "string" + }, + { + "name": "TimeGenerated", + "type": "datetime" + }, + { + "name": "Id", + "type": "string" + }, + { + "name": "Source", + "type": "string" + }, + { + "name": "Name", + "type": "string" + }, + { + "name": "Url", + "type": "string" + }, + { + "name": "Success", + "type": "bool" + }, + { + "name": "ResultCode", + "type": "string" + }, + { + "name": "DurationMs", + "type": "real" + }, + { + "name": "PerformanceBucket", + "type": "string" + }, + { + "name": "Properties", + "type": "dynamic" + }, + { + "name": "Measurements", + "type": "dynamic" + }, + { + "name": "OperationName", + "type": "string" + }, + { + "name": "OperationId", + "type": "string" + }, + { + "name": "OperationLinks", + "type": "dynamic" + }, + { + "name": "ParentId", + "type": "string" + }, + { + "name": "SyntheticSource", + "type": "string" + }, + { + "name": "SessionId", + "type": "string" + }, + { + "name": "UserId", + "type": "string" + }, + { + "name": "UserAuthenticatedId", + "type": "string" + }, + { + "name": "UserAccountId", + "type": "string" + }, + { + "name": "AppVersion", + "type": "string" + }, + { + "name": "AppRoleName", + "type": "string" + }, + { + "name": "AppRoleInstance", + "type": "string" + }, + { + "name": "ClientType", + "type": "string" + }, + { + "name": "ClientModel", + "type": "string" + }, + { + "name": "ClientOS", + "type": "string" + }, + { + "name": "ClientIP", + "type": "string" + }, + { + "name": "ClientCity", + "type": "string" + }, + { + "name": "ClientStateOrProvince", + "type": "string" + }, + { + "name": "ClientCountryOrRegion", + "type": "string" + }, + { + "name": "ClientBrowser", + "type": "string" + }, + { + "name": "ResourceGUID", + "type": "string" + }, + { + "name": "IKey", + "type": "string" + }, + { + "name": "SDKVersion", + "type": "string" + }, + { + "name": "ItemCount", + "type": "int" + }, + { + "name": "ReferencedItemId", + "type": "string" + }, + { + "name": "ReferencedType", + "type": "string" + }, + { + "name": "SourceSystem", + "type": "string" + }, + { + "name": "Type", + "type": "string" + }, + { + "name": "_ResourceId", + "type": "string" + } + ], + "rows": [ + [ + "d2d0e126-fa1e-4b0a-b647-250cdd471e68", + "2021-06-02T16:31:25.383Z", + "08bf242cdc68504c", + "", + "ServiceBus.process", + "", + true, + "200", + 0, + "<250ms", + "{\"x-opt-enqueued-time\":\"1622651483\"}", + null, + "ServiceBus.process", + "65d9eb1ccf85b1b7ed1e2ea6bb72f563", + null, + "146140ce8493a6ed", + "", + "", + "", + "", + "", + "", + "", + "srikanta", + "PC", + "", + "", + "0.0.0.0", + "Edmonds", + "Washington", + "United States", + "", + "fc5f5a5d-d6d1-47f9-be1b-aa57185ec6be", + "b4f83947-968d-4e2f-82ad-804be07697ae", + "java:3.1.1-BETA.2", + 1, + "", + "", + "Azure", + "AppRequests", + "/subscriptions/faa080af-c1d8-40ad-9cce-e1a450ca5b57/resourcegroups/srnagar-azuresdkgroup/providers/microsoft.insights/components/srnagarappinsights" + ], + [ + "d2d0e126-fa1e-4b0a-b647-250cdd471e68", + "2021-06-02T16:32:25.492Z", + "9f4cd78c10d57b4f", + "", + "ServiceBus.process", + "", + true, + "200", + 0, + "<250ms", + "{\"x-opt-enqueued-time\":\"1622651483\"}", + null, + "ServiceBus.process", + "ae054fe7b7ac3adf8b841ebbe1ecb912", + null, + "14eab103a1969665", + "", + "", + "", + "", + "", + "", + "", + "srikanta", + "PC", + "", + "", + "0.0.0.0", + "Edmonds", + "Washington", + "United States", + "", + "fc5f5a5d-d6d1-47f9-be1b-aa57185ec6be", + "b4f83947-968d-4e2f-82ad-804be07697ae", + "java:3.1.1-BETA.2", + 1, + "", + "", + "Azure", + "AppRequests", + "/subscriptions/faa080af-c1d8-40ad-9cce-e1a450ca5b57/resourcegroups/srnagar-azuresdkgroup/providers/microsoft.insights/components/srnagarappinsights" + ], + [ + "d2d0e126-fa1e-4b0a-b647-250cdd471e68", + "2021-06-02T16:33:25.585Z", + "ea7e09d4baa4e4ce", + "", + "ServiceBus.process", + "", + true, + "200", + 0, + "<250ms", + "{\"x-opt-enqueued-time\":\"1622651483\"}", + null, + "ServiceBus.process", + "ba6162e3ccd803086944750b82600a3a", + null, + "b60455183860caaf", + "", + "", + "", + "", + "", + "", + "", + "srikanta", + "PC", + "", + "", + "0.0.0.0", + "Edmonds", + "Washington", + "United States", + "", + "fc5f5a5d-d6d1-47f9-be1b-aa57185ec6be", + "b4f83947-968d-4e2f-82ad-804be07697ae", + "java:3.1.1-BETA.2", + 1, + "", + "", + "Azure", + "AppRequests", + "/subscriptions/faa080af-c1d8-40ad-9cce-e1a450ca5b57/resourcegroups/srnagar-azuresdkgroup/providers/microsoft.insights/components/srnagarappinsights" + ] + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2021-05-19_Preview/examples/metadata-get.json b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2021-05-19_Preview/examples/metadata-get.json new file mode 100644 index 000000000000..a2c34fe519aa --- /dev/null +++ b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2021-05-19_Preview/examples/metadata-get.json @@ -0,0 +1,284 @@ +{ + "title": "Get Metadata", + "description": "A metadata request that returns the workspace schema and other information", + "parameters": { + "workspaceId": "b438b4f6-912a-46d5-9cb1-b44069212abc", + "apiVersion": "2018-04-20" + }, + "responses": { + "200": { + "body": { + "tables": [ + { + "id": "ADAssessmentRecommendation", + "name": "ADAssessmentRecommendation", + "description": "Recommendations generated by AD assessments that are started through a scheduled task. When you schedule the assessment it runs by default every 7 days and upload the data into Azure Log Analytics", + "timespanColumn": "TimeGenerated", + "columns": [ + { + "name": "SourceSystem", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "AssessmentId", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "RecommendationId", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "Recommendation", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "Description", + "type": "string" + }, + { + "name": "RecommendationResult", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "TimeGenerated", + "type": "datetime" + }, + { + "name": "FocusAreaId", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "FocusArea", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "ActionAreaId", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "ActionArea", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "RecommendationWeight", + "type": "real" + }, + { + "name": "Computer", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "AffectedObjectType", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "AffectedObjectName", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "Forest", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "Domain", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "DomainController", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "Technology", + "type": "string" + }, + { + "name": "CustomData", + "type": "string" + }, + { + "name": "TargetCount", + "type": "int" + }, + { + "name": "IsRollup", + "type": "bool", + "isPreferredFacet": true + }, + { + "name": "IsCopied", + "type": "bool", + "isPreferredFacet": true + }, + { + "name": "RecommendationPeriod", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "Type", + "type": "string" + }, + { + "name": "_ResourceId", + "type": "string" + } + ], + "related": { + "categories": [ + "workloads" + ], + "solutions": [ + "ADAssessment" + ], + "resourceTypes": [ + "microsoft.compute/virtualmachines" + ] + } + }, + { + "id": "custom_CL", + "name": "custom_CL", + "timespanColumn": "TimeGenerated", + "columns": [ + { + "name": "SourceSystem", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "ManagementGroupName", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "TimeGenerated", + "type": "datetime", + "isPreferredFacet": true + }, + { + "name": "Computer", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "RawData", + "type": "string" + }, + { + "name": "Type", + "type": "string" + }, + { + "name": "_ResourceId", + "type": "string" + } + ], + "related": { + "workspaces": [ + "b438b4f6-912a-46d5-9cb1-b44069212abc" + ] + } + } + ], + "solutions": [ + { + "id": "ADAssessment", + "name": "ADAssessment", + "displayName": "Active Directory Health Check", + "description": "Assess the risk and health of Active Directory environments.", + "related": { + "tables": [ + "ADAssessmentRecommendation" + ], + "functions": [ + "dwad" + ], + "workspaces": [ + "b438b4f6-912a-46d5-9cb1-b44069212abc" + ] + } + } + ], + "functions": [ + { + "id": "dwad", + "name": "dwad", + "displayName": "dasd", + "body": "Heartbeat\r\n| where ResourceGroup != \"rg-SAP-DEVQA-005\" and ResourceGroup != \"rg-SAP-DEVQA-006\" and Computer contains \"\"\r\n| limit 500000\r\n| sort by Computer asc\r\n| distinct Computer\r\n", + "related": { + "solutions": [ + "ADAssessment" + ], + "workspaces": [ + "b438b4f6-912a-46d5-9cb1-b44069212abc" + ] + } + } + ], + "resourceTypes": [ + { + "id": "microsoft.compute/virtualmachines", + "type": "Microsoft.Compute/VirtualMachines", + "displayName": "Virtual machines", + "related": { + "tables": [ + "ADAssessmentRecommendation" + ] + } + } + ], + "workspaces": [ + { + "id": "b438b4f6-912a-46d5-9cb1-b44069212abc", + "resourceId": "/subscriptions/e4272367-5645-4c4e-9c67-3b74b59a6982/resourceGroups/contosoazurehq/providers/microsoft.operationalinsights/workspaces/contosoretail-IT", + "name": "contosoretail-IT", + "region": "eastus", + "related": { + "resourceTypes": [ + "microsoft.compute/virtualmachines" + ], + "tables": [ + "custom_CL" + ], + "solutions": [ + "ADAssessment" + ], + "functions": [ + "dwad" + ] + } + } + ], + "categories": [ + { + "id": "workloads", + "displayName": "Workloads", + "related": { + "tables": [ + "ADAssessmentRecommendation", + "ADReplicationResult", + "SQLAssessmentRecommendation", + "WorkloadMonitoringPerf" + ] + } + } + ] + } + } + } +} diff --git a/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2021-05-19_Preview/examples/metadata-post.json b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2021-05-19_Preview/examples/metadata-post.json new file mode 100644 index 000000000000..ebfe9e55d2af --- /dev/null +++ b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2021-05-19_Preview/examples/metadata-post.json @@ -0,0 +1,284 @@ +{ + "title": "Post Metadata", + "description": "A metadata request that returns the workspace schema and other information", + "parameters": { + "workspaceId": "b438b4f6-912a-46d5-9cb1-b44069212abc", + "apiVersion": "2018-04-20" + }, + "responses": { + "200": { + "body": { + "tables": [ + { + "id": "ADAssessmentRecommendation", + "name": "ADAssessmentRecommendation", + "description": "Recommendations generated by AD assessments that are started through a scheduled task. When you schedule the assessment it runs by default every 7 days and upload the data into Azure Log Analytics", + "timespanColumn": "TimeGenerated", + "columns": [ + { + "name": "SourceSystem", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "AssessmentId", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "RecommendationId", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "Recommendation", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "Description", + "type": "string" + }, + { + "name": "RecommendationResult", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "TimeGenerated", + "type": "datetime" + }, + { + "name": "FocusAreaId", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "FocusArea", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "ActionAreaId", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "ActionArea", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "RecommendationWeight", + "type": "real" + }, + { + "name": "Computer", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "AffectedObjectType", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "AffectedObjectName", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "Forest", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "Domain", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "DomainController", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "Technology", + "type": "string" + }, + { + "name": "CustomData", + "type": "string" + }, + { + "name": "TargetCount", + "type": "int" + }, + { + "name": "IsRollup", + "type": "bool", + "isPreferredFacet": true + }, + { + "name": "IsCopied", + "type": "bool", + "isPreferredFacet": true + }, + { + "name": "RecommendationPeriod", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "Type", + "type": "string" + }, + { + "name": "_ResourceId", + "type": "string" + } + ], + "related": { + "categories": [ + "workloads" + ], + "solutions": [ + "ADAssessment" + ], + "resourceTypes": [ + "microsoft.compute/virtualmachines" + ] + } + }, + { + "id": "custom_CL", + "name": "custom_CL", + "timespanColumn": "TimeGenerated", + "columns": [ + { + "name": "SourceSystem", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "ManagementGroupName", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "TimeGenerated", + "type": "datetime", + "isPreferredFacet": true + }, + { + "name": "Computer", + "type": "string", + "isPreferredFacet": true + }, + { + "name": "RawData", + "type": "string" + }, + { + "name": "Type", + "type": "string" + }, + { + "name": "_ResourceId", + "type": "string" + } + ], + "related": { + "workspaces": [ + "b438b4f6-912a-46d5-9cb1-b44069212abc" + ] + } + } + ], + "solutions": [ + { + "id": "ADAssessment", + "name": "ADAssessment", + "displayName": "Active Directory Health Check", + "description": "Assess the risk and health of Active Directory environments.", + "related": { + "tables": [ + "ADAssessmentRecommendation" + ], + "functions": [ + "dwad" + ], + "workspaces": [ + "b438b4f6-912a-46d5-9cb1-b44069212abc" + ] + } + } + ], + "functions": [ + { + "id": "dwad", + "name": "dwad", + "displayName": "dasd", + "body": "Heartbeat\r\n| where ResourceGroup != \"rg-SAP-DEVQA-005\" and ResourceGroup != \"rg-SAP-DEVQA-006\" and Computer contains \"\"\r\n| limit 500000\r\n| sort by Computer asc\r\n| distinct Computer\r\n", + "related": { + "solutions": [ + "ADAssessment" + ], + "workspaces": [ + "b438b4f6-912a-46d5-9cb1-b44069212abc" + ] + } + } + ], + "resourceTypes": [ + { + "id": "microsoft.compute/virtualmachines", + "type": "Microsoft.Compute/VirtualMachines", + "displayName": "Virtual machines", + "related": { + "tables": [ + "ADAssessmentRecommendation" + ] + } + } + ], + "workspaces": [ + { + "id": "b438b4f6-912a-46d5-9cb1-b44069212abc", + "resourceId": "/subscriptions/e4272367-5645-4c4e-9c67-3b74b59a6982/resourceGroups/contosoazurehq/providers/microsoft.operationalinsights/workspaces/contosoretail-IT", + "name": "contosoretail-IT", + "region": "eastus", + "related": { + "resourceTypes": [ + "microsoft.compute/virtualmachines" + ], + "tables": [ + "custom_CL" + ], + "solutions": [ + "ADAssessment" + ], + "functions": [ + "dwad" + ] + } + } + ], + "categories": [ + { + "id": "workloads", + "displayName": "Workloads", + "related": { + "tables": [ + "ADAssessmentRecommendation", + "ADReplicationResult", + "SQLAssessmentRecommendation", + "WorkloadMonitoringPerf" + ] + } + } + ] + } + } + } +} diff --git a/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2021-05-19_Preview/examples/oms-get-cross-workspace-example.json b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2021-05-19_Preview/examples/oms-get-cross-workspace-example.json new file mode 100644 index 000000000000..d1e3647f86ef --- /dev/null +++ b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2021-05-19_Preview/examples/oms-get-cross-workspace-example.json @@ -0,0 +1,66 @@ +{ + "title": "Cross Workspace Query", + "description": "A cross workspace query that the type and count of each row per workspace.", + "parameters": { + "workspaceId": "63613592-b6f7-4c3d-a390-22ba13102111", + "query": "union * | where TimeGenerated > ago(1h) | summarize count() by Type, TenantId", + "workspaces": "draft-test,draft-test-2" + }, + "responses": { + "200": { + "body": { + "tables": [ + { + "name": "PrimaryResult", + "columns": [ + { + "name": "Type", + "type": "string" + }, + { + "name": "TenantId", + "type": "string" + }, + { + "name": "count_", + "type": "long" + } + ], + "rows": [ + [ + "Usage", + "63613592-b6f7-4c3d-a390-22ba13102111", + "1" + ], + [ + "Usage", + "d436f322-a9f4-4aad-9a7d-271fbf66001c", + "1" + ], + [ + "BillingFact", + "63613592-b6f7-4c3d-a390-22ba13102111", + "1" + ], + [ + "BillingFact", + "d436f322-a9f4-4aad-9a7d-271fbf66001c", + "1" + ], + [ + "Operation", + "63613592-b6f7-4c3d-a390-22ba13102111", + "7" + ], + [ + "Operation", + "d436f322-a9f4-4aad-9a7d-271fbf66001c", + "5" + ] + ] + } + ] + } + } + } +} diff --git a/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2021-05-19_Preview/examples/oms-get-example.json b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2021-05-19_Preview/examples/oms-get-example.json new file mode 100644 index 000000000000..5b4e6d426e57 --- /dev/null +++ b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2021-05-19_Preview/examples/oms-get-example.json @@ -0,0 +1,158 @@ +{ + "title": "Simple Query", + "description": "A simple query that returns query results.", + "parameters": { + "workspaceId": "63613592-b6f7-4c3d-a390-22ba13102111", + "query": "Usage | take 10", + "timespan": "PT12H" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "58a37988-2c05-427a-891f-5e0e1266fcc5", + "x-ms-correlation-request-id": "58a37988-2c05-427a-891f-5e0e1266fcc5" + }, + "body": { + "tables": [ + { + "name": "PrimaryResult", + "columns": [ + { + "name": "TenantId", + "type": "string" + }, + { + "name": "Computer", + "type": "string" + }, + { + "name": "TimeGenerated", + "type": "datetime" + }, + { + "name": "SourceSystem", + "type": "string" + }, + { + "name": "StartTime", + "type": "datetime" + }, + { + "name": "EndTime", + "type": "datetime" + }, + { + "name": "ResourceUri", + "type": "string" + }, + { + "name": "LinkedResourceUri", + "type": "string" + }, + { + "name": "DataType", + "type": "string" + }, + { + "name": "Solution", + "type": "string" + }, + { + "name": "BatchesWithinSla", + "type": "long" + }, + { + "name": "BatchesOutsideSla", + "type": "long" + }, + { + "name": "BatchesCapped", + "type": "long" + }, + { + "name": "TotalBatches", + "type": "long" + }, + { + "name": "AvgLatencyInSeconds", + "type": "real" + }, + { + "name": "Quantity", + "type": "real" + }, + { + "name": "QuantityUnit", + "type": "string" + }, + { + "name": "IsBillable", + "type": "bool" + }, + { + "name": "MeterId", + "type": "string" + }, + { + "name": "LinkedMeterId", + "type": "string" + }, + { + "name": "Type", + "type": "string" + } + ], + "rows": [ + [ + "b438b4f6-912a-46d5-9cb1-b44069212abc", + "ContosoSQLSrv1", + "2017-08-24T06:59:59Z", + "OMS", + "2017-08-24T06:00:00Z", + "2017-08-24T06:59:59Z", + "/subscriptions/e4272367-5645-4c4e-9c67-3b74b59a6982/resourcegroups/contosoazurehq/providers/microsoft.operationalinsights/workspaces/contosoretail-it", + null, + "Perf", + "LogManagement", + "1", + "0", + "0", + "1", + "1.286", + "0.076408", + "MBytes", + "true", + "a4e29a95-5b4c-408b-80e3-113f9410566e", + "00000000-0000-0000-0000-000000000000", + "Usage" + ], + [ + "b438b4f6-912a-46d5-9cb1-b44069212abc", + "Store010Web3", + "2017-08-24T06:59:59Z", + "OMS", + "2017-08-24T06:00:00Z", + "2017-08-24T06:59:59Z", + "/subscriptions/e4272367-5645-4c4e-9c67-3b74b59a6982/resourcegroups/contosoazurehq/providers/microsoft.operationalinsights/workspaces/contosoretail-it", + null, + "Perf", + "LogManagement", + "1", + "0", + "0", + "1", + "1.7", + "0.106767", + "MBytes", + "true", + "a4e29a95-5b4c-408b-80e3-113f9410566e", + "00000000-0000-0000-0000-000000000000", + "Usage" + ] + ] + } + ] + } + } + } +} diff --git a/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2021-05-19_Preview/examples/oms-post-cross-workspace-example.json b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2021-05-19_Preview/examples/oms-post-cross-workspace-example.json new file mode 100644 index 000000000000..20a06125bd66 --- /dev/null +++ b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2021-05-19_Preview/examples/oms-post-cross-workspace-example.json @@ -0,0 +1,71 @@ +{ + "title": "Cross Workspace Query", + "description": "A cross workspace query that the type and count of each row per workspace.", + "parameters": { + "workspaceId": "63613592-b6f7-4c3d-a390-22ba13102111", + "body": { + "query": "union * | where TimeGenerated > ago(1h) | summarize count() by Type, TenantId", + "workspaces": [ + "draft-test", + "draft-test-2" + ] + } + }, + "responses": { + "200": { + "body": { + "tables": [ + { + "name": "PrimaryResult", + "columns": [ + { + "name": "Type", + "type": "string" + }, + { + "name": "TenantId", + "type": "string" + }, + { + "name": "count_", + "type": "long" + } + ], + "rows": [ + [ + "Usage", + "63613592-b6f7-4c3d-a390-22ba13102111", + "1" + ], + [ + "Usage", + "d436f322-a9f4-4aad-9a7d-271fbf66001c", + "1" + ], + [ + "BillingFact", + "63613592-b6f7-4c3d-a390-22ba13102111", + "1" + ], + [ + "BillingFact", + "d436f322-a9f4-4aad-9a7d-271fbf66001c", + "1" + ], + [ + "Operation", + "63613592-b6f7-4c3d-a390-22ba13102111", + "7" + ], + [ + "Operation", + "d436f322-a9f4-4aad-9a7d-271fbf66001c", + "5" + ] + ] + } + ] + } + } + } +} diff --git a/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2021-05-19_Preview/examples/oms-post-example.json b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2021-05-19_Preview/examples/oms-post-example.json new file mode 100644 index 000000000000..57a53fa2a365 --- /dev/null +++ b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2021-05-19_Preview/examples/oms-post-example.json @@ -0,0 +1,156 @@ +{ + "title": "Simple Query", + "description": "A simple query that returns query results.", + "parameters": { + "workspaceId": "63613592-b6f7-4c3d-a390-22ba13102111", + "body": { + "query": "Usage | take 10", + "timespan": "PT12H" + } + }, + "responses": { + "200": { + "body": { + "tables": [ + { + "name": "PrimaryResult", + "columns": [ + { + "name": "TenantId", + "type": "string" + }, + { + "name": "Computer", + "type": "string" + }, + { + "name": "TimeGenerated", + "type": "datetime" + }, + { + "name": "SourceSystem", + "type": "string" + }, + { + "name": "StartTime", + "type": "datetime" + }, + { + "name": "EndTime", + "type": "datetime" + }, + { + "name": "ResourceUri", + "type": "string" + }, + { + "name": "LinkedResourceUri", + "type": "string" + }, + { + "name": "DataType", + "type": "string" + }, + { + "name": "Solution", + "type": "string" + }, + { + "name": "BatchesWithinSla", + "type": "long" + }, + { + "name": "BatchesOutsideSla", + "type": "long" + }, + { + "name": "BatchesCapped", + "type": "long" + }, + { + "name": "TotalBatches", + "type": "long" + }, + { + "name": "AvgLatencyInSeconds", + "type": "real" + }, + { + "name": "Quantity", + "type": "real" + }, + { + "name": "QuantityUnit", + "type": "string" + }, + { + "name": "IsBillable", + "type": "bool" + }, + { + "name": "MeterId", + "type": "string" + }, + { + "name": "LinkedMeterId", + "type": "string" + }, + { + "name": "Type", + "type": "string" + } + ], + "rows": [ + [ + "b438b4f6-912a-46d5-9cb1-b44069212abc", + "ContosoSQLSrv1", + "2017-08-24T06:59:59Z", + "OMS", + "2017-08-24T06:00:00Z", + "2017-08-24T06:59:59Z", + "/subscriptions/e4272367-5645-4c4e-9c67-3b74b59a6982/resourcegroups/contosoazurehq/providers/microsoft.operationalinsights/workspaces/contosoretail-it", + null, + "Perf", + "LogManagement", + "1", + "0", + "0", + "1", + "1.286", + "0.076408", + "MBytes", + "true", + "a4e29a95-5b4c-408b-80e3-113f9410566e", + "00000000-0000-0000-0000-000000000000", + "Usage" + ], + [ + "b438b4f6-912a-46d5-9cb1-b44069212abc", + "Store010Web3", + "2017-08-24T06:59:59Z", + "OMS", + "2017-08-24T06:00:00Z", + "2017-08-24T06:59:59Z", + "/subscriptions/e4272367-5645-4c4e-9c67-3b74b59a6982/resourcegroups/contosoazurehq/providers/microsoft.operationalinsights/workspaces/contosoretail-it", + null, + "Perf", + "LogManagement", + "1", + "0", + "0", + "1", + "1.7", + "0.106767", + "MBytes", + "true", + "a4e29a95-5b4c-408b-80e3-113f9410566e", + "00000000-0000-0000-0000-000000000000", + "Usage" + ] + ] + } + ] + } + } + } +} diff --git a/specification/operationalinsights/data-plane/readme.md b/specification/operationalinsights/data-plane/readme.md index f1e857ed5d8f..f74eef9fcd6a 100644 --- a/specification/operationalinsights/data-plane/readme.md +++ b/specification/operationalinsights/data-plane/readme.md @@ -52,6 +52,15 @@ directive: transform: $.operationId = "Query" ``` +``` yaml $(tag) == '20210519' +input-file: +- Microsoft.OperationalInsights/preview/2021-05-19_Preview/OperationalInsights.json +directive: + - reason: Include batch query and add prefer headers to query request + where-operation: Query_Post + transform: $.operationId = "Query" +``` + --- # Code Generation diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/LinkedServices.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/LinkedServices.json index 4312e9929293..84b5f4b52c58 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/LinkedServices.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/LinkedServices.json @@ -77,6 +77,9 @@ } ], "responses": { + "202": { + "description": "Accepted response definition." + }, "200": { "description": "OK response definition.", "schema": { @@ -131,6 +134,9 @@ "$ref": "#/definitions/LinkedService" } }, + "202": { + "description": "Accepted response definition." + }, "204": { "description": "NoContent response definition." } diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/SavedSearches.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/SavedSearches.json index 34f7ad1d6c8f..1d9bc958f0ea 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/SavedSearches.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/SavedSearches.json @@ -266,7 +266,7 @@ "properties": { "etag": { "type": "string", - "description": "The ETag of the saved search." + "description": "The ETag of the saved search. To override an existing saved search, use \"*\" or specify the current Etag" }, "properties": { "x-ms-client-flatten": true, diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/Tables.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/Tables.json index d2a59d33aea9..a3477a2dce3d 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/Tables.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/Tables.json @@ -183,8 +183,6 @@ "retentionInDays": { "type": "integer", "format": "int32", - "minimum": 30, - "maximum": 730, "description": "The data table data retention in days, between 30 and 730. Setting this property to null will default to the workspace retention." } }, diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/examples/LinkedServicesCreate.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/examples/LinkedServicesCreate.json index 8f7915890a23..5f740de7116a 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/examples/LinkedServicesCreate.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/examples/LinkedServicesCreate.json @@ -12,6 +12,7 @@ "subscriptionId": "00000000-0000-0000-0000-00000000000" }, "responses": { + "202": {}, "200": { "body": { "properties": { diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/examples/LinkedServicesDelete.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/examples/LinkedServicesDelete.json index d1a010ac07f8..a8928cda635c 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/examples/LinkedServicesDelete.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/examples/LinkedServicesDelete.json @@ -7,6 +7,7 @@ "subscriptionId": "00000000-0000-0000-0000-00000000000" }, "responses": { + "202": {}, "200": { "body": { "properties": { diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-10-01/Clusters.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-10-01/Clusters.json index 78b82498e54f..401389de9e17 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-10-01/Clusters.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-10-01/Clusters.json @@ -212,6 +212,9 @@ } ], "responses": { + "202": { + "description": "Accepted response definition." + }, "200": { "description": "OK response definition." }, @@ -629,12 +632,6 @@ "description": "Minimum CapacityReservation value in GB.", "type": "integer", "format": "int64" - }, - "maxCapacity": { - "readOnly": true, - "description": "Maximum CapacityReservation value in GB.", - "type": "integer", - "format": "int64" } } } diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-10-01/Workspaces.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-10-01/Workspaces.json index 9402e0a9bf04..cf81e6902d66 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-10-01/Workspaces.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-10-01/Workspaces.json @@ -562,7 +562,6 @@ "description": "List of linked private link scope resources." }, "features": { - "x-ms-client-flatten": true, "$ref": "#/definitions/WorkspaceFeatures", "description": "Workspace features." } @@ -590,6 +589,11 @@ "type": "string", "x-nullable": true, "description": "Dedicated LA cluster resourceId that is linked to the workspaces." + }, + "disableLocalAuth": { + "type": "boolean", + "x-nullable": true, + "description": "Disable Non-AAD based Auth." } }, "additionalProperties": true, diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-10-01/examples/ClustersCreate.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-10-01/examples/ClustersCreate.json index 7c5c2f6ae4d0..bcba9ddd3793 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-10-01/examples/ClustersCreate.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-10-01/examples/ClustersCreate.json @@ -33,8 +33,7 @@ "associatedWorkspaces": [], "capacityReservationProperties": { "lastSkuUpdate": "Thu, 01 Jan 1970 00:00:00 GMT", - "minCapacity": 1000, - "maxCapacity": 3000 + "minCapacity": 1000 } }, "id": "/subscriptions/594038b5-1093-476e-a366-482775671c11/resourcegroups/oiautorest6685/providers/microsoft.operationalinsights/clusters/oiautorest6685", @@ -68,8 +67,7 @@ "associatedWorkspaces": [], "capacityReservationProperties": { "lastSkuUpdate": "Thu, 01 Jan 1970 00:00:00 GMT", - "minCapacity": 1000, - "maxCapacity": 3000 + "minCapacity": 1000 } }, "id": "/subscriptions/594038b5-1093-476e-a366-482775671c11/resourcegroups/oiautorest6685/providers/microsoft.operationalinsights/clusters/oiautorest6685", diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-10-01/examples/ClustersDelete.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-10-01/examples/ClustersDelete.json index 859ff3048e99..2bdd152922a4 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-10-01/examples/ClustersDelete.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-10-01/examples/ClustersDelete.json @@ -7,6 +7,7 @@ }, "responses": { "200": {}, + "202": {}, "204": {} } } diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-10-01/examples/ClustersGet.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-10-01/examples/ClustersGet.json index ed1c03679531..145f77b34aa5 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-10-01/examples/ClustersGet.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-10-01/examples/ClustersGet.json @@ -38,8 +38,7 @@ ], "capacityReservationProperties": { "lastSkuUpdate": "Thu, 01 Jan 1970 00:00:00 GMT", - "minCapacity": 1000, - "maxCapacity": 3000 + "minCapacity": 1000 } }, "id": "/subscriptions/594038b5-1093-476e-a366-482775671c11/resourcegroups/calbot-rg/providers/microsoft.operationalinsights/clusters/testresourcelock", diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-10-01/examples/ClustersUpdate.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-10-01/examples/ClustersUpdate.json index 0e5a0ee89da3..a7ebeca9695f 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-10-01/examples/ClustersUpdate.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2020-10-01/examples/ClustersUpdate.json @@ -68,8 +68,7 @@ ], "capacityReservationProperties": { "lastSkuUpdate": "Thu, 01 Jan 1970 00:00:00 GMT", - "minCapacity": 1000, - "maxCapacity": 3000 + "minCapacity": 1000 } }, "sku": { diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/Clusters.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/Clusters.json new file mode 100644 index 000000000000..f8c56df74cca --- /dev/null +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/Clusters.json @@ -0,0 +1,652 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Log Analytics", + "description": "Azure Log Analytics API reference", + "version": "2021-06-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.OperationalInsights/clusters": { + "get": { + "tags": [ + "Clusters" + ], + "x-ms-examples": { + "ClustersGet": { + "$ref": "./examples/ClustersListByResourceGroup.json" + } + }, + "operationId": "Clusters_ListByResourceGroup", + "description": "Gets Log Analytics clusters in a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/ClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/clusters": { + "get": { + "tags": [ + "Clusters" + ], + "x-ms-examples": { + "ClustersSubscriptionList": { + "$ref": "./examples/ClustersSubscriptionList.json" + } + }, + "operationId": "Clusters_List", + "description": "Gets the Log Analytics clusters in a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/ClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/clusters/{clusterName}": { + "put": { + "tags": [ + "Clusters" + ], + "x-ms-examples": { + "ClustersCreate": { + "$ref": "./examples/ClustersCreate.json" + } + }, + "operationId": "Clusters_CreateOrUpdate", + "description": "Create or update a Log Analytics cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$", + "minLength": 4, + "maxLength": 63, + "description": "The name of the Log Analytics cluster." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Cluster" + }, + "description": "The parameters required to create or update a Log Analytics cluster." + } + ], + "responses": { + "202": { + "description": "Accepted response definition." + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "201": { + "description": "Created response definition.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Clusters" + ], + "x-ms-examples": { + "ClustersDelete": { + "$ref": "./examples/ClustersDelete.json" + } + }, + "operationId": "Clusters_Delete", + "description": "Deletes a cluster instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the Log Analytics Cluster." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted response definition." + }, + "200": { + "description": "OK response definition." + }, + "204": { + "description": "NoContent response definition." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Clusters" + ], + "x-ms-examples": { + "ClustersGet": { + "$ref": "./examples/ClustersGet.json" + } + }, + "operationId": "Clusters_Get", + "description": "Gets a Log Analytics cluster instance.", + "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" + }, + { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the Log Analytics Cluster." + } + ], + "responses": { + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Clusters" + ], + "x-ms-examples": { + "ClustersPatch": { + "$ref": "./examples/ClustersUpdate.json" + } + }, + "operationId": "Clusters_Update", + "description": "Updates a Log Analytics cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the Log Analytics Cluster." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterPatch" + }, + "description": "The parameters required to patch a Log Analytics cluster." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The existing cluster was successfully updated. Check provisioningStatus to see detailed status.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ClusterProperties": { + "properties": { + "clusterId": { + "type": "string", + "readOnly": true, + "description": "The ID associated with the cluster." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioning state of the cluster.", + "enum": [ + "Creating", + "Succeeded", + "Failed", + "Canceled", + "Deleting", + "ProvisioningAccount", + "Updating" + ], + "x-ms-enum": { + "name": "ClusterEntityStatus", + "modelAsString": true + } + }, + "isDoubleEncryptionEnabled": { + "type": "boolean", + "readOnly": false, + "description": "Configures whether cluster will use double encryption. This Property can not be modified after cluster creation. Default value is 'true'", + "x-ms-mutability": [ + "create" + ] + }, + "isAvailabilityZonesEnabled": { + "type": "boolean", + "readOnly": false, + "description": "Sets whether the cluster will support availability zones. This can be set as true only in regions where Azure Data Explorer support Availability Zones. This Property can not be modified after cluster creation. Default value is 'true' if region supports Availability Zones." + }, + "billingType": { + "$ref": "#/definitions/billingType", + "description": "The cluster's billing type." + }, + "keyVaultProperties": { + "$ref": "#/definitions/keyVaultProperties", + "description": "The associated key properties." + }, + "lastModifiedDate": { + "type": "string", + "description": "The last time the cluster was updated.", + "readOnly": true + }, + "createdDate": { + "type": "string", + "description": "The cluster creation time", + "readOnly": true + }, + "associatedWorkspaces": { + "description": "The list of Log Analytics workspaces associated with the cluster", + "type": "array", + "items": { + "$ref": "#/definitions/AssociatedWorkspace" + } + }, + "capacityReservationProperties": { + "$ref": "#/definitions/CapacityReservationProperties", + "description": "Additional properties for capacity reservation" + } + }, + "description": "Cluster properties." + }, + "ClusterPatchProperties": { + "properties": { + "keyVaultProperties": { + "$ref": "#/definitions/keyVaultProperties", + "description": "The associated key properties." + }, + "billingType": { + "$ref": "#/definitions/billingType", + "description": "The cluster's billing type." + } + }, + "description": "Log Analytics cluster patch properties." + }, + "ClusterPatch": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ClusterPatchProperties", + "description": "Log Analytics cluster properties." + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the resource." + }, + "sku": { + "$ref": "#/definitions/ClusterSku", + "description": "The sku properties." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + } + }, + "description": "The top level Log Analytics cluster resource container.", + "x-ms-azure-resource": true + }, + "Cluster": { + "properties": { + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the resource." + }, + "sku": { + "$ref": "#/definitions/ClusterSku", + "description": "The sku properties." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ClusterProperties", + "description": "Log Analytics cluster properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "description": "The top level Log Analytics cluster resource container." + }, + "ClusterListResult": { + "properties": { + "nextLink": { + "description": "The link used to get the next page of recommendations.", + "type": "string" + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Cluster" + }, + "description": "A list of Log Analytics clusters." + } + }, + "description": "The list clusters operation response." + }, + "keyVaultProperties": { + "description": "The key vault properties.", + "properties": { + "keyVaultUri": { + "description": "The Key Vault uri which holds they key associated with the Log Analytics cluster.", + "type": "string" + }, + "keyName": { + "description": "The name of the key associated with the Log Analytics cluster.", + "type": "string" + }, + "keyVersion": { + "description": "The version of the key associated with the Log Analytics cluster.", + "type": "string" + }, + "keyRsaSize": { + "description": "Selected key minimum required size.", + "type": "integer", + "format": "int32" + } + } + }, + "billingType": { + "type": "string", + "readOnly": false, + "description": "Configures whether billing will be only on the cluster or each workspace will be billed by its proportional use. This does not change the overall billing, only how it will be distributed. Default value is 'Cluster'", + "enum": [ + "Cluster", + "Workspaces" + ], + "x-ms-enum": { + "name": "BillingType", + "modelAsString": true + } + }, + "ClusterSku": { + "description": "The cluster sku definition.", + "properties": { + "capacity": { + "description": "The capacity value", + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string", + "description": "The name of the SKU.", + "enum": [ + "CapacityReservation" + ], + "x-ms-enum": { + "name": "ClusterSkuNameEnum", + "modelAsString": true + } + } + } + }, + "Identity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of resource identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID of resource." + }, + "type": { + "type": "string", + "description": "Type of managed service identity.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "description": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserIdentityProperties" + } + } + }, + "required": [ + "type" + ], + "description": "Identity for the resource." + }, + "UserIdentityProperties": { + "type": "object", + "description": "User assigned identity properties.", + "properties": { + "principalId": { + "readOnly": true, + "description": "The principal id of user assigned identity.", + "type": "string" + }, + "clientId": { + "readOnly": true, + "description": "The client id of user assigned identity.", + "type": "string" + } + } + }, + "AssociatedWorkspace": { + "type": "object", + "description": "The list of Log Analytics workspaces associated with the cluster.", + "properties": { + "workspaceId": { + "readOnly": true, + "description": "The id of the assigned workspace.", + "type": "string" + }, + "workspaceName": { + "readOnly": true, + "description": "The name id the assigned workspace.", + "type": "string" + }, + "resourceId": { + "readOnly": true, + "description": "The ResourceId id the assigned workspace.", + "type": "string" + }, + "associateDate": { + "readOnly": true, + "description": "The time of workspace association.", + "type": "string" + } + } + }, + "CapacityReservationProperties": { + "description": "The Capacity Reservation properties.", + "properties": { + "lastSkuUpdate": { + "readOnly": true, + "description": "The last time Sku was updated.", + "type": "string" + }, + "minCapacity": { + "readOnly": true, + "description": "Minimum CapacityReservation value in GB.", + "type": "integer", + "format": "int64" + }, + "capacityReservationLevel": { + "readOnly": true, + "description": "The capacity reservation level for this cluster in GB", + "type": "integer", + "format": "int32", + "enum": [ + 500, + 1000, + 2000, + 5000 + ] + } + } + } + }, + "parameters": {} +} diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/Workspaces.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/Workspaces.json new file mode 100644 index 000000000000..8cba3e80e87c --- /dev/null +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/Workspaces.json @@ -0,0 +1,708 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Log Analytics", + "description": "Azure Log Analytics API reference", + "version": "2021-06-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.OperationalInsights/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "x-ms-examples": { + "WorkspacesSubscriptionList": { + "$ref": "./examples/WorkspacesSubscriptionList.json" + } + }, + "operationId": "Workspaces_List", + "description": "Gets the workspaces in a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "x-ms-examples": { + "WorkspacesGet": { + "$ref": "./examples/WorkspacesListByResourceGroup.json" + } + }, + "operationId": "Workspaces_ListByResourceGroup", + "description": "Gets workspaces in a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}": { + "put": { + "tags": [ + "Workspaces" + ], + "x-ms-examples": { + "WorkspacesCreate": { + "$ref": "./examples/WorkspacesCreate.json" + } + }, + "operationId": "Workspaces_CreateOrUpdate", + "description": "Create or update a workspace.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Workspace" + }, + "description": "The parameters required to create or update a workspace." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "201": { + "description": "Created response definition.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Workspaces" + ], + "x-ms-examples": { + "WorkspacesDelete": { + "$ref": "./examples/WorkspacesDelete.json" + } + }, + "operationId": "Workspaces_Delete", + "description": "Deletes a workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Deletes the workspace without the recovery option. A workspace that was deleted with this flag cannot be recovered." + } + ], + "responses": { + "200": { + "description": "OK response definition." + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent response definition." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Workspaces" + ], + "x-ms-examples": { + "WorkspaceGet": { + "$ref": "./examples/WorkspacesGet.json" + } + }, + "operationId": "Workspaces_Get", + "description": "Gets a workspace instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Workspaces" + ], + "x-ms-examples": { + "WorkspacesPatch": { + "$ref": "./examples/WorkspacesUpdate.json" + } + }, + "operationId": "Workspaces_Update", + "description": "Updates a workspace.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspacePatch" + }, + "description": "The parameters required to patch a workspace." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The existing workspace was successfully updated. Check provisioningStatus to see detailed status.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/deletedWorkspaces": { + "get": { + "tags": [ + "DeletedWorkspaces" + ], + "x-ms-examples": { + "WorkspacesSubscriptionList": { + "$ref": "./examples/WorkspacesSubscriptionList.json" + } + }, + "operationId": "DeletedWorkspaces_List", + "description": "Gets recently deleted workspaces in a subscription, available for recovery.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/deletedWorkspaces": { + "get": { + "tags": [ + "DeletedWorkspaces" + ], + "x-ms-examples": { + "WorkspacesGet": { + "$ref": "./examples/WorkspacesListByResourceGroup.json" + } + }, + "operationId": "DeletedWorkspaces_ListByResourceGroup", + "description": "Gets recently deleted workspaces in a resource group, available for recovery.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + } + }, + "definitions": { + "WorkspaceSku": { + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU.", + "enum": [ + "Free", + "Standard", + "Premium", + "PerNode", + "PerGB2018", + "Standalone", + "CapacityReservation", + "LACluster" + ], + "x-ms-enum": { + "name": "WorkspaceSkuNameEnum", + "modelAsString": true + } + }, + "capacityReservationLevel": { + "type": "integer", + "format": "int32", + "description": "The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected.", + "enum": [ + 100, + 200, + 300, + 400, + 500, + 1000, + 2000, + 5000 + ] + }, + "lastSkuUpdate": { + "type": "string", + "description": "The last time when the sku was updated.", + "readOnly": true + } + }, + "required": [ + "name" + ], + "description": "The SKU (tier) of a workspace." + }, + "WorkspaceCapping": { + "description": "The daily volume cap for ingestion.", + "properties": { + "dailyQuotaGb": { + "type": "number", + "format": "double", + "description": "The workspace daily quota for ingestion." + }, + "quotaNextResetTime": { + "type": "string", + "description": "The time when the quota will be rest.", + "readOnly": true + }, + "dataIngestionStatus": { + "type": "string", + "readOnly": true, + "description": "The status of data ingestion for this workspace.", + "enum": [ + "RespectQuota", + "ForceOn", + "ForceOff", + "OverQuota", + "SubscriptionSuspended", + "ApproachingQuota" + ], + "x-ms-enum": { + "name": "DataIngestionStatus", + "modelAsString": true, + "values": [ + { + "value": "RespectQuota", + "description": "Ingestion enabled following daily cap quota reset, or subscription enablement." + }, + { + "value": "ForceOn", + "description": "Ingestion started following service setting change." + }, + { + "value": "ForceOff", + "description": "Ingestion stopped following service setting change." + }, + { + "value": "OverQuota", + "description": "Reached daily cap quota, ingestion stopped." + }, + { + "value": "SubscriptionSuspended", + "description": "Ingestion stopped following suspended subscription." + }, + { + "value": "ApproachingQuota", + "description": "80% of daily cap quota reached." + } + ] + } + } + } + }, + "WorkspaceProperties": { + "properties": { + "provisioningState": { + "type": "string", + "description": "The provisioning state of the workspace.", + "enum": [ + "Creating", + "Succeeded", + "Failed", + "Canceled", + "Deleting", + "ProvisioningAccount", + "Updating" + ], + "x-ms-enum": { + "name": "WorkspaceEntityStatus", + "modelAsString": true + } + }, + "customerId": { + "type": "string", + "description": "This is a read-only property. Represents the ID associated with the workspace.", + "readOnly": true + }, + "sku": { + "$ref": "#/definitions/WorkspaceSku", + "description": "The SKU of the workspace." + }, + "retentionInDays": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details." + }, + "workspaceCapping": { + "$ref": "#/definitions/WorkspaceCapping", + "description": "The daily volume cap for ingestion." + }, + "createdDate": { + "type": "string", + "description": "Workspace creation date.", + "readOnly": true + }, + "modifiedDate": { + "type": "string", + "description": "Workspace modification date.", + "readOnly": true + }, + "publicNetworkAccessForIngestion": { + "description": "The network access type for accessing Log Analytics ingestion.", + "$ref": "#/definitions/PublicNetworkAccessType" + }, + "publicNetworkAccessForQuery": { + "description": "The network access type for accessing Log Analytics query.", + "$ref": "#/definitions/PublicNetworkAccessType" + }, + "forceCmkForQuery": { + "type": "boolean", + "description": "Indicates whether customer managed storage is mandatory for query management." + }, + "privateLinkScopedResources": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkScopedResource" + }, + "description": "List of linked private link scope resources." + }, + "features": { + "$ref": "#/definitions/WorkspaceFeatures", + "description": "Workspace features." + } + }, + "description": "Workspace properties." + }, + "WorkspaceFeatures": { + "properties": { + "enableDataExport": { + "type": "boolean", + "x-nullable": true, + "description": "Flag that indicate if data should be exported." + }, + "immediatePurgeDataOn30Days": { + "type": "boolean", + "x-nullable": true, + "description": "Flag that describes if we want to remove the data after 30 days." + }, + "enableLogAccessUsingOnlyResourcePermissions": { + "type": "boolean", + "x-nullable": true, + "description": "Flag that indicate which permission to use - resource or workspace or both." + }, + "clusterResourceId": { + "type": "string", + "x-nullable": true, + "description": "Dedicated LA cluster resourceId that is linked to the workspaces." + }, + "disableLocalAuth": { + "type": "boolean", + "x-nullable": true, + "description": "Disable Non-AAD based Auth." + } + }, + "additionalProperties": true, + "description": "Workspace features." + }, + "PrivateLinkScopedResource": { + "properties": { + "resourceId": { + "type": "string", + "description": "The full resource Id of the private link scope resource." + }, + "scopeId": { + "type": "string", + "description": "The private link scope unique Identifier." + } + }, + "description": "The private link scope resource reference." + }, + "Workspace": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkspaceProperties", + "description": "Workspace properties." + }, + "eTag": { + "type": "string", + "description": "The ETag of the workspace." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "description": "The top level Workspace resource container." + }, + "WorkspacePatch": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkspaceProperties", + "description": "Workspace properties." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags. Optional." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/AzureEntityResource" + } + ], + "description": "The top level Workspace resource container." + }, + "WorkspaceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Workspace" + }, + "description": "A list of workspaces." + } + }, + "description": "The list workspaces operation response." + }, + "PublicNetworkAccessType": { + "type": "string", + "description": "The network access type for operating on the Log Analytics Workspace. By default it is Enabled", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccessType", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Enables connectivity to Log Analytics through public DNS." + }, + { + "value": "Disabled", + "description": "Disables public connectivity to Log Analytics through public DNS." + } + ] + } + } + }, + "parameters": {} +} diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/ClustersCreate.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/ClustersCreate.json new file mode 100644 index 000000000000..bcba9ddd3793 --- /dev/null +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/ClustersCreate.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "resourceGroupName": "oiautorest6685", + "clusterName": "oiautorest6685", + "parameters": { + "sku": { + "name": "CapacityReservation", + "capacity": 1000 + }, + "location": "australiasoutheast", + "tags": { + "tag1": "val1" + } + }, + "api-version": "2020-10-01", + "subscriptionId": "00000000-0000-0000-0000-00000000000" + }, + "responses": { + "202": {}, + "200": { + "body": { + "properties": { + "keyVaultProperties": { + "keyVaultUri": "https://aztest2170.vault.azure.net", + "keyName": "aztest2170cert", + "keyVersion": "654ft6c4e63845cbb50fd6fg51540429" + }, + "provisioningState": "ProvisioningAccount", + "clusterId": "1c3f2afc-9ec1-4e74-bfe8-022b83bcd7b1", + "billingType": "Cluster", + "lastModifiedDate": "Sun, 04 Jan 2020 17:10:56 GMT", + "createdDate": "Mon, 13 Jan 2020 14:40:33 GMT", + "associatedWorkspaces": [], + "capacityReservationProperties": { + "lastSkuUpdate": "Thu, 01 Jan 1970 00:00:00 GMT", + "minCapacity": 1000 + } + }, + "id": "/subscriptions/594038b5-1093-476e-a366-482775671c11/resourcegroups/oiautorest6685/providers/microsoft.operationalinsights/clusters/oiautorest6685", + "identity": { + "principalId": "356d057d-cba5-44dd-8a30-b2e547bc416b", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "sku": { + "name": "CapacityReservation", + "capacity": 1000 + }, + "name": "oiautorest6685", + "type": "Microsoft.OperationalInsights/clusters", + "location": "australiasoutheast" + } + }, + "201": { + "body": { + "properties": { + "keyVaultProperties": { + "keyVaultUri": "https://aztest2170.vault.azure.net", + "keyName": "aztest2170cert", + "keyVersion": "654ft6c4e63845cbb50fd6fg51540429" + }, + "provisioningState": "ProvisioningAccount", + "clusterId": "1c3f2afc-9ec1-4e74-bfe8-022b83bcd7b1", + "billingType": "Cluster", + "lastModifiedDate": "Sun, 04 Jan 2020 17:10:56 GMT", + "createdDate": "Mon, 13 Jan 2020 14:40:33 GMT", + "associatedWorkspaces": [], + "capacityReservationProperties": { + "lastSkuUpdate": "Thu, 01 Jan 1970 00:00:00 GMT", + "minCapacity": 1000 + } + }, + "id": "/subscriptions/594038b5-1093-476e-a366-482775671c11/resourcegroups/oiautorest6685/providers/microsoft.operationalinsights/clusters/oiautorest6685", + "identity": { + "principalId": "356d057d-cba5-44dd-8a30-b2e547bc416b", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "sku": { + "name": "CapacityReservation", + "capacity": 1000 + }, + "name": "oiautorest6685", + "type": "Microsoft.OperationalInsights/clusters", + "location": "australiasoutheast" + } + } + } +} diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/ClustersDelete.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/ClustersDelete.json new file mode 100644 index 000000000000..2bdd152922a4 --- /dev/null +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/ClustersDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "resourceGroupName": "oiautorest6685", + "clusterName": "oiautorest6685", + "api-version": "2020-10-01", + "subscriptionId": "00000000-0000-0000-0000-00000000000" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/ClustersGet.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/ClustersGet.json new file mode 100644 index 000000000000..145f77b34aa5 --- /dev/null +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/ClustersGet.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "resourceGroupName": "oiautorest6685", + "clusterName": "oiautorest6685", + "api-version": "2020-10-01", + "subscriptionId": "00000000-0000-0000-0000-00000000000" + }, + "responses": { + "200": { + "body": [ + { + "properties": { + "keyVaultProperties": { + "keyVaultUri": "https://aztest2170.vault.azure.net", + "keyName": "aztest2170cert", + "keyVersion": "654ft6c4e63845cbb50fd6fg51540429" + }, + "provisioningState": "Succeeded", + "clusterId": "1c3f2afc-9ec1-4e74-bfe8-022b83bcd7b1", + "billingType": "Cluster", + "lastModifiedDate": "Sun, 04 Jan 2020 17:10:56 GMT", + "createdDate": "Mon, 13 Jan 2020 14:40:33 GMT", + "isDoubleEncryptionEnabled": false, + "isAvailabilityZonesEnabled": false, + "associatedWorkspaces": [ + { + "workspaceId": "942bdefd-e6c9-411c-ac69-70ffad564363", + "workspaceName": "testWs1", + "resourceId": "/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/testRG/providers/microsoft.operationalinsights/workspaces/testWs1", + "associateDate": "Tue, 07 Jul 2020 07:35:51 GMT" + }, + { + "workspaceId": "c7edb8f8-67f7-41f2-bddb-aecf22507e3f", + "workspaceName": "testWs2", + "resourceId": "/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/testRG/providers/microsoft.operationalinsights/workspaces/testWs2", + "associateDate": "Mon, 13 Jan 2020 16:03:39 GMT" + } + ], + "capacityReservationProperties": { + "lastSkuUpdate": "Thu, 01 Jan 1970 00:00:00 GMT", + "minCapacity": 1000 + } + }, + "id": "/subscriptions/594038b5-1093-476e-a366-482775671c11/resourcegroups/calbot-rg/providers/microsoft.operationalinsights/clusters/testresourcelock", + "identity": { + "principalId": "356d057d-cba5-44dd-8a30-b2e547bc416b", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "sku": { + "name": "CapacityReservation", + "capacity": 1000 + }, + "name": "TestResourceLock", + "type": "Microsoft.OperationalInsights/clusters", + "location": "eastus" + } + ] + } + } +} diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/ClustersListByResourceGroup.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/ClustersListByResourceGroup.json new file mode 100644 index 000000000000..1bad17bc3eba --- /dev/null +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/ClustersListByResourceGroup.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "resourceGroupName": "oiautorest6685", + "api-version": "2020-10-01", + "subscriptionId": "00000000-0000-0000-0000-00000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "keyVaultProperties": { + "keyVaultUri": "https://aztest2170.vault.azure.net", + "keyName": "aztest2170cert", + "keyVersion": "654ft6c4e63845cbb50fd6fg51540429" + }, + "provisioningState": "Succeeded", + "clusterId": "5b02755b-5bf4-430c-9487-45502a2a7e62" + }, + "sku": { + "name": "CapacityReservation", + "capacity": 1000 + }, + "id": "/subscriptions/594038b5-1093-476e-a366-482775671c11/resourcegroups/calbot-rg/providers/microsoft.operationalinsights/clusters/testresourcelock", + "identity": { + "principalId": "356d057d-cba5-44dd-8a30-b2e547bc416b", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "name": "TestResourceLock", + "type": "Microsoft.OperationalInsights/clusters", + "location": "eastus" + } + ] + } + } + } +} diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/ClustersSubscriptionList.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/ClustersSubscriptionList.json new file mode 100644 index 000000000000..c0c3538ee698 --- /dev/null +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/ClustersSubscriptionList.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2020-10-01", + "subscriptionId": "00000000-0000-0000-0000-00000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "keyVaultProperties": { + "keyVaultUri": "https://aztest2170.vault.azure.net", + "keyName": "aztest2170cert", + "keyVersion": "654ft6c4e63845cbb50fd6fg51540429" + }, + "provisioningState": "Succeeded", + "clusterId": "5b02755b-5bf4-430c-9487-45502a2a7e62" + }, + "sku": { + "name": "CapacityReservation", + "capacity": 1000 + }, + "id": "/subscriptions/594038b5-1093-476e-a366-482775671c11/resourcegroups/calbot-rg/providers/microsoft.operationalinsights/clusters/testresourcelock", + "identity": { + "principalId": "356d057d-cba5-44dd-8a30-b2e547bc416b", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "name": "TestResourceLock", + "type": "Microsoft.OperationalInsights/clusters", + "location": "eastus" + } + ] + } + } + } +} diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/ClustersUpdate.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/ClustersUpdate.json new file mode 100644 index 000000000000..a7ebeca9695f --- /dev/null +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/ClustersUpdate.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "resourceGroupName": "oiautorest6685", + "clusterName": "oiautorest6685", + "parameters": { + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/oiautorest6685/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity": {} + } + }, + "properties": { + "keyVaultProperties": { + "keyVaultUri": "https://aztest2170.vault.azure.net", + "keyName": "aztest2170cert", + "keyVersion": "654ft6c4e63845cbb50fd6fg51540429", + "keyRsaSize": 1024 + } + }, + "sku": { + "name": "CapacityReservation", + "capacity": 1000 + }, + "tags": { + "tag1": "val1" + } + }, + "api-version": "2020-10-01", + "subscriptionId": "00000000-0000-0000-0000-00000000000" + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "UserAssigned", + "tenantId": "72f999bf-acf1-41af-91ab-2d7cd011db47", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/oiautorest6685/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity": { + "clientId": "eb3a943d-6b12-48a6-b585-ac2316e15ab2", + "principalId": "b31776d4-ee80-4860-9433-ec0101be1891" + } + } + }, + "properties": { + "keyVaultProperties": { + "keyVaultUri": "https://aztest2170.vault.azure.net", + "keyName": "aztest2170cert", + "keyVersion": "654ft6c4e63845cbb50fd6fg51540429" + }, + "provisioningState": "Succeeded", + "clusterId": "1c3f2afc-9ec1-4e74-bfe8-022b83bcd7b1", + "billingType": "Cluster", + "lastModifiedDate": "Sun, 04 Jan 2020 17:10:56 GMT", + "createdDate": "Mon, 13 Jan 2020 14:40:33 GMT", + "associatedWorkspaces": [ + { + "workspaceId": "942bdefd-e6c9-411c-ac69-70ffad564363", + "workspaceName": "testWs1", + "resourceId": "/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/testRG/providers/microsoft.operationalinsights/workspaces/testWs1", + "associateDate": "Tue, 07 Jul 2020 07:35:51 GMT" + }, + { + "workspaceId": "c7edb8f8-67f7-41f2-bddb-aecf22507e3f", + "workspaceName": "testWs2", + "resourceId": "/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/testRG/providers/microsoft.operationalinsights/workspaces/testWs2", + "associateDate": "Mon, 13 Jan 2020 16:03:39 GMT" + } + ], + "capacityReservationProperties": { + "lastSkuUpdate": "Thu, 01 Jan 1970 00:00:00 GMT", + "minCapacity": 1000 + } + }, + "sku": { + "name": "CapacityReservation", + "capacity": 1000 + }, + "location": "australiasoutheast", + "tags": { + "tag1": "val1" + } + } + } + } +} diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/WorkspacesCreate.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/WorkspacesCreate.json new file mode 100644 index 000000000000..a866c2dcff7c --- /dev/null +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/WorkspacesCreate.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "resourceGroupName": "oiautorest6685", + "workspaceName": "oiautorest6685", + "parameters": { + "properties": { + "sku": { + "name": "PerGB2018" + }, + "retentionInDays": 30 + }, + "location": "australiasoutheast", + "tags": { + "tag1": "val1" + } + }, + "api-version": "2020-10-01", + "subscriptionId": "00000000-0000-0000-0000-00000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourcegroups/oiautorest6685/providers/microsoft.operationalinsights/workspaces/aztest2170", + "name": "AzTest2170", + "type": "Microsoft.OperationalInsights/workspaces", + "location": "australiasoutheast", + "tags": { + "tag1": "val1" + }, + "properties": { + "customerId": "bc089d7b-485c-4aff-a71e-c00f362d8d2f", + "provisioningState": "Creating", + "sku": { + "name": "PerGB2018" + }, + "retentionInDays": 30, + "publicNetworkAccessForQuery": "Enabled", + "publicNetworkAccessForIngestion": "Enabled" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourcegroups/oiautorest6685/providers/microsoft.operationalinsights/workspaces/aztest2170", + "name": "AzTest2170", + "type": "Microsoft.OperationalInsights/workspaces", + "location": "australiasoutheast", + "tags": { + "tag1": "val1" + }, + "properties": { + "customerId": "bc089d7b-485c-4aff-a71e-c00f362d8d2f", + "provisioningState": "Creating", + "sku": { + "name": "PerGB2018" + }, + "retentionInDays": 30, + "publicNetworkAccessForQuery": "Enabled", + "publicNetworkAccessForIngestion": "Enabled" + } + } + }, + "202": {} + } +} diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/WorkspacesDelete.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/WorkspacesDelete.json new file mode 100644 index 000000000000..036cbf224db8 --- /dev/null +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/WorkspacesDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "resourceGroupName": "oiautorest6685", + "workspaceName": "oiautorest6685", + "api-version": "2020-10-01", + "subscriptionId": "00000000-0000-0000-0000-00000000000" + }, + "responses": { + "200": {}, + "204": {}, + "202": {} + } +} diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/WorkspacesGet.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/WorkspacesGet.json new file mode 100644 index 000000000000..33424f2aa6ca --- /dev/null +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/WorkspacesGet.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "resourceGroupName": "oiautorest6685", + "workspaceName": "oiautorest6685", + "api-version": "2020-10-01", + "subscriptionId": "00000000-0000-0000-0000-00000000000" + }, + "responses": { + "200": { + "body": [ + { + "properties": { + "customerId": "5b02755b-5bf4-430c-9487-45502a2a7e62", + "provisioningState": "Succeeded", + "sku": { + "name": "free" + }, + "retentionInDays": 30, + "publicNetworkAccessForQuery": "Enabled", + "publicNetworkAccessForIngestion": "Enabled" + }, + "id": "/subscriptions/594038b5-1093-476e-a366-482775671c11/resourcegroups/calbot-rg/providers/microsoft.operationalinsights/workspaces/testresourcelock", + "name": "TestResourceLock", + "type": "Microsoft.OperationalInsights/workspaces", + "location": "eastus" + }, + { + "properties": { + "customerId": "4884a2fd-b08f-4aa6-bf16-5757df1093fe", + "provisioningState": "Succeeded", + "sku": { + "name": "free" + }, + "retentionInDays": 30, + "publicNetworkAccessForQuery": "Enabled", + "publicNetworkAccessForIngestion": "Enabled" + }, + "id": "/subscriptions/594038b5-1093-476e-a366-482775671c11/resourcegroups/mms-eus/providers/microsoft.operationalinsights/workspaces/southukws", + "name": "SouthUKWS", + "type": "Microsoft.OperationalInsights/workspaces", + "location": "East US" + } + ] + } + } +} diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/WorkspacesListByResourceGroup.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/WorkspacesListByResourceGroup.json new file mode 100644 index 000000000000..bf91f106607c --- /dev/null +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/WorkspacesListByResourceGroup.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "resourceGroupName": "oiautorest6685", + "api-version": "2020-10-01", + "subscriptionId": "00000000-0000-0000-0000-00000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "customerId": "bc089d7b-485c-4aff-a71e-c00f362d8d2f", + "provisioningState": "Succeeded", + "sku": { + "name": "PerGB2018" + }, + "retentionInDays": 30, + "publicNetworkAccessForQuery": "Enabled", + "publicNetworkAccessForIngestion": "Enabled" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourcegroups/oiautorest6685/providers/microsoft.operationalinsights/workspaces/aztest2170", + "name": "AzTest2170", + "type": "Microsoft.OperationalInsights/workspaces", + "location": "australiasoutheast", + "tags": { + "tag1": "val1" + } + } + ] + } + } + } +} diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/WorkspacesSubscriptionList.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/WorkspacesSubscriptionList.json new file mode 100644 index 000000000000..773230b84566 --- /dev/null +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/WorkspacesSubscriptionList.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2020-10-01", + "subscriptionId": "00000000-0000-0000-0000-00000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "customerId": "bc089d7b-485c-4aff-a71e-c00f362d8d2f", + "provisioningState": "Succeeded", + "sku": { + "name": "PerGB2018" + }, + "retentionInDays": 30, + "publicNetworkAccessForQuery": "Enabled", + "publicNetworkAccessForIngestion": "Enabled" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourcegroups/oiautorest6685/providers/microsoft.operationalinsights/workspaces/aztest2170", + "name": "AzTest2170", + "type": "Microsoft.OperationalInsights/workspaces", + "location": "australiasoutheast", + "tags": { + "tag1": "val1" + } + } + ] + } + } + } +} diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/WorkspacesUpdate.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/WorkspacesUpdate.json new file mode 100644 index 000000000000..37a38e7101de --- /dev/null +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/examples/WorkspacesUpdate.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "resourceGroupName": "oiautorest6685", + "workspaceName": "oiautorest6685", + "parameters": { + "properties": { + "sku": { + "name": "PerGB2018" + }, + "retentionInDays": 30, + "workspaceCapping": { + "dailyQuotaGb": -1 + } + } + }, + "api-version": "2020-10-01", + "subscriptionId": "00000000-0000-0000-0000-00000000000" + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": { + "name": "PerGB2018" + }, + "retentionInDays": 30, + "publicNetworkAccessForQuery": "Enabled", + "publicNetworkAccessForIngestion": "Enabled", + "workspaceCapping": { + "dailyQuotaGb": -1, + "quotaNextResetTime": "Mon, 16 Nov 2020 15:00:00 GMT", + "dataIngestionStatus": "RespectQuota" + } + }, + "location": "australiasoutheast", + "tags": { + "tag1": "val1" + } + } + } + } +} diff --git a/specification/operationalinsights/resource-manager/readme.md b/specification/operationalinsights/resource-manager/readme.md index eb2b5381d8f7..ae18c5caa738 100644 --- a/specification/operationalinsights/resource-manager/readme.md +++ b/specification/operationalinsights/resource-manager/readme.md @@ -174,6 +174,32 @@ input-file: - Microsoft.OperationalInsights/stable/2020-10-01/Workspaces.json ``` +### Tag: package-2021-06 + +These settings apply only when `--tag=package-2021-06` is specified on the command line. + +``` yaml $(tag) == 'package-2021-06' +input-file: +- Microsoft.OperationalInsights/stable/2020-08-01/DataExports.json +- Microsoft.OperationalInsights/stable/2020-08-01/DataSources.json +- Microsoft.OperationalInsights/stable/2020-08-01/IntelligencePacks.json +- Microsoft.OperationalInsights/stable/2020-08-01/LinkedServices.json +- Microsoft.OperationalInsights/stable/2020-08-01/LinkedStorageAccounts.json +- Microsoft.OperationalInsights/stable/2020-08-01/ManagementGroups.json +- Microsoft.OperationalInsights/stable/2020-08-01/OperationStatuses.json +- Microsoft.OperationalInsights/stable/2020-08-01/SharedKeys.json +- Microsoft.OperationalInsights/stable/2020-08-01/Usages.json +- Microsoft.OperationalInsights/stable/2020-08-01/StorageInsightConfigs.json +- Microsoft.OperationalInsights/stable/2020-08-01/SavedSearches.json +- Microsoft.OperationalInsights/stable/2020-08-01/AvailableServiceTiers.json +- Microsoft.OperationalInsights/stable/2020-08-01/Gateways.json +- Microsoft.OperationalInsights/stable/2020-08-01/Schema.json +- Microsoft.OperationalInsights/stable/2020-08-01/SharedKeys.json +- Microsoft.OperationalInsights/stable/2020-08-01/WorkspacePurge.json +- Microsoft.OperationalInsights/stable/2020-10-01/Operations.json +- Microsoft.OperationalInsights/stable/2021-06-01/Clusters.json +- Microsoft.OperationalInsights/stable/2021-06-01/Workspaces.json +``` --- # Code Generation diff --git a/specification/operationsmanagement/resource-manager/readme.md b/specification/operationsmanagement/resource-manager/readme.md index 2cd43ca75691..582250ff458a 100644 --- a/specification/operationsmanagement/resource-manager/readme.md +++ b/specification/operationsmanagement/resource-manager/readme.md @@ -58,7 +58,7 @@ swagger-to-sdk: - repo: azure-sdk-for-go - repo: azure-sdk-for-js - repo: azure-sdk-for-node - - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 - repo: azure-cli-extensions - repo: azure-resource-manager-schemas ``` diff --git a/specification/operationsmanagement/resource-manager/readme.python.md b/specification/operationsmanagement/resource-manager/readme.python.md index 9eb64a8b4bd4..17e537b8ce98 100644 --- a/specification/operationsmanagement/resource-manager/readme.python.md +++ b/specification/operationsmanagement/resource-manager/readme.python.md @@ -4,36 +4,16 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.operationsmanagement - package-name: azure-mgmt-operationsmanagement - package-version: 0.1.0 - clear-output-folder: true -``` -``` yaml $(python) && $(track2) +``` yaml $(python) python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.operationsmanagement package-name: azure-mgmt-operationsmanagement -package-version: 0.1.0 +package-version: 1.0.0b1 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/operationsmanagement/azure-mgmt-operationsmanagement/azure/mgmt/operationsmanagement -``` -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/operationsmanagement/azure-mgmt-operationsmanagement -``` + ``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/operationsmanagement/azure-mgmt-operationsmanagement/azure/mgmt/operationsmanagement diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-01-01/peering.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-01-01/peering.json index 652e7b1eddf3..0d0f595e9d3f 100644 --- a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-01-01/peering.json +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-01-01/peering.json @@ -422,7 +422,8 @@ "Cdn", "Internal", "Ix", - "IxRs" + "IxRs", + "Voice" ] }, { @@ -2259,7 +2260,8 @@ "Cdn", "Internal", "Ix", - "IxRs" + "IxRs", + "Voice" ], "type": "string", "x-ms-enum": { @@ -2790,7 +2792,8 @@ "Cdn", "Internal", "Ix", - "IxRs" + "IxRs", + "Voice" ], "type": "string", "x-ms-enum": { diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/CheckServiceProviderAvailability.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/CheckServiceProviderAvailability.json new file mode 100644 index 000000000000..f2f8933f0aee --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/CheckServiceProviderAvailability.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "subId", + "api-version": "2021-06-01", + "checkServiceProviderAvailabilityInput": { + "peeringServiceLocation": "peeringServiceLocation1", + "peeringServiceProvider": "peeringServiceProvider1" + } + }, + "responses": { + "200": { + "body": "Available" + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/CreateDirectPeering.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/CreateDirectPeering.json new file mode 100644 index 000000000000..99abeaf4a45e --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/CreateDirectPeering.json @@ -0,0 +1,173 @@ +{ + "parameters": { + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "peeringName": "peeringName", + "api-version": "2021-06-01", + "peering": { + "sku": { + "name": "Basic_Direct_Free" + }, + "kind": "Direct", + "properties": { + "direct": { + "connections": [ + { + "bandwidthInMbps": 10000, + "sessionAddressProvider": "Peer", + "useForPeeringService": false, + "peeringDBFacilityId": 99999, + "bgpSession": { + "sessionPrefixV4": "192.168.0.0/31", + "sessionPrefixV6": "fd00::0/127", + "maxPrefixesAdvertisedV4": 1000, + "maxPrefixesAdvertisedV6": 100, + "md5AuthenticationKey": "test-md5-auth-key" + }, + "connectionIdentifier": "5F4CB5C7-6B43-4444-9338-9ABC72606C16" + }, + { + "bandwidthInMbps": 10000, + "sessionAddressProvider": "Microsoft", + "useForPeeringService": true, + "peeringDBFacilityId": 99999, + "connectionIdentifier": "8AB00818-D533-4504-A25A-03A17F61201C" + } + ], + "peerAsn": { + "id": "/subscriptions/subId/providers/Microsoft.Peering/peerAsns/myAsn1" + }, + "directPeeringType": "Edge" + }, + "peeringLocation": "peeringLocation0" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Basic_Direct_Free", + "tier": "Basic", + "family": "Direct", + "size": "Free" + }, + "kind": "Direct", + "properties": { + "direct": { + "connections": [ + { + "bandwidthInMbps": 10000, + "provisionedBandwidthInMbps": 10000, + "sessionAddressProvider": "Peer", + "useForPeeringService": false, + "microsoftTrackingId": "test-microsoft-reference-id-1", + "peeringDBFacilityId": 99999, + "connectionState": "ProvisioningFailed", + "bgpSession": { + "sessionPrefixV4": "192.168.0.0/31", + "sessionPrefixV6": "fd00::0/127", + "sessionStateV4": "Established", + "sessionStateV6": "Established", + "maxPrefixesAdvertisedV4": 1000, + "maxPrefixesAdvertisedV6": 100, + "md5AuthenticationKey": "test-md5-auth-key" + }, + "connectionIdentifier": "5F4CB5C7-6B43-4444-9338-9ABC72606C16", + "errorMessage": "IPv4 address is already configured with a different ASN" + }, + { + "bandwidthInMbps": 10000, + "provisionedBandwidthInMbps": 10000, + "sessionAddressProvider": "Microsoft", + "useForPeeringService": true, + "microsoftTrackingId": "test-microsoft-reference-id-2", + "peeringDBFacilityId": 99999, + "connectionState": "Active", + "bgpSession": { + "sessionPrefixV4": "192.168.1.0/31", + "sessionPrefixV6": "fd00::2/127", + "sessionStateV4": "Established", + "sessionStateV6": "Established", + "maxPrefixesAdvertisedV4": 1000, + "maxPrefixesAdvertisedV6": 100, + "md5AuthenticationKey": "test-md5-auth-key" + }, + "connectionIdentifier": "8AB00818-D533-4504-A25A-03A17F61201C" + } + ], + "useForPeeringService": true, + "peerAsn": { + "id": "/subscriptions/subId/providers/Microsoft.Peering/peerAsns/myAsn1" + }, + "directPeeringType": "Edge" + }, + "peeringLocation": "peeringLocation0", + "provisioningState": "Succeeded" + }, + "location": "eastus", + "name": "peeringName", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peerings/peeringName", + "type": "Microsoft.Peering/peerings" + } + }, + "201": { + "body": { + "sku": { + "name": "Basic_Direct_Free", + "tier": "Basic", + "family": "Direct", + "size": "Free" + }, + "kind": "Direct", + "properties": { + "direct": { + "connections": [ + { + "bandwidthInMbps": 10000, + "provisionedBandwidthInMbps": 0, + "sessionAddressProvider": "Peer", + "useForPeeringService": false, + "microsoftTrackingId": "test-microsoft-reference-id-1", + "peeringDBFacilityId": 99999, + "connectionState": "PendingApproval", + "bgpSession": { + "sessionPrefixV4": "192.168.0.0/31", + "sessionPrefixV6": "fd00::0/127", + "sessionStateV4": "PendingAdd", + "sessionStateV6": "PendingAdd", + "maxPrefixesAdvertisedV4": 1000, + "maxPrefixesAdvertisedV6": 100, + "md5AuthenticationKey": "test-md5-auth-key" + }, + "connectionIdentifier": "5F4CB5C7-6B43-4444-9338-9ABC72606C16" + }, + { + "bandwidthInMbps": 10000, + "provisionedBandwidthInMbps": 0, + "sessionAddressProvider": "Microsoft", + "useForPeeringService": true, + "microsoftTrackingId": "test-microsoft-reference-id-2", + "peeringDBFacilityId": 99999, + "connectionState": "PendingApproval", + "connectionIdentifier": "8AB00818-D533-4504-A25A-03A17F61201C" + } + ], + "useForPeeringService": true, + "peerAsn": { + "id": "/subscriptions/subId/providers/Microsoft.Peering/peerAsns/myAsn1" + }, + "directPeeringType": "Edge" + }, + "peeringLocation": "peeringLocation0", + "provisioningState": "Succeeded" + }, + "location": "eastus", + "name": "peeringName", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peerings/peeringName", + "type": "Microsoft.Peering/peerings" + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/CreateExchangePeering.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/CreateExchangePeering.json new file mode 100644 index 000000000000..a5b03ec61561 --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/CreateExchangePeering.json @@ -0,0 +1,166 @@ +{ + "parameters": { + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "peeringName": "peeringName", + "api-version": "2021-06-01", + "peering": { + "sku": { + "name": "Basic_Exchange_Free" + }, + "kind": "Exchange", + "properties": { + "exchange": { + "connections": [ + { + "peeringDBFacilityId": 99999, + "bgpSession": { + "peerSessionIPv4Address": "192.168.2.1", + "peerSessionIPv6Address": "fd00::1", + "maxPrefixesAdvertisedV4": 1000, + "maxPrefixesAdvertisedV6": 100, + "md5AuthenticationKey": "test-md5-auth-key" + }, + "connectionIdentifier": "CE495334-0E94-4E51-8164-8116D6CD284D" + }, + { + "peeringDBFacilityId": 99999, + "bgpSession": { + "peerSessionIPv4Address": "192.168.2.2", + "peerSessionIPv6Address": "fd00::2", + "maxPrefixesAdvertisedV4": 1000, + "maxPrefixesAdvertisedV6": 100, + "md5AuthenticationKey": "test-md5-auth-key" + }, + "connectionIdentifier": "CDD8E673-CB07-47E6-84DE-3739F778762B" + } + ], + "peerAsn": { + "id": "/subscriptions/subId/providers/Microsoft.Peering/peerAsns/myAsn1" + } + }, + "peeringLocation": "peeringLocation0" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Basic_Exchange_Free", + "tier": "Basic", + "family": "Exchange", + "size": "Free" + }, + "kind": "Exchange", + "properties": { + "exchange": { + "connections": [ + { + "peeringDBFacilityId": 99999, + "connectionState": "ProvisioningFailed", + "bgpSession": { + "microsoftSessionIPv4Address": "192.168.3.1", + "microsoftSessionIPv6Address": "fd00::1:1", + "peerSessionIPv4Address": "192.168.2.1", + "peerSessionIPv6Address": "fd00::1", + "sessionStateV4": "Established", + "sessionStateV6": "Established", + "maxPrefixesAdvertisedV4": 1000, + "maxPrefixesAdvertisedV6": 100, + "md5AuthenticationKey": "test-md5-auth-key" + }, + "connectionIdentifier": "CE495334-0E94-4E51-8164-8116D6CD284D", + "errorMessage": "IPv4 address is already configured with a different ASN" + }, + { + "peeringDBFacilityId": 99999, + "connectionState": "Active", + "bgpSession": { + "microsoftSessionIPv4Address": "192.168.3.2", + "microsoftSessionIPv6Address": "fd00::1:2", + "peerSessionIPv4Address": "192.168.2.2", + "peerSessionIPv6Address": "fd00::2", + "sessionStateV4": "Established", + "sessionStateV6": "Established", + "maxPrefixesAdvertisedV4": 1000, + "maxPrefixesAdvertisedV6": 100, + "md5AuthenticationKey": "test-md5-auth-key" + }, + "connectionIdentifier": "CDD8E673-CB07-47E6-84DE-3739F778762B" + } + ], + "peerAsn": { + "id": "/subscriptions/subId/providers/Microsoft.Peering/peerAsns/myAsn1" + } + }, + "peeringLocation": "peeringLocation0", + "provisioningState": "Succeeded" + }, + "location": "eastus", + "name": "peeringName", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peerings/peeringName", + "type": "Microsoft.Peering/peerings" + } + }, + "201": { + "body": { + "sku": { + "name": "Basic_Exchange_Free", + "tier": "Basic", + "family": "Exchange", + "size": "Free" + }, + "kind": "Exchange", + "properties": { + "exchange": { + "connections": [ + { + "peeringDBFacilityId": 99999, + "connectionState": "PendingApproval", + "bgpSession": { + "microsoftSessionIPv4Address": "192.168.3.1", + "microsoftSessionIPv6Address": "fd00::1:1", + "peerSessionIPv4Address": "192.168.2.1", + "peerSessionIPv6Address": "fd00::1", + "sessionStateV4": "PendingAdd", + "sessionStateV6": "PendingAdd", + "maxPrefixesAdvertisedV4": 1000, + "maxPrefixesAdvertisedV6": 100, + "md5AuthenticationKey": "test-md5-auth-key" + }, + "connectionIdentifier": "CE495334-0E94-4E51-8164-8116D6CD284D" + }, + { + "peeringDBFacilityId": 99999, + "connectionState": "PendingApproval", + "bgpSession": { + "microsoftSessionIPv4Address": "192.168.3.2", + "microsoftSessionIPv6Address": "fd00::1:2", + "peerSessionIPv4Address": "192.168.2.2", + "peerSessionIPv6Address": "fd00::2", + "sessionStateV4": "PendingAdd", + "sessionStateV6": "PendingAdd", + "maxPrefixesAdvertisedV4": 1000, + "maxPrefixesAdvertisedV6": 100, + "md5AuthenticationKey": "test-md5-auth-key" + }, + "connectionIdentifier": "CDD8E673-CB07-47E6-84DE-3739F778762B" + } + ], + "peerAsn": { + "id": "/subscriptions/subId/providers/Microsoft.Peering/peerAsns/myAsn1" + } + }, + "peeringLocation": "peeringLocation0", + "provisioningState": "Succeeded" + }, + "location": "eastus", + "name": "peeringName", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peerings/peeringName", + "type": "Microsoft.Peering/peerings" + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/CreateOrUpdateConnectionMonitorTest.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/CreateOrUpdateConnectionMonitorTest.json new file mode 100644 index 000000000000..5681bc52eb40 --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/CreateOrUpdateConnectionMonitorTest.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "peeringServiceName": "peeringServiceName", + "api-version": "2021-06-01", + "connectionMonitorTestName": "connectionMonitorTestName", + "connectionMonitorTest": { + "properties": { + "sourceAgent": "Example Source Agent", + "destination": "Example Destination", + "destinationPort": 443, + "testFrequencyInSec": 30 + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sourceAgent": "Example Source Agent", + "destination": "Example Destination", + "destinationPort": 443, + "testFrequencyInSec": 30, + "isTestSuccessful": false, + "path": [], + "provisioningState": "Succeeded" + }, + "name": "connectionMonitorTestName", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peeringServices/peeringServiceName/connectionMonitorTests/connectionMonitorTestName" + } + }, + "201": { + "body": { + "properties": { + "sourceAgent": "Example Source Agent", + "destination": "Example Destination", + "destinationPort": 443, + "testFrequencyInSec": 30, + "isTestSuccessful": false, + "path": [], + "provisioningState": "Succeeded" + }, + "name": "connectionMonitorTestName", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peeringServices/peeringServiceName/connectionMonitorTests/connectionMonitorTestName" + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/CreatePeerAsn.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/CreatePeerAsn.json new file mode 100644 index 000000000000..725fd6b5c2cc --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/CreatePeerAsn.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "subscriptionId": "subId", + "peerAsnName": "peerAsnName", + "api-version": "2021-06-01", + "peerAsn": { + "properties": { + "peerAsn": 65000, + "peerContactDetail": [ + { + "role": "Noc", + "email": "noc@contoso.com", + "phone": "+1 (234) 567-8999" + }, + { + "role": "Policy", + "email": "abc@contoso.com", + "phone": "+1 (234) 567-8900" + }, + { + "role": "Technical", + "email": "xyz@contoso.com", + "phone": "+1 (234) 567-8900" + } + ], + "peerName": "Contoso" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "peerAsn": 65000, + "peerContactDetail": [ + { + "role": "Noc", + "email": "noc@contoso.com", + "phone": "+1 (234) 567-8999" + }, + { + "role": "Policy", + "email": "abc@contoso.com", + "phone": "+1 (234) 567-8900" + }, + { + "role": "Technical", + "email": "xyz@contoso.com", + "phone": "+1 (234) 567-8900" + } + ], + "peerName": "Contoso", + "validationState": "Pending" + }, + "name": "peerAsnName", + "id": "/subscriptions/subId/providers/Microsoft.Peering/peerAsns/peerAsnName", + "type": "Microsoft.Peering/peerAsns" + } + }, + "201": { + "body": { + "properties": { + "peerAsn": 65000, + "peerContactDetail": [ + { + "role": "Noc", + "email": "noc@contoso.com", + "phone": "+1 (234) 567-8999" + }, + { + "role": "Policy", + "email": "abc@contoso.com", + "phone": "+1 (234) 567-8900" + }, + { + "role": "Technical", + "email": "xyz@contoso.com", + "phone": "+1 (234) 567-8900" + } + ], + "peerName": "Contoso", + "validationState": "Pending" + }, + "name": "peerAsnName", + "id": "/subscriptions/subId/providers/Microsoft.Peering/peerAsns/peerAsnName", + "type": "Microsoft.Peering/peerAsns" + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/CreatePeeringService.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/CreatePeeringService.json new file mode 100644 index 000000000000..1979fc4786df --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/CreatePeeringService.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "peeringServiceName": "peeringServiceName", + "api-version": "2021-06-01", + "peeringService": { + "properties": { + "peeringServiceLocation": "state1", + "peeringServiceProvider": "serviceProvider1", + "providerPrimaryPeeringLocation": "peeringLocation1", + "providerBackupPeeringLocation": "peeringLocation2" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "peeringServiceLocation": "state1", + "peeringServiceProvider": "serviceProvider1", + "provisioningState": "Succeeded", + "providerPrimaryPeeringLocation": "peeringLocation1", + "providerBackupPeeringLocation": "peeringLocation2" + }, + "location": "eastus", + "name": "peeringServiceName", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peeringServices/peeringServiceName", + "type": "Microsoft.Peering/peeringServices" + } + }, + "201": { + "body": { + "properties": { + "peeringServiceLocation": "state1", + "peeringServiceProvider": "serviceProvider1", + "provisioningState": "Succeeded", + "providerPrimaryPeeringLocation": "peeringLocation1", + "providerBackupPeeringLocation": "peeringLocation2" + }, + "location": "eastus", + "name": "peeringServiceName", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peeringServices/peeringServiceName", + "type": "Microsoft.Peering/peeringServices" + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/CreatePeeringServicePrefix.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/CreatePeeringServicePrefix.json new file mode 100644 index 000000000000..8e7a6933b385 --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/CreatePeeringServicePrefix.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "peeringServiceName": "peeringServiceName", + "prefixName": "peeringServicePrefixName", + "api-version": "2021-06-01", + "peeringServicePrefix": { + "properties": { + "prefix": "192.168.1.0/24", + "peeringServicePrefixKey": "00000000-0000-0000-0000-000000000000" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "prefix": "192.168.1.0/24", + "prefixValidationState": "Failed", + "learnedType": "None", + "errorMessage": "Prefix is not announced by the service provider to Microsoft.", + "peeringServicePrefixKey": "00000000-0000-0000-0000-000000000000", + "provisioningState": "Succeeded" + }, + "name": "peeringServicePrefixName", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peeringServices/peeringServiceName/prefixes/peeringServicePrefixName" + } + }, + "201": { + "body": { + "properties": { + "prefix": "192.168.1.0/24", + "prefixValidationState": "Failed", + "learnedType": "None", + "errorMessage": "Prefix is not announced by the service provider to Microsoft.", + "peeringServicePrefixKey": "00000000-0000-0000-0000-000000000000", + "provisioningState": "Succeeded" + }, + "name": "peeringServicePrefixName", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peeringServices/peeringServiceName/prefixes/peeringServicePrefixName" + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/CreatePeeringWithExchangeRouteServer.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/CreatePeeringWithExchangeRouteServer.json new file mode 100644 index 000000000000..44b305ae9296 --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/CreatePeeringWithExchangeRouteServer.json @@ -0,0 +1,134 @@ +{ + "parameters": { + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "peeringName": "peeringName", + "api-version": "2021-06-01", + "peering": { + "sku": { + "name": "Premium_Direct_Free" + }, + "kind": "Direct", + "properties": { + "direct": { + "connections": [ + { + "bandwidthInMbps": 10000, + "sessionAddressProvider": "Peer", + "useForPeeringService": true, + "peeringDBFacilityId": 99999, + "bgpSession": { + "sessionPrefixV4": "192.168.0.0/24", + "microsoftSessionIPv4Address": "192.168.0.123", + "peerSessionIPv4Address": "192.168.0.234", + "maxPrefixesAdvertisedV4": 1000, + "maxPrefixesAdvertisedV6": 100 + }, + "connectionIdentifier": "5F4CB5C7-6B43-4444-9338-9ABC72606C16" + } + ], + "peerAsn": { + "id": "/subscriptions/subId/providers/Microsoft.Peering/peerAsns/myAsn1" + }, + "directPeeringType": "IxRs" + }, + "peeringLocation": "peeringLocation0" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Premium_Direct_Free", + "tier": "Premium", + "family": "Direct", + "size": "Free" + }, + "kind": "Direct", + "properties": { + "direct": { + "connections": [ + { + "bandwidthInMbps": 10000, + "provisionedBandwidthInMbps": 10000, + "sessionAddressProvider": "Peer", + "useForPeeringService": true, + "peeringDBFacilityId": 99999, + "connectionState": "Active", + "bgpSession": { + "sessionPrefixV4": "192.168.0.0/24", + "microsoftSessionIPv4Address": "192.168.0.123", + "peerSessionIPv4Address": "192.168.0.234", + "sessionStateV4": "Established", + "sessionStateV6": "Established", + "maxPrefixesAdvertisedV4": 1000, + "maxPrefixesAdvertisedV6": 100 + }, + "connectionIdentifier": "5F4CB5C7-6B43-4444-9338-9ABC72606C16" + } + ], + "useForPeeringService": true, + "peerAsn": { + "id": "/subscriptions/subId/providers/Microsoft.Peering/peerAsns/myAsn1" + }, + "directPeeringType": "IxRs" + }, + "peeringLocation": "peeringLocation0", + "provisioningState": "Succeeded" + }, + "location": "eastus", + "name": "peeringName", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peerings/peeringName", + "type": "Microsoft.Peering/peerings" + } + }, + "201": { + "body": { + "sku": { + "name": "Premium_Direct_Free", + "tier": "Premium", + "family": "Direct", + "size": "Free" + }, + "kind": "Direct", + "properties": { + "direct": { + "connections": [ + { + "bandwidthInMbps": 10000, + "provisionedBandwidthInMbps": 0, + "sessionAddressProvider": "Peer", + "useForPeeringService": true, + "peeringDBFacilityId": 99999, + "connectionState": "PendingApproval", + "bgpSession": { + "sessionPrefixV4": "192.168.0.0/24", + "microsoftSessionIPv4Address": "192.168.0.123", + "peerSessionIPv4Address": "192.168.0.234", + "sessionStateV4": "PendingAdd", + "sessionStateV6": "PendingAdd", + "maxPrefixesAdvertisedV4": 1000, + "maxPrefixesAdvertisedV6": 100 + }, + "connectionIdentifier": "5F4CB5C7-6B43-4444-9338-9ABC72606C16" + } + ], + "useForPeeringService": true, + "peerAsn": { + "id": "/subscriptions/subId/providers/Microsoft.Peering/peerAsns/myAsn1" + }, + "directPeeringType": "IxRs" + }, + "peeringLocation": "peeringLocation0", + "provisioningState": "Succeeded" + }, + "location": "eastus", + "name": "peeringName", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peerings/peeringName", + "type": "Microsoft.Peering/peerings" + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/CreateRegisteredAsn.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/CreateRegisteredAsn.json new file mode 100644 index 000000000000..dd7188bb7fb1 --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/CreateRegisteredAsn.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "peeringName": "peeringName", + "api-version": "2021-06-01", + "registeredAsn": { + "properties": { + "asn": 65000 + } + }, + "registeredAsnName": "registeredAsnName" + }, + "responses": { + "200": { + "body": { + "properties": { + "asn": 65000, + "peeringServicePrefixKey": "00000000-0000-0000-0000-000000000000", + "provisioningState": "Succeeded" + }, + "name": "registeredAsnName", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peerings/peeringName/registeredAsns/registeredAsnName", + "type": "Microsoft.Peering/registeredAsns" + } + }, + "201": { + "body": { + "properties": { + "asn": 65000, + "peeringServicePrefixKey": "00000000-0000-0000-0000-000000000000", + "provisioningState": "Succeeded" + }, + "name": "registeredAsnName", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peerings/peeringName/registeredAsns/registeredAsnName", + "type": "Microsoft.Peering/registeredAsns" + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/CreateRegisteredPrefix.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/CreateRegisteredPrefix.json new file mode 100644 index 000000000000..8915001485ec --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/CreateRegisteredPrefix.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "peeringName": "peeringName", + "api-version": "2021-06-01", + "registeredPrefix": { + "properties": { + "prefix": "10.22.20.0/24" + } + }, + "registeredPrefixName": "registeredPrefixName" + }, + "responses": { + "200": { + "body": { + "properties": { + "prefix": "10.22.20.0/24", + "prefixValidationState": "Verified", + "peeringServicePrefixKey": "00000000-0000-0000-0000-000000000000", + "provisioningState": "Succeeded" + }, + "name": "registeredPrefixName", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peerings/peeringName/registeredPrefixes/registeredPrefixName", + "type": "Microsoft.Peering/registeredPrefixes" + } + }, + "201": { + "body": { + "properties": { + "prefix": "10.22.20.0/24", + "prefixValidationState": "Pending", + "provisioningState": "Succeeded" + }, + "name": "registeredPrefixName", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peerings/peeringName/registeredPrefixes/registeredPrefixName", + "type": "Microsoft.Peering/registeredPrefixes" + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/DeleteConnectionMonitorTest.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/DeleteConnectionMonitorTest.json new file mode 100644 index 000000000000..e42037f7c214 --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/DeleteConnectionMonitorTest.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "peeringServiceName": "peeringServiceName", + "api-version": "2021-06-01", + "connectionMonitorTestName": "connectionMonitorTestName" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/DeletePeerAsn.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/DeletePeerAsn.json new file mode 100644 index 000000000000..6b13d9e52140 --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/DeletePeerAsn.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "subId", + "peerAsnName": "peerAsnName", + "api-version": "2021-06-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/DeletePeering.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/DeletePeering.json new file mode 100644 index 000000000000..2ee47dac2755 --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/DeletePeering.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "peeringName": "peeringName", + "api-version": "2021-06-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/DeletePeeringService.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/DeletePeeringService.json new file mode 100644 index 000000000000..0870e39cafc1 --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/DeletePeeringService.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "peeringServiceName": "peeringServiceName", + "api-version": "2021-06-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/DeletePeeringServicePrefix.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/DeletePeeringServicePrefix.json new file mode 100644 index 000000000000..59becd8e69d8 --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/DeletePeeringServicePrefix.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "peeringServiceName": "peeringServiceName", + "prefixName": "peeringServicePrefixName", + "api-version": "2021-06-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/DeleteRegisteredAsn.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/DeleteRegisteredAsn.json new file mode 100644 index 000000000000..ab86c2a8dc4e --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/DeleteRegisteredAsn.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "peeringName": "peeringName", + "api-version": "2021-06-01", + "registeredAsnName": "registeredAsnName" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/DeleteRegisteredPrefix.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/DeleteRegisteredPrefix.json new file mode 100644 index 000000000000..2b81fb9f8ee0 --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/DeleteRegisteredPrefix.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "peeringName": "peeringName", + "api-version": "2021-06-01", + "registeredPrefixName": "registeredPrefixName" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/GetConnectionMonitorTest.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/GetConnectionMonitorTest.json new file mode 100644 index 000000000000..bac01237937a --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/GetConnectionMonitorTest.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "peeringServiceName": "peeringServiceName", + "api-version": "2021-06-01", + "connectionMonitorTestName": "connectionMonitorTestName" + }, + "responses": { + "200": { + "body": { + "properties": { + "sourceAgent": "Example Source Agent", + "destination": "Example Destination", + "destinationPort": 443, + "testFrequencyInSec": 30, + "isTestSuccessful": true, + "path": [ + "source", + "hop1", + "hop2", + "destination" + ], + "provisioningState": "Succeeded" + }, + "name": "connectionMonitorTestName", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peeringServices/peeringServiceName/connectionMonitorTests/connectionMonitorTestName" + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/GetPeerAsn.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/GetPeerAsn.json new file mode 100644 index 000000000000..783088715d10 --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/GetPeerAsn.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "subId", + "peerAsnName": "peerAsnName", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "peerAsn": 65000, + "peerContactDetail": [ + { + "role": "Noc", + "email": "noc@contoso.com", + "phone": "+1 (234) 567-8999" + }, + { + "role": "Policy", + "email": "abc@contoso.com", + "phone": "+1 (234) 567-8900" + }, + { + "role": "Technical", + "email": "xyz@contoso.com", + "phone": "+1 (234) 567-8900" + } + ], + "peerName": "Contoso", + "validationState": "Approved" + }, + "name": "peerAsnName", + "id": "/subscriptions/subId/providers/Microsoft.Peering/peerAsns/peerAsnName", + "type": "Microsoft.Peering/peerAsns" + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/GetPeering.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/GetPeering.json new file mode 100644 index 000000000000..127dd4319268 --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/GetPeering.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "peeringName": "peeringName", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Basic_Exchange_Free", + "tier": "Basic", + "family": "Exchange", + "size": "Free" + }, + "kind": "Exchange", + "properties": { + "exchange": { + "connections": [ + { + "peeringDBFacilityId": 99999, + "connectionState": "Active", + "bgpSession": { + "microsoftSessionIPv4Address": "192.168.3.1", + "microsoftSessionIPv6Address": "fd00::1:1", + "peerSessionIPv4Address": "192.168.2.1", + "peerSessionIPv6Address": "fd00::1", + "sessionStateV4": "Established", + "sessionStateV6": "Established", + "maxPrefixesAdvertisedV4": 1000, + "maxPrefixesAdvertisedV6": 100, + "md5AuthenticationKey": "test-md5-auth-key" + }, + "connectionIdentifier": "CE495334-0E94-4E51-8164-8116D6CD284D" + }, + { + "peeringDBFacilityId": 99999, + "connectionState": "Active", + "bgpSession": { + "microsoftSessionIPv4Address": "192.168.3.2", + "microsoftSessionIPv6Address": "fd00::1:2", + "peerSessionIPv4Address": "192.168.2.2", + "peerSessionIPv6Address": "fd00::2", + "sessionStateV4": "Established", + "sessionStateV6": "Established", + "maxPrefixesAdvertisedV4": 1000, + "maxPrefixesAdvertisedV6": 100, + "md5AuthenticationKey": "test-md5-auth-key" + }, + "connectionIdentifier": "CDD8E673-CB07-47E6-84DE-3739F778762B" + } + ], + "peerAsn": { + "id": "/subscriptions/subId/providers/Microsoft.Peering/peerAsns/myAsn1" + } + }, + "peeringLocation": "peeringLocation0", + "provisioningState": "Succeeded" + }, + "location": "eastus", + "name": "peeringName", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peerings/peeringName", + "type": "Microsoft.Peering/peerings" + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/GetPeeringReceivedRoutes.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/GetPeeringReceivedRoutes.json new file mode 100644 index 000000000000..bfd28965b9ba --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/GetPeeringReceivedRoutes.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "peeringName": "peeringName", + "api-version": "2021-06-01", + "prefix": "1.1.1.0/24", + "asPath": "123 456", + "originAsValidationState": "Valid", + "rpkiValidationState": "Valid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "prefix": "1.1.1.0/24", + "nextHop": "127.0.0.1", + "asPath": "123 456", + "originAsValidationState": "Valid", + "rpkiValidationState": "Valid", + "trustAnchor": "Arin", + "receivedTimestamp": "2020-04-05 03:39:20" + } + ] + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/GetPeeringService.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/GetPeeringService.json new file mode 100644 index 000000000000..8b9519041365 --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/GetPeeringService.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "peeringServiceName": "peeringServiceName", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "peeringServiceLocation": "state1", + "peeringServiceProvider": "serviceProvider1", + "provisioningState": "Succeeded", + "providerPrimaryPeeringLocation": "peeringLocation1", + "providerBackupPeeringLocation": "peeringLocation2", + "logAnalyticsWorkspaceProperties": { + "workspaceID": "00000000-0000-0000-0000-000000000000", + "key": "key", + "connectedAgents": [ + "Agent1", + "Agent2" + ] + } + }, + "location": "eastus", + "name": "peeringServiceName", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peeringServices/peeringServiceName", + "type": "Microsoft.Peering/peeringServices" + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/GetPeeringServicePrefix.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/GetPeeringServicePrefix.json new file mode 100644 index 000000000000..4385f5fd759e --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/GetPeeringServicePrefix.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "peeringServiceName": "peeringServiceName", + "prefixName": "peeringServicePrefixName", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "prefix": "192.168.1.0/24", + "prefixValidationState": "Verified", + "learnedType": "ViaServiceProvider", + "peeringServicePrefixKey": "00000000-0000-0000-0000-000000000000", + "provisioningState": "Succeeded" + }, + "name": "peeringServicePrefixName", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peeringServices/peeringServiceName/prefixes/peeringServicePrefixName" + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/GetRegisteredAsn.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/GetRegisteredAsn.json new file mode 100644 index 000000000000..c02d0cbf68f7 --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/GetRegisteredAsn.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "peeringName": "peeringName", + "api-version": "2021-06-01", + "registeredAsnName": "registeredAsnName0" + }, + "responses": { + "200": { + "body": { + "properties": { + "asn": 65000, + "peeringServicePrefixKey": "00000000-0000-0000-0000-000000000000", + "provisioningState": "Succeeded" + }, + "name": "registeredAsnName0", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peerings/peeringName/registeredAsns/registeredAsnName0", + "type": "Microsoft.Peering/registeredAsns" + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/GetRegisteredPrefix.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/GetRegisteredPrefix.json new file mode 100644 index 000000000000..df8a15b77a89 --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/GetRegisteredPrefix.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "peeringName": "peeringName", + "api-version": "2021-06-01", + "registeredPrefixName": "registeredPrefixName" + }, + "responses": { + "200": { + "body": { + "properties": { + "prefix": "10.22.20.0/24", + "prefixValidationState": "Verified", + "peeringServicePrefixKey": "00000000-0000-0000-0000-000000000000", + "provisioningState": "Succeeded" + }, + "name": "registeredPrefixName", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peerings/peeringName/registeredPrefixes/registeredPrefixName", + "type": "Microsoft.Peering/registeredPrefixes" + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/InitializeConnectionMonitor.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/InitializeConnectionMonitor.json new file mode 100644 index 000000000000..5ee29e8f832f --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/InitializeConnectionMonitor.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "subscriptionId": "subId", + "api-version": "2021-06-01" + }, + "responses": { + "200": {} + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListCdnPeeringPrefixes.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListCdnPeeringPrefixes.json new file mode 100644 index 000000000000..e4af4eaf9a32 --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListCdnPeeringPrefixes.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "subId", + "peeringLocation": "peeringLocation0", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "prefix": "192.168.1.0/24", + "azureRegion": "West Central US", + "azureService": "AzureCompute", + "isPrimaryRegion": false, + "bgpCommunity": "0000:0000" + }, + "name": "CdnPrefix_192_168_1_0_24", + "id": "/subscriptions/subId/providers/Microsoft.Peering/cdnPeeringPrefixes/CdnPrefix_192_168_1_0_24", + "type": "Microsoft.Peering/cdnPeeringPrefixes" + } + ] + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListConnectionMonitorTestsByPeeringService.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListConnectionMonitorTestsByPeeringService.json new file mode 100644 index 000000000000..b713e91e07be --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListConnectionMonitorTestsByPeeringService.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "peeringServiceName": "peeringServiceName", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "sourceAgent": "Example Source Agent", + "destination": "Example Destination", + "destinationPort": 443, + "testFrequencyInSec": 30, + "isTestSuccessful": true, + "path": [ + "source", + "hop1", + "hop2", + "destination" + ], + "provisioningState": "Succeeded" + }, + "name": "connectionMonitorTestName1", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peeringServices/peeringServiceName/connectionMonitorTests/connectionMonitorTestName1" + }, + { + "properties": { + "sourceAgent": "Example Source Agent", + "destination": "Example Destination 2", + "destinationPort": 443, + "testFrequencyInSec": 30, + "isTestSuccessful": false, + "path": [ + "source", + "hop1", + "hop2", + "destination" + ], + "provisioningState": "Succeeded" + }, + "name": "connectionMonitorTestName2", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peeringServices/peeringServiceName/connectionMonitorTests/connectionMonitorTestName2" + } + ] + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListDirectPeeringLocations.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListDirectPeeringLocations.json new file mode 100644 index 000000000000..4321d0f0948b --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListDirectPeeringLocations.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "subId", + "kind": "Direct", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "kind": "Direct", + "properties": { + "direct": { + "peeringFacilities": [ + { + "address": "address1", + "directPeeringType": "Edge", + "peeringDBFacilityId": 99999, + "peeringDBFacilityLink": "https://www.peeringdb.com/fac/99999" + }, + { + "address": "address3", + "directPeeringType": "Cdn", + "peeringDBFacilityId": 99999, + "peeringDBFacilityLink": "https://www.peeringdb.com/fac/99999" + } + ], + "bandwidthOffers": [ + { + "offerName": "10Gbps", + "valueInMbps": 10000 + }, + { + "offerName": "100Gbps", + "valueInMbps": 100000 + } + ] + }, + "peeringLocation": "peeringLocation1", + "country": "country1" + }, + "name": "peeringLocation1", + "id": "/subscriptions/subId/providers/Microsoft.Peering/peeringLocations/peeringLocation1", + "type": "Microsoft.Peering/peeringLocations" + }, + { + "kind": "Direct", + "properties": { + "direct": { + "peeringFacilities": [ + { + "address": "address2", + "directPeeringType": "Edge", + "peeringDBFacilityId": 99999, + "peeringDBFacilityLink": "https://www.peeringdb.com/fac/99999" + } + ], + "bandwidthOffers": [ + { + "offerName": "10Gbps", + "valueInMbps": 10000 + }, + { + "offerName": "100Gbps", + "valueInMbps": 100000 + } + ] + }, + "peeringLocation": "peeringLocation2", + "country": "country2" + }, + "name": "peeringLocation2", + "id": "/subscriptions/subId/providers/Microsoft.Peering/peeringLocations/peeringLocation2", + "type": "Microsoft.Peering/peeringLocations" + } + ] + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListExchangePeeringLocations.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListExchangePeeringLocations.json new file mode 100644 index 000000000000..2bcc93126c0e --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListExchangePeeringLocations.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "subId", + "kind": "Exchange", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "kind": "Exchange", + "properties": { + "exchange": { + "peeringFacilities": [ + { + "exchangeName": "name1", + "bandwidthInMbps": 10000, + "microsoftIPv4Address": "192.168.131.1", + "microsoftIPv6Address": "fd00::1:1", + "facilityIPv4Prefix": "192.168.128.0/17", + "facilityIPv6Prefix": "fd00::1000:0/98", + "peeringDBFacilityId": 99999, + "peeringDBFacilityLink": "https://www.peeringdb.com/ix/99999" + }, + { + "exchangeName": "name3", + "bandwidthInMbps": 10000, + "microsoftIPv4Address": "192.168.2.2", + "microsoftIPv6Address": "fd00::2", + "facilityIPv4Prefix": "192.168.0.0/17", + "facilityIPv6Prefix": "fd00::0/98", + "peeringDBFacilityId": 99999, + "peeringDBFacilityLink": "https://www.peeringdb.com/ix/99999" + } + ] + }, + "peeringLocation": "peeringLocation1", + "country": "country1" + }, + "name": "peeringLocation1", + "id": "/subscriptions/subId/providers/Microsoft.Peering/peeringLocations/peeringLocation1", + "type": "Microsoft.Peering/peeringLocations" + }, + { + "kind": "Exchange", + "properties": { + "exchange": { + "peeringFacilities": [ + { + "exchangeName": "name2", + "bandwidthInMbps": 10000, + "microsoftIPv4Address": "192.168.2.1", + "microsoftIPv6Address": "fd00::2", + "facilityIPv4Prefix": "192.168.0.0/16", + "facilityIPv6Prefix": "fd00::0/98", + "peeringDBFacilityId": 99999, + "peeringDBFacilityLink": "https://www.peeringdb.com/ix/99999" + } + ] + }, + "peeringLocation": "peeringLocation2", + "country": "country2" + }, + "name": "peeringLocation2", + "id": "/subscriptions/subId/providers/Microsoft.Peering/peeringLocations/peeringLocation2", + "type": "Microsoft.Peering/peeringLocations" + } + ] + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListLegacyPeerings.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListLegacyPeerings.json new file mode 100644 index 000000000000..440cb0fe0d88 --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListLegacyPeerings.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "subId", + "kind": "Exchange", + "peeringLocation": "peeringLocation0", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Basic_Exchange_Free", + "tier": "Basic", + "family": "Exchange", + "size": "Free" + }, + "kind": "Exchange", + "properties": { + "exchange": { + "connections": [ + { + "peeringDBFacilityId": 99999, + "connectionState": "Active", + "bgpSession": { + "microsoftSessionIPv4Address": "192.168.3.1", + "microsoftSessionIPv6Address": "fd00::1:1", + "peerSessionIPv4Address": "192.168.2.1", + "peerSessionIPv6Address": "fd00::1", + "sessionStateV4": "Established", + "sessionStateV6": "Established", + "maxPrefixesAdvertisedV4": 1000, + "maxPrefixesAdvertisedV6": 100, + "md5AuthenticationKey": "test-md5-auth-key" + }, + "connectionIdentifier": "CE495334-0E94-4E51-8164-8116D6CD284D" + }, + { + "peeringDBFacilityId": 99999, + "connectionState": "Active", + "bgpSession": { + "microsoftSessionIPv4Address": "192.168.3.2", + "microsoftSessionIPv6Address": "fd00::1:2", + "peerSessionIPv4Address": "192.168.2.2", + "peerSessionIPv6Address": "fd00::2", + "sessionStateV4": "Established", + "sessionStateV6": "Established", + "maxPrefixesAdvertisedV4": 1000, + "maxPrefixesAdvertisedV6": 100, + "md5AuthenticationKey": "test-md5-auth-key" + }, + "connectionIdentifier": "CDD8E673-CB07-47E6-84DE-3739F778762B" + } + ], + "peerAsn": { + "id": "65000" + } + }, + "peeringLocation": "peeringLocation0", + "provisioningState": "Succeeded" + }, + "location": "centralus", + "name": "peeringName", + "id": "/subscriptions/subId/providers/Microsoft.Peering/peerings/peeringName", + "type": "Microsoft.Peering/peerings" + } + ] + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListPeerAsnsBySubscription.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListPeerAsnsBySubscription.json new file mode 100644 index 000000000000..cf6d685588ce --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListPeerAsnsBySubscription.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "subId", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "peerAsn": 65000, + "peerContactDetail": [ + { + "role": "Noc", + "email": "noc@contoso.com", + "phone": "+1 (234) 567-8999" + }, + { + "role": "Policy", + "email": "abc@contoso.com", + "phone": "+1 (234) 567-8900" + }, + { + "role": "Technical", + "email": "xyz@contoso.com", + "phone": "+1 (234) 567-8900" + } + ], + "peerName": "Contoso", + "validationState": "Approved" + }, + "name": "peerAsnName", + "id": "/subscriptions/subId/providers/Microsoft.Peering/peerAsns/peerAsnName", + "type": "Microsoft.Peering/peerAsns" + } + ] + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListPeeringOperations.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListPeeringOperations.json new file mode 100644 index 000000000000..f387c5491a39 --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListPeeringOperations.json @@ -0,0 +1,283 @@ +{ + "parameters": { + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Peering/register/action", + "display": { + "provider": "Microsoft.Peering", + "resource": "Peering Resource Provider", + "operation": "Registers the Peering Resource Provider", + "description": "Registers the subscription for the Peering Resource Provider and enables the creation of peerings" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Peering/peerAsns/write", + "display": { + "provider": "Microsoft.Peering", + "resource": "peerAsns", + "operation": "Write PeerAsn", + "description": "Write any peerAsns" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Peering/peerAsns/read", + "display": { + "provider": "Microsoft.Peering", + "resource": "peerAsns", + "operation": "Read PeerAsn", + "description": "Read any peerAsns" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Peering/peerAsns/delete", + "display": { + "provider": "Microsoft.Peering", + "resource": "peerAsns", + "operation": "Delete PeerAsn", + "description": "Delete any peerAsns" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Peering/peeringLocations/read", + "display": { + "provider": "Microsoft.Peering", + "resource": "peeringLocations", + "operation": "Read PeeringLocation", + "description": "Read any peeringLocations" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Peering/legacyPeerings/read", + "display": { + "provider": "Microsoft.Peering", + "resource": "legacyPeerings", + "operation": "Read LegacyPeering", + "description": "Read any legacyPeerings" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Peering/peerings/write", + "display": { + "provider": "Microsoft.Peering", + "resource": "peerings", + "operation": "Write Peering", + "description": "Write any peerings" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Peering/peerings/read", + "display": { + "provider": "Microsoft.Peering", + "resource": "peerings", + "operation": "Read Peering", + "description": "Read any peerings" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Peering/peerings/delete", + "display": { + "provider": "Microsoft.Peering", + "resource": "peerings", + "operation": "Delete Peering", + "description": "Delete any peerings" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Peering/peeringServiceLocations/read", + "display": { + "provider": "Microsoft.Peering", + "resource": "peeringServiceLocations", + "operation": "Read PeeringServiceLocations", + "description": "Read any peeringServiceLocations" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Peering/peeringServiceProviders/read", + "display": { + "provider": "Microsoft.Peering", + "resource": "peeringServiceProviders", + "operation": "Read PeeringServiceProviders", + "description": "Read any peeringServiceProviders" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Peering/peeringServices/read", + "display": { + "provider": "Microsoft.Peering", + "resource": "peeringServices", + "operation": "Read PeeringServices", + "description": "Read any peeringServices" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Peering/peeringServices/write", + "display": { + "provider": "Microsoft.Peering", + "resource": "peeringServices", + "operation": "Write PeeringService", + "description": "Write any peeringServices" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Peering/peeringServices/delete", + "display": { + "provider": "Microsoft.Peering", + "resource": "peeringServices", + "operation": "Delete PeeringServices", + "description": "Delete any peeringServices" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Peering/peeringServices/prefixes/read", + "display": { + "provider": "Microsoft.Peering", + "resource": "prefixes", + "operation": "Read PeeringServicePrefixes", + "description": "Read any prefixes" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Peering/peeringServices/prefixes/write", + "display": { + "provider": "Microsoft.Peering", + "resource": "prefixes", + "operation": "Write PeeringServicePrefixes", + "description": "Write any prefixes" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Peering/peeringServices/prefixes/delete", + "display": { + "provider": "Microsoft.Peering", + "resource": "prefixes", + "operation": "Delete PeeringServicePrefixes", + "description": "Delete any prefixes" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Peering/peerings/registeredPrefixes/read", + "display": { + "provider": "Microsoft.Peering", + "resource": "registeredPrefixes", + "operation": "Read RegisteredPrefixes", + "description": "Read any registeredPrefixes" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Peering/peerings/registeredPrefixes/write", + "display": { + "provider": "Microsoft.Peering", + "resource": "registeredPrefixes", + "operation": "Write RegisteredPrefixes", + "description": "Write any registeredPrefixes" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Peering/peerings/registeredPrefixes/delete", + "display": { + "provider": "Microsoft.Peering", + "resource": "registeredPrefixes", + "operation": "Delete RegisteredPrefixes", + "description": "Delete any registeredPrefixes" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Peering/peerings/registeredAsns/read", + "display": { + "provider": "Microsoft.Peering", + "resource": "registeredAsns", + "operation": "Read RegisteredAsns", + "description": "Read any registeredAsns" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Peering/peerings/registeredAsns/write", + "display": { + "provider": "Microsoft.Peering", + "resource": "registeredAsns", + "operation": "Write RegisteredAsns", + "description": "Write any registeredAsns" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Peering/peerings/registeredAsns/delete", + "display": { + "provider": "Microsoft.Peering", + "resource": "registeredAsns", + "operation": "Delete RegisteredAsns", + "description": "Delete any registeredAsns" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Peering/peerings/receivedRoutes/read", + "display": { + "provider": "Microsoft.Peering", + "resource": "receivedRoutes", + "operation": "Read PeeringReceivedRoutes", + "description": "Read any receivedRoutes" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Peering/peeringServices/connectionMonitorTests/read", + "display": { + "provider": "Microsoft.Peering", + "resource": "connectionMonitorTests", + "operation": "Read Peering Service Connection Monitor Tests", + "description": "Read any Peering Service Connection Monitor Tests" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Peering/peeringServices/connectionMonitorTests/write", + "display": { + "provider": "Microsoft.Peering", + "resource": "connectionMonitorTests", + "operation": "Write Peering Service Connection Monitor Tests", + "description": "Write any connectionMonitorTests" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Peering/peeringServices/connectionMonitorTests/delete", + "display": { + "provider": "Microsoft.Peering", + "resource": "connectionMonitorTests", + "operation": "Delete Peering Service Connection Monitor Tests", + "description": "Delete any Peering Service Connection Monitor Tests" + }, + "isDataAction": false + } + ] + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListPeeringServiceCountriesBySubscription.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListPeeringServiceCountriesBySubscription.json new file mode 100644 index 000000000000..569c13f96b59 --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListPeeringServiceCountriesBySubscription.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "subId", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "country1", + "id": "/subscriptions/subId/providers/Microsoft.Peering/peeringServiceCountries/country1", + "type": "Microsoft.Peering/peeringServiceCountries" + }, + { + "name": "country2", + "id": "/subscriptions/subId/providers/Microsoft.Peering/peeringServiceCountries/country2", + "type": "Microsoft.Peering/peeringServiceCountries" + } + ] + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListPeeringServiceLocationsBySubscription.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListPeeringServiceLocationsBySubscription.json new file mode 100644 index 000000000000..f891e7dcd38c --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListPeeringServiceLocationsBySubscription.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "subId", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "country": "country1", + "state": "state1" + }, + "name": "peeringServiceLocation1", + "id": "/subscriptions/subId/providers/Microsoft.Peering/peeringServiceLocations/peeringServiceLocation1", + "type": "Microsoft.Peering/peeringServiceLocations" + }, + { + "properties": { + "country": "country2", + "state": "state2" + }, + "name": "peeringServiceLocation2", + "id": "/subscriptions/subId/providers/Microsoft.Peering/peeringServiceLocations/peeringServiceLocation2", + "type": "Microsoft.Peering/peeringServiceLocations" + } + ] + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListPeeringServiceProviders.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListPeeringServiceProviders.json new file mode 100644 index 000000000000..6c07f0332f65 --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListPeeringServiceProviders.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "subId", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "serviceProviderName": "peeringServiceProvider1", + "peeringLocations": [ + "peeringLocation1", + "peeringLocation2" + ] + }, + "name": "peeringServiceProvider1", + "id": "/subscriptions/subId/providers/Microsoft.Peering/peeringServiceProviders/peeringServiceProvider1", + "type": "Microsoft.Peering/peeringServiceProviders" + }, + { + "properties": { + "serviceProviderName": "peeringServiceProvider2", + "peeringLocations": [ + "peeringLocation1", + "peeringLocation2" + ] + }, + "name": "peeringServiceProvider2", + "id": "/subscriptions/subId/providers/Microsoft.Peering/peeringServiceProviders/peeringServiceProvider2", + "type": "Microsoft.Peering/peeringServiceProviders" + } + ] + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListPeeringServicesByResourceGroup.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListPeeringServicesByResourceGroup.json new file mode 100644 index 000000000000..4bcf70260924 --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListPeeringServicesByResourceGroup.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "peeringServiceLocation": "state1", + "peeringServiceProvider": "serviceProvider1", + "provisioningState": "Succeeded", + "providerPrimaryPeeringLocation": "peeringLocation1", + "providerBackupPeeringLocation": "peeringLocation2", + "logAnalyticsWorkspaceProperties": { + "workspaceID": "00000000-0000-0000-0000-000000000000", + "key": "key", + "connectedAgents": [ + "Agent1", + "Agent2" + ] + } + }, + "location": "eastus", + "name": "peeringServiceName", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peeringServices/peeringServiceName", + "type": "Microsoft.Peering/peeringServices" + } + ] + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListPeeringServicesBySubscription.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListPeeringServicesBySubscription.json new file mode 100644 index 000000000000..d0cb941c948d --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListPeeringServicesBySubscription.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "subId", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "peeringServiceLocation": "state1", + "peeringServiceProvider": "serviceProvider1", + "provisioningState": "Succeeded", + "providerPrimaryPeeringLocation": "peeringLocation1", + "providerBackupPeeringLocation": "peeringLocation2", + "logAnalyticsWorkspaceProperties": { + "workspaceID": "00000000-0000-0000-0000-000000000000", + "key": "key", + "connectedAgents": [ + "Agent1", + "Agent2" + ] + } + }, + "location": "eastus", + "name": "peeringServiceName", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peeringServices/peeringServiceName", + "type": "Microsoft.Peering/peeringServices" + } + ] + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListPeeringsByResourceGroup.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListPeeringsByResourceGroup.json new file mode 100644 index 000000000000..553a6534fd93 --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListPeeringsByResourceGroup.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Basic_Exchange_Free", + "tier": "Basic", + "family": "Exchange", + "size": "Free" + }, + "kind": "Exchange", + "properties": { + "exchange": { + "connections": [ + { + "peeringDBFacilityId": 99999, + "connectionState": "Active", + "bgpSession": { + "microsoftSessionIPv4Address": "192.168.3.1", + "microsoftSessionIPv6Address": "fd00::1:1", + "peerSessionIPv4Address": "192.168.2.1", + "peerSessionIPv6Address": "fd00::1", + "sessionStateV4": "Established", + "sessionStateV6": "Established", + "maxPrefixesAdvertisedV4": 1000, + "maxPrefixesAdvertisedV6": 100, + "md5AuthenticationKey": "test-md5-auth-key" + }, + "connectionIdentifier": "CE495334-0E94-4E51-8164-8116D6CD284D" + }, + { + "peeringDBFacilityId": 99999, + "connectionState": "Active", + "bgpSession": { + "microsoftSessionIPv4Address": "192.168.3.2", + "microsoftSessionIPv6Address": "fd00::1:2", + "peerSessionIPv4Address": "192.168.2.2", + "peerSessionIPv6Address": "fd00::2", + "sessionStateV4": "Established", + "sessionStateV6": "Established", + "maxPrefixesAdvertisedV4": 1000, + "maxPrefixesAdvertisedV6": 100, + "md5AuthenticationKey": "test-md5-auth-key" + }, + "connectionIdentifier": "CDD8E673-CB07-47E6-84DE-3739F778762B" + } + ], + "peerAsn": { + "id": "/subscriptions/subId/providers/Microsoft.Peering/peerAsns/myAsn1" + } + }, + "peeringLocation": "peeringLocation0", + "provisioningState": "Succeeded" + }, + "location": "eastus", + "name": "peeringName", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peerings/peeringName", + "type": "Microsoft.Peering/peerings" + } + ] + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListPeeringsBySubscription.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListPeeringsBySubscription.json new file mode 100644 index 000000000000..e760d5019ed4 --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListPeeringsBySubscription.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "subId", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Basic_Exchange_Free", + "tier": "Basic", + "family": "Exchange", + "size": "Free" + }, + "kind": "Exchange", + "properties": { + "exchange": { + "connections": [ + { + "peeringDBFacilityId": 99999, + "connectionState": "Active", + "bgpSession": { + "microsoftSessionIPv4Address": "192.168.3.1", + "microsoftSessionIPv6Address": "fd00::1:1", + "peerSessionIPv4Address": "192.168.2.1", + "peerSessionIPv6Address": "fd00::1", + "sessionStateV4": "Established", + "sessionStateV6": "Established", + "maxPrefixesAdvertisedV4": 1000, + "maxPrefixesAdvertisedV6": 100, + "md5AuthenticationKey": "test-md5-auth-key" + }, + "connectionIdentifier": "CE495334-0E94-4E51-8164-8116D6CD284D" + }, + { + "peeringDBFacilityId": 99999, + "connectionState": "Active", + "bgpSession": { + "microsoftSessionIPv4Address": "192.168.3.2", + "microsoftSessionIPv6Address": "fd00::1:2", + "peerSessionIPv4Address": "192.168.2.2", + "peerSessionIPv6Address": "fd00::2", + "sessionStateV4": "Established", + "sessionStateV6": "Established", + "maxPrefixesAdvertisedV4": 1000, + "maxPrefixesAdvertisedV6": 100, + "md5AuthenticationKey": "test-md5-auth-key" + }, + "connectionIdentifier": "CDD8E673-CB07-47E6-84DE-3739F778762B" + } + ], + "peerAsn": { + "id": "/subscriptions/subId/providers/Microsoft.Peering/peerAsns/myAsn1" + } + }, + "peeringLocation": "peeringLocation0", + "provisioningState": "Succeeded" + }, + "location": "eastus", + "name": "peeringName", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peerings/peeringName", + "type": "Microsoft.Peering/peerings" + } + ] + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListPrefixesByPeeringService.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListPrefixesByPeeringService.json new file mode 100644 index 000000000000..b09cf0d5f186 --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListPrefixesByPeeringService.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "peeringServiceName": "peeringServiceName", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "prefix": "192.168.1.0/24", + "prefixValidationState": "Verified", + "learnedType": "ViaServiceProvider", + "peeringServicePrefixKey": "00000000-0000-0000-0000-000000000000", + "provisioningState": "Succeeded" + }, + "name": "peeringServicePrefixName1", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peeringServices/peeringServiceName/prefixes/peeringServicePrefixName1" + }, + { + "properties": { + "prefix": "192.168.2.0/24", + "prefixValidationState": "Verified", + "learnedType": "ViaServiceProvider", + "peeringServicePrefixKey": "00000000-0000-0000-0000-000000000000", + "provisioningState": "Succeeded" + }, + "name": "peeringServicePrefixName2", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peeringServices/peeringServiceName/prefixes/peeringServicePrefixName2" + } + ] + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListRegisteredAsnsByPeering.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListRegisteredAsnsByPeering.json new file mode 100644 index 000000000000..15954612deb7 --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListRegisteredAsnsByPeering.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "peeringName": "peeringName", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "asn": 65000, + "peeringServicePrefixKey": "00000000-0000-0000-0000-000000000000", + "provisioningState": "Succeeded" + }, + "name": "registeredAsnName0", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peerings/peeringName/registeredAsns/registeredAsnName0", + "type": "Microsoft.Peering/registeredAsns" + }, + { + "properties": { + "asn": 65001, + "provisioningState": "Failed" + }, + "name": "registeredAsnName1", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peerings/peeringName/registeredAsns/registeredAsnName1", + "type": "Microsoft.Peering/registeredAsns" + }, + { + "properties": { + "asn": 65002, + "peeringServicePrefixKey": "00000000-0000-0000-0000-000000000000", + "provisioningState": "Succeeded" + }, + "name": "registeredAsnName2", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peerings/peeringName/registeredAsns/registeredAsnName2", + "type": "Microsoft.Peering/registeredAsns" + } + ] + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListRegisteredPrefixesByPeering.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListRegisteredPrefixesByPeering.json new file mode 100644 index 000000000000..1697b8f5452b --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/ListRegisteredPrefixesByPeering.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "peeringName": "peeringName", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "prefix": "10.22.20.0/24", + "prefixValidationState": "Verified", + "peeringServicePrefixKey": "00000000-0000-0000-0000-000000000000", + "provisioningState": "Succeeded" + }, + "name": "registeredPrefixName0", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peerings/peeringName/registeredPrefixes/registeredPrefixName0", + "type": "Microsoft.Peering/registeredPrefixes" + }, + { + "properties": { + "prefix": "10.22.21.0/24", + "prefixValidationState": "Verified", + "peeringServicePrefixKey": "00000000-0000-0000-0000-000000000000", + "provisioningState": "Succeeded" + }, + "name": "registeredPrefixName1", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peerings/peeringName/registeredPrefixes/registeredPrefixName1", + "type": "Microsoft.Peering/registeredPrefixes" + }, + { + "properties": { + "prefix": "10.22.22.0/24", + "prefixValidationState": "Pending", + "provisioningState": "Succeeded" + }, + "name": "registeredPrefixName2", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peerings/peeringName/registeredPrefixes/registeredPrefixName2", + "type": "Microsoft.Peering/registeredPrefixes" + } + ] + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/LookingGlassInvokeCommand.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/LookingGlassInvokeCommand.json new file mode 100644 index 000000000000..6b0b4e586aad --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/LookingGlassInvokeCommand.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "subId", + "api-version": "2021-06-01", + "command": "Traceroute", + "sourceType": "AzureRegion", + "sourceLocation": "West US", + "destinationIP": "0.0.0.0" + }, + "responses": { + "200": { + "body": { + "command": "Traceroute", + "output": "traceroute to 0.0.0.0, 64 hops max, 52 bytes packets\n 1 West US (1.1.1.1) 0.111ms 0.222ms 0.333ms" + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/UpdatePeeringServiceTags.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/UpdatePeeringServiceTags.json new file mode 100644 index 000000000000..cec8ef69690e --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/UpdatePeeringServiceTags.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "peeringServiceName": "peeringServiceName", + "api-version": "2021-06-01", + "tags": { + "tags": { + "tag0": "value0", + "tag1": "value1" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "peeringServiceLocation": "state1", + "peeringServiceProvider": "serviceProvider1", + "provisioningState": "Succeeded", + "providerPrimaryPeeringLocation": "peeringLocation1", + "providerBackupPeeringLocation": "peeringLocation2", + "logAnalyticsWorkspaceProperties": { + "workspaceID": "00000000-0000-0000-0000-000000000000", + "key": "key", + "connectedAgents": [ + "Agent1", + "Agent2" + ] + } + }, + "location": "eastus", + "tags": { + "tag0": "value0", + "tag1": "value1" + }, + "name": "peeringServiceName", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peeringServices/peeringServiceName", + "type": "Microsoft.Peering/peeringServices" + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/UpdatePeeringTags.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/UpdatePeeringTags.json new file mode 100644 index 000000000000..6d59a505ce0c --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/examples/UpdatePeeringTags.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "peeringName": "peeringName", + "api-version": "2021-06-01", + "tags": { + "tags": { + "tag0": "value0", + "tag1": "value1" + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Basic_Exchange_Free", + "tier": "Basic", + "family": "Exchange", + "size": "Free" + }, + "kind": "Exchange", + "properties": { + "exchange": { + "connections": [ + { + "peeringDBFacilityId": 99999, + "connectionState": "Active", + "bgpSession": { + "microsoftSessionIPv4Address": "192.168.3.1", + "microsoftSessionIPv6Address": "fd00::1:1", + "peerSessionIPv4Address": "192.168.2.1", + "peerSessionIPv6Address": "fd00::1", + "sessionStateV4": "Established", + "sessionStateV6": "Established", + "maxPrefixesAdvertisedV4": 1000, + "maxPrefixesAdvertisedV6": 100, + "md5AuthenticationKey": "test-md5-auth-key" + }, + "connectionIdentifier": "CE495334-0E94-4E51-8164-8116D6CD284D" + }, + { + "peeringDBFacilityId": 99999, + "connectionState": "Active", + "bgpSession": { + "microsoftSessionIPv4Address": "192.168.3.2", + "microsoftSessionIPv6Address": "fd00::1:2", + "peerSessionIPv4Address": "192.168.2.2", + "peerSessionIPv6Address": "fd00::2", + "sessionStateV4": "Established", + "sessionStateV6": "Established", + "maxPrefixesAdvertisedV4": 1000, + "maxPrefixesAdvertisedV6": 100, + "md5AuthenticationKey": "test-md5-auth-key" + }, + "connectionIdentifier": "CDD8E673-CB07-47E6-84DE-3739F778762B" + } + ], + "peerAsn": { + "id": "/subscriptions/subId/providers/Microsoft.Peering/peerAsns/myAsn1" + } + }, + "peeringLocation": "peeringLocation0", + "provisioningState": "Succeeded" + }, + "location": "eastus", + "tags": { + "tag0": "value0", + "tag1": "value1" + }, + "name": "peeringName", + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peerings/peeringName", + "type": "Microsoft.Peering/peerings" + } + } + } +} diff --git a/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/peering.json b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/peering.json new file mode 100644 index 000000000000..693f5ffa560d --- /dev/null +++ b/specification/peering/resource-manager/Microsoft.Peering/stable/2021-06-01/peering.json @@ -0,0 +1,4118 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01", + "title": "PeeringManagementClient", + "description": "APIs to manage Peering resources through the Azure Resource Manager." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Peering/cdnPeeringPrefixes": { + "get": { + "tags": [ + "CdnPeeringPrefixes" + ], + "description": "Lists all of the advertised prefixes for the specified peering location", + "operationId": "CdnPeeringPrefixes_List", + "parameters": [ + { + "name": "peeringLocation", + "in": "query", + "description": "The peering location.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CdnPeeringPrefixListResult" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List all the cdn peering prefixes advertised at a particular peering location": { + "$ref": "./examples/ListCdnPeeringPrefixes.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Peering/checkServiceProviderAvailability": { + "post": { + "tags": [ + "CheckServiceProviderAvailability" + ], + "description": "Checks if the peering service provider is present within 1000 miles of customer's location", + "operationId": "CheckServiceProviderAvailability", + "parameters": [ + { + "name": "checkServiceProviderAvailabilityInput", + "in": "body", + "description": "The CheckServiceProviderAvailabilityInput indicating customer location and service provider.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckServiceProviderAvailabilityInput" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "enum": [ + "Available", + "Unavailable" + ], + "type": "string" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Check if peering service provider is available in customer location": { + "$ref": "./examples/CheckServiceProviderAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Peering/legacyPeerings": { + "get": { + "tags": [ + "LegacyPeerings" + ], + "description": "Lists all of the legacy peerings under the given subscription matching the specified kind and location.", + "operationId": "LegacyPeerings_List", + "parameters": [ + { + "name": "peeringLocation", + "in": "query", + "description": "The location of the peering.", + "required": true, + "type": "string" + }, + { + "name": "kind", + "in": "query", + "description": "The kind of the peering.", + "required": true, + "type": "string", + "enum": [ + "Direct", + "Exchange" + ] + }, + { + "name": "asn", + "in": "query", + "description": "The ASN number associated with a legacy peering.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PeeringListResult" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List legacy peerings": { + "$ref": "./examples/ListLegacyPeerings.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Peering/lookingGlass": { + "post": { + "tags": [ + "LookingGlass" + ], + "description": "Run looking glass functionality", + "operationId": "LookingGlass_Invoke", + "parameters": [ + { + "name": "command", + "in": "query", + "description": "The command to be executed: ping, traceroute, bgpRoute.", + "required": true, + "type": "string", + "enum": [ + "Traceroute", + "Ping", + "BgpRoute" + ] + }, + { + "name": "sourceType", + "in": "query", + "description": "The type of the source: Edge site or Azure Region.", + "required": true, + "type": "string", + "enum": [ + "EdgeSite", + "AzureRegion" + ] + }, + { + "name": "sourceLocation", + "in": "query", + "description": "The location of the source.", + "required": true, + "type": "string" + }, + { + "name": "destinationIP", + "in": "query", + "description": "The IP address of the destination.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LookingGlassOutput" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Call looking glass to execute a command": { + "$ref": "./examples/LookingGlassInvokeCommand.json" + } + } + } + }, + "/providers/Microsoft.Peering/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available API operations for peering resources.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List peering operations": { + "$ref": "./examples/ListPeeringOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Peering/peerAsns/{peerAsnName}": { + "get": { + "tags": [ + "PeerAsns" + ], + "description": "Gets the peer ASN with the specified name under the given subscription.", + "operationId": "PeerAsns_Get", + "parameters": [ + { + "name": "peerAsnName", + "in": "path", + "description": "The peer ASN name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PeerAsn" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a peer ASN": { + "$ref": "./examples/GetPeerAsn.json" + } + } + }, + "put": { + "tags": [ + "PeerAsns" + ], + "description": "Creates a new peer ASN or updates an existing peer ASN with the specified name under the given subscription.", + "operationId": "PeerAsns_CreateOrUpdate", + "parameters": [ + { + "name": "peerAsnName", + "in": "path", + "description": "The peer ASN name.", + "required": true, + "type": "string" + }, + { + "name": "peerAsn", + "in": "body", + "description": "The peer ASN.", + "required": true, + "schema": { + "$ref": "#/definitions/PeerAsn" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PeerAsn" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/PeerAsn" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a peer ASN": { + "$ref": "./examples/CreatePeerAsn.json" + } + } + }, + "delete": { + "tags": [ + "PeerAsns" + ], + "description": "Deletes an existing peer ASN with the specified name under the given subscription.", + "operationId": "PeerAsns_Delete", + "parameters": [ + { + "name": "peerAsnName", + "in": "path", + "description": "The peer ASN name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a peer ASN": { + "$ref": "./examples/DeletePeerAsn.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Peering/peerAsns": { + "get": { + "tags": [ + "PeerAsns" + ], + "description": "Lists all of the peer ASNs under the given subscription.", + "operationId": "PeerAsns_ListBySubscription", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PeerAsnListResult" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List peer ASNs in a subscription": { + "$ref": "./examples/ListPeerAsnsBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Peering/peeringLocations": { + "get": { + "tags": [ + "PeeringLocations" + ], + "description": "Lists all of the available peering locations for the specified kind of peering.", + "operationId": "PeeringLocations_List", + "parameters": [ + { + "name": "kind", + "in": "query", + "description": "The kind of the peering.", + "required": true, + "type": "string", + "enum": [ + "Direct", + "Exchange" + ] + }, + { + "name": "directPeeringType", + "in": "query", + "description": "The type of direct peering.", + "required": false, + "type": "string", + "enum": [ + "Edge", + "Transit", + "Cdn", + "Internal", + "Ix", + "IxRs", + "Voice" + ] + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PeeringLocationListResult" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List direct peering locations": { + "$ref": "./examples/ListDirectPeeringLocations.json" + }, + "List exchange peering locations": { + "$ref": "./examples/ListExchangePeeringLocations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredAsns/{registeredAsnName}": { + "get": { + "tags": [ + "PeeringRegisteredAsns" + ], + "description": "Gets an existing registered ASN with the specified name under the given subscription, resource group and peering.", + "operationId": "RegisteredAsns_Get", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string" + }, + { + "name": "peeringName", + "in": "path", + "description": "The name of the peering.", + "required": true, + "type": "string" + }, + { + "name": "registeredAsnName", + "in": "path", + "description": "The name of the registered ASN.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PeeringRegisteredAsn" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a registered ASN associated with the peering": { + "$ref": "./examples/GetRegisteredAsn.json" + } + } + }, + "put": { + "tags": [ + "PeeringRegisteredAsns" + ], + "description": "Creates a new registered ASN with the specified name under the given subscription, resource group and peering.", + "operationId": "RegisteredAsns_CreateOrUpdate", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string" + }, + { + "name": "peeringName", + "in": "path", + "description": "The name of the peering.", + "required": true, + "type": "string" + }, + { + "name": "registeredAsnName", + "in": "path", + "description": "The name of the ASN.", + "required": true, + "type": "string" + }, + { + "name": "registeredAsn", + "in": "body", + "description": "The properties needed to create a registered ASN.", + "required": true, + "schema": { + "$ref": "#/definitions/PeeringRegisteredAsn" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PeeringRegisteredAsn" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/PeeringRegisteredAsn" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a registered ASN for the peering": { + "$ref": "./examples/CreateRegisteredAsn.json" + } + } + }, + "delete": { + "tags": [ + "PeeringRegisteredAsns" + ], + "description": "Deletes an existing registered ASN with the specified name under the given subscription, resource group and peering.", + "operationId": "RegisteredAsns_Delete", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string" + }, + { + "name": "peeringName", + "in": "path", + "description": "The name of the peering.", + "required": true, + "type": "string" + }, + { + "name": "registeredAsnName", + "in": "path", + "description": "The name of the registered ASN.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deletes a registered ASN associated with the peering": { + "$ref": "./examples/DeleteRegisteredAsn.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredAsns": { + "get": { + "tags": [ + "PeeringRegisteredAsns" + ], + "description": "Lists all registered ASNs under the given subscription, resource group and peering.", + "operationId": "RegisteredAsns_ListByPeering", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string" + }, + { + "name": "peeringName", + "in": "path", + "description": "The name of the peering.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PeeringRegisteredAsnListResult" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List all the registered ASNs associated with the peering": { + "$ref": "./examples/ListRegisteredAsnsByPeering.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredPrefixes/{registeredPrefixName}": { + "get": { + "tags": [ + "PeeringRegisteredPrefixes" + ], + "description": "Gets an existing registered prefix with the specified name under the given subscription, resource group and peering.", + "operationId": "RegisteredPrefixes_Get", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string" + }, + { + "name": "peeringName", + "in": "path", + "description": "The name of the peering.", + "required": true, + "type": "string" + }, + { + "name": "registeredPrefixName", + "in": "path", + "description": "The name of the registered prefix.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PeeringRegisteredPrefix" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a registered prefix associated with the peering": { + "$ref": "./examples/GetRegisteredPrefix.json" + } + } + }, + "put": { + "tags": [ + "PeeringRegisteredPrefixes" + ], + "description": "Creates a new registered prefix with the specified name under the given subscription, resource group and peering.", + "operationId": "RegisteredPrefixes_CreateOrUpdate", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string" + }, + { + "name": "peeringName", + "in": "path", + "description": "The name of the peering.", + "required": true, + "type": "string" + }, + { + "name": "registeredPrefixName", + "in": "path", + "description": "The name of the registered prefix.", + "required": true, + "type": "string" + }, + { + "name": "registeredPrefix", + "in": "body", + "description": "The properties needed to create a registered prefix.", + "required": true, + "schema": { + "$ref": "#/definitions/PeeringRegisteredPrefix" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PeeringRegisteredPrefix" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/PeeringRegisteredPrefix" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a registered prefix for the peering": { + "$ref": "./examples/CreateRegisteredPrefix.json" + } + } + }, + "delete": { + "tags": [ + "PeeringRegisteredPrefixes" + ], + "description": "Deletes an existing registered prefix with the specified name under the given subscription, resource group and peering.", + "operationId": "RegisteredPrefixes_Delete", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string" + }, + { + "name": "peeringName", + "in": "path", + "description": "The name of the peering.", + "required": true, + "type": "string" + }, + { + "name": "registeredPrefixName", + "in": "path", + "description": "The name of the registered prefix.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deletes a registered prefix associated with the peering": { + "$ref": "./examples/DeleteRegisteredPrefix.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredPrefixes": { + "get": { + "tags": [ + "PeeringRegisteredPrefixes" + ], + "description": "Lists all registered prefixes under the given subscription, resource group and peering.", + "operationId": "RegisteredPrefixes_ListByPeering", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string" + }, + { + "name": "peeringName", + "in": "path", + "description": "The name of the peering.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PeeringRegisteredPrefixListResult" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List all the registered prefixes associated with the peering": { + "$ref": "./examples/ListRegisteredPrefixesByPeering.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}": { + "get": { + "tags": [ + "Peerings" + ], + "description": "Gets an existing peering with the specified name under the given subscription and resource group.", + "operationId": "Peerings_Get", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string" + }, + { + "name": "peeringName", + "in": "path", + "description": "The name of the peering.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Peering" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a peering": { + "$ref": "./examples/GetPeering.json" + } + } + }, + "put": { + "tags": [ + "Peerings" + ], + "description": "Creates a new peering or updates an existing peering with the specified name under the given subscription and resource group.", + "operationId": "Peerings_CreateOrUpdate", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string" + }, + { + "name": "peeringName", + "in": "path", + "description": "The name of the peering.", + "required": true, + "type": "string" + }, + { + "name": "peering", + "in": "body", + "description": "The properties needed to create or update a peering.", + "required": true, + "schema": { + "$ref": "#/definitions/Peering" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Peering" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Peering" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a direct peering": { + "$ref": "./examples/CreateDirectPeering.json" + }, + "Create an exchange peering": { + "$ref": "./examples/CreateExchangePeering.json" + }, + "Create a peering with exchange route server": { + "$ref": "./examples/CreatePeeringWithExchangeRouteServer.json" + } + } + }, + "delete": { + "tags": [ + "Peerings" + ], + "description": "Deletes an existing peering with the specified name under the given subscription and resource group.", + "operationId": "Peerings_Delete", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string" + }, + { + "name": "peeringName", + "in": "path", + "description": "The name of the peering.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a peering": { + "$ref": "./examples/DeletePeering.json" + } + } + }, + "patch": { + "tags": [ + "Peerings" + ], + "description": "Updates tags for a peering with the specified name under the given subscription and resource group.", + "operationId": "Peerings_Update", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string" + }, + { + "name": "peeringName", + "in": "path", + "description": "The name of the peering.", + "required": true, + "type": "string" + }, + { + "name": "tags", + "in": "body", + "description": "The resource tags.", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceTags" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Peering" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update peering tags": { + "$ref": "./examples/UpdatePeeringTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings": { + "get": { + "tags": [ + "Peerings" + ], + "description": "Lists all of the peerings under the given subscription and resource group.", + "operationId": "Peerings_ListByResourceGroup", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PeeringListResult" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List peerings in a resource group": { + "$ref": "./examples/ListPeeringsByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Peering/peerings": { + "get": { + "tags": [ + "Peerings" + ], + "description": "Lists all of the peerings under the given subscription.", + "operationId": "Peerings_ListBySubscription", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PeeringListResult" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List peerings in a subscription": { + "$ref": "./examples/ListPeeringsBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/receivedRoutes": { + "get": { + "tags": [ + "Peerings" + ], + "description": "Lists the prefixes received over the specified peering under the given subscription and resource group.", + "operationId": "ReceivedRoutes_ListByPeering", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string" + }, + { + "name": "peeringName", + "in": "path", + "description": "The name of the peering.", + "required": true, + "type": "string" + }, + { + "name": "prefix", + "in": "query", + "description": "The optional prefix that can be used to filter the routes.", + "required": false, + "type": "string" + }, + { + "name": "asPath", + "in": "query", + "description": "The optional AS path that can be used to filter the routes.", + "required": false, + "type": "string" + }, + { + "name": "originAsValidationState", + "in": "query", + "description": "The optional origin AS validation state that can be used to filter the routes.", + "required": false, + "type": "string" + }, + { + "name": "rpkiValidationState", + "in": "query", + "description": "The optional RPKI validation state that can be used to filter the routes.", + "required": false, + "type": "string" + }, + { + "name": "$skipToken", + "in": "query", + "description": "The optional page continuation token that is used in the event of paginated result.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PeeringReceivedRouteListResult" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Lists the prefixes received over the specified peering under the given subscription and resource group.": { + "$ref": "./examples/GetPeeringReceivedRoutes.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}/connectionMonitorTests/{connectionMonitorTestName}": { + "get": { + "tags": [ + "PeeringServiceConnectionMonitors" + ], + "description": "Gets an existing connection monitor test with the specified name under the given subscription, resource group and peering service.", + "operationId": "ConnectionMonitorTests_Get", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string" + }, + { + "name": "peeringServiceName", + "in": "path", + "description": "The name of the peering service.", + "required": true, + "type": "string" + }, + { + "name": "connectionMonitorTestName", + "in": "path", + "description": "The name of the connection monitor test", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectionMonitorTest" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Connection Monitor Test": { + "$ref": "./examples/GetConnectionMonitorTest.json" + } + } + }, + "put": { + "tags": [ + "PeeringServiceConnectionMonitors" + ], + "description": "Creates or updates a connection monitor test with the specified name under the given subscription, resource group and peering service.", + "operationId": "ConnectionMonitorTests_CreateOrUpdate", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string" + }, + { + "name": "peeringServiceName", + "in": "path", + "description": "The name of the peering service.", + "required": true, + "type": "string" + }, + { + "name": "connectionMonitorTestName", + "in": "path", + "description": "The name of the connection monitor test", + "required": true, + "type": "string" + }, + { + "name": "connectionMonitorTest", + "in": "body", + "description": "The properties needed to create a connection monitor test", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectionMonitorTest" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectionMonitorTest" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ConnectionMonitorTest" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update Connection Monitor Test": { + "$ref": "./examples/CreateOrUpdateConnectionMonitorTest.json" + } + } + }, + "delete": { + "tags": [ + "PeeringServiceConnectionMonitors" + ], + "description": "Deletes an existing connection monitor test with the specified name under the given subscription, resource group and peering service.", + "operationId": "ConnectionMonitorTests_Delete", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string" + }, + { + "name": "peeringServiceName", + "in": "path", + "description": "The name of the peering service.", + "required": true, + "type": "string" + }, + { + "name": "connectionMonitorTestName", + "in": "path", + "description": "The name of the connection monitor test", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Connection Monitor Test": { + "$ref": "./examples/DeleteConnectionMonitorTest.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}/connectionMonitorTests": { + "get": { + "tags": [ + "PeeringServiceConnectionMonitors" + ], + "description": "Lists all connection monitor tests under the given subscription, resource group and peering service.", + "operationId": "ConnectionMonitorTests_ListByPeeringService", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string" + }, + { + "name": "peeringServiceName", + "in": "path", + "description": "The name of the peering service.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectionMonitorTestListResult" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List all Connection Monitor Tests associated with the peering service": { + "$ref": "./examples/ListConnectionMonitorTestsByPeeringService.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Peering/peeringServiceCountries": { + "get": { + "tags": [ + "PeeringServiceCountries" + ], + "description": "Lists all of the available countries for peering service.", + "operationId": "PeeringServiceCountries_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PeeringServiceCountryListResult" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List peering service countries": { + "$ref": "./examples/ListPeeringServiceCountriesBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Peering/peeringServiceLocations": { + "get": { + "tags": [ + "PeeringServiceLocations" + ], + "description": "Lists all of the available locations for peering service.", + "operationId": "PeeringServiceLocations_List", + "parameters": [ + { + "name": "country", + "in": "query", + "description": "The country of interest, in which the locations are to be present.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PeeringServiceLocationListResult" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List peering service locations": { + "$ref": "./examples/ListPeeringServiceLocationsBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}/prefixes/{prefixName}": { + "get": { + "tags": [ + "PeeringServicePrefixes" + ], + "description": "Gets an existing prefix with the specified name under the given subscription, resource group and peering service.", + "operationId": "Prefixes_Get", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string" + }, + { + "name": "peeringServiceName", + "in": "path", + "description": "The name of the peering service.", + "required": true, + "type": "string" + }, + { + "name": "prefixName", + "in": "path", + "description": "The name of the prefix.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "The properties to be expanded.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PeeringServicePrefix" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a prefix associated with the peering service": { + "$ref": "./examples/GetPeeringServicePrefix.json" + } + } + }, + "put": { + "tags": [ + "PeeringServicePrefixes" + ], + "description": "Creates a new prefix with the specified name under the given subscription, resource group and peering service.", + "operationId": "Prefixes_CreateOrUpdate", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string" + }, + { + "name": "peeringServiceName", + "in": "path", + "description": "The name of the peering service.", + "required": true, + "type": "string" + }, + { + "name": "prefixName", + "in": "path", + "description": "The name of the prefix.", + "required": true, + "type": "string" + }, + { + "name": "peeringServicePrefix", + "in": "body", + "description": "The properties needed to create a prefix.", + "required": true, + "schema": { + "$ref": "#/definitions/PeeringServicePrefix" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PeeringServicePrefix" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/PeeringServicePrefix" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a prefix for the peering service": { + "$ref": "./examples/CreatePeeringServicePrefix.json" + } + } + }, + "delete": { + "tags": [ + "PeeringServicePrefixes" + ], + "description": "Deletes an existing prefix with the specified name under the given subscription, resource group and peering service.", + "operationId": "Prefixes_Delete", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string" + }, + { + "name": "peeringServiceName", + "in": "path", + "description": "The name of the peering service.", + "required": true, + "type": "string" + }, + { + "name": "prefixName", + "in": "path", + "description": "The name of the prefix.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a prefix associated with the peering service": { + "$ref": "./examples/DeletePeeringServicePrefix.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}/prefixes": { + "get": { + "tags": [ + "PeeringServicePrefixes" + ], + "description": "Lists all prefixes under the given subscription, resource group and peering service.", + "operationId": "Prefixes_ListByPeeringService", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string" + }, + { + "name": "peeringServiceName", + "in": "path", + "description": "The name of the peering service.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "The properties to be expanded.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PeeringServicePrefixListResult" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List all the prefixes associated with the peering service": { + "$ref": "./examples/ListPrefixesByPeeringService.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Peering/peeringServiceProviders": { + "get": { + "tags": [ + "PeeringServiceProviders" + ], + "description": "Lists all of the available peering service locations for the specified kind of peering.", + "operationId": "PeeringServiceProviders_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PeeringServiceProviderListResult" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List peering service providers": { + "$ref": "./examples/ListPeeringServiceProviders.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}": { + "get": { + "tags": [ + "PeeringServices" + ], + "description": "Gets an existing peering service with the specified name under the given subscription and resource group.", + "operationId": "PeeringServices_Get", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string" + }, + { + "name": "peeringServiceName", + "in": "path", + "description": "The name of the peering.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PeeringService" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a peering service": { + "$ref": "./examples/GetPeeringService.json" + } + } + }, + "put": { + "tags": [ + "PeeringServices" + ], + "description": "Creates a new peering service or updates an existing peering with the specified name under the given subscription and resource group.", + "operationId": "PeeringServices_CreateOrUpdate", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string" + }, + { + "name": "peeringServiceName", + "in": "path", + "description": "The name of the peering service.", + "required": true, + "type": "string" + }, + { + "name": "peeringService", + "in": "body", + "description": "The properties needed to create or update a peering service.", + "required": true, + "schema": { + "$ref": "#/definitions/PeeringService" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PeeringService" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/PeeringService" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a peering service": { + "$ref": "./examples/CreatePeeringService.json" + } + } + }, + "delete": { + "tags": [ + "PeeringServices" + ], + "description": "Deletes an existing peering service with the specified name under the given subscription and resource group.", + "operationId": "PeeringServices_Delete", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string" + }, + { + "name": "peeringServiceName", + "in": "path", + "description": "The name of the peering service.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a peering service": { + "$ref": "./examples/DeletePeeringService.json" + } + } + }, + "patch": { + "tags": [ + "PeeringServices" + ], + "description": "Updates tags for a peering service with the specified name under the given subscription and resource group.", + "operationId": "PeeringServices_Update", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string" + }, + { + "name": "peeringServiceName", + "in": "path", + "description": "The name of the peering service.", + "required": true, + "type": "string" + }, + { + "name": "tags", + "in": "body", + "description": "The resource tags.", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceTags" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PeeringService" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update peering service tags": { + "$ref": "./examples/UpdatePeeringServiceTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices": { + "get": { + "tags": [ + "PeeringServices" + ], + "description": "Lists all of the peering services under the given subscription and resource group.", + "operationId": "PeeringServices_ListByResourceGroup", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PeeringServiceListResult" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List peering services in a resource group": { + "$ref": "./examples/ListPeeringServicesByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Peering/peeringServices": { + "get": { + "tags": [ + "PeeringServices" + ], + "description": "Lists all of the peerings under the given subscription.", + "operationId": "PeeringServices_ListBySubscription", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PeeringServiceListResult" + } + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List peering services in a subscription": { + "$ref": "./examples/ListPeeringServicesBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Peering/initializeConnectionMonitor": { + "post": { + "tags": [ + "PeeringServices" + ], + "description": "Initialize Peering Service for Connection Monitor functionality", + "operationId": "PeeringServices_InitializeConnectionMonitor", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation has failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Initialize Peering Service for Connection Monitor functionality": { + "$ref": "./examples/InitializeConnectionMonitor.json" + } + } + } + } + }, + "definitions": { + "CdnPeeringPrefixListResult": { + "description": "The paginated list of CDN peering prefixes.", + "type": "object", + "properties": { + "value": { + "description": "The list of CDN peering prefixes.", + "type": "array", + "items": { + "$ref": "#/definitions/CdnPeeringPrefix" + } + }, + "nextLink": { + "description": "The link to fetch the next page of CDN peering prefixes.", + "type": "string" + } + } + }, + "CdnPeeringPrefix": { + "description": "The CDN peering prefix", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/CdnPeeringPrefixProperties", + "description": "The properties that define a cdn peering prefix.", + "x-ms-client-flatten": true + } + } + }, + "CdnPeeringPrefixProperties": { + "description": "The properties that define a CDN peering prefix", + "type": "object", + "properties": { + "prefix": { + "description": "The prefix.", + "type": "string", + "readOnly": true + }, + "azureRegion": { + "description": "The Azure region.", + "type": "string", + "readOnly": true + }, + "azureService": { + "description": "The Azure service.", + "type": "string", + "readOnly": true + }, + "isPrimaryRegion": { + "description": "The flag that indicates whether or not this is the primary region.", + "type": "boolean", + "readOnly": true + }, + "bgpCommunity": { + "description": "The BGP Community", + "type": "string", + "readOnly": true + } + } + }, + "CheckServiceProviderAvailabilityInput": { + "description": "Class for CheckServiceProviderAvailabilityInput", + "type": "object", + "properties": { + "peeringServiceLocation": { + "description": "Gets or sets the peering service location.", + "type": "string" + }, + "peeringServiceProvider": { + "description": "Gets or sets the peering service provider.", + "type": "string" + } + } + }, + "PeeringListResult": { + "description": "The paginated list of peerings.", + "type": "object", + "properties": { + "value": { + "description": "The list of peerings.", + "type": "array", + "items": { + "$ref": "#/definitions/Peering" + } + }, + "nextLink": { + "description": "The link to fetch the next page of peerings.", + "type": "string" + } + } + }, + "Peering": { + "description": "Peering is a logical representation of a set of connections to the Microsoft Cloud Edge at a location.", + "required": [ + "sku", + "kind", + "location" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "sku": { + "$ref": "#/definitions/PeeringSku", + "description": "The SKU that defines the tier and kind of the peering." + }, + "kind": { + "description": "The kind of the peering.", + "enum": [ + "Direct", + "Exchange" + ], + "type": "string", + "x-ms-enum": { + "name": "kind", + "modelAsString": true + } + }, + "properties": { + "$ref": "#/definitions/PeeringProperties", + "description": "The properties that define a peering.", + "x-ms-client-flatten": true + }, + "location": { + "description": "The location of the resource.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "description": "The resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "PeeringSku": { + "description": "The SKU that defines the tier and kind of the peering.", + "type": "object", + "properties": { + "name": { + "description": "The name of the peering SKU.", + "type": "string" + }, + "tier": { + "description": "The tier of the peering SKU.", + "enum": [ + "Basic", + "Premium" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "tier", + "modelAsString": true + } + }, + "family": { + "description": "The family of the peering SKU.", + "enum": [ + "Direct", + "Exchange" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "family", + "modelAsString": true + } + }, + "size": { + "description": "The size of the peering SKU.", + "enum": [ + "Free", + "Metered", + "Unlimited" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "size", + "modelAsString": true + } + } + } + }, + "PeeringProperties": { + "description": "The properties that define connectivity to the Microsoft Cloud Edge.", + "type": "object", + "properties": { + "direct": { + "$ref": "#/definitions/PeeringPropertiesDirect", + "description": "The properties that define a direct peering." + }, + "exchange": { + "$ref": "#/definitions/PeeringPropertiesExchange", + "description": "The properties that define an exchange peering." + }, + "peeringLocation": { + "description": "The location of the peering.", + "type": "string" + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "enum": [ + "Succeeded", + "Updating", + "Deleting", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } + } + } + }, + "PeeringPropertiesDirect": { + "description": "The properties that define a direct peering.", + "type": "object", + "properties": { + "connections": { + "description": "The set of connections that constitute a direct peering.", + "type": "array", + "items": { + "$ref": "#/definitions/DirectConnection" + } + }, + "useForPeeringService": { + "description": "The flag that indicates whether or not the peering is used for peering service.", + "type": "boolean", + "readOnly": true + }, + "peerAsn": { + "$ref": "#/definitions/SubResource", + "description": "The reference of the peer ASN." + }, + "directPeeringType": { + "description": "The type of direct peering.", + "enum": [ + "Edge", + "Transit", + "Cdn", + "Internal", + "Ix", + "IxRs", + "Voice" + ], + "type": "string", + "x-ms-enum": { + "name": "directPeeringType", + "modelAsString": true + } + } + } + }, + "PeeringPropertiesExchange": { + "description": "The properties that define an exchange peering.", + "type": "object", + "properties": { + "connections": { + "description": "The set of connections that constitute an exchange peering.", + "type": "array", + "items": { + "$ref": "#/definitions/ExchangeConnection" + } + }, + "peerAsn": { + "$ref": "#/definitions/SubResource", + "description": "The reference of the peer ASN." + } + } + }, + "DirectConnection": { + "description": "The properties that define a direct connection.", + "type": "object", + "properties": { + "bandwidthInMbps": { + "format": "int32", + "description": "The bandwidth of the connection.", + "type": "integer" + }, + "provisionedBandwidthInMbps": { + "format": "int32", + "description": "The bandwidth that is actually provisioned.", + "type": "integer", + "readOnly": true + }, + "sessionAddressProvider": { + "description": "The field indicating if Microsoft provides session ip addresses.", + "enum": [ + "Microsoft", + "Peer" + ], + "type": "string", + "x-ms-enum": { + "name": "sessionAddressProvider", + "modelAsString": true + } + }, + "useForPeeringService": { + "description": "The flag that indicates whether or not the connection is used for peering service.", + "type": "boolean" + }, + "microsoftTrackingId": { + "description": "The ID used within Microsoft's peering provisioning system to track the connection", + "type": "string", + "readOnly": true + }, + "peeringDBFacilityId": { + "format": "int32", + "description": "The PeeringDB.com ID of the facility at which the connection has to be set up.", + "type": "integer" + }, + "connectionState": { + "description": "The state of the connection.", + "enum": [ + "None", + "PendingApproval", + "Approved", + "ProvisioningStarted", + "ProvisioningFailed", + "ProvisioningCompleted", + "Validating", + "Active" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "connectionState", + "modelAsString": true + } + }, + "bgpSession": { + "$ref": "#/definitions/BgpSession", + "description": "The BGP session associated with the connection." + }, + "connectionIdentifier": { + "description": "The unique identifier (GUID) for the connection.", + "type": "string" + }, + "errorMessage": { + "description": "The error message related to the connection state, if any.", + "type": "string", + "readOnly": true + } + } + }, + "SubResource": { + "description": "The sub resource.", + "type": "object", + "properties": { + "id": { + "description": "The identifier of the referenced resource.", + "type": "string" + } + } + }, + "ExchangeConnection": { + "description": "The properties that define an exchange connection.", + "type": "object", + "properties": { + "peeringDBFacilityId": { + "format": "int32", + "description": "The PeeringDB.com ID of the facility at which the connection has to be set up.", + "type": "integer" + }, + "connectionState": { + "description": "The state of the connection.", + "enum": [ + "None", + "PendingApproval", + "Approved", + "ProvisioningStarted", + "ProvisioningFailed", + "ProvisioningCompleted", + "Validating", + "Active" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "connectionState", + "modelAsString": true + } + }, + "bgpSession": { + "$ref": "#/definitions/BgpSession", + "description": "The BGP session associated with the connection." + }, + "connectionIdentifier": { + "description": "The unique identifier (GUID) for the connection.", + "type": "string" + }, + "errorMessage": { + "description": "The error message related to the connection state, if any.", + "type": "string", + "readOnly": true + } + } + }, + "BgpSession": { + "description": "The properties that define a BGP session.", + "type": "object", + "properties": { + "sessionPrefixV4": { + "description": "The IPv4 prefix that contains both ends' IPv4 addresses.", + "type": "string" + }, + "sessionPrefixV6": { + "description": "The IPv6 prefix that contains both ends' IPv6 addresses.", + "type": "string" + }, + "microsoftSessionIPv4Address": { + "description": "The IPv4 session address on Microsoft's end.", + "type": "string" + }, + "microsoftSessionIPv6Address": { + "description": "The IPv6 session address on Microsoft's end.", + "type": "string" + }, + "peerSessionIPv4Address": { + "description": "The IPv4 session address on peer's end.", + "type": "string" + }, + "peerSessionIPv6Address": { + "description": "The IPv6 session address on peer's end.", + "type": "string" + }, + "sessionStateV4": { + "description": "The state of the IPv4 session.", + "enum": [ + "None", + "Idle", + "Connect", + "Active", + "OpenSent", + "OpenConfirm", + "OpenReceived", + "Established", + "PendingAdd", + "PendingUpdate", + "PendingRemove" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "sessionStateV4", + "modelAsString": true + } + }, + "sessionStateV6": { + "description": "The state of the IPv6 session.", + "enum": [ + "None", + "Idle", + "Connect", + "Active", + "OpenSent", + "OpenConfirm", + "OpenReceived", + "Established", + "PendingAdd", + "PendingUpdate", + "PendingRemove" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "sessionStateV6", + "modelAsString": true + } + }, + "maxPrefixesAdvertisedV4": { + "format": "int32", + "description": "The maximum number of prefixes advertised over the IPv4 session.", + "type": "integer" + }, + "maxPrefixesAdvertisedV6": { + "format": "int32", + "description": "The maximum number of prefixes advertised over the IPv6 session.", + "type": "integer" + }, + "md5AuthenticationKey": { + "description": "The MD5 authentication key of the session.", + "type": "string" + } + } + }, + "LookingGlassOutput": { + "description": "Looking glass output model", + "type": "object", + "properties": { + "command": { + "description": "Invoked command", + "enum": [ + "Traceroute", + "Ping", + "BgpRoute" + ], + "type": "string", + "x-ms-enum": { + "name": "command", + "modelAsString": true + } + }, + "output": { + "description": "Output of the command", + "type": "string" + } + } + }, + "OperationListResult": { + "description": "The paginated list of peering API operations.", + "type": "object", + "properties": { + "value": { + "description": "The list of peering API operations.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "The link to fetch the next page of peering API operations.", + "type": "string" + } + } + }, + "Operation": { + "description": "The peering API operation.", + "type": "object", + "properties": { + "name": { + "description": "The name of the operation.", + "type": "string", + "readOnly": true + }, + "display": { + "$ref": "#/definitions/OperationDisplayInfo", + "description": "The information related to the operation.", + "readOnly": true + }, + "isDataAction": { + "description": "The flag that indicates whether the operation applies to data plane.", + "type": "boolean", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "The properties of the operation.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "OperationDisplayInfo": { + "description": "The information related to the operation.", + "type": "object", + "properties": { + "provider": { + "description": "The name of the resource provider.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "The name of the operation.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The description of the operation.", + "type": "string", + "readOnly": true + } + } + }, + "OperationProperties": { + "description": "The properties of the operation.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "Service specification payload.", + "readOnly": true + } + } + }, + "ServiceSpecification": { + "description": "Service specification payload.", + "type": "object", + "properties": { + "metricSpecifications": { + "description": "Specifications of the Metrics for Azure Monitoring.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "readOnly": true + } + } + }, + "MetricSpecification": { + "description": "Specifications of the Metrics for Azure Monitoring.", + "type": "object", + "properties": { + "name": { + "description": "Name of the metric.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "Localized friendly display name of the metric.", + "type": "string", + "readOnly": true + }, + "displayDescription": { + "description": "Localized friendly description of the metric.", + "type": "string", + "readOnly": true + }, + "unit": { + "description": "Unit that makes sense for the metric.", + "type": "string", + "readOnly": true + }, + "aggregationType": { + "description": "Aggregation type will be set to one of the values: Average, Minimum, Maximum, Total, Count.", + "type": "string", + "readOnly": true + }, + "supportedTimeGrainTypes": { + "description": "Supported time grain types for the metric.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "dimensions": { + "description": "Dimensions of the metric.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricDimension" + }, + "readOnly": true + } + } + }, + "MetricDimension": { + "description": "Dimensions of the metric.", + "type": "object", + "properties": { + "name": { + "description": "Name of the dimension.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "Localized friendly display name of the dimension.", + "type": "string", + "readOnly": true + } + } + }, + "PeerAsn": { + "description": "The essential information related to the peer's ASN.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PeerAsnProperties", + "description": "The properties that define a peer's ASN.", + "x-ms-client-flatten": true + } + } + }, + "PeerAsnProperties": { + "description": "The properties that define a peer's ASN.", + "type": "object", + "properties": { + "peerAsn": { + "format": "int32", + "description": "The Autonomous System Number (ASN) of the peer.", + "type": "integer" + }, + "peerContactDetail": { + "description": "The contact details of the peer.", + "type": "array", + "items": { + "$ref": "#/definitions/ContactDetail" + } + }, + "peerName": { + "description": "The name of the peer.", + "type": "string" + }, + "validationState": { + "description": "The validation state of the ASN associated with the peer.", + "enum": [ + "None", + "Pending", + "Approved", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "validationState", + "modelAsString": true + } + }, + "errorMessage": { + "description": "The error message for the validation state", + "type": "string", + "readOnly": true + } + } + }, + "ContactDetail": { + "description": "The contact detail class.", + "type": "object", + "properties": { + "role": { + "description": "The role of the contact.", + "enum": [ + "Noc", + "Policy", + "Technical", + "Service", + "Escalation", + "Other" + ], + "type": "string", + "x-ms-enum": { + "name": "role", + "modelAsString": true + } + }, + "email": { + "description": "The e-mail address of the contact.", + "type": "string" + }, + "phone": { + "description": "The phone number of the contact.", + "type": "string" + } + } + }, + "PeerAsnListResult": { + "description": "The paginated list of peer ASNs.", + "type": "object", + "properties": { + "value": { + "description": "The list of peer ASNs.", + "type": "array", + "items": { + "$ref": "#/definitions/PeerAsn" + } + }, + "nextLink": { + "description": "The link to fetch the next page of peer ASNs.", + "type": "string" + } + } + }, + "PeeringLocationListResult": { + "description": "The paginated list of peering locations.", + "type": "object", + "properties": { + "value": { + "description": "The list of peering locations.", + "type": "array", + "items": { + "$ref": "#/definitions/PeeringLocation" + } + }, + "nextLink": { + "description": "The link to fetch the next page of peering locations.", + "type": "string" + } + } + }, + "PeeringLocation": { + "description": "Peering location is where connectivity could be established to the Microsoft Cloud Edge.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "kind": { + "description": "The kind of peering that the peering location supports.", + "enum": [ + "Direct", + "Exchange" + ], + "type": "string", + "x-ms-enum": { + "name": "kind", + "modelAsString": true + } + }, + "properties": { + "$ref": "#/definitions/PeeringLocationProperties", + "description": "The properties that define a peering location.", + "x-ms-client-flatten": true + } + } + }, + "PeeringLocationProperties": { + "description": "The properties that define a peering location.", + "type": "object", + "properties": { + "direct": { + "$ref": "#/definitions/PeeringLocationPropertiesDirect", + "description": "The properties that define a direct peering location." + }, + "exchange": { + "$ref": "#/definitions/PeeringLocationPropertiesExchange", + "description": "The properties that define an exchange peering location." + }, + "peeringLocation": { + "description": "The name of the peering location.", + "type": "string" + }, + "country": { + "description": "The country in which the peering location exists.", + "type": "string" + }, + "azureRegion": { + "description": "The Azure region associated with the peering location.", + "type": "string" + } + } + }, + "PeeringLocationPropertiesDirect": { + "description": "The properties that define a direct peering location.", + "type": "object", + "properties": { + "peeringFacilities": { + "description": "The list of direct peering facilities at the peering location.", + "type": "array", + "items": { + "$ref": "#/definitions/DirectPeeringFacility" + } + }, + "bandwidthOffers": { + "description": "The list of bandwidth offers available at the peering location.", + "type": "array", + "items": { + "$ref": "#/definitions/PeeringBandwidthOffer" + } + } + } + }, + "PeeringLocationPropertiesExchange": { + "description": "The properties that define an exchange peering location.", + "type": "object", + "properties": { + "peeringFacilities": { + "description": "The list of exchange peering facilities at the peering location.", + "type": "array", + "items": { + "$ref": "#/definitions/ExchangePeeringFacility" + } + } + } + }, + "DirectPeeringFacility": { + "description": "The properties that define a direct peering facility.", + "type": "object", + "properties": { + "address": { + "description": "The address of the direct peering facility.", + "type": "string" + }, + "directPeeringType": { + "description": "The type of the direct peering.", + "enum": [ + "Edge", + "Transit", + "Cdn", + "Internal", + "Ix", + "IxRs", + "Voice" + ], + "type": "string", + "x-ms-enum": { + "name": "directPeeringType", + "modelAsString": true + } + }, + "peeringDBFacilityId": { + "format": "int32", + "description": "The PeeringDB.com ID of the facility.", + "type": "integer" + }, + "peeringDBFacilityLink": { + "description": "The PeeringDB.com URL of the facility.", + "type": "string" + } + } + }, + "PeeringBandwidthOffer": { + "description": "The properties that define a peering bandwidth offer.", + "type": "object", + "properties": { + "offerName": { + "description": "The name of the bandwidth offer.", + "type": "string" + }, + "valueInMbps": { + "format": "int32", + "description": "The value of the bandwidth offer in Mbps.", + "type": "integer" + } + } + }, + "ExchangePeeringFacility": { + "description": "The properties that define an exchange peering facility.", + "type": "object", + "properties": { + "exchangeName": { + "description": "The name of the exchange peering facility.", + "type": "string" + }, + "bandwidthInMbps": { + "format": "int32", + "description": "The bandwidth of the connection between Microsoft and the exchange peering facility.", + "type": "integer" + }, + "microsoftIPv4Address": { + "description": "The IPv4 address of Microsoft at the exchange peering facility.", + "type": "string" + }, + "microsoftIPv6Address": { + "description": "The IPv6 address of Microsoft at the exchange peering facility.", + "type": "string" + }, + "facilityIPv4Prefix": { + "description": "The IPv4 prefixes associated with the exchange peering facility.", + "type": "string" + }, + "facilityIPv6Prefix": { + "description": "The IPv6 prefixes associated with the exchange peering facility.", + "type": "string" + }, + "peeringDBFacilityId": { + "format": "int32", + "description": "The PeeringDB.com ID of the facility.", + "type": "integer" + }, + "peeringDBFacilityLink": { + "description": "The PeeringDB.com URL of the facility.", + "type": "string" + } + } + }, + "PeeringRegisteredAsn": { + "description": "The customer's ASN that is registered by the peering service provider.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PeeringRegisteredAsnProperties", + "description": "The properties that define a registered ASN.", + "x-ms-client-flatten": true + } + } + }, + "PeeringRegisteredAsnProperties": { + "description": "The properties that define a registered ASN.", + "type": "object", + "properties": { + "asn": { + "format": "int32", + "description": "The customer's ASN from which traffic originates.", + "type": "integer" + }, + "peeringServicePrefixKey": { + "description": "The peering service prefix key that is to be shared with the customer.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "enum": [ + "Succeeded", + "Updating", + "Deleting", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } + } + } + }, + "PeeringRegisteredAsnListResult": { + "description": "The paginated list of peering registered ASNs.", + "type": "object", + "properties": { + "value": { + "description": "The list of peering registered ASNs.", + "type": "array", + "items": { + "$ref": "#/definitions/PeeringRegisteredAsn" + } + }, + "nextLink": { + "description": "The link to fetch the next page of peering registered ASNs.", + "type": "string" + } + } + }, + "PeeringRegisteredPrefix": { + "description": "The customer's prefix that is registered by the peering service provider.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PeeringRegisteredPrefixProperties", + "description": "The properties that define a registered prefix.", + "x-ms-client-flatten": true + } + } + }, + "PeeringRegisteredPrefixProperties": { + "description": "The properties that define a registered prefix.", + "type": "object", + "properties": { + "prefix": { + "description": "The customer's prefix from which traffic originates.", + "type": "string" + }, + "prefixValidationState": { + "description": "The prefix validation state.", + "enum": [ + "None", + "Invalid", + "Verified", + "Failed", + "Pending", + "Warning", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "prefixValidationState", + "modelAsString": true + } + }, + "peeringServicePrefixKey": { + "description": "The peering service prefix key that is to be shared with the customer.", + "type": "string", + "readOnly": true + }, + "errorMessage": { + "description": "The error message associated with the validation state, if any.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "enum": [ + "Succeeded", + "Updating", + "Deleting", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } + } + } + }, + "PeeringRegisteredPrefixListResult": { + "description": "The paginated list of peering registered prefixes.", + "type": "object", + "properties": { + "value": { + "description": "The list of peering registered prefixes.", + "type": "array", + "items": { + "$ref": "#/definitions/PeeringRegisteredPrefix" + } + }, + "nextLink": { + "description": "The link to fetch the next page of peering registered prefixes.", + "type": "string" + } + } + }, + "ResourceTags": { + "description": "The resource tags.", + "type": "object", + "properties": { + "tags": { + "description": "Gets or sets the tags, a dictionary of descriptors arm object", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "PeeringReceivedRouteListResult": { + "description": "The paginated list of received routes for the peering.", + "type": "object", + "properties": { + "value": { + "description": "The list of received routes for the peering.", + "type": "array", + "items": { + "$ref": "#/definitions/PeeringReceivedRoute" + } + }, + "nextLink": { + "description": "The link to fetch the next page of received routes for the peering.", + "type": "string" + } + } + }, + "PeeringReceivedRoute": { + "description": "The properties that define a received route.", + "type": "object", + "properties": { + "prefix": { + "description": "The prefix.", + "type": "string", + "readOnly": true + }, + "nextHop": { + "description": "The next hop for the prefix.", + "type": "string", + "readOnly": true + }, + "asPath": { + "description": "The AS path for the prefix.", + "type": "string", + "readOnly": true + }, + "originAsValidationState": { + "description": "The origin AS change information for the prefix.", + "type": "string", + "readOnly": true + }, + "rpkiValidationState": { + "description": "The RPKI validation state for the prefix and origin AS that's listed in the AS path.", + "type": "string", + "readOnly": true + }, + "trustAnchor": { + "description": "The authority which holds the Route Origin Authorization record for the prefix, if any.", + "type": "string", + "readOnly": true + }, + "receivedTimestamp": { + "description": "The received timestamp associated with the prefix.", + "type": "string", + "readOnly": true + } + } + }, + "ConnectionMonitorTest": { + "description": "The Connection Monitor Test class.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ConnectionMonitorTestProperties", + "description": "The properties that define a Connection Monitor Test.", + "x-ms-client-flatten": true + } + } + }, + "ConnectionMonitorTestProperties": { + "description": "The properties that define a Connection Monitor Test.", + "type": "object", + "properties": { + "sourceAgent": { + "description": "The Connection Monitor test source agent", + "type": "string" + }, + "destination": { + "description": "The Connection Monitor test destination", + "type": "string" + }, + "destinationPort": { + "format": "int32", + "description": "The Connection Monitor test destination port", + "type": "integer" + }, + "testFrequencyInSec": { + "format": "int32", + "description": "The Connection Monitor test frequency in seconds", + "type": "integer" + }, + "isTestSuccessful": { + "description": "The flag that indicates if the Connection Monitor test is successful or not.", + "type": "boolean", + "readOnly": true + }, + "path": { + "description": "The path representing the Connection Monitor test.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "enum": [ + "Succeeded", + "Updating", + "Deleting", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } + } + } + }, + "ConnectionMonitorTestListResult": { + "description": "The paginated list of [T].", + "type": "object", + "properties": { + "value": { + "description": "The list of [T].", + "type": "array", + "items": { + "$ref": "#/definitions/ConnectionMonitorTest" + } + }, + "nextLink": { + "description": "The link to fetch the next page of [T].", + "type": "string" + } + } + }, + "PeeringServiceCountryListResult": { + "description": "The paginated list of peering service countries.", + "type": "object", + "properties": { + "value": { + "description": "The list of peering service countries.", + "type": "array", + "items": { + "$ref": "#/definitions/PeeringServiceCountry" + } + }, + "nextLink": { + "description": "The link to fetch the next page of peering service countries.", + "type": "string" + } + } + }, + "PeeringServiceCountry": { + "description": "The peering service country.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": {} + }, + "PeeringServiceLocationListResult": { + "description": "The paginated list of peering service locations.", + "type": "object", + "properties": { + "value": { + "description": "The list of peering service locations.", + "type": "array", + "items": { + "$ref": "#/definitions/PeeringServiceLocation" + } + }, + "nextLink": { + "description": "The link to fetch the next page of peering service locations.", + "type": "string" + } + } + }, + "PeeringServiceLocation": { + "description": "The peering service location.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PeeringServiceLocationProperties", + "description": "The properties that define a peering service location.", + "x-ms-client-flatten": true + } + } + }, + "PeeringServiceLocationProperties": { + "description": "The properties that define connectivity to the Peering Service Location.", + "type": "object", + "properties": { + "country": { + "description": "Country of the customer", + "type": "string" + }, + "state": { + "description": "State of the customer", + "type": "string" + }, + "azureRegion": { + "description": "Azure region for the location", + "type": "string" + } + } + }, + "PeeringServicePrefix": { + "description": "The peering service prefix class.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PeeringServicePrefixProperties", + "description": "Gets or sets the peering prefix properties.", + "x-ms-client-flatten": true + } + } + }, + "PeeringServicePrefixProperties": { + "description": "The peering service prefix properties class.", + "type": "object", + "properties": { + "prefix": { + "description": "The prefix from which your traffic originates.", + "type": "string" + }, + "prefixValidationState": { + "description": "The prefix validation state", + "enum": [ + "None", + "Invalid", + "Verified", + "Failed", + "Pending", + "Warning", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "prefixValidationState", + "modelAsString": true + } + }, + "learnedType": { + "description": "The prefix learned type", + "enum": [ + "None", + "ViaServiceProvider", + "ViaSession" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "learnedType", + "modelAsString": true + } + }, + "errorMessage": { + "description": "The error message for validation state", + "type": "string", + "readOnly": true + }, + "events": { + "description": "The list of events for peering service prefix", + "type": "array", + "items": { + "$ref": "#/definitions/PeeringServicePrefixEvent" + }, + "readOnly": true + }, + "peeringServicePrefixKey": { + "description": "The peering service prefix key", + "type": "string" + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "enum": [ + "Succeeded", + "Updating", + "Deleting", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } + } + } + }, + "PeeringServicePrefixEvent": { + "description": "The details of the event associated with a prefix.", + "type": "object", + "properties": { + "eventTimestamp": { + "format": "date-time", + "description": "The timestamp of the event associated with a prefix.", + "type": "string", + "readOnly": true + }, + "eventType": { + "description": "The type of the event associated with a prefix.", + "type": "string", + "readOnly": true + }, + "eventSummary": { + "description": "The summary of the event associated with a prefix.", + "type": "string", + "readOnly": true + }, + "eventLevel": { + "description": "The level of the event associated with a prefix.", + "type": "string", + "readOnly": true + }, + "eventDescription": { + "description": "The description of the event associated with a prefix.", + "type": "string", + "readOnly": true + } + } + }, + "PeeringServicePrefixListResult": { + "description": "The paginated list of peering service prefixes.", + "type": "object", + "properties": { + "value": { + "description": "The list of peering service prefixes.", + "type": "array", + "items": { + "$ref": "#/definitions/PeeringServicePrefix" + } + }, + "nextLink": { + "description": "The link to fetch the next page of peering service prefixes.", + "type": "string" + } + } + }, + "PeeringServiceProviderListResult": { + "description": "The paginated list of peering service providers.", + "type": "object", + "properties": { + "value": { + "description": "The list of peering service providers.", + "type": "array", + "items": { + "$ref": "#/definitions/PeeringServiceProvider" + } + }, + "nextLink": { + "description": "The link to fetch the next page of peering service providers.", + "type": "string" + } + } + }, + "PeeringServiceProvider": { + "description": "PeeringService provider", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PeeringServiceProviderProperties", + "description": "The properties that define a peering service provider.", + "x-ms-client-flatten": true + } + } + }, + "PeeringServiceProviderProperties": { + "description": "The properties that define connectivity to the Peering Service Provider.", + "type": "object", + "properties": { + "serviceProviderName": { + "description": "The name of the service provider.", + "type": "string" + }, + "peeringLocations": { + "description": "The list of locations at which the service provider peers with Microsoft.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PeeringService": { + "description": "Peering Service", + "required": [ + "location" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "sku": { + "$ref": "#/definitions/PeeringServiceSku", + "description": "The SKU that defines the type of the peering service." + }, + "properties": { + "$ref": "#/definitions/PeeringServiceProperties", + "description": "The properties that define a peering service.", + "x-ms-client-flatten": true + }, + "location": { + "description": "The location of the resource.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "description": "The resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "PeeringServiceSku": { + "description": "The SKU that defines the type of the peering service.", + "type": "object", + "properties": { + "name": { + "description": "The name of the peering service SKU.", + "type": "string" + } + } + }, + "PeeringServiceProperties": { + "description": "The properties that define connectivity to the Peering Service.", + "type": "object", + "properties": { + "peeringServiceLocation": { + "description": "The location (state/province) of the customer.", + "type": "string" + }, + "peeringServiceProvider": { + "description": "The name of the service provider.", + "type": "string" + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "enum": [ + "Succeeded", + "Updating", + "Deleting", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } + }, + "providerPrimaryPeeringLocation": { + "description": "The primary peering (Microsoft/service provider) location to be used for customer traffic.", + "type": "string" + }, + "providerBackupPeeringLocation": { + "description": "The backup peering (Microsoft/service provider) location to be used for customer traffic.", + "type": "string" + }, + "logAnalyticsWorkspaceProperties": { + "$ref": "#/definitions/LogAnalyticsWorkspaceProperties", + "description": "The Log Analytics Workspace Properties" + } + } + }, + "LogAnalyticsWorkspaceProperties": { + "description": "The properties that define a Log Analytics Workspace.", + "type": "object", + "properties": { + "workspaceID": { + "description": "The Workspace ID.", + "type": "string", + "readOnly": true + }, + "key": { + "description": "The Workspace Key.", + "type": "string", + "readOnly": true + }, + "connectedAgents": { + "description": "The list of connected agents.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "PeeringServiceListResult": { + "description": "The paginated list of peering services.", + "type": "object", + "properties": { + "value": { + "description": "The list of peering services.", + "type": "array", + "items": { + "$ref": "#/definitions/PeeringService" + } + }, + "nextLink": { + "description": "The link to fetch the next page of peering services.", + "type": "string" + } + } + }, + "ErrorResponse": { + "description": "The error response that indicates why an operation has failed.", + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorDetail", + "description": "The error detail that describes why an operation has failed." + } + } + }, + "ErrorDetail": { + "description": "The error detail that describes why an operation has failed.", + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The error message.", + "type": "string", + "readOnly": true + } + } + }, + "Resource": { + "description": "The ARM resource class.", + "type": "object", + "properties": { + "name": { + "description": "The name of the resource.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "The ID of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The Azure subscription ID.", + "required": true, + "type": "string" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The client API version.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/peering/resource-manager/readme.go.md b/specification/peering/resource-manager/readme.go.md index d5d686f9126e..2ed06c9018bb 100644 --- a/specification/peering/resource-manager/readme.go.md +++ b/specification/peering/resource-manager/readme.go.md @@ -13,34 +13,24 @@ go: ### Go multi-api ``` yaml $(go) && $(multiapi) batch: + - tag: package-2021-06-01 - tag: package-2021-01-01 -``` -or -``` yaml $(go) && $(multiapi) -batch: - tag: package-2020-10-01 -``` -or -``` yaml $(go) && $(multiapi) -batch: - tag: package-2020-04-01 -``` -or -``` yaml $(go) && $(multiapi) -batch: - tag: package-2020-01-01-preview -``` -or -``` yaml $(go) && $(multiapi) -batch: - tag: package-2019-09-01-preview -``` -or -``` yaml $(go) && $(multiapi) -batch: - tag: package-2019-08-01-preview ``` +### Tag: package-2021-06-01 and go + +These settings apply only when `--tag=package-2021-06-01 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2021-06-01' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2021-06-01/$(namespace) +``` + ### Tag: package-2021-01-01 and go These settings apply only when `--tag=package-2021-01-01 --go` is specified on the command line. diff --git a/specification/peering/resource-manager/readme.java.md b/specification/peering/resource-manager/readme.java.md index 6380f51504f2..5269c7823301 100644 --- a/specification/peering/resource-manager/readme.java.md +++ b/specification/peering/resource-manager/readme.java.md @@ -14,6 +14,11 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-peering ### Java multi-api ``` yaml $(java) && $(multiapi) +batch: + - tag: package-2021-06-01 +``` +or +``` yaml $(java) && $(multiapi) batch: - tag: package-2021-01-01 ``` @@ -43,6 +48,19 @@ batch: - tag: package-2019-08-01-preview ``` +### Tag: package-2021-06-01 and java + +These settings apply only when `--tag=package-2021-06-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2021-06-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.peering.v2021-06-01 + output-folder: $(azure-libraries-for-java-folder)/sdk/peering/mgmt-v2021-06-01 +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-2021-01-01 and java These settings apply only when `--tag=package-2021-01-01 --java` is specified on the command line. diff --git a/specification/peering/resource-manager/readme.md b/specification/peering/resource-manager/readme.md index d81b897d3edf..56596e4ca9e9 100644 --- a/specification/peering/resource-manager/readme.md +++ b/specification/peering/resource-manager/readme.md @@ -22,6 +22,14 @@ To see additional help and options, run: ### Basic Information These are the global settings for the Peering API. +``` yaml +title: PeeringManagementClient +description: Peering Client +openapi-type: arm +tag: package-2021-06-01 +``` +or + ``` yaml title: PeeringManagementClient description: Peering Client @@ -65,6 +73,15 @@ description: Peering Client openapi-type: arm tag: package-2019-08-01-preview ``` +### Tag: package-2021-06-01 + +These settings apply only when `--tag=package-2021-06-01` is specified on the command line. + +``` yaml $(tag) == 'package-2021-06-01' +input-file: +- Microsoft.Peering/stable/2021-06-01/peering.json +``` + ### Tag: package-2021-01-01 These settings apply only when `--tag=package-2021-01-01` is specified on the command line. @@ -129,7 +146,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/peering/resource-manager/readme.python.md b/specification/peering/resource-manager/readme.python.md index b006a15f07a1..c02f0b8dc61d 100644 --- a/specification/peering/resource-manager/readme.python.md +++ b/specification/peering/resource-manager/readme.python.md @@ -4,37 +4,15 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.peering - package-name: azure-mgmt-peering - package-version: 0.2.0 - clear-output-folder: true -``` ``` yaml $(python) && $(track2) -python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.peering package-name: azure-mgmt-peering -package-version: 0.2.0 +package-version: 1.0.0b1 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/peering/azure-mgmt-peering/azure/mgmt/peering -``` -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/peering/azure-mgmt-peering -``` ``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/peering/azure-mgmt-peering/azure/mgmt/peering diff --git a/specification/peering/resource-manager/readme.ruby.md b/specification/peering/resource-manager/readme.ruby.md index f328ba3fd148..30e255807cd6 100644 --- a/specification/peering/resource-manager/readme.ruby.md +++ b/specification/peering/resource-manager/readme.ruby.md @@ -2,6 +2,12 @@ These settings apply only when `--ruby` is specified on the command line. +``` yaml +package-name: azure_mgmt_peering +package-version: "2021-06-01" +azure-arm: true +``` +or ``` yaml package-name: azure_mgmt_peering package-version: "2021-01-01" @@ -40,6 +46,11 @@ azure-arm: true ### Ruby multi-api +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2021-06-01 +``` +or ``` yaml $(ruby) && $(multiapi) batch: - tag: package-2021-01-01 @@ -70,6 +81,16 @@ batch: - tag: package-2019-08-01-preview ``` +### Tag: package-2021-06-01 and ruby + +These settings apply only when `--tag=package-2021-06-01 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2021-06-01' && $(ruby) +namespace: "Azure::Peering::Mgmt::V2021-06-01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_peering/lib +``` + ### Tag: package-2021-01-01 and ruby These settings apply only when `--tag=package-2021-01-01 --ruby` is specified on the command line. diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/policyEvents.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/policyEvents.json index de7e20edf86e..4ab47f3b2a5d 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/policyEvents.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/policyEvents.json @@ -634,7 +634,7 @@ } }, "x-ms-paths": { - "/{nextLink}?Next paging op for policy events": { + "{nextLink}?Next paging op for policy events": { "post": { "operationId": "PolicyEvents_NextLink", "description": "Subsequent post calls to the next link", diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/policyStates.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/policyStates.json index 407d6fd276a1..d64a6edeabf9 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/policyStates.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/policyStates.json @@ -1161,8 +1161,10 @@ } } } - }, - "/{nextLink}": { + } + }, + "x-ms-paths": { + "{nextLink}?Next paging op for policy states": { "post": { "operationId": "PolicyStates_NextLink", "description": "Subsequent post calls to the next link", diff --git a/specification/policyinsights/resource-manager/readme.md b/specification/policyinsights/resource-manager/readme.md index 7e3ee603d921..cefb975388db 100644 --- a/specification/policyinsights/resource-manager/readme.md +++ b/specification/policyinsights/resource-manager/readme.md @@ -79,6 +79,59 @@ directive: where: $.definitions.Attestation.properties reason: systemData is now a required top level property + - suppress: OBJECT_ADDITIONAL_PROPERTIES + from: policyEvents.json + reason: unnecessary check + + - suppress: OBJECT_ADDITIONAL_PROPERTIES + from: policyStates.json + reason: unnecessary check + + - suppress: MISSING_REQUIRED_PARAMETER + from: policyEvents.json + reason: unnecessary check + + - suppress: MISSING_REQUIRED_PARAMETER + from: policyStates.json + reason: unnecessary check + +``` + +``` yaml !$(python) +directive: + - from: policyEvents.json + where: $ + transform: delete $['x-ms-paths'] + reason: other languages which still use track1 does not support remove '/' for 'next_link' + + - from: policyStates.json + where: $ + transform: delete $['x-ms-paths'] + reason: other languages which still use track1 does not support remove '/' for 'next_link' + + - from: policyEvents.json + where: + - $.path["/providers/{managementGroupsNamespace}/managementGroups/{managementGroupName}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults"] + - $.path["/subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults"] + - $.path["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults"] + - $.path["/{resourceId}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults"] + - $.path["/subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policySetDefinitions/{policySetDefinitionName}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults"] + - $.path["/subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyDefinitions/{policyDefinitionName}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults"] + - $.path["/subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults"] + - $.path["/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{authorizationNamespace}/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults"] + transform: delete $['post']['x-ms-pageable']['operationName'] + + - from: policyStates.json + where: + - $.path["/providers/{managementGroupsNamespace}/managementGroups/{managementGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults"] + - $.path["/subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults"] + - $.path["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults"] + - $.path["/{resourceId}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults"] + - $.path["/subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policySetDefinitions/{policySetDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults"] + - $.path["/subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyDefinitions/{policyDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults"] + - $.path["/subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults"] + - $.path["/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{authorizationNamespace}/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults"] + transform: delete $['post']['x-ms-pageable']['operationName'] ``` ### Tag: package-2021-01 @@ -160,10 +213,8 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - repo: azure-sdk-for-js - repo: azure-sdk-for-node - repo: azure-resource-manager-schemas diff --git a/specification/policyinsights/resource-manager/readme.python.md b/specification/policyinsights/resource-manager/readme.python.md index f6544fe4cf1e..fe1ea68f3f87 100644 --- a/specification/policyinsights/resource-manager/readme.python.md +++ b/specification/policyinsights/resource-manager/readme.python.md @@ -4,17 +4,6 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.policyinsights - package-name: azure-mgmt-policyinsights - clear-output-folder: true -``` - ``` yaml $(python) && $(track2) python-mode: create azure-arm: true @@ -25,19 +14,13 @@ package-version: 1.0.0b1 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' +``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/policyinsights/azure-mgmt-policyinsights/azure/mgmt/policyinsights -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/policyinsights/azure-mgmt-policyinsights/azure/mgmt/policyinsights ``` -``` yaml $(python) && $(python-mode) == 'create' +``` yaml $(python) && $(python-mode) == 'create' && $(track2) basic-setup-py: true output-folder: $(python-sdks-folder)/policyinsights/azure-mgmt-policyinsights -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/policyinsights/azure-mgmt-policyinsights ``` ``` yaml $(python) && $(track2) diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/postgresql.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/postgresql.json index 1740324e8423..869e85ca9803 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/postgresql.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/postgresql.json @@ -34,7 +34,7 @@ } }, "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}": { "put": { "tags": [ "Servers" @@ -241,7 +241,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers": { "get": { "tags": [ "Servers" @@ -283,7 +283,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBForPostgreSQL/servers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/servers": { "get": { "tags": [ "Servers" @@ -322,7 +322,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/replicas": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/replicas": { "get": { "tags": [ "Replicas" @@ -367,7 +367,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/restart": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/restart": { "post": { "tags": [ "ServerRestart" @@ -410,7 +410,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/firewallRules/{firewallRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/firewallRules/{firewallRuleName}": { "put": { "tags": [ "FirewallRules" @@ -564,7 +564,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/firewallRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/firewallRules": { "get": { "tags": [ "FirewallRules" @@ -609,7 +609,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { "get": { "tags": [ "VirtualNetworkRules" @@ -754,7 +754,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/virtualNetworkRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/virtualNetworkRules": { "get": { "tags": [ "VirtualNetworkRules" @@ -796,7 +796,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/databases/{databaseName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/databases/{databaseName}": { "put": { "tags": [ "Databases" @@ -950,7 +950,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/databases": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/databases": { "get": { "tags": [ "Databases" @@ -995,7 +995,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/configurations/{configurationName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/configurations/{configurationName}": { "put": { "tags": [ "Configurations" @@ -1096,7 +1096,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/configurations": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/configurations": { "get": { "tags": [ "Configurations" @@ -1141,7 +1141,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/updateConfigurations": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/updateConfigurations": { "post": { "tags": [ "ConfigurationsUpdate" @@ -1199,7 +1199,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/logFiles": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/logFiles": { "get": { "tags": [ "LogFiles" @@ -1244,7 +1244,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/administrators/activeDirectory": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/administrators/activeDirectory": { "get": { "tags": [ "ServerAdministrators" @@ -1386,7 +1386,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/administrators": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/administrators": { "get": { "tags": [ "ServerAdministrators" @@ -1431,7 +1431,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/recoverableServers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/recoverableServers": { "get": { "tags": [ "RecoverableServers" @@ -1473,7 +1473,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/performanceTiers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/performanceTiers": { "get": { "tags": [ "ServerBasedPerformanceTier" @@ -1518,7 +1518,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBForPostgreSQL/locations/{locationName}/performanceTiers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/locations/{locationName}/performanceTiers": { "get": { "tags": [ "LocationBasedPerformanceTier" @@ -1560,7 +1560,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBForPostgreSQL/checkNameAvailability": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/checkNameAvailability": { "post": { "tags": [ "CheckNameAvailability" @@ -1605,7 +1605,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { "get": { "tags": [ "ServerSecurityAlertPolicies" @@ -1767,7 +1767,7 @@ } } }, - "/providers/Microsoft.DBForPostgreSQL/operations": { + "/providers/Microsoft.DBforPostgreSQL/operations": { "get": { "tags": [ "Operations" diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerCreate.json index ce333211ec73..d1a8a6ac4f47 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerCreate.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerCreate.json @@ -23,7 +23,8 @@ }, "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 7 + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled" }, "availabilityZone": "1" }, @@ -42,12 +43,15 @@ "properties": { "administratorLogin": "cloudsa", "version": "12", + "minorVersion": "6", "state": "Ready", "haState": "NotEnabled", "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", "displayName": "demosingleserver", "publicNetworkAccess": "Enabled", "haEnabled": "Enabled", + "standbyCount": 1, + "logBackupStorageSku": "Standard_ZRS", "delegatedSubnetArguments": { "subnetArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet" }, @@ -56,7 +60,9 @@ }, "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 7 + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" }, "availabilityZone": "1", "standbyAvailabilityZone": "2", @@ -85,12 +91,15 @@ "properties": { "administratorLogin": "cloudsa", "version": "12", + "minorVersion": "6", "state": "Ready", "haState": "NotEnabled", "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", "displayName": "demosingleserver", "publicNetworkAccess": "Enabled", "haEnabled": "Enabled", + "standbyCount": 1, + "logBackupStorageSku": "Standard_ZRS", "delegatedSubnetArguments": { "subnetArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet" }, @@ -99,7 +108,9 @@ }, "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 7 + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" }, "availabilityZone": "1", "standbyAvailabilityZone": "2", diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerCreatePointInTimeRestore.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerCreatePointInTimeRestore.json index 4c902f67f91c..d3099cf93649 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerCreatePointInTimeRestore.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerCreatePointInTimeRestore.json @@ -25,17 +25,22 @@ "properties": { "administratorLogin": "cloudsa", "version": "12", + "minorVersion": "6", "state": "Ready", "haState": "NotEnabled", "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", "displayName": "demosingleserver", "publicNetworkAccess": "Enabled", "haEnabled": "Disabled", + "standbyCount": 0, + "logBackupStorageSku": "Standard_ZRS", "delegatedSubnetArguments": {}, "privateDnsZoneArguments": {}, "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 7 + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" }, "availabilityZone": "1" }, @@ -57,17 +62,22 @@ "properties": { "administratorLogin": "cloudsa", "version": "12", + "minorVersion": "6", "state": "Ready", "haState": "NotEnabled", "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", "displayName": "demosingleserver", "publicNetworkAccess": "Enabled", "haEnabled": "Disabled", + "standbyCount": 0, + "logBackupStorageSku": "Standard_ZRS", "delegatedSubnetArguments": {}, "privateDnsZoneArguments": {}, "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 7 + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" }, "availabilityZone": "1" }, diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerGet.json index b28535f615a1..49b06b0c9626 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerGet.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerGet.json @@ -15,6 +15,7 @@ "properties": { "administratorLogin": "cloudsa", "version": "12", + "minorVersion": "6", "state": "Ready", "haState": "NotEnabled", "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", @@ -22,9 +23,13 @@ "publicNetworkAccess": "Enabled", "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 7 + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" }, "haEnabled": "Enabled", + "standbyCount": 1, + "logBackupStorageSku": "Standard_ZRS", "availabilityZone": "1", "standbyAvailabilityZone": "2", "maintenanceWindow": { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerGetWithVnet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerGetWithVnet.json index 13126f937fcc..c66b083767e8 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerGetWithVnet.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerGetWithVnet.json @@ -15,8 +15,12 @@ "properties": { "administratorLogin": "cloudsa", "version": "12", + "minorVersion": "6", "state": "Ready", "haState": "NotEnabled", + "haEnabled": "Disabled", + "standbyCount": 0, + "logBackupStorageSku": "Standard_ZRS", "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", "displayName": "demosingleserver", "publicNetworkAccess": "Disabled", @@ -28,7 +32,9 @@ }, "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 7 + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" }, "availabilityZone": "1" }, diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerList.json index d8917699f069..39feb87e4930 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerList.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerList.json @@ -16,6 +16,7 @@ "properties": { "administratorLogin": "cloudsa", "version": "12", + "minorVersion": "6", "state": "Ready", "haState": "NotEnabled", "fullyQualifiedDomainName": "pgtestsvc1.postgres.database.azure.com", @@ -23,9 +24,13 @@ "publicNetworkAccess": "Enabled", "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 7 + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" }, "haEnabled": "Enabled", + "standbyCount": 1, + "logBackupStorageSku": "Standard_ZRS", "availabilityZone": "1", "standbyAvailabilityZone": "2", "maintenanceWindow": { @@ -51,6 +56,7 @@ "properties": { "administratorLogin": "cloudsa", "version": "12", + "minorVersion": "6", "state": "Ready", "haState": "Healthy", "fullyQualifiedDomainName": "pgtestsvc2.postgres.database.azure.com", @@ -58,9 +64,13 @@ "publicNetworkAccess": "Enabled", "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 7 + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" }, "haEnabled": "Disabled", + "standbyCount": 0, + "logBackupStorageSku": "Standard_ZRS", "availabilityZone": "2", "maintenanceWindow": { "dayOfWeek": 0, @@ -85,6 +95,7 @@ "properties": { "administratorLogin": "cloudsa", "version": "12", + "minorVersion": "6", "state": "Ready", "haState": "FailingOver", "fullyQualifiedDomainName": "pgtestsvc3.postgres.database.azure.com", @@ -92,9 +103,13 @@ "publicNetworkAccess": "Enabled", "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 7 + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" }, "haEnabled": "Disabled", + "standbyCount": 0, + "logBackupStorageSku": "Standard_ZRS", "availabilityZone": "3", "maintenanceWindow": { "dayOfWeek": 0, @@ -119,6 +134,7 @@ "properties": { "administratorLogin": "cloudsa", "version": "12", + "minorVersion": "6", "state": "Ready", "haState": "ReplicatingData", "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", @@ -126,9 +142,13 @@ "publicNetworkAccess": "Enabled", "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 7 + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" }, "haEnabled": "Enabled", + "standbyCount": 1, + "logBackupStorageSku": "Standard_ZRS", "availabilityZone": "1", "standbyAvailabilityZone": "2", "maintenanceWindow": { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerListByResourceGroup.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerListByResourceGroup.json index 276e20cb04d8..1e59f192b218 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerListByResourceGroup.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerListByResourceGroup.json @@ -17,6 +17,7 @@ "properties": { "administratorLogin": "testuser", "version": "12", + "minorVersion": "6", "state": "Ready", "haState": "NotEnabled", "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", @@ -24,9 +25,13 @@ "publicNetworkAccess": "Enabled", "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 7 + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" }, "haEnabled": "Enabled", + "standbyCount": 1, + "logBackupStorageSku": "Standard_ZRS", "availabilityZone": "1", "standbyAvailabilityZone": "2", "maintenanceWindow": { @@ -49,6 +54,7 @@ "properties": { "administratorLogin": "testuser", "version": "12", + "minorVersion": "6", "state": "Ready", "haState": "Healthy", "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", @@ -56,9 +62,13 @@ "publicNetworkAccess": "Enabled", "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 7 + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" }, "haEnabled": "Disabled", + "standbyCount": 0, + "logBackupStorageSku": "Standard_ZRS", "availabilityZone": "2", "maintenanceWindow": { "dayOfWeek": 0, @@ -80,6 +90,7 @@ "properties": { "administratorLogin": "testuser", "version": "12", + "minorVersion": "6", "state": "Ready", "haState": "Healthy", "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", @@ -87,9 +98,13 @@ "publicNetworkAccess": "Enabled", "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 7 + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" }, "haEnabled": "Disabled", + "standbyCount": 0, + "logBackupStorageSku": "Standard_ZRS", "availabilityZone": "3", "maintenanceWindow": { "dayOfWeek": 0, diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerUpdate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerUpdate.json index 60c9bb9ae82a..ebcb79ed0800 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerUpdate.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerUpdate.json @@ -29,6 +29,7 @@ "properties": { "administratorLogin": "cloudsa", "version": "12", + "minorVersion": "6", "state": "Ready", "haState": "NotEnabled", "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", @@ -36,11 +37,15 @@ "publicNetworkAccess": "Enabled", "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 20 + "backupRetentionDays": 20, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" }, "delegatedSubnetArguments": {}, "privateDnsZoneArguments": {}, "haEnabled": "Disabled", + "standbyCount": 0, + "logBackupStorageSku": "Standard_ZRS", "availabilityZone": "1" }, "location": "westus", diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerUpdateWithCustomerMaintenanceWindow.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerUpdateWithCustomerMaintenanceWindow.json index 26e2330fffcd..034dbc34e0f7 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerUpdateWithCustomerMaintenanceWindow.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerUpdateWithCustomerMaintenanceWindow.json @@ -26,6 +26,7 @@ "properties": { "administratorLogin": "cloudsa", "version": "12", + "minorVersion": "6", "state": "Ready", "haState": "NotEnabled", "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", @@ -33,11 +34,15 @@ "publicNetworkAccess": "Enabled", "storageProfile": { "storageMB": 524288, - "backupRetentionDays": 20 + "backupRetentionDays": 20, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" }, "delegatedSubnetArguments": {}, "privateDnsZoneArguments": {}, "haEnabled": "Disabled", + "standbyCount": 0, + "logBackupStorageSku": "Standard_ZRS", "availabilityZone": "1", "maintenanceWindow": { "dayOfWeek": 0, diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/postgresql.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/postgresql.json index 6cb9ac4eb47d..2f9d84b9b974 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/postgresql.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/postgresql.json @@ -1189,6 +1189,11 @@ "$ref": "#/definitions/ServerVersion", "description": "PostgreSQL Server version." }, + "minorVersion": { + "type": "string", + "description": "The minor version of the server.", + "readOnly": true + }, "state": { "type": "string", "description": "A state of a server that is visible to user.", @@ -1252,7 +1257,11 @@ }, "maintenanceWindow": { "$ref": "#/definitions/MaintenanceWindow", - "description": "Maintenance window of a server." + "description": "Maintenance window of a server.", + "x-ms-mutability": [ + "update", + "read" + ] }, "haEnabled": { "type": "string", @@ -1266,6 +1275,23 @@ "modelAsString": false } }, + "standbyCount": { + "type": "integer", + "format": "int32", + "description": "The number of standbys.", + "x-ms-mutability": [ + "update", + "read" + ] + }, + "logBackupStorageSku": { + "type": "string", + "description": "The log backup storage sku of the server.", + "x-ms-mutability": [ + "create", + "read" + ] + }, "sourceServerName": { "type": "string", "description": "The source PostgreSQL server name to restore from." @@ -1285,7 +1311,11 @@ }, "availabilityZone": { "type": "string", - "description": "availability Zone information of the server." + "description": "availability Zone information of the server.", + "x-ms-mutability": [ + "create", + "read" + ] }, "standbyAvailabilityZone": { "type": "string", @@ -1409,9 +1439,22 @@ "modelAsString": false } }, + "standbyCount": { + "type": "integer", + "format": "int32", + "description": "The number of standbys.", + "x-ms-mutability": [ + "update", + "read" + ] + }, "maintenanceWindow": { "$ref": "#/definitions/MaintenanceWindow", - "description": "Maintenance window of a server." + "description": "Maintenance window of a server.", + "x-ms-mutability": [ + "update", + "read" + ] } } }, @@ -1468,6 +1511,28 @@ "type": "integer", "format": "int32", "description": "Max storage allowed for a server." + }, + "geoRedundantBackup": { + "type": "string", + "description": "A value indicating whether Geo-Redundant backup is enabled on the server.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "GeoRedundantBackupEnum", + "modelAsString": true + }, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "earliestRestoreDate": { + "type": "string", + "format": "date-time", + "description": "The earliest restore point time (ISO8601 format) for server.", + "readOnly": true } }, "description": "Storage Profile properties of a server" diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/IntelligentPerformance.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/IntelligentPerformance.json new file mode 100644 index 000000000000..fc1e1a167bd7 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/IntelligentPerformance.json @@ -0,0 +1,341 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2021-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/advisors/{advisorName}": { + "get": { + "tags": [ + "Advisors" + ], + "operationId": "Advisors_Get", + "x-ms-examples": { + "AdvisorsGet": { + "$ref": "./examples/AdvisorsGet.json" + } + }, + "description": "Get a recommendation action advisor.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/AdvisorNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Advisor" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/advisors": { + "get": { + "tags": [ + "Advisors" + ], + "operationId": "Advisors_ListByServer", + "x-ms-examples": { + "AdvisorsListByServer": { + "$ref": "./examples/AdvisorsListByServer.json" + } + }, + "description": "List recommendation action advisors.", + "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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AdvisorsResultList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/advisors/{advisorName}/recommendedActions": { + "get": { + "tags": [ + "RecommendedActions" + ], + "operationId": "RecommendedActions_ListByServer", + "x-ms-examples": { + "RecommendedActionsListByServer": { + "$ref": "./examples/RecommendedActionsListByServer.json" + } + }, + "description": "Retrieve recommended actions from the advisor.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/AdvisorNameParameter" + }, + { + "name": "sessionId", + "in": "query", + "required": false, + "type": "string", + "description": "The recommendation action session identifier." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecommendationActionsResultList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AdvisorProperties": { + "type": "object", + "properties": {}, + "description": "The properties of a recommendation action advisor." + }, + "Advisor": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AdvisorProperties", + "x-ms-client-flatten": true, + "description": "The properties of a recommendation action advisor." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "readOnly": true, + "description": "Represents a recommendation action advisor." + }, + "AdvisorsResultList": { + "description": "A list of query statistics.", + "type": "object", + "properties": { + "value": { + "description": "The list of recommendation action advisors.", + "type": "array", + "items": { + "$ref": "#/definitions/Advisor" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "RecommendationActionProperties": { + "type": "object", + "properties": { + "advisorName": { + "type": "string", + "description": "Advisor name." + }, + "sessionId": { + "type": "string", + "description": "Recommendation action session identifier." + }, + "actionId": { + "type": "integer", + "format": "int32", + "description": "Recommendation action identifier." + }, + "createdTime": { + "type": "string", + "format": "date-time", + "description": "Recommendation action creation time." + }, + "expirationTime": { + "type": "string", + "format": "date-time", + "description": "Recommendation action expiration time." + }, + "reason": { + "type": "string", + "description": "Recommendation action reason." + }, + "recommendationType": { + "type": "string", + "description": "Recommendation action type." + }, + "details": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Recommendation action details." + } + }, + "description": "The properties of a recommendation action." + }, + "RecommendationAction": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RecommendationActionProperties", + "x-ms-client-flatten": true, + "description": "The properties of a recommendation action." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "readOnly": true, + "description": "Represents a Recommendation Action." + }, + "RecommendationActionsResultList": { + "description": "A list of recommendation actions.", + "type": "object", + "properties": { + "value": { + "description": "The list of recommendation action advisors.", + "type": "array", + "items": { + "$ref": "#/definitions/RecommendationAction" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse" + } + }, + "description": "An error response from the Batch service." + } + }, + "parameters": { + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "description": "The name of the server.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "AdvisorNameParameter": { + "name": "advisorName", + "in": "path", + "required": true, + "type": "string", + "description": "The advisor name for recommendation action.", + "x-ms-parameter-location": "method" + }, + "RecommendedActionNameParameter": { + "name": "recommendedActionName", + "in": "path", + "required": true, + "type": "string", + "description": "The recommended action name.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/QueryPerformanceInsights.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/QueryPerformanceInsights.json new file mode 100644 index 000000000000..e1bc6547fd5a --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/QueryPerformanceInsights.json @@ -0,0 +1,661 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2021-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/resetQueryPerformanceInsightData": { + "post": { + "tags": [ + "ResetQueryPerformanceInsightData" + ], + "operationId": "QueryPerformanceInsightData_Reset", + "x-ms-examples": { + "QueryPerformanceInsightResetData": { + "$ref": "./examples/QueryPerformanceInsightResetData.json" + } + }, + "description": "Reset data for Query Performance Insight.", + "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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/QueryPerformanceInsightResetDataResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/queryTexts/{queryId}": { + "get": { + "tags": [ + "QueryTexts" + ], + "operationId": "QueryTexts_Get", + "x-ms-examples": { + "QueryTextsGet": { + "$ref": "./examples/QueryTextsGet.json" + } + }, + "description": "Retrieve the Query-Store query texts for the queryId.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/QueryIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/QueryText" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/queryTexts": { + "get": { + "tags": [ + "QueryTexts" + ], + "operationId": "QueryTexts_ListByServer", + "x-ms-examples": { + "QueryTextsListByServer": { + "$ref": "./examples/QueryTextsListByServer.json" + } + }, + "description": "Retrieve the Query-Store query texts for specified queryIds.", + "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/ServerNameParameter" + }, + { + "name": "queryIds", + "in": "query", + "required": true, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "description": "The query identifiers" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/QueryTextsResultList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/topQueryStatistics": { + "get": { + "tags": [ + "TopQueryStatistics" + ], + "operationId": "TopQueryStatistics_ListByServer", + "x-ms-examples": { + "TopQueryStatisticsListByServer": { + "$ref": "./examples/TopQueryStatisticsListByServer.json" + } + }, + "description": "Retrieve the Query-Store top queries for specified metric and aggregation.", + "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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TopQueryStatisticsResultList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/waitStatistics": { + "get": { + "tags": [ + "WaitStatistics" + ], + "operationId": "WaitStatistics_ListByServer", + "x-ms-examples": { + "WaitStatisticsListByServer": { + "$ref": "./examples/WaitStatisticsListByServer.json" + } + }, + "description": "Retrieve wait statistics for specified aggregation window.", + "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/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WaitStatisticsInput" + }, + "description": "The required parameters for retrieving wait statistics." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WaitStatisticsResultList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "QueryPerformanceInsightResetDataResult": { + "description": "Result of Query Performance Insight data reset.", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "QueryPerformanceInsightResetDataResultState", + "modelAsString": true + }, + "description": "Indicates result of the operation." + }, + "message": { + "type": "string", + "description": "result operation message." + } + } + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse" + } + }, + "description": "An error response from the Batch service." + }, + "QueryTextProperties": { + "type": "object", + "properties": { + "queryId": { + "type": "string", + "description": "Query identifier unique to the server." + }, + "queryText": { + "type": "string", + "description": "Query text." + } + }, + "description": "The properties of a query text." + }, + "QueryText": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/QueryTextProperties", + "x-ms-client-flatten": true, + "description": "The properties of a query text." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "description": "Represents a Query Text." + }, + "QueryTextsResultList": { + "description": "A list of query texts.", + "type": "object", + "properties": { + "value": { + "description": "The list of query texts.", + "type": "array", + "items": { + "$ref": "#/definitions/QueryText" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "TopQueryStatisticsInputProperties": { + "type": "object", + "properties": { + "numberOfTopQueries": { + "type": "integer", + "format": "int32", + "description": "Max number of top queries to return." + }, + "aggregationFunction": { + "type": "string", + "description": "Aggregation function name." + }, + "observedMetric": { + "type": "string", + "description": "Observed metric name." + }, + "observationStartTime": { + "type": "string", + "format": "date-time", + "description": "Observation start time." + }, + "observationEndTime": { + "type": "string", + "format": "date-time", + "description": "Observation end time." + }, + "aggregationWindow": { + "type": "string", + "description": "Aggregation interval type in ISO 8601 format." + } + }, + "required": [ + "numberOfTopQueries", + "aggregationFunction", + "observedMetric", + "observationStartTime", + "observationEndTime", + "aggregationWindow" + ], + "description": "The properties for input to get top query statistics" + }, + "TopQueryStatisticsInput": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/TopQueryStatisticsInputProperties", + "x-ms-client-flatten": true, + "description": "The properties of a wait statistics input." + } + }, + "required": [ + "properties" + ], + "description": "Input to get top query statistics" + }, + "QueryStatisticProperties": { + "type": "object", + "properties": { + "queryId": { + "type": "string", + "description": "Database query identifier." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Observation start time." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "Observation end time." + }, + "aggregationFunction": { + "type": "string", + "description": "Aggregation function name." + }, + "databaseNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of database names." + }, + "queryExecutionCount": { + "type": "integer", + "format": "int64", + "description": "Number of query executions in this time interval." + }, + "metricName": { + "type": "string", + "description": "Metric name." + }, + "metricDisplayName": { + "type": "string", + "description": "Metric display name." + }, + "metricValue": { + "type": "number", + "format": "double", + "description": "Metric value." + }, + "metricValueUnit": { + "type": "string", + "description": "Metric value unit." + } + }, + "description": "The properties of a query statistic." + }, + "QueryStatistic": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/QueryStatisticProperties", + "x-ms-client-flatten": true, + "description": "The properties of a query statistic." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "description": "Represents a Query Statistic." + }, + "TopQueryStatisticsResultList": { + "description": "A list of query statistics.", + "type": "object", + "properties": { + "value": { + "description": "The list of top query statistics.", + "type": "array", + "items": { + "$ref": "#/definitions/QueryStatistic" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "WaitStatisticsInputProperties": { + "type": "object", + "properties": { + "observationStartTime": { + "type": "string", + "format": "date-time", + "description": "Observation start time." + }, + "observationEndTime": { + "type": "string", + "format": "date-time", + "description": "Observation end time." + }, + "aggregationWindow": { + "type": "string", + "description": "Aggregation interval type in ISO 8601 format." + } + }, + "required": [ + "observationStartTime", + "observationEndTime", + "aggregationWindow" + ], + "description": "The properties for input to get wait statistics" + }, + "WaitStatisticsInput": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/WaitStatisticsInputProperties", + "x-ms-client-flatten": true, + "description": "The properties of a wait statistics input." + } + }, + "required": [ + "properties" + ], + "description": "Input to get wait statistics" + }, + "WaitStatisticProperties": { + "type": "object", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "Observation start time." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "Observation end time." + }, + "eventName": { + "type": "string", + "description": "Wait event name." + }, + "eventTypeName": { + "type": "string", + "description": "Wait event type name." + }, + "queryId": { + "type": "integer", + "format": "int64", + "description": "Database query identifier." + }, + "databaseName": { + "type": "string", + "description": "Database Name." + }, + "userId": { + "type": "integer", + "format": "int64", + "description": "Database user identifier." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Wait event count observed in this time interval." + }, + "totalTimeInMs": { + "type": "number", + "format": "double", + "description": "Total time of wait in milliseconds in this time interval." + } + }, + "description": "The properties of a wait statistic." + }, + "WaitStatistic": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/WaitStatisticProperties", + "x-ms-client-flatten": true, + "description": "The properties of a wait statistic." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "description": "Represents a Wait Statistic." + }, + "WaitStatisticsResultList": { + "description": "A list of wait statistics.", + "type": "object", + "properties": { + "value": { + "description": "The list of wait statistics.", + "type": "array", + "items": { + "$ref": "#/definitions/WaitStatistic" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "description": "The name of the server.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "QueryIdParameter": { + "name": "queryId", + "in": "path", + "required": true, + "type": "string", + "description": "The Query-Store query identifier.", + "x-ms-parameter-location": "method" + }, + "QueryStatisticIdParameter": { + "name": "queryStatisticId", + "in": "path", + "required": true, + "type": "string", + "description": "The Query Statistic identifier.", + "x-ms-parameter-location": "method" + }, + "WaitStatisticsIdParameter": { + "name": "waitStatisticsId", + "in": "path", + "required": true, + "type": "string", + "description": "The Wait Statistic identifier.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/AdvisorsGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/AdvisorsGet.json new file mode 100644 index 000000000000..59427387778a --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/AdvisorsGet.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testResourceGroupName", + "serverName": "testServerName", + "advisorName": "Index" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testResourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/testServerName/advisors/Index", + "name": "Index", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/advisors", + "properties": {} + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/AdvisorsListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/AdvisorsListByServer.json new file mode 100644 index 000000000000..cc25bb6522d6 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/AdvisorsListByServer.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testResourceGroupName", + "serverName": "testServerName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testResourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/testServerName/advisors/Index", + "name": "Index", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/advisors", + "properties": {} + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/CapabilitiesByLocation.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/CapabilitiesByLocation.json new file mode 100644 index 000000000000..8aff1edd624b --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/CapabilitiesByLocation.json @@ -0,0 +1,6094 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "locationName": "WestUS" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "zone": "none", + "geoBackupSupported": true, + "zoneRedundantHaSupported": true, + "zoneRedundantHaAndGeoBackupSupported": true, + "supportedFlexibleServerEditions": [ + { + "name": "Burstable", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "GeneralPurpose", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "MemoryOptimized", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + } + ], + "supportedHyperscaleNodeEditions": [ + { + "name": "GeneralPurpose", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + }, + { + "name": "33553408", + "supportedIops": 20000, + "storageSizeMB": 33553408, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "11.0", + "supportedVcores": [ + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "11.2", + "supportedVcores": [ + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "11.2.8", + "supportedVcores": [ + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + } + ], + "supportedNodeTypes": [ + { + "name": "Coordinator", + "nodeType": "Coordinator", + "status": "Default" + } + ], + "status": "Available" + }, + { + "name": "MemoryOptimized", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + }, + { + "name": "33553408", + "supportedIops": 20000, + "storageSizeMB": 33553408, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "11.0", + "supportedVcores": [ + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "11.2", + "supportedVcores": [ + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "11.2.8", + "supportedVcores": [ + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + } + ], + "supportedNodeTypes": [ + { + "name": "Worker", + "nodeType": "Worker", + "status": "Default" + } + ], + "status": "Available" + } + ], + "status": "Default" + }, + { + "zone": "1", + "geoBackupSupported": true, + "zoneRedundantHaSupported": true, + "zoneRedundantHaAndGeoBackupSupported": true, + "supportedFlexibleServerEditions": [ + { + "name": "Burstable", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "GeneralPurpose", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "MemoryOptimized", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + } + ], + "supportedHyperscaleNodeEditions": [], + "status": "Available" + }, + { + "zone": "2", + "geoBackupSupported": true, + "zoneRedundantHaSupported": true, + "zoneRedundantHaAndGeoBackupSupported": true, + "supportedFlexibleServerEditions": [ + { + "name": "Burstable", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "GeneralPurpose", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "MemoryOptimized", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + } + ], + "supportedHyperscaleNodeEditions": [], + "status": "Available" + }, + { + "zone": "3", + "geoBackupSupported": true, + "zoneRedundantHaSupported": true, + "zoneRedundantHaAndGeoBackupSupported": true, + "supportedFlexibleServerEditions": [ + { + "name": "Burstable", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "GeneralPurpose", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "MemoryOptimized", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + } + ], + "supportedHyperscaleNodeEditions": [], + "status": "Available" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/CheckNameAvailability.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..1b845bdb290c --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/CheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "nameAvailabilityRequest": { + "name": "name1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "message": "", + "name": "name1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ConfigurationGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ConfigurationGet.json new file mode 100644 index 000000000000..fb6ca8eaaecc --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ConfigurationGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "configurationName": "array_nulls", + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "properties": { + "value": "on", + "description": "Enable input of NULL elements in arrays.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/array_nulls", + "name": "array_nulls", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ConfigurationListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ConfigurationListByServer.json new file mode 100644 index 000000000000..3181ad5eda3f --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ConfigurationListByServer.json @@ -0,0 +1,1902 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff//resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations?api-version=2021-06-01-preview&$top=200&$skiptoken=skiptoken", + "value": [ + { + "properties": { + "value": "", + "description": "Sets the application name to be reported in statistics and logs.", + "defaultValue": "", + "dataType": "String", + "allowedValues": "[A-Za-z0-9._-]*", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/application_name", + "name": "application_name", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables input of NULL elements in arrays.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/array_nulls", + "name": "array_nulls", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Starts the autovacuum subprocess.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum", + "name": "autovacuum", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.1", + "description": "Number of tuple inserts, updates, or deletes prior to analyze as a fraction of reltuples.", + "defaultValue": "0.1", + "dataType": "Numeric", + "allowedValues": "0-100", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_analyze_scale_factor", + "name": "autovacuum_analyze_scale_factor", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "50", + "description": "Minimum number of tuple inserts, updates, or deletes prior to analyze.", + "defaultValue": "50", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_analyze_threshold", + "name": "autovacuum_analyze_threshold", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "60", + "description": "Time to sleep between autovacuum runs.", + "defaultValue": "60", + "dataType": "Integer", + "allowedValues": "1-2147483", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_naptime", + "name": "autovacuum_naptime", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "Vacuum cost delay in milliseconds, for autovacuum.", + "defaultValue": "2", + "dataType": "Integer", + "allowedValues": "-1-100", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_vacuum_cost_delay", + "name": "autovacuum_vacuum_cost_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-1", + "description": "Vacuum cost amount available before napping, for autovacuum.", + "defaultValue": "-1", + "dataType": "Integer", + "allowedValues": "-1-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_vacuum_cost_limit", + "name": "autovacuum_vacuum_cost_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.2", + "description": "Number of tuple updates or deletes prior to vacuum as a fraction of reltuples.", + "defaultValue": "0.2", + "dataType": "Numeric", + "allowedValues": "0-100", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_vacuum_scale_factor", + "name": "autovacuum_vacuum_scale_factor", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "50", + "description": "Minimum number of tuple updates or deletes prior to vacuum.", + "defaultValue": "50", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_vacuum_threshold", + "name": "autovacuum_vacuum_threshold", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-1", + "description": "Sets the maximum memory to be used by each autovacuum worker process.", + "defaultValue": "-1", + "dataType": "Integer", + "allowedValues": "-1-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_work_mem", + "name": "autovacuum_work_mem", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Number of pages after which previously performed writes are flushed to disk.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-256", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/backend_flush_after", + "name": "backend_flush_after", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "safe_encoding", + "description": "Sets whether \"\\'\" is allowed in string literals.", + "defaultValue": "safe_encoding", + "dataType": "Enumeration", + "allowedValues": "safe_encoding,on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/backslash_quote", + "name": "backslash_quote", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "200", + "description": "Background writer sleep time between rounds.", + "defaultValue": "200", + "dataType": "Integer", + "allowedValues": "10-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/bgwriter_delay", + "name": "bgwriter_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "64", + "description": "Number of pages after which previously performed writes are flushed to disk.", + "defaultValue": "64", + "dataType": "Integer", + "allowedValues": "0-256", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/bgwriter_flush_after", + "name": "bgwriter_flush_after", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "100", + "description": "Background writer maximum number of LRU pages to flush per round.", + "defaultValue": "100", + "dataType": "Integer", + "allowedValues": "0-1073741823", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/bgwriter_lru_maxpages", + "name": "bgwriter_lru_maxpages", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "Multiple of the average buffer usage to free per round.", + "defaultValue": "2", + "dataType": "Numeric", + "allowedValues": "0-10", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/bgwriter_lru_multiplier", + "name": "bgwriter_lru_multiplier", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "hex", + "description": "Sets the output format for bytea.", + "defaultValue": "hex", + "dataType": "Enumeration", + "allowedValues": "escape,hex", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/bytea_output", + "name": "bytea_output", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Checks function bodies during CREATE FUNCTION.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/check_function_bodies", + "name": "check_function_bodies", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.5", + "description": "Time spent flushing dirty buffers during checkpoint, as fraction of checkpoint interval.", + "defaultValue": "0.5", + "dataType": "Numeric", + "allowedValues": "0-1", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/checkpoint_completion_target", + "name": "checkpoint_completion_target", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "300", + "description": "Sets the maximum time between automatic WAL checkpoints.", + "defaultValue": "300", + "dataType": "Integer", + "allowedValues": "30-86400", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/checkpoint_timeout", + "name": "checkpoint_timeout", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "30", + "description": "Enables warnings if checkpoint segments are filled more frequently than this.", + "defaultValue": "30", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/checkpoint_warning", + "name": "checkpoint_warning", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "sql_ascii", + "description": "Sets the client's character set encoding.", + "defaultValue": "sql_ascii", + "dataType": "Enumeration", + "allowedValues": "BIG5,EUC_CN,EUC_JP,EUC_JIS_2004,EUC_KR,EUC_TW,GB18030,GBK,ISO_8859_5,ISO_8859_6,ISO_8859_7,ISO_8859_8,JOHAB,KOI8R,KOI8U,LATIN1,LATIN2,LATIN3,LATIN4,LATIN5,LATIN6,LATIN7,LATIN8,LATIN9,LATIN10,MULE_INTERNAL,SJIS,SHIFT_JIS_2004,SQL_ASCII,UHC,UTF8,WIN866,WIN874,WIN1250,WIN1251,WIN1252,WIN1253,WIN1254,WIN1255,WIN1256,WIN1257,WIN1258", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/client_encoding", + "name": "client_encoding", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "notice", + "description": "Sets the message levels that are sent to the client.", + "defaultValue": "notice", + "dataType": "Enumeration", + "allowedValues": "debug5,debug4,debug3,debug2,debug1,log,notice,warning,error", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/client_min_messages", + "name": "client_min_messages", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Sets the delay in microseconds between transaction commit and flushing WAL to disk.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-100000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/commit_delay", + "name": "commit_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "5", + "description": "Sets the minimum concurrent open transactions before performing commit_delay.", + "defaultValue": "5", + "dataType": "Integer", + "allowedValues": "0-1000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/commit_siblings", + "name": "commit_siblings", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "partition", + "description": "Enables the planner to use constraints to optimize queries.", + "defaultValue": "partition", + "dataType": "Enumeration", + "allowedValues": "partition,on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/constraint_exclusion", + "name": "constraint_exclusion", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.005", + "description": "Sets the planner's estimate of the cost of processing each index entry during an index scan.", + "defaultValue": "0.005", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/cpu_index_tuple_cost", + "name": "cpu_index_tuple_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.0025", + "description": "Sets the planner's estimate of the cost of processing each operator or function call.", + "defaultValue": "0.0025", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/cpu_operator_cost", + "name": "cpu_operator_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.01", + "description": "Sets the planner's estimate of the cost of processing each tuple (row).", + "defaultValue": "0.01", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/cpu_tuple_cost", + "name": "cpu_tuple_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.1", + "description": "Sets the planner's estimate of the fraction of a cursor's rows that will be retrieved.", + "defaultValue": "0.1", + "dataType": "Numeric", + "allowedValues": "0-1", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/cursor_tuple_fraction", + "name": "cursor_tuple_fraction", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "ISO, MDY", + "description": "Sets the display format for date and time values.", + "defaultValue": "ISO, MDY", + "dataType": "String", + "allowedValues": "(ISO|POSTGRES|SQL|GERMAN)(, (DMY|MDY|YMD))?", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/DateStyle", + "name": "DateStyle", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1000", + "description": "Sets the amount of time, in milliseconds, to wait on a lock before checking for deadlock.", + "defaultValue": "1000", + "dataType": "Integer", + "allowedValues": "1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/deadlock_timeout", + "name": "deadlock_timeout", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Indents parse and plan tree displays.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/debug_pretty_print", + "name": "debug_pretty_print", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs each query's parse tree.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/debug_print_parse", + "name": "debug_print_parse", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs each query's execution plan.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/debug_print_plan", + "name": "debug_print_plan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs each query's rewritten parse tree.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/debug_print_rewritten", + "name": "debug_print_rewritten", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "100", + "description": "Sets the default statistics target.", + "defaultValue": "100", + "dataType": "Integer", + "allowedValues": "1-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_statistics_target", + "name": "default_statistics_target", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "", + "description": "Sets the default tablespace to create tables and indexes in.", + "defaultValue": "", + "dataType": "String", + "allowedValues": "[A-Za-z._]*", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_tablespace", + "name": "default_tablespace", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "pg_catalog.english", + "description": "Sets default text search configuration.", + "defaultValue": "pg_catalog.english", + "dataType": "String", + "allowedValues": "[A-Za-z._]+", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_text_search_config", + "name": "default_text_search_config", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Sets the default deferrable status of new transactions.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_transaction_deferrable", + "name": "default_transaction_deferrable", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "read committed", + "description": "Sets the transaction isolation level of each new transaction.", + "defaultValue": "read committed", + "dataType": "Enumeration", + "allowedValues": "serializable,repeatable read,read committed,read uncommitted", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_transaction_isolation", + "name": "default_transaction_isolation", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Sets the default read-only status of new transactions.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_transaction_read_only", + "name": "default_transaction_read_only", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Creates new tables with OIDs by default.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_with_oids", + "name": "default_with_oids", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "3145728", + "description": "Sets the planner's assumption about the size of the disk cache.", + "defaultValue": "3145728", + "dataType": "Integer", + "allowedValues": "1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/effective_cache_size", + "name": "effective_cache_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of bitmap-scan plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_bitmapscan", + "name": "enable_bitmapscan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of gather merge plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_gathermerge", + "name": "enable_gathermerge", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of hashed aggregation plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_hashagg", + "name": "enable_hashagg", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of hash join plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_hashjoin", + "name": "enable_hashjoin", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of index-only-scan plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_indexonlyscan", + "name": "enable_indexonlyscan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of index-scan plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_indexscan", + "name": "enable_indexscan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of materialization.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_material", + "name": "enable_material", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of merge join plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_mergejoin", + "name": "enable_mergejoin", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of nested loop join plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_nestloop", + "name": "enable_nestloop", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of sequential-scan plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_seqscan", + "name": "enable_seqscan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of explicit sort steps.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_sort", + "name": "enable_sort", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of TID scan plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_tidscan", + "name": "enable_tidscan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Warns about backslash escapes in ordinary string literals.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/escape_string_warning", + "name": "escape_string_warning", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Terminates session on any error.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/exit_on_error", + "name": "exit_on_error", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1", + "description": "Sets the number of digits displayed for floating-point values.", + "defaultValue": "1", + "dataType": "Integer", + "allowedValues": "-15-3", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/extra_float_digits", + "name": "extra_float_digits", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Forces use of parallel query facilities.", + "defaultValue": "off", + "dataType": "Enumeration", + "allowedValues": "off,on,regress", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/force_parallel_mode", + "name": "force_parallel_mode", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "8", + "description": "Sets the FROM-list size beyond which subqueries are not collapsed.", + "defaultValue": "8", + "dataType": "Integer", + "allowedValues": "1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/from_collapse_limit", + "name": "from_collapse_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables genetic query optimization.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo", + "name": "geqo", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "5", + "description": "GEQO: effort is used to set the default for other GEQO parameters.", + "defaultValue": "5", + "dataType": "Integer", + "allowedValues": "1-10", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_effort", + "name": "geqo_effort", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "GEQO: number of iterations of the algorithm.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_generations", + "name": "geqo_generations", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "GEQO: number of individuals in the population.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_pool_size", + "name": "geqo_pool_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "GEQO: seed for random path selection.", + "defaultValue": "0", + "dataType": "Numeric", + "allowedValues": "0-1", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_seed", + "name": "geqo_seed", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "GEQO: selective pressure within the population.", + "defaultValue": "2", + "dataType": "Numeric", + "allowedValues": "1.5-2", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_selection_bias", + "name": "geqo_selection_bias", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "12", + "description": "Sets the threshold of FROM items beyond which GEQO is used.", + "defaultValue": "12", + "dataType": "Integer", + "allowedValues": "2-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_threshold", + "name": "geqo_threshold", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Sets the maximum allowed result for exact search by GIN.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/gin_fuzzy_search_limit", + "name": "gin_fuzzy_search_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "4096", + "description": "Sets the maximum size of the pending list for GIN index.", + "defaultValue": "4096", + "dataType": "Integer", + "allowedValues": "64-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/gin_pending_list_limit", + "name": "gin_pending_list_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Sets the maximum allowed duration of any idling transaction.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/idle_in_transaction_session_timeout", + "name": "idle_in_transaction_session_timeout", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "postgres", + "description": "Sets the display format for interval values.", + "defaultValue": "postgres", + "dataType": "Enumeration", + "allowedValues": "postgres,postgres_verbose,sql_standard,iso_8601", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/IntervalStyle", + "name": "IntervalStyle", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "8", + "description": "Sets the FROM-list size beyond which JOIN constructs are not flattened.", + "defaultValue": "8", + "dataType": "Integer", + "allowedValues": "1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/join_collapse_limit", + "name": "join_collapse_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "en_US.utf-8", + "description": "Sets the locale for formatting monetary amounts.", + "defaultValue": "en_US.utf-8", + "dataType": "String", + "allowedValues": "[A-Za-z0-9._ -]+", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/lc_monetary", + "name": "lc_monetary", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "en_US.utf-8", + "description": "Sets the locale for formatting numbers.", + "defaultValue": "en_US.utf-8", + "dataType": "String", + "allowedValues": "[A-Za-z0-9._ -]+", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/lc_numeric", + "name": "lc_numeric", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Enables backward compatibility mode for privilege checks on large objects.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/lo_compat_privileges", + "name": "lo_compat_privileges", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Sets the maximum allowed duration (in milliseconds) of any wait for a lock. 0 turns this off.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/lock_timeout", + "name": "lock_timeout", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-1", + "description": "Sets the minimum execution time above which autovacuum actions will be logged.", + "defaultValue": "-1", + "dataType": "Integer", + "allowedValues": "-1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_autovacuum_min_duration", + "name": "log_autovacuum_min_duration", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Logs each checkpoint.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_checkpoints", + "name": "log_checkpoints", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Logs each successful connection.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_connections", + "name": "log_connections", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "stderr", + "description": "Sets the destination for server log output.", + "defaultValue": "stderr", + "dataType": "Enumeration", + "allowedValues": "stderr,csvlog", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_destination", + "name": "log_destination", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs end of a session, including duration.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_disconnections", + "name": "log_disconnections", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs the duration of each completed SQL statement.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_duration", + "name": "log_duration", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "default", + "description": "Sets the verbosity of logged messages.", + "defaultValue": "default", + "dataType": "Enumeration", + "allowedValues": "terse,default,verbose", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_error_verbosity", + "name": "log_error_verbosity", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs long lock waits.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_lock_waits", + "name": "log_lock_waits", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-1", + "description": "Sets the minimum execution time (in milliseconds) above which statements will be logged. -1 disables logging statement durations.", + "defaultValue": "-1", + "dataType": "Integer", + "allowedValues": "-1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_min_duration_statement", + "name": "log_min_duration_statement", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "error", + "description": "Causes all statements generating error at or above this level to be logged.", + "defaultValue": "error", + "dataType": "Enumeration", + "allowedValues": "debug5,debug4,debug3,debug2,debug1,info,notice,warning,error,log,fatal,panic", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_min_error_statement", + "name": "log_min_error_statement", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "warning", + "description": "Sets the message levels that are logged.", + "defaultValue": "warning", + "dataType": "Enumeration", + "allowedValues": "debug5,debug4,debug3,debug2,debug1,info,notice,warning,error,log,fatal,panic", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_min_messages", + "name": "log_min_messages", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs each replication command.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_replication_commands", + "name": "log_replication_commands", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "none", + "description": "Sets the type of statements logged.", + "defaultValue": "none", + "dataType": "Enumeration", + "allowedValues": "none,ddl,mod,all", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_statement", + "name": "log_statement", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "For each query, writes cumulative performance statistics to the server log.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_statement_stats", + "name": "log_statement_stats", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-1", + "description": "Logs the use of temporary files larger than this number of kilobytes.", + "defaultValue": "-1", + "dataType": "Integer", + "allowedValues": "-1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_temp_files", + "name": "log_temp_files", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "332800", + "description": "Sets the maximum memory to be used for maintenance operations.", + "defaultValue": "332800", + "dataType": "Integer", + "allowedValues": "1024-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/maintenance_work_mem", + "name": "maintenance_work_mem", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "8", + "description": "Sets the maximum number of parallel workers than can be active at one time.", + "defaultValue": "8", + "dataType": "Integer", + "allowedValues": "0-1024", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_parallel_workers", + "name": "max_parallel_workers", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "Sets the maximum number of parallel processes per executor node.", + "defaultValue": "2", + "dataType": "Integer", + "allowedValues": "0-1024", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_parallel_workers_per_gather", + "name": "max_parallel_workers_per_gather", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "Sets the maximum number of predicate-locked tuples per page.", + "defaultValue": "2", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_pred_locks_per_page", + "name": "max_pred_locks_per_page", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-2", + "description": "Sets the maximum number of predicate-locked pages and tuples per relation.", + "defaultValue": "-2", + "dataType": "Integer", + "allowedValues": "-2147483648-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_pred_locks_per_relation", + "name": "max_pred_locks_per_relation", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "30000", + "description": "Sets the maximum delay before canceling queries when a hot standby server is processing archived WAL data.", + "defaultValue": "30000", + "dataType": "Integer", + "allowedValues": "-1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_standby_archive_delay", + "name": "max_standby_archive_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "30000", + "description": "Sets the maximum delay before canceling queries when a hot standby server is processing streamed WAL data.", + "defaultValue": "30000", + "dataType": "Integer", + "allowedValues": "-1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_standby_streaming_delay", + "name": "max_standby_streaming_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "Maximum number of table synchronization workers per subscription.", + "defaultValue": "2", + "dataType": "Integer", + "allowedValues": "0-262143", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_sync_workers_per_subscription", + "name": "max_sync_workers_per_subscription", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1024", + "description": "Sets the WAL size that triggers a checkpoint.", + "defaultValue": "1024", + "dataType": "Integer", + "allowedValues": "2-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_wal_size", + "name": "max_wal_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "64", + "description": "Sets the minimum amount of index data for a parallel scan.", + "defaultValue": "64", + "dataType": "Integer", + "allowedValues": "0-715827882", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/min_parallel_index_scan_size", + "name": "min_parallel_index_scan_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1024", + "description": "Sets the minimum amount of table data for a parallel scan.", + "defaultValue": "1024", + "dataType": "Integer", + "allowedValues": "0-715827882", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/min_parallel_table_scan_size", + "name": "min_parallel_table_scan_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "80", + "description": "Sets the minimum size to shrink the WAL to.", + "defaultValue": "80", + "dataType": "Integer", + "allowedValues": "2-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/min_wal_size", + "name": "min_wal_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Emits a warning for constructs that changed meaning since PostgreSQL 9.4.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/operator_precedence_warning", + "name": "operator_precedence_warning", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1000", + "description": "Sets the planner's estimate of the cost of starting up worker processes for parallel query.", + "defaultValue": "1000", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/parallel_setup_cost", + "name": "parallel_setup_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.1", + "description": "Sets the planner's estimate of the cost of passing each tuple (row) from worker to master backend.", + "defaultValue": "0.1", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/parallel_tuple_cost", + "name": "parallel_tuple_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "When generating SQL fragments, quotes all identifiers.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/quote_all_identifiers", + "name": "quote_all_identifiers", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "4", + "description": "Sets the planner's estimate of the cost of a nonsequentially fetched disk page.", + "defaultValue": "4", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/random_page_cost", + "name": "random_page_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables row security.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/row_security", + "name": "row_security", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "\"$user\", public", + "description": "Sets the schema search order for names that are not schema-qualified.", + "defaultValue": "\"$user\", public", + "dataType": "String", + "allowedValues": "[A-Za-z.\"$, ]+", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/search_path", + "name": "search_path", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1", + "description": "Sets the planner's estimate of the cost of a sequentially fetched disk page.", + "defaultValue": "1", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/seq_page_cost", + "name": "seq_page_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "origin", + "description": "Sets the session's behavior for triggers and rewrite rules.", + "defaultValue": "origin", + "dataType": "Enumeration", + "allowedValues": "origin,replica,local", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/session_replication_role", + "name": "session_replication_role", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Causes '...' strings to treat backslashes literally.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/standard_conforming_strings", + "name": "standard_conforming_strings", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Sets the maximum allowed duration (in milliseconds) of any statement. 0 turns this off.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/statement_timeout", + "name": "statement_timeout", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables synchronized sequential scans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/synchronize_seqscans", + "name": "synchronize_seqscans", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Sets the current transaction's synchronization level.", + "defaultValue": "on", + "dataType": "Enumeration", + "allowedValues": "local,remote_write,on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/synchronous_commit", + "name": "synchronous_commit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "9", + "description": "Maximum number of TCP keepalive retransmits.", + "defaultValue": "9", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/tcp_keepalives_count", + "name": "tcp_keepalives_count", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "120", + "description": "Time between issuing TCP keepalives.", + "defaultValue": "120", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/tcp_keepalives_idle", + "name": "tcp_keepalives_idle", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "30", + "description": "Time between TCP keepalive retransmits.", + "defaultValue": "30", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/tcp_keepalives_interval", + "name": "tcp_keepalives_interval", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1024", + "description": "Sets the maximum number of temporary buffers used by each database session.", + "defaultValue": "1024", + "dataType": "Integer", + "allowedValues": "100-1073741823", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/temp_buffers", + "name": "temp_buffers", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "", + "description": "Sets the tablespace(s) to use for temporary tables and sort files.", + "defaultValue": "", + "dataType": "String", + "allowedValues": "[A-Za-z._]*", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/temp_tablespaces", + "name": "temp_tablespaces", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "UTC", + "description": "Sets the time zone for displaying and interpreting time stamps.", + "defaultValue": "UTC", + "dataType": "String", + "allowedValues": "[A-Za-z0-9/+_-]+", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/TimeZone", + "name": "TimeZone", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Collects information about executing commands.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/track_activities", + "name": "track_activities", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Collects statistics on database activity.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/track_counts", + "name": "track_counts", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "none", + "description": "Collects function-level statistics on database activity.", + "defaultValue": "none", + "dataType": "Enumeration", + "allowedValues": "none,pl,all", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/track_functions", + "name": "track_functions", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Collects timing statistics for database I/O activity.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/track_io_timing", + "name": "track_io_timing", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Treats \"expr=NULL\" as \"expr IS NULL\".", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/transform_null_equals", + "name": "transform_null_equals", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Vacuum cost delay in milliseconds.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-100", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_cost_delay", + "name": "vacuum_cost_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "200", + "description": "Vacuum cost amount available before napping.", + "defaultValue": "200", + "dataType": "Integer", + "allowedValues": "1-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_cost_limit", + "name": "vacuum_cost_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "20", + "description": "Vacuum cost for a page dirtied by vacuum.", + "defaultValue": "20", + "dataType": "Integer", + "allowedValues": "0-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_cost_page_dirty", + "name": "vacuum_cost_page_dirty", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1", + "description": "Vacuum cost for a page found in the buffer cache.", + "defaultValue": "1", + "dataType": "Integer", + "allowedValues": "0-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_cost_page_hit", + "name": "vacuum_cost_page_hit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "10", + "description": "Vacuum cost for a page not found in the buffer cache.", + "defaultValue": "10", + "dataType": "Integer", + "allowedValues": "0-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_cost_page_miss", + "name": "vacuum_cost_page_miss", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Number of transactions by which VACUUM and HOT cleanup should be deferred, if any.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-1000000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_defer_cleanup_age", + "name": "vacuum_defer_cleanup_age", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "50000000", + "description": "Minimum age at which VACUUM should freeze a table row.", + "defaultValue": "50000000", + "dataType": "Integer", + "allowedValues": "0-1000000000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_freeze_min_age", + "name": "vacuum_freeze_min_age", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "150000000", + "description": "Age at which VACUUM should scan whole table to freeze tuples.", + "defaultValue": "150000000", + "dataType": "Integer", + "allowedValues": "0-2000000000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_freeze_table_age", + "name": "vacuum_freeze_table_age", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "5000000", + "description": "Minimum age at which VACUUM should freeze a MultiXactId in a table row.", + "defaultValue": "5000000", + "dataType": "Integer", + "allowedValues": "0-1000000000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_multixact_freeze_min_age", + "name": "vacuum_multixact_freeze_min_age", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "150000000", + "description": "Multixact age at which VACUUM should scan whole table to freeze tuples.", + "defaultValue": "150000000", + "dataType": "Integer", + "allowedValues": "0-2000000000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_multixact_freeze_table_age", + "name": "vacuum_multixact_freeze_table_age", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "10", + "description": "Sets the maximum interval between WAL receiver status reports to the primary.", + "defaultValue": "10", + "dataType": "Integer", + "allowedValues": "0-2147483", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/wal_receiver_status_interval", + "name": "wal_receiver_status_interval", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "200", + "description": "Time between WAL flushes performed in the WAL writer.", + "defaultValue": "200", + "dataType": "Integer", + "allowedValues": "1-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/wal_writer_delay", + "name": "wal_writer_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "128", + "description": "Amount of WAL written out by WAL writer that triggers a flush.", + "defaultValue": "128", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/wal_writer_flush_after", + "name": "wal_writer_flush_after", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "115712", + "description": "Sets the amount of memory to be used by internal sort operations and hash tables before writing to temporary disk files.", + "defaultValue": "115712", + "dataType": "Integer", + "allowedValues": "4096-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/work_mem", + "name": "work_mem", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "base64", + "description": "Sets how binary values are to be encoded in XML.", + "defaultValue": "base64", + "dataType": "Enumeration", + "allowedValues": "base64,hex", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/xmlbinary", + "name": "xmlbinary", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "content", + "description": "Sets whether XML data in implicit parsing and serialization operations is to be considered as documents or content fragments.", + "defaultValue": "content", + "dataType": "Enumeration", + "allowedValues": "content,document", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/xmloption", + "name": "xmloption", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ConfigurationUpdate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ConfigurationUpdate.json new file mode 100644 index 000000000000..3bba586d68a6 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ConfigurationUpdate.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "serverName": "testserver", + "configurationName": "event_scheduler", + "resourceGroupName": "testrg", + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "value": "on", + "source": "user-override" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "value": "ON", + "description": "Indicates the status of the Event Scheduler.", + "defaultValue": "OFF", + "dataType": "Enumeration", + "allowedValues": "ON,OFF,DISABLED", + "source": "user-override" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/event_scheduler", + "name": "event_scheduler", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/FirewallRuleCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/FirewallRuleCreate.json new file mode 100644 index 000000000000..a77bb1c22444 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/FirewallRuleCreate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "firewallRuleName": "rule1", + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/servers/testserver/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/servers/testserver/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/FirewallRuleDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/FirewallRuleDelete.json new file mode 100644 index 000000000000..2f675b9a1091 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/FirewallRuleDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "firewallRuleName": "rule1", + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/FirewallRuleGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/FirewallRuleGet.json new file mode 100644 index 000000000000..7268cc29a22c --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/FirewallRuleGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "firewallRuleName": "rule1", + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/servers/testserver/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/FirewallRuleListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/FirewallRuleListByServer.json new file mode 100644 index 000000000000..6c104175fe47 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/FirewallRuleListByServer.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff//resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/firewallRules?api-version=2021-06-01-preview&$top=2&$skiptoken=skiptoken", + "value": [ + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + }, + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/firewallRules/rule2", + "name": "rule2", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "1.0.0.0", + "endIpAddress": "255.0.0.0" + } + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/OperationList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/OperationList.json new file mode 100644 index 000000000000..c7a129c6acc1 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/OperationList.json @@ -0,0 +1,176 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/read", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "PostgreSQL Server", + "operation": "List/Get PostgreSQL Servers", + "description": "Return the list of servers or gets the properties for the specified server." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/write", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "PostgreSQL Server", + "operation": "Create/Update PostgreSQL Server", + "description": "Creates a server with the specified parameters or update the properties or tags for the specified server." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/delete", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "PostgreSQL Server", + "operation": "Delete PostgreSQL Server", + "description": "Deletes an existing server." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules/read", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Firewall Rules", + "operation": "List/Get Firewall Rules", + "description": "Return the list of firewall rules for a server or gets the properties for the specified firewall rule." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules/write", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Firewall Rules", + "operation": "Create/Update Firewall Rule", + "description": "Creates a firewall rule with the specified parameters or update an existing rule." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules/delete", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Firewall Rules", + "operation": "Delete Firewall Rule", + "description": "Deletes an existing firewall rule." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Database Metric Definition", + "operation": "Get database metric definitions", + "description": "Return types of metrics that are available for databases" + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "cpu_percent", + "displayName": "CPU percent", + "displayDescription": "CPU percent", + "unit": "Percent", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "compute_limit", + "displayName": "Compute Unit limit", + "displayDescription": "Compute Unit limit", + "unit": "Count", + "aggregationType": "Average" + }, + { + "name": "compute_consumption_percent", + "displayName": "Compute Unit percentage", + "displayDescription": "Compute Unit percentage", + "unit": "Percent", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "memory_percent", + "displayName": "Memory percent", + "displayDescription": "Memory percent", + "unit": "Percent", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "io_consumption_percent", + "displayName": "IO percent", + "displayDescription": "IO percent", + "unit": "Percent", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "storage_percent", + "displayName": "Storage percentage", + "displayDescription": "Storage percentage", + "unit": "Percent", + "aggregationType": "Average" + }, + { + "name": "storage_used", + "displayName": "Storage used", + "displayDescription": "Storage used", + "unit": "Bytes", + "aggregationType": "Average" + }, + { + "name": "storage_limit", + "displayName": "Storage limit", + "displayDescription": "Storage limit", + "unit": "Bytes", + "aggregationType": "Average" + }, + { + "name": "active_connections", + "displayName": "Total active connections", + "displayDescription": "Total active connections", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "connections_failed", + "displayName": "Total failed connections", + "displayDescription": "Total failed connections", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": true + } + ] + } + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Database Metric Definition", + "operation": "Read diagnostic setting", + "description": "Gets the disagnostic setting for the resource" + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Database Metric Definition", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource" + } + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/QueryPerformanceInsightResetData.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/QueryPerformanceInsightResetData.json new file mode 100644 index 000000000000..38210d965e4d --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/QueryPerformanceInsightResetData.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testResourceGroupName", + "serverName": "testServerName" + }, + "responses": { + "200": { + "body": { + "status": "Succeeded", + "message": "QPI reset data successful" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/QueryTextsGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/QueryTextsGet.json new file mode 100644 index 000000000000..46e29b056d15 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/QueryTextsGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testResourceGroupName", + "serverName": "testServerName", + "queryId": 1 + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testResourceGroupName/providers/Microsoft.DBforMySQL/servers/testServerName/queryTexts/1", + "name": "1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/queryTexts", + "properties": { + "queryId": "1", + "queryText": "UPDATE `performance_schema`.`setup_instruments` SET `ENABLED` = ? , `TIMED` = ? WHERE NAME = ?" + } + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/QueryTextsListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/QueryTextsListByServer.json new file mode 100644 index 000000000000..24c84011360f --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/QueryTextsListByServer.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testResourceGroupName", + "serverName": "testServerName", + "queryIds": [ + "1", + "2" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testResourceGroupName/providers/Microsoft.DBforMySQL/servers/testServerName/queryTexts/1", + "name": "1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/queryTexts", + "properties": { + "queryId": "1", + "queryText": "UPDATE `performance_schema`.`setup_instruments` SET `ENABLED` = ? , `TIMED` = ? WHERE NAME = ?" + } + }, + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testResourceGroupName/providers/Microsoft.DBforMySQL/servers/testServerName/queryTexts/2", + "name": "2", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/queryTexts", + "properties": { + "queryId": "2", + "queryText": "UPDATE `performance_schema`.`setup_instruments` SET `ENABLED` = ? , `TIMED` = ? WHERE NAME LIKE ?" + } + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/RecommendedActionsListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/RecommendedActionsListByServer.json new file mode 100644 index 000000000000..7499eb946c0a --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/RecommendedActionsListByServer.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testResourceGroupName", + "serverName": "testServerName", + "advisorName": "Index" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testResourceGroupName/providers/Microsoft.Sql/flexibleServers/testServerName/advisors/Index/recommendedActions/Index-1", + "name": "Index-1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/advisors/recommendedActions", + "properties": { + "advisorName": "Index", + "sessionId": "c63c2114-e2a4-4c7a-98c1-85577d1a5d50", + "actionId": 1, + "createdTime": "2019-05-01T23:43:24Z", + "expirationTime": "2019-05-08T23:43:24Z", + "reason": "Column `movies_genres`.`movie_id` appear in Join On clause(s).", + "recommendationType": "Add", + "details": { + "engine": "InnoDB", + "script": "alter table `movies`.`movies_genres` add index `idx_movie_id` (`movie_id`)", + "queryIds": "779", + "indexName": "idx_movie_id", + "indexType": "BTREE", + "tableName": "movies_genres", + "schemaName": "movies", + "indexColumns": "`movies_genres`.`movie_id`", + "parentTableName": "movies_genres" + } + } + }, + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testResourceGroupName/providers/Microsoft.Sql/flexibleServers/testServerName/advisors/Index/recommendedActions/Index-2", + "name": "Index-2", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/advisors/recommendedActions", + "properties": { + "advisorName": "Index", + "sessionId": "c63c2114-e2a4-4c7a-98c1-85577d1a5d50", + "actionId": 2, + "createdTime": "2019-05-01T23:43:24Z", + "expirationTime": "2019-05-08T23:43:24Z", + "reason": "Column `movies_genres`.`genre` appear in Group By clause(s).", + "recommendationType": "Add", + "details": { + "engine": "InnoDB", + "script": "alter table `movies`.`movies_genres` add index `idx_genre` (`genre`)", + "queryIds": "779", + "indexName": "idx_genre", + "indexType": "BTREE", + "tableName": "movies_genres", + "schemaName": "movies", + "indexColumns": "`movies_genres`.`genre`", + "parentTableName": "movies_genres" + } + } + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerCreate.json new file mode 100644 index 000000000000..204416eef81e --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerCreate.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLogin": "cloudsa", + "administratorLoginPassword": "password", + "version": "12", + "availabilityZone": "1", + "createMode": "Create", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled" + }, + "network": { + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourcegroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant" + } + }, + "tags": { + "ElasticServer": "1" + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:08:06.7197478+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:08:06.7197478+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerCreatePointInTimeRestore.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerCreatePointInTimeRestore.json new file mode 100644 index 000000000000..76b542fc685a --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerCreatePointInTimeRestore.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "serverName": "pgtestsvc5", + "resourceGroupName": "testrg", + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "properties": { + "createMode": "PointInTimeRestore", + "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/sourcepgservername", + "pointInTimeUTC": "2021-06-27T00:04:59.4078005+00:00" + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc5.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "2", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-27T00:28:17.7279547+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5", + "name": "pgtestsvc5", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc5.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "2", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-27T00:28:17.7279547+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5", + "name": "pgtestsvc5", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerDelete.json new file mode 100644 index 000000000000..5993fc904f16 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerGet.json new file mode 100644 index 000000000000..247569514223 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerGet.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "serverName": "pgtestsvc1", + "resourceGroupName": "testrg", + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc1.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1", + "name": "pgtestsvc1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerGetWithVnet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerGetWithVnet.json new file mode 100644 index 000000000000..d9d4e5fe7d8a --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerGetWithVnet.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerList.json new file mode 100644 index 000000000000..08e74a155bde --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerList.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/flexibleServers?api-version=2021-06-01-preview&$top=3&$skiptoken=skiptoken", + "value": [ + { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + }, + { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc1.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:15:38.8131437+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1", + "name": "pgtestsvc1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerListByResourceGroup.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerListByResourceGroup.json new file mode 100644 index 000000000000..9ca6d7339555 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerListByResourceGroup.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers?api-version=2021-06-01-preview&$top=3&$skiptoken=skiptoken", + "value": [ + { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + }, + { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc1.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:15:38.8131437+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1", + "name": "pgtestsvc1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerRestart.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerRestart.json new file mode 100644 index 000000000000..e35aec2f0a40 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerRestart.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerRestartWithFailover.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerRestartWithFailover.json new file mode 100644 index 000000000000..fdb11d0b1e70 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerRestartWithFailover.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "restartWithFailover": true, + "failoverMode": "forcedFailover" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerStart.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerStart.json new file mode 100644 index 000000000000..e35aec2f0a40 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerStart.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerStop.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerStop.json new file mode 100644 index 000000000000..e35aec2f0a40 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerStop.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerUpdate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerUpdate.json new file mode 100644 index 000000000000..6511eb41b948 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerUpdate.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "TestGroup", + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D8s_v3" + }, + "properties": { + "administratorLoginPassword": "newpassword", + "createMode": "Update", + "storage": { + "storageSizeGB": 1024 + }, + "backup": { + "backupRetentionDays": 20 + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D8s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 1024 + }, + "backup": { + "backupRetentionDays": 20, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerUpdateWithCustomerMaintenanceWindow.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerUpdateWithCustomerMaintenanceWindow.json new file mode 100644 index 000000000000..0475ddb11ff0 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/ServerUpdateWithCustomerMaintenanceWindow.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "properties": { + "createMode": "Update", + "maintenanceWindow": { + "customWindow": "Enabled", + "dayOfWeek": 0, + "startHour": 8, + "startMinute": 0 + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Enabled", + "dayOfWeek": 0, + "startHour": 8, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/TopQueryStatisticsListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/TopQueryStatisticsListByServer.json new file mode 100644 index 000000000000..488621f9cf13 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/TopQueryStatisticsListByServer.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testResourceGroupName", + "serverName": "testServerName", + "parameters": { + "properties": { + "numberOfTopQueries": 5, + "aggregationFunction": "avg", + "observedMetric": "duration", + "observationStartTime": "2019-05-01T20:00:00.000Z", + "observationEndTime": "2019-05-07T20:00:00.000Z", + "aggregationWindow": "PT15M" + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testResourceGroupName/providers/Microsoft.DBforMySQL/servers/testServerName/queryStatistic/66-636923268000000000-636923277000000000-avg-duration", + "name": "66-636923268000000000-636923277000000000-avg-duration", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/queryStatistics", + "properties": { + "aggregationFunction": "avg", + "databaseNames": [ + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testResourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/testServerName/databases/postgresql" + ], + "startTime": "2019-05-01T17:00:00Z", + "endTime": "2019-05-01T17:15:00Z", + "metricDisplayName": "Query duration", + "metricName": "duration", + "metricValue": 123.301446136, + "metricValueUnit": "milliseconds", + "queryExecutionCount": 1, + "queryId": "66" + } + }, + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testResourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/testServerName/queryStatistic/66-636924483000000000-636924492000000000-avg-duration", + "name": "66-636924483000000000-636924492000000000-avg-duration", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/queryStatistics", + "properties": { + "aggregationFunction": "avg", + "databaseNames": [ + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testResourceGroupName/providers/Microsoft.DBforPostgreSQL/flexibleServers/testServerName/databases/postgresql" + ], + "startTime": "2019-05-03T02:45:00Z", + "endTime": "2019-05-03T03:00:00Z", + "metricDisplayName": "Query duration", + "metricName": "duration", + "metricValue": 1712.301446136, + "metricValueUnit": "milliseconds", + "queryExecutionCount": 1, + "queryId": "66" + } + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/VirtualNetworkSubnetUsage.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/VirtualNetworkSubnetUsage.json new file mode 100644 index 000000000000..bab833c15cb2 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/VirtualNetworkSubnetUsage.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "locationName": "WestUS", + "parameters": { + "virtualNetworkArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/testvnet" + } + }, + "responses": { + "200": { + "body": { + "delegatedSubnetsUsage": [ + { + "subnetName": "test-subnet-1", + "usage": 2 + }, + { + "subnetName": "test-subnet-2", + "usage": 3 + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/WaitStatisticsListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/WaitStatisticsListByServer.json new file mode 100644 index 000000000000..94907f5bdea0 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/WaitStatisticsListByServer.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testResourceGroupName", + "serverName": "testServerName", + "parameters": { + "properties": { + "observationStartTime": "2019-05-01T20:00:00.000Z", + "observationEndTime": "2019-05-07T20:00:00.000Z", + "aggregationWindow": "PT15M" + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/hyshim-test/providers/Microsoft.DBforPostgreSQL/servers/hyshim-wait-stats-fix/waitStatistics/636927606000000000-636927615000000000-lock-wait", + "name": "636927606000000000-636927615000000000-lock-wait", + "type": "Microsoft.DBforPostgreSQL/servers/waitStatistics", + "properties": { + "startTime": "2019-05-06T17:30:00Z", + "endTime": "2019-05-06T17:45:00Z", + "eventName": "wait/synch/mutex/mysys/THR_LOCK::mutex", + "eventTypeName": "lock", + "queryId": 2, + "databaseName": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/hyshim-test/providers/Microsoft.DBforPostgreSQL/servers/hyshim-wait-stats-fix/databases/", + "userId": 0, + "count": 4, + "totalTimeInMs": 56.789 + } + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/postgresql.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/postgresql.json new file mode 100644 index 000000000000..566ba6bb956a --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/postgresql.json @@ -0,0 +1,2081 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2021-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}": { + "put": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Create", + "x-ms-examples": { + "Create a new server": { + "$ref": "./examples/ServerCreate.json" + }, + "Create a database as a point in time restore": { + "$ref": "./examples/ServerCreatePointInTimeRestore.json" + } + }, + "description": "Creates a new server.", + "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/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Server" + }, + "description": "The required parameters for creating or updating a server." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Update", + "x-ms-examples": { + "ServerUpdate": { + "$ref": "./examples/ServerUpdate.json" + }, + "ServerUpdateWithCustomerMaintenanceWindow": { + "$ref": "./examples/ServerUpdateWithCustomerMaintenanceWindow.json" + } + }, + "description": "Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.", + "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/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ServerForUpdate" + }, + "description": "The required parameters for updating a server." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Delete", + "x-ms-examples": { + "ServerDelete": { + "$ref": "./examples/ServerDelete.json" + } + }, + "description": "Deletes a server.", + "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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Get", + "x-ms-examples": { + "ServerGet": { + "$ref": "./examples/ServerGet.json" + }, + "ServerGetWithVnet": { + "$ref": "./examples/ServerGetWithVnet.json" + } + }, + "description": "Gets information about a server.", + "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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers": { + "get": { + "tags": [ + "Servers" + ], + "operationId": "Servers_ListByResourceGroup", + "x-ms-examples": { + "ServerListByResourceGroup": { + "$ref": "./examples/ServerListByResourceGroup.json" + } + }, + "description": "List all the servers in a given resource group.", + "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" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/flexibleServers": { + "get": { + "tags": [ + "Servers" + ], + "operationId": "Servers_List", + "x-ms-examples": { + "ServerList": { + "$ref": "./examples/ServerList.json" + } + }, + "description": "List all the servers in a given 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": "OK", + "schema": { + "$ref": "#/definitions/ServerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/restart": { + "post": { + "tags": [ + "ServerRestart" + ], + "operationId": "Servers_Restart", + "x-ms-examples": { + "ServerRestart": { + "$ref": "./examples/ServerRestart.json" + }, + "ServerRestartWithFailover": { + "$ref": "./examples/ServerRestartWithFailover.json" + } + }, + "description": "Restarts a server.", + "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/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "schema": { + "$ref": "#/definitions/RestartParameter" + }, + "description": "The parameters for restarting a server." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/start": { + "post": { + "tags": [ + "ServerStart" + ], + "operationId": "Servers_Start", + "x-ms-examples": { + "ServerStart": { + "$ref": "./examples/ServerStart.json" + } + }, + "description": "Starts a server.", + "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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/stop": { + "post": { + "tags": [ + "ServerStop" + ], + "operationId": "Servers_Stop", + "x-ms-examples": { + "ServerStop": { + "$ref": "./examples/ServerStop.json" + } + }, + "description": "Stops a server.", + "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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/firewallRules/{firewallRuleName}": { + "put": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_CreateOrUpdate", + "x-ms-examples": { + "FirewallRuleCreate": { + "$ref": "./examples/FirewallRuleCreate.json" + } + }, + "description": "Creates a new firewall rule or updates an existing firewall rule.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/FirewallRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FirewallRule" + }, + "description": "The required parameters for creating or updating a firewall rule." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_Delete", + "x-ms-examples": { + "FirewallRuleDelete": { + "$ref": "./examples/FirewallRuleDelete.json" + } + }, + "description": "Deletes a PostgreSQL server firewall rule.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/FirewallRuleNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_Get", + "x-ms-examples": { + "FirewallRuleList": { + "$ref": "./examples/FirewallRuleGet.json" + } + }, + "description": "List all the firewall rules in a given server.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/FirewallRuleNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/firewallRules": { + "get": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_ListByServer", + "x-ms-examples": { + "FirewallRuleList": { + "$ref": "./examples/FirewallRuleListByServer.json" + } + }, + "description": "List all the firewall rules in a given PostgreSQL server.", + "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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FirewallRuleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/configurations": { + "get": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_ListByServer", + "x-ms-examples": { + "ConfigurationList": { + "$ref": "./examples/ConfigurationListByServer.json" + } + }, + "description": "List all the configurations in a given server.", + "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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/configurations/{configurationName}": { + "get": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_Get", + "x-ms-examples": { + "ConfigurationGet": { + "$ref": "./examples/ConfigurationGet.json" + } + }, + "description": "Gets information about a configuration of server.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_Update", + "x-ms-examples": { + "Update a user configuration": { + "$ref": "./examples/ConfigurationUpdate.json" + } + }, + "description": "Updates a configuration of a server.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Configuration" + }, + "description": "The required parameters for updating a server configuration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_Put", + "x-ms-examples": { + "Update a user configuration": { + "$ref": "./examples/ConfigurationUpdate.json" + } + }, + "description": "Updates a configuration of a server.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Configuration" + }, + "description": "The required parameters for updating a server configuration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/checkNameAvailability": { + "post": { + "tags": [ + "CheckNameAvailability" + ], + "operationId": "CheckNameAvailability_Execute", + "x-ms-examples": { + "NameAvailability": { + "$ref": "./examples/CheckNameAvailability.json" + } + }, + "description": "Check the availability of name for resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "nameAvailabilityRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NameAvailabilityRequest" + }, + "description": "The required parameters for checking if resource name is available." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NameAvailability" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/locations/{locationName}/capabilities": { + "get": { + "tags": [ + "LocationBasedCapabilities" + ], + "operationId": "LocationBasedCapabilities_Execute", + "x-ms-examples": { + "CapabilitiesList": { + "$ref": "./examples/CapabilitiesByLocation.json" + } + }, + "description": "Get capabilities at specified location in a given subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapabilitiesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/locations/{locationName}/checkVirtualNetworkSubnetUsage": { + "post": { + "tags": [ + "VirtualNetworkSubnetUsage" + ], + "operationId": "VirtualNetworkSubnetUsage_Execute", + "x-ms-examples": { + "VirtualNetworkSubnetUsageList": { + "$ref": "./examples/VirtualNetworkSubnetUsage.json" + } + }, + "description": "Get virtual network subnet usage for a given vNet resource id.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkSubnetUsageParameter" + }, + "description": "The required parameters for creating or updating a server." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualNetworkSubnetUsageResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/providers/Microsoft.DBforPostgreSQL/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "OperationList": { + "$ref": "./examples/OperationList.json" + } + }, + "description": "Lists all of the available REST API operations.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "VirtualNetworkSubnetUsageParameter": { + "type": "object", + "properties": { + "virtualNetworkArmResourceId": { + "type": "string", + "description": "Virtual network resource id." + } + }, + "description": "Virtual network subnet usage parameter" + }, + "VirtualNetworkSubnetUsageResult": { + "type": "object", + "properties": { + "delegatedSubnetsUsage": { + "type": "array", + "items": { + "$ref": "#/definitions/DelegatedSubnetUsage" + }, + "readOnly": true + } + }, + "description": "Virtual network subnet usage data." + }, + "DelegatedSubnetUsage": { + "type": "object", + "properties": { + "subnetName": { + "type": "string", + "readOnly": true, + "description": "name of the subnet" + }, + "usage": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Number of used delegated subnets" + } + }, + "description": "Delegated subnet usage data." + }, + "StorageMBCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "storage MB name", + "readOnly": true + }, + "supportedIops": { + "type": "integer", + "format": "int64", + "description": "supported IOPS", + "readOnly": true + }, + "storageSizeMB": { + "type": "integer", + "format": "int64", + "description": "storage size in MB", + "readOnly": true + }, + "status": { + "type": "string", + "description": "The status", + "readOnly": true + } + }, + "description": "storage size in MB capability" + }, + "VcoreCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "vCore name", + "readOnly": true + }, + "vCores": { + "type": "integer", + "format": "int64", + "description": "supported vCores", + "readOnly": true + }, + "supportedIops": { + "type": "integer", + "format": "int64", + "description": "supported IOPS", + "readOnly": true + }, + "supportedMemoryPerVcoreMB": { + "type": "integer", + "format": "int64", + "description": "supported memory per vCore in MB", + "readOnly": true + }, + "status": { + "type": "string", + "description": "The status", + "readOnly": true + } + }, + "description": "Vcores capability" + }, + "ServerVersionCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "server version", + "readOnly": true + }, + "supportedVcores": { + "type": "array", + "items": { + "$ref": "#/definitions/VcoreCapability" + }, + "readOnly": true + }, + "status": { + "type": "string", + "description": "The status", + "readOnly": true + } + }, + "description": "Server version capabilities." + }, + "StorageEditionCapability": { + "properties": { + "name": { + "type": "string", + "description": "storage edition name", + "readOnly": true + }, + "supportedStorageMB": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageMBCapability" + }, + "readOnly": true + }, + "status": { + "type": "string", + "description": "The status", + "readOnly": true + } + }, + "description": "storage edition capability" + }, + "NodeTypeCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "note type name", + "readOnly": true + }, + "nodeType": { + "type": "string", + "description": "note type", + "readOnly": true + }, + "status": { + "type": "string", + "description": "The status", + "readOnly": true + } + }, + "description": "node type capability" + }, + "FlexibleServerEditionCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Server edition name", + "readOnly": true + }, + "supportedStorageEditions": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageEditionCapability" + }, + "description": "The list of editions supported by this server edition.", + "readOnly": true + }, + "supportedServerVersions": { + "type": "array", + "items": { + "$ref": "#/definitions/ServerVersionCapability" + }, + "description": "The list of server versions supported by this server edition.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "The status", + "readOnly": true + } + }, + "description": "Flexible server edition capabilities." + }, + "HyperscaleNodeEditionCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Server edition name", + "readOnly": true + }, + "supportedStorageEditions": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageEditionCapability" + }, + "description": "The list of editions supported by this server edition.", + "readOnly": true + }, + "supportedServerVersions": { + "type": "array", + "items": { + "$ref": "#/definitions/ServerVersionCapability" + }, + "description": "The list of server versions supported by this server edition.", + "readOnly": true + }, + "supportedNodeTypes": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeTypeCapability" + }, + "description": "The list of Node Types supported by this server edition.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "The status", + "readOnly": true + } + }, + "description": "Hyperscale node edition capabilities." + }, + "CapabilityProperties": { + "properties": { + "zone": { + "type": "string", + "description": "zone name", + "readOnly": true + }, + "geoBackupSupported": { + "type": "boolean", + "description": "A value indicating whether a new server in this region can have geo-backups to paired region.", + "readOnly": true + }, + "zoneRedundantHaSupported": { + "type": "boolean", + "description": "A value indicating whether a new server in this region can support multi zone HA.", + "readOnly": true + }, + "zoneRedundantHaAndGeoBackupSupported": { + "type": "boolean", + "description": "A value indicating whether a new server in this region can have geo-backups to paired region.", + "readOnly": true + }, + "supportedFlexibleServerEditions": { + "type": "array", + "items": { + "$ref": "#/definitions/FlexibleServerEditionCapability" + }, + "readOnly": true + }, + "supportedHyperscaleNodeEditions": { + "type": "array", + "items": { + "$ref": "#/definitions/HyperscaleNodeEditionCapability" + }, + "readOnly": true + }, + "status": { + "type": "string", + "description": "The status", + "readOnly": true + } + }, + "description": "Location capabilities." + }, + "CapabilitiesListResult": { + "type": "object", + "properties": { + "value": { + "description": "A list of supported capabilities.", + "type": "array", + "items": { + "$ref": "#/definitions/CapabilityProperties" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + }, + "description": "location capability" + }, + "ServerVersion": { + "type": "string", + "description": "The version of a server.", + "enum": [ + "13", + "12", + "11" + ], + "x-ms-enum": { + "name": "ServerVersion", + "modelAsString": true + } + }, + "ServerProperties": { + "properties": { + "administratorLogin": { + "type": "string", + "description": "The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "administratorLoginPassword": { + "type": "string", + "description": "The administrator login password (required for server creation).", + "x-ms-secret": true, + "format": "password", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "version": { + "$ref": "#/definitions/ServerVersion", + "description": "PostgreSQL Server version." + }, + "minorVersion": { + "type": "string", + "description": "The minor version of the server.", + "readOnly": true + }, + "state": { + "type": "string", + "description": "A state of a server that is visible to user.", + "readOnly": true, + "enum": [ + "Ready", + "Dropping", + "Disabled", + "Starting", + "Stopping", + "Stopped", + "Updating" + ], + "x-ms-enum": { + "name": "ServerState", + "modelAsString": true + } + }, + "fullyQualifiedDomainName": { + "type": "string", + "description": "The fully qualified domain name of a server.", + "readOnly": true + }, + "storage": { + "$ref": "#/definitions/Storage", + "description": "Storage properties of a server." + }, + "backup": { + "$ref": "#/definitions/Backup", + "description": "Backup properties of a server." + }, + "network": { + "$ref": "#/definitions/Network", + "description": "Network properties of a server.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "highAvailability": { + "$ref": "#/definitions/HighAvailability", + "description": "High availability properties of a server." + }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "description": "Maintenance window properties of a server.", + "x-ms-mutability": [ + "update", + "read" + ] + }, + "sourceServerResourceId": { + "type": "string", + "description": "The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore'.", + "x-ms-mutability": [ + "create" + ] + }, + "pointInTimeUTC": { + "type": "string", + "format": "date-time", + "description": "Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore'.", + "x-ms-mutability": [ + "create" + ] + }, + "availabilityZone": { + "type": "string", + "description": "availability zone information of the server.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "createMode": { + "type": "string", + "description": "The mode to create a new PostgreSQL server.", + "enum": [ + "Default", + "Create", + "Update", + "PointInTimeRestore" + ], + "x-ms-enum": { + "name": "CreateMode", + "modelAsString": true + }, + "x-ms-mutability": [ + "create", + "update" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application-specific metadata in the form of key-value pairs." + } + }, + "description": "The properties of a server." + }, + "Server": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU (pricing tier) of the server." + }, + "properties": { + "$ref": "#/definitions/ServerProperties", + "x-ms-client-flatten": true, + "description": "Properties of the server." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true, + "description": "The system metadata relating to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "description": "Represents a server." + }, + "ServerPropertiesForUpdate": { + "properties": { + "administratorLoginPassword": { + "type": "string", + "format": "password", + "description": "The password of the administrator login." + }, + "storage": { + "$ref": "#/definitions/Storage", + "description": "Storage properties of a server." + }, + "backup": { + "$ref": "#/definitions/Backup", + "description": "Backup properties of a server." + }, + "highAvailability": { + "$ref": "#/definitions/HighAvailability", + "description": "High availability properties of a server." + }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "description": "Maintenance window properties of a server." + }, + "createMode": { + "type": "string", + "description": "The mode to update a new PostgreSQL server.", + "enum": [ + "Default", + "Update" + ], + "x-ms-enum": { + "name": "CreateModeForUpdate", + "modelAsString": true + }, + "x-ms-mutability": [ + "update" + ] + } + } + }, + "ServerForUpdate": { + "properties": { + "location": { + "type": "string", + "description": "The location the resource resides in." + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU (pricing tier) of the server." + }, + "properties": { + "$ref": "#/definitions/ServerPropertiesForUpdate", + "x-ms-client-flatten": true, + "description": "Properties of the server." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application-specific metadata in the form of key-value pairs." + } + }, + "description": "Represents a server to be updated." + }, + "ServerListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Server" + }, + "description": "The list of flexible servers" + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of servers." + }, + "Sku": { + "properties": { + "name": { + "type": "string", + "description": "The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3." + }, + "tier": { + "type": "string", + "description": "The tier of the particular SKU, e.g. Burstable.", + "enum": [ + "Burstable", + "GeneralPurpose", + "MemoryOptimized" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + } + }, + "required": [ + "name", + "tier" + ], + "description": "Sku information related properties of a server." + }, + "Storage": { + "properties": { + "storageSizeGB": { + "type": "integer", + "format": "int32", + "description": "Max storage allowed for a server." + } + }, + "description": "Storage properties of a server" + }, + "Backup": { + "properties": { + "backupRetentionDays": { + "type": "integer", + "format": "int32", + "description": "Backup retention days for the server." + }, + "geoRedundantBackup": { + "type": "string", + "description": "A value indicating whether Geo-Redundant backup is enabled on the server.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "GeoRedundantBackupEnum", + "modelAsString": true + }, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "earliestRestoreDate": { + "type": "string", + "format": "date-time", + "description": "The earliest restore point time (ISO8601 format) for server.", + "readOnly": true + } + }, + "description": "Backup properties of a server" + }, + "Network": { + "properties": { + "publicNetworkAccess": { + "type": "string", + "description": "public network access is enabled or not", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ServerPublicNetworkAccessState", + "modelAsString": true + }, + "readOnly": true + }, + "delegatedSubnetResourceId": { + "type": "string", + "description": "delegated subnet arm resource id.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "privateDnsZoneArmResourceId": { + "type": "string", + "description": "private dns zone arm resource id.", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "description": "Network properties of a server" + }, + "HighAvailability": { + "properties": { + "mode": { + "type": "string", + "description": "The HA mode for the server.", + "enum": [ + "Disabled", + "ZoneRedundant" + ], + "x-ms-enum": { + "name": "HighAvailabilityMode", + "modelAsString": true + } + }, + "state": { + "type": "string", + "description": "A state of a HA server that is visible to user.", + "enum": [ + "NotEnabled", + "CreatingStandby", + "ReplicatingData", + "FailingOver", + "Healthy", + "RemovingStandby" + ], + "x-ms-enum": { + "name": "ServerHAState", + "modelAsString": true + }, + "readOnly": true + }, + "standbyAvailabilityZone": { + "type": "string", + "description": "availability zone information of the standby." + } + }, + "description": "High availability properties of a server" + }, + "MaintenanceWindow": { + "type": "object", + "description": "Maintenance window properties of a server.", + "properties": { + "customWindow": { + "type": "string", + "description": "indicates whether custom window is enabled or disabled" + }, + "startHour": { + "type": "integer", + "format": "int32", + "description": "start hour for maintenance window" + }, + "startMinute": { + "type": "integer", + "format": "int32", + "description": "start minute for maintenance window" + }, + "dayOfWeek": { + "type": "integer", + "format": "int32", + "description": "day of week for maintenance window" + } + } + }, + "FirewallRuleProperties": { + "properties": { + "startIpAddress": { + "type": "string", + "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$", + "description": "The start IP address of the server firewall rule. Must be IPv4 format." + }, + "endIpAddress": { + "type": "string", + "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$", + "description": "The end IP address of the server firewall rule. Must be IPv4 format." + } + }, + "required": [ + "startIpAddress", + "endIpAddress" + ], + "description": "The properties of a server firewall rule." + }, + "FirewallRule": { + "properties": { + "properties": { + "$ref": "#/definitions/FirewallRuleProperties", + "x-ms-client-flatten": true, + "description": "The properties of a firewall rule." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true, + "description": "The system metadata relating to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "required": [ + "properties" + ], + "description": "Represents a server firewall rule." + }, + "FirewallRuleListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FirewallRule" + }, + "description": "The list of firewall rules in a server." + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of firewall rules." + }, + "ConfigurationProperties": { + "properties": { + "value": { + "type": "string", + "description": "Value of the configuration." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "Description of the configuration." + }, + "defaultValue": { + "type": "string", + "readOnly": true, + "description": "Default value of the configuration." + }, + "dataType": { + "type": "string", + "readOnly": true, + "description": "Data type of the configuration.", + "enum": [ + "Boolean", + "Numeric", + "Integer", + "Enumeration" + ], + "x-ms-enum": { + "name": "ConfigurationDataType", + "modelAsString": true + } + }, + "allowedValues": { + "type": "string", + "readOnly": true, + "description": "Allowed values of the configuration." + }, + "source": { + "type": "string", + "description": "Source of the configuration." + } + }, + "description": "The properties of a configuration." + }, + "Configuration": { + "properties": { + "properties": { + "$ref": "#/definitions/ConfigurationProperties", + "x-ms-client-flatten": true, + "description": "The properties of a configuration." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true, + "description": "The system metadata relating to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "description": "Represents a Configuration." + }, + "ConfigurationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Configuration" + }, + "description": "The list of server configurations." + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of server configurations." + }, + "OperationDisplay": { + "properties": { + "provider": { + "type": "string", + "readOnly": true, + "description": "Operation resource provider name." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "Resource on which the operation is performed." + }, + "operation": { + "type": "string", + "readOnly": true, + "description": "Localized friendly name for the operation." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "Operation description." + } + }, + "description": "Display metadata associated with the operation." + }, + "Operation": { + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the operation being performed on this particular object." + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "readOnly": true, + "description": "The localized display information for this particular operation or action." + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "origin": { + "type": "string", + "readOnly": true, + "description": "The intended executor of the operation.", + "enum": [ + "NotSpecified", + "user", + "system" + ], + "x-ms-enum": { + "name": "OperationOrigin", + "modelAsString": true + } + }, + "properties": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "readOnly": true, + "x-ms-client-flatten": false, + "description": "Additional descriptions for the operation." + } + }, + "description": "REST API operation definition." + }, + "OperationListResult": { + "description": "A list of resource provider operations.", + "type": "object", + "properties": { + "value": { + "description": "Collection of available operation details", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "NameAvailabilityRequest": { + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "Resource name to verify." + }, + "type": { + "type": "string", + "description": "Resource type used for verification." + } + }, + "description": "Request from client to check resource name availability." + }, + "NameAvailability": { + "properties": { + "message": { + "type": "string", + "description": "Error Message." + }, + "nameAvailable": { + "type": "boolean", + "description": "Indicates whether the resource name is available." + }, + "name": { + "type": "string", + "description": "name of the PostgreSQL server." + }, + "type": { + "type": "string", + "description": "type of the server" + } + }, + "description": "Represents a resource name availability." + }, + "RestartParameter": { + "type": "object", + "properties": { + "restartWithFailover": { + "type": "boolean", + "description": "Indicates whether to restart the server with failover." + }, + "failoverMode": { + "type": "string", + "description": "Failover mode." + } + }, + "description": "Represents server restart parameters." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse" + } + }, + "description": "An error response from the Batch service." + } + }, + "parameters": { + "LocationNameParameter": { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the location.", + "x-ms-parameter-location": "method" + }, + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the server.", + "x-ms-parameter-location": "method" + }, + "FirewallRuleNameParameter": { + "name": "firewallRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the server firewall rule.", + "x-ms-parameter-location": "method" + }, + "ConfigurationNameParameter": { + "name": "configurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the server configuration.", + "x-ms-parameter-location": "method" + }, + "MaintenanceWindowNameParameter": { + "name": "maintenanceWindowName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance window.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/Migrations.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/Migrations.json new file mode 100644 index 000000000000..0275b5707f28 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/Migrations.json @@ -0,0 +1,821 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2021-06-15-privatepreview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "description": "Azure Active Directory OAuth2 Flow", + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{targetDBServerSubscriptionId}/resourceGroups/{targetDBServerResourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{targetDBServerName}/migrations/{migrationName}": { + "put": { + "tags": [ + "Migrations" + ], + "operationId": "Migrations_Create", + "x-ms-examples": { + "Migrations_Create": { + "$ref": "./examples/Migrations_Create.json" + } + }, + "description": "Creates a new migration.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TargetDBServerSubscriptionIdParameter" + }, + { + "$ref": "#/parameters/TargetDBServerResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TargetDBServerNameParameter" + }, + { + "$ref": "#/parameters/MigrationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MigrationResource" + }, + "description": "The required parameters for creating a migration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/MigrationResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ServiceError" + } + } + } + }, + "get": { + "tags": [ + "Migrations" + ], + "operationId": "Migrations_Get", + "x-ms-examples": { + "Migrations_Get": { + "$ref": "./examples/Migrations_Get.json" + } + }, + "description": "Gets details of a migration.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TargetDBServerSubscriptionIdParameter" + }, + { + "$ref": "#/parameters/TargetDBServerResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TargetDBServerNameParameter" + }, + { + "$ref": "#/parameters/MigrationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ServiceError" + } + } + } + }, + "patch": { + "tags": [ + "Migrations" + ], + "operationId": "Migrations_Update", + "x-ms-examples": { + "Migrations_Update": { + "$ref": "./examples/Migrations_Update.json" + } + }, + "description": "Updates an existing migration. The request body can contain one to many of the mutable properties present in the migration definition. Certain property updates initiate migration state transitions.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TargetDBServerSubscriptionIdParameter" + }, + { + "$ref": "#/parameters/TargetDBServerResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TargetDBServerNameParameter" + }, + { + "$ref": "#/parameters/MigrationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MigrationResourceForPatch" + }, + "description": "The required parameters for updating a migration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ServiceError" + } + } + } + }, + "delete": { + "tags": [ + "Migrations" + ], + "operationId": "Migrations_Delete", + "x-ms-examples": { + "Migrations_Delete": { + "$ref": "./examples/Migrations_Delete.json" + } + }, + "description": "Deletes a migration.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TargetDBServerSubscriptionIdParameter" + }, + { + "$ref": "#/parameters/TargetDBServerResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TargetDBServerNameParameter" + }, + { + "$ref": "#/parameters/MigrationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ServiceError" + } + } + } + } + }, + "/subscriptions/{targetDBServerSubscriptionId}/resourceGroups/{targetDBServerResourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{targetDBServerName}/migrations": { + "get": { + "tags": [ + "Migrations" + ], + "operationId": "Migrations_ListByTargetServer", + "x-ms-examples": { + "Migrations_ListByTargetServer": { + "$ref": "./examples/Migrations_ListByTargetServer.json" + } + }, + "description": "List all the migrations on a given target server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TargetDBServerSubscriptionIdParameter" + }, + { + "$ref": "#/parameters/TargetDBServerResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TargetDBServerNameParameter" + }, + { + "$ref": "#/parameters/MigrationListFilter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MigrationResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ServiceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{targetDBServerSubscriptionId}/resourceGroups/{targetDBServerResourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{targetDBServerName}/checkMigrationNameAvailability": { + "post": { + "summary": "Check migration name validity and availability", + "description": "This method checks whether a proposed migration name is valid and available.", + "tags": [ + "Custom operation", + "POST" + ], + "operationId": "CheckMigrationNameAvailability", + "x-ms-examples": { + "CheckMigrationNameAvailability": { + "$ref": "./examples/CheckMigrationNameAvailability.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TargetDBServerSubscriptionIdParameter" + }, + { + "$ref": "#/parameters/TargetDBServerResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TargetDBServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MigrationNameAvailabilityResource" + }, + "description": "The required parameters for checking if a migration name is available." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationNameAvailabilityResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ServiceError" + } + } + } + } + } + }, + "definitions": { + "MigrationResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/MigrationResourceProperties", + "description": "Migration resource properties.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "description": "Represents a migration resource." + }, + "MigrationResourceProperties": { + "type": "object", + "properties": { + "migrationId": { + "type": "string", + "format": "uuid", + "readOnly": true + }, + "migrationName": { + "type": "string", + "readOnly": true + }, + "migrationDetailsLevel": { + "$ref": "#/definitions/MigrationDetailsLevel", + "readOnly": true + }, + "currentStatus": { + "$ref": "#/definitions/MigrationStatus", + "readOnly": true + }, + "sourceDBServerMetadata": { + "$ref": "#/definitions/DBServerMetadata", + "readOnly": true + }, + "targetDBServerMetadata": { + "$ref": "#/definitions/DBServerMetadata", + "readOnly": true + }, + "sourceDBServerResourceId": { + "type": "string" + }, + "secretParameters": { + "$ref": "#/definitions/MigrationSecretParameters" + }, + "userAssignedIdentityResourceId": { + "type": "string" + }, + "targetDBServerResourceId": { + "type": "string", + "readOnly": true + }, + "dBsToMigrate": { + "maxItems": 8, + "type": "array", + "items": { + "type": "string" + } + }, + "migrationResourceGroup": { + "$ref": "#/definitions/MigrationResourceGroup" + }, + "setupLogicalReplicationOnSourceDBIfNeeded": { + "type": "boolean" + }, + "overwriteDBsInTarget": { + "type": "boolean" + }, + "migrationWindowStartTimeInUtc": { + "format": "date-time", + "type": "string" + }, + "startDataMigration": { + "type": "boolean" + }, + "triggerCutover": { + "type": "boolean" + } + }, + "description": "Migration resource properties." + }, + "MigrationResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MigrationResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "The link used to get the next page of migrations.", + "type": "string", + "readOnly": true + } + }, + "description": "A list of migration resources." + }, + "MigrationResourceForPatch": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/MigrationResourcePropertiesForPatch", + "description": "Migration resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application-specific metadata in the form of key-value pairs." + } + }, + "description": "Represents a migration resource for patch." + }, + "MigrationResourcePropertiesForPatch": { + "type": "object", + "properties": { + "sourceDBServerResourceId": { + "type": "string" + }, + "secretParameters": { + "$ref": "#/definitions/MigrationSecretParameters" + }, + "userAssignedIdentityResourceId": { + "type": "string" + }, + "dBsToMigrate": { + "maxItems": 8, + "type": "array", + "items": { + "type": "string" + } + }, + "migrationResourceGroup": { + "$ref": "#/definitions/MigrationResourceGroup" + }, + "setupLogicalReplicationOnSourceDBIfNeeded": { + "type": "boolean" + }, + "overwriteDBsInTarget": { + "type": "boolean" + }, + "migrationWindowStartTimeInUtc": { + "format": "date-time", + "type": "string" + }, + "startDataMigration": { + "type": "boolean" + }, + "triggerCutover": { + "type": "boolean" + } + }, + "description": "Migration resource properties for patch." + }, + "MigrationResourceGroup": { + "type": "object", + "properties": { + "resourceId": { + "type": "string" + }, + "subnetResourceId": { + "type": "string" + } + }, + "description": "Migration resource group." + }, + "MigrationSecretParameters": { + "required": [ + "aadApp", + "adminCredentials" + ], + "type": "object", + "properties": { + "adminCredentials": { + "x-ms-secret": true, + "x-ms-external": true, + "$ref": "#/definitions/AdminCredentials" + }, + "aadApp": { + "x-ms-secret": true, + "x-ms-external": true, + "$ref": "#/definitions/AADApp" + } + }, + "description": "Migration secret parameters." + }, + "AADApp": { + "type": "object", + "required": [ + "aadSecret", + "clientId", + "tenantId" + ], + "properties": { + "aadSecret": { + "type": "string", + "x-ms-secret": true, + "x-ms-external": true, + "x-ms-mutability": [ + "create", + "update" + ] + }, + "clientId": { + "type": "string", + "format": "uuid" + }, + "tenantId": { + "type": "string", + "format": "uuid" + } + }, + "description": "Azure active directory application." + }, + "AdminCredentials": { + "type": "object", + "required": [ + "sourceServerPassword", + "targetServerPassword" + ], + "properties": { + "sourceServerPassword": { + "type": "string", + "x-ms-secret": true, + "x-ms-external": true, + "x-ms-mutability": [ + "create", + "update" + ] + }, + "targetServerPassword": { + "type": "string", + "x-ms-secret": true, + "x-ms-external": true, + "x-ms-mutability": [ + "create", + "update" + ] + } + }, + "description": "Server admin credentials." + }, + "DBServerMetadata": { + "type": "object", + "properties": { + "location": { + "type": "string" + }, + "version": { + "type": "string" + }, + "storageMB": { + "format": "int32", + "type": "integer" + }, + "sku": { + "$ref": "#/definitions/ServerSku" + } + }, + "description": "Database server metadata." + }, + "MigrationDetailsLevel": { + "enum": [ + "Default", + "Summary", + "Full" + ], + "type": "string", + "description": "Migration details level.", + "x-ms-enum": { + "name": "MigrationDetailsLevel", + "modelAsString": true + } + }, + "MigrationState": { + "enum": [ + "InProgress", + "WaitingForUserAction", + "Canceled", + "Failed", + "Succeeded" + ], + "type": "string", + "description": "Migration state.", + "x-ms-enum": { + "name": "MigrationState", + "modelAsString": true + } + }, + "MigrationStatus": { + "type": "object", + "properties": { + "state": { + "$ref": "#/definitions/MigrationState", + "readOnly": true + }, + "error": { + "type": "string", + "readOnly": true + }, + "currentSubStateDetails": { + "$ref": "#/definitions/MigrationSubStateDetails", + "readOnly": true + } + }, + "description": "Migration status." + }, + "MigrationSubState": { + "enum": [ + "PerformingPreRequisiteSteps", + "WaitingForLogicalReplicationSetupRequestOnSourceDB", + "WaitingForDBsToMigrateSpecification", + "WaitingForTargetDBOverwriteConfirmation", + "WaitingForDataMigrationScheduling", + "WaitingForDataMigrationWindow", + "MigratingData", + "WaitingForCutoverTrigger", + "CompletingMigration", + "Completed" + ], + "type": "string", + "description": "Migration sub state.", + "x-ms-enum": { + "name": "MigrationSubState", + "modelAsString": true + } + }, + "MigrationSubStateDetails": { + "type": "object", + "properties": { + "currentSubState": { + "$ref": "#/definitions/MigrationSubState", + "readOnly": true + } + }, + "description": "Migration sub state details." + }, + "ServerSku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3." + }, + "tier": { + "type": "string", + "description": "The tier of the particular SKU, e.g. Burstable.", + "enum": [ + "Burstable", + "GeneralPurpose", + "MemoryOptimized" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + } + }, + "required": [ + "name", + "tier" + ], + "description": "Sku information related properties of a server." + }, + "MigrationNameAvailabilityReason": { + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "description": "Migration name availability reason.", + "x-ms-enum": { + "name": "MigrationNameAvailabilityReason", + "modelAsString": true + } + }, + "MigrationNameAvailabilityResource": { + "required": [ + "name", + "type" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The resource name to verify." + }, + "type": { + "type": "string", + "description": "The type of the resource." + }, + "nameAvailable": { + "type": "boolean", + "description": "Indicates whether the resource name is available.", + "readOnly": true + }, + "reason": { + "$ref": "#/definitions/MigrationNameAvailabilityReason", + "description": "Migration name availability reason", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Migration name availability message.", + "readOnly": true + } + }, + "description": "Represents a migration name's availability." + }, + "ServiceError": { + "x-ms-external": true, + "type": "object", + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse" + } + }, + "description": "An error response from the Batch service." + } + }, + "parameters": { + "TargetDBServerSubscriptionIdParameter": { + "name": "targetDBServerSubscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription ID of the target database server.", + "x-ms-parameter-location": "method" + }, + "TargetDBServerResourceGroupNameParameter": { + "name": "targetDBServerResourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the target database server.", + "x-ms-parameter-location": "method" + }, + "TargetDBServerNameParameter": { + "name": "targetDBServerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the target database server.", + "x-ms-parameter-location": "method" + }, + "MigrationNameParameter": { + "name": "migrationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the migration.", + "x-ms-parameter-location": "method" + }, + "MigrationListFilter": { + "name": "migrationListFilter", + "in": "query", + "required": false, + "enum": [ + "Active", + "All" + ], + "type": "string", + "description": "Migration list filter. Retrieves either active migrations or all migrations.", + "x-ms-enum": { + "name": "MigrationListFilter", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/CapabilitiesByLocation.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/CapabilitiesByLocation.json new file mode 100644 index 000000000000..0eab48a59747 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/CapabilitiesByLocation.json @@ -0,0 +1,6094 @@ +{ + "parameters": { + "api-version": "2021-06-15-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "locationName": "WestUS" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "zone": "none", + "geoBackupSupported": true, + "zoneRedundantHaSupported": true, + "zoneRedundantHaAndGeoBackupSupported": true, + "supportedFlexibleServerEditions": [ + { + "name": "Burstable", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "GeneralPurpose", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "MemoryOptimized", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + } + ], + "supportedHyperscaleNodeEditions": [ + { + "name": "GeneralPurpose", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + }, + { + "name": "33553408", + "supportedIops": 20000, + "storageSizeMB": 33553408, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "11.0", + "supportedVcores": [ + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "11.2", + "supportedVcores": [ + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "11.2.8", + "supportedVcores": [ + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + } + ], + "supportedNodeTypes": [ + { + "name": "Coordinator", + "nodeType": "Coordinator", + "status": "Default" + } + ], + "status": "Available" + }, + { + "name": "MemoryOptimized", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + }, + { + "name": "33553408", + "supportedIops": 20000, + "storageSizeMB": 33553408, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "11.0", + "supportedVcores": [ + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "11.2", + "supportedVcores": [ + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "11.2.8", + "supportedVcores": [ + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + } + ], + "supportedNodeTypes": [ + { + "name": "Worker", + "nodeType": "Worker", + "status": "Default" + } + ], + "status": "Available" + } + ], + "status": "Default" + }, + { + "zone": "1", + "geoBackupSupported": true, + "zoneRedundantHaSupported": true, + "zoneRedundantHaAndGeoBackupSupported": true, + "supportedFlexibleServerEditions": [ + { + "name": "Burstable", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "GeneralPurpose", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "MemoryOptimized", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + } + ], + "supportedHyperscaleNodeEditions": [], + "status": "Available" + }, + { + "zone": "2", + "geoBackupSupported": true, + "zoneRedundantHaSupported": true, + "zoneRedundantHaAndGeoBackupSupported": true, + "supportedFlexibleServerEditions": [ + { + "name": "Burstable", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "GeneralPurpose", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "MemoryOptimized", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + } + ], + "supportedHyperscaleNodeEditions": [], + "status": "Available" + }, + { + "zone": "3", + "geoBackupSupported": true, + "zoneRedundantHaSupported": true, + "zoneRedundantHaAndGeoBackupSupported": true, + "supportedFlexibleServerEditions": [ + { + "name": "Burstable", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "GeneralPurpose", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "MemoryOptimized", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + } + ], + "supportedHyperscaleNodeEditions": [], + "status": "Available" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/CheckMigrationNameAvailability.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/CheckMigrationNameAvailability.json new file mode 100644 index 000000000000..4119caa8da00 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/CheckMigrationNameAvailability.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2021-06-15-privatepreview", + "targetDBServerSubscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "targetDBServerResourceGroupName": "testrg", + "targetDBServerName": "testtarget", + "parameters": { + "name": "name1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/migrations" + } + }, + "responses": { + "200": { + "body": { + "name": "name1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/migrations", + "nameAvailable": true, + "reason": null, + "message": null + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/CheckNameAvailability.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..1faf35ecd5da --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/CheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2021-06-15-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "nameAvailabilityRequest": { + "name": "name1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "message": "", + "name": "name1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ConfigurationGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ConfigurationGet.json new file mode 100644 index 000000000000..9fdf96943096 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ConfigurationGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "configurationName": "array_nulls", + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-15-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "properties": { + "value": "on", + "description": "Enable input of NULL elements in arrays.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/array_nulls", + "name": "array_nulls", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ConfigurationListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ConfigurationListByServer.json new file mode 100644 index 000000000000..456da452cfbd --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ConfigurationListByServer.json @@ -0,0 +1,1902 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-15-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff//resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations?api-version=2021-06-15-privatepreview&$top=200&$skiptoken=skiptoken", + "value": [ + { + "properties": { + "value": "", + "description": "Sets the application name to be reported in statistics and logs.", + "defaultValue": "", + "dataType": "String", + "allowedValues": "[A-Za-z0-9._-]*", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/application_name", + "name": "application_name", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables input of NULL elements in arrays.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/array_nulls", + "name": "array_nulls", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Starts the autovacuum subprocess.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum", + "name": "autovacuum", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.1", + "description": "Number of tuple inserts, updates, or deletes prior to analyze as a fraction of reltuples.", + "defaultValue": "0.1", + "dataType": "Numeric", + "allowedValues": "0-100", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_analyze_scale_factor", + "name": "autovacuum_analyze_scale_factor", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "50", + "description": "Minimum number of tuple inserts, updates, or deletes prior to analyze.", + "defaultValue": "50", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_analyze_threshold", + "name": "autovacuum_analyze_threshold", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "60", + "description": "Time to sleep between autovacuum runs.", + "defaultValue": "60", + "dataType": "Integer", + "allowedValues": "1-2147483", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_naptime", + "name": "autovacuum_naptime", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "Vacuum cost delay in milliseconds, for autovacuum.", + "defaultValue": "2", + "dataType": "Integer", + "allowedValues": "-1-100", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_vacuum_cost_delay", + "name": "autovacuum_vacuum_cost_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-1", + "description": "Vacuum cost amount available before napping, for autovacuum.", + "defaultValue": "-1", + "dataType": "Integer", + "allowedValues": "-1-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_vacuum_cost_limit", + "name": "autovacuum_vacuum_cost_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.2", + "description": "Number of tuple updates or deletes prior to vacuum as a fraction of reltuples.", + "defaultValue": "0.2", + "dataType": "Numeric", + "allowedValues": "0-100", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_vacuum_scale_factor", + "name": "autovacuum_vacuum_scale_factor", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "50", + "description": "Minimum number of tuple updates or deletes prior to vacuum.", + "defaultValue": "50", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_vacuum_threshold", + "name": "autovacuum_vacuum_threshold", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-1", + "description": "Sets the maximum memory to be used by each autovacuum worker process.", + "defaultValue": "-1", + "dataType": "Integer", + "allowedValues": "-1-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_work_mem", + "name": "autovacuum_work_mem", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Number of pages after which previously performed writes are flushed to disk.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-256", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/backend_flush_after", + "name": "backend_flush_after", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "safe_encoding", + "description": "Sets whether \"\\'\" is allowed in string literals.", + "defaultValue": "safe_encoding", + "dataType": "Enumeration", + "allowedValues": "safe_encoding,on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/backslash_quote", + "name": "backslash_quote", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "200", + "description": "Background writer sleep time between rounds.", + "defaultValue": "200", + "dataType": "Integer", + "allowedValues": "10-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/bgwriter_delay", + "name": "bgwriter_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "64", + "description": "Number of pages after which previously performed writes are flushed to disk.", + "defaultValue": "64", + "dataType": "Integer", + "allowedValues": "0-256", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/bgwriter_flush_after", + "name": "bgwriter_flush_after", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "100", + "description": "Background writer maximum number of LRU pages to flush per round.", + "defaultValue": "100", + "dataType": "Integer", + "allowedValues": "0-1073741823", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/bgwriter_lru_maxpages", + "name": "bgwriter_lru_maxpages", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "Multiple of the average buffer usage to free per round.", + "defaultValue": "2", + "dataType": "Numeric", + "allowedValues": "0-10", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/bgwriter_lru_multiplier", + "name": "bgwriter_lru_multiplier", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "hex", + "description": "Sets the output format for bytea.", + "defaultValue": "hex", + "dataType": "Enumeration", + "allowedValues": "escape,hex", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/bytea_output", + "name": "bytea_output", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Checks function bodies during CREATE FUNCTION.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/check_function_bodies", + "name": "check_function_bodies", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.5", + "description": "Time spent flushing dirty buffers during checkpoint, as fraction of checkpoint interval.", + "defaultValue": "0.5", + "dataType": "Numeric", + "allowedValues": "0-1", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/checkpoint_completion_target", + "name": "checkpoint_completion_target", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "300", + "description": "Sets the maximum time between automatic WAL checkpoints.", + "defaultValue": "300", + "dataType": "Integer", + "allowedValues": "30-86400", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/checkpoint_timeout", + "name": "checkpoint_timeout", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "30", + "description": "Enables warnings if checkpoint segments are filled more frequently than this.", + "defaultValue": "30", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/checkpoint_warning", + "name": "checkpoint_warning", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "sql_ascii", + "description": "Sets the client's character set encoding.", + "defaultValue": "sql_ascii", + "dataType": "Enumeration", + "allowedValues": "BIG5,EUC_CN,EUC_JP,EUC_JIS_2004,EUC_KR,EUC_TW,GB18030,GBK,ISO_8859_5,ISO_8859_6,ISO_8859_7,ISO_8859_8,JOHAB,KOI8R,KOI8U,LATIN1,LATIN2,LATIN3,LATIN4,LATIN5,LATIN6,LATIN7,LATIN8,LATIN9,LATIN10,MULE_INTERNAL,SJIS,SHIFT_JIS_2004,SQL_ASCII,UHC,UTF8,WIN866,WIN874,WIN1250,WIN1251,WIN1252,WIN1253,WIN1254,WIN1255,WIN1256,WIN1257,WIN1258", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/client_encoding", + "name": "client_encoding", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "notice", + "description": "Sets the message levels that are sent to the client.", + "defaultValue": "notice", + "dataType": "Enumeration", + "allowedValues": "debug5,debug4,debug3,debug2,debug1,log,notice,warning,error", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/client_min_messages", + "name": "client_min_messages", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Sets the delay in microseconds between transaction commit and flushing WAL to disk.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-100000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/commit_delay", + "name": "commit_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "5", + "description": "Sets the minimum concurrent open transactions before performing commit_delay.", + "defaultValue": "5", + "dataType": "Integer", + "allowedValues": "0-1000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/commit_siblings", + "name": "commit_siblings", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "partition", + "description": "Enables the planner to use constraints to optimize queries.", + "defaultValue": "partition", + "dataType": "Enumeration", + "allowedValues": "partition,on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/constraint_exclusion", + "name": "constraint_exclusion", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.005", + "description": "Sets the planner's estimate of the cost of processing each index entry during an index scan.", + "defaultValue": "0.005", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/cpu_index_tuple_cost", + "name": "cpu_index_tuple_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.0025", + "description": "Sets the planner's estimate of the cost of processing each operator or function call.", + "defaultValue": "0.0025", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/cpu_operator_cost", + "name": "cpu_operator_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.01", + "description": "Sets the planner's estimate of the cost of processing each tuple (row).", + "defaultValue": "0.01", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/cpu_tuple_cost", + "name": "cpu_tuple_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.1", + "description": "Sets the planner's estimate of the fraction of a cursor's rows that will be retrieved.", + "defaultValue": "0.1", + "dataType": "Numeric", + "allowedValues": "0-1", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/cursor_tuple_fraction", + "name": "cursor_tuple_fraction", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "ISO, MDY", + "description": "Sets the display format for date and time values.", + "defaultValue": "ISO, MDY", + "dataType": "String", + "allowedValues": "(ISO|POSTGRES|SQL|GERMAN)(, (DMY|MDY|YMD))?", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/DateStyle", + "name": "DateStyle", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1000", + "description": "Sets the amount of time, in milliseconds, to wait on a lock before checking for deadlock.", + "defaultValue": "1000", + "dataType": "Integer", + "allowedValues": "1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/deadlock_timeout", + "name": "deadlock_timeout", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Indents parse and plan tree displays.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/debug_pretty_print", + "name": "debug_pretty_print", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs each query's parse tree.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/debug_print_parse", + "name": "debug_print_parse", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs each query's execution plan.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/debug_print_plan", + "name": "debug_print_plan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs each query's rewritten parse tree.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/debug_print_rewritten", + "name": "debug_print_rewritten", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "100", + "description": "Sets the default statistics target.", + "defaultValue": "100", + "dataType": "Integer", + "allowedValues": "1-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_statistics_target", + "name": "default_statistics_target", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "", + "description": "Sets the default tablespace to create tables and indexes in.", + "defaultValue": "", + "dataType": "String", + "allowedValues": "[A-Za-z._]*", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_tablespace", + "name": "default_tablespace", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "pg_catalog.english", + "description": "Sets default text search configuration.", + "defaultValue": "pg_catalog.english", + "dataType": "String", + "allowedValues": "[A-Za-z._]+", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_text_search_config", + "name": "default_text_search_config", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Sets the default deferrable status of new transactions.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_transaction_deferrable", + "name": "default_transaction_deferrable", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "read committed", + "description": "Sets the transaction isolation level of each new transaction.", + "defaultValue": "read committed", + "dataType": "Enumeration", + "allowedValues": "serializable,repeatable read,read committed,read uncommitted", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_transaction_isolation", + "name": "default_transaction_isolation", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Sets the default read-only status of new transactions.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_transaction_read_only", + "name": "default_transaction_read_only", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Creates new tables with OIDs by default.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_with_oids", + "name": "default_with_oids", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "3145728", + "description": "Sets the planner's assumption about the size of the disk cache.", + "defaultValue": "3145728", + "dataType": "Integer", + "allowedValues": "1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/effective_cache_size", + "name": "effective_cache_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of bitmap-scan plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_bitmapscan", + "name": "enable_bitmapscan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of gather merge plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_gathermerge", + "name": "enable_gathermerge", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of hashed aggregation plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_hashagg", + "name": "enable_hashagg", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of hash join plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_hashjoin", + "name": "enable_hashjoin", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of index-only-scan plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_indexonlyscan", + "name": "enable_indexonlyscan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of index-scan plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_indexscan", + "name": "enable_indexscan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of materialization.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_material", + "name": "enable_material", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of merge join plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_mergejoin", + "name": "enable_mergejoin", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of nested loop join plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_nestloop", + "name": "enable_nestloop", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of sequential-scan plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_seqscan", + "name": "enable_seqscan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of explicit sort steps.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_sort", + "name": "enable_sort", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of TID scan plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_tidscan", + "name": "enable_tidscan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Warns about backslash escapes in ordinary string literals.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/escape_string_warning", + "name": "escape_string_warning", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Terminates session on any error.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/exit_on_error", + "name": "exit_on_error", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1", + "description": "Sets the number of digits displayed for floating-point values.", + "defaultValue": "1", + "dataType": "Integer", + "allowedValues": "-15-3", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/extra_float_digits", + "name": "extra_float_digits", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Forces use of parallel query facilities.", + "defaultValue": "off", + "dataType": "Enumeration", + "allowedValues": "off,on,regress", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/force_parallel_mode", + "name": "force_parallel_mode", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "8", + "description": "Sets the FROM-list size beyond which subqueries are not collapsed.", + "defaultValue": "8", + "dataType": "Integer", + "allowedValues": "1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/from_collapse_limit", + "name": "from_collapse_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables genetic query optimization.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo", + "name": "geqo", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "5", + "description": "GEQO: effort is used to set the default for other GEQO parameters.", + "defaultValue": "5", + "dataType": "Integer", + "allowedValues": "1-10", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_effort", + "name": "geqo_effort", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "GEQO: number of iterations of the algorithm.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_generations", + "name": "geqo_generations", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "GEQO: number of individuals in the population.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_pool_size", + "name": "geqo_pool_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "GEQO: seed for random path selection.", + "defaultValue": "0", + "dataType": "Numeric", + "allowedValues": "0-1", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_seed", + "name": "geqo_seed", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "GEQO: selective pressure within the population.", + "defaultValue": "2", + "dataType": "Numeric", + "allowedValues": "1.5-2", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_selection_bias", + "name": "geqo_selection_bias", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "12", + "description": "Sets the threshold of FROM items beyond which GEQO is used.", + "defaultValue": "12", + "dataType": "Integer", + "allowedValues": "2-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_threshold", + "name": "geqo_threshold", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Sets the maximum allowed result for exact search by GIN.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/gin_fuzzy_search_limit", + "name": "gin_fuzzy_search_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "4096", + "description": "Sets the maximum size of the pending list for GIN index.", + "defaultValue": "4096", + "dataType": "Integer", + "allowedValues": "64-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/gin_pending_list_limit", + "name": "gin_pending_list_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Sets the maximum allowed duration of any idling transaction.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/idle_in_transaction_session_timeout", + "name": "idle_in_transaction_session_timeout", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "postgres", + "description": "Sets the display format for interval values.", + "defaultValue": "postgres", + "dataType": "Enumeration", + "allowedValues": "postgres,postgres_verbose,sql_standard,iso_8601", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/IntervalStyle", + "name": "IntervalStyle", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "8", + "description": "Sets the FROM-list size beyond which JOIN constructs are not flattened.", + "defaultValue": "8", + "dataType": "Integer", + "allowedValues": "1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/join_collapse_limit", + "name": "join_collapse_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "en_US.utf-8", + "description": "Sets the locale for formatting monetary amounts.", + "defaultValue": "en_US.utf-8", + "dataType": "String", + "allowedValues": "[A-Za-z0-9._ -]+", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/lc_monetary", + "name": "lc_monetary", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "en_US.utf-8", + "description": "Sets the locale for formatting numbers.", + "defaultValue": "en_US.utf-8", + "dataType": "String", + "allowedValues": "[A-Za-z0-9._ -]+", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/lc_numeric", + "name": "lc_numeric", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Enables backward compatibility mode for privilege checks on large objects.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/lo_compat_privileges", + "name": "lo_compat_privileges", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Sets the maximum allowed duration (in milliseconds) of any wait for a lock. 0 turns this off.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/lock_timeout", + "name": "lock_timeout", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-1", + "description": "Sets the minimum execution time above which autovacuum actions will be logged.", + "defaultValue": "-1", + "dataType": "Integer", + "allowedValues": "-1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_autovacuum_min_duration", + "name": "log_autovacuum_min_duration", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Logs each checkpoint.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_checkpoints", + "name": "log_checkpoints", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Logs each successful connection.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_connections", + "name": "log_connections", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "stderr", + "description": "Sets the destination for server log output.", + "defaultValue": "stderr", + "dataType": "Enumeration", + "allowedValues": "stderr,csvlog", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_destination", + "name": "log_destination", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs end of a session, including duration.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_disconnections", + "name": "log_disconnections", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs the duration of each completed SQL statement.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_duration", + "name": "log_duration", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "default", + "description": "Sets the verbosity of logged messages.", + "defaultValue": "default", + "dataType": "Enumeration", + "allowedValues": "terse,default,verbose", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_error_verbosity", + "name": "log_error_verbosity", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs long lock waits.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_lock_waits", + "name": "log_lock_waits", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-1", + "description": "Sets the minimum execution time (in milliseconds) above which statements will be logged. -1 disables logging statement durations.", + "defaultValue": "-1", + "dataType": "Integer", + "allowedValues": "-1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_min_duration_statement", + "name": "log_min_duration_statement", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "error", + "description": "Causes all statements generating error at or above this level to be logged.", + "defaultValue": "error", + "dataType": "Enumeration", + "allowedValues": "debug5,debug4,debug3,debug2,debug1,info,notice,warning,error,log,fatal,panic", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_min_error_statement", + "name": "log_min_error_statement", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "warning", + "description": "Sets the message levels that are logged.", + "defaultValue": "warning", + "dataType": "Enumeration", + "allowedValues": "debug5,debug4,debug3,debug2,debug1,info,notice,warning,error,log,fatal,panic", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_min_messages", + "name": "log_min_messages", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs each replication command.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_replication_commands", + "name": "log_replication_commands", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "none", + "description": "Sets the type of statements logged.", + "defaultValue": "none", + "dataType": "Enumeration", + "allowedValues": "none,ddl,mod,all", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_statement", + "name": "log_statement", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "For each query, writes cumulative performance statistics to the server log.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_statement_stats", + "name": "log_statement_stats", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-1", + "description": "Logs the use of temporary files larger than this number of kilobytes.", + "defaultValue": "-1", + "dataType": "Integer", + "allowedValues": "-1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_temp_files", + "name": "log_temp_files", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "332800", + "description": "Sets the maximum memory to be used for maintenance operations.", + "defaultValue": "332800", + "dataType": "Integer", + "allowedValues": "1024-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/maintenance_work_mem", + "name": "maintenance_work_mem", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "8", + "description": "Sets the maximum number of parallel workers than can be active at one time.", + "defaultValue": "8", + "dataType": "Integer", + "allowedValues": "0-1024", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_parallel_workers", + "name": "max_parallel_workers", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "Sets the maximum number of parallel processes per executor node.", + "defaultValue": "2", + "dataType": "Integer", + "allowedValues": "0-1024", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_parallel_workers_per_gather", + "name": "max_parallel_workers_per_gather", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "Sets the maximum number of predicate-locked tuples per page.", + "defaultValue": "2", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_pred_locks_per_page", + "name": "max_pred_locks_per_page", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-2", + "description": "Sets the maximum number of predicate-locked pages and tuples per relation.", + "defaultValue": "-2", + "dataType": "Integer", + "allowedValues": "-2147483648-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_pred_locks_per_relation", + "name": "max_pred_locks_per_relation", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "30000", + "description": "Sets the maximum delay before canceling queries when a hot standby server is processing archived WAL data.", + "defaultValue": "30000", + "dataType": "Integer", + "allowedValues": "-1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_standby_archive_delay", + "name": "max_standby_archive_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "30000", + "description": "Sets the maximum delay before canceling queries when a hot standby server is processing streamed WAL data.", + "defaultValue": "30000", + "dataType": "Integer", + "allowedValues": "-1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_standby_streaming_delay", + "name": "max_standby_streaming_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "Maximum number of table synchronization workers per subscription.", + "defaultValue": "2", + "dataType": "Integer", + "allowedValues": "0-262143", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_sync_workers_per_subscription", + "name": "max_sync_workers_per_subscription", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1024", + "description": "Sets the WAL size that triggers a checkpoint.", + "defaultValue": "1024", + "dataType": "Integer", + "allowedValues": "2-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_wal_size", + "name": "max_wal_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "64", + "description": "Sets the minimum amount of index data for a parallel scan.", + "defaultValue": "64", + "dataType": "Integer", + "allowedValues": "0-715827882", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/min_parallel_index_scan_size", + "name": "min_parallel_index_scan_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1024", + "description": "Sets the minimum amount of table data for a parallel scan.", + "defaultValue": "1024", + "dataType": "Integer", + "allowedValues": "0-715827882", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/min_parallel_table_scan_size", + "name": "min_parallel_table_scan_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "80", + "description": "Sets the minimum size to shrink the WAL to.", + "defaultValue": "80", + "dataType": "Integer", + "allowedValues": "2-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/min_wal_size", + "name": "min_wal_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Emits a warning for constructs that changed meaning since PostgreSQL 9.4.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/operator_precedence_warning", + "name": "operator_precedence_warning", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1000", + "description": "Sets the planner's estimate of the cost of starting up worker processes for parallel query.", + "defaultValue": "1000", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/parallel_setup_cost", + "name": "parallel_setup_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.1", + "description": "Sets the planner's estimate of the cost of passing each tuple (row) from worker to master backend.", + "defaultValue": "0.1", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/parallel_tuple_cost", + "name": "parallel_tuple_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "When generating SQL fragments, quotes all identifiers.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/quote_all_identifiers", + "name": "quote_all_identifiers", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "4", + "description": "Sets the planner's estimate of the cost of a nonsequentially fetched disk page.", + "defaultValue": "4", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/random_page_cost", + "name": "random_page_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables row security.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/row_security", + "name": "row_security", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "\"$user\", public", + "description": "Sets the schema search order for names that are not schema-qualified.", + "defaultValue": "\"$user\", public", + "dataType": "String", + "allowedValues": "[A-Za-z.\"$, ]+", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/search_path", + "name": "search_path", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1", + "description": "Sets the planner's estimate of the cost of a sequentially fetched disk page.", + "defaultValue": "1", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/seq_page_cost", + "name": "seq_page_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "origin", + "description": "Sets the session's behavior for triggers and rewrite rules.", + "defaultValue": "origin", + "dataType": "Enumeration", + "allowedValues": "origin,replica,local", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/session_replication_role", + "name": "session_replication_role", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Causes '...' strings to treat backslashes literally.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/standard_conforming_strings", + "name": "standard_conforming_strings", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Sets the maximum allowed duration (in milliseconds) of any statement. 0 turns this off.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/statement_timeout", + "name": "statement_timeout", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables synchronized sequential scans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/synchronize_seqscans", + "name": "synchronize_seqscans", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Sets the current transaction's synchronization level.", + "defaultValue": "on", + "dataType": "Enumeration", + "allowedValues": "local,remote_write,on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/synchronous_commit", + "name": "synchronous_commit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "9", + "description": "Maximum number of TCP keepalive retransmits.", + "defaultValue": "9", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/tcp_keepalives_count", + "name": "tcp_keepalives_count", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "120", + "description": "Time between issuing TCP keepalives.", + "defaultValue": "120", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/tcp_keepalives_idle", + "name": "tcp_keepalives_idle", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "30", + "description": "Time between TCP keepalive retransmits.", + "defaultValue": "30", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/tcp_keepalives_interval", + "name": "tcp_keepalives_interval", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1024", + "description": "Sets the maximum number of temporary buffers used by each database session.", + "defaultValue": "1024", + "dataType": "Integer", + "allowedValues": "100-1073741823", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/temp_buffers", + "name": "temp_buffers", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "", + "description": "Sets the tablespace(s) to use for temporary tables and sort files.", + "defaultValue": "", + "dataType": "String", + "allowedValues": "[A-Za-z._]*", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/temp_tablespaces", + "name": "temp_tablespaces", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "UTC", + "description": "Sets the time zone for displaying and interpreting time stamps.", + "defaultValue": "UTC", + "dataType": "String", + "allowedValues": "[A-Za-z0-9/+_-]+", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/TimeZone", + "name": "TimeZone", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Collects information about executing commands.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/track_activities", + "name": "track_activities", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Collects statistics on database activity.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/track_counts", + "name": "track_counts", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "none", + "description": "Collects function-level statistics on database activity.", + "defaultValue": "none", + "dataType": "Enumeration", + "allowedValues": "none,pl,all", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/track_functions", + "name": "track_functions", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Collects timing statistics for database I/O activity.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/track_io_timing", + "name": "track_io_timing", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Treats \"expr=NULL\" as \"expr IS NULL\".", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/transform_null_equals", + "name": "transform_null_equals", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Vacuum cost delay in milliseconds.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-100", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_cost_delay", + "name": "vacuum_cost_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "200", + "description": "Vacuum cost amount available before napping.", + "defaultValue": "200", + "dataType": "Integer", + "allowedValues": "1-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_cost_limit", + "name": "vacuum_cost_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "20", + "description": "Vacuum cost for a page dirtied by vacuum.", + "defaultValue": "20", + "dataType": "Integer", + "allowedValues": "0-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_cost_page_dirty", + "name": "vacuum_cost_page_dirty", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1", + "description": "Vacuum cost for a page found in the buffer cache.", + "defaultValue": "1", + "dataType": "Integer", + "allowedValues": "0-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_cost_page_hit", + "name": "vacuum_cost_page_hit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "10", + "description": "Vacuum cost for a page not found in the buffer cache.", + "defaultValue": "10", + "dataType": "Integer", + "allowedValues": "0-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_cost_page_miss", + "name": "vacuum_cost_page_miss", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Number of transactions by which VACUUM and HOT cleanup should be deferred, if any.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-1000000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_defer_cleanup_age", + "name": "vacuum_defer_cleanup_age", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "50000000", + "description": "Minimum age at which VACUUM should freeze a table row.", + "defaultValue": "50000000", + "dataType": "Integer", + "allowedValues": "0-1000000000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_freeze_min_age", + "name": "vacuum_freeze_min_age", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "150000000", + "description": "Age at which VACUUM should scan whole table to freeze tuples.", + "defaultValue": "150000000", + "dataType": "Integer", + "allowedValues": "0-2000000000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_freeze_table_age", + "name": "vacuum_freeze_table_age", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "5000000", + "description": "Minimum age at which VACUUM should freeze a MultiXactId in a table row.", + "defaultValue": "5000000", + "dataType": "Integer", + "allowedValues": "0-1000000000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_multixact_freeze_min_age", + "name": "vacuum_multixact_freeze_min_age", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "150000000", + "description": "Multixact age at which VACUUM should scan whole table to freeze tuples.", + "defaultValue": "150000000", + "dataType": "Integer", + "allowedValues": "0-2000000000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_multixact_freeze_table_age", + "name": "vacuum_multixact_freeze_table_age", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "10", + "description": "Sets the maximum interval between WAL receiver status reports to the primary.", + "defaultValue": "10", + "dataType": "Integer", + "allowedValues": "0-2147483", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/wal_receiver_status_interval", + "name": "wal_receiver_status_interval", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "200", + "description": "Time between WAL flushes performed in the WAL writer.", + "defaultValue": "200", + "dataType": "Integer", + "allowedValues": "1-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/wal_writer_delay", + "name": "wal_writer_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "128", + "description": "Amount of WAL written out by WAL writer that triggers a flush.", + "defaultValue": "128", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/wal_writer_flush_after", + "name": "wal_writer_flush_after", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "115712", + "description": "Sets the amount of memory to be used by internal sort operations and hash tables before writing to temporary disk files.", + "defaultValue": "115712", + "dataType": "Integer", + "allowedValues": "4096-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/work_mem", + "name": "work_mem", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "base64", + "description": "Sets how binary values are to be encoded in XML.", + "defaultValue": "base64", + "dataType": "Enumeration", + "allowedValues": "base64,hex", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/xmlbinary", + "name": "xmlbinary", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "content", + "description": "Sets whether XML data in implicit parsing and serialization operations is to be considered as documents or content fragments.", + "defaultValue": "content", + "dataType": "Enumeration", + "allowedValues": "content,document", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/xmloption", + "name": "xmloption", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ConfigurationUpdate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ConfigurationUpdate.json new file mode 100644 index 000000000000..c6b9583cd239 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ConfigurationUpdate.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "serverName": "testserver", + "configurationName": "event_scheduler", + "resourceGroupName": "testrg", + "api-version": "2021-06-15-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "value": "on", + "source": "user-override" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "value": "ON", + "description": "Indicates the status of the Event Scheduler.", + "defaultValue": "OFF", + "dataType": "Enumeration", + "allowedValues": "ON,OFF,DISABLED", + "source": "user-override" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/event_scheduler", + "name": "event_scheduler", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/FirewallRuleCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/FirewallRuleCreate.json new file mode 100644 index 000000000000..4c607441b4e5 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/FirewallRuleCreate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "firewallRuleName": "rule1", + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-15-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/servers/testserver/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/servers/testserver/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/FirewallRuleDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/FirewallRuleDelete.json new file mode 100644 index 000000000000..6362cda8fb16 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/FirewallRuleDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "firewallRuleName": "rule1", + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-15-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/FirewallRuleGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/FirewallRuleGet.json new file mode 100644 index 000000000000..1889691d5496 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/FirewallRuleGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "firewallRuleName": "rule1", + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-15-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/servers/testserver/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/FirewallRuleListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/FirewallRuleListByServer.json new file mode 100644 index 000000000000..05f80a86dd86 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/FirewallRuleListByServer.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-15-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff//resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/firewallRules?api-version=2021-06-15-privatepreview&$top=2&$skiptoken=skiptoken", + "value": [ + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + }, + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/firewallRules/rule2", + "name": "rule2", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "1.0.0.0", + "endIpAddress": "255.0.0.0" + } + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/Migrations_Create.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/Migrations_Create.json new file mode 100644 index 000000000000..8f3f8aecc019 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/Migrations_Create.json @@ -0,0 +1,164 @@ +{ + "parameters": { + "api-version": "2021-06-15-privatepreview", + "targetDBServerSubscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "targetDBServerResourceGroupName": "testrg", + "targetDBServerName": "testtarget", + "migrationName": "testmigration", + "parameters": { + "properties": { + "sourceDBServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "secretParameters": { + "adminCredentials": { + "sourceServerPassword": "testsourcepassword", + "targetServerPassword": "testtargetpassword" + }, + "aadApp": { + "aadSecret": "testaadsecret", + "clientId": "cccccccc-cccc-cccc-cccc-cccccccccccc", + "tenantId": "tttttttt-tttt-tttt-tttt-tttttttttttt" + } + }, + "dBsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "migrationResourceGroup": { + "resourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg", + "subnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/default" + } + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "migrationId": "mmmmmmmm-mmmm-mmmm-mmmm-mmmmmmmmmmmm", + "migrationName": "testmigration", + "migrationDetailsLevel": "Default", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "PerformingPreRequisiteSteps" + } + }, + "sourceDBServerMetadata": { + "location": "westus", + "version": "10", + "storageMB": 1024, + "sku": { + "name": "B_Gen5_2", + "tier": "Basic" + } + }, + "targetDBServerMetadata": { + "location": "westus", + "version": "11", + "storageMB": 2048, + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + } + }, + "sourceDBServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "secretParameters": { + "adminCredentials": {}, + "aadApp": { + "clientId": "cccccccc-cccc-cccc-cccc-cccccccccccc", + "tenantId": "tttttttt-tttt-tttt-tttt-tttttttttttt" + } + }, + "targetDBServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dBsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "migrationResourceGroup": { + "resourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg", + "subnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/default" + }, + "setupLogicalReplicationOnSourceDBIfNeeded": false, + "overwriteDBsInTarget": false, + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": false, + "triggerCutover": false + }, + "tags": { + "key1624": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "location": "westus", + "id": "mmmmmmmm-mmmm-mmmm-mmmm-mmmmmmmmmmmm", + "name": "mmmmmmmm-mmmm-mmmm-mmmm-mmmmmmmmmmmm", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + }, + "201": { + "body": { + "properties": { + "migrationId": "mmmmmmmm-mmmm-mmmm-mmmm-mmmmmmmmmmmm", + "migrationDetailsLevel": "Default", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "PerformingPreRequisiteSteps" + } + }, + "sourceDBServerMetadata": { + "location": "westus", + "version": "10", + "storageMB": 1024, + "sku": { + "name": "B_Gen5_2", + "tier": "Basic" + } + }, + "targetDBServerMetadata": { + "location": "westus", + "version": "11", + "storageMB": 2048, + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + } + }, + "sourceDBServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "secretParameters": { + "adminCredentials": {}, + "aadApp": { + "clientId": "cccccccc-cccc-cccc-cccc-cccccccccccc", + "tenantId": "tttttttt-tttt-tttt-tttt-tttttttttttt" + } + }, + "targetDBServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dBsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "migrationResourceGroup": { + "resourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg", + "subnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/default" + }, + "setupLogicalReplicationOnSourceDBIfNeeded": false, + "overwriteDBsInTarget": false, + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": false, + "triggerCutover": false + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/Migrations_Delete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/Migrations_Delete.json new file mode 100644 index 000000000000..e5ff08fcd79a --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/Migrations_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-06-15-privatepreview", + "targetDBServerSubscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "targetDBServerResourceGroupName": "testrg", + "targetDBServerName": "testtarget", + "migrationName": "testmigration" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/Migrations_Get.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/Migrations_Get.json new file mode 100644 index 000000000000..775258ca1968 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/Migrations_Get.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2021-06-15-privatepreview", + "targetDBServerSubscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "targetDBServerResourceGroupName": "testrg", + "targetDBServerName": "testtarget", + "migrationName": "testmigration" + }, + "responses": { + "200": { + "body": { + "properties": { + "migrationId": "mmmmmmmm-mmmm-mmmm-mmmm-mmmmmmmmmmmm", + "migrationName": "testmigration", + "migrationDetailsLevel": "Default", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "PerformingPreRequisiteSteps" + } + }, + "sourceDBServerMetadata": { + "location": "westus", + "version": "10", + "storageMB": 1024, + "sku": { + "name": "B_Gen5_2", + "tier": "Basic" + } + }, + "targetDBServerMetadata": { + "location": "westus", + "version": "11", + "storageMB": 2048, + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + } + }, + "sourceDBServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "secretParameters": { + "adminCredentials": {}, + "aadApp": { + "clientId": "cccccccc-cccc-cccc-cccc-cccccccccccc", + "tenantId": "tttttttt-tttt-tttt-tttt-tttttttttttt" + } + }, + "targetDBServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dBsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "migrationResourceGroup": { + "resourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg", + "subnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/default" + }, + "setupLogicalReplicationOnSourceDBIfNeeded": false, + "overwriteDBsInTarget": false, + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": false, + "triggerCutover": false + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/Migrations_ListByTargetServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/Migrations_ListByTargetServer.json new file mode 100644 index 000000000000..0095c014c06c --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/Migrations_ListByTargetServer.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2021-06-15-privatepreview", + "targetDBServerSubscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "targetDBServerResourceGroupName": "testrg", + "targetDBServerName": "testtarget", + "migrationListFilter": "All" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "migrationId": "mmmmmmmm-mmmm-mmmm-mmmm-mmmmmmmmmmmm", + "migrationName": "testmigration", + "migrationDetailsLevel": "Default", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "PerformingPreRequisiteSteps" + } + }, + "sourceDBServerMetadata": { + "location": "westus", + "version": "10", + "storageMB": 1024, + "sku": { + "name": "B_Gen5_2", + "tier": "Basic" + } + }, + "targetDBServerMetadata": { + "location": "westus", + "version": "11", + "storageMB": 2048, + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + } + }, + "sourceDBServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "secretParameters": { + "adminCredentials": {}, + "aadApp": { + "clientId": "cccccccc-cccc-cccc-cccc-cccccccccccc", + "tenantId": "tttttttt-tttt-tttt-tttt-tttttttttttt" + } + }, + "targetDBServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dBsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "migrationResourceGroup": { + "resourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg", + "subnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/default" + }, + "setupLogicalReplicationOnSourceDBIfNeeded": false, + "overwriteDBsInTarget": false, + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": false, + "triggerCutover": false + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/Migrations_Update.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/Migrations_Update.json new file mode 100644 index 000000000000..3c60b1eebc14 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/Migrations_Update.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2021-06-15-privatepreview", + "targetDBServerSubscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "targetDBServerResourceGroupName": "testrg", + "targetDBServerName": "testtarget", + "migrationName": "testmigration", + "parameters": { + "properties": { + "setupLogicalReplicationOnSourceDBIfNeeded": true + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "migrationId": "mmmmmmmm-mmmm-mmmm-mmmm-mmmmmmmmmmmm", + "migrationName": "testmigration", + "migrationDetailsLevel": "Default", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "PerformingPreRequisiteSteps" + } + }, + "sourceDBServerMetadata": { + "location": "westus", + "version": "10", + "storageMB": 1024, + "sku": { + "name": "B_Gen5_2", + "tier": "Basic" + } + }, + "targetDBServerMetadata": { + "location": "westus", + "version": "11", + "storageMB": 2048, + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + } + }, + "sourceDBServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "secretParameters": { + "adminCredentials": {}, + "aadApp": { + "clientId": "cccccccc-cccc-cccc-cccc-cccccccccccc", + "tenantId": "tttttttt-tttt-tttt-tttt-tttttttttttt" + } + }, + "targetDBServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dBsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "migrationResourceGroup": { + "resourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg", + "subnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/default" + }, + "setupLogicalReplicationOnSourceDBIfNeeded": true, + "overwriteDBsInTarget": false, + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": false, + "triggerCutover": false + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/OperationList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/OperationList.json new file mode 100644 index 000000000000..d2568e2815bf --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/OperationList.json @@ -0,0 +1,176 @@ +{ + "parameters": { + "api-version": "2021-06-15-privatepreview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/read", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "PostgreSQL Server", + "operation": "List/Get PostgreSQL Servers", + "description": "Return the list of servers or gets the properties for the specified server." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/write", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "PostgreSQL Server", + "operation": "Create/Update PostgreSQL Server", + "description": "Creates a server with the specified parameters or update the properties or tags for the specified server." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/delete", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "PostgreSQL Server", + "operation": "Delete PostgreSQL Server", + "description": "Deletes an existing server." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules/read", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Firewall Rules", + "operation": "List/Get Firewall Rules", + "description": "Return the list of firewall rules for a server or gets the properties for the specified firewall rule." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules/write", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Firewall Rules", + "operation": "Create/Update Firewall Rule", + "description": "Creates a firewall rule with the specified parameters or update an existing rule." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules/delete", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Firewall Rules", + "operation": "Delete Firewall Rule", + "description": "Deletes an existing firewall rule." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Database Metric Definition", + "operation": "Get database metric definitions", + "description": "Return types of metrics that are available for databases" + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "cpu_percent", + "displayName": "CPU percent", + "displayDescription": "CPU percent", + "unit": "Percent", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "compute_limit", + "displayName": "Compute Unit limit", + "displayDescription": "Compute Unit limit", + "unit": "Count", + "aggregationType": "Average" + }, + { + "name": "compute_consumption_percent", + "displayName": "Compute Unit percentage", + "displayDescription": "Compute Unit percentage", + "unit": "Percent", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "memory_percent", + "displayName": "Memory percent", + "displayDescription": "Memory percent", + "unit": "Percent", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "io_consumption_percent", + "displayName": "IO percent", + "displayDescription": "IO percent", + "unit": "Percent", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "storage_percent", + "displayName": "Storage percentage", + "displayDescription": "Storage percentage", + "unit": "Percent", + "aggregationType": "Average" + }, + { + "name": "storage_used", + "displayName": "Storage used", + "displayDescription": "Storage used", + "unit": "Bytes", + "aggregationType": "Average" + }, + { + "name": "storage_limit", + "displayName": "Storage limit", + "displayDescription": "Storage limit", + "unit": "Bytes", + "aggregationType": "Average" + }, + { + "name": "active_connections", + "displayName": "Total active connections", + "displayDescription": "Total active connections", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "connections_failed", + "displayName": "Total failed connections", + "displayDescription": "Total failed connections", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": true + } + ] + } + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Database Metric Definition", + "operation": "Read diagnostic setting", + "description": "Gets the disagnostic setting for the resource" + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Database Metric Definition", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource" + } + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerCreate.json new file mode 100644 index 000000000000..93d7fb3f3aea --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerCreate.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2021-06-15-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLogin": "cloudsa", + "administratorLoginPassword": "password", + "version": "12", + "availabilityZone": "1", + "createMode": "Create", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled" + }, + "network": { + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourcegroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant" + } + }, + "tags": { + "ElasticServer": "1" + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:08:06.7197478+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:08:06.7197478+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerCreatePointInTimeRestore.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerCreatePointInTimeRestore.json new file mode 100644 index 000000000000..b2a772b86fdd --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerCreatePointInTimeRestore.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "serverName": "pgtestsvc5", + "resourceGroupName": "testrg", + "api-version": "2021-06-15-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "properties": { + "createMode": "PointInTimeRestore", + "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/sourcepgservername", + "pointInTimeUTC": "2021-06-27T00:04:59.4078005+00:00" + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc5.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "2", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-27T00:28:17.7279547+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5", + "name": "pgtestsvc5", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc5.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "2", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-27T00:28:17.7279547+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5", + "name": "pgtestsvc5", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerDelete.json new file mode 100644 index 000000000000..ffc023c9d8a2 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-15-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerGet.json new file mode 100644 index 000000000000..850933613d90 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerGet.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "serverName": "pgtestsvc1", + "resourceGroupName": "testrg", + "api-version": "2021-06-15-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc1.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1", + "name": "pgtestsvc1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerGetWithVnet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerGetWithVnet.json new file mode 100644 index 000000000000..aa7bd9aca30c --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerGetWithVnet.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2021-06-15-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerList.json new file mode 100644 index 000000000000..0b924c860713 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerList.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2021-06-15-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/flexibleServers?api-version=2021-06-15-privatepreview&$top=3&$skiptoken=skiptoken", + "value": [ + { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + }, + { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc1.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:15:38.8131437+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1", + "name": "pgtestsvc1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerListByResourceGroup.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerListByResourceGroup.json new file mode 100644 index 000000000000..161bd2396404 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerListByResourceGroup.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2021-06-15-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers?api-version=2021-06-15-privatepreview&$top=3&$skiptoken=skiptoken", + "value": [ + { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + }, + { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc1.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:15:38.8131437+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1", + "name": "pgtestsvc1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerRestart.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerRestart.json new file mode 100644 index 000000000000..8c08c2878d41 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerRestart.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-15-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerRestartWithFailover.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerRestartWithFailover.json new file mode 100644 index 000000000000..d928707a0575 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerRestartWithFailover.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-15-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "restartWithFailover": true, + "failoverMode": "forcedFailover" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerStart.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerStart.json new file mode 100644 index 000000000000..8c08c2878d41 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerStart.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-15-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerStop.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerStop.json new file mode 100644 index 000000000000..8c08c2878d41 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerStop.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-15-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerUpdate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerUpdate.json new file mode 100644 index 000000000000..5ac55da617e1 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerUpdate.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "TestGroup", + "api-version": "2021-06-15-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D8s_v3" + }, + "properties": { + "administratorLoginPassword": "newpassword", + "createMode": "Update", + "storage": { + "storageSizeGB": 1024 + }, + "backup": { + "backupRetentionDays": 20 + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D8s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 1024 + }, + "backup": { + "backupRetentionDays": 20, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerUpdateWithCustomerMaintenanceWindow.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerUpdateWithCustomerMaintenanceWindow.json new file mode 100644 index 000000000000..2a774f81256b --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/ServerUpdateWithCustomerMaintenanceWindow.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2021-06-15-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "properties": { + "createMode": "Update", + "maintenanceWindow": { + "customWindow": "Enabled", + "dayOfWeek": 0, + "startHour": 8, + "startMinute": 0 + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Enabled", + "dayOfWeek": 0, + "startHour": 8, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/VirtualNetworkSubnetUsage.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/VirtualNetworkSubnetUsage.json new file mode 100644 index 000000000000..9879af02c1a9 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/VirtualNetworkSubnetUsage.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2021-06-15-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "locationName": "WestUS", + "parameters": { + "virtualNetworkArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/testvnet" + } + }, + "responses": { + "200": { + "body": { + "delegatedSubnetsUsage": [ + { + "subnetName": "test-subnet-1", + "usage": 2 + }, + { + "subnetName": "test-subnet-2", + "usage": 3 + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/postgresql.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/postgresql.json new file mode 100644 index 000000000000..5c6b70dd81ad --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/postgresql.json @@ -0,0 +1,2105 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2021-06-15-privatepreview" + }, + "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.DBforPostgreSQL/flexibleServers/{serverName}": { + "put": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Create", + "x-ms-examples": { + "Create a new server": { + "$ref": "./examples/ServerCreate.json" + }, + "Create a database as a point in time restore": { + "$ref": "./examples/ServerCreatePointInTimeRestore.json" + } + }, + "description": "Creates a new server.", + "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/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Server" + }, + "description": "The required parameters for creating or updating a server." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Update", + "x-ms-examples": { + "ServerUpdate": { + "$ref": "./examples/ServerUpdate.json" + }, + "ServerUpdateWithCustomerMaintenanceWindow": { + "$ref": "./examples/ServerUpdateWithCustomerMaintenanceWindow.json" + } + }, + "description": "Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.", + "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/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ServerForUpdate" + }, + "description": "The required parameters for updating a server." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Delete", + "x-ms-examples": { + "ServerDelete": { + "$ref": "./examples/ServerDelete.json" + } + }, + "description": "Deletes a server.", + "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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Get", + "x-ms-examples": { + "ServerGet": { + "$ref": "./examples/ServerGet.json" + }, + "ServerGetWithVnet": { + "$ref": "./examples/ServerGetWithVnet.json" + } + }, + "description": "Gets information about a server.", + "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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers": { + "get": { + "tags": [ + "Servers" + ], + "operationId": "Servers_ListByResourceGroup", + "x-ms-examples": { + "ServerListByResourceGroup": { + "$ref": "./examples/ServerListByResourceGroup.json" + } + }, + "description": "List all the servers in a given resource group.", + "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" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/flexibleServers": { + "get": { + "tags": [ + "Servers" + ], + "operationId": "Servers_List", + "x-ms-examples": { + "ServerList": { + "$ref": "./examples/ServerList.json" + } + }, + "description": "List all the servers in a given 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": "OK", + "schema": { + "$ref": "#/definitions/ServerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/restart": { + "post": { + "tags": [ + "ServerRestart" + ], + "operationId": "Servers_Restart", + "x-ms-examples": { + "ServerRestart": { + "$ref": "./examples/ServerRestart.json" + }, + "ServerRestartWithFailover": { + "$ref": "./examples/ServerRestartWithFailover.json" + } + }, + "description": "Restarts a server.", + "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/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "schema": { + "$ref": "#/definitions/RestartParameter" + }, + "description": "The parameters for restarting a server." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/start": { + "post": { + "tags": [ + "ServerStart" + ], + "operationId": "Servers_Start", + "x-ms-examples": { + "ServerStart": { + "$ref": "./examples/ServerStart.json" + } + }, + "description": "Starts a server.", + "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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/stop": { + "post": { + "tags": [ + "ServerStop" + ], + "operationId": "Servers_Stop", + "x-ms-examples": { + "ServerStop": { + "$ref": "./examples/ServerStop.json" + } + }, + "description": "Stops a server.", + "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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/firewallRules/{firewallRuleName}": { + "put": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_CreateOrUpdate", + "x-ms-examples": { + "FirewallRuleCreate": { + "$ref": "./examples/FirewallRuleCreate.json" + } + }, + "description": "Creates a new firewall rule or updates an existing firewall rule.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/FirewallRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FirewallRule" + }, + "description": "The required parameters for creating or updating a firewall rule." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_Delete", + "x-ms-examples": { + "FirewallRuleDelete": { + "$ref": "./examples/FirewallRuleDelete.json" + } + }, + "description": "Deletes a PostgreSQL server firewall rule.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/FirewallRuleNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_Get", + "x-ms-examples": { + "FirewallRuleList": { + "$ref": "./examples/FirewallRuleGet.json" + } + }, + "description": "List all the firewall rules in a given server.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/FirewallRuleNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/firewallRules": { + "get": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_ListByServer", + "x-ms-examples": { + "FirewallRuleList": { + "$ref": "./examples/FirewallRuleListByServer.json" + } + }, + "description": "List all the firewall rules in a given PostgreSQL server.", + "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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FirewallRuleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/configurations": { + "get": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_ListByServer", + "x-ms-examples": { + "ConfigurationList": { + "$ref": "./examples/ConfigurationListByServer.json" + } + }, + "description": "List all the configurations in a given server.", + "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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/configurations/{configurationName}": { + "get": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_Get", + "x-ms-examples": { + "ConfigurationGet": { + "$ref": "./examples/ConfigurationGet.json" + } + }, + "description": "Gets information about a configuration of server.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_Update", + "x-ms-examples": { + "Update a user configuration": { + "$ref": "./examples/ConfigurationUpdate.json" + } + }, + "description": "Updates a configuration of a server.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Configuration" + }, + "description": "The required parameters for updating a server configuration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_Put", + "x-ms-examples": { + "Update a user configuration": { + "$ref": "./examples/ConfigurationUpdate.json" + } + }, + "description": "Updates a configuration of a server.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Configuration" + }, + "description": "The required parameters for updating a server configuration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/checkNameAvailability": { + "post": { + "tags": [ + "CheckNameAvailability" + ], + "operationId": "CheckNameAvailability_Execute", + "x-ms-examples": { + "NameAvailability": { + "$ref": "./examples/CheckNameAvailability.json" + } + }, + "description": "Check the availability of name for resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "nameAvailabilityRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NameAvailabilityRequest" + }, + "description": "The required parameters for checking if resource name is available." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NameAvailability" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/locations/{locationName}/capabilities": { + "get": { + "tags": [ + "LocationBasedCapabilities" + ], + "operationId": "LocationBasedCapabilities_Execute", + "x-ms-examples": { + "CapabilitiesList": { + "$ref": "./examples/CapabilitiesByLocation.json" + } + }, + "description": "Get capabilities at specified location in a given subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapabilitiesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/locations/{locationName}/checkVirtualNetworkSubnetUsage": { + "post": { + "tags": [ + "VirtualNetworkSubnetUsage" + ], + "operationId": "VirtualNetworkSubnetUsage_Execute", + "x-ms-examples": { + "VirtualNetworkSubnetUsageList": { + "$ref": "./examples/VirtualNetworkSubnetUsage.json" + } + }, + "description": "Get virtual network subnet usage for a given vNet resource id.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkSubnetUsageParameter" + }, + "description": "The required parameters for creating or updating a server." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualNetworkSubnetUsageResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/providers/Microsoft.DBforPostgreSQL/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "OperationList": { + "$ref": "./examples/OperationList.json" + } + }, + "description": "Lists all of the available REST API operations.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "VirtualNetworkSubnetUsageParameter": { + "type": "object", + "properties": { + "virtualNetworkArmResourceId": { + "type": "string", + "description": "Virtual network resource id." + } + }, + "description": "Virtual network subnet usage parameter" + }, + "VirtualNetworkSubnetUsageResult": { + "type": "object", + "properties": { + "delegatedSubnetsUsage": { + "type": "array", + "items": { + "$ref": "#/definitions/DelegatedSubnetUsage" + }, + "readOnly": true + } + }, + "description": "Virtual network subnet usage data." + }, + "DelegatedSubnetUsage": { + "type": "object", + "properties": { + "subnetName": { + "type": "string", + "readOnly": true, + "description": "name of the subnet" + }, + "usage": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Number of used delegated subnets" + } + }, + "description": "Delegated subnet usage data." + }, + "StorageMBCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "storage MB name", + "readOnly": true + }, + "supportedIops": { + "type": "integer", + "format": "int64", + "description": "supported IOPS", + "readOnly": true + }, + "storageSizeMB": { + "type": "integer", + "format": "int64", + "description": "storage size in MB", + "readOnly": true + }, + "status": { + "type": "string", + "description": "The status", + "readOnly": true + } + }, + "description": "storage size in MB capability" + }, + "VcoreCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "vCore name", + "readOnly": true + }, + "vCores": { + "type": "integer", + "format": "int64", + "description": "supported vCores", + "readOnly": true + }, + "supportedIops": { + "type": "integer", + "format": "int64", + "description": "supported IOPS", + "readOnly": true + }, + "supportedMemoryPerVcoreMB": { + "type": "integer", + "format": "int64", + "description": "supported memory per vCore in MB", + "readOnly": true + }, + "status": { + "type": "string", + "description": "The status", + "readOnly": true + } + }, + "description": "Vcores capability" + }, + "ServerVersionCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "server version", + "readOnly": true + }, + "supportedVcores": { + "type": "array", + "items": { + "$ref": "#/definitions/VcoreCapability" + }, + "readOnly": true + }, + "status": { + "type": "string", + "description": "The status", + "readOnly": true + } + }, + "description": "Server version capabilities." + }, + "StorageEditionCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "storage edition name", + "readOnly": true + }, + "supportedStorageMB": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageMBCapability" + }, + "readOnly": true + }, + "status": { + "type": "string", + "description": "The status", + "readOnly": true + } + }, + "description": "storage edition capability" + }, + "NodeTypeCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "note type name", + "readOnly": true + }, + "nodeType": { + "type": "string", + "description": "note type", + "readOnly": true + }, + "status": { + "type": "string", + "description": "The status", + "readOnly": true + } + }, + "description": "node type capability" + }, + "FlexibleServerEditionCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Server edition name", + "readOnly": true + }, + "supportedStorageEditions": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageEditionCapability" + }, + "description": "The list of editions supported by this server edition.", + "readOnly": true + }, + "supportedServerVersions": { + "type": "array", + "items": { + "$ref": "#/definitions/ServerVersionCapability" + }, + "description": "The list of server versions supported by this server edition.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "The status", + "readOnly": true + } + }, + "description": "Flexible server edition capabilities." + }, + "HyperscaleNodeEditionCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Server edition name", + "readOnly": true + }, + "supportedStorageEditions": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageEditionCapability" + }, + "description": "The list of editions supported by this server edition.", + "readOnly": true + }, + "supportedServerVersions": { + "type": "array", + "items": { + "$ref": "#/definitions/ServerVersionCapability" + }, + "description": "The list of server versions supported by this server edition.", + "readOnly": true + }, + "supportedNodeTypes": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeTypeCapability" + }, + "description": "The list of Node Types supported by this server edition.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "The status", + "readOnly": true + } + }, + "description": "Hyperscale node edition capabilities." + }, + "CapabilityProperties": { + "type": "object", + "properties": { + "zone": { + "type": "string", + "description": "zone name", + "readOnly": true + }, + "geoBackupSupported": { + "type": "boolean", + "description": "A value indicating whether a new server in this region can have geo-backups to paired region.", + "readOnly": true + }, + "zoneRedundantHaSupported": { + "type": "boolean", + "description": "A value indicating whether a new server in this region can support multi zone HA.", + "readOnly": true + }, + "zoneRedundantHaAndGeoBackupSupported": { + "type": "boolean", + "description": "A value indicating whether a new server in this region can have geo-backups to paired region.", + "readOnly": true + }, + "supportedFlexibleServerEditions": { + "type": "array", + "items": { + "$ref": "#/definitions/FlexibleServerEditionCapability" + }, + "readOnly": true + }, + "supportedHyperscaleNodeEditions": { + "type": "array", + "items": { + "$ref": "#/definitions/HyperscaleNodeEditionCapability" + }, + "readOnly": true + }, + "status": { + "type": "string", + "description": "The status", + "readOnly": true + } + }, + "description": "Location capabilities." + }, + "CapabilitiesListResult": { + "type": "object", + "properties": { + "value": { + "description": "A list of supported capabilities.", + "type": "array", + "items": { + "$ref": "#/definitions/CapabilityProperties" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + }, + "description": "location capability" + }, + "ServerVersion": { + "type": "string", + "description": "The version of a server.", + "enum": [ + "13", + "12", + "11" + ], + "x-ms-enum": { + "name": "ServerVersion", + "modelAsString": true + } + }, + "ServerProperties": { + "type": "object", + "properties": { + "administratorLogin": { + "type": "string", + "description": "The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "administratorLoginPassword": { + "type": "string", + "description": "The administrator login password (required for server creation).", + "x-ms-secret": true, + "format": "password", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "version": { + "$ref": "#/definitions/ServerVersion", + "description": "PostgreSQL Server version." + }, + "minorVersion": { + "type": "string", + "description": "The minor version of the server.", + "readOnly": true + }, + "state": { + "type": "string", + "description": "A state of a server that is visible to user.", + "readOnly": true, + "enum": [ + "Ready", + "Dropping", + "Disabled", + "Starting", + "Stopping", + "Stopped", + "Updating" + ], + "x-ms-enum": { + "name": "ServerState", + "modelAsString": true + } + }, + "fullyQualifiedDomainName": { + "type": "string", + "description": "The fully qualified domain name of a server.", + "readOnly": true + }, + "storage": { + "$ref": "#/definitions/Storage", + "description": "Storage properties of a server." + }, + "backup": { + "$ref": "#/definitions/Backup", + "description": "Backup properties of a server." + }, + "network": { + "$ref": "#/definitions/Network", + "description": "Network properties of a server.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "highAvailability": { + "$ref": "#/definitions/HighAvailability", + "description": "High availability properties of a server." + }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "description": "Maintenance window properties of a server.", + "x-ms-mutability": [ + "update", + "read" + ] + }, + "sourceServerResourceId": { + "type": "string", + "description": "The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore'.", + "x-ms-mutability": [ + "create" + ] + }, + "pointInTimeUTC": { + "type": "string", + "format": "date-time", + "description": "Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore'.", + "x-ms-mutability": [ + "create" + ] + }, + "availabilityZone": { + "type": "string", + "description": "availability zone information of the server.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "createMode": { + "type": "string", + "description": "The mode to create a new PostgreSQL server.", + "enum": [ + "Default", + "Create", + "Update", + "PointInTimeRestore" + ], + "x-ms-enum": { + "name": "CreateMode", + "modelAsString": true + }, + "x-ms-mutability": [ + "create", + "update" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application-specific metadata in the form of key-value pairs." + } + }, + "description": "The properties of a server." + }, + "Server": { + "type": "object", + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Identity", + "description": "The Azure Active Directory identity of the server." + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU (pricing tier) of the server." + }, + "properties": { + "$ref": "#/definitions/ServerProperties", + "x-ms-client-flatten": true, + "description": "Properties of the server." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true, + "description": "The system metadata relating to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "description": "Represents a server." + }, + "ServerPropertiesForUpdate": { + "type": "object", + "properties": { + "administratorLoginPassword": { + "type": "string", + "format": "password", + "description": "The password of the administrator login." + }, + "storage": { + "$ref": "#/definitions/Storage", + "description": "Storage properties of a server." + }, + "backup": { + "$ref": "#/definitions/Backup", + "description": "Backup properties of a server." + }, + "highAvailability": { + "$ref": "#/definitions/HighAvailability", + "description": "High availability properties of a server." + }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "description": "Maintenance window properties of a server." + }, + "createMode": { + "type": "string", + "description": "The mode to update a new PostgreSQL server.", + "enum": [ + "Default", + "Update" + ], + "x-ms-enum": { + "name": "CreateModeForUpdate", + "modelAsString": true + }, + "x-ms-mutability": [ + "update" + ] + } + } + }, + "ServerForUpdate": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The location the resource resides in." + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU (pricing tier) of the server." + }, + "properties": { + "$ref": "#/definitions/ServerPropertiesForUpdate", + "x-ms-client-flatten": true, + "description": "Properties of the server." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application-specific metadata in the form of key-value pairs." + } + }, + "description": "Represents a server to be updated." + }, + "ServerListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Server" + }, + "description": "The list of flexible servers" + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of servers." + }, + "Sku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3." + }, + "tier": { + "type": "string", + "description": "The tier of the particular SKU, e.g. Burstable.", + "enum": [ + "Burstable", + "GeneralPurpose", + "MemoryOptimized" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + } + }, + "required": [ + "name", + "tier" + ], + "description": "Sku information related properties of a server." + }, + "Storage": { + "type": "object", + "properties": { + "storageSizeGB": { + "type": "integer", + "format": "int32", + "description": "Max storage allowed for a server." + } + }, + "description": "Storage properties of a server" + }, + "Backup": { + "type": "object", + "properties": { + "backupRetentionDays": { + "type": "integer", + "format": "int32", + "description": "Backup retention days for the server." + }, + "geoRedundantBackup": { + "type": "string", + "description": "A value indicating whether Geo-Redundant backup is enabled on the server.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "GeoRedundantBackupEnum", + "modelAsString": true + }, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "earliestRestoreDate": { + "type": "string", + "format": "date-time", + "description": "The earliest restore point time (ISO8601 format) for server.", + "readOnly": true + } + }, + "description": "Backup properties of a server" + }, + "Network": { + "type": "object", + "properties": { + "publicNetworkAccess": { + "type": "string", + "description": "public network access is enabled or not", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ServerPublicNetworkAccessState", + "modelAsString": true + }, + "readOnly": true + }, + "delegatedSubnetResourceId": { + "type": "string", + "description": "delegated subnet arm resource id.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "privateDnsZoneArmResourceId": { + "type": "string", + "description": "private dns zone arm resource id.", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "description": "Network properties of a server" + }, + "HighAvailability": { + "type": "object", + "properties": { + "mode": { + "type": "string", + "description": "The HA mode for the server.", + "enum": [ + "Disabled", + "ZoneRedundant" + ], + "x-ms-enum": { + "name": "HighAvailabilityMode", + "modelAsString": true + } + }, + "state": { + "type": "string", + "description": "A state of a HA server that is visible to user.", + "enum": [ + "NotEnabled", + "CreatingStandby", + "ReplicatingData", + "FailingOver", + "Healthy", + "RemovingStandby" + ], + "x-ms-enum": { + "name": "ServerHAState", + "modelAsString": true + }, + "readOnly": true + }, + "standbyAvailabilityZone": { + "type": "string", + "description": "availability zone information of the standby." + } + }, + "description": "High availability properties of a server" + }, + "MaintenanceWindow": { + "type": "object", + "description": "Maintenance window properties of a server.", + "properties": { + "customWindow": { + "type": "string", + "description": "indicates whether custom window is enabled or disabled" + }, + "startHour": { + "type": "integer", + "format": "int32", + "description": "start hour for maintenance window" + }, + "startMinute": { + "type": "integer", + "format": "int32", + "description": "start minute for maintenance window" + }, + "dayOfWeek": { + "type": "integer", + "format": "int32", + "description": "day of week for maintenance window" + } + } + }, + "FirewallRuleProperties": { + "type": "object", + "properties": { + "startIpAddress": { + "type": "string", + "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$", + "description": "The start IP address of the server firewall rule. Must be IPv4 format." + }, + "endIpAddress": { + "type": "string", + "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$", + "description": "The end IP address of the server firewall rule. Must be IPv4 format." + } + }, + "required": [ + "startIpAddress", + "endIpAddress" + ], + "description": "The properties of a server firewall rule." + }, + "FirewallRule": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FirewallRuleProperties", + "x-ms-client-flatten": true, + "description": "The properties of a firewall rule." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true, + "description": "The system metadata relating to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "required": [ + "properties" + ], + "description": "Represents a server firewall rule." + }, + "FirewallRuleListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FirewallRule" + }, + "description": "The list of firewall rules in a server." + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of firewall rules." + }, + "ConfigurationProperties": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "Value of the configuration." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "Description of the configuration." + }, + "defaultValue": { + "type": "string", + "readOnly": true, + "description": "Default value of the configuration." + }, + "dataType": { + "type": "string", + "readOnly": true, + "description": "Data type of the configuration.", + "enum": [ + "Boolean", + "Numeric", + "Integer", + "Enumeration" + ], + "x-ms-enum": { + "name": "ConfigurationDataType", + "modelAsString": true + } + }, + "allowedValues": { + "type": "string", + "readOnly": true, + "description": "Allowed values of the configuration." + }, + "source": { + "type": "string", + "description": "Source of the configuration." + } + }, + "description": "The properties of a configuration." + }, + "Configuration": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ConfigurationProperties", + "x-ms-client-flatten": true, + "description": "The properties of a configuration." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true, + "description": "The system metadata relating to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "description": "Represents a Configuration." + }, + "ConfigurationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Configuration" + }, + "description": "The list of server configurations." + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of server configurations." + }, + "OperationDisplay": { + "type": "object", + "properties": { + "provider": { + "type": "string", + "readOnly": true, + "description": "Operation resource provider name." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "Resource on which the operation is performed." + }, + "operation": { + "type": "string", + "readOnly": true, + "description": "Localized friendly name for the operation." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "Operation description." + } + }, + "description": "Display metadata associated with the operation." + }, + "Operation": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the operation being performed on this particular object." + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "readOnly": true, + "description": "The localized display information for this particular operation or action." + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "origin": { + "type": "string", + "readOnly": true, + "description": "The intended executor of the operation.", + "enum": [ + "NotSpecified", + "user", + "system" + ], + "x-ms-enum": { + "name": "OperationOrigin", + "modelAsString": true + } + }, + "properties": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "readOnly": true, + "x-ms-client-flatten": false, + "description": "Additional descriptions for the operation." + } + }, + "description": "REST API operation definition." + }, + "OperationListResult": { + "description": "A list of resource provider operations.", + "type": "object", + "properties": { + "value": { + "description": "Collection of available operation details", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "NameAvailabilityRequest": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "Resource name to verify." + }, + "type": { + "type": "string", + "description": "Resource type used for verification." + } + }, + "description": "Request from client to check resource name availability." + }, + "NameAvailability": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "Error Message." + }, + "nameAvailable": { + "type": "boolean", + "description": "Indicates whether the resource name is available." + }, + "name": { + "type": "string", + "description": "name of the PostgreSQL server." + }, + "type": { + "type": "string", + "description": "type of the server" + } + }, + "description": "Represents a resource name availability." + }, + "RestartParameter": { + "type": "object", + "properties": { + "restartWithFailover": { + "type": "boolean", + "description": "Indicates whether to restart the server with failover." + }, + "failoverMode": { + "type": "string", + "description": "Failover mode." + } + }, + "description": "Represents server restart parameters." + }, + "CloudError": { + "x-ms-external": true, + "type": "object", + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse" + } + }, + "description": "An error response from the Batch service." + } + }, + "parameters": { + "LocationNameParameter": { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the location.", + "x-ms-parameter-location": "method" + }, + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the server.", + "x-ms-parameter-location": "method" + }, + "FirewallRuleNameParameter": { + "name": "firewallRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the server firewall rule.", + "x-ms-parameter-location": "method" + }, + "ConfigurationNameParameter": { + "name": "configurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the server configuration.", + "x-ms-parameter-location": "method" + }, + "MaintenanceWindowNameParameter": { + "name": "maintenanceWindowName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance window.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json index 2184ab17d862..ecfe673cddb0 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json @@ -34,7 +34,7 @@ } }, "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}": { "put": { "tags": [ "Servers" @@ -241,7 +241,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers": { "get": { "tags": [ "Servers" @@ -283,7 +283,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBForPostgreSQL/servers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/servers": { "get": { "tags": [ "Servers" @@ -322,7 +322,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/replicas": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/replicas": { "get": { "tags": [ "Replicas" @@ -367,7 +367,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/restart": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/restart": { "post": { "tags": [ "ServerRestart" @@ -410,7 +410,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/firewallRules/{firewallRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/firewallRules/{firewallRuleName}": { "put": { "tags": [ "FirewallRules" @@ -564,7 +564,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/firewallRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/firewallRules": { "get": { "tags": [ "FirewallRules" @@ -609,7 +609,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { "get": { "tags": [ "VirtualNetworkRules" @@ -754,7 +754,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/virtualNetworkRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/virtualNetworkRules": { "get": { "tags": [ "VirtualNetworkRules" @@ -796,7 +796,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/databases/{databaseName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/databases/{databaseName}": { "put": { "tags": [ "Databases" @@ -950,7 +950,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/databases": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/databases": { "get": { "tags": [ "Databases" @@ -995,7 +995,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/configurations/{configurationName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/configurations/{configurationName}": { "put": { "tags": [ "Configurations" @@ -1096,7 +1096,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/configurations": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/configurations": { "get": { "tags": [ "Configurations" @@ -1141,7 +1141,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/updateConfigurations": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/updateConfigurations": { "post": { "tags": [ "ConfigurationsUpdate" @@ -1199,7 +1199,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/logFiles": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/logFiles": { "get": { "tags": [ "LogFiles" @@ -1244,7 +1244,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/administrators/activeDirectory": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/administrators/activeDirectory": { "get": { "tags": [ "ServerAdministrators" @@ -1386,7 +1386,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/administrators": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/administrators": { "get": { "tags": [ "ServerAdministrators" @@ -1431,7 +1431,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/recoverableServers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/recoverableServers": { "get": { "tags": [ "RecoverableServers" @@ -1473,7 +1473,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/performanceTiers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/performanceTiers": { "get": { "tags": [ "ServerBasedPerformanceTier" @@ -1518,7 +1518,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBForPostgreSQL/locations/{locationName}/performanceTiers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/locations/{locationName}/performanceTiers": { "get": { "tags": [ "LocationBasedPerformanceTier" @@ -1560,7 +1560,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBForPostgreSQL/checkNameAvailability": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/checkNameAvailability": { "post": { "tags": [ "CheckNameAvailability" @@ -1605,7 +1605,7 @@ } } }, - "/providers/Microsoft.DBForPostgreSQL/operations": { + "/providers/Microsoft.DBforPostgreSQL/operations": { "get": { "tags": [ "Operations" diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/Databases.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/Databases.json new file mode 100644 index 000000000000..aff65a40716d --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/Databases.json @@ -0,0 +1,316 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2021-06-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.DBforPostgreSQL/flexibleServers/{serverName}/databases/{databaseName}": { + "put": { + "tags": [ + "Databases" + ], + "operationId": "Databases_Create", + "x-ms-examples": { + "Create a database": { + "$ref": "./examples/DatabaseCreate.json" + } + }, + "description": "Creates a new database or updates an existing database.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Database" + }, + "description": "The required parameters for creating or updating a database." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Databases" + ], + "operationId": "Databases_Delete", + "x-ms-examples": { + "Delete a database": { + "$ref": "./examples/DatabaseDelete.json" + } + }, + "description": "Deletes a database.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Databases" + ], + "operationId": "Databases_Get", + "x-ms-examples": { + "Get a database": { + "$ref": "./examples/DatabaseGet.json" + } + }, + "description": "Gets information about a database.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/databases": { + "get": { + "tags": [ + "Databases" + ], + "operationId": "Databases_ListByServer", + "x-ms-examples": { + "List databases in a server": { + "$ref": "./examples/DatabasesListByServer.json" + } + }, + "description": "List all the databases in a given server.", + "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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DatabaseListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "DatabaseProperties": { + "properties": { + "charset": { + "type": "string", + "description": "The charset of the database." + }, + "collation": { + "type": "string", + "description": "The collation of the database." + } + }, + "description": "The properties of a database." + }, + "Database": { + "properties": { + "properties": { + "$ref": "#/definitions/DatabaseProperties", + "x-ms-client-flatten": true, + "description": "The properties of a database." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true, + "description": "The system metadata relating to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "description": "Represents a Database." + }, + "DatabaseListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Database" + }, + "description": "The list of databases housed in a server" + }, + "nextLink": { + "description": "The link used to get the next page of databases.", + "type": "string" + } + }, + "description": "A List of databases." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse" + } + }, + "description": "An error response from the Batch service." + } + }, + "parameters": { + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "description": "The name of the server.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DatabaseNameParameter": { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/PrivateDnsZone.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/PrivateDnsZone.json new file mode 100644 index 000000000000..9c65844534f4 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/PrivateDnsZone.json @@ -0,0 +1,86 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01", + "title": "PostgreSQLManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model." + }, + "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.DBforPostgreSQL/getPrivateDnsZoneSuffix": { + "post": { + "tags": [ + "GetPrivateDnsZoneSuffix" + ], + "operationId": "GetPrivateDnsZoneSuffix_Execute", + "x-ms-examples": { + "GetPrivateDnsZoneSuffix": { + "$ref": "./examples/GetPrivateDnsZoneSuffix.json" + } + }, + "description": "Get private DNS zone suffix in the cloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateDnsZoneSuffix" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "PrivateDnsZoneSuffix": { + "type": "string", + "description": "Represents a resource name availability." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse" + } + }, + "description": "An error response from the Batch service." + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/CapabilitiesByLocation.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/CapabilitiesByLocation.json new file mode 100644 index 000000000000..2c78e5056f87 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/CapabilitiesByLocation.json @@ -0,0 +1,6094 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "locationName": "westus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "zone": "none", + "geoBackupSupported": true, + "zoneRedundantHaSupported": true, + "zoneRedundantHaAndGeoBackupSupported": true, + "supportedFlexibleServerEditions": [ + { + "name": "Burstable", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "GeneralPurpose", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "MemoryOptimized", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + } + ], + "supportedHyperscaleNodeEditions": [ + { + "name": "GeneralPurpose", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + }, + { + "name": "33553408", + "supportedIops": 20000, + "storageSizeMB": 33553408, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "11.0", + "supportedVcores": [ + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "11.2", + "supportedVcores": [ + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "11.2.8", + "supportedVcores": [ + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + } + ], + "supportedNodeTypes": [ + { + "name": "Coordinator", + "nodeType": "Coordinator", + "status": "Default" + } + ], + "status": "Available" + }, + { + "name": "MemoryOptimized", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + }, + { + "name": "33553408", + "supportedIops": 20000, + "storageSizeMB": 33553408, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "11.0", + "supportedVcores": [ + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "11.2", + "supportedVcores": [ + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "11.2.8", + "supportedVcores": [ + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + } + ], + "supportedNodeTypes": [ + { + "name": "Worker", + "nodeType": "Worker", + "status": "Default" + } + ], + "status": "Available" + } + ], + "status": "Default" + }, + { + "zone": "1", + "geoBackupSupported": true, + "zoneRedundantHaSupported": true, + "zoneRedundantHaAndGeoBackupSupported": true, + "supportedFlexibleServerEditions": [ + { + "name": "Burstable", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "GeneralPurpose", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "MemoryOptimized", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + } + ], + "supportedHyperscaleNodeEditions": [], + "status": "Available" + }, + { + "zone": "2", + "geoBackupSupported": true, + "zoneRedundantHaSupported": true, + "zoneRedundantHaAndGeoBackupSupported": true, + "supportedFlexibleServerEditions": [ + { + "name": "Burstable", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "GeneralPurpose", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "MemoryOptimized", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + } + ], + "supportedHyperscaleNodeEditions": [], + "status": "Available" + }, + { + "zone": "3", + "geoBackupSupported": true, + "zoneRedundantHaSupported": true, + "zoneRedundantHaAndGeoBackupSupported": true, + "supportedFlexibleServerEditions": [ + { + "name": "Burstable", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "GeneralPurpose", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 4096, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "MemoryOptimized", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768, + "status": "Available" + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536, + "status": "Available" + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072, + "status": "Available" + }, + { + "name": "262144", + "supportedIops": 1100, + "storageSizeMB": 262144, + "status": "Available" + }, + { + "name": "524288", + "supportedIops": 2300, + "storageSizeMB": 524288, + "status": "Available" + }, + { + "name": "1048576", + "supportedIops": 5000, + "storageSizeMB": 1048576, + "status": "Available" + }, + { + "name": "2097152", + "supportedIops": 7500, + "storageSizeMB": 2097152, + "status": "Available" + }, + { + "name": "4194304", + "supportedIops": 7500, + "storageSizeMB": 4194304, + "status": "Available" + }, + { + "name": "8388608", + "supportedIops": 16000, + "storageSizeMB": 8388608, + "status": "Available" + }, + { + "name": "16777216", + "supportedIops": 18000, + "storageSizeMB": 16777216, + "status": "Available" + } + ], + "status": "Default" + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.0", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "12.1", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + }, + { + "name": "13", + "supportedVcores": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 8192, + "status": "Available" + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 18000, + "supportedMemoryPerVcoreMB": 6912, + "status": "Available" + } + ], + "status": "Available" + } + ], + "status": "Available" + } + ], + "supportedHyperscaleNodeEditions": [], + "status": "Available" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/CheckNameAvailability.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..a5ac71dce79d --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/CheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "nameAvailabilityRequest": { + "name": "name1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "message": "", + "name": "name1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ConfigurationGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ConfigurationGet.json new file mode 100644 index 000000000000..007f2bc89654 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ConfigurationGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "configurationName": "array_nulls", + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "properties": { + "value": "on", + "description": "Enable input of NULL elements in arrays.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/array_nulls", + "name": "array_nulls", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ConfigurationListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ConfigurationListByServer.json new file mode 100644 index 000000000000..736f068199ba --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ConfigurationListByServer.json @@ -0,0 +1,1902 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff//resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations?api-version=2021-06-01&$top=200&$skiptoken=skiptoken", + "value": [ + { + "properties": { + "value": "", + "description": "Sets the application name to be reported in statistics and logs.", + "defaultValue": "", + "dataType": "String", + "allowedValues": "[A-Za-z0-9._-]*", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/application_name", + "name": "application_name", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables input of NULL elements in arrays.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/array_nulls", + "name": "array_nulls", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Starts the autovacuum subprocess.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum", + "name": "autovacuum", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.1", + "description": "Number of tuple inserts, updates, or deletes prior to analyze as a fraction of reltuples.", + "defaultValue": "0.1", + "dataType": "Numeric", + "allowedValues": "0-100", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_analyze_scale_factor", + "name": "autovacuum_analyze_scale_factor", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "50", + "description": "Minimum number of tuple inserts, updates, or deletes prior to analyze.", + "defaultValue": "50", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_analyze_threshold", + "name": "autovacuum_analyze_threshold", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "60", + "description": "Time to sleep between autovacuum runs.", + "defaultValue": "60", + "dataType": "Integer", + "allowedValues": "1-2147483", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_naptime", + "name": "autovacuum_naptime", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "Vacuum cost delay in milliseconds, for autovacuum.", + "defaultValue": "2", + "dataType": "Integer", + "allowedValues": "-1-100", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_vacuum_cost_delay", + "name": "autovacuum_vacuum_cost_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-1", + "description": "Vacuum cost amount available before napping, for autovacuum.", + "defaultValue": "-1", + "dataType": "Integer", + "allowedValues": "-1-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_vacuum_cost_limit", + "name": "autovacuum_vacuum_cost_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.2", + "description": "Number of tuple updates or deletes prior to vacuum as a fraction of reltuples.", + "defaultValue": "0.2", + "dataType": "Numeric", + "allowedValues": "0-100", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_vacuum_scale_factor", + "name": "autovacuum_vacuum_scale_factor", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "50", + "description": "Minimum number of tuple updates or deletes prior to vacuum.", + "defaultValue": "50", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_vacuum_threshold", + "name": "autovacuum_vacuum_threshold", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-1", + "description": "Sets the maximum memory to be used by each autovacuum worker process.", + "defaultValue": "-1", + "dataType": "Integer", + "allowedValues": "-1-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_work_mem", + "name": "autovacuum_work_mem", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Number of pages after which previously performed writes are flushed to disk.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-256", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/backend_flush_after", + "name": "backend_flush_after", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "safe_encoding", + "description": "Sets whether \"\\'\" is allowed in string literals.", + "defaultValue": "safe_encoding", + "dataType": "Enumeration", + "allowedValues": "safe_encoding,on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/backslash_quote", + "name": "backslash_quote", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "200", + "description": "Background writer sleep time between rounds.", + "defaultValue": "200", + "dataType": "Integer", + "allowedValues": "10-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/bgwriter_delay", + "name": "bgwriter_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "64", + "description": "Number of pages after which previously performed writes are flushed to disk.", + "defaultValue": "64", + "dataType": "Integer", + "allowedValues": "0-256", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/bgwriter_flush_after", + "name": "bgwriter_flush_after", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "100", + "description": "Background writer maximum number of LRU pages to flush per round.", + "defaultValue": "100", + "dataType": "Integer", + "allowedValues": "0-1073741823", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/bgwriter_lru_maxpages", + "name": "bgwriter_lru_maxpages", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "Multiple of the average buffer usage to free per round.", + "defaultValue": "2", + "dataType": "Numeric", + "allowedValues": "0-10", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/bgwriter_lru_multiplier", + "name": "bgwriter_lru_multiplier", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "hex", + "description": "Sets the output format for bytea.", + "defaultValue": "hex", + "dataType": "Enumeration", + "allowedValues": "escape,hex", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/bytea_output", + "name": "bytea_output", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Checks function bodies during CREATE FUNCTION.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/check_function_bodies", + "name": "check_function_bodies", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.5", + "description": "Time spent flushing dirty buffers during checkpoint, as fraction of checkpoint interval.", + "defaultValue": "0.5", + "dataType": "Numeric", + "allowedValues": "0-1", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/checkpoint_completion_target", + "name": "checkpoint_completion_target", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "300", + "description": "Sets the maximum time between automatic WAL checkpoints.", + "defaultValue": "300", + "dataType": "Integer", + "allowedValues": "30-86400", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/checkpoint_timeout", + "name": "checkpoint_timeout", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "30", + "description": "Enables warnings if checkpoint segments are filled more frequently than this.", + "defaultValue": "30", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/checkpoint_warning", + "name": "checkpoint_warning", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "sql_ascii", + "description": "Sets the client's character set encoding.", + "defaultValue": "sql_ascii", + "dataType": "Enumeration", + "allowedValues": "BIG5,EUC_CN,EUC_JP,EUC_JIS_2004,EUC_KR,EUC_TW,GB18030,GBK,ISO_8859_5,ISO_8859_6,ISO_8859_7,ISO_8859_8,JOHAB,KOI8R,KOI8U,LATIN1,LATIN2,LATIN3,LATIN4,LATIN5,LATIN6,LATIN7,LATIN8,LATIN9,LATIN10,MULE_INTERNAL,SJIS,SHIFT_JIS_2004,SQL_ASCII,UHC,UTF8,WIN866,WIN874,WIN1250,WIN1251,WIN1252,WIN1253,WIN1254,WIN1255,WIN1256,WIN1257,WIN1258", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/client_encoding", + "name": "client_encoding", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "notice", + "description": "Sets the message levels that are sent to the client.", + "defaultValue": "notice", + "dataType": "Enumeration", + "allowedValues": "debug5,debug4,debug3,debug2,debug1,log,notice,warning,error", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/client_min_messages", + "name": "client_min_messages", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Sets the delay in microseconds between transaction commit and flushing WAL to disk.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-100000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/commit_delay", + "name": "commit_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "5", + "description": "Sets the minimum concurrent open transactions before performing commit_delay.", + "defaultValue": "5", + "dataType": "Integer", + "allowedValues": "0-1000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/commit_siblings", + "name": "commit_siblings", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "partition", + "description": "Enables the planner to use constraints to optimize queries.", + "defaultValue": "partition", + "dataType": "Enumeration", + "allowedValues": "partition,on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/constraint_exclusion", + "name": "constraint_exclusion", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.005", + "description": "Sets the planner's estimate of the cost of processing each index entry during an index scan.", + "defaultValue": "0.005", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/cpu_index_tuple_cost", + "name": "cpu_index_tuple_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.0025", + "description": "Sets the planner's estimate of the cost of processing each operator or function call.", + "defaultValue": "0.0025", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/cpu_operator_cost", + "name": "cpu_operator_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.01", + "description": "Sets the planner's estimate of the cost of processing each tuple (row).", + "defaultValue": "0.01", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/cpu_tuple_cost", + "name": "cpu_tuple_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.1", + "description": "Sets the planner's estimate of the fraction of a cursor's rows that will be retrieved.", + "defaultValue": "0.1", + "dataType": "Numeric", + "allowedValues": "0-1", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/cursor_tuple_fraction", + "name": "cursor_tuple_fraction", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "ISO, MDY", + "description": "Sets the display format for date and time values.", + "defaultValue": "ISO, MDY", + "dataType": "String", + "allowedValues": "(ISO|POSTGRES|SQL|GERMAN)(, (DMY|MDY|YMD))?", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/DateStyle", + "name": "DateStyle", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1000", + "description": "Sets the amount of time, in milliseconds, to wait on a lock before checking for deadlock.", + "defaultValue": "1000", + "dataType": "Integer", + "allowedValues": "1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/deadlock_timeout", + "name": "deadlock_timeout", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Indents parse and plan tree displays.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/debug_pretty_print", + "name": "debug_pretty_print", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs each query's parse tree.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/debug_print_parse", + "name": "debug_print_parse", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs each query's execution plan.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/debug_print_plan", + "name": "debug_print_plan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs each query's rewritten parse tree.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/debug_print_rewritten", + "name": "debug_print_rewritten", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "100", + "description": "Sets the default statistics target.", + "defaultValue": "100", + "dataType": "Integer", + "allowedValues": "1-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_statistics_target", + "name": "default_statistics_target", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "", + "description": "Sets the default tablespace to create tables and indexes in.", + "defaultValue": "", + "dataType": "String", + "allowedValues": "[A-Za-z._]*", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_tablespace", + "name": "default_tablespace", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "pg_catalog.english", + "description": "Sets default text search configuration.", + "defaultValue": "pg_catalog.english", + "dataType": "String", + "allowedValues": "[A-Za-z._]+", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_text_search_config", + "name": "default_text_search_config", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Sets the default deferrable status of new transactions.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_transaction_deferrable", + "name": "default_transaction_deferrable", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "read committed", + "description": "Sets the transaction isolation level of each new transaction.", + "defaultValue": "read committed", + "dataType": "Enumeration", + "allowedValues": "serializable,repeatable read,read committed,read uncommitted", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_transaction_isolation", + "name": "default_transaction_isolation", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Sets the default read-only status of new transactions.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_transaction_read_only", + "name": "default_transaction_read_only", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Creates new tables with OIDs by default.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_with_oids", + "name": "default_with_oids", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "3145728", + "description": "Sets the planner's assumption about the size of the disk cache.", + "defaultValue": "3145728", + "dataType": "Integer", + "allowedValues": "1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/effective_cache_size", + "name": "effective_cache_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of bitmap-scan plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_bitmapscan", + "name": "enable_bitmapscan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of gather merge plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_gathermerge", + "name": "enable_gathermerge", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of hashed aggregation plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_hashagg", + "name": "enable_hashagg", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of hash join plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_hashjoin", + "name": "enable_hashjoin", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of index-only-scan plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_indexonlyscan", + "name": "enable_indexonlyscan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of index-scan plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_indexscan", + "name": "enable_indexscan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of materialization.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_material", + "name": "enable_material", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of merge join plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_mergejoin", + "name": "enable_mergejoin", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of nested loop join plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_nestloop", + "name": "enable_nestloop", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of sequential-scan plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_seqscan", + "name": "enable_seqscan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of explicit sort steps.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_sort", + "name": "enable_sort", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of TID scan plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_tidscan", + "name": "enable_tidscan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Warns about backslash escapes in ordinary string literals.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/escape_string_warning", + "name": "escape_string_warning", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Terminates session on any error.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/exit_on_error", + "name": "exit_on_error", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1", + "description": "Sets the number of digits displayed for floating-point values.", + "defaultValue": "1", + "dataType": "Integer", + "allowedValues": "-15-3", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/extra_float_digits", + "name": "extra_float_digits", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Forces use of parallel query facilities.", + "defaultValue": "off", + "dataType": "Enumeration", + "allowedValues": "off,on,regress", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/force_parallel_mode", + "name": "force_parallel_mode", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "8", + "description": "Sets the FROM-list size beyond which subqueries are not collapsed.", + "defaultValue": "8", + "dataType": "Integer", + "allowedValues": "1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/from_collapse_limit", + "name": "from_collapse_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables genetic query optimization.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo", + "name": "geqo", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "5", + "description": "GEQO: effort is used to set the default for other GEQO parameters.", + "defaultValue": "5", + "dataType": "Integer", + "allowedValues": "1-10", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_effort", + "name": "geqo_effort", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "GEQO: number of iterations of the algorithm.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_generations", + "name": "geqo_generations", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "GEQO: number of individuals in the population.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_pool_size", + "name": "geqo_pool_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "GEQO: seed for random path selection.", + "defaultValue": "0", + "dataType": "Numeric", + "allowedValues": "0-1", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_seed", + "name": "geqo_seed", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "GEQO: selective pressure within the population.", + "defaultValue": "2", + "dataType": "Numeric", + "allowedValues": "1.5-2", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_selection_bias", + "name": "geqo_selection_bias", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "12", + "description": "Sets the threshold of FROM items beyond which GEQO is used.", + "defaultValue": "12", + "dataType": "Integer", + "allowedValues": "2-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_threshold", + "name": "geqo_threshold", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Sets the maximum allowed result for exact search by GIN.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/gin_fuzzy_search_limit", + "name": "gin_fuzzy_search_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "4096", + "description": "Sets the maximum size of the pending list for GIN index.", + "defaultValue": "4096", + "dataType": "Integer", + "allowedValues": "64-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/gin_pending_list_limit", + "name": "gin_pending_list_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Sets the maximum allowed duration of any idling transaction.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/idle_in_transaction_session_timeout", + "name": "idle_in_transaction_session_timeout", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "postgres", + "description": "Sets the display format for interval values.", + "defaultValue": "postgres", + "dataType": "Enumeration", + "allowedValues": "postgres,postgres_verbose,sql_standard,iso_8601", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/IntervalStyle", + "name": "IntervalStyle", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "8", + "description": "Sets the FROM-list size beyond which JOIN constructs are not flattened.", + "defaultValue": "8", + "dataType": "Integer", + "allowedValues": "1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/join_collapse_limit", + "name": "join_collapse_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "en_US.utf-8", + "description": "Sets the locale for formatting monetary amounts.", + "defaultValue": "en_US.utf-8", + "dataType": "String", + "allowedValues": "[A-Za-z0-9._ -]+", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/lc_monetary", + "name": "lc_monetary", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "en_US.utf-8", + "description": "Sets the locale for formatting numbers.", + "defaultValue": "en_US.utf-8", + "dataType": "String", + "allowedValues": "[A-Za-z0-9._ -]+", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/lc_numeric", + "name": "lc_numeric", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Enables backward compatibility mode for privilege checks on large objects.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/lo_compat_privileges", + "name": "lo_compat_privileges", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Sets the maximum allowed duration (in milliseconds) of any wait for a lock. 0 turns this off.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/lock_timeout", + "name": "lock_timeout", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-1", + "description": "Sets the minimum execution time above which autovacuum actions will be logged.", + "defaultValue": "-1", + "dataType": "Integer", + "allowedValues": "-1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_autovacuum_min_duration", + "name": "log_autovacuum_min_duration", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Logs each checkpoint.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_checkpoints", + "name": "log_checkpoints", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Logs each successful connection.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_connections", + "name": "log_connections", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "stderr", + "description": "Sets the destination for server log output.", + "defaultValue": "stderr", + "dataType": "Enumeration", + "allowedValues": "stderr,csvlog", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_destination", + "name": "log_destination", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs end of a session, including duration.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_disconnections", + "name": "log_disconnections", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs the duration of each completed SQL statement.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_duration", + "name": "log_duration", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "default", + "description": "Sets the verbosity of logged messages.", + "defaultValue": "default", + "dataType": "Enumeration", + "allowedValues": "terse,default,verbose", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_error_verbosity", + "name": "log_error_verbosity", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs long lock waits.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_lock_waits", + "name": "log_lock_waits", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-1", + "description": "Sets the minimum execution time (in milliseconds) above which statements will be logged. -1 disables logging statement durations.", + "defaultValue": "-1", + "dataType": "Integer", + "allowedValues": "-1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_min_duration_statement", + "name": "log_min_duration_statement", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "error", + "description": "Causes all statements generating error at or above this level to be logged.", + "defaultValue": "error", + "dataType": "Enumeration", + "allowedValues": "debug5,debug4,debug3,debug2,debug1,info,notice,warning,error,log,fatal,panic", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_min_error_statement", + "name": "log_min_error_statement", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "warning", + "description": "Sets the message levels that are logged.", + "defaultValue": "warning", + "dataType": "Enumeration", + "allowedValues": "debug5,debug4,debug3,debug2,debug1,info,notice,warning,error,log,fatal,panic", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_min_messages", + "name": "log_min_messages", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs each replication command.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_replication_commands", + "name": "log_replication_commands", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "none", + "description": "Sets the type of statements logged.", + "defaultValue": "none", + "dataType": "Enumeration", + "allowedValues": "none,ddl,mod,all", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_statement", + "name": "log_statement", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "For each query, writes cumulative performance statistics to the server log.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_statement_stats", + "name": "log_statement_stats", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-1", + "description": "Logs the use of temporary files larger than this number of kilobytes.", + "defaultValue": "-1", + "dataType": "Integer", + "allowedValues": "-1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_temp_files", + "name": "log_temp_files", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "332800", + "description": "Sets the maximum memory to be used for maintenance operations.", + "defaultValue": "332800", + "dataType": "Integer", + "allowedValues": "1024-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/maintenance_work_mem", + "name": "maintenance_work_mem", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "8", + "description": "Sets the maximum number of parallel workers than can be active at one time.", + "defaultValue": "8", + "dataType": "Integer", + "allowedValues": "0-1024", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_parallel_workers", + "name": "max_parallel_workers", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "Sets the maximum number of parallel processes per executor node.", + "defaultValue": "2", + "dataType": "Integer", + "allowedValues": "0-1024", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_parallel_workers_per_gather", + "name": "max_parallel_workers_per_gather", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "Sets the maximum number of predicate-locked tuples per page.", + "defaultValue": "2", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_pred_locks_per_page", + "name": "max_pred_locks_per_page", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-2", + "description": "Sets the maximum number of predicate-locked pages and tuples per relation.", + "defaultValue": "-2", + "dataType": "Integer", + "allowedValues": "-2147483648-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_pred_locks_per_relation", + "name": "max_pred_locks_per_relation", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "30000", + "description": "Sets the maximum delay before canceling queries when a hot standby server is processing archived WAL data.", + "defaultValue": "30000", + "dataType": "Integer", + "allowedValues": "-1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_standby_archive_delay", + "name": "max_standby_archive_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "30000", + "description": "Sets the maximum delay before canceling queries when a hot standby server is processing streamed WAL data.", + "defaultValue": "30000", + "dataType": "Integer", + "allowedValues": "-1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_standby_streaming_delay", + "name": "max_standby_streaming_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "Maximum number of table synchronization workers per subscription.", + "defaultValue": "2", + "dataType": "Integer", + "allowedValues": "0-262143", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_sync_workers_per_subscription", + "name": "max_sync_workers_per_subscription", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1024", + "description": "Sets the WAL size that triggers a checkpoint.", + "defaultValue": "1024", + "dataType": "Integer", + "allowedValues": "2-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_wal_size", + "name": "max_wal_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "64", + "description": "Sets the minimum amount of index data for a parallel scan.", + "defaultValue": "64", + "dataType": "Integer", + "allowedValues": "0-715827882", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/min_parallel_index_scan_size", + "name": "min_parallel_index_scan_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1024", + "description": "Sets the minimum amount of table data for a parallel scan.", + "defaultValue": "1024", + "dataType": "Integer", + "allowedValues": "0-715827882", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/min_parallel_table_scan_size", + "name": "min_parallel_table_scan_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "80", + "description": "Sets the minimum size to shrink the WAL to.", + "defaultValue": "80", + "dataType": "Integer", + "allowedValues": "2-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/min_wal_size", + "name": "min_wal_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Emits a warning for constructs that changed meaning since PostgreSQL 9.4.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/operator_precedence_warning", + "name": "operator_precedence_warning", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1000", + "description": "Sets the planner's estimate of the cost of starting up worker processes for parallel query.", + "defaultValue": "1000", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/parallel_setup_cost", + "name": "parallel_setup_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.1", + "description": "Sets the planner's estimate of the cost of passing each tuple (row) from worker to master backend.", + "defaultValue": "0.1", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/parallel_tuple_cost", + "name": "parallel_tuple_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "When generating SQL fragments, quotes all identifiers.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/quote_all_identifiers", + "name": "quote_all_identifiers", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "4", + "description": "Sets the planner's estimate of the cost of a nonsequentially fetched disk page.", + "defaultValue": "4", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/random_page_cost", + "name": "random_page_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables row security.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/row_security", + "name": "row_security", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "\"$user\", public", + "description": "Sets the schema search order for names that are not schema-qualified.", + "defaultValue": "\"$user\", public", + "dataType": "String", + "allowedValues": "[A-Za-z.\"$, ]+", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/search_path", + "name": "search_path", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1", + "description": "Sets the planner's estimate of the cost of a sequentially fetched disk page.", + "defaultValue": "1", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/seq_page_cost", + "name": "seq_page_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "origin", + "description": "Sets the session's behavior for triggers and rewrite rules.", + "defaultValue": "origin", + "dataType": "Enumeration", + "allowedValues": "origin,replica,local", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/session_replication_role", + "name": "session_replication_role", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Causes '...' strings to treat backslashes literally.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/standard_conforming_strings", + "name": "standard_conforming_strings", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Sets the maximum allowed duration (in milliseconds) of any statement. 0 turns this off.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/statement_timeout", + "name": "statement_timeout", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables synchronized sequential scans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/synchronize_seqscans", + "name": "synchronize_seqscans", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Sets the current transaction's synchronization level.", + "defaultValue": "on", + "dataType": "Enumeration", + "allowedValues": "local,remote_write,on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/synchronous_commit", + "name": "synchronous_commit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "9", + "description": "Maximum number of TCP keepalive retransmits.", + "defaultValue": "9", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/tcp_keepalives_count", + "name": "tcp_keepalives_count", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "120", + "description": "Time between issuing TCP keepalives.", + "defaultValue": "120", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/tcp_keepalives_idle", + "name": "tcp_keepalives_idle", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "30", + "description": "Time between TCP keepalive retransmits.", + "defaultValue": "30", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/tcp_keepalives_interval", + "name": "tcp_keepalives_interval", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1024", + "description": "Sets the maximum number of temporary buffers used by each database session.", + "defaultValue": "1024", + "dataType": "Integer", + "allowedValues": "100-1073741823", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/temp_buffers", + "name": "temp_buffers", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "", + "description": "Sets the tablespace(s) to use for temporary tables and sort files.", + "defaultValue": "", + "dataType": "String", + "allowedValues": "[A-Za-z._]*", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/temp_tablespaces", + "name": "temp_tablespaces", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "UTC", + "description": "Sets the time zone for displaying and interpreting time stamps.", + "defaultValue": "UTC", + "dataType": "String", + "allowedValues": "[A-Za-z0-9/+_-]+", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/TimeZone", + "name": "TimeZone", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Collects information about executing commands.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/track_activities", + "name": "track_activities", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Collects statistics on database activity.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/track_counts", + "name": "track_counts", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "none", + "description": "Collects function-level statistics on database activity.", + "defaultValue": "none", + "dataType": "Enumeration", + "allowedValues": "none,pl,all", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/track_functions", + "name": "track_functions", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Collects timing statistics for database I/O activity.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/track_io_timing", + "name": "track_io_timing", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Treats \"expr=NULL\" as \"expr IS NULL\".", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/transform_null_equals", + "name": "transform_null_equals", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Vacuum cost delay in milliseconds.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-100", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_cost_delay", + "name": "vacuum_cost_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "200", + "description": "Vacuum cost amount available before napping.", + "defaultValue": "200", + "dataType": "Integer", + "allowedValues": "1-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_cost_limit", + "name": "vacuum_cost_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "20", + "description": "Vacuum cost for a page dirtied by vacuum.", + "defaultValue": "20", + "dataType": "Integer", + "allowedValues": "0-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_cost_page_dirty", + "name": "vacuum_cost_page_dirty", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1", + "description": "Vacuum cost for a page found in the buffer cache.", + "defaultValue": "1", + "dataType": "Integer", + "allowedValues": "0-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_cost_page_hit", + "name": "vacuum_cost_page_hit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "10", + "description": "Vacuum cost for a page not found in the buffer cache.", + "defaultValue": "10", + "dataType": "Integer", + "allowedValues": "0-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_cost_page_miss", + "name": "vacuum_cost_page_miss", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Number of transactions by which VACUUM and HOT cleanup should be deferred, if any.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-1000000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_defer_cleanup_age", + "name": "vacuum_defer_cleanup_age", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "50000000", + "description": "Minimum age at which VACUUM should freeze a table row.", + "defaultValue": "50000000", + "dataType": "Integer", + "allowedValues": "0-1000000000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_freeze_min_age", + "name": "vacuum_freeze_min_age", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "150000000", + "description": "Age at which VACUUM should scan whole table to freeze tuples.", + "defaultValue": "150000000", + "dataType": "Integer", + "allowedValues": "0-2000000000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_freeze_table_age", + "name": "vacuum_freeze_table_age", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "5000000", + "description": "Minimum age at which VACUUM should freeze a MultiXactId in a table row.", + "defaultValue": "5000000", + "dataType": "Integer", + "allowedValues": "0-1000000000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_multixact_freeze_min_age", + "name": "vacuum_multixact_freeze_min_age", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "150000000", + "description": "Multixact age at which VACUUM should scan whole table to freeze tuples.", + "defaultValue": "150000000", + "dataType": "Integer", + "allowedValues": "0-2000000000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_multixact_freeze_table_age", + "name": "vacuum_multixact_freeze_table_age", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "10", + "description": "Sets the maximum interval between WAL receiver status reports to the primary.", + "defaultValue": "10", + "dataType": "Integer", + "allowedValues": "0-2147483", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/wal_receiver_status_interval", + "name": "wal_receiver_status_interval", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "200", + "description": "Time between WAL flushes performed in the WAL writer.", + "defaultValue": "200", + "dataType": "Integer", + "allowedValues": "1-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/wal_writer_delay", + "name": "wal_writer_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "128", + "description": "Amount of WAL written out by WAL writer that triggers a flush.", + "defaultValue": "128", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/wal_writer_flush_after", + "name": "wal_writer_flush_after", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "115712", + "description": "Sets the amount of memory to be used by internal sort operations and hash tables before writing to temporary disk files.", + "defaultValue": "115712", + "dataType": "Integer", + "allowedValues": "4096-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/work_mem", + "name": "work_mem", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "base64", + "description": "Sets how binary values are to be encoded in XML.", + "defaultValue": "base64", + "dataType": "Enumeration", + "allowedValues": "base64,hex", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/xmlbinary", + "name": "xmlbinary", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "content", + "description": "Sets whether XML data in implicit parsing and serialization operations is to be considered as documents or content fragments.", + "defaultValue": "content", + "dataType": "Enumeration", + "allowedValues": "content,document", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/xmloption", + "name": "xmloption", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ConfigurationUpdate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ConfigurationUpdate.json new file mode 100644 index 000000000000..6b8842cc5c3e --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ConfigurationUpdate.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "serverName": "testserver", + "configurationName": "event_scheduler", + "resourceGroupName": "testrg", + "api-version": "2021-06-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "value": "on", + "source": "user-override" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "value": "ON", + "description": "Indicates the status of the Event Scheduler.", + "defaultValue": "OFF", + "dataType": "Enumeration", + "allowedValues": "ON,OFF,DISABLED", + "source": "user-override" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/event_scheduler", + "name": "event_scheduler", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/DatabaseCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/DatabaseCreate.json new file mode 100644 index 000000000000..73040ea376bf --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/DatabaseCreate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "databaseName": "db1", + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2021-06-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "charset": "utf8", + "collation": "en_US.utf8" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/databases/db1", + "name": "db1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/databases", + "properties": { + "charset": "utf8", + "collation": "en_US.utf8" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/databases/db1", + "name": "db1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/databases", + "properties": { + "charset": "utf8", + "collation": "en_US.utf8" + } + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/DatabaseDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/DatabaseDelete.json new file mode 100644 index 000000000000..019557674727 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/DatabaseDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "databaseName": "db1", + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2021-06-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/DatabaseGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/DatabaseGet.json new file mode 100644 index 000000000000..d4daf8d3a5f1 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/DatabaseGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "databaseName": "db1", + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2021-06-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/databases/db1", + "name": "db1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/databases", + "properties": { + "charset": "utf8", + "collation": "en_US.utf8" + } + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/DatabasesListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/DatabasesListByServer.json new file mode 100644 index 000000000000..10d81eb03cc8 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/DatabasesListByServer.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2021-06-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/databases/db1", + "name": "db1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/databases", + "properties": { + "charset": "utf8", + "collation": "en_US.utf8" + } + }, + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/databases/db2", + "name": "db2", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/databases", + "properties": { + "charset": "utf8", + "collation": "en_US.utf8" + } + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/FirewallRuleCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/FirewallRuleCreate.json new file mode 100644 index 000000000000..a9f08ca716d5 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/FirewallRuleCreate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "firewallRuleName": "rule1", + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/servers/testserver/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/servers/testserver/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/FirewallRuleDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/FirewallRuleDelete.json new file mode 100644 index 000000000000..244d02d0ac01 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/FirewallRuleDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "firewallRuleName": "rule1", + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/FirewallRuleGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/FirewallRuleGet.json new file mode 100644 index 000000000000..42ad715d83f5 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/FirewallRuleGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "firewallRuleName": "rule1", + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/servers/testserver/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/FirewallRuleListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/FirewallRuleListByServer.json new file mode 100644 index 000000000000..f8c9f3133858 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/FirewallRuleListByServer.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff//resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/firewallRules?api-version=2021-06-01&$top=2&$skiptoken=skiptoken", + "value": [ + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + }, + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/firewallRules/rule2", + "name": "rule2", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "1.0.0.0", + "endIpAddress": "255.0.0.0" + } + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/GetPrivateDnsZoneSuffix.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/GetPrivateDnsZoneSuffix.json new file mode 100644 index 000000000000..65f2beac9d14 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/GetPrivateDnsZoneSuffix.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": "postgres.database.azure.com" + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/OperationList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/OperationList.json new file mode 100644 index 000000000000..79c1521a1cba --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/OperationList.json @@ -0,0 +1,176 @@ +{ + "parameters": { + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/read", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "PostgreSQL Server", + "operation": "List/Get PostgreSQL Servers", + "description": "Return the list of servers or gets the properties for the specified server." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/write", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "PostgreSQL Server", + "operation": "Create/Update PostgreSQL Server", + "description": "Creates a server with the specified parameters or update the properties or tags for the specified server." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/delete", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "PostgreSQL Server", + "operation": "Delete PostgreSQL Server", + "description": "Deletes an existing server." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules/read", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Firewall Rules", + "operation": "List/Get Firewall Rules", + "description": "Return the list of firewall rules for a server or gets the properties for the specified firewall rule." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules/write", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Firewall Rules", + "operation": "Create/Update Firewall Rule", + "description": "Creates a firewall rule with the specified parameters or update an existing rule." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules/delete", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Firewall Rules", + "operation": "Delete Firewall Rule", + "description": "Deletes an existing firewall rule." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Database Metric Definition", + "operation": "Get database metric definitions", + "description": "Return types of metrics that are available for databases" + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "cpu_percent", + "displayName": "CPU percent", + "displayDescription": "CPU percent", + "unit": "Percent", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "compute_limit", + "displayName": "Compute Unit limit", + "displayDescription": "Compute Unit limit", + "unit": "Count", + "aggregationType": "Average" + }, + { + "name": "compute_consumption_percent", + "displayName": "Compute Unit percentage", + "displayDescription": "Compute Unit percentage", + "unit": "Percent", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "memory_percent", + "displayName": "Memory percent", + "displayDescription": "Memory percent", + "unit": "Percent", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "io_consumption_percent", + "displayName": "IO percent", + "displayDescription": "IO percent", + "unit": "Percent", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "storage_percent", + "displayName": "Storage percentage", + "displayDescription": "Storage percentage", + "unit": "Percent", + "aggregationType": "Average" + }, + { + "name": "storage_used", + "displayName": "Storage used", + "displayDescription": "Storage used", + "unit": "Bytes", + "aggregationType": "Average" + }, + { + "name": "storage_limit", + "displayName": "Storage limit", + "displayDescription": "Storage limit", + "unit": "Bytes", + "aggregationType": "Average" + }, + { + "name": "active_connections", + "displayName": "Total active connections", + "displayDescription": "Total active connections", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "connections_failed", + "displayName": "Total failed connections", + "displayDescription": "Total failed connections", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": true + } + ] + } + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Database Metric Definition", + "operation": "Read diagnostic setting", + "description": "Gets the disagnostic setting for the resource" + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Database Metric Definition", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource" + } + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerCreate.json new file mode 100644 index 000000000000..09401bc28c8e --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerCreate.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2021-06-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLogin": "cloudsa", + "administratorLoginPassword": "password", + "version": "12", + "availabilityZone": "1", + "createMode": "Create", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled" + }, + "network": { + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourcegroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant" + } + }, + "tags": { + "ElasticServer": "1" + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:08:06.7197478+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:08:06.7197478+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerCreatePointInTimeRestore.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerCreatePointInTimeRestore.json new file mode 100644 index 000000000000..56e65381cc60 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerCreatePointInTimeRestore.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "serverName": "pgtestsvc5", + "resourceGroupName": "testrg", + "api-version": "2021-06-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "properties": { + "createMode": "PointInTimeRestore", + "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/sourcepgservername", + "pointInTimeUTC": "2021-06-27T00:04:59.4078005+00:00" + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc5.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "2", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-27T00:28:17.7279547+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5", + "name": "pgtestsvc5", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc5.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "2", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-27T00:28:17.7279547+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5", + "name": "pgtestsvc5", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerDelete.json new file mode 100644 index 000000000000..c0e5bbb95a7f --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerGet.json new file mode 100644 index 000000000000..e9445268eaf0 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerGet.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "serverName": "pgtestsvc1", + "resourceGroupName": "testrg", + "api-version": "2021-06-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc1.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1", + "name": "pgtestsvc1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerGetWithVnet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerGetWithVnet.json new file mode 100644 index 000000000000..a73476a3159e --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerGetWithVnet.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2021-06-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerList.json new file mode 100644 index 000000000000..054b4f264661 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerList.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/flexibleServers?api-version=2021-06-01&$top=3&$skiptoken=skiptoken", + "value": [ + { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + }, + { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc1.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:15:38.8131437+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1", + "name": "pgtestsvc1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerListByResourceGroup.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerListByResourceGroup.json new file mode 100644 index 000000000000..8bbd416005cf --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerListByResourceGroup.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2021-06-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers?api-version=2021-06-01&$top=3&$skiptoken=skiptoken", + "value": [ + { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + }, + { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc1.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:15:38.8131437+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1", + "name": "pgtestsvc1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerRestart.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerRestart.json new file mode 100644 index 000000000000..24e52991d805 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerRestart.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerRestartWithFailover.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerRestartWithFailover.json new file mode 100644 index 000000000000..f8f484379769 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerRestartWithFailover.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "restartWithFailover": true, + "failoverMode": "forcedFailover" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerStart.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerStart.json new file mode 100644 index 000000000000..24e52991d805 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerStart.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerStop.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerStop.json new file mode 100644 index 000000000000..24e52991d805 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerStop.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2021-06-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerUpdate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerUpdate.json new file mode 100644 index 000000000000..e54d23675479 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerUpdate.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "TestGroup", + "api-version": "2021-06-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D8s_v3" + }, + "properties": { + "administratorLoginPassword": "newpassword", + "createMode": "Update", + "storage": { + "storageSizeGB": 1024 + }, + "backup": { + "backupRetentionDays": 20 + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D8s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 1024 + }, + "backup": { + "backupRetentionDays": 20, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerUpdateWithCustomerMaintenanceWindow.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerUpdateWithCustomerMaintenanceWindow.json new file mode 100644 index 000000000000..204d2b7ea5c6 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/ServerUpdateWithCustomerMaintenanceWindow.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2021-06-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "properties": { + "createMode": "Update", + "maintenanceWindow": { + "customWindow": "Enabled", + "dayOfWeek": 0, + "startHour": 8, + "startMinute": 0 + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Enabled", + "dayOfWeek": 0, + "startHour": 8, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/VirtualNetworkSubnetUsage.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/VirtualNetworkSubnetUsage.json new file mode 100644 index 000000000000..c2ae77a2c4f5 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/VirtualNetworkSubnetUsage.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "locationName": "westus", + "parameters": { + "virtualNetworkArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/testvnet" + } + }, + "responses": { + "200": { + "body": { + "delegatedSubnetsUsage": [ + { + "subnetName": "test-subnet-1", + "usage": 2 + }, + { + "subnetName": "test-subnet-2", + "usage": 3 + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json new file mode 100644 index 000000000000..7771cb9a91ac --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json @@ -0,0 +1,2081 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2021-06-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.DBforPostgreSQL/flexibleServers/{serverName}": { + "put": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Create", + "x-ms-examples": { + "Create a new server": { + "$ref": "./examples/ServerCreate.json" + }, + "Create a database as a point in time restore": { + "$ref": "./examples/ServerCreatePointInTimeRestore.json" + } + }, + "description": "Creates a new server.", + "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/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Server" + }, + "description": "The required parameters for creating or updating a server." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Update", + "x-ms-examples": { + "ServerUpdate": { + "$ref": "./examples/ServerUpdate.json" + }, + "ServerUpdateWithCustomerMaintenanceWindow": { + "$ref": "./examples/ServerUpdateWithCustomerMaintenanceWindow.json" + } + }, + "description": "Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.", + "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/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ServerForUpdate" + }, + "description": "The required parameters for updating a server." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Delete", + "x-ms-examples": { + "ServerDelete": { + "$ref": "./examples/ServerDelete.json" + } + }, + "description": "Deletes a server.", + "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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Get", + "x-ms-examples": { + "ServerGet": { + "$ref": "./examples/ServerGet.json" + }, + "ServerGetWithVnet": { + "$ref": "./examples/ServerGetWithVnet.json" + } + }, + "description": "Gets information about a server.", + "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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers": { + "get": { + "tags": [ + "Servers" + ], + "operationId": "Servers_ListByResourceGroup", + "x-ms-examples": { + "ServerListByResourceGroup": { + "$ref": "./examples/ServerListByResourceGroup.json" + } + }, + "description": "List all the servers in a given resource group.", + "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" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/flexibleServers": { + "get": { + "tags": [ + "Servers" + ], + "operationId": "Servers_List", + "x-ms-examples": { + "ServerList": { + "$ref": "./examples/ServerList.json" + } + }, + "description": "List all the servers in a given 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": "OK", + "schema": { + "$ref": "#/definitions/ServerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/restart": { + "post": { + "tags": [ + "ServerRestart" + ], + "operationId": "Servers_Restart", + "x-ms-examples": { + "ServerRestart": { + "$ref": "./examples/ServerRestart.json" + }, + "ServerRestartWithFailover": { + "$ref": "./examples/ServerRestartWithFailover.json" + } + }, + "description": "Restarts a server.", + "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/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "schema": { + "$ref": "#/definitions/RestartParameter" + }, + "description": "The parameters for restarting a server." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/start": { + "post": { + "tags": [ + "ServerStart" + ], + "operationId": "Servers_Start", + "x-ms-examples": { + "ServerStart": { + "$ref": "./examples/ServerStart.json" + } + }, + "description": "Starts a server.", + "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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/stop": { + "post": { + "tags": [ + "ServerStop" + ], + "operationId": "Servers_Stop", + "x-ms-examples": { + "ServerStop": { + "$ref": "./examples/ServerStop.json" + } + }, + "description": "Stops a server.", + "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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/firewallRules/{firewallRuleName}": { + "put": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_CreateOrUpdate", + "x-ms-examples": { + "FirewallRuleCreate": { + "$ref": "./examples/FirewallRuleCreate.json" + } + }, + "description": "Creates a new firewall rule or updates an existing firewall rule.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/FirewallRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FirewallRule" + }, + "description": "The required parameters for creating or updating a firewall rule." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_Delete", + "x-ms-examples": { + "FirewallRuleDelete": { + "$ref": "./examples/FirewallRuleDelete.json" + } + }, + "description": "Deletes a PostgreSQL server firewall rule.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/FirewallRuleNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_Get", + "x-ms-examples": { + "FirewallRuleList": { + "$ref": "./examples/FirewallRuleGet.json" + } + }, + "description": "List all the firewall rules in a given server.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/FirewallRuleNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/firewallRules": { + "get": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_ListByServer", + "x-ms-examples": { + "FirewallRuleList": { + "$ref": "./examples/FirewallRuleListByServer.json" + } + }, + "description": "List all the firewall rules in a given PostgreSQL server.", + "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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FirewallRuleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/configurations": { + "get": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_ListByServer", + "x-ms-examples": { + "ConfigurationList": { + "$ref": "./examples/ConfigurationListByServer.json" + } + }, + "description": "List all the configurations in a given server.", + "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/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/configurations/{configurationName}": { + "get": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_Get", + "x-ms-examples": { + "ConfigurationGet": { + "$ref": "./examples/ConfigurationGet.json" + } + }, + "description": "Gets information about a configuration of server.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_Update", + "x-ms-examples": { + "Update a user configuration": { + "$ref": "./examples/ConfigurationUpdate.json" + } + }, + "description": "Updates a configuration of a server.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Configuration" + }, + "description": "The required parameters for updating a server configuration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_Put", + "x-ms-examples": { + "Update a user configuration": { + "$ref": "./examples/ConfigurationUpdate.json" + } + }, + "description": "Updates a configuration of a server.", + "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/ServerNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Configuration" + }, + "description": "The required parameters for updating a server configuration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/checkNameAvailability": { + "post": { + "tags": [ + "CheckNameAvailability" + ], + "operationId": "CheckNameAvailability_Execute", + "x-ms-examples": { + "NameAvailability": { + "$ref": "./examples/CheckNameAvailability.json" + } + }, + "description": "Check the availability of name for resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "nameAvailabilityRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NameAvailabilityRequest" + }, + "description": "The required parameters for checking if resource name is available." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NameAvailability" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/locations/{locationName}/capabilities": { + "get": { + "tags": [ + "LocationBasedCapabilities" + ], + "operationId": "LocationBasedCapabilities_Execute", + "x-ms-examples": { + "CapabilitiesList": { + "$ref": "./examples/CapabilitiesByLocation.json" + } + }, + "description": "Get capabilities at specified location in a given subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapabilitiesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/locations/{locationName}/checkVirtualNetworkSubnetUsage": { + "post": { + "tags": [ + "VirtualNetworkSubnetUsage" + ], + "operationId": "VirtualNetworkSubnetUsage_Execute", + "x-ms-examples": { + "VirtualNetworkSubnetUsageList": { + "$ref": "./examples/VirtualNetworkSubnetUsage.json" + } + }, + "description": "Get virtual network subnet usage for a given vNet resource id.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkSubnetUsageParameter" + }, + "description": "The required parameters for creating or updating a server." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualNetworkSubnetUsageResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/providers/Microsoft.DBforPostgreSQL/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "OperationList": { + "$ref": "./examples/OperationList.json" + } + }, + "description": "Lists all of the available REST API operations.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "VirtualNetworkSubnetUsageParameter": { + "type": "object", + "properties": { + "virtualNetworkArmResourceId": { + "type": "string", + "description": "Virtual network resource id." + } + }, + "description": "Virtual network subnet usage parameter" + }, + "VirtualNetworkSubnetUsageResult": { + "type": "object", + "properties": { + "delegatedSubnetsUsage": { + "type": "array", + "items": { + "$ref": "#/definitions/DelegatedSubnetUsage" + }, + "readOnly": true + } + }, + "description": "Virtual network subnet usage data." + }, + "DelegatedSubnetUsage": { + "type": "object", + "properties": { + "subnetName": { + "type": "string", + "readOnly": true, + "description": "name of the subnet" + }, + "usage": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Number of used delegated subnets" + } + }, + "description": "Delegated subnet usage data." + }, + "StorageMBCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "storage MB name", + "readOnly": true + }, + "supportedIops": { + "type": "integer", + "format": "int64", + "description": "supported IOPS", + "readOnly": true + }, + "storageSizeMB": { + "type": "integer", + "format": "int64", + "description": "storage size in MB", + "readOnly": true + }, + "status": { + "type": "string", + "description": "The status", + "readOnly": true + } + }, + "description": "storage size in MB capability" + }, + "VcoreCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "vCore name", + "readOnly": true + }, + "vCores": { + "type": "integer", + "format": "int64", + "description": "supported vCores", + "readOnly": true + }, + "supportedIops": { + "type": "integer", + "format": "int64", + "description": "supported IOPS", + "readOnly": true + }, + "supportedMemoryPerVcoreMB": { + "type": "integer", + "format": "int64", + "description": "supported memory per vCore in MB", + "readOnly": true + }, + "status": { + "type": "string", + "description": "The status", + "readOnly": true + } + }, + "description": "Vcores capability" + }, + "ServerVersionCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "server version", + "readOnly": true + }, + "supportedVcores": { + "type": "array", + "items": { + "$ref": "#/definitions/VcoreCapability" + }, + "readOnly": true + }, + "status": { + "type": "string", + "description": "The status", + "readOnly": true + } + }, + "description": "Server version capabilities." + }, + "StorageEditionCapability": { + "properties": { + "name": { + "type": "string", + "description": "storage edition name", + "readOnly": true + }, + "supportedStorageMB": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageMBCapability" + }, + "readOnly": true + }, + "status": { + "type": "string", + "description": "The status", + "readOnly": true + } + }, + "description": "storage edition capability" + }, + "NodeTypeCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "note type name", + "readOnly": true + }, + "nodeType": { + "type": "string", + "description": "note type", + "readOnly": true + }, + "status": { + "type": "string", + "description": "The status", + "readOnly": true + } + }, + "description": "node type capability" + }, + "FlexibleServerEditionCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Server edition name", + "readOnly": true + }, + "supportedStorageEditions": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageEditionCapability" + }, + "description": "The list of editions supported by this server edition.", + "readOnly": true + }, + "supportedServerVersions": { + "type": "array", + "items": { + "$ref": "#/definitions/ServerVersionCapability" + }, + "description": "The list of server versions supported by this server edition.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "The status", + "readOnly": true + } + }, + "description": "Flexible server edition capabilities." + }, + "HyperscaleNodeEditionCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Server edition name", + "readOnly": true + }, + "supportedStorageEditions": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageEditionCapability" + }, + "description": "The list of editions supported by this server edition.", + "readOnly": true + }, + "supportedServerVersions": { + "type": "array", + "items": { + "$ref": "#/definitions/ServerVersionCapability" + }, + "description": "The list of server versions supported by this server edition.", + "readOnly": true + }, + "supportedNodeTypes": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeTypeCapability" + }, + "description": "The list of Node Types supported by this server edition.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "The status", + "readOnly": true + } + }, + "description": "Hyperscale node edition capabilities." + }, + "CapabilityProperties": { + "properties": { + "zone": { + "type": "string", + "description": "zone name", + "readOnly": true + }, + "geoBackupSupported": { + "type": "boolean", + "description": "A value indicating whether a new server in this region can have geo-backups to paired region.", + "readOnly": true + }, + "zoneRedundantHaSupported": { + "type": "boolean", + "description": "A value indicating whether a new server in this region can support multi zone HA.", + "readOnly": true + }, + "zoneRedundantHaAndGeoBackupSupported": { + "type": "boolean", + "description": "A value indicating whether a new server in this region can have geo-backups to paired region.", + "readOnly": true + }, + "supportedFlexibleServerEditions": { + "type": "array", + "items": { + "$ref": "#/definitions/FlexibleServerEditionCapability" + }, + "readOnly": true + }, + "supportedHyperscaleNodeEditions": { + "type": "array", + "items": { + "$ref": "#/definitions/HyperscaleNodeEditionCapability" + }, + "readOnly": true + }, + "status": { + "type": "string", + "description": "The status", + "readOnly": true + } + }, + "description": "Location capabilities." + }, + "CapabilitiesListResult": { + "type": "object", + "properties": { + "value": { + "description": "A list of supported capabilities.", + "type": "array", + "items": { + "$ref": "#/definitions/CapabilityProperties" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + }, + "description": "location capability" + }, + "ServerVersion": { + "type": "string", + "description": "The version of a server.", + "enum": [ + "13", + "12", + "11" + ], + "x-ms-enum": { + "name": "ServerVersion", + "modelAsString": true + } + }, + "ServerProperties": { + "properties": { + "administratorLogin": { + "type": "string", + "description": "The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "administratorLoginPassword": { + "type": "string", + "description": "The administrator login password (required for server creation).", + "x-ms-secret": true, + "format": "password", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "version": { + "$ref": "#/definitions/ServerVersion", + "description": "PostgreSQL Server version." + }, + "minorVersion": { + "type": "string", + "description": "The minor version of the server.", + "readOnly": true + }, + "state": { + "type": "string", + "description": "A state of a server that is visible to user.", + "readOnly": true, + "enum": [ + "Ready", + "Dropping", + "Disabled", + "Starting", + "Stopping", + "Stopped", + "Updating" + ], + "x-ms-enum": { + "name": "ServerState", + "modelAsString": true + } + }, + "fullyQualifiedDomainName": { + "type": "string", + "description": "The fully qualified domain name of a server.", + "readOnly": true + }, + "storage": { + "$ref": "#/definitions/Storage", + "description": "Storage properties of a server." + }, + "backup": { + "$ref": "#/definitions/Backup", + "description": "Backup properties of a server." + }, + "network": { + "$ref": "#/definitions/Network", + "description": "Network properties of a server.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "highAvailability": { + "$ref": "#/definitions/HighAvailability", + "description": "High availability properties of a server." + }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "description": "Maintenance window properties of a server.", + "x-ms-mutability": [ + "update", + "read" + ] + }, + "sourceServerResourceId": { + "type": "string", + "description": "The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore'.", + "x-ms-mutability": [ + "create" + ] + }, + "pointInTimeUTC": { + "type": "string", + "format": "date-time", + "description": "Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore'.", + "x-ms-mutability": [ + "create" + ] + }, + "availabilityZone": { + "type": "string", + "description": "availability zone information of the server.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "createMode": { + "type": "string", + "description": "The mode to create a new PostgreSQL server.", + "enum": [ + "Default", + "Create", + "Update", + "PointInTimeRestore" + ], + "x-ms-enum": { + "name": "CreateMode", + "modelAsString": true + }, + "x-ms-mutability": [ + "create", + "update" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application-specific metadata in the form of key-value pairs." + } + }, + "description": "The properties of a server." + }, + "Server": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU (pricing tier) of the server." + }, + "properties": { + "$ref": "#/definitions/ServerProperties", + "x-ms-client-flatten": true, + "description": "Properties of the server." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true, + "description": "The system metadata relating to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "description": "Represents a server." + }, + "ServerPropertiesForUpdate": { + "properties": { + "administratorLoginPassword": { + "type": "string", + "format": "password", + "description": "The password of the administrator login." + }, + "storage": { + "$ref": "#/definitions/Storage", + "description": "Storage properties of a server." + }, + "backup": { + "$ref": "#/definitions/Backup", + "description": "Backup properties of a server." + }, + "highAvailability": { + "$ref": "#/definitions/HighAvailability", + "description": "High availability properties of a server." + }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "description": "Maintenance window properties of a server." + }, + "createMode": { + "type": "string", + "description": "The mode to update a new PostgreSQL server.", + "enum": [ + "Default", + "Update" + ], + "x-ms-enum": { + "name": "CreateModeForUpdate", + "modelAsString": true + }, + "x-ms-mutability": [ + "update" + ] + } + } + }, + "ServerForUpdate": { + "properties": { + "location": { + "type": "string", + "description": "The location the resource resides in." + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU (pricing tier) of the server." + }, + "properties": { + "$ref": "#/definitions/ServerPropertiesForUpdate", + "x-ms-client-flatten": true, + "description": "Properties of the server." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application-specific metadata in the form of key-value pairs." + } + }, + "description": "Represents a server to be updated." + }, + "ServerListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Server" + }, + "description": "The list of flexible servers" + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of servers." + }, + "Sku": { + "properties": { + "name": { + "type": "string", + "description": "The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3." + }, + "tier": { + "type": "string", + "description": "The tier of the particular SKU, e.g. Burstable.", + "enum": [ + "Burstable", + "GeneralPurpose", + "MemoryOptimized" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + } + }, + "required": [ + "name", + "tier" + ], + "description": "Sku information related properties of a server." + }, + "Storage": { + "properties": { + "storageSizeGB": { + "type": "integer", + "format": "int32", + "description": "Max storage allowed for a server." + } + }, + "description": "Storage properties of a server" + }, + "Backup": { + "properties": { + "backupRetentionDays": { + "type": "integer", + "format": "int32", + "description": "Backup retention days for the server." + }, + "geoRedundantBackup": { + "type": "string", + "description": "A value indicating whether Geo-Redundant backup is enabled on the server.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "GeoRedundantBackupEnum", + "modelAsString": true + }, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "earliestRestoreDate": { + "type": "string", + "format": "date-time", + "description": "The earliest restore point time (ISO8601 format) for server.", + "readOnly": true + } + }, + "description": "Backup properties of a server" + }, + "Network": { + "properties": { + "publicNetworkAccess": { + "type": "string", + "description": "public network access is enabled or not", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ServerPublicNetworkAccessState", + "modelAsString": true + }, + "readOnly": true + }, + "delegatedSubnetResourceId": { + "type": "string", + "description": "delegated subnet arm resource id.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "privateDnsZoneArmResourceId": { + "type": "string", + "description": "private dns zone arm resource id.", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "description": "Network properties of a server" + }, + "HighAvailability": { + "properties": { + "mode": { + "type": "string", + "description": "The HA mode for the server.", + "enum": [ + "Disabled", + "ZoneRedundant" + ], + "x-ms-enum": { + "name": "HighAvailabilityMode", + "modelAsString": true + } + }, + "state": { + "type": "string", + "description": "A state of a HA server that is visible to user.", + "enum": [ + "NotEnabled", + "CreatingStandby", + "ReplicatingData", + "FailingOver", + "Healthy", + "RemovingStandby" + ], + "x-ms-enum": { + "name": "ServerHAState", + "modelAsString": true + }, + "readOnly": true + }, + "standbyAvailabilityZone": { + "type": "string", + "description": "availability zone information of the standby." + } + }, + "description": "High availability properties of a server" + }, + "MaintenanceWindow": { + "type": "object", + "description": "Maintenance window properties of a server.", + "properties": { + "customWindow": { + "type": "string", + "description": "indicates whether custom window is enabled or disabled" + }, + "startHour": { + "type": "integer", + "format": "int32", + "description": "start hour for maintenance window" + }, + "startMinute": { + "type": "integer", + "format": "int32", + "description": "start minute for maintenance window" + }, + "dayOfWeek": { + "type": "integer", + "format": "int32", + "description": "day of week for maintenance window" + } + } + }, + "FirewallRuleProperties": { + "properties": { + "startIpAddress": { + "type": "string", + "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$", + "description": "The start IP address of the server firewall rule. Must be IPv4 format." + }, + "endIpAddress": { + "type": "string", + "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$", + "description": "The end IP address of the server firewall rule. Must be IPv4 format." + } + }, + "required": [ + "startIpAddress", + "endIpAddress" + ], + "description": "The properties of a server firewall rule." + }, + "FirewallRule": { + "properties": { + "properties": { + "$ref": "#/definitions/FirewallRuleProperties", + "x-ms-client-flatten": true, + "description": "The properties of a firewall rule." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true, + "description": "The system metadata relating to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "required": [ + "properties" + ], + "description": "Represents a server firewall rule." + }, + "FirewallRuleListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FirewallRule" + }, + "description": "The list of firewall rules in a server." + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of firewall rules." + }, + "ConfigurationProperties": { + "properties": { + "value": { + "type": "string", + "description": "Value of the configuration." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "Description of the configuration." + }, + "defaultValue": { + "type": "string", + "readOnly": true, + "description": "Default value of the configuration." + }, + "dataType": { + "type": "string", + "readOnly": true, + "description": "Data type of the configuration.", + "enum": [ + "Boolean", + "Numeric", + "Integer", + "Enumeration" + ], + "x-ms-enum": { + "name": "ConfigurationDataType", + "modelAsString": true + } + }, + "allowedValues": { + "type": "string", + "readOnly": true, + "description": "Allowed values of the configuration." + }, + "source": { + "type": "string", + "description": "Source of the configuration." + } + }, + "description": "The properties of a configuration." + }, + "Configuration": { + "properties": { + "properties": { + "$ref": "#/definitions/ConfigurationProperties", + "x-ms-client-flatten": true, + "description": "The properties of a configuration." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true, + "description": "The system metadata relating to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "description": "Represents a Configuration." + }, + "ConfigurationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Configuration" + }, + "description": "The list of server configurations." + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of server configurations." + }, + "OperationDisplay": { + "properties": { + "provider": { + "type": "string", + "readOnly": true, + "description": "Operation resource provider name." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "Resource on which the operation is performed." + }, + "operation": { + "type": "string", + "readOnly": true, + "description": "Localized friendly name for the operation." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "Operation description." + } + }, + "description": "Display metadata associated with the operation." + }, + "Operation": { + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the operation being performed on this particular object." + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "readOnly": true, + "description": "The localized display information for this particular operation or action." + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "origin": { + "type": "string", + "readOnly": true, + "description": "The intended executor of the operation.", + "enum": [ + "NotSpecified", + "user", + "system" + ], + "x-ms-enum": { + "name": "OperationOrigin", + "modelAsString": true + } + }, + "properties": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "readOnly": true, + "x-ms-client-flatten": false, + "description": "Additional descriptions for the operation." + } + }, + "description": "REST API operation definition." + }, + "OperationListResult": { + "description": "A list of resource provider operations.", + "type": "object", + "properties": { + "value": { + "description": "Collection of available operation details", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "NameAvailabilityRequest": { + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "Resource name to verify." + }, + "type": { + "type": "string", + "description": "Resource type used for verification." + } + }, + "description": "Request from client to check resource name availability." + }, + "NameAvailability": { + "properties": { + "message": { + "type": "string", + "description": "Error Message." + }, + "nameAvailable": { + "type": "boolean", + "description": "Indicates whether the resource name is available." + }, + "name": { + "type": "string", + "description": "name of the PostgreSQL server." + }, + "type": { + "type": "string", + "description": "type of the server" + } + }, + "description": "Represents a resource name availability." + }, + "RestartParameter": { + "type": "object", + "properties": { + "restartWithFailover": { + "type": "boolean", + "description": "Indicates whether to restart the server with failover." + }, + "failoverMode": { + "type": "string", + "description": "Failover mode." + } + }, + "description": "Represents server restart parameters." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse" + } + }, + "description": "An error response from the Batch service." + } + }, + "parameters": { + "LocationNameParameter": { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the location.", + "x-ms-parameter-location": "method" + }, + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the server.", + "x-ms-parameter-location": "method" + }, + "FirewallRuleNameParameter": { + "name": "firewallRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the server firewall rule.", + "x-ms-parameter-location": "method" + }, + "ConfigurationNameParameter": { + "name": "configurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the server configuration.", + "x-ms-parameter-location": "method" + }, + "MaintenanceWindowNameParameter": { + "name": "maintenanceWindowName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance window.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/postgresql/resource-manager/readme.go.md b/specification/postgresql/resource-manager/readme.go.md index 87a6958d79ba..cfdb1a52bc58 100644 --- a/specification/postgresql/resource-manager/readme.go.md +++ b/specification/postgresql/resource-manager/readme.go.md @@ -12,6 +12,8 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-flexibleserver-2021-06 + - tag: package-flexibleserver-2021-06-preview - tag: package-2020-11-05-preview - tag: package-2020-02-14-preview - tag: package-2020-01-01 @@ -19,6 +21,28 @@ batch: - tag: package-2017-12-01 ``` +### Tag: package-flexibleserver-2021-06 and go + +These settings apply only when `--tag=package-flexibleserver-2021-06 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-flexibleserver-2021-06' && $(go) +rpname: postgresql +namespace: postgresqlflexibleservers +output-folder: $(go-sdk-folder)/services/$(rpname)/mgmt/2021-06-01/$(namespace) +``` + +### Tag: package-flexibleserver-2021-06-preview and go + +These settings apply only when `--tag=package-flexibleserver-2021-06-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-flexibleserver-2021-06-preview' && $(go) +rpname: postgresql +namespace: postgresqlflexibleservers +output-folder: $(go-sdk-folder)/services/preview/$(rpname)/mgmt/2021-06-01-preview/$(namespace) +``` + ### Tag: package-2020-11-05 and go These settings apply only when `--tag=package-2020-11-05-preview --go` is specified on the command line. diff --git a/specification/postgresql/resource-manager/readme.java.md b/specification/postgresql/resource-manager/readme.java.md index 134c8d9e3930..4f86b9ad8fd8 100644 --- a/specification/postgresql/resource-manager/readme.java.md +++ b/specification/postgresql/resource-manager/readme.java.md @@ -9,6 +9,7 @@ fluent: true namespace: com.microsoft.azure.management.postgresql license-header: MICROSOFT_MIT_NO_CODEGEN payload-flattening-threshold: 1 +tag: package-2020-01-01 output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-postgresql ``` diff --git a/specification/postgresql/resource-manager/readme.md b/specification/postgresql/resource-manager/readme.md index b984ff26c82e..4c70b7f7ffad 100644 --- a/specification/postgresql/resource-manager/readme.md +++ b/specification/postgresql/resource-manager/readme.md @@ -19,8 +19,6 @@ To see additional help and options, run: ## Configuration - - ### Basic Information These are the global settings for the PostgreSQL API. @@ -28,8 +26,51 @@ These are the global settings for the PostgreSQL API. title: PostgreSQLManagementClient description: The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model. openapi-type: arm +tag: package-flexibleserver-2021-06 +``` + +``` yaml $(package-flexibleservers) +tag: package-flexibleserver-2021-06 +``` + +``` yaml $(package-singleservers) tag: package-2020-01-01 ``` + +### Tag: package-2021-06-15-privatepreview + +These settings apply only when `--tag=package-2021-06-15-privatepreview` is specified on the command line. + +``` yaml $(tag) == 'package-2021-06-15-privatepreview' +input-file: +- Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/Migrations.json +- Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/postgresql.json +``` + +### Tag: package-flexibleserver-2021-06 + +These settings apply only when `--tag=package-flexibleserver-2021-06` is specified on the command line. + +``` yaml $(tag) == 'package-flexibleserver-2021-06' +input-file: +- Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json +- Microsoft.DBforPostgreSQL/stable/2021-06-01/Databases.json +- Microsoft.DBforPostgreSQL/stable/2021-06-01/PrivateDnsZone.json +``` + +### Tag: package-flexibleserver-2021-06-preview + +These settings apply only when `--tag=package-flexibleserver-2021-06-preview` is specified on the command line.cd .. + +``` yaml $(tag) == 'package-flexibleserver-2021-06-preview' +input-file: +- Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/postgresql.json +- Microsoft.DBforPostgreSQL/preview/2020-11-05-preview/Databases.json +- Microsoft.DBforPostgreSQL/preview/2021-03-31-privatepreview/PrivateDnsZone.json +- Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/IntelligentPerformance.json +- Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/QueryPerformanceInsights.json +``` + ### Tag: package-2021-04-10-privatepreview These settings apply only when `--tag=package-2021-04-10-privatepreview` is specified on the command line. @@ -41,6 +82,7 @@ input-file: - Microsoft.DBforPostgreSQL/preview/2021-04-10-privatepreview/postgresql.json ``` + ### Tag: package-2021-03-31-privatepreview These settings apply only when `--tag=package-2021-03-31-privatepreview` is specified on the command line. @@ -53,7 +95,6 @@ input-file: ``` - ### Tag: package-2020-11-05-preview These settings apply only when `--tag=package-2020-11-05-preview` is specified on the command line. @@ -181,12 +222,10 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - repo: azure-resource-manager-schemas ``` @@ -216,6 +255,10 @@ See configuration in [readme.go.md](./readme.go.md) See configuration in [readme.java.md](./readme.java.md) +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + ## Multi-API/Profile support for AutoRest v3 generators @@ -235,6 +278,10 @@ input-file: - $(this-folder)/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/postgresql.json - $(this-folder)/Microsoft.DBforPostgreSQL/preview/2021-04-10-privatepreview/postgresql.json - $(this-folder)/Microsoft.DBforPostgreSQL/preview/2020-01-01-privatepreview/DataEncryptionKeys.json + - $(this-folder)/Microsoft.DBforPostgreSQL/preview/2021-03-31-privatepreview/PrivateDnsZone.json + - $(this-folder)/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/postgresql.json + - $(this-folder)/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/IntelligentPerformance.json + - $(this-folder)/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/QueryPerformanceInsights.json - $(this-folder)/Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json - $(this-folder)/Microsoft.DBforPostgreSQL/stable/2017-12-01/ServerSecurityAlertPolicies.json - $(this-folder)/Microsoft.DBforPostgreSQL/stable/2018-06-01/PrivateEndpointConnections.json @@ -242,6 +289,9 @@ input-file: - $(this-folder)/Microsoft.DBforPostgreSQL/stable/2018-06-01/QueryPerformanceInsights.json - $(this-folder)/Microsoft.DBforPostgreSQL/stable/2018-06-01/PerformanceRecommendations.json - $(this-folder)/Microsoft.DBforPostgreSQL/stable/2020-01-01/DataEncryptionKeys.json + - $(this-folder)/Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json + - $(this-folder)/Microsoft.DBforPostgreSQL/stable/2021-06-01/Databases.json + - $(this-folder)/Microsoft.DBforPostgreSQL/stable/2021-06-01/PrivateDnsZone.json - $(this-folder)/Microsoft.DBforPostgreSQL/preview/2018-06-01-privatepreview/PrivateEndpointConnections.json - $(this-folder)/Microsoft.DBforPostgreSQL/preview/2018-06-01-privatepreview/PrivateLinkResources.json - $(this-folder)/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/postgresql.json diff --git a/specification/postgresql/resource-manager/readme.python.md b/specification/postgresql/resource-manager/readme.python.md index 6dc601939234..01335026cfd2 100644 --- a/specification/postgresql/resource-manager/readme.python.md +++ b/specification/postgresql/resource-manager/readme.python.md @@ -2,15 +2,13 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -These settings apply only when `--track2` is specified on the command line. ``` yaml $(track2) azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-rdbms -package-version: 1.0.0b1 no-namespace-folders: true +package-version: 1.0.0b1 ``` ### Python multi-api @@ -20,18 +18,16 @@ Generate all API versions currently shipped for this package ```yaml $(track2) clear-output-folder: true batch: + - tag: package-flexibleserver-2021-06 - tag: package-2020-01-01 - - tag: package-2020-11-05-preview - - tag: package-2021-03-31-privatepreview ``` +### Tag: package-flexibleserver-2021-06 and python -### Tag: package-2021-03-31-privatepreview and python - -These settings apply only when `--tag=package-2021-03-31-privatepreview --python` is specified on the command line. +These settings apply only when `--tag=package-flexibleserver-2021-06 --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2021-03-31-privatepreview' && $(python) +``` yaml $(tag) == 'package-flexibleserver-2021-06' && $(python) namespace: azure.mgmt.rdbms.postgresql_flexibleservers output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms/azure/mgmt/rdbms/postgresql_flexibleservers ``` @@ -44,14 +40,4 @@ Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2020-11-05-preview' && $(python) -namespace: azure.mgmt.rdbms.postgresql_flexibleservers -output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms/azure/mgmt/rdbms/postgresql_flexibleservers -``` +``` \ No newline at end of file diff --git a/specification/postgresql/resource-manager/readme.typescript.md b/specification/postgresql/resource-manager/readme.typescript.md index f0fb5561e92a..a7102d58a166 100644 --- a/specification/postgresql/resource-manager/readme.typescript.md +++ b/specification/postgresql/resource-manager/readme.typescript.md @@ -6,8 +6,60 @@ Please also specify `--typescript-sdks-folder=`. + +``` yaml $(tag) == 'package-flexibleserver-2021-06' && $(typescript) +title: PostgreSQLManagementFlexibleServerClient +package-name: "@azure/arm-postgresql-flexible" +output-folder: "$(typescript-sdks-folder)/sdk/postgresql/arm-postgresql-flexible/" +``` + +### Tag: package-flexibleserver-2021-06-preview and TypeScript + +These settings apply only when `--tag=package-flexibleserver-2021-06-preview --typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(tag) == 'package-flexibleserver-2021-06-preview' && $(typescript) +title: PostgreSQLManagementFlexibleServerClient +package-name: "@azure/arm-postgresql-flexible" +output-folder: "$(typescript-sdks-folder)/sdk/postgresql/arm-postgresql-flexible/" +``` + +### Tag: package-2021-04-10-privatepreview and TypeScript + +These settings apply only when `--tag=package-2021-04-10-privatepreview --typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(tag) == 'package-2021-04-10-privatepreview' && $(typescript) +title: PostgreSQLManagementFlexibleServerClient +package-name: "@azure/arm-postgresql-flexible" +output-folder: "$(typescript-sdks-folder)/sdk/postgresql/arm-postgresql-flexible/" +``` + +### Tag: package-2021-03-31-privatepreview and TypeScript + +These settings apply only when `--tag=package-2021-03-31-privatepreview --typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(tag) == 'package-2021-03-31-privatepreview' && $(typescript) +title: PostgreSQLManagementFlexibleServerClient +package-name: "@azure/arm-postgresql-flexible" +output-folder: "$(typescript-sdks-folder)/sdk/postgresql/arm-postgresql-flexible/" +``` + +### Tag: package-2020-01-01 and TypeScript + +These settings apply only when `--tag=package-2020-01-01 --typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(tag) == 'package-2020-01-01' && $(typescript) +package-name: "@azure/arm-postgresql" +output-folder: "$(typescript-sdks-folder)/sdk/postgresql/arm-postgresql/" +``` diff --git a/specification/postgresqlhsc/resource-manager/readme.md b/specification/postgresqlhsc/resource-manager/readme.md index 8e79c4770cd5..27cc553e2200 100644 --- a/specification/postgresqlhsc/resource-manager/readme.md +++ b/specification/postgresqlhsc/resource-manager/readme.md @@ -51,7 +51,6 @@ This is not used by Autorest itself. ```yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/postgresqlhsc/resource-manager/readme.python.md b/specification/postgresqlhsc/resource-manager/readme.python.md index 17fb9703ec17..104b1d965801 100644 --- a/specification/postgresqlhsc/resource-manager/readme.python.md +++ b/specification/postgresqlhsc/resource-manager/readme.python.md @@ -4,22 +4,13 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml !$(track2) -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - package-name: azure-mgmt-rdbms - clear-output-folder: true - no-namespace-folders: true -``` - These settings apply only when `--track2` is specified on the command line. ``` yaml $(track2) azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-rdbms +package-version: 1.0.0b1 no-namespace-folders: true ``` @@ -27,11 +18,6 @@ no-namespace-folders: true Generate all API versions currently shipped for this package -```yaml !$(track2) -batch: - - tag: package-2020-10-05-privatepreview -``` - ```yaml $(track2) clear-output-folder: true batch: @@ -46,7 +32,4 @@ Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.powerbidedicated - package-name: azure-mgmt-powerbidedicated - package-version: 2.0.0 - clear-output-folder: true -``` -``` yaml $(python) && $(track2) -python-mode: create +``` yaml $(python) && $(track2 azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.powerbidedicated package-name: azure-mgmt-powerbidedicated -package-version: 2.0.0 +package-version: 1.0.0b1 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/powerbidedicated/azure-mgmt-powerbidedicated/azure/mgmt/powerbidedicated -``` -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/powerbidedicated/azure-mgmt-powerbidedicated -``` + ``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/powerbidedicated/azure-mgmt-powerbidedicated/azure/mgmt/powerbidedicated diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/account.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/account.json new file mode 100644 index 000000000000..36f8af84ed52 --- /dev/null +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/account.json @@ -0,0 +1,425 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-10-30-preview", + "title": "PowerPlatform" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerPlatform/accounts/{accountName}": { + "put": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_CreateOrUpdate", + "description": "Creates an account.", + "x-ms-examples": { + "Create or update account": { + "$ref": "./examples/createOrUpdateAccount.json" + } + }, + "parameters": [ + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the account." + }, + { + "$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" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Account" + }, + "description": "Parameters supplied to create or update an account." + } + ], + "responses": { + "201": { + "description": "Created. Account created.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "200": { + "description": "OK. Account updated.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": false, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "get": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_Get", + "description": "Get information about an account.", + "x-ms-examples": { + "Get account": { + "$ref": "./examples/getAccount.json" + } + }, + "parameters": [ + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the account." + }, + { + "$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": "OK. Account found.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_Delete", + "description": "Delete an account.", + "x-ms-examples": { + "Delete account": { + "$ref": "./examples/deleteAccount.json" + } + }, + "parameters": [ + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the account." + }, + { + "$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": "OK." + }, + "204": { + "description": "OK." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": false, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "patch": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_Update", + "description": "Updates an account.", + "x-ms-examples": { + "Update account": { + "$ref": "./examples/updateAccount.json" + } + }, + "parameters": [ + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the account." + }, + { + "$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" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PatchAccount" + }, + "description": "Parameters supplied to update an account." + } + ], + "responses": { + "200": { + "description": "OK. Account updated.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": false, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerPlatform/accounts": { + "get": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_ListByResourceGroup", + "description": "Retrieve a list of accounts within a given resource group.", + "x-ms-examples": { + "List accounts by resource group": { + "$ref": "./examples/listAccountsByResourceGroup.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": "OK. Accounts listed.", + "schema": { + "$ref": "#/definitions/AccountList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.PowerPlatform/accounts": { + "get": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_ListBySubscription", + "description": "Retrieve a list of accounts within a subscription.", + "x-ms-examples": { + "List accounts by subscription": { + "$ref": "./examples/listAccountsBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Accounts listed.", + "schema": { + "$ref": "#/definitions/AccountList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + } + }, + "definitions": { + "Account": { + "type": "object", + "description": "Definition of the account.", + "allOf": [ + { + "description": "The resource model definition for a ARM tracked top level resource.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AccountProperties", + "description": "The properties that define configuration for the account.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + } + } + }, + "PatchAccount": { + "type": "object", + "description": "Definition of the account.", + "allOf": [ + { + "description": "The resource model definition for a ARM tracked top level resource.", + "$ref": "../../common/v1/definitions.json#/definitions/PatchTrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AccountProperties", + "description": "The properties that define configuration for the account.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + } + } + }, + "AccountProperties": { + "type": "object", + "description": "The properties that define configuration for the account.", + "properties": { + "description": { + "type": "string", + "description": "The description of the account." + } + } + }, + "AccountList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Account" + }, + "description": "Result of the list accounts operation." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "The response of the list accounts operation." + } + }, + "parameters": {} +} diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json index 59fa3d128b77..454f59e04583 100644 --- a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json @@ -294,7 +294,7 @@ } }, "x-ms-pageable": { - "nextLinkName": null + "nextLinkName": "nextLink" }, "produces": [ "application/json" @@ -339,7 +339,7 @@ } }, "x-ms-pageable": { - "nextLinkName": null + "nextLinkName": "nextLink" }, "produces": [ "application/json" @@ -381,7 +381,7 @@ } }, "x-ms-pageable": { - "nextLinkName": null + "nextLinkName": "nextLink" }, "produces": [ "application/json" @@ -407,6 +407,10 @@ "$ref": "#/definitions/EnterprisePolicyIdentity", "description": "The identity of the EnterprisePolicy." }, + "kind": { + "$ref": "#/definitions/EnterprisePolicyKind", + "description": "The kind (type) of Enterprise Policy." + }, "properties": { "$ref": "#/definitions/Properties", "description": "The properties that define configuration for the enterprise policy", @@ -416,7 +420,10 @@ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", "description": "Metadata pertaining to creation and last modification of the resource." } - } + }, + "required": [ + "kind" + ] }, "PatchEnterprisePolicy": { "type": "object", @@ -432,6 +439,10 @@ "$ref": "#/definitions/EnterprisePolicyIdentity", "description": "The identity of the EnterprisePolicy." }, + "kind": { + "$ref": "#/definitions/EnterprisePolicyKind", + "description": "The kind (type) of Enterprise Policy." + }, "properties": { "$ref": "#/definitions/Properties", "description": "The properties that define configuration for the enterprise policy", @@ -524,6 +535,20 @@ "NotConfigured" ] }, + "EnterprisePolicyKind": { + "type": "string", + "description": "The Kind (type) of Enterprise Policy", + "x-ms-enum": { + "name": "EnterprisePolicyKind", + "modelAsString": true + }, + "enum": [ + "Lockbox", + "PrivateEndpoint", + "Encryption", + "NetworkInjection" + ] + }, "KeyVaultProperties": { "type": "object", "description": "Settings concerning key vault encryption for a configuration store.", @@ -539,6 +564,7 @@ } }, "keyProperties": { + "type": "object", "properties": { "name": { "description": "The identifier of the key vault key used to encrypt data.", @@ -559,6 +585,10 @@ "items": { "$ref": "#/definitions/VirtualNetworkProperties" } + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." } }, "description": "A list of private link resources" @@ -588,6 +618,7 @@ } }, "EnterprisePolicyList": { + "type": "object", "properties": { "value": { "type": "array", @@ -595,6 +626,10 @@ "$ref": "#/definitions/EnterprisePolicy" }, "description": "Result of the list EnterprisePolicy operation." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." } }, "description": "The response of the list EnterprisePolicy operation." diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/createOrUpdateAccount.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/createOrUpdateAccount.json new file mode 100644 index 000000000000..cd618266e968 --- /dev/null +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/createOrUpdateAccount.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "resourceGroup", + "api-version": "2020-10-30-preview", + "accountName": "account", + "parameters": { + "tags": { + "Organization": "Administration" + }, + "location": "East US", + "properties": { + "description": "Description of the account." + } + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "name": "account", + "id": "/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.PowerPlatform/accounts/account", + "type": "Microsoft.PowerPlatform/accounts", + "location": "East US", + "properties": { + "description": "Description of the account." + }, + "tags": { + "Organization": "Administration" + } + } + }, + "200": { + "headers": {}, + "body": { + "name": "account", + "id": "/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.PowerPlatform/accounts/account", + "type": "Microsoft.PowerPlatform/accounts", + "location": "East US", + "properties": { + "description": "Description of the account." + }, + "tags": { + "Organization": "Administration" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + } + } + } + } +} diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/createOrUpdateEnterprisePolicy.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/createOrUpdateEnterprisePolicy.json index 6d940ca9b32f..d0c7021e14de 100644 --- a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/createOrUpdateEnterprisePolicy.json +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/createOrUpdateEnterprisePolicy.json @@ -11,7 +11,8 @@ "identity": { "type": "SystemAssigned" }, - "location": "East US" + "location": "East US", + "kind": "Lockbox" } }, "responses": { @@ -22,6 +23,7 @@ "id": "/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.PowerPlatform/enterprisePolicies/enterprisePolicy", "type": "Microsoft.PowerPlatform/enterprisePolicies", "location": "East US", + "kind": "Lockbox", "tags": { "Organization": "Administration" }, @@ -39,6 +41,7 @@ "id": "/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.PowerPlatform/enterprisePolicies/enterprisePolicy", "type": "Microsoft.PowerPlatform/enterprisePolicies", "location": "East US", + "kind": "Lockbox", "tags": { "Organization": "Administration" }, diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/deleteAccount.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/deleteAccount.json new file mode 100644 index 000000000000..052126de8273 --- /dev/null +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/deleteAccount.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "resourceGroup", + "accountName": "account", + "api-version": "2020-10-30-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/getAccount.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/getAccount.json new file mode 100644 index 000000000000..d638ae93ac18 --- /dev/null +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/getAccount.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "accountName": "account", + "api-version": "2020-10-30-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "account", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.PowerPlatform/accounts/account", + "type": "Microsoft.PowerPlatform/accounts", + "location": "East US", + "properties": { + "description": "Description of the account." + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + } + } + } + } +} diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/getEnterprisePolicy.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/getEnterprisePolicy.json index 2adac882e965..514bfb9a013b 100644 --- a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/getEnterprisePolicy.json +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/getEnterprisePolicy.json @@ -13,6 +13,7 @@ "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.PowerPlatform/enterprisePolicies/enterprisePolicy", "type": "Microsoft.PowerPlatform/enterprisePolicies", "location": "East US", + "kind": "Lockbox", "identity": { "systemAssignedIdentityPrincipalId": "principalId", "tenantId": "tenantId", @@ -22,6 +23,15 @@ "lockbox": { "state": "succeeded" }, + "encryption": { + "keyVault": { + "id": "nnn", + "key": { + "name": "name", + "version": "1.0" + } + } + }, "networkInjection": { "virtualNetworks": [ { diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listAccountsByResourceGroup.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listAccountsByResourceGroup.json new file mode 100644 index 000000000000..12c97183089f --- /dev/null +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listAccountsByResourceGroup.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "api-version": "2020-10-30-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "account1", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.PowerPlatform/accounts/account1", + "type": "Microsoft.PowerPlatform/accounts", + "location": "East US", + "properties": { + "description": "Description of account 1." + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + } + }, + { + "name": "account2", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.PowerPlatform/accounts/account2", + "type": "Microsoft.PowerPlatform/accounts", + "location": "East US", + "properties": { + "description": "Description of account 2." + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + } + } + ] + } + } + } +} diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listAccountsBySubscription.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listAccountsBySubscription.json new file mode 100644 index 000000000000..4189288bc642 --- /dev/null +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listAccountsBySubscription.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2020-10-30-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "account1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.PowerPlatform/accounts/account1", + "type": "Microsoft.PowerPlatform/accounts", + "location": "East US", + "properties": { + "description": "Description of account 1." + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + } + }, + { + "name": "account2", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.PowerPlatform/accounts/account2", + "type": "Microsoft.PowerPlatform/accounts", + "location": "East US", + "properties": { + "description": "Description of account 2." + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + } + } + ] + } + } + } +} diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listEnterprisePoliciesByResourceGroup.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listEnterprisePoliciesByResourceGroup.json index f43fa493ae1c..cb8fdfc55bc0 100644 --- a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listEnterprisePoliciesByResourceGroup.json +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listEnterprisePoliciesByResourceGroup.json @@ -1,56 +1,56 @@ { "parameters": { "subscriptionId": "subid", - "resourceGroupName": "rg", + "resourceGroupName": "rg1", "api-version": "2020-10-30-preview" }, "responses": { "200": { "headers": {}, - "body": [ - { - "name": "entrprisePolicy1", - "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.PowerPlatform/enterprisePolicies/enterprisePolicy1", - "type": "Microsoft.PowerPlatform/enterprisePolicies", - "location": "East US", - "properties": { + "body": { + "value": [ + { + "name": "enterprisePolicy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.PowerPlatform/enterprisePolicies/enterprisePolicy1", + "type": "Microsoft.PowerPlatform/enterprisePolicies", + "location": "East US", + "kind": "Lockbox", "identity": { "systemAssignedIdentityPrincipalId": "principalId", "tenantId": "tenantId", "type": "SystemAssigned" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" } }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - } - }, - { - "name": "enterprisePolicy2", - "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.PowerPlatform/enterprisePolicies/enterprisePolicy2", - "type": "Microsoft.PowerPlatform/enterprisePolicies", - "location": "East US", - "properties": { + { + "name": "enterprisePolicy2", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.PowerPlatform/enterprisePolicies/enterprisePolicy2", + "type": "Microsoft.PowerPlatform/enterprisePolicies", + "location": "East US", + "kind": "Lockbox", "identity": { "systemAssignedIdentityPrincipalId": "principalId", "tenantId": "tenantId", "type": "SystemAssigned" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" } - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" } - } - ] + ] + } } } } diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listEnterprisePoliciesBySubscription.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listEnterprisePoliciesBySubscription.json index 100d68113d74..b82ce187d8d2 100644 --- a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listEnterprisePoliciesBySubscription.json +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listEnterprisePoliciesBySubscription.json @@ -6,46 +6,50 @@ "responses": { "200": { "headers": {}, - "body": [ - { - "name": "enterprisePolicy1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.PowerPlatform/enterprisePolicies/enterprisePolicy1", - "type": "Microsoft.PowerPlatform/enterprisePolicies", - "location": "East US", - "identity": { - "systemAssignedIdentityPrincipalId": "principalId", - "tenantId": "tenantId", - "type": "SystemAssigned" + "body": { + "value": [ + { + "name": "enterprisePolicy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.PowerPlatform/enterprisePolicies/enterprisePolicy1", + "type": "Microsoft.PowerPlatform/enterprisePolicies", + "location": "East US", + "kind": "Lockbox", + "identity": { + "systemAssignedIdentityPrincipalId": "principalId", + "tenantId": "tenantId", + "type": "SystemAssigned" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + } }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + { + "name": "enterprisePolicy2", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.PowerPlatform/enterprisePolicies/enterprisePolicy2", + "type": "Microsoft.PowerPlatform/enterprisePolicies", + "location": "East US", + "kind": "Lockbox", + "identity": { + "systemAssignedIdentityPrincipalId": "principalId", + "tenantId": "tenantId", + "type": "SystemAssigned" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + } } - }, - { - "name": "enterprisePolicy2", - "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.PowerPlatform/enterprisePolicies/enterprisePolicy2", - "type": "Microsoft.PowerPlatform/enterprisePolicies", - "location": "East US", - "identity": { - "systemAssignedIdentityPrincipalId": "principalId", - "tenantId": "tenantId", - "type": "SystemAssigned" - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - } - } - ] + ] + } } } } diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listOperations.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listOperations.json index 0d19fa2a6b78..538d8b189e5a 100644 --- a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listOperations.json +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listOperations.json @@ -26,6 +26,26 @@ "operation": "Microsoft.PowerPlatform/enterprisePolicies/read", "description": "Get enterprisePolicy." } + }, + { + "name": "Microsoft.PowerPlatform/accounts/write", + "isDataAction": false, + "display": { + "provider": "Microsoft PowerPlatform", + "resource": "Microsoft.PowerPlatform/accounts", + "operation": "Microsoft.PowerPlatform/accounts/write", + "description": "Create new account." + } + }, + { + "name": "Microsoft.PowerPlatform/accounts/read", + "isDataAction": false, + "display": { + "provider": "Microsoft PowerPlatform", + "resource": "Microsoft.PowerPlatform/accounts", + "operation": "Microsoft.PowerPlatform/accounts/read", + "description": "Get account." + } } ] } diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/updateAccount.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/updateAccount.json new file mode 100644 index 000000000000..b7f659838eed --- /dev/null +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/updateAccount.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "resourceGroup", + "accountName": "account", + "api-version": "2020-10-30-preview", + "parameters": { + "tags": { + "Organization": "Administration" + }, + "location": "East US", + "properties": { + "description": "Description of account." + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "account", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.PowerPlatform/accounts/account", + "type": "Microsoft.PowerPlatform/accounts", + "location": "East US", + "properties": { + "description": "Description of account." + }, + "tags": { + "Organization": "Administration" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + } + } + } + } +} diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/updateEnterprisePolicy.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/updateEnterprisePolicy.json index a9d9caf02a13..a3453879f58a 100644 --- a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/updateEnterprisePolicy.json +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/updateEnterprisePolicy.json @@ -22,6 +22,7 @@ "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.PowerPlatform/enterprisePolicies/enterprisePolicy", "type": "Microsoft.PowerPlatform/enterprisePolicies", "location": "East US", + "kind": "Lockbox", "tags": { "Organization": "Administration" }, diff --git a/specification/powerplatform/resource-manager/readme.md b/specification/powerplatform/resource-manager/readme.md index 55bff0784649..6da6ba067739 100644 --- a/specification/powerplatform/resource-manager/readme.md +++ b/specification/powerplatform/resource-manager/readme.md @@ -35,6 +35,7 @@ These settings apply only when `--tag=package-2020-10-30-preview` is specified o ```yaml $(tag) == 'package-2020-10-30-preview' input-file: + - Microsoft.PowerPlatform/preview/2020-10-30-preview/account.json - Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json - Microsoft.PowerPlatform/preview/2020-10-30-preview/privateEndpointConnection.json - Microsoft.PowerPlatform/preview/2020-10-30-preview/privateLinkResources.json diff --git a/specification/privatedns/resource-manager/readme.go.md b/specification/privatedns/resource-manager/readme.go.md index 330ed7581ed4..5496064f88d3 100644 --- a/specification/privatedns/resource-manager/readme.go.md +++ b/specification/privatedns/resource-manager/readme.go.md @@ -2,16 +2,24 @@ These settings apply only when `--go` is specified on the command line. -``` yaml $(go) +``` yaml $(go) && !$(track2) go: license-header: MICROSOFT_MIT_NO_VERSION namespace: privatedns clear-output-folder: true ``` +``` yaml $(go) && $(track2) +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/privatedns/armprivatedns +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) +``` yaml $(go) && $(multiapi) batch: - tag: package-2018-09 ``` diff --git a/specification/privatedns/resource-manager/readme.md b/specification/privatedns/resource-manager/readme.md index d2bf528d5cbc..531b5698caca 100644 --- a/specification/privatedns/resource-manager/readme.md +++ b/specification/privatedns/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the Private DNS API. ``` yaml openapi-type: arm -tag: package-2018-09 +tag: package-2020-06 ``` ### Tag: package-2018-09 @@ -38,11 +38,6 @@ input-file: - Microsoft.Network/stable/2018-09-01/privatedns.json ``` -``` yaml -openapi-type: arm -tag: package-2020-01 -``` - ### Tag: package-2020-01 These settings apply only when `--tag=package-2020-01` is specified on the command line. @@ -52,11 +47,6 @@ input-file: - Microsoft.Network/stable/2020-01-01/privatedns.json ``` -``` yaml -openapi-type: arm -tag: package-2020-06 -``` - ### Tag: package-2020-06 These settings apply only when `--tag=package-2020-06` is specified on the command line. @@ -76,7 +66,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/privatedns/resource-manager/readme.python.md b/specification/privatedns/resource-manager/readme.python.md index e33f11bd20b0..c0aa35eab68b 100644 --- a/specification/privatedns/resource-manager/readme.python.md +++ b/specification/privatedns/resource-manager/readme.python.md @@ -4,36 +4,17 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.privatedns - package-name: azure-mgmt-privatedns - package-version: 1.0.0 - clear-output-folder: true -``` + ``` yaml $(python) && $(track2) python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.privatedns package-name: azure-mgmt-privatedns -package-version: 1.0.0 +package-version: 1.0.0b1 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/network/azure-mgmt-privatedns/azure/mgmt/privatedns -``` -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/network/azure-mgmt-privatedns -``` + ``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/network/azure-mgmt-privatedns/azure/mgmt/privatedns diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/CheckinManifest.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/CheckinManifest.json new file mode 100644 index 000000000000..d3f48a1f69de --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/CheckinManifest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview", + "checkinManifestParams": { + "baselineArmManifestLocation": "EastUS2EUAP", + "environment": "Prod" + } + }, + "responses": { + "200": { + "description": "Checkin the manifest.", + "body": { + "isCheckedIn": false, + "statusMessage": "Manifest is successfully merged. Use the Default/Custom rollout (http://aka.ms/rpaasrollout) to roll out the manifest in ARM." + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/CustomRollouts_CreateOrUpdate.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/CustomRollouts_CreateOrUpdate.json new file mode 100644 index 000000000000..4e84f85d13cd --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/CustomRollouts_CreateOrUpdate.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "rolloutName": "brazilUsShoeBoxTesting", + "api-version": "2021-06-01-preview", + "properties": { + "properties": { + "specification": { + "canary": { + "regions": [ + "brazilus" + ] + } + } + } + } + }, + "responses": { + "200": { + "description": "Custom rollout completed successfully.", + "body": { + "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/customRollouts/brazilUsShoeBoxTesting", + "name": "Microsoft.Contoso/brazilUsShoeBoxTesting", + "type": "Microsoft.ProviderHub/providerRegistrations/customRollouts", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "properties": { + "provisioningState": "Succeeded", + "specification": { + "canary": { + "regions": [ + "brazilus", + "eastus2euap", + "centraluseuap" + ] + } + }, + "status": { + "completedRegions": [ + "brazilus", + "eastus2euap", + "centraluseuap" + ] + } + } + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/CustomRollouts_Get.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/CustomRollouts_Get.json new file mode 100644 index 000000000000..3fe51c5d4ab8 --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/CustomRollouts_Get.json @@ -0,0 +1,135 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "rolloutName": "canaryTesting99", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "description": "Successfully retrieved the rollout details.", + "body": { + "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/customRollouts/canaryTesting99", + "name": "Microsoft.Contoso/canaryTesting99", + "type": "Microsoft.ProviderHub/providerRegistrations/customRollouts", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "properties": { + "provisioningState": "Completed", + "specification": { + "canary": { + "regions": [ + "eastus2euap", + "centraluseuap" + ] + }, + "providerRegistration": { + "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso", + "name": "Microsoft.Contoso", + "type": "Microsoft.ProviderHub/providerRegistrations", + "properties": { + "providerHubMetadata": { + "providerAuthentication": { + "allowedAudiences": [ + "https://management.core.windows.net/" + ] + } + }, + "provisioningState": "Succeeded", + "providerAuthorizations": [ + { + "applicationId": "1a3b5c7d-8e9f-10g1-1h12-i13j14k1", + "roleDefinitionId": "123456bf-gkur-2098-b890-98da392a00b2" + } + ], + "namespace": "microsoft.contoso", + "providerVersion": "2.0", + "providerType": "Internal, Hidden", + "management": { + "manifestOwners": [ + "SPARTA-PlatformServiceAdministrator" + ], + "incidentRoutingService": "", + "incidentRoutingTeam": "", + "incidentContactEmail": "helpme@contoso.com", + "resourceAccessPolicy": "NotSpecified" + }, + "capabilities": [ + { + "quotaId": "CSP_2015-05-01", + "effect": "Allow" + }, + { + "quotaId": "CSP_MG_2017-12-01", + "effect": "Allow" + } + ], + "metadata": null + } + }, + "resourceTypeRegistrations": [ + { + "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/resourceTypeRegistrations/employees", + "name": "Microsoft.Contoso/employees", + "type": "Microsoft.ProviderHub/providerRegistrations/resourceTypeRegistrations", + "properties": { + "routingType": "Default", + "regionality": "Regional", + "endpoints": [ + { + "apiVersions": [ + "2018-11-01-preview", + "2020-01-01-preview", + "2019-01-01" + ], + "locations": [ + "East Asia", + "East US", + "North Europe", + "Southeast Asia", + "East US 2 EUAP", + "Central US EUAP", + "West Europe", + "West US", + "West Central US", + "West US 2" + ], + "requiredFeatures": [ + "Microsoft.Contoso/RPaaSSampleApp" + ] + } + ], + "swaggerSpecifications": [ + { + "apiVersions": [ + "2018-11-01-preview", + "2020-01-01-preview", + "2019-01-01" + ], + "swaggerSpecFolderUri": "https://github.com/Azure/azure-rest-api-specs/blob/feature/azure/contoso/specification/contoso/resource-manager/Microsoft.SampleRP/" + } + ], + "enableAsyncOperation": false, + "provisioningState": "Succeeded", + "enableThirdPartyS2S": false + } + } + ] + }, + "status": { + "completedRegions": [ + "eastus2euap", + "centraluseuap" + ] + } + } + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/CustomRollouts_ListByProviderRegistration.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/CustomRollouts_ListByProviderRegistration.json new file mode 100644 index 000000000000..a1ddcbd2f76d --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/CustomRollouts_ListByProviderRegistration.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "description": "List of custom rollouts for given subscription id.", + "body": { + "value": [ + { + "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/customRollouts/canaryTesting99", + "name": "Microsoft.Contoso/canaryTesting99", + "type": "Microsoft.ProviderHub/providerRegistrations/customRollouts", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "properties": { + "provisioningState": "Succeeded", + "specification": { + "canary": { + "regions": [ + "eastus2euap", + "centraluseuap" + ] + } + }, + "status": { + "completedRegions": [ + "eastus2euap", + "centraluseuap" + ] + } + } + }, + { + "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/customRollouts/brazilustesting", + "name": "Microsoft.Contoso/brazilustesting", + "type": "Microsoft.ProviderHub/providerRegistrations/customRollouts", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "properties": { + "provisioningState": "Failed", + "specification": { + "canary": { + "regions": [ + "brazilus" + ] + } + }, + "status": { + "failedOrSkippedRegions": { + "brazilus": { + "code": "RolloutTimedout", + "message": "Failed to rollout to specified region." + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/DefaultRollouts_CreateOrUpdate.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/DefaultRollouts_CreateOrUpdate.json new file mode 100644 index 000000000000..52a3ddfb802d --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/DefaultRollouts_CreateOrUpdate.json @@ -0,0 +1,183 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "rolloutName": "2020week10", + "api-version": "2021-06-01-preview", + "properties": { + "properties": { + "specification": { + "expeditedRollout": { + "enabled": true + }, + "canary": { + "skipRegions": [ + "eastus2euap" + ] + }, + "restOfTheWorldGroupTwo": { + "waitDuration": "PT4H" + } + } + } + } + }, + "responses": { + "201": { + "description": "Default rollout started successfully.", + "headers": { + "location": "https://management.azure.com/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/operationStauses/11111111-f7ef-471a-a2f4-d0ebbf494f77", + "retry-after": "5000" + }, + "body": { + "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/defaultRollouts/2020week10", + "name": "Microsoft.Contoso/2020week10", + "type": "Microsoft.ProviderHub/providerRegistrations/defaultRollouts", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "properties": { + "provisioningState": "RolloutInProgress", + "specification": { + "canary": { + "regions": [ + "brazilus", + "eastus2euap", + "centraluseuap" + ], + "skipRegions": [ + "brazilus" + ] + }, + "lowTraffic": { + "regions": [ + "southeastasia" + ], + "waitDuration": "PT24H" + }, + "mediumTraffic": { + "regions": [ + "uksouth", + "indiawest" + ], + "waitDuration": "PT24H" + }, + "highTraffic": { + "regions": [ + "australiasoutheast", + "otherhightraficregions" + ], + "waitDuration": "PT24H" + }, + "restOfTheWorldGroupOne": { + "regions": [ + "koreacentral", + "francecentral", + "australiacentral", + "westus", + "allotherregions" + ], + "waitDuration": "PT4H" + }, + "restOfTheWorldGroupTwo": { + "regions": [ + "germanynorth", + "norwayeast", + "allotherregions" + ], + "waitDuration": "PT4H" + } + }, + "status": { + "completedRegions": [ + "brazilus", + "eastus2euap", + "centraluseuap" + ], + "nextTrafficRegion": "LowTraffic", + "nextTrafficRegionScheduledTime": "2020-03-03T22:00:00Z" + } + } + } + }, + "200": { + "description": "Default rollout updated successfully.", + "body": { + "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/defaultRollouts/2020week10", + "name": "Microsoft.Contoso/2020week10", + "type": "Microsoft.ProviderHub/providerRegistrations/defaultRollouts", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "properties": { + "provisioningState": "RolloutInProgress", + "specification": { + "canary": { + "regions": [ + "brazilus", + "eastus2euap", + "centraluseuap" + ] + }, + "lowTraffic": { + "regions": [ + "southeastasia" + ], + "waitDuration": "PT24H" + }, + "mediumTraffic": { + "regions": [ + "uksouth", + "indiawest" + ], + "waitDuration": "PT24H" + }, + "highTraffic": { + "regions": [ + "australiasoutheast", + "otherhightraficregions" + ], + "waitDuration": "PT24H" + }, + "restOfTheWorldGroupOne": { + "regions": [ + "koreacentral", + "francecentral", + "australiacentral", + "westus", + "allotherregions" + ], + "waitDuration": "PT4H" + }, + "restOfTheWorldGroupTwo": { + "regions": [ + "germanynorth", + "norwayeast", + "allotherregions" + ], + "waitDuration": "PT4H" + } + }, + "status": { + "completedRegions": [ + "brazilus", + "eastus2euap", + "centraluseuap", + "allcompletedregions" + ] + } + } + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/DefaultRollouts_Delete.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/DefaultRollouts_Delete.json new file mode 100644 index 000000000000..65d960936e18 --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/DefaultRollouts_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "rolloutName": "2020week10", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "description": "Rollout deleted successfully." + }, + "204": { + "description": "No content." + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/DefaultRollouts_Get.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/DefaultRollouts_Get.json new file mode 100644 index 000000000000..5d8fa9aeb239 --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/DefaultRollouts_Get.json @@ -0,0 +1,188 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "rolloutName": "2020week10", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "description": "Default rollout resource.", + "body": { + "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/defaultRollouts/2020week10", + "name": "Microsoft.Contoso/2020week10", + "type": "Microsoft.ProviderHub/providerRegistrations/defaultRollouts", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "properties": { + "provisioningState": "Cancelled", + "specification": { + "expeditedRollout": { + "enabled": true + }, + "canary": { + "regions": [ + "eastus2euap", + "centraluseuap" + ], + "skipRegions": [ + "brazilus" + ] + }, + "lowTraffic": { + "regions": [ + "southeastasia" + ], + "waitDuration": "PT24H" + }, + "mediumTraffic": { + "regions": [ + "uksouth", + "indiawest" + ], + "waitDuration": "PT24H" + }, + "highTraffic": { + "regions": [ + "australiasoutheast", + "otherhightraficregions" + ], + "waitDuration": "PT24H" + }, + "restOfTheWorldGroupOne": { + "regions": [ + "koreacentral", + "francecentral", + "australiacentral", + "westus", + "allotherregions" + ], + "waitDuration": "PT4H" + }, + "restOfTheWorldGroupTwo": { + "regions": [ + "germanynorth", + "norwayeast", + "allotherregions" + ], + "waitDuration": "PT4H" + }, + "providerRegistration": { + "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso", + "name": "Microsoft.Contoso", + "type": "Microsoft.ProviderHub/providerRegistrations", + "properties": { + "providerHubMetadata": { + "providerAuthentication": { + "allowedAudiences": [ + "https://management.core.windows.net/" + ] + } + }, + "provisioningState": "Succeeded", + "providerAuthorizations": [ + { + "applicationId": "1a3b5c7d-8e9f-10g1-1h12-i13j14k1", + "roleDefinitionId": "123456bf-gkur-2098-b890-98da392a00b2" + } + ], + "namespace": "microsoft.contoso", + "providerVersion": "2.0", + "providerType": "Internal, Hidden", + "management": { + "manifestOwners": [ + "SPARTA-PlatformServiceAdministrator" + ], + "incidentRoutingService": "", + "incidentRoutingTeam": "", + "incidentContactEmail": "helpme@contoso.com", + "resourceAccessPolicy": "NotSpecified" + }, + "capabilities": [ + { + "quotaId": "CSP_2015-05-01", + "effect": "Allow" + }, + { + "quotaId": "CSP_MG_2017-12-01", + "effect": "Allow" + } + ], + "metadata": null + } + }, + "resourceTypeRegistrations": [ + { + "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/resourceTypeRegistrations/employees", + "name": "Microsoft.Contoso/employees", + "type": "Microsoft.ProviderHub/providerRegistrations/resourceTypeRegistrations", + "properties": { + "routingType": "Default", + "regionality": "Regional", + "endpoints": [ + { + "apiVersions": [ + "2018-11-01-preview", + "2020-01-01-preview", + "2019-01-01" + ], + "locations": [ + "East Asia", + "East US", + "North Europe", + "Southeast Asia", + "East US 2 EUAP", + "Central US EUAP", + "West Europe", + "West US", + "West Central US", + "West US 2" + ], + "requiredFeatures": [ + "Microsoft.Contoso/RPaaSSampleApp" + ] + } + ], + "swaggerSpecifications": [ + { + "apiVersions": [ + "2018-11-01-preview", + "2020-01-01-preview", + "2019-01-01" + ], + "swaggerSpecFolderUri": "https://github.com/Azure/azure-rest-api-specs/blob/feature/azure/contoso/specification/contoso/resource-manager/Microsoft.SampleRP/" + } + ], + "enableAsyncOperation": false, + "provisioningState": "Succeeded", + "enableThirdPartyS2S": false + } + } + ] + }, + "status": { + "completedRegions": [ + "brazilus", + "eastus2euap", + "centraluseuap", + "allcompletedregions" + ], + "failedOrSkippedRegions": { + "westus2": { + "code": "RolloutStoppedByUser", + "message": "Rollout was explicitly stopped by the user." + } + }, + "subscriptionReregistrationResult": "ConditionalUpdate" + } + } + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/DefaultRollouts_ListByProviderRegistration.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/DefaultRollouts_ListByProviderRegistration.json new file mode 100644 index 000000000000..7ab210079c9a --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/DefaultRollouts_ListByProviderRegistration.json @@ -0,0 +1,167 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "description": "List of default rollouts for given subscription id.", + "body": { + "value": [ + { + "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/defaultRollouts/2020week01", + "name": "Microsoft.Contoso/2020week01", + "type": "Microsoft.ProviderHub/providerRegistrations/defaultRollouts", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "properties": { + "provisioningState": "Succeeded", + "specification": { + "expeditedRollout": { + "enabled": true + }, + "canary": { + "regions": [ + "brazilus", + "eastus2euap", + "centraluseuap" + ] + }, + "lowTraffic": { + "regions": [ + "southeastasia" + ], + "waitDuration": "PT24H" + }, + "mediumTraffic": { + "regions": [ + "uksouth", + "indiawest" + ], + "waitDuration": "PT24H" + }, + "highTraffic": { + "regions": [ + "australiasoutheast", + "otherhightraficregions" + ], + "waitDuration": "PT24H" + }, + "restOfTheWorldGroupOne": { + "regions": [ + "koreacentral", + "francecentral", + "australiacentral", + "westus", + "allotherregions" + ], + "waitDuration": "PT4H" + }, + "restOfTheWorldGroupTwo": { + "regions": [ + "germanynorth", + "norwayeast", + "allotherregions" + ], + "waitDuration": "PT4H" + } + }, + "status": { + "completedRegions": [ + "brazilus", + "eastus2euap", + "centraluseuap", + "allcompletedregions" + ] + } + } + }, + { + "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/defaultRollouts/2020week10", + "name": "Microsoft.Contoso/2020week10", + "type": "Microsoft.ProviderHub/providerRegistrations/defaultRollouts", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "properties": { + "provisioningState": "Cancelled", + "specification": { + "canary": { + "regions": [ + "brazilus", + "eastus2euap", + "centraluseuap" + ] + }, + "lowTraffic": { + "regions": [ + "southeastasia" + ], + "waitDuration": "PT24H" + }, + "mediumTraffic": { + "regions": [ + "uksouth", + "indiawest" + ], + "waitDuration": "PT24H" + }, + "highTraffic": { + "regions": [ + "australiasoutheast", + "otherhightraficregions" + ], + "waitDuration": "PT24H" + }, + "restOfTheWorldGroupOne": { + "regions": [ + "koreacentral", + "francecentral", + "australiacentral", + "westus", + "allotherregions" + ], + "waitDuration": "PT4H" + }, + "restOfTheWorldGroupTwo": { + "regions": [ + "germanynorth", + "norwayeast", + "allotherregions" + ], + "waitDuration": "PT4H" + } + }, + "status": { + "completedRegions": [ + "brazilus", + "eastus2euap", + "centraluseuap", + "allcompletedregions" + ], + "failedOrSkippedRegions": { + "westus2": { + "code": "RolloutStoppedByUser", + "message": "Rollout was explicitly stopped by the user." + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/DefaultRollouts_Stop.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/DefaultRollouts_Stop.json new file mode 100644 index 000000000000..d32529688fa7 --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/DefaultRollouts_Stop.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "rolloutName": "2020week10", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "description": "The rollout is stopped successfully." + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/GenerateManifest.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/GenerateManifest.json new file mode 100644 index 000000000000..3144d33f427b --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/GenerateManifest.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "description": "Generates the manifest for the given provider.", + "body": { + "providerAuthorizations": [ + { + "applicationId": "1a3b5c7d-8e9f-10g1-1h12-i13j14k1", + "roleDefinitionId": "123456bf-gkur-2098-b890-98da392a00b2" + } + ], + "namespace": "microsoft.contoso", + "providerVersion": "2.0", + "providerType": "Internal, Hidden", + "resourceTypes": [ + { + "name": "Operations", + "routingType": "ProxyOnly, Tenant", + "resourceValidation": "ReservedWords, ProfaneWords", + "allowedUnauthorizedActions": [ + "microsoft.contoso/operations/read" + ], + "endpoints": [ + { + "apiVersions": [ + "2020-01-01-preview" + ], + "endpointUri": "https://resource-endpoint.com/", + "locations": [ + "" + ], + "timeout": "PT20S" + } + ], + "linkedOperationRules": [] + }, + { + "name": "Locations", + "routingType": "ProxyOnly", + "resourceValidation": "ReservedWords, ProfaneWords", + "endpoints": [ + { + "apiVersions": [ + "2020-01-01-preview" + ], + "endpointUri": "https://resource-endpoint.com/", + "locations": [ + "" + ], + "timeout": "PT20S" + } + ], + "linkedOperationRules": [] + } + ], + "management": { + "manifestOwners": [ + "manifestOwners-group" + ], + "incidentRoutingService": "", + "incidentRoutingTeam": "", + "incidentContactEmail": "helpme@contoso.com", + "resourceAccessPolicy": "NotSpecified" + }, + "capabilities": [ + { + "quotaId": "CSP_2015-05-01", + "effect": "Allow" + }, + { + "quotaId": "CSP_MG_2017-12-01", + "effect": "Allow" + } + ], + "metadata": { + "onboardedVia": "ProviderHub" + }, + "globalNotificationEndpoints": [ + { + "enabled": true, + "endpointUri": "https://notificationendpoint.com" + } + ], + "reRegisterSubscriptionMetadata": { + "enabled": true, + "concurrencyLimit": 100 + } + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/NotificationRegistrations_CreateOrUpdate.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/NotificationRegistrations_CreateOrUpdate.json new file mode 100644 index 000000000000..62897789a7c9 --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/NotificationRegistrations_CreateOrUpdate.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview", + "notificationRegistrationName": "fooNotificationRegistration", + "properties": { + "properties": { + "notificationMode": "EventHub", + "messageScope": "RegisteredSubscriptions", + "includedEvents": [ + "*/write", + "Microsoft.Contoso/employees/delete" + ], + "notificationEndpoints": [ + { + "locations": [ + "", + "East US" + ], + "notificationDestination": "/subscriptions/ac6bcfb5-3dc1-491f-95a6-646b89bf3e88/resourceGroups/mgmtexp-eastus/providers/Microsoft.EventHub/namespaces/unitedstates-mgmtexpint/eventhubs/armlinkednotifications" + }, + { + "locations": [ + "North Europe" + ], + "notificationDestination": "/subscriptions/ac6bcfb5-3dc1-491f-95a6-646b89bf3e88/resourceGroups/mgmtexp-northeurope/providers/Microsoft.EventHub/namespaces/europe-mgmtexpint/eventhubs/armlinkednotifications" + } + ] + } + } + }, + "responses": { + "200": { + "description": "Gets the notification registration details.", + "body": { + "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/notificationregistrations/fooNotificationRegistration", + "type": "Microsoft.ProviderHub/providerRegistrations/notificationregistrations", + "name": "fooNotificationRegistration", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "properties": { + "notificationMode": "EventHub", + "messageScope": "RegisteredSubscriptions", + "includedEvents": [ + "*/write", + "Microsoft.Contoso/employees/delete" + ], + "notificationEndpoints": [ + { + "locations": [ + "", + "East US" + ], + "notificationDestination": "/subscriptions/ac6bcfb5-3dc1-491f-95a6-646b89bf3e88/resourceGroups/mgmtexp-eastus/providers/Microsoft.EventHub/namespaces/unitedstates-mgmtexpint/eventhubs/armlinkednotifications" + }, + { + "locations": [ + "North Europe" + ], + "notificationDestination": "/subscriptions/ac6bcfb5-3dc1-491f-95a6-646b89bf3e88/resourceGroups/mgmtexp-northeurope/providers/Microsoft.EventHub/namespaces/europe-mgmtexpint/eventhubs/armlinkednotifications" + } + ] + } + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/NotificationRegistrations_Delete.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/NotificationRegistrations_Delete.json new file mode 100644 index 000000000000..0f709cfb9e31 --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/NotificationRegistrations_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview", + "notificationRegistrationName": "fooNotificationRegistration" + }, + "responses": { + "200": { + "description": "Successfully deleted the notification registration." + }, + "204": { + "description": "Resource does not exist." + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/NotificationRegistrations_Get.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/NotificationRegistrations_Get.json new file mode 100644 index 000000000000..7cba399a6ebd --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/NotificationRegistrations_Get.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview", + "notificationRegistrationName": "fooNotificationRegistration" + }, + "responses": { + "200": { + "description": "Gets the notification registration details.", + "body": { + "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/notificationregistrations/fooNotificationRegistration", + "type": "Microsoft.ProviderHub/providerRegistrations/notificationregistrations", + "name": "fooNotificationRegistration", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "properties": { + "notificationMode": "EventHub", + "messageScope": "RegisteredSubscriptions", + "includedEvents": [ + "*/write", + "Microsoft.Contoso/employees/delete" + ], + "notificationEndpoints": [ + { + "notificationDestination": "/subscriptions/ac6bcfb5-3dc1-491f-95a6-646b89bf3e88/resourceGroups/mgmtexp-eastus/providers/Microsoft.EventHub/namespaces/unitedstates-mgmtexpint/eventhubs/armlinkednotifications", + "locations": [ + "", + "East US" + ] + }, + { + "notificationDestination": "/subscriptions/ac6bcfb5-3dc1-491f-95a6-646b89bf3e88/resourceGroups/mgmtexp-northeurope/providers/Microsoft.EventHub/namespaces/europe-mgmtexpint/eventhubs/armlinkednotifications", + "locations": [ + "North Europe" + ] + } + ] + } + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/NotificationRegistrations_ListByProviderRegistration.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/NotificationRegistrations_ListByProviderRegistration.json new file mode 100644 index 000000000000..88cb9dcde8a7 --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/NotificationRegistrations_ListByProviderRegistration.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "description": "Gets the list of the notification registrations for the given provider.", + "body": { + "value": [ + { + "name": "fooNotificationRegistration", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "properties": { + "notificationMode": "EventHub", + "messageScope": "RegisteredSubscriptions", + "includedEvents": [ + "*/write", + "Microsoft.Contoso/employees/delete" + ], + "notificationEndpoints": [ + { + "notificationDestination": "/subscriptions/ac6bcfb5-3dc1-491f-95a6-646b89bf3e88/resourceGroups/mgmtexp-eastus/providers/Microsoft.EventHub/namespaces/unitedstates-mgmtexpint/eventhubs/armlinkednotifications", + "locations": [ + "", + "East US" + ] + }, + { + "notificationDestination": "/subscriptions/ac6bcfb5-3dc1-491f-95a6-646b89bf3e88/resourceGroups/mgmtexp-northeurope/providers/Microsoft.EventHub/namespaces/europe-mgmtexpint/eventhubs/armlinkednotifications", + "locations": [ + "North Europe" + ] + } + ] + } + }, + { + "name": "barNotificationRegistration", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "properties": { + "notificationMode": "EventHub", + "messageScope": "RegisteredSubscriptions", + "includedEvents": [ + "*/delete" + ], + "notificationEndpoints": [ + { + "notificationDestination": "/subscriptions/ac6bcfb5-3dc1-491f-95a6-646b89bf3e88/resourceGroups/mgmtexp-eastus/providers/Microsoft.EventHub/namespaces/unitedstates-mgmtexpint/eventhubs/armlinkednotifications", + "locations": [ + "" + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Operations_CreateOrUpdate.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Operations_CreateOrUpdate.json new file mode 100644 index 000000000000..19cdee166a39 --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Operations_CreateOrUpdate.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview", + "OperationsPutContent": { + "properties": { + "contents": [ + { + "name": "RP.69C09791/register/action", + "isDataAction": true, + "display": { + "default": { + "provider": "RP.69C09791", + "resource": "Register", + "operation": "Registers the RP.69C09791 Resource Provider", + "description": "Registers the subscription for the RP.69C09791 resource provider and enables the creation of RP.69C09791." + } + }, + "actionType": "Internal" + }, + { + "name": "RP.69C09791/unregister/action", + "isDataAction": false, + "origin": "System", + "display": { + "default": { + "provider": "RP.69C09791", + "resource": "Unregister", + "operation": "Unregisters the RP.69C09791 Resource Provider", + "description": "Unregisters the subscription for the RP.69C09791 resource provider and enables the creation of RP.69C09791." + }, + "en": { + "provider": "RP.69C09791", + "resource": "2e1803d4-417f-492c-b305-148da38b211e", + "operation": "d31623d6-8765-42fb-aca2-5a58303e52dd", + "description": "ece249f5-b5b9-492d-ac68-b4e1be1677bc" + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "contents": [ + { + "name": "RP.69C09791/register/action", + "isDataAction": true, + "display": { + "default": { + "provider": "RP.69C09791", + "resource": "Register", + "operation": "Registers the RP.69C09791 Resource Provider", + "description": "Registers the subscription for the RP.69C09791 resource provider and enables the creation of RP.69C09791." + } + }, + "actionType": "Internal" + }, + { + "name": "RP.69C09791/unregister/action", + "isDataAction": false, + "origin": "System", + "display": { + "default": { + "provider": "RP.69C09791", + "resource": "Unregister", + "operation": "Unregisters the RP.69C09791 Resource Provider", + "description": "Unregisters the subscription for the RP.69C09791 resource provider and enables the creation of RP.69C09791." + }, + "en": { + "provider": "RP.69C09791", + "resource": "2e1803d4-417f-492c-b305-148da38b211e", + "operation": "d31623d6-8765-42fb-aca2-5a58303e52dd", + "description": "ece249f5-b5b9-492d-ac68-b4e1be1677bc" + } + } + } + ] + } + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Operations_Delete.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Operations_Delete.json new file mode 100644 index 000000000000..f29c7a0a298c --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Operations_Delete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "description": "Successfully deleted the operation." + }, + "204": { + "description": "Resource does not exist." + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Operations_List.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..ab89293be3fb --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Operations_List.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "description": "The list of supported operations has been fetched successfully.", + "body": { + "value": [ + { + "name": "Microsoft.ProviderHub/register/action", + "isDataAction": false, + "display": { + "provider": "Microsoft ProviderHub", + "resource": "register", + "operation": "Register for Microsoft.ProviderHub", + "description": "Registers the specified subscription with Microsoft.ProviderHub resource provider" + } + }, + { + "name": "Microsoft.ProviderHub/defaultRollouts/write", + "isDataAction": false, + "display": { + "provider": "Microsoft ProviderHub", + "resource": "defaultRollouts", + "operation": "Create or Update rollout", + "description": "Creates or Updates any rollout" + } + }, + { + "name": "Microsoft.ProviderHub/defaultRollouts/read", + "isDataAction": false, + "display": { + "provider": "Microsoft ProviderHub", + "resource": "defaultRollouts", + "operation": "Read rollout", + "description": "Reads any rollout" + } + }, + { + "name": "Microsoft.ProviderHub/defaultRollouts/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft ProviderHub", + "resource": "defaultRollouts", + "operation": "Delete rollout", + "description": "Deletes any rollout" + } + }, + { + "name": "Microsoft.ProviderHub/defaultRollouts/stop/action", + "isDataAction": false, + "display": { + "provider": "Microsoft ProviderHub", + "resource": "defaultRollouts", + "operation": "Delete rollout", + "description": "Deletes any rollout" + } + }, + { + "name": "Microsoft.ProviderHub/customRollouts/write", + "isDataAction": false, + "display": { + "provider": "Microsoft ProviderHub", + "resource": "customRollouts", + "operation": "Create or Update rollout", + "description": "Creates or Updates any rollout" + } + }, + { + "name": "Microsoft.ProviderHub/customRollouts/read", + "isDataAction": false, + "display": { + "provider": "Microsoft ProviderHub", + "resource": "customRollouts", + "operation": "Read rollout", + "description": "Reads any rollout" + } + } + ] + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Operations_ListByProviderRegistration.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Operations_ListByProviderRegistration.json new file mode 100644 index 000000000000..605829629c80 --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Operations_ListByProviderRegistration.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "description": "Gets the operations supported by the given provider.", + "body": [ + { + "name": "Microsoft.Contoso/Employees/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Contoso", + "resource": "Employees", + "operation": "Gets/List employee resources", + "description": "Read employees" + }, + "properties": null + }, + { + "name": "Microsoft.Contoso/Employees/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Contoso", + "resource": "Employees", + "operation": "Create/update employee resources", + "description": "Writes employees" + }, + "properties": null + }, + { + "name": "Microsoft.Contoso/Employees/Delete", + "isDataAction": false, + "origin": "User", + "display": { + "provider": "Microsoft.Contoso", + "resource": "Employees", + "operation": "Deletes employee resource", + "description": "Deletes employees" + }, + "properties": null + }, + { + "name": "Microsoft.Contoso/Employees/Action", + "isDataAction": true, + "origin": "System", + "display": { + "provider": "Microsoft.Contoso", + "resource": "Employees", + "operation": "Create/update employee resources", + "description": "Writes employees" + }, + "properties": null + } + ] + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ProviderRegistrations_CreateOrUpdate.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ProviderRegistrations_CreateOrUpdate.json new file mode 100644 index 000000000000..c421ec33a475 --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ProviderRegistrations_CreateOrUpdate.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview", + "properties": { + "properties": { + "providerType": "Internal", + "providerVersion": "2.0", + "management": { + "incidentRoutingService": "Contoso Resource Provider", + "incidentRoutingTeam": "Contoso Triage", + "incidentContactEmail": "helpme@contoso.com" + }, + "capabilities": [ + { + "quotaId": "CSP_2015-05-01", + "effect": "Allow" + }, + { + "quotaId": "CSP_MG_2017-12-01", + "effect": "Allow" + } + ] + } + } + }, + "responses": { + "200": { + "description": "", + "body": { + "properties": { + "namespace": "Microsoft.Contoso", + "providerAuthorizations": [ + { + "applicationId": "1a3b5c7d-8e9f-10g1-1h12-i13j14k1", + "roleDefinitionId": "123456bf-gkur-2098-b890-98da392a00b2" + } + ], + "management": { + "manifestOwners": [ + "manifestOwners-group" + ], + "incidentRoutingService": "", + "incidentRoutingTeam": "", + "incidentContactEmail": "helpme@contoso.com", + "resourceAccessPolicy": "NotSpecified" + }, + "capabilities": [ + { + "quotaId": "CSP_2015-05-01", + "effect": "Allow" + }, + { + "quotaId": "CSP_MG_2017-12-01", + "effect": "Allow" + } + ], + "metadata": { + "onboardedVia": "ProviderHub" + }, + "providerVersion": "2.0", + "providerType": "Internal, Hidden", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + } + } + }, + "201": { + "description": "Successfully created the provider registration." + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ProviderRegistrations_Delete.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ProviderRegistrations_Delete.json new file mode 100644 index 000000000000..2faa9060be75 --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ProviderRegistrations_Delete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "description": "Successfully deleted the provider registration." + }, + "204": { + "description": "Resource does not exist." + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ProviderRegistrations_GenerateOperations.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ProviderRegistrations_GenerateOperations.json new file mode 100644 index 000000000000..276c32d73a49 --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ProviderRegistrations_GenerateOperations.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "description": "", + "body": [ + { + "name": "Microsoft.Contoso/Employees/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Contoso", + "resource": "Employees", + "operation": "Gets/List employee resources", + "description": "Read employees" + }, + "properties": null + }, + { + "name": "Microsoft.Contoso/Employees/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Contoso", + "resource": "Employees", + "operation": "Create/update employee resources", + "description": "Writes employees" + }, + "properties": null + }, + { + "name": "Microsoft.Contoso/Employees/Delete", + "isDataAction": false, + "origin": "User", + "display": { + "provider": "Microsoft.Contoso", + "resource": "Employees", + "operation": "Deletes employee resource", + "description": "Deletes employees" + }, + "properties": null + }, + { + "name": "Microsoft.Contoso/Employees/Action", + "isDataAction": true, + "origin": "System", + "display": { + "provider": "Microsoft.Contoso", + "resource": "Employees", + "operation": "Create/update employee resources", + "description": "Writes employees" + }, + "properties": null + } + ] + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ProviderRegistrations_Get.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ProviderRegistrations_Get.json new file mode 100644 index 000000000000..36525992e782 --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ProviderRegistrations_Get.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "description": "", + "body": { + "properties": { + "providerHubMetadata": { + "providerAuthentication": { + "allowedAudiences": [ + "https://management.core.windows.net/" + ] + } + }, + "provisioningState": "Succeeded", + "providerAuthorizations": [ + { + "applicationId": "1a3b5c7d-8e9f-10g1-1h12-i13j14k1", + "roleDefinitionId": "123456bf-gkur-2098-b890-98da392a00b2" + } + ], + "namespace": "microsoft.contoso", + "providerVersion": "2.0", + "providerType": "Internal, Hidden", + "management": { + "manifestOwners": [ + "SPARTA-PlatformServiceAdministrator" + ], + "incidentRoutingService": "", + "incidentRoutingTeam": "", + "incidentContactEmail": "helpme@contoso.com", + "resourceAccessPolicy": "NotSpecified" + }, + "capabilities": [ + { + "quotaId": "CSP_2015-05-01", + "effect": "Allow" + }, + { + "quotaId": "CSP_MG_2017-12-01", + "effect": "Allow" + } + ], + "metadata": null + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + } + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ProviderRegistrations_List.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ProviderRegistrations_List.json new file mode 100644 index 000000000000..818ff0d5ac7e --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ProviderRegistrations_List.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "namespace": "microsoft.contoso", + "providerAuthorizations": [ + { + "applicationId": "1a3b5c7d-8e9f-10g1-1h12-i13j14k1", + "roleDefinitionId": "123456bf-gkur-2098-b890-98da392a00b2" + } + ], + "providerHubMetadata": { + "providerAuthentication": { + "allowedAudiences": [ + "https://management.core.windows.net/" + ] + } + }, + "management": { + "manifestOwners": [ + "manifestOwners-group" + ], + "incidentRoutingService": "", + "incidentRoutingTeam": "", + "incidentContactEmail": "helpme@contoso.com", + "resourceAccessPolicy": "NotSpecified" + }, + "providerType": "Internal, Hidden", + "providerVersion": "2.0", + "capabilities": [ + { + "quotaId": "CSP_2015-05-01", + "effect": "Allow" + }, + { + "quotaId": "CSP_MG_2017-12-01", + "effect": "Allow" + } + ], + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + } + } + ] + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ResourceActions_DeleteResources.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ResourceActions_DeleteResources.json new file mode 100644 index 000000000000..9a4fd7e71a7f --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ResourceActions_DeleteResources.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "resourceActionName": "default", + "api-version": "2021-06-01-preview", + "properties": { + "resources": [ + { + "resourceId": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.Contoso/employee/test", + "location": "southeastasia", + "homeTenantId": "11111111-f7ef-471a-a2f4-d0ebbf494f77" + } + ] + } + }, + "responses": { + "202": { + "description": "Resource management action started.", + "headers": { + "location": "https://management.azure.com/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/operationStauses/11111111-f7ef-471a-a2f4-d0ebbf494f77", + "retry-after": "5000" + }, + "body": { + "resources": [ + { + "resourceId": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.Contoso/employee/test", + "location": "southeastasia", + "homeTenantId": "11111111-f7ef-471a-a2f4-d0ebbf494f77" + } + ] + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ResourceTypeRegistrations_CreateOrUpdate.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ResourceTypeRegistrations_CreateOrUpdate.json new file mode 100644 index 000000000000..101ae54cdb0f --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ResourceTypeRegistrations_CreateOrUpdate.json @@ -0,0 +1,237 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "resourceType": "employees", + "api-version": "2021-06-01-preview", + "properties": { + "properties": { + "routingType": "Default", + "regionality": "Regional", + "endpoints": [ + { + "apiVersions": [ + "2020-06-01-preview" + ], + "locations": [ + "West US", + "East US", + "North Europe" + ], + "requiredFeatures": [ + "" + ] + } + ], + "resourceConcurrencyControlOptions": { + "put": { + "policy": "SynchronizeBeginExtension" + }, + "patch": { + "policy": "SynchronizeBeginExtension" + }, + "post": { + "policy": "SynchronizeBeginExtension" + } + }, + "swaggerSpecifications": [ + { + "apiVersions": [ + "2020-06-01-preview" + ], + "swaggerSpecFolderUri": "https://github.com/Azure/azure-rest-api-specs/blob/feature/azure/contoso/specification/contoso/resource-manager/Microsoft.SampleRP/" + } + ], + "resourceGraphConfiguration": { + "enabled": true, + "apiVersion": "2019-01-01" + }, + "management": { + "manifestOwners": [ + "SPARTA-PlatformServiceAdministrator" + ], + "incidentRoutingService": "", + "incidentRoutingTeam": "", + "incidentContactEmail": "helpme@contoso.com", + "resourceAccessPolicy": "NotSpecified" + }, + "openApiConfiguration": { + "validation": { + "allowNoncompliantCollectionResponse": true + } + } + } + } + }, + "responses": { + "200": { + "description": "Successfully updated the resource type.", + "body": { + "properties": { + "routingType": "Default", + "regionality": "Regional", + "endpoints": [ + { + "apiVersions": [ + "2018-11-01-preview", + "2020-01-01-preview", + "2019-01-01" + ], + "locations": [ + "East Asia", + "East US", + "North Europe", + "Southeast Asia", + "East US 2 EUAP", + "Central US EUAP", + "West Europe", + "West US", + "West Central US", + "West US 2" + ], + "requiredFeatures": [ + "Microsoft.Contoso/RPaaSSampleApp" + ] + } + ], + "swaggerSpecifications": [ + { + "apiVersions": [ + "2018-11-01-preview", + "2020-01-01-preview", + "2019-01-01" + ], + "swaggerSpecFolderUri": "https://github.com/Azure/azure-rest-api-specs/blob/feature/azure/contoso/specification/contoso/resource-manager/Microsoft.SampleRP/" + } + ], + "enableAsyncOperation": false, + "provisioningState": "Succeeded", + "enableThirdPartyS2S": false, + "resourceDeletionPolicy": "CascadeDeleteProxyOnlyChildren", + "resourceConcurrencyControlOptions": { + "put": { + "policy": "SynchronizeBeginExtension" + }, + "patch": { + "policy": "SynchronizeBeginExtension" + }, + "post": { + "policy": "SynchronizeBeginExtension" + } + }, + "resourceGraphConfiguration": { + "enabled": true, + "apiVersion": "2019-01-01" + }, + "management": { + "manifestOwners": [ + "SPARTA-PlatformServiceAdministrator" + ], + "incidentRoutingService": "", + "incidentRoutingTeam": "", + "incidentContactEmail": "helpme@contoso.com", + "resourceAccessPolicy": "NotSpecified" + }, + "openApiConfiguration": { + "validation": { + "allowNoncompliantCollectionResponse": true + } + } + }, + "name": "employees", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + } + } + }, + "201": { + "description": "Successfully created the resource type.", + "body": { + "properties": { + "routingType": "Default", + "regionality": "Regional", + "endpoints": [ + { + "apiVersions": [ + "2018-11-01-preview", + "2020-01-01-preview", + "2019-01-01" + ], + "locations": [ + "East Asia", + "East US", + "North Europe", + "Southeast Asia", + "East US 2 EUAP", + "Central US EUAP", + "West Europe", + "West US", + "West Central US", + "West US 2" + ], + "requiredFeatures": [ + "Microsoft.Contoso/RPaaSSampleApp" + ] + } + ], + "swaggerSpecifications": [ + { + "apiVersions": [ + "2018-11-01-preview", + "2020-01-01-preview", + "2019-01-01" + ], + "swaggerSpecFolderUri": "https://github.com/Azure/azure-rest-api-specs/blob/feature/azure/contoso/specification/contoso/resource-manager/Microsoft.SampleRP/" + } + ], + "enableAsyncOperation": false, + "provisioningState": "Succeeded", + "enableThirdPartyS2S": false, + "resourceConcurrencyControlOptions": { + "put": { + "policy": "SynchronizeBeginExtension" + }, + "patch": { + "policy": "SynchronizeBeginExtension" + }, + "post": { + "policy": "SynchronizeBeginExtension" + } + }, + "resourceGraphConfiguration": { + "enabled": true, + "apiVersion": "2019-01-01" + }, + "management": { + "manifestOwners": [ + "SPARTA-PlatformServiceAdministrator" + ], + "incidentRoutingService": "", + "incidentRoutingTeam": "", + "incidentContactEmail": "helpme@contoso.com", + "resourceAccessPolicy": "NotSpecified" + }, + "openApiConfiguration": { + "validation": { + "allowNoncompliantCollectionResponse": true + } + } + }, + "name": "employees", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + } + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ResourceTypeRegistrations_Delete.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ResourceTypeRegistrations_Delete.json new file mode 100644 index 000000000000..c159cd6880c3 --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ResourceTypeRegistrations_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview", + "resourceType": "testResourceType" + }, + "responses": { + "200": { + "description": "Successfully deleted the resource type." + }, + "204": { + "description": "Resource does not exist." + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ResourceTypeRegistrations_Get.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ResourceTypeRegistrations_Get.json new file mode 100644 index 000000000000..1a772e784399 --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ResourceTypeRegistrations_Get.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "resourceType": "employees", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "description": "", + "body": { + "properties": { + "routingType": "Default", + "regionality": "Regional", + "endpoints": [ + { + "apiVersions": [ + "2018-11-01-preview", + "2020-01-01-preview", + "2019-01-01" + ], + "locations": [ + "East Asia", + "East US", + "North Europe", + "Southeast Asia", + "East US 2 EUAP", + "Central US EUAP", + "West Europe", + "West US", + "West Central US", + "West US 2" + ], + "requiredFeatures": [ + "Microsoft.Contoso/RPaaSSampleApp" + ] + } + ], + "swaggerSpecifications": [ + { + "apiVersions": [ + "2018-11-01-preview", + "2020-01-01-preview", + "2019-01-01" + ], + "swaggerSpecFolderUri": "https://github.com/Azure/azure-rest-api-specs/blob/feature/azure/contoso/specification/contoso/resource-manager/Microsoft.SampleRP/" + } + ], + "enableAsyncOperation": false, + "provisioningState": "Succeeded", + "enableThirdPartyS2S": false, + "resourceConcurrencyControlOptions": { + "put": { + "policy": "SynchronizeBeginExtension" + }, + "patch": { + "policy": "SynchronizeBeginExtension" + }, + "post": { + "policy": "SynchronizeBeginExtension" + } + }, + "resourceGraphConfiguration": { + "enabled": true, + "apiVersion": "2019-01-01" + }, + "management": { + "manifestOwners": [ + "SPARTA-PlatformServiceAdministrator" + ], + "incidentRoutingService": "", + "incidentRoutingTeam": "", + "incidentContactEmail": "helpme@contoso.com", + "resourceAccessPolicy": "NotSpecified" + }, + "openApiConfiguration": { + "validation": { + "allowNoncompliantCollectionResponse": false + } + } + }, + "name": "employees", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + } + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ResourceTypeRegistrations_ListByProviderRegistration.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ResourceTypeRegistrations_ListByProviderRegistration.json new file mode 100644 index 000000000000..7af5619015eb --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/ResourceTypeRegistrations_ListByProviderRegistration.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "description": "", + "body": { + "value": [ + { + "properties": { + "routingType": "Default", + "regionality": "Regional", + "endpoints": [ + { + "apiVersions": [ + "2018-11-01-preview", + "2020-01-01-preview", + "2019-01-01" + ], + "locations": [ + "East Asia", + "East US", + "North Europe", + "Southeast Asia", + "East US 2 EUAP", + "Central US EUAP", + "West Europe", + "West US", + "West Central US", + "West US 2" + ], + "requiredFeatures": [ + "Microsoft.Contoso/RPaaSSampleApp" + ] + } + ], + "swaggerSpecifications": [ + { + "apiVersions": [ + "2018-11-01-preview", + "2020-01-01-preview", + "2019-01-01" + ], + "swaggerSpecFolderUri": "https://github.com/Azure/azure-rest-api-specs/blob/feature/azure/contoso/specification/contoso/resource-manager/Microsoft.SampleRP/" + } + ], + "enableAsyncOperation": false, + "provisioningState": "Succeeded", + "enableThirdPartyS2S": false, + "resourceConcurrencyControlOptions": { + "put": { + "policy": "SynchronizeBeginExtension" + }, + "patch": { + "policy": "SynchronizeBeginExtension" + }, + "post": { + "policy": "SynchronizeBeginExtension" + } + }, + "resourceGraphConfiguration": { + "enabled": true, + "apiVersion": "2019-01-01" + }, + "management": { + "manifestOwners": [ + "SPARTA-PlatformServiceAdministrator" + ], + "incidentRoutingService": "", + "incidentRoutingTeam": "", + "incidentContactEmail": "helpme@contoso.com", + "resourceAccessPolicy": "NotSpecified" + }, + "openApiConfiguration": { + "validation": { + "allowNoncompliantCollectionResponse": false + } + } + }, + "name": "employees", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + } + } + ] + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_CreateOrUpdate.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_CreateOrUpdate.json new file mode 100644 index 000000000000..9962b47bacb4 --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_CreateOrUpdate.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview", + "resourceType": "testResourceType", + "sku": "testSku", + "properties": { + "skuSettings": [ + { + "name": "freeSku", + "tier": "Tier1", + "kind": "Standard" + }, + { + "name": "premiumSku", + "tier": "Tier2", + "kind": "Premium", + "costs": [ + { + "meterId": "xxx" + } + ] + } + ] + } + }, + "responses": { + "200": { + "description": "", + "body": { + "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/", + "name": "Microsoft.Contoso/", + "type": "Microsoft.ProviderHub/providerRegistrations/", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + } + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_CreateOrUpdateNestedResourceTypeFirst.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_CreateOrUpdateNestedResourceTypeFirst.json new file mode 100644 index 000000000000..144031b9da8f --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_CreateOrUpdateNestedResourceTypeFirst.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview", + "resourceType": "testResourceType", + "sku": "testSku", + "nestedResourceTypeFirst": "nestedResourceTypeFirst", + "properties": { + "skuSettings": [ + { + "name": "freeSku", + "tier": "Tier1", + "kind": "Standard" + }, + { + "name": "premiumSku", + "tier": "Tier2", + "kind": "Premium", + "costs": [ + { + "meterId": "xxx" + } + ] + } + ] + } + }, + "responses": { + "200": { + "description": "", + "body": { + "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/", + "name": "Microsoft.Contoso/", + "type": "Microsoft.ProviderHub/providerRegistrations/", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + } + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_CreateOrUpdateNestedResourceTypeSecond.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_CreateOrUpdateNestedResourceTypeSecond.json new file mode 100644 index 000000000000..c9bbd2a2e45a --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_CreateOrUpdateNestedResourceTypeSecond.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview", + "resourceType": "testResourceType", + "sku": "testSku", + "nestedResourceTypeFirst": "nestedResourceTypeFirst", + "nestedResourceTypeSecond": "nestedResourceTypeSecond", + "properties": { + "skuSettings": [ + { + "name": "freeSku", + "tier": "Tier1", + "kind": "Standard" + }, + { + "name": "premiumSku", + "tier": "Tier2", + "kind": "Premium", + "costs": [ + { + "meterId": "xxx" + } + ] + } + ] + } + }, + "responses": { + "200": { + "description": "", + "body": { + "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/", + "name": "Microsoft.Contoso/", + "type": "Microsoft.ProviderHub/providerRegistrations/", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + } + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_CreateOrUpdateNestedResourceTypeThird.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_CreateOrUpdateNestedResourceTypeThird.json new file mode 100644 index 000000000000..fbb79b66259b --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_CreateOrUpdateNestedResourceTypeThird.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview", + "resourceType": "testResourceType", + "sku": "testSku", + "nestedResourceTypeFirst": "nestedResourceTypeFirst", + "nestedResourceTypeSecond": "nestedResourceTypeSecond", + "nestedResourceTypeThird": "nestedResourceTypeThird", + "properties": { + "skuSettings": [ + { + "name": "freeSku", + "tier": "Tier1", + "kind": "Standard" + }, + { + "name": "premiumSku", + "tier": "Tier2", + "kind": "Premium", + "costs": [ + { + "meterId": "xxx" + } + ] + } + ] + } + }, + "responses": { + "200": { + "description": "", + "body": { + "id": "/subscriptions/ab7a8701-f7ef-471a-a2f4-d0ebbf494f77providers/Microsoft.ProviderHub/providerRegistrations/Microsoft.Contoso/", + "name": "Microsoft.Contoso/", + "type": "Microsoft.ProviderHub/providerRegistrations/", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + } + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_Delete.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_Delete.json new file mode 100644 index 000000000000..de0a5d1a9200 --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview", + "resourceType": "testResourceType", + "sku": "testSku" + }, + "responses": { + "200": { + "description": "Successfully deleted the resource type sku." + }, + "204": { + "description": "Resource does not exist." + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_DeleteNestedResourceTypeFirst.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_DeleteNestedResourceTypeFirst.json new file mode 100644 index 000000000000..a27fde974322 --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_DeleteNestedResourceTypeFirst.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview", + "resourceType": "testResourceType", + "sku": "testSku", + "nestedResourceTypeFirst": "nestedResourceTypeFirst" + }, + "responses": { + "200": { + "description": "Successfully deleted the resource type sku." + }, + "204": { + "description": "Resource does not exist." + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_DeleteNestedResourceTypeSecond.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_DeleteNestedResourceTypeSecond.json new file mode 100644 index 000000000000..3807cf1e7233 --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_DeleteNestedResourceTypeSecond.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview", + "resourceType": "testResourceType", + "sku": "testSku", + "nestedResourceTypeFirst": "nestedResourceTypeFirst", + "nestedResourceTypeSecond": "nestedResourceTypeSecond" + }, + "responses": { + "200": { + "description": "Successfully deleted the resource type sku." + }, + "204": { + "description": "Resource does not exist." + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_DeleteNestedResourceTypeThird.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_DeleteNestedResourceTypeThird.json new file mode 100644 index 000000000000..31ed71df2a8a --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_DeleteNestedResourceTypeThird.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview", + "resourceType": "testResourceType", + "sku": "testSku", + "nestedResourceTypeFirst": "nestedResourceTypeFirst", + "nestedResourceTypeSecond": "nestedResourceTypeSecond", + "nestedResourceTypeThird": "nestedResourceTypeThird" + }, + "responses": { + "200": { + "description": "Successfully deleted the resource type sku." + }, + "204": { + "description": "Resource does not exist." + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_Get.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_Get.json new file mode 100644 index 000000000000..31d706af9a58 --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_Get.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview", + "resourceType": "testResourceType", + "sku": "testSku" + }, + "responses": { + "200": { + "body": { + "name": "testSku", + "properties": { + "skuSettings": [ + { + "name": "freeSku", + "tier": "Tier1", + "kind": "Standard" + }, + { + "name": "premiumSku", + "tier": "Tier2", + "kind": "Premium", + "costs": [ + { + "meterId": "xxx" + } + ] + } + ] + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + } + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_GetNestedResourceTypeFirst.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_GetNestedResourceTypeFirst.json new file mode 100644 index 000000000000..65dcf73ffd4b --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_GetNestedResourceTypeFirst.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview", + "resourceType": "testResourceType", + "sku": "testSku", + "nestedResourceTypeFirst": "nestedResourceTypeFirst" + }, + "responses": { + "200": { + "body": { + "name": "testSku", + "properties": { + "skuSettings": [ + { + "name": "freeSku", + "tier": "Tier1", + "kind": "Standard" + }, + { + "name": "premiumSku", + "tier": "Tier2", + "kind": "Premium", + "costs": [ + { + "meterId": "xxx" + } + ] + } + ] + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + } + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_GetNestedResourceTypeSecond.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_GetNestedResourceTypeSecond.json new file mode 100644 index 000000000000..24a6b44aaf56 --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_GetNestedResourceTypeSecond.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview", + "resourceType": "testResourceType", + "sku": "testSku", + "nestedResourceTypeFirst": "nestedResourceTypeFirst", + "nestedResourceTypeSecond": "nestedResourceTypeSecond" + }, + "responses": { + "200": { + "body": { + "name": "testSku", + "properties": { + "skuSettings": [ + { + "name": "freeSku", + "tier": "Tier1", + "kind": "Standard" + }, + { + "name": "premiumSku", + "tier": "Tier2", + "kind": "Premium", + "costs": [ + { + "meterId": "xxx" + } + ] + } + ] + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + } + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_GetNestedResourceTypeThird.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_GetNestedResourceTypeThird.json new file mode 100644 index 000000000000..71bd93be92db --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_GetNestedResourceTypeThird.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview", + "resourceType": "testResourceType", + "sku": "testSku", + "nestedResourceTypeFirst": "nestedResourceTypeFirst", + "nestedResourceTypeSecond": "nestedResourceTypeSecond", + "nestedResourceTypeThird": "nestedResourceTypeThird" + }, + "responses": { + "200": { + "body": { + "name": "testSku", + "properties": { + "skuSettings": [ + { + "name": "freeSku", + "tier": "Tier1", + "kind": "Standard" + }, + { + "name": "premiumSku", + "tier": "Tier2", + "kind": "Premium", + "costs": [ + { + "meterId": "xxx" + } + ] + } + ] + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + } + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_ListByResourceTypeRegistrations.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_ListByResourceTypeRegistrations.json new file mode 100644 index 000000000000..49c4c5e57242 --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_ListByResourceTypeRegistrations.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview", + "resourceType": "testResourceType" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testSku", + "properties": { + "skuSettings": [ + { + "name": "freeSku", + "tier": "Tier1", + "kind": "Standard" + }, + { + "name": "premiumSku", + "tier": "Tier2", + "kind": "Premium", + "costs": [ + { + "meterId": "xxx" + } + ] + } + ] + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + } + } + ] + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_ListByResourceTypeRegistrationsNestedResourceTypeFirst.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_ListByResourceTypeRegistrationsNestedResourceTypeFirst.json new file mode 100644 index 000000000000..7c3c4815df58 --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_ListByResourceTypeRegistrationsNestedResourceTypeFirst.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview", + "resourceType": "testResourceType", + "nestedResourceTypeFirst": "nestedResourceTypeFirst" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testSku", + "properties": { + "skuSettings": [ + { + "name": "freeSku", + "tier": "Tier1", + "kind": "Standard" + }, + { + "name": "premiumSku", + "tier": "Tier2", + "kind": "Premium", + "costs": [ + { + "meterId": "xxx" + } + ] + } + ] + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + } + } + ] + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_ListByResourceTypeRegistrationsNestedResourceTypeSecond.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_ListByResourceTypeRegistrationsNestedResourceTypeSecond.json new file mode 100644 index 000000000000..a312436580fa --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_ListByResourceTypeRegistrationsNestedResourceTypeSecond.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview", + "resourceType": "testResourceType", + "sku": "testSku", + "nestedResourceTypeFirst": "nestedResourceTypeFirst", + "nestedResourceTypeSecond": "nestedResourceTypeSecond" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testSku", + "properties": { + "skuSettings": [ + { + "name": "freeSku", + "tier": "Tier1", + "kind": "Standard" + }, + { + "name": "premiumSku", + "tier": "Tier2", + "kind": "Premium", + "costs": [ + { + "meterId": "xxx" + } + ] + } + ] + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + } + } + ] + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_ListByResourceTypeRegistrationsNestedResourceTypeThird.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_ListByResourceTypeRegistrationsNestedResourceTypeThird.json new file mode 100644 index 000000000000..a641d3ecffc8 --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/examples/Skus_ListByResourceTypeRegistrationsNestedResourceTypeThird.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77", + "providerNamespace": "Microsoft.Contoso", + "api-version": "2021-06-01-preview", + "resourceType": "testResourceType", + "sku": "testSku", + "nestedResourceTypeFirst": "nestedResourceTypeFirst", + "nestedResourceTypeSecond": "nestedResourceTypeSecond", + "nestedResourceTypeThird": "nestedResourceTypeThird" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testSku", + "properties": { + "skuSettings": [ + { + "name": "freeSku", + "tier": "Tier1", + "kind": "Standard" + }, + { + "name": "premiumSku", + "tier": "Tier2", + "kind": "Premium", + "costs": [ + { + "meterId": "xxx" + } + ] + } + ] + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + } + } + ] + } + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json new file mode 100644 index 000000000000..4695d71164b8 --- /dev/null +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json @@ -0,0 +1,5091 @@ +{ + "swagger": "2.0", + "info": { + "title": "ProviderHub", + "description": "Microsoft ProviderHub", + "version": "2021-06-01-preview", + "x-ms-code-generation-settings": { + "name": "ProviderHubClient" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "host": "management.azure.com", + "schemes": [ + "https" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/customRollouts/{rolloutName}": { + "get": { + "tags": [ + "CustomRollouts" + ], + "description": "Gets the custom rollout details.", + "operationId": "CustomRollouts_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/GetRolloutNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the rollout details.", + "schema": { + "$ref": "#/definitions/CustomRollout" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CustomRollouts_Get": { + "$ref": "./examples/CustomRollouts_Get.json" + } + } + }, + "put": { + "tags": [ + "CustomRollouts" + ], + "description": "Creates or updates the rollout details.", + "operationId": "CustomRollouts_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/GetRolloutNameParameter" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CustomRollout" + }, + "description": "The custom rollout properties supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Rollout completed successfully.", + "schema": { + "$ref": "#/definitions/CustomRollout" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CustomRollouts_CreateOrUpdate": { + "$ref": "./examples/CustomRollouts_CreateOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/customRollouts": { + "get": { + "tags": [ + "CustomRollouts" + ], + "description": "Gets the list of the custom rollouts for the given provider.", + "operationId": "CustomRollouts_ListByProviderRegistration", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of custom rollouts for given provider.", + "schema": { + "$ref": "#/definitions/CustomRolloutArrayResponseWithContinuation" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CustomRollouts_ListByProviderRegistration": { + "$ref": "./examples/CustomRollouts_ListByProviderRegistration.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/defaultRollouts/{rolloutName}": { + "get": { + "tags": [ + "DefaultRollouts" + ], + "description": "Gets the default rollout details.", + "operationId": "DefaultRollouts_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/GetRolloutNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the default rollout details.", + "schema": { + "$ref": "#/definitions/DefaultRollout" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DefaultRollouts_Get": { + "$ref": "./examples/DefaultRollouts_Get.json" + } + } + }, + "delete": { + "tags": [ + "DefaultRollouts" + ], + "description": "Deletes the rollout resource. Rollout must be in terminal state.", + "operationId": "DefaultRollouts_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/GetRolloutNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the default rollout resource." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DefaultRollouts_Delete": { + "$ref": "./examples/DefaultRollouts_Delete.json" + } + } + }, + "put": { + "tags": [ + "DefaultRollouts" + ], + "description": "Creates or updates the rollout details.", + "operationId": "DefaultRollouts_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/GetRolloutNameParameter" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DefaultRollout" + }, + "description": "The Default rollout properties supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Default rollout started successfully.", + "schema": { + "$ref": "#/definitions/DefaultRollout" + } + }, + "201": { + "description": "Default rollout completed successfully.", + "schema": { + "$ref": "#/definitions/DefaultRollout" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DefaultRollouts_CreateOrUpdate": { + "$ref": "./examples/DefaultRollouts_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/defaultRollouts": { + "get": { + "tags": [ + "DefaultRollouts" + ], + "description": "Gets the list of the rollouts for the given provider.", + "operationId": "DefaultRollouts_ListByProviderRegistration", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of default rollouts.", + "schema": { + "$ref": "#/definitions/DefaultRolloutArrayResponseWithContinuation" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DefaultRollouts_ListByProviderRegistration": { + "$ref": "./examples/DefaultRollouts_ListByProviderRegistration.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/defaultRollouts/{rolloutName}/stop": { + "post": { + "tags": [ + "DefaultRollouts" + ], + "description": "Stops or cancels the rollout, if in progress.", + "operationId": "DefaultRollouts_Stop", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/GetRolloutNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully cancelled the default rollout." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DefaultRollouts_Stop": { + "$ref": "./examples/DefaultRollouts_Stop.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/generateManifest": { + "post": { + "tags": [ + "Manifest" + ], + "description": "Generates the manifest for the given provider.", + "operationId": "GenerateManifest", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "GenerateManifest": { + "$ref": "./examples/GenerateManifest.json" + } + }, + "responses": { + "200": { + "description": "Manifest generated.", + "schema": { + "$ref": "#/definitions/ResourceProviderManifest" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/checkinManifest": { + "post": { + "tags": [ + "Manifest" + ], + "description": "Checkin the manifest.", + "operationId": "CheckinManifest", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "name": "checkinManifestParams", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckinManifestParams" + }, + "description": "The required body parameters supplied to the checkin manifest operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "CheckinManifest": { + "$ref": "./examples/CheckinManifest.json" + } + }, + "responses": { + "200": { + "description": "Successfully checked-in manifest.", + "schema": { + "$ref": "#/definitions/CheckinManifestInfo" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/notificationRegistrations/{notificationRegistrationName}": { + "get": { + "tags": [ + "NotificationRegistration" + ], + "description": "Gets the notification registration details.", + "operationId": "NotificationRegistrations_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/GetNotificationRegistrationNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "NotificationRegistrations_Get": { + "$ref": "./examples/NotificationRegistrations_Get.json" + } + }, + "responses": { + "200": { + "description": "Successfully retrieved the notification registration.", + "schema": { + "$ref": "#/definitions/NotificationRegistration" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "NotificationRegistration" + ], + "description": "Creates or updates a notification registration.", + "operationId": "NotificationRegistrations_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/GetNotificationRegistrationNameParameter" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NotificationRegistration" + }, + "description": "The required body parameters supplied to the notification registration operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "NotificationRegistrations_CreateOrUpdate": { + "$ref": "./examples/NotificationRegistrations_CreateOrUpdate.json" + } + }, + "responses": { + "200": { + "description": "Successfully created or updated the notification registration.", + "schema": { + "$ref": "#/definitions/NotificationRegistration" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "NotificationRegistration" + ], + "description": "Deletes a notification registration.", + "operationId": "NotificationRegistrations_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/GetNotificationRegistrationNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "NotificationRegistrations_Delete": { + "$ref": "./examples/NotificationRegistrations_Delete.json" + } + }, + "responses": { + "200": { + "description": "Successfully deleted the notification registration." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/notificationRegistrations": { + "get": { + "tags": [ + "NotificationRegistration" + ], + "description": "Gets the list of the notification registrations for the given provider.", + "operationId": "NotificationRegistrations_ListByProviderRegistration", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "NotificationRegistrations_ListByProviderRegistration": { + "$ref": "./examples/NotificationRegistrations_ListByProviderRegistration.json" + } + }, + "responses": { + "200": { + "description": "Successfully retrieved the notification registrations.", + "schema": { + "$ref": "#/definitions/NotificationRegistrationArrayResponseWithContinuation" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ProviderHub/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all the operations supported by Microsoft.ProviderHub.", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of supported operations.", + "schema": { + "$ref": "#/definitions/OperationsDefinitionArrayResponseWithContinuation" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/operations/default": { + "get": { + "tags": [ + "Operations" + ], + "description": "Gets the operations supported by the given provider.", + "operationId": "Operations_ListByProviderRegistration", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "Operations_ListByProviderRegistration": { + "$ref": "./examples/Operations_ListByProviderRegistration.json" + } + }, + "responses": { + "200": { + "description": "Successfully retrieved the supported operations.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/OperationsDefinition" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Operations" + ], + "description": "Creates or updates the operation supported by the given provider.", + "operationId": "Operations_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "name": "OperationsPutContent", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OperationsPutContent" + }, + "description": "The operations content properties supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "Operations_CreateOrUpdate": { + "$ref": "./examples/Operations_CreateOrUpdate.json" + } + }, + "responses": { + "200": { + "description": "Successfully created or updated the operation.", + "schema": { + "$ref": "#/definitions/OperationsPutContent" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Operations" + ], + "description": "Deletes an operation.", + "operationId": "Operations_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "Operations_Delete": { + "$ref": "./examples/Operations_Delete.json" + } + }, + "responses": { + "200": { + "description": "Successfully deleted the operation." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}": { + "get": { + "tags": [ + "ProviderRegistration" + ], + "description": "Gets the provider registration details.", + "operationId": "ProviderRegistrations_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "ProviderRegistrations_Get": { + "$ref": "./examples/ProviderRegistrations_Get.json" + } + }, + "responses": { + "200": { + "description": "Successfully retrieved the provider registration.", + "schema": { + "$ref": "#/definitions/ProviderRegistration" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ProviderRegistration" + ], + "description": "Creates or updates the provider registration.", + "operationId": "ProviderRegistrations_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ProviderRegistration" + }, + "description": "The provider registration properties supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "ProviderRegistrations_CreateOrUpdate": { + "$ref": "./examples/ProviderRegistrations_CreateOrUpdate.json" + } + }, + "responses": { + "200": { + "description": "Successfully updated the provider registration.", + "schema": { + "$ref": "#/definitions/ProviderRegistration" + } + }, + "201": { + "description": "Successfully created the provider registration." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "ProviderRegistration" + ], + "description": "Deletes a provider registration.", + "operationId": "ProviderRegistrations_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "ProviderRegistrations_Delete": { + "$ref": "./examples/ProviderRegistrations_Delete.json" + } + }, + "responses": { + "200": { + "description": "Successfully deleted the provider registration." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations": { + "get": { + "tags": [ + "ProviderRegistration" + ], + "description": "Gets the list of the provider registrations in the subscription.", + "operationId": "ProviderRegistrations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "ProviderRegistrations_List": { + "$ref": "./examples/ProviderRegistrations_List.json" + } + }, + "responses": { + "200": { + "description": "Successfully retrieved the provider registrations.", + "schema": { + "$ref": "#/definitions/ProviderRegistrationArrayResponseWithContinuation" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/generateOperations": { + "post": { + "tags": [ + "ProviderRegistration" + ], + "description": "Generates the operations api for the given provider.", + "operationId": "ProviderRegistrations_GenerateOperations", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "ProviderRegistrations_GenerateOperations": { + "$ref": "./examples/ProviderRegistrations_GenerateOperations.json" + } + }, + "responses": { + "200": { + "description": "The operations api has been generated successfully.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/OperationsDefinition" + } + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourcetypeRegistrations/{resourceType}": { + "get": { + "tags": [ + "ResourceTypeRegistration" + ], + "description": "Gets a resource type details in the given subscription and provider.", + "operationId": "ResourceTypeRegistrations_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/GetResourceTypeParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "ResourceTypeRegistrations_Get": { + "$ref": "./examples/ResourceTypeRegistrations_Get.json" + } + }, + "responses": { + "200": { + "description": "Successfully retrieved the resource type.", + "schema": { + "$ref": "#/definitions/ResourceTypeRegistration" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ResourceTypeRegistration" + ], + "description": "Creates or updates a resource type.", + "operationId": "ResourceTypeRegistrations_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/GetResourceTypeParameter" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceTypeRegistration" + }, + "description": "The required request body parameters supplied to the resource type registration CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "ResourceTypeRegistrations_CreateOrUpdate": { + "$ref": "./examples/ResourceTypeRegistrations_CreateOrUpdate.json" + } + }, + "responses": { + "200": { + "description": "Successfully updated the resource type.", + "schema": { + "$ref": "#/definitions/ResourceTypeRegistration" + } + }, + "201": { + "description": "Successfully created the resource type.", + "schema": { + "$ref": "#/definitions/ResourceTypeRegistration" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "ResourceTypeRegistration" + ], + "description": "Deletes a resource type", + "operationId": "ResourceTypeRegistrations_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/GetResourceTypeParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "ResourceTypeRegistrations_Delete": { + "$ref": "./examples/ResourceTypeRegistrations_Delete.json" + } + }, + "responses": { + "200": { + "description": "Successfully deleted the resource type." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourcetypeRegistrations": { + "get": { + "tags": [ + "ResourceTypeRegistration" + ], + "description": "Gets the list of the resource types for the given provider.", + "operationId": "ResourceTypeRegistrations_ListByProviderRegistration", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "ResourceTypeRegistrations_ListByProviderRegistration": { + "$ref": "./examples/ResourceTypeRegistrations_ListByProviderRegistration.json" + } + }, + "responses": { + "200": { + "description": "Successfully retrieved the resource types.", + "schema": { + "$ref": "#/definitions/ResourceTypeRegistrationArrayResponseWithContinuation" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourcetypeRegistrations/{resourceType}/skus/{sku}": { + "get": { + "tags": [ + "ResourceTypeSku" + ], + "description": "Gets the sku details for the given resource type and sku name.", + "operationId": "Skus_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/GetResourceTypeParameter" + }, + { + "$ref": "#/parameters/SkuParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "Skus_Get": { + "$ref": "./examples/Skus_Get.json" + } + }, + "responses": { + "200": { + "description": "Successfully retrieved the resource type sku.", + "schema": { + "$ref": "#/definitions/SkuResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ResourceTypeSku" + ], + "description": "Creates or updates the resource type skus in the given resource type.", + "operationId": "Skus_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/GetResourceTypeParameter" + }, + { + "$ref": "#/parameters/SkuParameter" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceTypeSku" + }, + "description": "The required body parameters supplied to the resource sku operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "Skus_CreateOrUpdate": { + "$ref": "./examples/Skus_CreateOrUpdate.json" + } + }, + "responses": { + "200": { + "description": "Successfully created or updated the resource type sku.", + "schema": { + "$ref": "#/definitions/SkuResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ResourceTypeSku" + ], + "description": "Deletes a resource type sku.", + "operationId": "Skus_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/GetResourceTypeParameter" + }, + { + "$ref": "#/parameters/SkuParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "Skus_Delete": { + "$ref": "./examples/Skus_Delete.json" + } + }, + "responses": { + "200": { + "description": "Successfully deleted the resource type sku." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourcetypeRegistrations/{resourceType}/resourcetypeRegistrations/{nestedResourceTypeFirst}/skus/{sku}": { + "get": { + "tags": [ + "ResourceTypeSku" + ], + "description": "Gets the sku details for the given resource type and sku name.", + "operationId": "Skus_GetNestedResourceTypeFirst", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/GetResourceTypeParameter" + }, + { + "$ref": "#/parameters/NestedResourceTypeFirstParameter" + }, + { + "$ref": "#/parameters/SkuParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "Skus_GetNestedResourceTypeFirst": { + "$ref": "./examples/Skus_GetNestedResourceTypeFirst.json" + } + }, + "responses": { + "200": { + "description": "Successfully retrieved the resource type sku.", + "schema": { + "$ref": "#/definitions/SkuResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ResourceTypeSku" + ], + "description": "Creates or updates the resource type skus in the given resource type.", + "operationId": "Skus_CreateOrUpdateNestedResourceTypeFirst", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/GetResourceTypeParameter" + }, + { + "$ref": "#/parameters/NestedResourceTypeFirstParameter" + }, + { + "$ref": "#/parameters/SkuParameter" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceTypeSku" + }, + "description": "The required body parameters supplied to the resource sku operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "Skus_CreateOrUpdateNestedResourceTypeFirst": { + "$ref": "./examples/Skus_CreateOrUpdateNestedResourceTypeFirst.json" + } + }, + "responses": { + "200": { + "description": "Successfully created or updated the resource type sku.", + "schema": { + "$ref": "#/definitions/SkuResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ResourceTypeSku" + ], + "description": "Deletes a resource type sku.", + "operationId": "Skus_DeleteNestedResourceTypeFirst", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/GetResourceTypeParameter" + }, + { + "$ref": "#/parameters/NestedResourceTypeFirstParameter" + }, + { + "$ref": "#/parameters/SkuParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "Skus_DeleteNestedResourceTypeFirst": { + "$ref": "./examples/Skus_DeleteNestedResourceTypeFirst.json" + } + }, + "responses": { + "200": { + "description": "Successfully deleted the resource type sku." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourcetypeRegistrations/{resourceType}/resourcetypeRegistrations/{nestedResourceTypeFirst}/resourcetypeRegistrations/{nestedResourceTypeSecond}/skus/{sku}": { + "get": { + "tags": [ + "ResourceTypeSku" + ], + "description": "Gets the sku details for the given resource type and sku name.", + "operationId": "Skus_GetNestedResourceTypeSecond", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/GetResourceTypeParameter" + }, + { + "$ref": "#/parameters/NestedResourceTypeFirstParameter" + }, + { + "$ref": "#/parameters/NestedResourceTypeSecondParameter" + }, + { + "$ref": "#/parameters/SkuParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "Skus_GetNestedResourceTypeSecond": { + "$ref": "./examples/Skus_GetNestedResourceTypeSecond.json" + } + }, + "responses": { + "200": { + "description": "Successfully retrieved the resource type sku.", + "schema": { + "$ref": "#/definitions/SkuResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ResourceTypeSku" + ], + "description": "Creates or updates the resource type skus in the given resource type.", + "operationId": "Skus_CreateOrUpdateNestedResourceTypeSecond", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/GetResourceTypeParameter" + }, + { + "$ref": "#/parameters/NestedResourceTypeFirstParameter" + }, + { + "$ref": "#/parameters/NestedResourceTypeSecondParameter" + }, + { + "$ref": "#/parameters/SkuParameter" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceTypeSku" + }, + "description": "The required body parameters supplied to the resource sku operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "Skus_CreateOrUpdateNestedResourceTypeSecond": { + "$ref": "./examples/Skus_CreateOrUpdateNestedResourceTypeSecond.json" + } + }, + "responses": { + "200": { + "description": "Successfully created or updated the resource type sku.", + "schema": { + "$ref": "#/definitions/SkuResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ResourceTypeSku" + ], + "description": "Deletes a resource type sku.", + "operationId": "Skus_DeleteNestedResourceTypeSecond", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/GetResourceTypeParameter" + }, + { + "$ref": "#/parameters/NestedResourceTypeFirstParameter" + }, + { + "$ref": "#/parameters/NestedResourceTypeSecondParameter" + }, + { + "$ref": "#/parameters/SkuParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "Skus_DeleteNestedResourceTypeSecond": { + "$ref": "./examples/Skus_DeleteNestedResourceTypeSecond.json" + } + }, + "responses": { + "200": { + "description": "Successfully deleted the resource type sku." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourcetypeRegistrations/{resourceType}/resourcetypeRegistrations/{nestedResourceTypeFirst}/resourcetypeRegistrations/{nestedResourceTypeSecond}/resourcetypeRegistrations/{nestedResourceTypeThird}/skus/{sku}": { + "get": { + "tags": [ + "ResourceTypeSku" + ], + "description": "Gets the sku details for the given resource type and sku name.", + "operationId": "Skus_GetNestedResourceTypeThird", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/GetResourceTypeParameter" + }, + { + "$ref": "#/parameters/NestedResourceTypeFirstParameter" + }, + { + "$ref": "#/parameters/NestedResourceTypeSecondParameter" + }, + { + "$ref": "#/parameters/NestedResourceTypeThirdParameter" + }, + { + "$ref": "#/parameters/SkuParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "Skus_GetNestedResourceTypeThird": { + "$ref": "./examples/Skus_GetNestedResourceTypeThird.json" + } + }, + "responses": { + "200": { + "description": "Successfully retrieved the resource type sku.", + "schema": { + "$ref": "#/definitions/SkuResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ResourceTypeSku" + ], + "description": "Creates or updates the resource type skus in the given resource type.", + "operationId": "Skus_CreateOrUpdateNestedResourceTypeThird", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/GetResourceTypeParameter" + }, + { + "$ref": "#/parameters/NestedResourceTypeFirstParameter" + }, + { + "$ref": "#/parameters/NestedResourceTypeSecondParameter" + }, + { + "$ref": "#/parameters/NestedResourceTypeThirdParameter" + }, + { + "$ref": "#/parameters/SkuParameter" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceTypeSku" + }, + "description": "The required body parameters supplied to the resource sku operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "Skus_CreateOrUpdateNestedResourceTypeThird": { + "$ref": "./examples/Skus_CreateOrUpdateNestedResourceTypeThird.json" + } + }, + "responses": { + "200": { + "description": "Successfully created or updated the resource type sku.", + "schema": { + "$ref": "#/definitions/SkuResource" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ResourceTypeSku" + ], + "description": "Deletes a resource type sku.", + "operationId": "Skus_DeleteNestedResourceTypeThird", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/GetResourceTypeParameter" + }, + { + "$ref": "#/parameters/NestedResourceTypeFirstParameter" + }, + { + "$ref": "#/parameters/NestedResourceTypeSecondParameter" + }, + { + "$ref": "#/parameters/NestedResourceTypeThirdParameter" + }, + { + "$ref": "#/parameters/SkuParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "Skus_DeleteNestedResourceTypeThird": { + "$ref": "./examples/Skus_DeleteNestedResourceTypeThird.json" + } + }, + "responses": { + "200": { + "description": "Successfully deleted the resource type sku." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourcetypeRegistrations/{resourceType}/skus": { + "get": { + "tags": [ + "ResourceTypeSku" + ], + "description": "Gets the list of skus for the given resource type.", + "operationId": "Skus_ListByResourceTypeRegistrations", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/GetResourceTypeParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "Skus_ListByResourceTypeRegistrations": { + "$ref": "./examples/Skus_ListByResourceTypeRegistrations.json" + } + }, + "responses": { + "200": { + "description": "SUccessfully retrieved the resource type skus.", + "schema": { + "$ref": "#/definitions/SkuResourceArrayResponseWithContinuation" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourcetypeRegistrations/{resourceType}/resourcetypeRegistrations/{nestedResourceTypeFirst}/skus": { + "get": { + "tags": [ + "ResourceTypeSku" + ], + "description": "Gets the list of skus for the given resource type.", + "operationId": "Skus_ListByResourceTypeRegistrationsNestedResourceTypeFirst", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/GetResourceTypeParameter" + }, + { + "$ref": "#/parameters/NestedResourceTypeFirstParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "Skus_ListByResourceTypeRegistrationsNestedResourceTypeFirst": { + "$ref": "./examples/Skus_ListByResourceTypeRegistrationsNestedResourceTypeFirst.json" + } + }, + "responses": { + "200": { + "description": "SUccessfully retrieved the resource type skus.", + "schema": { + "$ref": "#/definitions/SkuResourceArrayResponseWithContinuation" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourcetypeRegistrations/{resourceType}/resourcetypeRegistrations/{nestedResourceTypeFirst}/resourcetypeRegistrations/{nestedResourceTypeSecond}/skus": { + "get": { + "tags": [ + "ResourceTypeSku" + ], + "description": "Gets the list of skus for the given resource type.", + "operationId": "Skus_ListByResourceTypeRegistrationsNestedResourceTypeSecond", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/GetResourceTypeParameter" + }, + { + "$ref": "#/parameters/NestedResourceTypeFirstParameter" + }, + { + "$ref": "#/parameters/NestedResourceTypeSecondParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "Skus_ListByResourceTypeRegistrationsNestedResourceTypeSecond": { + "$ref": "./examples/Skus_ListByResourceTypeRegistrationsNestedResourceTypeSecond.json" + } + }, + "responses": { + "200": { + "description": "SUccessfully retrieved the resource type skus.", + "schema": { + "$ref": "#/definitions/SkuResourceArrayResponseWithContinuation" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourcetypeRegistrations/{resourceType}/resourcetypeRegistrations/{nestedResourceTypeFirst}/resourcetypeRegistrations/{nestedResourceTypeSecond}/resourcetypeRegistrations/{nestedResourceTypeThird}/skus": { + "get": { + "tags": [ + "ResourceTypeSku" + ], + "description": "Gets the list of skus for the given resource type.", + "operationId": "Skus_ListByResourceTypeRegistrationsNestedResourceTypeThird", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/GetResourceTypeParameter" + }, + { + "$ref": "#/parameters/NestedResourceTypeFirstParameter" + }, + { + "$ref": "#/parameters/NestedResourceTypeSecondParameter" + }, + { + "$ref": "#/parameters/NestedResourceTypeThirdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "Skus_ListByResourceTypeRegistrationsNestedResourceTypeThird": { + "$ref": "./examples/Skus_ListByResourceTypeRegistrationsNestedResourceTypeThird.json" + } + }, + "responses": { + "200": { + "description": "SUccessfully retrieved the resource type skus.", + "schema": { + "$ref": "#/definitions/SkuResourceArrayResponseWithContinuation" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourceActions/{resourceActionName}/deleteResources": { + "post": { + "tags": [ + "ResourceActions" + ], + "description": "Deletes resources.", + "operationId": "ResourceActions_DeleteResources", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/ResourceActionParameter" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceManagementAction" + }, + "description": "The properties supplied to the DeleteResources operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Resource management action started.", + "schema": { + "$ref": "#/definitions/ResourceManagementAction" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ResourceActions_DeleteResources": { + "$ref": "./examples/ResourceActions_DeleteResources.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + } + }, + "definitions": { + "ProvisioningState": { + "enum": [ + "NotSpecified", + "Accepted", + "Running", + "Creating", + "Created", + "Deleting", + "Deleted", + "Canceled", + "Failed", + "Succeeded", + "MovingResources", + "TransientFailure", + "RolloutInProgress" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "TrafficRegions": { + "type": "object", + "properties": { + "regions": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "CustomRolloutSpecification": { + "required": [ + "canary" + ], + "type": "object", + "properties": { + "canary": { + "allOf": [ + { + "$ref": "#/definitions/TrafficRegions" + } + ] + }, + "providerRegistration": { + "allOf": [ + { + "$ref": "#/definitions/ProviderRegistration" + } + ] + }, + "resourceTypeRegistrations": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceTypeRegistration" + } + } + } + }, + "TypedErrorInfo": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "info": { + "type": "object", + "readOnly": true + } + } + }, + "ExtendedErrorInfo": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "target": { + "type": "string" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ExtendedErrorInfo" + } + }, + "additionalInfo": { + "type": "array", + "items": { + "$ref": "#/definitions/TypedErrorInfo" + } + } + } + }, + "CheckinManifestParams": { + "type": "object", + "properties": { + "environment": { + "type": "string", + "description": "The environment supplied to the checkin manifest operation." + }, + "baselineArmManifestLocation": { + "type": "string", + "description": "The baseline ARM manifest location supplied to the checkin manifest operation." + } + }, + "required": [ + "baselineArmManifestLocation", + "environment" + ] + }, + "RolloutStatusBase": { + "type": "object", + "properties": { + "completedRegions": { + "type": "array", + "items": { + "type": "string" + } + }, + "failedOrSkippedRegions": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ExtendedErrorInfo" + } + } + } + }, + "CustomRolloutProperties": { + "type": "object", + "required": [ + "specification" + ], + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioned state of the resource." + }, + "specification": { + "allOf": [ + { + "$ref": "#/definitions/CustomRolloutSpecification" + } + ] + }, + "status": { + "allOf": [ + { + "$ref": "#/definitions/CustomRolloutStatus" + } + ] + } + } + }, + "CustomRollout": { + "description": "Rollout details.", + "type": "object", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/CustomRolloutProperties" + } + ], + "description": "Properties of the rollout." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "InnerError": { + "description": "Inner error containing list of errors.", + "type": "object", + "properties": { + "code": { + "description": "Specific error code than was provided by the containing error.", + "type": "string", + "readOnly": true + }, + "innerError": { + "description": "Object containing more specific information than the current object about the error.", + "type": "object", + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "Error": { + "description": "Standard error object.", + "type": "object", + "properties": { + "code": { + "description": "Server-defined set of error codes.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Human-readable representation of the error.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "Target of the error.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Array of details about specific errors that led to this reported error.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + }, + "readOnly": true + }, + "innerError": { + "description": "Object containing more specific information than the current object about the error.", + "allOf": [ + { + "$ref": "#/definitions/InnerError" + } + ], + "readOnly": true + } + } + }, + "ErrorResponse": { + "description": "Standard error response.", + "type": "object", + "properties": { + "error": { + "description": "Standard error object.", + "allOf": [ + { + "$ref": "#/definitions/Error" + } + ] + } + } + }, + "CustomRolloutArrayResponseWithContinuation": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomRollout" + } + }, + "nextLink": { + "description": "The URL to get to the next set of results, if there are any.", + "type": "string" + } + } + }, + "TrafficRegionRolloutConfiguration": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrafficRegions" + } + ], + "properties": { + "waitDuration": { + "format": "duration", + "type": "string" + } + } + }, + "ExpeditedRolloutDefinition": { + "description": "Expedited rollout configuration.", + "type": "object", + "properties": { + "enabled": { + "description": "Indicates whether expedited rollout is enabled/disabled", + "type": "boolean" + } + } + }, + "DefaultRolloutSpecification": { + "type": "object", + "properties": { + "expeditedRollout": { + "allOf": [ + { + "$ref": "#/definitions/ExpeditedRolloutDefinition" + } + ] + }, + "canary": { + "allOf": [ + { + "$ref": "#/definitions/CanaryTrafficRegionRolloutConfiguration" + } + ] + }, + "lowTraffic": { + "allOf": [ + { + "$ref": "#/definitions/TrafficRegionRolloutConfiguration" + } + ] + }, + "mediumTraffic": { + "allOf": [ + { + "$ref": "#/definitions/TrafficRegionRolloutConfiguration" + } + ] + }, + "highTraffic": { + "allOf": [ + { + "$ref": "#/definitions/TrafficRegionRolloutConfiguration" + } + ] + }, + "restOfTheWorldGroupOne": { + "allOf": [ + { + "$ref": "#/definitions/TrafficRegionRolloutConfiguration" + } + ] + }, + "restOfTheWorldGroupTwo": { + "allOf": [ + { + "$ref": "#/definitions/TrafficRegionRolloutConfiguration" + } + ] + }, + "providerRegistration": { + "allOf": [ + { + "$ref": "#/definitions/ProviderRegistration" + } + ] + }, + "resourceTypeRegistrations": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceTypeRegistration" + } + } + } + }, + "DefaultRolloutStatus": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RolloutStatusBase" + } + ], + "properties": { + "nextTrafficRegion": { + "enum": [ + "NotSpecified", + "Canary", + "LowTraffic", + "MediumTraffic", + "HighTraffic", + "None", + "RestOfTheWorldGroupOne", + "RestOfTheWorldGroupTwo" + ], + "type": "string", + "x-ms-enum": { + "name": "TrafficRegionCategory", + "modelAsString": true + } + }, + "nextTrafficRegionScheduledTime": { + "format": "date-time", + "type": "string" + }, + "subscriptionReregistrationResult": { + "enum": [ + "NotApplicable", + "ConditionalUpdate", + "ForcedUpdate", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "SubscriptionReregistrationResult", + "modelAsString": true + } + } + } + }, + "DefaultRolloutProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioned state of the resource." + }, + "specification": { + "allOf": [ + { + "$ref": "#/definitions/DefaultRolloutSpecification" + } + ] + }, + "status": { + "allOf": [ + { + "$ref": "#/definitions/DefaultRolloutStatus" + } + ] + } + } + }, + "DefaultRollout": { + "description": "Default rollout definition.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/DefaultRolloutProperties" + } + ], + "description": "Properties of the rollout." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "DefaultRolloutArrayResponseWithContinuation": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DefaultRollout" + } + }, + "nextLink": { + "description": "The URL to get to the next set of results, if there are any.", + "type": "string" + } + } + }, + "ResourceProviderAuthentication": { + "required": [ + "allowedAudiences" + ], + "type": "object", + "properties": { + "allowedAudiences": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ResourceProviderAuthorization": { + "type": "object", + "properties": { + "applicationId": { + "type": "string" + }, + "roleDefinitionId": { + "type": "string" + }, + "managedByRoleDefinitionId": { + "type": "string" + } + } + }, + "FeaturesRule": { + "required": [ + "requiredFeaturesPolicy" + ], + "type": "object", + "properties": { + "requiredFeaturesPolicy": { + "enum": [ + "Any", + "All" + ], + "type": "string", + "x-ms-enum": { + "name": "FeaturesPolicy", + "modelAsString": true + } + } + } + }, + "RequestHeaderOptions": { + "type": "object", + "properties": { + "optInHeaders": { + "enum": [ + "NotSpecified", + "SignedUserToken", + "ClientGroupMembership", + "SignedAuxiliaryTokens", + "UnboundedClientGroupMembership" + ], + "type": "string", + "x-ms-enum": { + "name": "OptInHeaderType", + "modelAsString": true + } + } + } + }, + "AuthorizationActionMapping": { + "type": "object", + "properties": { + "original": { + "type": "string" + }, + "desired": { + "type": "string" + } + } + }, + "LinkedAccessCheck": { + "type": "object", + "properties": { + "actionName": { + "type": "string" + }, + "linkedProperty": { + "type": "string" + }, + "linkedAction": { + "type": "string" + }, + "linkedActionVerb": { + "type": "string" + }, + "linkedType": { + "type": "string" + } + } + }, + "LoggingHiddenPropertyPath": { + "type": "object", + "properties": { + "hiddenPathsOnRequest": { + "type": "array", + "items": { + "type": "string" + } + }, + "hiddenPathsOnResponse": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "LoggingRule": { + "required": [ + "action", + "detailLevel", + "direction" + ], + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "direction": { + "enum": [ + "None", + "Request", + "Response" + ], + "type": "string", + "x-ms-enum": { + "name": "LoggingDirections", + "modelAsString": true + } + }, + "detailLevel": { + "enum": [ + "None", + "Body" + ], + "type": "string", + "x-ms-enum": { + "name": "LoggingDetails", + "modelAsString": true + } + }, + "hiddenPropertyPaths": { + "allOf": [ + { + "$ref": "#/definitions/LoggingHiddenPropertyPath" + } + ] + } + } + }, + "ThrottlingMetric": { + "required": [ + "limit", + "type" + ], + "type": "object", + "properties": { + "type": { + "enum": [ + "NotSpecified", + "NumberOfRequests", + "NumberOfResources" + ], + "type": "string", + "x-ms-enum": { + "name": "ThrottlingMetricType", + "modelAsString": true + } + }, + "limit": { + "format": "int64", + "type": "integer" + }, + "interval": { + "format": "duration", + "type": "string" + } + } + }, + "ThrottlingRule": { + "required": [ + "action", + "metrics" + ], + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "metrics": { + "type": "array", + "items": { + "$ref": "#/definitions/ThrottlingMetric" + } + }, + "requiredFeatures": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ResourceProviderEndpoint": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "apiVersions": { + "type": "array", + "items": { + "type": "string" + } + }, + "endpointUri": { + "type": "string" + }, + "locations": { + "type": "array", + "items": { + "type": "string" + } + }, + "requiredFeatures": { + "type": "array", + "items": { + "type": "string" + } + }, + "featuresRule": { + "allOf": [ + { + "$ref": "#/definitions/FeaturesRule" + } + ] + }, + "timeout": { + "format": "duration", + "type": "string" + }, + "endpointType": { + "enum": [ + "NotSpecified", + "Canary", + "Production", + "TestInProduction" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointType", + "modelAsString": true + } + } + } + }, + "IdentityManagementProperties": { + "type": "object", + "properties": { + "type": { + "enum": [ + "NotSpecified", + "SystemAssigned", + "UserAssigned", + "Actor", + "DelegatedResourceIdentity" + ], + "type": "string", + "x-ms-enum": { + "name": "IdentityManagementTypes", + "modelAsString": true + } + }, + "applicationId": { + "type": "string" + } + } + }, + "IdentityManagement": { + "type": "object", + "properties": { + "type": { + "enum": [ + "NotSpecified", + "SystemAssigned", + "UserAssigned", + "Actor", + "DelegatedResourceIdentity" + ], + "type": "string", + "x-ms-enum": { + "name": "IdentityManagementTypes", + "modelAsString": true + } + } + } + }, + "SubscriptionStateRule": { + "type": "object", + "properties": { + "state": { + "enum": [ + "NotDefined", + "Enabled", + "Warned", + "PastDue", + "Disabled", + "Deleted" + ], + "type": "string", + "x-ms-enum": { + "name": "SubscriptionState", + "modelAsString": true + } + }, + "allowedActions": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "CustomRolloutStatus": { + "type": "object", + "properties": { + "completedRegions": { + "type": "array", + "items": { + "type": "string" + } + }, + "failedOrSkippedRegions": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ExtendedErrorInfo" + } + } + } + }, + "CanaryTrafficRegionRolloutConfiguration": { + "type": "object", + "properties": { + "skipRegions": { + "type": "array", + "items": { + "type": "string" + } + }, + "regions": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ServiceTreeInfo": { + "type": "object", + "properties": { + "serviceId": { + "type": "string" + }, + "componentId": { + "type": "string" + } + } + }, + "TemplateDeploymentPolicy": { + "required": [ + "capabilities", + "preflightOptions" + ], + "type": "object", + "properties": { + "capabilities": { + "enum": [ + "Default", + "Preflight" + ], + "type": "string", + "x-ms-enum": { + "name": "TemplateDeploymentCapabilities", + "modelAsString": true + } + }, + "preflightOptions": { + "enum": [ + "None", + "ValidationRequests", + "DeploymentRequests", + "TestOnly", + "RegisteredOnly" + ], + "type": "string", + "x-ms-enum": { + "name": "TemplateDeploymentPreflightOptions", + "modelAsString": true + } + } + } + }, + "ExtendedLocationOptions": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "supportedPolicy": { + "type": "string" + } + } + }, + "LinkedOperationRule": { + "required": [ + "linkedAction", + "linkedOperation" + ], + "type": "object", + "properties": { + "linkedOperation": { + "enum": [ + "None", + "CrossResourceGroupResourceMove", + "CrossSubscriptionResourceMove" + ], + "type": "string", + "x-ms-enum": { + "name": "LinkedOperation", + "modelAsString": true + } + }, + "linkedAction": { + "enum": [ + "NotSpecified", + "Blocked", + "Validate", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "LinkedAction", + "modelAsString": true + } + } + } + }, + "ResourceType": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "routingType": { + "enum": [ + "Default", + "ProxyOnly", + "HostBased", + "Extension", + "Tenant", + "Fanout", + "LocationBased", + "Failover", + "CascadeExtension" + ], + "type": "string", + "x-ms-enum": { + "name": "RoutingType", + "modelAsString": true + } + }, + "resourceValidation": { + "enum": [ + "NotSpecified", + "ReservedWords", + "ProfaneWords" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceValidation", + "modelAsString": true + } + }, + "allowedUnauthorizedActions": { + "type": "array", + "items": { + "type": "string" + } + }, + "authorizationActionMappings": { + "type": "array", + "items": { + "$ref": "#/definitions/AuthorizationActionMapping" + } + }, + "linkedAccessChecks": { + "type": "array", + "items": { + "$ref": "#/definitions/LinkedAccessCheck" + } + }, + "defaultApiVersion": { + "type": "string" + }, + "loggingRules": { + "type": "array", + "items": { + "$ref": "#/definitions/LoggingRule" + } + }, + "throttlingRules": { + "type": "array", + "items": { + "$ref": "#/definitions/ThrottlingRule" + } + }, + "endpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceProviderEndpoint" + } + }, + "marketplaceType": { + "enum": [ + "NotSpecified", + "AddOn", + "Bypass", + "Store" + ], + "type": "string" + }, + "identityManagement": { + "allOf": [ + { + "$ref": "#/definitions/IdentityManagement" + } + ] + }, + "metadata": {}, + "requiredFeatures": { + "type": "array", + "items": { + "type": "string" + } + }, + "featuresRule": { + "allOf": [ + { + "$ref": "#/definitions/FeaturesRule" + } + ] + }, + "subscriptionStateRules": { + "type": "array", + "items": { + "$ref": "#/definitions/SubscriptionStateRule" + } + }, + "serviceTreeInfos": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceTreeInfo" + } + }, + "requestHeaderOptions": { + "allOf": [ + { + "$ref": "#/definitions/RequestHeaderOptions" + } + ] + }, + "skuLink": { + "type": "string" + }, + "disallowedActionVerbs": { + "type": "array", + "items": { + "type": "string" + } + }, + "templateDeploymentPolicy": { + "allOf": [ + { + "$ref": "#/definitions/TemplateDeploymentPolicy" + } + ] + }, + "extendedLocations": { + "type": "array", + "items": { + "$ref": "#/definitions/ExtendedLocationOptions" + } + }, + "linkedOperationRules": { + "type": "array", + "items": { + "$ref": "#/definitions/LinkedOperationRule" + } + }, + "resourceDeletionPolicy": { + "enum": [ + "NotSpecified", + "Cascade", + "Force" + ], + "type": "string", + "x-ms-enum": { + "name": "ManifestResourceDeletionPolicy", + "modelAsString": true + } + } + } + }, + "ResourceProviderManagement": { + "type": "object", + "properties": { + "schemaOwners": { + "type": "array", + "items": { + "type": "string" + } + }, + "manifestOwners": { + "type": "array", + "items": { + "type": "string" + } + }, + "incidentRoutingService": { + "type": "string" + }, + "incidentRoutingTeam": { + "type": "string" + }, + "incidentContactEmail": { + "type": "string" + }, + "serviceTreeInfos": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceTreeInfo" + } + }, + "resourceAccessPolicy": { + "enum": [ + "NotSpecified", + "AcisReadAllowed", + "AcisActionAllowed" + ], + "type": "string" + }, + "resourceAccessRoles": { + "type": "array", + "items": {} + } + } + }, + "ResourceProviderCapabilities": { + "required": [ + "effect", + "quotaId" + ], + "type": "object", + "properties": { + "quotaId": { + "type": "string" + }, + "effect": { + "enum": [ + "NotSpecified", + "Allow", + "Disallow" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceProviderCapabilitiesEffect", + "modelAsString": true + } + }, + "requiredFeatures": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ReRegisterSubscriptionMetadata": { + "required": [ + "enabled" + ], + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "concurrencyLimit": { + "format": "int32", + "type": "integer" + } + } + }, + "ResourceProviderManifest": { + "type": "object", + "properties": { + "providerAuthentication": { + "allOf": [ + { + "$ref": "#/definitions/ResourceProviderAuthentication" + } + ] + }, + "providerAuthorizations": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceProviderAuthorization" + } + }, + "namespace": { + "type": "string" + }, + "providerVersion": { + "type": "string" + }, + "providerType": { + "enum": [ + "NotSpecified", + "Internal", + "External", + "Hidden", + "RegistrationFree", + "LegacyRegistrationRequired", + "TenantOnly", + "AuthorizationFree" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceProviderType", + "modelAsString": true + } + }, + "requiredFeatures": { + "type": "array", + "items": { + "type": "string" + } + }, + "featuresRule": { + "allOf": [ + { + "$ref": "#/definitions/FeaturesRule" + } + ] + }, + "requestHeaderOptions": { + "allOf": [ + { + "$ref": "#/definitions/RequestHeaderOptions" + } + ] + }, + "resourceTypes": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceType" + } + }, + "management": { + "allOf": [ + { + "$ref": "#/definitions/ResourceProviderManagement" + } + ] + }, + "capabilities": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceProviderCapabilities" + } + }, + "metadata": {}, + "globalNotificationEndpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceProviderEndpoint" + } + }, + "reRegisterSubscriptionMetadata": { + "allOf": [ + { + "$ref": "#/definitions/ReRegisterSubscriptionMetadata" + } + ] + } + } + }, + "CheckinManifestInfo": { + "required": [ + "isCheckedIn", + "statusMessage" + ], + "type": "object", + "properties": { + "isCheckedIn": { + "type": "boolean" + }, + "statusMessage": { + "type": "string" + }, + "pullRequest": { + "type": "string" + }, + "commitId": { + "type": "string" + } + } + }, + "NotificationEndpoint": { + "type": "object", + "properties": { + "notificationDestination": { + "type": "string" + }, + "locations": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "NotificationRegistrationProperties": { + "type": "object", + "properties": { + "notificationMode": { + "enum": [ + "NotSpecified", + "EventHub", + "WebHook" + ], + "type": "string", + "x-ms-enum": { + "name": "NotificationMode", + "modelAsString": true + } + }, + "messageScope": { + "enum": [ + "NotSpecified", + "RegisteredSubscriptions" + ], + "type": "string", + "x-ms-enum": { + "name": "MessageScope", + "modelAsString": true + } + }, + "includedEvents": { + "type": "array", + "items": { + "type": "string" + } + }, + "notificationEndpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/NotificationEndpoint" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioned state of the resource." + } + } + }, + "NotificationRegistration": { + "description": "The notification registration definition.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/NotificationRegistrationProperties" + } + ] + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "NotificationRegistrationArrayResponseWithContinuation": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NotificationRegistration" + } + }, + "nextLink": { + "description": "The URL to get to the next set of results, if there are any.", + "type": "string" + } + } + }, + "OperationsDisplayDefinition": { + "required": [ + "description", + "operation", + "provider", + "resource" + ], + "type": "object", + "properties": { + "provider": { + "type": "string" + }, + "resource": { + "type": "string" + }, + "operation": { + "type": "string" + }, + "description": { + "type": "string" + } + } + }, + "OperationsDefinition": { + "required": [ + "display", + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the operation." + }, + "isDataAction": { + "type": "boolean", + "description": "Indicates whether the operation applies to data-plane." + }, + "origin": { + "enum": [ + "NotSpecified", + "User", + "System" + ], + "type": "string" + }, + "display": { + "description": "Display information of the operation.", + "allOf": [ + { + "$ref": "#/definitions/OperationsDisplayDefinition" + } + ] + }, + "actionType": { + "enum": [ + "NotSpecified", + "Internal" + ], + "type": "string" + }, + "properties": {} + }, + "description": "Properties of an Operation." + }, + "OperationsContent": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Operations content.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationsDefinition" + } + }, + "x-ms-azure-resource": true + }, + "LocalizedOperationDisplayDefinition": { + "required": [ + "default" + ], + "type": "object", + "properties": { + "default": { + "description": "Display information of the operation.", + "allOf": [ + { + "$ref": "#/definitions/OperationsDisplayDefinition" + } + ] + }, + "en": { + "description": "Display information of the operation for en locale.", + "allOf": [ + { + "$ref": "#/definitions/OperationsDisplayDefinition" + } + ] + }, + "cs": { + "description": "Display information of the operation for cs locale.", + "allOf": [ + { + "$ref": "#/definitions/OperationsDisplayDefinition" + } + ] + }, + "de": { + "description": "Display information of the operation for de locale.", + "allOf": [ + { + "$ref": "#/definitions/OperationsDisplayDefinition" + } + ] + }, + "es": { + "description": "Display information of the operation for es locale.", + "allOf": [ + { + "$ref": "#/definitions/OperationsDisplayDefinition" + } + ] + }, + "fr": { + "description": "Display information of the operation for fr locale.", + "allOf": [ + { + "$ref": "#/definitions/OperationsDisplayDefinition" + } + ] + }, + "hu": { + "description": "Display information of the operation for hu locale.", + "allOf": [ + { + "$ref": "#/definitions/OperationsDisplayDefinition" + } + ] + }, + "it": { + "description": "Display information of the operation for it locale.", + "allOf": [ + { + "$ref": "#/definitions/OperationsDisplayDefinition" + } + ] + }, + "ja": { + "description": "Display information of the operation for ja locale.", + "allOf": [ + { + "$ref": "#/definitions/OperationsDisplayDefinition" + } + ] + }, + "ko": { + "description": "Display information of the operation for ko locale.", + "allOf": [ + { + "$ref": "#/definitions/OperationsDisplayDefinition" + } + ] + }, + "nl": { + "description": "Display information of the operation for nl locale.", + "allOf": [ + { + "$ref": "#/definitions/OperationsDisplayDefinition" + } + ] + }, + "pl": { + "description": "Display information of the operation for pl locale.", + "allOf": [ + { + "$ref": "#/definitions/OperationsDisplayDefinition" + } + ] + }, + "ptBR": { + "description": "Display information of the operation for pt-BR locale.", + "allOf": [ + { + "$ref": "#/definitions/OperationsDisplayDefinition" + } + ] + }, + "ptPT": { + "description": "Display information of the operation for pt-PT locale.", + "allOf": [ + { + "$ref": "#/definitions/OperationsDisplayDefinition" + } + ] + }, + "ru": { + "description": "Display information of the operation for ru locale.", + "allOf": [ + { + "$ref": "#/definitions/OperationsDisplayDefinition" + } + ] + }, + "sv": { + "description": "Display information of the operation for sv locale.", + "allOf": [ + { + "$ref": "#/definitions/OperationsDisplayDefinition" + } + ] + }, + "zhHans": { + "description": "Display information of the operation for zh-Hans locale.", + "allOf": [ + { + "$ref": "#/definitions/OperationsDisplayDefinition" + } + ] + }, + "zhHant": { + "description": "Display information of the operation for zh-Hant locale.", + "allOf": [ + { + "$ref": "#/definitions/OperationsDisplayDefinition" + } + ] + } + } + }, + "LocalizedOperationDefinition": { + "required": [ + "display", + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the operation." + }, + "isDataAction": { + "type": "boolean", + "description": "Indicates whether the operation applies to data-plane." + }, + "origin": { + "enum": [ + "NotSpecified", + "User", + "System" + ], + "type": "string" + }, + "display": { + "description": "Display information of the operation.", + "allOf": [ + { + "$ref": "#/definitions/LocalizedOperationDisplayDefinition" + } + ] + }, + "actionType": { + "enum": [ + "NotSpecified", + "Internal" + ], + "type": "string" + }, + "properties": {} + } + }, + "OperationsContentProperties": { + "type": "object", + "properties": { + "contents": { + "type": "array", + "description": "Operations content.", + "x-ms-client-flatten": true, + "items": { + "$ref": "#/definitions/LocalizedOperationDefinition" + } + } + } + }, + "OperationsPutContent": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "type": "object", + "properties": { + "properties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OperationsContentProperties" + } + ] + } + }, + "x-ms-azure-resource": true + }, + "OperationsDefinitionArrayResponseWithContinuation": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/OperationsDefinition" + } + }, + "nextLink": { + "description": "The URL to get to the next set of results, if there are any.", + "type": "string" + } + } + }, + "LightHouseAuthorization": { + "required": [ + "principalId", + "roleDefinitionId" + ], + "type": "object", + "properties": { + "principalId": { + "type": "string" + }, + "roleDefinitionId": { + "type": "string" + } + } + }, + "ThirdPartyProviderAuthorization": { + "type": "object", + "properties": { + "authorizations": { + "type": "array", + "items": { + "$ref": "#/definitions/LightHouseAuthorization" + } + }, + "managedByTenantId": { + "type": "string" + } + } + }, + "ProviderHubMetadata": { + "type": "object", + "properties": { + "providerAuthorizations": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceProviderAuthorization" + } + }, + "providerAuthentication": { + "allOf": [ + { + "$ref": "#/definitions/ResourceProviderAuthentication" + } + ] + }, + "thirdPartyProviderAuthorization": { + "allOf": [ + { + "$ref": "#/definitions/ThirdPartyProviderAuthorization" + } + ] + } + } + }, + "SubscriptionStateOverrideAction": { + "required": [ + "action", + "state" + ], + "type": "object", + "properties": { + "state": { + "enum": [ + "Registered", + "Unregistered", + "Warned", + "Suspended", + "Deleted", + "WarnedToRegistered", + "WarnedToSuspended", + "WarnedToDeleted", + "WarnedToUnregistered", + "SuspendedToRegistered", + "SuspendedToWarned", + "SuspendedToDeleted", + "SuspendedToUnregistered" + ], + "type": "string", + "x-ms-enum": { + "name": "SubscriptionTransitioningState", + "modelAsString": true + } + }, + "action": { + "enum": [ + "NotDefined", + "DeleteAllResources", + "SoftDeleteAllResources", + "NoOp", + "BillingCancellation", + "UndoSoftDelete" + ], + "type": "string", + "x-ms-enum": { + "name": "SubscriptionNotificationOperation", + "modelAsString": true + } + } + } + }, + "SubscriptionLifecycleNotificationSpecifications": { + "type": "object", + "properties": { + "subscriptionStateOverrideActions": { + "type": "array", + "items": { + "$ref": "#/definitions/SubscriptionStateOverrideAction" + } + }, + "softDeleteTTL": { + "format": "duration", + "type": "string" + } + } + }, + "TemplateDeploymentOptions": { + "type": "object", + "properties": { + "preflightSupported": { + "type": "boolean" + }, + "preflightOptions": { + "type": "array", + "items": { + "enum": [ + "None", + "ContinueDeploymentOnFailure", + "DefaultValidationOnly" + ], + "type": "string", + "x-ms-enum": { + "name": "PreflightOption", + "modelAsString": true + } + } + } + } + }, + "ResourceProviderManifestProperties": { + "type": "object", + "properties": { + "providerAuthentication": { + "allOf": [ + { + "$ref": "#/definitions/ResourceProviderAuthentication" + } + ] + }, + "providerAuthorizations": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceProviderAuthorization" + } + }, + "namespace": { + "type": "string" + }, + "providerVersion": { + "type": "string" + }, + "providerType": { + "enum": [ + "NotSpecified", + "Internal", + "External", + "Hidden", + "RegistrationFree", + "LegacyRegistrationRequired", + "TenantOnly", + "AuthorizationFree" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceProviderType", + "modelAsString": true + } + }, + "requiredFeatures": { + "type": "array", + "items": { + "type": "string" + } + }, + "featuresRule": { + "allOf": [ + { + "$ref": "#/definitions/FeaturesRule" + } + ] + }, + "requestHeaderOptions": { + "allOf": [ + { + "$ref": "#/definitions/RequestHeaderOptions" + } + ] + }, + "management": { + "allOf": [ + { + "$ref": "#/definitions/ResourceProviderManagement" + } + ] + }, + "capabilities": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceProviderCapabilities" + } + }, + "metadata": {}, + "templateDeploymentOptions": { + "allOf": [ + { + "$ref": "#/definitions/TemplateDeploymentOptions" + } + ] + } + } + }, + "ProviderRegistrationProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceProviderManifestProperties" + } + ], + "properties": { + "providerHubMetadata": { + "allOf": [ + { + "$ref": "#/definitions/ProviderHubMetadata" + } + ] + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioned state of the resource." + }, + "subscriptionLifecycleNotificationSpecifications": { + "allOf": [ + { + "$ref": "#/definitions/SubscriptionLifecycleNotificationSpecifications" + } + ] + } + } + }, + "ProviderRegistration": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/ProviderRegistrationProperties" + } + ] + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "ProviderRegistrationArrayResponseWithContinuation": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ProviderRegistration" + } + }, + "nextLink": { + "description": "The URL to get to the next set of results, if there are any.", + "type": "string" + } + } + }, + "ResourceTypeExtension": { + "type": "object", + "properties": { + "endpointUri": { + "type": "string" + }, + "extensionCategories": { + "type": "array", + "items": { + "enum": [ + "NotSpecified", + "ResourceCreationValidate", + "ResourceCreationBegin", + "ResourceCreationCompleted", + "ResourceReadValidate", + "ResourceReadBegin", + "ResourcePatchValidate", + "ResourcePatchCompleted", + "ResourceDeletionValidate", + "ResourceDeletionBegin", + "ResourceDeletionCompleted", + "ResourcePostAction", + "SubscriptionLifecycleNotification", + "ResourcePatchBegin", + "ResourceMoveBegin", + "ResourceMoveCompleted" + ], + "type": "string", + "x-ms-enum": { + "name": "ExtensionCategory", + "modelAsString": true + } + } + }, + "timeout": { + "format": "duration", + "type": "string" + } + } + }, + "ResourceTypeEndpoint": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "apiVersions": { + "type": "array", + "items": { + "type": "string" + } + }, + "locations": { + "type": "array", + "items": { + "type": "string" + } + }, + "requiredFeatures": { + "type": "array", + "items": { + "type": "string" + } + }, + "featuresRule": { + "allOf": [ + { + "$ref": "#/definitions/FeaturesRule" + } + ] + }, + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceTypeExtension" + } + }, + "timeout": { + "format": "duration", + "type": "string" + }, + "endpointType": { + "enum": [ + "NotSpecified", + "Canary", + "Production", + "TestInProduction" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointType", + "modelAsString": true + } + } + } + }, + "ExtensionOptions": { + "type": "object", + "properties": { + "request": { + "type": "array", + "items": { + "enum": [ + "NotSpecified", + "DoNotMergeExistingReadOnlyAndSecretProperties", + "IncludeInternalMetadata" + ], + "type": "string", + "x-ms-enum": { + "name": "ExtensionOptionType", + "modelAsString": true + } + } + }, + "response": { + "type": "array", + "items": { + "enum": [ + "NotSpecified", + "DoNotMergeExistingReadOnlyAndSecretProperties", + "IncludeInternalMetadata" + ], + "type": "string", + "x-ms-enum": { + "name": "ExtensionOptionType", + "modelAsString": true + } + } + } + } + }, + "ResourceTypeExtensionOptions": { + "type": "object", + "properties": { + "resourceCreationBegin": { + "allOf": [ + { + "$ref": "#/definitions/ExtensionOptions" + } + ] + } + } + }, + "SwaggerSpecification": { + "type": "object", + "properties": { + "apiVersions": { + "type": "array", + "items": { + "type": "string" + } + }, + "swaggerSpecFolderUri": { + "type": "string" + } + } + }, + "CheckNameAvailabilitySpecifications": { + "type": "object", + "properties": { + "enableDefaultValidation": { + "type": "boolean" + }, + "resourceTypesWithCustomValidation": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ResourceMovePolicy": { + "type": "object", + "properties": { + "validationRequired": { + "type": "boolean" + }, + "crossResourceGroupMoveEnabled": { + "type": "boolean" + }, + "crossSubscriptionMoveEnabled": { + "type": "boolean" + } + } + }, + "ResourceConcurrencyControlOption": { + "type": "object", + "properties": { + "policy": { + "enum": [ + "NotSpecified", + "SynchronizeBeginExtension" + ], + "type": "string", + "x-ms-enum": { + "name": "Policy", + "modelAsString": true + } + } + } + }, + "ResourceGraphConfiguration": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "apiVersion": { + "type": "string" + } + } + }, + "ResourceTypeRegistrationProperties": { + "type": "object", + "properties": { + "routingType": { + "enum": [ + "Default", + "ProxyOnly", + "HostBased", + "Extension", + "Tenant", + "Fanout", + "LocationBased", + "Failover", + "CascadeExtension" + ], + "type": "string", + "x-ms-enum": { + "name": "RoutingType", + "modelAsString": true + } + }, + "regionality": { + "enum": [ + "NotSpecified", + "Global", + "Regional" + ], + "type": "string", + "x-ms-enum": { + "name": "Regionality", + "modelAsString": true + } + }, + "endpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceTypeEndpoint" + } + }, + "extensionOptions": { + "allOf": [ + { + "$ref": "#/definitions/ResourceTypeExtensionOptions" + } + ] + }, + "marketplaceType": { + "enum": [ + "NotSpecified", + "AddOn", + "Bypass", + "Store" + ], + "type": "string" + }, + "swaggerSpecifications": { + "type": "array", + "items": { + "$ref": "#/definitions/SwaggerSpecification" + } + }, + "allowedUnauthorizedActions": { + "type": "array", + "items": { + "type": "string" + } + }, + "authorizationActionMappings": { + "type": "array", + "items": { + "$ref": "#/definitions/AuthorizationActionMapping" + } + }, + "linkedAccessChecks": { + "type": "array", + "items": { + "$ref": "#/definitions/LinkedAccessCheck" + } + }, + "defaultApiVersion": { + "type": "string" + }, + "loggingRules": { + "type": "array", + "items": { + "$ref": "#/definitions/LoggingRule" + } + }, + "throttlingRules": { + "type": "array", + "items": { + "$ref": "#/definitions/ThrottlingRule" + } + }, + "requiredFeatures": { + "type": "array", + "items": { + "type": "string" + } + }, + "featuresRule": { + "allOf": [ + { + "$ref": "#/definitions/FeaturesRule" + } + ] + }, + "enableAsyncOperation": { + "type": "boolean" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioned state of the resource." + }, + "enableThirdPartyS2S": { + "type": "boolean" + }, + "subscriptionLifecycleNotificationSpecifications": { + "allOf": [ + { + "$ref": "#/definitions/SubscriptionLifecycleNotificationSpecifications" + } + ] + }, + "isPureProxy": { + "type": "boolean" + }, + "identityManagement": { + "allOf": [ + { + "$ref": "#/definitions/IdentityManagementProperties" + } + ] + }, + "checkNameAvailabilitySpecifications": { + "allOf": [ + { + "$ref": "#/definitions/CheckNameAvailabilitySpecifications" + } + ] + }, + "disallowedActionVerbs": { + "type": "array", + "items": { + "type": "string" + } + }, + "serviceTreeInfos": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceTreeInfo" + } + }, + "requestHeaderOptions": { + "allOf": [ + { + "$ref": "#/definitions/RequestHeaderOptions" + } + ] + }, + "subscriptionStateRules": { + "type": "array", + "items": { + "$ref": "#/definitions/SubscriptionStateRule" + } + }, + "templateDeploymentOptions": { + "allOf": [ + { + "$ref": "#/definitions/TemplateDeploymentOptions" + } + ] + }, + "extendedLocations": { + "type": "array", + "items": { + "$ref": "#/definitions/ExtendedLocationOptions" + } + }, + "resourceMovePolicy": { + "allOf": [ + { + "$ref": "#/definitions/ResourceMovePolicy" + } + ] + }, + "resourceDeletionPolicy": { + "enum": [ + "NotSpecified", + "CascadeDeleteAll", + "CascadeDeleteProxyOnlyChildren" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceDeletionPolicy", + "modelAsString": true + } + }, + "resourceConcurrencyControlOptions": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ResourceConcurrencyControlOption" + } + }, + "resourceGraphConfiguration": { + "allOf": [ + { + "$ref": "#/definitions/ResourceGraphConfiguration" + } + ] + }, + "management": { + "allOf": [ + { + "$ref": "#/definitions/ResourceProviderManagement" + } + ] + }, + "openApiConfiguration": { + "$ref": "#/definitions/OpenApiConfiguration" + } + } + }, + "ResourceTypeRegistration": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/ResourceTypeRegistrationProperties" + } + ] + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "ResourceTypeRegistrationArrayResponseWithContinuation": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceTypeRegistration" + } + }, + "nextLink": { + "description": "The URL to get to the next set of results, if there are any.", + "type": "string" + } + } + }, + "SkuCapability": { + "required": [ + "name", + "value" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + } + } + }, + "SkuZoneDetail": { + "type": "object", + "properties": { + "name": { + "type": "array", + "items": { + "type": "string" + } + }, + "capabilities": { + "type": "array", + "items": { + "$ref": "#/definitions/SkuCapability" + } + } + } + }, + "SkuLocationInfo": { + "required": [ + "location" + ], + "type": "object", + "properties": { + "location": { + "type": "string" + }, + "zones": { + "type": "array", + "items": { + "type": "string" + } + }, + "zoneDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/SkuZoneDetail" + } + }, + "extendedLocations": { + "type": "array", + "items": { + "type": "string" + } + }, + "type": { + "enum": [ + "NotSpecified", + "EdgeZone", + "ArcZone" + ], + "type": "string" + } + } + }, + "SkuCapacity": { + "required": [ + "minimum" + ], + "type": "object", + "properties": { + "minimum": { + "format": "int32", + "type": "integer" + }, + "maximum": { + "format": "int32", + "type": "integer" + }, + "default": { + "format": "int32", + "type": "integer" + }, + "scaleType": { + "enum": [ + "None", + "Manual", + "Automatic" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuScaleType", + "modelAsString": true + } + } + } + }, + "SkuCost": { + "required": [ + "meterId" + ], + "type": "object", + "properties": { + "meterId": { + "type": "string" + }, + "quantity": { + "format": "int32", + "type": "integer" + }, + "extendedUnit": { + "type": "string" + } + } + }, + "SkuSetting": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "tier": { + "type": "string" + }, + "size": { + "type": "string" + }, + "family": { + "type": "string" + }, + "kind": { + "type": "string" + }, + "locations": { + "type": "array", + "items": { + "type": "string" + } + }, + "locationInfo": { + "type": "array", + "items": { + "$ref": "#/definitions/SkuLocationInfo" + } + }, + "requiredQuotaIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "requiredFeatures": { + "type": "array", + "items": { + "type": "string" + } + }, + "capacity": { + "allOf": [ + { + "$ref": "#/definitions/SkuCapacity" + } + ] + }, + "costs": { + "type": "array", + "items": { + "$ref": "#/definitions/SkuCost" + } + }, + "capabilities": { + "type": "array", + "items": { + "$ref": "#/definitions/SkuCapability" + } + } + } + }, + "ResourceTypeSku": { + "required": [ + "skuSettings" + ], + "type": "object", + "properties": { + "skuSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/SkuSetting" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioned state of the resource." + } + } + }, + "SkuResource": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/ResourceTypeSku" + } + ] + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "SkuResourceArrayResponseWithContinuation": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SkuResource" + } + }, + "nextLink": { + "description": "The URL to get to the next set of results, if there are any.", + "type": "string" + } + } + }, + "OpenApiConfiguration": { + "type": "object", + "properties": { + "validation": { + "$ref": "#/definitions/OpenApiValidation" + } + } + }, + "OpenApiValidation": { + "type": "object", + "properties": { + "allowNoncompliantCollectionResponse": { + "description": "Indicates whether a non compliance response is allowed for a LIST call", + "type": "boolean" + } + } + }, + "ResourceManagementEntity": { + "required": [ + "resourceId" + ], + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "description": "The resource id." + }, + "homeTenantId": { + "type": "string", + "description": "The home tenant id." + }, + "location": { + "type": "string", + "description": "The location." + }, + "status": { + "readOnly": true, + "type": "string", + "description": "The operation status." + } + } + }, + "ResourceManagementAction": { + "type": "object", + "properties": { + "resources": { + "type": "array", + "description": "resource management action content.", + "x-ms-client-flatten": true, + "items": { + "$ref": "#/definitions/ResourceManagementEntity" + } + } + } + } + }, + "parameters": { + "SelectParameter": { + "in": "query", + "name": "$select", + "description": "An OData $select clause. Used to select the properties to be returned in the GET response.", + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + "FilterParameter": { + "in": "query", + "name": "$filter", + "description": "An OData $filter clause. Used to filter results that are returned in the GET response.", + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + "ProviderNamespaceParameter": { + "in": "path", + "name": "providerNamespace", + "description": "The name of the resource provider hosted within ProviderHub.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "NestedResourceTypeFirstParameter": { + "in": "path", + "name": "nestedResourceTypeFirst", + "description": "The first child resource type.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "NestedResourceTypeSecondParameter": { + "in": "path", + "name": "nestedResourceTypeSecond", + "description": "The second child resource type.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "NestedResourceTypeThirdParameter": { + "in": "path", + "name": "nestedResourceTypeThird", + "description": "The third child resource type.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "GetRolloutNameParameter": { + "in": "path", + "name": "rolloutName", + "description": "The rollout name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "EnvironmentParameter": { + "in": "path", + "name": "environment", + "description": "The environment.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SkuParameter": { + "in": "path", + "name": "sku", + "description": "The SKU.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "GetNotificationRegistrationNameParameter": { + "in": "path", + "name": "notificationRegistrationName", + "description": "The notification registration.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "GetAsyncOperationStatusIdParameter": { + "in": "path", + "name": "asyncOperationStatusId", + "description": "The async operation status ID.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "GetApplicationIdParameter": { + "in": "path", + "name": "applicationId", + "description": "The application ID.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "GetAccountNameParameter": { + "in": "path", + "name": "accountName", + "description": "The available account name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "GetResourceTypeParameter": { + "in": "path", + "name": "resourceType", + "description": "The resource type.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ResourceActionParameter": { + "in": "path", + "name": "resourceActionName", + "description": "The resource action name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/providerhub.json b/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/providerhub.json index c0d4179fb1b1..c3c23e46a2ca 100644 --- a/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/providerhub.json +++ b/specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/providerhub.json @@ -3461,6 +3461,28 @@ "items": { "$ref": "#/definitions/NotificationEndpoint" } + }, + "provisioningState": { + "enum": [ + "NotSpecified", + "Accepted", + "Running", + "Creating", + "Created", + "Deleting", + "Deleted", + "Canceled", + "Failed", + "Succeeded", + "MovingResources", + "TransientFailure", + "RolloutInProgress" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } } } }, @@ -4526,6 +4548,28 @@ "items": { "$ref": "#/definitions/SkuSetting" } + }, + "provisioningState": { + "enum": [ + "NotSpecified", + "Accepted", + "Running", + "Creating", + "Created", + "Deleting", + "Deleted", + "Canceled", + "Failed", + "Succeeded", + "MovingResources", + "TransientFailure", + "RolloutInProgress" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } } } }, diff --git a/specification/providerhub/resource-manager/readme.md b/specification/providerhub/resource-manager/readme.md index 97fa0ce13eb1..03fab320236d 100644 --- a/specification/providerhub/resource-manager/readme.md +++ b/specification/providerhub/resource-manager/readme.md @@ -30,6 +30,19 @@ openapi-subtype: rpaas tag: package-2020-11-20 ``` +### Tag: package-2021-06-01-preview + +These settings apply only when `--tag=package-2021-06-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2021-06-01-preview' +input-file: + - Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json +directive: + - suppress: R4009 + from: providerhub.json + reason: This version doesn't support systemData. +``` + ### Tag: package-2021-05-01-preview These settings apply only when `--tag=package-2021-05-01-preview` is specified on the command line. diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/account.json b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/account.json new file mode 100644 index 000000000000..a07c2d4c6508 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/account.json @@ -0,0 +1,1616 @@ +{ + "swagger": "2.0", + "info": { + "version": "2019-11-01-preview", + "title": "DataPlaneAccountClient", + "description": "Creates a Microsoft.Purview data plane account client." + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/": { + "get": { + "tags": [ + "Account" + ], + "description": "Get an account", + "operationId": "Accounts_Get", + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Accounts_Get": { + "$ref": "./examples/Accounts_Get.json" + } + } + }, + "patch": { + "tags": [ + "Account" + ], + "description": "Updates an account", + "operationId": "Accounts_Update", + "parameters": [ + { + "name": "accountUpdateParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataPlaneAccountUpdateParameters" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Accounts_Update": { + "$ref": "./examples/Accounts_Update.json" + } + } + } + }, + "/listkeys": { + "post": { + "tags": [ + "Account" + ], + "description": "List the authorization keys associated with this account.", + "operationId": "Accounts_ListKeys", + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Accounts_ListKeys": { + "$ref": "./examples/Accounts_ListKeys.json" + } + } + } + }, + "/regeneratekeys": { + "post": { + "tags": [ + "Account" + ], + "description": "Regenerate the authorization keys associated with this data catalog.", + "operationId": "Accounts_RegenerateKeys", + "parameters": [ + { + "name": "keyOptions", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AccessKeyOptions" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Accounts_RegenerateKeys": { + "$ref": "./examples/Accounts_RegenerateKeys.json" + } + } + } + }, + "/collections/{collectionName}": { + "get": { + "tags": [ + "Collection" + ], + "description": "Get a collection", + "operationId": "Collections_Get", + "parameters": [ + { + "name": "collectionName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Collection" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Collections_Get": { + "$ref": "./examples/Collections_Get.json" + } + } + }, + "put": { + "tags": [ + "Collection" + ], + "description": "Creates or updates a collection entity.", + "operationId": "Collections_CreateOrUpdate", + "parameters": [ + { + "name": "collectionName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "collection", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Collection" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Collection" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Collections_CreateOrUpdate": { + "$ref": "./examples/Collections_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Collection" + ], + "description": "Deletes a Collection entity.", + "operationId": "Collections_Delete", + "parameters": [ + { + "name": "collectionName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Collections_Delete": { + "$ref": "./examples/Collections_Delete.json" + } + } + } + }, + "/collections": { + "get": { + "tags": [ + "Collection" + ], + "description": "List the collections in the account.", + "operationId": "Collections_ListByAccount", + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "name": "$skipToken", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CollectionList" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Collections_ListByAccount": { + "$ref": "./examples/Collections_ListByAccount.json" + } + } + } + }, + "/collections/{collectionName}/getChildCollectionNames": { + "get": { + "tags": [ + "Collection" + ], + "description": "Lists the child collections names in the collection.", + "operationId": "Collections_GetChildCollectionNames", + "parameters": [ + { + "name": "collectionName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "$skipToken", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CollectionNameResponseList" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Collections_GetChildCollectionNames": { + "$ref": "./examples/Collections_GetChildCollectionNames.json" + } + } + } + }, + "/collections/{collectionName}/getCollectionPath": { + "get": { + "tags": [ + "Collection" + ], + "description": "Gets the parent name and parent friendly name chains that represent the collection path.", + "operationId": "Collections_GetCollectionPath", + "parameters": [ + { + "name": "collectionName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "$skipToken", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CollectionPathResponse" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Collections_GetCollectionPath": { + "$ref": "./examples/Collections_GetCollectionPath.json" + } + } + } + }, + "/resourceSetRuleConfigs/defaultResourceSetRuleConfig": { + "get": { + "tags": [ + "ResourceSetRuleConfig" + ], + "description": "Get a resource set config service model.", + "operationId": "ResourceSetRuleConfigs_Get", + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ResourceSetRuleConfig" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "ResourceSetRuleConfigs_Get": { + "$ref": "./examples/ResourceSetRuleConfigs_Get.json" + } + } + }, + "put": { + "tags": [ + "ResourceSetRuleConfig" + ], + "description": "Creates or updates an resource set config.", + "operationId": "ResourceSetRuleConfigs_CreateOrUpdate", + "parameters": [ + { + "name": "resourceSetRuleConfig", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceSetRuleConfig" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ResourceSetRuleConfig" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "ResourceSetRuleConfigs_CreateOrUpdate": { + "$ref": "./examples/ResourceSetRuleConfigs_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "ResourceSetRuleConfig" + ], + "description": "Deletes a ResourceSetRuleConfig resource.", + "operationId": "ResourceSetRuleConfigs_Delete", + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "ResourceSetRuleConfigs_Delete": { + "$ref": "./examples/ResourceSetRuleConfigs_Delete.json" + } + } + } + }, + "/resourceSetRuleConfigs": { + "get": { + "tags": [ + "ResourceSetRuleConfig" + ], + "description": "Get a resource set config service model.", + "operationId": "ResourceSetRuleConfigs_ListByAccount", + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "name": "$skipToken", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ResourceSetRuleConfigList" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ResourceSetRuleConfigs_ListByAccount": { + "$ref": "./examples/ResourceSetRuleConfigs_ListByAccount.json" + } + } + } + } + }, + "definitions": { + "Account": { + "description": "Account resource", + "type": "object", + "properties": { + "id": { + "description": "Gets or sets the identifier.", + "type": "string", + "readOnly": true + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "Identity Info on the tracked resource" + }, + "location": { + "description": "Gets or sets the location.", + "type": "string" + }, + "name": { + "description": "Gets or sets the name.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/AccountProperties", + "description": "Gets or sets the properties." + }, + "sku": { + "$ref": "#/definitions/AccountSku", + "description": "Gets or sets the Sku." + }, + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "allOf": [ + { + "$ref": "#/definitions/SystemData" + } + ], + "readOnly": true + }, + "tags": { + "description": "Tags on the azure resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "type": { + "description": "Gets or sets the type.", + "type": "string", + "readOnly": true + } + } + }, + "AccountSku": { + "description": "The Sku", + "type": "object", + "properties": { + "capacity": { + "format": "int32", + "description": "Gets or sets the sku capacity. Possible values include: 4, 16", + "type": "integer" + }, + "name": { + "description": "Gets or sets the sku name.", + "enum": [ + "Standard" + ], + "type": "string", + "x-ms-enum": { + "name": "name", + "modelAsString": true + } + } + } + }, + "AccountProperties": { + "description": "The account properties", + "type": "object", + "properties": { + "cloudConnectors": { + "$ref": "#/definitions/CloudConnectors", + "description": "Cloud connectors.\r\nExternal cloud identifier used as part of scanning configuration." + }, + "createdAt": { + "format": "date-time", + "description": "Gets the time at which the entity was created.", + "type": "string", + "readOnly": true + }, + "createdBy": { + "description": "Gets the creator of the entity.", + "type": "string", + "readOnly": true + }, + "createdByObjectId": { + "description": "Gets the creators of the entity's object id.", + "type": "string", + "readOnly": true + }, + "endpoints": { + "description": "The URIs that are the public endpoints of the account.", + "allOf": [ + { + "$ref": "#/definitions/AccountEndpoints" + } + ], + "readOnly": true + }, + "friendlyName": { + "description": "Gets or sets the friendly name.", + "type": "string", + "readOnly": true + }, + "managedResourceGroupName": { + "description": "Gets or sets the managed resource group name", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "managedResources": { + "description": "Gets the resource identifiers of the managed resources.", + "allOf": [ + { + "$ref": "#/definitions/ManagedResources" + } + ], + "readOnly": true + }, + "privateEndpointConnections": { + "description": "Gets the private endpoint connections information.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "provisioningState": { + "description": "Gets or sets the state of the provisioning.", + "enum": [ + "Unknown", + "Creating", + "Moving", + "Deleting", + "SoftDeleting", + "SoftDeleted", + "Failed", + "Succeeded", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } + }, + "publicNetworkAccess": { + "description": "Gets or sets the public network access.", + "default": "Enabled", + "enum": [ + "NotSpecified", + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "publicNetworkAccess", + "modelAsString": true + } + } + } + }, + "Identity": { + "description": "The Managed Identity of the resource", + "type": "object", + "properties": { + "principalId": { + "description": "Service principal object Id", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "Tenant Id", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Identity Type", + "enum": [ + "SystemAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "type", + "modelAsString": true + } + } + } + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "properties": { + "createdAt": { + "format": "date-time", + "description": "The timestamp of resource creation (UTC).", + "type": "string", + "readOnly": true + }, + "createdBy": { + "description": "The identity that created the resource.", + "type": "string", + "readOnly": true + }, + "createdByType": { + "description": "The type of identity that created the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "lastModifiedAt": { + "format": "date-time", + "description": "The timestamp of the last modification the resource (UTC).", + "type": "string", + "readOnly": true + }, + "lastModifiedBy": { + "description": "The identity that last modified the resource.", + "type": "string", + "readOnly": true + }, + "lastModifiedByType": { + "description": "The type of identity that last modified the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "lastModifiedByType", + "modelAsString": true + } + } + } + }, + "CloudConnectors": { + "type": "object", + "properties": { + "awsExternalId": { + "description": "AWS external identifier.\r\nConfigured in AWS to allow use of the role arn used for scanning", + "type": "string", + "readOnly": true + } + } + }, + "AccountEndpoints": { + "description": "The account endpoints", + "type": "object", + "properties": { + "catalog": { + "description": "Gets the catalog endpoint.", + "type": "string", + "readOnly": true + }, + "guardian": { + "description": "Gets the guardian endpoint.", + "type": "string", + "readOnly": true + }, + "scan": { + "description": "Gets the scan endpoint.", + "type": "string", + "readOnly": true + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection class.", + "type": "object", + "properties": { + "id": { + "description": "Gets or sets the identifier.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Gets or sets the name.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The connection identifier." + }, + "type": { + "description": "Gets or sets the type.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedResources": { + "description": "The managed resources in customer subscription.", + "type": "object", + "properties": { + "eventHubNamespace": { + "description": "Gets the managed event hub namespace resource identifier.", + "type": "string", + "readOnly": true + }, + "resourceGroup": { + "description": "Gets the managed resource group resource identifier. This resource group will host resource dependencies for the account.", + "type": "string", + "readOnly": true + }, + "storageAccount": { + "description": "Gets the managed storage account resource identifier.", + "type": "string", + "readOnly": true + } + } + }, + "PrivateEndpointConnectionProperties": { + "description": "A private endpoint connection properties class.", + "type": "object", + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The private endpoint information." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "The private link service connection state." + }, + "provisioningState": { + "description": "The provisioning state.", + "type": "string", + "readOnly": true + } + } + }, + "PrivateEndpoint": { + "description": "A private endpoint class.", + "type": "object", + "properties": { + "id": { + "description": "The private endpoint identifier.", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "The private link service connection state.", + "type": "object", + "properties": { + "actionsRequired": { + "description": "The required actions.", + "type": "string" + }, + "description": { + "description": "The description.", + "type": "string" + }, + "status": { + "description": "The status.", + "enum": [ + "Unknown", + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "status", + "modelAsString": true + } + } + } + }, + "ErrorResponseModel": { + "description": "Default error response model", + "type": "object", + "properties": { + "error": { + "description": "Gets or sets the error.", + "allOf": [ + { + "$ref": "#/definitions/ErrorModel" + } + ], + "readOnly": true + } + } + }, + "ErrorModel": { + "description": "Default error model", + "type": "object", + "properties": { + "code": { + "description": "Gets or sets the code.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Gets or sets the details.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ErrorModel" + }, + "readOnly": true + }, + "message": { + "description": "Gets or sets the messages.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "Gets or sets the target.", + "type": "string", + "readOnly": true + } + } + }, + "DataPlaneAccountUpdateParameters": { + "description": "The account properties that can be updated through data plane.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The friendly name for the azure resource.", + "type": "string" + } + } + }, + "AccessKeys": { + "description": "The Account access keys.", + "type": "object", + "properties": { + "atlasKafkaPrimaryEndpoint": { + "description": "Gets or sets the primary connection string.", + "type": "string" + }, + "atlasKafkaSecondaryEndpoint": { + "description": "Gets or sets the secondary connection string.", + "type": "string" + } + } + }, + "AccessKeyOptions": { + "description": "A access key options used for regeneration.", + "type": "object", + "properties": { + "keyType": { + "description": "The access key type.", + "enum": [ + "PrimaryAtlasKafkaKey", + "SecondaryAtlasKafkaKey" + ], + "type": "string", + "x-ms-enum": { + "name": "keyType", + "modelAsString": true + } + } + } + }, + "Collection": { + "description": "Collection resource.", + "type": "object", + "properties": { + "collectionProvisioningState": { + "description": "Gets the state of the provisioning.", + "enum": [ + "Unknown", + "Creating", + "Moving", + "Deleting", + "Failed", + "Succeeded" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "collectionProvisioningState", + "modelAsString": true + } + }, + "description": { + "description": "Gets or sets the description.", + "type": "string" + }, + "friendlyName": { + "description": "Gets or sets the friendly name of the collection.", + "type": "string" + }, + "name": { + "description": "Gets the name.", + "type": "string", + "readOnly": true + }, + "parentCollection": { + "$ref": "#/definitions/CollectionReference", + "description": "Gets or sets the parent collection reference." + }, + "systemData": { + "description": "Gets the system data that contains information about who and when created and updated the resource.", + "allOf": [ + { + "$ref": "#/definitions/SystemData" + } + ], + "readOnly": true + } + } + }, + "CollectionReference": { + "description": "Reference to a Collection.", + "type": "object", + "properties": { + "referenceName": { + "description": "Gets or sets the reference name.", + "type": "string" + }, + "type": { + "description": "Gets the reference type property.", + "type": "string", + "readOnly": true + } + } + }, + "CollectionList": { + "description": "Paged list of collections.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "count": { + "format": "int64", + "description": "Total item count.", + "type": "integer" + }, + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + }, + "value": { + "description": "Collection of items of type results.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Collection" + } + } + } + }, + "CollectionNameResponseList": { + "description": "Paged list of collections.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "count": { + "format": "int64", + "description": "Total item count.", + "type": "integer" + }, + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + }, + "value": { + "description": "Collection of items of type results.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/CollectionNameResponse" + } + } + } + }, + "CollectionNameResponse": { + "description": "Collection resource.", + "type": "object", + "properties": { + "friendlyName": { + "description": "Gets or sets the friendly name of the collection.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Gets the name.", + "type": "string", + "readOnly": true + } + } + }, + "CollectionPathResponse": { + "description": "Collection resource.", + "type": "object", + "properties": { + "parentFriendlyNameChain": { + "description": "The friendly names of ancestors starting from the default (root) collection and ending with the immediate parent.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "parentNameChain": { + "description": "The names of ancestors starting from the default (root) collection and ending with the immediate parent.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "ResourceSetRuleConfig": { + "description": "ResourceSetRuleConfig implementation class.", + "type": "object", + "properties": { + "advancedResourceSet": { + "$ref": "#/definitions/AdvancedResourceSet", + "description": "Gets or sets the advanced resource set property of the account." + }, + "name": { + "description": "The name of the rule", + "type": "string", + "readOnly": true + }, + "pathPatternConfig": { + "$ref": "#/definitions/PathPatternExtractorConfig", + "description": "The configuration rules for path pattern extraction." + } + } + }, + "PathPatternExtractorConfig": { + "required": [ + "enableDefaultPatterns", + "createdBy" + ], + "type": "object", + "properties": { + "acceptedPatterns": { + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Filter" + } + }, + "complexReplacers": { + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ComplexReplacerConfig" + } + }, + "createdBy": { + "type": "string" + }, + "enableDefaultPatterns": { + "type": "boolean" + }, + "lastUpdatedTimestamp": { + "format": "int64", + "type": "integer" + }, + "modifiedBy": { + "default": "AzureDataCatalog", + "type": "string" + }, + "normalizationRules": { + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/NormalizationRule" + } + }, + "regexReplacers": { + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/RegexReplacer" + } + }, + "rejectedPatterns": { + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Filter" + } + }, + "scopedRules": { + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ScopedRule" + } + }, + "version": { + "format": "int32", + "default": 0, + "type": "integer" + } + } + }, + "AdvancedResourceSet": { + "description": "The resource set processing property of the account.", + "type": "object", + "properties": { + "modifiedAt": { + "format": "date-time", + "description": "Date at which ResourceSetProcessing property of the account is updated.", + "type": "string" + }, + "resourceSetProcessing": { + "description": "The advanced resource property of the account.", + "enum": [ + "Default", + "Advanced" + ], + "type": "string", + "x-ms-enum": { + "name": "resourceSetProcessing", + "modelAsString": true + } + } + } + }, + "Filter": { + "required": [ + "name", + "path" + ], + "type": "object", + "properties": { + "createdBy": { + "default": "AzureDataCatalog", + "type": "string" + }, + "filterType": { + "default": "Pattern", + "enum": [ + "Pattern", + "Regex" + ], + "type": "string", + "x-ms-enum": { + "name": "filterType", + "modelAsString": true + } + }, + "lastUpdatedTimestamp": { + "format": "int64", + "type": "integer" + }, + "modifiedBy": { + "default": "AzureDataCatalog", + "type": "string" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + } + } + }, + "RegexReplacer": { + "required": [ + "name", + "disabled" + ], + "type": "object", + "properties": { + "condition": { + "type": "string" + }, + "createdBy": { + "default": "AzureDataCatalog", + "type": "string" + }, + "description": { + "type": "string" + }, + "disabled": { + "type": "boolean" + }, + "disableRecursiveReplacerApplication": { + "type": "boolean" + }, + "doNotReplaceRegex": { + "$ref": "#/definitions/FastRegex" + }, + "lastUpdatedTimestamp": { + "format": "int64", + "type": "integer" + }, + "modifiedBy": { + "default": "AzureDataCatalog", + "type": "string" + }, + "name": { + "type": "string" + }, + "regex": { + "$ref": "#/definitions/FastRegex" + }, + "replaceWith": { + "type": "string" + } + } + }, + "ComplexReplacerConfig": { + "type": "object", + "properties": { + "createdBy": { + "type": "string" + }, + "description": { + "type": "string" + }, + "disabled": { + "type": "boolean" + }, + "disableRecursiveReplacerApplication": { + "type": "boolean" + }, + "lastUpdatedTimestamp": { + "format": "int64", + "type": "integer" + }, + "modifiedBy": { + "type": "string" + }, + "name": { + "type": "string" + }, + "typeName": { + "type": "string" + } + } + }, + "NormalizationRule": { + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "disabled": { + "type": "boolean" + }, + "dynamicReplacement": { + "type": "boolean" + }, + "entityTypes": { + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "lastUpdatedTimestamp": { + "format": "int64", + "type": "integer" + }, + "name": { + "type": "string" + }, + "regex": { + "$ref": "#/definitions/FastRegex" + }, + "replaceWith": { + "type": "string" + }, + "version": { + "format": "double", + "type": "number" + } + } + }, + "ScopedRule": { + "required": [ + "bindingUrl", + "storeType" + ], + "type": "object", + "properties": { + "bindingUrl": { + "type": "string" + }, + "rules": { + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Rule" + } + }, + "storeType": { + "type": "string" + } + } + }, + "FastRegex": { + "type": "object", + "properties": { + "maxDigits": { + "format": "int32", + "type": "integer" + }, + "maxLetters": { + "format": "int32", + "type": "integer" + }, + "minDashes": { + "format": "int32", + "type": "integer" + }, + "minDigits": { + "format": "int32", + "type": "integer" + }, + "minDigitsOrLetters": { + "format": "int32", + "type": "integer" + }, + "minDots": { + "format": "int32", + "type": "integer" + }, + "minHex": { + "format": "int32", + "type": "integer" + }, + "minLetters": { + "format": "int32", + "type": "integer" + }, + "minUnderscores": { + "format": "int32", + "type": "integer" + }, + "options": { + "format": "int32", + "type": "integer" + }, + "regexStr": { + "type": "string" + } + } + }, + "Rule": { + "required": [ + "qualifiedName" + ], + "type": "object", + "properties": { + "displayName": { + "type": "string" + }, + "isResourceSet": { + "default": true, + "type": "boolean" + }, + "lastUpdatedTimestamp": { + "format": "int64", + "type": "integer" + }, + "name": { + "type": "string" + }, + "qualifiedName": { + "type": "string" + } + } + }, + "ResourceSetRuleConfigList": { + "description": "Paged list of account resources", + "required": [ + "value" + ], + "type": "object", + "properties": { + "count": { + "format": "int64", + "description": "Total item count.", + "type": "integer" + }, + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + }, + "value": { + "description": "Collection of items of type results.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ResourceSetRuleConfig" + } + } + } + } + }, + "parameters": { + "api-version": { + "name": "api-version", + "in": "query", + "description": "The api version to use.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "tags": [] +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Accounts_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Accounts_Get.json new file mode 100644 index 000000000000..b2de791c01a9 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Accounts_Get.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2018-12-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "location": "West US 2", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.ProjectBabylon/accounts/account1", + "name": "account1", + "type": "Microsoft.ProjectBabylon/accounts", + "sku": { + "name": "Standard", + "capacity": 4 + }, + "systemData": { + "createdBy": "client-name", + "createdByType": "User", + "createdAt": "2019-11-22T18:39:58.6929344Z", + "lastModifiedBy": "client-name", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-03-16T23:24:34.3430059Z" + }, + "properties": { + "friendlyName": "friendly-account1", + "createdBy": "client-name", + "createdByObjectId": "client-objectId", + "createdAt": "2019-11-22T18:39:58.6929344Z", + "provisioningState": "Succeeded", + "endpoints": { + "catalog": "https://account1.catalog.babylon.azure-test.com", + "scan": "https://account1.scan.babylon.azure-test.com", + "guardian": "https://account1.guardian.babylon.azure-test.com" + }, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/baca8a88-4527-4c35-a13e-b2775ce0d7fc/resourceGroups/nrpResourceGroupName/providers/Microsoft.Network/privateEndpoints/peName" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my connection, thanks.", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.ProjectBabylon/accounts/account1/privateEndpointConnections/peName-8536c337-7b36-4d67-a7ce-081655baf59e", + "name": "peName-8536c337-7b36-4d67-a7ce-081655baf59e", + "type": "Microsoft.ProjectBabylon/accounts/privateEndpointConnections" + } + ], + "managedResources": { + "resourceGroup": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl", + "storageAccount": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.Storage/storageAccounts/scanwestustzaagzr", + "eventHubNamespace": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.EventHub/namespaces/atlas-westusdddnbtp" + } + } + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Accounts_ListKeys.json b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Accounts_ListKeys.json new file mode 100644 index 000000000000..3e7df73103e6 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Accounts_ListKeys.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2018-12-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "atlasKafkaPrimaryEndpoint": "Endpoint=sb://fake_objectId.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=ASDASasdfmasdf123412341234=", + "atlasKafkaSecondaryEndpoint": "Endpoint=sb://fake_objectId.servicebus.windows.net/;SharedAccessKeyName=AlternateSharedAccessKey;SharedAccessKey=BSDASasdfmasdf123412341234=" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Accounts_RegenerateKeys.json b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Accounts_RegenerateKeys.json new file mode 100644 index 000000000000..6a8b867a7e97 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Accounts_RegenerateKeys.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2018-12-01-preview", + "keyOptions": { + "keyType": "PrimaryKey" + } + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "atlasKafkaPrimaryEndpoint": "Endpoint=sb://fake_objectId.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=ASDASasdfmasdf123412341234=", + "atlasKafkaSecondaryEndpoint": "Endpoint=sb://fake_objectId.servicebus.windows.net/;SharedAccessKeyName=AlternateSharedAccessKey;SharedAccessKey=BSDASasdfmasdf123412341234=" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Accounts_Update.json b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Accounts_Update.json new file mode 100644 index 000000000000..645ea8e114eb --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Accounts_Update.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "SampleResourceGroup", + "accountName": "account1", + "api-version": "2018-12-01-preview", + "accountUpdateParameters": { + "friendlyName": "friendly-account1" + } + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "location": "West US 2", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.ProjectBabylon/accounts/account1", + "name": "account1", + "type": "Microsoft.ProjectBabylon/accounts", + "sku": { + "name": "Standard", + "capacity": 4 + }, + "systemData": { + "createdBy": "client-name", + "createdByType": "User", + "createdAt": "2019-11-22T18:39:58.6929344Z", + "lastModifiedBy": "client-name", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-03-16T23:24:34.3430059Z" + }, + "properties": { + "friendlyName": "friendly-account1", + "createdBy": "client-name", + "createdByObjectId": "client-objectId", + "createdAt": "2019-11-22T18:39:58.6929344Z", + "provisioningState": "Succeeded", + "endpoints": { + "catalog": "https://account2.catalog.babylon.azure-test.com", + "scan": "https://account2.scan.babylon.azure-test.com", + "guardian": "https://account1.guardian.babylon.azure-test.com" + }, + "managedResources": { + "resourceGroup": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl", + "storageAccount": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.Storage/storageAccounts/scanwestustzaagzr", + "eventHubNamespace": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.EventHub/namespaces/atlas-westusdddnbtp" + } + }, + "tags": { + "tag": "tag value." + } + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Collections_CreateOrUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Collections_CreateOrUpdate.json new file mode 100644 index 000000000000..261d8463e1b8 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Collections_CreateOrUpdate.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "collectionName": "myCollection1", + "api-version": "2019-11-01-preview", + "collection": { + "parentCollection": { + "referenceName": "myParentCollection1" + } + } + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "name": "mycollection1", + "friendlyName": "Finance", + "parentCollection": { + "type": "CollectionReference", + "referenceName": "myParentCollection1" + }, + "collectionProvisioningState": "Succeeded" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Collections_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Collections_Delete.json new file mode 100644 index 000000000000..1596de37828b --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Collections_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "collectionName": "myCollection1", + "api-version": "2019-11-01-preview" + }, + "responses": { + "204": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Collections_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Collections_Get.json new file mode 100644 index 000000000000..6fd40f203563 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Collections_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "collectionName": "myCollection1", + "api-version": "2019-11-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "name": "mycollection1", + "friendlyName": "Finance", + "parentCollection": { + "type": "CollectionReference", + "referenceName": "accountName" + }, + "collectionProvisioningState": "Succeeded" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Collections_GetChildCollectionNames.json b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Collections_GetChildCollectionNames.json new file mode 100644 index 000000000000..039838e30c62 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Collections_GetChildCollectionNames.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "collectionName": "myCollection1", + "api-version": "2019-11-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "value": [ + { + "name": "mycollection1", + "friendlyName": "The first collection" + }, + { + "name": "mycollection2", + "friendlyName": "Some collection" + }, + { + "name": "parent2", + "friendlyName": "parent2" + } + ], + "count": 3 + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Collections_GetCollectionPath.json b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Collections_GetCollectionPath.json new file mode 100644 index 000000000000..6cd313d7732d --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Collections_GetCollectionPath.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "collectionName": "myCollection1", + "api-version": "2019-11-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "parentNameChain": [ + "account1", + "parent1" + ], + "parentFriendlyNameChain": [ + "Test account friendly name", + "parent1" + ] + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Collections_ListByAccount.json b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Collections_ListByAccount.json new file mode 100644 index 000000000000..90cc3441f215 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/Collections_ListByAccount.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2019-11-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "value": [ + { + "name": "mycollection1", + "friendlyName": "Finance", + "parentCollection": { + "type": "CollectionReference", + "referenceName": "accountName" + }, + "collectionProvisioningState": "Succeeded" + } + ] + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/ResourceSetRuleConfigs_CreateOrUpdate.json b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/ResourceSetRuleConfigs_CreateOrUpdate.json new file mode 100644 index 000000000000..f7d6a39c5314 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/ResourceSetRuleConfigs_CreateOrUpdate.json @@ -0,0 +1,455 @@ +{ + "parameters": { + "accountId": "11349e3d-b23d-47fe-aaf2-3d4c3d9a3f5b", + "resourceSetRuleConfigName": "myNewresourceSetRuleConfigName", + "api-version": "2019-11-01-preview", + "resourceSetRuleConfig": { + "pathPatternConfig": { + "rejectedPatterns": [ + { + "name": "OfficeDocuments", + "filterType": "Regex", + "path": "^.*\\.(?i)(DOC|DOCM|DOCX|DOT|ODP|ODS|ODT|PDF|POT|PPS|PPSX|PPT|PPTM|PPTX|XLC|XLS|XLSB|XLSM|XLSX|XLT)(?-i)$", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0 + } + ], + "acceptedPatterns": [], + "enableDefaultPatterns": true, + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "regexReplacers": [ + { + "name": "Guid", + "disabled": false, + "description": null, + "regex": { + "regexStr": "([0-9A-F]{32}|[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12})", + "options": 9, + "minHex": 32 + }, + "replaceWith": "{GUID}", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0 + }, + { + "name": "Number", + "disabled": false, + "description": null, + "regex": { + "regexStr": "^\\d+$", + "options": 8, + "minDigits": 1 + }, + "replaceWith": "{N}", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0 + }, + { + "name": "yyyy-mm-ddThh-MM-ss", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(20)[1-9][0-9]([-\\._@]?)(0[1-9]|1[012])([-\\._@]?)(0[1-9]|[12][0-9]|3[01])([T])(2[0-3]|[01]?[0-9])([-\\._@]?)([0-5][0-9])([-\\._@]?)([0-5][0-9])(Z)?", + "options": 8, + "minDigits": 12 + }, + "replaceWith": "{N}$2{N}$4{N}$6{N}$8{N}$10{N}$12", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0 + }, + { + "name": "yyyy-mm-ddThh", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(20)[1-9][0-9]([-\\._@]?)(0[1-9]|1[012])([-\\._@]?)(0[1-9]|[12][0-9]|3[01])([T])(2[0-3]|[01]?[0-9])(Z)?", + "options": 8, + "minDigits": 8 + }, + "replaceWith": "{N}$2{N}$4{N}$6{N}$8", + "condition": "ApplyToNonFileName", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0 + }, + { + "name": "yyyy-mm-ddZ", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(20)[1-9][0-9]([-\\._@]?)(0[1-9]|1[012])([-\\._@]?)(0[1-9]|[12][0-9]|3[01])(Z)", + "options": 8, + "minDigits": 6 + }, + "replaceWith": "{N}$2{N}$4{N}$6", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0 + }, + { + "name": "yyyy-mm-dd-hhZ", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(20)[1-9][0-9]([-\\._@]?)(0[1-9]|1[012])([-\\._@]?)(0[1-9]|[12][0-9]|3[01])([-\\._@]?)(2[0-3]|[01]?[0-9])(Z)", + "options": 8, + "minDigits": 8 + }, + "replaceWith": "{N}$2{N}$4{N}$6{N}$8", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0 + }, + { + "name": "NumberBetweenDelimiter", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(?<=[-\\._@])([\\d]+)(?=[-\\._@])|^(\\d+)(?=[-\\._@])|(?<=[-\\._@])(\\d+)$", + "options": 8, + "minDigits": 1 + }, + "replaceWith": "{N}", + "doNotReplaceRegex": { + "regexStr": "(?<=[-\\._@]|^)[v](\\d+)[\\.](\\d+)[\\.]?(\\d+)?(?=[-\\._@]|$)", + "options": 9, + "minDigits": 1, + "minLetters": 1 + }, + "condition": "ApplyToFileNameOrNonVersionString", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0 + }, + { + "name": "4ByteHex", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(?<=[-\\._@]|^)([0-9A-F]{8,16})(?=[-\\._@]|$)", + "options": 9, + "minDigitsOrLetters": 8 + }, + "replaceWith": "{HEX}", + "doNotReplaceRegex": { + "regexStr": "(?<=[-\\._@]|^)[v](\\d+)[\\.](\\d+)[\\.]?(\\d+)?(?=[-\\._@]|$)", + "options": 9, + "minDigits": 1, + "minLetters": 1 + }, + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0 + }, + { + "name": "NumberInFile", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(\\d+)", + "options": 8, + "minDigits": 1 + }, + "replaceWith": "{N}", + "doNotReplaceRegex": { + "regexStr": "(?<=[-\\._@]|^)[v](\\d+)[\\.](\\d+)[\\.]?(\\d+)?(?=[-\\._@]|$)", + "options": 9, + "minDigits": 1, + "minLetters": 1 + }, + "condition": "ApplyToFileName", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0 + }, + { + "name": "Localization(DashSeparated)", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(?<=[-\\._@]|^)(ar-eg|ar-sa|cy-gb|da-dk|de-at|de-ch|de-de|en-au|en-ca|en-gb|en-ie|en-in|en-my|en-nz|en-ph|en-sg|en-us|en-ww|en-xa|en-za|es-ar|es-cl|es-es|es-mx|es-us|es-xl|fi-fi|fr-be|fr-ca|fr-ch|fr-fr|gu-in|hi-in|id-id|it-it|ja-jp|nb-no|nl-nl|nl-be|pt-br|pt-pt|pl-pl|ru-ru|sv-se|ta-in|te-in|zh-cn|zh-hk|zh-tw|ko-kr|tr-tr)(?=[-\\._@]|$)", + "options": 9, + "minLetters": 4, + "minDashes": 1 + }, + "replaceWith": "{LOC}", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0 + }, + { + "name": "Localization(UnderscoreSeparated)", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(?<=[-\\._@]|^)(ar_eg|ar_sa|cy_gb|da_dk|de_at|de_ch|de_de|en_au|en_ca|en_gb|en_ie|en_in|en_my|en_nz|en_ph|en_sg|en_us|en_ww|en_xa|en_za|es_ar|es_cl|es_es|es_mx|es_us|es_xl|fi_fi|fr_be|fr_ca|fr_ch|fr_fr|gu_in|hi_in|id_id|it_it|ja_jp|nb_no|nl_nl|nl_be|pt_br|pt_pt|pl_pl|ru_ru|sv_se|ta_in|te_in|zh_cn|zh_hk|zh_tw|ko_kr|tr_tr)(?=[-\\._@]|$)", + "options": 9, + "minLetters": 4, + "minUnderscores": 1 + }, + "replaceWith": "{LOC}", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0 + } + ], + "complexReplacers": [ + { + "name": "SparkPath", + "disabled": false, + "description": null, + "typeName": "Microsoft.DataMap.PathPattern.SparkPathReplacer", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0 + } + ] + }, + "advancedResourceSet": { + "resourceSetProcessing": "Default" + } + } + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "name": "myNewresourceSetRuleConfigName", + "pathPatternConfig": { + "rejectedPatterns": [ + { + "name": "OfficeDocuments", + "filterType": "Regex", + "path": "^.*\\.(?i)(DOC|DOCM|DOCX|DOT|ODP|ODS|ODT|PDF|POT|PPS|PPSX|PPT|PPTM|PPTX|XLC|XLS|XLSB|XLSM|XLSX|XLT)(?-i)$", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0 + } + ], + "acceptedPatterns": [], + "enableDefaultPatterns": true, + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 1585257544, + "regexReplacers": [ + { + "name": "Guid", + "disabled": false, + "description": null, + "regex": { + "regexStr": "([0-9A-F]{32}|[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12})", + "options": 9, + "minHex": 32 + }, + "replaceWith": "{GUID}", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false + }, + { + "name": "Number", + "disabled": false, + "description": null, + "regex": { + "regexStr": "^\\d+$", + "options": 8, + "minDigits": 1 + }, + "replaceWith": "{N}", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false + }, + { + "name": "yyyy-mm-ddThh-MM-ss", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(20)[1-9][0-9]([-\\._@]?)(0[1-9]|1[012])([-\\._@]?)(0[1-9]|[12][0-9]|3[01])([T])(2[0-3]|[01]?[0-9])([-\\._@]?)([0-5][0-9])([-\\._@]?)([0-5][0-9])(Z)?", + "options": 8, + "minDigits": 12 + }, + "replaceWith": "{N}$2{N}$4{N}$6{N}$8{N}$10{N}$12", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false + }, + { + "name": "yyyy-mm-ddThh", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(20)[1-9][0-9]([-\\._@]?)(0[1-9]|1[012])([-\\._@]?)(0[1-9]|[12][0-9]|3[01])([T])(2[0-3]|[01]?[0-9])(Z)?", + "options": 8, + "minDigits": 8 + }, + "replaceWith": "{N}$2{N}$4{N}$6{N}$8", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false, + "condition": "ApplyToNonFileName" + }, + { + "name": "yyyy-mm-ddZ", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(20)[1-9][0-9]([-\\._@]?)(0[1-9]|1[012])([-\\._@]?)(0[1-9]|[12][0-9]|3[01])(Z)", + "options": 8, + "minDigits": 6 + }, + "replaceWith": "{N}$2{N}$4{N}$6", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false + }, + { + "name": "yyyy-mm-dd-hhZ", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(20)[1-9][0-9]([-\\._@]?)(0[1-9]|1[012])([-\\._@]?)(0[1-9]|[12][0-9]|3[01])([-\\._@]?)(2[0-3]|[01]?[0-9])(Z)", + "options": 8, + "minDigits": 8 + }, + "replaceWith": "{N}$2{N}$4{N}$6{N}$8", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false + }, + { + "name": "NumberBetweenDelimiter", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(?<=[-\\._@])([\\d]+)(?=[-\\._@])|^(\\d+)(?=[-\\._@])|(?<=[-\\._@])(\\d+)$", + "options": 8, + "minDigits": 1 + }, + "replaceWith": "{N}", + "doNotReplaceRegex": { + "regexStr": "(?<=[-\\._@]|^)[v](\\d+)[\\.](\\d+)[\\.]?(\\d+)?(?=[-\\._@]|$)", + "options": 9, + "minDigits": 1, + "minLetters": 1 + }, + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false, + "condition": "ApplyToFileNameOrNonVersionString" + }, + { + "name": "4ByteHex", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(?<=[-\\._@]|^)([0-9A-F]{8,16})(?=[-\\._@]|$)", + "options": 9, + "minDigitsOrLetters": 8 + }, + "replaceWith": "{HEX}", + "doNotReplaceRegex": { + "regexStr": "(?<=[-\\._@]|^)[v](\\d+)[\\.](\\d+)[\\.]?(\\d+)?(?=[-\\._@]|$)", + "options": 9, + "minDigits": 1, + "minLetters": 1 + }, + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false + }, + { + "name": "NumberInFile", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(\\d+)", + "options": 8, + "minDigits": 1 + }, + "replaceWith": "{N}", + "doNotReplaceRegex": { + "regexStr": "(?<=[-\\._@]|^)[v](\\d+)[\\.](\\d+)[\\.]?(\\d+)?(?=[-\\._@]|$)", + "options": 9, + "minDigits": 1, + "minLetters": 1 + }, + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false, + "condition": "ApplyToFileName" + }, + { + "name": "Localization(DashSeparated)", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(?<=[-\\._@]|^)(ar-eg|ar-sa|cy-gb|da-dk|de-at|de-ch|de-de|en-au|en-ca|en-gb|en-ie|en-in|en-my|en-nz|en-ph|en-sg|en-us|en-ww|en-xa|en-za|es-ar|es-cl|es-es|es-mx|es-us|es-xl|fi-fi|fr-be|fr-ca|fr-ch|fr-fr|gu-in|hi-in|id-id|it-it|ja-jp|nb-no|nl-nl|nl-be|pt-br|pt-pt|pl-pl|ru-ru|sv-se|ta-in|te-in|zh-cn|zh-hk|zh-tw|ko-kr|tr-tr)(?=[-\\._@]|$)", + "options": 9, + "minLetters": 4, + "minDashes": 1 + }, + "replaceWith": "{LOC}", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false + }, + { + "name": "Localization(UnderscoreSeparated)", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(?<=[-\\._@]|^)(ar_eg|ar_sa|cy_gb|da_dk|de_at|de_ch|de_de|en_au|en_ca|en_gb|en_ie|en_in|en_my|en_nz|en_ph|en_sg|en_us|en_ww|en_xa|en_za|es_ar|es_cl|es_es|es_mx|es_us|es_xl|fi_fi|fr_be|fr_ca|fr_ch|fr_fr|gu_in|hi_in|id_id|it_it|ja_jp|nb_no|nl_nl|nl_be|pt_br|pt_pt|pl_pl|ru_ru|sv_se|ta_in|te_in|zh_cn|zh_hk|zh_tw|ko_kr|tr_tr)(?=[-\\._@]|$)", + "options": 9, + "minLetters": 4, + "minUnderscores": 1 + }, + "replaceWith": "{LOC}", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false + } + ], + "complexReplacers": [ + { + "name": "SparkPath", + "disabled": false, + "description": null, + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false, + "typeName": "Microsoft.DataMap.PathPattern.SparkPathReplacer" + } + ] + }, + "advancedResourceSet": { + "resourceSetProcessing": "Default", + "modifiedAt": "2021-07-08T23:14:06.4084575Z" + } + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/ResourceSetRuleConfigs_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/ResourceSetRuleConfigs_Delete.json new file mode 100644 index 000000000000..135165d8bb77 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/ResourceSetRuleConfigs_Delete.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "accountId": "11349e3d-b23d-47fe-aaf2-3d4c3d9a3f5b", + "resourceSetRuleConfigName": "myNewresourceSetRuleConfigName", + "api-version": "2019-11-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + } + }, + "204": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/ResourceSetRuleConfigs_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/ResourceSetRuleConfigs_Get.json new file mode 100644 index 000000000000..9883a87162df --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/ResourceSetRuleConfigs_Get.json @@ -0,0 +1,243 @@ +{ + "parameters": { + "accountId": "11349e3d-b23d-47fe-aaf2-3d4c3d9a3f5b", + "resourceSetRuleConfigName": "myNewresourceSetRuleConfigName", + "api-version": "2019-11-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "name": "myNewresourceSetRuleConfigName", + "pathPatternConfig": { + "rejectedPatterns": [ + { + "name": "OfficeDocuments", + "filterType": "Regex", + "path": "^.*\\.(?i)(DOC|DOCM|DOCX|DOT|ODP|ODS|ODT|PDF|POT|PPS|PPSX|PPT|PPTM|PPTX|XLC|XLS|XLSB|XLSM|XLSX|XLT)(?-i)$", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0 + } + ], + "acceptedPatterns": [], + "enableDefaultPatterns": true, + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 1585257544, + "regexReplacers": [ + { + "name": "Guid", + "disabled": false, + "description": null, + "regex": { + "regexStr": "([0-9A-F]{32}|[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12})", + "options": 9, + "minHex": 32 + }, + "replaceWith": "{GUID}", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false + }, + { + "name": "Number", + "disabled": false, + "description": null, + "regex": { + "regexStr": "^\\d+$", + "options": 8, + "minDigits": 1 + }, + "replaceWith": "{N}", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false + }, + { + "name": "yyyy-mm-ddThh-MM-ss", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(20)[1-9][0-9]([-\\._@]?)(0[1-9]|1[012])([-\\._@]?)(0[1-9]|[12][0-9]|3[01])([T])(2[0-3]|[01]?[0-9])([-\\._@]?)([0-5][0-9])([-\\._@]?)([0-5][0-9])(Z)?", + "options": 8, + "minDigits": 12 + }, + "replaceWith": "{N}$2{N}$4{N}$6{N}$8{N}$10{N}$12", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false + }, + { + "name": "yyyy-mm-ddThh", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(20)[1-9][0-9]([-\\._@]?)(0[1-9]|1[012])([-\\._@]?)(0[1-9]|[12][0-9]|3[01])([T])(2[0-3]|[01]?[0-9])(Z)?", + "options": 8, + "minDigits": 8 + }, + "replaceWith": "{N}$2{N}$4{N}$6{N}$8", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false, + "condition": "ApplyToNonFileName" + }, + { + "name": "yyyy-mm-ddZ", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(20)[1-9][0-9]([-\\._@]?)(0[1-9]|1[012])([-\\._@]?)(0[1-9]|[12][0-9]|3[01])(Z)", + "options": 8, + "minDigits": 6 + }, + "replaceWith": "{N}$2{N}$4{N}$6", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false + }, + { + "name": "yyyy-mm-dd-hhZ", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(20)[1-9][0-9]([-\\._@]?)(0[1-9]|1[012])([-\\._@]?)(0[1-9]|[12][0-9]|3[01])([-\\._@]?)(2[0-3]|[01]?[0-9])(Z)", + "options": 8, + "minDigits": 8 + }, + "replaceWith": "{N}$2{N}$4{N}$6{N}$8", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false + }, + { + "name": "NumberBetweenDelimiter", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(?<=[-\\._@])([\\d]+)(?=[-\\._@])|^(\\d+)(?=[-\\._@])|(?<=[-\\._@])(\\d+)$", + "options": 8, + "minDigits": 1 + }, + "replaceWith": "{N}", + "doNotReplaceRegex": { + "regexStr": "(?<=[-\\._@]|^)[v](\\d+)[\\.](\\d+)[\\.]?(\\d+)?(?=[-\\._@]|$)", + "options": 9, + "minDigits": 1, + "minLetters": 1 + }, + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false, + "condition": "ApplyToFileNameOrNonVersionString" + }, + { + "name": "4ByteHex", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(?<=[-\\._@]|^)([0-9A-F]{8,16})(?=[-\\._@]|$)", + "options": 9, + "minDigitsOrLetters": 8 + }, + "replaceWith": "{HEX}", + "doNotReplaceRegex": { + "regexStr": "(?<=[-\\._@]|^)[v](\\d+)[\\.](\\d+)[\\.]?(\\d+)?(?=[-\\._@]|$)", + "options": 9, + "minDigits": 1, + "minLetters": 1 + }, + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false + }, + { + "name": "NumberInFile", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(\\d+)", + "options": 8, + "minDigits": 1 + }, + "replaceWith": "{N}", + "doNotReplaceRegex": { + "regexStr": "(?<=[-\\._@]|^)[v](\\d+)[\\.](\\d+)[\\.]?(\\d+)?(?=[-\\._@]|$)", + "options": 9, + "minDigits": 1, + "minLetters": 1 + }, + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false, + "condition": "ApplyToFileName" + }, + { + "name": "Localization(DashSeparated)", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(?<=[-\\._@]|^)(ar-eg|ar-sa|cy-gb|da-dk|de-at|de-ch|de-de|en-au|en-ca|en-gb|en-ie|en-in|en-my|en-nz|en-ph|en-sg|en-us|en-ww|en-xa|en-za|es-ar|es-cl|es-es|es-mx|es-us|es-xl|fi-fi|fr-be|fr-ca|fr-ch|fr-fr|gu-in|hi-in|id-id|it-it|ja-jp|nb-no|nl-nl|nl-be|pt-br|pt-pt|pl-pl|ru-ru|sv-se|ta-in|te-in|zh-cn|zh-hk|zh-tw|ko-kr|tr-tr)(?=[-\\._@]|$)", + "options": 9, + "minLetters": 4, + "minDashes": 1 + }, + "replaceWith": "{LOC}", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false + }, + { + "name": "Localization(UnderscoreSeparated)", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(?<=[-\\._@]|^)(ar_eg|ar_sa|cy_gb|da_dk|de_at|de_ch|de_de|en_au|en_ca|en_gb|en_ie|en_in|en_my|en_nz|en_ph|en_sg|en_us|en_ww|en_xa|en_za|es_ar|es_cl|es_es|es_mx|es_us|es_xl|fi_fi|fr_be|fr_ca|fr_ch|fr_fr|gu_in|hi_in|id_id|it_it|ja_jp|nb_no|nl_nl|nl_be|pt_br|pt_pt|pl_pl|ru_ru|sv_se|ta_in|te_in|zh_cn|zh_hk|zh_tw|ko_kr|tr_tr)(?=[-\\._@]|$)", + "options": 9, + "minLetters": 4, + "minUnderscores": 1 + }, + "replaceWith": "{LOC}", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false + } + ], + "complexReplacers": [ + { + "name": "SparkPath", + "disabled": false, + "description": null, + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false, + "typeName": "Microsoft.DataMap.PathPattern.SparkPathReplacer" + } + ] + }, + "advancedResourceSet": { + "resourceSetProcessing": "Advanced", + "modifiedAt": "2021-07-08T23:14:06.4084575Z" + } + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/ResourceSetRuleConfigs_ListByAccount.json b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/ResourceSetRuleConfigs_ListByAccount.json new file mode 100644 index 000000000000..e85a31748936 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/examples/ResourceSetRuleConfigs_ListByAccount.json @@ -0,0 +1,247 @@ +{ + "parameters": { + "accountId": "11349e3d-b23d-47fe-aaf2-3d4c3d9a3f5b", + "resourceSetRuleConfigName": "myNewresourceSetRuleConfigName", + "api-version": "2019-11-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "value": [ + { + "name": "myNewresourceSetRuleConfigName", + "pathPatternConfig": { + "rejectedPatterns": [ + { + "name": "OfficeDocuments", + "filterType": "Regex", + "path": "^.*\\.(?i)(DOC|DOCM|DOCX|DOT|ODP|ODS|ODT|PDF|POT|PPS|PPSX|PPT|PPTM|PPTX|XLC|XLS|XLSB|XLSM|XLSX|XLT)(?-i)$", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0 + } + ], + "acceptedPatterns": [], + "enableDefaultPatterns": true, + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 1585257544, + "regexReplacers": [ + { + "name": "Guid", + "disabled": false, + "description": null, + "regex": { + "regexStr": "([0-9A-F]{32}|[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12})", + "options": 9, + "minHex": 32 + }, + "replaceWith": "{GUID}", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false + }, + { + "name": "Number", + "disabled": false, + "description": null, + "regex": { + "regexStr": "^\\d+$", + "options": 8, + "minDigits": 1 + }, + "replaceWith": "{N}", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false + }, + { + "name": "yyyy-mm-ddThh-MM-ss", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(20)[1-9][0-9]([-\\._@]?)(0[1-9]|1[012])([-\\._@]?)(0[1-9]|[12][0-9]|3[01])([T])(2[0-3]|[01]?[0-9])([-\\._@]?)([0-5][0-9])([-\\._@]?)([0-5][0-9])(Z)?", + "options": 8, + "minDigits": 12 + }, + "replaceWith": "{N}$2{N}$4{N}$6{N}$8{N}$10{N}$12", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false + }, + { + "name": "yyyy-mm-ddThh", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(20)[1-9][0-9]([-\\._@]?)(0[1-9]|1[012])([-\\._@]?)(0[1-9]|[12][0-9]|3[01])([T])(2[0-3]|[01]?[0-9])(Z)?", + "options": 8, + "minDigits": 8 + }, + "replaceWith": "{N}$2{N}$4{N}$6{N}$8", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false, + "condition": "ApplyToNonFileName" + }, + { + "name": "yyyy-mm-ddZ", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(20)[1-9][0-9]([-\\._@]?)(0[1-9]|1[012])([-\\._@]?)(0[1-9]|[12][0-9]|3[01])(Z)", + "options": 8, + "minDigits": 6 + }, + "replaceWith": "{N}$2{N}$4{N}$6", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false + }, + { + "name": "yyyy-mm-dd-hhZ", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(20)[1-9][0-9]([-\\._@]?)(0[1-9]|1[012])([-\\._@]?)(0[1-9]|[12][0-9]|3[01])([-\\._@]?)(2[0-3]|[01]?[0-9])(Z)", + "options": 8, + "minDigits": 8 + }, + "replaceWith": "{N}$2{N}$4{N}$6{N}$8", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false + }, + { + "name": "NumberBetweenDelimiter", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(?<=[-\\._@])([\\d]+)(?=[-\\._@])|^(\\d+)(?=[-\\._@])|(?<=[-\\._@])(\\d+)$", + "options": 8, + "minDigits": 1 + }, + "replaceWith": "{N}", + "doNotReplaceRegex": { + "regexStr": "(?<=[-\\._@]|^)[v](\\d+)[\\.](\\d+)[\\.]?(\\d+)?(?=[-\\._@]|$)", + "options": 9, + "minDigits": 1, + "minLetters": 1 + }, + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false, + "condition": "ApplyToFileNameOrNonVersionString" + }, + { + "name": "4ByteHex", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(?<=[-\\._@]|^)([0-9A-F]{8,16})(?=[-\\._@]|$)", + "options": 9, + "minDigitsOrLetters": 8 + }, + "replaceWith": "{HEX}", + "doNotReplaceRegex": { + "regexStr": "(?<=[-\\._@]|^)[v](\\d+)[\\.](\\d+)[\\.]?(\\d+)?(?=[-\\._@]|$)", + "options": 9, + "minDigits": 1, + "minLetters": 1 + }, + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false + }, + { + "name": "NumberInFile", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(\\d+)", + "options": 8, + "minDigits": 1 + }, + "replaceWith": "{N}", + "doNotReplaceRegex": { + "regexStr": "(?<=[-\\._@]|^)[v](\\d+)[\\.](\\d+)[\\.]?(\\d+)?(?=[-\\._@]|$)", + "options": 9, + "minDigits": 1, + "minLetters": 1 + }, + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false, + "condition": "ApplyToFileName" + }, + { + "name": "Localization(DashSeparated)", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(?<=[-\\._@]|^)(ar-eg|ar-sa|cy-gb|da-dk|de-at|de-ch|de-de|en-au|en-ca|en-gb|en-ie|en-in|en-my|en-nz|en-ph|en-sg|en-us|en-ww|en-xa|en-za|es-ar|es-cl|es-es|es-mx|es-us|es-xl|fi-fi|fr-be|fr-ca|fr-ch|fr-fr|gu-in|hi-in|id-id|it-it|ja-jp|nb-no|nl-nl|nl-be|pt-br|pt-pt|pl-pl|ru-ru|sv-se|ta-in|te-in|zh-cn|zh-hk|zh-tw|ko-kr|tr-tr)(?=[-\\._@]|$)", + "options": 9, + "minLetters": 4, + "minDashes": 1 + }, + "replaceWith": "{LOC}", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false + }, + { + "name": "Localization(UnderscoreSeparated)", + "disabled": false, + "description": null, + "regex": { + "regexStr": "(?<=[-\\._@]|^)(ar_eg|ar_sa|cy_gb|da_dk|de_at|de_ch|de_de|en_au|en_ca|en_gb|en_ie|en_in|en_my|en_nz|en_ph|en_sg|en_us|en_ww|en_xa|en_za|es_ar|es_cl|es_es|es_mx|es_us|es_xl|fi_fi|fr_be|fr_ca|fr_ch|fr_fr|gu_in|hi_in|id_id|it_it|ja_jp|nb_no|nl_nl|nl_be|pt_br|pt_pt|pl_pl|ru_ru|sv_se|ta_in|te_in|zh_cn|zh_hk|zh_tw|ko_kr|tr_tr)(?=[-\\._@]|$)", + "options": 9, + "minLetters": 4, + "minUnderscores": 1 + }, + "replaceWith": "{LOC}", + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false + } + ], + "complexReplacers": [ + { + "name": "SparkPath", + "disabled": false, + "description": null, + "createdBy": "AzureDataCatalog", + "modifiedBy": "AzureDataCatalog", + "lastUpdatedTimestamp": 0, + "disableRecursiveReplacerApplication": false, + "typeName": "Microsoft.DataMap.PathPattern.SparkPathReplacer" + } + ] + }, + "advancedResourceSet": { + "resourceSetProcessing": "Default", + "modifiedAt": "2021-07-08T23:14:06.4084575Z" + } + } + ] + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Account/readme.md b/specification/purview/data-plane/Azure.Analytics.Purview.Account/readme.md new file mode 100644 index 000000000000..befe41ceb425 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Account/readme.md @@ -0,0 +1,40 @@ +# Purview + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Purview Account Service. + +--- + +## Getting Started + +To build the SDK for Purview Account Service, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +### Basic Information +These are the global settings for the Azure Purview Account API. + +``` yaml +openapi-type: data-plane +tag: package-2019-11-01-preview +title: PurviewAccountClient +``` + + +### Tag: package-2019-11-01-preview + +These settings apply only when `--tag=package-2019-11-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2019-11-01-preview' +input-file: +- preview/2019-11-01-preview/account.json +``` diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_AutoComplete.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_AutoComplete.json index 4b3f8b7b6515..46bbc338f26a 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_AutoComplete.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_AutoComplete.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "autoCompleteRequest": { - "keywords": "tes", + "keywords": "exa", "filter": { "and": [ { @@ -13,23 +13,23 @@ }, "limit": 10 }, - "api-version": "2021-05-01" + "api-version": "2021-05-01-preview" }, "responses": { "200": { "body": { "value": [ { - "text": "test", - "queryPlusText": "test" + "text": "example", + "queryPlusText": "example" }, { - "text": "testconfiguration", - "queryPlusText": "testconfiguration" + "text": "exampleconfiguration", + "queryPlusText": "exampleconfiguration" }, { - "text": "testresources", - "queryPlusText": "testresources" + "text": "exampleresources", + "queryPlusText": "exampleresources" } ] } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Browse_EntityType.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Browse_EntityType.json new file mode 100644 index 000000000000..d05e3310e307 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Browse_EntityType.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "browseRequest": { + "entityType": "azure_data_explorer_cluster", + "limit": 10 + }, + "api-version": "2021-05-01-preview" + }, + "responses": { + "200": { + "body": { + "@search.count": 1, + "value": [ + { + "id": "7afe6da2-4275-4096-90af-e40479cf70e2", + "name": "examplecluster.westus", + "qualifiedName": "https://examplecluster.westus.kusto.windows.net", + "entityType": "azure_data_explorer_cluster", + "path": "/azure_data_explorer_cluster#examplecluster.westus.kusto.windows.net", + "owner": [ + { + "id": "12345678-1234-5678-1234-86b7251e0353", + "displayName": "Example DisplayName", + "mail": "example.displayname@microsoft.com", + "contactType": "Owner" + } + ], + "isLeaf": false + } + ] + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Browse_Path.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Browse_Path.json new file mode 100644 index 000000000000..7a3f758a76aa --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Browse_Path.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "browseRequest": { + "path": "/azure_data_explorer_cluster#examplecluster.westus.kusto.windows.net", + "limit": 10 + }, + "api-version": "2021-05-01-preview" + }, + "responses": { + "200": { + "body": { + "@search.count": 3, + "value": [ + { + "id": "55656c92-7e29-4831-a243-f95bdcdd397b", + "name": "exampledata", + "qualifiedName": "https://examplecluster.westus.kusto.windows.net/exampledata", + "entityType": "azure_data_explorer_database", + "path": "/azure_data_explorer_cluster#examplecluster.westus.kusto.windows.net/azure_data_explorer_database#exampledata", + "owner": [ + { + "id": "12345678-1234-5678-1234-86b7251e0353", + "displayName": "Example DisplayName", + "mail": "example.displayname@microsoft.com", + "contactType": "Owner" + } + ], + "isLeaf": false + }, + { + "id": "940aa60f-36f6-4dcf-8989-2faa49c74462", + "name": "exampledata2", + "qualifiedName": "https://examplecluster.westus.kusto.windows.net/exampledata2", + "entityType": "azure_data_explorer_database", + "path": "/azure_data_explorer_cluster#examplecluster.westus.kusto.windows.net/azure_data_explorer_database#exampledata2", + "owner": [ + { + "id": "12345678-1234-5678-1234-86b7251e0353", + "displayName": "Example DisplayName", + "mail": "example.displayname@microsoft.com", + "contactType": "Owner" + } + ], + "isLeaf": false + }, + { + "id": "19c4a337-840b-442d-ac9c-3df65bb33d69", + "name": "exampledata3", + "qualifiedName": "https://examplecluster.westus.kusto.windows.net/exampledata3", + "entityType": "azure_data_explorer_database", + "path": "/azure_data_explorer_cluster#examplecluster.westus.kusto.windows.net/azure_data_explorer_database#exampledata3", + "owner": [ + { + "id": "12345678-1234-5678-1234-86b7251e0353", + "displayName": "Example DisplayName", + "mail": "example.displayname@microsoft.com", + "contactType": "Owner" + } + ], + "isLeaf": false + } + ] + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query.json index 25831aa08b56..620938208c5f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "searchRequest": { - "keywords": "copyfile.csv", + "keywords": "examplefile.csv", "filter": { "and": [ { @@ -94,7 +94,7 @@ } ] }, - "api-version": "2021-05-01" + "api-version": "2021-05-01-preview" }, "responses": { "200": { @@ -104,8 +104,8 @@ { "@search.score": 1.0, "id": "97dc2d61-ef37-4cfd-8be8-d0a8b3524c1a", - "qualifiedName": "Office of the CEO@Glossary", - "name": "Office of the CEO", + "qualifiedName": "ExampleName1@Glossary", + "name": "Example Name 1", "description": null, "owner": null, "entityType": "AtlasGlossaryTerm", @@ -118,8 +118,8 @@ { "@search.score": 1.0, "id": "477b0278-81e3-473f-a2d4-d134f1b52f84", - "qualifiedName": "Government@Glossary", - "name": "Government", + "qualifiedName": "ExampleName2@Glossary", + "name": "Example Name 2", "description": null, "owner": null, "entityType": "AtlasGlossaryTerm", @@ -132,8 +132,8 @@ { "@search.score": 1.0, "id": "e09577ab-8d46-48af-b4b6-9476e2b5afb7", - "qualifiedName": "Diversified@Glossary", - "name": "Diversified", + "qualifiedName": "ExampleName2@Glossary", + "name": "Example Name 3", "description": null, "owner": null, "entityType": "AtlasGlossaryTerm", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_And.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_And.json index 65c5260a85d5..4ffde478a0d4 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_And.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_And.json @@ -17,7 +17,7 @@ ] } }, - "api-version": "2021-05-01" + "api-version": "2021-05-01-preview" }, "responses": { "200": { @@ -28,18 +28,18 @@ "@search.score": 1.0, "@search.highlights": { "qualifiedName": [ - "https://adctestaccount.blob.core.windows.net/adcresource/csv/sourcedata.csv" + "https://exampleaccount.blob.core.windows.net/examplepath/csv/exampledata.csv" ] }, "id": "63b92968-c9ac-4af8-8cff-f61d147bbf88", - "qualifiedName": "https://adctestaccount.blob.core.windows.net/adcresource/csv/sourcedata.csv", - "name": "sourcedata.csv", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/exampledata.csv", + "name": "exampledata.csv", "description": null, "owner": null, "entityType": "azure_blob_path", "classification": [], "label": [ - "Microsoft.Label.9FBDE396_1A24_4C79_8EDF_9254A0F35055" + "Example.Label" ], "assetType": [ "Azure Blob Storage" @@ -51,18 +51,18 @@ "@search.score": 1.0, "@search.highlights": { "qualifiedName": [ - "https://adctestaccount.blob.core.windows.net/adcresource/csv/AllTypes.csv" + "https://exampleaccount.blob.core.windows.net/examplepath/csv/AllTypes.csv" ] }, "id": "2605db54-086d-4d6c-adb6-f0bbed6c6eab", - "qualifiedName": "https://adctestaccount.blob.core.windows.net/adcresource/csv/AllTypes.csv", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/AllTypes.csv", "name": "AllTypes.csv", "description": null, "owner": null, "entityType": "azure_blob_path", "classification": [], "label": [ - "Microsoft.Label.9FBDE396_1A24_4C79_8EDF_9254A0F35055" + "Example.Label" ], "assetType": [ "Azure Blob Storage" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_AndOrNested.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_AndOrNested.json index 7435ef4d612d..0caa0100e580 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_AndOrNested.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_AndOrNested.json @@ -19,7 +19,7 @@ { "attributeName": "name", "operator": "eq", - "attributeValue": "sourcedata.csv" + "attributeValue": "exampledata.csv" }, { "attributeName": "name", @@ -31,7 +31,7 @@ ] } }, - "api-version": "2021-05-01" + "api-version": "2021-05-01-preview" }, "responses": { "200": { @@ -42,18 +42,18 @@ "@search.score": 1.0, "@search.highlights": { "qualifiedName": [ - "https://adctestaccount.blob.core.windows.net/adcresource/csv/sourcedata.csv" + "https://exampleaccount.blob.core.windows.net/examplepath/csv/exampledata.csv" ] }, "id": "63b92968-c9ac-4af8-8cff-f61d147bbf88", - "qualifiedName": "https://adctestaccount.blob.core.windows.net/adcresource/csv/sourcedata.csv", - "name": "sourcedata.csv", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/exampledata.csv", + "name": "exampledata.csv", "description": null, "owner": null, "entityType": "azure_blob_path", "classification": [], "label": [ - "Microsoft.Label.9FBDE396_1A24_4C79_8EDF_9254A0F35055" + "Example.Label" ], "assetType": [ "Azure Blob Storage" @@ -65,21 +65,21 @@ "@search.score": 1.0, "@search.highlights": { "qualifiedName": [ - "https://adctestaccount.blob.core.windows.net/adcresource/csv/AllTypes.csv" + "https://exampleaccount.blob.core.windows.net/examplepath/csv/AllTypes.csv" ], "name": [ "AllTypes.csv" ] }, "id": "2605db54-086d-4d6c-adb6-f0bbed6c6eab", - "qualifiedName": "https://adctestaccount.blob.core.windows.net/adcresource/csv/AllTypes.csv", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/AllTypes.csv", "name": "AllTypes.csv", "description": null, "owner": null, "entityType": "azure_blob_path", "classification": [], "label": [ - "Microsoft.Label.9FBDE396_1A24_4C79_8EDF_9254A0F35055" + "Example.Label" ], "assetType": [ "Azure Blob Storage" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_AssetType.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_AssetType.json index 15def0d52695..e5766d57c433 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_AssetType.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_AssetType.json @@ -90,7 +90,7 @@ ] } }, - "api-version": "2021-05-01" + "api-version": "2021-05-01-preview" }, "responses": { "200": { @@ -100,8 +100,8 @@ { "@search.score": 1.0, "id": "24c16e53-1bfd-4d6c-b4ce-b1f6f6f60000", - "qualifiedName": "mssql://adcsqlmi.public.1bed77b0fc93.database.windows.net:3342/adcsqlmidb/dbo/onpremsqltosqlmitestlineage_202008100551", - "name": "onpremsqltosqlmitestlineage_202008100551", + "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampledata1", + "name": "exampledata1", "description": null, "owner": null, "entityType": "azure_sql_mi_table", @@ -116,8 +116,8 @@ { "@search.score": 1.0, "id": "d7b516fc-5d38-40f8-baeb-72f6f6f60000", - "qualifiedName": "mssql://adcsqlmi.public.1bed77b0fc93.database.windows.net:3342/adcsqlmidb/dbo/adlsgen1tosqlmitestlineage_202008020130", - "name": "adlsgen1tosqlmitestlineage_202008020130", + "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampledata2", + "name": "exampledata2", "description": null, "owner": null, "entityType": "azure_sql_mi_table", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Attribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Attribute.json index 69b30a5f6670..33704afe8979 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Attribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Attribute.json @@ -7,10 +7,10 @@ "filter": { "attributeName": "name", "operator": "eq", - "attributeValue": "sourcedata.csv" + "attributeValue": "exampledata.csv" } }, - "api-version": "2021-05-01" + "api-version": "2021-05-01-preview" }, "responses": { "200": { @@ -20,14 +20,14 @@ { "@search.score": 1.0, "id": "63b92968-c9ac-4af8-8cff-f61d147bbf88", - "qualifiedName": "https://adctestaccount.blob.core.windows.net/adcresource/csv/sourcedata.csv", - "name": "sourcedata.csv", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/exampledata.csv", + "name": "exampledata.csv", "description": null, "owner": null, "entityType": "azure_blob_path", "classification": [], "label": [ - "Microsoft.Label.9FBDE396_1A24_4C79_8EDF_9254A0F35055" + "Example.Label" ], "assetType": [ "Azure Blob Storage" @@ -38,14 +38,14 @@ { "@search.score": 1.0, "id": "55b2290d-e11d-4ed2-8c7a-0d8d35eb6254", - "qualifiedName": "https://adctestgen2account.dfs.core.windows.net/adcresource/csv/sourcedata.csv", - "name": "sourcedata.csv", + "qualifiedName": "https://examplegen2account.dfs.core.windows.net/examplepath/csv/exampledata.csv", + "name": "exampledata.csv", "description": null, "owner": "$superuser", "entityType": "azure_datalake_gen2_path", "classification": [], "label": [ - "Microsoft.Label.9FBDE396_1A24_4C79_8EDF_9254A0F35055" + "Example.Label" ], "assetType": [ "Azure Data Lake Storage Gen2" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Classification.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Classification.json index 896f7d9a960f..663c18c01c4a 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Classification.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Classification.json @@ -9,7 +9,7 @@ "includeSubClassifications": true } }, - "api-version": "2021-05-01" + "api-version": "2021-05-01-preview" }, "responses": { "200": { @@ -19,8 +19,8 @@ { "@search.score": 1.0, "id": "b9638b91-884f-4e5e-98b5-29f6f6f60000", - "qualifiedName": "mssql://adcdbserver.database.windows.net/adcsqldb/SalesLT/Customer", - "name": "Customer", + "qualifiedName": "mssql://exampleserver.database.windows.net/examplesqldb/examplepath/exampledata1", + "name": "exampledata1", "description": null, "owner": null, "entityType": "azure_sql_table", @@ -40,8 +40,8 @@ { "@search.score": 1.0, "id": "01aefb9a-61cd-4a02-a572-70f6f6f60000", - "qualifiedName": "mssql://adcdbserver.database.windows.net/adcdw/dbo/ProspectiveBuyer", - "name": "ProspectiveBuyer", + "qualifiedName": "mssql://exampleserver.database.windows.net/exampledw/examplepath/exampledata2", + "name": "exampledata2", "description": null, "owner": null, "entityType": "azure_sql_dw_table", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Facet.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Facet.json index c4c8c1aef5c4..f6412b183f3d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Facet.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Facet.json @@ -42,7 +42,7 @@ } ] }, - "api-version": "2021-05-01" + "api-version": "2021-05-01-preview" }, "responses": { "200": { @@ -113,7 +113,7 @@ "label": [ { "count": 835, - "value": "Microsoft.Label.9FBDE396_1A24_4C79_8EDF_9254A0F35055" + "value": "Example.Label" } ], "classificationCategory": [], @@ -128,8 +128,8 @@ { "@search.score": 1.0, "id": "24c16e53-1bfd-4d6c-b4ce-b1f6f6f60000", - "qualifiedName": "mssql://adcsqlmi.public.1bed77b0fc93.database.windows.net:3342/adcsqlmidb/dbo/onpremsqltosqlmitestlineage_202008100551", - "name": "onpremsqltosqlmitestlineage_202008100551", + "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampledata", + "name": "exampledata", "description": null, "owner": null, "entityType": "azure_sql_mi_table", @@ -144,8 +144,8 @@ { "@search.score": 1.0, "id": "d7b516fc-5d38-40f8-baeb-72f6f6f60000", - "qualifiedName": "mssql://adcsqlmi.public.1bed77b0fc93.database.windows.net:3342/adcsqlmidb/dbo/adlsgen1tosqlmitestlineage_202008020130", - "name": "adlsgen1tosqlmitestlineage_202008020130", + "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampledata2", + "name": "exampledata2", "description": null, "owner": null, "entityType": "azure_sql_mi_table", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_FileExtension.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_FileExtension.json index 394ed945850b..cf6a90c8d59e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_FileExtension.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_FileExtension.json @@ -12,7 +12,7 @@ ] } }, - "api-version": "2021-05-01" + "api-version": "2021-05-01-preview" }, "responses": { "200": { @@ -22,8 +22,8 @@ { "@search.score": 1.0, "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9", - "qualifiedName": "https://testaccount.blob.core.windows.net/editingintegration/backupCustomer.txt", - "name": "backupCustomer.txt", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata.txt", + "name": "exampledata.txt", "description": null, "owner": null, "entityType": "azure_blob_path", @@ -38,8 +38,8 @@ { "@search.score": 1.0, "id": "14d857b9-e2c1-4118-8bfa-12e53ae6ce7f", - "qualifiedName": "https://testaccount.blob.core.windows.net/editingintegration/backupCustomer.txt", - "name": "backupCustomer.txt", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata.txt", + "name": "exampledata.txt", "description": null, "owner": null, "entityType": "azure_blob_path", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Id.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Id.json index 959cafc600c1..c2e3bfdbc10f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Id.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Id.json @@ -12,7 +12,7 @@ ] } }, - "api-version": "2021-05-01" + "api-version": "2021-05-01-preview" }, "responses": { "200": { @@ -22,8 +22,8 @@ { "@search.score": 1.0, "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9", - "qualifiedName": "https://fexiaooneboxvvtbtdum.blob.core.windows.net/editingintegration/backupCustomer.txt", - "name": "backupCustomer.txt", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata.txt", + "name": "exampledata.txt", "description": null, "owner": null, "entityType": "azure_blob_path", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Not.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Not.json index dca4c2baa643..568a0bab7541 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Not.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Not.json @@ -10,7 +10,7 @@ } } }, - "api-version": "2021-05-01" + "api-version": "2021-05-01-preview" }, "responses": { "200": { @@ -20,8 +20,8 @@ { "@search.score": 1.0, "id": "11fd6e94-2dc6-4ebd-822c-caf6f6f60000", - "qualifiedName": "mssql://adcsqlmi.public.1bed77b0fc93.database.windows.net:3342/adcsqlmidb/dbo/adlsgen1tosqlmitestlineage_202008231230", - "name": "adlsgen1tosqlmitestlineage_202008231230", + "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/exampledb/dbo/exampledata", + "name": "exampledata", "description": null, "owner": null, "entityType": "azure_sql_mi_table", @@ -36,8 +36,8 @@ { "@search.score": 1.0, "id": "1af82c87-798c-41a2-abab-93f6f6f60000", - "qualifiedName": "mssql://adcsqlmi.public.1bed77b0fc93.database.windows.net:3342/adcsqlmidb/dbo/adlsgen1tosqlmitestlineage_202009211230", - "name": "adlsgen1tosqlmitestlineage_202009211230", + "qualifiedName": "mssql://exampleaccount.database.windows.net:3342/exampledb/dbo/exampledata2", + "name": "exampledata2", "description": null, "owner": null, "entityType": "azure_sql_mi_table", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Taxonomy.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Taxonomy.json index 0aa8aed5d087..d75d6cf1b8d6 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Taxonomy.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Taxonomy.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "searchRequest": { - "keywords": "test", + "keywords": "example", "filter": { "and": [ { @@ -62,7 +62,7 @@ } } }, - "api-version": "2021-05-01" + "api-version": "2021-05-01-preview" }, "responses": { "200": { @@ -72,8 +72,8 @@ { "@search.score": 1.0, "id": "97dc2d61-ef37-4cfd-8be8-d0a8b3524c1a", - "qualifiedName": "Office of the CEO@Glossary", - "name": "Office of the CEO", + "qualifiedName": "ExampleName1@Glossary", + "name": "examplename1", "description": null, "owner": null, "entityType": "AtlasGlossaryTerm", @@ -86,8 +86,8 @@ { "@search.score": 1.0, "id": "477b0278-81e3-473f-a2d4-d134f1b52f84", - "qualifiedName": "Government@Glossary", - "name": "Government", + "qualifiedName": "ExampleName2@Glossary", + "name": "examplename2", "description": null, "owner": null, "entityType": "AtlasGlossaryTerm", @@ -100,8 +100,8 @@ { "@search.score": 1.0, "id": "e09577ab-8d46-48af-b4b6-9476e2b5afb7", - "qualifiedName": "Diversified@Glossary", - "name": "Diversified", + "qualifiedName": "ExampleName3@Glossary", + "name": "examplename3", "description": null, "owner": null, "entityType": "AtlasGlossaryTerm", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Term.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Term.json index 19cb80a947cd..aa297546363b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Term.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Term.json @@ -7,12 +7,12 @@ "filter": { "and": [ { - "term": "TestTerm" + "term": "ExampleTerm" } ] } }, - "api-version": "2021-05-01" + "api-version": "2021-05-01-preview" }, "responses": { "200": { @@ -22,8 +22,8 @@ { "@search.score": 1.0, "id": "b20ac13a-7883-4376-b076-bac9f8f214a8", - "qualifiedName": "https://adcperftest_34f7fbad-a.blob.core.windows.net/tcphcontainer_34f7fbad-a", - "name": "tcphcontainer_34f7fbad-a", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplecontainer", + "name": "examplecontainer", "description": null, "owner": null, "entityType": "azure_blob_container", @@ -33,13 +33,13 @@ ], "term": [ { - "name": "TestTerm", + "name": "ExampleTerm", "glossaryName": "Glossary" } ], "contact": [], "label": [ - "Microsoft.Label.9FBDE396_1A24_4C79_8EDF_9254A0F35055" + "Example.Label" ] } ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_TermOfGlossary.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_TermOfGlossary.json index e85a59ba4a5d..3dac47ae048d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_TermOfGlossary.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_TermOfGlossary.json @@ -7,13 +7,13 @@ "filter": { "and": [ { - "term": "TestTerm", + "term": "ExampleTerm", "glossaryName": "Glossary" } ] } }, - "api-version": "2021-05-01" + "api-version": "2021-05-01-preview" }, "responses": { "200": { @@ -23,8 +23,8 @@ { "@search.score": 1.0, "id": "b20ac13a-7883-4376-b076-bac9f8f214a8", - "qualifiedName": "https://adcperftest_34f7fbad-a.blob.core.windows.net/tcphcontainer_34f7fbad-a", - "name": "tcphcontainer_34f7fbad-a", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplecontainer", + "name": "examplecontainer", "description": null, "owner": null, "entityType": "azure_blob_container", @@ -34,13 +34,13 @@ ], "term": [ { - "name": "TestTerm", + "name": "ExampleTerm", "glossaryName": "Glossary" } ], "contact": [], "label": [ - "Microsoft.Label.9FBDE396_1A24_4C79_8EDF_9254A0F35055" + "Example.Label" ] } ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Type.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Type.json index a0aa0cc0336d..003339c6f2f9 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Type.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Query_Type.json @@ -13,7 +13,7 @@ ] } }, - "api-version": "2021-05-01" + "api-version": "2021-05-01-preview" }, "responses": { "200": { @@ -23,14 +23,14 @@ { "@search.score": 1.0, "id": "1d797ddf-47bf-4151-8fe8-918590d62e70", - "qualifiedName": "https://adctestaccount.blob.core.windows.net/scanoutput/akkejidmzidikzkklszpegbzsmbhpblgfihd.csv", - "name": "akkejidmzidikzkklszpegbzsmbhpblgfihd.csv", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata.csv", + "name": "exampledata.csv", "description": null, "owner": null, "entityType": "azure_blob_path", "classification": [], "label": [ - "Microsoft.Label.9FBDE396_1A24_4C79_8EDF_9254A0F35055" + "Example.Label" ], "assetType": [ "Azure Blob Storage" @@ -41,14 +41,14 @@ { "@search.score": 1.0, "id": "d3e83b17-c730-4898-94c8-58579cda04f6", - "qualifiedName": "https://adctestaccount.blob.core.windows.net/scanoutput/addkkaaczasfpzkjmhzacdezbgpcoohlpjlp.csv", - "name": "addkkaaczasfpzkjmhzacdezbgpcoohlpjlp.csv", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata2.csv", + "name": "exampledata2.csv", "description": null, "owner": null, "entityType": "azure_blob_path", "classification": [], "label": [ - "Microsoft.Label.9FBDE396_1A24_4C79_8EDF_9254A0F35055" + "Example.Label" ], "assetType": [ "Azure Blob Storage" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Suggest.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Suggest.json index dcfcb66a9c29..95b0fd0e47c2 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Suggest.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Discovery_Suggest.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "suggestRequest": { - "keywords": "copyfile", + "keywords": "exampledata", "filter": { "and": [ { @@ -13,20 +13,20 @@ }, "limit": 10 }, - "api-version": "2021-05-01" + "api-version": "2021-05-01-preview" }, "responses": { "200": { "body": { "value": [ { - "@search.text": "copyfile.csv", + "@search.text": "exampledata.csv", "@search.score": 9.81402, - "description": "a copied file", + "description": "Example Description", "id": "af7a01b0-1b14-4ab6-83a5-12cb11a717ed", - "name": "copyfile.csv", + "name": "exampledata.csv", "owner": "$superuser", - "qualifiedName": "https://adctestaccount.blob.core.windows.net/adcresource/copyfile.csv", + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata.csv", "entityType": "azure_blob_path", "assetType": [ "Azure Blob Storage" @@ -37,16 +37,16 @@ "contact": [ { "id": "8a597ffc-6993-4772-ac25-86b7251e1234", - "info": "Expert for this entity", + "info": "Example Info", "contactType": "Expert" } ], "label": [ - "Microsoft.Label.9FBDE396_1A24_4C79_8EDF_9254A0F35055" + "Example.Label" ], "term": [ { - "name": "Test Term", + "name": "Example Term", "glossaryName": "Glossary" } ] diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_AddClassificationsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_AddClassificationsByUniqueAttribute.json index 0830fd37c31d..e82bbe57a2f3 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_AddClassificationsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_AddClassificationsByUniqueAttribute.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", - "attr:qualifiedName": "https://test_azure_storage_account.core.windows.net", + "attr:qualifiedName": "https://exampleaccount.core.windows.net", "atlasClassificationArray": [ { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_Create.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_Create.json index aa7e5c290ff2..b4946962b191 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_Create.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_Create.json @@ -6,11 +6,11 @@ "entity": { "typeName": "azure_storage_account", "attributes": { - "owner": "test_owner", + "owner": "ExampleOwner", "modifiedTime": 0, "createTime": 0, - "qualifiedName": "https://test_azure_storage_account.core.windows.net", - "name": "test_azure_storage_account", + "qualifiedName": "https://exampleaccount.core.windows.net", + "name": "ExampleStorageAccount", "description": null, "publicAccessLevel": null }, @@ -18,19 +18,19 @@ "Expert": [ { "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", - "info": "expert info" + "info": "Example Expert Info" } ], "Owner": [ { "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", - "info": "owner info" + "info": "Example Owner Info" } ] }, "status": "ACTIVE", - "createdBy": "ServiceAdmin", - "updatedBy": "ServiceAdmin", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "version": 0 } } @@ -43,7 +43,7 @@ { "typeName": "azure_storage_account", "attributes": { - "qualifiedName": "https://test_azure_storage_account.core.windows.net" + "qualifiedName": "https://exampleaccount.core.windows.net" }, "lastModifiedTS": "1", "guid": "38d3c41f-300c-434e-8dad-0b1a7cb5efd6", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_CreateOrUpdateEntities.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_CreateOrUpdateEntities.json index 99a0b46a980b..779992eff9ba 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_CreateOrUpdateEntities.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_CreateOrUpdateEntities.json @@ -7,11 +7,11 @@ { "typeName": "azure_storage_account", "attributes": { - "owner": "test_owner", + "owner": "ExampleOwner", "modifiedTime": 0, "createTime": 0, - "qualifiedName": "test_azure_storage_account_1022_5", - "name": "test_azure_storage_account_1022_5", + "qualifiedName": "exampleaccount1", + "name": "ExampleStorageAccount1", "description": null, "publicAccessLevel": null }, @@ -19,49 +19,49 @@ "Expert": [ { "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", - "info": "expert info" + "info": "Example Expert Info" } ], "Owner": [ { "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", - "info": "owner info" + "info": "Example Owner Info" } ] }, "status": "ACTIVE", - "createdBy": "ServiceAdmin", - "updatedBy": "ServiceAdmin", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "version": 0 }, { "typeName": "azure_storage_account", "attributes": { - "owner": "test_owner", + "owner": "ExampleOwner", "modifiedTime": 0, "createTime": 0, - "qualifiedName": "test_azure_storage_account_1022_4", - "name": "test_azure_storage_account_1022_4", - "description": "test_update_description", + "qualifiedName": "exampleaccount2", + "name": "ExampleStorageAccount2", + "description": "Example Description", "publicAccessLevel": null }, "contacts": { "Expert": [ { "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", - "info": "expert info" + "info": "Example Expert Info" } ], "Owner": [ { "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", - "info": "owner info" + "info": "Example Owner Info" } ] }, "status": "ACTIVE", - "createdBy": "ServiceAdmin", - "updatedBy": "ServiceAdmin", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "version": 0 } ] @@ -75,7 +75,7 @@ { "typeName": "azure_storage_account", "attributes": { - "qualifiedName": "test_azure_storage_account_1022_4" + "qualifiedName": "exampleaccount2" }, "lastModifiedTS": "2", "guid": "b2f9c306-cf65-4bb0-878e-cfaafde156b1", @@ -86,7 +86,7 @@ { "typeName": "azure_storage_account", "attributes": { - "qualifiedName": "test_azure_storage_account_1022_5" + "qualifiedName": "exampleaccount1" }, "lastModifiedTS": "1", "guid": "321493e3-3fb7-4b3e-9df7-3b69154174c2", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_DeleteByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_DeleteByGuid.json index 957eab984595..029021e09916 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_DeleteByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_DeleteByGuid.json @@ -13,9 +13,9 @@ "status": "ACTIVE", "lastModifiedTS": "2", "attributes": { - "owner": "test_owner", - "qualifiedName": "https://test_azure_storage_account.core.windows.net", - "name": "test_azure_storage_account" + "owner": "ExampleOwner", + "qualifiedName": "https://exampleaccount.core.windows.net", + "name": "ExampleStorageAaccount" }, "typeName": "azure_storage_account" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_DeleteByGuids.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_DeleteByGuids.json index 4ddbad395bb2..f13c86d2564a 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_DeleteByGuids.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_DeleteByGuids.json @@ -14,7 +14,7 @@ { "typeName": "azure_blob_container", "attributes": { - "qualifiedName": "https://account228.blob.core.windows.net/e2etest_container2_228_2" + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplecontainer" }, "guid": "18e06957-e265-967a-07f1-e14e2ab8940f", "status": "ACTIVE" @@ -22,7 +22,7 @@ { "typeName": "azure_blob_container", "attributes": { - "qualifiedName": "https://account228.blob.core.windows.net/e2etest_container2_228" + "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplecontainer2" }, "guid": "cc0730ba-9b30-41f0-6953-559d17626d2b", "status": "ACTIVE" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_DeleteByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_DeleteByUniqueAttribute.json index 0afba7700485..34948b6504ab 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_DeleteByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_DeleteByUniqueAttribute.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", - "attr:qualifiedName": "https://test_azure_storage_account.core.windows.net" + "attr:qualifiedName": "https://exampleaccount.core.windows.net" }, "responses": { "200": { @@ -11,17 +11,17 @@ "DELETE": [ { "classificationNames": [], - "displayText": "new name", + "displayText": "Example Name", "guid": "e0ba3f20-f3b5-4d52-b769-ed35a02df60a", "meaningNames": [], "meanings": [], "status": "ACTIVE", - "lastModifiedTS": "3", + "lastModifiedTS": "1", "attributes": { - "owner": "test_owner", + "owner": "ExampleOwner", "createTime": 0, - "qualifiedName": "https://test_azure_storage_account.core.windows.net", - "name": "new name" + "qualifiedName": "https://exampleaccount.core.windows.net", + "name": "ExampleName" }, "typeName": "azure_storage_account" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_DeleteClassificationByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_DeleteClassificationByUniqueAttribute.json index b587ce36cd4a..4d2cc9927070 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_DeleteClassificationByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_DeleteClassificationByUniqueAttribute.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "typeName": "column", "classificationName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER", - "attr:qualifiedName": "https://adcperftest.blob.core.windows.net/tcphcontainer/tcph1_10.csv" + "attr:qualifiedName": "https://exampleaccount.blob.core.windows.net/examplecontainer/exampledata.csv" }, "responses": { "204": {} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_GetByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_GetByGuid.json index ac513add08f6..918d06e41adc 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_GetByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_GetByGuid.json @@ -11,15 +11,15 @@ "typeName": "column", "attributes": { "owner": null, - "qualifiedName": "adl://adlsgary.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/Target/XmlPeek/@XmlInputPath", + "qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/Target/XmlPeek/@XmlInputPath", "name": "~XmlInputPath", "description": null, "type": "string" }, "guid": "5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb", "status": "ACTIVE", - "createdBy": "ServiceAdmin", - "updatedBy": "ServiceAdmin", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1553072455110, "updateTime": 1553072455110, "version": 0, @@ -44,13 +44,13 @@ "Expert": [ { "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", - "info": "expert info" + "info": "Example Expert Info" } ], "Owner": [ { "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", - "info": "owner info" + "info": "Example Owner Info" } ] } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_GetByUniqueAttributes.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_GetByUniqueAttributes.json index e2954e5d9de6..1985ed6cb10e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_GetByUniqueAttributes.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_GetByUniqueAttributes.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", - "attr:qualifiedName": "https://test_azure_storage_account.core.windows.net" + "attr:qualifiedName": "https://exampleaccount.core.windows.net" }, "responses": { "200": { @@ -21,10 +21,10 @@ "lastModifiedTS": "2", "version": 0.0, "attributes": { - "owner": "test_owner", - "qualifiedName": "https://test_azure_storage_account.core.windows.net", + "owner": "ExampleOwner", + "qualifiedName": "https://exampleaccount.core.windows.net", "createTime": 0, - "name": "new name" + "name": "ExampleNewName" }, "typeName": "azure_storage_account" }, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_GetEntitiesByUniqueAttributes.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_GetEntitiesByUniqueAttributes.json index 78f1b5287823..8c7356021a43 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_GetEntitiesByUniqueAttributes.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_GetEntitiesByUniqueAttributes.json @@ -2,8 +2,8 @@ "parameters": { "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", - "attr_1:qualifiedName": "adl://adlsgary.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/PropertyGroup/DttpCopyDependsOn", - "attr_2:qualifiedName": "adl://adlsgary.azuredatalakestore.net/123/1/Experience/CBT/Extensions/CodeAnalysis.targets#:xml/Project/PropertyGroup/MSBuildAllProjects" + "attr_1:qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/PropertyGroup/ExampleName1", + "attr_2:qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/Experience/CBT/Extensions/CodeAnalysis.targets#:xml/Project/PropertyGroup/ExampleName2" }, "responses": { "200": { @@ -14,15 +14,15 @@ "typeName": "column", "attributes": { "owner": null, - "qualifiedName": "adl://adlsgary.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/PropertyGroup/DttpCopyDependsOn", - "name": "DttpCopyDependsOn", + "qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/PropertyGroup/ExampleName1", + "name": "ExampleName1", "description": null, "type": "string" }, "guid": "784c0f2f-afd2-e26b-f9cb-984f6c2c5021", "status": "ACTIVE", - "createdBy": "ServiceAdmin", - "updatedBy": "ServiceAdmin", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1553072455110, "updateTime": 1553072455110, "version": 0, @@ -48,15 +48,15 @@ "typeName": "column", "attributes": { "owner": null, - "qualifiedName": "adl://adlsgary.azuredatalakestore.net/123/1/Experience/CBT/Extensions/CodeAnalysis.targets#:xml/Project/PropertyGroup/MSBuildAllProjects", - "name": "MSBuildAllProjects", + "qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/Experience/CBT/Extensions/CodeAnalysis.targets#:xml/Project/PropertyGroup/ExampleName2", + "name": "ExampleName2", "description": null, "type": "string" }, "guid": "b4ebc8be-cef4-860a-bee9-28cc34cb5caa", "status": "ACTIVE", - "createdBy": "ServiceAdmin", - "updatedBy": "ServiceAdmin", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1553072455110, "updateTime": 1553072455110, "version": 0, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_GetHeader.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_GetHeader.json index 24db04e29933..c9ae29bce60d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_GetHeader.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_GetHeader.json @@ -9,17 +9,17 @@ "classificationNames": [ "MICROSOFT.PERSONAL.EMAIL" ], - "displayText": "test_azure_storage_account", + "displayText": "Example Storage Account", "guid": "9fb74c11-ac48-4650-95bc-760665c5bd92", "meaningNames": [], "meanings": [], "status": "ACTIVE", "lastModifiedTS": "3", "attributes": { - "owner": "test_owner", + "owner": "ExampleOwner", "createTime": 0, - "qualifiedName": "https://test_azure_storage_account.core.windows.net", - "name": "test_azure_storage_account" + "qualifiedName": "https://exampleaccount.core.windows.net", + "name": "ExampleStorageAccount" }, "typeName": "azure_storage_account" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_ListByGuids.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_ListByGuids.json index 3cd32c029dd2..23681ef47140 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_ListByGuids.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_ListByGuids.json @@ -15,15 +15,15 @@ "typeName": "column", "attributes": { "owner": null, - "qualifiedName": "adl://adlsgary.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/PropertyGroup/DttpCopyDependsOn", - "name": "DttpCopyDependsOn", + "qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/PropertyGroup/ExampleName1", + "name": "ExampleName1", "description": null, "type": "string" }, "guid": "784c0f2f-afd2-e26b-f9cb-984f6c2c5021", "status": "ACTIVE", - "createdBy": "ServiceAdmin", - "updatedBy": "ServiceAdmin", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1553072455110, "updateTime": 1553072455110, "version": 0, @@ -48,13 +48,13 @@ "Expert": [ { "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", - "info": "expert info" + "info": "Example Expert Info" } ], "Owner": [ { "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", - "info": "owner info" + "info": "Example Owner Info" } ] } @@ -63,15 +63,15 @@ "typeName": "column", "attributes": { "owner": null, - "qualifiedName": "adl://adlsgary.azuredatalakestore.net/123/1/Experience/CBT/Extensions/CodeAnalysis.targets#:xml/Project/PropertyGroup/MSBuildAllProjects", - "name": "MSBuildAllProjects", + "qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/Experience/CBT/Extensions/CodeAnalysis.targets#:xml/Project/PropertyGroup/ExampleName2", + "name": "ExampleName2", "description": null, "type": "string" }, "guid": "b4ebc8be-cef4-860a-bee9-28cc34cb5caa", "status": "ACTIVE", - "createdBy": "ServiceAdmin", - "updatedBy": "ServiceAdmin", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1553072455110, "updateTime": 1553072455110, "version": 0, @@ -96,13 +96,13 @@ "Expert": [ { "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", - "info": "expert info" + "info": "Example Expert Info" } ], "Owner": [ { "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", - "info": "owner info" + "info": "Example Owner Info" } ] } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_PartialUpdateEntityAttributeByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_PartialUpdateEntityAttributeByGuid.json index 2bca7de38a3d..343a0b2ecb25 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_PartialUpdateEntityAttributeByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_PartialUpdateEntityAttributeByGuid.json @@ -2,8 +2,8 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "394d9a03-912e-483b-bbd2-bedee1a69798", - "name": "name", - "body": "new name" + "name": "ExampleName", + "body": "ExampleNewName" }, "responses": { "200": { @@ -13,7 +13,7 @@ { "typeName": "azure_storage_account", "attributes": { - "qualifiedName": "https://test_azure_storage_account.core.windows.net" + "qualifiedName": "https://exampleaccount.core.windows.net" }, "lastModifiedTS": "1", "guid": "394d9a03-912e-483b-bbd2-bedee1a69798", @@ -25,7 +25,7 @@ { "typeName": "azure_storage_account", "attributes": { - "qualifiedName": "https://test_azure_storage_account.core.windows.net" + "qualifiedName": "https://exampleaccount.core.windows.net" }, "lastModifiedTS": "1", "guid": "394d9a03-912e-483b-bbd2-bedee1a69798" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_PartialUpdateEntityByUniqueAttributes.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_PartialUpdateEntityByUniqueAttributes.json index 799c39b5988f..a38dc403ff1d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_PartialUpdateEntityByUniqueAttributes.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_PartialUpdateEntityByUniqueAttributes.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", - "attr:qualifiedName": "https://test_azure_storage_account.core.windows.net", + "attr:qualifiedName": "https://exampleaccount.core.windows.net", "atlasEntityWithExtInfo": { "entity": { "createTime": 1.605766397985E12, @@ -18,10 +18,10 @@ "lastModifiedTS": "1", "version": 0.0, "attributes": { - "owner": "test_owner", - "qualifiedName": "https://test_azure_storage_account.core.windows.net", + "owner": "ExampleOwner", + "qualifiedName": "https://exampleaccount.core.windows.net", "createTime": 0, - "name": "new name" + "name": "ExampleNewName" }, "typeName": "azure_storage_account" }, @@ -38,7 +38,7 @@ "guid": "dc507ccf-0c57-4165-9327-f37b0d13fda0", "lastModifiedTS": "2", "attributes": { - "qualifiedName": "https://test_azure_storage_account.core.windows.net" + "qualifiedName": "https://exampleaccount.core.windows.net" }, "typeName": "azure_storage_account" } @@ -49,7 +49,7 @@ "guid": "dc507ccf-0c57-4165-9327-f37b0d13fda0", "lastModifiedTS": "2", "attributes": { - "qualifiedName": "https://test_azure_storage_account.core.windows.net" + "qualifiedName": "https://exampleaccount.core.windows.net" }, "typeName": "azure_storage_account" } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_SetClassifications.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_SetClassifications.json index ff461f621145..907bbe9c1e97 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_SetClassifications.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_SetClassifications.json @@ -5,7 +5,7 @@ "guidHeaderMap": { "9fb74c11-ac48-4650-95bc-760665c5bd92": { "attributes": { - "qualifiedName": "https://test_azure_storage_account1.core.windows.net" + "qualifiedName": "https://exampleaccount1.core.windows.net" }, "typeName": "azure_storage_account", "classifications": [ @@ -16,7 +16,7 @@ }, "7fcc43ab-55ea-45d4-9971-ce0443cb10bb": { "attributes": { - "qualifiedName": "https://test_azure_storage_account2.core.windows.net" + "qualifiedName": "https://exampleaccount2.core.windows.net" }, "typeName": "azure_storage_account", "classifications": [ diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_Update.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_Update.json index 5b3c37dcea3d..56799529f337 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_Update.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_Update.json @@ -6,11 +6,11 @@ "entity": { "typeName": "azure_storage_account", "attributes": { - "owner": "test_owner", + "owner": "ExampleOwner", "modifiedTime": 0, "createTime": 0, - "qualifiedName": "test_azure_storage_account_0114", - "name": "test_azure_storage_account_0114_2", + "qualifiedName": "exampleaccount", + "name": "ExampleStorageAccount", "description": null, "publicAccessLevel": null }, @@ -18,19 +18,19 @@ "Expert": [ { "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", - "info": "expert info" + "info": "Example Expert Info" } ], "Owner": [ { "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", - "info": "owner info" + "info": "Example Owner Info" } ] }, "status": "ACTIVE", - "createdBy": "ServiceAdmin", - "updatedBy": "ServiceAdmin", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "version": 0 } } @@ -43,7 +43,7 @@ { "typeName": "azure_storage_account", "attributes": { - "qualifiedName": "test_azure_storage_account_0114" + "qualifiedName": "exampleaccount" }, "lastModifiedTS": "2", "guid": "029d5668-a36c-40a9-bc11-6f352bafdc3b" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_UpdateClassificationsByUniqueAttribute.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_UpdateClassificationsByUniqueAttribute.json index 0830fd37c31d..e82bbe57a2f3 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_UpdateClassificationsByUniqueAttribute.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Entity_UpdateClassificationsByUniqueAttribute.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "typeName": "azure_storage_account", - "attr:qualifiedName": "https://test_azure_storage_account.core.windows.net", + "attr:qualifiedName": "https://exampleaccount.core.windows.net", "atlasClassificationArray": [ { "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_AssignTermToEntities.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_AssignTermToEntities.json index 6a8f4d0b206b..5ff085189499 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_AssignTermToEntities.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_AssignTermToEntities.json @@ -7,10 +7,10 @@ "guid": "ab9f1920-0b94-436d-aeb4-11a32c270fc0", "relationshipAttributes": { "attributes": { - "expression": "this is expression", + "expression": "Example Expression", "confidence": 100, - "description": "this is description", - "source": "Azure" + "description": "Example Description", + "source": "ExampleSource" } } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_CreateGlossary.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_CreateGlossary.json index d6e8fab4edea..05ab5190130d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_CreateGlossary.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_CreateGlossary.json @@ -3,10 +3,10 @@ "Endpoint": "{Endpoint}", "atlasGlossary": { "name": "Glossary", - "shortDescription": "shortDescription", - "longDescription": "longDescription", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", "language": "en", - "usage": "demo glossary" + "usage": "Example Glossary" } }, "responses": { @@ -15,11 +15,11 @@ "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "qualifiedName": "Glossary", "name": "Glossary", - "shortDescription": "shortDescription", - "longDescription": "longDescription", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", "lastModifiedTS": "1", "language": "en", - "usage": "demo glossary" + "usage": "Example Glossary" } } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_CreateGlossaryCategories.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_CreateGlossaryCategories.json index d1560d6ebe54..17a515af1f09 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_CreateGlossaryCategories.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_CreateGlossaryCategories.json @@ -3,13 +3,13 @@ "Endpoint": "{Endpoint}", "glossaryCategory": [ { - "name": "Category2", + "name": "ExampleCategory2", "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" } }, { - "name": "Category3", + "name": "ExampleCategory3", "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" } @@ -21,8 +21,8 @@ "body": [ { "guid": "e47c4584-daca-4f9e-9092-194e04692c9a", - "qualifiedName": "Category2@Glossary", - "name": "Category2", + "qualifiedName": "ExampleCategory2@Glossary", + "name": "ExampleCategory2", "lastModifiedTS": "1", "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", @@ -31,8 +31,8 @@ }, { "guid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", - "qualifiedName": "Category3@Glossary", - "name": "Category3", + "qualifiedName": "ExampleCategory3@Glossary", + "name": "ExampleCategory3", "lastModifiedTS": "1", "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_CreateGlossaryCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_CreateGlossaryCategory.json index f212c2269212..7f31caaea342 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_CreateGlossaryCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_CreateGlossaryCategory.json @@ -5,7 +5,7 @@ "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" }, - "name": "Category1", + "name": "ExampleCategory1", "terms": [ { "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea" @@ -17,8 +17,8 @@ "200": { "body": { "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", - "qualifiedName": "Category1@Glossary", - "name": "Category1", + "qualifiedName": "ExampleCategory1@Glossary", + "name": "ExampleCategory1", "lastModifiedTS": "1", "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", @@ -28,7 +28,7 @@ { "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007", - "displayText": "Term1" + "displayText": "ExampleTerm1" } ] } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_CreateGlossaryTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_CreateGlossaryTerm.json index 56d8bfa02558..efd7d2d547b2 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_CreateGlossaryTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_CreateGlossaryTerm.json @@ -2,9 +2,9 @@ "parameters": { "Endpoint": "{Endpoint}", "glossaryTerm": { - "name": "Term1", - "shortDescription": "shortDescription1", - "longDescription": "longDescription1", + "name": "ExampleTerm1", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", "abbreviation": "T1", "status": "Approved", "anchor": { @@ -12,21 +12,21 @@ }, "resources": [ { - "displayName": "microsoft", - "url": "https://www.microsoft.com/en-sg/" + "displayName": "Example Display Name", + "url": "Example Url" } ], "contacts": { "Expert": [ { "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", - "info": "expert" + "info": "Example Expert Info" } ], "Steward": [ { "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", - "info": "steward" + "info": "Example Steward info" } ] } @@ -36,10 +36,10 @@ "200": { "body": { "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", - "qualifiedName": "Term1@Glossary", - "name": "Term1", - "shortDescription": "shortDescription1", - "longDescription": "longDescription1", + "qualifiedName": "ExampleTerm1@Glossary", + "name": "ExampleTerm1", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", "abbreviation": "T1", "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", @@ -52,21 +52,21 @@ "status": "Approved", "resources": [ { - "displayName": "microsoft", - "url": "https://www.microsoft.com/en-sg/" + "displayName": "Example Display Name", + "url": "Example Url" } ], "contacts": { "Expert": [ { "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", - "info": "expert" + "info": "Example Expert Info" } ], "Steward": [ { "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", - "info": "steward" + "info": "Example Steward Info" } ] } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_CreateGlossaryTermWithTermTemplate.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_CreateGlossaryTermWithTermTemplate.json index 5e8a7dc7e67a..c9b7795a1b04 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_CreateGlossaryTermWithTermTemplate.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_CreateGlossaryTermWithTermTemplate.json @@ -2,18 +2,18 @@ "parameters": { "Endpoint": "{Endpoint}", "glossaryTerm": { - "name": "TermWithTermTemplate", + "name": "ExampleTerm", "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" }, "attributes": { - "MS KPI": { - "plain string": "some string", + "ExampleTermTemplateAttribute": { + "plain string": "Example String", "date": 1606233600000, - "single choice": "Single Choice A", + "single choice": "Example Single Choice A", "multi choice": [ - "Multi Choice A", - "Multi Choice B" + "Example Multi Choice A", + "Example Multi Choice B" ] } } @@ -23,8 +23,8 @@ "200": { "body": { "guid": "9390cc82-1077-403e-a4d2-b6a69834707b", - "qualifiedName": "TermWithTermTemplate@Glossary", - "name": "TermWithTermTemplate", + "qualifiedName": "ExampleTerm@Glossary", + "name": "ExampleTerm", "lastModifiedTS": "1", "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", @@ -35,13 +35,13 @@ "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0" }, "attributes": { - "MS KPI": { - "plain string": "some string", + "ExampleTermTemplateAttribute": { + "plain string": "Example String", "date": 1606233600000, - "single choice": "Single Choice A", + "single choice": "Example Single Choice A", "multi choice": [ - "Multi Choice A", - "Multi Choice B" + "Example Multi Choice A", + "Example Multi Choice B" ] } } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_CreateGlossaryTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_CreateGlossaryTerms.json index 39b8e69633f4..ddd48b3a0782 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_CreateGlossaryTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_CreateGlossaryTerms.json @@ -6,15 +6,15 @@ "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" }, - "name": "Term2", + "name": "ExampleTerm2", "status": "Approved", - "shortDescription": "shortDescription2", - "longDescription": "longDescription2", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", "abbreviation": "T2", "resources": [ { - "displayName": "microsoft", - "url": "https://www.microsoft.com/en-sg/" + "displayName": "Example Display Name", + "url": "Example Url" } ] }, @@ -22,15 +22,15 @@ "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8" }, - "name": "Term3", + "name": "ExampleTerm3", "status": "Approved", - "shortDescription": "shortDescription3", - "longDescription": "longDescription3", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", "abbreviation": "T3", "resources": [ { - "displayName": "microsoft", - "url": "https://www.microsoft.com/en-sg/" + "displayName": "Example Display Name", + "url": "Example Url" } ] } @@ -41,9 +41,9 @@ "body": [ { "guid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", - "qualifiedName": "Term2@Glossary", - "name": "Term2", - "shortDescription": "shortDescription2", + "qualifiedName": "ExampleTerm2@Glossary", + "name": "ExampleTerm2", + "shortDescription": "Example Short Description", "lastModifiedTS": "1", "abbreviation": "T2", "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", @@ -57,16 +57,16 @@ }, "resources": [ { - "displayName": "microsoft", - "url": "https://www.microsoft.com/en-sg/" + "displayName": "Example Display Name", + "url": "Example Url" } ] }, { "guid": "821beef0-ced9-47ba-8f7f-c4f3459f4d18", - "qualifiedName": "Term3@Glossary", - "name": "Term3", - "shortDescription": "shortDescription3", + "qualifiedName": "ExampleTerm3@Glossary", + "name": "ExampleTerm3", + "shortDescription": "Example Short Description", "lastModifiedTS": "1", "abbreviation": "T3", "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", @@ -80,8 +80,8 @@ }, "resources": [ { - "displayName": "microsoft", - "url": "https://www.microsoft.com/en-sg/" + "displayName": "Example Display Name", + "url": "Example Url" } ] } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_GetDetailedGlossary.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_GetDetailedGlossary.json index d3a8f93bad1a..6740e81f7b5d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_GetDetailedGlossary.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_GetDetailedGlossary.json @@ -9,20 +9,20 @@ "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "qualifiedName": "Glossary", "name": "Glossary", - "shortDescription": "shortDescription", - "longDescription": "long description after partial update", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", "language": "en", - "usage": "demo glossary", + "usage": "Example Glossary", "terms": [ { "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0", - "displayText": "Term1" + "displayText": "ExampleTerm1" }, { "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189", - "displayText": "Term2" + "displayText": "ExampleTerm2" } ], "categories": [ @@ -42,10 +42,10 @@ "termInfo": { "54688d39-b298-4104-9e80-f2a16f44aaea": { "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", - "qualifiedName": "Term1@Glossary", - "name": "Term1", - "shortDescription": "shortDescription1", - "longDescription": "long desc after partial update", + "qualifiedName": "ExampleTerm1@Glossary", + "name": "ExampleTerm1", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", "lastModifiedTS": "2", "abbreviation": "T1", "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", @@ -69,11 +69,11 @@ "relationshipAttributes": { "typeName": "AtlasGlossarySemanticAssignment", "attributes": { - "expression": "this is expression", - "createdBy": "microsoft", - "steward": "microsoft", + "expression": "Example Expression", + "createdBy": "ExampleCreator", + "steward": "ExampleSteward", "confidence": 100, - "description": "this is description", + "description": "Example Description", "source": "Azure", "status": null } @@ -90,42 +90,42 @@ { "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01", - "displayText": "Term2" + "displayText": "ExampleTerm2" } ], "synonyms": [ { "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c", - "displayText": "Term2" + "displayText": "ExampleTerm2" } ], "contacts": { "Expert": [ { "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", - "info": "expert" + "info": "Example Expert Info" } ], "Steward": [ { "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", - "info": "steward" + "info": "Example Steward Info" } ] }, "resources": [ { - "displayName": "microsoft", - "url": "https://www.microsoft.com/en-sg/" + "displayName": "Example Display Name", + "url": "Example Url" } ] }, "952c7ba4-4c89-42d8-a05a-7d2161be7008": { "guid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", - "qualifiedName": "Term2@Glossary", - "name": "Term2", - "shortDescription": "shortDescription2", + "qualifiedName": "ExampleTerm2@Glossary", + "name": "ExampleTerm2", + "shortDescription": "Example Short Description", "lastModifiedTS": "1", "abbreviation": "T2", "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", @@ -141,20 +141,20 @@ { "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01", - "displayText": "Term1" + "displayText": "ExampleTerm1" } ], "synonyms": [ { "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c", - "displayText": "Term1" + "displayText": "ExampleTerm1" } ], "resources": [ { - "displayName": "microsoft", - "url": "https://www.microsoft.com/en-sg/" + "displayName": "Example Display Name", + "url": "Example Url" } ] } @@ -162,9 +162,9 @@ "categoryInfo": { "ed7458f0-9463-48a5-b5c6-4f785fb34e12": { "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", - "qualifiedName": "Category1.Category2@Glossary", - "name": "Category1", - "longDescription": "long description after paritial update", + "qualifiedName": "ExampleCategory1.ExampleCategory2@Glossary", + "name": "ExampleCategory1", + "longDescription": "Example Long Description", "lastModifiedTS": "3", "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", @@ -184,14 +184,14 @@ { "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007", - "displayText": "Term1" + "displayText": "ExampleTerm1" } ] }, "e47c4584-daca-4f9e-9092-194e04692c9a": { "guid": "e47c4584-daca-4f9e-9092-194e04692c9a", - "qualifiedName": "Category2@Glossary", - "name": "Category2", + "qualifiedName": "ExampleCategory2@Glossary", + "name": "ExampleCategory2", "lastModifiedTS": "1", "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", @@ -206,8 +206,8 @@ }, "0d6766f6-f4b6-435b-bda2-d3edc358998e": { "guid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", - "qualifiedName": "Category3.Category1.Category2@Glossary", - "name": "Category3", + "qualifiedName": "ExampleCategory3.ExampleCategory1.ExampleCategory2@Glossary", + "name": "ExampleCategory3", "lastModifiedTS": "2", "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_GetGlossary.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_GetGlossary.json index 9bf6a6ff7a9c..11a7789498ca 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_GetGlossary.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_GetGlossary.json @@ -9,26 +9,26 @@ "guid": "47029611-67a1-42d5-8766-90eb904f7f22", "qualifiedName": "Glossary", "name": "Glossary", - "shortDescription": "shortDescription", - "longDescription": "longDescription", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", "lastModifiedTS": "1", "language": "en", - "usage": "demo glossary", + "usage": "Example Glossary", "terms": [ { "termGuid": "29d88363-9677-4ce6-aeee-5fdf45f84e9b", "relationGuid": "fb3d4ac4-27e0-45a2-bb13-105214e0ef7e", - "displayText": "Term3" + "displayText": "ExampleTerm3" }, { "termGuid": "e5136a91-bc02-49da-81f4-f075bd54b8f5", "relationGuid": "741186cd-1d62-4798-8e58-6cbe35105baa", - "displayText": "Term1" + "displayText": "ExampleTerm1" }, { "termGuid": "68347d87-ae38-43b4-a62c-0fdc25b54cb1", "relationGuid": "2f2b1fe6-d2b6-4aef-81cd-bea7a510312e", - "displayText": "Term2" + "displayText": "ExampleTerm2" } ] } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_GetGlossaryCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_GetGlossaryCategory.json index cb80e6afebb5..2329430d0e4d 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_GetGlossaryCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_GetGlossaryCategory.json @@ -7,8 +7,8 @@ "200": { "body": { "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", - "qualifiedName": "Category1.Category2@Glossary", - "name": "Category1", + "qualifiedName": "ExampleCategory1.ExampleCategory2@Glossary", + "name": "ExampleCategory1", "lastModifiedTS": "2", "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", @@ -23,14 +23,14 @@ "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "relationGuid": "e50be8c5-7905-4c92-b676-4278866c2c2f", - "displayText": "Category3" + "displayText": "ExampleCategory3" } ], "terms": [ { "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007", - "displayText": "Term1" + "displayText": "ExampleTerm1" } ] } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_GetGlossaryTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_GetGlossaryTerm.json index f317c51d102f..cece6585101c 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_GetGlossaryTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_GetGlossaryTerm.json @@ -7,9 +7,9 @@ "200": { "body": { "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", - "qualifiedName": "Term1@Glossary", - "name": "Term1", - "shortDescription": "shortDescription1", + "qualifiedName": "ExampleTerm1@Glossary", + "name": "ExampleTerm1", + "shortDescription": "Example Short Description", "lastModifiedTS": "1", "abbreviation": "T1", "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", @@ -25,34 +25,34 @@ { "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01", - "displayText": "Term2" + "displayText": "ExampleTerm2" } ], "synonyms": [ { "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c", - "displayText": "Term2" + "displayText": "ExampleTerm2" } ], "contacts": { "Expert": [ { "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", - "info": "expert" + "info": "Example Expert Info" } ], "Steward": [ { "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", - "info": "steward" + "info": "Example Steward Info" } ] }, "resources": [ { - "displayName": "microsoft", - "url": "https://www.microsoft.com/en-sg/" + "displayName": "Example Display Name", + "url": "Example Url" } ] } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_GetImportCSVOperationStatus.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_GetImportCSVOperationStatus.json index 91d82573f8d1..5fc675717e10 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_GetImportCSVOperationStatus.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_GetImportCSVOperationStatus.json @@ -2,8 +2,8 @@ "parameters": { "Endpoint": "{Endpoint}", "glossaryGuid": "a02d8eb5-a977-4ed6-85c6-63d44239471a", - "api-version": "2021-05-01", - "file": "10_terms_with_dependency_to_import_backward.csv" + "api-version": "2021-05-01-preview", + "file": "examplefile.csv" }, "responses": { "202": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_GetImportCSVOperationStatusByGloassaryName.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_GetImportCSVOperationStatusByGloassaryName.json index 0b675bf74f94..7345a1e4fa86 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_GetImportCSVOperationStatusByGloassaryName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_GetImportCSVOperationStatusByGloassaryName.json @@ -3,8 +3,8 @@ "Endpoint": "{Endpoint}", "glossaryName": "Glossary", "includeTermHierarchy": true, - "api-version": "2021-05-01", - "file": "10_terms_with_dependency_to_import_backward.csv" + "api-version": "2021-05-01-preview", + "file": "examplefile.csv" }, "responses": { "202": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_GetImportCSVOperationStatusByOperationguid.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_GetImportCSVOperationStatusByOperationguid.json index 66d20bf331d9..33872e83b4aa 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_GetImportCSVOperationStatusByOperationguid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_GetImportCSVOperationStatusByOperationguid.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "{Endpoint}", "operationGuid": "3ffca165-75a7-4987-ba71-cfc0a273d6b7", - "api-version": "2021-05-01" + "api-version": "2021-05-01-preview" }, "responses": { "200": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListCategoryTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListCategoryTerms.json index 593fcd4348ae..7fe35d8dd8f2 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListCategoryTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListCategoryTerms.json @@ -12,7 +12,7 @@ { "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007", - "displayText": "Term1" + "displayText": "ExampleTerm1" } ] } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListEntitiesAssignedWithTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListEntitiesAssignedWithTerm.json index 495804c3387a..ebfed3c2de40 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListEntitiesAssignedWithTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListEntitiesAssignedWithTerm.json @@ -13,7 +13,7 @@ "guid": "ea116881-222e-41c8-8acb-9af6f6f60009", "typeName": "column", "entityStatus": "ACTIVE", - "displayText": "PasswordSalt", + "displayText": "ExampleColumnName", "relationshipType": "AtlasGlossarySemanticAssignment", "relationshipGuid": "ff9023a5-8495-49d6-bf04-a22c3634151e", "relationshipStatus": "ACTIVE", @@ -34,7 +34,7 @@ "guid": "fbf0a84d-7080-456b-b889-b5ba42186c2e", "typeName": "azure_blob_path", "entityStatus": "ACTIVE", - "displayText": "csvtest.csv", + "displayText": "exampledata.csv", "relationshipType": "AtlasGlossarySemanticAssignment", "relationshipGuid": "dedc1294-a893-4e52-ba27-6be9b8694748", "relationshipStatus": "ACTIVE", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListGlossaries.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListGlossaries.json index 6670125ca18c..29f04491e9ef 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListGlossaries.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListGlossaries.json @@ -12,21 +12,21 @@ "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "qualifiedName": "Glossary", "name": "Glossary", - "shortDescription": "shortDescription", - "longDescription": "long description after partial update", - "lastModifiedTS": "3", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", + "lastModifiedTS": "1", "language": "en", - "usage": "demo glossary", + "usage": "Example Glossary", "terms": [ { "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0", - "displayText": "Term1" + "displayText": "ExampleTerm1" }, { "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189", - "displayText": "Term2" + "displayText": "ExampleTerm2" } ], "categories": [ @@ -34,18 +34,18 @@ "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2", - "displayText": "Category3" + "displayText": "ExampleCategory3" }, { "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "parentCategoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0", - "displayText": "Category1" + "displayText": "ExampleCategory1" }, { "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d", - "displayText": "Category2" + "displayText": "ExampleCategory2" } ] } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListGlossaryCategories.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListGlossaryCategories.json index 87db3aa90851..aabcc66dc2d0 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListGlossaryCategories.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListGlossaryCategories.json @@ -11,8 +11,8 @@ "body": [ { "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", - "qualifiedName": "Category1.Category2@Glossary", - "name": "Category1", + "qualifiedName": "ExampleCategory1.ExampleCategory2@Glossary", + "name": "ExampleCategory1", "lastModifiedTS": "2", "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", @@ -32,14 +32,14 @@ { "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007", - "displayText": "Term1" + "displayText": "ExampleTerm1" } ] }, { "guid": "e47c4584-daca-4f9e-9092-194e04692c9a", - "qualifiedName": "Category2@Glossary", - "name": "Category2", + "qualifiedName": "ExampleCategory2@Glossary", + "name": "ExampleCategory2", "lastModifiedTS": "1", "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", @@ -54,8 +54,8 @@ }, { "guid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", - "qualifiedName": "Category3.Category1.Category2@Glossary", - "name": "Category3", + "qualifiedName": "ExampleCategory3.ExampleCategory1.ExampleCategory2@Glossary", + "name": "ExampleCategory3", "lastModifiedTS": "2", "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListGlossaryCategoriesHeaders.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListGlossaryCategoriesHeaders.json index 44637cb89b91..277c967f7f0b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListGlossaryCategoriesHeaders.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListGlossaryCategoriesHeaders.json @@ -13,18 +13,18 @@ "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "parentCategoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0", - "displayText": "Category1" + "displayText": "ExampleCategory1" }, { "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d", - "displayText": "Category2" + "displayText": "ExampleCategory2" }, { "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2", - "displayText": "Category3" + "displayText": "ExampleCategory3" } ] } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListGlossaryTermHeaders.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListGlossaryTermHeaders.json index 2ae055593863..1375aa567f2b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListGlossaryTermHeaders.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListGlossaryTermHeaders.json @@ -12,12 +12,12 @@ { "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0", - "displayText": "Term1" + "displayText": "ExampleTerm1" }, { "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189", - "displayText": "Term2" + "displayText": "ExampleTerm2" } ] } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListGlossaryTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListGlossaryTerms.json index 37be42a7ad16..214bbd4c4f76 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListGlossaryTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListGlossaryTerms.json @@ -11,9 +11,9 @@ "body": [ { "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", - "qualifiedName": "Term1@Glossary", - "name": "Term1", - "shortDescription": "shortDescription1", + "qualifiedName": "ExampleTerm1@Glossary", + "name": "ExampleTerm1", + "shortDescription": "Example Short Description", "lastModifiedTS": "1", "abbreviation": "T1", "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", @@ -29,42 +29,42 @@ { "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01", - "displayText": "Term2" + "displayText": "ExampleTerm2" } ], "synonyms": [ { "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c", - "displayText": "Term2" + "displayText": "ExampleTerm2" } ], "contacts": { "Expert": [ { "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", - "info": "expert" + "info": "Example Expert Info" } ], "Steward": [ { "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df", - "info": "steward" + "info": "Example Steward Info" } ] }, "resources": [ { - "displayName": "microsoft", - "url": "https://www.microsoft.com/en-sg/" + "displayName": "Example Display Name", + "url": "Example Url" } ] }, { "guid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", - "qualifiedName": "Term2@Glossary", - "name": "Term2", - "shortDescription": "shortDescription2", + "qualifiedName": "ExampleTerm2@Glossary", + "name": "ExampleTerm2", + "shortDescription": "Example Short Description", "lastModifiedTS": "1", "abbreviation": "T2", "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", @@ -80,20 +80,20 @@ { "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01", - "displayText": "Term1" + "displayText": "ExampleTerm1" } ], "synonyms": [ { "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c", - "displayText": "Term1" + "displayText": "ExampleTerm1" } ], "resources": [ { - "displayName": "microsoft", - "url": "https://www.microsoft.com/en-sg/" + "displayName": "Example Display Name", + "url": "Example Url" } ] } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListRelatedCategories.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListRelatedCategories.json index a7c830cc3dca..7523745867a5 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListRelatedCategories.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListRelatedCategories.json @@ -20,7 +20,7 @@ "categoryGuid": "abc6ac1b-5700-9c70-3f5a-60a519150035", "parentCategoryGuid": "3243ea0a-9492-47e1-392e-a84e64980af9", "relationGuid": "12d41563-2fd9-4be5-9eb9-9908f811a8f2", - "displayText": "Category4" + "displayText": "ExampleCategory4" } ] } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListRelatedTerms.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListRelatedTerms.json index 6be887a2d0c2..ca90bb6d08d7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListRelatedTerms.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListRelatedTerms.json @@ -13,14 +13,14 @@ { "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01", - "displayText": "Term2" + "displayText": "ExampleTerm2" } ], "synonyms": [ { "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c", - "displayText": "Term2" + "displayText": "ExampleTerm2" } ] } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListTermsByGlossaryName.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListTermsByGlossaryName.json index 7f3d3e333b81..94bbbcf44da2 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListTermsByGlossaryName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_ListTermsByGlossaryName.json @@ -4,43 +4,43 @@ "glossaryName": "Glossary", "limit": "10", "offset": "0", - "api-version": "2020-12-01" + "api-version": "2021-05-01-preview" }, "responses": { "200": { "body": [ { - "qualifiedName": "Administrative and Support and Waste Management and Remediation Services@Glossary", - "name": "Administrative and Support and Waste Management and Remediation Services", + "qualifiedName": "ExampleTerm1@Glossary", + "name": "ExampleTerm1", "createTime": 1608002832463, "updateTime": 1608002832463, "guid": "daf0ba4d-bc9a-4536-8a88-4b58e39dd3d4", "status": "Approved", "templateName": [], "shortDescription": null, - "longDescription": "Contoso Corporation Retail industry sub segment involving Business Support Services; Employment Services; Facilities Support Services; Investigation and Security Services; Office Administrative Services; Other Support Services; Remediation and Other Waste Management Services; Services to Buildings and Dwellings; Travel Arrangement and Reservation Services; Waste Collection; and Waste Treatment and Disposal." + "longDescription": "Example Long Description" }, { - "qualifiedName": "Advisory Services (AS) @Glossary", - "name": "Advisory Services (AS) ", + "qualifiedName": "ExampleTerm2@Glossary", + "name": "ExampleTerm2", "createTime": 1608002832463, "updateTime": 1608002832463, "guid": "21b82aa6-483b-43ff-a484-71d34aa34bbc", "status": "Approved", "templateName": [], "shortDescription": null, - "longDescription": "Delivery Unit (DU) under Applied Technology focused on a range of consulting services provided by Certified Public Accountants (CPA) and other financial advisors to businesses and high net worth individuals who require specialized advice on capital formation, cash flow and wealth management." + "longDescription": "Example Long Description" }, { - "qualifiedName": "Audit @Glossary", - "name": "Audit ", + "qualifiedName": "ExampleTerm3@Glossary", + "name": "ExampleTerm3", "createTime": 1608002832463, "updateTime": 1608002832463, "guid": "02785962-e01e-425b-8698-5194e116130f", "status": "Approved", "templateName": [], "shortDescription": null, - "longDescription": "Delivery Unit (DU) under Applied Technology focused on auditing services." + "longDescription": "Example Long Description" } ] } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_PartialUpdateGlossary.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_PartialUpdateGlossary.json index ccb2b10ca779..3b71492bec22 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_PartialUpdateGlossary.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_PartialUpdateGlossary.json @@ -3,7 +3,7 @@ "Endpoint": "{Endpoint}", "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "partialUpdates": { - "longDescription": "long description after partial update" + "longDescription": "Example Long Description" } }, "responses": { @@ -12,21 +12,21 @@ "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "qualifiedName": "Glossary", "name": "Glossary", - "shortDescription": "shortDescription", - "longDescription": "long description after partial update", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", "lastModifiedTS": "3", "language": "en", - "usage": "demo glossary", + "usage": "Example Glossary", "terms": [ { "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0", - "displayText": "Term1" + "displayText": "ExampleTerm1" }, { "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189", - "displayText": "Term2" + "displayText": "ExampleTerm2" } ], "categories": [ @@ -34,18 +34,18 @@ "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2", - "displayText": "Category3" + "displayText": "ExampleCategory3" }, { "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "parentCategoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0", - "displayText": "Category1" + "displayText": "ExampleCategory1" }, { "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d", - "displayText": "Category2" + "displayText": "ExampleCategory2" } ] } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_PartialUpdateGlossaryCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_PartialUpdateGlossaryCategory.json index 4ce88f2cefeb..11516593b6bd 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_PartialUpdateGlossaryCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_PartialUpdateGlossaryCategory.json @@ -3,16 +3,16 @@ "Endpoint": "{Endpoint}", "categoryGuid": "3243ea0a-9492-47e1-392e-a84e64980af9", "partialUpdates": { - "longDescription": "long description after paritial update" + "longDescription": "Example Long Description" } }, "responses": { "200": { "body": { "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", - "qualifiedName": "Category1.Category2@Glossary", - "name": "Category1", - "longDescription": "long description after paritial update", + "qualifiedName": "ExampleCategory1.ExampleCategory2@Glossary", + "name": "ExampleCategory1", + "longDescription": "Example Long Description", "lastModifiedTS": "3", "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", @@ -27,14 +27,14 @@ "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "relationGuid": "e50be8c5-7905-4c92-b676-4278866c2c2f", - "displayText": "Category3" + "displayText": "ExampleCategory3" } ], "terms": [ { "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007", - "displayText": "Term1" + "displayText": "ExampleTerm1" } ] } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_PartialUpdateGlossaryTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_PartialUpdateGlossaryTerm.json index 51f80829c9d5..572d692fa4b6 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_PartialUpdateGlossaryTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_PartialUpdateGlossaryTerm.json @@ -3,17 +3,17 @@ "Endpoint": "{Endpoint}", "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", "partialUpdates": { - "longDescription": "long desc after partial update" + "longDescription": "Example Long Descrition" } }, "responses": { "200": { "body": { "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", - "qualifiedName": "Term1@Glossary", - "name": "Term1", - "shortDescription": "shortDescription1", - "longDescription": "long desc after partial update", + "qualifiedName": "ExampleTerm1@Glossary", + "name": "ExampleTerm1", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Descrition", "lastModifiedTS": "2", "abbreviation": "T1", "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", @@ -29,27 +29,27 @@ { "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007", - "displayText": "Category1" + "displayText": "ExampleCategory1" } ], "seeAlso": [ { "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01", - "displayText": "Term2" + "displayText": "ExampleTerm2" } ], "synonyms": [ { "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c", - "displayText": "Term2" + "displayText": "ExampleTerm2" } ], "resources": [ { - "displayName": "microsoft", - "url": "https://www.microsoft.com/en-sg/" + "displayName": "Example Display Name", + "url": "Example Url" } ] } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_UpdateGlossary.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_UpdateGlossary.json index 51372e212451..1ff957ab4d0b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_UpdateGlossary.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_UpdateGlossary.json @@ -6,21 +6,21 @@ "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "qualifiedName": "Glossary", "name": "Glossary", - "shortDescription": "shortDescription", - "longDescription": "longDescription after update", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", "lastModifiedTS": "1", "language": "en", - "usage": "demo glossary", + "usage": "Example Glossary", "terms": [ { "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0", - "displayText": "Term1" + "displayText": "ExampleTerm1" }, { "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189", - "displayText": "Term2" + "displayText": "ExampleTerm2" } ], "categories": [ @@ -28,18 +28,18 @@ "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2", - "displayText": "Category3" + "displayText": "ExampleCategory3" }, { "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "parentCategoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0", - "displayText": "Category1" + "displayText": "ExampleCategory1" }, { "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d", - "displayText": "Category2" + "displayText": "ExampleCategory2" } ] } @@ -50,21 +50,21 @@ "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", "qualifiedName": "Glossary", "name": "Glossary", - "shortDescription": "shortDescription", - "longDescription": "longDescription after update", + "shortDescription": "Example Short Description", + "longDescription": "Example Long Description", "lastModifiedTS": "2", "language": "en", - "usage": "demo glossary", + "usage": "Example Glossary", "terms": [ { "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0", - "displayText": "Term1" + "displayText": "ExampleTerm1" }, { "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189", - "displayText": "Term2" + "displayText": "ExampleTerm2" } ], "categories": [ @@ -72,18 +72,18 @@ "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2", - "displayText": "Category3" + "displayText": "ExampleCategory3" }, { "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "parentCategoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0", - "displayText": "Category1" + "displayText": "ExampleCategory1" }, { "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a", "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d", - "displayText": "Category2" + "displayText": "ExampleCategory2" } ] } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_UpdateGlossaryCategory.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_UpdateGlossaryCategory.json index 72071aefe48c..fb8c92c94fd5 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_UpdateGlossaryCategory.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_UpdateGlossaryCategory.json @@ -4,8 +4,8 @@ "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "glossaryCategory": { "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", - "qualifiedName": "Category1@Glossary", - "name": "Category1", + "qualifiedName": "ExampleCategory1@Glossary", + "name": "ExampleCategory1", "lastModifiedTS": "1", "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", @@ -31,8 +31,8 @@ "200": { "body": { "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", - "qualifiedName": "Category1.Category2@Glossary", - "name": "Category1", + "qualifiedName": "ExampleCategory1.Category2@Glossary", + "name": "ExampleCategory1", "lastModifiedTS": "2", "anchor": { "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8", @@ -47,14 +47,14 @@ "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e", "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12", "relationGuid": "e50be8c5-7905-4c92-b676-4278866c2c2f", - "displayText": "Category3" + "displayText": "ExampleCategory3" } ], "terms": [ { "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007", - "displayText": "Term1" + "displayText": "ExampleTerm1" } ] } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_UpdateGlossaryTerm.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_UpdateGlossaryTerm.json index 294d93bdf831..065bba39f639 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_UpdateGlossaryTerm.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Glossary_UpdateGlossaryTerm.json @@ -4,9 +4,9 @@ "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea", "glossaryTerm": { "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", - "qualifiedName": "Term1@Glossary", - "name": "Term1", - "shortDescription": "shortDescription1", + "qualifiedName": "ExampleTerm1@Glossary", + "name": "ExampleTerm1", + "shortDescription": "Example Short Description", "lastModifiedTS": "1", "abbreviation": "T1", "status": "Approved", @@ -16,8 +16,8 @@ }, "resources": [ { - "displayName": "microsoft", - "url": "https://www.microsoft.com/en-sg/" + "displayName": "Example Display Name", + "url": "Example Url" } ], "seeAlso": [ @@ -42,9 +42,9 @@ "200": { "body": { "guid": "54688d39-b298-4104-9e80-f2a16f44aaea", - "qualifiedName": "Term1@Glossary", - "name": "Term1", - "shortDescription": "shortDescription1", + "qualifiedName": "ExampleTerm1@Glossary", + "name": "ExampleTerm1", + "shortDescription": "Example Short Description", "lastModifiedTS": "1", "abbreviation": "T1", "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", @@ -60,30 +60,30 @@ { "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01", - "displayText": "Term2" + "displayText": "ExampleTerm2" }, { "termGuid": "821beef0-ced9-47ba-8f7f-c4f3459f4d18", "relationGuid": "4d802ada-65f3-45a8-969f-aba47d9c6200", - "displayText": "Term3" + "displayText": "ExampleTerm3" } ], "synonyms": [ { "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008", "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c", - "displayText": "Term2" + "displayText": "ExampleTerm2" }, { "termGuid": "821beef0-ced9-47ba-8f7f-c4f3459f4d18", "relationGuid": "bb26fe7c-6e26-46ad-b936-50a5f7ffbbaf", - "displayText": "Term3" + "displayText": "ExampleTerm3" } ], "resources": [ { - "displayName": "microsoft", - "url": "https://www.microsoft.com/en-sg/" + "displayName": "Example Display Name", + "url": "Example Url" } ] } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/NextPageLineage.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/NextPageLineage.json index bcba2d929ef0..c3e0d8164f1e 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/NextPageLineage.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/NextPageLineage.json @@ -6,7 +6,7 @@ "limit": "5", "getDerivedLineage": true, "direction": "INPUT", - "api-version": "2021-05-01" + "api-version": "2021-05-01-preview" }, "responses": { "200": { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Relationship_Create.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Relationship_Create.json index e0e4a09e383e..8122eee5cd3a 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Relationship_Create.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Relationship_Create.json @@ -4,9 +4,9 @@ "relationship": { "typeName": "AtlasGlossarySynonym", "attributes": { - "expression": "test", - "steward": "test", - "description": "test", + "expression": "Example Expression", + "steward": "Example Steward", + "description": "Example Description", "source": null, "status": null }, @@ -20,8 +20,8 @@ }, "label": "r:AtlasGlossarySynonym", "status": "ACTIVE", - "createdBy": "ServiceAdmin", - "updatedBy": "ServiceAdmin", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "version": 0 } }, @@ -30,9 +30,9 @@ "body": { "typeName": "AtlasGlossarySynonym", "attributes": { - "expression": "test", - "steward": "test", - "description": "test", + "expression": "Example Expression", + "steward": "Example Steward", + "description": "Example Description", "source": null, "status": null }, @@ -47,8 +47,8 @@ }, "label": "r:AtlasGlossarySynonym", "status": "ACTIVE", - "createdBy": "ServiceAdmin", - "updatedBy": "ServiceAdmin", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1553840134724, "updateTime": 1553840134724, "version": 0 diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Relationship_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Relationship_Get.json index 55d48470b25c..7a9054f95285 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Relationship_Get.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Relationship_Get.json @@ -27,8 +27,8 @@ }, "label": "r:AtlasGlossarySynonym", "status": "ACTIVE", - "createdBy": "ServiceAdmin", - "updatedBy": "ServiceAdmin", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1553838993803, "updateTime": 1553838993803, "version": 0 diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Relationship_Update.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Relationship_Update.json index 95c8d4945113..3664c81a3ec7 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Relationship_Update.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Relationship_Update.json @@ -4,9 +4,9 @@ "relationship": { "typeName": "AtlasGlossarySynonym", "attributes": { - "expression": "test", - "steward": "test", - "description": "test", + "expression": "Example Expression", + "steward": "Example Steward", + "description": "Example Description", "source": null, "status": null }, @@ -21,8 +21,8 @@ }, "label": "r:AtlasGlossarySynonym", "status": "ACTIVE", - "createdBy": "ServiceAdmin", - "updatedBy": "ServiceAdmin", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "version": 0 } }, @@ -31,9 +31,9 @@ "body": { "typeName": "AtlasGlossarySynonym", "attributes": { - "expression": "test", - "steward": "test", - "description": "test", + "expression": "Example Expression", + "steward": "Example Steward", + "description": "Example Description", "source": null, "status": null }, @@ -48,8 +48,8 @@ }, "label": "r:AtlasGlossarySynonym", "status": "ACTIVE", - "createdBy": "ServiceAdmin", - "updatedBy": "ServiceAdmin", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1553839805039, "updateTime": 1553839805039, "version": 0 diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_CreateTypeDefinitions.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_CreateTypeDefinitions.json index f7d992e65bea..3c08502d3e0f 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_CreateTypeDefinitions.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_CreateTypeDefinitions.json @@ -7,7 +7,7 @@ "classificationDefs": [], "entityDefs": [ { - "name": "azure_sql_server_test", + "name": "azure_sql_server_example", "superTypes": [ "azure_resource" ], @@ -37,13 +37,13 @@ { "category": "ENTITY", "guid": "a47fd902-a564-45f1-aa51-ce9224955881", - "createdBy": "ServiceAdmin", - "updatedBy": "ServiceAdmin", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1553672211954, "updateTime": 1553672211954, "version": 1, - "name": "azure_sql_server_test", - "description": "azure_sql_server_test", + "name": "azure_sql_server_example", + "description": "azure_sql_server_example", "typeVersion": "1.0", "attributeDefs": [ { diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_DeleteTypeDefinitions.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_DeleteTypeDefinitions.json index 87ae72673c5a..40e463be1ce9 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_DeleteTypeDefinitions.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_DeleteTypeDefinitions.json @@ -7,7 +7,7 @@ "classificationDefs": [], "entityDefs": [ { - "name": "azure_sql_server_test", + "name": "azure_sql_server_example", "superTypes": [ "azure_resource" ], diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetAllEnumDef.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetAllEnumDef.json index 9d992ab37408..0c3b2d78f851 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetAllEnumDef.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetAllEnumDef.json @@ -10,8 +10,8 @@ { "category": "ENUM", "guid": "0ddc2fcf-ad17-4d06-984a-ffb2ffb2a941", - "createdBy": "admin", - "updatedBy": "admin", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1604728877305, "updateTime": 1604728877305, "version": 1, @@ -41,8 +41,8 @@ { "category": "ENUM", "guid": "c694edf1-6f9e-4b60-b832-23e8d6187675", - "createdBy": "admin", - "updatedBy": "admin", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1604728832692, "updateTime": 1604728905525, "version": 2, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetAllTermTemplateDef.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetAllTermTemplateDef.json index c799b74974df..26902f2461c6 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetAllTermTemplateDef.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetAllTermTemplateDef.json @@ -15,8 +15,8 @@ { "category": "TERM_TEMPLATE", "guid": "d776af9c-985c-4168-abb2-477523dbfc70", - "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", - "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1606300465443, "updateTime": 1606300465443, "version": 1, @@ -41,7 +41,7 @@ }, { "name": "single choice", - "typeName": "TERM_TEMPLATE_ENUM_b629447d_d220_4cc6_a1a7_3a888d3ccc03", + "typeName": "TERM_TEMPLATE_ENUM_EXAMPLE_1", "isOptional": true, "cardinality": "SINGLE", "valuesMinCount": 0, @@ -55,7 +55,7 @@ }, { "name": "multi choice", - "typeName": "array", + "typeName": "array", "isOptional": true, "cardinality": "SET", "valuesMinCount": 0, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetAllTypeDefinitions.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetAllTypeDefinitions.json index 9315e8ddd813..4e6b37b8b6f1 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetAllTypeDefinitions.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetAllTypeDefinitions.json @@ -10,8 +10,8 @@ { "category": "ENUM", "guid": "0ddc2fcf-ad17-4d06-984a-ffb2ffb2a941", - "createdBy": "admin", - "updatedBy": "admin", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1604728877305, "updateTime": 1604728877305, "version": 1, @@ -37,82 +37,14 @@ "ordinal": 3 } ] - }, - { - "category": "ENUM", - "guid": "c694edf1-6f9e-4b60-b832-23e8d6187675", - "createdBy": "admin", - "updatedBy": "admin", - "createTime": 1604728832692, - "updateTime": 1604728905525, - "version": 2, - "name": "AtlasGlossaryTermRelationshipStatus", - "description": "TermRelationshipStatus defines how reliable the relationship is between two glossary terms", - "typeVersion": "1.1", - "serviceType": "atlas_core", - "lastModifiedTS": "2", - "elementDefs": [ - { - "value": "DRAFT", - "description": "DRAFT means the relationship is under development.", - "ordinal": 0 - }, - { - "value": "ACTIVE", - "description": "ACTIVE means the relationship is validated and in use.", - "ordinal": 1 - }, - { - "value": "DEPRECATED", - "description": "DEPRECATED means the the relationship is being phased out.", - "ordinal": 2 - }, - { - "value": "OBSOLETE", - "description": "OBSOLETE means that the relationship should not be used anymore.", - "ordinal": 3 - }, - { - "value": "OTHER", - "description": "OTHER means that there is another status.", - "ordinal": 99 - } - ] - }, - { - "category": "ENUM", - "guid": "eb499a3e-31cf-432a-b867-99f25f7ef096", - "createdBy": "admin", - "updatedBy": "admin", - "createTime": 1604730390805, - "updateTime": 1604730390805, - "version": 1, - "name": "parquet_field_repetition_type", - "description": "parquet_field_repetition_type", - "typeVersion": "1.0", - "lastModifiedTS": "1", - "elementDefs": [ - { - "value": "optional", - "ordinal": 0 - }, - { - "value": "required", - "ordinal": 1 - }, - { - "value": "repeated", - "ordinal": 2 - } - ] } ], "structDefs": [ { "category": "STRUCT", "guid": "a8892bd7-59d6-47d8-b80d-ba4c7631098f", - "createdBy": "admin", - "updatedBy": "admin", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1604729507664, "updateTime": 1604729507664, "version": 1, @@ -156,52 +88,14 @@ "includeInNotification": false } ] - }, - { - "category": "STRUCT", - "guid": "bdeb8ba3-5b23-440c-8b9c-d545a033386f", - "createdBy": "admin", - "updatedBy": "admin", - "createTime": 1604729507404, - "updateTime": 1604729507404, - "version": 1, - "name": "blob_delete_retention_policy", - "description": "blob_delete_retention_policy", - "typeVersion": "1.0", - "serviceType": "Azure Blob Storage", - "lastModifiedTS": "1", - "attributeDefs": [ - { - "name": "enabled", - "typeName": "boolean", - "isOptional": true, - "cardinality": "SINGLE", - "valuesMinCount": 0, - "valuesMaxCount": 1, - "isUnique": false, - "isIndexable": false, - "includeInNotification": false - }, - { - "name": "days", - "typeName": "long", - "isOptional": true, - "cardinality": "SINGLE", - "valuesMinCount": 0, - "valuesMaxCount": 1, - "isUnique": false, - "isIndexable": false, - "includeInNotification": false - } - ] } ], "classificationDefs": [ { "category": "CLASSIFICATION", "guid": "bd97460e-e5db-4701-8158-5b4062cf8a10", - "createdBy": "admin", - "updatedBy": "admin", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1604730971448, "updateTime": 1604730971448, "version": 1, @@ -215,33 +109,14 @@ "superTypes": [], "entityTypes": [], "subTypes": [] - }, - { - "category": "CLASSIFICATION", - "guid": "da1d7441-5bce-4552-9dd6-4c2174a823a5", - "createdBy": "admin", - "updatedBy": "admin", - "createTime": 1604730727163, - "updateTime": 1604730727163, - "version": 1, - "name": "MICROSOFT.PERSONAL.EU.GPS_COORDINATES", - "description": "EU GPS Coordinates", - "typeVersion": "1.0", - "options": { - "displayName": "EU GPS Coordinates" - }, - "attributeDefs": [], - "superTypes": [], - "entityTypes": [], - "subTypes": [] } ], "entityDefs": [ { "category": "ENTITY", "guid": "7c53da5d-2797-4e8a-9b89-dd9b3b26ffa8", - "createdBy": "admin", - "updatedBy": "admin", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1604730605047, "updateTime": 1604730605047, "version": 1, @@ -354,197 +229,14 @@ "isLegacyAttribute": false } ] - }, - { - "category": "ENTITY", - "guid": "ed176e86-779c-4d56-b261-f0dbadba2ba4", - "createdBy": "462cd5a6-6967-4465-a617-db1f03a1ee31", - "updatedBy": "462cd5a6-6967-4465-a617-db1f03a1ee31", - "createTime": 1610985276183, - "updateTime": 1610985276183, - "version": 1, - "name": "spark_db", - "description": "spark_db", - "typeVersion": "1.0", - "serviceType": "spark", - "lastModifiedTS": "1", - "attributeDefs": [ - { - "name": "location", - "typeName": "string", - "isOptional": true, - "cardinality": "SINGLE", - "valuesMinCount": 0, - "valuesMaxCount": 1, - "isUnique": false, - "isIndexable": false, - "includeInNotification": false - }, - { - "name": "clusterName", - "typeName": "string", - "isOptional": true, - "cardinality": "SINGLE", - "valuesMinCount": 0, - "valuesMaxCount": 1, - "isUnique": false, - "isIndexable": false, - "includeInNotification": false - }, - { - "name": "parameters", - "typeName": "map", - "isOptional": true, - "cardinality": "SINGLE", - "valuesMinCount": 0, - "valuesMaxCount": 1, - "isUnique": false, - "isIndexable": false, - "includeInNotification": false - }, - { - "name": "ownerType", - "typeName": "string", - "isOptional": true, - "cardinality": "SINGLE", - "valuesMinCount": 0, - "valuesMaxCount": 1, - "isUnique": false, - "isIndexable": false, - "includeInNotification": false - } - ], - "superTypes": [ - "DataSet" - ], - "subTypes": [], - "relationshipAttributeDefs": [ - { - "name": "inputToProcesses", - "typeName": "array", - "isOptional": true, - "cardinality": "SET", - "valuesMinCount": -1, - "valuesMaxCount": -1, - "isUnique": false, - "isIndexable": false, - "includeInNotification": false, - "relationshipTypeName": "dataset_process_inputs", - "isLegacyAttribute": false - }, - { - "name": "pipeline", - "typeName": "spark_ml_pipeline", - "isOptional": true, - "cardinality": "SINGLE", - "valuesMinCount": -1, - "valuesMaxCount": -1, - "isUnique": false, - "isIndexable": false, - "includeInNotification": false, - "relationshipTypeName": "spark_ml_pipeline_dataset", - "isLegacyAttribute": false - }, - { - "name": "schema", - "typeName": "array", - "isOptional": true, - "cardinality": "SET", - "valuesMinCount": -1, - "valuesMaxCount": -1, - "isUnique": false, - "isIndexable": false, - "includeInNotification": false, - "relationshipTypeName": "avro_schema_associatedEntities", - "isLegacyAttribute": false - }, - { - "name": "tables", - "typeName": "array", - "isOptional": true, - "cardinality": "SET", - "valuesMinCount": -1, - "valuesMaxCount": -1, - "isUnique": false, - "isIndexable": false, - "includeInNotification": false, - "relationshipTypeName": "spark_table_db", - "isLegacyAttribute": false - }, - { - "name": "model", - "typeName": "spark_ml_model", - "isOptional": true, - "cardinality": "SINGLE", - "valuesMinCount": -1, - "valuesMaxCount": -1, - "isUnique": false, - "isIndexable": false, - "includeInNotification": false, - "relationshipTypeName": "spark_ml_model_dataset", - "isLegacyAttribute": false - }, - { - "name": "attachedSchema", - "typeName": "array", - "isOptional": true, - "cardinality": "SET", - "valuesMinCount": -1, - "valuesMaxCount": -1, - "isUnique": false, - "isIndexable": false, - "includeInNotification": false, - "relationshipTypeName": "dataset_attached_schemas", - "isLegacyAttribute": false - }, - { - "name": "meanings", - "typeName": "array", - "isOptional": true, - "cardinality": "SET", - "valuesMinCount": -1, - "valuesMaxCount": -1, - "isUnique": false, - "isIndexable": false, - "includeInNotification": false, - "relationshipTypeName": "AtlasGlossarySemanticAssignment", - "isLegacyAttribute": false - }, - { - "name": "outputFromProcesses", - "typeName": "array", - "isOptional": true, - "cardinality": "SET", - "valuesMinCount": -1, - "valuesMaxCount": -1, - "isUnique": false, - "isIndexable": false, - "includeInNotification": false, - "relationshipTypeName": "process_dataset_outputs", - "isLegacyAttribute": false - }, - { - "name": "tabular_schema", - "typeName": "tabular_schema", - "isOptional": true, - "cardinality": "SINGLE", - "valuesMinCount": -1, - "valuesMaxCount": -1, - "isUnique": false, - "isIndexable": false, - "includeInNotification": false, - "relationshipTypeName": "tabular_schema_datasets", - "isLegacyAttribute": false - } - ] } ], "relationshipDefs": [ { "category": "RELATIONSHIP", "guid": "6284b865-cbb3-4236-83ed-059a407f06fb", - "createdBy": "admin", - "updatedBy": "admin", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1604729078159, "updateTime": 1604729323080, "version": 2, @@ -569,37 +261,6 @@ "cardinality": "SET", "isLegacyAttribute": false } - }, - { - "category": "RELATIONSHIP", - "guid": "dfd218d9-f8ab-43f8-b042-f8995c2312af", - "createdBy": "admin", - "updatedBy": "admin", - "createTime": 1604728947928, - "updateTime": 1604728947928, - "version": 1, - "name": "hive_table_db", - "description": "hive_table_db", - "typeVersion": "1.2", - "serviceType": "hive", - "lastModifiedTS": "1", - "attributeDefs": [], - "relationshipCategory": "AGGREGATION", - "relationshipLabel": "__hive_table.db", - "endDef1": { - "type": "hive_table", - "name": "db", - "isContainer": false, - "cardinality": "SINGLE", - "isLegacyAttribute": true - }, - "endDef2": { - "type": "hive_db", - "name": "tables", - "isContainer": true, - "cardinality": "SET", - "isLegacyAttribute": false - } } ] } diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetClassificationDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetClassificationDefByGuid.json index 16d3b5cafa0e..31f09a6d61e6 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetClassificationDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetClassificationDefByGuid.json @@ -8,8 +8,8 @@ "body": { "category": "CLASSIFICATION", "guid": "e79878fa-adba-4ee5-adc5-328d8841cd49", - "createdBy": "vsts", - "updatedBy": "vsts", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1553065966043, "updateTime": 1553065966043, "version": 1, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetClassificationDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetClassificationDefByName.json index f921d861f8c5..b7d7ed8a4f74 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetClassificationDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetClassificationDefByName.json @@ -8,8 +8,8 @@ "body": { "category": "CLASSIFICATION", "guid": "e79878fa-adba-4ee5-adc5-328d8841cd49", - "createdBy": "vsts", - "updatedBy": "vsts", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1553065966043, "updateTime": 1553065966043, "version": 1, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetEntityDefinitionByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetEntityDefinitionByGuid.json index ca4fb60ee568..2728fb2507c3 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetEntityDefinitionByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetEntityDefinitionByGuid.json @@ -8,8 +8,8 @@ "body": { "category": "ENTITY", "guid": "4bc54c37-98a8-4de8-9ee8-182610859d43", - "createdBy": "vsts", - "updatedBy": "vsts", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1553065960959, "updateTime": 1553065960959, "version": 1, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetEntityDefinitionByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetEntityDefinitionByName.json index c6122c2a95c8..0542db979369 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetEntityDefinitionByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetEntityDefinitionByName.json @@ -8,8 +8,8 @@ "body": { "category": "ENTITY", "guid": "4bc54c37-98a8-4de8-9ee8-182610859d43", - "createdBy": "vsts", - "updatedBy": "vsts", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1553065960959, "updateTime": 1553065960959, "version": 1, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetEnumDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetEnumDefByGuid.json index ede482f430dd..9c324ce8d35b 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetEnumDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetEnumDefByGuid.json @@ -8,8 +8,8 @@ "body": { "category": "ENUM", "guid": "644ab9c7-893a-4a4d-8e0a-591a6556d1a0", - "createdBy": "vsts", - "updatedBy": "vsts", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1553065968102, "updateTime": 1553065968102, "version": 1, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetEnumDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetEnumDefByName.json index 6c13e07ccb94..6adfee266b61 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetEnumDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetEnumDefByName.json @@ -8,8 +8,8 @@ "body": { "category": "ENUM", "guid": "644ab9c7-893a-4a4d-8e0a-591a6556d1a0", - "createdBy": "vsts", - "updatedBy": "vsts", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1553065968102, "updateTime": 1553065968102, "version": 1, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetRelationshipDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetRelationshipDefByGuid.json index db0f5a181817..66b6efd3f8bf 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetRelationshipDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetRelationshipDefByGuid.json @@ -8,8 +8,8 @@ "body": { "category": "RELATIONSHIP", "guid": "695edde1-2782-4a3c-841b-0b3aba25fe45", - "createdBy": "vsts", - "updatedBy": "vsts", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1553065976797, "updateTime": 1553065976797, "version": 1, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetRelationshipDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetRelationshipDefByName.json index 15319b26465d..148c7d655371 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetRelationshipDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetRelationshipDefByName.json @@ -8,8 +8,8 @@ "body": { "category": "RELATIONSHIP", "guid": "695edde1-2782-4a3c-841b-0b3aba25fe45", - "createdBy": "vsts", - "updatedBy": "vsts", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1553065976797, "updateTime": 1553065976797, "version": 1, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetStructDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetStructDefByGuid.json index 1675dcdf4afa..d2e1e0901f30 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetStructDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetStructDefByGuid.json @@ -8,8 +8,8 @@ "body": { "category": "STRUCT", "guid": "f1571b6e-ad08-4040-a9a7-c30ed935d437", - "createdBy": "vsts", - "updatedBy": "vsts", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1553065968145, "updateTime": 1553065968145, "version": 1, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetStructDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetStructDefByName.json index a796753e46ea..6bffd4888fa2 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetStructDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetStructDefByName.json @@ -8,8 +8,8 @@ "body": { "category": "STRUCT", "guid": "f1571b6e-ad08-4040-a9a7-c30ed935d437", - "createdBy": "vsts", - "updatedBy": "vsts", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1553065968145, "updateTime": 1553065968145, "version": 1, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetTermTemplateDefByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetTermTemplateDefByGuid.json index 7ee1603beeed..e36279a4bf52 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetTermTemplateDefByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetTermTemplateDefByGuid.json @@ -2,15 +2,15 @@ "parameters": { "Endpoint": "{Endpoint}", "guid": "d776af9c-985c-4168-abb2-477523dbfc70", - "api-version": "2021-05-01" + "api-version": "2021-05-01-preview" }, "responses": { "200": { "body": { "category": "TERM_TEMPLATE", "guid": "d776af9c-985c-4168-abb2-477523dbfc70", - "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", - "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1606300465443, "updateTime": 1606300465443, "version": 1, @@ -35,7 +35,7 @@ }, { "name": "single choice", - "typeName": "TERM_TEMPLATE_ENUM_b629447d_d220_4cc6_a1a7_3a888d3ccc03", + "typeName": "TERM_TEMPLATE_ENUM_EXAMPLE_1", "isOptional": true, "cardinality": "SINGLE", "valuesMinCount": 0, @@ -49,7 +49,7 @@ }, { "name": "multi choice", - "typeName": "array", + "typeName": "array", "isOptional": true, "cardinality": "SET", "valuesMinCount": 0, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetTermTemplateDefByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetTermTemplateDefByName.json index ee064ea0cc5d..101692791c27 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetTermTemplateDefByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetTermTemplateDefByName.json @@ -2,15 +2,15 @@ "parameters": { "Endpoint": "{Endpoint}", "name": "MS KPI", - "api-version": "2021-05-01" + "api-version": "2021-05-01-preview" }, "responses": { "200": { "body": { "category": "TERM_TEMPLATE", "guid": "d776af9c-985c-4168-abb2-477523dbfc70", - "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", - "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1606300465443, "updateTime": 1606300465443, "version": 1, @@ -35,7 +35,7 @@ }, { "name": "single choice", - "typeName": "TERM_TEMPLATE_ENUM_b629447d_d220_4cc6_a1a7_3a888d3ccc03", + "typeName": "TERM_TEMPLATE_ENUM_EXAMPLE_1", "isOptional": true, "cardinality": "SINGLE", "valuesMinCount": 0, @@ -49,7 +49,7 @@ }, { "name": "multi choice", - "typeName": "array", + "typeName": "array", "isOptional": true, "cardinality": "SET", "valuesMinCount": 0, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetTypeDefinitionByGuid.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetTypeDefinitionByGuid.json index 5b11bc846cdc..ebd1ed4902de 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetTypeDefinitionByGuid.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetTypeDefinitionByGuid.json @@ -8,8 +8,8 @@ "body": { "category": "ENUM", "guid": "0ddc2fcf-ad17-4d06-984a-ffb2ffb2a941", - "createdBy": "admin", - "updatedBy": "admin", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1604728877305, "updateTime": 1604728877305, "version": 1, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetTypeDefinitionByName.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetTypeDefinitionByName.json index cc8b7591e0a3..77ec05812c26 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetTypeDefinitionByName.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_GetTypeDefinitionByName.json @@ -8,8 +8,8 @@ "body": { "category": "ENUM", "guid": "0ddc2fcf-ad17-4d06-984a-ffb2ffb2a941", - "createdBy": "admin", - "updatedBy": "admin", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1604728877305, "updateTime": 1604728877305, "version": 1, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_UpdateAtlasTypeDefinitions.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_UpdateAtlasTypeDefinitions.json index 5fa672640832..fd37acb1ec1c 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_UpdateAtlasTypeDefinitions.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/examples/Types_UpdateAtlasTypeDefinitions.json @@ -125,8 +125,8 @@ { "category": "ENTITY", "guid": "a59fe369-2b1d-4bba-bb74-c273f3d74eb1", - "createdBy": "admin", - "updatedBy": "ServiceAdmin", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1548841689501, "updateTime": 1553671448662, "version": 3, @@ -154,8 +154,8 @@ { "category": "ENTITY", "guid": "cc33ec5a-205a-4853-91dd-c0ebd0049ffb", - "createdBy": "admin", - "updatedBy": "ServiceAdmin", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1548841689575, "updateTime": 1553671448783, "version": 3, @@ -226,8 +226,8 @@ { "category": "RELATIONSHIP", "guid": "1e0584a8-2587-4e1d-a772-db1e879469af", - "createdBy": "admin", - "updatedBy": "ServiceAdmin", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1548841689879, "updateTime": 1553671449536, "version": 3, @@ -255,8 +255,8 @@ { "category": "RELATIONSHIP", "guid": "77ee34f6-ea48-4fe3-86bf-7e2e722f4596", - "createdBy": "admin", - "updatedBy": "ServiceAdmin", + "createdBy": "ExampleCreator", + "updatedBy": "ExampleUpdator", "createTime": 1548841690094, "updateTime": 1553671449545, "version": 3, diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/purviewcatalog.json b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/purviewcatalog.json index af05e128d447..ab3f534e8782 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/purviewcatalog.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2021-05-01-preview/purviewcatalog.json @@ -2193,6 +2193,45 @@ } } }, + "/browse": { + "post": { + "tags": [ + "Discovery" + ], + "description": "Browse entities by path or entity type.", + "operationId": "Discovery_Browse", + "x-ms-examples": { + "Discovery_Browse_Path": { + "$ref": "./examples/Discovery_Browse_Path.json" + }, + "Discovery_Browse_EntityType": { + "$ref": "./examples/Discovery_Browse_EntityType.json" + } + }, + "parameters": [ + { + "in": "body", + "name": "browseRequest", + "description": "An object specifying the browse criteria.", + "required": true, + "schema": { + "$ref": "#/definitions/BrowseRequest" + } + }, + { + "$ref": "#/parameters/purviewAPIVersion" + } + ], + "responses": { + "200": { + "description": "OK. On successful get the entities to browse.", + "schema": { + "$ref": "#/definitions/BrowseResult" + } + } + } + } + }, "/search/autocomplete": { "post": { "tags": [ @@ -2235,7 +2274,7 @@ "Lineage" ], "description": "Get lineage info of the entity specified by GUID.", - "operationId": "GetLineageGraph", + "operationId": "Lineage_GetLineageGraph", "x-ms-examples": { "GetLineageGraph": { "$ref": "./examples/GetLineageGraph.json" @@ -2277,7 +2316,7 @@ "Lineage" ], "description": "Return immediate next page lineage info about entity with pagination", - "operationId": "NextPageLineage", + "operationId": "Lineage_NextPageLineage", "x-ms-examples": { "NextPageLineage": { "$ref": "./examples/NextPageLineage.json" @@ -4594,64 +4633,6 @@ "title": "AtlasTypeDef", "description": "The definitions of type." }, - "TypeStatistics": { - "type": "object", - "properties": { - "typeStatistics": { - "type": "object", - "description": "An map with type and corresponding statistics.", - "additionalProperties": { - "$ref": "#/definitions/TypeStatisticsExtraProperties" - } - } - }, - "title": "TypeStatistics", - "description": "The types and corresponding statistics." - }, - "TypeStatisticsExtraProperties": { - "type": "object", - "properties": { - "count": { - "type": "integer", - "format": "int32", - "description": "The entity count of this type." - } - }, - "title": "TypeStatisticsExtraProperties", - "description": "The additional properties for types and corresponding statistics." - }, - "AtlasUserSavedSearch": { - "type": "object", - "title": "AtlasUserSavedSearch", - "allOf": [ - { - "$ref": "#/definitions/AtlasBaseModelObject" - }, - { - "properties": { - "name": { - "type": "string", - "description": "The name of the saved search." - }, - "ownerName": { - "type": "string", - "description": "The owner name of the saved search." - }, - "searchParameters": { - "$ref": "#/definitions/SearchParameters" - }, - "searchType": { - "$ref": "#/definitions/SavedSearchType" - }, - "uiParameters": { - "type": "string", - "description": "The UI parameters." - } - } - } - ], - "description": "User saved search." - }, "Cardinality": { "type": "string", "title": "Cardinality", @@ -4683,19 +4664,6 @@ "title": "ClassificationAssociateRequest", "description": "The request for classification association." }, - "Condition": { - "type": "string", - "title": "Condition", - "description": "The enum for condition.", - "enum": [ - "AND", - "OR" - ], - "x-ms-enum": { - "name": "Condition", - "modelAsString": true - } - }, "DateFormat": { "type": "object", "title": "DateFormat", @@ -4766,54 +4734,6 @@ "title": "EntityMutationResponse", "description": "The mutation response of entity." }, - "EntityOperation": { - "type": "string", - "title": "EntityOperation", - "description": "The enum of entity operation.", - "enum": [ - "CREATE", - "UPDATE", - "PARTIAL_UPDATE", - "DELETE" - ], - "x-ms-enum": { - "name": "EntityOperation", - "modelAsString": true - } - }, - "FilterCriteria": { - "type": "object", - "properties": { - "attributeName": { - "type": "string", - "description": "The name of the attribute." - }, - "attributeValue": { - "type": "string", - "description": "The value of the attribute." - }, - "condition": { - "$ref": "#/definitions/Condition" - }, - "criterion": { - "type": "array", - "description": "An array of filter criteria.", - "items": { - "$ref": "#/definitions/FilterCriteria" - } - }, - "operator": { - "$ref": "#/definitions/Operator" - } - }, - "title": "FilterCriteria", - "description": "The filter criteria with attributes and condition." - }, - "Format": { - "type": "object", - "title": "Format", - "description": "The format object." - }, "LineageDirection": { "type": "string", "title": "LineageDirection", @@ -4935,32 +4855,6 @@ "title": "termGuid", "description": "The globally unique identifier for glossary term." }, - "Operator": { - "type": "string", - "title": "Operator", - "description": "Supported search operations\nLogical comparison operators can only be used with numbers or dates\nIN, LIKE, startsWith, endsWith, CONTAINS can only be used with strings or text", - "enum": [ - "LT", - "GT", - "LTE", - "GTE", - "EQ", - "NEQ", - "IN", - "LIKE", - "STARTS_WITH", - "ENDS_WITH", - "CONTAINS", - "CONTAINS_ANY", - "CONTAINS_ALL", - "IS_NULL", - "NOT_NULL" - ], - "x-ms-enum": { - "name": "Operator", - "modelAsString": true - } - }, "PList": { "type": "object", "properties": { @@ -4998,30 +4892,6 @@ "title": "PList", "description": "Paginated-list, for returning search results." }, - "Relation": { - "type": "string", - "title": "Relation", - "description": "The enum of relations.", - "enum": [ - "SEE_ALSO", - "SYNONYMS", - "ANTONYMS", - "PREFERRED_TO_TERMS", - "PREFERRED_TERMS", - "REPLACEMENT_TERMS", - "REPLACED_BY", - "TRANSLATION_TERMS", - "TRANSLATED_TERMS", - "ISA", - "CLASSIFIES", - "VALID_VALUES", - "VALID_VALUES_FOR" - ], - "x-ms-enum": { - "name": "Relation", - "modelAsString": true - } - }, "RelationshipCategory": { "type": "string", "title": "RelationshipCategory", @@ -5055,119 +4925,6 @@ "modelAsString": true } }, - "SavedSearchType": { - "type": "string", - "title": "SavedSearchType", - "description": "The enum of saved search type.", - "enum": [ - "BASIC", - "ADVANCED" - ], - "x-ms-enum": { - "name": "SavedSearchType", - "modelAsString": true - } - }, - "SearchFilter": { - "type": "object", - "properties": { - "getCount": { - "type": "boolean", - "description": "Determines if get the count." - }, - "maxRows": { - "type": "integer", - "format": "int64", - "description": "The maximum of rows." - }, - "params": { - "type": "object", - "description": "The parameters of the search filter.", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "sortBy": { - "type": "string", - "description": "The sorted by field." - }, - "sortType": { - "$ref": "#/definitions/SortType" - }, - "startIndex": { - "type": "integer", - "format": "int64", - "description": "The start index of the search." - } - }, - "title": "SearchFilter", - "description": "Generic filter, to specify search criteria using name/value pairs." - }, - "SearchParameters": { - "type": "object", - "properties": { - "attributes": { - "type": "array", - "description": "Attribute values included in the results", - "items": { - "type": "string" - } - }, - "classification": { - "type": "string", - "description": "The classification to search." - }, - "entityFilters": { - "$ref": "#/definitions/FilterCriteria" - }, - "excludeDeletedEntities": { - "type": "boolean", - "description": "Determines if exclude deleted entities." - }, - "includeClassificationAttributes": { - "type": "boolean", - "description": "Determines if include classification attributes." - }, - "includeSubClassifications": { - "type": "boolean", - "description": "Determines if include sub classifications." - }, - "includeSubTypes": { - "type": "boolean", - "description": "Determines if include sub types." - }, - "limit": { - "type": "integer", - "format": "int32", - "description": "The limit of the search result." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "The offset of the search." - }, - "query": { - "type": "string", - "description": "The search query." - }, - "tagFilters": { - "$ref": "#/definitions/FilterCriteria" - }, - "termName": { - "type": "string", - "description": "The name of the term for search." - }, - "typeName": { - "type": "string", - "description": "The name of the type for search." - } - }, - "title": "SearchParameters", - "description": "The parameters used for search." - }, "SortType": { "type": "string", "title": "SortType", @@ -5283,89 +5040,36 @@ "modelAsString": true } }, - "AzureCatalogUser": { - "type": "object", - "properties": { - "userId": { - "type": "string", - "description": "User ID of the Azure catalog user." - } - }, - "title": "AzureCatalogUser", - "description": "Azure catalog user." - }, - "CatalogCreationRequest": { - "type": "object", - "properties": { - "catalogName": { - "type": "string", - "description": "Name of the catalog." - }, - "catalogId": { - "type": "string", - "description": "ID of the catalog." - }, - "creatorUserId": { - "type": "string", - "description": "User ID or the creator." - }, - "eventHubConnectionString": { - "type": "string", - "description": "The connection string of the Event Hubs." - } - }, - "title": "CatalogCreationRequest", - "description": "Request for catalog creation." - }, - "CatalogDeletionRequest": { + "SuggestResult": { "type": "object", "properties": { - "catalogName": { - "type": "string", - "description": "Name of the catalog." + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SuggestResultValue" + } } }, - "title": "CatalogDeletionRequest", - "description": "Request for catalog deletion." + "title": "SuggestResult", + "description": "The result item of the search suggest." }, - "DataScanPermissionCheckRequest": { + "BrowseResult": { "type": "object", "properties": { - "catalogName": { - "type": "string", - "description": "Name of the catalog." + "@search.count": { + "type": "integer", + "format": "int32", + "description": "The total number of browse results." }, - "userId": { - "type": "string", - "description": "User ID of the catalog." - } - }, - "title": "DataScanPermissionCheckRequest", - "description": "Request for data scan permission check." - }, - "DataScanPermissionCheckResponse": { - "type": "object", - "properties": { - "result": { - "type": "string", - "description": "The result of the response." - } - }, - "title": "DataScanPermissionCheckResponse", - "description": "Response for data scan permission check." - }, - "SuggestResult": { - "type": "object", - "properties": { "value": { "type": "array", "items": { - "$ref": "#/definitions/SuggestResultValue" + "$ref": "#/definitions/BrowseResultValue" } } }, - "title": "SuggestResult", - "description": "The result item of the search suggest." + "title": "BrowseResult", + "description": "The result item of the browse request." }, "SuggestResultValue": { "type": "object", @@ -5421,14 +5125,14 @@ "type": "array", "description": "The terms assigned to the record.", "items": { - "$ref": "#/definitions/termSearchResultValue" + "$ref": "#/definitions/TermSearchResultValue" } }, "contact": { "type": "array", "description": "The contacts of the record.", "items": { - "$ref": "#/definitions/contactSearchResultValue" + "$ref": "#/definitions/ContactSearchResultValue" } }, "assetType": { @@ -5442,6 +5146,67 @@ "title": "SuggestResultValue", "description": "The value item of the search suggest." }, + "BrowseResultValue": { + "type": "object", + "properties": { + "entityType": { + "type": "string", + "description": "The type name of the record." + }, + "id": { + "type": "string", + "description": "The GUID of the record." + }, + "isLeaf": { + "type": "boolean", + "description": "If the record is a leaf entity." + }, + "name": { + "type": "string", + "description": "The name of the record." + }, + "owner": { + "type": "array", + "description": "The owners of the record.", + "items": { + "$ref": "#/definitions/BrowseResultOwner" + } + }, + "path": { + "type": "string", + "description": "The path of the record." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the record." + } + }, + "title": "BrowseResultValue", + "description": "The value item of the browse result." + }, + "BrowseResultOwner": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The GUID of the owner." + }, + "displayName": { + "type": "string", + "description": "The display name of the owner." + }, + "mail": { + "type": "string", + "description": "The mail of the owner." + }, + "contactType": { + "type": "string", + "description": "The contact type of the owner. The value will be Owner." + } + }, + "title": "BrowseResultOwner", + "description": "The value item of the browse owner." + }, "SearchResult": { "type": "object", "properties": { @@ -5604,14 +5369,14 @@ "type": "array", "description": "The terms assigned to the record.", "items": { - "$ref": "#/definitions/termSearchResultValue" + "$ref": "#/definitions/TermSearchResultValue" } }, "contact": { "type": "array", "description": "The contacts of the record.", "items": { - "$ref": "#/definitions/contactSearchResultValue" + "$ref": "#/definitions/ContactSearchResultValue" } }, "assetType": { @@ -5662,7 +5427,7 @@ }, "title": "SearchHighlights" }, - "termSearchResultValue": { + "TermSearchResultValue": { "type": "object", "properties": { "name": { @@ -5681,7 +5446,7 @@ "title": "Context", "description": "The context." }, - "contactSearchResultValue": { + "ContactSearchResultValue": { "type": "object", "properties": { "id": { @@ -5748,43 +5513,6 @@ "title": "AutoCompleteResultValue", "description": "The value item of the autocomplete suggest." }, - "Context": { - "type": "object", - "properties": { - "value": { - "type": "string", - "description": "The value of the context." - } - }, - "title": "Context", - "description": "The context." - }, - "Error": { - "type": "object", - "properties": { - "errorMessage": { - "type": "string", - "description": "The error message." - } - }, - "title": "Error", - "description": "The error response." - }, - "AtlasError": { - "type": "object", - "properties": { - "errorCode": { - "type": "string", - "description": "Error code" - }, - "errorMessage": { - "type": "string", - "description": "Error message" - } - }, - "title": "AtlasError", - "description": "The atlas error response." - }, "SearchRequest": { "type": "object", "properties": { @@ -5830,6 +5558,31 @@ "title": "SearchRequest", "description": "The search query of advanced search request." }, + "BrowseRequest": { + "type": "object", + "properties": { + "entityType": { + "type": "string", + "description": "The entity type to browse as the root level entry point." + }, + "path": { + "type": "string", + "description": "The path to browse the next level child entities." + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "The number of browse items we hope to return." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The offset. The default value is 0." + } + }, + "title": "BrowseRequest", + "description": "The criteria of browse request." + }, "SuggestRequest": { "type": "object", "properties": { @@ -5850,161 +5603,6 @@ "title": "SuggestRequest", "description": "The query of suggest request." }, - "HookNotificationType": { - "type": "string", - "enum": [ - "TYPE_CREATE", - "TYPE_UPDATE", - "ENTITY_CREATE", - "ENTITY_PARTIAL_UPDATE", - "ENTITY_FULL_UPDATE", - "ENTITY_DELETE", - "ENTITY_CREATE_V2", - "ENTITY_PARTIAL_UPDATE_V2", - "ENTITY_FULL_UPDATE_V2", - "ENTITY_DELETE_V2" - ], - "x-ms-enum": { - "name": "HookNotificationType", - "modelAsString": true - }, - "title": "HookNotificationType", - "description": "Enum of hook notification type. Different behavior will be invoked by the value." - }, - "HookNotification": { - "type": "object", - "properties": { - "type": { - "$ref": "#/definitions/HookNotificationType" - }, - "user": { - "type": "string", - "default": "UNKNOWN", - "description": "The user of the notification. Default to be \"UNKNOWN\"." - } - }, - "title": "HookNotification", - "description": "The base class for hook notification." - }, - "EntityCreateRequestV2": { - "type": "object", - "properties": { - "type": { - "$ref": "#/definitions/HookNotificationType" - }, - "user": { - "type": "string", - "default": "UNKNOWN", - "description": "The user of the notification. Default to be \"UNKNOWN\"." - }, - "entities": { - "$ref": "#/definitions/AtlasEntitiesWithExtInfo" - } - }, - "title": "EntityCreateRequestV2", - "description": "The class for hook notification for type ENTITY_CREATE_V2." - }, - "EntityUpdateRequestV2": { - "type": "object", - "properties": { - "type": { - "$ref": "#/definitions/HookNotificationType" - }, - "user": { - "type": "string", - "default": "UNKNOWN", - "description": "The user of the notification. Default to be \"UNKNOWN\"." - }, - "entities": { - "$ref": "#/definitions/AtlasEntitiesWithExtInfo" - } - }, - "title": "EntityUpdateRequestV2", - "description": "The class for hook notification for type ENTITY_FULL_UPDATE_V2." - }, - "EntityPartialUpdateRequestV2": { - "type": "object", - "properties": { - "type": { - "$ref": "#/definitions/HookNotificationType" - }, - "user": { - "type": "string", - "default": "UNKNOWN", - "description": "The user of the notification. Default to be \"UNKNOWN\"." - }, - "entityId": { - "$ref": "#/definitions/AtlasObjectId" - }, - "entity": { - "$ref": "#/definitions/AtlasEntitiesWithExtInfo" - } - }, - "title": "EntityPartialUpdateRequestV2", - "description": "The class for hook notification for type ENTITY_PARTIAL_UPDATE_V2." - }, - "EntityDeleteRequestV2": { - "type": "object", - "properties": { - "type": { - "$ref": "#/definitions/HookNotificationType" - }, - "user": { - "type": "string", - "default": "UNKNOWN", - "description": "The user of the notification. Default to be \"UNKNOWN\"." - }, - "entities": { - "type": "array", - "items": { - "$ref": "#/definitions/AtlasObjectId" - } - } - }, - "title": "EntityDeleteRequestV2", - "description": "The class for hook notification for type ENTITY_DELETE_V2." - }, - "RoleAssignmentEntry": { - "type": "object", - "title": "RoleAssignmentEntry", - "description": "A role assignment.", - "properties": { - "principalId": { - "type": "string", - "description": "The object ID of the AAD user." - }, - "role": { - "type": "string", - "description": "The name of the role." - } - } - }, - "UpdateRoleAssignmentRequest": { - "type": "object", - "title": "UpdateRoleAssignmentRequest", - "description": "The request for role assignment update operations.", - "properties": { - "roleAssignmentList": { - "type": "array", - "items": { - "$ref": "#/definitions/RoleAssignmentEntry" - } - } - } - }, - "ListRoleAssignmentResponse": { - "type": "object", - "title": "ListRoleAssignmentResponse", - "description": "The response of listing role assignments.", - "properties": { - "roleAssignmentList": { - "type": "array", - "items": { - "$ref": "#/definitions/RoleAssignmentEntry" - } - } - } - }, "ImportCSVOperation": { "type": "object", "title": "Status of import csv operation", @@ -6080,172 +5678,6 @@ "type": "string", "title": "lastModifiedTS", "description": "ETag for concurrency control." - }, - "xml_ns0_PList": { - "type": "object", - "title": "PList", - "xml": { - "name": "PList", - "namespace": "" - }, - "allOf": [ - { - "properties": { - "list": { - "type": "array", - "xml": { - "namespace": "" - }, - "description": "An array of objects.", - "items": { - "type": "object", - "properties": {} - } - }, - "pageSize": { - "type": "integer", - "format": "int32", - "xml": { - "namespace": "" - }, - "description": "The size of the page." - }, - "sortBy": { - "type": "string", - "xml": { - "namespace": "" - }, - "description": "The sorted by field." - }, - "sortType": { - "$ref": "#/definitions/xml_ns0_sortType" - }, - "startIndex": { - "type": "integer", - "format": "int64", - "xml": { - "namespace": "" - }, - "description": "The start index of the page." - }, - "totalCount": { - "type": "integer", - "format": "int64", - "xml": { - "namespace": "" - }, - "description": "The total count of items." - } - } - } - ], - "description": "Paginated-list, for returning search results." - }, - "xml_ns0_searchFilter": { - "type": "object", - "title": "searchFilter", - "xml": { - "name": "searchFilter", - "namespace": "" - }, - "allOf": [ - { - "properties": { - "getCount": { - "type": "boolean", - "xml": { - "namespace": "" - }, - "description": "Determines if get the count." - }, - "maxRows": { - "type": "integer", - "format": "int64", - "xml": { - "namespace": "" - }, - "description": "The maximum of rows." - }, - "params": { - "type": "object", - "xml": { - "namespace": "" - }, - "description": "The parameter of the search.", - "properties": {} - }, - "sortBy": { - "type": "string", - "xml": { - "namespace": "" - }, - "description": "The sorted by field." - }, - "sortType": { - "$ref": "#/definitions/xml_ns0_sortType" - }, - "startIndex": { - "type": "integer", - "format": "int64", - "xml": { - "namespace": "" - }, - "description": "The start index of the search." - } - } - } - ], - "description": "Generic filter, to specify search criteria using name/value pairs." - }, - "xml_ns0_sortType": { - "type": "string", - "title": "sortType", - "description": "to specify whether the result should be sorted? If yes, whether asc or desc.", - "enum": [ - "NONE", - "ASC", - "DESC" - ], - "x-ms-enum": { - "name": "xml_ns0_sortType", - "modelAsString": true - } - }, - "xml_ns0_timeBoundary": { - "type": "object", - "title": "timeBoundary", - "xml": { - "name": "timeBoundary", - "namespace": "" - }, - "allOf": [ - { - "properties": { - "endTime": { - "type": "string", - "xml": { - "namespace": "" - }, - "description": "The end of the time boundary." - }, - "startTime": { - "type": "string", - "xml": { - "namespace": "" - }, - "description": "The start of the time boundary." - }, - "timeZone": { - "type": "string", - "xml": { - "namespace": "" - }, - "description": "The timezone of the time boundary." - } - } - } - ], - "description": "Captures time-boundary details" } }, "parameters": { diff --git a/specification/purview/resource-manager/Microsoft.Purview/preview/2020-12-01-preview/purview.json b/specification/purview/resource-manager/Microsoft.Purview/preview/2020-12-01-preview/purview.json index 0abd987bbd46..19526cdbbdf5 100644 --- a/specification/purview/resource-manager/Microsoft.Purview/preview/2020-12-01-preview/purview.json +++ b/specification/purview/resource-manager/Microsoft.Purview/preview/2020-12-01-preview/purview.json @@ -725,6 +725,7 @@ } } }, + "x-ms-long-running-operation": true, "x-ms-examples": { "PrivateEndpointConnections_CreateOrUpdate": { "$ref": "./examples/PrivateEndpointConnections_CreateOrUpdate.json" @@ -1070,7 +1071,8 @@ "SoftDeleting", "SoftDeleted", "Failed", - "Succeeded" + "Succeeded", + "Canceled" ], "type": "string", "readOnly": true, @@ -1846,21 +1848,6 @@ } }, "parameters": { - "resourceGroupName": { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group name.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "subscriptionId": { - "name": "subscriptionId", - "in": "path", - "description": "The subscription identifier", - "required": true, - "type": "string" - }, "api-version": { "name": "api-version", "in": "query", @@ -1875,6 +1862,21 @@ "required": true, "type": "string", "x-ms-parameter-location": "method" + }, + "resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription identifier", + "required": true, + "type": "string" } }, "securityDefinitions": { diff --git a/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_AddRootCollectionAdmin.json b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_AddRootCollectionAdmin.json new file mode 100644 index 000000000000..bbc97e94aaa7 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_AddRootCollectionAdmin.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "SampleResourceGroup", + "accountName": "account1", + "api-version": "2021-07-01", + "collectionAdminUpdate": { + "objectId": "7e8de0e7-2bfc-4e1f-9659-2a5785e4356f" + } + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_CheckNameAvailability.json b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_CheckNameAvailability.json new file mode 100644 index 000000000000..24748dcd999b --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_CheckNameAvailability.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "checkNameAvailabilityRequest": { + "name": "account1", + "type": "Microsoft.Purview/accounts" + }, + "api-version": "2021-07-01", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_CreateOrUpdate.json b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_CreateOrUpdate.json new file mode 100644 index 000000000000..b81b9b5de8a2 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_CreateOrUpdate.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "SampleResourceGroup", + "accountName": "account1", + "api-version": "2021-07-01", + "account": { + "location": "West US 2", + "sku": { + "name": "Standard", + "capacity": 4 + }, + "properties": { + "managedResourceGroupName": "custom-rgname" + } + } + }, + "responses": { + "201": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "location": "West US 2", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1", + "name": "account1", + "type": "Microsoft.Purview/accounts", + "properties": { + "friendlyName": "friendly-account1", + "createdBy": "client-name", + "createdByObjectId": "client-objectId", + "createdAt": "2019-11-22T18:39:58.6929344Z", + "provisioningState": "Creating", + "endpoints": { + "catalog": "https://account1.catalog.purview.azure-test.com", + "scan": "https://account1.scan.purview.azure-test.com", + "guardian": "https://account1.guardian.purview.azure-test.com" + }, + "publicNetworkAccess": "Enabled" + } + } + }, + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "location": "West US 2", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1", + "name": "account1", + "type": "Microsoft.Purview/accounts", + "systemData": { + "createdBy": "client-name", + "createdByType": "User", + "createdAt": "2019-11-22T18:39:58.6929344Z", + "lastModifiedBy": "client-name", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-03-16T23:24:34.3430059Z" + }, + "properties": { + "friendlyName": "friendly-account1", + "createdBy": "client-name", + "createdByObjectId": "client-objectId", + "createdAt": "2019-11-22T18:39:58.6929344Z", + "provisioningState": "Succeeded", + "endpoints": { + "catalog": "https://account1.catalog.purview.azure-test.com", + "scan": "https://account1.scan.purview.azure-test.com", + "guardian": "https://account1.guardian.purview.azure-test.com" + }, + "publicNetworkAccess": "Enabled", + "managedResourceGroupName": "custom-rgname", + "managedResources": { + "resourceGroup": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/custom-rgname", + "storageAccount": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/custom-rgname/providers/Microsoft.Storage/storageAccounts/scanwestustzaagzr", + "eventHubNamespace": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/custom-rgname/providers/Microsoft.EventHub/namespaces/atlas-westusdddnbtp" + } + } + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_Delete.json b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_Delete.json new file mode 100644 index 000000000000..7f676d8976c0 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_Delete.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "SampleResourceGroup", + "accountName": "account1", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + } + }, + "202": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd", + "x-ms-long-running-operation": true, + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2021-07-01" + } + }, + "204": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_Get.json b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_Get.json new file mode 100644 index 000000000000..7b65c4b64f67 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_Get.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "SampleResourceGroup", + "accountName": "account1", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "location": "West US 2", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1", + "name": "account1", + "type": "Microsoft.Purview/accounts", + "sku": { + "name": "Standard", + "capacity": 4 + }, + "systemData": { + "createdBy": "client-name", + "createdByType": "User", + "createdAt": "2019-11-22T18:39:58.6929344Z", + "lastModifiedBy": "client-name", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-03-16T23:24:34.3430059Z" + }, + "properties": { + "friendlyName": "friendly-account1", + "createdBy": "client-name", + "createdByObjectId": "client-objectId", + "createdAt": "2019-11-22T18:39:58.6929344Z", + "provisioningState": "Succeeded", + "endpoints": { + "catalog": "https://account1.catalog.purview.azure-test.com", + "scan": "https://account1.scan.purview.azure-test.com", + "guardian": "https://account1.guardian.purview.azure-test.com" + }, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/baca8a88-4527-4c35-a13e-b2775ce0d7fc/resourceGroups/nrpResourceGroupName/providers/Microsoft.Network/privateEndpoints/peName" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my connection, thanks.", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateEndpointConnections/peName-8536c337-7b36-4d67-a7ce-081655baf59e", + "name": "peName-8536c337-7b36-4d67-a7ce-081655baf59e", + "type": "Microsoft.Purview/accounts/privateEndpointConnections" + } + ], + "publicNetworkAccess": "Enabled", + "managedResourceGroupName": "managed-rg-mwjotkl", + "managedResources": { + "resourceGroup": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl", + "storageAccount": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.Storage/storageAccounts/scanwestustzaagzr", + "eventHubNamespace": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.EventHub/namespaces/atlas-westusdddnbtp" + } + } + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_ListByResourceGroup.json b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_ListByResourceGroup.json new file mode 100644 index 000000000000..33bb1e7991b2 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_ListByResourceGroup.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "SampleResourceGroup" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:33:55 GMT", + "x-ms-request-id": "8e58266a-de42-40d5-b3c4-c6a7e159cfba", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14993", + "x-ms-correlation-request-id": "5d862c55-4de9-4a46-969d-cf1ed3e235ed" + }, + "body": { + "value": [ + { + "location": "West US 2", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1", + "name": "account1", + "type": "Microsoft.Purview/accounts", + "sku": { + "name": "Standard", + "capacity": 4 + }, + "systemData": { + "createdBy": "client-name", + "createdByType": "User", + "createdAt": "2019-11-22T18:39:58.6929344Z", + "lastModifiedBy": "client-name", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-03-16T23:24:34.3430059Z" + }, + "properties": { + "friendlyName": "friendly-account1", + "createdBy": "client-name", + "createdByObjectId": "client-objectId", + "createdAt": "2019-11-22T18:39:58.6929344Z", + "provisioningState": "Succeeded", + "endpoints": { + "catalog": "https://account1.catalog.purview.azure-test.com", + "scan": "https://account1.scan.purview.azure-test.com", + "guardian": "https://account1.guardian.purview.azure-test.com" + }, + "publicNetworkAccess": "Enabled" + } + }, + { + "location": "West US 2", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account2", + "name": "account2", + "type": "Microsoft.Purview/accounts", + "sku": { + "name": "Standard", + "capacity": 4 + }, + "systemData": { + "createdBy": "client-name", + "createdByType": "User", + "createdAt": "2019-11-22T18:39:58.6929344Z", + "lastModifiedBy": "client-name", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-03-16T23:24:34.3430059Z" + }, + "properties": { + "friendlyName": "friendly-account1", + "createdBy": "client-name", + "createdByObjectId": "client-objectId", + "createdAt": "2019-11-22T18:39:58.6929344Z", + "provisioningState": "Succeeded", + "endpoints": { + "catalog": "https://account2.catalog.purview.azure-test.com", + "scan": "https://account2.scan.purview.azure-test.com", + "guardian": "https://account1.guardian.purview.azure-test.com" + }, + "publicNetworkAccess": "Enabled" + } + } + ] + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_ListBySubscription.json b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_ListBySubscription.json new file mode 100644 index 000000000000..ac105e58f0a2 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_ListBySubscription.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:33:55 GMT", + "x-ms-request-id": "8e58266a-de42-40d5-b3c4-c6a7e159cfba", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14993", + "x-ms-correlation-request-id": "5d862c55-4de9-4a46-969d-cf1ed3e235ed" + }, + "body": { + "value": [ + { + "location": "West US 2", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1", + "name": "account1", + "type": "Microsoft.Purview/accounts", + "sku": { + "name": "Standard", + "capacity": 4 + }, + "systemData": { + "createdBy": "client-name", + "createdByType": "User", + "createdAt": "2019-11-22T18:39:58.6929344Z", + "lastModifiedBy": "client-name", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-03-16T23:24:34.3430059Z" + }, + "properties": { + "friendlyName": "friendly-account1", + "createdBy": "client-name", + "createdByObjectId": "client-objectId", + "createdAt": "2019-11-22T18:39:58.6929344Z", + "provisioningState": "Succeeded", + "endpoints": { + "catalog": "https://account1.catalog.purview.azure-test.com", + "scan": "https://account1.scan.purview.azure-test.com", + "guardian": "https://account1.guardian.purview.azure-test.com" + }, + "publicNetworkAccess": "Enabled" + } + }, + { + "location": "West US 2", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account2", + "name": "account2", + "type": "Microsoft.Purview/accounts", + "sku": { + "name": "Standard", + "capacity": 4 + }, + "systemData": { + "createdBy": "client-name", + "createdByType": "User", + "createdAt": "2019-11-22T18:39:58.6929344Z", + "lastModifiedBy": "client-name", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-03-16T23:24:34.3430059Z" + }, + "properties": { + "friendlyName": "friendly-account1", + "createdBy": "client-name", + "createdByObjectId": "client-objectId", + "createdAt": "2019-11-22T18:39:58.6929344Z", + "provisioningState": "Succeeded", + "endpoints": { + "catalog": "https://account2.catalog.purview.azure-test.com", + "scan": "https://account2.scan.purview.azure-test.com", + "guardian": "https://account1.guardian.purview.azure-test.com" + }, + "publicNetworkAccess": "Enabled" + } + } + ] + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_ListKeys.json b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_ListKeys.json new file mode 100644 index 000000000000..5b7af693f330 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_ListKeys.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "SampleResourceGroup", + "accountName": "account1", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "atlasKafkaPrimaryEndpoint": "Endpoint=sb://fake_objectId.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=ASDASasdfmasdf123412341234=", + "atlasKafkaSecondaryEndpoint": "Endpoint=sb://fake_objectId.servicebus.windows.net/;SharedAccessKeyName=AlternateSharedAccessKey;SharedAccessKey=BSDASasdfmasdf123412341234=" + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_Update.json b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_Update.json new file mode 100644 index 000000000000..c5606f1efb71 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Accounts_Update.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "SampleResourceGroup", + "accountName": "account1", + "api-version": "2021-07-01", + "accountUpdateParameters": { + "tags": { + "newTag": "New tag value." + } + } + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "location": "West US 2", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1", + "name": "account1", + "type": "Microsoft.Purview/accounts", + "sku": { + "name": "Standard", + "capacity": 4 + }, + "systemData": { + "createdBy": "client-name", + "createdByType": "User", + "createdAt": "2019-11-22T18:39:58.6929344Z", + "lastModifiedBy": "client-name", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-03-16T23:24:34.3430059Z" + }, + "properties": { + "friendlyName": "friendly-account1", + "createdBy": "client-name", + "createdByObjectId": "client-objectId", + "createdAt": "2019-11-22T18:39:58.6929344Z", + "provisioningState": "Succeeded", + "endpoints": { + "catalog": "https://account2.catalog.purview.azure-test.com", + "scan": "https://account2.scan.purview.azure-test.com", + "guardian": "https://account1.guardian.purview.azure-test.com" + }, + "publicNetworkAccess": "Enabled", + "managedResources": { + "resourceGroup": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl", + "storageAccount": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.Storage/storageAccounts/scanwestustzaagzr", + "eventHubNamespace": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.EventHub/namespaces/atlas-westusdddnbtp" + } + }, + "tags": { + "newTag": "New tag value." + } + } + }, + "202": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd", + "x-ms-long-running-operation": true, + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2021-07-01" + }, + "body": { + "location": "West US 2", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1", + "name": "account1", + "type": "Microsoft.Purview/accounts", + "sku": { + "name": "Standard", + "capacity": 4 + }, + "systemData": { + "createdBy": "client-name", + "createdByType": "User", + "createdAt": "2019-11-22T18:39:58.6929344Z", + "lastModifiedBy": "client-name", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-03-16T23:24:34.3430059Z" + }, + "properties": { + "friendlyName": "friendly-account1", + "createdBy": "client-name", + "createdByObjectId": "client-objectId", + "createdAt": "2019-11-22T18:39:58.6929344Z", + "provisioningState": "Succeeded", + "endpoints": { + "catalog": "https://account2.catalog.purview.azure-test.com", + "scan": "https://account2.scan.purview.azure-test.com", + "guardian": "https://account1.guardian.purview.azure-test.com" + }, + "publicNetworkAccess": "Enabled", + "managedResources": { + "resourceGroup": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl", + "storageAccount": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.Storage/storageAccounts/scanwestustzaagzr", + "eventHubNamespace": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.EventHub/namespaces/atlas-westusdddnbtp" + } + }, + "tags": { + "newTag": "New tag value." + } + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/DefaultAccounts_Get.json b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/DefaultAccounts_Get.json new file mode 100644 index 000000000000..bdba6b4798cb --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/DefaultAccounts_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "scopeTenantId": "12345678-1234-1234-12345678abc", + "scopeType": "Tenant", + "scope": "12345678-1234-1234-12345678abc", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "scopeTenantId": "12345678-1234-1234-12345678abc", + "scopeType": "Tenant", + "scope": "12345678-1234-1234-12345678abc", + "accountName": "myDefaultAccount", + "resourceGroupName": "rg-1", + "subscriptionId": "12345678-1234-1234-12345678aaa" + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/DefaultAccounts_Remove.json b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/DefaultAccounts_Remove.json new file mode 100644 index 000000000000..55661cde2117 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/DefaultAccounts_Remove.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "scopeTenantId": "12345678-1234-1234-12345678abc", + "scopeType": "Tenant", + "scope": "12345678-1234-1234-12345678abc", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + } + }, + "204": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/DefaultAccounts_Set.json b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/DefaultAccounts_Set.json new file mode 100644 index 000000000000..dcbf3c21bfb6 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/DefaultAccounts_Set.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "defaultAccountPayload": { + "scopeTenantId": "12345678-1234-1234-12345678abc", + "scopeType": "Tenant", + "scope": "12345678-1234-1234-12345678abc", + "accountName": "myDefaultAccount", + "resourceGroupName": "rg-1", + "subscriptionId": "12345678-1234-1234-12345678aaa" + } + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "scopeTenantId": "12345678-1234-1234-12345678abc", + "scopeType": "Tenant", + "scope": "12345678-1234-1234-12345678abc", + "accountName": "myDefaultAccount", + "resourceGroupName": "rg-1", + "subscriptionId": "12345678-1234-1234-12345678aaa" + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Operations_List.json b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Operations_List.json new file mode 100644 index 000000000000..40c4596b30ca --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/Operations_List.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "value": [ + { + "name": "Microsoft.Purview/operations/read", + "display": { + "provider": "Microsoft Purview", + "resource": "Operations", + "operation": "Read all operations", + "description": "Reads all available operations in Purview Resource Provider." + } + }, + { + "name": "Microsoft.Purview/register/action", + "display": { + "provider": "Microsoft Purview", + "resource": "Purview Resource Provider", + "operation": "Register Purview Resource Provider", + "description": "Register the subscription for Purview Resource Provider" + } + }, + { + "name": "Microsoft.Purview/unregister/action", + "display": { + "provider": "Microsoft Purview", + "resource": "Purview Resource Provider", + "operation": "Unregister Purview Resource Provider", + "description": "Unregister the subscription for Purview Resource Provider" + } + }, + { + "name": "Microsoft.Purview/accounts/read", + "display": { + "provider": "Microsoft Purview", + "resource": "Account", + "operation": "Read account resource", + "description": "Read account resource for Purview Resource Provider." + } + }, + { + "name": "Microsoft.Purview/accounts/write", + "display": { + "provider": "Microsoft Purview", + "resource": "Account", + "operation": "Write account resource", + "description": "Write account resource for Purview Resource Provider." + } + }, + { + "name": "Microsoft.Purview/accounts/delete", + "display": { + "provider": "Microsoft Purview", + "resource": "Account", + "operation": "Delete account resource", + "description": "Delete account resource for Purview Resource Provider." + } + } + ] + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/PrivateEndpointConnections_CreateOrUpdate.json b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/PrivateEndpointConnections_CreateOrUpdate.json new file mode 100644 index 000000000000..e44c71177561 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/PrivateEndpointConnections_CreateOrUpdate.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "SampleResourceGroup", + "accountName": "account1", + "privateEndpointConnectionName": "privateEndpointConnection1", + "api-version": "2021-07-01", + "request": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@company.com" + } + } + } + }, + "responses": { + "201": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd", + "x-ms-long-running-operation": true, + "Azure-AsyncOperation": "https://management.azure.com/subscriptions34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateEndpointConnections/privateEndpointConnection1?api-version=2021-07-01" + }, + "body": { + "name": "privateEndpointConnection1", + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateEndpointConnections/privateEndpointConnection1", + "type": "Microsoft.Purview/accounts/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@company.com" + } + } + } + }, + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "name": "privateEndpointConnection1", + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateEndpointConnections/privateEndpointConnection1", + "type": "Microsoft.Purview/accounts/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@company.com" + } + } + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/PrivateEndpointConnections_Delete.json b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/PrivateEndpointConnections_Delete.json new file mode 100644 index 000000000000..96d8d62b3c7a --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/PrivateEndpointConnections_Delete.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "SampleResourceGroup", + "accountName": "account1", + "privateEndpointConnectionName": "privateEndpointConnection1", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + } + }, + "202": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd", + "x-ms-long-running-operation": true, + "Azure-AsyncOperation": "https://management.azure.com/subscriptions34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateEndpointConnections/privateEndpointConnection1?api-version=2021-07-01" + } + }, + "204": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/PrivateEndpointConnections_Get.json b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/PrivateEndpointConnections_Get.json new file mode 100644 index 000000000000..5a338b4a287a --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/PrivateEndpointConnections_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "SampleResourceGroup", + "accountName": "account1", + "privateEndpointConnectionName": "privateEndpointConnection1", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "name": "privateEndpointConnection1", + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateEndpointConnections/privateEndpointConnection1", + "type": "Microsoft.Purview/accounts/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@company.com" + } + } + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/PrivateEndpointConnections_ListByAccount.json b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/PrivateEndpointConnections_ListByAccount.json new file mode 100644 index 000000000000..66e59b15eea8 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/PrivateEndpointConnections_ListByAccount.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "SampleResourceGroup", + "accountName": "account1", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:33:55 GMT", + "x-ms-request-id": "8e58266a-de42-40d5-b3c4-c6a7e159cfba", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14993", + "x-ms-correlation-request-id": "5d862c55-4de9-4a46-969d-cf1ed3e235ed" + }, + "body": { + "value": [ + { + "name": "privateEndpointConnection1", + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateEndpointConnections/privateEndpointConnection1", + "type": "Microsoft.Purview/accounts/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@company.com" + } + } + }, + { + "name": "privateEndpointConnection2", + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateEndpointConnections/privateEndpointConnection2", + "type": "Microsoft.Purview/accounts/privateEndpointConnections", + "properties": { + "provisioningState": "Deleting", + "privateEndpoint": { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Rejected", + "description": "Rejected by johndoe@company.com" + } + } + } + ] + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/PrivateLinkResources_GetByGroupId.json b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/PrivateLinkResources_GetByGroupId.json new file mode 100644 index 000000000000..64a531920e73 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/PrivateLinkResources_GetByGroupId.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "SampleResourceGroup", + "accountName": "account1", + "groupId": "group1", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateLinkResources/plr1", + "name": "plr1", + "type": "Microsoft.Purview/accounts/privateLinkResources", + "properties": { + "groupId": "group1", + "requiredMembers": [ + "group1" + ], + "requiredZoneNames": [ + "privatelinkzone1.service.azure.com" + ] + } + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/PrivateLinkResources_ListByAccount.json b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/PrivateLinkResources_ListByAccount.json new file mode 100644 index 000000000000..de1da1efdb03 --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/examples/PrivateLinkResources_ListByAccount.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "SampleResourceGroup", + "accountName": "account1", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateLinkResources/plr1", + "name": "plr1", + "type": "Microsoft.Purview/accounts/privateLinkResources", + "properties": { + "groupId": "account1", + "requiredMembers": [ + "account1" + ], + "requiredZoneNames": [ + "privatelinkzone1.service.azure.com" + ] + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/privateLinkResources/plr2", + "name": "plr2", + "type": "Microsoft.Purview/accounts/privateLinkResources", + "properties": { + "groupId": "account2", + "requiredMembers": [ + "account2" + ], + "requiredZoneNames": [ + "privatelinkzone2.service.azure.com" + ] + } + } + ] + } + } + } +} diff --git a/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/purview.json b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/purview.json new file mode 100644 index 000000000000..64fab73535fd --- /dev/null +++ b/specification/purview/resource-manager/Microsoft.Purview/stable/2021-07-01/purview.json @@ -0,0 +1,1960 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-07-01", + "title": "PurviewManagementClient", + "description": "Creates a Microsoft.Purview management client." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts": { + "get": { + "tags": [ + "Account" + ], + "summary": "Gets the accounts resources by resource group.", + "description": "List accounts in ResourceGroup", + "operationId": "Accounts_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "$skipToken", + "in": "query", + "description": "The skip token.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AccountList" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Accounts_ListByResourceGroup": { + "$ref": "./examples/Accounts_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Purview/accounts": { + "get": { + "tags": [ + "Account" + ], + "summary": "Gets the accounts resources by subscription.", + "description": "List accounts in Subscription", + "operationId": "Accounts_ListBySubscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "$skipToken", + "in": "query", + "description": "The skip token.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AccountList" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Accounts_ListBySubscription": { + "$ref": "./examples/Accounts_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}": { + "get": { + "tags": [ + "Account" + ], + "summary": "Gets the account resource.", + "description": "Get an account", + "operationId": "Accounts_Get", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Accounts_Get": { + "$ref": "./examples/Accounts_Get.json" + } + } + }, + "put": { + "tags": [ + "Account" + ], + "summary": "Create or update an account resource", + "description": "Creates or updates an account", + "operationId": "Accounts_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "name": "account", + "in": "body", + "description": "The account.", + "required": true, + "schema": { + "$ref": "#/definitions/Account" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Accounts_CreateOrUpdate": { + "$ref": "./examples/Accounts_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Account" + ], + "summary": "Deletes the account resource.", + "description": "Deletes an account resource", + "operationId": "Accounts_Delete", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Accounts_Delete": { + "$ref": "./examples/Accounts_Delete.json" + } + } + }, + "patch": { + "tags": [ + "Account" + ], + "summary": "Patches the account resource.", + "description": "Updates an account", + "operationId": "Accounts_Update", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "name": "accountUpdateParameters", + "in": "body", + "description": "The account update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AccountUpdateParameters" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Accounts_Update": { + "$ref": "./examples/Accounts_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/listkeys": { + "post": { + "tags": [ + "Account" + ], + "summary": "Lists the keys asynchronous.", + "description": "List the authorization keys associated with this account.", + "operationId": "Accounts_ListKeys", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Accounts_ListKeys": { + "$ref": "./examples/Accounts_ListKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/addRootCollectionAdmin": { + "post": { + "tags": [ + "Account" + ], + "summary": "Add the administrator for root collection.", + "description": "Add the administrator for root collection associated with this account.", + "operationId": "Accounts_AddRootCollectionAdmin", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "name": "collectionAdminUpdate", + "in": "body", + "description": "The collection admin update payload.", + "required": true, + "schema": { + "$ref": "#/definitions/CollectionAdminUpdate" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Accounts_AddRootCollectionAdmin": { + "$ref": "./examples/Accounts_AddRootCollectionAdmin.json" + } + } + } + }, + "/providers/Microsoft.Purview/getDefaultAccount": { + "get": { + "tags": [ + "DefaultAccount" + ], + "summary": "Gets the default account information set for the scope.", + "description": "Get the default account for the scope.", + "operationId": "DefaultAccounts_Get", + "parameters": [ + { + "name": "scopeTenantId", + "in": "query", + "description": "The tenant ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "scopeType", + "in": "query", + "description": "The scope for the default account.", + "required": true, + "type": "string", + "enum": [ + "Tenant", + "Subscription" + ], + "x-ms-enum": { + "name": "ScopeType", + "modelAsString": true + } + }, + { + "name": "scope", + "in": "query", + "description": "The Id of the scope object, for example if the scope is \"Subscription\" then it is the ID of that subscription.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DefaultAccountPayload" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "DefaultAccounts_Get": { + "$ref": "./examples/DefaultAccounts_Get.json" + } + } + } + }, + "/providers/Microsoft.Purview/setDefaultAccount": { + "post": { + "tags": [ + "DefaultAccount" + ], + "summary": "Sets the default account for the scope.", + "description": "Sets the default account for the scope.", + "operationId": "DefaultAccounts_Set", + "parameters": [ + { + "name": "defaultAccountPayload", + "in": "body", + "description": "The payload containing the default account information and the scope.", + "required": true, + "schema": { + "$ref": "#/definitions/DefaultAccountPayload" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DefaultAccountPayload" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "DefaultAccounts_Set": { + "$ref": "./examples/DefaultAccounts_Set.json" + } + } + } + }, + "/providers/Microsoft.Purview/removeDefaultAccount": { + "post": { + "tags": [ + "DefaultAccount" + ], + "summary": "Removes the default account from the scope.", + "description": "Removes the default account from the scope.", + "operationId": "DefaultAccounts_Remove", + "parameters": [ + { + "name": "scopeTenantId", + "in": "query", + "description": "The tenant ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "scopeType", + "in": "query", + "description": "The scope for the default account.", + "required": true, + "type": "string", + "enum": [ + "Tenant", + "Subscription" + ], + "x-ms-enum": { + "name": "ScopeType", + "modelAsString": true + } + }, + { + "name": "scope", + "in": "query", + "description": "The Id of the scope object, for example if the scope is \"Subscription\" then it is the ID of that subscription.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "DefaultAccounts_Remove": { + "$ref": "./examples/DefaultAccounts_Remove.json" + } + } + } + }, + "/providers/Microsoft.Purview/operations": { + "get": { + "tags": [ + "Operation" + ], + "summary": "Lists the available operations", + "description": "List of available operations", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnection" + ], + "summary": "Gets private endpoint connections.", + "description": "Get private endpoint connections for account", + "operationId": "PrivateEndpointConnections_ListByAccount", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "$skipToken", + "in": "query", + "description": "The skip token.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionList" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrivateEndpointConnections_ListByAccount": { + "$ref": "./examples/PrivateEndpointConnections_ListByAccount.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnection" + ], + "summary": "Gets private endpoint connection information.", + "description": "Get a private endpoint connection", + "operationId": "PrivateEndpointConnections_Get", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Name of the private endpoint connection.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_Get": { + "$ref": "./examples/PrivateEndpointConnections_Get.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnection" + ], + "summary": "Approves/Rejects private endpoint connection request.", + "description": "Create or update a private endpoint connection", + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Name of the private endpoint connection.", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "The request.", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PrivateEndpointConnections_CreateOrUpdate": { + "$ref": "./examples/PrivateEndpointConnections_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnection" + ], + "summary": "Deletes private endpoint connection.", + "description": "Delete a private endpoint connection", + "operationId": "PrivateEndpointConnections_Delete", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Name of the private endpoint connection.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PrivateEndpointConnections_Delete": { + "$ref": "./examples/PrivateEndpointConnections_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResource" + ], + "summary": "Gets a list of privately linkable resources for an account.", + "description": "Gets a list of privately linkable resources for an account", + "operationId": "PrivateLinkResources_ListByAccount", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceList" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrivateLinkResources_ListByAccount": { + "$ref": "./examples/PrivateLinkResources_ListByAccount.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/privateLinkResources/{groupId}": { + "get": { + "tags": [ + "PrivateLinkResource" + ], + "summary": "Gets a privately linkable resources for an account with given group identifier.", + "description": "Gets a privately linkable resources for an account with given group identifier", + "operationId": "PrivateLinkResources_GetByGroupId", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "name": "groupId", + "in": "path", + "description": "The group identifier.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "PrivateLinkResources_GetByGroupId": { + "$ref": "./examples/PrivateLinkResources_GetByGroupId.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Purview/checkNameAvailability": { + "post": { + "tags": [ + "Provider" + ], + "summary": "Checks the account name availability.", + "description": "Checks if account name is available.", + "operationId": "Accounts_CheckNameAvailability", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "checkNameAvailabilityRequest", + "in": "body", + "description": "The check name availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityRequest" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "An error response received from the provider.", + "schema": { + "$ref": "#/definitions/ErrorResponseModel" + } + } + }, + "x-ms-examples": { + "Accounts_CheckNameAvailability": { + "$ref": "./examples/Accounts_CheckNameAvailability.json" + } + } + } + } + }, + "definitions": { + "AccountList": { + "description": "Paged list of account resources", + "required": [ + "value" + ], + "type": "object", + "properties": { + "count": { + "format": "int64", + "description": "Total item count.", + "type": "integer" + }, + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + }, + "value": { + "description": "Collection of items of type results.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Account" + } + } + } + }, + "Account": { + "description": "Account resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AccountProperties", + "description": "Gets or sets the properties.", + "x-ms-client-flatten": true + }, + "sku": { + "$ref": "#/definitions/AccountSku", + "description": "Gets or sets the Sku." + } + } + }, + "AccountSku": { + "description": "The Sku", + "type": "object", + "properties": { + "capacity": { + "format": "int32", + "description": "Gets or sets the sku capacity. Possible values include: 4, 16", + "type": "integer" + }, + "name": { + "description": "Gets or sets the sku name.", + "enum": [ + "Standard" + ], + "type": "string", + "x-ms-enum": { + "name": "name", + "modelAsString": true + } + } + } + }, + "AccountProperties": { + "description": "The account properties", + "type": "object", + "properties": { + "cloudConnectors": { + "$ref": "#/definitions/CloudConnectors", + "description": "Cloud connectors.\r\nExternal cloud identifier used as part of scanning configuration." + }, + "createdAt": { + "format": "date-time", + "description": "Gets the time at which the entity was created.", + "type": "string", + "readOnly": true + }, + "createdBy": { + "description": "Gets the creator of the entity.", + "type": "string", + "readOnly": true + }, + "createdByObjectId": { + "description": "Gets the creators of the entity's object id.", + "type": "string", + "readOnly": true + }, + "endpoints": { + "description": "The URIs that are the public endpoints of the account.", + "allOf": [ + { + "$ref": "#/definitions/AccountEndpoints" + } + ], + "readOnly": true + }, + "friendlyName": { + "description": "Gets or sets the friendly name.", + "type": "string", + "readOnly": true + }, + "managedResourceGroupName": { + "description": "Gets or sets the managed resource group name", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "managedResources": { + "description": "Gets the resource identifiers of the managed resources.", + "allOf": [ + { + "$ref": "#/definitions/ManagedResources" + } + ], + "readOnly": true + }, + "privateEndpointConnections": { + "description": "Gets the private endpoint connections information.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "provisioningState": { + "description": "Gets or sets the state of the provisioning.", + "enum": [ + "Unknown", + "Creating", + "Moving", + "Deleting", + "SoftDeleting", + "SoftDeleted", + "Failed", + "Succeeded", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } + }, + "publicNetworkAccess": { + "description": "Gets or sets the public network access.", + "default": "Enabled", + "enum": [ + "NotSpecified", + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "publicNetworkAccess", + "modelAsString": true + } + } + } + }, + "Identity": { + "description": "The Managed Identity of the resource", + "type": "object", + "properties": { + "principalId": { + "description": "Service principal object Id", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "Tenant Id", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Identity Type", + "enum": [ + "SystemAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "type", + "modelAsString": true + } + } + } + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "properties": { + "createdAt": { + "format": "date-time", + "description": "The timestamp of resource creation (UTC).", + "type": "string", + "readOnly": true + }, + "createdBy": { + "description": "The identity that created the resource.", + "type": "string", + "readOnly": true + }, + "createdByType": { + "description": "The type of identity that created the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "lastModifiedAt": { + "format": "date-time", + "description": "The timestamp of the last modification the resource (UTC).", + "type": "string", + "readOnly": true + }, + "lastModifiedBy": { + "description": "The identity that last modified the resource.", + "type": "string", + "readOnly": true + }, + "lastModifiedByType": { + "description": "The type of identity that last modified the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "lastModifiedByType", + "modelAsString": true + } + } + } + }, + "CloudConnectors": { + "type": "object", + "properties": { + "awsExternalId": { + "description": "AWS external identifier.\r\nConfigured in AWS to allow use of the role arn used for scanning", + "type": "string", + "readOnly": true + } + } + }, + "AccountEndpoints": { + "description": "The account endpoints", + "type": "object", + "properties": { + "catalog": { + "description": "Gets the catalog endpoint.", + "type": "string", + "readOnly": true + }, + "guardian": { + "description": "Gets the guardian endpoint.", + "type": "string", + "readOnly": true + }, + "scan": { + "description": "Gets the scan endpoint.", + "type": "string", + "readOnly": true + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection class.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The connection identifier.", + "x-ms-client-flatten": true + } + } + }, + "ManagedResources": { + "description": "The managed resources in customer subscription.", + "type": "object", + "properties": { + "eventHubNamespace": { + "description": "Gets the managed event hub namespace resource identifier.", + "type": "string", + "readOnly": true + }, + "resourceGroup": { + "description": "Gets the managed resource group resource identifier. This resource group will host resource dependencies for the account.", + "type": "string", + "readOnly": true + }, + "storageAccount": { + "description": "Gets the managed storage account resource identifier.", + "type": "string", + "readOnly": true + } + } + }, + "PrivateEndpointConnectionProperties": { + "description": "A private endpoint connection properties class.", + "type": "object", + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The private endpoint information." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "The private link service connection state." + }, + "provisioningState": { + "description": "The provisioning state.", + "type": "string", + "readOnly": true + } + } + }, + "PrivateEndpoint": { + "description": "A private endpoint class.", + "type": "object", + "properties": { + "id": { + "description": "The private endpoint identifier.", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "The private link service connection state.", + "type": "object", + "properties": { + "actionsRequired": { + "description": "The required actions.", + "type": "string" + }, + "description": { + "description": "The description.", + "type": "string" + }, + "status": { + "description": "The status.", + "enum": [ + "Unknown", + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "status", + "modelAsString": true + } + } + } + }, + "ErrorResponseModel": { + "description": "Default error response model", + "type": "object", + "properties": { + "error": { + "description": "Gets or sets the error.", + "allOf": [ + { + "$ref": "#/definitions/ErrorModel" + } + ], + "readOnly": true + } + } + }, + "ErrorModel": { + "description": "Default error model", + "type": "object", + "properties": { + "code": { + "description": "Gets or sets the code.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Gets or sets the details.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ErrorModel" + }, + "readOnly": true + }, + "message": { + "description": "Gets or sets the messages.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "Gets or sets the target.", + "type": "string", + "readOnly": true + } + } + }, + "AccountUpdateParameters": { + "description": "The account update properties.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AccountProperties", + "description": "The account properties." + }, + "tags": { + "description": "Tags on the azure resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "AccessKeys": { + "description": "The Account access keys.", + "type": "object", + "properties": { + "atlasKafkaPrimaryEndpoint": { + "description": "Gets or sets the primary connection string.", + "type": "string" + }, + "atlasKafkaSecondaryEndpoint": { + "description": "Gets or sets the secondary connection string.", + "type": "string" + } + } + }, + "CollectionAdminUpdate": { + "description": "Collection administrator update.", + "type": "object", + "properties": { + "objectId": { + "description": "Gets or sets the object identifier of the admin.", + "type": "string" + } + } + }, + "DefaultAccountPayload": { + "description": "Payload to get and set the default account in the given scope", + "type": "object", + "properties": { + "accountName": { + "description": "The name of the account that is set as the default.", + "type": "string" + }, + "resourceGroupName": { + "description": "The resource group name of the account that is set as the default.", + "type": "string" + }, + "scope": { + "description": "The scope object ID. For example, sub ID or tenant ID.", + "type": "string" + }, + "scopeTenantId": { + "description": "The scope tenant in which the default account is set.", + "type": "string" + }, + "scopeType": { + "description": "The scope where the default account is set.", + "enum": [ + "Tenant", + "Subscription" + ], + "type": "string", + "x-ms-enum": { + "name": "scopeType", + "modelAsString": true + } + }, + "subscriptionId": { + "description": "The subscription ID of the account that is set as the default.", + "type": "string" + } + } + }, + "OperationList": { + "description": "Paged list of operation resources", + "required": [ + "value" + ], + "type": "object", + "properties": { + "count": { + "format": "int64", + "description": "Total item count.", + "type": "integer" + }, + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + }, + "value": { + "description": "Collection of items of type results.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + } + } + }, + "Operation": { + "description": "Operation resource", + "type": "object", + "properties": { + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "Properties on the operation" + }, + "isDataAction": { + "description": "Whether operation is a data action", + "type": "boolean" + }, + "name": { + "description": "Operation name for display purposes", + "type": "string" + }, + "origin": { + "description": "origin of the operation", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "properties for the operation meta info", + "x-ms-client-flatten": true + } + } + }, + "OperationDisplay": { + "description": "The response model for get operation properties", + "type": "object", + "properties": { + "description": { + "description": "Description of the operation for display purposes", + "type": "string" + }, + "operation": { + "description": "Name of the operation for display purposes", + "type": "string" + }, + "provider": { + "description": "Name of the provider for display purposes", + "type": "string" + }, + "resource": { + "description": "Name of the resource type for display purposes", + "type": "string" + } + } + }, + "OperationProperties": { + "description": "properties on meta info", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/OperationMetaServiceSpecification", + "description": "meta service specification" + } + } + }, + "OperationMetaServiceSpecification": { + "description": "The operation meta service specification", + "type": "object", + "properties": { + "logSpecifications": { + "description": "log specifications for the operation", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/OperationMetaLogSpecification" + } + }, + "metricSpecifications": { + "description": "metric specifications for the operation", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/OperationMetaMetricSpecification" + } + } + } + }, + "OperationMetaMetricSpecification": { + "description": "metric specifications for the operation", + "type": "object", + "properties": { + "aggregationType": { + "description": "aggregation type of metric", + "type": "string" + }, + "dimensions": { + "description": "properties for dimension", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/DimensionProperties" + } + }, + "displayDescription": { + "description": "description of the metric", + "type": "string" + }, + "displayName": { + "description": "localized name of the metric", + "type": "string" + }, + "enableRegionalMdmAccount": { + "description": "enable regional mdm account", + "type": "string" + }, + "internalMetricName": { + "description": "internal metric name", + "type": "string" + }, + "name": { + "description": "name of the metric", + "type": "string" + }, + "resourceIdDimensionNameOverride": { + "description": "dimension name use to replace resource id if specified", + "type": "string" + }, + "sourceMdmNamespace": { + "description": "Metric namespace.\r\nOnly set the namespace if different from the default value, \r\nleaving it empty makes it use the value from the ARM manifest.", + "type": "string" + }, + "supportedAggregationTypes": { + "description": "supported aggregation types", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "supportedTimeGrainTypes": { + "description": "supported time grain types", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "unit": { + "description": "units for the metric", + "type": "string" + } + } + }, + "OperationMetaLogSpecification": { + "description": "log specifications for operation api", + "type": "object", + "properties": { + "blobDuration": { + "description": "blob duration of the log", + "type": "string" + }, + "displayName": { + "description": "localized name of the log category", + "type": "string" + }, + "name": { + "description": "name of the log category", + "type": "string" + } + } + }, + "DimensionProperties": { + "description": "properties for dimension", + "type": "object", + "properties": { + "displayName": { + "description": "localized display name of the dimension to customer", + "type": "string" + }, + "name": { + "description": "dimension name", + "type": "string" + }, + "toBeExportedForCustomer": { + "description": "flag indicating whether this dimension should be included to the customer in Azure Monitor logs (aka Shoebox)", + "type": "boolean" + } + } + }, + "PrivateEndpointConnectionList": { + "description": "Paged list of private endpoint connections", + "required": [ + "value" + ], + "type": "object", + "properties": { + "count": { + "format": "int64", + "description": "Total item count.", + "type": "integer" + }, + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + }, + "value": { + "description": "Collection of items of type results.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + } + }, + "PrivateLinkResourceList": { + "description": "Paged list of private link resources", + "required": [ + "value" + ], + "type": "object", + "properties": { + "count": { + "format": "int64", + "description": "Total item count.", + "type": "integer" + }, + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + }, + "value": { + "description": "Collection of items of type results.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + } + }, + "PrivateLinkResource": { + "description": "A privately linkable resource.", + "type": "object", + "properties": { + "id": { + "description": "The private link resource identifier.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The private link resource name.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "The private link resource properties.", + "readOnly": true + }, + "type": { + "description": "The private link resource type.", + "type": "string", + "readOnly": true + } + } + }, + "PrivateLinkResourceProperties": { + "description": "A privately linkable resource properties.", + "type": "object", + "properties": { + "groupId": { + "description": "The private link resource group identifier.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "This translates to how many Private IPs should be created for each privately linkable resource.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "description": "The required zone names for private link resource.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "CheckNameAvailabilityRequest": { + "description": "The request payload for CheckNameAvailability API", + "type": "object", + "properties": { + "name": { + "description": "Resource name to verify for availability", + "type": "string" + }, + "type": { + "description": "Fully qualified resource type which includes provider namespace", + "type": "string" + } + } + }, + "CheckNameAvailabilityResult": { + "description": "The response payload for CheckNameAvailability API", + "type": "object", + "properties": { + "message": { + "description": "Error message", + "type": "string" + }, + "nameAvailable": { + "description": "Indicates if name is valid and available.", + "type": "boolean" + }, + "reason": { + "description": "The reason the name is not available.", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "x-ms-enum": { + "name": "reason", + "modelAsString": true + } + } + } + }, + "TrackedResource": { + "description": "Azure ARM Tracked Resource", + "type": "object", + "properties": { + "id": { + "description": "Gets or sets the identifier.", + "type": "string", + "readOnly": true + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "Identity Info on the tracked resource" + }, + "location": { + "description": "Gets or sets the location.", + "type": "string" + }, + "name": { + "description": "Gets or sets the name.", + "type": "string", + "readOnly": true + }, + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "allOf": [ + { + "$ref": "#/definitions/SystemData" + } + ], + "readOnly": true + }, + "tags": { + "description": "Tags on the azure resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "type": { + "description": "Gets or sets the type.", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "ProxyResource": { + "description": "Proxy Azure Resource", + "type": "object", + "properties": { + "id": { + "description": "Gets or sets the identifier.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Gets or sets the name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Gets or sets the type.", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription identifier", + "required": true, + "type": "string" + }, + "accountName": { + "name": "accountName", + "in": "path", + "description": "The name of the account.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "api-version": { + "name": "api-version", + "in": "query", + "description": "The api version to use.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "tags": [] +} diff --git a/specification/purview/resource-manager/readme.go.md b/specification/purview/resource-manager/readme.go.md index aa7f67359045..6387b976cd36 100644 --- a/specification/purview/resource-manager/readme.go.md +++ b/specification/purview/resource-manager/readme.go.md @@ -24,6 +24,7 @@ directive: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2021-07-01 - tag: package-2020-12-01-preview ``` @@ -34,4 +35,13 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2021-07-01' && $(go) +output-folder: $(go-sdk-folder)/services/purview/mgmt/2021-07-01/$(namespace) +``` diff --git a/specification/purview/resource-manager/readme.md b/specification/purview/resource-manager/readme.md index 06393cede641..076ce998d2fe 100644 --- a/specification/purview/resource-manager/readme.md +++ b/specification/purview/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the Purview API. ``` yaml openapi-type: arm -tag: package-2020-12-01-preview +tag: package-2021-07-01 ``` @@ -39,6 +39,16 @@ input-file: - Microsoft.Purview/preview/2020-12-01-preview/purview.json ``` + +### Tag: package-2021-07-01 + +These settings apply only when `--tag=package-2021-07-01` is specified on the command line. + +``` yaml $(tag) == 'package-2021-07-01' +input-file: +- Microsoft.Purview/stable/2021-07-01/purview.json +``` + --- # Code Generation diff --git a/specification/quantum/data-plane/Microsoft.Quantum/preview/2021-05-06-preview/examples/jobDelete.json b/specification/quantum/data-plane/Microsoft.Quantum/preview/2021-05-06-preview/examples/jobDelete.json new file mode 100644 index 000000000000..705e0ea4d43c --- /dev/null +++ b/specification/quantum/data-plane/Microsoft.Quantum/preview/2021-05-06-preview/examples/jobDelete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "jobId": "a0f7adb6-0378-11eb-9463-2816a847b9a3", + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceName": "quantumworkspace1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/quantum/data-plane/Microsoft.Quantum/preview/2021-05-06-preview/examples/jobGet.json b/specification/quantum/data-plane/Microsoft.Quantum/preview/2021-05-06-preview/examples/jobGet.json new file mode 100644 index 000000000000..f2b936d8763e --- /dev/null +++ b/specification/quantum/data-plane/Microsoft.Quantum/preview/2021-05-06-preview/examples/jobGet.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "jobId": "a0f7adb6-0378-11eb-9463-2816a847b9a3", + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceName": "quantumworkspace1" + }, + "responses": { + "200": { + "body": { + "name": "tabu-demo", + "id": "a0f7adb6-0378-11eb-9463-2816a847b9a3", + "beginExecutionTime": "2020-09-30T23:57:11.5659691Z", + "cancellationTime": null, + "containerUri": "https://storage.blob.core.windows.net/job-a0f7adb6-0378-11eb-9463-2816a847b9a3?sv=2019-02-02&sr=c&sig=mhbf4fluypvLtgXwN5a7iWMygL6b9ojM4EnCC%2F8BZBg%3D&se=2020-10-01T11%3A57%3A01Z&sp=rcw", + "creationTime": "2020-09-30T23:57:02.3737928+00:00", + "endExecutionTime": "2020-09-30T23:57:11.6180743Z", + "errorData": null, + "inputDataFormat": "microsoft.qio.v2", + "inputDataUri": "https://storage.blob.core.windows.net/job-a0f7adb6-0378-11eb-9463-2816a847b9a3/inputData?sv=2019-02-02&sr=b&sig=MtgxZEmrCv%2FmeQWFUe6%2Bx9tViSrhxSxYr6euGGHtWnw%3D&se=2020-10-01T11%3A57%3A01Z&sp=rcw", + "inputParams": { + "params": { + "sweeps": 300 + } + }, + "metadata": null, + "outputDataFormat": "microsoft.qio-results.v2", + "outputDataUri": "https://storage.blob.core.windows.net/job-a0f7adb6-0378-11eb-9463-2816a847b9a3/rawOutputData?sv=2019-02-02&sr=c&sig=mhbf4fluypvLtgXwN5a7iWMygL6b9ojM4EnCC%2F8BZBg%3D&se=2020-10-01T11%3A57%3A01Z&sp=rcw", + "providerId": "microsoft", + "status": "Succeeded", + "target": "microsoft.tabu.cpu", + "tags": [ + "tag1", + "new" + ] + } + } + } +} diff --git a/specification/quantum/data-plane/Microsoft.Quantum/preview/2021-05-06-preview/examples/jobList.json b/specification/quantum/data-plane/Microsoft.Quantum/preview/2021-05-06-preview/examples/jobList.json new file mode 100644 index 000000000000..3d30d4e69b6e --- /dev/null +++ b/specification/quantum/data-plane/Microsoft.Quantum/preview/2021-05-06-preview/examples/jobList.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceName": "quantumworkspace1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "tabu-demo", + "id": "a0f7adb6-0378-11eb-9463-2816a847b9a3", + "beginExecutionTime": "2020-09-30T23:57:11.5659691Z", + "cancellationTime": null, + "containerUri": "https://storage.blob.core.windows.net/job-a0f7adb6-0378-11eb-9463-2816a847b9a3?sv=2019-02-02&sr=c&sig=mhbf4fluypvLtgXwN5a7iWMygL6b9ojM4EnCC%2F8BZBg%3D&se=2020-10-01T11%3A57%3A01Z&sp=rcw", + "creationTime": "2020-09-30T23:57:02.3737928+00:00", + "endExecutionTime": "2020-09-30T23:57:11.6180743Z", + "errorData": null, + "inputDataFormat": "microsoft.qio.v2", + "inputDataUri": "https://storage.blob.core.windows.net/job-a0f7adb6-0378-11eb-9463-2816a847b9a3/inputData?sv=2019-02-02&sr=b&sig=MtgxZEmrCv%2FmeQWFUe6%2Bx9tViSrhxSxYr6euGGHtWnw%3D&se=2020-10-01T11%3A57%3A01Z&sp=rcw", + "inputParams": { + "params": { + "sweeps": 300 + } + }, + "metadata": null, + "outputDataFormat": "microsoft.qio-results.v2", + "outputDataUri": "https://storage.blob.core.windows.net/job-a0f7adb6-0378-11eb-9463-2816a847b9a3/rawOutputData?sv=2019-02-02&sr=c&sig=mhbf4fluypvLtgXwN5a7iWMygL6b9ojM4EnCC%2F8BZBg%3D&se=2020-10-01T11%3A57%3A01Z&sp=rcw", + "providerId": "microsoft", + "status": "Succeeded", + "target": "microsoft.tabu.cpu", + "tags": [ + "tag1" + ] + }, + { + "id": "ab1aeddd-f191-4884-b8a9-13cdfa020fc6", + "name": "Superposition: true", + "beginExecutionTime": "2020-09-18T23:25:45.781389Z", + "cancellationTime": null, + "containerUri": "https://storage.blob.core.windows.net/quantum-job-ab1aeddd-f191-4884-b8a9-13cdfa020fc6?sv=2019-02-02&sr=c&sig=xhQtyt7Forj1HtpEkBTJTXAMTuuEvN0dTssv2OZlUNk%3D&se=2020-09-25T23%3A25%3A32Z&sp=rcw", + "creationTime": "2020-09-18T23:25:33.5541484+00:00", + "endExecutionTime": "2020-09-18T23:25:53.911837Z", + "errorData": null, + "inputDataFormat": "microsoft.qci-ir.v1", + "inputDataUri": "https://storage.blob.core.windows.net/quantum-job-ab1aeddd-f191-4884-b8a9-13cdfa020fc6/inputData?sv=2019-02-02&sr=b&sig=nDMUBPqNskFDLq591NGBE4nVnCiQhXYQBhSiU4xseVY%3D&se=2020-09-19T00%3A25%3A33Z&sp=rcw", + "inputParams": { + "shots": "10" + }, + "metadata": { + "entryPointInput": "true", + "outputMappingBlobUri": "https://storage.blob.core.windows.net/quantum-job-ab1aeddd-f191-4884-b8a9-13cdfa020fc6/mappingData?sv=2019-02-02&sr=b&sig=k6Gvd396GUtBxJasU9muSzkYXPQb8utASRSz932MFiw%3D&se=2020-09-19T00%3A25%3A33Z&sp=rcw" + }, + "outputDataFormat": "microsoft.quantum-results.v1", + "outputDataUri": "https://storage.blob.core.windows.net/quantum-job-ab1aeddd-f191-4884-b8a9-13cdfa020fc6/outputData?sv=2019-02-02&sr=c&sig=xhQtyt7Forj1HtpEkBTJTXAMTuuEvN0dTssv2OZlUNk%3D&se=2020-09-25T23%3A25%3A32Z&sp=rcw", + "providerId": "qci", + "status": "Succeeded", + "target": "qci.simulator", + "tags": [ + "tag2" + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/quantum/data-plane/Microsoft.Quantum/preview/2021-05-06-preview/examples/jobPatch.json b/specification/quantum/data-plane/Microsoft.Quantum/preview/2021-05-06-preview/examples/jobPatch.json new file mode 100644 index 000000000000..b474360410ca --- /dev/null +++ b/specification/quantum/data-plane/Microsoft.Quantum/preview/2021-05-06-preview/examples/jobPatch.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "jobId": "a0f7adb6-0378-11eb-9463-2816a847b9a3", + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceName": "quantumworkspace1", + "patchJob": [ + { + "op": "add", + "path": "/tags/-", + "value": "new_tag" + }, + { + "op": "remove", + "path": "/tags/0" + } + ] + }, + "responses": { + "200": { + "body": { + "name": "tabu-demo", + "id": "a0f7adb6-0378-11eb-9463-2816a847b9a3", + "beginExecutionTime": "2020-09-30T23:57:11.5659691Z", + "cancellationTime": null, + "containerUri": "https://storage.blob.core.windows.net/job-a0f7adb6-0378-11eb-9463-2816a847b9a3?sv=2019-02-02&sr=c&sig=mhbf4fluypvLtgXwN5a7iWMygL6b9ojM4EnCC%2F8BZBg%3D&se=2020-10-01T11%3A57%3A01Z&sp=rcw", + "creationTime": "2020-09-30T23:57:02.3737928+00:00", + "endExecutionTime": "2020-09-30T23:57:11.6180743Z", + "errorData": null, + "inputDataFormat": "microsoft.qio.v2", + "inputDataUri": "https://storage.blob.core.windows.net/job-a0f7adb6-0378-11eb-9463-2816a847b9a3/inputData?sv=2019-02-02&sr=b&sig=MtgxZEmrCv%2FmeQWFUe6%2Bx9tViSrhxSxYr6euGGHtWnw%3D&se=2020-10-01T11%3A57%3A01Z&sp=rcw", + "inputParams": { + "params": { + "sweeps": 300 + } + }, + "metadata": null, + "outputDataFormat": "microsoft.qio-results.v2", + "outputDataUri": "https://storage.blob.core.windows.net/job-a0f7adb6-0378-11eb-9463-2816a847b9a3/rawOutputData?sv=2019-02-02&sr=c&sig=mhbf4fluypvLtgXwN5a7iWMygL6b9ojM4EnCC%2F8BZBg%3D&se=2020-10-01T11%3A57%3A01Z&sp=rcw", + "providerId": "microsoft", + "status": "Succeeded", + "target": "microsoft.tabu.cpu", + "tags": [ + "tag2", + "new_tag" + ] + } + }, + "204": {} + } +} diff --git a/specification/quantum/data-plane/Microsoft.Quantum/preview/2021-05-06-preview/examples/jobPut.json b/specification/quantum/data-plane/Microsoft.Quantum/preview/2021-05-06-preview/examples/jobPut.json new file mode 100644 index 000000000000..b14fad3a2e7d --- /dev/null +++ b/specification/quantum/data-plane/Microsoft.Quantum/preview/2021-05-06-preview/examples/jobPut.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "jobId": "a0f7adb6-0378-11eb-9463-2816a847b9a3", + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceName": "quantumworkspace1", + "job": { + "name": "tabu-demo", + "id": "a0f7adb6-0378-11eb-9463-2816a847b9a3", + "containerUri": "https://storage.blob.core.windows.net/job-a0f7adb6-0378-11eb-9463-2816a847b9a3?sv=2019-02-02&sr=c&sig=mhbf4fluypvLtgXwN5a7iWMygL6b9ojM4EnCC%2F8BZBg%3D&se=2020-10-01T11%3A57%3A01Z&sp=rcw", + "inputDataFormat": "microsoft.qio.v2", + "inputDataUri": "https://storage.blob.core.windows.net/job-a0f7adb6-0378-11eb-9463-2816a847b9a3/inputData?sv=2019-02-02&sr=b&sig=MtgxZEmrCv%2FmeQWFUe6%2Bx9tViSrhxSxYr6euGGHtWnw%3D&se=2020-10-01T11%3A57%3A01Z&sp=rcw", + "inputParams": { + "params": { + "sweeps": 300 + } + }, + "outputDataFormat": "microsoft.qio-results.v2", + "outputDataUri": "https://storage.blob.core.windows.net/job-a0f7adb6-0378-11eb-9463-2816a847b9a3/rawOutputData?sv=2019-02-02&sr=c&sig=mhbf4fluypvLtgXwN5a7iWMygL6b9ojM4EnCC%2F8BZBg%3D&se=2020-10-01T11%3A57%3A01Z&sp=rcw", + "providerId": "microsoft", + "target": "microsoft.tabu.cpu", + "tags": [ + "tag1", + "tag_2" + ] + } + }, + "responses": { + "200": { + "body": { + "name": "tabu-demo", + "id": "a0f7adb6-0378-11eb-9463-2816a847b9a3", + "beginExecutionTime": "2020-09-30T23:57:11.5659691Z", + "cancellationTime": null, + "containerUri": "https://storage.blob.core.windows.net/job-a0f7adb6-0378-11eb-9463-2816a847b9a3?sv=2019-02-02&sr=c&sig=mhbf4fluypvLtgXwN5a7iWMygL6b9ojM4EnCC%2F8BZBg%3D&se=2020-10-01T11%3A57%3A01Z&sp=rcw", + "creationTime": "2020-09-30T23:57:02.3737928+00:00", + "endExecutionTime": "2020-09-30T23:57:11.6180743Z", + "errorData": null, + "inputDataFormat": "microsoft.qio.v2", + "inputDataUri": "https://storage.blob.core.windows.net/job-a0f7adb6-0378-11eb-9463-2816a847b9a3/inputData?sv=2019-02-02&sr=b&sig=MtgxZEmrCv%2FmeQWFUe6%2Bx9tViSrhxSxYr6euGGHtWnw%3D&se=2020-10-01T11%3A57%3A01Z&sp=rcw", + "inputParams": { + "params": { + "sweeps": 300 + } + }, + "metadata": null, + "outputDataFormat": "microsoft.qio-results.v2", + "outputDataUri": "https://storage.blob.core.windows.net/job-a0f7adb6-0378-11eb-9463-2816a847b9a3/rawOutputData?sv=2019-02-02&sr=c&sig=mhbf4fluypvLtgXwN5a7iWMygL6b9ojM4EnCC%2F8BZBg%3D&se=2020-10-01T11%3A57%3A01Z&sp=rcw", + "providerId": "microsoft", + "status": "Succeeded", + "target": "microsoft.tabu.cpu", + "tags": [ + "tag1", + "tag_2" + ] + } + }, + "201": { + "body": { + "name": "tabu-demo", + "id": "a0f7adb6-0378-11eb-9463-2816a847b9a3", + "beginExecutionTime": "2020-09-30T23:57:11.5659691Z", + "cancellationTime": null, + "containerUri": "https://storage.blob.core.windows.net/job-a0f7adb6-0378-11eb-9463-2816a847b9a3?sv=2019-02-02&sr=c&sig=mhbf4fluypvLtgXwN5a7iWMygL6b9ojM4EnCC%2F8BZBg%3D&se=2020-10-01T11%3A57%3A01Z&sp=rcw", + "creationTime": "2020-09-30T23:57:02.3737928+00:00", + "endExecutionTime": "2020-09-30T23:57:11.6180743Z", + "errorData": null, + "inputDataFormat": "microsoft.qio.v2", + "inputDataUri": "https://storage.blob.core.windows.net/job-a0f7adb6-0378-11eb-9463-2816a847b9a3/inputData?sv=2019-02-02&sr=b&sig=MtgxZEmrCv%2FmeQWFUe6%2Bx9tViSrhxSxYr6euGGHtWnw%3D&se=2020-10-01T11%3A57%3A01Z&sp=rcw", + "inputParams": { + "params": { + "sweeps": 300 + } + }, + "metadata": null, + "outputDataFormat": "microsoft.qio-results.v2", + "outputDataUri": "https://storage.blob.core.windows.net/job-a0f7adb6-0378-11eb-9463-2816a847b9a3/rawOutputData?sv=2019-02-02&sr=c&sig=mhbf4fluypvLtgXwN5a7iWMygL6b9ojM4EnCC%2F8BZBg%3D&se=2020-10-01T11%3A57%3A01Z&sp=rcw", + "providerId": "microsoft", + "status": "Succeeded", + "target": "microsoft.tabu.cpu", + "tags": [ + "tag1", + "tag_2" + ] + } + } + } +} diff --git a/specification/quantum/data-plane/Microsoft.Quantum/preview/2021-05-06-preview/examples/providerStatus.json b/specification/quantum/data-plane/Microsoft.Quantum/preview/2021-05-06-preview/examples/providerStatus.json new file mode 100644 index 000000000000..4369f518c3ec --- /dev/null +++ b/specification/quantum/data-plane/Microsoft.Quantum/preview/2021-05-06-preview/examples/providerStatus.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceName": "quantumworkspace1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "Microsoft", + "currentAvailability": "Available", + "targets": [ + { + "id": "microsoft.paralleltempering-parameterfree.cpu", + "currentAvailability": "Available", + "averageQueueTime": 0, + "statusPage": null + }, + { + "id": "microsoft.paralleltempering.cpu", + "currentAvailability": "Available", + "averageQueueTime": 0, + "statusPage": null + }, + { + "id": "microsoft.simulatedannealing-parameterfree.cpu", + "currentAvailability": "Available", + "averageQueueTime": 0, + "statusPage": null + }, + { + "id": "microsoft.simulatedannealing.cpu", + "currentAvailability": "Available", + "averageQueueTime": 0, + "statusPage": null + }, + { + "id": "microsoft.tabu-parameterfree.cpu", + "currentAvailability": "Available", + "averageQueueTime": 0, + "statusPage": null + }, + { + "id": "microsoft.tabu.cpu", + "currentAvailability": "Available", + "averageQueueTime": 0, + "statusPage": null + }, + { + "id": "microsoft.simulatedannealing-parameterfree.fpga", + "currentAvailability": "Available", + "averageQueueTime": 0, + "statusPage": null + }, + { + "id": "microsoft.simulatedannealing.fpga", + "currentAvailability": "Available", + "averageQueueTime": 0, + "statusPage": null + } + ] + }, + { + "id": "ionq", + "currentAvailability": "Available", + "targets": [ + { + "id": "ionq.qpu", + "currentAvailability": "Available", + "averageQueueTime": 1679, + "statusPage": "https://status.ionq.co" + }, + { + "id": "ionq.simulator", + "currentAvailability": "Available", + "averageQueueTime": 0, + "statusPage": "https://status.ionq.co" + } + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/quantum/data-plane/Microsoft.Quantum/preview/2021-05-06-preview/examples/quotaList.json b/specification/quantum/data-plane/Microsoft.Quantum/preview/2021-05-06-preview/examples/quotaList.json new file mode 100644 index 000000000000..4959efb267a5 --- /dev/null +++ b/specification/quantum/data-plane/Microsoft.Quantum/preview/2021-05-06-preview/examples/quotaList.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceName": "quantumworkspace1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "dimension": "free_combined_job_hours", + "scope": "Subscription", + "providerId": "Microsoft", + "utilization": 0.001756120333333333, + "holds": 0.016666666666666666, + "limit": 15.0, + "period": "Monthly" + }, + { + "dimension": "free_fpga_job_hours", + "scope": "Workspace", + "providerId": "Microsoft", + "utilization": 0.0, + "holds": 0.0, + "limit": 0.25, + "period": "Monthly" + }, + { + "dimension": "free_combined_job_hours", + "scope": "Workspace", + "providerId": "Microsoft", + "utilization": 0.0017561203333333335, + "holds": 0.0, + "limit": 1.0, + "period": "Monthly" + }, + { + "dimension": "concurrent_cpu_jobs", + "scope": "Workspace", + "providerId": "Microsoft", + "utilization": 0.0, + "holds": 0.0, + "limit": 10.0, + "period": "None" + }, + { + "dimension": "concurrent_fpga_jobs", + "scope": "Workspace", + "providerId": "Microsoft", + "utilization": 0.0, + "holds": 0.0, + "limit": 1.0, + "period": "None" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/quantum/data-plane/Microsoft.Quantum/preview/2021-05-06-preview/examples/storageGet.json b/specification/quantum/data-plane/Microsoft.Quantum/preview/2021-05-06-preview/examples/storageGet.json new file mode 100644 index 000000000000..d968ec0660e6 --- /dev/null +++ b/specification/quantum/data-plane/Microsoft.Quantum/preview/2021-05-06-preview/examples/storageGet.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "workspaceName": "quantumworkspace1", + "blobDetails": { + "containerName": "some_container", + "blobName": "input_blob" + } + }, + "responses": { + "200": { + "body": { + "sasUri": "https://storage.blob.core.windows.net/some_container/input_blob?sv=2019-02-02&sr=b&sig=cdO24OOoXterLJVM8T6QpSaog3ST4PjQsDj3mLflfJA%3D&se=2020-10-17T10%3A03%3A01Z&sp=rcw" + } + } + } +} diff --git a/specification/quantum/data-plane/Microsoft.Quantum/preview/2021-05-06-preview/quantum.json b/specification/quantum/data-plane/Microsoft.Quantum/preview/2021-05-06-preview/quantum.json new file mode 100644 index 000000000000..52a4daf87a35 --- /dev/null +++ b/specification/quantum/data-plane/Microsoft.Quantum/preview/2021-05-06-preview/quantum.json @@ -0,0 +1,761 @@ +{ + "swagger": "2.0", + "info": { + "title": "Quantum Client", + "description": "Azure Quantum REST API client", + "version": "2021-05-06-preview" + }, + "host": "quantum.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs": { + "get": { + "operationId": "Jobs_List", + "description": "List jobs.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/JobDetailsList" + } + } + }, + "x-ms-examples": { + "Get list of jobs in a Quantum Workspace": { + "$ref": "./examples/jobList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs/{jobId}": { + "get": { + "operationId": "Jobs_Get", + "description": "Get job by id", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + }, + { + "$ref": "#/parameters/jobIdParameter" + } + ], + "x-ms-examples": { + "Get a job's metadata": { + "$ref": "./examples/jobGet.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/RestError" + } + } + } + }, + "put": { + "operationId": "Jobs_Create", + "description": "Create a job.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + }, + { + "$ref": "#/parameters/jobIdParameter" + }, + { + "name": "job", + "description": "The complete metadata of the job to submit.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobDetails" + } + } + ], + "x-ms-examples": { + "Submit a new job for execution to a Quantum Workspace": { + "$ref": "./examples/jobPut.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobDetails" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/JobDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/RestError" + } + } + } + }, + "delete": { + "operationId": "Jobs_Cancel", + "description": "Cancel a job.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + }, + { + "$ref": "#/parameters/jobIdParameter" + } + ], + "x-ms-examples": { + "Cancel the execution of an existing job": { + "$ref": "./examples/jobDelete.json" + } + }, + "responses": { + "204": { + "description": "NoContent - The job was successfully cancelled." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/RestError" + } + } + } + }, + "patch": { + "operationId": "Jobs_Patch", + "description": "Patch a job.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + }, + { + "$ref": "#/parameters/jobIdParameter" + }, + { + "name": "patchJob", + "description": "The json patch document containing the patch operations.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PatchRequest" + } + } + ], + "x-ms-examples": { + "Patch an existing job to a Quantum Workspace": { + "$ref": "./examples/jobPatch.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobDetails" + } + }, + "204": { + "description": "No Content - the patch body was empty or had no operations." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/RestError" + } + } + } + } + }, + "/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/providerStatus": { + "get": { + "operationId": "Providers_GetStatus", + "description": "Get provider status.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + } + ], + "x-ms-examples": { + "Get list of of providers and their status for a Quantum Workspace": { + "$ref": "./examples/providerStatus.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ProviderStatusList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/RestError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/storage/sasUri": { + "post": { + "operationId": "Storage_SasUri", + "description": "Gets a URL with SAS token for a container/blob in the storage account associated with the workspace. The SAS URL can be used to upload job input and/or download job output.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + }, + { + "name": "blobDetails", + "description": "The details (name and container) of the blob to store or download data.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BlobDetails" + } + } + ], + "x-ms-examples": { + "Get a SAS token to upload data for a Quantum Workspace": { + "$ref": "./examples/storageGet.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SasUriResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/RestError" + } + } + } + } + }, + "/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/quotas": { + "get": { + "operationId": "Quotas_List", + "description": "List quotas for the given workspace.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + } + ], + "x-ms-examples": { + "Get a list of quotas for a particular quantum workspace.": { + "$ref": "./examples/quotaList.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/QuotaList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/RestError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "JobDetailsList": { + "description": "List of job details.", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/JobDetails" + } + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total records count number." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "JobDetails": { + "description": "Job details.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The job id." + }, + "name": { + "type": "string", + "description": "The job name. Is not required for the name to be unique and it's only used for display purposes." + }, + "containerUri": { + "type": "string", + "description": "The blob container SAS uri, the container is used to host job data." + }, + "inputDataUri": { + "type": "string", + "description": "The input blob SAS uri, if specified, it will override the default input blob in the container." + }, + "inputDataFormat": { + "type": "string", + "description": "The format of the input data." + }, + "inputParams": { + "type": "object", + "description": "The input parameters for the job. JSON object used by the target solver. It is expected that the size of this object is small and only used to specify parameters for the execution target, not the input data." + }, + "providerId": { + "type": "string", + "description": "The unique identifier for the provider." + }, + "target": { + "type": "string", + "description": "The target identifier to run the job." + }, + "metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The job metadata. Metadata provides client the ability to store client-specific information" + }, + "outputDataUri": { + "type": "string", + "description": "The output blob SAS uri. When a job finishes successfully, results will be uploaded to this blob." + }, + "outputDataFormat": { + "type": "string", + "description": "The format of the output data." + }, + "status": { + "type": "string", + "description": "The job status.", + "readOnly": true, + "enum": [ + "Waiting", + "Executing", + "Succeeded", + "Failed", + "Cancelled" + ], + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true + } + }, + "creationTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The creation time of the job." + }, + "beginExecutionTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The time when the job began execution." + }, + "endExecutionTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The time when the job finished execution." + }, + "cancellationTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The time when a job was successfully cancelled." + }, + "errorData": { + "$ref": "#/definitions/ErrorData", + "readOnly": true, + "description": "The error data for the job. This is expected only when Status 'Failed'." + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of user-supplied tags associated with the job." + } + }, + "required": [ + "containerUri", + "inputDataFormat", + "providerId", + "target" + ] + }, + "BlobDetails": { + "description": "Blob details.", + "type": "object", + "properties": { + "containerName": { + "type": "string", + "description": "The container name." + }, + "blobName": { + "type": "string", + "description": "The blob name." + } + }, + "required": [ + "containerName" + ] + }, + "SasUriResponse": { + "description": "Get SAS URL operation response.", + "type": "object", + "properties": { + "sasUri": { + "type": "string", + "description": "A URL with a SAS token to upload a blob for execution in the given workspace." + } + } + }, + "ProviderStatusList": { + "description": "Providers status.", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ProviderStatus" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ProviderStatus": { + "description": "Providers status.", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Provider id." + }, + "currentAvailability": { + "type": "string", + "readOnly": true, + "description": "Provider availability.", + "enum": [ + "Available", + "Degraded", + "Unavailable" + ], + "x-ms-enum": { + "name": "ProviderAvailability", + "modelAsString": true + } + }, + "targets": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/TargetStatus" + } + } + } + }, + "TargetStatus": { + "description": "Target status.", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Target id." + }, + "currentAvailability": { + "type": "string", + "readOnly": true, + "description": "Target availability.", + "enum": [ + "Available", + "Degraded", + "Unavailable" + ], + "x-ms-enum": { + "name": "TargetAvailability", + "modelAsString": true + } + }, + "averageQueueTime": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Average queue time in seconds." + }, + "statusPage": { + "type": "string", + "readOnly": true, + "description": "A page with detailed status of the provider." + } + } + }, + "QuotaList": { + "description": "List of quotas.", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Quota" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "Quota": { + "description": "Quota information.", + "type": "object", + "properties": { + "dimension": { + "type": "string", + "description": "The name of the dimension associated with the quota." + }, + "scope": { + "type": "string", + "description": "The scope at which the quota is applied.", + "enum": [ + "Workspace", + "Subscription" + ], + "x-ms-enum": { + "name": "DimensionScope", + "modelAsString": true + } + }, + "providerId": { + "type": "string", + "description": "The unique identifier for the provider." + }, + "utilization": { + "type": "number", + "description": "The amount of the usage that has been applied for the current period." + }, + "holds": { + "type": "number", + "description": "The amount of the usage that has been reserved but not applied for the current period." + }, + "limit": { + "type": "number", + "description": "The maximum amount of usage allowed for the current period." + }, + "period": { + "type": "string", + "description": "The time period in which the quota's underlying meter is accumulated. Based on calendar year. 'None' is used for concurrent quotas.", + "enum": [ + "None", + "Monthly" + ], + "x-ms-enum": { + "name": "MeterPeriod", + "modelAsString": true + } + } + } + }, + "RestError": { + "type": "object", + "description": "Error information returned by the API", + "properties": { + "error": { + "$ref": "#/definitions/ErrorData" + } + } + }, + "ErrorData": { + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for displaying in a user interface." + } + }, + "description": "An error response from Azure." + }, + "PatchRequest": { + "type": "array", + "items": { + "$ref": "#/definitions/JsonPatchDocument" + } + }, + "JsonPatchDocument": { + "description": "A JSONPatch document as defined by RFC 6902", + "required": [ + "op", + "path" + ], + "properties": { + "op": { + "type": "string", + "description": "The operation to be performed.", + "enum": [ + "add", + "remove", + "replace", + "move", + "copy", + "test" + ], + "x-ms-enum": { + "name": "JsonPatchOperation", + "modelAsString": true + } + }, + "path": { + "type": "string", + "description": "A JSON-Pointer." + }, + "value": { + "type": "object", + "description": "A value to be used in the operation on the path." + }, + "from": { + "type": "string", + "description": "Optional field used in copy and move operations." + } + } + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "description": "The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)", + "in": "path", + "required": true, + "x-ms-parameter-location": "client", + "type": "string" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "description": "Name of an Azure resource group." + }, + "workspaceNameParameter": { + "name": "workspaceName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "description": "Name of the workspace." + }, + "jobIdParameter": { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Id of the job." + } + } +} diff --git a/specification/quantum/data-plane/readme.md b/specification/quantum/data-plane/readme.md index 107be6e48189..66d02f482dae 100644 --- a/specification/quantum/data-plane/readme.md +++ b/specification/quantum/data-plane/readme.md @@ -38,6 +38,16 @@ input-file: - Microsoft.Quantum/preview/2019-11-04-preview/quantum.json ``` +### Tag: package-2021-05-06-preview + +These settings apply only when `--tag=package-2021-05-06-preview` is specified on the command line. + +```yaml $(tag) == 'package-2021-05-06-preview' +input-file: + - Microsoft.Quantum/preview/2021-05-06-preview/quantum.json +``` + + --- # Code Generation diff --git a/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/GetOperations.json b/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/GetOperations.json new file mode 100644 index 000000000000..514f00c4ca1e --- /dev/null +++ b/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/GetOperations.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2021-03-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Quota/quotaLimits/read", + "display": { + "provider": "Microsoft Quota", + "resource": "Resource service limit", + "operation": "Get resource service limit", + "description": "Get the current service limit or quota of the specified resource and location" + } + }, + { + "name": "Microsoft.Quota/quotaLimits/write", + "display": { + "provider": "Microsoft Quota", + "resource": "Resource service limit", + "operation": "Create resource service limit", + "description": "Create service limit or quota for the specified resource and location" + } + }, + { + "name": "Microsoft.Quota/quotaLimitProviders/read", + "display": { + "provider": "Microsoft Quota", + "resource": "Quota limits provider metadata", + "operation": "Get quota limit providers metadata", + "description": "Get quota limit resource providers metadata" + } + }, + { + "name": "Microsoft.Quota/quotaLimitsRequests/read", + "display": { + "provider": "Microsoft Quota", + "resource": "Resource service limit request", + "operation": "Get service limit request", + "description": "Get any service limit request for the specified resource and location" + } + } + ] + } + } + } +} diff --git a/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/getComputeOneSkuUsages.json b/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/getComputeOneSkuUsages.json new file mode 100644 index 000000000000..b43e5c6eac1c --- /dev/null +++ b/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/getComputeOneSkuUsages.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus", + "resourceName": "standardNDSFamily", + "api-version": "2021-03-15-preview" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardNDSFamily", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardNDSFamily", + "properties": { + "limit": 10, + "unit": "Count", + "name": { + "value": "standardNDSFamily", + "localizedValue": "Standard NDS Family vCPUs" + }, + "isQuotaApplicable": true + } + } + } + } +} diff --git a/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/getComputeUsages.json b/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/getComputeUsages.json new file mode 100644 index 000000000000..905d034e2952 --- /dev/null +++ b/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/getComputeUsages.json @@ -0,0 +1,195 @@ +{ + "parameters": { + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus", + "api-version": "2021-03-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardFSv2Family", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardFSv2Family", + "properties": { + "limit": 100, + "unit": "Count", + "currentValue": 0, + "isQuotaApplicable": true, + "name": { + "value": "standardFSv2Family", + "localizedValue": "Standard FSv2 Family vCPUs" + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardNDSFamily", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardNDSFamily", + "properties": { + "limit": 0, + "unit": "Count", + "currentValue": 0, + "isQuotaApplicable": true, + "name": { + "value": "standardNDSFamily", + "localizedValue": "Standard NDS Family vCPUs" + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardNCSv2Family", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardNCSv2Family", + "properties": { + "limit": 0, + "unit": "Count", + "currentValue": 0, + "isQuotaApplicable": true, + "name": { + "value": "standardNCSv2Family", + "localizedValue": "Standard NCSv2 Family vCPUs" + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardNCSv3Family", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardNCSv3Family", + "properties": { + "limit": 0, + "unit": "Count", + "currentValue": 0, + "isQuotaApplicable": true, + "name": { + "value": "standardNCSv3Family", + "localizedValue": "Standard NCSv3 Family vCPUs" + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardLSv2Family", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardLSv2Family", + "properties": { + "limit": 100, + "unit": "Count", + "currentValue": 0, + "isQuotaApplicable": true, + "name": { + "value": "standardLSv2Family", + "localizedValue": "Standard LSv2 Family vCPUs" + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardPBSFamily", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardPBSFamily", + "properties": { + "limit": 6, + "unit": "Count", + "currentValue": 0, + "isQuotaApplicable": true, + "name": { + "value": "standardPBSFamily", + "localizedValue": "Standard PBS Family vCPUs" + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardEIv3Family", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardEIv3Family", + "properties": { + "limit": 100, + "unit": "Count", + "currentValue": 0, + "isQuotaApplicable": true, + "name": { + "value": "standardEIv3Family", + "localizedValue": "Standard EIv3 Family vCPUs" + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardEISv3Family", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardEISv3Family", + "properties": { + "limit": 100, + "unit": "Count", + "currentValue": 0, + "isQuotaApplicable": true, + "name": { + "value": "standardEISv3Family", + "localizedValue": "Standard EISv3 Family vCPUs" + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardDCSFamily", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardDCSFamily", + "properties": { + "limit": 8, + "unit": "Count", + "currentValue": 0, + "isQuotaApplicable": true, + "name": { + "value": "standardDCSFamily", + "localizedValue": "Standard DCS Family vCPUs" + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardNVSv2Family", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardNVSv2Family", + "properties": { + "limit": 0, + "unit": "Count", + "currentValue": 0, + "isQuotaApplicable": true, + "name": { + "value": "standardNVSv2Family", + "localizedValue": "Standard NVSv2 Family vCPUs" + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardMSv2Family", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardMSv2Family", + "properties": { + "limit": 0, + "unit": "Count", + "currentValue": 0, + "isQuotaApplicable": true, + "name": { + "value": "standardMSv2Family", + "localizedValue": "Standard MSv2 Family vCPUs" + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/availabilitySets", + "type": "Microsoft.Quota/quotaLimits", + "name": "availabilitySets", + "properties": { + "limit": 0, + "unit": "Count", + "currentValue": 0, + "isQuotaApplicable": false, + "name": { + "value": "availabilitySets", + "localizedValue": "Availability Sets" + } + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/getMachineLearningServicesUsages.json b/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/getMachineLearningServicesUsages.json new file mode 100644 index 000000000000..b080dc729c8f --- /dev/null +++ b/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/getMachineLearningServicesUsages.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.MachineLearningServices/locations/eastus", + "api-version": "2021-03-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.MachineLearningServices/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardDv2Family", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardDv2Family", + "properties": { + "currentValue": 15, + "limit": 20, + "name": { + "value": "standardDv2Family", + "localizedValue": "Standard Dv2 Family vCPUs" + }, + "resourceType": "dedicated" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.MachineLearningServices/locations/eastus/providers/Microsoft.Quota/quotaLimits/totalLowPriorityCores", + "type": "Microsoft.Quota/quotaLimits", + "name": "totalLowPriorityCores", + "properties": { + "currentValue": 49, + "limit": 600, + "name": { + "value": "totalLowPriorityCores", + "localizedValue": "Total Regional Low-priority vCPUs" + }, + "resourceType": "lowPriority" + } + } + ] + } + } + } +} diff --git a/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/getQuotaRequestStatusById.json b/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/getQuotaRequestStatusById.json new file mode 100644 index 000000000000..2e632f45f217 --- /dev/null +++ b/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/getQuotaRequestStatusById.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "scope": "subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus", + "id": "2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "api-version": "2021-03-15-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/serviceLimitsRequests/2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "type": "Microsoft.Quota/serviceLimitsRequests", + "name": "2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "properties": { + "requestSubmitTime": "2019-08-19T19:23:17.904Z", + "message": "Request completed", + "provisioningState": "Succeeded", + "value": [ + { + "limit": 200, + "subRequestId": "AD07450A-DE86-4FD3-859B-107BEF218C4C", + "name": { + "value": "standardHCSFamily", + "localizedValue": "Standard HCS Family vCPUs" + }, + "message": "Request completed", + "provisioningState": "Succeeded" + }, + { + "limit": 50, + "name": { + "value": "standardNCPromoFamily", + "localizedValue": "Standard NC Promo Family vCPUs" + }, + "message": "Request completed", + "provisioningState": "Succeeded" + } + ] + } + } + } + } +} diff --git a/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/getQuotaRequestStatusFailed.json b/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/getQuotaRequestStatusFailed.json new file mode 100644 index 000000000000..84f1d6a02fc0 --- /dev/null +++ b/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/getQuotaRequestStatusFailed.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus", + "id": "2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "api-version": "2021-03-15-preview" + }, + "responses": { + "200": { + "body": { + "id": "2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "type": "Microsoft.Quota/serviceLimitsRequests", + "name": "2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "properties": { + "requestSubmitTime": "2019-08-19T19:23:17.904Z", + "message": "Request failed, please contact support.", + "provisioningState": "Failed", + "value": [ + { + "limit": 200, + "subRequestId": "AD07450A-DE86-4FD3-859B-107BEF218C4C", + "name": { + "value": "standardHCSFamily", + "localizedValue": "Standard HCS Family vCPUs" + }, + "message": "Request completed", + "provisioningState": "Succeeded" + }, + { + "limit": 50, + "subRequestId": "AD07450A-DE86-4FD3-859B-107BEF218C4C", + "name": { + "value": "standardNCPromoFamily", + "localizedValue": "Standard NC Promo Family vCPUs" + }, + "message": "RRequest failed, please contact support.", + "provisioningState": "Failed" + } + ] + } + } + } + } +} diff --git a/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/getQuotaRequestStatusInProgress.json b/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/getQuotaRequestStatusInProgress.json new file mode 100644 index 000000000000..f5aa8ae85698 --- /dev/null +++ b/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/getQuotaRequestStatusInProgress.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus", + "id": "2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "api-version": "2021-03-15-preview" + }, + "responses": { + "200": { + "body": { + "id": "2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "type": "Microsoft.Quota/serviceLimitsRequests", + "name": "2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "properties": { + "requestSubmitTime": "2019-08-19T19:23:17.904Z", + "message": "Request processing", + "provisioningState": "InProgress", + "value": [ + { + "limit": 200, + "subRequestId": "AD07450A-DE86-4FD3-859B-107BEF218C4C", + "name": { + "value": "standardHCSFamily", + "localizedValue": "Standard HCS Family vCPUs" + }, + "message": "Request completed", + "provisioningState": "Succeeded" + }, + { + "limit": 50, + "subRequestId": "AD07450A-DE86-4FD3-859B-107BEF218C4C", + "name": { + "value": "standardNCPromoFamily", + "localizedValue": "Standard NC Promo Family vCPUs" + }, + "message": "Request processing", + "provisioningState": "InProgress" + } + ] + } + } + } + } +} diff --git a/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/getQuotaRequestsHistory.json b/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/getQuotaRequestsHistory.json new file mode 100644 index 000000000000..23b2f766af56 --- /dev/null +++ b/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/getQuotaRequestsHistory.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "scope": "subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus", + "api-version": "2021-03-15-preview" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/microsoft.Quota/resourceProviders/Microsoft.Compute/locations/eastus/serviceLimitsRequests?api-version=2021-03-15&$top=3", + "value": [ + { + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/serviceLimitsRequests/2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "type": "Microsoft.Quota/serviceLimitsRequests", + "name": "2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "properties": { + "requestSubmitTime": "2019-08-19T19:23:17.904Z", + "message": "Request completed", + "provisioningState": "Success", + "value": [ + { + "limit": 200, + "subRequestId": "AD07450A-DE86-4FD3-859B-107BEF218C4C", + "name": { + "value": "standardHCSFamily", + "localizedValue": "Standard HCS Family vCPUs" + }, + "message": "Request completed", + "provisioningState": "Success" + }, + { + "limit": 50, + "subRequestId": "AD07450A-DE86-4FD3-859B-107BEF218C4C", + "name": { + "value": "standardNCPromoFamily", + "localizedValue": "Standard NC Promo Family vCPUs" + }, + "message": "Request completed", + "provisioningState": "Success" + } + ] + } + }, + { + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/serviceLimitsRequests/7E73A85C-83BB-4DE4-903F-076F1A2B91D6", + "type": "Microsoft.Quota/serviceLimitsRequests", + "name": "7E73A85C-83BB-4DE4-903F-076F1A2B91D6", + "properties": { + "requestSubmitTime": "2019-08-18T19:23:17.904Z", + "message": "Request completed", + "provisioningState": "Succeeded", + "value": [ + { + "limit": 100, + "subRequestId": "AD07450A-DE86-4FD3-859B-107BEF218C4C", + "name": { + "value": "standardNVSv3Family", + "localizedValue": "Standard NVSv3 Family vCPUs" + }, + "message": "Request completed", + "provisioningState": "Success" + }, + { + "limit": 150, + "subRequestId": "AD07450A-DE86-4FD3-859B-107BEF218C4C", + "name": { + "value": "standardNVPromoFamily", + "localizedValue": "Standard NV Promo Family vCPUs" + }, + "message": "Request completed", + "provisioningState": "Succeeded" + } + ] + } + }, + { + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/serviceLimitsRequests/5E460077-AB53-4802-8997-A6940E0B7649", + "type": "Microsoft.Quota/serviceLimitsRequests", + "name": "5E460077-AB53-4802-8997-A6940E0B7649", + "properties": { + "requestSubmitTime": "2019-08-17T19:23:17.904Z", + "message": "Request completed", + "provisioningState": "Succeeded", + "value": [ + { + "limit": 70, + "subRequestId": "AD07450A-DE86-4FD3-859B-107BEF218C4C", + "name": { + "value": "standardNCPromoFamily", + "localizedValue": "Standard NC Promo Family vCPUs" + }, + "message": "Request completed", + "provisioningState": "Succeeded" + }, + { + "limit": 52, + "subRequestId": "AD07450A-DE86-4FD3-859B-107BEF218C4C", + "name": { + "value": "standardHBSFamily", + "localizedValue": "Standard HBS Family vCPUs" + }, + "message": "Request completed", + "provisioningState": "Succeeded" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/metadata/getQuotaRPMetadata.json b/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/metadata/getQuotaRPMetadata.json new file mode 100644 index 000000000000..7468a0537840 --- /dev/null +++ b/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/metadata/getQuotaRPMetadata.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "api-version": "2021-03-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceProviderName": "Microsoft.Compute", + "properties": { + "value": [ + { + "resourceType": "virtualMachines", + "resourceQuery": { + "resourceQueryType": "", + "resourceQueryMethod": "", + "resourceQueryUri": "", + "resourceQueryPostTemplate": "" + }, + "resourceUsagesQuery": { + "resourceQueryType": "RestAPI", + "resourceQueryMethod": "GET", + "resourceQueryUri": "subscriptions/{{subscriptionId}}/providers/Microsoft.Compute/locations/{{location}}/usages?api-version=2020-12-01", + "resourceQueryPostTemplate": "" + }, + "dimensions": [ + { + "name": "subscriptionId", + "displayName": "SubscriptionId" + }, + { + "name": "location", + "displayName": "Location" + } + ] + } + ] + } + }, + { + "resourceProviderName": "Microsoft.Batch", + "properties": { + "value": [ + { + "resourceType": "batchAccounts/pool", + "resourceQuery": { + "resourceQueryType": "ARG", + "resourceQueryMethod": "POST", + "resourceQueryUri": "providers/Microsoft.ResourceGraph/resources?api-version=2019-04-01", + "resourceQueryPostTemplate": "{ \"subscriptions\": [ {{subscriptipnId}} ], \"query\": \"where type contains 'batchAccounts' and isnotempty(properties.batchAccountName)\" }" + }, + "resourceUsagesQuery": { + "resourceQueryType": "RestAPI", + "resourceQueryMethod": "GET", + "resourceQueryUri": "subscriptions/{{subscriptionId}}/providers/Microsoft.Batch/locations/{{location}}/batchAccounts/{{batchAccountName}}/usages?api-version=2020-12-01", + "resourceQueryPostTemplate": "" + }, + "dimensions": [ + { + "name": "subscriptionId", + "displayName": "SubscriptionId" + }, + { + "name": "location", + "displayName": "Location" + }, + { + "name": "batchAccounts", + "displayName": "BatchAccount Name" + } + ] + }, + { + "resourceType": "batchAccounts", + "resourceQuery": { + "resourceQueryType": "ARG", + "resourceQueryMethod": "POST", + "resourceQueryUri": "providers/Microsoft.ResourceGraph/resources?api-version=2019-04-01", + "resourceQueryPostTemplate": "{ \"subscriptions\": [ {{subscriptipnId}} ], \"query\": \"where type contains 'batchAccounts'\" }" + }, + "resourceUsagesQuery": { + "resourceQueryType": "RestAPI", + "resourceQueryMethod": "GET", + "resourceQueryUri": "subscriptions/{{subscriptionId}}/providers/Microsoft.Batch/locations/{{location}}/usages?api-version=2020-12-01", + "resourceQueryPostTemplate": "" + }, + "dimensions": [ + { + "name": "subscriptionId", + "displayName": "SubscriptionId" + }, + { + "name": "location", + "displayName": "Location" + } + ] + } + ] + } + }, + { + "resourceProviderName": "Microsoft.Network", + "properties": { + "value": [ + { + "resourceType": "PublicIpAddresses", + "resourceQuery": { + "resourceQueryType": "ARG", + "resourceQueryMethod": "POST", + "resourceQueryUri": "providers/Microsoft.ResourceGraph/resources?api-version=2019-04-01", + "resourceQueryPostTemplate": "{ \"subscriptions\": [ {{subscriptipnId}} ], \"query\": \"where type contains 'publicIPAddresses' and isnotempty(properties.ipAddress)\" }" + }, + "resourceUsagesQuery": { + "resourceQueryType": "RestAPI", + "resourceQueryMethod": "GET", + "resourceQueryUri": "subscriptions/{{subscriptionId}}/providers/Microsoft.Network/locations/{{location}}/usages?api-version=2020-12-01" + }, + "dimensions": [ + { + "name": "subscriptions", + "displayName": "Subscription" + }, + { + "name": "locations", + "displayName": "Location" + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/patchComputeQuotaRequest.json b/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/patchComputeQuotaRequest.json new file mode 100644 index 000000000000..74d800f2906b --- /dev/null +++ b/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/patchComputeQuotaRequest.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "scope": "subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus", + "resourceName": "standardFSv2Family", + "api-version": "2021-03-15-preview", + "createQuotaRequest": { + "properties": { + "limit": 200, + "name": { + "value": "standardFSv2Family" + } + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimitsRequests/2B5C8515-37D8-4B6A-879B-CD641A2CF605?api-version=2021-03-15-preview", + "Retry-After": "30", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/operationsStatus/2B5C8515-37D8-4B6A-879B-CD641A2CF605?api-version=2021-03-15-preview" + }, + "body": { + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardFSv2Family", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardFSv2Family", + "properties": { + "limit": 200, + "name": { + "value": "standardFSv2Family" + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardFSv2Family", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardFSv2Family", + "properties": { + "limit": 200, + "name": { + "value": "standardFSv2Family", + "localizedValue": "Standard FSv2 Family vCPUs" + } + } + } + } + } +} diff --git a/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/putComputeOneSkuQuotaRequest.json b/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/putComputeOneSkuQuotaRequest.json new file mode 100644 index 000000000000..e7686efd7de2 --- /dev/null +++ b/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/putComputeOneSkuQuotaRequest.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "scope": "subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus", + "resourceName": "standardFSv2Family", + "api-version": "2021-03-15-preview", + "createQuotaRequest": { + "properties": { + "limit": 200, + "name": { + "value": "standardFSv2Family" + } + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimitsRequests/2B5C8515-37D8-4B6A-879B-CD641A2CF605?api-version=2021-03-15-preview", + "Retry-After": "30", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/operationsStatus/2B5C8515-37D8-4B6A-879B-CD641A2CF605?api-version=2021-03-15-preview" + }, + "body": { + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardFSv2Family", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardFSv2Family", + "properties": { + "limit": 200, + "name": { + "value": "standardFSv2Family" + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardFSv2Family", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardFSv2Family", + "properties": { + "limit": 200, + "name": { + "value": "standardFSv2Family" + } + } + } + } + } +} diff --git a/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/putMachineLearningServicesQuotaRequestDedicated.json b/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/putMachineLearningServicesQuotaRequestDedicated.json new file mode 100644 index 000000000000..e7686efd7de2 --- /dev/null +++ b/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/putMachineLearningServicesQuotaRequestDedicated.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "scope": "subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus", + "resourceName": "standardFSv2Family", + "api-version": "2021-03-15-preview", + "createQuotaRequest": { + "properties": { + "limit": 200, + "name": { + "value": "standardFSv2Family" + } + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimitsRequests/2B5C8515-37D8-4B6A-879B-CD641A2CF605?api-version=2021-03-15-preview", + "Retry-After": "30", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/operationsStatus/2B5C8515-37D8-4B6A-879B-CD641A2CF605?api-version=2021-03-15-preview" + }, + "body": { + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardFSv2Family", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardFSv2Family", + "properties": { + "limit": 200, + "name": { + "value": "standardFSv2Family" + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardFSv2Family", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardFSv2Family", + "properties": { + "limit": 200, + "name": { + "value": "standardFSv2Family" + } + } + } + } + } +} diff --git a/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/putMachineLearningServicesQuotaRequestLowPriority.json b/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/putMachineLearningServicesQuotaRequestLowPriority.json new file mode 100644 index 000000000000..f263e23c189a --- /dev/null +++ b/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/examples/putMachineLearningServicesQuotaRequestLowPriority.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "scope": "subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.MachineLearningServices/locations/eastus", + "resourceName": "TotalLowPriorityCores", + "api-version": "2021-03-15-preview", + "createQuotaRequest": { + "properties": { + "limit": 200, + "name": { + "value": "TotalLowPriorityCores" + }, + "resourceType": "lowPriority" + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.MachineLearningServices/locations/eastus/providers/Microsoft.Quota/quotaLimits/TotalLowPriorityCores", + "type": "Microsoft.Quota/quotaLimits", + "name": "TotalLowPriorityCores", + "properties": { + "name": { + "value": "TotalLowPriorityCores" + }, + "resourceType": "lowPriority" + } + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimitsRequests/2B5C8515-37D8-4B6A-879B-CD641A2CF605?api-version=2021-03-15-preview", + "Retry-After": "30", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/operationsStatus/2B5C8515-37D8-4B6A-879B-CD641A2CF605?api-version=2021-03-15-preview" + }, + "body": { + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.MachineLearningServices/locations/eastus/providers/Microsoft.Quota/quotaLimits/TotalLowPriorityCores", + "type": "Microsoft.Quota/quotaLimits", + "name": "TotalLowPriorityCores", + "properties": { + "name": { + "value": "TotalLowPriorityCores" + }, + "resourceType": "lowPriority" + } + } + } + } +} diff --git a/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/quota.json b/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/quota.json new file mode 100644 index 000000000000..a0edfe706850 --- /dev/null +++ b/specification/quota/resource-manager/Microsoft.Quota/preview/2021-03-15-preview/quota.json @@ -0,0 +1,1278 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-03-15-preview", + "title": "Azure Quota Extension API", + "description": "Microsoft Azure Quota Resource Provider" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2", + "description": "Azure Active Directory OAuth 2.0 authorization" + } + }, + "paths": { + "/{scope}/providers/Microsoft.Quota/quotaLimits/{resourceName}": { + "get": { + "tags": [ + "QuotaInformation" + ], + "description": "Gets the quota limit and current quota usage of a resource. The response can be used to determine the remaining quota and calculate a new quota limit that can be submitted with a PUT request.", + "operationId": "Quota_Get", + "x-ms-examples": { + "Quotas_Request_ForCompute": { + "$ref": "./examples/getComputeOneSkuUsages.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceNameInParameters" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeInPath" + } + ], + "responses": { + "200": { + "description": "OK. The quota information will be returned in the response with pagination.", + "schema": { + "$ref": "#/definitions/CurrentQuotaLimitBase" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ExceptionResponse" + } + } + } + }, + "put": { + "tags": [ + "QuotaInformation" + ], + "description": "Create or update the quota limit for the specified resource to the requested value. To update the quota, follow these steps:\n1. Use the GET operation to determine how much quota remains for the specific resource and to calculate the new quota limit. These steps are detailed in [this example](https://techcommunity.microsoft.com/t5/azure-governance-and-management/using-the-new-quota-rest-api/ba-p/2183670).\n2. Use this PUT operation to update the quota limit.", + "operationId": "Quota_CreateOrUpdate", + "x-ms-examples": { + "Quotas_Request_ForCompute": { + "$ref": "./examples/putComputeOneSkuQuotaRequest.json" + }, + "Quotas_Request_ForMachineLearningServices_DedicatedResource": { + "$ref": "./examples/putMachineLearningServicesQuotaRequestDedicated.json" + }, + "Quotas_Request_ForMachineLearningServices_LowPriorityResource": { + "$ref": "./examples/putMachineLearningServicesQuotaRequestLowPriority.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceNameInParameters" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeInPath" + }, + { + "name": "createQuotaRequest", + "in": "body", + "description": "Quota requests payload.", + "required": true, + "schema": { + "$ref": "#/definitions/CurrentQuotaLimitBase" + } + } + ], + "responses": { + "200": { + "description": "OK. Returns the quota request details.", + "schema": { + "$ref": "#/definitions/CurrentQuotaLimitBase" + } + }, + "202": { + "description": "The request is accepted and is being processed. To check the status for this request, use the value for the quota request ID **id** obtained in the response of a [Quota Request Status](https://docs.microsoft.com/en-us/rest/api/reserved-vm-instances/quotarequeststatus/get) GET operation.", + "schema": { + "$ref": "#/definitions/CurrentQuotaLimitBase" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ExceptionResponse" + } + } + } + }, + "patch": { + "tags": [ + "QuotaInformation" + ], + "description": "Update the quota limit for a specific resource to the specified value:\n1. Use the GET operation to determine how much quota remains for the specific resource and to calculate the new quota limit. These steps are detailed in [this example](https://techcommunity.microsoft.com/t5/azure-governance-and-management/using-the-new-quota-rest-api/ba-p/2183670).\n2. Use this PUT operation to update the quota limit.", + "operationId": "Quota_Update", + "x-ms-examples": { + "Quotas_Request_PatchForCompute": { + "$ref": "./examples/patchComputeQuotaRequest.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceNameInParameters" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeInPath" + }, + { + "name": "createQuotaRequest", + "in": "body", + "description": "Quota requests payload.", + "required": true, + "schema": { + "$ref": "#/definitions/CurrentQuotaLimitBase" + } + } + ], + "responses": { + "200": { + "description": "OK. Returns the quota request details.", + "schema": { + "$ref": "#/definitions/CurrentQuotaLimitBase" + } + }, + "202": { + "description": "The request is accepted and is being processed. To check the status for this request, use the value for the quota request ID **id** in a [Quota Request Status](https://docs.microsoft.com/en-us/rest/api/reserved-vm-instances/quotarequeststatus/get) GET operation.", + "schema": { + "$ref": "#/definitions/CurrentQuotaLimitBase" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ExceptionResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.Quota/quotaLimits": { + "get": { + "tags": [ + "QuotaInformation" + ], + "description": "Get a list of current quota limits and usages of all resources. The response from this GET operation can be leveraged to submit requests to update a quota.", + "operationId": "Quota_List", + "x-ms-examples": { + "Quotas_listUsagesForCompute": { + "$ref": "./examples/getComputeUsages.json" + }, + "Quotas_listUsagesMachineLearningServices": { + "$ref": "./examples/getMachineLearningServicesUsages.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeInPath" + } + ], + "responses": { + "200": { + "description": "OK. Quota information will be returned in the response with pagination.", + "schema": { + "$ref": "#/definitions/QuotaLimits" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ExceptionResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{scope}/providers/Microsoft.Quota/quotaLimitsRequests/{id}": { + "get": { + "tags": [ + "QuotaRequests" + ], + "x-ms-examples": { + "QuotaRequestStatus": { + "$ref": "./examples/getQuotaRequestStatusById.json" + }, + "QuotaRequestInProgress": { + "$ref": "./examples/getQuotaRequestStatusInProgress.json" + }, + "QuotaRequestFailed": { + "$ref": "./examples/getQuotaRequestStatusFailed.json" + } + }, + "description": "Gets the quota request details and status by quota request ID for the resources of the resource provider at a specific location. The quota request ID **id** is returned in the response of the PUT operation.", + "operationId": "QuotaRequestStatus_Get", + "parameters": [ + { + "$ref": "#/parameters/RequestIdInParameters" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeInPath" + } + ], + "responses": { + "200": { + "description": "OK. Returning the status for the quota request.", + "schema": { + "$ref": "#/definitions/QuotaRequestDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ExceptionResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.Quota/quotaLimitsRequests": { + "get": { + "tags": [ + "QuotaRequests" + ], + "x-ms-examples": { + "QuotaRequestHistory": { + "$ref": "./examples/getQuotaRequestsHistory.json" + } + }, + "description": "For the specified location and resource provider, gets the current quota requests under the subscription for a one year period ending at the time is made. Use the **oData** filter can be used to select quota requests.", + "operationId": "QuotaRequestStatus_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeInPath" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators \n|---------------------|------------------------\n\r\n|requestSubmitTime | ge, le, eq, gt, lt\n |provisioningState eq {QuotaRequestState}\n |resourceName eq {resourceName}\n" + }, + { + "$ref": "#/parameters/TopQueryParameter" + }, + { + "$ref": "#/parameters/SkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "OK. Sending quota request status and details.", + "schema": { + "$ref": "#/definitions/QuotaRequestDetailsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ExceptionResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Quota/quotaLimitProviders": { + "get": { + "tags": [ + "QuotaMetadata" + ], + "description": "Gets the list of current resource providers supported by the Microsoft.Quota resource provider.\r\nFor each resource provider, the resource templates the resource provider supports are be provided. \r\nFor each resource template, the resource dimensions are listed. The resource dimensions are the name-value pairs in the resource URI.\r\nExample: Microsoft.Compute Resource Provider\r\nThe URI template is '/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{locationId}/quotaBucket'. The actual dimensions vary depending on the resource provider.\r\nThe resource dimensions are {subscriptions},{locations},{quotaBucket}.", + "operationId": "QuotaResourceProviders_List", + "x-ms-examples": { + "Quotas_listMetadataForRPs": { + "$ref": "./examples/metadata/getQuotaRPMetadata.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Quota limits type information.", + "schema": { + "$ref": "#/definitions/resourceProvidersList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ExceptionResponse" + } + } + } + } + }, + "/providers/Microsoft.Quota/operations": { + "get": { + "summary": "GET operations.", + "description": "List all GET operations.", + "operationId": "Operation_List", + "x-ms-examples": { + "GetOperations": { + "$ref": "./examples/GetOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "Operation" + ], + "responses": { + "200": { + "description": "List all GET operations.", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ExceptionResponse" + } + } + } + } + } + }, + "definitions": { + "OperationList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/OperationResponse" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next page of items." + } + } + }, + "OperationResponse": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplay" + }, + "origin": { + "type": "string" + } + } + }, + "OperationDisplay": { + "type": "object", + "properties": { + "provider": { + "type": "string", + "description": "Provider name." + }, + "resource": { + "type": "string", + "description": "Resource name." + }, + "operation": { + "type": "string", + "description": "Operation name." + }, + "description": { + "type": "string", + "description": "Operation description." + } + } + }, + "CommonResourceProperties": { + "type": "object", + "description": "Resource properties.", + "properties": { + "id": { + "description": "Resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource name.", + "type": "string", + "readOnly": true + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type. \"Microsoft.Quota/quotaLimits\"" + } + } + }, + "CurrentQuotaLimitBase": { + "type": "object", + "description": "Quota limit.", + "x-ms-azure-resource": true, + "properties": { + "id": { + "description": "The resource Id.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The resource type.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The resource name.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Quota properties for the specified resource.", + "$ref": "#/definitions/QuotaProperties" + } + } + }, + "QuotaProperties": { + "description": "Quota properties for the specified resource.", + "type": "object", + "properties": { + "limit": { + "description": "Quota limit.", + "type": "integer", + "format": "int32", + "readOnly": false + }, + "currentValue": { + "description": "Usage information for the current resource.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "unit": { + "description": " The quota limit units, such as Count and Bytes. When requesting quota, use the **unit** value returned in the GET response in the request body of your PUT operation.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource name provided by the resource provider. Use this property name when requesting quota.", + "$ref": "#/definitions/ResourceName" + }, + "resourceType": { + "description": "Resource type name.", + "$ref": "#/definitions/ResourceTypesName" + }, + "quotaPeriod": { + "description": "The time period over which the quota usage values are summarized. For example:\r\n*P1D (per one day)\n*PT1M (per one minute)\n*PT1S (per one second).\r\nThis parameter is optional because, for some resources like compute, the period is irrelevant.", + "type": "string", + "readOnly": true + }, + "isQuotaApplicable": { + "description": "States if quota can be requested for this resource.", + "type": "boolean", + "readOnly": true + }, + "properties": { + "description": "Additional properties for the specific resource provider.", + "type": "object" + } + } + }, + "ResourceName": { + "type": "object", + "description": "Name of the resource provided by the resource Provider. When requesting quota, use this property name.", + "properties": { + "value": { + "description": "Resource name.", + "type": "string", + "readOnly": false + }, + "localizedValue": { + "description": "Resource display name.", + "type": "string", + "readOnly": true + } + } + }, + "QuotaLimits": { + "type": "object", + "description": "Quota limits.", + "properties": { + "value": { + "description": "List of quota limits.", + "type": "array", + "items": { + "$ref": "#/definitions/CurrentQuotaLimitBase" + } + }, + "nextLink": { + "description": "The URI used to fetch the next page of quota limits. When there are no more pages, this is null.", + "type": "string" + } + } + }, + "QuotaLimitsResponse": { + "type": "object", + "description": "Quota limits request response.", + "properties": { + "value": { + "description": "List of quota limits with the quota request status.", + "type": "array", + "items": { + "$ref": "#/definitions/CurrentQuotaLimitBase" + } + }, + "nextLink": { + "description": "The URI used to fetch the next page of quota limits. When there are no more pages, this is null.", + "type": "string" + } + } + }, + "CreateGenericQuotaRequestParameters": { + "type": "object", + "description": "Quota change requests information.", + "properties": { + "value": { + "description": "Quota change requests.", + "type": "array", + "items": { + "$ref": "#/definitions/CurrentQuotaLimitBase" + } + } + } + }, + "SubRequest": { + "type": "object", + "description": "Request property.", + "properties": { + "limit": { + "description": "Resource quota limit.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "name": { + "description": "Resource name.", + "$ref": "#/definitions/ResourceName" + }, + "resourceType": { + "description": "Resource type for which the quota check was made.", + "type": "string", + "readOnly": true + }, + "unit": { + "description": " Quota limit units, such as Count and Bytes. When requesting quota, use the **unit** value returned in the GET response in the request body of your PUT operation.", + "type": "string" + }, + "provisioningState": { + "description": "The quota request status.", + "$ref": "#/definitions/QuotaRequestState" + }, + "message": { + "description": "User-friendly status message.", + "type": "string", + "readOnly": true + }, + "subRequestId": { + "description": "Quota request ID.", + "type": "string", + "readOnly": true + } + } + }, + "QuotaRequestOneResourceSubmitResponse": { + "description": "Quota request response.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "description": "Quota request ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the quota request.", + "type": "string", + "readOnly": true + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type. \"Microsoft.Quota/ServiceLimitRequests\"" + }, + "properties": { + "description": "Quota request details.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/quotaRequestOneResourceProperties" + } + } + }, + "QuotaRequestSubmitResponse": { + "description": "Quota request response.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "description": "Quota request ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Quota request name.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "The quota request details.", + "type": "object", + "$ref": "#/definitions/QuotaRequestProperties" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type. \"Microsoft.Quota/quotaLimits\"" + } + } + }, + "QuotaRequestSubmitResponse202": { + "description": "The quota request response with the quota request ID.", + "type": "object", + "properties": { + "id": { + "description": "The quota request ID. To check the request status, use the **id** value in a [Quota Request Status](https://docs.microsoft.com/en-us/rest/api/reserved-vm-instances/quotarequeststatus/get) GET operation.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Operation ID.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Quota request status.", + "$ref": "#/definitions/QuotaRequestStatusDetails", + "x-ms-client-flatten": true + } + } + }, + "QuotaRequestStatusDetails": { + "description": "Quota request status details.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Quota request status.", + "$ref": "#/definitions/QuotaRequestState", + "readOnly": true + }, + "message": { + "description": "User-friendly message.", + "type": "string", + "readOnly": true + }, + "limit": { + "description": "Quota limit.", + "type": "integer", + "format": "int32", + "readOnly": false + }, + "currentValue": { + "description": "Usage information for the current resource.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "unit": { + "description": " The quota limit units, such as Count and Bytes. When requesting quota, use the **unit** value returned in the GET response in the request body of your PUT operation.", + "type": "string", + "readOnly": false + }, + "name": { + "description": "Resource name provided by the resource provider. Use this property name when requesting quota.", + "$ref": "#/definitions/ResourceName" + }, + "resourceType": { + "description": "Resource type name.", + "$ref": "#/definitions/ResourceTypesName" + }, + "quotaPeriod": { + "description": "The time period over which the quota usage values are summarized. For example:\r\n*P1D (per one day)\n*PT1M (per one minute)\n*PT1S (per one second).\r\nThis parameter is optional because, for some resources like compute, the period is irrelevant.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Additional properties for the specific resource provider.", + "type": "object" + } + } + }, + "QuotaRequestDetails": { + "type": "object", + "description": "List of quota requests with details.", + "properties": { + "id": { + "description": "Quota request ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Quota request name.", + "type": "string", + "readOnly": true + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type. \"Microsoft.Quota/quotaLimits\"" + }, + "properties": { + "description": "Quota request details.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/QuotaRequestProperties" + } + } + }, + "QuotaRequestDetailsList": { + "description": "Quota request information.", + "type": "object", + "properties": { + "value": { + "description": "Quota request details.", + "type": "array", + "items": { + "$ref": "#/definitions/QuotaRequestDetails" + } + }, + "nextLink": { + "description": "The URI for fetching the next page of quota limits. When there are no more pages, this is null.", + "type": "string" + } + } + }, + "QuotaRequestProperties": { + "type": "object", + "description": "Quota request properties.", + "properties": { + "provisioningState": { + "description": "The quota request status.", + "$ref": "#/definitions/QuotaRequestState" + }, + "message": { + "description": "User-friendly status message.", + "type": "string", + "readOnly": true + }, + "requestSubmitTime": { + "description": "The quota request submission time. The date conforms to the following format specified by the ISO 8601 standard: yyyy-MM-ddTHH:mm:ssZ", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "value": { + "description": "Quota request details.", + "type": "array", + "items": { + "$ref": "#/definitions/SubRequest" + } + } + } + }, + "quotaRequestOneResourceProperties": { + "type": "object", + "description": "Quota request.", + "properties": { + "provisioningState": { + "description": "Quota request status.", + "readOnly": true, + "$ref": "#/definitions/QuotaRequestState" + }, + "message": { + "description": "User-friendly status message.", + "type": "string", + "readOnly": true + }, + "requestSubmitTime": { + "description": "Quota request submission time. The date conforms to the following ISO 8601 standard format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "limit": { + "description": "Quota limit.", + "type": "integer", + "format": "int32", + "readOnly": false + }, + "currentValue": { + "description": "Usage information for the current resource.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "unit": { + "description": " The quota limit units, such as Count and Bytes. When requesting quota, use the **unit** value returned in the GET response in the request body of your PUT operation.", + "type": "string", + "readOnly": false + }, + "name": { + "description": "Resource name provided by the resource provider. Use this property name when requesting quota.", + "$ref": "#/definitions/ResourceName" + }, + "resourceType": { + "description": "Resource type name.", + "$ref": "#/definitions/ResourceTypesName" + }, + "quotaPeriod": { + "description": "The time period over which the quota usage values are summarized. For example:\r\n*P1D (per one day)\n*PT1M (per one minute)\n*PT1S (per one second).\r\nThis parameter is optional because, for some resources like compute, the period is irrelevant.", + "type": "string", + "readOnly": true + }, + "isQuotaApplicable": { + "description": "States if quota can be requested for this resource.", + "type": "boolean", + "readOnly": true + }, + "properties": { + "description": "Additional properties for the specific resource provider.", + "type": "object" + } + } + }, + "QuotaRequestState": { + "description": "Quota request status.", + "enum": [ + "Accepted", + "Invalid", + "Succeeded", + "Failed", + "InProgress" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "name": "QuotaRequestState", + "modelAsString": true + } + }, + "ResourceTypesName": { + "description": "Resource types. For extensibility, it is a string.", + "enum": [ + "standard", + "dedicated", + "lowPriority", + "shared", + "serviceSpecific" + ], + "readOnly": false, + "type": "string", + "x-ms-enum": { + "name": "ResourceType", + "modelAsString": true + } + }, + "ExceptionResponse": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ServiceError", + "description": "API error details." + } + }, + "description": "Error." + }, + "quotaBucketProperties": { + "type": "object", + "description": "quotaBucket provider properties.", + "properties": { + "name": { + "type": "string", + "description": "Property name." + }, + "displayName": { + "description": "Display name.", + "type": "string" + } + } + }, + "ResourceProviderDimension": { + "type": "object", + "description": "Resource provider resource dimension.", + "properties": { + "name": { + "type": "string", + "description": "Resource dimension name." + }, + "displayName": { + "description": "Display name.", + "type": "string" + } + } + }, + "ResourceProviderTemplate": { + "type": "object", + "description": "Resource template details for the resource provider.", + "properties": { + "resourceType": { + "type": "string", + "description": "Resource type." + }, + "resourceQuery": { + "description": "Resource query for dimension values.", + "$ref": "#/definitions/resourceQueryDetails" + }, + "resourceUsagesQuery": { + "description": "Resource usages query.", + "$ref": "#/definitions/resourceQueryDetails" + }, + "dimensions": { + "description": "Resource provider dimensions.", + "type": "array", + "items": { + "$ref": "#/definitions/ResourceProviderDimension" + } + } + } + }, + "ResourceProviderTemplates": { + "type": "object", + "description": "List of resource provider templates", + "properties": { + "value": { + "description": "The resource provider templates", + "type": "array", + "items": { + "$ref": "#/definitions/ResourceProviderTemplate" + } + } + } + }, + "ResourceProviderInformation": { + "type": "object", + "description": "Resource provider information.", + "properties": { + "resourceProviderName": { + "type": "string", + "description": "Resource provider name." + }, + "properties": { + "description": "Resource provider quota dimensions.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ResourceProviderTemplates" + } + } + }, + "resourceProvidersList": { + "type": "object", + "description": "Resource providers list.", + "properties": { + "value": { + "description": "Resource provider information.", + "type": "array", + "items": { + "$ref": "#/definitions/ResourceProviderInformation" + } + } + } + }, + "QuotaTypeInformationDimensionList": { + "description": "Quota types information list.", + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "description": "Resource type" + }, + "value": { + "description": "Quota type information.", + "type": "array", + "items": { + "$ref": "#/definitions/QuotaTypeDimensionInformation" + } + } + } + }, + "QuotaTypeDimensionInformation": { + "type": "object", + "description": "Quota type information.", + "properties": { + "name": { + "type": "string", + "description": "Property name." + }, + "displayName": { + "type": "string", + "description": "Display name." + }, + "id": { + "type": "string", + "description": "Dimension ID." + } + } + }, + "QuotaTemplateDetails": { + "type": "object", + "description": "Quota template details.", + "properties": { + "resourceType": { + "type": "string", + "description": "Resource type." + }, + "properties": { + "description": "Quota type properties for the resource ID.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/QuotaTypeInformationDimensionList" + } + } + }, + "resourceQueryDetails": { + "type": "object", + "description": "Resource query details.", + "properties": { + "resourceQueryType": { + "description": "Resource query type.", + "$ref": "#/definitions/ResourceQueryType" + }, + "resourceQueryMethod": { + "description": "Resource query method.", + "$ref": "#/definitions/ResourceQueryMethod" + }, + "resourceQueryUri": { + "type": "string", + "description": "Base URI for for resource query." + }, + "resourceQueryPostTemplate": { + "description": "Template to create the resource query.", + "type": "string" + } + } + }, + "ResourceQueryType": { + "description": "Resource query types. For extensibility, it is a string.", + "enum": [ + "ARG", + "RestAPI" + ], + "readOnly": false, + "type": "string", + "x-ms-enum": { + "name": "ResourceQueryType", + "modelAsString": true + } + }, + "ResourceQueryMethod": { + "description": "The resource query method.", + "enum": [ + "GET", + "POST" + ], + "readOnly": false, + "type": "string", + "x-ms-enum": { + "name": "ResourceQueryMethod", + "modelAsString": true + } + }, + "QuotaTemplatesDetails": { + "type": "object", + "description": "Quota templates details.", + "properties": { + "value": { + "description": "Quota templates information.", + "type": "array", + "items": { + "$ref": "#/definitions/QuotaTemplateDetails" + } + } + } + }, + "ServiceError": { + "description": "API error details.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Error code." + }, + "message": { + "type": "string", + "description": "Error message." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceErrorDetail" + }, + "description": "List of error details.", + "readOnly": true + } + } + }, + "ServiceErrorDetail": { + "description": "Error details.", + "type": "object", + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "Error code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "Error message." + } + } + } + }, + "parameters": { + "SubscriptionIdInParameters": { + "name": "subscriptionId", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "description": "Azure subscription ID." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for this operation.", + "minLength": 1 + }, + "ResourceNameInParameters": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource name for a given resource provider. For example:\r\n- SKU name for Microsoft.Compute\r\n- Sku or TotalLowPriorityCores for Microsoft.MachineLearningServices", + "x-ms-parameter-location": "method" + }, + "ResourceDimensionTypeInParameter": { + "name": "resourceDimension", + "in": "path", + "required": true, + "type": "string", + "description": "Resource dimension type for a resource provider. For example:\r\n- locations and SKUs for Microsoft.Compute\r\n- resource groups, batch accounts, and SKUs for Microsoft.Batch", + "x-ms-parameter-location": "method" + }, + "RequestIdInParameters": { + "name": "id", + "in": "path", + "required": true, + "type": "string", + "description": "Quota request ID.", + "x-ms-parameter-location": "method" + }, + "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": { + "name": "$skiptoken", + "in": "query", + "type": "string", + "required": false, + "description": "The **Skiptoken** parameter is used only if a previous operation returned a partial result. If a previous response contains a **nextLink** element, the value of the **nextLink** element includes a **skiptoken** parameter that specifies a starting point to use for subsequent calls.", + "x-ms-parameter-location": "method" + }, + "ScopeInPath": { + "name": "scope", + "description": "The target Azure resource URI. For example, `/subscriptions/9f6cce51-6baf-4de5-a3c4-6f58b85315b9/resourceGroups/qms-test/providers/Microsoft.Batch/batchAccounts/testAccount/`. This is the target Azure resource URI for the List GET operation. If a `{resourceName}` is added after `/quotaLimits`, then it's the target Azure resource URI in the GET operation for the specific resource.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/GetOperations.json b/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/GetOperations.json new file mode 100644 index 000000000000..a0ee24dd7dc2 --- /dev/null +++ b/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/GetOperations.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2021-03-15" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Quota/quotaLimits/read", + "display": { + "provider": "Microsoft Quota", + "resource": "Resource service limit", + "operation": "Get resource service limit", + "description": "Get the current service limit or quota of the specified resource and location" + } + }, + { + "name": "Microsoft.Quota/quotaLimits/write", + "display": { + "provider": "Microsoft Quota", + "resource": "Resource service limit", + "operation": "Create resource service limit", + "description": "Create service limit or quota for the specified resource and location" + } + }, + { + "name": "Microsoft.Quota/quotaLimitProviders/read", + "display": { + "provider": "Microsoft Quota", + "resource": "Quota limits provider metadata", + "operation": "Get quota limit providers metadata", + "description": "Get quota limit resource providers metadata" + } + }, + { + "name": "Microsoft.Quota/quotaLimitsRequests/read", + "display": { + "provider": "Microsoft Quota", + "resource": "Resource service limit request", + "operation": "Get service limit request", + "description": "Get any service limit request for the specified resource and location" + } + } + ] + } + } + } +} diff --git a/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/getComputeOneSkuUsages.json b/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/getComputeOneSkuUsages.json new file mode 100644 index 000000000000..9efbd14bfdd2 --- /dev/null +++ b/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/getComputeOneSkuUsages.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus", + "resourceName": "standardNDSFamily", + "api-version": "2021-03-15" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardNDSFamily", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardNDSFamily", + "properties": { + "limit": 10, + "unit": "Count", + "name": { + "value": "standardNDSFamily", + "localizedValue": "Standard NDS Family vCPUs" + }, + "isQuotaApplicable": true + } + } + } + } +} diff --git a/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/getComputeUsages.json b/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/getComputeUsages.json new file mode 100644 index 000000000000..adf15b58a729 --- /dev/null +++ b/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/getComputeUsages.json @@ -0,0 +1,195 @@ +{ + "parameters": { + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus", + "api-version": "2021-03-15" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardFSv2Family", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardFSv2Family", + "properties": { + "limit": 100, + "unit": "Count", + "currentValue": 0, + "isQuotaApplicable": true, + "name": { + "value": "standardFSv2Family", + "localizedValue": "Standard FSv2 Family vCPUs" + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardNDSFamily", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardNDSFamily", + "properties": { + "limit": 0, + "unit": "Count", + "currentValue": 0, + "isQuotaApplicable": true, + "name": { + "value": "standardNDSFamily", + "localizedValue": "Standard NDS Family vCPUs" + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardNCSv2Family", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardNCSv2Family", + "properties": { + "limit": 0, + "unit": "Count", + "currentValue": 0, + "isQuotaApplicable": true, + "name": { + "value": "standardNCSv2Family", + "localizedValue": "Standard NCSv2 Family vCPUs" + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardNCSv3Family", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardNCSv3Family", + "properties": { + "limit": 0, + "unit": "Count", + "currentValue": 0, + "isQuotaApplicable": true, + "name": { + "value": "standardNCSv3Family", + "localizedValue": "Standard NCSv3 Family vCPUs" + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardLSv2Family", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardLSv2Family", + "properties": { + "limit": 100, + "unit": "Count", + "currentValue": 0, + "isQuotaApplicable": true, + "name": { + "value": "standardLSv2Family", + "localizedValue": "Standard LSv2 Family vCPUs" + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardPBSFamily", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardPBSFamily", + "properties": { + "limit": 6, + "unit": "Count", + "currentValue": 0, + "isQuotaApplicable": true, + "name": { + "value": "standardPBSFamily", + "localizedValue": "Standard PBS Family vCPUs" + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardEIv3Family", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardEIv3Family", + "properties": { + "limit": 100, + "unit": "Count", + "currentValue": 0, + "isQuotaApplicable": true, + "name": { + "value": "standardEIv3Family", + "localizedValue": "Standard EIv3 Family vCPUs" + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardEISv3Family", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardEISv3Family", + "properties": { + "limit": 100, + "unit": "Count", + "currentValue": 0, + "isQuotaApplicable": true, + "name": { + "value": "standardEISv3Family", + "localizedValue": "Standard EISv3 Family vCPUs" + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardDCSFamily", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardDCSFamily", + "properties": { + "limit": 8, + "unit": "Count", + "currentValue": 0, + "isQuotaApplicable": true, + "name": { + "value": "standardDCSFamily", + "localizedValue": "Standard DCS Family vCPUs" + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardNVSv2Family", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardNVSv2Family", + "properties": { + "limit": 0, + "unit": "Count", + "currentValue": 0, + "isQuotaApplicable": true, + "name": { + "value": "standardNVSv2Family", + "localizedValue": "Standard NVSv2 Family vCPUs" + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardMSv2Family", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardMSv2Family", + "properties": { + "limit": 0, + "unit": "Count", + "currentValue": 0, + "isQuotaApplicable": true, + "name": { + "value": "standardMSv2Family", + "localizedValue": "Standard MSv2 Family vCPUs" + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/availabilitySets", + "type": "Microsoft.Quota/quotaLimits", + "name": "availabilitySets", + "properties": { + "limit": 0, + "unit": "Count", + "currentValue": 0, + "isQuotaApplicable": false, + "name": { + "value": "availabilitySets", + "localizedValue": "Availability Sets" + } + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/getMachineLearningServicesUsages.json b/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/getMachineLearningServicesUsages.json new file mode 100644 index 000000000000..827ec295282a --- /dev/null +++ b/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/getMachineLearningServicesUsages.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.MachineLearningServices/locations/eastus", + "api-version": "2021-03-15" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.MachineLearningServices/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardDv2Family", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardDv2Family", + "properties": { + "currentValue": 15, + "limit": 20, + "name": { + "value": "standardDv2Family", + "localizedValue": "Standard Dv2 Family vCPUs" + }, + "resourceType": "dedicated" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.MachineLearningServices/locations/eastus/providers/Microsoft.Quota/quotaLimits/totalLowPriorityCores", + "type": "Microsoft.Quota/quotaLimits", + "name": "totalLowPriorityCores", + "properties": { + "currentValue": 49, + "limit": 600, + "name": { + "value": "totalLowPriorityCores", + "localizedValue": "Total Regional Low-priority vCPUs" + }, + "resourceType": "lowPriority" + } + } + ] + } + } + } +} diff --git a/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/getQuotaRequestStatusById.json b/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/getQuotaRequestStatusById.json new file mode 100644 index 000000000000..036cc2f22b1e --- /dev/null +++ b/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/getQuotaRequestStatusById.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "scope": "subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus", + "id": "2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "api-version": "2021-03-15" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/serviceLimitsRequests/2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "type": "Microsoft.Quota/serviceLimitsRequests", + "name": "2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "properties": { + "requestSubmitTime": "2019-08-19T19:23:17.904Z", + "message": "Request completed", + "provisioningState": "Succeeded", + "value": [ + { + "limit": 200, + "subRequestId": "AD07450A-DE86-4FD3-859B-107BEF218C4C", + "name": { + "value": "standardHCSFamily", + "localizedValue": "Standard HCS Family vCPUs" + }, + "message": "Request completed", + "provisioningState": "Succeeded" + }, + { + "limit": 50, + "name": { + "value": "standardNCPromoFamily", + "localizedValue": "Standard NC Promo Family vCPUs" + }, + "message": "Request completed", + "provisioningState": "Succeeded" + } + ] + } + } + } + } +} diff --git a/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/getQuotaRequestStatusFailed.json b/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/getQuotaRequestStatusFailed.json new file mode 100644 index 000000000000..93cda8f02d0e --- /dev/null +++ b/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/getQuotaRequestStatusFailed.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus", + "id": "2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "api-version": "2021-03-15" + }, + "responses": { + "200": { + "body": { + "id": "2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "type": "Microsoft.Quota/serviceLimitsRequests", + "name": "2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "properties": { + "requestSubmitTime": "2019-08-19T19:23:17.904Z", + "message": "Request failed, please contact support.", + "provisioningState": "Failed", + "value": [ + { + "limit": 200, + "subRequestId": "AD07450A-DE86-4FD3-859B-107BEF218C4C", + "name": { + "value": "standardHCSFamily", + "localizedValue": "Standard HCS Family vCPUs" + }, + "message": "Request completed", + "provisioningState": "Succeeded" + }, + { + "limit": 50, + "subRequestId": "AD07450A-DE86-4FD3-859B-107BEF218C4C", + "name": { + "value": "standardNCPromoFamily", + "localizedValue": "Standard NC Promo Family vCPUs" + }, + "message": "RRequest failed, please contact support.", + "provisioningState": "Failed" + } + ] + } + } + } + } +} diff --git a/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/getQuotaRequestStatusInProgress.json b/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/getQuotaRequestStatusInProgress.json new file mode 100644 index 000000000000..6feb49fab18e --- /dev/null +++ b/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/getQuotaRequestStatusInProgress.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus", + "id": "2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "api-version": "2021-03-15" + }, + "responses": { + "200": { + "body": { + "id": "2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "type": "Microsoft.Quota/serviceLimitsRequests", + "name": "2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "properties": { + "requestSubmitTime": "2019-08-19T19:23:17.904Z", + "message": "Request processing", + "provisioningState": "InProgress", + "value": [ + { + "limit": 200, + "subRequestId": "AD07450A-DE86-4FD3-859B-107BEF218C4C", + "name": { + "value": "standardHCSFamily", + "localizedValue": "Standard HCS Family vCPUs" + }, + "message": "Request completed", + "provisioningState": "Succeeded" + }, + { + "limit": 50, + "subRequestId": "AD07450A-DE86-4FD3-859B-107BEF218C4C", + "name": { + "value": "standardNCPromoFamily", + "localizedValue": "Standard NC Promo Family vCPUs" + }, + "message": "Request processing", + "provisioningState": "InProgress" + } + ] + } + } + } + } +} diff --git a/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/getQuotaRequestsHistory.json b/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/getQuotaRequestsHistory.json new file mode 100644 index 000000000000..340983dfdd0b --- /dev/null +++ b/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/getQuotaRequestsHistory.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "scope": "subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus", + "api-version": "2021-03-15" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/microsoft.Quota/resourceProviders/Microsoft.Compute/locations/eastus/serviceLimitsRequests?api-version=2021-03-15&$top=3", + "value": [ + { + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/serviceLimitsRequests/2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "type": "Microsoft.Quota/serviceLimitsRequests", + "name": "2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "properties": { + "requestSubmitTime": "2019-08-19T19:23:17.904Z", + "message": "Request completed", + "provisioningState": "Success", + "value": [ + { + "limit": 200, + "subRequestId": "AD07450A-DE86-4FD3-859B-107BEF218C4C", + "name": { + "value": "standardHCSFamily", + "localizedValue": "Standard HCS Family vCPUs" + }, + "message": "Request completed", + "provisioningState": "Success" + }, + { + "limit": 50, + "subRequestId": "AD07450A-DE86-4FD3-859B-107BEF218C4C", + "name": { + "value": "standardNCPromoFamily", + "localizedValue": "Standard NC Promo Family vCPUs" + }, + "message": "Request completed", + "provisioningState": "Success" + } + ] + } + }, + { + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/serviceLimitsRequests/7E73A85C-83BB-4DE4-903F-076F1A2B91D6", + "type": "Microsoft.Quota/serviceLimitsRequests", + "name": "7E73A85C-83BB-4DE4-903F-076F1A2B91D6", + "properties": { + "requestSubmitTime": "2019-08-18T19:23:17.904Z", + "message": "Request completed", + "provisioningState": "Succeeded", + "value": [ + { + "limit": 100, + "subRequestId": "AD07450A-DE86-4FD3-859B-107BEF218C4C", + "name": { + "value": "standardNVSv3Family", + "localizedValue": "Standard NVSv3 Family vCPUs" + }, + "message": "Request completed", + "provisioningState": "Success" + }, + { + "limit": 150, + "subRequestId": "AD07450A-DE86-4FD3-859B-107BEF218C4C", + "name": { + "value": "standardNVPromoFamily", + "localizedValue": "Standard NV Promo Family vCPUs" + }, + "message": "Request completed", + "provisioningState": "Succeeded" + } + ] + } + }, + { + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/serviceLimitsRequests/5E460077-AB53-4802-8997-A6940E0B7649", + "type": "Microsoft.Quota/serviceLimitsRequests", + "name": "5E460077-AB53-4802-8997-A6940E0B7649", + "properties": { + "requestSubmitTime": "2019-08-17T19:23:17.904Z", + "message": "Request completed", + "provisioningState": "Succeeded", + "value": [ + { + "limit": 70, + "subRequestId": "AD07450A-DE86-4FD3-859B-107BEF218C4C", + "name": { + "value": "standardNCPromoFamily", + "localizedValue": "Standard NC Promo Family vCPUs" + }, + "message": "Request completed", + "provisioningState": "Succeeded" + }, + { + "limit": 52, + "subRequestId": "AD07450A-DE86-4FD3-859B-107BEF218C4C", + "name": { + "value": "standardHBSFamily", + "localizedValue": "Standard HBS Family vCPUs" + }, + "message": "Request completed", + "provisioningState": "Succeeded" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/metadata/getQuotaRPMetadata.json b/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/metadata/getQuotaRPMetadata.json new file mode 100644 index 000000000000..dbe102fdf738 --- /dev/null +++ b/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/metadata/getQuotaRPMetadata.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "api-version": "2021-03-15" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceProviderName": "Microsoft.Compute", + "properties": { + "value": [ + { + "resourceType": "virtualMachines", + "resourceQuery": { + "resourceQueryType": "", + "resourceQueryMethod": "", + "resourceQueryUri": "", + "resourceQueryPostTemplate": "" + }, + "resourceUsagesQuery": { + "resourceQueryType": "RestAPI", + "resourceQueryMethod": "GET", + "resourceQueryUri": "subscriptions/{{subscriptionId}}/providers/Microsoft.Compute/locations/{{location}}/usages?api-version=2020-12-01", + "resourceQueryPostTemplate": "" + }, + "dimensions": [ + { + "name": "subscriptionId", + "displayName": "SubscriptionId" + }, + { + "name": "location", + "displayName": "Location" + } + ] + } + ] + } + }, + { + "resourceProviderName": "Microsoft.Batch", + "properties": { + "value": [ + { + "resourceType": "batchAccounts/pool", + "resourceQuery": { + "resourceQueryType": "ARG", + "resourceQueryMethod": "POST", + "resourceQueryUri": "providers/Microsoft.ResourceGraph/resources?api-version=2019-04-01", + "resourceQueryPostTemplate": "{ \"subscriptions\": [ {{subscriptipnId}} ], \"query\": \"where type contains 'batchAccounts' and isnotempty(properties.batchAccountName)\" }" + }, + "resourceUsagesQuery": { + "resourceQueryType": "RestAPI", + "resourceQueryMethod": "GET", + "resourceQueryUri": "subscriptions/{{subscriptionId}}/providers/Microsoft.Batch/locations/{{location}}/batchAccounts/{{batchAccountName}}/usages?api-version=2020-12-01", + "resourceQueryPostTemplate": "" + }, + "dimensions": [ + { + "name": "subscriptionId", + "displayName": "SubscriptionId" + }, + { + "name": "location", + "displayName": "Location" + }, + { + "name": "batchAccounts", + "displayName": "BatchAccount Name" + } + ] + }, + { + "resourceType": "batchAccounts", + "resourceQuery": { + "resourceQueryType": "ARG", + "resourceQueryMethod": "POST", + "resourceQueryUri": "providers/Microsoft.ResourceGraph/resources?api-version=2019-04-01", + "resourceQueryPostTemplate": "{ \"subscriptions\": [ {{subscriptipnId}} ], \"query\": \"where type contains 'batchAccounts'\" }" + }, + "resourceUsagesQuery": { + "resourceQueryType": "RestAPI", + "resourceQueryMethod": "GET", + "resourceQueryUri": "subscriptions/{{subscriptionId}}/providers/Microsoft.Batch/locations/{{location}}/usages?api-version=2020-12-01", + "resourceQueryPostTemplate": "" + }, + "dimensions": [ + { + "name": "subscriptionId", + "displayName": "SubscriptionId" + }, + { + "name": "location", + "displayName": "Location" + } + ] + } + ] + } + }, + { + "resourceProviderName": "Microsoft.Network", + "properties": { + "value": [ + { + "resourceType": "PublicIpAddresses", + "resourceQuery": { + "resourceQueryType": "ARG", + "resourceQueryMethod": "POST", + "resourceQueryUri": "providers/Microsoft.ResourceGraph/resources?api-version=2019-04-01", + "resourceQueryPostTemplate": "{ \"subscriptions\": [ {{subscriptipnId}} ], \"query\": \"where type contains 'publicIPAddresses' and isnotempty(properties.ipAddress)\" }" + }, + "resourceUsagesQuery": { + "resourceQueryType": "RestAPI", + "resourceQueryMethod": "GET", + "resourceQueryUri": "subscriptions/{{subscriptionId}}/providers/Microsoft.Network/locations/{{location}}/usages?api-version=2020-12-01" + }, + "dimensions": [ + { + "name": "subscriptions", + "displayName": "Subscription" + }, + { + "name": "locations", + "displayName": "Location" + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/patchComputeQuotaRequest.json b/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/patchComputeQuotaRequest.json new file mode 100644 index 000000000000..eb1bbeeab119 --- /dev/null +++ b/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/patchComputeQuotaRequest.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "scope": "subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus", + "resourceName": "standardFSv2Family", + "api-version": "2021-03-15", + "createQuotaRequest": { + "properties": { + "limit": 200, + "name": { + "value": "standardFSv2Family" + } + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimitsRequests/2B5C8515-37D8-4B6A-879B-CD641A2CF605?api-version=2021-03-15", + "Retry-After": "30", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/operationsStatus/2B5C8515-37D8-4B6A-879B-CD641A2CF605?api-version=2021-03-15" + }, + "body": { + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardFSv2Family", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardFSv2Family", + "properties": { + "limit": 200, + "name": { + "value": "standardFSv2Family" + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardFSv2Family", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardFSv2Family", + "properties": { + "limit": 200, + "name": { + "value": "standardFSv2Family", + "localizedValue": "Standard FSv2 Family vCPUs" + } + } + } + } + } +} diff --git a/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/putComputeOneSkuQuotaRequest.json b/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/putComputeOneSkuQuotaRequest.json new file mode 100644 index 000000000000..03242d60c745 --- /dev/null +++ b/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/putComputeOneSkuQuotaRequest.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "scope": "subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus", + "resourceName": "standardFSv2Family", + "api-version": "2021-03-15", + "createQuotaRequest": { + "properties": { + "limit": 200, + "name": { + "value": "standardFSv2Family" + } + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimitsRequests/2B5C8515-37D8-4B6A-879B-CD641A2CF605?api-version=2021-03-15", + "Retry-After": "30", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/operationsStatus/2B5C8515-37D8-4B6A-879B-CD641A2CF605?api-version=2021-03-15" + }, + "body": { + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardFSv2Family", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardFSv2Family", + "properties": { + "limit": 200, + "name": { + "value": "standardFSv2Family" + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardFSv2Family", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardFSv2Family", + "properties": { + "limit": 200, + "name": { + "value": "standardFSv2Family" + } + } + } + } + } +} diff --git a/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/putMachineLearningServicesQuotaRequestDedicated.json b/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/putMachineLearningServicesQuotaRequestDedicated.json new file mode 100644 index 000000000000..03242d60c745 --- /dev/null +++ b/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/putMachineLearningServicesQuotaRequestDedicated.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "scope": "subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus", + "resourceName": "standardFSv2Family", + "api-version": "2021-03-15", + "createQuotaRequest": { + "properties": { + "limit": 200, + "name": { + "value": "standardFSv2Family" + } + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimitsRequests/2B5C8515-37D8-4B6A-879B-CD641A2CF605?api-version=2021-03-15", + "Retry-After": "30", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/operationsStatus/2B5C8515-37D8-4B6A-879B-CD641A2CF605?api-version=2021-03-15" + }, + "body": { + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardFSv2Family", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardFSv2Family", + "properties": { + "limit": 200, + "name": { + "value": "standardFSv2Family" + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimits/standardFSv2Family", + "type": "Microsoft.Quota/quotaLimits", + "name": "standardFSv2Family", + "properties": { + "limit": 200, + "name": { + "value": "standardFSv2Family" + } + } + } + } + } +} diff --git a/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/putMachineLearningServicesQuotaRequestLowPriority.json b/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/putMachineLearningServicesQuotaRequestLowPriority.json new file mode 100644 index 000000000000..ec36e6e591c4 --- /dev/null +++ b/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/examples/putMachineLearningServicesQuotaRequestLowPriority.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "scope": "subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.MachineLearningServices/locations/eastus", + "resourceName": "TotalLowPriorityCores", + "api-version": "2021-03-15", + "createQuotaRequest": { + "properties": { + "limit": 200, + "name": { + "value": "TotalLowPriorityCores" + }, + "resourceType": "lowPriority" + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.MachineLearningServices/locations/eastus/providers/Microsoft.Quota/quotaLimits/TotalLowPriorityCores", + "type": "Microsoft.Quota/quotaLimits", + "name": "TotalLowPriorityCores", + "properties": { + "name": { + "value": "TotalLowPriorityCores" + }, + "resourceType": "lowPriority" + } + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/quotaLimitsRequests/2B5C8515-37D8-4B6A-879B-CD641A2CF605?api-version=2021-03-15", + "Retry-After": "30", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.Quota/operationsStatus/2B5C8515-37D8-4B6A-879B-CD641A2CF605?api-version=2021-03-15" + }, + "body": { + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.MachineLearningServices/locations/eastus/providers/Microsoft.Quota/quotaLimits/TotalLowPriorityCores", + "type": "Microsoft.Quota/quotaLimits", + "name": "TotalLowPriorityCores", + "properties": { + "name": { + "value": "TotalLowPriorityCores" + }, + "resourceType": "lowPriority" + } + } + } + } +} diff --git a/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/quota.json b/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/quota.json new file mode 100644 index 000000000000..d276a378ae11 --- /dev/null +++ b/specification/quota/resource-manager/Microsoft.Quota/stable/2021-03-15/quota.json @@ -0,0 +1,1278 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-03-15", + "title": "Azure Quota Extension API", + "description": "Microsoft Azure Quota Resource Provider" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2", + "description": "Azure Active Directory OAuth 2.0 authorization" + } + }, + "paths": { + "/{scope}/providers/Microsoft.Quota/quotaLimits/{resourceName}": { + "get": { + "tags": [ + "QuotaInformation" + ], + "description": "Gets the quota limit and current quota usage of a resource. The response can be used to determine the remaining quota and calculate a new quota limit that can be submitted with a PUT request.", + "operationId": "Quota_Get", + "x-ms-examples": { + "Quotas_Request_ForCompute": { + "$ref": "./examples/getComputeOneSkuUsages.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceNameInParameters" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeInPath" + } + ], + "responses": { + "200": { + "description": "OK. The quota information will be returned in the response with pagination.", + "schema": { + "$ref": "#/definitions/CurrentQuotaLimitBase" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ExceptionResponse" + } + } + } + }, + "put": { + "tags": [ + "QuotaInformation" + ], + "description": "Create or update the quota limit for the specified resource to the requested value. To update the quota, follow these steps:\n1. Use the GET operation to determine how much quota remains for the specific resource and to calculate the new quota limit. These steps are detailed in [this example](https://techcommunity.microsoft.com/t5/azure-governance-and-management/using-the-new-quota-rest-api/ba-p/2183670).\n2. Use this PUT operation to update the quota limit.", + "operationId": "Quota_CreateOrUpdate", + "x-ms-examples": { + "Quotas_Request_ForCompute": { + "$ref": "./examples/putComputeOneSkuQuotaRequest.json" + }, + "Quotas_Request_ForMachineLearningServices_DedicatedResource": { + "$ref": "./examples/putMachineLearningServicesQuotaRequestDedicated.json" + }, + "Quotas_Request_ForMachineLearningServices_LowPriorityResource": { + "$ref": "./examples/putMachineLearningServicesQuotaRequestLowPriority.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceNameInParameters" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeInPath" + }, + { + "name": "createQuotaRequest", + "in": "body", + "description": "Quota requests payload.", + "required": true, + "schema": { + "$ref": "#/definitions/CurrentQuotaLimitBase" + } + } + ], + "responses": { + "200": { + "description": "OK. Returns the quota request details.", + "schema": { + "$ref": "#/definitions/CurrentQuotaLimitBase" + } + }, + "202": { + "description": "The request is accepted and is being processed. To check the status for this request, use the value for the quota request ID **id** obtained in the response of a [Quota Request Status](https://docs.microsoft.com/en-us/rest/api/reserved-vm-instances/quotarequeststatus/get) GET operation.", + "schema": { + "$ref": "#/definitions/CurrentQuotaLimitBase" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ExceptionResponse" + } + } + } + }, + "patch": { + "tags": [ + "QuotaInformation" + ], + "description": "Update the quota limit for a specific resource to the specified value:\n1. Use the GET operation to determine how much quota remains for the specific resource and to calculate the new quota limit. These steps are detailed in [this example](https://techcommunity.microsoft.com/t5/azure-governance-and-management/using-the-new-quota-rest-api/ba-p/2183670).\n2. Use this PUT operation to update the quota limit.", + "operationId": "Quota_Update", + "x-ms-examples": { + "Quotas_Request_PatchForCompute": { + "$ref": "./examples/patchComputeQuotaRequest.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceNameInParameters" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeInPath" + }, + { + "name": "createQuotaRequest", + "in": "body", + "description": "Quota requests payload.", + "required": true, + "schema": { + "$ref": "#/definitions/CurrentQuotaLimitBase" + } + } + ], + "responses": { + "200": { + "description": "OK. Returns the quota request details.", + "schema": { + "$ref": "#/definitions/CurrentQuotaLimitBase" + } + }, + "202": { + "description": "The request is accepted and is being processed. To check the status for this request, use the value for the quota request ID **id** in a [Quota Request Status](https://docs.microsoft.com/en-us/rest/api/reserved-vm-instances/quotarequeststatus/get) GET operation.", + "schema": { + "$ref": "#/definitions/CurrentQuotaLimitBase" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ExceptionResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.Quota/quotaLimits": { + "get": { + "tags": [ + "QuotaInformation" + ], + "description": "Get a list of current quota limits and usages of all resources. The response from this GET operation can be leveraged to submit requests to update a quota.", + "operationId": "Quota_List", + "x-ms-examples": { + "Quotas_listUsagesForCompute": { + "$ref": "./examples/getComputeUsages.json" + }, + "Quotas_listUsagesMachineLearningServices": { + "$ref": "./examples/getMachineLearningServicesUsages.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeInPath" + } + ], + "responses": { + "200": { + "description": "OK. Quota information will be returned in the response with pagination.", + "schema": { + "$ref": "#/definitions/QuotaLimits" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ExceptionResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{scope}/providers/Microsoft.Quota/quotaLimitsRequests/{id}": { + "get": { + "tags": [ + "QuotaRequests" + ], + "x-ms-examples": { + "QuotaRequestStatus": { + "$ref": "./examples/getQuotaRequestStatusById.json" + }, + "QuotaRequestInProgress": { + "$ref": "./examples/getQuotaRequestStatusInProgress.json" + }, + "QuotaRequestFailed": { + "$ref": "./examples/getQuotaRequestStatusFailed.json" + } + }, + "description": "Gets the quota request details and status by quota request ID for the resources of the resource provider at a specific location. The quota request ID **id** is returned in the response of the PUT operation.", + "operationId": "QuotaRequestStatus_Get", + "parameters": [ + { + "$ref": "#/parameters/RequestIdInParameters" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeInPath" + } + ], + "responses": { + "200": { + "description": "OK. Returning the status for the quota request.", + "schema": { + "$ref": "#/definitions/QuotaRequestDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ExceptionResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.Quota/quotaLimitsRequests": { + "get": { + "tags": [ + "QuotaRequests" + ], + "x-ms-examples": { + "QuotaRequestHistory": { + "$ref": "./examples/getQuotaRequestsHistory.json" + } + }, + "description": "For the specified location and resource provider, gets the current quota requests under the subscription for a one year period ending at the time is made. Use the **oData** filter can be used to select quota requests.", + "operationId": "QuotaRequestStatus_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeInPath" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators \n|---------------------|------------------------\n\r\n|requestSubmitTime | ge, le, eq, gt, lt\n |provisioningState eq {QuotaRequestState}\n |resourceName eq {resourceName}\n" + }, + { + "$ref": "#/parameters/TopQueryParameter" + }, + { + "$ref": "#/parameters/SkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "OK. Sending quota request status and details.", + "schema": { + "$ref": "#/definitions/QuotaRequestDetailsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ExceptionResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Quota/quotaLimitProviders": { + "get": { + "tags": [ + "QuotaMetadata" + ], + "description": "Gets the list of current resource providers supported by the Microsoft.Quota resource provider.\r\nFor each resource provider, the resource templates the resource provider supports are be provided. \r\nFor each resource template, the resource dimensions are listed. The resource dimensions are the name-value pairs in the resource URI.\r\nExample: Microsoft.Compute Resource Provider\r\nThe URI template is '/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{locationId}/quotaBucket'. The actual dimensions vary depending on the resource provider.\r\nThe resource dimensions are {subscriptions},{locations},{quotaBucket}.", + "operationId": "QuotaResourceProviders_List", + "x-ms-examples": { + "Quotas_listMetadataForRPs": { + "$ref": "./examples/metadata/getQuotaRPMetadata.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Quota limits type information.", + "schema": { + "$ref": "#/definitions/resourceProvidersList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ExceptionResponse" + } + } + } + } + }, + "/providers/Microsoft.Quota/operations": { + "get": { + "summary": "GET operations.", + "description": "List all GET operations.", + "operationId": "Operation_List", + "x-ms-examples": { + "GetOperations": { + "$ref": "./examples/GetOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "Operation" + ], + "responses": { + "200": { + "description": "List all GET operations.", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ExceptionResponse" + } + } + } + } + } + }, + "definitions": { + "OperationList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/OperationResponse" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next page of items." + } + } + }, + "OperationResponse": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplay" + }, + "origin": { + "type": "string" + } + } + }, + "OperationDisplay": { + "type": "object", + "properties": { + "provider": { + "type": "string", + "description": "Provider name." + }, + "resource": { + "type": "string", + "description": "Resource name." + }, + "operation": { + "type": "string", + "description": "Operation name." + }, + "description": { + "type": "string", + "description": "Operation description." + } + } + }, + "CommonResourceProperties": { + "type": "object", + "description": "Resource properties.", + "properties": { + "id": { + "description": "Resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource name.", + "type": "string", + "readOnly": true + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type. \"Microsoft.Quota/quotaLimits\"" + } + } + }, + "CurrentQuotaLimitBase": { + "type": "object", + "description": "Quota limit.", + "x-ms-azure-resource": true, + "properties": { + "id": { + "description": "The resource Id.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The resource type.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The resource name.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Quota properties for the specified resource.", + "$ref": "#/definitions/QuotaProperties" + } + } + }, + "QuotaProperties": { + "description": "Quota properties for the specified resource.", + "type": "object", + "properties": { + "limit": { + "description": "Quota limit.", + "type": "integer", + "format": "int32", + "readOnly": false + }, + "currentValue": { + "description": "Usage information for the current resource.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "unit": { + "description": " The quota limit units, such as Count and Bytes. When requesting quota, use the **unit** value returned in the GET response in the request body of your PUT operation.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource name provided by the resource provider. Use this property name when requesting quota.", + "$ref": "#/definitions/ResourceName" + }, + "resourceType": { + "description": "Resource type name.", + "$ref": "#/definitions/ResourceTypesName" + }, + "quotaPeriod": { + "description": "The time period over which the quota usage values are summarized. For example:\r\n*P1D (per one day)\n*PT1M (per one minute)\n*PT1S (per one second).\r\nThis parameter is optional because, for some resources like compute, the period is irrelevant.", + "type": "string", + "readOnly": true + }, + "isQuotaApplicable": { + "description": "States if quota can be requested for this resource.", + "type": "boolean", + "readOnly": true + }, + "properties": { + "description": "Additional properties for the specific resource provider.", + "type": "object" + } + } + }, + "ResourceName": { + "type": "object", + "description": "Name of the resource provided by the resource Provider. When requesting quota, use this property name.", + "properties": { + "value": { + "description": "Resource name.", + "type": "string", + "readOnly": false + }, + "localizedValue": { + "description": "Resource display name.", + "type": "string", + "readOnly": true + } + } + }, + "QuotaLimits": { + "type": "object", + "description": "Quota limits.", + "properties": { + "value": { + "description": "List of quota limits.", + "type": "array", + "items": { + "$ref": "#/definitions/CurrentQuotaLimitBase" + } + }, + "nextLink": { + "description": "The URI used to fetch the next page of quota limits. When there are no more pages, this is null.", + "type": "string" + } + } + }, + "QuotaLimitsResponse": { + "type": "object", + "description": "Quota limits request response.", + "properties": { + "value": { + "description": "List of quota limits with the quota request status.", + "type": "array", + "items": { + "$ref": "#/definitions/CurrentQuotaLimitBase" + } + }, + "nextLink": { + "description": "The URI used to fetch the next page of quota limits. When there are no more pages, this is null.", + "type": "string" + } + } + }, + "CreateGenericQuotaRequestParameters": { + "type": "object", + "description": "Quota change requests information.", + "properties": { + "value": { + "description": "Quota change requests.", + "type": "array", + "items": { + "$ref": "#/definitions/CurrentQuotaLimitBase" + } + } + } + }, + "SubRequest": { + "type": "object", + "description": "Request property.", + "properties": { + "limit": { + "description": "Resource quota limit.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "name": { + "description": "Resource name.", + "$ref": "#/definitions/ResourceName" + }, + "resourceType": { + "description": "Resource type for which the quota check was made.", + "type": "string", + "readOnly": true + }, + "unit": { + "description": " Quota limit units, such as Count and Bytes. When requesting quota, use the **unit** value returned in the GET response in the request body of your PUT operation.", + "type": "string" + }, + "provisioningState": { + "description": "The quota request status.", + "$ref": "#/definitions/QuotaRequestState" + }, + "message": { + "description": "User-friendly status message.", + "type": "string", + "readOnly": true + }, + "subRequestId": { + "description": "Quota request ID.", + "type": "string", + "readOnly": true + } + } + }, + "QuotaRequestOneResourceSubmitResponse": { + "description": "Quota request response.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "description": "Quota request ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the quota request.", + "type": "string", + "readOnly": true + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type. \"Microsoft.Quota/ServiceLimitRequests\"" + }, + "properties": { + "description": "Quota request details.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/quotaRequestOneResourceProperties" + } + } + }, + "QuotaRequestSubmitResponse": { + "description": "Quota request response.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "description": "Quota request ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Quota request name.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "The quota request details.", + "type": "object", + "$ref": "#/definitions/QuotaRequestProperties" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type. \"Microsoft.Quota/quotaLimits\"" + } + } + }, + "QuotaRequestSubmitResponse202": { + "description": "The quota request response with the quota request ID.", + "type": "object", + "properties": { + "id": { + "description": "The quota request ID. To check the request status, use the **id** value in a [Quota Request Status](https://docs.microsoft.com/en-us/rest/api/reserved-vm-instances/quotarequeststatus/get) GET operation.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Operation ID.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Quota request status.", + "$ref": "#/definitions/QuotaRequestStatusDetails", + "x-ms-client-flatten": true + } + } + }, + "QuotaRequestStatusDetails": { + "description": "Quota request status details.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Quota request status.", + "$ref": "#/definitions/QuotaRequestState", + "readOnly": true + }, + "message": { + "description": "User-friendly message.", + "type": "string", + "readOnly": true + }, + "limit": { + "description": "Quota limit.", + "type": "integer", + "format": "int32", + "readOnly": false + }, + "currentValue": { + "description": "Usage information for the current resource.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "unit": { + "description": " The quota limit units, such as Count and Bytes. When requesting quota, use the **unit** value returned in the GET response in the request body of your PUT operation.", + "type": "string", + "readOnly": false + }, + "name": { + "description": "Resource name provided by the resource provider. Use this property name when requesting quota.", + "$ref": "#/definitions/ResourceName" + }, + "resourceType": { + "description": "Resource type name.", + "$ref": "#/definitions/ResourceTypesName" + }, + "quotaPeriod": { + "description": "The time period over which the quota usage values are summarized. For example:\r\n*P1D (per one day)\n*PT1M (per one minute)\n*PT1S (per one second).\r\nThis parameter is optional because, for some resources like compute, the period is irrelevant.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Additional properties for the specific resource provider.", + "type": "object" + } + } + }, + "QuotaRequestDetails": { + "type": "object", + "description": "List of quota requests with details.", + "properties": { + "id": { + "description": "Quota request ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Quota request name.", + "type": "string", + "readOnly": true + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type. \"Microsoft.Quota/quotaLimits\"" + }, + "properties": { + "description": "Quota request details.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/QuotaRequestProperties" + } + } + }, + "QuotaRequestDetailsList": { + "description": "Quota request information.", + "type": "object", + "properties": { + "value": { + "description": "Quota request details.", + "type": "array", + "items": { + "$ref": "#/definitions/QuotaRequestDetails" + } + }, + "nextLink": { + "description": "The URI for fetching the next page of quota limits. When there are no more pages, this is null.", + "type": "string" + } + } + }, + "QuotaRequestProperties": { + "type": "object", + "description": "Quota request properties.", + "properties": { + "provisioningState": { + "description": "The quota request status.", + "$ref": "#/definitions/QuotaRequestState" + }, + "message": { + "description": "User-friendly status message.", + "type": "string", + "readOnly": true + }, + "requestSubmitTime": { + "description": "The quota request submission time. The date conforms to the following format specified by the ISO 8601 standard: yyyy-MM-ddTHH:mm:ssZ", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "value": { + "description": "Quota request details.", + "type": "array", + "items": { + "$ref": "#/definitions/SubRequest" + } + } + } + }, + "quotaRequestOneResourceProperties": { + "type": "object", + "description": "Quota request.", + "properties": { + "provisioningState": { + "description": "Quota request status.", + "readOnly": true, + "$ref": "#/definitions/QuotaRequestState" + }, + "message": { + "description": "User-friendly status message.", + "type": "string", + "readOnly": true + }, + "requestSubmitTime": { + "description": "Quota request submission time. The date conforms to the following ISO 8601 standard format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "limit": { + "description": "Quota limit.", + "type": "integer", + "format": "int32", + "readOnly": false + }, + "currentValue": { + "description": "Usage information for the current resource.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "unit": { + "description": " The quota limit units, such as Count and Bytes. When requesting quota, use the **unit** value returned in the GET response in the request body of your PUT operation.", + "type": "string", + "readOnly": false + }, + "name": { + "description": "Resource name provided by the resource provider. Use this property name when requesting quota.", + "$ref": "#/definitions/ResourceName" + }, + "resourceType": { + "description": "Resource type name.", + "$ref": "#/definitions/ResourceTypesName" + }, + "quotaPeriod": { + "description": "The time period over which the quota usage values are summarized. For example:\r\n*P1D (per one day)\n*PT1M (per one minute)\n*PT1S (per one second).\r\nThis parameter is optional because, for some resources like compute, the period is irrelevant.", + "type": "string", + "readOnly": true + }, + "isQuotaApplicable": { + "description": "States if quota can be requested for this resource.", + "type": "boolean", + "readOnly": true + }, + "properties": { + "description": "Additional properties for the specific resource provider.", + "type": "object" + } + } + }, + "QuotaRequestState": { + "description": "Quota request status.", + "enum": [ + "Accepted", + "Invalid", + "Succeeded", + "Failed", + "InProgress" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "name": "QuotaRequestState", + "modelAsString": true + } + }, + "ResourceTypesName": { + "description": "Resource types. For extensibility, it is a string.", + "enum": [ + "standard", + "dedicated", + "lowPriority", + "shared", + "serviceSpecific" + ], + "readOnly": false, + "type": "string", + "x-ms-enum": { + "name": "ResourceType", + "modelAsString": true + } + }, + "ExceptionResponse": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ServiceError", + "description": "API error details." + } + }, + "description": "Error." + }, + "quotaBucketProperties": { + "type": "object", + "description": "quotaBucket provider properties.", + "properties": { + "name": { + "type": "string", + "description": "Property name." + }, + "displayName": { + "description": "Display name.", + "type": "string" + } + } + }, + "ResourceProviderDimension": { + "type": "object", + "description": "Resource provider resource dimension.", + "properties": { + "name": { + "type": "string", + "description": "Resource dimension name." + }, + "displayName": { + "description": "Display name.", + "type": "string" + } + } + }, + "ResourceProviderTemplate": { + "type": "object", + "description": "Resource template details for the resource provider.", + "properties": { + "resourceType": { + "type": "string", + "description": "Resource type." + }, + "resourceQuery": { + "description": "Resource query for dimension values.", + "$ref": "#/definitions/resourceQueryDetails" + }, + "resourceUsagesQuery": { + "description": "Resource usages query.", + "$ref": "#/definitions/resourceQueryDetails" + }, + "dimensions": { + "description": "Resource provider dimensions.", + "type": "array", + "items": { + "$ref": "#/definitions/ResourceProviderDimension" + } + } + } + }, + "ResourceProviderTemplates": { + "type": "object", + "description": "List of resource provider templates", + "properties": { + "value": { + "description": "The resource provider templates", + "type": "array", + "items": { + "$ref": "#/definitions/ResourceProviderTemplate" + } + } + } + }, + "ResourceProviderInformation": { + "type": "object", + "description": "Resource provider information.", + "properties": { + "resourceProviderName": { + "type": "string", + "description": "Resource provider name." + }, + "properties": { + "description": "Resource provider quota dimensions.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ResourceProviderTemplates" + } + } + }, + "resourceProvidersList": { + "type": "object", + "description": "Resource providers list.", + "properties": { + "value": { + "description": "Resource provider information.", + "type": "array", + "items": { + "$ref": "#/definitions/ResourceProviderInformation" + } + } + } + }, + "QuotaTypeInformationDimensionList": { + "description": "Quota types information list.", + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "description": "Resource type" + }, + "value": { + "description": "Quota type information.", + "type": "array", + "items": { + "$ref": "#/definitions/QuotaTypeDimensionInformation" + } + } + } + }, + "QuotaTypeDimensionInformation": { + "type": "object", + "description": "Quota type information.", + "properties": { + "name": { + "type": "string", + "description": "Property name." + }, + "displayName": { + "type": "string", + "description": "Display name." + }, + "id": { + "type": "string", + "description": "Dimension ID." + } + } + }, + "QuotaTemplateDetails": { + "type": "object", + "description": "Quota template details.", + "properties": { + "resourceType": { + "type": "string", + "description": "Resource type." + }, + "properties": { + "description": "Quota type properties for the resource ID.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/QuotaTypeInformationDimensionList" + } + } + }, + "resourceQueryDetails": { + "type": "object", + "description": "Resource query details.", + "properties": { + "resourceQueryType": { + "description": "Resource query type.", + "$ref": "#/definitions/ResourceQueryType" + }, + "resourceQueryMethod": { + "description": "Resource query method.", + "$ref": "#/definitions/ResourceQueryMethod" + }, + "resourceQueryUri": { + "type": "string", + "description": "Base URI for for resource query." + }, + "resourceQueryPostTemplate": { + "description": "Template to create the resource query.", + "type": "string" + } + } + }, + "ResourceQueryType": { + "description": "Resource query types. For extensibility, it is a string.", + "enum": [ + "ARG", + "RestAPI" + ], + "readOnly": false, + "type": "string", + "x-ms-enum": { + "name": "ResourceQueryType", + "modelAsString": true + } + }, + "ResourceQueryMethod": { + "description": "The resource query method.", + "enum": [ + "GET", + "POST" + ], + "readOnly": false, + "type": "string", + "x-ms-enum": { + "name": "ResourceQueryMethod", + "modelAsString": true + } + }, + "QuotaTemplatesDetails": { + "type": "object", + "description": "Quota templates details.", + "properties": { + "value": { + "description": "Quota templates information.", + "type": "array", + "items": { + "$ref": "#/definitions/QuotaTemplateDetails" + } + } + } + }, + "ServiceError": { + "description": "API error details.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Error code." + }, + "message": { + "type": "string", + "description": "Error message." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceErrorDetail" + }, + "description": "List of error details.", + "readOnly": true + } + } + }, + "ServiceErrorDetail": { + "description": "Error details.", + "type": "object", + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "Error code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "Error message." + } + } + } + }, + "parameters": { + "SubscriptionIdInParameters": { + "name": "subscriptionId", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "description": "Azure subscription ID." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for this operation.", + "minLength": 1 + }, + "ResourceNameInParameters": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource name for a given resource provider. For example:\r\n- SKU name for Microsoft.Compute\r\n- Sku or TotalLowPriorityCores for Microsoft.MachineLearningServices", + "x-ms-parameter-location": "method" + }, + "ResourceDimensionTypeInParameter": { + "name": "resourceDimension", + "in": "path", + "required": true, + "type": "string", + "description": "Resource dimension type for a resource provider. For example:\r\n- locations and SKUs for Microsoft.Compute\r\n- resource groups, batch accounts, and SKUs for Microsoft.Batch", + "x-ms-parameter-location": "method" + }, + "RequestIdInParameters": { + "name": "id", + "in": "path", + "required": true, + "type": "string", + "description": "Quota request ID.", + "x-ms-parameter-location": "method" + }, + "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": { + "name": "$skiptoken", + "in": "query", + "type": "string", + "required": false, + "description": "The **Skiptoken** parameter is used only if a previous operation returned a partial result. If a previous response contains a **nextLink** element, the value of the **nextLink** element includes a **skiptoken** parameter that specifies a starting point to use for subsequent calls.", + "x-ms-parameter-location": "method" + }, + "ScopeInPath": { + "name": "scope", + "description": "The target Azure resource URI. For example, `/subscriptions/9f6cce51-6baf-4de5-a3c4-6f58b85315b9/resourceGroups/qms-test/providers/Microsoft.Batch/batchAccounts/testAccount/`. This is the target Azure resource URI for the List GET operation. If a `{resourceName}` is added after `/quotaLimits`, then it's the target Azure resource URI in the GET operation for the specific resource.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/quota/resource-manager/readme.az.md b/specification/quota/resource-manager/readme.az.md new file mode 100644 index 000000000000..cc170cdca295 --- /dev/null +++ b/specification/quota/resource-manager/readme.az.md @@ -0,0 +1,13 @@ +# AZ quota + +These settings apply only when `--az` is specified on the command line. + +``` yaml $(az) +az: + extensions: quota + namespace: azure.mgmt.quota + package-name: azure-mgmt-quota + client-subscription-bound: false +az-output-folder: $(azure-cli-extension-folder)/src/quota +python-sdk-output-folder: "$(az-output-folder)/azext_quota/vendored_sdks/quota" +``` \ No newline at end of file diff --git a/specification/quota/resource-manager/readme.azureresourceschema.md b/specification/quota/resource-manager/readme.azureresourceschema.md new file mode 100644 index 000000000000..b4bf5795d0f5 --- /dev/null +++ b/specification/quota/resource-manager/readme.azureresourceschema.md @@ -0,0 +1,44 @@ +## AzureResourceSchema + +These settings apply only when `--azureresourceschema` is specified on the command line. + +### AzureResourceSchema multi-api + +``` yaml $(azureresourceschema) && $(multiapi) +batch: + - tag: schema-quota-2021-03-15 +``` + +Please also specify `--azureresourceschema-folder=`. + +### Tag: schema-quota-2021-03-15 and azureresourceschema + +``` yaml $(tag) == 'schema-quota-2021-03-15' && $(azureresourceschema) +output-folder: $(azureresourceschema-folder)/schemas + +# all the input files in this apiVersion +input-file: + - Microsoft.Quota/stable/2021-03-15/quota.json + +``` + +# all the input files in this apiVersion +input-file: + - Microsoft.Quota/stable/2021-03-15/quota.json +``` + +### Tag: schema-quota-2021-03-15-preview and azureresourceschema + +``` yaml $(tag) == 'schema-quota-2021-03-15-preview' && $(azureresourceschema) +output-folder: $(azureresourceschema-folder)/schemas + +# all the input files in this apiVersion +input-file: + - Microsoft.Quota/review/2021-03-15-preview/quota.json + +``` + +# all the input files in this apiVersion +input-file: + - Microsoft.Quota/preview/2021-03-15-preview/quota.json +``` \ No newline at end of file diff --git a/specification/quota/resource-manager/readme.cli.md b/specification/quota/resource-manager/readme.cli.md new file mode 100644 index 000000000000..70969e68bd39 --- /dev/null +++ b/specification/quota/resource-manager/readme.cli.md @@ -0,0 +1,11 @@ +## CLI + +These settings apply only when `--cli` is specified on the command line. + +``` yaml $(cli) +cli: + cli-name: quota + package-name: azure-mgmt-quota + namespace: azure.mgmt.quota + +``` diff --git a/specification/quota/resource-manager/readme.go.md b/specification/quota/resource-manager/readme.go.md new file mode 100644 index 000000000000..54989d12c163 --- /dev/null +++ b/specification/quota/resource-manager/readme.go.md @@ -0,0 +1,36 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + clear-output-folder: true + namespace: quota +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2021-03-15-preview + - tag: package-2021-03-15 +``` + +### Tag: package-2021-03-15 and go + +These settings apply only when `--tag=package-2021-03-15 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2021-03-15' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2021-03-15/$(namespace) +``` + +### Tag: package-2021-03-15-preview and go + +These settings apply only when `--tag=package-2021-03-15-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2021-03-15-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2021-03-15-preview/$(namespace) +``` diff --git a/specification/quota/resource-manager/readme.java.md b/specification/quota/resource-manager/readme.java.md new file mode 100644 index 000000000000..bb311f134f94 --- /dev/null +++ b/specification/quota/resource-manager/readme.java.md @@ -0,0 +1,47 @@ +## 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.quota +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-quota +``` + +### Java multi-api + +```yaml $(java) && $(multiapi) +batch: + - tag: package-2021-03-15-preview +``` + +### Tag: package-2021-03-15 and java + +These settings apply only when `--tag=package-2021-03-15 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2021-03-15' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.quota.v2021_03_15 + output-folder: $(azure-libraries-for-java-folder)/sdk/quota/mgmt-v2021_03_15 +regenerate-manager: true +generate-interface: true +``` + + +### Tag: package-2021-03-15-preview and java + +These settings apply only when `--tag=package-2021-03-15-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2021-03-15-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.quota.v2021_03_15_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/quota/mgmt-v2021_03_15_preview +regenerate-manager: true +generate-interface: true +``` diff --git a/specification/quota/resource-manager/readme.md b/specification/quota/resource-manager/readme.md new file mode 100644 index 000000000000..c9aa8db54bd4 --- /dev/null +++ b/specification/quota/resource-manager/readme.md @@ -0,0 +1,179 @@ +# Quota + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Quota RP. + +--- + +## Getting Started + +To build the SDK for Quota, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +### Basic Information + +These are the global settings for the Quota API. + +``` yaml +openapi-type: arm +tag: package-2021-03-15-preview +``` + +### Tag: package-2021-03-15 + +These settings apply only when `--tag=package-2021-03-15` is specified on the command line. + +```yaml $(tag) == 'package-2021-03-15' +input-file: + - Microsoft.Quota/stable/2021-03-15/quota.json +``` + +### Tag: package-021-03-15-preview + +These settings apply only when `--tag=package-2021-03-15-preview` is specified on the command line. + +```yaml $(tag) == 'package-2021-03-15-preview' +input-file: + - Microsoft.Quota/preview/2021-03-15-preview/quota.json +``` + +### Supressions + +``` yaml +directive: +- suppress: + - R3007 # The 'PutGetPatchResponseSchema' Both get and put/Patch is using same data model - CurrentQuotaLimitBase. + - R4009 # The 'RequiredReadOnlySystemData' It will be added later, if needed. + - R4018 # The 'OperationsApiResponseSchema' It will be added later, if needed. The current API provides in this format. +``` + +--- +--- +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-net + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-cli-extensions + - repo: azure-sdk-for-ruby + - repo: azure-resource-manager-schemas + after_scripts: + - node sdkauto_afterscript.js quota/resource-manager +``` + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.Quota + payload-flattening-threshold: 1 + output-folder: $(csharp-sdks-folder)/quota/Microsoft.Azure.Management.Quota/src/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.quota + package-name: azure-mgmt-quota + package-version: 0.1.0 + clear-output-folder: true +``` + +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/quota/azure-mgmt-quota/azure/mgmt/quota +``` + +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/quota/azure-mgmt-quota +``` + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## CLI + +See configuration in [readme.cli.md](./readme.cli.md) + +## AZ + + See configuration in [readme.az.md](./readme.az.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## AzureResourceSchema + +See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) + +## Java + +See configuration in [readme.java.md](./readme.java.md) + +## Ruby + +See configuration in [readme.ruby.md](./readme.ruby.md) + +## Multi-API/Profile support for AutoRest v3 generators + +AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. + +This block is updated by an automatic script. Edits may be lost! + +``` yaml $(tag) == 'all-api-versions' /* autogenerated */ +# include the azure profile definitions from the standard location +require: $(this-folder)/../../../profiles/readme.md + +# all the input files across all versions +input-file: + - $(this-folder)/Microsoft.Quota/preview/2021-03-15-preview/quota.json + +``` + +If there are files that should not be in the `all-api-versions` set, +uncomment the `exclude-file` section below and add the file paths. + +``` yaml $(tag) == 'all-api-versions' +#exclude-file: +# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json +``` diff --git a/specification/quota/resource-manager/readme.nodejs.md b/specification/quota/resource-manager/readme.nodejs.md new file mode 100644 index 000000000000..fc93057cc12f --- /dev/null +++ b/specification/quota/resource-manager/readme.nodejs.md @@ -0,0 +1,14 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + azure-arm: true + package-name: azure-arm-quota + output-folder: $(node-sdks-folder)/lib/services/quotaManagement + generate-license-txt: true + generate-package-json: true + generate-readme-md: true +``` diff --git a/specification/quota/resource-manager/readme.python.md b/specification/quota/resource-manager/readme.python.md new file mode 100644 index 000000000000..9d747b0704ed --- /dev/null +++ b/specification/quota/resource-manager/readme.python.md @@ -0,0 +1,49 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) && !$(track2) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.quota + package-name: azure-mgmt-quota + package-version: 0.1.0 + clear-output-folder: true +``` + +``` yaml $(python) && $(track2) +python-mode: create +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +namespace: azure.mgmt.quota +package-name: azure-mgmt-quota +package-version: 0.1.0 +clear-output-folder: true +``` + +``` yaml $(python) && $(python-mode) == 'update' && !$(track2) +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/quota/azure-mgmt-quota/azure/mgmt/quota +``` + +``` yaml $(python) && $(python-mode) == 'create' && !$(track2) +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/quota/azure-mgmt-quota +``` + +``` yaml $(python) && $(python-mode) == 'update' && $(track2) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/quota/azure-mgmt-quota/azure/mgmt/quota +``` + +``` yaml $(python) && $(python-mode) == 'create' && $(track2) +basic-setup-py: true +output-folder: $(python-sdks-folder)/quota/azure-mgmt-quota +``` diff --git a/specification/quota/resource-manager/readme.ruby.md b/specification/quota/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..f1664b4df244 --- /dev/null +++ b/specification/quota/resource-manager/readme.ruby.md @@ -0,0 +1,29 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +```yaml +package-name: azure_mgmt_quota +package-version: 2021-03-15 +azure-arm: true +``` + +### Tag: package-2021-03-15 and ruby + +These settings apply only when `--tag=package-2021-03-15 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +```yaml $(tag) == 'package-2021-03-15' && $(ruby) +namespace: Microsoft.Quota +output-folder: $(ruby-sdks-folder)/quota +``` + +### Tag: package-2021-03-15-preview and ruby + +These settings apply only when `--tag=package-2021-03-15-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +```yaml $(tag) == 'package-2021-03-15-preview' && $(ruby) +namespace: Microsoft.Quota +output-folder: $(ruby-sdks-folder)/quota-preview +``` diff --git a/specification/quota/resource-manager/readme.typescript.md b/specification/quota/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..f1dd7ff501ea --- /dev/null +++ b/specification/quota/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: "@azure/arm-quota" + output-folder: "$(typescript-sdks-folder)/sdk/quota/arm-quota" + clear-output-folder: true + generate-metadata: true +``` diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/CheckNameAvailability_Available.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/CheckNameAvailability_Available.json new file mode 100644 index 000000000000..575affeed158 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/CheckNameAvailability_Available.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "resGroupFoo", + "api-version": "2021-04-01", + "location": "westus", + "input": { + "name": "swaggerExample", + "type": "Microsoft.RecoveryServices/Vaults" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/CheckNameAvailability_NotAvailable.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/CheckNameAvailability_NotAvailable.json new file mode 100644 index 000000000000..e4f541309c32 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/CheckNameAvailability_NotAvailable.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "resGroupBar", + "api-version": "2021-04-01", + "location": "westus", + "input": { + "name": "swaggerExample2", + "type": "Microsoft.RecoveryServices/Vaults" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "Resource already exists with the same name." + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/DeleteRegisteredIdentities.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/DeleteRegisteredIdentities.json new file mode 100644 index 000000000000..29936eb7d19c --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/DeleteRegisteredIdentities.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "77777777-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "BCDRIbzRG", + "vaultName": "BCDRIbzVault", + "identityName": "dpmcontainer01", + "api-version": "2021-04-01" + }, + "responses": { + "204": {} + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/DeleteVault.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/DeleteVault.json new file mode 100644 index 000000000000..ee8abd582ad3 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/DeleteVault.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "Default-RecoveryServices-ResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2021-04-01" + }, + "responses": { + "200": {} + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/GETVault.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/GETVault.json new file mode 100644 index 000000000000..2a97245685f5 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/GETVault.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "Default-RecoveryServices-ResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2021-04-01" + }, + "responses": { + "200": { + "body": { + "location": "westus", + "name": "swaggerExample", + "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"", + "tags": { + "TestUpdatedKey": "TestUpdatedValue" + }, + "identity": { + "tenantId": "d676e86e-2206-4a7c-999c-ece52c144b5b", + "principalId": "3137d6c7-5d6c-411c-b934-7a2a729ee247", + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpointConnections": [ + { + "id": "/subscriptions/6c48fa17-39c7-45f1-90ac-47a587128ace/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/Vaults/pemsi-ecy-rsv2/privateEndpointConnections/pe114-pemsi-ecy-rsv.5944358949303501042.backup.75061caa-cba4-4849-8e09-608da4914aad", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/6c48fa17-39c7-45f1-90ac-47a587128ace/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.Network/privateEndpoints/pe114-pemsi-ecy-rsv" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "None", + "actionsRequired": "None" + } + } + } + ], + "privateEndpointStateForBackup": "Enabled", + "privateEndpointStateForSiteRecovery": "None" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/GETVaultExtendedInfo.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/GETVaultExtendedInfo.json new file mode 100644 index 000000000000..9195923e95fb --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/GETVaultExtendedInfo.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "Default-RecoveryServices-ResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2021-04-01" + }, + "responses": { + "200": { + "body": { + "name": "vaultExtendedInfo", + "etag": "f0d0260b-b92d-4458-ba0a-32c6cdabacb7", + "properties": { + "integrityKey": "J09wzS27fnJ+Wjot7xO5wA==", + "algorithm": "None" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample/extendedInformation/vaultExtendedInfo", + "type": "Microsoft.RecoveryServices/vaults/extendedInformation" + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/GetOperationResult.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/GetOperationResult.json new file mode 100644 index 000000000000..b16170e7468b --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/GetOperationResult.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "HelloWorld", + "vaultName": "swaggerExample", + "operationId": "YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==", + "api-version": "2021-04-01" + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15", + "Location": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15" + } + }, + "200": { + "body": { + "location": "westus", + "name": "swaggerExample", + "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"", + "tags": { + "PatchKey": "PatchKeyUpdated" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": { + "clientId": "fbe75b66-01c5-4f87-a220-233af3270436", + "principalId": "075a0ca6-43f6-4434-9abf-c9b1b79f9219" + } + } + }, + "properties": { + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/GetOperationStatus.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/GetOperationStatus.json new file mode 100644 index 000000000000..70f0cc2f9e62 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/GetOperationStatus.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "HelloWorld", + "vaultName": "swaggerExample", + "operationId": "YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==", + "api-version": "2021-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==", + "name": "YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==", + "status": "Succeeded", + "startTime": "2019-11-20T09:49:44.0478496Z", + "endTime": "2019-11-20T09:49:46Z" + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/GetPrivateLinkResources.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/GetPrivateLinkResources.json new file mode 100644 index 000000000000..bec194f140c8 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/GetPrivateLinkResources.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "6c48fa17-39c7-45f1-90ac-47a587128ace", + "resourceGroupName": "petesting", + "vaultName": "pemsi-ecy-rsv2", + "api-version": "2021-04-01", + "privateLinkResourceName": "backupResource" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/6c48fa17-39c7-45f1-90ac-47a587128ace/resourceGroups/petesting/providers/Microsoft.RecoveryServices/Vaults/pemsi-ecy-rsv2/privateLinkResources/backupResource", + "name": "backupResource", + "type": "Microsoft.RecoveryServices/Vaults/privateLinkResources", + "properties": { + "groupId": "AzureBackup", + "requiredMembers": [ + "backup-fab1", + "backup-rec2", + "backup-prot1", + "backup-ecs1", + "backup-tel1", + "backup-wbcm1", + "backup-fc1", + "backup-id1" + ], + "requiredZoneNames": [ + "privatelink.ecy.backup.windowsazure.com", + "privatelink.queue.core.windows.net", + "privatelink.blob.core.windows.net" + ] + } + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ListBySubscriptionIds.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ListBySubscriptionIds.json new file mode 100644 index 000000000000..ab84636c9bd8 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ListBySubscriptionIds.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "api-version": "2021-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "westus", + "name": "patchtest", + "etag": "W/\"datetime'2017-11-22T11%3A05%3A19.907Z'\"", + "tags": { + "Love": "India" + }, + "properties": { + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/patchtest", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + }, + { + "location": "westus", + "name": "swaggerExample", + "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"", + "tags": { + "TestUpdatedKey": "TestUpdatedValue" + }, + "properties": { + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + }, + { + "location": "westus", + "name": "today1", + "etag": "W/\"datetime'2017-11-21T10%3A52%3A19.633Z'\"", + "tags": { + "TestUpdatedKey": "TestUpdatedValue" + }, + "properties": { + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/today1", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ListOperations.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ListOperations.json new file mode 100644 index 000000000000..8d6f29106177 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ListOperations.json @@ -0,0 +1,463 @@ +{ + "parameters": { + "api-version": "2021-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "microsoft.recoveryservices/vaults/usages/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Vault Usage", + "operation": "Recovery Services Vault usage details.", + "description": "Returns usage details for a Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupUsageSummaries/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Usages Summaries", + "operation": "Recovery Services Protected Items and Protected Servers usage summaries details.", + "description": "Returns summaries for Protected Items and Protected Servers for a Recovery Services ." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/storageConfig/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Vault Storage Config", + "operation": "Get Resource Storage Config", + "description": "Returns Storage Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/storageConfig/write", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Vault Storage Config", + "operation": "Write Resource Storage Config", + "description": "Updates Storage Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupconfig/vaultconfig/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Vault Config", + "operation": "Get Resource Config", + "description": "Returns Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupconfig/vaultconfig/write", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Vault Config", + "operation": "Update Resource Config", + "description": "Updates Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/tokenInfo/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Token Info", + "operation": "Get Vault Token Info", + "description": "Returns token information for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupSecurityPIN/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "SecurityPINInfo", + "operation": "Get Security PIN Info", + "description": "Returns Security PIN Information for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupManagementMetaData/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Management Metadata", + "operation": "Get Backup Management Metadata", + "description": "Returns Backup Management Metadata for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupOperationResults/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Operation Results", + "operation": "Get Backup Operation Result", + "description": "Returns Backup Operation Result for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupOperations/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Operation Status", + "operation": "Get Backup Operation Status", + "description": "Returns Backup Operation Status for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupJobs/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Jobs", + "operation": "Get Jobs", + "description": "Returns all Job Objects" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupJobs/cancel/action", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Jobs", + "operation": "Cancel Jobs", + "description": "Cancel the Job" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupJobsExport/action", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Export Backup Jobs", + "operation": "Export Jobs", + "description": "Export Jobs" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupJobs/operationResults/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Jobs Operation Results", + "operation": "Get Job Operation Result", + "description": "Returns the Result of Job Operation." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupJobsExport/operationResults/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Export Backup Jobs Operation Results", + "operation": "Get Export Job Operation Result", + "description": "Returns the Result of Export Job Operation." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Recovery Points", + "operation": "Get Recovery Points", + "description": "Get Recovery Points for Protected Items." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/restore/action", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Recovery Points", + "operation": "Restore Recovery Points", + "description": "Restore Recovery Points for Protected Items." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/provisionInstantItemRecovery/action", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Recovery Points", + "operation": "Provision Instant Item Recovery for Protected Item", + "description": "Provision Instant Item Recovery for Protected Item" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/revokeInstantItemRecovery/action", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Recovery Points", + "operation": "Revoke Instant Item Recovery for Protected Item", + "description": "Revoke Instant Item Recovery for Protected Item" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupPolicies/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Policies", + "operation": "Get Protection Policy", + "description": "Returns all Protection Policies" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupPolicies/write", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Policies", + "operation": "Create Protection Policy", + "description": "Creates Protection Policy" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupPolicies/delete", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Policies", + "operation": "Delete Protection Policy", + "description": "Delete a Protection Policy" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupPolicies/operationResults/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Policy Operation Results", + "operation": "Get Policy Operation Results", + "description": "Get Results of Policy Operation." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupPolicies/operationsStatus/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Policy Operation Status", + "operation": "Get Policy Operation Status", + "description": "Get Status of Policy Operation." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protected Items", + "operation": "Get Protected Item Details", + "description": "Returns object details of the Protected Item" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupProtectedItems/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protected Items", + "operation": "Get All Protected Items", + "description": "Returns the list of all Protected Items." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/write", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protected Items", + "operation": "Create Backup Protected Item", + "description": "Create a backup Protected Item" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/delete", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protected Items", + "operation": "Delete Protected Items", + "description": "Deletes Protected Item" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/operationResults/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protected Item Operation Results", + "operation": "Get Protected Items Operation Results", + "description": "Gets Result of Operation Performed on Protected Items." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/operationsStatus/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protected Item Operation Status", + "operation": "Get Protected Items operation status", + "description": "Returns the status of Operation performed on Protected Items." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/backup/action", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protected Items", + "operation": "Backup Protected Item", + "description": "Performs Backup for Protected Item." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupProtectableItems/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Protectable Items", + "operation": "Get Protectable Items", + "description": "Returns list of all Protectable Items." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/refreshContainers/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Refresh Containers", + "operation": "Refresh container", + "description": "Refreshes the container list" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/operationResults/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Refresh Containers Operation Results", + "operation": "Get Operation Results", + "description": "Returns status of the operation" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupProtectionContainers/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Protection Containers", + "operation": "Get Containers In Subscription", + "description": "Returns all containers belonging to the subscription" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protection Containers", + "operation": "Get Registered Container", + "description": "Returns all registered containers" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/operationResults/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protection Containers Operation Results", + "operation": "Get Container Operation Results", + "description": "Gets result of Operation performed on Protection Container." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupEngines", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Engines", + "operation": "List of backup management servers.", + "description": "Returns all the backup management servers registered with vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupStatus", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Status", + "operation": "Check Backup Status for Vault", + "description": "Check Backup Status for Recovery Services Vaults" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupPreValidateProtection", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "PreValidate Protection", + "operation": "Pre Validate Enable Protection", + "description": "" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupValidateFeatures", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Validate Features", + "operation": "Validate Features", + "description": "Validate Features" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/backupProtectionIntent/write", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protection Intent", + "operation": "Create backup Protection Intent", + "description": "Create a backup Protection Intent" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/{fabricName}/protectionContainers/{containerName}/items/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Workload Items", + "operation": "Get all items in a container", + "description": "Get all items in a container" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/inquire/action", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protection Containers Inquire", + "operation": "Get all items in a container", + "description": "Get all items in a container" + }, + "origin": "user" + } + ] + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ListPrivateLinkResources.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ListPrivateLinkResources.json new file mode 100644 index 000000000000..627f66f177a8 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ListPrivateLinkResources.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "6c48fa17-39c7-45f1-90ac-47a587128ace", + "resourceGroupName": "petesting", + "vaultName": "pemsi-ecy-rsv2", + "api-version": "2021-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/6c48fa17-39c7-45f1-90ac-47a587128ace/resourceGroups/petesting/providers/Microsoft.RecoveryServices/Vaults/pemsi-ecy-rsv2/privateLinkResources/backupResource", + "name": "backupResource", + "type": "Microsoft.RecoveryServices/Vaults/privateLinkResources", + "properties": { + "groupId": "AzureBackup", + "requiredMembers": [ + "backup-fab1", + "backup-rec2", + "backup-prot1", + "backup-ecs1", + "backup-tel1", + "backup-wbcm1", + "backup-fc1", + "backup-id1" + ], + "requiredZoneNames": [ + "privatelink.ecy.backup.windowsazure.com", + "privatelink.queue.core.windows.net", + "privatelink.blob.core.windows.net" + ] + } + }, + { + "id": "/subscriptions/6c48fa17-39c7-45f1-90ac-47a587128ace/resourceGroups/gaallarg/providers/Microsoft.RecoveryServices/vaults/amchandnTest2702A/privateLinkResources/siteRecoveryResource", + "name": "siteRecoveryResource", + "type": "Microsoft.RecoveryServices/vaults/privateLinkResources", + "properties": { + "groupId": "AzureSiteRecovery", + "requiredMembers": [ + "siteRecovery-rcm1", + "siteRecovery-prot2", + "siteRecovery-tel1", + "siteRecovery-srs1", + "siteRecovery-prot2b", + "siteRecovery-id1" + ], + "requiredZoneNames": [ + "privatelink.ecy.siterecovery.windowsazure.com", + "privatelink.queue.core.windows.net", + "privatelink.blob.core.windows.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ListReplicationUsages.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ListReplicationUsages.json new file mode 100644 index 000000000000..476a8fb2a118 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ListReplicationUsages.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "vaultName": "avrai7517Vault1", + "resourceGroupName": "avrai7517RG1", + "subscriptionId": "6808dbbc-98c7-431f-a1b1-9580902423b7" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "monitoringSummary": { + "unHealthyVmCount": 0, + "unHealthyProviderCount": 0, + "eventsCount": 0, + "deprecatedProviderCount": 0, + "supportedProviderCount": 0, + "unsupportedProviderCount": 0 + }, + "jobsSummary": { + "failedJobs": 0, + "suspendedJobs": 0, + "inProgressJobs": 0 + }, + "protectedItemCount": 2, + "registeredServersCount": 2, + "recoveryPlanCount": 1 + } + ] + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ListResources.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ListResources.json new file mode 100644 index 000000000000..a4247c21cdec --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ListResources.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "Default-RecoveryServices-ResourceGroup", + "api-version": "2021-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "westus", + "name": "patchtest", + "etag": "W/\"datetime'2017-11-22T11%3A05%3A19.907Z'\"", + "tags": { + "Love": "India" + }, + "properties": { + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/patchtest", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + }, + { + "location": "westus", + "name": "swaggerExample", + "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"", + "tags": { + "TestUpdatedKey": "TestUpdatedValue" + }, + "properties": { + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + }, + { + "location": "westus", + "name": "today1", + "etag": "W/\"datetime'2017-11-21T10%3A52%3A19.633Z'\"", + "tags": { + "TestUpdatedKey": "TestUpdatedValue" + }, + "properties": { + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/today1", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ListUsages.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ListUsages.json new file mode 100644 index 000000000000..842589f13b77 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ListUsages.json @@ -0,0 +1,180 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "Default-RecoveryServices-ResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2021-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 6, + "limit": -1, + "name": { + "value": "MABContainersCount", + "localizedValue": "Backup management servers" + } + }, + { + "unit": "Count", + "currentValue": 3, + "limit": -1, + "name": { + "value": "ProtectedItemCount", + "localizedValue": "Backup items/Azure virtual machine backup" + } + }, + { + "unit": "Count", + "currentValue": 0, + "limit": -1, + "name": { + "value": "ProtectedItemCriticalCount", + "localizedValue": "Critical" + } + }, + { + "unit": "Count", + "currentValue": 0, + "limit": -1, + "name": { + "value": "ProtectedItemWarningCount", + "localizedValue": "Warning" + } + }, + { + "unit": "Count", + "currentValue": 0, + "limit": -1, + "name": { + "value": "IaaSVMProtectedItemCount", + "localizedValue": "Azure Virtual Machines" + } + }, + { + "unit": "Count", + "currentValue": 0, + "limit": -1, + "name": { + "value": "IaaSVMProtectedItemCriticalCount", + "localizedValue": "Critical" + } + }, + { + "unit": "Count", + "currentValue": 0, + "limit": -1, + "name": { + "value": "IaaSVMProtectedItemWarningCount", + "localizedValue": "Warning" + } + }, + { + "unit": "Count", + "currentValue": 0, + "limit": -1, + "name": { + "value": "MABProtectedItemCount", + "localizedValue": "File-Folders" + } + }, + { + "unit": "Count", + "currentValue": 1, + "limit": -1, + "name": { + "value": "DPMProtectedItemCount", + "localizedValue": "DPM Protected Items Count" + } + }, + { + "unit": "Count", + "currentValue": 2, + "limit": -1, + "name": { + "value": "AzureBackupServerProtectedItemCount", + "localizedValue": "Azure Backup Server Protected Items Count" + } + }, + { + "unit": "Count", + "quotaPeriod": "P1D", + "currentValue": 0, + "limit": -1, + "name": { + "value": "InProgressJobsCount", + "localizedValue": "In progress" + } + }, + { + "unit": "Count", + "quotaPeriod": "P1D", + "currentValue": 0, + "limit": -1, + "name": { + "value": "FailedJobsCount", + "localizedValue": "Failed" + } + }, + { + "unit": "Bytes", + "currentValue": 117007930, + "limit": -1, + "name": { + "value": "GRSStorageUsage", + "localizedValue": "Cloud - GRS" + } + }, + { + "unit": "Bytes", + "currentValue": 0, + "limit": -1, + "name": { + "value": "LRSStorageUsage", + "localizedValue": "Cloud - LRS" + } + }, + { + "unit": "Count", + "currentValue": 5, + "limit": -1, + "name": { + "value": "ManagedInstances", + "localizedValue": "Protected Instances" + } + }, + { + "unit": "Bytes", + "currentValue": 0, + "limit": -1, + "name": { + "value": "GRSDedupStorageUsage", + "localizedValue": "Dedup - GRS" + } + }, + { + "unit": "Bytes", + "currentValue": 0, + "limit": -1, + "name": { + "value": "LRSDedupStorageUsage", + "localizedValue": "Dedup - LRS" + } + }, + { + "unit": "Bytes", + "currentValue": 117851553792, + "limit": -1, + "name": { + "value": "UsedDiskSize", + "localizedValue": "Backup Engines' Disk Used" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/PATCHVault.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/PATCHVault.json new file mode 100644 index 000000000000..c23cfce0a7b8 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/PATCHVault.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "HelloWorld", + "vaultName": "swaggerExample", + "api-version": "2021-04-01", + "vault": { + "tags": { + "PatchKey": "PatchKeyUpdated" + } + } + }, + "responses": { + "200": { + "body": { + "location": "westus", + "name": "swaggerExample", + "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"", + "tags": { + "PatchKey": "PatchKeyUpdated" + }, + "properties": { + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15", + "Location": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15" + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/PATCHVault_WithCMK.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/PATCHVault_WithCMK.json new file mode 100644 index 000000000000..d7a63f989876 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/PATCHVault_WithCMK.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "HelloWorld", + "vaultName": "swaggerExample", + "api-version": "2021-04-01", + "vault": { + "tags": { + "PatchKey": "PatchKeyUpdated" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": {} + } + }, + "properties": { + "encryption": { + "keyVaultProperties": { + "keyUri": "https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3" + }, + "kekIdentity": { + "userAssignedIdentity": "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi" + }, + "infrastructureEncryption": "Enabled" + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "westus", + "name": "swaggerExample", + "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"", + "tags": { + "PatchKey": "PatchKeyUpdated" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": { + "clientId": "fbe75b66-01c5-4f87-a220-233af3270436", + "principalId": "075a0ca6-43f6-4434-9abf-c9b1b79f9219" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "encryption": { + "keyVaultProperties": { + "keyUri": "https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3" + }, + "kekIdentity": { + "userAssignedIdentity": "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi", + "useSystemAssignedIdentity": false + }, + "infrastructureEncryption": "Enabled" + } + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15", + "Location": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15" + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/PATCHVault_WithCMK3.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/PATCHVault_WithCMK3.json new file mode 100644 index 000000000000..6f10cfe1cdc8 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/PATCHVault_WithCMK3.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "HelloWorld", + "vaultName": "swaggerExample", + "api-version": "2021-04-01", + "vault": { + "tags": { + "PatchKey": "PatchKeyUpdated" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": {} + } + }, + "properties": { + "encryption": { + "keyVaultProperties": { + "keyUri": "https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "westus", + "name": "swaggerExample", + "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"", + "tags": { + "PatchKey": "PatchKeyUpdated" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": { + "clientId": "fbe75b66-01c5-4f87-a220-233af3270436", + "principalId": "075a0ca6-43f6-4434-9abf-c9b1b79f9219" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "encryption": { + "keyVaultProperties": { + "keyUri": "https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3" + }, + "kekIdentity": { + "userAssignedIdentity": "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi", + "useSystemAssignedIdentity": false + }, + "infrastructureEncryption": "Enabled" + } + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15", + "Location": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15" + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/PATCHVault_WithUserAssignedIdentity.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/PATCHVault_WithUserAssignedIdentity.json new file mode 100644 index 000000000000..2dd0e6bbfb31 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/PATCHVault_WithUserAssignedIdentity.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "HelloWorld", + "vaultName": "swaggerExample", + "api-version": "2021-04-01", + "vault": { + "tags": { + "PatchKey": "PatchKeyUpdated" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "westus", + "name": "swaggerExample", + "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"", + "tags": { + "PatchKey": "PatchKeyUpdated" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": { + "clientId": "fbe75b66-01c5-4f87-a220-233af3270436", + "principalId": "075a0ca6-43f6-4434-9abf-c9b1b79f9219" + } + } + }, + "properties": { + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15", + "Location": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15" + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/PUTVault.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/PUTVault.json new file mode 100644 index 000000000000..f873be76ed9b --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/PUTVault.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "Default-RecoveryServices-ResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2021-04-01", + "vault": { + "properties": {}, + "sku": { + "name": "Standard" + }, + "location": "West US", + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "location": "westus", + "name": "swaggerExample", + "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"", + "tags": { + "TestUpdatedKey": "TestUpdatedValue" + }, + "identity": { + "tenantId": "d676e86e-2206-4a7c-999c-ece52c144b5b", + "principalId": "3137d6c7-5d6c-411c-b934-7a2a729ee247", + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "RS0", + "tier": "Standard" + } + } + }, + "201": { + "body": { + "location": "westus", + "name": "swaggerExample", + "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"", + "tags": { + "TestUpdatedKey": "TestUpdatedValue" + }, + "identity": { + "tenantId": "d676e86e-2206-4a7c-999c-ece52c144b5b", + "principalId": "3137d6c7-5d6c-411c-b934-7a2a729ee247", + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "RS0", + "tier": "Standard" + } + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/PUTVaultCred.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/PUTVaultCred.json new file mode 100644 index 000000000000..1a2d387e18d5 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/PUTVaultCred.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "77777777-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "BCDRIbzRG", + "vaultName": "BCDRIbzVault", + "certificateName": "BCDRIbzVault77777777-d41f-4550-9f70-7708a3a2283b-12-18-2017-vaultcredentials", + "api-version": "2021-04-01", + "certificateRequest": { + "properties": { + "authType": "AAD", + "certificate": "MTTC3TCCAcWgAwIBAgIQEj9h+ZLlXK9KrqZX9UkAnzANBgkqhkiG9w0BAQUFADAeMRwwGgYDVQQDExNXaW5kb3dzIEF6dXJlIFRvb2xzMB4XDTE3MTIxODA5MTc1M1oXDTE3MTIyMzA5Mjc1M1owHjEcMBoGA1UEAxMTV2luZG93cyBBenVyZSBUb29sczCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK773/eZZ69RbZZAT05r9MjUxu9y1L1Pn1EgPk62IPJyHlO3OZA922eSBahhP4bgmFljN4LVReqQ5eT/wqO0Zhc+yFkUy4U4RdbQLeUZt2W7yy9XLXgVvqeYDgsjg/QhHetgHArQBW+tlQq5+zPdU7zchI4rbShSJrWhLrZFWiOyFPsuAE4joUQHNlRifdCTsBGKk8HRCY3j1S3c4bfEn3zxlrvrXXssRuW5mJM95rMk0tskoRxXSCi6i9bnlki2Cs9mpVMmBFeofs41KwzlWU0TgpdD8s1QEdvfGB5NbByfetPX7MfJaTBeHZEGbv/Iq8l72u8sPBoOhcaH7qDE/mECAwEAAaMXMBUwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQEFBQADggEBAILfgHluye1Q+WelhgWhpBBdIq2C0btfV8eFsZaTlBUrM0fwpxQSlAWc2oYHVMQI4A5iUjbDOY35O4yc+TnWKDBKf+laqDP+yos4aiUPuadGUZfvDk7kuw7xeECs64JpHAIEKdRHFW9rD3gwG+nIWaDnEL/7rTyhL3kXrRW2MSUAL8g3GX8Z45c+MQY0jmASIqWdhGn1vpAGyA9mKkzsqg7FXjg8GZb24tGl5Ky85+ip4dkBfXinDD8WwaGyjhGGK97ErvNmN36qly/H0H1Qngiovg1FbHDmkcFO5QclnEJsFFmcO2CcHp5Fqh2wXn5O1cQaxCIRTpQ/uXRpDjl2wKs=" + } + } + }, + "responses": { + "200": { + "body": { + "name": "BCDRIbzVault77777777-d41f-4550-9f70-7708a3a2283b-12-18-2017-vaultcredentials", + "type": "Microsoft.RecoveryServices/vaults/certificates", + "id": "/Subscriptions/77777777-d41f-4550-9f70-7708a3a2283b/resourceGroups/BCDRIbzRG/providers/Microsoft.RecoveryServices/vaults/BCDRIbzVault/certificates/BCDRIbzVault77777777-d41f-4550-9f70-7708a3a2283b-12-18-2017-vaultcredentials", + "properties": { + "authType": "AzureActiveDirectory", + "certificate": "MTTC3TCCAcWgAwIBAgIQEj9h+ZLlXK9KrqZX9UkAnzANBgkqhkiG9w0BAQUFADAeMRwwGgYDVQQDExNXaW5kb3dzIEF6dXJlIFRvb2xzMB4XDTE3MTIxODA5MTc1M1oXDTE3MTIyMzA5Mjc1M1owHjEcMBoGA1UEAxMTV2luZG93cyBBenVyZSBUb29sczCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK773/eZZ69RbZZAT05r9MjUxu9y1L1Pn1EgPk62IPJyHlO3OZA922eSBahhP4bgmFljN4LVReqQ5eT/wqO0Zhc+yFkUy4U4RdbQLeUZt2W7yy9XLXgVvqeYDgsjg/QhHetgHArQBW+tlQq5+zPdU7zchI4rbShSJrWhLrZFWiOyFPsuAE4joUQHNlRifdCTsBGKk8HRCY3j1S3c4bfEn3zxlrvrXXssRuW5mJM95rMk0tskoRxXSCi6i9bnlki2Cs9mpVMmBFeofs41KwzlWU0TgpdD8s1QEdvfGB5NbByfetPX7Mf JaTBeHZEGbv/Iq8l72u8sPBoOhcaH7qDE/mECAwEAAaMXMBUwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQEFBQADggEBAILfgHluye1Q+WelhgWhpBBdIq2C0btfV8eFsZaTlBUrM0fwpxQSlAWc2oYHVMQI4A5iUjbDOY35O4yc+TnWKDBKf+laqDP+yos4aiUPuadGUZfvDk7kuw7xeECs64JpHAIEKdRHFW9rD3gwG+nIWaDnEL/7rTyhL3kXrRW2MSUAL8g3GX8Z45c+MQY0jmASIqWdhGn1vpAGyA9mKkzsqg7FXjg8GZb24tGl5Ky85+ip4dkBfXinDD8WwaGyjhGGK97ErvNmN36qly/H0H1Qngiovg1FbHDmkcFO5QclnEJsFFmcO2CcHp5Fqh2wXn5O1cQaxCIRTpQ/uXRpDjl2wKs=", + "resourceId": 8726350008099341699, + "aadAuthority": "https://login.windows.net", + "aadTenantId": "9b0c2069-2eba-489f-95f4-eca15cb602ab", + "servicePrincipalClientId": "4932d0bd-b5f9-4659-94a0-7ab02d918933", + "servicePrincipalObjectId": "2d60221e-cef5-4e13-ba66-b33701a533bb", + "azureManagementEndpointAudience": "https://ppe1-id1.wus.wabppe.obs-test.com/restapi/", + "subject": "CN=Windows Azure Tools", + "validFrom": "2017-12-18T14:47:53+05:30", + "validTo": "2017-12-23T14:57:53+05:30", + "thumbprint": "019FE9BAD18A5A09A5CA53B593AF66331F3054AF", + "friendlyName": "", + "issuer": "CN=Windows Azure Tools" + } + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/PUTVault_WithCMK.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/PUTVault_WithCMK.json new file mode 100644 index 000000000000..b39d63f9d1da --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/PUTVault_WithCMK.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "Default-RecoveryServices-ResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2021-04-01", + "vault": { + "properties": { + "encryption": { + "keyVaultProperties": { + "keyUri": "https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3" + }, + "kekIdentity": { + "userAssignedIdentity": "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi" + }, + "infrastructureEncryption": "Enabled" + } + }, + "sku": { + "name": "Standard" + }, + "location": "West US", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "westus", + "name": "swaggerExample", + "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"", + "tags": { + "TestUpdatedKey": "TestUpdatedValue" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": { + "clientId": "fbe75b66-01c5-4f87-a220-233af3270436", + "principalId": "075a0ca6-43f6-4434-9abf-c9b1b79f9219" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "encryption": { + "keyVaultProperties": { + "keyUri": "https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3" + }, + "kekIdentity": { + "userAssignedIdentity": "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi", + "useSystemAssignedIdentity": false + }, + "infrastructureEncryption": "Enabled" + } + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + } + }, + "201": { + "body": { + "location": "westus", + "name": "swaggerExample", + "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"", + "tags": { + "TestUpdatedKey": "TestUpdatedValue" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": {} + } + }, + "properties": { + "provisioningState": "Provisioning", + "encryption": { + "keyVaultProperties": { + "keyUri": "https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3" + }, + "kekIdentity": { + "userAssignedIdentity": "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi", + "useSystemAssignedIdentity": false + }, + "infrastructureEncryption": "Enabled" + } + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + }, + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15" + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/PUTVault_WithUserAssignedIdentity.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/PUTVault_WithUserAssignedIdentity.json new file mode 100644 index 000000000000..48ec6e5ce56c --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/PUTVault_WithUserAssignedIdentity.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "Default-RecoveryServices-ResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2021-04-01", + "vault": { + "properties": {}, + "sku": { + "name": "Standard" + }, + "location": "West US", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "westus", + "name": "swaggerExample", + "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"", + "tags": { + "TestUpdatedKey": "TestUpdatedValue" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": { + "clientId": "fbe75b66-01c5-4f87-a220-233af3270436", + "principalId": "075a0ca6-43f6-4434-9abf-c9b1b79f9219" + } + } + }, + "properties": { + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + } + }, + "201": { + "body": { + "location": "westus", + "name": "swaggerExample", + "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"", + "tags": { + "TestUpdatedKey": "TestUpdatedValue" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": {} + } + }, + "properties": { + "provisioningState": "Provisioning" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + }, + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15" + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/PatchVault_WithCMK2.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/PatchVault_WithCMK2.json new file mode 100644 index 000000000000..384edc7979ed --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/PatchVault_WithCMK2.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "HelloWorld", + "vaultName": "swaggerExample", + "api-version": "2021-04-01", + "vault": { + "tags": { + "PatchKey": "PatchKeyUpdated" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "encryption": { + "kekIdentity": { + "useSystemAssignedIdentity": true + } + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "westus", + "name": "swaggerExample", + "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"", + "tags": { + "PatchKey": "PatchKeyUpdated" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": { + "clientId": "fbe75b66-01c5-4f87-a220-233af3270436", + "principalId": "075a0ca6-43f6-4434-9abf-c9b1b79f9219" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "encryption": { + "keyVaultProperties": { + "keyUri": "https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3" + }, + "kekIdentity": { + "useSystemAssignedIdentity": true + }, + "infrastructureEncryption": "Enabled" + } + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15", + "Location": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15" + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/UpdateVaultExtendedInfo.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/UpdateVaultExtendedInfo.json new file mode 100644 index 000000000000..2418e697552e --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/UpdateVaultExtendedInfo.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "Default-RecoveryServices-ResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2021-04-01", + "resourceResourceExtendedInfoDetails": { + "properties": { + "integrityKey": "J99wzS27fmJ+Wjot7xO5wA==", + "algorithm": "None" + } + } + }, + "responses": { + "200": { + "body": { + "name": "vaultExtendedInfo", + "etag": "f0d0260b-b92d-4458-ba0a-32c6cdabacb7", + "properties": { + "integrityKey": "J99wzS27fmJ+Wjot7xO5wA==", + "algorithm": "None" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample/extendedInformation/vaultExtendedInfo", + "type": "Microsoft.RecoveryServices/vaults/extendedInformation" + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/registeredidentities.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/registeredidentities.json new file mode 100644 index 000000000000..4152afee7664 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/registeredidentities.json @@ -0,0 +1,372 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-04-01", + "title": "RecoveryServicesClient", + "x-ms-code-generation-settings": { + "internalConstructors": false + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/certificates/{certificateName}": { + "put": { + "tags": [ + "VaultCertificates" + ], + "description": "Uploads a certificate for a resource.", + "operationId": "VaultCertificates_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "certificateName", + "in": "path", + "description": "Certificate friendly name.", + "required": true, + "type": "string" + }, + { + "name": "certificateRequest", + "in": "body", + "description": "Input parameters for uploading the vault certificate.", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultCertificateResponse" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Download vault credential file": { + "$ref": "./examples/PUTVaultCred.json" + } + } + } + }, + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/registeredIdentities/{identityName}": { + "delete": { + "tags": [ + "RegisteredIdentities" + ], + "description": "Unregisters the given container from your Recovery Services vault.", + "operationId": "RegisteredIdentities_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "identityName", + "in": "path", + "description": "Name of the protection container to unregister.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "NoContent" + } + }, + "deprecated": false, + "x-ms-examples": { + "Delete registered Identity": { + "$ref": "./examples/DeleteRegisteredIdentities.json" + } + } + } + } + }, + "definitions": { + "CertificateRequest": { + "description": "Details of the certificate to be uploaded to the vault.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RawCertificateData" + } + } + }, + "RawCertificateData": { + "description": "Raw certificate data.", + "type": "object", + "properties": { + "authType": { + "description": "Specifies the authentication type.", + "enum": [ + "Invalid", + "ACS", + "AAD", + "AccessControlService", + "AzureActiveDirectory" + ], + "type": "string", + "x-ms-enum": { + "name": "AuthType", + "modelAsString": true + } + }, + "certificate": { + "format": "byte", + "description": "The base64 encoded certificate raw data string", + "type": "string" + } + } + }, + "ResourceCertificateAndAadDetails": { + "description": "Certificate details representing the Vault credentials for AAD.", + "required": [ + "certificate", + "resourceId", + "aadAuthority", + "aadTenantId", + "servicePrincipalClientId", + "servicePrincipalObjectId", + "azureManagementEndpointAudience", + "subject", + "validFrom", + "validTo", + "thumbprint", + "friendlyName", + "issuer" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceCertificateDetails" + } + ], + "properties": { + "aadAuthority": { + "description": "AAD tenant authority.", + "type": "string" + }, + "aadTenantId": { + "description": "AAD tenant Id.", + "type": "string" + }, + "servicePrincipalClientId": { + "description": "AAD service principal clientId.", + "type": "string" + }, + "servicePrincipalObjectId": { + "description": "AAD service principal ObjectId.", + "type": "string" + }, + "azureManagementEndpointAudience": { + "description": "Azure Management Endpoint Audience.", + "type": "string" + }, + "serviceResourceId": { + "description": "Service Resource Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureActiveDirectory" + }, + "ResourceCertificateAndAcsDetails": { + "description": "Certificate details representing the Vault credentials for ACS.", + "required": [ + "certificate", + "resourceId", + "globalAcsNamespace", + "globalAcsHostName", + "globalAcsRPRealm", + "subject", + "validFrom", + "validTo", + "thumbprint", + "friendlyName", + "issuer" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceCertificateDetails" + } + ], + "properties": { + "globalAcsNamespace": { + "description": "ACS namespace name - tenant for our service.", + "type": "string" + }, + "globalAcsHostName": { + "description": "Acs mgmt host name to connect to.", + "type": "string" + }, + "globalAcsRPRealm": { + "description": "Global ACS namespace RP realm.", + "type": "string" + } + }, + "x-ms-discriminator-value": "AccessControlService" + }, + "ResourceCertificateDetails": { + "description": "Certificate details representing the Vault credentials.", + "required": [ + "authType" + ], + "type": "object", + "properties": { + "authType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + }, + "certificate": { + "format": "byte", + "description": "The base64 encoded certificate raw data string.", + "type": "string" + }, + "friendlyName": { + "description": "Certificate friendly name.", + "type": "string" + }, + "issuer": { + "description": "Certificate issuer.", + "type": "string" + }, + "resourceId": { + "format": "int64", + "description": "Resource ID of the vault.", + "type": "integer" + }, + "subject": { + "description": "Certificate Subject Name.", + "type": "string" + }, + "thumbprint": { + "description": "Certificate thumbprint.", + "type": "string" + }, + "validFrom": { + "format": "date-time", + "description": "Certificate Validity start Date time.", + "type": "string" + }, + "validTo": { + "format": "date-time", + "description": "Certificate Validity End Date time.", + "type": "string" + } + }, + "discriminator": "authType" + }, + "VaultCertificateResponse": { + "description": "Certificate corresponding to a vault that can be used by clients to register themselves with the vault.", + "type": "object", + "properties": { + "name": { + "description": "Resource name associated with the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Resource Id represents the complete path to the resource.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/ResourceCertificateDetails" + } + }, + "x-ms-azure-resource": true + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription Id.", + "required": true, + "type": "string" + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group where the recovery services vault is present.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "VaultName": { + "name": "vaultName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account." + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/replicationusages.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/replicationusages.json new file mode 100644 index 000000000000..ee59ca521875 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/replicationusages.json @@ -0,0 +1,208 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-04-01", + "title": "RecoveryServicesClient", + "x-ms-code-generation-settings": { + "internalConstructors": false + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/replicationUsages": { + "get": { + "tags": [ + "ReplicationUsages" + ], + "description": "Fetches the replication usages of the vault.", + "operationId": "ReplicationUsages_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationUsageList" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Gets Replication usages of vault": { + "$ref": "./examples/ListReplicationUsages.json" + } + } + } + } + }, + "definitions": { + "JobsSummary": { + "description": "Summary of the replication job data for this vault.", + "type": "object", + "properties": { + "failedJobs": { + "description": "Count of failed jobs.", + "type": "integer" + }, + "suspendedJobs": { + "description": "Count of suspended jobs.", + "type": "integer" + }, + "inProgressJobs": { + "description": "Count of in-progress jobs.", + "type": "integer" + } + } + }, + "MonitoringSummary": { + "description": "Summary of the replication monitoring data for this vault.", + "type": "object", + "properties": { + "unHealthyVmCount": { + "description": "Count of unhealthy VMs.", + "type": "integer" + }, + "unHealthyProviderCount": { + "description": "Count of unhealthy replication providers.", + "type": "integer" + }, + "eventsCount": { + "description": "Count of all critical warnings.", + "type": "integer" + }, + "deprecatedProviderCount": { + "description": "Count of all deprecated recovery service providers.", + "type": "integer" + }, + "supportedProviderCount": { + "description": "Count of all the supported recovery service providers.", + "type": "integer" + }, + "unsupportedProviderCount": { + "description": "Count of all the unsupported recovery service providers.", + "type": "integer" + } + } + }, + "ReplicationUsage": { + "description": "Replication usages of a vault.", + "type": "object", + "properties": { + "monitoringSummary": { + "$ref": "#/definitions/MonitoringSummary", + "description": "Summary of the replication monitoring data for this vault." + }, + "jobsSummary": { + "$ref": "#/definitions/JobsSummary", + "description": "Summary of the replication jobs data for this vault." + }, + "protectedItemCount": { + "description": "Number of replication protected items for this vault.", + "type": "integer" + }, + "recoveryPlanCount": { + "description": "Number of replication recovery plans for this vault.", + "type": "integer" + }, + "registeredServersCount": { + "description": "Number of servers registered to this vault.", + "type": "integer" + }, + "recoveryServicesProviderAuthType": { + "description": "The authentication type of recovery service providers in the vault.", + "type": "integer" + } + } + }, + "ReplicationUsageList": { + "description": "Replication usages for vault.", + "type": "object", + "properties": { + "value": { + "description": "The list of replication usages for the given vault.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationUsage" + } + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription Id.", + "required": true, + "type": "string" + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group where the recovery services vault is present.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "VaultName": { + "name": "vaultName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account." + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/vaults.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/vaults.json new file mode 100644 index 000000000000..3cfd3f360392 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/vaults.json @@ -0,0 +1,1798 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-04-01", + "title": "RecoveryServicesClient", + "x-ms-code-generation-settings": { + "internalConstructors": false + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateLinkResources": { + "get": { + "tags": [ + "ListPrivateLinkResources" + ], + "summary": "Returns the list of private link resources that need to be created for Backup and SiteRecovery", + "operationId": "PrivateLinkResources_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResources" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + }, + "x-ms-examples": { + "List PrivateLinkResources": { + "$ref": "./examples/ListPrivateLinkResources.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateLinkResources/{privateLinkResourceName}": { + "get": { + "tags": [ + "GetPrivateLinkResources" + ], + "summary": "Returns a specified private link resource that need to be created for Backup and SiteRecovery", + "operationId": "PrivateLinkResources_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "privateLinkResourceName", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Get PrivateLinkResource": { + "$ref": "./examples/GetPrivateLinkResources.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/locations/{location}/checkNameAvailability": { + "post": { + "tags": [ + "RecoveryServices" + ], + "summary": "API to check for resource name availability.\r\nA name is available if no other resource exists that has the same SubscriptionId, Resource Name and Type\r\nor if one or more such resources exist, each of these must be GC'd and their time of deletion be more than 24 Hours Ago", + "operationId": "RecoveryServices_CheckNameAvailability", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "location", + "in": "path", + "description": "Location of the resource", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Contains information about Resource type and Resource name", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityParameters" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Availability status of Resource Name when no resource with same name, type and subscription exists, nor has been deleted within last 24 hours": { + "$ref": "./examples/CheckNameAvailability_Available.json" + }, + "Availability status of Resource Name when resource with same name, type and subscription exists": { + "$ref": "./examples/CheckNameAvailability_NotAvailable.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/vaults": { + "get": { + "tags": [ + "Vaults" + ], + "description": "Fetches all the resources of the specified type in the subscription.", + "operationId": "Vaults_ListBySubscriptionId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + }, + "x-ms-examples": { + "List of Recovery Services Resources in SubscriptionId": { + "$ref": "./examples/ListBySubscriptionIds.json" + } + } + } + }, + "/providers/Microsoft.RecoveryServices/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Returns the list of available operations.", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClientDiscoveryResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + }, + "x-ms-examples": { + "ListOperations": { + "$ref": "./examples/ListOperations.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults": { + "get": { + "tags": [ + "Vaults" + ], + "description": "Retrieve a list of Vaults.", + "operationId": "Vaults_ListByResourceGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + }, + "x-ms-examples": { + "List of Recovery Services Resources in ResourceGroup": { + "$ref": "./examples/ListResources.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}": { + "get": { + "tags": [ + "Vaults" + ], + "description": "Get the Vault details.", + "operationId": "Vaults_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Vault" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Get Recovery Services Resource": { + "$ref": "./examples/GETVault.json" + } + } + }, + "put": { + "tags": [ + "Vaults" + ], + "description": "Creates or updates a Recovery Services vault.", + "operationId": "Vaults_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "vault", + "in": "body", + "description": "Recovery Services Vault to be created.", + "required": true, + "schema": { + "$ref": "#/definitions/Vault" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Vault" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Vault" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Create or Update Recovery Services vault": { + "$ref": "./examples/PUTVault.json" + }, + "Create or Update Vault with User Assigned Identity": { + "$ref": "./examples/PUTVault_WithUserAssignedIdentity.json" + }, + "Create or Update Vault with CustomerManagedKeys": { + "$ref": "./examples/PUTVault_WithCMK.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Vaults" + ], + "description": "Deletes a vault.", + "operationId": "Vaults_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Delete Recovery Services Vault": { + "$ref": "./examples/DeleteVault.json" + } + } + }, + "patch": { + "tags": [ + "Vaults" + ], + "description": "Updates the vault.", + "operationId": "Vaults_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "vault", + "in": "body", + "description": "Recovery Services Vault to be created.", + "required": true, + "schema": { + "$ref": "#/definitions/PatchVault" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Vault" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Update Resource": { + "$ref": "./examples/PATCHVault.json" + }, + "Update Resource With User Assigned Identity": { + "$ref": "./examples/PATCHVault_WithUserAssignedIdentity.json" + }, + "Update Resource With CustomerManagedKeys": { + "$ref": "./examples/PATCHVault_WithCMK.json" + }, + "Update Resource With CustomerManagedKeys2": { + "$ref": "./examples/PatchVault_WithCMK2.json" + }, + "Update Resource With CustomerManagedKeys3": { + "$ref": "./examples/PATCHVault_WithCMK3.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/extendedInformation/vaultExtendedInfo": { + "get": { + "tags": [ + "VaultExtendedInfo" + ], + "description": "Get the vault extended info.", + "operationId": "VaultExtendedInfo_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultExtendedInfoResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Get ExtendedInfo of Resource": { + "$ref": "./examples/GETVaultExtendedInfo.json" + } + } + }, + "put": { + "tags": [ + "VaultExtendedInfo" + ], + "description": "Create vault extended info.", + "operationId": "VaultExtendedInfo_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "resourceResourceExtendedInfoDetails", + "in": "body", + "description": "Details of ResourceExtendedInfo", + "required": true, + "schema": { + "$ref": "#/definitions/VaultExtendedInfoResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultExtendedInfoResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Put ExtendedInfo of Resource": { + "$ref": "./examples/UpdateVaultExtendedInfo.json" + } + } + }, + "patch": { + "tags": [ + "VaultExtendedInfo" + ], + "description": "Update vault extended info.", + "operationId": "VaultExtendedInfo_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "resourceResourceExtendedInfoDetails", + "in": "body", + "description": "Details of ResourceExtendedInfo", + "required": true, + "schema": { + "$ref": "#/definitions/VaultExtendedInfoResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultExtendedInfoResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "PATCH ExtendedInfo of Resource": { + "$ref": "./examples/UpdateVaultExtendedInfo.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/operationStatus/{operationId}": { + "get": { + "tags": [ + "Vaults" + ], + "description": "Gets the operation status for a resource.", + "operationId": "GetOperationStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Operation Status": { + "$ref": "./examples/GetOperationStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/operationResults/{operationId}": { + "get": { + "tags": [ + "Vaults" + ], + "description": "Gets the operation result for a resource.", + "operationId": "GetOperationResult", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Vault" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Operation Result": { + "$ref": "./examples/GetOperationResult.json" + } + } + } + } + }, + "definitions": { + "CheckNameAvailabilityParameters": { + "description": "Resource Name availability input parameters - Resource type and resource name", + "type": "object", + "properties": { + "type": { + "description": "Describes the Resource type: Microsoft.RecoveryServices/Vaults", + "type": "string" + }, + "name": { + "description": "Resource name for which availability needs to be checked", + "type": "string" + } + } + }, + "CheckNameAvailabilityResult": { + "description": "Response for check name availability API. Resource provider will set availability as true | false.", + "type": "object", + "properties": { + "nameAvailable": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "ClientDiscoveryDisplay": { + "description": "Localized display information of an operation.", + "type": "object", + "properties": { + "provider": { + "description": "Name of the provider for display purposes", + "type": "string" + }, + "resource": { + "description": "ResourceType for which this Operation can be performed.", + "type": "string" + }, + "operation": { + "description": "Operations Name itself.", + "type": "string" + }, + "description": { + "description": "Description of the operation having details of what operation is about.", + "type": "string" + } + } + }, + "ClientDiscoveryForLogSpecification": { + "description": "Class to represent shoebox log specification in json client discovery.", + "type": "object", + "properties": { + "name": { + "description": "Name of the log.", + "type": "string" + }, + "displayName": { + "description": "Localized display name", + "type": "string" + }, + "blobDuration": { + "description": "Blobs created in customer storage account per hour", + "type": "string" + } + } + }, + "ClientDiscoveryForProperties": { + "description": "Class to represent shoebox properties in json client discovery.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ClientDiscoveryForServiceSpecification", + "description": "Operation properties." + } + } + }, + "ClientDiscoveryForServiceSpecification": { + "description": "Class to represent shoebox service specification in json client discovery.", + "type": "object", + "properties": { + "logSpecifications": { + "description": "List of log specifications of this operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ClientDiscoveryForLogSpecification" + } + } + } + }, + "ClientDiscoveryResponse": { + "description": "Operations List response which contains list of available APIs.", + "type": "object", + "properties": { + "value": { + "description": "List of available operations.", + "type": "array", + "items": { + "$ref": "#/definitions/ClientDiscoveryValueForSingleApi" + } + }, + "nextLink": { + "description": "Link to the next chunk of the response", + "type": "string" + } + } + }, + "ClientDiscoveryValueForSingleApi": { + "description": "Available operation details.", + "type": "object", + "properties": { + "name": { + "description": "Name of the Operation.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/ClientDiscoveryDisplay", + "description": "Contains the localized display information for this particular operation" + }, + "origin": { + "description": "The intended executor of the operation;governs the display of the operation in the RBAC UX and the audit logs UX", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/ClientDiscoveryForProperties", + "description": "ShoeBox properties for the given operation." + } + } + }, + "Resource": { + "description": "ARM Resource.", + "type": "object", + "properties": { + "id": { + "description": "Resource Id represents the complete path to the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource name associated with the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...", + "type": "string", + "readOnly": true + }, + "etag": { + "description": "Optional ETag.", + "type": "string" + } + }, + "x-ms-azure-resource": true + }, + "Sku": { + "description": "Identifies the unique system identifier for each Azure resource.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The Sku name.", + "enum": [ + "Standard", + "RS0" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "tier": { + "description": "The Sku tier.", + "type": "string" + }, + "family": { + "description": "The sku family", + "type": "string" + }, + "size": { + "description": "The sku size", + "type": "string" + }, + "capacity": { + "description": "The sku capacity", + "type": "string" + } + } + }, + "TrackedResource": { + "description": "Tracked resource with location.", + "type": "object", + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "description": "Resource location.", + "type": "string" + }, + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "PatchTrackedResource": { + "description": "Tracked resource with location.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "description": "Resource location.", + "type": "string" + }, + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "UpgradeDetails": { + "description": "Details for upgrading vault.", + "type": "object", + "properties": { + "operationId": { + "description": "ID of the vault upgrade operation.", + "type": "string", + "readOnly": true + }, + "startTimeUtc": { + "description": "UTC time at which the upgrade operation has started.", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "lastUpdatedTimeUtc": { + "description": "UTC time at which the upgrade operation status was last updated.", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "endTimeUtc": { + "description": "UTC time at which the upgrade operation has ended.", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "status": { + "description": "Status of the vault upgrade operation.", + "enum": [ + "Unknown", + "InProgress", + "Upgraded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VaultUpgradeState", + "modelAsString": true + } + }, + "message": { + "description": "Message to the user containing information about the upgrade operation.", + "type": "string", + "readOnly": true + }, + "triggerType": { + "description": "The way the vault upgrade was triggered.", + "enum": [ + "UserTriggered", + "ForcedUpgrade" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "TriggerType", + "modelAsString": true + } + }, + "upgradedResourceId": { + "description": "Resource ID of the upgraded vault.", + "type": "string", + "readOnly": true + }, + "previousResourceId": { + "description": "Resource ID of the vault before the upgrade.", + "type": "string", + "readOnly": true + } + } + }, + "Vault": { + "description": "Resource information, as returned by the resource provider.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "$ref": "#/definitions/IdentityData" + }, + "properties": { + "$ref": "#/definitions/VaultProperties" + }, + "sku": { + "$ref": "#/definitions/Sku" + }, + "systemData": { + "$ref": "#/definitions/systemData" + } + } + }, + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "type": "string", + "description": "The type of identity that created the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)." + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "type": "string", + "description": "The type of identity that last modified the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The type of identity that last modified the resource." + } + } + }, + "PatchVault": { + "description": "Patch Resource information, as returned by the resource provider.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PatchTrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/VaultProperties" + }, + "sku": { + "$ref": "#/definitions/Sku" + }, + "identity": { + "$ref": "#/definitions/IdentityData" + } + } + }, + "VaultExtendedInfo": { + "description": "Vault extended information.", + "type": "object", + "properties": { + "integrityKey": { + "description": "Integrity key.", + "type": "string" + }, + "encryptionKey": { + "description": "Encryption key.", + "type": "string" + }, + "encryptionKeyThumbprint": { + "description": "Encryption key thumbprint.", + "type": "string" + }, + "algorithm": { + "description": "Algorithm for Vault ExtendedInfo", + "type": "string" + } + } + }, + "VaultExtendedInfoResource": { + "description": "Vault extended information.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/VaultExtendedInfo", + "x-ms-client-flatten": true + } + } + }, + "VaultList": { + "description": "The response model for a list of Vaults.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Vault" + } + }, + "nextLink": { + "type": "string", + "readOnly": true + } + } + }, + "VaultProperties": { + "description": "Properties of the vault.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning State.", + "type": "string", + "readOnly": true + }, + "upgradeDetails": { + "$ref": "#/definitions/UpgradeDetails" + }, + "privateEndpointConnections": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnectionVaultProperties" + }, + "description": "List of private endpoint connection.", + "readOnly": true + }, + "privateEndpointStateForBackup": { + "description": "Private endpoint state for backup.", + "enum": [ + "None", + "Enabled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VaultPrivateEndpointState", + "modelAsString": true + } + }, + "privateEndpointStateForSiteRecovery": { + "description": "Private endpoint state for site recovery.", + "enum": [ + "None", + "Enabled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VaultPrivateEndpointState", + "modelAsString": true + } + }, + "encryption": { + "description": "Customer Managed Key details of the resource.", + "type": "object", + "properties": { + "keyVaultProperties": { + "$ref": "#/definitions/CmkKeyVaultProperties" + }, + "kekIdentity": { + "$ref": "#/definitions/CmkKekIdentity" + }, + "infrastructureEncryption": { + "description": "Enabling/Disabling the Double Encryption state", + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "InfrastructureEncryptionState", + "modelAsString": true + } + } + } + }, + "moveDetails": { + "description": "The details of the latest move operation performed on the Azure Resource", + "type": "object", + "properties": { + "operationId": { + "description": "OperationId of the Resource Move Operation", + "type": "string", + "readOnly": true + }, + "startTimeUtc": { + "description": "Start Time of the Resource Move Operation", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "completionTimeUtc": { + "description": "End Time of the Resource Move Operation", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "sourceResourceId": { + "description": "Source Resource of the Resource Move Operation", + "type": "string", + "readOnly": true + }, + "targetResourceId": { + "description": "Target Resource of the Resource Move Operation", + "type": "string", + "readOnly": true + } + } + }, + "moveState": { + "description": "The State of the Resource after the move operation", + "type": "string", + "readOnly": true, + "enum": [ + "Unknown", + "InProgress", + "PrepareFailed", + "CommitFailed", + "PrepareTimedout", + "CommitTimedout", + "MoveSucceeded", + "Failure", + "CriticalFailure", + "PartialSuccess" + ], + "x-ms-enum": { + "name": "ResourceMoveState", + "modelAsString": true + } + } + } + }, + "IdentityData": { + "required": [ + "type" + ], + "type": "object", + "description": "Identity for the resource.", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of resource identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID of resource." + }, + "type": { + "type": "string", + "description": "The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities.", + "enum": [ + "SystemAssigned", + "None", + "UserAssigned", + "SystemAssigned, UserAssigned" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": true + } + }, + "userAssignedIdentities": { + "description": "The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserIdentity" + } + } + } + }, + "UserIdentity": { + "type": "object", + "description": "A resource identity that is managed by the user of the service.", + "properties": { + "principalId": { + "description": "The principal ID of the user-assigned identity.", + "type": "string", + "readOnly": true + }, + "clientId": { + "description": "The client ID of the user-assigned identity.", + "type": "string", + "readOnly": true + } + } + }, + "PrivateEndpointConnectionVaultProperties": { + "description": "Information to be stored in Vault properties as an element of privateEndpointConnections List.", + "readOnly": true, + "type": "object", + "properties": { + "id": { + "description": "Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}.", + "readOnly": true, + "type": "string" + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "name": { + "description": "The name of the private Endpoint Connection", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type, which will be of the format, Microsoft.RecoveryServices/vaults/privateEndpointConnections", + "type": "string", + "readOnly": true + }, + "location": { + "description": "The location of the private Endpoint connection", + "type": "string", + "readOnly": true + } + } + }, + "PrivateEndpointConnection": { + "description": "Private Endpoint Connection Response Properties.", + "readOnly": true, + "type": "object", + "properties": { + "provisioningState": { + "description": "Gets or sets provisioning state of the private endpoint connection.", + "readOnly": true, + "enum": [ + "Succeeded", + "Deleting", + "Failed", + "Pending" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState" + } + } + }, + "PrivateEndpoint": { + "description": "The Private Endpoint network resource that is linked to the Private Endpoint connection.", + "readOnly": true, + "type": "object", + "properties": { + "id": { + "description": "Gets or sets id.", + "readOnly": true, + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "Gets or sets private link service connection state.", + "readOnly": true, + "type": "object", + "properties": { + "status": { + "description": "Gets or sets the status.", + "readOnly": true, + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateEndpointConnectionStatus", + "modelAsString": true + } + }, + "description": { + "description": "Gets or sets description.", + "readOnly": true, + "type": "string" + }, + "actionsRequired": { + "description": "Gets or sets actions required.", + "readOnly": true, + "type": "string" + } + } + }, + "PrivateLinkResources": { + "description": "Class which represent the stamps associated with the vault.", + "readOnly": true, + "type": "object", + "properties": { + "value": { + "description": "A collection of private link resources", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "description": "Link to the next chunk of the response", + "type": "string" + } + } + }, + "PrivateLinkResource": { + "description": "Information of the private link resource.", + "readOnly": true, + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties", + "x-ms-client-flatten": true + }, + "id": { + "description": "Fully qualified identifier of the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "e.g. Microsoft.RecoveryServices/vaults/privateLinkResources", + "readOnly": true, + "type": "string" + } + } + }, + "PrivateLinkResourceProperties": { + "type": "object", + "description": "Properties of the private link resource.", + "properties": { + "groupId": { + "description": "e.g. f9ad6492-33d4-4690-9999-6bfd52a0d081 (Backup) or f9ad6492-33d4-4690-9999-6bfd52a0d082 (SiteRecovery)", + "readOnly": true, + "type": "string" + }, + "requiredMembers": { + "description": "[backup-ecs1, backup-prot1, backup-prot1b, backup-prot1c, backup-id1]", + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + }, + "requiredZoneNames": { + "description": "The private link resource Private link DNS zone name.", + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "CmkKeyVaultProperties": { + "type": "object", + "description": "The properties of the Key Vault which hosts CMK", + "properties": { + "keyUri": { + "description": "The key uri of the Customer Managed Key", + "type": "string" + } + } + }, + "CmkKekIdentity": { + "type": "object", + "description": "The details of the identity used for CMK", + "properties": { + "useSystemAssignedIdentity": { + "type": "boolean", + "description": "Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field" + }, + "userAssignedIdentity": { + "type": "string", + "description": "The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned" + } + } + }, + "OperationResource": { + "type": "object", + "description": "Operation Resource", + "properties": { + "endTime": { + "description": "End time of the operation", + "format": "date-time", + "type": "string" + }, + "error": { + "$ref": "#/definitions/Error", + "description": "Required if status == failed or status == canceled. This is the OData v4 error format, used by the RPC and will go into the v2.2 Azure REST API guidelines." + }, + "id": { + "description": "It should match what is used to GET the operation result", + "type": "string" + }, + "name": { + "description": "It must match the last segment of the \"id\" field, and will typically be a GUID / system generated value", + "type": "string" + }, + "status": { + "description": "The status of the operation. (InProgress/Success/Failed/Cancelled)", + "type": "string" + }, + "startTime": { + "description": "Start time of the operation", + "format": "date-time", + "type": "string" + } + } + }, + "CloudError": { + "description": "An error response from Azure Backup.", + "properties": { + "error": { + "$ref": "#/definitions/Error" + } + }, + "title": "CloudError", + "x-ms-external": true + }, + "Error": { + "description": "The resource management error response.", + "properties": { + "additionalInfo": { + "description": "The error additional info.", + "items": { + "$ref": "#/definitions/ErrorAdditionalInfo" + }, + "readOnly": true, + "type": "array" + }, + "code": { + "description": "The error code.", + "readOnly": true, + "type": "string" + }, + "details": { + "description": "The error details.", + "items": { + "$ref": "#/definitions/Error" + }, + "readOnly": true, + "type": "array" + }, + "message": { + "description": "The error message.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "The error target.", + "readOnly": true, + "type": "string" + } + } + }, + "ErrorAdditionalInfo": { + "description": "The resource management error additional info.", + "properties": { + "info": { + "description": "The additional info.", + "readOnly": true, + "type": "object" + }, + "type": { + "description": "The additional info type.", + "readOnly": true, + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription Id.", + "required": true, + "type": "string" + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group where the recovery services vault is present.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "VaultName": { + "name": "vaultName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account." + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/vaultusages.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/vaultusages.json new file mode 100644 index 000000000000..50609710cebb --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/vaultusages.json @@ -0,0 +1,189 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-04-01", + "title": "RecoveryServicesClient", + "x-ms-code-generation-settings": { + "internalConstructors": false + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/usages": { + "get": { + "tags": [ + "VaultUsages" + ], + "description": "Fetches the usages of the vault.", + "operationId": "Usages_ListByVaults", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultUsageList" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Gets vault usages": { + "$ref": "./examples/ListUsages.json" + } + } + } + } + }, + "definitions": { + "VaultUsage": { + "description": "Usages of a vault.", + "type": "object", + "properties": { + "unit": { + "description": "Unit of the usage.", + "enum": [ + "Count", + "Bytes", + "Seconds", + "Percent", + "CountPerSecond", + "BytesPerSecond" + ], + "type": "string", + "x-ms-enum": { + "name": "UsagesUnit", + "modelAsString": true + } + }, + "quotaPeriod": { + "description": "Quota period of usage.", + "type": "string" + }, + "nextResetTime": { + "format": "date-time", + "description": "Next reset time of usage.", + "type": "string" + }, + "currentValue": { + "format": "int64", + "description": "Current value of usage.", + "type": "integer" + }, + "limit": { + "format": "int64", + "description": "Limit of usage.", + "type": "integer" + }, + "name": { + "$ref": "#/definitions/NameInfo", + "description": "Name of usage." + } + } + }, + "VaultUsageList": { + "description": "Usage for vault.", + "type": "object", + "properties": { + "value": { + "description": "The list of usages for the given vault.", + "type": "array", + "items": { + "$ref": "#/definitions/VaultUsage" + } + } + } + }, + "NameInfo": { + "description": "The name of usage.", + "type": "object", + "properties": { + "value": { + "description": "Value of usage.", + "type": "string" + }, + "localizedValue": { + "description": "Localized value of usage.", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription Id.", + "required": true, + "type": "string" + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group where the recovery services vault is present.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "VaultName": { + "name": "vaultName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account." + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/CheckNameAvailability_Available.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/CheckNameAvailability_Available.json new file mode 100644 index 000000000000..23aade7e808a --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/CheckNameAvailability_Available.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "resGroupFoo", + "api-version": "2021-06-01", + "location": "westus", + "input": { + "name": "swaggerExample", + "type": "Microsoft.RecoveryServices/Vaults" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/CheckNameAvailability_NotAvailable.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/CheckNameAvailability_NotAvailable.json new file mode 100644 index 000000000000..8e7024b7c924 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/CheckNameAvailability_NotAvailable.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "resGroupBar", + "api-version": "2021-06-01", + "location": "westus", + "input": { + "name": "swaggerExample2", + "type": "Microsoft.RecoveryServices/Vaults" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "Resource already exists with the same name." + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/DeleteRegisteredIdentities.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/DeleteRegisteredIdentities.json new file mode 100644 index 000000000000..e3b5c1bdd67e --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/DeleteRegisteredIdentities.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "77777777-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "BCDRIbzRG", + "vaultName": "BCDRIbzVault", + "identityName": "dpmcontainer01", + "api-version": "2021-06-01" + }, + "responses": { + "204": {} + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/DeleteVault.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/DeleteVault.json new file mode 100644 index 000000000000..2eb1068128a3 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/DeleteVault.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "Default-RecoveryServices-ResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2021-06-01" + }, + "responses": { + "200": {} + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/GETVault.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/GETVault.json new file mode 100644 index 000000000000..697a8c7f4b9b --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/GETVault.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "Default-RecoveryServices-ResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "location": "westus", + "name": "swaggerExample", + "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"", + "tags": { + "TestUpdatedKey": "TestUpdatedValue" + }, + "identity": { + "tenantId": "d676e86e-2206-4a7c-999c-ece52c144b5b", + "principalId": "3137d6c7-5d6c-411c-b934-7a2a729ee247", + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpointConnections": [ + { + "id": "/subscriptions/6c48fa17-39c7-45f1-90ac-47a587128ace/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/Vaults/pemsi-ecy-rsv2/privateEndpointConnections/pe114-pemsi-ecy-rsv.5944358949303501042.backup.75061caa-cba4-4849-8e09-608da4914aad", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/6c48fa17-39c7-45f1-90ac-47a587128ace/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.Network/privateEndpoints/pe114-pemsi-ecy-rsv" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "None", + "actionsRequired": "None" + } + } + } + ], + "privateEndpointStateForBackup": "Enabled", + "privateEndpointStateForSiteRecovery": "None" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/GETVaultExtendedInfo.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/GETVaultExtendedInfo.json new file mode 100644 index 000000000000..e387fa18666e --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/GETVaultExtendedInfo.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "Default-RecoveryServices-ResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "name": "vaultExtendedInfo", + "etag": "f0d0260b-b92d-4458-ba0a-32c6cdabacb7", + "properties": { + "integrityKey": "J09wzS27fnJ+Wjot7xO5wA==", + "algorithm": "None" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample/extendedInformation/vaultExtendedInfo", + "type": "Microsoft.RecoveryServices/vaults/extendedInformation" + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/GetOperationResult.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/GetOperationResult.json new file mode 100644 index 000000000000..cee22b5d2d06 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/GetOperationResult.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "HelloWorld", + "vaultName": "swaggerExample", + "operationId": "YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==", + "api-version": "2021-06-01" + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15", + "Location": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15" + } + }, + "200": { + "body": { + "location": "westus", + "name": "swaggerExample", + "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"", + "tags": { + "PatchKey": "PatchKeyUpdated" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": { + "clientId": "fbe75b66-01c5-4f87-a220-233af3270436", + "principalId": "075a0ca6-43f6-4434-9abf-c9b1b79f9219" + } + } + }, + "properties": { + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/GetOperationStatus.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/GetOperationStatus.json new file mode 100644 index 000000000000..aa6d827e868d --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/GetOperationStatus.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "HelloWorld", + "vaultName": "swaggerExample", + "operationId": "YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==", + "name": "YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==", + "status": "Succeeded", + "startTime": "2019-11-20T09:49:44.0478496Z", + "endTime": "2019-11-20T09:49:46Z" + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/GetPrivateLinkResources.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/GetPrivateLinkResources.json new file mode 100644 index 000000000000..ec7a39fe251a --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/GetPrivateLinkResources.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "6c48fa17-39c7-45f1-90ac-47a587128ace", + "resourceGroupName": "petesting", + "vaultName": "pemsi-ecy-rsv2", + "api-version": "2021-06-01", + "privateLinkResourceName": "backupResource" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/6c48fa17-39c7-45f1-90ac-47a587128ace/resourceGroups/petesting/providers/Microsoft.RecoveryServices/Vaults/pemsi-ecy-rsv2/privateLinkResources/backupResource", + "name": "backupResource", + "type": "Microsoft.RecoveryServices/Vaults/privateLinkResources", + "properties": { + "groupId": "AzureBackup", + "requiredMembers": [ + "backup-fab1", + "backup-rec2", + "backup-prot1", + "backup-ecs1", + "backup-tel1", + "backup-wbcm1", + "backup-fc1", + "backup-id1" + ], + "requiredZoneNames": [ + "privatelink.ecy.backup.windowsazure.com", + "privatelink.queue.core.windows.net", + "privatelink.blob.core.windows.net" + ] + } + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ListBySubscriptionIds.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ListBySubscriptionIds.json new file mode 100644 index 000000000000..ee8faa787b53 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ListBySubscriptionIds.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "westus", + "name": "patchtest", + "etag": "W/\"datetime'2017-11-22T11%3A05%3A19.907Z'\"", + "tags": { + "Love": "India" + }, + "properties": { + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/patchtest", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + }, + { + "location": "westus", + "name": "swaggerExample", + "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"", + "tags": { + "TestUpdatedKey": "TestUpdatedValue" + }, + "properties": { + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + }, + { + "location": "westus", + "name": "today1", + "etag": "W/\"datetime'2017-11-21T10%3A52%3A19.633Z'\"", + "tags": { + "TestUpdatedKey": "TestUpdatedValue" + }, + "properties": { + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/today1", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ListOperations.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ListOperations.json new file mode 100644 index 000000000000..3937248fb596 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ListOperations.json @@ -0,0 +1,463 @@ +{ + "parameters": { + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "microsoft.recoveryservices/vaults/usages/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Vault Usage", + "operation": "Recovery Services Vault usage details.", + "description": "Returns usage details for a Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupUsageSummaries/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Usages Summaries", + "operation": "Recovery Services Protected Items and Protected Servers usage summaries details.", + "description": "Returns summaries for Protected Items and Protected Servers for a Recovery Services ." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/storageConfig/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Vault Storage Config", + "operation": "Get Resource Storage Config", + "description": "Returns Storage Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/storageConfig/write", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Vault Storage Config", + "operation": "Write Resource Storage Config", + "description": "Updates Storage Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupconfig/vaultconfig/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Vault Config", + "operation": "Get Resource Config", + "description": "Returns Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupconfig/vaultconfig/write", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Vault Config", + "operation": "Update Resource Config", + "description": "Updates Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/tokenInfo/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Token Info", + "operation": "Get Vault Token Info", + "description": "Returns token information for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupSecurityPIN/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "SecurityPINInfo", + "operation": "Get Security PIN Info", + "description": "Returns Security PIN Information for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupManagementMetaData/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Management Metadata", + "operation": "Get Backup Management Metadata", + "description": "Returns Backup Management Metadata for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupOperationResults/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Operation Results", + "operation": "Get Backup Operation Result", + "description": "Returns Backup Operation Result for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupOperations/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Operation Status", + "operation": "Get Backup Operation Status", + "description": "Returns Backup Operation Status for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupJobs/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Jobs", + "operation": "Get Jobs", + "description": "Returns all Job Objects" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupJobs/cancel/action", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Jobs", + "operation": "Cancel Jobs", + "description": "Cancel the Job" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupJobsExport/action", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Export Backup Jobs", + "operation": "Export Jobs", + "description": "Export Jobs" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupJobs/operationResults/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Jobs Operation Results", + "operation": "Get Job Operation Result", + "description": "Returns the Result of Job Operation." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupJobsExport/operationResults/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Export Backup Jobs Operation Results", + "operation": "Get Export Job Operation Result", + "description": "Returns the Result of Export Job Operation." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Recovery Points", + "operation": "Get Recovery Points", + "description": "Get Recovery Points for Protected Items." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/restore/action", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Recovery Points", + "operation": "Restore Recovery Points", + "description": "Restore Recovery Points for Protected Items." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/provisionInstantItemRecovery/action", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Recovery Points", + "operation": "Provision Instant Item Recovery for Protected Item", + "description": "Provision Instant Item Recovery for Protected Item" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/revokeInstantItemRecovery/action", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Recovery Points", + "operation": "Revoke Instant Item Recovery for Protected Item", + "description": "Revoke Instant Item Recovery for Protected Item" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupPolicies/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Policies", + "operation": "Get Protection Policy", + "description": "Returns all Protection Policies" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupPolicies/write", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Policies", + "operation": "Create Protection Policy", + "description": "Creates Protection Policy" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupPolicies/delete", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Policies", + "operation": "Delete Protection Policy", + "description": "Delete a Protection Policy" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupPolicies/operationResults/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Policy Operation Results", + "operation": "Get Policy Operation Results", + "description": "Get Results of Policy Operation." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupPolicies/operationsStatus/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Policy Operation Status", + "operation": "Get Policy Operation Status", + "description": "Get Status of Policy Operation." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protected Items", + "operation": "Get Protected Item Details", + "description": "Returns object details of the Protected Item" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupProtectedItems/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protected Items", + "operation": "Get All Protected Items", + "description": "Returns the list of all Protected Items." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/write", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protected Items", + "operation": "Create Backup Protected Item", + "description": "Create a backup Protected Item" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/delete", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protected Items", + "operation": "Delete Protected Items", + "description": "Deletes Protected Item" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/operationResults/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protected Item Operation Results", + "operation": "Get Protected Items Operation Results", + "description": "Gets Result of Operation Performed on Protected Items." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/operationsStatus/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protected Item Operation Status", + "operation": "Get Protected Items operation status", + "description": "Returns the status of Operation performed on Protected Items." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/backup/action", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protected Items", + "operation": "Backup Protected Item", + "description": "Performs Backup for Protected Item." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupProtectableItems/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Protectable Items", + "operation": "Get Protectable Items", + "description": "Returns list of all Protectable Items." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/refreshContainers/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Refresh Containers", + "operation": "Refresh container", + "description": "Refreshes the container list" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/operationResults/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Refresh Containers Operation Results", + "operation": "Get Operation Results", + "description": "Returns status of the operation" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupProtectionContainers/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Protection Containers", + "operation": "Get Containers In Subscription", + "description": "Returns all containers belonging to the subscription" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protection Containers", + "operation": "Get Registered Container", + "description": "Returns all registered containers" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/operationResults/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protection Containers Operation Results", + "operation": "Get Container Operation Results", + "description": "Gets result of Operation performed on Protection Container." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupEngines", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Engines", + "operation": "List of backup management servers.", + "description": "Returns all the backup management servers registered with vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupStatus", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Status", + "operation": "Check Backup Status for Vault", + "description": "Check Backup Status for Recovery Services Vaults" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupPreValidateProtection", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "PreValidate Protection", + "operation": "Pre Validate Enable Protection", + "description": "" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupValidateFeatures", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Validate Features", + "operation": "Validate Features", + "description": "Validate Features" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/backupProtectionIntent/write", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protection Intent", + "operation": "Create backup Protection Intent", + "description": "Create a backup Protection Intent" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/{fabricName}/protectionContainers/{containerName}/items/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Workload Items", + "operation": "Get all items in a container", + "description": "Get all items in a container" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/inquire/action", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protection Containers Inquire", + "operation": "Get all items in a container", + "description": "Get all items in a container" + }, + "origin": "user" + } + ] + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ListPrivateLinkResources.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ListPrivateLinkResources.json new file mode 100644 index 000000000000..9841029fa564 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ListPrivateLinkResources.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "6c48fa17-39c7-45f1-90ac-47a587128ace", + "resourceGroupName": "petesting", + "vaultName": "pemsi-ecy-rsv2", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/6c48fa17-39c7-45f1-90ac-47a587128ace/resourceGroups/petesting/providers/Microsoft.RecoveryServices/Vaults/pemsi-ecy-rsv2/privateLinkResources/backupResource", + "name": "backupResource", + "type": "Microsoft.RecoveryServices/Vaults/privateLinkResources", + "properties": { + "groupId": "AzureBackup", + "requiredMembers": [ + "backup-fab1", + "backup-rec2", + "backup-prot1", + "backup-ecs1", + "backup-tel1", + "backup-wbcm1", + "backup-fc1", + "backup-id1" + ], + "requiredZoneNames": [ + "privatelink.ecy.backup.windowsazure.com", + "privatelink.queue.core.windows.net", + "privatelink.blob.core.windows.net" + ] + } + }, + { + "id": "/subscriptions/6c48fa17-39c7-45f1-90ac-47a587128ace/resourceGroups/gaallarg/providers/Microsoft.RecoveryServices/vaults/amchandnTest2702A/privateLinkResources/siteRecoveryResource", + "name": "siteRecoveryResource", + "type": "Microsoft.RecoveryServices/vaults/privateLinkResources", + "properties": { + "groupId": "AzureSiteRecovery", + "requiredMembers": [ + "siteRecovery-rcm1", + "siteRecovery-prot2", + "siteRecovery-tel1", + "siteRecovery-srs1", + "siteRecovery-prot2b", + "siteRecovery-id1" + ], + "requiredZoneNames": [ + "privatelink.ecy.siterecovery.windowsazure.com", + "privatelink.queue.core.windows.net", + "privatelink.blob.core.windows.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ListReplicationUsages.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ListReplicationUsages.json new file mode 100644 index 000000000000..e3d0125c3c4c --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ListReplicationUsages.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "vaultName": "avrai7517Vault1", + "resourceGroupName": "avrai7517RG1", + "subscriptionId": "6808dbbc-98c7-431f-a1b1-9580902423b7" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "monitoringSummary": { + "unHealthyVmCount": 0, + "unHealthyProviderCount": 0, + "eventsCount": 0, + "deprecatedProviderCount": 0, + "supportedProviderCount": 0, + "unsupportedProviderCount": 0 + }, + "jobsSummary": { + "failedJobs": 0, + "suspendedJobs": 0, + "inProgressJobs": 0 + }, + "protectedItemCount": 2, + "registeredServersCount": 2, + "recoveryPlanCount": 1 + } + ] + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ListResources.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ListResources.json new file mode 100644 index 000000000000..b6a2e9aef50c --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ListResources.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "Default-RecoveryServices-ResourceGroup", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "westus", + "name": "patchtest", + "etag": "W/\"datetime'2017-11-22T11%3A05%3A19.907Z'\"", + "tags": { + "Love": "India" + }, + "properties": { + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/patchtest", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + }, + { + "location": "westus", + "name": "swaggerExample", + "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"", + "tags": { + "TestUpdatedKey": "TestUpdatedValue" + }, + "properties": { + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + }, + { + "location": "westus", + "name": "today1", + "etag": "W/\"datetime'2017-11-21T10%3A52%3A19.633Z'\"", + "tags": { + "TestUpdatedKey": "TestUpdatedValue" + }, + "properties": { + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/today1", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ListUsages.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ListUsages.json new file mode 100644 index 000000000000..e8470e41f282 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ListUsages.json @@ -0,0 +1,180 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "Default-RecoveryServices-ResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 6, + "limit": -1, + "name": { + "value": "MABContainersCount", + "localizedValue": "Backup management servers" + } + }, + { + "unit": "Count", + "currentValue": 3, + "limit": -1, + "name": { + "value": "ProtectedItemCount", + "localizedValue": "Backup items/Azure virtual machine backup" + } + }, + { + "unit": "Count", + "currentValue": 0, + "limit": -1, + "name": { + "value": "ProtectedItemCriticalCount", + "localizedValue": "Critical" + } + }, + { + "unit": "Count", + "currentValue": 0, + "limit": -1, + "name": { + "value": "ProtectedItemWarningCount", + "localizedValue": "Warning" + } + }, + { + "unit": "Count", + "currentValue": 0, + "limit": -1, + "name": { + "value": "IaaSVMProtectedItemCount", + "localizedValue": "Azure Virtual Machines" + } + }, + { + "unit": "Count", + "currentValue": 0, + "limit": -1, + "name": { + "value": "IaaSVMProtectedItemCriticalCount", + "localizedValue": "Critical" + } + }, + { + "unit": "Count", + "currentValue": 0, + "limit": -1, + "name": { + "value": "IaaSVMProtectedItemWarningCount", + "localizedValue": "Warning" + } + }, + { + "unit": "Count", + "currentValue": 0, + "limit": -1, + "name": { + "value": "MABProtectedItemCount", + "localizedValue": "File-Folders" + } + }, + { + "unit": "Count", + "currentValue": 1, + "limit": -1, + "name": { + "value": "DPMProtectedItemCount", + "localizedValue": "DPM Protected Items Count" + } + }, + { + "unit": "Count", + "currentValue": 2, + "limit": -1, + "name": { + "value": "AzureBackupServerProtectedItemCount", + "localizedValue": "Azure Backup Server Protected Items Count" + } + }, + { + "unit": "Count", + "quotaPeriod": "P1D", + "currentValue": 0, + "limit": -1, + "name": { + "value": "InProgressJobsCount", + "localizedValue": "In progress" + } + }, + { + "unit": "Count", + "quotaPeriod": "P1D", + "currentValue": 0, + "limit": -1, + "name": { + "value": "FailedJobsCount", + "localizedValue": "Failed" + } + }, + { + "unit": "Bytes", + "currentValue": 117007930, + "limit": -1, + "name": { + "value": "GRSStorageUsage", + "localizedValue": "Cloud - GRS" + } + }, + { + "unit": "Bytes", + "currentValue": 0, + "limit": -1, + "name": { + "value": "LRSStorageUsage", + "localizedValue": "Cloud - LRS" + } + }, + { + "unit": "Count", + "currentValue": 5, + "limit": -1, + "name": { + "value": "ManagedInstances", + "localizedValue": "Protected Instances" + } + }, + { + "unit": "Bytes", + "currentValue": 0, + "limit": -1, + "name": { + "value": "GRSDedupStorageUsage", + "localizedValue": "Dedup - GRS" + } + }, + { + "unit": "Bytes", + "currentValue": 0, + "limit": -1, + "name": { + "value": "LRSDedupStorageUsage", + "localizedValue": "Dedup - LRS" + } + }, + { + "unit": "Bytes", + "currentValue": 117851553792, + "limit": -1, + "name": { + "value": "UsedDiskSize", + "localizedValue": "Backup Engines' Disk Used" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PATCHVault.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PATCHVault.json new file mode 100644 index 000000000000..4f255811f2f0 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PATCHVault.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "HelloWorld", + "vaultName": "swaggerExample", + "api-version": "2021-06-01", + "vault": { + "tags": { + "PatchKey": "PatchKeyUpdated" + } + } + }, + "responses": { + "200": { + "body": { + "location": "westus", + "name": "swaggerExample", + "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"", + "tags": { + "PatchKey": "PatchKeyUpdated" + }, + "properties": { + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15", + "Location": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15" + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PATCHVault_WithCMK.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PATCHVault_WithCMK.json new file mode 100644 index 000000000000..457f1ea52784 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PATCHVault_WithCMK.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "HelloWorld", + "vaultName": "swaggerExample", + "api-version": "2021-06-01", + "vault": { + "tags": { + "PatchKey": "PatchKeyUpdated" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": {} + } + }, + "properties": { + "encryption": { + "keyVaultProperties": { + "keyUri": "https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3" + }, + "kekIdentity": { + "userAssignedIdentity": "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi" + }, + "infrastructureEncryption": "Enabled" + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "westus", + "name": "swaggerExample", + "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"", + "tags": { + "PatchKey": "PatchKeyUpdated" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": { + "clientId": "fbe75b66-01c5-4f87-a220-233af3270436", + "principalId": "075a0ca6-43f6-4434-9abf-c9b1b79f9219" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "encryption": { + "keyVaultProperties": { + "keyUri": "https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3" + }, + "kekIdentity": { + "userAssignedIdentity": "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi", + "useSystemAssignedIdentity": false + }, + "infrastructureEncryption": "Enabled" + } + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15", + "Location": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15" + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PATCHVault_WithCMK3.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PATCHVault_WithCMK3.json new file mode 100644 index 000000000000..78b183734457 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PATCHVault_WithCMK3.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "HelloWorld", + "vaultName": "swaggerExample", + "api-version": "2021-06-01", + "vault": { + "tags": { + "PatchKey": "PatchKeyUpdated" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": {} + } + }, + "properties": { + "encryption": { + "keyVaultProperties": { + "keyUri": "https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "westus", + "name": "swaggerExample", + "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"", + "tags": { + "PatchKey": "PatchKeyUpdated" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": { + "clientId": "fbe75b66-01c5-4f87-a220-233af3270436", + "principalId": "075a0ca6-43f6-4434-9abf-c9b1b79f9219" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "encryption": { + "keyVaultProperties": { + "keyUri": "https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3" + }, + "kekIdentity": { + "userAssignedIdentity": "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi", + "useSystemAssignedIdentity": false + }, + "infrastructureEncryption": "Enabled" + } + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15", + "Location": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15" + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PATCHVault_WithUserAssignedIdentity.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PATCHVault_WithUserAssignedIdentity.json new file mode 100644 index 000000000000..410d3e20417b --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PATCHVault_WithUserAssignedIdentity.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "HelloWorld", + "vaultName": "swaggerExample", + "api-version": "2021-06-01", + "vault": { + "tags": { + "PatchKey": "PatchKeyUpdated" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "westus", + "name": "swaggerExample", + "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"", + "tags": { + "PatchKey": "PatchKeyUpdated" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": { + "clientId": "fbe75b66-01c5-4f87-a220-233af3270436", + "principalId": "075a0ca6-43f6-4434-9abf-c9b1b79f9219" + } + } + }, + "properties": { + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15", + "Location": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15" + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PUTVault.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PUTVault.json new file mode 100644 index 000000000000..048a877ce15a --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PUTVault.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "Default-RecoveryServices-ResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2021-06-01", + "vault": { + "properties": {}, + "sku": { + "name": "Standard" + }, + "location": "West US", + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "location": "westus", + "name": "swaggerExample", + "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"", + "tags": { + "TestUpdatedKey": "TestUpdatedValue" + }, + "identity": { + "tenantId": "d676e86e-2206-4a7c-999c-ece52c144b5b", + "principalId": "3137d6c7-5d6c-411c-b934-7a2a729ee247", + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "RS0", + "tier": "Standard" + } + } + }, + "201": { + "body": { + "location": "westus", + "name": "swaggerExample", + "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"", + "tags": { + "TestUpdatedKey": "TestUpdatedValue" + }, + "identity": { + "tenantId": "d676e86e-2206-4a7c-999c-ece52c144b5b", + "principalId": "3137d6c7-5d6c-411c-b934-7a2a729ee247", + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "RS0", + "tier": "Standard" + } + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PUTVaultCred.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PUTVaultCred.json new file mode 100644 index 000000000000..bb7ef3589d38 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PUTVaultCred.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "77777777-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "BCDRIbzRG", + "vaultName": "BCDRIbzVault", + "certificateName": "BCDRIbzVault77777777-d41f-4550-9f70-7708a3a2283b-12-18-2017-vaultcredentials", + "api-version": "2021-06-01", + "certificateRequest": { + "properties": { + "authType": "AAD", + "certificate": "MTTC3TCCAcWgAwIBAgIQEj9h+ZLlXK9KrqZX9UkAnzANBgkqhkiG9w0BAQUFADAeMRwwGgYDVQQDExNXaW5kb3dzIEF6dXJlIFRvb2xzMB4XDTE3MTIxODA5MTc1M1oXDTE3MTIyMzA5Mjc1M1owHjEcMBoGA1UEAxMTV2luZG93cyBBenVyZSBUb29sczCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK773/eZZ69RbZZAT05r9MjUxu9y1L1Pn1EgPk62IPJyHlO3OZA922eSBahhP4bgmFljN4LVReqQ5eT/wqO0Zhc+yFkUy4U4RdbQLeUZt2W7yy9XLXgVvqeYDgsjg/QhHetgHArQBW+tlQq5+zPdU7zchI4rbShSJrWhLrZFWiOyFPsuAE4joUQHNlRifdCTsBGKk8HRCY3j1S3c4bfEn3zxlrvrXXssRuW5mJM95rMk0tskoRxXSCi6i9bnlki2Cs9mpVMmBFeofs41KwzlWU0TgpdD8s1QEdvfGB5NbByfetPX7MfJaTBeHZEGbv/Iq8l72u8sPBoOhcaH7qDE/mECAwEAAaMXMBUwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQEFBQADggEBAILfgHluye1Q+WelhgWhpBBdIq2C0btfV8eFsZaTlBUrM0fwpxQSlAWc2oYHVMQI4A5iUjbDOY35O4yc+TnWKDBKf+laqDP+yos4aiUPuadGUZfvDk7kuw7xeECs64JpHAIEKdRHFW9rD3gwG+nIWaDnEL/7rTyhL3kXrRW2MSUAL8g3GX8Z45c+MQY0jmASIqWdhGn1vpAGyA9mKkzsqg7FXjg8GZb24tGl5Ky85+ip4dkBfXinDD8WwaGyjhGGK97ErvNmN36qly/H0H1Qngiovg1FbHDmkcFO5QclnEJsFFmcO2CcHp5Fqh2wXn5O1cQaxCIRTpQ/uXRpDjl2wKs=" + } + } + }, + "responses": { + "200": { + "body": { + "name": "BCDRIbzVault77777777-d41f-4550-9f70-7708a3a2283b-12-18-2017-vaultcredentials", + "type": "Microsoft.RecoveryServices/vaults/certificates", + "id": "/Subscriptions/77777777-d41f-4550-9f70-7708a3a2283b/resourceGroups/BCDRIbzRG/providers/Microsoft.RecoveryServices/vaults/BCDRIbzVault/certificates/BCDRIbzVault77777777-d41f-4550-9f70-7708a3a2283b-12-18-2017-vaultcredentials", + "properties": { + "authType": "AzureActiveDirectory", + "certificate": "MTTC3TCCAcWgAwIBAgIQEj9h+ZLlXK9KrqZX9UkAnzANBgkqhkiG9w0BAQUFADAeMRwwGgYDVQQDExNXaW5kb3dzIEF6dXJlIFRvb2xzMB4XDTE3MTIxODA5MTc1M1oXDTE3MTIyMzA5Mjc1M1owHjEcMBoGA1UEAxMTV2luZG93cyBBenVyZSBUb29sczCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK773/eZZ69RbZZAT05r9MjUxu9y1L1Pn1EgPk62IPJyHlO3OZA922eSBahhP4bgmFljN4LVReqQ5eT/wqO0Zhc+yFkUy4U4RdbQLeUZt2W7yy9XLXgVvqeYDgsjg/QhHetgHArQBW+tlQq5+zPdU7zchI4rbShSJrWhLrZFWiOyFPsuAE4joUQHNlRifdCTsBGKk8HRCY3j1S3c4bfEn3zxlrvrXXssRuW5mJM95rMk0tskoRxXSCi6i9bnlki2Cs9mpVMmBFeofs41KwzlWU0TgpdD8s1QEdvfGB5NbByfetPX7Mf JaTBeHZEGbv/Iq8l72u8sPBoOhcaH7qDE/mECAwEAAaMXMBUwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQEFBQADggEBAILfgHluye1Q+WelhgWhpBBdIq2C0btfV8eFsZaTlBUrM0fwpxQSlAWc2oYHVMQI4A5iUjbDOY35O4yc+TnWKDBKf+laqDP+yos4aiUPuadGUZfvDk7kuw7xeECs64JpHAIEKdRHFW9rD3gwG+nIWaDnEL/7rTyhL3kXrRW2MSUAL8g3GX8Z45c+MQY0jmASIqWdhGn1vpAGyA9mKkzsqg7FXjg8GZb24tGl5Ky85+ip4dkBfXinDD8WwaGyjhGGK97ErvNmN36qly/H0H1Qngiovg1FbHDmkcFO5QclnEJsFFmcO2CcHp5Fqh2wXn5O1cQaxCIRTpQ/uXRpDjl2wKs=", + "resourceId": 8726350008099341699, + "aadAuthority": "https://login.windows.net", + "aadTenantId": "9b0c2069-2eba-489f-95f4-eca15cb602ab", + "servicePrincipalClientId": "4932d0bd-b5f9-4659-94a0-7ab02d918933", + "servicePrincipalObjectId": "2d60221e-cef5-4e13-ba66-b33701a533bb", + "azureManagementEndpointAudience": "https://ppe1-id1.wus.wabppe.obs-test.com/restapi/", + "subject": "CN=Windows Azure Tools", + "validFrom": "2017-12-18T14:47:53+05:30", + "validTo": "2017-12-23T14:57:53+05:30", + "thumbprint": "019FE9BAD18A5A09A5CA53B593AF66331F3054AF", + "friendlyName": "", + "issuer": "CN=Windows Azure Tools" + } + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PUTVault_WithCMK.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PUTVault_WithCMK.json new file mode 100644 index 000000000000..2aeb5743bab0 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PUTVault_WithCMK.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "Default-RecoveryServices-ResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2021-06-01", + "vault": { + "properties": { + "encryption": { + "keyVaultProperties": { + "keyUri": "https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3" + }, + "kekIdentity": { + "userAssignedIdentity": "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi" + }, + "infrastructureEncryption": "Enabled" + } + }, + "sku": { + "name": "Standard" + }, + "location": "West US", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "westus", + "name": "swaggerExample", + "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"", + "tags": { + "TestUpdatedKey": "TestUpdatedValue" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": { + "clientId": "fbe75b66-01c5-4f87-a220-233af3270436", + "principalId": "075a0ca6-43f6-4434-9abf-c9b1b79f9219" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "encryption": { + "keyVaultProperties": { + "keyUri": "https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3" + }, + "kekIdentity": { + "userAssignedIdentity": "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi", + "useSystemAssignedIdentity": false + }, + "infrastructureEncryption": "Enabled" + } + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + } + }, + "201": { + "body": { + "location": "westus", + "name": "swaggerExample", + "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"", + "tags": { + "TestUpdatedKey": "TestUpdatedValue" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": {} + } + }, + "properties": { + "provisioningState": "Provisioning", + "encryption": { + "keyVaultProperties": { + "keyUri": "https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3" + }, + "kekIdentity": { + "userAssignedIdentity": "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi", + "useSystemAssignedIdentity": false + }, + "infrastructureEncryption": "Enabled" + } + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + }, + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15" + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PUTVault_WithUserAssignedIdentity.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PUTVault_WithUserAssignedIdentity.json new file mode 100644 index 000000000000..11337f5b9827 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PUTVault_WithUserAssignedIdentity.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "Default-RecoveryServices-ResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2021-06-01", + "vault": { + "properties": {}, + "sku": { + "name": "Standard" + }, + "location": "West US", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "westus", + "name": "swaggerExample", + "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"", + "tags": { + "TestUpdatedKey": "TestUpdatedValue" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": { + "clientId": "fbe75b66-01c5-4f87-a220-233af3270436", + "principalId": "075a0ca6-43f6-4434-9abf-c9b1b79f9219" + } + } + }, + "properties": { + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + } + }, + "201": { + "body": { + "location": "westus", + "name": "swaggerExample", + "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"", + "tags": { + "TestUpdatedKey": "TestUpdatedValue" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": {} + } + }, + "properties": { + "provisioningState": "Provisioning" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + }, + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15" + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PatchVault_WithCMK2.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PatchVault_WithCMK2.json new file mode 100644 index 000000000000..51cc0cb7755a --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PatchVault_WithCMK2.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "HelloWorld", + "vaultName": "swaggerExample", + "api-version": "2021-06-01", + "vault": { + "tags": { + "PatchKey": "PatchKeyUpdated" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "encryption": { + "kekIdentity": { + "useSystemAssignedIdentity": true + } + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "westus", + "name": "swaggerExample", + "etag": "W/\"datetime'2017-12-15T12%3A36%3A51.68Z'\"", + "tags": { + "PatchKey": "PatchKeyUpdated" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi": { + "clientId": "fbe75b66-01c5-4f87-a220-233af3270436", + "principalId": "075a0ca6-43f6-4434-9abf-c9b1b79f9219" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "encryption": { + "keyVaultProperties": { + "keyUri": "https://cmk2xkv.vault.azure.net/keys/Key1/0767b348bb1a4c07baa6c4ec0055d2b3" + }, + "kekIdentity": { + "useSystemAssignedIdentity": true + }, + "infrastructureEncryption": "Enabled" + } + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample", + "type": "Microsoft.RecoveryServices/vaults", + "sku": { + "name": "Standard" + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15", + "Location": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.RecoveryServices/vaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15" + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/UpdateVaultExtendedInfo.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/UpdateVaultExtendedInfo.json new file mode 100644 index 000000000000..4466be6e724e --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/UpdateVaultExtendedInfo.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "77777777-b0c6-47a2-b37c-d8e65a629c18", + "resourceGroupName": "Default-RecoveryServices-ResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2021-06-01", + "resourceResourceExtendedInfoDetails": { + "properties": { + "integrityKey": "J99wzS27fmJ+Wjot7xO5wA==", + "algorithm": "None" + } + } + }, + "responses": { + "200": { + "body": { + "name": "vaultExtendedInfo", + "etag": "f0d0260b-b92d-4458-ba0a-32c6cdabacb7", + "properties": { + "integrityKey": "J99wzS27fmJ+Wjot7xO5wA==", + "algorithm": "None" + }, + "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample/extendedInformation/vaultExtendedInfo", + "type": "Microsoft.RecoveryServices/vaults/extendedInformation" + } + } + } +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/registeredidentities.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/registeredidentities.json new file mode 100644 index 000000000000..6e30c8a08fdf --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/registeredidentities.json @@ -0,0 +1,372 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01", + "title": "RecoveryServicesClient", + "x-ms-code-generation-settings": { + "internalConstructors": false + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/certificates/{certificateName}": { + "put": { + "tags": [ + "VaultCertificates" + ], + "description": "Uploads a certificate for a resource.", + "operationId": "VaultCertificates_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "certificateName", + "in": "path", + "description": "Certificate friendly name.", + "required": true, + "type": "string" + }, + { + "name": "certificateRequest", + "in": "body", + "description": "Input parameters for uploading the vault certificate.", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultCertificateResponse" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Download vault credential file": { + "$ref": "./examples/PUTVaultCred.json" + } + } + } + }, + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/registeredIdentities/{identityName}": { + "delete": { + "tags": [ + "RegisteredIdentities" + ], + "description": "Unregisters the given container from your Recovery Services vault.", + "operationId": "RegisteredIdentities_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "identityName", + "in": "path", + "description": "Name of the protection container to unregister.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "NoContent" + } + }, + "deprecated": false, + "x-ms-examples": { + "Delete registered Identity": { + "$ref": "./examples/DeleteRegisteredIdentities.json" + } + } + } + } + }, + "definitions": { + "CertificateRequest": { + "description": "Details of the certificate to be uploaded to the vault.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RawCertificateData" + } + } + }, + "RawCertificateData": { + "description": "Raw certificate data.", + "type": "object", + "properties": { + "authType": { + "description": "Specifies the authentication type.", + "enum": [ + "Invalid", + "ACS", + "AAD", + "AccessControlService", + "AzureActiveDirectory" + ], + "type": "string", + "x-ms-enum": { + "name": "AuthType", + "modelAsString": true + } + }, + "certificate": { + "format": "byte", + "description": "The base64 encoded certificate raw data string", + "type": "string" + } + } + }, + "ResourceCertificateAndAadDetails": { + "description": "Certificate details representing the Vault credentials for AAD.", + "required": [ + "certificate", + "resourceId", + "aadAuthority", + "aadTenantId", + "servicePrincipalClientId", + "servicePrincipalObjectId", + "azureManagementEndpointAudience", + "subject", + "validFrom", + "validTo", + "thumbprint", + "friendlyName", + "issuer" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceCertificateDetails" + } + ], + "properties": { + "aadAuthority": { + "description": "AAD tenant authority.", + "type": "string" + }, + "aadTenantId": { + "description": "AAD tenant Id.", + "type": "string" + }, + "servicePrincipalClientId": { + "description": "AAD service principal clientId.", + "type": "string" + }, + "servicePrincipalObjectId": { + "description": "AAD service principal ObjectId.", + "type": "string" + }, + "azureManagementEndpointAudience": { + "description": "Azure Management Endpoint Audience.", + "type": "string" + }, + "serviceResourceId": { + "description": "Service Resource Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureActiveDirectory" + }, + "ResourceCertificateAndAcsDetails": { + "description": "Certificate details representing the Vault credentials for ACS.", + "required": [ + "certificate", + "resourceId", + "globalAcsNamespace", + "globalAcsHostName", + "globalAcsRPRealm", + "subject", + "validFrom", + "validTo", + "thumbprint", + "friendlyName", + "issuer" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceCertificateDetails" + } + ], + "properties": { + "globalAcsNamespace": { + "description": "ACS namespace name - tenant for our service.", + "type": "string" + }, + "globalAcsHostName": { + "description": "Acs mgmt host name to connect to.", + "type": "string" + }, + "globalAcsRPRealm": { + "description": "Global ACS namespace RP realm.", + "type": "string" + } + }, + "x-ms-discriminator-value": "AccessControlService" + }, + "ResourceCertificateDetails": { + "description": "Certificate details representing the Vault credentials.", + "required": [ + "authType" + ], + "type": "object", + "properties": { + "authType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + }, + "certificate": { + "format": "byte", + "description": "The base64 encoded certificate raw data string.", + "type": "string" + }, + "friendlyName": { + "description": "Certificate friendly name.", + "type": "string" + }, + "issuer": { + "description": "Certificate issuer.", + "type": "string" + }, + "resourceId": { + "format": "int64", + "description": "Resource ID of the vault.", + "type": "integer" + }, + "subject": { + "description": "Certificate Subject Name.", + "type": "string" + }, + "thumbprint": { + "description": "Certificate thumbprint.", + "type": "string" + }, + "validFrom": { + "format": "date-time", + "description": "Certificate Validity start Date time.", + "type": "string" + }, + "validTo": { + "format": "date-time", + "description": "Certificate Validity End Date time.", + "type": "string" + } + }, + "discriminator": "authType" + }, + "VaultCertificateResponse": { + "description": "Certificate corresponding to a vault that can be used by clients to register themselves with the vault.", + "type": "object", + "properties": { + "name": { + "description": "Resource name associated with the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Resource Id represents the complete path to the resource.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/ResourceCertificateDetails" + } + }, + "x-ms-azure-resource": true + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription Id.", + "required": true, + "type": "string" + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group where the recovery services vault is present.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "VaultName": { + "name": "vaultName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account." + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/replicationusages.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/replicationusages.json new file mode 100644 index 000000000000..accf4e778857 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/replicationusages.json @@ -0,0 +1,208 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01", + "title": "RecoveryServicesClient", + "x-ms-code-generation-settings": { + "internalConstructors": false + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/replicationUsages": { + "get": { + "tags": [ + "ReplicationUsages" + ], + "description": "Fetches the replication usages of the vault.", + "operationId": "ReplicationUsages_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationUsageList" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Gets Replication usages of vault": { + "$ref": "./examples/ListReplicationUsages.json" + } + } + } + } + }, + "definitions": { + "JobsSummary": { + "description": "Summary of the replication job data for this vault.", + "type": "object", + "properties": { + "failedJobs": { + "description": "Count of failed jobs.", + "type": "integer" + }, + "suspendedJobs": { + "description": "Count of suspended jobs.", + "type": "integer" + }, + "inProgressJobs": { + "description": "Count of in-progress jobs.", + "type": "integer" + } + } + }, + "MonitoringSummary": { + "description": "Summary of the replication monitoring data for this vault.", + "type": "object", + "properties": { + "unHealthyVmCount": { + "description": "Count of unhealthy VMs.", + "type": "integer" + }, + "unHealthyProviderCount": { + "description": "Count of unhealthy replication providers.", + "type": "integer" + }, + "eventsCount": { + "description": "Count of all critical warnings.", + "type": "integer" + }, + "deprecatedProviderCount": { + "description": "Count of all deprecated recovery service providers.", + "type": "integer" + }, + "supportedProviderCount": { + "description": "Count of all the supported recovery service providers.", + "type": "integer" + }, + "unsupportedProviderCount": { + "description": "Count of all the unsupported recovery service providers.", + "type": "integer" + } + } + }, + "ReplicationUsage": { + "description": "Replication usages of a vault.", + "type": "object", + "properties": { + "monitoringSummary": { + "$ref": "#/definitions/MonitoringSummary", + "description": "Summary of the replication monitoring data for this vault." + }, + "jobsSummary": { + "$ref": "#/definitions/JobsSummary", + "description": "Summary of the replication jobs data for this vault." + }, + "protectedItemCount": { + "description": "Number of replication protected items for this vault.", + "type": "integer" + }, + "recoveryPlanCount": { + "description": "Number of replication recovery plans for this vault.", + "type": "integer" + }, + "registeredServersCount": { + "description": "Number of servers registered to this vault.", + "type": "integer" + }, + "recoveryServicesProviderAuthType": { + "description": "The authentication type of recovery service providers in the vault.", + "type": "integer" + } + } + }, + "ReplicationUsageList": { + "description": "Replication usages for vault.", + "type": "object", + "properties": { + "value": { + "description": "The list of replication usages for the given vault.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationUsage" + } + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription Id.", + "required": true, + "type": "string" + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group where the recovery services vault is present.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "VaultName": { + "name": "vaultName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account." + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/vaults.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/vaults.json new file mode 100644 index 000000000000..0de0660085ca --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/vaults.json @@ -0,0 +1,1798 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01", + "title": "RecoveryServicesClient", + "x-ms-code-generation-settings": { + "internalConstructors": false + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateLinkResources": { + "get": { + "tags": [ + "ListPrivateLinkResources" + ], + "summary": "Returns the list of private link resources that need to be created for Backup and SiteRecovery", + "operationId": "PrivateLinkResources_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResources" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + }, + "x-ms-examples": { + "List PrivateLinkResources": { + "$ref": "./examples/ListPrivateLinkResources.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateLinkResources/{privateLinkResourceName}": { + "get": { + "tags": [ + "GetPrivateLinkResources" + ], + "summary": "Returns a specified private link resource that need to be created for Backup and SiteRecovery", + "operationId": "PrivateLinkResources_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "privateLinkResourceName", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Get PrivateLinkResource": { + "$ref": "./examples/GetPrivateLinkResources.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/locations/{location}/checkNameAvailability": { + "post": { + "tags": [ + "RecoveryServices" + ], + "summary": "API to check for resource name availability.\r\nA name is available if no other resource exists that has the same SubscriptionId, Resource Name and Type\r\nor if one or more such resources exist, each of these must be GC'd and their time of deletion be more than 24 Hours Ago", + "operationId": "RecoveryServices_CheckNameAvailability", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "location", + "in": "path", + "description": "Location of the resource", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Contains information about Resource type and Resource name", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityParameters" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Availability status of Resource Name when no resource with same name, type and subscription exists, nor has been deleted within last 24 hours": { + "$ref": "./examples/CheckNameAvailability_Available.json" + }, + "Availability status of Resource Name when resource with same name, type and subscription exists": { + "$ref": "./examples/CheckNameAvailability_NotAvailable.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/vaults": { + "get": { + "tags": [ + "Vaults" + ], + "description": "Fetches all the resources of the specified type in the subscription.", + "operationId": "Vaults_ListBySubscriptionId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + }, + "x-ms-examples": { + "List of Recovery Services Resources in SubscriptionId": { + "$ref": "./examples/ListBySubscriptionIds.json" + } + } + } + }, + "/providers/Microsoft.RecoveryServices/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Returns the list of available operations.", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClientDiscoveryResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + }, + "x-ms-examples": { + "ListOperations": { + "$ref": "./examples/ListOperations.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults": { + "get": { + "tags": [ + "Vaults" + ], + "description": "Retrieve a list of Vaults.", + "operationId": "Vaults_ListByResourceGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + }, + "x-ms-examples": { + "List of Recovery Services Resources in ResourceGroup": { + "$ref": "./examples/ListResources.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}": { + "get": { + "tags": [ + "Vaults" + ], + "description": "Get the Vault details.", + "operationId": "Vaults_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Vault" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Get Recovery Services Resource": { + "$ref": "./examples/GETVault.json" + } + } + }, + "put": { + "tags": [ + "Vaults" + ], + "description": "Creates or updates a Recovery Services vault.", + "operationId": "Vaults_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "vault", + "in": "body", + "description": "Recovery Services Vault to be created.", + "required": true, + "schema": { + "$ref": "#/definitions/Vault" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Vault" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Vault" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Create or Update Recovery Services vault": { + "$ref": "./examples/PUTVault.json" + }, + "Create or Update Vault with User Assigned Identity": { + "$ref": "./examples/PUTVault_WithUserAssignedIdentity.json" + }, + "Create or Update Vault with CustomerManagedKeys": { + "$ref": "./examples/PUTVault_WithCMK.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Vaults" + ], + "description": "Deletes a vault.", + "operationId": "Vaults_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Delete Recovery Services Vault": { + "$ref": "./examples/DeleteVault.json" + } + } + }, + "patch": { + "tags": [ + "Vaults" + ], + "description": "Updates the vault.", + "operationId": "Vaults_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "vault", + "in": "body", + "description": "Recovery Services Vault to be created.", + "required": true, + "schema": { + "$ref": "#/definitions/PatchVault" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Vault" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Update Resource": { + "$ref": "./examples/PATCHVault.json" + }, + "Update Resource With User Assigned Identity": { + "$ref": "./examples/PATCHVault_WithUserAssignedIdentity.json" + }, + "Update Resource With CustomerManagedKeys": { + "$ref": "./examples/PATCHVault_WithCMK.json" + }, + "Update Resource With CustomerManagedKeys2": { + "$ref": "./examples/PatchVault_WithCMK2.json" + }, + "Update Resource With CustomerManagedKeys3": { + "$ref": "./examples/PATCHVault_WithCMK3.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/extendedInformation/vaultExtendedInfo": { + "get": { + "tags": [ + "VaultExtendedInfo" + ], + "description": "Get the vault extended info.", + "operationId": "VaultExtendedInfo_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultExtendedInfoResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Get ExtendedInfo of Resource": { + "$ref": "./examples/GETVaultExtendedInfo.json" + } + } + }, + "put": { + "tags": [ + "VaultExtendedInfo" + ], + "description": "Create vault extended info.", + "operationId": "VaultExtendedInfo_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "resourceResourceExtendedInfoDetails", + "in": "body", + "description": "Details of ResourceExtendedInfo", + "required": true, + "schema": { + "$ref": "#/definitions/VaultExtendedInfoResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultExtendedInfoResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Put ExtendedInfo of Resource": { + "$ref": "./examples/UpdateVaultExtendedInfo.json" + } + } + }, + "patch": { + "tags": [ + "VaultExtendedInfo" + ], + "description": "Update vault extended info.", + "operationId": "VaultExtendedInfo_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "resourceResourceExtendedInfoDetails", + "in": "body", + "description": "Details of ResourceExtendedInfo", + "required": true, + "schema": { + "$ref": "#/definitions/VaultExtendedInfoResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultExtendedInfoResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "PATCH ExtendedInfo of Resource": { + "$ref": "./examples/UpdateVaultExtendedInfo.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/operationStatus/{operationId}": { + "get": { + "tags": [ + "Vaults" + ], + "description": "Gets the operation status for a resource.", + "operationId": "GetOperationStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Operation Status": { + "$ref": "./examples/GetOperationStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/operationResults/{operationId}": { + "get": { + "tags": [ + "Vaults" + ], + "description": "Gets the operation result for a resource.", + "operationId": "GetOperationResult", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Vault" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Operation Result": { + "$ref": "./examples/GetOperationResult.json" + } + } + } + } + }, + "definitions": { + "CheckNameAvailabilityParameters": { + "description": "Resource Name availability input parameters - Resource type and resource name", + "type": "object", + "properties": { + "type": { + "description": "Describes the Resource type: Microsoft.RecoveryServices/Vaults", + "type": "string" + }, + "name": { + "description": "Resource name for which availability needs to be checked", + "type": "string" + } + } + }, + "CheckNameAvailabilityResult": { + "description": "Response for check name availability API. Resource provider will set availability as true | false.", + "type": "object", + "properties": { + "nameAvailable": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "ClientDiscoveryDisplay": { + "description": "Localized display information of an operation.", + "type": "object", + "properties": { + "provider": { + "description": "Name of the provider for display purposes", + "type": "string" + }, + "resource": { + "description": "ResourceType for which this Operation can be performed.", + "type": "string" + }, + "operation": { + "description": "Operations Name itself.", + "type": "string" + }, + "description": { + "description": "Description of the operation having details of what operation is about.", + "type": "string" + } + } + }, + "ClientDiscoveryForLogSpecification": { + "description": "Class to represent shoebox log specification in json client discovery.", + "type": "object", + "properties": { + "name": { + "description": "Name of the log.", + "type": "string" + }, + "displayName": { + "description": "Localized display name", + "type": "string" + }, + "blobDuration": { + "description": "Blobs created in customer storage account per hour", + "type": "string" + } + } + }, + "ClientDiscoveryForProperties": { + "description": "Class to represent shoebox properties in json client discovery.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ClientDiscoveryForServiceSpecification", + "description": "Operation properties." + } + } + }, + "ClientDiscoveryForServiceSpecification": { + "description": "Class to represent shoebox service specification in json client discovery.", + "type": "object", + "properties": { + "logSpecifications": { + "description": "List of log specifications of this operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ClientDiscoveryForLogSpecification" + } + } + } + }, + "ClientDiscoveryResponse": { + "description": "Operations List response which contains list of available APIs.", + "type": "object", + "properties": { + "value": { + "description": "List of available operations.", + "type": "array", + "items": { + "$ref": "#/definitions/ClientDiscoveryValueForSingleApi" + } + }, + "nextLink": { + "description": "Link to the next chunk of the response", + "type": "string" + } + } + }, + "ClientDiscoveryValueForSingleApi": { + "description": "Available operation details.", + "type": "object", + "properties": { + "name": { + "description": "Name of the Operation.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/ClientDiscoveryDisplay", + "description": "Contains the localized display information for this particular operation" + }, + "origin": { + "description": "The intended executor of the operation;governs the display of the operation in the RBAC UX and the audit logs UX", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/ClientDiscoveryForProperties", + "description": "ShoeBox properties for the given operation." + } + } + }, + "Resource": { + "description": "ARM Resource.", + "type": "object", + "properties": { + "id": { + "description": "Resource Id represents the complete path to the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource name associated with the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...", + "type": "string", + "readOnly": true + }, + "etag": { + "description": "Optional ETag.", + "type": "string" + } + }, + "x-ms-azure-resource": true + }, + "Sku": { + "description": "Identifies the unique system identifier for each Azure resource.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The Sku name.", + "enum": [ + "Standard", + "RS0" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "tier": { + "description": "The Sku tier.", + "type": "string" + }, + "family": { + "description": "The sku family", + "type": "string" + }, + "size": { + "description": "The sku size", + "type": "string" + }, + "capacity": { + "description": "The sku capacity", + "type": "string" + } + } + }, + "TrackedResource": { + "description": "Tracked resource with location.", + "type": "object", + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "description": "Resource location.", + "type": "string" + }, + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "PatchTrackedResource": { + "description": "Tracked resource with location.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "description": "Resource location.", + "type": "string" + }, + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "UpgradeDetails": { + "description": "Details for upgrading vault.", + "type": "object", + "properties": { + "operationId": { + "description": "ID of the vault upgrade operation.", + "type": "string", + "readOnly": true + }, + "startTimeUtc": { + "description": "UTC time at which the upgrade operation has started.", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "lastUpdatedTimeUtc": { + "description": "UTC time at which the upgrade operation status was last updated.", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "endTimeUtc": { + "description": "UTC time at which the upgrade operation has ended.", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "status": { + "description": "Status of the vault upgrade operation.", + "enum": [ + "Unknown", + "InProgress", + "Upgraded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VaultUpgradeState", + "modelAsString": true + } + }, + "message": { + "description": "Message to the user containing information about the upgrade operation.", + "type": "string", + "readOnly": true + }, + "triggerType": { + "description": "The way the vault upgrade was triggered.", + "enum": [ + "UserTriggered", + "ForcedUpgrade" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "TriggerType", + "modelAsString": true + } + }, + "upgradedResourceId": { + "description": "Resource ID of the upgraded vault.", + "type": "string", + "readOnly": true + }, + "previousResourceId": { + "description": "Resource ID of the vault before the upgrade.", + "type": "string", + "readOnly": true + } + } + }, + "Vault": { + "description": "Resource information, as returned by the resource provider.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "$ref": "#/definitions/IdentityData" + }, + "properties": { + "$ref": "#/definitions/VaultProperties" + }, + "sku": { + "$ref": "#/definitions/Sku" + }, + "systemData": { + "$ref": "#/definitions/systemData" + } + } + }, + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "type": "string", + "description": "The type of identity that created the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)." + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "type": "string", + "description": "The type of identity that last modified the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The type of identity that last modified the resource." + } + } + }, + "PatchVault": { + "description": "Patch Resource information, as returned by the resource provider.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PatchTrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/VaultProperties" + }, + "sku": { + "$ref": "#/definitions/Sku" + }, + "identity": { + "$ref": "#/definitions/IdentityData" + } + } + }, + "VaultExtendedInfo": { + "description": "Vault extended information.", + "type": "object", + "properties": { + "integrityKey": { + "description": "Integrity key.", + "type": "string" + }, + "encryptionKey": { + "description": "Encryption key.", + "type": "string" + }, + "encryptionKeyThumbprint": { + "description": "Encryption key thumbprint.", + "type": "string" + }, + "algorithm": { + "description": "Algorithm for Vault ExtendedInfo", + "type": "string" + } + } + }, + "VaultExtendedInfoResource": { + "description": "Vault extended information.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/VaultExtendedInfo", + "x-ms-client-flatten": true + } + } + }, + "VaultList": { + "description": "The response model for a list of Vaults.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Vault" + } + }, + "nextLink": { + "type": "string", + "readOnly": true + } + } + }, + "VaultProperties": { + "description": "Properties of the vault.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning State.", + "type": "string", + "readOnly": true + }, + "upgradeDetails": { + "$ref": "#/definitions/UpgradeDetails" + }, + "privateEndpointConnections": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnectionVaultProperties" + }, + "description": "List of private endpoint connection.", + "readOnly": true + }, + "privateEndpointStateForBackup": { + "description": "Private endpoint state for backup.", + "enum": [ + "None", + "Enabled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VaultPrivateEndpointState", + "modelAsString": true + } + }, + "privateEndpointStateForSiteRecovery": { + "description": "Private endpoint state for site recovery.", + "enum": [ + "None", + "Enabled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VaultPrivateEndpointState", + "modelAsString": true + } + }, + "encryption": { + "description": "Customer Managed Key details of the resource.", + "type": "object", + "properties": { + "keyVaultProperties": { + "$ref": "#/definitions/CmkKeyVaultProperties" + }, + "kekIdentity": { + "$ref": "#/definitions/CmkKekIdentity" + }, + "infrastructureEncryption": { + "description": "Enabling/Disabling the Double Encryption state", + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "InfrastructureEncryptionState", + "modelAsString": true + } + } + } + }, + "moveDetails": { + "description": "The details of the latest move operation performed on the Azure Resource", + "type": "object", + "properties": { + "operationId": { + "description": "OperationId of the Resource Move Operation", + "type": "string", + "readOnly": true + }, + "startTimeUtc": { + "description": "Start Time of the Resource Move Operation", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "completionTimeUtc": { + "description": "End Time of the Resource Move Operation", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "sourceResourceId": { + "description": "Source Resource of the Resource Move Operation", + "type": "string", + "readOnly": true + }, + "targetResourceId": { + "description": "Target Resource of the Resource Move Operation", + "type": "string", + "readOnly": true + } + } + }, + "moveState": { + "description": "The State of the Resource after the move operation", + "type": "string", + "readOnly": true, + "enum": [ + "Unknown", + "InProgress", + "PrepareFailed", + "CommitFailed", + "PrepareTimedout", + "CommitTimedout", + "MoveSucceeded", + "Failure", + "CriticalFailure", + "PartialSuccess" + ], + "x-ms-enum": { + "name": "ResourceMoveState", + "modelAsString": true + } + } + } + }, + "IdentityData": { + "required": [ + "type" + ], + "type": "object", + "description": "Identity for the resource.", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of resource identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID of resource." + }, + "type": { + "type": "string", + "description": "The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities.", + "enum": [ + "SystemAssigned", + "None", + "UserAssigned", + "SystemAssigned, UserAssigned" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": true + } + }, + "userAssignedIdentities": { + "description": "The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserIdentity" + } + } + } + }, + "UserIdentity": { + "type": "object", + "description": "A resource identity that is managed by the user of the service.", + "properties": { + "principalId": { + "description": "The principal ID of the user-assigned identity.", + "type": "string", + "readOnly": true + }, + "clientId": { + "description": "The client ID of the user-assigned identity.", + "type": "string", + "readOnly": true + } + } + }, + "PrivateEndpointConnectionVaultProperties": { + "description": "Information to be stored in Vault properties as an element of privateEndpointConnections List.", + "readOnly": true, + "type": "object", + "properties": { + "id": { + "description": "Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}.", + "readOnly": true, + "type": "string" + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "name": { + "description": "The name of the private Endpoint Connection", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type, which will be of the format, Microsoft.RecoveryServices/vaults/privateEndpointConnections", + "type": "string", + "readOnly": true + }, + "location": { + "description": "The location of the private Endpoint connection", + "type": "string", + "readOnly": true + } + } + }, + "PrivateEndpointConnection": { + "description": "Private Endpoint Connection Response Properties.", + "readOnly": true, + "type": "object", + "properties": { + "provisioningState": { + "description": "Gets or sets provisioning state of the private endpoint connection.", + "readOnly": true, + "enum": [ + "Succeeded", + "Deleting", + "Failed", + "Pending" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState" + } + } + }, + "PrivateEndpoint": { + "description": "The Private Endpoint network resource that is linked to the Private Endpoint connection.", + "readOnly": true, + "type": "object", + "properties": { + "id": { + "description": "Gets or sets id.", + "readOnly": true, + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "Gets or sets private link service connection state.", + "readOnly": true, + "type": "object", + "properties": { + "status": { + "description": "Gets or sets the status.", + "readOnly": true, + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateEndpointConnectionStatus", + "modelAsString": true + } + }, + "description": { + "description": "Gets or sets description.", + "readOnly": true, + "type": "string" + }, + "actionsRequired": { + "description": "Gets or sets actions required.", + "readOnly": true, + "type": "string" + } + } + }, + "PrivateLinkResources": { + "description": "Class which represent the stamps associated with the vault.", + "readOnly": true, + "type": "object", + "properties": { + "value": { + "description": "A collection of private link resources", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "description": "Link to the next chunk of the response", + "type": "string" + } + } + }, + "PrivateLinkResource": { + "description": "Information of the private link resource.", + "readOnly": true, + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties", + "x-ms-client-flatten": true + }, + "id": { + "description": "Fully qualified identifier of the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "e.g. Microsoft.RecoveryServices/vaults/privateLinkResources", + "readOnly": true, + "type": "string" + } + } + }, + "PrivateLinkResourceProperties": { + "type": "object", + "description": "Properties of the private link resource.", + "properties": { + "groupId": { + "description": "e.g. f9ad6492-33d4-4690-9999-6bfd52a0d081 (Backup) or f9ad6492-33d4-4690-9999-6bfd52a0d082 (SiteRecovery)", + "readOnly": true, + "type": "string" + }, + "requiredMembers": { + "description": "[backup-ecs1, backup-prot1, backup-prot1b, backup-prot1c, backup-id1]", + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + }, + "requiredZoneNames": { + "description": "The private link resource Private link DNS zone name.", + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "CmkKeyVaultProperties": { + "type": "object", + "description": "The properties of the Key Vault which hosts CMK", + "properties": { + "keyUri": { + "description": "The key uri of the Customer Managed Key", + "type": "string" + } + } + }, + "CmkKekIdentity": { + "type": "object", + "description": "The details of the identity used for CMK", + "properties": { + "useSystemAssignedIdentity": { + "type": "boolean", + "description": "Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field" + }, + "userAssignedIdentity": { + "type": "string", + "description": "The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned" + } + } + }, + "OperationResource": { + "type": "object", + "description": "Operation Resource", + "properties": { + "endTime": { + "description": "End time of the operation", + "format": "date-time", + "type": "string" + }, + "error": { + "$ref": "#/definitions/Error", + "description": "Required if status == failed or status == canceled. This is the OData v4 error format, used by the RPC and will go into the v2.2 Azure REST API guidelines." + }, + "id": { + "description": "It should match what is used to GET the operation result", + "type": "string" + }, + "name": { + "description": "It must match the last segment of the \"id\" field, and will typically be a GUID / system generated value", + "type": "string" + }, + "status": { + "description": "The status of the operation. (InProgress/Success/Failed/Cancelled)", + "type": "string" + }, + "startTime": { + "description": "Start time of the operation", + "format": "date-time", + "type": "string" + } + } + }, + "CloudError": { + "description": "An error response from Azure Backup.", + "properties": { + "error": { + "$ref": "#/definitions/Error" + } + }, + "title": "CloudError", + "x-ms-external": true + }, + "Error": { + "description": "The resource management error response.", + "properties": { + "additionalInfo": { + "description": "The error additional info.", + "items": { + "$ref": "#/definitions/ErrorAdditionalInfo" + }, + "readOnly": true, + "type": "array" + }, + "code": { + "description": "The error code.", + "readOnly": true, + "type": "string" + }, + "details": { + "description": "The error details.", + "items": { + "$ref": "#/definitions/Error" + }, + "readOnly": true, + "type": "array" + }, + "message": { + "description": "The error message.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "The error target.", + "readOnly": true, + "type": "string" + } + } + }, + "ErrorAdditionalInfo": { + "description": "The resource management error additional info.", + "properties": { + "info": { + "description": "The additional info.", + "readOnly": true, + "type": "object" + }, + "type": { + "description": "The additional info type.", + "readOnly": true, + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription Id.", + "required": true, + "type": "string" + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group where the recovery services vault is present.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "VaultName": { + "name": "vaultName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account." + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/vaultusages.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/vaultusages.json new file mode 100644 index 000000000000..f87374e37e15 --- /dev/null +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/vaultusages.json @@ -0,0 +1,189 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01", + "title": "RecoveryServicesClient", + "x-ms-code-generation-settings": { + "internalConstructors": false + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/usages": { + "get": { + "tags": [ + "VaultUsages" + ], + "description": "Fetches the usages of the vault.", + "operationId": "Usages_ListByVaults", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultUsageList" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Gets vault usages": { + "$ref": "./examples/ListUsages.json" + } + } + } + } + }, + "definitions": { + "VaultUsage": { + "description": "Usages of a vault.", + "type": "object", + "properties": { + "unit": { + "description": "Unit of the usage.", + "enum": [ + "Count", + "Bytes", + "Seconds", + "Percent", + "CountPerSecond", + "BytesPerSecond" + ], + "type": "string", + "x-ms-enum": { + "name": "UsagesUnit", + "modelAsString": true + } + }, + "quotaPeriod": { + "description": "Quota period of usage.", + "type": "string" + }, + "nextResetTime": { + "format": "date-time", + "description": "Next reset time of usage.", + "type": "string" + }, + "currentValue": { + "format": "int64", + "description": "Current value of usage.", + "type": "integer" + }, + "limit": { + "format": "int64", + "description": "Limit of usage.", + "type": "integer" + }, + "name": { + "$ref": "#/definitions/NameInfo", + "description": "Name of usage." + } + } + }, + "VaultUsageList": { + "description": "Usage for vault.", + "type": "object", + "properties": { + "value": { + "description": "The list of usages for the given vault.", + "type": "array", + "items": { + "$ref": "#/definitions/VaultUsage" + } + } + } + }, + "NameInfo": { + "description": "The name of usage.", + "type": "object", + "properties": { + "value": { + "description": "Value of usage.", + "type": "string" + }, + "localizedValue": { + "description": "Localized value of usage.", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription Id.", + "required": true, + "type": "string" + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group where the recovery services vault is present.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "VaultName": { + "name": "vaultName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account." + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/recoveryservices/resource-manager/readme.md b/specification/recoveryservices/resource-manager/readme.md index cedd31067b16..d95a85d909ed 100644 --- a/specification/recoveryservices/resource-manager/readme.md +++ b/specification/recoveryservices/resource-manager/readme.md @@ -28,7 +28,7 @@ These are the global settings for the RecoveryServices API. title: RecoveryServicesClient description: Recovery Services Client openapi-type: arm -tag: package-2021-03 +tag: package-2021-06 ``` ### Validations @@ -42,28 +42,54 @@ semantic-validator: true message-format: json ``` + +### Tag: package-2021-06 + +These settings apply only when `--tag=package-2021-06` is specified on the command line. + +```yaml $(tag) == 'package-2021-06' +input-file: + - Microsoft.RecoveryServices/stable/2021-06-01/registeredidentities.json + - Microsoft.RecoveryServices/stable/2021-06-01/replicationusages.json + - Microsoft.RecoveryServices/stable/2021-06-01/vaults.json + - Microsoft.RecoveryServices/stable/2021-06-01/vaultusages.json +``` +### Tag: package-2021-04 + +These settings apply only when `--tag=package-2021-04` is specified on the command line. + +``` yaml $(tag) == 'package-2021-04' +input-file: + - Microsoft.RecoveryServices/stable/2021-04-01/registeredidentities.json + - Microsoft.RecoveryServices/stable/2021-04-01/replicationusages.json + - Microsoft.RecoveryServices/stable/2021-04-01/vaults.json + - Microsoft.RecoveryServices/stable/2021-04-01/vaultusages.json +``` + ### Tag: package-2021-03 These settings apply only when `--tag=package-2021-03` is specified on the command line. -```yaml $(tag) == 'package-2021-03' +``` yaml $(tag) == 'package-2021-03' input-file: - Microsoft.RecoveryServices/stable/2021-03-01/registeredidentities.json - Microsoft.RecoveryServices/stable/2021-03-01/replicationusages.json - Microsoft.RecoveryServices/stable/2021-03-01/vaults.json - Microsoft.RecoveryServices/stable/2021-03-01/vaultusages.json ``` + ### Tag: package-2021-02 These settings apply only when `--tag=package-2021-02` is specified on the command line. -```yaml $(tag) == 'package-2021-02' +``` yaml $(tag) == 'package-2021-02' input-file: - Microsoft.RecoveryServices/stable/2021-02-10/registeredidentities.json - Microsoft.RecoveryServices/stable/2021-02-10/replicationusages.json - Microsoft.RecoveryServices/stable/2021-02-10/vaults.json - Microsoft.RecoveryServices/stable/2021-02-10/vaultusages.json ``` + ### Tag: package-2016-06 These settings apply only when `--tag=package-2016-06` is specified on the command line. @@ -124,7 +150,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js @@ -154,6 +180,10 @@ csharp: See configuration in [readme.go.md](./readme.go.md) +## Python + +See configuration in [readme.python.md](./readme.python.md) + ## Java These settings apply only when `--java` is specified on the command line. @@ -187,4 +217,3 @@ java: regenerate-manager: true generate-interface: true ``` - diff --git a/specification/recoveryservices/resource-manager/readme.python.md b/specification/recoveryservices/resource-manager/readme.python.md index 777ef088bf30..6691aa8e3cb2 100644 --- a/specification/recoveryservices/resource-manager/readme.python.md +++ b/specification/recoveryservices/resource-manager/readme.python.md @@ -4,31 +4,13 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.recoveryservices - package-name: azure-mgmt-recoveryservices - clear-output-folder: true -``` - ``` yaml $(python) && $(track2) -python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.recoveryservices package-name: azure-mgmt-recoveryservices package-version: 1.0.0b1 -clear-output-folder: false -``` - -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/recoveryservices/azure-mgmt-recoveryservices/azure/mgmt/recoveryservices +clear-output-folder: true ``` ``` yaml $(python) && $(python-mode) == 'update' && $(track2) @@ -36,12 +18,6 @@ no-namespace-folders: true output-folder: $(python-sdks-folder)/recoveryservices/azure-mgmt-recoveryservices/azure/mgmt/recoveryservices ``` -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/recoveryservices/azure-mgmt-recoveryservices -``` - ``` yaml $(python) && $(python-mode) == 'create' && $(track2) basic-setup-py: true output-folder: $(python-sdks-folder)/recoveryservices/azure-mgmt-recoveryservices diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2018-12-20/bms.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2018-12-20/bms.json index 708f9d32f3bd..f5442df10e62 100644 --- a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2018-12-20/bms.json +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2018-12-20/bms.json @@ -3157,10 +3157,28 @@ "items": { "type": "string" } + }, + "identityInfo": { + "$ref": "#/definitions/IdentityInfo", + "description": "Managed Identity information required to access customer storage account." } }, "x-ms-discriminator-value": "IaasVMRestoreRequest" }, + "IdentityInfo": { + "description": "Encapsulates Managed Identity related information", + "type": "object", + "properties": { + "isSystemAssignedIdentity": { + "description": "To differentiate if the managed identity is system assigned or user assigned", + "type": "boolean" + }, + "managedIdentityResourceId": { + "description": "Managed Identity Resource Id\r\nOptional: Might not be required in the case of system assigned managed identity", + "type": "string" + } + } + }, "InstantItemRecoveryTarget": { "description": "Target details for file / folder restore.", "type": "object", diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2018-12-20/examples/AzureIaasVm/GetAccessToken_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2018-12-20/examples/AzureIaasVm/GetAccessToken_Get.json index bedda70ca471..b45d741ae88e 100644 --- a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2018-12-20/examples/AzureIaasVm/GetAccessToken_Get.json +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2018-12-20/examples/AzureIaasVm/GetAccessToken_Get.json @@ -7,7 +7,7 @@ "containerName": "IaasVMContainer;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall", "protectedItemName": "VM;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall", "recoveryPointId": "26083826328862", - "api-version": "2018-12-20-preview", + "api-version": "2018-12-20", "parameters": { "properties": { "tenantId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d", diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2018-12-20/examples/AzureIaasVm/TriggerCrossRegionRestore_Post.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2018-12-20/examples/AzureIaasVm/TriggerCrossRegionRestore_Post.json index 4b56c8015e36..ac84c031efe5 100644 --- a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2018-12-20/examples/AzureIaasVm/TriggerCrossRegionRestore_Post.json +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2018-12-20/examples/AzureIaasVm/TriggerCrossRegionRestore_Post.json @@ -30,6 +30,10 @@ "encryptionDetails": { "encryptionEnabled": false }, + "identityInfo": { + "isSystemAssignedIdentity": false, + "managedIdentityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/asmaskarRG1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/asmaskartestmsi" + }, "objectType": "IaasVMRestoreRequest", "originalStorageAccountOption": false, "recoveryPointId": "87178355392716", diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/bms.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/bms.json index bb35d0d9bbf9..6be5e3ba24ae 100644 --- a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/bms.json +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/bms.json @@ -18,6 +18,149 @@ "application/json" ], "paths": { + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig": { + "get": { + "tags": [ + "BackupResourceStorageConfigsNonCRR" + ], + "description": "Fetches resource storage config.", + "operationId": "BackupResourceStorageConfigsNonCRR_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupResourceConfigResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/NewErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Vault Storage Configuration": { + "$ref": "./examples/Common/BackupStorageConfig_Get.json" + } + } + }, + "put": { + "tags": [ + "BackupResourceStorageConfigsNonCRR" + ], + "description": "Updates vault storage model type.", + "operationId": "BackupResourceStorageConfigsNonCRR_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "Vault storage config request", + "required": true, + "schema": { + "$ref": "#/definitions/BackupResourceConfigResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupResourceConfigResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/NewErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Vault Storage Configuration": { + "$ref": "./examples/Common/BackupStorageConfig_Put.json" + } + } + }, + "patch": { + "tags": [ + "BackupResourceStorageConfigsNonCRR" + ], + "description": "Updates vault storage model type.", + "operationId": "BackupResourceStorageConfigsNonCRR_patch", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "Vault storage config request", + "required": true, + "schema": { + "$ref": "#/definitions/BackupResourceConfigResource" + } + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/NewErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Vault Storage Configuration": { + "$ref": "./examples/Common/BackupStorageConfig_Patch.json" + } + } + } + }, "/Subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupPreValidateProtection": { "post": { "tags": [ @@ -5885,6 +6028,73 @@ }, "x-ms-discriminator-value": "DpmJob" }, + "BackupResourceConfigResource": { + "description": "The resource storage details.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BackupResourceConfig", + "description": "BackupResourceConfigResource properties" + } + } + }, + "BackupResourceConfig": { + "description": "The resource storage details.", + "type": "object", + "properties": { + "storageModelType": { + "description": "Storage type", + "enum": [ + "Invalid", + "GeoRedundant", + "LocallyRedundant", + "ZoneRedundant", + "ReadAccessGeoZoneRedundant" + ], + "type": "string", + "x-ms-enum": { + "name": "StorageType", + "modelAsString": true + } + }, + "storageType": { + "description": "Storage type.", + "enum": [ + "Invalid", + "GeoRedundant", + "LocallyRedundant", + "ZoneRedundant", + "ReadAccessGeoZoneRedundant" + ], + "type": "string", + "x-ms-enum": { + "name": "StorageType", + "modelAsString": true + } + }, + "storageTypeState": { + "description": "Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked.", + "enum": [ + "Invalid", + "Locked", + "Unlocked" + ], + "type": "string", + "x-ms-enum": { + "name": "StorageTypeState", + "modelAsString": true + } + }, + "crossRegionRestoreFlag": { + "description": "Opt in details of Cross Region Restore feature.", + "type": "boolean" + } + } + }, "DpmJobExtendedInfo": { "description": "Additional information on the DPM workload-specific job.", "type": "object", diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/AzureIaasVm/RecoveryPoints_List.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/AzureIaasVm/RecoveryPoints_List.json index 979951e5f8d1..207d7279b695 100644 --- a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/AzureIaasVm/RecoveryPoints_List.json +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/AzureIaasVm/RecoveryPoints_List.json @@ -6,7 +6,7 @@ "fabricName": "Azure", "containerName": "IaasVMContainer;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall", "protectedItemName": "VM;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall", - "api-version": "2021-01-01" + "api-version": "2019-05-13" }, "responses": { "200": { @@ -27,18 +27,13 @@ "recoveryPointTierDetails": [ { "type": "InstantRP", - "status": "Deleted" + "status": "Valid" }, { "type": "HardenedRP", "status": "Valid" } ], - "recoveryPointMoveReadinessInfo": { - "Archive": { - "isReadyForMove": true - } - }, "isManagedVirtualMachine": true, "virtualMachineSize": "Standard_D1", "originalStorageAccountOption": false @@ -59,26 +54,13 @@ "recoveryPointTierDetails": [ { "type": "InstantRP", - "status": "Deleted" + "status": "Valid" }, { "type": "HardenedRP", - "status": "Deleted" - }, - { - "type": "ArchivedRP", - "status": "Rehydrated", - "extendedInfo": { - "RehydratedRPExpiryTime": "2020-12-21T22:48:25.4353958Z" - } + "status": "Valid" } ], - "recoveryPointMoveReadinessInfo": { - "ArchivedRP": { - "isReadyForMove": false, - "additionalInfo": "Recovery point cannot be moved to archive tier since it has already been moved." - } - }, "isManagedVirtualMachine": true, "virtualMachineSize": "Standard_D1", "originalStorageAccountOption": false, diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/Common/BackupStorageConfig_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/Common/BackupStorageConfig_Get.json new file mode 100644 index 000000000000..a22ef9d6df43 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/Common/BackupStorageConfig_Get.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "PythonSDKBackupTestRg", + "vaultName": "PySDKBackupTestRsVault", + "api-version": "2016-12-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupstorageconfig/vaultstorageconfig", + "name": "vaultstorageconfig", + "type": "Microsoft.RecoveryServices/vaults/backupstorageconfig", + "properties": { + "storageModelType": "GeoRedundant", + "storageType": "GeoRedundant", + "storageTypeState": "Locked" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/Common/BackupStorageConfig_Patch.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/Common/BackupStorageConfig_Patch.json new file mode 100644 index 000000000000..34f7e0fea52d --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/Common/BackupStorageConfig_Patch.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "PythonSDKBackupTestRg", + "vaultName": "PySDKBackupTestRsVault", + "api-version": "2016-12-01", + "parameters": { + "properties": { + "storageType": "LocallyRedundant", + "storageTypeState": "Unlocked" + } + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/Common/BackupStorageConfig_Put.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/Common/BackupStorageConfig_Put.json new file mode 100644 index 000000000000..67f6df781093 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/Common/BackupStorageConfig_Put.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "PythonSDKBackupTestRg", + "vaultName": "PySDKBackupTestRsVault", + "api-version": "2016-12-01", + "parameters": { + "properties": { + "storageType": "LocallyRedundant", + "storageTypeState": "Unlocked" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupstorageconfig/vaultstorageconfig", + "name": "vaultstorageconfig", + "type": "Microsoft.RecoveryServices/vaults/backupstorageconfig", + "properties": { + "storageModelType": "LocallyRedundant", + "storageType": "LocallyRedundant", + "storageTypeState": "Unlocked" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/Common/ProtectedItem_Delete_OperationStatus.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/Common/ProtectedItem_Delete_OperationStatus.json index 63e5d3412e3d..493f0919fdf3 100644 --- a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/Common/ProtectedItem_Delete_OperationStatus.json +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/Common/ProtectedItem_Delete_OperationStatus.json @@ -14,7 +14,7 @@ "name": "00000000-0000-0000-0000-000000000000", "status": "InProgress", "startTime": "2017-08-03T06:52:53.886027Z", - "endTime": "0001-01-01T00:00:00.00000Z" + "endTime": "2017-09-03T06:52:53.886027Z" } } } diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/bms.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/bms.json new file mode 100644 index 000000000000..d6808c34470a --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/bms.json @@ -0,0 +1,11360 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01", + "title": "RecoveryServicesBackupClient", + "x-ms-code-generation-settings": { + "internalConstructors": false + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/Subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupPreValidateProtection": { + "post": { + "tags": [ + "ProtectionIntent" + ], + "summary": "It will validate followings\r\n1. Vault capacity\r\n2. VM is already protected\r\n3. Any VM related configuration passed in properties.", + "operationId": "ProtectionIntent_Validate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/AzureRegion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "Enable backup validation request on Virtual Machine", + "required": true, + "schema": { + "$ref": "#/definitions/PreValidateEnableBackupRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PreValidateEnableBackupResponse" + } + } + }, + "x-ms-examples": { + "Validate Enable Protection on Azure Vm": { + "$ref": "./examples/AzureIaasVm/ProtectionIntent_Validate.json" + } + } + } + }, + "/Subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupStatus": { + "post": { + "tags": [ + "BackupStatus" + ], + "summary": "Get the container backup status", + "operationId": "BackupStatus_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/AzureRegion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "Container Backup Status Request", + "required": true, + "schema": { + "$ref": "#/definitions/BackupStatusRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupStatusResponse" + } + } + }, + "x-ms-examples": { + "Get Azure Virtual Machine Backup Status": { + "$ref": "./examples/AzureIaasVm/GetBackupStatus.json" + } + } + } + }, + "/Subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupValidateFeatures": { + "post": { + "tags": [ + "FeatureSupport" + ], + "summary": "It will validate if given feature with resource properties is supported in service", + "operationId": "FeatureSupport_Validate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/AzureRegion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "Feature support request object", + "required": true, + "schema": { + "$ref": "#/definitions/FeatureSupportRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureVMResourceFeatureSupportResponse" + } + } + }, + "x-ms-examples": { + "Check Azure Vm Backup Feature Support": { + "$ref": "./examples/AzureIaasVm/BackupFeature_Validate.json" + } + } + } + }, + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/backupProtectionIntent/{intentObjectName}": { + "get": { + "tags": [ + "ProtectionIntent" + ], + "description": "Provides the details of the protection intent up item. This is an asynchronous operation. To know the status of the operation,\r\ncall the GetItemOperationResult API.", + "operationId": "ProtectionIntent_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the backed up item.", + "required": true, + "type": "string" + }, + { + "name": "intentObjectName", + "in": "path", + "description": "Backed up item name whose details are to be fetched.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionIntentResource" + } + } + }, + "x-ms-examples": { + "Get ProtectionIntent for an item": { + "$ref": "./examples/AzureWorkload/BackupProtectionIntent_Get.json" + } + } + }, + "put": { + "tags": [ + "ProtectionIntent" + ], + "description": "Create Intent for Enabling backup of an item. This is a synchronous operation.", + "operationId": "ProtectionIntent_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the backup item.", + "required": true, + "type": "string" + }, + { + "name": "intentObjectName", + "in": "path", + "description": "Intent object name.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "resource backed up item", + "required": true, + "schema": { + "$ref": "#/definitions/ProtectionIntentResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionIntentResource" + } + } + }, + "x-ms-examples": { + "Create or Update Azure Vm Protection Intent": { + "$ref": "./examples/AzureIaasVm/ProtectionIntent_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "ProtectionIntent" + ], + "description": "Used to remove intent from an item", + "operationId": "ProtectionIntent_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the intent.", + "required": true, + "type": "string" + }, + { + "name": "intentObjectName", + "in": "path", + "description": "Intent to be deleted.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "NoContent" + } + }, + "x-ms-examples": { + "Delete Protection intent from item": { + "$ref": "./examples/AzureWorkload/BackupProtectionIntent_Delete.json" + } + } + } + }, + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectionIntents": { + "get": { + "tags": [ + "BackupProtectionIntent" + ], + "description": "Provides a pageable list of all intents that are present within a vault.", + "operationId": "BackupProtectionIntent_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "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/ProtectionIntentResourceList" + } + } + }, + "x-ms-odata": "#/definitions/ProtectionIntentQueryObject", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List protection intent with backupManagementType filter": { + "$ref": "./examples/AzureWorkload/BackupProtectionIntent_List.json" + } + } + } + }, + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupUsageSummaries": { + "get": { + "tags": [ + "BackupUsageSummaries" + ], + "description": "Fetches the backup management usage summaries of the vault.", + "operationId": "BackupUsageSummaries_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "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/BackupManagementUsageList" + } + } + }, + "x-ms-odata": "#/definitions/BMSBackupSummariesQueryObject", + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Get Protected Items Usages Summary": { + "$ref": "./examples/Common/BackupProtectedItem_UsageSummary_Get.json" + }, + "Get Protected Containers Usages Summary": { + "$ref": "./examples/Common/BackupProtectionContainers_UsageSummary_Get.json" + } + } + } + }, + "/providers/Microsoft.RecoveryServices/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Returns the list of available operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClientDiscoveryResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + }, + "x-ms-examples": { + "ListOperations": { + "$ref": "./examples/ListOperations.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupconfig/vaultconfig": { + "get": { + "tags": [ + "BackupResourceVaultConfigs" + ], + "description": "Fetches resource vault config.", + "operationId": "BackupResourceVaultConfigs_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupResourceVaultConfigResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/NewErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Vault Security Config": { + "$ref": "./examples/Common/BackupResourceVaultConfigs_Get.json" + } + } + }, + "patch": { + "tags": [ + "BackupResourceVaultConfigs" + ], + "description": "Updates vault security config.", + "operationId": "BackupResourceVaultConfigs_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "resource config request", + "required": true, + "schema": { + "$ref": "#/definitions/BackupResourceVaultConfigResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupResourceVaultConfigResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/NewErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Vault Security Config": { + "$ref": "./examples/Common/BackupResourceVaultConfigs_Patch.json" + } + } + }, + "put": { + "tags": [ + "BackupResourceVaultConfigs" + ], + "description": "Updates vault security config. ", + "operationId": "BackupResourceVaultConfigs_Put", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "resource config request", + "required": true, + "schema": { + "$ref": "#/definitions/BackupResourceVaultConfigResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupResourceVaultConfigResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/NewErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Vault Security Config": { + "$ref": "./examples/Common/BackupResourceVaultConfigs_Put.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupEncryptionConfigs/backupResourceEncryptionConfig": { + "get": { + "tags": [ + "BackupResourceEncryptionConfigs" + ], + "description": "Fetches Vault Encryption config.", + "operationId": "BackupResourceEncryptionConfigs_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupResourceEncryptionConfigExtendedResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/NewErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Vault Encryption Configuration": { + "$ref": "./examples/BackupResourceEncryptionConfig_Get.json" + } + } + }, + "put": { + "tags": [ + "BackupResourceEncryptionConfigs" + ], + "description": "Updates Vault encryption config.", + "operationId": "BackupResourceEncryptionConfigs_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "Vault encryption input config request", + "required": true, + "schema": { + "$ref": "#/definitions/BackupResourceEncryptionConfigResource" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/NewErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Vault Encryption Configuration": { + "$ref": "./examples/BackupResourceEncryptionConfig_Put.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnection" + ], + "description": "Get Private Endpoint Connection. This call is made by Backup Admin.", + "operationId": "PrivateEndpointConnection_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/NewErrorResponse" + } + } + }, + "x-ms-examples": { + "Get PrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/GetPrivateEndpointConnection.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnection" + ], + "description": "Approve or Reject Private Endpoint requests. This call is made by Backup Admin.", + "operationId": "PrivateEndpointConnection_Put", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update PrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/PutPrivateEndpointConnection.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnection" + ], + "description": "Delete Private Endpoint requests. This call is made by Backup Admin.", + "operationId": "PrivateEndpointConnection_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete PrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/DeletePrivateEndpointConnection.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}/operationsStatus/{operationId}": { + "get": { + "tags": [ + "PrivateEndpoint" + ], + "summary": "Gets the operation status for a private endpoint connection.", + "operationId": "PrivateEndpoint_GetOperationStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/NewErrorResponse" + } + } + }, + "x-ms-examples": { + "Get OperationStatus": { + "$ref": "./examples/PrivateEndpointConnection/GetPrivateEndpointConnectionOperationStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig/operationStatus/{operationId}": { + "get": { + "tags": [ + "DataMove" + ], + "description": "Fetches operation status for data move operation on vault", + "operationId": "GetOperationStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/NewErrorResponse" + } + } + }, + "x-ms-examples": { + "Get OperationStatus": { + "$ref": "./examples/BackupDataMove/BackupDataMoveOperationStatus_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig/prepareDataMove": { + "post": { + "tags": [ + "DataMove" + ], + "description": "Prepares source vault for Data Move operation", + "operationId": "BMSPrepareDataMove", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "Prepare data move request", + "required": true, + "schema": { + "$ref": "#/definitions/PrepareDataMoveRequest" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/NewErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Prepare Data Move": { + "$ref": "./examples/BackupDataMove/PrepareDataMove_Post.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig/operationResults/{operationId}": { + "get": { + "tags": [ + "BMSPrepareDataMoveOperationResult" + ], + "description": "Fetches Operation Result for Prepare Data Move", + "operationId": "BMSPrepareDataMoveOperationResult_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultStorageConfigOperationResultResponse" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed. ", + "schema": { + "$ref": "#/definitions/NewErrorResponse" + } + } + }, + "x-ms-examples": { + "Get operation result for PrepareDataMove": { + "$ref": "./examples/BackupDataMove/PrepareDataMoveOperationResult_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig/triggerDataMove": { + "post": { + "tags": [ + "DataMove" + ], + "description": "Triggers Data Move Operation on target vault", + "operationId": "BMSTriggerDataMove", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "Trigger data move request", + "required": true, + "schema": { + "$ref": "#/definitions/TriggerDataMoveRequest" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/NewErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Trigger Data Move": { + "$ref": "./examples/BackupDataMove/TriggerDataMove_Post.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}": { + "get": { + "tags": [ + "ProtectedItems" + ], + "description": "Provides the details of the backed up item. This is an asynchronous operation. To know the status of the operation,\r\ncall the GetItemOperationResult API.", + "operationId": "ProtectedItems_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the backed up item.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Container name associated with the backed up item.", + "required": true, + "type": "string" + }, + { + "name": "protectedItemName", + "in": "path", + "description": "Backed up item name whose details are to be fetched.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectedItemResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/GetProtectedItemQueryObject", + "x-ms-examples": { + "Get Protected Classic Virtual Machine Details": { + "$ref": "./examples/AzureIaasVm/ClassicCompute_ProtectedItem_Get.json" + }, + "Get Protected Virtual Machine Details": { + "$ref": "./examples/AzureIaasVm/Compute_ProtectedItem_Get.json" + } + } + }, + "put": { + "tags": [ + "ProtectedItems" + ], + "description": "Enables backup of an item or to modifies the backup policy information of an already backed up item. This is an\r\nasynchronous operation. To know the status of the operation, call the GetItemOperationResult API.", + "operationId": "ProtectedItems_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the backup item.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Container name associated with the backup item.", + "required": true, + "type": "string" + }, + { + "name": "protectedItemName", + "in": "path", + "description": "Item name to be backed up.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "resource backed up item", + "required": true, + "schema": { + "$ref": "#/definitions/ProtectedItemResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectedItemResource" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Enable Protection on Azure IaasVm": { + "$ref": "./examples/AzureIaasVm/ConfigureProtection.json" + }, + "Stop Protection with retain data on Azure IaasVm": { + "$ref": "./examples/AzureIaasVm/StopProtection.json" + } + } + }, + "delete": { + "tags": [ + "ProtectedItems" + ], + "description": "Used to disable backup of an item within a container. This is an asynchronous operation. To know the status of the\r\nrequest, call the GetItemOperationResult API.", + "operationId": "ProtectedItems_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the backed up item.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Container name associated with the backed up item.", + "required": true, + "type": "string" + }, + { + "name": "protectedItemName", + "in": "path", + "description": "Backed up item to be deleted.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Protection from Azure Virtual Machine": { + "$ref": "./examples/Common/ProtectedItem_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/operationResults/{operationId}": { + "get": { + "tags": [ + "ProtectedItemOperationResults" + ], + "description": "Fetches the result of any operation on the backup item.", + "operationId": "ProtectedItemOperationResults_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the backup item.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Container name associated with the backup item.", + "required": true, + "type": "string" + }, + { + "name": "protectedItemName", + "in": "path", + "description": "Backup item name whose details are to be fetched.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "OperationID which represents the operation whose result needs to be fetched.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectedItemResource" + } + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Operation Results of Protected Vm": { + "$ref": "./examples/AzureIaasVm/ProtectedItemOperationResults.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints": { + "get": { + "tags": [ + "RecoveryPoints" + ], + "description": "Lists the backup copies for the backed up item.", + "operationId": "RecoveryPoints_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the backed up item.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Container name associated with the backed up item.", + "required": true, + "type": "string" + }, + { + "name": "protectedItemName", + "in": "path", + "description": "Backed up item whose backup copies are to be fetched.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPointResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/BMSRPQueryObject", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Protected Azure Vm Recovery Points": { + "$ref": "./examples/AzureIaasVm/RecoveryPoints_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}": { + "get": { + "tags": [ + "RecoveryPoints" + ], + "description": "Provides the information of the backed up data identified using RecoveryPointID. This is an asynchronous operation.\r\nTo know the status of the operation, call the GetProtectedItemOperationResult API.", + "operationId": "RecoveryPoints_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with backed up item.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Container name associated with backed up item.", + "required": true, + "type": "string" + }, + { + "name": "protectedItemName", + "in": "path", + "description": "Backed up item name whose backup data needs to be fetched.", + "required": true, + "type": "string" + }, + { + "name": "recoveryPointId", + "in": "path", + "description": "RecoveryPointID represents the backed up data to be fetched.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPointResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Azure Vm Recovery Point Details": { + "$ref": "./examples/AzureIaasVm/RecoveryPoints_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/restore": { + "post": { + "tags": [ + "Restores" + ], + "description": "Restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use\r\nGetProtectedItemOperationResult API.", + "operationId": "Restores_Trigger", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the backed up items.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Container name associated with the backed up items.", + "required": true, + "type": "string" + }, + { + "name": "protectedItemName", + "in": "path", + "description": "Backed up item to be restored.", + "required": true, + "type": "string" + }, + { + "name": "recoveryPointId", + "in": "path", + "description": "Recovery point ID which represents the backed up data to be restored.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "resource restore request", + "required": true, + "schema": { + "$ref": "#/definitions/RestoreRequestResource" + } + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Restore to New Azure IaasVm with IaasVMRestoreRequest": { + "$ref": "./examples/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest.json" + }, + "Restore to New Azure IaasVm with IaasVMRestoreWithRehydrationRequest": { + "$ref": "./examples/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreWithRehydrationRequest.json" + }, + "Restore Disks with IaasVMRestoreRequest": { + "$ref": "./examples/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreRequest.json" + }, + "Restore Disks with IaasVMRestoreWithRehydrationRequest": { + "$ref": "./examples/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreWithRehydrationRequest.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies": { + "get": { + "tags": [ + "BackupPolicies" + ], + "description": "Lists of backup policies associated with Recovery Services Vault. API provides pagination parameters to fetch\r\nscoped results.", + "operationId": "BackupPolicies_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionPolicyResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/ProtectionPolicyQueryObject", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List protection policies with backupManagementType filter as AzureIaasVm": { + "$ref": "./examples/AzureIaasVm/BackupPolicies_List.json" + }, + "List protection policies with backupManagementType filter as AzureWorkload": { + "$ref": "./examples/AzureWorkload/BackupPolicies_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}": { + "get": { + "tags": [ + "ProtectionPolicies" + ], + "description": "Provides the details of the backup policies associated to Recovery Services Vault. This is an asynchronous\r\noperation. Status of the operation can be fetched using GetPolicyOperationResult API.", + "operationId": "ProtectionPolicies_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "policyName", + "in": "path", + "description": "Backup policy information to be fetched.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionPolicyResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Azure IaasVm Protection Policy Details": { + "$ref": "./examples/AzureIaasVm/ProtectionPolicies_Get.json" + } + } + }, + "put": { + "tags": [ + "ProtectionPolicies" + ], + "description": "Creates or modifies a backup policy. This is an asynchronous operation. Status of the operation can be fetched\r\nusing GetPolicyOperationResult API.", + "operationId": "ProtectionPolicies_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "policyName", + "in": "path", + "description": "Backup policy to be created.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "resource backup policy", + "required": true, + "schema": { + "$ref": "#/definitions/ProtectionPolicyResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionPolicyResource" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create or Update Simple Azure Vm Protection Policy": { + "$ref": "./examples/AzureIaasVm/ProtectionPolicies_CreateOrUpdate_Simple.json" + }, + "Create or Update Full Azure Vm Protection Policy": { + "$ref": "./examples/AzureIaasVm/ProtectionPolicies_CreateOrUpdate_Complex.json" + }, + "Create or Update Full Azure Workload Protection Policy": { + "$ref": "./examples/AzureWorkload/ProtectionPolicies_CreateOrUpdate_Complex.json" + } + } + }, + "delete": { + "tags": [ + "ProtectionPolicies" + ], + "description": "Deletes specified backup policy from your Recovery Services Vault. This is an asynchronous operation. Status of the\r\noperation can be fetched using GetProtectionPolicyOperationResult API.", + "operationId": "ProtectionPolicies_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "policyName", + "in": "path", + "description": "Backup policy to be deleted.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Azure Vm Protection Policy": { + "$ref": "./examples/AzureIaasVm/ProtectionPolicies_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}/operationResults/{operationId}": { + "get": { + "tags": [ + "ProtectionPolicyOperationResults" + ], + "description": "Provides the result of an operation.", + "operationId": "ProtectionPolicyOperationResults_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "policyName", + "in": "path", + "description": "Backup policy name whose operation's result needs to be fetched.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation ID which represents the operation whose result needs to be fetched.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionPolicyResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Protection Policy Operation Results": { + "$ref": "./examples/AzureIaasVm/ProtectionPolicyOperationResults_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs": { + "get": { + "tags": [ + "BackupJobs" + ], + "description": "Provides a pageable list of jobs.", + "operationId": "BackupJobs_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "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/JobResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/JobQueryObject", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List All Jobs": { + "$ref": "./examples/Common/ListJobs.json" + }, + "List Jobs With Filters": { + "$ref": "./examples/Common/ListJobsWithAllSupportedFilters.json" + }, + "List Jobs With Time Filter": { + "$ref": "./examples/Common/ListJobsWithStartTimeAndEndTimeFilters.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/{jobName}": { + "get": { + "tags": [ + "JobDetails" + ], + "description": "Gets extended information associated with the job.", + "operationId": "JobDetails_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "jobName", + "in": "path", + "description": "Name of the job whose details are to be fetched.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Job Details": { + "$ref": "./examples/Common/GetJobDetails.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/{jobName}/cancel": { + "post": { + "tags": [ + "JobCancellations" + ], + "description": "Cancels a job. This is an asynchronous operation. To know the status of the cancellation, call\r\nGetCancelOperationResult API.", + "operationId": "JobCancellations_Trigger", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "jobName", + "in": "path", + "description": "Name of the job to cancel.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Cancel Job": { + "$ref": "./examples/Common/TriggerCancelJob.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/{jobName}/operationResults/{operationId}": { + "get": { + "tags": [ + "JobOperationResults" + ], + "description": "Fetches the result of any operation.", + "operationId": "JobOperationResults_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "jobName", + "in": "path", + "description": "Job name whose operation result has to be fetched.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "OperationID which represents the operation whose result has to be fetched.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Cancel Job Operation Result": { + "$ref": "./examples/Common/CancelJobOperationResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/operationResults/{operationId}": { + "get": { + "tags": [ + "ExportJobsOperationResults" + ], + "description": "Gets the operation result of operation triggered by Export Jobs API. If the operation is successful, then it also\r\ncontains URL of a Blob and a SAS key to access the same. The blob contains exported jobs in JSON serialized format.", + "operationId": "ExportJobsOperationResults_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "operationId", + "in": "path", + "description": "OperationID which represents the export job.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationResultInfoBaseResource" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/OperationResultInfoBaseResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Export Jobs Operation Results": { + "$ref": "./examples/Common/ExportJobsOperationResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobsExport": { + "post": { + "tags": [ + "Jobs" + ], + "description": "Triggers export of jobs specified by filters and returns an OperationID to track.", + "operationId": "Jobs_Export", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/JobQueryObject", + "x-ms-examples": { + "Export Jobs": { + "$ref": "./examples/Common/TriggerExportJobs.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectedItems": { + "get": { + "tags": [ + "BackupProtectedItems" + ], + "description": "Provides a pageable list of all items that are backed up within a vault.", + "operationId": "BackupProtectedItems_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "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/ProtectedItemResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/ProtectedItemQueryObject", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List protected items with backupManagementType filter as AzureIaasVm": { + "$ref": "./examples/AzureIaasVm/BackupProtectedItems_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupValidateOperation": { + "post": { + "tags": [ + "Operation" + ], + "description": "Validate operation for specified backed up item. This is a synchronous operation.", + "operationId": "Operation_Validate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "resource validate operation request", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateOperationRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ValidateOperationsResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Validate Operation": { + "$ref": "./examples/AzureIaasVm/ValidateOperation_RestoreDisk.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupEngines": { + "get": { + "tags": [ + "BackupEngines" + ], + "description": "Backup management servers registered to Recovery Services Vault. Returns a pageable list of servers.", + "operationId": "BackupEngines_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "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/BackupEngineBaseResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/BMSBackupEnginesQueryObject", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Dpm/AzureBackupServer/Lajolla Backup Engines": { + "$ref": "./examples/Dpm/BackupEngines_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupEngines/{backupEngineName}": { + "get": { + "tags": [ + "BackupEngines" + ], + "description": "Returns backup management server registered to Recovery Services Vault.", + "operationId": "BackupEngines_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "backupEngineName", + "in": "path", + "description": "Name of the backup management server.", + "required": true, + "type": "string" + }, + { + "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/BackupEngineBaseResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/BMSBackupEngineQueryObject", + "x-ms-examples": { + "Get Dpm/AzureBackupServer/Lajolla Backup Engine Details": { + "$ref": "./examples/Dpm/BackupEngines_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/operationResults/{operationId}": { + "get": { + "tags": [ + "ProtectionContainerRefreshOperationResults" + ], + "description": "Provides the result of the refresh operation triggered by the BeginRefresh operation.", + "operationId": "ProtectionContainerRefreshOperationResults_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the container.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation ID associated with the operation whose result needs to be fetched.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Azure Vm Discovery Operation Result": { + "$ref": "./examples/Common/RefreshContainers_OperationResults.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectableContainers": { + "get": { + "tags": [ + "ProtectableContainers" + ], + "description": "Lists the containers that can be registered to Recovery Services Vault.", + "operationId": "ProtectableContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectableContainerResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/BMSContainerQueryObject", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List protectable items with backupManagementType filter as AzureStorage": { + "$ref": "./examples/AzureStorage/ProtectableContainers_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}": { + "get": { + "tags": [ + "ProtectionContainers" + ], + "description": "Gets details of the specific container registered to your Recovery Services Vault.", + "operationId": "ProtectionContainers_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Name of the fabric where the container belongs.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Name of the container whose details need to be fetched.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Protection Container Details": { + "$ref": "./examples/AzureWorkload/ProtectionContainers_Get.json" + } + } + }, + "put": { + "tags": [ + "ProtectionContainers" + ], + "description": "Registers the container with Recovery Services vault.\r\nThis is an asynchronous operation. To track the operation status, use location header to call get latest status of\r\nthe operation.", + "operationId": "ProtectionContainers_Register", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the container.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Name of the container to be registered.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/ProtectionContainerResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerResource" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "RegisterAzure Storage ProtectionContainers": { + "$ref": "./examples/AzureStorage/ProtectionContainers_Register.json" + } + } + }, + "delete": { + "tags": [ + "ProtectionContainers" + ], + "description": "Unregisters the given container from your Recovery Services Vault. This is an asynchronous operation. To determine\r\nwhether the backend service has finished processing the request, call Get Container Operation Result API.", + "operationId": "ProtectionContainers_Unregister", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Name of the fabric where the container belongs.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Name of the container which needs to be unregistered from the Recovery Services Vault.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Unregister Protection Container": { + "$ref": "./examples/AzureWorkload/ProtectionContainers_Unregister.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/inquire": { + "post": { + "tags": [ + "ProtectionContainers" + ], + "summary": "Inquires all the protectable items under the given container.", + "description": "This is an async operation and the results should be tracked using location header or Azure-async-url.", + "operationId": "ProtectionContainers_Inquire", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric Name associated with the container.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Name of the container in which inquiry needs to be triggered.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/BMSContainersInquiryQueryObject", + "x-ms-examples": { + "Inquire Azure Storage Protection Containers": { + "$ref": "./examples/AzureStorage/ProtectionContainers_Inquire.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/items": { + "get": { + "tags": [ + "BackupWorkloadItems" + ], + "description": "Provides a pageable list of workload item of a specific container according to the query filter and the pagination\r\nparameters.", + "operationId": "BackupWorkloadItems_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the container.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Name of the container.", + "required": true, + "type": "string" + }, + { + "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/WorkloadItemResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/BMSWorkloadItemQueryObject", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Workload Items in Container": { + "$ref": "./examples/AzureWorkload/BackupWorkloadItems_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/operationResults/{operationId}": { + "get": { + "tags": [ + "ProtectionContainerOperationResults" + ], + "description": "Fetches the result of any operation on the container.", + "operationId": "ProtectionContainerOperationResults_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the container.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Container name whose information should be fetched.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation ID which represents the operation whose result needs to be fetched.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerResource" + } + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Azure Storage Protection Container Operation Result": { + "$ref": "./examples/AzureStorage/ProtectionContainers_Inquire_Result.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/backup": { + "post": { + "tags": [ + "Backups" + ], + "description": "Triggers backup for specified backed up item. This is an asynchronous operation. To know the status of the\r\noperation, call GetProtectedItemOperationResult API.", + "operationId": "Backups_Trigger", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the backup item.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Container name associated with the backup item.", + "required": true, + "type": "string" + }, + { + "name": "protectedItemName", + "in": "path", + "description": "Backup item for which backup needs to be triggered.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "resource backup request", + "required": true, + "schema": { + "$ref": "#/definitions/BackupRequestResource" + } + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Trigger Backup": { + "$ref": "./examples/Common/TriggerBackup_Post.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/operationsStatus/{operationId}": { + "get": { + "tags": [ + "ProtectedItemOperationStatuses" + ], + "description": "Fetches the status of an operation such as triggering a backup, restore. The status can be in progress, completed\r\nor failed. You can refer to the OperationStatus enum for all the possible states of the operation. Some operations\r\ncreate jobs. This method returns the list of jobs associated with the operation.", + "operationId": "ProtectedItemOperationStatuses_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the backup item.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Container name associated with the backup item.", + "required": true, + "type": "string" + }, + { + "name": "protectedItemName", + "in": "path", + "description": "Backup item name whose details are to be fetched.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "OperationID represents the operation whose status needs to be fetched.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Operation Status of Protected Vm": { + "$ref": "./examples/AzureIaasVm/ProtectedItemOperationStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/provisionInstantItemRecovery": { + "post": { + "tags": [ + "ItemLevelRecoveryConnections" + ], + "description": "Provisions a script which invokes an iSCSI connection to the backup data. Executing this script opens a file\r\nexplorer displaying all the recoverable files and folders. This is an asynchronous operation. To know the status of\r\nprovisioning, call GetProtectedItemOperationResult API.", + "operationId": "ItemLevelRecoveryConnections_Provision", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the backed up items.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Container name associated with the backed up items.", + "required": true, + "type": "string" + }, + { + "name": "protectedItemName", + "in": "path", + "description": "Backed up item name whose files/folders are to be restored.", + "required": true, + "type": "string" + }, + { + "name": "recoveryPointId", + "in": "path", + "description": "Recovery point ID which represents backed up data. iSCSI connection will be provisioned\r\nfor this backed up data.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "resource ILR request", + "required": true, + "schema": { + "$ref": "#/definitions/ILRRequestResource" + } + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Provision Instant Item Level Recovery for Azure Vm": { + "$ref": "./examples/AzureIaasVm/Provision_Ilr.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/revokeInstantItemRecovery": { + "post": { + "tags": [ + "ItemLevelRecoveryConnections" + ], + "description": "Revokes an iSCSI connection which can be used to download a script. Executing this script opens a file explorer\r\ndisplaying all recoverable files and folders. This is an asynchronous operation.", + "operationId": "ItemLevelRecoveryConnections_Revoke", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the backed up items.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Container name associated with the backed up items.", + "required": true, + "type": "string" + }, + { + "name": "protectedItemName", + "in": "path", + "description": "Backed up item name whose files/folders are to be restored.", + "required": true, + "type": "string" + }, + { + "name": "recoveryPointId", + "in": "path", + "description": "Recovery point ID which represents backed up data. iSCSI connection will be revoked for\r\nthis backed up data.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Revoke Instant Item Level Recovery for Azure Vm": { + "$ref": "./examples/AzureIaasVm/Revoke_Ilr.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/refreshContainers": { + "post": { + "tags": [ + "ProtectionContainers" + ], + "description": "Discovers all the containers in the subscription that can be backed up to Recovery Services Vault. This is an\r\nasynchronous operation. To know the status of the operation, call GetRefreshOperationResult API.", + "operationId": "ProtectionContainers_Refresh", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated the container.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/BMSRefreshContainersQueryObject", + "x-ms-examples": { + "Trigger Azure Vm Discovery": { + "$ref": "./examples/Common/RefreshContainers.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupOperationResults/{operationId}": { + "get": { + "tags": [ + "BackupOperationResults" + ], + "description": "Provides the status of the delete operations such as deleting backed up item. Once the operation has started, the\r\nstatus code in the response would be Accepted. It will continue to be in this state till it reaches completion. On\r\nsuccessful completion, the status code will be OK. This method expects OperationID as an argument. OperationID is\r\npart of the Location header of the operation response.", + "operationId": "BackupOperationResults_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "operationId", + "in": "path", + "description": "OperationID which represents the operation.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Result for Protected Item Delete Operation": { + "$ref": "./examples/Common/ProtectedItem_Delete_OperationResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupOperations/{operationId}": { + "get": { + "tags": [ + "BackupOperationStatuses" + ], + "description": "Fetches the status of an operation such as triggering a backup, restore. The status can be in progress, completed\r\nor failed. You can refer to the OperationStatus enum for all the possible states of an operation. Some operations\r\ncreate jobs. This method returns the list of jobs when the operation is complete.", + "operationId": "BackupOperationStatuses_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "operationId", + "in": "path", + "description": "OperationID which represents the operation.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Protected Item Delete Operation Status": { + "$ref": "./examples/Common/ProtectedItem_Delete_OperationStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}/operations/{operationId}": { + "get": { + "tags": [ + "ProtectionPolicyOperationStatuses" + ], + "description": "Provides the status of the asynchronous operations like backup, restore. The status can be in progress, completed\r\nor failed. You can refer to the Operation Status enum for all the possible states of an operation. Some operations\r\ncreate jobs. This method returns the list of jobs associated with operation.", + "operationId": "ProtectionPolicyOperationStatuses_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "policyName", + "in": "path", + "description": "Backup policy name whose operation's status needs to be fetched.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation ID which represents an operation whose status needs to be fetched.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Protection Policy Operation Status": { + "$ref": "./examples/AzureIaasVm/ProtectionPolicyOperationStatuses_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectableItems": { + "get": { + "tags": [ + "BackupProtectableItems" + ], + "description": "Provides a pageable list of protectable objects within your subscription according to the query filter and the\r\npagination parameters.", + "operationId": "BackupProtectableItems_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "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/WorkloadProtectableItemResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/BMSPOQueryObject", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List protectable items with backupManagementType filter as AzureIaasVm": { + "$ref": "./examples/AzureIaasVm/BackupProtectableItems_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectionContainers": { + "get": { + "tags": [ + "BackupProtectionContainers" + ], + "description": "Lists the containers registered to Recovery Services Vault.", + "operationId": "BackupProtectionContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/BMSContainerQueryObject", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Backup Protection Containers": { + "$ref": "./examples/AzureStorage/ProtectionContainers_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupSecurityPIN": { + "post": { + "tags": [ + "SecurityPINs" + ], + "description": "Get the security PIN.", + "operationId": "SecurityPINs_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TokenInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Vault Security Pin": { + "$ref": "./examples/Common/BackupSecurityPin_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/move": { + "post": { + "tags": [ + "RecoveryPoint" + ], + "summary": "Move recovery point from one datastore to another store.", + "operationId": "MoveRecoveryPoint", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "protectedItemName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "recoveryPointId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Move Resource Across Tiers Request", + "required": true, + "schema": { + "$ref": "#/definitions/MoveRPAcrossTiersRequest" + } + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Trigger RP Move Operation": { + "$ref": "./examples/TriggerRecoveryPointMove_Post.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPointsRecommendedForMove": { + "post": { + "tags": [ + "RecoveryPointsRecommendedForMove" + ], + "description": "Lists the recovery points recommended for move to another tier", + "operationId": "RecoveryPointsRecommendedForMove_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "protectedItemName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "List Recovery points Recommended for Move Request", + "required": true, + "schema": { + "$ref": "#/definitions/ListRecoveryPointsRecommendedForMoveRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPointResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Protected Azure Vm Recovery Points Recommended for Move": { + "$ref": "./examples/AzureIaasVm/RecoveryPointsRecommendedForMove_List.json" + } + } + } + } + }, + "definitions": { + "BackupResourceEncryptionConfig": { + "type": "object", + "properties": { + "encryptionAtRestType": { + "description": "Encryption At Rest Type", + "enum": [ + "Invalid", + "MicrosoftManaged", + "CustomerManaged" + ], + "type": "string", + "x-ms-enum": { + "name": "EncryptionAtRestType", + "modelAsString": true + } + }, + "keyUri": { + "description": "Key Vault Key URI", + "type": "string" + }, + "subscriptionId": { + "description": "Key Vault Subscription Id", + "type": "string" + }, + "lastUpdateStatus": { + "enum": [ + "Invalid", + "NotEnabled", + "PartiallySucceeded", + "PartiallyFailed", + "Failed", + "Succeeded", + "Initialized", + "FirstInitialization" + ], + "type": "string", + "x-ms-enum": { + "name": "LastUpdateStatus", + "modelAsString": true + } + }, + "infrastructureEncryptionState": { + "enum": [ + "Invalid", + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "InfrastructureEncryptionState", + "modelAsString": true + } + } + } + }, + "BackupResourceEncryptionConfigExtended": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BackupResourceEncryptionConfig" + } + ], + "properties": { + "userAssignedIdentity": { + "description": "User Assigned Identity Id", + "type": "string" + }, + "useSystemAssignedIdentity": { + "description": "bool to indicate whether to use system Assigned Identity or not", + "type": "boolean" + } + } + }, + "BackupResourceEncryptionConfigExtendedResource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BackupResourceEncryptionConfigExtended", + "description": "BackupResourceEncryptionConfigExtendedResource properties" + } + } + }, + "BackupResourceEncryptionConfigResource": { + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BackupResourceEncryptionConfig", + "description": "BackupResourceEncryptionConfigResource properties" + } + } + }, + "PrivateEndpoint": { + "description": "The Private Endpoint network resource that is linked to the Private Endpoint connection", + "type": "object", + "properties": { + "id": { + "description": "Gets or sets id", + "type": "string" + } + } + }, + "PrivateEndpointConnection": { + "description": "Private Endpoint Connection Response Properties", + "type": "object", + "properties": { + "provisioningState": { + "description": "Gets or sets provisioning state of the private endpoint connection", + "enum": [ + "Succeeded", + "Deleting", + "Failed", + "Pending" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "Gets or sets private endpoint associated with the private endpoint connection" + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "Gets or sets private link service connection state" + } + } + }, + "PrivateEndpointConnectionResource": { + "description": "Private Endpoint Connection Response Properties", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnection", + "description": "PrivateEndpointConnectionResource properties" + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "Private Link Service Connection State", + "type": "object", + "properties": { + "status": { + "description": "Gets or sets the status", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateEndpointConnectionStatus", + "modelAsString": true + } + }, + "description": { + "description": "Gets or sets description", + "type": "string" + }, + "actionRequired": { + "description": "Gets or sets actions required", + "type": "string" + } + } + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "type": "object", + "$ref": "#/definitions/CloudErrorBody", + "description": "The error object." + } + }, + "description": "An error response from the Container Instance service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "readOnly": true, + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "A list of additional details about the error." + }, + "additionalInfo": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorAdditionalInfo" + }, + "description": "The error additional info." + } + }, + "description": "An error response from the Container Instance service." + }, + "NewErrorResponse": { + "properties": { + "error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "The error code." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "The error message." + }, + "target": { + "readOnly": true, + "type": "string", + "description": "The error target." + }, + "details": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/NewErrorResponse" + }, + "description": "The error details." + }, + "additionalInfo": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorAdditionalInfo" + }, + "description": "The error additional info." + } + } + } + }, + "description": "The resource management error response." + }, + "AzureFileshareProtectedItem": { + "description": "Azure File Share workload-specific backup item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectedItem" + } + ], + "properties": { + "friendlyName": { + "description": "Friendly name of the fileshare represented by this backup item.", + "type": "string" + }, + "protectionStatus": { + "description": "Backup status of this backup item.", + "type": "string" + }, + "protectionState": { + "description": "Backup state of this backup item.", + "enum": [ + "Invalid", + "IRPending", + "Protected", + "ProtectionError", + "ProtectionStopped", + "ProtectionPaused" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectionState", + "modelAsString": true + } + }, + "lastBackupStatus": { + "description": "Last backup operation status. Possible values: Healthy, Unhealthy.", + "type": "string" + }, + "lastBackupTime": { + "format": "date-time", + "description": "Timestamp of the last backup operation on this backup item.", + "type": "string" + }, + "kpisHealths": { + "description": "Health details of different KPIs", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/KPIResourceHealthDetails" + } + }, + "extendedInfo": { + "$ref": "#/definitions/AzureFileshareProtectedItemExtendedInfo", + "description": "Additional information with this backup item." + } + }, + "x-ms-discriminator-value": "AzureFileShareProtectedItem" + }, + "AzureFileshareProtectedItemExtendedInfo": { + "description": "Additional information about Azure File Share backup item.", + "type": "object", + "properties": { + "oldestRecoveryPoint": { + "format": "date-time", + "description": "The oldest backup copy available for this item in the service.", + "type": "string" + }, + "recoveryPointCount": { + "format": "int32", + "description": "Number of available backup copies associated with this backup item.", + "type": "integer" + }, + "policyState": { + "description": "Indicates consistency of policy object and policy applied to this backup item.", + "type": "string" + }, + "resourceState": { + "description": "Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted}", + "type": "string", + "readOnly": true + }, + "resourceStateSyncTime": { + "format": "date-time", + "description": "The resource state sync time for this backup item.", + "type": "string", + "readOnly": true + } + } + }, + "AzureFileShareRecoveryPoint": { + "description": "Azure File Share workload specific backup copy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPoint" + } + ], + "properties": { + "recoveryPointType": { + "description": "Type of the backup copy. Specifies whether it is a crash consistent backup or app consistent.", + "type": "string" + }, + "recoveryPointTime": { + "format": "date-time", + "description": "Time at which this backup copy was created.", + "type": "string" + }, + "fileShareSnapshotUri": { + "description": "Contains Url to the snapshot of fileshare, if applicable", + "type": "string" + }, + "recoveryPointSizeInGB": { + "format": "int32", + "description": "Contains recovery point size", + "type": "integer" + } + }, + "x-ms-discriminator-value": "AzureFileShareRecoveryPoint" + }, + "AzureFileShareRestoreRequest": { + "description": "AzureFileShare Restore Request", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RestoreRequest" + } + ], + "properties": { + "recoveryType": { + "description": "Type of this recovery.", + "enum": [ + "Invalid", + "OriginalLocation", + "AlternateLocation", + "RestoreDisks", + "Offline" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryType", + "modelAsString": true + } + }, + "sourceResourceId": { + "description": "Source storage account ARM Id", + "type": "string" + }, + "copyOptions": { + "description": "Options to resolve copy conflicts.", + "enum": [ + "Invalid", + "CreateCopy", + "Skip", + "Overwrite", + "FailOnConflict" + ], + "type": "string", + "x-ms-enum": { + "name": "CopyOptions", + "modelAsString": true + } + }, + "restoreRequestType": { + "description": "Restore Type (FullShareRestore or ItemLevelRestore)", + "enum": [ + "Invalid", + "FullShareRestore", + "ItemLevelRestore" + ], + "type": "string", + "x-ms-enum": { + "name": "RestoreRequestType", + "modelAsString": true + } + }, + "restoreFileSpecs": { + "description": "List of Source Files/Folders(which need to recover) and TargetFolderPath details", + "type": "array", + "items": { + "$ref": "#/definitions/RestoreFileSpecs" + } + }, + "targetDetails": { + "$ref": "#/definitions/TargetAFSRestoreInfo", + "description": "Target File Share Details" + } + }, + "x-ms-discriminator-value": "AzureFileShareRestoreRequest" + }, + "AzureVmWorkloadProtectionPolicy": { + "description": "Azure VM (Mercury) workload-specific backup policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionPolicy" + } + ], + "properties": { + "workLoadType": { + "description": "Type of workload for the backup management", + "enum": [ + "Invalid", + "VM", + "FileFolder", + "AzureSqlDb", + "SQLDB", + "Exchange", + "Sharepoint", + "VMwareVM", + "SystemState", + "Client", + "GenericDataSource", + "SQLDataBase", + "AzureFileShare", + "SAPHanaDatabase", + "SAPAseDatabase" + ], + "type": "string", + "x-ms-enum": { + "name": "WorkloadType", + "modelAsString": true + } + }, + "settings": { + "$ref": "#/definitions/Settings", + "description": "Common settings for the backup management" + }, + "subProtectionPolicy": { + "description": "List of sub-protection policies which includes schedule and retention", + "type": "array", + "items": { + "$ref": "#/definitions/SubProtectionPolicy" + } + }, + "makePolicyConsistent": { + "description": "Fix the policy inconsistency", + "type": "boolean" + } + }, + "x-ms-discriminator-value": "AzureWorkload" + }, + "AzureFileShareProtectionPolicy": { + "description": "AzureStorage backup policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionPolicy" + } + ], + "properties": { + "workLoadType": { + "description": "Type of workload for the backup management", + "enum": [ + "Invalid", + "VM", + "FileFolder", + "AzureSqlDb", + "SQLDB", + "Exchange", + "Sharepoint", + "VMwareVM", + "SystemState", + "Client", + "GenericDataSource", + "SQLDataBase", + "AzureFileShare", + "SAPHanaDatabase", + "SAPAseDatabase" + ], + "type": "string", + "x-ms-enum": { + "name": "WorkloadType", + "modelAsString": true + } + }, + "schedulePolicy": { + "$ref": "#/definitions/SchedulePolicy", + "description": "Backup schedule specified as part of backup policy." + }, + "retentionPolicy": { + "$ref": "#/definitions/RetentionPolicy", + "description": "Retention policy with the details on backup copy retention ranges." + }, + "timeZone": { + "description": "TimeZone optional input as string. For example: TimeZone = \"Pacific Standard Time\".", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureStorage" + }, + "AzureIaaSClassicComputeVMProtectedItem": { + "description": "IaaS VM workload-specific backup item representing the Classic Compute VM.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureIaaSVMProtectedItem" + } + ], + "x-ms-discriminator-value": "Microsoft.ClassicCompute/virtualMachines" + }, + "AzureIaaSComputeVMProtectedItem": { + "description": "IaaS VM workload-specific backup item representing the Azure Resource Manager VM.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureIaaSVMProtectedItem" + } + ], + "x-ms-discriminator-value": "Microsoft.Compute/virtualMachines" + }, + "AzureIaaSVMErrorInfo": { + "description": "Azure IaaS VM workload-specific error information.", + "type": "object", + "properties": { + "errorCode": { + "format": "int32", + "description": "Error code.", + "type": "integer", + "readOnly": true + }, + "errorTitle": { + "description": "Title: Typically, the entity that the error pertains to.", + "type": "string", + "readOnly": true + }, + "errorString": { + "description": "Localized error string.", + "type": "string", + "readOnly": true + }, + "recommendations": { + "description": "List of localized recommendations for above error code.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "ResourceHealthDetails": { + "description": "Health Details for backup items.", + "type": "object", + "properties": { + "code": { + "format": "int32", + "description": "Health Code", + "type": "integer", + "readOnly": true + }, + "title": { + "description": "Health Title", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Health Message", + "type": "string", + "readOnly": true + }, + "recommendations": { + "description": "Health Recommended Actions", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "AzureIaaSVMHealthDetails": { + "description": "Azure IaaS VM workload-specific Health Details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceHealthDetails" + } + ] + }, + "AzureIaaSVMJob": { + "description": "Azure IaaS VM workload-specific job object.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Job" + } + ], + "properties": { + "duration": { + "format": "duration", + "description": "Time elapsed during the execution of this job.", + "type": "string" + }, + "actionsInfo": { + "description": "Gets or sets the state/actions applicable on this job like cancel/retry.", + "type": "array", + "items": { + "enum": [ + "Invalid", + "Cancellable", + "Retriable" + ], + "type": "string", + "x-ms-enum": { + "name": "JobSupportedAction", + "modelAsString": false + } + } + }, + "errorDetails": { + "description": "Error details on execution of this job.", + "type": "array", + "items": { + "$ref": "#/definitions/AzureIaaSVMErrorInfo" + } + }, + "virtualMachineVersion": { + "description": "Specifies whether the backup item is a Classic or an Azure Resource Manager VM.", + "type": "string" + }, + "extendedInfo": { + "$ref": "#/definitions/AzureIaaSVMJobExtendedInfo", + "description": "Additional information for this job." + } + }, + "x-ms-discriminator-value": "AzureIaaSVMJob" + }, + "AzureIaaSVMJobExtendedInfo": { + "description": "Azure IaaS VM workload-specific additional information for job.", + "type": "object", + "properties": { + "tasksList": { + "description": "List of tasks associated with this job.", + "type": "array", + "items": { + "$ref": "#/definitions/AzureIaaSVMJobTaskDetails" + } + }, + "propertyBag": { + "description": "Job properties.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "internalPropertyBag": { + "description": "Job internal properties.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "progressPercentage": { + "format": "double", + "description": "Indicates progress of the job. Null if it has not started or completed.", + "type": "number" + }, + "estimatedRemainingDuration": { + "description": "Time remaining for execution of this job.", + "type": "string" + }, + "dynamicErrorMessage": { + "description": "Non localized error message on job execution.", + "type": "string" + } + } + }, + "AzureIaaSVMJobTaskDetails": { + "description": "Azure IaaS VM workload-specific job task details.", + "type": "object", + "properties": { + "taskId": { + "description": "The task display name.", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "The start time.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "The end time.", + "type": "string" + }, + "instanceId": { + "description": "The instanceId.", + "type": "string" + }, + "duration": { + "format": "duration", + "description": "Time elapsed for task.", + "type": "string" + }, + "status": { + "description": "The status.", + "type": "string" + }, + "progressPercentage": { + "format": "double", + "description": "Progress of the task.", + "type": "number" + }, + "taskExecutionDetails": { + "description": "Details about execution of the task.\r\neg: number of bytes transferred etc", + "type": "string" + } + } + }, + "AzureIaaSVMProtectedItem": { + "description": "IaaS VM workload-specific backup item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectedItem" + } + ], + "properties": { + "friendlyName": { + "description": "Friendly name of the VM represented by this backup item.", + "type": "string" + }, + "virtualMachineId": { + "description": "Fully qualified ARM ID of the virtual machine represented by this item.", + "type": "string" + }, + "protectionStatus": { + "description": "Backup status of this backup item.", + "type": "string" + }, + "protectionState": { + "description": "Backup state of this backup item.", + "enum": [ + "Invalid", + "IRPending", + "Protected", + "ProtectionError", + "ProtectionStopped", + "ProtectionPaused" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectionState", + "modelAsString": true + } + }, + "healthStatus": { + "description": "Health status of protected item.", + "enum": [ + "Passed", + "ActionRequired", + "ActionSuggested", + "Invalid" + ], + "type": "string", + "x-ms-enum": { + "name": "HealthStatus", + "modelAsString": true + } + }, + "healthDetails": { + "description": "Health details on this backup item.", + "type": "array", + "items": { + "$ref": "#/definitions/AzureIaaSVMHealthDetails" + } + }, + "kpisHealths": { + "description": "Health details of different KPIs", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/KPIResourceHealthDetails" + } + }, + "lastBackupStatus": { + "description": "Last backup operation status.", + "type": "string" + }, + "lastBackupTime": { + "format": "date-time", + "description": "Timestamp of the last backup operation on this backup item.", + "type": "string" + }, + "protectedItemDataId": { + "description": "Data ID of the protected item.", + "type": "string" + }, + "extendedInfo": { + "$ref": "#/definitions/AzureIaaSVMProtectedItemExtendedInfo", + "description": "Additional information for this backup item." + }, + "extendedProperties": { + "$ref": "#/definitions/ExtendedProperties" + } + }, + "x-ms-discriminator-value": "AzureIaaSVMProtectedItem" + }, + "AzureIaaSVMProtectedItemExtendedInfo": { + "description": "Additional information on Azure IaaS VM specific backup item.", + "type": "object", + "properties": { + "oldestRecoveryPoint": { + "format": "date-time", + "description": "The oldest backup copy available for this backup item.", + "type": "string" + }, + "recoveryPointCount": { + "format": "int32", + "description": "Number of backup copies available for this backup item.", + "type": "integer" + }, + "policyInconsistent": { + "description": "Specifies if backup policy associated with the backup item is inconsistent.", + "type": "boolean" + } + } + }, + "AzureIaaSVMProtectionPolicy": { + "description": "IaaS VM workload-specific backup policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionPolicy" + } + ], + "properties": { + "instantRPDetails": { + "$ref": "#/definitions/InstantRPAdditionalDetails" + }, + "schedulePolicy": { + "$ref": "#/definitions/SchedulePolicy", + "description": "Backup schedule specified as part of backup policy." + }, + "retentionPolicy": { + "$ref": "#/definitions/RetentionPolicy", + "description": "Retention policy with the details on backup copy retention ranges." + }, + "instantRpRetentionRangeInDays": { + "format": "int32", + "description": "Instant RP retention policy range in days", + "type": "integer" + }, + "timeZone": { + "description": "TimeZone optional input as string. For example: TimeZone = \"Pacific Standard Time\".", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureIaasVM" + }, + "AzureSqlProtectedItem": { + "description": "Azure SQL workload-specific backup item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectedItem" + } + ], + "properties": { + "protectedItemDataId": { + "description": "Internal ID of a backup item. Used by Azure SQL Backup engine to contact Recovery Services.", + "type": "string" + }, + "protectionState": { + "description": "Backup state of the backed up item.", + "enum": [ + "Invalid", + "IRPending", + "Protected", + "ProtectionError", + "ProtectionStopped", + "ProtectionPaused" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectedItemState", + "modelAsString": true + } + }, + "extendedInfo": { + "$ref": "#/definitions/AzureSqlProtectedItemExtendedInfo", + "description": "Additional information for this backup item." + } + }, + "x-ms-discriminator-value": "Microsoft.Sql/servers/databases" + }, + "AzureSqlProtectedItemExtendedInfo": { + "description": "Additional information on Azure Sql specific protected item.", + "type": "object", + "properties": { + "oldestRecoveryPoint": { + "format": "date-time", + "description": "The oldest backup copy available for this item in the service.", + "type": "string" + }, + "recoveryPointCount": { + "format": "int32", + "description": "Number of available backup copies associated with this backup item.", + "type": "integer" + }, + "policyState": { + "description": "State of the backup policy associated with this backup item.", + "type": "string" + } + } + }, + "AzureStorageErrorInfo": { + "description": "Azure storage specific error information", + "type": "object", + "properties": { + "errorCode": { + "format": "int32", + "description": "Error code.", + "type": "integer" + }, + "errorString": { + "description": "Localized error string.", + "type": "string" + }, + "recommendations": { + "description": "List of localized recommendations for above error code.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "AzureSqlProtectionPolicy": { + "description": "Azure SQL workload-specific backup policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionPolicy" + } + ], + "properties": { + "retentionPolicy": { + "$ref": "#/definitions/RetentionPolicy", + "description": "Retention policy details." + } + }, + "x-ms-discriminator-value": "AzureSql" + }, + "AzureStorageJob": { + "description": "Azure storage specific job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Job" + } + ], + "properties": { + "duration": { + "format": "duration", + "description": "Time elapsed during the execution of this job.", + "type": "string" + }, + "actionsInfo": { + "description": "Gets or sets the state/actions applicable on this job like cancel/retry.", + "type": "array", + "items": { + "enum": [ + "Invalid", + "Cancellable", + "Retriable" + ], + "type": "string", + "x-ms-enum": { + "name": "JobSupportedAction", + "modelAsString": false + } + } + }, + "errorDetails": { + "description": "Error details on execution of this job.", + "type": "array", + "items": { + "$ref": "#/definitions/AzureStorageErrorInfo" + } + }, + "storageAccountName": { + "description": "Specifies friendly name of the storage account.", + "type": "string" + }, + "storageAccountVersion": { + "description": "Specifies whether the Storage account is a Classic or an Azure Resource Manager Storage account.", + "type": "string" + }, + "extendedInfo": { + "$ref": "#/definitions/AzureStorageJobExtendedInfo", + "description": "Additional information about the job." + } + }, + "x-ms-discriminator-value": "AzureStorageJob" + }, + "AzureStorageJobExtendedInfo": { + "description": "Azure Storage workload-specific additional information for job.", + "type": "object", + "properties": { + "tasksList": { + "description": "List of tasks for this job", + "type": "array", + "items": { + "$ref": "#/definitions/AzureStorageJobTaskDetails" + } + }, + "propertyBag": { + "description": "Job properties.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "dynamicErrorMessage": { + "description": "Non localized error message on job execution.", + "type": "string" + } + } + }, + "AzureStorageJobTaskDetails": { + "description": "Azure storage workload specific job task details.", + "type": "object", + "properties": { + "taskId": { + "description": "The task display name.", + "type": "string" + }, + "status": { + "description": "The status.", + "type": "string" + } + } + }, + "AzureVmWorkloadProtectedItem": { + "description": "Azure VM workload-specific protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectedItem" + } + ], + "properties": { + "friendlyName": { + "description": "Friendly name of the DB represented by this backup item.", + "type": "string" + }, + "serverName": { + "description": "Host/Cluster Name for instance or AG", + "type": "string" + }, + "parentName": { + "description": "Parent name of the DB such as Instance or Availability Group.", + "type": "string" + }, + "parentType": { + "description": "Parent type of protected item, example: for a DB, standalone server or distributed", + "type": "string" + }, + "protectionStatus": { + "description": "Backup status of this backup item.", + "type": "string" + }, + "protectionState": { + "description": "Backup state of this backup item.", + "enum": [ + "Invalid", + "IRPending", + "Protected", + "ProtectionError", + "ProtectionStopped", + "ProtectionPaused" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectionState", + "modelAsString": true + } + }, + "lastBackupStatus": { + "description": "Last backup operation status. Possible values: Healthy, Unhealthy.", + "enum": [ + "Invalid", + "Healthy", + "Unhealthy", + "IRPending" + ], + "type": "string", + "x-ms-enum": { + "name": "LastBackupStatus", + "modelAsString": true + } + }, + "lastBackupTime": { + "format": "date-time", + "description": "Timestamp of the last backup operation on this backup item.", + "type": "string" + }, + "lastBackupErrorDetail": { + "$ref": "#/definitions/ErrorDetail", + "description": "Error details in last backup" + }, + "protectedItemDataSourceId": { + "description": "Data ID of the protected item.", + "type": "string" + }, + "protectedItemHealthStatus": { + "description": "Health status of the backup item, evaluated based on last heartbeat received", + "enum": [ + "Invalid", + "Healthy", + "Unhealthy", + "NotReachable", + "IRPending" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectedItemHealthStatus", + "modelAsString": true + } + }, + "extendedInfo": { + "$ref": "#/definitions/AzureVmWorkloadProtectedItemExtendedInfo", + "description": "Additional information for this backup item." + }, + "kpisHealths": { + "description": "Health details of different KPIs", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/KPIResourceHealthDetails" + } + } + }, + "x-ms-discriminator-value": "AzureVmWorkloadProtectedItem" + }, + "AzureVmWorkloadProtectedItemExtendedInfo": { + "description": "Additional information on Azure Workload for SQL specific backup item.", + "type": "object", + "properties": { + "oldestRecoveryPoint": { + "format": "date-time", + "description": "The oldest backup copy available for this backup item.", + "type": "string" + }, + "recoveryPointCount": { + "format": "int32", + "description": "Number of backup copies available for this backup item.", + "type": "integer" + }, + "policyState": { + "description": "Indicates consistency of policy object and policy applied to this backup item.", + "type": "string" + } + } + }, + "AzureVmWorkloadSAPAseDatabaseProtectedItem": { + "description": "Azure VM workload-specific protected item representing SAP ASE Database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadProtectedItem" + } + ], + "x-ms-discriminator-value": "AzureVmWorkloadSAPAseDatabase" + }, + "AzureVmWorkloadSAPHanaDatabaseProtectedItem": { + "description": "Azure VM workload-specific protected item representing SAP HANA Database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadProtectedItem" + } + ], + "x-ms-discriminator-value": "AzureVmWorkloadSAPHanaDatabase" + }, + "AzureVmWorkloadSQLDatabaseProtectedItem": { + "description": "Azure VM workload-specific protected item representing SQL Database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadProtectedItem" + } + ], + "x-ms-discriminator-value": "AzureVmWorkloadSQLDatabase" + }, + "AzureWorkloadErrorInfo": { + "description": "Azure storage specific error information", + "type": "object", + "properties": { + "errorCode": { + "format": "int32", + "description": "Error code.", + "type": "integer" + }, + "errorString": { + "description": "Localized error string.", + "type": "string" + }, + "errorTitle": { + "description": "Title: Typically, the entity that the error pertains to.", + "type": "string" + }, + "recommendations": { + "description": "List of localized recommendations for above error code.", + "type": "array", + "items": { + "type": "string" + } + }, + "additionalDetails": { + "description": "Additional details for above error code.", + "type": "string" + } + } + }, + "AzureWorkloadJob": { + "description": "Azure storage specific job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Job" + } + ], + "properties": { + "workloadType": { + "description": "Workload type of the job", + "type": "string" + }, + "duration": { + "format": "duration", + "description": "Time elapsed during the execution of this job.", + "type": "string" + }, + "actionsInfo": { + "description": "Gets or sets the state/actions applicable on this job like cancel/retry.", + "type": "array", + "items": { + "enum": [ + "Invalid", + "Cancellable", + "Retriable" + ], + "type": "string", + "x-ms-enum": { + "name": "JobSupportedAction", + "modelAsString": false + } + } + }, + "errorDetails": { + "description": "Error details on execution of this job.", + "type": "array", + "items": { + "$ref": "#/definitions/AzureWorkloadErrorInfo" + } + }, + "extendedInfo": { + "$ref": "#/definitions/AzureWorkloadJobExtendedInfo", + "description": "Additional information about the job." + } + }, + "x-ms-discriminator-value": "AzureWorkloadJob" + }, + "AzureWorkloadJobExtendedInfo": { + "description": "Azure VM workload-specific additional information for job.", + "type": "object", + "properties": { + "tasksList": { + "description": "List of tasks for this job", + "type": "array", + "items": { + "$ref": "#/definitions/AzureWorkloadJobTaskDetails" + } + }, + "propertyBag": { + "description": "Job properties.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "dynamicErrorMessage": { + "description": "Non localized error message on job execution.", + "type": "string" + } + } + }, + "AzureWorkloadJobTaskDetails": { + "description": "Azure VM workload specific job task details.", + "type": "object", + "properties": { + "taskId": { + "description": "The task display name.", + "type": "string" + }, + "status": { + "description": "The status.", + "type": "string" + } + } + }, + "AzureWorkloadPointInTimeRecoveryPoint": { + "description": "Recovery point specific to PointInTime", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadRecoveryPoint" + } + ], + "properties": { + "timeRanges": { + "description": "List of log ranges", + "type": "array", + "items": { + "$ref": "#/definitions/PointInTimeRange" + } + } + }, + "x-ms-discriminator-value": "AzureWorkloadPointInTimeRecoveryPoint" + }, + "AzureWorkloadPointInTimeRestoreRequest": { + "description": "AzureWorkload SAP Hana -specific restore. Specifically for PointInTime/Log restore", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadRestoreRequest" + } + ], + "properties": { + "pointInTime": { + "format": "date-time", + "description": "PointInTime value", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureWorkloadPointInTimeRestoreRequest" + }, + "AzureWorkloadRecoveryPoint": { + "description": "Workload specific recovery point, specifically encapsulates full/diff recovery point", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPoint" + } + ], + "properties": { + "recoveryPointTimeInUTC": { + "format": "date-time", + "description": "UTC time at which recovery point was created", + "type": "string" + }, + "type": { + "description": "Type of restore point", + "enum": [ + "Invalid", + "Full", + "Log", + "Differential", + "Incremental" + ], + "type": "string", + "x-ms-enum": { + "name": "RestorePointType", + "modelAsString": true + } + }, + "recoveryPointTierDetails": { + "description": "Recovery point tier information.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPointTierInformation" + } + }, + "recoveryPointMoveReadinessInfo": { + "description": "Eligibility of RP to be moved to another tier", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/RecoveryPointMoveReadinessInfo" + } + } + }, + "x-ms-discriminator-value": "AzureWorkloadRecoveryPoint" + }, + "AzureWorkloadRestoreRequest": { + "description": "AzureWorkload-specific restore.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RestoreRequest" + } + ], + "properties": { + "recoveryType": { + "description": "Type of this recovery.", + "enum": [ + "Invalid", + "OriginalLocation", + "AlternateLocation", + "RestoreDisks", + "Offline" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryType", + "modelAsString": true + } + }, + "sourceResourceId": { + "description": "Fully qualified ARM ID of the VM on which workload that was running is being recovered.", + "type": "string" + }, + "propertyBag": { + "description": "Workload specific property bag.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetInfo": { + "$ref": "#/definitions/TargetRestoreInfo", + "description": "Details of target database" + }, + "recoveryMode": { + "description": "Defines whether the current recovery mode is file restore or database restore", + "enum": [ + "Invalid", + "FileRecovery", + "WorkloadRecovery" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryMode", + "modelAsString": true + } + }, + "targetVirtualMachineId": { + "description": "This is the complete ARM Id of the target VM\r\nFor e.g. /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm}", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureWorkloadRestoreRequest" + }, + "AzureWorkloadSAPHanaPointInTimeRecoveryPoint": { + "description": "Recovery point specific to PointInTime in SAPHana", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadPointInTimeRecoveryPoint" + } + ], + "x-ms-discriminator-value": "AzureWorkloadSAPHanaPointInTimeRecoveryPoint" + }, + "AzureWorkloadSAPHanaPointInTimeRestoreRequest": { + "description": "AzureWorkload SAP Hana -specific restore. Specifically for PointInTime/Log restore", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadSAPHanaRestoreRequest" + } + ], + "properties": { + "pointInTime": { + "format": "date-time", + "description": "PointInTime value", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureWorkloadSAPHanaPointInTimeRestoreRequest" + }, + "AzureWorkloadSAPHanaRecoveryPoint": { + "description": "SAPHana specific recoverypoint, specifically encapsulates full/diff recoverypoints", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadRecoveryPoint" + } + ], + "x-ms-discriminator-value": "AzureWorkloadSAPHanaRecoveryPoint" + }, + "AzureWorkloadSAPHanaRestoreRequest": { + "description": "AzureWorkload SAP Hana-specific restore.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadRestoreRequest" + } + ], + "x-ms-discriminator-value": "AzureWorkloadSAPHanaRestoreRequest" + }, + "AzureWorkloadSQLPointInTimeRecoveryPoint": { + "description": "Recovery point specific to PointInTime", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadSQLRecoveryPoint" + } + ], + "properties": { + "timeRanges": { + "description": "List of log ranges", + "type": "array", + "items": { + "$ref": "#/definitions/PointInTimeRange" + } + } + }, + "x-ms-discriminator-value": "AzureWorkloadSQLPointInTimeRecoveryPoint" + }, + "AzureWorkloadSQLPointInTimeRestoreRequest": { + "description": "AzureWorkload SQL -specific restore. Specifically for PointInTime/Log restore", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadSQLRestoreRequest" + } + ], + "properties": { + "pointInTime": { + "format": "date-time", + "description": "PointInTime value", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureWorkloadSQLPointInTimeRestoreRequest" + }, + "AzureWorkloadSQLRecoveryPoint": { + "description": "SQL specific recoverypoint, specifically encapsulates full/diff recoverypoint along with extended info", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadRecoveryPoint" + } + ], + "properties": { + "extendedInfo": { + "$ref": "#/definitions/AzureWorkloadSQLRecoveryPointExtendedInfo", + "description": "Extended Info that provides data directory details. Will be populated in two cases:\r\nWhen a specific recovery point is accessed using GetRecoveryPoint\r\nOr when ListRecoveryPoints is called for Log RP only with ExtendedInfo query filter" + } + }, + "x-ms-discriminator-value": "AzureWorkloadSQLRecoveryPoint" + }, + "AzureWorkloadSQLRecoveryPointExtendedInfo": { + "description": "Extended info class details", + "type": "object", + "properties": { + "dataDirectoryTimeInUTC": { + "format": "date-time", + "description": "UTC time at which data directory info was captured", + "type": "string" + }, + "dataDirectoryPaths": { + "description": "List of data directory paths during restore operation.", + "type": "array", + "items": { + "$ref": "#/definitions/SQLDataDirectory" + } + } + } + }, + "AzureWorkloadSQLRestoreRequest": { + "description": "AzureWorkload SQL -specific restore. Specifically for full/diff restore", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadRestoreRequest" + } + ], + "properties": { + "shouldUseAlternateTargetLocation": { + "description": "Default option set to true. If this is set to false, alternate data directory must be provided", + "type": "boolean" + }, + "isNonRecoverable": { + "description": "SQL specific property where user can chose to set no-recovery when restore operation is tried", + "type": "boolean" + }, + "alternateDirectoryPaths": { + "description": "Data directory details", + "type": "array", + "items": { + "$ref": "#/definitions/SQLDataDirectoryMapping" + } + } + }, + "x-ms-discriminator-value": "AzureWorkloadSQLRestoreRequest" + }, + "BEKDetails": { + "description": "BEK is bitlocker encryption key.", + "type": "object", + "properties": { + "secretUrl": { + "description": "Secret is BEK.", + "type": "string" + }, + "secretVaultId": { + "description": "ID of the Key Vault where this Secret is stored.", + "type": "string" + }, + "secretData": { + "description": "BEK data.", + "type": "string" + } + } + }, + "BMSRPQueryObject": { + "description": "Filters to list backup copies.", + "type": "object", + "properties": { + "startDate": { + "format": "date-time", + "description": "Backup copies created after this time.", + "type": "string" + }, + "endDate": { + "format": "date-time", + "description": "Backup copies created before this time.", + "type": "string" + }, + "restorePointQueryType": { + "description": "RestorePoint type", + "enum": [ + "Invalid", + "Full", + "Log", + "Differential", + "FullAndDifferential", + "All", + "Incremental" + ], + "type": "string", + "x-ms-enum": { + "name": "RestorePointQueryType", + "modelAsString": true + } + }, + "extendedInfo": { + "description": "In Get Recovery Point, it tells whether extended information about recovery point is asked.", + "type": "boolean" + }, + "moveReadyRPOnly": { + "description": "Whether the RP can be moved to another tier", + "type": "boolean" + } + } + }, + "DiskExclusionProperties": { + "type": "object", + "properties": { + "diskLunList": { + "description": "List of Disks' Logical Unit Numbers (LUN) to be used for VM Protection.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "isInclusionList": { + "description": "Flag to indicate whether DiskLunList is to be included/ excluded from backup.", + "type": "boolean" + } + } + }, + "ClientDiscoveryDisplay": { + "description": "Localized display information of an operation.", + "type": "object", + "properties": { + "provider": { + "description": "Name of the provider for display purposes", + "type": "string" + }, + "resource": { + "description": "ResourceType for which this Operation can be performed.", + "type": "string" + }, + "operation": { + "description": "Operations Name itself.", + "type": "string" + }, + "description": { + "description": "Description of the operation having details of what operation is about.", + "type": "string" + } + } + }, + "ClientDiscoveryForLogSpecification": { + "description": "Class to represent shoebox log specification in json client discovery.", + "type": "object", + "properties": { + "name": { + "description": "Name for shoebox log specification.", + "type": "string" + }, + "displayName": { + "description": "Localized display name", + "type": "string" + }, + "blobDuration": { + "description": "blob duration of shoebox log specification", + "type": "string" + } + } + }, + "ClientDiscoveryForProperties": { + "description": "Class to represent shoebox properties in json client discovery.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ClientDiscoveryForServiceSpecification", + "description": "Operation properties." + } + } + }, + "ClientDiscoveryForServiceSpecification": { + "description": "Class to represent shoebox service specification in json client discovery.", + "type": "object", + "properties": { + "logSpecifications": { + "description": "List of log specifications of this operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ClientDiscoveryForLogSpecification" + } + } + } + }, + "ClientDiscoveryResponse": { + "description": "Operations List response which contains list of available APIs.", + "type": "object", + "properties": { + "value": { + "description": "List of available operations.", + "type": "array", + "items": { + "$ref": "#/definitions/ClientDiscoveryValueForSingleApi" + } + }, + "nextLink": { + "description": "Link to the next chunk of Response.", + "type": "string" + } + } + }, + "ClientDiscoveryValueForSingleApi": { + "description": "Available operation details.", + "type": "object", + "properties": { + "name": { + "description": "Name of the Operation.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/ClientDiscoveryDisplay", + "description": "Contains the localized display information for this particular operation" + }, + "origin": { + "description": "The intended executor of the operation;governs the display of the operation in the RBAC UX and the audit logs UX", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/ClientDiscoveryForProperties", + "description": "ShoeBox properties for the given operation." + } + } + }, + "DiskInformation": { + "description": "Disk information", + "type": "object", + "properties": { + "lun": { + "format": "int32", + "type": "integer" + }, + "name": { + "type": "string" + } + } + }, + "DailyRetentionFormat": { + "description": "Daily retention format.", + "type": "object", + "properties": { + "daysOfTheMonth": { + "description": "List of days of the month.", + "type": "array", + "items": { + "$ref": "#/definitions/Day" + } + } + } + }, + "DailyRetentionSchedule": { + "description": "Daily retention schedule.", + "type": "object", + "properties": { + "retentionTimes": { + "description": "Retention times of retention policy.", + "type": "array", + "items": { + "format": "date-time", + "type": "string" + } + }, + "retentionDuration": { + "$ref": "#/definitions/RetentionDuration", + "description": "Retention duration of retention Policy." + } + } + }, + "Day": { + "description": "Day of the week.", + "type": "object", + "properties": { + "date": { + "format": "int32", + "description": "Date of the month", + "type": "integer" + }, + "isLast": { + "description": "Whether Date is last date of month", + "type": "boolean" + } + } + }, + "DpmErrorInfo": { + "description": "DPM workload-specific error information.", + "type": "object", + "properties": { + "errorString": { + "description": "Localized error string.", + "type": "string" + }, + "recommendations": { + "description": "List of localized recommendations for above error code.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DpmJob": { + "description": "DPM workload-specific job object.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Job" + } + ], + "properties": { + "duration": { + "format": "duration", + "description": "Time elapsed for job.", + "type": "string" + }, + "dpmServerName": { + "description": "DPM server name managing the backup item or backup job.", + "type": "string" + }, + "containerName": { + "description": "Name of cluster/server protecting current backup item, if any.", + "type": "string" + }, + "containerType": { + "description": "Type of container.", + "type": "string" + }, + "workloadType": { + "description": "Type of backup item.", + "type": "string" + }, + "actionsInfo": { + "description": "The state/actions applicable on this job like cancel/retry.", + "type": "array", + "items": { + "enum": [ + "Invalid", + "Cancellable", + "Retriable" + ], + "type": "string", + "x-ms-enum": { + "name": "JobSupportedAction", + "modelAsString": false + } + } + }, + "errorDetails": { + "description": "The errors.", + "type": "array", + "items": { + "$ref": "#/definitions/DpmErrorInfo" + } + }, + "extendedInfo": { + "$ref": "#/definitions/DpmJobExtendedInfo", + "description": "Additional information for this job." + } + }, + "x-ms-discriminator-value": "DpmJob" + }, + "DpmJobExtendedInfo": { + "description": "Additional information on the DPM workload-specific job.", + "type": "object", + "properties": { + "tasksList": { + "description": "List of tasks associated with this job.", + "type": "array", + "items": { + "$ref": "#/definitions/DpmJobTaskDetails" + } + }, + "propertyBag": { + "description": "The job properties.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "dynamicErrorMessage": { + "description": "Non localized error message on job execution.", + "type": "string" + } + } + }, + "DpmJobTaskDetails": { + "description": "DPM workload-specific job task details.", + "type": "object", + "properties": { + "taskId": { + "description": "The task display name.", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "The start time.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "The end time.", + "type": "string" + }, + "duration": { + "format": "duration", + "description": "Time elapsed for task.", + "type": "string" + }, + "status": { + "description": "The status.", + "type": "string" + } + } + }, + "DPMProtectedItem": { + "description": "Additional information on Backup engine specific backup item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectedItem" + } + ], + "properties": { + "friendlyName": { + "description": "Friendly name of the managed item", + "type": "string" + }, + "backupEngineName": { + "description": "Backup Management server protecting this backup item", + "type": "string" + }, + "protectionState": { + "description": "Protection state of the backup engine", + "enum": [ + "Invalid", + "IRPending", + "Protected", + "ProtectionError", + "ProtectionStopped", + "ProtectionPaused" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectedItemState", + "modelAsString": true + } + }, + "extendedInfo": { + "$ref": "#/definitions/DPMProtectedItemExtendedInfo", + "description": "Extended info of the backup item." + } + }, + "x-ms-discriminator-value": "DPMProtectedItem" + }, + "DPMProtectedItemExtendedInfo": { + "description": "Additional information of DPM Protected item.", + "type": "object", + "properties": { + "protectableObjectLoadPath": { + "description": "Attribute to provide information on various DBs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "protected": { + "description": "To check if backup item is disk protected.", + "type": "boolean" + }, + "isPresentOnCloud": { + "description": "To check if backup item is cloud protected.", + "type": "boolean" + }, + "lastBackupStatus": { + "description": "Last backup status information on backup item.", + "type": "string" + }, + "lastRefreshedAt": { + "format": "date-time", + "description": "Last refresh time on backup item.", + "type": "string" + }, + "oldestRecoveryPoint": { + "format": "date-time", + "description": "Oldest cloud recovery point time.", + "type": "string" + }, + "recoveryPointCount": { + "format": "int32", + "description": "cloud recovery point count.", + "type": "integer" + }, + "onPremiseOldestRecoveryPoint": { + "format": "date-time", + "description": "Oldest disk recovery point time.", + "type": "string" + }, + "onPremiseLatestRecoveryPoint": { + "format": "date-time", + "description": "latest disk recovery point time.", + "type": "string" + }, + "onPremiseRecoveryPointCount": { + "format": "int32", + "description": "disk recovery point count.", + "type": "integer" + }, + "isCollocated": { + "description": "To check if backup item is collocated.", + "type": "boolean" + }, + "protectionGroupName": { + "description": "Protection group name of the backup item.", + "type": "string" + }, + "diskStorageUsedInBytes": { + "description": "Used Disk storage in bytes.", + "type": "string" + }, + "totalDiskStorageSizeInBytes": { + "description": "total Disk storage in bytes.", + "type": "string" + } + } + }, + "EncryptionDetails": { + "description": "Details needed if the VM was encrypted at the time of backup.", + "type": "object", + "properties": { + "encryptionEnabled": { + "description": "Identifies whether this backup copy represents an encrypted VM at the time of backup.", + "type": "boolean" + }, + "kekUrl": { + "description": "Key Url.", + "type": "string" + }, + "secretKeyUrl": { + "description": "Secret Url.", + "type": "string" + }, + "kekVaultId": { + "description": "ID of Key Vault where KEK is stored.", + "type": "string" + }, + "secretKeyVaultId": { + "description": "ID of Key Vault where Secret is stored.", + "type": "string" + } + } + }, + "ErrorDetail": { + "description": "Error Detail class which encapsulates Code, Message and Recommendations.", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Error Message related to the Code.", + "type": "string", + "readOnly": true + }, + "recommendations": { + "description": "List of recommendation strings.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "ExportJobsOperationResultInfo": { + "description": "This class is used to send blob details after exporting jobs.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OperationResultInfoBase" + } + ], + "properties": { + "blobUrl": { + "description": "URL of the blob into which the serialized string of list of jobs is exported.", + "type": "string" + }, + "blobSasKey": { + "description": "SAS key to access the blob. It expires in 15 mins.", + "type": "string" + }, + "excelFileBlobUrl": { + "description": "URL of the blob into which the ExcelFile is uploaded.", + "type": "string" + }, + "excelFileBlobSasKey": { + "description": "SAS key to access the blob. It expires in 15 mins.", + "type": "string" + } + }, + "x-ms-discriminator-value": "ExportJobsOperationResultInfo" + }, + "ExtendedProperties": { + "description": "Extended Properties for Azure IaasVM Backup.", + "type": "object", + "properties": { + "diskExclusionProperties": { + "$ref": "#/definitions/DiskExclusionProperties", + "description": "Extended Properties for Disk Exclusion." + } + } + }, + "GenericProtectionPolicy": { + "description": "Azure VM (Mercury) workload-specific backup policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionPolicy" + } + ], + "properties": { + "subProtectionPolicy": { + "description": "List of sub-protection policies which includes schedule and retention", + "type": "array", + "items": { + "$ref": "#/definitions/SubProtectionPolicy" + } + }, + "timeZone": { + "description": "TimeZone optional input as string. For example: TimeZone = \"Pacific Standard Time\".", + "type": "string" + }, + "fabricName": { + "description": "Name of this policy's fabric.", + "type": "string" + } + }, + "x-ms-discriminator-value": "GenericProtectionPolicy" + }, + "IdentityInfo": { + "description": "Encapsulates Managed Identity related information", + "type": "object", + "properties": { + "isSystemAssignedIdentity": { + "description": "To differentiate if the managed identity is system assigned or user assigned", + "type": "boolean" + }, + "managedIdentityResourceId": { + "description": "Managed Identity Resource Id\r\nOptional: Might not be required in the case of system assigned managed identity", + "type": "string" + } + } + }, + "InstantRPAdditionalDetails": { + "type": "object", + "properties": { + "azureBackupRGNamePrefix": { + "type": "string" + }, + "azureBackupRGNameSuffix": { + "type": "string" + } + } + }, + "GenericProtectedItem": { + "description": "Base class for backup items.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectedItem" + } + ], + "properties": { + "friendlyName": { + "description": "Friendly name of the container.", + "type": "string" + }, + "policyState": { + "description": "Indicates consistency of policy object and policy applied to this backup item.", + "type": "string" + }, + "protectionState": { + "description": "Backup state of this backup item.", + "enum": [ + "Invalid", + "IRPending", + "Protected", + "ProtectionError", + "ProtectionStopped", + "ProtectionPaused" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectionState", + "modelAsString": true + } + }, + "protectedItemId": { + "format": "int64", + "description": "Data Plane Service ID of the protected item.", + "type": "integer" + }, + "sourceAssociations": { + "description": "Loosely coupled (type, value) associations (example - parent of a protected item)", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "fabricName": { + "description": "Name of this backup item's fabric.", + "type": "string" + } + }, + "x-ms-discriminator-value": "GenericProtectedItem" + }, + "GenericRecoveryPoint": { + "description": "Generic backup copy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPoint" + } + ], + "properties": { + "friendlyName": { + "description": "Friendly name of the backup copy.", + "type": "string" + }, + "recoveryPointType": { + "description": "Type of the backup copy.", + "type": "string" + }, + "recoveryPointTime": { + "format": "date-time", + "description": "Time at which this backup copy was created.", + "type": "string" + }, + "recoveryPointAdditionalInfo": { + "description": "Additional information associated with this backup copy.", + "type": "string" + } + }, + "x-ms-discriminator-value": "GenericRecoveryPoint" + }, + "GetProtectedItemQueryObject": { + "description": "Filters to list backup items.", + "type": "object", + "properties": { + "expand": { + "description": "Specifies if the additional information should be provided for this item.", + "type": "string" + } + } + }, + "IaasVMRecoveryPoint": { + "description": "IaaS VM workload specific backup copy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPoint" + } + ], + "properties": { + "recoveryPointType": { + "description": "Type of the backup copy.", + "type": "string" + }, + "recoveryPointTime": { + "format": "date-time", + "description": "Time at which this backup copy was created.", + "type": "string" + }, + "recoveryPointAdditionalInfo": { + "description": "Additional information associated with this backup copy.", + "type": "string" + }, + "sourceVMStorageType": { + "description": "Storage type of the VM whose backup copy is created.", + "type": "string" + }, + "isSourceVMEncrypted": { + "description": "Identifies whether the VM was encrypted when the backup copy is created.", + "type": "boolean" + }, + "keyAndSecret": { + "$ref": "#/definitions/KeyAndSecretDetails", + "description": "Required details for recovering an encrypted VM. Applicable only when IsSourceVMEncrypted is true." + }, + "isInstantIlrSessionActive": { + "description": "Is the session to recover items from this backup copy still active.", + "type": "boolean" + }, + "recoveryPointTierDetails": { + "description": "Recovery point tier information.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPointTierInformation" + } + }, + "isManagedVirtualMachine": { + "description": "Whether VM is with Managed Disks", + "type": "boolean" + }, + "virtualMachineSize": { + "description": "Virtual Machine Size", + "type": "string" + }, + "originalStorageAccountOption": { + "description": "Original Storage Account Option", + "type": "boolean" + }, + "osType": { + "description": "OS type", + "type": "string" + }, + "recoveryPointDiskConfiguration": { + "$ref": "#/definitions/RecoveryPointDiskConfiguration", + "description": "Disk configuration" + }, + "zones": { + "description": "Identifies the zone of the VM at the time of backup. Applicable only for zone-pinned Vms", + "type": "array", + "items": { + "type": "string" + } + }, + "recoveryPointMoveReadinessInfo": { + "description": "Eligibility of RP to be moved to another tier", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/RecoveryPointMoveReadinessInfo" + } + } + }, + "x-ms-discriminator-value": "IaasVMRecoveryPoint" + }, + "IaasVMRestoreRequest": { + "description": "IaaS VM workload-specific restore.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RestoreRequest" + } + ], + "properties": { + "recoveryPointId": { + "description": "ID of the backup copy to be recovered.", + "type": "string" + }, + "recoveryType": { + "description": "Type of this recovery.", + "enum": [ + "Invalid", + "OriginalLocation", + "AlternateLocation", + "RestoreDisks", + "Offline" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryType", + "modelAsString": true + } + }, + "sourceResourceId": { + "description": "Fully qualified ARM ID of the VM which is being recovered.", + "type": "string" + }, + "targetVirtualMachineId": { + "description": "This is the complete ARM Id of the VM that will be created.\r\nFor e.g. /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm}", + "type": "string" + }, + "targetResourceGroupId": { + "description": "This is the ARM Id of the resource group that you want to create for this Virtual machine and other artifacts.\r\nFor e.g. /subscriptions/{subId}/resourcegroups/{rg}", + "type": "string" + }, + "storageAccountId": { + "description": "Fully qualified ARM ID of the storage account to which the VM has to be restored.", + "type": "string" + }, + "virtualNetworkId": { + "description": "This is the virtual network Id of the vnet that will be attached to the virtual machine.\r\nUser will be validated for join action permissions in the linked access.", + "type": "string" + }, + "subnetId": { + "description": "Subnet ID, is the subnet ID associated with the to be restored VM. For Classic VMs it would be\r\n{VnetID}/Subnet/{SubnetName} and, for the Azure Resource Manager VMs it would be ARM resource ID used to represent\r\nthe subnet.", + "type": "string" + }, + "targetDomainNameId": { + "description": "Fully qualified ARM ID of the domain name to be associated to the VM being restored. This applies only to Classic\r\nVirtual Machines.", + "type": "string" + }, + "region": { + "description": "Region in which the virtual machine is restored.", + "type": "string" + }, + "affinityGroup": { + "description": "Affinity group associated to VM to be restored. Used only for Classic Compute Virtual Machines.", + "type": "string" + }, + "createNewCloudService": { + "description": "Should a new cloud service be created while restoring the VM. If this is false, VM will be restored to the same\r\ncloud service as it was at the time of backup.", + "type": "boolean" + }, + "originalStorageAccountOption": { + "description": "Original Storage Account Option", + "type": "boolean" + }, + "encryptionDetails": { + "$ref": "#/definitions/EncryptionDetails", + "description": "Details needed if the VM was encrypted at the time of backup." + }, + "restoreDiskLunList": { + "description": "List of Disk LUNs for partial restore", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "restoreWithManagedDisks": { + "description": "Flag to denote of an Unmanaged disk VM should be restored with Managed disks.", + "type": "boolean" + }, + "diskEncryptionSetId": { + "description": "DiskEncryptionSet's ID - needed if the VM needs to be encrypted at rest during restore with customer managed key.", + "type": "string" + }, + "zones": { + "description": "Target zone where the VM and its disks should be restored.", + "type": "array", + "items": { + "type": "string" + } + }, + "identityInfo": { + "$ref": "#/definitions/IdentityInfo", + "description": "Managed Identity information required to access customer storage account." + } + }, + "x-ms-discriminator-value": "IaasVMRestoreRequest" + }, + "Job": { + "description": "Defines workload agnostic properties for a job.", + "required": [ + "jobType" + ], + "type": "object", + "properties": { + "entityFriendlyName": { + "description": "Friendly name of the entity on which the current job is executing.", + "type": "string" + }, + "backupManagementType": { + "description": "Backup management type to execute the current job.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureBackupServer", + "AzureSql", + "AzureStorage", + "AzureWorkload", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + }, + "operation": { + "description": "The operation name.", + "type": "string" + }, + "status": { + "description": "Job status.", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "The start time.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "The end time.", + "type": "string" + }, + "activityId": { + "description": "ActivityId of job.", + "type": "string" + }, + "jobType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + } + }, + "discriminator": "jobType" + }, + "JobQueryObject": { + "description": "Filters to list the jobs.", + "type": "object", + "properties": { + "status": { + "description": "Status of the job.", + "enum": [ + "Invalid", + "InProgress", + "Completed", + "Failed", + "CompletedWithWarnings", + "Cancelled", + "Cancelling" + ], + "type": "string", + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true + } + }, + "backupManagementType": { + "description": "Type of backup management for the job.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureBackupServer", + "AzureSql", + "AzureStorage", + "AzureWorkload", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + }, + "operation": { + "description": "Type of operation.", + "enum": [ + "Invalid", + "Register", + "UnRegister", + "ConfigureBackup", + "Backup", + "Restore", + "DisableBackup", + "DeleteBackupData", + "CrossRegionRestore", + "Undelete", + "UpdateCustomerManagedKey" + ], + "type": "string", + "x-ms-enum": { + "name": "JobOperationType", + "modelAsString": true + } + }, + "jobId": { + "description": "JobID represents the job uniquely.", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "Job has started at this time. Value is in UTC.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "Job has ended at this time. Value is in UTC.", + "type": "string" + } + } + }, + "JobResource": { + "description": "Defines workload agnostic properties for a job.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/Job", + "description": "JobResource properties" + } + } + }, + "JobResourceList": { + "description": "List of Job resources", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceList" + } + ], + "properties": { + "value": { + "description": "List of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/JobResource" + } + } + } + }, + "KEKDetails": { + "description": "KEK is encryption key for BEK.", + "type": "object", + "properties": { + "keyUrl": { + "description": "Key is KEK.", + "type": "string" + }, + "keyVaultId": { + "description": "Key Vault ID where this Key is stored.", + "type": "string" + }, + "keyBackupData": { + "description": "KEK data.", + "type": "string" + } + } + }, + "KeyAndSecretDetails": { + "description": "BEK is bitlocker key.\r\nKEK is encryption key for BEK\r\nIf the VM was encrypted then we will store following details :\r\n1. Secret(BEK) - Url + Backup Data + vaultId.\r\n2. Key(KEK) - Url + Backup Data + vaultId.\r\n3. EncryptionMechanism\r\nBEK and KEK can potentially have different vault ids.", + "type": "object", + "properties": { + "kekDetails": { + "$ref": "#/definitions/KEKDetails", + "description": "KEK is encryption key for BEK." + }, + "bekDetails": { + "$ref": "#/definitions/BEKDetails", + "description": "BEK is bitlocker encryption key." + }, + "encryptionMechanism": { + "description": "Encryption mechanism: None/ SinglePass/ DoublePass", + "type": "string" + } + } + }, + "LogSchedulePolicy": { + "description": "Log policy schedule.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SchedulePolicy" + } + ], + "properties": { + "scheduleFrequencyInMins": { + "format": "int32", + "description": "Frequency of the log schedule operation of this policy in minutes.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "LogSchedulePolicy" + }, + "LongTermRetentionPolicy": { + "description": "Long term retention policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RetentionPolicy" + } + ], + "properties": { + "dailySchedule": { + "$ref": "#/definitions/DailyRetentionSchedule", + "description": "Daily retention schedule of the protection policy." + }, + "weeklySchedule": { + "$ref": "#/definitions/WeeklyRetentionSchedule", + "description": "Weekly retention schedule of the protection policy." + }, + "monthlySchedule": { + "$ref": "#/definitions/MonthlyRetentionSchedule", + "description": "Monthly retention schedule of the protection policy." + }, + "yearlySchedule": { + "$ref": "#/definitions/YearlyRetentionSchedule", + "description": "Yearly retention schedule of the protection policy." + } + }, + "x-ms-discriminator-value": "LongTermRetentionPolicy" + }, + "LongTermSchedulePolicy": { + "description": "Long term policy schedule.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SchedulePolicy" + } + ], + "x-ms-discriminator-value": "LongTermSchedulePolicy" + }, + "MabErrorInfo": { + "description": "MAB workload-specific error information.", + "type": "object", + "properties": { + "errorString": { + "description": "Localized error string.", + "type": "string", + "readOnly": true + }, + "recommendations": { + "description": "List of localized recommendations.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "MabFileFolderProtectedItem": { + "description": "MAB workload-specific backup item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectedItem" + } + ], + "properties": { + "friendlyName": { + "description": "Friendly name of this backup item.", + "type": "string" + }, + "computerName": { + "description": "Name of the computer associated with this backup item.", + "type": "string" + }, + "lastBackupStatus": { + "description": "Status of last backup operation.", + "type": "string" + }, + "lastBackupTime": { + "format": "date-time", + "description": "Timestamp of the last backup operation on this backup item.", + "type": "string" + }, + "protectionState": { + "description": "Protected, ProtectionStopped, IRPending or ProtectionError", + "type": "string" + }, + "deferredDeleteSyncTimeInUTC": { + "format": "int64", + "description": "Sync time for deferred deletion in UTC", + "type": "integer" + }, + "extendedInfo": { + "$ref": "#/definitions/MabFileFolderProtectedItemExtendedInfo", + "description": "Additional information with this backup item." + } + }, + "x-ms-discriminator-value": "MabFileFolderProtectedItem" + }, + "MabFileFolderProtectedItemExtendedInfo": { + "description": "Additional information on the backed up item.", + "type": "object", + "properties": { + "lastRefreshedAt": { + "format": "date-time", + "description": "Last time when the agent data synced to service.", + "type": "string" + }, + "oldestRecoveryPoint": { + "format": "date-time", + "description": "The oldest backup copy available.", + "type": "string" + }, + "recoveryPointCount": { + "format": "int32", + "description": "Number of backup copies associated with the backup item.", + "type": "integer" + } + } + }, + "MabJob": { + "description": "MAB workload-specific job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Job" + } + ], + "properties": { + "duration": { + "format": "duration", + "description": "Time taken by job to run.", + "type": "string" + }, + "actionsInfo": { + "description": "The state/actions applicable on jobs like cancel/retry.", + "type": "array", + "items": { + "enum": [ + "Invalid", + "Cancellable", + "Retriable" + ], + "type": "string", + "x-ms-enum": { + "name": "JobSupportedAction", + "modelAsString": false + } + } + }, + "mabServerName": { + "description": "Name of server protecting the DS.", + "type": "string" + }, + "mabServerType": { + "description": "Server type of MAB container.", + "enum": [ + "Invalid", + "Unknown", + "IaasVMContainer", + "IaasVMServiceContainer", + "DPMContainer", + "AzureBackupServerContainer", + "MABContainer", + "Cluster", + "AzureSqlContainer", + "Windows", + "VCenter", + "VMAppContainer", + "SQLAGWorkLoadContainer", + "StorageContainer", + "GenericContainer" + ], + "type": "string", + "x-ms-enum": { + "name": "MabServerType", + "modelAsString": true + } + }, + "workloadType": { + "description": "Workload type of backup item.", + "enum": [ + "Invalid", + "VM", + "FileFolder", + "AzureSqlDb", + "SQLDB", + "Exchange", + "Sharepoint", + "VMwareVM", + "SystemState", + "Client", + "GenericDataSource", + "SQLDataBase", + "AzureFileShare", + "SAPHanaDatabase", + "SAPAseDatabase" + ], + "type": "string", + "x-ms-enum": { + "name": "WorkloadType", + "modelAsString": true + } + }, + "errorDetails": { + "description": "The errors.", + "type": "array", + "items": { + "$ref": "#/definitions/MabErrorInfo" + } + }, + "extendedInfo": { + "$ref": "#/definitions/MabJobExtendedInfo", + "description": "Additional information on the job." + } + }, + "x-ms-discriminator-value": "MabJob" + }, + "MabJobExtendedInfo": { + "description": "Additional information for the MAB workload-specific job.", + "type": "object", + "properties": { + "tasksList": { + "description": "List of tasks for this job.", + "type": "array", + "items": { + "$ref": "#/definitions/MabJobTaskDetails" + } + }, + "propertyBag": { + "description": "The job properties.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "dynamicErrorMessage": { + "description": "Non localized error message specific to this job.", + "type": "string" + } + } + }, + "MabJobTaskDetails": { + "description": "MAB workload-specific job task details.", + "type": "object", + "properties": { + "taskId": { + "description": "The task display name.", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "The start time.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "The end time.", + "type": "string" + }, + "duration": { + "format": "duration", + "description": "Time elapsed for task.", + "type": "string" + }, + "status": { + "description": "The status.", + "type": "string" + } + } + }, + "MabProtectionPolicy": { + "description": "Mab container-specific backup policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionPolicy" + } + ], + "properties": { + "schedulePolicy": { + "$ref": "#/definitions/SchedulePolicy", + "description": "Backup schedule of backup policy." + }, + "retentionPolicy": { + "$ref": "#/definitions/RetentionPolicy", + "description": "Retention policy details." + } + }, + "x-ms-discriminator-value": "MAB" + }, + "MonthlyRetentionSchedule": { + "description": "Monthly retention schedule.", + "type": "object", + "properties": { + "retentionScheduleFormatType": { + "description": "Retention schedule format type for monthly retention policy.", + "enum": [ + "Invalid", + "Daily", + "Weekly" + ], + "type": "string", + "x-ms-enum": { + "name": "RetentionScheduleFormat", + "modelAsString": true + } + }, + "retentionScheduleDaily": { + "$ref": "#/definitions/DailyRetentionFormat", + "description": "Daily retention format for monthly retention policy." + }, + "retentionScheduleWeekly": { + "$ref": "#/definitions/WeeklyRetentionFormat", + "description": "Weekly retention format for monthly retention policy." + }, + "retentionTimes": { + "description": "Retention times of retention policy.", + "type": "array", + "items": { + "format": "date-time", + "type": "string" + } + }, + "retentionDuration": { + "$ref": "#/definitions/RetentionDuration", + "description": "Retention duration of retention Policy." + } + } + }, + "OperationResultInfo": { + "description": "Operation result info.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OperationResultInfoBase" + } + ], + "properties": { + "jobList": { + "description": "List of jobs created by this operation.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "OperationResultInfo" + }, + "OperationResultInfoBase": { + "description": "Base class for operation result info.", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + } + }, + "discriminator": "objectType" + }, + "KPIResourceHealthDetails": { + "description": "KPI Resource Health Details", + "type": "object", + "properties": { + "resourceHealthStatus": { + "description": "Resource Health Status", + "enum": [ + "Healthy", + "TransientDegraded", + "PersistentDegraded", + "TransientUnhealthy", + "PersistentUnhealthy", + "Invalid" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceHealthStatus", + "modelAsString": true + } + }, + "resourceHealthDetails": { + "description": "Resource Health Status", + "type": "array", + "items": { + "$ref": "#/definitions/ResourceHealthDetails" + } + } + } + }, + "PrepareDataMoveRequest": { + "description": "Prepare DataMove Request", + "required": [ + "targetResourceId", + "targetRegion", + "dataMoveLevel" + ], + "type": "object", + "properties": { + "targetResourceId": { + "description": "ARM Id of target vault", + "type": "string" + }, + "targetRegion": { + "description": "Target Region", + "type": "string" + }, + "dataMoveLevel": { + "description": "DataMove Level", + "enum": [ + "Invalid", + "Vault", + "Container" + ], + "type": "string", + "x-ms-enum": { + "name": "DataMoveLevel", + "modelAsString": true + } + }, + "sourceContainerArmIds": { + "description": "Source Container ArmIds\r\nThis needs to be populated only if DataMoveLevel is set to container", + "type": "array", + "items": { + "type": "string" + } + }, + "ignoreMoved": { + "description": "Ignore the artifacts which are already moved.", + "type": "boolean" + } + } + }, + "PrepareDataMoveResponse": { + "description": "Prepare DataMove Response", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/VaultStorageConfigOperationResultResponse" + } + ], + "properties": { + "correlationId": { + "description": "Co-relationId for move operation", + "type": "string" + }, + "sourceVaultProperties": { + "description": "Source Vault Properties", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "PrepareDataMoveResponse" + }, + "VaultStorageConfigOperationResultResponse": { + "description": "Operation result response for Vault Storage Config", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + } + }, + "discriminator": "objectType" + }, + "TriggerDataMoveRequest": { + "description": "Trigger DataMove Request", + "required": [ + "sourceResourceId", + "sourceRegion", + "dataMoveLevel", + "correlationId" + ], + "type": "object", + "properties": { + "sourceResourceId": { + "description": "ARM Id of source vault", + "type": "string" + }, + "sourceRegion": { + "description": "Source Region", + "type": "string" + }, + "dataMoveLevel": { + "description": "DataMove Level", + "enum": [ + "Invalid", + "Vault", + "Container" + ], + "type": "string", + "x-ms-enum": { + "name": "DataMoveLevel", + "modelAsString": true + } + }, + "correlationId": { + "description": "Correlation Id", + "type": "string" + }, + "sourceContainerArmIds": { + "description": "Source Container ArmIds", + "type": "array", + "items": { + "type": "string" + } + }, + "pauseGC": { + "description": "Pause GC", + "type": "boolean" + } + } + }, + "OperationResultInfoBaseResource": { + "description": "Base class for operation result info.", + "allOf": [ + { + "$ref": "#/definitions/OperationWorkerResponse" + } + ], + "properties": { + "operation": { + "$ref": "#/definitions/OperationResultInfoBase", + "description": "OperationResultInfoBaseResource operation" + } + } + }, + "OperationWorkerResponse": { + "description": "This is the base class for operation result responses.", + "type": "object", + "properties": { + "statusCode": { + "description": "HTTP Status Code of the operation.", + "enum": [ + "Continue", + "SwitchingProtocols", + "OK", + "Created", + "Accepted", + "NonAuthoritativeInformation", + "NoContent", + "ResetContent", + "PartialContent", + "MultipleChoices", + "Ambiguous", + "MovedPermanently", + "Moved", + "Found", + "Redirect", + "SeeOther", + "RedirectMethod", + "NotModified", + "UseProxy", + "Unused", + "TemporaryRedirect", + "RedirectKeepVerb", + "BadRequest", + "Unauthorized", + "PaymentRequired", + "Forbidden", + "NotFound", + "MethodNotAllowed", + "NotAcceptable", + "ProxyAuthenticationRequired", + "RequestTimeout", + "Conflict", + "Gone", + "LengthRequired", + "PreconditionFailed", + "RequestEntityTooLarge", + "RequestUriTooLong", + "UnsupportedMediaType", + "RequestedRangeNotSatisfiable", + "ExpectationFailed", + "UpgradeRequired", + "InternalServerError", + "NotImplemented", + "BadGateway", + "ServiceUnavailable", + "GatewayTimeout", + "HttpVersionNotSupported" + ], + "type": "string", + "x-ms-enum": { + "name": "HttpStatusCode", + "modelAsString": false + } + }, + "headers": { + "description": "HTTP headers associated with this operation.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "PointInTimeRange": { + "description": "Provides details for log ranges", + "type": "object", + "properties": { + "startTime": { + "format": "date-time", + "description": "Start time of the time range for log recovery.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "End time of the time range for log recovery.", + "type": "string" + } + } + }, + "ProtectedItem": { + "description": "Base class for backup items.", + "required": [ + "protectedItemType" + ], + "type": "object", + "properties": { + "protectedItemType": { + "description": "backup item type.", + "type": "string" + }, + "backupManagementType": { + "description": "Type of backup management for the backed up item.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureBackupServer", + "AzureSql", + "AzureStorage", + "AzureWorkload", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + }, + "workloadType": { + "description": "Type of workload this item represents.", + "enum": [ + "Invalid", + "VM", + "FileFolder", + "AzureSqlDb", + "SQLDB", + "Exchange", + "Sharepoint", + "VMwareVM", + "SystemState", + "Client", + "GenericDataSource", + "SQLDataBase", + "AzureFileShare", + "SAPHanaDatabase", + "SAPAseDatabase" + ], + "type": "string", + "x-ms-enum": { + "name": "DataSourceType", + "modelAsString": true + } + }, + "containerName": { + "description": "Unique name of container", + "type": "string" + }, + "sourceResourceId": { + "description": "ARM ID of the resource to be backed up.", + "type": "string" + }, + "policyId": { + "description": "ID of the backup policy with which this item is backed up.", + "type": "string" + }, + "lastRecoveryPoint": { + "format": "date-time", + "description": "Timestamp when the last (latest) backup copy was created for this backup item.", + "type": "string" + }, + "backupSetName": { + "description": "Name of the backup set the backup item belongs to", + "type": "string" + }, + "createMode": { + "description": "Create mode to indicate recovery of existing soft deleted data source or creation of new data source.", + "enum": [ + "Invalid", + "Default", + "Recover" + ], + "type": "string", + "x-ms-enum": { + "name": "CreateMode", + "modelAsString": true + } + }, + "deferredDeleteTimeInUTC": { + "format": "date-time", + "description": "Time for deferred deletion in UTC", + "type": "string" + }, + "isScheduledForDeferredDelete": { + "description": "Flag to identify whether the DS is scheduled for deferred delete", + "type": "boolean" + }, + "deferredDeleteTimeRemaining": { + "description": "Time remaining before the DS marked for deferred delete is permanently deleted", + "type": "string" + }, + "isDeferredDeleteScheduleUpcoming": { + "description": "Flag to identify whether the deferred deleted DS is to be purged soon", + "type": "boolean" + }, + "isRehydrate": { + "description": "Flag to identify that deferred deleted DS is to be moved into Pause state", + "type": "boolean" + } + }, + "discriminator": "protectedItemType" + }, + "ProtectedItemQueryObject": { + "description": "Filters to list backup items.", + "type": "object", + "properties": { + "healthState": { + "description": "Health State for the backed up item.", + "enum": [ + "Passed", + "ActionRequired", + "ActionSuggested", + "Invalid" + ], + "type": "string", + "x-ms-enum": { + "name": "HealthState", + "modelAsString": true + } + }, + "backupManagementType": { + "description": "Backup management type for the backed up item.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureBackupServer", + "AzureSql", + "AzureStorage", + "AzureWorkload", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + }, + "itemType": { + "description": "Type of workload this item represents.", + "enum": [ + "Invalid", + "VM", + "FileFolder", + "AzureSqlDb", + "SQLDB", + "Exchange", + "Sharepoint", + "VMwareVM", + "SystemState", + "Client", + "GenericDataSource", + "SQLDataBase", + "AzureFileShare", + "SAPHanaDatabase", + "SAPAseDatabase" + ], + "type": "string", + "x-ms-enum": { + "name": "DataSourceType", + "modelAsString": true + } + }, + "policyName": { + "description": "Backup policy name associated with the backup item.", + "type": "string" + }, + "containerName": { + "description": "Name of the container.", + "type": "string" + }, + "backupEngineName": { + "description": "Backup Engine name", + "type": "string" + }, + "friendlyName": { + "description": "Friendly name of protected item", + "type": "string" + }, + "fabricName": { + "description": "Name of the fabric.", + "type": "string" + }, + "backupSetName": { + "description": "Name of the backup set.", + "type": "string" + } + } + }, + "ProtectedItemResource": { + "description": "Base class for backup items.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ProtectedItem", + "description": "ProtectedItemResource properties" + } + } + }, + "ProtectedItemResourceList": { + "description": "List of ProtectedItem resources", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceList" + } + ], + "properties": { + "value": { + "description": "List of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ProtectedItemResource" + } + } + } + }, + "ProtectionPolicy": { + "description": "Base class for backup policy. Workload-specific backup policies are derived from this class.", + "required": [ + "backupManagementType" + ], + "type": "object", + "properties": { + "protectedItemsCount": { + "format": "int32", + "description": "Number of items associated with this policy.", + "type": "integer" + }, + "backupManagementType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + } + }, + "discriminator": "backupManagementType" + }, + "ProtectionPolicyQueryObject": { + "description": "Filters the list backup policies API.", + "type": "object", + "properties": { + "backupManagementType": { + "description": "Backup management type for the backup policy.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureBackupServer", + "AzureSql", + "AzureStorage", + "AzureWorkload", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + }, + "fabricName": { + "description": "Fabric name for filter", + "type": "string" + }, + "workloadType": { + "description": "Workload type for the backup policy.", + "enum": [ + "Invalid", + "VM", + "FileFolder", + "AzureSqlDb", + "SQLDB", + "Exchange", + "Sharepoint", + "VMwareVM", + "SystemState", + "Client", + "GenericDataSource", + "SQLDataBase", + "AzureFileShare", + "SAPHanaDatabase", + "SAPAseDatabase" + ], + "type": "string", + "x-ms-enum": { + "name": "WorkloadType", + "modelAsString": true + } + } + } + }, + "ProtectionPolicyResource": { + "description": "Base class for backup policy. Workload-specific backup policies are derived from this class.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ProtectionPolicy", + "description": "ProtectionPolicyResource properties" + } + } + }, + "ProtectionPolicyResourceList": { + "description": "List of ProtectionPolicy resources", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceList" + } + ], + "properties": { + "value": { + "description": "List of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ProtectionPolicyResource" + } + } + } + }, + "RecoveryPoint": { + "description": "Base class for backup copies. Workload-specific backup copies are derived from this class.", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + } + }, + "discriminator": "objectType" + }, + "RecoveryPointDiskConfiguration": { + "description": "Disk configuration", + "type": "object", + "properties": { + "numberOfDisksIncludedInBackup": { + "format": "int32", + "description": "Number of disks included in backup", + "type": "integer" + }, + "numberOfDisksAttachedToVm": { + "format": "int32", + "description": "Number of disks attached to the VM", + "type": "integer" + }, + "includedDiskList": { + "description": "Information of disks included in backup", + "type": "array", + "items": { + "$ref": "#/definitions/DiskInformation" + } + }, + "excludedDiskList": { + "description": "Information of disks excluded from backup", + "type": "array", + "items": { + "$ref": "#/definitions/DiskInformation" + } + } + } + }, + "RecoveryPointResource": { + "description": "Base class for backup copies. Workload-specific backup copies are derived from this class.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RecoveryPoint", + "description": "RecoveryPointResource properties" + } + } + }, + "RecoveryPointResourceList": { + "description": "List of RecoveryPoint resources", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceList" + } + ], + "properties": { + "value": { + "description": "List of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPointResource" + } + } + } + }, + "RecoveryPointTierInformation": { + "description": "Recovery point tier information.", + "type": "object", + "properties": { + "type": { + "description": "Recovery point tier type.", + "enum": [ + "Invalid", + "InstantRP", + "HardenedRP", + "ArchivedRP" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPointTierType", + "modelAsString": false + } + }, + "status": { + "description": "Recovery point tier status.", + "enum": [ + "Invalid", + "Valid", + "Disabled", + "Deleted", + "Rehydrated" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPointTierStatus", + "modelAsString": false + } + }, + "extendedInfo": { + "description": "Recovery point tier status.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Resource": { + "description": "ARM Resource.", + "type": "object", + "properties": { + "id": { + "description": "Resource Id represents the complete path to the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource name associated with the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...", + "type": "string", + "readOnly": true + }, + "location": { + "description": "Resource location.", + "type": "string" + }, + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "eTag": { + "description": "Optional ETag.", + "type": "string" + } + }, + "x-ms-azure-resource": true + }, + "ResourceList": { + "description": "Base for all lists of resources.", + "type": "object", + "properties": { + "nextLink": { + "description": "The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.", + "type": "string" + } + } + }, + "RestoreFileSpecs": { + "description": "Restore file specs like file path, type and target folder path info.", + "type": "object", + "properties": { + "path": { + "description": "Source File/Folder path", + "type": "string" + }, + "fileSpecType": { + "description": "Indicates what the Path variable stands for", + "type": "string" + }, + "targetFolderPath": { + "description": "Destination folder path in target FileShare", + "type": "string" + } + } + }, + "RestoreRequest": { + "description": "Base class for restore request. Workload-specific restore requests are derived from this class.", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + } + }, + "discriminator": "objectType" + }, + "RestoreRequestResource": { + "description": "Base class for restore request. Workload-specific restore requests are derived from this class.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RestoreRequest", + "description": "RestoreRequestResource properties" + } + } + }, + "RetentionDuration": { + "description": "Retention duration.", + "type": "object", + "properties": { + "count": { + "format": "int32", + "description": "Count of duration types. Retention duration is obtained by the counting the duration type Count times.\r\nFor example, when Count = 3 and DurationType = Weeks, retention duration will be three weeks.", + "type": "integer" + }, + "durationType": { + "description": "Retention duration type of retention policy.", + "enum": [ + "Invalid", + "Days", + "Weeks", + "Months", + "Years" + ], + "type": "string", + "x-ms-enum": { + "name": "RetentionDurationType", + "modelAsString": true + } + } + } + }, + "RetentionPolicy": { + "description": "Base class for retention policy.", + "required": [ + "retentionPolicyType" + ], + "type": "object", + "properties": { + "retentionPolicyType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + } + }, + "discriminator": "retentionPolicyType" + }, + "SchedulePolicy": { + "description": "Base class for backup schedule.", + "required": [ + "schedulePolicyType" + ], + "type": "object", + "properties": { + "schedulePolicyType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + } + }, + "discriminator": "schedulePolicyType" + }, + "Settings": { + "description": "Common settings field for backup management", + "type": "object", + "properties": { + "timeZone": { + "description": "TimeZone optional input as string. For example: TimeZone = \"Pacific Standard Time\".", + "type": "string" + }, + "issqlcompression": { + "description": "SQL compression flag", + "type": "boolean" + }, + "isCompression": { + "description": "Workload compression flag. This has been added so that 'isSqlCompression'\r\nwill be deprecated once clients upgrade to consider this flag.", + "type": "boolean" + } + } + }, + "SimpleRetentionPolicy": { + "description": "Simple policy retention.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RetentionPolicy" + } + ], + "properties": { + "retentionDuration": { + "$ref": "#/definitions/RetentionDuration", + "description": "Retention duration of the protection policy." + } + }, + "x-ms-discriminator-value": "SimpleRetentionPolicy" + }, + "SimpleSchedulePolicy": { + "description": "Simple policy schedule.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SchedulePolicy" + } + ], + "properties": { + "scheduleRunFrequency": { + "description": "Frequency of the schedule operation of this policy.", + "enum": [ + "Invalid", + "Daily", + "Weekly" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduleRunType", + "modelAsString": true + } + }, + "scheduleRunDays": { + "description": "List of days of week this schedule has to be run.", + "type": "array", + "items": { + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "type": "string", + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + } + } + }, + "scheduleRunTimes": { + "description": "List of times of day this schedule has to be run.", + "type": "array", + "items": { + "format": "date-time", + "type": "string" + } + }, + "scheduleWeeklyFrequency": { + "format": "int32", + "description": "At every number weeks this schedule has to be run.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "SimpleSchedulePolicy" + }, + "SubProtectionPolicy": { + "description": "Sub-protection policy which includes schedule and retention", + "type": "object", + "properties": { + "policyType": { + "description": "Type of backup policy type", + "enum": [ + "Invalid", + "Full", + "Differential", + "Log", + "CopyOnlyFull", + "Incremental" + ], + "type": "string", + "x-ms-enum": { + "name": "PolicyType", + "modelAsString": true + } + }, + "schedulePolicy": { + "$ref": "#/definitions/SchedulePolicy", + "description": "Backup schedule specified as part of backup policy." + }, + "retentionPolicy": { + "$ref": "#/definitions/RetentionPolicy", + "description": "Retention policy with the details on backup copy retention ranges." + } + } + }, + "SQLDataDirectory": { + "description": "SQLDataDirectory info", + "type": "object", + "properties": { + "type": { + "description": "Type of data directory mapping", + "enum": [ + "Invalid", + "Data", + "Log" + ], + "type": "string", + "x-ms-enum": { + "name": "SQLDataDirectoryType", + "modelAsString": true + } + }, + "path": { + "description": "File path", + "type": "string" + }, + "logicalName": { + "description": "Logical name of the file", + "type": "string" + } + } + }, + "SQLDataDirectoryMapping": { + "description": "Encapsulates information regarding data directory", + "type": "object", + "properties": { + "mappingType": { + "description": "Type of data directory mapping", + "enum": [ + "Invalid", + "Data", + "Log" + ], + "type": "string", + "x-ms-enum": { + "name": "SQLDataDirectoryType", + "modelAsString": true + } + }, + "sourceLogicalName": { + "description": "Restore source logical name path", + "type": "string" + }, + "sourcePath": { + "description": "Restore source path", + "type": "string" + }, + "targetPath": { + "description": "Target path", + "type": "string" + } + } + }, + "TargetAFSRestoreInfo": { + "description": "Target Azure File Share Info.", + "type": "object", + "properties": { + "name": { + "description": "File share name", + "type": "string" + }, + "targetResourceId": { + "description": "Target file share resource ARM ID", + "type": "string" + } + } + }, + "TargetRestoreInfo": { + "description": "Details about target workload during restore operation.", + "type": "object", + "properties": { + "overwriteOption": { + "description": "Can Overwrite if Target DataBase already exists", + "enum": [ + "Invalid", + "FailOnConflict", + "Overwrite" + ], + "type": "string", + "x-ms-enum": { + "name": "OverwriteOptions", + "modelAsString": true + } + }, + "containerId": { + "description": "Resource Id name of the container in which Target DataBase resides", + "type": "string" + }, + "databaseName": { + "description": "Database name InstanceName/DataBaseName for SQL or System/DbName for SAP Hana", + "type": "string" + }, + "targetDirectoryForFileRestore": { + "description": "Target directory location for restore as files.", + "type": "string" + } + } + }, + "ValidateIaasVMRestoreOperationRequest": { + "description": "AzureRestoreValidation request.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidateRestoreOperationRequest" + } + ], + "x-ms-discriminator-value": "ValidateIaasVMRestoreOperationRequest" + }, + "ValidateOperationRequest": { + "description": "Base class for validate operation request.", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + } + }, + "discriminator": "objectType" + }, + "ValidateOperationResponse": { + "description": "Base class for validate operation response.", + "type": "object", + "properties": { + "validationResults": { + "description": "Gets the validation result", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetail" + } + } + } + }, + "ValidateOperationsResponse": { + "type": "object", + "properties": { + "validateOperationResponse": { + "$ref": "#/definitions/ValidateOperationResponse" + } + } + }, + "ValidateRestoreOperationRequest": { + "description": "AzureRestoreValidation request.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidateOperationRequest" + } + ], + "properties": { + "restoreRequest": { + "$ref": "#/definitions/RestoreRequest", + "description": "Sets restore request to be validated" + } + }, + "x-ms-discriminator-value": "ValidateRestoreOperationRequest" + }, + "WeeklyRetentionFormat": { + "description": "Weekly retention format.", + "type": "object", + "properties": { + "daysOfTheWeek": { + "description": "List of days of the week.", + "type": "array", + "items": { + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "type": "string", + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + } + } + }, + "weeksOfTheMonth": { + "description": "List of weeks of month.", + "type": "array", + "items": { + "enum": [ + "First", + "Second", + "Third", + "Fourth", + "Last", + "Invalid" + ], + "type": "string", + "x-ms-enum": { + "name": "WeekOfMonth", + "modelAsString": false + } + } + } + } + }, + "WeeklyRetentionSchedule": { + "description": "Weekly retention schedule.", + "type": "object", + "properties": { + "daysOfTheWeek": { + "description": "List of days of week for weekly retention policy.", + "type": "array", + "items": { + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "type": "string", + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + } + } + }, + "retentionTimes": { + "description": "Retention times of retention policy.", + "type": "array", + "items": { + "format": "date-time", + "type": "string" + } + }, + "retentionDuration": { + "$ref": "#/definitions/RetentionDuration", + "description": "Retention duration of retention Policy." + } + } + }, + "BackupResourceVaultConfigResource": { + "description": "Backup resource vault config details.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BackupResourceVaultConfig", + "description": "BackupResourceVaultConfigResource properties" + } + } + }, + "BackupResourceVaultConfig": { + "description": "Backup resource vault config details.", + "type": "object", + "properties": { + "storageModelType": { + "description": "Storage type.", + "enum": [ + "Invalid", + "GeoRedundant", + "LocallyRedundant", + "ZoneRedundant", + "ReadAccessGeoZoneRedundant" + ], + "type": "string", + "x-ms-enum": { + "name": "StorageType", + "modelAsString": true + } + }, + "storageType": { + "description": "Storage type.", + "enum": [ + "Invalid", + "GeoRedundant", + "LocallyRedundant", + "ZoneRedundant", + "ReadAccessGeoZoneRedundant" + ], + "type": "string", + "x-ms-enum": { + "name": "StorageType", + "modelAsString": true + } + }, + "storageTypeState": { + "description": "Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked.", + "enum": [ + "Invalid", + "Locked", + "Unlocked" + ], + "type": "string", + "x-ms-enum": { + "name": "StorageTypeState", + "modelAsString": true + } + }, + "enhancedSecurityState": { + "description": "Enabled or Disabled.", + "enum": [ + "Invalid", + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EnhancedSecurityState", + "modelAsString": true + } + }, + "softDeleteFeatureState": { + "description": "Soft Delete feature state", + "enum": [ + "Invalid", + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "SoftDeleteFeatureState", + "modelAsString": true + } + } + } + }, + "YearlyRetentionSchedule": { + "description": "Yearly retention schedule.", + "type": "object", + "properties": { + "retentionScheduleFormatType": { + "description": "Retention schedule format for yearly retention policy.", + "enum": [ + "Invalid", + "Daily", + "Weekly" + ], + "type": "string", + "x-ms-enum": { + "name": "RetentionScheduleFormat", + "modelAsString": true + } + }, + "monthsOfYear": { + "description": "List of months of year of yearly retention policy.", + "type": "array", + "items": { + "enum": [ + "Invalid", + "January", + "February", + "March", + "April", + "May", + "June", + "July", + "August", + "September", + "October", + "November", + "December" + ], + "type": "string", + "x-ms-enum": { + "name": "MonthOfYear", + "modelAsString": false + } + } + }, + "retentionScheduleDaily": { + "$ref": "#/definitions/DailyRetentionFormat", + "description": "Daily retention format for yearly retention policy." + }, + "retentionScheduleWeekly": { + "$ref": "#/definitions/WeeklyRetentionFormat", + "description": "Weekly retention format for yearly retention policy." + }, + "retentionTimes": { + "description": "Retention times of retention policy.", + "type": "array", + "items": { + "format": "date-time", + "type": "string" + } + }, + "retentionDuration": { + "$ref": "#/definitions/RetentionDuration", + "description": "Retention duration of retention Policy." + } + } + }, + "VaultJob": { + "description": "Vault level Job", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Job" + } + ], + "properties": { + "duration": { + "format": "duration", + "description": "Time elapsed during the execution of this job.", + "type": "string" + }, + "actionsInfo": { + "description": "Gets or sets the state/actions applicable on this job like cancel/retry.", + "type": "array", + "items": { + "enum": [ + "Invalid", + "Cancellable", + "Retriable" + ], + "type": "string", + "x-ms-enum": { + "name": "JobSupportedAction", + "modelAsString": false + } + } + }, + "errorDetails": { + "description": "Error details on execution of this job.", + "type": "array", + "items": { + "$ref": "#/definitions/VaultJobErrorInfo" + } + }, + "extendedInfo": { + "$ref": "#/definitions/VaultJobExtendedInfo", + "description": "Additional information about the job." + } + }, + "x-ms-discriminator-value": "VaultJob" + }, + "VaultJobErrorInfo": { + "description": "Vault Job specific error information", + "type": "object", + "properties": { + "errorCode": { + "format": "int32", + "description": "Error code.", + "type": "integer" + }, + "errorString": { + "description": "Localized error string.", + "type": "string" + }, + "recommendations": { + "description": "List of localized recommendations for above error code.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "VaultJobExtendedInfo": { + "description": "Vault Job for CMK - has CMK specific info.", + "type": "object", + "properties": { + "propertyBag": { + "description": "Job properties.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "AzureBackupServerContainer": { + "description": "AzureBackupServer (DPMVenus) workload-specific protection container.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DpmContainer" + } + ], + "x-ms-discriminator-value": "AzureBackupServerContainer" + }, + "AzureBackupServerEngine": { + "description": "Backup engine type when Azure Backup Server is used to manage the backups.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BackupEngineBase" + } + ], + "x-ms-discriminator-value": "AzureBackupServerEngine" + }, + "AzureFileShareBackupRequest": { + "description": "AzureFileShare workload-specific backup request.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BackupRequest" + } + ], + "properties": { + "recoveryPointExpiryTimeInUTC": { + "format": "date-time", + "description": "Backup copy will expire after the time specified (UTC).", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureFileShareBackupRequest" + }, + "AzureFileShareProtectableItem": { + "description": "Protectable item for Azure Fileshare workloads.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkloadProtectableItem" + } + ], + "properties": { + "parentContainerFabricId": { + "description": "Full Fabric ID of container to which this protectable item belongs. For example, ARM ID.", + "type": "string" + }, + "parentContainerFriendlyName": { + "description": "Friendly name of container to which this protectable item belongs.", + "type": "string" + }, + "azureFileShareType": { + "description": "File Share type XSync or XSMB.", + "enum": [ + "Invalid", + "XSMB", + "XSync" + ], + "type": "string", + "x-ms-enum": { + "name": "AzureFileShareType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "AzureFileShare" + }, + "AzureFileShareProvisionILRRequest": { + "description": "Update snapshot Uri with the correct friendly Name of the source Azure file share.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ILRRequest" + } + ], + "properties": { + "recoveryPointId": { + "description": "Recovery point ID.", + "type": "string" + }, + "sourceResourceId": { + "description": "Source Storage account ARM Id", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureFileShareProvisionILRRequest" + }, + "AzureIaaSClassicComputeVMContainer": { + "description": "IaaS VM workload-specific backup item representing a classic virtual machine.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IaaSVMContainer" + } + ], + "x-ms-discriminator-value": "Microsoft.ClassicCompute/virtualMachines" + }, + "AzureIaaSClassicComputeVMProtectableItem": { + "description": "IaaS VM workload-specific backup item representing the Classic Compute VM.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IaaSVMProtectableItem" + } + ], + "x-ms-discriminator-value": "Microsoft.ClassicCompute/virtualMachines" + }, + "AzureIaaSComputeVMContainer": { + "description": "IaaS VM workload-specific backup item representing an Azure Resource Manager virtual machine.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IaaSVMContainer" + } + ], + "x-ms-discriminator-value": "Microsoft.Compute/virtualMachines" + }, + "AzureIaaSComputeVMProtectableItem": { + "description": "IaaS VM workload-specific backup item representing the Azure Resource Manager VM.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IaaSVMProtectableItem" + } + ], + "x-ms-discriminator-value": "Microsoft.Compute/virtualMachines" + }, + "AzureSQLAGWorkloadContainerProtectionContainer": { + "description": "Container for SQL workloads under SQL Availability Group.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadContainer" + } + ], + "x-ms-discriminator-value": "SQLAGWorkLoadContainer" + }, + "AzureSqlContainer": { + "description": "Azure Sql workload-specific container.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionContainer" + } + ], + "x-ms-discriminator-value": "AzureSqlContainer" + }, + "AzureStorageContainer": { + "description": "Azure Storage Account workload-specific container.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionContainer" + } + ], + "properties": { + "sourceResourceId": { + "description": "Fully qualified ARM url.", + "type": "string" + }, + "storageAccountVersion": { + "description": "Storage account version.", + "type": "string" + }, + "resourceGroup": { + "description": "Resource group name of Recovery Services Vault.", + "type": "string" + }, + "protectedItemCount": { + "format": "int64", + "description": "Number of items backed up in this container.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "StorageContainer" + }, + "AzureStorageProtectableContainer": { + "description": "Azure Storage-specific protectable containers", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectableContainer" + } + ], + "x-ms-discriminator-value": "StorageContainer" + }, + "AzureVMAppContainerProtectableContainer": { + "description": "Azure workload-specific container", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectableContainer" + } + ], + "x-ms-discriminator-value": "VMAppContainer" + }, + "AzureVMAppContainerProtectionContainer": { + "description": "Container for SQL workloads under Azure Virtual Machines.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadContainer" + } + ], + "x-ms-discriminator-value": "VMAppContainer" + }, + "AzureVmWorkloadItem": { + "description": "Azure VM workload-specific workload item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkloadItem" + } + ], + "properties": { + "parentName": { + "description": "Name for instance or AG", + "type": "string" + }, + "serverName": { + "description": "Host/Cluster Name for instance or AG", + "type": "string" + }, + "isAutoProtectable": { + "description": "Indicates if workload item is auto-protectable", + "type": "boolean" + }, + "subinquireditemcount": { + "format": "int32", + "description": "For instance or AG, indicates number of DB's present", + "type": "integer" + }, + "subWorkloadItemCount": { + "format": "int32", + "description": "For instance or AG, indicates number of DB's to be protected", + "type": "integer" + } + }, + "x-ms-discriminator-value": "AzureVmWorkloadItem" + }, + "AzureVmWorkloadProtectableItem": { + "description": "Azure VM workload-specific protectable item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkloadProtectableItem" + } + ], + "properties": { + "parentName": { + "description": "Name for instance or AG", + "type": "string" + }, + "parentUniqueName": { + "description": "Parent Unique Name is added to provide the service formatted URI Name of the Parent\r\nOnly Applicable for data bases where the parent would be either Instance or a SQL AG.", + "type": "string" + }, + "serverName": { + "description": "Host/Cluster Name for instance or AG", + "type": "string" + }, + "isAutoProtectable": { + "description": "Indicates if protectable item is auto-protectable", + "type": "boolean" + }, + "isAutoProtected": { + "description": "Indicates if protectable item is auto-protected", + "type": "boolean" + }, + "subinquireditemcount": { + "format": "int32", + "description": "For instance or AG, indicates number of DB's present", + "type": "integer" + }, + "subprotectableitemcount": { + "format": "int32", + "description": "For instance or AG, indicates number of DB's to be protected", + "type": "integer" + }, + "prebackupvalidation": { + "$ref": "#/definitions/PreBackupValidation", + "description": "Pre-backup validation for protectable objects" + } + }, + "x-ms-discriminator-value": "AzureVmWorkloadProtectableItem" + }, + "AzureVmWorkloadSAPAseDatabaseWorkloadItem": { + "description": "Azure VM workload-specific workload item representing SAP ASE Database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadItem" + } + ], + "x-ms-discriminator-value": "SAPAseDatabase" + }, + "AzureVmWorkloadSAPAseSystemProtectableItem": { + "description": "Azure VM workload-specific protectable item representing SAP ASE System.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadProtectableItem" + } + ], + "x-ms-discriminator-value": "SAPAseSystem" + }, + "AzureVmWorkloadSAPAseSystemWorkloadItem": { + "description": "Azure VM workload-specific workload item representing SAP ASE System.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadItem" + } + ], + "x-ms-discriminator-value": "SAPAseSystem" + }, + "AzureVmWorkloadSAPHanaDatabaseProtectableItem": { + "description": "Azure VM workload-specific protectable item representing SAP HANA Database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadProtectableItem" + } + ], + "x-ms-discriminator-value": "SAPHanaDatabase" + }, + "AzureVmWorkloadSAPHanaDatabaseWorkloadItem": { + "description": "Azure VM workload-specific workload item representing SAP HANA Database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadItem" + } + ], + "x-ms-discriminator-value": "SAPHanaDatabase" + }, + "AzureVmWorkloadSAPHanaSystemProtectableItem": { + "description": "Azure VM workload-specific protectable item representing SAP HANA System.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadProtectableItem" + } + ], + "x-ms-discriminator-value": "SAPHanaSystem" + }, + "AzureVmWorkloadSAPHanaSystemWorkloadItem": { + "description": "Azure VM workload-specific workload item representing SAP HANA System.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadItem" + } + ], + "x-ms-discriminator-value": "SAPHanaSystem" + }, + "AzureVmWorkloadSQLAvailabilityGroupProtectableItem": { + "description": "Azure VM workload-specific protectable item representing SQL Availability Group.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadProtectableItem" + } + ], + "x-ms-discriminator-value": "SQLAvailabilityGroupContainer" + }, + "AzureVmWorkloadSQLDatabaseProtectableItem": { + "description": "Azure VM workload-specific protectable item representing SQL Database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadProtectableItem" + } + ], + "x-ms-discriminator-value": "SQLDataBase" + }, + "AzureVmWorkloadSQLDatabaseWorkloadItem": { + "description": "Azure VM workload-specific workload item representing SQL Database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadItem" + } + ], + "x-ms-discriminator-value": "SQLDataBase" + }, + "AzureVmWorkloadSQLInstanceProtectableItem": { + "description": "Azure VM workload-specific protectable item representing SQL Instance.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadProtectableItem" + } + ], + "x-ms-discriminator-value": "SQLInstance" + }, + "AzureVmWorkloadSQLInstanceWorkloadItem": { + "description": "Azure VM workload-specific workload item representing SQL Instance.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadItem" + } + ], + "properties": { + "dataDirectoryPaths": { + "description": "Data Directory Paths for default directories", + "type": "array", + "items": { + "$ref": "#/definitions/SQLDataDirectory" + } + } + }, + "x-ms-discriminator-value": "SQLInstance" + }, + "AzureWorkloadBackupRequest": { + "description": "AzureWorkload workload-specific backup request.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BackupRequest" + } + ], + "properties": { + "backupType": { + "description": "Type of backup, viz. Full, Differential, Log or CopyOnlyFull", + "enum": [ + "Invalid", + "Full", + "Differential", + "Log", + "CopyOnlyFull", + "Incremental" + ], + "type": "string", + "x-ms-enum": { + "name": "backupType", + "modelAsString": true + } + }, + "enableCompression": { + "description": "Bool for Compression setting", + "type": "boolean" + }, + "recoveryPointExpiryTimeInUTC": { + "format": "date-time", + "description": "Backup copy will expire after the time specified (UTC).", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureWorkloadBackupRequest" + }, + "AzureBackupGoalFeatureSupportRequest": { + "description": "Azure backup goal feature specific request.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FeatureSupportRequest" + } + ], + "x-ms-discriminator-value": "AzureBackupGoals" + }, + "AzureRecoveryServiceVaultProtectionIntent": { + "description": "Azure Recovery Services Vault specific protection intent item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionIntent" + } + ], + "x-ms-discriminator-value": "RecoveryServiceVaultItem" + }, + "AzureResourceProtectionIntent": { + "description": "IaaS VM specific backup protection intent item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionIntent" + } + ], + "properties": { + "friendlyName": { + "description": "Friendly name of the VM represented by this backup item.", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureResourceItem" + }, + "AzureVMResourceFeatureSupportRequest": { + "description": "AzureResource(IaaS VM) Specific feature support request", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FeatureSupportRequest" + } + ], + "properties": { + "vmSize": { + "description": "Size of the resource: VM size(A/D series etc) in case of IaasVM", + "type": "string" + }, + "vmSku": { + "description": "SKUs (Premium/Managed etc) in case of IaasVM", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureVMResourceBackup" + }, + "AzureVMResourceFeatureSupportResponse": { + "description": "Response for feature support requests for Azure IaasVm", + "type": "object", + "properties": { + "supportStatus": { + "description": "Support status of feature", + "enum": [ + "Invalid", + "Supported", + "DefaultOFF", + "DefaultON", + "NotSupported" + ], + "type": "string", + "x-ms-enum": { + "name": "SupportStatus", + "modelAsString": true + } + } + } + }, + "AzureWorkloadAutoProtectionIntent": { + "description": "Azure Recovery Services Vault specific protection intent item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureRecoveryServiceVaultProtectionIntent" + } + ], + "x-ms-discriminator-value": "AzureWorkloadAutoProtectionIntent" + }, + "AzureWorkloadSQLAutoProtectionIntent": { + "description": "Azure Workload SQL Auto Protection intent item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadAutoProtectionIntent" + } + ], + "properties": { + "workloadItemType": { + "description": "Workload item type of the item for which intent is to be set", + "enum": [ + "Invalid", + "SQLInstance", + "SQLDataBase", + "SAPHanaSystem", + "SAPHanaDatabase", + "SAPAseSystem", + "SAPAseDatabase" + ], + "type": "string", + "x-ms-enum": { + "name": "WorkloadItemType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "AzureWorkloadSQLAutoProtectionIntent" + }, + "BackupManagementUsage": { + "description": "Backup management usages of a vault.", + "type": "object", + "properties": { + "unit": { + "description": "Unit of the usage.", + "enum": [ + "Count", + "Bytes", + "Seconds", + "Percent", + "CountPerSecond", + "BytesPerSecond" + ], + "type": "string", + "x-ms-enum": { + "name": "UsagesUnit", + "modelAsString": true + } + }, + "quotaPeriod": { + "description": "Quota period of usage.", + "type": "string" + }, + "nextResetTime": { + "format": "date-time", + "description": "Next reset time of usage.", + "type": "string" + }, + "currentValue": { + "format": "int64", + "description": "Current value of usage.", + "type": "integer" + }, + "limit": { + "format": "int64", + "description": "Limit of usage.", + "type": "integer" + }, + "name": { + "$ref": "#/definitions/NameInfo", + "description": "Name of usage." + } + } + }, + "BackupManagementUsageList": { + "description": "Backup management usage for vault.", + "type": "object", + "properties": { + "value": { + "description": "The list of backup management usages for the given vault.", + "type": "array", + "items": { + "$ref": "#/definitions/BackupManagementUsage" + } + } + } + }, + "BackupStatusRequest": { + "description": "BackupStatus request.", + "type": "object", + "properties": { + "resourceType": { + "description": "Container Type - VM, SQLPaaS, DPM, AzureFileShare...", + "enum": [ + "Invalid", + "VM", + "FileFolder", + "AzureSqlDb", + "SQLDB", + "Exchange", + "Sharepoint", + "VMwareVM", + "SystemState", + "Client", + "GenericDataSource", + "SQLDataBase", + "AzureFileShare", + "SAPHanaDatabase", + "SAPAseDatabase" + ], + "type": "string", + "x-ms-enum": { + "name": "DataSourceType", + "modelAsString": true + } + }, + "resourceId": { + "description": "Entire ARM resource id of the resource", + "type": "string" + }, + "poLogicalName": { + "description": "Protectable Item Logical Name", + "type": "string" + } + } + }, + "BackupStatusResponse": { + "description": "BackupStatus response.", + "type": "object", + "properties": { + "protectionStatus": { + "description": "Specifies whether the container is registered or not", + "enum": [ + "Invalid", + "NotProtected", + "Protecting", + "Protected", + "ProtectionFailed" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectionStatus", + "modelAsString": true + } + }, + "vaultId": { + "description": "Specifies the arm resource id of the vault", + "type": "string" + }, + "fabricName": { + "description": "Specifies the fabric name - Azure or AD", + "enum": [ + "Invalid", + "Azure" + ], + "type": "string", + "x-ms-enum": { + "name": "FabricName", + "modelAsString": true + } + }, + "containerName": { + "description": "Specifies the product specific container name. E.g. iaasvmcontainer;iaasvmcontainer;csname;vmname.", + "type": "string" + }, + "protectedItemName": { + "description": "Specifies the product specific ds name. E.g. vm;iaasvmcontainer;csname;vmname.", + "type": "string" + }, + "errorCode": { + "description": "ErrorCode in case of intent failed", + "type": "string" + }, + "errorMessage": { + "description": "ErrorMessage in case of intent failed.", + "type": "string" + }, + "policyName": { + "description": "Specifies the policy name which is used for protection", + "type": "string" + }, + "registrationStatus": { + "description": "Container registration status", + "type": "string" + } + } + }, + "BMSBackupSummariesQueryObject": { + "description": "Query parameters to fetch backup summaries.", + "type": "object", + "properties": { + "type": { + "description": "Backup management type for this container.", + "enum": [ + "Invalid", + "BackupProtectedItemCountSummary", + "BackupProtectionContainerCountSummary" + ], + "type": "string", + "x-ms-enum": { + "name": "Type", + "modelAsString": true + } + } + } + }, + "FeatureSupportRequest": { + "description": "Base class for feature request", + "required": [ + "featureType" + ], + "type": "object", + "properties": { + "featureType": { + "description": "backup support feature type.", + "type": "string" + } + }, + "discriminator": "featureType" + }, + "NameInfo": { + "description": "The name of usage.", + "type": "object", + "properties": { + "value": { + "description": "Value of usage.", + "type": "string" + }, + "localizedValue": { + "description": "Localized value of usage.", + "type": "string" + } + } + }, + "PreValidateEnableBackupRequest": { + "description": "Contract to validate if backup can be enabled on the given resource in a given vault and given configuration.\r\nIt will validate followings\r\n1. Vault capacity\r\n2. VM is already protected\r\n3. Any VM related configuration passed in properties.", + "type": "object", + "properties": { + "resourceType": { + "description": "ProtectedItem Type- VM, SqlDataBase, AzureFileShare etc", + "enum": [ + "Invalid", + "VM", + "FileFolder", + "AzureSqlDb", + "SQLDB", + "Exchange", + "Sharepoint", + "VMwareVM", + "SystemState", + "Client", + "GenericDataSource", + "SQLDataBase", + "AzureFileShare", + "SAPHanaDatabase", + "SAPAseDatabase" + ], + "type": "string", + "x-ms-enum": { + "name": "DataSourceType", + "modelAsString": true + } + }, + "resourceId": { + "description": "ARM Virtual Machine Id", + "type": "string" + }, + "vaultId": { + "description": "ARM id of the Recovery Services Vault", + "type": "string" + }, + "properties": { + "description": "Configuration of VM if any needs to be validated like OS type etc", + "type": "string" + } + } + }, + "PreValidateEnableBackupResponse": { + "description": "Response contract for enable backup validation request", + "type": "object", + "properties": { + "status": { + "description": "Validation Status", + "enum": [ + "Invalid", + "Succeeded", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "ValidationStatus", + "modelAsString": true + } + }, + "errorCode": { + "description": "Response error code", + "type": "string" + }, + "errorMessage": { + "description": "Response error message", + "type": "string" + }, + "recommendation": { + "description": "Recommended action for user", + "type": "string" + }, + "containerName": { + "description": "Specifies the product specific container name. E.g. iaasvmcontainer;iaasvmcontainer;rgname;vmname. This is required\r\nfor portal", + "type": "string" + }, + "protectedItemName": { + "description": "Specifies the product specific ds name. E.g. vm;iaasvmcontainer;rgname;vmname. This is required for portal", + "type": "string" + } + } + }, + "ProtectionIntent": { + "description": "Base class for backup ProtectionIntent.", + "required": [ + "protectionIntentItemType" + ], + "type": "object", + "properties": { + "protectionIntentItemType": { + "description": "backup protectionIntent type.", + "type": "string" + }, + "backupManagementType": { + "description": "Type of backup management for the backed up item.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureBackupServer", + "AzureSql", + "AzureStorage", + "AzureWorkload", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + }, + "sourceResourceId": { + "description": "ARM ID of the resource to be backed up.", + "type": "string" + }, + "itemId": { + "description": "ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId", + "type": "string" + }, + "policyId": { + "description": "ID of the backup policy with which this item is backed up.", + "type": "string" + }, + "protectionState": { + "description": "Backup state of this backup item.", + "enum": [ + "Invalid", + "NotProtected", + "Protecting", + "Protected", + "ProtectionFailed" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectionStatus", + "modelAsString": true + } + } + }, + "discriminator": "protectionIntentItemType" + }, + "ProtectionIntentQueryObject": { + "description": "Filters to list protection intent.", + "type": "object", + "properties": { + "backupManagementType": { + "description": "Backup management type for the backed up item", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureBackupServer", + "AzureSql", + "AzureStorage", + "AzureWorkload", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + }, + "itemType": { + "description": "Type of workload this item represents", + "enum": [ + "Invalid", + "SQLInstance", + "SQLAvailabilityGroupContainer" + ], + "type": "string", + "x-ms-enum": { + "name": "IntentItemType", + "modelAsString": true + } + }, + "parentName": { + "description": "Parent name of the intent", + "type": "string" + }, + "itemName": { + "description": "Item name of the intent", + "type": "string" + } + } + }, + "ProtectionIntentResource": { + "description": "Base class for backup ProtectionIntent.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ProtectionIntent", + "description": "ProtectionIntentResource properties" + } + } + }, + "ProtectionIntentResourceList": { + "description": "List of ProtectionIntent resources", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceList" + } + ], + "properties": { + "value": { + "description": "List of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ProtectionIntentResource" + } + } + } + }, + "AzureWorkloadContainer": { + "description": "Container for the workloads running inside Azure Compute or Classic Compute.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionContainer" + } + ], + "properties": { + "sourceResourceId": { + "description": "ARM ID of the virtual machine represented by this Azure Workload Container", + "type": "string" + }, + "lastUpdatedTime": { + "format": "date-time", + "description": "Time stamp when this container was updated.", + "type": "string" + }, + "extendedInfo": { + "$ref": "#/definitions/AzureWorkloadContainerExtendedInfo", + "description": "Additional details of a workload container." + }, + "workloadType": { + "description": "Workload type for which registration was sent.", + "enum": [ + "Invalid", + "VM", + "FileFolder", + "AzureSqlDb", + "SQLDB", + "Exchange", + "Sharepoint", + "VMwareVM", + "SystemState", + "Client", + "GenericDataSource", + "SQLDataBase", + "AzureFileShare", + "SAPHanaDatabase", + "SAPAseDatabase" + ], + "type": "string", + "x-ms-enum": { + "name": "WorkloadType", + "modelAsString": true + } + }, + "operationType": { + "description": "Re-Do Operation", + "enum": [ + "Invalid", + "Register", + "Reregister" + ], + "type": "string", + "x-ms-enum": { + "name": "OperationType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "AzureWorkloadContainer" + }, + "AzureWorkloadContainerExtendedInfo": { + "description": "Extended information of the container.", + "type": "object", + "properties": { + "hostServerName": { + "description": "Host Os Name in case of Stand Alone and Cluster Name in case of distributed container.", + "type": "string" + }, + "inquiryInfo": { + "$ref": "#/definitions/InquiryInfo", + "description": "Inquiry Status for the container." + }, + "nodesList": { + "description": "List of the nodes in case of distributed container.", + "type": "array", + "items": { + "$ref": "#/definitions/DistributedNodesInfo" + } + } + } + }, + "BackupEngineBase": { + "description": "The base backup engine class. All workload specific backup engines derive from this class.", + "type": "object", + "required": [ + "backupEngineType" + ], + "properties": { + "friendlyName": { + "description": "Friendly name of the backup engine.", + "type": "string" + }, + "backupManagementType": { + "description": "Type of backup management for the backup engine.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureBackupServer", + "AzureSql", + "AzureStorage", + "AzureWorkload", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + }, + "registrationStatus": { + "description": "Registration status of the backup engine with the Recovery Services Vault.", + "type": "string" + }, + "backupEngineState": { + "description": "Status of the backup engine with the Recovery Services Vault. = {Active/Deleting/DeleteFailed}", + "type": "string" + }, + "healthStatus": { + "description": "Backup status of the backup engine.", + "type": "string" + }, + "backupEngineType": { + "description": "Type of the backup engine.", + "enum": [ + "Invalid", + "DpmBackupEngine", + "AzureBackupServerEngine" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupEngineType", + "modelAsString": true + } + }, + "canReRegister": { + "description": "Flag indicating if the backup engine be registered, once already registered.", + "type": "boolean" + }, + "backupEngineId": { + "description": "ID of the backup engine.", + "type": "string" + }, + "dpmVersion": { + "description": "Backup engine version", + "type": "string" + }, + "azureBackupAgentVersion": { + "description": "Backup agent version", + "type": "string" + }, + "isAzureBackupAgentUpgradeAvailable": { + "description": "To check if backup agent upgrade available", + "type": "boolean" + }, + "isDpmUpgradeAvailable": { + "description": "To check if backup engine upgrade available", + "type": "boolean" + }, + "extendedInfo": { + "$ref": "#/definitions/BackupEngineExtendedInfo", + "description": "Extended info of the backupengine" + } + }, + "discriminator": "backupEngineType" + }, + "BackupEngineBaseResource": { + "description": "The base backup engine class. All workload specific backup engines derive from this class.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BackupEngineBase", + "description": "BackupEngineBaseResource properties" + } + } + }, + "BackupEngineBaseResourceList": { + "description": "List of BackupEngineBase resources", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceList" + } + ], + "properties": { + "value": { + "description": "List of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/BackupEngineBaseResource" + } + } + } + }, + "BackupEngineExtendedInfo": { + "description": "Additional information on backup engine.", + "type": "object", + "properties": { + "databaseName": { + "description": "Database name of backup engine.", + "type": "string" + }, + "protectedItemsCount": { + "format": "int32", + "description": "Number of protected items in the backup engine.", + "type": "integer" + }, + "protectedServersCount": { + "format": "int32", + "description": "Number of protected servers in the backup engine.", + "type": "integer" + }, + "diskCount": { + "format": "int32", + "description": "Number of disks in the backup engine.", + "type": "integer" + }, + "usedDiskSpace": { + "format": "double", + "description": "Disk space used in the backup engine.", + "type": "number" + }, + "availableDiskSpace": { + "format": "double", + "description": "Disk space currently available in the backup engine.", + "type": "number" + }, + "refreshedAt": { + "format": "date-time", + "description": "Last refresh time in the backup engine.", + "type": "string" + }, + "azureProtectedInstances": { + "format": "int32", + "description": "Protected instances in the backup engine.", + "type": "integer" + } + } + }, + "BackupRequest": { + "description": "Base class for backup request. Workload-specific backup requests are derived from this class.", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + } + }, + "discriminator": "objectType" + }, + "BackupRequestResource": { + "description": "Base class for backup request. Workload-specific backup requests are derived from this class.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BackupRequest", + "description": "BackupRequestResource properties" + } + } + }, + "BMSBackupEngineQueryObject": { + "description": "Query parameters to fetch list of backup engines.", + "type": "object", + "properties": { + "expand": { + "description": "attribute to add extended info", + "type": "string" + } + } + }, + "BMSBackupEnginesQueryObject": { + "description": "Query parameters to fetch list of backup engines.", + "type": "object", + "properties": { + "backupManagementType": { + "description": "Backup management type for the backup engine.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureBackupServer", + "AzureSql", + "AzureStorage", + "AzureWorkload", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + }, + "friendlyName": { + "description": "Friendly name of the backup engine.", + "type": "string" + }, + "expand": { + "description": "Attribute to add extended info.", + "type": "string" + } + } + }, + "BMSContainerQueryObject": { + "description": "The query filters that can be used with the list containers API.", + "required": [ + "backupManagementType" + ], + "type": "object", + "properties": { + "backupManagementType": { + "description": "Backup management type for this container.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureBackupServer", + "AzureSql", + "AzureStorage", + "AzureWorkload", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + }, + "containerType": { + "description": "Type of container for filter", + "enum": [ + "Invalid", + "Unknown", + "IaasVMContainer", + "IaasVMServiceContainer", + "DPMContainer", + "AzureBackupServerContainer", + "MABContainer", + "Cluster", + "AzureSqlContainer", + "Windows", + "VCenter", + "VMAppContainer", + "SQLAGWorkLoadContainer", + "StorageContainer", + "GenericContainer" + ], + "type": "string", + "x-ms-enum": { + "name": "ContainerType", + "modelAsString": true + } + }, + "backupEngineName": { + "description": "Backup engine name", + "type": "string" + }, + "fabricName": { + "description": "Fabric name for filter", + "type": "string" + }, + "status": { + "description": "Status of registration of this container with the Recovery Services Vault.", + "type": "string" + }, + "friendlyName": { + "description": "Friendly name of this container.", + "type": "string" + } + } + }, + "BMSContainersInquiryQueryObject": { + "description": "The query filters that can be used with the inquire container API.", + "type": "object", + "properties": { + "backupManagementType": { + "description": "Backup management type for this container.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureBackupServer", + "AzureSql", + "AzureStorage", + "AzureWorkload", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + }, + "workloadType": { + "description": "Workload type for this container.", + "enum": [ + "Invalid", + "VM", + "FileFolder", + "AzureSqlDb", + "SQLDB", + "Exchange", + "Sharepoint", + "VMwareVM", + "SystemState", + "Client", + "GenericDataSource", + "SQLDataBase", + "AzureFileShare", + "SAPHanaDatabase", + "SAPAseDatabase" + ], + "type": "string", + "x-ms-enum": { + "name": "WorkloadType", + "modelAsString": true + } + } + } + }, + "BMSPOQueryObject": { + "description": "Filters to list items that can be backed up.", + "type": "object", + "properties": { + "backupManagementType": { + "description": "Backup management type.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureSql", + "AzureBackupServer", + "AzureWorkload", + "AzureStorage", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + }, + "workloadType": { + "description": "Workload type", + "enum": [ + "Invalid", + "VM", + "FileFolder", + "AzureSqlDb", + "SQLDB", + "Exchange", + "Sharepoint", + "VMwareVM", + "SystemState", + "Client", + "GenericDataSource", + "SQLDataBase", + "AzureFileShare", + "SAPHanaDatabase", + "SAPAseDatabase" + ], + "type": "string", + "x-ms-enum": { + "name": "WorkloadType", + "modelAsString": true + } + }, + "containerName": { + "description": "Full name of the container whose Protectable Objects should be returned.", + "type": "string" + }, + "status": { + "description": "Backup status query parameter.", + "type": "string" + }, + "friendlyName": { + "description": "Friendly name.", + "type": "string" + } + } + }, + "BMSRefreshContainersQueryObject": { + "description": "The query filters that can be used with the refresh container API.", + "type": "object", + "properties": { + "backupManagementType": { + "description": "Backup management type for this container.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureBackupServer", + "AzureSql", + "AzureStorage", + "AzureWorkload", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + } + } + }, + "BMSWorkloadItemQueryObject": { + "description": "Filters to list items that can be backed up.", + "type": "object", + "properties": { + "backupManagementType": { + "description": "Backup management type.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureSql", + "AzureBackupServer", + "AzureWorkload", + "AzureStorage", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + }, + "workloadItemType": { + "description": "Workload Item type", + "enum": [ + "Invalid", + "SQLInstance", + "SQLDataBase", + "SAPHanaSystem", + "SAPHanaDatabase", + "SAPAseSystem", + "SAPAseDatabase" + ], + "type": "string", + "x-ms-enum": { + "name": "WorkloadItemType", + "modelAsString": true + } + }, + "workloadType": { + "description": "Workload type", + "enum": [ + "Invalid", + "VM", + "FileFolder", + "AzureSqlDb", + "SQLDB", + "Exchange", + "Sharepoint", + "VMwareVM", + "SystemState", + "Client", + "GenericDataSource", + "SQLDataBase", + "AzureFileShare", + "SAPHanaDatabase", + "SAPAseDatabase" + ], + "type": "string", + "x-ms-enum": { + "name": "WorkloadType", + "modelAsString": true + } + }, + "protectionStatus": { + "description": "Backup status query parameter.", + "enum": [ + "Invalid", + "NotProtected", + "Protecting", + "Protected", + "ProtectionFailed" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectionStatus", + "modelAsString": true + } + } + } + }, + "ClientScriptForConnect": { + "description": "Client script details for file / folder restore.", + "type": "object", + "properties": { + "scriptContent": { + "description": "File content of the client script for file / folder restore.", + "type": "string" + }, + "scriptExtension": { + "description": "File extension of the client script for file / folder restore - .ps1 , .sh , etc.", + "type": "string" + }, + "osType": { + "description": "OS type - Windows, Linux etc. for which this file / folder restore client script works.", + "type": "string" + }, + "url": { + "description": "URL of Executable from where to source the content. If this is not null then ScriptContent should not be used", + "type": "string" + }, + "scriptNameSuffix": { + "description": "Mandatory suffix that should be added to the name of script that is given for download to user.\r\nIf its null or empty then , ignore it.", + "type": "string" + } + } + }, + "ContainerIdentityInfo": { + "description": "Container identity information", + "type": "object", + "properties": { + "uniqueName": { + "description": "Unique name of the container", + "type": "string" + }, + "aadTenantId": { + "description": "Protection container identity - AAD Tenant", + "type": "string" + }, + "servicePrincipalClientId": { + "description": "Protection container identity - AAD Service Principal", + "type": "string" + }, + "audience": { + "description": "Protection container identity - Audience", + "type": "string" + } + } + }, + "DistributedNodesInfo": { + "description": "This is used to represent the various nodes of the distributed container.", + "type": "object", + "properties": { + "nodeName": { + "description": "Name of the node under a distributed container.", + "type": "string" + }, + "status": { + "description": "Status of this Node.\r\nFailed | Succeeded", + "type": "string" + }, + "errorDetail": { + "$ref": "#/definitions/ErrorDetail", + "description": "Error Details if the Status is non-success." + } + } + }, + "DpmBackupEngine": { + "description": "Data Protection Manager (DPM) specific backup engine.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BackupEngineBase" + } + ], + "x-ms-discriminator-value": "DpmBackupEngine" + }, + "DpmContainer": { + "description": "DPM workload-specific protection container.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionContainer" + } + ], + "properties": { + "canReRegister": { + "description": "Specifies whether the container is re-registrable.", + "type": "boolean" + }, + "containerId": { + "description": "ID of container.", + "type": "string" + }, + "protectedItemCount": { + "format": "int64", + "description": "Number of protected items in the BackupEngine", + "type": "integer" + }, + "dpmAgentVersion": { + "description": "Backup engine Agent version", + "type": "string" + }, + "dpmServers": { + "description": "List of BackupEngines protecting the container", + "type": "array", + "items": { + "type": "string" + } + }, + "upgradeAvailable": { + "description": "To check if upgrade available", + "type": "boolean" + }, + "protectionStatus": { + "description": "Protection status of the container.", + "type": "string" + }, + "extendedInfo": { + "$ref": "#/definitions/DPMContainerExtendedInfo", + "description": "Extended Info of the container." + } + }, + "x-ms-discriminator-value": "DPMContainer" + }, + "DPMContainerExtendedInfo": { + "description": "Additional information of the DPMContainer.", + "type": "object", + "properties": { + "lastRefreshedAt": { + "format": "date-time", + "description": "Last refresh time of the DPMContainer.", + "type": "string" + } + } + }, + "GenericContainer": { + "description": "Base class for generic container of backup items", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionContainer" + } + ], + "properties": { + "fabricName": { + "description": "Name of the container's fabric", + "type": "string" + }, + "extendedInformation": { + "$ref": "#/definitions/GenericContainerExtendedInfo", + "description": "Extended information (not returned in List container API calls)" + } + }, + "x-ms-discriminator-value": "GenericContainer" + }, + "GenericContainerExtendedInfo": { + "description": "Container extended information", + "type": "object", + "properties": { + "rawCertData": { + "description": "Public key of container cert", + "type": "string" + }, + "containerIdentityInfo": { + "$ref": "#/definitions/ContainerIdentityInfo", + "description": "Container identity information" + }, + "serviceEndpoints": { + "description": "Azure Backup Service Endpoints for the container", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "IaasVMBackupRequest": { + "description": "IaaS VM workload-specific backup request.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BackupRequest" + } + ], + "properties": { + "recoveryPointExpiryTimeInUTC": { + "format": "date-time", + "description": "Backup copy will expire after the time specified (UTC).", + "type": "string" + } + }, + "x-ms-discriminator-value": "IaasVMBackupRequest" + }, + "IaaSVMContainer": { + "description": "IaaS VM workload-specific container.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionContainer" + } + ], + "properties": { + "virtualMachineId": { + "description": "Fully qualified ARM url of the virtual machine represented by this Azure IaaS VM container.", + "type": "string" + }, + "virtualMachineVersion": { + "description": "Specifies whether the container represents a Classic or an Azure Resource Manager VM.", + "type": "string" + }, + "resourceGroup": { + "description": "Resource group name of Recovery Services Vault.", + "type": "string" + } + }, + "x-ms-discriminator-value": "IaaSVMContainer" + }, + "IaasVMILRRegistrationRequest": { + "description": "Restore files/folders from a backup copy of IaaS VM.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ILRRequest" + } + ], + "properties": { + "recoveryPointId": { + "description": "ID of the IaaS VM backup copy from where the files/folders have to be restored.", + "type": "string" + }, + "virtualMachineId": { + "description": "Fully qualified ARM ID of the virtual machine whose the files / folders have to be restored.", + "type": "string" + }, + "initiatorName": { + "description": "iSCSI initiator name.", + "type": "string" + }, + "renewExistingRegistration": { + "description": "Whether to renew existing registration with the iSCSI server.", + "type": "boolean" + } + }, + "x-ms-discriminator-value": "IaasVMILRRegistrationRequest" + }, + "IaaSVMProtectableItem": { + "description": "IaaS VM workload-specific backup item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkloadProtectableItem" + } + ], + "properties": { + "virtualMachineId": { + "description": "Fully qualified ARM ID of the virtual machine.", + "type": "string" + } + }, + "x-ms-discriminator-value": "IaaSVMProtectableItem" + }, + "ILRRequest": { + "description": "Parameters to Provision ILR API.", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + } + }, + "discriminator": "objectType" + }, + "ILRRequestResource": { + "description": "Parameters to Provision ILR API.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ILRRequest", + "description": "ILRRequestResource properties" + } + } + }, + "InquiryInfo": { + "description": "Details about inquired protectable items under a given container.", + "type": "object", + "properties": { + "status": { + "description": "Inquiry Status for this container such as\r\nInProgress | Failed | Succeeded", + "type": "string" + }, + "errorDetail": { + "$ref": "#/definitions/ErrorDetail", + "description": "Error Details if the Status is non-success." + }, + "inquiryDetails": { + "description": "Inquiry Details which will have workload specific details.\r\nFor e.g. - For SQL and oracle this will contain different details.", + "type": "array", + "items": { + "$ref": "#/definitions/WorkloadInquiryDetails" + } + } + } + }, + "InquiryValidation": { + "description": "Validation for inquired protectable items under a given container.", + "type": "object", + "properties": { + "status": { + "description": "Status for the Inquiry Validation.", + "type": "string" + }, + "errorDetail": { + "$ref": "#/definitions/ErrorDetail", + "description": "Error Detail in case the status is non-success." + }, + "additionalDetail": { + "description": "Error Additional Detail in case the status is non-success.", + "type": "string", + "readOnly": true + } + } + }, + "InstantItemRecoveryTarget": { + "description": "Target details for file / folder restore.", + "type": "object", + "properties": { + "clientScripts": { + "description": "List of client scripts.", + "type": "array", + "items": { + "$ref": "#/definitions/ClientScriptForConnect" + } + } + } + }, + "MabContainer": { + "description": "Container with items backed up using MAB backup engine.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionContainer" + } + ], + "properties": { + "canReRegister": { + "description": "Can the container be registered one more time.", + "type": "boolean" + }, + "containerId": { + "format": "int64", + "description": "ContainerID represents the container.", + "type": "integer" + }, + "protectedItemCount": { + "format": "int64", + "description": "Number of items backed up in this container.", + "type": "integer" + }, + "agentVersion": { + "description": "Agent version of this container.", + "type": "string" + }, + "extendedInfo": { + "$ref": "#/definitions/MabContainerExtendedInfo", + "description": "Additional information for this container" + }, + "mabContainerHealthDetails": { + "description": "Health details on this mab container.", + "type": "array", + "items": { + "$ref": "#/definitions/MABContainerHealthDetails" + } + }, + "containerHealthState": { + "description": "Health state of mab container.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Windows" + }, + "MabContainerExtendedInfo": { + "description": "Additional information of the container.", + "type": "object", + "properties": { + "lastRefreshedAt": { + "format": "date-time", + "description": "Time stamp when this container was refreshed.", + "type": "string" + }, + "backupItemType": { + "description": "Type of backup items associated with this container.", + "enum": [ + "Invalid", + "VM", + "FileFolder", + "AzureSqlDb", + "SQLDB", + "Exchange", + "Sharepoint", + "VMwareVM", + "SystemState", + "Client", + "GenericDataSource", + "SQLDataBase", + "AzureFileShare", + "SAPHanaDatabase", + "SAPAseDatabase" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupItemType", + "modelAsString": true + } + }, + "backupItems": { + "description": "List of backup items associated with this container.", + "type": "array", + "items": { + "type": "string" + } + }, + "policyName": { + "description": "Backup policy associated with this container.", + "type": "string" + }, + "lastBackupStatus": { + "description": "Latest backup status of this container.", + "type": "string" + } + } + }, + "MABContainerHealthDetails": { + "description": "MAB workload-specific Health Details.", + "type": "object", + "properties": { + "code": { + "format": "int32", + "description": "Health Code", + "type": "integer" + }, + "title": { + "description": "Health Title", + "type": "string" + }, + "message": { + "description": "Health Message", + "type": "string" + }, + "recommendations": { + "description": "Health Recommended Actions", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "OperationStatus": { + "description": "Operation status.", + "type": "object", + "properties": { + "id": { + "description": "ID of the operation.", + "type": "string" + }, + "name": { + "description": "Name of the operation.", + "type": "string" + }, + "status": { + "description": "Operation status.", + "enum": [ + "Invalid", + "InProgress", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "x-ms-enum": { + "name": "OperationStatusValues", + "modelAsString": true + } + }, + "startTime": { + "format": "date-time", + "description": "Operation start time. Format: ISO-8601.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "Operation end time. Format: ISO-8601.", + "type": "string" + }, + "error": { + "$ref": "#/definitions/OperationStatusError", + "description": "Error information related to this operation." + }, + "properties": { + "$ref": "#/definitions/OperationStatusExtendedInfo", + "description": "Additional information associated with this operation." + } + } + }, + "OperationStatusError": { + "description": "Error information associated with operation status call.", + "type": "object", + "properties": { + "code": { + "description": "Error code of the operation failure.", + "type": "string" + }, + "message": { + "description": "Error message displayed if the operation failure.", + "type": "string" + } + } + }, + "OperationStatusExtendedInfo": { + "description": "Base class for additional information of operation status.", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + } + }, + "discriminator": "objectType" + }, + "OperationStatusJobExtendedInfo": { + "description": "Operation status job extended info.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OperationStatusExtendedInfo" + } + ], + "properties": { + "jobId": { + "description": "ID of the job created for this protected item.", + "type": "string" + } + }, + "x-ms-discriminator-value": "OperationStatusJobExtendedInfo" + }, + "OperationStatusJobsExtendedInfo": { + "description": "Operation status extended info for list of jobs.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OperationStatusExtendedInfo" + } + ], + "properties": { + "jobIds": { + "description": "IDs of the jobs created for the protected item.", + "type": "array", + "items": { + "type": "string" + } + }, + "failedJobsError": { + "description": "Stores all the failed jobs along with the corresponding error codes.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "OperationStatusJobsExtendedInfo" + }, + "OperationStatusProvisionILRExtendedInfo": { + "description": "Operation status extended info for ILR provision action.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OperationStatusExtendedInfo" + } + ], + "properties": { + "recoveryTarget": { + "$ref": "#/definitions/InstantItemRecoveryTarget", + "description": "Target details for file / folder restore." + } + }, + "x-ms-discriminator-value": "OperationStatusProvisionILRExtendedInfo" + }, + "PreBackupValidation": { + "description": "Pre-backup validation for Azure VM Workload provider.", + "type": "object", + "properties": { + "status": { + "description": "Status of protectable item, i.e. InProgress,Succeeded,Failed", + "enum": [ + "Invalid", + "Success", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "InquiryStatus", + "modelAsString": true + } + }, + "code": { + "description": "Error code of protectable item", + "type": "string" + }, + "message": { + "description": "Message corresponding to the error code for the protectable item", + "type": "string" + } + } + }, + "ProtectableContainer": { + "description": "Protectable Container Class.", + "type": "object", + "required": [ + "protectableContainerType" + ], + "properties": { + "friendlyName": { + "description": "Friendly name of the container.", + "type": "string" + }, + "backupManagementType": { + "description": "Type of backup management for the container.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureBackupServer", + "AzureSql", + "AzureStorage", + "AzureWorkload", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + }, + "protectableContainerType": { + "description": "Type of the container. The value of this property for\r\n1. Compute Azure VM is Microsoft.Compute/virtualMachines\r\n2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines", + "enum": [ + "Invalid", + "Unknown", + "IaasVMContainer", + "IaasVMServiceContainer", + "DPMContainer", + "AzureBackupServerContainer", + "MABContainer", + "Cluster", + "AzureSqlContainer", + "Windows", + "VCenter", + "VMAppContainer", + "SQLAGWorkLoadContainer", + "StorageContainer", + "GenericContainer" + ], + "type": "string", + "readOnly": false, + "x-ms-enum": { + "name": "ContainerType", + "modelAsString": false + } + }, + "healthStatus": { + "description": "Status of health of the container.", + "type": "string" + }, + "containerId": { + "description": "Fabric Id of the container such as ARM Id.", + "type": "string" + } + }, + "discriminator": "protectableContainerType" + }, + "ProtectableContainerResource": { + "description": "Protectable Container Class.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ProtectableContainer", + "description": "ProtectableContainerResource properties" + } + } + }, + "ProtectableContainerResourceList": { + "description": "List of ProtectableContainer resources", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceList" + } + ], + "properties": { + "value": { + "description": "List of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ProtectableContainerResource" + } + } + } + }, + "ProtectionContainer": { + "description": "Base class for container with backup items. Containers with specific workloads are derived from this class.", + "type": "object", + "required": [ + "containerType" + ], + "properties": { + "friendlyName": { + "description": "Friendly name of the container.", + "type": "string" + }, + "backupManagementType": { + "description": "Type of backup management for the container.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureBackupServer", + "AzureSql", + "AzureStorage", + "AzureWorkload", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + }, + "registrationStatus": { + "description": "Status of registration of the container with the Recovery Services Vault.", + "type": "string" + }, + "healthStatus": { + "description": "Status of health of the container.", + "type": "string" + }, + "containerType": { + "description": "Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2.\r\nClassic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is\r\nWindows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload\r\nBackup is VMAppContainer", + "enum": [ + "Invalid", + "Unknown", + "IaasVMContainer", + "IaasVMServiceContainer", + "DPMContainer", + "AzureBackupServerContainer", + "MABContainer", + "Cluster", + "AzureSqlContainer", + "Windows", + "VCenter", + "VMAppContainer", + "SQLAGWorkLoadContainer", + "StorageContainer", + "GenericContainer" + ], + "type": "string", + "x-ms-enum": { + "name": "ContainerType", + "modelAsString": true + } + } + }, + "discriminator": "containerType" + }, + "ProtectionContainerResource": { + "description": "Base class for container with backup items. Containers with specific workloads are derived from this class.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ProtectionContainer", + "description": "ProtectionContainerResource properties" + } + } + }, + "ProtectionContainerResourceList": { + "description": "List of ProtectionContainer resources", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceList" + } + ], + "properties": { + "value": { + "description": "List of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ProtectionContainerResource" + } + } + } + }, + "TokenInformation": { + "description": "The token information details.", + "type": "object", + "properties": { + "token": { + "description": "Token value.", + "type": "string" + }, + "expiryTimeInUtcTicks": { + "format": "int64", + "description": "Expiry time of token.", + "type": "integer" + }, + "securityPIN": { + "description": "Security PIN", + "type": "string" + } + } + }, + "WorkloadInquiryDetails": { + "description": "Details of an inquired protectable item.", + "type": "object", + "properties": { + "type": { + "description": "Type of the Workload such as SQL, Oracle etc.", + "type": "string" + }, + "itemCount": { + "format": "int64", + "description": "Contains the protectable item Count inside this Container.", + "type": "integer" + }, + "inquiryValidation": { + "$ref": "#/definitions/InquiryValidation", + "description": "Inquiry validation such as permissions and other backup validations." + } + } + }, + "WorkloadItem": { + "description": "Base class for backup item. Workload-specific backup items are derived from this class.", + "type": "object", + "required": [ + "workloadItemType" + ], + "properties": { + "backupManagementType": { + "description": "Type of backup management to backup an item.", + "type": "string" + }, + "workloadType": { + "description": "Type of workload for the backup management", + "type": "string" + }, + "workloadItemType": { + "description": "Type of the backup item.", + "type": "string" + }, + "friendlyName": { + "description": "Friendly name of the backup item.", + "type": "string" + }, + "protectionState": { + "description": "State of the back up item.", + "enum": [ + "Invalid", + "NotProtected", + "Protecting", + "Protected", + "ProtectionFailed" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectionStatus", + "modelAsString": true + } + } + }, + "discriminator": "workloadItemType" + }, + "WorkloadItemResource": { + "description": "Base class for backup item. Workload-specific backup items are derived from this class.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/WorkloadItem", + "description": "WorkloadItemResource properties" + } + } + }, + "WorkloadItemResourceList": { + "description": "List of WorkloadItem resources", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceList" + } + ], + "properties": { + "value": { + "description": "List of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/WorkloadItemResource" + } + } + } + }, + "WorkloadProtectableItem": { + "description": "Base class for backup item. Workload-specific backup items are derived from this class.", + "type": "object", + "required": [ + "protectableItemType" + ], + "properties": { + "backupManagementType": { + "description": "Type of backup management to backup an item.", + "type": "string" + }, + "workloadType": { + "description": "Type of workload for the backup management", + "type": "string" + }, + "protectableItemType": { + "description": "Type of the backup item.", + "type": "string" + }, + "friendlyName": { + "description": "Friendly name of the backup item.", + "type": "string" + }, + "protectionState": { + "description": "State of the back up item.", + "enum": [ + "Invalid", + "NotProtected", + "Protecting", + "Protected", + "ProtectionFailed" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectionStatus", + "modelAsString": true + } + } + }, + "discriminator": "protectableItemType" + }, + "WorkloadProtectableItemResource": { + "description": "Base class for backup item. Workload-specific backup items are derived from this class.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/WorkloadProtectableItem", + "description": "WorkloadProtectableItemResource properties" + } + } + }, + "WorkloadProtectableItemResourceList": { + "description": "List of WorkloadProtectableItem resources", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceList" + } + ], + "properties": { + "value": { + "description": "List of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/WorkloadProtectableItemResource" + } + } + } + }, + "AzureWorkloadSAPHanaPointInTimeRestoreWithRehydrateRequest": { + "description": "AzureWorkload SAP Hana-specific restore with integrated rehydration of recovery point.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadSAPHanaPointInTimeRestoreRequest" + } + ], + "properties": { + "recoveryPointRehydrationInfo": { + "$ref": "#/definitions/RecoveryPointRehydrationInfo", + "description": "RP Rehydration Info" + } + }, + "x-ms-discriminator-value": "AzureWorkloadSAPHanaPointInTimeRestoreWithRehydrateRequest" + }, + "AzureWorkloadSAPHanaRestoreWithRehydrateRequest": { + "description": "AzureWorkload SAP Hana-specific restore with integrated rehydration of recovery point.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadSAPHanaRestoreRequest" + } + ], + "properties": { + "recoveryPointRehydrationInfo": { + "$ref": "#/definitions/RecoveryPointRehydrationInfo", + "description": "RP Rehydration Info" + } + }, + "x-ms-discriminator-value": "AzureWorkloadSAPHanaRestoreWithRehydrateRequest" + }, + "AzureWorkloadSQLPointInTimeRestoreWithRehydrateRequest": { + "description": "AzureWorkload SQL-specific restore with integrated rehydration of recovery point.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadSQLPointInTimeRestoreRequest" + } + ], + "properties": { + "recoveryPointRehydrationInfo": { + "$ref": "#/definitions/RecoveryPointRehydrationInfo", + "description": "RP Rehydration Info" + } + }, + "x-ms-discriminator-value": "AzureWorkloadSQLPointInTimeRestoreWithRehydrateRequest" + }, + "AzureWorkloadSQLRestoreWithRehydrateRequest": { + "description": "AzureWorkload SQL-specific restore with integrated rehydration of recovery point", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadSQLRestoreRequest" + } + ], + "properties": { + "recoveryPointRehydrationInfo": { + "$ref": "#/definitions/RecoveryPointRehydrationInfo", + "description": "RP Rehydration Info" + } + }, + "x-ms-discriminator-value": "AzureWorkloadSQLRestoreWithRehydrateRequest" + }, + "IaasVMRestoreWithRehydrationRequest": { + "description": "IaaS VM workload-specific restore with integrated rehydration of recovery point.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IaasVMRestoreRequest" + } + ], + "properties": { + "recoveryPointRehydrationInfo": { + "$ref": "#/definitions/RecoveryPointRehydrationInfo", + "description": "RP Rehydration Info" + } + }, + "x-ms-discriminator-value": "IaasVMRestoreWithRehydrationRequest" + }, + "MoveRPAcrossTiersRequest": { + "type": "object", + "properties": { + "objectType": { + "description": "Gets the class type.", + "type": "string" + }, + "sourceTierType": { + "description": "Source tier from where RP needs to be moved", + "enum": [ + "Invalid", + "InstantRP", + "HardenedRP", + "ArchivedRP" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPointTierType", + "modelAsString": false + } + }, + "targetTierType": { + "description": "Target tier where RP needs to be moved", + "enum": [ + "Invalid", + "InstantRP", + "HardenedRP", + "ArchivedRP" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPointTierType", + "modelAsString": false + } + } + } + }, + "RecoveryPointMoveReadinessInfo": { + "type": "object", + "properties": { + "isReadyForMove": { + "type": "boolean" + }, + "additionalInfo": { + "type": "string" + } + } + }, + "RecoveryPointRehydrationInfo": { + "description": "RP Rehydration Info", + "type": "object", + "properties": { + "rehydrationRetentionDuration": { + "description": "How long the rehydrated RP should be kept\r\nShould be ISO8601 Duration format e.g. \"P7D\"", + "type": "string" + }, + "rehydrationPriority": { + "description": "Rehydration Priority", + "enum": [ + "Standard", + "High" + ], + "type": "string", + "x-ms-enum": { + "name": "RehydrationPriority", + "modelAsString": true + } + } + } + }, + "ListRecoveryPointsRecommendedForMoveRequest": { + "description": "ListRecoveryPointsRecommendedForMoveRequest Request", + "type": "object", + "properties": { + "objectType": { + "description": "Gets the class type.", + "type": "string" + }, + "excludedRPList": { + "description": "List of Recovery Points excluded from Move", + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription Id.", + "required": true, + "type": "string" + }, + "AzureRegion": { + "name": "azureRegion", + "in": "path", + "description": "Azure region to hit Api", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group where the recovery services vault is present.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VaultName": { + "name": "vaultName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account." + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/BackupFeature_Validate.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/BackupFeature_Validate.json new file mode 100644 index 000000000000..3bdfd47d8cc7 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/BackupFeature_Validate.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "azureRegion": "southeastasia", + "api-version": "2021-06-01", + "parameters": { + "featureType": "AzureVMResourceBackup", + "vmSize": "Basic_A0", + "vmSku": "Premium" + } + }, + "responses": { + "200": { + "body": { + "supportStatus": "DefaultOFF" + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/BackupPolicies_List.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/BackupPolicies_List.json new file mode 100644 index 000000000000..266c00dd3771 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/BackupPolicies_List.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "api-version": "2021-06-01", + "$filter": "backupManagementType eq 'AzureIaasVM'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/DefaultPolicy", + "name": "DefaultPolicy", + "type": "Microsoft.RecoveryServices/vaults/backupPolicies", + "properties": { + "backupManagementType": "AzureIaasVM", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Daily", + "scheduleRunTimes": [ + "2017-12-05T19:00:00Z" + ], + "scheduleWeeklyFrequency": 0 + }, + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "dailySchedule": { + "retentionTimes": [ + "2017-12-05T19:00:00Z" + ], + "retentionDuration": { + "count": 30, + "durationType": "Days" + } + } + }, + "protectedItemsCount": 0 + } + }, + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1", + "name": "testPolicy1", + "type": "Microsoft.RecoveryServices/vaults/backupPolicies", + "properties": { + "backupManagementType": "AzureIaasVM", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Daily", + "scheduleRunTimes": [ + "2018-01-24T02:00:00Z" + ], + "scheduleWeeklyFrequency": 0 + }, + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "dailySchedule": { + "retentionTimes": [ + "2018-01-24T02:00:00Z" + ], + "retentionDuration": { + "count": 1, + "durationType": "Days" + } + } + }, + "timeZone": "Pacific Standard Time", + "protectedItemsCount": 0 + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/BackupProtectableItems_List.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/BackupProtectableItems_List.json new file mode 100644 index 000000000000..3ad6a7722182 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/BackupProtectableItems_List.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "api-version": "2021-06-01", + "$filter": "backupManagementType eq 'AzureIaasVM'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/protectionContainers/IaasVMContainer;iaasvmcontainer;iaasvm-rg;iaasvm-1/protectableItems/VM;iaasvmcontainer;iaasvm-rg;iaasvm-1", + "name": "VM;iaasvmcontainer;iaasvm-rg;iaasvm-1", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectableItems", + "properties": { + "friendlyName": "iaasvm-1", + "virtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/providers/Microsoft.ClassicCompute/virtualMachines/iaasvm-1", + "protectionState": "NotProtected", + "protectableItemType": "Microsoft.ClassicCompute/virtualMachines", + "backupManagementType": "AzureIaasVM", + "workloadType": "VM" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/BackupProtectedItems_List.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/BackupProtectedItems_List.json new file mode 100644 index 000000000000..cdcbbd6d9bc3 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/BackupProtectedItems_List.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "api-version": "2021-06-01", + "$filter": "backupManagementType eq 'AzureIaasVM' and itemType eq 'VM'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/protectionContainers/IaasVMContainer;iaasvmcontainer;iaasvm-rg;iaasvm-1/protectedItems/VM;iaasvmcontainer;iaasvm-rg;iaasvm-1", + "name": "VM;iaasvmcontainer;iaasvm-rg;iaasvm-1", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems", + "properties": { + "friendlyName": "iaasvm-1", + "virtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/providers/Microsoft.ClassicCompute/virtualMachines/iaasvm-1", + "protectionStatus": "Healthy", + "protectionState": "Protected", + "healthStatus": "Passed", + "lastBackupStatus": "Completed", + "lastBackupTime": "2018-01-22T12:25:32.048723Z", + "protectedItemDataId": "636482643132986882", + "protectedItemType": "Microsoft.ClassicCompute/virtualMachines", + "backupManagementType": "AzureIaasVM", + "workloadType": "VM", + "containerName": "iaasvmcontainer;iaasvm-rg;iaasvm-1", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/providers/Microsoft.ClassicCompute/virtualMachines/iaasvm-1", + "policyId": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1", + "lastRecoveryPoint": "2017-11-22T12:25:32.048723Z" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ClassicCompute_ProtectedItem_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ClassicCompute_ProtectedItem_Get.json new file mode 100644 index 000000000000..5d22a1213d1e --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ClassicCompute_ProtectedItem_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "PythonSDKBackupTestRg", + "vaultName": "PySDKBackupTestRsVault", + "fabricName": "Azure", + "containerName": "iaasvmcontainer;iaasvmcontainer;iaasvm-rg;iaasvm-1", + "protectedItemName": "vm;iaasvmcontainer;iaasvm-rg;iaasvm-1", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainer;iaasvm-rg;iaasvm-1/protectedItems/VM;iaasvmcontainer;iaasvm-rg;iaasvm-1", + "name": "VM;iaasvmcontainer;iaasvm-rg;iaasvm-1", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems", + "properties": { + "friendlyName": "iaasvm-1", + "virtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/providers/Microsoft.ClassicCompute/virtualMachines/iaasvm-1", + "protectionStatus": "Healthy", + "protectionState": "Protected", + "healthStatus": "Passed", + "lastBackupStatus": "Completed", + "lastBackupTime": "2018-01-22T12:25:32.048723Z", + "protectedItemDataId": "636482643132986882", + "protectedItemType": "Microsoft.ClassicCompute/virtualMachines", + "backupManagementType": "AzureIaasVM", + "workloadType": "VM", + "containerName": "iaasvmcontainer;iaasvm-rg;iaasvm-1", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/providers/Microsoft.ClassicCompute/virtualMachines/iaasvm-1", + "policyId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupPolicies/testPolicy1", + "lastRecoveryPoint": "2017-11-22T12:25:32.048723Z" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/Compute_ProtectedItem_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/Compute_ProtectedItem_Get.json new file mode 100644 index 000000000000..7cd7d05e1f4f --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/Compute_ProtectedItem_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "PythonSDKBackupTestRg", + "vaultName": "PySDKBackupTestRsVault", + "fabricName": "Azure", + "containerName": "iaasvmcontainer;iaasvmcontainerv2;iaasvm-rg;iaasvm-1", + "protectedItemName": "vm;iaasvmcontainerv2;iaasvm-rg;iaasvm-1", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;iaasvm-rg;iaasvm-1/protectedItems/VM;iaasvmcontainerv2;iaasvm-rg;iaasvm-1", + "name": "VM;iaasvmcontainerv2;iaasvm-rg;iaasvm-1", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems", + "properties": { + "friendlyName": "iaasvm-1", + "virtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/providers/Microsoft.Compute/virtualMachines/iaasvm-1", + "protectionStatus": "Healthy", + "protectionState": "Protected", + "healthStatus": "Passed", + "lastBackupStatus": "Completed", + "lastBackupTime": "2018-01-22T12:25:32.048723Z", + "protectedItemDataId": "636482643132986882", + "protectedItemType": "Microsoft.Compute/virtualMachines", + "backupManagementType": "AzureIaasVM", + "workloadType": "VM", + "containerName": "iaasvmcontainerv2;iaasvm-rg;iaasvm-1", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/providers/Microsoft.Compute/virtualMachines/iaasvm-1", + "policyId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupPolicies/testPolicy1", + "lastRecoveryPoint": "2017-11-22T12:25:32.048723Z" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ConfigureProtection.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ConfigureProtection.json new file mode 100644 index 000000000000..9f50f006dce6 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ConfigureProtection.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "protectedItemName": "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "protectedItemType": "Microsoft.Compute/virtualMachines", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "policyId": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/DefaultPolicy" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Retry-After": 60 + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "name": "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems", + "properties": { + "friendlyName": "netvmtestv2vm1", + "virtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "protectionStatus": "Healthy", + "protectionState": "Protected", + "healthStatus": "Passed", + "lastBackupStatus": "Completed", + "lastBackupTime": "2018-01-22T12:25:32.048723Z", + "protectedItemDataId": "636482643132986882", + "protectedItemType": "Microsoft.Compute/virtualMachines", + "backupManagementType": "AzureIaasVM", + "workloadType": "VM", + "containerName": "iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "policyId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupPolicies/testPolicy1", + "lastRecoveryPoint": null + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/GetBackupStatus.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/GetBackupStatus.json new file mode 100644 index 000000000000..d89525f6f2a8 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/GetBackupStatus.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "azureRegion": "southeastasia", + "api-version": "2021-06-01", + "parameters": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Compute/VirtualMachines/testVm", + "resourceType": "VM" + } + }, + "responses": { + "200": { + "body": { + "protectionStatus": "Protected", + "vaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.RecoveryServices/Vaults/testVault", + "fabricName": "Azure", + "containerName": "iaasvmcontainer;iaasvmcontainerv2;testRg;testVm", + "protectedItemName": "vm;iaasvmcontainerv2;testRg;testVm", + "policyName": "myPolicy", + "errorCode": "Success", + "errorMessage": "ErrorMessage" + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ProtectedItemOperationResults.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ProtectedItemOperationResults.json new file mode 100644 index 000000000000..10ac3793e12f --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ProtectedItemOperationResults.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "protectedItemName": "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Retry-After": 60 + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "name": "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems", + "properties": { + "friendlyName": "netvmtestv2vm1", + "virtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "protectionStatus": "Healthy", + "protectionState": "Protected", + "healthStatus": "Passed", + "lastBackupStatus": "Completed", + "lastBackupTime": "2018-01-22T12:25:32.048723Z", + "protectedItemDataId": "636482643132986882", + "protectedItemType": "Microsoft.Compute/virtualMachines", + "backupManagementType": "AzureIaasVM", + "workloadType": "VM", + "containerName": "iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "policyId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupPolicies/testPolicy1", + "lastRecoveryPoint": null + } + } + }, + "204": {} + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ProtectedItemOperationStatus.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ProtectedItemOperationStatus.json new file mode 100644 index 000000000000..650d1b47519c --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ProtectedItemOperationStatus.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "protectedItemName": "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "status": "Succeeded", + "startTime": "2017-10-29T06:04:18.207325Z", + "endTime": "2017-10-29T06:04:18.207325Z", + "properties": { + "objectType": "OperationStatusJobExtendedInfo", + "jobId": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ProtectionIntent_CreateOrUpdate.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ProtectionIntent_CreateOrUpdate.json new file mode 100644 index 000000000000..613fef0ac47a --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ProtectionIntent_CreateOrUpdate.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myRG", + "vaultName": "myVault", + "fabricName": "Azure", + "intentObjectName": "vm;iaasvmcontainerv2;chamsrgtest;chamscandel", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/chamsrgtest/providers/Microsoft.Compute/virtualMachines/chamscandel", + "protectionIntentItemType": "AzureResourceItem", + "policyId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupPolicies/myPolicy" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupFabrics/Azure/backupProtectionIntent/vm;iaasvmcontainerv2;chamsrgtest;chamscandel", + "name": "vm;iaasvmcontainerv2;chamsrgtest;chamscandel", + "type": "Microsoft.RecoveryServices/vaults/backupProtectionIntent", + "properties": { + "backupManagementType": "AzureIaasVM", + "policyId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupPolicies/myPolicy", + "protectionState": "Protected" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ProtectionIntent_Validate.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ProtectionIntent_Validate.json new file mode 100644 index 000000000000..2df0a972de02 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ProtectionIntent_Validate.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "azureRegion": "southeastasia", + "api-version": "2021-06-01", + "parameters": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/arunaupgrade/providers/Microsoft.Compute/VirtualMachines/upgrade1", + "resourceType": "VM", + "vaultId": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.RecoveryServices/Vaults/myVault", + "properties": "" + } + }, + "responses": { + "200": { + "body": { + "status": "Failed", + "errorCode": "VirtualMachineAlreadyProtected", + "errorMessage": "Virtual machine with same name and same resource group is already protected. Please select `Disable' choice above for backup and go to backup item corresponding to this VM in the vault", + "recommendation": "Please do not enable protection again.", + "containerName": "iaasvmcontainer;iaasvmcontainerv2;arunaupgrade;upgrade1", + "protectedItemName": "vm;iaasvmcontainerv2;arunaupgrade;upgrade1" + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ProtectionPolicies_CreateOrUpdate_Complex.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ProtectionPolicies_CreateOrUpdate_Complex.json new file mode 100644 index 000000000000..af53a45a75b5 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ProtectionPolicies_CreateOrUpdate_Complex.json @@ -0,0 +1,181 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "policyName": "testPolicy1", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "backupManagementType": "AzureIaasVM", + "timeZone": "Pacific Standard Time", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Weekly", + "scheduleRunTimes": [ + "2018-01-24T10:00:00Z" + ], + "scheduleRunDays": [ + "Monday", + "Wednesday", + "Thursday" + ] + }, + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "weeklySchedule": { + "daysOfTheWeek": [ + "Monday", + "Wednesday", + "Thursday" + ], + "retentionTimes": [ + "2018-01-24T10:00:00Z" + ], + "retentionDuration": { + "count": 1, + "durationType": "Weeks" + } + }, + "monthlySchedule": { + "retentionScheduleFormatType": "Weekly", + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Wednesday", + "Thursday" + ], + "weeksOfTheMonth": [ + "First", + "Third" + ] + }, + "retentionTimes": [ + "2018-01-24T10:00:00Z" + ], + "retentionDuration": { + "count": 2, + "durationType": "Months" + } + }, + "yearlySchedule": { + "retentionScheduleFormatType": "Weekly", + "monthsOfYear": [ + "February", + "November" + ], + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Monday", + "Thursday" + ], + "weeksOfTheMonth": [ + "Fourth" + ] + }, + "retentionTimes": [ + "2018-01-24T10:00:00Z" + ], + "retentionDuration": { + "count": 4, + "durationType": "Years" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1", + "name": "testPolicy1", + "type": "Microsoft.RecoveryServices/vaults/backupPolicies", + "properties": { + "backupManagementType": "AzureIaasVM", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Weekly", + "scheduleRunDays": [ + "Monday", + "Wednesday", + "Thursday" + ], + "scheduleRunTimes": [ + "2018-01-24T10:00:00Z" + ], + "scheduleWeeklyFrequency": 0 + }, + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "weeklySchedule": { + "daysOfTheWeek": [ + "Monday", + "Wednesday", + "Thursday" + ], + "retentionTimes": [ + "2018-01-24T10:00:00Z" + ], + "retentionDuration": { + "count": 1, + "durationType": "Weeks" + } + }, + "monthlySchedule": { + "retentionScheduleFormatType": "Weekly", + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Wednesday", + "Thursday" + ], + "weeksOfTheMonth": [ + "First", + "Third" + ] + }, + "retentionTimes": [ + "2018-01-24T10:00:00Z" + ], + "retentionDuration": { + "count": 2, + "durationType": "Months" + } + }, + "yearlySchedule": { + "retentionScheduleFormatType": "Weekly", + "monthsOfYear": [ + "February", + "November" + ], + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Monday", + "Thursday" + ], + "weeksOfTheMonth": [ + "Fourth" + ] + }, + "retentionTimes": [ + "2018-01-24T10:00:00Z" + ], + "retentionDuration": { + "count": 4, + "durationType": "Years" + } + } + }, + "timeZone": "Pacific Standard Time", + "protectedItemsCount": 0 + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-06-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1/operations/00000000-0000-0000-0000-000000000000?api-version=2016-06-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ProtectionPolicies_CreateOrUpdate_Simple.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ProtectionPolicies_CreateOrUpdate_Simple.json new file mode 100644 index 000000000000..3b3bd09151a1 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ProtectionPolicies_CreateOrUpdate_Simple.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "policyName": "testPolicy1", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "backupManagementType": "AzureIaasVM", + "timeZone": "Pacific Standard Time", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Daily", + "scheduleRunTimes": [ + "2018-01-24T02:00:00Z" + ] + }, + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "dailySchedule": { + "retentionTimes": [ + "2018-01-24T02:00:00Z" + ], + "retentionDuration": { + "count": 1, + "durationType": "Days" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1", + "name": "testPolicy1", + "type": "Microsoft.RecoveryServices/vaults/backupPolicies", + "properties": { + "backupManagementType": "AzureIaasVM", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Daily", + "scheduleRunTimes": [ + "2018-01-24T02:00:00Z" + ], + "scheduleWeeklyFrequency": 0 + }, + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "dailySchedule": { + "retentionTimes": [ + "2018-01-24T02:00:00Z" + ], + "retentionDuration": { + "count": 1, + "durationType": "Days" + } + } + }, + "timeZone": "Pacific Standard Time", + "protectedItemsCount": 0 + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-06-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1/operations/00000000-0000-0000-0000-000000000000?api-version=2016-06-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ProtectionPolicies_Delete.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ProtectionPolicies_Delete.json new file mode 100644 index 000000000000..46859835a833 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ProtectionPolicies_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "policyName": "testPolicy1", + "api-version": "2021-06-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ProtectionPolicies_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ProtectionPolicies_Get.json new file mode 100644 index 000000000000..ca47282a6120 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ProtectionPolicies_Get.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "policyName": "testPolicy1", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1", + "name": "testPolicy1", + "type": "Microsoft.RecoveryServices/vaults/backupPolicies", + "properties": { + "backupManagementType": "AzureIaasVM", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Daily", + "scheduleRunTimes": [ + "2018-01-24T02:00:00Z" + ], + "scheduleWeeklyFrequency": 0 + }, + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "dailySchedule": { + "retentionTimes": [ + "2018-01-24T02:00:00Z" + ], + "retentionDuration": { + "count": 1, + "durationType": "Days" + } + } + }, + "timeZone": "Pacific Standard Time", + "protectedItemsCount": 0 + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ProtectionPolicyOperationResults_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ProtectionPolicyOperationResults_Get.json new file mode 100644 index 000000000000..c80ba9cfb14c --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ProtectionPolicyOperationResults_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "policyName": "testPolicy1", + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1", + "name": "testPolicy1", + "type": "Microsoft.RecoveryServices/vaults/backupPolicies", + "properties": { + "backupManagementType": "AzureIaasVM", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Daily", + "scheduleRunTimes": [ + "2018-01-24T02:00:00Z" + ], + "scheduleWeeklyFrequency": 0 + }, + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "dailySchedule": { + "retentionTimes": [ + "2018-01-24T02:00:00Z" + ], + "retentionDuration": { + "count": 1, + "durationType": "Days" + } + } + }, + "timeZone": "Pacific Standard Time", + "protectedItemsCount": 1 + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ProtectionPolicyOperationStatuses_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ProtectionPolicyOperationStatuses_Get.json new file mode 100644 index 000000000000..7e88678052fb --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ProtectionPolicyOperationStatuses_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "policyName": "testPolicy1", + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "id": "00000000-0000-0000-0000-000000000000", + "name": "GetProtectionPolicyOperationStatus", + "status": "Succeeded", + "startTime": "2018-01-24T12:57:32.1142968Z", + "endTime": "2018-01-24T12:57:32.1142968Z", + "properties": { + "objectType": "OperationStatusJobsExtendedInfo", + "jobIds": [ + "00000000-0000-0000-0000-000000000000" + ], + "failedJobsError": {} + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/Provision_Ilr.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/Provision_Ilr.json new file mode 100644 index 000000000000..6af7dbac4276 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/Provision_Ilr.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "PythonSDKBackupTestRg", + "vaultName": "PySDKBackupTestRsVault", + "fabricName": "Azure", + "containerName": "iaasvmcontainer;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1", + "protectedItemName": "vm;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1", + "recoveryPointId": "1", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "initiatorName": "Hello World", + "recoveryPointId": "38823086363464", + "renewExistingRegistration": true, + "virtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/pysdktestrg/providers/Microsoft.Compute/virtualMachines/pysdktestv2vm1", + "objectType": "IaasVMILRRegistrationRequest" + } + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1/protectedItems/vm;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1/protectedItems/vm;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/RecoveryPointsRecommendedForMove_List.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/RecoveryPointsRecommendedForMove_List.json new file mode 100644 index 000000000000..ca259ad90d42 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/RecoveryPointsRecommendedForMove_List.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rshhtestmdvmrg", + "vaultName": "rshvault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall", + "protectedItemName": "VM;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall", + "api-version": "2021-06-01", + "parameters": { + "objectType": "ListRecoveryPointsRecommendedForMoveRequest", + "excludedRPList": [ + "348916168024334", + "348916168024335" + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rshhtestmdvmrg/providers/Microsoft.RecoveryServices/vaults/rshvault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall/protectedItems/VM;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall/recoveryPoints/22244821112382", + "name": "22244821112382", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints", + "properties": { + "objectType": "IaasVMRecoveryPoint", + "recoveryPointType": "CrashConsistent", + "recoveryPointTime": "2017-12-21T22:48:25.4353958Z", + "recoveryPointAdditionalInfo": "", + "sourceVMStorageType": "NormalStorage", + "isSourceVMEncrypted": false, + "isInstantIlrSessionActive": false, + "recoveryPointTierDetails": [ + { + "type": "InstantRP", + "status": "Deleted" + }, + { + "type": "HardenedRP", + "status": "Valid" + } + ], + "recoveryPointMoveReadinessInfo": { + "ArchivedRP": { + "isReadyForMove": true + } + }, + "isManagedVirtualMachine": true, + "virtualMachineSize": "Standard_D1", + "originalStorageAccountOption": false + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rshhtestmdvmrg/providers/Microsoft.RecoveryServices/vaults/rshvault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall/protectedItems/VM;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall/recoveryPoints/24977149827250", + "name": "24977149827250", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints", + "properties": { + "objectType": "IaasVMRecoveryPoint", + "recoveryPointType": "CrashConsistent", + "recoveryPointTime": "2017-12-20T22:49:44.3317945Z", + "recoveryPointAdditionalInfo": "", + "sourceVMStorageType": "NormalStorage", + "isSourceVMEncrypted": false, + "isInstantIlrSessionActive": false, + "recoveryPointTierDetails": [ + { + "type": "InstantRP", + "status": "Deleted" + }, + { + "type": "HardenedRP", + "status": "Deleted" + }, + { + "type": "ArchivedRP", + "status": "Rehydrated", + "extendedInfo": { + "RehydratedRPExpiryTime": "2020-12-21T22:48:25.4353958Z" + } + } + ], + "recoveryPointMoveReadinessInfo": { + "ArchivedRP": { + "isReadyForMove": true + } + }, + "isManagedVirtualMachine": true, + "virtualMachineSize": "Standard_D1", + "originalStorageAccountOption": false, + "zones": [ + "1" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/RecoveryPoints_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/RecoveryPoints_Get.json new file mode 100644 index 000000000000..86636ebefbb7 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/RecoveryPoints_Get.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rshhtestmdvmrg", + "vaultName": "rshvault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall", + "protectedItemName": "VM;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall", + "recoveryPointId": "26083826328862", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rshhtestmdvmrg/providers/Microsoft.RecoveryServices/vaults/rshvault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall/protectedItems/VM;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall/recoveryPoints/26083826328862", + "name": "26083826328862", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints", + "properties": { + "objectType": "IaasVMRecoveryPoint", + "recoveryPointType": "CrashConsistent", + "recoveryPointTime": "2017-11-22T22:32:46.6088472Z", + "recoveryPointAdditionalInfo": "", + "sourceVMStorageType": "NormalStorage", + "isSourceVMEncrypted": false, + "isInstantIlrSessionActive": false, + "recoveryPointTierDetails": [ + { + "type": "HardenedRP", + "status": "Valid" + } + ], + "recoveryPointMoveReadinessInfo": { + "ArchivedRP": { + "isReadyForMove": true + } + }, + "isManagedVirtualMachine": true, + "virtualMachineSize": "Standard_D1", + "originalStorageAccountOption": false, + "zones": [ + "1" + ] + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/RecoveryPoints_List.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/RecoveryPoints_List.json new file mode 100644 index 000000000000..1f38a6167d36 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/RecoveryPoints_List.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rshhtestmdvmrg", + "vaultName": "rshvault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall", + "protectedItemName": "VM;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rshhtestmdvmrg/providers/Microsoft.RecoveryServices/vaults/rshvault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall/protectedItems/VM;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall/recoveryPoints/22244821112382", + "name": "22244821112382", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints", + "properties": { + "objectType": "IaasVMRecoveryPoint", + "recoveryPointType": "CrashConsistent", + "recoveryPointTime": "2017-12-21T22:48:25.4353958Z", + "recoveryPointAdditionalInfo": "", + "sourceVMStorageType": "NormalStorage", + "isSourceVMEncrypted": false, + "isInstantIlrSessionActive": false, + "recoveryPointTierDetails": [ + { + "type": "InstantRP", + "status": "Deleted" + }, + { + "type": "HardenedRP", + "status": "Valid" + } + ], + "recoveryPointMoveReadinessInfo": { + "Archive": { + "isReadyForMove": true + } + }, + "isManagedVirtualMachine": true, + "virtualMachineSize": "Standard_D1", + "originalStorageAccountOption": false + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rshhtestmdvmrg/providers/Microsoft.RecoveryServices/vaults/rshvault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall/protectedItems/VM;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall/recoveryPoints/24977149827250", + "name": "24977149827250", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints", + "properties": { + "objectType": "IaasVMRecoveryPoint", + "recoveryPointType": "CrashConsistent", + "recoveryPointTime": "2017-12-20T22:49:44.3317945Z", + "recoveryPointAdditionalInfo": "", + "sourceVMStorageType": "NormalStorage", + "isSourceVMEncrypted": false, + "isInstantIlrSessionActive": false, + "recoveryPointTierDetails": [ + { + "type": "InstantRP", + "status": "Deleted" + }, + { + "type": "HardenedRP", + "status": "Deleted" + }, + { + "type": "ArchivedRP", + "status": "Rehydrated", + "extendedInfo": { + "RehydratedRPExpiryTime": "2020-12-21T22:48:25.4353958Z" + } + } + ], + "recoveryPointMoveReadinessInfo": { + "ArchivedRP": { + "isReadyForMove": false, + "additionalInfo": "Recovery point cannot be moved to archive tier since it has already been moved." + } + }, + "isManagedVirtualMachine": true, + "virtualMachineSize": "Standard_D1", + "originalStorageAccountOption": false, + "zones": [ + "1" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/Revoke_Ilr.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/Revoke_Ilr.json new file mode 100644 index 000000000000..1d4ddbbb0b4d --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/Revoke_Ilr.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "PythonSDKBackupTestRg", + "vaultName": "PySDKBackupTestRsVault", + "fabricName": "Azure", + "containerName": "iaasvmcontainer;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1", + "protectedItemName": "vm;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1", + "recoveryPointId": "1", + "api-version": "2021-06-01" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1/protectedItems/vm;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1/protectedItems/vm;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/StopProtection.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/StopProtection.json new file mode 100644 index 000000000000..82ec474f3d9a --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/StopProtection.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "protectedItemName": "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "protectedItemType": "Microsoft.Compute/virtualMachines", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "protectionState": "ProtectionStopped" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Retry-After": 60 + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "name": "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems", + "properties": { + "friendlyName": "netvmtestv2vm1", + "virtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "protectionStatus": "Healthy", + "protectionState": "ProtectionStopped", + "healthStatus": "Passed", + "lastBackupStatus": "Completed", + "lastBackupTime": "2018-01-22T12:25:32.048723Z", + "protectedItemDataId": "636482643132986882", + "protectedItemType": "Microsoft.Compute/virtualMachines", + "backupManagementType": "AzureIaasVM", + "workloadType": "VM", + "containerName": "iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "policyId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupPolicies/testPolicy1", + "lastRecoveryPoint": null + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest.json new file mode 100644 index 000000000000..1967977829aa --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "netsdktestrg", + "vaultName": "testVault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "protectedItemName": "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "recoveryPointId": "348916168024334", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "objectType": "IaasVMRestoreRequest", + "recoveryPointId": "348916168024334", + "recoveryType": "AlternateLocation", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "targetVirtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435", + "targetResourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2", + "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount", + "virtualNetworkId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default", + "region": "southeastasia", + "createNewCloudService": false, + "originalStorageAccountOption": false, + "encryptionDetails": { + "encryptionEnabled": false + }, + "identityInfo": { + "isSystemAssignedIdentity": true + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2017-07-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2017-07-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreWithRehydrationRequest.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreWithRehydrationRequest.json new file mode 100644 index 000000000000..6a1e84792ee9 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreWithRehydrationRequest.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "netsdktestrg", + "vaultName": "testVault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "protectedItemName": "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "recoveryPointId": "348916168024334", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "objectType": "IaasVMRestoreWithRehydrationRequest", + "recoveryPointId": "348916168024334", + "recoveryType": "AlternateLocation", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "targetVirtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435", + "targetResourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2", + "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount", + "virtualNetworkId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default", + "region": "southeastasia", + "createNewCloudService": false, + "originalStorageAccountOption": false, + "encryptionDetails": { + "encryptionEnabled": false + }, + "recoveryPointRehydrationInfo": { + "rehydrationRetentionDuration": "P7D", + "rehydrationPriority": "High" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2017-07-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2017-07-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreRequest.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreRequest.json new file mode 100644 index 000000000000..7cf0eccb90cb --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreRequest.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "netsdktestrg", + "vaultName": "testVault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "protectedItemName": "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "recoveryPointId": "348916168024334", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "objectType": "IaasVMRestoreRequest", + "recoveryPointId": "348916168024334", + "recoveryType": "RestoreDisks", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount", + "region": "southeastasia", + "createNewCloudService": true, + "originalStorageAccountOption": false, + "encryptionDetails": { + "encryptionEnabled": false + }, + "identityInfo": { + "isSystemAssignedIdentity": false, + "managedIdentityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/asmaskarRG1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/asmaskartestmsi" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2020-09-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2020-09-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreWithRehydrationRequest.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreWithRehydrationRequest.json new file mode 100644 index 000000000000..75875eac1b25 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreWithRehydrationRequest.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "netsdktestrg", + "vaultName": "testVault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "protectedItemName": "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "recoveryPointId": "348916168024334", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "objectType": "IaasVMRestoreWithRehydrationRequest", + "recoveryPointId": "348916168024334", + "recoveryType": "RestoreDisks", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount", + "region": "southeastasia", + "createNewCloudService": true, + "originalStorageAccountOption": false, + "encryptionDetails": { + "encryptionEnabled": false + }, + "recoveryPointRehydrationInfo": { + "rehydrationRetentionDuration": "P7D", + "rehydrationPriority": "Standard" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2020-09-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2020-09-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ValidateOperation_RestoreDisk.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ValidateOperation_RestoreDisk.json new file mode 100644 index 000000000000..c68a5bfc1b03 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureIaasVm/ValidateOperation_RestoreDisk.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testRG", + "vaultName": "testVault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;testRG;testvmName", + "protectedItemName": "VM;iaasvmcontainerv2;testRG;testvmName", + "recoveryPointId": "348916168024334", + "api-version": "2021-06-01", + "parameters": { + "objectType": "ValidateIaasVMRestoreOperationRequest", + "restoreRequest": { + "recoveryPointId": "348916168024334", + "objectType": "IaasVMRestoreRequest", + "recoveryType": "RestoreDisks", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount", + "region": "southeastasia", + "createNewCloudService": true, + "originalStorageAccountOption": false, + "encryptionDetails": { + "encryptionEnabled": false + }, + "identityInfo": { + "isSystemAssignedIdentity": false, + "managedIdentityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/asmaskarRG1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/asmaskartestmsi" + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "validateOperationResponse": { + "validationResults": [ + { + "code": "UserErrorCoreCountSubscriptionQuotaReached", + "message": "Core Count subscription quota has been reached.", + "recommendations": [ + "Contact Azure support to increase the limits." + ] + } + ] + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureStorage/ProtectableContainers_List.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureStorage/ProtectableContainers_List.json new file mode 100644 index 000000000000..a64e6db51826 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureStorage/ProtectableContainers_List.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testRg", + "vaultName": "testvault", + "fabricName": "Azure", + "api-version": "2021-06-01", + "$filter": "backupManagementType eq 'AzureStorage' and workloadType eq 'AzureFileShare'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.RecoveryServices/vaults/testvault/backupFabrics/Azure/protectableContainers/StorageContainer;storage;test-rg;teststorage", + "name": "StorageContainer;storage;test-rg;testst", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectableContainers", + "properties": { + "friendlyName": "teststorage", + "backupManagementType": "AzureStorage", + "protectableContainerType": "StorageContainer", + "healthStatus": "Healthy", + "containerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/teststorage" + } + }, + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.RecoveryServices/vaults/testvault/backupFabrics/Azure/protectableContainers/StorageContainer;ClassicStorage;test-rg;teststorage", + "name": "StorageContainer;ClassicStorage;test-rg;teststorage", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectableContainers", + "properties": { + "friendlyName": "teststorage", + "backupManagementType": "AzureStorage", + "protectableContainerType": "StorageContainer", + "healthStatus": "Healthy", + "containerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ClassicStorage/storageAccounts/teststorage" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureStorage/ProtectionContainers_Inquire.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureStorage/ProtectionContainers_Inquire.json new file mode 100644 index 000000000000..9cd2c9ccb305 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureStorage/ProtectionContainers_Inquire.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "vaultName": "testvault", + "fabricName": "Azure", + "containerName": "storagecontainer;Storage;test-rg;teststorage", + "api-version": "2021-06-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.RecoveryServices/vaults/testvault/backupFabrics/Azure/protectionContainers/storagecontainer;Storage;test-rg;teststorage/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.RecoveryServices/vaults/testvault/backupFabrics/Azure/protectionContainers/storagecontainer;Storage;test-rg;teststorage/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureStorage/ProtectionContainers_Inquire_Result.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureStorage/ProtectionContainers_Inquire_Result.json new file mode 100644 index 000000000000..92e6e587858c --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureStorage/ProtectionContainers_Inquire_Result.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "vaultName": "testvault", + "fabricName": "Azure", + "containerName": "VMAppContainer;Compute;testRG;testSQL", + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.RecoveryServices/vaults/testvault/backupFabrics/Azure/protectionContainers/VMAppContainer;Compute;testRG;testSQL/operationResults/00000000-0000-0000-0000-000000000000?api-version=2017-07-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.RecoveryServices/vaults/testvault/backupFabrics/Azure/protectionContainers/VMAppContainer;Compute;testRG;testSQL/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2017-07-01", + "Retry-After": 60 + } + }, + "200": { + "body": { + "name": "VMAppContainer;Compute;testRG;testSQL", + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/VMAppContainer;Compute;testRG;testSQL", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers", + "properties": { + "extendedInfo": { + "hostServerName": "testsql", + "nodesList": [], + "inquiryInfo": { + "status": "Success", + "errorDetail": { + "code": "Success", + "message": "Not Available", + "recommendations": [ + "Not Available" + ] + }, + "inquiryDetails": [ + { + "type": "sql", + "itemCount": 14, + "inquiryValidation": { + "status": "Success", + "errorDetail": { + "code": "Success", + "message": "Not Available", + "recommendations": [ + "Not Available" + ] + } + } + } + ] + } + }, + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Compute/virtualMachines/testSQL", + "backupManagementType": "AzureWorkload", + "workloadType": null, + "containerType": "VMAppContainer", + "friendlyName": "testSQL" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureStorage/ProtectionContainers_List.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureStorage/ProtectionContainers_List.json new file mode 100644 index 000000000000..778aeedc7aea --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureStorage/ProtectionContainers_List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testRg", + "vaultName": "testVault", + "api-version": "2021-06-01", + "fabricName": "Azure", + "$filter": "backupManagementType eq 'AzureWorkload'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/172424a4-d65f-421e-a8de-197d98aabeba/resourcegroups/testrg/providers/microsoft.recoveryservices/vaults/suchandr-test-vault-wcus/backupFabrics/Azure/protectionContainers/StorageContainer;Storage;testrg;suchandrtestsa125", + "name": "StorageContainer;Storage;testrg;suchandrtestsa125", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers", + "properties": { + "sourceResourceId": "/subscriptions/172424a4-d65f-421e-a8de-197d98aabeba/resourceGroups/testrg/providers/Microsoft.Storage/storageAccounts/suchandrtestsa125", + "protectedItemCount": 2, + "friendlyName": "suchandrtestsa125", + "backupManagementType": "AzureStorage", + "registrationStatus": "Registered", + "healthStatus": "Healthy", + "containerType": "StorageContainer" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureStorage/ProtectionContainers_Register.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureStorage/ProtectionContainers_Register.json new file mode 100644 index 000000000000..1beb924059bb --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureStorage/ProtectionContainers_Register.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "vaultName": "testvault", + "fabricName": "Azure", + "containerName": "VMAppContainer;Compute;testRG;testSQL", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "friendlyName": "testSQL", + "backupManagementType": "AzureWorkload", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Compute/virtualMachines/testSQL", + "containerType": "VMAppContainer" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.RecoveryServices/vaults/testvault/backupFabrics/Azure/protectionContainers/VMAppContainer;Compute;testRG;testSQL/operationResults/00000000-0000-0000-0000-000000000000?api-version=2017-07-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.RecoveryServices/vaults/testvault/backupFabrics/Azure/protectionContainers/VMAppContainer;Compute;testRG;testSQL/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2017-07-01", + "Retry-After": 60 + } + }, + "200": { + "body": { + "name": "VMAppContainer;Compute;testRG;testSQL", + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/VMAppContainer;Compute;testRG;testSQL", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers", + "properties": { + "extendedInfo": { + "hostServerName": "testsql", + "nodesList": [], + "inquiryInfo": { + "status": "Success", + "errorDetail": { + "code": "Success", + "message": "Not Available", + "recommendations": [ + "Not Available" + ] + }, + "inquiryDetails": [ + { + "type": "sql", + "itemCount": 14, + "inquiryValidation": { + "status": "Success", + "errorDetail": { + "code": "Success", + "message": "Not Available", + "recommendations": [ + "Not Available" + ] + } + } + } + ] + } + }, + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Compute/virtualMachines/testSQL", + "backupManagementType": "AzureWorkload", + "workloadType": null, + "containerType": "VMAppContainer", + "friendlyName": "testSQL" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureWorkload/BackupPolicies_List.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureWorkload/BackupPolicies_List.json new file mode 100644 index 000000000000..c7aa5cd30ab4 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureWorkload/BackupPolicies_List.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "api-version": "2021-06-01", + "$filter": "backupManagementType eq 'AzureWorkload'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/HourlyLogBackup", + "name": "HourlyLogBackup", + "type": "Microsoft.RecoveryServices/vaults/backupPolicies", + "properties": { + "backupManagementType": "AzureWorkload", + "workLoadType": "SQLDataBase", + "settings": { + "timeZone": "UTC", + "issqlcompression": false + }, + "subProtectionPolicy": [ + { + "policyType": "Full", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Daily", + "scheduleRunTimes": [ + "2017-12-05T19:00:00Z" + ], + "scheduleWeeklyFrequency": 0 + }, + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "dailySchedule": { + "retentionTimes": [ + "2017-12-05T19:00:00Z" + ], + "retentionDuration": { + "count": 30, + "durationType": "Days" + } + } + } + }, + { + "policyType": "Log", + "schedulePolicy": { + "schedulePolicyType": "LogSchedulePolicy", + "scheduleFrequencyInMins": 60 + }, + "retentionPolicy": { + "retentionPolicyType": "SimpleRetentionPolicy", + "retentionDuration": { + "count": 30, + "durationType": "Days" + } + } + } + ], + "protectedItemsCount": 0 + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureWorkload/BackupProtectionIntent_Delete.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureWorkload/BackupProtectionIntent_Delete.json new file mode 100644 index 000000000000..50570a66e421 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureWorkload/BackupProtectionIntent_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myRG", + "vaultName": "myVault", + "fabricName": "Azure", + "intentObjectName": "249D9B07-D2EF-4202-AA64-65F35418564E", + "api-version": "2021-06-01", + "parameters": {} + }, + "responses": { + "204": {} + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureWorkload/BackupProtectionIntent_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureWorkload/BackupProtectionIntent_Get.json new file mode 100644 index 000000000000..69bc861b022f --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureWorkload/BackupProtectionIntent_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myRG", + "vaultName": "myVault", + "fabricName": "Azure", + "intentObjectName": "249D9B07-D2EF-4202-AA64-65F35418564E", + "api-version": "2021-06-01", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupFabrics/Azure/backupProtectionIntent/249D9B07-D2EF-4202-AA64-65F35418564E", + "name": "249D9B07-D2EF-4202-AA64-65F35418564E", + "type": "Microsoft.RecoveryServices/vaults/backupProtectionIntent", + "properties": { + "backupManagementType": "AzureWorkload", + "policyId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupPolicies/myPolicy", + "itemId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupProtectionContainer/VMAppContainer;Compute;testVmName/backupProtectableItems/SQLInstance;MSSQLSERVER" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureWorkload/BackupProtectionIntent_List.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureWorkload/BackupProtectionIntent_List.json new file mode 100644 index 000000000000..66dca5a7ef68 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureWorkload/BackupProtectionIntent_List.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myRG", + "vaultName": "myVault", + "api-version": "2021-06-01", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupFabrics/Azure/backupProtectionIntent/249D9B07-D2EF-4202-AA64-65F35418564E", + "name": "249D9B07-D2EF-4202-AA64-65F35418564E", + "type": "Microsoft.RecoveryServices/vaults/backupProtectionIntent", + "properties": { + "backupManagementType": "AzureWorkload", + "policyId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupPolicies/myPolicy", + "itemId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupProtectionContainer/VMAppContainer;Compute;testVmName/backupProtectableItems/SQLInstance;MSSQLSERVER" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureWorkload/BackupWorkloadItems_List.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureWorkload/BackupWorkloadItems_List.json new file mode 100644 index 000000000000..3b28eded83b8 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureWorkload/BackupWorkloadItems_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testRg", + "vaultName": "suchandr-seacan-rsv", + "api-version": "2021-06-01", + "$filter": "backupManagementType eq 'AzureWorkload'", + "fabricName": "Azure", + "containerName": "VMAppContainer;Compute;bvtdtestag;sqlserver-1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/testRg/providers/Microsoft.RecoveryServices/vaults/suchandr-seacan-rsv/backupFabrics/Azure/protectionContainers/VMAppContainer;Compute;bvtdtestag;sqlserver-1/protectableItems/SQLInstance;MSSQLSERVER", + "name": "SQLInstance;MSSQLSERVER", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/items", + "properties": { + "dataDirectoryPaths": [ + { + "type": "Data", + "path": "F:\\DATA\\" + }, + { + "type": "Log", + "path": "F:\\LOG\\" + } + ], + "parentName": "MSSQLSERVER", + "serverName": "sqlserver-1.contoso.com", + "isAutoProtectable": true, + "subinquireditemcount": 0, + "subWorkloadItemCount": 3, + "backupManagementType": "AzureWorkload", + "workloadType": "SQL", + "workloadItemType": "SQLInstance", + "friendlyName": "MSSQLSERVER", + "protectionState": "NotProtected" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureWorkload/ProtectionContainers_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureWorkload/ProtectionContainers_Get.json new file mode 100644 index 000000000000..6fc87431eff0 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureWorkload/ProtectionContainers_Get.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testRg", + "vaultName": "testVault", + "fabricName": "Azure", + "containerName": "VMAppContainer;Compute;testRG;testSQL", + "api-version": "2021-06-01", + "$filter": "backupManagementType eq 'AzureWorkload'" + }, + "responses": { + "200": { + "body": { + "name": "VMAppContainer;Compute;testRG;testSQL", + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/VMAppContainer;Compute;testRG;testSQL", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers", + "properties": { + "extendedInfo": { + "hostServerName": "testsql", + "nodesList": [], + "inquiryInfo": { + "status": "Success", + "errorDetail": { + "code": "Success", + "message": "Not Available", + "recommendations": [ + "Not Available" + ] + }, + "inquiryDetails": [ + { + "type": "sql", + "itemCount": 14, + "inquiryValidation": { + "status": "Success", + "errorDetail": { + "code": "Success", + "message": "Not Available", + "recommendations": [ + "Not Available" + ] + } + } + } + ] + } + }, + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Compute/virtualMachines/testSQL", + "backupManagementType": "AzureWorkload", + "workloadType": null, + "containerType": "VMAppContainer", + "friendlyName": "testSQL" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureWorkload/ProtectionContainers_Unregister.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureWorkload/ProtectionContainers_Unregister.json new file mode 100644 index 000000000000..59af6855c070 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureWorkload/ProtectionContainers_Unregister.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testRg", + "vaultName": "testVault", + "api-version": "2021-06-01", + "fabricName": "Azure", + "containerName": "storagecontainer;Storage;test-rg;teststorage" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.RecoveryServices/vaults/testvault/backupFabrics/Azure/protectionContainers/storagecontainer;Storage;test-rg;teststorage/operationResults/00000000-0000-0000-0000-000000000000?api-version=2017-07-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.RecoveryServices/vaults/testvault/backupFabrics/Azure/protectionContainers/storagecontainer;Storage;test-rg;teststorage/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2017-07-01", + "Retry-After": 60 + } + }, + "204": {} + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureWorkload/ProtectionPolicies_CreateOrUpdate_Complex.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureWorkload/ProtectionPolicies_CreateOrUpdate_Complex.json new file mode 100644 index 000000000000..a5863e2da10c --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/AzureWorkload/ProtectionPolicies_CreateOrUpdate_Complex.json @@ -0,0 +1,260 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "policyName": "testPolicy1", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "backupManagementType": "AzureWorkload", + "workLoadType": "SQLDataBase", + "settings": { + "timeZone": "Pacific Standard Time", + "issqlcompression": false + }, + "subProtectionPolicy": [ + { + "policyType": "Full", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Weekly", + "scheduleRunTimes": [ + "2018-01-24T10:00:00Z" + ], + "scheduleRunDays": [ + "Sunday", + "Tuesday" + ] + }, + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "weeklySchedule": { + "daysOfTheWeek": [ + "Sunday", + "Tuesday" + ], + "retentionTimes": [ + "2018-01-24T10:00:00Z" + ], + "retentionDuration": { + "count": 2, + "durationType": "Weeks" + } + }, + "monthlySchedule": { + "retentionScheduleFormatType": "Weekly", + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Sunday" + ], + "weeksOfTheMonth": [ + "Second" + ] + }, + "retentionTimes": [ + "2018-01-24T10:00:00Z" + ], + "retentionDuration": { + "count": 1, + "durationType": "Months" + } + }, + "yearlySchedule": { + "retentionScheduleFormatType": "Weekly", + "monthsOfYear": [ + "January", + "June", + "December" + ], + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Sunday" + ], + "weeksOfTheMonth": [ + "Last" + ] + }, + "retentionTimes": [ + "2018-01-24T10:00:00Z" + ], + "retentionDuration": { + "count": 1, + "durationType": "Years" + } + } + } + }, + { + "policyType": "Differential", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Weekly", + "scheduleRunTimes": [ + "2018-01-24T10:00:00Z" + ], + "scheduleRunDays": [ + "Friday" + ] + }, + "retentionPolicy": { + "retentionPolicyType": "SimpleRetentionPolicy", + "retentionDuration": { + "count": 8, + "durationType": "Days" + } + } + }, + { + "policyType": "Log", + "schedulePolicy": { + "schedulePolicyType": "LogSchedulePolicy", + "scheduleFrequencyInMins": 60 + }, + "retentionPolicy": { + "retentionPolicyType": "SimpleRetentionPolicy", + "retentionDuration": { + "count": 7, + "durationType": "Days" + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1", + "name": "testPolicy1", + "type": "Microsoft.RecoveryServices/vaults/backupPolicies", + "properties": { + "backupManagementType": "AzureWorkload", + "workLoadType": "SQLDataBase", + "settings": { + "timeZone": "Pacific Standard Time", + "issqlcompression": false + }, + "subProtectionPolicy": [ + { + "policyType": "Full", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Weekly", + "scheduleRunDays": [ + "Sunday", + "Tuesday" + ], + "scheduleRunTimes": [ + "2018-01-24T10:00:00Z" + ], + "scheduleWeeklyFrequency": 0 + }, + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "weeklySchedule": { + "daysOfTheWeek": [ + "Sunday", + "Tuesday" + ], + "retentionTimes": [ + "2018-01-24T10:00:00Z" + ], + "retentionDuration": { + "count": 2, + "durationType": "Weeks" + } + }, + "monthlySchedule": { + "retentionScheduleFormatType": "Weekly", + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Sunday" + ], + "weeksOfTheMonth": [ + "Second" + ] + }, + "retentionTimes": [ + "2018-01-24T10:00:00Z" + ], + "retentionDuration": { + "count": 1, + "durationType": "Months" + } + }, + "yearlySchedule": { + "retentionScheduleFormatType": "Weekly", + "monthsOfYear": [ + "January", + "June", + "December" + ], + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Sunday" + ], + "weeksOfTheMonth": [ + "Last" + ] + }, + "retentionTimes": [ + "2018-01-24T10:00:00Z" + ], + "retentionDuration": { + "count": 1, + "durationType": "Years" + } + } + } + }, + { + "policyType": "Differential", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Weekly", + "scheduleRunDays": [ + "Friday" + ], + "scheduleRunTimes": [ + "2018-01-24T10:00:00Z" + ], + "scheduleWeeklyFrequency": 0 + }, + "retentionPolicy": { + "retentionPolicyType": "SimpleRetentionPolicy", + "retentionDuration": { + "count": 8, + "durationType": "Days" + } + } + }, + { + "policyType": "Log", + "schedulePolicy": { + "schedulePolicyType": "LogSchedulePolicy", + "scheduleFrequencyInMins": 60 + }, + "retentionPolicy": { + "retentionPolicyType": "SimpleRetentionPolicy", + "retentionDuration": { + "count": 7, + "durationType": "Days" + } + } + } + ], + "protectedItemsCount": 0 + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-06-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1/operations/00000000-0000-0000-0000-000000000000?api-version=2016-06-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/BackupDataMove/BackupDataMoveOperationStatus_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/BackupDataMove/BackupDataMoveOperationStatus_Get.json new file mode 100644 index 000000000000..ca5e9971614f --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/BackupDataMove/BackupDataMoveOperationStatus_Get.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sourceRG", + "vaultName": "source-rsv", + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "id": "0f48183b-0a44-4dca-aec1-bba5daab888a", + "name": "0f48183b-0a44-4dca-aec1-bba5daab888a", + "status": "Succeeded", + "startTime": "2020-02-27T11:59:47.5901592Z", + "endTime": "2020-02-27T11:59:47.5901592Z" + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/BackupDataMove/PrepareDataMoveOperationResult_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/BackupDataMove/PrepareDataMoveOperationResult_Get.json new file mode 100644 index 000000000000..3c6c0fdc958a --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/BackupDataMove/PrepareDataMoveOperationResult_Get.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sourceRG", + "vaultName": "source-rsv", + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sourceRG/providers/Microsoft.RecoveryServices/vaults/source-rsv/backupStorageConfig/vaultStorageConfig/operationResult/00000000-0000-0000-0000-000000000000?api-version=2020-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sourceRG/providers/Microsoft.RecoveryServices/vaults/source-rsv/backupStorageConfig/vaultStorageConfig/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2020-07-01-preview", + "Retry-After": 60 + } + }, + "200": { + "body": { + "objectType": "" + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/BackupDataMove/PrepareDataMove_Post.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/BackupDataMove/PrepareDataMove_Post.json new file mode 100644 index 000000000000..9cb0a5e30dc2 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/BackupDataMove/PrepareDataMove_Post.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sourceRG", + "vaultName": "source-rsv", + "api-version": "2021-06-01", + "parameters": { + "targetResourceId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/targetRG/providers/Microsoft.RecoveryServices/vaults/target-rsv", + "targetRegion": "USGov Virginia", + "dataMoveLevel": "Vault" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sourceRG/providers/Microsoft.RecoveryServices/vaults/source-rsv/backupStorageConfig/vaultStorageConfig/prepareDataMove/operationResult/00000000-0000-0000-0000-000000000000?api-version=2020-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sourceRG/providers/Microsoft.RecoveryServices/vaults/source-rsv/backupStorageConfig/vaultStorageConfig/backupDataMove/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2020-07-01-preview", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/BackupDataMove/TriggerDataMove_Post.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/BackupDataMove/TriggerDataMove_Post.json new file mode 100644 index 000000000000..fa52fbf04f3c --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/BackupDataMove/TriggerDataMove_Post.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "targetRG", + "vaultName": "target-rsv", + "api-version": "2021-06-01", + "parameters": { + "sourceResourceId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/sourceRG/providers/Microsoft.RecoveryServices/vaults/source-rsv", + "sourceRegion": "USGov Iowa", + "dataMoveLevel": "Vault", + "correlationId": "MTg2OTcyMzM4NzYyMjc1NDY3Nzs1YmUzYmVmNi04YjJiLTRhOTItOTllYi01NTM0MDllYjk2NjE=" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sourceRG/providers/Microsoft.RecoveryServices/vaults/source-rsv/backupStorageConfig/vaultStorageConfig/backupDataMove/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2020-07-01-preview", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/BackupResourceEncryptionConfig_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/BackupResourceEncryptionConfig_Get.json new file mode 100644 index 000000000000..ff74c97baaf0 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/BackupResourceEncryptionConfig_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rishgrp", + "vaultName": "rishTestVault", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rishgrp/providers/Microsoft.RecoveryServicesBVTD2/vaults/rishTestVault/backupEncryptionConfigs/backupResourceEncryptionConfig", + "name": "backupResourceEncryptionConfig", + "type": "Microsoft.RecoveryServices/vaults/backupEncryptionConfigs", + "properties": { + "userAssignedIdentity": "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi", + "useSystemAssignedIdentity": false, + "encryptionAtRestType": "CustomerManaged", + "keyUri": "https://gktestkv1.vault.azure.net/keys/Test1/ed2e8cdc7f86477ebf0c6462b504a9ed", + "subscriptionId": "1a2311d9-66f5-47d3-a9fb-7a37da63934b", + "lastUpdateStatus": "Succeeded", + "infrastructureEncryptionState": "Disabled" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/BackupResourceEncryptionConfig_Put.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/BackupResourceEncryptionConfig_Put.json new file mode 100644 index 000000000000..30a36fe07867 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/BackupResourceEncryptionConfig_Put.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "vaultName": "source-rsv", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "encryptionAtRestType": "CustomerManaged", + "keyUri": "https://gktestkv1.vault.azure.net/keys/Test1/ed2e8cdc7f86477ebf0c6462b504a9ed", + "subscriptionId": "1a2311d9-66f5-47d3-a9fb-7a37da63934b", + "infrastructureEncryptionState": "true" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/BackupProtectedItem_UsageSummary_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/BackupProtectedItem_UsageSummary_Get.json new file mode 100644 index 000000000000..0e4ea98cb016 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/BackupProtectedItem_UsageSummary_Get.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testRG", + "vaultName": "testVault", + "api-version": "2021-06-01", + "$filter": "type eq 'BackupProtectedItemCountSummary'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 7, + "limit": -1, + "name": { + "value": "AzureIaasVM", + "localizedValue": "Azure Virtual Machine" + } + }, + { + "unit": "Count", + "currentValue": 3, + "limit": -1, + "name": { + "value": "MAB", + "localizedValue": "Azure Backup Agent" + } + }, + { + "unit": "Count", + "currentValue": 1, + "limit": -1, + "name": { + "value": "AzureBackupServer", + "localizedValue": "Azure Backup Server" + } + }, + { + "unit": "Count", + "currentValue": 2, + "limit": -1, + "name": { + "value": "AzureStorage", + "localizedValue": "Azure Storage (Azure Files)" + } + }, + { + "unit": "Count", + "currentValue": 2, + "limit": -1, + "name": { + "value": "AzureWorkload", + "localizedValue": "SQL in Azure VM" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/BackupProtectionContainers_UsageSummary_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/BackupProtectionContainers_UsageSummary_Get.json new file mode 100644 index 000000000000..d8ca7373183e --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/BackupProtectionContainers_UsageSummary_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testRG", + "vaultName": "testVault", + "api-version": "2021-06-01", + "$filter": "type eq 'BackupProtectionContainerCountSummary'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 2, + "limit": -1, + "name": { + "value": "AzureBackupServer", + "localizedValue": "Azure Backup Server" + } + }, + { + "unit": "Count", + "currentValue": 3, + "limit": -1, + "name": { + "value": "MAB", + "localizedValue": "Azure Backup Agent" + } + }, + { + "unit": "Count", + "currentValue": 1, + "limit": -1, + "name": { + "value": "AzureWorkload", + "localizedValue": "SQL in Azure VM" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/BackupResourceVaultConfigs_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/BackupResourceVaultConfigs_Get.json new file mode 100644 index 000000000000..b5619f5dd52b --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/BackupResourceVaultConfigs_Get.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "SwaggerTest", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/SwaggerTest/backupconfig/vaultconfig", + "name": "vaultconfig", + "type": "Microsoft.RecoveryServices/vaults/backupconfig", + "properties": { + "enhancedSecurityState": "Enabled" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/BackupResourceVaultConfigs_Patch.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/BackupResourceVaultConfigs_Patch.json new file mode 100644 index 000000000000..10c3604e332e --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/BackupResourceVaultConfigs_Patch.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "SwaggerTest", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "enhancedSecurityState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/SwaggerTest/backupconfig/vaultconfig", + "name": "vaultconfig", + "type": "Microsoft.RecoveryServices/vaults/backupconfig", + "properties": { + "enhancedSecurityState": "Enabled" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/BackupResourceVaultConfigs_Put.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/BackupResourceVaultConfigs_Put.json new file mode 100644 index 000000000000..a385d0b238d9 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/BackupResourceVaultConfigs_Put.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "SwaggerTest", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "enhancedSecurityState": "Enabled", + "softDeleteFeatureState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/SwaggerTest/backupconfig/vaultconfig", + "name": "vaultconfig", + "type": "Microsoft.RecoveryServices/vaults/backupconfig", + "properties": { + "enhancedSecurityState": "Enabled", + "softDeleteFeatureState": "Enabled" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/BackupSecurityPin_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/BackupSecurityPin_Get.json new file mode 100644 index 000000000000..1a417938c05c --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/BackupSecurityPin_Get.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "SwaggerTest", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "token": "200432", + "expiryTimeInUtcTicks": 636495150137443121, + "securityPIN": "200432" + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/CancelJobOperationResult.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/CancelJobOperationResult.json new file mode 100644 index 000000000000..961f53ff4696 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/CancelJobOperationResult.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "jobName": "00000000-0000-0000-0000-000000000000", + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01" + }, + "responses": { + "204": {}, + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/00000000-0000-0000-0000-000000000000/operationResults/00000000-0000-0000-0000-000000000000?api-version=2017-07-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/ExportJobsOperationResult.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/ExportJobsOperationResult.json new file mode 100644 index 000000000000..1aec652aaf3a --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/ExportJobsOperationResult.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "operation": { + "objectType": "ExportJobsOperationResultInfo", + "blobUrl": "https://azureblob.blob.core.windows.net/reportcontainer/exportjobsreportc00000000-0000-0000-0000-000000000000", + "blobSasKey": "?sv=2014-02-14&sr=b&sig=&st=2017-11-29T07%3A53%3A34Z&se=2017-11-29T08%3A03%3A34Z&sp=r" + }, + "headers": {} + } + }, + "202": { + "headers": { + "Retry-After": 60, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/operationResults/00000000-0000-0000-0000-000000000000?api-version=2017-07-01" + }, + "body": { + "operation": { + "objectType": "ExportJobsOperationResultInfo" + }, + "headers": { + "Location": [ + "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/operationResults/00000000-0000-0000-0000-000000000000?api-version=2017-07-01" + ], + "Retry-After": [ + "60" + ] + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/GetJobDetails.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/GetJobDetails.json new file mode 100644 index 000000000000..4da249a37516 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/GetJobDetails.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "jobName": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.RecoveryServices/vaults/backupJobs", + "properties": { + "jobType": "AzureIaaSVMJob", + "duration": "PT9.8782791S", + "virtualMachineVersion": "Compute", + "extendedInfo": { + "tasksList": [ + { + "taskId": "Take Snapshot", + "duration": "PT0S", + "status": "InProgress" + }, + { + "taskId": "Transfer data to vault", + "duration": "PT0S", + "status": "NotStarted" + } + ], + "propertyBag": { + "VM Name": "testvm" + } + }, + "entityFriendlyName": "testvm", + "backupManagementType": "AzureIaasVM", + "operation": "Backup", + "status": "InProgress", + "startTime": "2017-08-03T05:31:07.014604Z", + "activityId": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/ListJobs.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/ListJobs.json new file mode 100644 index 000000000000..bcf90ca0c6cd --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/ListJobs.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.RecoveryServices/vaults/backupJobs", + "properties": { + "jobType": "AzureIaaSVMJob", + "duration": "PT12.4272909S", + "virtualMachineVersion": "Compute", + "entityFriendlyName": "testvm", + "backupManagementType": "AzureIaasVM", + "operation": "Backup", + "status": "InProgress", + "startTime": "2017-08-03T05:31:07.014604Z", + "activityId": "00000000-0000-0000-0000-000000000000" + } + }, + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.RecoveryServices/vaults/backupJobs", + "properties": { + "jobType": "AzureIaaSVMJob", + "duration": "PT31.3066291S", + "virtualMachineVersion": "Compute", + "entityFriendlyName": "testvm", + "backupManagementType": "AzureIaasVM", + "operation": "ConfigureBackup", + "status": "Completed", + "startTime": "2017-08-03T05:30:32.4487085Z", + "endTime": "2017-08-03T05:31:03.7553376Z", + "activityId": "00000000-0000-0000-0000-000000000000" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/ListJobsWithAllSupportedFilters.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/ListJobsWithAllSupportedFilters.json new file mode 100644 index 000000000000..e63441bc8139 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/ListJobsWithAllSupportedFilters.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "api-version": "2021-06-01", + "$filter": "startTime eq '2016-01-01 00:00:00 AM' and endTime eq '2017-11-29 00:00:00 AM' and operation eq 'Backup' and backupManagementType eq 'AzureIaasVM' and status eq 'InProgress'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.RecoveryServices/vaults/backupJobs", + "properties": { + "jobType": "AzureIaaSVMJob", + "duration": "PT12.4272909S", + "virtualMachineVersion": "Compute", + "entityFriendlyName": "testvm", + "backupManagementType": "AzureIaasVM", + "operation": "Backup", + "status": "InProgress", + "startTime": "2017-08-03T05:31:07.014604Z", + "activityId": "00000000-0000-0000-0000-000000000000" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/ListJobsWithStartTimeAndEndTimeFilters.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/ListJobsWithStartTimeAndEndTimeFilters.json new file mode 100644 index 000000000000..2cb6f1952ac5 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/ListJobsWithStartTimeAndEndTimeFilters.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "api-version": "2021-06-01", + "$filter": "startTime eq '2016-01-01 00:00:00 AM' and endTime eq '2017-11-29 00:00:00 AM'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.RecoveryServices/vaults/backupJobs", + "properties": { + "jobType": "AzureIaaSVMJob", + "duration": "PT12.4272909S", + "virtualMachineVersion": "Compute", + "entityFriendlyName": "testvm", + "backupManagementType": "AzureIaasVM", + "operation": "Backup", + "status": "InProgress", + "startTime": "2017-08-03T05:31:07.014604Z", + "activityId": "00000000-0000-0000-0000-000000000000" + } + }, + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.RecoveryServices/vaults/backupJobs", + "properties": { + "jobType": "AzureIaaSVMJob", + "duration": "PT31.3066291S", + "virtualMachineVersion": "Compute", + "entityFriendlyName": "testvm", + "backupManagementType": "AzureIaasVM", + "operation": "ConfigureBackup", + "status": "Completed", + "startTime": "2017-08-03T05:30:32.4487085Z", + "endTime": "2017-08-03T05:31:03.7553376Z", + "activityId": "00000000-0000-0000-0000-000000000000" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs?api-version=2017-07-01&%24filter=startTime+eq+%272016-01-01+00%3a00%3a00+AM%27+and+endTime+eq+%272017-11-29+00%3a00%3a00+AM%27&%24skiptoken=%3c%3fxml+version%3d%221.0%22+encoding%3d%22utf-16%22%3f%3e%0d%0a%3cContinuationToken%3e%0d%0a++%3cContinuationToken%3e%0d%0a++++%3cVersion%3e2.0%3c%2fVersion%3e%0d%0a++++%3cType%3eTable%3c%2fType%3e%0d%0a++++%3cNextPartitionKey%3e1!28!NzI5MTk0OTM1MDkwNjEwODQzMA--%3c%2fNextPartitionKey%3e%0d%0a++++%3cNextRowKey%3e1!108!am9ic3N0YXJ0dGltZWluZGV4XzBfMjUxODkxNDYzNTI2NjE5Nzg5OF8wXzYwOWZkM2JmLTU4MzctNDFkYi1iMjExLTY1MzliNDNlZjM1OA--%3c%2fNextRowKey%3e%0d%0a++++%3cTargetLocation%3ePrimary%3c%2fTargetLocation%3e%0d%0a++%3c%2fContinuationToken%3e%0d%0a%3c%2fContinuationToken%3e" + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/ProtectedItem_Delete.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/ProtectedItem_Delete.json new file mode 100644 index 000000000000..611f12366d0a --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/ProtectedItem_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "PythonSDKBackupTestRg", + "vaultName": "PySDKBackupTestRsVault", + "fabricName": "Azure", + "containerName": "iaasvmcontainer;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1", + "protectedItemName": "vm;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1", + "api-version": "2021-06-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupOperations/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupOperationResults/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Retry-After": 60 + } + }, + "204": {} + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/ProtectedItem_Delete_OperationResult.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/ProtectedItem_Delete_OperationResult.json new file mode 100644 index 000000000000..4f6c4d724a38 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/ProtectedItem_Delete_OperationResult.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "PythonSDKBackupTestRg", + "vaultName": "PySDKBackupTestRsVault", + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupOperations/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupOperationResults/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Retry-After": 60 + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/ProtectedItem_Delete_OperationStatus.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/ProtectedItem_Delete_OperationStatus.json new file mode 100644 index 000000000000..ff7165024893 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/ProtectedItem_Delete_OperationStatus.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "PythonSDKBackupTestRg", + "vaultName": "PySDKBackupTestRsVault", + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "status": "InProgress", + "startTime": "2017-08-03T06:52:53.886027Z", + "endTime": "0001-01-01T00:00:00.00000Z" + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/RefreshContainers.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/RefreshContainers.json new file mode 100644 index 000000000000..98a8ad2e5f80 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/RefreshContainers.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "fabricName": "Azure", + "api-version": "2021-06-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupFabrics/Azure/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/RefreshContainers_OperationResults.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/RefreshContainers_OperationResults.json new file mode 100644 index 000000000000..aa2b873ae617 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/RefreshContainers_OperationResults.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "fabricName": "Azure", + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupFabrics/Azure/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Retry-After": 60 + } + }, + "204": {} + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/TriggerBackup_Post.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/TriggerBackup_Post.json new file mode 100644 index 000000000000..49c20c89d70f --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/TriggerBackup_Post.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "linuxRsVaultRG", + "vaultName": "linuxRsVault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;testrg;v1win2012r", + "protectedItemName": "VM;iaasvmcontainerv2;testrg;v1win2012r", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "objectType": "IaasVMBackupRequest" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/linuxRsVaultRG/providers/Microsoft.RecoveryServices/vaults/linuxRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainer;testrg;v1win2012r/protectedItems/VM;iaasvmcontainer;testrg;v1win2012r/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/linuxRsVaultRG/providers/Microsoft.RecoveryServices/vaults/linuxRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainer;testrg;v1win2012r/protectedItems/VM;iaasvmcontainer;testrg;v1win2012r/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/TriggerCancelJob.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/TriggerCancelJob.json new file mode 100644 index 000000000000..94639cd7d3a4 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/TriggerCancelJob.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "jobName": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/00000000-0000-0000-0000-000000000000/operationResults/00000000-0000-0000-0000-000000000000?api-version=2017-07-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/TriggerExportJobs.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/TriggerExportJobs.json new file mode 100644 index 000000000000..eb491166c767 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Common/TriggerExportJobs.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "api-version": "2021-06-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/operationResults/00000000-0000-0000-0000-000000000000?api-version=2017-07-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Dpm/BackupEngines_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Dpm/BackupEngines_Get.json new file mode 100644 index 000000000000..3d90fcda39d5 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Dpm/BackupEngines_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testRG", + "vaultName": "testVault", + "backupEngineName": "testServer", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.RecoveryServices/vaults/testVault/backupEngines/testServer", + "name": "testServer", + "type": "Microsoft.RecoveryServices/vaults/backupEngines", + "properties": { + "backupEngineType": "DpmBackupEngine", + "dpmVersion": "5.1.348.0", + "isDpmUpgradeAvailable": false, + "azureBackupAgentVersion": "2.0.9532.0", + "isAzureBackupAgentUpgradeAvailable": false, + "registrationStatus": "Registered", + "backupEngineState": "Active", + "friendlyName": "testServer", + "extendedInfo": { + "protectedItemsCount": 35, + "protectedServersCount": 21, + "diskCount": 5, + "availableDiskSpace": 50, + "usedDiskSpace": 20 + } + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Dpm/BackupEngines_List.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Dpm/BackupEngines_List.json new file mode 100644 index 000000000000..33c19e5cc933 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Dpm/BackupEngines_List.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testRG", + "vaultName": "testVault", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.RecoveryServices/vaults/testVault/backupEngines/testServer1", + "name": "testServer1", + "type": "Microsoft.RecoveryServices/vaults/backupEngines", + "properties": { + "backupEngineType": "DpmBackupEngine", + "dpmVersion": "5.1.348.0", + "isDpmUpgradeAvailable": false, + "azureBackupAgentVersion": "2.0.9532.0", + "isAzureBackupAgentUpgradeAvailable": false, + "registrationStatus": "Registered", + "backupEngineState": "Active", + "friendlyName": "testServer1", + "extendedInfo": { + "protectedItemsCount": 35, + "protectedServersCount": 21, + "diskCount": 5, + "availableDiskSpace": 50, + "usedDiskSpace": 20 + } + } + }, + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.RecoveryServices/vaults/testVault/backupEngines/testServer5", + "name": "testServer5", + "type": "Microsoft.RecoveryServices/vaults/backupEngines", + "properties": { + "backupEngineType": "DpmBackupEngine", + "dpmVersion": "5.1.348.0", + "isDpmUpgradeAvailable": false, + "azureBackupAgentVersion": "2.0.9530.0", + "isAzureBackupAgentUpgradeAvailable": false, + "registrationStatus": "Registered", + "backupEngineState": "Active", + "friendlyName": "testServer5", + "extendedInfo": { + "protectedItemsCount": 35, + "protectedServersCount": 21, + "diskCount": 5, + "availableDiskSpace": 50, + "usedDiskSpace": 20 + } + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ListOperations.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ListOperations.json new file mode 100644 index 000000000000..3937248fb596 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ListOperations.json @@ -0,0 +1,463 @@ +{ + "parameters": { + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "microsoft.recoveryservices/vaults/usages/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Vault Usage", + "operation": "Recovery Services Vault usage details.", + "description": "Returns usage details for a Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupUsageSummaries/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Usages Summaries", + "operation": "Recovery Services Protected Items and Protected Servers usage summaries details.", + "description": "Returns summaries for Protected Items and Protected Servers for a Recovery Services ." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/storageConfig/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Vault Storage Config", + "operation": "Get Resource Storage Config", + "description": "Returns Storage Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/storageConfig/write", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Vault Storage Config", + "operation": "Write Resource Storage Config", + "description": "Updates Storage Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupconfig/vaultconfig/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Vault Config", + "operation": "Get Resource Config", + "description": "Returns Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupconfig/vaultconfig/write", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Vault Config", + "operation": "Update Resource Config", + "description": "Updates Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/tokenInfo/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Token Info", + "operation": "Get Vault Token Info", + "description": "Returns token information for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupSecurityPIN/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "SecurityPINInfo", + "operation": "Get Security PIN Info", + "description": "Returns Security PIN Information for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupManagementMetaData/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Management Metadata", + "operation": "Get Backup Management Metadata", + "description": "Returns Backup Management Metadata for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupOperationResults/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Operation Results", + "operation": "Get Backup Operation Result", + "description": "Returns Backup Operation Result for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupOperations/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Operation Status", + "operation": "Get Backup Operation Status", + "description": "Returns Backup Operation Status for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupJobs/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Jobs", + "operation": "Get Jobs", + "description": "Returns all Job Objects" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupJobs/cancel/action", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Jobs", + "operation": "Cancel Jobs", + "description": "Cancel the Job" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupJobsExport/action", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Export Backup Jobs", + "operation": "Export Jobs", + "description": "Export Jobs" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupJobs/operationResults/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Jobs Operation Results", + "operation": "Get Job Operation Result", + "description": "Returns the Result of Job Operation." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupJobsExport/operationResults/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Export Backup Jobs Operation Results", + "operation": "Get Export Job Operation Result", + "description": "Returns the Result of Export Job Operation." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Recovery Points", + "operation": "Get Recovery Points", + "description": "Get Recovery Points for Protected Items." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/restore/action", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Recovery Points", + "operation": "Restore Recovery Points", + "description": "Restore Recovery Points for Protected Items." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/provisionInstantItemRecovery/action", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Recovery Points", + "operation": "Provision Instant Item Recovery for Protected Item", + "description": "Provision Instant Item Recovery for Protected Item" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/revokeInstantItemRecovery/action", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Recovery Points", + "operation": "Revoke Instant Item Recovery for Protected Item", + "description": "Revoke Instant Item Recovery for Protected Item" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupPolicies/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Policies", + "operation": "Get Protection Policy", + "description": "Returns all Protection Policies" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupPolicies/write", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Policies", + "operation": "Create Protection Policy", + "description": "Creates Protection Policy" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupPolicies/delete", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Policies", + "operation": "Delete Protection Policy", + "description": "Delete a Protection Policy" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupPolicies/operationResults/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Policy Operation Results", + "operation": "Get Policy Operation Results", + "description": "Get Results of Policy Operation." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupPolicies/operationsStatus/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Policy Operation Status", + "operation": "Get Policy Operation Status", + "description": "Get Status of Policy Operation." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protected Items", + "operation": "Get Protected Item Details", + "description": "Returns object details of the Protected Item" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupProtectedItems/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protected Items", + "operation": "Get All Protected Items", + "description": "Returns the list of all Protected Items." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/write", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protected Items", + "operation": "Create Backup Protected Item", + "description": "Create a backup Protected Item" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/delete", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protected Items", + "operation": "Delete Protected Items", + "description": "Deletes Protected Item" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/operationResults/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protected Item Operation Results", + "operation": "Get Protected Items Operation Results", + "description": "Gets Result of Operation Performed on Protected Items." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/operationsStatus/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protected Item Operation Status", + "operation": "Get Protected Items operation status", + "description": "Returns the status of Operation performed on Protected Items." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/backup/action", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protected Items", + "operation": "Backup Protected Item", + "description": "Performs Backup for Protected Item." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupProtectableItems/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Protectable Items", + "operation": "Get Protectable Items", + "description": "Returns list of all Protectable Items." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/refreshContainers/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Refresh Containers", + "operation": "Refresh container", + "description": "Refreshes the container list" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/operationResults/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Refresh Containers Operation Results", + "operation": "Get Operation Results", + "description": "Returns status of the operation" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupProtectionContainers/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Protection Containers", + "operation": "Get Containers In Subscription", + "description": "Returns all containers belonging to the subscription" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protection Containers", + "operation": "Get Registered Container", + "description": "Returns all registered containers" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/operationResults/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protection Containers Operation Results", + "operation": "Get Container Operation Results", + "description": "Gets result of Operation performed on Protection Container." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupEngines", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Engines", + "operation": "List of backup management servers.", + "description": "Returns all the backup management servers registered with vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupStatus", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Status", + "operation": "Check Backup Status for Vault", + "description": "Check Backup Status for Recovery Services Vaults" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupPreValidateProtection", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "PreValidate Protection", + "operation": "Pre Validate Enable Protection", + "description": "" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupValidateFeatures", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Validate Features", + "operation": "Validate Features", + "description": "Validate Features" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/backupProtectionIntent/write", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protection Intent", + "operation": "Create backup Protection Intent", + "description": "Create a backup Protection Intent" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/{fabricName}/protectionContainers/{containerName}/items/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Workload Items", + "operation": "Get all items in a container", + "description": "Get all items in a container" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/inquire/action", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protection Containers Inquire", + "operation": "Get all items in a container", + "description": "Get all items in a container" + }, + "origin": "user" + } + ] + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PrivateEndpointConnection/DeletePrivateEndpointConnection.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PrivateEndpointConnection/DeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..f80dfb44e892 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PrivateEndpointConnection/DeletePrivateEndpointConnection.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "gaallaRG", + "vaultName": "gaallavaultbvtd2msi", + "privateEndpointConnectionName": "gaallatestpe2.5704c932-249a-490b-a142-1396838cd3b", + "api-version": "2021-06-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/6c48fa17-39c7-45f1-90ac-47a587128ace/resourceGroups/backupadminrg/providers/Microsoft.RecoveryServices/Vaults/demo-pevault-2/privateEndpointConnections/autoapprovalpeecy4.3679789459502941542.backup.5ede856d-d9f0-461e-a15b-370c84525817/operationsStatus/2908a25d-8036-48d2-bdcc-fdce26b9771f?api-versi", + "Retry-After": "60" + } + }, + "204": {} + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PrivateEndpointConnection/GetPrivateEndpointConnection.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PrivateEndpointConnection/GetPrivateEndpointConnection.json new file mode 100644 index 000000000000..f3c15f1a596c --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PrivateEndpointConnection/GetPrivateEndpointConnection.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "gaallaRG", + "vaultName": "gaallavaultbvtd2msi", + "privateEndpointConnectionName": "gaallatestpe2.5704c932-249a-490b-a142-1396838cd3b", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/gaallaRG/providers/Microsoft.RecoveryServicesBVTD2/vaults/gaallavaultbvtd2msi/privateEndpointConnections/gaallatestpe3.3592346090307038890.backup.5704c932-249a-490b-a142-1396838cd3b", + "name": "gaallatestpe1.3592346090307038890.backup.5704c932-249a-490b-a142-1396838cd3b", + "type": "Microsoft.RecoveryServices/vaults/privateEndpointConnections", + "properties": { + "provisioningState": "Pending", + "privateEndpoint": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/gaallaRG/providers/Microsoft.Network/privateEndpoints/gaallatestpe3" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@company.com" + } + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PrivateEndpointConnection/GetPrivateEndpointConnectionOperationStatus.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PrivateEndpointConnection/GetPrivateEndpointConnectionOperationStatus.json new file mode 100644 index 000000000000..04b242e59e12 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PrivateEndpointConnection/GetPrivateEndpointConnectionOperationStatus.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "gaallaRG", + "privateEndpointConnectionName": "gaallatestpe2.5704c932-249a-490b-a142-1396838cd3b", + "vaultName": "gaallavaultbvtd2msi", + "operationId": "0f48183b-0a44-4dca-aec1-bba5daab888a", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "id": "0f48183b-0a44-4dca-aec1-bba5daab888a", + "name": "0f48183b-0a44-4dca-aec1-bba5daab888a", + "status": "Succeeded", + "startTime": "2020-02-27T11:59:47.5901592Z", + "endTime": "2020-02-27T11:59:47.5901592Z" + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PrivateEndpointConnection/PutPrivateEndpointConnection.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PrivateEndpointConnection/PutPrivateEndpointConnection.json new file mode 100644 index 000000000000..6eb1ab7c674c --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/PrivateEndpointConnection/PutPrivateEndpointConnection.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "gaallaRG", + "vaultName": "gaallavaultbvtd2msi", + "privateEndpointConnectionName": "gaallatestpe2.5704c932-249a-490b-a142-1396838cd3b", + "api-version": "2021-06-01", + "parameters": { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/gaallaRG/providers/Microsoft.Network/privateEndpoints/gaallatestpe3" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@company.com" + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/gaallaRG/providers/Microsoft.RecoveryServicesBVTD2/vaults/gaallavaultbvtd2msi/privateEndpointConnections/gaallatestpe3.3592346090307038890.backup.5704c932-249a-490b-a142-1396838cd3b", + "name": "gaallatestpe1.3592346090307038890.backup.5704c932-249a-490b-a142-1396838cd3b", + "type": "Microsoft.RecoveryServices/vaults/privateEndpointConnections", + "properties": { + "provisioningState": "Pending", + "privateEndpoint": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/gaallaRG/providers/Microsoft.Network/privateEndpoints/gaallatestpe3" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@company.com" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/6c48fa17-39c7-45f1-90ac-47a587128ace/resourceGroups/backupadminrg/providers/Microsoft.RecoveryServices/Vaults/demo-pevault-2/privateEndpointConnections/autoapprovalpeecy4.3679789459502941542.backup.5ede856d-d9f0-461e-a15b-370c84525817/operationsStatus/2908a25d-8036-48d2-bdcc-fdce26b9771f?api-versi", + "Retry-After": "60" + } + }, + "200": { + "body": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/gaallaRG/providers/Microsoft.RecoveryServicesBVTD2/vaults/gaallavaultbvtd2msi/privateEndpointConnections/gaallatestpe3.3592346090307038890.backup.5704c932-249a-490b-a142-1396838cd3b", + "name": "gaallatestpe1.3592346090307038890.backup.5704c932-249a-490b-a142-1396838cd3b", + "type": "Microsoft.RecoveryServices/vaults/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/gaallaRG/providers/Microsoft.Network/privateEndpoints/gaallatestpe3" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@company.com" + } + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/TriggerRecoveryPointMove_Post.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/TriggerRecoveryPointMove_Post.json new file mode 100644 index 000000000000..f12280ce4201 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/TriggerRecoveryPointMove_Post.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "netsdktestrg", + "vaultName": "testVault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "protectedItemName": "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "recoveryPointId": "348916168024334", + "api-version": "2021-06-01", + "parameters": { + "objectType": "MoveRPAcrossTiersRequest", + "sourceTierType": "HardenedRP", + "targetTierType": "ArchivedRP" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2020-09-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2020-09-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/readme.md b/specification/recoveryservicesbackup/resource-manager/readme.md index 332047f1cd90..e57fa89c6cf5 100644 --- a/specification/recoveryservicesbackup/resource-manager/readme.md +++ b/specification/recoveryservicesbackup/resource-manager/readme.md @@ -28,7 +28,7 @@ These are the global settings for the RecoveryServicesBackup API. title: Recovery Services Backup Client description: Open API 2.0 Specs for Azure RecoveryServices Backup service openapi-type: arm -tag: package-2021-01 +tag: package-2021-06 csharp-sdks-folder: ./Generated/CSharp python-sdks-folder: ./Generated/Python go-sdk-folder: ./Generated/Golang @@ -46,6 +46,16 @@ semantic-validator: true message-format: json ``` + +### Tag: package-2021-06 + +These settings apply only when `--tag=package-2021-06` is specified on the command line. + +```yaml $(tag) == 'package-2021-06' +input-file: + - Microsoft.RecoveryServices/stable/2021-06-01/bms.json + - Microsoft.RecoveryServices/stable/2018-12-20/bms.json +``` ### Tag: package-2021-04 These settings apply only when `--tag=package-2021-04` is specified on the command line. @@ -70,11 +80,12 @@ input-file: These settings apply only when `--tag=package-2021-02-10` is specified on the command line. -```yaml $(tag) == 'package-2021-02-10' +``` yaml $(tag) == 'package-2021-02-10' input-file: - Microsoft.RecoveryServices/stable/2021-02-10/bms.json - Microsoft.RecoveryServices/stable/2018-12-20/bms.json ``` + ### Tag: package-2021-02-preview These settings apply only when `--tag=package-2021-02-preview` is specified on the command line. @@ -275,3 +286,14 @@ See configuration in [readme.go.md](./readme.go.md) See configuration in [readme.java.md](./readme.java.md) +## Suppression + +``` yaml $(directive) +directive: + - suppress: ImplementPrivateEndpointAPIs + from: Microsoft.RecoveryServices/stable/2018-12-20/bms.json + reason: Existing API version. Private Endpoint are not supposed to be implemented for this API version dedicated for CRR, that uses API version based routing. + - suppress: ImplementPrivateEndpointAPIs + from: Microsoft.RecoveryServices/stable/2021-06-01/bms.json + reason: Addition of new API version is specific to MSI support for our service, to ensure sign off we commit we will take a fix for Private endpoint in Ni. +``` diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/MigrationRecoveryPoints_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/MigrationRecoveryPoints_Get.json new file mode 100644 index 000000000000..ad796fb9cdc9 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/MigrationRecoveryPoints_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "migrationRecoveryPointName": "b22134ea-620c-474b-9fa5-3c1cb47708e3", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef" + }, + "responses": { + "200": { + "body": { + "name": "b22134ea-620c-474b-9fa5-3c1cb47708e3", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems/migrationRecoveryPoints", + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1/migrationRecoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "properties": { + "recoveryPointTime": "2017-04-26T06:37:50.8082715Z", + "recoveryPointType": "CrashConsistent" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/MigrationRecoveryPoints_ListByReplicationMigrationItems.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/MigrationRecoveryPoints_ListByReplicationMigrationItems.json new file mode 100644 index 000000000000..b091928c7229 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/MigrationRecoveryPoints_ListByReplicationMigrationItems.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "648336ef-2d70-4d98-b100-8c299f97cd41", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems/migrationRecoveryPoints", + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1/migrationRecoveryPoints/648336ef-2d70-4d98-b100-8c299f97cd41", + "properties": { + "recoveryPointTime": "2017-04-26T06:37:50.8082715Z", + "recoveryPointType": "CrashConsistent" + } + }, + { + "name": "34cb2d05-e730-4d3f-b96b-a60a5e92acb2", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems/migrationRecoveryPoints", + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1/migrationRecoveryPoints/34cb2d05-e730-4d3f-b96b-a60a5e92acb2", + "properties": { + "recoveryPointTime": "2017-04-26T07:37:30.9722019Z", + "recoveryPointType": "CrashConsistent" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/Operations_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/Operations_List.json new file mode 100644 index 000000000000..6aaf1ae1bd74 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/Operations_List.json @@ -0,0 +1,1225 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.RecoveryServices/Vaults/vaultTokens/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Vault Token", + "description": "The Vault Token operation can be used to get Vault Token for vault level backend operations." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/registeredIdentities/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Register Service Container", + "description": "The Register Service Container operation can be used to register a container with Recovery Service." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/registeredIdentities/operationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Get Operation Results", + "description": "The Get Operation Results operation can be used get the operation status and result for the asynchronously submitted operation" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/registeredIdentities/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Get Containers", + "description": "The Get Containers operation can be used get the containers registered for a resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/registeredIdentities/delete", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Unregister Service Container", + "description": "The UnRegister Container operation can be used to unregister a container." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/certificates/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Update Resource Certificate", + "description": "The Update Resource Certificate operation updates the resource/vault credential certificate." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationAlertSettings/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Alerts Settings", + "operation": "Read Alerts Settings", + "description": "Read Any Alerts Settings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationAlertSettings/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Alerts Settings", + "operation": "Create or Update Alerts Settings", + "description": "Create or Update Any Alerts Settings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationEvents/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Events", + "operation": "Read Events", + "description": "Read Any Events" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Networks", + "operation": "Read Networks", + "description": "Read Any Networks" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Network Mappings", + "operation": "Read Network Mappings", + "description": "Read Any Network Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Network Mappings", + "operation": "Create or Update Network Mappings", + "description": "Create or Update Any Network Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Network Mappings", + "operation": "Delete Network Mappings", + "description": "Delete Any Network Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectableItems/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protectable Items", + "operation": "Read Protectable Items", + "description": "Read Any Protectable Items" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Container Mappings", + "operation": "Read Protection Container Mappings", + "description": "Read Any Protection Container Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Container Mappings", + "operation": "Create or Update Protection Container Mappings", + "description": "Create or Update Any Protection Container Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings/remove/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Container Mappings", + "operation": "Remove Protection Container Mapping", + "description": "Remove Protection Container Mapping" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Container Mappings", + "operation": "Delete Protection Container Mappings", + "description": "Delete Any Protection Container Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/recoveryPoints/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Replication Recovery Points", + "operation": "Read Replication Recovery Points", + "description": "Read Any Replication Recovery Points" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Read Protected Items", + "description": "Read Any Protected Items" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Create or Update Protected Items", + "description": "Create or Update Any Protected Items" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Delete Protected Items", + "description": "Delete Any Protected Items" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/remove/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Remove Protected Item", + "description": "Remove Protected Item" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/plannedFailover/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Planned Failover", + "description": "Planned Failover" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/unplannedFailover/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Failover", + "description": "Failover" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/testFailover/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Test Failover", + "description": "Test Failover" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/testFailoverCleanup/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Test Failover Cleanup", + "description": "Test Failover Cleanup" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/failoverCommit/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Failover Commit", + "description": "Failover Commit" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/reProtect/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "ReProtect Protected Item", + "description": "ReProtect Protected Item" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/updateMobilityService/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Update Mobility Service", + "description": "Update Mobility Service" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/repairReplication/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Repair replication", + "description": "Repair replication" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/applyRecoveryPoint/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Apply Recovery Point", + "description": "Apply Recovery Point" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationJobs/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Jobs", + "operation": "Read Jobs", + "description": "Read Any Jobs" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationJobs/cancel/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Jobs", + "operation": "Cancel Job", + "description": "Cancel Job" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationJobs/restart/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Jobs", + "operation": "Restart job", + "description": "Restart job" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationJobs/resume/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Jobs", + "operation": "Resume Job", + "description": "Resume Job" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Containers", + "operation": "Read Protection Containers", + "description": "Read Any Protection Containers" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/discoverProtectableItem/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Containers", + "operation": "Discover Protectable Item", + "description": "Discover Protectable Item" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Containers", + "operation": "Create or Update Protection Containers", + "description": "Create or Update Any Protection Containers" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/remove/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Containers", + "operation": "Remove Protection Container", + "description": "Remove Protection Container" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/switchprotection/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Containers", + "operation": "Switch Protection Container", + "description": "Switch Protection Container" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationPolicies/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Policies", + "operation": "Read Policies", + "description": "Read Any Policies" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationPolicies/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Policies", + "operation": "Create or Update Policies", + "description": "Create or Update Any Policies" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationPolicies/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Policies", + "operation": "Delete Policies", + "description": "Delete Any Policies" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Read Recovery Plans", + "description": "Read Any Recovery Plans" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Create or Update Recovery Plans", + "description": "Create or Update Any Recovery Plans" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Delete Recovery Plans", + "description": "Delete Any Recovery Plans" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/plannedFailover/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Planned Failover Recovery Plan", + "description": "Planned Failover Recovery Plan" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/unplannedFailover/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Failover Recovery Plan", + "description": "Failover Recovery Plan" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/testFailover/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Test Failover Recovery Plan", + "description": "Test Failover Recovery Plan" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/testFailoverCleanup/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Test Failover Cleanup Recovery Plan", + "description": "Test Failover Cleanup Recovery Plan" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/failoverCommit/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Failover Commit Recovery Plan", + "description": "Failover Commit Recovery Plan" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/reProtect/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "ReProtect Recovery Plan", + "description": "ReProtect Recovery Plan" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Services Providers", + "operation": "Read Recovery Services Providers", + "description": "Read Any Recovery Services Providers" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders/remove/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Services Providers", + "operation": "Remove Recovery Services Provider", + "description": "Remove Recovery Services Provider" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Services Providers", + "operation": "Delete Recovery Services Providers", + "description": "Delete Any Recovery Services Providers" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders/refreshProvider/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Services Providers", + "operation": "Refresh Provider", + "description": "Refresh Provider" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Read Fabrics", + "description": "Read Any Fabrics" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Create or Update Fabrics", + "description": "Create or Update Any Fabrics" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/remove/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Remove Fabric", + "description": "Remove Fabric" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/checkConsistency/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Checks Consistency of the Fabric", + "description": "Checks Consistency of the Fabric" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Delete Fabrics", + "description": "Delete Any Fabrics" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/renewcertificate/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Renew Certificate for Fabric", + "description": "Renew Certificate for Fabric" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/deployProcessServerImage/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Deploy Process Server Image", + "description": "Deploy Process Server Image" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/reassociateGateway/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Reassociate Gateway", + "description": "Reassociate Gateway" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Storage Classifications", + "operation": "Read Storage Classifications", + "description": "Read Any Storage Classifications" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Storage Classification Mappings", + "operation": "Read Storage Classification Mappings", + "description": "Read Any Storage Classification Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Storage Classification Mappings", + "operation": "Create or Update Storage Classification Mappings", + "description": "Create or Update Any Storage Classification Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Storage Classification Mappings", + "operation": "Delete Storage Classification Mappings", + "description": "Delete Any Storage Classification Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/usages/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Vault Usages", + "operation": "Read Vault Usages", + "description": "Read Any Vault Usages" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Jobs", + "operation": "Read Jobs", + "description": "Read Any Jobs" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Jobs", + "operation": "Create or Update Jobs", + "description": "Create or Update Any Jobs" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Jobs", + "operation": "Delete Jobs", + "description": "Delete Any Jobs" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/usages/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vault Usage", + "operation": "Recovery Services Vault usage details.", + "description": "Returns usage details for a Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupUsageSummaries/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Usages Summaries", + "operation": "Recovery Services Protected Items and Protected Servers usage summaries details.", + "description": "Returns summaries for Protected Items and Protected Servers for a Recovery Services ." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/storageConfig/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vault Storage Config", + "operation": "Get Resource Storage Config", + "description": "Returns Storage Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/storageConfig/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vault Storage Config", + "operation": "Write Resource Storage Config", + "description": "Updates Storage Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupconfig/vaultconfig/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vault Config", + "operation": "Get Resource Config", + "description": "Returns Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupconfig/vaultconfig/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vault Config", + "operation": "Update Resource Config", + "description": "Updates Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/tokenInfo/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Token Info", + "operation": "Get Vault Token Info", + "description": "Returns token information for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupSecurityPIN/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "SecurityPINInfo", + "operation": "Get Security PIN Info", + "description": "Returns Security PIN Information for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupManagementMetaData/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Management Metadata", + "operation": "Get Backup Management Metadata", + "description": "Returns Backup Management Metadata for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupOperationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Operation Results", + "operation": "Get Backup Operation Result", + "description": "Returns Backup Operation Result for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupOperations/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Operation Status", + "operation": "Get Backup Operation Status", + "description": "Returns Backup Operation Status for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupJobs/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Jobs", + "operation": "Get Jobs", + "description": "Returns all Job Objects" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupJobs/cancel/action", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Jobs", + "operation": "Cancel Jobs", + "description": "Cancel the Job" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupJobsExport/action", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Export Backup Jobs", + "operation": "Export Jobs", + "description": "Export Jobs" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupJobs/operationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Jobs Operation Results", + "operation": "Get Job Operation Result", + "description": "Returns the Result of Job Operation." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupJobsExport/operationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Export Backup Jobs Operation Results", + "operation": "Get Export Job Operation Result", + "description": "Returns the Result of Export Job Operation." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Recovery Points", + "operation": "Get Recovery Points", + "description": "Get Recovery Points for Protected Items." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/restore/action", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Recovery Points", + "operation": "Restore Recovery Points", + "description": "Restore Recovery Points for Protected Items." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/provisionInstantItemRecovery/action", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Recovery Points", + "operation": "Provision Instant Item Recovery for Protected Item", + "description": "Provision Instant Item Recovery for Protected Item" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/revokeInstantItemRecovery/action", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Recovery Points", + "operation": "Revoke Instant Item Recovery for Protected Item", + "description": "Revoke Instant Item Recovery for Protected Item" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupPolicies/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Policies", + "operation": "Get Protection Policy", + "description": "Returns all Protection Policies" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupPolicies/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Policies", + "operation": "Create Protection Policy", + "description": "Creates Protection Policy" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupPolicies/delete", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Policies", + "operation": "Delete Protection Policy", + "description": "Delete a Protection Policy" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupPolicies/operationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Policy Operation Results", + "operation": "Get Policy Operation Results", + "description": "Get Results of Policy Operation." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupPolicies/operationStatus/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Policy Operation Status", + "operation": "Get Policy Operation Status", + "description": "Get Status of Policy Operation." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protected Items", + "operation": "Get Protected Item Details", + "description": "Returns object details of the Protected Item" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupProtectedItems/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protected Items", + "operation": "Get All Protected Items", + "description": "Returns the list of all Protected Items." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protected Items", + "operation": "Create Backup Protected Item", + "description": "Create a backup Protected Item" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/delete", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protected Items", + "operation": "Delete Protected Items", + "description": "Deletes Protected Item" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/operationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protected Item Operation Results", + "operation": "Get Protected Items Operation Results", + "description": "Gets Result of Operation Performed on Protected Items." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/operationStatus/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protected Item Operation Status", + "operation": "Get Protected Items operation status", + "description": "Returns the status of Operation performed on Protected Items." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/backup/action", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protected Items", + "operation": "Backup Protected Item", + "description": "Performs Backup for Protected Item." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupProtectableItems/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Protectable Items", + "operation": "Get Protectable Items", + "description": "Returns list of all Protectable Items." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/refreshContainers/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Refresh Containers", + "operation": "Refresh container", + "description": "Refreshes the container list" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/operationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Refresh Containers Operation Results", + "operation": "Get Operation Results", + "description": "Returns status of the operation" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupProtectionContainers/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Protection Containers", + "operation": "Get Containers In Subscription", + "description": "Returns all containers belonging to the subscription" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protection Containers", + "operation": "Get Registered Container", + "description": "Returns all registered containers" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/operationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protection Containers Operation Results", + "operation": "Get Container Operation Results", + "description": "Gets result of Operation performed on Protection Container." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupEngines", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Engines", + "operation": "List of backup management servers.", + "description": "Returns all the backup management servers registered with vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupStatus", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Status", + "operation": "Check Backup Status for Vault", + "description": "Check Backup Status for Recovery Services Vaults" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Create Vault", + "description": "Create Vault operation creates an Azure resource of type 'vault'" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Get Vault", + "description": "The Get Vault operation gets an object representing the Azure resource of type 'vault'" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/delete", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Delete Vault", + "description": "The Delete Vault operation deletes the specified Azure resource of type 'vault'" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/extendedInformation/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Get Extended Info", + "description": "The Get Extended Info operation gets an object's Extended Info representing the Azure resource of type ?vault?" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/extendedInformation/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Get Extended Info", + "description": "The Get Extended Info operation gets an object's Extended Info representing the Azure resource of type ?vault?" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/extendedInformation/delete", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Get Extended Info", + "description": "The Get Extended Info operation gets an object's Extended Info representing the Azure resource of type ?vault?" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/locations/allocatedStamp/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "locations/allocatedStamp", + "operation": "Get Allocated Stamp", + "description": "GetAllocatedStamp is internal operation used by service" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/locations/allocateStamp/action", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "locations/allocateStamp", + "operation": "Allocated Stamp Action", + "description": "AllocateStamp is internal operation used by service" + }, + "origin": "user" + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/RecoveryPoints_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/RecoveryPoints_Get.json new file mode 100644 index 000000000000..7b897034a199 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/RecoveryPoints_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPointName": "b22134ea-620c-474b-9fa5-3c1cb47708e3" + }, + "responses": { + "200": { + "body": { + "name": "b22134ea-620c-474b-9fa5-3c1cb47708e3", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/recoveryPoints", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "properties": { + "recoveryPointTime": "2017-04-26T06:37:50.8082715Z", + "recoveryPointType": "CrashConsistent" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/RecoveryPoints_ListByReplicationProtectedItems.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/RecoveryPoints_ListByReplicationProtectedItems.json new file mode 100644 index 000000000000..d62122caaa94 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/RecoveryPoints_ListByReplicationProtectedItems.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "b22134ea-620c-474b-9fa5-3c1cb47708e3", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/recoveryPoints", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "properties": { + "recoveryPointTime": "2017-04-26T06:37:50.8082715Z", + "recoveryPointType": "CrashConsistent" + } + }, + { + "name": "34cb2d05-e730-4d3f-b96b-a60a5e92acb2", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/recoveryPoints", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/34cb2d05-e730-4d3f-b96b-a60a5e92acb2", + "properties": { + "recoveryPointTime": "2017-04-26T07:37:30.9722019Z", + "recoveryPointType": "CrashConsistent" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationAlertSettings_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationAlertSettings_Create.json new file mode 100644 index 000000000000..c3bd9763e5b3 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationAlertSettings_Create.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "alertSettingName": "defaultAlertSetting", + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "request": { + "properties": { + "sendToOwners": "false", + "customEmailAddresses": [ + "ronehr@microsoft.com" + ], + "locale": "" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationAlertSettings", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationAlertSettings/defaultAlertSetting", + "name": "defaultAlertSetting", + "properties": { + "sendToOwners": "false", + "customEmailAddresses": [ + "ronehr@microsoft.com" + ], + "locale": "en-US" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationAlertSettings_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationAlertSettings_Get.json new file mode 100644 index 000000000000..4c000f96e217 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationAlertSettings_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "alertSettingName": "defaultAlertSetting", + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationAlertSettings", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationAlertSettings/defaultAlertSetting", + "name": "defaultAlertSetting", + "properties": { + "sendToOwners": "false", + "customEmailAddresses": [ + "ronehr@microsoft.com" + ], + "locale": "en-US" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationAlertSettings_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationAlertSettings_List.json new file mode 100644 index 000000000000..42ca86e35d8b --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationAlertSettings_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationAlertSettings", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationAlertSettings/defaultAlertSetting", + "name": "defaultAlertSetting", + "properties": { + "sendToOwners": "false", + "customEmailAddresses": [ + "ronehr@microsoft.com" + ], + "locale": "en-US" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationEligibilityResults_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationEligibilityResults_Get.json new file mode 100644 index 000000000000..5bbe7330aa1f --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationEligibilityResults_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "virtualMachineName": "testVm1", + "resourceGroupName": "testRg1", + "subscriptionId": "d90d145a-4cdd-45a3-b2c4-971d69775278" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.RecoveryServices/replicationEligibilityResults", + "id": "/subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/testRg1/providers/Microsoft.Compute/virtualMachines/testVm1/providers/Microsoft.RecoveryServices/replicationEligibilityResults/default", + "properties": { + "clientRequestId": "7d72ade7-b9f7-4d9b-8a19-15d9728c6190", + "errors": [ + { + "code": "A2AOperatingSystemNotSupported", + "message": "The A2A operation could not be completed as the virtual machine is running OS 'ubuntu' with version '18.04' which is not supported for replication.", + "possibleCauses": "OS version not supported.", + "recommendedAction": "The virtual machine is running unsupported Operating system. Refer to the documentation for supported OS versions - https://aka.ms/a2a-os-support-matrix.", + "status": "Error" + } + ] + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationEligibilityResults_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationEligibilityResults_List.json new file mode 100644 index 000000000000..889abdb0be03 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationEligibilityResults_List.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "virtualMachineName": "testVm2", + "resourceGroupName": "testRg1", + "subscriptionId": "d90d145a-4cdd-45a3-b2c4-971d69775278" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.RecoveryServices/replicationEligibilityResults", + "id": "/subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/testRg1/providers/Microsoft.Compute/virtualMachines/testVm2/providers/Microsoft.RecoveryServices/replicationEligibilityResults/default", + "properties": { + "clientRequestId": "a62c81df-e26e-47ea-ab4b-f1fcc1e5b135", + "errors": [ + { + "code": "AzureVmIsNotInDesiredProvisioningState", + "message": "Azure virtual machine with Id (/subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/testRg1/providers/Microsoft.Compute/virtualMachines/testVm2) is with provisioning state 'failed'. To enable replication, VM's provisioning state should be 'succeeded'.", + "possibleCauses": "Virtual machine is not in desired state.", + "recommendedAction": "\n Ensure that the VM's provisioning state is 'succeeded'.\n Refer to https://aka.ms/a2a-vm-state-issues to troubleshoot VM provisioning state issues.\n ", + "status": "Error" + }, + { + "code": "AzureVmIsNotInDesiredPowerState", + "message": "Azure virtual machine with Id (/subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/testRg1/providers/Microsoft.Compute/virtualMachines/testVm2) is with power status 'deallocated'. To enable replication, VM's power status should be 'running'.", + "possibleCauses": "Virtual machine is not in desired state.", + "recommendedAction": "\n Ensure that the VM's power status is 'running'.\n You can check the power status in 'VM > Settings > Properties > Status' in Azure portal.\n ", + "status": "Error" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationEvents_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationEvents_Get.json new file mode 100644 index 000000000000..b1e46b253c5a --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationEvents_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "eventName": "654b71d0-b2ce-4e6e-a861-98528d4bd375", + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationEvents", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationEvents/VmMonitoringEvent;9091989947769704276_516de684-0079-48f7-b44b-882923268654", + "name": "VmMonitoringEvent;9091989947769704276_516de684-0079-48f7-b44b-882923268654", + "properties": { + "eventCode": "d9a07b07-c7b5-49ca-ab6c-6926596dfe47", + "description": "Virtual machine health is OK", + "eventType": "VmHealth", + "affectedObjectFriendlyName": "vm1", + "severity": "OK", + "timeOfOccurrence": "2017-05-02T14:28:28.5071531Z", + "fabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "eventSpecificDetails": { + "instanceType": "JobStatus" + }, + "healthErrors": [] + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationEvents_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationEvents_List.json new file mode 100644 index 000000000000..c0b0fc4b8b3c --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationEvents_List.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationEvents", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationEvents/JobStatusMonitoringEvent;9091989892524070155_4ed6f1a6-9b6d-4048-9079-1307dd24b814", + "name": "JobStatusMonitoringEvent;9091989892524070155_4ed6f1a6-9b6d-4048-9079-1307dd24b814", + "properties": { + "eventCode": "d32574f6-f59e-4545-b5ac-bc88d545f089", + "description": "TestFailover - Failed", + "eventType": "JobStatus", + "affectedObjectFriendlyName": "vm1", + "severity": "Critical", + "timeOfOccurrence": "2017-05-02T16:00:33.0705652Z", + "fabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "eventSpecificDetails": { + "instanceType": "JobStatus" + }, + "healthErrors": [ + { + "errorCode": "499", + "errorMessage": "An internal error occurred.", + "possibleCauses": "The operation failed due to an internal error.", + "recommendedAction": "Retry the last action. If the issue persists, contact Support." + } + ] + } + }, + { + "type": "Microsoft.RecoveryServices/vaults/replicationEvents", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationEvents/VmMonitoringEvent;9091989947769704276_516de684-0079-48f7-b44b-882923268654", + "name": "VmMonitoringEvent;9091989947769704276_516de684-0079-48f7-b44b-882923268654", + "properties": { + "eventCode": "d9a07b07-c7b5-49ca-ab6c-6926596dfe47", + "description": "Virtual machine health is OK", + "eventType": "VmHealth", + "affectedObjectFriendlyName": "vm1", + "severity": "OK", + "timeOfOccurrence": "2017-05-02T14:28:28.5071531Z", + "fabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "eventSpecificDetails": { + "instanceType": "JobStatus" + }, + "healthErrors": [] + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationFabrics_CheckConsistency.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationFabrics_CheckConsistency.json new file mode 100644 index 000000000000..a86fa511f32c --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationFabrics_CheckConsistency.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "name": "cloud1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "properties": { + "friendlyName": "cloud1", + "encryptionDetails": { + "kekState": "None" + }, + "rolloverEncryptionDetails": { + "kekState": "None" + }, + "internalIdentifier": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "bcdrState": "Valid", + "customDetails": { + "instanceType": "HyperVSite" + }, + "healthErrorDetails": [], + "health": "Normal" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationFabrics_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationFabrics_Create.json new file mode 100644 index 000000000000..c34de5d2a554 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationFabrics_Create.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "input": { + "properties": { + "customDetails": { + "instanceType": "FabricSpecificCreationInput" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "cloud1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "properties": { + "friendlyName": "cloud1", + "encryptionDetails": { + "kekState": "None" + }, + "rolloverEncryptionDetails": { + "kekState": "None" + }, + "internalIdentifier": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "bcdrState": "Valid", + "customDetails": { + "instanceType": "HyperVSite" + }, + "healthErrorDetails": [], + "health": "Normal" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationFabrics_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationFabrics_Delete.json new file mode 100644 index 000000000000..b1d24ddfa156 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationFabrics_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationFabrics_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationFabrics_Get.json new file mode 100644 index 000000000000..1146371c7b29 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationFabrics_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "name": "cloud1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "properties": { + "friendlyName": "cloud1", + "encryptionDetails": { + "kekState": "None" + }, + "rolloverEncryptionDetails": { + "kekState": "None" + }, + "internalIdentifier": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "bcdrState": "Valid", + "customDetails": { + "instanceType": "HyperVSite" + }, + "healthErrorDetails": [], + "health": "Normal" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationFabrics_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationFabrics_List.json new file mode 100644 index 000000000000..7edf56c3751f --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationFabrics_List.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "cloud1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "properties": { + "friendlyName": "cloud1", + "encryptionDetails": { + "kekState": "None" + }, + "rolloverEncryptionDetails": { + "kekState": "None" + }, + "internalIdentifier": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "bcdrState": "Valid", + "customDetails": { + "instanceType": "HyperVSite" + }, + "healthErrorDetails": [], + "health": "Normal" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationFabrics_MigrateToAad.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationFabrics_MigrateToAad.json new file mode 100644 index 000000000000..b1d24ddfa156 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationFabrics_MigrateToAad.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationFabrics_Purge.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationFabrics_Purge.json new file mode 100644 index 000000000000..b1d24ddfa156 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationFabrics_Purge.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationFabrics_ReassociateGateway.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationFabrics_ReassociateGateway.json new file mode 100644 index 000000000000..06989953b2b5 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationFabrics_ReassociateGateway.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "fabricName": "GRACE-V2A-1", + "api-version": "2021-04-01", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574", + "failoverProcessServerRequest": { + "properties": { + "containerName": "cloud_1f3c15af-2256-4568-9e06-e1ef4f728f75", + "sourceProcessServerId": "AFA0EC54-1894-4E44-9CAB02DB8854B117", + "targetProcessServerId": "5D3ED340-85AE-C646-B338641E015DA405", + "vmsToMigrate": [ + "Vm1", + "Vm2" + ], + "updateType": "ServerLevel" + } + } + }, + "responses": { + "200": { + "body": { + "name": "bc15edf300344660d9c2965f5d9225593d99734f6580613c997033abc3512a56", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics", + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationFabrics/bc15edf300344660d9c2965f5d9225593d99734f6580613c997033abc3512a56", + "properties": { + "friendlyName": "GRACE-V2A-1", + "encryptionDetails": { + "kekState": "None" + }, + "rolloverEncryptionDetails": { + "kekState": "None" + }, + "internalIdentifier": "1f3c15af-2256-4568-9e06-e1ef4f728f75", + "bcdrState": "Valid", + "customDetails": { + "instanceType": "VMware" + }, + "healthErrorDetails": [], + "health": "Normal" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationFabrics_RenewCertificate.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationFabrics_RenewCertificate.json new file mode 100644 index 000000000000..6b194faa515f --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationFabrics_RenewCertificate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "renewCertificate": { + "properties": { + "renewCertificateType": "Cloud" + } + } + }, + "responses": { + "200": { + "body": { + "name": "cloud1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "properties": { + "friendlyName": "cloud1", + "encryptionDetails": { + "kekState": "None" + }, + "rolloverEncryptionDetails": { + "kekState": "None" + }, + "internalIdentifier": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "bcdrState": "Valid", + "customDetails": { + "instanceType": "HyperVSite" + }, + "healthErrorDetails": [], + "health": "Normal" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationJobs_Cancel.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationJobs_Cancel.json new file mode 100644 index 000000000000..eefe92e1df7a --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationJobs_Cancel.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "jobName": "2653c648-fc72-4316-86f3-fdf8eaa0066b", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/2653c648-fc72-4316-86f3-fdf8eaa0066b", + "name": "2653c648-fc72-4316-86f3-fdf8eaa0066b", + "properties": { + "activityId": "bfbbf6dd-9cbb-4cbc-98a6-faecc8891579 ActivityId: 07cc35ca-b63f-4e42-83c9-81ae0191c322", + "scenarioName": "PlannedFailover", + "friendlyName": "Planned failover", + "state": "Cancelling", + "stateDescription": "Cancelling", + "tasks": [], + "errors": [], + "startTime": "2017-05-03T06:16:06.3235186Z", + "allowedActions": [], + "targetObjectId": "f8491e4f-817a-40dd-a90c-af773978c75b", + "targetObjectName": "vm1", + "targetInstanceType": "ProtectionEntity", + "customDetails": { + "instanceType": "AsrJobDetails", + "affectedObjectDetails": { + "PrimaryVmId": "f8491e4f-817a-40dd-a90c-af773978c75b", + "PrimaryVmName": "vm1", + "RecoveryVmId": "", + "RecoveryVmName": "vm1", + "ProtectionProfileId": "af095a1e-1f1b-5365-87c9-99162ebcfaf0", + "PrimaryCloudId": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "PrimaryCloudName": "cloud1", + "RecoveryCloudId": "d38048d4-b460-4791-8ece-108395ee8478", + "RecoveryCloudName": "Microsoft Azure", + "PrimaryVmmId": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "PrimaryVmmName": "cloud1", + "RecoveryVmmId": "21a9403c-6ec1-44f2-b744-b4e50b792387", + "RecoveryVmmName": "Microsoft Azure", + "PrimaryFabricProviderId": "HyperVSite", + "RecoveryFabricProviderId": "Azure" + } + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationJobs_Export.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationJobs_Export.json new file mode 100644 index 000000000000..5c9900784872 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationJobs_Export.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "jobQueryParameter": { + "startTime": "2017-04-27T14:26:51.9161395Z", + "endTime": "2017-05-04T14:26:51.9161395Z", + "affectedObjectTypes": "", + "jobStatus": "" + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/37e0fc2b-13f2-4817-aafa-0cd807d46842", + "name": "37e0fc2b-13f2-4817-aafa-0cd807d46842", + "properties": { + "activityId": "36841d27-34f6-49ad-b572-e7dc263f100b-2017-05-04 14:26:47Z-Ibz ActivityId: c124df21-7661-4541-b32a-3c723ebbb045", + "scenarioName": "ExportJobs", + "state": "Succeeded", + "stateDescription": "Completed", + "tasks": [], + "errors": [], + "startTime": "2017-05-04T14:33:42.2765562Z", + "endTime": "2017-05-04T14:33:43Z", + "allowedActions": [], + "targetObjectId": "", + "targetObjectName": "", + "targetInstanceType": "Other", + "customDetails": { + "blobUri": "", + "sasToken": "", + "instanceType": "ExportJobDetails", + "affectedObjectDetails": {} + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationJobs_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationJobs_Get.json new file mode 100644 index 000000000000..0878af38d36f --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationJobs_Get.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "jobName": "58776d0b-3141-48b2-a377-9ad863eb160d", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/32ea4b9e-de62-49a1-b062-7864d5c3b897", + "name": "32ea4b9e-de62-49a1-b062-7864d5c3b897", + "properties": { + "activityId": "fc8e9c8f-0e76-4b6b-8e7e-d37c1b31eba0 ActivityId: c506b6ba-0711-411e-8b09-1f3f4dcb824b", + "scenarioName": "DeleteRecoveryPlan", + "friendlyName": "Delete a recovery plan", + "state": "Succeeded", + "stateDescription": "Completed", + "tasks": [ + { + "taskId": "763326a2-01c9-4257-b2a1-0aac56465014", + "name": "DeleteRecoveryPlanTask", + "startTime": "2017-04-27T11:25:57.3029434Z", + "endTime": "2017-04-27T11:25:57.318574Z", + "allowedActions": [], + "friendlyName": "Delete a recovery plan task", + "state": "Succeeded", + "stateDescription": "Completed", + "taskType": "TaskDetails", + "customDetails": { + "instanceType": "ManualActionTaskDetails" + }, + "errors": [] + } + ], + "errors": [], + "startTime": "2017-04-27T11:25:56.800358Z", + "endTime": "2017-04-27T11:25:57Z", + "allowedActions": [], + "targetObjectId": "966c33bb-66e7-4567-9786-f80b0694f5f9", + "targetObjectName": "RPtest1", + "targetInstanceType": "RecoveryPlan", + "customDetails": { + "instanceType": "AsrJobDetails", + "affectedObjectDetails": { + "PrimaryVmmId": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "PrimaryVmmName": "cloud1", + "RecoveryVmmId": "21a9403c-6ec1-44f2-b744-b4e50b792387", + "PrimaryFabricProviderId": "HyperVSite", + "RecoveryFabricProviderId": "Azure" + } + } + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationJobs_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationJobs_List.json new file mode 100644 index 000000000000..29656cca1bb7 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationJobs_List.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/1557d73f-6244-491e-8f0b-d300f752240b", + "name": "1557d73f-6244-491e-8f0b-d300f752240b", + "properties": { + "scenarioName": "AddProtectionProfile", + "friendlyName": "Create replication policy", + "state": "Succeeded", + "stateDescription": "Completed", + "tasks": [], + "errors": [], + "startTime": "2017-04-27T12:46:04.641851Z", + "endTime": "2017-04-27T12:46:11Z", + "allowedActions": [], + "targetObjectId": "af095a1e-1f1b-5365-87c9-99162ebcfaf0", + "targetObjectName": "protectionprofile1", + "targetInstanceType": "ProtectionProfile" + } + }, + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/0236416a-7573-4913-a4a1-6a286fbb1ceb", + "name": "0236416a-7573-4913-a4a1-6a286fbb1ceb", + "properties": { + "scenarioName": "RegisterDra", + "friendlyName": "Register the Azure Site Recovery Provider", + "state": "Succeeded", + "stateDescription": "Completed", + "tasks": [], + "errors": [], + "startTime": "2017-05-02T14:07:19.2784338Z", + "endTime": "2017-05-02T14:07:21Z", + "allowedActions": [], + "targetObjectId": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "targetObjectName": "CP-B3L40406-12.ntdev.corp.microsoft.com", + "targetInstanceType": "Server" + } + }, + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/2438d560-80f0-420b-839e-5c8ee0af90a1", + "name": "2438d560-80f0-420b-839e-5c8ee0af90a1", + "properties": { + "scenarioName": "CreateSite", + "friendlyName": "Create a site", + "state": "Succeeded", + "stateDescription": "Completed", + "tasks": [], + "errors": [], + "startTime": "2017-05-02T05:56:14.569095Z", + "endTime": "2017-05-02T05:56:16Z", + "allowedActions": [], + "targetObjectId": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "targetObjectName": "cloud1", + "targetInstanceType": "Server" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationJobs_Restart.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationJobs_Restart.json new file mode 100644 index 000000000000..c001fec48a89 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationJobs_Restart.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "jobName": "0664564c-353e-401a-ab0c-722257c10e25", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/42c7d13b-790c-4609-8e0b-0936f1c5e5fb", + "name": "42c7d13b-790c-4609-8e0b-0936f1c5e5fb", + "properties": { + "activityId": "2443a5b4-e675-499f-8983-4126ea0e232c ActivityId: 2a776896-5e56-470b-af55-3c981283c4bc", + "scenarioName": "RestartJob", + "friendlyName": "Restart job", + "state": "Succeeded", + "stateDescription": "Completed", + "tasks": [ + { + "taskId": "RemediateWfTask", + "name": "RemediateTask", + "startTime": "2017-05-03T10:45:13.5677237Z", + "endTime": "2017-05-03T10:45:13.6458467Z", + "allowedActions": [], + "friendlyName": "Restarting job", + "state": "Succeeded", + "stateDescription": "Completed", + "taskType": "TaskDetails", + "customDetails": { + "instanceType": "ManualActionTaskDetails" + }, + "errors": [] + } + ], + "errors": [], + "startTime": "2017-05-03T10:45:12.1320757Z", + "endTime": "2017-05-03T10:45:14Z", + "allowedActions": [], + "targetObjectId": "f8491e4f-817a-40dd-a90c-af773978c75b", + "targetObjectName": "vm1", + "targetInstanceType": "ProtectionEntity", + "customDetails": { + "instanceType": "AsrJobDetails", + "affectedObjectDetails": {} + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationJobs_Resume.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationJobs_Resume.json new file mode 100644 index 000000000000..c5fdad827477 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationJobs_Resume.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "jobName": "58776d0b-3141-48b2-a377-9ad863eb160d", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "resumeJobParams": { + "properties": { + "comments": " " + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/58776d0b-3141-48b2-a377-9ad863eb160d", + "name": "58776d0b-3141-48b2-a377-9ad863eb160d", + "properties": { + "activityId": "1b808dfe-0451-44ac-894c-c7270711cd8c ActivityId: 9f6f849e-922a-43ec-a7a6-0be45fc85c56", + "scenarioName": "TestFailover", + "friendlyName": "Test failover", + "state": "Suspended", + "stateDescription": "WaitingForStopTestFailover", + "tasks": [], + "errors": [], + "startTime": "2017-04-25T09:57:57.0357829Z", + "allowedActions": [ + "Cancel", + "Resume" + ], + "targetObjectId": "f8491e4f-817a-40dd-a90c-af773978c75b", + "targetObjectName": "vm1", + "targetInstanceType": "ProtectionEntity", + "customDetails": { + "instanceType": "TestFailoverJobDetails", + "testFailoverStatus": "Completed", + "comments": " ", + "networkName": "vnetavrai", + "networkFriendlyName": "vnetavrai", + "networkType": "VmNetworkAsInput", + "protectedItemDetails": [ + { + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "friendlyName": "vm1", + "testVmName": "vm1-test", + "testVmFriendlyName": "vm1-test", + "networkConnectionStatus": "Connected", + "networkFriendlyName": "vnetavrai", + "subnet": "Subnet1" + } + ], + "affectedObjectDetails": { + "PrimaryVmId": "f8491e4f-817a-40dd-a90c-af773978c75b", + "PrimaryVmName": "vm1", + "RecoveryVmId": "", + "RecoveryVmName": "vm1", + "ProtectionProfileId": "af095a1e-1f1b-5365-87c9-99162ebcfaf0", + "PrimaryCloudId": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "PrimaryCloudName": "cloud1", + "RecoveryCloudId": "d38048d4-b460-4791-8ece-108395ee8478", + "RecoveryCloudName": "Microsoft Azure", + "PrimaryVmmId": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "PrimaryVmmName": "cloud1", + "RecoveryVmmId": "21a9403c-6ec1-44f2-b744-b4e50b792387", + "RecoveryVmmName": "Microsoft Azure", + "PrimaryFabricProviderId": "HyperVSite", + "RecoveryFabricProviderId": "Azure" + } + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationLogicalNetworks_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationLogicalNetworks_Get.json new file mode 100644 index 000000000000..0291dd244d19 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationLogicalNetworks_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "logicalNetworkName": "87ab394f-165f-4aa9-bd84-b018500b4509", + "fabricName": "cloud1", + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationLogicalNetworks", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationLogicalNetworks/53f5a278-ae85-4001-bd5f-f6a02e1f579d", + "name": "87ab394f-165f-4aa9-bd84-b018500b4509", + "properties": { + "friendlyName": "corp", + "networkVirtualizationStatus": "NetworkVirtualizationNotEnabled", + "logicalNetworkUsage": "NotUsedAsPrivateNetworkForTestFailover", + "logicalNetworkDefinitionsStatus": "LogicalNetworkDefinitionsNotIsolated" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationLogicalNetworks_ListByReplicationFabrics.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationLogicalNetworks_ListByReplicationFabrics.json new file mode 100644 index 000000000000..bc3e8fe7c92b --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationLogicalNetworks_ListByReplicationFabrics.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationLogicalNetworks", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationLogicalNetworks/53f5a278-ae85-4001-bd5f-f6a02e1f579d", + "name": "87ab394f-165f-4aa9-bd84-b018500b4509", + "properties": { + "friendlyName": "corp", + "networkVirtualizationStatus": "NetworkVirtualizationNotEnabled", + "logicalNetworkUsage": "NotUsedAsPrivateNetworkForTestFailover", + "logicalNetworkDefinitionsStatus": "LogicalNetworkDefinitionsNotIsolated" + } + }, + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationLogicalNetworks", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationLogicalNetworks/87ab394f-165f-4aa9-bd84-b018500b4509", + "name": "53f5a278-ae85-4001-bd5f-f6a02e1f579d", + "properties": { + "friendlyName": "LN-VLANNetwork-4", + "networkVirtualizationStatus": "NetworkVirtualizationNotEnabled", + "logicalNetworkUsage": "NotUsedAsPrivateNetworkForTestFailover", + "logicalNetworkDefinitionsStatus": "LogicalNetworkDefinitionsIsolated" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationMigrationItems_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationMigrationItems_Create.json new file mode 100644 index 000000000000..71dd6c63af65 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationMigrationItems_Create.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "input": { + "properties": { + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "providerSpecificDetails": { + "instanceType": "VMwareCbt", + "disksToInclude": [ + { + "diskId": "disk1", + "isOSDisk": "true", + "logStorageAccountId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.Storage/storageAccounts/logStorageAccount1", + "logStorageAccountSasSecretName": "logStorageSas" + } + ], + "vmwareMachineId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.OffAzure/VMwareSites/vmwaresite1/machines/virtualmachine1", + "targetNetworkId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1", + "targetResourceGroupId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1", + "snapshotRunAsAccountId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.OffAzure/VMwareSites/vmwaresite1/runasaccounts/snapshotRunAsAccount1", + "dataMoverRunAsAccountId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.OffAzure/VMwareSites/vmwaresite1/runasaccounts/dataMoverRunAsAccount1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationMigrationItems_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationMigrationItems_Delete.json new file mode 100644 index 000000000000..07bb2d5a3ab5 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationMigrationItems_Delete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationMigrationItems_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationMigrationItems_Get.json new file mode 100644 index 000000000000..dc24c5f5803e --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationMigrationItems_Get.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationMigrationItems_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationMigrationItems_List.json new file mode 100644 index 000000000000..5dfcd01315ce --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationMigrationItems_List.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationMigrationItems_ListByReplicationProtectionContainers.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationMigrationItems_ListByReplicationProtectionContainers.json new file mode 100644 index 000000000000..4cf0289a243e --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationMigrationItems_ListByReplicationProtectionContainers.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationMigrationItems_Migrate.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationMigrationItems_Migrate.json new file mode 100644 index 000000000000..3398cde2967d --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationMigrationItems_Migrate.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "migrateInput": { + "properties": { + "providerSpecificDetails": { + "instanceType": "VMwareCbt", + "performShutdown": "true" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationMigrationItems_Resync.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationMigrationItems_Resync.json new file mode 100644 index 000000000000..0297986502e5 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationMigrationItems_Resync.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "input": { + "properties": { + "providerSpecificDetails": { + "instanceType": "VMwareCbt", + "skipCbtReset": "true" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationMigrationItems_TestMigrate.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationMigrationItems_TestMigrate.json new file mode 100644 index 000000000000..ae82bafb4de3 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationMigrationItems_TestMigrate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "testMigrateInput": { + "properties": { + "providerSpecificDetails": { + "instanceType": "VMwareCbt", + "recoveryPointId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1/migrationRecoveryPoints/9e737191-317e-43d0-8c83-e32ac3b34686", + "networkId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationMigrationItems_TestMigrateCleanup.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationMigrationItems_TestMigrateCleanup.json new file mode 100644 index 000000000000..5e1ea5740cde --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationMigrationItems_TestMigrateCleanup.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "testMigrateCleanupInput": { + "properties": { + "comments": "Test Failover Cleanup" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationMigrationItems_Update.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationMigrationItems_Update.json new file mode 100644 index 000000000000..6caaa24a166f --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationMigrationItems_Update.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "input": { + "properties": { + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationNetworkMappings_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationNetworkMappings_Create.json new file mode 100644 index 000000000000..76ad8cc6644f --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationNetworkMappings_Create.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "fabricName": "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac", + "api-version": "2021-04-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071", + "networkName": "e2267b5c-2650-49bd-ab3f-d66aae694c06", + "networkMappingName": "corpe2amap", + "input": { + "properties": { + "recoveryFabricName": "Microsoft Azure", + "recoveryNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "fabricSpecificDetails": { + "instanceType": "VmmToAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06/replicationNetworkMappings/corpe2amap", + "name": "corpe2amap", + "properties": { + "state": "Paired", + "primaryNetworkFriendlyName": "corp", + "primaryNetworkId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06", + "primaryFabricFriendlyName": "CP-B3L30108-01.ntdev.corp.microsoft.com", + "recoveryNetworkFriendlyName": "vnetavrai", + "recoveryNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "recoveryFabricArmId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5", + "recoveryFabricFriendlyName": "Microsoft Azure", + "fabricSpecificSettings": { + "instanceType": "VmmToAzure" + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationNetworkMappings_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationNetworkMappings_Delete.json new file mode 100644 index 000000000000..fd177243e5a7 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationNetworkMappings_Delete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "fabricName": "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac", + "api-version": "2021-04-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071", + "networkName": "e2267b5c-2650-49bd-ab3f-d66aae694c06", + "networkMappingName": "corpe2amap" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationNetworkMappings_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationNetworkMappings_Get.json new file mode 100644 index 000000000000..91120dd54915 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationNetworkMappings_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "fabricName": "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac", + "api-version": "2021-04-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071", + "networkName": "e2267b5c-2650-49bd-ab3f-d66aae694c06", + "networkMappingName": "corpe2amap" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06/replicationNetworkMappings/corpe2amap", + "name": "corpe2amap", + "properties": { + "state": "Paired", + "primaryNetworkFriendlyName": "corp", + "primaryNetworkId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06", + "primaryFabricFriendlyName": "CP-B3L30108-01.ntdev.corp.microsoft.com", + "recoveryNetworkFriendlyName": "vnetavrai", + "recoveryNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "recoveryFabricArmId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5", + "recoveryFabricFriendlyName": "Microsoft Azure", + "fabricSpecificSettings": { + "instanceType": "VmmToAzure" + } + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationNetworkMappings_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationNetworkMappings_List.json new file mode 100644 index 000000000000..98f420fa50ce --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationNetworkMappings_List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.RecoveryServicesBVTD2/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServicesBVTD2/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06/replicationNetworkMappings/corpe2amap", + "name": "corpe2amap", + "properties": { + "state": "Paired", + "primaryNetworkFriendlyName": "corp", + "primaryNetworkId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServicesBVTD2/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06", + "primaryFabricFriendlyName": "CP-B3L30108-01.ntdev.corp.microsoft.com", + "recoveryNetworkFriendlyName": "vnetavrai", + "recoveryNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "recoveryFabricArmId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServicesBVTD2/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5", + "recoveryFabricFriendlyName": "Microsoft Azure", + "fabricSpecificSettings": { + "instanceType": "VmmToAzure" + } + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationNetworkMappings_ListByReplicationNetworks.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationNetworkMappings_ListByReplicationNetworks.json new file mode 100644 index 000000000000..254ab2b04bd5 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationNetworkMappings_ListByReplicationNetworks.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "networkName": "e2267b5c-2650-49bd-ab3f-d66aae694c06", + "fabricName": "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac", + "api-version": "2021-04-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06/replicationNetworkMappings/corpe2amap", + "name": "corpe2amap", + "properties": { + "state": "Paired", + "primaryNetworkFriendlyName": "corp", + "primaryNetworkId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06", + "primaryFabricFriendlyName": "CP-B3L30108-01.ntdev.corp.microsoft.com", + "recoveryNetworkFriendlyName": "vnetavrai", + "recoveryNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "recoveryFabricArmId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5", + "recoveryFabricFriendlyName": "Microsoft Azure", + "fabricSpecificSettings": { + "instanceType": "VmmToAzure" + } + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationNetworkMappings_Update.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationNetworkMappings_Update.json new file mode 100644 index 000000000000..275e65e562b1 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationNetworkMappings_Update.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "fabricName": "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac", + "api-version": "2021-04-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071", + "networkName": "e2267b5c-2650-49bd-ab3f-d66aae694c06", + "networkMappingName": "corpe2amap", + "input": { + "properties": { + "recoveryFabricName": "Microsoft Azure", + "recoveryNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai2", + "fabricSpecificDetails": { + "instanceType": "VmmToAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06/replicationNetworkMappings/corpe2amap", + "name": "corpe2amap", + "properties": { + "state": "Paired", + "primaryNetworkFriendlyName": "corp", + "primaryNetworkId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06", + "primaryFabricFriendlyName": "CP-B3L30108-01.ntdev.corp.microsoft.com", + "recoveryNetworkFriendlyName": "vnetavrai2", + "recoveryNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai2", + "recoveryFabricArmId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5", + "recoveryFabricFriendlyName": "Microsoft Azure", + "fabricSpecificSettings": { + "instanceType": "VmmToAzure" + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationNetworks_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationNetworks_Get.json new file mode 100644 index 000000000000..66e5a9855ea4 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationNetworks_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "fabricName": "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac", + "api-version": "2021-04-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071", + "networkName": "93ce99d7-1219-4914-aa61-73fe5023988e" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/93ce99d7-1219-4914-aa61-73fe5023988e", + "name": "93ce99d7-1219-4914-aa61-73fe5023988e", + "properties": { + "fabricType": "VMM", + "subnets": [], + "friendlyName": "VSwitch_VLan", + "networkType": "NoIsolation" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationNetworks_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationNetworks_List.json new file mode 100644 index 000000000000..cc25cc656a31 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationNetworks_List.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/93ce99d7-1219-4914-aa61-73fe5023988e", + "name": "93ce99d7-1219-4914-aa61-73fe5023988e", + "properties": { + "fabricType": "VMM", + "subnets": [], + "friendlyName": "VSwitch_VLan", + "networkType": "NoIsolation" + } + }, + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/b83bf8fd-f304-48d7-82c9-5d74e6215c1b", + "name": "b83bf8fd-f304-48d7-82c9-5d74e6215c1b", + "properties": { + "fabricType": "VMM", + "subnets": [], + "friendlyName": "VSwitch_NoIso", + "networkType": "NoIsolation" + } + }, + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06", + "name": "e2267b5c-2650-49bd-ab3f-d66aae694c06", + "properties": { + "fabricType": "VMM", + "subnets": [], + "friendlyName": "corp", + "networkType": "NoIsolation" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationNetworks_ListByReplicationFabrics.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationNetworks_ListByReplicationFabrics.json new file mode 100644 index 000000000000..74221cb8e84b --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationNetworks_ListByReplicationFabrics.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "fabricName": "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac", + "api-version": "2021-04-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/93ce99d7-1219-4914-aa61-73fe5023988e", + "name": "93ce99d7-1219-4914-aa61-73fe5023988e", + "properties": { + "fabricType": "VMM", + "subnets": [], + "friendlyName": "VSwitch_VLan", + "networkType": "NoIsolation" + } + }, + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/b83bf8fd-f304-48d7-82c9-5d74e6215c1b", + "name": "b83bf8fd-f304-48d7-82c9-5d74e6215c1b", + "properties": { + "fabricType": "VMM", + "subnets": [], + "friendlyName": "VSwitch_NoIso", + "networkType": "NoIsolation" + } + }, + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06", + "name": "e2267b5c-2650-49bd-ab3f-d66aae694c06", + "properties": { + "fabricType": "VMM", + "subnets": [], + "friendlyName": "corp", + "networkType": "NoIsolation" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationPolicies_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationPolicies_Create.json new file mode 100644 index 000000000000..ff526f4b2f01 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationPolicies_Create.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "policyName": "protectionprofile1", + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "input": { + "properties": { + "providerSpecificInput": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "name": "protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationPolicies", + "properties": { + "friendlyName": "protectionprofile1", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationPolicies_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationPolicies_Delete.json new file mode 100644 index 000000000000..f3c30d349f60 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationPolicies_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "policyName": "protectionprofile1", + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationPolicies_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationPolicies_Get.json new file mode 100644 index 000000000000..8e8fa2625b33 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationPolicies_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "policyName": "protectionprofile1", + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "name": "protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationPolicies", + "properties": { + "friendlyName": "protectionprofile1", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationPolicies_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationPolicies_List.json new file mode 100644 index 000000000000..dc8cee93b877 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationPolicies_List.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "name": "protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationPolicies", + "properties": { + "friendlyName": "protectionprofile1", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationPolicies_Update.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationPolicies_Update.json new file mode 100644 index 000000000000..32bb6a8586af --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationPolicies_Update.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "policyName": "protectionprofile1", + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "input": { + "properties": { + "replicationProviderSettings": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "name": "protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationPolicies", + "properties": { + "friendlyName": "protectionprofile1", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectableItems_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectableItems_Get.json new file mode 100644 index 000000000000..f30a23bf1b1e --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectableItems_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "protectableItemName": "c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "name": "c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectableItems", + "properties": { + "friendlyName": "vm2", + "protectionStatus": "Unprotected", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "protectionReadinessErrors": [], + "supportedReplicationProviders": [ + "HyperVReplicaAzure" + ], + "customDetails": { + "instanceType": "HyperVVirtualMachine" + } + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectableItems_ListByReplicationProtectionContainers.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectableItems_ListByReplicationProtectionContainers.json new file mode 100644 index 000000000000..60b4f513ef68 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectableItems_ListByReplicationProtectionContainers.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "name": "c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectableItems", + "properties": { + "friendlyName": "vm2", + "protectionStatus": "Unprotected", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "protectionReadinessErrors": [], + "supportedReplicationProviders": [ + "HyperVReplicaAzure" + ], + "customDetails": { + "instanceType": "HyperVVirtualMachine" + } + } + }, + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectableItems", + "properties": { + "friendlyName": "vm1", + "protectionStatus": "Unprotected", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "protectionReadinessErrors": [], + "supportedReplicationProviders": [ + "HyperVReplicaAzure" + ], + "customDetails": { + "instanceType": "HyperVVirtualMachine" + } + } + } + ], + "nextLink": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems?api-version=2021-04-01&%24skipToken=ReplicationGroup%3aBegin" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_AddDisks.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_AddDisks.json new file mode 100644 index 000000000000..0cacfca64c65 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_AddDisks.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "addDisksInput": { + "properties": { + "providerSpecificDetails": { + "instanceType": "A2A", + "vmDisks": [ + { + "diskUri": "https://vmstorage.blob.core.windows.net/vhds/datadisk1.vhd", + "recoveryAzureStorageAccountId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourcegroups/recoveryResource/providers/Microsoft.Storage/storageAccounts/recoverystorage", + "primaryStagingAzureStorageAccountId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourcegroups/primaryResource/providers/Microsoft.Storage/storageAccounts/vmcachestorage" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectedItemType": "", + "protectableItemId": null, + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/6d2940f9-4c34-5989-9f56-1243a6e76ecf", + "primaryFabricFriendlyName": "cloud1", + "primaryFabricProvider": "AzureFabric", + "recoveryFabricFriendlyName": "cloud2", + "recoveryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud2", + "primaryProtectionContainerFriendlyName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "recoveryProtectionContainerFriendlyName": "cloud_81224fc6-f326-5d35-96de-fbf51efb3188", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "RepairReplication", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "failoverHealth": "Normal", + "healthErrors": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/A2APolicy", + "policyFriendlyName": "A2APolicy", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1752-12-31T19:31:01Z" + }, + "failoverRecoveryPointId": null, + "providerSpecificDetails": { + "instanceType": "A2A" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud2/replicationProtectionContainers/cloud_81224fc6-f326-5d35-96de-fbf51efb3188" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_ApplyRecoveryPoint.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_ApplyRecoveryPoint.json new file mode 100644 index 000000000000..5c481decc3cf --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_ApplyRecoveryPoint.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "applyRecoveryPointInput": { + "properties": { + "recoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/e4d05fe9-5dfd-47be-b50b-aad306b2802d", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "UnplannedFailoverCommitPendingStatesBegin", + "protectionStateDescription": "Failover completed", + "activeLocation": "Recovery", + "testFailoverState": "MarkedForDeletion", + "testFailoverStateDescription": "Cleaning up test environment", + "allowedOperations": [ + "CompleteMigration", + "Commit", + "DisableProtection", + "ChangePit" + ], + "replicationHealth": "Critical", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "lastSuccessfulFailoverTime": "2017-04-26T08:42:33.0996129Z", + "lastSuccessfulTestFailoverTime": "2017-04-25T09:57:57.0357829Z", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/e4d05fe9-5dfd-47be-b50b-aad306b2802d", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_Create.json new file mode 100644 index 000000000000..60d729193d19 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_Create.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "input": { + "properties": { + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_Delete.json new file mode 100644 index 000000000000..fc9d1aecb11c --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "replicatedProtectedItemName": "c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "disableProtectionInput": { + "properties": { + "replicationProviderInput": { + "instanceType": "DisableProtectionProviderSpecificInput" + } + } + } + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_FailoverCancel.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_FailoverCancel.json new file mode 100644 index 000000000000..9cf4bca26eeb --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_FailoverCancel.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "cloud1", + "recoveryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "cloud1", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "PlannedFailover", + "DisableProtection" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "lastSuccessfulFailoverTime": "2021-02-24T06:37:23.1578655Z", + "lastSuccessfulTestFailoverTime": "1601-01-01T00:00:00.0000000Z", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "2021-02-24T07:17:23.1358752Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "providerSpecificDetails": { + "instanceType": "InMageRcmFailback" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_FailoverCommit.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_FailoverCommit.json new file mode 100644 index 000000000000..678e48c80dae --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_FailoverCommit.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "PlannedFailoverStatesBegin", + "protectionStateDescription": "Planned failover committed", + "activeLocation": "Recovery", + "testFailoverState": "MarkedForDeletion", + "testFailoverStateDescription": "Cleaning up test environment", + "allowedOperations": [ + "CompleteMigration", + "DisableProtection", + "Failback" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "lastSuccessfulFailoverTime": "2017-04-26T06:37:23.1578655Z", + "lastSuccessfulTestFailoverTime": "2017-04-25T09:57:57.0357829Z", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_Get.json new file mode 100644 index 000000000000..f579d04f5fe3 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_Get.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_List.json new file mode 100644 index 000000000000..c191ff86ef66 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_List.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_ListByReplicationProtectionContainers.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_ListByReplicationProtectionContainers.json new file mode 100644 index 000000000000..f65885adf899 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_ListByReplicationProtectionContainers.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_PlannedFailover.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_PlannedFailover.json new file mode 100644 index 000000000000..0eb188afafe0 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_PlannedFailover.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "failoverInput": { + "properties": { + "failoverDirection": "PrimaryToRecovery", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "PlannedFailoverCommitRequired", + "protectionStateDescription": "Planned failover finished", + "activeLocation": "Recovery", + "testFailoverState": "MarkedForDeletion", + "testFailoverStateDescription": "Cleaning up test environment", + "allowedOperations": [ + "CompleteMigration", + "Commit", + "DisableProtection", + "ChangePit" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "lastSuccessfulFailoverTime": "2017-04-26T06:37:23.1578655Z", + "lastSuccessfulTestFailoverTime": "2017-04-25T09:57:57.0357829Z", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_Purge.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_Purge.json new file mode 100644 index 000000000000..6c0291ff68f0 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_Purge.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "replicatedProtectedItemName": "c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_RemoveDisks.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_RemoveDisks.json new file mode 100644 index 000000000000..8999b524e89d --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_RemoveDisks.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "removeDisksInput": { + "properties": { + "providerSpecificDetails": { + "instanceType": "A2A", + "vmDisksUris": [ + "https://vmstorage.blob.core.windows.net/vhds/datadisk1.vhd" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectedItemType": "", + "protectableItemId": null, + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/6d2940f9-4c34-5989-9f56-1243a6e76ecf", + "primaryFabricFriendlyName": "cloud1", + "primaryFabricProvider": "AzureFabric", + "recoveryFabricFriendlyName": "cloud2", + "recoveryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud2", + "primaryProtectionContainerFriendlyName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "recoveryProtectionContainerFriendlyName": "cloud_81224fc6-f326-5d35-96de-fbf51efb3188", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "RepairReplication", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "failoverHealth": "Normal", + "healthErrors": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/A2APolicy", + "policyFriendlyName": "A2APolicy", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1752-12-31T19:31:01Z" + }, + "failoverRecoveryPointId": null, + "providerSpecificDetails": { + "instanceType": "A2A" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud2/replicationProtectionContainers/cloud_81224fc6-f326-5d35-96de-fbf51efb3188" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_RepairReplication.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_RepairReplication.json new file mode 100644 index 000000000000..b74ea6f2c12b --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_RepairReplication.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_Reprotect.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_Reprotect.json new file mode 100644 index 000000000000..5e7e11331c8a --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_Reprotect.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "reprotectInput": { + "properties": { + "failoverDirection": "PrimaryToRecovery", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "MarkedForDeletion", + "testFailoverStateDescription": "Cleaning up test environment", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "lastSuccessfulFailoverTime": "2017-04-26T06:37:23.1578655Z", + "lastSuccessfulTestFailoverTime": "2017-04-25T09:57:57.0357829Z", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_ResolveHealthErrors.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_ResolveHealthErrors.json new file mode 100644 index 000000000000..e9370777acdc --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_ResolveHealthErrors.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "resolveHealthInput": { + "properties": { + "healthErrors": [ + { + "healthErrorId": "3:8020" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectedItemType": "", + "protectableItemId": null, + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/6d2940f9-4c34-5989-9f56-1243a6e76ecf", + "primaryFabricFriendlyName": "cloud1", + "primaryFabricProvider": "AzureFabric", + "recoveryFabricFriendlyName": "cloud2", + "recoveryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud2", + "primaryProtectionContainerFriendlyName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "recoveryProtectionContainerFriendlyName": "cloud_81224fc6-f326-5d35-96de-fbf51efb3188", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "RepairReplication", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "failoverHealth": "Normal", + "healthErrors": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/A2APolicy", + "policyFriendlyName": "A2APolicy", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1752-12-31T19:31:01Z" + }, + "failoverRecoveryPointId": null, + "providerSpecificDetails": { + "instanceType": "A2A" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud2/replicationProtectionContainers/cloud_81224fc6-f326-5d35-96de-fbf51efb3188" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_TestFailover.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_TestFailover.json new file mode 100644 index 000000000000..66f7b8d29a71 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_TestFailover.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "testfailoverInput": { + "properties": { + "failoverDirection": "PrimaryToRecovery", + "networkType": "VmNetworkAsInput", + "networkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Cleanup test failover pending", + "activeLocation": "Primary", + "testFailoverState": "WaitingForCompletion", + "testFailoverStateDescription": "Waiting for user input", + "allowedOperations": [ + "TestFailoverCleanup" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "currentScenario": { + "scenarioName": "TestFailover", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/2838f9b4-2609-4f76-a7e9-07e6387c5e98", + "startTime": "2017-04-25T09:57:57.0357829Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/0689d0d0-3518-4793-8c98-c26bf94526f6", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_TestFailoverCleanup.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_TestFailoverCleanup.json new file mode 100644 index 000000000000..1ffe52c3d60a --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_TestFailoverCleanup.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "cleanupInput": { + "properties": { + "comments": "Test Failover Cleanup" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "MarkedForDeletion", + "testFailoverStateDescription": "Cleaning up test environment", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "lastSuccessfulFailoverTime": "2017-04-26T06:37:23.1578655Z", + "lastSuccessfulTestFailoverTime": "2017-04-25T09:57:57.0357829Z", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_UnplannedFailover.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_UnplannedFailover.json new file mode 100644 index 000000000000..5eb674eee78d --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_UnplannedFailover.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "failoverInput": { + "properties": { + "failoverDirection": "PrimaryToRecovery", + "sourceSiteOperations": "NotRequired", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "UnplannedFailoverCommitPendingStatesBegin", + "protectionStateDescription": "Failover completed", + "activeLocation": "Recovery", + "testFailoverState": "MarkedForDeletion", + "testFailoverStateDescription": "Cleaning up test environment", + "allowedOperations": [ + "CompleteMigration", + "Commit", + "DisableProtection", + "ChangePit" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "lastSuccessfulFailoverTime": "2017-04-26T08:42:33.0996129Z", + "lastSuccessfulTestFailoverTime": "2017-04-25T09:57:57.0357829Z", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b2c7b208-0999-40a4-804f-8ee1019c8f76", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_Update.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_Update.json new file mode 100644 index 000000000000..725644fd1257 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_Update.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "updateProtectionInput": { + "properties": { + "recoveryAzureVMName": "vm1", + "recoveryAzureVMSize": "Basic_A0", + "selectedRecoveryAzureNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "vmNics": [ + { + "nicId": "TWljcm9zb2Z0OkY4NDkxRTRGLTgxN0EtNDBERC1BOTBDLUFGNzczOTc4Qzc1Qlw3NjAwMzMxRS03NDk4LTQ0QTQtQjdDNy0xQjY1NkJDREQ1MkQ=", + "selectionType": "SelectedByUser", + "ipConfigs": [ + { + "ipConfigName": "ipconfig1", + "isPrimary": true, + "recoverySubnetName": "subnet1", + "recoveryStaticIPAddress": "10.0.2.46" + } + ] + } + ], + "licenseType": "WindowsServer", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_UpdateMobilityService.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_UpdateMobilityService.json new file mode 100644 index 000000000000..e9ef08304b6d --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectedItems_UpdateMobilityService.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "replicationProtectedItemName": "79dd20ab-2b40-11e7-9791-0050568f387e", + "protectionContainerName": "cloud_c6780228-83bd-4f3e-a70e-cb46b7da33a0", + "fabricName": "WIN-JKKJ31QI8U2", + "resourceName": "WCUSVault", + "resourceGroupName": "wcusValidations", + "subscriptionId": "b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c", + "updateMobilityServiceRequest": { + "properties": { + "runAsAccountId": "2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "79dd20ab-2b40-11e7-9791-0050568f387e", + "id": "/Subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/wcusValidations/providers/Microsoft.RecoveryServices/vaults/WCUSVault/replicationFabrics/d70b0326a201008a953505ef271dc908e5e23468bc7356862ea178696f5f15c7/replicationProtectionContainers/cloud_c6780228-83bd-4f3e-a70e-cb46b7da33a0/replicationProtectedItems/79dd20ab-2b40-11e7-9791-0050568f387e", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "MMR-LIN-V2A-3", + "protectedItemType": "", + "protectableItemId": "/Subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/wcusValidations/providers/Microsoft.RecoveryServices/vaults/WCUSVault/replicationFabrics/d70b0326a201008a953505ef271dc908e5e23468bc7356862ea178696f5f15c7/replicationProtectionContainers/cloud_c6780228-83bd-4f3e-a70e-cb46b7da33a0/replicationProtectableItems/79dd20ab-2b40-11e7-9791-0050568f387e", + "recoveryServicesProviderId": "/Subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/wcusValidations/providers/Microsoft.RecoveryServices/vaults/WCUSVault/replicationFabrics/d70b0326a201008a953505ef271dc908e5e23468bc7356862ea178696f5f15c7/replicationRecoveryServicesProviders/c6780228-83bd-4f3e-a70e-cb46b7da33a0", + "primaryFabricFriendlyName": "WIN-JKKJ31QI8U2", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "WIN-JKKJ31QI8U2", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/wcusValidations/providers/Microsoft.RecoveryServices/vaults/WCUSVault/replicationPolicies/MadhaviPolicyNew", + "policyFriendlyName": "MadhaviPolicyNew", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/wcusValidations/providers/Microsoft.RecoveryServices/vaults/WCUSVault/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "providerSpecificDetails": { + "instanceType": "InMageAzureV2" + }, + "recoveryContainerId": "/Subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/wcusValidations/providers/Microsoft.RecoveryServices/vaults/WCUSVault/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainerMappings_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainerMappings_Create.json new file mode 100644 index 000000000000..61532c745c85 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainerMappings_Create.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "mappingName": "cloud1protectionprofile1", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "creationInput": { + "properties": { + "targetProtectionContainerId": "Microsoft Azure", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "providerSpecificInput": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectionContainerMappings/cloud1protectionprofile1", + "name": "cloud1protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings", + "properties": { + "targetProtectionContainerId": "Microsoft Azure", + "targetProtectionContainerFriendlyName": "Microsoft Azure", + "health": "Normal", + "healthErrorDetails": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "state": "Paired", + "sourceProtectionContainerFriendlyName": "cloud1", + "sourceFabricFriendlyName": "cloud1", + "targetFabricFriendlyName": "Microsoft Azure", + "policyFriendlyName": "protectionprofile1" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainerMappings_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainerMappings_Delete.json new file mode 100644 index 000000000000..4a0f4f2257e3 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainerMappings_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "mappingName": "cloud1protectionprofile1", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "removalInput": { + "properties": { + "providerSpecificInput": {} + } + } + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainerMappings_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainerMappings_Get.json new file mode 100644 index 000000000000..694e926d992d --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainerMappings_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "mappingName": "cloud1protectionprofile1", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectionContainerMappings/cloud1protectionprofile1", + "name": "cloud1protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings", + "properties": { + "targetProtectionContainerId": "Microsoft Azure", + "targetProtectionContainerFriendlyName": "Microsoft Azure", + "health": "Normal", + "healthErrorDetails": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "state": "Paired", + "sourceProtectionContainerFriendlyName": "cloud1", + "sourceFabricFriendlyName": "cloud1", + "targetFabricFriendlyName": "Microsoft Azure", + "policyFriendlyName": "protectionprofile1" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainerMappings_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainerMappings_List.json new file mode 100644 index 000000000000..4371d8dd0310 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainerMappings_List.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectionContainerMappings/cloud1protectionprofile1", + "name": "cloud1protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationProtectionContainerMappings", + "properties": { + "targetProtectionContainerId": "Microsoft Azure", + "targetProtectionContainerFriendlyName": "Microsoft Azure", + "health": "Normal", + "healthErrorDetails": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "state": "Paired", + "sourceProtectionContainerFriendlyName": "cloud1", + "sourceFabricFriendlyName": "cloud1", + "targetFabricFriendlyName": "Microsoft Azure", + "policyFriendlyName": "protectionprofile1" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers.json new file mode 100644 index 000000000000..14032ba876a6 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectionContainerMappings/cloud1protectionprofile1", + "name": "cloud1protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings", + "properties": { + "targetProtectionContainerId": "Microsoft Azure", + "targetProtectionContainerFriendlyName": "Microsoft Azure", + "health": "Normal", + "healthErrorDetails": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "state": "Paired", + "sourceProtectionContainerFriendlyName": "cloud1", + "sourceFabricFriendlyName": "cloud1", + "targetFabricFriendlyName": "Microsoft Azure", + "policyFriendlyName": "protectionprofile1" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainerMappings_Purge.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainerMappings_Purge.json new file mode 100644 index 000000000000..3b93d982148a --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainerMappings_Purge.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "mappingName": "cloud1protectionprofile1", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainerMappings_Update.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainerMappings_Update.json new file mode 100644 index 000000000000..85ddccbf069d --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainerMappings_Update.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "mappingName": "cloud1protectionprofile1", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "updateInput": { + "properties": { + "providerSpecificInput": { + "instanceType": "A2A", + "agentAutoUpdateStatus": "Enabled", + "automationAccountArmId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/automationrg1/providers/Microsoft.Automation/automationAccounts/automationaccount1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectionContainerMappings/cloud1protectionprofile1", + "name": "cloud1protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings", + "properties": { + "targetProtectionContainerId": "Microsoft Azure", + "targetProtectionContainerFriendlyName": "Microsoft Azure", + "health": "Normal", + "healthErrorDetails": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "state": "Paired", + "sourceProtectionContainerFriendlyName": "cloud1", + "sourceFabricFriendlyName": "cloud1", + "targetFabricFriendlyName": "Microsoft Azure", + "policyFriendlyName": "protectionprofile1", + "providerSpecificDetails": { + "instanceType": "A2A", + "agentAutoUpdateStatus": "Enabled", + "automationAccountArmId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/automationrg1/providers/Microsoft.Automation/automationAccounts/automationaccount1", + "scheduleName": "cloud1protectionprofile1_a85ea38f-62a8-471b-93cc-69b74fd9578c", + "jobScheduleName": "ffd503ec-5f88-4b58-97c8-841466e7aa47" + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainers_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainers_Create.json new file mode 100644 index 000000000000..701cf08c87a6 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainers_Create.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "creationInput": { + "properties": { + "providerSpecificInput": [ + { + "instanceType": "ReplicationProviderSpecificContainerCreationInput" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "name": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers", + "properties": { + "fabricFriendlyName": "cloud1", + "friendlyName": "cloud1", + "fabricType": "HyperVSite", + "protectedItemCount": 0, + "pairingStatus": "NotPaired", + "role": "" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainers_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainers_Delete.json new file mode 100644 index 000000000000..0d5b9796e321 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainers_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainers_DiscoverProtectableItem.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainers_DiscoverProtectableItem.json new file mode 100644 index 000000000000..f70f0438ed7f --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainers_DiscoverProtectableItem.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "protectionContainerName": "cloud_7328549c-5c37-4459-a3c2-e35f9ef6893c", + "fabricName": "V2A-W2K12-660", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574", + "discoverProtectableItemRequest": { + "properties": { + "friendlyName": "Test", + "ipAddress": "10.150.2.3", + "osType": "Windows" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationFabrics/239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d/replicationProtectionContainers/cloud_7328549c-5c37-4459-a3c2-e35f9ef6893c", + "name": "cloud_7328549c-5c37-4459-a3c2-e35f9ef6893c", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers", + "properties": { + "fabricFriendlyName": "V2A-W2K12-660", + "friendlyName": "V2A-W2K12-660", + "fabricType": "VMware", + "protectedItemCount": 2, + "pairingStatus": "Paired", + "role": "Primary" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainers_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainers_Get.json new file mode 100644 index 000000000000..c978958e9df6 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainers_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "name": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers", + "properties": { + "fabricFriendlyName": "cloud1", + "friendlyName": "cloud1", + "fabricType": "HyperVSite", + "protectedItemCount": 0, + "pairingStatus": "NotPaired", + "role": "" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainers_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainers_List.json new file mode 100644 index 000000000000..3d44e61e5076 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainers_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "name": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "type": "Microsoft.RecoveryServices/vaults/replicationProtectionContainers", + "properties": { + "fabricFriendlyName": "cloud1", + "friendlyName": "cloud1", + "fabricType": "HyperVSite", + "protectedItemCount": 0, + "pairingStatus": "NotPaired", + "role": "" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainers_ListByReplicationFabrics.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainers_ListByReplicationFabrics.json new file mode 100644 index 000000000000..1eafaf9c7b48 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainers_ListByReplicationFabrics.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "name": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers", + "properties": { + "fabricFriendlyName": "cloud1", + "friendlyName": "cloud1", + "fabricType": "HyperVSite", + "protectedItemCount": 0, + "pairingStatus": "NotPaired", + "role": "" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainers_SwitchProtection.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainers_SwitchProtection.json new file mode 100644 index 000000000000..2677bad0ecde --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionContainers_SwitchProtection.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "protectionContainerName": "CentralUSCancloud", + "fabricName": "CentralUSCanSite", + "resourceName": "priyanponeboxvault", + "resourceGroupName": "priyanprg", + "subscriptionId": "42195872-7e70-4f8a-837f-84b28ecbb78b", + "switchInput": { + "properties": { + "replicationProtectedItemName": "a2aSwapOsVm", + "providerSpecificDetails": { + "instanceType": "A2A" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/42195872-7e70-4f8a-837f-84b28ecbb78b/resourceGroups/priyanprg/providers/Microsoft.RecoveryServices/vaults/priyanponeboxvault/replicationFabrics/EUSCanSite/replicationProtectionContainers/euscancloud", + "name": "euscancloud", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers", + "properties": { + "fabricFriendlyName": "East US 2 EUAP", + "friendlyName": "euscancloud", + "fabricType": "Azure", + "protectedItemCount": 0, + "pairingStatus": "Paired", + "role": "Primary" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionIntents_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionIntents_Create.json new file mode 100644 index 000000000000..74bf58acc074 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionIntents_Create.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "intentObjectName": "vm1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "509099b2-9d2c-4636-b43e-bd5cafb6be69", + "input": { + "properties": { + "providerSpecificDetails": { + "instanceType": "A2A", + "fabricObjectId": "/subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/removeOne/providers/Microsoft.Compute/virtualMachines/vmPpgAv5", + "primaryLocation": "eastUs2", + "recoveryLocation": "westus2", + "recoverySubscriptionId": "ed5bcdf6-d61e-47bd-8ea9-f2bd379a2640", + "recoveryAvailabilityType": "Single", + "recoveryResourceGroupId": "/subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/removeOne-asr" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/2007vttp/providers/Microsoft.RecoveryServices/vaults/tp2007vt/replicationProtectionIntents/vm1", + "name": "vm1", + "type": "Microsoft.RecoveryServices/vaults/replicationProtectionIntents", + "properties": { + "friendlyName": "vm1", + "jobId": "/Subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/a2acl-rg-vault-prod-gip-ccy/providers/Microsoft.RecoveryServices/vaults/a2acl-vault-prod-gip-ccy/replicationJobs/02004ea7-d498-4bb4-bdeb-cdb611706867", + "jobState": "InProgress", + "providerSpecificDetails": { + "instanceType": "A2A", + "recoveryAvailabilityType": "Single" + } + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionIntents_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionIntents_Get.json new file mode 100644 index 000000000000..38067aa71bc7 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionIntents_Get.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "intentObjectName": "vm1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "509099b2-9d2c-4636-b43e-bd5cafb6be69" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/2007vttp/providers/Microsoft.RecoveryServices/vaults/tp2007vt/replicationProtectionIntents/vm1", + "name": "vm1", + "type": "Microsoft.RecoveryServices/vaults/replicationProtectionIntents", + "properties": { + "friendlyName": "vm1", + "jobId": "/Subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/a2acl-rg-vault-prod-gip-ccy/providers/Microsoft.RecoveryServices/vaults/a2acl-vault-prod-gip-ccy/replicationJobs/02004ea7-d498-4bb4-bdeb-cdb611706867", + "jobState": "InProgress", + "providerSpecificDetails": { + "instanceType": "A2A", + "fabricObjectId": "/subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/removeOne/providers/Microsoft.Compute/virtualMachines/vmPpgAv5", + "primaryLocation": "eastUs2", + "recoveryLocation": "westus2", + "recoverySubscriptionId": "ed5bcdf6-d61e-47bd-8ea9-f2bd379a2640", + "recoveryAvailabilityType": "Single" + } + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionIntents_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionIntents_List.json new file mode 100644 index 000000000000..c719ea7c42bc --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationProtectionIntents_List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "2007vttp", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "509099b2-9d2c-4636-b43e-bd5cafb6be69" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/2007vttp/providers/Microsoft.RecoveryServices/vaults/tp2007vt/replicationProtectionIntents/vm1", + "name": "vm1", + "type": "Microsoft.RecoveryServices/vaults/replicationProtectionIntents", + "properties": { + "friendlyName": "vm1", + "jobId": "/Subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/a2acl-rg-vault-prod-gip-ccy/providers/Microsoft.RecoveryServices/vaults/a2acl-vault-prod-gip-ccy/replicationJobs/02004ea7-d498-4bb4-bdeb-cdb611706867", + "jobState": "InProgress", + "providerSpecificDetails": { + "instanceType": "A2A", + "fabricObjectId": "/subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/removeOne/providers/Microsoft.Compute/virtualMachines/vmPpgAv5", + "primaryLocation": "eastUs2", + "recoveryLocation": "westus2", + "recoverySubscriptionId": "ed5bcdf6-d61e-47bd-8ea9-f2bd379a2640", + "recoveryAvailabilityType": "Single" + } + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_Create.json new file mode 100644 index 000000000000..86ee5eedc020 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_Create.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1", + "input": { + "properties": { + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "recoveryFabricId": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "groups": [ + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover" + ], + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_Delete.json new file mode 100644 index 000000000000..23c927c3f026 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_FailoverCancel.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_FailoverCancel.json new file mode 100644 index 000000000000..48a2f3d86a99 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_FailoverCancel.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "recoveryFabricFriendlyName": "cloud1", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "InMageRcmFailback" + ], + "allowedOperations": [ + "PlannedFailover" + ], + "lastPlannedFailoverTime": "2021-02-24T07:33:49.1372448Z", + "lastTestFailoverTime": "1601-01-01T00:00:00.0000000Z", + "currentScenario": { + "scenarioName": "CancelFailover", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/5276a7bc-12a3-43a1-bc53-9bf80e0be87b", + "startTime": "2021-02-24T08:52:42.1587592Z" + }, + "currentScenarioStatus": "Succeeded", + "currentScenarioStatusDescription": "Completed", + "groups": [] + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_FailoverCommit.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_FailoverCommit.json new file mode 100644 index 000000000000..87f4a5ed5051 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_FailoverCommit.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover" + ], + "lastPlannedFailoverTime": "2017-04-27T07:33:49.1372448Z", + "lastTestFailoverTime": "2017-04-27T07:00:27.8354747Z", + "currentScenario": { + "scenarioName": "CommitFailover", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/5276a7bc-12a3-43a1-bc53-9bf80e0be87b", + "startTime": "2017-04-27T08:52:42.1587592Z" + }, + "currentScenarioStatus": "Succeeded", + "currentScenarioStatusDescription": "Completed", + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_Get.json new file mode 100644 index 000000000000..8c9711a795a1 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_Get.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover" + ], + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_List.json new file mode 100644 index 000000000000..0afea80fe746 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_List.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover" + ], + "groups": [] + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_PlannedFailover.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_PlannedFailover.json new file mode 100644 index 000000000000..5d24e7be9566 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_PlannedFailover.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1", + "input": { + "properties": { + "failoverDirection": "PrimaryToRecovery", + "providerSpecificDetails": [ + { + "instanceType": "HyperVReplicaAzure" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover", + "Commit" + ], + "lastPlannedFailoverTime": "2017-04-27T07:33:49.1372448Z", + "lastTestFailoverTime": "2017-04-27T07:00:27.8354747Z", + "currentScenario": { + "scenarioName": "PlannedFailover", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/d4821a53-90da-4fcb-bc11-a280d13e3350", + "startTime": "2017-04-27T07:34:02.6176524Z" + }, + "currentScenarioStatus": "Succeeded", + "currentScenarioStatusDescription": "Completed", + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_Reprotect.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_Reprotect.json new file mode 100644 index 000000000000..80858ab0fb40 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_Reprotect.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover" + ], + "lastPlannedFailoverTime": "2017-04-27T08:58:35.9062813Z", + "lastTestFailoverTime": "2017-04-27T07:00:27.8354747Z", + "currentScenario": { + "scenarioName": "ReverseReplication", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/edf01dfb-b649-4802-91e4-3d55ce3bebf0", + "startTime": "2017-04-27T09:52:16.9818841Z" + }, + "currentScenarioStatus": "Succeeded", + "currentScenarioStatusDescription": "Completed", + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_TestFailover.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_TestFailover.json new file mode 100644 index 000000000000..cc9eec2a9daa --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_TestFailover.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1", + "input": { + "properties": { + "failoverDirection": "PrimaryToRecovery", + "networkType": "VmNetworkAsInput", + "networkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "providerSpecificDetails": [ + { + "instanceType": "HyperVReplicaAzure" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "TestFailoverCleanup" + ], + "currentScenario": { + "scenarioName": "TestFailover", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/d40bfb40-aaaa-4c0d-87d3-41b15439a84b", + "startTime": "2017-04-27T07:00:58.8191916Z" + }, + "currentScenarioStatus": "Suspended", + "currentScenarioStatusDescription": "WaitingForStopTestFailover", + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_TestFailoverCleanup.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_TestFailoverCleanup.json new file mode 100644 index 000000000000..209639565110 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_TestFailoverCleanup.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1", + "input": { + "properties": { + "comments": "Test Failover Cleanup" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover" + ], + "lastPlannedFailoverTime": "2017-04-27T07:33:49.1372448Z", + "lastTestFailoverTime": "2017-04-27T07:00:27.8354747Z", + "currentScenario": { + "scenarioName": "TestFailoverCleanup", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/4ae8eaa8-a384-42cb-9768-152cb5b8a1ff", + "startTime": "2017-04-27T07:10:52.8424747Z" + }, + "currentScenarioStatus": "Succeeded", + "currentScenarioStatusDescription": "Completed", + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_UnplannedFailover.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_UnplannedFailover.json new file mode 100644 index 000000000000..a3e1eeb36b85 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_UnplannedFailover.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1", + "input": { + "properties": { + "failoverDirection": "PrimaryToRecovery", + "sourceSiteOperations": "Required", + "providerSpecificDetails": [ + { + "instanceType": "HyperVReplicaAzure" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover", + "Commit" + ], + "lastPlannedFailoverTime": "2017-04-27T08:58:35.9062813Z", + "lastTestFailoverTime": "2017-04-27T07:00:27.8354747Z", + "currentScenario": { + "scenarioName": "UnplannedFailover", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/60b84068-9adb-4867-a49d-88be40bff14b", + "startTime": "2017-04-27T10:03:03.2206946Z" + }, + "currentScenarioStatus": "Succeeded", + "currentScenarioStatusDescription": "Completed", + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_Update.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_Update.json new file mode 100644 index 000000000000..ea6fd5c72b4f --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryPlans_Update.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1", + "input": { + "properties": { + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover" + ], + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryServicesProviders_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryServicesProviders_Create.json new file mode 100644 index 000000000000..e04faba9e844 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryServicesProviders_Create.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "providerName": "vmwareprovider1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "addProviderInput": { + "properties": { + "machineName": "vmwareprovider1", + "authenticationIdentityInput": { + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "f66fce08-c0c6-47a1-beeb-0ede5ea94f90", + "objectId": "141360b8-5686-4240-a027-5e24e6affeba", + "audience": "https://microsoft.onmicrosoft.com/cf19e349-644c-4c6a-bcae-9c8f35357874", + "aadAuthority": "https://login.microsoftonline.com" + }, + "resourceAccessIdentityInput": { + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "f66fce08-c0c6-47a1-beeb-0ede5ea94f90", + "objectId": "141360b8-5686-4240-a027-5e24e6affeba", + "audience": "https://microsoft.onmicrosoft.com/cf19e349-644c-4c6a-bcae-9c8f35357874", + "aadAuthority": "https://login.microsoftonline.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationRecoveryServicesProviders/vmwareprovider1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders", + "name": "vmwareprovider1", + "properties": { + "fabricType": "VMwareV2", + "friendlyName": "vmwareprovider1", + "providerVersion": "5.1.3688.0", + "serverVersion": "3.2.7510.0", + "providerVersionState": "Latest", + "fabricFriendlyName": "vmwarefabric1", + "lastHeartBeat": "2017-04-27T09:16:04.9405768Z", + "connectionStatus": "Connected", + "protectedItemCount": 2, + "allowedScenarios": [ + "Refresh" + ] + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryServicesProviders_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryServicesProviders_Delete.json new file mode 100644 index 000000000000..10699216b0c2 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryServicesProviders_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "providerName": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "fabricName": "cloud1", + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryServicesProviders_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryServicesProviders_Get.json new file mode 100644 index 000000000000..ec4634ab00f6 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryServicesProviders_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "providerName": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "fabricName": "cloud1", + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders", + "name": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "properties": { + "fabricType": "HyperVSite", + "friendlyName": "CP-B3L40406-12.ntdev.corp.microsoft.com", + "providerVersion": "5.1.2250.0", + "serverVersion": "3.2.7510.0", + "providerVersionState": "Latest", + "fabricFriendlyName": "cloud1", + "lastHeartBeat": "2017-04-27T09:16:04.9405768Z", + "connectionStatus": "Connected", + "protectedItemCount": 2, + "allowedScenarios": [ + "Refresh" + ] + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryServicesProviders_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryServicesProviders_List.json new file mode 100644 index 000000000000..4b2fcfe95949 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryServicesProviders_List.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders", + "name": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "properties": { + "fabricType": "HyperVSite", + "friendlyName": "CP-B3L40406-12.ntdev.corp.microsoft.com", + "providerVersion": "5.1.2250.0", + "serverVersion": "3.2.7510.0", + "providerVersionState": "Latest", + "fabricFriendlyName": "cloud1", + "lastHeartBeat": "2017-04-27T09:06:38.2728455Z", + "connectionStatus": "Connected", + "protectedItemCount": 2, + "allowedScenarios": [ + "Refresh" + ] + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryServicesProviders_ListByReplicationFabrics.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryServicesProviders_ListByReplicationFabrics.json new file mode 100644 index 000000000000..4eddd2db4cb8 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryServicesProviders_ListByReplicationFabrics.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders", + "name": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "properties": { + "fabricType": "HyperVSite", + "friendlyName": "CP-B3L40406-12.ntdev.corp.microsoft.com", + "providerVersion": "5.1.2250.0", + "serverVersion": "3.2.7510.0", + "providerVersionState": "Latest", + "fabricFriendlyName": "cloud1", + "lastHeartBeat": "2017-04-27T09:06:38.2728455Z", + "connectionStatus": "Connected", + "protectedItemCount": 2, + "allowedScenarios": [ + "Refresh" + ] + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryServicesProviders_Purge.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryServicesProviders_Purge.json new file mode 100644 index 000000000000..10699216b0c2 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryServicesProviders_Purge.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "providerName": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "fabricName": "cloud1", + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryServicesProviders_RefreshProvider.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryServicesProviders_RefreshProvider.json new file mode 100644 index 000000000000..c589c09974d4 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationRecoveryServicesProviders_RefreshProvider.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "providerName": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "fabricName": "cloud1", + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders", + "name": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "properties": { + "fabricType": "HyperVSite", + "friendlyName": "CP-B3L40406-12.ntdev.corp.microsoft.com", + "providerVersion": "5.1.2250.0", + "serverVersion": "3.2.7510.0", + "providerVersionState": "Latest", + "fabricFriendlyName": "cloud1", + "lastHeartBeat": "2017-04-27T09:48:36.6528303Z", + "connectionStatus": "Connected", + "protectedItemCount": 2, + "allowedScenarios": [ + "Refresh" + ] + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationStorageClassificationMappings_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationStorageClassificationMappings_Create.json new file mode 100644 index 000000000000..56dfd3904f7b --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationStorageClassificationMappings_Create.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "storageClassificationMappingName": "testStorageMapping", + "storageClassificationName": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "fabricName": "2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071", + "pairingInput": { + "properties": { + "targetStorageClassificationId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09/replicationStorageClassificationMappings/testStorageMapping", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings", + "name": "testStorageMapping", + "properties": { + "targetStorageClassificationId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationStorageClassificationMappings_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationStorageClassificationMappings_Delete.json new file mode 100644 index 000000000000..e72659c3c1b9 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationStorageClassificationMappings_Delete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "storageClassificationMappingName": "testStorageMapping", + "storageClassificationName": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "fabricName": "2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationStorageClassificationMappings_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationStorageClassificationMappings_Get.json new file mode 100644 index 000000000000..3e580b86e5a0 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationStorageClassificationMappings_Get.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "storageClassificationMappingName": "testStorageMapping", + "storageClassificationName": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "fabricName": "2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09/replicationStorageClassificationMappings/testStorageMapping", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings", + "name": "testStorageMapping", + "properties": { + "targetStorageClassificationId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationStorageClassificationMappings_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationStorageClassificationMappings_List.json new file mode 100644 index 000000000000..269eb38d2870 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationStorageClassificationMappings_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09/replicationStorageClassificationMappings/testStorageMapping", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings", + "name": "testStorageMapping", + "properties": { + "targetStorageClassificationId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationStorageClassificationMappings_ListByReplicationStorageClassifications.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationStorageClassificationMappings_ListByReplicationStorageClassifications.json new file mode 100644 index 000000000000..f73a082d1256 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationStorageClassificationMappings_ListByReplicationStorageClassifications.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "storageClassificationName": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "fabricName": "2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09/replicationStorageClassificationMappings/testStorageMapping", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings", + "name": "testStorageMapping", + "properties": { + "targetStorageClassificationId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationStorageClassifications_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationStorageClassifications_Get.json new file mode 100644 index 000000000000..f457fa903011 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationStorageClassifications_Get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "storageClassificationName": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "fabricName": "2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications", + "name": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "properties": { + "friendlyName": "testStorageClassification" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationStorageClassifications_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationStorageClassifications_List.json new file mode 100644 index 000000000000..7fb527ad8233 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationStorageClassifications_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications", + "name": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "properties": { + "friendlyName": "testStorageClassification" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationStorageClassifications_ListByReplicationFabrics.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationStorageClassifications_ListByReplicationFabrics.json new file mode 100644 index 000000000000..12d88c57710f --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationStorageClassifications_ListByReplicationFabrics.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "fabricName": "2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications", + "name": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "properties": { + "friendlyName": "testStorageClassification" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationVaultHealth_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationVaultHealth_Get.json new file mode 100644 index 000000000000..f580a2236835 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationVaultHealth_Get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "name": "Default", + "type": "Microsoft.RecoveryServices/vaults/replicationVaultHealth", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationVaultHealth/Default", + "properties": { + "vaultErrors": [], + "protectedItemsHealth": { + "resourceCount": 6, + "issues": [ + { + "summaryCode": "10008", + "category": "Replication", + "severity": "Error", + "summaryMessage": "RPO Throttled", + "affectedResourceType": "replicationProtectedItems", + "affectedResourceSubtype": "", + "affectedResourceCorrelationIds": [ + "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "c183865e-6077-46f2-a3b1-ceb0a4c3751e" + ] + } + ] + }, + "fabricsHealth": { + "resourceCount": 1, + "issues": [] + } + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationVaultHealth_Refresh.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationVaultHealth_Refresh.json new file mode 100644 index 000000000000..cd79d4c107cc --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationVaultHealth_Refresh.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "name": "Default", + "type": "Microsoft.RecoveryServices/vaults/replicationVaultHealth", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationVaultHealth/Default", + "properties": { + "vaultErrors": [], + "protectedItemsHealth": { + "resourceCount": 2, + "issues": [] + }, + "fabricsHealth": { + "resourceCount": 1, + "issues": [] + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationVaultSetting_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationVaultSetting_Create.json new file mode 100644 index 000000000000..342a7a34236d --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationVaultSetting_Create.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "vaultSettingName": "default", + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "input": { + "properties": { + "migrationSolutionId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.Migrate/MigrateProjects/resourceGroupPS1-MigrateProject/Solutions/Servers-Migration-ServerMigration" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationVaultSettings/default", + "name": "default", + "type": "Microsoft.RecoveryServices/vaults/replicationVaultSettings", + "properties": { + "migrationSolutionId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.Migrate/MigrateProjects/resourceGroupPS1-MigrateProject/Solutions/Servers-Migration-ServerMigration" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationVaultSetting_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationVaultSetting_Get.json new file mode 100644 index 000000000000..9dd85dbfff5e --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationVaultSetting_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "vaultSettingName": "default", + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationVaultSettings/default", + "name": "default", + "type": "Microsoft.RecoveryServices/vaults/replicationVaultSettings", + "properties": { + "migrationSolutionId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.Migrate/MigrateProjects/resourceGroupPS1-MigrateProject/Solutions/Servers-Migration-ServerMigration" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationVaultSetting_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationVaultSetting_List.json new file mode 100644 index 000000000000..2d41d495455b --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationVaultSetting_List.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationVaultSettings/default", + "name": "default", + "type": "Microsoft.RecoveryServices/vaults/replicationVaultSettings", + "properties": { + "migrationSolutionId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.Migrate/MigrateProjects/resourceGroupPS1-MigrateProject/Solutions/Servers-Migration-ServerMigration" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationvCenters_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationvCenters_Create.json new file mode 100644 index 000000000000..4a5fb3317df6 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationvCenters_Create.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "vcenterName": "esx-78", + "fabricName": "MadhaviFabric", + "api-version": "2021-04-01", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574", + "addVCenterRequest": { + "properties": { + "friendlyName": "esx-78", + "ipAddress": "inmtest78", + "processServerId": "5A720CAB-39CB-F445-BD1662B0B33164B5", + "port": "443", + "runAsAccountId": "2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "esx-78", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters", + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationFabrics/239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d/replicationvCenters/esx-78", + "properties": { + "friendlyName": "esx-78", + "internalId": "inmtest78", + "discoveryStatus": "Pending", + "processServerId": "5A720CAB-39CB-F445-BD1662B0B33164B5", + "ipAddress": "inmtest78", + "port": "443", + "runAsAccountId": "2", + "fabricArmResourceName": "239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationvCenters_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationvCenters_Delete.json new file mode 100644 index 000000000000..1dc56f0f4860 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationvCenters_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "vcenterName": "esx-78", + "fabricName": "MadhaviFabric", + "api-version": "2021-04-01", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationvCenters_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationvCenters_Get.json new file mode 100644 index 000000000000..67aa8d8e70a1 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationvCenters_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "vcenterName": "esx-78", + "fabricName": "MadhaviFabric", + "api-version": "2021-04-01", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574" + }, + "responses": { + "200": { + "body": { + "name": "esx-78", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters", + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationFabrics/239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d/replicationvCenters/esx-78", + "properties": { + "friendlyName": "esx-78", + "internalId": "inmtest78", + "discoveryStatus": "Pending", + "processServerId": "5A720CAB-39CB-F445-BD1662B0B33164B5", + "ipAddress": "inmtest78", + "port": "443", + "runAsAccountId": "2", + "fabricArmResourceName": "239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationvCenters_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationvCenters_List.json new file mode 100644 index 000000000000..6380344b4620 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationvCenters_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "esx-78", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters", + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationFabrics/239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d/replicationvCenters/esx-78", + "properties": { + "friendlyName": "esx-78", + "internalId": "inmtest78", + "discoveryStatus": "Pending", + "processServerId": "5A720CAB-39CB-F445-BD1662B0B33164B5", + "ipAddress": "inmtest78", + "port": "443", + "runAsAccountId": "2", + "fabricArmResourceName": "239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationvCenters_ListByReplicationFabrics.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationvCenters_ListByReplicationFabrics.json new file mode 100644 index 000000000000..f2e1b7bf327f --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationvCenters_ListByReplicationFabrics.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "fabricName": "MadhaviFabric", + "api-version": "2021-04-01", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "esx-78", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters", + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationFabrics/239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d/replicationvCenters/esx-78", + "properties": { + "friendlyName": "esx-78", + "internalId": "inmtest78", + "discoveryStatus": "Pending", + "processServerId": "5A720CAB-39CB-F445-BD1662B0B33164B5", + "ipAddress": "inmtest78", + "port": "443", + "runAsAccountId": "2", + "fabricArmResourceName": "239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationvCenters_Update.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationvCenters_Update.json new file mode 100644 index 000000000000..c6b37098a75b --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/ReplicationvCenters_Update.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "vcenterName": "esx-78", + "fabricName": "MadhaviFabric", + "api-version": "2021-04-01", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574", + "updateVCenterRequest": { + "properties": { + "ipAddress": "10.150.109.25" + } + } + }, + "responses": { + "200": { + "body": { + "name": "esx-78", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters", + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationFabrics/239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d/replicationvCenters/esx-78", + "properties": { + "friendlyName": "esx-78", + "internalId": "inmtest78", + "discoveryStatus": "Pending", + "processServerId": "5A720CAB-39CB-F445-BD1662B0B33164B5", + "ipAddress": "10.150.109.25", + "port": "443", + "runAsAccountId": "2", + "fabricArmResourceName": "239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/SupportedOperatingSystems_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/SupportedOperatingSystems_Get.json new file mode 100644 index 000000000000..c2eaddf85b8a --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/SupportedOperatingSystems_Get.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "name": "Default", + "type": "Microsoft.RecoveryServices/vaults/replicationSupportedOperatingSystems", + "id": "/Subscriptions/bc403605-c2b0-43dd-abe9-0162124b1ee1/resourceGroups/oneBoxRG/providers/Microsoft.RecoveryServices/vaults/oneBoxRSVault/replicationSupportedOperatingSystems/Default", + "properties": { + "supportedOsList": [ + { + "instanceType": "A2A", + "supportedOs": [ + { + "osName": "centos", + "osType": "linux", + "osVersions": [ + { + "version": "6.0" + } + ] + }, + { + "osName": "Windows Server 2008 R2 Datacenter", + "osType": "windows", + "osVersions": [ + { + "version": "6.1", + "servicePack": "1" + } + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/TargetComputeSizes_ListByReplicationProtectedItems.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/TargetComputeSizes_ListByReplicationProtectedItems.json new file mode 100644 index 000000000000..5d776741d545 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/examples/TargetComputeSizes_ListByReplicationProtectedItems.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "replicatedProtectedItemName": "468c912d-b1ab-4ea2-97eb-4b5095155db2", + "protectionContainerName": "asr-a2a-default-centraluseuap-container", + "fabricName": "asr-a2a-default-centraluseuap", + "resourceName": "avraiMgDiskVault", + "resourceGroupName": "avraiMgDiskVaultRG", + "subscriptionId": "6808dbbc-98c7-431f-a1b1-9580902423b7" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/6808dbbc-98c7-431f-a1b1-9580902423b7/resourceGroups/avraiMgDiskVaultRG/providers/Microsoft.RecoveryServices/vaults/avraiMgDiskVault/replicationFabrics/asr-a2a-default-centraluseuap/replicationProtectionContainers/asr-a2a-default-centraluseuap-container/replicationProtectedItems/468c912d-b1ab-4ea2-97eb-4b5095155db2/targetComputeSizes/Basic_A0", + "name": "Basic_A0", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/targetComputeSizes", + "properties": { + "name": "Basic_A0", + "friendlyName": "Basic_A0", + "cpuCoresCount": 1, + "memoryInGB": 0.75, + "maxDataDiskCount": 1, + "maxNicsCount": 2, + "errors": null, + "highIopsSupported": "NotSupported" + } + }, + { + "id": "/Subscriptions/6808dbbc-98c7-431f-a1b1-9580902423b7/resourceGroups/avraiMgDiskVaultRG/providers/Microsoft.RecoveryServices/vaults/avraiMgDiskVault/replicationFabrics/asr-a2a-default-centraluseuap/replicationProtectionContainers/asr-a2a-default-centraluseuap-container/replicationProtectedItems/468c912d-b1ab-4ea2-97eb-4b5095155db2/targetComputeSizes/Standard_A0", + "name": "Standard_A0", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/targetComputeSizes", + "properties": { + "name": "Standard_A0", + "friendlyName": "Standard_A0", + "cpuCoresCount": 1, + "vCPUsAvailable": 1, + "memoryInGB": 0.75, + "maxDataDiskCount": 1, + "maxNicsCount": 2, + "errors": null, + "highIopsSupported": "NotSupported", + "hyperVGenerations": [ + "V1" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/service.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/service.json new file mode 100644 index 000000000000..790762fa1bff --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-04-01/service.json @@ -0,0 +1,23158 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-04-01", + "title": "SiteRecoveryManagementClient", + "x-ms-code-generation-settings": { + "header": "MICROSOFT_MIT_NO_VERSION" + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Returns the list of available operations.", + "description": "Operation to return the list of available operations.", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationsDiscoveryCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Returns the list of available operations.": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationAlertSettings": { + "get": { + "tags": [ + "ReplicationAlertSettings" + ], + "summary": "Gets the list of configured email notification(alert) configurations.", + "description": "Gets the list of email notification(alert) configurations for the vault.", + "operationId": "ReplicationAlertSettings_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of configured email notification(alert) configurations.": { + "$ref": "./examples/ReplicationAlertSettings_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationAlertSettings/{alertSettingName}": { + "get": { + "tags": [ + "ReplicationAlertSettings" + ], + "summary": "Gets an email notification(alert) configuration.", + "description": "Gets the details of the specified email notification(alert) configuration.", + "operationId": "ReplicationAlertSettings_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "alertSettingName", + "in": "path", + "description": "The name of the email notification configuration.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Alert" + } + } + }, + "x-ms-examples": { + "Gets an email notification(alert) configuration.": { + "$ref": "./examples/ReplicationAlertSettings_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationAlertSettings" + ], + "summary": "Configures email notifications for this vault.", + "description": "Create or update an email notification(alert) configuration.", + "operationId": "ReplicationAlertSettings_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "alertSettingName", + "in": "path", + "description": "The name of the email notification(alert) configuration.", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "The input to configure the email notification(alert).", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigureAlertRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Alert" + } + } + }, + "x-ms-examples": { + "Configures email notifications for this vault.": { + "$ref": "./examples/ReplicationAlertSettings_Create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}/providers/Microsoft.RecoveryServices/replicationEligibilityResults": { + "get": { + "tags": [ + "ReplicationEligibilityResults" + ], + "summary": "Gets the validation errors in case the VM is unsuitable for protection.", + "description": "Validates whether a given VM can be protected or not in which case returns list of errors.", + "operationId": "ReplicationEligibilityResults_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "virtualMachineName", + "in": "path", + "description": "Virtual Machine name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationEligibilityResultsCollection" + } + } + }, + "x-ms-examples": { + "Gets the validation errors in case the VM is unsuitable for protection.": { + "$ref": "./examples/ReplicationEligibilityResults_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}/providers/Microsoft.RecoveryServices/replicationEligibilityResults/default": { + "get": { + "tags": [ + "ReplicationEligibilityResults" + ], + "summary": "Gets the validation errors in case the VM is unsuitable for protection.", + "description": "Validates whether a given VM can be protected or not in which case returns list of errors.", + "operationId": "ReplicationEligibilityResults_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "virtualMachineName", + "in": "path", + "description": "Virtual Machine name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationEligibilityResults" + } + } + }, + "x-ms-examples": { + "Gets the validation errors in case the VM is unsuitable for protection.": { + "$ref": "./examples/ReplicationEligibilityResults_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationEvents": { + "get": { + "tags": [ + "ReplicationEvents" + ], + "summary": "Gets the list of Azure Site Recovery events.", + "description": "Gets the list of Azure Site Recovery events for the vault.", + "operationId": "ReplicationEvents_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/EventQueryParameter", + "x-ms-examples": { + "Gets the list of Azure Site Recovery events.": { + "$ref": "./examples/ReplicationEvents_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationEvents/{eventName}": { + "get": { + "tags": [ + "ReplicationEvents" + ], + "summary": "Get the details of an Azure Site recovery event.", + "description": "The operation to get the details of an Azure Site recovery event.", + "operationId": "ReplicationEvents_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "eventName", + "in": "path", + "description": "The name of the Azure Site Recovery event.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Event" + } + } + }, + "x-ms-examples": { + "Get the details of an Azure Site recovery event.": { + "$ref": "./examples/ReplicationEvents_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics": { + "get": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Gets the list of ASR fabrics.", + "description": "Gets a list of the Azure Site Recovery fabrics in the vault.", + "operationId": "ReplicationFabrics_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FabricCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of ASR fabrics.": { + "$ref": "./examples/ReplicationFabrics_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}": { + "get": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Gets the details of an ASR fabric.", + "description": "Gets the details of an Azure Site Recovery fabric.", + "operationId": "ReplicationFabrics_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Fabric" + } + } + }, + "x-ms-odata": "#/definitions/FabricQueryParameter", + "x-ms-examples": { + "Gets the details of an ASR fabric.": { + "$ref": "./examples/ReplicationFabrics_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Creates an Azure Site Recovery fabric.", + "description": "The operation to create an Azure Site Recovery fabric (for e.g. Hyper-V site).", + "operationId": "ReplicationFabrics_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Name of the ASR fabric.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Fabric creation input.", + "required": true, + "schema": { + "$ref": "#/definitions/FabricCreationInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Fabric" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Creates an Azure Site Recovery fabric.": { + "$ref": "./examples/ReplicationFabrics_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Purges the site.", + "description": "The operation to purge(force delete) an Azure Site Recovery fabric.", + "operationId": "ReplicationFabrics_Purge", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "ASR fabric to purge.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Purges the site.": { + "$ref": "./examples/ReplicationFabrics_Purge.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/checkConsistency": { + "post": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Checks the consistency of the ASR fabric.", + "description": "The operation to perform a consistency check on the fabric.", + "operationId": "ReplicationFabrics_CheckConsistency", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Fabric" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Checks the consistency of the ASR fabric.": { + "$ref": "./examples/ReplicationFabrics_CheckConsistency.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/migratetoaad": { + "post": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Migrates the site to AAD.", + "description": "The operation to migrate an Azure Site Recovery fabric to AAD.", + "operationId": "ReplicationFabrics_MigrateToAad", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "ASR fabric to migrate.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Migrates the site to AAD.": { + "$ref": "./examples/ReplicationFabrics_MigrateToAad.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/reassociateGateway": { + "post": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Perform failover of the process server.", + "description": "The operation to move replications from a process server to another process server.", + "operationId": "ReplicationFabrics_ReassociateGateway", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "The name of the fabric containing the process server.", + "required": true, + "type": "string" + }, + { + "name": "failoverProcessServerRequest", + "in": "body", + "description": "The input to the failover process server operation.", + "required": true, + "schema": { + "$ref": "#/definitions/FailoverProcessServerRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Fabric" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Perform failover of the process server.": { + "$ref": "./examples/ReplicationFabrics_ReassociateGateway.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/remove": { + "post": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Deletes the site.", + "description": "The operation to delete or remove an Azure Site Recovery fabric.", + "operationId": "ReplicationFabrics_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "ASR fabric to delete.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes the site.": { + "$ref": "./examples/ReplicationFabrics_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/renewCertificate": { + "post": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Renews certificate for the fabric.", + "description": "Renews the connection certificate for the ASR replication fabric.", + "operationId": "ReplicationFabrics_RenewCertificate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "fabric name to renew certs for.", + "required": true, + "type": "string" + }, + { + "name": "renewCertificate", + "in": "body", + "description": "Renew certificate input.", + "required": true, + "schema": { + "$ref": "#/definitions/RenewCertificateInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Fabric" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Renews certificate for the fabric.": { + "$ref": "./examples/ReplicationFabrics_RenewCertificate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationLogicalNetworks": { + "get": { + "tags": [ + "ReplicationLogicalNetworks" + ], + "summary": "Gets the list of logical networks under a fabric.", + "description": "Lists all the logical networks of the Azure Site Recovery fabric.", + "operationId": "ReplicationLogicalNetworks_ListByReplicationFabrics", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Server Id.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LogicalNetworkCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of logical networks under a fabric.": { + "$ref": "./examples/ReplicationLogicalNetworks_ListByReplicationFabrics.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationLogicalNetworks/{logicalNetworkName}": { + "get": { + "tags": [ + "ReplicationLogicalNetworks" + ], + "summary": "Gets a logical network with specified server id and logical network name.", + "description": "Gets the details of a logical network.", + "operationId": "ReplicationLogicalNetworks_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Server Id.", + "required": true, + "type": "string" + }, + { + "name": "logicalNetworkName", + "in": "path", + "description": "Logical network name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LogicalNetwork" + } + } + }, + "x-ms-examples": { + "Gets a logical network with specified server id and logical network name.": { + "$ref": "./examples/ReplicationLogicalNetworks_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks": { + "get": { + "tags": [ + "ReplicationNetworks" + ], + "summary": "Gets the list of networks under a fabric.", + "description": "Lists the networks available for a fabric.", + "operationId": "ReplicationNetworks_ListByReplicationFabrics", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of networks under a fabric.": { + "$ref": "./examples/ReplicationNetworks_ListByReplicationFabrics.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks/{networkName}": { + "get": { + "tags": [ + "ReplicationNetworks" + ], + "summary": "Gets a network with specified server id and network name.", + "description": "Gets the details of a network.", + "operationId": "ReplicationNetworks_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Server Id.", + "required": true, + "type": "string" + }, + { + "name": "networkName", + "in": "path", + "description": "Primary network name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Network" + } + } + }, + "x-ms-examples": { + "Gets a network with specified server id and network name.": { + "$ref": "./examples/ReplicationNetworks_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks/{networkName}/replicationNetworkMappings": { + "get": { + "tags": [ + "ReplicationNetworkMappings" + ], + "summary": "Gets all the network mappings under a network.", + "description": "Lists all ASR network mappings for the specified network.", + "operationId": "ReplicationNetworkMappings_ListByReplicationNetworks", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Primary fabric name.", + "required": true, + "type": "string" + }, + { + "name": "networkName", + "in": "path", + "description": "Primary network name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkMappingCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all the network mappings under a network.": { + "$ref": "./examples/ReplicationNetworkMappings_ListByReplicationNetworks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks/{networkName}/replicationNetworkMappings/{networkMappingName}": { + "get": { + "tags": [ + "ReplicationNetworkMappings" + ], + "summary": "Gets network mapping by name.", + "description": "Gets the details of an ASR network mapping.", + "operationId": "ReplicationNetworkMappings_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Primary fabric name.", + "required": true, + "type": "string" + }, + { + "name": "networkName", + "in": "path", + "description": "Primary network name.", + "required": true, + "type": "string" + }, + { + "name": "networkMappingName", + "in": "path", + "description": "Network mapping name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkMapping" + } + } + }, + "x-ms-examples": { + "Gets network mapping by name.": { + "$ref": "./examples/ReplicationNetworkMappings_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationNetworkMappings" + ], + "summary": "Creates network mapping.", + "description": "The operation to create an ASR network mapping.", + "operationId": "ReplicationNetworkMappings_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Primary fabric name.", + "required": true, + "type": "string" + }, + { + "name": "networkName", + "in": "path", + "description": "Primary network name.", + "required": true, + "type": "string" + }, + { + "name": "networkMappingName", + "in": "path", + "description": "Network mapping name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Create network mapping input.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateNetworkMappingInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkMapping" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Creates network mapping.": { + "$ref": "./examples/ReplicationNetworkMappings_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationNetworkMappings" + ], + "summary": "Delete network mapping.", + "description": "The operation to delete a network mapping.", + "operationId": "ReplicationNetworkMappings_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Primary fabric name.", + "required": true, + "type": "string" + }, + { + "name": "networkName", + "in": "path", + "description": "Primary network name.", + "required": true, + "type": "string" + }, + { + "name": "networkMappingName", + "in": "path", + "description": "ARM Resource Name for network mapping.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete network mapping.": { + "$ref": "./examples/ReplicationNetworkMappings_Delete.json" + } + } + }, + "patch": { + "tags": [ + "ReplicationNetworkMappings" + ], + "summary": "Updates network mapping.", + "description": "The operation to update an ASR network mapping.", + "operationId": "ReplicationNetworkMappings_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Primary fabric name.", + "required": true, + "type": "string" + }, + { + "name": "networkName", + "in": "path", + "description": "Primary network name.", + "required": true, + "type": "string" + }, + { + "name": "networkMappingName", + "in": "path", + "description": "Network mapping name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Update network mapping input.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateNetworkMappingInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkMapping" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates network mapping.": { + "$ref": "./examples/ReplicationNetworkMappings_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers": { + "get": { + "tags": [ + "ReplicationProtectionContainers" + ], + "summary": "Gets the list of protection container for a fabric.", + "description": "Lists the protection containers in the specified fabric.", + "operationId": "ReplicationProtectionContainers_ListByReplicationFabrics", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of protection container for a fabric.": { + "$ref": "./examples/ReplicationProtectionContainers_ListByReplicationFabrics.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}": { + "get": { + "tags": [ + "ReplicationProtectionContainers" + ], + "summary": "Gets the protection container details.", + "description": "Gets the details of a protection container.", + "operationId": "ReplicationProtectionContainers_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainer" + } + } + }, + "x-ms-examples": { + "Gets the protection container details.": { + "$ref": "./examples/ReplicationProtectionContainers_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationProtectionContainers" + ], + "summary": "Create a protection container.", + "description": "Operation to create a protection container.", + "operationId": "ReplicationProtectionContainers_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric ARM name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Unique protection container ARM name.", + "required": true, + "type": "string" + }, + { + "name": "creationInput", + "in": "body", + "description": "Creation input.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateProtectionContainerInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainer" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a protection container.": { + "$ref": "./examples/ReplicationProtectionContainers_Create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/discoverProtectableItem": { + "post": { + "tags": [ + "ReplicationProtectionContainers" + ], + "summary": "Adds a protectable item to the replication protection container.", + "description": "The operation to a add a protectable item to a protection container(Add physical server).", + "operationId": "ReplicationProtectionContainers_DiscoverProtectableItem", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "The name of the fabric.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "The name of the protection container.", + "required": true, + "type": "string" + }, + { + "name": "discoverProtectableItemRequest", + "in": "body", + "description": "The request object to add a protectable item.", + "required": true, + "schema": { + "$ref": "#/definitions/DiscoverProtectableItemRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainer" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Adds a protectable item to the replication protection container.": { + "$ref": "./examples/ReplicationProtectionContainers_DiscoverProtectableItem.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/remove": { + "post": { + "tags": [ + "ReplicationProtectionContainers" + ], + "summary": "Removes a protection container.", + "description": "Operation to remove a protection container.", + "operationId": "ReplicationProtectionContainers_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric ARM name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Unique protection container ARM name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Removes a protection container.": { + "$ref": "./examples/ReplicationProtectionContainers_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems": { + "get": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Gets the list of migration items in the protection container.", + "description": "Gets the list of ASR migration items in the protection container.", + "operationId": "ReplicationMigrationItems_ListByReplicationProtectionContainers", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "skipToken", + "in": "query", + "description": "The pagination token.", + "required": false, + "type": "string" + }, + { + "name": "takeToken", + "in": "query", + "description": "The page size.", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItemCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/MigrationItemsQueryParameter", + "x-ms-examples": { + "Gets the list of migration items in the protection container.": { + "$ref": "./examples/ReplicationMigrationItems_ListByReplicationProtectionContainers.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}": { + "get": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Gets the details of a migration item.", + "operationId": "ReplicationMigrationItems_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric unique name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + } + }, + "x-ms-examples": { + "Gets the details of a migration item.": { + "$ref": "./examples/ReplicationMigrationItems_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Enables migration.", + "description": "The operation to create an ASR migration item (enable migration).", + "operationId": "ReplicationMigrationItems_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Enable migration input.", + "required": true, + "schema": { + "$ref": "#/definitions/EnableMigrationInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Enables migration.": { + "$ref": "./examples/ReplicationMigrationItems_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Delete the migration item.", + "description": "The operation to delete an ASR migration item.", + "operationId": "ReplicationMigrationItems_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "deleteOption", + "in": "query", + "description": "The delete option.", + "required": false, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete the migration item.": { + "$ref": "./examples/ReplicationMigrationItems_Delete.json" + } + } + }, + "patch": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Updates migration item.", + "description": "The operation to update the recovery settings of an ASR migration item.", + "operationId": "ReplicationMigrationItems_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Update migration item input.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateMigrationItemInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates migration item.": { + "$ref": "./examples/ReplicationMigrationItems_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/migrate": { + "post": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Migrate item.", + "description": "The operation to initiate migration of the item.", + "operationId": "ReplicationMigrationItems_Migrate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "migrateInput", + "in": "body", + "description": "Migrate input.", + "required": true, + "schema": { + "$ref": "#/definitions/MigrateInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Migrate item.": { + "$ref": "./examples/ReplicationMigrationItems_Migrate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/migrationRecoveryPoints": { + "get": { + "tags": [ + "MigrationRecoveryPoints" + ], + "summary": "Gets the recovery points for a migration item.", + "operationId": "MigrationRecoveryPoints_ListByReplicationMigrationItems", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric unique name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationRecoveryPointCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the recovery points for a migration item.": { + "$ref": "./examples/MigrationRecoveryPoints_ListByReplicationMigrationItems.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/migrationRecoveryPoints/{migrationRecoveryPointName}": { + "get": { + "tags": [ + "MigrationRecoveryPoints" + ], + "summary": "Gets a recovery point for a migration item.", + "operationId": "MigrationRecoveryPoints_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric unique name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "migrationRecoveryPointName", + "in": "path", + "description": "The migration recovery point name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationRecoveryPoint" + } + } + }, + "x-ms-examples": { + "Gets a recovery point for a migration item.": { + "$ref": "./examples/MigrationRecoveryPoints_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/resync": { + "post": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Resynchronizes replication.", + "description": "The operation to resynchronize replication of an ASR migration item.", + "operationId": "ReplicationMigrationItems_Resync", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Resync input.", + "required": true, + "schema": { + "$ref": "#/definitions/ResyncInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Resynchronizes replication.": { + "$ref": "./examples/ReplicationMigrationItems_Resync.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/testMigrate": { + "post": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Test migrate item.", + "description": "The operation to initiate test migration of the item.", + "operationId": "ReplicationMigrationItems_TestMigrate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "testMigrateInput", + "in": "body", + "description": "Test migrate input.", + "required": true, + "schema": { + "$ref": "#/definitions/TestMigrateInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Test migrate item.": { + "$ref": "./examples/ReplicationMigrationItems_TestMigrate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/testMigrateCleanup": { + "post": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Test migrate cleanup.", + "description": "The operation to initiate test migrate cleanup.", + "operationId": "ReplicationMigrationItems_TestMigrateCleanup", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "testMigrateCleanupInput", + "in": "body", + "description": "Test migrate cleanup input.", + "required": true, + "schema": { + "$ref": "#/definitions/TestMigrateCleanupInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Test migrate cleanup.": { + "$ref": "./examples/ReplicationMigrationItems_TestMigrateCleanup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectableItems": { + "get": { + "tags": [ + "ReplicationProtectableItems" + ], + "summary": "Gets the list of protectable items.", + "description": "Lists the protectable items in a protection container.", + "operationId": "ReplicationProtectableItems_ListByReplicationProtectionContainers", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + }, + { + "name": "$take", + "in": "query", + "description": "take OData query parameter.", + "required": false, + "type": "string" + }, + { + "name": "$skipToken", + "in": "query", + "description": "skipToken OData query parameter.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectableItemCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ProtectableItemQueryParameter", + "x-ms-examples": { + "Gets the list of protectable items.": { + "$ref": "./examples/ReplicationProtectableItems_ListByReplicationProtectionContainers.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectableItems/{protectableItemName}": { + "get": { + "tags": [ + "ReplicationProtectableItems" + ], + "summary": "Gets the details of a protectable item.", + "description": "The operation to get the details of a protectable item.", + "operationId": "ReplicationProtectableItems_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "protectableItemName", + "in": "path", + "description": "Protectable item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectableItem" + } + } + }, + "x-ms-examples": { + "Gets the details of a protectable item.": { + "$ref": "./examples/ReplicationProtectableItems_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems": { + "get": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Gets the list of Replication protected items.", + "description": "Gets the list of ASR replication protected items in the protection container.", + "operationId": "ReplicationProtectedItems_ListByReplicationProtectionContainers", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItemCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of Replication protected items.": { + "$ref": "./examples/ReplicationProtectedItems_ListByReplicationProtectionContainers.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}": { + "get": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Gets the details of a Replication protected item.", + "description": "Gets the details of an ASR replication protected item.", + "operationId": "ReplicationProtectedItems_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric unique name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + } + }, + "x-ms-examples": { + "Gets the details of a Replication protected item.": { + "$ref": "./examples/ReplicationProtectedItems_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Enables protection.", + "description": "The operation to create an ASR replication protected item (Enable replication).", + "operationId": "ReplicationProtectedItems_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Name of the fabric.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "A name for the replication protected item.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Enable Protection Input.", + "required": true, + "schema": { + "$ref": "#/definitions/EnableProtectionInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Enables protection.": { + "$ref": "./examples/ReplicationProtectedItems_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Purges protection.", + "description": "The operation to delete or purge a replication protected item. This operation will force delete the replication protected item. Use the remove operation on replication protected item to perform a clean disable replication for the item.", + "operationId": "ReplicationProtectedItems_Purge", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Purges protection.": { + "$ref": "./examples/ReplicationProtectedItems_Purge.json" + } + } + }, + "patch": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Updates the replication protected item settings.", + "description": "The operation to update the recovery settings of an ASR replication protected item.", + "operationId": "ReplicationProtectedItems_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "updateProtectionInput", + "in": "body", + "description": "Update protection input.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateReplicationProtectedItemInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates the replication protected Item settings.": { + "$ref": "./examples/ReplicationProtectedItems_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/addDisks": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Add disk(s) for protection.", + "description": "Operation to add disks(s) to the replication protected item.", + "operationId": "ReplicationProtectedItems_AddDisks", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "addDisksInput", + "in": "body", + "description": "Add disks input.", + "required": true, + "schema": { + "$ref": "#/definitions/AddDisksInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Add disk(s) for protection.": { + "$ref": "./examples/ReplicationProtectedItems_AddDisks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/applyRecoveryPoint": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Change or apply recovery point.", + "description": "The operation to change the recovery point of a failed over replication protected item.", + "operationId": "ReplicationProtectedItems_ApplyRecoveryPoint", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "The ARM fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "The protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "The replicated protected item name.", + "required": true, + "type": "string" + }, + { + "name": "applyRecoveryPointInput", + "in": "body", + "description": "The ApplyRecoveryPointInput.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplyRecoveryPointInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Change or apply recovery point.": { + "$ref": "./examples/ReplicationProtectedItems_ApplyRecoveryPoint.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/failoverCancel": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute cancel failover.", + "description": "Operation to cancel the failover of the replication protected item.", + "operationId": "ReplicationProtectedItems_FailoverCancel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute cancel failover.": { + "$ref": "./examples/ReplicationProtectedItems_FailoverCancel.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/failoverCommit": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute commit failover.", + "description": "Operation to commit the failover of the replication protected item.", + "operationId": "ReplicationProtectedItems_FailoverCommit", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute commit failover.": { + "$ref": "./examples/ReplicationProtectedItems_FailoverCommit.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/plannedFailover": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute planned failover.", + "description": "Operation to initiate a planned failover of the replication protected item.", + "operationId": "ReplicationProtectedItems_PlannedFailover", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "failoverInput", + "in": "body", + "description": "Planned failover input.", + "required": true, + "schema": { + "$ref": "#/definitions/PlannedFailoverInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute planned failover.": { + "$ref": "./examples/ReplicationProtectedItems_PlannedFailover.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/recoveryPoints": { + "get": { + "tags": [ + "RecoveryPoints" + ], + "summary": "Gets the list of recovery points for a replication protected item.", + "description": "Lists the available recovery points for a replication protected item.", + "operationId": "RecoveryPoints_ListByReplicationProtectedItems", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "The fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "The protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "The replication protected item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPointCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of recovery points for a replication protected item.": { + "$ref": "./examples/RecoveryPoints_ListByReplicationProtectedItems.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/recoveryPoints/{recoveryPointName}": { + "get": { + "tags": [ + "RecoveryPoints" + ], + "summary": "Gets a recovery point.", + "description": "Get the details of specified recovery point.", + "operationId": "RecoveryPoints_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "The fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "The protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "The replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "recoveryPointName", + "in": "path", + "description": "The recovery point name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPoint" + } + } + }, + "x-ms-examples": { + "Gets a recovery point.": { + "$ref": "./examples/RecoveryPoints_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/remove": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Disables protection.", + "description": "The operation to disable replication on a replication protected item. This will also remove the item.", + "operationId": "ReplicationProtectedItems_Delete", + "consumes": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "disableProtectionInput", + "in": "body", + "description": "Disable protection input.", + "required": true, + "schema": { + "$ref": "#/definitions/DisableProtectionInput" + } + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Disables protection.": { + "$ref": "./examples/ReplicationProtectedItems_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/removeDisks": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Removes disk(s).", + "description": "Operation to remove disk(s) from the replication protected item.", + "operationId": "ReplicationProtectedItems_RemoveDisks", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "removeDisksInput", + "in": "body", + "description": "Remove disks input.", + "required": true, + "schema": { + "$ref": "#/definitions/RemoveDisksInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Removes disk(s).": { + "$ref": "./examples/ReplicationProtectedItems_RemoveDisks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/repairReplication": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Resynchronize or repair replication.", + "description": "The operation to start resynchronize/repair replication for a replication protected item requiring resynchronization.", + "operationId": "ReplicationProtectedItems_RepairReplication", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "The name of the fabric.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "The name of the container.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "The name of the replication protected item.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Resynchronize or repair replication.": { + "$ref": "./examples/ReplicationProtectedItems_RepairReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/reProtect": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute Reverse Replication\\Reprotect.", + "description": "Operation to reprotect or reverse replicate a failed over replication protected item.", + "operationId": "ReplicationProtectedItems_Reprotect", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "reprotectInput", + "in": "body", + "description": "Reverse replication input.", + "required": true, + "schema": { + "$ref": "#/definitions/ReverseReplicationInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute Reverse Replication\\Reprotect.": { + "$ref": "./examples/ReplicationProtectedItems_Reprotect.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/resolveHealthErrors": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Resolve health errors.", + "description": "Operation to resolve health issues of the replication protected item.", + "operationId": "ReplicationProtectedItems_ResolveHealthErrors", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "resolveHealthInput", + "in": "body", + "description": "Health issue input object.", + "required": true, + "schema": { + "$ref": "#/definitions/ResolveHealthInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Resolve health errors.": { + "$ref": "./examples/ReplicationProtectedItems_ResolveHealthErrors.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/targetComputeSizes": { + "get": { + "tags": [ + "TargetComputeSizes" + ], + "summary": "Gets the list of target compute sizes for the replication protected item.", + "description": "Lists the available target compute sizes for a replication protected item.", + "operationId": "TargetComputeSizes_ListByReplicationProtectedItems", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TargetComputeSizeCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of target compute sizes for the replication protected item.": { + "$ref": "./examples/TargetComputeSizes_ListByReplicationProtectedItems.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/testFailover": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute test failover.", + "description": "Operation to perform a test failover of the replication protected item.", + "operationId": "ReplicationProtectedItems_TestFailover", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "testfailoverInput", + "in": "body", + "description": "Test failover input.", + "required": true, + "schema": { + "$ref": "#/definitions/TestFailoverInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute test failover.": { + "$ref": "./examples/ReplicationProtectedItems_TestFailover.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/testFailoverCleanup": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute test failover cleanup.", + "description": "Operation to clean up the test failover of a replication protected item.", + "operationId": "ReplicationProtectedItems_TestFailoverCleanup", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "cleanupInput", + "in": "body", + "description": "Test failover cleanup input.", + "required": true, + "schema": { + "$ref": "#/definitions/TestFailoverCleanupInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute test failover cleanup.": { + "$ref": "./examples/ReplicationProtectedItems_TestFailoverCleanup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/unplannedFailover": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute unplanned failover.", + "description": "Operation to initiate a failover of the replication protected item.", + "operationId": "ReplicationProtectedItems_UnplannedFailover", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "failoverInput", + "in": "body", + "description": "Failover input.", + "required": true, + "schema": { + "$ref": "#/definitions/UnplannedFailoverInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute unplanned failover.": { + "$ref": "./examples/ReplicationProtectedItems_UnplannedFailover.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicationProtectedItemName}/updateMobilityService": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Update the mobility service on a protected item.", + "description": "The operation to update(push update) the installed mobility service software on a replication protected item to the latest available version.", + "operationId": "ReplicationProtectedItems_UpdateMobilityService", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "The name of the fabric containing the protected item.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "The name of the container containing the protected item.", + "required": true, + "type": "string" + }, + { + "name": "replicationProtectedItemName", + "in": "path", + "description": "The name of the protected item on which the agent is to be updated.", + "required": true, + "type": "string" + }, + { + "name": "updateMobilityServiceRequest", + "in": "body", + "description": "Request to update the mobility service on the protected item.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateMobilityServiceRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update the mobility service on a protected item.": { + "$ref": "./examples/ReplicationProtectedItems_UpdateMobilityService.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings": { + "get": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Gets the list of protection container mappings for a protection container.", + "description": "Lists the protection container mappings for a protection container.", + "operationId": "ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerMappingCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of protection container mappings for a protection container.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings/{mappingName}": { + "get": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Gets a protection container mapping.", + "description": "Gets the details of a protection container mapping.", + "operationId": "ReplicationProtectionContainerMappings_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "mappingName", + "in": "path", + "description": "Protection Container mapping name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerMapping" + } + } + }, + "x-ms-examples": { + "Gets a protection container mapping.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Create protection container mapping.", + "description": "The operation to create a protection container mapping.", + "operationId": "ReplicationProtectionContainerMappings_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "mappingName", + "in": "path", + "description": "Protection container mapping name.", + "required": true, + "type": "string" + }, + { + "name": "creationInput", + "in": "body", + "description": "Mapping creation input.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateProtectionContainerMappingInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerMapping" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create protection container mapping.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Purge protection container mapping.", + "description": "The operation to purge(force delete) a protection container mapping.", + "operationId": "ReplicationProtectionContainerMappings_Purge", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "mappingName", + "in": "path", + "description": "Protection container mapping name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Purge protection container mapping.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_Purge.json" + } + } + }, + "patch": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Update protection container mapping.", + "description": "The operation to update protection container mapping.", + "operationId": "ReplicationProtectionContainerMappings_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "mappingName", + "in": "path", + "description": "Protection container mapping name.", + "required": true, + "type": "string" + }, + { + "name": "updateInput", + "in": "body", + "description": "Mapping update input.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateProtectionContainerMappingInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerMapping" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update protection container mapping.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings/{mappingName}/remove": { + "post": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Remove protection container mapping.", + "description": "The operation to delete or remove a protection container mapping.", + "operationId": "ReplicationProtectionContainerMappings_Delete", + "consumes": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "mappingName", + "in": "path", + "description": "Protection container mapping name.", + "required": true, + "type": "string" + }, + { + "name": "removalInput", + "in": "body", + "description": "Removal input.", + "required": true, + "schema": { + "$ref": "#/definitions/RemoveProtectionContainerMappingInput" + } + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Remove protection container mapping.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/switchprotection": { + "post": { + "tags": [ + "ReplicationProtectionContainers" + ], + "summary": "Switches protection from one container to another or one replication provider to another.", + "description": "Operation to switch protection from one container to another or one replication provider to another.", + "operationId": "ReplicationProtectionContainers_SwitchProtection", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "switchInput", + "in": "body", + "description": "Switch protection input.", + "required": true, + "schema": { + "$ref": "#/definitions/SwitchProtectionInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainer" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Switches protection from one container to another or one replication provider to another.": { + "$ref": "./examples/ReplicationProtectionContainers_SwitchProtection.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders": { + "get": { + "tags": [ + "ReplicationRecoveryServicesProviders" + ], + "summary": "Gets the list of registered recovery services providers for the fabric.", + "description": "Lists the registered recovery services providers for the specified fabric.", + "operationId": "ReplicationRecoveryServicesProviders_ListByReplicationFabrics", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryServicesProviderCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of registered recovery services providers for the fabric.": { + "$ref": "./examples/ReplicationRecoveryServicesProviders_ListByReplicationFabrics.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders/{providerName}": { + "get": { + "tags": [ + "ReplicationRecoveryServicesProviders" + ], + "summary": "Gets the details of a recovery services provider.", + "description": "Gets the details of registered recovery services provider.", + "operationId": "ReplicationRecoveryServicesProviders_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Recovery services provider name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryServicesProvider" + } + } + }, + "x-ms-examples": { + "Gets the details of a recovery services provider.": { + "$ref": "./examples/ReplicationRecoveryServicesProviders_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationRecoveryServicesProviders" + ], + "summary": "Adds a recovery services provider.", + "description": "The operation to add a recovery services provider.", + "operationId": "ReplicationRecoveryServicesProviders_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Recovery services provider name.", + "required": true, + "type": "string" + }, + { + "name": "addProviderInput", + "in": "body", + "description": "Add provider input.", + "required": true, + "schema": { + "$ref": "#/definitions/AddRecoveryServicesProviderInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryServicesProvider" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Adds a recovery services provider.": { + "$ref": "./examples/ReplicationRecoveryServicesProviders_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationRecoveryServicesProviders" + ], + "summary": "Purges recovery service provider from fabric.", + "description": "The operation to purge(force delete) a recovery services provider from the vault.", + "operationId": "ReplicationRecoveryServicesProviders_Purge", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Recovery services provider name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Purges recovery service provider from fabric.": { + "$ref": "./examples/ReplicationRecoveryServicesProviders_Purge.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders/{providerName}/refreshProvider": { + "post": { + "tags": [ + "ReplicationRecoveryServicesProviders" + ], + "summary": "Refresh details from the recovery services provider.", + "description": "The operation to refresh the information from the recovery services provider.", + "operationId": "ReplicationRecoveryServicesProviders_RefreshProvider", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Recovery services provider name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryServicesProvider" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Refresh details from the recovery services provider.": { + "$ref": "./examples/ReplicationRecoveryServicesProviders_RefreshProvider.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders/{providerName}/remove": { + "post": { + "tags": [ + "ReplicationRecoveryServicesProviders" + ], + "summary": "Deletes provider from fabric. Note: Deleting provider for any fabric other than SingleHost is unsupported. To maintain backward compatibility for released clients the object \"deleteRspInput\" is used (if the object is empty we assume that it is old client and continue the old behavior).", + "description": "The operation to removes/delete(unregister) a recovery services provider from the vault.", + "operationId": "ReplicationRecoveryServicesProviders_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Recovery services provider name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes provider from fabric. Note: Deleting provider for any fabric other than SingleHost is unsupported. To maintain backward compatibility for released clients the object \"deleteRspInput\" is used (if the object is empty we assume that it is old client and continue the old behavior).": { + "$ref": "./examples/ReplicationRecoveryServicesProviders_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationStorageClassifications": { + "get": { + "tags": [ + "ReplicationStorageClassifications" + ], + "summary": "Gets the list of storage classification objects under a fabric.", + "description": "Lists the storage classifications available in the specified fabric.", + "operationId": "ReplicationStorageClassifications_ListByReplicationFabrics", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Site name of interest.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageClassificationCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of storage classification objects under a fabric.": { + "$ref": "./examples/ReplicationStorageClassifications_ListByReplicationFabrics.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationStorageClassifications/{storageClassificationName}": { + "get": { + "tags": [ + "ReplicationStorageClassifications" + ], + "summary": "Gets the details of a storage classification.", + "description": "Gets the details of the specified storage classification.", + "operationId": "ReplicationStorageClassifications_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationName", + "in": "path", + "description": "Storage classification name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageClassification" + } + } + }, + "x-ms-examples": { + "Gets the details of a storage classification.": { + "$ref": "./examples/ReplicationStorageClassifications_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationStorageClassifications/{storageClassificationName}/replicationStorageClassificationMappings": { + "get": { + "tags": [ + "ReplicationStorageClassificationMappings" + ], + "summary": "Gets the list of storage classification mappings objects under a storage.", + "description": "Lists the storage classification mappings for the fabric.", + "operationId": "ReplicationStorageClassificationMappings_ListByReplicationStorageClassifications", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationName", + "in": "path", + "description": "Storage classification name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageClassificationMappingCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of storage classification mappings objects under a storage.": { + "$ref": "./examples/ReplicationStorageClassificationMappings_ListByReplicationStorageClassifications.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationStorageClassifications/{storageClassificationName}/replicationStorageClassificationMappings/{storageClassificationMappingName}": { + "get": { + "tags": [ + "ReplicationStorageClassificationMappings" + ], + "summary": "Gets the details of a storage classification mapping.", + "description": "Gets the details of the specified storage classification mapping.", + "operationId": "ReplicationStorageClassificationMappings_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationName", + "in": "path", + "description": "Storage classification name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationMappingName", + "in": "path", + "description": "Storage classification mapping name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageClassificationMapping" + } + } + }, + "x-ms-examples": { + "Gets the details of a storage classification mapping.": { + "$ref": "./examples/ReplicationStorageClassificationMappings_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationStorageClassificationMappings" + ], + "summary": "Create storage classification mapping.", + "description": "The operation to create a storage classification mapping.", + "operationId": "ReplicationStorageClassificationMappings_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationName", + "in": "path", + "description": "Storage classification name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationMappingName", + "in": "path", + "description": "Storage classification mapping name.", + "required": true, + "type": "string" + }, + { + "name": "pairingInput", + "in": "body", + "description": "Pairing input.", + "required": true, + "schema": { + "$ref": "#/definitions/StorageClassificationMappingInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageClassificationMapping" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create storage classification mapping.": { + "$ref": "./examples/ReplicationStorageClassificationMappings_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationStorageClassificationMappings" + ], + "summary": "Delete a storage classification mapping.", + "description": "The operation to delete a storage classification mapping.", + "operationId": "ReplicationStorageClassificationMappings_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationName", + "in": "path", + "description": "Storage classification name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationMappingName", + "in": "path", + "description": "Storage classification mapping name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a storage classification mapping.": { + "$ref": "./examples/ReplicationStorageClassificationMappings_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationvCenters": { + "get": { + "tags": [ + "ReplicationvCenters" + ], + "summary": "Gets the list of vCenter registered under a fabric.", + "description": "Lists the vCenter servers registered in a fabric.", + "operationId": "ReplicationvCenters_ListByReplicationFabrics", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VCenterCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of vCenter registered under a fabric.": { + "$ref": "./examples/ReplicationvCenters_ListByReplicationFabrics.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationvCenters/{vcenterName}": { + "get": { + "tags": [ + "ReplicationvCenters" + ], + "summary": "Gets the details of a vCenter.", + "description": "Gets the details of a registered vCenter server(Add vCenter server).", + "operationId": "ReplicationvCenters_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "vcenterName", + "in": "path", + "description": "vcenter name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VCenter" + } + } + }, + "x-ms-examples": { + "Gets the details of a vCenter.": { + "$ref": "./examples/ReplicationvCenters_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationvCenters" + ], + "summary": "Add vCenter.", + "description": "The operation to create a vCenter object..", + "operationId": "ReplicationvCenters_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "vcenterName", + "in": "path", + "description": "vcenter name.", + "required": true, + "type": "string" + }, + { + "name": "addVCenterRequest", + "in": "body", + "description": "The input to the add vCenter operation.", + "required": true, + "schema": { + "$ref": "#/definitions/AddVCenterRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VCenter" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Add vCenter.": { + "$ref": "./examples/ReplicationvCenters_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationvCenters" + ], + "summary": "Remove vcenter operation.", + "description": "The operation to remove(unregister) a registered vCenter server from the vault.", + "operationId": "ReplicationvCenters_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "vcenterName", + "in": "path", + "description": "vcenter name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Remove vCenter operation.": { + "$ref": "./examples/ReplicationvCenters_Delete.json" + } + } + }, + "patch": { + "tags": [ + "ReplicationvCenters" + ], + "summary": "Update vCenter operation.", + "description": "The operation to update a registered vCenter.", + "operationId": "ReplicationvCenters_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "vcenterName", + "in": "path", + "description": "vcenter name.", + "required": true, + "type": "string" + }, + { + "name": "updateVCenterRequest", + "in": "body", + "description": "The input to the update vCenter operation.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateVCenterRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VCenter" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update vCenter operation.": { + "$ref": "./examples/ReplicationvCenters_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs": { + "get": { + "tags": [ + "ReplicationJobs" + ], + "summary": "Gets the list of jobs.", + "description": "Gets the list of Azure Site Recovery Jobs for the vault.", + "operationId": "ReplicationJobs_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/JobQueryParameter", + "x-ms-examples": { + "Gets the list of jobs.": { + "$ref": "./examples/ReplicationJobs_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}": { + "get": { + "tags": [ + "ReplicationJobs" + ], + "summary": "Gets the job details.", + "description": "Get the details of an Azure Site Recovery job.", + "operationId": "ReplicationJobs_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "jobName", + "in": "path", + "description": "Job identifier.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Job" + } + } + }, + "x-ms-examples": { + "Gets the job details.": { + "$ref": "./examples/ReplicationJobs_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}/cancel": { + "post": { + "tags": [ + "ReplicationJobs" + ], + "summary": "Cancels the specified job.", + "description": "The operation to cancel an Azure Site Recovery job.", + "operationId": "ReplicationJobs_Cancel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "jobName", + "in": "path", + "description": "Job identifier.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Cancels the specified job.": { + "$ref": "./examples/ReplicationJobs_Cancel.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}/restart": { + "post": { + "tags": [ + "ReplicationJobs" + ], + "summary": "Restarts the specified job.", + "description": "The operation to restart an Azure Site Recovery job.", + "operationId": "ReplicationJobs_Restart", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "jobName", + "in": "path", + "description": "Job identifier.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Restarts the specified job.": { + "$ref": "./examples/ReplicationJobs_Restart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}/resume": { + "post": { + "tags": [ + "ReplicationJobs" + ], + "summary": "Resumes the specified job.", + "description": "The operation to resume an Azure Site Recovery job.", + "operationId": "ReplicationJobs_Resume", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "jobName", + "in": "path", + "description": "Job identifier.", + "required": true, + "type": "string" + }, + { + "name": "resumeJobParams", + "in": "body", + "description": "Resume rob comments.", + "required": true, + "schema": { + "$ref": "#/definitions/ResumeJobParams" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Resumes the specified job.": { + "$ref": "./examples/ReplicationJobs_Resume.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/export": { + "post": { + "tags": [ + "ReplicationJobs" + ], + "summary": "Exports the details of the Azure Site Recovery jobs of the vault.", + "description": "The operation to export the details of the Azure Site Recovery jobs of the vault.", + "operationId": "ReplicationJobs_Export", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "jobQueryParameter", + "in": "body", + "description": "job query filter.", + "required": true, + "schema": { + "$ref": "#/definitions/JobQueryParameter" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Exports the details of the Azure Site Recovery jobs of the vault.": { + "$ref": "./examples/ReplicationJobs_Export.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationMigrationItems": { + "get": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Gets the list of migration items in the vault.", + "operationId": "ReplicationMigrationItems_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "skipToken", + "in": "query", + "description": "The pagination token.", + "required": false, + "type": "string" + }, + { + "name": "takeToken", + "in": "query", + "description": "The page size.", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItemCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/MigrationItemsQueryParameter", + "x-ms-examples": { + "Gets the list of migration items in the vault.": { + "$ref": "./examples/ReplicationMigrationItems_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationNetworkMappings": { + "get": { + "tags": [ + "ReplicationNetworkMappings" + ], + "summary": "Gets all the network mappings under a vault.", + "description": "Lists all ASR network mappings in the vault.", + "operationId": "ReplicationNetworkMappings_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkMappingCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all the network mappings under a vault.": { + "$ref": "./examples/ReplicationNetworkMappings_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationNetworks": { + "get": { + "tags": [ + "ReplicationNetworks" + ], + "summary": "Gets the list of networks. View-only API.", + "description": "Lists the networks available in a vault.", + "operationId": "ReplicationNetworks_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of networks. View-only API.": { + "$ref": "./examples/ReplicationNetworks_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationPolicies": { + "get": { + "tags": [ + "ReplicationPolicies" + ], + "summary": "Gets the list of replication policies.", + "description": "Lists the replication policies for a vault.", + "operationId": "ReplicationPolicies_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PolicyCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of replication policies.": { + "$ref": "./examples/ReplicationPolicies_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationPolicies/{policyName}": { + "get": { + "tags": [ + "ReplicationPolicies" + ], + "summary": "Gets the requested policy.", + "description": "Gets the details of a replication policy.", + "operationId": "ReplicationPolicies_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "policyName", + "in": "path", + "description": "Replication policy name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Policy" + } + } + }, + "x-ms-examples": { + "Gets the requested policy.": { + "$ref": "./examples/ReplicationPolicies_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationPolicies" + ], + "summary": "Creates the policy.", + "description": "The operation to create a replication policy.", + "operationId": "ReplicationPolicies_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "policyName", + "in": "path", + "description": "Replication policy name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Create policy input.", + "required": true, + "schema": { + "$ref": "#/definitions/CreatePolicyInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Policy" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Creates the policy.": { + "$ref": "./examples/ReplicationPolicies_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationPolicies" + ], + "summary": "Delete the policy.", + "description": "The operation to delete a replication policy.", + "operationId": "ReplicationPolicies_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "policyName", + "in": "path", + "description": "Replication policy name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete the policy.": { + "$ref": "./examples/ReplicationPolicies_Delete.json" + } + } + }, + "patch": { + "tags": [ + "ReplicationPolicies" + ], + "summary": "Updates the policy.", + "description": "The operation to update a replication policy.", + "operationId": "ReplicationPolicies_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "policyName", + "in": "path", + "description": "Policy Id.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Update Policy Input.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdatePolicyInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Policy" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates the policy.": { + "$ref": "./examples/ReplicationPolicies_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectedItems": { + "get": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Gets the list of replication protected items.", + "description": "Gets the list of ASR replication protected items in the vault.", + "operationId": "ReplicationProtectedItems_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "skipToken", + "in": "query", + "description": "The pagination token. Possible values: \"FabricId\" or \"FabricId_CloudId\" or null.", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItemCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ProtectedItemsQueryParameter", + "x-ms-examples": { + "Gets the list of replication protected items.": { + "$ref": "./examples/ReplicationProtectedItems_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionContainerMappings": { + "get": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Gets the list of all protection container mappings in a vault.", + "description": "Lists the protection container mappings in the vault.", + "operationId": "ReplicationProtectionContainerMappings_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerMappingCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of all protection container mappings in a vault.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionContainers": { + "get": { + "tags": [ + "ReplicationProtectionContainers" + ], + "summary": "Gets the list of all protection containers in a vault.", + "description": "Lists the protection containers in a vault.", + "operationId": "ReplicationProtectionContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of all protection containers in a vault.": { + "$ref": "./examples/ReplicationProtectionContainers_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionIntents": { + "get": { + "tags": [ + "ReplicationProtectionIntents" + ], + "summary": "Gets the list of replication protection intent objects.", + "description": "Gets the list of ASR replication protection intent objects in the vault.", + "operationId": "ReplicationProtectionIntents_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "skipToken", + "in": "query", + "description": "The pagination token.", + "required": false, + "type": "string" + }, + { + "name": "takeToken", + "in": "query", + "description": "The page size.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectionIntentCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of replication protection intent objects.": { + "$ref": "./examples/ReplicationProtectionIntents_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionIntents/{intentObjectName}": { + "get": { + "tags": [ + "ReplicationProtectionIntents" + ], + "summary": "Gets the details of a Replication protection intent item.", + "description": "Gets the details of an ASR replication protection intent.", + "operationId": "ReplicationProtectionIntents_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "intentObjectName", + "in": "path", + "description": "Replication protection intent name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectionIntent" + } + } + }, + "x-ms-examples": { + "Gets the details of a Replication protection intent item.": { + "$ref": "./examples/ReplicationProtectionIntents_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationProtectionIntents" + ], + "summary": "Create protection intent Resource.", + "description": "The operation to create an ASR replication protection intent item.", + "operationId": "ReplicationProtectionIntents_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "intentObjectName", + "in": "path", + "description": "A name for the replication protection item.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Create Protection Intent Input.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateProtectionIntentInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectionIntent" + } + } + }, + "x-ms-examples": { + "Create protection intent Resource.": { + "$ref": "./examples/ReplicationProtectionIntents_Create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans": { + "get": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Gets the list of recovery plans.", + "description": "Lists the recovery plans in the vault.", + "operationId": "ReplicationRecoveryPlans_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlanCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of recovery plans.": { + "$ref": "./examples/ReplicationRecoveryPlans_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}": { + "get": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Gets the requested recovery plan.", + "description": "Gets the details of the recovery plan.", + "operationId": "ReplicationRecoveryPlans_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Name of the recovery plan.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + } + }, + "x-ms-examples": { + "Gets the requested recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Creates a recovery plan with the given details.", + "description": "The operation to create a recovery plan.", + "operationId": "ReplicationRecoveryPlans_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Recovery Plan creation input.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateRecoveryPlanInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Creates a recovery plan with the given details.": { + "$ref": "./examples/ReplicationRecoveryPlans_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Deletes the specified recovery plan.", + "description": "Delete a recovery plan.", + "operationId": "ReplicationRecoveryPlans_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes the specified recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_Delete.json" + } + } + }, + "patch": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Updates the given recovery plan.", + "description": "The operation to update a recovery plan.", + "operationId": "ReplicationRecoveryPlans_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Update recovery plan input.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateRecoveryPlanInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates the given recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/failoverCancel": { + "post": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Execute cancel failover of the recovery plan.", + "description": "The operation to cancel the failover of a recovery plan.", + "operationId": "ReplicationRecoveryPlans_FailoverCancel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute cancel failover of the recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_FailoverCancel.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/failoverCommit": { + "post": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Execute commit failover of the recovery plan.", + "description": "The operation to commit the failover of a recovery plan.", + "operationId": "ReplicationRecoveryPlans_FailoverCommit", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute commit failover of the recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_FailoverCommit.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/plannedFailover": { + "post": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Execute planned failover of the recovery plan.", + "description": "The operation to start the planned failover of a recovery plan.", + "operationId": "ReplicationRecoveryPlans_PlannedFailover", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Failover input.", + "required": true, + "schema": { + "$ref": "#/definitions/RecoveryPlanPlannedFailoverInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute planned failover of the recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_PlannedFailover.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/reProtect": { + "post": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Execute reprotect of the recovery plan.", + "description": "The operation to reprotect(reverse replicate) a recovery plan.", + "operationId": "ReplicationRecoveryPlans_Reprotect", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute reprotect of the recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_Reprotect.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/testFailover": { + "post": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Execute test failover of the recovery plan.", + "description": "The operation to start the test failover of a recovery plan.", + "operationId": "ReplicationRecoveryPlans_TestFailover", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Recovery plan test failover input.", + "required": true, + "schema": { + "$ref": "#/definitions/RecoveryPlanTestFailoverInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute test failover of the recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_TestFailover.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/testFailoverCleanup": { + "post": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Execute test failover cleanup of the recovery plan.", + "description": "The operation to cleanup test failover of a recovery plan.", + "operationId": "ReplicationRecoveryPlans_TestFailoverCleanup", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Recovery plan test failover cleanup input.", + "required": true, + "schema": { + "$ref": "#/definitions/RecoveryPlanTestFailoverCleanupInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute test failover cleanup of the recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_TestFailoverCleanup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/unplannedFailover": { + "post": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Execute unplanned failover of the recovery plan.", + "description": "The operation to start the unplanned failover of a recovery plan.", + "operationId": "ReplicationRecoveryPlans_UnplannedFailover", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Recovery plan unplanned failover input.", + "required": true, + "schema": { + "$ref": "#/definitions/RecoveryPlanUnplannedFailoverInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute unplanned failover of the recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_UnplannedFailover.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryServicesProviders": { + "get": { + "tags": [ + "ReplicationRecoveryServicesProviders" + ], + "summary": "Gets the list of registered recovery services providers in the vault. This is a view only api.", + "description": "Lists the registered recovery services providers in the vault.", + "operationId": "ReplicationRecoveryServicesProviders_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryServicesProviderCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of registered recovery services providers in the vault. This is a view only api.": { + "$ref": "./examples/ReplicationRecoveryServicesProviders_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationStorageClassificationMappings": { + "get": { + "tags": [ + "ReplicationStorageClassificationMappings" + ], + "summary": "Gets the list of storage classification mappings objects under a vault.", + "description": "Lists the storage classification mappings in the vault.", + "operationId": "ReplicationStorageClassificationMappings_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageClassificationMappingCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of storage classification mappings objects under a vault.": { + "$ref": "./examples/ReplicationStorageClassificationMappings_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationStorageClassifications": { + "get": { + "tags": [ + "ReplicationStorageClassifications" + ], + "summary": "Gets the list of storage classification objects under a vault.", + "description": "Lists the storage classifications in the vault.", + "operationId": "ReplicationStorageClassifications_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageClassificationCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of storage classification objects under a vault.": { + "$ref": "./examples/ReplicationStorageClassifications_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationSupportedOperatingSystems": { + "get": { + "tags": [ + "SupportedOperatingSystems" + ], + "summary": "Gets the data of supported operating systems by SRS.", + "operationId": "SupportedOperatingSystems_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "instanceType", + "in": "query", + "description": "The instance type.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SupportedOperatingSystems" + } + } + }, + "x-ms-examples": { + "Gets the data of supported operating systems by SRS.": { + "$ref": "./examples/SupportedOperatingSystems_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultHealth": { + "get": { + "tags": [ + "ReplicationVaultHealth" + ], + "summary": "Gets the health summary for the vault.", + "description": "Gets the health details of the vault.", + "operationId": "ReplicationVaultHealth_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultHealthDetails" + } + } + }, + "x-ms-examples": { + "Gets the health summary for the vault.": { + "$ref": "./examples/ReplicationVaultHealth_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultHealth/default/refresh": { + "post": { + "tags": [ + "ReplicationVaultHealth" + ], + "summary": "Refreshes health summary of the vault.", + "operationId": "ReplicationVaultHealth_Refresh", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultHealthDetails" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Refreshes health summary of the vault.": { + "$ref": "./examples/ReplicationVaultHealth_Refresh.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultSettings": { + "get": { + "tags": [ + "ReplicationVaultSetting" + ], + "summary": "Gets the list of vault setting.", + "description": "Gets the list of vault setting. This includes the Migration Hub connection settings.", + "operationId": "ReplicationVaultSetting_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultSettingCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of vault setting.": { + "$ref": "./examples/ReplicationVaultSetting_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultSettings/{vaultSettingName}": { + "get": { + "tags": [ + "ReplicationVaultSetting" + ], + "summary": "Gets the vault setting.", + "description": "Gets the vault setting. This includes the Migration Hub connection settings.", + "operationId": "ReplicationVaultSetting_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "vaultSettingName", + "in": "path", + "description": "Vault setting name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultSetting" + } + } + }, + "x-ms-examples": { + "Gets the vault setting.": { + "$ref": "./examples/ReplicationVaultSetting_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationVaultSetting" + ], + "summary": "Updates vault setting. A vault setting object is a singleton per vault and it is always present by default.", + "description": "The operation to configure vault setting.", + "operationId": "ReplicationVaultSetting_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "vaultSettingName", + "in": "path", + "description": "Vault setting name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Vault setting creation input.", + "required": true, + "schema": { + "$ref": "#/definitions/VaultSettingCreationInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultSetting" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates vault setting. A vault setting object is a singleton per vault and it is always present by default.": { + "$ref": "./examples/ReplicationVaultSetting_Create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationvCenters": { + "get": { + "tags": [ + "ReplicationvCenters" + ], + "summary": "Gets the list of vCenter registered under the vault.", + "description": "Lists the vCenter servers registered in the vault.", + "operationId": "ReplicationvCenters_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VCenterCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of vCenter registered under the vault.": { + "$ref": "./examples/ReplicationvCenters_List.json" + } + } + } + } + }, + "definitions": { + "A2AAddDisksInput": { + "description": "A2A add disk(s) input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AddDisksProviderSpecificInput" + } + ], + "properties": { + "vmDisks": { + "description": "The list of vm disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmDiskInputDetails" + } + }, + "vmManagedDisks": { + "description": "The list of vm managed disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmManagedDiskInputDetails" + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AApplyRecoveryPointInput": { + "description": "ApplyRecoveryPoint input specific to A2A provider.", + "required": [ + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "A2A" + }, + "A2AContainerCreationInput": { + "description": "A2A cloud creation input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificContainerCreationInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "A2A" + }, + "A2AContainerMappingInput": { + "description": "A2A container mapping input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificContainerMappingInput" + } + ], + "properties": { + "agentAutoUpdateStatus": { + "description": "A value indicating whether the auto update is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentAutoUpdateStatus", + "modelAsString": true + } + }, + "automationAccountArmId": { + "description": "The automation account arm id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2ACreateProtectionIntentInput": { + "description": "A2A create protection intent input.", + "required": [ + "fabricObjectId", + "primaryLocation", + "recoveryLocation", + "recoverySubscriptionId", + "recoveryAvailabilityType", + "recoveryResourceGroupId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CreateProtectionIntentProviderSpecificDetails" + } + ], + "properties": { + "fabricObjectId": { + "description": "The fabric specific object Id of the virtual machine.", + "type": "string" + }, + "primaryLocation": { + "description": "The primary location for the virtual machine.", + "type": "string" + }, + "recoveryLocation": { + "description": "The recovery location for the virtual machine.", + "type": "string" + }, + "recoverySubscriptionId": { + "description": "The recovery subscription Id of the virtual machine.", + "type": "string" + }, + "recoveryAvailabilityType": { + "description": "The recovery availability type of the virtual machine.", + "enum": [ + "Single", + "AvailabilitySet", + "AvailabilityZone" + ], + "type": "string", + "x-ms-enum": { + "name": "A2ARecoveryAvailabilityType", + "modelAsString": true + } + }, + "protectionProfileCustomInput": { + "$ref": "#/definitions/ProtectionProfileCustomDetails", + "description": "The protection profile custom inputs." + }, + "recoveryResourceGroupId": { + "description": "The recovery resource group Id. Valid for V2 scenarios.", + "type": "string" + }, + "primaryStagingStorageAccountCustomInput": { + "$ref": "#/definitions/StorageAccountCustomDetails", + "description": "The primary staging storage account input." + }, + "recoveryAvailabilitySetCustomInput": { + "$ref": "#/definitions/RecoveryAvailabilitySetCustomDetails", + "description": "The recovery availability set input." + }, + "recoveryVirtualNetworkCustomInput": { + "$ref": "#/definitions/RecoveryVirtualNetworkCustomDetails", + "description": "The recovery virtual network input." + }, + "recoveryProximityPlacementGroupCustomInput": { + "$ref": "#/definitions/RecoveryProximityPlacementGroupCustomDetails", + "description": "The recovery proximity placement group custom input." + }, + "autoProtectionOfDataDisk": { + "description": "A value indicating whether the auto protection is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoProtectionOfDataDisk", + "modelAsString": true + } + }, + "vmDisks": { + "description": "The list of vm disk inputs.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AProtectionIntentDiskInputDetails" + } + }, + "vmManagedDisks": { + "description": "The list of vm managed disk inputs.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AProtectionIntentManagedDiskInputDetails" + } + }, + "multiVmGroupName": { + "description": "The multi vm group name.", + "type": "string" + }, + "multiVmGroupId": { + "description": "The multi vm group id.", + "type": "string" + }, + "recoveryBootDiagStorageAccount": { + "$ref": "#/definitions/StorageAccountCustomDetails", + "description": "The boot diagnostic storage account." + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery disk encryption information (for two pass flows)." + }, + "recoveryAvailabilityZone": { + "description": "The recovery availability zone.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2ACrossClusterMigrationApplyRecoveryPointInput": { + "description": "ApplyRecoveryPoint input specific to A2ACrossClusterMigration provider.", + "required": [ + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "A2ACrossClusterMigration" + }, + "A2ACrossClusterMigrationContainerCreationInput": { + "description": "A2ACrossClusterMigration cloud creation input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificContainerCreationInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "A2ACrossClusterMigration" + }, + "A2ACrossClusterMigrationEnableProtectionInput": { + "description": "A2A Cross-Cluster Migration enable protection input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnableProtectionProviderSpecificInput" + } + ], + "properties": { + "fabricObjectId": { + "description": "The fabric specific object Id of the virtual machine.", + "type": "string" + }, + "recoveryContainerId": { + "description": "The recovery container Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2ACrossClusterMigration" + }, + "A2ACrossClusterMigrationPolicyCreationInput": { + "description": "A2A Cross-Cluster Migration Policy creation input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "A2ACrossClusterMigration" + }, + "A2ACrossClusterMigrationReplicationDetails": { + "description": "A2A provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "fabricObjectId": { + "description": "The fabric specific object Id of the virtual machine.", + "type": "string" + }, + "primaryFabricLocation": { + "description": "Primary fabric location.", + "type": "string" + }, + "osType": { + "description": "The type of operating system.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "lifecycleId": { + "description": "An id associated with the PE that survives actions like switch protection which change the backing PE/CPE objects internally.The lifecycle id gets carried forward to have a link/continuity in being able to have an Id that denotes the \"same\" protected item even though other internal Ids/ARM Id might be changing.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2ACrossClusterMigration" + }, + "A2AEnableProtectionInput": { + "description": "A2A enable protection input.", + "required": [ + "fabricObjectId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnableProtectionProviderSpecificInput" + } + ], + "properties": { + "fabricObjectId": { + "description": "The fabric specific object Id of the virtual machine.", + "type": "string" + }, + "recoveryContainerId": { + "description": "The recovery container Id.", + "type": "string" + }, + "recoveryResourceGroupId": { + "description": "The recovery resource group Id. Valid for V2 scenarios.", + "type": "string" + }, + "recoveryCloudServiceId": { + "description": "The recovery cloud service Id. Valid for V1 scenarios.", + "type": "string" + }, + "recoveryAvailabilitySetId": { + "description": "The recovery availability set Id.", + "type": "string" + }, + "recoveryProximityPlacementGroupId": { + "description": "The recovery proximity placement group Id.", + "type": "string" + }, + "vmDisks": { + "description": "The list of vm disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmDiskInputDetails" + } + }, + "vmManagedDisks": { + "description": "The list of vm managed disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmManagedDiskInputDetails" + } + }, + "multiVmGroupName": { + "description": "The multi vm group name.", + "type": "string" + }, + "multiVmGroupId": { + "description": "The multi vm group id.", + "type": "string" + }, + "recoveryBootDiagStorageAccountId": { + "description": "The boot diagnostic storage account.", + "type": "string" + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery disk encryption information (for two pass flows)." + }, + "recoveryAvailabilityZone": { + "description": "The recovery availability zone.", + "type": "string" + }, + "recoveryAzureNetworkId": { + "description": "The recovery Azure virtual network ARM id.", + "type": "string" + }, + "recoverySubnetName": { + "description": "The recovery subnet name.", + "type": "string" + }, + "recoveryVirtualMachineScaleSetId": { + "description": "The virtual machine scale set Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AEventDetails": { + "description": "Model class for event details of a A2A event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "protectedItemName": { + "description": "The protected item arm name.", + "type": "string" + }, + "fabricObjectId": { + "description": "The azure vm arm id.", + "type": "string" + }, + "fabricName": { + "description": "Fabric arm name.", + "type": "string" + }, + "fabricLocation": { + "description": "The fabric location.", + "type": "string" + }, + "remoteFabricName": { + "description": "Remote fabric arm name.", + "type": "string" + }, + "remoteFabricLocation": { + "description": "Remote fabric location.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2APolicyCreationInput": { + "description": "A2A Policy creation input.", + "required": [ + "multiVmSyncStatus" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'.", + "enum": [ + "Enable", + "Disable" + ], + "type": "string", + "x-ms-enum": { + "name": "SetMultiVmSyncStatus", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2APolicyDetails": { + "description": "A2A specific policy details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPointThresholdInMinutes": { + "format": "int32", + "description": "The recovery point threshold in minutes.", + "type": "integer" + }, + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency in minutes.", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled.", + "type": "string" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency in minutes.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AProtectedDiskDetails": { + "description": "A2A protected disk details.", + "type": "object", + "properties": { + "diskUri": { + "description": "The disk uri.", + "type": "string" + }, + "recoveryAzureStorageAccountId": { + "description": "The recovery disk storage account.", + "type": "string" + }, + "primaryDiskAzureStorageAccountId": { + "description": "The primary disk storage account.", + "type": "string" + }, + "recoveryDiskUri": { + "description": "Recovery disk uri.", + "type": "string" + }, + "diskName": { + "description": "The disk name.", + "type": "string" + }, + "diskCapacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer" + }, + "primaryStagingAzureStorageAccountId": { + "description": "The primary staging storage account.", + "type": "string" + }, + "diskType": { + "description": "The type of disk.", + "type": "string" + }, + "resyncRequired": { + "description": "A value indicating whether resync is required for this disk.", + "type": "boolean" + }, + "monitoringPercentageCompletion": { + "format": "int32", + "description": "The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property.", + "type": "integer" + }, + "monitoringJobType": { + "description": "The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property.", + "type": "string" + }, + "dataPendingInStagingStorageAccountInMB": { + "format": "double", + "description": "The data pending for replication in MB at staging account.", + "type": "number" + }, + "dataPendingAtSourceAgentInMB": { + "format": "double", + "description": "The data pending at source virtual machine in MB.", + "type": "number" + }, + "diskState": { + "description": "The disk state.", + "type": "string" + }, + "allowedDiskLevelOperation": { + "description": "The disk level operations list.", + "type": "array", + "items": { + "type": "string" + } + }, + "isDiskEncrypted": { + "description": "A value indicating whether vm has encrypted os disk or not.", + "type": "boolean" + }, + "secretIdentifier": { + "description": "The secret URL / identifier (BEK).", + "type": "string" + }, + "dekKeyVaultArmId": { + "description": "The KeyVault resource id for secret (BEK).", + "type": "string" + }, + "isDiskKeyEncrypted": { + "description": "A value indicating whether disk key got encrypted or not.", + "type": "boolean" + }, + "keyIdentifier": { + "description": "The key URL / identifier (KEK).", + "type": "string" + }, + "kekKeyVaultArmId": { + "description": "The KeyVault resource id for key (KEK).", + "type": "string" + }, + "failoverDiskName": { + "description": "The failover name for the managed disk.", + "type": "string" + }, + "tfoDiskName": { + "description": "The test failover name for the managed disk.", + "type": "string" + } + } + }, + "A2AProtectedManagedDiskDetails": { + "description": "A2A protected managed disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The managed disk Arm id.", + "type": "string" + }, + "recoveryResourceGroupId": { + "description": "The recovery disk resource group Arm Id.", + "type": "string" + }, + "recoveryTargetDiskId": { + "description": "Recovery target disk Arm Id.", + "type": "string" + }, + "recoveryReplicaDiskId": { + "description": "Recovery replica disk Arm Id.", + "type": "string" + }, + "recoveryOrignalTargetDiskId": { + "description": "Recovery original target disk Arm Id.", + "type": "string" + }, + "recoveryReplicaDiskAccountType": { + "description": "The replica disk type. Its an optional value and will be same as source disk type if not user provided.", + "type": "string" + }, + "recoveryTargetDiskAccountType": { + "description": "The target disk type after failover. Its an optional value and will be same as source disk type if not user provided.", + "type": "string" + }, + "recoveryDiskEncryptionSetId": { + "description": "The recovery disk encryption set Id.", + "type": "string" + }, + "primaryDiskEncryptionSetId": { + "description": "The primary disk encryption set Id.", + "type": "string" + }, + "diskName": { + "description": "The disk name.", + "type": "string" + }, + "diskCapacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer" + }, + "primaryStagingAzureStorageAccountId": { + "description": "The primary staging storage account.", + "type": "string" + }, + "diskType": { + "description": "The type of disk.", + "type": "string" + }, + "resyncRequired": { + "description": "A value indicating whether resync is required for this disk.", + "type": "boolean" + }, + "monitoringPercentageCompletion": { + "format": "int32", + "description": "The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property.", + "type": "integer" + }, + "monitoringJobType": { + "description": "The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property.", + "type": "string" + }, + "dataPendingInStagingStorageAccountInMB": { + "format": "double", + "description": "The data pending for replication in MB at staging account.", + "type": "number" + }, + "dataPendingAtSourceAgentInMB": { + "format": "double", + "description": "The data pending at source virtual machine in MB.", + "type": "number" + }, + "diskState": { + "description": "The disk state.", + "type": "string" + }, + "allowedDiskLevelOperation": { + "description": "The disk level operations list.", + "type": "array", + "items": { + "type": "string" + } + }, + "isDiskEncrypted": { + "description": "A value indicating whether vm has encrypted os disk or not.", + "type": "boolean" + }, + "secretIdentifier": { + "description": "The secret URL / identifier (BEK).", + "type": "string" + }, + "dekKeyVaultArmId": { + "description": "The KeyVault resource id for secret (BEK).", + "type": "string" + }, + "isDiskKeyEncrypted": { + "description": "A value indicating whether disk key got encrypted or not.", + "type": "boolean" + }, + "keyIdentifier": { + "description": "The key URL / identifier (KEK).", + "type": "string" + }, + "kekKeyVaultArmId": { + "description": "The KeyVault resource id for key (KEK).", + "type": "string" + }, + "failoverDiskName": { + "description": "The failover name for the managed disk.", + "type": "string" + }, + "tfoDiskName": { + "description": "The test failover name for the managed disk.", + "type": "string" + } + } + }, + "A2AProtectionContainerMappingDetails": { + "description": "A2A provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionContainerMappingProviderSpecificDetails" + } + ], + "properties": { + "agentAutoUpdateStatus": { + "description": "A value indicating whether the auto update is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentAutoUpdateStatus", + "modelAsString": true + } + }, + "automationAccountArmId": { + "description": "The automation account arm id.", + "type": "string" + }, + "scheduleName": { + "description": "The schedule arm name.", + "type": "string" + }, + "jobScheduleName": { + "description": "The job schedule arm name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AProtectionIntentDiskInputDetails": { + "description": "Azure VM unmanaged disk input details.", + "required": [ + "diskUri" + ], + "type": "object", + "properties": { + "diskUri": { + "description": "The disk Uri.", + "type": "string" + }, + "recoveryAzureStorageAccountCustomInput": { + "$ref": "#/definitions/StorageAccountCustomDetails", + "description": "The recovery VHD storage account input." + }, + "primaryStagingStorageAccountCustomInput": { + "$ref": "#/definitions/StorageAccountCustomDetails", + "description": "The primary staging storage account input." + } + } + }, + "A2AProtectionIntentManagedDiskInputDetails": { + "description": "Azure VM managed disk input details.", + "required": [ + "diskId" + ], + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "primaryStagingStorageAccountCustomInput": { + "$ref": "#/definitions/StorageAccountCustomDetails", + "description": "The primary staging storage account input." + }, + "recoveryResourceGroupCustomInput": { + "$ref": "#/definitions/RecoveryResourceGroupCustomDetails", + "description": "The recovery resource group input." + }, + "recoveryReplicaDiskAccountType": { + "description": "The replica disk type. Its an optional value and will be same as source disk type if not user provided.", + "type": "string" + }, + "recoveryTargetDiskAccountType": { + "description": "The target disk type after failover. Its an optional value and will be same as source disk type if not user provided.", + "type": "string" + }, + "recoveryDiskEncryptionSetId": { + "description": "The recovery disk encryption set Id.", + "type": "string" + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery disk encryption information (for one / single pass flows)." + } + } + }, + "A2ARecoveryPointDetails": { + "description": "A2A provider specific recovery point details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProviderSpecificRecoveryPointDetails" + } + ], + "properties": { + "recoveryPointSyncType": { + "description": "A value indicating whether the recovery point is multi VM consistent.", + "enum": [ + "MultiVmSyncRecoveryPoint", + "PerVmRecoveryPoint" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPointSyncType", + "modelAsString": true + } + }, + "disks": { + "description": "List of disk ids representing a recovery point.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2ARemoveDisksInput": { + "description": "A2A remove disk(s) input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RemoveDisksProviderSpecificInput" + } + ], + "properties": { + "vmDisksUris": { + "description": "The list of vm disk vhd URIs.", + "type": "array", + "items": { + "type": "string" + } + }, + "vmManagedDisksIds": { + "description": "The list of vm managed disk Ids.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AReplicationDetails": { + "description": "A2A provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "fabricObjectId": { + "description": "The fabric specific object Id of the virtual machine.", + "type": "string" + }, + "initialPrimaryZone": { + "description": "The initial primary availability zone.", + "type": "string", + "readOnly": true + }, + "initialPrimaryFabricLocation": { + "description": "The initial primary fabric location.", + "type": "string", + "readOnly": true + }, + "initialRecoveryZone": { + "description": "The initial recovery availability zone.", + "type": "string", + "readOnly": true + }, + "initialRecoveryFabricLocation": { + "description": "The initial recovery fabric location.", + "type": "string", + "readOnly": true + }, + "multiVmGroupId": { + "description": "The multi vm group Id.", + "type": "string" + }, + "multiVmGroupName": { + "description": "The multi vm group name.", + "type": "string" + }, + "multiVmGroupCreateOption": { + "description": "Whether Multi VM group is auto created or specified by user.", + "enum": [ + "AutoCreated", + "UserSpecified" + ], + "type": "string", + "x-ms-enum": { + "name": "MultiVmGroupCreateOption", + "modelAsString": true + } + }, + "managementId": { + "description": "The management Id.", + "type": "string" + }, + "protectedDisks": { + "description": "The list of protected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AProtectedDiskDetails" + } + }, + "unprotectedDisks": { + "description": "The list of unprotected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AUnprotectedDiskDetails" + } + }, + "protectedManagedDisks": { + "description": "The list of protected managed disks.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AProtectedManagedDiskDetails" + } + }, + "recoveryBootDiagStorageAccountId": { + "description": "The recovery boot diagnostic storage account Arm Id.", + "type": "string" + }, + "primaryFabricLocation": { + "description": "Primary fabric location.", + "type": "string" + }, + "recoveryFabricLocation": { + "description": "The recovery fabric location.", + "type": "string" + }, + "osType": { + "description": "The type of operating system.", + "type": "string" + }, + "recoveryAzureVMSize": { + "description": "The size of recovery virtual machine.", + "type": "string" + }, + "recoveryAzureVMName": { + "description": "The name of recovery virtual machine.", + "type": "string" + }, + "recoveryAzureResourceGroupId": { + "description": "The recovery resource group.", + "type": "string" + }, + "recoveryCloudService": { + "description": "The recovery cloud service.", + "type": "string" + }, + "recoveryAvailabilitySet": { + "description": "The recovery availability set.", + "type": "string" + }, + "selectedRecoveryAzureNetworkId": { + "description": "The recovery virtual network.", + "type": "string" + }, + "selectedTfoAzureNetworkId": { + "description": "The test failover virtual network.", + "type": "string" + }, + "vmNics": { + "description": "The virtual machine nic details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicDetails" + } + }, + "vmSyncedConfigDetails": { + "$ref": "#/definitions/AzureToAzureVmSyncedConfigDetails", + "description": "The synced configuration details." + }, + "monitoringPercentageCompletion": { + "format": "int32", + "description": "The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property.", + "type": "integer" + }, + "monitoringJobType": { + "description": "The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property.", + "type": "string" + }, + "lastHeartbeat": { + "format": "date-time", + "description": "The last heartbeat received from the source server.", + "type": "string" + }, + "agentVersion": { + "description": "The agent version.", + "type": "string" + }, + "agentExpiryDate": { + "format": "date-time", + "description": "Agent expiry date.", + "type": "string" + }, + "isReplicationAgentUpdateRequired": { + "description": "A value indicating whether replication agent update is required.", + "type": "boolean" + }, + "agentCertificateExpiryDate": { + "format": "date-time", + "description": "Agent certificate expiry date.", + "type": "string", + "readOnly": true + }, + "isReplicationAgentCertificateUpdateRequired": { + "description": "A value indicating whether agent certificate update is required.", + "type": "boolean" + }, + "recoveryFabricObjectId": { + "description": "The recovery fabric object Id.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "lifecycleId": { + "description": "An id associated with the PE that survives actions like switch protection which change the backing PE/CPE objects internally.The lifecycle id gets carried forward to have a link/continuity in being able to have an Id that denotes the \"same\" protected item even though other internal Ids/ARM Id might be changing.", + "type": "string" + }, + "testFailoverRecoveryFabricObjectId": { + "description": "The test failover fabric object Id.", + "type": "string" + }, + "rpoInSeconds": { + "format": "int64", + "description": "The last RPO value in seconds.", + "type": "integer" + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The time (in UTC) when the last RPO value was calculated by Protection Service.", + "type": "string" + }, + "primaryAvailabilityZone": { + "description": "The primary availability zone.", + "type": "string" + }, + "recoveryAvailabilityZone": { + "description": "The recovery availability zone.", + "type": "string" + }, + "vmEncryptionType": { + "description": "The encryption type of the VM.", + "type": "string", + "readOnly": true, + "enum": [ + "NotEncrypted", + "OnePassEncrypted", + "TwoPassEncrypted" + ], + "x-ms-enum": { + "name": "VmEncryptionType", + "modelAsString": true + } + }, + "tfoAzureVMName": { + "description": "The test failover vm name.", + "type": "string" + }, + "recoveryAzureGeneration": { + "description": "The recovery azure generation.", + "type": "string", + "readOnly": true + }, + "recoveryProximityPlacementGroupId": { + "description": "The recovery proximity placement group Id.", + "type": "string" + }, + "autoProtectionOfDataDisk": { + "description": "A value indicating whether the auto protection is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoProtectionOfDataDisk", + "modelAsString": true + } + }, + "recoveryVirtualMachineScaleSetId": { + "description": "The recovery virtual machine scale set id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AReplicationIntentDetails": { + "description": "A2A provider specific settings.", + "required": [ + "recoveryAvailabilityType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProtectionIntentProviderSpecificSettings" + } + ], + "properties": { + "fabricObjectId": { + "description": "The fabric specific object Id of the virtual machine.", + "type": "string" + }, + "primaryLocation": { + "description": "The primary location for the virtual machine.", + "type": "string" + }, + "recoveryLocation": { + "description": "The recovery location for the virtual machine.", + "type": "string" + }, + "recoverySubscriptionId": { + "description": "The recovery subscription Id of the virtual machine.", + "type": "string" + }, + "vmDisks": { + "description": "The list of vm disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AProtectionIntentDiskInputDetails" + } + }, + "vmManagedDisks": { + "description": "The list of vm managed disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AProtectionIntentManagedDiskInputDetails" + } + }, + "recoveryResourceGroupId": { + "description": "The recovery resource group id.", + "type": "string" + }, + "protectionProfile": { + "$ref": "#/definitions/ProtectionProfileCustomDetails", + "description": "The protection profile custom details." + }, + "primaryStagingStorageAccount": { + "$ref": "#/definitions/StorageAccountCustomDetails", + "description": "The primary staging storage account details." + }, + "recoveryAvailabilitySet": { + "$ref": "#/definitions/RecoveryAvailabilitySetCustomDetails", + "description": "The recovery availability set details." + }, + "recoveryVirtualNetwork": { + "$ref": "#/definitions/RecoveryVirtualNetworkCustomDetails", + "description": "The recovery virtual network details." + }, + "recoveryProximityPlacementGroup": { + "$ref": "#/definitions/RecoveryProximityPlacementGroupCustomDetails", + "description": "The recovery proximity placement group custom details." + }, + "autoProtectionOfDataDisk": { + "description": "A value indicating whether the auto protection is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoProtectionOfDataDisk", + "modelAsString": true + } + }, + "multiVmGroupName": { + "description": "The multi vm group name.", + "type": "string" + }, + "multiVmGroupId": { + "description": "The multi vm group id.", + "type": "string" + }, + "recoveryBootDiagStorageAccount": { + "$ref": "#/definitions/StorageAccountCustomDetails", + "description": "The boot diagnostic storage account." + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery disk encryption information (for two pass flows)." + }, + "recoveryAvailabilityZone": { + "description": "The recovery availability zone.", + "type": "string" + }, + "recoveryAvailabilityType": { + "description": "The recovery availability type of the virtual machine.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AReprotectInput": { + "description": "Azure specific reprotect input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReverseReplicationProviderSpecificInput" + } + ], + "properties": { + "recoveryContainerId": { + "description": "The recovery container Id.", + "type": "string" + }, + "vmDisks": { + "description": "The list of vm disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmDiskInputDetails" + } + }, + "recoveryResourceGroupId": { + "description": "The recovery resource group Id. Valid for V2 scenarios.", + "type": "string" + }, + "recoveryCloudServiceId": { + "description": "The recovery cloud service Id. Valid for V1 scenarios.", + "type": "string" + }, + "recoveryAvailabilitySetId": { + "description": "The recovery availability set.", + "type": "string" + }, + "policyId": { + "description": "The Policy Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2ASwitchProtectionInput": { + "description": "A2A specific switch protection input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SwitchProtectionProviderSpecificInput" + } + ], + "properties": { + "recoveryContainerId": { + "description": "The recovery container Id.", + "type": "string" + }, + "vmDisks": { + "description": "The list of vm disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmDiskInputDetails" + } + }, + "vmManagedDisks": { + "description": "The list of vm managed disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmManagedDiskInputDetails" + } + }, + "recoveryResourceGroupId": { + "description": "The recovery resource group Id. Valid for V2 scenarios.", + "type": "string" + }, + "recoveryCloudServiceId": { + "description": "The recovery cloud service Id. Valid for V1 scenarios.", + "type": "string" + }, + "recoveryAvailabilitySetId": { + "description": "The recovery availability set.", + "type": "string" + }, + "policyId": { + "description": "The Policy Id.", + "type": "string" + }, + "recoveryBootDiagStorageAccountId": { + "description": "The boot diagnostic storage account.", + "type": "string" + }, + "recoveryAvailabilityZone": { + "description": "The recovery availability zone.", + "type": "string" + }, + "recoveryProximityPlacementGroupId": { + "description": "The recovery proximity placement group Id.", + "type": "string" + }, + "recoveryVirtualMachineScaleSetId": { + "description": "The virtual machine scale set id.", + "type": "string" + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery disk encryption information." + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2ATestFailoverInput": { + "description": "A2A provider specific input for test failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TestFailoverProviderSpecificInput" + } + ], + "properties": { + "recoveryPointId": { + "description": "The recovery point id to be passed to test failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + }, + "cloudServiceCreationOption": { + "description": "A value indicating whether to use recovery cloud service for TFO or not.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AUnplannedFailoverInput": { + "description": "A2A provider specific input for unplanned failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput" + } + ], + "properties": { + "recoveryPointId": { + "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + }, + "cloudServiceCreationOption": { + "description": "A value indicating whether to use recovery cloud service for failover or not.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AUnprotectedDiskDetails": { + "description": "A2A unprotected disk details.", + "type": "object", + "properties": { + "diskLunId": { + "format": "int32", + "description": "The source lun Id for the data disk.", + "type": "integer" + }, + "diskAutoProtectionStatus": { + "description": "A value indicating whether the disk auto protection is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoProtectionOfDataDisk", + "modelAsString": true + } + } + } + }, + "A2AUpdateContainerMappingInput": { + "description": "A2A update protection container mapping.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificUpdateContainerMappingInput" + } + ], + "properties": { + "agentAutoUpdateStatus": { + "description": "A value indicating whether the auto update is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentAutoUpdateStatus", + "modelAsString": true + } + }, + "automationAccountArmId": { + "description": "The automation account arm id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AUpdateReplicationProtectedItemInput": { + "description": "InMage Azure V2 input to update replication protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UpdateReplicationProtectedItemProviderInput" + } + ], + "properties": { + "recoveryCloudServiceId": { + "description": "The target cloud service ARM Id (for V1).", + "type": "string" + }, + "recoveryResourceGroupId": { + "description": "The target resource group ARM Id (for V2).", + "type": "string" + }, + "managedDiskUpdateDetails": { + "description": "Managed disk update details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmManagedDiskUpdateDetails" + } + }, + "recoveryBootDiagStorageAccountId": { + "description": "The boot diagnostic storage account.", + "type": "string" + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery os disk encryption information." + }, + "tfoAzureVMName": { + "description": "The user given name for Test Failover VM.", + "type": "string" + }, + "recoveryProximityPlacementGroupId": { + "description": "The recovery proximity placement group Id.", + "type": "string" + }, + "recoveryVirtualMachineScaleSetId": { + "description": "The recovery virtual machine scale set Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AVmDiskInputDetails": { + "description": "A2A disk input details.", + "required": [ + "diskUri", + "recoveryAzureStorageAccountId", + "primaryStagingAzureStorageAccountId" + ], + "type": "object", + "properties": { + "diskUri": { + "description": "The disk Uri.", + "type": "string" + }, + "recoveryAzureStorageAccountId": { + "description": "The recovery VHD storage account Id.", + "type": "string" + }, + "primaryStagingAzureStorageAccountId": { + "description": "The primary staging storage account Id.", + "type": "string" + } + } + }, + "A2AVmManagedDiskInputDetails": { + "description": "A2A managed disk input details.", + "required": [ + "diskId", + "primaryStagingAzureStorageAccountId", + "recoveryResourceGroupId" + ], + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "primaryStagingAzureStorageAccountId": { + "description": "The primary staging storage account Arm Id.", + "type": "string" + }, + "recoveryResourceGroupId": { + "description": "The target resource group Arm Id.", + "type": "string" + }, + "recoveryReplicaDiskAccountType": { + "description": "The replica disk type. Its an optional value and will be same as source disk type if not user provided.", + "type": "string" + }, + "recoveryTargetDiskAccountType": { + "description": "The target disk type after failover. Its an optional value and will be same as source disk type if not user provided.", + "type": "string" + }, + "recoveryDiskEncryptionSetId": { + "description": "The recovery disk encryption set Id.", + "type": "string" + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery disk encryption information (for one / single pass flows)." + } + } + }, + "A2AVmManagedDiskUpdateDetails": { + "description": "A2A Vm managed disk update details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "recoveryTargetDiskAccountType": { + "description": "The target disk type before failover.", + "type": "string" + }, + "recoveryReplicaDiskAccountType": { + "description": "The replica disk type before failover.", + "type": "string" + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery os disk encryption information." + }, + "failoverDiskName": { + "description": "The target disk name for unplanned failover operation.", + "type": "string" + }, + "tfoDiskName": { + "description": "The target disk name for test failover operation.", + "type": "string" + } + } + }, + "A2AZoneDetails": { + "description": "Zone details data.", + "type": "object", + "properties": { + "source": { + "description": "Source zone info.", + "type": "string" + }, + "target": { + "description": "The target zone info.", + "type": "string" + } + } + }, + "AddDisksInput": { + "description": "Input for add disk(s) operation.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AddDisksInputProperties", + "description": "Add disks input properties." + } + } + }, + "AddDisksInputProperties": { + "description": "Add Disks input properties.", + "required": [ + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/AddDisksProviderSpecificInput", + "description": "The ReplicationProviderInput. For HyperVReplicaAzure provider, it will be AzureEnableProtectionInput object. For San provider, it will be SanEnableProtectionInput object. For HyperVReplicaAzure provider, it can be null." + } + } + }, + "AddDisksProviderSpecificInput": { + "description": "Add Disks provider specific input.", + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "AddRecoveryServicesProviderInput": { + "description": "Input required to add a provider.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AddRecoveryServicesProviderInputProperties", + "description": "The properties of an add provider request." + } + } + }, + "AddRecoveryServicesProviderInputProperties": { + "description": "The properties of an add provider request.", + "required": [ + "machineName", + "authenticationIdentityInput", + "resourceAccessIdentityInput" + ], + "type": "object", + "properties": { + "machineName": { + "description": "The name of the machine where the provider is getting added.", + "type": "string" + }, + "machineId": { + "description": "The Id of the machine where the provider is getting added.", + "type": "string" + }, + "biosId": { + "description": "The Bios Id of the machine.", + "type": "string" + }, + "authenticationIdentityInput": { + "$ref": "#/definitions/IdentityProviderInput", + "description": "The identity provider input for DRA authentication." + }, + "resourceAccessIdentityInput": { + "$ref": "#/definitions/IdentityProviderInput", + "description": "The identity provider input for resource access." + }, + "dataPlaneAuthenticationIdentityInput": { + "$ref": "#/definitions/IdentityProviderInput", + "description": "The identity provider input for data plane authentication." + } + } + }, + "AddVCenterRequest": { + "description": "Input required to add vCenter.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AddVCenterRequestProperties", + "description": "The properties of an add vCenter request." + } + } + }, + "AddVCenterRequestProperties": { + "description": "The properties of an add vCenter request.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The friendly name of the vCenter.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address of the vCenter to be discovered.", + "type": "string" + }, + "processServerId": { + "description": "The process server Id from where the discovery is orchestrated.", + "type": "string" + }, + "port": { + "description": "The port number for discovery.", + "type": "string" + }, + "runAsAccountId": { + "description": "The account Id which has privileges to discover the vCenter.", + "type": "string" + } + } + }, + "AgentDetails": { + "description": "Agent details.", + "type": "object", + "properties": { + "agentId": { + "description": "The Id of the agent running on the server.", + "type": "string", + "readOnly": true + }, + "machineId": { + "description": "The Id of the machine to which the agent is registered.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The machine BIOS Id.", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "The machine FQDN.", + "type": "string", + "readOnly": true + }, + "disks": { + "description": "The disks.", + "type": "array", + "items": { + "$ref": "#/definitions/AgentDiskDetails" + }, + "readOnly": true + } + } + }, + "AgentDiskDetails": { + "description": "Agent disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string", + "readOnly": true + }, + "diskName": { + "description": "The disk name.", + "type": "string", + "readOnly": true + }, + "isOSDisk": { + "description": "A value indicating whether the disk is the OS disk.", + "type": "string", + "readOnly": true + }, + "capacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer", + "readOnly": true + }, + "lunId": { + "format": "int32", + "description": "The lun of disk.", + "type": "integer", + "readOnly": true + } + } + }, + "Alert": { + "description": "Implements the Alert class.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AlertProperties", + "description": "Alert related data." + } + } + }, + "AlertCollection": { + "description": "Collection of alerts.", + "type": "object", + "properties": { + "value": { + "description": "The list of alerts.", + "type": "array", + "items": { + "$ref": "#/definitions/Alert" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "AlertProperties": { + "description": "The properties of an alert.", + "type": "object", + "properties": { + "sendToOwners": { + "description": "A value indicating whether to send email to subscription administrator.", + "type": "string" + }, + "customEmailAddresses": { + "description": "The custom email address for sending emails.", + "type": "array", + "items": { + "type": "string" + } + }, + "locale": { + "description": "The locale for the email notification.", + "type": "string" + } + } + }, + "ApplyRecoveryPointInput": { + "description": "Input to apply recovery point.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ApplyRecoveryPointInputProperties", + "description": "The input properties to apply recovery point." + } + } + }, + "ApplyRecoveryPointInputProperties": { + "description": "Input properties to apply recovery point.", + "required": [ + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "recoveryPointId": { + "description": "The recovery point Id.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput", + "description": "Provider specific input for applying recovery point." + } + } + }, + "ApplyRecoveryPointProviderSpecificInput": { + "description": "Provider specific input for apply recovery point.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "AsrJobDetails": { + "description": "This class represents job details based on specific job type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": {}, + "x-ms-discriminator-value": "AsrJobDetails" + }, + "ASRTask": { + "description": "Task of the Job.", + "type": "object", + "properties": { + "taskId": { + "description": "The Id.", + "type": "string" + }, + "name": { + "description": "The unique Task name.", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "The start time.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "The end time.", + "type": "string" + }, + "allowedActions": { + "description": "The state/actions applicable on this task.", + "type": "array", + "items": { + "type": "string" + } + }, + "friendlyName": { + "description": "The name.", + "type": "string" + }, + "state": { + "description": "The State. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other.", + "type": "string" + }, + "stateDescription": { + "description": "The description of the task state. For example - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped.", + "type": "string" + }, + "taskType": { + "description": "The type of task. Details in CustomDetails property depend on this type.", + "type": "string" + }, + "customDetails": { + "$ref": "#/definitions/TaskTypeDetails", + "description": "The custom task details based on the task type." + }, + "groupTaskCustomDetails": { + "$ref": "#/definitions/GroupTaskDetails", + "description": "The custom task details based on the task type, if the task type is GroupTaskDetails or one of the types derived from it." + }, + "errors": { + "description": "The task error details.", + "type": "array", + "items": { + "$ref": "#/definitions/JobErrorDetails" + } + } + } + }, + "AutomationRunbookTaskDetails": { + "description": "This class represents the task details for an automation runbook.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskTypeDetails" + } + ], + "properties": { + "name": { + "description": "The recovery plan task name.", + "type": "string" + }, + "cloudServiceName": { + "description": "The cloud service of the automation runbook account.", + "type": "string" + }, + "subscriptionId": { + "description": "The subscription Id of the automation runbook account.", + "type": "string" + }, + "accountName": { + "description": "The automation account name of the runbook.", + "type": "string" + }, + "runbookId": { + "description": "The runbook Id.", + "type": "string" + }, + "runbookName": { + "description": "The runbook name.", + "type": "string" + }, + "jobId": { + "description": "The job Id of the runbook execution.", + "type": "string" + }, + "jobOutput": { + "description": "The execution output of the runbook.", + "type": "string" + }, + "isPrimarySideScript": { + "description": "A value indicating whether it is a primary side script or not.", + "type": "boolean" + } + }, + "x-ms-discriminator-value": "AutomationRunbookTaskDetails" + }, + "AzureFabricCreationInput": { + "description": "Fabric provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificCreationInput" + } + ], + "properties": { + "location": { + "description": "The Location.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Azure" + }, + "AzureFabricSpecificDetails": { + "description": "Azure Fabric Specific Details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificDetails" + } + ], + "properties": { + "location": { + "description": "The Location for the Azure fabric.", + "type": "string" + }, + "containerIds": { + "description": "The container Ids for the Azure fabric.", + "type": "array", + "items": { + "type": "string" + } + }, + "zones": { + "description": "The zones.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AZoneDetails" + } + } + }, + "x-ms-discriminator-value": "Azure" + }, + "AzureToAzureCreateNetworkMappingInput": { + "description": "Create network mappings input properties/behavior specific to Azure to Azure Network mapping.", + "required": [ + "primaryNetworkId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificCreateNetworkMappingInput" + } + ], + "properties": { + "primaryNetworkId": { + "description": "The primary azure vnet Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureToAzure" + }, + "AzureToAzureNetworkMappingSettings": { + "description": "A2A Network Mapping fabric specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkMappingFabricSpecificSettings" + } + ], + "properties": { + "primaryFabricLocation": { + "description": "The primary fabric location.", + "type": "string" + }, + "recoveryFabricLocation": { + "description": "The recovery fabric location.", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureToAzure" + }, + "AzureToAzureUpdateNetworkMappingInput": { + "description": "Updates network mappings input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificUpdateNetworkMappingInput" + } + ], + "properties": { + "primaryNetworkId": { + "description": "The primary azure vnet Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureToAzure" + }, + "AzureToAzureVmSyncedConfigDetails": { + "description": "Azure to Azure VM synced configuration details.", + "type": "object", + "properties": { + "tags": { + "description": "The Azure VM tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "inputEndpoints": { + "description": "The Azure VM input endpoints.", + "type": "array", + "items": { + "$ref": "#/definitions/InputEndpoint" + } + } + } + }, + "AzureVmDiskDetails": { + "description": "Disk details for E2A provider.", + "type": "object", + "properties": { + "vhdType": { + "description": "VHD type.", + "type": "string" + }, + "vhdId": { + "description": "The VHD id.", + "type": "string" + }, + "diskId": { + "description": "The disk resource id.", + "type": "string" + }, + "vhdName": { + "description": "VHD name.", + "type": "string" + }, + "maxSizeMB": { + "description": "Max side in MB.", + "type": "string" + }, + "targetDiskLocation": { + "description": "Blob uri of the Azure disk.", + "type": "string" + }, + "targetDiskName": { + "description": "The target Azure disk name.", + "type": "string" + }, + "lunId": { + "description": "Ordinal\\LunId of the disk for the Azure VM.", + "type": "string" + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM ID.", + "type": "string" + } + } + }, + "ComputeSizeErrorDetails": { + "description": "Represents the error used to indicate why the target compute size is not applicable.", + "type": "object", + "properties": { + "message": { + "description": "The error message.", + "type": "string" + }, + "severity": { + "description": "The severity of the error.", + "type": "string" + } + } + }, + "ConfigurationSettings": { + "description": "Replication provider specific settings.", + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type. Overridden in derived classes.", + "type": "string", + "readOnly": true + } + }, + "discriminator": "instanceType" + }, + "ConfigureAlertRequest": { + "description": "Request to configure alerts for the system.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ConfigureAlertRequestProperties", + "description": "The properties of a configure alert request." + } + } + }, + "ConfigureAlertRequestProperties": { + "description": "Properties of a configure alert request.", + "type": "object", + "properties": { + "sendToOwners": { + "description": "A value indicating whether to send email to subscription administrator.", + "type": "string" + }, + "customEmailAddresses": { + "description": "The custom email address for sending emails.", + "type": "array", + "items": { + "type": "string" + } + }, + "locale": { + "description": "The locale for the email notification.", + "type": "string" + } + } + }, + "ConsistencyCheckTaskDetails": { + "description": "This class contains monitoring details of all the inconsistent Protected Entities in Vmm.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskTypeDetails" + } + ], + "properties": { + "vmDetails": { + "description": "The list of inconsistent Vm details.", + "type": "array", + "items": { + "$ref": "#/definitions/InconsistentVmDetails" + } + } + }, + "x-ms-discriminator-value": "ConsistencyCheckTaskDetails" + }, + "CreateNetworkMappingInput": { + "description": "Create network mappings input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CreateNetworkMappingInputProperties", + "description": "Input properties for creating network mapping." + } + } + }, + "CreateNetworkMappingInputProperties": { + "description": "Common input details for network mapping operation.", + "required": [ + "recoveryNetworkId" + ], + "type": "object", + "properties": { + "recoveryFabricName": { + "description": "Recovery fabric Name.", + "type": "string" + }, + "recoveryNetworkId": { + "description": "Recovery network Id.", + "type": "string" + }, + "fabricSpecificDetails": { + "$ref": "#/definitions/FabricSpecificCreateNetworkMappingInput", + "description": "Fabric specific input properties." + } + } + }, + "CreatePolicyInput": { + "description": "Protection Policy input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CreatePolicyInputProperties", + "description": "Policy creation properties." + } + } + }, + "CreatePolicyInputProperties": { + "description": "Policy creation properties.", + "type": "object", + "properties": { + "providerSpecificInput": { + "$ref": "#/definitions/PolicyProviderSpecificInput", + "description": "The ReplicationProviderSettings." + } + } + }, + "CreateProtectionContainerInput": { + "description": "Create protection container input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CreateProtectionContainerInputProperties", + "description": "Create protection container input properties." + } + } + }, + "CreateProtectionContainerInputProperties": { + "description": "Create protection container input properties.", + "type": "object", + "properties": { + "providerSpecificInput": { + "description": "Provider specific inputs for container creation.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationProviderSpecificContainerCreationInput" + } + } + } + }, + "CreateProtectionContainerMappingInput": { + "description": "Configure pairing input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CreateProtectionContainerMappingInputProperties", + "description": "Configure protection input properties." + } + } + }, + "CreateProtectionContainerMappingInputProperties": { + "description": "Configure pairing input properties.", + "type": "object", + "properties": { + "targetProtectionContainerId": { + "description": "The target unique protection container name.", + "type": "string" + }, + "policyId": { + "description": "Applicable policy.", + "type": "string" + }, + "providerSpecificInput": { + "$ref": "#/definitions/ReplicationProviderSpecificContainerMappingInput", + "description": "Provider specific input for pairing." + } + } + }, + "CreateProtectionIntentInput": { + "description": "Create protection intent input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CreateProtectionIntentProperties", + "description": "Create protection intent input properties." + } + } + }, + "CreateProtectionIntentProperties": { + "description": "Create protection intent input properties.", + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/CreateProtectionIntentProviderSpecificDetails", + "description": "The ReplicationProviderInput. For A2A provider, it will be A2ACreateProtectionIntentInput object." + } + } + }, + "CreateProtectionIntentProviderSpecificDetails": { + "description": "Create protection intent provider specific input.", + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "CreateRecoveryPlanInput": { + "description": "Create recovery plan input class.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CreateRecoveryPlanInputProperties", + "description": "Recovery plan creation properties." + } + } + }, + "CreateRecoveryPlanInputProperties": { + "description": "Recovery plan creation properties.", + "required": [ + "primaryFabricId", + "recoveryFabricId", + "groups" + ], + "type": "object", + "properties": { + "primaryFabricId": { + "description": "The primary fabric Id.", + "type": "string" + }, + "recoveryFabricId": { + "description": "The recovery fabric Id.", + "type": "string" + }, + "failoverDeploymentModel": { + "description": "The failover deployment model.", + "enum": [ + "NotApplicable", + "Classic", + "ResourceManager" + ], + "type": "string", + "x-ms-enum": { + "name": "FailoverDeploymentModel", + "modelAsString": true + } + }, + "groups": { + "description": "The recovery plan groups.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanGroup" + } + }, + "providerSpecificInput": { + "description": "The provider specific input.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanProviderSpecificInput" + } + } + } + }, + "CurrentJobDetails": { + "description": "Current job details of the migration item.", + "type": "object", + "properties": { + "jobName": { + "description": "The job name.", + "type": "string", + "readOnly": true + }, + "jobId": { + "description": "The ARM Id of the job being executed.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "The start time of the job.", + "type": "string", + "readOnly": true + } + } + }, + "CurrentScenarioDetails": { + "description": "Current scenario details of the protected entity.", + "type": "object", + "properties": { + "scenarioName": { + "description": "Scenario name.", + "type": "string" + }, + "jobId": { + "description": "ARM Id of the job being executed.", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "Start time of the workflow.", + "type": "string" + } + } + }, + "DataStore": { + "description": "The datastore details of the MT.", + "type": "object", + "properties": { + "symbolicName": { + "description": "The symbolic name of data store.", + "type": "string" + }, + "uuid": { + "description": "The uuid of data store.", + "type": "string" + }, + "capacity": { + "description": "The capacity of data store in GBs.", + "type": "string" + }, + "freeSpace": { + "description": "The free space of data store in GBs.", + "type": "string" + }, + "type": { + "description": "The type of data store.", + "type": "string" + } + } + }, + "DisableProtectionInput": { + "description": "Disable protection input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/DisableProtectionInputProperties", + "description": "Disable protection input properties." + } + } + }, + "DisableProtectionInputProperties": { + "description": "Disable protection input properties.", + "type": "object", + "properties": { + "disableProtectionReason": { + "description": "Disable protection reason. It can have values NotSpecified/MigrationComplete.", + "enum": [ + "NotSpecified", + "MigrationComplete" + ], + "type": "string", + "x-ms-enum": { + "name": "DisableProtectionReason", + "modelAsString": true + } + }, + "replicationProviderInput": { + "$ref": "#/definitions/DisableProtectionProviderSpecificInput", + "description": "Replication provider specific input." + } + } + }, + "DisableProtectionProviderSpecificInput": { + "description": "Disable protection provider specific input.", + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "DiscoverProtectableItemRequest": { + "description": "Request to add a physical machine as a protectable item in a container.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/DiscoverProtectableItemRequestProperties", + "description": "The properties of a discover protectable item request." + } + } + }, + "DiscoverProtectableItemRequestProperties": { + "description": "Discover protectable item properties.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The friendly name of the physical machine.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address of the physical machine to be discovered.", + "type": "string" + }, + "osType": { + "description": "The OS type on the physical machine.", + "type": "string" + } + } + }, + "DiskDetails": { + "description": "Onprem disk details data.", + "type": "object", + "properties": { + "maxSizeMB": { + "format": "int64", + "description": "The hard disk max size in MB.", + "type": "integer" + }, + "vhdType": { + "description": "The type of the volume.", + "type": "string" + }, + "vhdId": { + "description": "The VHD Id.", + "type": "string" + }, + "vhdName": { + "description": "The VHD name.", + "type": "string" + } + } + }, + "DiskEncryptionInfo": { + "description": "Recovery disk encryption info (BEK and KEK).", + "type": "object", + "properties": { + "diskEncryptionKeyInfo": { + "$ref": "#/definitions/DiskEncryptionKeyInfo", + "description": "The recovery KeyVault reference for secret." + }, + "keyEncryptionKeyInfo": { + "$ref": "#/definitions/KeyEncryptionKeyInfo", + "description": "The recovery KeyVault reference for key." + } + } + }, + "DiskEncryptionKeyInfo": { + "description": "Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows).", + "type": "object", + "properties": { + "secretIdentifier": { + "description": "The secret url / identifier.", + "type": "string" + }, + "keyVaultResourceArmId": { + "description": "The KeyVault resource ARM id for secret.", + "type": "string" + } + } + }, + "DiskVolumeDetails": { + "description": "Volume details.", + "type": "object", + "properties": { + "label": { + "description": "The volume label.", + "type": "string" + }, + "name": { + "description": "The volume name.", + "type": "string" + } + } + }, + "Display": { + "description": "Contains the localized display information for this particular operation / action. These value will be used by several clients for (1) custom role definitions for RBAC; (2) complex query filters for the event service; and (3) audit history / records for management operations.", + "type": "object", + "properties": { + "provider": { + "description": "The provider. The localized friendly form of the resource provider name - it is expected to also include the publisher/company responsible. It should use Title Casing and begin with \"Microsoft\" for 1st party services. e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute.\".", + "type": "string" + }, + "resource": { + "description": "The resource. The localized friendly form of the resource related to this action/operation - it should match the public documentation for the resource provider. It should use Title Casing. This value should be unique for a particular URL type (e.g. nested types should *not* reuse their parent's display.resource field). e.g. \"Virtual Machines\" or \"Scheduler Job Collections\", or \"Virtual Machine VM Sizes\" or \"Scheduler Jobs\".", + "type": "string" + }, + "operation": { + "description": "The operation. The localized friendly name for the operation, as it should be shown to the user. It should be concise (to fit in drop downs) but clear (i.e. self-documenting). It should use Title Casing. Prescriptive guidance: Read Create or Update Delete 'ActionName'.", + "type": "string" + }, + "description": { + "description": "The description. The localized friendly description for the operation, as it should be shown to the user. It should be thorough, yet concise - it will be used in tool tips and detailed views. Prescriptive guidance for namespaces: Read any 'display.provider' resource Create or Update any 'display.provider' resource Delete any 'display.provider' resource Perform any other action on any 'display.provider' resource Prescriptive guidance for namespaces: Read any 'display.resource' Create or Update any 'display.resource' Delete any 'display.resource' 'ActionName' any 'display.resources'.", + "type": "string" + } + } + }, + "DraDetails": { + "description": "DRA details.", + "type": "object", + "properties": { + "id": { + "description": "The DRA Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The DRA name.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The DRA Bios Id.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the DRA.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The health.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + } + } + }, + "EnableMigrationInput": { + "description": "Enable migration input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/EnableMigrationInputProperties", + "description": "Enable migration input properties." + } + } + }, + "EnableMigrationInputProperties": { + "description": "Enable migration input properties.", + "required": [ + "policyId", + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "policyId": { + "description": "The policy Id.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/EnableMigrationProviderSpecificInput", + "description": "The provider specific details." + } + } + }, + "EnableMigrationProviderSpecificInput": { + "description": "Enable migration provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "EnableProtectionInput": { + "description": "Enable protection input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/EnableProtectionInputProperties", + "description": "Enable protection input properties." + } + } + }, + "EnableProtectionInputProperties": { + "description": "Enable protection input properties.", + "type": "object", + "properties": { + "policyId": { + "description": "The Policy Id.", + "type": "string" + }, + "protectableItemId": { + "description": "The protectable item Id.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/EnableProtectionProviderSpecificInput", + "description": "The ReplicationProviderInput. For HyperVReplicaAzure provider, it will be AzureEnableProtectionInput object. For San provider, it will be SanEnableProtectionInput object. For HyperVReplicaAzure provider, it can be null." + } + } + }, + "EnableProtectionProviderSpecificInput": { + "description": "Enable protection provider specific input.", + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "EncryptionDetails": { + "description": "Encryption details for the fabric.", + "type": "object", + "properties": { + "kekState": { + "description": "The key encryption key state for the Vmm.", + "type": "string" + }, + "kekCertThumbprint": { + "description": "The key encryption key certificate thumbprint.", + "type": "string" + }, + "kekCertExpiryDate": { + "format": "date-time", + "description": "The key encryption key certificate expiry date.", + "type": "string" + } + } + }, + "Event": { + "description": "Implements the Event class.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EventProperties", + "description": "Event related data." + } + } + }, + "EventCollection": { + "description": "Collection of fabric details.", + "type": "object", + "properties": { + "value": { + "description": "The list of events.", + "type": "array", + "items": { + "$ref": "#/definitions/Event" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "EventProperties": { + "description": "The properties of a monitoring event.", + "type": "object", + "properties": { + "eventCode": { + "description": "The Id of the monitoring event.", + "type": "string" + }, + "description": { + "description": "The event name.", + "type": "string" + }, + "eventType": { + "description": "The type of the event. for example: VM Health, Server Health, Job Failure etc.", + "type": "string" + }, + "affectedObjectFriendlyName": { + "description": "The friendly name of the source of the event on which it is raised (for example, VM, VMM etc).", + "type": "string" + }, + "affectedObjectCorrelationId": { + "description": "The affected object correlationId for the event.", + "type": "string" + }, + "severity": { + "description": "The severity of the event.", + "type": "string" + }, + "timeOfOccurrence": { + "format": "date-time", + "description": "The time of occurrence of the event.", + "type": "string" + }, + "fabricId": { + "description": "The ARM ID of the fabric.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/EventProviderSpecificDetails", + "description": "The provider specific settings." + }, + "eventSpecificDetails": { + "$ref": "#/definitions/EventSpecificDetails", + "description": "The event specific settings." + }, + "healthErrors": { + "description": "The list of errors / warnings capturing details associated with the issue(s).", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + } + } + }, + "EventProviderSpecificDetails": { + "description": "Model class for provider specific details for an event.", + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type. Overridden in derived classes.", + "type": "string", + "readOnly": true + } + }, + "discriminator": "instanceType" + }, + "EventQueryParameter": { + "description": "Implements the event query parameter.", + "type": "object", + "properties": { + "eventCode": { + "description": "The source id of the events to be queried.", + "type": "string" + }, + "severity": { + "description": "The severity of the events to be queried.", + "type": "string" + }, + "eventType": { + "description": "The type of the events to be queried.", + "type": "string" + }, + "fabricName": { + "description": "The affected object server id of the events to be queried.", + "type": "string" + }, + "affectedObjectFriendlyName": { + "description": "The affected object name of the events to be queried.", + "type": "string" + }, + "affectedObjectCorrelationId": { + "description": "The affected object correlationId for the events to be queried.", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "The start time of the time range within which the events are to be queried.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "The end time of the time range within which the events are to be queried.", + "type": "string" + } + } + }, + "EventSpecificDetails": { + "description": "Model class for event specific details for an event.", + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type. Overridden in derived classes.", + "type": "string", + "readOnly": true + } + }, + "discriminator": "instanceType" + }, + "ExistingProtectionProfile": { + "description": "Existing storage account input.", + "required": [ + "protectionProfileId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionProfileCustomDetails" + } + ], + "properties": { + "protectionProfileId": { + "description": "The protection profile Arm Id. Throw error, if resource does not exists.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Existing" + }, + "ExistingRecoveryAvailabilitySet": { + "description": "Existing recovery availability set input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryAvailabilitySetCustomDetails" + } + ], + "properties": { + "recoveryAvailabilitySetId": { + "description": "The recovery availability set Id. Will throw error, if resource does not exist.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Existing" + }, + "ExistingRecoveryProximityPlacementGroup": { + "description": "Existing recovery proximity placement group input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryProximityPlacementGroupCustomDetails" + } + ], + "properties": { + "recoveryProximityPlacementGroupId": { + "description": "The recovery proximity placement group Id. Will throw error, if resource does not exist.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Existing" + }, + "ExistingRecoveryRecoveryResourceGroup": { + "description": "Existing recovery resource group input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryResourceGroupCustomDetails" + } + ], + "properties": { + "recoveryResourceGroupId": { + "description": "The recovery resource group Id. Valid for V2 scenarios.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Existing" + }, + "ExistingRecoveryVirtualNetwork": { + "description": "Existing recovery virtual network input.", + "required": [ + "recoveryVirtualNetworkId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryVirtualNetworkCustomDetails" + } + ], + "properties": { + "recoveryVirtualNetworkId": { + "description": "The recovery virtual network Id. Will throw error, if resource does not exist.", + "type": "string" + }, + "recoverySubnetName": { + "description": "The recovery subnet name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Existing" + }, + "ExistingStorageAccount": { + "description": "Existing storage account input.", + "required": [ + "azureStorageAccountId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StorageAccountCustomDetails" + } + ], + "properties": { + "azureStorageAccountId": { + "description": "The storage account Arm Id. Throw error, if resource does not exists.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Existing" + }, + "ExportJobDetails": { + "description": "This class represents details for export jobs workflow.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": { + "blobUri": { + "description": "BlobUri of the exported jobs.", + "type": "string" + }, + "sasToken": { + "description": "The sas token to access blob.", + "type": "string" + } + }, + "x-ms-discriminator-value": "ExportJobDetails" + }, + "Fabric": { + "description": "Fabric definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/FabricProperties", + "description": "Fabric related data." + } + } + }, + "FabricCollection": { + "description": "Collection of fabric details.", + "type": "object", + "properties": { + "value": { + "description": "The fabric details.", + "type": "array", + "items": { + "$ref": "#/definitions/Fabric" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "FabricCreationInput": { + "description": "Site details provided during the time of site creation.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FabricCreationInputProperties", + "description": "Fabric creation input." + } + } + }, + "FabricCreationInputProperties": { + "description": "Properties of site details provided during the time of site creation.", + "type": "object", + "properties": { + "customDetails": { + "$ref": "#/definitions/FabricSpecificCreationInput", + "description": "Fabric provider specific creation input." + } + } + }, + "FabricProperties": { + "description": "Fabric properties.", + "type": "object", + "properties": { + "friendlyName": { + "description": "Friendly name of the fabric.", + "type": "string" + }, + "encryptionDetails": { + "$ref": "#/definitions/EncryptionDetails", + "description": "Encryption details for the fabric." + }, + "rolloverEncryptionDetails": { + "$ref": "#/definitions/EncryptionDetails", + "description": "Rollover encryption details for the fabric." + }, + "internalIdentifier": { + "description": "Dra Registration Id.", + "type": "string" + }, + "bcdrState": { + "description": "BCDR state of the fabric.", + "type": "string" + }, + "customDetails": { + "$ref": "#/definitions/FabricSpecificDetails", + "description": "Fabric specific settings." + }, + "healthErrorDetails": { + "description": "Fabric health error details.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "health": { + "description": "Health of fabric.", + "type": "string" + } + } + }, + "FabricQueryParameter": { + "description": "Query parameter to get fabric.", + "type": "object", + "properties": { + "zoneToZoneMappings": { + "description": "A value indicating whether the zone to zone mappings are to be returned.", + "type": "string" + }, + "fetchAgentDetails": { + "description": "A value indicating whether the agent details are to be fetched.", + "type": "string" + }, + "biosId": { + "description": "The BIOS Id to be used for fetching agent details.", + "type": "string" + }, + "fqdn": { + "description": "The FQDN to be used for fetching agent details.", + "type": "string" + }, + "discoveryType": { + "description": "The type of the discovered machine to be used for fetching agent details.", + "type": "string" + }, + "osType": { + "description": "The OS type to be used for fetching agent details.", + "type": "string" + } + } + }, + "FabricReplicationGroupTaskDetails": { + "description": "This class represents the fabric replication group task details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobTaskDetails" + } + ], + "properties": { + "skippedReason": { + "description": "The skipped reason.", + "type": "string" + }, + "skippedReasonString": { + "description": "The skipped reason string.", + "type": "string" + } + }, + "x-ms-discriminator-value": "FabricReplicationGroupTaskDetails" + }, + "FabricSpecificCreateNetworkMappingInput": { + "description": "Input details specific to fabrics during Network Mapping.", + "type": "object", + "properties": { + "instanceType": { + "description": "The instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "FabricSpecificCreationInput": { + "description": "Fabric provider specific settings.", + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "FabricSpecificDetails": { + "description": "Fabric specific details.", + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type. Overridden in derived classes.", + "type": "string", + "readOnly": true + } + }, + "discriminator": "instanceType" + }, + "FabricSpecificUpdateNetworkMappingInput": { + "description": "Input details specific to fabrics during Network Mapping.", + "type": "object", + "properties": { + "instanceType": { + "description": "The instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "FailoverJobDetails": { + "description": "This class represents the details for a failover job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": { + "protectedItemDetails": { + "description": "The test VM details.", + "type": "array", + "items": { + "$ref": "#/definitions/FailoverReplicationProtectedItemDetails" + } + } + }, + "x-ms-discriminator-value": "FailoverJobDetails" + }, + "FailoverProcessServerRequest": { + "description": "Request to failover a process server.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FailoverProcessServerRequestProperties", + "description": "The properties of the PS Failover request." + } + } + }, + "FailoverProcessServerRequestProperties": { + "description": "The properties of the Failover Process Server request.", + "type": "object", + "properties": { + "containerName": { + "description": "The container identifier.", + "type": "string" + }, + "sourceProcessServerId": { + "description": "The source process server.", + "type": "string" + }, + "targetProcessServerId": { + "description": "The new process server.", + "type": "string" + }, + "vmsToMigrate": { + "description": "The VMS to migrate.", + "type": "array", + "items": { + "type": "string" + } + }, + "updateType": { + "description": "A value for failover type. It can be systemlevel/serverlevel.", + "type": "string" + } + } + }, + "FailoverReplicationProtectedItemDetails": { + "description": "Failover details for a replication protected item.", + "type": "object", + "properties": { + "name": { + "description": "The name.", + "type": "string" + }, + "friendlyName": { + "description": "The friendly name.", + "type": "string" + }, + "testVmName": { + "description": "The test Vm name.", + "type": "string" + }, + "testVmFriendlyName": { + "description": "The test Vm friendly name.", + "type": "string" + }, + "networkConnectionStatus": { + "description": "The network connection status.", + "type": "string" + }, + "networkFriendlyName": { + "description": "The network friendly name.", + "type": "string" + }, + "subnet": { + "description": "The network subnet.", + "type": "string" + }, + "recoveryPointId": { + "description": "The recovery point Id.", + "type": "string" + }, + "recoveryPointTime": { + "format": "date-time", + "description": "The recovery point time.", + "type": "string" + } + } + }, + "GroupTaskDetails": { + "description": "This class represents the group task details when parent child relationship exists in the drill down.", + "type": "object", + "properties": { + "instanceType": { + "description": "The type of task details.", + "type": "string" + }, + "childTasks": { + "description": "The child tasks.", + "type": "array", + "items": { + "$ref": "#/definitions/ASRTask" + } + } + }, + "discriminator": "instanceType" + }, + "HealthError": { + "description": "Health Error.", + "type": "object", + "properties": { + "innerHealthErrors": { + "description": "The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException.", + "type": "array", + "items": { + "$ref": "#/definitions/InnerHealthError" + } + }, + "errorSource": { + "description": "Source of error.", + "type": "string" + }, + "errorType": { + "description": "Type of error.", + "type": "string" + }, + "errorLevel": { + "description": "Level of error.", + "type": "string" + }, + "errorCategory": { + "description": "Category of error.", + "type": "string" + }, + "errorCode": { + "description": "Error code.", + "type": "string" + }, + "summaryMessage": { + "description": "Summary message of the entity.", + "type": "string" + }, + "errorMessage": { + "description": "Error message.", + "type": "string" + }, + "possibleCauses": { + "description": "Possible causes of error.", + "type": "string" + }, + "recommendedAction": { + "description": "Recommended action to resolve error.", + "type": "string" + }, + "creationTimeUtc": { + "format": "date-time", + "description": "Error creation time (UTC).", + "type": "string" + }, + "recoveryProviderErrorMessage": { + "description": "DRA error message.", + "type": "string" + }, + "entityId": { + "description": "ID of the entity.", + "type": "string" + }, + "errorId": { + "description": "The health error unique id.", + "type": "string" + }, + "customerResolvability": { + "description": "Value indicating whether the health error is customer resolvable.", + "enum": [ + "Allowed", + "NotAllowed" + ], + "type": "string", + "x-ms-enum": { + "name": "HealthErrorCustomerResolvability", + "modelAsString": true + } + } + } + }, + "HealthErrorSummary": { + "description": "class to define the summary of the health error details.", + "type": "object", + "properties": { + "summaryCode": { + "description": "The code of the health error.", + "type": "string" + }, + "category": { + "description": "The category of the health error.", + "enum": [ + "None", + "Replication", + "TestFailover", + "Configuration", + "FabricInfrastructure", + "VersionExpiry", + "AgentAutoUpdateInfra", + "AgentAutoUpdateArtifactDeleted", + "AgentAutoUpdateRunAsAccount", + "AgentAutoUpdateRunAsAccountExpiry", + "AgentAutoUpdateRunAsAccountExpired" + ], + "type": "string", + "x-ms-enum": { + "name": "HealthErrorCategory", + "modelAsString": true + } + }, + "severity": { + "description": "Severity of error.", + "enum": [ + "NONE", + "Warning", + "Error", + "Info" + ], + "type": "string", + "x-ms-enum": { + "name": "Severity", + "modelAsString": true + } + }, + "summaryMessage": { + "description": "The summary message of the health error.", + "type": "string" + }, + "affectedResourceType": { + "description": "The type of affected ARM resource.", + "type": "string" + }, + "affectedResourceSubtype": { + "description": "The sub type of any subcomponent within the ARM resource that this might be applicable. Value remains null if not applicable.", + "type": "string" + }, + "affectedResourceCorrelationIds": { + "description": "The list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "HyperVHostDetails": { + "description": "Hyper-V host details.", + "type": "object", + "properties": { + "id": { + "description": "The Hyper-V host Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The Hyper-V host name.", + "type": "string", + "readOnly": true + }, + "marsAgentVersion": { + "description": "The Mars agent version.", + "type": "string", + "readOnly": true + } + } + }, + "HyperVReplica2012EventDetails": { + "description": "Model class for event details of a HyperVReplica E2E event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "containerName": { + "description": "The container friendly name.", + "type": "string" + }, + "fabricName": { + "description": "The fabric friendly name.", + "type": "string" + }, + "remoteContainerName": { + "description": "The remote container name.", + "type": "string" + }, + "remoteFabricName": { + "description": "The remote fabric name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplica2012" + }, + "HyperVReplica2012R2EventDetails": { + "description": "Model class for event details of a HyperVReplica blue E2E event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "containerName": { + "description": "The container friendly name.", + "type": "string" + }, + "fabricName": { + "description": "The fabric friendly name.", + "type": "string" + }, + "remoteContainerName": { + "description": "The remote container name.", + "type": "string" + }, + "remoteFabricName": { + "description": "The remote fabric name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplica2012R2" + }, + "HyperVReplicaAzureApplyRecoveryPointInput": { + "description": "ApplyRecoveryPoint input specific to HyperVReplicaAzure provider.", + "required": [ + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput" + } + ], + "properties": { + "primaryKekCertificatePfx": { + "description": "The primary kek certificate pfx.", + "type": "string" + }, + "secondaryKekCertificatePfx": { + "description": "The secondary kek certificate pfx.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureDiskInputDetails": { + "description": "Disk input details.", + "type": "object", + "properties": { + "diskId": { + "description": "The DiskId.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The LogStorageAccountId.", + "type": "string" + }, + "diskType": { + "description": "The DiskType.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM ID.", + "type": "string" + } + } + }, + "HyperVReplicaAzureEnableProtectionInput": { + "description": "HyperVReplicaAzure specific enable protection input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnableProtectionProviderSpecificInput" + } + ], + "properties": { + "hvHostVmId": { + "description": "The Hyper-V host VM Id.", + "type": "string" + }, + "vmName": { + "description": "The VM Name.", + "type": "string" + }, + "osType": { + "description": "The OS type associated with VM.", + "type": "string" + }, + "vhdId": { + "description": "The OS disk VHD id associated with VM.", + "type": "string" + }, + "targetStorageAccountId": { + "description": "The storage account Id.", + "type": "string" + }, + "targetAzureNetworkId": { + "description": "The selected target Azure network Id.", + "type": "string" + }, + "targetAzureSubnetId": { + "description": "The selected target Azure subnet Id.", + "type": "string" + }, + "enableRdpOnTargetOption": { + "description": "The selected option to enable RDP\\SSH on target vm after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum.", + "type": "string" + }, + "targetAzureVmName": { + "description": "The target azure VM Name.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The storage account to be used for logging during replication.", + "type": "string" + }, + "disksToInclude": { + "description": "The list of VHD Ids of disks to be protected.", + "type": "array", + "items": { + "type": "string" + } + }, + "targetAzureV1ResourceGroupId": { + "description": "The Id of the target resource group (for classic deployment) in which the failover VM is to be created.", + "type": "string" + }, + "targetAzureV2ResourceGroupId": { + "description": "The Id of the target resource group (for resource manager deployment) in which the failover VM is to be created.", + "type": "string" + }, + "useManagedDisks": { + "description": "A value indicating whether managed disks should be used during failover.", + "type": "string" + }, + "targetAvailabilitySetId": { + "description": "The target availability set ARM Id for resource manager deployment.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "licenseType": { + "description": "License type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "PAYG", + "AHUB" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true + } + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The proximity placement group ARM Id.", + "type": "string" + }, + "useManagedDisksForReplication": { + "description": "A value indicating whether managed disks should be used during replication.", + "type": "string" + }, + "diskType": { + "description": "The DiskType.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + }, + "disksToIncludeForManagedDisks": { + "description": "The disks to include list for managed disks.", + "type": "array", + "items": { + "$ref": "#/definitions/HyperVReplicaAzureDiskInputDetails" + } + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM Id.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "seedManagedDiskTags": { + "description": "The tags for the seed managed disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetManagedDiskTags": { + "description": "The tags for the target managed disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureEventDetails": { + "description": "Model class for event details of a HyperVReplica E2A event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "containerName": { + "description": "The container friendly name.", + "type": "string" + }, + "fabricName": { + "description": "The fabric friendly name.", + "type": "string" + }, + "remoteContainerName": { + "description": "The remote container name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureFailbackProviderInput": { + "description": "HyperVReplicaAzureFailback specific planned failover input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PlannedFailoverProviderSpecificFailoverInput" + } + ], + "properties": { + "dataSyncOption": { + "description": "Data sync option.", + "type": "string" + }, + "recoveryVmCreationOption": { + "description": "ALR options to create alternate recovery.", + "type": "string" + }, + "providerIdForAlternateRecovery": { + "description": "Provider Id for alternate location.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzureFailback" + }, + "HyperVReplicaAzureManagedDiskDetails": { + "description": "Hyper-V Managed disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "seedManagedDiskId": { + "description": "Seed managed disk Id.", + "type": "string" + }, + "replicaDiskType": { + "description": "The replica disk type.", + "type": "string" + }, + "diskEncryptionSetId": { + "description": "The disk encryption set ARM Id.", + "type": "string" + } + } + }, + "HyperVReplicaAzurePlannedFailoverProviderInput": { + "description": "HyperVReplicaAzure specific planned failover input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PlannedFailoverProviderSpecificFailoverInput" + } + ], + "properties": { + "primaryKekCertificatePfx": { + "description": "Primary kek certificate pfx.", + "type": "string" + }, + "secondaryKekCertificatePfx": { + "description": "Secondary kek certificate pfx.", + "type": "string" + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzurePolicyDetails": { + "description": "Hyper-V Replica Azure specific protection profile details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPointHistoryDurationInHours": { + "format": "int32", + "description": "The duration (in hours) to which point the recovery history needs to be maintained.", + "type": "integer" + }, + "applicationConsistentSnapshotFrequencyInHours": { + "format": "int32", + "description": "The interval (in hours) at which Hyper-V Replica should create an application consistent snapshot within the VM.", + "type": "integer" + }, + "replicationInterval": { + "format": "int32", + "description": "The replication interval.", + "type": "integer" + }, + "onlineReplicationStartTime": { + "description": "The scheduled start time for the initial replication. If this parameter is Null, the initial replication starts immediately.", + "type": "string" + }, + "encryption": { + "description": "A value indicating whether encryption is enabled for virtual machines in this cloud.", + "type": "string" + }, + "activeStorageAccountId": { + "description": "The active storage account Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzurePolicyInput": { + "description": "Hyper-V Replica Azure specific input for creating a protection profile.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "recoveryPointHistoryDuration": { + "format": "int32", + "description": "The duration (in hours) to which point the recovery history needs to be maintained.", + "type": "integer" + }, + "applicationConsistentSnapshotFrequencyInHours": { + "format": "int32", + "description": "The interval (in hours) at which Hyper-V Replica should create an application consistent snapshot within the VM.", + "type": "integer" + }, + "replicationInterval": { + "format": "int32", + "description": "The replication interval.", + "type": "integer" + }, + "onlineReplicationStartTime": { + "description": "The scheduled start time for the initial replication. If this parameter is Null, the initial replication starts immediately.", + "type": "string" + }, + "storageAccounts": { + "description": "The list of storage accounts to which the VMs in the primary cloud can replicate to.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureReplicationDetails": { + "description": "Hyper V Replica Azure provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "azureVmDiskDetails": { + "description": "Azure VM Disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/AzureVmDiskDetails" + } + }, + "recoveryAzureVmName": { + "description": "Recovery Azure given name.", + "type": "string" + }, + "recoveryAzureVMSize": { + "description": "The Recovery Azure VM size.", + "type": "string" + }, + "recoveryAzureStorageAccount": { + "description": "The recovery Azure storage account.", + "type": "string" + }, + "recoveryAzureLogStorageAccountId": { + "description": "The ARM id of the log storage account used for replication. This will be set to null if no log storage account was provided during enable protection.", + "type": "string" + }, + "lastReplicatedTime": { + "format": "date-time", + "description": "The Last replication time.", + "type": "string" + }, + "rpoInSeconds": { + "format": "int64", + "description": "Last RPO value.", + "type": "integer" + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The last RPO calculated time.", + "type": "string" + }, + "vmId": { + "description": "The virtual machine Id.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "initialReplicationDetails": { + "$ref": "#/definitions/InitialReplicationDetails", + "description": "Initial replication details." + }, + "vmNics": { + "description": "The PE Network details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicDetails" + } + }, + "selectedRecoveryAzureNetworkId": { + "description": "The selected recovery azure network Id.", + "type": "string" + }, + "selectedSourceNicId": { + "description": "The selected source nic Id which will be used as the primary nic during failover.", + "type": "string" + }, + "encryption": { + "description": "The encryption info.", + "type": "string" + }, + "oSDetails": { + "$ref": "#/definitions/OSDetails", + "description": "The operating system info." + }, + "sourceVmRamSizeInMB": { + "format": "int32", + "description": "The RAM size of the VM on the primary side.", + "type": "integer" + }, + "sourceVmCpuCount": { + "format": "int32", + "description": "The CPU count of the VM on the primary side.", + "type": "integer" + }, + "enableRdpOnTargetOption": { + "description": "The selected option to enable RDP\\SSH on target vm after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum.", + "type": "string" + }, + "recoveryAzureResourceGroupId": { + "description": "The target resource group Id.", + "type": "string" + }, + "recoveryAvailabilitySetId": { + "description": "The recovery availability set Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "useManagedDisks": { + "description": "A value indicating whether managed disks should be used during failover.", + "type": "string" + }, + "licenseType": { + "description": "License Type of the VM to be used.", + "type": "string" + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "type": "string" + }, + "lastRecoveryPointReceived": { + "format": "date-time", + "description": "The last recovery point received time.", + "type": "string", + "readOnly": true + }, + "targetVmTags": { + "description": "The target VM tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "seedManagedDiskTags": { + "description": "The tags for the seed managed disks.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetManagedDiskTags": { + "description": "The tags for the target managed disks.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "protectedManagedDisks": { + "description": "The list of protected managed disks.", + "type": "array", + "items": { + "$ref": "#/definitions/HyperVReplicaAzureManagedDiskDetails" + } + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureReprotectInput": { + "description": "Azure specific reprotect input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReverseReplicationProviderSpecificInput" + } + ], + "properties": { + "hvHostVmId": { + "description": "The Hyper-V host Vm Id.", + "type": "string" + }, + "vmName": { + "description": "The Vm Name.", + "type": "string" + }, + "osType": { + "description": "The OS type associated with vm.", + "type": "string" + }, + "vHDId": { + "description": "The OS disk VHD id associated with vm.", + "type": "string" + }, + "storageAccountId": { + "description": "The storage account name.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The storage account to be used for logging during replication.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureTestFailoverInput": { + "description": "HvrA provider specific input for test failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TestFailoverProviderSpecificInput" + } + ], + "properties": { + "primaryKekCertificatePfx": { + "description": "Primary kek certificate pfx.", + "type": "string" + }, + "secondaryKekCertificatePfx": { + "description": "Secondary kek certificate pfx.", + "type": "string" + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to test failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureUnplannedFailoverInput": { + "description": "HvrA provider specific input for unplanned failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput" + } + ], + "properties": { + "primaryKekCertificatePfx": { + "description": "Primary kek certificate pfx.", + "type": "string" + }, + "secondaryKekCertificatePfx": { + "description": "Secondary kek certificate pfx.", + "type": "string" + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureUpdateReplicationProtectedItemInput": { + "description": "HyperV replica Azure input to update replication protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UpdateReplicationProtectedItemProviderInput" + } + ], + "properties": { + "recoveryAzureV1ResourceGroupId": { + "description": "The recovery Azure resource group Id for classic deployment.", + "type": "string" + }, + "recoveryAzureV2ResourceGroupId": { + "description": "The recovery Azure resource group Id for resource manager deployment.", + "type": "string" + }, + "useManagedDisks": { + "description": "A value indicating whether managed disks should be used during failover.", + "type": "string" + }, + "diskIdToDiskEncryptionMap": { + "description": "The dictionary of disk resource Id to disk encryption set ARM Id.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetManagedDiskTags": { + "description": "The tags for the target managed disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "PAYG", + "AHUB" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaBaseEventDetails": { + "description": "Abstract model class for event details of a HyperVReplica E2E event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "containerName": { + "description": "The container friendly name.", + "type": "string" + }, + "fabricName": { + "description": "The fabric friendly name.", + "type": "string" + }, + "remoteContainerName": { + "description": "The remote container name.", + "type": "string" + }, + "remoteFabricName": { + "description": "The remote fabric name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaBaseEventDetails" + }, + "HyperVReplicaBasePolicyDetails": { + "description": "Base class for HyperVReplica policy details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPoints": { + "format": "int32", + "description": "A value indicating the number of recovery points.", + "type": "integer" + }, + "applicationConsistentSnapshotFrequencyInHours": { + "format": "int32", + "description": "A value indicating the application consistent frequency.", + "type": "integer" + }, + "compression": { + "description": "A value indicating whether compression has to be enabled.", + "type": "string" + }, + "initialReplicationMethod": { + "description": "A value indicating whether IR is online.", + "type": "string" + }, + "onlineReplicationStartTime": { + "description": "A value indicating the online IR start time.", + "type": "string" + }, + "offlineReplicationImportPath": { + "description": "A value indicating the offline IR import path.", + "type": "string" + }, + "offlineReplicationExportPath": { + "description": "A value indicating the offline IR export path.", + "type": "string" + }, + "replicationPort": { + "format": "int32", + "description": "A value indicating the recovery HTTPS port.", + "type": "integer" + }, + "allowedAuthenticationType": { + "format": "int32", + "description": "A value indicating the authentication type.", + "type": "integer" + }, + "replicaDeletionOption": { + "description": "A value indicating whether the VM has to be auto deleted. Supported Values: String.Empty, None, OnRecoveryCloud.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaBasePolicyDetails" + }, + "HyperVReplicaBaseReplicationDetails": { + "description": "Hyper V replica provider specific settings base class.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "lastReplicatedTime": { + "format": "date-time", + "description": "The Last replication time.", + "type": "string" + }, + "vmNics": { + "description": "The PE Network details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicDetails" + } + }, + "vmId": { + "description": "The virtual machine Id.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "initialReplicationDetails": { + "$ref": "#/definitions/InitialReplicationDetails", + "description": "Initial replication details." + }, + "vMDiskDetails": { + "description": "VM disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/DiskDetails" + } + } + }, + "x-ms-discriminator-value": "HyperVReplicaBaseReplicationDetails" + }, + "HyperVReplicaBluePolicyDetails": { + "description": "Hyper-V Replica Blue specific protection profile details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "replicationFrequencyInSeconds": { + "format": "int32", + "description": "A value indicating the replication interval.", + "type": "integer" + }, + "recoveryPoints": { + "format": "int32", + "description": "A value indicating the number of recovery points.", + "type": "integer" + }, + "applicationConsistentSnapshotFrequencyInHours": { + "format": "int32", + "description": "A value indicating the application consistent frequency.", + "type": "integer" + }, + "compression": { + "description": "A value indicating whether compression has to be enabled.", + "type": "string" + }, + "initialReplicationMethod": { + "description": "A value indicating whether IR is online.", + "type": "string" + }, + "onlineReplicationStartTime": { + "description": "A value indicating the online IR start time.", + "type": "string" + }, + "offlineReplicationImportPath": { + "description": "A value indicating the offline IR import path.", + "type": "string" + }, + "offlineReplicationExportPath": { + "description": "A value indicating the offline IR export path.", + "type": "string" + }, + "replicationPort": { + "format": "int32", + "description": "A value indicating the recovery HTTPS port.", + "type": "integer" + }, + "allowedAuthenticationType": { + "format": "int32", + "description": "A value indicating the authentication type.", + "type": "integer" + }, + "replicaDeletionOption": { + "description": "A value indicating whether the VM has to be auto deleted. Supported Values: String.Empty, None, OnRecoveryCloud", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplica2012R2" + }, + "HyperVReplicaBluePolicyInput": { + "description": "HyperV Replica Blue policy input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HyperVReplicaPolicyInput" + } + ], + "properties": { + "replicationFrequencyInSeconds": { + "format": "int32", + "description": "A value indicating the replication interval.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "HyperVReplica2012R2" + }, + "HyperVReplicaBlueReplicationDetails": { + "description": "HyperV replica 2012 R2 (Blue) replication details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "lastReplicatedTime": { + "format": "date-time", + "description": "The Last replication time.", + "type": "string" + }, + "vmNics": { + "description": "The PE Network details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicDetails" + } + }, + "vmId": { + "description": "The virtual machine Id.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "initialReplicationDetails": { + "$ref": "#/definitions/InitialReplicationDetails", + "description": "Initial replication details." + }, + "vMDiskDetails": { + "description": "VM disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/DiskDetails" + } + } + }, + "x-ms-discriminator-value": "HyperVReplica2012R2" + }, + "HyperVReplicaPolicyDetails": { + "description": "Hyper-V Replica Blue specific protection profile details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPoints": { + "format": "int32", + "description": "A value indicating the number of recovery points.", + "type": "integer" + }, + "applicationConsistentSnapshotFrequencyInHours": { + "format": "int32", + "description": "A value indicating the application consistent frequency.", + "type": "integer" + }, + "compression": { + "description": "A value indicating whether compression has to be enabled.", + "type": "string" + }, + "initialReplicationMethod": { + "description": "A value indicating whether IR is online.", + "type": "string" + }, + "onlineReplicationStartTime": { + "description": "A value indicating the online IR start time.", + "type": "string" + }, + "offlineReplicationImportPath": { + "description": "A value indicating the offline IR import path.", + "type": "string" + }, + "offlineReplicationExportPath": { + "description": "A value indicating the offline IR export path.", + "type": "string" + }, + "replicationPort": { + "format": "int32", + "description": "A value indicating the recovery HTTPS port.", + "type": "integer" + }, + "allowedAuthenticationType": { + "format": "int32", + "description": "A value indicating the authentication type.", + "type": "integer" + }, + "replicaDeletionOption": { + "description": "A value indicating whether the VM has to be auto deleted. Supported Values: String.Empty, None, OnRecoveryCloud", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplica2012" + }, + "HyperVReplicaPolicyInput": { + "description": "Hyper-V Replica specific policy Input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "recoveryPoints": { + "format": "int32", + "description": "A value indicating the number of recovery points.", + "type": "integer" + }, + "applicationConsistentSnapshotFrequencyInHours": { + "format": "int32", + "description": "A value indicating the application consistent frequency.", + "type": "integer" + }, + "compression": { + "description": "A value indicating whether compression has to be enabled.", + "type": "string" + }, + "initialReplicationMethod": { + "description": "A value indicating whether IR is online.", + "type": "string" + }, + "onlineReplicationStartTime": { + "description": "A value indicating the online IR start time.", + "type": "string" + }, + "offlineReplicationImportPath": { + "description": "A value indicating the offline IR import path.", + "type": "string" + }, + "offlineReplicationExportPath": { + "description": "A value indicating the offline IR export path.", + "type": "string" + }, + "replicationPort": { + "format": "int32", + "description": "A value indicating the recovery HTTPS port.", + "type": "integer" + }, + "allowedAuthenticationType": { + "format": "int32", + "description": "A value indicating the authentication type.", + "type": "integer" + }, + "replicaDeletion": { + "description": "A value indicating whether the VM has to be auto deleted.", + "type": "string" + } + }, + "discriminator": "instanceType", + "x-ms-discriminator-value": "HyperVReplica2012" + }, + "HyperVReplicaReplicationDetails": { + "description": "HyperV replica 2012 replication details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "lastReplicatedTime": { + "format": "date-time", + "description": "The Last replication time.", + "type": "string" + }, + "vmNics": { + "description": "The PE Network details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicDetails" + } + }, + "vmId": { + "description": "The virtual machine Id.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "initialReplicationDetails": { + "$ref": "#/definitions/InitialReplicationDetails", + "description": "Initial replication details." + }, + "vMDiskDetails": { + "description": "VM disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/DiskDetails" + } + } + }, + "x-ms-discriminator-value": "HyperVReplica2012" + }, + "HyperVSiteDetails": { + "description": "HyperVSite fabric specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificDetails" + } + ], + "properties": { + "hyperVHosts": { + "description": "The list of Hyper-V hosts associated with the fabric.", + "type": "array", + "items": { + "$ref": "#/definitions/HyperVHostDetails" + } + } + }, + "x-ms-discriminator-value": "HyperVSite" + }, + "HyperVVirtualMachineDetails": { + "description": "Single Host fabric provider specific VM settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConfigurationSettings" + } + ], + "properties": { + "sourceItemId": { + "description": "The source id of the object.", + "type": "string" + }, + "generation": { + "description": "The id of the object in fabric.", + "type": "string" + }, + "osDetails": { + "$ref": "#/definitions/OSDetails", + "description": "The Last replication time." + }, + "diskDetails": { + "description": "The Last successful failover time.", + "type": "array", + "items": { + "$ref": "#/definitions/DiskDetails" + } + }, + "hasPhysicalDisk": { + "description": "A value indicating whether the VM has a physical disk attached. String value of SrsDataContract.PresenceStatus enum.", + "enum": [ + "Unknown", + "Present", + "NotPresent" + ], + "type": "string", + "x-ms-enum": { + "name": "PresenceStatus", + "modelAsString": true + } + }, + "hasFibreChannelAdapter": { + "description": "A value indicating whether the VM has a fibre channel adapter attached. String value of SrsDataContract.PresenceStatus enum.", + "enum": [ + "Unknown", + "Present", + "NotPresent" + ], + "type": "string", + "x-ms-enum": { + "name": "PresenceStatus", + "modelAsString": true + } + }, + "hasSharedVhd": { + "description": "A value indicating whether the VM has a shared VHD attached. String value of SrsDataContract.PresenceStatus enum.", + "enum": [ + "Unknown", + "Present", + "NotPresent" + ], + "type": "string", + "x-ms-enum": { + "name": "PresenceStatus", + "modelAsString": true + } + } + }, + "discriminator": "instanceType", + "x-ms-discriminator-value": "HyperVVirtualMachine" + }, + "IdentityProviderDetails": { + "description": "Identity provider details.", + "type": "object", + "properties": { + "tenantId": { + "description": "The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "applicationId": { + "description": "The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "objectId": { + "description": "The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "audience": { + "description": "The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "aadAuthority": { + "description": "The base authority for Azure Active Directory authentication.", + "type": "string" + } + } + }, + "IdentityProviderInput": { + "description": "Identity provider input.", + "required": [ + "tenantId", + "applicationId", + "objectId", + "audience", + "aadAuthority" + ], + "type": "object", + "properties": { + "tenantId": { + "description": "The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "applicationId": { + "description": "The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "objectId": { + "description": "The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "audience": { + "description": "The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "aadAuthority": { + "description": "The base authority for Azure Active Directory authentication.", + "type": "string" + } + } + }, + "InconsistentVmDetails": { + "description": "This class stores the monitoring details for consistency check of inconsistent Protected Entity.", + "type": "object", + "properties": { + "vmName": { + "description": "The Vm name.", + "type": "string" + }, + "cloudName": { + "description": "The Cloud name.", + "type": "string" + }, + "details": { + "description": "The list of details regarding state of the Protected Entity in SRS and On prem.", + "type": "array", + "items": { + "type": "string" + } + }, + "errorIds": { + "description": "The list of error ids.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "InitialReplicationDetails": { + "description": "Initial replication details.", + "type": "object", + "properties": { + "initialReplicationType": { + "description": "Initial replication type.", + "type": "string" + }, + "initialReplicationProgressPercentage": { + "description": "The initial replication progress percentage.", + "type": "string" + } + } + }, + "InlineWorkflowTaskDetails": { + "description": "This class represents the inline workflow task details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GroupTaskDetails" + } + ], + "properties": { + "workflowIds": { + "description": "The list of child workflow ids.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "InlineWorkflowTaskDetails" + }, + "InMageAgentDetails": { + "description": "The details of the InMage agent.", + "type": "object", + "properties": { + "agentVersion": { + "description": "The agent version.", + "type": "string" + }, + "agentUpdateStatus": { + "description": "A value indicating whether installed agent needs to be updated.", + "type": "string" + }, + "postUpdateRebootStatus": { + "description": "A value indicating whether reboot is required after update is applied.", + "type": "string" + }, + "agentExpiryDate": { + "format": "date-time", + "description": "Agent expiry date.", + "type": "string" + } + } + }, + "InMageAzureV2ApplyRecoveryPointInput": { + "description": "ApplyRecoveryPoint input specific to InMageAzureV2 provider.", + "required": [ + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2DiskInputDetails": { + "description": "Disk input details.", + "type": "object", + "properties": { + "diskId": { + "description": "The DiskId.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The LogStorageAccountId.", + "type": "string" + }, + "diskType": { + "description": "The DiskType.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM ID.", + "type": "string" + } + } + }, + "InMageAzureV2EnableProtectionInput": { + "description": "VMware Azure specific enable protection input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnableProtectionProviderSpecificInput" + } + ], + "properties": { + "masterTargetId": { + "description": "The Master target Id.", + "type": "string" + }, + "processServerId": { + "description": "The Process Server Id.", + "type": "string" + }, + "storageAccountId": { + "description": "The storage account Id.", + "type": "string" + }, + "runAsAccountId": { + "description": "The CS account Id.", + "type": "string" + }, + "multiVmGroupId": { + "description": "The multi VM group Id.", + "type": "string" + }, + "multiVmGroupName": { + "description": "The multi VM group name.", + "type": "string" + }, + "disksToInclude": { + "description": "The disks to include list.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageAzureV2DiskInputDetails" + } + }, + "targetAzureNetworkId": { + "description": "The selected target Azure network Id.", + "type": "string" + }, + "targetAzureSubnetId": { + "description": "The selected target Azure subnet Id.", + "type": "string" + }, + "enableRdpOnTargetOption": { + "description": "The selected option to enable RDP\\SSH on target VM after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum.", + "type": "string" + }, + "targetAzureVmName": { + "description": "The target azure VM Name.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The storage account to be used for logging during replication.", + "type": "string" + }, + "targetAzureV1ResourceGroupId": { + "description": "The Id of the target resource group (for classic deployment) in which the failover VM is to be created.", + "type": "string" + }, + "targetAzureV2ResourceGroupId": { + "description": "The Id of the target resource group (for resource manager deployment) in which the failover VM is to be created.", + "type": "string" + }, + "diskType": { + "description": "The DiskType.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + }, + "targetAvailabilitySetId": { + "description": "The target availability set ARM Id for resource manager deployment.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The proximity placement group ARM Id.", + "type": "string" + }, + "licenseType": { + "description": "License type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "PAYG", + "AHUB" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true + } + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM Id.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "seedManagedDiskTags": { + "description": "The tags for the seed managed disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetManagedDiskTags": { + "description": "The tags for the target managed disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2EventDetails": { + "description": "Model class for event details of a VMwareAzureV2 event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "eventType": { + "description": "InMage Event type. Takes one of the values of InMageDataContract.InMageMonitoringEventType.", + "type": "string" + }, + "category": { + "description": "InMage Event Category.", + "type": "string" + }, + "component": { + "description": "InMage Event Component.", + "type": "string" + }, + "correctiveAction": { + "description": "Corrective Action string for the event.", + "type": "string" + }, + "details": { + "description": "InMage Event Details.", + "type": "string" + }, + "summary": { + "description": "InMage Event Summary.", + "type": "string" + }, + "siteName": { + "description": "VMware Site name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2ManagedDiskDetails": { + "description": "InMageAzureV2 Managed disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk id.", + "type": "string" + }, + "seedManagedDiskId": { + "description": "Seed managed disk Id.", + "type": "string" + }, + "replicaDiskType": { + "description": "The replica disk type.", + "type": "string" + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM ID.", + "type": "string" + } + } + }, + "InMageAzureV2PolicyDetails": { + "description": "InMage Azure v2 specific protection profile details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency in minutes.", + "type": "integer" + }, + "recoveryPointThresholdInMinutes": { + "format": "int32", + "description": "The recovery point threshold in minutes.", + "type": "integer" + }, + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency in minutes.", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2PolicyInput": { + "description": "VMWare Azure specific policy Input.", + "required": [ + "multiVmSyncStatus" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "recoveryPointThresholdInMinutes": { + "format": "int32", + "description": "The recovery point threshold in minutes.", + "type": "integer" + }, + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'.", + "enum": [ + "Enable", + "Disable" + ], + "type": "string", + "x-ms-enum": { + "name": "SetMultiVmSyncStatus", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2ProtectedDiskDetails": { + "description": "InMageAzureV2 protected disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk id.", + "type": "string" + }, + "diskName": { + "description": "The disk name.", + "type": "string" + }, + "protectionStage": { + "description": "The protection stage.", + "type": "string" + }, + "healthErrorCode": { + "description": "The health error code for the disk.", + "type": "string" + }, + "rpoInSeconds": { + "format": "int64", + "description": "The RPO in seconds.", + "type": "integer" + }, + "resyncRequired": { + "description": "A value indicating whether resync is required for this disk.", + "type": "string" + }, + "resyncProgressPercentage": { + "format": "int32", + "description": "The resync progress percentage.", + "type": "integer" + }, + "resyncDurationInSeconds": { + "format": "int64", + "description": "The resync duration in seconds.", + "type": "integer" + }, + "diskCapacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer" + }, + "fileSystemCapacityInBytes": { + "format": "int64", + "description": "The disk file system capacity in bytes.", + "type": "integer" + }, + "sourceDataInMegaBytes": { + "format": "double", + "description": "The source data transit in MB.", + "type": "number" + }, + "psDataInMegaBytes": { + "format": "double", + "description": "The PS data transit in MB.", + "type": "number" + }, + "targetDataInMegaBytes": { + "format": "double", + "description": "The target data transit in MB.", + "type": "number" + }, + "diskResized": { + "description": "A value indicating whether disk is resized.", + "type": "string" + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The last RPO calculated time.", + "type": "string" + }, + "resyncProcessedBytes": { + "format": "int64", + "description": "The resync processed bytes.", + "type": "integer" + }, + "resyncTotalTransferredBytes": { + "format": "int64", + "description": "The resync total transferred bytes.", + "type": "integer" + }, + "resyncLast15MinutesTransferredBytes": { + "format": "int64", + "description": "The resync last 15 minutes transferred bytes.", + "type": "integer" + }, + "resyncLastDataTransferTimeUTC": { + "format": "date-time", + "description": "The last data transfer time in UTC.", + "type": "string" + }, + "resyncStartTime": { + "format": "date-time", + "description": "The resync start time.", + "type": "string" + }, + "progressHealth": { + "description": "The Progress Health.", + "type": "string" + }, + "progressStatus": { + "description": "The Progress Status.", + "type": "string" + } + } + }, + "InMageAzureV2RecoveryPointDetails": { + "description": "InMage Azure V2 provider specific recovery point details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProviderSpecificRecoveryPointDetails" + } + ], + "properties": { + "isMultiVmSyncPoint": { + "description": "A value indicating whether the recovery point is multi VM consistent.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2ReplicationDetails": { + "description": "InMageAzureV2 provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "infrastructureVmId": { + "description": "The infrastructure VM Id.", + "type": "string" + }, + "vCenterInfrastructureId": { + "description": "The vCenter infrastructure Id.", + "type": "string" + }, + "protectionStage": { + "description": "The protection stage.", + "type": "string" + }, + "vmId": { + "description": "The virtual machine Id.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "resyncProgressPercentage": { + "format": "int32", + "description": "The resync progress percentage.", + "type": "integer" + }, + "rpoInSeconds": { + "format": "int64", + "description": "The RPO in seconds.", + "type": "integer" + }, + "compressedDataRateInMB": { + "format": "double", + "description": "The compressed data change rate in MB.", + "type": "number" + }, + "uncompressedDataRateInMB": { + "format": "double", + "description": "The uncompressed data change rate in MB.", + "type": "number" + }, + "ipAddress": { + "description": "The source IP address.", + "type": "string" + }, + "agentVersion": { + "description": "The agent version.", + "type": "string" + }, + "agentExpiryDate": { + "format": "date-time", + "description": "Agent expiry date.", + "type": "string" + }, + "isAgentUpdateRequired": { + "description": "A value indicating whether installed agent needs to be updated.", + "type": "string" + }, + "isRebootAfterUpdateRequired": { + "description": "A value indicating whether the source server requires a restart after update.", + "type": "string" + }, + "lastHeartbeat": { + "format": "date-time", + "description": "The last heartbeat received from the source server.", + "type": "string" + }, + "processServerId": { + "description": "The process server Id.", + "type": "string" + }, + "processServerName": { + "description": "The process server name.", + "type": "string" + }, + "multiVmGroupId": { + "description": "The multi vm group Id.", + "type": "string" + }, + "multiVmGroupName": { + "description": "The multi vm group name.", + "type": "string" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi vm sync is enabled or disabled.", + "type": "string" + }, + "protectedDisks": { + "description": "The list of protected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageAzureV2ProtectedDiskDetails" + } + }, + "diskResized": { + "description": "A value indicating whether any disk is resized for this VM.", + "type": "string" + }, + "masterTargetId": { + "description": "The master target Id.", + "type": "string" + }, + "sourceVmCpuCount": { + "format": "int32", + "description": "The CPU count of the VM on the primary side.", + "type": "integer" + }, + "sourceVmRamSizeInMB": { + "format": "int32", + "description": "The RAM size of the VM on the primary side.", + "type": "integer" + }, + "osType": { + "description": "The type of the OS on the VM.", + "type": "string" + }, + "vhdName": { + "description": "The OS disk VHD name.", + "type": "string" + }, + "osDiskId": { + "description": "The id of the disk containing the OS.", + "type": "string" + }, + "azureVMDiskDetails": { + "description": "Azure VM Disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/AzureVmDiskDetails" + } + }, + "recoveryAzureVMName": { + "description": "Recovery Azure given name.", + "type": "string" + }, + "recoveryAzureVMSize": { + "description": "The Recovery Azure VM size.", + "type": "string" + }, + "recoveryAzureStorageAccount": { + "description": "The recovery Azure storage account.", + "type": "string" + }, + "recoveryAzureLogStorageAccountId": { + "description": "The ARM id of the log storage account used for replication. This will be set to null if no log storage account was provided during enable protection.", + "type": "string" + }, + "vmNics": { + "description": "The PE Network details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicDetails" + } + }, + "selectedRecoveryAzureNetworkId": { + "description": "The selected recovery azure network Id.", + "type": "string" + }, + "selectedTfoAzureNetworkId": { + "description": "The test failover virtual network.", + "type": "string" + }, + "selectedSourceNicId": { + "description": "The selected source nic Id which will be used as the primary nic during failover.", + "type": "string" + }, + "discoveryType": { + "description": "A value indicating the discovery type of the machine. Value can be vCenter or physical.", + "type": "string" + }, + "enableRdpOnTargetOption": { + "description": "The selected option to enable RDP\\SSH on target vm after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum.", + "type": "string" + }, + "datastores": { + "description": "The datastores of the on-premise machine. Value can be list of strings that contain datastore names.", + "type": "array", + "items": { + "type": "string" + } + }, + "targetVmId": { + "description": "The ARM Id of the target Azure VM. This value will be null until the VM is failed over. Only after failure it will be populated with the ARM Id of the Azure VM.", + "type": "string" + }, + "recoveryAzureResourceGroupId": { + "description": "The target resource group Id.", + "type": "string" + }, + "recoveryAvailabilitySetId": { + "description": "The recovery availability set Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "useManagedDisks": { + "description": "A value indicating whether managed disks should be used during failover.", + "type": "string" + }, + "licenseType": { + "description": "License Type of the VM to be used.", + "type": "string" + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "type": "string" + }, + "validationErrors": { + "description": "The validation errors of the on-premise machine Value can be list of validation errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The last RPO calculated time.", + "type": "string" + }, + "lastUpdateReceivedTime": { + "format": "date-time", + "description": "The last update time received from on-prem components.", + "type": "string" + }, + "replicaId": { + "description": "The replica id of the protected item.", + "type": "string" + }, + "osVersion": { + "description": "The OS Version of the protected item.", + "type": "string" + }, + "protectedManagedDisks": { + "description": "The list of protected managed disks.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageAzureV2ManagedDiskDetails" + } + }, + "lastRecoveryPointReceived": { + "format": "date-time", + "description": "The last recovery point received time.", + "type": "string", + "readOnly": true + }, + "firmwareType": { + "description": "The firmware type of this protected item.", + "type": "string" + }, + "azureVmGeneration": { + "description": "The target generation for this protected item.", + "type": "string" + }, + "isAdditionalStatsAvailable": { + "description": "A value indicating whether additional IR stats are available or not.", + "type": "boolean" + }, + "totalDataTransferred": { + "format": "int64", + "description": "The total transferred data in bytes.", + "type": "integer" + }, + "totalProgressHealth": { + "description": "The progress health.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "seedManagedDiskTags": { + "description": "The tags for the seed managed disks.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetManagedDiskTags": { + "description": "The tags for the target managed disks.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2ReprotectInput": { + "description": "InMageAzureV2 specific provider input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReverseReplicationProviderSpecificInput" + } + ], + "properties": { + "masterTargetId": { + "description": "The Master target Id.", + "type": "string" + }, + "processServerId": { + "description": "The Process Server Id.", + "type": "string" + }, + "storageAccountId": { + "description": "The storage account id.", + "type": "string" + }, + "runAsAccountId": { + "description": "The CS account Id.", + "type": "string" + }, + "policyId": { + "description": "The Policy Id.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The storage account to be used for logging during replication.", + "type": "string" + }, + "disksToInclude": { + "description": "The disks to include list.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2TestFailoverInput": { + "description": "InMageAzureV2 provider specific input for test failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TestFailoverProviderSpecificInput" + } + ], + "properties": { + "recoveryPointId": { + "description": "The recovery point id to be passed to test failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2UnplannedFailoverInput": { + "description": "InMageAzureV2 provider specific input for unplanned failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput" + } + ], + "properties": { + "recoveryPointId": { + "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2UpdateReplicationProtectedItemInput": { + "description": "InMage Azure V2 input to update replication protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UpdateReplicationProtectedItemProviderInput" + } + ], + "properties": { + "recoveryAzureV1ResourceGroupId": { + "description": "The recovery Azure resource group Id for classic deployment.", + "type": "string" + }, + "recoveryAzureV2ResourceGroupId": { + "description": "The recovery Azure resource group Id for resource manager deployment.", + "type": "string" + }, + "useManagedDisks": { + "description": "A value indicating whether managed disks should be used during failover.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetManagedDiskTags": { + "description": "The tags for the target managed disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "PAYG", + "AHUB" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageBasePolicyDetails": { + "description": "Base class for the policies of providers using InMage replication.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPointThresholdInMinutes": { + "format": "int32", + "description": "The recovery point threshold in minutes.", + "type": "integer" + }, + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency in minutes.", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageBasePolicyDetails" + }, + "InMageDisableProtectionProviderSpecificInput": { + "description": "InMage disable protection provider specific input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DisableProtectionProviderSpecificInput" + } + ], + "properties": { + "replicaVmDeletionStatus": { + "description": "A value indicating whether the replica VM should be destroyed or retained. Values from Delete and Retain.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMageDiskDetails": { + "description": "VMware/Physical specific Disk Details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "diskName": { + "description": "The disk name.", + "type": "string" + }, + "diskSizeInMB": { + "description": "The disk size in MB.", + "type": "string" + }, + "diskType": { + "description": "Whether disk is system disk or data disk.", + "type": "string" + }, + "diskConfiguration": { + "description": "Whether disk is dynamic disk or basic disk.", + "type": "string" + }, + "volumeList": { + "description": "Volumes of the disk.", + "type": "array", + "items": { + "$ref": "#/definitions/DiskVolumeDetails" + } + } + } + }, + "InMageDiskExclusionInput": { + "description": "DiskExclusionInput when doing enable protection of virtual machine in InMage provider.", + "type": "object", + "properties": { + "volumeOptions": { + "description": "The volume label based option for disk exclusion.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageVolumeExclusionOptions" + } + }, + "diskSignatureOptions": { + "description": "The guest disk signature based option for disk exclusion.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageDiskSignatureExclusionOptions" + } + } + } + }, + "InMageDiskSignatureExclusionOptions": { + "description": "Guest disk signature based disk exclusion option when doing enable protection of virtual machine in InMage provider.", + "type": "object", + "properties": { + "diskSignature": { + "description": "The guest signature of disk to be excluded from replication.", + "type": "string" + } + } + }, + "InMageEnableProtectionInput": { + "description": "VMware Azure specific enable protection input.", + "required": [ + "masterTargetId", + "processServerId", + "retentionDrive", + "multiVmGroupId", + "multiVmGroupName" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnableProtectionProviderSpecificInput" + } + ], + "properties": { + "vmFriendlyName": { + "description": "The VM Name.", + "type": "string" + }, + "masterTargetId": { + "description": "The Master Target Id.", + "type": "string" + }, + "processServerId": { + "description": "The Process Server Id.", + "type": "string" + }, + "retentionDrive": { + "description": "The retention drive to use on the MT.", + "type": "string" + }, + "runAsAccountId": { + "description": "The CS account Id.", + "type": "string" + }, + "multiVmGroupId": { + "description": "The multi VM group Id.", + "type": "string" + }, + "multiVmGroupName": { + "description": "The multi VM group name.", + "type": "string" + }, + "datastoreName": { + "description": "The target datastore name.", + "type": "string" + }, + "diskExclusionInput": { + "$ref": "#/definitions/InMageDiskExclusionInput", + "description": "The enable disk exclusion input." + }, + "disksToInclude": { + "description": "The disks to include list.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMagePolicyDetails": { + "description": "InMage specific protection profile details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPointThresholdInMinutes": { + "format": "int32", + "description": "The recovery point threshold in minutes.", + "type": "integer" + }, + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency in minutes.", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMagePolicyInput": { + "description": "VMWare Azure specific protection profile Input.", + "required": [ + "multiVmSyncStatus" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "recoveryPointThresholdInMinutes": { + "format": "int32", + "description": "The recovery point threshold in minutes.", + "type": "integer" + }, + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'.", + "enum": [ + "Enable", + "Disable" + ], + "type": "string", + "x-ms-enum": { + "name": "SetMultiVmSyncStatus", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMageProtectedDiskDetails": { + "description": "InMage protected disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk id.", + "type": "string" + }, + "diskName": { + "description": "The disk name.", + "type": "string" + }, + "protectionStage": { + "description": "The protection stage.", + "type": "string" + }, + "healthErrorCode": { + "description": "The health error code for the disk.", + "type": "string" + }, + "rpoInSeconds": { + "format": "int64", + "description": "The RPO in seconds.", + "type": "integer" + }, + "resyncRequired": { + "description": "A value indicating whether resync is required for this disk.", + "type": "string" + }, + "resyncProgressPercentage": { + "format": "int32", + "description": "The resync progress percentage.", + "type": "integer" + }, + "resyncDurationInSeconds": { + "format": "int64", + "description": "The resync duration in seconds.", + "type": "integer" + }, + "diskCapacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer" + }, + "fileSystemCapacityInBytes": { + "format": "int64", + "description": "The file system capacity in bytes.", + "type": "integer" + }, + "sourceDataInMB": { + "format": "double", + "description": "The source data transit in MB.", + "type": "number" + }, + "psDataInMB": { + "format": "double", + "description": "The PS data transit in MB.", + "type": "number" + }, + "targetDataInMB": { + "format": "double", + "description": "The target data transit in MB.", + "type": "number" + }, + "diskResized": { + "description": "A value indicating whether disk is resized.", + "type": "string" + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The last RPO calculated time.", + "type": "string" + }, + "resyncProcessedBytes": { + "format": "int64", + "description": "The resync processed bytes.", + "type": "integer" + }, + "resyncTotalTransferredBytes": { + "format": "int64", + "description": "The resync total transferred bytes.", + "type": "integer" + }, + "resyncLast15MinutesTransferredBytes": { + "format": "int64", + "description": "The resync last 15 minutes transferred bytes.", + "type": "integer" + }, + "resyncLastDataTransferTimeUTC": { + "format": "date-time", + "description": "The last data transfer time in UTC.", + "type": "string" + }, + "resyncStartTime": { + "format": "date-time", + "description": "The resync start time.", + "type": "string" + }, + "progressHealth": { + "description": "The Progress Health.", + "type": "string" + }, + "progressStatus": { + "description": "The Progress Status.", + "type": "string" + } + } + }, + "InMageRcmAgentUpgradeBlockingErrorDetails": { + "description": "InMageRcm source agent upgrade blocking error details.", + "type": "object", + "properties": { + "errorCode": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "errorMessage": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "possibleCauses": { + "description": "The possible causes.", + "type": "string", + "readOnly": true + }, + "recommendedAction": { + "description": "The recommended action.", + "type": "string", + "readOnly": true + }, + "errorMessageParameters": { + "description": "The error message parameters.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "errorTags": { + "description": "The error tags.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + } + }, + "InMageRcmApplyRecoveryPointInput": { + "description": "ApplyRecoveryPoint input specific to InMageRcm provider.", + "required": [ + "recoveryPointId", + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput" + } + ], + "properties": { + "recoveryPointId": { + "description": "The recovery point Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmDiskInput": { + "description": "InMageRcm disk input.", + "required": [ + "diskId", + "logStorageAccountId", + "diskType" + ], + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string" + }, + "diskType": { + "description": "The disk type.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM Id.", + "type": "string" + } + } + }, + "InMageRcmDisksDefaultInput": { + "description": "InMageRcm disk input.", + "required": [ + "logStorageAccountId", + "diskType" + ], + "type": "object", + "properties": { + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string" + }, + "diskType": { + "description": "The disk type.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM Id.", + "type": "string" + } + } + }, + "InMageRcmEnableProtectionInput": { + "description": "InMageRcm specific enable protection input.", + "required": [ + "fabricDiscoveryMachineId", + "targetResourceGroupId", + "processServerId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnableProtectionProviderSpecificInput" + } + ], + "properties": { + "fabricDiscoveryMachineId": { + "description": "The ARM Id of discovered machine.", + "type": "string" + }, + "disksToInclude": { + "description": "The disks to include list.", + "minLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmDiskInput" + } + }, + "disksDefault": { + "$ref": "#/definitions/InMageRcmDisksDefaultInput", + "description": "The default disk input." + }, + "targetResourceGroupId": { + "description": "The target resource group ARM Id.", + "type": "string" + }, + "targetNetworkId": { + "description": "The selected target network ARM Id.", + "type": "string" + }, + "testNetworkId": { + "description": "The selected test network ARM Id.", + "type": "string" + }, + "targetSubnetName": { + "description": "The selected target subnet name.", + "type": "string" + }, + "testSubnetName": { + "description": "The selected test subnet name.", + "type": "string" + }, + "targetVmName": { + "description": "The target VM name.", + "type": "string" + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "licenseType": { + "description": "The license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "targetAvailabilitySetId": { + "description": "The target availability set ARM Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "targetBootDiagnosticsStorageAccountId": { + "description": "The target boot diagnostics storage account ARM Id.", + "type": "string" + }, + "runAsAccountId": { + "description": "The run-as account Id.", + "type": "string" + }, + "processServerId": { + "description": "The process server Id.", + "type": "string" + }, + "multiVmGroupName": { + "description": "The multi VM group name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmEventDetails": { + "description": "Event details for InMageRcm provider.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "protectedItemName": { + "description": "The protected item name.", + "type": "string", + "readOnly": true + }, + "vmName": { + "description": "The protected item name.", + "type": "string", + "readOnly": true + }, + "latestAgentVersion": { + "description": "The latest agent version.", + "type": "string", + "readOnly": true + }, + "jobId": { + "description": "The job Id.", + "type": "string", + "readOnly": true + }, + "fabricName": { + "description": "The fabric name.", + "type": "string", + "readOnly": true + }, + "applianceName": { + "description": "The appliance name.", + "type": "string", + "readOnly": true + }, + "serverType": { + "description": "The server type.", + "type": "string", + "readOnly": true + }, + "componentDisplayName": { + "description": "The component display name.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmFabricCreationInput": { + "description": "InMageRcm fabric provider specific settings.", + "required": [ + "vmwareSiteId", + "physicalSiteId", + "sourceAgentIdentity" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificCreationInput" + } + ], + "properties": { + "vmwareSiteId": { + "description": "The ARM Id of the VMware site.", + "type": "string" + }, + "physicalSiteId": { + "description": "The ARM Id of the physical site.", + "type": "string" + }, + "sourceAgentIdentity": { + "$ref": "#/definitions/IdentityProviderInput", + "description": "The identity provider input for source agent authentication." + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmFabricSpecificDetails": { + "description": "InMageRcm fabric specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificDetails" + } + ], + "properties": { + "vmwareSiteId": { + "description": "The ARM Id of the VMware site.", + "type": "string", + "readOnly": true + }, + "physicalSiteId": { + "description": "The ARM Id of the physical site.", + "type": "string", + "readOnly": true + }, + "serviceEndpoint": { + "description": "The service endpoint.", + "type": "string", + "readOnly": true + }, + "serviceResourceId": { + "description": "The service resource Id.", + "type": "string", + "readOnly": true + }, + "serviceContainerId": { + "description": "The service container Id.", + "type": "string", + "readOnly": true + }, + "dataPlaneUri": { + "description": "The data plane Uri.", + "type": "string", + "readOnly": true + }, + "controlPlaneUri": { + "description": "The control plane Uri.", + "type": "string", + "readOnly": true + }, + "processServers": { + "description": "The list of process servers.", + "type": "array", + "items": { + "$ref": "#/definitions/ProcessServerDetails" + }, + "readOnly": true + }, + "rcmProxies": { + "description": "The list of RCM proxies.", + "type": "array", + "items": { + "$ref": "#/definitions/RcmProxyDetails" + }, + "readOnly": true + }, + "pushInstallers": { + "description": "The list of push installers.", + "type": "array", + "items": { + "$ref": "#/definitions/PushInstallerDetails" + }, + "readOnly": true + }, + "replicationAgents": { + "description": "The list of replication agents.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationAgentDetails" + }, + "readOnly": true + }, + "reprotectAgents": { + "description": "The list of reprotect agents.", + "type": "array", + "items": { + "$ref": "#/definitions/ReprotectAgentDetails" + }, + "readOnly": true + }, + "marsAgents": { + "description": "The list of Mars agents.", + "type": "array", + "items": { + "$ref": "#/definitions/MarsAgentDetails" + }, + "readOnly": true + }, + "dras": { + "description": "The list of DRAs.", + "type": "array", + "items": { + "$ref": "#/definitions/DraDetails" + }, + "readOnly": true + }, + "agentDetails": { + "description": "The list of agent details.", + "type": "array", + "items": { + "$ref": "#/definitions/AgentDetails" + }, + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmFailbackEventDetails": { + "description": "Event details for InMageRcmFailback provider.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "protectedItemName": { + "description": "The protected item name.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageRcmFailback" + }, + "InMageRcmFailbackMobilityAgentDetails": { + "description": "InMageRcmFailback mobility agent details.", + "type": "object", + "properties": { + "version": { + "description": "The agent version.", + "type": "string", + "readOnly": true + }, + "latestVersion": { + "description": "The latest agent version available.", + "type": "string", + "readOnly": true + }, + "driverVersion": { + "description": "The driver version.", + "type": "string", + "readOnly": true + }, + "latestUpgradableVersionWithoutReboot": { + "description": "The latest upgradeable version available without reboot.", + "type": "string", + "readOnly": true + }, + "agentVersionExpiryDate": { + "format": "date-time", + "description": "The agent version expiry date.", + "type": "string", + "readOnly": true + }, + "driverVersionExpiryDate": { + "format": "date-time", + "description": "The driver version expiry date.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The time of the last heartbeat received from the agent.", + "type": "string", + "readOnly": true + }, + "reasonsBlockingUpgrade": { + "description": "The whether update is possible or not.", + "type": "array", + "items": { + "enum": [ + "AlreadyOnLatestVersion", + "RebootRequired", + "AgentNoHeartbeat", + "RcmProxyNoHeartbeat", + "ProcessServerNoHeartbeat", + "IncompatibleApplianceVersion", + "NotProtected", + "UnsupportedProtectionScenario", + "DistroIsNotReported", + "DistroNotSupportedForUpgrade", + "MissingUpgradePath", + "InvalidAgentVersion", + "InvalidDriverVersion", + "Unknown" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentUpgradeBlockedReason", + "modelAsString": true + } + }, + "readOnly": true + }, + "isUpgradeable": { + "description": "A value indicating whether agent is upgradeable or not.", + "type": "string", + "readOnly": true + } + } + }, + "InMageRcmFailbackNicDetails": { + "description": "InMageRcmFailback NIC details.", + "type": "object", + "properties": { + "macAddress": { + "description": "The mac address.", + "type": "string", + "readOnly": true + }, + "networkName": { + "description": "The network name.", + "type": "string", + "readOnly": true + }, + "adapterType": { + "description": "The adapter type.", + "type": "string", + "readOnly": true + }, + "sourceIpAddress": { + "description": "The IP address.", + "type": "string", + "readOnly": true + } + } + }, + "InMageRcmFailbackPlannedFailoverProviderInput": { + "description": "Provider specific input for InMageRcmFailback failover.", + "required": [ + "recoveryPointType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PlannedFailoverProviderSpecificFailoverInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "ApplicationConsistent", + "CrashConsistent" + ], + "type": "string", + "x-ms-enum": { + "name": "InMageRcmFailbackRecoveryPointType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "InMageRcmFailback" + }, + "InMageRcmFailbackPolicyCreationInput": { + "description": "InMageRcmFailback policy creation input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency (in minutes).", + "type": "integer" + } + }, + "x-ms-discriminator-value": "InMageRcmFailback" + }, + "InMageRcmFailbackPolicyDetails": { + "description": "InMageRcm failback specific policy details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency in minutes.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency in minutes.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "InMageRcmFailback" + }, + "InMageRcmFailbackProtectedDiskDetails": { + "description": "InMageRcmFailback protected disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id (reported by source agent).", + "type": "string", + "readOnly": true + }, + "diskName": { + "description": "The disk name.", + "type": "string", + "readOnly": true + }, + "isOSDisk": { + "description": "A value indicating whether the disk is the OS disk.", + "type": "string", + "readOnly": true + }, + "capacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer", + "readOnly": true + }, + "diskUuid": { + "description": "The disk Uuid (reported by vCenter).", + "type": "string", + "readOnly": true + }, + "dataPendingInLogDataStoreInMB": { + "format": "double", + "description": "The data pending in log data store in MB.", + "type": "number", + "readOnly": true + }, + "dataPendingAtSourceAgentInMB": { + "format": "double", + "description": "The data pending at source agent in MB.", + "type": "number", + "readOnly": true + }, + "isInitialReplicationComplete": { + "description": "A value indicating whether initial replication is complete or not.", + "type": "string", + "readOnly": true + }, + "irDetails": { + "$ref": "#/definitions/InMageRcmFailbackSyncDetails", + "description": "The initial replication details." + }, + "resyncDetails": { + "$ref": "#/definitions/InMageRcmFailbackSyncDetails", + "description": "The resync details." + }, + "lastSyncTime": { + "format": "date-time", + "description": "The last sync time.", + "type": "string", + "readOnly": true + } + } + }, + "InMageRcmFailbackReplicationDetails": { + "description": "InMageRcmFailback provider specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "internalIdentifier": { + "description": "The virtual machine internal identifier.", + "type": "string", + "readOnly": true + }, + "azureVirtualMachineId": { + "description": "The ARM Id of the azure VM.", + "type": "string", + "readOnly": true + }, + "multiVmGroupName": { + "description": "The multi VM group name.", + "type": "string", + "readOnly": true + }, + "reprotectAgentId": { + "description": "The reprotect agent Id.", + "type": "string", + "readOnly": true + }, + "reprotectAgentName": { + "description": "The reprotect agent name.", + "type": "string", + "readOnly": true + }, + "osType": { + "description": "The type of the OS on the VM.", + "type": "string", + "readOnly": true + }, + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string", + "readOnly": true + }, + "targetvCenterId": { + "description": "The target vCenter Id.", + "type": "string", + "readOnly": true + }, + "targetDataStoreName": { + "description": "The target datastore name.", + "type": "string", + "readOnly": true + }, + "targetVmName": { + "description": "The target VM name.", + "type": "string", + "readOnly": true + }, + "initialReplicationProgressPercentage": { + "format": "int32", + "description": "The initial replication progress percentage.", + "type": "integer", + "readOnly": true + }, + "initialReplicationProcessedBytes": { + "format": "int64", + "description": "The initial replication processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM.", + "type": "integer", + "readOnly": true + }, + "initialReplicationTransferredBytes": { + "format": "int64", + "description": "The initial replication transferred bytes from source VM to target for all selected disks on source VM.", + "type": "integer", + "readOnly": true + }, + "initialReplicationProgressHealth": { + "description": "The initial replication progress health.", + "enum": [ + "None", + "InProgress", + "SlowProgress", + "NoProgress" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VmReplicationProgressHealth", + "modelAsString": true + } + }, + "resyncProgressPercentage": { + "format": "int32", + "description": "The resync progress percentage.", + "type": "integer", + "readOnly": true + }, + "resyncProcessedBytes": { + "format": "int64", + "description": "The resync processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM.", + "type": "integer", + "readOnly": true + }, + "resyncTransferredBytes": { + "format": "int64", + "description": "The resync transferred bytes from source VM to target for all selected disks on source VM.", + "type": "integer", + "readOnly": true + }, + "resyncProgressHealth": { + "description": "The resync progress health.", + "enum": [ + "None", + "InProgress", + "SlowProgress", + "NoProgress" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VmReplicationProgressHealth", + "modelAsString": true + } + }, + "resyncRequired": { + "description": "A value indicating whether resync is required.", + "type": "string", + "readOnly": true + }, + "resyncState": { + "description": "The resync state.", + "enum": [ + "None", + "PreparedForResynchronization", + "StartedResynchronization" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ResyncState", + "modelAsString": true + } + }, + "protectedDisks": { + "description": "The list of protected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmFailbackProtectedDiskDetails" + } + }, + "mobilityAgentDetails": { + "$ref": "#/definitions/InMageRcmFailbackMobilityAgentDetails", + "description": "The mobility agent information." + }, + "vmNics": { + "description": "The network details.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmFailbackNicDetails" + } + } + }, + "x-ms-discriminator-value": "InMageRcmFailback" + }, + "InMageRcmFailbackReprotectInput": { + "description": "InMageRcmFailback specific provider input.", + "required": [ + "processServerId", + "policyId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReverseReplicationProviderSpecificInput" + } + ], + "properties": { + "processServerId": { + "description": "The process server Id.", + "type": "string" + }, + "runAsAccountId": { + "description": "The run as account Id.", + "type": "string" + }, + "policyId": { + "description": "The Policy Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcmFailback" + }, + "InMageRcmFailbackSyncDetails": { + "description": "InMageRcmFailback disk level sync details.", + "type": "object", + "properties": { + "progressHealth": { + "description": "The progress health.", + "enum": [ + "None", + "InProgress", + "SlowProgress", + "NoProgress", + "Queued" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DiskReplicationProgressHealth", + "modelAsString": true + } + }, + "transferredBytes": { + "format": "int64", + "description": "The transferred bytes from source VM to azure for the disk.", + "type": "integer", + "readOnly": true + }, + "last15MinutesTransferredBytes": { + "format": "int64", + "description": "The bytes transferred in last 15 minutes from source VM to target.", + "type": "integer", + "readOnly": true + }, + "lastDataTransferTimeUtc": { + "description": "The time of the last data transfer from source VM to target.", + "type": "string", + "readOnly": true + }, + "processedBytes": { + "format": "int64", + "description": "The total processed bytes. This includes bytes that are transferred from source VM to target and matched bytes.", + "type": "integer", + "readOnly": true + }, + "startTime": { + "description": "The start time.", + "type": "string", + "readOnly": true + }, + "lastRefreshTime": { + "description": "The last refresh time.", + "type": "string", + "readOnly": true + }, + "progressPercentage": { + "format": "int32", + "description": "Progress in percentage. Progress percentage is calculated based on processed bytes.", + "type": "integer", + "readOnly": true + } + } + }, + "InMageRcmLastAgentUpgradeErrorDetails": { + "description": "InMageRcm last source agent upgrade error details.", + "type": "object", + "properties": { + "errorCode": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "errorMessage": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "possibleCauses": { + "description": "The possible causes.", + "type": "string", + "readOnly": true + }, + "recommendedAction": { + "description": "The recommended action.", + "type": "string", + "readOnly": true + }, + "errorMessageParameters": { + "description": "The error message parameters.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "errorTags": { + "description": "The error tags.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + } + }, + "InMageRcmMobilityAgentDetails": { + "description": "InMageRcm mobility agent details.", + "type": "object", + "properties": { + "version": { + "description": "The agent version.", + "type": "string", + "readOnly": true + }, + "latestVersion": { + "description": "The latest agent version available.", + "type": "string", + "readOnly": true + }, + "latestAgentReleaseDate": { + "description": "The latest agent version release date.", + "type": "string", + "readOnly": true + }, + "driverVersion": { + "description": "The driver version.", + "type": "string", + "readOnly": true + }, + "latestUpgradableVersionWithoutReboot": { + "description": "The latest upgradeable version available without reboot.", + "type": "string", + "readOnly": true + }, + "agentVersionExpiryDate": { + "format": "date-time", + "description": "The agent version expiry date.", + "type": "string", + "readOnly": true + }, + "driverVersionExpiryDate": { + "format": "date-time", + "description": "The driver version expiry date.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The time of the last heartbeat received from the agent.", + "type": "string", + "readOnly": true + }, + "reasonsBlockingUpgrade": { + "description": "The whether update is possible or not.", + "type": "array", + "items": { + "enum": [ + "AlreadyOnLatestVersion", + "RebootRequired", + "AgentNoHeartbeat", + "RcmProxyNoHeartbeat", + "ProcessServerNoHeartbeat", + "IncompatibleApplianceVersion", + "NotProtected", + "UnsupportedProtectionScenario", + "DistroIsNotReported", + "DistroNotSupportedForUpgrade", + "MissingUpgradePath", + "InvalidAgentVersion", + "InvalidDriverVersion", + "Unknown" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentUpgradeBlockedReason", + "modelAsString": true + } + }, + "readOnly": true + }, + "isUpgradeable": { + "description": "A value indicating whether agent is upgradeable or not.", + "type": "string", + "readOnly": true + } + } + }, + "InMageRcmNicDetails": { + "description": "InMageRcm NIC details.", + "type": "object", + "properties": { + "nicId": { + "description": "The NIC Id.", + "type": "string", + "readOnly": true + }, + "isPrimaryNic": { + "description": "A value indicating whether this is the primary NIC.", + "type": "string" + }, + "isSelectedForFailover": { + "description": "A value indicating whether this NIC is selected for failover.", + "type": "string" + }, + "sourceIPAddress": { + "description": "The source IP address.", + "type": "string", + "readOnly": true + }, + "sourceIPAddressType": { + "description": "The source IP address type.", + "enum": [ + "Dynamic", + "Static" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "EthernetAddressType", + "modelAsString": true + } + }, + "sourceNetworkId": { + "description": "Source network Id.", + "type": "string", + "readOnly": true + }, + "sourceSubnetName": { + "description": "Source subnet name.", + "type": "string", + "readOnly": true + }, + "targetIPAddress": { + "description": "The target IP address.", + "type": "string" + }, + "targetIPAddressType": { + "description": "The target IP address type.", + "enum": [ + "Dynamic", + "Static" + ], + "type": "string", + "x-ms-enum": { + "name": "EthernetAddressType", + "modelAsString": true + } + }, + "targetSubnetName": { + "description": "Target subnet name.", + "type": "string" + }, + "testSubnetName": { + "description": "Test subnet name.", + "type": "string" + }, + "testIPAddress": { + "description": "The test IP address.", + "type": "string" + }, + "testIPAddressType": { + "description": "The test IP address type.", + "enum": [ + "Dynamic", + "Static" + ], + "type": "string", + "x-ms-enum": { + "name": "EthernetAddressType", + "modelAsString": true + } + } + } + }, + "InMageRcmNicInput": { + "description": "InMageRcm NIC input.", + "required": [ + "nicId", + "isPrimaryNic" + ], + "type": "object", + "properties": { + "nicId": { + "description": "The NIC Id.", + "type": "string" + }, + "isPrimaryNic": { + "description": "A value indicating whether this is the primary NIC.", + "type": "string" + }, + "isSelectedForFailover": { + "description": "A value indicating whether this NIC is selected for failover.", + "type": "string" + }, + "targetSubnetName": { + "description": "Target subnet name.", + "type": "string" + }, + "targetStaticIPAddress": { + "description": "The target static IP address.", + "type": "string" + }, + "testSubnetName": { + "description": "The test subnet name.", + "type": "string" + }, + "testStaticIPAddress": { + "description": "The test static IP address.", + "type": "string" + } + } + }, + "InMageRcmPolicyCreationInput": { + "description": "InMageRcm policy creation input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "recoveryPointHistoryInMinutes": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "enableMultiVmSync": { + "description": "A value indicating whether multi-VM sync has to be enabled.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmPolicyDetails": { + "description": "InMageRcm specific policy details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPointHistoryInMinutes": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency in minutes.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency in minutes.", + "type": "integer" + }, + "enableMultiVmSync": { + "description": "A value indicating whether multi-VM sync has to be enabled.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmProtectedDiskDetails": { + "description": "InMageRcm protected disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string", + "readOnly": true + }, + "diskName": { + "description": "The disk name.", + "type": "string", + "readOnly": true + }, + "isOSDisk": { + "description": "A value indicating whether the disk is the OS disk.", + "type": "string", + "readOnly": true + }, + "capacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer", + "readOnly": true + }, + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string", + "readOnly": true + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM Id.", + "type": "string", + "readOnly": true + }, + "seedManagedDiskId": { + "description": "The ARM Id of the seed managed disk.", + "type": "string", + "readOnly": true + }, + "targetManagedDiskId": { + "description": "The ARM Id of the target managed disk.", + "type": "string", + "readOnly": true + }, + "diskType": { + "description": "The disk type.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + }, + "dataPendingInLogDataStoreInMB": { + "format": "double", + "description": "The data pending in log data store in MB.", + "type": "number", + "readOnly": true + }, + "dataPendingAtSourceAgentInMB": { + "format": "double", + "description": "The data pending at source agent in MB.", + "type": "number", + "readOnly": true + }, + "isInitialReplicationComplete": { + "description": "A value indicating whether initial replication is complete or not.", + "type": "string", + "readOnly": true + }, + "irDetails": { + "$ref": "#/definitions/InMageRcmSyncDetails", + "description": "The initial replication details." + }, + "resyncDetails": { + "$ref": "#/definitions/InMageRcmSyncDetails", + "description": "The resync details." + } + } + }, + "InMageRcmProtectionContainerMappingDetails": { + "description": "InMageRcm provider specific container mapping details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionContainerMappingProviderSpecificDetails" + } + ], + "properties": { + "enableAgentAutoUpgrade": { + "description": "A value indicating whether the flag for enable agent auto upgrade.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmRecoveryPointDetails": { + "description": "InMageRcm provider specific recovery point details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProviderSpecificRecoveryPointDetails" + } + ], + "properties": { + "isMultiVmSyncPoint": { + "description": "A value indicating whether the recovery point is multi VM consistent.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmReplicationDetails": { + "description": "InMageRcm provider specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "internalIdentifier": { + "description": "The virtual machine internal identifier.", + "type": "string", + "readOnly": true + }, + "fabricDiscoveryMachineId": { + "description": "The ARM Id of the discovered VM.", + "type": "string", + "readOnly": true + }, + "multiVmGroupName": { + "description": "The multi VM group name.", + "type": "string", + "readOnly": true + }, + "discoveryType": { + "description": "The type of the discovered VM.", + "type": "string", + "readOnly": true + }, + "processServerId": { + "description": "The process server Id.", + "type": "string", + "readOnly": true + }, + "processorCoreCount": { + "format": "int32", + "description": "The processor core count.", + "type": "integer", + "readOnly": true + }, + "allocatedMemoryInMB": { + "format": "double", + "description": "The allocated memory in MB.", + "type": "number", + "readOnly": true + }, + "processServerName": { + "description": "The process server name.", + "type": "string", + "readOnly": true + }, + "runAsAccountId": { + "description": "The run-as account Id.", + "type": "string", + "readOnly": true + }, + "osType": { + "description": "The type of the OS on the VM.", + "type": "string", + "readOnly": true + }, + "firmwareType": { + "description": "The firmware type.", + "type": "string", + "readOnly": true + }, + "primaryNicIpAddress": { + "description": "The IP address of the primary network interface.", + "type": "string", + "readOnly": true + }, + "targetGeneration": { + "description": "The target generation.", + "type": "string", + "readOnly": true + }, + "licenseType": { + "description": "License Type of the VM to be used.", + "type": "string" + }, + "targetVmName": { + "description": "Target VM name.", + "type": "string" + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "targetResourceGroupId": { + "description": "The target resource group Id.", + "type": "string" + }, + "targetLocation": { + "description": "The target location.", + "type": "string" + }, + "targetAvailabilitySetId": { + "description": "The target availability set Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "targetBootDiagnosticsStorageAccountId": { + "description": "The target boot diagnostics storage account ARM Id.", + "type": "string" + }, + "targetNetworkId": { + "description": "The target network Id.", + "type": "string" + }, + "testNetworkId": { + "description": "The test network Id.", + "type": "string" + }, + "failoverRecoveryPointId": { + "description": "The recovery point Id to which the VM was failed over.", + "type": "string", + "readOnly": true + }, + "lastRecoveryPointReceived": { + "format": "date-time", + "description": "The last recovery point received time.", + "type": "string", + "readOnly": true + }, + "lastRpoInSeconds": { + "format": "int64", + "description": "The last recovery point objective value.", + "type": "integer", + "readOnly": true + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The last recovery point objective calculated time.", + "type": "string", + "readOnly": true + }, + "lastRecoveryPointId": { + "description": "The last recovery point Id.", + "type": "string", + "readOnly": true + }, + "initialReplicationProgressPercentage": { + "format": "int32", + "description": "The initial replication progress percentage. This is calculated based on total bytes processed for all disks in the source VM.", + "type": "integer", + "readOnly": true + }, + "initialReplicationProcessedBytes": { + "format": "int64", + "description": "The initial replication processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM.", + "type": "integer", + "readOnly": true + }, + "initialReplicationTransferredBytes": { + "format": "int64", + "description": "The initial replication transferred bytes from source VM to azure for all selected disks on source VM.", + "type": "integer", + "readOnly": true + }, + "initialReplicationProgressHealth": { + "description": "The initial replication progress health.", + "enum": [ + "None", + "InProgress", + "SlowProgress", + "NoProgress" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VmReplicationProgressHealth", + "modelAsString": true + } + }, + "resyncProgressPercentage": { + "format": "int32", + "description": "The resync progress percentage. This is calculated based on total bytes processed for all disks in the source VM.", + "type": "integer", + "readOnly": true + }, + "resyncProcessedBytes": { + "format": "int64", + "description": "The resync processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM.", + "type": "integer", + "readOnly": true + }, + "resyncTransferredBytes": { + "format": "int64", + "description": "The resync transferred bytes from source VM to azure for all selected disks on source VM.", + "type": "integer", + "readOnly": true + }, + "resyncProgressHealth": { + "description": "The resync progress health.", + "enum": [ + "None", + "InProgress", + "SlowProgress", + "NoProgress" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VmReplicationProgressHealth", + "modelAsString": true + } + }, + "resyncRequired": { + "description": "A value indicating whether resync is required.", + "type": "string", + "readOnly": true + }, + "resyncState": { + "description": "The resync state.", + "enum": [ + "None", + "PreparedForResynchronization", + "StartedResynchronization" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ResyncState", + "modelAsString": true + } + }, + "agentUpgradeState": { + "description": "The agent auto upgrade state.", + "enum": [ + "None", + "Started", + "Completed", + "Commit" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MobilityAgentUpgradeState", + "modelAsString": true + } + }, + "lastAgentUpgradeType": { + "description": "The last agent upgrade type.", + "type": "string", + "readOnly": true + }, + "agentUpgradeJobId": { + "description": "The agent upgrade job Id.", + "type": "string", + "readOnly": true + }, + "agentUpgradeAttemptToVersion": { + "description": "The agent version to which last agent upgrade was attempted.", + "type": "string", + "readOnly": true + }, + "protectedDisks": { + "description": "The list of protected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmProtectedDiskDetails" + } + }, + "isLastUpgradeSuccessful": { + "description": "A value indicating whether last agent upgrade was successful or not.", + "type": "string", + "readOnly": true + }, + "mobilityAgentDetails": { + "$ref": "#/definitions/InMageRcmMobilityAgentDetails", + "description": "The mobility agent information." + }, + "lastAgentUpgradeErrorDetails": { + "description": "The last agent upgrade error information.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmLastAgentUpgradeErrorDetails" + } + }, + "agentUpgradeBlockingErrorDetails": { + "description": "The agent upgrade blocking error information.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmAgentUpgradeBlockingErrorDetails" + } + }, + "vmNics": { + "description": "The network details.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmNicDetails" + } + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmReprotectInput": { + "description": "InMageRcm specific provider input.", + "required": [ + "reprotectAgentId", + "datastoreName", + "logStorageAccountId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReverseReplicationProviderSpecificInput" + } + ], + "properties": { + "reprotectAgentId": { + "description": "The reprotect agent Id.", + "type": "string" + }, + "datastoreName": { + "description": "The target datastore name.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string" + }, + "policyId": { + "description": "The Policy Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmSyncDetails": { + "description": "InMageRcm disk level sync details.", + "type": "object", + "properties": { + "progressHealth": { + "description": "The progress health.", + "enum": [ + "None", + "InProgress", + "SlowProgress", + "NoProgress", + "Queued" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DiskReplicationProgressHealth", + "modelAsString": true + } + }, + "transferredBytes": { + "format": "int64", + "description": "The transferred bytes from source VM to azure for the disk.", + "type": "integer", + "readOnly": true + }, + "last15MinutesTransferredBytes": { + "format": "int64", + "description": "The bytes transferred in last 15 minutes from source VM to azure.", + "type": "integer", + "readOnly": true + }, + "lastDataTransferTimeUtc": { + "description": "The time of the last data transfer from source VM to azure.", + "type": "string", + "readOnly": true + }, + "processedBytes": { + "format": "int64", + "description": "The total processed bytes. This includes bytes that are transferred from source VM to azure and matched bytes.", + "type": "integer", + "readOnly": true + }, + "startTime": { + "description": "The start time.", + "type": "string", + "readOnly": true + }, + "lastRefreshTime": { + "description": "The last refresh time.", + "type": "string", + "readOnly": true + }, + "progressPercentage": { + "format": "int32", + "description": "Progress in percentage. Progress percentage is calculated based on processed bytes.", + "type": "integer", + "readOnly": true + } + } + }, + "InMageRcmTestFailoverInput": { + "description": "InMageRcm provider specific input for test failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TestFailoverProviderSpecificInput" + } + ], + "properties": { + "networkId": { + "description": "The test network Id.", + "type": "string" + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to test failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmUnplannedFailoverInput": { + "description": "InMageRcm provider specific input for unplanned failover.", + "required": [ + "performShutdown" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput" + } + ], + "properties": { + "performShutdown": { + "description": "A value indicating whether VM is to be shutdown.", + "type": "string" + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmUpdateContainerMappingInput": { + "description": "InMageRcm update protection container mapping.", + "required": [ + "enableAgentAutoUpgrade" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificUpdateContainerMappingInput" + } + ], + "properties": { + "enableAgentAutoUpgrade": { + "description": "A value indicating whether agent auto upgrade has to be enabled.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmUpdateReplicationProtectedItemInput": { + "description": "InMageRcm provider specific input to update replication protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UpdateReplicationProtectedItemProviderInput" + } + ], + "properties": { + "targetVmName": { + "description": "The target VM name.", + "type": "string" + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "targetResourceGroupId": { + "description": "The target resource group ARM Id.", + "type": "string" + }, + "targetAvailabilitySetId": { + "description": "The target availability set ARM Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "targetBootDiagnosticsStorageAccountId": { + "description": "The target boot diagnostics storage account ARM Id.", + "type": "string" + }, + "targetNetworkId": { + "description": "The target network ARM Id.", + "type": "string" + }, + "testNetworkId": { + "description": "The test network ARM Id.", + "type": "string" + }, + "vmNics": { + "description": "The list of NIC details.", + "minLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmNicInput" + } + }, + "licenseType": { + "description": "The license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageReplicationDetails": { + "description": "InMage provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "activeSiteType": { + "description": "The active location of the VM. If the VM is being protected from Azure, this field will take values from { Azure, OnPrem }. If the VM is being protected between two data-centers, this field will be OnPrem always.", + "type": "string" + }, + "sourceVmCpuCount": { + "format": "int32", + "description": "The CPU count of the VM on the primary side.", + "type": "integer" + }, + "sourceVmRamSizeInMB": { + "format": "int32", + "description": "The RAM size of the VM on the primary side.", + "type": "integer" + }, + "osDetails": { + "$ref": "#/definitions/OSDiskDetails", + "description": "The OS details." + }, + "protectionStage": { + "description": "The protection stage.", + "type": "string" + }, + "vmId": { + "description": "The virtual machine Id.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "resyncDetails": { + "$ref": "#/definitions/InitialReplicationDetails", + "description": "The resync details of the machine." + }, + "retentionWindowStart": { + "format": "date-time", + "description": "The retention window start time.", + "type": "string" + }, + "retentionWindowEnd": { + "format": "date-time", + "description": "The retention window end time.", + "type": "string" + }, + "compressedDataRateInMB": { + "format": "double", + "description": "The compressed data change rate in MB.", + "type": "number" + }, + "uncompressedDataRateInMB": { + "format": "double", + "description": "The uncompressed data change rate in MB.", + "type": "number" + }, + "rpoInSeconds": { + "format": "int64", + "description": "The RPO in seconds.", + "type": "integer" + }, + "protectedDisks": { + "description": "The list of protected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageProtectedDiskDetails" + } + }, + "ipAddress": { + "description": "The source IP address.", + "type": "string" + }, + "lastHeartbeat": { + "format": "date-time", + "description": "The last heartbeat received from the source server.", + "type": "string" + }, + "processServerId": { + "description": "The process server Id.", + "type": "string" + }, + "masterTargetId": { + "description": "The master target Id.", + "type": "string" + }, + "consistencyPoints": { + "description": "The collection of Consistency points.", + "type": "object", + "additionalProperties": { + "format": "date-time", + "type": "string" + } + }, + "diskResized": { + "description": "A value indicating whether any disk is resized for this VM.", + "type": "string" + }, + "rebootAfterUpdateStatus": { + "description": "A value indicating whether the source server requires a restart after update.", + "type": "string" + }, + "multiVmGroupId": { + "description": "The multi vm group Id, if any.", + "type": "string" + }, + "multiVmGroupName": { + "description": "The multi vm group name, if any.", + "type": "string" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether the multi vm sync is enabled or disabled.", + "type": "string" + }, + "agentDetails": { + "$ref": "#/definitions/InMageAgentDetails", + "description": "The agent details." + }, + "vCenterInfrastructureId": { + "description": "The vCenter infrastructure Id.", + "type": "string" + }, + "infrastructureVmId": { + "description": "The infrastructure VM Id.", + "type": "string" + }, + "vmNics": { + "description": "The PE Network details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicDetails" + } + }, + "discoveryType": { + "description": "A value indicating the discovery type of the machine.", + "type": "string" + }, + "azureStorageAccountId": { + "description": "A value indicating the underlying Azure storage account. If the VM is not running in Azure, this value shall be set to null.", + "type": "string" + }, + "datastores": { + "description": "The datastores of the on-premise machine Value can be list of strings that contain datastore names.", + "type": "array", + "items": { + "type": "string" + } + }, + "validationErrors": { + "description": "The validation errors of the on-premise machine Value can be list of validation errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The last RPO calculated time.", + "type": "string" + }, + "lastUpdateReceivedTime": { + "format": "date-time", + "description": "The last update time received from on-prem components.", + "type": "string" + }, + "replicaId": { + "description": "The replica id of the protected item.", + "type": "string" + }, + "osVersion": { + "description": "The OS Version of the protected item.", + "type": "string" + }, + "isAdditionalStatsAvailable": { + "description": "A value indicating whether additional IR stats are available or not.", + "type": "boolean" + }, + "totalDataTransferred": { + "format": "int64", + "description": "The total transferred data in bytes.", + "type": "integer" + }, + "totalProgressHealth": { + "description": "The progress health.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMageReprotectInput": { + "description": "InMageAzureV2 specific provider input.", + "required": [ + "masterTargetId", + "processServerId", + "retentionDrive", + "profileId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReverseReplicationProviderSpecificInput" + } + ], + "properties": { + "masterTargetId": { + "description": "The Master Target Id.", + "type": "string" + }, + "processServerId": { + "description": "The Process Server Id.", + "type": "string" + }, + "retentionDrive": { + "description": "The retention drive to use on the MT.", + "type": "string" + }, + "runAsAccountId": { + "description": "The CS account Id.", + "type": "string" + }, + "datastoreName": { + "description": "The target datastore name.", + "type": "string" + }, + "diskExclusionInput": { + "$ref": "#/definitions/InMageDiskExclusionInput", + "description": "The enable disk exclusion input." + }, + "profileId": { + "description": "The Policy Id.", + "type": "string" + }, + "disksToInclude": { + "description": "The disks to include list.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMageTestFailoverInput": { + "description": "Provider specific input for InMage test failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TestFailoverProviderSpecificInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type. Values from LatestTime, LatestTag or Custom. In the case of custom, the recovery point provided by RecoveryPointId will be used. In the other two cases, recovery point id will be ignored.", + "enum": [ + "LatestTime", + "LatestTag", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPointType", + "modelAsString": true + } + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to test failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMageUnplannedFailoverInput": { + "description": "Provider specific input for InMage unplanned failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type. Values from LatestTime, LatestTag or Custom. In the case of custom, the recovery point provided by RecoveryPointId will be used. In the other two cases, recovery point id will be ignored.", + "enum": [ + "LatestTime", + "LatestTag", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPointType", + "modelAsString": true + } + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMageVolumeExclusionOptions": { + "description": "Guest disk signature based disk exclusion option when doing enable protection of virtual machine in InMage provider.", + "type": "object", + "properties": { + "volumeLabel": { + "description": "The volume label. The disk having any volume with this label will be excluded from replication.", + "type": "string" + }, + "onlyExcludeIfSingleVolume": { + "description": "The value indicating whether to exclude multi volume disk or not. If a disk has multiple volumes and one of the volume has label matching with VolumeLabel this disk will be excluded from replication if OnlyExcludeIfSingleVolume is false.", + "type": "string" + } + } + }, + "InnerHealthError": { + "description": "Implements InnerHealthError class. HealthError object has a list of InnerHealthErrors as child errors. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException.", + "type": "object", + "properties": { + "errorSource": { + "description": "Source of error.", + "type": "string" + }, + "errorType": { + "description": "Type of error.", + "type": "string" + }, + "errorLevel": { + "description": "Level of error.", + "type": "string" + }, + "errorCategory": { + "description": "Category of error.", + "type": "string" + }, + "errorCode": { + "description": "Error code.", + "type": "string" + }, + "summaryMessage": { + "description": "Summary message of the entity.", + "type": "string" + }, + "errorMessage": { + "description": "Error message.", + "type": "string" + }, + "possibleCauses": { + "description": "Possible causes of error.", + "type": "string" + }, + "recommendedAction": { + "description": "Recommended action to resolve error.", + "type": "string" + }, + "creationTimeUtc": { + "format": "date-time", + "description": "Error creation time (UTC).", + "type": "string" + }, + "recoveryProviderErrorMessage": { + "description": "DRA error message.", + "type": "string" + }, + "entityId": { + "description": "ID of the entity.", + "type": "string" + }, + "errorId": { + "description": "The health error unique id.", + "type": "string" + }, + "customerResolvability": { + "description": "Value indicating whether the health error is customer resolvable.", + "enum": [ + "Allowed", + "NotAllowed" + ], + "type": "string", + "x-ms-enum": { + "name": "HealthErrorCustomerResolvability", + "modelAsString": true + } + } + } + }, + "InputEndpoint": { + "type": "object", + "properties": { + "endpointName": { + "type": "string" + }, + "privatePort": { + "format": "int32", + "type": "integer" + }, + "publicPort": { + "format": "int32", + "type": "integer" + }, + "protocol": { + "type": "string" + } + } + }, + "Job": { + "description": "Job details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "The custom data." + } + } + }, + "JobCollection": { + "description": "Collection of jobs.", + "type": "object", + "properties": { + "value": { + "description": "The list of jobs.", + "type": "array", + "items": { + "$ref": "#/definitions/Job" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "JobDetails": { + "description": "Job details based on specific job type.", + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the type of job details (see JobDetailsTypes enum for possible values).", + "type": "string", + "readOnly": true + }, + "affectedObjectDetails": { + "description": "The affected object properties like source server, source cloud, target server, target cloud etc. based on the workflow object details.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "discriminator": "instanceType" + }, + "JobEntity": { + "description": "This class contains the minimal job details required to navigate to the desired drill down.", + "type": "object", + "properties": { + "jobId": { + "description": "The job id.", + "type": "string" + }, + "jobFriendlyName": { + "description": "The job display name.", + "type": "string" + }, + "targetObjectId": { + "description": "The object id.", + "type": "string" + }, + "targetObjectName": { + "description": "The object name.", + "type": "string" + }, + "targetInstanceType": { + "description": "The workflow affected object type.", + "type": "string" + }, + "jobScenarioName": { + "description": "The job name. Enum type ScenarioName.", + "type": "string" + } + } + }, + "JobErrorDetails": { + "description": "This class contains the error details per object.", + "type": "object", + "properties": { + "serviceErrorDetails": { + "$ref": "#/definitions/ServiceError", + "description": "The Service error details." + }, + "providerErrorDetails": { + "$ref": "#/definitions/ProviderError", + "description": "The Provider error details." + }, + "errorLevel": { + "description": "Error level of error.", + "type": "string" + }, + "creationTime": { + "format": "date-time", + "description": "The creation time of job error.", + "type": "string" + }, + "taskId": { + "description": "The Id of the task.", + "type": "string" + } + } + }, + "JobProperties": { + "description": "Job custom data details.", + "type": "object", + "properties": { + "activityId": { + "description": "The activity id.", + "type": "string" + }, + "scenarioName": { + "description": "The ScenarioName.", + "type": "string" + }, + "friendlyName": { + "description": "The DisplayName.", + "type": "string" + }, + "state": { + "description": "The status of the Job. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other.", + "type": "string" + }, + "stateDescription": { + "description": "The description of the state of the Job. For e.g. - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped.", + "type": "string" + }, + "tasks": { + "description": "The tasks.", + "type": "array", + "items": { + "$ref": "#/definitions/ASRTask" + } + }, + "errors": { + "description": "The errors.", + "type": "array", + "items": { + "$ref": "#/definitions/JobErrorDetails" + } + }, + "startTime": { + "format": "date-time", + "description": "The start time.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "The end time.", + "type": "string" + }, + "allowedActions": { + "description": "The Allowed action the job.", + "type": "array", + "items": { + "type": "string" + } + }, + "targetObjectId": { + "description": "The affected Object Id.", + "type": "string" + }, + "targetObjectName": { + "description": "The name of the affected object.", + "type": "string" + }, + "targetInstanceType": { + "description": "The type of the affected object which is of Microsoft.Azure.SiteRecovery.V2015_11_10.AffectedObjectType class.", + "type": "string" + }, + "customDetails": { + "$ref": "#/definitions/JobDetails", + "description": "The custom job details like test failover job details." + } + } + }, + "JobQueryParameter": { + "description": "Query parameter to enumerate jobs.", + "type": "object", + "properties": { + "startTime": { + "description": "Date time to get jobs from.", + "type": "string" + }, + "endTime": { + "description": "Date time to get jobs upto.", + "type": "string" + }, + "fabricId": { + "description": "The Id of the fabric to search jobs under.", + "type": "string" + }, + "affectedObjectTypes": { + "description": "The type of objects.", + "type": "string" + }, + "jobStatus": { + "description": "The states of the job to be filtered can be in.", + "type": "string" + }, + "jobOutputType": { + "description": "The output type of the jobs.", + "enum": [ + "Json", + "Xml", + "Excel" + ], + "type": "string", + "x-ms-enum": { + "name": "ExportJobOutputSerializationType", + "modelAsString": true + } + }, + "jobName": { + "description": "The job Name.", + "type": "string" + }, + "timezoneOffset": { + "format": "double", + "description": "The timezone offset for the location of the request (in minutes).", + "type": "number" + } + } + }, + "JobStatusEventDetails": { + "description": "Model class for event details of a job status event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventSpecificDetails" + } + ], + "properties": { + "jobId": { + "description": "Job arm id for the event.", + "type": "string" + }, + "jobFriendlyName": { + "description": "JobName for the Event.", + "type": "string" + }, + "jobStatus": { + "description": "JobStatus for the Event.", + "type": "string" + }, + "affectedObjectType": { + "description": "AffectedObjectType for the event.", + "type": "string" + } + }, + "x-ms-discriminator-value": "JobStatus" + }, + "JobTaskDetails": { + "description": "This class represents a task which is actually a workflow so that one can navigate to its individual drill down.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskTypeDetails" + } + ], + "properties": { + "jobTask": { + "$ref": "#/definitions/JobEntity", + "description": "The job entity." + } + }, + "discriminator": "instanceType", + "x-ms-discriminator-value": "JobTaskDetails" + }, + "KeyEncryptionKeyInfo": { + "description": "Key Encryption Key (KEK) information.", + "type": "object", + "properties": { + "keyIdentifier": { + "description": "The key URL / identifier.", + "type": "string" + }, + "keyVaultResourceArmId": { + "description": "The KeyVault resource ARM Id for key.", + "type": "string" + } + } + }, + "LogicalNetwork": { + "description": "Logical network data model.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/LogicalNetworkProperties", + "description": "The Logical Network Properties." + } + } + }, + "LogicalNetworkCollection": { + "description": "List of logical networks.", + "type": "object", + "properties": { + "value": { + "description": "The Logical Networks list details.", + "type": "array", + "items": { + "$ref": "#/definitions/LogicalNetwork" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "LogicalNetworkProperties": { + "description": "Logical Network Properties.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The Friendly Name.", + "type": "string" + }, + "networkVirtualizationStatus": { + "description": "A value indicating whether Network Virtualization is enabled for the logical network.", + "type": "string" + }, + "logicalNetworkUsage": { + "description": "A value indicating whether logical network is used as private test network by test failover.", + "type": "string" + }, + "logicalNetworkDefinitionsStatus": { + "description": "A value indicating whether logical network definitions are isolated.", + "type": "string" + } + } + }, + "ManualActionTaskDetails": { + "description": "This class represents the manual action task details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskTypeDetails" + } + ], + "properties": { + "name": { + "description": "The name.", + "type": "string" + }, + "instructions": { + "description": "The instructions.", + "type": "string" + }, + "observation": { + "description": "The observation.", + "type": "string" + } + }, + "x-ms-discriminator-value": "ManualActionTaskDetails" + }, + "MarsAgentDetails": { + "description": "Mars agent details.", + "type": "object", + "properties": { + "id": { + "description": "The Mars agent Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The Mars agent name.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The Mars agent Bios Id.", + "type": "string", + "readOnly": true + }, + "fabricObjectId": { + "description": "The fabric object Id.", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "The Mars agent Fqdn.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the Mars agent.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The health of the Mars agent.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + } + } + }, + "MasterTargetServer": { + "description": "Details of a Master Target Server.", + "type": "object", + "properties": { + "id": { + "description": "The server Id.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address of the server.", + "type": "string" + }, + "name": { + "description": "The server name.", + "type": "string" + }, + "osType": { + "description": "The OS type of the server.", + "type": "string" + }, + "agentVersion": { + "description": "The version of the scout component on the server.", + "type": "string" + }, + "lastHeartbeat": { + "format": "date-time", + "description": "The last heartbeat received from the server.", + "type": "string" + }, + "versionStatus": { + "description": "Version status.", + "type": "string" + }, + "retentionVolumes": { + "description": "The retention volumes of Master target Server.", + "type": "array", + "items": { + "$ref": "#/definitions/RetentionVolume" + } + }, + "dataStores": { + "description": "The list of data stores in the fabric.", + "type": "array", + "items": { + "$ref": "#/definitions/DataStore" + } + }, + "validationErrors": { + "description": "Validation errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "healthErrors": { + "description": "Health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "diskCount": { + "format": "int32", + "description": "Disk count of the master target.", + "type": "integer" + }, + "osVersion": { + "description": "OS Version of the master target.", + "type": "string" + }, + "agentExpiryDate": { + "format": "date-time", + "description": "Agent expiry date.", + "type": "string" + }, + "marsAgentVersion": { + "description": "MARS agent version.", + "type": "string" + }, + "marsAgentExpiryDate": { + "format": "date-time", + "description": "MARS agent expiry date.", + "type": "string" + }, + "agentVersionDetails": { + "$ref": "#/definitions/VersionDetails", + "description": "Agent version details." + }, + "marsAgentVersionDetails": { + "$ref": "#/definitions/VersionDetails", + "description": "Mars agent version details." + } + } + }, + "MigrateInput": { + "description": "Input for migrate.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/MigrateInputProperties", + "description": "Migrate input properties." + } + } + }, + "MigrateInputProperties": { + "description": "Migrate input properties.", + "required": [ + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/MigrateProviderSpecificInput", + "description": "The provider specific details." + } + } + }, + "MigrateProviderSpecificInput": { + "description": "Migrate provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "MigrationItem": { + "description": "Migration item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MigrationItemProperties", + "description": "The migration item properties." + } + } + }, + "MigrationItemCollection": { + "description": "Migration item collection.", + "type": "object", + "properties": { + "value": { + "description": "The list of migration items.", + "type": "array", + "items": { + "$ref": "#/definitions/MigrationItem" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "MigrationItemProperties": { + "description": "Migration item properties.", + "type": "object", + "properties": { + "machineName": { + "description": "The on-premise virtual machine name.", + "type": "string", + "readOnly": true + }, + "policyId": { + "description": "The ARM Id of policy governing this item.", + "type": "string", + "readOnly": true + }, + "policyFriendlyName": { + "description": "The name of policy governing this item.", + "type": "string", + "readOnly": true + }, + "migrationState": { + "description": "The migration status.", + "enum": [ + "None", + "EnableMigrationInProgress", + "EnableMigrationFailed", + "DisableMigrationInProgress", + "DisableMigrationFailed", + "InitialSeedingInProgress", + "InitialSeedingFailed", + "Replicating", + "MigrationInProgress", + "MigrationSucceeded", + "MigrationFailed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MigrationState", + "modelAsString": true + } + }, + "migrationStateDescription": { + "description": "The migration state description.", + "type": "string", + "readOnly": true + }, + "lastTestMigrationTime": { + "format": "date-time", + "description": "The last test migration time.", + "type": "string", + "readOnly": true + }, + "lastTestMigrationStatus": { + "description": "The status of the last test migration.", + "type": "string", + "readOnly": true + }, + "testMigrateState": { + "description": "The test migrate state.", + "enum": [ + "None", + "TestMigrationInProgress", + "TestMigrationSucceeded", + "TestMigrationFailed", + "TestMigrationCleanupInProgress" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "TestMigrationState", + "modelAsString": true + } + }, + "testMigrateStateDescription": { + "description": "The test migrate state description.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The consolidated health.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The list of health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + }, + "allowedOperations": { + "description": "The allowed operations on the migration item based on the current migration state of the item.", + "type": "array", + "items": { + "enum": [ + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup", + "Migrate", + "StartResync" + ], + "type": "string", + "x-ms-enum": { + "name": "MigrationItemOperation", + "modelAsString": true + } + }, + "readOnly": true + }, + "currentJob": { + "$ref": "#/definitions/CurrentJobDetails", + "description": "The current job details.", + "readOnly": true + }, + "eventCorrelationId": { + "description": "The correlation Id for events associated with this migration item.", + "type": "string", + "readOnly": true + }, + "providerSpecificDetails": { + "$ref": "#/definitions/MigrationProviderSpecificSettings", + "description": "The migration provider custom settings." + } + } + }, + "MigrationItemsQueryParameter": { + "description": "Query parameter to enumerate migration items.", + "type": "object", + "properties": { + "sourceFabricName": { + "description": "The source fabric name filter.", + "type": "string" + }, + "sourceContainerName": { + "description": "The source container name filter.", + "type": "string" + }, + "instanceType": { + "description": "The replication provider type.", + "type": "string" + } + } + }, + "MigrationProviderSpecificSettings": { + "description": "Migration provider specific settings.", + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the instance type.", + "type": "string", + "readOnly": true + } + }, + "discriminator": "instanceType" + }, + "MigrationRecoveryPoint": { + "description": "Recovery point for a migration item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MigrationRecoveryPointProperties", + "description": "Recovery point properties." + } + } + }, + "MigrationRecoveryPointCollection": { + "description": "Collection of migration recovery points.", + "type": "object", + "properties": { + "value": { + "description": "The migration recovery point details.", + "type": "array", + "items": { + "$ref": "#/definitions/MigrationRecoveryPoint" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "MigrationRecoveryPointProperties": { + "description": "Migration item recovery point properties.", + "type": "object", + "properties": { + "recoveryPointTime": { + "format": "date-time", + "description": "The recovery point time.", + "type": "string", + "readOnly": true + }, + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "NotSpecified", + "ApplicationConsistent", + "CrashConsistent" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MigrationRecoveryPointType", + "modelAsString": true + } + } + } + }, + "MobilityServiceUpdate": { + "description": "The Mobility Service update details.", + "type": "object", + "properties": { + "version": { + "description": "The version of the latest update.", + "type": "string" + }, + "rebootStatus": { + "description": "The reboot status of the update - whether it is required or not.", + "type": "string" + }, + "osType": { + "description": "The OS type.", + "type": "string" + } + } + }, + "Network": { + "description": "Network model.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/NetworkProperties", + "description": "The Network Properties." + } + } + }, + "NetworkCollection": { + "description": "List of networks.", + "type": "object", + "properties": { + "value": { + "description": "The Networks list details.", + "type": "array", + "items": { + "$ref": "#/definitions/Network" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "NetworkMapping": { + "description": "Network Mapping model. Ideally it should have been possible to inherit this class from prev version in InheritedModels as long as there is no difference in structure or method signature. Since there were no base Models for certain fields and methods viz NetworkMappingProperties and Load with required return type, the class has been introduced in its entirety with references to base models to facilitate extensions in subsequent versions.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/NetworkMappingProperties", + "description": "The Network Mapping Properties." + } + } + }, + "NetworkMappingCollection": { + "description": "List of network mappings. As with NetworkMapping, it should be possible to reuse a prev version of this class. It doesn't seem likely this class could be anything more than a slightly bespoke collection of NetworkMapping. Hence it makes sense to override Load with Base.NetworkMapping instead of existing CurrentVersion.NetworkMapping.", + "type": "object", + "properties": { + "value": { + "description": "The Network Mappings list.", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkMapping" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "NetworkMappingFabricSpecificSettings": { + "description": "Network Mapping fabric specific settings.", + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the Instance type.", + "type": "string", + "readOnly": true + } + }, + "discriminator": "instanceType" + }, + "NetworkMappingProperties": { + "description": "Network Mapping Properties.", + "type": "object", + "properties": { + "state": { + "description": "The pairing state for network mapping.", + "type": "string" + }, + "primaryNetworkFriendlyName": { + "description": "The primary network friendly name.", + "type": "string" + }, + "primaryNetworkId": { + "description": "The primary network id for network mapping.", + "type": "string" + }, + "primaryFabricFriendlyName": { + "description": "The primary fabric friendly name.", + "type": "string" + }, + "recoveryNetworkFriendlyName": { + "description": "The recovery network friendly name.", + "type": "string" + }, + "recoveryNetworkId": { + "description": "The recovery network id for network mapping.", + "type": "string" + }, + "recoveryFabricArmId": { + "description": "The recovery fabric ARM id.", + "type": "string" + }, + "recoveryFabricFriendlyName": { + "description": "The recovery fabric friendly name.", + "type": "string" + }, + "fabricSpecificSettings": { + "$ref": "#/definitions/NetworkMappingFabricSpecificSettings", + "description": "The fabric specific settings." + } + } + }, + "NetworkProperties": { + "description": "Network Properties.", + "type": "object", + "properties": { + "fabricType": { + "description": "The Fabric Type.", + "type": "string" + }, + "subnets": { + "description": "The List of subnets.", + "type": "array", + "items": { + "$ref": "#/definitions/Subnet" + } + }, + "friendlyName": { + "description": "The Friendly Name.", + "type": "string" + }, + "networkType": { + "description": "The Network Type.", + "type": "string" + } + } + }, + "NewProtectionProfile": { + "description": "New Protection profile input.", + "required": [ + "policyName", + "multiVmSyncStatus" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionProfileCustomDetails" + } + ], + "properties": { + "policyName": { + "description": "The protection profile input.", + "type": "string" + }, + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'.", + "enum": [ + "Enable", + "Disable" + ], + "type": "string", + "x-ms-enum": { + "name": "SetMultiVmSyncStatus", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "New" + }, + "NewRecoveryVirtualNetwork": { + "description": "Recovery virtual network input to create new virtual network from given source network.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryVirtualNetworkCustomDetails" + } + ], + "properties": { + "recoveryVirtualNetworkResourceGroupName": { + "description": "The name of the resource group to be used to create the recovery virtual network. If absent, target network would be created in the same resource group as target VM.", + "type": "string" + }, + "recoveryVirtualNetworkName": { + "description": "The recovery virtual network name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "New" + }, + "OperationsDiscovery": { + "description": "Operations discovery class.", + "type": "object", + "properties": { + "name": { + "description": "Name of the API. The name of the operation being performed on this particular object. It should match the action name that appears in RBAC / the event service. Examples of operations include: * Microsoft.Compute/virtualMachine/capture/action * Microsoft.Compute/virtualMachine/restart/action * Microsoft.Compute/virtualMachine/write * Microsoft.Compute/virtualMachine/read * Microsoft.Compute/virtualMachine/delete Each action should include, in order: (1) Resource Provider Namespace (2) Type hierarchy for which the action applies (e.g. server/databases for a SQL Azure database) (3) Read, Write, Action or Delete indicating which type applies. If it is a PUT/PATCH on a collection or named value, Write should be used. If it is a GET, Read should be used. If it is a DELETE, Delete should be used. If it is a POST, Action should be used. As a note: all resource providers would need to include the \"{Resource Provider Namespace}/register/action\" operation in their response. This API is used to register for their service, and should include details about the operation (e.g. a localized name for the resource provider + any special considerations like PII release).", + "type": "string" + }, + "display": { + "$ref": "#/definitions/Display", + "description": "Object type." + }, + "origin": { + "description": "Origin. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX. Default value is \"user,system\".", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/OperationsDiscoveryProperties", + "description": "Properties. Reserved for future use." + } + } + }, + "OperationsDiscoveryCollection": { + "description": "Collection of ClientDiscovery details.", + "type": "object", + "properties": { + "value": { + "description": "The ClientDiscovery details.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationsDiscovery" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "OperationsDiscoveryProperties": { + "description": "ClientDiscovery properties.", + "type": "object", + "properties": {} + }, + "OSDetails": { + "description": "Disk Details.", + "type": "object", + "properties": { + "osType": { + "description": "VM Disk details.", + "type": "string" + }, + "productType": { + "description": "Product type.", + "type": "string" + }, + "osEdition": { + "description": "The OSEdition.", + "type": "string" + }, + "oSVersion": { + "description": "The OS Version.", + "type": "string" + }, + "oSMajorVersion": { + "description": "The OS Major Version.", + "type": "string" + }, + "oSMinorVersion": { + "description": "The OS Minor Version.", + "type": "string" + } + } + }, + "OSDiskDetails": { + "description": "Details of the OS Disk.", + "type": "object", + "properties": { + "osVhdId": { + "description": "The id of the disk containing the OS.", + "type": "string" + }, + "osType": { + "description": "The type of the OS on the VM.", + "type": "string" + }, + "vhdName": { + "description": "The OS disk VHD name.", + "type": "string" + } + } + }, + "OSVersionWrapper": { + "description": "Wrapper model for OSVersion to include version and service pack info.", + "type": "object", + "properties": { + "version": { + "description": "The version.", + "type": "string" + }, + "servicePack": { + "description": "The service pack.", + "type": "string" + } + } + }, + "PlannedFailoverInput": { + "description": "Input definition for planned failover.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PlannedFailoverInputProperties", + "description": "Planned failover input properties." + } + } + }, + "PlannedFailoverInputProperties": { + "description": "Input definition for planned failover input properties.", + "type": "object", + "properties": { + "failoverDirection": { + "description": "Failover direction.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/PlannedFailoverProviderSpecificFailoverInput", + "description": "Provider specific settings." + } + } + }, + "PlannedFailoverProviderSpecificFailoverInput": { + "description": "Provider specific failover input.", + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "Policy": { + "description": "Protection profile details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PolicyProperties", + "description": "The custom data." + } + } + }, + "PolicyCollection": { + "description": "Protection Profile Collection details.", + "type": "object", + "properties": { + "value": { + "description": "The policy details.", + "type": "array", + "items": { + "$ref": "#/definitions/Policy" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "PolicyProperties": { + "description": "Protection profile custom data details.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The FriendlyName.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/PolicyProviderSpecificDetails", + "description": "The ReplicationChannelSetting." + } + } + }, + "PolicyProviderSpecificDetails": { + "description": "Base class for Provider specific details for policies.", + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type. Overridden in derived classes.", + "type": "string", + "readOnly": true + } + }, + "discriminator": "instanceType" + }, + "PolicyProviderSpecificInput": { + "description": "Base class for provider specific input.", + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ProcessServer": { + "description": "Details of the Process Server.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The Process Server's friendly name.", + "type": "string" + }, + "id": { + "description": "The Process Server Id.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address of the server.", + "type": "string" + }, + "osType": { + "description": "The OS type of the server.", + "type": "string" + }, + "agentVersion": { + "description": "The version of the scout component on the server.", + "type": "string" + }, + "lastHeartbeat": { + "format": "date-time", + "description": "The last heartbeat received from the server.", + "type": "string" + }, + "versionStatus": { + "description": "Version status.", + "type": "string" + }, + "mobilityServiceUpdates": { + "description": "The list of the mobility service updates available on the Process Server.", + "type": "array", + "items": { + "$ref": "#/definitions/MobilityServiceUpdate" + } + }, + "hostId": { + "description": "The agent generated Id.", + "type": "string" + }, + "machineCount": { + "description": "The servers configured with this PS.", + "type": "string" + }, + "replicationPairCount": { + "description": "The number of replication pairs configured in this PS.", + "type": "string" + }, + "systemLoad": { + "description": "The percentage of the system load.", + "type": "string" + }, + "systemLoadStatus": { + "description": "The system load status.", + "type": "string" + }, + "cpuLoad": { + "description": "The percentage of the CPU load.", + "type": "string" + }, + "cpuLoadStatus": { + "description": "The CPU load status.", + "type": "string" + }, + "totalMemoryInBytes": { + "format": "int64", + "description": "The total memory.", + "type": "integer" + }, + "availableMemoryInBytes": { + "format": "int64", + "description": "The available memory.", + "type": "integer" + }, + "memoryUsageStatus": { + "description": "The memory usage status.", + "type": "string" + }, + "totalSpaceInBytes": { + "format": "int64", + "description": "The total space.", + "type": "integer" + }, + "availableSpaceInBytes": { + "format": "int64", + "description": "The available space.", + "type": "integer" + }, + "spaceUsageStatus": { + "description": "The space usage status.", + "type": "string" + }, + "psServiceStatus": { + "description": "The PS service status.", + "type": "string" + }, + "sslCertExpiryDate": { + "format": "date-time", + "description": "The PS SSL cert expiry date.", + "type": "string" + }, + "sslCertExpiryRemainingDays": { + "format": "int32", + "description": "CS SSL cert expiry date.", + "type": "integer" + }, + "osVersion": { + "description": "OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0.", + "type": "string" + }, + "healthErrors": { + "description": "Health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "agentExpiryDate": { + "format": "date-time", + "description": "Agent expiry date.", + "type": "string" + }, + "agentVersionDetails": { + "$ref": "#/definitions/VersionDetails", + "description": "The agent version details." + }, + "health": { + "description": "The health of Process Server.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "psStatsRefreshTime": { + "format": "date-time", + "description": "The process server stats refresh time.", + "type": "string", + "readOnly": true + }, + "throughputUploadPendingDataInBytes": { + "format": "int64", + "description": "The uploading pending data in bytes.", + "type": "integer", + "readOnly": true + }, + "throughputInMBps": { + "format": "int64", + "description": "The throughput in MBps.", + "type": "integer", + "readOnly": true + }, + "throughputInBytes": { + "format": "int64", + "description": "The throughput in bytes.", + "type": "integer", + "readOnly": true + }, + "throughputStatus": { + "description": "The throughput status.", + "type": "string", + "readOnly": true + }, + "marsCommunicationStatus": { + "description": "The MARS communication status.", + "type": "string", + "readOnly": true + }, + "marsRegistrationStatus": { + "description": "The MARS registration status.", + "type": "string", + "readOnly": true + } + } + }, + "ProcessServerDetails": { + "description": "Process server details.", + "type": "object", + "properties": { + "id": { + "description": "The process server Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The process server name.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The process server Bios Id.", + "type": "string", + "readOnly": true + }, + "fabricObjectId": { + "description": "The fabric object Id.", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "The process server Fqdn.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the process server.", + "type": "string", + "readOnly": true + }, + "totalMemoryInBytes": { + "format": "int64", + "description": "The total memory.", + "type": "integer", + "readOnly": true + }, + "availableMemoryInBytes": { + "format": "int64", + "description": "The available memory.", + "type": "integer", + "readOnly": true + }, + "usedMemoryInBytes": { + "format": "int64", + "description": "The used memory.", + "type": "integer", + "readOnly": true + }, + "memoryUsagePercentage": { + "format": "double", + "description": "The memory usage percentage.", + "type": "number", + "readOnly": true + }, + "totalSpaceInBytes": { + "format": "int64", + "description": "The total disk space.", + "type": "integer", + "readOnly": true + }, + "availableSpaceInBytes": { + "format": "int64", + "description": "The available disk space.", + "type": "integer", + "readOnly": true + }, + "usedSpaceInBytes": { + "format": "int64", + "description": "The used disk space.", + "type": "integer", + "readOnly": true + }, + "freeSpacePercentage": { + "format": "double", + "description": "The free disk space percentage.", + "type": "number", + "readOnly": true + }, + "throughputUploadPendingDataInBytes": { + "format": "int64", + "description": "The uploading pending data in bytes.", + "type": "integer", + "readOnly": true + }, + "throughputInBytes": { + "format": "int64", + "description": "The throughput in bytes.", + "type": "integer", + "readOnly": true + }, + "processorUsagePercentage": { + "format": "double", + "description": "The processor usage percentage.", + "type": "number", + "readOnly": true + }, + "throughputStatus": { + "description": "The throughput status.", + "enum": [ + "Healthy", + "Warning", + "Critical", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RcmComponentStatus", + "modelAsString": true + } + }, + "systemLoad": { + "format": "int64", + "description": "The system load.", + "type": "integer", + "readOnly": true + }, + "systemLoadStatus": { + "description": "The system load status.", + "enum": [ + "Healthy", + "Warning", + "Critical", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RcmComponentStatus", + "modelAsString": true + } + }, + "diskUsageStatus": { + "description": "The disk usage status.", + "enum": [ + "Healthy", + "Warning", + "Critical", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RcmComponentStatus", + "modelAsString": true + } + }, + "memoryUsageStatus": { + "description": "The memory usage status.", + "enum": [ + "Healthy", + "Warning", + "Critical", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RcmComponentStatus", + "modelAsString": true + } + }, + "processorUsageStatus": { + "description": "The processor usage status.", + "enum": [ + "Healthy", + "Warning", + "Critical", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RcmComponentStatus", + "modelAsString": true + } + }, + "health": { + "description": "The health of the process server.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + }, + "historicHealth": { + "description": "The historic health of the process server based on the health in last 24 hours.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + } + } + }, + "ProtectableItem": { + "description": "Replication protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ProtectableItemProperties", + "description": "The custom data." + } + } + }, + "ProtectableItemCollection": { + "description": "Protectable item collection.", + "type": "object", + "properties": { + "value": { + "description": "The Protectable item details.", + "type": "array", + "items": { + "$ref": "#/definitions/ProtectableItem" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "ProtectableItemProperties": { + "description": "Replication protected item custom data details.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The name.", + "type": "string" + }, + "protectionStatus": { + "description": "The protection status.", + "type": "string" + }, + "replicationProtectedItemId": { + "description": "The ARM resource of protected items.", + "type": "string" + }, + "recoveryServicesProviderId": { + "description": "The recovery provider ARM Id.", + "type": "string" + }, + "protectionReadinessErrors": { + "description": "The Current protection readiness errors.", + "type": "array", + "items": { + "type": "string" + } + }, + "supportedReplicationProviders": { + "description": "The list of replication providers supported for the protectable item.", + "type": "array", + "items": { + "type": "string" + } + }, + "customDetails": { + "$ref": "#/definitions/ConfigurationSettings", + "description": "The Replication provider custom settings." + } + } + }, + "ProtectableItemQueryParameter": { + "description": "Query parameter to enumerate Protectable items.", + "type": "object", + "properties": { + "state": { + "description": "State of the Protectable item query filter.", + "type": "string" + } + } + }, + "ProtectedItemsQueryParameter": { + "description": "Query parameter to enumerate protected items.", + "type": "object", + "properties": { + "sourceFabricName": { + "description": "The source fabric name filter.", + "type": "string" + }, + "recoveryPlanName": { + "description": "The recovery plan filter.", + "type": "string" + }, + "vCenterName": { + "description": "The vCenter name filter.", + "type": "string" + }, + "instanceType": { + "description": "The replication provider type.", + "type": "string" + }, + "multiVmGroupCreateOption": { + "description": "Whether Multi VM group is auto created or specified by user.", + "enum": [ + "AutoCreated", + "UserSpecified" + ], + "type": "string", + "x-ms-enum": { + "name": "MultiVmGroupCreateOption", + "modelAsString": true + } + }, + "processServerId": { + "description": "The process server Id filter.", + "type": "string" + } + } + }, + "ProtectionContainer": { + "description": "Protection container details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ProtectionContainerProperties", + "description": "The custom data." + } + } + }, + "ProtectionContainerCollection": { + "description": "Protection Container collection.", + "type": "object", + "properties": { + "value": { + "description": "The Protection Container details.", + "type": "array", + "items": { + "$ref": "#/definitions/ProtectionContainer" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "ProtectionContainerFabricSpecificDetails": { + "description": "Base class for fabric specific details of container.", + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type. Overridden in derived classes.", + "type": "string", + "readOnly": true + } + } + }, + "ProtectionContainerMapping": { + "description": "Protection container mapping object.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ProtectionContainerMappingProperties", + "description": "The custom data." + } + } + }, + "ProtectionContainerMappingCollection": { + "description": "Protection container mapping collection class.", + "type": "object", + "properties": { + "value": { + "description": "List of container mappings.", + "type": "array", + "items": { + "$ref": "#/definitions/ProtectionContainerMapping" + } + }, + "nextLink": { + "description": "Link to fetch rest of the data.", + "type": "string" + } + } + }, + "ProtectionContainerMappingProperties": { + "description": "Protection container mapping properties.", + "type": "object", + "properties": { + "targetProtectionContainerId": { + "description": "Paired protection container ARM ID.", + "type": "string" + }, + "targetProtectionContainerFriendlyName": { + "description": "Friendly name of paired container.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/ProtectionContainerMappingProviderSpecificDetails", + "description": "Provider specific provider details." + }, + "health": { + "description": "Health of pairing.", + "type": "string" + }, + "healthErrorDetails": { + "description": "Health error.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "policyId": { + "description": "Policy ARM Id.", + "type": "string" + }, + "state": { + "description": "Association Status.", + "type": "string" + }, + "sourceProtectionContainerFriendlyName": { + "description": "Friendly name of source protection container.", + "type": "string" + }, + "sourceFabricFriendlyName": { + "description": "Friendly name of source fabric.", + "type": "string" + }, + "targetFabricFriendlyName": { + "description": "Friendly name of target fabric.", + "type": "string" + }, + "policyFriendlyName": { + "description": "Friendly name of replication policy.", + "type": "string" + } + } + }, + "ProtectionContainerMappingProviderSpecificDetails": { + "description": "Container mapping provider specific details.", + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type. Overridden in derived classes.", + "type": "string", + "readOnly": true + } + }, + "discriminator": "instanceType" + }, + "ProtectionContainerProperties": { + "description": "Protection profile custom data details.", + "type": "object", + "properties": { + "fabricFriendlyName": { + "description": "Fabric friendly name.", + "type": "string" + }, + "friendlyName": { + "description": "The name.", + "type": "string" + }, + "fabricType": { + "description": "The fabric type.", + "type": "string" + }, + "protectedItemCount": { + "format": "int32", + "description": "Number of protected PEs.", + "type": "integer" + }, + "pairingStatus": { + "description": "The pairing status of this cloud.", + "type": "string" + }, + "role": { + "description": "The role of this cloud.", + "type": "string" + }, + "fabricSpecificDetails": { + "$ref": "#/definitions/ProtectionContainerFabricSpecificDetails", + "description": "Fabric specific details." + } + } + }, + "ProtectionProfileCustomDetails": { + "description": "Protection Profile custom input.", + "type": "object", + "properties": { + "resourceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "resourceType" + }, + "ProviderError": { + "description": "This class contains the error details per object.", + "type": "object", + "properties": { + "errorCode": { + "format": "int32", + "description": "The Error code.", + "type": "integer" + }, + "errorMessage": { + "description": "The Error message.", + "type": "string" + }, + "errorId": { + "description": "The Provider error Id.", + "type": "string" + }, + "possibleCauses": { + "description": "The possible causes for the error.", + "type": "string" + }, + "recommendedAction": { + "description": "The recommended action to resolve the error.", + "type": "string" + } + } + }, + "ProviderSpecificRecoveryPointDetails": { + "description": "Replication provider specific recovery point details.", + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the provider type.", + "type": "string", + "readOnly": true + } + }, + "discriminator": "instanceType" + }, + "PushInstallerDetails": { + "description": "Push installer details.", + "type": "object", + "properties": { + "id": { + "description": "The push installer Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The push installer name.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The push installer Bios Id.", + "type": "string", + "readOnly": true + }, + "fabricObjectId": { + "description": "The fabric object Id.", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "The push installer Fqdn.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the push installer.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The health of the push installer.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + } + } + }, + "RcmProxyDetails": { + "description": "RCM proxy details.", + "type": "object", + "properties": { + "id": { + "description": "The RCM proxy Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The RCM proxy name.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The RCM proxy Bios Id.", + "type": "string", + "readOnly": true + }, + "fabricObjectId": { + "description": "The fabric object Id.", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "The RCM proxy Fqdn.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the RCM proxy.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The health of the RCM proxy.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + } + } + }, + "RecoveryAvailabilitySetCustomDetails": { + "description": "Recovery Availability Set custom input.", + "type": "object", + "properties": { + "resourceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "resourceType" + }, + "RecoveryPlan": { + "description": "Recovery plan details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RecoveryPlanProperties", + "description": "The custom details." + } + } + }, + "RecoveryPlanA2ADetails": { + "description": "Recovery plan A2A specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificDetails" + } + ], + "properties": { + "primaryZone": { + "description": "The primary zone.", + "type": "string" + }, + "recoveryZone": { + "description": "The recovery zone.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "RecoveryPlanA2AFailoverInput": { + "description": "Recovery plan A2A failover input.", + "required": [ + "recoveryPointType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "Latest", + "LatestApplicationConsistent", + "LatestCrashConsistent", + "LatestProcessed" + ], + "type": "string", + "x-ms-enum": { + "name": "A2ARpRecoveryPointType", + "modelAsString": true + } + }, + "cloudServiceCreationOption": { + "description": "A value indicating whether to use recovery cloud service for TFO or not.", + "type": "string" + }, + "multiVmSyncPointOption": { + "description": "A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover.", + "enum": [ + "UseMultiVmSyncRecoveryPoint", + "UsePerVmRecoveryPoint" + ], + "type": "string", + "x-ms-enum": { + "name": "MultiVmSyncPointOption", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "RecoveryPlanA2AInput": { + "description": "Recovery plan A2A input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificInput" + } + ], + "properties": { + "primaryZone": { + "description": "The primary zone.", + "type": "string" + }, + "recoveryZone": { + "description": "The recovery zone.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "RecoveryPlanAction": { + "description": "Recovery plan action details.", + "required": [ + "actionName", + "failoverTypes", + "failoverDirections", + "customDetails" + ], + "type": "object", + "properties": { + "actionName": { + "description": "The action name.", + "type": "string" + }, + "failoverTypes": { + "description": "The list of failover types.", + "type": "array", + "items": { + "enum": [ + "ReverseReplicate", + "Commit", + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover", + "TestFailoverCleanup", + "Failback", + "FinalizeFailback", + "CancelFailover", + "ChangePit", + "RepairReplication", + "SwitchProtection", + "CompleteMigration" + ], + "type": "string", + "x-ms-enum": { + "name": "ReplicationProtectedItemOperation", + "modelAsString": true + } + } + }, + "failoverDirections": { + "description": "The list of failover directions.", + "type": "array", + "items": { + "enum": [ + "PrimaryToRecovery", + "RecoveryToPrimary" + ], + "type": "string", + "x-ms-enum": { + "name": "PossibleOperationsDirections", + "modelAsString": true + } + } + }, + "customDetails": { + "$ref": "#/definitions/RecoveryPlanActionDetails", + "description": "The custom details." + } + } + }, + "RecoveryPlanActionDetails": { + "description": "Recovery plan action custom details.", + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values).", + "type": "string", + "readOnly": true + } + }, + "discriminator": "instanceType" + }, + "RecoveryPlanAutomationRunbookActionDetails": { + "description": "Recovery plan Automation runbook action details.", + "required": [ + "fabricLocation" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanActionDetails" + } + ], + "properties": { + "runbookId": { + "description": "The runbook ARM Id.", + "type": "string" + }, + "timeout": { + "description": "The runbook timeout.", + "type": "string" + }, + "fabricLocation": { + "description": "The fabric location.", + "enum": [ + "Primary", + "Recovery" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPlanActionLocation", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "AutomationRunbookActionDetails" + }, + "RecoveryPlanCollection": { + "description": "Recovery plan collection details.", + "type": "object", + "properties": { + "value": { + "description": "The list of recovery plans.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "RecoveryPlanGroup": { + "description": "Recovery plan group details.", + "required": [ + "groupType" + ], + "type": "object", + "properties": { + "groupType": { + "description": "The group type.", + "enum": [ + "Shutdown", + "Boot", + "Failover" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPlanGroupType", + "modelAsString": true + } + }, + "replicationProtectedItems": { + "description": "The list of protected items.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanProtectedItem" + } + }, + "startGroupActions": { + "description": "The start group actions.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanAction" + } + }, + "endGroupActions": { + "description": "The end group actions.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanAction" + } + } + } + }, + "RecoveryPlanGroupTaskDetails": { + "description": "This class represents the recovery plan group task.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GroupTaskDetails" + } + ], + "properties": { + "name": { + "description": "The name.", + "type": "string" + }, + "groupId": { + "description": "The group identifier.", + "type": "string" + }, + "rpGroupType": { + "description": "The group type.", + "type": "string" + } + }, + "discriminator": "instanceType", + "x-ms-discriminator-value": "RecoveryPlanGroupTaskDetails" + }, + "RecoveryPlanHyperVReplicaAzureFailbackInput": { + "description": "Recovery plan HVR Azure failback input.", + "required": [ + "dataSyncOption", + "recoveryVmCreationOption" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + ], + "properties": { + "dataSyncOption": { + "description": "The data sync option.", + "enum": [ + "ForDownTime", + "ForSynchronization" + ], + "type": "string", + "x-ms-enum": { + "name": "DataSyncStatus", + "modelAsString": true + } + }, + "recoveryVmCreationOption": { + "description": "The ALR option.", + "enum": [ + "CreateVmIfNotFound", + "NoAction" + ], + "type": "string", + "x-ms-enum": { + "name": "AlternateLocationRecoveryOption", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzureFailback" + }, + "RecoveryPlanHyperVReplicaAzureFailoverInput": { + "description": "Recovery plan HVR Azure failover input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + ], + "properties": { + "primaryKekCertificatePfx": { + "description": "The primary KEK certificate PFX.", + "type": "string" + }, + "secondaryKekCertificatePfx": { + "description": "The secondary KEK certificate PFX.", + "type": "string" + }, + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "Latest", + "LatestApplicationConsistent", + "LatestProcessed" + ], + "type": "string", + "x-ms-enum": { + "name": "HyperVReplicaAzureRpRecoveryPointType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "RecoveryPlanInMageAzureV2FailoverInput": { + "description": "Recovery plan InMageAzureV2 failover input.", + "required": [ + "recoveryPointType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "Latest", + "LatestApplicationConsistent", + "LatestCrashConsistent", + "LatestProcessed" + ], + "type": "string", + "x-ms-enum": { + "name": "InMageV2RpRecoveryPointType", + "modelAsString": true + } + }, + "useMultiVmSyncPoint": { + "description": "A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "RecoveryPlanInMageFailoverInput": { + "description": "Recovery plan InMage failover input.", + "required": [ + "recoveryPointType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "LatestTime", + "LatestTag", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "RpInMageRecoveryPointType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "InMage" + }, + "RecoveryPlanInMageRcmFailbackFailoverInput": { + "description": "Recovery plan InMageRcmFailback failover input.", + "required": [ + "recoveryPointType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "ApplicationConsistent", + "CrashConsistent" + ], + "type": "string", + "x-ms-enum": { + "name": "InMageRcmFailbackRecoveryPointType", + "modelAsString": true + } + }, + "useMultiVmSyncPoint": { + "description": "A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcmFailback" + }, + "RecoveryPlanInMageRcmFailoverInput": { + "description": "Recovery plan InMageRcm failover input.", + "required": [ + "recoveryPointType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "Latest", + "LatestApplicationConsistent", + "LatestCrashConsistent", + "LatestProcessed" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPlanPointType", + "modelAsString": true + } + }, + "useMultiVmSyncPoint": { + "description": "A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "RecoveryPlanManualActionDetails": { + "description": "Recovery plan manual action details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanActionDetails" + } + ], + "properties": { + "description": { + "description": "The manual action description.", + "type": "string" + } + }, + "x-ms-discriminator-value": "ManualActionDetails" + }, + "RecoveryPlanPlannedFailoverInput": { + "description": "Recovery plan planned failover input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RecoveryPlanPlannedFailoverInputProperties", + "description": "The recovery plan planned failover input properties." + } + } + }, + "RecoveryPlanPlannedFailoverInputProperties": { + "description": "Recovery plan planned failover input properties.", + "required": [ + "failoverDirection" + ], + "type": "object", + "properties": { + "failoverDirection": { + "description": "The failover direction.", + "enum": [ + "PrimaryToRecovery", + "RecoveryToPrimary" + ], + "type": "string", + "x-ms-enum": { + "name": "PossibleOperationsDirections", + "modelAsString": true + } + }, + "providerSpecificDetails": { + "description": "The provider specific properties.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + } + } + }, + "RecoveryPlanProperties": { + "description": "Recovery plan properties.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The friendly name.", + "type": "string" + }, + "primaryFabricId": { + "description": "The primary fabric Id.", + "type": "string" + }, + "primaryFabricFriendlyName": { + "description": "The primary fabric friendly name.", + "type": "string" + }, + "recoveryFabricId": { + "description": "The recovery fabric Id.", + "type": "string" + }, + "recoveryFabricFriendlyName": { + "description": "The recovery fabric friendly name.", + "type": "string" + }, + "failoverDeploymentModel": { + "description": "The failover deployment model.", + "type": "string" + }, + "replicationProviders": { + "description": "The list of replication providers.", + "type": "array", + "items": { + "type": "string" + } + }, + "allowedOperations": { + "description": "The list of allowed operations.", + "type": "array", + "items": { + "type": "string" + } + }, + "lastPlannedFailoverTime": { + "format": "date-time", + "description": "The start time of the last planned failover.", + "type": "string" + }, + "lastUnplannedFailoverTime": { + "format": "date-time", + "description": "The start time of the last unplanned failover.", + "type": "string" + }, + "lastTestFailoverTime": { + "format": "date-time", + "description": "The start time of the last test failover.", + "type": "string" + }, + "currentScenario": { + "$ref": "#/definitions/CurrentScenarioDetails", + "description": "The current scenario details." + }, + "currentScenarioStatus": { + "description": "The recovery plan status.", + "type": "string" + }, + "currentScenarioStatusDescription": { + "description": "The recovery plan status description.", + "type": "string" + }, + "groups": { + "description": "The recovery plan groups.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanGroup" + } + }, + "providerSpecificDetails": { + "description": "The provider id and provider specific details.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanProviderSpecificDetails" + } + } + } + }, + "RecoveryPlanProtectedItem": { + "description": "Recovery plan protected item.", + "type": "object", + "properties": { + "id": { + "description": "The ARM Id of the recovery plan protected item.", + "type": "string" + }, + "virtualMachineId": { + "description": "The virtual machine Id.", + "type": "string" + } + } + }, + "RecoveryPlanProviderSpecificDetails": { + "description": "Recovery plan provider specific details.", + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the Instance type.", + "type": "string", + "readOnly": true + } + }, + "discriminator": "instanceType" + }, + "RecoveryPlanProviderSpecificFailoverInput": { + "description": "Recovery plan provider specific failover input.", + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "RecoveryPlanProviderSpecificInput": { + "description": "Recovery plan provider specific input base class.", + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the Instance type.", + "type": "string", + "readOnly": true + } + }, + "discriminator": "instanceType" + }, + "RecoveryPlanScriptActionDetails": { + "description": "Recovery plan script action details.", + "required": [ + "path", + "fabricLocation" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanActionDetails" + } + ], + "properties": { + "path": { + "description": "The script path.", + "type": "string" + }, + "timeout": { + "description": "The script timeout.", + "type": "string" + }, + "fabricLocation": { + "description": "The fabric location.", + "enum": [ + "Primary", + "Recovery" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPlanActionLocation", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "ScriptActionDetails" + }, + "RecoveryPlanShutdownGroupTaskDetails": { + "description": "This class represents the recovery plan shutdown group task details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanGroupTaskDetails" + } + ], + "properties": {}, + "x-ms-discriminator-value": "RecoveryPlanShutdownGroupTaskDetails" + }, + "RecoveryPlanTestFailoverCleanupInput": { + "description": "Recovery plan test failover cleanup input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RecoveryPlanTestFailoverCleanupInputProperties", + "description": "The recovery plan test failover cleanup input properties." + } + } + }, + "RecoveryPlanTestFailoverCleanupInputProperties": { + "description": "Recovery plan test failover cleanup input properties.", + "type": "object", + "properties": { + "comments": { + "description": "The test failover cleanup comments.", + "maxLength": 1024, + "type": "string" + } + } + }, + "RecoveryPlanTestFailoverInput": { + "description": "Recovery plan test failover input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RecoveryPlanTestFailoverInputProperties", + "description": "The recovery plan test failover input properties." + } + } + }, + "RecoveryPlanTestFailoverInputProperties": { + "description": "Recovery plan test failover input properties.", + "required": [ + "failoverDirection", + "networkType" + ], + "type": "object", + "properties": { + "failoverDirection": { + "description": "The failover direction.", + "enum": [ + "PrimaryToRecovery", + "RecoveryToPrimary" + ], + "type": "string", + "x-ms-enum": { + "name": "PossibleOperationsDirections", + "modelAsString": true + } + }, + "networkType": { + "description": "The network type to be used for test failover.", + "type": "string" + }, + "networkId": { + "description": "The Id of the network to be used for test failover.", + "type": "string" + }, + "providerSpecificDetails": { + "description": "The provider specific properties.", + "maxLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + } + } + }, + "RecoveryPlanUnplannedFailoverInput": { + "description": "Recovery plan unplanned failover input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RecoveryPlanUnplannedFailoverInputProperties", + "description": "The recovery plan unplanned failover input properties." + } + } + }, + "RecoveryPlanUnplannedFailoverInputProperties": { + "description": "Recovery plan unplanned failover input properties.", + "required": [ + "failoverDirection", + "sourceSiteOperations" + ], + "type": "object", + "properties": { + "failoverDirection": { + "description": "The failover direction.", + "enum": [ + "PrimaryToRecovery", + "RecoveryToPrimary" + ], + "type": "string", + "x-ms-enum": { + "name": "PossibleOperationsDirections", + "modelAsString": true + } + }, + "sourceSiteOperations": { + "description": "A value indicating whether source site operations are required.", + "enum": [ + "Required", + "NotRequired" + ], + "type": "string", + "x-ms-enum": { + "name": "SourceSiteOperations", + "modelAsString": true + } + }, + "providerSpecificDetails": { + "description": "The provider specific properties.", + "maxLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + } + } + }, + "RecoveryPoint": { + "description": "Recovery point.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RecoveryPointProperties", + "description": "The recovery point properties." + } + } + }, + "RecoveryPointCollection": { + "description": "Collection of recovery point details.", + "type": "object", + "properties": { + "value": { + "description": "The recovery point details.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPoint" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "RecoveryPointProperties": { + "description": "Recovery point properties.", + "type": "object", + "properties": { + "recoveryPointTime": { + "format": "date-time", + "description": "The recovery point time.", + "type": "string" + }, + "recoveryPointType": { + "description": "The recovery point type: ApplicationConsistent, CrashConsistent.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/ProviderSpecificRecoveryPointDetails", + "description": "The provider specific details for the recovery point." + } + } + }, + "RecoveryProximityPlacementGroupCustomDetails": { + "description": "Recovery Proximity placement group custom input.", + "type": "object", + "properties": { + "resourceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "resourceType" + }, + "RecoveryResourceGroupCustomDetails": { + "description": "Recovery Resource Group custom input.", + "type": "object", + "properties": { + "resourceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "resourceType" + }, + "RecoveryServicesProvider": { + "description": "Provider details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RecoveryServicesProviderProperties", + "description": "Provider properties." + } + } + }, + "RecoveryServicesProviderCollection": { + "description": "Collection of providers.", + "type": "object", + "properties": { + "value": { + "description": "The Servers details.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryServicesProvider" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "RecoveryServicesProviderProperties": { + "description": "Recovery services provider properties.", + "type": "object", + "properties": { + "fabricType": { + "description": "Type of the site.", + "type": "string" + }, + "friendlyName": { + "description": "Friendly name of the DRA.", + "type": "string" + }, + "providerVersion": { + "description": "The provider version.", + "type": "string" + }, + "serverVersion": { + "description": "The fabric provider.", + "type": "string" + }, + "providerVersionState": { + "description": "DRA version status.", + "type": "string" + }, + "providerVersionExpiryDate": { + "format": "date-time", + "description": "Expiry date of the version.", + "type": "string" + }, + "fabricFriendlyName": { + "description": "The fabric friendly name.", + "type": "string" + }, + "lastHeartBeat": { + "format": "date-time", + "description": "Time when last heartbeat was sent by the DRA.", + "type": "string" + }, + "connectionStatus": { + "description": "A value indicating whether DRA is responsive.", + "type": "string" + }, + "protectedItemCount": { + "format": "int32", + "description": "Number of protected VMs currently managed by the DRA.", + "type": "integer" + }, + "allowedScenarios": { + "description": "The scenarios allowed on this provider.", + "type": "array", + "items": { + "type": "string" + } + }, + "healthErrorDetails": { + "description": "The recovery services provider health error details.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "draIdentifier": { + "description": "The DRA Id.", + "type": "string" + }, + "machineId": { + "description": "The machine Id.", + "type": "string" + }, + "machineName": { + "description": "The machine name.", + "type": "string" + }, + "biosId": { + "description": "The Bios Id.", + "type": "string" + }, + "authenticationIdentityDetails": { + "$ref": "#/definitions/IdentityProviderDetails", + "description": "The authentication identity details." + }, + "resourceAccessIdentityDetails": { + "$ref": "#/definitions/IdentityProviderDetails", + "description": "The resource access identity details." + }, + "dataPlaneAuthenticationIdentityDetails": { + "$ref": "#/definitions/IdentityProviderDetails", + "description": "The data plane authentication identity details." + }, + "providerVersionDetails": { + "$ref": "#/definitions/VersionDetails", + "description": "The provider version details." + } + } + }, + "RecoveryVirtualNetworkCustomDetails": { + "description": "Recovery Virtual network custom input.", + "type": "object", + "properties": { + "resourceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "resourceType" + }, + "RemoveDisksInput": { + "description": "Input for remove disk(s) operation.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RemoveDisksInputProperties", + "description": "Remove disk input properties." + } + } + }, + "RemoveDisksInputProperties": { + "description": "Remove Disk input properties.", + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/RemoveDisksProviderSpecificInput", + "description": "The ReplicationProviderInput. For HyperVReplicaAzure provider, it will be AzureEnableProtectionInput object. For San provider, it will be SanEnableProtectionInput object. For HyperVReplicaAzure provider, it can be null." + } + } + }, + "RemoveDisksProviderSpecificInput": { + "description": "Remove Disk provider specific input.", + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "RemoveProtectionContainerMappingInput": { + "description": "Container unpairing input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RemoveProtectionContainerMappingInputProperties", + "description": "Configure protection input properties." + } + } + }, + "RemoveProtectionContainerMappingInputProperties": { + "description": "Unpairing input properties.", + "type": "object", + "properties": { + "providerSpecificInput": { + "$ref": "#/definitions/ReplicationProviderContainerUnmappingInput", + "description": "Provider specific input for unpairing." + } + } + }, + "RenewCertificateInput": { + "description": "Certificate renewal input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RenewCertificateInputProperties", + "description": "Renew certificate input properties." + } + } + }, + "RenewCertificateInputProperties": { + "description": "Renew Certificate input properties.", + "type": "object", + "properties": { + "renewCertificateType": { + "description": "Renew certificate type.", + "type": "string" + } + } + }, + "ReplicationAgentDetails": { + "description": "Replication agent details.", + "type": "object", + "properties": { + "id": { + "description": "The replication agent Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The replication agent name.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The replication agent Bios Id.", + "type": "string", + "readOnly": true + }, + "fabricObjectId": { + "description": "The fabric object Id.", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "The replication agent Fqdn.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the replication agent.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The health of the replication agent.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + } + } + }, + "ReplicationEligibilityResults": { + "description": "Replication eligibility results response model.", + "type": "object", + "properties": { + "name": { + "description": "Gets the name of this object.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Gets the object type.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Gets Unique ARM identifier for this object.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/ReplicationEligibilityResultsProperties", + "description": "Gets properties model for replication eligibility results API.", + "readOnly": true + } + } + }, + "ReplicationEligibilityResultsCollection": { + "description": "Replication eligibility results collection response model.", + "type": "object", + "properties": { + "value": { + "description": "The replication eligibility results details.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationEligibilityResults" + } + } + } + }, + "ReplicationEligibilityResultsErrorInfo": { + "description": "Error model that can be exposed to the user.", + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "type": "string" + }, + "message": { + "description": "The error message.", + "type": "string" + }, + "possibleCauses": { + "description": "The possible causes.", + "type": "string" + }, + "recommendedAction": { + "description": "The recommended action.", + "type": "string" + }, + "status": { + "description": "The error status.", + "readOnly": true, + "type": "string" + } + } + }, + "ReplicationEligibilityResultsProperties": { + "description": "Properties model for replication eligibility results API.", + "type": "object", + "properties": { + "clientRequestId": { + "description": "The client request Id.", + "readOnly": true, + "type": "string" + }, + "errors": { + "description": "The error details.", + "type": "array", + "uniqueItems": false, + "items": { + "$ref": "#/definitions/ReplicationEligibilityResultsErrorInfo" + } + } + } + }, + "ReplicationGroupDetails": { + "description": "Replication group details. This will be used in case of San.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConfigurationSettings" + } + ], + "properties": {}, + "x-ms-discriminator-value": "ReplicationGroupDetails" + }, + "ReplicationProtectedItem": { + "description": "Replication protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ReplicationProtectedItemProperties", + "description": "The custom data." + } + } + }, + "ReplicationProtectedItemCollection": { + "description": "Replication protected item collection.", + "type": "object", + "properties": { + "value": { + "description": "The Replication protected item details.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "ReplicationProtectedItemProperties": { + "description": "Replication protected item custom data details.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The name.", + "type": "string" + }, + "protectedItemType": { + "description": "The type of protected item type.", + "type": "string" + }, + "protectableItemId": { + "description": "The protected item ARM Id.", + "type": "string" + }, + "recoveryServicesProviderId": { + "description": "The recovery provider ARM Id.", + "type": "string" + }, + "primaryFabricFriendlyName": { + "description": "The friendly name of the primary fabric.", + "type": "string" + }, + "primaryFabricProvider": { + "description": "The fabric provider of the primary fabric.", + "type": "string" + }, + "recoveryFabricFriendlyName": { + "description": "The friendly name of recovery fabric.", + "type": "string" + }, + "recoveryFabricId": { + "description": "The Arm Id of recovery fabric.", + "type": "string" + }, + "primaryProtectionContainerFriendlyName": { + "description": "The name of primary protection container friendly name.", + "type": "string" + }, + "recoveryProtectionContainerFriendlyName": { + "description": "The name of recovery container friendly name.", + "type": "string" + }, + "protectionState": { + "description": "The protection status.", + "type": "string" + }, + "protectionStateDescription": { + "description": "The protection state description.", + "type": "string" + }, + "activeLocation": { + "description": "The Current active location of the PE.", + "type": "string" + }, + "testFailoverState": { + "description": "The Test failover state.", + "type": "string" + }, + "testFailoverStateDescription": { + "description": "The Test failover state description.", + "type": "string" + }, + "allowedOperations": { + "description": "The allowed operations on the Replication protected item.", + "type": "array", + "items": { + "type": "string" + } + }, + "replicationHealth": { + "description": "The consolidated protection health for the VM taking any issues with SRS as well as all the replication units associated with the VM's replication group into account. This is a string representation of the ProtectionHealth enumeration.", + "type": "string" + }, + "failoverHealth": { + "description": "The consolidated failover health for the VM.", + "type": "string" + }, + "healthErrors": { + "description": "List of health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "policyId": { + "description": "The ID of Policy governing this PE.", + "type": "string" + }, + "policyFriendlyName": { + "description": "The name of Policy governing this PE.", + "type": "string" + }, + "lastSuccessfulFailoverTime": { + "format": "date-time", + "description": "The Last successful failover time.", + "type": "string" + }, + "lastSuccessfulTestFailoverTime": { + "format": "date-time", + "description": "The Last successful test failover time.", + "type": "string" + }, + "currentScenario": { + "$ref": "#/definitions/CurrentScenarioDetails", + "description": "The current scenario." + }, + "failoverRecoveryPointId": { + "description": "The recovery point ARM Id to which the Vm was failed over.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/ReplicationProviderSpecificSettings", + "description": "The Replication provider custom settings." + }, + "recoveryContainerId": { + "description": "The recovery container Id.", + "type": "string" + }, + "eventCorrelationId": { + "description": "The correlation Id for events associated with this protected item.", + "type": "string" + } + } + }, + "ReplicationProtectionIntent": { + "description": "Replication protection intent.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ReplicationProtectionIntentProperties", + "description": "The custom data." + } + } + }, + "ReplicationProtectionIntentCollection": { + "description": "Replication protection intent objects collection.", + "type": "object", + "properties": { + "value": { + "description": "The Replication protection intent details.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationProtectionIntent" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "ReplicationProtectionIntentProperties": { + "description": "Replication protection intent custom data details.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The name.", + "type": "string" + }, + "jobId": { + "description": "The job Id.", + "type": "string", + "readOnly": true + }, + "jobState": { + "description": "The job state.", + "type": "string", + "readOnly": true + }, + "isActive": { + "description": "A value indicating whether the intent object is active.", + "type": "boolean", + "readOnly": true + }, + "creationTimeUTC": { + "description": "The creation time in UTC.", + "type": "string", + "readOnly": true + }, + "providerSpecificDetails": { + "$ref": "#/definitions/ReplicationProtectionIntentProviderSpecificSettings", + "description": "The Replication provider custom settings." + } + } + }, + "ReplicationProtectionIntentProviderSpecificSettings": { + "description": "Replication provider specific settings.", + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the Instance type.", + "type": "string", + "readOnly": true + } + }, + "discriminator": "instanceType" + }, + "ReplicationProviderContainerUnmappingInput": { + "description": "Provider specific input for unpairing operations.", + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + } + }, + "ReplicationProviderSpecificContainerCreationInput": { + "description": "Provider specific input for container creation operation.", + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ReplicationProviderSpecificContainerMappingInput": { + "description": "Provider specific input for pairing operations.", + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ReplicationProviderSpecificSettings": { + "description": "Replication provider specific settings.", + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the Instance type.", + "type": "string", + "readOnly": true + } + }, + "discriminator": "instanceType" + }, + "ReplicationProviderSpecificUpdateContainerMappingInput": { + "description": "Provider specific input for update pairing operations.", + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ReprotectAgentDetails": { + "description": "Reprotect agent details.", + "type": "object", + "properties": { + "id": { + "description": "The reprotect agent Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The reprotect agent name.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The reprotect agent Bios Id.", + "type": "string", + "readOnly": true + }, + "fabricObjectId": { + "description": "The fabric object Id.", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "The reprotect agent Fqdn.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the reprotect agent.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The health of the reprotect agent.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + } + } + }, + "ResolveHealthError": { + "description": "Resolve health errors input properties.", + "type": "object", + "properties": { + "healthErrorId": { + "description": "Health error id.", + "type": "string" + } + } + }, + "ResolveHealthInput": { + "description": "Resolve health input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ResolveHealthInputProperties", + "description": "Disable resolve health input properties." + } + } + }, + "ResolveHealthInputProperties": { + "description": "Resolve health input properties.", + "type": "object", + "properties": { + "healthErrors": { + "description": "Health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/ResolveHealthError" + } + } + } + }, + "Resource": { + "description": "Azure resource.", + "properties": { + "id": { + "description": "Resource Id", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource Name", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource Type", + "type": "string", + "readOnly": true + }, + "location": { + "description": "Resource Location", + "type": "string" + } + }, + "x-ms-azure-resource": true + }, + "ResourceHealthSummary": { + "description": "Base class to define the health summary of the resources contained under an Arm resource.", + "type": "object", + "properties": { + "resourceCount": { + "format": "int32", + "description": "The count of total resources under the container.", + "type": "integer" + }, + "issues": { + "description": "The list of summary of health errors across the resources under the container.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthErrorSummary" + } + }, + "categorizedResourceCounts": { + "description": "The categorized resource counts.", + "type": "object", + "additionalProperties": { + "format": "int32", + "type": "integer" + } + } + } + }, + "ResumeJobParams": { + "description": "Resume job params.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ResumeJobParamsProperties", + "description": "Resume job properties." + } + } + }, + "ResumeJobParamsProperties": { + "description": "Resume job properties.", + "type": "object", + "properties": { + "comments": { + "description": "Resume job comments.", + "type": "string" + } + } + }, + "ResyncInput": { + "description": "Resync input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ResyncInputProperties", + "description": "Resync input properties." + } + } + }, + "ResyncInputProperties": { + "description": "Resync input properties.", + "required": [ + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/ResyncProviderSpecificInput", + "description": "The provider specific details." + } + } + }, + "ResyncProviderSpecificInput": { + "description": "Resync provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "RetentionVolume": { + "description": "The retention details of the MT.", + "type": "object", + "properties": { + "volumeName": { + "description": "The volume name.", + "type": "string" + }, + "capacityInBytes": { + "format": "int64", + "description": "The volume capacity.", + "type": "integer" + }, + "freeSpaceInBytes": { + "format": "int64", + "description": "The free space available in this volume.", + "type": "integer" + }, + "thresholdPercentage": { + "format": "int32", + "description": "The threshold percentage.", + "type": "integer" + } + } + }, + "ReverseReplicationInput": { + "description": "Reverse replication input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ReverseReplicationInputProperties", + "description": "Reverse replication properties." + } + } + }, + "ReverseReplicationInputProperties": { + "description": "Reverse replication input properties.", + "type": "object", + "properties": { + "failoverDirection": { + "description": "Failover direction.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/ReverseReplicationProviderSpecificInput", + "description": "Provider specific reverse replication input." + } + } + }, + "ReverseReplicationProviderSpecificInput": { + "description": "Provider specific reverse replication input.", + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "RoleAssignment": { + "description": "Azure role assignment details.", + "type": "object", + "properties": { + "id": { + "description": "The ARM Id of the role assignment.", + "type": "string" + }, + "name": { + "description": "The name of the role assignment.", + "type": "string" + }, + "scope": { + "description": "Role assignment scope.", + "type": "string" + }, + "principalId": { + "description": "Principal Id.", + "type": "string" + }, + "roleDefinitionId": { + "description": "Role definition id.", + "type": "string" + } + } + }, + "RunAsAccount": { + "description": "CS Accounts Details.", + "type": "object", + "properties": { + "accountId": { + "description": "The CS RunAs account Id.", + "type": "string" + }, + "accountName": { + "description": "The CS RunAs account name.", + "type": "string" + } + } + }, + "ScriptActionTaskDetails": { + "description": "This class represents the script action task details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskTypeDetails" + } + ], + "properties": { + "name": { + "description": "The name.", + "type": "string" + }, + "path": { + "description": "The path.", + "type": "string" + }, + "output": { + "description": "The output.", + "type": "string" + }, + "isPrimarySideScript": { + "description": "A value indicating whether it is a primary side script or not.", + "type": "boolean" + } + }, + "x-ms-discriminator-value": "ScriptActionTaskDetails" + }, + "ServiceError": { + "description": "ASR error model.", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Error message.", + "type": "string" + }, + "possibleCauses": { + "description": "Possible causes of error.", + "type": "string" + }, + "recommendedAction": { + "description": "Recommended action to resolve error.", + "type": "string" + }, + "activityId": { + "description": "Activity Id.", + "type": "string" + } + } + }, + "IPConfigDetails": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "isPrimary": { + "type": "boolean" + }, + "subnetName": { + "type": "string" + }, + "staticIPAddress": { + "type": "string" + }, + "ipAddressType": { + "type": "string" + }, + "isSeletedForFailover": { + "type": "boolean" + }, + "recoverySubnetName": { + "type": "string" + }, + "recoveryStaticIPAddress": { + "type": "string" + }, + "recoveryIPAddressType": { + "type": "string" + }, + "recoveryPublicIPAddressId": { + "type": "string" + }, + "recoveryLBBackendAddressPoolIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "tfoSubnetName": { + "type": "string" + }, + "tfoStaticIPAddress": { + "type": "string" + }, + "tfoPublicIPAddressId": { + "type": "string" + }, + "tfoLBBackendAddressPoolIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "IPConfigInputDetails": { + "type": "object", + "properties": { + "ipConfigName": { + "type": "string" + }, + "isPrimary": { + "type": "boolean" + }, + "isSeletedForFailover": { + "type": "boolean" + }, + "recoverySubnetName": { + "type": "string" + }, + "recoveryStaticIPAddress": { + "type": "string" + }, + "recoveryPublicIPAddressId": { + "type": "string" + }, + "recoveryLBBackendAddressPoolIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "tfoSubnetName": { + "type": "string" + }, + "tfoStaticIPAddress": { + "type": "string" + }, + "tfoPublicIPAddressId": { + "type": "string" + }, + "tfoLBBackendAddressPoolIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "StorageAccountCustomDetails": { + "description": "Storage account custom input.", + "type": "object", + "properties": { + "resourceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "resourceType" + }, + "StorageClassification": { + "description": "Storage object definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StorageClassificationProperties", + "description": "Properties of the storage object." + } + } + }, + "StorageClassificationCollection": { + "description": "Collection of storage details.", + "type": "object", + "properties": { + "value": { + "description": "The storage details.", + "type": "array", + "items": { + "$ref": "#/definitions/StorageClassification" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "StorageClassificationMapping": { + "description": "Storage mapping object.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StorageClassificationMappingProperties", + "description": "Properties of the storage mapping object." + } + } + }, + "StorageClassificationMappingCollection": { + "description": "Collection of storage mapping details.", + "type": "object", + "properties": { + "value": { + "description": "The storage details.", + "type": "array", + "items": { + "$ref": "#/definitions/StorageClassificationMapping" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "StorageClassificationMappingInput": { + "description": "Storage mapping input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/StorageMappingInputProperties", + "description": "Storage mapping input properties." + } + } + }, + "StorageClassificationMappingProperties": { + "description": "Storage mapping properties.", + "type": "object", + "properties": { + "targetStorageClassificationId": { + "description": "Target storage object Id.", + "type": "string" + } + } + }, + "StorageClassificationProperties": { + "description": "Storage object properties.", + "type": "object", + "properties": { + "friendlyName": { + "description": "Friendly name of the Storage classification.", + "type": "string" + } + } + }, + "StorageMappingInputProperties": { + "description": "Storage mapping input properties.", + "type": "object", + "properties": { + "targetStorageClassificationId": { + "description": "The ID of the storage object.", + "type": "string" + } + } + }, + "Subnet": { + "description": "Subnets of the network.", + "type": "object", + "properties": { + "name": { + "description": "The subnet name.", + "type": "string" + }, + "friendlyName": { + "description": "The subnet friendly name.", + "type": "string" + }, + "addressList": { + "description": "The list of addresses for the subnet.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SupportedOperatingSystems": { + "description": "Supported operating systems.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SupportedOSProperties", + "description": "The supported operating systems properties." + } + } + }, + "SupportedOSDetails": { + "description": "Supported operating system details.", + "type": "object", + "properties": { + "osName": { + "description": "The name.", + "type": "string" + }, + "osType": { + "description": "The type.", + "type": "string" + }, + "osVersions": { + "description": "The list of version for operating system.", + "type": "array", + "items": { + "$ref": "#/definitions/OSVersionWrapper" + } + } + } + }, + "SupportedOSProperties": { + "description": "Supported operating systems properties.", + "type": "object", + "properties": { + "supportedOsList": { + "description": "The supported operating systems property list.", + "type": "array", + "items": { + "$ref": "#/definitions/SupportedOSProperty" + } + } + } + }, + "SupportedOSProperty": { + "description": "Supported operating systems property.", + "type": "object", + "properties": { + "instanceType": { + "description": "The replication provider type.", + "type": "string" + }, + "supportedOs": { + "description": "The list of supported operating systems.", + "type": "array", + "items": { + "$ref": "#/definitions/SupportedOSDetails" + } + } + } + }, + "SwitchProtectionInput": { + "description": "Switch protection input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/SwitchProtectionInputProperties", + "description": "Switch protection properties." + } + } + }, + "SwitchProtectionInputProperties": { + "description": "Switch protection input properties.", + "type": "object", + "properties": { + "replicationProtectedItemName": { + "description": "The unique replication protected item name.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/SwitchProtectionProviderSpecificInput", + "description": "Provider specific switch protection input." + } + } + }, + "SwitchProtectionJobDetails": { + "description": "This class represents details for switch protection job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": { + "newReplicationProtectedItemId": { + "description": "ARM Id of the new replication protected item.", + "type": "string" + } + }, + "x-ms-discriminator-value": "SwitchProtectionJobDetails" + }, + "SwitchProtectionProviderSpecificInput": { + "description": "Provider specific switch protection input.", + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the Instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "TargetComputeSize": { + "description": "Represents applicable recovery vm sizes.", + "type": "object", + "properties": { + "id": { + "description": "The Id.", + "type": "string" + }, + "name": { + "description": "The name.", + "type": "string" + }, + "type": { + "description": "The Type of the object.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/TargetComputeSizeProperties", + "description": "The custom data." + } + } + }, + "TargetComputeSizeCollection": { + "description": "Target compute size collection.", + "type": "object", + "properties": { + "value": { + "description": "The list of target compute sizes.", + "type": "array", + "items": { + "$ref": "#/definitions/TargetComputeSize" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "TargetComputeSizeProperties": { + "description": "Represents applicable recovery vm sizes properties.", + "type": "object", + "properties": { + "name": { + "description": "Target compute size name.", + "type": "string" + }, + "friendlyName": { + "description": "Target compute size display name.", + "type": "string" + }, + "cpuCoresCount": { + "format": "int32", + "description": "The maximum cpu cores count supported by target compute size.", + "type": "integer" + }, + "vCPUsAvailable": { + "format": "int32", + "description": "The Available vCPUs supported by target compute size.", + "type": "integer", + "readOnly": true + }, + "memoryInGB": { + "format": "double", + "description": "The maximum memory in GB supported by target compute size.", + "type": "number" + }, + "maxDataDiskCount": { + "format": "int32", + "description": "The maximum data disks count supported by target compute size.", + "type": "integer" + }, + "maxNicsCount": { + "format": "int32", + "description": "The maximum Nics count supported by target compute size.", + "type": "integer" + }, + "errors": { + "description": "The reasons why the target compute size is not applicable for the protected item.", + "type": "array", + "items": { + "$ref": "#/definitions/ComputeSizeErrorDetails" + } + }, + "highIopsSupported": { + "description": "The value indicating whether the target compute size supports high Iops.", + "type": "string" + }, + "hyperVGenerations": { + "description": "The supported HyperV Generations.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "TaskTypeDetails": { + "description": "Task details based on specific task type.", + "type": "object", + "properties": { + "instanceType": { + "description": "The type of task details.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "TestFailoverCleanupInput": { + "description": "Input definition for test failover cleanup.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/TestFailoverCleanupInputProperties", + "description": "Test failover cleanup input properties." + } + } + }, + "TestFailoverCleanupInputProperties": { + "description": "Input definition for test failover cleanup input properties.", + "type": "object", + "properties": { + "comments": { + "description": "Test failover cleanup comments.", + "maxLength": 1024, + "type": "string" + } + } + }, + "TestFailoverInput": { + "description": "Input definition for test failover.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/TestFailoverInputProperties", + "description": "Test failover input properties." + } + } + }, + "TestFailoverInputProperties": { + "description": "Input definition for test failover input properties.", + "type": "object", + "properties": { + "failoverDirection": { + "description": "Test failover direction.", + "type": "string" + }, + "networkType": { + "description": "Network type to be used for test failover.", + "type": "string" + }, + "networkId": { + "description": "The id of the network to be used for test failover.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/TestFailoverProviderSpecificInput", + "description": "Provider specific settings." + } + } + }, + "TestFailoverJobDetails": { + "description": "This class represents the details for a test failover job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": { + "testFailoverStatus": { + "description": "The test failover status.", + "type": "string" + }, + "comments": { + "description": "The test failover comments.", + "type": "string" + }, + "networkName": { + "description": "The test network name.", + "type": "string" + }, + "networkFriendlyName": { + "description": "The test network friendly name.", + "type": "string" + }, + "networkType": { + "description": "The test network type (see TestFailoverInput enum for possible values).", + "type": "string" + }, + "protectedItemDetails": { + "description": "The test VM details.", + "type": "array", + "items": { + "$ref": "#/definitions/FailoverReplicationProtectedItemDetails" + } + } + }, + "x-ms-discriminator-value": "TestFailoverJobDetails" + }, + "TestFailoverProviderSpecificInput": { + "description": "Provider specific test failover input.", + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "TestMigrateCleanupInput": { + "description": "Input for test migrate cleanup.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/TestMigrateCleanupInputProperties", + "description": "Test migrate cleanup input properties." + } + } + }, + "TestMigrateCleanupInputProperties": { + "description": "Test migrate cleanup input properties.", + "type": "object", + "properties": { + "comments": { + "description": "Test migrate cleanup comments.", + "maxLength": 1024, + "type": "string" + } + } + }, + "TestMigrateInput": { + "description": "Input for test migrate.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/TestMigrateInputProperties", + "description": "Test migrate input properties." + } + } + }, + "TestMigrateInputProperties": { + "description": "Test migrate input properties.", + "required": [ + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/TestMigrateProviderSpecificInput", + "description": "The provider specific details." + } + } + }, + "TestMigrateProviderSpecificInput": { + "description": "Test migrate provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "UnplannedFailoverInput": { + "description": "Input definition for unplanned failover.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UnplannedFailoverInputProperties", + "description": "Unplanned failover input properties." + } + } + }, + "UnplannedFailoverInputProperties": { + "description": "Input definition for unplanned failover input properties.", + "type": "object", + "properties": { + "failoverDirection": { + "description": "Failover direction.", + "type": "string" + }, + "sourceSiteOperations": { + "description": "Source site operations status.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput", + "description": "Provider specific settings." + } + } + }, + "UnplannedFailoverProviderSpecificInput": { + "description": "Provider specific unplanned failover input.", + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "UpdateMigrationItemInput": { + "description": "Update migration item input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateMigrationItemInputProperties", + "description": "Update migration item input properties." + } + } + }, + "UpdateMigrationItemInputProperties": { + "description": "Update migration item input properties.", + "required": [ + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/UpdateMigrationItemProviderSpecificInput", + "description": "The provider specific input to update migration item." + } + } + }, + "UpdateMigrationItemProviderSpecificInput": { + "description": "Update migration item provider specific input.", + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "UpdateMobilityServiceRequest": { + "description": "Request to update the mobility service on a protected item.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateMobilityServiceRequestProperties", + "description": "The properties of the update mobility service request." + } + } + }, + "UpdateMobilityServiceRequestProperties": { + "description": "The properties of an update mobility service request.", + "type": "object", + "properties": { + "runAsAccountId": { + "description": "The CS run as account Id.", + "type": "string" + } + } + }, + "UpdateNetworkMappingInput": { + "description": "Update network mapping input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateNetworkMappingInputProperties", + "description": "The input properties needed to update network mapping." + } + } + }, + "UpdateNetworkMappingInputProperties": { + "description": "Common input details for network mapping operation.", + "type": "object", + "properties": { + "recoveryFabricName": { + "description": "Recovery fabric name.", + "type": "string" + }, + "recoveryNetworkId": { + "description": "Recovery network Id.", + "type": "string" + }, + "fabricSpecificDetails": { + "$ref": "#/definitions/FabricSpecificUpdateNetworkMappingInput", + "description": "Fabrics specific input network Id." + } + } + }, + "UpdatePolicyInput": { + "description": "Update policy input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdatePolicyInputProperties", + "description": "The ReplicationProviderSettings." + } + } + }, + "UpdatePolicyInputProperties": { + "description": "Policy update properties.", + "type": "object", + "properties": { + "replicationProviderSettings": { + "$ref": "#/definitions/PolicyProviderSpecificInput", + "description": "The ReplicationProviderSettings." + } + } + }, + "UpdateProtectionContainerMappingInput": { + "description": "Container pairing update input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateProtectionContainerMappingInputProperties", + "description": "Update protection container mapping input properties." + } + } + }, + "UpdateProtectionContainerMappingInputProperties": { + "description": "Container pairing update input.", + "type": "object", + "properties": { + "providerSpecificInput": { + "$ref": "#/definitions/ReplicationProviderSpecificUpdateContainerMappingInput", + "description": "Provider specific input for updating protection container mapping." + } + } + }, + "UpdateRecoveryPlanInput": { + "description": "Update recovery plan input class.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateRecoveryPlanInputProperties", + "description": "Recovery plan update properties." + } + } + }, + "UpdateRecoveryPlanInputProperties": { + "description": "Recovery plan update properties.", + "type": "object", + "properties": { + "groups": { + "description": "The recovery plan groups.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanGroup" + } + } + } + }, + "UpdateReplicationProtectedItemInput": { + "description": "Update replication protected item input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateReplicationProtectedItemInputProperties", + "description": "Update replication protected item properties." + } + } + }, + "UpdateReplicationProtectedItemInputProperties": { + "description": "Update protected item input properties.", + "type": "object", + "properties": { + "recoveryAzureVMName": { + "description": "Target Azure VM name given by the user.", + "type": "string" + }, + "recoveryAzureVMSize": { + "description": "Target Azure VM size.", + "type": "string" + }, + "selectedRecoveryAzureNetworkId": { + "description": "Target Azure Network Id.", + "type": "string" + }, + "selectedTfoAzureNetworkId": { + "description": "The Azure Network Id for test failover.", + "type": "string" + }, + "selectedSourceNicId": { + "description": "The selected source nic Id which will be used as the primary nic during failover.", + "type": "string" + }, + "enableRdpOnTargetOption": { + "description": "The selected option to enable RDP\\SSH on target vm after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum.", + "type": "string" + }, + "vmNics": { + "description": "The list of VM nic details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicInputDetails" + } + }, + "licenseType": { + "description": "License type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "recoveryAvailabilitySetId": { + "description": "The target availability set Id.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/UpdateReplicationProtectedItemProviderInput", + "description": "The provider specific input to update replication protected item." + } + } + }, + "UpdateReplicationProtectedItemProviderInput": { + "description": "Update replication protected item provider specific input.", + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "UpdateVCenterRequest": { + "description": "Input required to update vCenter.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateVCenterRequestProperties", + "description": "The update VCenter Request Properties." + } + } + }, + "UpdateVCenterRequestProperties": { + "description": "The properties of an update vCenter request.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The friendly name of the vCenter.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address of the vCenter to be discovered.", + "type": "string" + }, + "processServerId": { + "description": "The process server Id from where the update can be orchestrated.", + "type": "string" + }, + "port": { + "description": "The port number for discovery.", + "type": "string" + }, + "runAsAccountId": { + "description": "The CS account Id which has privileges to update the vCenter.", + "type": "string" + } + } + }, + "VaultHealthDetails": { + "description": "Vault health details definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/VaultHealthProperties", + "description": "The vault health related data." + } + } + }, + "VaultHealthProperties": { + "description": "class to define the health summary of the Vault.", + "type": "object", + "properties": { + "vaultErrors": { + "description": "The list of errors on the vault.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "protectedItemsHealth": { + "$ref": "#/definitions/ResourceHealthSummary", + "description": "The list of the health detail of the protected items in the vault." + }, + "fabricsHealth": { + "$ref": "#/definitions/ResourceHealthSummary", + "description": "The list of the health detail of the fabrics in the vault." + }, + "containersHealth": { + "$ref": "#/definitions/ResourceHealthSummary", + "description": "The list of the health detail of the containers in the vault." + } + } + }, + "VaultSetting": { + "description": "Vault setting.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/VaultSettingProperties", + "description": "The vault setting properties." + } + } + }, + "VaultSettingCollection": { + "description": "Vault setting collection.", + "type": "object", + "properties": { + "value": { + "description": "The list of vault setting.", + "type": "array", + "items": { + "$ref": "#/definitions/VaultSetting" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "VaultSettingCreationInput": { + "description": "Input to create vault setting.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/VaultSettingCreationInputProperties", + "description": "Vault setting creation input properties." + } + } + }, + "VaultSettingCreationInputProperties": { + "description": "Input to create vault setting.", + "required": [ + "migrationSolutionId" + ], + "type": "object", + "properties": { + "migrationSolutionId": { + "description": "The migration solution Id.", + "type": "string" + } + } + }, + "VaultSettingProperties": { + "description": "Vault setting properties.", + "type": "object", + "properties": { + "migrationSolutionId": { + "description": "The migration solution ARM Id.", + "type": "string" + } + } + }, + "VCenter": { + "description": "vCenter definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/VCenterProperties", + "description": "VCenter related data." + } + } + }, + "VCenterCollection": { + "description": "Collection of vCenter details.", + "type": "object", + "properties": { + "value": { + "description": "The vCenter details.", + "type": "array", + "items": { + "$ref": "#/definitions/VCenter" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "VCenterProperties": { + "description": "vCenter properties.", + "type": "object", + "properties": { + "friendlyName": { + "description": "Friendly name of the vCenter.", + "type": "string" + }, + "internalId": { + "description": "VCenter internal ID.", + "type": "string" + }, + "lastHeartbeat": { + "format": "date-time", + "description": "The time when the last heartbeat was received by vCenter.", + "type": "string" + }, + "discoveryStatus": { + "description": "The VCenter discovery status.", + "type": "string" + }, + "processServerId": { + "description": "The process server Id.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address of the vCenter.", + "type": "string" + }, + "infrastructureId": { + "description": "The infrastructure Id of vCenter.", + "type": "string" + }, + "port": { + "description": "The port number for discovery.", + "type": "string" + }, + "runAsAccountId": { + "description": "The account Id which has privileges to discover the vCenter.", + "type": "string" + }, + "fabricArmResourceName": { + "description": "The ARM resource name of the fabric containing this VCenter.", + "type": "string" + }, + "healthErrors": { + "description": "The health errors for this VCenter.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + } + } + }, + "VersionDetails": { + "description": "Version related details.", + "type": "object", + "properties": { + "version": { + "description": "The agent version.", + "type": "string" + }, + "expiryDate": { + "format": "date-time", + "description": "Version expiry date.", + "type": "string" + }, + "status": { + "description": "A value indicating whether security update required.", + "enum": [ + "Supported", + "NotSupported", + "Deprecated", + "UpdateRequired", + "SecurityUpdateRequired" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentVersionStatus", + "modelAsString": true + } + } + } + }, + "VirtualMachineTaskDetails": { + "description": "This class represents the virtual machine task details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobTaskDetails" + } + ], + "properties": { + "skippedReason": { + "description": "The skipped reason.", + "type": "string" + }, + "skippedReasonString": { + "description": "The skipped reason string.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VirtualMachineTaskDetails" + }, + "VmmDetails": { + "description": "VMM fabric specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificDetails" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VMM" + }, + "VmmToAzureCreateNetworkMappingInput": { + "description": "Create network mappings input properties/behavior specific to Vmm to Azure Network mapping.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificCreateNetworkMappingInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VmmToAzure" + }, + "VmmToAzureNetworkMappingSettings": { + "description": "E2A Network Mapping fabric specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkMappingFabricSpecificSettings" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VmmToAzure" + }, + "VmmToAzureUpdateNetworkMappingInput": { + "description": "Update network mappings input properties/behavior specific to vmm to azure.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificUpdateNetworkMappingInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VmmToAzure" + }, + "VmmToVmmCreateNetworkMappingInput": { + "description": "Create network mappings input properties/behavior specific to vmm to vmm Network mapping.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificCreateNetworkMappingInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VmmToVmm" + }, + "VmmToVmmNetworkMappingSettings": { + "description": "E2E Network Mapping fabric specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkMappingFabricSpecificSettings" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VmmToVmm" + }, + "VmmToVmmUpdateNetworkMappingInput": { + "description": "Update network mappings input properties/behavior specific to vmm to vmm.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificUpdateNetworkMappingInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VmmToVmm" + }, + "VmmVirtualMachineDetails": { + "description": "VMM fabric provider specific VM settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HyperVVirtualMachineDetails" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VmmVirtualMachine" + }, + "VMNicDetails": { + "description": "Hyper V VM network details.", + "type": "object", + "properties": { + "nicId": { + "description": "The nic Id.", + "type": "string" + }, + "replicaNicId": { + "description": "The replica nic Id.", + "type": "string" + }, + "sourceNicArmId": { + "description": "The source nic ARM Id.", + "type": "string" + }, + "vMNetworkName": { + "description": "VM network name.", + "type": "string" + }, + "recoveryVMNetworkId": { + "description": "Recovery VM network Id.", + "type": "string" + }, + "ipConfigs": { + "description": "The IP configurations of the NIC.", + "type": "array", + "items": { + "$ref": "#/definitions/IPConfigDetails" + } + }, + "selectionType": { + "description": "Selection type for failover.", + "type": "string" + }, + "recoveryNetworkSecurityGroupId": { + "description": "The id of the NSG associated with the NIC.", + "type": "string" + }, + "enableAcceleratedNetworkingOnRecovery": { + "description": "A value indicating whether the NIC has accelerated networking enabled.", + "type": "boolean" + }, + "tfoVMNetworkId": { + "description": "The network to be used by NIC during test failover.", + "type": "string" + }, + "tfoNetworkSecurityGroupId": { + "description": "The NSG to be used by NIC during test failover.", + "type": "string" + }, + "enableAcceleratedNetworkingOnTfo": { + "description": "Whether the TFO NIC has accelerated networking enabled.", + "type": "boolean" + }, + "recoveryNicName": { + "description": "The name of the NIC to be used when creating target NICs.", + "type": "string" + }, + "recoveryNicResourceGroupName": { + "description": "The resource group of the NIC to be used when creating target NICs.", + "type": "string" + }, + "reuseExistingNic": { + "description": "A value indicating whether an existing NIC is allowed to be reused during failover subject to availability.", + "type": "boolean", + "default": false + }, + "tfoRecoveryNicName": { + "description": "The name of the NIC to be used when creating target NICs in TFO.", + "type": "string" + }, + "tfoRecoveryNicResourceGroupName": { + "description": "The resource group of the NIC to be used when creating target NICs in TFO.", + "type": "string" + }, + "tfoReuseExistingNic": { + "description": "A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability.", + "type": "boolean", + "default": false + } + } + }, + "VMNicInputDetails": { + "description": "Hyper V VM network input details.", + "type": "object", + "properties": { + "nicId": { + "description": "The nic Id.", + "type": "string" + }, + "ipConfigs": { + "description": "The IP configurations to be used by NIC during test failover and failover.", + "type": "array", + "items": { + "$ref": "#/definitions/IPConfigInputDetails" + } + }, + "selectionType": { + "description": "Selection type for failover.", + "type": "string" + }, + "recoveryNetworkSecurityGroupId": { + "description": "The id of the NSG associated with the NIC.", + "type": "string" + }, + "enableAcceleratedNetworkingOnRecovery": { + "description": "Whether the NIC has accelerated networking enabled.", + "type": "boolean" + }, + "tfoNetworkSecurityGroupId": { + "description": "The NSG to be used by NIC during test failover.", + "type": "string" + }, + "enableAcceleratedNetworkingOnTfo": { + "description": "Whether the test NIC has accelerated networking enabled.", + "type": "boolean" + }, + "recoveryNicName": { + "description": "The name of the NIC to be used when creating target NICs.", + "type": "string" + }, + "recoveryNicResourceGroupName": { + "description": "The resource group of the NIC to be used when creating target NICs.", + "type": "string" + }, + "reuseExistingNic": { + "description": "A value indicating whether an existing NIC is allowed to be reused during failover subject to availability.", + "type": "boolean" + }, + "tfoNicName": { + "description": "The name of the NIC to be used when creating target NICs in TFO.", + "type": "string" + }, + "tfoNicResourceGroupName": { + "description": "The resource group of the NIC to be used when creating target NICs in TFO.", + "type": "string" + }, + "tfoReuseExistingNic": { + "description": "A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability.", + "type": "boolean" + } + } + }, + "VmNicUpdatesTaskDetails": { + "description": "This class represents the vm NicUpdates task details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskTypeDetails" + } + ], + "properties": { + "vmId": { + "description": "Virtual machine Id.", + "type": "string" + }, + "nicId": { + "description": "Nic Id.", + "type": "string" + }, + "name": { + "description": "Name of the Nic.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VmNicUpdatesTaskDetails" + }, + "VMwareCbtContainerCreationInput": { + "description": "VMwareCbt container creation input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificContainerCreationInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtContainerMappingInput": { + "description": "VMwareCbt container mapping input.", + "required": [ + "keyVaultId", + "keyVaultUri", + "storageAccountId", + "storageAccountSasSecretName", + "serviceBusConnectionStringSecretName", + "targetLocation" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificContainerMappingInput" + } + ], + "properties": { + "keyVaultId": { + "description": "The target key vault ARM Id.", + "type": "string" + }, + "keyVaultUri": { + "description": "The target key vault URL.", + "type": "string" + }, + "storageAccountId": { + "description": "The storage account ARM Id.", + "type": "string" + }, + "storageAccountSasSecretName": { + "description": "The secret name of the storage account.", + "type": "string" + }, + "serviceBusConnectionStringSecretName": { + "description": "The secret name of the service bus connection string.", + "type": "string" + }, + "targetLocation": { + "description": "The target location.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtDiskInput": { + "description": "VMwareCbt disk input.", + "required": [ + "diskId", + "isOSDisk", + "logStorageAccountId", + "logStorageAccountSasSecretName" + ], + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "diskType": { + "description": "The disk type.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + }, + "isOSDisk": { + "description": "A value indicating whether the disk is the OS disk.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string" + }, + "logStorageAccountSasSecretName": { + "description": "The key vault secret name of the log storage account.", + "type": "string" + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM Id.", + "type": "string" + } + } + }, + "VMwareCbtEnableMigrationInput": { + "description": "VMwareCbt specific enable migration input.", + "required": [ + "vmwareMachineId", + "disksToInclude", + "dataMoverRunAsAccountId", + "snapshotRunAsAccountId", + "targetResourceGroupId", + "targetNetworkId", + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnableMigrationProviderSpecificInput" + } + ], + "properties": { + "vmwareMachineId": { + "description": "The ARM Id of the VM discovered in VMware.", + "type": "string" + }, + "disksToInclude": { + "description": "The disks to include list.", + "minLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/VMwareCbtDiskInput" + } + }, + "licenseType": { + "description": "License type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "PAYG", + "AHUB" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true + } + }, + "dataMoverRunAsAccountId": { + "description": "The data mover run as account Id.", + "type": "string" + }, + "snapshotRunAsAccountId": { + "description": "The snapshot run as account Id.", + "type": "string" + }, + "targetVmName": { + "description": "The target VM name.", + "type": "string" + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "targetResourceGroupId": { + "description": "The target resource group ARM Id.", + "type": "string" + }, + "targetNetworkId": { + "description": "The target network ARM Id.", + "type": "string" + }, + "targetSubnetName": { + "description": "The target subnet name.", + "type": "string" + }, + "targetAvailabilitySetId": { + "description": "The target availability set ARM Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group ARM Id.", + "type": "string" + }, + "targetBootDiagnosticsStorageAccountId": { + "description": "The target boot diagnostics storage account ARM Id.", + "type": "string" + }, + "performAutoResync": { + "description": "A value indicating whether auto resync is to be done.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "seedDiskTags": { + "description": "The tags for the seed disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetDiskTags": { + "description": "The tags for the target disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtEventDetails": { + "description": "Event details for VMwareCbt provider.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "migrationItemName": { + "description": "The migration item name.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtMigrateInput": { + "description": "VMwareCbt specific migrate input.", + "required": [ + "performShutdown", + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MigrateProviderSpecificInput" + } + ], + "properties": { + "performShutdown": { + "description": "A value indicating whether VM is to be shutdown.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtMigrationDetails": { + "description": "VMwareCbt provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MigrationProviderSpecificSettings" + } + ], + "properties": { + "vmwareMachineId": { + "description": "The ARM Id of the VM discovered in VMware.", + "type": "string", + "readOnly": true + }, + "osType": { + "description": "The type of the OS on the VM.", + "type": "string", + "readOnly": true + }, + "firmwareType": { + "description": "The firmware type.", + "type": "string", + "readOnly": true + }, + "targetGeneration": { + "description": "The target generation.", + "type": "string", + "readOnly": true + }, + "licenseType": { + "description": "License Type of the VM to be used.", + "type": "string" + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "type": "string" + }, + "dataMoverRunAsAccountId": { + "description": "The data mover run as account Id.", + "type": "string", + "readOnly": true + }, + "snapshotRunAsAccountId": { + "description": "The snapshot run as account Id.", + "type": "string", + "readOnly": true + }, + "targetVmName": { + "description": "Target VM name.", + "type": "string" + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "targetLocation": { + "description": "The target location.", + "type": "string", + "readOnly": true + }, + "targetResourceGroupId": { + "description": "The target resource group Id.", + "type": "string" + }, + "targetAvailabilitySetId": { + "description": "The target availability set Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "targetBootDiagnosticsStorageAccountId": { + "description": "The target boot diagnostics storage account ARM Id.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "protectedDisks": { + "description": "The list of protected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/VMwareCbtProtectedDiskDetails" + } + }, + "targetNetworkId": { + "description": "The target network Id.", + "type": "string" + }, + "vmNics": { + "description": "The network details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMwareCbtNicDetails" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "migrationRecoveryPointId": { + "description": "The recovery point Id to which the VM was migrated.", + "type": "string", + "readOnly": true + }, + "lastRecoveryPointReceived": { + "format": "date-time", + "description": "The last recovery point received time.", + "type": "string", + "readOnly": true + }, + "lastRecoveryPointId": { + "description": "The last recovery point Id.", + "type": "string", + "readOnly": true + }, + "initialSeedingProgressPercentage": { + "format": "int32", + "description": "The initial seeding progress percentage.", + "type": "integer", + "readOnly": true + }, + "migrationProgressPercentage": { + "format": "int32", + "description": "The migration progress percentage.", + "type": "integer", + "readOnly": true + }, + "resyncProgressPercentage": { + "format": "int32", + "description": "The resync progress percentage.", + "type": "integer", + "readOnly": true + }, + "initialSeedingRetryCount": { + "format": "int64", + "description": "The initial seeding retry count.", + "type": "integer", + "readOnly": true + }, + "resyncRetryCount": { + "format": "int64", + "description": "The resync retry count.", + "type": "integer", + "readOnly": true + }, + "resyncRequired": { + "description": "A value indicating whether resync is required.", + "type": "string", + "readOnly": true + }, + "resyncState": { + "description": "The resync state.", + "enum": [ + "None", + "PreparedForResynchronization", + "StartedResynchronization" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ResyncState", + "modelAsString": true + } + }, + "performAutoResync": { + "description": "A value indicating whether auto resync is to be done.", + "type": "string" + }, + "seedDiskTags": { + "description": "The tags for the seed disks.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetDiskTags": { + "description": "The tags for the target disks.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtNicDetails": { + "description": "VMwareCbt NIC details.", + "type": "object", + "properties": { + "nicId": { + "description": "The NIC Id.", + "type": "string", + "readOnly": true + }, + "isPrimaryNic": { + "description": "A value indicating whether this is the primary NIC.", + "type": "string" + }, + "sourceIPAddress": { + "description": "The source IP address.", + "type": "string", + "readOnly": true + }, + "sourceIPAddressType": { + "description": "The source IP address type.", + "enum": [ + "Dynamic", + "Static" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "EthernetAddressType", + "modelAsString": true + } + }, + "sourceNetworkId": { + "description": "Source network Id.", + "type": "string", + "readOnly": true + }, + "targetIPAddress": { + "description": "The target IP address.", + "type": "string" + }, + "targetIPAddressType": { + "description": "The target IP address type.", + "enum": [ + "Dynamic", + "Static" + ], + "type": "string", + "x-ms-enum": { + "name": "EthernetAddressType", + "modelAsString": true + } + }, + "targetSubnetName": { + "description": "Target subnet name.", + "type": "string" + }, + "targetNicName": { + "description": "Target NIC name.", + "type": "string" + }, + "isSelectedForMigration": { + "description": "A value indicating whether this NIC is selected for migration.", + "type": "string" + } + } + }, + "VMwareCbtNicInput": { + "description": "VMwareCbt NIC input.", + "required": [ + "nicId", + "isPrimaryNic" + ], + "type": "object", + "properties": { + "nicId": { + "description": "The NIC Id.", + "type": "string" + }, + "isPrimaryNic": { + "description": "A value indicating whether this is the primary NIC.", + "type": "string" + }, + "targetSubnetName": { + "description": "Target subnet name.", + "type": "string" + }, + "targetStaticIPAddress": { + "description": "The static IP address.", + "type": "string" + }, + "isSelectedForMigration": { + "description": "A value indicating whether this NIC is selected for migration.", + "type": "string" + }, + "targetNicName": { + "description": "Target NIC name.", + "type": "string" + } + } + }, + "VMwareCbtPolicyCreationInput": { + "description": "VMware Cbt policy creation input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "recoveryPointHistoryInMinutes": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency (in minutes).", + "type": "integer" + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VmwareCbtPolicyDetails": { + "description": "VMware Cbt specific policy details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPointHistoryInMinutes": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency in minutes.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency in minutes.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtProtectedDiskDetails": { + "description": "VMwareCbt protected disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk id.", + "type": "string", + "readOnly": true + }, + "diskName": { + "description": "The disk name.", + "type": "string", + "readOnly": true + }, + "diskType": { + "description": "The disk type.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + }, + "diskPath": { + "description": "The disk path.", + "type": "string", + "readOnly": true + }, + "isOSDisk": { + "description": "A value indicating whether the disk is the OS disk.", + "type": "string", + "readOnly": true + }, + "capacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer", + "readOnly": true + }, + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string", + "readOnly": true + }, + "logStorageAccountSasSecretName": { + "description": "The key vault secret name of the log storage account.", + "type": "string", + "readOnly": true + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM Id.", + "type": "string", + "readOnly": true + }, + "seedManagedDiskId": { + "description": "The ARM Id of the seed managed disk.", + "type": "string", + "readOnly": true + }, + "targetManagedDiskId": { + "description": "The ARM Id of the target managed disk.", + "type": "string", + "readOnly": true + }, + "targetDiskName": { + "description": "The name for the target managed disk.", + "type": "string" + } + } + }, + "VMwareCbtProtectionContainerMappingDetails": { + "description": "VMwareCbt provider specific container mapping details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionContainerMappingProviderSpecificDetails" + } + ], + "properties": { + "keyVaultId": { + "description": "The target key vault ARM Id.", + "type": "string", + "readOnly": true + }, + "keyVaultUri": { + "description": "The target key vault URI.", + "type": "string", + "readOnly": true + }, + "storageAccountId": { + "description": "The storage account ARM Id.", + "type": "string", + "readOnly": true + }, + "storageAccountSasSecretName": { + "description": "The secret name of the storage account.", + "type": "string", + "readOnly": true + }, + "serviceBusConnectionStringSecretName": { + "description": "The secret name of the service bus connection string.", + "type": "string", + "readOnly": true + }, + "targetLocation": { + "description": "The target location.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtResyncInput": { + "description": "VMwareCbt specific resync input.", + "required": [ + "skipCbtReset", + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResyncProviderSpecificInput" + } + ], + "properties": { + "skipCbtReset": { + "description": "A value indicating whether CBT is to be reset.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtTestMigrateInput": { + "description": "VMwareCbt specific test migrate input.", + "required": [ + "recoveryPointId", + "networkId", + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TestMigrateProviderSpecificInput" + } + ], + "properties": { + "recoveryPointId": { + "description": "The recovery point Id.", + "type": "string" + }, + "networkId": { + "description": "The test network Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtUpdateDiskInput": { + "description": "VMwareCbt disk input for update.", + "required": [ + "diskId" + ], + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "targetDiskName": { + "description": "The target disk name.", + "type": "string" + } + } + }, + "VMwareCbtUpdateMigrationItemInput": { + "description": "VMwareCbt specific update migration item input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UpdateMigrationItemProviderSpecificInput" + } + ], + "properties": { + "targetVmName": { + "description": "The target VM name.", + "type": "string" + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "targetResourceGroupId": { + "description": "The target resource group ARM Id.", + "type": "string" + }, + "targetAvailabilitySetId": { + "description": "The target availability set ARM Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group ARM Id.", + "type": "string" + }, + "targetBootDiagnosticsStorageAccountId": { + "description": "The target boot diagnostics storage account ARM Id.", + "type": "string" + }, + "targetNetworkId": { + "description": "The target network ARM Id.", + "type": "string" + }, + "vmNics": { + "description": "The list of NIC details.", + "minLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/VMwareCbtNicInput" + } + }, + "vmDisks": { + "description": "The list of disk update properties.", + "minLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/VMwareCbtUpdateDiskInput" + } + }, + "licenseType": { + "description": "The license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "PAYG", + "AHUB" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true + } + }, + "performAutoResync": { + "description": "A value indicating whether auto resync is to be done.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetDiskTags": { + "description": "The tags for the target disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareDetails": { + "description": "Store the fabric details specific to the VMware fabric.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificDetails" + } + ], + "properties": { + "processServers": { + "description": "The list of Process Servers associated with the fabric.", + "type": "array", + "items": { + "$ref": "#/definitions/ProcessServer" + } + }, + "masterTargetServers": { + "description": "The list of Master Target servers associated with the fabric.", + "type": "array", + "items": { + "$ref": "#/definitions/MasterTargetServer" + } + }, + "runAsAccounts": { + "description": "The list of run as accounts created on the server.", + "type": "array", + "items": { + "$ref": "#/definitions/RunAsAccount" + } + }, + "replicationPairCount": { + "description": "The number of replication pairs configured in this CS.", + "type": "string" + }, + "processServerCount": { + "description": "The number of process servers.", + "type": "string" + }, + "agentCount": { + "description": "The number of source and target servers configured to talk to this CS.", + "type": "string" + }, + "protectedServers": { + "description": "The number of protected servers.", + "type": "string" + }, + "systemLoad": { + "description": "The percentage of the system load.", + "type": "string" + }, + "systemLoadStatus": { + "description": "The system load status.", + "type": "string" + }, + "cpuLoad": { + "description": "The percentage of the CPU load.", + "type": "string" + }, + "cpuLoadStatus": { + "description": "The CPU load status.", + "type": "string" + }, + "totalMemoryInBytes": { + "format": "int64", + "description": "The total memory.", + "type": "integer" + }, + "availableMemoryInBytes": { + "format": "int64", + "description": "The available memory.", + "type": "integer" + }, + "memoryUsageStatus": { + "description": "The memory usage status.", + "type": "string" + }, + "totalSpaceInBytes": { + "format": "int64", + "description": "The total space.", + "type": "integer" + }, + "availableSpaceInBytes": { + "format": "int64", + "description": "The available space.", + "type": "integer" + }, + "spaceUsageStatus": { + "description": "The space usage status.", + "type": "string" + }, + "webLoad": { + "description": "The web load.", + "type": "string" + }, + "webLoadStatus": { + "description": "The web load status.", + "type": "string" + }, + "databaseServerLoad": { + "description": "The database server load.", + "type": "string" + }, + "databaseServerLoadStatus": { + "description": "The database server load status.", + "type": "string" + }, + "csServiceStatus": { + "description": "The CS service status.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address.", + "type": "string" + }, + "agentVersion": { + "description": "The agent Version.", + "type": "string" + }, + "hostName": { + "description": "The host name.", + "type": "string" + }, + "lastHeartbeat": { + "format": "date-time", + "description": "The last heartbeat received from CS server.", + "type": "string" + }, + "versionStatus": { + "description": "Version status.", + "type": "string" + }, + "sslCertExpiryDate": { + "format": "date-time", + "description": "CS SSL cert expiry date.", + "type": "string" + }, + "sslCertExpiryRemainingDays": { + "format": "int32", + "description": "CS SSL cert expiry date.", + "type": "integer" + }, + "psTemplateVersion": { + "description": "PS template version.", + "type": "string" + }, + "agentExpiryDate": { + "format": "date-time", + "description": "Agent expiry date.", + "type": "string" + }, + "agentVersionDetails": { + "$ref": "#/definitions/VersionDetails", + "description": "The agent version details." + } + }, + "x-ms-discriminator-value": "VMware" + }, + "VMwareV2FabricCreationInput": { + "description": "VMwareV2 fabric provider specific settings.", + "required": [ + "migrationSolutionId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificCreationInput" + } + ], + "properties": { + "vmwareSiteId": { + "description": "The ARM Id of the VMware site.", + "type": "string" + }, + "physicalSiteId": { + "description": "The ARM Id of the physical site.", + "type": "string" + }, + "migrationSolutionId": { + "description": "The ARM Id of the migration solution.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VMwareV2" + }, + "VMwareV2FabricSpecificDetails": { + "description": "VMwareV2 fabric specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificDetails" + } + ], + "properties": { + "vmwareSiteId": { + "description": "The ARM Id of the VMware site.", + "type": "string", + "readOnly": true + }, + "physicalSiteId": { + "description": "The ARM Id of the physical site.", + "type": "string", + "readOnly": true + }, + "migrationSolutionId": { + "description": "The Migration solution ARM Id.", + "type": "string", + "readOnly": true + }, + "serviceEndpoint": { + "description": "The service endpoint.", + "type": "string", + "readOnly": true + }, + "serviceResourceId": { + "description": "The service resource Id.", + "type": "string", + "readOnly": true + }, + "serviceContainerId": { + "description": "The service container Id.", + "type": "string", + "readOnly": true + }, + "processServers": { + "description": "The list of process servers.", + "type": "array", + "items": { + "$ref": "#/definitions/ProcessServerDetails" + }, + "readOnly": true + } + }, + "x-ms-discriminator-value": "VMwareV2" + }, + "VMwareVirtualMachineDetails": { + "description": "VMware provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConfigurationSettings" + } + ], + "properties": { + "agentGeneratedId": { + "description": "The ID generated by the InMage agent after it gets installed on guest. This is the ID to be used during InMage CreateProtection.", + "type": "string" + }, + "agentInstalled": { + "description": "The value indicating if InMage scout agent is installed on guest.", + "type": "string" + }, + "osType": { + "description": "The OsType installed on VM.", + "type": "string" + }, + "agentVersion": { + "description": "The agent version.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address.", + "type": "string" + }, + "poweredOn": { + "description": "The value indicating whether VM is powered on.", + "type": "string" + }, + "vCenterInfrastructureId": { + "description": "The VCenter infrastructure Id.", + "type": "string" + }, + "discoveryType": { + "description": "A value indicating the discovery type of the machine. Value can be vCenter or physical.", + "type": "string" + }, + "diskDetails": { + "description": "The disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageDiskDetails" + } + }, + "validationErrors": { + "description": "The validation errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + } + }, + "x-ms-discriminator-value": "VMwareVirtualMachine" + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription Id.", + "required": true, + "type": "string" + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group where the recovery services vault is present.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ResourceName": { + "name": "resourceName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account." + }, + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "tags": [] +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/MigrationRecoveryPoints_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/MigrationRecoveryPoints_Get.json new file mode 100644 index 000000000000..8f4b662c93d7 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/MigrationRecoveryPoints_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "migrationRecoveryPointName": "b22134ea-620c-474b-9fa5-3c1cb47708e3", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef" + }, + "responses": { + "200": { + "body": { + "name": "b22134ea-620c-474b-9fa5-3c1cb47708e3", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems/migrationRecoveryPoints", + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1/migrationRecoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "properties": { + "recoveryPointTime": "2017-04-26T06:37:50.8082715Z", + "recoveryPointType": "CrashConsistent" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/MigrationRecoveryPoints_ListByReplicationMigrationItems.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/MigrationRecoveryPoints_ListByReplicationMigrationItems.json new file mode 100644 index 000000000000..ada75e8a1cce --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/MigrationRecoveryPoints_ListByReplicationMigrationItems.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "648336ef-2d70-4d98-b100-8c299f97cd41", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems/migrationRecoveryPoints", + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1/migrationRecoveryPoints/648336ef-2d70-4d98-b100-8c299f97cd41", + "properties": { + "recoveryPointTime": "2017-04-26T06:37:50.8082715Z", + "recoveryPointType": "CrashConsistent" + } + }, + { + "name": "34cb2d05-e730-4d3f-b96b-a60a5e92acb2", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems/migrationRecoveryPoints", + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1/migrationRecoveryPoints/34cb2d05-e730-4d3f-b96b-a60a5e92acb2", + "properties": { + "recoveryPointTime": "2017-04-26T07:37:30.9722019Z", + "recoveryPointType": "CrashConsistent" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Operations_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Operations_List.json new file mode 100644 index 000000000000..3511ba9236a3 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/Operations_List.json @@ -0,0 +1,1225 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.RecoveryServices/Vaults/vaultTokens/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Vault Token", + "description": "The Vault Token operation can be used to get Vault Token for vault level backend operations." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/registeredIdentities/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Register Service Container", + "description": "The Register Service Container operation can be used to register a container with Recovery Service." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/registeredIdentities/operationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Get Operation Results", + "description": "The Get Operation Results operation can be used get the operation status and result for the asynchronously submitted operation" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/registeredIdentities/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Get Containers", + "description": "The Get Containers operation can be used get the containers registered for a resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/registeredIdentities/delete", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Unregister Service Container", + "description": "The UnRegister Container operation can be used to unregister a container." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/certificates/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Update Resource Certificate", + "description": "The Update Resource Certificate operation updates the resource/vault credential certificate." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationAlertSettings/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Alerts Settings", + "operation": "Read Alerts Settings", + "description": "Read Any Alerts Settings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationAlertSettings/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Alerts Settings", + "operation": "Create or Update Alerts Settings", + "description": "Create or Update Any Alerts Settings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationEvents/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Events", + "operation": "Read Events", + "description": "Read Any Events" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Networks", + "operation": "Read Networks", + "description": "Read Any Networks" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Network Mappings", + "operation": "Read Network Mappings", + "description": "Read Any Network Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Network Mappings", + "operation": "Create or Update Network Mappings", + "description": "Create or Update Any Network Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Network Mappings", + "operation": "Delete Network Mappings", + "description": "Delete Any Network Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectableItems/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protectable Items", + "operation": "Read Protectable Items", + "description": "Read Any Protectable Items" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Container Mappings", + "operation": "Read Protection Container Mappings", + "description": "Read Any Protection Container Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Container Mappings", + "operation": "Create or Update Protection Container Mappings", + "description": "Create or Update Any Protection Container Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings/remove/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Container Mappings", + "operation": "Remove Protection Container Mapping", + "description": "Remove Protection Container Mapping" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Container Mappings", + "operation": "Delete Protection Container Mappings", + "description": "Delete Any Protection Container Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/recoveryPoints/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Replication Recovery Points", + "operation": "Read Replication Recovery Points", + "description": "Read Any Replication Recovery Points" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Read Protected Items", + "description": "Read Any Protected Items" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Create or Update Protected Items", + "description": "Create or Update Any Protected Items" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Delete Protected Items", + "description": "Delete Any Protected Items" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/remove/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Remove Protected Item", + "description": "Remove Protected Item" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/plannedFailover/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Planned Failover", + "description": "Planned Failover" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/unplannedFailover/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Failover", + "description": "Failover" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/testFailover/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Test Failover", + "description": "Test Failover" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/testFailoverCleanup/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Test Failover Cleanup", + "description": "Test Failover Cleanup" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/failoverCommit/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Failover Commit", + "description": "Failover Commit" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/reProtect/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "ReProtect Protected Item", + "description": "ReProtect Protected Item" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/updateMobilityService/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Update Mobility Service", + "description": "Update Mobility Service" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/repairReplication/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Repair replication", + "description": "Repair replication" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/applyRecoveryPoint/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protected Items", + "operation": "Apply Recovery Point", + "description": "Apply Recovery Point" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationJobs/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Jobs", + "operation": "Read Jobs", + "description": "Read Any Jobs" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationJobs/cancel/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Jobs", + "operation": "Cancel Job", + "description": "Cancel Job" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationJobs/restart/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Jobs", + "operation": "Restart job", + "description": "Restart job" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationJobs/resume/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Jobs", + "operation": "Resume Job", + "description": "Resume Job" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Containers", + "operation": "Read Protection Containers", + "description": "Read Any Protection Containers" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/discoverProtectableItem/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Containers", + "operation": "Discover Protectable Item", + "description": "Discover Protectable Item" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Containers", + "operation": "Create or Update Protection Containers", + "description": "Create or Update Any Protection Containers" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/remove/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Containers", + "operation": "Remove Protection Container", + "description": "Remove Protection Container" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/switchprotection/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Protection Containers", + "operation": "Switch Protection Container", + "description": "Switch Protection Container" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationPolicies/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Policies", + "operation": "Read Policies", + "description": "Read Any Policies" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationPolicies/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Policies", + "operation": "Create or Update Policies", + "description": "Create or Update Any Policies" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationPolicies/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Policies", + "operation": "Delete Policies", + "description": "Delete Any Policies" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Read Recovery Plans", + "description": "Read Any Recovery Plans" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Create or Update Recovery Plans", + "description": "Create or Update Any Recovery Plans" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Delete Recovery Plans", + "description": "Delete Any Recovery Plans" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/plannedFailover/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Planned Failover Recovery Plan", + "description": "Planned Failover Recovery Plan" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/unplannedFailover/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Failover Recovery Plan", + "description": "Failover Recovery Plan" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/testFailover/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Test Failover Recovery Plan", + "description": "Test Failover Recovery Plan" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/testFailoverCleanup/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Test Failover Cleanup Recovery Plan", + "description": "Test Failover Cleanup Recovery Plan" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/failoverCommit/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "Failover Commit Recovery Plan", + "description": "Failover Commit Recovery Plan" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans/reProtect/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Plans", + "operation": "ReProtect Recovery Plan", + "description": "ReProtect Recovery Plan" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Services Providers", + "operation": "Read Recovery Services Providers", + "description": "Read Any Recovery Services Providers" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders/remove/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Services Providers", + "operation": "Remove Recovery Services Provider", + "description": "Remove Recovery Services Provider" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Services Providers", + "operation": "Delete Recovery Services Providers", + "description": "Delete Any Recovery Services Providers" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders/refreshProvider/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Recovery Services Providers", + "operation": "Refresh Provider", + "description": "Refresh Provider" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Read Fabrics", + "description": "Read Any Fabrics" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Create or Update Fabrics", + "description": "Create or Update Any Fabrics" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/remove/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Remove Fabric", + "description": "Remove Fabric" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/checkConsistency/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Checks Consistency of the Fabric", + "description": "Checks Consistency of the Fabric" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Delete Fabrics", + "description": "Delete Any Fabrics" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/renewcertificate/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Renew Certificate for Fabric", + "description": "Renew Certificate for Fabric" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/deployProcessServerImage/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Deploy Process Server Image", + "description": "Deploy Process Server Image" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/reassociateGateway/action", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Fabrics", + "operation": "Reassociate Gateway", + "description": "Reassociate Gateway" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Storage Classifications", + "operation": "Read Storage Classifications", + "description": "Read Any Storage Classifications" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Storage Classification Mappings", + "operation": "Read Storage Classification Mappings", + "description": "Read Any Storage Classification Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Storage Classification Mappings", + "operation": "Create or Update Storage Classification Mappings", + "description": "Create or Update Any Storage Classification Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Storage Classification Mappings", + "operation": "Delete Storage Classification Mappings", + "description": "Delete Any Storage Classification Mappings" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/usages/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Vault Usages", + "operation": "Read Vault Usages", + "description": "Read Any Vault Usages" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters/read", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Jobs", + "operation": "Read Jobs", + "description": "Read Any Jobs" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters/write", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Jobs", + "operation": "Create or Update Jobs", + "description": "Create or Update Any Jobs" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters/delete", + "display": { + "provider": "Microsoft Recovery Services", + "resource": "Jobs", + "operation": "Delete Jobs", + "description": "Delete Any Jobs" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/usages/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vault Usage", + "operation": "Recovery Services Vault usage details.", + "description": "Returns usage details for a Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupUsageSummaries/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Usages Summaries", + "operation": "Recovery Services Protected Items and Protected Servers usage summaries details.", + "description": "Returns summaries for Protected Items and Protected Servers for a Recovery Services ." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/storageConfig/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vault Storage Config", + "operation": "Get Resource Storage Config", + "description": "Returns Storage Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/storageConfig/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vault Storage Config", + "operation": "Write Resource Storage Config", + "description": "Updates Storage Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupconfig/vaultconfig/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vault Config", + "operation": "Get Resource Config", + "description": "Returns Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupconfig/vaultconfig/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vault Config", + "operation": "Update Resource Config", + "description": "Updates Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/tokenInfo/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Token Info", + "operation": "Get Vault Token Info", + "description": "Returns token information for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupSecurityPIN/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "SecurityPINInfo", + "operation": "Get Security PIN Info", + "description": "Returns Security PIN Information for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupManagementMetaData/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Management Metadata", + "operation": "Get Backup Management Metadata", + "description": "Returns Backup Management Metadata for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupOperationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Operation Results", + "operation": "Get Backup Operation Result", + "description": "Returns Backup Operation Result for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupOperations/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Operation Status", + "operation": "Get Backup Operation Status", + "description": "Returns Backup Operation Status for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupJobs/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Jobs", + "operation": "Get Jobs", + "description": "Returns all Job Objects" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupJobs/cancel/action", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Jobs", + "operation": "Cancel Jobs", + "description": "Cancel the Job" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupJobsExport/action", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Export Backup Jobs", + "operation": "Export Jobs", + "description": "Export Jobs" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupJobs/operationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Jobs Operation Results", + "operation": "Get Job Operation Result", + "description": "Returns the Result of Job Operation." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupJobsExport/operationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Export Backup Jobs Operation Results", + "operation": "Get Export Job Operation Result", + "description": "Returns the Result of Export Job Operation." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Recovery Points", + "operation": "Get Recovery Points", + "description": "Get Recovery Points for Protected Items." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/restore/action", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Recovery Points", + "operation": "Restore Recovery Points", + "description": "Restore Recovery Points for Protected Items." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/provisionInstantItemRecovery/action", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Recovery Points", + "operation": "Provision Instant Item Recovery for Protected Item", + "description": "Provision Instant Item Recovery for Protected Item" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/revokeInstantItemRecovery/action", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Recovery Points", + "operation": "Revoke Instant Item Recovery for Protected Item", + "description": "Revoke Instant Item Recovery for Protected Item" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupPolicies/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Policies", + "operation": "Get Protection Policy", + "description": "Returns all Protection Policies" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupPolicies/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Policies", + "operation": "Create Protection Policy", + "description": "Creates Protection Policy" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupPolicies/delete", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Policies", + "operation": "Delete Protection Policy", + "description": "Delete a Protection Policy" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupPolicies/operationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Policy Operation Results", + "operation": "Get Policy Operation Results", + "description": "Get Results of Policy Operation." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupPolicies/operationStatus/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Policy Operation Status", + "operation": "Get Policy Operation Status", + "description": "Get Status of Policy Operation." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protected Items", + "operation": "Get Protected Item Details", + "description": "Returns object details of the Protected Item" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupProtectedItems/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protected Items", + "operation": "Get All Protected Items", + "description": "Returns the list of all Protected Items." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protected Items", + "operation": "Create Backup Protected Item", + "description": "Create a backup Protected Item" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/delete", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protected Items", + "operation": "Delete Protected Items", + "description": "Deletes Protected Item" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/operationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protected Item Operation Results", + "operation": "Get Protected Items Operation Results", + "description": "Gets Result of Operation Performed on Protected Items." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/operationStatus/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protected Item Operation Status", + "operation": "Get Protected Items operation status", + "description": "Returns the status of Operation performed on Protected Items." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/protectedItems/backup/action", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protected Items", + "operation": "Backup Protected Item", + "description": "Performs Backup for Protected Item." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupProtectableItems/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Protectable Items", + "operation": "Get Protectable Items", + "description": "Returns list of all Protectable Items." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/refreshContainers/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Refresh Containers", + "operation": "Refresh container", + "description": "Refreshes the container list" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/operationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Refresh Containers Operation Results", + "operation": "Get Operation Results", + "description": "Returns status of the operation" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupProtectionContainers/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Protection Containers", + "operation": "Get Containers In Subscription", + "description": "Returns all containers belonging to the subscription" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protection Containers", + "operation": "Get Registered Container", + "description": "Returns all registered containers" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupFabrics/protectionContainers/operationResults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Protection Containers Operation Results", + "operation": "Get Container Operation Results", + "description": "Gets result of Operation performed on Protection Container." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupEngines", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Engines", + "operation": "List of backup management servers.", + "description": "Returns all the backup management servers registered with vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupStatus", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Backup Status", + "operation": "Check Backup Status for Vault", + "description": "Check Backup Status for Recovery Services Vaults" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Create Vault", + "description": "Create Vault operation creates an Azure resource of type 'vault'" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Get Vault", + "description": "The Get Vault operation gets an object representing the Azure resource of type 'vault'" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/delete", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Delete Vault", + "description": "The Delete Vault operation deletes the specified Azure resource of type 'vault'" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/extendedInformation/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Get Extended Info", + "description": "The Get Extended Info operation gets an object's Extended Info representing the Azure resource of type ?vault?" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/extendedInformation/write", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Get Extended Info", + "description": "The Get Extended Info operation gets an object's Extended Info representing the Azure resource of type ?vault?" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/extendedInformation/delete", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "Vaults", + "operation": "Get Extended Info", + "description": "The Get Extended Info operation gets an object's Extended Info representing the Azure resource of type ?vault?" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/locations/allocatedStamp/read", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "locations/allocatedStamp", + "operation": "Get Allocated Stamp", + "description": "GetAllocatedStamp is internal operation used by service" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/locations/allocateStamp/action", + "display": { + "provider": "Microsoft.RecoveryServices", + "resource": "locations/allocateStamp", + "operation": "Allocated Stamp Action", + "description": "AllocateStamp is internal operation used by service" + }, + "origin": "user" + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/RecoveryPoints_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/RecoveryPoints_Get.json new file mode 100644 index 000000000000..d1955a1afe4d --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/RecoveryPoints_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPointName": "b22134ea-620c-474b-9fa5-3c1cb47708e3" + }, + "responses": { + "200": { + "body": { + "name": "b22134ea-620c-474b-9fa5-3c1cb47708e3", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/recoveryPoints", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "properties": { + "recoveryPointTime": "2017-04-26T06:37:50.8082715Z", + "recoveryPointType": "CrashConsistent" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/RecoveryPoints_ListByReplicationProtectedItems.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/RecoveryPoints_ListByReplicationProtectedItems.json new file mode 100644 index 000000000000..25f7d0040890 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/RecoveryPoints_ListByReplicationProtectedItems.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "b22134ea-620c-474b-9fa5-3c1cb47708e3", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/recoveryPoints", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "properties": { + "recoveryPointTime": "2017-04-26T06:37:50.8082715Z", + "recoveryPointType": "CrashConsistent" + } + }, + { + "name": "34cb2d05-e730-4d3f-b96b-a60a5e92acb2", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/recoveryPoints", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/34cb2d05-e730-4d3f-b96b-a60a5e92acb2", + "properties": { + "recoveryPointTime": "2017-04-26T07:37:30.9722019Z", + "recoveryPointType": "CrashConsistent" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationAlertSettings_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationAlertSettings_Create.json new file mode 100644 index 000000000000..d16c32ae8eaa --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationAlertSettings_Create.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "alertSettingName": "defaultAlertSetting", + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "request": { + "properties": { + "sendToOwners": "false", + "customEmailAddresses": [ + "ronehr@microsoft.com" + ], + "locale": "" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationAlertSettings", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationAlertSettings/defaultAlertSetting", + "name": "defaultAlertSetting", + "properties": { + "sendToOwners": "false", + "customEmailAddresses": [ + "ronehr@microsoft.com" + ], + "locale": "en-US" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationAlertSettings_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationAlertSettings_Get.json new file mode 100644 index 000000000000..e05443316d0c --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationAlertSettings_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "alertSettingName": "defaultAlertSetting", + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationAlertSettings", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationAlertSettings/defaultAlertSetting", + "name": "defaultAlertSetting", + "properties": { + "sendToOwners": "false", + "customEmailAddresses": [ + "ronehr@microsoft.com" + ], + "locale": "en-US" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationAlertSettings_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationAlertSettings_List.json new file mode 100644 index 000000000000..8a5fb77447d2 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationAlertSettings_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationAlertSettings", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationAlertSettings/defaultAlertSetting", + "name": "defaultAlertSetting", + "properties": { + "sendToOwners": "false", + "customEmailAddresses": [ + "ronehr@microsoft.com" + ], + "locale": "en-US" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationEligibilityResults_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationEligibilityResults_Get.json new file mode 100644 index 000000000000..eb25b1f7c283 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationEligibilityResults_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "virtualMachineName": "testVm1", + "resourceGroupName": "testRg1", + "subscriptionId": "d90d145a-4cdd-45a3-b2c4-971d69775278" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.RecoveryServices/replicationEligibilityResults", + "id": "/subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/testRg1/providers/Microsoft.Compute/virtualMachines/testVm1/providers/Microsoft.RecoveryServices/replicationEligibilityResults/default", + "properties": { + "clientRequestId": "7d72ade7-b9f7-4d9b-8a19-15d9728c6190", + "errors": [ + { + "code": "A2AOperatingSystemNotSupported", + "message": "The A2A operation could not be completed as the virtual machine is running OS 'ubuntu' with version '18.04' which is not supported for replication.", + "possibleCauses": "OS version not supported.", + "recommendedAction": "The virtual machine is running unsupported Operating system. Refer to the documentation for supported OS versions - https://aka.ms/a2a-os-support-matrix.", + "status": "Error" + } + ] + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationEligibilityResults_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationEligibilityResults_List.json new file mode 100644 index 000000000000..9b2d3ad91f2a --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationEligibilityResults_List.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "virtualMachineName": "testVm2", + "resourceGroupName": "testRg1", + "subscriptionId": "d90d145a-4cdd-45a3-b2c4-971d69775278" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.RecoveryServices/replicationEligibilityResults", + "id": "/subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/testRg1/providers/Microsoft.Compute/virtualMachines/testVm2/providers/Microsoft.RecoveryServices/replicationEligibilityResults/default", + "properties": { + "clientRequestId": "a62c81df-e26e-47ea-ab4b-f1fcc1e5b135", + "errors": [ + { + "code": "AzureVmIsNotInDesiredProvisioningState", + "message": "Azure virtual machine with Id (/subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/testRg1/providers/Microsoft.Compute/virtualMachines/testVm2) is with provisioning state 'failed'. To enable replication, VM's provisioning state should be 'succeeded'.", + "possibleCauses": "Virtual machine is not in desired state.", + "recommendedAction": "\n Ensure that the VM's provisioning state is 'succeeded'.\n Refer to https://aka.ms/a2a-vm-state-issues to troubleshoot VM provisioning state issues.\n ", + "status": "Error" + }, + { + "code": "AzureVmIsNotInDesiredPowerState", + "message": "Azure virtual machine with Id (/subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/testRg1/providers/Microsoft.Compute/virtualMachines/testVm2) is with power status 'deallocated'. To enable replication, VM's power status should be 'running'.", + "possibleCauses": "Virtual machine is not in desired state.", + "recommendedAction": "\n Ensure that the VM's power status is 'running'.\n You can check the power status in 'VM > Settings > Properties > Status' in Azure portal.\n ", + "status": "Error" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationEvents_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationEvents_Get.json new file mode 100644 index 000000000000..2ca14d9675a2 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationEvents_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "eventName": "654b71d0-b2ce-4e6e-a861-98528d4bd375", + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationEvents", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationEvents/VmMonitoringEvent;9091989947769704276_516de684-0079-48f7-b44b-882923268654", + "name": "VmMonitoringEvent;9091989947769704276_516de684-0079-48f7-b44b-882923268654", + "properties": { + "eventCode": "d9a07b07-c7b5-49ca-ab6c-6926596dfe47", + "description": "Virtual machine health is OK", + "eventType": "VmHealth", + "affectedObjectFriendlyName": "vm1", + "severity": "OK", + "timeOfOccurrence": "2017-05-02T14:28:28.5071531Z", + "fabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "eventSpecificDetails": { + "instanceType": "JobStatus" + }, + "healthErrors": [] + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationEvents_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationEvents_List.json new file mode 100644 index 000000000000..a881af27a6fd --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationEvents_List.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationEvents", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationEvents/JobStatusMonitoringEvent;9091989892524070155_4ed6f1a6-9b6d-4048-9079-1307dd24b814", + "name": "JobStatusMonitoringEvent;9091989892524070155_4ed6f1a6-9b6d-4048-9079-1307dd24b814", + "properties": { + "eventCode": "d32574f6-f59e-4545-b5ac-bc88d545f089", + "description": "TestFailover - Failed", + "eventType": "JobStatus", + "affectedObjectFriendlyName": "vm1", + "severity": "Critical", + "timeOfOccurrence": "2017-05-02T16:00:33.0705652Z", + "fabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "eventSpecificDetails": { + "instanceType": "JobStatus" + }, + "healthErrors": [ + { + "errorCode": "499", + "errorMessage": "An internal error occurred.", + "possibleCauses": "The operation failed due to an internal error.", + "recommendedAction": "Retry the last action. If the issue persists, contact Support." + } + ] + } + }, + { + "type": "Microsoft.RecoveryServices/vaults/replicationEvents", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationEvents/VmMonitoringEvent;9091989947769704276_516de684-0079-48f7-b44b-882923268654", + "name": "VmMonitoringEvent;9091989947769704276_516de684-0079-48f7-b44b-882923268654", + "properties": { + "eventCode": "d9a07b07-c7b5-49ca-ab6c-6926596dfe47", + "description": "Virtual machine health is OK", + "eventType": "VmHealth", + "affectedObjectFriendlyName": "vm1", + "severity": "OK", + "timeOfOccurrence": "2017-05-02T14:28:28.5071531Z", + "fabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "eventSpecificDetails": { + "instanceType": "JobStatus" + }, + "healthErrors": [] + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationFabrics_CheckConsistency.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationFabrics_CheckConsistency.json new file mode 100644 index 000000000000..a8b52646831f --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationFabrics_CheckConsistency.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "name": "cloud1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "properties": { + "friendlyName": "cloud1", + "encryptionDetails": { + "kekState": "None" + }, + "rolloverEncryptionDetails": { + "kekState": "None" + }, + "internalIdentifier": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "bcdrState": "Valid", + "customDetails": { + "instanceType": "HyperVSite" + }, + "healthErrorDetails": [], + "health": "Normal" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationFabrics_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationFabrics_Create.json new file mode 100644 index 000000000000..f342df6d225c --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationFabrics_Create.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "input": { + "properties": { + "customDetails": { + "instanceType": "FabricSpecificCreationInput" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "cloud1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "properties": { + "friendlyName": "cloud1", + "encryptionDetails": { + "kekState": "None" + }, + "rolloverEncryptionDetails": { + "kekState": "None" + }, + "internalIdentifier": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "bcdrState": "Valid", + "customDetails": { + "instanceType": "HyperVSite" + }, + "healthErrorDetails": [], + "health": "Normal" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationFabrics_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationFabrics_Delete.json new file mode 100644 index 000000000000..45c279e5656f --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationFabrics_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationFabrics_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationFabrics_Get.json new file mode 100644 index 000000000000..1f3e61ebe2d6 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationFabrics_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "name": "cloud1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "properties": { + "friendlyName": "cloud1", + "encryptionDetails": { + "kekState": "None" + }, + "rolloverEncryptionDetails": { + "kekState": "None" + }, + "internalIdentifier": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "bcdrState": "Valid", + "customDetails": { + "instanceType": "HyperVSite" + }, + "healthErrorDetails": [], + "health": "Normal" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationFabrics_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationFabrics_List.json new file mode 100644 index 000000000000..e98bd674aa43 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationFabrics_List.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "cloud1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "properties": { + "friendlyName": "cloud1", + "encryptionDetails": { + "kekState": "None" + }, + "rolloverEncryptionDetails": { + "kekState": "None" + }, + "internalIdentifier": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "bcdrState": "Valid", + "customDetails": { + "instanceType": "HyperVSite" + }, + "healthErrorDetails": [], + "health": "Normal" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationFabrics_MigrateToAad.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationFabrics_MigrateToAad.json new file mode 100644 index 000000000000..45c279e5656f --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationFabrics_MigrateToAad.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationFabrics_Purge.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationFabrics_Purge.json new file mode 100644 index 000000000000..45c279e5656f --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationFabrics_Purge.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationFabrics_ReassociateGateway.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationFabrics_ReassociateGateway.json new file mode 100644 index 000000000000..5bf7b5c70017 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationFabrics_ReassociateGateway.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "fabricName": "GRACE-V2A-1", + "api-version": "2021-06-01", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574", + "failoverProcessServerRequest": { + "properties": { + "containerName": "cloud_1f3c15af-2256-4568-9e06-e1ef4f728f75", + "sourceProcessServerId": "AFA0EC54-1894-4E44-9CAB02DB8854B117", + "targetProcessServerId": "5D3ED340-85AE-C646-B338641E015DA405", + "vmsToMigrate": [ + "Vm1", + "Vm2" + ], + "updateType": "ServerLevel" + } + } + }, + "responses": { + "200": { + "body": { + "name": "bc15edf300344660d9c2965f5d9225593d99734f6580613c997033abc3512a56", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics", + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationFabrics/bc15edf300344660d9c2965f5d9225593d99734f6580613c997033abc3512a56", + "properties": { + "friendlyName": "GRACE-V2A-1", + "encryptionDetails": { + "kekState": "None" + }, + "rolloverEncryptionDetails": { + "kekState": "None" + }, + "internalIdentifier": "1f3c15af-2256-4568-9e06-e1ef4f728f75", + "bcdrState": "Valid", + "customDetails": { + "instanceType": "VMware" + }, + "healthErrorDetails": [], + "health": "Normal" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationFabrics_RenewCertificate.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationFabrics_RenewCertificate.json new file mode 100644 index 000000000000..938aa641e388 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationFabrics_RenewCertificate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "renewCertificate": { + "properties": { + "renewCertificateType": "Cloud" + } + } + }, + "responses": { + "200": { + "body": { + "name": "cloud1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "properties": { + "friendlyName": "cloud1", + "encryptionDetails": { + "kekState": "None" + }, + "rolloverEncryptionDetails": { + "kekState": "None" + }, + "internalIdentifier": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "bcdrState": "Valid", + "customDetails": { + "instanceType": "HyperVSite" + }, + "healthErrorDetails": [], + "health": "Normal" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationJobs_Cancel.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationJobs_Cancel.json new file mode 100644 index 000000000000..4ac6d7451ebd --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationJobs_Cancel.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "jobName": "2653c648-fc72-4316-86f3-fdf8eaa0066b", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/2653c648-fc72-4316-86f3-fdf8eaa0066b", + "name": "2653c648-fc72-4316-86f3-fdf8eaa0066b", + "properties": { + "activityId": "bfbbf6dd-9cbb-4cbc-98a6-faecc8891579 ActivityId: 07cc35ca-b63f-4e42-83c9-81ae0191c322", + "scenarioName": "PlannedFailover", + "friendlyName": "Planned failover", + "state": "Cancelling", + "stateDescription": "Cancelling", + "tasks": [], + "errors": [], + "startTime": "2017-05-03T06:16:06.3235186Z", + "allowedActions": [], + "targetObjectId": "f8491e4f-817a-40dd-a90c-af773978c75b", + "targetObjectName": "vm1", + "targetInstanceType": "ProtectionEntity", + "customDetails": { + "instanceType": "AsrJobDetails", + "affectedObjectDetails": { + "PrimaryVmId": "f8491e4f-817a-40dd-a90c-af773978c75b", + "PrimaryVmName": "vm1", + "RecoveryVmId": "", + "RecoveryVmName": "vm1", + "ProtectionProfileId": "af095a1e-1f1b-5365-87c9-99162ebcfaf0", + "PrimaryCloudId": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "PrimaryCloudName": "cloud1", + "RecoveryCloudId": "d38048d4-b460-4791-8ece-108395ee8478", + "RecoveryCloudName": "Microsoft Azure", + "PrimaryVmmId": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "PrimaryVmmName": "cloud1", + "RecoveryVmmId": "21a9403c-6ec1-44f2-b744-b4e50b792387", + "RecoveryVmmName": "Microsoft Azure", + "PrimaryFabricProviderId": "HyperVSite", + "RecoveryFabricProviderId": "Azure" + } + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationJobs_Export.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationJobs_Export.json new file mode 100644 index 000000000000..52eba4cc88af --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationJobs_Export.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "jobQueryParameter": { + "startTime": "2017-04-27T14:26:51.9161395Z", + "endTime": "2017-05-04T14:26:51.9161395Z", + "affectedObjectTypes": "", + "jobStatus": "" + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/37e0fc2b-13f2-4817-aafa-0cd807d46842", + "name": "37e0fc2b-13f2-4817-aafa-0cd807d46842", + "properties": { + "activityId": "36841d27-34f6-49ad-b572-e7dc263f100b-2017-05-04 14:26:47Z-Ibz ActivityId: c124df21-7661-4541-b32a-3c723ebbb045", + "scenarioName": "ExportJobs", + "state": "Succeeded", + "stateDescription": "Completed", + "tasks": [], + "errors": [], + "startTime": "2017-05-04T14:33:42.2765562Z", + "endTime": "2017-05-04T14:33:43Z", + "allowedActions": [], + "targetObjectId": "", + "targetObjectName": "", + "targetInstanceType": "Other", + "customDetails": { + "blobUri": "", + "sasToken": "", + "instanceType": "ExportJobDetails", + "affectedObjectDetails": {} + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationJobs_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationJobs_Get.json new file mode 100644 index 000000000000..b2b23ebb7318 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationJobs_Get.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "jobName": "58776d0b-3141-48b2-a377-9ad863eb160d", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/32ea4b9e-de62-49a1-b062-7864d5c3b897", + "name": "32ea4b9e-de62-49a1-b062-7864d5c3b897", + "properties": { + "activityId": "fc8e9c8f-0e76-4b6b-8e7e-d37c1b31eba0 ActivityId: c506b6ba-0711-411e-8b09-1f3f4dcb824b", + "scenarioName": "DeleteRecoveryPlan", + "friendlyName": "Delete a recovery plan", + "state": "Succeeded", + "stateDescription": "Completed", + "tasks": [ + { + "taskId": "763326a2-01c9-4257-b2a1-0aac56465014", + "name": "DeleteRecoveryPlanTask", + "startTime": "2017-04-27T11:25:57.3029434Z", + "endTime": "2017-04-27T11:25:57.318574Z", + "allowedActions": [], + "friendlyName": "Delete a recovery plan task", + "state": "Succeeded", + "stateDescription": "Completed", + "taskType": "TaskDetails", + "customDetails": { + "instanceType": "ManualActionTaskDetails" + }, + "errors": [] + } + ], + "errors": [], + "startTime": "2017-04-27T11:25:56.800358Z", + "endTime": "2017-04-27T11:25:57Z", + "allowedActions": [], + "targetObjectId": "966c33bb-66e7-4567-9786-f80b0694f5f9", + "targetObjectName": "RPtest1", + "targetInstanceType": "RecoveryPlan", + "customDetails": { + "instanceType": "AsrJobDetails", + "affectedObjectDetails": { + "PrimaryVmmId": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "PrimaryVmmName": "cloud1", + "RecoveryVmmId": "21a9403c-6ec1-44f2-b744-b4e50b792387", + "PrimaryFabricProviderId": "HyperVSite", + "RecoveryFabricProviderId": "Azure" + } + } + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationJobs_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationJobs_List.json new file mode 100644 index 000000000000..dcf51fad0a81 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationJobs_List.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/1557d73f-6244-491e-8f0b-d300f752240b", + "name": "1557d73f-6244-491e-8f0b-d300f752240b", + "properties": { + "scenarioName": "AddProtectionProfile", + "friendlyName": "Create replication policy", + "state": "Succeeded", + "stateDescription": "Completed", + "tasks": [], + "errors": [], + "startTime": "2017-04-27T12:46:04.641851Z", + "endTime": "2017-04-27T12:46:11Z", + "allowedActions": [], + "targetObjectId": "af095a1e-1f1b-5365-87c9-99162ebcfaf0", + "targetObjectName": "protectionprofile1", + "targetInstanceType": "ProtectionProfile" + } + }, + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/0236416a-7573-4913-a4a1-6a286fbb1ceb", + "name": "0236416a-7573-4913-a4a1-6a286fbb1ceb", + "properties": { + "scenarioName": "RegisterDra", + "friendlyName": "Register the Azure Site Recovery Provider", + "state": "Succeeded", + "stateDescription": "Completed", + "tasks": [], + "errors": [], + "startTime": "2017-05-02T14:07:19.2784338Z", + "endTime": "2017-05-02T14:07:21Z", + "allowedActions": [], + "targetObjectId": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "targetObjectName": "CP-B3L40406-12.ntdev.corp.microsoft.com", + "targetInstanceType": "Server" + } + }, + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/2438d560-80f0-420b-839e-5c8ee0af90a1", + "name": "2438d560-80f0-420b-839e-5c8ee0af90a1", + "properties": { + "scenarioName": "CreateSite", + "friendlyName": "Create a site", + "state": "Succeeded", + "stateDescription": "Completed", + "tasks": [], + "errors": [], + "startTime": "2017-05-02T05:56:14.569095Z", + "endTime": "2017-05-02T05:56:16Z", + "allowedActions": [], + "targetObjectId": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "targetObjectName": "cloud1", + "targetInstanceType": "Server" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationJobs_Restart.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationJobs_Restart.json new file mode 100644 index 000000000000..cbe2be3931d6 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationJobs_Restart.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "jobName": "0664564c-353e-401a-ab0c-722257c10e25", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/42c7d13b-790c-4609-8e0b-0936f1c5e5fb", + "name": "42c7d13b-790c-4609-8e0b-0936f1c5e5fb", + "properties": { + "activityId": "2443a5b4-e675-499f-8983-4126ea0e232c ActivityId: 2a776896-5e56-470b-af55-3c981283c4bc", + "scenarioName": "RestartJob", + "friendlyName": "Restart job", + "state": "Succeeded", + "stateDescription": "Completed", + "tasks": [ + { + "taskId": "RemediateWfTask", + "name": "RemediateTask", + "startTime": "2017-05-03T10:45:13.5677237Z", + "endTime": "2017-05-03T10:45:13.6458467Z", + "allowedActions": [], + "friendlyName": "Restarting job", + "state": "Succeeded", + "stateDescription": "Completed", + "taskType": "TaskDetails", + "customDetails": { + "instanceType": "ManualActionTaskDetails" + }, + "errors": [] + } + ], + "errors": [], + "startTime": "2017-05-03T10:45:12.1320757Z", + "endTime": "2017-05-03T10:45:14Z", + "allowedActions": [], + "targetObjectId": "f8491e4f-817a-40dd-a90c-af773978c75b", + "targetObjectName": "vm1", + "targetInstanceType": "ProtectionEntity", + "customDetails": { + "instanceType": "AsrJobDetails", + "affectedObjectDetails": {} + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationJobs_Resume.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationJobs_Resume.json new file mode 100644 index 000000000000..e0a17002407b --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationJobs_Resume.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "jobName": "58776d0b-3141-48b2-a377-9ad863eb160d", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "resumeJobParams": { + "properties": { + "comments": " " + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/58776d0b-3141-48b2-a377-9ad863eb160d", + "name": "58776d0b-3141-48b2-a377-9ad863eb160d", + "properties": { + "activityId": "1b808dfe-0451-44ac-894c-c7270711cd8c ActivityId: 9f6f849e-922a-43ec-a7a6-0be45fc85c56", + "scenarioName": "TestFailover", + "friendlyName": "Test failover", + "state": "Suspended", + "stateDescription": "WaitingForStopTestFailover", + "tasks": [], + "errors": [], + "startTime": "2017-04-25T09:57:57.0357829Z", + "allowedActions": [ + "Cancel", + "Resume" + ], + "targetObjectId": "f8491e4f-817a-40dd-a90c-af773978c75b", + "targetObjectName": "vm1", + "targetInstanceType": "ProtectionEntity", + "customDetails": { + "instanceType": "TestFailoverJobDetails", + "testFailoverStatus": "Completed", + "comments": " ", + "networkName": "vnetavrai", + "networkFriendlyName": "vnetavrai", + "networkType": "VmNetworkAsInput", + "protectedItemDetails": [ + { + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "friendlyName": "vm1", + "testVmName": "vm1-test", + "testVmFriendlyName": "vm1-test", + "networkConnectionStatus": "Connected", + "networkFriendlyName": "vnetavrai", + "subnet": "Subnet1" + } + ], + "affectedObjectDetails": { + "PrimaryVmId": "f8491e4f-817a-40dd-a90c-af773978c75b", + "PrimaryVmName": "vm1", + "RecoveryVmId": "", + "RecoveryVmName": "vm1", + "ProtectionProfileId": "af095a1e-1f1b-5365-87c9-99162ebcfaf0", + "PrimaryCloudId": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "PrimaryCloudName": "cloud1", + "RecoveryCloudId": "d38048d4-b460-4791-8ece-108395ee8478", + "RecoveryCloudName": "Microsoft Azure", + "PrimaryVmmId": "6d224fc6-f326-5d35-96de-fbf51efb3179", + "PrimaryVmmName": "cloud1", + "RecoveryVmmId": "21a9403c-6ec1-44f2-b744-b4e50b792387", + "RecoveryVmmName": "Microsoft Azure", + "PrimaryFabricProviderId": "HyperVSite", + "RecoveryFabricProviderId": "Azure" + } + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationLogicalNetworks_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationLogicalNetworks_Get.json new file mode 100644 index 000000000000..1ab4d83a061a --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationLogicalNetworks_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "logicalNetworkName": "87ab394f-165f-4aa9-bd84-b018500b4509", + "fabricName": "cloud1", + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationLogicalNetworks", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationLogicalNetworks/53f5a278-ae85-4001-bd5f-f6a02e1f579d", + "name": "87ab394f-165f-4aa9-bd84-b018500b4509", + "properties": { + "friendlyName": "corp", + "networkVirtualizationStatus": "NetworkVirtualizationNotEnabled", + "logicalNetworkUsage": "NotUsedAsPrivateNetworkForTestFailover", + "logicalNetworkDefinitionsStatus": "LogicalNetworkDefinitionsNotIsolated" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationLogicalNetworks_ListByReplicationFabrics.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationLogicalNetworks_ListByReplicationFabrics.json new file mode 100644 index 000000000000..1f04006b3988 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationLogicalNetworks_ListByReplicationFabrics.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationLogicalNetworks", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationLogicalNetworks/53f5a278-ae85-4001-bd5f-f6a02e1f579d", + "name": "87ab394f-165f-4aa9-bd84-b018500b4509", + "properties": { + "friendlyName": "corp", + "networkVirtualizationStatus": "NetworkVirtualizationNotEnabled", + "logicalNetworkUsage": "NotUsedAsPrivateNetworkForTestFailover", + "logicalNetworkDefinitionsStatus": "LogicalNetworkDefinitionsNotIsolated" + } + }, + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationLogicalNetworks", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationLogicalNetworks/87ab394f-165f-4aa9-bd84-b018500b4509", + "name": "53f5a278-ae85-4001-bd5f-f6a02e1f579d", + "properties": { + "friendlyName": "LN-VLANNetwork-4", + "networkVirtualizationStatus": "NetworkVirtualizationNotEnabled", + "logicalNetworkUsage": "NotUsedAsPrivateNetworkForTestFailover", + "logicalNetworkDefinitionsStatus": "LogicalNetworkDefinitionsIsolated" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationMigrationItems_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationMigrationItems_Create.json new file mode 100644 index 000000000000..1de91741723e --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationMigrationItems_Create.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "input": { + "properties": { + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "providerSpecificDetails": { + "instanceType": "VMwareCbt", + "disksToInclude": [ + { + "diskId": "disk1", + "isOSDisk": "true", + "logStorageAccountId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.Storage/storageAccounts/logStorageAccount1", + "logStorageAccountSasSecretName": "logStorageSas" + } + ], + "vmwareMachineId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.OffAzure/VMwareSites/vmwaresite1/machines/virtualmachine1", + "targetNetworkId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1", + "targetResourceGroupId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1", + "snapshotRunAsAccountId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.OffAzure/VMwareSites/vmwaresite1/runasaccounts/snapshotRunAsAccount1", + "dataMoverRunAsAccountId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.OffAzure/VMwareSites/vmwaresite1/runasaccounts/dataMoverRunAsAccount1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationMigrationItems_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationMigrationItems_Delete.json new file mode 100644 index 000000000000..b1d3d98ccd9e --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationMigrationItems_Delete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationMigrationItems_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationMigrationItems_Get.json new file mode 100644 index 000000000000..c8d2343e7ffc --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationMigrationItems_Get.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationMigrationItems_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationMigrationItems_List.json new file mode 100644 index 000000000000..3e0bd06c7f0e --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationMigrationItems_List.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationMigrationItems_ListByReplicationProtectionContainers.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationMigrationItems_ListByReplicationProtectionContainers.json new file mode 100644 index 000000000000..fe9808bc0b16 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationMigrationItems_ListByReplicationProtectionContainers.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationMigrationItems_Migrate.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationMigrationItems_Migrate.json new file mode 100644 index 000000000000..2ce2715d62c1 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationMigrationItems_Migrate.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "migrateInput": { + "properties": { + "providerSpecificDetails": { + "instanceType": "VMwareCbt", + "performShutdown": "true" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationMigrationItems_Resync.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationMigrationItems_Resync.json new file mode 100644 index 000000000000..c43c96166bdf --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationMigrationItems_Resync.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "input": { + "properties": { + "providerSpecificDetails": { + "instanceType": "VMwareCbt", + "skipCbtReset": "true" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationMigrationItems_TestMigrate.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationMigrationItems_TestMigrate.json new file mode 100644 index 000000000000..b6c1f0c55e64 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationMigrationItems_TestMigrate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "testMigrateInput": { + "properties": { + "providerSpecificDetails": { + "instanceType": "VMwareCbt", + "recoveryPointId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1/migrationRecoveryPoints/9e737191-317e-43d0-8c83-e32ac3b34686", + "networkId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationMigrationItems_TestMigrateCleanup.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationMigrationItems_TestMigrateCleanup.json new file mode 100644 index 000000000000..babf8fa948a3 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationMigrationItems_TestMigrateCleanup.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "testMigrateCleanupInput": { + "properties": { + "comments": "Test Failover Cleanup" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationMigrationItems_Update.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationMigrationItems_Update.json new file mode 100644 index 000000000000..79f84b227d16 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationMigrationItems_Update.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "input": { + "properties": { + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationNetworkMappings_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationNetworkMappings_Create.json new file mode 100644 index 000000000000..d6d20dde5351 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationNetworkMappings_Create.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "fabricName": "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac", + "api-version": "2021-06-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071", + "networkName": "e2267b5c-2650-49bd-ab3f-d66aae694c06", + "networkMappingName": "corpe2amap", + "input": { + "properties": { + "recoveryFabricName": "Microsoft Azure", + "recoveryNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "fabricSpecificDetails": { + "instanceType": "VmmToAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06/replicationNetworkMappings/corpe2amap", + "name": "corpe2amap", + "properties": { + "state": "Paired", + "primaryNetworkFriendlyName": "corp", + "primaryNetworkId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06", + "primaryFabricFriendlyName": "CP-B3L30108-01.ntdev.corp.microsoft.com", + "recoveryNetworkFriendlyName": "vnetavrai", + "recoveryNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "recoveryFabricArmId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5", + "recoveryFabricFriendlyName": "Microsoft Azure", + "fabricSpecificSettings": { + "instanceType": "VmmToAzure" + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationNetworkMappings_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationNetworkMappings_Delete.json new file mode 100644 index 000000000000..281da6fa1d5c --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationNetworkMappings_Delete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "fabricName": "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac", + "api-version": "2021-06-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071", + "networkName": "e2267b5c-2650-49bd-ab3f-d66aae694c06", + "networkMappingName": "corpe2amap" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationNetworkMappings_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationNetworkMappings_Get.json new file mode 100644 index 000000000000..e1b0d8c91315 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationNetworkMappings_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "fabricName": "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac", + "api-version": "2021-06-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071", + "networkName": "e2267b5c-2650-49bd-ab3f-d66aae694c06", + "networkMappingName": "corpe2amap" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06/replicationNetworkMappings/corpe2amap", + "name": "corpe2amap", + "properties": { + "state": "Paired", + "primaryNetworkFriendlyName": "corp", + "primaryNetworkId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06", + "primaryFabricFriendlyName": "CP-B3L30108-01.ntdev.corp.microsoft.com", + "recoveryNetworkFriendlyName": "vnetavrai", + "recoveryNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "recoveryFabricArmId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5", + "recoveryFabricFriendlyName": "Microsoft Azure", + "fabricSpecificSettings": { + "instanceType": "VmmToAzure" + } + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationNetworkMappings_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationNetworkMappings_List.json new file mode 100644 index 000000000000..f6a3df9a9866 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationNetworkMappings_List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.RecoveryServicesBVTD2/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServicesBVTD2/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06/replicationNetworkMappings/corpe2amap", + "name": "corpe2amap", + "properties": { + "state": "Paired", + "primaryNetworkFriendlyName": "corp", + "primaryNetworkId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServicesBVTD2/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06", + "primaryFabricFriendlyName": "CP-B3L30108-01.ntdev.corp.microsoft.com", + "recoveryNetworkFriendlyName": "vnetavrai", + "recoveryNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "recoveryFabricArmId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServicesBVTD2/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5", + "recoveryFabricFriendlyName": "Microsoft Azure", + "fabricSpecificSettings": { + "instanceType": "VmmToAzure" + } + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationNetworkMappings_ListByReplicationNetworks.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationNetworkMappings_ListByReplicationNetworks.json new file mode 100644 index 000000000000..65384bb6a91f --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationNetworkMappings_ListByReplicationNetworks.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "networkName": "e2267b5c-2650-49bd-ab3f-d66aae694c06", + "fabricName": "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac", + "api-version": "2021-06-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06/replicationNetworkMappings/corpe2amap", + "name": "corpe2amap", + "properties": { + "state": "Paired", + "primaryNetworkFriendlyName": "corp", + "primaryNetworkId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06", + "primaryFabricFriendlyName": "CP-B3L30108-01.ntdev.corp.microsoft.com", + "recoveryNetworkFriendlyName": "vnetavrai", + "recoveryNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "recoveryFabricArmId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5", + "recoveryFabricFriendlyName": "Microsoft Azure", + "fabricSpecificSettings": { + "instanceType": "VmmToAzure" + } + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationNetworkMappings_Update.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationNetworkMappings_Update.json new file mode 100644 index 000000000000..592b4e3bc0aa --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationNetworkMappings_Update.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "fabricName": "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac", + "api-version": "2021-06-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071", + "networkName": "e2267b5c-2650-49bd-ab3f-d66aae694c06", + "networkMappingName": "corpe2amap", + "input": { + "properties": { + "recoveryFabricName": "Microsoft Azure", + "recoveryNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai2", + "fabricSpecificDetails": { + "instanceType": "VmmToAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06/replicationNetworkMappings/corpe2amap", + "name": "corpe2amap", + "properties": { + "state": "Paired", + "primaryNetworkFriendlyName": "corp", + "primaryNetworkId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06", + "primaryFabricFriendlyName": "CP-B3L30108-01.ntdev.corp.microsoft.com", + "recoveryNetworkFriendlyName": "vnetavrai2", + "recoveryNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai2", + "recoveryFabricArmId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5", + "recoveryFabricFriendlyName": "Microsoft Azure", + "fabricSpecificSettings": { + "instanceType": "VmmToAzure" + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationNetworks_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationNetworks_Get.json new file mode 100644 index 000000000000..d330994d3852 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationNetworks_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "fabricName": "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac", + "api-version": "2021-06-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071", + "networkName": "93ce99d7-1219-4914-aa61-73fe5023988e" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/93ce99d7-1219-4914-aa61-73fe5023988e", + "name": "93ce99d7-1219-4914-aa61-73fe5023988e", + "properties": { + "fabricType": "VMM", + "subnets": [], + "friendlyName": "VSwitch_VLan", + "networkType": "NoIsolation" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationNetworks_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationNetworks_List.json new file mode 100644 index 000000000000..c5b3c188ff7d --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationNetworks_List.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/93ce99d7-1219-4914-aa61-73fe5023988e", + "name": "93ce99d7-1219-4914-aa61-73fe5023988e", + "properties": { + "fabricType": "VMM", + "subnets": [], + "friendlyName": "VSwitch_VLan", + "networkType": "NoIsolation" + } + }, + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/b83bf8fd-f304-48d7-82c9-5d74e6215c1b", + "name": "b83bf8fd-f304-48d7-82c9-5d74e6215c1b", + "properties": { + "fabricType": "VMM", + "subnets": [], + "friendlyName": "VSwitch_NoIso", + "networkType": "NoIsolation" + } + }, + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06", + "name": "e2267b5c-2650-49bd-ab3f-d66aae694c06", + "properties": { + "fabricType": "VMM", + "subnets": [], + "friendlyName": "corp", + "networkType": "NoIsolation" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationNetworks_ListByReplicationFabrics.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationNetworks_ListByReplicationFabrics.json new file mode 100644 index 000000000000..ecaac7655cc7 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationNetworks_ListByReplicationFabrics.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "fabricName": "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac", + "api-version": "2021-06-01", + "resourceName": "srce2avaultbvtaC27", + "resourceGroupName": "srcBvte2a14C27", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/93ce99d7-1219-4914-aa61-73fe5023988e", + "name": "93ce99d7-1219-4914-aa61-73fe5023988e", + "properties": { + "fabricType": "VMM", + "subnets": [], + "friendlyName": "VSwitch_VLan", + "networkType": "NoIsolation" + } + }, + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/b83bf8fd-f304-48d7-82c9-5d74e6215c1b", + "name": "b83bf8fd-f304-48d7-82c9-5d74e6215c1b", + "properties": { + "fabricType": "VMM", + "subnets": [], + "friendlyName": "VSwitch_NoIso", + "networkType": "NoIsolation" + } + }, + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks", + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06", + "name": "e2267b5c-2650-49bd-ab3f-d66aae694c06", + "properties": { + "fabricType": "VMM", + "subnets": [], + "friendlyName": "corp", + "networkType": "NoIsolation" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationPolicies_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationPolicies_Create.json new file mode 100644 index 000000000000..042299df7d9d --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationPolicies_Create.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "policyName": "protectionprofile1", + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "input": { + "properties": { + "providerSpecificInput": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "name": "protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationPolicies", + "properties": { + "friendlyName": "protectionprofile1", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationPolicies_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationPolicies_Delete.json new file mode 100644 index 000000000000..555a76bad65d --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationPolicies_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "policyName": "protectionprofile1", + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationPolicies_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationPolicies_Get.json new file mode 100644 index 000000000000..7e25987d659e --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationPolicies_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "policyName": "protectionprofile1", + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "name": "protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationPolicies", + "properties": { + "friendlyName": "protectionprofile1", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationPolicies_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationPolicies_List.json new file mode 100644 index 000000000000..af849a97f3cf --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationPolicies_List.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "name": "protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationPolicies", + "properties": { + "friendlyName": "protectionprofile1", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationPolicies_Update.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationPolicies_Update.json new file mode 100644 index 000000000000..0c80e7500f03 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationPolicies_Update.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "policyName": "protectionprofile1", + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "input": { + "properties": { + "replicationProviderSettings": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "name": "protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationPolicies", + "properties": { + "friendlyName": "protectionprofile1", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectableItems_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectableItems_Get.json new file mode 100644 index 000000000000..442f8247ae14 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectableItems_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "protectableItemName": "c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "name": "c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectableItems", + "properties": { + "friendlyName": "vm2", + "protectionStatus": "Unprotected", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "protectionReadinessErrors": [], + "supportedReplicationProviders": [ + "HyperVReplicaAzure" + ], + "customDetails": { + "instanceType": "HyperVVirtualMachine" + } + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectableItems_ListByReplicationProtectionContainers.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectableItems_ListByReplicationProtectionContainers.json new file mode 100644 index 000000000000..0b15dee892cc --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectableItems_ListByReplicationProtectionContainers.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "name": "c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectableItems", + "properties": { + "friendlyName": "vm2", + "protectionStatus": "Unprotected", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "protectionReadinessErrors": [], + "supportedReplicationProviders": [ + "HyperVReplicaAzure" + ], + "customDetails": { + "instanceType": "HyperVVirtualMachine" + } + } + }, + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectableItems", + "properties": { + "friendlyName": "vm1", + "protectionStatus": "Unprotected", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "protectionReadinessErrors": [], + "supportedReplicationProviders": [ + "HyperVReplicaAzure" + ], + "customDetails": { + "instanceType": "HyperVVirtualMachine" + } + } + } + ], + "nextLink": "https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems?api-version=2021-06-01&%24skipToken=ReplicationGroup%3aBegin" + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_AddDisks.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_AddDisks.json new file mode 100644 index 000000000000..55061cce024d --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_AddDisks.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "addDisksInput": { + "properties": { + "providerSpecificDetails": { + "instanceType": "A2A", + "vmDisks": [ + { + "diskUri": "https://vmstorage.blob.core.windows.net/vhds/datadisk1.vhd", + "recoveryAzureStorageAccountId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourcegroups/recoveryResource/providers/Microsoft.Storage/storageAccounts/recoverystorage", + "primaryStagingAzureStorageAccountId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourcegroups/primaryResource/providers/Microsoft.Storage/storageAccounts/vmcachestorage" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectedItemType": "", + "protectableItemId": null, + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/6d2940f9-4c34-5989-9f56-1243a6e76ecf", + "primaryFabricFriendlyName": "cloud1", + "primaryFabricProvider": "AzureFabric", + "recoveryFabricFriendlyName": "cloud2", + "recoveryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud2", + "primaryProtectionContainerFriendlyName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "recoveryProtectionContainerFriendlyName": "cloud_81224fc6-f326-5d35-96de-fbf51efb3188", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "RepairReplication", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "failoverHealth": "Normal", + "healthErrors": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/A2APolicy", + "policyFriendlyName": "A2APolicy", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1752-12-31T19:31:01Z" + }, + "failoverRecoveryPointId": null, + "providerSpecificDetails": { + "instanceType": "A2A" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud2/replicationProtectionContainers/cloud_81224fc6-f326-5d35-96de-fbf51efb3188" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_ApplyRecoveryPoint.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_ApplyRecoveryPoint.json new file mode 100644 index 000000000000..3d7c87c5506a --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_ApplyRecoveryPoint.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "applyRecoveryPointInput": { + "properties": { + "recoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/e4d05fe9-5dfd-47be-b50b-aad306b2802d", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "UnplannedFailoverCommitPendingStatesBegin", + "protectionStateDescription": "Failover completed", + "activeLocation": "Recovery", + "testFailoverState": "MarkedForDeletion", + "testFailoverStateDescription": "Cleaning up test environment", + "allowedOperations": [ + "CompleteMigration", + "Commit", + "DisableProtection", + "ChangePit" + ], + "replicationHealth": "Critical", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "lastSuccessfulFailoverTime": "2017-04-26T08:42:33.0996129Z", + "lastSuccessfulTestFailoverTime": "2017-04-25T09:57:57.0357829Z", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/e4d05fe9-5dfd-47be-b50b-aad306b2802d", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_Create.json new file mode 100644 index 000000000000..39e1159a4d43 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_Create.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "input": { + "properties": { + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_Delete.json new file mode 100644 index 000000000000..36b827f71756 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "replicatedProtectedItemName": "c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "disableProtectionInput": { + "properties": { + "replicationProviderInput": { + "instanceType": "DisableProtectionProviderSpecificInput" + } + } + } + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_FailoverCancel.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_FailoverCancel.json new file mode 100644 index 000000000000..1a1845419711 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_FailoverCancel.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "cloud1", + "recoveryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "cloud1", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "PlannedFailover", + "DisableProtection" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "lastSuccessfulFailoverTime": "2021-02-24T06:37:23.1578655Z", + "lastSuccessfulTestFailoverTime": "1601-01-01T00:00:00.0000000Z", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "2021-02-24T07:17:23.1358752Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "providerSpecificDetails": { + "instanceType": "InMageRcmFailback" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_FailoverCommit.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_FailoverCommit.json new file mode 100644 index 000000000000..8a7b21290f8a --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_FailoverCommit.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "PlannedFailoverStatesBegin", + "protectionStateDescription": "Planned failover committed", + "activeLocation": "Recovery", + "testFailoverState": "MarkedForDeletion", + "testFailoverStateDescription": "Cleaning up test environment", + "allowedOperations": [ + "CompleteMigration", + "DisableProtection", + "Failback" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "lastSuccessfulFailoverTime": "2017-04-26T06:37:23.1578655Z", + "lastSuccessfulTestFailoverTime": "2017-04-25T09:57:57.0357829Z", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_Get.json new file mode 100644 index 000000000000..2d670d2bc8d4 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_Get.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_List.json new file mode 100644 index 000000000000..a515df92b926 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_List.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_ListByReplicationProtectionContainers.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_ListByReplicationProtectionContainers.json new file mode 100644 index 000000000000..272d03f143c9 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_ListByReplicationProtectionContainers.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_PlannedFailover.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_PlannedFailover.json new file mode 100644 index 000000000000..e31c180135d1 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_PlannedFailover.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "failoverInput": { + "properties": { + "failoverDirection": "PrimaryToRecovery", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "PlannedFailoverCommitRequired", + "protectionStateDescription": "Planned failover finished", + "activeLocation": "Recovery", + "testFailoverState": "MarkedForDeletion", + "testFailoverStateDescription": "Cleaning up test environment", + "allowedOperations": [ + "CompleteMigration", + "Commit", + "DisableProtection", + "ChangePit" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "lastSuccessfulFailoverTime": "2017-04-26T06:37:23.1578655Z", + "lastSuccessfulTestFailoverTime": "2017-04-25T09:57:57.0357829Z", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_Purge.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_Purge.json new file mode 100644 index 000000000000..b9e52f630c15 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_Purge.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "replicatedProtectedItemName": "c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_RemoveDisks.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_RemoveDisks.json new file mode 100644 index 000000000000..1c7fccd27b65 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_RemoveDisks.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "removeDisksInput": { + "properties": { + "providerSpecificDetails": { + "instanceType": "A2A", + "vmDisksUris": [ + "https://vmstorage.blob.core.windows.net/vhds/datadisk1.vhd" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectedItemType": "", + "protectableItemId": null, + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/6d2940f9-4c34-5989-9f56-1243a6e76ecf", + "primaryFabricFriendlyName": "cloud1", + "primaryFabricProvider": "AzureFabric", + "recoveryFabricFriendlyName": "cloud2", + "recoveryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud2", + "primaryProtectionContainerFriendlyName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "recoveryProtectionContainerFriendlyName": "cloud_81224fc6-f326-5d35-96de-fbf51efb3188", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "RepairReplication", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "failoverHealth": "Normal", + "healthErrors": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/A2APolicy", + "policyFriendlyName": "A2APolicy", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1752-12-31T19:31:01Z" + }, + "failoverRecoveryPointId": null, + "providerSpecificDetails": { + "instanceType": "A2A" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud2/replicationProtectionContainers/cloud_81224fc6-f326-5d35-96de-fbf51efb3188" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_RepairReplication.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_RepairReplication.json new file mode 100644 index 000000000000..a5b448fb641f --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_RepairReplication.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_Reprotect.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_Reprotect.json new file mode 100644 index 000000000000..66335891b47d --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_Reprotect.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "reprotectInput": { + "properties": { + "failoverDirection": "PrimaryToRecovery", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "MarkedForDeletion", + "testFailoverStateDescription": "Cleaning up test environment", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "lastSuccessfulFailoverTime": "2017-04-26T06:37:23.1578655Z", + "lastSuccessfulTestFailoverTime": "2017-04-25T09:57:57.0357829Z", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_ResolveHealthErrors.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_ResolveHealthErrors.json new file mode 100644 index 000000000000..bfdfa54de7fa --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_ResolveHealthErrors.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "resolveHealthInput": { + "properties": { + "healthErrors": [ + { + "healthErrorId": "3:8020" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectedItemType": "", + "protectableItemId": null, + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/6d2940f9-4c34-5989-9f56-1243a6e76ecf", + "primaryFabricFriendlyName": "cloud1", + "primaryFabricProvider": "AzureFabric", + "recoveryFabricFriendlyName": "cloud2", + "recoveryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud2", + "primaryProtectionContainerFriendlyName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "recoveryProtectionContainerFriendlyName": "cloud_81224fc6-f326-5d35-96de-fbf51efb3188", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "RepairReplication", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "failoverHealth": "Normal", + "healthErrors": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/A2APolicy", + "policyFriendlyName": "A2APolicy", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1752-12-31T19:31:01Z" + }, + "failoverRecoveryPointId": null, + "providerSpecificDetails": { + "instanceType": "A2A" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud2/replicationProtectionContainers/cloud_81224fc6-f326-5d35-96de-fbf51efb3188" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_TestFailover.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_TestFailover.json new file mode 100644 index 000000000000..59b6bda3d738 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_TestFailover.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "testfailoverInput": { + "properties": { + "failoverDirection": "PrimaryToRecovery", + "networkType": "VmNetworkAsInput", + "networkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Cleanup test failover pending", + "activeLocation": "Primary", + "testFailoverState": "WaitingForCompletion", + "testFailoverStateDescription": "Waiting for user input", + "allowedOperations": [ + "TestFailoverCleanup" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "currentScenario": { + "scenarioName": "TestFailover", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/2838f9b4-2609-4f76-a7e9-07e6387c5e98", + "startTime": "2017-04-25T09:57:57.0357829Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/0689d0d0-3518-4793-8c98-c26bf94526f6", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_TestFailoverCleanup.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_TestFailoverCleanup.json new file mode 100644 index 000000000000..5e7a48ebd482 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_TestFailoverCleanup.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "cleanupInput": { + "properties": { + "comments": "Test Failover Cleanup" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "MarkedForDeletion", + "testFailoverStateDescription": "Cleaning up test environment", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "lastSuccessfulFailoverTime": "2017-04-26T06:37:23.1578655Z", + "lastSuccessfulTestFailoverTime": "2017-04-25T09:57:57.0357829Z", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_UnplannedFailover.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_UnplannedFailover.json new file mode 100644 index 000000000000..6f420c3f2d00 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_UnplannedFailover.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "failoverInput": { + "properties": { + "failoverDirection": "PrimaryToRecovery", + "sourceSiteOperations": "NotRequired", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "UnplannedFailoverCommitPendingStatesBegin", + "protectionStateDescription": "Failover completed", + "activeLocation": "Recovery", + "testFailoverState": "MarkedForDeletion", + "testFailoverStateDescription": "Cleaning up test environment", + "allowedOperations": [ + "CompleteMigration", + "Commit", + "DisableProtection", + "ChangePit" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "lastSuccessfulFailoverTime": "2017-04-26T08:42:33.0996129Z", + "lastSuccessfulTestFailoverTime": "2017-04-25T09:57:57.0357829Z", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "failoverRecoveryPointId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b/recoveryPoints/b2c7b208-0999-40a4-804f-8ee1019c8f76", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_Update.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_Update.json new file mode 100644 index 000000000000..68663ed873b5 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_Update.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "replicatedProtectedItemName": "f8491e4f-817a-40dd-a90c-af773978c75b", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "updateProtectionInput": { + "properties": { + "recoveryAzureVMName": "vm1", + "recoveryAzureVMSize": "Basic_A0", + "selectedRecoveryAzureNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "vmNics": [ + { + "nicId": "TWljcm9zb2Z0OkY4NDkxRTRGLTgxN0EtNDBERC1BOTBDLUFGNzczOTc4Qzc1Qlw3NjAwMzMxRS03NDk4LTQ0QTQtQjdDNy0xQjY1NkJDREQ1MkQ=", + "selectionType": "SelectedByUser", + "ipConfigs": [ + { + "ipConfigName": "ipconfig1", + "isPrimary": true, + "recoverySubnetName": "subnet1", + "recoveryStaticIPAddress": "10.0.2.46" + } + ] + } + ], + "licenseType": "WindowsServer", + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "name": "f8491e4f-817a-40dd-a90c-af773978c75b", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "vm1", + "protectedItemType": "HyperVVirtualMachine", + "protectableItemId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectableItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "recoveryServicesProviderId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "cloud1", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "policyFriendlyName": "protectionprofile1", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "providerSpecificDetails": { + "instanceType": "HyperVReplicaAzure" + }, + "recoveryContainerId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_UpdateAppliance.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_UpdateAppliance.json new file mode 100644 index 000000000000..d1fff23c5e68 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_UpdateAppliance.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "replicatedProtectedItemName": "idclab-vcen67_50158124-8857-3e08-0893-2ddf8ebb8c1f", + "protectionContainerName": "Ayan-0106-SA-Vaultreplicationcontainer", + "fabricName": "Ayan-0106-SA-Vaultreplicationfabric", + "resourceName": "Ayan-0106-SA-Vault", + "resourceGroupName": "Ayan-0106-SA-RG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574", + "applianceUpdateInput": { + "properties": { + "targetApplianceId": "", + "providerSpecificDetails": { + "instanceType": "InMageRcm", + "runAsAccountId": "" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/Ayan-0106-SA-RG/providers/Microsoft.RecoveryServices/vaults/Ayan-0106-SA-Vault/replicationFabrics/Ayan-0106-SA-Vaultreplicationfabric/replicationProtectionContainers/Ayan-0106-SA-Vaultreplicationcontainer/replicationProtectedItems/idclab-vcen67_50158124-8857-3e08-0893-2ddf8ebb8c1f", + "name": "idclab-vcen67_50158124-8857-3e08-0893-2ddf8ebb8c1f", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "Ayan-RHEL7-Test2", + "protectedItemType": "", + "protectableItemId": null, + "recoveryServicesProviderId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/Ayan-0106-SA-RG/providers/Microsoft.RecoveryServices/vaults/Ayan-0106-SA-Vault/replicationFabrics/Ayan-0106-SA-Vaultreplicationfabric/replicationRecoveryServicesProviders/a552cf2d-bbb3-4d78-8145-e1992ecb31d1", + "primaryFabricFriendlyName": "Ayan-0106-SA-Vaultreplicationfabric", + "primaryFabricProvider": "InMageRcmFabric", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "Ayan-0106-SA-Vaultreplicationcontainer", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "failoverHealth": "Normal", + "healthErrors": [], + "policyId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/Ayan-0106-SA-RG/providers/Microsoft.RecoveryServices/vaults/Ayan-0106-SA-Vault/replicationPolicies/24-hour-replication-policy", + "policyFriendlyName": "24-hour-replication-policy", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/Ayan-0106-SA-RG/providers/Microsoft.RecoveryServices/vaults/Ayan-0106-SA-Vault/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "failoverRecoveryPointId": null, + "providerSpecificDetails": { + "instanceType": "InMageRcm" + }, + "recoveryContainerId": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/Ayan-0106-SA-RG/providers/Microsoft.RecoveryServices/vaults/Ayan-0106-SA-Vault/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478", + "eventCorrelationId": "fb40d161-cffd-44d9-a252-0b7978e1f73c" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_UpdateMobilityService.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_UpdateMobilityService.json new file mode 100644 index 000000000000..5ffc3c1db5d5 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectedItems_UpdateMobilityService.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "replicationProtectedItemName": "79dd20ab-2b40-11e7-9791-0050568f387e", + "protectionContainerName": "cloud_c6780228-83bd-4f3e-a70e-cb46b7da33a0", + "fabricName": "WIN-JKKJ31QI8U2", + "resourceName": "WCUSVault", + "resourceGroupName": "wcusValidations", + "subscriptionId": "b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c", + "updateMobilityServiceRequest": { + "properties": { + "runAsAccountId": "2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "79dd20ab-2b40-11e7-9791-0050568f387e", + "id": "/Subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/wcusValidations/providers/Microsoft.RecoveryServices/vaults/WCUSVault/replicationFabrics/d70b0326a201008a953505ef271dc908e5e23468bc7356862ea178696f5f15c7/replicationProtectionContainers/cloud_c6780228-83bd-4f3e-a70e-cb46b7da33a0/replicationProtectedItems/79dd20ab-2b40-11e7-9791-0050568f387e", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems", + "properties": { + "friendlyName": "MMR-LIN-V2A-3", + "protectedItemType": "", + "protectableItemId": "/Subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/wcusValidations/providers/Microsoft.RecoveryServices/vaults/WCUSVault/replicationFabrics/d70b0326a201008a953505ef271dc908e5e23468bc7356862ea178696f5f15c7/replicationProtectionContainers/cloud_c6780228-83bd-4f3e-a70e-cb46b7da33a0/replicationProtectableItems/79dd20ab-2b40-11e7-9791-0050568f387e", + "recoveryServicesProviderId": "/Subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/wcusValidations/providers/Microsoft.RecoveryServices/vaults/WCUSVault/replicationFabrics/d70b0326a201008a953505ef271dc908e5e23468bc7356862ea178696f5f15c7/replicationRecoveryServicesProviders/c6780228-83bd-4f3e-a70e-cb46b7da33a0", + "primaryFabricFriendlyName": "WIN-JKKJ31QI8U2", + "recoveryFabricFriendlyName": "Microsoft Azure", + "recoveryFabricId": "Microsoft Azure", + "primaryProtectionContainerFriendlyName": "WIN-JKKJ31QI8U2", + "recoveryProtectionContainerFriendlyName": "Microsoft Azure", + "protectionState": "Protected", + "protectionStateDescription": "Protected", + "activeLocation": "Primary", + "testFailoverState": "None", + "testFailoverStateDescription": "None", + "allowedOperations": [ + "UnplannedFailover", + "DisableProtection", + "TestFailover" + ], + "replicationHealth": "Normal", + "policyId": "/Subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/wcusValidations/providers/Microsoft.RecoveryServices/vaults/WCUSVault/replicationPolicies/MadhaviPolicyNew", + "policyFriendlyName": "MadhaviPolicyNew", + "currentScenario": { + "scenarioName": "None", + "jobId": "/Subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/wcusValidations/providers/Microsoft.RecoveryServices/vaults/WCUSVault/replicationJobs/None", + "startTime": "1753-01-01T01:01:01Z" + }, + "providerSpecificDetails": { + "instanceType": "InMageAzureV2" + }, + "recoveryContainerId": "/Subscriptions/b364ed8d-4279-4bf8-8fd1-56f8fa0ae05c/resourceGroups/wcusValidations/providers/Microsoft.RecoveryServices/vaults/WCUSVault/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationProtectionContainers/d38048d4-b460-4791-8ece-108395ee8478" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainerMappings_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainerMappings_Create.json new file mode 100644 index 000000000000..fb776d189186 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainerMappings_Create.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "mappingName": "cloud1protectionprofile1", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "creationInput": { + "properties": { + "targetProtectionContainerId": "Microsoft Azure", + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "providerSpecificInput": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectionContainerMappings/cloud1protectionprofile1", + "name": "cloud1protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings", + "properties": { + "targetProtectionContainerId": "Microsoft Azure", + "targetProtectionContainerFriendlyName": "Microsoft Azure", + "health": "Normal", + "healthErrorDetails": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "state": "Paired", + "sourceProtectionContainerFriendlyName": "cloud1", + "sourceFabricFriendlyName": "cloud1", + "targetFabricFriendlyName": "Microsoft Azure", + "policyFriendlyName": "protectionprofile1" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainerMappings_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainerMappings_Delete.json new file mode 100644 index 000000000000..2510bc897746 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainerMappings_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "mappingName": "cloud1protectionprofile1", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "removalInput": { + "properties": { + "providerSpecificInput": {} + } + } + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainerMappings_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainerMappings_Get.json new file mode 100644 index 000000000000..f2129224e3aa --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainerMappings_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "mappingName": "cloud1protectionprofile1", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectionContainerMappings/cloud1protectionprofile1", + "name": "cloud1protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings", + "properties": { + "targetProtectionContainerId": "Microsoft Azure", + "targetProtectionContainerFriendlyName": "Microsoft Azure", + "health": "Normal", + "healthErrorDetails": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "state": "Paired", + "sourceProtectionContainerFriendlyName": "cloud1", + "sourceFabricFriendlyName": "cloud1", + "targetFabricFriendlyName": "Microsoft Azure", + "policyFriendlyName": "protectionprofile1" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainerMappings_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainerMappings_List.json new file mode 100644 index 000000000000..6c0fb37c5c8c --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainerMappings_List.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectionContainerMappings/cloud1protectionprofile1", + "name": "cloud1protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationProtectionContainerMappings", + "properties": { + "targetProtectionContainerId": "Microsoft Azure", + "targetProtectionContainerFriendlyName": "Microsoft Azure", + "health": "Normal", + "healthErrorDetails": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "state": "Paired", + "sourceProtectionContainerFriendlyName": "cloud1", + "sourceFabricFriendlyName": "cloud1", + "targetFabricFriendlyName": "Microsoft Azure", + "policyFriendlyName": "protectionprofile1" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers.json new file mode 100644 index 000000000000..e2fe72937533 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectionContainerMappings/cloud1protectionprofile1", + "name": "cloud1protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings", + "properties": { + "targetProtectionContainerId": "Microsoft Azure", + "targetProtectionContainerFriendlyName": "Microsoft Azure", + "health": "Normal", + "healthErrorDetails": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "state": "Paired", + "sourceProtectionContainerFriendlyName": "cloud1", + "sourceFabricFriendlyName": "cloud1", + "targetFabricFriendlyName": "Microsoft Azure", + "policyFriendlyName": "protectionprofile1" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainerMappings_Purge.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainerMappings_Purge.json new file mode 100644 index 000000000000..2372acce8042 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainerMappings_Purge.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "mappingName": "cloud1protectionprofile1", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainerMappings_Update.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainerMappings_Update.json new file mode 100644 index 000000000000..aaf2719c3dd9 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainerMappings_Update.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "mappingName": "cloud1protectionprofile1", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "updateInput": { + "properties": { + "providerSpecificInput": { + "instanceType": "A2A", + "agentAutoUpdateStatus": "Enabled", + "automationAccountArmId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/automationrg1/providers/Microsoft.Automation/automationAccounts/automationaccount1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectionContainerMappings/cloud1protectionprofile1", + "name": "cloud1protectionprofile1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings", + "properties": { + "targetProtectionContainerId": "Microsoft Azure", + "targetProtectionContainerFriendlyName": "Microsoft Azure", + "health": "Normal", + "healthErrorDetails": [], + "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "state": "Paired", + "sourceProtectionContainerFriendlyName": "cloud1", + "sourceFabricFriendlyName": "cloud1", + "targetFabricFriendlyName": "Microsoft Azure", + "policyFriendlyName": "protectionprofile1", + "providerSpecificDetails": { + "instanceType": "A2A", + "agentAutoUpdateStatus": "Enabled", + "automationAccountArmId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/automationrg1/providers/Microsoft.Automation/automationAccounts/automationaccount1", + "scheduleName": "cloud1protectionprofile1_a85ea38f-62a8-471b-93cc-69b74fd9578c", + "jobScheduleName": "ffd503ec-5f88-4b58-97c8-841466e7aa47" + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainers_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainers_Create.json new file mode 100644 index 000000000000..af7132caf86e --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainers_Create.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "creationInput": { + "properties": { + "providerSpecificInput": [ + { + "instanceType": "ReplicationProviderSpecificContainerCreationInput" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "name": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers", + "properties": { + "fabricFriendlyName": "cloud1", + "friendlyName": "cloud1", + "fabricType": "HyperVSite", + "protectedItemCount": 0, + "pairingStatus": "NotPaired", + "role": "" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainers_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainers_Delete.json new file mode 100644 index 000000000000..b26f1138afa1 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainers_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainers_DiscoverProtectableItem.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainers_DiscoverProtectableItem.json new file mode 100644 index 000000000000..b8e8226b79c6 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainers_DiscoverProtectableItem.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "protectionContainerName": "cloud_7328549c-5c37-4459-a3c2-e35f9ef6893c", + "fabricName": "V2A-W2K12-660", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574", + "discoverProtectableItemRequest": { + "properties": { + "friendlyName": "Test", + "ipAddress": "10.150.2.3", + "osType": "Windows" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationFabrics/239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d/replicationProtectionContainers/cloud_7328549c-5c37-4459-a3c2-e35f9ef6893c", + "name": "cloud_7328549c-5c37-4459-a3c2-e35f9ef6893c", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers", + "properties": { + "fabricFriendlyName": "V2A-W2K12-660", + "friendlyName": "V2A-W2K12-660", + "fabricType": "VMware", + "protectedItemCount": 2, + "pairingStatus": "Paired", + "role": "Primary" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainers_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainers_Get.json new file mode 100644 index 000000000000..e13468dbf85b --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainers_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "protectionContainerName": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "name": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers", + "properties": { + "fabricFriendlyName": "cloud1", + "friendlyName": "cloud1", + "fabricType": "HyperVSite", + "protectedItemCount": 0, + "pairingStatus": "NotPaired", + "role": "" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainers_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainers_List.json new file mode 100644 index 000000000000..7e4718fb41f0 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainers_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "name": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "type": "Microsoft.RecoveryServices/vaults/replicationProtectionContainers", + "properties": { + "fabricFriendlyName": "cloud1", + "friendlyName": "cloud1", + "fabricType": "HyperVSite", + "protectedItemCount": 0, + "pairingStatus": "NotPaired", + "role": "" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainers_ListByReplicationFabrics.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainers_ListByReplicationFabrics.json new file mode 100644 index 000000000000..a896cf31b33e --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainers_ListByReplicationFabrics.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "fabricName": "cloud1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "name": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers", + "properties": { + "fabricFriendlyName": "cloud1", + "friendlyName": "cloud1", + "fabricType": "HyperVSite", + "protectedItemCount": 0, + "pairingStatus": "NotPaired", + "role": "" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainers_SwitchProtection.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainers_SwitchProtection.json new file mode 100644 index 000000000000..6d9d68a39426 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionContainers_SwitchProtection.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "protectionContainerName": "CentralUSCancloud", + "fabricName": "CentralUSCanSite", + "resourceName": "priyanponeboxvault", + "resourceGroupName": "priyanprg", + "subscriptionId": "42195872-7e70-4f8a-837f-84b28ecbb78b", + "switchInput": { + "properties": { + "replicationProtectedItemName": "a2aSwapOsVm", + "providerSpecificDetails": { + "instanceType": "A2A" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/42195872-7e70-4f8a-837f-84b28ecbb78b/resourceGroups/priyanprg/providers/Microsoft.RecoveryServices/vaults/priyanponeboxvault/replicationFabrics/EUSCanSite/replicationProtectionContainers/euscancloud", + "name": "euscancloud", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers", + "properties": { + "fabricFriendlyName": "East US 2 EUAP", + "friendlyName": "euscancloud", + "fabricType": "Azure", + "protectedItemCount": 0, + "pairingStatus": "Paired", + "role": "Primary" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionIntents_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionIntents_Create.json new file mode 100644 index 000000000000..b12ecf1286db --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionIntents_Create.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "intentObjectName": "vm1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "509099b2-9d2c-4636-b43e-bd5cafb6be69", + "input": { + "properties": { + "providerSpecificDetails": { + "instanceType": "A2A", + "fabricObjectId": "/subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/removeOne/providers/Microsoft.Compute/virtualMachines/vmPpgAv5", + "primaryLocation": "eastUs2", + "recoveryLocation": "westus2", + "recoverySubscriptionId": "ed5bcdf6-d61e-47bd-8ea9-f2bd379a2640", + "recoveryAvailabilityType": "Single", + "recoveryResourceGroupId": "/subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/removeOne-asr" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/2007vttp/providers/Microsoft.RecoveryServices/vaults/tp2007vt/replicationProtectionIntents/vm1", + "name": "vm1", + "type": "Microsoft.RecoveryServices/vaults/replicationProtectionIntents", + "properties": { + "friendlyName": "vm1", + "jobId": "/Subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/a2acl-rg-vault-prod-gip-ccy/providers/Microsoft.RecoveryServices/vaults/a2acl-vault-prod-gip-ccy/replicationJobs/02004ea7-d498-4bb4-bdeb-cdb611706867", + "jobState": "InProgress", + "providerSpecificDetails": { + "instanceType": "A2A", + "recoveryAvailabilityType": "Single" + } + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionIntents_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionIntents_Get.json new file mode 100644 index 000000000000..58c2f7e5ee00 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionIntents_Get.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "intentObjectName": "vm1", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "509099b2-9d2c-4636-b43e-bd5cafb6be69" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/2007vttp/providers/Microsoft.RecoveryServices/vaults/tp2007vt/replicationProtectionIntents/vm1", + "name": "vm1", + "type": "Microsoft.RecoveryServices/vaults/replicationProtectionIntents", + "properties": { + "friendlyName": "vm1", + "jobId": "/Subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/a2acl-rg-vault-prod-gip-ccy/providers/Microsoft.RecoveryServices/vaults/a2acl-vault-prod-gip-ccy/replicationJobs/02004ea7-d498-4bb4-bdeb-cdb611706867", + "jobState": "InProgress", + "providerSpecificDetails": { + "instanceType": "A2A", + "fabricObjectId": "/subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/removeOne/providers/Microsoft.Compute/virtualMachines/vmPpgAv5", + "primaryLocation": "eastUs2", + "recoveryLocation": "westus2", + "recoverySubscriptionId": "ed5bcdf6-d61e-47bd-8ea9-f2bd379a2640", + "recoveryAvailabilityType": "Single" + } + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionIntents_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionIntents_List.json new file mode 100644 index 000000000000..2ebfc97f6431 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationProtectionIntents_List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "2007vttp", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "509099b2-9d2c-4636-b43e-bd5cafb6be69" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/2007vttp/providers/Microsoft.RecoveryServices/vaults/tp2007vt/replicationProtectionIntents/vm1", + "name": "vm1", + "type": "Microsoft.RecoveryServices/vaults/replicationProtectionIntents", + "properties": { + "friendlyName": "vm1", + "jobId": "/Subscriptions/d90d145a-4cdd-45a3-b2c4-971d69775278/resourceGroups/a2acl-rg-vault-prod-gip-ccy/providers/Microsoft.RecoveryServices/vaults/a2acl-vault-prod-gip-ccy/replicationJobs/02004ea7-d498-4bb4-bdeb-cdb611706867", + "jobState": "InProgress", + "providerSpecificDetails": { + "instanceType": "A2A", + "fabricObjectId": "/subscriptions/509099b2-9d2c-4636-b43e-bd5cafb6be69/resourceGroups/removeOne/providers/Microsoft.Compute/virtualMachines/vmPpgAv5", + "primaryLocation": "eastUs2", + "recoveryLocation": "westus2", + "recoverySubscriptionId": "ed5bcdf6-d61e-47bd-8ea9-f2bd379a2640", + "recoveryAvailabilityType": "Single" + } + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_Create.json new file mode 100644 index 000000000000..41200ad6179c --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_Create.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1", + "input": { + "properties": { + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "recoveryFabricId": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "groups": [ + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover" + ], + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_Delete.json new file mode 100644 index 000000000000..ce2afbf09cdd --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_FailoverCancel.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_FailoverCancel.json new file mode 100644 index 000000000000..8930dd813ba6 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_FailoverCancel.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "recoveryFabricFriendlyName": "cloud1", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "InMageRcmFailback" + ], + "allowedOperations": [ + "PlannedFailover" + ], + "lastPlannedFailoverTime": "2021-02-24T07:33:49.1372448Z", + "lastTestFailoverTime": "1601-01-01T00:00:00.0000000Z", + "currentScenario": { + "scenarioName": "CancelFailover", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/5276a7bc-12a3-43a1-bc53-9bf80e0be87b", + "startTime": "2021-02-24T08:52:42.1587592Z" + }, + "currentScenarioStatus": "Succeeded", + "currentScenarioStatusDescription": "Completed", + "groups": [] + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_FailoverCommit.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_FailoverCommit.json new file mode 100644 index 000000000000..09a39ed4d366 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_FailoverCommit.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover" + ], + "lastPlannedFailoverTime": "2017-04-27T07:33:49.1372448Z", + "lastTestFailoverTime": "2017-04-27T07:00:27.8354747Z", + "currentScenario": { + "scenarioName": "CommitFailover", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/5276a7bc-12a3-43a1-bc53-9bf80e0be87b", + "startTime": "2017-04-27T08:52:42.1587592Z" + }, + "currentScenarioStatus": "Succeeded", + "currentScenarioStatusDescription": "Completed", + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_Get.json new file mode 100644 index 000000000000..137c9ad7f569 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_Get.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover" + ], + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_List.json new file mode 100644 index 000000000000..07dfdca66e4b --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_List.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover" + ], + "groups": [] + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_PlannedFailover.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_PlannedFailover.json new file mode 100644 index 000000000000..3ae71012bb51 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_PlannedFailover.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1", + "input": { + "properties": { + "failoverDirection": "PrimaryToRecovery", + "providerSpecificDetails": [ + { + "instanceType": "HyperVReplicaAzure" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover", + "Commit" + ], + "lastPlannedFailoverTime": "2017-04-27T07:33:49.1372448Z", + "lastTestFailoverTime": "2017-04-27T07:00:27.8354747Z", + "currentScenario": { + "scenarioName": "PlannedFailover", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/d4821a53-90da-4fcb-bc11-a280d13e3350", + "startTime": "2017-04-27T07:34:02.6176524Z" + }, + "currentScenarioStatus": "Succeeded", + "currentScenarioStatusDescription": "Completed", + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_Reprotect.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_Reprotect.json new file mode 100644 index 000000000000..32a04a1170de --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_Reprotect.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover" + ], + "lastPlannedFailoverTime": "2017-04-27T08:58:35.9062813Z", + "lastTestFailoverTime": "2017-04-27T07:00:27.8354747Z", + "currentScenario": { + "scenarioName": "ReverseReplication", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/edf01dfb-b649-4802-91e4-3d55ce3bebf0", + "startTime": "2017-04-27T09:52:16.9818841Z" + }, + "currentScenarioStatus": "Succeeded", + "currentScenarioStatusDescription": "Completed", + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_TestFailover.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_TestFailover.json new file mode 100644 index 000000000000..09f07d9f676e --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_TestFailover.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1", + "input": { + "properties": { + "failoverDirection": "PrimaryToRecovery", + "networkType": "VmNetworkAsInput", + "networkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai", + "providerSpecificDetails": [ + { + "instanceType": "HyperVReplicaAzure" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "TestFailoverCleanup" + ], + "currentScenario": { + "scenarioName": "TestFailover", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/d40bfb40-aaaa-4c0d-87d3-41b15439a84b", + "startTime": "2017-04-27T07:00:58.8191916Z" + }, + "currentScenarioStatus": "Suspended", + "currentScenarioStatusDescription": "WaitingForStopTestFailover", + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_TestFailoverCleanup.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_TestFailoverCleanup.json new file mode 100644 index 000000000000..3552e29cd54c --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_TestFailoverCleanup.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1", + "input": { + "properties": { + "comments": "Test Failover Cleanup" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover" + ], + "lastPlannedFailoverTime": "2017-04-27T07:33:49.1372448Z", + "lastTestFailoverTime": "2017-04-27T07:00:27.8354747Z", + "currentScenario": { + "scenarioName": "TestFailoverCleanup", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/4ae8eaa8-a384-42cb-9768-152cb5b8a1ff", + "startTime": "2017-04-27T07:10:52.8424747Z" + }, + "currentScenarioStatus": "Succeeded", + "currentScenarioStatusDescription": "Completed", + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_UnplannedFailover.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_UnplannedFailover.json new file mode 100644 index 000000000000..0c056a24e5b7 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_UnplannedFailover.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1", + "input": { + "properties": { + "failoverDirection": "PrimaryToRecovery", + "sourceSiteOperations": "Required", + "providerSpecificDetails": [ + { + "instanceType": "HyperVReplicaAzure" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover", + "Commit" + ], + "lastPlannedFailoverTime": "2017-04-27T08:58:35.9062813Z", + "lastTestFailoverTime": "2017-04-27T07:00:27.8354747Z", + "currentScenario": { + "scenarioName": "UnplannedFailover", + "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/60b84068-9adb-4867-a49d-88be40bff14b", + "startTime": "2017-04-27T10:03:03.2206946Z" + }, + "currentScenarioStatus": "Succeeded", + "currentScenarioStatusDescription": "Completed", + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_Update.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_Update.json new file mode 100644 index 000000000000..f2d31d9e55da --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryPlans_Update.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "recoveryPlanName": "RPtest1", + "input": { + "properties": { + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1", + "name": "RPtest1", + "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans", + "properties": { + "friendlyName": "RPtest1", + "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1", + "primaryFabricFriendlyName": "cloud1", + "recoveryFabricId": "Microsoft Azure", + "recoveryFabricFriendlyName": "Microsoft Azure", + "failoverDeploymentModel": "ResourceManager", + "replicationProviders": [ + "HyperVReplicaAzure" + ], + "allowedOperations": [ + "PlannedFailover", + "UnplannedFailover", + "TestFailover" + ], + "groups": [ + { + "groupType": "Shutdown", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Failover", + "replicationProtectedItems": [], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b", + "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b" + } + ], + "startGroupActions": [], + "endGroupActions": [] + }, + { + "groupType": "Boot", + "replicationProtectedItems": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6", + "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6" + } + ], + "startGroupActions": [], + "endGroupActions": [] + } + ] + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryServicesProviders_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryServicesProviders_Create.json new file mode 100644 index 000000000000..a6b3bb9f4e63 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryServicesProviders_Create.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "providerName": "vmwareprovider1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "addProviderInput": { + "properties": { + "machineName": "vmwareprovider1", + "authenticationIdentityInput": { + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "f66fce08-c0c6-47a1-beeb-0ede5ea94f90", + "objectId": "141360b8-5686-4240-a027-5e24e6affeba", + "audience": "https://microsoft.onmicrosoft.com/cf19e349-644c-4c6a-bcae-9c8f35357874", + "aadAuthority": "https://login.microsoftonline.com" + }, + "resourceAccessIdentityInput": { + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "f66fce08-c0c6-47a1-beeb-0ede5ea94f90", + "objectId": "141360b8-5686-4240-a027-5e24e6affeba", + "audience": "https://microsoft.onmicrosoft.com/cf19e349-644c-4c6a-bcae-9c8f35357874", + "aadAuthority": "https://login.microsoftonline.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationRecoveryServicesProviders/vmwareprovider1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders", + "name": "vmwareprovider1", + "properties": { + "fabricType": "VMwareV2", + "friendlyName": "vmwareprovider1", + "providerVersion": "5.1.3688.0", + "serverVersion": "3.2.7510.0", + "providerVersionState": "Latest", + "fabricFriendlyName": "vmwarefabric1", + "lastHeartBeat": "2017-04-27T09:16:04.9405768Z", + "connectionStatus": "Connected", + "protectedItemCount": 2, + "allowedScenarios": [ + "Refresh" + ] + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryServicesProviders_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryServicesProviders_Delete.json new file mode 100644 index 000000000000..d05c386856a5 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryServicesProviders_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "providerName": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "fabricName": "cloud1", + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryServicesProviders_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryServicesProviders_Get.json new file mode 100644 index 000000000000..3d7140cae48d --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryServicesProviders_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "providerName": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "fabricName": "cloud1", + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders", + "name": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "properties": { + "fabricType": "HyperVSite", + "friendlyName": "CP-B3L40406-12.ntdev.corp.microsoft.com", + "providerVersion": "5.1.2250.0", + "serverVersion": "3.2.7510.0", + "providerVersionState": "Latest", + "fabricFriendlyName": "cloud1", + "lastHeartBeat": "2017-04-27T09:16:04.9405768Z", + "connectionStatus": "Connected", + "protectedItemCount": 2, + "allowedScenarios": [ + "Refresh" + ] + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryServicesProviders_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryServicesProviders_List.json new file mode 100644 index 000000000000..86630986a110 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryServicesProviders_List.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders", + "name": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "properties": { + "fabricType": "HyperVSite", + "friendlyName": "CP-B3L40406-12.ntdev.corp.microsoft.com", + "providerVersion": "5.1.2250.0", + "serverVersion": "3.2.7510.0", + "providerVersionState": "Latest", + "fabricFriendlyName": "cloud1", + "lastHeartBeat": "2017-04-27T09:06:38.2728455Z", + "connectionStatus": "Connected", + "protectedItemCount": 2, + "allowedScenarios": [ + "Refresh" + ] + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryServicesProviders_ListByReplicationFabrics.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryServicesProviders_ListByReplicationFabrics.json new file mode 100644 index 000000000000..13542d064580 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryServicesProviders_ListByReplicationFabrics.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "fabricName": "cloud1", + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders", + "name": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "properties": { + "fabricType": "HyperVSite", + "friendlyName": "CP-B3L40406-12.ntdev.corp.microsoft.com", + "providerVersion": "5.1.2250.0", + "serverVersion": "3.2.7510.0", + "providerVersionState": "Latest", + "fabricFriendlyName": "cloud1", + "lastHeartBeat": "2017-04-27T09:06:38.2728455Z", + "connectionStatus": "Connected", + "protectedItemCount": 2, + "allowedScenarios": [ + "Refresh" + ] + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryServicesProviders_Purge.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryServicesProviders_Purge.json new file mode 100644 index 000000000000..d05c386856a5 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryServicesProviders_Purge.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "providerName": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "fabricName": "cloud1", + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryServicesProviders_RefreshProvider.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryServicesProviders_RefreshProvider.json new file mode 100644 index 000000000000..c9edd34d3b10 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationRecoveryServicesProviders_RefreshProvider.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "providerName": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "fabricName": "cloud1", + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationRecoveryServicesProviders/241641e6-ee7b-4ee4-8141-821fadda43fa", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders", + "name": "241641e6-ee7b-4ee4-8141-821fadda43fa", + "properties": { + "fabricType": "HyperVSite", + "friendlyName": "CP-B3L40406-12.ntdev.corp.microsoft.com", + "providerVersion": "5.1.2250.0", + "serverVersion": "3.2.7510.0", + "providerVersionState": "Latest", + "fabricFriendlyName": "cloud1", + "lastHeartBeat": "2017-04-27T09:48:36.6528303Z", + "connectionStatus": "Connected", + "protectedItemCount": 2, + "allowedScenarios": [ + "Refresh" + ] + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationStorageClassificationMappings_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationStorageClassificationMappings_Create.json new file mode 100644 index 000000000000..40280cf0127c --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationStorageClassificationMappings_Create.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "storageClassificationMappingName": "testStorageMapping", + "storageClassificationName": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "fabricName": "2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071", + "pairingInput": { + "properties": { + "targetStorageClassificationId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09/replicationStorageClassificationMappings/testStorageMapping", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings", + "name": "testStorageMapping", + "properties": { + "targetStorageClassificationId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationStorageClassificationMappings_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationStorageClassificationMappings_Delete.json new file mode 100644 index 000000000000..e70e8049fb51 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationStorageClassificationMappings_Delete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "storageClassificationMappingName": "testStorageMapping", + "storageClassificationName": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "fabricName": "2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationStorageClassificationMappings_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationStorageClassificationMappings_Get.json new file mode 100644 index 000000000000..02f276a604ce --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationStorageClassificationMappings_Get.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "storageClassificationMappingName": "testStorageMapping", + "storageClassificationName": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "fabricName": "2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09/replicationStorageClassificationMappings/testStorageMapping", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings", + "name": "testStorageMapping", + "properties": { + "targetStorageClassificationId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationStorageClassificationMappings_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationStorageClassificationMappings_List.json new file mode 100644 index 000000000000..91e4f1912ae6 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationStorageClassificationMappings_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09/replicationStorageClassificationMappings/testStorageMapping", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings", + "name": "testStorageMapping", + "properties": { + "targetStorageClassificationId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationStorageClassificationMappings_ListByReplicationStorageClassifications.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationStorageClassificationMappings_ListByReplicationStorageClassifications.json new file mode 100644 index 000000000000..0e22e8ba18dd --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationStorageClassificationMappings_ListByReplicationStorageClassifications.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "storageClassificationName": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "fabricName": "2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09/replicationStorageClassificationMappings/testStorageMapping", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings", + "name": "testStorageMapping", + "properties": { + "targetStorageClassificationId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationStorageClassifications_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationStorageClassifications_Get.json new file mode 100644 index 000000000000..1d9c3c922dc6 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationStorageClassifications_Get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "storageClassificationName": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "fabricName": "2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications", + "name": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "properties": { + "friendlyName": "testStorageClassification" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationStorageClassifications_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationStorageClassifications_List.json new file mode 100644 index 000000000000..f54645dad516 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationStorageClassifications_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications", + "name": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "properties": { + "friendlyName": "testStorageClassification" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationStorageClassifications_ListByReplicationFabrics.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationStorageClassifications_ListByReplicationFabrics.json new file mode 100644 index 000000000000..d961a0ba5d8b --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationStorageClassifications_ListByReplicationFabrics.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "fabricName": "2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "9112a37f-0f3e-46ec-9c00-060c6edca071" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/2a48e3770ac08aa2be8bfbd94fcfb1cbf2dcc487b78fb9d3bd778304441b06a0/replicationStorageClassifications/8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications", + "name": "8891569e-aaef-4a46-a4a0-78c14f2d7b09", + "properties": { + "friendlyName": "testStorageClassification" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationVaultHealth_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationVaultHealth_Get.json new file mode 100644 index 000000000000..41bdc39834b6 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationVaultHealth_Get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "name": "Default", + "type": "Microsoft.RecoveryServices/vaults/replicationVaultHealth", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationVaultHealth/Default", + "properties": { + "vaultErrors": [], + "protectedItemsHealth": { + "resourceCount": 6, + "issues": [ + { + "summaryCode": "10008", + "category": "Replication", + "severity": "Error", + "summaryMessage": "RPO Throttled", + "affectedResourceType": "replicationProtectedItems", + "affectedResourceSubtype": "", + "affectedResourceCorrelationIds": [ + "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "c183865e-6077-46f2-a3b1-ceb0a4c3751e" + ] + } + ] + }, + "fabricsHealth": { + "resourceCount": 1, + "issues": [] + } + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationVaultHealth_Refresh.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationVaultHealth_Refresh.json new file mode 100644 index 000000000000..93090e1d2799 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationVaultHealth_Refresh.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "name": "Default", + "type": "Microsoft.RecoveryServices/vaults/replicationVaultHealth", + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationVaultHealth/Default", + "properties": { + "vaultErrors": [], + "protectedItemsHealth": { + "resourceCount": 2, + "issues": [] + }, + "fabricsHealth": { + "resourceCount": 1, + "issues": [] + } + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationVaultSetting_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationVaultSetting_Create.json new file mode 100644 index 000000000000..5f345da9daca --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationVaultSetting_Create.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "vaultSettingName": "default", + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a", + "input": { + "properties": { + "migrationSolutionId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.Migrate/MigrateProjects/resourceGroupPS1-MigrateProject/Solutions/Servers-Migration-ServerMigration" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationVaultSettings/default", + "name": "default", + "type": "Microsoft.RecoveryServices/vaults/replicationVaultSettings", + "properties": { + "migrationSolutionId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.Migrate/MigrateProjects/resourceGroupPS1-MigrateProject/Solutions/Servers-Migration-ServerMigration" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationVaultSetting_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationVaultSetting_Get.json new file mode 100644 index 000000000000..e4a90559c3f0 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationVaultSetting_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "vaultSettingName": "default", + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationVaultSettings/default", + "name": "default", + "type": "Microsoft.RecoveryServices/vaults/replicationVaultSettings", + "properties": { + "migrationSolutionId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.Migrate/MigrateProjects/resourceGroupPS1-MigrateProject/Solutions/Servers-Migration-ServerMigration" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationVaultSetting_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationVaultSetting_List.json new file mode 100644 index 000000000000..f85a0e181ae7 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationVaultSetting_List.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationVaultSettings/default", + "name": "default", + "type": "Microsoft.RecoveryServices/vaults/replicationVaultSettings", + "properties": { + "migrationSolutionId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.Migrate/MigrateProjects/resourceGroupPS1-MigrateProject/Solutions/Servers-Migration-ServerMigration" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationvCenters_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationvCenters_Create.json new file mode 100644 index 000000000000..124f1ed5fa1f --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationvCenters_Create.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "vcenterName": "esx-78", + "fabricName": "MadhaviFabric", + "api-version": "2021-06-01", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574", + "addVCenterRequest": { + "properties": { + "friendlyName": "esx-78", + "ipAddress": "inmtest78", + "processServerId": "5A720CAB-39CB-F445-BD1662B0B33164B5", + "port": "443", + "runAsAccountId": "2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "esx-78", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters", + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationFabrics/239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d/replicationvCenters/esx-78", + "properties": { + "friendlyName": "esx-78", + "internalId": "inmtest78", + "discoveryStatus": "Pending", + "processServerId": "5A720CAB-39CB-F445-BD1662B0B33164B5", + "ipAddress": "inmtest78", + "port": "443", + "runAsAccountId": "2", + "fabricArmResourceName": "239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationvCenters_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationvCenters_Delete.json new file mode 100644 index 000000000000..f2a496fe6d02 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationvCenters_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "vcenterName": "esx-78", + "fabricName": "MadhaviFabric", + "api-version": "2021-06-01", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationvCenters_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationvCenters_Get.json new file mode 100644 index 000000000000..2cc1201b6105 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationvCenters_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "vcenterName": "esx-78", + "fabricName": "MadhaviFabric", + "api-version": "2021-06-01", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574" + }, + "responses": { + "200": { + "body": { + "name": "esx-78", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters", + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationFabrics/239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d/replicationvCenters/esx-78", + "properties": { + "friendlyName": "esx-78", + "internalId": "inmtest78", + "discoveryStatus": "Pending", + "processServerId": "5A720CAB-39CB-F445-BD1662B0B33164B5", + "ipAddress": "inmtest78", + "port": "443", + "runAsAccountId": "2", + "fabricArmResourceName": "239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationvCenters_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationvCenters_List.json new file mode 100644 index 000000000000..e58e9ae6bd3d --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationvCenters_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "esx-78", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters", + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationFabrics/239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d/replicationvCenters/esx-78", + "properties": { + "friendlyName": "esx-78", + "internalId": "inmtest78", + "discoveryStatus": "Pending", + "processServerId": "5A720CAB-39CB-F445-BD1662B0B33164B5", + "ipAddress": "inmtest78", + "port": "443", + "runAsAccountId": "2", + "fabricArmResourceName": "239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationvCenters_ListByReplicationFabrics.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationvCenters_ListByReplicationFabrics.json new file mode 100644 index 000000000000..71dc53d15e05 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationvCenters_ListByReplicationFabrics.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "fabricName": "MadhaviFabric", + "api-version": "2021-06-01", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "esx-78", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters", + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationFabrics/239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d/replicationvCenters/esx-78", + "properties": { + "friendlyName": "esx-78", + "internalId": "inmtest78", + "discoveryStatus": "Pending", + "processServerId": "5A720CAB-39CB-F445-BD1662B0B33164B5", + "ipAddress": "inmtest78", + "port": "443", + "runAsAccountId": "2", + "fabricArmResourceName": "239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationvCenters_Update.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationvCenters_Update.json new file mode 100644 index 000000000000..0b487b1ecae1 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/ReplicationvCenters_Update.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "vcenterName": "esx-78", + "fabricName": "MadhaviFabric", + "api-version": "2021-06-01", + "resourceName": "MadhaviVault", + "resourceGroupName": "MadhaviVRG", + "subscriptionId": "7c943c1b-5122-4097-90c8-861411bdd574", + "updateVCenterRequest": { + "properties": { + "ipAddress": "10.150.109.25" + } + } + }, + "responses": { + "200": { + "body": { + "name": "esx-78", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters", + "id": "/Subscriptions/7c943c1b-5122-4097-90c8-861411bdd574/resourceGroups/MadhaviVRG/providers/Microsoft.RecoveryServices/vaults/MadhaviVault/replicationFabrics/239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d/replicationvCenters/esx-78", + "properties": { + "friendlyName": "esx-78", + "internalId": "inmtest78", + "discoveryStatus": "Pending", + "processServerId": "5A720CAB-39CB-F445-BD1662B0B33164B5", + "ipAddress": "10.150.109.25", + "port": "443", + "runAsAccountId": "2", + "fabricArmResourceName": "239f778f368e34f78216d81f030725cdf2033174b47879b9f2eeede06fdd9c4d" + } + } + }, + "202": {} + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/SupportedOperatingSystems_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/SupportedOperatingSystems_Get.json new file mode 100644 index 000000000000..8e983aaaabbf --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/SupportedOperatingSystems_Get.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "resourceName": "vault1", + "resourceGroupName": "resourceGroupPS1", + "subscriptionId": "c183865e-6077-46f2-a3b1-deb0f4f4650a" + }, + "responses": { + "200": { + "body": { + "name": "Default", + "type": "Microsoft.RecoveryServices/vaults/replicationSupportedOperatingSystems", + "id": "/Subscriptions/bc403605-c2b0-43dd-abe9-0162124b1ee1/resourceGroups/oneBoxRG/providers/Microsoft.RecoveryServices/vaults/oneBoxRSVault/replicationSupportedOperatingSystems/Default", + "properties": { + "supportedOsList": [ + { + "instanceType": "A2A", + "supportedOs": [ + { + "osName": "centos", + "osType": "linux", + "osVersions": [ + { + "version": "6.0" + } + ] + }, + { + "osName": "Windows Server 2008 R2 Datacenter", + "osType": "windows", + "osVersions": [ + { + "version": "6.1", + "servicePack": "1" + } + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/TargetComputeSizes_ListByReplicationProtectedItems.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/TargetComputeSizes_ListByReplicationProtectedItems.json new file mode 100644 index 000000000000..5efea122a0f8 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/examples/TargetComputeSizes_ListByReplicationProtectedItems.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "replicatedProtectedItemName": "468c912d-b1ab-4ea2-97eb-4b5095155db2", + "protectionContainerName": "asr-a2a-default-centraluseuap-container", + "fabricName": "asr-a2a-default-centraluseuap", + "resourceName": "avraiMgDiskVault", + "resourceGroupName": "avraiMgDiskVaultRG", + "subscriptionId": "6808dbbc-98c7-431f-a1b1-9580902423b7" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/6808dbbc-98c7-431f-a1b1-9580902423b7/resourceGroups/avraiMgDiskVaultRG/providers/Microsoft.RecoveryServices/vaults/avraiMgDiskVault/replicationFabrics/asr-a2a-default-centraluseuap/replicationProtectionContainers/asr-a2a-default-centraluseuap-container/replicationProtectedItems/468c912d-b1ab-4ea2-97eb-4b5095155db2/targetComputeSizes/Basic_A0", + "name": "Basic_A0", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/targetComputeSizes", + "properties": { + "name": "Basic_A0", + "friendlyName": "Basic_A0", + "cpuCoresCount": 1, + "memoryInGB": 0.75, + "maxDataDiskCount": 1, + "maxNicsCount": 2, + "errors": null, + "highIopsSupported": "NotSupported" + } + }, + { + "id": "/Subscriptions/6808dbbc-98c7-431f-a1b1-9580902423b7/resourceGroups/avraiMgDiskVaultRG/providers/Microsoft.RecoveryServices/vaults/avraiMgDiskVault/replicationFabrics/asr-a2a-default-centraluseuap/replicationProtectionContainers/asr-a2a-default-centraluseuap-container/replicationProtectedItems/468c912d-b1ab-4ea2-97eb-4b5095155db2/targetComputeSizes/Standard_A0", + "name": "Standard_A0", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/targetComputeSizes", + "properties": { + "name": "Standard_A0", + "friendlyName": "Standard_A0", + "cpuCoresCount": 1, + "vCPUsAvailable": 1, + "memoryInGB": 0.75, + "maxDataDiskCount": 1, + "maxNicsCount": 2, + "errors": null, + "highIopsSupported": "NotSupported", + "hyperVGenerations": [ + "V1" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/service.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/service.json new file mode 100644 index 000000000000..eedffbf72a6a --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-06-01/service.json @@ -0,0 +1,23762 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01", + "title": "SiteRecoveryManagementClient", + "x-ms-code-generation-settings": { + "header": "MICROSOFT_MIT_NO_VERSION" + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Returns the list of available operations.", + "description": "Operation to return the list of available operations.", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationsDiscoveryCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Returns the list of available operations.": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationAlertSettings": { + "get": { + "tags": [ + "ReplicationAlertSettings" + ], + "summary": "Gets the list of configured email notification(alert) configurations.", + "description": "Gets the list of email notification(alert) configurations for the vault.", + "operationId": "ReplicationAlertSettings_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of configured email notification(alert) configurations.": { + "$ref": "./examples/ReplicationAlertSettings_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationAlertSettings/{alertSettingName}": { + "get": { + "tags": [ + "ReplicationAlertSettings" + ], + "summary": "Gets an email notification(alert) configuration.", + "description": "Gets the details of the specified email notification(alert) configuration.", + "operationId": "ReplicationAlertSettings_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "alertSettingName", + "in": "path", + "description": "The name of the email notification configuration.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Alert" + } + } + }, + "x-ms-examples": { + "Gets an email notification(alert) configuration.": { + "$ref": "./examples/ReplicationAlertSettings_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationAlertSettings" + ], + "summary": "Configures email notifications for this vault.", + "description": "Create or update an email notification(alert) configuration.", + "operationId": "ReplicationAlertSettings_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "alertSettingName", + "in": "path", + "description": "The name of the email notification(alert) configuration.", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "The input to configure the email notification(alert).", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigureAlertRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Alert" + } + } + }, + "x-ms-examples": { + "Configures email notifications for this vault.": { + "$ref": "./examples/ReplicationAlertSettings_Create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}/providers/Microsoft.RecoveryServices/replicationEligibilityResults": { + "get": { + "tags": [ + "ReplicationEligibilityResults" + ], + "summary": "Gets the validation errors in case the VM is unsuitable for protection.", + "description": "Validates whether a given VM can be protected or not in which case returns list of errors.", + "operationId": "ReplicationEligibilityResults_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "virtualMachineName", + "in": "path", + "description": "Virtual Machine name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationEligibilityResultsCollection" + } + } + }, + "x-ms-examples": { + "Gets the validation errors in case the VM is unsuitable for protection.": { + "$ref": "./examples/ReplicationEligibilityResults_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}/providers/Microsoft.RecoveryServices/replicationEligibilityResults/default": { + "get": { + "tags": [ + "ReplicationEligibilityResults" + ], + "summary": "Gets the validation errors in case the VM is unsuitable for protection.", + "description": "Validates whether a given VM can be protected or not in which case returns list of errors.", + "operationId": "ReplicationEligibilityResults_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "virtualMachineName", + "in": "path", + "description": "Virtual Machine name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationEligibilityResults" + } + } + }, + "x-ms-examples": { + "Gets the validation errors in case the VM is unsuitable for protection.": { + "$ref": "./examples/ReplicationEligibilityResults_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationEvents": { + "get": { + "tags": [ + "ReplicationEvents" + ], + "summary": "Gets the list of Azure Site Recovery events.", + "description": "Gets the list of Azure Site Recovery events for the vault.", + "operationId": "ReplicationEvents_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/EventQueryParameter", + "x-ms-examples": { + "Gets the list of Azure Site Recovery events.": { + "$ref": "./examples/ReplicationEvents_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationEvents/{eventName}": { + "get": { + "tags": [ + "ReplicationEvents" + ], + "summary": "Get the details of an Azure Site recovery event.", + "description": "The operation to get the details of an Azure Site recovery event.", + "operationId": "ReplicationEvents_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "eventName", + "in": "path", + "description": "The name of the Azure Site Recovery event.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Event" + } + } + }, + "x-ms-examples": { + "Get the details of an Azure Site recovery event.": { + "$ref": "./examples/ReplicationEvents_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics": { + "get": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Gets the list of ASR fabrics.", + "description": "Gets a list of the Azure Site Recovery fabrics in the vault.", + "operationId": "ReplicationFabrics_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FabricCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of ASR fabrics.": { + "$ref": "./examples/ReplicationFabrics_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}": { + "get": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Gets the details of an ASR fabric.", + "description": "Gets the details of an Azure Site Recovery fabric.", + "operationId": "ReplicationFabrics_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Fabric" + } + } + }, + "x-ms-odata": "#/definitions/FabricQueryParameter", + "x-ms-examples": { + "Gets the details of an ASR fabric.": { + "$ref": "./examples/ReplicationFabrics_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Creates an Azure Site Recovery fabric.", + "description": "The operation to create an Azure Site Recovery fabric (for e.g. Hyper-V site).", + "operationId": "ReplicationFabrics_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Name of the ASR fabric.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Fabric creation input.", + "required": true, + "schema": { + "$ref": "#/definitions/FabricCreationInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Fabric" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Creates an Azure Site Recovery fabric.": { + "$ref": "./examples/ReplicationFabrics_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Purges the site.", + "description": "The operation to purge(force delete) an Azure Site Recovery fabric.", + "operationId": "ReplicationFabrics_Purge", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "ASR fabric to purge.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Purges the site.": { + "$ref": "./examples/ReplicationFabrics_Purge.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/checkConsistency": { + "post": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Checks the consistency of the ASR fabric.", + "description": "The operation to perform a consistency check on the fabric.", + "operationId": "ReplicationFabrics_CheckConsistency", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Fabric" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Checks the consistency of the ASR fabric.": { + "$ref": "./examples/ReplicationFabrics_CheckConsistency.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/migratetoaad": { + "post": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Migrates the site to AAD.", + "description": "The operation to migrate an Azure Site Recovery fabric to AAD.", + "operationId": "ReplicationFabrics_MigrateToAad", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "ASR fabric to migrate.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Migrates the site to AAD.": { + "$ref": "./examples/ReplicationFabrics_MigrateToAad.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/reassociateGateway": { + "post": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Perform failover of the process server.", + "description": "The operation to move replications from a process server to another process server.", + "operationId": "ReplicationFabrics_ReassociateGateway", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "The name of the fabric containing the process server.", + "required": true, + "type": "string" + }, + { + "name": "failoverProcessServerRequest", + "in": "body", + "description": "The input to the failover process server operation.", + "required": true, + "schema": { + "$ref": "#/definitions/FailoverProcessServerRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Fabric" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Perform failover of the process server.": { + "$ref": "./examples/ReplicationFabrics_ReassociateGateway.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/remove": { + "post": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Deletes the site.", + "description": "The operation to delete or remove an Azure Site Recovery fabric.", + "operationId": "ReplicationFabrics_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "ASR fabric to delete.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes the site.": { + "$ref": "./examples/ReplicationFabrics_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/renewCertificate": { + "post": { + "tags": [ + "ReplicationFabrics" + ], + "summary": "Renews certificate for the fabric.", + "description": "Renews the connection certificate for the ASR replication fabric.", + "operationId": "ReplicationFabrics_RenewCertificate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "fabric name to renew certs for.", + "required": true, + "type": "string" + }, + { + "name": "renewCertificate", + "in": "body", + "description": "Renew certificate input.", + "required": true, + "schema": { + "$ref": "#/definitions/RenewCertificateInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Fabric" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Renews certificate for the fabric.": { + "$ref": "./examples/ReplicationFabrics_RenewCertificate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationLogicalNetworks": { + "get": { + "tags": [ + "ReplicationLogicalNetworks" + ], + "summary": "Gets the list of logical networks under a fabric.", + "description": "Lists all the logical networks of the Azure Site Recovery fabric.", + "operationId": "ReplicationLogicalNetworks_ListByReplicationFabrics", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Server Id.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LogicalNetworkCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of logical networks under a fabric.": { + "$ref": "./examples/ReplicationLogicalNetworks_ListByReplicationFabrics.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationLogicalNetworks/{logicalNetworkName}": { + "get": { + "tags": [ + "ReplicationLogicalNetworks" + ], + "summary": "Gets a logical network with specified server id and logical network name.", + "description": "Gets the details of a logical network.", + "operationId": "ReplicationLogicalNetworks_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Server Id.", + "required": true, + "type": "string" + }, + { + "name": "logicalNetworkName", + "in": "path", + "description": "Logical network name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LogicalNetwork" + } + } + }, + "x-ms-examples": { + "Gets a logical network with specified server id and logical network name.": { + "$ref": "./examples/ReplicationLogicalNetworks_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks": { + "get": { + "tags": [ + "ReplicationNetworks" + ], + "summary": "Gets the list of networks under a fabric.", + "description": "Lists the networks available for a fabric.", + "operationId": "ReplicationNetworks_ListByReplicationFabrics", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of networks under a fabric.": { + "$ref": "./examples/ReplicationNetworks_ListByReplicationFabrics.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks/{networkName}": { + "get": { + "tags": [ + "ReplicationNetworks" + ], + "summary": "Gets a network with specified server id and network name.", + "description": "Gets the details of a network.", + "operationId": "ReplicationNetworks_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Server Id.", + "required": true, + "type": "string" + }, + { + "name": "networkName", + "in": "path", + "description": "Primary network name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Network" + } + } + }, + "x-ms-examples": { + "Gets a network with specified server id and network name.": { + "$ref": "./examples/ReplicationNetworks_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks/{networkName}/replicationNetworkMappings": { + "get": { + "tags": [ + "ReplicationNetworkMappings" + ], + "summary": "Gets all the network mappings under a network.", + "description": "Lists all ASR network mappings for the specified network.", + "operationId": "ReplicationNetworkMappings_ListByReplicationNetworks", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Primary fabric name.", + "required": true, + "type": "string" + }, + { + "name": "networkName", + "in": "path", + "description": "Primary network name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkMappingCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all the network mappings under a network.": { + "$ref": "./examples/ReplicationNetworkMappings_ListByReplicationNetworks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks/{networkName}/replicationNetworkMappings/{networkMappingName}": { + "get": { + "tags": [ + "ReplicationNetworkMappings" + ], + "summary": "Gets network mapping by name.", + "description": "Gets the details of an ASR network mapping.", + "operationId": "ReplicationNetworkMappings_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Primary fabric name.", + "required": true, + "type": "string" + }, + { + "name": "networkName", + "in": "path", + "description": "Primary network name.", + "required": true, + "type": "string" + }, + { + "name": "networkMappingName", + "in": "path", + "description": "Network mapping name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkMapping" + } + } + }, + "x-ms-examples": { + "Gets network mapping by name.": { + "$ref": "./examples/ReplicationNetworkMappings_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationNetworkMappings" + ], + "summary": "Creates network mapping.", + "description": "The operation to create an ASR network mapping.", + "operationId": "ReplicationNetworkMappings_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Primary fabric name.", + "required": true, + "type": "string" + }, + { + "name": "networkName", + "in": "path", + "description": "Primary network name.", + "required": true, + "type": "string" + }, + { + "name": "networkMappingName", + "in": "path", + "description": "Network mapping name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Create network mapping input.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateNetworkMappingInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkMapping" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Creates network mapping.": { + "$ref": "./examples/ReplicationNetworkMappings_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationNetworkMappings" + ], + "summary": "Delete network mapping.", + "description": "The operation to delete a network mapping.", + "operationId": "ReplicationNetworkMappings_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Primary fabric name.", + "required": true, + "type": "string" + }, + { + "name": "networkName", + "in": "path", + "description": "Primary network name.", + "required": true, + "type": "string" + }, + { + "name": "networkMappingName", + "in": "path", + "description": "ARM Resource Name for network mapping.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete network mapping.": { + "$ref": "./examples/ReplicationNetworkMappings_Delete.json" + } + } + }, + "patch": { + "tags": [ + "ReplicationNetworkMappings" + ], + "summary": "Updates network mapping.", + "description": "The operation to update an ASR network mapping.", + "operationId": "ReplicationNetworkMappings_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Primary fabric name.", + "required": true, + "type": "string" + }, + { + "name": "networkName", + "in": "path", + "description": "Primary network name.", + "required": true, + "type": "string" + }, + { + "name": "networkMappingName", + "in": "path", + "description": "Network mapping name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Update network mapping input.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateNetworkMappingInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkMapping" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates network mapping.": { + "$ref": "./examples/ReplicationNetworkMappings_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers": { + "get": { + "tags": [ + "ReplicationProtectionContainers" + ], + "summary": "Gets the list of protection container for a fabric.", + "description": "Lists the protection containers in the specified fabric.", + "operationId": "ReplicationProtectionContainers_ListByReplicationFabrics", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of protection container for a fabric.": { + "$ref": "./examples/ReplicationProtectionContainers_ListByReplicationFabrics.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}": { + "get": { + "tags": [ + "ReplicationProtectionContainers" + ], + "summary": "Gets the protection container details.", + "description": "Gets the details of a protection container.", + "operationId": "ReplicationProtectionContainers_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainer" + } + } + }, + "x-ms-examples": { + "Gets the protection container details.": { + "$ref": "./examples/ReplicationProtectionContainers_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationProtectionContainers" + ], + "summary": "Create a protection container.", + "description": "Operation to create a protection container.", + "operationId": "ReplicationProtectionContainers_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric ARM name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Unique protection container ARM name.", + "required": true, + "type": "string" + }, + { + "name": "creationInput", + "in": "body", + "description": "Creation input.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateProtectionContainerInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainer" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a protection container.": { + "$ref": "./examples/ReplicationProtectionContainers_Create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/discoverProtectableItem": { + "post": { + "tags": [ + "ReplicationProtectionContainers" + ], + "summary": "Adds a protectable item to the replication protection container.", + "description": "The operation to a add a protectable item to a protection container(Add physical server).", + "operationId": "ReplicationProtectionContainers_DiscoverProtectableItem", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "The name of the fabric.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "The name of the protection container.", + "required": true, + "type": "string" + }, + { + "name": "discoverProtectableItemRequest", + "in": "body", + "description": "The request object to add a protectable item.", + "required": true, + "schema": { + "$ref": "#/definitions/DiscoverProtectableItemRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainer" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Adds a protectable item to the replication protection container.": { + "$ref": "./examples/ReplicationProtectionContainers_DiscoverProtectableItem.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/remove": { + "post": { + "tags": [ + "ReplicationProtectionContainers" + ], + "summary": "Removes a protection container.", + "description": "Operation to remove a protection container.", + "operationId": "ReplicationProtectionContainers_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric ARM name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Unique protection container ARM name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Removes a protection container.": { + "$ref": "./examples/ReplicationProtectionContainers_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems": { + "get": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Gets the list of migration items in the protection container.", + "description": "Gets the list of ASR migration items in the protection container.", + "operationId": "ReplicationMigrationItems_ListByReplicationProtectionContainers", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "skipToken", + "in": "query", + "description": "The pagination token.", + "required": false, + "type": "string" + }, + { + "name": "takeToken", + "in": "query", + "description": "The page size.", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItemCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/MigrationItemsQueryParameter", + "x-ms-examples": { + "Gets the list of migration items in the protection container.": { + "$ref": "./examples/ReplicationMigrationItems_ListByReplicationProtectionContainers.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}": { + "get": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Gets the details of a migration item.", + "operationId": "ReplicationMigrationItems_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric unique name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + } + }, + "x-ms-examples": { + "Gets the details of a migration item.": { + "$ref": "./examples/ReplicationMigrationItems_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Enables migration.", + "description": "The operation to create an ASR migration item (enable migration).", + "operationId": "ReplicationMigrationItems_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Enable migration input.", + "required": true, + "schema": { + "$ref": "#/definitions/EnableMigrationInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Enables migration.": { + "$ref": "./examples/ReplicationMigrationItems_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Delete the migration item.", + "description": "The operation to delete an ASR migration item.", + "operationId": "ReplicationMigrationItems_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "deleteOption", + "in": "query", + "description": "The delete option.", + "required": false, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete the migration item.": { + "$ref": "./examples/ReplicationMigrationItems_Delete.json" + } + } + }, + "patch": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Updates migration item.", + "description": "The operation to update the recovery settings of an ASR migration item.", + "operationId": "ReplicationMigrationItems_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Update migration item input.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateMigrationItemInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates migration item.": { + "$ref": "./examples/ReplicationMigrationItems_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/migrate": { + "post": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Migrate item.", + "description": "The operation to initiate migration of the item.", + "operationId": "ReplicationMigrationItems_Migrate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "migrateInput", + "in": "body", + "description": "Migrate input.", + "required": true, + "schema": { + "$ref": "#/definitions/MigrateInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Migrate item.": { + "$ref": "./examples/ReplicationMigrationItems_Migrate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/migrationRecoveryPoints": { + "get": { + "tags": [ + "MigrationRecoveryPoints" + ], + "summary": "Gets the recovery points for a migration item.", + "operationId": "MigrationRecoveryPoints_ListByReplicationMigrationItems", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric unique name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationRecoveryPointCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the recovery points for a migration item.": { + "$ref": "./examples/MigrationRecoveryPoints_ListByReplicationMigrationItems.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/migrationRecoveryPoints/{migrationRecoveryPointName}": { + "get": { + "tags": [ + "MigrationRecoveryPoints" + ], + "summary": "Gets a recovery point for a migration item.", + "operationId": "MigrationRecoveryPoints_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric unique name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "migrationRecoveryPointName", + "in": "path", + "description": "The migration recovery point name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationRecoveryPoint" + } + } + }, + "x-ms-examples": { + "Gets a recovery point for a migration item.": { + "$ref": "./examples/MigrationRecoveryPoints_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/resync": { + "post": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Resynchronizes replication.", + "description": "The operation to resynchronize replication of an ASR migration item.", + "operationId": "ReplicationMigrationItems_Resync", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Resync input.", + "required": true, + "schema": { + "$ref": "#/definitions/ResyncInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Resynchronizes replication.": { + "$ref": "./examples/ReplicationMigrationItems_Resync.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/testMigrate": { + "post": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Test migrate item.", + "description": "The operation to initiate test migration of the item.", + "operationId": "ReplicationMigrationItems_TestMigrate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "testMigrateInput", + "in": "body", + "description": "Test migrate input.", + "required": true, + "schema": { + "$ref": "#/definitions/TestMigrateInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Test migrate item.": { + "$ref": "./examples/ReplicationMigrationItems_TestMigrate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/testMigrateCleanup": { + "post": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Test migrate cleanup.", + "description": "The operation to initiate test migrate cleanup.", + "operationId": "ReplicationMigrationItems_TestMigrateCleanup", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "testMigrateCleanupInput", + "in": "body", + "description": "Test migrate cleanup input.", + "required": true, + "schema": { + "$ref": "#/definitions/TestMigrateCleanupInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Test migrate cleanup.": { + "$ref": "./examples/ReplicationMigrationItems_TestMigrateCleanup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectableItems": { + "get": { + "tags": [ + "ReplicationProtectableItems" + ], + "summary": "Gets the list of protectable items.", + "description": "Lists the protectable items in a protection container.", + "operationId": "ReplicationProtectableItems_ListByReplicationProtectionContainers", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + }, + { + "name": "$take", + "in": "query", + "description": "take OData query parameter.", + "required": false, + "type": "string" + }, + { + "name": "$skipToken", + "in": "query", + "description": "skipToken OData query parameter.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectableItemCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ProtectableItemQueryParameter", + "x-ms-examples": { + "Gets the list of protectable items.": { + "$ref": "./examples/ReplicationProtectableItems_ListByReplicationProtectionContainers.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectableItems/{protectableItemName}": { + "get": { + "tags": [ + "ReplicationProtectableItems" + ], + "summary": "Gets the details of a protectable item.", + "description": "The operation to get the details of a protectable item.", + "operationId": "ReplicationProtectableItems_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "protectableItemName", + "in": "path", + "description": "Protectable item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectableItem" + } + } + }, + "x-ms-examples": { + "Gets the details of a protectable item.": { + "$ref": "./examples/ReplicationProtectableItems_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems": { + "get": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Gets the list of Replication protected items.", + "description": "Gets the list of ASR replication protected items in the protection container.", + "operationId": "ReplicationProtectedItems_ListByReplicationProtectionContainers", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItemCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of Replication protected items.": { + "$ref": "./examples/ReplicationProtectedItems_ListByReplicationProtectionContainers.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}": { + "get": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Gets the details of a Replication protected item.", + "description": "Gets the details of an ASR replication protected item.", + "operationId": "ReplicationProtectedItems_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric unique name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + } + }, + "x-ms-examples": { + "Gets the details of a Replication protected item.": { + "$ref": "./examples/ReplicationProtectedItems_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Enables protection.", + "description": "The operation to create an ASR replication protected item (Enable replication).", + "operationId": "ReplicationProtectedItems_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Name of the fabric.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "A name for the replication protected item.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Enable Protection Input.", + "required": true, + "schema": { + "$ref": "#/definitions/EnableProtectionInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Enables protection.": { + "$ref": "./examples/ReplicationProtectedItems_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Purges protection.", + "description": "The operation to delete or purge a replication protected item. This operation will force delete the replication protected item. Use the remove operation on replication protected item to perform a clean disable replication for the item.", + "operationId": "ReplicationProtectedItems_Purge", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Purges protection.": { + "$ref": "./examples/ReplicationProtectedItems_Purge.json" + } + } + }, + "patch": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Updates the replication protected item settings.", + "description": "The operation to update the recovery settings of an ASR replication protected item.", + "operationId": "ReplicationProtectedItems_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "updateProtectionInput", + "in": "body", + "description": "Update protection input.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateReplicationProtectedItemInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates the replication protected Item settings.": { + "$ref": "./examples/ReplicationProtectedItems_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/addDisks": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Add disk(s) for protection.", + "description": "Operation to add disks(s) to the replication protected item.", + "operationId": "ReplicationProtectedItems_AddDisks", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "addDisksInput", + "in": "body", + "description": "Add disks input.", + "required": true, + "schema": { + "$ref": "#/definitions/AddDisksInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Add disk(s) for protection.": { + "$ref": "./examples/ReplicationProtectedItems_AddDisks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/applyRecoveryPoint": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Change or apply recovery point.", + "description": "The operation to change the recovery point of a failed over replication protected item.", + "operationId": "ReplicationProtectedItems_ApplyRecoveryPoint", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "The ARM fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "The protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "The replicated protected item name.", + "required": true, + "type": "string" + }, + { + "name": "applyRecoveryPointInput", + "in": "body", + "description": "The ApplyRecoveryPointInput.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplyRecoveryPointInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Change or apply recovery point.": { + "$ref": "./examples/ReplicationProtectedItems_ApplyRecoveryPoint.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/failoverCancel": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute cancel failover.", + "description": "Operation to cancel the failover of the replication protected item.", + "operationId": "ReplicationProtectedItems_FailoverCancel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute cancel failover.": { + "$ref": "./examples/ReplicationProtectedItems_FailoverCancel.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/failoverCommit": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute commit failover.", + "description": "Operation to commit the failover of the replication protected item.", + "operationId": "ReplicationProtectedItems_FailoverCommit", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute commit failover.": { + "$ref": "./examples/ReplicationProtectedItems_FailoverCommit.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/plannedFailover": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute planned failover.", + "description": "Operation to initiate a planned failover of the replication protected item.", + "operationId": "ReplicationProtectedItems_PlannedFailover", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "failoverInput", + "in": "body", + "description": "Planned failover input.", + "required": true, + "schema": { + "$ref": "#/definitions/PlannedFailoverInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute planned failover.": { + "$ref": "./examples/ReplicationProtectedItems_PlannedFailover.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/recoveryPoints": { + "get": { + "tags": [ + "RecoveryPoints" + ], + "summary": "Gets the list of recovery points for a replication protected item.", + "description": "Lists the available recovery points for a replication protected item.", + "operationId": "RecoveryPoints_ListByReplicationProtectedItems", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "The fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "The protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "The replication protected item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPointCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of recovery points for a replication protected item.": { + "$ref": "./examples/RecoveryPoints_ListByReplicationProtectedItems.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/recoveryPoints/{recoveryPointName}": { + "get": { + "tags": [ + "RecoveryPoints" + ], + "summary": "Gets a recovery point.", + "description": "Get the details of specified recovery point.", + "operationId": "RecoveryPoints_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "The fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "The protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "The replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "recoveryPointName", + "in": "path", + "description": "The recovery point name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPoint" + } + } + }, + "x-ms-examples": { + "Gets a recovery point.": { + "$ref": "./examples/RecoveryPoints_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/remove": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Disables protection.", + "description": "The operation to disable replication on a replication protected item. This will also remove the item.", + "operationId": "ReplicationProtectedItems_Delete", + "consumes": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "disableProtectionInput", + "in": "body", + "description": "Disable protection input.", + "required": true, + "schema": { + "$ref": "#/definitions/DisableProtectionInput" + } + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Disables protection.": { + "$ref": "./examples/ReplicationProtectedItems_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/removeDisks": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Removes disk(s).", + "description": "Operation to remove disk(s) from the replication protected item.", + "operationId": "ReplicationProtectedItems_RemoveDisks", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "removeDisksInput", + "in": "body", + "description": "Remove disks input.", + "required": true, + "schema": { + "$ref": "#/definitions/RemoveDisksInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Removes disk(s).": { + "$ref": "./examples/ReplicationProtectedItems_RemoveDisks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/repairReplication": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Resynchronize or repair replication.", + "description": "The operation to start resynchronize/repair replication for a replication protected item requiring resynchronization.", + "operationId": "ReplicationProtectedItems_RepairReplication", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "The name of the fabric.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "The name of the container.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "The name of the replication protected item.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Resynchronize or repair replication.": { + "$ref": "./examples/ReplicationProtectedItems_RepairReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/reProtect": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute Reverse Replication\\Reprotect.", + "description": "Operation to reprotect or reverse replicate a failed over replication protected item.", + "operationId": "ReplicationProtectedItems_Reprotect", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "reprotectInput", + "in": "body", + "description": "Reverse replication input.", + "required": true, + "schema": { + "$ref": "#/definitions/ReverseReplicationInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute Reverse Replication\\Reprotect.": { + "$ref": "./examples/ReplicationProtectedItems_Reprotect.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/resolveHealthErrors": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Resolve health errors.", + "description": "Operation to resolve health issues of the replication protected item.", + "operationId": "ReplicationProtectedItems_ResolveHealthErrors", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "resolveHealthInput", + "in": "body", + "description": "Health issue input object.", + "required": true, + "schema": { + "$ref": "#/definitions/ResolveHealthInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Resolve health errors.": { + "$ref": "./examples/ReplicationProtectedItems_ResolveHealthErrors.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/targetComputeSizes": { + "get": { + "tags": [ + "TargetComputeSizes" + ], + "summary": "Gets the list of target compute sizes for the replication protected item.", + "description": "Lists the available target compute sizes for a replication protected item.", + "operationId": "TargetComputeSizes_ListByReplicationProtectedItems", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TargetComputeSizeCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of target compute sizes for the replication protected item.": { + "$ref": "./examples/TargetComputeSizes_ListByReplicationProtectedItems.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/testFailover": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute test failover.", + "description": "Operation to perform a test failover of the replication protected item.", + "operationId": "ReplicationProtectedItems_TestFailover", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "testfailoverInput", + "in": "body", + "description": "Test failover input.", + "required": true, + "schema": { + "$ref": "#/definitions/TestFailoverInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute test failover.": { + "$ref": "./examples/ReplicationProtectedItems_TestFailover.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/testFailoverCleanup": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute test failover cleanup.", + "description": "Operation to clean up the test failover of a replication protected item.", + "operationId": "ReplicationProtectedItems_TestFailoverCleanup", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "cleanupInput", + "in": "body", + "description": "Test failover cleanup input.", + "required": true, + "schema": { + "$ref": "#/definitions/TestFailoverCleanupInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute test failover cleanup.": { + "$ref": "./examples/ReplicationProtectedItems_TestFailoverCleanup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/unplannedFailover": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute unplanned failover.", + "description": "Operation to initiate a failover of the replication protected item.", + "operationId": "ReplicationProtectedItems_UnplannedFailover", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "failoverInput", + "in": "body", + "description": "Failover input.", + "required": true, + "schema": { + "$ref": "#/definitions/UnplannedFailoverInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute unplanned failover.": { + "$ref": "./examples/ReplicationProtectedItems_UnplannedFailover.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/updateAppliance": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Updates appliance for replication protected Item.", + "description": "The operation to update appliance of an ASR replication protected item.", + "operationId": "ReplicationProtectedItems_UpdateAppliance", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "applianceUpdateInput", + "in": "body", + "description": "Appliance update protection input.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateApplianceForReplicationProtectedItemInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates appliance for replication protected Item.": { + "$ref": "./examples/ReplicationProtectedItems_UpdateAppliance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicationProtectedItemName}/updateMobilityService": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Update the mobility service on a protected item.", + "description": "The operation to update(push update) the installed mobility service software on a replication protected item to the latest available version.", + "operationId": "ReplicationProtectedItems_UpdateMobilityService", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "The name of the fabric containing the protected item.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "The name of the container containing the protected item.", + "required": true, + "type": "string" + }, + { + "name": "replicationProtectedItemName", + "in": "path", + "description": "The name of the protected item on which the agent is to be updated.", + "required": true, + "type": "string" + }, + { + "name": "updateMobilityServiceRequest", + "in": "body", + "description": "Request to update the mobility service on the protected item.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateMobilityServiceRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update the mobility service on a protected item.": { + "$ref": "./examples/ReplicationProtectedItems_UpdateMobilityService.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings": { + "get": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Gets the list of protection container mappings for a protection container.", + "description": "Lists the protection container mappings for a protection container.", + "operationId": "ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerMappingCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of protection container mappings for a protection container.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings/{mappingName}": { + "get": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Gets a protection container mapping.", + "description": "Gets the details of a protection container mapping.", + "operationId": "ReplicationProtectionContainerMappings_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "mappingName", + "in": "path", + "description": "Protection Container mapping name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerMapping" + } + } + }, + "x-ms-examples": { + "Gets a protection container mapping.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Create protection container mapping.", + "description": "The operation to create a protection container mapping.", + "operationId": "ReplicationProtectionContainerMappings_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "mappingName", + "in": "path", + "description": "Protection container mapping name.", + "required": true, + "type": "string" + }, + { + "name": "creationInput", + "in": "body", + "description": "Mapping creation input.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateProtectionContainerMappingInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerMapping" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create protection container mapping.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Purge protection container mapping.", + "description": "The operation to purge(force delete) a protection container mapping.", + "operationId": "ReplicationProtectionContainerMappings_Purge", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "mappingName", + "in": "path", + "description": "Protection container mapping name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Purge protection container mapping.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_Purge.json" + } + } + }, + "patch": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Update protection container mapping.", + "description": "The operation to update protection container mapping.", + "operationId": "ReplicationProtectionContainerMappings_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "mappingName", + "in": "path", + "description": "Protection container mapping name.", + "required": true, + "type": "string" + }, + { + "name": "updateInput", + "in": "body", + "description": "Mapping update input.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateProtectionContainerMappingInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerMapping" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update protection container mapping.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings/{mappingName}/remove": { + "post": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Remove protection container mapping.", + "description": "The operation to delete or remove a protection container mapping.", + "operationId": "ReplicationProtectionContainerMappings_Delete", + "consumes": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "mappingName", + "in": "path", + "description": "Protection container mapping name.", + "required": true, + "type": "string" + }, + { + "name": "removalInput", + "in": "body", + "description": "Removal input.", + "required": true, + "schema": { + "$ref": "#/definitions/RemoveProtectionContainerMappingInput" + } + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Remove protection container mapping.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/switchprotection": { + "post": { + "tags": [ + "ReplicationProtectionContainers" + ], + "summary": "Switches protection from one container to another or one replication provider to another.", + "description": "Operation to switch protection from one container to another or one replication provider to another.", + "operationId": "ReplicationProtectionContainers_SwitchProtection", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "switchInput", + "in": "body", + "description": "Switch protection input.", + "required": true, + "schema": { + "$ref": "#/definitions/SwitchProtectionInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainer" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Switches protection from one container to another or one replication provider to another.": { + "$ref": "./examples/ReplicationProtectionContainers_SwitchProtection.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders": { + "get": { + "tags": [ + "ReplicationRecoveryServicesProviders" + ], + "summary": "Gets the list of registered recovery services providers for the fabric.", + "description": "Lists the registered recovery services providers for the specified fabric.", + "operationId": "ReplicationRecoveryServicesProviders_ListByReplicationFabrics", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryServicesProviderCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of registered recovery services providers for the fabric.": { + "$ref": "./examples/ReplicationRecoveryServicesProviders_ListByReplicationFabrics.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders/{providerName}": { + "get": { + "tags": [ + "ReplicationRecoveryServicesProviders" + ], + "summary": "Gets the details of a recovery services provider.", + "description": "Gets the details of registered recovery services provider.", + "operationId": "ReplicationRecoveryServicesProviders_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Recovery services provider name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryServicesProvider" + } + } + }, + "x-ms-examples": { + "Gets the details of a recovery services provider.": { + "$ref": "./examples/ReplicationRecoveryServicesProviders_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationRecoveryServicesProviders" + ], + "summary": "Adds a recovery services provider.", + "description": "The operation to add a recovery services provider.", + "operationId": "ReplicationRecoveryServicesProviders_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Recovery services provider name.", + "required": true, + "type": "string" + }, + { + "name": "addProviderInput", + "in": "body", + "description": "Add provider input.", + "required": true, + "schema": { + "$ref": "#/definitions/AddRecoveryServicesProviderInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryServicesProvider" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Adds a recovery services provider.": { + "$ref": "./examples/ReplicationRecoveryServicesProviders_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationRecoveryServicesProviders" + ], + "summary": "Purges recovery service provider from fabric.", + "description": "The operation to purge(force delete) a recovery services provider from the vault.", + "operationId": "ReplicationRecoveryServicesProviders_Purge", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Recovery services provider name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Purges recovery service provider from fabric.": { + "$ref": "./examples/ReplicationRecoveryServicesProviders_Purge.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders/{providerName}/refreshProvider": { + "post": { + "tags": [ + "ReplicationRecoveryServicesProviders" + ], + "summary": "Refresh details from the recovery services provider.", + "description": "The operation to refresh the information from the recovery services provider.", + "operationId": "ReplicationRecoveryServicesProviders_RefreshProvider", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Recovery services provider name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryServicesProvider" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Refresh details from the recovery services provider.": { + "$ref": "./examples/ReplicationRecoveryServicesProviders_RefreshProvider.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders/{providerName}/remove": { + "post": { + "tags": [ + "ReplicationRecoveryServicesProviders" + ], + "summary": "Deletes provider from fabric. Note: Deleting provider for any fabric other than SingleHost is unsupported. To maintain backward compatibility for released clients the object \"deleteRspInput\" is used (if the object is empty we assume that it is old client and continue the old behavior).", + "description": "The operation to removes/delete(unregister) a recovery services provider from the vault.", + "operationId": "ReplicationRecoveryServicesProviders_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Recovery services provider name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes provider from fabric. Note: Deleting provider for any fabric other than SingleHost is unsupported. To maintain backward compatibility for released clients the object \"deleteRspInput\" is used (if the object is empty we assume that it is old client and continue the old behavior).": { + "$ref": "./examples/ReplicationRecoveryServicesProviders_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationStorageClassifications": { + "get": { + "tags": [ + "ReplicationStorageClassifications" + ], + "summary": "Gets the list of storage classification objects under a fabric.", + "description": "Lists the storage classifications available in the specified fabric.", + "operationId": "ReplicationStorageClassifications_ListByReplicationFabrics", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Site name of interest.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageClassificationCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of storage classification objects under a fabric.": { + "$ref": "./examples/ReplicationStorageClassifications_ListByReplicationFabrics.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationStorageClassifications/{storageClassificationName}": { + "get": { + "tags": [ + "ReplicationStorageClassifications" + ], + "summary": "Gets the details of a storage classification.", + "description": "Gets the details of the specified storage classification.", + "operationId": "ReplicationStorageClassifications_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationName", + "in": "path", + "description": "Storage classification name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageClassification" + } + } + }, + "x-ms-examples": { + "Gets the details of a storage classification.": { + "$ref": "./examples/ReplicationStorageClassifications_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationStorageClassifications/{storageClassificationName}/replicationStorageClassificationMappings": { + "get": { + "tags": [ + "ReplicationStorageClassificationMappings" + ], + "summary": "Gets the list of storage classification mappings objects under a storage.", + "description": "Lists the storage classification mappings for the fabric.", + "operationId": "ReplicationStorageClassificationMappings_ListByReplicationStorageClassifications", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationName", + "in": "path", + "description": "Storage classification name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageClassificationMappingCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of storage classification mappings objects under a storage.": { + "$ref": "./examples/ReplicationStorageClassificationMappings_ListByReplicationStorageClassifications.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationStorageClassifications/{storageClassificationName}/replicationStorageClassificationMappings/{storageClassificationMappingName}": { + "get": { + "tags": [ + "ReplicationStorageClassificationMappings" + ], + "summary": "Gets the details of a storage classification mapping.", + "description": "Gets the details of the specified storage classification mapping.", + "operationId": "ReplicationStorageClassificationMappings_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationName", + "in": "path", + "description": "Storage classification name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationMappingName", + "in": "path", + "description": "Storage classification mapping name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageClassificationMapping" + } + } + }, + "x-ms-examples": { + "Gets the details of a storage classification mapping.": { + "$ref": "./examples/ReplicationStorageClassificationMappings_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationStorageClassificationMappings" + ], + "summary": "Create storage classification mapping.", + "description": "The operation to create a storage classification mapping.", + "operationId": "ReplicationStorageClassificationMappings_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationName", + "in": "path", + "description": "Storage classification name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationMappingName", + "in": "path", + "description": "Storage classification mapping name.", + "required": true, + "type": "string" + }, + { + "name": "pairingInput", + "in": "body", + "description": "Pairing input.", + "required": true, + "schema": { + "$ref": "#/definitions/StorageClassificationMappingInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageClassificationMapping" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create storage classification mapping.": { + "$ref": "./examples/ReplicationStorageClassificationMappings_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationStorageClassificationMappings" + ], + "summary": "Delete a storage classification mapping.", + "description": "The operation to delete a storage classification mapping.", + "operationId": "ReplicationStorageClassificationMappings_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationName", + "in": "path", + "description": "Storage classification name.", + "required": true, + "type": "string" + }, + { + "name": "storageClassificationMappingName", + "in": "path", + "description": "Storage classification mapping name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a storage classification mapping.": { + "$ref": "./examples/ReplicationStorageClassificationMappings_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationvCenters": { + "get": { + "tags": [ + "ReplicationvCenters" + ], + "summary": "Gets the list of vCenter registered under a fabric.", + "description": "Lists the vCenter servers registered in a fabric.", + "operationId": "ReplicationvCenters_ListByReplicationFabrics", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VCenterCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of vCenter registered under a fabric.": { + "$ref": "./examples/ReplicationvCenters_ListByReplicationFabrics.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationvCenters/{vcenterName}": { + "get": { + "tags": [ + "ReplicationvCenters" + ], + "summary": "Gets the details of a vCenter.", + "description": "Gets the details of a registered vCenter server(Add vCenter server).", + "operationId": "ReplicationvCenters_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "vcenterName", + "in": "path", + "description": "vcenter name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VCenter" + } + } + }, + "x-ms-examples": { + "Gets the details of a vCenter.": { + "$ref": "./examples/ReplicationvCenters_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationvCenters" + ], + "summary": "Add vCenter.", + "description": "The operation to create a vCenter object..", + "operationId": "ReplicationvCenters_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "vcenterName", + "in": "path", + "description": "vcenter name.", + "required": true, + "type": "string" + }, + { + "name": "addVCenterRequest", + "in": "body", + "description": "The input to the add vCenter operation.", + "required": true, + "schema": { + "$ref": "#/definitions/AddVCenterRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VCenter" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Add vCenter.": { + "$ref": "./examples/ReplicationvCenters_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationvCenters" + ], + "summary": "Remove vcenter operation.", + "description": "The operation to remove(unregister) a registered vCenter server from the vault.", + "operationId": "ReplicationvCenters_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "vcenterName", + "in": "path", + "description": "vcenter name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Remove vCenter operation.": { + "$ref": "./examples/ReplicationvCenters_Delete.json" + } + } + }, + "patch": { + "tags": [ + "ReplicationvCenters" + ], + "summary": "Update vCenter operation.", + "description": "The operation to update a registered vCenter.", + "operationId": "ReplicationvCenters_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "vcenterName", + "in": "path", + "description": "vcenter name.", + "required": true, + "type": "string" + }, + { + "name": "updateVCenterRequest", + "in": "body", + "description": "The input to the update vCenter operation.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateVCenterRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VCenter" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update vCenter operation.": { + "$ref": "./examples/ReplicationvCenters_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs": { + "get": { + "tags": [ + "ReplicationJobs" + ], + "summary": "Gets the list of jobs.", + "description": "Gets the list of Azure Site Recovery Jobs for the vault.", + "operationId": "ReplicationJobs_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/JobQueryParameter", + "x-ms-examples": { + "Gets the list of jobs.": { + "$ref": "./examples/ReplicationJobs_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}": { + "get": { + "tags": [ + "ReplicationJobs" + ], + "summary": "Gets the job details.", + "description": "Get the details of an Azure Site Recovery job.", + "operationId": "ReplicationJobs_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "jobName", + "in": "path", + "description": "Job identifier.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Job" + } + } + }, + "x-ms-examples": { + "Gets the job details.": { + "$ref": "./examples/ReplicationJobs_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}/cancel": { + "post": { + "tags": [ + "ReplicationJobs" + ], + "summary": "Cancels the specified job.", + "description": "The operation to cancel an Azure Site Recovery job.", + "operationId": "ReplicationJobs_Cancel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "jobName", + "in": "path", + "description": "Job identifier.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Cancels the specified job.": { + "$ref": "./examples/ReplicationJobs_Cancel.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}/restart": { + "post": { + "tags": [ + "ReplicationJobs" + ], + "summary": "Restarts the specified job.", + "description": "The operation to restart an Azure Site Recovery job.", + "operationId": "ReplicationJobs_Restart", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "jobName", + "in": "path", + "description": "Job identifier.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Restarts the specified job.": { + "$ref": "./examples/ReplicationJobs_Restart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}/resume": { + "post": { + "tags": [ + "ReplicationJobs" + ], + "summary": "Resumes the specified job.", + "description": "The operation to resume an Azure Site Recovery job.", + "operationId": "ReplicationJobs_Resume", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "jobName", + "in": "path", + "description": "Job identifier.", + "required": true, + "type": "string" + }, + { + "name": "resumeJobParams", + "in": "body", + "description": "Resume rob comments.", + "required": true, + "schema": { + "$ref": "#/definitions/ResumeJobParams" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Resumes the specified job.": { + "$ref": "./examples/ReplicationJobs_Resume.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/export": { + "post": { + "tags": [ + "ReplicationJobs" + ], + "summary": "Exports the details of the Azure Site Recovery jobs of the vault.", + "description": "The operation to export the details of the Azure Site Recovery jobs of the vault.", + "operationId": "ReplicationJobs_Export", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "jobQueryParameter", + "in": "body", + "description": "job query filter.", + "required": true, + "schema": { + "$ref": "#/definitions/JobQueryParameter" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Exports the details of the Azure Site Recovery jobs of the vault.": { + "$ref": "./examples/ReplicationJobs_Export.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationMigrationItems": { + "get": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Gets the list of migration items in the vault.", + "operationId": "ReplicationMigrationItems_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "skipToken", + "in": "query", + "description": "The pagination token.", + "required": false, + "type": "string" + }, + { + "name": "takeToken", + "in": "query", + "description": "The page size.", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItemCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/MigrationItemsQueryParameter", + "x-ms-examples": { + "Gets the list of migration items in the vault.": { + "$ref": "./examples/ReplicationMigrationItems_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationNetworkMappings": { + "get": { + "tags": [ + "ReplicationNetworkMappings" + ], + "summary": "Gets all the network mappings under a vault.", + "description": "Lists all ASR network mappings in the vault.", + "operationId": "ReplicationNetworkMappings_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkMappingCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all the network mappings under a vault.": { + "$ref": "./examples/ReplicationNetworkMappings_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationNetworks": { + "get": { + "tags": [ + "ReplicationNetworks" + ], + "summary": "Gets the list of networks. View-only API.", + "description": "Lists the networks available in a vault.", + "operationId": "ReplicationNetworks_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of networks. View-only API.": { + "$ref": "./examples/ReplicationNetworks_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationPolicies": { + "get": { + "tags": [ + "ReplicationPolicies" + ], + "summary": "Gets the list of replication policies.", + "description": "Lists the replication policies for a vault.", + "operationId": "ReplicationPolicies_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PolicyCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of replication policies.": { + "$ref": "./examples/ReplicationPolicies_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationPolicies/{policyName}": { + "get": { + "tags": [ + "ReplicationPolicies" + ], + "summary": "Gets the requested policy.", + "description": "Gets the details of a replication policy.", + "operationId": "ReplicationPolicies_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "policyName", + "in": "path", + "description": "Replication policy name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Policy" + } + } + }, + "x-ms-examples": { + "Gets the requested policy.": { + "$ref": "./examples/ReplicationPolicies_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationPolicies" + ], + "summary": "Creates the policy.", + "description": "The operation to create a replication policy.", + "operationId": "ReplicationPolicies_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "policyName", + "in": "path", + "description": "Replication policy name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Create policy input.", + "required": true, + "schema": { + "$ref": "#/definitions/CreatePolicyInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Policy" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Creates the policy.": { + "$ref": "./examples/ReplicationPolicies_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationPolicies" + ], + "summary": "Delete the policy.", + "description": "The operation to delete a replication policy.", + "operationId": "ReplicationPolicies_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "policyName", + "in": "path", + "description": "Replication policy name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete the policy.": { + "$ref": "./examples/ReplicationPolicies_Delete.json" + } + } + }, + "patch": { + "tags": [ + "ReplicationPolicies" + ], + "summary": "Updates the policy.", + "description": "The operation to update a replication policy.", + "operationId": "ReplicationPolicies_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "policyName", + "in": "path", + "description": "Policy Id.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Update Policy Input.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdatePolicyInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Policy" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates the policy.": { + "$ref": "./examples/ReplicationPolicies_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectedItems": { + "get": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Gets the list of replication protected items.", + "description": "Gets the list of ASR replication protected items in the vault.", + "operationId": "ReplicationProtectedItems_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "skipToken", + "in": "query", + "description": "The pagination token. Possible values: \"FabricId\" or \"FabricId_CloudId\" or null.", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItemCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ProtectedItemsQueryParameter", + "x-ms-examples": { + "Gets the list of replication protected items.": { + "$ref": "./examples/ReplicationProtectedItems_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionContainerMappings": { + "get": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Gets the list of all protection container mappings in a vault.", + "description": "Lists the protection container mappings in the vault.", + "operationId": "ReplicationProtectionContainerMappings_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerMappingCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of all protection container mappings in a vault.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionContainers": { + "get": { + "tags": [ + "ReplicationProtectionContainers" + ], + "summary": "Gets the list of all protection containers in a vault.", + "description": "Lists the protection containers in a vault.", + "operationId": "ReplicationProtectionContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of all protection containers in a vault.": { + "$ref": "./examples/ReplicationProtectionContainers_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionIntents": { + "get": { + "tags": [ + "ReplicationProtectionIntents" + ], + "summary": "Gets the list of replication protection intent objects.", + "description": "Gets the list of ASR replication protection intent objects in the vault.", + "operationId": "ReplicationProtectionIntents_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "skipToken", + "in": "query", + "description": "The pagination token.", + "required": false, + "type": "string" + }, + { + "name": "takeToken", + "in": "query", + "description": "The page size.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectionIntentCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of replication protection intent objects.": { + "$ref": "./examples/ReplicationProtectionIntents_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionIntents/{intentObjectName}": { + "get": { + "tags": [ + "ReplicationProtectionIntents" + ], + "summary": "Gets the details of a Replication protection intent item.", + "description": "Gets the details of an ASR replication protection intent.", + "operationId": "ReplicationProtectionIntents_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "intentObjectName", + "in": "path", + "description": "Replication protection intent name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectionIntent" + } + } + }, + "x-ms-examples": { + "Gets the details of a Replication protection intent item.": { + "$ref": "./examples/ReplicationProtectionIntents_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationProtectionIntents" + ], + "summary": "Create protection intent Resource.", + "description": "The operation to create an ASR replication protection intent item.", + "operationId": "ReplicationProtectionIntents_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "intentObjectName", + "in": "path", + "description": "A name for the replication protection item.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Create Protection Intent Input.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateProtectionIntentInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectionIntent" + } + } + }, + "x-ms-examples": { + "Create protection intent Resource.": { + "$ref": "./examples/ReplicationProtectionIntents_Create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans": { + "get": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Gets the list of recovery plans.", + "description": "Lists the recovery plans in the vault.", + "operationId": "ReplicationRecoveryPlans_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlanCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of recovery plans.": { + "$ref": "./examples/ReplicationRecoveryPlans_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}": { + "get": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Gets the requested recovery plan.", + "description": "Gets the details of the recovery plan.", + "operationId": "ReplicationRecoveryPlans_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Name of the recovery plan.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + } + }, + "x-ms-examples": { + "Gets the requested recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Creates a recovery plan with the given details.", + "description": "The operation to create a recovery plan.", + "operationId": "ReplicationRecoveryPlans_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Recovery Plan creation input.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateRecoveryPlanInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Creates a recovery plan with the given details.": { + "$ref": "./examples/ReplicationRecoveryPlans_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Deletes the specified recovery plan.", + "description": "Delete a recovery plan.", + "operationId": "ReplicationRecoveryPlans_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes the specified recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_Delete.json" + } + } + }, + "patch": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Updates the given recovery plan.", + "description": "The operation to update a recovery plan.", + "operationId": "ReplicationRecoveryPlans_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Update recovery plan input.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateRecoveryPlanInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates the given recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/failoverCancel": { + "post": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Execute cancel failover of the recovery plan.", + "description": "The operation to cancel the failover of a recovery plan.", + "operationId": "ReplicationRecoveryPlans_FailoverCancel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute cancel failover of the recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_FailoverCancel.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/failoverCommit": { + "post": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Execute commit failover of the recovery plan.", + "description": "The operation to commit the failover of a recovery plan.", + "operationId": "ReplicationRecoveryPlans_FailoverCommit", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute commit failover of the recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_FailoverCommit.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/plannedFailover": { + "post": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Execute planned failover of the recovery plan.", + "description": "The operation to start the planned failover of a recovery plan.", + "operationId": "ReplicationRecoveryPlans_PlannedFailover", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Failover input.", + "required": true, + "schema": { + "$ref": "#/definitions/RecoveryPlanPlannedFailoverInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute planned failover of the recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_PlannedFailover.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/reProtect": { + "post": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Execute reprotect of the recovery plan.", + "description": "The operation to reprotect(reverse replicate) a recovery plan.", + "operationId": "ReplicationRecoveryPlans_Reprotect", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute reprotect of the recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_Reprotect.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/testFailover": { + "post": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Execute test failover of the recovery plan.", + "description": "The operation to start the test failover of a recovery plan.", + "operationId": "ReplicationRecoveryPlans_TestFailover", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Recovery plan test failover input.", + "required": true, + "schema": { + "$ref": "#/definitions/RecoveryPlanTestFailoverInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute test failover of the recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_TestFailover.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/testFailoverCleanup": { + "post": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Execute test failover cleanup of the recovery plan.", + "description": "The operation to cleanup test failover of a recovery plan.", + "operationId": "ReplicationRecoveryPlans_TestFailoverCleanup", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Recovery plan test failover cleanup input.", + "required": true, + "schema": { + "$ref": "#/definitions/RecoveryPlanTestFailoverCleanupInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute test failover cleanup of the recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_TestFailoverCleanup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/unplannedFailover": { + "post": { + "tags": [ + "ReplicationRecoveryPlans" + ], + "summary": "Execute unplanned failover of the recovery plan.", + "description": "The operation to start the unplanned failover of a recovery plan.", + "operationId": "ReplicationRecoveryPlans_UnplannedFailover", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "recoveryPlanName", + "in": "path", + "description": "Recovery plan name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Recovery plan unplanned failover input.", + "required": true, + "schema": { + "$ref": "#/definitions/RecoveryPlanUnplannedFailoverInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute unplanned failover of the recovery plan.": { + "$ref": "./examples/ReplicationRecoveryPlans_UnplannedFailover.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryServicesProviders": { + "get": { + "tags": [ + "ReplicationRecoveryServicesProviders" + ], + "summary": "Gets the list of registered recovery services providers in the vault. This is a view only api.", + "description": "Lists the registered recovery services providers in the vault.", + "operationId": "ReplicationRecoveryServicesProviders_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryServicesProviderCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of registered recovery services providers in the vault. This is a view only api.": { + "$ref": "./examples/ReplicationRecoveryServicesProviders_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationStorageClassificationMappings": { + "get": { + "tags": [ + "ReplicationStorageClassificationMappings" + ], + "summary": "Gets the list of storage classification mappings objects under a vault.", + "description": "Lists the storage classification mappings in the vault.", + "operationId": "ReplicationStorageClassificationMappings_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageClassificationMappingCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of storage classification mappings objects under a vault.": { + "$ref": "./examples/ReplicationStorageClassificationMappings_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationStorageClassifications": { + "get": { + "tags": [ + "ReplicationStorageClassifications" + ], + "summary": "Gets the list of storage classification objects under a vault.", + "description": "Lists the storage classifications in the vault.", + "operationId": "ReplicationStorageClassifications_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageClassificationCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of storage classification objects under a vault.": { + "$ref": "./examples/ReplicationStorageClassifications_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationSupportedOperatingSystems": { + "get": { + "tags": [ + "SupportedOperatingSystems" + ], + "summary": "Gets the data of supported operating systems by SRS.", + "operationId": "SupportedOperatingSystems_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "instanceType", + "in": "query", + "description": "The instance type.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SupportedOperatingSystems" + } + } + }, + "x-ms-examples": { + "Gets the data of supported operating systems by SRS.": { + "$ref": "./examples/SupportedOperatingSystems_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultHealth": { + "get": { + "tags": [ + "ReplicationVaultHealth" + ], + "summary": "Gets the health summary for the vault.", + "description": "Gets the health details of the vault.", + "operationId": "ReplicationVaultHealth_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultHealthDetails" + } + } + }, + "x-ms-examples": { + "Gets the health summary for the vault.": { + "$ref": "./examples/ReplicationVaultHealth_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultHealth/default/refresh": { + "post": { + "tags": [ + "ReplicationVaultHealth" + ], + "summary": "Refreshes health summary of the vault.", + "operationId": "ReplicationVaultHealth_Refresh", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultHealthDetails" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Refreshes health summary of the vault.": { + "$ref": "./examples/ReplicationVaultHealth_Refresh.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultSettings": { + "get": { + "tags": [ + "ReplicationVaultSetting" + ], + "summary": "Gets the list of vault setting.", + "description": "Gets the list of vault setting. This includes the Migration Hub connection settings.", + "operationId": "ReplicationVaultSetting_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultSettingCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of vault setting.": { + "$ref": "./examples/ReplicationVaultSetting_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultSettings/{vaultSettingName}": { + "get": { + "tags": [ + "ReplicationVaultSetting" + ], + "summary": "Gets the vault setting.", + "description": "Gets the vault setting. This includes the Migration Hub connection settings.", + "operationId": "ReplicationVaultSetting_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "vaultSettingName", + "in": "path", + "description": "Vault setting name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultSetting" + } + } + }, + "x-ms-examples": { + "Gets the vault setting.": { + "$ref": "./examples/ReplicationVaultSetting_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationVaultSetting" + ], + "summary": "Updates vault setting. A vault setting object is a singleton per vault and it is always present by default.", + "description": "The operation to configure vault setting.", + "operationId": "ReplicationVaultSetting_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "vaultSettingName", + "in": "path", + "description": "Vault setting name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Vault setting creation input.", + "required": true, + "schema": { + "$ref": "#/definitions/VaultSettingCreationInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultSetting" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates vault setting. A vault setting object is a singleton per vault and it is always present by default.": { + "$ref": "./examples/ReplicationVaultSetting_Create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationvCenters": { + "get": { + "tags": [ + "ReplicationvCenters" + ], + "summary": "Gets the list of vCenter registered under the vault.", + "description": "Lists the vCenter servers registered in the vault.", + "operationId": "ReplicationvCenters_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VCenterCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of vCenter registered under the vault.": { + "$ref": "./examples/ReplicationvCenters_List.json" + } + } + } + } + }, + "definitions": { + "A2AAddDisksInput": { + "description": "A2A add disk(s) input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AddDisksProviderSpecificInput" + } + ], + "properties": { + "vmDisks": { + "description": "The list of vm disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmDiskInputDetails" + } + }, + "vmManagedDisks": { + "description": "The list of vm managed disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmManagedDiskInputDetails" + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AApplyRecoveryPointInput": { + "description": "ApplyRecoveryPoint input specific to A2A provider.", + "required": [ + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "A2A" + }, + "A2AContainerCreationInput": { + "description": "A2A cloud creation input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificContainerCreationInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "A2A" + }, + "A2AContainerMappingInput": { + "description": "A2A container mapping input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificContainerMappingInput" + } + ], + "properties": { + "agentAutoUpdateStatus": { + "description": "A value indicating whether the auto update is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentAutoUpdateStatus", + "modelAsString": true + } + }, + "automationAccountArmId": { + "description": "The automation account arm id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2ACreateProtectionIntentInput": { + "description": "A2A create protection intent input.", + "required": [ + "fabricObjectId", + "primaryLocation", + "recoveryLocation", + "recoverySubscriptionId", + "recoveryAvailabilityType", + "recoveryResourceGroupId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CreateProtectionIntentProviderSpecificDetails" + } + ], + "properties": { + "fabricObjectId": { + "description": "The fabric specific object Id of the virtual machine.", + "type": "string" + }, + "primaryLocation": { + "description": "The primary location for the virtual machine.", + "type": "string" + }, + "recoveryLocation": { + "description": "The recovery location for the virtual machine.", + "type": "string" + }, + "recoverySubscriptionId": { + "description": "The recovery subscription Id of the virtual machine.", + "type": "string" + }, + "recoveryAvailabilityType": { + "description": "The recovery availability type of the virtual machine.", + "enum": [ + "Single", + "AvailabilitySet", + "AvailabilityZone" + ], + "type": "string", + "x-ms-enum": { + "name": "A2ARecoveryAvailabilityType", + "modelAsString": true + } + }, + "protectionProfileCustomInput": { + "$ref": "#/definitions/ProtectionProfileCustomDetails", + "description": "The protection profile custom inputs." + }, + "recoveryResourceGroupId": { + "description": "The recovery resource group Id. Valid for V2 scenarios.", + "type": "string" + }, + "primaryStagingStorageAccountCustomInput": { + "$ref": "#/definitions/StorageAccountCustomDetails", + "description": "The primary staging storage account input." + }, + "recoveryAvailabilitySetCustomInput": { + "$ref": "#/definitions/RecoveryAvailabilitySetCustomDetails", + "description": "The recovery availability set input." + }, + "recoveryVirtualNetworkCustomInput": { + "$ref": "#/definitions/RecoveryVirtualNetworkCustomDetails", + "description": "The recovery virtual network input." + }, + "recoveryProximityPlacementGroupCustomInput": { + "$ref": "#/definitions/RecoveryProximityPlacementGroupCustomDetails", + "description": "The recovery proximity placement group custom input." + }, + "autoProtectionOfDataDisk": { + "description": "A value indicating whether the auto protection is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoProtectionOfDataDisk", + "modelAsString": true + } + }, + "vmDisks": { + "description": "The list of vm disk inputs.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AProtectionIntentDiskInputDetails" + } + }, + "vmManagedDisks": { + "description": "The list of vm managed disk inputs.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AProtectionIntentManagedDiskInputDetails" + } + }, + "multiVmGroupName": { + "description": "The multi vm group name.", + "type": "string" + }, + "multiVmGroupId": { + "description": "The multi vm group id.", + "type": "string" + }, + "recoveryBootDiagStorageAccount": { + "$ref": "#/definitions/StorageAccountCustomDetails", + "description": "The boot diagnostic storage account." + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery disk encryption information (for two pass flows)." + }, + "recoveryAvailabilityZone": { + "description": "The recovery availability zone.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2ACrossClusterMigrationApplyRecoveryPointInput": { + "description": "ApplyRecoveryPoint input specific to A2ACrossClusterMigration provider.", + "required": [ + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "A2ACrossClusterMigration" + }, + "A2ACrossClusterMigrationContainerCreationInput": { + "description": "A2ACrossClusterMigration cloud creation input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificContainerCreationInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "A2ACrossClusterMigration" + }, + "A2ACrossClusterMigrationEnableProtectionInput": { + "description": "A2A Cross-Cluster Migration enable protection input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnableProtectionProviderSpecificInput" + } + ], + "properties": { + "fabricObjectId": { + "description": "The fabric specific object Id of the virtual machine.", + "type": "string" + }, + "recoveryContainerId": { + "description": "The recovery container Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2ACrossClusterMigration" + }, + "A2ACrossClusterMigrationPolicyCreationInput": { + "description": "A2A Cross-Cluster Migration Policy creation input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "A2ACrossClusterMigration" + }, + "A2ACrossClusterMigrationReplicationDetails": { + "description": "A2A provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "fabricObjectId": { + "description": "The fabric specific object Id of the virtual machine.", + "type": "string" + }, + "primaryFabricLocation": { + "description": "Primary fabric location.", + "type": "string" + }, + "osType": { + "description": "The type of operating system.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "lifecycleId": { + "description": "An id associated with the PE that survives actions like switch protection which change the backing PE/CPE objects internally.The lifecycle id gets carried forward to have a link/continuity in being able to have an Id that denotes the \"same\" protected item even though other internal Ids/ARM Id might be changing.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2ACrossClusterMigration" + }, + "A2AEnableProtectionInput": { + "description": "A2A enable protection input.", + "required": [ + "fabricObjectId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnableProtectionProviderSpecificInput" + } + ], + "properties": { + "fabricObjectId": { + "description": "The fabric specific object Id of the virtual machine.", + "type": "string" + }, + "recoveryContainerId": { + "description": "The recovery container Id.", + "type": "string" + }, + "recoveryResourceGroupId": { + "description": "The recovery resource group Id. Valid for V2 scenarios.", + "type": "string" + }, + "recoveryCloudServiceId": { + "description": "The recovery cloud service Id. Valid for V1 scenarios.", + "type": "string" + }, + "recoveryAvailabilitySetId": { + "description": "The recovery availability set Id.", + "type": "string" + }, + "recoveryProximityPlacementGroupId": { + "description": "The recovery proximity placement group Id.", + "type": "string" + }, + "vmDisks": { + "description": "The list of vm disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmDiskInputDetails" + } + }, + "vmManagedDisks": { + "description": "The list of vm managed disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmManagedDiskInputDetails" + } + }, + "multiVmGroupName": { + "description": "The multi vm group name.", + "type": "string" + }, + "multiVmGroupId": { + "description": "The multi vm group id.", + "type": "string" + }, + "recoveryBootDiagStorageAccountId": { + "description": "The boot diagnostic storage account.", + "type": "string" + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery disk encryption information (for two pass flows)." + }, + "recoveryAvailabilityZone": { + "description": "The recovery availability zone.", + "type": "string" + }, + "recoveryAzureNetworkId": { + "description": "The recovery Azure virtual network ARM id.", + "type": "string" + }, + "recoverySubnetName": { + "description": "The recovery subnet name.", + "type": "string" + }, + "recoveryVirtualMachineScaleSetId": { + "description": "The virtual machine scale set Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AEventDetails": { + "description": "Model class for event details of a A2A event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "protectedItemName": { + "description": "The protected item arm name.", + "type": "string" + }, + "fabricObjectId": { + "description": "The azure vm arm id.", + "type": "string" + }, + "fabricName": { + "description": "Fabric arm name.", + "type": "string" + }, + "fabricLocation": { + "description": "The fabric location.", + "type": "string" + }, + "remoteFabricName": { + "description": "Remote fabric arm name.", + "type": "string" + }, + "remoteFabricLocation": { + "description": "Remote fabric location.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2APolicyCreationInput": { + "description": "A2A Policy creation input.", + "required": [ + "multiVmSyncStatus" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'.", + "enum": [ + "Enable", + "Disable" + ], + "type": "string", + "x-ms-enum": { + "name": "SetMultiVmSyncStatus", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2APolicyDetails": { + "description": "A2A specific policy details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPointThresholdInMinutes": { + "format": "int32", + "description": "The recovery point threshold in minutes.", + "type": "integer" + }, + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency in minutes.", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled.", + "type": "string" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency in minutes.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AProtectedDiskDetails": { + "description": "A2A protected disk details.", + "type": "object", + "properties": { + "diskUri": { + "description": "The disk uri.", + "type": "string" + }, + "recoveryAzureStorageAccountId": { + "description": "The recovery disk storage account.", + "type": "string" + }, + "primaryDiskAzureStorageAccountId": { + "description": "The primary disk storage account.", + "type": "string" + }, + "recoveryDiskUri": { + "description": "Recovery disk uri.", + "type": "string" + }, + "diskName": { + "description": "The disk name.", + "type": "string" + }, + "diskCapacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer" + }, + "primaryStagingAzureStorageAccountId": { + "description": "The primary staging storage account.", + "type": "string" + }, + "diskType": { + "description": "The type of disk.", + "type": "string" + }, + "resyncRequired": { + "description": "A value indicating whether resync is required for this disk.", + "type": "boolean" + }, + "monitoringPercentageCompletion": { + "format": "int32", + "description": "The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property.", + "type": "integer" + }, + "monitoringJobType": { + "description": "The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property.", + "type": "string" + }, + "dataPendingInStagingStorageAccountInMB": { + "format": "double", + "description": "The data pending for replication in MB at staging account.", + "type": "number" + }, + "dataPendingAtSourceAgentInMB": { + "format": "double", + "description": "The data pending at source virtual machine in MB.", + "type": "number" + }, + "diskState": { + "description": "The disk state.", + "type": "string" + }, + "allowedDiskLevelOperation": { + "description": "The disk level operations list.", + "type": "array", + "items": { + "type": "string" + } + }, + "isDiskEncrypted": { + "description": "A value indicating whether vm has encrypted os disk or not.", + "type": "boolean" + }, + "secretIdentifier": { + "description": "The secret URL / identifier (BEK).", + "type": "string" + }, + "dekKeyVaultArmId": { + "description": "The KeyVault resource id for secret (BEK).", + "type": "string" + }, + "isDiskKeyEncrypted": { + "description": "A value indicating whether disk key got encrypted or not.", + "type": "boolean" + }, + "keyIdentifier": { + "description": "The key URL / identifier (KEK).", + "type": "string" + }, + "kekKeyVaultArmId": { + "description": "The KeyVault resource id for key (KEK).", + "type": "string" + }, + "failoverDiskName": { + "description": "The failover name for the managed disk.", + "type": "string" + }, + "tfoDiskName": { + "description": "The test failover name for the managed disk.", + "type": "string" + } + } + }, + "A2AProtectedManagedDiskDetails": { + "description": "A2A protected managed disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The managed disk Arm id.", + "type": "string" + }, + "recoveryResourceGroupId": { + "description": "The recovery disk resource group Arm Id.", + "type": "string" + }, + "recoveryTargetDiskId": { + "description": "Recovery target disk Arm Id.", + "type": "string" + }, + "recoveryReplicaDiskId": { + "description": "Recovery replica disk Arm Id.", + "type": "string" + }, + "recoveryOrignalTargetDiskId": { + "description": "Recovery original target disk Arm Id.", + "type": "string" + }, + "recoveryReplicaDiskAccountType": { + "description": "The replica disk type. Its an optional value and will be same as source disk type if not user provided.", + "type": "string" + }, + "recoveryTargetDiskAccountType": { + "description": "The target disk type after failover. Its an optional value and will be same as source disk type if not user provided.", + "type": "string" + }, + "recoveryDiskEncryptionSetId": { + "description": "The recovery disk encryption set Id.", + "type": "string" + }, + "primaryDiskEncryptionSetId": { + "description": "The primary disk encryption set Id.", + "type": "string" + }, + "diskName": { + "description": "The disk name.", + "type": "string" + }, + "diskCapacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer" + }, + "primaryStagingAzureStorageAccountId": { + "description": "The primary staging storage account.", + "type": "string" + }, + "diskType": { + "description": "The type of disk.", + "type": "string" + }, + "resyncRequired": { + "description": "A value indicating whether resync is required for this disk.", + "type": "boolean" + }, + "monitoringPercentageCompletion": { + "format": "int32", + "description": "The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property.", + "type": "integer" + }, + "monitoringJobType": { + "description": "The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property.", + "type": "string" + }, + "dataPendingInStagingStorageAccountInMB": { + "format": "double", + "description": "The data pending for replication in MB at staging account.", + "type": "number" + }, + "dataPendingAtSourceAgentInMB": { + "format": "double", + "description": "The data pending at source virtual machine in MB.", + "type": "number" + }, + "diskState": { + "description": "The disk state.", + "type": "string" + }, + "allowedDiskLevelOperation": { + "description": "The disk level operations list.", + "type": "array", + "items": { + "type": "string" + } + }, + "isDiskEncrypted": { + "description": "A value indicating whether vm has encrypted os disk or not.", + "type": "boolean" + }, + "secretIdentifier": { + "description": "The secret URL / identifier (BEK).", + "type": "string" + }, + "dekKeyVaultArmId": { + "description": "The KeyVault resource id for secret (BEK).", + "type": "string" + }, + "isDiskKeyEncrypted": { + "description": "A value indicating whether disk key got encrypted or not.", + "type": "boolean" + }, + "keyIdentifier": { + "description": "The key URL / identifier (KEK).", + "type": "string" + }, + "kekKeyVaultArmId": { + "description": "The KeyVault resource id for key (KEK).", + "type": "string" + }, + "failoverDiskName": { + "description": "The failover name for the managed disk.", + "type": "string" + }, + "tfoDiskName": { + "description": "The test failover name for the managed disk.", + "type": "string" + } + } + }, + "A2AProtectionContainerMappingDetails": { + "description": "A2A provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionContainerMappingProviderSpecificDetails" + } + ], + "properties": { + "agentAutoUpdateStatus": { + "description": "A value indicating whether the auto update is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentAutoUpdateStatus", + "modelAsString": true + } + }, + "automationAccountArmId": { + "description": "The automation account arm id.", + "type": "string" + }, + "scheduleName": { + "description": "The schedule arm name.", + "type": "string" + }, + "jobScheduleName": { + "description": "The job schedule arm name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AProtectionIntentDiskInputDetails": { + "description": "Azure VM unmanaged disk input details.", + "required": [ + "diskUri" + ], + "type": "object", + "properties": { + "diskUri": { + "description": "The disk Uri.", + "type": "string" + }, + "recoveryAzureStorageAccountCustomInput": { + "$ref": "#/definitions/StorageAccountCustomDetails", + "description": "The recovery VHD storage account input." + }, + "primaryStagingStorageAccountCustomInput": { + "$ref": "#/definitions/StorageAccountCustomDetails", + "description": "The primary staging storage account input." + } + } + }, + "A2AProtectionIntentManagedDiskInputDetails": { + "description": "Azure VM managed disk input details.", + "required": [ + "diskId" + ], + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "primaryStagingStorageAccountCustomInput": { + "$ref": "#/definitions/StorageAccountCustomDetails", + "description": "The primary staging storage account input." + }, + "recoveryResourceGroupCustomInput": { + "$ref": "#/definitions/RecoveryResourceGroupCustomDetails", + "description": "The recovery resource group input." + }, + "recoveryReplicaDiskAccountType": { + "description": "The replica disk type. Its an optional value and will be same as source disk type if not user provided.", + "type": "string" + }, + "recoveryTargetDiskAccountType": { + "description": "The target disk type after failover. Its an optional value and will be same as source disk type if not user provided.", + "type": "string" + }, + "recoveryDiskEncryptionSetId": { + "description": "The recovery disk encryption set Id.", + "type": "string" + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery disk encryption information (for one / single pass flows)." + } + } + }, + "A2ARecoveryPointDetails": { + "description": "A2A provider specific recovery point details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProviderSpecificRecoveryPointDetails" + } + ], + "properties": { + "recoveryPointSyncType": { + "description": "A value indicating whether the recovery point is multi VM consistent.", + "enum": [ + "MultiVmSyncRecoveryPoint", + "PerVmRecoveryPoint" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPointSyncType", + "modelAsString": true + } + }, + "disks": { + "description": "List of disk ids representing a recovery point.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2ARemoveDisksInput": { + "description": "A2A remove disk(s) input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RemoveDisksProviderSpecificInput" + } + ], + "properties": { + "vmDisksUris": { + "description": "The list of vm disk vhd URIs.", + "type": "array", + "items": { + "type": "string" + } + }, + "vmManagedDisksIds": { + "description": "The list of vm managed disk Ids.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AReplicationDetails": { + "description": "A2A provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "fabricObjectId": { + "description": "The fabric specific object Id of the virtual machine.", + "type": "string" + }, + "initialPrimaryZone": { + "description": "The initial primary availability zone.", + "type": "string", + "readOnly": true + }, + "initialPrimaryFabricLocation": { + "description": "The initial primary fabric location.", + "type": "string", + "readOnly": true + }, + "initialRecoveryZone": { + "description": "The initial recovery availability zone.", + "type": "string", + "readOnly": true + }, + "initialRecoveryFabricLocation": { + "description": "The initial recovery fabric location.", + "type": "string", + "readOnly": true + }, + "multiVmGroupId": { + "description": "The multi vm group Id.", + "type": "string" + }, + "multiVmGroupName": { + "description": "The multi vm group name.", + "type": "string" + }, + "multiVmGroupCreateOption": { + "description": "Whether Multi VM group is auto created or specified by user.", + "enum": [ + "AutoCreated", + "UserSpecified" + ], + "type": "string", + "x-ms-enum": { + "name": "MultiVmGroupCreateOption", + "modelAsString": true + } + }, + "managementId": { + "description": "The management Id.", + "type": "string" + }, + "protectedDisks": { + "description": "The list of protected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AProtectedDiskDetails" + } + }, + "unprotectedDisks": { + "description": "The list of unprotected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AUnprotectedDiskDetails" + } + }, + "protectedManagedDisks": { + "description": "The list of protected managed disks.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AProtectedManagedDiskDetails" + } + }, + "recoveryBootDiagStorageAccountId": { + "description": "The recovery boot diagnostic storage account Arm Id.", + "type": "string" + }, + "primaryFabricLocation": { + "description": "Primary fabric location.", + "type": "string" + }, + "recoveryFabricLocation": { + "description": "The recovery fabric location.", + "type": "string" + }, + "osType": { + "description": "The type of operating system.", + "type": "string" + }, + "recoveryAzureVMSize": { + "description": "The size of recovery virtual machine.", + "type": "string" + }, + "recoveryAzureVMName": { + "description": "The name of recovery virtual machine.", + "type": "string" + }, + "recoveryAzureResourceGroupId": { + "description": "The recovery resource group.", + "type": "string" + }, + "recoveryCloudService": { + "description": "The recovery cloud service.", + "type": "string" + }, + "recoveryAvailabilitySet": { + "description": "The recovery availability set.", + "type": "string" + }, + "selectedRecoveryAzureNetworkId": { + "description": "The recovery virtual network.", + "type": "string" + }, + "selectedTfoAzureNetworkId": { + "description": "The test failover virtual network.", + "type": "string" + }, + "vmNics": { + "description": "The virtual machine nic details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicDetails" + } + }, + "vmSyncedConfigDetails": { + "$ref": "#/definitions/AzureToAzureVmSyncedConfigDetails", + "description": "The synced configuration details." + }, + "monitoringPercentageCompletion": { + "format": "int32", + "description": "The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property.", + "type": "integer" + }, + "monitoringJobType": { + "description": "The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property.", + "type": "string" + }, + "lastHeartbeat": { + "format": "date-time", + "description": "The last heartbeat received from the source server.", + "type": "string" + }, + "agentVersion": { + "description": "The agent version.", + "type": "string" + }, + "agentExpiryDate": { + "format": "date-time", + "description": "Agent expiry date.", + "type": "string" + }, + "isReplicationAgentUpdateRequired": { + "description": "A value indicating whether replication agent update is required.", + "type": "boolean" + }, + "agentCertificateExpiryDate": { + "format": "date-time", + "description": "Agent certificate expiry date.", + "type": "string", + "readOnly": true + }, + "isReplicationAgentCertificateUpdateRequired": { + "description": "A value indicating whether agent certificate update is required.", + "type": "boolean" + }, + "recoveryFabricObjectId": { + "description": "The recovery fabric object Id.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "lifecycleId": { + "description": "An id associated with the PE that survives actions like switch protection which change the backing PE/CPE objects internally.The lifecycle id gets carried forward to have a link/continuity in being able to have an Id that denotes the \"same\" protected item even though other internal Ids/ARM Id might be changing.", + "type": "string" + }, + "testFailoverRecoveryFabricObjectId": { + "description": "The test failover fabric object Id.", + "type": "string" + }, + "rpoInSeconds": { + "format": "int64", + "description": "The last RPO value in seconds.", + "type": "integer" + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The time (in UTC) when the last RPO value was calculated by Protection Service.", + "type": "string" + }, + "primaryAvailabilityZone": { + "description": "The primary availability zone.", + "type": "string" + }, + "recoveryAvailabilityZone": { + "description": "The recovery availability zone.", + "type": "string" + }, + "vmEncryptionType": { + "description": "The encryption type of the VM.", + "type": "string", + "readOnly": true, + "enum": [ + "NotEncrypted", + "OnePassEncrypted", + "TwoPassEncrypted" + ], + "x-ms-enum": { + "name": "VmEncryptionType", + "modelAsString": true + } + }, + "tfoAzureVMName": { + "description": "The test failover vm name.", + "type": "string" + }, + "recoveryAzureGeneration": { + "description": "The recovery azure generation.", + "type": "string", + "readOnly": true + }, + "recoveryProximityPlacementGroupId": { + "description": "The recovery proximity placement group Id.", + "type": "string" + }, + "autoProtectionOfDataDisk": { + "description": "A value indicating whether the auto protection is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoProtectionOfDataDisk", + "modelAsString": true + } + }, + "recoveryVirtualMachineScaleSetId": { + "description": "The recovery virtual machine scale set id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AReplicationIntentDetails": { + "description": "A2A provider specific settings.", + "required": [ + "recoveryAvailabilityType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProtectionIntentProviderSpecificSettings" + } + ], + "properties": { + "fabricObjectId": { + "description": "The fabric specific object Id of the virtual machine.", + "type": "string" + }, + "primaryLocation": { + "description": "The primary location for the virtual machine.", + "type": "string" + }, + "recoveryLocation": { + "description": "The recovery location for the virtual machine.", + "type": "string" + }, + "recoverySubscriptionId": { + "description": "The recovery subscription Id of the virtual machine.", + "type": "string" + }, + "vmDisks": { + "description": "The list of vm disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AProtectionIntentDiskInputDetails" + } + }, + "vmManagedDisks": { + "description": "The list of vm managed disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AProtectionIntentManagedDiskInputDetails" + } + }, + "recoveryResourceGroupId": { + "description": "The recovery resource group id.", + "type": "string" + }, + "protectionProfile": { + "$ref": "#/definitions/ProtectionProfileCustomDetails", + "description": "The protection profile custom details." + }, + "primaryStagingStorageAccount": { + "$ref": "#/definitions/StorageAccountCustomDetails", + "description": "The primary staging storage account details." + }, + "recoveryAvailabilitySet": { + "$ref": "#/definitions/RecoveryAvailabilitySetCustomDetails", + "description": "The recovery availability set details." + }, + "recoveryVirtualNetwork": { + "$ref": "#/definitions/RecoveryVirtualNetworkCustomDetails", + "description": "The recovery virtual network details." + }, + "recoveryProximityPlacementGroup": { + "$ref": "#/definitions/RecoveryProximityPlacementGroupCustomDetails", + "description": "The recovery proximity placement group custom details." + }, + "autoProtectionOfDataDisk": { + "description": "A value indicating whether the auto protection is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoProtectionOfDataDisk", + "modelAsString": true + } + }, + "multiVmGroupName": { + "description": "The multi vm group name.", + "type": "string" + }, + "multiVmGroupId": { + "description": "The multi vm group id.", + "type": "string" + }, + "recoveryBootDiagStorageAccount": { + "$ref": "#/definitions/StorageAccountCustomDetails", + "description": "The boot diagnostic storage account." + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery disk encryption information (for two pass flows)." + }, + "recoveryAvailabilityZone": { + "description": "The recovery availability zone.", + "type": "string" + }, + "recoveryAvailabilityType": { + "description": "The recovery availability type of the virtual machine.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AReprotectInput": { + "description": "Azure specific reprotect input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReverseReplicationProviderSpecificInput" + } + ], + "properties": { + "recoveryContainerId": { + "description": "The recovery container Id.", + "type": "string" + }, + "vmDisks": { + "description": "The list of vm disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmDiskInputDetails" + } + }, + "recoveryResourceGroupId": { + "description": "The recovery resource group Id. Valid for V2 scenarios.", + "type": "string" + }, + "recoveryCloudServiceId": { + "description": "The recovery cloud service Id. Valid for V1 scenarios.", + "type": "string" + }, + "recoveryAvailabilitySetId": { + "description": "The recovery availability set.", + "type": "string" + }, + "policyId": { + "description": "The Policy Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2ASwitchProtectionInput": { + "description": "A2A specific switch protection input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SwitchProtectionProviderSpecificInput" + } + ], + "properties": { + "recoveryContainerId": { + "description": "The recovery container Id.", + "type": "string" + }, + "vmDisks": { + "description": "The list of vm disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmDiskInputDetails" + } + }, + "vmManagedDisks": { + "description": "The list of vm managed disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmManagedDiskInputDetails" + } + }, + "recoveryResourceGroupId": { + "description": "The recovery resource group Id. Valid for V2 scenarios.", + "type": "string" + }, + "recoveryCloudServiceId": { + "description": "The recovery cloud service Id. Valid for V1 scenarios.", + "type": "string" + }, + "recoveryAvailabilitySetId": { + "description": "The recovery availability set.", + "type": "string" + }, + "policyId": { + "description": "The Policy Id.", + "type": "string" + }, + "recoveryBootDiagStorageAccountId": { + "description": "The boot diagnostic storage account.", + "type": "string" + }, + "recoveryAvailabilityZone": { + "description": "The recovery availability zone.", + "type": "string" + }, + "recoveryProximityPlacementGroupId": { + "description": "The recovery proximity placement group Id.", + "type": "string" + }, + "recoveryVirtualMachineScaleSetId": { + "description": "The virtual machine scale set id.", + "type": "string" + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery disk encryption information." + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2ATestFailoverInput": { + "description": "A2A provider specific input for test failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TestFailoverProviderSpecificInput" + } + ], + "properties": { + "recoveryPointId": { + "description": "The recovery point id to be passed to test failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + }, + "cloudServiceCreationOption": { + "description": "A value indicating whether to use recovery cloud service for TFO or not.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AUnplannedFailoverInput": { + "description": "A2A provider specific input for unplanned failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput" + } + ], + "properties": { + "recoveryPointId": { + "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + }, + "cloudServiceCreationOption": { + "description": "A value indicating whether to use recovery cloud service for failover or not.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AUnprotectedDiskDetails": { + "description": "A2A unprotected disk details.", + "type": "object", + "properties": { + "diskLunId": { + "format": "int32", + "description": "The source lun Id for the data disk.", + "type": "integer" + }, + "diskAutoProtectionStatus": { + "description": "A value indicating whether the disk auto protection is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoProtectionOfDataDisk", + "modelAsString": true + } + } + } + }, + "A2AUpdateContainerMappingInput": { + "description": "A2A update protection container mapping.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificUpdateContainerMappingInput" + } + ], + "properties": { + "agentAutoUpdateStatus": { + "description": "A value indicating whether the auto update is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentAutoUpdateStatus", + "modelAsString": true + } + }, + "automationAccountArmId": { + "description": "The automation account arm id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AUpdateReplicationProtectedItemInput": { + "description": "InMage Azure V2 input to update replication protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UpdateReplicationProtectedItemProviderInput" + } + ], + "properties": { + "recoveryCloudServiceId": { + "description": "The target cloud service ARM Id (for V1).", + "type": "string" + }, + "recoveryResourceGroupId": { + "description": "The target resource group ARM Id (for V2).", + "type": "string" + }, + "managedDiskUpdateDetails": { + "description": "Managed disk update details.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AVmManagedDiskUpdateDetails" + } + }, + "recoveryBootDiagStorageAccountId": { + "description": "The boot diagnostic storage account.", + "type": "string" + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery os disk encryption information." + }, + "tfoAzureVMName": { + "description": "The user given name for Test Failover VM.", + "type": "string" + }, + "recoveryProximityPlacementGroupId": { + "description": "The recovery proximity placement group Id.", + "type": "string" + }, + "recoveryVirtualMachineScaleSetId": { + "description": "The recovery virtual machine scale set Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AVmDiskInputDetails": { + "description": "A2A disk input details.", + "required": [ + "diskUri", + "recoveryAzureStorageAccountId", + "primaryStagingAzureStorageAccountId" + ], + "type": "object", + "properties": { + "diskUri": { + "description": "The disk Uri.", + "type": "string" + }, + "recoveryAzureStorageAccountId": { + "description": "The recovery VHD storage account Id.", + "type": "string" + }, + "primaryStagingAzureStorageAccountId": { + "description": "The primary staging storage account Id.", + "type": "string" + } + } + }, + "A2AVmManagedDiskInputDetails": { + "description": "A2A managed disk input details.", + "required": [ + "diskId", + "primaryStagingAzureStorageAccountId", + "recoveryResourceGroupId" + ], + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "primaryStagingAzureStorageAccountId": { + "description": "The primary staging storage account Arm Id.", + "type": "string" + }, + "recoveryResourceGroupId": { + "description": "The target resource group Arm Id.", + "type": "string" + }, + "recoveryReplicaDiskAccountType": { + "description": "The replica disk type. Its an optional value and will be same as source disk type if not user provided.", + "type": "string" + }, + "recoveryTargetDiskAccountType": { + "description": "The target disk type after failover. Its an optional value and will be same as source disk type if not user provided.", + "type": "string" + }, + "recoveryDiskEncryptionSetId": { + "description": "The recovery disk encryption set Id.", + "type": "string" + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery disk encryption information (for one / single pass flows)." + } + } + }, + "A2AVmManagedDiskUpdateDetails": { + "description": "A2A Vm managed disk update details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "recoveryTargetDiskAccountType": { + "description": "The target disk type before failover.", + "type": "string" + }, + "recoveryReplicaDiskAccountType": { + "description": "The replica disk type before failover.", + "type": "string" + }, + "diskEncryptionInfo": { + "$ref": "#/definitions/DiskEncryptionInfo", + "description": "The recovery os disk encryption information." + }, + "failoverDiskName": { + "description": "The target disk name for unplanned failover operation.", + "type": "string" + }, + "tfoDiskName": { + "description": "The target disk name for test failover operation.", + "type": "string" + } + } + }, + "A2AZoneDetails": { + "description": "Zone details data.", + "type": "object", + "properties": { + "source": { + "description": "Source zone info.", + "type": "string" + }, + "target": { + "description": "The target zone info.", + "type": "string" + } + } + }, + "AddDisksInput": { + "description": "Input for add disk(s) operation.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AddDisksInputProperties", + "description": "Add disks input properties." + } + } + }, + "AddDisksInputProperties": { + "description": "Add Disks input properties.", + "required": [ + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/AddDisksProviderSpecificInput", + "description": "The ReplicationProviderInput. For HyperVReplicaAzure provider, it will be AzureEnableProtectionInput object. For San provider, it will be SanEnableProtectionInput object. For HyperVReplicaAzure provider, it can be null." + } + } + }, + "AddDisksProviderSpecificInput": { + "description": "Add Disks provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "AddRecoveryServicesProviderInput": { + "description": "Input required to add a provider.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AddRecoveryServicesProviderInputProperties", + "description": "The properties of an add provider request." + } + } + }, + "AddRecoveryServicesProviderInputProperties": { + "description": "The properties of an add provider request.", + "required": [ + "machineName", + "authenticationIdentityInput", + "resourceAccessIdentityInput" + ], + "type": "object", + "properties": { + "machineName": { + "description": "The name of the machine where the provider is getting added.", + "type": "string" + }, + "machineId": { + "description": "The Id of the machine where the provider is getting added.", + "type": "string" + }, + "biosId": { + "description": "The Bios Id of the machine.", + "type": "string" + }, + "authenticationIdentityInput": { + "$ref": "#/definitions/IdentityProviderInput", + "description": "The identity provider input for DRA authentication." + }, + "resourceAccessIdentityInput": { + "$ref": "#/definitions/IdentityProviderInput", + "description": "The identity provider input for resource access." + }, + "dataPlaneAuthenticationIdentityInput": { + "$ref": "#/definitions/IdentityProviderInput", + "description": "The identity provider input for data plane authentication." + } + } + }, + "AddVCenterRequest": { + "description": "Input required to add vCenter.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AddVCenterRequestProperties", + "description": "The properties of an add vCenter request." + } + } + }, + "AddVCenterRequestProperties": { + "description": "The properties of an add vCenter request.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The friendly name of the vCenter.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address of the vCenter to be discovered.", + "type": "string" + }, + "processServerId": { + "description": "The process server Id from where the discovery is orchestrated.", + "type": "string" + }, + "port": { + "description": "The port number for discovery.", + "type": "string" + }, + "runAsAccountId": { + "description": "The account Id which has privileges to discover the vCenter.", + "type": "string" + } + } + }, + "AgentDetails": { + "description": "Agent details.", + "type": "object", + "properties": { + "agentId": { + "description": "The Id of the agent running on the server.", + "type": "string", + "readOnly": true + }, + "machineId": { + "description": "The Id of the machine to which the agent is registered.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The machine BIOS Id.", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "The machine FQDN.", + "type": "string", + "readOnly": true + }, + "disks": { + "description": "The disks.", + "type": "array", + "items": { + "$ref": "#/definitions/AgentDiskDetails" + }, + "readOnly": true + } + } + }, + "AgentDiskDetails": { + "description": "Agent disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string", + "readOnly": true + }, + "diskName": { + "description": "The disk name.", + "type": "string", + "readOnly": true + }, + "isOSDisk": { + "description": "A value indicating whether the disk is the OS disk.", + "type": "string", + "readOnly": true + }, + "capacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer", + "readOnly": true + }, + "lunId": { + "format": "int32", + "description": "The lun of disk.", + "type": "integer", + "readOnly": true + } + } + }, + "Alert": { + "description": "Implements the Alert class.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AlertProperties", + "description": "Alert related data." + } + } + }, + "AlertCollection": { + "description": "Collection of alerts.", + "type": "object", + "properties": { + "value": { + "description": "The list of alerts.", + "type": "array", + "items": { + "$ref": "#/definitions/Alert" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "AlertProperties": { + "description": "The properties of an alert.", + "type": "object", + "properties": { + "sendToOwners": { + "description": "A value indicating whether to send email to subscription administrator.", + "type": "string" + }, + "customEmailAddresses": { + "description": "The custom email address for sending emails.", + "type": "array", + "items": { + "type": "string" + } + }, + "locale": { + "description": "The locale for the email notification.", + "type": "string" + } + } + }, + "ApplyRecoveryPointInput": { + "description": "Input to apply recovery point.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ApplyRecoveryPointInputProperties", + "description": "The input properties to apply recovery point." + } + } + }, + "ApplyRecoveryPointInputProperties": { + "description": "Input properties to apply recovery point.", + "required": [ + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "recoveryPointId": { + "description": "The recovery point Id.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput", + "description": "Provider specific input for applying recovery point." + } + } + }, + "ApplyRecoveryPointProviderSpecificInput": { + "description": "Provider specific input for apply recovery point.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "AsrJobDetails": { + "description": "This class represents job details based on specific job type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": {}, + "x-ms-discriminator-value": "AsrJobDetails" + }, + "ASRTask": { + "description": "Task of the Job.", + "type": "object", + "properties": { + "taskId": { + "description": "The Id.", + "type": "string" + }, + "name": { + "description": "The unique Task name.", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "The start time.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "The end time.", + "type": "string" + }, + "allowedActions": { + "description": "The state/actions applicable on this task.", + "type": "array", + "items": { + "type": "string" + } + }, + "friendlyName": { + "description": "The name.", + "type": "string" + }, + "state": { + "description": "The State. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other.", + "type": "string" + }, + "stateDescription": { + "description": "The description of the task state. For example - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped.", + "type": "string" + }, + "taskType": { + "description": "The type of task. Details in CustomDetails property depend on this type.", + "type": "string" + }, + "customDetails": { + "$ref": "#/definitions/TaskTypeDetails", + "description": "The custom task details based on the task type." + }, + "groupTaskCustomDetails": { + "$ref": "#/definitions/GroupTaskDetails", + "description": "The custom task details based on the task type, if the task type is GroupTaskDetails or one of the types derived from it." + }, + "errors": { + "description": "The task error details.", + "type": "array", + "items": { + "$ref": "#/definitions/JobErrorDetails" + } + } + } + }, + "AutomationRunbookTaskDetails": { + "description": "This class represents the task details for an automation runbook.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskTypeDetails" + } + ], + "properties": { + "name": { + "description": "The recovery plan task name.", + "type": "string" + }, + "cloudServiceName": { + "description": "The cloud service of the automation runbook account.", + "type": "string" + }, + "subscriptionId": { + "description": "The subscription Id of the automation runbook account.", + "type": "string" + }, + "accountName": { + "description": "The automation account name of the runbook.", + "type": "string" + }, + "runbookId": { + "description": "The runbook Id.", + "type": "string" + }, + "runbookName": { + "description": "The runbook name.", + "type": "string" + }, + "jobId": { + "description": "The job Id of the runbook execution.", + "type": "string" + }, + "jobOutput": { + "description": "The execution output of the runbook.", + "type": "string" + }, + "isPrimarySideScript": { + "description": "A value indicating whether it is a primary side script or not.", + "type": "boolean" + } + }, + "x-ms-discriminator-value": "AutomationRunbookTaskDetails" + }, + "AzureFabricCreationInput": { + "description": "Fabric provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificCreationInput" + } + ], + "properties": { + "location": { + "description": "The Location.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Azure" + }, + "AzureFabricSpecificDetails": { + "description": "Azure Fabric Specific Details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificDetails" + } + ], + "properties": { + "location": { + "description": "The Location for the Azure fabric.", + "type": "string" + }, + "containerIds": { + "description": "The container Ids for the Azure fabric.", + "type": "array", + "items": { + "type": "string" + } + }, + "zones": { + "description": "The zones.", + "type": "array", + "items": { + "$ref": "#/definitions/A2AZoneDetails" + } + } + }, + "x-ms-discriminator-value": "Azure" + }, + "AzureToAzureCreateNetworkMappingInput": { + "description": "Create network mappings input properties/behavior specific to Azure to Azure Network mapping.", + "required": [ + "primaryNetworkId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificCreateNetworkMappingInput" + } + ], + "properties": { + "primaryNetworkId": { + "description": "The primary azure vnet Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureToAzure" + }, + "AzureToAzureNetworkMappingSettings": { + "description": "A2A Network Mapping fabric specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkMappingFabricSpecificSettings" + } + ], + "properties": { + "primaryFabricLocation": { + "description": "The primary fabric location.", + "type": "string" + }, + "recoveryFabricLocation": { + "description": "The recovery fabric location.", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureToAzure" + }, + "AzureToAzureUpdateNetworkMappingInput": { + "description": "Updates network mappings input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificUpdateNetworkMappingInput" + } + ], + "properties": { + "primaryNetworkId": { + "description": "The primary azure vnet Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureToAzure" + }, + "AzureToAzureVmSyncedConfigDetails": { + "description": "Azure to Azure VM synced configuration details.", + "type": "object", + "properties": { + "tags": { + "description": "The Azure VM tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "inputEndpoints": { + "description": "The Azure VM input endpoints.", + "type": "array", + "items": { + "$ref": "#/definitions/InputEndpoint" + } + } + } + }, + "AzureVmDiskDetails": { + "description": "Disk details for E2A provider.", + "type": "object", + "properties": { + "vhdType": { + "description": "VHD type.", + "type": "string" + }, + "vhdId": { + "description": "The VHD id.", + "type": "string" + }, + "diskId": { + "description": "The disk resource id.", + "type": "string" + }, + "vhdName": { + "description": "VHD name.", + "type": "string" + }, + "maxSizeMB": { + "description": "Max side in MB.", + "type": "string" + }, + "targetDiskLocation": { + "description": "Blob uri of the Azure disk.", + "type": "string" + }, + "targetDiskName": { + "description": "The target Azure disk name.", + "type": "string" + }, + "lunId": { + "description": "Ordinal\\LunId of the disk for the Azure VM.", + "type": "string" + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM ID.", + "type": "string" + }, + "customTargetDiskName": { + "description": "The custom target Azure disk name.", + "type": "string" + } + } + }, + "ComputeSizeErrorDetails": { + "description": "Represents the error used to indicate why the target compute size is not applicable.", + "type": "object", + "properties": { + "message": { + "description": "The error message.", + "type": "string" + }, + "severity": { + "description": "The severity of the error.", + "type": "string" + } + } + }, + "ConfigurationSettings": { + "description": "Replication provider specific settings.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type. Overridden in derived classes.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ConfigureAlertRequest": { + "description": "Request to configure alerts for the system.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ConfigureAlertRequestProperties", + "description": "The properties of a configure alert request." + } + } + }, + "ConfigureAlertRequestProperties": { + "description": "Properties of a configure alert request.", + "type": "object", + "properties": { + "sendToOwners": { + "description": "A value indicating whether to send email to subscription administrator.", + "type": "string" + }, + "customEmailAddresses": { + "description": "The custom email address for sending emails.", + "type": "array", + "items": { + "type": "string" + } + }, + "locale": { + "description": "The locale for the email notification.", + "type": "string" + } + } + }, + "ConsistencyCheckTaskDetails": { + "description": "This class contains monitoring details of all the inconsistent Protected Entities in Vmm.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskTypeDetails" + } + ], + "properties": { + "vmDetails": { + "description": "The list of inconsistent Vm details.", + "type": "array", + "items": { + "$ref": "#/definitions/InconsistentVmDetails" + } + } + }, + "x-ms-discriminator-value": "ConsistencyCheckTaskDetails" + }, + "CreateNetworkMappingInput": { + "description": "Create network mappings input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CreateNetworkMappingInputProperties", + "description": "Input properties for creating network mapping." + } + } + }, + "CreateNetworkMappingInputProperties": { + "description": "Common input details for network mapping operation.", + "required": [ + "recoveryNetworkId" + ], + "type": "object", + "properties": { + "recoveryFabricName": { + "description": "Recovery fabric Name.", + "type": "string" + }, + "recoveryNetworkId": { + "description": "Recovery network Id.", + "type": "string" + }, + "fabricSpecificDetails": { + "$ref": "#/definitions/FabricSpecificCreateNetworkMappingInput", + "description": "Fabric specific input properties." + } + } + }, + "CreatePolicyInput": { + "description": "Protection Policy input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CreatePolicyInputProperties", + "description": "Policy creation properties." + } + } + }, + "CreatePolicyInputProperties": { + "description": "Policy creation properties.", + "type": "object", + "properties": { + "providerSpecificInput": { + "$ref": "#/definitions/PolicyProviderSpecificInput", + "description": "The ReplicationProviderSettings." + } + } + }, + "CreateProtectionContainerInput": { + "description": "Create protection container input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CreateProtectionContainerInputProperties", + "description": "Create protection container input properties." + } + } + }, + "CreateProtectionContainerInputProperties": { + "description": "Create protection container input properties.", + "type": "object", + "properties": { + "providerSpecificInput": { + "description": "Provider specific inputs for container creation.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationProviderSpecificContainerCreationInput" + } + } + } + }, + "CreateProtectionContainerMappingInput": { + "description": "Configure pairing input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CreateProtectionContainerMappingInputProperties", + "description": "Configure protection input properties." + } + } + }, + "CreateProtectionContainerMappingInputProperties": { + "description": "Configure pairing input properties.", + "type": "object", + "properties": { + "targetProtectionContainerId": { + "description": "The target unique protection container name.", + "type": "string" + }, + "policyId": { + "description": "Applicable policy.", + "type": "string" + }, + "providerSpecificInput": { + "$ref": "#/definitions/ReplicationProviderSpecificContainerMappingInput", + "description": "Provider specific input for pairing." + } + } + }, + "CreateProtectionIntentInput": { + "description": "Create protection intent input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CreateProtectionIntentProperties", + "description": "Create protection intent input properties." + } + } + }, + "CreateProtectionIntentProperties": { + "description": "Create protection intent input properties.", + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/CreateProtectionIntentProviderSpecificDetails", + "description": "The ReplicationProviderInput. For A2A provider, it will be A2ACreateProtectionIntentInput object." + } + } + }, + "CreateProtectionIntentProviderSpecificDetails": { + "description": "Create protection intent provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "CreateRecoveryPlanInput": { + "description": "Create recovery plan input class.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CreateRecoveryPlanInputProperties", + "description": "Recovery plan creation properties." + } + } + }, + "CreateRecoveryPlanInputProperties": { + "description": "Recovery plan creation properties.", + "required": [ + "primaryFabricId", + "recoveryFabricId", + "groups" + ], + "type": "object", + "properties": { + "primaryFabricId": { + "description": "The primary fabric Id.", + "type": "string" + }, + "recoveryFabricId": { + "description": "The recovery fabric Id.", + "type": "string" + }, + "failoverDeploymentModel": { + "description": "The failover deployment model.", + "enum": [ + "NotApplicable", + "Classic", + "ResourceManager" + ], + "type": "string", + "x-ms-enum": { + "name": "FailoverDeploymentModel", + "modelAsString": true + } + }, + "groups": { + "description": "The recovery plan groups.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanGroup" + } + }, + "providerSpecificInput": { + "description": "The provider specific input.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanProviderSpecificInput" + } + } + } + }, + "CurrentJobDetails": { + "description": "Current job details of the migration item.", + "type": "object", + "properties": { + "jobName": { + "description": "The job name.", + "type": "string", + "readOnly": true + }, + "jobId": { + "description": "The ARM Id of the job being executed.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "The start time of the job.", + "type": "string", + "readOnly": true + } + } + }, + "CurrentScenarioDetails": { + "description": "Current scenario details of the protected entity.", + "type": "object", + "properties": { + "scenarioName": { + "description": "Scenario name.", + "type": "string" + }, + "jobId": { + "description": "ARM Id of the job being executed.", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "Start time of the workflow.", + "type": "string" + } + } + }, + "DataStore": { + "description": "The datastore details of the MT.", + "type": "object", + "properties": { + "symbolicName": { + "description": "The symbolic name of data store.", + "type": "string" + }, + "uuid": { + "description": "The uuid of data store.", + "type": "string" + }, + "capacity": { + "description": "The capacity of data store in GBs.", + "type": "string" + }, + "freeSpace": { + "description": "The free space of data store in GBs.", + "type": "string" + }, + "type": { + "description": "The type of data store.", + "type": "string" + } + } + }, + "DisableProtectionInput": { + "description": "Disable protection input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/DisableProtectionInputProperties", + "description": "Disable protection input properties." + } + } + }, + "DisableProtectionInputProperties": { + "description": "Disable protection input properties.", + "type": "object", + "properties": { + "disableProtectionReason": { + "description": "Disable protection reason. It can have values NotSpecified/MigrationComplete.", + "enum": [ + "NotSpecified", + "MigrationComplete" + ], + "type": "string", + "x-ms-enum": { + "name": "DisableProtectionReason", + "modelAsString": true + } + }, + "replicationProviderInput": { + "$ref": "#/definitions/DisableProtectionProviderSpecificInput", + "description": "Replication provider specific input." + } + } + }, + "DisableProtectionProviderSpecificInput": { + "description": "Disable protection provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "DiscoverProtectableItemRequest": { + "description": "Request to add a physical machine as a protectable item in a container.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/DiscoverProtectableItemRequestProperties", + "description": "The properties of a discover protectable item request." + } + } + }, + "DiscoverProtectableItemRequestProperties": { + "description": "Discover protectable item properties.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The friendly name of the physical machine.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address of the physical machine to be discovered.", + "type": "string" + }, + "osType": { + "description": "The OS type on the physical machine.", + "type": "string" + } + } + }, + "DiskDetails": { + "description": "Onprem disk details data.", + "type": "object", + "properties": { + "maxSizeMB": { + "format": "int64", + "description": "The hard disk max size in MB.", + "type": "integer" + }, + "vhdType": { + "description": "The type of the volume.", + "type": "string" + }, + "vhdId": { + "description": "The VHD Id.", + "type": "string" + }, + "vhdName": { + "description": "The VHD name.", + "type": "string" + } + } + }, + "DiskEncryptionInfo": { + "description": "Recovery disk encryption info (BEK and KEK).", + "type": "object", + "properties": { + "diskEncryptionKeyInfo": { + "$ref": "#/definitions/DiskEncryptionKeyInfo", + "description": "The recovery KeyVault reference for secret." + }, + "keyEncryptionKeyInfo": { + "$ref": "#/definitions/KeyEncryptionKeyInfo", + "description": "The recovery KeyVault reference for key." + } + } + }, + "DiskEncryptionKeyInfo": { + "description": "Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows).", + "type": "object", + "properties": { + "secretIdentifier": { + "description": "The secret url / identifier.", + "type": "string" + }, + "keyVaultResourceArmId": { + "description": "The KeyVault resource ARM id for secret.", + "type": "string" + } + } + }, + "DiskVolumeDetails": { + "description": "Volume details.", + "type": "object", + "properties": { + "label": { + "description": "The volume label.", + "type": "string" + }, + "name": { + "description": "The volume name.", + "type": "string" + } + } + }, + "Display": { + "description": "Contains the localized display information for this particular operation / action. These value will be used by several clients for (1) custom role definitions for RBAC; (2) complex query filters for the event service; and (3) audit history / records for management operations.", + "type": "object", + "properties": { + "provider": { + "description": "The provider. The localized friendly form of the resource provider name - it is expected to also include the publisher/company responsible. It should use Title Casing and begin with \"Microsoft\" for 1st party services. e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute.\".", + "type": "string" + }, + "resource": { + "description": "The resource. The localized friendly form of the resource related to this action/operation - it should match the public documentation for the resource provider. It should use Title Casing. This value should be unique for a particular URL type (e.g. nested types should *not* reuse their parent's display.resource field). e.g. \"Virtual Machines\" or \"Scheduler Job Collections\", or \"Virtual Machine VM Sizes\" or \"Scheduler Jobs\".", + "type": "string" + }, + "operation": { + "description": "The operation. The localized friendly name for the operation, as it should be shown to the user. It should be concise (to fit in drop downs) but clear (i.e. self-documenting). It should use Title Casing. Prescriptive guidance: Read Create or Update Delete 'ActionName'.", + "type": "string" + }, + "description": { + "description": "The description. The localized friendly description for the operation, as it should be shown to the user. It should be thorough, yet concise - it will be used in tool tips and detailed views. Prescriptive guidance for namespaces: Read any 'display.provider' resource Create or Update any 'display.provider' resource Delete any 'display.provider' resource Perform any other action on any 'display.provider' resource Prescriptive guidance for namespaces: Read any 'display.resource' Create or Update any 'display.resource' Delete any 'display.resource' 'ActionName' any 'display.resources'.", + "type": "string" + } + } + }, + "DraDetails": { + "description": "DRA details.", + "type": "object", + "properties": { + "id": { + "description": "The DRA Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The DRA name.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The DRA Bios Id.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the DRA.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The health.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + }, + "forwardProtectedItemCount": { + "format": "int32", + "description": "The count of protected items which are protected in forward direction.", + "type": "integer", + "readOnly": true + }, + "reverseProtectedItemCount": { + "format": "int32", + "description": "The count of protected items which are protected in reverse direction.", + "type": "integer", + "readOnly": true + } + } + }, + "EnableMigrationInput": { + "description": "Enable migration input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/EnableMigrationInputProperties", + "description": "Enable migration input properties." + } + } + }, + "EnableMigrationInputProperties": { + "description": "Enable migration input properties.", + "required": [ + "policyId", + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "policyId": { + "description": "The policy Id.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/EnableMigrationProviderSpecificInput", + "description": "The provider specific details." + } + } + }, + "EnableMigrationProviderSpecificInput": { + "description": "Enable migration provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "EnableProtectionInput": { + "description": "Enable protection input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/EnableProtectionInputProperties", + "description": "Enable protection input properties." + } + } + }, + "EnableProtectionInputProperties": { + "description": "Enable protection input properties.", + "type": "object", + "properties": { + "policyId": { + "description": "The Policy Id.", + "type": "string" + }, + "protectableItemId": { + "description": "The protectable item Id.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/EnableProtectionProviderSpecificInput", + "description": "The ReplicationProviderInput. For HyperVReplicaAzure provider, it will be AzureEnableProtectionInput object. For San provider, it will be SanEnableProtectionInput object. For HyperVReplicaAzure provider, it can be null." + } + } + }, + "EnableProtectionProviderSpecificInput": { + "description": "Enable protection provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "EncryptionDetails": { + "description": "Encryption details for the fabric.", + "type": "object", + "properties": { + "kekState": { + "description": "The key encryption key state for the Vmm.", + "type": "string" + }, + "kekCertThumbprint": { + "description": "The key encryption key certificate thumbprint.", + "type": "string" + }, + "kekCertExpiryDate": { + "format": "date-time", + "description": "The key encryption key certificate expiry date.", + "type": "string" + } + } + }, + "Event": { + "description": "Implements the Event class.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EventProperties", + "description": "Event related data." + } + } + }, + "EventCollection": { + "description": "Collection of fabric details.", + "type": "object", + "properties": { + "value": { + "description": "The list of events.", + "type": "array", + "items": { + "$ref": "#/definitions/Event" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "EventProperties": { + "description": "The properties of a monitoring event.", + "type": "object", + "properties": { + "eventCode": { + "description": "The Id of the monitoring event.", + "type": "string" + }, + "description": { + "description": "The event name.", + "type": "string" + }, + "eventType": { + "description": "The type of the event. for example: VM Health, Server Health, Job Failure etc.", + "type": "string" + }, + "affectedObjectFriendlyName": { + "description": "The friendly name of the source of the event on which it is raised (for example, VM, VMM etc).", + "type": "string" + }, + "affectedObjectCorrelationId": { + "description": "The affected object correlationId for the event.", + "type": "string" + }, + "severity": { + "description": "The severity of the event.", + "type": "string" + }, + "timeOfOccurrence": { + "format": "date-time", + "description": "The time of occurrence of the event.", + "type": "string" + }, + "fabricId": { + "description": "The ARM ID of the fabric.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/EventProviderSpecificDetails", + "description": "The provider specific settings." + }, + "eventSpecificDetails": { + "$ref": "#/definitions/EventSpecificDetails", + "description": "The event specific settings." + }, + "healthErrors": { + "description": "The list of errors / warnings capturing details associated with the issue(s).", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + } + } + }, + "EventProviderSpecificDetails": { + "description": "Model class for provider specific details for an event.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type. Overridden in derived classes.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "EventQueryParameter": { + "description": "Implements the event query parameter.", + "type": "object", + "properties": { + "eventCode": { + "description": "The source id of the events to be queried.", + "type": "string" + }, + "severity": { + "description": "The severity of the events to be queried.", + "type": "string" + }, + "eventType": { + "description": "The type of the events to be queried.", + "type": "string" + }, + "fabricName": { + "description": "The affected object server id of the events to be queried.", + "type": "string" + }, + "affectedObjectFriendlyName": { + "description": "The affected object name of the events to be queried.", + "type": "string" + }, + "affectedObjectCorrelationId": { + "description": "The affected object correlationId for the events to be queried.", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "The start time of the time range within which the events are to be queried.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "The end time of the time range within which the events are to be queried.", + "type": "string" + } + } + }, + "EventSpecificDetails": { + "description": "Model class for event specific details for an event.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type. Overridden in derived classes.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ExistingProtectionProfile": { + "description": "Existing storage account input.", + "required": [ + "protectionProfileId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionProfileCustomDetails" + } + ], + "properties": { + "protectionProfileId": { + "description": "The protection profile Arm Id. Throw error, if resource does not exists.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Existing" + }, + "ExistingRecoveryAvailabilitySet": { + "description": "Existing recovery availability set input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryAvailabilitySetCustomDetails" + } + ], + "properties": { + "recoveryAvailabilitySetId": { + "description": "The recovery availability set Id. Will throw error, if resource does not exist.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Existing" + }, + "ExistingRecoveryProximityPlacementGroup": { + "description": "Existing recovery proximity placement group input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryProximityPlacementGroupCustomDetails" + } + ], + "properties": { + "recoveryProximityPlacementGroupId": { + "description": "The recovery proximity placement group Id. Will throw error, if resource does not exist.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Existing" + }, + "ExistingRecoveryRecoveryResourceGroup": { + "description": "Existing recovery resource group input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryResourceGroupCustomDetails" + } + ], + "properties": { + "recoveryResourceGroupId": { + "description": "The recovery resource group Id. Valid for V2 scenarios.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Existing" + }, + "ExistingRecoveryVirtualNetwork": { + "description": "Existing recovery virtual network input.", + "required": [ + "recoveryVirtualNetworkId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryVirtualNetworkCustomDetails" + } + ], + "properties": { + "recoveryVirtualNetworkId": { + "description": "The recovery virtual network Id. Will throw error, if resource does not exist.", + "type": "string" + }, + "recoverySubnetName": { + "description": "The recovery subnet name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Existing" + }, + "ExistingStorageAccount": { + "description": "Existing storage account input.", + "required": [ + "azureStorageAccountId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StorageAccountCustomDetails" + } + ], + "properties": { + "azureStorageAccountId": { + "description": "The storage account Arm Id. Throw error, if resource does not exists.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Existing" + }, + "ExportJobDetails": { + "description": "This class represents details for export jobs workflow.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": { + "blobUri": { + "description": "BlobUri of the exported jobs.", + "type": "string" + }, + "sasToken": { + "description": "The sas token to access blob.", + "type": "string" + } + }, + "x-ms-discriminator-value": "ExportJobDetails" + }, + "Fabric": { + "description": "Fabric definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/FabricProperties", + "description": "Fabric related data." + } + } + }, + "FabricCollection": { + "description": "Collection of fabric details.", + "type": "object", + "properties": { + "value": { + "description": "The fabric details.", + "type": "array", + "items": { + "$ref": "#/definitions/Fabric" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "FabricCreationInput": { + "description": "Site details provided during the time of site creation.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FabricCreationInputProperties", + "description": "Fabric creation input." + } + } + }, + "FabricCreationInputProperties": { + "description": "Properties of site details provided during the time of site creation.", + "type": "object", + "properties": { + "customDetails": { + "$ref": "#/definitions/FabricSpecificCreationInput", + "description": "Fabric provider specific creation input." + } + } + }, + "FabricProperties": { + "description": "Fabric properties.", + "type": "object", + "properties": { + "friendlyName": { + "description": "Friendly name of the fabric.", + "type": "string" + }, + "encryptionDetails": { + "$ref": "#/definitions/EncryptionDetails", + "description": "Encryption details for the fabric." + }, + "rolloverEncryptionDetails": { + "$ref": "#/definitions/EncryptionDetails", + "description": "Rollover encryption details for the fabric." + }, + "internalIdentifier": { + "description": "Dra Registration Id.", + "type": "string" + }, + "bcdrState": { + "description": "BCDR state of the fabric.", + "type": "string" + }, + "customDetails": { + "$ref": "#/definitions/FabricSpecificDetails", + "description": "Fabric specific settings." + }, + "healthErrorDetails": { + "description": "Fabric health error details.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "health": { + "description": "Health of fabric.", + "type": "string" + } + } + }, + "FabricQueryParameter": { + "description": "Query parameter to get fabric.", + "type": "object", + "properties": { + "zoneToZoneMappings": { + "description": "A value indicating whether the zone to zone mappings are to be returned.", + "type": "string" + }, + "fetchAgentDetails": { + "description": "A value indicating whether the agent details are to be fetched.", + "type": "string" + }, + "biosId": { + "description": "The BIOS Id to be used for fetching agent details.", + "type": "string" + }, + "fqdn": { + "description": "The FQDN to be used for fetching agent details.", + "type": "string" + }, + "discoveryType": { + "description": "The type of the discovered machine to be used for fetching agent details.", + "type": "string" + }, + "osType": { + "description": "The OS type to be used for fetching agent details.", + "type": "string" + } + } + }, + "FabricReplicationGroupTaskDetails": { + "description": "This class represents the fabric replication group task details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobTaskDetails" + } + ], + "properties": { + "skippedReason": { + "description": "The skipped reason.", + "type": "string" + }, + "skippedReasonString": { + "description": "The skipped reason string.", + "type": "string" + } + }, + "x-ms-discriminator-value": "FabricReplicationGroupTaskDetails" + }, + "FabricSpecificCreateNetworkMappingInput": { + "description": "Input details specific to fabrics during Network Mapping.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "FabricSpecificCreationInput": { + "description": "Fabric provider specific settings.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "FabricSpecificDetails": { + "description": "Fabric specific details.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type. Overridden in derived classes.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "FabricSpecificUpdateNetworkMappingInput": { + "description": "Input details specific to fabrics during Network Mapping.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "FailoverJobDetails": { + "description": "This class represents the details for a failover job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": { + "protectedItemDetails": { + "description": "The test VM details.", + "type": "array", + "items": { + "$ref": "#/definitions/FailoverReplicationProtectedItemDetails" + } + } + }, + "x-ms-discriminator-value": "FailoverJobDetails" + }, + "FailoverProcessServerRequest": { + "description": "Request to failover a process server.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FailoverProcessServerRequestProperties", + "description": "The properties of the PS Failover request." + } + } + }, + "FailoverProcessServerRequestProperties": { + "description": "The properties of the Failover Process Server request.", + "type": "object", + "properties": { + "containerName": { + "description": "The container identifier.", + "type": "string" + }, + "sourceProcessServerId": { + "description": "The source process server.", + "type": "string" + }, + "targetProcessServerId": { + "description": "The new process server.", + "type": "string" + }, + "vmsToMigrate": { + "description": "The VMS to migrate.", + "type": "array", + "items": { + "type": "string" + } + }, + "updateType": { + "description": "A value for failover type. It can be systemlevel/serverlevel.", + "type": "string" + } + } + }, + "FailoverReplicationProtectedItemDetails": { + "description": "Failover details for a replication protected item.", + "type": "object", + "properties": { + "name": { + "description": "The name.", + "type": "string" + }, + "friendlyName": { + "description": "The friendly name.", + "type": "string" + }, + "testVmName": { + "description": "The test Vm name.", + "type": "string" + }, + "testVmFriendlyName": { + "description": "The test Vm friendly name.", + "type": "string" + }, + "networkConnectionStatus": { + "description": "The network connection status.", + "type": "string" + }, + "networkFriendlyName": { + "description": "The network friendly name.", + "type": "string" + }, + "subnet": { + "description": "The network subnet.", + "type": "string" + }, + "recoveryPointId": { + "description": "The recovery point Id.", + "type": "string" + }, + "recoveryPointTime": { + "format": "date-time", + "description": "The recovery point time.", + "type": "string" + } + } + }, + "GroupTaskDetails": { + "description": "This class represents the group task details when parent child relationship exists in the drill down.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The type of task details.", + "type": "string" + }, + "childTasks": { + "description": "The child tasks.", + "type": "array", + "items": { + "$ref": "#/definitions/ASRTask" + } + } + }, + "discriminator": "instanceType" + }, + "HealthError": { + "description": "Health Error.", + "type": "object", + "properties": { + "innerHealthErrors": { + "description": "The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException.", + "type": "array", + "items": { + "$ref": "#/definitions/InnerHealthError" + } + }, + "errorSource": { + "description": "Source of error.", + "type": "string" + }, + "errorType": { + "description": "Type of error.", + "type": "string" + }, + "errorLevel": { + "description": "Level of error.", + "type": "string" + }, + "errorCategory": { + "description": "Category of error.", + "type": "string" + }, + "errorCode": { + "description": "Error code.", + "type": "string" + }, + "summaryMessage": { + "description": "Summary message of the entity.", + "type": "string" + }, + "errorMessage": { + "description": "Error message.", + "type": "string" + }, + "possibleCauses": { + "description": "Possible causes of error.", + "type": "string" + }, + "recommendedAction": { + "description": "Recommended action to resolve error.", + "type": "string" + }, + "creationTimeUtc": { + "format": "date-time", + "description": "Error creation time (UTC).", + "type": "string" + }, + "recoveryProviderErrorMessage": { + "description": "DRA error message.", + "type": "string" + }, + "entityId": { + "description": "ID of the entity.", + "type": "string" + }, + "errorId": { + "description": "The health error unique id.", + "type": "string" + }, + "customerResolvability": { + "description": "Value indicating whether the health error is customer resolvable.", + "enum": [ + "Allowed", + "NotAllowed" + ], + "type": "string", + "x-ms-enum": { + "name": "HealthErrorCustomerResolvability", + "modelAsString": true + } + } + } + }, + "HealthErrorSummary": { + "description": "class to define the summary of the health error details.", + "type": "object", + "properties": { + "summaryCode": { + "description": "The code of the health error.", + "type": "string" + }, + "category": { + "description": "The category of the health error.", + "enum": [ + "None", + "Replication", + "TestFailover", + "Configuration", + "FabricInfrastructure", + "VersionExpiry", + "AgentAutoUpdateInfra", + "AgentAutoUpdateArtifactDeleted", + "AgentAutoUpdateRunAsAccount", + "AgentAutoUpdateRunAsAccountExpiry", + "AgentAutoUpdateRunAsAccountExpired" + ], + "type": "string", + "x-ms-enum": { + "name": "HealthErrorCategory", + "modelAsString": true + } + }, + "severity": { + "description": "Severity of error.", + "enum": [ + "NONE", + "Warning", + "Error", + "Info" + ], + "type": "string", + "x-ms-enum": { + "name": "Severity", + "modelAsString": true + } + }, + "summaryMessage": { + "description": "The summary message of the health error.", + "type": "string" + }, + "affectedResourceType": { + "description": "The type of affected ARM resource.", + "type": "string" + }, + "affectedResourceSubtype": { + "description": "The sub type of any subcomponent within the ARM resource that this might be applicable. Value remains null if not applicable.", + "type": "string" + }, + "affectedResourceCorrelationIds": { + "description": "The list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "HyperVHostDetails": { + "description": "Hyper-V host details.", + "type": "object", + "properties": { + "id": { + "description": "The Hyper-V host Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The Hyper-V host name.", + "type": "string", + "readOnly": true + }, + "marsAgentVersion": { + "description": "The Mars agent version.", + "type": "string", + "readOnly": true + } + } + }, + "HyperVReplica2012EventDetails": { + "description": "Model class for event details of a HyperVReplica E2E event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "containerName": { + "description": "The container friendly name.", + "type": "string" + }, + "fabricName": { + "description": "The fabric friendly name.", + "type": "string" + }, + "remoteContainerName": { + "description": "The remote container name.", + "type": "string" + }, + "remoteFabricName": { + "description": "The remote fabric name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplica2012" + }, + "HyperVReplica2012R2EventDetails": { + "description": "Model class for event details of a HyperVReplica blue E2E event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "containerName": { + "description": "The container friendly name.", + "type": "string" + }, + "fabricName": { + "description": "The fabric friendly name.", + "type": "string" + }, + "remoteContainerName": { + "description": "The remote container name.", + "type": "string" + }, + "remoteFabricName": { + "description": "The remote fabric name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplica2012R2" + }, + "HyperVReplicaAzureApplyRecoveryPointInput": { + "description": "ApplyRecoveryPoint input specific to HyperVReplicaAzure provider.", + "required": [ + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput" + } + ], + "properties": { + "primaryKekCertificatePfx": { + "description": "The primary kek certificate pfx.", + "type": "string" + }, + "secondaryKekCertificatePfx": { + "description": "The secondary kek certificate pfx.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureDiskInputDetails": { + "description": "Disk input details.", + "type": "object", + "properties": { + "diskId": { + "description": "The DiskId.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The LogStorageAccountId.", + "type": "string" + }, + "diskType": { + "description": "The DiskType.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM ID.", + "type": "string" + } + } + }, + "HyperVReplicaAzureEnableProtectionInput": { + "description": "HyperVReplicaAzure specific enable protection input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnableProtectionProviderSpecificInput" + } + ], + "properties": { + "hvHostVmId": { + "description": "The Hyper-V host VM Id.", + "type": "string" + }, + "vmName": { + "description": "The VM Name.", + "type": "string" + }, + "osType": { + "description": "The OS type associated with VM.", + "type": "string" + }, + "vhdId": { + "description": "The OS disk VHD id associated with VM.", + "type": "string" + }, + "targetStorageAccountId": { + "description": "The storage account Id.", + "type": "string" + }, + "targetAzureNetworkId": { + "description": "The selected target Azure network Id.", + "type": "string" + }, + "targetAzureSubnetId": { + "description": "The selected target Azure subnet Id.", + "type": "string" + }, + "enableRdpOnTargetOption": { + "description": "The selected option to enable RDP\\SSH on target vm after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum.", + "type": "string" + }, + "targetAzureVmName": { + "description": "The target azure VM Name.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The storage account to be used for logging during replication.", + "type": "string" + }, + "disksToInclude": { + "description": "The list of VHD Ids of disks to be protected.", + "type": "array", + "items": { + "type": "string" + } + }, + "targetAzureV1ResourceGroupId": { + "description": "The Id of the target resource group (for classic deployment) in which the failover VM is to be created.", + "type": "string" + }, + "targetAzureV2ResourceGroupId": { + "description": "The Id of the target resource group (for resource manager deployment) in which the failover VM is to be created.", + "type": "string" + }, + "useManagedDisks": { + "description": "A value indicating whether managed disks should be used during failover.", + "type": "string" + }, + "targetAvailabilitySetId": { + "description": "The target availability set ARM Id for resource manager deployment.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "licenseType": { + "description": "License type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "PAYG", + "AHUB" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true + } + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The proximity placement group ARM Id.", + "type": "string" + }, + "useManagedDisksForReplication": { + "description": "A value indicating whether managed disks should be used during replication.", + "type": "string" + }, + "diskType": { + "description": "The DiskType.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + }, + "disksToIncludeForManagedDisks": { + "description": "The disks to include list for managed disks.", + "type": "array", + "items": { + "$ref": "#/definitions/HyperVReplicaAzureDiskInputDetails" + } + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM Id.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "seedManagedDiskTags": { + "description": "The tags for the seed managed disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetManagedDiskTags": { + "description": "The tags for the target managed disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureEventDetails": { + "description": "Model class for event details of a HyperVReplica E2A event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "containerName": { + "description": "The container friendly name.", + "type": "string" + }, + "fabricName": { + "description": "The fabric friendly name.", + "type": "string" + }, + "remoteContainerName": { + "description": "The remote container name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureFailbackProviderInput": { + "description": "HyperVReplicaAzureFailback specific planned failover input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PlannedFailoverProviderSpecificFailoverInput" + } + ], + "properties": { + "dataSyncOption": { + "description": "Data sync option.", + "type": "string" + }, + "recoveryVmCreationOption": { + "description": "ALR options to create alternate recovery.", + "type": "string" + }, + "providerIdForAlternateRecovery": { + "description": "Provider Id for alternate location.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzureFailback" + }, + "HyperVReplicaAzureManagedDiskDetails": { + "description": "Hyper-V Managed disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "seedManagedDiskId": { + "description": "Seed managed disk Id.", + "type": "string" + }, + "replicaDiskType": { + "description": "The replica disk type.", + "type": "string" + }, + "diskEncryptionSetId": { + "description": "The disk encryption set ARM Id.", + "type": "string" + } + } + }, + "HyperVReplicaAzurePlannedFailoverProviderInput": { + "description": "HyperVReplicaAzure specific planned failover input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PlannedFailoverProviderSpecificFailoverInput" + } + ], + "properties": { + "primaryKekCertificatePfx": { + "description": "Primary kek certificate pfx.", + "type": "string" + }, + "secondaryKekCertificatePfx": { + "description": "Secondary kek certificate pfx.", + "type": "string" + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzurePolicyDetails": { + "description": "Hyper-V Replica Azure specific protection profile details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPointHistoryDurationInHours": { + "format": "int32", + "description": "The duration (in hours) to which point the recovery history needs to be maintained.", + "type": "integer" + }, + "applicationConsistentSnapshotFrequencyInHours": { + "format": "int32", + "description": "The interval (in hours) at which Hyper-V Replica should create an application consistent snapshot within the VM.", + "type": "integer" + }, + "replicationInterval": { + "format": "int32", + "description": "The replication interval.", + "type": "integer" + }, + "onlineReplicationStartTime": { + "description": "The scheduled start time for the initial replication. If this parameter is Null, the initial replication starts immediately.", + "type": "string" + }, + "encryption": { + "description": "A value indicating whether encryption is enabled for virtual machines in this cloud.", + "type": "string" + }, + "activeStorageAccountId": { + "description": "The active storage account Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzurePolicyInput": { + "description": "Hyper-V Replica Azure specific input for creating a protection profile.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "recoveryPointHistoryDuration": { + "format": "int32", + "description": "The duration (in hours) to which point the recovery history needs to be maintained.", + "type": "integer" + }, + "applicationConsistentSnapshotFrequencyInHours": { + "format": "int32", + "description": "The interval (in hours) at which Hyper-V Replica should create an application consistent snapshot within the VM.", + "type": "integer" + }, + "replicationInterval": { + "format": "int32", + "description": "The replication interval.", + "type": "integer" + }, + "onlineReplicationStartTime": { + "description": "The scheduled start time for the initial replication. If this parameter is Null, the initial replication starts immediately.", + "type": "string" + }, + "storageAccounts": { + "description": "The list of storage accounts to which the VMs in the primary cloud can replicate to.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureReplicationDetails": { + "description": "Hyper V Replica Azure provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "azureVmDiskDetails": { + "description": "Azure VM Disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/AzureVmDiskDetails" + } + }, + "recoveryAzureVmName": { + "description": "Recovery Azure given name.", + "type": "string" + }, + "recoveryAzureVMSize": { + "description": "The Recovery Azure VM size.", + "type": "string" + }, + "recoveryAzureStorageAccount": { + "description": "The recovery Azure storage account.", + "type": "string" + }, + "recoveryAzureLogStorageAccountId": { + "description": "The ARM id of the log storage account used for replication. This will be set to null if no log storage account was provided during enable protection.", + "type": "string" + }, + "lastReplicatedTime": { + "format": "date-time", + "description": "The Last replication time.", + "type": "string" + }, + "rpoInSeconds": { + "format": "int64", + "description": "Last RPO value.", + "type": "integer" + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The last RPO calculated time.", + "type": "string" + }, + "vmId": { + "description": "The virtual machine Id.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "initialReplicationDetails": { + "$ref": "#/definitions/InitialReplicationDetails", + "description": "Initial replication details." + }, + "vmNics": { + "description": "The PE Network details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicDetails" + } + }, + "selectedRecoveryAzureNetworkId": { + "description": "The selected recovery azure network Id.", + "type": "string" + }, + "selectedSourceNicId": { + "description": "The selected source nic Id which will be used as the primary nic during failover.", + "type": "string" + }, + "encryption": { + "description": "The encryption info.", + "type": "string" + }, + "oSDetails": { + "$ref": "#/definitions/OSDetails", + "description": "The operating system info." + }, + "sourceVmRamSizeInMB": { + "format": "int32", + "description": "The RAM size of the VM on the primary side.", + "type": "integer" + }, + "sourceVmCpuCount": { + "format": "int32", + "description": "The CPU count of the VM on the primary side.", + "type": "integer" + }, + "enableRdpOnTargetOption": { + "description": "The selected option to enable RDP\\SSH on target vm after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum.", + "type": "string" + }, + "recoveryAzureResourceGroupId": { + "description": "The target resource group Id.", + "type": "string" + }, + "recoveryAvailabilitySetId": { + "description": "The recovery availability set Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "useManagedDisks": { + "description": "A value indicating whether managed disks should be used during failover.", + "type": "string" + }, + "licenseType": { + "description": "License Type of the VM to be used.", + "type": "string" + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "type": "string" + }, + "lastRecoveryPointReceived": { + "format": "date-time", + "description": "The last recovery point received time.", + "type": "string", + "readOnly": true + }, + "targetVmTags": { + "description": "The target VM tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "seedManagedDiskTags": { + "description": "The tags for the seed managed disks.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetManagedDiskTags": { + "description": "The tags for the target managed disks.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "protectedManagedDisks": { + "description": "The list of protected managed disks.", + "type": "array", + "items": { + "$ref": "#/definitions/HyperVReplicaAzureManagedDiskDetails" + } + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureReprotectInput": { + "description": "Azure specific reprotect input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReverseReplicationProviderSpecificInput" + } + ], + "properties": { + "hvHostVmId": { + "description": "The Hyper-V host Vm Id.", + "type": "string" + }, + "vmName": { + "description": "The Vm Name.", + "type": "string" + }, + "osType": { + "description": "The OS type associated with vm.", + "type": "string" + }, + "vHDId": { + "description": "The OS disk VHD id associated with vm.", + "type": "string" + }, + "storageAccountId": { + "description": "The storage account name.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The storage account to be used for logging during replication.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureTestFailoverInput": { + "description": "HvrA provider specific input for test failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TestFailoverProviderSpecificInput" + } + ], + "properties": { + "primaryKekCertificatePfx": { + "description": "Primary kek certificate pfx.", + "type": "string" + }, + "secondaryKekCertificatePfx": { + "description": "Secondary kek certificate pfx.", + "type": "string" + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to test failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureUnplannedFailoverInput": { + "description": "HvrA provider specific input for unplanned failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput" + } + ], + "properties": { + "primaryKekCertificatePfx": { + "description": "Primary kek certificate pfx.", + "type": "string" + }, + "secondaryKekCertificatePfx": { + "description": "Secondary kek certificate pfx.", + "type": "string" + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureUpdateReplicationProtectedItemInput": { + "description": "HyperV replica Azure input to update replication protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UpdateReplicationProtectedItemProviderInput" + } + ], + "properties": { + "recoveryAzureV1ResourceGroupId": { + "description": "The recovery Azure resource group Id for classic deployment.", + "type": "string" + }, + "recoveryAzureV2ResourceGroupId": { + "description": "The recovery Azure resource group Id for resource manager deployment.", + "type": "string" + }, + "useManagedDisks": { + "description": "A value indicating whether managed disks should be used during failover.", + "type": "string" + }, + "diskIdToDiskEncryptionMap": { + "description": "The dictionary of disk resource Id to disk encryption set ARM Id.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetManagedDiskTags": { + "description": "The tags for the target managed disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "PAYG", + "AHUB" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true + } + }, + "vmDisks": { + "description": "The list of disk update properties.", + "type": "array", + "items": { + "$ref": "#/definitions/UpdateDiskInput" + } + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaBaseEventDetails": { + "description": "Abstract model class for event details of a HyperVReplica E2E event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "containerName": { + "description": "The container friendly name.", + "type": "string" + }, + "fabricName": { + "description": "The fabric friendly name.", + "type": "string" + }, + "remoteContainerName": { + "description": "The remote container name.", + "type": "string" + }, + "remoteFabricName": { + "description": "The remote fabric name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaBaseEventDetails" + }, + "HyperVReplicaBasePolicyDetails": { + "description": "Base class for HyperVReplica policy details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPoints": { + "format": "int32", + "description": "A value indicating the number of recovery points.", + "type": "integer" + }, + "applicationConsistentSnapshotFrequencyInHours": { + "format": "int32", + "description": "A value indicating the application consistent frequency.", + "type": "integer" + }, + "compression": { + "description": "A value indicating whether compression has to be enabled.", + "type": "string" + }, + "initialReplicationMethod": { + "description": "A value indicating whether IR is online.", + "type": "string" + }, + "onlineReplicationStartTime": { + "description": "A value indicating the online IR start time.", + "type": "string" + }, + "offlineReplicationImportPath": { + "description": "A value indicating the offline IR import path.", + "type": "string" + }, + "offlineReplicationExportPath": { + "description": "A value indicating the offline IR export path.", + "type": "string" + }, + "replicationPort": { + "format": "int32", + "description": "A value indicating the recovery HTTPS port.", + "type": "integer" + }, + "allowedAuthenticationType": { + "format": "int32", + "description": "A value indicating the authentication type.", + "type": "integer" + }, + "replicaDeletionOption": { + "description": "A value indicating whether the VM has to be auto deleted. Supported Values: String.Empty, None, OnRecoveryCloud.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaBasePolicyDetails" + }, + "HyperVReplicaBaseReplicationDetails": { + "description": "Hyper V replica provider specific settings base class.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "lastReplicatedTime": { + "format": "date-time", + "description": "The Last replication time.", + "type": "string" + }, + "vmNics": { + "description": "The PE Network details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicDetails" + } + }, + "vmId": { + "description": "The virtual machine Id.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "initialReplicationDetails": { + "$ref": "#/definitions/InitialReplicationDetails", + "description": "Initial replication details." + }, + "vMDiskDetails": { + "description": "VM disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/DiskDetails" + } + } + }, + "x-ms-discriminator-value": "HyperVReplicaBaseReplicationDetails" + }, + "HyperVReplicaBluePolicyDetails": { + "description": "Hyper-V Replica Blue specific protection profile details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "replicationFrequencyInSeconds": { + "format": "int32", + "description": "A value indicating the replication interval.", + "type": "integer" + }, + "recoveryPoints": { + "format": "int32", + "description": "A value indicating the number of recovery points.", + "type": "integer" + }, + "applicationConsistentSnapshotFrequencyInHours": { + "format": "int32", + "description": "A value indicating the application consistent frequency.", + "type": "integer" + }, + "compression": { + "description": "A value indicating whether compression has to be enabled.", + "type": "string" + }, + "initialReplicationMethod": { + "description": "A value indicating whether IR is online.", + "type": "string" + }, + "onlineReplicationStartTime": { + "description": "A value indicating the online IR start time.", + "type": "string" + }, + "offlineReplicationImportPath": { + "description": "A value indicating the offline IR import path.", + "type": "string" + }, + "offlineReplicationExportPath": { + "description": "A value indicating the offline IR export path.", + "type": "string" + }, + "replicationPort": { + "format": "int32", + "description": "A value indicating the recovery HTTPS port.", + "type": "integer" + }, + "allowedAuthenticationType": { + "format": "int32", + "description": "A value indicating the authentication type.", + "type": "integer" + }, + "replicaDeletionOption": { + "description": "A value indicating whether the VM has to be auto deleted. Supported Values: String.Empty, None, OnRecoveryCloud", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplica2012R2" + }, + "HyperVReplicaBluePolicyInput": { + "description": "HyperV Replica Blue policy input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HyperVReplicaPolicyInput" + } + ], + "properties": { + "replicationFrequencyInSeconds": { + "format": "int32", + "description": "A value indicating the replication interval.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "HyperVReplica2012R2" + }, + "HyperVReplicaBlueReplicationDetails": { + "description": "HyperV replica 2012 R2 (Blue) replication details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "lastReplicatedTime": { + "format": "date-time", + "description": "The Last replication time.", + "type": "string" + }, + "vmNics": { + "description": "The PE Network details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicDetails" + } + }, + "vmId": { + "description": "The virtual machine Id.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "initialReplicationDetails": { + "$ref": "#/definitions/InitialReplicationDetails", + "description": "Initial replication details." + }, + "vMDiskDetails": { + "description": "VM disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/DiskDetails" + } + } + }, + "x-ms-discriminator-value": "HyperVReplica2012R2" + }, + "HyperVReplicaPolicyDetails": { + "description": "Hyper-V Replica Blue specific protection profile details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPoints": { + "format": "int32", + "description": "A value indicating the number of recovery points.", + "type": "integer" + }, + "applicationConsistentSnapshotFrequencyInHours": { + "format": "int32", + "description": "A value indicating the application consistent frequency.", + "type": "integer" + }, + "compression": { + "description": "A value indicating whether compression has to be enabled.", + "type": "string" + }, + "initialReplicationMethod": { + "description": "A value indicating whether IR is online.", + "type": "string" + }, + "onlineReplicationStartTime": { + "description": "A value indicating the online IR start time.", + "type": "string" + }, + "offlineReplicationImportPath": { + "description": "A value indicating the offline IR import path.", + "type": "string" + }, + "offlineReplicationExportPath": { + "description": "A value indicating the offline IR export path.", + "type": "string" + }, + "replicationPort": { + "format": "int32", + "description": "A value indicating the recovery HTTPS port.", + "type": "integer" + }, + "allowedAuthenticationType": { + "format": "int32", + "description": "A value indicating the authentication type.", + "type": "integer" + }, + "replicaDeletionOption": { + "description": "A value indicating whether the VM has to be auto deleted. Supported Values: String.Empty, None, OnRecoveryCloud", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplica2012" + }, + "HyperVReplicaPolicyInput": { + "description": "Hyper-V Replica specific policy Input.", + "required": [ + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "recoveryPoints": { + "format": "int32", + "description": "A value indicating the number of recovery points.", + "type": "integer" + }, + "applicationConsistentSnapshotFrequencyInHours": { + "format": "int32", + "description": "A value indicating the application consistent frequency.", + "type": "integer" + }, + "compression": { + "description": "A value indicating whether compression has to be enabled.", + "type": "string" + }, + "initialReplicationMethod": { + "description": "A value indicating whether IR is online.", + "type": "string" + }, + "onlineReplicationStartTime": { + "description": "A value indicating the online IR start time.", + "type": "string" + }, + "offlineReplicationImportPath": { + "description": "A value indicating the offline IR import path.", + "type": "string" + }, + "offlineReplicationExportPath": { + "description": "A value indicating the offline IR export path.", + "type": "string" + }, + "replicationPort": { + "format": "int32", + "description": "A value indicating the recovery HTTPS port.", + "type": "integer" + }, + "allowedAuthenticationType": { + "format": "int32", + "description": "A value indicating the authentication type.", + "type": "integer" + }, + "replicaDeletion": { + "description": "A value indicating whether the VM has to be auto deleted.", + "type": "string" + } + }, + "discriminator": "instanceType", + "x-ms-discriminator-value": "HyperVReplica2012" + }, + "HyperVReplicaReplicationDetails": { + "description": "HyperV replica 2012 replication details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "lastReplicatedTime": { + "format": "date-time", + "description": "The Last replication time.", + "type": "string" + }, + "vmNics": { + "description": "The PE Network details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicDetails" + } + }, + "vmId": { + "description": "The virtual machine Id.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "initialReplicationDetails": { + "$ref": "#/definitions/InitialReplicationDetails", + "description": "Initial replication details." + }, + "vMDiskDetails": { + "description": "VM disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/DiskDetails" + } + } + }, + "x-ms-discriminator-value": "HyperVReplica2012" + }, + "HyperVSiteDetails": { + "description": "HyperVSite fabric specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificDetails" + } + ], + "properties": { + "hyperVHosts": { + "description": "The list of Hyper-V hosts associated with the fabric.", + "type": "array", + "items": { + "$ref": "#/definitions/HyperVHostDetails" + } + } + }, + "x-ms-discriminator-value": "HyperVSite" + }, + "HyperVVirtualMachineDetails": { + "description": "Single Host fabric provider specific VM settings.", + "required": [ + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConfigurationSettings" + } + ], + "properties": { + "sourceItemId": { + "description": "The source id of the object.", + "type": "string" + }, + "generation": { + "description": "The id of the object in fabric.", + "type": "string" + }, + "osDetails": { + "$ref": "#/definitions/OSDetails", + "description": "The Last replication time." + }, + "diskDetails": { + "description": "The Last successful failover time.", + "type": "array", + "items": { + "$ref": "#/definitions/DiskDetails" + } + }, + "hasPhysicalDisk": { + "description": "A value indicating whether the VM has a physical disk attached. String value of SrsDataContract.PresenceStatus enum.", + "enum": [ + "Unknown", + "Present", + "NotPresent" + ], + "type": "string", + "x-ms-enum": { + "name": "PresenceStatus", + "modelAsString": true + } + }, + "hasFibreChannelAdapter": { + "description": "A value indicating whether the VM has a fibre channel adapter attached. String value of SrsDataContract.PresenceStatus enum.", + "enum": [ + "Unknown", + "Present", + "NotPresent" + ], + "type": "string", + "x-ms-enum": { + "name": "PresenceStatus", + "modelAsString": true + } + }, + "hasSharedVhd": { + "description": "A value indicating whether the VM has a shared VHD attached. String value of SrsDataContract.PresenceStatus enum.", + "enum": [ + "Unknown", + "Present", + "NotPresent" + ], + "type": "string", + "x-ms-enum": { + "name": "PresenceStatus", + "modelAsString": true + } + } + }, + "discriminator": "instanceType", + "x-ms-discriminator-value": "HyperVVirtualMachine" + }, + "IdentityProviderDetails": { + "description": "Identity provider details.", + "type": "object", + "properties": { + "tenantId": { + "description": "The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "applicationId": { + "description": "The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "objectId": { + "description": "The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "audience": { + "description": "The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "aadAuthority": { + "description": "The base authority for Azure Active Directory authentication.", + "type": "string" + } + } + }, + "IdentityProviderInput": { + "description": "Identity provider input.", + "required": [ + "tenantId", + "applicationId", + "objectId", + "audience", + "aadAuthority" + ], + "type": "object", + "properties": { + "tenantId": { + "description": "The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "applicationId": { + "description": "The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "objectId": { + "description": "The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "audience": { + "description": "The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "aadAuthority": { + "description": "The base authority for Azure Active Directory authentication.", + "type": "string" + } + } + }, + "InconsistentVmDetails": { + "description": "This class stores the monitoring details for consistency check of inconsistent Protected Entity.", + "type": "object", + "properties": { + "vmName": { + "description": "The Vm name.", + "type": "string" + }, + "cloudName": { + "description": "The Cloud name.", + "type": "string" + }, + "details": { + "description": "The list of details regarding state of the Protected Entity in SRS and On prem.", + "type": "array", + "items": { + "type": "string" + } + }, + "errorIds": { + "description": "The list of error ids.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "InitialReplicationDetails": { + "description": "Initial replication details.", + "type": "object", + "properties": { + "initialReplicationType": { + "description": "Initial replication type.", + "type": "string" + }, + "initialReplicationProgressPercentage": { + "description": "The initial replication progress percentage.", + "type": "string" + } + } + }, + "InlineWorkflowTaskDetails": { + "description": "This class represents the inline workflow task details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GroupTaskDetails" + } + ], + "properties": { + "workflowIds": { + "description": "The list of child workflow ids.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "InlineWorkflowTaskDetails" + }, + "InMageAgentDetails": { + "description": "The details of the InMage agent.", + "type": "object", + "properties": { + "agentVersion": { + "description": "The agent version.", + "type": "string" + }, + "agentUpdateStatus": { + "description": "A value indicating whether installed agent needs to be updated.", + "type": "string" + }, + "postUpdateRebootStatus": { + "description": "A value indicating whether reboot is required after update is applied.", + "type": "string" + }, + "agentExpiryDate": { + "format": "date-time", + "description": "Agent expiry date.", + "type": "string" + } + } + }, + "InMageAzureV2ApplyRecoveryPointInput": { + "description": "ApplyRecoveryPoint input specific to InMageAzureV2 provider.", + "required": [ + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2DiskInputDetails": { + "description": "Disk input details.", + "type": "object", + "properties": { + "diskId": { + "description": "The DiskId.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The LogStorageAccountId.", + "type": "string" + }, + "diskType": { + "description": "The DiskType.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM ID.", + "type": "string" + } + } + }, + "InMageAzureV2EnableProtectionInput": { + "description": "VMware Azure specific enable protection input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnableProtectionProviderSpecificInput" + } + ], + "properties": { + "masterTargetId": { + "description": "The Master target Id.", + "type": "string" + }, + "processServerId": { + "description": "The Process Server Id.", + "type": "string" + }, + "storageAccountId": { + "description": "The storage account Id.", + "type": "string" + }, + "runAsAccountId": { + "description": "The CS account Id.", + "type": "string" + }, + "multiVmGroupId": { + "description": "The multi VM group Id.", + "type": "string" + }, + "multiVmGroupName": { + "description": "The multi VM group name.", + "type": "string" + }, + "disksToInclude": { + "description": "The disks to include list.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageAzureV2DiskInputDetails" + } + }, + "targetAzureNetworkId": { + "description": "The selected target Azure network Id.", + "type": "string" + }, + "targetAzureSubnetId": { + "description": "The selected target Azure subnet Id.", + "type": "string" + }, + "enableRdpOnTargetOption": { + "description": "The selected option to enable RDP\\SSH on target VM after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum.", + "type": "string" + }, + "targetAzureVmName": { + "description": "The target azure VM Name.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The storage account to be used for logging during replication.", + "type": "string" + }, + "targetAzureV1ResourceGroupId": { + "description": "The Id of the target resource group (for classic deployment) in which the failover VM is to be created.", + "type": "string" + }, + "targetAzureV2ResourceGroupId": { + "description": "The Id of the target resource group (for resource manager deployment) in which the failover VM is to be created.", + "type": "string" + }, + "diskType": { + "description": "The DiskType.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + }, + "targetAvailabilitySetId": { + "description": "The target availability set ARM Id for resource manager deployment.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The proximity placement group ARM Id.", + "type": "string" + }, + "licenseType": { + "description": "License type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "PAYG", + "AHUB" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true + } + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM Id.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "seedManagedDiskTags": { + "description": "The tags for the seed managed disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetManagedDiskTags": { + "description": "The tags for the target managed disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2EventDetails": { + "description": "Model class for event details of a VMwareAzureV2 event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "eventType": { + "description": "InMage Event type. Takes one of the values of InMageDataContract.InMageMonitoringEventType.", + "type": "string" + }, + "category": { + "description": "InMage Event Category.", + "type": "string" + }, + "component": { + "description": "InMage Event Component.", + "type": "string" + }, + "correctiveAction": { + "description": "Corrective Action string for the event.", + "type": "string" + }, + "details": { + "description": "InMage Event Details.", + "type": "string" + }, + "summary": { + "description": "InMage Event Summary.", + "type": "string" + }, + "siteName": { + "description": "VMware Site name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2ManagedDiskDetails": { + "description": "InMageAzureV2 Managed disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk id.", + "type": "string" + }, + "seedManagedDiskId": { + "description": "Seed managed disk Id.", + "type": "string" + }, + "replicaDiskType": { + "description": "The replica disk type.", + "type": "string" + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM ID.", + "type": "string" + }, + "targetDiskName": { + "description": "The target disk name.", + "type": "string" + } + } + }, + "InMageAzureV2PolicyDetails": { + "description": "InMage Azure v2 specific protection profile details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency in minutes.", + "type": "integer" + }, + "recoveryPointThresholdInMinutes": { + "format": "int32", + "description": "The recovery point threshold in minutes.", + "type": "integer" + }, + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency in minutes.", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2PolicyInput": { + "description": "VMWare Azure specific policy Input.", + "required": [ + "multiVmSyncStatus" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "recoveryPointThresholdInMinutes": { + "format": "int32", + "description": "The recovery point threshold in minutes.", + "type": "integer" + }, + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'.", + "enum": [ + "Enable", + "Disable" + ], + "type": "string", + "x-ms-enum": { + "name": "SetMultiVmSyncStatus", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2ProtectedDiskDetails": { + "description": "InMageAzureV2 protected disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk id.", + "type": "string" + }, + "diskName": { + "description": "The disk name.", + "type": "string" + }, + "protectionStage": { + "description": "The protection stage.", + "type": "string" + }, + "healthErrorCode": { + "description": "The health error code for the disk.", + "type": "string" + }, + "rpoInSeconds": { + "format": "int64", + "description": "The RPO in seconds.", + "type": "integer" + }, + "resyncRequired": { + "description": "A value indicating whether resync is required for this disk.", + "type": "string" + }, + "resyncProgressPercentage": { + "format": "int32", + "description": "The resync progress percentage.", + "type": "integer" + }, + "resyncDurationInSeconds": { + "format": "int64", + "description": "The resync duration in seconds.", + "type": "integer" + }, + "diskCapacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer" + }, + "fileSystemCapacityInBytes": { + "format": "int64", + "description": "The disk file system capacity in bytes.", + "type": "integer" + }, + "sourceDataInMegaBytes": { + "format": "double", + "description": "The source data transit in MB.", + "type": "number" + }, + "psDataInMegaBytes": { + "format": "double", + "description": "The PS data transit in MB.", + "type": "number" + }, + "targetDataInMegaBytes": { + "format": "double", + "description": "The target data transit in MB.", + "type": "number" + }, + "diskResized": { + "description": "A value indicating whether disk is resized.", + "type": "string" + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The last RPO calculated time.", + "type": "string" + }, + "resyncProcessedBytes": { + "format": "int64", + "description": "The resync processed bytes.", + "type": "integer" + }, + "resyncTotalTransferredBytes": { + "format": "int64", + "description": "The resync total transferred bytes.", + "type": "integer" + }, + "resyncLast15MinutesTransferredBytes": { + "format": "int64", + "description": "The resync last 15 minutes transferred bytes.", + "type": "integer" + }, + "resyncLastDataTransferTimeUTC": { + "format": "date-time", + "description": "The last data transfer time in UTC.", + "type": "string" + }, + "resyncStartTime": { + "format": "date-time", + "description": "The resync start time.", + "type": "string" + }, + "progressHealth": { + "description": "The Progress Health.", + "type": "string" + }, + "progressStatus": { + "description": "The Progress Status.", + "type": "string" + } + } + }, + "InMageAzureV2RecoveryPointDetails": { + "description": "InMage Azure V2 provider specific recovery point details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProviderSpecificRecoveryPointDetails" + } + ], + "properties": { + "isMultiVmSyncPoint": { + "description": "A value indicating whether the recovery point is multi VM consistent.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2ReplicationDetails": { + "description": "InMageAzureV2 provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "infrastructureVmId": { + "description": "The infrastructure VM Id.", + "type": "string" + }, + "vCenterInfrastructureId": { + "description": "The vCenter infrastructure Id.", + "type": "string" + }, + "protectionStage": { + "description": "The protection stage.", + "type": "string" + }, + "vmId": { + "description": "The virtual machine Id.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "resyncProgressPercentage": { + "format": "int32", + "description": "The resync progress percentage.", + "type": "integer" + }, + "rpoInSeconds": { + "format": "int64", + "description": "The RPO in seconds.", + "type": "integer" + }, + "compressedDataRateInMB": { + "format": "double", + "description": "The compressed data change rate in MB.", + "type": "number" + }, + "uncompressedDataRateInMB": { + "format": "double", + "description": "The uncompressed data change rate in MB.", + "type": "number" + }, + "ipAddress": { + "description": "The source IP address.", + "type": "string" + }, + "agentVersion": { + "description": "The agent version.", + "type": "string" + }, + "agentExpiryDate": { + "format": "date-time", + "description": "Agent expiry date.", + "type": "string" + }, + "isAgentUpdateRequired": { + "description": "A value indicating whether installed agent needs to be updated.", + "type": "string" + }, + "isRebootAfterUpdateRequired": { + "description": "A value indicating whether the source server requires a restart after update.", + "type": "string" + }, + "lastHeartbeat": { + "format": "date-time", + "description": "The last heartbeat received from the source server.", + "type": "string" + }, + "processServerId": { + "description": "The process server Id.", + "type": "string" + }, + "processServerName": { + "description": "The process server name.", + "type": "string" + }, + "multiVmGroupId": { + "description": "The multi vm group Id.", + "type": "string" + }, + "multiVmGroupName": { + "description": "The multi vm group name.", + "type": "string" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi vm sync is enabled or disabled.", + "type": "string" + }, + "protectedDisks": { + "description": "The list of protected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageAzureV2ProtectedDiskDetails" + } + }, + "diskResized": { + "description": "A value indicating whether any disk is resized for this VM.", + "type": "string" + }, + "masterTargetId": { + "description": "The master target Id.", + "type": "string" + }, + "sourceVmCpuCount": { + "format": "int32", + "description": "The CPU count of the VM on the primary side.", + "type": "integer" + }, + "sourceVmRamSizeInMB": { + "format": "int32", + "description": "The RAM size of the VM on the primary side.", + "type": "integer" + }, + "osType": { + "description": "The type of the OS on the VM.", + "type": "string" + }, + "vhdName": { + "description": "The OS disk VHD name.", + "type": "string" + }, + "osDiskId": { + "description": "The id of the disk containing the OS.", + "type": "string" + }, + "azureVMDiskDetails": { + "description": "Azure VM Disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/AzureVmDiskDetails" + } + }, + "recoveryAzureVMName": { + "description": "Recovery Azure given name.", + "type": "string" + }, + "recoveryAzureVMSize": { + "description": "The Recovery Azure VM size.", + "type": "string" + }, + "recoveryAzureStorageAccount": { + "description": "The recovery Azure storage account.", + "type": "string" + }, + "recoveryAzureLogStorageAccountId": { + "description": "The ARM id of the log storage account used for replication. This will be set to null if no log storage account was provided during enable protection.", + "type": "string" + }, + "vmNics": { + "description": "The PE Network details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicDetails" + } + }, + "selectedRecoveryAzureNetworkId": { + "description": "The selected recovery azure network Id.", + "type": "string" + }, + "selectedTfoAzureNetworkId": { + "description": "The test failover virtual network.", + "type": "string" + }, + "selectedSourceNicId": { + "description": "The selected source nic Id which will be used as the primary nic during failover.", + "type": "string" + }, + "discoveryType": { + "description": "A value indicating the discovery type of the machine. Value can be vCenter or physical.", + "type": "string" + }, + "enableRdpOnTargetOption": { + "description": "The selected option to enable RDP\\SSH on target vm after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum.", + "type": "string" + }, + "datastores": { + "description": "The datastores of the on-premise machine. Value can be list of strings that contain datastore names.", + "type": "array", + "items": { + "type": "string" + } + }, + "targetVmId": { + "description": "The ARM Id of the target Azure VM. This value will be null until the VM is failed over. Only after failure it will be populated with the ARM Id of the Azure VM.", + "type": "string" + }, + "recoveryAzureResourceGroupId": { + "description": "The target resource group Id.", + "type": "string" + }, + "recoveryAvailabilitySetId": { + "description": "The recovery availability set Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "useManagedDisks": { + "description": "A value indicating whether managed disks should be used during failover.", + "type": "string" + }, + "licenseType": { + "description": "License Type of the VM to be used.", + "type": "string" + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "type": "string" + }, + "validationErrors": { + "description": "The validation errors of the on-premise machine Value can be list of validation errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The last RPO calculated time.", + "type": "string" + }, + "lastUpdateReceivedTime": { + "format": "date-time", + "description": "The last update time received from on-prem components.", + "type": "string" + }, + "replicaId": { + "description": "The replica id of the protected item.", + "type": "string" + }, + "osVersion": { + "description": "The OS Version of the protected item.", + "type": "string" + }, + "protectedManagedDisks": { + "description": "The list of protected managed disks.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageAzureV2ManagedDiskDetails" + } + }, + "lastRecoveryPointReceived": { + "format": "date-time", + "description": "The last recovery point received time.", + "type": "string", + "readOnly": true + }, + "firmwareType": { + "description": "The firmware type of this protected item.", + "type": "string" + }, + "azureVmGeneration": { + "description": "The target generation for this protected item.", + "type": "string" + }, + "isAdditionalStatsAvailable": { + "description": "A value indicating whether additional IR stats are available or not.", + "type": "boolean" + }, + "totalDataTransferred": { + "format": "int64", + "description": "The total transferred data in bytes.", + "type": "integer" + }, + "totalProgressHealth": { + "description": "The progress health.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "seedManagedDiskTags": { + "description": "The tags for the seed managed disks.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetManagedDiskTags": { + "description": "The tags for the target managed disks.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2ReprotectInput": { + "description": "InMageAzureV2 specific provider input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReverseReplicationProviderSpecificInput" + } + ], + "properties": { + "masterTargetId": { + "description": "The Master target Id.", + "type": "string" + }, + "processServerId": { + "description": "The Process Server Id.", + "type": "string" + }, + "storageAccountId": { + "description": "The storage account id.", + "type": "string" + }, + "runAsAccountId": { + "description": "The CS account Id.", + "type": "string" + }, + "policyId": { + "description": "The Policy Id.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The storage account to be used for logging during replication.", + "type": "string" + }, + "disksToInclude": { + "description": "The disks to include list.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2TestFailoverInput": { + "description": "InMageAzureV2 provider specific input for test failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TestFailoverProviderSpecificInput" + } + ], + "properties": { + "recoveryPointId": { + "description": "The recovery point id to be passed to test failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2UnplannedFailoverInput": { + "description": "InMageAzureV2 provider specific input for unplanned failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput" + } + ], + "properties": { + "recoveryPointId": { + "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2UpdateReplicationProtectedItemInput": { + "description": "InMage Azure V2 input to update replication protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UpdateReplicationProtectedItemProviderInput" + } + ], + "properties": { + "recoveryAzureV1ResourceGroupId": { + "description": "The recovery Azure resource group Id for classic deployment.", + "type": "string" + }, + "recoveryAzureV2ResourceGroupId": { + "description": "The recovery Azure resource group Id for resource manager deployment.", + "type": "string" + }, + "useManagedDisks": { + "description": "A value indicating whether managed disks should be used during failover.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetManagedDiskTags": { + "description": "The tags for the target managed disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "PAYG", + "AHUB" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true + } + }, + "vmDisks": { + "description": "The list of disk update properties.", + "type": "array", + "items": { + "$ref": "#/definitions/UpdateDiskInput" + } + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageBasePolicyDetails": { + "description": "Base class for the policies of providers using InMage replication.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPointThresholdInMinutes": { + "format": "int32", + "description": "The recovery point threshold in minutes.", + "type": "integer" + }, + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency in minutes.", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageBasePolicyDetails" + }, + "InMageDisableProtectionProviderSpecificInput": { + "description": "InMage disable protection provider specific input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DisableProtectionProviderSpecificInput" + } + ], + "properties": { + "replicaVmDeletionStatus": { + "description": "A value indicating whether the replica VM should be destroyed or retained. Values from Delete and Retain.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMageDiskDetails": { + "description": "VMware/Physical specific Disk Details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "diskName": { + "description": "The disk name.", + "type": "string" + }, + "diskSizeInMB": { + "description": "The disk size in MB.", + "type": "string" + }, + "diskType": { + "description": "Whether disk is system disk or data disk.", + "type": "string" + }, + "diskConfiguration": { + "description": "Whether disk is dynamic disk or basic disk.", + "type": "string" + }, + "volumeList": { + "description": "Volumes of the disk.", + "type": "array", + "items": { + "$ref": "#/definitions/DiskVolumeDetails" + } + } + } + }, + "InMageDiskExclusionInput": { + "description": "DiskExclusionInput when doing enable protection of virtual machine in InMage provider.", + "type": "object", + "properties": { + "volumeOptions": { + "description": "The volume label based option for disk exclusion.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageVolumeExclusionOptions" + } + }, + "diskSignatureOptions": { + "description": "The guest disk signature based option for disk exclusion.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageDiskSignatureExclusionOptions" + } + } + } + }, + "InMageDiskSignatureExclusionOptions": { + "description": "Guest disk signature based disk exclusion option when doing enable protection of virtual machine in InMage provider.", + "type": "object", + "properties": { + "diskSignature": { + "description": "The guest signature of disk to be excluded from replication.", + "type": "string" + } + } + }, + "InMageEnableProtectionInput": { + "description": "VMware Azure specific enable protection input.", + "required": [ + "masterTargetId", + "processServerId", + "retentionDrive", + "multiVmGroupId", + "multiVmGroupName" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnableProtectionProviderSpecificInput" + } + ], + "properties": { + "vmFriendlyName": { + "description": "The VM Name.", + "type": "string" + }, + "masterTargetId": { + "description": "The Master Target Id.", + "type": "string" + }, + "processServerId": { + "description": "The Process Server Id.", + "type": "string" + }, + "retentionDrive": { + "description": "The retention drive to use on the MT.", + "type": "string" + }, + "runAsAccountId": { + "description": "The CS account Id.", + "type": "string" + }, + "multiVmGroupId": { + "description": "The multi VM group Id.", + "type": "string" + }, + "multiVmGroupName": { + "description": "The multi VM group name.", + "type": "string" + }, + "datastoreName": { + "description": "The target datastore name.", + "type": "string" + }, + "diskExclusionInput": { + "$ref": "#/definitions/InMageDiskExclusionInput", + "description": "The enable disk exclusion input." + }, + "disksToInclude": { + "description": "The disks to include list.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMagePolicyDetails": { + "description": "InMage specific protection profile details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPointThresholdInMinutes": { + "format": "int32", + "description": "The recovery point threshold in minutes.", + "type": "integer" + }, + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency in minutes.", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMagePolicyInput": { + "description": "VMWare Azure specific protection profile Input.", + "required": [ + "multiVmSyncStatus" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "recoveryPointThresholdInMinutes": { + "format": "int32", + "description": "The recovery point threshold in minutes.", + "type": "integer" + }, + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'.", + "enum": [ + "Enable", + "Disable" + ], + "type": "string", + "x-ms-enum": { + "name": "SetMultiVmSyncStatus", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMageProtectedDiskDetails": { + "description": "InMage protected disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk id.", + "type": "string" + }, + "diskName": { + "description": "The disk name.", + "type": "string" + }, + "protectionStage": { + "description": "The protection stage.", + "type": "string" + }, + "healthErrorCode": { + "description": "The health error code for the disk.", + "type": "string" + }, + "rpoInSeconds": { + "format": "int64", + "description": "The RPO in seconds.", + "type": "integer" + }, + "resyncRequired": { + "description": "A value indicating whether resync is required for this disk.", + "type": "string" + }, + "resyncProgressPercentage": { + "format": "int32", + "description": "The resync progress percentage.", + "type": "integer" + }, + "resyncDurationInSeconds": { + "format": "int64", + "description": "The resync duration in seconds.", + "type": "integer" + }, + "diskCapacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer" + }, + "fileSystemCapacityInBytes": { + "format": "int64", + "description": "The file system capacity in bytes.", + "type": "integer" + }, + "sourceDataInMB": { + "format": "double", + "description": "The source data transit in MB.", + "type": "number" + }, + "psDataInMB": { + "format": "double", + "description": "The PS data transit in MB.", + "type": "number" + }, + "targetDataInMB": { + "format": "double", + "description": "The target data transit in MB.", + "type": "number" + }, + "diskResized": { + "description": "A value indicating whether disk is resized.", + "type": "string" + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The last RPO calculated time.", + "type": "string" + }, + "resyncProcessedBytes": { + "format": "int64", + "description": "The resync processed bytes.", + "type": "integer" + }, + "resyncTotalTransferredBytes": { + "format": "int64", + "description": "The resync total transferred bytes.", + "type": "integer" + }, + "resyncLast15MinutesTransferredBytes": { + "format": "int64", + "description": "The resync last 15 minutes transferred bytes.", + "type": "integer" + }, + "resyncLastDataTransferTimeUTC": { + "format": "date-time", + "description": "The last data transfer time in UTC.", + "type": "string" + }, + "resyncStartTime": { + "format": "date-time", + "description": "The resync start time.", + "type": "string" + }, + "progressHealth": { + "description": "The Progress Health.", + "type": "string" + }, + "progressStatus": { + "description": "The Progress Status.", + "type": "string" + } + } + }, + "InMageRcmAgentUpgradeBlockingErrorDetails": { + "description": "InMageRcm source agent upgrade blocking error details.", + "type": "object", + "properties": { + "errorCode": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "errorMessage": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "possibleCauses": { + "description": "The possible causes.", + "type": "string", + "readOnly": true + }, + "recommendedAction": { + "description": "The recommended action.", + "type": "string", + "readOnly": true + }, + "errorMessageParameters": { + "description": "The error message parameters.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "errorTags": { + "description": "The error tags.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + } + }, + "InMageRcmApplyRecoveryPointInput": { + "description": "ApplyRecoveryPoint input specific to InMageRcm provider.", + "required": [ + "recoveryPointId", + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput" + } + ], + "properties": { + "recoveryPointId": { + "description": "The recovery point Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmDiscoveredProtectedVmDetails": { + "description": "InMageRcm discovered protected VM details.", + "type": "object", + "properties": { + "vCenterId": { + "description": "The VCenter Id.", + "type": "string", + "readOnly": true + }, + "vCenterFqdn": { + "description": "The VCenter fqdn.", + "type": "string", + "readOnly": true + }, + "datastores": { + "description": "The list of datastores.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "ipAddresses": { + "description": "The list of IP addresses.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "vmwareToolsStatus": { + "description": "The VMware tools status.", + "type": "string", + "readOnly": true + }, + "powerStatus": { + "description": "The VM power status.", + "type": "string", + "readOnly": true + }, + "vmFqdn": { + "description": "The VM fqdn.", + "type": "string", + "readOnly": true + }, + "osName": { + "description": "The VM's OS name.", + "type": "string", + "readOnly": true + }, + "createdTimestamp": { + "format": "date-time", + "description": "The SDS created timestamp.", + "type": "string", + "readOnly": true + }, + "updatedTimestamp": { + "format": "date-time", + "description": "The SDS updated timestamp.", + "type": "string", + "readOnly": true + }, + "isDeleted": { + "description": "A value indicating whether the VM is deleted.", + "type": "boolean", + "readOnly": true + }, + "lastDiscoveryTimeInUtc": { + "format": "date-time", + "description": "The last time when SDS information discovered in SRS.", + "type": "string", + "readOnly": true + } + } + }, + "InMageRcmDiskInput": { + "description": "InMageRcm disk input.", + "required": [ + "diskId", + "logStorageAccountId", + "diskType" + ], + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string" + }, + "diskType": { + "description": "The disk type.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM Id.", + "type": "string" + } + } + }, + "InMageRcmDisksDefaultInput": { + "description": "InMageRcm disk input.", + "required": [ + "logStorageAccountId", + "diskType" + ], + "type": "object", + "properties": { + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string" + }, + "diskType": { + "description": "The disk type.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM Id.", + "type": "string" + } + } + }, + "InMageRcmEnableProtectionInput": { + "description": "InMageRcm specific enable protection input.", + "required": [ + "fabricDiscoveryMachineId", + "targetResourceGroupId", + "processServerId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnableProtectionProviderSpecificInput" + } + ], + "properties": { + "fabricDiscoveryMachineId": { + "description": "The ARM Id of discovered machine.", + "type": "string" + }, + "disksToInclude": { + "description": "The disks to include list.", + "minLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmDiskInput" + } + }, + "disksDefault": { + "$ref": "#/definitions/InMageRcmDisksDefaultInput", + "description": "The default disk input." + }, + "targetResourceGroupId": { + "description": "The target resource group ARM Id.", + "type": "string" + }, + "targetNetworkId": { + "description": "The selected target network ARM Id.", + "type": "string" + }, + "testNetworkId": { + "description": "The selected test network ARM Id.", + "type": "string" + }, + "targetSubnetName": { + "description": "The selected target subnet name.", + "type": "string" + }, + "testSubnetName": { + "description": "The selected test subnet name.", + "type": "string" + }, + "targetVmName": { + "description": "The target VM name.", + "type": "string" + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "licenseType": { + "description": "The license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "targetAvailabilitySetId": { + "description": "The target availability set ARM Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "targetBootDiagnosticsStorageAccountId": { + "description": "The target boot diagnostics storage account ARM Id.", + "type": "string" + }, + "runAsAccountId": { + "description": "The run-as account Id.", + "type": "string" + }, + "processServerId": { + "description": "The process server Id.", + "type": "string" + }, + "multiVmGroupName": { + "description": "The multi VM group name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmEventDetails": { + "description": "Event details for InMageRcm provider.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "protectedItemName": { + "description": "The protected item name.", + "type": "string", + "readOnly": true + }, + "vmName": { + "description": "The protected item name.", + "type": "string", + "readOnly": true + }, + "latestAgentVersion": { + "description": "The latest agent version.", + "type": "string", + "readOnly": true + }, + "jobId": { + "description": "The job Id.", + "type": "string", + "readOnly": true + }, + "fabricName": { + "description": "The fabric name.", + "type": "string", + "readOnly": true + }, + "applianceName": { + "description": "The appliance name.", + "type": "string", + "readOnly": true + }, + "serverType": { + "description": "The server type.", + "type": "string", + "readOnly": true + }, + "componentDisplayName": { + "description": "The component display name.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmFabricCreationInput": { + "description": "InMageRcm fabric provider specific settings.", + "required": [ + "vmwareSiteId", + "physicalSiteId", + "sourceAgentIdentity" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificCreationInput" + } + ], + "properties": { + "vmwareSiteId": { + "description": "The ARM Id of the VMware site.", + "type": "string" + }, + "physicalSiteId": { + "description": "The ARM Id of the physical site.", + "type": "string" + }, + "sourceAgentIdentity": { + "$ref": "#/definitions/IdentityProviderInput", + "description": "The identity provider input for source agent authentication." + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmFabricSpecificDetails": { + "description": "InMageRcm fabric specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificDetails" + } + ], + "properties": { + "vmwareSiteId": { + "description": "The ARM Id of the VMware site.", + "type": "string", + "readOnly": true + }, + "physicalSiteId": { + "description": "The ARM Id of the physical site.", + "type": "string", + "readOnly": true + }, + "serviceEndpoint": { + "description": "The service endpoint.", + "type": "string", + "readOnly": true + }, + "serviceResourceId": { + "description": "The service resource Id.", + "type": "string", + "readOnly": true + }, + "serviceContainerId": { + "description": "The service container Id.", + "type": "string", + "readOnly": true + }, + "dataPlaneUri": { + "description": "The data plane Uri.", + "type": "string", + "readOnly": true + }, + "controlPlaneUri": { + "description": "The control plane Uri.", + "type": "string", + "readOnly": true + }, + "sourceAgentIdentityDetails": { + "$ref": "#/definitions/IdentityProviderDetails", + "description": "The source agent identity details." + }, + "processServers": { + "description": "The list of process servers.", + "type": "array", + "items": { + "$ref": "#/definitions/ProcessServerDetails" + }, + "readOnly": true + }, + "rcmProxies": { + "description": "The list of RCM proxies.", + "type": "array", + "items": { + "$ref": "#/definitions/RcmProxyDetails" + }, + "readOnly": true + }, + "pushInstallers": { + "description": "The list of push installers.", + "type": "array", + "items": { + "$ref": "#/definitions/PushInstallerDetails" + }, + "readOnly": true + }, + "replicationAgents": { + "description": "The list of replication agents.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationAgentDetails" + }, + "readOnly": true + }, + "reprotectAgents": { + "description": "The list of reprotect agents.", + "type": "array", + "items": { + "$ref": "#/definitions/ReprotectAgentDetails" + }, + "readOnly": true + }, + "marsAgents": { + "description": "The list of Mars agents.", + "type": "array", + "items": { + "$ref": "#/definitions/MarsAgentDetails" + }, + "readOnly": true + }, + "dras": { + "description": "The list of DRAs.", + "type": "array", + "items": { + "$ref": "#/definitions/DraDetails" + }, + "readOnly": true + }, + "agentDetails": { + "description": "The list of agent details.", + "type": "array", + "items": { + "$ref": "#/definitions/AgentDetails" + }, + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmFailbackDiscoveredProtectedVmDetails": { + "description": "InMageRcmFailback discovered VM details.", + "type": "object", + "properties": { + "vCenterId": { + "description": "The VCenter Id.", + "type": "string", + "readOnly": true + }, + "vCenterFqdn": { + "description": "The VCenter fqdn.", + "type": "string", + "readOnly": true + }, + "datastores": { + "description": "The list of datastores.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "ipAddresses": { + "description": "The list of IP addresses.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "vmwareToolsStatus": { + "description": "The VMware tools status.", + "type": "string", + "readOnly": true + }, + "powerStatus": { + "description": "The VM power status.", + "type": "string", + "readOnly": true + }, + "vmFqdn": { + "description": "The VM fqdn.", + "type": "string", + "readOnly": true + }, + "osName": { + "description": "The VM's OS name.", + "type": "string", + "readOnly": true + }, + "createdTimestamp": { + "format": "date-time", + "description": "The SDS created timestamp.", + "type": "string", + "readOnly": true + }, + "updatedTimestamp": { + "format": "date-time", + "description": "The SDS updated timestamp.", + "type": "string", + "readOnly": true + }, + "isDeleted": { + "description": "A value indicating whether the VM is deleted.", + "type": "boolean", + "readOnly": true + }, + "lastDiscoveryTimeInUtc": { + "format": "date-time", + "description": "The last time when SDS information discovered in SRS.", + "type": "string", + "readOnly": true + } + } + }, + "InMageRcmFailbackEventDetails": { + "description": "Event details for InMageRcmFailback provider.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "protectedItemName": { + "description": "The protected item name.", + "type": "string", + "readOnly": true + }, + "vmName": { + "description": "The protected item name.", + "type": "string", + "readOnly": true + }, + "applianceName": { + "description": "The appliance name.", + "type": "string", + "readOnly": true + }, + "serverType": { + "description": "The server type.", + "type": "string", + "readOnly": true + }, + "componentDisplayName": { + "description": "The component display name.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageRcmFailback" + }, + "InMageRcmFailbackMobilityAgentDetails": { + "description": "InMageRcmFailback mobility agent details.", + "type": "object", + "properties": { + "version": { + "description": "The agent version.", + "type": "string", + "readOnly": true + }, + "latestVersion": { + "description": "The latest agent version available.", + "type": "string", + "readOnly": true + }, + "driverVersion": { + "description": "The driver version.", + "type": "string", + "readOnly": true + }, + "latestUpgradableVersionWithoutReboot": { + "description": "The latest upgradeable version available without reboot.", + "type": "string", + "readOnly": true + }, + "agentVersionExpiryDate": { + "format": "date-time", + "description": "The agent version expiry date.", + "type": "string", + "readOnly": true + }, + "driverVersionExpiryDate": { + "format": "date-time", + "description": "The driver version expiry date.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The time of the last heartbeat received from the agent.", + "type": "string", + "readOnly": true + }, + "reasonsBlockingUpgrade": { + "description": "The whether update is possible or not.", + "type": "array", + "items": { + "enum": [ + "AlreadyOnLatestVersion", + "RebootRequired", + "AgentNoHeartbeat", + "RcmProxyNoHeartbeat", + "ProcessServerNoHeartbeat", + "IncompatibleApplianceVersion", + "NotProtected", + "UnsupportedProtectionScenario", + "DistroIsNotReported", + "DistroNotSupportedForUpgrade", + "MissingUpgradePath", + "InvalidAgentVersion", + "InvalidDriverVersion", + "Unknown" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentUpgradeBlockedReason", + "modelAsString": true + } + }, + "readOnly": true + }, + "isUpgradeable": { + "description": "A value indicating whether agent is upgradeable or not.", + "type": "string", + "readOnly": true + } + } + }, + "InMageRcmFailbackNicDetails": { + "description": "InMageRcmFailback NIC details.", + "type": "object", + "properties": { + "macAddress": { + "description": "The mac address.", + "type": "string", + "readOnly": true + }, + "networkName": { + "description": "The network name.", + "type": "string", + "readOnly": true + }, + "adapterType": { + "description": "The adapter type.", + "type": "string", + "readOnly": true + }, + "sourceIpAddress": { + "description": "The IP address.", + "type": "string", + "readOnly": true + } + } + }, + "InMageRcmFailbackPlannedFailoverProviderInput": { + "description": "Provider specific input for InMageRcmFailback failover.", + "required": [ + "recoveryPointType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PlannedFailoverProviderSpecificFailoverInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "ApplicationConsistent", + "CrashConsistent" + ], + "type": "string", + "x-ms-enum": { + "name": "InMageRcmFailbackRecoveryPointType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "InMageRcmFailback" + }, + "InMageRcmFailbackPolicyCreationInput": { + "description": "InMageRcmFailback policy creation input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency (in minutes).", + "type": "integer" + } + }, + "x-ms-discriminator-value": "InMageRcmFailback" + }, + "InMageRcmFailbackPolicyDetails": { + "description": "InMageRcm failback specific policy details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency in minutes.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency in minutes.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "InMageRcmFailback" + }, + "InMageRcmFailbackProtectedDiskDetails": { + "description": "InMageRcmFailback protected disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id (reported by source agent).", + "type": "string", + "readOnly": true + }, + "diskName": { + "description": "The disk name.", + "type": "string", + "readOnly": true + }, + "isOSDisk": { + "description": "A value indicating whether the disk is the OS disk.", + "type": "string", + "readOnly": true + }, + "capacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer", + "readOnly": true + }, + "diskUuid": { + "description": "The disk Uuid (reported by vCenter).", + "type": "string", + "readOnly": true + }, + "dataPendingInLogDataStoreInMB": { + "format": "double", + "description": "The data pending in log data store in MB.", + "type": "number", + "readOnly": true + }, + "dataPendingAtSourceAgentInMB": { + "format": "double", + "description": "The data pending at source agent in MB.", + "type": "number", + "readOnly": true + }, + "isInitialReplicationComplete": { + "description": "A value indicating whether initial replication is complete or not.", + "type": "string", + "readOnly": true + }, + "irDetails": { + "$ref": "#/definitions/InMageRcmFailbackSyncDetails", + "description": "The initial replication details." + }, + "resyncDetails": { + "$ref": "#/definitions/InMageRcmFailbackSyncDetails", + "description": "The resync details." + }, + "lastSyncTime": { + "format": "date-time", + "description": "The last sync time.", + "type": "string", + "readOnly": true + } + } + }, + "InMageRcmFailbackReplicationDetails": { + "description": "InMageRcmFailback provider specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "internalIdentifier": { + "description": "The virtual machine internal identifier.", + "type": "string", + "readOnly": true + }, + "azureVirtualMachineId": { + "description": "The ARM Id of the azure VM.", + "type": "string", + "readOnly": true + }, + "multiVmGroupName": { + "description": "The multi VM group name.", + "type": "string", + "readOnly": true + }, + "reprotectAgentId": { + "description": "The reprotect agent Id.", + "type": "string", + "readOnly": true + }, + "reprotectAgentName": { + "description": "The reprotect agent name.", + "type": "string", + "readOnly": true + }, + "osType": { + "description": "The type of the OS on the VM.", + "type": "string", + "readOnly": true + }, + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string", + "readOnly": true + }, + "targetvCenterId": { + "description": "The target vCenter Id.", + "type": "string", + "readOnly": true + }, + "targetDataStoreName": { + "description": "The target datastore name.", + "type": "string", + "readOnly": true + }, + "targetVmName": { + "description": "The target VM name.", + "type": "string", + "readOnly": true + }, + "initialReplicationProgressPercentage": { + "format": "int32", + "description": "The initial replication progress percentage.", + "type": "integer", + "readOnly": true + }, + "initialReplicationProcessedBytes": { + "format": "int64", + "description": "The initial replication processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM.", + "type": "integer", + "readOnly": true + }, + "initialReplicationTransferredBytes": { + "format": "int64", + "description": "The initial replication transferred bytes from source VM to target for all selected disks on source VM.", + "type": "integer", + "readOnly": true + }, + "initialReplicationProgressHealth": { + "description": "The initial replication progress health.", + "enum": [ + "None", + "InProgress", + "SlowProgress", + "NoProgress" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VmReplicationProgressHealth", + "modelAsString": true + } + }, + "resyncProgressPercentage": { + "format": "int32", + "description": "The resync progress percentage.", + "type": "integer", + "readOnly": true + }, + "resyncProcessedBytes": { + "format": "int64", + "description": "The resync processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM.", + "type": "integer", + "readOnly": true + }, + "resyncTransferredBytes": { + "format": "int64", + "description": "The resync transferred bytes from source VM to target for all selected disks on source VM.", + "type": "integer", + "readOnly": true + }, + "resyncProgressHealth": { + "description": "The resync progress health.", + "enum": [ + "None", + "InProgress", + "SlowProgress", + "NoProgress" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VmReplicationProgressHealth", + "modelAsString": true + } + }, + "resyncRequired": { + "description": "A value indicating whether resync is required.", + "type": "string", + "readOnly": true + }, + "resyncState": { + "description": "The resync state.", + "enum": [ + "None", + "PreparedForResynchronization", + "StartedResynchronization" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ResyncState", + "modelAsString": true + } + }, + "protectedDisks": { + "description": "The list of protected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmFailbackProtectedDiskDetails" + } + }, + "mobilityAgentDetails": { + "$ref": "#/definitions/InMageRcmFailbackMobilityAgentDetails", + "description": "The mobility agent information." + }, + "vmNics": { + "description": "The network details.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmFailbackNicDetails" + } + }, + "lastPlannedFailoverStartTime": { + "format": "date-time", + "description": "The last planned failover start time.", + "type": "string", + "readOnly": true + }, + "lastPlannedFailoverStatus": { + "description": "The last planned failover status.", + "enum": [ + "Succeeded", + "Failed", + "Cancelled", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "PlannedFailoverStatus", + "modelAsString": true + } + }, + "discoveredVmDetails": { + "$ref": "#/definitions/InMageRcmFailbackDiscoveredProtectedVmDetails", + "description": "The discovered VM information." + }, + "lastUsedPolicyId": { + "description": "The policy Id used by the forward replication.", + "type": "string", + "readOnly": true + }, + "lastUsedPolicyFriendlyName": { + "description": "The policy friendly name used by the forward replication.", + "type": "string", + "readOnly": true + }, + "isAgentRegistrationSuccessfulAfterFailover": { + "description": "A value indicating whether agent registration was successful after failover.", + "type": "boolean", + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageRcmFailback" + }, + "InMageRcmFailbackReprotectInput": { + "description": "InMageRcmFailback specific provider input.", + "required": [ + "processServerId", + "policyId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReverseReplicationProviderSpecificInput" + } + ], + "properties": { + "processServerId": { + "description": "The process server Id.", + "type": "string" + }, + "runAsAccountId": { + "description": "The run as account Id.", + "type": "string" + }, + "policyId": { + "description": "The Policy Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcmFailback" + }, + "InMageRcmFailbackSyncDetails": { + "description": "InMageRcmFailback disk level sync details.", + "type": "object", + "properties": { + "progressHealth": { + "description": "The progress health.", + "enum": [ + "None", + "InProgress", + "SlowProgress", + "NoProgress", + "Queued" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DiskReplicationProgressHealth", + "modelAsString": true + } + }, + "transferredBytes": { + "format": "int64", + "description": "The transferred bytes from source VM to azure for the disk.", + "type": "integer", + "readOnly": true + }, + "last15MinutesTransferredBytes": { + "format": "int64", + "description": "The bytes transferred in last 15 minutes from source VM to target.", + "type": "integer", + "readOnly": true + }, + "lastDataTransferTimeUtc": { + "description": "The time of the last data transfer from source VM to target.", + "type": "string", + "readOnly": true + }, + "processedBytes": { + "format": "int64", + "description": "The total processed bytes. This includes bytes that are transferred from source VM to target and matched bytes.", + "type": "integer", + "readOnly": true + }, + "startTime": { + "description": "The start time.", + "type": "string", + "readOnly": true + }, + "lastRefreshTime": { + "description": "The last refresh time.", + "type": "string", + "readOnly": true + }, + "progressPercentage": { + "format": "int32", + "description": "Progress in percentage. Progress percentage is calculated based on processed bytes.", + "type": "integer", + "readOnly": true + } + } + }, + "InMageRcmLastAgentUpgradeErrorDetails": { + "description": "InMageRcm last source agent upgrade error details.", + "type": "object", + "properties": { + "errorCode": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "errorMessage": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "possibleCauses": { + "description": "The possible causes.", + "type": "string", + "readOnly": true + }, + "recommendedAction": { + "description": "The recommended action.", + "type": "string", + "readOnly": true + }, + "errorMessageParameters": { + "description": "The error message parameters.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "errorTags": { + "description": "The error tags.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + } + }, + "InMageRcmMobilityAgentDetails": { + "description": "InMageRcm mobility agent details.", + "type": "object", + "properties": { + "version": { + "description": "The agent version.", + "type": "string", + "readOnly": true + }, + "latestVersion": { + "description": "The latest agent version available.", + "type": "string", + "readOnly": true + }, + "latestAgentReleaseDate": { + "description": "The latest agent version release date.", + "type": "string", + "readOnly": true + }, + "driverVersion": { + "description": "The driver version.", + "type": "string", + "readOnly": true + }, + "latestUpgradableVersionWithoutReboot": { + "description": "The latest upgradeable version available without reboot.", + "type": "string", + "readOnly": true + }, + "agentVersionExpiryDate": { + "format": "date-time", + "description": "The agent version expiry date.", + "type": "string", + "readOnly": true + }, + "driverVersionExpiryDate": { + "format": "date-time", + "description": "The driver version expiry date.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The time of the last heartbeat received from the agent.", + "type": "string", + "readOnly": true + }, + "reasonsBlockingUpgrade": { + "description": "The whether update is possible or not.", + "type": "array", + "items": { + "enum": [ + "AlreadyOnLatestVersion", + "RebootRequired", + "AgentNoHeartbeat", + "RcmProxyNoHeartbeat", + "ProcessServerNoHeartbeat", + "IncompatibleApplianceVersion", + "NotProtected", + "UnsupportedProtectionScenario", + "DistroIsNotReported", + "DistroNotSupportedForUpgrade", + "MissingUpgradePath", + "InvalidAgentVersion", + "InvalidDriverVersion", + "Unknown" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentUpgradeBlockedReason", + "modelAsString": true + } + }, + "readOnly": true + }, + "isUpgradeable": { + "description": "A value indicating whether agent is upgradeable or not.", + "type": "string", + "readOnly": true + } + } + }, + "InMageRcmNicDetails": { + "description": "InMageRcm NIC details.", + "type": "object", + "properties": { + "nicId": { + "description": "The NIC Id.", + "type": "string", + "readOnly": true + }, + "isPrimaryNic": { + "description": "A value indicating whether this is the primary NIC.", + "type": "string" + }, + "isSelectedForFailover": { + "description": "A value indicating whether this NIC is selected for failover.", + "type": "string" + }, + "sourceIPAddress": { + "description": "The source IP address.", + "type": "string", + "readOnly": true + }, + "sourceIPAddressType": { + "description": "The source IP address type.", + "enum": [ + "Dynamic", + "Static" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "EthernetAddressType", + "modelAsString": true + } + }, + "sourceNetworkId": { + "description": "Source network Id.", + "type": "string", + "readOnly": true + }, + "sourceSubnetName": { + "description": "Source subnet name.", + "type": "string", + "readOnly": true + }, + "targetIPAddress": { + "description": "The target IP address.", + "type": "string" + }, + "targetIPAddressType": { + "description": "The target IP address type.", + "enum": [ + "Dynamic", + "Static" + ], + "type": "string", + "x-ms-enum": { + "name": "EthernetAddressType", + "modelAsString": true + } + }, + "targetSubnetName": { + "description": "Target subnet name.", + "type": "string" + }, + "testSubnetName": { + "description": "Test subnet name.", + "type": "string" + }, + "testIPAddress": { + "description": "The test IP address.", + "type": "string" + }, + "testIPAddressType": { + "description": "The test IP address type.", + "enum": [ + "Dynamic", + "Static" + ], + "type": "string", + "x-ms-enum": { + "name": "EthernetAddressType", + "modelAsString": true + } + } + } + }, + "InMageRcmNicInput": { + "description": "InMageRcm NIC input.", + "required": [ + "nicId", + "isPrimaryNic" + ], + "type": "object", + "properties": { + "nicId": { + "description": "The NIC Id.", + "type": "string" + }, + "isPrimaryNic": { + "description": "A value indicating whether this is the primary NIC.", + "type": "string" + }, + "isSelectedForFailover": { + "description": "A value indicating whether this NIC is selected for failover.", + "type": "string" + }, + "targetSubnetName": { + "description": "Target subnet name.", + "type": "string" + }, + "targetStaticIPAddress": { + "description": "The target static IP address.", + "type": "string" + }, + "testSubnetName": { + "description": "The test subnet name.", + "type": "string" + }, + "testStaticIPAddress": { + "description": "The test static IP address.", + "type": "string" + } + } + }, + "InMageRcmPolicyCreationInput": { + "description": "InMageRcm policy creation input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "recoveryPointHistoryInMinutes": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "enableMultiVmSync": { + "description": "A value indicating whether multi-VM sync has to be enabled.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmPolicyDetails": { + "description": "InMageRcm specific policy details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPointHistoryInMinutes": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency in minutes.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency in minutes.", + "type": "integer" + }, + "enableMultiVmSync": { + "description": "A value indicating whether multi-VM sync has to be enabled.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmProtectedDiskDetails": { + "description": "InMageRcm protected disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string", + "readOnly": true + }, + "diskName": { + "description": "The disk name.", + "type": "string", + "readOnly": true + }, + "isOSDisk": { + "description": "A value indicating whether the disk is the OS disk.", + "type": "string", + "readOnly": true + }, + "capacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer", + "readOnly": true + }, + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string", + "readOnly": true + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM Id.", + "type": "string", + "readOnly": true + }, + "seedManagedDiskId": { + "description": "The ARM Id of the seed managed disk.", + "type": "string", + "readOnly": true + }, + "targetManagedDiskId": { + "description": "The ARM Id of the target managed disk.", + "type": "string", + "readOnly": true + }, + "diskType": { + "description": "The disk type.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + }, + "dataPendingInLogDataStoreInMB": { + "format": "double", + "description": "The data pending in log data store in MB.", + "type": "number", + "readOnly": true + }, + "dataPendingAtSourceAgentInMB": { + "format": "double", + "description": "The data pending at source agent in MB.", + "type": "number", + "readOnly": true + }, + "isInitialReplicationComplete": { + "description": "A value indicating whether initial replication is complete or not.", + "type": "string", + "readOnly": true + }, + "irDetails": { + "$ref": "#/definitions/InMageRcmSyncDetails", + "description": "The initial replication details." + }, + "resyncDetails": { + "$ref": "#/definitions/InMageRcmSyncDetails", + "description": "The resync details." + } + } + }, + "InMageRcmProtectionContainerMappingDetails": { + "description": "InMageRcm provider specific container mapping details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionContainerMappingProviderSpecificDetails" + } + ], + "properties": { + "enableAgentAutoUpgrade": { + "description": "A value indicating whether the flag for enable agent auto upgrade.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmRecoveryPointDetails": { + "description": "InMageRcm provider specific recovery point details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProviderSpecificRecoveryPointDetails" + } + ], + "properties": { + "isMultiVmSyncPoint": { + "description": "A value indicating whether the recovery point is multi VM consistent.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmReplicationDetails": { + "description": "InMageRcm provider specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "internalIdentifier": { + "description": "The virtual machine internal identifier.", + "type": "string", + "readOnly": true + }, + "fabricDiscoveryMachineId": { + "description": "The ARM Id of the discovered VM.", + "type": "string", + "readOnly": true + }, + "multiVmGroupName": { + "description": "The multi VM group name.", + "type": "string", + "readOnly": true + }, + "discoveryType": { + "description": "The type of the discovered VM.", + "type": "string", + "readOnly": true + }, + "processServerId": { + "description": "The process server Id.", + "type": "string", + "readOnly": true + }, + "processorCoreCount": { + "format": "int32", + "description": "The processor core count.", + "type": "integer", + "readOnly": true + }, + "allocatedMemoryInMB": { + "format": "double", + "description": "The allocated memory in MB.", + "type": "number", + "readOnly": true + }, + "processServerName": { + "description": "The process server name.", + "type": "string", + "readOnly": true + }, + "runAsAccountId": { + "description": "The run-as account Id.", + "type": "string", + "readOnly": true + }, + "osType": { + "description": "The type of the OS on the VM.", + "type": "string", + "readOnly": true + }, + "firmwareType": { + "description": "The firmware type.", + "type": "string", + "readOnly": true + }, + "primaryNicIpAddress": { + "description": "The IP address of the primary network interface.", + "type": "string", + "readOnly": true + }, + "targetGeneration": { + "description": "The target generation.", + "type": "string", + "readOnly": true + }, + "licenseType": { + "description": "License Type of the VM to be used.", + "type": "string" + }, + "targetVmName": { + "description": "Target VM name.", + "type": "string" + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "targetResourceGroupId": { + "description": "The target resource group Id.", + "type": "string" + }, + "targetLocation": { + "description": "The target location.", + "type": "string" + }, + "targetAvailabilitySetId": { + "description": "The target availability set Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "targetBootDiagnosticsStorageAccountId": { + "description": "The target boot diagnostics storage account ARM Id.", + "type": "string" + }, + "targetNetworkId": { + "description": "The target network Id.", + "type": "string" + }, + "testNetworkId": { + "description": "The test network Id.", + "type": "string" + }, + "failoverRecoveryPointId": { + "description": "The recovery point Id to which the VM was failed over.", + "type": "string", + "readOnly": true + }, + "lastRecoveryPointReceived": { + "format": "date-time", + "description": "The last recovery point received time.", + "type": "string", + "readOnly": true + }, + "lastRpoInSeconds": { + "format": "int64", + "description": "The last recovery point objective value.", + "type": "integer", + "readOnly": true + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The last recovery point objective calculated time.", + "type": "string", + "readOnly": true + }, + "lastRecoveryPointId": { + "description": "The last recovery point Id.", + "type": "string", + "readOnly": true + }, + "initialReplicationProgressPercentage": { + "format": "int32", + "description": "The initial replication progress percentage. This is calculated based on total bytes processed for all disks in the source VM.", + "type": "integer", + "readOnly": true + }, + "initialReplicationProcessedBytes": { + "format": "int64", + "description": "The initial replication processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM.", + "type": "integer", + "readOnly": true + }, + "initialReplicationTransferredBytes": { + "format": "int64", + "description": "The initial replication transferred bytes from source VM to azure for all selected disks on source VM.", + "type": "integer", + "readOnly": true + }, + "initialReplicationProgressHealth": { + "description": "The initial replication progress health.", + "enum": [ + "None", + "InProgress", + "SlowProgress", + "NoProgress" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VmReplicationProgressHealth", + "modelAsString": true + } + }, + "resyncProgressPercentage": { + "format": "int32", + "description": "The resync progress percentage. This is calculated based on total bytes processed for all disks in the source VM.", + "type": "integer", + "readOnly": true + }, + "resyncProcessedBytes": { + "format": "int64", + "description": "The resync processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM.", + "type": "integer", + "readOnly": true + }, + "resyncTransferredBytes": { + "format": "int64", + "description": "The resync transferred bytes from source VM to azure for all selected disks on source VM.", + "type": "integer", + "readOnly": true + }, + "resyncProgressHealth": { + "description": "The resync progress health.", + "enum": [ + "None", + "InProgress", + "SlowProgress", + "NoProgress" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VmReplicationProgressHealth", + "modelAsString": true + } + }, + "resyncRequired": { + "description": "A value indicating whether resync is required.", + "type": "string", + "readOnly": true + }, + "resyncState": { + "description": "The resync state.", + "enum": [ + "None", + "PreparedForResynchronization", + "StartedResynchronization" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ResyncState", + "modelAsString": true + } + }, + "agentUpgradeState": { + "description": "The agent auto upgrade state.", + "enum": [ + "None", + "Started", + "Completed", + "Commit" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MobilityAgentUpgradeState", + "modelAsString": true + } + }, + "lastAgentUpgradeType": { + "description": "The last agent upgrade type.", + "type": "string", + "readOnly": true + }, + "agentUpgradeJobId": { + "description": "The agent upgrade job Id.", + "type": "string", + "readOnly": true + }, + "agentUpgradeAttemptToVersion": { + "description": "The agent version to which last agent upgrade was attempted.", + "type": "string", + "readOnly": true + }, + "protectedDisks": { + "description": "The list of protected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmProtectedDiskDetails" + } + }, + "isLastUpgradeSuccessful": { + "description": "A value indicating whether last agent upgrade was successful or not.", + "type": "string", + "readOnly": true + }, + "isAgentRegistrationSuccessfulAfterFailover": { + "description": "A value indicating whether agent registration was successful after failover.", + "type": "boolean", + "readOnly": true + }, + "mobilityAgentDetails": { + "$ref": "#/definitions/InMageRcmMobilityAgentDetails", + "description": "The mobility agent information." + }, + "lastAgentUpgradeErrorDetails": { + "description": "The last agent upgrade error information.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmLastAgentUpgradeErrorDetails" + } + }, + "agentUpgradeBlockingErrorDetails": { + "description": "The agent upgrade blocking error information.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmAgentUpgradeBlockingErrorDetails" + } + }, + "vmNics": { + "description": "The network details.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmNicDetails" + } + }, + "discoveredVmDetails": { + "$ref": "#/definitions/InMageRcmDiscoveredProtectedVmDetails", + "description": "The discovered VM details." + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmReprotectInput": { + "description": "InMageRcm specific provider input.", + "required": [ + "reprotectAgentId", + "datastoreName", + "logStorageAccountId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReverseReplicationProviderSpecificInput" + } + ], + "properties": { + "reprotectAgentId": { + "description": "The reprotect agent Id.", + "type": "string" + }, + "datastoreName": { + "description": "The target datastore name.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string" + }, + "policyId": { + "description": "The Policy Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmSyncDetails": { + "description": "InMageRcm disk level sync details.", + "type": "object", + "properties": { + "progressHealth": { + "description": "The progress health.", + "enum": [ + "None", + "InProgress", + "SlowProgress", + "NoProgress", + "Queued" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DiskReplicationProgressHealth", + "modelAsString": true + } + }, + "transferredBytes": { + "format": "int64", + "description": "The transferred bytes from source VM to azure for the disk.", + "type": "integer", + "readOnly": true + }, + "last15MinutesTransferredBytes": { + "format": "int64", + "description": "The bytes transferred in last 15 minutes from source VM to azure.", + "type": "integer", + "readOnly": true + }, + "lastDataTransferTimeUtc": { + "description": "The time of the last data transfer from source VM to azure.", + "type": "string", + "readOnly": true + }, + "processedBytes": { + "format": "int64", + "description": "The total processed bytes. This includes bytes that are transferred from source VM to azure and matched bytes.", + "type": "integer", + "readOnly": true + }, + "startTime": { + "description": "The start time.", + "type": "string", + "readOnly": true + }, + "lastRefreshTime": { + "description": "The last refresh time.", + "type": "string", + "readOnly": true + }, + "progressPercentage": { + "format": "int32", + "description": "Progress in percentage. Progress percentage is calculated based on processed bytes.", + "type": "integer", + "readOnly": true + } + } + }, + "InMageRcmTestFailoverInput": { + "description": "InMageRcm provider specific input for test failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TestFailoverProviderSpecificInput" + } + ], + "properties": { + "networkId": { + "description": "The test network Id.", + "type": "string" + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to test failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmUnplannedFailoverInput": { + "description": "InMageRcm provider specific input for unplanned failover.", + "required": [ + "performShutdown" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput" + } + ], + "properties": { + "performShutdown": { + "description": "A value indicating whether VM is to be shutdown.", + "type": "string" + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmUpdateApplianceForReplicationProtectedItemInput": { + "description": "InMageRcm provider specific input to update appliance for replication protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UpdateApplianceForReplicationProtectedItemProviderSpecificInput" + } + ], + "properties": { + "runAsAccountId": { + "description": "The run as account Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmUpdateContainerMappingInput": { + "description": "InMageRcm update protection container mapping.", + "required": [ + "enableAgentAutoUpgrade" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificUpdateContainerMappingInput" + } + ], + "properties": { + "enableAgentAutoUpgrade": { + "description": "A value indicating whether agent auto upgrade has to be enabled.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmUpdateReplicationProtectedItemInput": { + "description": "InMageRcm provider specific input to update replication protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UpdateReplicationProtectedItemProviderInput" + } + ], + "properties": { + "targetVmName": { + "description": "The target VM name.", + "type": "string" + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "targetResourceGroupId": { + "description": "The target resource group ARM Id.", + "type": "string" + }, + "targetAvailabilitySetId": { + "description": "The target availability set ARM Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "targetBootDiagnosticsStorageAccountId": { + "description": "The target boot diagnostics storage account ARM Id.", + "type": "string" + }, + "targetNetworkId": { + "description": "The target network ARM Id.", + "type": "string" + }, + "testNetworkId": { + "description": "The test network ARM Id.", + "type": "string" + }, + "vmNics": { + "description": "The list of NIC details.", + "minLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmNicInput" + } + }, + "licenseType": { + "description": "The license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageReplicationDetails": { + "description": "InMage provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "activeSiteType": { + "description": "The active location of the VM. If the VM is being protected from Azure, this field will take values from { Azure, OnPrem }. If the VM is being protected between two data-centers, this field will be OnPrem always.", + "type": "string" + }, + "sourceVmCpuCount": { + "format": "int32", + "description": "The CPU count of the VM on the primary side.", + "type": "integer" + }, + "sourceVmRamSizeInMB": { + "format": "int32", + "description": "The RAM size of the VM on the primary side.", + "type": "integer" + }, + "osDetails": { + "$ref": "#/definitions/OSDiskDetails", + "description": "The OS details." + }, + "protectionStage": { + "description": "The protection stage.", + "type": "string" + }, + "vmId": { + "description": "The virtual machine Id.", + "type": "string" + }, + "vmProtectionState": { + "description": "The protection state for the vm.", + "type": "string" + }, + "vmProtectionStateDescription": { + "description": "The protection state description for the vm.", + "type": "string" + }, + "resyncDetails": { + "$ref": "#/definitions/InitialReplicationDetails", + "description": "The resync details of the machine." + }, + "retentionWindowStart": { + "format": "date-time", + "description": "The retention window start time.", + "type": "string" + }, + "retentionWindowEnd": { + "format": "date-time", + "description": "The retention window end time.", + "type": "string" + }, + "compressedDataRateInMB": { + "format": "double", + "description": "The compressed data change rate in MB.", + "type": "number" + }, + "uncompressedDataRateInMB": { + "format": "double", + "description": "The uncompressed data change rate in MB.", + "type": "number" + }, + "rpoInSeconds": { + "format": "int64", + "description": "The RPO in seconds.", + "type": "integer" + }, + "protectedDisks": { + "description": "The list of protected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageProtectedDiskDetails" + } + }, + "ipAddress": { + "description": "The source IP address.", + "type": "string" + }, + "lastHeartbeat": { + "format": "date-time", + "description": "The last heartbeat received from the source server.", + "type": "string" + }, + "processServerId": { + "description": "The process server Id.", + "type": "string" + }, + "masterTargetId": { + "description": "The master target Id.", + "type": "string" + }, + "consistencyPoints": { + "description": "The collection of Consistency points.", + "type": "object", + "additionalProperties": { + "format": "date-time", + "type": "string" + } + }, + "diskResized": { + "description": "A value indicating whether any disk is resized for this VM.", + "type": "string" + }, + "rebootAfterUpdateStatus": { + "description": "A value indicating whether the source server requires a restart after update.", + "type": "string" + }, + "multiVmGroupId": { + "description": "The multi vm group Id, if any.", + "type": "string" + }, + "multiVmGroupName": { + "description": "The multi vm group name, if any.", + "type": "string" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether the multi vm sync is enabled or disabled.", + "type": "string" + }, + "agentDetails": { + "$ref": "#/definitions/InMageAgentDetails", + "description": "The agent details." + }, + "vCenterInfrastructureId": { + "description": "The vCenter infrastructure Id.", + "type": "string" + }, + "infrastructureVmId": { + "description": "The infrastructure VM Id.", + "type": "string" + }, + "vmNics": { + "description": "The PE Network details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicDetails" + } + }, + "discoveryType": { + "description": "A value indicating the discovery type of the machine.", + "type": "string" + }, + "azureStorageAccountId": { + "description": "A value indicating the underlying Azure storage account. If the VM is not running in Azure, this value shall be set to null.", + "type": "string" + }, + "datastores": { + "description": "The datastores of the on-premise machine Value can be list of strings that contain datastore names.", + "type": "array", + "items": { + "type": "string" + } + }, + "validationErrors": { + "description": "The validation errors of the on-premise machine Value can be list of validation errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The last RPO calculated time.", + "type": "string" + }, + "lastUpdateReceivedTime": { + "format": "date-time", + "description": "The last update time received from on-prem components.", + "type": "string" + }, + "replicaId": { + "description": "The replica id of the protected item.", + "type": "string" + }, + "osVersion": { + "description": "The OS Version of the protected item.", + "type": "string" + }, + "isAdditionalStatsAvailable": { + "description": "A value indicating whether additional IR stats are available or not.", + "type": "boolean" + }, + "totalDataTransferred": { + "format": "int64", + "description": "The total transferred data in bytes.", + "type": "integer" + }, + "totalProgressHealth": { + "description": "The progress health.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMageReprotectInput": { + "description": "InMageAzureV2 specific provider input.", + "required": [ + "masterTargetId", + "processServerId", + "retentionDrive", + "profileId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReverseReplicationProviderSpecificInput" + } + ], + "properties": { + "masterTargetId": { + "description": "The Master Target Id.", + "type": "string" + }, + "processServerId": { + "description": "The Process Server Id.", + "type": "string" + }, + "retentionDrive": { + "description": "The retention drive to use on the MT.", + "type": "string" + }, + "runAsAccountId": { + "description": "The CS account Id.", + "type": "string" + }, + "datastoreName": { + "description": "The target datastore name.", + "type": "string" + }, + "diskExclusionInput": { + "$ref": "#/definitions/InMageDiskExclusionInput", + "description": "The enable disk exclusion input." + }, + "profileId": { + "description": "The Policy Id.", + "type": "string" + }, + "disksToInclude": { + "description": "The disks to include list.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMageTestFailoverInput": { + "description": "Provider specific input for InMage test failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TestFailoverProviderSpecificInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type. Values from LatestTime, LatestTag or Custom. In the case of custom, the recovery point provided by RecoveryPointId will be used. In the other two cases, recovery point id will be ignored.", + "enum": [ + "LatestTime", + "LatestTag", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPointType", + "modelAsString": true + } + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to test failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMageUnplannedFailoverInput": { + "description": "Provider specific input for InMage unplanned failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type. Values from LatestTime, LatestTag or Custom. In the case of custom, the recovery point provided by RecoveryPointId will be used. In the other two cases, recovery point id will be ignored.", + "enum": [ + "LatestTime", + "LatestTag", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPointType", + "modelAsString": true + } + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMageVolumeExclusionOptions": { + "description": "Guest disk signature based disk exclusion option when doing enable protection of virtual machine in InMage provider.", + "type": "object", + "properties": { + "volumeLabel": { + "description": "The volume label. The disk having any volume with this label will be excluded from replication.", + "type": "string" + }, + "onlyExcludeIfSingleVolume": { + "description": "The value indicating whether to exclude multi volume disk or not. If a disk has multiple volumes and one of the volume has label matching with VolumeLabel this disk will be excluded from replication if OnlyExcludeIfSingleVolume is false.", + "type": "string" + } + } + }, + "InnerHealthError": { + "description": "Implements InnerHealthError class. HealthError object has a list of InnerHealthErrors as child errors. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException.", + "type": "object", + "properties": { + "errorSource": { + "description": "Source of error.", + "type": "string" + }, + "errorType": { + "description": "Type of error.", + "type": "string" + }, + "errorLevel": { + "description": "Level of error.", + "type": "string" + }, + "errorCategory": { + "description": "Category of error.", + "type": "string" + }, + "errorCode": { + "description": "Error code.", + "type": "string" + }, + "summaryMessage": { + "description": "Summary message of the entity.", + "type": "string" + }, + "errorMessage": { + "description": "Error message.", + "type": "string" + }, + "possibleCauses": { + "description": "Possible causes of error.", + "type": "string" + }, + "recommendedAction": { + "description": "Recommended action to resolve error.", + "type": "string" + }, + "creationTimeUtc": { + "format": "date-time", + "description": "Error creation time (UTC).", + "type": "string" + }, + "recoveryProviderErrorMessage": { + "description": "DRA error message.", + "type": "string" + }, + "entityId": { + "description": "ID of the entity.", + "type": "string" + }, + "errorId": { + "description": "The health error unique id.", + "type": "string" + }, + "customerResolvability": { + "description": "Value indicating whether the health error is customer resolvable.", + "enum": [ + "Allowed", + "NotAllowed" + ], + "type": "string", + "x-ms-enum": { + "name": "HealthErrorCustomerResolvability", + "modelAsString": true + } + } + } + }, + "InputEndpoint": { + "type": "object", + "properties": { + "endpointName": { + "type": "string" + }, + "privatePort": { + "format": "int32", + "type": "integer" + }, + "publicPort": { + "format": "int32", + "type": "integer" + }, + "protocol": { + "type": "string" + } + } + }, + "Job": { + "description": "Job details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "The custom data." + } + } + }, + "JobCollection": { + "description": "Collection of jobs.", + "type": "object", + "properties": { + "value": { + "description": "The list of jobs.", + "type": "array", + "items": { + "$ref": "#/definitions/Job" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "JobDetails": { + "description": "Job details based on specific job type.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the type of job details (see JobDetailsTypes enum for possible values).", + "type": "string" + }, + "affectedObjectDetails": { + "description": "The affected object properties like source server, source cloud, target server, target cloud etc. based on the workflow object details.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "discriminator": "instanceType" + }, + "JobEntity": { + "description": "This class contains the minimal job details required to navigate to the desired drill down.", + "type": "object", + "properties": { + "jobId": { + "description": "The job id.", + "type": "string" + }, + "jobFriendlyName": { + "description": "The job display name.", + "type": "string" + }, + "targetObjectId": { + "description": "The object id.", + "type": "string" + }, + "targetObjectName": { + "description": "The object name.", + "type": "string" + }, + "targetInstanceType": { + "description": "The workflow affected object type.", + "type": "string" + }, + "jobScenarioName": { + "description": "The job name. Enum type ScenarioName.", + "type": "string" + } + } + }, + "JobErrorDetails": { + "description": "This class contains the error details per object.", + "type": "object", + "properties": { + "serviceErrorDetails": { + "$ref": "#/definitions/ServiceError", + "description": "The Service error details." + }, + "providerErrorDetails": { + "$ref": "#/definitions/ProviderError", + "description": "The Provider error details." + }, + "errorLevel": { + "description": "Error level of error.", + "type": "string" + }, + "creationTime": { + "format": "date-time", + "description": "The creation time of job error.", + "type": "string" + }, + "taskId": { + "description": "The Id of the task.", + "type": "string" + } + } + }, + "JobProperties": { + "description": "Job custom data details.", + "type": "object", + "properties": { + "activityId": { + "description": "The activity id.", + "type": "string" + }, + "scenarioName": { + "description": "The ScenarioName.", + "type": "string" + }, + "friendlyName": { + "description": "The DisplayName.", + "type": "string" + }, + "state": { + "description": "The status of the Job. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other.", + "type": "string" + }, + "stateDescription": { + "description": "The description of the state of the Job. For e.g. - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped.", + "type": "string" + }, + "tasks": { + "description": "The tasks.", + "type": "array", + "items": { + "$ref": "#/definitions/ASRTask" + } + }, + "errors": { + "description": "The errors.", + "type": "array", + "items": { + "$ref": "#/definitions/JobErrorDetails" + } + }, + "startTime": { + "format": "date-time", + "description": "The start time.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "The end time.", + "type": "string" + }, + "allowedActions": { + "description": "The Allowed action the job.", + "type": "array", + "items": { + "type": "string" + } + }, + "targetObjectId": { + "description": "The affected Object Id.", + "type": "string" + }, + "targetObjectName": { + "description": "The name of the affected object.", + "type": "string" + }, + "targetInstanceType": { + "description": "The type of the affected object which is of Microsoft.Azure.SiteRecovery.V2015_11_10.AffectedObjectType class.", + "type": "string" + }, + "customDetails": { + "$ref": "#/definitions/JobDetails", + "description": "The custom job details like test failover job details." + } + } + }, + "JobQueryParameter": { + "description": "Query parameter to enumerate jobs.", + "type": "object", + "properties": { + "startTime": { + "description": "Date time to get jobs from.", + "type": "string" + }, + "endTime": { + "description": "Date time to get jobs upto.", + "type": "string" + }, + "fabricId": { + "description": "The Id of the fabric to search jobs under.", + "type": "string" + }, + "affectedObjectTypes": { + "description": "The type of objects.", + "type": "string" + }, + "jobStatus": { + "description": "The states of the job to be filtered can be in.", + "type": "string" + }, + "jobOutputType": { + "description": "The output type of the jobs.", + "enum": [ + "Json", + "Xml", + "Excel" + ], + "type": "string", + "x-ms-enum": { + "name": "ExportJobOutputSerializationType", + "modelAsString": true + } + }, + "jobName": { + "description": "The job Name.", + "type": "string" + }, + "timezoneOffset": { + "format": "double", + "description": "The timezone offset for the location of the request (in minutes).", + "type": "number" + } + } + }, + "JobStatusEventDetails": { + "description": "Model class for event details of a job status event.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventSpecificDetails" + } + ], + "properties": { + "jobId": { + "description": "Job arm id for the event.", + "type": "string" + }, + "jobFriendlyName": { + "description": "JobName for the Event.", + "type": "string" + }, + "jobStatus": { + "description": "JobStatus for the Event.", + "type": "string" + }, + "affectedObjectType": { + "description": "AffectedObjectType for the event.", + "type": "string" + } + }, + "x-ms-discriminator-value": "JobStatus" + }, + "JobTaskDetails": { + "description": "This class represents a task which is actually a workflow so that one can navigate to its individual drill down.", + "required": [ + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskTypeDetails" + } + ], + "properties": { + "jobTask": { + "$ref": "#/definitions/JobEntity", + "description": "The job entity." + } + }, + "discriminator": "instanceType", + "x-ms-discriminator-value": "JobTaskDetails" + }, + "KeyEncryptionKeyInfo": { + "description": "Key Encryption Key (KEK) information.", + "type": "object", + "properties": { + "keyIdentifier": { + "description": "The key URL / identifier.", + "type": "string" + }, + "keyVaultResourceArmId": { + "description": "The KeyVault resource ARM Id for key.", + "type": "string" + } + } + }, + "LogicalNetwork": { + "description": "Logical network data model.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/LogicalNetworkProperties", + "description": "The Logical Network Properties." + } + } + }, + "LogicalNetworkCollection": { + "description": "List of logical networks.", + "type": "object", + "properties": { + "value": { + "description": "The Logical Networks list details.", + "type": "array", + "items": { + "$ref": "#/definitions/LogicalNetwork" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "LogicalNetworkProperties": { + "description": "Logical Network Properties.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The Friendly Name.", + "type": "string" + }, + "networkVirtualizationStatus": { + "description": "A value indicating whether Network Virtualization is enabled for the logical network.", + "type": "string" + }, + "logicalNetworkUsage": { + "description": "A value indicating whether logical network is used as private test network by test failover.", + "type": "string" + }, + "logicalNetworkDefinitionsStatus": { + "description": "A value indicating whether logical network definitions are isolated.", + "type": "string" + } + } + }, + "ManualActionTaskDetails": { + "description": "This class represents the manual action task details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskTypeDetails" + } + ], + "properties": { + "name": { + "description": "The name.", + "type": "string" + }, + "instructions": { + "description": "The instructions.", + "type": "string" + }, + "observation": { + "description": "The observation.", + "type": "string" + } + }, + "x-ms-discriminator-value": "ManualActionTaskDetails" + }, + "MarsAgentDetails": { + "description": "Mars agent details.", + "type": "object", + "properties": { + "id": { + "description": "The Mars agent Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The Mars agent name.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The Mars agent Bios Id.", + "type": "string", + "readOnly": true + }, + "fabricObjectId": { + "description": "The fabric object Id.", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "The Mars agent Fqdn.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the Mars agent.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The health of the Mars agent.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + } + } + }, + "MasterTargetServer": { + "description": "Details of a Master Target Server.", + "type": "object", + "properties": { + "id": { + "description": "The server Id.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address of the server.", + "type": "string" + }, + "name": { + "description": "The server name.", + "type": "string" + }, + "osType": { + "description": "The OS type of the server.", + "type": "string" + }, + "agentVersion": { + "description": "The version of the scout component on the server.", + "type": "string" + }, + "lastHeartbeat": { + "format": "date-time", + "description": "The last heartbeat received from the server.", + "type": "string" + }, + "versionStatus": { + "description": "Version status.", + "type": "string" + }, + "retentionVolumes": { + "description": "The retention volumes of Master target Server.", + "type": "array", + "items": { + "$ref": "#/definitions/RetentionVolume" + } + }, + "dataStores": { + "description": "The list of data stores in the fabric.", + "type": "array", + "items": { + "$ref": "#/definitions/DataStore" + } + }, + "validationErrors": { + "description": "Validation errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "healthErrors": { + "description": "Health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "diskCount": { + "format": "int32", + "description": "Disk count of the master target.", + "type": "integer" + }, + "osVersion": { + "description": "OS Version of the master target.", + "type": "string" + }, + "agentExpiryDate": { + "format": "date-time", + "description": "Agent expiry date.", + "type": "string" + }, + "marsAgentVersion": { + "description": "MARS agent version.", + "type": "string" + }, + "marsAgentExpiryDate": { + "format": "date-time", + "description": "MARS agent expiry date.", + "type": "string" + }, + "agentVersionDetails": { + "$ref": "#/definitions/VersionDetails", + "description": "Agent version details." + }, + "marsAgentVersionDetails": { + "$ref": "#/definitions/VersionDetails", + "description": "Mars agent version details." + } + } + }, + "MigrateInput": { + "description": "Input for migrate.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/MigrateInputProperties", + "description": "Migrate input properties." + } + } + }, + "MigrateInputProperties": { + "description": "Migrate input properties.", + "required": [ + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/MigrateProviderSpecificInput", + "description": "The provider specific details." + } + } + }, + "MigrateProviderSpecificInput": { + "description": "Migrate provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "MigrationItem": { + "description": "Migration item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MigrationItemProperties", + "description": "The migration item properties." + } + } + }, + "MigrationItemCollection": { + "description": "Migration item collection.", + "type": "object", + "properties": { + "value": { + "description": "The list of migration items.", + "type": "array", + "items": { + "$ref": "#/definitions/MigrationItem" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "MigrationItemProperties": { + "description": "Migration item properties.", + "type": "object", + "properties": { + "machineName": { + "description": "The on-premise virtual machine name.", + "type": "string", + "readOnly": true + }, + "policyId": { + "description": "The ARM Id of policy governing this item.", + "type": "string", + "readOnly": true + }, + "policyFriendlyName": { + "description": "The name of policy governing this item.", + "type": "string", + "readOnly": true + }, + "migrationState": { + "description": "The migration status.", + "enum": [ + "None", + "EnableMigrationInProgress", + "EnableMigrationFailed", + "DisableMigrationInProgress", + "DisableMigrationFailed", + "InitialSeedingInProgress", + "InitialSeedingFailed", + "Replicating", + "MigrationInProgress", + "MigrationSucceeded", + "MigrationFailed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MigrationState", + "modelAsString": true + } + }, + "migrationStateDescription": { + "description": "The migration state description.", + "type": "string", + "readOnly": true + }, + "lastTestMigrationTime": { + "format": "date-time", + "description": "The last test migration time.", + "type": "string", + "readOnly": true + }, + "lastTestMigrationStatus": { + "description": "The status of the last test migration.", + "type": "string", + "readOnly": true + }, + "testMigrateState": { + "description": "The test migrate state.", + "enum": [ + "None", + "TestMigrationInProgress", + "TestMigrationSucceeded", + "TestMigrationFailed", + "TestMigrationCleanupInProgress" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "TestMigrationState", + "modelAsString": true + } + }, + "testMigrateStateDescription": { + "description": "The test migrate state description.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The consolidated health.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The list of health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + }, + "allowedOperations": { + "description": "The allowed operations on the migration item based on the current migration state of the item.", + "type": "array", + "items": { + "enum": [ + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup", + "Migrate", + "StartResync" + ], + "type": "string", + "x-ms-enum": { + "name": "MigrationItemOperation", + "modelAsString": true + } + }, + "readOnly": true + }, + "currentJob": { + "$ref": "#/definitions/CurrentJobDetails", + "description": "The current job details.", + "readOnly": true + }, + "eventCorrelationId": { + "description": "The correlation Id for events associated with this migration item.", + "type": "string", + "readOnly": true + }, + "providerSpecificDetails": { + "$ref": "#/definitions/MigrationProviderSpecificSettings", + "description": "The migration provider custom settings." + } + } + }, + "MigrationItemsQueryParameter": { + "description": "Query parameter to enumerate migration items.", + "type": "object", + "properties": { + "sourceFabricName": { + "description": "The source fabric name filter.", + "type": "string" + }, + "sourceContainerName": { + "description": "The source container name filter.", + "type": "string" + }, + "instanceType": { + "description": "The replication provider type.", + "type": "string" + } + } + }, + "MigrationProviderSpecificSettings": { + "description": "Migration provider specific settings.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "MigrationRecoveryPoint": { + "description": "Recovery point for a migration item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MigrationRecoveryPointProperties", + "description": "Recovery point properties." + } + } + }, + "MigrationRecoveryPointCollection": { + "description": "Collection of migration recovery points.", + "type": "object", + "properties": { + "value": { + "description": "The migration recovery point details.", + "type": "array", + "items": { + "$ref": "#/definitions/MigrationRecoveryPoint" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "MigrationRecoveryPointProperties": { + "description": "Migration item recovery point properties.", + "type": "object", + "properties": { + "recoveryPointTime": { + "format": "date-time", + "description": "The recovery point time.", + "type": "string", + "readOnly": true + }, + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "NotSpecified", + "ApplicationConsistent", + "CrashConsistent" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MigrationRecoveryPointType", + "modelAsString": true + } + } + } + }, + "MobilityServiceUpdate": { + "description": "The Mobility Service update details.", + "type": "object", + "properties": { + "version": { + "description": "The version of the latest update.", + "type": "string" + }, + "rebootStatus": { + "description": "The reboot status of the update - whether it is required or not.", + "type": "string" + }, + "osType": { + "description": "The OS type.", + "type": "string" + } + } + }, + "Network": { + "description": "Network model.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/NetworkProperties", + "description": "The Network Properties." + } + } + }, + "NetworkCollection": { + "description": "List of networks.", + "type": "object", + "properties": { + "value": { + "description": "The Networks list details.", + "type": "array", + "items": { + "$ref": "#/definitions/Network" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "NetworkMapping": { + "description": "Network Mapping model. Ideally it should have been possible to inherit this class from prev version in InheritedModels as long as there is no difference in structure or method signature. Since there were no base Models for certain fields and methods viz NetworkMappingProperties and Load with required return type, the class has been introduced in its entirety with references to base models to facilitate extensions in subsequent versions.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/NetworkMappingProperties", + "description": "The Network Mapping Properties." + } + } + }, + "NetworkMappingCollection": { + "description": "List of network mappings. As with NetworkMapping, it should be possible to reuse a prev version of this class. It doesn't seem likely this class could be anything more than a slightly bespoke collection of NetworkMapping. Hence it makes sense to override Load with Base.NetworkMapping instead of existing CurrentVersion.NetworkMapping.", + "type": "object", + "properties": { + "value": { + "description": "The Network Mappings list.", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkMapping" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "NetworkMappingFabricSpecificSettings": { + "description": "Network Mapping fabric specific settings.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the Instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "NetworkMappingProperties": { + "description": "Network Mapping Properties.", + "type": "object", + "properties": { + "state": { + "description": "The pairing state for network mapping.", + "type": "string" + }, + "primaryNetworkFriendlyName": { + "description": "The primary network friendly name.", + "type": "string" + }, + "primaryNetworkId": { + "description": "The primary network id for network mapping.", + "type": "string" + }, + "primaryFabricFriendlyName": { + "description": "The primary fabric friendly name.", + "type": "string" + }, + "recoveryNetworkFriendlyName": { + "description": "The recovery network friendly name.", + "type": "string" + }, + "recoveryNetworkId": { + "description": "The recovery network id for network mapping.", + "type": "string" + }, + "recoveryFabricArmId": { + "description": "The recovery fabric ARM id.", + "type": "string" + }, + "recoveryFabricFriendlyName": { + "description": "The recovery fabric friendly name.", + "type": "string" + }, + "fabricSpecificSettings": { + "$ref": "#/definitions/NetworkMappingFabricSpecificSettings", + "description": "The fabric specific settings." + } + } + }, + "NetworkProperties": { + "description": "Network Properties.", + "type": "object", + "properties": { + "fabricType": { + "description": "The Fabric Type.", + "type": "string" + }, + "subnets": { + "description": "The List of subnets.", + "type": "array", + "items": { + "$ref": "#/definitions/Subnet" + } + }, + "friendlyName": { + "description": "The Friendly Name.", + "type": "string" + }, + "networkType": { + "description": "The Network Type.", + "type": "string" + } + } + }, + "NewProtectionProfile": { + "description": "New Protection profile input.", + "required": [ + "policyName", + "multiVmSyncStatus" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionProfileCustomDetails" + } + ], + "properties": { + "policyName": { + "description": "The protection profile input.", + "type": "string" + }, + "recoveryPointHistory": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "multiVmSyncStatus": { + "description": "A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'.", + "enum": [ + "Enable", + "Disable" + ], + "type": "string", + "x-ms-enum": { + "name": "SetMultiVmSyncStatus", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "New" + }, + "NewRecoveryVirtualNetwork": { + "description": "Recovery virtual network input to create new virtual network from given source network.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryVirtualNetworkCustomDetails" + } + ], + "properties": { + "recoveryVirtualNetworkResourceGroupName": { + "description": "The name of the resource group to be used to create the recovery virtual network. If absent, target network would be created in the same resource group as target VM.", + "type": "string" + }, + "recoveryVirtualNetworkName": { + "description": "The recovery virtual network name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "New" + }, + "OperationsDiscovery": { + "description": "Operations discovery class.", + "type": "object", + "properties": { + "name": { + "description": "Name of the API. The name of the operation being performed on this particular object. It should match the action name that appears in RBAC / the event service. Examples of operations include: * Microsoft.Compute/virtualMachine/capture/action * Microsoft.Compute/virtualMachine/restart/action * Microsoft.Compute/virtualMachine/write * Microsoft.Compute/virtualMachine/read * Microsoft.Compute/virtualMachine/delete Each action should include, in order: (1) Resource Provider Namespace (2) Type hierarchy for which the action applies (e.g. server/databases for a SQL Azure database) (3) Read, Write, Action or Delete indicating which type applies. If it is a PUT/PATCH on a collection or named value, Write should be used. If it is a GET, Read should be used. If it is a DELETE, Delete should be used. If it is a POST, Action should be used. As a note: all resource providers would need to include the \"{Resource Provider Namespace}/register/action\" operation in their response. This API is used to register for their service, and should include details about the operation (e.g. a localized name for the resource provider + any special considerations like PII release).", + "type": "string" + }, + "display": { + "$ref": "#/definitions/Display", + "description": "Object type." + }, + "origin": { + "description": "Origin. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX. Default value is \"user,system\".", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/OperationsDiscoveryProperties", + "description": "Properties. Reserved for future use." + } + } + }, + "OperationsDiscoveryCollection": { + "description": "Collection of ClientDiscovery details.", + "type": "object", + "properties": { + "value": { + "description": "The ClientDiscovery details.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationsDiscovery" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "OperationsDiscoveryProperties": { + "description": "ClientDiscovery properties.", + "type": "object", + "properties": {} + }, + "OSDetails": { + "description": "Disk Details.", + "type": "object", + "properties": { + "osType": { + "description": "VM Disk details.", + "type": "string" + }, + "productType": { + "description": "Product type.", + "type": "string" + }, + "osEdition": { + "description": "The OSEdition.", + "type": "string" + }, + "oSVersion": { + "description": "The OS Version.", + "type": "string" + }, + "oSMajorVersion": { + "description": "The OS Major Version.", + "type": "string" + }, + "oSMinorVersion": { + "description": "The OS Minor Version.", + "type": "string" + } + } + }, + "OSDiskDetails": { + "description": "Details of the OS Disk.", + "type": "object", + "properties": { + "osVhdId": { + "description": "The id of the disk containing the OS.", + "type": "string" + }, + "osType": { + "description": "The type of the OS on the VM.", + "type": "string" + }, + "vhdName": { + "description": "The OS disk VHD name.", + "type": "string" + } + } + }, + "OSVersionWrapper": { + "description": "Wrapper model for OSVersion to include version and service pack info.", + "type": "object", + "properties": { + "version": { + "description": "The version.", + "type": "string" + }, + "servicePack": { + "description": "The service pack.", + "type": "string" + } + } + }, + "PlannedFailoverInput": { + "description": "Input definition for planned failover.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PlannedFailoverInputProperties", + "description": "Planned failover input properties." + } + } + }, + "PlannedFailoverInputProperties": { + "description": "Input definition for planned failover input properties.", + "type": "object", + "properties": { + "failoverDirection": { + "description": "Failover direction.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/PlannedFailoverProviderSpecificFailoverInput", + "description": "Provider specific settings." + } + } + }, + "PlannedFailoverProviderSpecificFailoverInput": { + "description": "Provider specific failover input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "Policy": { + "description": "Protection profile details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PolicyProperties", + "description": "The custom data." + } + } + }, + "PolicyCollection": { + "description": "Protection Profile Collection details.", + "type": "object", + "properties": { + "value": { + "description": "The policy details.", + "type": "array", + "items": { + "$ref": "#/definitions/Policy" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "PolicyProperties": { + "description": "Protection profile custom data details.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The FriendlyName.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/PolicyProviderSpecificDetails", + "description": "The ReplicationChannelSetting." + } + } + }, + "PolicyProviderSpecificDetails": { + "description": "Base class for Provider specific details for policies.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type. Overridden in derived classes.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "PolicyProviderSpecificInput": { + "description": "Base class for provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ProcessServer": { + "description": "Details of the Process Server.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The Process Server's friendly name.", + "type": "string" + }, + "id": { + "description": "The Process Server Id.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address of the server.", + "type": "string" + }, + "osType": { + "description": "The OS type of the server.", + "type": "string" + }, + "agentVersion": { + "description": "The version of the scout component on the server.", + "type": "string" + }, + "lastHeartbeat": { + "format": "date-time", + "description": "The last heartbeat received from the server.", + "type": "string" + }, + "versionStatus": { + "description": "Version status.", + "type": "string" + }, + "mobilityServiceUpdates": { + "description": "The list of the mobility service updates available on the Process Server.", + "type": "array", + "items": { + "$ref": "#/definitions/MobilityServiceUpdate" + } + }, + "hostId": { + "description": "The agent generated Id.", + "type": "string" + }, + "machineCount": { + "description": "The servers configured with this PS.", + "type": "string" + }, + "replicationPairCount": { + "description": "The number of replication pairs configured in this PS.", + "type": "string" + }, + "systemLoad": { + "description": "The percentage of the system load.", + "type": "string" + }, + "systemLoadStatus": { + "description": "The system load status.", + "type": "string" + }, + "cpuLoad": { + "description": "The percentage of the CPU load.", + "type": "string" + }, + "cpuLoadStatus": { + "description": "The CPU load status.", + "type": "string" + }, + "totalMemoryInBytes": { + "format": "int64", + "description": "The total memory.", + "type": "integer" + }, + "availableMemoryInBytes": { + "format": "int64", + "description": "The available memory.", + "type": "integer" + }, + "memoryUsageStatus": { + "description": "The memory usage status.", + "type": "string" + }, + "totalSpaceInBytes": { + "format": "int64", + "description": "The total space.", + "type": "integer" + }, + "availableSpaceInBytes": { + "format": "int64", + "description": "The available space.", + "type": "integer" + }, + "spaceUsageStatus": { + "description": "The space usage status.", + "type": "string" + }, + "psServiceStatus": { + "description": "The PS service status.", + "type": "string" + }, + "sslCertExpiryDate": { + "format": "date-time", + "description": "The PS SSL cert expiry date.", + "type": "string" + }, + "sslCertExpiryRemainingDays": { + "format": "int32", + "description": "CS SSL cert expiry date.", + "type": "integer" + }, + "osVersion": { + "description": "OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0.", + "type": "string" + }, + "healthErrors": { + "description": "Health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "agentExpiryDate": { + "format": "date-time", + "description": "Agent expiry date.", + "type": "string" + }, + "agentVersionDetails": { + "$ref": "#/definitions/VersionDetails", + "description": "The agent version details." + }, + "health": { + "description": "The health of Process Server.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "psStatsRefreshTime": { + "format": "date-time", + "description": "The process server stats refresh time.", + "type": "string", + "readOnly": true + }, + "throughputUploadPendingDataInBytes": { + "format": "int64", + "description": "The uploading pending data in bytes.", + "type": "integer", + "readOnly": true + }, + "throughputInMBps": { + "format": "int64", + "description": "The throughput in MBps.", + "type": "integer", + "readOnly": true + }, + "throughputInBytes": { + "format": "int64", + "description": "The throughput in bytes.", + "type": "integer", + "readOnly": true + }, + "throughputStatus": { + "description": "The throughput status.", + "type": "string", + "readOnly": true + }, + "marsCommunicationStatus": { + "description": "The MARS communication status.", + "type": "string", + "readOnly": true + }, + "marsRegistrationStatus": { + "description": "The MARS registration status.", + "type": "string", + "readOnly": true + } + } + }, + "ProcessServerDetails": { + "description": "Process server details.", + "type": "object", + "properties": { + "id": { + "description": "The process server Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The process server name.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The process server Bios Id.", + "type": "string", + "readOnly": true + }, + "fabricObjectId": { + "description": "The fabric object Id.", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "The process server Fqdn.", + "type": "string", + "readOnly": true + }, + "ipAddresses": { + "description": "The list of IP addresses for communicating with the RCM component.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "version": { + "description": "The version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the process server.", + "type": "string", + "readOnly": true + }, + "totalMemoryInBytes": { + "format": "int64", + "description": "The total memory.", + "type": "integer", + "readOnly": true + }, + "availableMemoryInBytes": { + "format": "int64", + "description": "The available memory.", + "type": "integer", + "readOnly": true + }, + "usedMemoryInBytes": { + "format": "int64", + "description": "The used memory.", + "type": "integer", + "readOnly": true + }, + "memoryUsagePercentage": { + "format": "double", + "description": "The memory usage percentage.", + "type": "number", + "readOnly": true + }, + "totalSpaceInBytes": { + "format": "int64", + "description": "The total disk space.", + "type": "integer", + "readOnly": true + }, + "availableSpaceInBytes": { + "format": "int64", + "description": "The available disk space.", + "type": "integer", + "readOnly": true + }, + "usedSpaceInBytes": { + "format": "int64", + "description": "The used disk space.", + "type": "integer", + "readOnly": true + }, + "freeSpacePercentage": { + "format": "double", + "description": "The free disk space percentage.", + "type": "number", + "readOnly": true + }, + "throughputUploadPendingDataInBytes": { + "format": "int64", + "description": "The uploading pending data in bytes.", + "type": "integer", + "readOnly": true + }, + "throughputInBytes": { + "format": "int64", + "description": "The throughput in bytes.", + "type": "integer", + "readOnly": true + }, + "processorUsagePercentage": { + "format": "double", + "description": "The processor usage percentage.", + "type": "number", + "readOnly": true + }, + "throughputStatus": { + "description": "The throughput status.", + "enum": [ + "Healthy", + "Warning", + "Critical", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RcmComponentStatus", + "modelAsString": true + } + }, + "systemLoad": { + "format": "int64", + "description": "The system load.", + "type": "integer", + "readOnly": true + }, + "systemLoadStatus": { + "description": "The system load status.", + "enum": [ + "Healthy", + "Warning", + "Critical", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RcmComponentStatus", + "modelAsString": true + } + }, + "diskUsageStatus": { + "description": "The disk usage status.", + "enum": [ + "Healthy", + "Warning", + "Critical", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RcmComponentStatus", + "modelAsString": true + } + }, + "memoryUsageStatus": { + "description": "The memory usage status.", + "enum": [ + "Healthy", + "Warning", + "Critical", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RcmComponentStatus", + "modelAsString": true + } + }, + "processorUsageStatus": { + "description": "The processor usage status.", + "enum": [ + "Healthy", + "Warning", + "Critical", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RcmComponentStatus", + "modelAsString": true + } + }, + "health": { + "description": "The health of the process server.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + }, + "protectedItemCount": { + "format": "int32", + "description": "The protected item count.", + "type": "integer", + "readOnly": true + }, + "historicHealth": { + "description": "The historic health of the process server based on the health in last 24 hours.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + } + } + }, + "ProtectableItem": { + "description": "Replication protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ProtectableItemProperties", + "description": "The custom data." + } + } + }, + "ProtectableItemCollection": { + "description": "Protectable item collection.", + "type": "object", + "properties": { + "value": { + "description": "The Protectable item details.", + "type": "array", + "items": { + "$ref": "#/definitions/ProtectableItem" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "ProtectableItemProperties": { + "description": "Replication protected item custom data details.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The name.", + "type": "string" + }, + "protectionStatus": { + "description": "The protection status.", + "type": "string" + }, + "replicationProtectedItemId": { + "description": "The ARM resource of protected items.", + "type": "string" + }, + "recoveryServicesProviderId": { + "description": "The recovery provider ARM Id.", + "type": "string" + }, + "protectionReadinessErrors": { + "description": "The Current protection readiness errors.", + "type": "array", + "items": { + "type": "string" + } + }, + "supportedReplicationProviders": { + "description": "The list of replication providers supported for the protectable item.", + "type": "array", + "items": { + "type": "string" + } + }, + "customDetails": { + "$ref": "#/definitions/ConfigurationSettings", + "description": "The Replication provider custom settings." + } + } + }, + "ProtectableItemQueryParameter": { + "description": "Query parameter to enumerate Protectable items.", + "type": "object", + "properties": { + "state": { + "description": "State of the Protectable item query filter.", + "type": "string" + } + } + }, + "ProtectedItemsQueryParameter": { + "description": "Query parameter to enumerate protected items.", + "type": "object", + "properties": { + "sourceFabricName": { + "description": "The source fabric name filter.", + "type": "string" + }, + "recoveryPlanName": { + "description": "The recovery plan filter.", + "type": "string" + }, + "sourceFabricLocation": { + "description": "The source fabric location filter.", + "type": "string" + }, + "fabricObjectId": { + "description": "The fabric object Id filter.", + "type": "string" + }, + "vCenterName": { + "description": "The vCenter name filter.", + "type": "string" + }, + "instanceType": { + "description": "The replication provider type.", + "type": "string" + }, + "multiVmGroupCreateOption": { + "description": "Whether Multi VM group is auto created or specified by user.", + "enum": [ + "AutoCreated", + "UserSpecified" + ], + "type": "string", + "x-ms-enum": { + "name": "MultiVmGroupCreateOption", + "modelAsString": true + } + }, + "processServerId": { + "description": "The process server Id filter.", + "type": "string" + } + } + }, + "ProtectionContainer": { + "description": "Protection container details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ProtectionContainerProperties", + "description": "The custom data." + } + } + }, + "ProtectionContainerCollection": { + "description": "Protection Container collection.", + "type": "object", + "properties": { + "value": { + "description": "The Protection Container details.", + "type": "array", + "items": { + "$ref": "#/definitions/ProtectionContainer" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "ProtectionContainerFabricSpecificDetails": { + "description": "Base class for fabric specific details of container.", + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type. Overridden in derived classes.", + "type": "string", + "readOnly": true + } + } + }, + "ProtectionContainerMapping": { + "description": "Protection container mapping object.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ProtectionContainerMappingProperties", + "description": "The custom data." + } + } + }, + "ProtectionContainerMappingCollection": { + "description": "Protection container mapping collection class.", + "type": "object", + "properties": { + "value": { + "description": "List of container mappings.", + "type": "array", + "items": { + "$ref": "#/definitions/ProtectionContainerMapping" + } + }, + "nextLink": { + "description": "Link to fetch rest of the data.", + "type": "string" + } + } + }, + "ProtectionContainerMappingProperties": { + "description": "Protection container mapping properties.", + "type": "object", + "properties": { + "targetProtectionContainerId": { + "description": "Paired protection container ARM ID.", + "type": "string" + }, + "targetProtectionContainerFriendlyName": { + "description": "Friendly name of paired container.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/ProtectionContainerMappingProviderSpecificDetails", + "description": "Provider specific provider details." + }, + "health": { + "description": "Health of pairing.", + "type": "string" + }, + "healthErrorDetails": { + "description": "Health error.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "policyId": { + "description": "Policy ARM Id.", + "type": "string" + }, + "state": { + "description": "Association Status.", + "type": "string" + }, + "sourceProtectionContainerFriendlyName": { + "description": "Friendly name of source protection container.", + "type": "string" + }, + "sourceFabricFriendlyName": { + "description": "Friendly name of source fabric.", + "type": "string" + }, + "targetFabricFriendlyName": { + "description": "Friendly name of target fabric.", + "type": "string" + }, + "policyFriendlyName": { + "description": "Friendly name of replication policy.", + "type": "string" + } + } + }, + "ProtectionContainerMappingProviderSpecificDetails": { + "description": "Container mapping provider specific details.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the class type. Overridden in derived classes.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ProtectionContainerProperties": { + "description": "Protection profile custom data details.", + "type": "object", + "properties": { + "fabricFriendlyName": { + "description": "Fabric friendly name.", + "type": "string" + }, + "friendlyName": { + "description": "The name.", + "type": "string" + }, + "fabricType": { + "description": "The fabric type.", + "type": "string" + }, + "protectedItemCount": { + "format": "int32", + "description": "Number of protected PEs.", + "type": "integer" + }, + "pairingStatus": { + "description": "The pairing status of this cloud.", + "type": "string" + }, + "role": { + "description": "The role of this cloud.", + "type": "string" + }, + "fabricSpecificDetails": { + "$ref": "#/definitions/ProtectionContainerFabricSpecificDetails", + "description": "Fabric specific details." + } + } + }, + "ProtectionProfileCustomDetails": { + "description": "Protection Profile custom input.", + "required": [ + "resourceType" + ], + "type": "object", + "properties": { + "resourceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "resourceType" + }, + "ProviderError": { + "description": "This class contains the error details per object.", + "type": "object", + "properties": { + "errorCode": { + "format": "int32", + "description": "The Error code.", + "type": "integer" + }, + "errorMessage": { + "description": "The Error message.", + "type": "string" + }, + "errorId": { + "description": "The Provider error Id.", + "type": "string" + }, + "possibleCauses": { + "description": "The possible causes for the error.", + "type": "string" + }, + "recommendedAction": { + "description": "The recommended action to resolve the error.", + "type": "string" + } + } + }, + "ProviderSpecificRecoveryPointDetails": { + "description": "Replication provider specific recovery point details.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the provider type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "PushInstallerDetails": { + "description": "Push installer details.", + "type": "object", + "properties": { + "id": { + "description": "The push installer Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The push installer name.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The push installer Bios Id.", + "type": "string", + "readOnly": true + }, + "fabricObjectId": { + "description": "The fabric object Id.", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "The push installer Fqdn.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the push installer.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The health of the push installer.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + } + } + }, + "RcmProxyDetails": { + "description": "RCM proxy details.", + "type": "object", + "properties": { + "id": { + "description": "The RCM proxy Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The RCM proxy name.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The RCM proxy Bios Id.", + "type": "string", + "readOnly": true + }, + "fabricObjectId": { + "description": "The fabric object Id.", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "The RCM proxy Fqdn.", + "type": "string", + "readOnly": true + }, + "clientAuthenticationType": { + "description": "The client authentication type.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the RCM proxy.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The health of the RCM proxy.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + } + } + }, + "RecoveryAvailabilitySetCustomDetails": { + "description": "Recovery Availability Set custom input.", + "required": [ + "resourceType" + ], + "type": "object", + "properties": { + "resourceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "resourceType" + }, + "RecoveryPlan": { + "description": "Recovery plan details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RecoveryPlanProperties", + "description": "The custom details." + } + } + }, + "RecoveryPlanA2ADetails": { + "description": "Recovery plan A2A specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificDetails" + } + ], + "properties": { + "primaryZone": { + "description": "The primary zone.", + "type": "string" + }, + "recoveryZone": { + "description": "The recovery zone.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "RecoveryPlanA2AFailoverInput": { + "description": "Recovery plan A2A failover input.", + "required": [ + "recoveryPointType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "Latest", + "LatestApplicationConsistent", + "LatestCrashConsistent", + "LatestProcessed" + ], + "type": "string", + "x-ms-enum": { + "name": "A2ARpRecoveryPointType", + "modelAsString": true + } + }, + "cloudServiceCreationOption": { + "description": "A value indicating whether to use recovery cloud service for TFO or not.", + "type": "string" + }, + "multiVmSyncPointOption": { + "description": "A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover.", + "enum": [ + "UseMultiVmSyncRecoveryPoint", + "UsePerVmRecoveryPoint" + ], + "type": "string", + "x-ms-enum": { + "name": "MultiVmSyncPointOption", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "A2A" + }, + "RecoveryPlanA2AInput": { + "description": "Recovery plan A2A input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificInput" + } + ], + "properties": { + "primaryZone": { + "description": "The primary zone.", + "type": "string" + }, + "recoveryZone": { + "description": "The recovery zone.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "RecoveryPlanAction": { + "description": "Recovery plan action details.", + "required": [ + "actionName", + "failoverTypes", + "failoverDirections", + "customDetails" + ], + "type": "object", + "properties": { + "actionName": { + "description": "The action name.", + "type": "string" + }, + "failoverTypes": { + "description": "The list of failover types.", + "type": "array", + "items": { + "enum": [ + "ReverseReplicate", + "Commit", + "PlannedFailover", + "UnplannedFailover", + "DisableProtection", + "TestFailover", + "TestFailoverCleanup", + "Failback", + "FinalizeFailback", + "CancelFailover", + "ChangePit", + "RepairReplication", + "SwitchProtection", + "CompleteMigration" + ], + "type": "string", + "x-ms-enum": { + "name": "ReplicationProtectedItemOperation", + "modelAsString": true + } + } + }, + "failoverDirections": { + "description": "The list of failover directions.", + "type": "array", + "items": { + "enum": [ + "PrimaryToRecovery", + "RecoveryToPrimary" + ], + "type": "string", + "x-ms-enum": { + "name": "PossibleOperationsDirections", + "modelAsString": true + } + } + }, + "customDetails": { + "$ref": "#/definitions/RecoveryPlanActionDetails", + "description": "The custom details." + } + } + }, + "RecoveryPlanActionDetails": { + "description": "Recovery plan action custom details.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values).", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "RecoveryPlanAutomationRunbookActionDetails": { + "description": "Recovery plan Automation runbook action details.", + "required": [ + "fabricLocation" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanActionDetails" + } + ], + "properties": { + "runbookId": { + "description": "The runbook ARM Id.", + "type": "string" + }, + "timeout": { + "description": "The runbook timeout.", + "type": "string" + }, + "fabricLocation": { + "description": "The fabric location.", + "enum": [ + "Primary", + "Recovery" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPlanActionLocation", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "AutomationRunbookActionDetails" + }, + "RecoveryPlanCollection": { + "description": "Recovery plan collection details.", + "type": "object", + "properties": { + "value": { + "description": "The list of recovery plans.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlan" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "RecoveryPlanGroup": { + "description": "Recovery plan group details.", + "required": [ + "groupType" + ], + "type": "object", + "properties": { + "groupType": { + "description": "The group type.", + "enum": [ + "Shutdown", + "Boot", + "Failover" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPlanGroupType", + "modelAsString": true + } + }, + "replicationProtectedItems": { + "description": "The list of protected items.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanProtectedItem" + } + }, + "startGroupActions": { + "description": "The start group actions.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanAction" + } + }, + "endGroupActions": { + "description": "The end group actions.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanAction" + } + } + } + }, + "RecoveryPlanGroupTaskDetails": { + "description": "This class represents the recovery plan group task.", + "required": [ + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GroupTaskDetails" + } + ], + "properties": { + "name": { + "description": "The name.", + "type": "string" + }, + "groupId": { + "description": "The group identifier.", + "type": "string" + }, + "rpGroupType": { + "description": "The group type.", + "type": "string" + } + }, + "discriminator": "instanceType", + "x-ms-discriminator-value": "RecoveryPlanGroupTaskDetails" + }, + "RecoveryPlanHyperVReplicaAzureFailbackInput": { + "description": "Recovery plan HVR Azure failback input.", + "required": [ + "dataSyncOption", + "recoveryVmCreationOption" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + ], + "properties": { + "dataSyncOption": { + "description": "The data sync option.", + "enum": [ + "ForDownTime", + "ForSynchronization" + ], + "type": "string", + "x-ms-enum": { + "name": "DataSyncStatus", + "modelAsString": true + } + }, + "recoveryVmCreationOption": { + "description": "The ALR option.", + "enum": [ + "CreateVmIfNotFound", + "NoAction" + ], + "type": "string", + "x-ms-enum": { + "name": "AlternateLocationRecoveryOption", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzureFailback" + }, + "RecoveryPlanHyperVReplicaAzureFailoverInput": { + "description": "Recovery plan HVR Azure failover input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + ], + "properties": { + "primaryKekCertificatePfx": { + "description": "The primary KEK certificate PFX.", + "type": "string" + }, + "secondaryKekCertificatePfx": { + "description": "The secondary KEK certificate PFX.", + "type": "string" + }, + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "Latest", + "LatestApplicationConsistent", + "LatestProcessed" + ], + "type": "string", + "x-ms-enum": { + "name": "HyperVReplicaAzureRpRecoveryPointType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "RecoveryPlanInMageAzureV2FailoverInput": { + "description": "Recovery plan InMageAzureV2 failover input.", + "required": [ + "recoveryPointType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "Latest", + "LatestApplicationConsistent", + "LatestCrashConsistent", + "LatestProcessed" + ], + "type": "string", + "x-ms-enum": { + "name": "InMageV2RpRecoveryPointType", + "modelAsString": true + } + }, + "useMultiVmSyncPoint": { + "description": "A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "RecoveryPlanInMageFailoverInput": { + "description": "Recovery plan InMage failover input.", + "required": [ + "recoveryPointType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "LatestTime", + "LatestTag", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "RpInMageRecoveryPointType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "InMage" + }, + "RecoveryPlanInMageRcmFailbackFailoverInput": { + "description": "Recovery plan InMageRcmFailback failover input.", + "required": [ + "recoveryPointType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "ApplicationConsistent", + "CrashConsistent" + ], + "type": "string", + "x-ms-enum": { + "name": "InMageRcmFailbackRecoveryPointType", + "modelAsString": true + } + }, + "useMultiVmSyncPoint": { + "description": "A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcmFailback" + }, + "RecoveryPlanInMageRcmFailoverInput": { + "description": "Recovery plan InMageRcm failover input.", + "required": [ + "recoveryPointType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "Latest", + "LatestApplicationConsistent", + "LatestCrashConsistent", + "LatestProcessed" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPlanPointType", + "modelAsString": true + } + }, + "useMultiVmSyncPoint": { + "description": "A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "RecoveryPlanManualActionDetails": { + "description": "Recovery plan manual action details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanActionDetails" + } + ], + "properties": { + "description": { + "description": "The manual action description.", + "type": "string" + } + }, + "x-ms-discriminator-value": "ManualActionDetails" + }, + "RecoveryPlanPlannedFailoverInput": { + "description": "Recovery plan planned failover input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RecoveryPlanPlannedFailoverInputProperties", + "description": "The recovery plan planned failover input properties." + } + } + }, + "RecoveryPlanPlannedFailoverInputProperties": { + "description": "Recovery plan planned failover input properties.", + "required": [ + "failoverDirection" + ], + "type": "object", + "properties": { + "failoverDirection": { + "description": "The failover direction.", + "enum": [ + "PrimaryToRecovery", + "RecoveryToPrimary" + ], + "type": "string", + "x-ms-enum": { + "name": "PossibleOperationsDirections", + "modelAsString": true + } + }, + "providerSpecificDetails": { + "description": "The provider specific properties.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + } + } + }, + "RecoveryPlanProperties": { + "description": "Recovery plan properties.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The friendly name.", + "type": "string" + }, + "primaryFabricId": { + "description": "The primary fabric Id.", + "type": "string" + }, + "primaryFabricFriendlyName": { + "description": "The primary fabric friendly name.", + "type": "string" + }, + "recoveryFabricId": { + "description": "The recovery fabric Id.", + "type": "string" + }, + "recoveryFabricFriendlyName": { + "description": "The recovery fabric friendly name.", + "type": "string" + }, + "failoverDeploymentModel": { + "description": "The failover deployment model.", + "type": "string" + }, + "replicationProviders": { + "description": "The list of replication providers.", + "type": "array", + "items": { + "type": "string" + } + }, + "allowedOperations": { + "description": "The list of allowed operations.", + "type": "array", + "items": { + "type": "string" + } + }, + "lastPlannedFailoverTime": { + "format": "date-time", + "description": "The start time of the last planned failover.", + "type": "string" + }, + "lastUnplannedFailoverTime": { + "format": "date-time", + "description": "The start time of the last unplanned failover.", + "type": "string" + }, + "lastTestFailoverTime": { + "format": "date-time", + "description": "The start time of the last test failover.", + "type": "string" + }, + "currentScenario": { + "$ref": "#/definitions/CurrentScenarioDetails", + "description": "The current scenario details." + }, + "currentScenarioStatus": { + "description": "The recovery plan status.", + "type": "string" + }, + "currentScenarioStatusDescription": { + "description": "The recovery plan status description.", + "type": "string" + }, + "groups": { + "description": "The recovery plan groups.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanGroup" + } + }, + "providerSpecificDetails": { + "description": "The provider id and provider specific details.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanProviderSpecificDetails" + } + } + } + }, + "RecoveryPlanProtectedItem": { + "description": "Recovery plan protected item.", + "type": "object", + "properties": { + "id": { + "description": "The ARM Id of the recovery plan protected item.", + "type": "string" + }, + "virtualMachineId": { + "description": "The virtual machine Id.", + "type": "string" + } + } + }, + "RecoveryPlanProviderSpecificDetails": { + "description": "Recovery plan provider specific details.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the Instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "RecoveryPlanProviderSpecificFailoverInput": { + "description": "Recovery plan provider specific failover input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "RecoveryPlanProviderSpecificInput": { + "description": "Recovery plan provider specific input base class.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the Instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "RecoveryPlanScriptActionDetails": { + "description": "Recovery plan script action details.", + "required": [ + "path", + "fabricLocation" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanActionDetails" + } + ], + "properties": { + "path": { + "description": "The script path.", + "type": "string" + }, + "timeout": { + "description": "The script timeout.", + "type": "string" + }, + "fabricLocation": { + "description": "The fabric location.", + "enum": [ + "Primary", + "Recovery" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPlanActionLocation", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "ScriptActionDetails" + }, + "RecoveryPlanShutdownGroupTaskDetails": { + "description": "This class represents the recovery plan shutdown group task details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanGroupTaskDetails" + } + ], + "properties": {}, + "x-ms-discriminator-value": "RecoveryPlanShutdownGroupTaskDetails" + }, + "RecoveryPlanTestFailoverCleanupInput": { + "description": "Recovery plan test failover cleanup input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RecoveryPlanTestFailoverCleanupInputProperties", + "description": "The recovery plan test failover cleanup input properties." + } + } + }, + "RecoveryPlanTestFailoverCleanupInputProperties": { + "description": "Recovery plan test failover cleanup input properties.", + "type": "object", + "properties": { + "comments": { + "description": "The test failover cleanup comments.", + "maxLength": 1024, + "type": "string" + } + } + }, + "RecoveryPlanTestFailoverInput": { + "description": "Recovery plan test failover input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RecoveryPlanTestFailoverInputProperties", + "description": "The recovery plan test failover input properties." + } + } + }, + "RecoveryPlanTestFailoverInputProperties": { + "description": "Recovery plan test failover input properties.", + "required": [ + "failoverDirection", + "networkType" + ], + "type": "object", + "properties": { + "failoverDirection": { + "description": "The failover direction.", + "enum": [ + "PrimaryToRecovery", + "RecoveryToPrimary" + ], + "type": "string", + "x-ms-enum": { + "name": "PossibleOperationsDirections", + "modelAsString": true + } + }, + "networkType": { + "description": "The network type to be used for test failover.", + "type": "string" + }, + "networkId": { + "description": "The Id of the network to be used for test failover.", + "type": "string" + }, + "providerSpecificDetails": { + "description": "The provider specific properties.", + "maxLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + } + } + }, + "RecoveryPlanUnplannedFailoverInput": { + "description": "Recovery plan unplanned failover input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RecoveryPlanUnplannedFailoverInputProperties", + "description": "The recovery plan unplanned failover input properties." + } + } + }, + "RecoveryPlanUnplannedFailoverInputProperties": { + "description": "Recovery plan unplanned failover input properties.", + "required": [ + "failoverDirection", + "sourceSiteOperations" + ], + "type": "object", + "properties": { + "failoverDirection": { + "description": "The failover direction.", + "enum": [ + "PrimaryToRecovery", + "RecoveryToPrimary" + ], + "type": "string", + "x-ms-enum": { + "name": "PossibleOperationsDirections", + "modelAsString": true + } + }, + "sourceSiteOperations": { + "description": "A value indicating whether source site operations are required.", + "enum": [ + "Required", + "NotRequired" + ], + "type": "string", + "x-ms-enum": { + "name": "SourceSiteOperations", + "modelAsString": true + } + }, + "providerSpecificDetails": { + "description": "The provider specific properties.", + "maxLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + } + } + }, + "RecoveryPoint": { + "description": "Recovery point.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RecoveryPointProperties", + "description": "The recovery point properties." + } + } + }, + "RecoveryPointCollection": { + "description": "Collection of recovery point details.", + "type": "object", + "properties": { + "value": { + "description": "The recovery point details.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPoint" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "RecoveryPointProperties": { + "description": "Recovery point properties.", + "type": "object", + "properties": { + "recoveryPointTime": { + "format": "date-time", + "description": "The recovery point time.", + "type": "string" + }, + "recoveryPointType": { + "description": "The recovery point type: ApplicationConsistent, CrashConsistent.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/ProviderSpecificRecoveryPointDetails", + "description": "The provider specific details for the recovery point." + } + } + }, + "RecoveryProximityPlacementGroupCustomDetails": { + "description": "Recovery Proximity placement group custom input.", + "required": [ + "resourceType" + ], + "type": "object", + "properties": { + "resourceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "resourceType" + }, + "RecoveryResourceGroupCustomDetails": { + "description": "Recovery Resource Group custom input.", + "required": [ + "resourceType" + ], + "type": "object", + "properties": { + "resourceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "resourceType" + }, + "RecoveryServicesProvider": { + "description": "Provider details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RecoveryServicesProviderProperties", + "description": "Provider properties." + } + } + }, + "RecoveryServicesProviderCollection": { + "description": "Collection of providers.", + "type": "object", + "properties": { + "value": { + "description": "The Servers details.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryServicesProvider" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "RecoveryServicesProviderProperties": { + "description": "Recovery services provider properties.", + "type": "object", + "properties": { + "fabricType": { + "description": "Type of the site.", + "type": "string" + }, + "friendlyName": { + "description": "Friendly name of the DRA.", + "type": "string" + }, + "providerVersion": { + "description": "The provider version.", + "type": "string" + }, + "serverVersion": { + "description": "The fabric provider.", + "type": "string" + }, + "providerVersionState": { + "description": "DRA version status.", + "type": "string" + }, + "providerVersionExpiryDate": { + "format": "date-time", + "description": "Expiry date of the version.", + "type": "string" + }, + "fabricFriendlyName": { + "description": "The fabric friendly name.", + "type": "string" + }, + "lastHeartBeat": { + "format": "date-time", + "description": "Time when last heartbeat was sent by the DRA.", + "type": "string" + }, + "connectionStatus": { + "description": "A value indicating whether DRA is responsive.", + "type": "string" + }, + "protectedItemCount": { + "format": "int32", + "description": "Number of protected VMs currently managed by the DRA.", + "type": "integer" + }, + "allowedScenarios": { + "description": "The scenarios allowed on this provider.", + "type": "array", + "items": { + "type": "string" + } + }, + "healthErrorDetails": { + "description": "The recovery services provider health error details.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "draIdentifier": { + "description": "The DRA Id.", + "type": "string" + }, + "machineId": { + "description": "The machine Id.", + "type": "string" + }, + "machineName": { + "description": "The machine name.", + "type": "string" + }, + "biosId": { + "description": "The Bios Id.", + "type": "string" + }, + "authenticationIdentityDetails": { + "$ref": "#/definitions/IdentityProviderDetails", + "description": "The authentication identity details." + }, + "resourceAccessIdentityDetails": { + "$ref": "#/definitions/IdentityProviderDetails", + "description": "The resource access identity details." + }, + "dataPlaneAuthenticationIdentityDetails": { + "$ref": "#/definitions/IdentityProviderDetails", + "description": "The data plane authentication identity details." + }, + "providerVersionDetails": { + "$ref": "#/definitions/VersionDetails", + "description": "The provider version details." + } + } + }, + "RecoveryVirtualNetworkCustomDetails": { + "description": "Recovery Virtual network custom input.", + "required": [ + "resourceType" + ], + "type": "object", + "properties": { + "resourceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "resourceType" + }, + "RemoveDisksInput": { + "description": "Input for remove disk(s) operation.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RemoveDisksInputProperties", + "description": "Remove disk input properties." + } + } + }, + "RemoveDisksInputProperties": { + "description": "Remove Disk input properties.", + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/RemoveDisksProviderSpecificInput", + "description": "The ReplicationProviderInput. For HyperVReplicaAzure provider, it will be AzureEnableProtectionInput object. For San provider, it will be SanEnableProtectionInput object. For HyperVReplicaAzure provider, it can be null." + } + } + }, + "RemoveDisksProviderSpecificInput": { + "description": "Remove Disk provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "RemoveProtectionContainerMappingInput": { + "description": "Container unpairing input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RemoveProtectionContainerMappingInputProperties", + "description": "Configure protection input properties." + } + } + }, + "RemoveProtectionContainerMappingInputProperties": { + "description": "Unpairing input properties.", + "type": "object", + "properties": { + "providerSpecificInput": { + "$ref": "#/definitions/ReplicationProviderContainerUnmappingInput", + "description": "Provider specific input for unpairing." + } + } + }, + "RenewCertificateInput": { + "description": "Certificate renewal input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RenewCertificateInputProperties", + "description": "Renew certificate input properties." + } + } + }, + "RenewCertificateInputProperties": { + "description": "Renew Certificate input properties.", + "type": "object", + "properties": { + "renewCertificateType": { + "description": "Renew certificate type.", + "type": "string" + } + } + }, + "ReplicationAgentDetails": { + "description": "Replication agent details.", + "type": "object", + "properties": { + "id": { + "description": "The replication agent Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The replication agent name.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The replication agent Bios Id.", + "type": "string", + "readOnly": true + }, + "fabricObjectId": { + "description": "The fabric object Id.", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "The replication agent Fqdn.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the replication agent.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The health of the replication agent.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + } + } + }, + "ReplicationEligibilityResults": { + "description": "Replication eligibility results response model.", + "type": "object", + "properties": { + "name": { + "description": "Gets the name of this object.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Gets the object type.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Gets Unique ARM identifier for this object.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/ReplicationEligibilityResultsProperties", + "description": "Gets properties model for replication eligibility results API.", + "readOnly": true + } + } + }, + "ReplicationEligibilityResultsCollection": { + "description": "Replication eligibility results collection response model.", + "type": "object", + "properties": { + "value": { + "description": "The replication eligibility results details.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationEligibilityResults" + } + } + } + }, + "ReplicationEligibilityResultsErrorInfo": { + "description": "Error model that can be exposed to the user.", + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "type": "string" + }, + "message": { + "description": "The error message.", + "type": "string" + }, + "possibleCauses": { + "description": "The possible causes.", + "type": "string" + }, + "recommendedAction": { + "description": "The recommended action.", + "type": "string" + }, + "status": { + "description": "The error status.", + "readOnly": true, + "type": "string" + } + } + }, + "ReplicationEligibilityResultsProperties": { + "description": "Properties model for replication eligibility results API.", + "type": "object", + "properties": { + "clientRequestId": { + "description": "The client request Id.", + "readOnly": true, + "type": "string" + }, + "errors": { + "description": "The error details.", + "type": "array", + "uniqueItems": false, + "items": { + "$ref": "#/definitions/ReplicationEligibilityResultsErrorInfo" + } + } + } + }, + "ReplicationGroupDetails": { + "description": "Replication group details. This will be used in case of San.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConfigurationSettings" + } + ], + "properties": {}, + "x-ms-discriminator-value": "ReplicationGroupDetails" + }, + "ReplicationProtectedItem": { + "description": "Replication protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ReplicationProtectedItemProperties", + "description": "The custom data." + } + } + }, + "ReplicationProtectedItemCollection": { + "description": "Replication protected item collection.", + "type": "object", + "properties": { + "value": { + "description": "The Replication protected item details.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "ReplicationProtectedItemProperties": { + "description": "Replication protected item custom data details.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The name.", + "type": "string" + }, + "protectedItemType": { + "description": "The type of protected item type.", + "type": "string" + }, + "protectableItemId": { + "description": "The protected item ARM Id.", + "type": "string" + }, + "recoveryServicesProviderId": { + "description": "The recovery provider ARM Id.", + "type": "string" + }, + "primaryFabricFriendlyName": { + "description": "The friendly name of the primary fabric.", + "type": "string" + }, + "primaryFabricProvider": { + "description": "The fabric provider of the primary fabric.", + "type": "string" + }, + "recoveryFabricFriendlyName": { + "description": "The friendly name of recovery fabric.", + "type": "string" + }, + "recoveryFabricId": { + "description": "The Arm Id of recovery fabric.", + "type": "string" + }, + "primaryProtectionContainerFriendlyName": { + "description": "The name of primary protection container friendly name.", + "type": "string" + }, + "recoveryProtectionContainerFriendlyName": { + "description": "The name of recovery container friendly name.", + "type": "string" + }, + "protectionState": { + "description": "The protection status.", + "type": "string" + }, + "protectionStateDescription": { + "description": "The protection state description.", + "type": "string" + }, + "activeLocation": { + "description": "The Current active location of the PE.", + "type": "string" + }, + "testFailoverState": { + "description": "The Test failover state.", + "type": "string" + }, + "testFailoverStateDescription": { + "description": "The Test failover state description.", + "type": "string" + }, + "allowedOperations": { + "description": "The allowed operations on the Replication protected item.", + "type": "array", + "items": { + "type": "string" + } + }, + "replicationHealth": { + "description": "The consolidated protection health for the VM taking any issues with SRS as well as all the replication units associated with the VM's replication group into account. This is a string representation of the ProtectionHealth enumeration.", + "type": "string" + }, + "failoverHealth": { + "description": "The consolidated failover health for the VM.", + "type": "string" + }, + "healthErrors": { + "description": "List of health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "policyId": { + "description": "The ID of Policy governing this PE.", + "type": "string" + }, + "policyFriendlyName": { + "description": "The name of Policy governing this PE.", + "type": "string" + }, + "lastSuccessfulFailoverTime": { + "format": "date-time", + "description": "The Last successful failover time.", + "type": "string" + }, + "lastSuccessfulTestFailoverTime": { + "format": "date-time", + "description": "The Last successful test failover time.", + "type": "string" + }, + "currentScenario": { + "$ref": "#/definitions/CurrentScenarioDetails", + "description": "The current scenario." + }, + "failoverRecoveryPointId": { + "description": "The recovery point ARM Id to which the Vm was failed over.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/ReplicationProviderSpecificSettings", + "description": "The Replication provider custom settings." + }, + "recoveryContainerId": { + "description": "The recovery container Id.", + "type": "string" + }, + "eventCorrelationId": { + "description": "The correlation Id for events associated with this protected item.", + "type": "string" + } + } + }, + "ReplicationProtectionIntent": { + "description": "Replication protection intent.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ReplicationProtectionIntentProperties", + "description": "The custom data." + } + } + }, + "ReplicationProtectionIntentCollection": { + "description": "Replication protection intent objects collection.", + "type": "object", + "properties": { + "value": { + "description": "The Replication protection intent details.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationProtectionIntent" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "ReplicationProtectionIntentProperties": { + "description": "Replication protection intent custom data details.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The name.", + "type": "string" + }, + "jobId": { + "description": "The job Id.", + "type": "string", + "readOnly": true + }, + "jobState": { + "description": "The job state.", + "type": "string", + "readOnly": true + }, + "isActive": { + "description": "A value indicating whether the intent object is active.", + "type": "boolean", + "readOnly": true + }, + "creationTimeUTC": { + "description": "The creation time in UTC.", + "type": "string", + "readOnly": true + }, + "providerSpecificDetails": { + "$ref": "#/definitions/ReplicationProtectionIntentProviderSpecificSettings", + "description": "The Replication provider custom settings." + } + } + }, + "ReplicationProtectionIntentProviderSpecificSettings": { + "description": "Replication provider specific settings.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the Instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ReplicationProviderContainerUnmappingInput": { + "description": "Provider specific input for unpairing operations.", + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + } + }, + "ReplicationProviderSpecificContainerCreationInput": { + "description": "Provider specific input for container creation operation.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ReplicationProviderSpecificContainerMappingInput": { + "description": "Provider specific input for pairing operations.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ReplicationProviderSpecificSettings": { + "description": "Replication provider specific settings.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the Instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ReplicationProviderSpecificUpdateContainerMappingInput": { + "description": "Provider specific input for update pairing operations.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "ReprotectAgentDetails": { + "description": "Reprotect agent details.", + "type": "object", + "properties": { + "id": { + "description": "The reprotect agent Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The reprotect agent name.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The reprotect agent Bios Id.", + "type": "string", + "readOnly": true + }, + "fabricObjectId": { + "description": "The fabric object Id.", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "The reprotect agent Fqdn.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the reprotect agent.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The health of the reprotect agent.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + }, + "protectedItemCount": { + "format": "int32", + "description": "The protected item count.", + "type": "integer", + "readOnly": true + }, + "accessibleDatastores": { + "description": "The list of accessible datastores fetched from discovery.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "vcenterId": { + "description": "The Vcenter Id.", + "type": "string", + "readOnly": true + }, + "lastDiscoveryInUtc": { + "format": "date-time", + "description": "The last time when SDS information discovered in SRS.", + "type": "string", + "readOnly": true + } + } + }, + "ResolveHealthError": { + "description": "Resolve health errors input properties.", + "type": "object", + "properties": { + "healthErrorId": { + "description": "Health error id.", + "type": "string" + } + } + }, + "ResolveHealthInput": { + "description": "Resolve health input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ResolveHealthInputProperties", + "description": "Disable resolve health input properties." + } + } + }, + "ResolveHealthInputProperties": { + "description": "Resolve health input properties.", + "type": "object", + "properties": { + "healthErrors": { + "description": "Health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/ResolveHealthError" + } + } + } + }, + "Resource": { + "description": "Azure resource.", + "type": "object", + "properties": { + "id": { + "description": "Resource Id", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource Name", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource Type", + "type": "string", + "readOnly": true + }, + "location": { + "description": "Resource Location", + "type": "string" + } + }, + "x-ms-azure-resource": true + }, + "ResourceHealthSummary": { + "description": "Base class to define the health summary of the resources contained under an Arm resource.", + "type": "object", + "properties": { + "resourceCount": { + "format": "int32", + "description": "The count of total resources under the container.", + "type": "integer" + }, + "issues": { + "description": "The list of summary of health errors across the resources under the container.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthErrorSummary" + } + }, + "categorizedResourceCounts": { + "description": "The categorized resource counts.", + "type": "object", + "additionalProperties": { + "format": "int32", + "type": "integer" + } + } + } + }, + "ResumeJobParams": { + "description": "Resume job params.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ResumeJobParamsProperties", + "description": "Resume job properties." + } + } + }, + "ResumeJobParamsProperties": { + "description": "Resume job properties.", + "type": "object", + "properties": { + "comments": { + "description": "Resume job comments.", + "type": "string" + } + } + }, + "ResyncInput": { + "description": "Resync input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ResyncInputProperties", + "description": "Resync input properties." + } + } + }, + "ResyncInputProperties": { + "description": "Resync input properties.", + "required": [ + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/ResyncProviderSpecificInput", + "description": "The provider specific details." + } + } + }, + "ResyncProviderSpecificInput": { + "description": "Resync provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "RetentionVolume": { + "description": "The retention details of the MT.", + "type": "object", + "properties": { + "volumeName": { + "description": "The volume name.", + "type": "string" + }, + "capacityInBytes": { + "format": "int64", + "description": "The volume capacity.", + "type": "integer" + }, + "freeSpaceInBytes": { + "format": "int64", + "description": "The free space available in this volume.", + "type": "integer" + }, + "thresholdPercentage": { + "format": "int32", + "description": "The threshold percentage.", + "type": "integer" + } + } + }, + "ReverseReplicationInput": { + "description": "Reverse replication input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ReverseReplicationInputProperties", + "description": "Reverse replication properties." + } + } + }, + "ReverseReplicationInputProperties": { + "description": "Reverse replication input properties.", + "type": "object", + "properties": { + "failoverDirection": { + "description": "Failover direction.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/ReverseReplicationProviderSpecificInput", + "description": "Provider specific reverse replication input." + } + } + }, + "ReverseReplicationProviderSpecificInput": { + "description": "Provider specific reverse replication input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "RoleAssignment": { + "description": "Azure role assignment details.", + "type": "object", + "properties": { + "id": { + "description": "The ARM Id of the role assignment.", + "type": "string" + }, + "name": { + "description": "The name of the role assignment.", + "type": "string" + }, + "scope": { + "description": "Role assignment scope.", + "type": "string" + }, + "principalId": { + "description": "Principal Id.", + "type": "string" + }, + "roleDefinitionId": { + "description": "Role definition id.", + "type": "string" + } + } + }, + "RunAsAccount": { + "description": "CS Accounts Details.", + "type": "object", + "properties": { + "accountId": { + "description": "The CS RunAs account Id.", + "type": "string" + }, + "accountName": { + "description": "The CS RunAs account name.", + "type": "string" + } + } + }, + "ScriptActionTaskDetails": { + "description": "This class represents the script action task details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskTypeDetails" + } + ], + "properties": { + "name": { + "description": "The name.", + "type": "string" + }, + "path": { + "description": "The path.", + "type": "string" + }, + "output": { + "description": "The output.", + "type": "string" + }, + "isPrimarySideScript": { + "description": "A value indicating whether it is a primary side script or not.", + "type": "boolean" + } + }, + "x-ms-discriminator-value": "ScriptActionTaskDetails" + }, + "ServiceError": { + "description": "ASR error model.", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Error message.", + "type": "string" + }, + "possibleCauses": { + "description": "Possible causes of error.", + "type": "string" + }, + "recommendedAction": { + "description": "Recommended action to resolve error.", + "type": "string" + }, + "activityId": { + "description": "Activity Id.", + "type": "string" + } + } + }, + "IPConfigDetails": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "isPrimary": { + "type": "boolean" + }, + "subnetName": { + "type": "string" + }, + "staticIPAddress": { + "type": "string" + }, + "ipAddressType": { + "type": "string" + }, + "isSeletedForFailover": { + "type": "boolean" + }, + "recoverySubnetName": { + "type": "string" + }, + "recoveryStaticIPAddress": { + "type": "string" + }, + "recoveryIPAddressType": { + "type": "string" + }, + "recoveryPublicIPAddressId": { + "type": "string" + }, + "recoveryLBBackendAddressPoolIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "tfoSubnetName": { + "type": "string" + }, + "tfoStaticIPAddress": { + "type": "string" + }, + "tfoPublicIPAddressId": { + "type": "string" + }, + "tfoLBBackendAddressPoolIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "IPConfigInputDetails": { + "type": "object", + "properties": { + "ipConfigName": { + "type": "string" + }, + "isPrimary": { + "type": "boolean" + }, + "isSeletedForFailover": { + "type": "boolean" + }, + "recoverySubnetName": { + "type": "string" + }, + "recoveryStaticIPAddress": { + "type": "string" + }, + "recoveryPublicIPAddressId": { + "type": "string" + }, + "recoveryLBBackendAddressPoolIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "tfoSubnetName": { + "type": "string" + }, + "tfoStaticIPAddress": { + "type": "string" + }, + "tfoPublicIPAddressId": { + "type": "string" + }, + "tfoLBBackendAddressPoolIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "StorageAccountCustomDetails": { + "description": "Storage account custom input.", + "required": [ + "resourceType" + ], + "type": "object", + "properties": { + "resourceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "resourceType" + }, + "StorageClassification": { + "description": "Storage object definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StorageClassificationProperties", + "description": "Properties of the storage object." + } + } + }, + "StorageClassificationCollection": { + "description": "Collection of storage details.", + "type": "object", + "properties": { + "value": { + "description": "The storage details.", + "type": "array", + "items": { + "$ref": "#/definitions/StorageClassification" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "StorageClassificationMapping": { + "description": "Storage mapping object.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StorageClassificationMappingProperties", + "description": "Properties of the storage mapping object." + } + } + }, + "StorageClassificationMappingCollection": { + "description": "Collection of storage mapping details.", + "type": "object", + "properties": { + "value": { + "description": "The storage details.", + "type": "array", + "items": { + "$ref": "#/definitions/StorageClassificationMapping" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "StorageClassificationMappingInput": { + "description": "Storage mapping input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/StorageMappingInputProperties", + "description": "Storage mapping input properties." + } + } + }, + "StorageClassificationMappingProperties": { + "description": "Storage mapping properties.", + "type": "object", + "properties": { + "targetStorageClassificationId": { + "description": "Target storage object Id.", + "type": "string" + } + } + }, + "StorageClassificationProperties": { + "description": "Storage object properties.", + "type": "object", + "properties": { + "friendlyName": { + "description": "Friendly name of the Storage classification.", + "type": "string" + } + } + }, + "StorageMappingInputProperties": { + "description": "Storage mapping input properties.", + "type": "object", + "properties": { + "targetStorageClassificationId": { + "description": "The ID of the storage object.", + "type": "string" + } + } + }, + "Subnet": { + "description": "Subnets of the network.", + "type": "object", + "properties": { + "name": { + "description": "The subnet name.", + "type": "string" + }, + "friendlyName": { + "description": "The subnet friendly name.", + "type": "string" + }, + "addressList": { + "description": "The list of addresses for the subnet.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SupportedOperatingSystems": { + "description": "Supported operating systems.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SupportedOSProperties", + "description": "The supported operating systems properties." + } + } + }, + "SupportedOSDetails": { + "description": "Supported operating system details.", + "type": "object", + "properties": { + "osName": { + "description": "The name.", + "type": "string" + }, + "osType": { + "description": "The type.", + "type": "string" + }, + "osVersions": { + "description": "The list of version for operating system.", + "type": "array", + "items": { + "$ref": "#/definitions/OSVersionWrapper" + } + } + } + }, + "SupportedOSProperties": { + "description": "Supported operating systems properties.", + "type": "object", + "properties": { + "supportedOsList": { + "description": "The supported operating systems property list.", + "type": "array", + "items": { + "$ref": "#/definitions/SupportedOSProperty" + } + } + } + }, + "SupportedOSProperty": { + "description": "Supported operating systems property.", + "type": "object", + "properties": { + "instanceType": { + "description": "The replication provider type.", + "type": "string" + }, + "supportedOs": { + "description": "The list of supported operating systems.", + "type": "array", + "items": { + "$ref": "#/definitions/SupportedOSDetails" + } + } + } + }, + "SwitchProtectionInput": { + "description": "Switch protection input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/SwitchProtectionInputProperties", + "description": "Switch protection properties." + } + } + }, + "SwitchProtectionInputProperties": { + "description": "Switch protection input properties.", + "type": "object", + "properties": { + "replicationProtectedItemName": { + "description": "The unique replication protected item name.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/SwitchProtectionProviderSpecificInput", + "description": "Provider specific switch protection input." + } + } + }, + "SwitchProtectionJobDetails": { + "description": "This class represents details for switch protection job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": { + "newReplicationProtectedItemId": { + "description": "ARM Id of the new replication protected item.", + "type": "string" + } + }, + "x-ms-discriminator-value": "SwitchProtectionJobDetails" + }, + "SwitchProtectionProviderSpecificInput": { + "description": "Provider specific switch protection input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the Instance type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "TargetComputeSize": { + "description": "Represents applicable recovery vm sizes.", + "type": "object", + "properties": { + "id": { + "description": "The Id.", + "type": "string" + }, + "name": { + "description": "The name.", + "type": "string" + }, + "type": { + "description": "The Type of the object.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/TargetComputeSizeProperties", + "description": "The custom data." + } + } + }, + "TargetComputeSizeCollection": { + "description": "Target compute size collection.", + "type": "object", + "properties": { + "value": { + "description": "The list of target compute sizes.", + "type": "array", + "items": { + "$ref": "#/definitions/TargetComputeSize" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "TargetComputeSizeProperties": { + "description": "Represents applicable recovery vm sizes properties.", + "type": "object", + "properties": { + "name": { + "description": "Target compute size name.", + "type": "string" + }, + "friendlyName": { + "description": "Target compute size display name.", + "type": "string" + }, + "cpuCoresCount": { + "format": "int32", + "description": "The maximum cpu cores count supported by target compute size.", + "type": "integer" + }, + "vCPUsAvailable": { + "format": "int32", + "description": "The Available vCPUs supported by target compute size.", + "type": "integer", + "readOnly": true + }, + "memoryInGB": { + "format": "double", + "description": "The maximum memory in GB supported by target compute size.", + "type": "number" + }, + "maxDataDiskCount": { + "format": "int32", + "description": "The maximum data disks count supported by target compute size.", + "type": "integer" + }, + "maxNicsCount": { + "format": "int32", + "description": "The maximum Nics count supported by target compute size.", + "type": "integer" + }, + "errors": { + "description": "The reasons why the target compute size is not applicable for the protected item.", + "type": "array", + "items": { + "$ref": "#/definitions/ComputeSizeErrorDetails" + } + }, + "highIopsSupported": { + "description": "The value indicating whether the target compute size supports high Iops.", + "type": "string" + }, + "hyperVGenerations": { + "description": "The supported HyperV Generations.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "TaskTypeDetails": { + "description": "Task details based on specific task type.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The type of task details.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "TestFailoverCleanupInput": { + "description": "Input definition for test failover cleanup.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/TestFailoverCleanupInputProperties", + "description": "Test failover cleanup input properties." + } + } + }, + "TestFailoverCleanupInputProperties": { + "description": "Input definition for test failover cleanup input properties.", + "type": "object", + "properties": { + "comments": { + "description": "Test failover cleanup comments.", + "maxLength": 1024, + "type": "string" + } + } + }, + "TestFailoverInput": { + "description": "Input definition for test failover.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/TestFailoverInputProperties", + "description": "Test failover input properties." + } + } + }, + "TestFailoverInputProperties": { + "description": "Input definition for test failover input properties.", + "type": "object", + "properties": { + "failoverDirection": { + "description": "Test failover direction.", + "type": "string" + }, + "networkType": { + "description": "Network type to be used for test failover.", + "type": "string" + }, + "networkId": { + "description": "The id of the network to be used for test failover.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/TestFailoverProviderSpecificInput", + "description": "Provider specific settings." + } + } + }, + "TestFailoverJobDetails": { + "description": "This class represents the details for a test failover job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": { + "testFailoverStatus": { + "description": "The test failover status.", + "type": "string" + }, + "comments": { + "description": "The test failover comments.", + "type": "string" + }, + "networkName": { + "description": "The test network name.", + "type": "string" + }, + "networkFriendlyName": { + "description": "The test network friendly name.", + "type": "string" + }, + "networkType": { + "description": "The test network type (see TestFailoverInput enum for possible values).", + "type": "string" + }, + "protectedItemDetails": { + "description": "The test VM details.", + "type": "array", + "items": { + "$ref": "#/definitions/FailoverReplicationProtectedItemDetails" + } + } + }, + "x-ms-discriminator-value": "TestFailoverJobDetails" + }, + "TestFailoverProviderSpecificInput": { + "description": "Provider specific test failover input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "TestMigrateCleanupInput": { + "description": "Input for test migrate cleanup.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/TestMigrateCleanupInputProperties", + "description": "Test migrate cleanup input properties." + } + } + }, + "TestMigrateCleanupInputProperties": { + "description": "Test migrate cleanup input properties.", + "type": "object", + "properties": { + "comments": { + "description": "Test migrate cleanup comments.", + "maxLength": 1024, + "type": "string" + } + } + }, + "TestMigrateInput": { + "description": "Input for test migrate.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/TestMigrateInputProperties", + "description": "Test migrate input properties." + } + } + }, + "TestMigrateInputProperties": { + "description": "Test migrate input properties.", + "required": [ + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/TestMigrateProviderSpecificInput", + "description": "The provider specific details." + } + } + }, + "TestMigrateProviderSpecificInput": { + "description": "Test migrate provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "UnplannedFailoverInput": { + "description": "Input definition for unplanned failover.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UnplannedFailoverInputProperties", + "description": "Unplanned failover input properties." + } + } + }, + "UnplannedFailoverInputProperties": { + "description": "Input definition for unplanned failover input properties.", + "type": "object", + "properties": { + "failoverDirection": { + "description": "Failover direction.", + "type": "string" + }, + "sourceSiteOperations": { + "description": "Source site operations status.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput", + "description": "Provider specific settings." + } + } + }, + "UnplannedFailoverProviderSpecificInput": { + "description": "Provider specific unplanned failover input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "UpdateApplianceForReplicationProtectedItemInput": { + "description": "Update appliance for replication protected item input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateApplianceForReplicationProtectedItemInputProperties", + "description": "Update appliance replication protected item properties." + } + } + }, + "UpdateApplianceForReplicationProtectedItemInputProperties": { + "description": "Update appliance for protected item input properties.", + "required": [ + "targetApplianceId", + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "targetApplianceId": { + "description": "The target appliance Id.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/UpdateApplianceForReplicationProtectedItemProviderSpecificInput", + "description": "The provider specific input to update replication protected item." + } + } + }, + "UpdateApplianceForReplicationProtectedItemProviderSpecificInput": { + "description": "Update replication protected item provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "UpdateDiskInput": { + "description": "Disk input for update.", + "required": [ + "diskId" + ], + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "targetDiskName": { + "description": "The target disk name.", + "type": "string" + } + } + }, + "UpdateMigrationItemInput": { + "description": "Update migration item input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateMigrationItemInputProperties", + "description": "Update migration item input properties." + } + } + }, + "UpdateMigrationItemInputProperties": { + "description": "Update migration item input properties.", + "required": [ + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/UpdateMigrationItemProviderSpecificInput", + "description": "The provider specific input to update migration item." + } + } + }, + "UpdateMigrationItemProviderSpecificInput": { + "description": "Update migration item provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "UpdateMobilityServiceRequest": { + "description": "Request to update the mobility service on a protected item.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateMobilityServiceRequestProperties", + "description": "The properties of the update mobility service request." + } + } + }, + "UpdateMobilityServiceRequestProperties": { + "description": "The properties of an update mobility service request.", + "type": "object", + "properties": { + "runAsAccountId": { + "description": "The CS run as account Id.", + "type": "string" + } + } + }, + "UpdateNetworkMappingInput": { + "description": "Update network mapping input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateNetworkMappingInputProperties", + "description": "The input properties needed to update network mapping." + } + } + }, + "UpdateNetworkMappingInputProperties": { + "description": "Common input details for network mapping operation.", + "type": "object", + "properties": { + "recoveryFabricName": { + "description": "Recovery fabric name.", + "type": "string" + }, + "recoveryNetworkId": { + "description": "Recovery network Id.", + "type": "string" + }, + "fabricSpecificDetails": { + "$ref": "#/definitions/FabricSpecificUpdateNetworkMappingInput", + "description": "Fabrics specific input network Id." + } + } + }, + "UpdatePolicyInput": { + "description": "Update policy input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdatePolicyInputProperties", + "description": "The ReplicationProviderSettings." + } + } + }, + "UpdatePolicyInputProperties": { + "description": "Policy update properties.", + "type": "object", + "properties": { + "replicationProviderSettings": { + "$ref": "#/definitions/PolicyProviderSpecificInput", + "description": "The ReplicationProviderSettings." + } + } + }, + "UpdateProtectionContainerMappingInput": { + "description": "Container pairing update input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateProtectionContainerMappingInputProperties", + "description": "Update protection container mapping input properties." + } + } + }, + "UpdateProtectionContainerMappingInputProperties": { + "description": "Container pairing update input.", + "type": "object", + "properties": { + "providerSpecificInput": { + "$ref": "#/definitions/ReplicationProviderSpecificUpdateContainerMappingInput", + "description": "Provider specific input for updating protection container mapping." + } + } + }, + "UpdateRecoveryPlanInput": { + "description": "Update recovery plan input class.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateRecoveryPlanInputProperties", + "description": "Recovery plan update properties." + } + } + }, + "UpdateRecoveryPlanInputProperties": { + "description": "Recovery plan update properties.", + "type": "object", + "properties": { + "groups": { + "description": "The recovery plan groups.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPlanGroup" + } + } + } + }, + "UpdateReplicationProtectedItemInput": { + "description": "Update replication protected item input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateReplicationProtectedItemInputProperties", + "description": "Update replication protected item properties." + } + } + }, + "UpdateReplicationProtectedItemInputProperties": { + "description": "Update protected item input properties.", + "type": "object", + "properties": { + "recoveryAzureVMName": { + "description": "Target Azure VM name given by the user.", + "type": "string" + }, + "recoveryAzureVMSize": { + "description": "Target Azure VM size.", + "type": "string" + }, + "selectedRecoveryAzureNetworkId": { + "description": "Target Azure Network Id.", + "type": "string" + }, + "selectedTfoAzureNetworkId": { + "description": "The Azure Network Id for test failover.", + "type": "string" + }, + "selectedSourceNicId": { + "description": "The selected source nic Id which will be used as the primary nic during failover.", + "type": "string" + }, + "enableRdpOnTargetOption": { + "description": "The selected option to enable RDP\\SSH on target vm after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum.", + "type": "string" + }, + "vmNics": { + "description": "The list of VM nic details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMNicInputDetails" + } + }, + "licenseType": { + "description": "License type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "recoveryAvailabilitySetId": { + "description": "The target availability set Id.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/UpdateReplicationProtectedItemProviderInput", + "description": "The provider specific input to update replication protected item." + } + } + }, + "UpdateReplicationProtectedItemProviderInput": { + "description": "Update replication protected item provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "UpdateVCenterRequest": { + "description": "Input required to update vCenter.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateVCenterRequestProperties", + "description": "The update VCenter Request Properties." + } + } + }, + "UpdateVCenterRequestProperties": { + "description": "The properties of an update vCenter request.", + "type": "object", + "properties": { + "friendlyName": { + "description": "The friendly name of the vCenter.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address of the vCenter to be discovered.", + "type": "string" + }, + "processServerId": { + "description": "The process server Id from where the update can be orchestrated.", + "type": "string" + }, + "port": { + "description": "The port number for discovery.", + "type": "string" + }, + "runAsAccountId": { + "description": "The CS account Id which has privileges to update the vCenter.", + "type": "string" + } + } + }, + "VaultHealthDetails": { + "description": "Vault health details definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/VaultHealthProperties", + "description": "The vault health related data." + } + } + }, + "VaultHealthProperties": { + "description": "class to define the health summary of the Vault.", + "type": "object", + "properties": { + "vaultErrors": { + "description": "The list of errors on the vault.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + }, + "protectedItemsHealth": { + "$ref": "#/definitions/ResourceHealthSummary", + "description": "The list of the health detail of the protected items in the vault." + }, + "fabricsHealth": { + "$ref": "#/definitions/ResourceHealthSummary", + "description": "The list of the health detail of the fabrics in the vault." + }, + "containersHealth": { + "$ref": "#/definitions/ResourceHealthSummary", + "description": "The list of the health detail of the containers in the vault." + } + } + }, + "VaultSetting": { + "description": "Vault setting.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/VaultSettingProperties", + "description": "The vault setting properties." + } + } + }, + "VaultSettingCollection": { + "description": "Vault setting collection.", + "type": "object", + "properties": { + "value": { + "description": "The list of vault setting.", + "type": "array", + "items": { + "$ref": "#/definitions/VaultSetting" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "VaultSettingCreationInput": { + "description": "Input to create vault setting.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/VaultSettingCreationInputProperties", + "description": "Vault setting creation input properties." + } + } + }, + "VaultSettingCreationInputProperties": { + "description": "Input to create vault setting.", + "type": "object", + "properties": { + "migrationSolutionId": { + "description": "The migration solution Id.", + "type": "string" + }, + "vmwareToAzureProviderType": { + "description": "VMware to Azure provider type.", + "type": "string" + } + } + }, + "VaultSettingProperties": { + "description": "Vault setting properties.", + "type": "object", + "properties": { + "migrationSolutionId": { + "description": "The migration solution ARM Id.", + "type": "string" + }, + "vmwareToAzureProviderType": { + "description": "VMware to Azure provider type.", + "type": "string" + } + } + }, + "VCenter": { + "description": "vCenter definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/VCenterProperties", + "description": "VCenter related data." + } + } + }, + "VCenterCollection": { + "description": "Collection of vCenter details.", + "type": "object", + "properties": { + "value": { + "description": "The vCenter details.", + "type": "array", + "items": { + "$ref": "#/definitions/VCenter" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "VCenterProperties": { + "description": "vCenter properties.", + "type": "object", + "properties": { + "friendlyName": { + "description": "Friendly name of the vCenter.", + "type": "string" + }, + "internalId": { + "description": "VCenter internal ID.", + "type": "string" + }, + "lastHeartbeat": { + "format": "date-time", + "description": "The time when the last heartbeat was received by vCenter.", + "type": "string" + }, + "discoveryStatus": { + "description": "The VCenter discovery status.", + "type": "string" + }, + "processServerId": { + "description": "The process server Id.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address of the vCenter.", + "type": "string" + }, + "infrastructureId": { + "description": "The infrastructure Id of vCenter.", + "type": "string" + }, + "port": { + "description": "The port number for discovery.", + "type": "string" + }, + "runAsAccountId": { + "description": "The account Id which has privileges to discover the vCenter.", + "type": "string" + }, + "fabricArmResourceName": { + "description": "The ARM resource name of the fabric containing this VCenter.", + "type": "string" + }, + "healthErrors": { + "description": "The health errors for this VCenter.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + } + } + }, + "VersionDetails": { + "description": "Version related details.", + "type": "object", + "properties": { + "version": { + "description": "The agent version.", + "type": "string" + }, + "expiryDate": { + "format": "date-time", + "description": "Version expiry date.", + "type": "string" + }, + "status": { + "description": "A value indicating whether security update required.", + "enum": [ + "Supported", + "NotSupported", + "Deprecated", + "UpdateRequired", + "SecurityUpdateRequired" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentVersionStatus", + "modelAsString": true + } + } + } + }, + "VirtualMachineTaskDetails": { + "description": "This class represents the virtual machine task details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobTaskDetails" + } + ], + "properties": { + "skippedReason": { + "description": "The skipped reason.", + "type": "string" + }, + "skippedReasonString": { + "description": "The skipped reason string.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VirtualMachineTaskDetails" + }, + "VmmDetails": { + "description": "VMM fabric specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificDetails" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VMM" + }, + "VmmToAzureCreateNetworkMappingInput": { + "description": "Create network mappings input properties/behavior specific to Vmm to Azure Network mapping.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificCreateNetworkMappingInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VmmToAzure" + }, + "VmmToAzureNetworkMappingSettings": { + "description": "E2A Network Mapping fabric specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkMappingFabricSpecificSettings" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VmmToAzure" + }, + "VmmToAzureUpdateNetworkMappingInput": { + "description": "Update network mappings input properties/behavior specific to vmm to azure.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificUpdateNetworkMappingInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VmmToAzure" + }, + "VmmToVmmCreateNetworkMappingInput": { + "description": "Create network mappings input properties/behavior specific to vmm to vmm Network mapping.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificCreateNetworkMappingInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VmmToVmm" + }, + "VmmToVmmNetworkMappingSettings": { + "description": "E2E Network Mapping fabric specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkMappingFabricSpecificSettings" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VmmToVmm" + }, + "VmmToVmmUpdateNetworkMappingInput": { + "description": "Update network mappings input properties/behavior specific to vmm to vmm.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificUpdateNetworkMappingInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VmmToVmm" + }, + "VmmVirtualMachineDetails": { + "description": "VMM fabric provider specific VM settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HyperVVirtualMachineDetails" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VmmVirtualMachine" + }, + "VMNicDetails": { + "description": "Hyper V VM network details.", + "type": "object", + "properties": { + "nicId": { + "description": "The nic Id.", + "type": "string" + }, + "replicaNicId": { + "description": "The replica nic Id.", + "type": "string" + }, + "sourceNicArmId": { + "description": "The source nic ARM Id.", + "type": "string" + }, + "vMNetworkName": { + "description": "VM network name.", + "type": "string" + }, + "recoveryVMNetworkId": { + "description": "Recovery VM network Id.", + "type": "string" + }, + "ipConfigs": { + "description": "The IP configurations of the NIC.", + "type": "array", + "items": { + "$ref": "#/definitions/IPConfigDetails" + } + }, + "selectionType": { + "description": "Selection type for failover.", + "type": "string" + }, + "recoveryNetworkSecurityGroupId": { + "description": "The id of the NSG associated with the NIC.", + "type": "string" + }, + "enableAcceleratedNetworkingOnRecovery": { + "description": "A value indicating whether the NIC has accelerated networking enabled.", + "type": "boolean" + }, + "tfoVMNetworkId": { + "description": "The network to be used by NIC during test failover.", + "type": "string" + }, + "tfoNetworkSecurityGroupId": { + "description": "The NSG to be used by NIC during test failover.", + "type": "string" + }, + "enableAcceleratedNetworkingOnTfo": { + "description": "Whether the TFO NIC has accelerated networking enabled.", + "type": "boolean" + }, + "recoveryNicName": { + "description": "The name of the NIC to be used when creating target NICs.", + "type": "string" + }, + "recoveryNicResourceGroupName": { + "description": "The resource group of the NIC to be used when creating target NICs.", + "type": "string" + }, + "reuseExistingNic": { + "description": "A value indicating whether an existing NIC is allowed to be reused during failover subject to availability.", + "type": "boolean", + "default": false + }, + "tfoRecoveryNicName": { + "description": "The name of the NIC to be used when creating target NICs in TFO.", + "type": "string" + }, + "tfoRecoveryNicResourceGroupName": { + "description": "The resource group of the NIC to be used when creating target NICs in TFO.", + "type": "string" + }, + "tfoReuseExistingNic": { + "description": "A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability.", + "type": "boolean", + "default": false + }, + "targetNicName": { + "description": "Target NIC name.", + "type": "string" + } + } + }, + "VMNicInputDetails": { + "description": "Hyper V VM network input details.", + "type": "object", + "properties": { + "nicId": { + "description": "The nic Id.", + "type": "string" + }, + "ipConfigs": { + "description": "The IP configurations to be used by NIC during test failover and failover.", + "type": "array", + "items": { + "$ref": "#/definitions/IPConfigInputDetails" + } + }, + "selectionType": { + "description": "Selection type for failover.", + "type": "string" + }, + "recoveryNetworkSecurityGroupId": { + "description": "The id of the NSG associated with the NIC.", + "type": "string" + }, + "enableAcceleratedNetworkingOnRecovery": { + "description": "Whether the NIC has accelerated networking enabled.", + "type": "boolean" + }, + "tfoNetworkSecurityGroupId": { + "description": "The NSG to be used by NIC during test failover.", + "type": "string" + }, + "enableAcceleratedNetworkingOnTfo": { + "description": "Whether the test NIC has accelerated networking enabled.", + "type": "boolean" + }, + "recoveryNicName": { + "description": "The name of the NIC to be used when creating target NICs.", + "type": "string" + }, + "recoveryNicResourceGroupName": { + "description": "The resource group of the NIC to be used when creating target NICs.", + "type": "string" + }, + "reuseExistingNic": { + "description": "A value indicating whether an existing NIC is allowed to be reused during failover subject to availability.", + "type": "boolean" + }, + "tfoNicName": { + "description": "The name of the NIC to be used when creating target NICs in TFO.", + "type": "string" + }, + "tfoNicResourceGroupName": { + "description": "The resource group of the NIC to be used when creating target NICs in TFO.", + "type": "string" + }, + "tfoReuseExistingNic": { + "description": "A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability.", + "type": "boolean" + }, + "targetNicName": { + "description": "Target NIC name.", + "type": "string" + } + } + }, + "VmNicUpdatesTaskDetails": { + "description": "This class represents the vm NicUpdates task details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskTypeDetails" + } + ], + "properties": { + "vmId": { + "description": "Virtual machine Id.", + "type": "string" + }, + "nicId": { + "description": "Nic Id.", + "type": "string" + }, + "name": { + "description": "Name of the Nic.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VmNicUpdatesTaskDetails" + }, + "VMwareCbtContainerCreationInput": { + "description": "VMwareCbt container creation input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificContainerCreationInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtContainerMappingInput": { + "description": "VMwareCbt container mapping input.", + "required": [ + "keyVaultId", + "keyVaultUri", + "storageAccountId", + "storageAccountSasSecretName", + "serviceBusConnectionStringSecretName", + "targetLocation" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificContainerMappingInput" + } + ], + "properties": { + "keyVaultId": { + "description": "The target key vault ARM Id.", + "type": "string" + }, + "keyVaultUri": { + "description": "The target key vault URL.", + "type": "string" + }, + "storageAccountId": { + "description": "The storage account ARM Id.", + "type": "string" + }, + "storageAccountSasSecretName": { + "description": "The secret name of the storage account.", + "type": "string" + }, + "serviceBusConnectionStringSecretName": { + "description": "The secret name of the service bus connection string.", + "type": "string" + }, + "targetLocation": { + "description": "The target location.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtDiskInput": { + "description": "VMwareCbt disk input.", + "required": [ + "diskId", + "isOSDisk", + "logStorageAccountId", + "logStorageAccountSasSecretName" + ], + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "diskType": { + "description": "The disk type.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + }, + "isOSDisk": { + "description": "A value indicating whether the disk is the OS disk.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string" + }, + "logStorageAccountSasSecretName": { + "description": "The key vault secret name of the log storage account.", + "type": "string" + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM Id.", + "type": "string" + } + } + }, + "VMwareCbtEnableMigrationInput": { + "description": "VMwareCbt specific enable migration input.", + "required": [ + "vmwareMachineId", + "disksToInclude", + "dataMoverRunAsAccountId", + "snapshotRunAsAccountId", + "targetResourceGroupId", + "targetNetworkId", + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnableMigrationProviderSpecificInput" + } + ], + "properties": { + "vmwareMachineId": { + "description": "The ARM Id of the VM discovered in VMware.", + "type": "string" + }, + "disksToInclude": { + "description": "The disks to include list.", + "minLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/VMwareCbtDiskInput" + } + }, + "licenseType": { + "description": "License type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "PAYG", + "AHUB" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true + } + }, + "dataMoverRunAsAccountId": { + "description": "The data mover run as account Id.", + "type": "string" + }, + "snapshotRunAsAccountId": { + "description": "The snapshot run as account Id.", + "type": "string" + }, + "targetVmName": { + "description": "The target VM name.", + "type": "string" + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "targetResourceGroupId": { + "description": "The target resource group ARM Id.", + "type": "string" + }, + "targetNetworkId": { + "description": "The target network ARM Id.", + "type": "string" + }, + "targetSubnetName": { + "description": "The target subnet name.", + "type": "string" + }, + "targetAvailabilitySetId": { + "description": "The target availability set ARM Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group ARM Id.", + "type": "string" + }, + "targetBootDiagnosticsStorageAccountId": { + "description": "The target boot diagnostics storage account ARM Id.", + "type": "string" + }, + "performAutoResync": { + "description": "A value indicating whether auto resync is to be done.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "seedDiskTags": { + "description": "The tags for the seed disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetDiskTags": { + "description": "The tags for the target disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtEventDetails": { + "description": "Event details for VMwareCbt provider.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "migrationItemName": { + "description": "The migration item name.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtMigrateInput": { + "description": "VMwareCbt specific migrate input.", + "required": [ + "performShutdown", + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MigrateProviderSpecificInput" + } + ], + "properties": { + "performShutdown": { + "description": "A value indicating whether VM is to be shutdown.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtMigrationDetails": { + "description": "VMwareCbt provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MigrationProviderSpecificSettings" + } + ], + "properties": { + "vmwareMachineId": { + "description": "The ARM Id of the VM discovered in VMware.", + "type": "string", + "readOnly": true + }, + "osType": { + "description": "The type of the OS on the VM.", + "type": "string", + "readOnly": true + }, + "firmwareType": { + "description": "The firmware type.", + "type": "string", + "readOnly": true + }, + "targetGeneration": { + "description": "The target generation.", + "type": "string", + "readOnly": true + }, + "licenseType": { + "description": "License Type of the VM to be used.", + "type": "string" + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "type": "string" + }, + "dataMoverRunAsAccountId": { + "description": "The data mover run as account Id.", + "type": "string", + "readOnly": true + }, + "snapshotRunAsAccountId": { + "description": "The snapshot run as account Id.", + "type": "string", + "readOnly": true + }, + "targetVmName": { + "description": "Target VM name.", + "type": "string" + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "targetLocation": { + "description": "The target location.", + "type": "string", + "readOnly": true + }, + "targetResourceGroupId": { + "description": "The target resource group Id.", + "type": "string" + }, + "targetAvailabilitySetId": { + "description": "The target availability set Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "targetBootDiagnosticsStorageAccountId": { + "description": "The target boot diagnostics storage account ARM Id.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "protectedDisks": { + "description": "The list of protected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/VMwareCbtProtectedDiskDetails" + } + }, + "targetNetworkId": { + "description": "The target network Id.", + "type": "string" + }, + "vmNics": { + "description": "The network details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMwareCbtNicDetails" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "migrationRecoveryPointId": { + "description": "The recovery point Id to which the VM was migrated.", + "type": "string", + "readOnly": true + }, + "lastRecoveryPointReceived": { + "format": "date-time", + "description": "The last recovery point received time.", + "type": "string", + "readOnly": true + }, + "lastRecoveryPointId": { + "description": "The last recovery point Id.", + "type": "string", + "readOnly": true + }, + "initialSeedingProgressPercentage": { + "format": "int32", + "description": "The initial seeding progress percentage.", + "type": "integer", + "readOnly": true + }, + "migrationProgressPercentage": { + "format": "int32", + "description": "The migration progress percentage.", + "type": "integer", + "readOnly": true + }, + "resyncProgressPercentage": { + "format": "int32", + "description": "The resync progress percentage.", + "type": "integer", + "readOnly": true + }, + "initialSeedingRetryCount": { + "format": "int64", + "description": "The initial seeding retry count.", + "type": "integer", + "readOnly": true + }, + "resyncRetryCount": { + "format": "int64", + "description": "The resync retry count.", + "type": "integer", + "readOnly": true + }, + "resyncRequired": { + "description": "A value indicating whether resync is required.", + "type": "string", + "readOnly": true + }, + "resyncState": { + "description": "The resync state.", + "enum": [ + "None", + "PreparedForResynchronization", + "StartedResynchronization" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ResyncState", + "modelAsString": true + } + }, + "performAutoResync": { + "description": "A value indicating whether auto resync is to be done.", + "type": "string" + }, + "seedDiskTags": { + "description": "The tags for the seed disks.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetDiskTags": { + "description": "The tags for the target disks.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtNicDetails": { + "description": "VMwareCbt NIC details.", + "type": "object", + "properties": { + "nicId": { + "description": "The NIC Id.", + "type": "string", + "readOnly": true + }, + "isPrimaryNic": { + "description": "A value indicating whether this is the primary NIC.", + "type": "string" + }, + "sourceIPAddress": { + "description": "The source IP address.", + "type": "string", + "readOnly": true + }, + "sourceIPAddressType": { + "description": "The source IP address type.", + "enum": [ + "Dynamic", + "Static" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "EthernetAddressType", + "modelAsString": true + } + }, + "sourceNetworkId": { + "description": "Source network Id.", + "type": "string", + "readOnly": true + }, + "targetIPAddress": { + "description": "The target IP address.", + "type": "string" + }, + "targetIPAddressType": { + "description": "The target IP address type.", + "enum": [ + "Dynamic", + "Static" + ], + "type": "string", + "x-ms-enum": { + "name": "EthernetAddressType", + "modelAsString": true + } + }, + "targetSubnetName": { + "description": "Target subnet name.", + "type": "string" + }, + "targetNicName": { + "description": "Target NIC name.", + "type": "string" + }, + "isSelectedForMigration": { + "description": "A value indicating whether this NIC is selected for migration.", + "type": "string" + } + } + }, + "VMwareCbtNicInput": { + "description": "VMwareCbt NIC input.", + "required": [ + "nicId", + "isPrimaryNic" + ], + "type": "object", + "properties": { + "nicId": { + "description": "The NIC Id.", + "type": "string" + }, + "isPrimaryNic": { + "description": "A value indicating whether this is the primary NIC.", + "type": "string" + }, + "targetSubnetName": { + "description": "Target subnet name.", + "type": "string" + }, + "targetStaticIPAddress": { + "description": "The static IP address.", + "type": "string" + }, + "isSelectedForMigration": { + "description": "A value indicating whether this NIC is selected for migration.", + "type": "string" + }, + "targetNicName": { + "description": "Target NIC name.", + "type": "string" + } + } + }, + "VMwareCbtPolicyCreationInput": { + "description": "VMware Cbt policy creation input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "recoveryPointHistoryInMinutes": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency (in minutes).", + "type": "integer" + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VmwareCbtPolicyDetails": { + "description": "VMware Cbt specific policy details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPointHistoryInMinutes": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency in minutes.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency in minutes.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtProtectedDiskDetails": { + "description": "VMwareCbt protected disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk id.", + "type": "string", + "readOnly": true + }, + "diskName": { + "description": "The disk name.", + "type": "string", + "readOnly": true + }, + "diskType": { + "description": "The disk type.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + }, + "diskPath": { + "description": "The disk path.", + "type": "string", + "readOnly": true + }, + "isOSDisk": { + "description": "A value indicating whether the disk is the OS disk.", + "type": "string", + "readOnly": true + }, + "capacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer", + "readOnly": true + }, + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string", + "readOnly": true + }, + "logStorageAccountSasSecretName": { + "description": "The key vault secret name of the log storage account.", + "type": "string", + "readOnly": true + }, + "diskEncryptionSetId": { + "description": "The DiskEncryptionSet ARM Id.", + "type": "string", + "readOnly": true + }, + "seedManagedDiskId": { + "description": "The ARM Id of the seed managed disk.", + "type": "string", + "readOnly": true + }, + "targetManagedDiskId": { + "description": "The ARM Id of the target managed disk.", + "type": "string", + "readOnly": true + }, + "targetDiskName": { + "description": "The name for the target managed disk.", + "type": "string" + } + } + }, + "VMwareCbtProtectionContainerMappingDetails": { + "description": "VMwareCbt provider specific container mapping details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionContainerMappingProviderSpecificDetails" + } + ], + "properties": { + "keyVaultId": { + "description": "The target key vault ARM Id.", + "type": "string", + "readOnly": true + }, + "keyVaultUri": { + "description": "The target key vault URI.", + "type": "string", + "readOnly": true + }, + "storageAccountId": { + "description": "The storage account ARM Id.", + "type": "string", + "readOnly": true + }, + "storageAccountSasSecretName": { + "description": "The secret name of the storage account.", + "type": "string", + "readOnly": true + }, + "serviceBusConnectionStringSecretName": { + "description": "The secret name of the service bus connection string.", + "type": "string", + "readOnly": true + }, + "targetLocation": { + "description": "The target location.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtResyncInput": { + "description": "VMwareCbt specific resync input.", + "required": [ + "skipCbtReset", + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResyncProviderSpecificInput" + } + ], + "properties": { + "skipCbtReset": { + "description": "A value indicating whether CBT is to be reset.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtTestMigrateInput": { + "description": "VMwareCbt specific test migrate input.", + "required": [ + "recoveryPointId", + "networkId", + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TestMigrateProviderSpecificInput" + } + ], + "properties": { + "recoveryPointId": { + "description": "The recovery point Id.", + "type": "string" + }, + "networkId": { + "description": "The test network Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtUpdateDiskInput": { + "description": "VMwareCbt disk input for update.", + "required": [ + "diskId" + ], + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "targetDiskName": { + "description": "The target disk name.", + "type": "string" + } + } + }, + "VMwareCbtUpdateMigrationItemInput": { + "description": "VMwareCbt specific update migration item input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UpdateMigrationItemProviderSpecificInput" + } + ], + "properties": { + "targetVmName": { + "description": "The target VM name.", + "type": "string" + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "targetResourceGroupId": { + "description": "The target resource group ARM Id.", + "type": "string" + }, + "targetAvailabilitySetId": { + "description": "The target availability set ARM Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group ARM Id.", + "type": "string" + }, + "targetBootDiagnosticsStorageAccountId": { + "description": "The target boot diagnostics storage account ARM Id.", + "type": "string" + }, + "targetNetworkId": { + "description": "The target network ARM Id.", + "type": "string" + }, + "vmNics": { + "description": "The list of NIC details.", + "minLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/VMwareCbtNicInput" + } + }, + "vmDisks": { + "description": "The list of disk update properties.", + "minLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/VMwareCbtUpdateDiskInput" + } + }, + "licenseType": { + "description": "The license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "sqlServerLicenseType": { + "description": "The SQL Server license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "PAYG", + "AHUB" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true + } + }, + "performAutoResync": { + "description": "A value indicating whether auto resync is to be done.", + "type": "string" + }, + "targetVmTags": { + "description": "The target VM tags.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetDiskTags": { + "description": "The tags for the target disks.", + "maxLength": 49, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetNicTags": { + "description": "The tags for the target NICs.", + "maxLength": 50, + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareDetails": { + "description": "Store the fabric details specific to the VMware fabric.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificDetails" + } + ], + "properties": { + "processServers": { + "description": "The list of Process Servers associated with the fabric.", + "type": "array", + "items": { + "$ref": "#/definitions/ProcessServer" + } + }, + "masterTargetServers": { + "description": "The list of Master Target servers associated with the fabric.", + "type": "array", + "items": { + "$ref": "#/definitions/MasterTargetServer" + } + }, + "runAsAccounts": { + "description": "The list of run as accounts created on the server.", + "type": "array", + "items": { + "$ref": "#/definitions/RunAsAccount" + } + }, + "replicationPairCount": { + "description": "The number of replication pairs configured in this CS.", + "type": "string" + }, + "processServerCount": { + "description": "The number of process servers.", + "type": "string" + }, + "agentCount": { + "description": "The number of source and target servers configured to talk to this CS.", + "type": "string" + }, + "protectedServers": { + "description": "The number of protected servers.", + "type": "string" + }, + "systemLoad": { + "description": "The percentage of the system load.", + "type": "string" + }, + "systemLoadStatus": { + "description": "The system load status.", + "type": "string" + }, + "cpuLoad": { + "description": "The percentage of the CPU load.", + "type": "string" + }, + "cpuLoadStatus": { + "description": "The CPU load status.", + "type": "string" + }, + "totalMemoryInBytes": { + "format": "int64", + "description": "The total memory.", + "type": "integer" + }, + "availableMemoryInBytes": { + "format": "int64", + "description": "The available memory.", + "type": "integer" + }, + "memoryUsageStatus": { + "description": "The memory usage status.", + "type": "string" + }, + "totalSpaceInBytes": { + "format": "int64", + "description": "The total space.", + "type": "integer" + }, + "availableSpaceInBytes": { + "format": "int64", + "description": "The available space.", + "type": "integer" + }, + "spaceUsageStatus": { + "description": "The space usage status.", + "type": "string" + }, + "webLoad": { + "description": "The web load.", + "type": "string" + }, + "webLoadStatus": { + "description": "The web load status.", + "type": "string" + }, + "databaseServerLoad": { + "description": "The database server load.", + "type": "string" + }, + "databaseServerLoadStatus": { + "description": "The database server load status.", + "type": "string" + }, + "csServiceStatus": { + "description": "The CS service status.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address.", + "type": "string" + }, + "agentVersion": { + "description": "The agent Version.", + "type": "string" + }, + "hostName": { + "description": "The host name.", + "type": "string" + }, + "lastHeartbeat": { + "format": "date-time", + "description": "The last heartbeat received from CS server.", + "type": "string" + }, + "versionStatus": { + "description": "Version status.", + "type": "string" + }, + "sslCertExpiryDate": { + "format": "date-time", + "description": "CS SSL cert expiry date.", + "type": "string" + }, + "sslCertExpiryRemainingDays": { + "format": "int32", + "description": "CS SSL cert expiry date.", + "type": "integer" + }, + "psTemplateVersion": { + "description": "PS template version.", + "type": "string" + }, + "agentExpiryDate": { + "format": "date-time", + "description": "Agent expiry date.", + "type": "string" + }, + "agentVersionDetails": { + "$ref": "#/definitions/VersionDetails", + "description": "The agent version details." + } + }, + "x-ms-discriminator-value": "VMware" + }, + "VMwareV2FabricCreationInput": { + "description": "VMwareV2 fabric provider specific settings.", + "required": [ + "migrationSolutionId" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificCreationInput" + } + ], + "properties": { + "vmwareSiteId": { + "description": "The ARM Id of the VMware site.", + "type": "string" + }, + "physicalSiteId": { + "description": "The ARM Id of the physical site.", + "type": "string" + }, + "migrationSolutionId": { + "description": "The ARM Id of the migration solution.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VMwareV2" + }, + "VMwareV2FabricSpecificDetails": { + "description": "VMwareV2 fabric specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificDetails" + } + ], + "properties": { + "vmwareSiteId": { + "description": "The ARM Id of the VMware site.", + "type": "string", + "readOnly": true + }, + "physicalSiteId": { + "description": "The ARM Id of the physical site.", + "type": "string", + "readOnly": true + }, + "migrationSolutionId": { + "description": "The Migration solution ARM Id.", + "type": "string", + "readOnly": true + }, + "serviceEndpoint": { + "description": "The service endpoint.", + "type": "string", + "readOnly": true + }, + "serviceResourceId": { + "description": "The service resource Id.", + "type": "string", + "readOnly": true + }, + "serviceContainerId": { + "description": "The service container Id.", + "type": "string", + "readOnly": true + }, + "processServers": { + "description": "The list of process servers.", + "type": "array", + "items": { + "$ref": "#/definitions/ProcessServerDetails" + }, + "readOnly": true + } + }, + "x-ms-discriminator-value": "VMwareV2" + }, + "VMwareVirtualMachineDetails": { + "description": "VMware provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConfigurationSettings" + } + ], + "properties": { + "agentGeneratedId": { + "description": "The ID generated by the InMage agent after it gets installed on guest. This is the ID to be used during InMage CreateProtection.", + "type": "string" + }, + "agentInstalled": { + "description": "The value indicating if InMage scout agent is installed on guest.", + "type": "string" + }, + "osType": { + "description": "The OsType installed on VM.", + "type": "string" + }, + "agentVersion": { + "description": "The agent version.", + "type": "string" + }, + "ipAddress": { + "description": "The IP address.", + "type": "string" + }, + "poweredOn": { + "description": "The value indicating whether VM is powered on.", + "type": "string" + }, + "vCenterInfrastructureId": { + "description": "The VCenter infrastructure Id.", + "type": "string" + }, + "discoveryType": { + "description": "A value indicating the discovery type of the machine. Value can be vCenter or physical.", + "type": "string" + }, + "diskDetails": { + "description": "The disk details.", + "type": "array", + "items": { + "$ref": "#/definitions/InMageDiskDetails" + } + }, + "validationErrors": { + "description": "The validation errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + } + } + }, + "x-ms-discriminator-value": "VMwareVirtualMachine" + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription Id.", + "required": true, + "type": "string" + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group where the recovery services vault is present.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ResourceName": { + "name": "resourceName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account." + }, + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "tags": [] +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/readme.go.md b/specification/recoveryservicessiterecovery/resource-manager/readme.go.md index 64290e8aa1ed..5daa6ee7d83c 100644 --- a/specification/recoveryservicessiterecovery/resource-manager/readme.go.md +++ b/specification/recoveryservicessiterecovery/resource-manager/readme.go.md @@ -13,12 +13,22 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2021-06 - tag: package-2021-02 - tag: package-2018-07 - tag: package-2018-01 - tag: package-2016-08 ``` +### Tag: package-2021-06 and go + +These settings apply only when `--tag=package-2021-06 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2021-06' && $(go) +output-folder: $(go-sdk-folder)/services/recoveryservices/mgmt/2021-06-01/$(namespace) +``` + ### Tag: package-2021-02 and go These settings apply only when `--tag=package-2021-02 --go` is specified on the command line. diff --git a/specification/recoveryservicessiterecovery/resource-manager/readme.md b/specification/recoveryservicessiterecovery/resource-manager/readme.md index 95586209c9a7..1eccd8ce1404 100644 --- a/specification/recoveryservicessiterecovery/resource-manager/readme.md +++ b/specification/recoveryservicessiterecovery/resource-manager/readme.md @@ -54,7 +54,7 @@ These are the global settings for the RecoveryServicesSiteRecovery API. ``` yaml openapi-type: arm -tag: package-2021-03 +tag: package-2021-06 directive: - where: - $.paths @@ -62,20 +62,36 @@ directive: - UniqueResourcePaths ``` +### Tag: package-2021-06 +These settings apply only when `--tag=package-2021-06` is specified on the command line. + +```yaml $(tag) == 'package-2021-06' +input-file: + - Microsoft.RecoveryServices/stable/2021-06-01/service.json +``` +### Tag: package-2021-04 + +These settings apply only when `--tag=package-2021-04` is specified on the command line. + +```yaml $(tag) == 'package-2021-04' +input-file: + - Microsoft.RecoveryServices/stable/2021-04-01/service.json +``` ### Tag: package-2021-03 These settings apply only when `--tag=package-2021-03` is specified on the command line. -```yaml $(tag) == 'package-2021-03' +``` yaml $(tag) == 'package-2021-03' input-file: - Microsoft.RecoveryServices/stable/2021-03-01/service.json ``` + ### Tag: package-2021-02 These settings apply only when `--tag=package-2021-02` is specified on the command line. -```yaml $(tag) == 'package-2021-02' +``` yaml $(tag) == 'package-2021-02' input-file: - Microsoft.RecoveryServices/stable/2021-02-10/service.json ``` @@ -119,7 +135,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js @@ -149,7 +165,10 @@ csharp: See configuration in [readme.go.md](./readme.go.md) +## Python + +See configuration in [readme.python.md](./readme.python.md) + ## Java See configuration in [readme.java.md](./readme.java.md) - diff --git a/specification/recoveryservicessiterecovery/resource-manager/readme.python.md b/specification/recoveryservicessiterecovery/resource-manager/readme.python.md new file mode 100644 index 000000000000..511e3ca87bac --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/readme.python.md @@ -0,0 +1,23 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(python) && $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +namespace: azure.mgmt.recoveryservicessiterecovery +package-name: azure-mgmt-recoveryservicessiterecovery +package-version: 1.0.0b1 +clear-output-folder: true +``` + +``` yaml $(python) && $(python-mode) == 'update' && $(track2) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/recoveryservices/azure-mgmt-recoveryservicessiterecovery/azure/mgmt/recoveryservicessiterecovery +``` + +``` yaml $(python) && $(python-mode) == 'create' && $(track2) +basic-setup-py: true +output-folder: $(python-sdks-folder)/recoveryservices/azure-mgmt-recoveryservicessiterecovery +``` diff --git a/specification/redis/resource-manager/readme.go.md b/specification/redis/resource-manager/readme.go.md index 307213b58cbb..925e0395be6f 100644 --- a/specification/redis/resource-manager/readme.go.md +++ b/specification/redis/resource-manager/readme.go.md @@ -2,17 +2,26 @@ These settings apply only when `--go` is specified on the command line. -``` yaml $(go) +``` yaml $(go) && !$(track2) go: license-header: MICROSOFT_MIT_NO_VERSION namespace: redis clear-output-folder: true ``` +``` yaml $(go) && $(track2) +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/redis/armredis +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 - tag: package-2020-06 - tag: package-2019-07-preview - tag: package-2018-03 @@ -22,6 +31,15 @@ batch: - tag: package-2015-08 ``` +### Tag: package-2020-12 and go + +These settings apply only when `--tag=package-2020-12 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2020-12' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-12-01/$(namespace) +``` + ### Tag: package-2020-06 and go These settings apply only when `--tag=package-2020-06 --go` is specified on the command line. diff --git a/specification/redis/resource-manager/readme.md b/specification/redis/resource-manager/readme.md index 320429f7b641..6072ec6a582e 100644 --- a/specification/redis/resource-manager/readme.md +++ b/specification/redis/resource-manager/readme.md @@ -113,7 +113,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js @@ -121,6 +121,7 @@ swagger-to-sdk: - repo: azure-sdk-for-ruby after_scripts: - bundle install && rake arm:regen_all_profiles['azure_mgmt_redis'] + - repo: azure-sdk-for-python-track2 - repo: azure-resource-manager-schemas ``` @@ -141,47 +142,7 @@ csharp: ## Python -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.redis - package-name: azure-mgmt-redis - package-version: 5.0.0 - clear-output-folder: true -``` - -``` yaml $(python) && $(track2) -python-mode: update -azure-arm: true -license-header: MICROSOFT_MIT_NO_VERSION -namespace: azure.mgmt.redis -package-name: azure-mgmt-redis -package-version: 5.0.0 -clear-output-folder: true -``` - -``` yaml $(python) && $(python-mode) == 'update' -no-namespace-folders: true -output-folder: $(python-sdks-folder)/redis/azure-mgmt-redis/azure/mgmt/redis -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/redis/azure-mgmt-redis/azure/mgmt/redis -``` - -``` yaml $(python) && $(python-mode) == 'create' -basic-setup-py: true -output-folder: $(python-sdks-folder)/redis/azure-mgmt-redis -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/redis/azure-mgmt-redis -``` +See configuration in [readme.python.md](./readme.python.md) ## Go diff --git a/specification/redis/resource-manager/readme.python.md b/specification/redis/resource-manager/readme.python.md new file mode 100644 index 000000000000..dd1fa807486b --- /dev/null +++ b/specification/redis/resource-manager/readme.python.md @@ -0,0 +1,26 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + + +``` yaml $(python) && $(track2) +python-mode: update +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +namespace: azure.mgmt.redis +package-name: azure-mgmt-redis +package-version: 12.0.0b1 +clear-output-folder: true +``` + +``` yaml $(python) && $(python-mode) == 'update' && $(track2) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/redis/azure-mgmt-redis/azure/mgmt/redis +``` + +``` yaml $(python) && $(python-mode) == 'create' && $(track2) +basic-setup-py: true +output-folder: $(python-sdks-folder)/redis/azure-mgmt-redis +``` \ No newline at end of file diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/OperationsStatusGet.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/OperationsStatusGet.json new file mode 100644 index 000000000000..b04390088ed4 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/OperationsStatusGet.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "West US", + "operationId": "testoperationid", + "api-version": "2021-08-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.Cache/locations/westus/operationsStatus/testoperationid", + "name": "testoperationid", + "startTime": "2017-01-01T13:13:13.933Z", + "endTime": "2017-01-01T16:13:13.933Z", + "status": "Succeeded" + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseCreate.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseCreate.json new file mode 100644 index 000000000000..a29839d8a55d --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseCreate.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2021-08-01", + "subscriptionId": "subid", + "parameters": { + "location": "West US", + "sku": { + "name": "EnterpriseFlash_F300", + "capacity": 3 + }, + "zones": [ + "1", + "2", + "3" + ], + "properties": { + "minimumTlsVersion": "1.2" + }, + "tags": { + "tag1": "value1" + } + } + }, + "responses": { + "201": { + "body": { + "name": "cache1", + "type": "Microsoft.Cache/redisEnterprise", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1", + "location": "West US", + "sku": { + "name": "EnterpriseFlash_F300", + "capacity": 3 + }, + "zones": [ + "1", + "2", + "3" + ], + "properties": { + "provisioningState": "Creating", + "resourceState": "Creating", + "hostName": "cache1.westus.something.azure.net", + "redisVersion": "5", + "minimumTlsVersion": "1.2" + }, + "tags": { + "tag1": "value1" + } + } + }, + "200": { + "body": { + "name": "cache1", + "type": "Microsoft.Cache/redisEnterprise", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1", + "location": "West US", + "sku": { + "name": "EnterpriseFlash_F300", + "capacity": 3 + }, + "zones": [ + "1", + "2", + "3" + ], + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Running", + "hostName": "cache1.westus.something.azure.net", + "redisVersion": "5", + "minimumTlsVersion": "1.2" + }, + "tags": { + "tag1": "value1" + } + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDatabasesCreate.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDatabasesCreate.json new file mode 100644 index 000000000000..391e2dd36f9e --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDatabasesCreate.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2021-08-01", + "subscriptionId": "subid", + "parameters": { + "properties": { + "clientProtocol": "Encrypted", + "clusteringPolicy": "EnterpriseCluster", + "evictionPolicy": "AllKeysLRU", + "persistence": { + "aofEnabled": true, + "aofFrequency": "1s" + }, + "port": 10000, + "modules": [ + { + "name": "RedisBloom", + "args": "ERROR_RATE 0.00 INITIAL_SIZE 400" + }, + { + "name": "RedisTimeSeries", + "args": "RETENTION_POLICY 20" + }, + { + "name": "RediSearch" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default", + "name": "cache1/default", + "type": "Microsoft.Cache/redisEnterprise/databases", + "properties": { + "provisioningState": "Updating", + "resourceState": "Updating", + "clientProtocol": "Encrypted", + "clusteringPolicy": "EnterpriseCluster", + "evictionPolicy": "AllKeysLRU", + "persistence": { + "aofEnabled": true, + "aofFrequency": "1s" + }, + "port": 10000, + "modules": [ + { + "name": "RedisBloom", + "args": "ERROR_RATE 0.00 INITIAL_SIZE 400", + "version": "1.0.0" + }, + { + "name": "RedisTimeSeries", + "args": "RETENTION_POLICY 20", + "version": "1.0.0" + }, + { + "name": "RediSearch", + "args": "", + "version": "1.0.0" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/db1", + "name": "cache1/db1", + "type": "Microsoft.Cache/redisEnterprise/databases", + "properties": { + "provisioningState": "Creating", + "resourceState": "Creating", + "clientProtocol": "Encrypted", + "clusteringPolicy": "EnterpriseCluster", + "evictionPolicy": "AllKeysLRU", + "persistence": { + "aofEnabled": true, + "aofFrequency": "1s" + }, + "port": 10000, + "modules": [ + { + "name": "RedisBloom", + "args": "ERROR_RATE 0.00 INITIAL_SIZE 400", + "version": "1.0.0" + }, + { + "name": "RedisTimeSeries", + "args": "RETENTION_POLICY 20", + "version": "1.0.0" + }, + { + "name": "RediSearch", + "args": "", + "version": "1.0.0" + } + ] + } + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDatabasesDelete.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDatabasesDelete.json new file mode 100644 index 000000000000..f1378afb0237 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDatabasesDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "databaseName": "db1", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2021-08-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDatabasesExport.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDatabasesExport.json new file mode 100644 index 000000000000..41fa804e56d6 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDatabasesExport.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2021-08-01", + "subscriptionId": "subid", + "parameters": { + "sasUri": "https://contosostorage.blob.core.window.net/urlToBlobContainer?sasKeyParameters" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDatabasesGet.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDatabasesGet.json new file mode 100644 index 000000000000..b81172e7241e --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDatabasesGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2021-08-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default", + "name": "cache1/default", + "type": "Microsoft.Cache/redisEnterprise/databases", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Running", + "clientProtocol": "Encrypted", + "clusteringPolicy": "OSSCluster", + "evictionPolicy": "AllKeysLRU", + "persistence": { + "rdbEnabled": true, + "rdbFrequency": "12h" + }, + "port": 10000, + "modules": [ + { + "name": "RediSearch", + "args": "", + "version": "1.0.0" + } + ] + } + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDatabasesImport.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDatabasesImport.json new file mode 100644 index 000000000000..f23c9535ebea --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDatabasesImport.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2021-08-01", + "subscriptionId": "subid", + "parameters": { + "sasUris": [ + "https://contosostorage.blob.core.window.net/urltoBlobFile1?sasKeyParameters", + "https://contosostorage.blob.core.window.net/urltoBlobFile2?sasKeyParameters" + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDatabasesListByCluster.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDatabasesListByCluster.json new file mode 100644 index 000000000000..64c923bc1d52 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDatabasesListByCluster.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2021-08-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default", + "name": "cache1/default", + "type": "Microsoft.Cache/redisEnterprise/databases", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Running", + "clientProtocol": "Encrypted", + "clusteringPolicy": "OSSCluster", + "evictionPolicy": "AllKeysLRU", + "persistence": { + "rdbEnabled": true, + "rdbFrequency": "12h" + }, + "port": 10000, + "modules": [ + { + "name": "RediSearch", + "args": "", + "version": "1.0.0" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDatabasesListKeys.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDatabasesListKeys.json new file mode 100644 index 000000000000..1ca6f6aa8001 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDatabasesListKeys.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2021-08-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "primaryKey": "", + "secondaryKey": "" + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDatabasesRegenerateKey.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDatabasesRegenerateKey.json new file mode 100644 index 000000000000..f73460a310b2 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDatabasesRegenerateKey.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2021-08-01", + "subscriptionId": "subid", + "parameters": { + "keyType": "Primary" + } + }, + "responses": { + "200": { + "body": { + "primaryKey": "", + "secondaryKey": "" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDatabasesUpdate.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDatabasesUpdate.json new file mode 100644 index 000000000000..062ec7e756f0 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDatabasesUpdate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2021-08-01", + "subscriptionId": "subid", + "parameters": { + "properties": { + "clientProtocol": "Encrypted", + "evictionPolicy": "AllKeysLRU", + "persistence": { + "rdbEnabled": true, + "rdbFrequency": "12h" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default", + "name": "cache1/default", + "type": "Microsoft.Cache/redisEnterprise/databases", + "properties": { + "provisioningState": "Updating", + "resourceState": "Updating", + "clientProtocol": "Encrypted", + "clusteringPolicy": "OSSCluster", + "evictionPolicy": "AllKeysLRU", + "persistence": { + "rdbEnabled": true, + "rdbFrequency": "12h" + }, + "port": 10000, + "modules": [ + { + "name": "RediSearch", + "args": "", + "version": "1.0.0" + } + ] + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDelete.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDelete.json new file mode 100644 index 000000000000..c9847162f9f1 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2021-08-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDeletePrivateEndpointConnection.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..93ce68fce50c --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseDeletePrivateEndpointConnection.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2021-08-01", + "subscriptionId": "subid", + "privateEndpointConnectionName": "pectest01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseGet.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseGet.json new file mode 100644 index 000000000000..3ea6c6ef6fd8 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseGet.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2021-08-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1", + "location": "West US", + "sku": { + "name": "EnterpriseFlash_F300", + "capacity": 3 + }, + "zones": [ + "1", + "2", + "3" + ], + "name": "cache1", + "type": "Microsoft.Cache/redisEnterprise", + "tags": {}, + "properties": { + "hostName": "cache1.westus.something.azure.com", + "provisioningState": "Succeeded", + "resourceState": "Running", + "redisVersion": "6", + "minimumTlsVersion": "1.2", + "privateEndpointConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/privateEndpointConnections/cachePec", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/cachePe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Please approve my connection", + "actionsRequired": "None" + } + } + } + ] + } + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseGetPrivateEndpointConnection.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseGetPrivateEndpointConnection.json new file mode 100644 index 000000000000..1a5e99b7b808 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseGetPrivateEndpointConnection.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2021-08-01", + "subscriptionId": "subid", + "privateEndpointConnectionName": "pectest01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/privateEndpointConnections/pectest01", + "name": "pectest01", + "type": "Microsoft.Cache/redisEnterprise/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseList.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseList.json new file mode 100644 index 000000000000..c7f6ba0ce672 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseList.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2021-08-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1", + "location": "West US", + "sku": { + "name": "EnterpriseFlash_F300", + "capacity": 3 + }, + "name": "cache1", + "type": "Microsoft.Cache/redisEnterprise", + "tags": {}, + "properties": { + "hostName": "cache1.westus.something.azure.com", + "provisioningState": "Succeeded", + "resourceState": "Running", + "redisVersion": "6", + "minimumTlsVersion": "1.2" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseListByResourceGroup.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseListByResourceGroup.json new file mode 100644 index 000000000000..a505b2af8f5c --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseListByResourceGroup.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2021-08-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1", + "location": "West US", + "sku": { + "name": "EnterpriseFlash_F300", + "capacity": 3 + }, + "zones": [ + "1", + "2", + "3" + ], + "name": "cache1", + "type": "Microsoft.Cache/redisEnterprise", + "tags": {}, + "properties": { + "hostName": "cache1.westus.something.azure.com", + "provisioningState": "Succeeded", + "resourceState": "Running", + "redisVersion": "5", + "minimumTlsVersion": "1.2" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseListPrivateEndpointConnections.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseListPrivateEndpointConnections.json new file mode 100644 index 000000000000..ca773c239107 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseListPrivateEndpointConnections.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2021-08-01", + "subscriptionId": "subid", + "privateEndpointConnectionName": "pectest01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/privateEndpointConnections/pectest01", + "name": "pectest01", + "type": "Microsoft.Cache/redisEnterprise/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/privateEndpointConnections/pectest01", + "name": "pectest01", + "type": "Microsoft.Cache/redisEnterprise/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseListPrivateLinkResources.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseListPrivateLinkResources.json new file mode 100644 index 000000000000..305c572e6e1d --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseListPrivateLinkResources.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2021-08-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/privateLinkResources/redisEnterpriseCache", + "name": "redisEnterpriseCache", + "type": "Microsoft.Cache/redisEnterprise/privateLinkResources", + "properties": { + "groupId": "redisEnterpriseCache", + "requiredMembers": [ + "redisEnterpriseCache" + ], + "requiredZoneNames": [ + "privatelink.redisenterprise.cache.windows.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterprisePutPrivateEndpointConnection.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterprisePutPrivateEndpointConnection.json new file mode 100644 index 000000000000..4300ed856aac --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterprisePutPrivateEndpointConnection.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2021-08-01", + "subscriptionId": "subid", + "privateEndpointConnectionName": "pectest01", + "properties": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/privateEndpointConnections/pectest01", + "name": "pectest01", + "type": "Microsoft.Cache/redisEnterprise/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseUpdate.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseUpdate.json new file mode 100644 index 000000000000..e830f94af4e7 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/examples/RedisEnterpriseUpdate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2021-08-01", + "subscriptionId": "subid", + "parameters": { + "sku": { + "name": "EnterpriseFlash_F300", + "capacity": 9 + }, + "properties": { + "minimumTlsVersion": "1.2" + }, + "tags": { + "tag1": "value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1", + "name": "cache1", + "type": "Microsoft.Cache/redisEnterprise", + "location": "West US", + "sku": { + "name": "EnterpriseFlash_F300", + "capacity": 9 + }, + "zones": [ + "1", + "2", + "3" + ], + "tags": { + "tag1": "value1" + }, + "properties": { + "hostName": "cache1.westus.something.azure.com", + "provisioningState": "Updating", + "resourceState": "Updating", + "redisVersion": "5", + "minimumTlsVersion": "1.2" + } + } + }, + "202": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/redisenterprise.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/redisenterprise.json new file mode 100644 index 000000000000..c4154ae0de62 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2021-08-01/redisenterprise.json @@ -0,0 +1,1646 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-08-01", + "title": "RedisEnterpriseManagementClient", + "description": "REST API for managing Redis Enterprise resources in Azure." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Cache/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available REST API operations of the Microsoft.Cache provider.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cache/locations/{location}/operationsStatus/{operationId}": { + "get": { + "tags": [ + "OperationsStatus" + ], + "operationId": "OperationsStatus_Get", + "x-ms-examples": { + "OperationsStatusGet": { + "$ref": "./examples/OperationsStatusGet.json" + } + }, + "description": "Gets the status of operation.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The region the operation is in." + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The operation's unique identifier." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The detailed status of the operation is in the response.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}": { + "put": { + "tags": [ + "RedisEnterprise" + ], + "operationId": "RedisEnterprise_Create", + "x-ms-examples": { + "RedisEnterpriseCreate": { + "$ref": "./examples/RedisEnterpriseCreate.json" + } + }, + "description": "Creates or updates an existing (overwrite/recreate, with potential downtime) cache cluster", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Cluster" + }, + "description": "Parameters supplied to the Create RedisEnterprise operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The cluster was/is being created. Check provisioningState and resourceState to see detailed status.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "200": { + "description": "The cluster was/is being updated. Check provisioningState and resourceState to see detailed status.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "RedisEnterprise" + ], + "operationId": "RedisEnterprise_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "RedisEnterpriseUpdate": { + "$ref": "./examples/RedisEnterpriseUpdate.json" + } + }, + "description": "Updates an existing RedisEnterprise cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterUpdate" + }, + "description": "Parameters supplied to the Update RedisEnterprise operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The cluster was/is being updated. Check provisioningState and resourceState to see detailed status.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "202": { + "description": "The cluster update operation was started. GET the URL in the Azure-AsyncOperation or Location headers to retrieve updated status." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "RedisEnterprise" + ], + "operationId": "RedisEnterprise_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "RedisEnterpriseDelete": { + "$ref": "./examples/RedisEnterpriseDelete.json" + } + }, + "description": "Deletes a RedisEnterprise cache cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The cluster was successfully deleted." + }, + "202": { + "description": "The cluster delete operation was successfully started. GET the URL in the Azure-AsyncOperation or Location headers to retrieve updated status." + }, + "204": { + "description": "The cluster was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "RedisEnterprise" + ], + "operationId": "RedisEnterprise_Get", + "x-ms-examples": { + "RedisEnterpriseGet": { + "$ref": "./examples/RedisEnterpriseGet.json" + } + }, + "description": "Gets information about a RedisEnterprise cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The request succeeded, response body contains the requested details.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise": { + "get": { + "tags": [ + "RedisEnterprise" + ], + "operationId": "RedisEnterprise_ListByResourceGroup", + "x-ms-examples": { + "RedisEnterpriseListByResourceGroup": { + "$ref": "./examples/RedisEnterpriseListByResourceGroup.json" + } + }, + "description": "Lists all RedisEnterprise clusters in a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The list of RedisEnterprise clusters", + "schema": { + "$ref": "#/definitions/ClusterList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cache/redisEnterprise": { + "get": { + "tags": [ + "RedisEnterprise" + ], + "operationId": "RedisEnterprise_List", + "x-ms-examples": { + "RedisEnterpriseList": { + "$ref": "./examples/RedisEnterpriseList.json" + } + }, + "description": "Gets all RedisEnterprise clusters in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The list of RedisEnterprise clusters", + "schema": { + "$ref": "#/definitions/ClusterList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases": { + "get": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_ListByCluster", + "description": "Gets all databases in the specified RedisEnterprise cluster.", + "x-ms-examples": { + "RedisEnterpriseDatabasesListByCluster": { + "$ref": "./examples/RedisEnterpriseDatabasesListByCluster.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "The list of databases", + "schema": { + "$ref": "#/definitions/DatabaseList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}": { + "put": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_Create", + "description": "Creates a database", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + }, + "x-ms-examples": { + "RedisEnterpriseDatabasesCreate": { + "$ref": "./examples/RedisEnterpriseDatabasesCreate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Database" + }, + "description": "Parameters supplied to the create or update database operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The database was/is being updated. Check provisioningState and resourceState for detailed status.", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "201": { + "description": "The database was/is being created. Check provisioningState and resourceState for detailed status.", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_Update", + "description": "Updates a database", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "RedisEnterpriseDatabasesUpdate": { + "$ref": "./examples/RedisEnterpriseDatabasesUpdate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DatabaseUpdate" + }, + "description": "Parameters supplied to the create or update database operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The database was/is being updated. Check provisioningState and resourceState for detailed status.", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "202": { + "description": "The database update operation was successfully started. GET the URL in the Azure-AsyncOperation or Location headers to retrieve updated status." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_Get", + "description": "Gets information about a database in a RedisEnterprise cluster.", + "x-ms-examples": { + "RedisEnterpriseDatabasesGet": { + "$ref": "./examples/RedisEnterpriseDatabasesGet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully found the database", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_Delete", + "description": "Deletes a single database", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "RedisEnterpriseDatabasesDelete": { + "$ref": "./examples/RedisEnterpriseDatabasesDelete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the database." + }, + "202": { + "description": "The database delete operation started. GET the URL in the Azure-AsyncOperation or Location headers to retrieve updated status." + }, + "204": { + "description": "Successfully deleted the database." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/listKeys": { + "post": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_ListKeys", + "x-ms-examples": { + "RedisEnterpriseDatabasesListKeys": { + "$ref": "./examples/RedisEnterpriseDatabasesListKeys.json" + } + }, + "description": "Retrieves the access keys for the RedisEnterprise database.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The access keys for the specified database.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/regenerateKey": { + "post": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_RegenerateKey", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "RedisEnterpriseDatabasesRegenerateKey": { + "$ref": "./examples/RedisEnterpriseDatabasesRegenerateKey.json" + } + }, + "description": "Regenerates the RedisEnterprise database's access keys.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateKeyParameters" + }, + "description": "Specifies which key to regenerate." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns the new access keys for the database", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "202": { + "description": "The cluster update operation was started. GET the URL in the Azure-AsyncOperation or Location headers to retrieve updated status." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/import": { + "post": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_Import", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "RedisEnterpriseDatabasesImport": { + "$ref": "./examples/RedisEnterpriseDatabasesImport.json" + } + }, + "description": "Imports database files to target database.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ImportClusterParameters" + }, + "description": "Storage information for importing into the cluster" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Import operation succeeded." + }, + "202": { + "description": "The import operation was started. GET the URL in the Azure-AsyncOperation or Location headers to retrieve updated status." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/export": { + "post": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_Export", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "RedisEnterpriseDatabasesExport": { + "$ref": "./examples/RedisEnterpriseDatabasesExport.json" + } + }, + "description": "Exports a database file from target database.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExportClusterParameters" + }, + "description": "Storage information for exporting into the cluster" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Export operation succeeded." + }, + "202": { + "description": "Export operation successfully enqueued; follow the Location header to poll for final outcome." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "description": "Lists all the private endpoint connections associated with the RedisEnterprise cluster.", + "x-ms-examples": { + "RedisEnterpriseListPrivateEndpointConnections": { + "$ref": "./examples/RedisEnterpriseListPrivateEndpointConnections.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Successfully retrieved private endpoint connections.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "description": "Gets the specified private endpoint connection associated with the RedisEnterprise cluster.", + "x-ms-examples": { + "RedisEnterpriseGetPrivateEndpointConnection": { + "$ref": "./examples/RedisEnterpriseGetPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the private endpoint connection properties successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Put", + "description": "Updates the state of the specified private endpoint connection associated with the RedisEnterprise cluster.", + "x-ms-examples": { + "RedisEnterprisePutPrivateEndpointConnection": { + "$ref": "./examples/RedisEnterprisePutPrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "description": "The private endpoint connection properties." + } + ], + "responses": { + "201": { + "description": "OK -- Update the private endpoint connection properties successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "description": "Deletes the specified private endpoint connection associated with the RedisEnterprise cluster.", + "x-ms-examples": { + "RedisEnterpriseDeletePrivateEndpointConnection": { + "$ref": "./examples/RedisEnterpriseDeletePrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "OK -- Delete the private endpoint connection successfully." + }, + "204": { + "description": "No Content -- The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_ListByCluster", + "description": "Gets the private link resources that need to be created for a RedisEnterprise cluster.", + "x-ms-examples": { + "RedisEnterpriseListPrivateLinkResources": { + "$ref": "./examples/RedisEnterpriseListPrivateLinkResources.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + } + }, + "definitions": { + "Sku": { + "description": "SKU parameters supplied to the create RedisEnterprise operation.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.)", + "enum": [ + "Enterprise_E10", + "Enterprise_E20", + "Enterprise_E50", + "Enterprise_E100", + "EnterpriseFlash_F300", + "EnterpriseFlash_F700", + "EnterpriseFlash_F1500" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for Flash SKUs." + } + }, + "required": [ + "name" + ] + }, + "ProvisioningState": { + "type": "string", + "readOnly": true, + "description": "Current provisioning status", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Updating", + "Deleting" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "ResourceState": { + "type": "string", + "readOnly": true, + "description": "Current resource status", + "enum": [ + "Running", + "Creating", + "CreateFailed", + "Updating", + "UpdateFailed", + "Deleting", + "DeleteFailed", + "Enabling", + "EnableFailed", + "Disabling", + "DisableFailed", + "Disabled" + ], + "x-ms-enum": { + "name": "ResourceState", + "modelAsString": true + } + }, + "Cluster": { + "description": "Describes the RedisEnterprise cluster", + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU to create, which affects price, performance, and features." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The Availability Zones where this cluster will be deployed." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ClusterProperties", + "description": "Other properties of the cluster." + } + }, + "required": [ + "sku" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ] + }, + "ClusterUpdate": { + "description": "A partial update to the RedisEnterprise cluster", + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU to create, which affects price, performance, and features." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ClusterProperties", + "description": "Other properties of the cluster." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + } + } + }, + "ClusterProperties": { + "title": "RedisEnterprise cluster properties", + "description": "Properties of RedisEnterprise clusters, as opposed to general resource properties like location, tags", + "type": "object", + "properties": { + "minimumTlsVersion": { + "type": "string", + "description": "The minimum TLS version for the cluster to support, e.g. '1.2'", + "enum": [ + "1.0", + "1.1", + "1.2" + ], + "x-ms-enum": { + "name": "TlsVersion", + "modelAsString": true + } + }, + "hostName": { + "type": "string", + "readOnly": true, + "description": "DNS name of the cluster endpoint" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "readOnly": true, + "description": "Current provisioning status of the cluster" + }, + "resourceState": { + "$ref": "#/definitions/ResourceState", + "readOnly": true, + "description": "Current resource status of the cluster" + }, + "redisVersion": { + "type": "string", + "readOnly": true, + "description": "Version of redis the cluster supports, e.g. '6'" + }, + "privateEndpointConnections": { + "type": "array", + "readOnly": true, + "description": "List of private endpoint connections associated with the specified RedisEnterprise cluster", + "items": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + } + } + } + }, + "ClusterList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Cluster" + }, + "description": "List of clusters." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URI to fetch the next page of results." + } + }, + "description": "The response of a list-all operation." + }, + "Database": { + "description": "Describes a database on the RedisEnterprise cluster", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DatabaseProperties", + "description": "Other properties of the database." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "DatabaseUpdate": { + "description": "A partial update to the RedisEnterprise database", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DatabaseProperties", + "description": "Properties of the database." + } + } + }, + "DatabaseProperties": { + "title": "RedisEnterprise database properties", + "description": "Properties of RedisEnterprise databases, as opposed to general resource properties like location, tags", + "type": "object", + "properties": { + "clientProtocol": { + "type": "string", + "description": "Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.", + "enum": [ + "Encrypted", + "Plaintext" + ], + "x-ms-enum": { + "name": "Protocol", + "modelAsString": true + } + }, + "port": { + "type": "integer", + "format": "int32", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "TCP port of the database endpoint. Specified at create time. Defaults to an available port." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "readOnly": true, + "description": "Current provisioning status of the database" + }, + "resourceState": { + "$ref": "#/definitions/ResourceState", + "readOnly": true, + "description": "Current resource status of the database" + }, + "clusteringPolicy": { + "type": "string", + "description": "Clustering policy - default is OSSCluster. Specified at create time.", + "enum": [ + "EnterpriseCluster", + "OSSCluster" + ], + "x-ms-enum": { + "name": "ClusteringPolicy", + "modelAsString": true + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "evictionPolicy": { + "type": "string", + "description": "Redis eviction policy - default is VolatileLRU", + "enum": [ + "AllKeysLFU", + "AllKeysLRU", + "AllKeysRandom", + "VolatileLRU", + "VolatileLFU", + "VolatileTTL", + "VolatileRandom", + "NoEviction" + ], + "x-ms-enum": { + "name": "EvictionPolicy", + "modelAsString": true + } + }, + "persistence": { + "$ref": "#/definitions/Persistence", + "description": "Persistence settings" + }, + "modules": { + "type": "array", + "description": "Optional set of redis modules to enable in this database - modules can only be added at creation time.", + "items": { + "$ref": "#/definitions/Module" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "DatabaseList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Database" + }, + "description": "List of databases" + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URI to fetch the next page of results." + } + }, + "description": "The response of a list-all operation." + }, + "Persistence": { + "title": "Persistence settings", + "description": "Persistence-related configuration for the RedisEnterprise database", + "type": "object", + "properties": { + "aofEnabled": { + "type": "boolean", + "description": "Sets whether AOF is enabled." + }, + "rdbEnabled": { + "type": "boolean", + "description": "Sets whether RDB is enabled." + }, + "aofFrequency": { + "type": "string", + "description": "Sets the frequency at which data is written to disk.", + "enum": [ + "1s", + "always" + ], + "x-ms-enum": { + "name": "AofFrequency", + "modelAsString": true + } + }, + "rdbFrequency": { + "type": "string", + "description": "Sets the frequency at which a snapshot of the database is created.", + "enum": [ + "1h", + "6h", + "12h" + ], + "x-ms-enum": { + "name": "RdbFrequency", + "modelAsString": true + } + } + } + }, + "Module": { + "title": "Module settings", + "description": "Specifies configuration of a redis module", + "type": "object", + "properties": { + "name": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'" + }, + "args": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Configuration options for the module, e.g. 'ERROR_RATE 0.00 INITIAL_SIZE 400'." + }, + "version": { + "type": "string", + "readOnly": true, + "description": "The version of the module, e.g. '1.0'." + } + }, + "required": [ + "name" + ] + }, + "AccessKeys": { + "title": "Access keys", + "description": "The secret access keys used for authenticating connections to redis", + "type": "object", + "properties": { + "primaryKey": { + "readOnly": true, + "type": "string", + "description": "The current primary key that clients can use to authenticate" + }, + "secondaryKey": { + "readOnly": true, + "type": "string", + "description": "The current secondary key that clients can use to authenticate" + } + } + }, + "RegenerateKeyParameters": { + "title": "Regenerate access keys request", + "type": "object", + "properties": { + "keyType": { + "type": "string", + "description": "Which access key to regenerate.", + "enum": [ + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "AccessKeyType", + "modelAsString": false + } + } + }, + "required": [ + "keyType" + ], + "description": "Specifies which access keys to reset to a new random value." + }, + "ImportClusterParameters": { + "title": "Import RDB files into a target database", + "type": "object", + "properties": { + "sasUris": { + "type": "array", + "items": { + "type": "string" + }, + "description": "SAS URIs for the target blobs to import from", + "x-ms-secret": true + } + }, + "required": [ + "sasUris" + ], + "description": "Parameters for a Redis Enterprise import operation." + }, + "ExportClusterParameters": { + "title": "Export an RDB file into a target database", + "type": "object", + "properties": { + "sasUri": { + "type": "string", + "description": "SAS URI for the target directory to export to", + "x-ms-secret": true + } + }, + "required": [ + "sasUri" + ], + "description": "Parameters for a Redis Enterprise export operation." + }, + "OperationStatus": { + "description": "The status of a long-running operation.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The operation's unique id." + }, + "name": { + "type": "string", + "description": "The operation's name." + }, + "startTime": { + "type": "string", + "description": "The start time of the operation." + }, + "endTime": { + "type": "string", + "description": "The end time of the operation." + }, + "status": { + "type": "string", + "description": "The current status of the operation." + }, + "error": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse", + "description": "Error response describing why the operation failed." + } + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the RedisEnterprise cluster.", + "x-ms-parameter-location": "method" + }, + "DatabaseNameParameter": { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/redisenterprise/resource-manager/readme.go.md b/specification/redisenterprise/resource-manager/readme.go.md index 62ca1799815f..f05c3218b75a 100644 --- a/specification/redisenterprise/resource-manager/readme.go.md +++ b/specification/redisenterprise/resource-manager/readme.go.md @@ -13,10 +13,20 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2021-08 - tag: package-2021-03 - tag: package-2020-10-01-preview ``` +### Tag: package-2021-08 and go + +These settings apply only when `--tag=package-2021-08 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +```yaml $(tag) == 'package-2021-08' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2021-08-01/$(namespace) +``` + ### Tag: package-2021-03 and go These settings apply only when `--tag=package-2021-03 --go` is specified on the command line. diff --git a/specification/redisenterprise/resource-manager/readme.md b/specification/redisenterprise/resource-manager/readme.md index 6d77ed17c948..b73f6dc50076 100644 --- a/specification/redisenterprise/resource-manager/readme.md +++ b/specification/redisenterprise/resource-manager/readme.md @@ -26,10 +26,19 @@ These are the global settings for the RedisEnterprise API. ``` yaml openapi-type: arm -tag: package-2021-03 +tag: package-2021-08 ``` +### Tag: package-2021-08 + +These settings apply only when `--tag=package-2021-08` is specified on the command line. + +```yaml $(tag) == 'package-2021-08' +input-file: + - Microsoft.Cache/stable/2021-08-01/redisenterprise.json +``` + ### Tag: package-preview-2021-02 These settings apply only when `--tag=package-preview-2021-02` is specified on the command line. @@ -38,6 +47,7 @@ These settings apply only when `--tag=package-preview-2021-02` is specified on t input-file: - Microsoft.Cache/preview/2021-02-01-preview/redisenterprise.json ``` + ### Tag: package-2021-03 These settings apply only when `--tag=package-2021-03` is specified on the command line. diff --git a/specification/redisenterprise/resource-manager/readme.python.md b/specification/redisenterprise/resource-manager/readme.python.md index dfbd2f052429..6d9d730f6eb1 100644 --- a/specification/redisenterprise/resource-manager/readme.python.md +++ b/specification/redisenterprise/resource-manager/readme.python.md @@ -9,7 +9,7 @@ azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.redisenterprise package-name: azure-mgmt-redisenterprise -package-version: 1.0.0 +package-version: 2.0.0 clear-output-folder: true ``` diff --git a/specification/redisenterprise/resource-manager/readme.ruby.md b/specification/redisenterprise/resource-manager/readme.ruby.md index f299f659348e..e258905fbe9e 100644 --- a/specification/redisenterprise/resource-manager/readme.ruby.md +++ b/specification/redisenterprise/resource-manager/readme.ruby.md @@ -12,10 +12,21 @@ azure-arm: true ``` yaml $(ruby) && $(multiapi) batch: + - tag: package-2021-08 - tag: package-2021-03 - tag: package-2020-10-01-preview ``` +### Tag: package-2021-08 and ruby + +These settings apply only when `--tag=package-2021-08 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +```yaml $(tag) == 'package-2021-08' && $(ruby) +namespace: "Azure::RedisEnterprise::Mgmt::V2021_08_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_redisenterprise/lib +``` + ### Tag: package-2021-03 and ruby These settings apply only when `--tag=package-2021-03 --ruby` is specified on the command line. diff --git a/specification/reservations/resource-manager/readme.md b/specification/reservations/resource-manager/readme.md index d17ad6db7c1b..fb10f82f2645 100644 --- a/specification/reservations/resource-manager/readme.md +++ b/specification/reservations/resource-manager/readme.md @@ -109,7 +109,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-go - repo: azure-sdk-for-js diff --git a/specification/reservations/resource-manager/readme.python.md b/specification/reservations/resource-manager/readme.python.md index c2d23b97bf67..d9bd9e5db1df 100644 --- a/specification/reservations/resource-manager/readme.python.md +++ b/specification/reservations/resource-manager/readme.python.md @@ -4,38 +4,15 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.reservations - package-name: azure-mgmt-reservations - package-version: 0.3.2 - clear-output-folder: true -``` ``` yaml $(python) && $(track2) -python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.reservations package-name: azure-mgmt-reservations -package-version: 0.3.2 +package-version: 1.0.0b1 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/reservations/azure-mgmt-reservations/azure/mgmt/reservations -``` -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/reservations/azure-mgmt-reservations -``` - ``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/reservations/azure-mgmt-reservations/azure/mgmt/reservations diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/OperationsList.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/OperationsList.json new file mode 100644 index 000000000000..844835abb972 --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/OperationsList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ResourceGraph/operations/read", + "display": { + "provider": "Microsoft Resource Graph", + "resource": "Operation", + "operation": "Get Operations", + "description": "Gets the list of supported operations" + } + }, + { + "name": "Microsoft.ResourceGraph/resources/read", + "display": { + "provider": "Microsoft Resource Graph", + "resource": "Resources", + "operation": "Query resources", + "description": "Submits a query on resources within specified subscriptions, the specified management groups, or against all access granted in the tenant." + } + } + ] + } + } + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesBasicQuery.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesBasicQuery.json new file mode 100644 index 000000000000..a6c9a0b79467 --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesBasicQuery.json @@ -0,0 +1,48 @@ +{ + "title": "Basic Query", + "description": "A simple resources query.", + "parameters": { + "api-version": "2021-06-01-preview", + "query": { + "subscriptions": [ + "cfbbd179-59d2-4052-aa06-9270a38aa9d6" + ], + "query": "Resources | project id, name, type, location, tags | limit 3" + } + }, + "responses": { + "200": { + "body": { + "totalRecords": 3, + "count": 3, + "resultTruncated": "false", + "facets": [], + "data": [ + { + "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Network/networkInterfaces/myNetworkInterface", + "name": "myNetworkInterface", + "type": "microsoft.network/networkinterfaces", + "location": "centralus", + "tags": { + "tag1": "Value1" + } + }, + { + "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Network/virtualNetworks/myVnet", + "name": "myVnet", + "type": "microsoft.network/virtualnetworks", + "location": "westus", + "tags": {} + }, + { + "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Network/publicIPAddresses/myPublicIp", + "name": "myPublicIp", + "type": "microsoft.network/publicipaddresses", + "location": "westus", + "tags": {} + } + ] + } + } + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesComplexQuery.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesComplexQuery.json new file mode 100644 index 000000000000..90f60e294f18 --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesComplexQuery.json @@ -0,0 +1,37 @@ +{ + "title": "Complex Query", + "description": "A complex query on resources featuring multiple operations.", + "parameters": { + "api-version": "2021-06-01-preview", + "query": { + "subscriptions": [ + "cfbbd179-59d2-4052-aa06-9270a38aa9d6" + ], + "query": "Resources | project id, name, type, location | where type =~ 'Microsoft.Compute/virtualMachines' | summarize count() by location | top 3 by count_" + } + }, + "responses": { + "200": { + "body": { + "totalRecords": 3, + "count": 3, + "resultTruncated": "false", + "facets": [], + "data": [ + { + "location": "centralus", + "count_": 11 + }, + { + "location": "eastus", + "count_": 11 + }, + { + "location": "southcentralus", + "count_": 3 + } + ] + } + } + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesFacetQuery.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesFacetQuery.json new file mode 100644 index 000000000000..cbcec2d623e3 --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesFacetQuery.json @@ -0,0 +1,185 @@ +{ + "title": "Facet Query", + "description": "A query on resources requesting extra facets.", + "parameters": { + "api-version": "2021-06-01-preview", + "query": { + "subscriptions": [ + "cfbbd179-59d2-4052-aa06-9270a38aa9d6" + ], + "query": "Resources | where type =~ 'Microsoft.Compute/virtualMachines' | project id, name, location, resourceGroup, properties.storageProfile.osDisk.osType | limit 5", + "facets": [ + { + "expression": "location", + "options": { + "sortOrder": "desc", + "$top": 3 + } + }, + { + "expression": "properties.storageProfile.osDisk.osType", + "options": { + "sortOrder": "desc", + "$top": 3 + } + }, + { + "expression": "nonExistingColumn", + "options": { + "sortOrder": "desc", + "$top": 3 + } + }, + { + "expression": "resourceGroup", + "options": { + "sortBy": "tolower(resourceGroup)", + "sortOrder": "asc", + "$top": 3 + } + }, + { + "expression": "resourceGroup", + "options": { + "filter": "resourceGroup contains 'test'", + "$top": 3 + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "totalRecords": 5, + "count": 5, + "resultTruncated": "false", + "data": [ + { + "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/B-TEST-RG/providers/Microsoft.Compute/virtualMachines/myTestVm", + "name": "myTestVm", + "location": "eastus", + "resourceGroup": "B-TEST-RG", + "properties_storageProfile_osDisk_osType": "Windows" + }, + { + "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/c-rg/providers/Microsoft.Compute/virtualMachines/myTestAccountVm", + "name": "myTestAccountVm", + "location": "westcentralus", + "resourceGroup": "c-rg", + "properties_storageProfile_osDisk_osType": "Windows" + }, + { + "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/I-RG/providers/Microsoft.Compute/virtualMachines/yetanothertest", + "name": "yetanothertest", + "location": "eastus", + "resourceGroup": "I-RG", + "properties_storageProfile_osDisk_osType": "Linux" + }, + { + "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/x-test-rg/providers/Microsoft.Compute/virtualMachines/drafttest1bux4cv7a7q3aw", + "name": "drafttest1bux4cv7a7q3aw", + "location": "southcentralus", + "resourceGroup": "x-test-rg", + "properties_storageProfile_osDisk_osType": "Linux" + }, + { + "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/y-rg/providers/Microsoft.Compute/virtualMachines/testvmntp25370", + "name": "testvmntp25370", + "location": "eastus", + "resourceGroup": "y-rg", + "properties_storageProfile_osDisk_osType": "Windows" + } + ], + "facets": [ + { + "expression": "location", + "resultType": "FacetResult", + "totalRecords": 3, + "count": 3, + "data": [ + { + "location": "eastus", + "count": 3 + }, + { + "location": "southcentralus", + "count": 1 + }, + { + "location": "westcentralus", + "count": 1 + } + ] + }, + { + "expression": "properties.storageProfile.osDisk.osType", + "resultType": "FacetResult", + "totalRecords": 2, + "count": 2, + "data": [ + { + "properties_storageProfile_osDisk_osType": "Linux", + "count": 2 + }, + { + "properties_storageProfile_osDisk_osType": "Windows", + "count": 3 + } + ] + }, + { + "expression": "nonExistingColumn", + "resultType": "FacetError", + "errors": [ + { + "code": "NoValidColumns", + "message": "No valid columns in facet expression." + }, + { + "code": "InvalidColumnNames", + "message": "Invalid column names: [nonExistingColumn]." + } + ] + }, + { + "expression": "resourceGroup", + "resultType": "FacetResult", + "totalRecords": 5, + "count": 3, + "data": [ + { + "resourceGroup": "B-TEST-RG", + "count": 1 + }, + { + "resourceGroup": "c-rg", + "count": 1 + }, + { + "resourceGroup": "I-RG", + "count": 1 + } + ] + }, + { + "expression": "resourceGroup", + "resultType": "FacetResult", + "totalRecords": 2, + "count": 2, + "data": [ + { + "resourceGroup": "B-TEST-RG", + "count": 1 + }, + { + "resourceGroup": "x-test-rg", + "count": 1 + } + ] + } + ] + } + } + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesFilterQuery.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesFilterQuery.json new file mode 100644 index 000000000000..2f335f223d3e --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesFilterQuery.json @@ -0,0 +1,43 @@ +{ + "title": "Filter query", + "description": "A filtering query on resources.", + "parameters": { + "api-version": "2021-06-01-preview", + "query": { + "subscriptions": [ + "cfbbd179-59d2-4052-aa06-9270a38aa9d6" + ], + "query": "Resources | project id, name, type, location | where type =~ 'Microsoft.Compute/virtualMachines' | limit 3" + } + }, + "responses": { + "200": { + "body": { + "totalRecords": 3, + "count": 3, + "resultTruncated": "false", + "facets": [], + "data": [ + { + "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Compute/virtualMachines/myVm1", + "name": "myVm1", + "type": "microsoft.compute/virtualmachines", + "location": "centralus" + }, + { + "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Compute/virtualMachines/myVirtualMachine", + "name": "myVirtualMachine", + "type": "microsoft.compute/virtualmachines", + "location": "eastus" + }, + { + "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG3/providers/Microsoft.Compute/virtualMachines/testVm", + "name": "testVm", + "type": "microsoft.compute/virtualmachines", + "location": "eastus" + } + ] + } + } + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesFirstPageQuery.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesFirstPageQuery.json new file mode 100644 index 000000000000..4b3de5eabeb5 --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesFirstPageQuery.json @@ -0,0 +1,48 @@ +{ + "title": "First page query", + "description": "A query requesting a first page with of results. Please note id field is required in the response to return the pages in stable sorted fashion.", + "parameters": { + "api-version": "2021-06-01-preview", + "query": { + "subscriptions": [ + "cfbbd179-59d2-4052-aa06-9270a38aa9d6" + ], + "query": "Resources | where name contains 'test' | project id, name, type, location", + "options": { + "$top": 3, + "$skip": 0 + } + } + }, + "responses": { + "200": { + "body": { + "totalRecords": 386, + "count": 3, + "resultTruncated": "false", + "facets": [], + "$skipToken": "eyAibm8iOiAibHVjayIsICJidXQiOiAibmljZSIsICJ0cnkiOiAiISIgfQ==", + "data": [ + { + "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Compute/disks/yetanothertest_OsDisk_1_f396cbcb625a457bb69fe2abf5975820", + "name": "yetanothertest_OsDisk_1_f396cbcb625a457bb69fe2abf5975820", + "type": "microsoft.compute/disks", + "location": "eastus" + }, + { + "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Automation/automationAccounts/TestAA", + "name": "TestAA", + "type": "microsoft.automation/automationaccounts", + "location": "westcentralus" + }, + { + "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Automation/automationAccounts/TestAA/runbooks/TestRB", + "name": "TestRB", + "type": "microsoft.automation/automationaccounts/runbooks", + "location": "westcentralus" + } + ] + } + } + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesHistoryGet.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesHistoryGet.json new file mode 100644 index 000000000000..e769fed7218c --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesHistoryGet.json @@ -0,0 +1,60 @@ +{ + "title": "Resource History Query", + "description": "A resource history query.", + "parameters": { + "api-version": "2021-06-01-preview", + "request": { + "subscriptions": [ + "a7f33fdb-e646-4f15-89aa-3a360210861e" + ], + "query": "where name =~ 'cpu-utilization' | project id, name, properties", + "options": { + "interval": { + "start": "2020-11-12T01:00:00.0000000Z", + "end": "2020-11-12T01:25:00.0000000Z" + } + } + } + }, + "responses": { + "200": { + "body": { + "count": 2, + "snapshots": { + "columns": [ + { + "name": "id", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "properties", + "type": "object" + } + ], + "rows": [ + [ + "/subscriptions/a7f33fdb-e646-4f15-89aa-3a360210861e/resourceGroups/meya-test-rg/providers/Microsoft.Compute/virtualMachines/meya-win-eus/providers/Microsoft.WorkloadMonitor/monitors/cpu-utilization", + "cpu-utilization", + { + "monitorName": "", + "currentStateFirstObservedTimestamp": "" + } + ], + [ + "/subscriptions/a7f33fdb-e646-4f15-89aa-3a360210861e/resourceGroups/meya-test-rg/providers/Microsoft.Compute/virtualMachines/meya-win-eus/providers/Microsoft.WorkloadMonitor/monitors/cpu-utilization", + "cpu-utilization", + { + "monitorName": "test", + "currentStateFirstObservedTimestamp": "" + } + ] + ] + } + } + } + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesHistoryMgsGet.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesHistoryMgsGet.json new file mode 100644 index 000000000000..9177059060bb --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesHistoryMgsGet.json @@ -0,0 +1,61 @@ +{ + "title": "Resource History Management Group scoped Query", + "description": "A resource history query scoped to a list of management groups.", + "parameters": { + "api-version": "2021-06-01-preview", + "request": { + "managementGroups": [ + "e927f598-c1d4-4f72-8541-95d83a6a4ac8", + "ProductionMG" + ], + "query": "where name =~ 'cpu-utilization' | project id, name, properties", + "options": { + "interval": { + "start": "2020-11-12T01:00:00.0000000Z", + "end": "2020-11-12T01:25:00.0000000Z" + } + } + } + }, + "responses": { + "200": { + "body": { + "count": 2, + "snapshots": { + "columns": [ + { + "name": "id", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "properties", + "type": "object" + } + ], + "rows": [ + [ + "/subscriptions/a7f33fdb-e646-4f15-89aa-3a360210861e/resourceGroups/meya-test-rg/providers/Microsoft.Compute/virtualMachines/meya-win-eus/providers/Microsoft.WorkloadMonitor/monitors/cpu-utilization", + "cpu-utilization", + { + "monitorName": "", + "currentStateFirstObservedTimestamp": "" + } + ], + [ + "/subscriptions/a7f33fdb-e646-4f15-89aa-3a360210861e/resourceGroups/meya-test-rg/providers/Microsoft.Compute/virtualMachines/meya-win-eus/providers/Microsoft.WorkloadMonitor/monitors/cpu-utilization", + "cpu-utilization", + { + "monitorName": "test", + "currentStateFirstObservedTimestamp": "" + } + ] + ] + } + } + } + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesMgBasicQuery.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesMgBasicQuery.json new file mode 100644 index 000000000000..8c117aa61a4d --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesMgBasicQuery.json @@ -0,0 +1,49 @@ +{ + "title": "Basic Query", + "description": "A simple management groups scoped resources query.", + "parameters": { + "api-version": "2021-06-01-preview", + "query": { + "managementGroups": [ + "e927f598-c1d4-4f72-8541-95d83a6a4ac8", + "ProductionMG" + ], + "query": "Resources | project id, name, type, location, tags | limit 3" + } + }, + "responses": { + "200": { + "body": { + "totalRecords": 3, + "count": 3, + "resultTruncated": "false", + "facets": [], + "data": [ + { + "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Network/networkInterfaces/myNetworkInterface", + "name": "myNetworkInterface", + "type": "microsoft.network/networkinterfaces", + "location": "centralus", + "tags": { + "tag1": "Value1" + } + }, + { + "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Network/virtualNetworks/myVnet", + "name": "myVnet", + "type": "microsoft.network/virtualnetworks", + "location": "westus", + "tags": {} + }, + { + "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Network/publicIPAddresses/myPublicIp", + "name": "myPublicIp", + "type": "microsoft.network/publicipaddresses", + "location": "westus", + "tags": {} + } + ] + } + } + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesNextPageQuery.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesNextPageQuery.json new file mode 100644 index 000000000000..691a7a380fb1 --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesNextPageQuery.json @@ -0,0 +1,47 @@ +{ + "title": "Next page query", + "description": "A query on resources requesting the next page using skip token. Please note id field is required in the response to return the pages in stable sorted fashion.", + "parameters": { + "api-version": "2021-06-01-preview", + "query": { + "subscriptions": [ + "cfbbd179-59d2-4052-aa06-9270a38aa9d6" + ], + "query": "Resources | where name contains 'test' | project id, name, type, location", + "options": { + "$skipToken": "eyAibm8iOiAibHVjayIsICJidXQiOiAibmljZSIsICJ0cnkiOiAiISIgfQ==" + } + } + }, + "responses": { + "200": { + "body": { + "totalRecords": 386, + "count": 3, + "resultTruncated": "false", + "facets": [], + "$skipToken": "eyAibm8yIjogImx1Y2syIiwgImJ1dDIiOiAibmljZTIiLCAidHJ5MiI6ICIhIiB9", + "data": [ + { + "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Compute/disks/second_OsDisk_dddddbcb625a457bb69fe2abf5975820", + "name": "second_OsDisk_dddddbcb625a457bb69fe2abf5975820", + "type": "microsoft.compute/disks", + "location": "eastus" + }, + { + "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Automation/automationAccounts/AATest", + "name": "AATest", + "type": "microsoft.automation/automationaccounts", + "location": "westcentralus" + }, + { + "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Automation/automationAccounts/TestAA/runbooks/RBTest", + "name": "RBTest", + "type": "microsoft.automation/automationaccounts/runbooks", + "location": "westcentralus" + } + ] + } + } + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesPropertiesQuery.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesPropertiesQuery.json new file mode 100644 index 000000000000..ab6a53f32c2a --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesPropertiesQuery.json @@ -0,0 +1,33 @@ +{ + "title": "Properties Query", + "description": "A query accessing one of the resource properties.", + "parameters": { + "api-version": "2021-06-01-preview", + "query": { + "subscriptions": [ + "cfbbd179-59d2-4052-aa06-9270a38aa9d6" + ], + "query": "Resources | where type =~ 'Microsoft.Compute/virtualMachines' | summarize count() by tostring(properties.storageProfile.osDisk.osType)" + } + }, + "responses": { + "200": { + "body": { + "totalRecords": 2, + "count": 2, + "resultTruncated": "false", + "facets": [], + "data": [ + { + "properties_storageProfile_osDisk_osType": "Linux", + "count": 7 + }, + { + "properties_storageProfile_osDisk_osType": "Windows", + "count": 23 + } + ] + } + } + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesRandomPageQuery.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesRandomPageQuery.json new file mode 100644 index 000000000000..ae9cdd5e4c84 --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesRandomPageQuery.json @@ -0,0 +1,42 @@ +{ + "title": "Random page query", + "description": "A query on resources specifying paging and max rows through query options", + "parameters": { + "api-version": "2021-06-01-preview", + "query": { + "subscriptions": [ + "cfbbd179-59d2-4052-aa06-9270a38aa9d6" + ], + "query": "Resources | where name contains 'test' | project id, name, type, location", + "options": { + "$top": 2, + "$skip": 10 + } + } + }, + "responses": { + "200": { + "body": { + "totalRecords": 386, + "count": 2, + "resultTruncated": "false", + "facets": [], + "$skipToken": "eyAibm8iOiAibHVjayIsICJidXQiOiAibmljZSIsICJ0cnkiOiAiISIgfQ==", + "data": [ + { + "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Compute/disks/third_OsDisk_dddddbcb625a457bb69fe2abf5975820", + "name": "third_OsDisk_dddddbcb625a457bb69fe2abf5975820", + "type": "microsoft.compute/disks", + "location": "eastus" + }, + { + "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Automation/automationAccounts/CCTest", + "name": "CCTest", + "type": "microsoft.automation/automationaccounts", + "location": "westcentralus" + } + ] + } + } + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesSummarizeQuery.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesSummarizeQuery.json new file mode 100644 index 000000000000..d37a4cc89cbc --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesSummarizeQuery.json @@ -0,0 +1,34 @@ +{ + "title": "Summarize Query", + "description": "A summarizing query on resources.", + "parameters": { + "api-version": "2021-06-01-preview", + "query": { + "subscriptions": [ + "cfbbd179-59d2-4052-aa06-9270a38aa9d6" + ], + "query": "Resources | project id, name, type, location | summarize by location" + } + }, + "responses": { + "200": { + "body": { + "totalRecords": 3, + "count": 3, + "resultTruncated": "false", + "facets": [], + "data": [ + { + "location": "centralus" + }, + { + "location": "eastus" + }, + { + "location": "westus" + } + ] + } + } + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesTenantBasicQuery.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesTenantBasicQuery.json new file mode 100644 index 000000000000..24c77dad1793 --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/examples/ResourcesTenantBasicQuery.json @@ -0,0 +1,45 @@ +{ + "title": "Basic Query", + "description": "A simple tenant scoped resources query.", + "parameters": { + "api-version": "2021-06-01-preview", + "query": { + "query": "Resources | project id, name, type, location, tags | limit 3" + } + }, + "responses": { + "200": { + "body": { + "totalRecords": 3, + "count": 3, + "resultTruncated": "false", + "facets": [], + "data": [ + { + "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Network/networkInterfaces/myNetworkInterface", + "name": "myNetworkInterface", + "type": "microsoft.network/networkinterfaces", + "location": "centralus", + "tags": { + "tag1": "Value1" + } + }, + { + "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Network/virtualNetworks/myVnet", + "name": "myVnet", + "type": "microsoft.network/virtualnetworks", + "location": "westus", + "tags": {} + }, + { + "id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Network/publicIPAddresses/myPublicIp", + "name": "myPublicIp", + "type": "microsoft.network/publicipaddresses", + "location": "westus", + "tags": {} + } + ] + } + } + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/resourcegraph.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/resourcegraph.json new file mode 100644 index 000000000000..7f79bc41631f --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/resourcegraph.json @@ -0,0 +1,601 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Resource Graph", + "description": "Azure Resource Graph API Reference", + "version": "2021-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.ResourceGraph/resources": { + "post": { + "tags": [ + "Resources" + ], + "operationId": "Resources", + "description": "Queries the resources managed by Azure Resource Manager for scopes specified in the request.", + "externalDocs": { + "description": "Learn more about the query syntax here", + "url": "https://aka.ms/resource-graph/learntoquery" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "query", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/QueryRequest" + }, + "description": "Request specifying query and its options." + } + ], + "responses": { + "200": { + "description": "Result of the query operation", + "schema": { + "$ref": "#/definitions/QueryResponse" + } + }, + "default": { + "description": "An error occurred while processing the request. See the error.code parameter to identify the specific error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Basic query": { + "$ref": "./examples/ResourcesBasicQuery.json" + }, + "Basic tenant query": { + "$ref": "./examples/ResourcesTenantBasicQuery.json" + }, + "Basic management group query": { + "$ref": "./examples/ResourcesMgBasicQuery.json" + }, + "Filter resources": { + "$ref": "./examples/ResourcesFilterQuery.json" + }, + "Summarize resources by location": { + "$ref": "./examples/ResourcesSummarizeQuery.json" + }, + "Complex query": { + "$ref": "./examples/ResourcesComplexQuery.json" + }, + "Access a properties field": { + "$ref": "./examples/ResourcesPropertiesQuery.json" + }, + "Query with a facet request": { + "$ref": "./examples/ResourcesFacetQuery.json" + }, + "First page query": { + "$ref": "./examples/ResourcesFirstPageQuery.json" + }, + "Next page query": { + "$ref": "./examples/ResourcesNextPageQuery.json" + }, + "Random page query": { + "$ref": "./examples/ResourcesRandomPageQuery.json" + } + } + } + }, + "/providers/Microsoft.ResourceGraph/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available REST API operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/OperationsList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "An error occurred while processing the request. See the error.code parameter to identify the specific error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + } + }, + "definitions": { + "QueryRequest": { + "description": "Describes a query to be executed.", + "type": "object", + "properties": { + "subscriptions": { + "description": "Azure subscriptions against which to execute the query.", + "type": "array", + "items": { + "type": "string", + "description": "Subscription Id." + } + }, + "managementGroups": { + "description": "Azure management groups against which to execute the query. Example: [ 'mg1', 'mg2' ]", + "type": "array", + "items": { + "type": "string", + "description": "The name of Management group." + } + }, + "query": { + "description": "The resources query.", + "type": "string" + }, + "options": { + "description": "The query evaluation options", + "$ref": "#/definitions/QueryRequestOptions" + }, + "facets": { + "description": "An array of facet requests to be computed against the query result.", + "type": "array", + "items": { + "$ref": "#/definitions/FacetRequest" + } + } + }, + "required": [ + "query" + ] + }, + "QueryRequestOptions": { + "description": "The options for query evaluation", + "properties": { + "$skipToken": { + "description": "Continuation token for pagination, capturing the next page size and offset, as well as the context of the query.", + "type": "string" + }, + "$top": { + "description": "The maximum number of rows that the query should return. Overrides the page size when ```$skipToken``` property is present.", + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 1000 + }, + "$skip": { + "description": "The number of rows to skip from the beginning of the results. Overrides the next page offset when ```$skipToken``` property is present.", + "type": "integer", + "format": "int32", + "minimum": 0 + }, + "resultFormat": { + "description": "Defines in which format query result returned.", + "type": "string", + "enum": [ + "table", + "objectArray" + ], + "default": "objectArray", + "x-ms-enum": { + "name": "ResultFormat", + "modelAsString": false + } + }, + "allowPartialScopes": { + "description": "Only applicable for tenant and management group level queries to decide whether to allow partial scopes for result in case the number of subscriptions exceed allowed limits.", + "type": "boolean", + "default": false + }, + "authorizationScopeFilter": { + "description": "Defines what level of authorization resources should be returned based on the which subscriptions and management groups are passed as scopes.", + "type": "string", + "enum": [ + "AtScopeAndBelow", + "AtScopeAndAbove", + "AtScopeExact", + "AtScopeAboveAndBelow" + ], + "default": "AtScopeAndBelow", + "x-ms-enum": { + "name": "AuthorizationScopeFilter", + "modelAsString": false + } + } + } + }, + "FacetRequest": { + "description": "A request to compute additional statistics (facets) over the query results.", + "type": "object", + "properties": { + "expression": { + "description": "The column or list of columns to summarize by", + "type": "string" + }, + "options": { + "description": "The options for facet evaluation", + "$ref": "#/definitions/FacetRequestOptions" + } + }, + "required": [ + "expression" + ] + }, + "FacetRequestOptions": { + "description": "The options for facet evaluation", + "properties": { + "sortBy": { + "description": "The column name or query expression to sort on. Defaults to count if not present.", + "type": "string" + }, + "sortOrder": { + "description": "The sorting order by the selected column (count by default).", + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "FacetSortOrder", + "modelAsString": false + } + }, + "filter": { + "description": "Specifies the filter condition for the 'where' clause which will be run on main query's result, just before the actual faceting.", + "type": "string" + }, + "$top": { + "description": "The maximum number of facet rows that should be returned.", + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 1000 + } + } + }, + "QueryResponse": { + "description": "Query result.", + "type": "object", + "properties": { + "totalRecords": { + "description": "Number of total records matching the query.", + "type": "integer", + "format": "int64" + }, + "count": { + "description": "Number of records returned in the current response. In the case of paging, this is the number of records in the current page.", + "type": "integer", + "format": "int64" + }, + "resultTruncated": { + "description": "Indicates whether the query results are truncated.", + "type": "string", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "ResultTruncated", + "modelAsString": false + } + }, + "$skipToken": { + "description": "When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.", + "type": "string" + }, + "data": { + "description": "Query output in JObject array or Table format.", + "type": "object" + }, + "facets": { + "description": "Query facets.", + "type": "array", + "items": { + "$ref": "#/definitions/Facet" + } + } + }, + "required": [ + "totalRecords", + "count", + "resultTruncated", + "data" + ] + }, + "Table": { + "description": "Query output in tabular format.", + "type": "object", + "properties": { + "columns": { + "description": "Query result column descriptors.", + "type": "array", + "items": { + "$ref": "#/definitions/Column", + "description": "Column descriptor." + } + }, + "rows": { + "description": "Query result rows.", + "type": "array", + "items": { + "$ref": "#/definitions/Row", + "description": "Query result row." + } + } + }, + "required": [ + "columns", + "rows" + ] + }, + "Column": { + "description": "Query result column descriptor.", + "type": "object", + "properties": { + "name": { + "description": "Column name.", + "type": "string" + }, + "type": { + "description": "Column data type.", + "$ref": "#/definitions/ColumnDataType" + } + }, + "required": [ + "name", + "type" + ] + }, + "ColumnDataType": { + "description": "Data type of a column in a table.", + "type": "string", + "enum": [ + "string", + "integer", + "number", + "boolean", + "object" + ], + "x-ms-enum": { + "name": "ColumnDataType", + "modelAsString": false + } + }, + "Row": { + "description": "Query result row.", + "type": "array", + "items": { + "type": "object", + "description": "Cell value." + } + }, + "Facet": { + "description": "A facet containing additional statistics on the response of a query. Can be either FacetResult or FacetError.", + "type": "object", + "properties": { + "expression": { + "description": "Facet expression, same as in the corresponding facet request.", + "type": "string" + }, + "resultType": { + "description": "Result type", + "type": "string" + } + }, + "required": [ + "expression", + "resultType" + ], + "discriminator": "resultType" + }, + "FacetResult": { + "x-ms-discriminator-value": "FacetResult", + "description": "Successfully executed facet containing additional statistics on the response of a query.", + "type": "object", + "properties": { + "totalRecords": { + "description": "Number of total records in the facet results.", + "type": "integer", + "format": "int64" + }, + "count": { + "description": "Number of records returned in the facet response.", + "type": "integer", + "format": "int32" + }, + "data": { + "description": "A JObject array or Table containing the desired facets. Only present if the facet is valid.", + "type": "object" + } + }, + "required": [ + "totalRecords", + "count", + "data" + ], + "allOf": [ + { + "$ref": "#/definitions/Facet" + } + ] + }, + "FacetError": { + "x-ms-discriminator-value": "FacetError", + "description": "A facet whose execution resulted in an error.", + "type": "object", + "properties": { + "errors": { + "description": "An array containing detected facet errors with details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "required": [ + "errors" + ], + "allOf": [ + { + "$ref": "#/definitions/Facet" + } + ] + }, + "ErrorResponse": { + "title": "Error response.", + "type": "object", + "description": "An error response from the API.", + "properties": { + "error": { + "$ref": "#/definitions/Error", + "description": "Error information." + } + }, + "required": [ + "error" + ] + }, + "Error": { + "title": "Error info.", + "type": "object", + "description": "Error details.", + "properties": { + "code": { + "type": "string", + "description": "Error code identifying the specific error." + }, + "message": { + "type": "string", + "description": "A human readable error message." + }, + "details": { + "type": "array", + "description": "Error details", + "items": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "required": [ + "code", + "message" + ] + }, + "ErrorDetails": { + "title": "Error details.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Error code identifying the specific error." + }, + "message": { + "type": "string", + "description": "A human readable error message." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "code", + "message" + ] + }, + "OperationListResult": { + "description": "Result of the request to list Resource Graph 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 Resource Graph operations supported by the Resource Graph resource provider." + } + } + }, + "Operation": { + "description": "Resource Graph REST API operation definition.", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft Resource Graph.", + "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": "Description for the operation.", + "type": "string" + } + } + }, + "origin": { + "type": "string", + "description": "The origin of operations." + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Api Version." + } + } +} diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/resourceshistory.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/resourceshistory.json new file mode 100644 index 000000000000..56b81330feff --- /dev/null +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2021-06-01-preview/resourceshistory.json @@ -0,0 +1,244 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Resource Graph", + "description": "Azure Resource Graph API Reference", + "version": "2021-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.ResourceGraph/resourcesHistory": { + "post": { + "description": "List all snapshots of a resource for a given time interval.", + "operationId": "ResourcesHistory", + "tags": [ + "History" + ], + "parameters": [ + { + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ResourcesHistoryRequest" + }, + "description": "Request specifying the query and its options." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + }, + "default": { + "description": "A response indicating an error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Resource History Query": { + "$ref": "./examples/ResourcesHistoryGet.json" + }, + "Resource History Management Group scope Query": { + "$ref": "./examples/ResourcesHistoryMgsGet.json" + } + } + } + } + }, + "definitions": { + "ResourcesHistoryRequest": { + "description": "Describes a history request to be executed.", + "type": "object", + "properties": { + "subscriptions": { + "description": "Azure subscriptions against which to execute the query.", + "type": "array", + "items": { + "type": "string", + "description": "Subscription Id." + } + }, + "query": { + "description": "The resources query.", + "type": "string" + }, + "options": { + "description": "The history request evaluation options", + "$ref": "#/definitions/ResourcesHistoryRequestOptions" + }, + "managementGroups": { + "description": "Azure management groups against which to execute the query. Example: [ 'mg1', 'mg2' ]", + "type": "array", + "items": { + "type": "string", + "description": "The name of Management group." + } + } + } + }, + "ResourcesHistoryRequestOptions": { + "description": "The options for history request evaluation", + "type": "object", + "properties": { + "interval": { + "description": "The time interval used to fetch history.", + "$ref": "#/definitions/DateTimeInterval" + }, + "$top": { + "description": "The maximum number of rows that the query should return. Overrides the page size when ```$skipToken``` property is present.", + "format": "int32", + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + "$skip": { + "description": "The number of rows to skip from the beginning of the results. Overrides the next page offset when ```$skipToken``` property is present.", + "type": "integer", + "format": "int32", + "minimum": 0 + }, + "$skipToken": { + "description": "Continuation token for pagination, capturing the next page size and offset, as well as the context of the query.", + "type": "string" + }, + "resultFormat": { + "description": "Defines in which format query result returned.", + "type": "string", + "enum": [ + "table", + "objectArray" + ], + "x-ms-enum": { + "name": "ResultFormat", + "modelAsString": false + } + } + } + }, + "DateTimeInterval": { + "description": "An interval in time specifying the date and time for the inclusive start and exclusive end, i.e. `[start, end)`.", + "type": "object", + "properties": { + "start": { + "description": "A datetime indicating the inclusive/closed start of the time interval, i.e. `[`**`start`**`, end)`. Specifying a `start` that occurs chronologically after `end` will result in an error.", + "type": "string", + "format": "date-time" + }, + "end": { + "description": "A datetime indicating the exclusive/open end of the time interval, i.e. `[start, `**`end`**`)`. Specifying an `end` that occurs chronologically before `start` will result in an error.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "start", + "end" + ] + }, + "ErrorResponse": { + "title": "Error response.", + "type": "object", + "description": "An error response from the API.", + "properties": { + "error": { + "$ref": "#/definitions/Error", + "description": "Error information." + } + }, + "required": [ + "error" + ] + }, + "Error": { + "title": "Error info.", + "type": "object", + "description": "Error details.", + "properties": { + "code": { + "type": "string", + "description": "Error code identifying the specific error." + }, + "message": { + "type": "string", + "description": "A human readable error message." + }, + "details": { + "type": "array", + "description": "Error details", + "items": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "required": [ + "code", + "message" + ] + }, + "ErrorDetails": { + "title": "Error details.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Error code identifying the specific error." + }, + "message": { + "type": "string", + "description": "A human readable error message." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "code", + "message" + ] + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Api Version." + } + } +} diff --git a/specification/resourcegraph/resource-manager/readme.md b/specification/resourcegraph/resource-manager/readme.md index bbf13fe032b6..009a6c07cb7d 100644 --- a/specification/resourcegraph/resource-manager/readme.md +++ b/specification/resourcegraph/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for the ResourceGraph API. ``` yaml title: ResourceGraphClient openapi-type: arm -tag: package-preview-2021-03 +tag: package-preview-2021-06 ``` ### Validations @@ -40,6 +40,17 @@ semantic-validator: true model-validator: true message-format: json ``` + + +### Tag: package-preview-2021-06 + +These settings apply only when `--tag=package-preview-2021-06` is specified on the command line. + +```yaml $(tag) == 'package-preview-2021-06' +input-file: + - Microsoft.ResourceGraph/preview/2021-06-01-preview/resourcegraph.json + - Microsoft.ResourceGraph/preview/2021-06-01-preview/resourceshistory.json +``` ### Tag: package-preview-2021-03 These settings apply only when `--tag=package-preview-2021-03` is specified on the command line. @@ -166,8 +177,6 @@ directive: reason: This is a clear scenario for a boolean and will not have more than 2 values in the future. ``` - - ## cli These settings apply only when `--cli` is specified on the command line. diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/ResourceHealth.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/ResourceHealth.json index 9bcfc79ddd76..f7b98da96c4c 100644 --- a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/ResourceHealth.json +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/ResourceHealth.json @@ -561,7 +561,9 @@ "ServiceIssue", "PlannedMaintenance", "HealthAdvisory", - "RCA" + "RCA", + "EmergingIssues", + "SecurityAdvisory" ], "x-ms-enum": { "name": "EventTypeValues", @@ -621,6 +623,7 @@ "description": "Level of event.", "enum": [ "Critical", + "Error", "Warning", "Informational" ], @@ -710,13 +713,21 @@ "type": "boolean", "description": "Tells if we want to enable or disable Microsoft Support for this event." }, + "description": { + "type": "string", + "description": "Contains the communication message for the event, that could include summary, root cause and other details." + }, + "platformInitiated": { + "type": "boolean", + "description": "Is true if the event is platform initiated." + }, "enableChatWithUs": { "type": "boolean", "description": "Tells if we want to enable or disable Microsoft Support for this event." }, "priority": { "type": "integer", - "description": "Priority level of the event." + "description": "Priority level of the event. Has value from 0 to 23. 0 is the highest priority. Service issue events have higher priority followed by planned maintenance and health advisory. Critical events have higher priority followed by error, warning and informational. Furthermore, active events have higher priority than resolved." }, "lastUpdateTime": { "type": "string", diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2018-07-01/ResourceHealth.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2018-07-01/ResourceHealth.json index 641ea46f5f22..5a4d2ec900c1 100644 --- a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2018-07-01/ResourceHealth.json +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2018-07-01/ResourceHealth.json @@ -456,7 +456,9 @@ "ServiceIssue", "PlannedMaintenance", "HealthAdvisory", - "RCA" + "RCA", + "EmergingIssues", + "SecurityAdvisory" ], "x-ms-enum": { "name": "EventTypeValues", @@ -516,6 +518,7 @@ "description": "Level of event.", "enum": [ "Critical", + "Error", "Warning", "Informational" ], @@ -605,13 +608,21 @@ "type": "boolean", "description": "Tells if we want to enable or disable Microsoft Support for this event." }, + "description": { + "type": "string", + "description": "Contains the communication message for the event, that could include summary, root cause and other details." + }, + "platformInitiated": { + "type": "boolean", + "description": "Is true if the event is platform initiated." + }, "enableChatWithUs": { "type": "boolean", "description": "Tells if we want to enable or disable Microsoft Support for this event." }, "priority": { "type": "integer", - "description": "Priority level of the event." + "description": "Priority level of the event. Has value from 0 to 23. 0 is the highest priority. Service issue events have higher priority followed by planned maintenance and health advisory. Critical events have higher priority followed by error, warning and informational. Furthermore, active events have higher priority than resolved." }, "lastUpdateTime": { "type": "string", diff --git a/specification/resourcehealth/resource-manager/readme.md b/specification/resourcehealth/resource-manager/readme.md index 24f70a412441..d361e0fc1f44 100644 --- a/specification/resourcehealth/resource-manager/readme.md +++ b/specification/resourcehealth/resource-manager/readme.md @@ -82,7 +82,7 @@ swagger-to-sdk: - repo: azure-sdk-for-go - repo: azure-sdk-for-js - repo: azure-sdk-for-node - - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-net - repo: azure-sdk-for-ruby @@ -95,6 +95,10 @@ swagger-to-sdk: See configuration in [readme.go.md](./readme.go.md) +## Python + +See configuration in [readme.python.md](./readme.python.md) + ## Java These settings apply only when `--java` is specified on the command line. diff --git a/specification/resourcehealth/resource-manager/readme.python.md b/specification/resourcehealth/resource-manager/readme.python.md new file mode 100644 index 000000000000..dad5c5e7961c --- /dev/null +++ b/specification/resourcehealth/resource-manager/readme.python.md @@ -0,0 +1,37 @@ +## Python + +These settings apply only when `--track2` is specified on the command line. + +``` yaml $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-resourcehealth +no-namespace-folders: true +package-version: 1.0.0b1 +``` + +### Python multi-api + +Generate all API versions currently shipped for this package + +```yaml $(multiapi) +clear-output-folder: true +batch: + - tag: package-2015-01 + - multiapiscript: true +``` + +``` yaml $(multiapiscript) +output-folder: $(python-sdks-folder)/resourcehealth/azure-mgmt-resourcehealth/azure/mgmt/resourcehealth/ +clear-output-folder: false +perform-load: false +``` +### Tag: package-2015-01 and python + +These settings apply only when `--tag=package-2015-01 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2015-01' +namespace: azure.mgmt.resourcehealth.v2015_01_01 +output-folder: $(python-sdks-folder)/resourcehealth/azure-mgmt-resourcehealth/azure/mgmt/resourcehealth/v2015_01_01 +``` diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2020-05-01/examples/DeletePrivateLinkAssociation.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2020-05-01/examples/DeletePrivateLinkAssociation.json new file mode 100644 index 000000000000..e2f208e0ecad --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2020-05-01/examples/DeletePrivateLinkAssociation.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "plaId": "00000000-0000-0000-0000-000000000000", + "groupId": "my-management-group", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "headers": {} + }, + "204": {} + } +} diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2020-05-01/examples/DeleteResourceManagementPrivateLink.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2020-05-01/examples/DeleteResourceManagementPrivateLink.json new file mode 100644 index 000000000000..e1de91c0e242 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2020-05-01/examples/DeleteResourceManagementPrivateLink.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "my-resource-group", + "api-version": "2020-05-01", + "rmplName": "my-rmplName" + }, + "responses": { + "200": { + "headers": {} + }, + "204": {} + } +} diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2020-05-01/examples/GetPrivateLinkAssociation.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2020-05-01/examples/GetPrivateLinkAssociation.json new file mode 100644 index 000000000000..89021a2e220f --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2020-05-01/examples/GetPrivateLinkAssociation.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "groupId": "my-management-group", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "privateLink": "00000000-0000-0000-0000-000000000000", + "publicNetworkAccess": "Enabled", + "tenantID": "06b3ccb8-1384-4bcc-aec7-852f6d57161b", + "scope": "/providers/Microsoft.Management/managementGroups/my-management-group" + }, + "id": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Authorization/privateLinkAssociations", + "name": "my-pla" + } + ] + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2020-05-01/examples/GetResourceManagementPrivateLink.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2020-05-01/examples/GetResourceManagementPrivateLink.json new file mode 100644 index 000000000000..0864a63291cc --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2020-05-01/examples/GetResourceManagementPrivateLink.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "my-resource-group", + "api-version": "2020-05-01", + "rmplName": "my-rmplName" + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpointConnections": [] + }, + "id": "00000000-0000-0000-0000-000000000000", + "name": "my-pla", + "type": "Microsoft.Authorization/privateLinkAssociations", + "location": "eastus" + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2020-05-01/examples/ListResourceManagementPrivateLink.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2020-05-01/examples/ListResourceManagementPrivateLink.json new file mode 100644 index 000000000000..50475dd7e7d8 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2020-05-01/examples/ListResourceManagementPrivateLink.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "privateEndpointConnections": [] + }, + "id": "00000000-0000-0000-0000-000000000000", + "name": "my-pla", + "type": "Microsoft.Authorization/privateLinkAssociations", + "location": "eastus" + }, + { + "properties": { + "privateEndpointConnections": [] + }, + "id": "00000000-0000-0000-0000-000000000001", + "name": "my-pla2", + "type": "Microsoft.Authorization/privateLinkAssociations", + "location": "eastus" + } + ] + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2020-05-01/examples/PutPrivateLinkAssociation.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2020-05-01/examples/PutPrivateLinkAssociation.json new file mode 100644 index 000000000000..44ebe70b1bce --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2020-05-01/examples/PutPrivateLinkAssociation.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "plaId": "00000000-0000-0000-0000-000000000000", + "groupId": "my-management-group", + "api-version": "2020-05-01", + "parameters": { + "privateLink": "00000000-0000-0000-0000-000000000000", + "publicNetworkAccess": "Enabled" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "privateLink": "00000000-0000-0000-0000-000000000000", + "publicNetworkAccess": "Enabled", + "tenantID": "06b3ccb8-1384-4bcc-aec7-852f6d57161b", + "scope": "/providers/Microsoft.Management/managementGroups/my-management-group" + }, + "id": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Authorization/privateLinkAssociations", + "name": "my-pla" + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2020-05-01/examples/PutResourceManagementPrivateLink.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2020-05-01/examples/PutResourceManagementPrivateLink.json new file mode 100644 index 000000000000..c4bfd6816823 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2020-05-01/examples/PutResourceManagementPrivateLink.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "my-resource-group", + "api-version": "2020-05-01", + "rmplName": "my-rmplName", + "parameters": { + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpointConnections": [] + }, + "id": "00000000-0000-0000-0000-000000000000", + "name": "my-pla", + "type": "Microsoft.Authorization/privateLinkAssociations", + "location": "eastus" + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2020-05-01/privateLinks.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2020-05-01/privateLinks.json new file mode 100644 index 000000000000..20bbc6b91487 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2020-05-01/privateLinks.json @@ -0,0 +1,545 @@ +{ + "swagger": "2.0", + "info": { + "title": "PolicyClient", + "version": "2020-05-01", + "description": "To manage and control access to your resources, you can define customized policies and assign them at a scope." + }, + "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.Management/managementGroups/{groupId}/providers/Microsoft.Authorization/privateLinkAssociations/{plaId}": { + "put": { + "tags": [ + "PrivateLinkAssociation" + ], + "operationId": "PrivateLinkAssociation_Put", + "description": "Create a PrivateLinkAssociation", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "$ref": "#/parameters/PrivateLinkAssociationIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateLinkAssociationProperties" + }, + "description": "Parameters supplied to create the private link association." + } + ], + "responses": { + "200": { + "description": "Ok - Returns information about the new private link association.", + "schema": { + "$ref": "#/definitions/PrivateLinkAssociation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a private link association, associate scope to rmpl.": { + "$ref": "./examples/PutPrivateLinkAssociation.json" + } + } + }, + "delete": { + "tags": [ + "PrivateLinkAssociation" + ], + "operationId": "PrivateLinkAssociation_Delete", + "description": "Delete a PrivateLinkAssociation", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "$ref": "#/parameters/PrivateLinkAssociationIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete a private link association.": { + "$ref": "./examples/DeletePrivateLinkAssociation.json" + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Authorization/privateLinkAssociations": { + "get": { + "tags": [ + "PrivateLinkAssociation" + ], + "operationId": "PrivateLinkAssociation_Get", + "description": "Get a private link association for a management group scope", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/GroupIdParameter" + } + ], + "responses": { + "200": { + "description": "Ok. The request has succeeded", + "schema": { + "$ref": "#/definitions/PrivateLinkAssociationGetResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a private link association for a MG scope.": { + "$ref": "./examples/GetPrivateLinkAssociation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/resourceManagementPrivateLinks/{rmplName}": { + "put": { + "tags": [ + "ResourceManagementPrivateLink" + ], + "operationId": "ResourceManagementPrivateLink_Put", + "description": "Create a resource management group private link.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group the template will be deployed to. The name is case insensitive.", + "minLength": 1, + "maxLength": 90 + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceManagementPrivateLinkParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceManagementPrivateLinkLocation" + }, + "description": "The region to create the Resource Management private link." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ResourceManagementPrivateLink" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create Resource Management Private Link.": { + "$ref": "./examples/PutResourceManagementPrivateLink.json" + } + } + }, + "get": { + "tags": [ + "ResourceManagementPrivateLink" + ], + "operationId": "ResourceManagementPrivateLink_Get", + "description": "Get a resource management private link(resource-level).", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group the template will be deployed to. The name is case insensitive.", + "minLength": 1, + "maxLength": 90 + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceManagementPrivateLinkParameter" + } + ], + "responses": { + "200": { + "description": "Ok. Returns information about the resource management private link.", + "schema": { + "$ref": "#/definitions/ResourceManagementPrivateLink" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a Resource Management Private Link(resource-level).": { + "$ref": "./examples/GetResourceManagementPrivateLink.json" + } + } + }, + "delete": { + "tags": [ + "ResourceManagementPrivateLink" + ], + "operationId": "ResourceManagementPrivateLink_Delete", + "description": "Delete a resource management private link.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group the template will be deployed to. The name is case insensitive.", + "minLength": 1, + "maxLength": 90 + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceManagementPrivateLinkParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete a Resource Management Private Link.": { + "$ref": "./examples/DeleteResourceManagementPrivateLink.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/resourceManagementPrivateLinks": { + "get": { + "tags": [ + "ResourceManagementPrivateLink" + ], + "operationId": "ResourceManagementPrivateLink_List", + "description": "Get all the resource management private links in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok - Returns an array of private links.", + "schema": { + "$ref": "#/definitions/ResourceManagementPrivateLinkListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete a Resource Management Private Link.": { + "$ref": "./examples/ListResourceManagementPrivateLink.json" + } + } + } + } + }, + "definitions": { + "PrivateLinkAssociationProperties": { + "type": "object", + "properties": { + "privateLink": { + "type": "string", + "description": "The rmpl Resource ID." + }, + "publicNetworkAccess": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "publicNetworkAccessOptions", + "modelAsString": true + } + } + } + }, + "PrivateLinkAssociationGetResult": { + "description": "Result of the request to get PLA for a MG scope. ", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkAssociation" + }, + "description": "private link association information." + } + } + }, + "PrivateLinkAssociationPropertiesExpanded": { + "type": "object", + "properties": { + "privateLink": { + "type": "string", + "description": "The rmpl Resource ID." + }, + "publicNetworkAccess": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "publicNetworkAccessOptions", + "modelAsString": true + } + }, + "tenantID": { + "type": "string", + "description": "The TenantID." + }, + "scope": { + "type": "string", + "description": "The scope of the private link association." + } + }, + "description": "Private Link Association Properties." + }, + "PrivateLinkAssociation": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkAssociationPropertiesExpanded", + "description": "The private link association properties." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The plaResourceID." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The operation type." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The pla name." + } + }, + "x-ms-azure-resource": true + }, + "ResourceManagementPrivateLink": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ResourceManagementPrivateLinkEndpointConnections" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The rmplResourceID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The rmpl Name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The operation type." + }, + "location": { + "type": "string", + "description": "the region of the rmpl" + } + }, + "x-ms-azure-resource": true + }, + "ResourceManagementPrivateLinkLocation": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "the region to create private link association." + } + } + }, + "ResourceManagementPrivateLinkEndpointConnections": { + "type": "object", + "properties": { + "privateEndpointConnections": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private endpoint connections." + } + } + }, + "ResourceManagementPrivateLinkListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceManagementPrivateLink" + }, + "description": "An array of resource management private links." + } + } + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse" + } + }, + "description": "An error response for a resource management request." + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for this operation." + }, + "GroupIdParameter": { + "name": "groupId", + "in": "path", + "required": true, + "type": "string", + "description": "The management group ID.", + "x-ms-parameter-location": "method", + "minLength": 1, + "maxLength": 90 + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the target subscription." + }, + "PrivateLinkAssociationIdParameter": { + "name": "plaId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the PLA", + "x-ms-parameter-location": "method" + }, + "ResourceManagementPrivateLinkParameter": { + "name": "rmplName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource management private link.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/SubscriptionFeatureRegistration.json b/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/SubscriptionFeatureRegistration.json new file mode 100644 index 000000000000..e3a656280516 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/SubscriptionFeatureRegistration.json @@ -0,0 +1,462 @@ +{ + "swagger": "2.0", + "info": { + "title": "FeatureClient", + "description": "Feature provider", + "version": "2021-07-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.Features/featureProviders/{providerNamespace}/subscriptionFeatureRegistrations/{featureName}": { + "get": { + "description": "Returns a feature registration", + "operationId": "SubscriptionFeatureRegistrations_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/FeatureNameParameter" + } + ], + "responses": { + "200": { + "description": "Subscription Feature Registration.", + "schema": { + "$ref": "#/definitions/SubscriptionFeatureRegistration" + } + }, + "default": { + "description": "Error response describing the reason for operation failure.", + "schema": { + "$ref": "./features.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets a feature registration": { + "$ref": "./examples/FeatureRegistration/SubscriptionFeatureRegistrationGET.json" + } + } + }, + "put": { + "description": "Create or update a feature registration.", + "operationId": "SubscriptionFeatureRegistrations_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/FeatureNameParameter" + }, + { + "name": "SubscriptionFeatureRegistrationType", + "description": "Subscription Feature Registration Type details.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SubscriptionFeatureRegistration" + } + } + ], + "responses": { + "200": { + "description": "The feature registration is created or updated successfully.", + "schema": { + "$ref": "#/definitions/SubscriptionFeatureRegistration" + } + }, + "default": { + "description": "Error response describing the reason for operation failure.", + "schema": { + "$ref": "./features.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Creates a feature registration": { + "$ref": "./examples/FeatureRegistration/SubscriptionFeatureRegistrationPUT.json" + } + } + }, + "delete": { + "description": "Deletes a feature registration", + "operationId": "SubscriptionFeatureRegistrations_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/FeatureNameParameter" + } + ], + "responses": { + "200": { + "description": "The feature registration has been deleted successfully." + }, + "204": { + "description": "The feature registration has been deleted already." + }, + "default": { + "description": "Error response describing the reason for operation failure.", + "schema": { + "$ref": "./features.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deletes a feature registration": { + "$ref": "./examples/FeatureRegistration/SubscriptionFeatureRegistrationDELETE.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Features/featureProviders/{providerNamespace}/subscriptionFeatureRegistrations": { + "get": { + "description": "Returns subscription feature registrations for given subscription and provider namespace.", + "operationId": "SubscriptionFeatureRegistrations_ListBySubscription", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProviderNamespaceParameter" + } + ], + "responses": { + "200": { + "description": "Subscription Feature Registrations.", + "schema": { + "$ref": "#/definitions/SubscriptionFeatureRegistrationList" + } + }, + "default": { + "description": "Error response describing the reason for operation failure.", + "schema": { + "$ref": "./features.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets a list of feature registrations": { + "$ref": "./examples/FeatureRegistration/SubscriptionFeatureRegistrationLIST.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Features/subscriptionFeatureRegistrations": { + "get": { + "description": "Returns subscription feature registrations for given subscription.", + "operationId": "SubscriptionFeatureRegistrations_ListAllBySubscription", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Subscription Feature Registrations.", + "schema": { + "$ref": "#/definitions/SubscriptionFeatureRegistrationList" + } + }, + "default": { + "description": "Error response describing the reason for operation failure.", + "schema": { + "$ref": "./features.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets a list of feature registrations": { + "$ref": "./examples/FeatureRegistration/SubscriptionFeatureRegistrationLISTALL.json" + } + } + } + } + }, + "definitions": { + "ProxyResource": { + "type": "object", + "description": "An Azure proxy resource.", + "properties": { + "id": { + "description": "Azure resource Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Azure resource name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Azure resource type.", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "SubscriptionFeatureRegistration": { + "type": "object", + "description": "Subscription feature registration details", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "properties": { + "tenantId": { + "type": "string", + "description": "The tenantId.", + "readOnly": true + }, + "subscriptionId": { + "type": "string", + "description": "The subscriptionId.", + "readOnly": true + }, + "featureName": { + "type": "string", + "description": "The featureName.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The featureDisplayName.", + "readOnly": true + }, + "providerNamespace": { + "type": "string", + "description": "The providerNamespace.", + "readOnly": true + }, + "state": { + "type": "string", + "description": "The state.", + "enum": [ + "NotSpecified", + "NotRegistered", + "Pending", + "Registering", + "Registered", + "Unregistering", + "Unregistered" + ], + "x-ms-enum": { + "name": "SubscriptionFeatureRegistrationState", + "modelAsString": true + } + }, + "authorizationProfile": { + "$ref": "#/definitions/AuthorizationProfile" + }, + "metadata": { + "type": "object", + "additionalProperties": { + "type": "string", + "maxLength": 1000 + }, + "description": "Key-value pairs for meta data." + }, + "releaseDate": { + "type": "string", + "format": "date-time", + "description": "The feature release date.", + "readOnly": true + }, + "registrationDate": { + "type": "string", + "format": "date-time", + "description": "The feature registration date.", + "readOnly": true + }, + "documentationLink": { + "type": "string", + "maxLength": 1000, + "description": "The feature documentation link.", + "readOnly": true + }, + "approvalType": { + "type": "string", + "description": "The feature approval type.", + "enum": [ + "NotSpecified", + "ApprovalRequired", + "AutoApproval" + ], + "x-ms-enum": { + "name": "SubscriptionFeatureRegistrationApprovalType", + "modelAsString": true + }, + "readOnly": true + }, + "shouldFeatureDisplayInPortal": { + "type": "boolean", + "default": false, + "description": "Indicates whether feature should be displayed in Portal." + }, + "description": { + "type": "string", + "maxLength": 1000, + "description": "The feature description." + } + }, + "type": "object" + } + } + }, + "AuthorizationProfile": { + "description": "Authorization Profile", + "type": "object", + "properties": { + "requestedTime": { + "type": "string", + "format": "date-time", + "description": "The requested time", + "readOnly": true + }, + "requester": { + "type": "string", + "description": "The requester", + "readOnly": true + }, + "requesterObjectId": { + "type": "string", + "description": "The requester object id", + "readOnly": true + }, + "approvedTime": { + "type": "string", + "format": "date-time", + "description": "The approved time", + "readOnly": true + }, + "approver": { + "type": "string", + "description": "The approver", + "readOnly": true + } + } + }, + "SubscriptionFeatureRegistrationList": { + "description": "The list of subscription feature registrations.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of subscription feature registrations list.", + "type": "string" + }, + "value": { + "description": "The list of subscription feature registrations.", + "type": "array", + "items": { + "$ref": "#/definitions/SubscriptionFeatureRegistration" + } + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure subscription ID.", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for this operation.", + "x-ms-parameter-location": "method" + }, + "ProviderNamespaceParameter": { + "name": "providerNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "The provider namespace.", + "x-ms-parameter-location": "method" + }, + "FeatureNameParameter": { + "name": "featureName", + "in": "path", + "required": true, + "type": "string", + "description": "The feature name.", + "x-ms-parameter-location": "method" + }, + "ActionNameParameter": { + "name": "actionName", + "in": "path", + "required": true, + "type": "string", + "description": "The action name.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/FeatureRegistration/SubscriptionFeatureRegistrationDELETE.json b/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/FeatureRegistration/SubscriptionFeatureRegistrationDELETE.json new file mode 100644 index 000000000000..ead23307b59d --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/FeatureRegistration/SubscriptionFeatureRegistrationDELETE.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "providerNamespace": "subscriptionFeatureRegistrationGroupTestRG", + "featureName": "testFeature", + "api-version": "2021-07-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/FeatureRegistration/SubscriptionFeatureRegistrationGET.json b/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/FeatureRegistration/SubscriptionFeatureRegistrationGET.json new file mode 100644 index 000000000000..87f3a8c694b4 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/FeatureRegistration/SubscriptionFeatureRegistrationGET.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "providerNamespace": "subscriptionFeatureRegistrationGroupTestRG", + "featureName": "testFeature", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "body": { + "name": "testFeature", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Features/featureProviders/Microsoft.TestRP/subscriptionFeatureRegistrations/testFeature", + "type": "Microsoft.Features/featureProviders/subscriptionFeatureRegistrations", + "properties": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "featureName": "testFeature", + "providerNamespace": "Microsoft.TestRP", + "state": "Pending", + "authorizationProfile": {}, + "releaseDate": "2019-11-05T00:34:53.1243228Z", + "approvalType": "ApprovalRequired", + "registrationDate": "2020-02-26T01:57:51.734777Z" + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/FeatureRegistration/SubscriptionFeatureRegistrationLIST.json b/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/FeatureRegistration/SubscriptionFeatureRegistrationLIST.json new file mode 100644 index 000000000000..458689ef3674 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/FeatureRegistration/SubscriptionFeatureRegistrationLIST.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "providerNamespace": "subscriptionFeatureRegistrationGroupTestRG", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "body": { + "nextLink": "string", + "value": [ + { + "name": "testFeature", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Features/featureProviders/Microsoft.TestRP/subscriptionFeatureRegistrations/testFeature", + "type": "Microsoft.Features/featureProviders/subscriptionFeatureRegistrations", + "properties": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "featureName": "testFeature", + "providerNamespace": "Microsoft.TestRP", + "state": "Pending", + "authorizationProfile": {}, + "releaseDate": "2019-11-05T00:34:53.1243228Z", + "approvalType": "ApprovalRequired", + "registrationDate": "2020-02-26T01:57:51.734777Z" + } + } + ] + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/FeatureRegistration/SubscriptionFeatureRegistrationLISTALL.json b/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/FeatureRegistration/SubscriptionFeatureRegistrationLISTALL.json new file mode 100644 index 000000000000..4a9b42f55c49 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/FeatureRegistration/SubscriptionFeatureRegistrationLISTALL.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "body": { + "nextLink": "string", + "value": [ + { + "name": "testFeature", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Features/featureProviders/Microsoft.TestRP/subscriptionFeatureRegistrations/testFeature", + "type": "Microsoft.Features/featureProviders/subscriptionFeatureRegistrations", + "properties": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "featureName": "testFeature", + "providerNamespace": "Microsoft.TestRP", + "state": "Pending", + "authorizationProfile": {}, + "releaseDate": "2019-11-05T00:34:53.1243228Z", + "approvalType": "ApprovalRequired", + "registrationDate": "2020-02-26T01:57:51.734777Z" + } + } + ] + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/FeatureRegistration/SubscriptionFeatureRegistrationPUT.json b/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/FeatureRegistration/SubscriptionFeatureRegistrationPUT.json new file mode 100644 index 000000000000..79f0e0e1a416 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/FeatureRegistration/SubscriptionFeatureRegistrationPUT.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "providerNamespace": "subscriptionFeatureRegistrationGroupTestRG", + "featureName": "testFeature", + "api-version": "2021-07-01", + "SubscriptionFeatureRegistrationType": { + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "name": "testFeature", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Features/featureProviders/Microsoft.TestRP/subscriptionFeatureRegistrations/testFeature", + "type": "Microsoft.Features/featureProviders/subscriptionFeatureRegistrations", + "properties": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "featureName": "testFeature", + "providerNamespace": "Microsoft.TestRP", + "state": "Pending", + "authorizationProfile": {}, + "releaseDate": "2019-11-05T00:34:53.1243228Z", + "approvalType": "ApprovalRequired", + "registrationDate": "2020-02-26T01:57:51.734777Z" + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/getFeature.json b/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/getFeature.json new file mode 100644 index 000000000000..fc7972ef903c --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/getFeature.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "resourceProviderNamespace": "Resource Provider Namespace", + "featureName": "feature", + "api-version": "2021-07-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "Feature1", + "properties": { + "state": "registered" + }, + "id": "feature_id1", + "type": "type1" + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/listFeaturesOperations.json b/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/listFeaturesOperations.json new file mode 100644 index 000000000000..847c4a7ef8e8 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/listFeaturesOperations.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2021-07-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "FeaturesOpeartion1", + "display": { + "provider": "Microsoft.ResourceProvider", + "resource": "Resource1", + "operation": "Read" + } + }, + { + "name": "FeaturesOpeartion2", + "display": { + "provider": "Microsoft.ResourceProvider", + "resource": "Resource2", + "operation": "Write" + } + } + ] + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/listProviderFeatures.json b/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/listProviderFeatures.json new file mode 100644 index 000000000000..9fbcf79d2d21 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/listProviderFeatures.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "resourceProviderNamespace": "Resource Provider Namespace", + "api-version": "2021-07-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "Feature1", + "properties": { + "state": "registered" + }, + "id": "feature_id1", + "type": "type1" + }, + { + "name": "Feature2", + "properties": { + "state": "unregistered" + }, + "id": "feature_id2", + "type": "type2" + } + ] + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/listSubscriptionFeatures.json b/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/listSubscriptionFeatures.json new file mode 100644 index 000000000000..033823aa7480 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/listSubscriptionFeatures.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "Feature1", + "properties": { + "state": "registered" + }, + "id": "feature_id1", + "type": "type1" + }, + { + "name": "Feature2", + "properties": { + "state": "unregistered" + }, + "id": "feature_id2", + "type": "type2" + } + ] + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/registerFeature.json b/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/registerFeature.json new file mode 100644 index 000000000000..fc7972ef903c --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/registerFeature.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "resourceProviderNamespace": "Resource Provider Namespace", + "featureName": "feature", + "api-version": "2021-07-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "Feature1", + "properties": { + "state": "registered" + }, + "id": "feature_id1", + "type": "type1" + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/unregisterFeature.json b/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/unregisterFeature.json new file mode 100644 index 000000000000..4da2c9578dd3 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/examples/unregisterFeature.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "resourceProviderNamespace": "Resource Provider Namespace", + "featureName": "feature", + "api-version": "2021-07-01", + "subscriptionId": "ff23096b-f5a2-46ea-bd62-59c3e93fef9a" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "Feature1", + "properties": { + "state": "unregistered" + }, + "id": "/subscriptions/ff23096b-f5a2-46ea-bd62-59c3e93fef9a/providers/Microsoft.Features/providers/Microsoft.Test/features/Feature1", + "type": "Microsoft.Features/providers/features" + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/features.json b/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/features.json new file mode 100644 index 000000000000..64550d6d16e1 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/features.json @@ -0,0 +1,456 @@ +{ + "swagger": "2.0", + "info": { + "title": "FeatureClient", + "version": "2021-07-01", + "description": "Azure Feature Exposure Control (AFEC) provides a mechanism for the resource providers to control feature exposure to users. Resource providers typically use this mechanism to provide public/private preview for new features prior to making them generally available. Users need to explicitly register for AFEC features to get access to such functionality." + }, + "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": { + "/providers/Microsoft.Features/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "ListOperations", + "description": "Lists all of the available Microsoft.Features REST API operations.", + "x-ms-examples": { + "List Features operations": { + "$ref": "./examples/listFeaturesOperations.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing the reason for operation failure.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Features/features": { + "get": { + "tags": [ + "Features" + ], + "operationId": "Features_ListAll", + "description": "Gets all the preview features that are available through AFEC for the subscription.", + "x-ms-examples": { + "List subscription Features": { + "$ref": "./examples/listSubscriptionFeatures.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array containing metadata for each feature. The metadata includes the name of the feature, the registration state, the resource ID, and resource type.", + "schema": { + "$ref": "#/definitions/FeatureOperationsListResult" + } + }, + "default": { + "description": "Error response describing the reason for operation failure.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Features/providers/{resourceProviderNamespace}/features": { + "get": { + "tags": [ + "Features" + ], + "operationId": "Features_List", + "description": "Gets all the preview features in a provider namespace that are available through AFEC for the subscription.", + "x-ms-examples": { + "List provider Features": { + "$ref": "./examples/listProviderFeatures.json" + } + }, + "parameters": [ + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace of the resource provider for getting features." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array containing metadata for each feature in the resource provider. The metadata includes the name of the feature, the registration state, the resource ID, and resource type.", + "schema": { + "$ref": "#/definitions/FeatureOperationsListResult" + } + }, + "default": { + "description": "Error response describing the reason for operation failure.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Features/providers/{resourceProviderNamespace}/features/{featureName}": { + "get": { + "tags": [ + "Features" + ], + "operationId": "Features_Get", + "description": "Gets the preview feature with the specified name.", + "x-ms-examples": { + "Get feature": { + "$ref": "./examples/getFeature.json" + } + }, + "parameters": [ + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "The resource provider namespace for the feature." + }, + { + "name": "featureName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the feature to get." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns metadata about the feature. The metadata includes the name of the feature, the registration state, the resource ID, and resource type.", + "schema": { + "$ref": "#/definitions/FeatureResult" + } + }, + "default": { + "description": "Error response describing the reason for operation failure.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Features/providers/{resourceProviderNamespace}/features/{featureName}/register": { + "post": { + "tags": [ + "Features" + ], + "operationId": "Features_Register", + "description": "Registers the preview feature for the subscription.", + "x-ms-examples": { + "Register feature": { + "$ref": "./examples/registerFeature.json" + } + }, + "parameters": [ + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace of the resource provider." + }, + { + "name": "featureName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the feature to register." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns metadata about the registered feature. The metadata includes the name of the feature, the registration state, the resource ID, and resource type.", + "schema": { + "$ref": "#/definitions/FeatureResult" + } + }, + "default": { + "description": "Error response describing the reason for operation failure.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Features/providers/{resourceProviderNamespace}/features/{featureName}/unregister": { + "post": { + "tags": [ + "Features" + ], + "operationId": "Features_Unregister", + "description": "Unregisters the preview feature for the subscription.", + "x-ms-examples": { + "Register feature": { + "$ref": "./examples/unregisterFeature.json" + } + }, + "parameters": [ + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace of the resource provider." + }, + { + "name": "featureName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the feature to unregister." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns metadata about the unregistered feature. The metadata includes the name of the feature, the registration state, the resource ID, and resource type.", + "schema": { + "$ref": "#/definitions/FeatureResult" + } + }, + "default": { + "description": "Error response describing the reason for operation failure.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "FeatureProperties": { + "type": "object", + "properties": { + "state": { + "type": "string", + "description": "The registration state of the feature for the subscription." + } + }, + "description": "Information about feature." + }, + "FeatureResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the feature." + }, + "properties": { + "$ref": "#/definitions/FeatureProperties", + "description": "Properties of the previewed feature." + }, + "id": { + "type": "string", + "description": "The resource ID of the feature." + }, + "type": { + "type": "string", + "description": "The resource type of the feature." + } + }, + "description": "Previewed feature information." + }, + "FeatureOperationsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FeatureResult" + }, + "description": "The array of features." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "List of previewed features." + }, + "Operation": { + "description": "Microsoft.Features operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "type": "object", + "description": "The object that represents the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft.Features", + "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" + } + } + } + } + }, + "OperationListResult": { + "type": "object", + "description": "Result of the request to list Microsoft.Features 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 Microsoft.Features operations." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "ErrorResponse": { + "type": "object", + "description": "Error response indicates that the service is not able to process the incoming request.", + "properties": { + "error": { + "$ref": "#/definitions/ErrorDefinition", + "description": "The error details." + } + } + }, + "ErrorDefinition": { + "description": "Error definition.", + "type": "object", + "properties": { + "code": { + "description": "Service specific error code which serves as the substatus for the HTTP error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Description of the error.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Internal error details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDefinition" + } + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure subscription ID." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for this operation." + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2021-01-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2021-01-01/subscriptions.json index f1a2f58dbb72..6470248df2b3 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2021-01-01/subscriptions.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2021-01-01/subscriptions.json @@ -34,37 +34,6 @@ } }, "paths": { - "/providers/Microsoft.Resources/operations": { - "get": { - "tags": [ - "Operations" - ], - "operationId": "Operations_List", - "description": "Lists all of the available Microsoft.Resources REST API operations.", - "parameters": [ - { - "$ref": "#/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/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, "/subscriptions/{subscriptionId}/locations": { "get": { "tags": [ diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/resources.json index bf742b4114e6..a4a7865bbb9e 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/resources.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/resources.json @@ -2958,7 +2958,7 @@ "in": "query", "required": false, "type": "string", - "description": "The filter to apply on the operation.

    The properties you can use for eq (equals) or ne (not equals) are: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version, and plan/promotionCode.

    For example, to filter by a resource type, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks'

    You can use substringof(value, property) in the filter. The properties you can use for substring are: name and resourceGroup.

    For example, to get all resources with 'demo' anywhere in the name, use: $filter=substringof('demo', name)

    You can link more than one substringof together by adding and/or operators.

    You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'. When you filter by a tag name and value, the tags for each resource are not returned in the results.

    You can use some properties together when filtering. The combinations you can use are: substringof and/or resourceType, plan and plan/publisher and plan/name, identity and identity/principalId." + "description": "The filter to apply on the operation.

    Filter comparison operators include `eq` (equals) and `ne` (not equals) and may be used with the following properties: `location`, `resourceType`, `name`, `resourceGroup`, `identity`, `identity/principalId`, `plan`, `plan/publisher`, `plan/product`, `plan/name`, `plan/version`, and `plan/promotionCode`.

    For example, to filter by a resource type, use `$filter=resourceType eq 'Microsoft.Network/virtualNetworks'`


    `substringof(value, property)` can be used to filter for substrings of the following currently-supported properties: `name` and `resourceGroup`

    For example, to get all resources with 'demo' anywhere in the resource name, use `$filter=substringof('demo', name)`

    Multiple substring operations can also be combined using `and`/`or` operators.


    Resources can be filtered by tag names and values. For example, to filter for a tag name and value, use `$filter=tagName eq 'tag1' and tagValue eq 'Value1'`. Note that when resources are filtered by tag name and value, the original tags for each resource will not be returned in the results. Any list of additional properties queried via `$expand` may also not be compatible when filtering by tag names/values.

    For tag names only, resources can be filtered by prefix using the following syntax: `$filter=startswith(tagName, 'depart')`. This query will return all resources with a tag name prefixed by the phrase `depart` (i.e.`department`, `departureDate`, `departureTime`, etc.)


    Note that some properties can be combined when filtering resources, which include the following: `substringof() and/or resourceType`, `plan and plan/publisher and plan/name`, and `identity and identity/principalId`." }, { "name": "$expand", diff --git a/specification/resources/resource-manager/readme.csharp.md b/specification/resources/resource-manager/readme.csharp.md index c7d0dfa459b5..4ada90fb2e15 100644 --- a/specification/resources/resource-manager/readme.csharp.md +++ b/specification/resources/resource-manager/readme.csharp.md @@ -836,6 +836,7 @@ output-folder: $(csharp-sdks-folder)/$(csharp-profile)/Resource/Management.Resou batch: - tag: package-features-2015-12 + - tag: package-features-2021-07 - tag: package-locks-2016-09 - tag: package-policy-2018-03 - tag: package-policy-2016-12 diff --git a/specification/resources/resource-manager/readme.go.md b/specification/resources/resource-manager/readme.go.md index e84d09cd6eb4..75467280330c 100644 --- a/specification/resources/resource-manager/readme.go.md +++ b/specification/resources/resource-manager/readme.go.md @@ -32,6 +32,7 @@ azure-arm: true batch: - tag: package-templatespecs-2019-06-preview - tag: package-features-2015-12 + - tag: package-features-2021-07 - tag: package-locks-2016-09 - tag: package-locks-2015-01 - tag: package-policy-2020-09 @@ -92,6 +93,16 @@ namespace: features output-folder: $(go-sdk-folder)/services/resources/mgmt/2019-07-01/$(namespace) ``` +### Tag: package-features-2021-07 and go + +These settings apply only when `--tag=package-features-2021-07 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-features-2021-07' && $(go) +namespace: features +output-folder: $(go-sdk-folder)/services/resources/mgmt/2021-07-01/$(namespace) +``` + ### Tag: package-features-2015-12 and go These settings apply only when `--tag=package-features-2015-12 --go` is specified on the command line. diff --git a/specification/resources/resource-manager/readme.java.md b/specification/resources/resource-manager/readme.java.md index 80329cfc0d59..20c5d927ae94 100644 --- a/specification/resources/resource-manager/readme.java.md +++ b/specification/resources/resource-manager/readme.java.md @@ -51,6 +51,7 @@ Generate all API versions currently shipped for this package ``` yaml $(java) && $(multiapi) batch: - tag: package-features-2015-12 + - tag: package-features-2021-07 - tag: package-locks-2016-09 - tag: package-managedapplications-2019-07 - tag: package-policy-2020-09 @@ -75,6 +76,20 @@ batch: - tag: package-subscriptions-2016-06 ``` +### Tag: package-features-2021-07 and java + +These settings apply only when `--tag=package-features-2021-07 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-features-2021-07' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.features.v2021_07_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/features/mgmt-v2021_07_01 +regenerate-manager: true +generate-interface: true +fconfig: '{"moduleName": "Features"}' +``` + ### Tag: package-features-2015-12 and java These settings apply only when `--tag=package-features-2015-12 --java` is specified on the command line. diff --git a/specification/resources/resource-manager/readme.md b/specification/resources/resource-manager/readme.md index 56a878d78930..3282eb0b44c9 100644 --- a/specification/resources/resource-manager/readme.md +++ b/specification/resources/resource-manager/readme.md @@ -29,7 +29,7 @@ openapi-type: arm ``` ``` yaml $(package-features) -tag: package-features-2015-12 +tag: package-features-2021-07 ``` ``` yaml $(package-locks) @@ -64,8 +64,20 @@ tag: package-deploymentscripts-2020-10 tag: package-templatespecs-2021-03-preview ``` + + +### Tag: package-privatelinks-2020-05 + +These settings apply only when `--tag=package-privatelinks-2020-05` is specified on the command line. + +``` yaml $(tag) == 'package-privatelinks-2020-05' +input-file: +- Microsoft.Authorization/stable/2020-05-01/privateLinks.json +``` + ### Tag: package-resources-2021-04 + These settings apply only when `--tag=package-resources-2021-04` is specified on the command line. ``` yaml $(tag) == 'package-resources-2021-04' @@ -128,6 +140,20 @@ input-file: - Microsoft.Resources/preview/2019-10-01-preview/deploymentScripts.json ``` +### Tag: package-features-2021-07 + +These settings apply only when `--tag=package-features-2021-07` is specified on the command line. + +``` yaml $(tag) == 'package-features-2021-07' +input-file: +- Microsoft.Features/stable/2021-07-01/features.json +- Microsoft.Features/stable/2021-07-01/SubscriptionFeatureRegistration.json + +# Needed when there is more than one input file +override-info: + title: FeatureClient +``` + ### Tag: package-features-2015-12 These settings apply only when `--tag=package-features-2015-12` is specified on the command line. @@ -614,6 +640,10 @@ directive: from: policyAssignments.json where: $.paths reason: operation APIs for Microsoft.Authorization are to be defined in RBAC swagger + - suppress: OperationsAPIImplementation + from: privateLinks.json + where: $.paths + reason: operation APIs for Microsoft.Authorization are to be defined in RBAC swagger - suppress: OperationsAPIImplementation from: policyDefinitions.json where: $.paths @@ -755,6 +785,18 @@ directive: - suppress: TopLevelResourcesListByResourceGroup from: policySetDefinitions.json reason: Policy set definitions are a proxy resource that is only usable on subscriptions or management groups + - suppress: RequiredReadOnlySystemData + from: privateLinks.json + reason: We do not yet support system data + - from: SubscriptionFeatureRegistration.json + suppress: R4009 + reason: Currently systemData is not allowed + - from: Subscriptions.json + suppress: OperationsAPIImplementation + reason: 'Duplicate Operations API causes generation issues' + - suppress: TopLevelResourcesListByResourceGroup + from: privateLinks.json + reason: The resource is managed in a management group level (instead of inside a resource group) ``` --- @@ -769,16 +811,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - after_scripts: - - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#features - - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#locks - - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#policy - - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#resources - - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#subscriptions - - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#links - - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#templatespecs - - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#deploymentscripts - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/resources/resource-manager/readme.python.md b/specification/resources/resource-manager/readme.python.md index 2be524003445..0d068e7b3951 100644 --- a/specification/resources/resource-manager/readme.python.md +++ b/specification/resources/resource-manager/readme.python.md @@ -2,19 +2,6 @@ These settings apply only when `--python` is specified on the command line. -```yaml !$(track2) -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - package-name: azure-mgmt-resource - payload-flattening-threshold: 2 - clear-output-folder: true - package-version: 1.0.0b1 - no-namespace-folders: true - verbose: true - debug: true -``` - ``` yaml $(track2) azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION @@ -28,52 +15,10 @@ no-namespace-folders: true Generate all API versions currently shipped for this package -```yaml $(multiapi) && !$(track2) -batch: - - tag: package-features-2015-12 - - tag: package-links-2016-09 - - tag: package-locks-2016-09 - - tag: package-locks-2015-01 - - tag: package-managedapplications-2018-06 - - tag: package-policy-2020-09 - - tag: package-policy-2019-09 - - tag: package-policy-2019-06 - - tag: package-policy-2019-01 - - tag: package-policy-2018-05 - - tag: package-policy-2018-03 - - tag: package-policy-2017-06 - - tag: package-policy-2016-12 - - tag: package-policy-2016-04 - - tag: package-policy-2015-10 - - tag: package-resources-2021-04 - - tag: package-resources-2021-01 - - tag: package-resources-2020-10 - - tag: package-resources-2020-06 - - tag: package-resources-2019-10 - - tag: package-resources-2019-08 - - tag: package-resources-2019-07 - - tag: package-resources-2019-0510 - - tag: package-resources-2019-05 - - tag: package-resources-2019-03 - - tag: package-resources-2018-05 - - tag: package-resources-2018-02 - - tag: package-resources-2017-05 - - tag: package-resources-2016-09 - - tag: package-resources-2016-02 - - tag: package-subscriptions-2019-11 - - tag: package-subscriptions-2019-06 - - tag: package-subscriptions-2018-06 - - tag: package-subscriptions-2016-06 - - tag: package-deploymentscripts-2020-10 - - tag: package-deploymentscripts-2019-10-preview - - tag: package-templatespecs-2021-05 - - tag: package-templatespecs-2021-03-preview - - tag: package-templatespecs-2019-06-preview -``` - ```yaml $(multiapi) && $(track2) clear-output-folder: true batch: + - tag: package-features-2021-07 - tag: package-features-2015-12 - multiapiscript-features: true - tag: package-links-2016-09 @@ -109,6 +54,7 @@ batch: - tag: package-resources-2016-09 - tag: package-resources-2016-02 - multiapiscript-resources: true + - tag: package-subscriptions-2021-01 - tag: package-subscriptions-2019-11 - tag: package-subscriptions-2019-06 - tag: package-subscriptions-2018-06 @@ -189,6 +135,19 @@ clear-output-folder: false perform-load: false ``` +### Tag: package-features-2021-07 and python + +These settings apply only when `--tag=package-features-2021-07 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-features-2021-07' +namespace: azure.mgmt.resource.features.v2021_07_01 +output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/features/v2021_07_01 +python: + namespace: azure.mgmt.resource.features.v2021_07_01 + output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/features/v2021_07_01 +``` + ### Tag: package-features-2015-12 and python These settings apply only when `--tag=package-features-2015-12 --python` is specified on the command line. @@ -197,9 +156,6 @@ Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-subscriptions-2021-01' +namespace: azure.mgmt.resource.subscriptions.v2021_01_01 +output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/subscriptions/v2021_01_01 ``` ### Tag: package-subscriptions-2019-11 and python @@ -587,9 +466,6 @@ Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-features-2021-07' && $(ruby) +namespace: "Azure::Features::Mgmt::V2021_07_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_features/lib +``` + ### Tag: package-features-2015-12 and ruby These settings apply only when `--tag=package-features-2015-12 --ruby` is specified on the command line. diff --git a/specification/resources/resource-manager/readme.typescript.md b/specification/resources/resource-manager/readme.typescript.md index c81fd57d2aed..bd27c256a4ff 100644 --- a/specification/resources/resource-manager/readme.typescript.md +++ b/specification/resources/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) && !$(profile) +```yaml $(typescript) && !$(profile-content) typescript: azure-arm: true batch: true @@ -17,49 +17,49 @@ batch: - package-managedapplications: true ``` -```yaml $(typescript) && $(package-features) && !$(profile) +```yaml $(typescript) && $(package-features) && !$(profile-content) typescript: package-name: "@azure/arm-features" output-folder: "$(typescript-sdks-folder)/sdk/features/arm-features" clear-output-folder: true ``` -```yaml $(typescript) && $(package-locks) && !$(profile) +```yaml $(typescript) && $(package-locks) && !$(profile-content) typescript: package-name: "@azure/arm-locks" output-folder: "$(typescript-sdks-folder)/sdk/locks/arm-locks" clear-output-folder: true ``` -```yaml $(typescript) && $(package-policy) && !$(profile) +```yaml $(typescript) && $(package-policy) && !$(profile-content) typescript: package-name: "@azure/arm-policy" output-folder: "$(typescript-sdks-folder)/sdk/policy/arm-policy" clear-output-folder: true ``` -```yaml $(typescript) && $(package-resources) && !$(profile) +```yaml $(typescript) && $(package-resources) && !$(profile-content) typescript: package-name: "@azure/arm-resources" output-folder: "$(typescript-sdks-folder)/sdk/resources/arm-resources" clear-output-folder: true ``` -```yaml $(typescript) && $(package-links) && !$(profile) +```yaml $(typescript) && $(package-links) && !$(profile-content) typescript: package-name: "@azure/arm-links" output-folder: "$(typescript-sdks-folder)/sdk/links/arm-links" clear-output-folder: true ``` -```yaml $(typescript) && $(package-managedapplications) && !$(profile) +```yaml $(typescript) && $(package-managedapplications) && !$(profile-content) typescript: package-name: "@azure/arm-managedapplications" output-folder: "$(typescript-sdks-folder)/sdk/managedapplications/arm-managedapplications" clear-output-folder: true ``` -```yaml $(tag)=='package-resources-2018-05' && $(profile)=='profile-hybrid-2019-03-01' +```yaml $(tag)=='package-resources-2018-05' && $(profile-content)=='profile-hybrid-2019-03-01' typescript: azure-arm: true generate-metadata: true @@ -70,7 +70,7 @@ typescript: - tag: package-resources-2018-05 ``` -```yaml $(tag)=='package-policy-2016-12' && $(profile)=='profile-hybrid-2019-03-01' +```yaml $(tag)=='package-policy-2016-12' && $(profile-content)=='profile-hybrid-2019-03-01' typescript: azure-arm: true generate-metadata: true @@ -81,7 +81,7 @@ typescript: - tag: package-policy-2016-12 ``` -```yaml $(tag)=='package-locks-2016-09' && $(profile)=='profile-hybrid-2019-03-01' +```yaml $(tag)=='package-locks-2016-09' && $(profile-content)=='profile-hybrid-2019-03-01' typescript: azure-arm: true generate-metadata: true @@ -92,7 +92,7 @@ typescript: - tag: package-locks-2016-09 ``` -```yaml $(tag)=='package-subscriptions-2016-06' && $(profile)=='profile-hybrid-2019-03-01' +```yaml $(tag)=='package-subscriptions-2016-06' && $(profile-content)=='profile-hybrid-2019-03-01' typescript: azure-arm: true generate-metadata: true @@ -103,7 +103,7 @@ typescript: - tag: package-subscriptions-2016-06 ``` -```yaml $(tag)=='package-resources-2019-10' && $(profile)=='profile-hybrid-2020-09-01' +```yaml $(tag)=='package-resources-2019-10' && $(profile-content)=='profile-hybrid-2020-09-01' typescript: azure-arm: true generate-metadata: true @@ -114,7 +114,7 @@ typescript: - tag: package-resources-2019-10 ``` -```yaml $(tag)=='package-policy-2016-12' && $(profile)=='profile-hybrid-2020-09-01' +```yaml $(tag)=='package-policy-2016-12' && $(profile-content)=='profile-hybrid-2020-09-01' typescript: azure-arm: true generate-metadata: true @@ -125,7 +125,7 @@ typescript: - tag: package-policy-2016-12 ``` -```yaml $(tag)=='package-locks-2016-09' && $(profile)=='profile-hybrid-2020-09-01' +```yaml $(tag)=='package-locks-2016-09' && $(profile-content)=='profile-hybrid-2020-09-01' typescript: azure-arm: true generate-metadata: true @@ -136,7 +136,7 @@ typescript: - tag: package-locks-2016-09 ``` -```yaml $(tag)=='package-subscriptions-2016-06' && $(profile)=='profile-hybrid-2020-09-01' +```yaml $(tag)=='package-subscriptions-2016-06' && $(profile-content)=='profile-hybrid-2020-09-01' typescript: azure-arm: true generate-metadata: true @@ -145,4 +145,4 @@ typescript: clear-output-folder: true batch: - tag: package-subscriptions-2016-06 -``` \ No newline at end of file +``` diff --git a/specification/scheduler/resource-manager/readme.md b/specification/scheduler/resource-manager/readme.md index 05a09f91762f..0c2c1b887130 100644 --- a/specification/scheduler/resource-manager/readme.md +++ b/specification/scheduler/resource-manager/readme.md @@ -71,6 +71,7 @@ This is not used by Autorest itself. swagger-to-sdk: - repo: azure-sdk-for-net - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-ruby @@ -96,45 +97,7 @@ csharp: ## Python -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.scheduler - package-name: azure-mgmt-scheduler - clear-output-folder: true -``` - -``` yaml $(python) && $(track2) -python-mode: create -azure-arm: true -license-header: MICROSOFT_MIT_NO_VERSION -namespace: azure.mgmt.scheduler -package-name: azure-mgmt-scheduler -package-version: 7.0.0b1 -clear-output-folder: true -``` - -``` yaml $(python) && $(python-mode) == 'update' -no-namespace-folders: true -output-folder: $(python-sdks-folder)/scheduler/azure-mgmt-scheduler/azure/mgmt/scheduler -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/scheduler/azure-mgmt-scheduler/azure/mgmt/scheduler -``` -``` yaml $(python) && $(python-mode) == 'create' -basic-setup-py: true -output-folder: $(python-sdks-folder)/scheduler/azure-mgmt-scheduler -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/scheduler/azure-mgmt-scheduler -``` +See configuration in [readme.python.md](./readme.python.md) ## Go diff --git a/specification/scheduler/resource-manager/readme.python.md b/specification/scheduler/resource-manager/readme.python.md new file mode 100644 index 000000000000..4365d0801e93 --- /dev/null +++ b/specification/scheduler/resource-manager/readme.python.md @@ -0,0 +1,47 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) && !$(track2) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.scheduler + package-name: azure-mgmt-scheduler + package-version: 0.1.0 + clear-output-folder: true +``` + +``` yaml $(python) && $(track2) +python-mode: create +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +namespace: azure.mgmt.scheduler +package-name: azure-mgmt-scheduler +package-version: 7.0.0b1 +clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' && !$(track2) +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/scheduler/azure-mgmt-scheduler/azure/mgmt/scheduler +``` + +``` yaml $(python) && $(python-mode) == 'create' && !$(track2) +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/scheduler/azure-mgmt-scheduler +``` + +``` yaml $(python) && $(python-mode) == 'update' && $(track2) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/scheduler/azure-mgmt-scheduler/azure/mgmt/scheduler +``` +``` yaml $(python) && $(python-mode) == 'create' && $(track2) +basic-setup-py: true +output-folder: $(python-sdks-folder)/scheduler/azure-mgmt-scheduler +``` \ No newline at end of file diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json index 532c46803106..0d1de8fcf10a 100644 --- a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json @@ -7822,6 +7822,162 @@ }, "description": "Text analytics positive-negative sentiment analysis, scored as a floating point value in a range of zero to 1." }, + "SentimentSkillV3": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.V3.SentimentSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "type": "string", + "x-nullable": true, + "description": "A value indicating which language code to use. Default is en." + }, + "includeOpinionMining": { + "type": "boolean", + "default": false, + "description": "If set to true, the skill output will include information from Text Analytics for opinion mining, namely targets (nouns or verbs) and their associated assessment (adjective) in the text. Default is false." + }, + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-sentiment-v3" + }, + "description": "Using the Text Analytics API, evaluates unstructured text and for each record, provides sentiment labels (such as \"negative\", \"neutral\" and \"positive\") based on the highest confidence score found by the service at a sentence and document-level." + }, + "EntityLinkingSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.V3.EntityLinkingSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "type": "string", + "x-nullable": true, + "description": "A value indicating which language code to use. Default is en." + }, + "minimumPrecision": { + "type": "number", + "format": "double", + "minimum": 0.0, + "maximum": 1.0, + "x-nullable": true, + "description": "A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included." + }, + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-entity-linking-v3" + }, + "description": "Using the Text Analytics API, extracts linked entities from text." + }, + "EntityRecognitionSkillV3": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.V3.EntityRecognitionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "categories": { + "type": "array", + "items": { + "type": "string", + "x-nullable": false + }, + "description": "A list of entity categories that should be extracted." + }, + "defaultLanguageCode": { + "type": "string", + "x-nullable": true, + "description": "A value indicating which language code to use. Default is en." + }, + "minimumPrecision": { + "type": "number", + "format": "double", + "minimum": 0.0, + "maximum": 1.0, + "x-nullable": true, + "description": "A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included." + }, + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-entity-recognition-v3" + }, + "description": "Using the Text Analytics API, extracts entities of different types from text." + }, + "PIIDetectionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.PIIDetectionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "type": "string", + "x-nullable": true, + "description": "A value indicating which language code to use. Default is en." + }, + "minimumPrecision": { + "type": "number", + "format": "double", + "x-nullable": true, + "minimum": 0.0, + "maximum": 1.0, + "description": "A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included." + }, + "maskingMode": { + "$ref": "#/definitions/PIIDetectionSkillMaskingMode", + "description": "A parameter that provides various ways to mask the personal information detected in the input text. Default is 'none'." + }, + "maskingCharacter": { + "type": "string", + "x-nullable": true, + "maxLength": 1, + "description": "The character used to mask the text if the maskingMode parameter is set to replace. Default is '*'." + }, + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary." + }, + "piiCategories": { + "type": "array", + "items": { + "type": "string", + "x-nullable": false + }, + "description": "A list of PII entity categories that should be extracted and masked." + }, + "domain": { + "type": "string", + "x-nullable": true, + "description": "If specified, will set the PII domain to include only a subset of the entity categories. Possible values include: 'phi', 'none'. Default is 'none'." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-pii-detection" + }, + "description": "Using the Text Analytics API, extracts personal information from an input text and gives you the option of masking it." + }, "SplitSkill": { "x-ms-discriminator-value": "#Microsoft.Skills.Text.SplitSkill", "allOf": [ @@ -8187,6 +8343,30 @@ }, "description": "A string indicating what entity categories to return." }, + "PIIDetectionSkillMaskingMode": { + "type": "string", + "enum": [ + "none", + "replace" + ], + "x-ms-enum": { + "name": "PIIDetectionSkillMaskingMode", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "No masking occurs and the maskedText output will not be returned." + }, + { + "value": "replace", + "name": "Replace", + "description": "Replaces the detected entities with the character given in the maskingCharacter parameter. The character will be repeated to the length of the detected entity so that the offsets will correctly correspond to both the input text as well as the output maskedText." + } + ] + }, + "description": "A string indicating what maskingMode to use to mask the personal information detected in the input text." + }, "SentimentSkillLanguage": { "type": "string", "enum": [ diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchIndexAutocompleteDocumentsGet.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchIndexAutocompleteDocumentsGet.json new file mode 100644 index 000000000000..0c330a22fe55 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchIndexAutocompleteDocumentsGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2021-04-30-Preview", + "autocompleteMode": "oneTerm", + "search": "washington medic", + "suggesterName": "sg", + "filter": "search.in(docId,'101,102,105')", + "fuzzy": false, + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": 80, + "searchFields": [ + "title", + "description" + ], + "top": 10 + }, + "responses": { + "200": { + "body": [ + { + "text": "medicaid", + "queryPlusText": "washington medicaid" + }, + { + "text": "medicare", + "queryPlusText": "washington medicare" + }, + { + "text": "medicine", + "queryPlusText": "washington medicine" + } + ] + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchIndexAutocompleteDocumentsPost.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchIndexAutocompleteDocumentsPost.json new file mode 100644 index 000000000000..7c10e1388b6a --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchIndexAutocompleteDocumentsPost.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2021-04-30-Preview", + "autocompleteRequest": { + "autocompleteMode": "oneTerm", + "search": "washington medic", + "suggesterName": "sg", + "filter": "search.in(docId,'101,102,105')", + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": 80, + "searchFields": "title,description", + "top": 10 + } + }, + "responses": { + "200": { + "body": [ + { + "text": "medicaid", + "queryPlusText": "washington medicaid" + }, + { + "text": "medicare", + "queryPlusText": "washington medicare" + }, + { + "text": "medicine", + "queryPlusText": "washington medicine" + } + ] + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchIndexCountDocuments.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchIndexCountDocuments.json new file mode 100644 index 000000000000..7d74c1c48ce1 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchIndexCountDocuments.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2021-04-30-Preview" + }, + "responses": { + "200": { + "body": 427 + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchIndexGetDocument.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchIndexGetDocument.json new file mode 100644 index 000000000000..7aafa411b800 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchIndexGetDocument.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2021-04-30-Preview", + "key": "1", + "$select": [ + "docId", + "title", + "description" + ] + }, + "responses": { + "200": { + "body": { + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchIndexIndexDocuments.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchIndexIndexDocuments.json new file mode 100644 index 000000000000..21704a2be544 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchIndexIndexDocuments.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2021-04-30-Preview", + "batch": { + "value": [ + { + "@search.action": "upload", + "docId": "1", + "title": "Fancy Stay", + "description": "Best hotel in town" + }, + { + "@search.action": "merge", + "docId": "2", + "title": "Roach Motel" + }, + { + "@search.action": "mergeOrUpload", + "docId": "3", + "title": "Econo Motel" + }, + { + "@search.action": "delete", + "docId": "4" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "key": "1", + "status": true, + "errorMessage": null, + "statusCode": 201 + }, + { + "key": "2", + "status": true, + "errorMessage": null, + "statusCode": 200 + }, + { + "key": "3", + "status": true, + "errorMessage": null, + "statusCode": 200 + }, + { + "key": "4", + "status": true, + "errorMessage": null, + "statusCode": 200 + } + ] + } + }, + "207": { + "body": { + "value": [ + { + "key": "1", + "status": true, + "errorMessage": null, + "statusCode": 200 + }, + { + "key": "2", + "status": false, + "errorMessage": "Document not found.", + "statusCode": 404 + }, + { + "key": "3", + "status": true, + "errorMessage": null, + "statusCode": 200 + }, + { + "key": "4", + "status": true, + "errorMessage": null, + "statusCode": 200 + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchIndexSearchDocumentsGet.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchIndexSearchDocumentsGet.json new file mode 100644 index 000000000000..4c73bac5d8b1 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchIndexSearchDocumentsGet.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2021-04-30-Preview", + "$count": true, + "facet": [ + "category,count:10,sort:count" + ], + "$filter": "rating gt 10", + "highlight": [ + "title" + ], + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": 80, + "$orderby": [ + "search.score() desc", + "rating desc" + ], + "queryType": "simple", + "sessionId": "mysessionid", + "scoringStatistics": "global", + "scoringParameters": [ + "currentLocation--122.123,44.77233" + ], + "scoringProfile": "sp", + "search": "nice hotels", + "searchFields": [ + "title", + "description" + ], + "searchMode": "any", + "$select": [ + "docId", + "title", + "description" + ], + "$skip": 100, + "$top": 10 + }, + "responses": { + "200": { + "body": { + "@odata.count": 25, + "@search.coverage": 80, + "@search.facets": { + "category": [ + { + "count": 1, + "value": "Economy" + }, + { + "count": 1, + "value": "Luxury" + } + ] + }, + "value": [ + { + "@search.score": 1.50, + "@search.highlights": { + "title": [ + "Nice Hotel" + ] + }, + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + }, + { + "@search.score": 0.70, + "@search.highlights": { + "title": [ + "Fancy Hotel" + ] + }, + "description": "Best hotel in town", + "docId": "2", + "title": "Fancy Hotel" + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchIndexSearchDocumentsPost.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchIndexSearchDocumentsPost.json new file mode 100644 index 000000000000..b09ac183ab5f --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchIndexSearchDocumentsPost.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2021-04-30-Preview", + "searchRequest": { + "count": true, + "facets": [ + "category,count:10,sort:count" + ], + "filter": "rating gt 4.0", + "highlight": "title", + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": null, + "orderby": "search.score() desc,rating desc", + "queryType": "simple", + "scoringParameters": [ + "currentLocation--122.123,44.77233" + ], + "scoringProfile": "sp", + "search": "nice hotels", + "searchFields": "title,description", + "searchMode": "any", + "sessionId": "mysessionid", + "scoringStatistics": "global", + "select": "docId,title,description", + "skip": 0, + "top": 10 + } + }, + "responses": { + "200": { + "body": { + "@odata.count": 25, + "@search.facets": { + "category": [ + { + "count": 1, + "value": "Economy" + }, + { + "count": 1, + "value": "Luxury" + } + ] + }, + "@search.nextPageParameters": { + "count": true, + "facets": [ + "category,count:10,sort:count" + ], + "filter": "rating gt 4.0", + "highlight": "title", + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": null, + "orderby": "search.score() desc,rating desc", + "queryType": "simple", + "sessionId": "mysessionid", + "scoringStatistics": "global", + "scoringParameters": [ + "currentLocation--122.123,44.77233" + ], + "scoringProfile": "sp", + "search": "nice hotels", + "searchFields": "title,description", + "searchMode": "any", + "select": "docId,title,description", + "skip": 2, + "top": 8 + }, + "value": [ + { + "@search.score": 1.50, + "@search.highlights": { + "title": [ + "Nice Hotel" + ] + }, + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + }, + { + "@search.score": 0.70, + "@search.highlights": { + "title": [ + "Fancy Hotel" + ] + }, + "description": "Best hotel in town", + "docId": "2", + "title": "Fancy Hotel" + } + ], + "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2021-04-30-Preview" + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchIndexSuggestDocumentsGet.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchIndexSuggestDocumentsGet.json new file mode 100644 index 000000000000..206c82eaeeb1 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchIndexSuggestDocumentsGet.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2021-04-30-Preview", + "$filter": "rating gt 10", + "fuzzy": false, + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": 80, + "$orderby": [ + "search.score() desc", + "rating desc" + ], + "search": "hote", + "searchFields": [ + "title" + ], + "suggesterName": "sg", + "$select": [ + "docId", + "title", + "description" + ], + "$top": 10 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "@search.text": "Nice Hotel", + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + }, + { + "@search.text": "Fancy Hotel", + "description": "Best hotel in town", + "docId": "2", + "title": "Fancy Hotel" + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchIndexSuggestDocumentsPost.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchIndexSuggestDocumentsPost.json new file mode 100644 index 000000000000..ebb17c924e40 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchIndexSuggestDocumentsPost.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2021-04-30-Preview", + "suggestRequest": { + "filter": "rating gt 4.0", + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": 80, + "orderby": "rating desc", + "search": "hote", + "searchFields": "title", + "select": "docId,title,description", + "suggesterName": "sg", + "top": 10 + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "@search.text": "Nice Hotel", + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + }, + { + "@search.text": "Fancy Hotel", + "description": "Best hotel in town", + "docId": "2", + "title": "Fancy Hotel" + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceCreateDataSource.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceCreateDataSource.json new file mode 100644 index 000000000000..72dd5e8e133d --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceCreateDataSource.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2021-04-30-Preview", + "dataSource": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": "AccountEndpoint=https://myDocDbEndpoint.documents.azure.com;AccountKey=myDocDbAuthKey;Database=myDocDbDatabaseId" + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceCreateIndex.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceCreateIndex.json new file mode 100644 index 000000000000..8cc0a87c190f --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceCreateIndex.json @@ -0,0 +1,373 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2021-04-30-Preview", + "index": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "key": true, + "searchable": false + }, + { + "name": "baseRate", + "type": "Edm.Double" + }, + { + "name": "description", + "type": "Edm.String", + "filterable": false, + "sortable": false, + "facetable": false + }, + { + "name": "description_fr", + "type": "Edm.String", + "filterable": false, + "sortable": false, + "facetable": false, + "analyzer": "fr.lucene" + }, + { + "name": "hotelName", + "type": "Edm.String" + }, + { + "name": "category", + "type": "Edm.String" + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "analyzer": "tagsAnalyzer" + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean" + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean" + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset" + }, + { + "name": "rating", + "type": "Edm.Int32" + }, + { + "name": "location", + "type": "Edm.GeographyPoint" + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "" + } + }, + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.BM25Similarity", + "b": 0.5, + "k1": 1.3 + } + } + }, + "responses": { + "201": { + "body": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + }, + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.BM25Similarity", + "b": 0.5, + "k1": 1.3 + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceCreateIndexer.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceCreateIndexer.json new file mode 100644 index 000000000000..55f614e73e53 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceCreateIndexer.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2021-04-30-Preview", + "indexer": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceCreateOrUpdateDataSource.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceCreateOrUpdateDataSource.json new file mode 100644 index 000000000000..bd6d5a2955dc --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceCreateOrUpdateDataSource.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "dataSourceName": "mydatasource", + "api-version": "2021-04-30-Preview", + "Prefer": "return=representation", + "dataSource": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": "AccountEndpoint=https://myDocDbEndpoint.documents.azure.com;AccountKey=myDocDbAuthKey;Database=myDocDbDatabaseId" + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + }, + "responses": { + "200": { + "body": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + }, + "201": { + "body": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceCreateOrUpdateIndex.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceCreateOrUpdateIndex.json new file mode 100644 index 000000000000..d47abe426fa7 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceCreateOrUpdateIndex.json @@ -0,0 +1,598 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "hotels", + "allowIndexDowntime": false, + "api-version": "2021-04-30-Preview", + "Prefer": "return=representation", + "index": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "key": true, + "searchable": false + }, + { + "name": "baseRate", + "type": "Edm.Double" + }, + { + "name": "description", + "type": "Edm.String", + "filterable": false, + "sortable": false, + "facetable": false + }, + { + "name": "description_fr", + "type": "Edm.String", + "filterable": false, + "sortable": false, + "facetable": false, + "analyzer": "fr.lucene" + }, + { + "name": "hotelName", + "type": "Edm.String" + }, + { + "name": "category", + "type": "Edm.String" + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "analyzer": "tagsAnalyzer" + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean" + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean" + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset" + }, + { + "name": "rating", + "type": "Edm.Int32" + }, + { + "name": "location", + "type": "Edm.GeographyPoint" + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + }, + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.ClassicSimilarity" + } + } + }, + "responses": { + "200": { + "body": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + }, + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.ClassicSimilarity" + } + } + }, + "201": { + "body": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceCreateOrUpdateIndexer.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceCreateOrUpdateIndexer.json new file mode 100644 index 000000000000..8e1d36f1dc50 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceCreateOrUpdateIndexer.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2021-04-30-Preview", + "Prefer": "return=representation", + "indexer": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + }, + "responses": { + "200": { + "body": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + }, + "201": { + "body": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceCreateOrUpdateSkillset.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceCreateOrUpdateSkillset.json new file mode 100644 index 000000000000..78bdbf314f3d --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceCreateOrUpdateSkillset.json @@ -0,0 +1,387 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2021-04-30-Preview", + "Prefer": "return=representation", + "skillset": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "textSplitMode": "pages", + "maximumPageLength": 4000, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ], + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + }, + "responses": { + "200": { + "body": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "name": "#1", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7 + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "#2", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "#3", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "#4", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "description": null, + "context": "/document", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "degreeOfParallelism": null, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ], + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + }, + "201": { + "body": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "name": "#1", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7 + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "#2", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "#3", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "#4", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "description": null, + "context": "/document", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "degreeOfParallelism": null, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ], + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceCreateOrUpdateSynonymMap.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceCreateOrUpdateSynonymMap.json new file mode 100644 index 000000000000..d2c6f0fc266e --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceCreateOrUpdateSynonymMap.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "synonymMapName": "mysynonymmap", + "api-version": "2021-04-30-Preview", + "Prefer": "return=representation", + "synonymMap": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + }, + "responses": { + "200": { + "body": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + }, + "201": { + "body": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceCreateSkillset.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceCreateSkillset.json new file mode 100644 index 000000000000..d356115bec89 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceCreateSkillset.json @@ -0,0 +1,307 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2021-04-30-Preview", + "Prefer": "return=representation", + "skillset": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "textSplitMode": "pages", + "maximumPageLength": 4000, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ], + "knowledgeStore": { + "storageConnectionString": "DefaultEndpointsProtocol=https;AccountName=myStorage;AccountKey=myStorageKey;EndpointSuffix=core.windows.net", + "projections": [ + { + "tables": [ + { + "tableName": "Reviews", + "generatedKeyName": "ReviewId", + "source": "/document/Review", + "sourceContext": null, + "inputs": [] + }, + { + "tableName": "Sentences", + "generatedKeyName": "SentenceId", + "source": "/document/Review/Sentences/*", + "sourceContext": null, + "inputs": [] + }, + { + "tableName": "KeyPhrases", + "generatedKeyName": "KeyPhraseId", + "source": "/document/Review/Sentences/*/KeyPhrases", + "sourceContext": null, + "inputs": [] + }, + { + "tableName": "Entities", + "generatedKeyName": "EntityId", + "source": "/document/Review/Sentences/*/Entities/*", + "sourceContext": null, + "inputs": [] + } + ] + }, + { + "objects": [ + { + "storageContainer": "Reviews", + "source": "/document/Review", + "generatedKeyName": "/document/Review/Id" + } + ] + } + ] + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "name": "#1", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7 + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "#2", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "#3", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "#4", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "description": null, + "context": "/document", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "degreeOfParallelism": null, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ], + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceCreateSynonymMap.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceCreateSynonymMap.json new file mode 100644 index 000000000000..3eeb375defad --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceCreateSynonymMap.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2021-04-30-Preview", + "synonymMap": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "myApplicationSecret" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceDeleteDataSource.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceDeleteDataSource.json new file mode 100644 index 000000000000..0c4070628c46 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceDeleteDataSource.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "dataSourceName": "mydatasource", + "api-version": "2021-04-30-Preview" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceDeleteIndex.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceDeleteIndex.json new file mode 100644 index 000000000000..41ffaad717c4 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceDeleteIndex.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2021-04-30-Preview" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceDeleteIndexer.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceDeleteIndexer.json new file mode 100644 index 000000000000..b8adbbe717d0 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceDeleteIndexer.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2021-04-30-Preview" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceDeleteSkillset.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceDeleteSkillset.json new file mode 100644 index 000000000000..177657fad83a --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceDeleteSkillset.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2021-04-30-Preview" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceDeleteSynonymMap.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceDeleteSynonymMap.json new file mode 100644 index 000000000000..4aa6dcf2834e --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceDeleteSynonymMap.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "synonymMapName": "mysynonymmap", + "api-version": "2021-04-30-Preview" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceGetDataSource.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceGetDataSource.json new file mode 100644 index 000000000000..f98097cfe3ff --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceGetDataSource.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "dataSourceName": "mydatasource", + "api-version": "2021-04-30-Preview" + }, + "responses": { + "200": { + "body": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + }, + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceGetIndex.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceGetIndex.json new file mode 100644 index 000000000000..b64def1a67e4 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceGetIndex.json @@ -0,0 +1,244 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "hotels", + "api-version": "2021-04-30-Preview" + }, + "responses": { + "200": { + "body": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceGetIndexStatistics.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceGetIndexStatistics.json new file mode 100644 index 000000000000..a307f8364c3f --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceGetIndexStatistics.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "hotels", + "api-version": "2021-04-30-Preview" + }, + "responses": { + "200": { + "body": { + "documentCount": 239572, + "storageSize": 72375920 + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceGetIndexer.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceGetIndexer.json new file mode 100644 index 000000000000..745f8b433219 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceGetIndexer.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2021-04-30-Preview" + }, + "responses": { + "200": { + "body": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false, + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceGetIndexerStatus.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceGetIndexerStatus.json new file mode 100644 index 000000000000..8fb985c0b4a7 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceGetIndexerStatus.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2021-04-30-Preview" + }, + "responses": { + "200": { + "body": { + "status": "running", + "lastResult": { + "status": "success", + "errorMessage": null, + "startTime": "2014-11-26T03:37:18.853Z", + "endTime": "2014-11-26T03:37:19.012Z", + "errors": [], + "warnings": [], + "itemsProcessed": 11, + "itemsFailed": 0, + "initialTrackingState": null, + "finalTrackingState": null + }, + "executionHistory": [ + { + "status": "success", + "errorMessage": null, + "startTime": "2014-11-26T03:37:18.853Z", + "endTime": "2014-11-26T03:37:19.012Z", + "errors": [], + "warnings": [], + "itemsProcessed": 11, + "itemsFailed": 0, + "initialTrackingState": null, + "finalTrackingState": null + }, + { + "status": "transientFailure", + "errorMessage": null, + "startTime": "2014-11-26T03:28:10.125Z", + "endTime": "2014-11-26T03:28:12.007Z", + "errors": [ + { + "key": "", + "errorMessage": "Document key cannot be missing or empty.", + "statusCode": 400, + "name": null, + "details": null, + "documentationLink": null + }, + { + "key": "document id 1", + "errorMessage": "Could not read the value of column 'foo' at index '0'.", + "statusCode": 400, + "name": "DocumentExtraction.AzureBlob.MyDataSource", + "details": "The file could not be parsed.", + "documentationLink": "https://go.microsoft.com/fwlink/?linkid=2049388" + } + ], + "warnings": [ + { + "key": "document id", + "message": "A warning doesn't stop indexing, and is intended to inform you of certain interesting situations, like when a blob indexer truncates the amount of text extracted from a blob.", + "name": null, + "details": null, + "documentationLink": null + }, + { + "key": "document id 2", + "message": "Document was truncated to 50000 characters.", + "name": "Enrichment.LanguageDetectionSkill.#4", + "details": "The skill did something that didn't break anything, nonetheless something we didn't expect happened, so it might be worth double checking.", + "documentationLink": "https://go.microsoft.com/fwlink/?linkid=2099692" + } + ], + "itemsProcessed": 1, + "itemsFailed": 2, + "initialTrackingState": null, + "finalTrackingState": null + } + ], + "limits": { + "maxRunTime": "22:00:00", + "maxDocumentExtractionSize": 256000000, + "maxDocumentContentCharactersToExtract": 4000000 + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceGetServiceStatistics.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceGetServiceStatistics.json new file mode 100644 index 000000000000..e7f6d7adfc3a --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceGetServiceStatistics.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2021-04-30-Preview" + }, + "responses": { + "200": { + "body": { + "counters": { + "documentCount": { + "usage": 7093, + "quota": 10000 + }, + "indexesCount": { + "usage": 3, + "quota": 3 + }, + "indexersCount": { + "usage": 3, + "quota": 3 + }, + "dataSourcesCount": { + "usage": 1, + "quota": 3 + }, + "storageSize": { + "usage": 914529, + "quota": 52428800 + }, + "synonymMaps": { + "usage": 2, + "quota": 3 + }, + "skillsetCount": { + "usage": 0, + "quota": 3 + } + }, + "limits": { + "maxFieldsPerIndex": 1000, + "maxFieldNestingDepthPerIndex": 10, + "maxComplexCollectionFieldsPerIndex": 100, + "maxComplexObjectsInCollectionsPerDocument": 3000 + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceGetSkillset.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceGetSkillset.json new file mode 100644 index 000000000000..e7fa7bd11c46 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceGetSkillset.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2021-04-30-Preview" + }, + "responses": { + "200": { + "body": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "name": "#1", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7 + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "#2", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "#3", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "#4", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "description": null, + "context": "/document", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "degreeOfParallelism": null, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ], + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceGetSynonymMap.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceGetSynonymMap.json new file mode 100644 index 000000000000..9cf2e06f46d7 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceGetSynonymMap.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "synonymMapName": "mysynonymmap", + "api-version": "2021-04-30-Preview" + }, + "responses": { + "200": { + "body": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceIndexAnalyze.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceIndexAnalyze.json new file mode 100644 index 000000000000..83e68f4c5b73 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceIndexAnalyze.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "hotels", + "api-version": "2021-04-30-Preview", + "request": { + "text": "Text to analyze", + "analyzer": "standard.lucene" + } + }, + "responses": { + "200": { + "body": { + "tokens": [ + { + "token": "text", + "startOffset": 0, + "endOffset": 4, + "position": 0 + }, + { + "token": "to", + "startOffset": 5, + "endOffset": 7, + "position": 1 + }, + { + "token": "analyze", + "startOffset": 8, + "endOffset": 15, + "position": 2 + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceListDataSources.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceListDataSources.json new file mode 100644 index 000000000000..2b920d4a96f4 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceListDataSources.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "$select": "*", + "api-version": "2021-04-30-Preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + }, + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceListIndexers.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceListIndexers.json new file mode 100644 index 000000000000..f1739d20e2fc --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceListIndexers.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "$select": "*", + "api-version": "2021-04-30-Preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydocdbdatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false + }, + { + "name": "myotherindexer", + "description": "another cool indexer", + "dataSourceName": "myblobdatasource", + "targetIndexName": "orders", + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5, + "batchSize": 15 + }, + "fieldMappings": [ + { + "sourceFieldName": "PersonName", + "targetFieldName": "FirstName", + "mappingFunction": { + "name": "extractTokenAtPosition", + "parameters": { + "delimiter": " ", + "position": 0 + } + } + }, + { + "sourceFieldName": "PersonName", + "targetFieldName": "LastName", + "mappingFunction": { + "name": "extractTokenAtPosition", + "parameters": { + "delimiter": " ", + "position": 1 + } + } + } + ], + "disabled": false, + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceListIndexes.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceListIndexes.json new file mode 100644 index 000000000000..685425698c3d --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceListIndexes.json @@ -0,0 +1,287 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "$select": "*", + "api-version": "2021-04-30-Preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + }, + { + "name": "testindex", + "fields": [ + { + "name": "id", + "type": "Edm.String", + "searchable": false, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "hidden", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": false, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [], + "defaultScoringProfile": null, + "suggesters": [], + "analyzers": [], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": null, + "encryptionKey": null + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceListSkillsets.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceListSkillsets.json new file mode 100644 index 000000000000..f19c3969aa43 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceListSkillsets.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "$select": "*", + "api-version": "2021-04-30-Preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "name": "#1", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7 + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "#2", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "#3", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "#4", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "description": null, + "context": "/document", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "degreeOfParallelism": null, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ], + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceListSynonymMaps.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceListSynonymMaps.json new file mode 100644 index 000000000000..7dcc0a62fa1c --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceListSynonymMaps.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2021-04-30-Preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + }, + { + "name": "myothersynonymmap", + "format": "solr", + "synonyms": "couch, sofa, chesterfield\npop, soda\ntoque, hat", + "encryptionKey": null + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceResetIndexer.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceResetIndexer.json new file mode 100644 index 000000000000..8fc2f4b97644 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceResetIndexer.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2021-04-30-Preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceRunIndexer.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceRunIndexer.json new file mode 100644 index 000000000000..a204ca07580f --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/examples/SearchServiceRunIndexer.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2021-04-30-Preview" + }, + "responses": { + "202": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/searchindex.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/searchindex.json new file mode 100644 index 000000000000..e3739babde34 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/searchindex.json @@ -0,0 +1,1948 @@ +{ + "swagger": "2.0", + "info": { + "title": "SearchIndexClient", + "description": "Client that can be used to query an index and upload, merge, or delete documents.", + "version": "2021-04-30-Preview", + "x-ms-code-generation-settings": { + "useDateTimeOffset": true, + "syncMethods": "None" + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/indexes('{indexName}')", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/EndpointParameter" + }, + { + "$ref": "#/parameters/IndexNameParameter" + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/docs/$count": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_Count", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Count-Documents" + }, + "x-ms-examples": { + "SearchIndexCountDocuments": { + "$ref": "./examples/SearchIndexCountDocuments.json" + } + }, + "description": "Queries the number of documents in the index.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "type": "integer", + "format": "int64" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_SearchGet", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Search-Documents" + }, + "x-ms-examples": { + "SearchIndexSearchDocumentsGet": { + "$ref": "./examples/SearchIndexSearchDocumentsGet.json" + } + }, + "description": "Searches for documents in the index.", + "parameters": [ + { + "name": "search", + "in": "query", + "type": "string", + "description": "A full-text search query expression; Use \"*\" or omit this parameter to match all documents.", + "x-ms-client-name": "SearchText" + }, + { + "name": "$count", + "in": "query", + "type": "boolean", + "description": "A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation.", + "x-nullable": false, + "x-ms-client-name": "IncludeTotalResultCount", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "facet", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "description": "The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs.", + "x-ms-client-name": "Facets", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "$filter", + "in": "query", + "type": "string", + "description": "The OData $filter expression to apply to the search query.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "highlight", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting.", + "x-ms-client-name": "HighlightFields", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "highlightPostTag", + "in": "query", + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "highlightPreTag", + "in": "query", + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "minimumCoverage", + "in": "query", + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "$orderby", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses.", + "x-ms-client-name": "OrderBy", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "queryType", + "in": "query", + "type": "string", + "enum": [ + "simple", + "full", + "semantic" + ], + "x-ms-enum": { + "name": "QueryType", + "modelAsString": false, + "values": [ + { + "value": "simple", + "name": "Simple", + "description": "Uses the simple query syntax for searches. Search text is interpreted using a simple query language that allows for symbols such as +, * and \"\". Queries are evaluated across all searchable fields by default, unless the searchFields parameter is specified." + }, + { + "value": "full", + "name": "Full", + "description": "Uses the full Lucene query syntax for searches. Search text is interpreted using the Lucene query language which allows field-specific and weighted searches, as well as other advanced features." + }, + { + "value": "semantic", + "name": "Semantic", + "description": "Best suited for queries expressed in natural language as opposed to keywords. Improves precision of search results by re-ranking the top search results using a ranking model trained on the Web corpus." + } + ] + }, + "x-nullable": false, + "description": "A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "scoringParameter", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "x-ms-client-name": "ScoringParameters", + "description": "The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be \"mylocation--122.2,44.8\" (without the quotes).", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "scoringProfile", + "in": "query", + "type": "string", + "description": "The name of a scoring profile to evaluate match scores for matching documents in order to sort the results.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "searchFields", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any field names listed in this parameter.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "queryLanguage", + "in": "query", + "type": "string", + "enum": [ + "none", + "en-us" + ], + "x-ms-enum": { + "name": "QueryLanguage", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Query language not specified." + }, + { + "value": "en-us", + "name": "EnUs", + "description": "English (US)" + } + ] + }, + "description": "The language of the query.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "speller", + "in": "query", + "type": "string", + "enum": [ + "none", + "lexicon" + ], + "x-ms-enum": { + "name": "Speller", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Speller not enabled." + }, + { + "value": "lexicon", + "name": "Lexicon", + "description": "Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter." + } + ] + }, + "description": "Improve search recall by spell-correcting individual search query terms.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "answers", + "in": "query", + "type": "string", + "enum": [ + "none", + "extractive" + ], + "x-ms-enum": { + "name": "Answers", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Do not return answers for the query." + }, + { + "value": "extractive", + "name": "Extractive", + "description": "Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language." + } + ] + }, + "description": "This parameter is only valid if the query type is 'semantic'. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character '|' followed by the 'count-' option after the answers parameter value, such as 'extractive|count-3'. Default count is 1.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "searchMode", + "in": "query", + "type": "string", + "enum": [ + "any", + "all" + ], + "x-ms-enum": { + "name": "SearchMode", + "modelAsString": false, + "values": [ + { + "value": "any", + "name": "Any", + "description": "Any of the search terms must be matched in order to count the document as a match." + }, + { + "value": "all", + "name": "All", + "description": "All of the search terms must be matched in order to count the document as a match." + } + ] + }, + "x-nullable": false, + "description": "A value that specifies whether any or all of the search terms must be matched in order to count the document as a match.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "scoringStatistics", + "in": "query", + "type": "string", + "enum": [ + "local", + "global" + ], + "x-ms-enum": { + "name": "ScoringStatistics", + "modelAsString": false, + "values": [ + { + "value": "local", + "name": "Local", + "description": "The scoring statistics will be calculated locally for lower latency." + }, + { + "value": "global", + "name": "Global", + "description": "The scoring statistics will be calculated globally for more consistent scoring." + } + ] + }, + "x-nullable": false, + "description": "A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring, or locally, for lower latency.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "sessionId", + "in": "query", + "type": "string", + "description": "A value to be used to create a sticky session, which can help to get more consistent results. As long as the same sessionId is used, a best-effort attempt will be made to target the same replica set. Be wary that reusing the same sessionID values repeatedly can interfere with the load balancing of the requests across replicas and adversely affect the performance of the search service. The value used as sessionId cannot start with a '_' character.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "$select", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "$skip", + "in": "query", + "type": "integer", + "format": "int32", + "description": "The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use $skip due to this limitation, consider using $orderby on a totally-ordered key and $filter with a range query instead.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be used to issue another Search request for the next page of results.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "captions", + "in": "query", + "type": "string", + "enum": [ + "none", + "extractive" + ], + "x-ms-enum": { + "name": "Captions", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Do not return captions for the query." + }, + { + "value": "extractive", + "name": "Extractive", + "description": "Extracts captions from the matching documents that contain passages relevant to the search query." + } + ] + }, + "description": "This parameter is only valid if the query type is 'semantic'. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to 'extractive', highlighting is enabled by default, and can be configured by appending the pipe character '|' followed by the 'highlight-' option, such as 'extractive|highlight-true'. Defaults to 'None'.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "semanticFields", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names used for semantic search.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing documents that match the search criteria.", + "schema": { + "$ref": "#/definitions/SearchDocumentsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs/search.post.search": { + "post": { + "tags": [ + "Documents" + ], + "operationId": "Documents_SearchPost", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Search-Documents" + }, + "x-ms-examples": { + "SearchIndexSearchDocumentsPost": { + "$ref": "./examples/SearchIndexSearchDocumentsPost.json" + } + }, + "description": "Searches for documents in the index.", + "parameters": [ + { + "name": "searchRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchRequest", + "description": "The Search request." + }, + "description": "The definition of the Search request." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing documents that match the search criteria.", + "schema": { + "$ref": "#/definitions/SearchDocumentsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs('{key}')": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_Get", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/lookup-document" + }, + "x-ms-examples": { + "SearchIndexGetDocument": { + "$ref": "./examples/SearchIndexGetDocument.json" + } + }, + "description": "Retrieves a document from the index.", + "parameters": [ + { + "name": "key", + "in": "path", + "required": true, + "description": "The key of the document to retrieve.", + "type": "string" + }, + { + "name": "$select", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "List of field names to retrieve for the document; Any field not retrieved will be missing from the returned document.", + "x-ms-client-name": "SelectedFields" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "responses": { + "200": { + "description": "Response containing the requested document.", + "schema": { + "type": "object" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs/search.suggest": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_SuggestGet", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/suggestions" + }, + "x-ms-examples": { + "SearchIndexSuggestDocumentsGet": { + "$ref": "./examples/SearchIndexSuggestDocumentsGet.json" + } + }, + "description": "Suggests documents in the index that match the given partial query text.", + "parameters": [ + { + "name": "search", + "in": "query", + "required": true, + "type": "string", + "description": "The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters.", + "x-ms-client-name": "SearchText" + }, + { + "name": "suggesterName", + "in": "query", + "required": true, + "type": "string", + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + { + "name": "$filter", + "in": "query", + "type": "string", + "description": "An OData expression that filters the documents considered for suggestions.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "fuzzy", + "in": "query", + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the suggestions query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy suggestions queries are slower and consume more resources.", + "x-ms-client-name": "UseFuzzyMatching", + "x-nullable": false, + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "highlightPostTag", + "in": "query", + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "highlightPreTag", + "in": "query", + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting of suggestions is disabled.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "minimumCoverage", + "in": "query", + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestions query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "$orderby", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-client-name": "OrderBy", + "description": "The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "searchFields", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to search for the specified search text. Target fields must be included in the specified suggester.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "$select", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of fields to retrieve. If unspecified, only the key field will be included in the results.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "The number of suggestions to retrieve. The value must be a number between 1 and 100. The default is 5.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing suggested documents that match the partial input.", + "schema": { + "$ref": "#/definitions/SuggestDocumentsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs/search.post.suggest": { + "post": { + "tags": [ + "Documents" + ], + "operationId": "Documents_SuggestPost", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/suggestions" + }, + "x-ms-examples": { + "SearchIndexSuggestDocumentsPost": { + "$ref": "./examples/SearchIndexSuggestDocumentsPost.json" + } + }, + "description": "Suggests documents in the index that match the given partial query text.", + "parameters": [ + { + "name": "suggestRequest", + "in": "body", + "required": true, + "description": "The Suggest request.", + "schema": { + "$ref": "#/definitions/SuggestRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing suggested documents that match the partial input.", + "schema": { + "$ref": "#/definitions/SuggestDocumentsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs/search.index": { + "post": { + "tags": [ + "Documents" + ], + "operationId": "Documents_Index", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents" + }, + "x-ms-examples": { + "SearchIndexIndexDocuments": { + "$ref": "./examples/SearchIndexIndexDocuments.json" + } + }, + "description": "Sends a batch of document write actions to the index.", + "parameters": [ + { + "name": "batch", + "in": "body", + "description": "The batch of index actions.", + "required": true, + "schema": { + "$ref": "#/definitions/IndexBatch" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing the status of operations for all actions in the batch.", + "schema": { + "$ref": "#/definitions/IndexDocumentsResult" + } + }, + "207": { + "description": "Response containing the status of operations for all actions in the batch.", + "schema": { + "$ref": "#/definitions/IndexDocumentsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs/search.autocomplete": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_AutocompleteGet", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/autocomplete" + }, + "x-ms-examples": { + "SearchIndexAutocompleteDocumentsGet": { + "$ref": "./examples/SearchIndexAutocompleteDocumentsGet.json" + } + }, + "description": "Autocompletes incomplete query terms based on input text and matching terms in the index.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "search", + "in": "query", + "type": "string", + "required": true, + "description": "The incomplete term which should be auto-completed.", + "x-ms-client-name": "SearchText" + }, + { + "name": "suggesterName", + "in": "query", + "type": "string", + "required": true, + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + { + "name": "autocompleteMode", + "in": "query", + "type": "string", + "x-nullable": false, + "enum": [ + "oneTerm", + "twoTerms", + "oneTermWithContext" + ], + "x-ms-enum": { + "name": "AutocompleteMode", + "modelAsString": false, + "values": [ + { + "value": "oneTerm", + "name": "OneTerm", + "description": "Only one term is suggested. If the query has two terms, only the last term is completed. For example, if the input is 'washington medic', the suggested terms could include 'medicaid', 'medicare', and 'medicine'." + }, + { + "value": "twoTerms", + "name": "TwoTerms", + "description": "Matching two-term phrases in the index will be suggested. For example, if the input is 'medic', the suggested terms could include 'medicare coverage' and 'medical assistant'." + }, + { + "value": "oneTermWithContext", + "name": "OneTermWithContext", + "description": "Completes the last term in a query with two or more terms, where the last two terms are a phrase that exists in the index. For example, if the input is 'washington medic', the suggested terms could include 'washington medicaid' and 'washington medical'." + } + ] + }, + "description": "Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context while producing auto-completed terms.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "$filter", + "in": "query", + "type": "string", + "description": "An OData expression that filters the documents used to produce completed terms for the Autocomplete result.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "fuzzy", + "in": "query", + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.", + "x-ms-client-name": "UseFuzzyMatching", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "highlightPostTag", + "in": "query", + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "highlightPreTag", + "in": "query", + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "minimumCoverage", + "in": "query", + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "searchFields", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing suggested query terms that complete the partial input.", + "schema": { + "$ref": "#/definitions/AutocompleteResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs/search.post.autocomplete": { + "post": { + "tags": [ + "Documents" + ], + "operationId": "Documents_AutocompletePost", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/autocomplete" + }, + "x-ms-examples": { + "SearchIndexAutocompleteDocumentsPost": { + "$ref": "./examples/SearchIndexAutocompleteDocumentsPost.json" + } + }, + "description": "Autocompletes incomplete query terms based on input text and matching terms in the index.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "autocompleteRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AutocompleteRequest" + }, + "description": "The definition of the Autocomplete request." + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing suggested query terms that complete the partial input.", + "schema": { + "$ref": "#/definitions/AutocompleteResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + } + }, + "definitions": { + "SuggestDocumentsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SuggestResult" + }, + "readOnly": true, + "x-ms-client-name": "Results", + "description": "The sequence of results returned by the query." + }, + "@search.coverage": { + "type": "number", + "readOnly": true, + "format": "double", + "x-ms-client-name": "Coverage", + "description": "A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not set in the request." + } + }, + "required": [ + "value" + ], + "description": "Response containing suggestion query results from an index." + }, + "SuggestResult": { + "properties": { + "@search.text": { + "type": "string", + "readOnly": true, + "description": "The text of the suggestion result.", + "x-ms-client-name": "Text" + } + }, + "required": [ + "@search.text" + ], + "additionalProperties": true, + "description": "A result containing a document found by a suggestion query, plus associated metadata." + }, + "FacetResult": { + "properties": { + "count": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The approximate count of documents falling within the bucket described by this facet." + } + }, + "additionalProperties": true, + "description": "A single bucket of a facet query result. Reports the number of documents with a field value falling within a particular range or having a particular value or interval." + }, + "AnswerResult": { + "properties": { + "score": { + "type": "number", + "format": "double", + "readOnly": true, + "description": "The score value represents how relevant the answer is to the the query relative to other answers returned for the query." + }, + "key": { + "type": "string", + "readOnly": true, + "description": "The key of the document the answer was extracted from." + }, + "text": { + "type": "string", + "readOnly": true, + "description": "The text passage extracted from the document contents as the answer." + }, + "highlights": { + "type": "string", + "readOnly": true, + "x-nullable": true, + "description": "Same text passage as in the Text property with highlighted text phrases most relevant to the query." + } + }, + "additionalProperties": true, + "description": "An answer is a text passage extracted from the contents of the most relevant documents that matched the query. Answers are extracted from the top search results. Answer candidates are scored and the top answers are selected." + }, + "CaptionResult": { + "properties": { + "text": { + "type": "string", + "readOnly": true, + "description": "A representative text passage extracted from the document most relevant to the search query." + }, + "highlights": { + "type": "string", + "readOnly": true, + "x-nullable": true, + "description": "Same text passage as in the Text property with highlighted phrases most relevant to the query." + } + }, + "additionalProperties": true, + "description": "Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type 'semantic'.." + }, + "SearchDocumentsResult": { + "properties": { + "@odata.count": { + "type": "integer", + "format": "int64", + "readOnly": true, + "x-ms-client-name": "Count", + "description": "The total count of results found by the search operation, or null if the count was not requested. If present, the count may be greater than the number of results in this response. This can happen if you use the $top or $skip parameters, or if Azure Cognitive Search can't return all the requested documents in a single Search response." + }, + "@search.coverage": { + "type": "number", + "format": "double", + "readOnly": true, + "x-ms-client-name": "Coverage", + "description": "A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not specified in the request." + }, + "@search.facets": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/FacetResult" + } + }, + "readOnly": true, + "x-ms-client-name": "Facets", + "description": "The facet query results for the search operation, organized as a collection of buckets for each faceted field; null if the query did not include any facet expressions." + }, + "@search.answers": { + "type": "array", + "items": { + "$ref": "#/definitions/AnswerResult" + }, + "readOnly": true, + "x-ms-client-name": "Answers", + "x-nullable": true, + "description": "The answers query results for the search operation; null if the answers query parameter was not specified or set to 'none'." + }, + "@search.nextPageParameters": { + "$ref": "#/definitions/SearchRequest", + "readOnly": true, + "x-ms-client-name": "NextPageParameters", + "description": "Continuation JSON payload returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this JSON along with @odata.nextLink to formulate another POST Search request to get the next part of the search response." + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchResult" + }, + "readOnly": true, + "x-ms-client-name": "Results", + "description": "The sequence of results returned by the query." + }, + "@odata.nextLink": { + "type": "string", + "readOnly": true, + "x-ms-client-name": "NextLink", + "description": "Continuation URL returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this URL to formulate another GET or POST Search request to get the next part of the search response. Make sure to use the same verb (GET or POST) as the request that produced this response." + } + }, + "required": [ + "value" + ], + "description": "Response containing search results from an index." + }, + "SearchResult": { + "properties": { + "@search.score": { + "type": "number", + "format": "double", + "readOnly": true, + "x-ms-client-name": "Score", + "x-nullable": false, + "description": "The relevance score of the document compared to other documents returned by the query." + }, + "@search.rerankerScore": { + "type": "number", + "format": "double", + "readOnly": true, + "x-ms-client-name": "RerankerScore", + "x-nullable": true, + "description": "The relevance score computed by the semantic ranker for the top search results. Search results are sorted by the RerankerScore first and then by the Score. RerankerScore is only returned for queries of type 'semantic'." + }, + "@search.highlights": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + }, + "readOnly": true, + "x-ms-client-name": "Highlights", + "description": "Text fragments from the document that indicate the matching search terms, organized by each applicable field; null if hit highlighting was not enabled for the query." + }, + "@search.captions": { + "type": "array", + "items": { + "$ref": "#/definitions/CaptionResult" + }, + "readOnly": true, + "x-ms-client-name": "Captions", + "x-nullable": true, + "description": "Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type 'semantic'." + } + }, + "required": [ + "@search.score" + ], + "additionalProperties": true, + "description": "Contains a document found by a search query, plus associated metadata." + }, + "IndexBatch": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IndexAction" + }, + "description": "The actions in the batch.", + "x-ms-client-name": "Actions" + } + }, + "required": [ + "value" + ], + "description": "Contains a batch of document write actions to send to the index." + }, + "IndexAction": { + "properties": { + "@search.action": { + "type": "string", + "enum": [ + "upload", + "merge", + "mergeOrUpload", + "delete" + ], + "x-ms-enum": { + "name": "IndexActionType", + "modelAsString": false, + "values": [ + { + "value": "upload", + "name": "Upload", + "description": "Inserts the document into the index if it is new and updates it if it exists. All fields are replaced in the update case." + }, + { + "value": "merge", + "name": "Merge", + "description": "Merges the specified field values with an existing document. If the document does not exist, the merge will fail. Any field you specify in a merge will replace the existing field in the document. This also applies to collections of primitive and complex types." + }, + { + "value": "mergeOrUpload", + "name": "MergeOrUpload", + "description": "Behaves like merge if a document with the given key already exists in the index. If the document does not exist, it behaves like upload with a new document." + }, + { + "value": "delete", + "name": "Delete", + "description": "Removes the specified document from the index. Any field you specify in a delete operation other than the key field will be ignored. If you want to remove an individual field from a document, use merge instead and set the field explicitly to null." + } + ] + }, + "x-ms-client-name": "ActionType", + "x-nullable": false, + "description": "The operation to perform on a document in an indexing batch." + } + }, + "additionalProperties": true, + "description": "Represents an index action that operates on a document." + }, + "IndexingResult": { + "properties": { + "key": { + "type": "string", + "readOnly": true, + "description": "The key of a document that was in the indexing request." + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "The error message explaining why the indexing operation failed for the document identified by the key; null if indexing succeeded." + }, + "status": { + "x-ms-client-name": "Succeeded", + "type": "boolean", + "x-nullable": false, + "readOnly": true, + "description": "A value indicating whether the indexing operation succeeded for the document identified by the key." + }, + "statusCode": { + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The status code of the indexing operation. Possible values include: 200 for a successful update or delete, 201 for successful document creation, 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy." + } + }, + "required": [ + "key", + "status", + "statusCode" + ], + "description": "Status of an indexing operation for a single document." + }, + "IndexDocumentsResult": { + "properties": { + "value": { + "x-ms-client-name": "Results", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/IndexingResult" + }, + "description": "The list of status information for each document in the indexing request." + } + }, + "required": [ + "value" + ], + "description": "Response containing the status of operations for all documents in the indexing request." + }, + "SearchMode": { + "type": "string", + "enum": [ + "any", + "all" + ], + "x-ms-enum": { + "name": "SearchMode", + "modelAsString": false, + "values": [ + { + "value": "any", + "name": "Any", + "description": "Any of the search terms must be matched in order to count the document as a match." + }, + { + "value": "all", + "name": "All", + "description": "All of the search terms must be matched in order to count the document as a match." + } + ] + }, + "description": "Specifies whether any or all of the search terms must be matched in order to count the document as a match." + }, + "QueryType": { + "type": "string", + "enum": [ + "simple", + "full", + "semantic" + ], + "x-ms-enum": { + "name": "QueryType", + "modelAsString": false, + "values": [ + { + "value": "simple", + "name": "Simple", + "description": "Uses the simple query syntax for searches. Search text is interpreted using a simple query language that allows for symbols such as +, * and \"\". Queries are evaluated across all searchable fields by default, unless the searchFields parameter is specified." + }, + { + "value": "full", + "name": "Full", + "description": "Uses the full Lucene query syntax for searches. Search text is interpreted using the Lucene query language which allows field-specific and weighted searches, as well as other advanced features." + }, + { + "value": "semantic", + "name": "Semantic", + "description": "Best suited for queries expressed in natural language as opposed to keywords. Improves precision of search results by re-ranking the top search results using a ranking model trained on the Web corpus." + } + ] + }, + "description": "Specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax and 'semantic' if query syntax is not needed." + }, + "Speller": { + "type": "string", + "enum": [ + "none", + "lexicon" + ], + "x-ms-enum": { + "name": "Speller", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Speller not enabled." + }, + { + "value": "lexicon", + "name": "Lexicon", + "description": "Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter." + } + ] + }, + "description": "Improve search recall by spell-correcting individual search query terms." + }, + "Answers": { + "type": "string", + "enum": [ + "none", + "extractive" + ], + "x-ms-enum": { + "name": "Answers", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Do not return answers for the query." + }, + { + "value": "extractive", + "name": "Extractive", + "description": "Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language." + } + ] + }, + "description": "This parameter is only valid if the query type is 'semantic'. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character '|' followed by the 'count-' option after the answers parameter value, such as 'extractive|count-3'. Default count is 1." + }, + "Captions": { + "type": "string", + "enum": [ + "none", + "extractive" + ], + "x-ms-enum": { + "name": "Captions", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Do not return captions for the query." + }, + { + "value": "extractive", + "name": "Extractive", + "description": "Extracts captions from the matching documents that contain passages relevant to the search query." + } + ] + }, + "description": "This parameter is only valid if the query type is 'semantic'. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to 'extractive', highlighting is enabled by default, and can be configured by appending the pipe character '|' followed by the 'highlight-' option, such as 'extractive|highlight-true'. Defaults to 'None'." + }, + "QueryLanguage": { + "type": "string", + "enum": [ + "none", + "en-us" + ], + "x-ms-enum": { + "name": "QueryLanguage", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Query language not specified." + }, + { + "value": "en-us", + "name": "EnUs", + "description": "English" + } + ] + }, + "description": "The language of the query." + }, + "ScoringStatistics": { + "type": "string", + "enum": [ + "local", + "global" + ], + "x-ms-enum": { + "name": "ScoringStatistics", + "modelAsString": false, + "values": [ + { + "value": "local", + "name": "Local", + "description": "The scoring statistics will be calculated locally for lower latency." + }, + { + "value": "global", + "name": "Global", + "description": "The scoring statistics will be calculated globally for more consistent scoring." + } + ] + }, + "description": "A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring, or locally, for lower latency. The default is 'local'. Use 'global' to aggregate scoring statistics globally before scoring. Using global scoring statistics can increase latency of search queries." + }, + "AutocompleteMode": { + "type": "string", + "enum": [ + "oneTerm", + "twoTerms", + "oneTermWithContext" + ], + "x-ms-enum": { + "name": "AutocompleteMode", + "modelAsString": false, + "values": [ + { + "value": "oneTerm", + "name": "OneTerm", + "description": "Only one term is suggested. If the query has two terms, only the last term is completed. For example, if the input is 'washington medic', the suggested terms could include 'medicaid', 'medicare', and 'medicine'." + }, + { + "value": "twoTerms", + "name": "TwoTerms", + "description": "Matching two-term phrases in the index will be suggested. For example, if the input is 'medic', the suggested terms could include 'medicare coverage' and 'medical assistant'." + }, + { + "value": "oneTermWithContext", + "name": "OneTermWithContext", + "description": "Completes the last term in a query with two or more terms, where the last two terms are a phrase that exists in the index. For example, if the input is 'washington medic', the suggested terms could include 'washington medicaid' and 'washington medical'." + } + ] + }, + "description": "Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context in producing autocomplete terms." + }, + "SearchRequest": { + "properties": { + "count": { + "type": "boolean", + "description": "A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation.", + "x-ms-client-name": "IncludeTotalResultCount" + }, + "facets": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Search-Documents" + }, + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs." + }, + "filter": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search" + }, + "type": "string", + "description": "The OData $filter expression to apply to the search query." + }, + "highlight": { + "type": "string", + "description": "The comma-separated list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting.", + "x-ms-client-name": "HighlightFields" + }, + "highlightPostTag": { + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>." + }, + "highlightPreTag": { + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>." + }, + "minimumCoverage": { + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100." + }, + "orderby": { + "x-ms-client-name": "OrderBy", + "type": "string", + "description": "The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses." + }, + "queryType": { + "$ref": "#/definitions/QueryType", + "description": "A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax." + }, + "scoringStatistics": { + "$ref": "#/definitions/ScoringStatistics", + "description": "A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring, or locally, for lower latency. The default is 'local'. Use 'global' to aggregate scoring statistics globally before scoring. Using global scoring statistics can increase latency of search queries." + }, + "sessionId": { + "type": "string", + "description": "A value to be used to create a sticky session, which can help getting more consistent results. As long as the same sessionId is used, a best-effort attempt will be made to target the same replica set. Be wary that reusing the same sessionID values repeatedly can interfere with the load balancing of the requests across replicas and adversely affect the performance of the search service. The value used as sessionId cannot start with a '_' character." + }, + "scoringParameters": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be \"mylocation--122.2,44.8\" (without the quotes)." + }, + "scoringProfile": { + "type": "string", + "description": "The name of a scoring profile to evaluate match scores for matching documents in order to sort the results." + }, + "search": { + "type": "string", + "description": "A full-text search query expression; Use \"*\" or omit this parameter to match all documents.", + "x-ms-client-name": "SearchText" + }, + "searchFields": { + "type": "string", + "description": "The comma-separated list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any field names listed in this parameter." + }, + "searchMode": { + "$ref": "#/definitions/SearchMode", + "description": "A value that specifies whether any or all of the search terms must be matched in order to count the document as a match." + }, + "queryLanguage": { + "$ref": "#/definitions/QueryLanguage", + "description": "A value that specifies the language of the search query." + }, + "speller": { + "$ref": "#/definitions/Speller", + "description": "A value that specified the type of the speller to use to spell-correct individual search query terms." + }, + "answers": { + "$ref": "#/definitions/Answers", + "description": "A value that specifies whether answers should be returned as part of the search response." + }, + "select": { + "type": "string", + "description": "The comma-separated list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included." + }, + "skip": { + "type": "integer", + "format": "int32", + "description": "The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use skip due to this limitation, consider using orderby on a totally-ordered key and filter with a range query instead." + }, + "top": { + "type": "integer", + "format": "int32", + "description": "The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be used to issue another Search request for the next page of results." + }, + "captions": { + "$ref": "#/definitions/Captions", + "description": "A value that specifies whether captions should be returned as part of the search response." + }, + "semanticFields": { + "type": "string", + "description": "The comma-separated list of field names used for semantic search." + } + }, + "description": "Parameters for filtering, sorting, faceting, paging, and other search query behaviors." + }, + "SuggestRequest": { + "properties": { + "filter": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search" + }, + "type": "string", + "description": "An OData expression that filters the documents considered for suggestions." + }, + "fuzzy": { + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the suggestion query. Default is false. When set to true, the query will find suggestions even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy suggestion searches are slower and consume more resources.", + "x-ms-client-name": "UseFuzzyMatching" + }, + "highlightPostTag": { + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled." + }, + "highlightPreTag": { + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting of suggestions is disabled." + }, + "minimumCoverage": { + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestion query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80." + }, + "orderby": { + "x-ms-client-name": "OrderBy", + "type": "string", + "description": "The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses." + }, + "search": { + "type": "string", + "description": "The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters.", + "x-ms-client-name": "SearchText" + }, + "searchFields": { + "type": "string", + "description": "The comma-separated list of field names to search for the specified search text. Target fields must be included in the specified suggester." + }, + "select": { + "type": "string", + "description": "The comma-separated list of fields to retrieve. If unspecified, only the key field will be included in the results." + }, + "suggesterName": { + "type": "string", + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + "top": { + "type": "integer", + "format": "int32", + "description": "The number of suggestions to retrieve. This must be a value between 1 and 100. The default is 5." + } + }, + "required": [ + "search", + "suggesterName" + ], + "description": "Parameters for filtering, sorting, fuzzy matching, and other suggestions query behaviors." + }, + "AutocompleteRequest": { + "properties": { + "search": { + "type": "string", + "description": "The search text on which to base autocomplete results.", + "x-ms-client-name": "SearchText" + }, + "autocompleteMode": { + "$ref": "#/definitions/AutocompleteMode", + "description": "Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context while producing auto-completed terms." + }, + "filter": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search" + }, + "type": "string", + "description": "An OData expression that filters the documents used to produce completed terms for the Autocomplete result." + }, + "fuzzy": { + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will autocomplete terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.", + "x-ms-client-name": "UseFuzzyMatching" + }, + "highlightPostTag": { + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled." + }, + "highlightPreTag": { + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled." + }, + "minimumCoverage": { + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80." + }, + "searchFields": { + "type": "string", + "description": "The comma-separated list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester." + }, + "suggesterName": { + "type": "string", + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + "top": { + "type": "integer", + "format": "int32", + "description": "The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5." + } + }, + "required": [ + "search", + "suggesterName" + ], + "description": "Parameters for fuzzy matching, and other autocomplete query behaviors." + }, + "AutocompleteResult": { + "properties": { + "@search.coverage": { + "type": "number", + "format": "double", + "readOnly": true, + "x-ms-client-name": "Coverage", + "description": "A value indicating the percentage of the index that was considered by the autocomplete request, or null if minimumCoverage was not specified in the request." + }, + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AutocompleteItem" + }, + "description": "The list of returned Autocompleted items.", + "x-ms-client-name": "Results" + } + }, + "required": [ + "value" + ], + "description": "The result of Autocomplete query." + }, + "AutocompleteItem": { + "properties": { + "text": { + "type": "string", + "readOnly": true, + "description": "The completed term." + }, + "queryPlusText": { + "type": "string", + "readOnly": true, + "description": "The query along with the completed term." + } + }, + "required": [ + "text", + "queryPlusText" + ], + "description": "The result of Autocomplete requests." + }, + "SearchError": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "A human-readable representation of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchError" + }, + "readOnly": true, + "description": "An array of details about specific errors that led to this reported error." + } + }, + "required": [ + "message" + ], + "description": "Describes an error condition for the Azure Cognitive Search API." + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ClientRequestIdParameter": { + "name": "x-ms-client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The tracking ID sent with the request to help with debugging.", + "x-ms-client-request-id": true, + "x-ms-parameter-grouping": { + "name": "request-options" + }, + "x-ms-parameter-location": "method" + }, + "EndpointParameter": { + "name": "endpoint", + "in": "path", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "description": "The endpoint URL of the search service.", + "x-ms-parameter-location": "client" + }, + "IndexNameParameter": { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": false, + "description": "The name of the index.", + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/searchservice.json new file mode 100644 index 000000000000..e747e3649649 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/searchservice.json @@ -0,0 +1,9802 @@ +{ + "swagger": "2.0", + "info": { + "title": "SearchServiceClient", + "description": "Client that can be used to manage and query indexes and documents, as well as manage other resources, on a search service.", + "version": "2021-04-30-Preview", + "x-ms-code-generation-settings": { + "useDateTimeOffset": true + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/EndpointParameter" + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/datasources('{dataSourceName}')": { + "put": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateDataSource": { + "$ref": "./examples/SearchServiceCreateOrUpdateDataSource.json" + } + }, + "description": "Creates a new datasource or updates a datasource if it already exists.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Update-Data-Source" + }, + "parameters": [ + { + "name": "dataSourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the datasource to create or update." + }, + { + "name": "dataSource", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + }, + "description": "The definition of the datasource to create or update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IgnoreResetRequirementsParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "delete": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_Delete", + "x-ms-examples": { + "SearchServiceDeleteDataSource": { + "$ref": "./examples/SearchServiceDeleteDataSource.json" + } + }, + "description": "Deletes a datasource.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Data-Source" + }, + "parameters": [ + { + "name": "dataSourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the datasource to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "get": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_Get", + "x-ms-examples": { + "SearchServiceGetDataSource": { + "$ref": "./examples/SearchServiceGetDataSource.json" + } + }, + "description": "Retrieves a datasource definition.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Data-Source" + }, + "parameters": [ + { + "name": "dataSourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the datasource to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/datasources": { + "get": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_List", + "x-ms-examples": { + "SearchServiceListDataSources": { + "$ref": "./examples/SearchServiceListDataSources.json" + } + }, + "description": "Lists all datasources available for a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/List-Data-Sources" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which top-level properties of the data sources to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListDataSourcesResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "post": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_Create", + "x-ms-examples": { + "SearchServiceCreateDataSource": { + "$ref": "./examples/SearchServiceCreateDataSource.json" + } + }, + "description": "Creates a new datasource.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Data-Source" + }, + "parameters": [ + { + "name": "dataSource", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + }, + "description": "The definition of the datasource to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexers('{indexerName}')/search.reset": { + "post": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Reset", + "x-ms-examples": { + "SearchServiceResetIndexer": { + "$ref": "./examples/SearchServiceResetIndexer.json" + } + }, + "description": "Resets the change tracking state associated with an indexer.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Reset-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to reset." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexers('{indexerName}')/search.run": { + "post": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Run", + "x-ms-examples": { + "SearchServiceRunIndexer": { + "$ref": "./examples/SearchServiceRunIndexer.json" + } + }, + "description": "Runs an indexer on-demand.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Run-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to run." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "202": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexers('{indexerName}')": { + "put": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateIndexer": { + "$ref": "./examples/SearchServiceCreateOrUpdateIndexer.json" + } + }, + "description": "Creates a new indexer or updates an indexer if it already exists.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to create or update." + }, + { + "name": "indexer", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexer" + }, + "description": "The definition of the indexer to create or update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/DisableCacheReprocessingChangeDetectionParameter" + }, + { + "$ref": "#/parameters/IgnoreResetRequirementsParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexer" + } + }, + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexer" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "delete": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Delete", + "x-ms-examples": { + "SearchServiceDeleteIndexer": { + "$ref": "./examples/SearchServiceDeleteIndexer.json" + } + }, + "description": "Deletes an indexer.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "404": { + "description": "" + }, + "204": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "get": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Get", + "x-ms-examples": { + "SearchServiceGetIndexer": { + "$ref": "./examples/SearchServiceGetIndexer.json" + } + }, + "description": "Retrieves an indexer definition.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexer" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexers": { + "get": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_List", + "x-ms-examples": { + "SearchServiceListIndexers": { + "$ref": "./examples/SearchServiceListIndexers.json" + } + }, + "description": "Lists all indexers available for a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/List-Indexers" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which top-level properties of the indexers to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListIndexersResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "post": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Create", + "x-ms-examples": { + "SearchServiceCreateIndexer": { + "$ref": "./examples/SearchServiceCreateIndexer.json" + } + }, + "description": "Creates a new indexer.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Indexer" + }, + "parameters": [ + { + "name": "indexer", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexer" + }, + "description": "The definition of the indexer to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexer" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexers('{indexerName}')/search.status": { + "get": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_GetStatus", + "x-ms-examples": { + "SearchServiceGetIndexerStatus": { + "$ref": "./examples/SearchServiceGetIndexerStatus.json" + } + }, + "description": "Returns the current status and execution history of an indexer.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Indexer-Status" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer for which to retrieve status." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexerStatus" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/skillsets('{skillsetName}')": { + "put": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateSkillset": { + "$ref": "./examples/SearchServiceCreateOrUpdateSkillset.json" + } + }, + "description": "Creates a new skillset in a search service or updates the skillset if it already exists.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/update-skillset" + }, + "parameters": [ + { + "name": "skillsetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the skillset to create or update." + }, + { + "name": "skillset", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + }, + "description": "The skillset containing one or more skills to create or update in a search service." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/DisableCacheReprocessingChangeDetectionParameter" + }, + { + "$ref": "#/parameters/IgnoreResetRequirementsParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "The skillset is successfully updated.", + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + } + }, + "201": { + "description": "The skillset is successfully created.", + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "delete": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_Delete", + "x-ms-examples": { + "SearchServiceDeleteSkillset": { + "$ref": "./examples/SearchServiceDeleteSkillset.json" + } + }, + "description": "Deletes a skillset in a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/delete-skillset" + }, + "parameters": [ + { + "name": "skillsetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the skillset to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "The skillset is successfully deleted." + }, + "404": { + "description": "The provided skillset name is not found." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "get": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_Get", + "x-ms-examples": { + "SearchServiceGetSkillset": { + "$ref": "./examples/SearchServiceGetSkillset.json" + } + }, + "description": "Retrieves a skillset in a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/get-skillset" + }, + "parameters": [ + { + "name": "skillsetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the skillset to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "The skillset is successfully returned.", + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/skillsets": { + "get": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_List", + "x-ms-examples": { + "SearchServiceListSkillsets": { + "$ref": "./examples/SearchServiceListSkillsets.json" + } + }, + "description": "List all skillsets in a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/list-skillset" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which top-level properties of the skillsets to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "The list is successfully returned.", + "schema": { + "$ref": "#/definitions/ListSkillsetsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "post": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_Create", + "x-ms-examples": { + "SearchServiceCreateSkillset": { + "$ref": "./examples/SearchServiceCreateSkillset.json" + } + }, + "description": "Creates a new skillset in a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/create-skillset" + }, + "parameters": [ + { + "name": "skillset", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + }, + "description": "The skillset containing one or more skills to create in a search service." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "The skillset is successfully created.", + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/synonymmaps('{synonymMapName}')": { + "put": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateSynonymMap": { + "$ref": "./examples/SearchServiceCreateOrUpdateSynonymMap.json" + } + }, + "description": "Creates a new synonym map or updates a synonym map if it already exists.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Update-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the synonym map to create or update." + }, + { + "name": "synonymMap", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SynonymMap" + }, + "description": "The definition of the synonym map to create or update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "delete": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_Delete", + "x-ms-examples": { + "SearchServiceDeleteSynonymMap": { + "$ref": "./examples/SearchServiceDeleteSynonymMap.json" + } + }, + "description": "Deletes a synonym map.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the synonym map to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "get": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_Get", + "x-ms-examples": { + "SearchServiceGetSynonymMap": { + "$ref": "./examples/SearchServiceGetSynonymMap.json" + } + }, + "description": "Retrieves a synonym map definition.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the synonym map to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/synonymmaps": { + "get": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_List", + "x-ms-examples": { + "SearchServiceListSynonymMaps": { + "$ref": "./examples/SearchServiceListSynonymMaps.json" + } + }, + "description": "Lists all synonym maps available for a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/List-Synonym-Maps" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which top-level properties of the synonym maps to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListSynonymMapsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "post": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_Create", + "x-ms-examples": { + "SearchServiceCreateSynonymMap": { + "$ref": "./examples/SearchServiceCreateSynonymMap.json" + } + }, + "description": "Creates a new synonym map.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMap", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SynonymMap" + }, + "description": "The definition of the synonym map to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexes": { + "post": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Create", + "x-ms-examples": { + "SearchServiceCreateIndex": { + "$ref": "./examples/SearchServiceCreateIndex.json" + } + }, + "description": "Creates a new search index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Index" + }, + "parameters": [ + { + "name": "index", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndex" + }, + "description": "The definition of the index to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndex" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "get": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_List", + "x-ms-examples": { + "SearchServiceListIndexes": { + "$ref": "./examples/SearchServiceListIndexes.json" + } + }, + "description": "Lists all indexes available for a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/List-Indexes" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which top-level properties of the index definitions to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListIndexesResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/indexes('{indexName}')": { + "put": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateIndex": { + "$ref": "./examples/SearchServiceCreateOrUpdateIndex.json" + } + }, + "description": "Creates a new search index or updates an index if it already exists.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Update-Index" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The definition of the index to create or update." + }, + { + "name": "index", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndex" + }, + "description": "The definition of the index to create or update." + }, + { + "name": "allowIndexDowntime", + "in": "query", + "required": false, + "type": "boolean", + "description": "Allows new analyzers, tokenizers, token filters, or char filters to be added to an index by taking the index offline for at least a few seconds. This temporarily causes indexing and query requests to fail. Performance and write availability of the index can be impaired for several minutes after the index is updated, or longer for very large indexes." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndex" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndex" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "delete": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Delete", + "x-ms-examples": { + "SearchServiceDeleteIndex": { + "$ref": "./examples/SearchServiceDeleteIndex.json" + } + }, + "description": "Deletes a search index and all the documents it contains. This operation is permanent, with no recovery option. Make sure you have a master copy of your index definition, data ingestion code, and a backup of the primary data source in case you need to re-build the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Index" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "get": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Get", + "x-ms-examples": { + "SearchServiceGetIndex": { + "$ref": "./examples/SearchServiceGetIndex.json" + } + }, + "description": "Retrieves an index definition.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Index" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndex" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexes('{indexName}')/search.stats": { + "get": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_GetStatistics", + "x-ms-examples": { + "SearchServiceGetIndexStatistics": { + "$ref": "./examples/SearchServiceGetIndexStatistics.json" + } + }, + "description": "Returns statistics for the given index, including a document count and storage usage.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Index-Statistics" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index for which to retrieve statistics." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/GetIndexStatisticsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexes('{indexName}')/search.analyze": { + "post": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Analyze", + "x-ms-examples": { + "SearchServiceIndexAnalyze": { + "$ref": "./examples/SearchServiceIndexAnalyze.json" + } + }, + "description": "Shows how an analyzer breaks text into tokens.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/test-analyzer" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index for which to test an analyzer." + }, + { + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeRequest" + }, + "description": "The text and analyzer or analysis components to test." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/AnalyzeResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/servicestats": { + "get": { + "tags": [ + "Service" + ], + "operationId": "GetServiceStatistics", + "x-ms-examples": { + "SearchServiceGetServiceStatistics": { + "$ref": "./examples/SearchServiceGetServiceStatistics.json" + } + }, + "description": "Gets service level statistics for a search service.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ServiceStatistics" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + } + }, + "definitions": { + "AnalyzeRequest": { + "properties": { + "text": { + "type": "string", + "description": "The text to break into tokens." + }, + "analyzer": { + "$ref": "#/definitions/LexicalAnalyzerName", + "description": "The name of the analyzer to use to break the given text. If this parameter is not specified, you must specify a tokenizer instead. The tokenizer and analyzer parameters are mutually exclusive." + }, + "tokenizer": { + "$ref": "#/definitions/LexicalTokenizerName", + "description": "The name of the tokenizer to use to break the given text. If this parameter is not specified, you must specify an analyzer instead. The tokenizer and analyzer parameters are mutually exclusive." + }, + "tokenFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenFilterName", + "x-nullable": false + }, + "description": "An optional list of token filters to use when breaking the given text. This parameter can only be set when using the tokenizer parameter." + }, + "charFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/CharFilterName", + "x-nullable": false + }, + "description": "An optional list of character filters to use when breaking the given text. This parameter can only be set when using the tokenizer parameter." + } + }, + "required": [ + "text" + ], + "description": "Specifies some text and analysis components used to break that text into tokens." + }, + "AnalyzeResult": { + "properties": { + "tokens": { + "type": "array", + "items": { + "$ref": "#/definitions/AnalyzedTokenInfo" + }, + "description": "The list of tokens returned by the analyzer specified in the request." + } + }, + "required": [ + "tokens" + ], + "description": "The result of testing an analyzer on text." + }, + "AnalyzedTokenInfo": { + "properties": { + "token": { + "type": "string", + "readOnly": true, + "description": "The token returned by the analyzer." + }, + "startOffset": { + "type": "integer", + "format": "int32", + "readOnly": true, + "x-nullable": false, + "description": "The index of the first character of the token in the input text." + }, + "endOffset": { + "type": "integer", + "format": "int32", + "readOnly": true, + "x-nullable": false, + "description": "The index of the last character of the token in the input text." + }, + "position": { + "type": "integer", + "format": "int32", + "readOnly": true, + "x-nullable": false, + "description": "The position of the token in the input text relative to other tokens. The first token in the input text has position 0, the next has position 1, and so on. Depending on the analyzer used, some tokens might have the same position, for example if they are synonyms of each other." + } + }, + "required": [ + "token", + "startOffset", + "endOffset", + "position" + ], + "description": "Information about a token returned by an analyzer." + }, + "LexicalAnalyzerName": { + "type": "string", + "enum": [ + "ar.microsoft", + "ar.lucene", + "hy.lucene", + "bn.microsoft", + "eu.lucene", + "bg.microsoft", + "bg.lucene", + "ca.microsoft", + "ca.lucene", + "zh-Hans.microsoft", + "zh-Hans.lucene", + "zh-Hant.microsoft", + "zh-Hant.lucene", + "hr.microsoft", + "cs.microsoft", + "cs.lucene", + "da.microsoft", + "da.lucene", + "nl.microsoft", + "nl.lucene", + "en.microsoft", + "en.lucene", + "et.microsoft", + "fi.microsoft", + "fi.lucene", + "fr.microsoft", + "fr.lucene", + "gl.lucene", + "de.microsoft", + "de.lucene", + "el.microsoft", + "el.lucene", + "gu.microsoft", + "he.microsoft", + "hi.microsoft", + "hi.lucene", + "hu.microsoft", + "hu.lucene", + "is.microsoft", + "id.microsoft", + "id.lucene", + "ga.lucene", + "it.microsoft", + "it.lucene", + "ja.microsoft", + "ja.lucene", + "kn.microsoft", + "ko.microsoft", + "ko.lucene", + "lv.microsoft", + "lv.lucene", + "lt.microsoft", + "ml.microsoft", + "ms.microsoft", + "mr.microsoft", + "nb.microsoft", + "no.lucene", + "fa.lucene", + "pl.microsoft", + "pl.lucene", + "pt-BR.microsoft", + "pt-BR.lucene", + "pt-PT.microsoft", + "pt-PT.lucene", + "pa.microsoft", + "ro.microsoft", + "ro.lucene", + "ru.microsoft", + "ru.lucene", + "sr-cyrillic.microsoft", + "sr-latin.microsoft", + "sk.microsoft", + "sl.microsoft", + "es.microsoft", + "es.lucene", + "sv.microsoft", + "sv.lucene", + "ta.microsoft", + "te.microsoft", + "th.microsoft", + "th.lucene", + "tr.microsoft", + "tr.lucene", + "uk.microsoft", + "ur.microsoft", + "vi.microsoft", + "standard.lucene", + "standardasciifolding.lucene", + "keyword", + "pattern", + "simple", + "stop", + "whitespace" + ], + "x-ms-enum": { + "name": "LexicalAnalyzerName", + "modelAsString": true, + "values": [ + { + "value": "ar.microsoft", + "name": "ArMicrosoft", + "description": "Microsoft analyzer for Arabic." + }, + { + "value": "ar.lucene", + "name": "ArLucene", + "description": "Lucene analyzer for Arabic." + }, + { + "value": "hy.lucene", + "name": "HyLucene", + "description": "Lucene analyzer for Armenian." + }, + { + "value": "bn.microsoft", + "name": "BnMicrosoft", + "description": "Microsoft analyzer for Bangla." + }, + { + "value": "eu.lucene", + "name": "EuLucene", + "description": "Lucene analyzer for Basque." + }, + { + "value": "bg.microsoft", + "name": "BgMicrosoft", + "description": "Microsoft analyzer for Bulgarian." + }, + { + "value": "bg.lucene", + "name": "BgLucene", + "description": "Lucene analyzer for Bulgarian." + }, + { + "value": "ca.microsoft", + "name": "CaMicrosoft", + "description": "Microsoft analyzer for Catalan." + }, + { + "value": "ca.lucene", + "name": "CaLucene", + "description": "Lucene analyzer for Catalan." + }, + { + "value": "zh-Hans.microsoft", + "name": "ZhHansMicrosoft", + "description": "Microsoft analyzer for Chinese (Simplified)." + }, + { + "value": "zh-Hans.lucene", + "name": "ZhHansLucene", + "description": "Lucene analyzer for Chinese (Simplified)." + }, + { + "value": "zh-Hant.microsoft", + "name": "ZhHantMicrosoft", + "description": "Microsoft analyzer for Chinese (Traditional)." + }, + { + "value": "zh-Hant.lucene", + "name": "ZhHantLucene", + "description": "Lucene analyzer for Chinese (Traditional)." + }, + { + "value": "hr.microsoft", + "name": "HrMicrosoft", + "description": "Microsoft analyzer for Croatian." + }, + { + "value": "cs.microsoft", + "name": "CsMicrosoft", + "description": "Microsoft analyzer for Czech." + }, + { + "value": "cs.lucene", + "name": "CsLucene", + "description": "Lucene analyzer for Czech." + }, + { + "value": "da.microsoft", + "name": "DaMicrosoft", + "description": "Microsoft analyzer for Danish." + }, + { + "value": "da.lucene", + "name": "DaLucene", + "description": "Lucene analyzer for Danish." + }, + { + "value": "nl.microsoft", + "name": "NlMicrosoft", + "description": "Microsoft analyzer for Dutch." + }, + { + "value": "nl.lucene", + "name": "NlLucene", + "description": "Lucene analyzer for Dutch." + }, + { + "value": "en.microsoft", + "name": "EnMicrosoft", + "description": "Microsoft analyzer for English." + }, + { + "value": "en.lucene", + "name": "EnLucene", + "description": "Lucene analyzer for English." + }, + { + "value": "et.microsoft", + "name": "EtMicrosoft", + "description": "Microsoft analyzer for Estonian." + }, + { + "value": "fi.microsoft", + "name": "FiMicrosoft", + "description": "Microsoft analyzer for Finnish." + }, + { + "value": "fi.lucene", + "name": "FiLucene", + "description": "Lucene analyzer for Finnish." + }, + { + "value": "fr.microsoft", + "name": "FrMicrosoft", + "description": "Microsoft analyzer for French." + }, + { + "value": "fr.lucene", + "name": "FrLucene", + "description": "Lucene analyzer for French." + }, + { + "value": "gl.lucene", + "name": "GlLucene", + "description": "Lucene analyzer for Galician." + }, + { + "value": "de.microsoft", + "name": "DeMicrosoft", + "description": "Microsoft analyzer for German." + }, + { + "value": "de.lucene", + "name": "DeLucene", + "description": "Lucene analyzer for German." + }, + { + "value": "el.microsoft", + "name": "ElMicrosoft", + "description": "Microsoft analyzer for Greek." + }, + { + "value": "el.lucene", + "name": "ElLucene", + "description": "Lucene analyzer for Greek." + }, + { + "value": "gu.microsoft", + "name": "GuMicrosoft", + "description": "Microsoft analyzer for Gujarati." + }, + { + "value": "he.microsoft", + "name": "HeMicrosoft", + "description": "Microsoft analyzer for Hebrew." + }, + { + "value": "hi.microsoft", + "name": "HiMicrosoft", + "description": "Microsoft analyzer for Hindi." + }, + { + "value": "hi.lucene", + "name": "HiLucene", + "description": "Lucene analyzer for Hindi." + }, + { + "value": "hu.microsoft", + "name": "HuMicrosoft", + "description": "Microsoft analyzer for Hungarian." + }, + { + "value": "hu.lucene", + "name": "HuLucene", + "description": "Lucene analyzer for Hungarian." + }, + { + "value": "is.microsoft", + "name": "IsMicrosoft", + "description": "Microsoft analyzer for Icelandic." + }, + { + "value": "id.microsoft", + "name": "IdMicrosoft", + "description": "Microsoft analyzer for Indonesian (Bahasa)." + }, + { + "value": "id.lucene", + "name": "IdLucene", + "description": "Lucene analyzer for Indonesian." + }, + { + "value": "ga.lucene", + "name": "GaLucene", + "description": "Lucene analyzer for Irish." + }, + { + "value": "it.microsoft", + "name": "ItMicrosoft", + "description": "Microsoft analyzer for Italian." + }, + { + "value": "it.lucene", + "name": "ItLucene", + "description": "Lucene analyzer for Italian." + }, + { + "value": "ja.microsoft", + "name": "JaMicrosoft", + "description": "Microsoft analyzer for Japanese." + }, + { + "value": "ja.lucene", + "name": "JaLucene", + "description": "Lucene analyzer for Japanese." + }, + { + "value": "kn.microsoft", + "name": "KnMicrosoft", + "description": "Microsoft analyzer for Kannada." + }, + { + "value": "ko.microsoft", + "name": "KoMicrosoft", + "description": "Microsoft analyzer for Korean." + }, + { + "value": "ko.lucene", + "name": "KoLucene", + "description": "Lucene analyzer for Korean." + }, + { + "value": "lv.microsoft", + "name": "LvMicrosoft", + "description": "Microsoft analyzer for Latvian." + }, + { + "value": "lv.lucene", + "name": "LvLucene", + "description": "Lucene analyzer for Latvian." + }, + { + "value": "lt.microsoft", + "name": "LtMicrosoft", + "description": "Microsoft analyzer for Lithuanian." + }, + { + "value": "ml.microsoft", + "name": "MlMicrosoft", + "description": "Microsoft analyzer for Malayalam." + }, + { + "value": "ms.microsoft", + "name": "MsMicrosoft", + "description": "Microsoft analyzer for Malay (Latin)." + }, + { + "value": "mr.microsoft", + "name": "MrMicrosoft", + "description": "Microsoft analyzer for Marathi." + }, + { + "value": "nb.microsoft", + "name": "NbMicrosoft", + "description": "Microsoft analyzer for Norwegian (Bokmål)." + }, + { + "value": "no.lucene", + "name": "NoLucene", + "description": "Lucene analyzer for Norwegian." + }, + { + "value": "fa.lucene", + "name": "FaLucene", + "description": "Lucene analyzer for Persian." + }, + { + "value": "pl.microsoft", + "name": "PlMicrosoft", + "description": "Microsoft analyzer for Polish." + }, + { + "value": "pl.lucene", + "name": "PlLucene", + "description": "Lucene analyzer for Polish." + }, + { + "value": "pt-BR.microsoft", + "name": "PtBrMicrosoft", + "description": "Microsoft analyzer for Portuguese (Brazil)." + }, + { + "value": "pt-BR.lucene", + "name": "PtBrLucene", + "description": "Lucene analyzer for Portuguese (Brazil)." + }, + { + "value": "pt-PT.microsoft", + "name": "PtPtMicrosoft", + "description": "Microsoft analyzer for Portuguese (Portugal)." + }, + { + "value": "pt-PT.lucene", + "name": "PtPtLucene", + "description": "Lucene analyzer for Portuguese (Portugal)." + }, + { + "value": "pa.microsoft", + "name": "PaMicrosoft", + "description": "Microsoft analyzer for Punjabi." + }, + { + "value": "ro.microsoft", + "name": "RoMicrosoft", + "description": "Microsoft analyzer for Romanian." + }, + { + "value": "ro.lucene", + "name": "RoLucene", + "description": "Lucene analyzer for Romanian." + }, + { + "value": "ru.microsoft", + "name": "RuMicrosoft", + "description": "Microsoft analyzer for Russian." + }, + { + "value": "ru.lucene", + "name": "RuLucene", + "description": "Lucene analyzer for Russian." + }, + { + "value": "sr-cyrillic.microsoft", + "name": "SrCyrillicMicrosoft", + "description": "Microsoft analyzer for Serbian (Cyrillic)." + }, + { + "value": "sr-latin.microsoft", + "name": "SrLatinMicrosoft", + "description": "Microsoft analyzer for Serbian (Latin)." + }, + { + "value": "sk.microsoft", + "name": "SkMicrosoft", + "description": "Microsoft analyzer for Slovak." + }, + { + "value": "sl.microsoft", + "name": "SlMicrosoft", + "description": "Microsoft analyzer for Slovenian." + }, + { + "value": "es.microsoft", + "name": "EsMicrosoft", + "description": "Microsoft analyzer for Spanish." + }, + { + "value": "es.lucene", + "name": "EsLucene", + "description": "Lucene analyzer for Spanish." + }, + { + "value": "sv.microsoft", + "name": "SvMicrosoft", + "description": "Microsoft analyzer for Swedish." + }, + { + "value": "sv.lucene", + "name": "SvLucene", + "description": "Lucene analyzer for Swedish." + }, + { + "value": "ta.microsoft", + "name": "TaMicrosoft", + "description": "Microsoft analyzer for Tamil." + }, + { + "value": "te.microsoft", + "name": "TeMicrosoft", + "description": "Microsoft analyzer for Telugu." + }, + { + "value": "th.microsoft", + "name": "ThMicrosoft", + "description": "Microsoft analyzer for Thai." + }, + { + "value": "th.lucene", + "name": "ThLucene", + "description": "Lucene analyzer for Thai." + }, + { + "value": "tr.microsoft", + "name": "TrMicrosoft", + "description": "Microsoft analyzer for Turkish." + }, + { + "value": "tr.lucene", + "name": "TrLucene", + "description": "Lucene analyzer for Turkish." + }, + { + "value": "uk.microsoft", + "name": "UkMicrosoft", + "description": "Microsoft analyzer for Ukrainian." + }, + { + "value": "ur.microsoft", + "name": "UrMicrosoft", + "description": "Microsoft analyzer for Urdu." + }, + { + "value": "vi.microsoft", + "name": "ViMicrosoft", + "description": "Microsoft analyzer for Vietnamese." + }, + { + "value": "standard.lucene", + "name": "StandardLucene", + "description": "Standard Lucene analyzer." + }, + { + "value": "standardasciifolding.lucene", + "name": "StandardAsciiFoldingLucene", + "description": "Standard ASCII Folding Lucene analyzer. See https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers" + }, + { + "value": "keyword", + "name": "Keyword", + "description": "Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html" + }, + { + "value": "pattern", + "name": "Pattern", + "description": "Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html" + }, + { + "value": "simple", + "name": "Simple", + "description": "Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html" + }, + { + "value": "stop", + "name": "Stop", + "description": "Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html" + }, + { + "value": "whitespace", + "name": "Whitespace", + "description": "An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html" + } + ] + }, + "description": "Defines the names of all text analyzers supported by Azure Cognitive Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" + } + }, + "LexicalTokenizerName": { + "type": "string", + "enum": [ + "classic", + "edgeNGram", + "keyword_v2", + "letter", + "lowercase", + "microsoft_language_tokenizer", + "microsoft_language_stemming_tokenizer", + "nGram", + "path_hierarchy_v2", + "pattern", + "standard_v2", + "uax_url_email", + "whitespace" + ], + "x-ms-enum": { + "name": "LexicalTokenizerName", + "modelAsString": true, + "values": [ + { + "value": "classic", + "name": "Classic", + "description": "Grammar-based tokenizer that is suitable for processing most European-language documents. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicTokenizer.html" + }, + { + "value": "edgeNGram", + "name": "EdgeNGram", + "description": "Tokenizes the input from an edge into n-grams of the given size(s). See https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenizer.html" + }, + { + "value": "keyword_v2", + "name": "Keyword", + "description": "Emits the entire input as a single token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html" + }, + { + "value": "letter", + "name": "Letter", + "description": "Divides text at non-letters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LetterTokenizer.html" + }, + { + "value": "lowercase", + "name": "Lowercase", + "description": "Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LowerCaseTokenizer.html" + }, + { + "value": "microsoft_language_tokenizer", + "name": "MicrosoftLanguageTokenizer", + "description": "Divides text using language-specific rules." + }, + { + "value": "microsoft_language_stemming_tokenizer", + "name": "MicrosoftLanguageStemmingTokenizer", + "description": "Divides text using language-specific rules and reduces words to their base forms." + }, + { + "value": "nGram", + "name": "NGram", + "description": "Tokenizes the input into n-grams of the given size(s). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenizer.html" + }, + { + "value": "path_hierarchy_v2", + "name": "PathHierarchy", + "description": "Tokenizer for path-like hierarchies. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/path/PathHierarchyTokenizer.html" + }, + { + "value": "pattern", + "name": "Pattern", + "description": "Tokenizer that uses regex pattern matching to construct distinct tokens. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternTokenizer.html" + }, + { + "value": "standard_v2", + "name": "Standard", + "description": "Standard Lucene analyzer; Composed of the standard tokenizer, lowercase filter and stop filter. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html" + }, + { + "value": "uax_url_email", + "name": "UaxUrlEmail", + "description": "Tokenizes urls and emails as one token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/UAX29URLEmailTokenizer.html" + }, + { + "value": "whitespace", + "name": "Whitespace", + "description": "Divides text at whitespace. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceTokenizer.html" + } + ] + }, + "description": "Defines the names of all tokenizers supported by Azure Cognitive Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "TokenFilterName": { + "type": "string", + "enum": [ + "arabic_normalization", + "apostrophe", + "asciifolding", + "cjk_bigram", + "cjk_width", + "classic", + "common_grams", + "edgeNGram_v2", + "elision", + "german_normalization", + "hindi_normalization", + "indic_normalization", + "keyword_repeat", + "kstem", + "length", + "limit", + "lowercase", + "nGram_v2", + "persian_normalization", + "phonetic", + "porter_stem", + "reverse", + "scandinavian_normalization", + "scandinavian_folding", + "shingle", + "snowball", + "sorani_normalization", + "stemmer", + "stopwords", + "trim", + "truncate", + "unique", + "uppercase", + "word_delimiter" + ], + "x-ms-enum": { + "name": "TokenFilterName", + "modelAsString": true, + "values": [ + { + "value": "arabic_normalization", + "name": "ArabicNormalization", + "description": "A token filter that applies the Arabic normalizer to normalize the orthography. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ar/ArabicNormalizationFilter.html" + }, + { + "value": "apostrophe", + "name": "Apostrophe", + "description": "Strips all characters after an apostrophe (including the apostrophe itself). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/tr/ApostropheFilter.html" + }, + { + "value": "asciifolding", + "name": "AsciiFolding", + "description": "Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the \"Basic Latin\" Unicode block) into their ASCII equivalents, if such equivalents exist. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html" + }, + { + "value": "cjk_bigram", + "name": "CjkBigram", + "description": "Forms bigrams of CJK terms that are generated from the standard tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKBigramFilter.html" + }, + { + "value": "cjk_width", + "name": "CjkWidth", + "description": "Normalizes CJK width differences. Folds fullwidth ASCII variants into the equivalent basic Latin, and half-width Katakana variants into the equivalent Kana. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKWidthFilter.html" + }, + { + "value": "classic", + "name": "Classic", + "description": "Removes English possessives, and dots from acronyms. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicFilter.html" + }, + { + "value": "common_grams", + "name": "CommonGram", + "description": "Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/commongrams/CommonGramsFilter.html" + }, + { + "value": "edgeNGram_v2", + "name": "EdgeNGram", + "description": "Generates n-grams of the given size(s) starting from the front or the back of an input token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html" + }, + { + "value": "elision", + "name": "Elision", + "description": "Removes elisions. For example, \"l'avion\" (the plane) will be converted to \"avion\" (plane). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html" + }, + { + "value": "german_normalization", + "name": "GermanNormalization", + "description": "Normalizes German characters according to the heuristics of the German2 snowball algorithm. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/de/GermanNormalizationFilter.html" + }, + { + "value": "hindi_normalization", + "name": "HindiNormalization", + "description": "Normalizes text in Hindi to remove some differences in spelling variations. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/hi/HindiNormalizationFilter.html" + }, + { + "value": "indic_normalization", + "name": "IndicNormalization", + "description": "Normalizes the Unicode representation of text in Indian languages. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/in/IndicNormalizationFilter.html" + }, + { + "value": "keyword_repeat", + "name": "KeywordRepeat", + "description": "Emits each incoming token twice, once as keyword and once as non-keyword. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeywordRepeatFilter.html" + }, + { + "value": "kstem", + "name": "KStem", + "description": "A high-performance kstem filter for English. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/en/KStemFilter.html" + }, + { + "value": "length", + "name": "Length", + "description": "Removes words that are too long or too short. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LengthFilter.html" + }, + { + "value": "limit", + "name": "Limit", + "description": "Limits the number of tokens while indexing. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LimitTokenCountFilter.html" + }, + { + "value": "lowercase", + "name": "Lowercase", + "description": "Normalizes token text to lower case. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html" + }, + { + "value": "nGram_v2", + "name": "NGram", + "description": "Generates n-grams of the given size(s). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html" + }, + { + "value": "persian_normalization", + "name": "PersianNormalization", + "description": "Applies normalization for Persian. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/fa/PersianNormalizationFilter.html" + }, + { + "value": "phonetic", + "name": "Phonetic", + "description": "Create tokens for phonetic matches. See https://lucene.apache.org/core/4_10_3/analyzers-phonetic/org/apache/lucene/analysis/phonetic/package-tree.html" + }, + { + "value": "porter_stem", + "name": "PorterStem", + "description": "Uses the Porter stemming algorithm to transform the token stream. See http://tartarus.org/~martin/PorterStemmer" + }, + { + "value": "reverse", + "name": "Reverse", + "description": "Reverses the token string. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html" + }, + { + "value": "scandinavian_normalization", + "name": "ScandinavianNormalization", + "description": "Normalizes use of the interchangeable Scandinavian characters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianNormalizationFilter.html" + }, + { + "value": "scandinavian_folding", + "name": "ScandinavianFoldingNormalization", + "description": "Folds Scandinavian characters åÅäæÄÆ->a and öÖøØ->o. It also discriminates against use of double vowels aa, ae, ao, oe and oo, leaving just the first one. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianFoldingFilter.html" + }, + { + "value": "shingle", + "name": "Shingle", + "description": "Creates combinations of tokens as a single token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/shingle/ShingleFilter.html" + }, + { + "value": "snowball", + "name": "Snowball", + "description": "A filter that stems words using a Snowball-generated stemmer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/snowball/SnowballFilter.html" + }, + { + "value": "sorani_normalization", + "name": "SoraniNormalization", + "description": "Normalizes the Unicode representation of Sorani text. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ckb/SoraniNormalizationFilter.html" + }, + { + "value": "stemmer", + "name": "Stemmer", + "description": "Language specific stemming filter. See https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters" + }, + { + "value": "stopwords", + "name": "Stopwords", + "description": "Removes stop words from a token stream. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopFilter.html" + }, + { + "value": "trim", + "name": "Trim", + "description": "Trims leading and trailing whitespace from tokens. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TrimFilter.html" + }, + { + "value": "truncate", + "name": "Truncate", + "description": "Truncates the terms to a specific length. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TruncateTokenFilter.html" + }, + { + "value": "unique", + "name": "Unique", + "description": "Filters out tokens with same text as the previous token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/RemoveDuplicatesTokenFilter.html" + }, + { + "value": "uppercase", + "name": "Uppercase", + "description": "Normalizes token text to upper case. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html" + }, + { + "value": "word_delimiter", + "name": "WordDelimiter", + "description": "Splits words into subwords and performs optional transformations on subword groups." + } + ] + }, + "description": "Defines the names of all token filters supported by Azure Cognitive Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "LexicalNormalizerName": { + "type": "string", + "enum": [ + "asciifolding", + "elision", + "lowercase", + "standard", + "uppercase" + ], + "x-ms-enum": { + "name": "LexicalNormalizerName", + "modelAsString": true, + "values": [ + { + "value": "asciifolding", + "name": "AsciiFolding", + "description": "Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the \"Basic Latin\" Unicode block) into their ASCII equivalents, if such equivalents exist. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html" + }, + { + "value": "elision", + "name": "Elision", + "description": "Removes elisions. For example, \"l'avion\" (the plane) will be converted to \"avion\" (plane). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html" + }, + { + "value": "lowercase", + "name": "Lowercase", + "description": "Normalizes token text to lowercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html" + }, + { + "value": "standard", + "name": "Standard", + "description": "Standard normalizer, which consists of lowercase and asciifolding. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html" + }, + { + "value": "uppercase", + "name": "Uppercase", + "description": "Normalizes token text to uppercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html" + } + ] + }, + "description": "Defines the names of all text normalizers supported by Azure Cognitive Search.", + "externalDocs": { + "url": "https://aka.ms/azs-normalizers" + } + }, + "CharFilterName": { + "type": "string", + "enum": [ + "html_strip" + ], + "x-ms-enum": { + "name": "CharFilterName", + "modelAsString": true, + "values": [ + { + "value": "html_strip", + "name": "HtmlStrip", + "description": "A character filter that attempts to strip out HTML constructs. See https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/charfilter/HTMLStripCharFilter.html" + } + ] + }, + "description": "Defines the names of all character filters supported by Azure Cognitive Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "RegexFlags": { + "type": "string", + "enum": [ + "CANON_EQ", + "CASE_INSENSITIVE", + "COMMENTS", + "DOTALL", + "LITERAL", + "MULTILINE", + "UNICODE_CASE", + "UNIX_LINES" + ], + "x-ms-enum": { + "name": "RegexFlags", + "modelAsString": true, + "values": [ + { + "value": "CANON_EQ", + "name": "CanonEq", + "description": "Enables canonical equivalence." + }, + { + "value": "CASE_INSENSITIVE", + "name": "CaseInsensitive", + "description": "Enables case-insensitive matching." + }, + { + "value": "COMMENTS", + "name": "Comments", + "description": "Permits whitespace and comments in the pattern." + }, + { + "value": "DOTALL", + "name": "DotAll", + "description": "Enables dotall mode." + }, + { + "value": "LITERAL", + "name": "Literal", + "description": "Enables literal parsing of the pattern." + }, + { + "value": "MULTILINE", + "name": "Multiline", + "description": "Enables multiline mode." + }, + { + "value": "UNICODE_CASE", + "name": "UnicodeCase", + "description": "Enables Unicode-aware case folding." + }, + { + "value": "UNIX_LINES", + "name": "UnixLines", + "description": "Enables Unix lines mode." + } + ] + }, + "description": "Defines flags that can be combined to control how regular expressions are used in the pattern analyzer and pattern tokenizer.", + "externalDocs": { + "url": "http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html#field_summary" + } + }, + "SearchFieldDataType": { + "type": "string", + "enum": [ + "Edm.String", + "Edm.Int32", + "Edm.Int64", + "Edm.Double", + "Edm.Boolean", + "Edm.DateTimeOffset", + "Edm.GeographyPoint", + "Edm.ComplexType" + ], + "x-ms-enum": { + "name": "SearchFieldDataType", + "modelAsString": true, + "values": [ + { + "value": "Edm.String", + "name": "String", + "description": "Indicates that a field contains a string." + }, + { + "value": "Edm.Int32", + "name": "Int32", + "description": "Indicates that a field contains a 32-bit signed integer." + }, + { + "value": "Edm.Int64", + "name": "Int64", + "description": "Indicates that a field contains a 64-bit signed integer." + }, + { + "value": "Edm.Double", + "name": "Double", + "description": "Indicates that a field contains an IEEE double-precision floating point number." + }, + { + "value": "Edm.Boolean", + "name": "Boolean", + "description": "Indicates that a field contains a Boolean value (true or false)." + }, + { + "value": "Edm.DateTimeOffset", + "name": "DateTimeOffset", + "description": "Indicates that a field contains a date/time value, including timezone information." + }, + { + "value": "Edm.GeographyPoint", + "name": "GeographyPoint", + "description": "Indicates that a field contains a geo-location in terms of longitude and latitude." + }, + { + "value": "Edm.ComplexType", + "name": "Complex", + "description": "Indicates that a field contains one or more complex objects that in turn have sub-fields of other types." + } + ] + }, + "description": "Defines the data type of a field in a search index." + }, + "LexicalAnalyzer": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the analyzer." + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Base type for analyzers." + }, + "CustomAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CustomAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/LexicalAnalyzer" + } + ], + "properties": { + "tokenizer": { + "$ref": "#/definitions/LexicalTokenizerName", + "description": "The name of the tokenizer to use to divide continuous text into a sequence of tokens, such as breaking a sentence into words." + }, + "tokenFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenFilterName", + "x-nullable": false + }, + "description": "A list of token filters used to filter out or modify the tokens generated by a tokenizer. For example, you can specify a lowercase filter that converts all characters to lowercase. The filters are run in the order in which they are listed." + }, + "charFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/CharFilterName", + "x-nullable": false + }, + "description": "A list of character filters used to prepare input text before it is processed by the tokenizer. For instance, they can replace certain characters or symbols. The filters are run in the order in which they are listed." + } + }, + "required": [ + "tokenizer" + ], + "description": "Allows you to take control over the process of converting text into indexable/searchable tokens. It's a user-defined configuration consisting of a single predefined tokenizer and one or more filters. The tokenizer is responsible for breaking text into tokens, and the filters for modifying tokens emitted by the tokenizer." + }, + "PatternAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/LexicalAnalyzer" + } + ], + "properties": { + "lowercase": { + "x-ms-client-name": "LowerCaseTerms", + "type": "boolean", + "default": true, + "description": "A value indicating whether terms should be lower-cased. Default is true." + }, + "pattern": { + "type": "string", + "default": "\\W+", + "description": "A regular expression pattern to match token separators. Default is an expression that matches one or more non-word characters." + }, + "flags": { + "$ref": "#/definitions/RegexFlags", + "description": "Regular expression flags." + }, + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stopwords." + } + }, + "description": "Flexibly separates text into terms via a regular expression pattern. This analyzer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html" + } + }, + "LuceneStandardAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StandardAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/LexicalAnalyzer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + }, + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stopwords." + } + }, + "description": "Standard Apache Lucene analyzer; Composed of the standard tokenizer, lowercase filter and stop filter.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardAnalyzer.html" + } + }, + "StopAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StopAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/LexicalAnalyzer" + } + ], + "properties": { + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stopwords." + } + }, + "description": "Divides text at non-letters; Applies the lowercase and stopword token filters. This analyzer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html" + } + }, + "LexicalNormalizer": { + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the normalizer." + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://aka.ms/azs-normalizers" + }, + "description": "The name of the normalizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. It cannot end in '.microsoft' nor '.lucene', nor be named 'asciifolding', 'standard', 'lowercase', 'uppercase', or 'elision'." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Base type for normalizers." + }, + "CustomNormalizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CustomNormalizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalNormalizer" + } + ], + "properties": { + "tokenFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenFilterName", + "x-nullable": false + }, + "description": "A list of token filters used to filter out or modify the input token. For example, you can specify a lowercase filter that converts all characters to lowercase. The filters are run in the order in which they are listed." + }, + "charFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/CharFilterName", + "x-nullable": false + }, + "description": "A list of character filters used to prepare input text before it is processed. For instance, they can replace certain characters or symbols. The filters are run in the order in which they are listed." + } + }, + "description": "Allows you to configure normalization for filterable, sortable, and facetable fields, which by default operate with strict matching. This is a user-defined configuration consisting of at least one or more filters, which modify the token that is stored.", + "externalDocs": { + "url": "https://aka.ms/azs-custom-normalizers" + } + }, + "LexicalTokenizer": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the tokenizer." + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Base type for tokenizers.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "ClassicTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.ClassicTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Grammar-based tokenizer that is suitable for processing most European-language documents. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicTokenizer.html" + } + }, + "TokenCharacterKind": { + "type": "string", + "enum": [ + "letter", + "digit", + "whitespace", + "punctuation", + "symbol" + ], + "x-ms-enum": { + "name": "TokenCharacterKind", + "modelAsString": false, + "values": [ + { + "value": "letter", + "name": "Letter", + "description": "Keeps letters in tokens." + }, + { + "value": "digit", + "name": "Digit", + "description": "Keeps digits in tokens." + }, + { + "value": "whitespace", + "name": "Whitespace", + "description": "Keeps whitespace in tokens." + }, + { + "value": "punctuation", + "name": "Punctuation", + "description": "Keeps punctuation in tokens." + }, + { + "value": "symbol", + "name": "Symbol", + "description": "Keeps symbols in tokens." + } + ] + }, + "description": "Represents classes of characters on which a token filter can operate." + }, + "EdgeNGramTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.EdgeNGramTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + }, + "tokenChars": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenCharacterKind", + "x-nullable": false + }, + "description": "Character classes to keep in the tokens." + } + }, + "description": "Tokenizes the input from an edge into n-grams of the given size(s). This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenizer.html" + } + }, + "KeywordTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeywordTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "bufferSize": { + "type": "integer", + "format": "int32", + "default": 256, + "description": "The read buffer size in bytes. Default is 256." + } + }, + "description": "Emits the entire input as a single token. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html" + }, + "x-az-search-deprecated": true + }, + "KeywordTokenizerV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeywordTokenizerV2", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 256, + "maximum": 300, + "description": "The maximum token length. Default is 256. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Emits the entire input as a single token. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html" + } + }, + "MicrosoftTokenizerLanguage": { + "type": "string", + "enum": [ + "bangla", + "bulgarian", + "catalan", + "chineseSimplified", + "chineseTraditional", + "croatian", + "czech", + "danish", + "dutch", + "english", + "french", + "german", + "greek", + "gujarati", + "hindi", + "icelandic", + "indonesian", + "italian", + "japanese", + "kannada", + "korean", + "malay", + "malayalam", + "marathi", + "norwegianBokmaal", + "polish", + "portuguese", + "portugueseBrazilian", + "punjabi", + "romanian", + "russian", + "serbianCyrillic", + "serbianLatin", + "slovenian", + "spanish", + "swedish", + "tamil", + "telugu", + "thai", + "ukrainian", + "urdu", + "vietnamese" + ], + "x-ms-enum": { + "name": "MicrosoftTokenizerLanguage", + "modelAsString": false, + "values": [ + { + "value": "bangla", + "name": "Bangla", + "description": "Selects the Microsoft tokenizer for Bangla." + }, + { + "value": "bulgarian", + "name": "Bulgarian", + "description": "Selects the Microsoft tokenizer for Bulgarian." + }, + { + "value": "catalan", + "name": "Catalan", + "description": "Selects the Microsoft tokenizer for Catalan." + }, + { + "value": "chineseSimplified", + "name": "ChineseSimplified", + "description": "Selects the Microsoft tokenizer for Chinese (Simplified)." + }, + { + "value": "chineseTraditional", + "name": "ChineseTraditional", + "description": "Selects the Microsoft tokenizer for Chinese (Traditional)." + }, + { + "value": "croatian", + "name": "Croatian", + "description": "Selects the Microsoft tokenizer for Croatian." + }, + { + "value": "czech", + "name": "Czech", + "description": "Selects the Microsoft tokenizer for Czech." + }, + { + "value": "danish", + "name": "Danish", + "description": "Selects the Microsoft tokenizer for Danish." + }, + { + "value": "dutch", + "name": "Dutch", + "description": "Selects the Microsoft tokenizer for Dutch." + }, + { + "value": "english", + "name": "English", + "description": "Selects the Microsoft tokenizer for English." + }, + { + "value": "french", + "name": "French", + "description": "Selects the Microsoft tokenizer for French." + }, + { + "value": "german", + "name": "German", + "description": "Selects the Microsoft tokenizer for German." + }, + { + "value": "greek", + "name": "Greek", + "description": "Selects the Microsoft tokenizer for Greek." + }, + { + "value": "gujarati", + "name": "Gujarati", + "description": "Selects the Microsoft tokenizer for Gujarati." + }, + { + "value": "hindi", + "name": "Hindi", + "description": "Selects the Microsoft tokenizer for Hindi." + }, + { + "value": "icelandic", + "name": "Icelandic", + "description": "Selects the Microsoft tokenizer for Icelandic." + }, + { + "value": "indonesian", + "name": "Indonesian", + "description": "Selects the Microsoft tokenizer for Indonesian." + }, + { + "value": "italian", + "name": "Italian", + "description": "Selects the Microsoft tokenizer for Italian." + }, + { + "value": "japanese", + "name": "Japanese", + "description": "Selects the Microsoft tokenizer for Japanese." + }, + { + "value": "kannada", + "name": "Kannada", + "description": "Selects the Microsoft tokenizer for Kannada." + }, + { + "value": "korean", + "name": "Korean", + "description": "Selects the Microsoft tokenizer for Korean." + }, + { + "value": "malay", + "name": "Malay", + "description": "Selects the Microsoft tokenizer for Malay." + }, + { + "value": "malayalam", + "name": "Malayalam", + "description": "Selects the Microsoft tokenizer for Malayalam." + }, + { + "value": "marathi", + "name": "Marathi", + "description": "Selects the Microsoft tokenizer for Marathi." + }, + { + "value": "norwegianBokmaal", + "name": "NorwegianBokmaal", + "description": "Selects the Microsoft tokenizer for Norwegian (Bokmål)." + }, + { + "value": "polish", + "name": "Polish", + "description": "Selects the Microsoft tokenizer for Polish." + }, + { + "value": "portuguese", + "name": "Portuguese", + "description": "Selects the Microsoft tokenizer for Portuguese." + }, + { + "value": "portugueseBrazilian", + "name": "PortugueseBrazilian", + "description": "Selects the Microsoft tokenizer for Portuguese (Brazil)." + }, + { + "value": "punjabi", + "name": "Punjabi", + "description": "Selects the Microsoft tokenizer for Punjabi." + }, + { + "value": "romanian", + "name": "Romanian", + "description": "Selects the Microsoft tokenizer for Romanian." + }, + { + "value": "russian", + "name": "Russian", + "description": "Selects the Microsoft tokenizer for Russian." + }, + { + "value": "serbianCyrillic", + "name": "SerbianCyrillic", + "description": "Selects the Microsoft tokenizer for Serbian (Cyrillic)." + }, + { + "value": "serbianLatin", + "name": "SerbianLatin", + "description": "Selects the Microsoft tokenizer for Serbian (Latin)." + }, + { + "value": "slovenian", + "name": "Slovenian", + "description": "Selects the Microsoft tokenizer for Slovenian." + }, + { + "value": "spanish", + "name": "Spanish", + "description": "Selects the Microsoft tokenizer for Spanish." + }, + { + "value": "swedish", + "name": "Swedish", + "description": "Selects the Microsoft tokenizer for Swedish." + }, + { + "value": "tamil", + "name": "Tamil", + "description": "Selects the Microsoft tokenizer for Tamil." + }, + { + "value": "telugu", + "name": "Telugu", + "description": "Selects the Microsoft tokenizer for Telugu." + }, + { + "value": "thai", + "name": "Thai", + "description": "Selects the Microsoft tokenizer for Thai." + }, + { + "value": "ukrainian", + "name": "Ukrainian", + "description": "Selects the Microsoft tokenizer for Ukrainian." + }, + { + "value": "urdu", + "name": "Urdu", + "description": "Selects the Microsoft tokenizer for Urdu." + }, + { + "value": "vietnamese", + "name": "Vietnamese", + "description": "Selects the Microsoft tokenizer for Vietnamese." + } + ] + }, + "description": "Lists the languages supported by the Microsoft language tokenizer." + }, + "MicrosoftLanguageTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.MicrosoftLanguageTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Tokens longer than the maximum length are split. Maximum token length that can be used is 300 characters. Tokens longer than 300 characters are first split into tokens of length 300 and then each of those tokens is split based on the max token length set. Default is 255." + }, + "isSearchTokenizer": { + "type": "boolean", + "default": false, + "description": "A value indicating how the tokenizer is used. Set to true if used as the search tokenizer, set to false if used as the indexing tokenizer. Default is false." + }, + "language": { + "$ref": "#/definitions/MicrosoftTokenizerLanguage", + "description": "The language to use. The default is English." + } + }, + "description": "Divides text using language-specific rules." + }, + "MicrosoftStemmingTokenizerLanguage": { + "type": "string", + "enum": [ + "arabic", + "bangla", + "bulgarian", + "catalan", + "croatian", + "czech", + "danish", + "dutch", + "english", + "estonian", + "finnish", + "french", + "german", + "greek", + "gujarati", + "hebrew", + "hindi", + "hungarian", + "icelandic", + "indonesian", + "italian", + "kannada", + "latvian", + "lithuanian", + "malay", + "malayalam", + "marathi", + "norwegianBokmaal", + "polish", + "portuguese", + "portugueseBrazilian", + "punjabi", + "romanian", + "russian", + "serbianCyrillic", + "serbianLatin", + "slovak", + "slovenian", + "spanish", + "swedish", + "tamil", + "telugu", + "turkish", + "ukrainian", + "urdu" + ], + "x-ms-enum": { + "name": "MicrosoftStemmingTokenizerLanguage", + "modelAsString": false, + "values": [ + { + "value": "arabic", + "name": "Arabic", + "description": "Selects the Microsoft stemming tokenizer for Arabic." + }, + { + "value": "bangla", + "name": "Bangla", + "description": "Selects the Microsoft stemming tokenizer for Bangla." + }, + { + "value": "bulgarian", + "name": "Bulgarian", + "description": "Selects the Microsoft stemming tokenizer for Bulgarian." + }, + { + "value": "catalan", + "name": "Catalan", + "description": "Selects the Microsoft stemming tokenizer for Catalan." + }, + { + "value": "croatian", + "name": "Croatian", + "description": "Selects the Microsoft stemming tokenizer for Croatian." + }, + { + "value": "czech", + "name": "Czech", + "description": "Selects the Microsoft stemming tokenizer for Czech." + }, + { + "value": "danish", + "name": "Danish", + "description": "Selects the Microsoft stemming tokenizer for Danish." + }, + { + "value": "dutch", + "name": "Dutch", + "description": "Selects the Microsoft stemming tokenizer for Dutch." + }, + { + "value": "english", + "name": "English", + "description": "Selects the Microsoft stemming tokenizer for English." + }, + { + "value": "estonian", + "name": "Estonian", + "description": "Selects the Microsoft stemming tokenizer for Estonian." + }, + { + "value": "finnish", + "name": "Finnish", + "description": "Selects the Microsoft stemming tokenizer for Finnish." + }, + { + "value": "french", + "name": "French", + "description": "Selects the Microsoft stemming tokenizer for French." + }, + { + "value": "german", + "name": "German", + "description": "Selects the Microsoft stemming tokenizer for German." + }, + { + "value": "greek", + "name": "Greek", + "description": "Selects the Microsoft stemming tokenizer for Greek." + }, + { + "value": "gujarati", + "name": "Gujarati", + "description": "Selects the Microsoft stemming tokenizer for Gujarati." + }, + { + "value": "hebrew", + "name": "Hebrew", + "description": "Selects the Microsoft stemming tokenizer for Hebrew." + }, + { + "value": "hindi", + "name": "Hindi", + "description": "Selects the Microsoft stemming tokenizer for Hindi." + }, + { + "value": "hungarian", + "name": "Hungarian", + "description": "Selects the Microsoft stemming tokenizer for Hungarian." + }, + { + "value": "icelandic", + "name": "Icelandic", + "description": "Selects the Microsoft stemming tokenizer for Icelandic." + }, + { + "value": "indonesian", + "name": "Indonesian", + "description": "Selects the Microsoft stemming tokenizer for Indonesian." + }, + { + "value": "italian", + "name": "Italian", + "description": "Selects the Microsoft stemming tokenizer for Italian." + }, + { + "value": "kannada", + "name": "Kannada", + "description": "Selects the Microsoft stemming tokenizer for Kannada." + }, + { + "value": "latvian", + "name": "Latvian", + "description": "Selects the Microsoft stemming tokenizer for Latvian." + }, + { + "value": "lithuanian", + "name": "Lithuanian", + "description": "Selects the Microsoft stemming tokenizer for Lithuanian." + }, + { + "value": "malay", + "name": "Malay", + "description": "Selects the Microsoft stemming tokenizer for Malay." + }, + { + "value": "malayalam", + "name": "Malayalam", + "description": "Selects the Microsoft stemming tokenizer for Malayalam." + }, + { + "value": "marathi", + "name": "Marathi", + "description": "Selects the Microsoft stemming tokenizer for Marathi." + }, + { + "value": "norwegianBokmaal", + "name": "NorwegianBokmaal", + "description": "Selects the Microsoft stemming tokenizer for Norwegian (Bokmål)." + }, + { + "value": "polish", + "name": "Polish", + "description": "Selects the Microsoft stemming tokenizer for Polish." + }, + { + "value": "portuguese", + "name": "Portuguese", + "description": "Selects the Microsoft stemming tokenizer for Portuguese." + }, + { + "value": "portugueseBrazilian", + "name": "PortugueseBrazilian", + "description": "Selects the Microsoft stemming tokenizer for Portuguese (Brazil)." + }, + { + "value": "punjabi", + "name": "Punjabi", + "description": "Selects the Microsoft stemming tokenizer for Punjabi." + }, + { + "value": "romanian", + "name": "Romanian", + "description": "Selects the Microsoft stemming tokenizer for Romanian." + }, + { + "value": "russian", + "name": "Russian", + "description": "Selects the Microsoft stemming tokenizer for Russian." + }, + { + "value": "serbianCyrillic", + "name": "SerbianCyrillic", + "description": "Selects the Microsoft stemming tokenizer for Serbian (Cyrillic)." + }, + { + "value": "serbianLatin", + "name": "SerbianLatin", + "description": "Selects the Microsoft stemming tokenizer for Serbian (Latin)." + }, + { + "value": "slovak", + "name": "Slovak", + "description": "Selects the Microsoft stemming tokenizer for Slovak." + }, + { + "value": "slovenian", + "name": "Slovenian", + "description": "Selects the Microsoft stemming tokenizer for Slovenian." + }, + { + "value": "spanish", + "name": "Spanish", + "description": "Selects the Microsoft stemming tokenizer for Spanish." + }, + { + "value": "swedish", + "name": "Swedish", + "description": "Selects the Microsoft stemming tokenizer for Swedish." + }, + { + "value": "tamil", + "name": "Tamil", + "description": "Selects the Microsoft stemming tokenizer for Tamil." + }, + { + "value": "telugu", + "name": "Telugu", + "description": "Selects the Microsoft stemming tokenizer for Telugu." + }, + { + "value": "turkish", + "name": "Turkish", + "description": "Selects the Microsoft stemming tokenizer for Turkish." + }, + { + "value": "ukrainian", + "name": "Ukrainian", + "description": "Selects the Microsoft stemming tokenizer for Ukrainian." + }, + { + "value": "urdu", + "name": "Urdu", + "description": "Selects the Microsoft stemming tokenizer for Urdu." + } + ] + }, + "description": "Lists the languages supported by the Microsoft language stemming tokenizer." + }, + "MicrosoftLanguageStemmingTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.MicrosoftLanguageStemmingTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Tokens longer than the maximum length are split. Maximum token length that can be used is 300 characters. Tokens longer than 300 characters are first split into tokens of length 300 and then each of those tokens is split based on the max token length set. Default is 255." + }, + "isSearchTokenizer": { + "type": "boolean", + "default": false, + "description": "A value indicating how the tokenizer is used. Set to true if used as the search tokenizer, set to false if used as the indexing tokenizer. Default is false." + }, + "language": { + "$ref": "#/definitions/MicrosoftStemmingTokenizerLanguage", + "description": "The language to use. The default is English." + } + }, + "description": "Divides text using language-specific rules and reduces words to their base forms." + }, + "NGramTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NGramTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + }, + "tokenChars": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenCharacterKind", + "x-nullable": false + }, + "description": "Character classes to keep in the tokens." + } + }, + "description": "Tokenizes the input into n-grams of the given size(s). This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenizer.html" + } + }, + "PathHierarchyTokenizerV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PathHierarchyTokenizerV2", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "delimiter": { + "type": "string", + "format": "char", + "default": "/", + "description": "The delimiter character to use. Default is \"/\"." + }, + "replacement": { + "type": "string", + "format": "char", + "default": "/", + "description": "A value that, if set, replaces the delimiter character. Default is \"/\"." + }, + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 300, + "maximum": 300, + "description": "The maximum token length. Default and maximum is 300." + }, + "reverse": { + "x-ms-client-name": "ReverseTokenOrder", + "type": "boolean", + "default": false, + "description": "A value indicating whether to generate tokens in reverse order. Default is false." + }, + "skip": { + "x-ms-client-name": "NumberOfTokensToSkip", + "type": "integer", + "format": "int32", + "default": 0, + "description": "The number of initial tokens to skip. Default is 0." + } + }, + "description": "Tokenizer for path-like hierarchies. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/path/PathHierarchyTokenizer.html" + } + }, + "PatternTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "pattern": { + "type": "string", + "default": "\\W+", + "description": "A regular expression pattern to match token separators. Default is an expression that matches one or more non-word characters." + }, + "flags": { + "$ref": "#/definitions/RegexFlags", + "description": "Regular expression flags." + }, + "group": { + "type": "integer", + "format": "int32", + "default": -1, + "description": "The zero-based ordinal of the matching group in the regular expression pattern to extract into tokens. Use -1 if you want to use the entire pattern to split the input into tokens, irrespective of matching groups. Default is -1." + } + }, + "description": "Tokenizer that uses regex pattern matching to construct distinct tokens. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternTokenizer.html" + } + }, + "LuceneStandardTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StandardTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split." + } + }, + "description": "Breaks text following the Unicode Text Segmentation rules. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html" + }, + "x-az-search-deprecated": true + }, + "LuceneStandardTokenizerV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StandardTokenizerV2", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Breaks text following the Unicode Text Segmentation rules. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html" + } + }, + "UaxUrlEmailTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.UaxUrlEmailTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Tokenizes urls and emails as one token. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/UAX29URLEmailTokenizer.html" + } + }, + "TokenFilter": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the token filter." + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Base type for token filters.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "AsciiFoldingTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.AsciiFoldingTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "preserveOriginal": { + "type": "boolean", + "default": false, + "description": "A value indicating whether the original token will be kept. Default is false." + } + }, + "description": "Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the \"Basic Latin\" Unicode block) into their ASCII equivalents, if such equivalents exist. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html" + } + }, + "CjkBigramTokenFilterScripts": { + "type": "string", + "enum": [ + "han", + "hiragana", + "katakana", + "hangul" + ], + "x-ms-enum": { + "name": "CjkBigramTokenFilterScripts", + "modelAsString": false, + "values": [ + { + "value": "han", + "name": "Han", + "description": "Ignore Han script when forming bigrams of CJK terms." + }, + { + "value": "hiragana", + "name": "Hiragana", + "description": "Ignore Hiragana script when forming bigrams of CJK terms." + }, + { + "value": "katakana", + "name": "Katakana", + "description": "Ignore Katakana script when forming bigrams of CJK terms." + }, + { + "value": "hangul", + "name": "Hangul", + "description": "Ignore Hangul script when forming bigrams of CJK terms." + } + ] + }, + "description": "Scripts that can be ignored by CjkBigramTokenFilter." + }, + "CjkBigramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CjkBigramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "ignoreScripts": { + "type": "array", + "items": { + "$ref": "#/definitions/CjkBigramTokenFilterScripts", + "x-nullable": false + }, + "description": "The scripts to ignore." + }, + "outputUnigrams": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to output both unigrams and bigrams (if true), or just bigrams (if false). Default is false." + } + }, + "description": "Forms bigrams of CJK terms that are generated from the standard tokenizer. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKBigramFilter.html" + } + }, + "CommonGramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CommonGramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "commonWords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of common words." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether common words matching will be case insensitive. Default is false." + }, + "queryMode": { + "x-ms-client-name": "UseQueryMode", + "type": "boolean", + "default": false, + "description": "A value that indicates whether the token filter is in query mode. When in query mode, the token filter generates bigrams and then removes common words and single terms followed by a common word. Default is false." + } + }, + "required": [ + "commonWords" + ], + "description": "Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/commongrams/CommonGramsFilter.html" + } + }, + "DictionaryDecompounderTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.DictionaryDecompounderTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "wordList": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of words to match against." + }, + "minWordSize": { + "type": "integer", + "format": "int32", + "default": 5, + "maximum": 300, + "description": "The minimum word size. Only words longer than this get processed. Default is 5. Maximum is 300." + }, + "minSubwordSize": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The minimum subword size. Only subwords longer than this are outputted. Default is 2. Maximum is 300." + }, + "maxSubwordSize": { + "type": "integer", + "format": "int32", + "default": 15, + "maximum": 300, + "description": "The maximum subword size. Only subwords shorter than this are outputted. Default is 15. Maximum is 300." + }, + "onlyLongestMatch": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to add only the longest matching subword to the output. Default is false." + } + }, + "required": [ + "wordList" + ], + "description": "Decomposes compound words found in many Germanic languages. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/compound/DictionaryCompoundWordTokenFilter.html" + } + }, + "EdgeNGramTokenFilterSide": { + "type": "string", + "enum": [ + "front", + "back" + ], + "x-ms-enum": { + "name": "EdgeNGramTokenFilterSide", + "modelAsString": false, + "values": [ + { + "value": "front", + "name": "Front", + "description": "Specifies that the n-gram should be generated from the front of the input." + }, + { + "value": "back", + "name": "Back", + "description": "Specifies that the n-gram should be generated from the back of the input." + } + ] + }, + "description": "Specifies which side of the input an n-gram should be generated from." + }, + "EdgeNGramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.EdgeNGramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "description": "The minimum n-gram length. Default is 1. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "description": "The maximum n-gram length. Default is 2." + }, + "side": { + "$ref": "#/definitions/EdgeNGramTokenFilterSide", + "default": "front", + "description": "Specifies which side of the input the n-gram should be generated from. Default is \"front\"." + } + }, + "description": "Generates n-grams of the given size(s) starting from the front or the back of an input token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html" + }, + "x-az-search-deprecated": true + }, + "EdgeNGramTokenFilterV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.EdgeNGramTokenFilterV2", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + }, + "side": { + "$ref": "#/definitions/EdgeNGramTokenFilterSide", + "default": "front", + "description": "Specifies which side of the input the n-gram should be generated from. Default is \"front\"." + } + }, + "description": "Generates n-grams of the given size(s) starting from the front or the back of an input token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html" + } + }, + "ElisionTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.ElisionTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "articles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of articles to remove." + } + }, + "description": "Removes elisions. For example, \"l'avion\" (the plane) will be converted to \"avion\" (plane). This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html" + } + }, + "KeepTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeepTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "keepWords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of words to keep." + }, + "keepWordsCase": { + "x-ms-client-name": "LowerCaseKeepWords", + "type": "boolean", + "default": false, + "description": "A value indicating whether to lower case all words first. Default is false." + } + }, + "required": [ + "keepWords" + ], + "description": "A token filter that only keeps tokens with text contained in a specified list of words. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeepWordFilter.html" + } + }, + "KeywordMarkerTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeywordMarkerTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "keywords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of words to mark as keywords." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to ignore case. If true, all words are converted to lower case first. Default is false." + } + }, + "required": [ + "keywords" + ], + "description": "Marks terms as keywords. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeywordMarkerFilter.html" + } + }, + "LengthTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.LengthTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "min": { + "x-ms-client-name": "minLength", + "type": "integer", + "format": "int32", + "default": 0, + "maximum": 300, + "description": "The minimum length in characters. Default is 0. Maximum is 300. Must be less than the value of max." + }, + "max": { + "x-ms-client-name": "maxLength", + "type": "integer", + "format": "int32", + "default": 300, + "maximum": 300, + "description": "The maximum length in characters. Default and maximum is 300." + } + }, + "description": "Removes words that are too long or too short. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LengthFilter.html" + } + }, + "LimitTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.LimitTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "maxTokenCount": { + "type": "integer", + "format": "int32", + "default": 1, + "description": "The maximum number of tokens to produce. Default is 1." + }, + "consumeAllTokens": { + "type": "boolean", + "default": false, + "description": "A value indicating whether all tokens from the input must be consumed even if maxTokenCount is reached. Default is false." + } + }, + "description": "Limits the number of tokens while indexing. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LimitTokenCountFilter.html" + } + }, + "NGramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NGramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "description": "The minimum n-gram length. Default is 1. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "description": "The maximum n-gram length. Default is 2." + } + }, + "description": "Generates n-grams of the given size(s). This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html" + }, + "x-az-search-deprecated": true + }, + "NGramTokenFilterV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NGramTokenFilterV2", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + } + }, + "description": "Generates n-grams of the given size(s). This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html" + } + }, + "PatternCaptureTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternCaptureTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "patterns": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of patterns to match against each token." + }, + "preserveOriginal": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to return the original token even if one of the patterns matches. Default is true." + } + }, + "required": [ + "patterns" + ], + "description": "Uses Java regexes to emit multiple tokens - one for each capture group in one or more patterns. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternCaptureGroupTokenFilter.html" + } + }, + "PatternReplaceTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternReplaceTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "pattern": { + "type": "string", + "description": "A regular expression pattern." + }, + "replacement": { + "type": "string", + "description": "The replacement text." + } + }, + "required": [ + "pattern", + "replacement" + ], + "description": "A character filter that replaces characters in the input string. It uses a regular expression to identify character sequences to preserve and a replacement pattern to identify characters to replace. For example, given the input text \"aa bb aa bb\", pattern \"(aa)\\s+(bb)\", and replacement \"$1#$2\", the result would be \"aa#bb aa#bb\". This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternReplaceFilter.html" + } + }, + "PhoneticEncoder": { + "type": "string", + "enum": [ + "metaphone", + "doubleMetaphone", + "soundex", + "refinedSoundex", + "caverphone1", + "caverphone2", + "cologne", + "nysiis", + "koelnerPhonetik", + "haasePhonetik", + "beiderMorse" + ], + "x-ms-enum": { + "name": "PhoneticEncoder", + "modelAsString": false, + "values": [ + { + "value": "metaphone", + "name": "Metaphone", + "description": "Encodes a token into a Metaphone value." + }, + { + "value": "doubleMetaphone", + "name": "DoubleMetaphone", + "description": "Encodes a token into a double metaphone value." + }, + { + "value": "soundex", + "name": "Soundex", + "description": "Encodes a token into a Soundex value." + }, + { + "value": "refinedSoundex", + "name": "RefinedSoundex", + "description": "Encodes a token into a Refined Soundex value." + }, + { + "value": "caverphone1", + "name": "Caverphone1", + "description": "Encodes a token into a Caverphone 1.0 value." + }, + { + "value": "caverphone2", + "name": "Caverphone2", + "description": "Encodes a token into a Caverphone 2.0 value." + }, + { + "value": "cologne", + "name": "Cologne", + "description": "Encodes a token into a Cologne Phonetic value." + }, + { + "value": "nysiis", + "name": "Nysiis", + "description": "Encodes a token into a NYSIIS value." + }, + { + "value": "koelnerPhonetik", + "name": "KoelnerPhonetik", + "description": "Encodes a token using the Kölner Phonetik algorithm." + }, + { + "value": "haasePhonetik", + "name": "HaasePhonetik", + "description": "Encodes a token using the Haase refinement of the Kölner Phonetik algorithm." + }, + { + "value": "beiderMorse", + "name": "BeiderMorse", + "description": "Encodes a token into a Beider-Morse value." + } + ] + }, + "description": "Identifies the type of phonetic encoder to use with a PhoneticTokenFilter." + }, + "PhoneticTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PhoneticTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "encoder": { + "$ref": "#/definitions/PhoneticEncoder", + "default": "metaphone", + "description": "The phonetic encoder to use. Default is \"metaphone\"." + }, + "replace": { + "x-ms-client-name": "ReplaceOriginalTokens", + "type": "boolean", + "default": true, + "description": "A value indicating whether encoded tokens should replace original tokens. If false, encoded tokens are added as synonyms. Default is true." + } + }, + "description": "Create tokens for phonetic matches. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-phonetic/org/apache/lucene/analysis/phonetic/package-tree.html" + } + }, + "ShingleTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.ShingleTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "maxShingleSize": { + "type": "integer", + "format": "int32", + "default": 2, + "minimum": 2, + "description": "The maximum shingle size. Default and minimum value is 2." + }, + "minShingleSize": { + "type": "integer", + "format": "int32", + "default": 2, + "minimum": 2, + "description": "The minimum shingle size. Default and minimum value is 2. Must be less than the value of maxShingleSize." + }, + "outputUnigrams": { + "type": "boolean", + "default": true, + "description": "A value indicating whether the output stream will contain the input tokens (unigrams) as well as shingles. Default is true." + }, + "outputUnigramsIfNoShingles": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to output unigrams for those times when no shingles are available. This property takes precedence when outputUnigrams is set to false. Default is false." + }, + "tokenSeparator": { + "type": "string", + "default": " ", + "description": "The string to use when joining adjacent tokens to form a shingle. Default is a single space (\" \")." + }, + "filterToken": { + "type": "string", + "default": "_", + "description": "The string to insert for each position at which there is no token. Default is an underscore (\"_\")." + } + }, + "description": "Creates combinations of tokens as a single token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/shingle/ShingleFilter.html" + } + }, + "SnowballTokenFilterLanguage": { + "type": "string", + "enum": [ + "armenian", + "basque", + "catalan", + "danish", + "dutch", + "english", + "finnish", + "french", + "german", + "german2", + "hungarian", + "italian", + "kp", + "lovins", + "norwegian", + "porter", + "portuguese", + "romanian", + "russian", + "spanish", + "swedish", + "turkish" + ], + "x-ms-enum": { + "name": "SnowballTokenFilterLanguage", + "modelAsString": false, + "values": [ + { + "value": "armenian", + "name": "Armenian", + "description": "Selects the Lucene Snowball stemming tokenizer for Armenian." + }, + { + "value": "basque", + "name": "Basque", + "description": "Selects the Lucene Snowball stemming tokenizer for Basque." + }, + { + "value": "catalan", + "name": "Catalan", + "description": "Selects the Lucene Snowball stemming tokenizer for Catalan." + }, + { + "value": "danish", + "name": "Danish", + "description": "Selects the Lucene Snowball stemming tokenizer for Danish." + }, + { + "value": "dutch", + "name": "Dutch", + "description": "Selects the Lucene Snowball stemming tokenizer for Dutch." + }, + { + "value": "english", + "name": "English", + "description": "Selects the Lucene Snowball stemming tokenizer for English." + }, + { + "value": "finnish", + "name": "Finnish", + "description": "Selects the Lucene Snowball stemming tokenizer for Finnish." + }, + { + "value": "french", + "name": "French", + "description": "Selects the Lucene Snowball stemming tokenizer for French." + }, + { + "value": "german", + "name": "German", + "description": "Selects the Lucene Snowball stemming tokenizer for German." + }, + { + "value": "german2", + "name": "German2", + "description": "Selects the Lucene Snowball stemming tokenizer that uses the German variant algorithm." + }, + { + "value": "hungarian", + "name": "Hungarian", + "description": "Selects the Lucene Snowball stemming tokenizer for Hungarian." + }, + { + "value": "italian", + "name": "Italian", + "description": "Selects the Lucene Snowball stemming tokenizer for Italian." + }, + { + "value": "kp", + "name": "Kp", + "description": "Selects the Lucene Snowball stemming tokenizer for Dutch that uses the Kraaij-Pohlmann stemming algorithm." + }, + { + "value": "lovins", + "name": "Lovins", + "description": "Selects the Lucene Snowball stemming tokenizer for English that uses the Lovins stemming algorithm." + }, + { + "value": "norwegian", + "name": "Norwegian", + "description": "Selects the Lucene Snowball stemming tokenizer for Norwegian." + }, + { + "value": "porter", + "name": "Porter", + "description": "Selects the Lucene Snowball stemming tokenizer for English that uses the Porter stemming algorithm." + }, + { + "value": "portuguese", + "name": "Portuguese", + "description": "Selects the Lucene Snowball stemming tokenizer for Portuguese." + }, + { + "value": "romanian", + "name": "Romanian", + "description": "Selects the Lucene Snowball stemming tokenizer for Romanian." + }, + { + "value": "russian", + "name": "Russian", + "description": "Selects the Lucene Snowball stemming tokenizer for Russian." + }, + { + "value": "spanish", + "name": "Spanish", + "description": "Selects the Lucene Snowball stemming tokenizer for Spanish." + }, + { + "value": "swedish", + "name": "Swedish", + "description": "Selects the Lucene Snowball stemming tokenizer for Swedish." + }, + { + "value": "turkish", + "name": "Turkish", + "description": "Selects the Lucene Snowball stemming tokenizer for Turkish." + } + ] + }, + "description": "The language to use for a Snowball token filter." + }, + "SnowballTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SnowballTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "language": { + "$ref": "#/definitions/SnowballTokenFilterLanguage", + "description": "The language to use." + } + }, + "required": [ + "language" + ], + "description": "A filter that stems words using a Snowball-generated stemmer. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/snowball/SnowballFilter.html" + } + }, + "StemmerTokenFilterLanguage": { + "type": "string", + "enum": [ + "arabic", + "armenian", + "basque", + "brazilian", + "bulgarian", + "catalan", + "czech", + "danish", + "dutch", + "dutchKp", + "english", + "lightEnglish", + "minimalEnglish", + "possessiveEnglish", + "porter2", + "lovins", + "finnish", + "lightFinnish", + "french", + "lightFrench", + "minimalFrench", + "galician", + "minimalGalician", + "german", + "german2", + "lightGerman", + "minimalGerman", + "greek", + "hindi", + "hungarian", + "lightHungarian", + "indonesian", + "irish", + "italian", + "lightItalian", + "sorani", + "latvian", + "norwegian", + "lightNorwegian", + "minimalNorwegian", + "lightNynorsk", + "minimalNynorsk", + "portuguese", + "lightPortuguese", + "minimalPortuguese", + "portugueseRslp", + "romanian", + "russian", + "lightRussian", + "spanish", + "lightSpanish", + "swedish", + "lightSwedish", + "turkish" + ], + "x-ms-enum": { + "name": "StemmerTokenFilterLanguage", + "modelAsString": false, + "values": [ + { + "value": "arabic", + "name": "Arabic", + "description": "Selects the Lucene stemming tokenizer for Arabic." + }, + { + "value": "armenian", + "name": "Armenian", + "description": "Selects the Lucene stemming tokenizer for Armenian." + }, + { + "value": "basque", + "name": "Basque", + "description": "Selects the Lucene stemming tokenizer for Basque." + }, + { + "value": "brazilian", + "name": "Brazilian", + "description": "Selects the Lucene stemming tokenizer for Portuguese (Brazil)." + }, + { + "value": "bulgarian", + "name": "Bulgarian", + "description": "Selects the Lucene stemming tokenizer for Bulgarian." + }, + { + "value": "catalan", + "name": "Catalan", + "description": "Selects the Lucene stemming tokenizer for Catalan." + }, + { + "value": "czech", + "name": "Czech", + "description": "Selects the Lucene stemming tokenizer for Czech." + }, + { + "value": "danish", + "name": "Danish", + "description": "Selects the Lucene stemming tokenizer for Danish." + }, + { + "value": "dutch", + "name": "Dutch", + "description": "Selects the Lucene stemming tokenizer for Dutch." + }, + { + "value": "dutchKp", + "name": "DutchKp", + "description": "Selects the Lucene stemming tokenizer for Dutch that uses the Kraaij-Pohlmann stemming algorithm." + }, + { + "value": "english", + "name": "English", + "description": "Selects the Lucene stemming tokenizer for English." + }, + { + "value": "lightEnglish", + "name": "LightEnglish", + "description": "Selects the Lucene stemming tokenizer for English that does light stemming." + }, + { + "value": "minimalEnglish", + "name": "MinimalEnglish", + "description": "Selects the Lucene stemming tokenizer for English that does minimal stemming." + }, + { + "value": "possessiveEnglish", + "name": "PossessiveEnglish", + "description": "Selects the Lucene stemming tokenizer for English that removes trailing possessives from words." + }, + { + "value": "porter2", + "name": "Porter2", + "description": "Selects the Lucene stemming tokenizer for English that uses the Porter2 stemming algorithm." + }, + { + "value": "lovins", + "name": "Lovins", + "description": "Selects the Lucene stemming tokenizer for English that uses the Lovins stemming algorithm." + }, + { + "value": "finnish", + "name": "Finnish", + "description": "Selects the Lucene stemming tokenizer for Finnish." + }, + { + "value": "lightFinnish", + "name": "LightFinnish", + "description": "Selects the Lucene stemming tokenizer for Finnish that does light stemming." + }, + { + "value": "french", + "name": "French", + "description": "Selects the Lucene stemming tokenizer for French." + }, + { + "value": "lightFrench", + "name": "LightFrench", + "description": "Selects the Lucene stemming tokenizer for French that does light stemming." + }, + { + "value": "minimalFrench", + "name": "MinimalFrench", + "description": "Selects the Lucene stemming tokenizer for French that does minimal stemming." + }, + { + "value": "galician", + "name": "Galician", + "description": "Selects the Lucene stemming tokenizer for Galician." + }, + { + "value": "minimalGalician", + "name": "MinimalGalician", + "description": "Selects the Lucene stemming tokenizer for Galician that does minimal stemming." + }, + { + "value": "german", + "name": "German", + "description": "Selects the Lucene stemming tokenizer for German." + }, + { + "value": "german2", + "name": "German2", + "description": "Selects the Lucene stemming tokenizer that uses the German variant algorithm." + }, + { + "value": "lightGerman", + "name": "LightGerman", + "description": "Selects the Lucene stemming tokenizer for German that does light stemming." + }, + { + "value": "minimalGerman", + "name": "MinimalGerman", + "description": "Selects the Lucene stemming tokenizer for German that does minimal stemming." + }, + { + "value": "greek", + "name": "Greek", + "description": "Selects the Lucene stemming tokenizer for Greek." + }, + { + "value": "hindi", + "name": "Hindi", + "description": "Selects the Lucene stemming tokenizer for Hindi." + }, + { + "value": "hungarian", + "name": "Hungarian", + "description": "Selects the Lucene stemming tokenizer for Hungarian." + }, + { + "value": "lightHungarian", + "name": "LightHungarian", + "description": "Selects the Lucene stemming tokenizer for Hungarian that does light stemming." + }, + { + "value": "indonesian", + "name": "Indonesian", + "description": "Selects the Lucene stemming tokenizer for Indonesian." + }, + { + "value": "irish", + "name": "Irish", + "description": "Selects the Lucene stemming tokenizer for Irish." + }, + { + "value": "italian", + "name": "Italian", + "description": "Selects the Lucene stemming tokenizer for Italian." + }, + { + "value": "lightItalian", + "name": "LightItalian", + "description": "Selects the Lucene stemming tokenizer for Italian that does light stemming." + }, + { + "value": "sorani", + "name": "Sorani", + "description": "Selects the Lucene stemming tokenizer for Sorani." + }, + { + "value": "latvian", + "name": "Latvian", + "description": "Selects the Lucene stemming tokenizer for Latvian." + }, + { + "value": "norwegian", + "name": "Norwegian", + "description": "Selects the Lucene stemming tokenizer for Norwegian (Bokmål)." + }, + { + "value": "lightNorwegian", + "name": "LightNorwegian", + "description": "Selects the Lucene stemming tokenizer for Norwegian (Bokmål) that does light stemming." + }, + { + "value": "minimalNorwegian", + "name": "MinimalNorwegian", + "description": "Selects the Lucene stemming tokenizer for Norwegian (Bokmål) that does minimal stemming." + }, + { + "value": "lightNynorsk", + "name": "LightNynorsk", + "description": "Selects the Lucene stemming tokenizer for Norwegian (Nynorsk) that does light stemming." + }, + { + "value": "minimalNynorsk", + "name": "MinimalNynorsk", + "description": "Selects the Lucene stemming tokenizer for Norwegian (Nynorsk) that does minimal stemming." + }, + { + "value": "portuguese", + "name": "Portuguese", + "description": "Selects the Lucene stemming tokenizer for Portuguese." + }, + { + "value": "lightPortuguese", + "name": "LightPortuguese", + "description": "Selects the Lucene stemming tokenizer for Portuguese that does light stemming." + }, + { + "value": "minimalPortuguese", + "name": "MinimalPortuguese", + "description": "Selects the Lucene stemming tokenizer for Portuguese that does minimal stemming." + }, + { + "value": "portugueseRslp", + "name": "PortugueseRslp", + "description": "Selects the Lucene stemming tokenizer for Portuguese that uses the RSLP stemming algorithm." + }, + { + "value": "romanian", + "name": "Romanian", + "description": "Selects the Lucene stemming tokenizer for Romanian." + }, + { + "value": "russian", + "name": "Russian", + "description": "Selects the Lucene stemming tokenizer for Russian." + }, + { + "value": "lightRussian", + "name": "LightRussian", + "description": "Selects the Lucene stemming tokenizer for Russian that does light stemming." + }, + { + "value": "spanish", + "name": "Spanish", + "description": "Selects the Lucene stemming tokenizer for Spanish." + }, + { + "value": "lightSpanish", + "name": "LightSpanish", + "description": "Selects the Lucene stemming tokenizer for Spanish that does light stemming." + }, + { + "value": "swedish", + "name": "Swedish", + "description": "Selects the Lucene stemming tokenizer for Swedish." + }, + { + "value": "lightSwedish", + "name": "LightSwedish", + "description": "Selects the Lucene stemming tokenizer for Swedish that does light stemming." + }, + { + "value": "turkish", + "name": "Turkish", + "description": "Selects the Lucene stemming tokenizer for Turkish." + } + ] + }, + "description": "The language to use for a stemmer token filter." + }, + "StemmerTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StemmerTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "language": { + "$ref": "#/definitions/StemmerTokenFilterLanguage", + "description": "The language to use." + } + }, + "required": [ + "language" + ], + "description": "Language specific stemming filter. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters" + } + }, + "StemmerOverrideTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StemmerOverrideTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "rules": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stemming rules in the following format: \"word => stem\", for example: \"ran => run\"." + } + }, + "required": [ + "rules" + ], + "description": "Provides the ability to override other stemming filters with custom dictionary-based stemming. Any dictionary-stemmed terms will be marked as keywords so that they will not be stemmed with stemmers down the chain. Must be placed before any stemming filters. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/StemmerOverrideFilter.html" + } + }, + "StopwordsList": { + "type": "string", + "enum": [ + "arabic", + "armenian", + "basque", + "brazilian", + "bulgarian", + "catalan", + "czech", + "danish", + "dutch", + "english", + "finnish", + "french", + "galician", + "german", + "greek", + "hindi", + "hungarian", + "indonesian", + "irish", + "italian", + "latvian", + "norwegian", + "persian", + "portuguese", + "romanian", + "russian", + "sorani", + "spanish", + "swedish", + "thai", + "turkish" + ], + "x-ms-enum": { + "name": "StopwordsList", + "modelAsString": false, + "values": [ + { + "value": "arabic", + "name": "Arabic", + "description": "Selects the stopword list for Arabic." + }, + { + "value": "armenian", + "name": "Armenian", + "description": "Selects the stopword list for Armenian." + }, + { + "value": "basque", + "name": "Basque", + "description": "Selects the stopword list for Basque." + }, + { + "value": "brazilian", + "name": "Brazilian", + "description": "Selects the stopword list for Portuguese (Brazil)." + }, + { + "value": "bulgarian", + "name": "Bulgarian", + "description": "Selects the stopword list for Bulgarian." + }, + { + "value": "catalan", + "name": "Catalan", + "description": "Selects the stopword list for Catalan." + }, + { + "value": "czech", + "name": "Czech", + "description": "Selects the stopword list for Czech." + }, + { + "value": "danish", + "name": "Danish", + "description": "Selects the stopword list for Danish." + }, + { + "value": "dutch", + "name": "Dutch", + "description": "Selects the stopword list for Dutch." + }, + { + "value": "english", + "name": "English", + "description": "Selects the stopword list for English." + }, + { + "value": "finnish", + "name": "Finnish", + "description": "Selects the stopword list for Finnish." + }, + { + "value": "french", + "name": "French", + "description": "Selects the stopword list for French." + }, + { + "value": "galician", + "name": "Galician", + "description": "Selects the stopword list for Galician." + }, + { + "value": "german", + "name": "German", + "description": "Selects the stopword list for German." + }, + { + "value": "greek", + "name": "Greek", + "description": "Selects the stopword list for Greek." + }, + { + "value": "hindi", + "name": "Hindi", + "description": "Selects the stopword list for Hindi." + }, + { + "value": "hungarian", + "name": "Hungarian", + "description": "Selects the stopword list for Hungarian." + }, + { + "value": "indonesian", + "name": "Indonesian", + "description": "Selects the stopword list for Indonesian." + }, + { + "value": "irish", + "name": "Irish", + "description": "Selects the stopword list for Irish." + }, + { + "value": "italian", + "name": "Italian", + "description": "Selects the stopword list for Italian." + }, + { + "value": "latvian", + "name": "Latvian", + "description": "Selects the stopword list for Latvian." + }, + { + "value": "norwegian", + "name": "Norwegian", + "description": "Selects the stopword list for Norwegian." + }, + { + "value": "persian", + "name": "Persian", + "description": "Selects the stopword list for Persian." + }, + { + "value": "portuguese", + "name": "Portuguese", + "description": "Selects the stopword list for Portuguese." + }, + { + "value": "romanian", + "name": "Romanian", + "description": "Selects the stopword list for Romanian." + }, + { + "value": "russian", + "name": "Russian", + "description": "Selects the stopword list for Russian." + }, + { + "value": "sorani", + "name": "Sorani", + "description": "Selects the stopword list for Sorani." + }, + { + "value": "spanish", + "name": "Spanish", + "description": "Selects the stopword list for Spanish." + }, + { + "value": "swedish", + "name": "Swedish", + "description": "Selects the stopword list for Swedish." + }, + { + "value": "thai", + "name": "Thai", + "description": "Selects the stopword list for Thai." + }, + { + "value": "turkish", + "name": "Turkish", + "description": "Selects the stopword list for Turkish." + } + ] + }, + "description": "Identifies a predefined list of language-specific stopwords." + }, + "StopwordsTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StopwordsTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of stopwords. This property and the stopwords list property cannot both be set." + }, + "stopwordsList": { + "$ref": "#/definitions/StopwordsList", + "default": "english", + "description": "A predefined list of stopwords to use. This property and the stopwords property cannot both be set. Default is English." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to ignore case. If true, all words are converted to lower case first. Default is false." + }, + "removeTrailing": { + "x-ms-client-name": "RemoveTrailingStopWords", + "type": "boolean", + "default": true, + "description": "A value indicating whether to ignore the last search term if it's a stop word. Default is true." + } + }, + "description": "Removes stop words from a token stream. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopFilter.html" + } + }, + "SynonymTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SynonymTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "synonyms": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of synonyms in following one of two formats: 1. incredible, unbelievable, fabulous => amazing - all terms on the left side of => symbol will be replaced with all terms on its right side; 2. incredible, unbelievable, fabulous, amazing - comma separated list of equivalent words. Set the expand option to change how this list is interpreted." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to case-fold input for matching. Default is false." + }, + "expand": { + "type": "boolean", + "default": true, + "description": "A value indicating whether all words in the list of synonyms (if => notation is not used) will map to one another. If true, all words in the list of synonyms (if => notation is not used) will map to one another. The following list: incredible, unbelievable, fabulous, amazing is equivalent to: incredible, unbelievable, fabulous, amazing => incredible, unbelievable, fabulous, amazing. If false, the following list: incredible, unbelievable, fabulous, amazing will be equivalent to: incredible, unbelievable, fabulous, amazing => incredible. Default is true." + } + }, + "required": [ + "synonyms" + ], + "description": "Matches single or multi-word synonyms in a token stream. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/synonym/SynonymFilter.html" + } + }, + "TruncateTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.TruncateTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "length": { + "type": "integer", + "format": "int32", + "default": 300, + "maximum": 300, + "description": "The length at which terms will be truncated. Default and maximum is 300." + } + }, + "description": "Truncates the terms to a specific length. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TruncateTokenFilter.html" + } + }, + "UniqueTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.UniqueTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "onlyOnSamePosition": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to remove duplicates only at the same position. Default is false." + } + }, + "description": "Filters out tokens with same text as the previous token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/RemoveDuplicatesTokenFilter.html" + } + }, + "WordDelimiterTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.WordDelimiterTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "generateWordParts": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to generate part words. If set, causes parts of words to be generated; for example \"AzureSearch\" becomes \"Azure\" \"Search\". Default is true." + }, + "generateNumberParts": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to generate number subwords. Default is true." + }, + "catenateWords": { + "type": "boolean", + "default": false, + "description": "A value indicating whether maximum runs of word parts will be catenated. For example, if this is set to true, \"Azure-Search\" becomes \"AzureSearch\". Default is false." + }, + "catenateNumbers": { + "type": "boolean", + "default": false, + "description": "A value indicating whether maximum runs of number parts will be catenated. For example, if this is set to true, \"1-2\" becomes \"12\". Default is false." + }, + "catenateAll": { + "type": "boolean", + "default": false, + "description": "A value indicating whether all subword parts will be catenated. For example, if this is set to true, \"Azure-Search-1\" becomes \"AzureSearch1\". Default is false." + }, + "splitOnCaseChange": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to split words on caseChange. For example, if this is set to true, \"AzureSearch\" becomes \"Azure\" \"Search\". Default is true." + }, + "preserveOriginal": { + "type": "boolean", + "default": false, + "description": "A value indicating whether original words will be preserved and added to the subword list. Default is false." + }, + "splitOnNumerics": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to split on numbers. For example, if this is set to true, \"Azure1Search\" becomes \"Azure\" \"1\" \"Search\". Default is true." + }, + "stemEnglishPossessive": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to remove trailing \"'s\" for each subword. Default is true." + }, + "protectedWords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of tokens to protect from being delimited." + } + }, + "description": "Splits words into subwords and performs optional transformations on subword groups. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/WordDelimiterFilter.html" + } + }, + "CharFilter": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the char filter." + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Base type for character filters.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "MappingCharFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.MappingCharFilter", + "allOf": [ + { + "$ref": "#/definitions/CharFilter" + } + ], + "properties": { + "mappings": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of mappings of the following format: \"a=>b\" (all occurrences of the character \"a\" will be replaced with character \"b\")." + } + }, + "required": [ + "mappings" + ], + "description": "A character filter that applies mappings defined with the mappings option. Matching is greedy (longest pattern matching at a given point wins). Replacement is allowed to be the empty string. This character filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/charfilter/MappingCharFilter.html" + } + }, + "PatternReplaceCharFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternReplaceCharFilter", + "allOf": [ + { + "$ref": "#/definitions/CharFilter" + } + ], + "properties": { + "pattern": { + "type": "string", + "description": "A regular expression pattern." + }, + "replacement": { + "type": "string", + "description": "The replacement text." + } + }, + "required": [ + "pattern", + "replacement" + ], + "description": "A character filter that replaces characters in the input string. It uses a regular expression to identify character sequences to preserve and a replacement pattern to identify characters to replace. For example, given the input text \"aa bb aa bb\", pattern \"(aa)\\s+(bb)\", and replacement \"$1#$2\", the result would be \"aa#bb aa#bb\". This character filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternReplaceCharFilter.html" + } + }, + "Similarity": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string" + } + }, + "required": [ + "@odata.type" + ], + "description": "Base type for similarity algorithms. Similarity algorithms are used to calculate scores that tie queries to documents. The higher the score, the more relevant the document is to that specific query. Those scores are used to rank the search results.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/index-ranking-similarity" + } + }, + "ClassicSimilarity": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.ClassicSimilarity", + "allOf": [ + { + "$ref": "#/definitions/Similarity" + } + ], + "description": "Legacy similarity algorithm which uses the Lucene TFIDFSimilarity implementation of TF-IDF. This variation of TF-IDF introduces static document length normalization as well as coordinating factors that penalize documents that only partially match the searched queries." + }, + "BM25Similarity": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.BM25Similarity", + "allOf": [ + { + "$ref": "#/definitions/Similarity" + } + ], + "properties": { + "k1": { + "type": "number", + "format": "double", + "description": "This property controls the scaling function between the term frequency of each matching terms and the final relevance score of a document-query pair. By default, a value of 1.2 is used. A value of 0.0 means the score does not scale with an increase in term frequency.", + "x-nullable": true + }, + "b": { + "type": "number", + "format": "double", + "description": "This property controls how the length of a document affects the relevance score. By default, a value of 0.75 is used. A value of 0.0 means no length normalization is applied, while a value of 1.0 means the score is fully normalized by the length of the document.", + "x-nullable": true + } + }, + "description": "Ranking function based on the Okapi BM25 similarity algorithm. BM25 is a TF-IDF-like algorithm that includes length normalization (controlled by the 'b' parameter) as well as term frequency saturation (controlled by the 'k1' parameter)." + }, + "DataSourceCredentials": { + "properties": { + "connectionString": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Data-Source" + }, + "type": "string", + "description": "The connection string for the datasource. Set to '' if you do not want the connection string updated." + } + }, + "description": "Represents credentials that can be used to connect to a datasource." + }, + "SearchIndexerDataContainer": { + "properties": { + "name": { + "type": "string", + "description": "The name of the table or view (for Azure SQL data source) or collection (for CosmosDB data source) that will be indexed." + }, + "query": { + "type": "string", + "description": "A query that is applied to this data container. The syntax and meaning of this parameter is datasource-specific. Not supported by Azure SQL datasources." + } + }, + "required": [ + "name" + ], + "description": "Represents information about the entity (such as Azure SQL table or CosmosDB collection) that will be indexed." + }, + "SearchIndexerDataIdentity": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the identity." + } + }, + "required": [ + "@odata.type" + ], + "description": "Abstract base type for data identities." + }, + "SearchIndexerDataNoneIdentity": { + "description": "Clears the identity property of a datasource.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SearchIndexerDataNoneIdentity", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerDataIdentity" + } + ] + }, + "SearchIndexerDataUserAssignedIdentity": { + "description": "Specifies the identity for a datasource to use.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SearchIndexerDataUserAssignedIdentity", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerDataIdentity" + } + ], + "properties": { + "userAssignedIdentity": { + "type": "string", + "description": "The fully qualified Azure resource Id of a user assigned managed identity typically in the form \"/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId\" that should have been assigned to the search service." + } + }, + "required": [ + "userAssignedIdentity" + ] + }, + "DataChangeDetectionPolicy": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the data change detection policy." + } + }, + "required": [ + "@odata.type" + ], + "description": "Base type for data change detection policies." + }, + "HighWaterMarkChangeDetectionPolicy": { + "description": "Defines a data change detection policy that captures changes based on the value of a high water mark column.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataChangeDetectionPolicy" + } + ], + "properties": { + "highWaterMarkColumnName": { + "type": "string", + "description": "The name of the high water mark column." + } + }, + "required": [ + "highWaterMarkColumnName" + ] + }, + "SqlIntegratedChangeTrackingPolicy": { + "description": "Defines a data change detection policy that captures changes using the Integrated Change Tracking feature of Azure SQL Database.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataChangeDetectionPolicy" + } + ] + }, + "DataDeletionDetectionPolicy": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the data deletion detection policy." + } + }, + "required": [ + "@odata.type" + ], + "description": "Base type for data deletion detection policies." + }, + "SoftDeleteColumnDeletionDetectionPolicy": { + "description": "Defines a data deletion detection policy that implements a soft-deletion strategy. It determines whether an item should be deleted based on the value of a designated 'soft delete' column.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataDeletionDetectionPolicy" + } + ], + "properties": { + "softDeleteColumnName": { + "type": "string", + "description": "The name of the column to use for soft-deletion detection." + }, + "softDeleteMarkerValue": { + "type": "string", + "description": "The marker value that identifies an item as deleted." + } + } + }, + "SearchIndexerDataSourceType": { + "type": "string", + "enum": [ + "azuresql", + "cosmosdb", + "azureblob", + "azuretable", + "mysql", + "adlsgen2" + ], + "x-ms-enum": { + "name": "SearchIndexerDataSourceType", + "modelAsString": true, + "values": [ + { + "value": "azuresql", + "name": "AzureSql", + "description": "Indicates an Azure SQL datasource." + }, + { + "value": "cosmosdb", + "name": "CosmosDb", + "description": "Indicates a CosmosDB datasource." + }, + { + "value": "azureblob", + "name": "AzureBlob", + "description": "Indicates an Azure Blob datasource." + }, + { + "value": "azuretable", + "name": "AzureTable", + "description": "Indicates an Azure Table datasource." + }, + { + "value": "mysql", + "name": "MySql", + "description": "Indicates a MySql datasource." + }, + { + "value": "adlsgen2", + "name": "AdlsGen2", + "description": "Indicates an ADLS Gen2 datasource." + } + ] + }, + "description": "Defines the type of a datasource." + }, + "SearchIndexerDataSource": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the datasource." + }, + "description": { + "type": "string", + "description": "The description of the datasource." + }, + "type": { + "$ref": "#/definitions/SearchIndexerDataSourceType", + "description": "The type of the datasource." + }, + "credentials": { + "$ref": "#/definitions/DataSourceCredentials", + "description": "Credentials for the datasource." + }, + "container": { + "$ref": "#/definitions/SearchIndexerDataContainer", + "description": "The data container for the datasource." + }, + "identity": { + "$ref": "#/definitions/SearchIndexerDataIdentity", + "x-nullable": true, + "description": "An explicit managed identity to use for this datasource. If not specified and the connection string is a managed identity, the system-assigned managed identity is used. If not specified, the value remains unchanged. If \"none\" is specified, the value of this property is cleared." + }, + "dataChangeDetectionPolicy": { + "$ref": "#/definitions/DataChangeDetectionPolicy", + "x-nullable": true, + "description": "The data change detection policy for the datasource." + }, + "dataDeletionDetectionPolicy": { + "$ref": "#/definitions/DataDeletionDetectionPolicy", + "x-nullable": true, + "description": "The data deletion detection policy for the datasource." + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the data source." + }, + "encryptionKey": { + "$ref": "#/definitions/SearchResourceEncryptionKey", + "description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your datasource definition when you want full assurance that no one, not even Microsoft, can decrypt your data source definition in Azure Cognitive Search. Once you have encrypted your data source definition, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your datasource definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.", + "externalDocs": { + "url": "https://aka.ms/azure-search-encryption-with-cmk" + }, + "x-nullable": true + } + }, + "required": [ + "name", + "type", + "credentials", + "container" + ], + "description": "Represents a datasource definition, which can be used to configure an indexer." + }, + "ListDataSourcesResult": { + "properties": { + "value": { + "x-ms-client-name": "DataSources", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndexerDataSource" + }, + "description": "The datasources in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a List Datasources request. If successful, it includes the full definitions of all datasources." + }, + "IndexingSchedule": { + "properties": { + "interval": { + "type": "string", + "format": "duration", + "description": "The interval of time between indexer executions." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The time when an indexer should start running." + } + }, + "required": [ + "interval" + ], + "description": "Represents a schedule for indexer execution." + }, + "IndexingParameters": { + "properties": { + "batchSize": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type." + }, + "maxFailedItems": { + "type": "integer", + "format": "int32", + "default": 0, + "x-nullable": true, + "description": "The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0." + }, + "maxFailedItemsPerBatch": { + "type": "integer", + "format": "int32", + "default": 0, + "x-nullable": true, + "description": "The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0." + }, + "configuration": { + "$ref": "#/definitions/IndexingParametersConfiguration" + } + }, + "description": "Represents parameters for indexer execution.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/create-indexer#parameters" + } + }, + "IndexingParametersConfiguration": { + "type": "object", + "properties": { + "parsingMode": { + "$ref": "#/definitions/ParsingMode" + }, + "excludedFileNameExtensions": { + "type": "string", + "default": "", + "description": "Comma-delimited list of filename extensions to ignore when processing from Azure blob storage. For example, you could exclude \".png, .mp4\" to skip over those files during indexing." + }, + "indexedFileNameExtensions": { + "type": "string", + "default": "", + "description": "Comma-delimited list of filename extensions to select when processing from Azure blob storage. For example, you could focus indexing on specific application files \".docx, .pptx, .msg\" to specifically include those file types." + }, + "failOnUnsupportedContentType": { + "type": "boolean", + "default": false, + "description": "For Azure blobs, set to false if you want to continue indexing when an unsupported content type is encountered, and you don't know all the content types (file extensions) in advance." + }, + "failOnUnprocessableDocument": { + "type": "boolean", + "default": false, + "description": "For Azure blobs, set to false if you want to continue indexing if a document fails indexing." + }, + "indexStorageMetadataOnlyForOversizedDocuments": { + "type": "boolean", + "default": false, + "description": "For Azure blobs, set this property to true to still index storage metadata for blob content that is too large to process. Oversized blobs are treated as errors by default. For limits on blob size, see https://docs.microsoft.com/azure/search/search-limits-quotas-capacity." + }, + "delimitedTextHeaders": { + "type": "string", + "description": "For CSV blobs, specifies a comma-delimited list of column headers, useful for mapping source fields to destination fields in an index." + }, + "delimitedTextDelimiter": { + "type": "string", + "description": "For CSV blobs, specifies the end-of-line single-character delimiter for CSV files where each line starts a new document (for example, \"|\")." + }, + "firstLineContainsHeaders": { + "type": "boolean", + "default": true, + "description": "For CSV blobs, indicates that the first (non-blank) line of each blob contains headers." + }, + "documentRoot": { + "type": "string", + "description": "For JSON arrays, given a structured or semi-structured document, you can specify a path to the array using this property." + }, + "dataToExtract": { + "$ref": "#/definitions/DataToExtract" + }, + "imageAction": { + "$ref": "#/definitions/ImageAction" + }, + "allowSkillsetToReadFileData": { + "type": "boolean", + "default": false, + "description": "If true, will create a path //document//file_data that is an object representing the original file data downloaded from your blob data source. This allows you to pass the original file data to a custom skill for processing within the enrichment pipeline, or to the Document Extraction skill." + }, + "pdfTextRotationAlgorithm": { + "$ref": "#/definitions/PdfTextRotationAlgorithm" + }, + "executionEnvironment": { + "$ref": "#/definitions/ExecutionEnvironment" + }, + "queryTimeout": { + "type": "string", + "default": "00:05:00", + "description": "Increases the timeout beyond the 5-minute default for Azure SQL database data sources, specified in the format \"hh:mm:ss\"." + } + }, + "additionalProperties": { + "type": "object" + }, + "description": "A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/create-indexer#parameters" + } + }, + "ParsingMode": { + "type": "string", + "enum": [ + "default", + "text", + "delimitedText", + "json", + "jsonArray", + "jsonLines" + ], + "x-ms-enum": { + "name": "BlobIndexerParsingMode", + "modelAsString": true, + "values": [ + { + "value": "default", + "name": "Default", + "description": "Set to default for normal file processing." + }, + { + "value": "text", + "name": "Text", + "description": "Set to text to improve indexing performance on plain text files in blob storage." + }, + { + "value": "delimitedText", + "name": "DelimitedText", + "description": "Set to delimitedText when blobs are plain CSV files." + }, + { + "value": "json", + "name": "Json", + "description": "Set to json to extract structured content from JSON files." + }, + { + "value": "jsonArray", + "name": "JsonArray", + "description": "Set to jsonArray to extract individual elements of a JSON array as separate documents in Azure Cognitive Search." + }, + { + "value": "jsonLines", + "name": "JsonLines", + "description": "Set to jsonLines to extract individual JSON entities, separated by a new line, as separate documents in Azure Cognitive Search." + } + ] + }, + "default": "default", + "description": "Represents the parsing mode for indexing from an Azure blob data source." + }, + "DataToExtract": { + "type": "string", + "enum": [ + "storageMetadata", + "allMetadata", + "contentAndMetadata" + ], + "x-ms-enum": { + "name": "BlobIndexerDataToExtract", + "modelAsString": true, + "values": [ + { + "value": "storageMetadata", + "name": "StorageMetadata", + "description": "Indexes just the standard blob properties and user-specified metadata." + }, + { + "value": "allMetadata", + "name": "AllMetadata", + "description": "Extracts metadata provided by the Azure blob storage subsystem and the content-type specific metadata (for example, metadata unique to just .png files are indexed)." + }, + { + "value": "contentAndMetadata", + "name": "ContentAndMetadata", + "description": "Extracts all metadata and textual content from each blob." + } + ] + }, + "default": "contentAndMetadata", + "description": "Specifies the data to extract from Azure blob storage and tells the indexer which data to extract from image content when \"imageAction\" is set to a value other than \"none\". This applies to embedded image content in a .PDF or other application, or image files such as .jpg and .png, in Azure blobs." + }, + "ImageAction": { + "type": "string", + "enum": [ + "none", + "generateNormalizedImages", + "generateNormalizedImagePerPage" + ], + "x-ms-enum": { + "name": "BlobIndexerImageAction", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Ignores embedded images or image files in the data set. This is the default." + }, + { + "value": "generateNormalizedImages", + "name": "GenerateNormalizedImages", + "description": "Extracts text from images (for example, the word \"STOP\" from a traffic stop sign), and embeds it into the content field. This action requires that \"dataToExtract\" is set to \"contentAndMetadata\". A normalized image refers to additional processing resulting in uniform image output, sized and rotated to promote consistent rendering when you include images in visual search results. This information is generated for each image when you use this option." + }, + { + "value": "generateNormalizedImagePerPage", + "name": "GenerateNormalizedImagePerPage", + "description": "Extracts text from images (for example, the word \"STOP\" from a traffic stop sign), and embeds it into the content field, but treats PDF files differently in that each page will be rendered as an image and normalized accordingly, instead of extracting embedded images. Non-PDF file types will be treated the same as if \"generateNormalizedImages\" was set." + } + ] + }, + "default": "none", + "description": "Determines how to process embedded images and image files in Azure blob storage. Setting the \"imageAction\" configuration to any value other than \"none\" requires that a skillset also be attached to that indexer." + }, + "PdfTextRotationAlgorithm": { + "type": "string", + "enum": [ + "none", + "detectAngles" + ], + "x-ms-enum": { + "name": "BlobIndexerPDFTextRotationAlgorithm", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Leverages normal text extraction. This is the default." + }, + { + "value": "detectAngles", + "name": "DetectAngles", + "description": "May produce better and more readable text extraction from PDF files that have rotated text within them. Note that there may be a small performance speed impact when this parameter is used. This parameter only applies to PDF files, and only to PDFs with embedded text. If the rotated text appears within an embedded image in the PDF, this parameter does not apply." + } + ] + }, + "default": "none", + "description": "Determines algorithm for text extraction from PDF files in Azure blob storage." + }, + "ExecutionEnvironment": { + "type": "string", + "enum": [ + "standard", + "private" + ], + "x-ms-enum": { + "name": "IndexerExecutionEnvironment", + "modelAsString": true, + "values": [ + { + "value": "standard", + "name": "standard", + "description": "Indicates that Azure Cognitive Search can determine where the indexer should execute. This is the default environment when nothing is specified and is the recommended value." + }, + { + "value": "private", + "name": "private", + "description": "Indicates that the indexer should run with the environment provisioned specifically for the search service. This should only be specified as the execution environment if the indexer needs to access resources securely over shared private link resources." + } + ] + }, + "default": "standard", + "description": "Specifies the environment in which the indexer should execute." + }, + "FieldMappingFunction": { + "properties": { + "name": { + "type": "string", + "description": "The name of the field mapping function." + }, + "parameters": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "description": "A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type." + } + }, + "required": [ + "name" + ], + "description": "Represents a function that transforms a value from a data source before indexing.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "FieldMapping": { + "properties": { + "sourceFieldName": { + "type": "string", + "description": "The name of the field in the data source." + }, + "targetFieldName": { + "type": "string", + "description": "The name of the target field in the index. Same as the source field name by default." + }, + "mappingFunction": { + "$ref": "#/definitions/FieldMappingFunction", + "x-nullable": true, + "description": "A function to apply to each source field value before indexing." + } + }, + "required": [ + "sourceFieldName" + ], + "description": "Defines a mapping between a field in a data source and a target field in an index.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "SearchIndexer": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the indexer." + }, + "description": { + "type": "string", + "description": "The description of the indexer." + }, + "dataSourceName": { + "type": "string", + "description": "The name of the datasource from which this indexer reads data." + }, + "skillsetName": { + "type": "string", + "description": "The name of the skillset executing with this indexer." + }, + "targetIndexName": { + "type": "string", + "description": "The name of the index to which this indexer writes data." + }, + "schedule": { + "$ref": "#/definitions/IndexingSchedule", + "x-nullable": true, + "description": "The schedule for this indexer." + }, + "parameters": { + "$ref": "#/definitions/IndexingParameters", + "x-nullable": true, + "description": "Parameters for indexer execution." + }, + "fieldMappings": { + "type": "array", + "items": { + "$ref": "#/definitions/FieldMapping" + }, + "description": "Defines mappings between fields in the data source and corresponding target fields in the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "outputFieldMappings": { + "type": "array", + "items": { + "$ref": "#/definitions/FieldMapping" + }, + "description": "Output field mappings are applied after enrichment and immediately before indexing.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "disabled": { + "x-ms-client-name": "IsDisabled", + "type": "boolean", + "default": false, + "x-nullable": true, + "description": "A value indicating whether the indexer is disabled. Default is false." + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the indexer." + }, + "encryptionKey": { + "$ref": "#/definitions/SearchResourceEncryptionKey", + "description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your indexer definition (as well as indexer execution status) when you want full assurance that no one, not even Microsoft, can decrypt them in Azure Cognitive Search. Once you have encrypted your indexer definition, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your indexer definition (and indexer execution status) will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.", + "externalDocs": { + "url": "https://aka.ms/azure-search-encryption-with-cmk" + }, + "x-nullable": true + }, + "cache": { + "$ref": "#/definitions/SearchIndexerCache", + "x-nullable": true, + "description": "Adds caching to an enrichment pipeline to allow for incremental modification steps without having to rebuild the index every time.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/search-howto-incremental-index" + } + } + }, + "required": [ + "name", + "dataSourceName", + "targetIndexName" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Indexer-operations" + }, + "description": "Represents an indexer." + }, + "ListIndexersResult": { + "properties": { + "value": { + "x-ms-client-name": "Indexers", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndexer" + }, + "description": "The indexers in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a List Indexers request. If successful, it includes the full definitions of all indexers." + }, + "SearchIndexerError": { + "properties": { + "key": { + "type": "string", + "readOnly": true, + "description": "The key of the item for which indexing failed." + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "The message describing the error that occurred while processing the item." + }, + "statusCode": { + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The status code indicating why the indexing operation failed. Possible values include: 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the source at which the error originated. For example, this could refer to a particular skill in the attached skillset. This may not be always available." + }, + "details": { + "type": "string", + "readOnly": true, + "description": "Additional, verbose details about the error to assist in debugging the indexer. This may not be always available." + }, + "documentationLink": { + "type": "string", + "readOnly": true, + "description": "A link to a troubleshooting guide for these classes of errors. This may not be always available." + } + }, + "required": [ + "errorMessage", + "statusCode" + ], + "description": "Represents an item- or document-level indexing error." + }, + "SearchIndexerWarning": { + "properties": { + "key": { + "type": "string", + "readOnly": true, + "description": "The key of the item which generated a warning." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The message describing the warning that occurred while processing the item." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the source at which the warning originated. For example, this could refer to a particular skill in the attached skillset. This may not be always available." + }, + "details": { + "type": "string", + "readOnly": true, + "description": "Additional, verbose details about the warning to assist in debugging the indexer. This may not be always available." + }, + "documentationLink": { + "type": "string", + "readOnly": true, + "description": "A link to a troubleshooting guide for these classes of warnings. This may not be always available." + } + }, + "required": [ + "message" + ], + "description": "Represents an item-level warning." + }, + "IndexerExecutionResult": { + "properties": { + "status": { + "$ref": "#/definitions/IndexerExecutionStatus", + "readOnly": true, + "description": "The outcome of this indexer execution." + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "The error message indicating the top-level error, if any." + }, + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The start time of this indexer execution." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true, + "description": "The end time of this indexer execution, if the execution has already completed." + }, + "errors": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndexerError" + }, + "description": "The item-level indexing errors." + }, + "warnings": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndexerWarning" + }, + "description": "The item-level indexing warnings." + }, + "itemsProcessed": { + "x-ms-client-name": "ItemCount", + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The number of items that were processed during this indexer execution. This includes both successfully processed items and items where indexing was attempted but failed." + }, + "itemsFailed": { + "x-ms-client-name": "FailedItemCount", + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The number of items that failed to be indexed during this indexer execution." + }, + "initialTrackingState": { + "type": "string", + "readOnly": true, + "description": "Change tracking state with which an indexer execution started." + }, + "finalTrackingState": { + "type": "string", + "readOnly": true, + "description": "Change tracking state with which an indexer execution finished." + } + }, + "required": [ + "status", + "errors", + "warnings", + "itemsProcessed", + "itemsFailed" + ], + "description": "Represents the result of an individual indexer execution." + }, + "IndexerExecutionStatus": { + "type": "string", + "enum": [ + "transientFailure", + "success", + "inProgress", + "reset" + ], + "x-ms-enum": { + "name": "IndexerExecutionStatus", + "modelAsString": false, + "values": [ + { + "value": "transientFailure", + "name": "TransientFailure", + "description": "An indexer invocation has failed, but the failure may be transient. Indexer invocations will continue per schedule." + }, + { + "value": "success", + "name": "Success", + "description": "Indexer execution completed successfully." + }, + { + "value": "inProgress", + "name": "InProgress", + "description": "Indexer execution is in progress." + }, + { + "value": "reset", + "name": "Reset", + "description": "Indexer has been reset." + } + ] + }, + "x-nullable": false, + "description": "Represents the status of an individual indexer execution." + }, + "SearchIndexerStatus": { + "properties": { + "status": { + "$ref": "#/definitions/IndexerStatus", + "readOnly": true, + "description": "Overall indexer status." + }, + "lastResult": { + "$ref": "#/definitions/IndexerExecutionResult", + "readOnly": true, + "description": "The result of the most recent or an in-progress indexer execution." + }, + "executionHistory": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/IndexerExecutionResult" + }, + "description": "History of the recent indexer executions, sorted in reverse chronological order." + }, + "limits": { + "$ref": "#/definitions/SearchIndexerLimits", + "readOnly": true, + "description": "The execution limits for the indexer." + } + }, + "required": [ + "status", + "executionHistory", + "limits" + ], + "description": "Represents the current status and execution history of an indexer." + }, + "IndexerStatus": { + "type": "string", + "enum": [ + "unknown", + "error", + "running" + ], + "x-ms-enum": { + "name": "IndexerStatus", + "modelAsString": false, + "values": [ + { + "value": "unknown", + "name": "Unknown", + "description": "Indicates that the indexer is in an unknown state." + }, + { + "value": "error", + "name": "Error", + "description": "Indicates that the indexer experienced an error that cannot be corrected without human intervention." + }, + { + "value": "running", + "name": "Running", + "description": "Indicates that the indexer is running normally." + } + ] + }, + "x-nullable": false, + "description": "Represents the overall indexer status." + }, + "SearchIndexerLimits": { + "properties": { + "maxRunTime": { + "type": "string", + "format": "duration", + "readOnly": true, + "description": "The maximum duration that the indexer is permitted to run for one execution." + }, + "maxDocumentExtractionSize": { + "type": "number", + "format": "int64", + "readOnly": true, + "description": "The maximum size of a document, in bytes, which will be considered valid for indexing." + }, + "maxDocumentContentCharactersToExtract": { + "type": "number", + "format": "int64", + "readOnly": true, + "description": "The maximum number of characters that will be extracted from a document picked up for indexing." + } + } + }, + "SearchField": { + "properties": { + "name": { + "type": "string", + "description": "The name of the field, which must be unique within the fields collection of the index or parent field.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + } + }, + "type": { + "$ref": "#/definitions/SearchFieldDataType", + "description": "The data type of the field.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/supported-data-types" + } + }, + "key": { + "type": "boolean", + "description": "A value indicating whether the field uniquely identifies documents in the index. Exactly one top-level field in each index must be chosen as the key field and it must be of type Edm.String. Key fields can be used to look up documents directly and update or delete specific documents. Default is false for simple fields and null for complex fields." + }, + "retrievable": { + "type": "boolean", + "description": "A value indicating whether the field can be returned in a search result. You can disable this option if you want to use a field (for example, margin) as a filter, sorting, or scoring mechanism but do not want the field to be visible to the end user. This property must be true for key fields, and it must be null for complex fields. This property can be changed on existing fields. Enabling this property does not cause any increase in index storage requirements. Default is true for simple fields and null for complex fields." + }, + "searchable": { + "type": "boolean", + "description": "A value indicating whether the field is full-text searchable. This means it will undergo analysis such as word-breaking during indexing. If you set a searchable field to a value like \"sunny day\", internally it will be split into the individual tokens \"sunny\" and \"day\". This enables full-text searches for these terms. Fields of type Edm.String or Collection(Edm.String) are searchable by default. This property must be false for simple fields of other non-string data types, and it must be null for complex fields. Note: searchable fields consume extra space in your index since Azure Cognitive Search will store an additional tokenized version of the field value for full-text searches. If you want to save space in your index and you don't need a field to be included in searches, set searchable to false." + }, + "filterable": { + "type": "boolean", + "description": "A value indicating whether to enable the field to be referenced in $filter queries. filterable differs from searchable in how strings are handled. Fields of type Edm.String or Collection(Edm.String) that are filterable do not undergo word-breaking, so comparisons are for exact matches only. For example, if you set such a field f to \"sunny day\", $filter=f eq 'sunny' will find no matches, but $filter=f eq 'sunny day' will. This property must be null for complex fields. Default is true for simple fields and null for complex fields." + }, + "sortable": { + "type": "boolean", + "description": "A value indicating whether to enable the field to be referenced in $orderby expressions. By default Azure Cognitive Search sorts results by score, but in many experiences users will want to sort by fields in the documents. A simple field can be sortable only if it is single-valued (it has a single value in the scope of the parent document). Simple collection fields cannot be sortable, since they are multi-valued. Simple sub-fields of complex collections are also multi-valued, and therefore cannot be sortable. This is true whether it's an immediate parent field, or an ancestor field, that's the complex collection. Complex fields cannot be sortable and the sortable property must be null for such fields. The default for sortable is true for single-valued simple fields, false for multi-valued simple fields, and null for complex fields." + }, + "facetable": { + "type": "boolean", + "description": "A value indicating whether to enable the field to be referenced in facet queries. Typically used in a presentation of search results that includes hit count by category (for example, search for digital cameras and see hits by brand, by megapixels, by price, and so on). This property must be null for complex fields. Fields of type Edm.GeographyPoint or Collection(Edm.GeographyPoint) cannot be facetable. Default is true for all other simple fields." + }, + "analyzer": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" + }, + "$ref": "#/definitions/LexicalAnalyzerName", + "description": "The name of the analyzer to use for the field. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields.", + "x-nullable": true + }, + "searchAnalyzer": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" + }, + "$ref": "#/definitions/LexicalAnalyzerName", + "description": "The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. This analyzer can be updated on an existing field. Must be null for complex fields.", + "x-nullable": true + }, + "indexAnalyzer": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" + }, + "$ref": "#/definitions/LexicalAnalyzerName", + "description": "The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields.", + "x-nullable": true + }, + "normalizer": { + "externalDocs": { + "url": "https://aka.ms/azs-normalizers" + }, + "$ref": "#/definitions/LexicalNormalizerName", + "description": "The name of the normalizer to use for the field. This option can be used only with fields with filterable, sortable, or facetable enabled. Once the normalizer is chosen, it cannot be changed for the field. Must be null for complex fields.", + "x-nullable": true + }, + "synonymMaps": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Synonym-Map-operations" + }, + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of the names of synonym maps to associate with this field. This option can be used only with searchable fields. Currently only one synonym map per field is supported. Assigning a synonym map to a field ensures that query terms targeting that field are expanded at query-time using the rules in the synonym map. This attribute can be changed on existing fields. Must be null or an empty collection for complex fields." + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchField" + }, + "description": "A list of sub-fields if this is a field of type Edm.ComplexType or Collection(Edm.ComplexType). Must be null or empty for simple fields." + } + }, + "required": [ + "name", + "type" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Index" + }, + "description": "Represents a field in an index definition, which describes the name, data type, and search behavior of a field." + }, + "TextWeights": { + "properties": { + "weights": { + "type": "object", + "additionalProperties": { + "type": "number", + "format": "double", + "x-nullable": false + }, + "description": "The dictionary of per-field weights to boost document scoring. The keys are field names and the values are the weights for each field." + } + }, + "required": [ + "weights" + ], + "description": "Defines weights on index fields for which matches should boost scoring in search queries." + }, + "ScoringFunction": { + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Indicates the type of function to use. Valid values include magnitude, freshness, distance, and tag. The function type must be lower case." + }, + "fieldName": { + "type": "string", + "description": "The name of the field used as input to the scoring function." + }, + "boost": { + "type": "number", + "format": "double", + "description": "A multiplier for the raw score. Must be a positive number not equal to 1.0." + }, + "interpolation": { + "$ref": "#/definitions/ScoringFunctionInterpolation", + "description": "A value indicating how boosting will be interpolated across document scores; defaults to \"Linear\"." + } + }, + "required": [ + "type", + "fieldName", + "boost" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Base type for functions that can modify document scores during ranking." + }, + "DistanceScoringFunction": { + "x-ms-discriminator-value": "distance", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "distance": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/DistanceScoringParameters", + "description": "Parameter values for the distance scoring function." + } + }, + "required": [ + "distance" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores based on distance from a geographic location." + }, + "DistanceScoringParameters": { + "properties": { + "referencePointParameter": { + "type": "string", + "description": "The name of the parameter passed in search queries to specify the reference location." + }, + "boostingDistance": { + "type": "number", + "format": "double", + "description": "The distance in kilometers from the reference location where the boosting range ends." + } + }, + "required": [ + "referencePointParameter", + "boostingDistance" + ], + "description": "Provides parameter values to a distance scoring function." + }, + "FreshnessScoringFunction": { + "x-ms-discriminator-value": "freshness", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "freshness": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/FreshnessScoringParameters", + "description": "Parameter values for the freshness scoring function." + } + }, + "required": [ + "freshness" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores based on the value of a date-time field." + }, + "FreshnessScoringParameters": { + "properties": { + "boostingDuration": { + "type": "string", + "format": "duration", + "description": "The expiration period after which boosting will stop for a particular document." + } + }, + "required": [ + "boostingDuration" + ], + "description": "Provides parameter values to a freshness scoring function." + }, + "MagnitudeScoringFunction": { + "x-ms-discriminator-value": "magnitude", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "magnitude": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/MagnitudeScoringParameters", + "description": "Parameter values for the magnitude scoring function." + } + }, + "required": [ + "magnitude" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores based on the magnitude of a numeric field." + }, + "MagnitudeScoringParameters": { + "properties": { + "boostingRangeStart": { + "type": "number", + "format": "double", + "description": "The field value at which boosting starts." + }, + "boostingRangeEnd": { + "type": "number", + "format": "double", + "description": "The field value at which boosting ends." + }, + "constantBoostBeyondRange": { + "x-ms-client-name": "ShouldBoostBeyondRangeByConstant", + "type": "boolean", + "description": "A value indicating whether to apply a constant boost for field values beyond the range end value; default is false." + } + }, + "required": [ + "boostingRangeStart", + "boostingRangeEnd" + ], + "description": "Provides parameter values to a magnitude scoring function." + }, + "TagScoringFunction": { + "x-ms-discriminator-value": "tag", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "tag": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/TagScoringParameters", + "description": "Parameter values for the tag scoring function." + } + }, + "required": [ + "tag" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores of documents with string values matching a given list of tags." + }, + "TagScoringParameters": { + "properties": { + "tagsParameter": { + "type": "string", + "description": "The name of the parameter passed in search queries to specify the list of tags to compare against the target field." + } + }, + "required": [ + "tagsParameter" + ], + "description": "Provides parameter values to a tag scoring function." + }, + "ScoringFunctionInterpolation": { + "type": "string", + "enum": [ + "linear", + "constant", + "quadratic", + "logarithmic" + ], + "x-ms-enum": { + "name": "ScoringFunctionInterpolation", + "modelAsString": false, + "values": [ + { + "value": "linear", + "name": "Linear", + "description": "Boosts scores by a linearly decreasing amount. This is the default interpolation for scoring functions." + }, + { + "value": "constant", + "name": "Constant", + "description": "Boosts scores by a constant factor." + }, + { + "value": "quadratic", + "name": "Quadratic", + "description": "Boosts scores by an amount that decreases quadratically. Boosts decrease slowly for higher scores, and more quickly as the scores decrease. This interpolation option is not allowed in tag scoring functions." + }, + { + "value": "logarithmic", + "name": "Logarithmic", + "description": "Boosts scores by an amount that decreases logarithmically. Boosts decrease quickly for higher scores, and more slowly as the scores decrease. This interpolation option is not allowed in tag scoring functions." + } + ] + }, + "description": "Defines the function used to interpolate score boosting across a range of documents." + }, + "ScoringProfile": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the scoring profile." + }, + "text": { + "x-ms-client-name": "TextWeights", + "$ref": "#/definitions/TextWeights", + "description": "Parameters that boost scoring based on text matches in certain index fields.", + "x-nullable": true + }, + "functions": { + "type": "array", + "items": { + "$ref": "#/definitions/ScoringFunction" + }, + "description": "The collection of functions that influence the scoring of documents." + }, + "functionAggregation": { + "$ref": "#/definitions/ScoringFunctionAggregation", + "description": "A value indicating how the results of individual scoring functions should be combined. Defaults to \"Sum\". Ignored if there are no scoring functions." + } + }, + "required": [ + "name" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines parameters for a search index that influence scoring in search queries." + }, + "ScoringFunctionAggregation": { + "type": "string", + "enum": [ + "sum", + "average", + "minimum", + "maximum", + "firstMatching" + ], + "x-ms-enum": { + "name": "ScoringFunctionAggregation", + "modelAsString": false, + "values": [ + { + "value": "sum", + "name": "Sum", + "description": "Boost scores by the sum of all scoring function results." + }, + { + "value": "average", + "name": "Average", + "description": "Boost scores by the average of all scoring function results." + }, + { + "value": "minimum", + "name": "Minimum", + "description": "Boost scores by the minimum of all scoring function results." + }, + { + "value": "maximum", + "name": "Maximum", + "description": "Boost scores by the maximum of all scoring function results." + }, + { + "value": "firstMatching", + "name": "FirstMatching", + "description": "Boost scores using the first applicable scoring function in the scoring profile." + } + ] + }, + "description": "Defines the aggregation function used to combine the results of all the scoring functions in a scoring profile." + }, + "CorsOptions": { + "properties": { + "allowedOrigins": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of origins from which JavaScript code will be granted access to your index. Can contain a list of hosts of the form {protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow all origins (not recommended)." + }, + "maxAgeInSeconds": { + "type": "integer", + "format": "int64", + "description": "The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes.", + "x-nullable": true + } + }, + "required": [ + "allowedOrigins" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Index" + }, + "description": "Defines options to control Cross-Origin Resource Sharing (CORS) for an index." + }, + "Suggester": { + "properties": { + "name": { + "type": "string", + "description": "The name of the suggester." + }, + "searchMode": { + "type": "string", + "enum": [ + "analyzingInfixMatching" + ], + "x-ms-enum": { + "name": "SuggesterSearchMode", + "modelAsString": false, + "values": [ + { + "value": "analyzingInfixMatching", + "name": "AnalyzingInfixMatching", + "description": "Matches consecutive whole terms and prefixes in a field. For example, for the field 'The fastest brown fox', the queries 'fast' and 'fastest brow' would both match." + } + ] + }, + "description": "A value indicating the capabilities of the suggester." + }, + "sourceFields": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to which the suggester applies. Each field must be searchable." + } + }, + "required": [ + "name", + "searchMode", + "sourceFields" + ], + "description": "Defines how the Suggest API should apply to a group of fields in the index." + }, + "SearchIndex": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the index." + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchField" + }, + "description": "The fields of the index." + }, + "scoringProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ScoringProfile" + }, + "description": "The scoring profiles for the index." + }, + "defaultScoringProfile": { + "type": "string", + "description": "The name of the scoring profile to use if none is specified in the query. If this property is not set and no scoring profile is specified in the query, then default scoring (tf-idf) will be used." + }, + "corsOptions": { + "$ref": "#/definitions/CorsOptions", + "description": "Options to control Cross-Origin Resource Sharing (CORS) for the index.", + "x-nullable": true + }, + "suggesters": { + "type": "array", + "items": { + "$ref": "#/definitions/Suggester" + }, + "description": "The suggesters for the index." + }, + "analyzers": { + "type": "array", + "items": { + "$ref": "#/definitions/LexicalAnalyzer" + }, + "description": "The analyzers for the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "tokenizers": { + "type": "array", + "items": { + "$ref": "#/definitions/LexicalTokenizer" + }, + "description": "The tokenizers for the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "tokenFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenFilter" + }, + "description": "The token filters for the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "charFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/CharFilter" + }, + "description": "The character filters for the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "normalizers": { + "type": "array", + "items": { + "$ref": "#/definitions/LexicalNormalizer" + }, + "description": "The normalizers for the index.", + "externalDocs": { + "url": "https://aka.ms/azs-custom-normalizers" + } + }, + "encryptionKey": { + "$ref": "#/definitions/SearchResourceEncryptionKey", + "description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.", + "externalDocs": { + "url": "https://aka.ms/azure-search-encryption-with-cmk" + }, + "x-nullable": true + }, + "similarity": { + "$ref": "#/definitions/Similarity", + "description": "The type of similarity algorithm to be used when scoring and ranking the documents matching a search query. The similarity algorithm can only be defined at index creation time and cannot be modified on existing indexes. If null, the ClassicSimilarity algorithm is used.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/index-ranking-similarity" + } + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the index." + } + }, + "required": [ + "name", + "fields" + ], + "description": "Represents a search index definition, which describes the fields and search behavior of an index." + }, + "GetIndexStatisticsResult": { + "properties": { + "documentCount": { + "type": "integer", + "format": "int64", + "x-nullable": false, + "readOnly": true, + "description": "The number of documents in the index." + }, + "storageSize": { + "type": "integer", + "format": "int64", + "x-nullable": false, + "readOnly": true, + "description": "The amount of storage in bytes consumed by the index." + } + }, + "required": [ + "documentCount", + "storageSize" + ], + "description": "Statistics for a given index. Statistics are collected periodically and are not guaranteed to always be up-to-date." + }, + "ListIndexesResult": { + "properties": { + "value": { + "x-ms-client-name": "Indexes", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndex" + }, + "description": "The indexes in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a List Indexes request. If successful, it includes the full definitions of all indexes." + }, + "SearchIndexerSkillset": { + "properties": { + "name": { + "type": "string", + "description": "The name of the skillset." + }, + "description": { + "type": "string", + "description": "The description of the skillset." + }, + "skills": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchIndexerSkill" + }, + "description": "A list of skills in the skillset." + }, + "cognitiveServices": { + "x-ms-client-name": "CognitiveServicesAccount", + "$ref": "#/definitions/CognitiveServicesAccount", + "description": "Details about cognitive services to be used when running skills." + }, + "knowledgeStore": { + "$ref": "#/definitions/SearchIndexerKnowledgeStore", + "description": "Definition of additional projections to azure blob, table, or files, of enriched data." + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the skillset." + }, + "encryptionKey": { + "$ref": "#/definitions/SearchResourceEncryptionKey", + "description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your skillset definition when you want full assurance that no one, not even Microsoft, can decrypt your skillset definition in Azure Cognitive Search. Once you have encrypted your skillset definition, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your skillset definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.", + "externalDocs": { + "url": "https://aka.ms/azure-search-encryption-with-cmk" + }, + "x-nullable": true + } + }, + "required": [ + "name", + "skills" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-tutorial-blob" + }, + "description": "A list of skills." + }, + "CognitiveServicesAccount": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the cognitive service resource attached to a skillset." + }, + "description": { + "type": "string", + "description": "Description of the cognitive service resource attached to a skillset." + } + }, + "required": [ + "@odata.type" + ], + "description": "Base type for describing any cognitive service resource attached to a skillset." + }, + "SearchIndexerKnowledgeStore": { + "properties": { + "storageConnectionString": { + "type": "string", + "description": "The connection string to the storage account projections will be stored in." + }, + "projections": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreProjection", + "x-nullable": false + }, + "description": "A list of additional projections to perform during indexing." + } + }, + "required": [ + "storageConnectionString", + "projections" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/knowledge-store-projection-overview" + }, + "description": "Definition of additional projections to azure blob, table, or files, of enriched data." + }, + "SearchIndexerKnowledgeStoreProjection": { + "properties": { + "tables": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreTableProjectionSelector", + "x-nullable": false + }, + "description": "Projections to Azure Table storage." + }, + "objects": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreObjectProjectionSelector", + "x-nullable": false + }, + "description": "Projections to Azure Blob storage." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreFileProjectionSelector", + "x-nullable": false + }, + "description": "Projections to Azure File storage." + } + }, + "description": "Container object for various projection selectors." + }, + "SearchIndexerKnowledgeStoreProjectionSelector": { + "properties": { + "referenceKeyName": { + "type": "string", + "description": "Name of reference key to different projection." + }, + "generatedKeyName": { + "type": "string", + "description": "Name of generated key to store projection under." + }, + "source": { + "type": "string", + "description": "Source data to project." + }, + "sourceContext": { + "type": "string", + "description": "Source context for complex projections." + }, + "inputs": { + "type": "array", + "items": { + "$ref": "#/definitions/InputFieldMappingEntry" + }, + "description": "Nested inputs for complex projections." + } + }, + "description": "Abstract class to share properties between concrete selectors." + }, + "SearchIndexerKnowledgeStoreBlobProjectionSelector": { + "properties": { + "storageContainer": { + "type": "string", + "description": "Blob container to store projections in." + } + }, + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreProjectionSelector" + } + ], + "required": [ + "storageContainer" + ], + "description": "Abstract class to share properties between concrete selectors." + }, + "SearchIndexerKnowledgeStoreTableProjectionSelector": { + "properties": { + "tableName": { + "type": "string", + "description": "Name of the Azure table to store projected data in." + } + }, + "required": [ + "generatedKeyName", + "tableName" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreProjectionSelector" + } + ], + "description": "Description for what data to store in Azure Tables." + }, + "SearchIndexerKnowledgeStoreObjectProjectionSelector": { + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreBlobProjectionSelector" + } + ], + "description": "Projection definition for what data to store in Azure Blob." + }, + "SearchIndexerKnowledgeStoreFileProjectionSelector": { + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreBlobProjectionSelector" + } + ], + "description": "Projection definition for what data to store in Azure Files." + }, + "DefaultCognitiveServicesAccount": { + "description": "An empty object that represents the default cognitive service resource for a skillset.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.DefaultCognitiveServices", + "allOf": [ + { + "$ref": "#/definitions/CognitiveServicesAccount" + } + ] + }, + "CognitiveServicesAccountKey": { + "description": "A cognitive service resource provisioned with a key that is attached to a skillset.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CognitiveServicesByKey", + "allOf": [ + { + "$ref": "#/definitions/CognitiveServicesAccount" + } + ], + "properties": { + "key": { + "type": "string", + "description": "The key used to provision the cognitive service resource attached to a skillset." + } + }, + "required": [ + "key" + ] + }, + "SearchIndexerSkill": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the skill." + }, + "name": { + "type": "string", + "description": "The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'." + }, + "description": { + "type": "string", + "description": "The description of the skill which describes the inputs, outputs, and usage of the skill." + }, + "context": { + "type": "string", + "description": "Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document." + }, + "inputs": { + "type": "array", + "items": { + "$ref": "#/definitions/InputFieldMappingEntry" + }, + "description": "Inputs of the skills could be a column in the source data set, or the output of an upstream skill." + }, + "outputs": { + "type": "array", + "items": { + "$ref": "#/definitions/OutputFieldMappingEntry" + }, + "description": "The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill." + } + }, + "required": [ + "@odata.type", + "inputs", + "outputs" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-predefined-skills" + }, + "description": "Base type for skills." + }, + "CustomEntity": { + "properties": { + "name": { + "type": "string", + "description": "The top-level entity descriptor. Matches in the skill output will be grouped by this name, and it should represent the \"normalized\" form of the text being found." + }, + "description": { + "type": "string", + "x-nullable": true, + "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." + }, + "type": { + "type": "string", + "x-nullable": true, + "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." + }, + "subtype": { + "type": "string", + "x-nullable": true, + "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." + }, + "id": { + "type": "string", + "x-nullable": true, + "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." + }, + "caseSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to character casing. Sample case insensitive matches of \"Microsoft\" could be: microsoft, microSoft, MICROSOFT." + }, + "accentSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to accent." + }, + "fuzzyEditDistance": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "Defaults to 0. Maximum value of 5. Denotes the acceptable number of divergent characters that would still constitute a match with the entity name. The smallest possible fuzziness for any given match is returned. For instance, if the edit distance is set to 3, \"Windows10\" would still match \"Windows\", \"Windows10\" and \"Windows 7\". When case sensitivity is set to false, case differences do NOT count towards fuzziness tolerance, but otherwise do." + }, + "defaultCaseSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Changes the default case sensitivity value for this entity. It be used to change the default value of all aliases caseSensitive values." + }, + "defaultAccentSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Changes the default accent sensitivity value for this entity. It be used to change the default value of all aliases accentSensitive values." + }, + "defaultFuzzyEditDistance": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "Changes the default fuzzy edit distance value for this entity. It can be used to change the default value of all aliases fuzzyEditDistance values." + }, + "aliases": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomEntityAlias" + }, + "x-nullable": true, + "description": "An array of complex objects that can be used to specify alternative spellings or synonyms to the root entity name." + } + }, + "required": [ + "name" + ], + "description": "An object that contains information about the matches that were found, and related metadata." + }, + "CustomEntityAlias": { + "properties": { + "text": { + "type": "string", + "description": "The text of the alias." + }, + "caseSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Determine if the alias is case sensitive." + }, + "accentSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Determine if the alias is accent sensitive." + }, + "fuzzyEditDistance": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "Determine the fuzzy edit distance of the alias." + } + }, + "required": [ + "text" + ], + "description": "A complex object that can be used to specify alternative spellings or synonyms to the root entity name." + }, + "InputFieldMappingEntry": { + "properties": { + "name": { + "type": "string", + "description": "The name of the input." + }, + "source": { + "type": "string", + "description": "The source of the input." + }, + "sourceContext": { + "type": "string", + "description": "The source context used for selecting recursive inputs." + }, + "inputs": { + "type": "array", + "items": { + "$ref": "#/definitions/InputFieldMappingEntry" + }, + "description": "The recursive inputs used when creating a complex type." + } + }, + "required": [ + "name" + ], + "description": "Input field mapping for a skill." + }, + "OutputFieldMappingEntry": { + "properties": { + "name": { + "type": "string", + "description": "The name of the output defined by the skill." + }, + "targetName": { + "type": "string", + "description": "The target name of the output. It is optional and default to name." + } + }, + "required": [ + "name" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/naming-rules" + }, + "description": "Output field mapping for a skill." + }, + "ConditionalSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Util.ConditionalSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-conditional" + }, + "description": "A skill that enables scenarios that require a Boolean operation to determine the data to assign to an output." + }, + "KeyPhraseExtractionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/KeyPhraseExtractionSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "maxKeyPhraseCount": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "A number indicating how many key phrases to return. If absent, all identified key phrases will be returned." + }, + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-keyphrases" + }, + "description": "A skill that uses text analytics for key phrase extraction." + }, + "OcrSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Vision.OcrSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/OcrSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "detectOrientation": { + "x-ms-client-name": "ShouldDetectOrientation", + "type": "boolean", + "default": false, + "description": "A value indicating to turn orientation detection on or not. Default is false." + }, + "lineEnding": { + "$ref": "#/definitions/OcrSkillLineEnding", + "description": "Defines the sequence of characters to use between the lines of text recognized by the OCR skill. The default value is \"space\"." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-ocr" + }, + "description": "A skill that extracts text from image files." + }, + "ImageAnalysisSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Vision.ImageAnalysisSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/ImageAnalysisSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "visualFeatures": { + "type": "array", + "items": { + "$ref": "#/definitions/VisualFeature", + "x-nullable": false + }, + "description": "A list of visual features." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageDetail", + "x-nullable": false + }, + "description": "A string indicating which domain-specific details to return." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-image-analysis" + }, + "description": "A skill that analyzes image files. It extracts a rich set of visual features based on the image content." + }, + "LanguageDetectionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultCountryHint": { + "type": "string", + "x-nullable": true, + "description": "A country code to use as a hint to the language detection model if it cannot disambiguate the language." + }, + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-language-detection" + }, + "description": "A skill that detects the language of input text and reports a single language code for every document submitted on the request. The language code is paired with a score indicating the confidence of the analysis." + }, + "ShaperSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Util.ShaperSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-shaper" + }, + "description": "A skill for reshaping the outputs. It creates a complex type to support composite fields (also known as multipart fields)." + }, + "MergeSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.MergeSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "insertPreTag": { + "type": "string", + "default": " ", + "description": "The tag indicates the start of the merged text. By default, the tag is an empty space." + }, + "insertPostTag": { + "type": "string", + "default": " ", + "description": "The tag indicates the end of the merged text. By default, the tag is an empty space." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-textmerger" + }, + "description": "A skill for merging two or more strings into a single unified string, with an optional user-defined delimiter separating each component part." + }, + "EntityRecognitionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "categories": { + "type": "array", + "items": { + "$ref": "#/definitions/EntityCategory", + "x-nullable": false + }, + "description": "A list of entity categories that should be extracted." + }, + "defaultLanguageCode": { + "$ref": "#/definitions/EntityRecognitionSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "includeTypelessEntities": { + "type": "boolean", + "x-nullable": true, + "description": "Determines whether or not to include entities which are well known but don't conform to a pre-defined type. If this configuration is not set (default), set to null or set to false, entities which don't conform to one of the pre-defined types will not be surfaced." + }, + "minimumPrecision": { + "type": "number", + "format": "double", + "x-nullable": true, + "description": "A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-entity-recognition" + }, + "description": "Text analytics entity recognition." + }, + "SentimentSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.SentimentSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/SentimentSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-sentiment" + }, + "description": "Text analytics positive-negative sentiment analysis, scored as a floating point value in a range of zero to 1." + }, + "SentimentSkillV3": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.V3.SentimentSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "type": "string", + "x-nullable": true, + "description": "A value indicating which language code to use. Default is en." + }, + "includeOpinionMining": { + "type": "boolean", + "default": false, + "description": "If set to true, the skill output will include information from Text Analytics for opinion mining, namely targets (nouns or verbs) and their associated assessment (adjective) in the text. Default is false." + }, + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-sentiment-v3" + }, + "description": "Using the Text Analytics API, evaluates unstructured text and for each record, provides sentiment labels (such as \"negative\", \"neutral\" and \"positive\") based on the highest confidence score found by the service at a sentence and document-level." + }, + "EntityLinkingSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.V3.EntityLinkingSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "type": "string", + "x-nullable": true, + "description": "A value indicating which language code to use. Default is en." + }, + "minimumPrecision": { + "type": "number", + "format": "double", + "minimum": 0.0, + "maximum": 1.0, + "x-nullable": true, + "description": "A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included." + }, + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-entity-linking-v3" + }, + "description": "Using the Text Analytics API, extracts linked entities from text." + }, + "EntityRecognitionSkillV3": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.V3.EntityRecognitionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "categories": { + "type": "array", + "items": { + "type": "string", + "x-nullable": false + }, + "description": "A list of entity categories that should be extracted." + }, + "defaultLanguageCode": { + "type": "string", + "x-nullable": true, + "description": "A value indicating which language code to use. Default is en." + }, + "minimumPrecision": { + "type": "number", + "format": "double", + "minimum": 0.0, + "maximum": 1.0, + "x-nullable": true, + "description": "A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included." + }, + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-entity-recognition-v3" + }, + "description": "Using the Text Analytics API, extracts entities of different types from text." + }, + "PIIDetectionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.PIIDetectionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "type": "string", + "x-nullable": true, + "description": "A value indicating which language code to use. Default is en." + }, + "minimumPrecision": { + "type": "number", + "format": "double", + "x-nullable": true, + "minimum": 0.0, + "maximum": 1.0, + "description": "A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included." + }, + "maskingMode": { + "$ref": "#/definitions/PIIDetectionSkillMaskingMode", + "description": "A parameter that provides various ways to mask the personal information detected in the input text. Default is 'none'." + }, + "maskingCharacter": { + "type": "string", + "x-nullable": true, + "maxLength": 1, + "description": "The character used to mask the text if the maskingMode parameter is set to replace. Default is '*'." + }, + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary." + }, + "piiCategories": { + "type": "array", + "items": { + "type": "string", + "x-nullable": false + }, + "description": "A list of PII entity categories that should be extracted and masked." + }, + "domain": { + "type": "string", + "x-nullable": true, + "description": "If specified, will set the PII domain to include only a subset of the entity categories. Possible values include: 'phi', 'none'. Default is 'none'." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-pii-detection" + }, + "description": "Using the Text Analytics API, extracts personal information from an input text and gives you the option of masking it." + }, + "SplitSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.SplitSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/SplitSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "textSplitMode": { + "$ref": "#/definitions/TextSplitMode", + "x-nullable": false, + "description": "A value indicating which split mode to perform." + }, + "maximumPageLength": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The desired maximum page length. Default is 10000." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-textsplit" + }, + "description": "A skill to split a string into chunks of text." + }, + "CustomEntityLookupSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.CustomEntityLookupSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/CustomEntityLookupSkillLanguage", + "x-nullable": true, + "description": "A value indicating which language code to use. Default is en." + }, + "entitiesDefinitionUri": { + "type": "string", + "x-nullable": true, + "description": "Path to a JSON or CSV file containing all the target text to match against. This entity definition is read at the beginning of an indexer run. Any updates to this file during an indexer run will not take effect until subsequent runs. This config must be accessible over HTTPS." + }, + "inlineEntitiesDefinition": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomEntity" + }, + "x-nullable": true, + "description": "The inline CustomEntity definition." + }, + "globalDefaultCaseSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "A global flag for CaseSensitive. If CaseSensitive is not set in CustomEntity, this value will be the default value." + }, + "globalDefaultAccentSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "A global flag for AccentSensitive. If AccentSensitive is not set in CustomEntity, this value will be the default value." + }, + "globalDefaultFuzzyEditDistance": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "A global flag for FuzzyEditDistance. If FuzzyEditDistance is not set in CustomEntity, this value will be the default value." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/search/cognitive-search-skill-custom-entity-lookup" + }, + "description": "A skill looks for text from a custom, user-defined list of words and phrases." + }, + "TextTranslationSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.TranslationSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultToLanguageCode": { + "$ref": "#/definitions/TextTranslationSkillLanguage", + "description": "The language code to translate documents into for documents that don't specify the to language explicitly. " + }, + "defaultFromLanguageCode": { + "$ref": "#/definitions/TextTranslationSkillLanguage", + "description": "The language code to translate documents from for documents that don't specify the from language explicitly." + }, + "suggestedFrom": { + "$ref": "#/definitions/TextTranslationSkillLanguage", + "x-nullable": true, + "description": "The language code to translate documents from when neither the fromLanguageCode input nor the defaultFromLanguageCode parameter are provided, and the automatic language detection is unsuccessful. Default is en." + } + }, + "required": [ + "defaultToLanguageCode" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-text-translation" + }, + "description": "A skill to translate text from one language to another." + }, + "DocumentExtractionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Util.DocumentExtractionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "parsingMode": { + "type": "string", + "x-nullable": true, + "description": "The parsingMode for the skill. Will be set to 'default' if not defined." + }, + "dataToExtract": { + "type": "string", + "x-nullable": true, + "description": "The type of data to be extracted for the skill. Will be set to 'contentAndMetadata' if not defined." + }, + "configuration": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "x-nullable": true, + "description": "A dictionary of configurations for the skill." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-document-extraction" + }, + "description": "A skill that extracts content from a file within the enrichment pipeline." + }, + "WebApiSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Custom.WebApiSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "uri": { + "type": "string", + "description": "The url for the Web API." + }, + "httpHeaders": { + "$ref": "#/definitions/WebApiHttpHeaders", + "description": "The headers required to make the http request." + }, + "httpMethod": { + "type": "string", + "description": "The method for the http request." + }, + "timeout": { + "type": "string", + "format": "duration", + "description": "The desired timeout for the request. Default is 30 seconds." + }, + "batchSize": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The desired batch size which indicates number of documents." + }, + "degreeOfParallelism": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "If set, the number of parallel calls that can be made to the Web API." + } + }, + "required": [ + "uri" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-custom-skill-web-api" + }, + "description": "A skill that can call a Web API endpoint, allowing you to extend a skillset by having it call your custom code." + }, + "WebApiHttpHeaders": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "A dictionary of http request headers." + }, + "ListSkillsetsResult": { + "properties": { + "value": { + "x-ms-client-name": "Skillsets", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndexerSkillset" + }, + "description": "The skillsets defined in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a list skillset request. If successful, it includes the full definitions of all skillsets." + }, + "TextSplitMode": { + "type": "string", + "enum": [ + "pages", + "sentences" + ], + "x-ms-enum": { + "name": "TextSplitMode", + "modelAsString": true, + "values": [ + { + "value": "pages", + "name": "Pages", + "description": "Split the text into individual pages." + }, + { + "value": "sentences", + "name": "Sentences", + "description": "Split the text into individual sentences." + } + ] + }, + "description": "A value indicating which split mode to perform." + }, + "VisualFeature": { + "type": "string", + "enum": [ + "adult", + "brands", + "categories", + "description", + "faces", + "objects", + "tags" + ], + "x-ms-enum": { + "name": "VisualFeature", + "modelAsString": true, + "values": [ + { + "value": "adult", + "name": "Adult", + "description": "Visual features recognized as adult persons." + }, + { + "value": "brands", + "name": "Brands", + "description": "Visual features recognized as commercial brands." + }, + { + "value": "categories", + "name": "Categories", + "description": "Categories." + }, + { + "value": "description", + "name": "Description", + "description": "Description." + }, + { + "value": "faces", + "name": "Faces", + "description": "Visual features recognized as people faces." + }, + { + "value": "objects", + "name": "Objects", + "description": "Visual features recognized as objects." + }, + { + "value": "tags", + "name": "Tags", + "description": "Tags." + } + ] + }, + "description": "The strings indicating what visual feature types to return." + }, + "ImageDetail": { + "type": "string", + "enum": [ + "celebrities", + "landmarks" + ], + "x-ms-enum": { + "name": "ImageDetail", + "modelAsString": true, + "values": [ + { + "value": "celebrities", + "name": "Celebrities", + "description": "Details recognized as celebrities." + }, + { + "value": "landmarks", + "name": "Landmarks", + "description": "Details recognized as landmarks." + } + ] + }, + "description": "A string indicating which domain-specific details to return." + }, + "EntityCategory": { + "type": "string", + "enum": [ + "location", + "organization", + "person", + "quantity", + "datetime", + "url", + "email" + ], + "x-ms-enum": { + "name": "EntityCategory", + "modelAsString": true, + "values": [ + { + "value": "location", + "name": "Location", + "description": "Entities describing a physical location." + }, + { + "value": "organization", + "name": "Organization", + "description": "Entities describing an organization." + }, + { + "value": "person", + "name": "Person", + "description": "Entities describing a person." + }, + { + "value": "quantity", + "name": "Quantity", + "description": "Entities describing a quantity." + }, + { + "value": "datetime", + "name": "Datetime", + "description": "Entities describing a date and time." + }, + { + "value": "url", + "name": "Url", + "description": "Entities describing a URL." + }, + { + "value": "email", + "name": "Email", + "description": "Entities describing an email address." + } + ] + }, + "description": "A string indicating what entity categories to return." + }, + "PIIDetectionSkillMaskingMode": { + "type": "string", + "enum": [ + "none", + "replace" + ], + "x-ms-enum": { + "name": "PIIDetectionSkillMaskingMode", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "No masking occurs and the maskedText output will not be returned." + }, + { + "value": "replace", + "name": "Replace", + "description": "Replaces the detected entities with the character given in the maskingCharacter parameter. The character will be repeated to the length of the detected entity so that the offsets will correctly correspond to both the input text as well as the output maskedText." + } + ] + }, + "description": "A string indicating what maskingMode to use to mask the personal information detected in the input text." + }, + "SentimentSkillLanguage": { + "type": "string", + "enum": [ + "da", + "nl", + "en", + "fi", + "fr", + "de", + "el", + "it", + "no", + "pl", + "pt-PT", + "ru", + "es", + "sv", + "tr" + ], + "x-ms-enum": { + "name": "SentimentSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "da", + "description": "Danish" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "el", + "description": "Greek" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "no", + "description": "Norwegian (Bokmaal)" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt-PT", + "description": "Portuguese (Portugal)" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "tr", + "description": "Turkish" + } + ] + }, + "description": "The language codes supported for input text by SentimentSkill." + }, + "KeyPhraseExtractionSkillLanguage": { + "type": "string", + "enum": [ + "da", + "nl", + "en", + "fi", + "fr", + "de", + "it", + "ja", + "ko", + "no", + "pl", + "pt-PT", + "pt-BR", + "ru", + "es", + "sv" + ], + "x-ms-enum": { + "name": "KeyPhraseExtractionSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "da", + "description": "Danish" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "no", + "description": "Norwegian (Bokmaal)" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt-PT", + "description": "Portuguese (Portugal)" + }, + { + "value": "pt-BR", + "description": "Portuguese (Brazil)" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "sv", + "description": "Swedish" + } + ] + }, + "description": "The language codes supported for input text by KeyPhraseExtractionSkill." + }, + "OcrSkillLanguage": { + "type": "string", + "enum": [ + "zh-Hans", + "zh-Hant", + "cs", + "da", + "nl", + "en", + "fi", + "fr", + "de", + "el", + "hu", + "it", + "ja", + "ko", + "nb", + "pl", + "pt", + "ru", + "es", + "sv", + "tr", + "ar", + "ro", + "sr-Cyrl", + "sr-Latn", + "sk" + ], + "x-ms-enum": { + "name": "OcrSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "zh-Hans", + "description": "Chinese-Simplified" + }, + { + "value": "zh-Hant", + "description": "Chinese-Traditional" + }, + { + "value": "cs", + "description": "Czech" + }, + { + "value": "da", + "description": "Danish" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "el", + "description": "Greek" + }, + { + "value": "hu", + "description": "Hungarian" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "nb", + "description": "Norwegian (Bokmaal)" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt", + "description": "Portuguese" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "tr", + "description": "Turkish" + }, + { + "value": "ar", + "description": "Arabic" + }, + { + "value": "ro", + "description": "Romanian" + }, + { + "value": "sr-Cyrl", + "description": "Serbian (Cyrillic, Serbia)" + }, + { + "value": "sr-Latn", + "description": "Serbian (Latin, Serbia)" + }, + { + "value": "sk", + "description": "Slovak" + } + ] + }, + "description": "The language codes supported for input by OcrSkill." + }, + "OcrSkillLineEnding": { + "type": "string", + "enum": [ + "space", + "carriageReturn", + "lineFeed", + "carriageReturnLineFeed" + ], + "x-ms-enum": { + "name": "LineEnding", + "modelAsString": true, + "values": [ + { + "value": "space", + "name": "Space", + "description": "Lines are separated by a single space character." + }, + { + "value": "carriageReturn", + "name": "CarriageReturn", + "description": "Lines are separated by a carriage return ('\\r') character." + }, + { + "value": "lineFeed", + "name": "LineFeed", + "description": "Lines are separated by a single line feed ('\\n') character." + }, + { + "value": "carriageReturnLineFeed", + "name": "CarriageReturnLineFeed", + "description": "Lines are separated by a carriage return and a line feed ('\\r\\n') character." + } + ] + }, + "description": "Defines the sequence of characters to use between the lines of text recognized by the OCR skill. The default value is \"space\"." + }, + "SplitSkillLanguage": { + "type": "string", + "enum": [ + "da", + "de", + "en", + "es", + "fi", + "fr", + "it", + "ko", + "pt" + ], + "x-ms-enum": { + "name": "SplitSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "da", + "description": "Danish" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "pt", + "description": "Portuguese" + } + ] + }, + "description": "The language codes supported for input text by SplitSkill." + }, + "CustomEntityLookupSkillLanguage": { + "type": "string", + "enum": [ + "da", + "de", + "en", + "es", + "fi", + "fr", + "it", + "ko", + "pt" + ], + "x-ms-enum": { + "name": "CustomEntityLookupSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "da", + "description": "Danish" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "pt", + "description": "Portuguese" + } + ] + }, + "description": "The language codes supported for input text by CustomEntityLookupSkill." + }, + "EntityRecognitionSkillLanguage": { + "type": "string", + "enum": [ + "ar", + "cs", + "zh-Hans", + "zh-Hant", + "da", + "nl", + "en", + "fi", + "fr", + "de", + "el", + "hu", + "it", + "ja", + "ko", + "no", + "pl", + "pt-PT", + "pt-BR", + "ru", + "es", + "sv", + "tr" + ], + "x-ms-enum": { + "name": "EntityRecognitionSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "ar", + "description": "Arabic" + }, + { + "value": "cs", + "description": "Czech" + }, + { + "value": "zh-Hans", + "description": "Chinese-Simplified" + }, + { + "value": "zh-Hant", + "description": "Chinese-Traditional" + }, + { + "value": "da", + "description": "Danish" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "el", + "description": "Greek" + }, + { + "value": "hu", + "description": "Hungarian" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "no", + "description": "Norwegian (Bokmaal)" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt-PT", + "description": "Portuguese (Portugal)" + }, + { + "value": "pt-BR", + "description": "Portuguese (Brazil)" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "tr", + "description": "Turkish" + } + ] + }, + "description": "The language codes supported for input text by EntityRecognitionSkill." + }, + "TextTranslationSkillLanguage": { + "type": "string", + "enum": [ + "af", + "ar", + "bn", + "bs", + "bg", + "yue", + "ca", + "zh-Hans", + "zh-Hant", + "hr", + "cs", + "da", + "nl", + "en", + "et", + "fj", + "fil", + "fi", + "fr", + "de", + "el", + "ht", + "he", + "hi", + "mww", + "hu", + "is", + "id", + "it", + "ja", + "sw", + "tlh", + "tlh-Latn", + "tlh-Piqd", + "ko", + "lv", + "lt", + "mg", + "ms", + "mt", + "nb", + "fa", + "pl", + "pt", + "pt-br", + "pt-PT", + "otq", + "ro", + "ru", + "sm", + "sr-Cyrl", + "sr-Latn", + "sk", + "sl", + "es", + "sv", + "ty", + "ta", + "te", + "th", + "to", + "tr", + "uk", + "ur", + "vi", + "cy", + "yua", + "ga", + "kn", + "mi", + "ml", + "pa" + ], + "x-ms-enum": { + "name": "TextTranslationSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "af", + "description": "Afrikaans" + }, + { + "value": "ar", + "description": "Arabic" + }, + { + "value": "bn", + "description": "Bangla" + }, + { + "value": "bs", + "description": "Bosnian (Latin)" + }, + { + "value": "bg", + "description": "Bulgarian" + }, + { + "value": "yue", + "description": "Cantonese (Traditional)" + }, + { + "value": "ca", + "description": "Catalan" + }, + { + "value": "zh-Hans", + "description": "Chinese Simplified" + }, + { + "value": "zh-Hant", + "description": "Chinese Traditional" + }, + { + "value": "hr", + "description": "Croatian" + }, + { + "value": "cs", + "description": "Czech" + }, + { + "value": "da", + "description": "Danish" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "et", + "description": "Estonian" + }, + { + "value": "fj", + "description": "Fijian" + }, + { + "value": "fil", + "description": "Filipino" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "el", + "description": "Greek" + }, + { + "value": "ht", + "description": "Haitian Creole" + }, + { + "value": "he", + "description": "Hebrew" + }, + { + "value": "hi", + "description": "Hindi" + }, + { + "value": "mww", + "description": "Hmong Daw" + }, + { + "value": "hu", + "description": "Hungarian" + }, + { + "value": "is", + "description": "Icelandic" + }, + { + "value": "id", + "description": "Indonesian" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "sw", + "description": "Kiswahili" + }, + { + "value": "tlh", + "description": "Klingon" + }, + { + "value": "tlh-Latn", + "description": "Klingon (Latin script)" + }, + { + "value": "tlh-Piqd", + "description": "Klingon (Klingon script)" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "lv", + "description": "Latvian" + }, + { + "value": "lt", + "description": "Lithuanian" + }, + { + "value": "mg", + "description": "Malagasy" + }, + { + "value": "ms", + "description": "Malay" + }, + { + "value": "mt", + "description": "Maltese" + }, + { + "value": "nb", + "description": "Norwegian" + }, + { + "value": "fa", + "description": "Persian" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt", + "description": "Portuguese" + }, + { + "value": "pt-br", + "description": "Portuguese (Brazil)" + }, + { + "value": "pt-PT", + "description": "Portuguese (Portugal)" + }, + { + "value": "otq", + "description": "Queretaro Otomi" + }, + { + "value": "ro", + "description": "Romanian" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "sm", + "description": "Samoan" + }, + { + "value": "sr-Cyrl", + "description": "Serbian (Cyrillic)" + }, + { + "value": "sr-Latn", + "description": "Serbian (Latin)" + }, + { + "value": "sk", + "description": "Slovak" + }, + { + "value": "sl", + "description": "Slovenian" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "ty", + "description": "Tahitian" + }, + { + "value": "ta", + "description": "Tamil" + }, + { + "value": "te", + "description": "Telugu" + }, + { + "value": "th", + "description": "Thai" + }, + { + "value": "to", + "description": "Tongan" + }, + { + "value": "tr", + "description": "Turkish" + }, + { + "value": "uk", + "description": "Ukrainian" + }, + { + "value": "ur", + "description": "Urdu" + }, + { + "value": "vi", + "description": "Vietnamese" + }, + { + "value": "cy", + "description": "Welsh" + }, + { + "value": "yua", + "description": "Yucatec Maya" + }, + { + "value": "ga", + "description": "Irish" + }, + { + "value": "kn", + "description": "Kannada" + }, + { + "value": "mi", + "description": "Maori" + }, + { + "value": "ml", + "description": "Malayalam" + }, + { + "value": "pa", + "description": "Punjabi" + } + ] + }, + "description": "The language codes supported for input text by TextTranslationSkill." + }, + "ImageAnalysisSkillLanguage": { + "type": "string", + "enum": [ + "en", + "es", + "ja", + "pt", + "zh" + ], + "x-ms-enum": { + "name": "ImageAnalysisSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "en", + "description": "English" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "pt", + "description": "Portuguese" + }, + { + "value": "zh", + "description": "Chinese" + } + ] + }, + "description": "The language codes supported for input by ImageAnalysisSkill." + }, + "SynonymMap": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the synonym map." + }, + "format": { + "type": "string", + "enum": [ + "solr" + ], + "x-ms-enum": { + "name": "SynonymMapFormat", + "modelAsString": false, + "values": [ + { + "value": "solr", + "name": "Solr", + "description": "Selects the SOLR format for synonym maps." + } + ] + }, + "description": "The format of the synonym map. Only the 'solr' format is currently supported." + }, + "synonyms": { + "type": "string", + "description": "A series of synonym rules in the specified synonym map format. The rules must be separated by newlines.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Synonym-Map#SynonymMapFormat" + } + }, + "encryptionKey": { + "$ref": "#/definitions/SearchResourceEncryptionKey", + "description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.", + "externalDocs": { + "url": "https://aka.ms/azure-search-encryption-with-cmk" + }, + "x-nullable": true + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the synonym map." + } + }, + "required": [ + "name", + "format", + "synonyms" + ], + "description": "Represents a synonym map definition." + }, + "ListSynonymMapsResult": { + "properties": { + "value": { + "x-ms-client-name": "SynonymMaps", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SynonymMap" + }, + "description": "The synonym maps in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a List SynonymMaps request. If successful, it includes the full definitions of all synonym maps." + }, + "SearchResourceEncryptionKey": { + "properties": { + "keyVaultKeyName": { + "x-ms-client-name": "keyName", + "type": "string", + "description": "The name of your Azure Key Vault key to be used to encrypt your data at rest." + }, + "keyVaultKeyVersion": { + "x-ms-client-name": "keyVersion", + "type": "string", + "description": "The version of your Azure Key Vault key to be used to encrypt your data at rest." + }, + "keyVaultUri": { + "x-ms-client-name": "vaultUri", + "type": "string", + "description": "The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be https://my-keyvault-name.vault.azure.net." + }, + "accessCredentials": { + "$ref": "#/definitions/AzureActiveDirectoryApplicationCredentials", + "description": "Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead.", + "externalDocs": { + "url": "https://aka.ms/azure-search-msi" + } + }, + "identity": { + "$ref": "#/definitions/SearchIndexerDataIdentity", + "x-nullable": true, + "description": "An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If \"none\" is specified, the value of this property is cleared." + } + }, + "required": [ + "keyVaultKeyName", + "keyVaultKeyVersion", + "keyVaultUri" + ], + "description": "A customer-managed encryption key in Azure Key Vault. Keys that you create and manage can be used to encrypt or decrypt data-at-rest in Azure Cognitive Search, such as indexes and synonym maps." + }, + "SearchIndexerCache": { + "properties": { + "storageConnectionString": { + "type": "string", + "description": "The connection string to the storage account where the cache data will be persisted." + }, + "enableReprocessing": { + "type": "boolean", + "x-nullable": true, + "description": "Specifies whether incremental reprocessing is enabled." + } + } + }, + "AzureActiveDirectoryApplicationCredentials": { + "properties": { + "applicationId": { + "type": "string", + "description": "An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application." + }, + "applicationSecret": { + "type": "string", + "description": "The authentication key of the specified AAD application." + } + }, + "required": [ + "applicationId" + ], + "description": "Credentials of a registered application created for your search service, used for authenticated access to the encryption keys stored in Azure Key Vault." + }, + "ServiceStatistics": { + "properties": { + "counters": { + "$ref": "#/definitions/ServiceCounters", + "description": "Service level resource counters." + }, + "limits": { + "$ref": "#/definitions/ServiceLimits", + "description": "Service level general limits." + } + }, + "required": [ + "counters", + "limits" + ], + "description": "Response from a get service statistics request. If successful, it includes service level counters and limits." + }, + "ServiceCounters": { + "properties": { + "documentCount": { + "x-ms-client-name": "documentCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of documents across all indexes in the service." + }, + "indexesCount": { + "x-ms-client-name": "indexCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of indexes." + }, + "indexersCount": { + "x-ms-client-name": "indexerCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of indexers." + }, + "dataSourcesCount": { + "x-ms-client-name": "dataSourceCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of data sources." + }, + "storageSize": { + "x-ms-client-name": "storageSizeCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total size of used storage in bytes." + }, + "synonymMaps": { + "x-ms-client-name": "synonymMapCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of synonym maps." + }, + "skillsetCount": { + "x-ms-client-name": "skillsetCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of skillsets." + } + }, + "required": [ + "documentCount", + "indexesCount", + "indexersCount", + "dataSourcesCount", + "storageSize", + "synonymMaps" + ], + "description": "Represents service-level resource counters and quotas." + }, + "ServiceLimits": { + "properties": { + "maxFieldsPerIndex": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The maximum allowed fields per index." + }, + "maxFieldNestingDepthPerIndex": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The maximum depth which you can nest sub-fields in an index, including the top-level complex field. For example, a/b/c has a nesting depth of 3." + }, + "maxComplexCollectionFieldsPerIndex": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The maximum number of fields of type Collection(Edm.ComplexType) allowed in an index." + }, + "maxComplexObjectsInCollectionsPerDocument": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The maximum number of objects in complex collections allowed per document." + } + }, + "description": "Represents various service level limits." + }, + "ResourceCounter": { + "properties": { + "usage": { + "type": "integer", + "format": "int64", + "x-nullable": false, + "description": "The resource usage amount." + }, + "quota": { + "type": "integer", + "format": "int64", + "x-nullable": true, + "description": "The resource amount quota." + } + }, + "required": [ + "usage" + ], + "description": "Represents a resource's usage and quota." + }, + "SearchError": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "A human-readable representation of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchError" + }, + "readOnly": true, + "description": "An array of details about specific errors that led to this reported error." + } + }, + "required": [ + "message" + ], + "description": "Describes an error condition for the Azure Cognitive Search API." + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ClientRequestIdParameter": { + "name": "x-ms-client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The tracking ID sent with the request to help with debugging.", + "x-ms-client-request-id": true, + "x-ms-parameter-grouping": { + "name": "request-options" + }, + "x-ms-parameter-location": "method" + }, + "IfMatchParameter": { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.", + "x-ms-parameter-location": "method" + }, + "IfNoneMatchParameter": { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.", + "x-ms-parameter-location": "method" + }, + "PreferHeaderParameter": { + "name": "Prefer", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "return=representation" + ], + "description": "For HTTP PUT requests, instructs the service to return the created/updated resource on success.", + "x-ms-parameter-location": "method" + }, + "EndpointParameter": { + "name": "endpoint", + "in": "path", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "description": "The endpoint URL of the search service.", + "x-ms-parameter-location": "client" + }, + "DisableCacheReprocessingChangeDetectionParameter": { + "name": "disableCacheReprocessingChangeDetection", + "in": "query", + "required": false, + "type": "boolean", + "description": "Disables cache reprocessing change detection.", + "x-ms-parameter-location": "method" + }, + "IgnoreResetRequirementsParameter": { + "name": "ignoreResetRequirements", + "in": "query", + "required": false, + "type": "boolean", + "description": "Ignores cache reset requirements.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/search/data-plane/Azure.Search/readme.go.md b/specification/search/data-plane/Azure.Search/readme.go.md new file mode 100644 index 000000000000..fbf00b58236a --- /dev/null +++ b/specification/search/data-plane/Azure.Search/readme.go.md @@ -0,0 +1,34 @@ +## Go +These settings apply only when `--go` is specified on the command line. +``` yaml $(go) +go: + license-header: MICROSOFT_MIT_NO_VERSION + clear-output-folder: true +``` +### Go multi-api +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2019-05-searchindex + - tag: package-2019-05-searchservice +``` + +### Tag: package-2019-05-searchindex and go + + These settings apply only when `--tag=package-2019-05-searchindex --go` is specified on the command line. + Please also specify `--go-sdk-folder=`. + + ``` yaml $(tag) == 'package-2019-05-searchindex' && $(go) + namespace: searchindex + output-folder: $(go-sdk-folder)/services/search/2019-05-01/$(namespace) + ``` + + + ### Tag: package-2019-05-searchservice and go + + These settings apply only when `--tag=package-2019-05-searchservice --go` is specified on the command line. + Please also specify `--go-sdk-folder=`. + + ``` yaml $(tag) == 'package-2019-05-searchservice' && $(go) + namespace: searchservice + output-folder: $(go-sdk-folder)/services/search/2019-05-01/$(namespace) + ``` diff --git a/specification/search/data-plane/Azure.Search/readme.md b/specification/search/data-plane/Azure.Search/readme.md index 934fd0d2b97d..5d523e1d204d 100644 --- a/specification/search/data-plane/Azure.Search/readme.md +++ b/specification/search/data-plane/Azure.Search/readme.md @@ -1,12 +1,12 @@ # SearchServiceClient and SearchIndexClient - + > see https://aka.ms/autorest This is the AutoRest configuration file for SearchServiceClient and SearchIndexClient. --- -## Getting Started +## Getting Started To build the SDK for SearchServiceClient and SearchIndexClient, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: @@ -19,7 +19,7 @@ To see additional help and options, run: ## Configuration -### Basic Information +### Basic Information These are the global settings for SearchServiceClient and SearchIndexClient. ``` yaml @@ -166,6 +166,24 @@ directive: - RequiredReadOnlyProperties ``` +### Tag: package-2021-04-searchservice-preview + +These settings apply only when `--tag=package-2021-04-searchservice-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2021-04-searchservice-preview' +input-file: +- preview/2021-04-30-Preview/searchservice.json +``` + +### Tag: package-2021-04-searchindex-preview + +These settings apply only when `--tag=package-2021-04-searchindex-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2021-04-searchindex-preview' +input-file: +- preview/2021-04-30-Preview/searchindex.json +``` + ### Tag: package-2020-06-searchservice-preview These settings apply only when `--tag=package-2020-06-searchservice-preview` is specified on the command line. @@ -492,7 +510,7 @@ directive: .replace(/(COSMOS_DB)/g, "COSMOS") ``` -## C# +## C# These settings apply only when `--csharp` is specified on the command line. Please also specify `--csharp-sdks-folder=`. @@ -505,7 +523,7 @@ csharp: clear-output-folder: true output-folder: $(csharp-sdks-folder)/search/Azure.Search/src/Generated -directive: +directive: # TODO: Simplify all the below regexes once we gain the ability to target them at specific files. # Rename the IDocumentsOperations interface and implementation, then make the interface internal so we can version it freely. @@ -676,10 +694,10 @@ directive: - from: source-file-csharp where: $ transform: >- - if ($.includes("class DataSourcesOperations") || $.includes("class IndexersOperations") || + if ($.includes("class DataSourcesOperations") || $.includes("class IndexersOperations") || $.includes("class IndexesOperations") || $.includes("class SynonymMapsOperations") || - $.includes("class SkillsetsOperations")) - + $.includes("class SkillsetsOperations")) + return $. replace( /this.SearchServiceName/g, "Client.SearchServiceName" ). replace( /this.SearchDnsSuffix/g, "Client.SearchDnsSuffix" ). @@ -691,7 +709,7 @@ directive: # that we've had in the Azure Search .NET SDK since it was first released. We've decided to keep the custom behavior of # Field just for .NET for the sake of backward compatibility, but for other languages the client behavior will conform # to the REST API. - # + # # To achieve this, we need to make the generated constructors internal, as well as some of the generated properties. - from: source-file-csharp where: $ @@ -707,7 +725,7 @@ directive: replace( /public (bool\? Facetable { get; set; })/g, "internal $1" ); ``` -## Multi-API/Profile support for AutoRest v3 generators +## Multi-API/Profile support for AutoRest v3 generators AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. @@ -719,6 +737,8 @@ require: $(this-folder)/../../../../profiles/readme.md # all the input files across all versions input-file: + - $(this-folder)/preview/2021-04-30-Preview/searchservice.json + - $(this-folder)/preview/2021-04-30-Preview/searchindex.json - $(this-folder)/preview/2020-06-30-Preview/searchservice.json - $(this-folder)/preview/2020-06-30-Preview/searchindex.json - $(this-folder)/preview/2020-06-30/searchservice.json @@ -730,10 +750,10 @@ input-file: ``` -If there are files that should not be in the `all-api-versions` set, +If there are files that should not be in the `all-api-versions` set, uncomment the `exclude-file` section below and add the file paths. ``` yaml $(tag) == 'all-api-versions' -#exclude-file: +#exclude-file: # - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json ``` diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/CreateOrUpdateSharedPrivateLinkResource.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/CreateOrUpdateSharedPrivateLinkResource.json new file mode 100644 index 000000000000..3e019e38f4a7 --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/CreateOrUpdateSharedPrivateLinkResource.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid", + "sharedPrivateLinkResourceName": "testResource", + "sharedPrivateLinkResource": { + "properties": { + "requestMessage": "please approve", + "groupId": "blob", + "privateLinkResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName", + "resourceRegion": null + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchService/sharedPrivateLinkResources/testResource/operationStatuses/08586060559526078782?api-version=2021-04-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchService/sharedPrivateLinkResources/testResource/operationStatuses/08586060559526078782?api-version=2021-04-01-preview" + } + }, + "200": { + "body": { + "name": "testResource", + "type": "Microsoft.Search/searchServices/sharedPrivateLinkResources", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource", + "properties": { + "requestMessage": "please approve", + "groupId": "blob", + "privateLinkResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName", + "status": "Pending", + "resourceRegion": null + } + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/DeletePrivateEndpointConnection.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/DeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..05a02a0c2cd8 --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/DeletePrivateEndpointConnection.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid", + "privateEndpointConnectionName": "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546", + "name": "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546", + "type": "Microsoft.Search/searchServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Disconnected", + "description": "", + "actionsRequired": "None" + } + } + } + }, + "404": {} + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/DeleteSharedPrivateLinkResource.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/DeleteSharedPrivateLinkResource.json new file mode 100644 index 000000000000..1dc614f3a924 --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/DeleteSharedPrivateLinkResource.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid", + "sharedPrivateLinkResourceName": "testResource" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchService/sharedPrivateLinkResources/testResource/operationStatuses/159c5e07-c829-4896-8aba-a1d4fcc7c89c?api-version=2021-04-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchService/sharedPrivateLinkResources/testResource/operationStatuses/159c5e07-c829-4896-8aba-a1d4fcc7c89c?api-version=2021-04-01-preview" + } + }, + "204": {}, + "404": {} + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/GetPrivateEndpointConnection.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/GetPrivateEndpointConnection.json new file mode 100644 index 000000000000..a737039ad01a --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/GetPrivateEndpointConnection.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid", + "privateEndpointConnectionName": "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546", + "name": "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546", + "type": "Microsoft.Search/searchServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/GetSharedPrivateLinkResource.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/GetSharedPrivateLinkResource.json new file mode 100644 index 000000000000..41c4bc68aa66 --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/GetSharedPrivateLinkResource.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid", + "sharedPrivateLinkResourceName": "testResource" + }, + "responses": { + "200": { + "body": { + "name": "testResource", + "type": "Microsoft.Search/searchServices/sharedPrivateLinkResources", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource", + "properties": { + "requestMessage": "please approve", + "groupId": "blob", + "privateLinkResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName", + "status": "Pending", + "resourceRegion": null + } + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/ListPrivateEndpointConnectionsByService.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/ListPrivateEndpointConnectionsByService.json new file mode 100644 index 000000000000..66f456cec938 --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/ListPrivateEndpointConnectionsByService.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546", + "name": "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546", + "type": "Microsoft.Search/searchServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/ListSharedPrivateLinkResourcesByService.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/ListSharedPrivateLinkResourcesByService.json new file mode 100644 index 000000000000..e2197b6e97a9 --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/ListSharedPrivateLinkResourcesByService.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testResource", + "type": "Microsoft.Search/searchServices/sharedPrivateLinkResources", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource", + "properties": { + "requestMessage": "please approve", + "groupId": "blob", + "privateLinkResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName", + "status": "Pending", + "resourceRegion": null + } + } + ] + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/ListSupportedPrivateLinkResources.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/ListSupportedPrivateLinkResources.json new file mode 100644 index 000000000000..b39932d95052 --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/ListSupportedPrivateLinkResources.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateLinkResources/searchService", + "name": "searchService", + "type": "Microsoft.Search/searchServices/privateLinkResources", + "properties": { + "groupId": "searchService", + "requiredMembers": [ + "searchService" + ], + "requiredZoneNames": [ + "privatelink.search.windows.net" + ], + "shareablePrivateLinkResourceTypes": [ + { + "name": "blob", + "properties": { + "type": "Microsoft.Storage/storageAccounts", + "groupId": "blob", + "description": "Azure Cognitive Search indexers can connect to blobs in Azure Storage for reading data (data source), for writing intermediate results of indexer execution (annotation cache, preview) or for storing any knowledge store projections (preview)" + } + }, + { + "name": "table", + "properties": { + "type": "Microsoft.Storage/storageAccounts", + "groupId": "table", + "description": "Azure Cognitive Search indexers can connect to tables in Azure Storage for reading data (data source), for writing book-keeping information about intermediate results of indexer execution (annotation cache, preview) or for storing any knowledge store projections (preview)" + } + }, + { + "name": "Sql", + "properties": { + "type": "Microsoft.DocumentDB/databaseAccounts", + "groupId": "Sql", + "description": "Azure Cognitive Search indexers can connect to CosmosDB using the SQL head for reading data (data source)." + } + }, + { + "name": "plr", + "properties": { + "type": "Microsoft.Sql/servers", + "groupId": "sqlServer", + "description": "Azure Cognitive Search indexers can connect to AzureSQL databases in a SQL server for reading data (data source)." + } + }, + { + "name": "vault", + "properties": { + "type": "Microsoft.KeyVault/vaults", + "groupId": "vault", + "description": "Azure Cognitive Search can access keys in Azure Key Vault to encrypt search index and synonym map data" + } + }, + { + "name": "plr", + "properties": { + "type": "Microsoft.DBforMySQL/servers", + "groupId": "mysqlServer", + "description": "Azure Cognitive Search indexers can connect to MySQL databases for reading data (data source, preview)." + } + }, + { + "name": "site", + "properties": { + "type": "Microsoft.Web/sites", + "groupId": "sites", + "description": "Azure Cognitive Search indexers can connect to App Services when executing custom web api skills that can be present in a skillset (optional) attached to the indexer." + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCheckNameAvailability.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCheckNameAvailability.json new file mode 100644 index 000000000000..a5775297760f --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCheckNameAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2021-04-01-preview", + "subscriptionId": "subid", + "checkNameAvailabilityInput": { + "name": "mysearchservice", + "type": "searchServices" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "" + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCreateOrUpdateService.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCreateOrUpdateService.json new file mode 100644 index 000000000000..5ee11ff42b45 --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCreateOrUpdateService.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid", + "service": { + "location": "westus", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 3, + "partitionCount": 1, + "hostingMode": "default" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice", + "name": "mysearchservice", + "location": "westus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 3, + "partitionCount": 1, + "status": "provisioning", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "provisioning", + "publicNetworkAccess": "enabled", + "networkRuleSet": { + "ipRules": [], + "bypass": "None" + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Unspecified", + "encryptionComplianceStatus": "Compliant" + }, + "disableLocalAuth": false, + "authOptions": { + "apiKeyOnly": {} + }, + "disabledDataExfiltrationOptions": [] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice", + "name": "mysearchservice", + "location": "westus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 3, + "partitionCount": 1, + "status": "provisioning", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "provisioning", + "publicNetworkAccess": "enabled", + "networkRuleSet": { + "ipRules": [], + "bypass": "None" + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Unspecified", + "encryptionComplianceStatus": "Compliant" + }, + "disableLocalAuth": false, + "authOptions": { + "apiKeyOnly": {} + }, + "disabledDataExfiltrationOptions": [] + } + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCreateOrUpdateServiceAuthOptions.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCreateOrUpdateServiceAuthOptions.json new file mode 100644 index 000000000000..180c8aae432e --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCreateOrUpdateServiceAuthOptions.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid", + "service": { + "location": "westus", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 3, + "partitionCount": 1, + "hostingMode": "default", + "authOptions": { + "aadOrApiKey": { + "aadAuthFailureMode": "http401WithBearerChallenge" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice", + "name": "mysearchservice", + "location": "westus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 3, + "partitionCount": 1, + "status": "provisioning", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "provisioning", + "publicNetworkAccess": "enabled", + "networkRuleSet": { + "ipRules": [], + "bypass": "None" + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Unspecified", + "encryptionComplianceStatus": "Compliant" + }, + "authOptions": { + "aadOrApiKey": { + "aadAuthFailureMode": "http401WithBearerChallenge" + } + }, + "disabledDataExfiltrationOptions": [] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice", + "name": "mysearchservice", + "location": "westus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 3, + "partitionCount": 1, + "status": "provisioning", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "provisioning", + "publicNetworkAccess": "enabled", + "networkRuleSet": { + "ipRules": [], + "bypass": "None" + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Unspecified", + "encryptionComplianceStatus": "Compliant" + }, + "authOptions": { + "aadOrApiKey": { + "aadAuthFailureMode": "http401WithBearerChallenge" + } + }, + "disabledDataExfiltrationOptions": [] + } + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCreateOrUpdateServiceDisableLocalAuth.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCreateOrUpdateServiceDisableLocalAuth.json new file mode 100644 index 000000000000..716410354b82 --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCreateOrUpdateServiceDisableLocalAuth.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid", + "service": { + "location": "westus", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 3, + "partitionCount": 1, + "hostingMode": "default", + "disableLocalAuth": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice", + "name": "mysearchservice", + "location": "westus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 3, + "partitionCount": 1, + "status": "provisioning", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "provisioning", + "publicNetworkAccess": "enabled", + "networkRuleSet": { + "ipRules": [], + "bypass": "None" + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Unspecified", + "encryptionComplianceStatus": "Compliant" + }, + "disableLocalAuth": true, + "authOptions": null, + "disabledDataExfiltrationOptions": [] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice", + "name": "mysearchservice", + "location": "westus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 3, + "partitionCount": 1, + "status": "provisioning", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "provisioning", + "publicNetworkAccess": "enabled", + "networkRuleSet": { + "ipRules": [], + "bypass": "None" + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Unspecified", + "encryptionComplianceStatus": "Compliant" + }, + "disableLocalAuth": true, + "authOptions": null, + "disabledDataExfiltrationOptions": [] + } + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints.json new file mode 100644 index 000000000000..f26fcb384e54 --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid", + "service": { + "location": "westus", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 3, + "partitionCount": 1, + "publicNetworkAccess": "disabled", + "hostingMode": "default" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice", + "name": "mysearchservice", + "location": "westus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 3, + "partitionCount": 1, + "status": "provisioning", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "provisioning", + "publicNetworkAccess": "disabled", + "networkRuleSet": { + "ipRules": [], + "bypass": "None" + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Unspecified", + "encryptionComplianceStatus": "Compliant" + }, + "disableLocalAuth": false, + "authOptions": { + "apiKeyOnly": {} + }, + "disabledDataExfiltrationOptions": [] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice", + "name": "mysearchservice", + "location": "westus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 3, + "partitionCount": 1, + "status": "provisioning", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "provisioning", + "publicNetworkAccess": "disabled", + "networkRuleSet": { + "ipRules": [], + "bypass": "None" + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Unspecified", + "encryptionComplianceStatus": "Compliant" + }, + "disableLocalAuth": false, + "authOptions": { + "apiKeyOnly": {} + }, + "disabledDataExfiltrationOptions": [] + } + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs.json new file mode 100644 index 000000000000..440288fc0f21 --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid", + "service": { + "location": "westus", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 1, + "partitionCount": 1, + "networkRuleSet": { + "ipRules": [ + { + "value": "123.4.5.6" + }, + { + "value": "123.4.6.0/18" + } + ] + }, + "hostingMode": "default" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice", + "name": "mysearchservice", + "location": "westus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 1, + "partitionCount": 1, + "status": "provisioning", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "provisioning", + "publicNetworkAccess": "enabled", + "networkRuleSet": { + "ipRules": [ + { + "value": "123.4.5.6" + }, + { + "value": "123.4.6.0/18" + } + ] + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Unspecified", + "encryptionComplianceStatus": "Compliant" + }, + "disableLocalAuth": false, + "authOptions": { + "apiKeyOnly": {} + }, + "disabledDataExfiltrationOptions": [] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice", + "name": "mysearchservice", + "location": "westus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 1, + "partitionCount": 1, + "status": "provisioning", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "provisioning", + "publicNetworkAccess": "enabled", + "networkRuleSet": { + "ipRules": [ + { + "value": "123.4.5.6" + }, + { + "value": "123.4.6.0/18" + } + ] + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Unspecified", + "encryptionComplianceStatus": "Compliant" + }, + "disableLocalAuth": false, + "authOptions": { + "apiKeyOnly": {} + }, + "disabledDataExfiltrationOptions": [] + } + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCreateOrUpdateServiceWithCmkEnforcement.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCreateOrUpdateServiceWithCmkEnforcement.json new file mode 100644 index 000000000000..bf209a9b459e --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCreateOrUpdateServiceWithCmkEnforcement.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid", + "service": { + "location": "westus", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 3, + "partitionCount": 1, + "hostingMode": "default", + "encryptionWithCmk": { + "enforcement": "Enabled" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice", + "name": "mysearchservice", + "location": "westus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 3, + "partitionCount": 1, + "status": "provisioning", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "provisioning", + "publicNetworkAccess": "enabled", + "networkRuleSet": { + "ipRules": [], + "bypass": "None" + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Enabled", + "encryptionComplianceStatus": "Compliant" + }, + "disableLocalAuth": false, + "authOptions": { + "apiKeyOnly": {} + }, + "disabledDataExfiltrationOptions": [] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice", + "name": "mysearchservice", + "location": "westus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 3, + "partitionCount": 1, + "status": "provisioning", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "provisioning", + "publicNetworkAccess": "enabled", + "networkRuleSet": { + "ipRules": [], + "bypass": "None" + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Enabled", + "encryptionComplianceStatus": "Compliant" + }, + "disableLocalAuth": false, + "authOptions": { + "apiKeyOnly": {} + }, + "disabledDataExfiltrationOptions": [] + } + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCreateOrUpdateServiceWithDataExfiltration.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCreateOrUpdateServiceWithDataExfiltration.json new file mode 100644 index 000000000000..76134f949a68 --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCreateOrUpdateServiceWithDataExfiltration.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid", + "service": { + "location": "westus", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 3, + "partitionCount": 1, + "hostingMode": "default", + "disabledDataExfiltrationOptions": [ + "All" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice", + "name": "mysearchservice", + "location": "westus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 3, + "partitionCount": 1, + "status": "provisioning", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "provisioning", + "publicNetworkAccess": "enabled", + "networkRuleSet": { + "ipRules": [], + "bypass": "None" + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Unspecified", + "encryptionComplianceStatus": "Compliant" + }, + "disableLocalAuth": false, + "authOptions": { + "apiKeyOnly": {} + }, + "disabledDataExfiltrationOptions": [ + "All" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice", + "name": "mysearchservice", + "location": "westus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 3, + "partitionCount": 1, + "status": "provisioning", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "provisioning", + "publicNetworkAccess": "enabled", + "networkRuleSet": { + "ipRules": [], + "bypass": "None" + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Unspecified", + "encryptionComplianceStatus": "Compliant" + }, + "disableLocalAuth": false, + "authOptions": { + "apiKeyOnly": {} + }, + "disabledDataExfiltrationOptions": [ + "All" + ] + } + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCreateOrUpdateServiceWithIdentity.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCreateOrUpdateServiceWithIdentity.json new file mode 100644 index 000000000000..c2fc573c5d5e --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCreateOrUpdateServiceWithIdentity.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid", + "service": { + "location": "westus", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 3, + "partitionCount": 1, + "hostingMode": "default" + }, + "identity": { + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-mi": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice", + "name": "mysearchservice", + "location": "westus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 3, + "partitionCount": 1, + "status": "provisioning", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "provisioning", + "publicNetworkAccess": "enabled", + "networkRuleSet": { + "ipRules": [], + "bypass": "None" + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Unspecified", + "encryptionComplianceStatus": "Compliant" + }, + "disableLocalAuth": false, + "authOptions": { + "apiKeyOnly": {} + }, + "disabledDataExfiltrationOptions": [] + }, + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "9d1e1f18-2122-4988-a11c-878782e40a5c", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-mi": { + "clientId": "cd1dcac8-82dd-45b5-9aed-76795d529f6b", + "principalId": "24e07a75-1286-41e5-a15d-ded85ec3acd7" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice", + "name": "mysearchservice", + "location": "westus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 3, + "partitionCount": 1, + "status": "provisioning", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "provisioning", + "publicNetworkAccess": "enabled", + "networkRuleSet": { + "ipRules": [], + "bypass": "None" + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Unspecified", + "encryptionComplianceStatus": "Compliant" + }, + "disableLocalAuth": false, + "authOptions": { + "apiKeyOnly": {} + }, + "disabledDataExfiltrationOptions": [] + }, + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "9d1e1f18-2122-4988-a11c-878782e40a5c", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-mi": { + "clientId": "cd1dcac8-82dd-45b5-9aed-76795d529f6b", + "principalId": "24e07a75-1286-41e5-a15d-ded85ec3acd7" + } + } + } + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCreateOrUpdateWithSemanticSearch.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCreateOrUpdateWithSemanticSearch.json new file mode 100644 index 000000000000..f9f5496e768d --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCreateOrUpdateWithSemanticSearch.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid", + "service": { + "location": "westus", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 3, + "partitionCount": 1, + "hostingMode": "default", + "semanticSearch": "free" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice", + "name": "mysearchservice", + "location": "westus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 3, + "partitionCount": 1, + "status": "provisioning", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "provisioning", + "publicNetworkAccess": "enabled", + "networkRuleSet": { + "ipRules": [], + "bypass": "None" + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Unspecified", + "encryptionComplianceStatus": "Compliant" + }, + "disableLocalAuth": false, + "authOptions": { + "apiKeyOnly": {} + }, + "disabledDataExfiltrationOptions": [], + "semanticSearch": "free" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice", + "name": "mysearchservice", + "location": "westus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 3, + "partitionCount": 1, + "status": "provisioning", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "provisioning", + "publicNetworkAccess": "enabled", + "networkRuleSet": { + "ipRules": [], + "bypass": "None" + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Unspecified", + "encryptionComplianceStatus": "Compliant" + }, + "disableLocalAuth": false, + "authOptions": { + "apiKeyOnly": {} + }, + "disabledDataExfiltrationOptions": [], + "semanticSearch": "free" + } + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCreateQueryKey.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCreateQueryKey.json new file mode 100644 index 000000000000..66cf74616ce5 --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchCreateQueryKey.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "name": "Query key for browser-based clients", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "Query key for browser-based clients", + "key": "" + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchDeleteQueryKey.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchDeleteQueryKey.json new file mode 100644 index 000000000000..1476d3d3c1ff --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchDeleteQueryKey.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "key": "", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "204": {}, + "404": {} + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchDeleteService.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchDeleteService.json new file mode 100644 index 000000000000..43703d80626b --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchDeleteService.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "204": {}, + "404": {} + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchGetAdminKeys.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchGetAdminKeys.json new file mode 100644 index 000000000000..468d00bbca29 --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchGetAdminKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "primaryKey": "", + "secondaryKey": "" + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchGetService.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchGetService.json new file mode 100644 index 000000000000..5725a0383dda --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchGetService.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice", + "name": "mysearchservice", + "location": "westus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 3, + "partitionCount": 1, + "status": "running", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "succeeded", + "publicNetworkAccess": "enabled", + "networkRuleSet": { + "ipRules": [], + "bypass": "None" + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Unspecified", + "encryptionComplianceStatus": "Compliant" + }, + "disableLocalAuth": false, + "authOptions": { + "apiKeyOnly": {} + }, + "disabledDataExfiltrationOptions": [] + } + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchListQueryKeysBySearchService.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchListQueryKeysBySearchService.json new file mode 100644 index 000000000000..11c1ed7cf2d6 --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchListQueryKeysBySearchService.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Query key for browser-based clients", + "key": "" + }, + { + "name": "Query key for mobile clients", + "key": "" + } + ] + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchListServicesByResourceGroup.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchListServicesByResourceGroup.json new file mode 100644 index 000000000000..b9b6bdc0decd --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchListServicesByResourceGroup.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice", + "name": "mysearchservice", + "location": "westus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 3, + "partitionCount": 1, + "status": "running", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "succeeded", + "publicNetworkAccess": "enabled", + "networkRuleSet": { + "ipRules": [], + "bypass": "None" + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Unspecified", + "encryptionComplianceStatus": "Compliant" + }, + "disableLocalAuth": false, + "authOptions": { + "apiKeyOnly": {} + }, + "disabledDataExfiltrationOptions": [] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice2", + "name": "mysearchservice2", + "location": "eastus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "basic" + }, + "properties": { + "replicaCount": 1, + "partitionCount": 1, + "status": "running", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "succeeded", + "publicNetworkAccess": "enabled", + "networkRuleSet": { + "ipRules": [], + "bypass": "None" + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Unspecified", + "encryptionComplianceStatus": "Compliant" + }, + "disableLocalAuth": false, + "authOptions": { + "apiKeyOnly": {} + }, + "disabledDataExfiltrationOptions": [] + } + } + ] + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchListServicesBySubscription.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchListServicesBySubscription.json new file mode 100644 index 000000000000..504c6049be69 --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchListServicesBySubscription.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2021-04-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice", + "name": "mysearchservice", + "location": "westus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 3, + "partitionCount": 1, + "status": "running", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "succeeded", + "publicNetworkAccess": "enabled", + "networkRuleSet": { + "ipRules": [], + "bypass": "None" + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Unspecified", + "encryptionComplianceStatus": "Compliant" + }, + "disableLocalAuth": false, + "authOptions": { + "apiKeyOnly": {} + }, + "disabledDataExfiltrationOptions": [] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Search/searchServices/mysearchservice2", + "name": "mysearchservice2", + "location": "eastus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app" + }, + "sku": { + "name": "basic" + }, + "properties": { + "replicaCount": 1, + "partitionCount": 1, + "status": "running", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "succeeded", + "publicNetworkAccess": "enabled", + "networkRuleSet": { + "ipRules": [], + "bypass": "None" + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Unspecified", + "encryptionComplianceStatus": "Compliant" + }, + "disableLocalAuth": false, + "authOptions": { + "apiKeyOnly": {} + }, + "disabledDataExfiltrationOptions": [] + } + } + ] + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchRegenerateAdminKey.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchRegenerateAdminKey.json new file mode 100644 index 000000000000..01598a091949 --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchRegenerateAdminKey.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "keyKind": "primary", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "primaryKey": "", + "secondaryKey": "" + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchUpdateService.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchUpdateService.json new file mode 100644 index 000000000000..1606cdbca4c1 --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchUpdateService.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid", + "service": { + "tags": { + "app-name": "My e-commerce app", + "new-tag": "Adding a new tag" + }, + "properties": { + "replicaCount": 2 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice", + "name": "mysearchservice", + "location": "westus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app", + "new-tag": "Adding a new tag" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 2, + "partitionCount": 1, + "status": "provisioning", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "provisioning", + "publicNetworkAccess": "enabled", + "networkRuleSet": { + "ipRules": [], + "bypass": "None" + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Unspecified", + "encryptionComplianceStatus": "Compliant" + }, + "disableLocalAuth": false, + "authOptions": { + "apiKeyOnly": {} + }, + "disabledDataExfiltrationOptions": [] + } + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchUpdateServiceAuthOptions.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchUpdateServiceAuthOptions.json new file mode 100644 index 000000000000..25ff97cd8415 --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchUpdateServiceAuthOptions.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid", + "service": { + "tags": { + "app-name": "My e-commerce app", + "new-tag": "Adding a new tag" + }, + "properties": { + "replicaCount": 2, + "authOptions": { + "aadOrApiKey": { + "aadAuthFailureMode": "http401WithBearerChallenge" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice", + "name": "mysearchservice", + "location": "westus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app", + "new-tag": "Adding a new tag" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 2, + "partitionCount": 1, + "status": "provisioning", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "provisioning", + "publicNetworkAccess": "enabled", + "networkRuleSet": { + "ipRules": [], + "bypass": "None" + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Unspecified", + "encryptionComplianceStatus": "Compliant" + }, + "authOptions": { + "aadOrApiKey": { + "aadAuthFailureMode": "http401WithBearerChallenge" + } + }, + "disabledDataExfiltrationOptions": [] + } + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchUpdateServiceDisableLocalAuth.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchUpdateServiceDisableLocalAuth.json new file mode 100644 index 000000000000..f3b94ad9b79f --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchUpdateServiceDisableLocalAuth.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid", + "service": { + "tags": { + "app-name": "My e-commerce app", + "new-tag": "Adding a new tag" + }, + "properties": { + "replicaCount": 2, + "disableLocalAuth": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice", + "name": "mysearchservice", + "location": "westus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app", + "new-tag": "Adding a new tag" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 2, + "partitionCount": 1, + "status": "provisioning", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "provisioning", + "publicNetworkAccess": "enabled", + "networkRuleSet": { + "ipRules": [], + "bypass": "None" + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Unspecified", + "encryptionComplianceStatus": "Compliant" + }, + "disableLocalAuth": true, + "authOptions": null, + "disabledDataExfiltrationOptions": [] + } + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchUpdateServiceToAllowAccessFromPrivateEndpoints.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchUpdateServiceToAllowAccessFromPrivateEndpoints.json new file mode 100644 index 000000000000..ae960839c6db --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchUpdateServiceToAllowAccessFromPrivateEndpoints.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid", + "service": { + "properties": { + "replicaCount": 1, + "partitionCount": 1, + "publicNetworkAccess": "disabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice", + "name": "mysearchservice", + "location": "westus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app", + "new-tag": "Adding a new tag" + }, + "sku": { + "name": "basic" + }, + "properties": { + "replicaCount": 1, + "partitionCount": 1, + "status": "running", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "succeeded", + "publicNetworkAccess": "disabled", + "networkRuleSet": { + "ipRules": [], + "bypass": "None" + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Unspecified", + "encryptionComplianceStatus": "Compliant" + }, + "disableLocalAuth": false, + "authOptions": { + "apiKeyOnly": {} + }, + "disabledDataExfiltrationOptions": [] + } + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchUpdateServiceToAllowAccessFromPublicCustomIPs.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchUpdateServiceToAllowAccessFromPublicCustomIPs.json new file mode 100644 index 000000000000..740dcba4e7ae --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchUpdateServiceToAllowAccessFromPublicCustomIPs.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid", + "service": { + "properties": { + "replicaCount": 3, + "partitionCount": 1, + "publicNetworkAccess": "enabled", + "networkRuleSet": { + "ipRules": [ + { + "value": "123.4.5.6" + }, + { + "value": "123.4.6.0/18" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice", + "name": "mysearchservice", + "location": "westus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app", + "new-tag": "Adding a new tag" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 3, + "partitionCount": 1, + "status": "running", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "succeeded", + "publicNetworkAccess": "enabled", + "networkRuleSet": { + "ipRules": [ + { + "value": "10.2.3.4" + } + ] + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Unspecified", + "encryptionComplianceStatus": "Compliant" + }, + "disableLocalAuth": false, + "authOptions": { + "apiKeyOnly": {} + }, + "disabledDataExfiltrationOptions": [] + } + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchUpdateServiceToRemoveIdentity.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchUpdateServiceToRemoveIdentity.json new file mode 100644 index 000000000000..426e7487dc5a --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchUpdateServiceToRemoveIdentity.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid", + "service": { + "sku": { + "name": "standard" + }, + "identity": { + "type": "None" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice", + "name": "mysearchservice", + "location": "westus", + "type": "Microsoft.Search/searchServices", + "tags": {}, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 3, + "partitionCount": 1, + "status": "running", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "succeeded", + "publicNetworkAccess": "enabled", + "networkRuleSet": { + "ipRules": [], + "bypass": "None" + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Unspecified", + "encryptionComplianceStatus": "Compliant" + }, + "disableLocalAuth": false, + "authOptions": { + "apiKeyOnly": {} + }, + "disabledDataExfiltrationOptions": [] + } + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchUpdateServiceWithCmkEnforcement.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchUpdateServiceWithCmkEnforcement.json new file mode 100644 index 000000000000..185aa688b15a --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchUpdateServiceWithCmkEnforcement.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid", + "service": { + "tags": { + "app-name": "My e-commerce app", + "new-tag": "Adding a new tag" + }, + "properties": { + "replicaCount": 2, + "encryptionWithCmk": { + "enforcement": "Enabled" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice", + "name": "mysearchservice", + "location": "westus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app", + "new-tag": "Adding a new tag" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 2, + "partitionCount": 1, + "status": "provisioning", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "provisioning", + "publicNetworkAccess": "enabled", + "networkRuleSet": { + "ipRules": [], + "bypass": "None" + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Enabled", + "encryptionComplianceStatus": "Compliant" + }, + "disableLocalAuth": false, + "authOptions": { + "apiKeyOnly": {} + }, + "disabledDataExfiltrationOptions": [] + } + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchUpdateServiceWithDataExfiltration.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchUpdateServiceWithDataExfiltration.json new file mode 100644 index 000000000000..a705c7ca7f2a --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchUpdateServiceWithDataExfiltration.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid", + "service": { + "tags": { + "app-name": "My e-commerce app", + "new-tag": "Adding a new tag" + }, + "properties": { + "replicaCount": 2, + "disabledDataExfiltrationOptions": [ + "All" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice", + "name": "mysearchservice", + "location": "westus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app", + "new-tag": "Adding a new tag" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 2, + "partitionCount": 1, + "status": "provisioning", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "provisioning", + "publicNetworkAccess": "enabled", + "networkRuleSet": { + "ipRules": [], + "bypass": "None" + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Unspecified", + "encryptionComplianceStatus": "Compliant" + }, + "disableLocalAuth": false, + "authOptions": { + "apiKeyOnly": {} + }, + "disabledDataExfiltrationOptions": [ + "All" + ] + } + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchUpdateServiceWithSemanticSearch.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchUpdateServiceWithSemanticSearch.json new file mode 100644 index 000000000000..ec1cb7195d79 --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/SearchUpdateServiceWithSemanticSearch.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid", + "service": { + "tags": { + "app-name": "My e-commerce app", + "new-tag": "Adding a new tag" + }, + "properties": { + "replicaCount": 2, + "semanticSearch": "standard" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice", + "name": "mysearchservice", + "location": "westus", + "type": "Microsoft.Search/searchServices", + "tags": { + "app-name": "My e-commerce app", + "new-tag": "Adding a new tag" + }, + "sku": { + "name": "standard" + }, + "properties": { + "replicaCount": 2, + "partitionCount": 1, + "status": "provisioning", + "statusDetails": "", + "hostingMode": "default", + "provisioningState": "provisioning", + "publicNetworkAccess": "enabled", + "networkRuleSet": { + "ipRules": [], + "bypass": "None" + }, + "privateEndpointConnections": [], + "sharedPrivateLinkResources": [], + "encryptionWithCmk": { + "enforcement": "Unspecified", + "encryptionComplianceStatus": "Compliant" + }, + "disableLocalAuth": false, + "authOptions": { + "apiKeyOnly": {} + }, + "disabledDataExfiltrationOptions": [], + "semanticSearch": "standard" + } + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/UpdatePrivateEndpointConnection.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/UpdatePrivateEndpointConnection.json new file mode 100644 index 000000000000..b3741f006c9c --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/examples/UpdatePrivateEndpointConnection.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "searchServiceName": "mysearchservice", + "resourceGroupName": "rg1", + "api-version": "2021-04-01-preview", + "subscriptionId": "subid", + "privateEndpointConnectionName": "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546", + "privateEndpointConnection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Rejected", + "description": "Rejected for some reason" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546", + "name": "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546", + "type": "Microsoft.Search/searchServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Rejected", + "description": "Rejected for some reason", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/search.json b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/search.json new file mode 100644 index 000000000000..e2a214bf348d --- /dev/null +++ b/specification/search/resource-manager/Microsoft.Search/preview/2021-04-01-preview/search.json @@ -0,0 +1,2680 @@ +{ + "swagger": "2.0", + "info": { + "title": "SearchManagementClient", + "description": "Client that can be used to manage Azure Cognitive Search services and API keys.", + "version": "2021-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Search/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available REST API operations of the Microsoft.Search provider.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of operations.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Operations API failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys": { + "post": { + "tags": [ + "AdminKeys" + ], + "operationId": "AdminKeys_Get", + "x-ms-examples": { + "SearchGetAdminKeys": { + "$ref": "./examples/SearchGetAdminKeys.json" + } + }, + "description": "Gets the primary and secondary admin API keys for the specified Azure Cognitive Search service.", + "externalDocs": { + "url": "https://aka.ms/search-manage" + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SearchServiceNameParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The admin keys were successfully retrieved and are in the response. You can use either the primary or secondary key as the value of the 'api-key' parameter in the Azure Cognitive Search Service REST API or SDK to perform any operations on your search service, including privileged operations. Privileged operations include managing resources like indexes and data sources as well as uploading, modifying, or deleting data in your indexes.", + "schema": { + "$ref": "#/definitions/AdminKeyResult" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, or search service could not be found. HTTP 409 (Conflict): The specified subscription is disabled.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/regenerateAdminKey/{keyKind}": { + "post": { + "tags": [ + "AdminKeys" + ], + "operationId": "AdminKeys_Regenerate", + "x-ms-examples": { + "SearchRegenerateAdminKey": { + "$ref": "./examples/SearchRegenerateAdminKey.json" + } + }, + "description": "Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.", + "externalDocs": { + "url": "https://aka.ms/search-manage" + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SearchServiceNameParameter" + }, + { + "name": "keyKind", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "primary", + "secondary" + ], + "x-ms-enum": { + "name": "AdminKeyKind", + "modelAsString": false, + "values": [ + { + "value": "primary", + "name": "Primary", + "description": "The primary API key for the search service." + }, + { + "value": "secondary", + "name": "Secondary", + "description": "The secondary API key for the search service." + } + ] + }, + "description": "Specifies which key to regenerate. Valid values include 'primary' and 'secondary'." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The specified admin key was successfully regenerated. Both admin keys are included in the response, including the newly-regenerated key.", + "schema": { + "$ref": "#/definitions/AdminKeyResult" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, or search service could not be found. HTTP 409 (Conflict): The specified subscription is disabled.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/createQueryKey/{name}": { + "post": { + "tags": [ + "QueryKeys" + ], + "operationId": "QueryKeys_Create", + "x-ms-examples": { + "SearchCreateQueryKey": { + "$ref": "./examples/SearchCreateQueryKey.json" + } + }, + "description": "Generates a new query key for the specified search service. You can create up to 50 query keys per service.", + "externalDocs": { + "url": "https://aka.ms/search-manage" + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SearchServiceNameParameter" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the new query API key." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The query key was successfully created and is in the response. You can use the query key as the value of the 'api-key' parameter in the Azure Cognitive Search Service REST API or SDK to perform read-only operations on your Search indexes such as querying and looking up documents by ID.", + "schema": { + "$ref": "#/definitions/QueryKey" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, or search service could not be found. HTTP 409 (Conflict): The specified subscription is disabled.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listQueryKeys": { + "post": { + "tags": [ + "QueryKeys" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "operationId": "QueryKeys_ListBySearchService", + "x-ms-examples": { + "SearchListQueryKeysBySearchService": { + "$ref": "./examples/SearchListQueryKeysBySearchService.json" + } + }, + "description": "Returns the list of query API keys for the given Azure Cognitive Search service.", + "externalDocs": { + "url": "https://aka.ms/search-manage" + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SearchServiceNameParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "All query keys for the given search service were successfully retrieved and are in the response. You can use any of the query keys as the value of the 'api-key' parameter in the Azure Cognitive Search Service REST API or SDK to perform read-only operations on your Search indexes such as querying and looking up documents by ID.", + "schema": { + "$ref": "#/definitions/ListQueryKeysResult" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, or search service could not be found. HTTP 409 (Conflict): The specified subscription is disabled.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/deleteQueryKey/{key}": { + "delete": { + "tags": [ + "QueryKeys" + ], + "operationId": "QueryKeys_Delete", + "x-ms-examples": { + "SearchDeleteQueryKey": { + "$ref": "./examples/SearchDeleteQueryKey.json" + } + }, + "description": "Deletes the specified query key. Unlike admin keys, query keys are not regenerated. The process for regenerating a query key is to delete and then recreate it.", + "externalDocs": { + "url": "https://aka.ms/search-manage" + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SearchServiceNameParameter" + }, + { + "name": "key", + "in": "path", + "required": true, + "type": "string", + "description": "The query key to be deleted. Query keys are identified by value, not by name." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The query key was successfully deleted." + }, + "204": { + "description": "The query key was successfully deleted." + }, + "404": { + "description": "The subscription, resource group, search service, or query key could not be found." + }, + "default": { + "description": "HTTP 409 (Conflict): The specified subscription is disabled.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}": { + "put": { + "tags": [ + "Services" + ], + "operationId": "Services_CreateOrUpdate", + "x-ms-examples": { + "SearchCreateOrUpdateService": { + "$ref": "./examples/SearchCreateOrUpdateService.json" + }, + "SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs": { + "$ref": "./examples/SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs.json" + }, + "SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints": { + "$ref": "./examples/SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints.json" + }, + "SearchCreateOrUpdateServiceWithIdentity": { + "$ref": "./examples/SearchCreateOrUpdateServiceWithIdentity.json" + }, + "SearchCreateOrUpdateServiceAuthOptions": { + "$ref": "./examples/SearchCreateOrUpdateServiceAuthOptions.json" + }, + "SearchCreateOrUpdateServiceDisableLocalAuth": { + "$ref": "./examples/SearchCreateOrUpdateServiceDisableLocalAuth.json" + }, + "SearchCreateOrUpdateServiceWithCmkEnforcement": { + "$ref": "./examples/SearchCreateOrUpdateServiceWithCmkEnforcement.json" + }, + "SearchCreateOrUpdateServiceWithDataExfiltration": { + "$ref": "./examples/SearchCreateOrUpdateServiceWithDataExfiltration.json" + }, + "SearchCreateOrUpdateWithSemanticSearch": { + "$ref": "./examples/SearchCreateOrUpdateWithSemanticSearch.json" + } + }, + "description": "Creates or updates a search service in the given resource group. If the search service already exists, all properties will be updated with the given values.", + "externalDocs": { + "url": "https://aka.ms/search-manage" + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "searchServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure Cognitive Search service to create or update. Search service names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in length. Search service names must be globally unique since they are part of the service URI (https://.search.windows.net). You cannot change the service name after the service is created." + }, + { + "name": "service", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchService" + }, + "description": "The definition of the search service to create or update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The existing service definition was successfully updated. If you changed the number of replicas or partitions, the scale operation will happen asynchronously. You can periodically get your service definition and monitor progress via the provisioningState property.", + "schema": { + "$ref": "#/definitions/SearchService" + } + }, + "201": { + "description": "If you requested creation of a free search service, the service is now provisioned and ready to use, subject to DNS propagation delay. For other SKU types, provisioning happens asynchronously. You can periodically get your service definition and monitor progress via the provisioningState property.", + "schema": { + "$ref": "#/definitions/SearchService" + } + }, + "default": { + "description": "HTTP 400 (Bad Request): The given service name or service definition is invalid; See the error code and message in the response for details. HTTP 404 (Not Found): The subscription or resource group could not be found. HTTP 409 (Conflict): The specified subscription is disabled.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Services" + ], + "operationId": "Services_Update", + "x-ms-examples": { + "SearchUpdateService": { + "$ref": "./examples/SearchUpdateService.json" + }, + "SearchUpdateServiceToRemoveIdentity": { + "$ref": "./examples/SearchUpdateServiceToRemoveIdentity.json" + }, + "SearchUpdateServiceToAllowAccessFromPublicCustomIPs": { + "$ref": "./examples/SearchUpdateServiceToAllowAccessFromPublicCustomIPs.json" + }, + "SearchUpdateServiceToAllowAccessFromPrivateEndpoints": { + "$ref": "./examples/SearchUpdateServiceToAllowAccessFromPrivateEndpoints.json" + }, + "SearchUpdateServiceAuthOptions": { + "$ref": "./examples/SearchUpdateServiceAuthOptions.json" + }, + "SearchUpdateServiceDisableLocalAuth": { + "$ref": "./examples/SearchUpdateServiceDisableLocalAuth.json" + }, + "SearchUpdateServiceWithCmkEnforcement": { + "$ref": "./examples/SearchUpdateServiceWithCmkEnforcement.json" + }, + "SearchUpdateServiceWithDataExfiltration": { + "$ref": "./examples/SearchUpdateServiceWithDataExfiltration.json" + }, + "SearchUpdateServiceWithSemanticSearch": { + "$ref": "./examples/SearchUpdateServiceWithSemanticSearch.json" + } + }, + "description": "Updates an existing search service in the given resource group.", + "externalDocs": { + "url": "https://aka.ms/search-manage" + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "searchServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure Cognitive Search service to update." + }, + { + "name": "service", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchServiceUpdate" + }, + "description": "The definition of the search service to update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The existing service definition was successfully updated. If you changed the number of replicas or partitions, the scale operation will happen asynchronously. You can periodically get your service definition and monitor progress via the provisioningState property.", + "schema": { + "$ref": "#/definitions/SearchService" + } + }, + "default": { + "description": "HTTP 400 (Bad Request): The given service definition is invalid or you attempted to change a property that is immutable; See the error code and message in the response for details. HTTP 404 (Not Found): The subscription or resource group could not be found. HTTP 409 (Conflict): The specified subscription is disabled.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "Services" + ], + "operationId": "Services_Get", + "x-ms-examples": { + "SearchGetService": { + "$ref": "./examples/SearchGetService.json" + } + }, + "description": "Gets the search service with the given name in the given resource group.", + "externalDocs": { + "url": "https://aka.ms/search-manage" + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SearchServiceNameParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The search service definition was successfully retrieved and is in the response. If you are polling for the completion of a provisioning or scale operation, you can check its status via the provisioningState property.", + "schema": { + "$ref": "#/definitions/SearchService" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, or search service name could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "Services" + ], + "operationId": "Services_Delete", + "x-ms-examples": { + "SearchDeleteService": { + "$ref": "./examples/SearchDeleteService.json" + } + }, + "description": "Deletes a search service in the given resource group, along with its associated resources.", + "externalDocs": { + "url": "https://aka.ms/search-manage" + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SearchServiceNameParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The search service was successfully deleted." + }, + "204": { + "description": "The search service was successfully deleted." + }, + "404": { + "description": "The subscription, resource group, or search service could not be found." + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices": { + "get": { + "tags": [ + "Services" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "operationId": "Services_ListByResourceGroup", + "x-ms-examples": { + "SearchListServicesByResourceGroup": { + "$ref": "./examples/SearchListServicesByResourceGroup.json" + } + }, + "description": "Gets a list of all Search services in the given resource group.", + "externalDocs": { + "url": "https://aka.ms/search-manage" + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation succeeded. The response contains the list of all search service definitions for the given resource group.", + "schema": { + "$ref": "#/definitions/SearchServiceListResult" + } + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "operationId": "PrivateLinkResources_ListSupported", + "x-ms-examples": { + "ListSupportedPrivateLinkResources": { + "$ref": "./examples/ListSupportedPrivateLinkResources.json" + } + }, + "description": "Gets a list of all supported private link resource types for the given service.", + "externalDocs": { + "url": "https://aka.ms/search-manage" + }, + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SearchServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "The operation succeeded. The response contains the list of all supported private link resource types for the given service.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourcesResult" + } + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Update", + "x-ms-examples": { + "PrivateEndpointConnectionUpdate": { + "$ref": "./examples/UpdatePrivateEndpointConnection.json" + } + }, + "description": "Updates a Private Endpoint connection to the search service in the given resource group.", + "externalDocs": { + "url": "https://aka.ms/search-manage" + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SearchServiceNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "name": "privateEndpointConnection", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The definition of the private endpoint connection to update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The existing private endpoint connection definition was successfully updated.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "HTTP 400 (Bad Request): The given private endpoint connection name or the private endpoint connection definition is invalid; See the error code and message in the response for details. HTTP 404 (Not Found): The subscription, resource group, search service or private endpoint connection could not be found. HTTP 409 (Conflict): The specified subscription is disabled.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "x-ms-examples": { + "PrivateEndpointConnectionGet": { + "$ref": "./examples/GetPrivateEndpointConnection.json" + } + }, + "description": "Gets the details of the private endpoint connection to the search service in the given resource group.", + "externalDocs": { + "url": "https://aka.ms/search-manage" + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SearchServiceNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The definition of the private endpoint connection was successfully retrieved and is in the response.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, search service or private endpoint connection could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "x-ms-examples": { + "PrivateEndpointConnectionDelete": { + "$ref": "./examples/DeletePrivateEndpointConnection.json" + } + }, + "description": "Disconnects the private endpoint connection and deletes it from the search service.", + "externalDocs": { + "url": "https://aka.ms/search-manage" + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SearchServiceNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The private endpoint connection was successfully disconnected and removed from the search service. The response will contain the updated definition of the private endpoint connection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "404": { + "description": "The subscription, resource group, search service or private endpoint connection could not be found." + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "operationId": "PrivateEndpointConnections_ListByService", + "x-ms-examples": { + "ListPrivateEndpointConnectionsByService": { + "$ref": "./examples/ListPrivateEndpointConnectionsByService.json" + } + }, + "description": "Gets a list of all private endpoint connections in the given service.", + "externalDocs": { + "url": "https://aka.ms/search-manage" + }, + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SearchServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "The operation succeeded. The response contains the list of all private endpoint connections for the given service.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}": { + "put": { + "tags": [ + "SharedPrivateLinkResources" + ], + "operationId": "SharedPrivateLinkResources_CreateOrUpdate", + "x-ms-examples": { + "SharedPrivateLinkResourceCreateOrUpdate": { + "$ref": "./examples/CreateOrUpdateSharedPrivateLinkResource.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "description": "Initiates the creation or update of a shared private link resource managed by the search service in the given resource group.", + "externalDocs": { + "url": "https://aka.ms/search-manage" + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SearchServiceNameParameter" + }, + { + "$ref": "#/parameters/SharedPrivateLinkResourceNameParameter" + }, + { + "name": "sharedPrivateLinkResource", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + }, + "description": "The definition of the shared private link resource to create or update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The details of the shared private link resource that was created or updated.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "202": { + "description": "The shared private link resource create or update operation has been accepted and will complete asynchronously." + }, + "default": { + "description": "HTTP 400 (Bad Request): The given shared private link resource name or the shared private link resource definition is invalid; See the error code and message in the response for details. HTTP 404 (Not Found): The subscription, resource group, search service or shared private link resource could not be found. HTTP 409 (Conflict): The specified subscription is disabled.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "SharedPrivateLinkResources" + ], + "operationId": "SharedPrivateLinkResources_Get", + "x-ms-examples": { + "SharedPrivateLinkResourceGet": { + "$ref": "./examples/GetSharedPrivateLinkResource.json" + } + }, + "description": "Gets the details of the shared private link resource managed by the search service in the given resource group.", + "externalDocs": { + "url": "https://aka.ms/search-manage" + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SearchServiceNameParameter" + }, + { + "$ref": "#/parameters/SharedPrivateLinkResourceNameParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The definition of the shared private link resource was successfully retrieved and is in the response.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, search service or shared private link resource could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "SharedPrivateLinkResources" + ], + "operationId": "SharedPrivateLinkResources_Delete", + "x-ms-examples": { + "SharedPrivateLinkResourceDelete": { + "$ref": "./examples/DeleteSharedPrivateLinkResource.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "description": "Initiates the deletion of the shared private link resource from the search service.", + "externalDocs": { + "url": "https://aka.ms/search-manage" + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SearchServiceNameParameter" + }, + { + "$ref": "#/parameters/SharedPrivateLinkResourceNameParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "The shared private link resource deletion operation was accepted and will complete asynchronously." + }, + "204": { + "description": "The backing private endpoint for the shared private link resource could not be found." + }, + "404": { + "description": "The subscription, resource group, search service or shared private link resource could not be found." + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources": { + "get": { + "tags": [ + "SharedPrivateLinkResources" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "operationId": "SharedPrivateLinkResources_ListByService", + "x-ms-examples": { + "ListSharedPrivateLinkResourcesByService": { + "$ref": "./examples/ListSharedPrivateLinkResourcesByService.json" + } + }, + "description": "Gets a list of all shared private link resources managed by the given service.", + "externalDocs": { + "url": "https://aka.ms/search-manage" + }, + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SearchServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "The operation succeeded. The response contains the list of all shared private link resources managed by the given service.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResourceListResult" + } + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Search/searchServices": { + "get": { + "tags": [ + "Services" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "operationId": "Services_ListBySubscription", + "x-ms-examples": { + "SearchListServicesBySubscription": { + "$ref": "./examples/SearchListServicesBySubscription.json" + } + }, + "description": "Gets a list of all Search services in the given subscription.", + "externalDocs": { + "url": "https://aka.ms/search-manage" + }, + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation succeeded. The response contains the list of all search service definitions for the given subscription.", + "schema": { + "$ref": "#/definitions/SearchServiceListResult" + } + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Search/checkNameAvailability": { + "post": { + "tags": [ + "Services" + ], + "description": "Checks whether or not the given search service name is available for use. Search service names must be globally unique since they are part of the service URI (https://.search.windows.net).", + "externalDocs": { + "url": "https://aka.ms/search-manage" + }, + "operationId": "Services_CheckNameAvailability", + "x-ms-examples": { + "SearchCheckNameAvailability": { + "$ref": "./examples/SearchCheckNameAvailability.json" + } + }, + "parameters": [ + { + "name": "checkNameAvailabilityInput", + "in": "body", + "description": "The resource name and type to check.", + "x-ms-client-flatten": true, + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityInput" + } + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The name check completed. The response contains details of whether the name is valid and available. If the name is invalid, the response also contains a message explaining why not.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityOutput" + } + }, + "default": { + "description": "HTTP 400 (Bad Request): The given resource type is not 'searchServices'.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "CheckNameAvailabilityInput": { + "type": "object", + "required": [ + "name", + "type" + ], + "properties": { + "name": { + "description": "The search service name to validate. Search service names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in length.", + "type": "string" + }, + "type": { + "description": "The type of the resource whose name is to be validated. This value must always be 'searchServices'.", + "type": "string", + "enum": [ + "searchServices" + ], + "x-ms-enum": { + "name": "ResourceType", + "modelAsString": false, + "values": [ + { + "value": "searchServices", + "name": "SearchServices", + "description": "'searchServices' is the only resource type whose name can be validated." + } + ] + } + } + }, + "description": "Input of check name availability API." + }, + "CheckNameAvailabilityOutput": { + "type": "object", + "properties": { + "nameAvailable": { + "x-ms-client-name": "IsNameAvailable", + "description": "A value indicating whether the name is available.", + "type": "boolean", + "readOnly": true + }, + "reason": { + "description": "The reason why the name is not available. 'Invalid' indicates the name provided does not match the naming requirements (incorrect length, unsupported characters, etc.). 'AlreadyExists' indicates that the name is already in use and is therefore unavailable.", + "type": "string", + "readOnly": true, + "enum": [ + "Invalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "UnavailableNameReason", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "name": "Invalid", + "description": "The search service name does not match naming requirements." + }, + { + "value": "AlreadyExists", + "name": "AlreadyExists", + "description": "The search service name is already assigned to a different search service." + } + ] + } + }, + "message": { + "description": "A message that explains why the name is invalid and provides resource naming requirements. Available only if 'Invalid' is returned in the 'reason' property.", + "type": "string", + "readOnly": true + } + }, + "description": "Output of check name availability API." + }, + "AdminKeyResult": { + "properties": { + "primaryKey": { + "readOnly": true, + "type": "string", + "description": "The primary admin API key of the search service." + }, + "secondaryKey": { + "readOnly": true, + "type": "string", + "description": "The secondary admin API key of the search service." + } + }, + "description": "Response containing the primary and secondary admin API keys for a given Azure Cognitive Search service." + }, + "QueryKey": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the query API key; may be empty." + }, + "key": { + "readOnly": true, + "type": "string", + "description": "The value of the query API key." + } + }, + "description": "Describes an API key for a given Azure Cognitive Search service that has permissions for query operations only." + }, + "ListQueryKeysResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/QueryKey" + }, + "description": "The query keys for the Azure Cognitive Search service." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "Request URL that can be used to query next page of query keys. Returned when the total number of requested query keys exceed maximum page size." + } + }, + "description": "Response containing the query API keys for a given Azure Cognitive Search service.", + "x-ms-external": true + }, + "Sku": { + "properties": { + "name": { + "type": "string", + "description": "The SKU of the search service. Valid values include: 'free': Shared service. 'basic': Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12 partitions and 12 replicas. 'standard2': Similar to standard, but with more capacity per search unit. 'standard3': The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). 'storage_optimized_l1': Supports 1TB per partition, up to 12 partitions. 'storage_optimized_l2': Supports 2TB per partition, up to 12 partitions.'", + "enum": [ + "free", + "basic", + "standard", + "standard2", + "standard3", + "storage_optimized_l1", + "storage_optimized_l2" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true, + "values": [ + { + "value": "free", + "name": "Free", + "description": "Free tier, with no SLA guarantees and a subset of features offered to paid tiers." + }, + { + "value": "basic", + "name": "Basic", + "description": "Paid tier dedicated service with up to 3 replicas." + }, + { + "value": "standard", + "name": "Standard", + "description": "Paid tier dedicated service with up to 12 partitions and 12 replicas." + }, + { + "value": "standard2", + "name": "Standard2", + "description": "Similar to 'standard', but with more capacity per search unit." + }, + { + "value": "standard3", + "name": "Standard3", + "description": " The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity')." + }, + { + "value": "storage_optimized_l1", + "name": "StorageOptimizedL1", + "description": "Paid tier dedicated service that supports 1TB per partition, up to 12 partitions." + }, + { + "value": "storage_optimized_l2", + "name": "StorageOptimizedL2", + "description": "Paid tier dedicated service that supports 2TB per partition, up to 12 partitions." + } + ] + } + } + }, + "description": "Defines the SKU of an Azure Cognitive Search Service, which determines price tier and capacity limits.", + "externalDocs": { + "url": "https://azure.microsoft.com/documentation/articles/search-sku-tier/" + } + }, + "DataPlaneAuthOptions": { + "properties": { + "apiKeyOnly": { + "type": "object", + "properties": {}, + "description": "Indicates that only the API key needs to be used for authentication." + }, + "aadOrApiKey": { + "$ref": "#/definitions/DataPlaneAadOrApiKeyAuthOption", + "description": "Indicates that either the API key or an access token from Azure Active Directory can be used for authentication." + } + }, + "description": "Defines the options for how the data plane API of a Search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true." + }, + "DataPlaneAadOrApiKeyAuthOption": { + "properties": { + "aadAuthFailureMode": { + "type": "string", + "description": "Describes what response the data plane API of a Search service would send for requests that failed authentication.", + "enum": [ + "http403", + "http401WithBearerChallenge" + ], + "x-ms-enum": { + "name": "AadAuthFailureMode", + "modelAsString": false, + "values": [ + { + "value": "http403", + "name": "Http403", + "description": "Indicates that requests that failed authentication should be presented with an HTTP status code of 403 (Forbidden)." + }, + { + "value": "http401WithBearerChallenge", + "name": "Http401WithBearerChallenge", + "description": "Indicates that requests that failed authentication should be presented with an HTTP status code of 401 (Unauthorized) and present a Bearer Challenge." + } + ] + } + } + }, + "description": "Indicates that either the API key or an access token from Azure Active Directory can be used for authentication." + }, + "DisabledDataExfiltrationOption": { + "type": "string", + "enum": [ + "All" + ], + "x-ms-enum": { + "name": "SearchDisabledDataExfiltrationOption", + "modelAsString": true, + "values": [ + { + "value": "All", + "name": "All", + "description": "Indicates that all data exfiltration scenarios are disabled." + } + ] + }, + "description": "A specific data exfiltration scenario that is disabled for the service." + }, + "EncryptionWithCmk": { + "type": "object", + "properties": { + "enforcement": { + "description": "Describes how a search service should enforce having one or more non customer encrypted resources.", + "type": "string", + "enum": [ + "Disabled", + "Enabled", + "Unspecified" + ], + "x-ms-enum": { + "name": "SearchEncryptionWithCmk", + "modelAsString": false, + "values": [ + { + "value": "Disabled", + "name": "Disabled", + "description": "No enforcement will be made and the search service can have non customer encrypted resources." + }, + { + "value": "Enabled", + "name": "Enabled", + "description": "Search service will be marked as non-compliant if there are one or more non customer encrypted resources." + }, + { + "value": "Unspecified", + "name": "Unspecified", + "description": "Enforcement policy is not explicitly specified, with the behavior being the same as if it were set to 'Disabled'." + } + ] + } + }, + "encryptionComplianceStatus": { + "readOnly": true, + "description": "Describes whether the search service is compliant or not with respect to having non customer encrypted resources. If a service has more than one non customer encrypted resource and 'Enforcement' is 'enabled' then the service will be marked as 'nonCompliant'.", + "type": "string", + "enum": [ + "Compliant", + "NonCompliant" + ], + "x-ms-enum": { + "name": "SearchEncryptionComplianceStatus", + "modelAsString": false, + "values": [ + { + "value": "Compliant", + "name": "Compliant", + "description": "Indicates that the search service is compliant, either because number of non customer encrypted resources is zero or enforcement is disabled." + }, + { + "value": "NonCompliant", + "name": "NonCompliant", + "description": "Indicates that the search service has more than 1 non customer encrypted resources." + } + ] + } + } + }, + "description": "Describes a policy that determines how resources within the search service are to be encrypted with Customer Managed Keys." + }, + "PrivateEndpointConnection": { + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ], + "description": "Describes an existing Private Endpoint connection to the Azure Cognitive Search service." + }, + "NetworkRuleSet": { + "properties": { + "ipRules": { + "type": "array", + "description": "A list of IP restriction rules that defines the inbound network(s) with allowing access to the search service endpoint. At the meantime, all other public IP networks are blocked by the firewall. These restriction rules are applied only when the 'publicNetworkAccess' of the search service is 'enabled'; otherwise, traffic over public interface is not allowed even with any public IP rules, and private endpoint connections would be the exclusive access method.", + "items": { + "$ref": "#/definitions/IpRule" + } + }, + "bypass": { + "type": "string", + "enum": [ + "None" + ], + "x-ms-enum": { + "name": "SearchBypass", + "modelAsString": true, + "values": [ + { + "value": "None", + "name": "None", + "description": "Indicates that no origin can bypass the rules defined in the 'ipRules' section. This is the default." + } + ] + }, + "description": "A specific data exfiltration scenario that is disabled for the service." + } + }, + "description": "Network specific rules that determine how the Azure Cognitive Search service may be reached." + }, + "IpRule": { + "properties": { + "value": { + "type": "string", + "description": "Value corresponding to a single IPv4 address (eg., 123.1.2.3) or an IP range in CIDR format (eg., 123.1.2.3/24) to be allowed." + } + }, + "description": "The IP restriction rule of the Azure Cognitive Search service." + }, + "PrivateEndpointConnectionProperties": { + "properties": { + "privateEndpoint": { + "properties": { + "id": { + "type": "string", + "description": "The resource id of the private endpoint resource from Microsoft.Network provider." + } + }, + "description": "The private endpoint resource from Microsoft.Network provider." + }, + "privateLinkServiceConnectionState": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "x-ms-enum": { + "name": "PrivateLinkServiceConnectionStatus", + "modelAsString": false, + "values": [ + { + "value": "Pending", + "name": "Pending", + "description": "The private endpoint connection has been created and is pending approval." + }, + { + "value": "Approved", + "name": "Approved", + "description": "The private endpoint connection is approved and is ready for use." + }, + { + "value": "Rejected", + "name": "Rejected", + "description": "The private endpoint connection has been rejected and cannot be used." + }, + { + "value": "Disconnected", + "name": "Disconnected", + "description": "The private endpoint connection has been removed from the service." + } + ] + } + }, + "description": { + "type": "string", + "description": "The description for the private link service connection state." + }, + "actionsRequired": { + "type": "string", + "description": "A description of any extra actions that may be required.", + "default": "None" + } + }, + "description": "Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint." + } + }, + "description": "Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service." + }, + "PrivateEndpointConnectionListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The list of Private Endpoint connections." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size." + } + }, + "description": "Response containing a list of Private Endpoint connections.", + "x-ms-external": true + }, + "SemanticSearch": { + "type": "string", + "enum": [ + "disabled", + "free", + "standard" + ], + "x-ms-enum": { + "name": "SearchSemanticSearch", + "modelAsString": true, + "values": [ + { + "value": "disabled", + "name": "disabled", + "description": "Indicates that semantic search is disabled for the search service. This is the default." + }, + { + "value": "free", + "name": "free", + "description": "Enables semantic search on a search service and indicates that it is to be used within the limits of the free tier. This would cap the volume of semantic search requests and is offered at no extra charge." + }, + { + "value": "standard", + "name": "standard", + "description": "Enables semantic search on a search service as a billable feature, with higher throughput and volume of semantic search queries." + } + ] + }, + "description": "Sets options that control the availability of semantic search. This configuration is only possible for certain Azure Cognitive Search SKUs in certain locations." + }, + "SharedPrivateLinkResource": { + "properties": { + "properties": { + "$ref": "#/definitions/SharedPrivateLinkResourceProperties", + "description": "Describes the properties of a Shared Private Link Resource managed by the Azure Cognitive Search service." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ], + "description": "Describes a Shared Private Link Resource managed by the Azure Cognitive Search service." + }, + "SharedPrivateLinkResourceProperties": { + "properties": { + "privateLinkResourceId": { + "type": "string", + "description": "The resource id of the resource the shared private link resource is for." + }, + "groupId": { + "type": "string", + "description": "The group id from the provider of resource the shared private link resource is for." + }, + "requestMessage": { + "type": "string", + "description": "The request message for requesting approval of the shared private link resource." + }, + "resourceRegion": { + "type": "string", + "description": "Optional. Can be used to specify the Azure Resource Manager location of the resource to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).", + "externalDocs": { + "description": "List of all Azure resources which have a regional DNS configuration requirement can be found here.", + "url": "https://docs.microsoft.com/azure/private-link/private-endpoint-dns" + } + }, + "status": { + "type": "string", + "description": "Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected or other yet to be documented value.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "x-ms-enum": { + "name": "SharedPrivateLinkResourceStatus", + "modelAsString": true, + "values": [ + { + "value": "Pending", + "name": "Pending", + "description": "The shared private link resource has been created and is pending approval." + }, + { + "value": "Approved", + "name": "Approved", + "description": "The shared private link resource is approved and is ready for use." + }, + { + "value": "Rejected", + "name": "Rejected", + "description": "The shared private link resource has been rejected and cannot be used." + }, + { + "value": "Disconnected", + "name": "Disconnected", + "description": "The shared private link resource has been removed from the service." + } + ] + } + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded, Incomplete or other yet to be documented value.", + "enum": [ + "Updating", + "Deleting", + "Failed", + "Succeeded", + "Incomplete" + ], + "x-ms-enum": { + "name": "SharedPrivateLinkResourceProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Updating", + "name": "Updating", + "description": "The shared private link resource is in the process of being created along with other resources for it to be fully functional." + }, + { + "value": "Deleting", + "name": "Deleting", + "description": "The shared private link resource is in the process of being deleted." + }, + { + "value": "Failed", + "name": "Failed", + "description": "The shared private link resource has failed to be provisioned or deleted." + }, + { + "value": "Succeeded", + "name": "Succeeded", + "description": "The shared private link resource has finished provisioning and is ready for approval." + }, + { + "value": "Incomplete", + "name": "Incomplete", + "description": "Provisioning request for the shared private link resource has been accepted but the process of creation has not commenced yet." + } + ] + } + } + }, + "description": "Describes the properties of an existing Shared Private Link Resource managed by the Azure Cognitive Search service." + }, + "SharedPrivateLinkResourceListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SharedPrivateLinkResource" + }, + "description": "The list of Shared Private Link Resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of shared private link resources, if there are any." + } + }, + "description": "Response containing a list of Shared Private Link Resources.", + "x-ms-external": true + }, + "PrivateLinkResourcesResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "The list of supported Private Link Resources." + } + }, + "description": "Response containing a list of supported Private Link Resources.", + "x-ms-external": true + }, + "PrivateLinkResource": { + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "readOnly": true, + "description": "Describes the properties of a supported private link resource for the Azure Cognitive Search service." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ], + "description": "Describes a supported private link resource for the Azure Cognitive Search service." + }, + "PrivateLinkResourceProperties": { + "properties": { + "groupId": { + "readOnly": true, + "type": "string", + "description": "The group ID of the private link resource." + }, + "requiredMembers": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of required members of the private link resource." + }, + "requiredZoneNames": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of required DNS zone names of the private link resource." + }, + "shareablePrivateLinkResourceTypes": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ShareablePrivateLinkResourceType" + }, + "description": "The list of resources that are onboarded to private link service, that are supported by Azure Cognitive Search." + } + }, + "description": "Describes the properties of a supported private link resource for the Azure Cognitive Search service. For a given API version, this represents the 'supported' groupIds when creating a shared private link resource." + }, + "ShareablePrivateLinkResourceType": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource type that has been onboarded to private link service, supported by Azure Cognitive Search." + }, + "properties": { + "$ref": "#/definitions/ShareablePrivateLinkResourceProperties", + "readOnly": true, + "description": "Describes the properties of a resource type that has been onboarded to private link service, supported by Azure Cognitive Search." + } + }, + "description": "Describes an resource type that has been onboarded to private link service, supported by Azure Cognitive Search." + }, + "ShareablePrivateLinkResourceProperties": { + "properties": { + "type": { + "readOnly": true, + "type": "string", + "description": "The resource provider type for the resource that has been onboarded to private link service, supported by Azure Cognitive Search." + }, + "groupId": { + "readOnly": true, + "type": "string", + "description": "The resource provider group id for the resource that has been onboarded to private link service, supported by Azure Cognitive Search." + }, + "description": { + "readOnly": true, + "type": "string", + "description": "The description of the resource type that has been onboarded to private link service, supported by Azure Cognitive Search." + } + }, + "description": "Describes the properties of a resource type that has been onboarded to private link service, supported by Azure Cognitive Search." + }, + "SearchService": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SearchServiceProperties", + "description": "Properties of the search service." + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service.", + "externalDocs": { + "url": "https://azure.microsoft.com/documentation/articles/search-sku-tier/" + } + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "description": "Describes an Azure Cognitive Search service and its current state." + }, + "SearchServiceUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SearchServiceProperties", + "description": "Properties of the search service." + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service.", + "externalDocs": { + "url": "https://azure.microsoft.com/documentation/articles/search-sku-tier/" + } + }, + "location": { + "type": "string", + "description": "The geographic location of the resource. This must be one of the supported and registered Azure Geo Regions (for example, West US, East US, Southeast Asia, and so forth). This property is required when creating a new resource.", + "externalDocs": { + "url": "https://aka.ms/search-rp-info" + }, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Tags to help categorize the resource in the Azure portal." + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "Details about the search service identity. A null value indicates that the search service has no identity assigned." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ], + "description": "The parameters used to update an Azure Cognitive Search service." + }, + "SearchServiceProperties": { + "properties": { + "replicaCount": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 12, + "default": 1, + "description": "The number of replicas in the search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU." + }, + "partitionCount": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 12, + "default": 1, + "description": "The number of partitions in the search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3." + }, + "hostingMode": { + "type": "string", + "default": "default", + "description": "Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'.", + "enum": [ + "default", + "highDensity" + ], + "x-ms-enum": { + "name": "HostingMode", + "modelAsString": false, + "values": [ + { + "value": "default", + "name": "Default", + "description": "The limit on number of indexes is determined by the default limits for the SKU." + }, + { + "value": "highDensity", + "name": "HighDensity", + "description": "Only application for standard3 SKU, where the search service can have up to 1000 indexes." + } + ] + } + }, + "publicNetworkAccess": { + "type": "string", + "default": "enabled", + "description": "This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method.", + "enum": [ + "enabled", + "disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true, + "values": [ + { + "value": "enabled", + "name": "Enabled", + "description": "The search service is accessible from traffic originating from the public internet." + }, + { + "value": "disabled", + "name": "Disabled", + "description": "The search service is not accessible from traffic originating from the public internet. Access is only permitted over approved private endpoint connections." + } + ] + } + }, + "status": { + "readOnly": true, + "type": "string", + "description": "The status of the search service. Possible values include: 'running': The search service is running and no provisioning operations are underway. 'provisioning': The search service is being provisioned or scaled up or down. 'deleting': The search service is being deleted. 'degraded': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. 'stopped': The search service is in a subscription that's disabled. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.", + "enum": [ + "running", + "provisioning", + "deleting", + "degraded", + "disabled", + "error", + "stopped" + ], + "x-ms-enum": { + "name": "SearchServiceStatus", + "modelAsString": false, + "values": [ + { + "value": "running", + "name": "Running", + "description": "The search service is running and no provisioning operations are underway." + }, + { + "value": "provisioning", + "name": "Provisioning", + "description": "The search service is being provisioned or scaled up or down." + }, + { + "value": "deleting", + "name": "Deleting", + "description": "The search service is being deleted." + }, + { + "value": "degraded", + "name": "Degraded", + "description": "The search service is degraded because underlying search units are not healthy." + }, + { + "value": "disabled", + "name": "Disabled", + "description": "The search service is disabled and all API requests will be rejected." + }, + { + "value": "error", + "name": "Error", + "description": "The search service is in error state, indicating either a failure to provision or to be deleted." + }, + { + "value": "stopped", + "name": "Stopped", + "description": "The search service is in a subscription that's disabled." + } + ] + } + }, + "statusDetails": { + "readOnly": true, + "type": "string", + "description": "The details of the search service status." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The state of the last provisioning operation performed on the search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create search service. This is because the free service uses capacity that is already set up.", + "enum": [ + "succeeded", + "provisioning", + "failed" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false, + "values": [ + { + "value": "succeeded", + "name": "Succeeded", + "description": "The last provisioning operation has completed successfully." + }, + { + "value": "provisioning", + "name": "Provisioning", + "description": "The search service is being provisioned or scaled up or down." + }, + { + "value": "failed", + "name": "Failed", + "description": "The last provisioning operation has failed." + } + ] + } + }, + "networkRuleSet": { + "$ref": "#/definitions/NetworkRuleSet", + "description": "Network specific rules that determine how the Azure Cognitive Search service may be reached." + }, + "disabledDataExfiltrationOptions": { + "type": "array", + "items": { + "$ref": "#/definitions/DisabledDataExfiltrationOption" + }, + "description": "A list of data exfiltration scenarios that are explicitly disallowed for the search service. Currently, the only supported value is 'All' to disable all possible data export scenarios with more fine grained controls planned for the future." + }, + "encryptionWithCmk": { + "$ref": "#/definitions/EncryptionWithCmk", + "description": "Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service." + }, + "disableLocalAuth": { + "type": "boolean", + "x-nullable": true, + "description": "When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined." + }, + "authOptions": { + "$ref": "#/definitions/DataPlaneAuthOptions", + "description": "Defines the options for how the data plane API of a search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true." + }, + "semanticSearch": { + "$ref": "#/definitions/SemanticSearch", + "x-nullable": true, + "description": "Sets options that control the availability of semantic search. This configuration is only possible for certain Azure Cognitive Search SKUs in certain locations." + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The list of private endpoint connections to the Azure Cognitive Search service." + }, + "sharedPrivateLinkResources": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SharedPrivateLinkResource" + }, + "description": "The list of shared private link resources managed by the Azure Cognitive Search service." + }, + "eTag": { + "readOnly": true, + "type": "string", + "description": "A system generated property representing the service's etag that can be for optimistic concurrency control during updates." + } + }, + "description": "Properties of the search service." + }, + "SearchServiceListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SearchService" + }, + "description": "The list of Search services." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "Request URL that can be used to query next page of search services. Returned when the total number of requested search services exceed maximum page size." + } + }, + "description": "Response containing a list of Azure Cognitive Search services.", + "x-ms-external": true + }, + "AsyncOperationResult": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "The current status of the long running asynchronous shared private link resource operation.", + "enum": [ + "Running", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "SharedPrivateLinkResourceAsyncOperationResult", + "modelAsString": true + } + } + }, + "description": "The details of a long running asynchronous shared private link resource operation" + }, + "CloudError": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "Describes a particular API error with an error code and a message." + }, + "message": { + "type": "string", + "description": "A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property)." + } + }, + "description": "Contains information about an API error.", + "x-ms-external": true + }, + "CloudErrorBody": { + "type": "object", + "description": "Describes a particular API error with an error code and a message.", + "properties": { + "code": { + "type": "string", + "description": "An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases." + }, + "message": { + "type": "string", + "description": "A message that describes the error in detail and provides debugging information." + }, + "target": { + "type": "string", + "description": "The target of the particular error (for example, the name of the property in error)." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "Contains nested errors that are related to this error." + } + }, + "x-ms-external": true + }, + "Operation": { + "description": "Describes a REST API operation.", + "type": "object", + "properties": { + "name": { + "description": "The name of the operation. This name is of the form {provider}/{resource}/{operation}.", + "readOnly": true, + "type": "string" + }, + "display": { + "description": "The object that describes the operation.", + "readOnly": true, + "properties": { + "provider": { + "description": "The friendly name of the resource provider.", + "readOnly": true, + "type": "string" + }, + "operation": { + "description": "The operation type: read, write, delete, listKeys/action, etc.", + "readOnly": true, + "type": "string" + }, + "resource": { + "description": "The resource type on which the operation is performed.", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "The friendly name of the operation.", + "readOnly": true, + "type": "string" + } + } + }, + "isDataAction": { + "type": "boolean", + "x-nullable": true, + "readOnly": true, + "description": "Describes if the specified operation is a data plane API operation. Operations where this value is not true are supported directly by the resource provider." + }, + "origin": { + "type": "string", + "readOnly": true, + "description": "Describes which originating entities are allowed to invoke this operation." + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Describes additional properties for this operation.", + "readOnly": true + } + } + }, + "OperationProperties": { + "description": "Describes additional properties for this operation.", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/OperationServiceSpecification", + "description": "Specifications of the service for this operation.", + "readOnly": true + } + } + }, + "OperationServiceSpecification": { + "description": "Specifications of the service for this operation.", + "properties": { + "metricSpecifications": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OperationMetricsSpecification" + }, + "description": "Specifications of metrics for this operation." + }, + "logSpecifications": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OperationLogsSpecification" + }, + "description": "Specifications of logs for this operation." + } + } + }, + "OperationMetricsSpecification": { + "description": "Specifications of one type of metric for this operation.", + "readOnly": true, + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the metric specification." + }, + "displayName": { + "type": "string", + "readOnly": true, + "description": "The display name of the metric specification." + }, + "displayDescription": { + "type": "string", + "readOnly": true, + "description": "The display description of the metric specification." + }, + "unit": { + "type": "string", + "readOnly": true, + "description": "The unit for the metric specification." + }, + "aggregationType": { + "type": "string", + "readOnly": true, + "description": "The type of aggregation for the metric specification." + }, + "dimensions": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OperationMetricDimension" + }, + "description": "Dimensions for the metric specification." + }, + "availabilities": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OperationAvailability" + }, + "description": "Availabilities for the metric specification." + } + } + }, + "OperationMetricDimension": { + "description": "Describes a particular dimension for the metric specification.", + "readOnly": true, + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the dimension." + }, + "displayName": { + "type": "string", + "readOnly": true, + "description": "The display name of the dimension." + } + } + }, + "OperationAvailability": { + "description": "Describes a particular availability for the metric specification.", + "readOnly": true, + "properties": { + "timeGrain": { + "type": "string", + "readOnly": true, + "description": "The time grain for the dimension." + }, + "blobDuration": { + "type": "string", + "readOnly": true, + "description": "The blob duration for the dimension." + } + } + }, + "OperationLogsSpecification": { + "description": "Specifications of one type of log for this operation.", + "readOnly": true, + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the log specification." + }, + "displayName": { + "type": "string", + "readOnly": true, + "description": "The display name of the log specification." + }, + "blobDuration": { + "type": "string", + "readOnly": true, + "description": "The blob duration for the log specification." + } + } + }, + "OperationListResult": { + "description": "The result of the request to list REST API operations. It contains a list of operations and a URL to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "readOnly": true, + "description": "The list of operations by Azure Cognitive Search, some supported by the resource provider and others by data plane APIs." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of operation list results, if any." + } + } + }, + "Identity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of the system-assigned identity of the search service." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID of the system-assigned identity of the search service." + }, + "type": { + "type": "string", + "description": "The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an identity created by the system and a set of user assigned identities. The type 'None' will remove all identities from the service.", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned" + ], + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": true, + "values": [ + { + "value": "None", + "name": "None", + "description": "Indicates that any identity associated with the search service needs to be removed." + }, + { + "value": "SystemAssigned", + "name": "SystemAssigned", + "description": "Indicates that system-assigned identity for the search service will be enabled." + }, + { + "value": "UserAssigned", + "name": "UserAssigned", + "description": "Indicates that one or more user assigned identities will be assigned to the search service." + }, + { + "value": "SystemAssigned, UserAssigned", + "name": "SystemAssigned, UserAssigned", + "description": "Indicates that system-assigned identity for the search service will be enabled along with the assignment of one or more user assigned identities." + } + ] + } + }, + "userAssignedIdentities": { + "$ref": "#/definitions/UserAssignedManagedIdentities", + "description": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "required": [ + "type" + ], + "description": "Details about the search service identity. A null value indicates that the search service has no identity assigned." + }, + "UserAssignedManagedIdentities": { + "type": "object", + "description": "The list of user identities associated with the search service. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedManagedIdentity" + } + }, + "UserAssignedManagedIdentity": { + "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." + } + }, + "type": "object", + "description": "The details of the user assigned managed identity assigned to the search service." + } + }, + "parameters": { + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.", + "x-ms-parameter-location": "method" + }, + "SearchServiceNameParameter": { + "name": "searchServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure Cognitive Search service associated with the specified resource group.", + "x-ms-parameter-location": "method" + }, + "PrivateEndpointConnectionNameParameter": { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.", + "x-ms-parameter-location": "method" + }, + "SharedPrivateLinkResourceNameParameter": { + "name": "sharedPrivateLinkResourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group.", + "x-ms-parameter-location": "method" + }, + "OperationNameParameter": { + "name": "operationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a shared private link resource operation.", + "x-ms-parameter-location": "method" + }, + "ClientRequestIdParameter": { + "name": "x-ms-client-request-id", + "x-ms-client-name": "clientRequestId", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.", + "x-ms-client-request-id": true, + "x-ms-parameter-grouping": { + "name": "search-management-request-options" + }, + "x-ms-parameter-location": "method" + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for each request." + } + } +} diff --git a/specification/search/resource-manager/readme.go.md b/specification/search/resource-manager/readme.go.md index 37ca670add13..75c6f5d2511c 100644 --- a/specification/search/resource-manager/readme.go.md +++ b/specification/search/resource-manager/readme.go.md @@ -18,6 +18,7 @@ batch: - tag: package-2015-08 - tag: package-2015-02 ``` + ### Tag: package-2020-08 and go These settings apply only when `--tag=package-2020-08 --go` is specified on the command line. diff --git a/specification/search/resource-manager/readme.md b/specification/search/resource-manager/readme.md index f96b053201f1..fe322809c162 100644 --- a/specification/search/resource-manager/readme.md +++ b/specification/search/resource-manager/readme.md @@ -63,6 +63,15 @@ input-file: - Microsoft.Search/stable/2015-02-28/search.json ``` +### Tag: package-2021-04-preview + +These settings apply only when `--tag=package-2021-04-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2021-04-preview' +input-file: +- Microsoft.Search/preview/2021-04-01-preview/search.json +``` + ### Tag: package-2020-08-preview These settings apply only when `--tag=package-2020-08-preview` is specified on the command line. @@ -94,7 +103,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js @@ -124,6 +133,10 @@ csharp: See configuration in [readme.go.md](./readme.go.md) +## Python + +See configuration in [readme.python.md](./readme.python.md) + ## Java These settings apply only when `--java` is specified on the command line. @@ -199,7 +212,3 @@ java: regenerate-manager: true generate-interface: true ``` - - - - diff --git a/specification/search/resource-manager/readme.python.md b/specification/search/resource-manager/readme.python.md index 060c57677640..610b7669a722 100644 --- a/specification/search/resource-manager/readme.python.md +++ b/specification/search/resource-manager/readme.python.md @@ -4,23 +4,19 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.search - package-name: azure-mgmt-search - clear-output-folder: true +``` yaml $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +namespace: azure.mgmt.search +package-name: azure-mgmt-search +package-version: 1.0.0b1 +clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/search/azure-mgmt-search/azure/mgmt/search +``` yaml $(python) && $(python-mode) == 'update' && $(track2) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/search/azure-mgmt-search/azure/mgmt/search ``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/search/azure-mgmt-search +``` yaml $(python) && $(python-mode) == 'create' && $(track2) +basic-setup-py: true +output-folder: $(python-sdks-folder)/search/azure-mgmt-search ``` diff --git a/specification/search/resource-manager/readme.ruby.md b/specification/search/resource-manager/readme.ruby.md index 015606328a5a..30475f046fff 100644 --- a/specification/search/resource-manager/readme.ruby.md +++ b/specification/search/resource-manager/readme.ruby.md @@ -45,4 +45,4 @@ Please also specify `--ruby-sdks-folder=2", - "3", - "another_name(4)" - ] - } - ], - "vendor": "BROADCOM", - "osName": "Windows 10 64", - "protocols": [ - { - "name": "CIP", - "identifiers": "0, 1" - }, - { - "name": "EtherNet/IP", - "identifiers": "0, 1" - } - ], - "lastActiveTime": "2020-05-13T06:32:25Z", - "lastUpdateTime": "2020-05-13T06:32:25Z", - "managementState": "Unmanaged", - "authorizationState": "Authorized", - "deviceCriticality": "Standard", - "purdueLevel": "ProcessControl", - "firmwares": [ - { - "serial": "0x27269242", - "model": "1768-ENBT", - "version": "29.11" - } - ], - "discoveryTime": "2020-05-13T06:32:25Z", - "programmingState": "NotProgrammingDevice", - "scanningFunctionality": "NotScannerDevice", - "riskScore": 100, - "sensors": [ - { - "name": "mySensorName", - "zone": "myZoneName" - } - ], - "site": { - "displayName": "mySite" - }, - "deviceStatus": "Active" - } - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/Devices/GetDevicesListForHub.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/Devices/GetDevicesListForHub.json deleted file mode 100644 index 777df993569e..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/Devices/GetDevicesListForHub.json +++ /dev/null @@ -1,82 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "resourceId": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Devices/iotHubs/myHub" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Devices/iotHubs/myHub/providers/Microsoft.Security/devices/myDevice", - "name": "myDevice", - "type": "Microsoft.Security/devices", - "properties": { - "displayName": "10.168.140.1", - "deviceType": "PLC", - "sourceName": "HORIZON", - "networkInterfaces": [ - { - "ipAddress": { - "v4Address": "10.168.140.1", - "detectionTime": "2020-05-13T06:32:25Z" - }, - "macAddress": { - "address": "34-E1-2D-77-80-D0", - "detectionTime": "2020-05-13T06:32:25Z", - "significance": "Primary", - "relationToIpStatus": "Certain" - }, - "vlans": [ - "name(1)->2", - "3", - "another_name(4)" - ] - } - ], - "vendor": "BROADCOM", - "osName": "Windows 10 64", - "protocols": [ - { - "name": "CIP", - "identifiers": "0, 1" - }, - { - "name": "EtherNet/IP", - "identifiers": "0, 1" - } - ], - "lastActiveTime": "2020-05-13T06:32:25Z", - "lastUpdateTime": "2020-05-13T06:32:25Z", - "managementState": "Unmanaged", - "authorizationState": "Authorized", - "deviceCriticality": "Standard", - "purdueLevel": "ProcessControl", - "firmwares": [ - { - "serial": "0x27269242", - "model": "1768-ENBT", - "version": "29.11" - } - ], - "discoveryTime": "2020-05-13T06:32:25Z", - "programmingState": "NotProgrammingDevice", - "scanningFunctionality": "NotScannerDevice", - "riskScore": 100, - "sensors": [ - { - "name": "mySensorName", - "zone": "myZoneName" - } - ], - "site": { - "displayName": "mySite" - }, - "deviceStatus": "Active" - } - } - ] - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/Devices/GetDevicesListForSubscription.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/Devices/GetDevicesListForSubscription.json deleted file mode 100644 index b4aca357ced5..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/Devices/GetDevicesListForSubscription.json +++ /dev/null @@ -1,82 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Devices/iotHubs/myHub/providers/Microsoft.Security/devices/myDevice", - "name": "myDevice", - "type": "Microsoft.Security/devices", - "properties": { - "displayName": "10.168.140.1", - "deviceType": "PLC", - "sourceName": "HORIZON", - "networkInterfaces": [ - { - "ipAddress": { - "v4Address": "10.168.140.1", - "detectionTime": "2020-05-13T06:32:25Z" - }, - "macAddress": { - "address": "34-E1-2D-77-80-D0", - "detectionTime": "2020-05-13T06:32:25Z", - "significance": "Primary", - "relationToIpStatus": "Certain" - }, - "vlans": [ - "name(1)->2", - "3", - "another_name(4)" - ] - } - ], - "vendor": "BROADCOM", - "osName": "Windows 10 64", - "protocols": [ - { - "name": "CIP", - "identifiers": "0, 1" - }, - { - "name": "EtherNet/IP", - "identifiers": "0, 1" - } - ], - "lastActiveTime": "2020-05-13T06:32:25Z", - "lastUpdateTime": "2020-05-13T06:32:25Z", - "managementState": "Unmanaged", - "authorizationState": "Authorized", - "deviceCriticality": "Standard", - "purdueLevel": "ProcessControl", - "firmwares": [ - { - "serial": "0x27269242", - "model": "1768-ENBT", - "version": "29.11" - } - ], - "discoveryTime": "2020-05-13T06:32:25Z", - "programmingState": "NotProgrammingDevice", - "scanningFunctionality": "NotScannerDevice", - "riskScore": 100, - "sensors": [ - { - "name": "mySensorName", - "zone": "myZoneName" - } - ], - "site": { - "displayName": "mySite" - }, - "deviceStatus": "Active" - } - } - ] - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlertTypes/GetIoTAlertType.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlertTypes/GetIoTAlertType.json deleted file mode 100644 index 87ce81ea38b0..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlertTypes/GetIoTAlertType.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "iotAlertTypeName": "IoT_PrivilegedContainer" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/iotAlertTypes/IoT_PrivilegedContainer", - "name": "IoT_PrivilegedContainer", - "type": "Microsoft.Security/iotAlertTypes", - "properties": { - "alertDisplayName": "Privileged container detected", - "severity": "Medium", - "description": "Machine logs indicate that a privileged Docker container is running. A privileged container has full access to host resources. If compromised, a malicious actor can use the privileged container to gain access to the host machine.", - "providerName": "IoTSecurity", - "remediationSteps": [ - "If the container doesn't need to run in privileged mode, remove the privileges from the container." - ], - "intent": "Exploitation,Execution", - "vendorName": "Microsoft", - "productName": "Azure Security Center for IoT", - "productComponentName": "IoT Hub" - } - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlertTypes/GetIoTAlertTypeList.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlertTypes/GetIoTAlertTypeList.json deleted file mode 100644 index 80e82e38a730..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlertTypes/GetIoTAlertTypeList.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/iotAlertTypes", - "name": "IoT_PrivilegedContainer", - "type": "Microsoft.Security/iotAlertTypes", - "properties": { - "alertDisplayName": "Privileged container detected", - "severity": "Medium", - "description": "Machine logs indicate that a privileged Docker container is running. A privileged container has full access to host resources. If compromised, a malicious actor can use the privileged container to gain access to the host machine.", - "providerName": "IoTSecurity", - "remediationSteps": [ - "If the container doesn't need to run in privileged mode, remove the privileges from the container." - ], - "intent": "Exploitation,Execution", - "vendorName": "Microsoft", - "productName": "Azure Security Center for IoT", - "productComponentName": "IoT Hub" - } - } - ] - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlerts/GetIoTAlert.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlerts/GetIoTAlert.json deleted file mode 100644 index 8412d3e4f6fd..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlerts/GetIoTAlert.json +++ /dev/null @@ -1,37 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myGroup/providers/Microsoft.Devices/IotHubs/myIotHub", - "iotAlertId": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Devices/iotHubs/myIotHub/providers/Microsoft.Security/iotAlerts/903e76ff-17eb-4bac-ac8a-2bc31ab68fd8", - "name": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8", - "type": "Microsoft.Security/iotAlerts", - "properties": { - "systemAlertId": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8", - "compromisedEntity": "device-1", - "alertType": "IoT_PrivilegedContainer", - "startTimeUtc": "2020-05-13T06:32:25Z", - "endTimeUtc": "2020-05-13T06:32:25Z", - "entities": [ - { - "$id": "1", - "CommandLine": "docker run --privileged", - "Type": "process" - } - ], - "extendedProperties": { - "CommandLine": "docker run --privileged", - "User Name": "aUser", - "UserId": "", - "ParentProcessId": 1593, - "DeviceId": "device-1" - } - } - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlerts/GetIoTAlertList.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlerts/GetIoTAlertList.json deleted file mode 100644 index 550b347860c5..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotAlerts/GetIoTAlertList.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myGroup/providers/Microsoft.Devices/IotHubs/myIotHub", - "alertType": "IoT_PrivilegedContainer", - "startTimeUtc>": "2020-05-12T06:32:25Z", - "startTimeUtc<": "2020-05-14T06:32:25Z", - "compromisedEntity": "device-1", - "$limit": 1 - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Devices/iotHubs/myIotHub/providers/Microsoft.Security/iotAlerts/903e76ff-17eb-4bac-ac8a-2bc31ab68fd8", - "name": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8", - "type": "Microsoft.Security/iotAlerts", - "properties": { - "systemAlertId": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8", - "compromisedEntity": "device-1", - "alertType": "IoT_PrivilegedContainer", - "startTimeUtc": "2020-05-13T06:32:25Z", - "endTimeUtc": "2020-05-13T06:32:25Z", - "entities": [ - { - "$id": "1", - "CommandLine": "docker run --privileged", - "Type": "process" - } - ], - "extendedProperties": { - "CommandLine": "docker run --privileged", - "User Name": "aUser", - "UserId": "", - "ParentProcessId": 1593, - "DeviceId": "device-1" - } - } - } - ], - "nextLink": "https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myGroup/providers/Microsoft.Devices/iotHubs/myIotHub/providers/Microsoft.Security/iotAlerts?api-version=2020-08-06-preview&alertType=IoT_PrivilegedContainer&startTimeUtc>=2020-05-12T06:32:25Z&startTimeUtc<=2020-05-14T06:32:25Z&compromisedEntity=device-1&$limit=1&$skipToken=903e76ff-17eb-4bac-ac8a-2bc31ab68fd8" - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/Delete.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/Delete.json deleted file mode 100644 index 1e27394b4322..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/Delete.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/DownloadManagerActivation.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/DownloadManagerActivation.json deleted file mode 100644 index 2063852d8dd6..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/DownloadManagerActivation.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": { - "headers": { - "content-type": "application/zip" - }, - "body": "{Binary}" - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/Get.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/Get.json deleted file mode 100644 index 792a0cade892..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/Get.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": { - "body": { - "name": "default", - "id": "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotDefenderSettings/default", - "type": "Microsoft.Security/iotDefenderSettings", - "properties": { - "deviceQuota": 2000, - "sentinelWorkspaceResourceIds": [ - "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1" - ], - "onboardingKind": "Default" - } - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/List.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/List.json deleted file mode 100644 index d4fed0f881c6..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/List.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "default", - "id": "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotDefenderSettings/default", - "type": "Microsoft.Security/iotDefenderSettings", - "properties": { - "deviceQuota": 2000, - "sentinelWorkspaceResourceIds": [ - "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1" - ], - "onboardingKind": "Default" - } - } - ] - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/PackageDownloads.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/PackageDownloads.json deleted file mode 100644 index 456dc61d0672..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/PackageDownloads.json +++ /dev/null @@ -1,170 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": { - "body": { - "sensor": { - "full": { - "iso": [ - { - "version": "3.1", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Latest" - }, - { - "version": "2.8.11", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Previous" - } - ], - "ovf": { - "enterprise": [ - { - "version": "3.1", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Latest" - }, - { - "version": "2.8.11", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Previous" - } - ], - "medium": [ - { - "version": "3.1", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Latest" - }, - { - "version": "2.8.11", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Previous" - } - ], - "line": [ - { - "version": "3.1", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Latest" - }, - { - "version": "2.8.11", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Previous" - } - ] - } - }, - "upgrade": [ - { - "version": "2.8.2", - "fromVersion": "2.8.0", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Latest" - }, - { - "version": "2.8.10", - "fromVersion": "2.8.0", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Previous" - } - ] - }, - "centralManager": { - "full": { - "iso": [ - { - "version": "3.1", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Latest" - }, - { - "version": "2.8.11", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Previous" - } - ], - "ovf": { - "enterprise": [ - { - "version": "3.1", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Latest" - } - ], - "enterpriseHighAvailability": [ - { - "version": "3.1", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Latest" - } - ], - "medium": [ - { - "version": "3.1", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Latest" - } - ], - "mediumHighAvailability": [ - { - "version": "3.1", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Latest" - } - ] - } - }, - "upgrade": [ - { - "version": "2.8.2", - "fromVersion": "2.8.0", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Latest" - }, - { - "version": "2.8.10", - "fromVersion": "2.8.0", - "link": "http://microsoft.com/downloadLocation", - "versionKind": "Previous" - } - ] - }, - "threatIntelligence": [ - { - "link": "http://microsoft.com/downloadLocation", - "version": "2020.02.10" - } - ], - "snmp": [ - { - "link": "http://microsoft.com/downloadLocation", - "version": "2020.02.10" - } - ], - "wmiTool": [ - { - "link": "http://microsoft.com/downloadLocation", - "version": "2020.02.10" - } - ], - "authorizedDevicesImportTemplate": [ - { - "link": "http://microsoft.com/downloadLocation", - "version": "2020.02.10" - } - ], - "deviceInformationUpdateImportTemplate": [ - { - "link": "http://microsoft.com/downloadLocation", - "version": "2020.02.10" - } - ] - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/Put.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/Put.json deleted file mode 100644 index e4c54697eab3..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/Put.json +++ /dev/null @@ -1,45 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "iotDefenderSettingsModel": { - "properties": { - "deviceQuota": 2000, - "sentinelWorkspaceResourceIds": [ - "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1" - ], - "onboardingKind": "Default" - } - } - }, - "responses": { - "200": { - "body": { - "name": "default", - "id": "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotDefenderSettings/default", - "type": "Microsoft.Security/iotDefenderSettings", - "properties": { - "deviceQuota": 2000, - "sentinelWorkspaceResourceIds": [ - "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1" - ], - "onboardingKind": "Default" - } - } - }, - "201": { - "body": { - "name": "default", - "id": "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotDefenderSettings/default", - "type": "Microsoft.Security/iotDefenderSettings", - "properties": { - "deviceQuota": 2000, - "sentinelWorkspaceResourceIds": [ - "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1" - ], - "onboardingKind": "Default" - } - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotRecommendationTypes/GetIoTRecommendationType.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotRecommendationTypes/GetIoTRecommendationType.json deleted file mode 100644 index ecc8b4b4b15e..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotRecommendationTypes/GetIoTRecommendationType.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "iotRecommendationTypeName": "IoT_VulnerableTLSCipherSuite" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/iotRecommendationTypes/IoT_VulnerableTLSCipherSuite", - "name": "IoT_VulnerableTLSCipherSuite", - "type": "Microsoft.Security/iotRecommendationTypes", - "properties": { - "recommendationDisplayName": "TLS cipher suite upgrade needed", - "severity": "Medium", - "description": "Insecure TLS configurations detected. Immediate TLS cipher suite upgrade recommended.", - "remediationSteps": [ - "Upgrade your TLS cipher suite to a secure configuration. See the Guide to TLS Standards Compliance for more information." - ], - "vendorName": "Microsoft", - "control": "Communication between device and IoT Hub is not optimized", - "productName": "Azure Security Center for IoT", - "productComponentName": "IoT Hub" - } - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotRecommendationTypes/GetIoTRecommendationTypeList.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotRecommendationTypes/GetIoTRecommendationTypeList.json deleted file mode 100644 index ba7a86b41b0b..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotRecommendationTypes/GetIoTRecommendationTypeList.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/iotRecommendationTypes/IoT_VulnerableTLSCipherSuite", - "name": "IoT_VulnerableTLSCipherSuite", - "type": "Microsoft.Security/iotRecommendationTypes", - "properties": { - "recommendationDisplayName": "TLS cipher suite upgrade needed", - "severity": "Medium", - "description": "Insecure TLS configurations detected. Immediate TLS cipher suite upgrade recommended.", - "remediationSteps": [ - "Upgrade your TLS cipher suite to a secure configuration. See the Guide to TLS Standards Compliance for more information." - ], - "vendorName": "Microsoft", - "control": "Communication between device and IoT Hub is not optimized", - "productName": "Azure Security Center for IoT", - "productComponentName": "IoT Hub" - } - } - ] - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotRecommendations/GetIoTRecommendation.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotRecommendations/GetIoTRecommendation.json deleted file mode 100644 index 4c12cfdae65b..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotRecommendations/GetIoTRecommendation.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myGroup/providers/Microsoft.Devices/IotHubs/myIotHub", - "iotRecommendationId": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8" - }, - "responses": { - "200": { - "body": { - "name": "IoT_Baseline|device-1", - "properties": { - "recommendationType": "IoT_Baseline", - "deviceId": "device-1", - "discoveredTimeUtc": "2020-05-13T06:32:25Z", - "recommendationAdditionalData": { - "SnapshotId": "48519d58-4e35-46cd-aed5-6251af95ed50", - "TotalFailedRules": "7", - "TotalRulesFailedDuoToError": "1", - "TotalInformationalFailedRules": "2", - "TotalCriticalFailedRules": "3", - "TotalWarningFailedRules": "1" - } - } - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotRecommendations/GetIoTRecommendationList.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotRecommendations/GetIoTRecommendationList.json deleted file mode 100644 index b6f909d395bc..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotRecommendations/GetIoTRecommendationList.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myGroup/providers/Microsoft.Devices/IotHubs/myIotHub", - "recommendationType": "IoT_Baseline", - "deviceId": "device-1", - "$limit": 1 - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "IoT_Baseline|device-1", - "properties": { - "recommendationType": "IoT_Baseline", - "deviceId": "device-1", - "discoveredTimeUtc": "2020-05-13T06:32:25Z", - "recommendationAdditionalData": { - "SnapshotId": "48519d58-4e35-46cd-aed5-6251af95ed50", - "TotalFailedRules": "7", - "TotalRulesFailedDuoToError": "1", - "TotalInformationalFailedRules": "2", - "TotalCriticalFailedRules": "3", - "TotalWarningFailedRules": "1" - } - } - } - ], - "nextLink": "https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myGroup/providers/Microsoft.Devices/iotHubs/myIotHub/providers/Microsoft.Security/iotRecommendations?api-version=2020-08-06-preview&recommendationType=IoT_Baseline&deviceId=device-1&$limit=1&$skipToken=903e76ff-17eb-4bac-ac8a-2bc31ab68fd8" - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/Delete.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/Delete.json deleted file mode 100644 index c24e42c7df41..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/Delete.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub", - "iotSensorName": "mySensor" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/DownloadActivation.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/DownloadActivation.json deleted file mode 100644 index 7274a7caecc6..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/DownloadActivation.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub", - "iotSensorName": "mySensor" - }, - "responses": { - "200": { - "headers": { - "content-type": "application/zip" - }, - "body": "{Binary}" - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/DownloadResetPassword.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/DownloadResetPassword.json deleted file mode 100644 index eb56c01ba963..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/DownloadResetPassword.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub", - "iotSensorName": "mySensor", - "body": { - "applianceId": "3214-528AV23-D121-D3-E1" - } - }, - "responses": { - "200": { - "headers": { - "content-type": "application/zip" - }, - "body": "{Binary}" - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/Get.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/Get.json deleted file mode 100644 index 80c66ce707a7..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/Get.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub", - "iotSensorName": "mySensor" - }, - "responses": { - "200": { - "body": { - "name": "mySensor", - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.Security/iotSensors/mySensor", - "type": "Microsoft.Security/iotSensors", - "properties": { - "connectivityTime": "2020-11-17T12:31:25Z", - "creationTime": "2020-11-17T12:31:25Z", - "dynamicLearning": true, - "learningMode": true, - "sensorStatus": "Ok", - "sensorVersion": "2020.11.01.1643", - "tiAutomaticUpdates": true, - "tiStatus": "Ok", - "tiVersion": "2020-11-17T12:31:25Z", - "zone": "Zone Name", - "sensorType": "Ot" - } - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/List.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/List.json deleted file mode 100644 index a7050fb4c8a4..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/List.json +++ /dev/null @@ -1,50 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "mySensor", - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.Security/iotSensors/mySensor", - "type": "Microsoft.Security/iotSensors", - "properties": { - "connectivityTime": "2020-11-17T12:31:25Z", - "creationTime": "2020-11-17T12:31:25Z", - "dynamicLearning": true, - "learningMode": true, - "sensorStatus": "Ok", - "sensorVersion": "2020.11.01.1643", - "tiAutomaticUpdates": true, - "tiStatus": "Ok", - "tiVersion": "2020-11-17T12:31:25Z", - "zone": "Zone Name", - "sensorType": "Ot" - } - }, - { - "name": "otherSensor", - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.Security/iotSensors/otherSensor", - "type": "Microsoft.Security/iotSensors", - "properties": { - "connectivityTime": "2020-11-17T12:31:25Z", - "creationTime": "2020-11-17T12:31:25Z", - "dynamicLearning": false, - "learningMode": false, - "sensorStatus": "Disconnected", - "sensorVersion": "2020.11.01.1643", - "tiAutomaticUpdates": true, - "tiStatus": "Ok", - "tiVersion": "2020-11-17T12:31:25Z", - "zone": "Zone Name", - "sensorType": "Ot" - } - } - ] - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/Put.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/Put.json deleted file mode 100644 index 835beb4467c0..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/Put.json +++ /dev/null @@ -1,56 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub", - "iotSensorName": "mySensor", - "iotSensorsModel": { - "properties": { - "tiAutomaticUpdates": true, - "zone": "Zone Name", - "sensorType": "Ot" - } - } - }, - "responses": { - "200": { - "body": { - "name": "mySensor", - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.Security/iotSensors/mySensor", - "type": "Microsoft.Security/iotSensors", - "properties": { - "connectivityTime": "2020-11-17T12:31:25Z", - "creationTime": "2020-11-17T12:31:25Z", - "dynamicLearning": true, - "learningMode": true, - "sensorStatus": "Ok", - "sensorVersion": "2020.11.01.1643", - "tiAutomaticUpdates": true, - "tiStatus": "Ok", - "tiVersion": "2020-11-17T12:31:25Z", - "zone": "Zone Name", - "sensorType": "Ot" - } - } - }, - "201": { - "body": { - "name": "mySensor", - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.Security/iotSensors/mySensor", - "type": "Microsoft.Security/iotSensors", - "properties": { - "connectivityTime": "2020-11-17T12:31:25Z", - "creationTime": "2020-11-17T12:31:25Z", - "dynamicLearning": true, - "learningMode": true, - "sensorStatus": "Ok", - "sensorVersion": "2020.11.01.1643", - "tiAutomaticUpdates": true, - "tiStatus": "Ok", - "tiVersion": "2020-11-17T12:31:25Z", - "zone": "Zone Name", - "sensorType": "Ot" - } - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/TriggerTiPackageUpdate.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/TriggerTiPackageUpdate.json deleted file mode 100644 index 2aebd9e8ac3b..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/TriggerTiPackageUpdate.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub", - "iotSensorName": "mySensor" - }, - "responses": { - "200": {} - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSites/Delete.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSites/Delete.json deleted file mode 100644 index dd79858b1cc7..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSites/Delete.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSites/Get.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSites/Get.json deleted file mode 100644 index 75d959c8d13c..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSites/Get.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.Security/iotSites/default", - "type": "Microsoft.Security/iotSites", - "name": "default", - "properties": { - "displayName": "IoT site name", - "tags": { - "key1": "value1", - "key2": "value2" - } - } - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSites/List.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSites/List.json deleted file mode 100644 index 9918a1f91395..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSites/List.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/iotSites" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "default", - "id": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.Security/iotSites/default", - "type": "Microsoft.Security/iotSites", - "properties": { - "displayName": "IoT site name", - "tags": { - "key1": "value1", - "key2": "value2" - } - } - } - ] - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSites/Put.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSites/Put.json deleted file mode 100644 index 3062bf75c5fe..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSites/Put.json +++ /dev/null @@ -1,45 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub", - "iotSitesModel": { - "properties": { - "displayName": "IoT site name", - "tags": { - "key1": "value1", - "key2": "value2" - } - } - } - }, - "responses": { - "200": { - "body": { - "name": "default", - "id": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.Security/iotSites/default", - "type": "Microsoft.Security/iotSites", - "properties": { - "displayName": "IoT site name", - "tags": { - "key1": "value1", - "key2": "value2" - } - } - } - }, - "201": { - "body": { - "name": "default", - "id": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.Security/iotSites/default", - "type": "Microsoft.Security/iotSites", - "properties": { - "displayName": "IoT site name", - "tags": { - "key1": "value1", - "key2": "value2" - } - } - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Delete.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Delete.json deleted file mode 100644 index 21b5427051fc..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Delete.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "onPremiseIotSensorName": "mySensor" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/DownloadActivation.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/DownloadActivation.json deleted file mode 100644 index b2236a188f58..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/DownloadActivation.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "onPremiseIotSensorName": "mySensor" - }, - "responses": { - "200": { - "headers": { - "content-type": "application/zip" - }, - "body": "{Binary}" - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/DownloadResetPassword.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/DownloadResetPassword.json deleted file mode 100644 index e1fb673660c8..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/DownloadResetPassword.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "onPremiseIotSensorName": "mySensor", - "body": { - "applianceId": "3214-528AV23-D121-D3-E1" - } - }, - "responses": { - "200": { - "headers": { - "content-type": "application/zip" - }, - "body": "{Binary}" - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Get.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Get.json deleted file mode 100644 index e504ee9a9086..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Get.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "onPremiseIotSensorName": "mySensor" - }, - "responses": { - "200": { - "body": { - "name": "mySensor", - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/onPremiseIotSensors/mySensor", - "type": "Microsoft.Security/onPremiseIotSensors", - "properties": {} - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/List.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/List.json deleted file mode 100644 index f2536dd92897..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/List.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "mySensor", - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/iotSensors/mySensor", - "type": "Microsoft.Security/onPremiseIotSensors", - "properties": {} - }, - { - "name": "otherSensor", - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/iotSensors/otherSensor", - "type": "Microsoft.Security/onPremiseIotSensors", - "properties": {} - } - ] - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Put.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Put.json deleted file mode 100644 index 80f3d877d6d4..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Put.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "onPremiseIotSensorName": "mySensor" - }, - "responses": { - "200": { - "body": { - "name": "mySensor", - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/iotSensors/mySensor", - "type": "Microsoft.Security/onPremiseIotSensors", - "properties": {} - } - }, - "201": { - "body": { - "name": "mySensor", - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/iotSensors/mySensor", - "type": "Microsoft.Security/onPremiseIotSensors", - "properties": {} - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotAlertTypes.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotAlertTypes.json deleted file mode 100644 index a1dd8e2d4361..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotAlertTypes.json +++ /dev/null @@ -1,307 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Security Center", - "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", - "version": "2020-08-06-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotAlertTypes": { - "get": { - "x-ms-examples": { - "Get IoT Alert Types": { - "$ref": "./examples/IotAlertTypes/GetIoTAlertTypeList.json" - } - }, - "tags": [ - "IoT Security Alert Types" - ], - "description": "List IoT alert types", - "operationId": "IotAlertTypes_List", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/IotAlertTypeList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotAlertTypes/{iotAlertTypeName}": { - "get": { - "x-ms-examples": { - "Get IoT Alert Type": { - "$ref": "./examples/IotAlertTypes/GetIoTAlertType.json" - } - }, - "tags": [ - "IoT Security Alert Types" - ], - "operationId": "IotAlertTypes_Get", - "description": "Get IoT alert type", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "in": "path", - "name": "iotAlertTypeName", - "required": true, - "type": "string", - "description": "Name of the alert type" - } - ], - "responses": { - "200": { - "description": "IoT alert type", - "schema": { - "$ref": "#/definitions/IotAlertType" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "IotAlertTypeList": { - "type": "object", - "description": "List of alert types", - "properties": { - "value": { - "type": "array", - "description": "List data", - "items": { - "$ref": "#/definitions/IotAlertType" - } - } - } - }, - "IotAlertType": { - "type": "object", - "description": "IoT alert type.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Alert type properties", - "$ref": "#/definitions/IotAlertTypeProperties" - } - }, - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/Resource" - } - ] - }, - "IotAlertTypeProperties": { - "type": "object", - "description": "IoT alert type information.", - "properties": { - "alertDisplayName": { - "readOnly": true, - "type": "string", - "example": "Privileged container detected", - "description": "The display name of the alert" - }, - "severity": { - "readOnly": true, - "type": "string", - "example": "Medium", - "description": "The severity of the alert", - "enum": [ - "Informational", - "Low", - "Medium", - "High" - ], - "x-ms-enum": { - "name": "alertSeverity", - "modelAsString": true, - "values": [ - { - "value": "Informational" - }, - { - "value": "Low" - }, - { - "value": "Medium" - }, - { - "value": "High" - } - ] - } - }, - "description": { - "readOnly": true, - "type": "string", - "description": "Description of the suspected vulnerability and meaning.", - "example": "Machine logs indicate that a privileged Docker container is running. A privileged container has full access to host resources. If compromised, a malicious actor can use the privileged container to gain access to the host machine." - }, - "providerName": { - "readOnly": true, - "type": "string", - "example": "IoTSecurity", - "description": "The name of the alert provider or internal partner" - }, - "productName": { - "readOnly": true, - "type": "string", - "example": "Azure Security Center for IoT", - "description": "The name of the product which published this alert" - }, - "productComponentName": { - "readOnly": true, - "type": "string", - "example": "IoT Hub", - "description": "The name of a component inside the product which generated the alert" - }, - "vendorName": { - "readOnly": true, - "type": "string", - "example": "Microsoft", - "description": "The name of the vendor that raise the alert" - }, - "intent": { - "readOnly": true, - "type": "string", - "example": "Exploitation,Execution", - "description": "Kill chain related intent behind the alert. Could contain multiple enum values (separated by commas)", - "enum": [ - "Unknown", - "PreAttack", - "InitialAccess", - "Persistence", - "PrivilegeEscalation", - "DefenseEvasion", - "CredentialAccess", - "Discovery", - "LateralMovement", - "Execution", - "Collection", - "Exfiltration", - "CommandAndControl", - "Impact", - "Probing", - "Exploitation" - ], - "x-ms-enum": { - "name": "alertIntent", - "modelAsString": true, - "values": [ - { - "value": "Unknown" - }, - { - "value": "PreAttack" - }, - { - "value": "InitialAccess" - }, - { - "value": "Persistence" - }, - { - "value": "PrivilegeEscalation" - }, - { - "value": "DefenseEvasion" - }, - { - "value": "CredentialAccess" - }, - { - "value": "Discovery" - }, - { - "value": "LateralMovement" - }, - { - "value": "Execution" - }, - { - "value": "Collection" - }, - { - "value": "Exfiltration" - }, - { - "value": "CommandAndControl" - }, - { - "value": "Impact" - }, - { - "value": "Probing" - }, - { - "value": "Exploitation" - } - ] - } - }, - "remediationSteps": { - "readOnly": true, - "description": "Manual action items to take to remediate the alert", - "type": "array", - "items": { - "type": "string", - "example": "If the container doesn't need to run in privileged mode, remove the privileges from the container." - } - } - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotAlerts.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotAlerts.json deleted file mode 100644 index bdf74b5bb257..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotAlerts.json +++ /dev/null @@ -1,289 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Security Center", - "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", - "version": "2020-08-06-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": { - "/{scope}/providers/Microsoft.Security/iotAlerts": { - "get": { - "x-ms-examples": { - "List IoT Alerts": { - "$ref": "./examples/IotAlerts/GetIoTAlertList.json" - } - }, - "tags": [ - "IoT Security Alerts" - ], - "description": "List IoT alerts", - "operationId": "IotAlerts_List", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IotAlertScope" - }, - { - "in": "query", - "name": "startTimeUtc>", - "x-ms-client-name": "minStartTimeUtc", - "required": false, - "type": "string", - "description": "Filter by minimum startTimeUtc (ISO 8601 format)" - }, - { - "in": "query", - "name": "startTimeUtc<", - "x-ms-client-name": "maxStartTimeUtc", - "required": false, - "type": "string", - "description": "Filter by maximum startTimeUtc (ISO 8601 format)" - }, - { - "in": "query", - "name": "alertType", - "required": false, - "type": "string", - "description": "Filter by alert type" - }, - { - "in": "query", - "name": "deviceManagementType", - "required": false, - "type": "string", - "enum": [ - "Managed", - "Unmanaged" - ], - "description": "Get devices only from specific type, Managed or Unmanaged.", - "x-ms-enum": { - "name": "ManagementState", - "modelAsString": true - } - }, - { - "in": "query", - "name": "compromisedEntity", - "required": false, - "type": "string", - "description": "Filter by compromised device" - }, - { - "in": "query", - "name": "$limit", - "required": false, - "type": "integer", - "format": "int32", - "description": "Limit the number of items returned in a single page" - }, - { - "in": "query", - "name": "$skipToken", - "required": false, - "type": "string", - "description": "Skip token used for pagination" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/IotAlertListModel" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/{scope}/providers/Microsoft.Security/iotAlerts/{iotAlertId}": { - "get": { - "x-ms-examples": { - "Get IoT Alert": { - "$ref": "./examples/IotAlerts/GetIoTAlert.json" - } - }, - "tags": [ - "IoT Security Alerts" - ], - "operationId": "IotAlerts_Get", - "description": "Get IoT alert", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IotAlertScope" - }, - { - "in": "path", - "name": "iotAlertId", - "required": true, - "type": "string", - "description": "Id of the alert" - } - ], - "responses": { - "200": { - "description": "IoT alert", - "schema": { - "$ref": "#/definitions/IotAlertModel" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "IotAlertListModel": { - "description": "List of IoT alerts", - "type": "object", - "properties": { - "value": { - "description": "List data", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/IotAlertModel" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "When available, follow the URI to get the next page of data" - } - } - }, - "IotAlertModel": { - "type": "object", - "description": "IoT alert", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Alert properties", - "$ref": "#/definitions/IotAlertPropertiesModel" - } - }, - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/Resource" - } - ] - }, - "IotAlertPropertiesModel": { - "type": "object", - "description": "IoT alert properties", - "properties": { - "systemAlertId": { - "description": "Holds the product canonical identifier of the alert within the scope of a product", - "readOnly": true, - "type": "string", - "example": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8" - }, - "compromisedEntity": { - "description": "Display name of the main entity being reported on", - "readOnly": true, - "type": "string", - "example": "device-1" - }, - "alertType": { - "description": "The type name of the alert", - "readOnly": true, - "type": "string", - "example": "IoT_PrivilegedContainer" - }, - "startTimeUtc": { - "description": "The impact start time of the alert (the time of the first event or activity included in the alert)", - "readOnly": true, - "type": "string", - "example": "2020-05-13T06:32:25Z" - }, - "endTimeUtc": { - "description": "The impact end time of the alert (the time of the last event or activity included in the alert)", - "readOnly": true, - "type": "string", - "example": "2020-05-13T06:32:25Z" - }, - "entities": { - "description": "A list of entities related to the alert", - "type": "array", - "items": { - "type": "object" - }, - "example": [ - { - "$id": "1", - "CommandLine": "docker run --privileged", - "Type": "process" - } - ] - }, - "extendedProperties": { - "type": "object", - "description": "A bag of fields which extends the alert information", - "example": { - "CommandLine": "docker run --privileged", - "User Name": "aUser", - "UserId": "", - "ParentProcessId": 1593, - "DeviceId": "device-1" - } - } - } - } - }, - "parameters": { - "IotAlertScope": { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "Scope of the query: Subscription (i.e. /subscriptions/{subscriptionId}) or IoT Hub (i.e. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Devices/iotHubs/{iotHubName})", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotDefenderSettings.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotDefenderSettings.json deleted file mode 100644 index f0013fcc8cff..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotDefenderSettings.json +++ /dev/null @@ -1,579 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Security Center", - "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", - "version": "2020-08-06-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotDefenderSettings": { - "get": { - "x-ms-examples": { - "List IoT Defender settings": { - "$ref": "./examples/IotDefenderSettings/List.json" - } - }, - "tags": [ - "IoT Defender Settings" - ], - "description": "List IoT Defender Settings", - "operationId": "IotDefenderSettings_List", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/IotDefenderSettingsList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotDefenderSettings/default": { - "get": { - "x-ms-examples": { - "Get IoT Defender settings": { - "$ref": "./examples/IotDefenderSettings/Get.json" - } - }, - "tags": [ - "IoT Defender Settings" - ], - "operationId": "IotDefenderSettings_Get", - "description": "Get IoT Defender Settings", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - } - ], - "responses": { - "200": { - "description": "IoT Defender Settings", - "schema": { - "$ref": "#/definitions/IotDefenderSettingsModel" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - }, - "put": { - "x-ms-examples": { - "Create or update IoT Defender settings": { - "$ref": "./examples/IotDefenderSettings/Put.json" - } - }, - "tags": [ - "IoT Defender Settings" - ], - "operationId": "IotDefenderSettings_CreateOrUpdate", - "description": "Create or update IoT Defender settings", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/IotDefenderSettingsModel" - } - ], - "responses": { - "200": { - "description": "Updated IoT Defender settings", - "schema": { - "$ref": "#/definitions/IotDefenderSettingsModel" - } - }, - "201": { - "description": "Created IoT Defender settings", - "schema": { - "$ref": "#/definitions/IotDefenderSettingsModel" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - }, - "delete": { - "x-ms-examples": { - "Delete IoT Defender settings": { - "$ref": "./examples/IotDefenderSettings/Delete.json" - } - }, - "tags": [ - "IoT Defender Settings" - ], - "operationId": "IotDefenderSettings_Delete", - "description": "Delete IoT Defender settings", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - } - ], - "responses": { - "200": { - "description": "IoT Defender settings deleted" - }, - "204": { - "description": "IoT Defender settings does not exist" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotDefenderSettings/default/packageDownloads": { - "post": { - "x-ms-examples": { - "Package downloads": { - "$ref": "./examples/IotDefenderSettings/PackageDownloads.json" - } - }, - "tags": [ - "IoT Defender Settings" - ], - "operationId": "IotDefenderSettings_PackageDownloads", - "description": "Information about downloadable packages", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - } - ], - "responses": { - "200": { - "description": "Package downloads", - "schema": { - "$ref": "#/definitions/PackageDownloads" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotDefenderSettings/default/downloadManagerActivation": { - "post": { - "x-ms-examples": { - "Download quota data of the subscription": { - "$ref": "./examples/IotDefenderSettings/DownloadManagerActivation.json" - } - }, - "tags": [ - "IoT Defender Settings" - ], - "operationId": "IotDefenderSettings_DownloadManagerActivation", - "description": "Download manager activation data defined for this subscription", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - } - ], - "produces": [ - "application/zip" - ], - "responses": { - "200": { - "description": "Downloaded file", - "schema": { - "type": "object", - "format": "file" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "IotDefenderSettingsList": { - "description": "List of IoT Defender settings", - "type": "object", - "properties": { - "value": { - "description": "List data", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/IotDefenderSettingsModel" - } - } - } - }, - "IotDefenderSettingsModel": { - "type": "object", - "description": "IoT Defender settings", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "IoT Defender settings properties", - "$ref": "#/definitions/IotDefenderSettingsProperties" - } - }, - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/Resource" - } - ] - }, - "IotDefenderSettingsProperties": { - "type": "object", - "description": "IoT Defender settings properties", - "properties": { - "deviceQuota": { - "type": "integer", - "format": "int32", - "minimum": 1000, - "description": "Size of the device quota (as a opposed to a Pay as You Go billing model). Value is required to be in multiples of 1000." - }, - "sentinelWorkspaceResourceIds": { - "type": "array", - "description": "Sentinel Workspace Resource Ids", - "items": { - "type": "string" - } - }, - "onboardingKind": { - "type": "string", - "enum": [ - "Default", - "MigratedToAzure" - ], - "description": "The kind of onboarding for the subscription", - "x-ms-enum": { - "name": "OnboardingKind", - "modelAsString": true - } - } - }, - "required": [ - "deviceQuota", - "sentinelWorkspaceResourceIds", - "onboardingKind" - ] - }, - "DownloadLink": { - "type": "string", - "description": "Download link", - "readOnly": true - }, - "PackageDownloadInfo": { - "type": "object", - "description": "Information on a specific package download", - "properties": { - "version": { - "type": "string", - "description": "Version number", - "readOnly": true - }, - "link": { - "description": "Download link", - "$ref": "#/definitions/DownloadLink" - }, - "versionKind": { - "type": "string", - "description": "Kind of the version", - "readOnly": true, - "enum": [ - "Latest", - "Previous", - "Preview" - ], - "x-ms-enum": { - "name": "versionKind", - "modelAsString": true, - "values": [ - { - "value": "Latest" - }, - { - "value": "Previous" - }, - { - "value": "Preview" - } - ] - } - } - } - }, - "UpgradePackageDownloadInfo": { - "type": "object", - "description": "Information on a specific package upgrade download", - "properties": { - "fromVersion": { - "type": "string", - "description": "Minimum base version for upgrade", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "#/definitions/PackageDownloadInfo" - } - ] - }, - "PackageDownloads": { - "type": "object", - "description": "Information about package downloads", - "readOnly": true, - "properties": { - "sensor": { - "type": "object", - "description": "Contains all Sensor binary downloads", - "readOnly": true, - "properties": { - "full": { - "type": "object", - "description": "Contains full package downloads", - "readOnly": true, - "properties": { - "iso": { - "type": "array", - "description": "Contains all ISO full versions for the sensor", - "readOnly": true, - "items": { - "$ref": "#/definitions/PackageDownloadInfo" - } - }, - "ovf": { - "type": "object", - "description": "Contains all OVF (virtual machine) full versions for the sensor", - "properties": { - "enterprise": { - "type": "array", - "description": "Enterprise package type", - "readOnly": true, - "items": { - "$ref": "#/definitions/PackageDownloadInfo" - } - }, - "medium": { - "type": "array", - "description": "Medium package type", - "readOnly": true, - "items": { - "$ref": "#/definitions/PackageDownloadInfo" - } - }, - "line": { - "type": "array", - "description": "Line package type", - "readOnly": true, - "items": { - "$ref": "#/definitions/PackageDownloadInfo" - } - } - } - } - } - }, - "upgrade": { - "type": "array", - "description": "Sensor upgrade package downloads (on existing installations)", - "items": { - "$ref": "#/definitions/UpgradePackageDownloadInfo" - } - } - } - }, - "centralManager": { - "type": "object", - "description": "All downloads for Central Manager", - "readOnly": true, - "properties": { - "full": { - "type": "object", - "description": "Contains full package downloads", - "readOnly": true, - "properties": { - "iso": { - "type": "array", - "description": "Contains all ISO full versions of the Central Manager", - "readOnly": true, - "items": { - "$ref": "#/definitions/PackageDownloadInfo" - } - }, - "ovf": { - "type": "object", - "description": "Contains all OVF (virtual machine) full versions of the Central Manager", - "readOnly": true, - "properties": { - "enterprise": { - "type": "array", - "description": "The Enterprise package type", - "readOnly": true, - "items": { - "$ref": "#/definitions/PackageDownloadInfo" - } - }, - "enterpriseHighAvailability": { - "type": "array", - "description": "The EnterpriseHighAvailability package type", - "readOnly": true, - "items": { - "$ref": "#/definitions/PackageDownloadInfo" - } - }, - "medium": { - "type": "array", - "description": "The Medium package type", - "readOnly": true, - "items": { - "$ref": "#/definitions/PackageDownloadInfo" - } - }, - "mediumHighAvailability": { - "type": "array", - "description": "The MediumHighAvailability package type", - "readOnly": true, - "items": { - "$ref": "#/definitions/PackageDownloadInfo" - } - } - } - } - } - }, - "upgrade": { - "type": "array", - "description": "Central Manager upgrade package downloads (on existing installations)", - "readOnly": true, - "items": { - "$ref": "#/definitions/UpgradePackageDownloadInfo" - } - } - } - }, - "threatIntelligence": { - "type": "array", - "description": "All downloads for threat intelligence", - "readOnly": true, - "items": { - "$ref": "#/definitions/PackageDownloadInfo" - } - }, - "snmp": { - "type": "array", - "description": "SNMP Server file", - "readOnly": true, - "items": { - "$ref": "#/definitions/PackageDownloadInfo" - } - }, - "wmiTool": { - "type": "array", - "description": "Used for local configuration export", - "readOnly": true, - "items": { - "$ref": "#/definitions/PackageDownloadInfo" - } - }, - "authorizedDevicesImportTemplate": { - "type": "array", - "description": "Authorized devices import template", - "readOnly": true, - "items": { - "$ref": "#/definitions/PackageDownloadInfo" - } - }, - "deviceInformationUpdateImportTemplate": { - "type": "array", - "description": "Authorized devices import template", - "readOnly": true, - "items": { - "$ref": "#/definitions/PackageDownloadInfo" - } - } - } - } - }, - "parameters": { - "IotDefenderSettingsModel": { - "name": "iotDefenderSettingsModel", - "in": "body", - "required": true, - "description": "The IoT defender settings model", - "schema": { - "$ref": "#/definitions/IotDefenderSettingsModel" - }, - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotRecommendationTypes.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotRecommendationTypes.json deleted file mode 100644 index 9299fa3006e2..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotRecommendationTypes.json +++ /dev/null @@ -1,247 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Security Center", - "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", - "version": "2020-08-06-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotRecommendationTypes": { - "get": { - "x-ms-examples": { - "Get IoT Recommendation Types": { - "$ref": "./examples/IotRecommendationTypes/GetIoTRecommendationTypeList.json" - } - }, - "tags": [ - "IoT Security Recommendation Types" - ], - "description": "List IoT recommendation types", - "operationId": "IotRecommendationTypes_List", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/IotRecommendationTypeList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotRecommendationTypes/{iotRecommendationTypeName}": { - "get": { - "x-ms-examples": { - "Get IoT Recommendation Type": { - "$ref": "./examples/IotRecommendationTypes/GetIoTRecommendationType.json" - } - }, - "tags": [ - "IoT Security Recommendation Types" - ], - "operationId": "IotRecommendationTypes_Get", - "description": "Get IoT recommendation type", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "in": "path", - "name": "iotRecommendationTypeName", - "required": true, - "type": "string", - "description": "Name of the recommendation type" - } - ], - "responses": { - "200": { - "description": "IoT recommendation type", - "schema": { - "$ref": "#/definitions/IotRecommendationType" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "IotRecommendationTypeList": { - "type": "object", - "description": "List of recommendation types", - "properties": { - "value": { - "type": "array", - "description": "List data", - "items": { - "$ref": "#/definitions/IotRecommendationType" - } - } - } - }, - "IotRecommendationType": { - "type": "object", - "description": "IoT recommendation type.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Recommendation type properties", - "$ref": "#/definitions/IotRecommendationTypeProperties" - } - }, - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/Resource" - } - ] - }, - "IotRecommendationTypeProperties": { - "type": "object", - "description": "IoT recommendation type information.", - "properties": { - "recommendationDisplayName": { - "readOnly": true, - "type": "string", - "example": "TLS cipher suite upgrade needed", - "description": "The display name of the recommendation" - }, - "severity": { - "readOnly": true, - "type": "string", - "example": "Medium", - "description": "The severity of the recommendation", - "enum": [ - "Unknown", - "NotApplicable", - "Healthy", - "OffByPolicy", - "Low", - "Medium", - "High" - ], - "x-ms-enum": { - "name": "recommendationSeverity", - "modelAsString": true, - "values": [ - { - "value": "Unknown" - }, - { - "value": "NotApplicable" - }, - { - "value": "Healthy" - }, - { - "value": "OffByPolicy" - }, - { - "value": "Low" - }, - { - "value": "Medium" - }, - { - "value": "High" - } - ] - } - }, - "description": { - "readOnly": true, - "type": "string", - "description": "Description of the suspected vulnerability and meaning.", - "example": "Insecure TLS configurations detected. Immediate TLS cipher suite upgrade recommended." - }, - "productName": { - "readOnly": true, - "type": "string", - "example": "Azure Security Center for IoT", - "description": "The name of the product which published this recommendation" - }, - "productComponentName": { - "readOnly": true, - "type": "string", - "example": "IoT Hub", - "description": "The name of a component inside the product which generated the recommendation" - }, - "vendorName": { - "readOnly": true, - "type": "string", - "example": "Microsoft", - "description": "The name of the vendor that raised the recommendation" - }, - "control": { - "readOnly": true, - "type": "string", - "example": "Communication between device and IoT Hub is not optimized", - "description": "The name of the recommendation's control category " - }, - "remediationSteps": { - "readOnly": true, - "description": "Manual action items to take to resolve the recommendation", - "type": "array", - "items": { - "type": "string", - "example": "Upgrade your TLS cipher suite to a secure configuration. See the Guide to TLS Standards Compliance for more information." - } - }, - "dataSource": { - "readOnly": true, - "description": "The alert's data source", - "type": "string", - "example": "IoT Hub" - } - } - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotRecommendations.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotRecommendations.json deleted file mode 100644 index 325bc059bf72..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotRecommendations.json +++ /dev/null @@ -1,233 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Security Center", - "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", - "version": "2020-08-06-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": { - "/{scope}/providers/Microsoft.Security/iotRecommendations": { - "get": { - "x-ms-examples": { - "Get IoT Recommendations": { - "$ref": "./examples/IotRecommendations/GetIoTRecommendationList.json" - } - }, - "tags": [ - "IoT Security Recommendations" - ], - "description": "List IoT recommendations", - "operationId": "IotRecommendations_List", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IotRecommendationScope" - }, - { - "in": "query", - "name": "recommendationType", - "required": false, - "type": "string", - "description": "Filter by recommendation type" - }, - { - "in": "query", - "name": "deviceId", - "required": false, - "type": "string", - "description": "Filter by device id" - }, - { - "in": "query", - "name": "$limit", - "required": false, - "type": "integer", - "format": "int32", - "description": "Limit the number of items returned in a single page" - }, - { - "in": "query", - "name": "$skipToken", - "required": false, - "type": "string", - "description": "Skip token used for pagination" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/IotRecommendationListModel" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/{scope}/providers/Microsoft.Security/iotRecommendations/{iotRecommendationId}": { - "get": { - "x-ms-examples": { - "Get IoT Recommendation": { - "$ref": "./examples/IotRecommendations/GetIoTRecommendation.json" - } - }, - "tags": [ - "IoT Security Recommendations" - ], - "operationId": "IotRecommendations_Get", - "description": "Get IoT recommendation", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IotRecommendationScope" - }, - { - "in": "path", - "name": "iotRecommendationId", - "required": true, - "type": "string", - "description": "Id of the recommendation" - } - ], - "responses": { - "200": { - "description": "IoT recommendation", - "schema": { - "$ref": "#/definitions/IotRecommendationModel" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "IotRecommendationListModel": { - "description": "List of IoT recommendations", - "type": "object", - "properties": { - "value": { - "description": "List data", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/IotRecommendationModel" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "When available, follow the URI to get the next page of data" - } - } - }, - "IotRecommendationModel": { - "type": "object", - "description": "IoT recommendation", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Recommendation properties", - "$ref": "#/definitions/IotRecommendationPropertiesModel" - } - }, - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/Resource" - } - ] - }, - "IotRecommendationPropertiesModel": { - "type": "object", - "description": "IoT recommendation properties", - "properties": { - "deviceId": { - "description": "Identifier of the device being reported on", - "readOnly": true, - "type": "string", - "example": "device-1" - }, - "recommendationType": { - "description": "The type name of the recommendation", - "readOnly": true, - "type": "string", - "example": "IoT_PrivilegedContainer" - }, - "discoveredTimeUtc": { - "description": "The discovery time of the recommendation", - "readOnly": true, - "type": "string", - "example": "2020-05-13T06:32:25Z" - }, - "recommendationAdditionalData": { - "type": "object", - "description": "A bag of fields which extends the recommendation information", - "example": { - "SnapshotId": "48519d58-4e35-46cd-aed5-6251af95ed50", - "TotalFailedRules": "7", - "TotalRulesFailedDuoToError": "1", - "TotalInformationalFailedRules": "2", - "TotalCriticalFailedRules": "3", - "TotalWarningFailedRules": "1" - } - } - } - } - }, - "parameters": { - "IotRecommendationScope": { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "Scope of the query: Subscription (i.e. /subscriptions/{subscriptionId}) or IoT Hub (i.e. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Devices/iotHubs/{iotHubName})", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotSensors.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotSensors.json deleted file mode 100644 index 84c5e3886d07..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotSensors.json +++ /dev/null @@ -1,528 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Security Center", - "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", - "version": "2020-08-06-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": { - "/{scope}/providers/Microsoft.Security/iotSensors": { - "get": { - "x-ms-examples": { - "List IoT sensors": { - "$ref": "./examples/IotSensors/List.json" - } - }, - "tags": [ - "IoT Sensors" - ], - "description": "List IoT sensors", - "operationId": "IotSensors_List", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IotSensorScope" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/IotSensorsList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/{scope}/providers/Microsoft.Security/iotSensors/{iotSensorName}": { - "get": { - "x-ms-examples": { - "Get IoT sensor": { - "$ref": "./examples/IotSensors/Get.json" - } - }, - "tags": [ - "IoT Sensors" - ], - "operationId": "IotSensors_Get", - "description": "Get IoT sensor", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IotSensorScope" - }, - { - "$ref": "#/parameters/IotSensorName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/IotSensorsModel" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - }, - "put": { - "x-ms-examples": { - "Create or update IoT sensor": { - "$ref": "./examples/IotSensors/Put.json" - } - }, - "tags": [ - "IoT Sensors" - ], - "operationId": "IotSensors_CreateOrUpdate", - "description": "Create or update IoT sensor", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IotSensorScope" - }, - { - "$ref": "#/parameters/IotSensorName" - }, - { - "$ref": "#/parameters/IotSensorsModel" - } - ], - "responses": { - "200": { - "description": "Updated IoT sensor", - "schema": { - "$ref": "#/definitions/IotSensorsModel" - } - }, - "201": { - "description": "Created IoT sensor", - "schema": { - "$ref": "#/definitions/IotSensorsModel" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - }, - "delete": { - "x-ms-examples": { - "Delete IoT sensor": { - "$ref": "./examples/IotSensors/Delete.json" - } - }, - "tags": [ - "IoT Sensors" - ], - "operationId": "IotSensors_Delete", - "description": "Delete IoT sensor", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IotSensorScope" - }, - { - "$ref": "#/parameters/IotSensorName" - } - ], - "responses": { - "200": { - "description": "Deleted IoT sensor" - }, - "204": { - "description": "IoT sensor does not exist" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/{scope}/providers/Microsoft.Security/iotSensors/{iotSensorName}/downloadActivation": { - "post": { - "x-ms-examples": { - "Download activation file": { - "$ref": "./examples/IotSensors/DownloadActivation.json" - } - }, - "tags": [ - "IoT Sensors" - ], - "operationId": "IotSensors_DownloadActivation", - "description": "Download sensor activation file", - "produces": [ - "application/zip" - ], - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IotSensorScope" - }, - { - "$ref": "#/parameters/IotSensorName" - } - ], - "responses": { - "200": { - "description": "Downloaded activation file", - "schema": { - "type": "object", - "format": "file" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/{scope}/providers/Microsoft.Security/iotSensors/{iotSensorName}/downloadResetPassword": { - "post": { - "x-ms-examples": { - "Download file for reset password of the sensor": { - "$ref": "./examples/IotSensors/DownloadResetPassword.json" - } - }, - "tags": [ - "IoT Sensors" - ], - "operationId": "IotSensors_DownloadResetPassword", - "description": "Download file for reset password of the sensor", - "produces": [ - "application/zip" - ], - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IotSensorScope" - }, - { - "$ref": "#/parameters/IotSensorName" - }, - { - "in": "body", - "name": "body", - "required": true, - "description": "The reset password input.", - "schema": { - "$ref": "#/definitions/ResetPasswordInput" - }, - "x-ms-parameter-location": "method" - } - ], - "responses": { - "200": { - "description": "Downloaded reset password file", - "schema": { - "type": "object", - "format": "file" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/{scope}/providers/Microsoft.Security/iotSensors/{iotSensorName}/triggerTiPackageUpdate": { - "post": { - "x-ms-examples": { - "Trigger threat intelligence package update": { - "$ref": "./examples/IotSensors/TriggerTiPackageUpdate.json" - } - }, - "tags": [ - "IoT Sensors" - ], - "operationId": "IotSensors_TriggerTiPackageUpdate", - "description": "Trigger threat intelligence package update", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IotSensorScope" - }, - { - "$ref": "#/parameters/IotSensorName" - } - ], - "responses": { - "200": { - "description": "Triggered threat intelligence package update" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "IotSensorsList": { - "description": "List of IoT sensors", - "type": "object", - "properties": { - "value": { - "description": "List data", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/IotSensorsModel" - } - } - } - }, - "IotSensorsModel": { - "type": "object", - "description": "IoT sensor model", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "IoT sensor properties", - "$ref": "#/definitions/IotSensorProperties" - } - }, - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/Resource" - } - ] - }, - "IotSensorProperties": { - "type": "object", - "description": "IoT sensor properties", - "properties": { - "connectivityTime": { - "description": "Last connectivity time of the IoT sensor", - "readOnly": true, - "type": "string", - "example": "2020-11-17T12:31:25Z" - }, - "creationTime": { - "description": "Creation time of the IoT sensor", - "readOnly": true, - "type": "string", - "example": "2020-11-17T12:31:25Z" - }, - "dynamicLearning": { - "description": "Dynamic mode status of the IoT sensor", - "example": true, - "readOnly": true, - "type": "boolean" - }, - "learningMode": { - "description": "Learning mode status of the IoT sensor", - "example": true, - "readOnly": true, - "type": "boolean" - }, - "sensorStatus": { - "readOnly": true, - "type": "string", - "example": "Ok", - "description": "Status of the IoT sensor", - "enum": [ - "Ok", - "Disconnected", - "Unavailable" - ], - "x-ms-enum": { - "name": "sensorStatus", - "modelAsString": true, - "values": [ - { - "value": "Ok" - }, - { - "value": "Disconnected" - }, - { - "value": "Unavailable" - } - ] - } - }, - "sensorVersion": { - "description": "Version of the IoT sensor", - "readOnly": true, - "type": "string", - "example": "2020.11.01.1643" - }, - "tiAutomaticUpdates": { - "description": "TI Automatic mode status of the IoT sensor", - "example": true, - "type": "boolean" - }, - "tiStatus": { - "readOnly": true, - "type": "string", - "example": "Ok", - "description": "TI Status of the IoT sensor", - "enum": [ - "Ok", - "Failed", - "InProgress", - "UpdateAvailable" - ], - "x-ms-enum": { - "name": "tiStatus", - "modelAsString": true, - "values": [ - { - "value": "Ok" - }, - { - "value": "Failed" - }, - { - "value": "InProgress" - }, - { - "value": "UpdateAvailable" - } - ] - } - }, - "tiVersion": { - "description": "TI Version of the IoT sensor", - "readOnly": true, - "type": "string", - "example": "2020-11-17T12:31:25Z" - }, - "zone": { - "type": "string", - "description": "Zone of the IoT sensor", - "example": "A12" - }, - "sensorType": { - "description": "Type of sensor", - "example": "Ot", - "type": "string", - "enum": [ - "Ot", - "Enterprise" - ], - "x-ms-enum": { - "name": "sensorType", - "modelAsString": true, - "values": [ - { - "value": "Ot" - }, - { - "value": "Enterprise" - } - ] - } - } - } - }, - "ResetPasswordInput": { - "type": "object", - "description": "Reset password input.", - "properties": { - "applianceId": { - "description": "The appliance id of the sensor.", - "type": "string" - } - } - } - }, - "parameters": { - "IotSensorScope": { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "Scope of the query (IoT Hub, /providers/Microsoft.Devices/iotHubs/myHub)", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true - }, - "IotSensorName": { - "name": "iotSensorName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of the IoT sensor", - "x-ms-parameter-location": "method" - }, - "IotSensorsModel": { - "name": "iotSensorsModel", - "in": "body", - "required": true, - "description": "The IoT sensor model", - "schema": { - "$ref": "#/definitions/IotSensorsModel" - }, - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotSites.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotSites.json deleted file mode 100644 index 085ac8e072fb..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotSites.json +++ /dev/null @@ -1,260 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Security Center", - "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", - "version": "2020-08-06-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": { - "/{scope}/providers/Microsoft.Security/iotSites": { - "get": { - "x-ms-examples": { - "List IoT sites": { - "$ref": "./examples/IotSites/List.json" - } - }, - "tags": [ - "IoT Sites" - ], - "description": "List IoT sites", - "operationId": "IotSites_List", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IotSiteScope" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/IotSitesList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/{scope}/providers/Microsoft.Security/iotSites/default": { - "get": { - "x-ms-examples": { - "Get IoT site": { - "$ref": "./examples/IotSites/Get.json" - } - }, - "tags": [ - "IoT Sites" - ], - "operationId": "IotSites_Get", - "description": "Get IoT site", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IotSiteScope" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/IotSitesModel" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - }, - "put": { - "x-ms-examples": { - "Create or update IoT site": { - "$ref": "./examples/IotSites/Put.json" - } - }, - "tags": [ - "IoT Sites" - ], - "operationId": "IotSites_CreateOrUpdate", - "description": "Create or update IoT site", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IotSiteScope" - }, - { - "$ref": "#/parameters/IotSitesModel" - } - ], - "responses": { - "200": { - "description": "Updated IoT site", - "schema": { - "$ref": "#/definitions/IotSitesModel" - } - }, - "201": { - "description": "Created IoT site", - "schema": { - "$ref": "#/definitions/IotSitesModel" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - }, - "delete": { - "x-ms-examples": { - "Delete IoT site": { - "$ref": "./examples/IotSites/Delete.json" - } - }, - "tags": [ - "IoT Sites" - ], - "operationId": "IotSites_Delete", - "description": "Delete IoT site", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/IotSiteScope" - } - ], - "responses": { - "200": { - "description": "Deleted IoT site" - }, - "204": { - "description": "IoT site does not exist" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "IotSitesList": { - "description": "List of IoT sites", - "type": "object", - "properties": { - "value": { - "description": "List data", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/IotSitesModel" - } - } - } - }, - "IotSitesModel": { - "type": "object", - "description": "IoT site model", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "IoT site properties", - "$ref": "#/definitions/IotSiteProperties" - } - }, - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/Resource" - } - ] - }, - "IotSiteProperties": { - "type": "object", - "description": "IoT site properties", - "properties": { - "displayName": { - "type": "string", - "description": "Display name of the IoT site" - }, - "tags": { - "type": "object", - "description": "Tags of the IoT site", - "additionalProperties": { - "type": "string" - } - } - }, - "required": [ - "displayName" - ] - } - }, - "parameters": { - "IotSiteScope": { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "Scope of the query (IoT Hub, /providers/Microsoft.Devices/iotHubs/myHub)", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true - }, - "IotSitesModel": { - "name": "iotSitesModel", - "in": "body", - "required": true, - "description": "The IoT sites model", - "schema": { - "$ref": "#/definitions/IotSitesModel" - }, - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/onPremiseIotSensors.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/onPremiseIotSensors.json deleted file mode 100644 index 97492fd35bed..000000000000 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/onPremiseIotSensors.json +++ /dev/null @@ -1,346 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Security Center", - "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", - "version": "2020-08-06-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/onPremiseIotSensors": { - "get": { - "x-ms-examples": { - "List on-premise IoT sensors": { - "$ref": "./examples/OnPremiseIotSensors/List.json" - } - }, - "tags": [ - "On-Premise IoT Sensors" - ], - "description": "List on-premise IoT sensors", - "operationId": "OnPremiseIotSensors_List", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/OnPremiseIotSensorsList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/onPremiseIotSensors/{onPremiseIotSensorName}": { - "get": { - "x-ms-examples": { - "Get on-premise IoT sensor": { - "$ref": "./examples/OnPremiseIotSensors/Get.json" - } - }, - "tags": [ - "On-Premise IoT Sensors" - ], - "operationId": "OnPremiseIotSensors_Get", - "description": "Get on-premise IoT sensor", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/OnPremiseIotSensorName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/OnPremiseIotSensor" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - }, - "put": { - "x-ms-examples": { - "Create or update on-premise IoT sensor": { - "$ref": "./examples/OnPremiseIotSensors/Put.json" - } - }, - "tags": [ - "On-Premise IoT Sensors" - ], - "operationId": "OnPremiseIotSensors_CreateOrUpdate", - "description": "Create or update on-premise IoT sensor", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/OnPremiseIotSensorName" - } - ], - "responses": { - "200": { - "description": "Updated on-premise IoT sensor", - "schema": { - "$ref": "#/definitions/OnPremiseIotSensor" - } - }, - "201": { - "description": "Created on-premise IoT sensor", - "schema": { - "$ref": "#/definitions/OnPremiseIotSensor" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - }, - "delete": { - "x-ms-examples": { - "Delete on-premise IoT sensor": { - "$ref": "./examples/OnPremiseIotSensors/Delete.json" - } - }, - "tags": [ - "On-Premise IoT Sensors" - ], - "operationId": "OnPremiseIotSensors_Delete", - "description": "Delete on-premise IoT sensor", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/OnPremiseIotSensorName" - } - ], - "responses": { - "200": { - "description": "Deleted on-premise IoT sensor" - }, - "204": { - "description": "On-premise IoT sensor does not exist" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/onPremiseIotSensors/{onPremiseIotSensorName}/downloadActivation": { - "post": { - "x-ms-examples": { - "Download activation file": { - "$ref": "./examples/OnPremiseIotSensors/DownloadActivation.json" - } - }, - "tags": [ - "On-Premise IoT Sensors" - ], - "operationId": "OnPremiseIotSensors_DownloadActivation", - "description": "Download sensor activation file", - "produces": [ - "application/zip" - ], - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/OnPremiseIotSensorName" - } - ], - "responses": { - "200": { - "description": "Downloaded activation file", - "schema": { - "type": "object", - "format": "file" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/onPremiseIotSensors/{onPremiseIotSensorName}/downloadResetPassword": { - "post": { - "x-ms-examples": { - "Download file for reset password of the sensor": { - "$ref": "./examples/OnPremiseIotSensors/DownloadResetPassword.json" - } - }, - "tags": [ - "IoT Sensors" - ], - "operationId": "OnPremiseIotSensors_DownloadResetPassword", - "description": "Download file for reset password of the sensor", - "produces": [ - "application/zip" - ], - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/OnPremiseIotSensorName" - }, - { - "in": "body", - "name": "body", - "required": true, - "description": "Input for reset password.", - "schema": { - "$ref": "#/definitions/ResetPasswordInput" - }, - "x-ms-parameter-location": "method" - } - ], - "responses": { - "200": { - "description": "Downloaded reset password file", - "schema": { - "type": "object", - "format": "file" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "OnPremiseIotSensorsList": { - "description": "List of on-premise IoT sensors", - "type": "object", - "properties": { - "value": { - "description": "List data", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/OnPremiseIotSensor" - } - } - } - }, - "OnPremiseIotSensor": { - "type": "object", - "description": "On-premise IoT sensor", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "On-premise IoT sensor properties", - "$ref": "#/definitions/OnPremiseIotSensorProperties" - } - }, - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/Resource" - } - ] - }, - "OnPremiseIotSensorProperties": { - "type": "object", - "description": "On-premise IoT sensor properties", - "properties": {} - }, - "ResetPasswordInput": { - "description": "Reset password input.", - "type": "object", - "properties": { - "applianceId": { - "description": "The appliance id of the sensor.", - "type": "string" - } - } - } - }, - "parameters": { - "OnPremiseIotSensorName": { - "name": "onPremiseIotSensorName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of the on-premise IoT sensor", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/applicationWhitelistings.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/applicationWhitelistings.json index 4bfa1d9d474d..4c449c09d25e 100644 --- a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/applicationWhitelistings.json +++ b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/applicationWhitelistings.json @@ -553,10 +553,6 @@ "description": "Include the policy rules", "type": "boolean", "required": false, - "enum": [ - false, - true - ], "x-ms-parameter-location": "method" }, "Summary": { @@ -565,10 +561,6 @@ "description": "Return output in a summarized form", "type": "boolean", "required": false, - "enum": [ - false, - true - ], "x-ms-parameter-location": "method" }, "AdaptiveApplicationControlGroup": { diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2021-06-01/examples/Settings/GetSetting_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2021-06-01/examples/Settings/GetSetting_example.json new file mode 100644 index 000000000000..7fbbed710058 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2021-06-01/examples/Settings/GetSetting_example.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "settingName": "MCAS" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/MCAS", + "name": "MCAS", + "kind": "DataExportSettings", + "type": "Microsoft.Security/settings", + "properties": { + "enabled": true + } + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2021-06-01/examples/Settings/GetSettings_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2021-06-01/examples/Settings/GetSettings_example.json new file mode 100644 index 000000000000..f38c7c97cf2d --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2021-06-01/examples/Settings/GetSettings_example.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/MCAS", + "name": "MCAS", + "kind": "DataExportSettings", + "type": "Microsoft.Security/settings", + "properties": { + "enabled": true + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/WDATP", + "name": "WDATP", + "kind": "DataExportSettings", + "type": "Microsoft.Security/settings", + "properties": { + "enabled": false + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/Sentinel", + "name": "Sentinel", + "kind": "AlertSyncSettings", + "type": "Microsoft.Security/settings", + "properties": { + "enabled": false + } + } + ] + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2021-06-01/examples/Settings/UpdateSetting_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2021-06-01/examples/Settings/UpdateSetting_example.json new file mode 100644 index 000000000000..ece31475d6eb --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2021-06-01/examples/Settings/UpdateSetting_example.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2021-06-01", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "settingName": "MCAS", + "setting": { + "kind": "DataExportSettings", + "properties": { + "enabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/MCAS", + "name": "MCAS", + "kind": "DataExportSettings", + "type": "Microsoft.Security/settings", + "properties": { + "enabled": true + } + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2021-06-01/settings.json b/specification/security/resource-manager/Microsoft.Security/stable/2021-06-01/settings.json new file mode 100644 index 000000000000..156684886bc3 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2021-06-01/settings.json @@ -0,0 +1,300 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Center", + "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", + "version": "2021-06-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.Security/settings": { + "get": { + "x-ms-examples": { + "Get settings of subscription": { + "$ref": "./examples/Settings/GetSettings_example.json" + } + }, + "tags": [ + "Settings" + ], + "description": "Settings about different configurations in security center", + "operationId": "Settings_List", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SettingsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/settings/{settingName}": { + "get": { + "x-ms-examples": { + "Get a setting on subscription": { + "$ref": "./examples/Settings/GetSetting_example.json" + } + }, + "tags": [ + "Settings" + ], + "description": "Settings of different configurations in security center", + "operationId": "Settings_Get", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/SettingName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Setting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Update a setting for subscription": { + "$ref": "./examples/Settings/UpdateSetting_example.json" + } + }, + "tags": [ + "Settings" + ], + "description": "updating settings about different configurations in security center", + "operationId": "Settings_Update", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/SettingName" + }, + { + "$ref": "#/parameters/Setting" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Setting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "SettingsList": { + "type": "object", + "description": "Subscription settings list.", + "properties": { + "value": { + "type": "array", + "description": "The settings list.", + "items": { + "$ref": "#/definitions/Setting" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "DataExportSettings": { + "type": "object", + "description": "Represents a data export setting", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Data export setting data", + "$ref": "#/definitions/DataExportSettingProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Setting" + } + ], + "x-ms-discriminator-value": "DataExportSettings" + }, + "AlertSyncSettings": { + "type": "object", + "description": "Represents an alert sync setting", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Alert sync setting data", + "$ref": "#/definitions/AlertSyncSettingProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Setting" + } + ], + "x-ms-discriminator-value": "AlertSyncSettings" + }, + "Setting": { + "type": "object", + "description": "The kind of the security setting", + "properties": { + "kind": { + "type": "string", + "description": "the kind of the settings string", + "enum": [ + "DataExportSettings", + "AlertSuppressionSetting", + "AlertSyncSettings" + ], + "x-ms-enum": { + "name": "SettingKind", + "modelAsString": true, + "values": [ + { + "value": "DataExportSettings" + }, + { + "value": "AlertSuppressionSetting" + }, + { + "value": "AlertSyncSettings" + } + ] + } + } + }, + "discriminator": "kind", + "required": [ + "kind" + ], + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/Resource" + } + ] + }, + "DataExportSettingProperties": { + "type": "object", + "description": "The data export setting properties", + "properties": { + "enabled": { + "type": "boolean", + "description": "Is the data export setting enabled" + } + }, + "required": [ + "enabled" + ] + }, + "AlertSyncSettingProperties": { + "type": "object", + "description": "The alert sync setting properties", + "properties": { + "enabled": { + "type": "boolean", + "description": "Is the alert sync setting enabled" + } + }, + "required": [ + "enabled" + ] + } + }, + "parameters": { + "SettingName": { + "name": "settingName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the setting", + "enum": [ + "MCAS", + "WDATP", + "Sentinel" + ], + "x-ms-parameter-location": "method" + }, + "Setting": { + "name": "setting", + "in": "body", + "required": true, + "description": "Setting object", + "schema": { + "$ref": "#/definitions/Setting" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2021-07-01/examples/Settings/GetSetting_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2021-07-01/examples/Settings/GetSetting_example.json new file mode 100644 index 000000000000..1ac66c2d42d9 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2021-07-01/examples/Settings/GetSetting_example.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "settingName": "MCAS" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/MCAS", + "name": "MCAS", + "kind": "DataExportSettings", + "type": "Microsoft.Security/settings", + "properties": { + "enabled": true + } + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2021-07-01/examples/Settings/GetSettings_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2021-07-01/examples/Settings/GetSettings_example.json new file mode 100644 index 000000000000..220cdf57cfea --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2021-07-01/examples/Settings/GetSettings_example.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/MCAS", + "name": "MCAS", + "kind": "DataExportSettings", + "type": "Microsoft.Security/settings", + "properties": { + "enabled": true + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/WDATP", + "name": "WDATP", + "kind": "DataExportSettings", + "type": "Microsoft.Security/settings", + "properties": { + "enabled": false + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/WDATP_EXCLUDE_LINUX_PUBLIC_PREVIEW", + "name": "WDATP_EXCLUDE_LINUX_PUBLIC_PREVIEW", + "kind": "DataExportSettings", + "type": "Microsoft.Security/settings", + "properties": { + "enabled": false + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/Sentinel", + "name": "Sentinel", + "kind": "AlertSyncSettings", + "type": "Microsoft.Security/settings", + "properties": { + "enabled": false + } + } + ] + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2021-07-01/examples/Settings/UpdateSetting_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2021-07-01/examples/Settings/UpdateSetting_example.json new file mode 100644 index 000000000000..659eca933372 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2021-07-01/examples/Settings/UpdateSetting_example.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2021-07-01", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "settingName": "MCAS", + "setting": { + "kind": "DataExportSettings", + "properties": { + "enabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/MCAS", + "name": "MCAS", + "kind": "DataExportSettings", + "type": "Microsoft.Security/settings", + "properties": { + "enabled": true + } + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2021-07-01/settings.json b/specification/security/resource-manager/Microsoft.Security/stable/2021-07-01/settings.json new file mode 100644 index 000000000000..e1aca0eb04e7 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2021-07-01/settings.json @@ -0,0 +1,301 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Center", + "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", + "version": "2021-07-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.Security/settings": { + "get": { + "x-ms-examples": { + "Get settings of subscription": { + "$ref": "./examples/Settings/GetSettings_example.json" + } + }, + "tags": [ + "Settings" + ], + "description": "Settings about different configurations in security center", + "operationId": "Settings_List", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SettingsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/settings/{settingName}": { + "get": { + "x-ms-examples": { + "Get a setting on subscription": { + "$ref": "./examples/Settings/GetSetting_example.json" + } + }, + "tags": [ + "Settings" + ], + "description": "Settings of different configurations in security center", + "operationId": "Settings_Get", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/SettingName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Setting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Update a setting for subscription": { + "$ref": "./examples/Settings/UpdateSetting_example.json" + } + }, + "tags": [ + "Settings" + ], + "description": "updating settings about different configurations in security center", + "operationId": "Settings_Update", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/SettingName" + }, + { + "$ref": "#/parameters/Setting" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Setting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "SettingsList": { + "type": "object", + "description": "Subscription settings list.", + "properties": { + "value": { + "type": "array", + "description": "The settings list.", + "items": { + "$ref": "#/definitions/Setting" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "DataExportSettings": { + "type": "object", + "description": "Represents a data export setting", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Data export setting data", + "$ref": "#/definitions/DataExportSettingProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Setting" + } + ], + "x-ms-discriminator-value": "DataExportSettings" + }, + "AlertSyncSettings": { + "type": "object", + "description": "Represents an alert sync setting", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Alert sync setting data", + "$ref": "#/definitions/AlertSyncSettingProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Setting" + } + ], + "x-ms-discriminator-value": "AlertSyncSettings" + }, + "Setting": { + "type": "object", + "description": "The kind of the security setting", + "properties": { + "kind": { + "type": "string", + "description": "the kind of the settings string", + "enum": [ + "DataExportSettings", + "AlertSuppressionSetting", + "AlertSyncSettings" + ], + "x-ms-enum": { + "name": "SettingKind", + "modelAsString": true, + "values": [ + { + "value": "DataExportSettings" + }, + { + "value": "AlertSuppressionSetting" + }, + { + "value": "AlertSyncSettings" + } + ] + } + } + }, + "discriminator": "kind", + "required": [ + "kind" + ], + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/Resource" + } + ] + }, + "DataExportSettingProperties": { + "type": "object", + "description": "The data export setting properties", + "properties": { + "enabled": { + "type": "boolean", + "description": "Is the data export setting enabled" + } + }, + "required": [ + "enabled" + ] + }, + "AlertSyncSettingProperties": { + "type": "object", + "description": "The alert sync setting properties", + "properties": { + "enabled": { + "type": "boolean", + "description": "Is the alert sync setting enabled" + } + }, + "required": [ + "enabled" + ] + } + }, + "parameters": { + "SettingName": { + "name": "settingName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the setting", + "enum": [ + "MCAS", + "WDATP", + "WDATP_EXCLUDE_LINUX_PUBLIC_PREVIEW", + "Sentinel" + ], + "x-ms-parameter-location": "method" + }, + "Setting": { + "name": "setting", + "in": "body", + "required": true, + "description": "Setting object", + "schema": { + "$ref": "#/definitions/Setting" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/security/resource-manager/readme.java.md b/specification/security/resource-manager/readme.java.md new file mode 100644 index 000000000000..b990427bd4eb --- /dev/null +++ b/specification/security/resource-manager/readme.java.md @@ -0,0 +1,16 @@ +## Java + +These settings apply only when `--java` is specified on the command line. + + +``` yaml $(java) +directive: + - from: externalSecuritySolutions.json + where: $.definitions.ExternalSecuritySolution.allOf[1] + set: + type: object + reason: discriminator property is required to be defined in the model + - from: externalSecuritySolutions.json + where: $.definitions + transform: $.ExternalSecuritySolution.properties = $.ExternalSecuritySolutionKind.properties +``` diff --git a/specification/security/resource-manager/readme.md b/specification/security/resource-manager/readme.md index 23c851a84205..d4b674a1eb50 100644 --- a/specification/security/resource-manager/readme.md +++ b/specification/security/resource-manager/readme.md @@ -36,30 +36,6 @@ directive: from: iotSecuritySolutionAnalytics.json where: '$.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName}/analyticsModels"].get' reason: The list returns limited number of items - - suppress: PageableOperation - from: alertTypes.json - where: '$.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName}/alertTypes"].get' - reason: The list returns limited number of items - - suppress: PageableOperation - from: recommendationTypes.json - where: '$.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName}/recommendationTypes"].get' - reason: The list returns limited number of items - - suppress: PageableOperation - from: iotDefenderSettings.json - where: '$.paths["/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotDefenderSettings"].get' - reason: The list returns limited number of items - - suppress: PageableOperation - from: iotSensors.json - where: '$.paths["/{scope}/providers/Microsoft.Security/iotSensors/{iotSensorName}"].get' - reason: The list returns limited number of items - - suppress: PageableOperation - from: onPremiseIotSensors.json - where: '$.paths["/subscriptions/{subscriptionId}/providers/Microsoft.Security/onPremiseIotSensors"].get' - reason: The list returns limited number of items - - suppress: TopLevelResourcesListByResourceGroup - from: onPremiseIotSensors.json - where: $.definitions.OnPremiseIotSensor - reason: The resource is managed in a subscription level (instead of inside a resource group) - suppress: SECRET_PROPERTY from: ingestionSettings.json where: $.definitions.IngestionSettingToken.properties.token @@ -182,15 +158,10 @@ These settings apply only when `--tag=package-composite-v3` is specified on the input-file: - Microsoft.Security/stable/2017-08-01/complianceResults.json - Microsoft.Security/stable/2018-06-01/pricings.json -- Microsoft.Security/stable/2019-01-01/settings.json - Microsoft.Security/stable/2019-01-01/advancedThreatProtectionSettings.json - Microsoft.Security/stable/2019-08-01/deviceSecurityGroups.json - Microsoft.Security/stable/2019-08-01/iotSecuritySolutions.json - Microsoft.Security/stable/2019-08-01/iotSecuritySolutionAnalytics.json -- Microsoft.Security/stable/2019-08-01/iotAlertTypes.json -- Microsoft.Security/stable/2019-08-01/iotAlerts.json -- Microsoft.Security/stable/2019-08-01/iotRecommendationTypes.json -- Microsoft.Security/stable/2019-08-01/iotRecommendations.json - Microsoft.Security/preview/2015-06-01-preview/locations.json - Microsoft.Security/preview/2015-06-01-preview/operations.json - Microsoft.Security/preview/2015-06-01-preview/tasks.json @@ -220,16 +191,8 @@ input-file: - Microsoft.Security/preview/2020-07-01-preview/sqlVulnerabilityAssessmentsScanOperations.json - Microsoft.Security/preview/2020-07-01-preview/sqlVulnerabilityAssessmentsScanResultsOperations.json - Microsoft.Security/preview/2020-07-01-preview/sqlVulnerabilityAssessmentsBaselineRuleOperations.json -- Microsoft.Security/preview/2020-08-06-preview/iotDefenderSettings.json -- Microsoft.Security/preview/2020-08-06-preview/iotSensors.json -- Microsoft.Security/preview/2020-08-06-preview/devices.json -- Microsoft.Security/preview/2020-08-06-preview/onPremiseIotSensors.json -- Microsoft.Security/preview/2020-08-06-preview/iotSites.json -- Microsoft.Security/preview/2020-08-06-preview/iotAlerts.json -- Microsoft.Security/preview/2020-08-06-preview/iotAlertTypes.json -- Microsoft.Security/preview/2020-08-06-preview/iotRecommendations.json -- Microsoft.Security/preview/2020-08-06-preview/iotRecommendationTypes.json - Microsoft.Security/stable/2021-01-01/alerts.json +- Microsoft.Security/stable/2021-07-01/settings.json - Microsoft.Security/preview/2021-01-15-preview/ingestionSettings.json - Microsoft.Security/preview/2021-05-01-preview/softwareInventories.json @@ -426,27 +389,6 @@ override-info: title: SecurityCenter ``` -### Tag: package-2020-08-preview-only - -These settings apply only when `--tag=package-2020-08-preview-only` is specified on the command line. This tag is used for Ruby SDK. - -``` yaml $(tag) == 'package-2020-08-preview-only' -input-file: -- Microsoft.Security/preview/2020-08-06-preview/iotDefenderSettings.json -- Microsoft.Security/preview/2020-08-06-preview/iotSensors.json -- Microsoft.Security/preview/2020-08-06-preview/devices.json -- Microsoft.Security/preview/2020-08-06-preview/onPremiseIotSensors.json -- Microsoft.Security/preview/2020-08-06-preview/iotSites.json -- Microsoft.Security/preview/2020-08-06-preview/iotAlerts.json -- Microsoft.Security/preview/2020-08-06-preview/iotAlertTypes.json -- Microsoft.Security/preview/2020-08-06-preview/iotRecommendations.json -- Microsoft.Security/preview/2020-08-06-preview/iotRecommendationTypes.json - -# Needed when there is more than one input file -override-info: - title: SecurityCenter -``` - ### Tag: package-2021-01-preview-only These settings apply only when `--tag=package-2021-01-preview-only` is specified on the command line. This tag is used for Ruby SDK. @@ -472,6 +414,19 @@ override-info: title: SecurityCenter ``` +### Tag: package-2021-06-only + +These settings apply only when `--tag=package-2021-06-only` is specified on the command line. This tag is used for Ruby SDK. + +``` yaml $(tag) == 'package-2021-06-only' +input-file: +- Microsoft.Security/stable/2021-06-01/settings.json + +# Needed when there is more than one input file +override-info: + title: SecurityCenter +``` + --- # Code Generation @@ -486,8 +441,10 @@ swagger-to-sdk: - repo: azure-sdk-for-net - repo: azure-sdk-for-go - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-js - repo: azure-sdk-for-node + - repo: azure-sdk-for-java - repo: azure-resource-manager-schemas ``` @@ -515,4 +472,6 @@ See configuration in [readme.typescript.md](./readme.typescript.md) See configuration in [readme.ruby.md](./readme.ruby.md) +## Java +See configuration in [readme.java.md](./readme.java.md) diff --git a/specification/security/resource-manager/readme.python.md b/specification/security/resource-manager/readme.python.md index 46bfb3c58b8f..448922f953a8 100644 --- a/specification/security/resource-manager/readme.python.md +++ b/specification/security/resource-manager/readme.python.md @@ -4,7 +4,7 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) +``` yaml $(python) && !$(track2) python-mode: create python: azure-arm: true @@ -15,13 +15,53 @@ python: package-version: 0.1.0 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' +``` yaml $(python) && $(track2) +python-mode: create +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +namespace: azure.mgmt.security +package-name: azure-mgmt-security +package-version: 1.0.0b1 +clear-output-folder: true +modelerfour: + lenient-model-deduplication: true +``` + +``` yaml $(python) && $(python-mode) == 'update' && !$(track2) python: no-namespace-folders: true output-folder: $(python-sdks-folder)/security/azure-mgmt-security/azure/mgmt/security ``` -``` yaml $(python) && $(python-mode) == 'create' +``` yaml $(python) && $(python-mode) == 'create' && !$(track2) python: basic-setup-py: true output-folder: $(python-sdks-folder)/security/azure-mgmt-security ``` +``` yaml $(python) && $(python-mode) == 'update' && $(track2) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/security/azure-mgmt-security/azure/mgmt/security +``` +``` yaml $(python) && $(python-mode) == 'create' && $(track2) +basic-setup-py: true +output-folder: $(python-sdks-folder)/security/azure-mgmt-security +``` + +```yaml $(python) && $(track2) +directive: + - from: swagger-document + where: $.definitions.AadConnectivityState.properties.connectivityState + transform: > + $['x-ms-enum']['name'] = 'AadConnectivityStateEnum'; + - from: swagger-document + where: $.definitions.ExternalSecuritySolutionKind.properties.kind + transform: > + $['x-ms-enum']['name'] = 'ExternalSecuritySolutionKindEnum'; + - from: jitNetworkAccessPolicies.json + where: $.definitions.JitNetworkAccessPortRule.properties.protocol + transform: > + $['x-ms-enum']['name'] = 'protocolEnum'; + - from: alerts.json + where: $.definitions.AlertSimulatorRequestProperties.properties.kind + transform: > + $['x-ms-enum']['name'] = 'kindEnum'; +``` \ No newline at end of file diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Aggregations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Aggregations.json new file mode 100644 index 000000000000..8a9169fe9391 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Aggregations.json @@ -0,0 +1,97 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2019-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/aggregations/{aggregationsName}": { + "get": { + "x-ms-examples": { + "Get aggregative data for all cases under the defined workspace, between the time range if specified.": { + "$ref": "./examples/aggregations/GetCasesAggregations.json" + } + }, + "tags": [ + "Aggregations" + ], + "description": "Get aggregative result for the given resources under the defined workspace", + "operationId": "CasesAggregations_Get", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/AggregationsName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "SecurityInsights.json#/definitions/Aggregations" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + } + } + }, + "parameters": { + "AggregationsName": { + "description": "The aggregation name. Supports - Cases", + "in": "path", + "name": "aggregationsName", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "definitions": {} +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/AutomationRules.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/AutomationRules.json new file mode 100644 index 000000000000..d791361dca51 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/AutomationRules.json @@ -0,0 +1,918 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2019-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/automationRules": { + "get": { + "x-ms-examples": { + "Get all automation rules.": { + "$ref": "./examples/automationRules/GetAllAutomationRules.json" + } + }, + "tags": [ + "Automation Rules" + ], + "description": "Gets all automation rules.", + "operationId": "AutomationRules_List", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AutomationRulesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/automationRules/{automationRuleId}": { + "get": { + "x-ms-examples": { + "Get an automation rule.": { + "$ref": "./examples/automationRules/GetAutomationRule.json" + } + }, + "tags": [ + "Automation Rules" + ], + "description": "Gets the automation rule.", + "operationId": "AutomationRules_Get", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/AutomationRuleId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AutomationRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates an automation rule.": { + "$ref": "./examples/automationRules/CreateAutomationRule.json" + } + }, + "tags": [ + "Automation Rules" + ], + "description": "Creates or updates the automation rule.", + "operationId": "AutomationRules_CreateOrUpdate", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/AutomationRuleId" + }, + { + "$ref": "#/parameters/AutomationRule" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AutomationRule" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/AutomationRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete an automation rule.": { + "$ref": "./examples/automationRules/DeleteAutomationRule.json" + } + }, + "tags": [ + "Automation Rule" + ], + "description": "Delete the automation rule.", + "operationId": "AutomationRules_Delete", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/AutomationRuleId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + } + } + }, + "parameters": { + "AutomationRule": { + "description": "The automation rule", + "in": "body", + "name": "automationRule", + "required": true, + "schema": { + "$ref": "#/definitions/AutomationRule" + }, + "x-ms-parameter-location": "method" + }, + "AutomationRuleId": { + "description": "Automation rule ID", + "in": "path", + "name": "automationRuleId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "AutomationRule": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents an automation rule.", + "properties": { + "properties": { + "$ref": "#/definitions/AutomationRuleProperties", + "description": "Automation rule properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "AutomationRuleAction": { + "description": "Describes an automation rule action", + "discriminator": "actionType", + "properties": { + "order": { + "description": "The order of execution of the automation rule action", + "type": "integer", + "format": "int32" + }, + "actionType": { + "description": "The type of the automation rule action", + "enum": [ + "ModifyProperties", + "RunPlaybook" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AutomationRuleActionType", + "values": [ + { + "description": "Modify an object's properties", + "value": "ModifyProperties" + }, + { + "description": "Run a playbook on an object", + "value": "RunPlaybook" + } + ] + } + } + }, + "required": [ + "order", + "actionType" + ], + "type": "object" + }, + "AutomationRuleCondition": { + "description": "Describes an automation rule condition", + "discriminator": "conditionType", + "properties": { + "conditionType": { + "description": "The type of the automation rule condition", + "enum": [ + "Property" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AutomationRuleConditionType", + "values": [ + { + "description": "Evaluate an object property value", + "value": "Property" + } + ] + } + } + }, + "required": [ + "conditionType" + ], + "type": "object" + }, + "AutomationRuleProperties": { + "description": "Describes automation rule properties", + "properties": { + "displayName": { + "description": "The display name of the automation rule", + "type": "string" + }, + "order": { + "description": "The order of execution of the automation rule", + "type": "integer", + "format": "int32" + }, + "triggeringLogic": { + "$ref": "#/definitions/AutomationRuleTriggeringLogic", + "description": "The triggering logic of the automation rule", + "type": "object" + }, + "actions": { + "description": "The actions to execute when the automation rule is triggered", + "items": { + "$ref": "#/definitions/AutomationRuleAction" + }, + "type": "array" + }, + "createdTimeUtc": { + "description": "The time the automation rule was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "lastModifiedTimeUtc": { + "description": "The last time the automation rule was updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "$ref": "SecurityInsights.json#/definitions/ClientInfo", + "description": "Describes the client that created the automation rule", + "readOnly": true, + "type": "object" + }, + "lastModifiedBy": { + "$ref": "SecurityInsights.json#/definitions/ClientInfo", + "description": "Describes the client that last updated the automation rule", + "readOnly": true, + "type": "object" + } + }, + "required": [ + "displayName", + "order", + "triggeringLogic", + "actions" + ], + "type": "object" + }, + "AutomationRulesList": { + "description": "List all the automation rules.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of automation rules.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of automation rules.", + "items": { + "$ref": "#/definitions/AutomationRule" + }, + "type": "array" + } + }, + "required": [ + "value" + ] + }, + "AutomationRuleRunPlaybookAction": { + "description": "Describes an automation rule action to run a playbook", + "allOf": [ + { + "$ref": "#/definitions/AutomationRuleAction" + } + ], + "properties": { + "actionConfiguration": { + "description": "The configuration of the run playbook automation rule action", + "properties": { + "logicAppResourceId": { + "description": "The resource id of the playbook resource", + "type": "string" + }, + "tenantId": { + "description": "The tenant id of the playbook resource", + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "actionConfiguration" + ], + "x-ms-client-flatten": true, + "type": "object", + "x-ms-discriminator-value": "RunPlaybook" + }, + "AutomationRuleModifyPropertiesAction": { + "description": "Describes an automation rule action to modify an object's properties", + "allOf": [ + { + "$ref": "#/definitions/AutomationRuleAction" + } + ], + "properties": { + "actionConfiguration": { + "description": "The configuration of the modify properties automation rule action", + "properties": { + "classification": { + "$ref": "SecurityInsights.json#/definitions/IncidentClassification", + "description": "The reason the incident was closed" + }, + "classificationComment": { + "description": "Describes the reason the incident was closed", + "type": "string" + }, + "classificationReason": { + "$ref": "SecurityInsights.json#/definitions/IncidentClassificationReason", + "description": "The classification reason to close the incident with" + }, + "labels": { + "description": "List of labels to add to the incident", + "items": { + "$ref": "SecurityInsights.json#/definitions/IncidentLabel" + }, + "type": "array" + }, + "owner": { + "$ref": "SecurityInsights.json#/definitions/IncidentOwnerInfo", + "description": "Describes a user that the incident is assigned to", + "type": "object" + }, + "severity": { + "$ref": "SecurityInsights.json#/definitions/IncidentSeverity", + "description": "The severity of the incident" + }, + "status": { + "$ref": "SecurityInsights.json#/definitions/IncidentStatus", + "description": "The status of the incident" + } + }, + "type": "object" + } + }, + "required": [ + "actionConfiguration" + ], + "x-ms-client-flatten": true, + "type": "object", + "x-ms-discriminator-value": "ModifyProperties" + }, + "AutomationRulePropertyConditionSupportedProperty": { + "description": "The property to evaluate in an automation rule property condition", + "enum": [ + "IncidentTitle", + "IncidentDescription", + "IncidentSeverity", + "IncidentStatus", + "IncidentTactics", + "IncidentRelatedAnalyticRuleIds", + "IncidentProviderName", + "AccountAadTenantId", + "AccountAadUserId", + "AccountName", + "AccountNTDomain", + "AccountPUID", + "AccountSid", + "AccountObjectGuid", + "AccountUPNSuffix", + "AzureResourceResourceId", + "AzureResourceSubscriptionId", + "CloudApplicationAppId", + "CloudApplicationAppName", + "DNSDomainName", + "FileDirectory", + "FileName", + "FileHashValue", + "HostAzureID", + "HostName", + "HostNetBiosName", + "HostNTDomain", + "HostOSVersion", + "IoTDeviceId", + "IoTDeviceName", + "IoTDeviceType", + "IoTDeviceVendor", + "IoTDeviceModel", + "IoTDeviceOperatingSystem", + "IPAddress", + "MailboxDisplayName", + "MailboxPrimaryAddress", + "MailboxUPN", + "MailMessageDeliveryAction", + "MailMessageDeliveryLocation", + "MailMessageRecipient", + "MailMessageSenderIP", + "MailMessageSubject", + "MailMessageP1Sender", + "MailMessageP2Sender", + "MalwareCategory", + "MalwareName", + "ProcessCommandLine", + "ProcessId", + "RegistryKey", + "RegistryValueData", + "Url" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AutomationRulePropertyConditionSupportedProperty", + "values": [ + { + "description": "The title of the incident", + "value": "IncidentTitle" + }, + { + "description": "The description of the incident", + "value": "IncidentDescription" + }, + { + "description": "The severity of the incident", + "value": "IncidentSeverity" + }, + { + "description": "The status of the incident", + "value": "IncidentStatus" + }, + { + "description": "The tactics of the incident", + "value": "IncidentTactics" + }, + { + "description": "The related Analytic rule ids of the incident", + "value": "IncidentRelatedAnalyticRuleIds" + }, + { + "description": "The provider name of the incident", + "value": "IncidentProviderName" + }, + { + "description": "The account Azure Active Directory tenant id", + "value": "AccountAadTenantId" + }, + { + "description": "The account Azure Active Directory user id.", + "value": "AccountAadUserId" + }, + { + "description": "The account name", + "value": "AccountName" + }, + { + "description": "The account NetBIOS domain name", + "value": "AccountNTDomain" + }, + { + "description": "The account Azure Active Directory Passport User ID", + "value": "AccountPUID" + }, + { + "description": "The account security identifier", + "value": "AccountSid" + }, + { + "description": "The account unique identifier", + "value": "AccountObjectGuid" + }, + { + "description": "The account user principal name suffix", + "value": "AccountUPNSuffix" + }, + { + "description": "The Azure resource id", + "value": "AzureResourceResourceId" + }, + { + "description": "The Azure resource subscription id", + "value": "AzureResourceSubscriptionId" + }, + { + "description": "The cloud application identifier", + "value": "CloudApplicationAppId" + }, + { + "description": "The cloud application name", + "value": "CloudApplicationAppName" + }, + { + "description": "The dns record domain name", + "value": "DNSDomainName" + }, + { + "description": "The file directory full path", + "value": "FileDirectory" + }, + { + "description": "The file name without path", + "value": "FileName" + }, + { + "description": "The file hash value", + "value": "FileHashValue" + }, + { + "description": "The host Azure resource id", + "value": "HostAzureID" + }, + { + "description": "The host name without domain", + "value": "HostName" + }, + { + "description": "The host NetBIOS name", + "value": "HostNetBiosName" + }, + { + "description": "The host NT domain", + "value": "HostNTDomain" + }, + { + "description": "The host operating system", + "value": "HostOSVersion" + }, + { + "description": "The IoT device id", + "value": "IoTDeviceId" + }, + { + "description": "The IoT device name", + "value": "IoTDeviceName" + }, + { + "description": "The IoT device type", + "value": "IoTDeviceType" + }, + { + "description": "The IoT device vendor", + "value": "IoTDeviceVendor" + }, + { + "description": "The IoT device model", + "value": "IoTDeviceModel" + }, + { + "description": "The IoT device operating system", + "value": "IoTDeviceOperatingSystem" + }, + { + "description": "The IP address", + "value": "IPAddress" + }, + { + "description": "The mailbox display name", + "value": "MailboxDisplayName" + }, + { + "description": "The mailbox primary address", + "value": "MailboxPrimaryAddress" + }, + { + "description": "The mailbox user principal name", + "value": "MailboxUPN" + }, + { + "description": "The mail message delivery action", + "value": "MailMessageDeliveryAction" + }, + { + "description": "The mail message delivery location", + "value": "MailMessageDeliveryLocation" + }, + { + "description": "The mail message recipient", + "value": "MailMessageRecipient" + }, + { + "description": "The mail message sender IP address", + "value": "MailMessageSenderIP" + }, + { + "description": "The mail message subject", + "value": "MailMessageSubject" + }, + { + "description": "The mail message P1 sender", + "value": "MailMessageP1Sender" + }, + { + "description": "The mail message P2 sender", + "value": "MailMessageP2Sender" + }, + { + "description": "The malware category", + "value": "MalwareCategory" + }, + { + "description": "The malware name", + "value": "MalwareName" + }, + { + "description": "The process execution command line", + "value": "ProcessCommandLine" + }, + { + "description": "The process id", + "value": "ProcessId" + }, + { + "description": "The registry key path", + "value": "RegistryKey" + }, + { + "description": "The registry key value in string formatted representation", + "value": "RegistryValueData" + }, + { + "description": "The url", + "value": "Url" + } + ] + } + }, + "AutomationRulePropertyValuesCondition": { + "description": "Describes an automation rule condition that evaluates a property's value", + "allOf": [ + { + "$ref": "#/definitions/AutomationRuleCondition" + } + ], + "properties": { + "conditionProperties": { + "description": "The configuration of the automation rule condition", + "properties": { + "propertyName": { + "$ref": "#/definitions/AutomationRulePropertyConditionSupportedProperty", + "description": "The property to evaluate" + }, + "operator": { + "description": "The operator to use for evaluation the condition", + "enum": [ + "Equals", + "NotEquals", + "Contains", + "NotContains", + "StartsWith", + "NotStartsWith", + "EndsWith", + "NotEndsWith" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AutomationRulePropertyConditionSupportedOperator", + "values": [ + { + "description": "Evaluates if the property equals at least one of the condition values", + "value": "Equals" + }, + { + "description": "Evaluates if the property does not equal any of the condition values", + "value": "NotEquals" + }, + { + "description": "Evaluates if the property contains at least one of the condition values", + "value": "Contains" + }, + { + "description": "Evaluates if the property does not contain any of the condition values", + "value": "NotContains" + }, + { + "description": "Evaluates if the property starts with any of the condition values", + "value": "StartsWith" + }, + { + "description": "Evaluates if the property does not start with any of the condition values", + "value": "NotStartsWith" + }, + { + "description": "Evaluates if the property ends with any of the condition values", + "value": "EndsWith" + }, + { + "description": "Evaluates if the property does not end with any of the condition values", + "value": "NotEndsWith" + } + ] + } + }, + "propertyValues": { + "description": "The values to use for evaluating the condition", + "items": { + "description": "A value to use for evaluating the condition", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "required": [ + "conditionProperties" + ], + "x-ms-client-flatten": true, + "type": "object", + "x-ms-discriminator-value": "Property" + }, + "AutomationRuleTriggeringLogic": { + "description": "Describes automation rule triggering logic", + "properties": { + "isEnabled": { + "description": "Determines whether the automation rule is enabled or disabled.", + "type": "boolean" + }, + "expirationTimeUtc": { + "description": "Determines when the automation rule should automatically expire and be disabled.", + "format": "date-time", + "type": "string" + }, + "triggersOn": { + "description": "The type of object the automation rule triggers on", + "enum": [ + "Incidents" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "TriggersOn", + "values": [ + { + "description": "Trigger on Incidents", + "value": "Incidents" + } + ] + } + }, + "triggersWhen": { + "description": "The type of event the automation rule triggers on", + "enum": [ + "Created" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "TriggersWhen", + "values": [ + { + "description": "Trigger on created objects", + "value": "Created" + } + ] + } + }, + "conditions": { + "description": "The conditions to evaluate to determine if the automation rule should be triggered on a given object", + "items": { + "$ref": "#/definitions/AutomationRuleCondition" + }, + "type": "array" + } + }, + "required": [ + "isEnabled", + "triggersOn", + "triggersWhen" + ], + "type": "object" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Bookmarks.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Bookmarks.json new file mode 100644 index 000000000000..dbb332f13015 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Bookmarks.json @@ -0,0 +1,699 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2019-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks": { + "get": { + "x-ms-examples": { + "Get all bookmarks.": { + "$ref": "./examples/bookmarks/GetBookmarks.json" + } + }, + "tags": [ + "Bookmarks" + ], + "description": "Gets all bookmarks.", + "operationId": "Bookmarks_List", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BookmarkList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}": { + "get": { + "x-ms-examples": { + "Get a bookmark.": { + "$ref": "./examples/bookmarks/GetBookmarkById.json" + } + }, + "tags": [ + "Bookmarks" + ], + "description": "Gets a bookmark.", + "operationId": "Bookmarks_Get", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BookmarkId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Bookmark" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a bookmark.": { + "$ref": "./examples/bookmarks/CreateBookmark.json" + } + }, + "tags": [ + "Bookmarks" + ], + "description": "Creates or updates the bookmark.", + "operationId": "Bookmarks_CreateOrUpdate", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BookmarkId" + }, + { + "$ref": "#/parameters/Bookmark" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Bookmark" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Bookmark" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a bookmark.": { + "$ref": "./examples/bookmarks/DeleteBookmark.json" + } + }, + "tags": [ + "Bookmarks" + ], + "description": "Delete the bookmark.", + "operationId": "Bookmarks_Delete", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BookmarkId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}/relations": { + "get": { + "x-ms-examples": { + "Get all bookmark relations.": { + "$ref": "./examples/bookmarks/relations/GetAllBookmarkRelations.json" + } + }, + "tags": [ + "BookmarkRelations" + ], + "description": "Gets all bookmark relations.", + "operationId": "BookmarkRelations_List", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BookmarkId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ODataFilter" + }, + { + "$ref": "SecurityInsights.json#/parameters/ODataOrderBy" + }, + { + "$ref": "SecurityInsights.json#/parameters/ODataTop" + }, + { + "$ref": "SecurityInsights.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "SecurityInsights.json#/definitions/RelationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + }, + "x-ms-odata": "SecurityInsights.json#/definitions/Relation", + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}/expand": { + "post": { + "x-ms-examples": { + "Expand an bookmark": { + "$ref": "./examples/bookmarks/expand/PostExpandBookmark.json" + } + }, + "description": "Expand an bookmark", + "operationId": "Bookmark_Expand", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BookmarkId" + }, + { + "$ref": "#/parameters/BookmarkExpandRequestBody" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BookmarkExpandResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + }, + "tags": [ + "Bookmark" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}/relations/{relationName}": { + "get": { + "x-ms-examples": { + "Get a bookmark relation.": { + "$ref": "./examples/bookmarks/relations/GetBookmarkRelationByName.json" + } + }, + "tags": [ + "BookmarkRelations" + ], + "description": "Gets a bookmark relation.", + "operationId": "BookmarkRelations_GetRelation", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BookmarkId" + }, + { + "$ref": "SecurityInsights.json#/parameters/RelationName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "SecurityInsights.json#/definitions/Relation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a bookmark relation.": { + "$ref": "./examples/bookmarks/relations/CreateBookmarkRelation.json" + } + }, + "tags": [ + "BookmarkRelations" + ], + "description": "Creates the bookmark relation.", + "operationId": "BookmarkRelations_CreateOrUpdateRelation", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BookmarkId" + }, + { + "$ref": "SecurityInsights.json#/parameters/RelationName" + }, + { + "$ref": "SecurityInsights.json#/parameters/Relation" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "SecurityInsights.json#/definitions/Relation" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "SecurityInsights.json#/definitions/Relation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete the bookmark relation.": { + "$ref": "./examples/bookmarks/relations/DeleteBookmarkRelation.json" + } + }, + "tags": [ + "BookmarkRelations" + ], + "description": "Delete the bookmark relation.", + "operationId": "BookmarkRelations_DeleteRelation", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BookmarkId" + }, + { + "$ref": "SecurityInsights.json#/parameters/RelationName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + } + } + }, + "parameters": { + "Bookmark": { + "description": "The bookmark", + "in": "body", + "name": "bookmark", + "required": true, + "schema": { + "$ref": "#/definitions/Bookmark" + }, + "x-ms-parameter-location": "method" + }, + "BookmarkExpandRequestBody": { + "description": "The parameters required to execute an expand operation on the given bookmark.", + "in": "body", + "name": "parameters", + "required": true, + "schema": { + "$ref": "#/definitions/BookmarkExpandParameters" + }, + "x-ms-parameter-location": "method" + }, + "BookmarkId": { + "description": "Bookmark ID", + "in": "path", + "name": "bookmarkId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "Bookmark": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents a bookmark in Azure Security Insights.", + "properties": { + "properties": { + "$ref": "#/definitions/BookmarkProperties", + "description": "Bookmark properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "BookmarkExpandResponse": { + "description": "The entity expansion result operation response.", + "properties": { + "metaData": { + "$ref": "SecurityInsights.json#/definitions/ExpansionResultsMetadata", + "description": "The metadata from the expansion operation results." + }, + "value": { + "description": "The expansion result values.", + "properties": { + "entities": { + "description": "Array of the expansion result entities.", + "items": { + "$ref": "SecurityInsights.json#/definitions/Entity" + }, + "type": "array" + }, + "edges": { + "description": "Array of expansion result connected entities", + "items": { + "$ref": "SecurityInsights.json#/definitions/ConnectedEntity" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "BookmarkExpandParameters": { + "description": "The parameters required to execute an expand operation on the given bookmark.", + "properties": { + "endTime": { + "description": "The end date filter, so the only expansion results returned are before this date.", + "format": "date-time", + "type": "string" + }, + "expansionId": { + "description": "The Id of the expansion to perform.", + "format": "uuid", + "type": "string" + }, + "startTime": { + "description": "The start date filter, so the only expansion results returned are after this date.", + "format": "date-time", + "type": "string" + } + } + }, + "BookmarkList": { + "description": "List all the bookmarks.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of cases.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of bookmarks.", + "items": { + "$ref": "#/definitions/Bookmark" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "BookmarkProperties": { + "description": "Describes bookmark properties", + "properties": { + "created": { + "description": "The time the bookmark was created", + "format": "date-time", + "type": "string" + }, + "createdBy": { + "$ref": "SecurityInsights.json#/definitions/UserInfo", + "description": "Describes a user that created the bookmark", + "type": "object" + }, + "displayName": { + "description": "The display name of the bookmark", + "type": "string" + }, + "labels": { + "description": "List of labels relevant to this bookmark", + "items": { + "$ref": "SecurityInsights.json#/definitions/Label" + }, + "type": "array" + }, + "notes": { + "description": "The notes of the bookmark", + "type": "string" + }, + "query": { + "description": "The query of the bookmark.", + "type": "string" + }, + "queryResult": { + "description": "The query result of the bookmark.", + "type": "string" + }, + "updated": { + "description": "The last time the bookmark was updated", + "format": "date-time", + "type": "string" + }, + "updatedBy": { + "$ref": "SecurityInsights.json#/definitions/UserInfo", + "description": "Describes a user that updated the bookmark", + "type": "object" + }, + "eventTime": { + "description": "The bookmark event time", + "format": "date-time", + "type": "string" + }, + "queryStartTime": { + "description": "The start time for the query", + "format": "date-time", + "type": "string" + }, + "queryEndTime": { + "description": "The end time for the query", + "format": "date-time", + "type": "string" + }, + "incidentInfo": { + "$ref": "SecurityInsights.json#/definitions/IncidentInfo", + "description": "Describes an incident that relates to bookmark", + "type": "object" + } + }, + "required": [ + "displayName", + "query" + ], + "type": "object" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Cases.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Cases.json new file mode 100644 index 000000000000..d95a503de738 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Cases.json @@ -0,0 +1,1187 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2019-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/cases": { + "get": { + "x-ms-examples": { + "Get all cases.": { + "$ref": "./examples/cases/GetCases.json" + } + }, + "tags": [ + "Cases" + ], + "description": "Gets all cases.", + "deprecated": true, + "operationId": "Cases_List", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "SecurityInsights.json#/parameters/ODataFilter" + }, + { + "$ref": "SecurityInsights.json#/parameters/ODataOrderBy" + }, + { + "$ref": "SecurityInsights.json#/parameters/ODataTop" + }, + { + "$ref": "SecurityInsights.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CaseList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/cases/{caseId}": { + "get": { + "x-ms-examples": { + "Get a case.": { + "$ref": "./examples/cases/GetCaseById.json" + } + }, + "tags": [ + "Cases" + ], + "description": "Gets a case.", + "deprecated": true, + "operationId": "Cases_Get", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/CaseId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Case" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a case.": { + "$ref": "./examples/cases/CreateCase.json" + } + }, + "tags": [ + "Cases" + ], + "description": "Creates or updates the case.", + "deprecated": true, + "operationId": "Cases_CreateOrUpdate", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/CaseId" + }, + { + "$ref": "#/parameters/Case" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Case" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Case" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a case.": { + "$ref": "./examples/cases/DeleteCase.json" + } + }, + "tags": [ + "Cases" + ], + "description": "Delete the case.", + "deprecated": true, + "operationId": "Cases_Delete", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/CaseId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/cases/{caseId}/comments": { + "get": { + "x-ms-examples": { + "Get all case comments.": { + "$ref": "./examples/cases/comments/GetAllCaseComments.json" + } + }, + "tags": [ + "CaseComments" + ], + "description": "Gets all case comments.", + "deprecated": true, + "operationId": "Comments_ListByCase", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/CaseId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ODataFilter" + }, + { + "$ref": "SecurityInsights.json#/parameters/ODataOrderBy" + }, + { + "$ref": "SecurityInsights.json#/parameters/ODataTop" + }, + { + "$ref": "SecurityInsights.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CaseCommentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/CaseComment", + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/cases/{caseId}/comments/{caseCommentId}": { + "get": { + "x-ms-examples": { + "Get a case comment.": { + "$ref": "./examples/cases/comments/GetCaseCommentById.json" + } + }, + "tags": [ + "CaseComments" + ], + "description": "Gets a case comment.", + "deprecated": true, + "operationId": "Cases_GetComment", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/CaseId" + }, + { + "$ref": "#/parameters/CaseCommentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CaseComment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a case comment.": { + "$ref": "./examples/cases/comments/CreateCaseComment.json" + } + }, + "tags": [ + "CaseComments" + ], + "description": "Creates the case comment.", + "deprecated": true, + "operationId": "CaseComments_CreateComment", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/CaseId" + }, + { + "$ref": "#/parameters/CaseCommentId" + }, + { + "$ref": "#/parameters/CaseComment" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/CaseComment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/cases/{caseId}/relations": { + "get": { + "x-ms-examples": { + "Get all case relations.": { + "$ref": "./examples/cases/relations/GetAllCaseRelations.json" + } + }, + "tags": [ + "CaseRelations" + ], + "description": "Gets all case relations.", + "deprecated": true, + "operationId": "CaseRelations_List", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/CaseId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ODataFilter" + }, + { + "$ref": "SecurityInsights.json#/parameters/ODataOrderBy" + }, + { + "$ref": "SecurityInsights.json#/parameters/ODataTop" + }, + { + "$ref": "SecurityInsights.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CaseRelationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/CaseRelation", + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/cases/{caseId}/relations/{relationName}": { + "get": { + "x-ms-examples": { + "Get a case relation.": { + "$ref": "./examples/cases/relations/GetCaseRelationByName.json" + } + }, + "tags": [ + "CaseRelations" + ], + "description": "Gets a case relation.", + "deprecated": true, + "operationId": "CaseRelations_GetRelation", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/CaseId" + }, + { + "$ref": "SecurityInsights.json#/parameters/RelationName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CaseRelation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a case relation.": { + "$ref": "./examples/cases/relations/CreateCaseRelation.json" + } + }, + "tags": [ + "CaseRelations" + ], + "description": "Creates or updates the case relation.", + "deprecated": true, + "operationId": "CaseRelations_CreateOrUpdateRelation", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/CaseId" + }, + { + "$ref": "SecurityInsights.json#/parameters/RelationName" + }, + { + "$ref": "#/parameters/RelationInputModel" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CaseRelation" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/CaseRelation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete the case relation.": { + "$ref": "./examples/cases/relations/DeleteCaseRelation.json" + } + }, + "tags": [ + "CaseRelations" + ], + "description": "Delete the case relation.", + "deprecated": true, + "operationId": "CaseRelations_DeleteRelation", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/CaseId" + }, + { + "$ref": "SecurityInsights.json#/parameters/RelationName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + } + } + }, + "parameters": { + "Case": { + "description": "The case", + "in": "body", + "name": "case", + "required": true, + "schema": { + "$ref": "#/definitions/Case" + }, + "x-ms-parameter-location": "method" + }, + "CaseComment": { + "description": "The case comment", + "in": "body", + "name": "caseComment", + "required": true, + "schema": { + "$ref": "#/definitions/CaseComment" + }, + "x-ms-parameter-location": "method" + }, + "CaseCommentId": { + "description": "Case comment ID", + "in": "path", + "name": "caseCommentId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "CaseId": { + "description": "Case ID", + "in": "path", + "name": "caseId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "RelationInputModel": { + "name": "relationInputModel", + "in": "body", + "description": "The relation input model", + "required": true, + "schema": { + "$ref": "#/definitions/RelationsModelInput" + }, + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "Case": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents a case in Azure Security Insights.", + "properties": { + "properties": { + "$ref": "#/definitions/CaseProperties", + "description": "Case properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "CaseComment": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/Resource" + } + ], + "description": "Represents a case comment", + "properties": { + "properties": { + "$ref": "#/definitions/CaseCommentProperties", + "description": "Case comment properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "CaseCommentList": { + "description": "List of case comments.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of comments.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of comments.", + "items": { + "$ref": "#/definitions/CaseComment" + }, + "type": "array" + } + }, + "required": [ + "value" + ] + }, + "CaseCommentProperties": { + "description": "Case comment property bag.", + "properties": { + "createdTimeUtc": { + "description": "The time the comment was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "The comment message", + "type": "string" + }, + "userInfo": { + "$ref": "SecurityInsights.json#/definitions/UserInfo", + "description": "Describes the user that created the comment", + "readOnly": true, + "type": "object" + } + }, + "required": [ + "message" + ], + "type": "object" + }, + "CaseList": { + "description": "List all the cases.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of cases.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of cases.", + "items": { + "$ref": "#/definitions/Case" + }, + "type": "array" + } + }, + "required": [ + "value" + ] + }, + "CaseProperties": { + "description": "Describes case properties", + "properties": { + "caseNumber": { + "description": "a sequential number", + "readOnly": true, + "type": "integer" + }, + "closeReason": { + "description": "The reason the case was closed", + "enum": [ + "Resolved", + "Dismissed", + "TruePositive", + "FalsePositive", + "Other" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "CloseReason", + "values": [ + { + "description": "Case was resolved", + "value": "Resolved" + }, + { + "description": "Case was dismissed", + "value": "Dismissed" + }, + { + "description": "Case was true positive", + "value": "TruePositive" + }, + { + "description": "Case was false positive", + "value": "FalsePositive" + }, + { + "description": "Case was closed for another reason", + "value": "Other" + } + ] + } + }, + "closedReasonText": { + "description": "the case close reason details", + "type": "string" + }, + "createdTimeUtc": { + "description": "The time the case was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "The description of the case", + "type": "string" + }, + "endTimeUtc": { + "description": "The end time of the case", + "format": "date-time", + "type": "string" + }, + "labels": { + "description": "List of labels relevant to this case", + "items": { + "$ref": "SecurityInsights.json#/definitions/Label" + }, + "type": "array" + }, + "lastComment": { + "description": "the last comment in the case", + "readOnly": true, + "type": "string" + }, + "lastUpdatedTimeUtc": { + "description": "The last time the case was updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "metrics": { + "description": "Dictionary of metrics, for example the number of alerts in the case", + "type": "object", + "additionalProperties": { + "type": "integer", + "format": "int32" + }, + "readOnly": true + }, + "owner": { + "$ref": "SecurityInsights.json#/definitions/UserInfo", + "description": "Describes a user that the case is assigned to", + "type": "object" + }, + "relatedAlertIds": { + "description": "List of related alert identifiers", + "items": { + "description": "related alert id", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "relatedAlertProductNames": { + "description": "List of related alert product names", + "items": { + "description": "related alert product name", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "tactics": { + "description": "The tactics associated with case", + "items": { + "$ref": "SecurityInsights.json#/definitions/AttackTactic" + }, + "readOnly": true, + "type": "array" + }, + "severity": { + "description": "The severity of the case", + "enum": [ + "Critical", + "High", + "Medium", + "Low", + "Informational" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "CaseSeverity", + "values": [ + { + "description": "Critical severity", + "value": "Critical" + }, + { + "description": "High severity", + "value": "High" + }, + { + "description": "Medium severity", + "value": "Medium" + }, + { + "description": "Low severity", + "value": "Low" + }, + { + "description": "Informational severity", + "value": "Informational" + } + ] + } + }, + "startTimeUtc": { + "description": "The start time of the case", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The status of the case", + "enum": [ + "Draft", + "New", + "InProgress", + "Closed" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "CaseStatus", + "values": [ + { + "description": "Case that wasn't promoted yet to active", + "value": "Draft" + }, + { + "description": "An active case which isn't handled currently", + "value": "New" + }, + { + "description": "An active case which is handled", + "value": "InProgress" + }, + { + "description": "A non active case", + "value": "Closed" + } + ] + } + }, + "title": { + "description": "The title of the case", + "type": "string" + }, + "totalComments": { + "description": "the number of total comments in the case", + "readOnly": true, + "type": "integer" + } + }, + "required": [ + "title", + "severity", + "status" + ], + "type": "object" + }, + "CaseRelationList": { + "description": "List of case relations.", + "properties": { + "nextLink": { + "readOnly": true, + "description": "URL to fetch the next set of relations.", + "type": "string" + }, + "value": { + "description": "Array of relations.", + "type": "array", + "items": { + "$ref": "#/definitions/CaseRelation" + } + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "CaseRelation": { + "type": "object", + "description": "Represents a case relation", + "allOf": [ + { + "$ref": "#/definitions/RelationBase" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Case relation properties", + "$ref": "#/definitions/CaseRelationProperties" + } + } + }, + "CaseRelationProperties": { + "type": "object", + "description": "Case relation properties", + "properties": { + "relationName": { + "type": "string", + "description": "Name of relation" + }, + "bookmarkId": { + "type": "string", + "description": "The case related bookmark id" + }, + "caseIdentifier": { + "type": "string", + "description": "The case identifier" + }, + "bookmarkName": { + "type": "string", + "description": "The case related bookmark name" + } + }, + "required": [ + "relationName", + "caseIdentifier", + "bookmarkId" + ] + }, + "RelationsModelInput": { + "type": "object", + "description": "Relation input model", + "allOf": [ + { + "$ref": "#/definitions/RelationBase" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Relation input properties", + "$ref": "#/definitions/RelationsModelInputProperties" + } + } + }, + "RelationsModelInputProperties": { + "type": "object", + "description": "Relation input properties", + "properties": { + "relationName": { + "type": "string", + "description": "Name of relation" + }, + "sourceRelationNode": { + "type": "object", + "description": "Relation source node", + "$ref": "#/definitions/RelationNode" + }, + "targetRelationNode": { + "type": "object", + "description": "Relation target node", + "$ref": "#/definitions/RelationNode" + } + } + }, + "RelationBase": { + "type": "object", + "description": "Represents a relation", + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/Resource" + }, + { + "type": "object", + "properties": { + "kind": { + "type": "string", + "description": "The type of relation node", + "readOnly": true, + "enum": [ + "CasesToBookmarks" + ], + "x-ms-enum": { + "name": "RelationTypes", + "modelAsString": true, + "values": [ + { + "value": "CasesToBookmarks", + "description": "Relations between cases and bookmarks" + } + ] + } + }, + "etag": { + "type": "string", + "description": "ETag for relation" + } + } + } + ] + }, + "RelationNode": { + "type": "object", + "description": "Relation node", + "properties": { + "relationNodeId": { + "type": "string", + "description": "Relation Node Id" + }, + "relationNodeKind": { + "type": "string", + "description": "The type of relation node", + "readOnly": true, + "enum": [ + "Case", + "Bookmark" + ], + "x-ms-enum": { + "name": "RelationNodeKind", + "modelAsString": true, + "values": [ + { + "value": "Case", + "description": "Case node part of the relation" + }, + { + "value": "Bookmark", + "description": "Bookmark node part of the relation" + } + ] + } + }, + "etag": { + "type": "string", + "description": "Etag for relation node" + }, + "relationAdditionalProperties": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Additional set of properties" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/DataConnectorsCheckRequirements.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/DataConnectorsCheckRequirements.json new file mode 100644 index 000000000000..1dbff9e13a48 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/DataConnectorsCheckRequirements.json @@ -0,0 +1,503 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2019-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectorsCheckRequirements": { + "post": { + "x-ms-examples": { + "Check requirements for TI.": { + "$ref": "./examples/dataConnectors/CheckRequirementsThreatIntelligence.json" + }, + "Check requirements for TI Taxii.": { + "$ref": "./examples/dataConnectors/CheckRequirementsThreatIntelligenceTaxii.json" + }, + "Check requirements for AAD.": { + "$ref": "./examples/dataConnectors/CheckRequirementsAzureActiveDirectory.json" + }, + "Check requirements for AAD - no license.": { + "$ref": "./examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoLicense.json" + }, + "Check requirements for AAD - no authorization.": { + "$ref": "./examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoAuthorization.json" + }, + "Check requirements for ASC.": { + "$ref": "./examples/dataConnectors/CheckRequirementsAzureSecurityCenter.json" + }, + "Check requirements for Mcas.": { + "$ref": "./examples/dataConnectors/CheckRequirementsMicrosoftCloudAppSecurity.json" + }, + "Check requirements for Mdatp.": { + "$ref": "./examples/dataConnectors/CheckRequirementsMdatp.json" + }, + "Check requirements for OfficeATP.": { + "$ref": "./examples/dataConnectors/CheckRequirementsOfficeATP.json" + }, + "Check requirements for Dynamics365.": { + "$ref": "./examples/dataConnectors/CheckRequirementsDynamics365.json" + }, + "Check requirements for MicrosoftThreatProtection.": { + "$ref": "./examples/dataConnectors/CheckRequirementsMicrosoftThreatProtection.json" + }, + "Check requirements for MicrosoftThreatIntelligence.": { + "$ref": "./examples/dataConnectors/CheckRequirementsMicrosoftThreatIntelligence.json" + } + }, + "tags": [ + "Check Data Connector Requirements" + ], + "description": "Get requirements state for a data connector type.", + "operationId": "DataConnectorsCheckRequirements_Post", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "#/parameters/DataConnectorsCheckRequirementsBody" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DataConnectorRequirementsState" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + } + } + }, + "parameters": { + "DataConnectorsCheckRequirementsBody": { + "description": "The parameters for requirements check message", + "in": "body", + "name": "DataConnectorsCheckRequirements", + "required": true, + "schema": { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + }, + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "AADCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents AAD (Azure Active Directory) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/AADCheckRequirementsProperties", + "description": "AAD (Azure Active Directory) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AzureActiveDirectory" + }, + "AADCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/DataConnectorTenantId" + } + ], + "description": "AAD (Azure Active Directory) requirements check properties.", + "type": "object" + }, + "AATPCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents AATP (Azure Advanced Threat Protection) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/AATPCheckRequirementsProperties", + "description": "AATP (Azure Advanced Threat Protection) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AzureAdvancedThreatProtection" + }, + "AATPCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/DataConnectorTenantId" + } + ], + "description": "AATP (Azure Advanced Threat Protection) requirements check properties.", + "type": "object" + }, + "ASCCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents ASC (Azure Security Center) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/ASCCheckRequirementsProperties", + "description": "ASC (Azure Security Center) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AzureSecurityCenter" + }, + "ASCCheckRequirementsProperties": { + "description": "ASC (Azure Security Center) requirements check properties.", + "properties": { + "subscriptionId": { + "description": "The subscription id to connect to, and get the data from.", + "type": "string" + } + }, + "type": "object" + }, + "AwsCloudTrailCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Amazon Web Services CloudTrail requirements check request.", + "type": "object", + "x-ms-discriminator-value": "AmazonWebServicesCloudTrail" + }, + "DataConnectorsCheckRequirements": { + "description": "Data connector requirements properties.", + "properties": { + "kind": { + "$ref": "SecurityInsights.json#/definitions/DataConnectorKind", + "description": "Describes the kind of connector to be checked." + } + }, + "discriminator": "kind", + "type": "object", + "required": [ + "kind" + ] + }, + "DataConnectorAuthorizationState": { + "description": "Describes the state of user's authorization for a connector kind.", + "enum": [ + "Valid", + "Invalid" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DataConnectorAuthorizationState", + "values": [ + { + "value": "Valid" + }, + { + "value": "Invalid" + } + ] + } + }, + "DataConnectorLicenseState": { + "description": "Describes the state of user's license for a connector kind.", + "enum": [ + "Valid", + "Invalid", + "Unknown" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DataConnectorLicenseState", + "values": [ + { + "value": "Valid" + }, + { + "value": "Invalid" + }, + { + "value": "Unknown" + } + ] + } + }, + "DataConnectorRequirementsState": { + "description": "Data connector requirements status.", + "properties": { + "authorizationState": { + "description": "Authorization state for this connector", + "$ref": "#/definitions/DataConnectorAuthorizationState" + }, + "licenseState": { + "description": "License state for this connector", + "$ref": "#/definitions/DataConnectorLicenseState" + } + }, + "type": "object" + }, + "Dynamics365CheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents Dynamics365 requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/Dynamics365CheckRequirementsProperties", + "description": "Dynamics365 requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Dynamics365" + }, + "Dynamics365CheckRequirementsProperties": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/DataConnectorTenantId" + } + ], + "description": "Dynamics365 requirements check properties.", + "type": "object" + }, + "MCASCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents MCAS (Microsoft Cloud App Security) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/MCASCheckRequirementsProperties", + "description": "MCAS (Microsoft Cloud App Security) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftCloudAppSecurity" + }, + "MCASCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/DataConnectorTenantId" + } + ], + "description": "MCAS (Microsoft Cloud App Security) requirements check properties.", + "type": "object" + }, + "MDATPCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents MDATP (Microsoft Defender Advanced Threat Protection) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/MDATPCheckRequirementsProperties", + "description": "MDATP (Microsoft Defender Advanced Threat Protection) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftDefenderAdvancedThreatProtection" + }, + "MDATPCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/DataConnectorTenantId" + } + ], + "description": "MDATP (Microsoft Defender Advanced Threat Protection) requirements check properties.", + "type": "object" + }, + "MSTICheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents Microsoft Threat Intelligence requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/MSTICheckRequirementsProperties", + "description": "Microsoft Threat Intelligence requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftThreatIntelligence" + }, + "MSTICheckRequirementsProperties": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/DataConnectorTenantId" + } + ], + "description": "Microsoft Threat Intelligence requirements check properties.", + "type": "object" + }, + "MtpCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents MTP (Microsoft Threat Protection) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/MTPCheckRequirementsProperties", + "description": "MTP (Microsoft Threat Protection) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftThreatProtection" + }, + "MTPCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/DataConnectorTenantId" + } + ], + "description": "MTP (Microsoft Threat Protection) requirements check properties.", + "type": "object" + }, + "OfficeATPCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents OfficeATP (Office 365 Advanced Threat Protection) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/OfficeATPCheckRequirementsProperties", + "description": "OfficeATP (Office 365 Advanced Threat Protection) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "OfficeATP" + }, + "OfficeATPCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/DataConnectorTenantId" + } + ], + "description": "OfficeATP (Office 365 Advanced Threat Protection) requirements check properties.", + "type": "object" + }, + "TICheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Threat Intelligence Platforms data connector check requirements", + "properties": { + "properties": { + "$ref": "#/definitions/TICheckRequirementsProperties", + "description": "Threat Intelligence Platforms data connector check required properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "ThreatIntelligence" + }, + "TICheckRequirementsProperties": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/DataConnectorTenantId" + } + ], + "description": "Threat Intelligence Platforms data connector required properties.", + "properties": {}, + "type": "object" + }, + "TiTaxiiCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Threat Intelligence TAXII data connector check requirements", + "properties": { + "properties": { + "$ref": "#/definitions/TiTaxiiCheckRequirementsProperties", + "description": "Threat Intelligence TAXII check required properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "ThreatIntelligenceTaxii" + }, + "TiTaxiiCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/DataConnectorTenantId" + } + ], + "description": "Threat Intelligence TAXII data connector required properties.", + "type": "object" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Enrichment.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Enrichment.json new file mode 100644 index 000000000000..356658a0ed41 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Enrichment.json @@ -0,0 +1,375 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2019-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityInsights/enrichment/ip/geodata/": { + "get": { + "x-ms-examples": { + "Get geodata for a single IP address": { + "$ref": "./examples/enrichment/GetGeodataByIp.json" + } + }, + "tags": [ + "Enrichment" + ], + "description": "Get geodata for a single IP address", + "operationId": "IPGeodata_Get", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/EnrichmentIpAddress" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EnrichmentIpGeodata" + } + }, + "default": { + "description": "Error response describing why the operation failed to enrich this ip.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityInsights/enrichment/domain/whois/": { + "get": { + "x-ms-examples": { + "Get whois information for a single domain name": { + "$ref": "./examples/enrichment/GetWhoisByDomainName.json" + } + }, + "tags": [ + "Enrichment" + ], + "description": "Get whois information for a single domain name", + "operationId": "DomainWhois_Get", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/EnrichmentDomain" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EnrichmentDomainWhois" + } + }, + "default": { + "description": "Error response describing why the operation failed to enrich this domain.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + } + } + }, + "parameters": { + "EnrichmentIpAddress": { + "description": "IP address (v4 or v6) to be enriched", + "in": "query", + "name": "ipAddress", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "EnrichmentDomain": { + "description": "Domain name to be enriched", + "in": "query", + "name": "domain", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "EnrichmentDomainWhois": { + "description": "Whois information for a given domain and associated metadata", + "properties": { + "domain": { + "description": "The domain for this whois record", + "type": "string" + }, + "server": { + "description": "The hostname of this registrar's whois server", + "type": "string" + }, + "created": { + "description": "The timestamp at which this record was created", + "format": "date-time", + "type": "string" + }, + "updated": { + "description": "The timestamp at which this record was last updated", + "format": "date-time", + "type": "string" + }, + "expires": { + "description": "The timestamp at which this record will expire", + "format": "date-time", + "type": "string" + }, + "parsedWhois": { + "description": "The whois record for a given domain", + "$ref": "#/definitions/EnrichmentDomainWhoisDetails" + } + } + }, + "EnrichmentDomainWhoisDetails": { + "description": "The whois record for a given domain", + "properties": { + "registrar": { + "description": "The registrar associated with this domain", + "$ref": "#/definitions/EnrichmentDomainWhoisRegistrarDetails" + }, + "contacts": { + "description": "The set of contacts associated with this domain", + "$ref": "#/definitions/EnrichmentDomainWhoisContacts" + }, + "nameServers": { + "description": "A list of name servers associated with this domain", + "type": "array", + "items": { + "type": "string" + } + }, + "statuses": { + "description": "The set of status flags for this whois record", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "EnrichmentDomainWhoisRegistrarDetails": { + "description": "The registrar associated with this domain", + "properties": { + "name": { + "description": "The name of this registrar", + "type": "string" + }, + "abuseContactEmail": { + "description": "This registrar's abuse contact email", + "type": "string" + }, + "abuseContactPhone": { + "description": "This registrar's abuse contact phone number", + "type": "string" + }, + "ianaId": { + "description": "This registrar's Internet Assigned Numbers Authority id", + "type": "string" + }, + "url": { + "description": "This registrar's URL", + "type": "string" + }, + "whoisServer": { + "description": "The hostname of this registrar's whois server", + "type": "string" + } + } + }, + "EnrichmentDomainWhoisContacts": { + "description": "The set of contacts associated with this domain", + "properties": { + "admin": { + "description": "The admin contact for this whois record", + "$ref": "#/definitions/EnrichmentDomainWhoisContact" + }, + "billing": { + "description": "The billing contact for this whois record", + "$ref": "#/definitions/EnrichmentDomainWhoisContact" + }, + "registrant": { + "description": "The registrant contact for this whois record", + "$ref": "#/definitions/EnrichmentDomainWhoisContact" + }, + "tech": { + "description": "The technical contact for this whois record", + "$ref": "#/definitions/EnrichmentDomainWhoisContact" + } + } + }, + "EnrichmentDomainWhoisContact": { + "description": "An individual contact associated with this domain", + "properties": { + "name": { + "description": "The name of this contact", + "type": "string" + }, + "org": { + "description": "The organization for this contact", + "type": "string" + }, + "street": { + "description": "A list describing the street address for this contact", + "type": "array", + "items": { + "type": "string" + } + }, + "city": { + "description": "The city for this contact", + "type": "string" + }, + "state": { + "description": "The state for this contact", + "type": "string" + }, + "postal": { + "description": "The postal code for this contact", + "type": "string" + }, + "country": { + "description": "The country for this contact", + "type": "string" + }, + "phone": { + "description": "The phone number for this contact", + "type": "string" + }, + "fax": { + "description": "The fax number for this contact", + "type": "string" + }, + "email": { + "description": "The email address for this contact", + "type": "string" + } + } + }, + "EnrichmentIpGeodata": { + "description": "Geodata information for a given IP address", + "properties": { + "asn": { + "description": "The autonomous system number associated with this IP address", + "type": "string" + }, + "carrier": { + "description": "The name of the carrier for this IP address", + "type": "string" + }, + "city": { + "description": "The city this IP address is located in", + "type": "string" + }, + "cityCf": { + "description": "A numeric rating of confidence that the value in the 'city' field is correct, on a scale of 0-100", + "type": "integer", + "format": "int32" + }, + "continent": { + "description": "The continent this IP address is located on", + "type": "string" + }, + "country": { + "description": "The county this IP address is located in", + "type": "string" + }, + "countryCf": { + "description": "A numeric rating of confidence that the value in the 'country' field is correct on a scale of 0-100", + "type": "integer", + "format": "int32" + }, + "ipAddr": { + "description": "The dotted-decimal or colon-separated string representation of the IP address", + "type": "string" + }, + "ipRoutingType": { + "description": "A description of the connection type of this IP address", + "type": "string" + }, + "latitude": { + "description": "The latitude of this IP address", + "type": "string" + }, + "longitude": { + "description": "The longitude of this IP address", + "type": "string" + }, + "organization": { + "description": "The name of the organization for this IP address", + "type": "string" + }, + "organizationType": { + "description": "The type of the organization for this IP address", + "type": "string" + }, + "region": { + "description": "The geographic region this IP address is located in", + "type": "string" + }, + "state": { + "description": "The state this IP address is located in", + "type": "string" + }, + "stateCf": { + "description": "A numeric rating of confidence that the value in the 'state' field is correct on a scale of 0-100", + "type": "integer", + "format": "int32" + }, + "stateCode": { + "description": "The abbreviated name for the state this IP address is located in", + "type": "string" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Entities.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Entities.json new file mode 100644 index 000000000000..32a16a5d78e9 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/Entities.json @@ -0,0 +1,1381 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2019-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities": { + "get": { + "x-ms-examples": { + "Get all entities.": { + "$ref": "./examples/entities/GetEntities.json" + } + }, + "tags": [ + "Entities" + ], + "description": "Gets all entities.", + "operationId": "Entities_List", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EntityList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityId}": { + "get": { + "x-ms-examples": { + "Get an account entity.": { + "$ref": "./examples/entities/GetAccountEntityById.json" + }, + "Get a host entity.": { + "$ref": "./examples/entities/GetHostEntityById.json" + }, + "Get a file entity.": { + "$ref": "./examples/entities/GetFileEntityById.json" + }, + "Get a security alert entity.": { + "$ref": "./examples/entities/GetSecurityAlertEntityById.json" + }, + "Get a file hash entity.": { + "$ref": "./examples/entities/GetFileHashEntityById.json" + }, + "Get a malware entity.": { + "$ref": "./examples/entities/GetMalwareEntityById.json" + }, + "Get a security group entity.": { + "$ref": "./examples/entities/GetSecurityGroupEntityById.json" + }, + "Get an azure resource entity.": { + "$ref": "./examples/entities/GetAzureResourceEntityById.json" + }, + "Get a cloud application entity.": { + "$ref": "./examples/entities/GetCloudApplicationEntityById.json" + }, + "Get a process entity.": { + "$ref": "./examples/entities/GetProcessEntityById.json" + }, + "Get a dns entity.": { + "$ref": "./examples/entities/GetDnsEntityById.json" + }, + "Get an ip entity.": { + "$ref": "./examples/entities/GetIpEntityById.json" + }, + "Get a registry key entity.": { + "$ref": "./examples/entities/GetRegistryKeyEntityById.json" + }, + "Get a registry value entity.": { + "$ref": "./examples/entities/GetRegistryValueEntityById.json" + }, + "Get a url entity.": { + "$ref": "./examples/entities/GetUrlEntityById.json" + }, + "Get an IoT device entity.": { + "$ref": "./examples/entities/GetIoTDeviceEntityById.json" + }, + "Get a mailCluster entity.": { + "$ref": "./examples/entities/GetMailClusterEntityById.json" + }, + "Get a mailbox entity.": { + "$ref": "./examples/entities/GetMailboxEntityById.json" + }, + "Get a mailMessage entity.": { + "$ref": "./examples/entities/GetMailMessageEntityById.json" + }, + "Get a submissionMail entity.": { + "$ref": "./examples/entities/GetSubmissionMailEntityById.json" + } + }, + "tags": [ + "Entities" + ], + "description": "Gets an entity.", + "operationId": "Entities_Get", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "SecurityInsights.json#/definitions/Entity" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityId}/expand": { + "post": { + "x-ms-examples": { + "Expand an entity": { + "$ref": "./examples/entities/expand/PostExpandEntity.json" + } + }, + "tags": [ + "Entities" + ], + "description": "Expands an entity.", + "operationId": "Entities_Expand", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityId" + }, + { + "$ref": "#/parameters/EntityExpandRequestBody" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EntityExpandResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityId}/getTimeline": { + "post": { + "x-ms-examples": { + "Entity timeline": { + "$ref": "./examples/entities/timeline/PostTimelineEntity.json" + } + }, + "tags": [ + "Entities" + ], + "description": "Timeline for an entity.", + "operationId": "EntitiesGetTimeline_list", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityId" + }, + { + "$ref": "#/parameters/EntityTimelineRequestBody" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EntityTimelineResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityId}/queries": { + "get": { + "x-ms-examples": { + "Get Entity Query": { + "$ref": "./examples/entities/GetQueries.json" + } + }, + "tags": [ + "Entities" + ], + "description": "Get Insights and Activities for an entity.", + "operationId": "Entities_Queries", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityId" + }, + { + "$ref": "#/parameters/EntityQueryKindParam" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GetQueriesResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityId}/getInsights": { + "post": { + "x-ms-examples": { + "Entity Insight": { + "$ref": "./examples/entities/insights/PostGetInsights.json" + } + }, + "tags": [ + "Entities" + ], + "description": "Execute Insights for an entity.", + "operationId": "Entities_GetInsights", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityId" + }, + { + "$ref": "#/parameters/GetInsightsEntityQueriesRequestBody" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EntityGetInsightsResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityId}/relations": { + "get": { + "x-ms-examples": { + "Get all relations of an entity.": { + "$ref": "./examples/entities/relations/GetAllEntityRelations.json" + } + }, + "tags": [ + "EntityRelations" + ], + "description": "Gets all relations of an entity.", + "operationId": "EntitiesRelations_List", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ODataFilter" + }, + { + "$ref": "SecurityInsights.json#/parameters/ODataOrderBy" + }, + { + "$ref": "SecurityInsights.json#/parameters/ODataTop" + }, + { + "$ref": "SecurityInsights.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "SecurityInsights.json#/definitions/RelationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + }, + "x-ms-odata": "SecurityInsights.json#/definitions/Relation", + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityId}/relations/{relationName}": { + "get": { + "x-ms-examples": { + "Get an entity relation.": { + "$ref": "./examples/entities/relations/GetEntityRelationByName.json" + } + }, + "tags": [ + "EntityRelations" + ], + "description": "Gets an entity relation.", + "operationId": "EntityRelations_GetRelation", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityId" + }, + { + "$ref": "SecurityInsights.json#/parameters/RelationName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "SecurityInsights.json#/definitions/Relation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + } + } + }, + "parameters": { + "EntityExpandRequestBody": { + "description": "The parameters required to execute an expand operation on the given entity.", + "in": "body", + "name": "parameters", + "required": true, + "schema": { + "$ref": "#/definitions/EntityExpandParameters" + }, + "x-ms-parameter-location": "method" + }, + "EntityId": { + "description": "entity ID", + "in": "path", + "name": "entityId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "EntityTimelineRequestBody": { + "description": "The parameters required to execute an timeline operation on the given entity.", + "in": "body", + "name": "parameters", + "required": true, + "schema": { + "$ref": "#/definitions/EntityTimelineParameters" + }, + "x-ms-parameter-location": "method" + }, + "EntityQueryKindParam": { + "description": "The Kind parameter for queries", + "in": "query", + "name": "kind", + "required": true, + "type": "string", + "enum": [ + "Insight" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "EntityItemQueryKind", + "values": [ + { + "description": "insight", + "value": "Insight" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "GetInsightsEntityQueriesRequestBody": { + "description": "The parameters required to execute insights on the given entity.", + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EntityGetInsightsParameters" + }, + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "ActivityTimelineItem": { + "allOf": [ + { + "$ref": "#/definitions/EntityTimelineItem" + } + ], + "description": "Represents Activity timeline item.", + "properties": { + "queryId": { + "type": "string", + "description": "The activity query id." + }, + "bucketStartTimeUTC": { + "format": "date-time", + "type": "string", + "description": "The grouping bucket start time." + }, + "bucketEndTimeUTC": { + "format": "date-time", + "type": "string", + "description": "The grouping bucket end time." + }, + "firstActivityTimeUTC": { + "format": "date-time", + "type": "string", + "description": "The time of the first activity in the grouping bucket." + }, + "lastActivityTimeUTC": { + "format": "date-time", + "type": "string", + "description": "The time of the last activity in the grouping bucket." + }, + "content": { + "type": "string", + "description": "The activity timeline content." + }, + "title": { + "type": "string", + "description": "The activity timeline title." + } + }, + "required": [ + "queryId", + "bucketStartTimeUTC", + "bucketEndTimeUTC", + "firstActivityTimeUTC", + "lastActivityTimeUTC", + "content", + "title" + ], + "type": "object", + "x-ms-discriminator-value": "Activity" + }, + "BookmarkTimelineItem": { + "allOf": [ + { + "$ref": "#/definitions/EntityTimelineItem" + } + ], + "description": "Represents bookmark timeline item.", + "properties": { + "azureResourceId": { + "type": "string", + "description": "The bookmark azure resource id." + }, + "displayName": { + "type": "string", + "description": "The bookmark display name." + }, + "notes": { + "type": "string", + "description": "The notes of the bookmark" + }, + "endTimeUtc": { + "format": "date-time", + "type": "string", + "description": "The bookmark end time." + }, + "startTimeUtc": { + "format": "date-time", + "type": "string", + "description": "The bookmark start time." + }, + "eventTime": { + "format": "date-time", + "type": "string", + "description": "The bookmark event time." + }, + "createdBy": { + "$ref": "SecurityInsights.json#/definitions/UserInfo", + "description": "Describes a user that created the bookmark", + "type": "object" + }, + "labels": { + "description": "List of labels relevant to this bookmark", + "items": { + "$ref": "SecurityInsights.json#/definitions/Label" + }, + "type": "array" + } + }, + "required": [ + "azureResourceId" + ], + "type": "object", + "x-ms-discriminator-value": "Bookmark" + }, + "EntityGetInsightsParameters": { + "description": "The parameters required to execute insights operation on the given entity.", + "type": "object", + "properties": { + "startTime": { + "description": "The start timeline date, so the results returned are after this date.", + "format": "date-time", + "type": "string" + }, + "endTime": { + "description": "The end timeline date, so the results returned are before this date.", + "format": "date-time", + "type": "string" + }, + "addDefaultExtendedTimeRange": { + "description": "Indicates if query time range should be extended with default time range of the query. Default value is false", + "type": "boolean" + }, + "insightQueryIds": { + "description": "List of Insights Query Id. If empty, default value is all insights of this entity", + "type": "array", + "items": { + "description": "Insight Query Id (GUID)", + "format": "uuid", + "type": "string" + } + } + }, + "required": [ + "startTime", + "endTime" + ] + }, + "EntityGetInsightsResponse": { + "description": "The Get Insights result operation response.", + "properties": { + "metaData": { + "$ref": "#/definitions/GetInsightsResultsMetadata", + "description": "The metadata from the get insights operation results." + }, + "value": { + "description": "The insights result values.", + "items": { + "$ref": "#/definitions/EntityInsightItem" + }, + "type": "array" + } + } + }, + "EntityEdges": { + "description": "The edge that connects the entity to the other entity.", + "properties": { + "targetEntityId": { + "description": "The target entity Id.", + "type": "string" + }, + "additionalData": { + "additionalProperties": { + "type": "object" + }, + "description": "A bag of custom fields that should be part of the entity and will be presented to the user.", + "type": "object" + } + }, + "type": "object" + }, + "EntityExpandParameters": { + "description": "The parameters required to execute an expand operation on the given entity.", + "properties": { + "endTime": { + "description": "The end date filter, so the only expansion results returned are before this date.", + "format": "date-time", + "type": "string" + }, + "expansionId": { + "description": "The Id of the expansion to perform.", + "format": "uuid", + "type": "string" + }, + "startTime": { + "description": "The start date filter, so the only expansion results returned are after this date.", + "format": "date-time", + "type": "string" + } + } + }, + "EntityExpandResponse": { + "description": "The entity expansion result operation response.", + "properties": { + "metaData": { + "$ref": "SecurityInsights.json#/definitions/ExpansionResultsMetadata", + "description": "The metadata from the expansion operation results." + }, + "value": { + "description": "The expansion result values.", + "properties": { + "entities": { + "description": "Array of the expansion result entities.", + "items": { + "$ref": "SecurityInsights.json#/definitions/Entity" + }, + "type": "array" + }, + "edges": { + "description": "Array of edges that connects the entity to the list of entities.", + "items": { + "$ref": "#/definitions/EntityEdges" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "EntityInsightItem": { + "description": "Entity insight Item.", + "type": "object", + "properties": { + "queryId": { + "type": "string", + "description": "The query id of the insight" + }, + "queryTimeInterval": { + "type": "object", + "description": "The Time interval that the query actually executed on.", + "properties": { + "startTime": { + "format": "date-time", + "type": "string", + "description": "Insight query start time" + }, + "endTime": { + "format": "date-time", + "type": "string", + "description": "Insight query end time" + } + } + }, + "tableQueryResults": { + "$ref": "#/definitions/InsightsTableResult", + "description": "Query results for table insights query." + }, + "chartQueryResults": { + "type": "array", + "description": "Query results for table insights query.", + "items": { + "$ref": "#/definitions/InsightsTableResult", + "description": "Query results for table insights query." + } + } + } + }, + "EntityList": { + "description": "List of all the entities.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of entities.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of entities.", + "items": { + "$ref": "SecurityInsights.json#/definitions/Entity" + }, + "type": "array" + } + }, + "required": [ + "value" + ] + }, + "EntityTimelineItem": { + "description": "Entity timeline Item.", + "discriminator": "kind", + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/EntityTimelineKind", + "description": "The entity query kind type." + } + }, + "required": [ + "kind" + ] + }, + "EntityTimelineResponse": { + "description": "The entity timeline result operation response.", + "properties": { + "metaData": { + "$ref": "#/definitions/TimelineResultsMetadata", + "description": "The metadata from the timeline operation results." + }, + "value": { + "description": "The timeline result values.", + "items": { + "$ref": "#/definitions/EntityTimelineItem" + }, + "type": "array" + } + } + }, + "EntityTimelineKind": { + "description": "The entity query kind", + "enum": [ + "Activity", + "Bookmark", + "SecurityAlert" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "EntityTimelineKind", + "values": [ + { + "description": "activity", + "value": "Activity" + }, + { + "description": "bookmarks", + "value": "Bookmark" + }, + { + "description": "security alerts", + "value": "SecurityAlert" + } + ] + } + }, + "EntityTimelineParameters": { + "description": "The parameters required to execute s timeline operation on the given entity.", + "properties": { + "kinds": { + "description": "Array of timeline Item kinds.", + "items": { + "$ref": "#/definitions/EntityTimelineKind" + }, + "type": "array" + }, + "startTime": { + "description": "The start timeline date, so the results returned are after this date.", + "format": "date-time", + "type": "string" + }, + "endTime": { + "description": "The end timeline date, so the results returned are before this date.", + "format": "date-time", + "type": "string" + }, + "numberOfBucket": { + "description": "The number of bucket for timeline queries aggregation.", + "type": "integer", + "format": "int32" + } + }, + "required": [ + "startTime", + "endTime" + ] + }, + "EntityQueryItem": { + "description": "An abstract Query item for entity", + "type": "object", + "discriminator": "kind", + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/EntityQueryKind" + } + ], + "properties": { + "id": { + "description": "Query Template ARM ID", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Query Template ARM Name", + "type": "string" + }, + "type": { + "description": "ARM Type", + "type": "string" + } + }, + "required": [ + "kind" + ] + }, + "EntityQueryItemProperties": { + "description": "An properties abstract Query item for entity", + "type": "object", + "properties": { + "dataTypes": { + "description": "Data types for template", + "type": "array", + "items": { + "properties": { + "dataType": { + "description": "Data type name", + "type": "string" + } + } + } + }, + "inputEntityType": { + "description": "The type of the entity", + "$ref": "SecurityInsights.json#/definitions/EntityInnerType" + }, + "requiredInputFieldsSets": { + "description": "Data types for template", + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "entitiesFilter": { + "description": "The query applied only to entities matching to all filters", + "type": "object" + } + } + }, + "InsightsTableResult": { + "type": "object", + "description": "Query results for table insights query.", + "properties": { + "columns": { + "type": "array", + "description": "Columns Metadata of the table", + "items": { + "properties": { + "type": { + "type": "string", + "description": "the type of the colum" + }, + "name": { + "type": "string", + "description": "the name of the colum" + } + } + } + }, + "rows": { + "type": "array", + "description": "Rows data of the table", + "items": { + "type": "array", + "description": "Single row of data", + "items": { + "type": "string", + "description": "Cell in the table" + } + } + } + } + }, + "InsightQueryItem": { + "allOf": [ + { + "$ref": "#/definitions/EntityQueryItem" + } + ], + "description": "Represents Insight Query.", + "properties": { + "properties": { + "description": "Properties bag for InsightQueryItem", + "$ref": "#/definitions/InsightQueryItemProperties" + } + }, + "type": "object", + "x-ms-discriminator-value": "Insight" + }, + "InsightQueryItemProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityQueryItemProperties" + } + ], + "description": "Represents Insight Query.", + "properties": { + "displayName": { + "type": "string", + "description": "The insight display name." + }, + "description": { + "type": "string", + "description": "The insight description." + }, + "baseQuery": { + "type": "string", + "description": "The base query of the insight." + }, + "tableQuery": { + "type": "object", + "description": "The insight table query.", + "properties": { + "columnsDefinitions": { + "type": "array", + "description": "List of insight column definitions.", + "items": { + "properties": { + "header": { + "type": "string", + "description": "Insight column header." + }, + "outputType": { + "type": "string", + "description": "Insights Column type.", + "enum": [ + "Number", + "String", + "Date", + "Entity" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "outputType" + } + }, + "supportDeepLink": { + "type": "boolean", + "description": "Is query supports deep-link." + } + } + } + }, + "queriesDefinitions": { + "type": "array", + "description": "List of insight queries definitions.", + "items": { + "properties": { + "filter": { + "type": "string", + "description": "Insight column header." + }, + "summarize": { + "type": "string", + "description": "Insight column header." + }, + "project": { + "type": "string", + "description": "Insight column header." + }, + "linkColumnsDefinitions": { + "type": "array", + "description": "Insight column header.", + "items": { + "properties": { + "projectedName": { + "type": "string", + "description": "Insight Link Definition Projected Name." + }, + "Query": { + "type": "string", + "description": "Insight Link Definition Query." + } + } + } + } + } + } + } + } + }, + "chartQuery": { + "type": "object", + "description": "The insight chart query." + }, + "additionalQuery": { + "type": "object", + "description": "The activity query definitions.", + "properties": { + "query": { + "type": "string", + "description": "The insight query." + }, + "text": { + "type": "string", + "description": "The insight text." + } + } + }, + "defaultTimeRange": { + "type": "object", + "description": "The insight chart query.", + "properties": { + "beforeRange": { + "type": "string", + "description": "The padding for the start time of the query." + }, + "afterRange": { + "type": "string", + "description": "The padding for the end time of the query." + } + } + }, + "referenceTimeRange": { + "type": "object", + "description": "The insight chart query.", + "properties": { + "beforeRange": { + "type": "string", + "description": "Additional query time for looking back." + } + } + } + }, + "type": "object", + "x-ms-discriminator-value": "Insight" + }, + "GetInsightsResultsMetadata": { + "description": "Get Insights result metadata.", + "properties": { + "totalCount": { + "description": "the total items found for the insights request", + "type": "integer", + "format": "int32" + }, + "errors": { + "description": "information about the failed queries", + "items": { + "$ref": "#/definitions/GetInsightsError" + }, + "type": "array" + } + }, + "required": [ + "totalCount" + ], + "type": "object" + }, + "GetInsightsError": { + "description": "GetInsights Query Errors.", + "properties": { + "kind": { + "description": "the query kind", + "type": "string", + "enum": [ + "Insight" + ] + }, + "queryId": { + "description": "the query id", + "type": "string" + }, + "errorMessage": { + "description": "the error message", + "type": "string" + } + }, + "required": [ + "kind", + "errorMessage" + ], + "type": "object" + }, + "GetQueriesResponse": { + "description": "Retrieve queries for entity result operation response.", + "properties": { + "value": { + "description": "The query result values.", + "items": { + "$ref": "#/definitions/EntityQueryItem" + }, + "type": "array" + } + } + }, + "SecurityAlertTimelineItem": { + "allOf": [ + { + "$ref": "#/definitions/EntityTimelineItem" + } + ], + "description": "Represents security alert timeline item.", + "properties": { + "azureResourceId": { + "type": "string", + "description": "The alert azure resource id." + }, + "productName": { + "type": "string", + "description": "The alert product name." + }, + "description": { + "type": "string", + "description": "The alert description." + }, + "displayName": { + "type": "string", + "description": "The alert name." + }, + "severity": { + "$ref": "SecurityInsights.json#/definitions/AlertSeverity", + "description": "The alert severity." + }, + "endTimeUtc": { + "format": "date-time", + "type": "string", + "description": "The alert end time." + }, + "startTimeUtc": { + "format": "date-time", + "type": "string", + "description": "The alert start time." + }, + "timeGenerated": { + "format": "date-time", + "type": "string", + "description": "The alert generated time." + }, + "alertType": { + "type": "string", + "description": "The name of the alert type." + } + }, + "required": [ + "azureResourceId", + "displayName", + "severity", + "endTimeUtc", + "startTimeUtc", + "timeGenerated", + "alertType" + ], + "type": "object", + "x-ms-discriminator-value": "SecurityAlert" + }, + "TimelineError": { + "description": "Timeline Query Errors.", + "properties": { + "kind": { + "description": "the query kind", + "$ref": "#/definitions/EntityTimelineKind" + }, + "queryId": { + "description": "the query id", + "type": "string" + }, + "errorMessage": { + "description": "the error message", + "type": "string" + } + }, + "required": [ + "kind", + "errorMessage" + ], + "type": "object" + }, + "TimelineResultsMetadata": { + "description": "Expansion result metadata.", + "properties": { + "totalCount": { + "description": "the total items found for the timeline request", + "type": "integer", + "format": "int32" + }, + "aggregations": { + "description": "timeline aggregation per kind", + "items": { + "$ref": "#/definitions/TimelineAggregation" + }, + "type": "array" + }, + "errors": { + "description": "information about the failure queries", + "items": { + "$ref": "#/definitions/TimelineError" + }, + "type": "array" + } + }, + "required": [ + "totalCount", + "aggregations" + ], + "type": "object" + }, + "TimelineAggregation": { + "description": "timeline aggregation information per kind", + "properties": { + "count": { + "description": "the total items found for a kind", + "type": "integer", + "format": "int32" + }, + "kind": { + "description": "the query kind", + "$ref": "#/definitions/EntityTimelineKind" + } + }, + "required": [ + "kind", + "count" + ], + "type": "object" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/OfficeConsents.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/OfficeConsents.json new file mode 100644 index 000000000000..7de815337dc8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/OfficeConsents.json @@ -0,0 +1,243 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2019-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/officeConsents": { + "get": { + "x-ms-examples": { + "Get all office consents.": { + "$ref": "./examples/officeConsents/GetOfficeConsents.json" + } + }, + "tags": [ + "Office Consents" + ], + "description": "Gets all office365 consents.", + "operationId": "OfficeConsents_List", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OfficeConsentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/officeConsents/{consentId}": { + "get": { + "x-ms-examples": { + "Get an office consent.": { + "$ref": "./examples/officeConsents/GetOfficeConsentsById.json" + } + }, + "tags": [ + "Office Consents" + ], + "description": "Gets an office365 consent.", + "operationId": "OfficeConsents_Get", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ConsentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OfficeConsent" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete an office consent.": { + "$ref": "./examples/officeConsents/DeleteOfficeConsents.json" + } + }, + "tags": [ + "Office Consents" + ], + "description": "Delete the office365 consent.", + "operationId": "OfficeConsents_Delete", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ConsentId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + } + } + }, + "parameters": { + "ConsentId": { + "description": "consent ID", + "in": "path", + "name": "consentId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "OfficeConsent": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/Resource" + } + ], + "description": "Consent for Office365 tenant that already made.", + "properties": { + "properties": { + "$ref": "#/definitions/OfficeConsentProperties", + "description": "Office consent properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "OfficeConsentList": { + "description": "List of all the office365 consents.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of office consents.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of the consents.", + "items": { + "$ref": "#/definitions/OfficeConsent" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "OfficeConsentProperties": { + "description": "Consent property bag.", + "properties": { + "tenantId": { + "description": "The tenantId of the Office365 with the consent.", + "type": "string" + }, + "consentId": { + "description": "Help to easily cascade among the data layers.", + "type": "string" + } + }, + "type": "object" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json index f7a1d2656d01..0577a3b91208 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json @@ -573,18 +573,18 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/automationRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors": { "get": { "x-ms-examples": { - "Get all automation rules.": { - "$ref": "./examples/automationRules/GetAllAutomationRules.json" + "Get all data connectors.": { + "$ref": "./examples/dataConnectors/GetDataConnectors.json" } }, "tags": [ - "Automation Rules" + "Data Connectors" ], - "description": "Gets all automation rules.", - "operationId": "AutomationRules_List", + "description": "Gets all data connectors.", + "operationId": "DataConnectors_List", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -606,7 +606,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/AutomationRulesList" + "$ref": "#/definitions/DataConnectorList" } }, "default": { @@ -621,18 +621,54 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/automationRules/{automationRuleId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors/{dataConnectorId}": { "get": { "x-ms-examples": { - "Get an automation rule.": { - "$ref": "./examples/automationRules/GetAutomationRule.json" + "Get an Office365 data connector.": { + "$ref": "./examples/dataConnectors/GetOfficeDataConnetorById.json" + }, + "Get a TI data connector.": { + "$ref": "./examples/dataConnectors/GetThreatIntelligenceById.json" + }, + "Get a TI Taxii data connector.": { + "$ref": "./examples/dataConnectors/GetThreatIntelligenceTaxiiById.json" + }, + "Get a MCAS data connector.": { + "$ref": "./examples/dataConnectors/GetMicrosoftCloudAppSecurityById.json" + }, + "Get a ASC data connector.": { + "$ref": "./examples/dataConnectors/GetAzureSecurityCenterById.json" + }, + "Get an AAD data connector.": { + "$ref": "./examples/dataConnectors/GetAzureActiveDirectoryById.json" + }, + "Get an AwsCloudTrail data connector.": { + "$ref": "./examples/dataConnectors/GetAmazonWebServicesCloudTrailById.json" + }, + "Get an AATP data connector.": { + "$ref": "./examples/dataConnectors/GetAzureAdvancedThreatProtectionById.json" + }, + "Get a MDATP data connector": { + "$ref": "./examples/dataConnectors/GetMicrosoftDefenderAdvancedThreatProtectionById.json" + }, + "Get a Office ATP data connector": { + "$ref": "./examples/dataConnectors/GetOffice365AdvancedThreatProtectionById.json" + }, + "Get a Dynamics365 data connector": { + "$ref": "./examples/dataConnectors/GetDynamics365DataConnectorById.json" + }, + "Get a MicrosoftThreatProtection data connector": { + "$ref": "./examples/dataConnectors/GetMicrosoftThreatProtectionById.json" + }, + "Get a MicrosoftThreatIntelligence data connector": { + "$ref": "./examples/dataConnectors/GetMicrosoftThreatIntelligenceById.json" } }, "tags": [ - "Automation Rules" + "Data Connectors" ], - "description": "Gets the automation rule.", - "operationId": "AutomationRules_Get", + "description": "Gets a data connector.", + "operationId": "DataConnectors_Get", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -650,14 +686,14 @@ "$ref": "#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/AutomationRuleId" + "$ref": "#/parameters/DataConnectorId" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/AutomationRule" + "$ref": "#/definitions/DataConnector" } }, "default": { @@ -670,15 +706,24 @@ }, "put": { "x-ms-examples": { - "Creates or updates an automation rule.": { - "$ref": "./examples/automationRules/CreateAutomationRule.json" + "Creates or updates an Office365 data connector.": { + "$ref": "./examples/dataConnectors/CreateOfficeDataConnetor.json" + }, + "Creates or updates a Threat Intelligence Taxii data connector.": { + "$ref": "./examples/dataConnectors/CreateThreatIntelligenceTaxiiDataConnector.json" + }, + "Creates or updates an Threat Intelligence Platform data connector.": { + "$ref": "./examples/dataConnectors/CreateThreatIntelligenceDataConnector.json" + }, + "Creates or updates a Dynamics365 data connector.": { + "$ref": "./examples/dataConnectors/CreateDynamics365DataConnetor.json" } }, "tags": [ - "Automation Rules" + "Data Connectors" ], - "description": "Creates or updates the automation rule.", - "operationId": "AutomationRules_CreateOrUpdate", + "description": "Creates or updates the data connector.", + "operationId": "DataConnectors_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -696,23 +741,23 @@ "$ref": "#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/AutomationRuleId" + "$ref": "#/parameters/DataConnectorId" }, { - "$ref": "#/parameters/AutomationRule" + "$ref": "#/parameters/DataConnector" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/AutomationRule" + "$ref": "#/definitions/DataConnector" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/AutomationRule" + "$ref": "#/definitions/DataConnector" } }, "default": { @@ -725,15 +770,15 @@ }, "delete": { "x-ms-examples": { - "Delete an automation rule.": { - "$ref": "./examples/automationRules/DeleteAutomationRule.json" + "Delete an Office365 data connector.": { + "$ref": "./examples/dataConnectors/DeleteOfficeDataConnetor.json" } }, "tags": [ - "Automation Rule" + "Data Connectors" ], - "description": "Delete the automation rule.", - "operationId": "AutomationRules_Delete", + "description": "Delete the data connector.", + "operationId": "DataConnectors_Delete", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -751,7 +796,7 @@ "$ref": "#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/AutomationRuleId" + "$ref": "#/parameters/DataConnectorId" } ], "responses": { @@ -770,19 +815,18 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/cases": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/settings": { "get": { "x-ms-examples": { - "Get all cases.": { - "$ref": "./examples/cases/GetCases.json" + "Get EyesOn settings.": { + "$ref": "./examples/settings/GetAllSettings.json" } }, "tags": [ - "Cases" + "Settings" ], - "description": "Gets all cases.", - "deprecated": true, - "operationId": "Cases_List", + "description": "List of all the settings", + "operationId": "ProductSettings_GetAll", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -798,25 +842,13 @@ }, { "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/ODataFilter" - }, - { - "$ref": "#/parameters/ODataOrderBy" - }, - { - "$ref": "#/parameters/ODataTop" - }, - { - "$ref": "#/parameters/ODataSkipToken" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/CaseList" + "$ref": "#/definitions/SettingList" } }, "default": { @@ -825,25 +857,21 @@ "$ref": "#/definitions/CloudError" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/cases/{caseId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/settings/{settingsName}": { "get": { "x-ms-examples": { - "Get a case.": { - "$ref": "./examples/cases/GetCaseById.json" + "Get EyesOn settings.": { + "$ref": "./examples/settings/GetEyesOnSetting.json" } }, "tags": [ - "Cases" + "Settings" ], - "description": "Gets a case.", - "deprecated": true, - "operationId": "Cases_Get", + "description": "Gets a setting.", + "operationId": "ProductSettings_Get", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -861,14 +889,14 @@ "$ref": "#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/CaseId" + "$ref": "#/parameters/SettingsName" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Case" + "$ref": "#/definitions/Settings" } }, "default": { @@ -879,18 +907,17 @@ } } }, - "put": { + "delete": { "x-ms-examples": { - "Creates or updates a case.": { - "$ref": "./examples/cases/CreateCase.json" + "Delete EyesOn settings.": { + "$ref": "./examples/settings/DeleteEyesOnSetting.json" } }, "tags": [ - "Cases" + "Settings" ], - "description": "Creates or updates the case.", - "deprecated": true, - "operationId": "Cases_CreateOrUpdate", + "description": "Delete setting of the product.", + "operationId": "ProductSettings_Delete", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -908,24 +935,15 @@ "$ref": "#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/CaseId" - }, - { - "$ref": "#/parameters/Case" + "$ref": "#/parameters/SettingsName" } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Case" - } + "description": "OK" }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/Case" - } + "204": { + "description": "No Content" }, "default": { "description": "Error response describing why the operation failed.", @@ -935,18 +953,17 @@ } } }, - "delete": { + "put": { "x-ms-examples": { - "Delete a case.": { - "$ref": "./examples/cases/DeleteCase.json" + "Update EyesOn settings.": { + "$ref": "./examples/settings/UpdateEyesOnSetting.json" } }, "tags": [ - "Cases" + "Settings" ], - "description": "Delete the case.", - "deprecated": true, - "operationId": "Cases_Delete", + "description": "Updates setting.", + "operationId": "ProductSettings_Update", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -964,15 +981,18 @@ "$ref": "#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/CaseId" + "$ref": "#/parameters/SettingsName" + }, + { + "$ref": "#/parameters/Settings" } ], "responses": { "200": { - "description": "OK" - }, - "204": { - "description": "No Content" + "description": "OK", + "schema": { + "$ref": "#/definitions/Settings" + } }, "default": { "description": "Error response describing why the operation failed.", @@ -983,19 +1003,18 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/cases/{caseId}/comments": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entityQueries": { "get": { "x-ms-examples": { - "Get all case comments.": { - "$ref": "./examples/cases/comments/GetAllCaseComments.json" + "Get all entity queries.": { + "$ref": "./examples/entityQueries/GetEntityQueries.json" } }, "tags": [ - "CaseComments" + "EntityQueries" ], - "description": "Gets all case comments.", - "deprecated": true, - "operationId": "Comments_ListByCase", + "description": "Gets all entity queries.", + "operationId": "EntityQueries_List", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -1011,28 +1030,13 @@ }, { "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/CaseId" - }, - { - "$ref": "#/parameters/ODataFilter" - }, - { - "$ref": "#/parameters/ODataOrderBy" - }, - { - "$ref": "#/parameters/ODataTop" - }, - { - "$ref": "#/parameters/ODataSkipToken" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/CaseCommentList" + "$ref": "#/definitions/EntityQueryList" } }, "default": { @@ -1042,25 +1046,23 @@ } } }, - "x-ms-odata": "#/definitions/CaseComment", "x-ms-pageable": { "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/cases/{caseId}/comments/{caseCommentId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entityQueries/{entityQueryId}": { "get": { "x-ms-examples": { - "Get a case comment.": { - "$ref": "./examples/cases/comments/GetCaseCommentById.json" + "Get an entity query.": { + "$ref": "./examples/entityQueries/GetExpansionEntityQueryById.json" } }, "tags": [ - "CaseComments" + "EntityQueries" ], - "description": "Gets a case comment.", - "deprecated": true, - "operationId": "Cases_GetComment", + "description": "Gets an entity query.", + "operationId": "EntityQueries_Get", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -1078,17 +1080,14 @@ "$ref": "#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/CaseId" - }, - { - "$ref": "#/parameters/CaseCommentId" + "$ref": "#/parameters/EntityQueryId" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/CaseComment" + "$ref": "#/definitions/EntityQuery" } }, "default": { @@ -1098,19 +1097,20 @@ } } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents": { + "get": { "x-ms-examples": { - "Creates or updates a case comment.": { - "$ref": "./examples/cases/comments/CreateCaseComment.json" + "Get all incidents.": { + "$ref": "./examples/incidents/GetIncidents.json" } }, "tags": [ - "CaseComments" + "Incidents" ], - "description": "Creates the case comment.", - "deprecated": true, - "operationId": "CaseComments_CreateComment", + "description": "Gets all incidents.", + "operationId": "Incidents_List", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -1128,65 +1128,23 @@ "$ref": "#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/CaseId" - }, - { - "$ref": "#/parameters/CaseCommentId" - }, - { - "$ref": "#/parameters/CaseComment" - } - ], - "responses": { - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/CaseComment" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks": { - "get": { - "x-ms-examples": { - "Get all bookmarks.": { - "$ref": "./examples/bookmarks/GetBookmarks.json" - } - }, - "tags": [ - "Bookmarks" - ], - "description": "Gets all bookmarks.", - "operationId": "Bookmarks_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" + "$ref": "#/parameters/ODataFilter" }, { - "$ref": "#/parameters/ResourceGroupName" + "$ref": "#/parameters/ODataOrderBy" }, { - "$ref": "#/parameters/OperationalInsightsResourceProvider" + "$ref": "#/parameters/ODataTop" }, { - "$ref": "#/parameters/WorkspaceName" + "$ref": "#/parameters/ODataSkipToken" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BookmarkList" + "$ref": "#/definitions/IncidentList" } }, "default": { @@ -1201,18 +1159,18 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}": { "get": { "x-ms-examples": { - "Get a bookmark.": { - "$ref": "./examples/bookmarks/GetBookmarkById.json" + "Get an incident.": { + "$ref": "./examples/incidents/GetIncidentById.json" } }, "tags": [ - "Bookmarks" + "Incidents" ], - "description": "Gets a bookmark.", - "operationId": "Bookmarks_Get", + "description": "Gets an incident.", + "operationId": "Incidents_Get", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -1230,14 +1188,14 @@ "$ref": "#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/BookmarkId" + "$ref": "#/parameters/IncidentId" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Bookmark" + "$ref": "#/definitions/Incident" } }, "default": { @@ -1250,15 +1208,15 @@ }, "put": { "x-ms-examples": { - "Creates or updates a bookmark.": { - "$ref": "./examples/bookmarks/CreateBookmark.json" + "Creates or updates an incident.": { + "$ref": "./examples/incidents/CreateIncident.json" } }, "tags": [ - "Bookmarks" + "Incidents" ], - "description": "Creates or updates the bookmark.", - "operationId": "Bookmarks_CreateOrUpdate", + "description": "Creates or updates the incident.", + "operationId": "Incidents_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -1276,23 +1234,23 @@ "$ref": "#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/BookmarkId" + "$ref": "#/parameters/IncidentId" }, { - "$ref": "#/parameters/Bookmark" + "$ref": "#/parameters/Incident" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Bookmark" + "$ref": "#/definitions/Incident" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/Bookmark" + "$ref": "#/definitions/Incident" } }, "default": { @@ -1305,15 +1263,15 @@ }, "delete": { "x-ms-examples": { - "Delete a bookmark.": { - "$ref": "./examples/bookmarks/DeleteBookmark.json" + "Delete an incident.": { + "$ref": "./examples/incidents/DeleteIncident.json" } }, "tags": [ - "Bookmarks" + "Incidents" ], - "description": "Delete the bookmark.", - "operationId": "Bookmarks_Delete", + "description": "Delete the incident.", + "operationId": "Incidents_Delete", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -1331,7 +1289,7 @@ "$ref": "#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/BookmarkId" + "$ref": "#/parameters/IncidentId" } ], "responses": { @@ -1350,19 +1308,114 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/cases/{caseId}/relations": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/alerts": { + "post": { "x-ms-examples": { - "Get all case relations.": { - "$ref": "./examples/cases/relations/GetAllCaseRelations.json" + "Get all incident alerts.": { + "$ref": "./examples/incidents/GetAllIncidentAlerts.json" } }, "tags": [ - "CaseRelations" + "IncidentAlerts" ], - "description": "Gets all case relations.", - "deprecated": true, - "operationId": "CaseRelations_List", + "description": "Gets all incident alerts.", + "operationId": "Incidents_ListOfAlerts", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentAlertList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/bookmarks": { + "post": { + "x-ms-examples": { + "Get all incident bookmarks.": { + "$ref": "./examples/incidents/GetAllIncidentBookmarks.json" + } + }, + "tags": [ + "IncidentBookmarks" + ], + "description": "Gets all incident bookmarks.", + "operationId": "Incidents_ListOfBookmarks", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentBookmarkList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/comments": { + "get": { + "x-ms-examples": { + "Get all incident comments.": { + "$ref": "./examples/incidents/comments/GetAllIncidentComments.json" + } + }, + "tags": [ + "IncidentComments" + ], + "description": "Gets all incident comments.", + "operationId": "IncidentComments_ListByIncident", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -1380,7 +1433,7 @@ "$ref": "#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/CaseId" + "$ref": "#/parameters/IncidentId" }, { "$ref": "#/parameters/ODataFilter" @@ -1399,7 +1452,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/CaseRelationList" + "$ref": "#/definitions/IncidentCommentList" } }, "default": { @@ -1409,25 +1462,24 @@ } } }, - "x-ms-odata": "#/definitions/CaseRelation", + "x-ms-odata": "#/definitions/IncidentComment", "x-ms-pageable": { "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/cases/{caseId}/relations/{relationName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/comments/{incidentCommentId}": { "get": { "x-ms-examples": { - "Get a case relation.": { - "$ref": "./examples/cases/relations/GetCaseRelationByName.json" + "Get an incident comment.": { + "$ref": "./examples/incidents/comments/GetIncidentCommentById.json" } }, "tags": [ - "CaseRelations" + "IncidentComments" ], - "description": "Gets a case relation.", - "deprecated": true, - "operationId": "CaseRelations_GetRelation", + "description": "Gets an incident comment.", + "operationId": "IncidentComments_GetComment", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -1445,17 +1497,17 @@ "$ref": "#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/CaseId" + "$ref": "#/parameters/IncidentId" }, { - "$ref": "#/parameters/RelationName" + "$ref": "#/parameters/IncidentCommentId" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/CaseRelation" + "$ref": "#/definitions/IncidentComment" } }, "default": { @@ -1468,16 +1520,15 @@ }, "put": { "x-ms-examples": { - "Creates or updates a case relation.": { - "$ref": "./examples/cases/relations/CreateCaseRelation.json" + "Creates or updates an incident comment.": { + "$ref": "./examples/incidents/comments/CreateIncidentComment.json" } }, "tags": [ - "CaseRelations" + "IncidentComments" ], - "description": "Creates or updates the case relation.", - "deprecated": true, - "operationId": "CaseRelations_CreateOrUpdateRelation", + "description": "Creates or updates the incident comment.", + "operationId": "IncidentComments_CreateComment", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -1495,26 +1546,26 @@ "$ref": "#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/CaseId" + "$ref": "#/parameters/IncidentId" }, { - "$ref": "#/parameters/RelationName" + "$ref": "#/parameters/IncidentCommentId" }, { - "$ref": "#/parameters/RelationInputModel" + "$ref": "#/parameters/IncidentComment" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/CaseRelation" + "$ref": "#/definitions/IncidentComment" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/CaseRelation" + "$ref": "#/definitions/IncidentComment" } }, "default": { @@ -1527,16 +1578,15 @@ }, "delete": { "x-ms-examples": { - "Delete the case relation.": { - "$ref": "./examples/cases/relations/DeleteCaseRelation.json" + "Delete the incident comment.": { + "$ref": "./examples/incidents/comments/DeleteIncidentComment.json" } }, "tags": [ - "CaseRelations" + "IncidentComments" ], - "description": "Delete the case relation.", - "deprecated": true, - "operationId": "CaseRelations_DeleteRelation", + "description": "Delete the incident comment.", + "operationId": "IncidentComments_DeleteComment", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -1554,10 +1604,10 @@ "$ref": "#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/CaseId" + "$ref": "#/parameters/IncidentId" }, { - "$ref": "#/parameters/RelationName" + "$ref": "#/parameters/IncidentCommentId" } ], "responses": { @@ -1576,18 +1626,18 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}/relations": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/entities": { + "post": { "x-ms-examples": { - "Get all bookmark relations.": { - "$ref": "./examples/bookmarks/relations/GetAllBookmarkRelations.json" + "Gets all incident related entities": { + "$ref": "./examples/incidents/entities/GetAllIncidentEntities.json" } }, "tags": [ - "BookmarkRelations" + "IncidentEntities" ], - "description": "Gets all bookmark relations.", - "operationId": "BookmarkRelations_List", + "description": "Gets all incident related entities.", + "operationId": "Incidents_ListOfEntities", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -1605,26 +1655,14 @@ "$ref": "#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/BookmarkId" - }, - { - "$ref": "#/parameters/ODataFilter" - }, - { - "$ref": "#/parameters/ODataOrderBy" - }, - { - "$ref": "#/parameters/ODataTop" - }, - { - "$ref": "#/parameters/ODataSkipToken" + "$ref": "#/parameters/IncidentId" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/RelationList" + "$ref": "#/definitions/IncidentEntitiesResponse" } }, "default": { @@ -1633,22 +1671,21 @@ "$ref": "#/definitions/CloudError" } } - }, - "x-ms-odata": "#/definitions/Relation", - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}/expand": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/relations": { + "get": { "x-ms-examples": { - "Expand an bookmark": { - "$ref": "./examples/bookmarks/expand/PostExpandBookmark.json" + "Get all incident relations.": { + "$ref": "./examples/incidents/relations/GetAllIncidentRelations.json" } }, - "description": "Expand an bookmark", - "operationId": "Bookmark_Expand", + "tags": [ + "IncidentRelations" + ], + "description": "Gets all incident relations.", + "operationId": "IncidentRelations_List", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -1666,17 +1703,26 @@ "$ref": "#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/BookmarkId" + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/ODataFilter" + }, + { + "$ref": "#/parameters/ODataOrderBy" + }, + { + "$ref": "#/parameters/ODataTop" }, { - "$ref": "#/parameters/BookmarkExpandRequestBody" + "$ref": "#/parameters/ODataSkipToken" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BookmarkExpandResponse" + "$ref": "#/definitions/RelationList" } }, "default": { @@ -1686,23 +1732,24 @@ } } }, - "tags": [ - "Bookmark" - ] + "x-ms-odata": "#/definitions/Relation", + "x-ms-pageable": { + "nextLinkName": "nextLink" + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}/relations/{relationName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/relations/{relationName}": { "get": { "x-ms-examples": { - "Get a bookmark relation.": { - "$ref": "./examples/bookmarks/relations/GetBookmarkRelationByName.json" + "Get an incident relation.": { + "$ref": "./examples/incidents/relations/GetIncidentRelationByName.json" } }, "tags": [ - "BookmarkRelations" + "IncidentRelations" ], - "description": "Gets a bookmark relation.", - "operationId": "BookmarkRelations_GetRelation", + "description": "Gets an incident relation.", + "operationId": "IncidentRelations_GetRelation", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -1720,7 +1767,7 @@ "$ref": "#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/BookmarkId" + "$ref": "#/parameters/IncidentId" }, { "$ref": "#/parameters/RelationName" @@ -1743,15 +1790,15 @@ }, "put": { "x-ms-examples": { - "Creates or updates a bookmark relation.": { - "$ref": "./examples/bookmarks/relations/CreateBookmarkRelation.json" + "Creates or updates an incident relation.": { + "$ref": "./examples/incidents/relations/CreateIncidentRelation.json" } }, "tags": [ - "BookmarkRelations" + "IncidentRelations" ], - "description": "Creates the bookmark relation.", - "operationId": "BookmarkRelations_CreateOrUpdateRelation", + "description": "Creates or updates the incident relation.", + "operationId": "IncidentRelations_CreateOrUpdateRelation", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -1769,7 +1816,7 @@ "$ref": "#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/BookmarkId" + "$ref": "#/parameters/IncidentId" }, { "$ref": "#/parameters/RelationName" @@ -1801,15 +1848,15 @@ }, "delete": { "x-ms-examples": { - "Delete the bookmark relation.": { - "$ref": "./examples/bookmarks/relations/DeleteBookmarkRelation.json" + "Delete the incident relation.": { + "$ref": "./examples/incidents/relations/DeleteIncidentRelation.json" } }, "tags": [ - "BookmarkRelations" + "IncidentRelations" ], - "description": "Delete the bookmark relation.", - "operationId": "BookmarkRelations_DeleteRelation", + "description": "Delete the incident relation.", + "operationId": "IncidentRelations_DeleteRelation", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -1827,7 +1874,7 @@ "$ref": "#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/BookmarkId" + "$ref": "#/parameters/IncidentId" }, { "$ref": "#/parameters/RelationName" @@ -1849,18 +1896,18 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityInsights/enrichment/ip/geodata/": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists": { "get": { "x-ms-examples": { - "Get geodata for a single IP address": { - "$ref": "./examples/enrichment/GetGeodataByIp.json" + "Get all watchlists.": { + "$ref": "./examples/watchlists/GetWatchlists.json" } }, "tags": [ - "Enrichment" + "Watchlists" ], - "description": "Get geodata for a single IP address", - "operationId": "IPGeodata_Get", + "description": "Gets all watchlists, without watchlist items.", + "operationId": "Watchlists_List", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -1872,37 +1919,43 @@ "$ref": "#/parameters/ResourceGroupName" }, { - "$ref": "#/parameters/EnrichmentIpAddress" + "$ref": "#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "#/parameters/WorkspaceName" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/EnrichmentIpGeodata" + "$ref": "#/definitions/WatchlistList" } }, "default": { - "description": "Error response describing why the operation failed to enrich this ip.", + "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityInsights/enrichment/domain/whois/": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}": { "get": { "x-ms-examples": { - "Get whois information for a single domain name": { - "$ref": "./examples/enrichment/GetWhoisByDomainName.json" + "Get a watchlist.": { + "$ref": "./examples/watchlists/GetWatchlistByAlias.json" } }, "tags": [ - "Enrichment" + "Watchlists" ], - "description": "Get whois information for a single domain name", - "operationId": "DomainWhois_Get", + "description": "Gets a watchlist, without its watchlist items.", + "operationId": "Watchlists_Get", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -1914,37 +1967,41 @@ "$ref": "#/parameters/ResourceGroupName" }, { - "$ref": "#/parameters/EnrichmentDomain" + "$ref": "#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WatchlistAlias" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/EnrichmentDomainWhois" + "$ref": "#/definitions/Watchlist" } }, "default": { - "description": "Error response describing why the operation failed to enrich this domain.", + "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors": { - "get": { + }, + "delete": { "x-ms-examples": { - "Get all data connectors.": { - "$ref": "./examples/dataConnectors/GetDataConnectors.json" + "Delete a watchlist.": { + "$ref": "./examples/watchlists/DeleteWatchlist.json" } }, "tags": [ - "Data Connectors" + "Watchlists" ], - "description": "Gets all data connectors.", - "operationId": "DataConnectors_List", + "description": "Delete a watchlist.", + "operationId": "Watchlists_Delete", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -1960,101 +2017,17 @@ }, { "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WatchlistAlias" } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DataConnectorList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors/{dataConnectorId}": { - "get": { - "x-ms-examples": { - "Get an Office365 data connector.": { - "$ref": "./examples/dataConnectors/GetOfficeDataConnetorById.json" - }, - "Get a TI data connector.": { - "$ref": "./examples/dataConnectors/GetThreatIntelligenceById.json" - }, - "Get a TI Taxii data connector.": { - "$ref": "./examples/dataConnectors/GetThreatIntelligenceTaxiiById.json" - }, - "Get a MCAS data connector.": { - "$ref": "./examples/dataConnectors/GetMicrosoftCloudAppSecurityById.json" - }, - "Get a ASC data connector.": { - "$ref": "./examples/dataConnectors/GetAzureSecurityCenterById.json" - }, - "Get an AAD data connector.": { - "$ref": "./examples/dataConnectors/GetAzureActiveDirectoryById.json" - }, - "Get an AwsCloudTrail data connector.": { - "$ref": "./examples/dataConnectors/GetAmazonWebServicesCloudTrailById.json" - }, - "Get an AATP data connector.": { - "$ref": "./examples/dataConnectors/GetAzureAdvancedThreatProtectionById.json" - }, - "Get a MDATP data connector": { - "$ref": "./examples/dataConnectors/GetMicrosoftDefenderAdvancedThreatProtectionById.json" - }, - "Get a Office ATP data connector": { - "$ref": "./examples/dataConnectors/GetOffice365AdvancedThreatProtectionById.json" - }, - "Get a Dynamics365 data connector": { - "$ref": "./examples/dataConnectors/GetDynamics365DataConnectorById.json" - }, - "Get a MicrosoftThreatProtection data connector": { - "$ref": "./examples/dataConnectors/GetMicrosoftThreatProtectionById.json" - }, - "Get a MicrosoftThreatIntelligence data connector": { - "$ref": "./examples/dataConnectors/GetMicrosoftThreatIntelligenceById.json" - } - }, - "tags": [ - "Data Connectors" - ], - "description": "Gets a data connector.", - "operationId": "DataConnectors_Get", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" + "description": "OK" }, - { - "$ref": "#/parameters/DataConnectorId" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DataConnector" - } + "204": { + "description": "No Content" }, "default": { "description": "Error response describing why the operation failed.", @@ -2066,24 +2039,15 @@ }, "put": { "x-ms-examples": { - "Creates or updates an Office365 data connector.": { - "$ref": "./examples/dataConnectors/CreateOfficeDataConnetor.json" - }, - "Creates or updates a Threat Intelligence Taxii data connector.": { - "$ref": "./examples/dataConnectors/CreateThreatIntelligenceTaxiiDataConnector.json" - }, - "Creates or updates an Threat Intelligence Platform data connector.": { - "$ref": "./examples/dataConnectors/CreateThreatIntelligenceDataConnector.json" - }, - "Creates or updates a Dynamics365 data connector.": { - "$ref": "./examples/dataConnectors/CreateDynamics365DataConnetor.json" + "Creates a watchlist.": { + "$ref": "./examples/watchlists/CreateWatchlist.json" } }, "tags": [ - "Data Connectors" + "Watchlists" ], - "description": "Creates or updates the data connector.", - "operationId": "DataConnectors_CreateOrUpdate", + "description": "Creates a watchlist and its watchlist items (bulk creation, e.g. through text/csv content type). To create a Watchlist and its Items, we should call this endpoint twice : the first call will create an empty Watchlist, and the second one will create its Items.", + "operationId": "Watchlists_Create", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -2101,23 +2065,23 @@ "$ref": "#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/DataConnectorId" + "$ref": "#/parameters/WatchlistAlias" }, { - "$ref": "#/parameters/DataConnector" + "$ref": "#/parameters/Watchlist" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/DataConnector" + "$ref": "#/definitions/Watchlist" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/DataConnector" + "$ref": "#/definitions/Watchlist" } }, "default": { @@ -2127,18 +2091,20 @@ } } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}/watchlistItems": { + "get": { "x-ms-examples": { - "Delete an Office365 data connector.": { - "$ref": "./examples/dataConnectors/DeleteOfficeDataConnetor.json" + "Get all watchlist Items.": { + "$ref": "./examples/watchlists/GetWatchlistItems.json" } }, "tags": [ - "Data Connectors" + "WatchlistItems" ], - "description": "Delete the data connector.", - "operationId": "DataConnectors_Delete", + "description": "Gets all watchlist Items.", + "operationId": "WatchlistItems_List", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -2156,15 +2122,15 @@ "$ref": "#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/DataConnectorId" + "$ref": "#/parameters/WatchlistAlias" } ], "responses": { "200": { - "description": "OK" - }, - "204": { - "description": "No Content" + "description": "OK", + "schema": { + "$ref": "#/definitions/WatchlistItemList" + } }, "default": { "description": "Error response describing why the operation failed.", @@ -2172,54 +2138,24 @@ "$ref": "#/definitions/CloudError" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectorsCheckRequirements": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}/watchlistItems/{watchlistItemId}": { + "get": { "x-ms-examples": { - "Check requirements for TI.": { - "$ref": "./examples/dataConnectors/CheckRequirementsThreatIntelligence.json" - }, - "Check requirements for TI Taxii.": { - "$ref": "./examples/dataConnectors/CheckRequirementsThreatIntelligenceTaxii.json" - }, - "Check requirements for AAD.": { - "$ref": "./examples/dataConnectors/CheckRequirementsAzureActiveDirectory.json" - }, - "Check requirements for AAD - no license.": { - "$ref": "./examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoLicense.json" - }, - "Check requirements for AAD - no authorization.": { - "$ref": "./examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoAuthorization.json" - }, - "Check requirements for ASC.": { - "$ref": "./examples/dataConnectors/CheckRequirementsAzureSecurityCenter.json" - }, - "Check requirements for Mcas.": { - "$ref": "./examples/dataConnectors/CheckRequirementsMicrosoftCloudAppSecurity.json" - }, - "Check requirements for Mdatp.": { - "$ref": "./examples/dataConnectors/CheckRequirementsMdatp.json" - }, - "Check requirements for OfficeATP.": { - "$ref": "./examples/dataConnectors/CheckRequirementsOfficeATP.json" - }, - "Check requirements for Dynamics365.": { - "$ref": "./examples/dataConnectors/CheckRequirementsDynamics365.json" - }, - "Check requirements for MicrosoftThreatProtection.": { - "$ref": "./examples/dataConnectors/CheckRequirementsMicrosoftThreatProtection.json" - }, - "Check requirements for MicrosoftThreatIntelligence.": { - "$ref": "./examples/dataConnectors/CheckRequirementsMicrosoftThreatIntelligence.json" + "Get a watchlist item.": { + "$ref": "./examples/watchlists/GetWatchlistItemById.json" } }, "tags": [ - "Check Data Connector Requirements" + "WatchlistItems" ], - "description": "Get requirements state for a data connector type.", - "operationId": "DataConnectorsCheckRequirements_Post", + "description": "Gets a watchlist, without its watchlist items.", + "operationId": "WatchlistItems_Get", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -2230,21 +2166,24 @@ { "$ref": "#/parameters/ResourceGroupName" }, + { + "$ref": "#/parameters/OperationalInsightsResourceProvider" + }, { "$ref": "#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/OperationalInsightsResourceProvider" + "$ref": "#/parameters/WatchlistAlias" }, { - "$ref": "#/parameters/DataConnectorsCheckRequirementsBody" + "$ref": "#/parameters/WatchlistItemId" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/DataConnectorRequirementsState" + "$ref": "#/definitions/WatchlistItem" } }, "default": { @@ -2254,20 +2193,18 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities": { - "get": { + }, + "delete": { "x-ms-examples": { - "Get all entities.": { - "$ref": "./examples/entities/GetEntities.json" + "Delete a watchlist Item.": { + "$ref": "./examples/watchlists/DeleteWatchlistItem.json" } }, "tags": [ - "Entities" + "WatchlistItems" ], - "description": "Gets all entities.", - "operationId": "Entities_List", + "description": "Delete a watchlist item.", + "operationId": "WatchlistItems_Delete", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -2283,14 +2220,20 @@ }, { "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WatchlistAlias" + }, + { + "$ref": "#/parameters/WatchlistItemId" } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/EntityList" - } + "description": "OK" + }, + "204": { + "description": "No Content" }, "default": { "description": "Error response describing why the operation failed.", @@ -2298,81 +2241,19 @@ "$ref": "#/definitions/CloudError" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityId}": { - "get": { + }, + "put": { "x-ms-examples": { - "Get an account entity.": { - "$ref": "./examples/entities/GetAccountEntityById.json" - }, - "Get a host entity.": { - "$ref": "./examples/entities/GetHostEntityById.json" - }, - "Get a file entity.": { - "$ref": "./examples/entities/GetFileEntityById.json" - }, - "Get a security alert entity.": { - "$ref": "./examples/entities/GetSecurityAlertEntityById.json" - }, - "Get a file hash entity.": { - "$ref": "./examples/entities/GetFileHashEntityById.json" - }, - "Get a malware entity.": { - "$ref": "./examples/entities/GetMalwareEntityById.json" - }, - "Get a security group entity.": { - "$ref": "./examples/entities/GetSecurityGroupEntityById.json" - }, - "Get an azure resource entity.": { - "$ref": "./examples/entities/GetAzureResourceEntityById.json" - }, - "Get a cloud application entity.": { - "$ref": "./examples/entities/GetCloudApplicationEntityById.json" - }, - "Get a process entity.": { - "$ref": "./examples/entities/GetProcessEntityById.json" - }, - "Get a dns entity.": { - "$ref": "./examples/entities/GetDnsEntityById.json" - }, - "Get an ip entity.": { - "$ref": "./examples/entities/GetIpEntityById.json" - }, - "Get a registry key entity.": { - "$ref": "./examples/entities/GetRegistryKeyEntityById.json" - }, - "Get a registry value entity.": { - "$ref": "./examples/entities/GetRegistryValueEntityById.json" - }, - "Get a url entity.": { - "$ref": "./examples/entities/GetUrlEntityById.json" - }, - "Get an IoT device entity.": { - "$ref": "./examples/entities/GetIoTDeviceEntityById.json" - }, - "Get a mailCluster entity.": { - "$ref": "./examples/entities/GetMailClusterEntityById.json" - }, - "Get a mailbox entity.": { - "$ref": "./examples/entities/GetMailboxEntityById.json" - }, - "Get a mailMessage entity.": { - "$ref": "./examples/entities/GetMailMessageEntityById.json" - }, - "Get a submissionMail entity.": { - "$ref": "./examples/entities/GetSubmissionMailEntityById.json" + "Creates or updates a watchlist item.": { + "$ref": "./examples/watchlists/CreateWatchlistItem.json" } }, "tags": [ - "Entities" + "WatchlistItems" ], - "description": "Gets an entity.", - "operationId": "Entities_Get", + "description": "Creates or updates a watchlist item.", + "operationId": "WatchlistItems_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -2390,14 +2271,26 @@ "$ref": "#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/EntityId" + "$ref": "#/parameters/WatchlistAlias" + }, + { + "$ref": "#/parameters/WatchlistItemId" + }, + { + "$ref": "#/parameters/WatchlistItem" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Entity" + "$ref": "#/definitions/WatchlistItem" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/WatchlistItem" } }, "default": { @@ -2408,10521 +2301,4957 @@ } } } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityId}/expand": { - "post": { - "x-ms-examples": { - "Expand an entity": { - "$ref": "./examples/entities/expand/PostExpandEntity.json" - } + } + }, + "definitions": { + "Aggregations": { + "allOf": [ + { + "$ref": "#/definitions/Resource" }, - "tags": [ - "Entities" - ], - "description": "Expands an entity.", - "operationId": "Entities_Expand", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/EntityId" - }, - { - "$ref": "#/parameters/EntityExpandRequestBody" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/EntityExpandResponse" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } + { + "$ref": "#/definitions/AggregationsKind" } - } + ], + "description": "The aggregation.", + "discriminator": "kind", + "type": "object", + "required": [ + "kind" + ] }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityId}/getTimeline": { - "post": { - "x-ms-examples": { - "Entity timeline": { - "$ref": "./examples/entities/timeline/PostTimelineEntity.json" - } - }, - "tags": [ - "Entities" - ], - "description": "Timeline for an entity.", - "operationId": "EntitiesGetTimeline_list", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/EntityId" - }, - { - "$ref": "#/parameters/EntityTimelineRequestBody" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/EntityTimelineResponse" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } + "AggregationsKind": { + "description": "Describes an Azure resource with kind.", + "properties": { + "kind": { + "description": "The kind of the setting", + "enum": [ + "CasesAggregation" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AggregationsKind" } } - } + }, + "required": [ + "kind" + ], + "type": "object" }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityId}/queries": { - "get": { - "x-ms-examples": { - "Get Entity Query": { - "$ref": "./examples/entities/GetQueries.json" - } + "MLBehaviorAnalyticsAlertRule": { + "allOf": [ + { + "$ref": "#/definitions/AlertRule" + } + ], + "description": "Represents MLBehaviorAnalytics alert rule.", + "properties": { + "properties": { + "$ref": "#/definitions/MLBehaviorAnalyticsAlertRuleProperties", + "description": "MLBehaviorAnalytics alert rule properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MLBehaviorAnalytics" + }, + "MLBehaviorAnalyticsAlertRuleProperties": { + "description": "MLBehaviorAnalytics alert rule base property bag.", + "properties": { + "alertRuleTemplateName": { + "description": "The Name of the alert rule template used to create this rule.", + "type": "string" }, - "tags": [ - "Entities" - ], - "description": "Get Insights and Activities for an entity.", - "operationId": "Entities_Queries", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/EntityId" + "description": { + "description": "The description of the alert rule.", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "The display name for alerts created by this alert rule.", + "readOnly": true, + "type": "string" + }, + "enabled": { + "description": "Determines whether this alert rule is enabled or disabled.", + "type": "boolean" + }, + "lastModifiedUtc": { + "description": "The last time that this alert rule has been modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "severity": { + "$ref": "#/definitions/AlertSeverity", + "description": "The severity for alerts created by this alert rule.", + "readOnly": true + }, + "tactics": { + "description": "The tactics of the alert rule", + "items": { + "$ref": "#/definitions/AttackTactic" }, - { - "$ref": "#/parameters/EntityQueryKindParam" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/GetQueriesResponse" + "readOnly": true, + "type": "array" + } + }, + "required": [ + "alertRuleTemplateName", + "enabled" + ], + "type": "object" + }, + "MLBehaviorAnalyticsAlertRuleTemplate": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplate" + } + ], + "description": "Represents MLBehaviorAnalytics alert rule template.", + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplatePropertiesBase" } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" + ], + "description": "MLBehaviorAnalytics alert rule template properties.", + "properties": { + "severity": { + "$ref": "#/definitions/AlertSeverity", + "description": "The severity for alerts created by this alert rule." + }, + "tactics": { + "description": "The tactics of the alert rule template.", + "items": { + "$ref": "#/definitions/AttackTactic" + }, + "type": "array" } - } + }, + "required": [ + "displayName", + "description", + "status", + "severity", + "alertRulesCreatedByTemplateCount" + ], + "x-ms-client-flatten": true } - } + }, + "type": "object", + "x-ms-discriminator-value": "MLBehaviorAnalytics" }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityId}/getInsights": { - "post": { - "x-ms-examples": { - "Entity Insight": { - "$ref": "./examples/entities/insights/PostGetInsights.json" - } + "AADDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents AAD (Azure Active Directory) data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/AADDataConnectorProperties", + "description": "AAD (Azure Active Directory) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AzureActiveDirectory" + }, + "AADDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" }, - "tags": [ - "Entities" - ], - "description": "Execute Insights for an entity.", - "operationId": "Entities_GetInsights", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/EntityId" - }, - { - "$ref": "#/parameters/GetInsightsEntityQueriesRequestBody" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/EntityGetInsightsResponse" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } + { + "$ref": "#/definitions/DataConnectorWithAlertsProperties" } - } + ], + "description": "AAD (Azure Active Directory) data connector properties.", + "type": "object" }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityId}/relations": { - "get": { - "x-ms-examples": { - "Get all relations of an entity.": { - "$ref": "./examples/entities/relations/GetAllEntityRelations.json" - } - }, - "tags": [ - "EntityRelations" - ], - "description": "Gets all relations of an entity.", - "operationId": "EntitiesRelations_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/EntityId" - }, - { - "$ref": "#/parameters/ODataFilter" - }, - { - "$ref": "#/parameters/ODataOrderBy" - }, - { - "$ref": "#/parameters/ODataTop" - }, - { - "$ref": "#/parameters/ODataSkipToken" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RelationList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-odata": "#/definitions/Relation", - "x-ms-pageable": { - "nextLinkName": "nextLink" + "AATPDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" } - } + ], + "description": "Represents AATP (Azure Advanced Threat Protection) data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/AATPDataConnectorProperties", + "description": "AATP (Azure Advanced Threat Protection) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AzureAdvancedThreatProtection" }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityId}/relations/{relationName}": { - "get": { - "x-ms-examples": { - "Get an entity relation.": { - "$ref": "./examples/entities/relations/GetEntityRelationByName.json" - } + "AATPDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" }, - "tags": [ - "EntityRelations" - ], - "description": "Gets an entity relation.", - "operationId": "EntityRelations_GetRelation", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/EntityId" - }, - { - "$ref": "#/parameters/RelationName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Relation" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } + { + "$ref": "#/definitions/DataConnectorWithAlertsProperties" } - } + ], + "description": "AATP (Azure Advanced Threat Protection) data connector properties.", + "type": "object" }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/officeConsents": { - "get": { - "x-ms-examples": { - "Get all office consents.": { - "$ref": "./examples/officeConsents/GetOfficeConsents.json" - } - }, - "tags": [ - "Office Consents" - ], - "description": "Gets all office365 consents.", - "operationId": "OfficeConsents_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/OfficeConsentList" + "MSTIDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents Microsoft Threat Intelligence data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/MSTIDataConnectorProperties", + "description": "Microsoft Threat Intelligence data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftThreatIntelligence" + }, + "MSTIDataConnectorDataTypes": { + "description": "The available data types for Microsoft Threat Intelligence Platforms data connector.", + "properties": { + "bingSafetyPhishingURL": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" + ], + "properties": { + "lookbackPeriod": { + "description": "lookback period", + "type": "string" } - } + }, + "description": "Data type for Microsoft Threat Intelligence Platforms data connector.", + "type": "object", + "required": [ + "lookbackPeriod" + ] }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "microsoftEmergingThreatFeed": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "properties": { + "lookbackPeriod": { + "description": "lookback period", + "type": "string" + } + }, + "description": "Data type for Microsoft Threat Intelligence Platforms data connector.", + "type": "object", + "required": [ + "lookbackPeriod" + ] } - } + }, + "type": "object", + "required": [ + "bingSafetyPhishingURL", + "microsoftEmergingThreatFeed" + ] }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/officeConsents/{consentId}": { - "get": { - "x-ms-examples": { - "Get an office consent.": { - "$ref": "./examples/officeConsents/GetOfficeConsentsById.json" - } - }, - "tags": [ - "Office Consents" - ], - "description": "Gets an office365 consent.", - "operationId": "OfficeConsents_Get", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/ConsentId" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/OfficeConsent" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "x-ms-examples": { - "Delete an office consent.": { - "$ref": "./examples/officeConsents/DeleteOfficeConsents.json" - } - }, - "tags": [ - "Office Consents" - ], - "description": "Delete the office365 consent.", - "operationId": "OfficeConsents_Delete", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/ConsentId" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/settings": { - "get": { - "x-ms-examples": { - "Get EyesOn settings.": { - "$ref": "./examples/settings/GetAllSettings.json" - } - }, - "tags": [ - "Settings" - ], - "description": "List of all the settings", - "operationId": "ProductSettings_GetAll", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SettingList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/settings/{settingsName}": { - "get": { - "x-ms-examples": { - "Get EyesOn settings.": { - "$ref": "./examples/settings/GetEyesOnSetting.json" - } - }, - "tags": [ - "Settings" - ], - "description": "Gets a setting.", - "operationId": "ProductSettings_Get", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/SettingsName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Settings" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "x-ms-examples": { - "Delete EyesOn settings.": { - "$ref": "./examples/settings/DeleteEyesOnSetting.json" - } - }, - "tags": [ - "Settings" - ], - "description": "Delete setting of the product.", - "operationId": "ProductSettings_Delete", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/SettingsName" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "x-ms-examples": { - "Update EyesOn settings.": { - "$ref": "./examples/settings/UpdateEyesOnSetting.json" - } - }, - "tags": [ - "Settings" - ], - "description": "Updates setting.", - "operationId": "ProductSettings_Update", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/SettingsName" - }, - { - "$ref": "#/parameters/Settings" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Settings" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/aggregations/{aggregationsName}": { - "get": { - "x-ms-examples": { - "Get aggregative data for all cases under the defined workspace, between the time range if specified.": { - "$ref": "./examples/aggregations/GetCasesAggregations.json" - } - }, - "tags": [ - "Aggregations" - ], - "description": "Get aggregative result for the given resources under the defined workspace", - "operationId": "CasesAggregations_Get", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/AggregationsName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Aggregations" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entityQueries": { - "get": { - "x-ms-examples": { - "Get all entity queries.": { - "$ref": "./examples/entityQueries/GetEntityQueries.json" - } - }, - "tags": [ - "EntityQueries" - ], - "description": "Gets all entity queries.", - "operationId": "EntityQueries_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/EntityQueryList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entityQueries/{entityQueryId}": { - "get": { - "x-ms-examples": { - "Get an entity query.": { - "$ref": "./examples/entityQueries/GetExpansionEntityQueryById.json" - } - }, - "tags": [ - "EntityQueries" - ], - "description": "Gets an entity query.", - "operationId": "EntityQueries_Get", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/EntityQueryId" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/EntityQuery" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents": { - "get": { - "x-ms-examples": { - "Get all incidents.": { - "$ref": "./examples/incidents/GetIncidents.json" - } - }, - "tags": [ - "Incidents" - ], - "description": "Gets all incidents.", - "operationId": "Incidents_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/ODataFilter" - }, - { - "$ref": "#/parameters/ODataOrderBy" - }, - { - "$ref": "#/parameters/ODataTop" - }, - { - "$ref": "#/parameters/ODataSkipToken" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/IncidentList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}": { - "get": { - "x-ms-examples": { - "Get an incident.": { - "$ref": "./examples/incidents/GetIncidentById.json" - } - }, - "tags": [ - "Incidents" - ], - "description": "Gets an incident.", - "operationId": "Incidents_Get", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/IncidentId" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Incident" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "x-ms-examples": { - "Creates or updates an incident.": { - "$ref": "./examples/incidents/CreateIncident.json" - } - }, - "tags": [ - "Incidents" - ], - "description": "Creates or updates the incident.", - "operationId": "Incidents_CreateOrUpdate", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/IncidentId" - }, - { - "$ref": "#/parameters/Incident" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Incident" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/Incident" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "x-ms-examples": { - "Delete an incident.": { - "$ref": "./examples/incidents/DeleteIncident.json" - } - }, - "tags": [ - "Incidents" - ], - "description": "Delete the incident.", - "operationId": "Incidents_Delete", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/IncidentId" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/alerts": { - "post": { - "x-ms-examples": { - "Get all incident alerts.": { - "$ref": "./examples/incidents/GetAllIncidentAlerts.json" - } - }, - "tags": [ - "IncidentAlerts" - ], - "description": "Gets all incident alerts.", - "operationId": "Incidents_ListOfAlerts", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/IncidentId" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/IncidentAlertList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/bookmarks": { - "post": { - "x-ms-examples": { - "Get all incident bookmarks.": { - "$ref": "./examples/incidents/GetAllIncidentBookmarks.json" - } - }, - "tags": [ - "IncidentBookmarks" - ], - "description": "Gets all incident bookmarks.", - "operationId": "Incidents_ListOfBookmarks", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/IncidentId" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/IncidentBookmarkList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/comments": { - "get": { - "x-ms-examples": { - "Get all incident comments.": { - "$ref": "./examples/incidents/comments/GetAllIncidentComments.json" - } - }, - "tags": [ - "IncidentComments" - ], - "description": "Gets all incident comments.", - "operationId": "IncidentComments_ListByIncident", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/IncidentId" - }, - { - "$ref": "#/parameters/ODataFilter" - }, - { - "$ref": "#/parameters/ODataOrderBy" - }, - { - "$ref": "#/parameters/ODataTop" - }, - { - "$ref": "#/parameters/ODataSkipToken" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/IncidentCommentList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-odata": "#/definitions/IncidentComment", - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/comments/{incidentCommentId}": { - "get": { - "x-ms-examples": { - "Get an incident comment.": { - "$ref": "./examples/incidents/comments/GetIncidentCommentById.json" - } - }, - "tags": [ - "IncidentComments" - ], - "description": "Gets an incident comment.", - "operationId": "IncidentComments_GetComment", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/IncidentId" - }, - { - "$ref": "#/parameters/IncidentCommentId" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/IncidentComment" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "x-ms-examples": { - "Creates or updates an incident comment.": { - "$ref": "./examples/incidents/comments/CreateIncidentComment.json" - } - }, - "tags": [ - "IncidentComments" - ], - "description": "Creates or updates the incident comment.", - "operationId": "IncidentComments_CreateComment", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/IncidentId" - }, - { - "$ref": "#/parameters/IncidentCommentId" - }, - { - "$ref": "#/parameters/IncidentComment" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/IncidentComment" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/IncidentComment" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "x-ms-examples": { - "Delete the incident comment.": { - "$ref": "./examples/incidents/comments/DeleteIncidentComment.json" - } - }, - "tags": [ - "IncidentComments" - ], - "description": "Delete the incident comment.", - "operationId": "IncidentComments_DeleteComment", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/IncidentId" - }, - { - "$ref": "#/parameters/IncidentCommentId" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/entities": { - "post": { - "x-ms-examples": { - "Gets all incident related entities": { - "$ref": "./examples/incidents/entities/GetAllIncidentEntities.json" - } - }, - "tags": [ - "IncidentEntities" - ], - "description": "Gets all incident related entities.", - "operationId": "Incidents_ListOfEntities", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/IncidentId" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/IncidentEntitiesResponse" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/relations": { - "get": { - "x-ms-examples": { - "Get all incident relations.": { - "$ref": "./examples/incidents/relations/GetAllIncidentRelations.json" - } - }, - "tags": [ - "IncidentRelations" - ], - "description": "Gets all incident relations.", - "operationId": "IncidentRelations_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/IncidentId" - }, - { - "$ref": "#/parameters/ODataFilter" - }, - { - "$ref": "#/parameters/ODataOrderBy" - }, - { - "$ref": "#/parameters/ODataTop" - }, - { - "$ref": "#/parameters/ODataSkipToken" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RelationList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-odata": "#/definitions/Relation", - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/relations/{relationName}": { - "get": { - "x-ms-examples": { - "Get an incident relation.": { - "$ref": "./examples/incidents/relations/GetIncidentRelationByName.json" - } - }, - "tags": [ - "IncidentRelations" - ], - "description": "Gets an incident relation.", - "operationId": "IncidentRelations_GetRelation", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/IncidentId" - }, - { - "$ref": "#/parameters/RelationName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Relation" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "x-ms-examples": { - "Creates or updates an incident relation.": { - "$ref": "./examples/incidents/relations/CreateIncidentRelation.json" - } - }, - "tags": [ - "IncidentRelations" - ], - "description": "Creates or updates the incident relation.", - "operationId": "IncidentRelations_CreateOrUpdateRelation", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/IncidentId" - }, - { - "$ref": "#/parameters/RelationName" - }, - { - "$ref": "#/parameters/Relation" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Relation" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/Relation" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "x-ms-examples": { - "Delete the incident relation.": { - "$ref": "./examples/incidents/relations/DeleteIncidentRelation.json" - } - }, - "tags": [ - "IncidentRelations" - ], - "description": "Delete the incident relation.", - "operationId": "IncidentRelations_DeleteRelation", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/IncidentId" - }, - { - "$ref": "#/parameters/RelationName" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists": { - "get": { - "x-ms-examples": { - "Get all watchlists.": { - "$ref": "./examples/watchlists/GetWatchlists.json" - } - }, - "tags": [ - "Watchlists" - ], - "description": "Gets all watchlists, without watchlist items.", - "operationId": "Watchlists_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/WatchlistList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}": { - "get": { - "x-ms-examples": { - "Get a watchlist.": { - "$ref": "./examples/watchlists/GetWatchlistByAlias.json" - } - }, - "tags": [ - "Watchlists" - ], - "description": "Gets a watchlist, without its watchlist items.", - "operationId": "Watchlists_Get", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/WatchlistAlias" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Watchlist" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "x-ms-examples": { - "Delete a watchlist.": { - "$ref": "./examples/watchlists/DeleteWatchlist.json" - } - }, - "tags": [ - "Watchlists" - ], - "description": "Delete a watchlist.", - "operationId": "Watchlists_Delete", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/WatchlistAlias" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "x-ms-examples": { - "Creates a watchlist.": { - "$ref": "./examples/watchlists/CreateWatchlist.json" - } - }, - "tags": [ - "Watchlists" - ], - "description": "Creates a watchlist and its watchlist items (bulk creation, e.g. through text/csv content type). To create a Watchlist and its Items, we should call this endpoint twice : the first call will create an empty Watchlist, and the second one will create its Items.", - "operationId": "Watchlists_Create", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/WatchlistAlias" - }, - { - "$ref": "#/parameters/Watchlist" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Watchlist" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/Watchlist" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}/watchlistItems": { - "get": { - "x-ms-examples": { - "Get all watchlist Items.": { - "$ref": "./examples/watchlists/GetWatchlistItems.json" - } - }, - "tags": [ - "WatchlistItems" - ], - "description": "Gets all watchlist Items.", - "operationId": "WatchlistItems_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/WatchlistAlias" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/WatchlistItemList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}/watchlistItems/{watchlistItemId}": { - "get": { - "x-ms-examples": { - "Get a watchlist item.": { - "$ref": "./examples/watchlists/GetWatchlistItemById.json" - } - }, - "tags": [ - "WatchlistItems" - ], - "description": "Gets a watchlist, without its watchlist items.", - "operationId": "WatchlistItems_Get", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/WatchlistAlias" - }, - { - "$ref": "#/parameters/WatchlistItemId" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/WatchlistItem" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "x-ms-examples": { - "Delete a watchlist Item.": { - "$ref": "./examples/watchlists/DeleteWatchlistItem.json" - } - }, - "tags": [ - "WatchlistItems" - ], - "description": "Delete a watchlist item.", - "operationId": "WatchlistItems_Delete", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/WatchlistAlias" - }, - { - "$ref": "#/parameters/WatchlistItemId" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "x-ms-examples": { - "Creates or updates a watchlist item.": { - "$ref": "./examples/watchlists/CreateWatchlistItem.json" - } - }, - "tags": [ - "WatchlistItems" - ], - "description": "Creates or updates a watchlist item.", - "operationId": "WatchlistItems_CreateOrUpdate", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/WatchlistAlias" - }, - { - "$ref": "#/parameters/WatchlistItemId" - }, - { - "$ref": "#/parameters/WatchlistItem" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/WatchlistItem" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/WatchlistItem" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/createIndicator": { - "post": { - "x-ms-examples": { - "Create a new Threat Intelligence": { - "$ref": "./examples/threatintelligence/CreateThreatIntelligence.json" - } - }, - "tags": [ - "ThreatIntelligence" - ], - "description": "Create a new threat intelligence indicator.", - "operationId": "ThreatIntelligenceIndicator_CreateIndicator", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/ThreatIntelligenceProperties" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ThreatIntelligenceInformation" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/ThreatIntelligenceInformation" - } - }, - "default": { - "description": "Error response describing why the operation failed to create indicators.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators": { - "get": { - "x-ms-examples": { - "Get all threat intelligence indicators": { - "$ref": "./examples/threatintelligence/GetThreatIntelligence.json" - } - }, - "tags": [ - "ThreatIntelligence" - ], - "description": "Get all threat intelligence indicators.", - "operationId": "ThreatIntelligenceIndicators_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/ODataFilter" - }, - { - "$ref": "#/parameters/ODataTop" - }, - { - "$ref": "#/parameters/ODataSkipToken" - }, - { - "$ref": "#/parameters/ODataOrderBy" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ThreatIntelligenceInformationList" - } - }, - "default": { - "description": "Error response describing why the operation failed to get indicators.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators/{name}": { - "get": { - "x-ms-examples": { - "View a threat intelligence indicator by name": { - "$ref": "./examples/threatintelligence/GetThreatIntelligenceById.json" - } - }, - "tags": [ - "ThreatIntelligence" - ], - "description": "View a threat intelligence indicator by name.", - "operationId": "ThreatIntelligenceIndicator_Get", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/ThreatIntelligenceName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ThreatIntelligenceInformation" - } - }, - "default": { - "description": "Error response describing why the operation failed to view an indicator.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "x-ms-examples": { - "Update a threat Intelligence indicator": { - "$ref": "./examples/threatintelligence/UpdateThreatIntelligence.json" - } - }, - "tags": [ - "ThreatIntelligence" - ], - "description": "Update a threat Intelligence indicator.", - "operationId": "ThreatIntelligenceIndicator_Create", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/ThreatIntelligenceName" - }, - { - "$ref": "#/parameters/ThreatIntelligenceProperties" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ThreatIntelligenceInformation" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/ThreatIntelligenceInformation" - } - }, - "default": { - "description": "Error response describing why the operation failed to update an indicator.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "x-ms-examples": { - "Delete a threat intelligence indicator": { - "$ref": "./examples/threatintelligence/DeleteThreatIntelligence.json" - } - }, - "tags": [ - "ThreatIntelligence" - ], - "description": "Delete a threat intelligence indicator.", - "operationId": "ThreatIntelligenceIndicator_Delete", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/ThreatIntelligenceName" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed to delete an indicator.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/queryIndicators": { - "post": { - "x-ms-examples": { - "Query threat intelligence indicators as per filtering criteria": { - "$ref": "./examples/threatintelligence/QueryThreatIntelligence.json" - } - }, - "tags": [ - "ThreatIntelligence" - ], - "description": "Query threat intelligence indicators as per filtering criteria.", - "operationId": "ThreatIntelligenceIndicator_QueryIndicators", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/ThreatIntelligenceFilteringCriteria" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ThreatIntelligenceInformationList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/metrics": { - "get": { - "x-ms-examples": { - "Get threat intelligence indicators metrics.": { - "$ref": "./examples/threatintelligence/CollectThreatIntelligenceMetrics.json" - } - }, - "tags": [ - "ThreatIntelligence" - ], - "description": "Get threat intelligence indicators metrics (Indicators counts by Type, Threat Type, Source).", - "operationId": "ThreatIntelligenceIndicatorMetrics_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ThreatIntelligenceMetricsList" - } - }, - "default": { - "description": "Error response describing why the operation failed to get metrics.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators/{name}/appendTags": { - "post": { - "x-ms-examples": { - "Append tags to a threat intelligence indicator": { - "$ref": "./examples/threatintelligence/AppendTagsThreatIntelligence.json" - } - }, - "tags": [ - "ThreatIntelligence" - ], - "description": "Append tags to a threat intelligence indicator.", - "operationId": "ThreatIntelligenceIndicator_AppendTags", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/ThreatIntelligenceName" - }, - { - "$ref": "#/parameters/ThreatIntelligenceAppendTags" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "default": { - "description": "Error response describing why the operation failed to append tags.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators/{name}/replaceTags": { - "post": { - "x-ms-examples": { - "Replace tags to a Threat Intelligence": { - "$ref": "./examples/threatintelligence/ReplaceTagsThreatIntelligence.json" - } - }, - "tags": [ - "ThreatIntelligence" - ], - "description": "Replace tags added to a threat intelligence indicator.", - "operationId": "ThreatIntelligenceIndicator_ReplaceTags", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/ThreatIntelligenceName" - }, - { - "$ref": "#/parameters/ThreatIntelligenceReplaceTags" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ThreatIntelligenceInformation" - } - }, - "default": { - "description": "Error response describing why the operation failed to replace tags.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "MLBehaviorAnalyticsAlertRule": { - "allOf": [ - { - "$ref": "#/definitions/AlertRule" - } - ], - "description": "Represents MLBehaviorAnalytics alert rule.", - "properties": { - "properties": { - "$ref": "#/definitions/MLBehaviorAnalyticsAlertRuleProperties", - "description": "MLBehaviorAnalytics alert rule properties", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "MLBehaviorAnalytics" - }, - "MLBehaviorAnalyticsAlertRuleProperties": { - "description": "MLBehaviorAnalytics alert rule base property bag.", - "properties": { - "alertRuleTemplateName": { - "description": "The Name of the alert rule template used to create this rule.", - "type": "string" - }, - "description": { - "description": "The description of the alert rule.", - "readOnly": true, - "type": "string" - }, - "displayName": { - "description": "The display name for alerts created by this alert rule.", - "readOnly": true, - "type": "string" - }, - "enabled": { - "description": "Determines whether this alert rule is enabled or disabled.", - "type": "boolean" - }, - "lastModifiedUtc": { - "description": "The last time that this alert rule has been modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "severity": { - "$ref": "#/definitions/AlertSeverity", - "description": "The severity for alerts created by this alert rule.", - "readOnly": true - }, - "tactics": { - "description": "The tactics of the alert rule", - "items": { - "$ref": "#/definitions/AttackTactic" - }, - "readOnly": true, - "type": "array" - } - }, - "required": [ - "alertRuleTemplateName", - "enabled" - ], - "type": "object" - }, - "MLBehaviorAnalyticsAlertRuleTemplate": { - "allOf": [ - { - "$ref": "#/definitions/AlertRuleTemplate" - } - ], - "description": "Represents MLBehaviorAnalytics alert rule template.", - "properties": { - "properties": { - "allOf": [ - { - "$ref": "#/definitions/AlertRuleTemplatePropertiesBase" - } - ], - "description": "MLBehaviorAnalytics alert rule template properties.", - "properties": { - "severity": { - "$ref": "#/definitions/AlertSeverity", - "description": "The severity for alerts created by this alert rule." - }, - "tactics": { - "description": "The tactics of the alert rule template.", - "items": { - "$ref": "#/definitions/AttackTactic" - }, - "type": "array" - } - }, - "required": [ - "displayName", - "description", - "status", - "severity", - "alertRulesCreatedByTemplateCount" - ], - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "MLBehaviorAnalytics" - }, - "AADDataConnector": { - "allOf": [ - { - "$ref": "#/definitions/DataConnector" - } - ], - "description": "Represents AAD (Azure Active Directory) data connector.", - "properties": { - "properties": { - "$ref": "#/definitions/AADDataConnectorProperties", - "description": "AAD (Azure Active Directory) data connector properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "AzureActiveDirectory" - }, - "AADDataConnectorProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" - }, - { - "$ref": "#/definitions/DataConnectorWithAlertsProperties" - } - ], - "description": "AAD (Azure Active Directory) data connector properties.", - "type": "object" - }, - "AADCheckRequirements": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorsCheckRequirements" - } - ], - "description": "Represents AAD (Azure Active Directory) requirements check request.", - "properties": { - "properties": { - "$ref": "#/definitions/AADCheckRequirementsProperties", - "description": "AAD (Azure Active Directory) requirements check properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "AzureActiveDirectory" - }, - "AADCheckRequirementsProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" - } - ], - "description": "AAD (Azure Active Directory) requirements check properties.", - "type": "object" - }, - "AATPDataConnector": { - "allOf": [ - { - "$ref": "#/definitions/DataConnector" - } - ], - "description": "Represents AATP (Azure Advanced Threat Protection) data connector.", - "properties": { - "properties": { - "$ref": "#/definitions/AATPDataConnectorProperties", - "description": "AATP (Azure Advanced Threat Protection) data connector properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "AzureAdvancedThreatProtection" - }, - "AATPDataConnectorProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" - }, - { - "$ref": "#/definitions/DataConnectorWithAlertsProperties" - } - ], - "description": "AATP (Azure Advanced Threat Protection) data connector properties.", - "type": "object" - }, - "AATPCheckRequirements": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorsCheckRequirements" - } - ], - "description": "Represents AATP (Azure Advanced Threat Protection) requirements check request.", - "properties": { - "properties": { - "$ref": "#/definitions/AATPCheckRequirementsProperties", - "description": "AATP (Azure Advanced Threat Protection) requirements check properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "AzureAdvancedThreatProtection" - }, - "AATPCheckRequirementsProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" - } - ], - "description": "AATP (Azure Advanced Threat Protection) requirements check properties.", - "type": "object" - }, - "MSTIDataConnector": { - "allOf": [ - { - "$ref": "#/definitions/DataConnector" - } - ], - "description": "Represents Microsoft Threat Intelligence data connector.", - "properties": { - "properties": { - "$ref": "#/definitions/MSTIDataConnectorProperties", - "description": "Microsoft Threat Intelligence data connector properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "MicrosoftThreatIntelligence" - }, - "MSTIDataConnectorDataTypes": { - "description": "The available data types for Microsoft Threat Intelligence Platforms data connector.", - "properties": { - "bingSafetyPhishingURL": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorDataTypeCommon" - } - ], - "properties": { - "lookbackPeriod": { - "description": "lookback period", - "type": "string" - } - }, - "description": "Data type for Microsoft Threat Intelligence Platforms data connector.", - "type": "object", - "required": [ - "lookbackPeriod" - ] - }, - "microsoftEmergingThreatFeed": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorDataTypeCommon" - } - ], - "properties": { - "lookbackPeriod": { - "description": "lookback period", - "type": "string" - } - }, - "description": "Data type for Microsoft Threat Intelligence Platforms data connector.", - "type": "object", - "required": [ - "lookbackPeriod" - ] - } - }, - "type": "object", - "required": [ - "bingSafetyPhishingURL", - "microsoftEmergingThreatFeed" - ] - }, - "MSTIDataConnectorProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" - } - ], - "description": "Microsoft Threat Intelligence data connector properties.", - "properties": { - "dataTypes": { - "$ref": "#/definitions/MSTIDataConnectorDataTypes", - "description": "The available data types for the connector." - } - }, - "required": [ - "dataTypes" - ], - "type": "object" - }, - "MSTICheckRequirements": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorsCheckRequirements" - } - ], - "description": "Represents Microsoft Threat Intelligence requirements check request.", - "properties": { - "properties": { - "$ref": "#/definitions/MSTICheckRequirementsProperties", - "description": "Microsoft Threat Intelligence requirements check properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "MicrosoftThreatIntelligence" - }, - "MSTICheckRequirementsProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" - } - ], - "description": "Microsoft Threat Intelligence requirements check properties.", - "type": "object" - }, - "MTPDataConnector": { - "allOf": [ - { - "$ref": "#/definitions/DataConnector" - } - ], - "description": "Represents MTP (Microsoft Threat Protection) data connector.", - "properties": { - "properties": { - "$ref": "#/definitions/MTPDataConnectorProperties", - "description": "MTP (Microsoft Threat Protection) data connector properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "MicrosoftThreatProtection" - }, - "MTPDataConnectorDataTypes": { - "description": "The available data types for Microsoft Threat Protection Platforms data connector.", - "properties": { - "incidents": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorDataTypeCommon" - } - ], - "description": "Data type for Microsoft Threat Protection Platforms data connector.", - "type": "object" - } - }, - "type": "object", - "required": [ - "incidents" - ] - }, - "MTPDataConnectorProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" - } - ], - "description": "MTP (Microsoft Threat Protection) data connector properties.", - "properties": { - "dataTypes": { - "$ref": "#/definitions/MTPDataConnectorDataTypes", - "description": "The available data types for the connector." - } - }, - "required": [ - "dataTypes" - ], - "type": "object" - }, - "MtpCheckRequirements": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorsCheckRequirements" - } - ], - "description": "Represents MTP (Microsoft Threat Protection) requirements check request.", - "properties": { - "properties": { - "$ref": "#/definitions/MTPCheckRequirementsProperties", - "description": "MTP (Microsoft Threat Protection) requirements check properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "MicrosoftThreatProtection" - }, - "MTPCheckRequirementsProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" - } - ], - "description": "MTP (Microsoft Threat Protection) requirements check properties.", - "type": "object" - }, - "ASCDataConnector": { - "allOf": [ - { - "$ref": "#/definitions/DataConnector" - } - ], - "description": "Represents ASC (Azure Security Center) data connector.", - "properties": { - "properties": { - "$ref": "#/definitions/ASCDataConnectorProperties", - "description": "ASC (Azure Security Center) data connector properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "AzureSecurityCenter" - }, - "ASCDataConnectorProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorWithAlertsProperties" - } - ], - "description": "ASC (Azure Security Center) data connector properties.", - "properties": { - "subscriptionId": { - "description": "The subscription id to connect to, and get the data from.", - "type": "string" - } - }, - "type": "object" - }, - "ASCCheckRequirements": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorsCheckRequirements" - } - ], - "description": "Represents ASC (Azure Security Center) requirements check request.", - "properties": { - "properties": { - "$ref": "#/definitions/ASCCheckRequirementsProperties", - "description": "ASC (Azure Security Center) requirements check properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "AzureSecurityCenter" - }, - "ASCCheckRequirementsProperties": { - "description": "ASC (Azure Security Center) requirements check properties.", - "properties": { - "subscriptionId": { - "description": "The subscription id to connect to, and get the data from.", - "type": "string" - } - }, - "type": "object" - }, - "AccountEntity": { - "allOf": [ - { - "$ref": "#/definitions/Entity" - } - ], - "description": "Represents an account entity.", - "properties": { - "properties": { - "$ref": "#/definitions/AccountEntityProperties", - "description": "Account entity properties", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "Account" - }, - "AccountEntityProperties": { - "allOf": [ - { - "$ref": "#/definitions/EntityCommonProperties" - } - ], - "description": "Account entity property bag.", - "properties": { - "aadTenantId": { - "description": "The Azure Active Directory tenant id.", - "readOnly": true, - "type": "string" - }, - "aadUserId": { - "description": "The Azure Active Directory user id.", - "readOnly": true, - "type": "string" - }, - "accountName": { - "description": "The name of the account. This field should hold only the name without any domain added to it, i.e. administrator.", - "readOnly": true, - "type": "string" - }, - "displayName": { - "description": "The display name of the account.", - "readOnly": true, - "type": "string" - }, - "hostEntityId": { - "description": "The Host entity id that contains the account in case it is a local account (not domain joined)", - "readOnly": true, - "type": "string" - }, - "isDomainJoined": { - "description": "Determines whether this is a domain account.", - "readOnly": true, - "type": "boolean" - }, - "ntDomain": { - "description": "The NetBIOS domain name as it appears in the alert format – domain\\username. Examples: NT AUTHORITY.", - "readOnly": true, - "type": "string" - }, - "objectGuid": { - "description": "The objectGUID attribute is a single-value attribute that is the unique identifier for the object, assigned by active directory.", - "format": "uuid", - "readOnly": true, - "type": "string" - }, - "puid": { - "description": "The Azure Active Directory Passport User ID.", - "readOnly": true, - "type": "string" - }, - "sid": { - "description": "The account security identifier, e.g. S-1-5-18.", - "readOnly": true, - "type": "string" - }, - "upnSuffix": { - "description": "The user principal name suffix for the account, in some cases it is also the domain name. Examples: contoso.com.", - "readOnly": true, - "type": "string" - }, - "dnsDomain": { - "description": "The fully qualified domain DNS name.", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "ActionRequest": { - "allOf": [ - { - "$ref": "#/definitions/ResourceWithEtag" - } - ], - "description": "Action for alert rule.", - "properties": { - "properties": { - "$ref": "#/definitions/ActionRequestProperties", - "description": "Action properties for put request", - "x-ms-client-flatten": true - } - }, - "type": "object" - }, - "ActionPropertiesBase": { - "description": "Action property bag base.", - "properties": { - "logicAppResourceId": { - "description": "Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}.", - "type": "string" - } - }, - "required": [ - "logicAppResourceId" - ], - "type": "object" - }, - "ActionRequestProperties": { - "allOf": [ - { - "$ref": "#/definitions/ActionPropertiesBase" - } - ], - "description": "Action property bag.", - "properties": { - "triggerUri": { - "description": "Logic App Callback URL for this specific workflow.", - "type": "string" - } - }, - "required": [ - "triggerUri" - ], - "type": "object" - }, - "ActionResponse": { - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Action for alert rule.", - "properties": { - "etag": { - "description": "Etag of the action.", - "type": "string" - }, - "properties": { - "$ref": "#/definitions/ActionResponseProperties", - "description": "Action properties for get request", - "x-ms-client-flatten": true - } - }, - "type": "object" - }, - "ActionResponseProperties": { - "allOf": [ - { - "$ref": "#/definitions/ActionPropertiesBase" - } - ], - "description": "Action property bag.", - "properties": { - "workflowId": { - "description": "The name of the logic app's workflow.", - "type": "string" - } - }, - "type": "object" - }, - "ActionsList": { - "description": "List all the actions.", - "properties": { - "nextLink": { - "description": "URL to fetch the next set of actions.", - "readOnly": true, - "type": "string" - }, - "value": { - "description": "Array of actions.", - "items": { - "$ref": "#/definitions/ActionResponse" - }, - "type": "array" - } - }, - "required": [ - "value" - ] - }, - "Aggregations": { - "allOf": [ - { - "$ref": "#/definitions/Resource" - }, - { - "$ref": "#/definitions/AggregationsKind" - } - ], - "description": "The aggregation.", - "discriminator": "kind", - "type": "object", - "required": [ - "kind" - ] - }, - "AggregationsKind": { - "description": "Describes an Azure resource with kind.", - "properties": { - "kind": { - "description": "The kind of the setting", - "enum": [ - "CasesAggregation" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "AggregationsKind" - } - } - }, - "required": [ - "kind" - ], - "type": "object" - }, - "AlertRule": { - "allOf": [ - { - "$ref": "#/definitions/ResourceWithEtag" - }, - { - "$ref": "#/definitions/AlertRuleKind" - } - ], - "description": "Alert rule.", - "discriminator": "kind", - "type": "object", - "required": [ - "kind" - ] - }, - "AlertRuleKind": { - "description": "Describes an Azure resource with kind.", - "properties": { - "kind": { - "description": "The kind of the alert rule", - "enum": [ - "Scheduled", - "MicrosoftSecurityIncidentCreation", - "Fusion", - "MLBehaviorAnalytics", - "ThreatIntelligence" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "AlertRuleKind", - "values": [ - { - "value": "Scheduled" - }, - { - "value": "MicrosoftSecurityIncidentCreation" - }, - { - "value": "Fusion" - }, - { - "value": "MLBehaviorAnalytics" - }, - { - "value": "ThreatIntelligence" - } - ] - } - } - }, - "required": [ - "kind" - ], - "type": "object" - }, - "AlertRuleTemplate": { - "allOf": [ - { - "$ref": "#/definitions/Resource" - }, - { - "$ref": "#/definitions/AlertRuleKind" - } - ], - "description": "Alert rule template.", - "discriminator": "kind", - "type": "object", - "required": [ - "kind" - ] - }, - "AlertRuleTemplateDataSource": { - "description": "alert rule template data sources", - "properties": { - "connectorId": { - "description": "The connector id that provides the following data types", - "type": "string" - }, - "dataTypes": { - "description": "The data types used by the alert rule template", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AlertRuleTemplatePropertiesBase": { - "description": "Base alert rule template property bag.", - "properties": { - "alertRulesCreatedByTemplateCount": { - "description": "the number of alert rules that were created by this template", - "type": "integer" - }, - "lastUpdatedDateUTC": { - "description": "The last time that this alert rule template has been updated.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "createdDateUTC": { - "description": "The time that this alert rule template has been added.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "The description of the alert rule template.", - "type": "string" - }, - "displayName": { - "description": "The display name for alert rule template.", - "type": "string" - }, - "requiredDataConnectors": { - "description": "The required data sources for this template", - "items": { - "$ref": "#/definitions/AlertRuleTemplateDataSource" - }, - "type": "array" - }, - "status": { - "description": "The alert rule template status.", - "enum": [ - "Installed", - "Available", - "NotAvailable" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "TemplateStatus", - "values": [ - { - "description": "Alert rule template installed. and can not use more then once", - "value": "Installed" - }, - { - "description": "Alert rule template is available.", - "value": "Available" - }, - { - "description": "Alert rule template is not available", - "value": "NotAvailable" - } - ] - } - } - }, - "type": "object" - }, - "AlertRuleTemplatesList": { - "description": "List all the alert rule templates.", - "properties": { - "nextLink": { - "description": "URL to fetch the next set of alert rule templates.", - "readOnly": true, - "type": "string" - }, - "value": { - "description": "Array of alert rule templates.", - "items": { - "$ref": "#/definitions/AlertRuleTemplate" - }, - "type": "array" - } - }, - "required": [ - "value" - ] - }, - "AlertRuleTriggerOperator": { - "description": "The operation against the threshold that triggers alert rule.", - "enum": [ - "GreaterThan", - "LessThan", - "Equal", - "NotEqual" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": false, - "name": "TriggerOperator" - } - }, - "AlertRulesList": { - "description": "List all the alert rules.", - "properties": { - "nextLink": { - "description": "URL to fetch the next set of alert rules.", - "readOnly": true, - "type": "string" - }, - "value": { - "description": "Array of alert rules.", - "items": { - "$ref": "#/definitions/AlertRule" - }, - "type": "array" - } - }, - "required": [ - "value" - ] - }, - "AlertSeverity": { - "description": "The severity of the alert", - "enum": [ - "High", - "Medium", - "Low", - "Informational" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "AlertSeverity", - "values": [ - { - "description": "High severity", - "value": "High" - }, - { - "description": "Medium severity", - "value": "Medium" - }, - { - "description": "Low severity", - "value": "Low" - }, - { - "description": "Informational severity", - "value": "Informational" - } - ] - } - }, - "AlertsDataTypeOfDataConnector": { - "description": "Alerts data type for data connectors.", - "properties": { - "alerts": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorDataTypeCommon" - } - ], - "description": "Alerts data type connection.", - "type": "object" - } - }, - "type": "object", - "required": [ - "alerts" - ] - }, - "AttackTactic": { - "description": "The severity for alerts created by this alert rule.", - "enum": [ - "InitialAccess", - "Execution", - "Persistence", - "PrivilegeEscalation", - "DefenseEvasion", - "CredentialAccess", - "Discovery", - "LateralMovement", - "Collection", - "Exfiltration", - "CommandAndControl", - "Impact", - "PreAttack" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "AttackTactic" - } - }, - "AutomationRule": { - "allOf": [ - { - "$ref": "#/definitions/ResourceWithEtag" - } - ], - "description": "Represents an automation rule.", - "properties": { - "properties": { - "$ref": "#/definitions/AutomationRuleProperties", - "description": "Automation rule properties", - "x-ms-client-flatten": true - } - }, - "type": "object" - }, - "AutomationRuleAction": { - "description": "Describes an automation rule action", - "discriminator": "actionType", - "properties": { - "order": { - "description": "The order of execution of the automation rule action", - "type": "integer", - "format": "int32" - }, - "actionType": { - "description": "The type of the automation rule action", - "enum": [ - "ModifyProperties", - "RunPlaybook" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "AutomationRuleActionType", - "values": [ - { - "description": "Modify an object's properties", - "value": "ModifyProperties" - }, - { - "description": "Run a playbook on an object", - "value": "RunPlaybook" - } - ] - } - } - }, - "required": [ - "order", - "actionType" - ], - "type": "object" - }, - "AutomationRuleCondition": { - "description": "Describes an automation rule condition", - "discriminator": "conditionType", - "properties": { - "conditionType": { - "description": "The type of the automation rule condition", - "enum": [ - "Property" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "AutomationRuleConditionType", - "values": [ - { - "description": "Evaluate an object property value", - "value": "Property" - } - ] - } - } - }, - "required": [ - "conditionType" - ], - "type": "object" - }, - "AutomationRuleRunPlaybookAction": { - "description": "Describes an automation rule action to run a playbook", - "allOf": [ - { - "$ref": "#/definitions/AutomationRuleAction" - } - ], - "properties": { - "actionConfiguration": { - "description": "The configuration of the run playbook automation rule action", - "properties": { - "logicAppResourceId": { - "description": "The resource id of the playbook resource", - "type": "string" - }, - "tenantId": { - "description": "The tenant id of the playbook resource", - "type": "string" - } - }, - "type": "object" - } - }, - "required": [ - "actionConfiguration" - ], - "x-ms-client-flatten": true, - "type": "object", - "x-ms-discriminator-value": "RunPlaybook" - }, - "AutomationRuleModifyPropertiesAction": { - "description": "Describes an automation rule action to modify an object's properties", - "allOf": [ - { - "$ref": "#/definitions/AutomationRuleAction" - } - ], - "properties": { - "actionConfiguration": { - "description": "The configuration of the modify properties automation rule action", - "properties": { - "classification": { - "$ref": "#/definitions/IncidentClassification", - "description": "The reason the incident was closed" - }, - "classificationComment": { - "description": "Describes the reason the incident was closed", - "type": "string" - }, - "classificationReason": { - "$ref": "#/definitions/IncidentClassificationReason", - "description": "The classification reason to close the incident with" - }, - "labels": { - "description": "List of labels to add to the incident", - "items": { - "$ref": "#/definitions/IncidentLabel" - }, - "type": "array" - }, - "owner": { - "$ref": "#/definitions/IncidentOwnerInfo", - "description": "Describes a user that the incident is assigned to", - "type": "object" - }, - "severity": { - "$ref": "#/definitions/IncidentSeverity", - "description": "The severity of the incident" - }, - "status": { - "$ref": "#/definitions/IncidentStatus", - "description": "The status of the incident" - } - }, - "type": "object" - } - }, - "required": [ - "actionConfiguration" - ], - "x-ms-client-flatten": true, - "type": "object", - "x-ms-discriminator-value": "ModifyProperties" - }, - "AutomationRulePropertyConditionSupportedProperty": { - "description": "The property to evaluate in an automation rule property condition", - "enum": [ - "IncidentTitle", - "IncidentDescription", - "IncidentSeverity", - "IncidentStatus", - "IncidentTactics", - "IncidentRelatedAnalyticRuleIds", - "IncidentProviderName", - "AccountAadTenantId", - "AccountAadUserId", - "AccountName", - "AccountNTDomain", - "AccountPUID", - "AccountSid", - "AccountObjectGuid", - "AccountUPNSuffix", - "AzureResourceResourceId", - "AzureResourceSubscriptionId", - "CloudApplicationAppId", - "CloudApplicationAppName", - "DNSDomainName", - "FileDirectory", - "FileName", - "FileHashValue", - "HostAzureID", - "HostName", - "HostNetBiosName", - "HostNTDomain", - "HostOSVersion", - "IoTDeviceId", - "IoTDeviceName", - "IoTDeviceType", - "IoTDeviceVendor", - "IoTDeviceModel", - "IoTDeviceOperatingSystem", - "IPAddress", - "MailboxDisplayName", - "MailboxPrimaryAddress", - "MailboxUPN", - "MailMessageDeliveryAction", - "MailMessageDeliveryLocation", - "MailMessageRecipient", - "MailMessageSenderIP", - "MailMessageSubject", - "MailMessageP1Sender", - "MailMessageP2Sender", - "MalwareCategory", - "MalwareName", - "ProcessCommandLine", - "ProcessId", - "RegistryKey", - "RegistryValueData", - "Url" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "AutomationRulePropertyConditionSupportedProperty", - "values": [ - { - "description": "The title of the incident", - "value": "IncidentTitle" - }, - { - "description": "The description of the incident", - "value": "IncidentDescription" - }, - { - "description": "The severity of the incident", - "value": "IncidentSeverity" - }, - { - "description": "The status of the incident", - "value": "IncidentStatus" - }, - { - "description": "The tactics of the incident", - "value": "IncidentTactics" - }, - { - "description": "The related Analytic rule ids of the incident", - "value": "IncidentRelatedAnalyticRuleIds" - }, - { - "description": "The provider name of the incident", - "value": "IncidentProviderName" - }, - { - "description": "The account Azure Active Directory tenant id", - "value": "AccountAadTenantId" - }, - { - "description": "The account Azure Active Directory user id.", - "value": "AccountAadUserId" - }, - { - "description": "The account name", - "value": "AccountName" - }, - { - "description": "The account NetBIOS domain name", - "value": "AccountNTDomain" - }, - { - "description": "The account Azure Active Directory Passport User ID", - "value": "AccountPUID" - }, - { - "description": "The account security identifier", - "value": "AccountSid" - }, - { - "description": "The account unique identifier", - "value": "AccountObjectGuid" - }, - { - "description": "The account user principal name suffix", - "value": "AccountUPNSuffix" - }, - { - "description": "The Azure resource id", - "value": "AzureResourceResourceId" - }, - { - "description": "The Azure resource subscription id", - "value": "AzureResourceSubscriptionId" - }, - { - "description": "The cloud application identifier", - "value": "CloudApplicationAppId" - }, - { - "description": "The cloud application name", - "value": "CloudApplicationAppName" - }, - { - "description": "The dns record domain name", - "value": "DNSDomainName" - }, - { - "description": "The file directory full path", - "value": "FileDirectory" - }, - { - "description": "The file name without path", - "value": "FileName" - }, - { - "description": "The file hash value", - "value": "FileHashValue" - }, - { - "description": "The host Azure resource id", - "value": "HostAzureID" - }, - { - "description": "The host name without domain", - "value": "HostName" - }, - { - "description": "The host NetBIOS name", - "value": "HostNetBiosName" - }, - { - "description": "The host NT domain", - "value": "HostNTDomain" - }, - { - "description": "The host operating system", - "value": "HostOSVersion" - }, - { - "description": "The IoT device id", - "value": "IoTDeviceId" - }, - { - "description": "The IoT device name", - "value": "IoTDeviceName" - }, - { - "description": "The IoT device type", - "value": "IoTDeviceType" - }, - { - "description": "The IoT device vendor", - "value": "IoTDeviceVendor" - }, - { - "description": "The IoT device model", - "value": "IoTDeviceModel" - }, - { - "description": "The IoT device operating system", - "value": "IoTDeviceOperatingSystem" - }, - { - "description": "The IP address", - "value": "IPAddress" - }, - { - "description": "The mailbox display name", - "value": "MailboxDisplayName" - }, - { - "description": "The mailbox primary address", - "value": "MailboxPrimaryAddress" - }, - { - "description": "The mailbox user principal name", - "value": "MailboxUPN" - }, - { - "description": "The mail message delivery action", - "value": "MailMessageDeliveryAction" - }, - { - "description": "The mail message delivery location", - "value": "MailMessageDeliveryLocation" - }, - { - "description": "The mail message recipient", - "value": "MailMessageRecipient" - }, - { - "description": "The mail message sender IP address", - "value": "MailMessageSenderIP" - }, - { - "description": "The mail message subject", - "value": "MailMessageSubject" - }, - { - "description": "The mail message P1 sender", - "value": "MailMessageP1Sender" - }, - { - "description": "The mail message P2 sender", - "value": "MailMessageP2Sender" - }, - { - "description": "The malware category", - "value": "MalwareCategory" - }, - { - "description": "The malware name", - "value": "MalwareName" - }, - { - "description": "The process execution command line", - "value": "ProcessCommandLine" - }, - { - "description": "The process id", - "value": "ProcessId" - }, - { - "description": "The registry key path", - "value": "RegistryKey" - }, - { - "description": "The registry key value in string formatted representation", - "value": "RegistryValueData" - }, - { - "description": "The url", - "value": "Url" - } - ] - } - }, - "AutomationRulePropertyValuesCondition": { - "description": "Describes an automation rule condition that evaluates a property's value", - "allOf": [ - { - "$ref": "#/definitions/AutomationRuleCondition" - } - ], - "properties": { - "conditionProperties": { - "description": "The configuration of the automation rule condition", - "properties": { - "propertyName": { - "$ref": "#/definitions/AutomationRulePropertyConditionSupportedProperty", - "description": "The property to evaluate" - }, - "operator": { - "description": "The operator to use for evaluation the condition", - "enum": [ - "Equals", - "NotEquals", - "Contains", - "NotContains", - "StartsWith", - "NotStartsWith", - "EndsWith", - "NotEndsWith" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "AutomationRulePropertyConditionSupportedOperator", - "values": [ - { - "description": "Evaluates if the property equals at least one of the condition values", - "value": "Equals" - }, - { - "description": "Evaluates if the property does not equal any of the condition values", - "value": "NotEquals" - }, - { - "description": "Evaluates if the property contains at least one of the condition values", - "value": "Contains" - }, - { - "description": "Evaluates if the property does not contain any of the condition values", - "value": "NotContains" - }, - { - "description": "Evaluates if the property starts with any of the condition values", - "value": "StartsWith" - }, - { - "description": "Evaluates if the property does not start with any of the condition values", - "value": "NotStartsWith" - }, - { - "description": "Evaluates if the property ends with any of the condition values", - "value": "EndsWith" - }, - { - "description": "Evaluates if the property does not end with any of the condition values", - "value": "NotEndsWith" - } - ] - } - }, - "propertyValues": { - "description": "The values to use for evaluating the condition", - "items": { - "description": "A value to use for evaluating the condition", - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - } - }, - "required": [ - "conditionProperties" - ], - "x-ms-client-flatten": true, - "type": "object", - "x-ms-discriminator-value": "Property" - }, - "AutomationRulesList": { - "description": "List all the automation rules.", - "properties": { - "nextLink": { - "description": "URL to fetch the next set of automation rules.", - "readOnly": true, - "type": "string" - }, - "value": { - "description": "Array of automation rules.", - "items": { - "$ref": "#/definitions/AutomationRule" - }, - "type": "array" - } - }, - "required": [ - "value" - ] - }, - "AutomationRuleProperties": { - "description": "Describes automation rule properties", - "properties": { - "displayName": { - "description": "The display name of the automation rule", - "type": "string" - }, - "order": { - "description": "The order of execution of the automation rule", - "type": "integer", - "format": "int32" - }, - "triggeringLogic": { - "$ref": "#/definitions/AutomationRuleTriggeringLogic", - "description": "The triggering logic of the automation rule", - "type": "object" - }, - "actions": { - "description": "The actions to execute when the automation rule is triggered", - "items": { - "$ref": "#/definitions/AutomationRuleAction" - }, - "type": "array" - }, - "createdTimeUtc": { - "description": "The time the automation rule was created", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "lastModifiedTimeUtc": { - "description": "The last time the automation rule was updated", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "createdBy": { - "$ref": "#/definitions/ClientInfo", - "description": "Describes the client that created the automation rule", - "readOnly": true, - "type": "object" - }, - "lastModifiedBy": { - "$ref": "#/definitions/ClientInfo", - "description": "Describes the client that last updated the automation rule", - "readOnly": true, - "type": "object" - } - }, - "required": [ - "displayName", - "order", - "triggeringLogic", - "actions" - ], - "type": "object" - }, - "AutomationRuleTriggeringLogic": { - "description": "Describes automation rule triggering logic", - "properties": { - "isEnabled": { - "description": "Determines whether the automation rule is enabled or disabled.", - "type": "boolean" - }, - "expirationTimeUtc": { - "description": "Determines when the automation rule should automatically expire and be disabled.", - "format": "date-time", - "type": "string" - }, - "triggersOn": { - "description": "The type of object the automation rule triggers on", - "enum": [ - "Incidents" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "TriggersOn", - "values": [ - { - "description": "Trigger on Incidents", - "value": "Incidents" - } - ] - } - }, - "triggersWhen": { - "description": "The type of event the automation rule triggers on", - "enum": [ - "Created" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "TriggersWhen", - "values": [ - { - "description": "Trigger on created objects", - "value": "Created" - } - ] - } - }, - "conditions": { - "description": "The conditions to evaluate to determine if the automation rule should be triggered on a given object", - "items": { - "$ref": "#/definitions/AutomationRuleCondition" - }, - "type": "array" - } - }, - "required": [ - "isEnabled", - "triggersOn", - "triggersWhen" - ], - "type": "object" - }, - "AwsCloudTrailDataConnector": { - "allOf": [ - { - "$ref": "#/definitions/DataConnector" - } - ], - "description": "Represents Amazon Web Services CloudTrail data connector.", - "properties": { - "properties": { - "$ref": "#/definitions/AwsCloudTrailDataConnectorProperties", - "description": "Amazon Web Services CloudTrail data connector properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "AmazonWebServicesCloudTrail" - }, - "AwsCloudTrailDataConnectorDataTypes": { - "description": "The available data types for Amazon Web Services CloudTrail data connector.", - "properties": { - "logs": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorDataTypeCommon" - } - ], - "description": "Logs data type.", - "type": "object" - } - }, - "type": "object", - "required": [ - "logs" - ] - }, - "AwsCloudTrailDataConnectorProperties": { - "description": "Amazon Web Services CloudTrail data connector properties.", - "properties": { - "awsRoleArn": { - "description": "The Aws Role Arn (with CloudTrailReadOnly policy) that is used to access the Aws account.", - "type": "string" - }, - "dataTypes": { - "$ref": "#/definitions/AwsCloudTrailDataConnectorDataTypes", - "description": "The available data types for the connector." - } - }, - "required": [ - "dataTypes" - ], - "type": "object" - }, - "AwsCloudTrailCheckRequirements": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorsCheckRequirements" - } - ], - "description": "Amazon Web Services CloudTrail requirements check request.", - "type": "object", - "x-ms-discriminator-value": "AmazonWebServicesCloudTrail" - }, - "AzureResourceEntity": { - "allOf": [ - { - "$ref": "#/definitions/Entity" - } - ], - "description": "Represents an azure resource entity.", - "properties": { - "properties": { - "$ref": "#/definitions/AzureResourceEntityProperties", - "description": "AzureResource entity properties", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "AzureResource" - }, - "AzureResourceEntityProperties": { - "allOf": [ - { - "$ref": "#/definitions/EntityCommonProperties" - } - ], - "description": "AzureResource entity property bag.", - "properties": { - "resourceId": { - "description": "The azure resource id of the resource", - "readOnly": true, - "type": "string" - }, - "subscriptionId": { - "description": "The subscription id of the resource", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "RelationBase": { - "type": "object", - "description": "Represents a relation", - "allOf": [ - { - "$ref": "#/definitions/Resource" - }, - { - "type": "object", - "properties": { - "kind": { - "type": "string", - "description": "The type of relation node", - "readOnly": true, - "enum": [ - "CasesToBookmarks" - ], - "x-ms-enum": { - "name": "RelationTypes", - "modelAsString": true, - "values": [ - { - "value": "CasesToBookmarks", - "description": "Relations between cases and bookmarks" - } - ] - } - }, - "etag": { - "type": "string", - "description": "ETag for relation" - } - } - } - ] - }, - "CaseRelationList": { - "description": "List of case relations.", - "properties": { - "nextLink": { - "readOnly": true, - "description": "URL to fetch the next set of relations.", - "type": "string" - }, - "value": { - "description": "Array of relations.", - "type": "array", - "items": { - "$ref": "#/definitions/CaseRelation" - } - } - }, - "required": [ - "value" - ] - }, - "CaseRelation": { - "type": "object", - "description": "Represents a case relation", - "allOf": [ - { - "$ref": "#/definitions/RelationBase" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Case relation properties", - "$ref": "#/definitions/CaseRelationProperties" - } - } - }, - "CaseRelationProperties": { - "type": "object", - "description": "Case relation properties", - "properties": { - "relationName": { - "type": "string", - "description": "Name of relation" - }, - "bookmarkId": { - "type": "string", - "description": "The case related bookmark id" - }, - "caseIdentifier": { - "type": "string", - "description": "The case identifier" - }, - "bookmarkName": { - "type": "string", - "description": "The case related bookmark name" - } - }, - "required": [ - "relationName", - "caseIdentifier", - "bookmarkId" - ] - }, - "RelationsModelInput": { - "type": "object", - "description": "Relation input model", - "allOf": [ - { - "$ref": "#/definitions/RelationBase" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Relation input properties", - "$ref": "#/definitions/RelationsModelInputProperties" - } - } - }, - "RelationsModelInputProperties": { - "type": "object", - "description": "Relation input properties", - "properties": { - "relationName": { - "type": "string", - "description": "Name of relation" - }, - "sourceRelationNode": { - "type": "object", - "description": "Relation source node", - "$ref": "#/definitions/RelationNode" - }, - "targetRelationNode": { - "type": "object", - "description": "Relation target node", - "$ref": "#/definitions/RelationNode" - } - } - }, - "RelationNode": { - "type": "object", - "description": "Relation node", - "properties": { - "relationNodeId": { - "type": "string", - "description": "Relation Node Id" - }, - "relationNodeKind": { - "type": "string", - "description": "The type of relation node", - "readOnly": true, - "enum": [ - "Case", - "Bookmark" - ], - "x-ms-enum": { - "name": "RelationNodeKind", - "modelAsString": true, - "values": [ - { - "value": "Case", - "description": "Case node part of the relation" - }, - { - "value": "Bookmark", - "description": "Bookmark node part of the relation" - } - ] - } - }, - "etag": { - "type": "string", - "description": "Etag for relation node" - }, - "relationAdditionalProperties": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Additional set of properties" - } - } - }, - "Bookmark": { - "allOf": [ - { - "$ref": "#/definitions/ResourceWithEtag" - } - ], - "description": "Represents a bookmark in Azure Security Insights.", - "properties": { - "properties": { - "$ref": "#/definitions/BookmarkProperties", - "description": "Bookmark properties", - "x-ms-client-flatten": true - } - }, - "type": "object" - }, - "BookmarkList": { - "description": "List all the bookmarks.", - "properties": { - "nextLink": { - "description": "URL to fetch the next set of cases.", - "readOnly": true, - "type": "string" - }, - "value": { - "description": "Array of bookmarks.", - "items": { - "$ref": "#/definitions/Bookmark" - }, - "type": "array" - } - }, - "required": [ - "value" - ] - }, - "BookmarkProperties": { - "description": "Describes bookmark properties", - "properties": { - "created": { - "description": "The time the bookmark was created", - "format": "date-time", - "type": "string" - }, - "createdBy": { - "$ref": "#/definitions/UserInfo", - "description": "Describes a user that created the bookmark", - "type": "object" - }, - "displayName": { - "description": "The display name of the bookmark", - "type": "string" - }, - "labels": { - "description": "List of labels relevant to this bookmark", - "items": { - "$ref": "#/definitions/Label" - }, - "type": "array" - }, - "notes": { - "description": "The notes of the bookmark", - "type": "string" - }, - "query": { - "description": "The query of the bookmark.", - "type": "string" - }, - "queryResult": { - "description": "The query result of the bookmark.", - "type": "string" - }, - "updated": { - "description": "The last time the bookmark was updated", - "format": "date-time", - "type": "string" - }, - "updatedBy": { - "$ref": "#/definitions/UserInfo", - "description": "Describes a user that updated the bookmark", - "type": "object" - }, - "eventTime": { - "description": "The bookmark event time", - "format": "date-time", - "type": "string" - }, - "queryStartTime": { - "description": "The start time for the query", - "format": "date-time", - "type": "string" - }, - "queryEndTime": { - "description": "The end time for the query", - "format": "date-time", - "type": "string" - }, - "incidentInfo": { - "$ref": "#/definitions/IncidentInfo", - "description": "Describes an incident that relates to bookmark", - "type": "object" - } - }, - "required": [ - "displayName", - "query" - ], - "type": "object" - }, - "BookmarkExpandParameters": { - "description": "The parameters required to execute an expand operation on the given bookmark.", - "properties": { - "endTime": { - "description": "The end date filter, so the only expansion results returned are before this date.", - "format": "date-time", - "type": "string" - }, - "expansionId": { - "description": "The Id of the expansion to perform.", - "format": "uuid", - "type": "string" - }, - "startTime": { - "description": "The start date filter, so the only expansion results returned are after this date.", - "format": "date-time", - "type": "string" - } - } - }, - "BookmarkExpandResponse": { - "description": "The entity expansion result operation response.", - "properties": { - "metaData": { - "$ref": "#/definitions/ExpansionResultsMetadata", - "description": "The metadata from the expansion operation results." - }, - "value": { - "description": "The expansion result values.", - "properties": { - "entities": { - "description": "Array of the expansion result entities.", - "items": { - "$ref": "#/definitions/Entity" - }, - "type": "array" - }, - "edges": { - "description": "Array of expansion result connected entities", - "items": { - "$ref": "#/definitions/ConnectedEntity" - }, - "type": "array" - } - }, - "type": "object" - } - } - }, - "Case": { - "allOf": [ - { - "$ref": "#/definitions/ResourceWithEtag" - } - ], - "description": "Represents a case in Azure Security Insights.", - "properties": { - "properties": { - "$ref": "#/definitions/CaseProperties", - "description": "Case properties", - "x-ms-client-flatten": true - } - }, - "type": "object" - }, - "CaseComment": { - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Represents a case comment", - "properties": { - "properties": { - "$ref": "#/definitions/CaseCommentProperties", - "description": "Case comment properties", - "x-ms-client-flatten": true - } - }, - "type": "object" - }, - "CaseCommentList": { - "description": "List of case comments.", - "properties": { - "nextLink": { - "description": "URL to fetch the next set of comments.", - "readOnly": true, - "type": "string" - }, - "value": { - "description": "Array of comments.", - "items": { - "$ref": "#/definitions/CaseComment" - }, - "type": "array" - } - }, - "required": [ - "value" - ] - }, - "CaseCommentProperties": { - "description": "Case comment property bag.", - "properties": { - "createdTimeUtc": { - "description": "The time the comment was created", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "message": { - "description": "The comment message", - "type": "string" - }, - "userInfo": { - "$ref": "#/definitions/UserInfo", - "description": "Describes the user that created the comment", - "readOnly": true, - "type": "object" - } - }, - "required": [ - "message" - ], - "type": "object" - }, - "CaseList": { - "description": "List all the cases.", - "properties": { - "nextLink": { - "description": "URL to fetch the next set of cases.", - "readOnly": true, - "type": "string" - }, - "value": { - "description": "Array of cases.", - "items": { - "$ref": "#/definitions/Case" - }, - "type": "array" - } - }, - "required": [ - "value" - ] - }, - "CaseProperties": { - "description": "Describes case properties", - "properties": { - "caseNumber": { - "description": "a sequential number", - "readOnly": true, - "type": "integer" - }, - "closeReason": { - "description": "The reason the case was closed", - "enum": [ - "Resolved", - "Dismissed", - "TruePositive", - "FalsePositive", - "Other" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "CloseReason", - "values": [ - { - "description": "Case was resolved", - "value": "Resolved" - }, - { - "description": "Case was dismissed", - "value": "Dismissed" - }, - { - "description": "Case was true positive", - "value": "TruePositive" - }, - { - "description": "Case was false positive", - "value": "FalsePositive" - }, - { - "description": "Case was closed for another reason", - "value": "Other" - } - ] - } - }, - "closedReasonText": { - "description": "the case close reason details", - "type": "string" - }, - "createdTimeUtc": { - "description": "The time the case was created", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "The description of the case", - "type": "string" - }, - "endTimeUtc": { - "description": "The end time of the case", - "format": "date-time", - "type": "string" - }, - "labels": { - "description": "List of labels relevant to this case", - "items": { - "$ref": "#/definitions/Label" - }, - "type": "array" - }, - "lastComment": { - "description": "the last comment in the case", - "readOnly": true, - "type": "string" - }, - "lastUpdatedTimeUtc": { - "description": "The last time the case was updated", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "metrics": { - "description": "Dictionary of metrics, for example the number of alerts in the case", - "type": "object", - "additionalProperties": { - "type": "integer", - "format": "int32" - }, - "readOnly": true - }, - "owner": { - "$ref": "#/definitions/UserInfo", - "description": "Describes a user that the case is assigned to", - "type": "object" - }, - "relatedAlertIds": { - "description": "List of related alert identifiers", - "items": { - "description": "related alert id", - "type": "string" - }, - "readOnly": true, - "type": "array" - }, - "relatedAlertProductNames": { - "description": "List of related alert product names", - "items": { - "description": "related alert product name", - "type": "string" - }, - "readOnly": true, - "type": "array" - }, - "tactics": { - "description": "The tactics associated with case", - "items": { - "$ref": "#/definitions/AttackTactic" - }, - "readOnly": true, - "type": "array" - }, - "severity": { - "description": "The severity of the case", - "enum": [ - "Critical", - "High", - "Medium", - "Low", - "Informational" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "CaseSeverity", - "values": [ - { - "description": "Critical severity", - "value": "Critical" - }, - { - "description": "High severity", - "value": "High" - }, - { - "description": "Medium severity", - "value": "Medium" - }, - { - "description": "Low severity", - "value": "Low" - }, - { - "description": "Informational severity", - "value": "Informational" - } - ] - } - }, - "startTimeUtc": { - "description": "The start time of the case", - "format": "date-time", - "type": "string" - }, - "status": { - "description": "The status of the case", - "enum": [ - "Draft", - "New", - "InProgress", - "Closed" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "CaseStatus", - "values": [ - { - "description": "Case that wasn't promoted yet to active", - "value": "Draft" - }, - { - "description": "An active case which isn't handled currently", - "value": "New" - }, - { - "description": "An active case which is handled", - "value": "InProgress" - }, - { - "description": "A non active case", - "value": "Closed" - } - ] - } - }, - "title": { - "description": "The title of the case", - "type": "string" - }, - "totalComments": { - "description": "the number of total comments in the case", - "readOnly": true, - "type": "integer" - } - }, - "required": [ - "title", - "severity", - "status" - ], - "type": "object" - }, - "CasesAggregation": { - "allOf": [ - { - "$ref": "#/definitions/Aggregations" - } - ], - "description": "Represents aggregations results for cases.", - "properties": { - "properties": { - "$ref": "#/definitions/CasesAggregationProperties", - "description": "Properties of aggregations results of cases.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "CasesAggregation" - }, - "CasesAggregationBySeverityProperties": { - "description": "Aggregative results of cases by severity property bag.", - "properties": { - "totalCriticalSeverity": { - "description": "Total amount of open cases with severity Critical", - "readOnly": true, - "type": "integer" - }, - "totalHighSeverity": { - "description": "Total amount of open cases with severity High", - "readOnly": true, - "type": "integer" - }, - "totalInformationalSeverity": { - "description": "Total amount of open cases with severity Informational", - "readOnly": true, - "type": "integer" - }, - "totalLowSeverity": { - "description": "Total amount of open cases with severity Low", - "readOnly": true, - "type": "integer" - }, - "totalMediumSeverity": { - "description": "Total amount of open cases with severity medium", - "readOnly": true, - "type": "integer" - } - }, - "type": "object" - }, - "CasesAggregationByStatusProperties": { - "description": "Aggregative results of cases by status property bag.", - "properties": { - "totalDismissedStatus": { - "description": "Total amount of closed cases with status Dismissed", - "readOnly": true, - "type": "integer" - }, - "totalInProgressStatus": { - "description": "Total amount of open cases with status InProgress", - "readOnly": true, - "type": "integer" - }, - "totalNewStatus": { - "description": "Total amount of open cases with status New", - "readOnly": true, - "type": "integer" - }, - "totalResolvedStatus": { - "description": "Total amount of closed cases with status Resolved", - "readOnly": true, - "type": "integer" - }, - "totalFalsePositiveStatus": { - "description": "Total amount of closed cases with status Closed and Close reason of False positive", - "readOnly": true, - "type": "integer", - "format": "int32" - }, - "totalTruePositiveStatus": { - "description": "Total amount of closed cases with status Closed and Close reason of True positive", - "readOnly": true, - "type": "integer", - "format": "int32" - } - }, - "type": "object" - }, - "CasesAggregationProperties": { - "description": "Aggregative results of cases property bag.", - "properties": { - "aggregationBySeverity": { - "$ref": "#/definitions/CasesAggregationBySeverityProperties", - "description": "Aggregations results by case severity." - }, - "aggregationByStatus": { - "$ref": "#/definitions/CasesAggregationByStatusProperties", - "description": "Aggregations results by case status." - } - }, - "type": "object" - }, - "ClientInfo": { - "description": "Information on the client (user or application) that made some action", - "properties": { - "email": { - "description": "The email of the client.", - "type": "string" - }, - "name": { - "description": "The name of the client.", - "type": "string" - }, - "objectId": { - "description": "The object id of the client.", - "format": "uuid", - "type": "string" - }, - "userPrincipalName": { - "description": "The user principal name of the client.", - "type": "string" - } - }, - "type": "object" - }, - "CloudApplicationEntity": { - "allOf": [ - { - "$ref": "#/definitions/Entity" - } - ], - "description": "Represents a cloud application entity.", - "properties": { - "properties": { - "$ref": "#/definitions/CloudApplicationEntityProperties", - "description": "CloudApplication entity properties", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "CloudApplication" - }, - "CloudApplicationEntityProperties": { - "allOf": [ - { - "$ref": "#/definitions/EntityCommonProperties" - } - ], - "description": "CloudApplication entity property bag.", - "properties": { - "appId": { - "description": "The technical identifier of the application.", - "readOnly": true, - "type": "integer" - }, - "appName": { - "description": "The name of the related cloud application.", - "readOnly": true, - "type": "string" - }, - "instanceName": { - "description": "The user defined instance name of the cloud application. It is often used to distinguish between several applications of the same type that a customer has.", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "CloudError": { - "description": "Error response structure.", - "properties": { - "error": { - "$ref": "#/definitions/CloudErrorBody", - "description": "Error data", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-external": true - }, - "CloudErrorBody": { - "description": "Error details.", - "properties": { - "code": { - "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically.", - "readOnly": true, - "type": "string" - }, - "message": { - "description": "A message describing the error, intended to be suitable for display in a user interface.", - "readOnly": true, - "type": "string" - } - }, - "type": "object", - "x-ms-external": true - }, - "DataConnector": { - "allOf": [ - { - "$ref": "#/definitions/ResourceWithEtag" - }, - { - "$ref": "#/definitions/DataConnectorKind" - } - ], - "description": "Data connector.", - "discriminator": "kind", - "type": "object", - "required": [ - "kind" - ] - }, - "DataConnectorsCheckRequirements": { - "description": "Data connector requirements properties.", - "properties": { - "kind": { - "$ref": "#/definitions/DataConnectorKind", - "description": "Describes the kind of connector to be checked." - } - }, - "discriminator": "kind", - "type": "object", - "required": [ - "kind" - ] - }, - "DataConnectorAuthorizationState": { - "description": "Describes the state of user's authorization for a connector kind.", - "enum": [ - "Valid", - "Invalid" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "DataConnectorAuthorizationState", - "values": [ - { - "value": "Valid" - }, - { - "value": "Invalid" - } - ] - } - }, - "DataConnectorLicenseState": { - "description": "Describes the state of user's license for a connector kind.", - "enum": [ - "Valid", - "Invalid", - "Unknown" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "DataConnectorLicenseState", - "values": [ - { - "value": "Valid" - }, - { - "value": "Invalid" - }, - { - "value": "Unknown" - } - ] - } - }, - "DataConnectorDataTypeCommon": { - "description": "Common field for data type in data connectors.", - "properties": { - "state": { - "description": "Describe whether this data type connection is enabled or not.", - "enum": [ - "Enabled", - "Disabled" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "DataTypeState" - } - } - }, - "type": "object", - "required": [ - "state" - ] - }, - "DataConnectorKind": { - "description": "Describes an Azure resource with kind.", - "properties": { - "kind": { - "description": "The kind of the data connector", - "enum": [ - "AzureActiveDirectory", - "AzureSecurityCenter", - "MicrosoftCloudAppSecurity", - "ThreatIntelligence", - "ThreatIntelligenceTaxii", - "Office365", - "OfficeATP", - "AmazonWebServicesCloudTrail", - "AzureAdvancedThreatProtection", - "MicrosoftDefenderAdvancedThreatProtection", - "Dynamics365", - "MicrosoftThreatProtection", - "MicrosoftThreatIntelligence" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "DataConnectorKind", - "values": [ - { - "value": "AzureActiveDirectory" - }, - { - "value": "AzureSecurityCenter" - }, - { - "value": "MicrosoftCloudAppSecurity" - }, - { - "value": "ThreatIntelligence" - }, - { - "value": "ThreatIntelligenceTaxii" - }, - { - "value": "Office365" - }, - { - "value": "OfficeATP" - }, - { - "value": "AmazonWebServicesCloudTrail" - }, - { - "value": "AzureAdvancedThreatProtection" - }, - { - "value": "MicrosoftDefenderAdvancedThreatProtection" - }, - { - "value": "Dynamics365" - }, - { - "value": "MicrosoftThreatProtection" - }, - { - "value": "MicrosoftThreatIntelligence" - } - ] - } - } - }, - "required": [ - "kind" - ], - "type": "object" - }, - "DataConnectorList": { - "description": "List all the data connectors.", - "properties": { - "nextLink": { - "description": "URL to fetch the next set of data connectors.", - "readOnly": true, - "type": "string" - }, - "value": { - "description": "Array of data connectors.", - "items": { - "$ref": "#/definitions/DataConnector" - }, - "type": "array" - } - }, - "required": [ - "value" - ] - }, - "DataConnectorRequirementsState": { - "description": "Data connector requirements status.", - "properties": { - "authorizationState": { - "description": "Authorization state for this connector", - "$ref": "#/definitions/DataConnectorAuthorizationState" - }, - "licenseState": { - "description": "License state for this connector", - "$ref": "#/definitions/DataConnectorLicenseState" - } - }, - "type": "object" - }, - "DataConnectorTenantId": { - "description": "Properties data connector on tenant level.", - "properties": { - "tenantId": { - "description": "The tenant id to connect to, and get the data from.", - "type": "string" - } - }, - "required": [ - "tenantId" - ], - "type": "object" - }, - "DataConnectorWithAlertsProperties": { - "description": "Data connector properties.", - "properties": { - "dataTypes": { - "$ref": "#/definitions/AlertsDataTypeOfDataConnector", - "description": "The available data types for the connector." - } - }, - "type": "object" - }, - "DnsEntity": { - "allOf": [ - { - "$ref": "#/definitions/Entity" - } - ], - "description": "Represents a dns entity.", - "properties": { - "properties": { - "$ref": "#/definitions/DnsEntityProperties", - "description": "Dns entity properties", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "DnsResolution" - }, - "DnsEntityProperties": { - "allOf": [ - { - "$ref": "#/definitions/EntityCommonProperties" - } - ], - "description": "Dns entity property bag.", - "properties": { - "dnsServerIpEntityId": { - "description": "An ip entity id for the dns server resolving the request", - "readOnly": true, - "type": "string" - }, - "domainName": { - "description": "The name of the dns record associated with the alert", - "readOnly": true, - "type": "string" - }, - "hostIpAddressEntityId": { - "description": "An ip entity id for the dns request client", - "readOnly": true, - "type": "string" - }, - "ipAddressEntityIds": { - "description": "Ip entity identifiers for the resolved ip address.", - "items": { - "description": "Ip entity id", - "type": "string" - }, - "readOnly": true, - "type": "array" - } - }, - "type": "object" - }, - "Dynamics365DataConnector": { - "allOf": [ - { - "$ref": "#/definitions/DataConnector" - } - ], - "description": "Represents Dynamics365 data connector.", - "properties": { - "properties": { - "$ref": "#/definitions/Dynamics365DataConnectorProperties", - "description": "Dynamics365 data connector properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "Dynamics365" - }, - "Dynamics365DataConnectorDataTypes": { - "description": "The available data types for Dynamics365 data connector.", - "properties": { - "dynamics365CdsActivities": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorDataTypeCommon" - } - ], - "description": "Common Data Service data type connection.", - "type": "object" - } - }, - "type": "object", - "required": [ - "dynamics365CdsActivities" - ] - }, - "Dynamics365DataConnectorProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" - } - ], - "description": "Dynamics365 data connector properties.", - "properties": { - "dataTypes": { - "$ref": "#/definitions/Dynamics365DataConnectorDataTypes", - "description": "The available data types for the connector." - } - }, - "required": [ - "dataTypes" - ], - "type": "object" - }, - "Dynamics365CheckRequirements": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorsCheckRequirements" - } - ], - "description": "Represents Dynamics365 requirements check request.", - "properties": { - "properties": { - "$ref": "#/definitions/Dynamics365CheckRequirementsProperties", - "description": "Dynamics365 requirements check properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "Dynamics365" - }, - "Dynamics365CheckRequirementsProperties": { + "MSTIDataConnectorProperties": { "allOf": [ { "$ref": "#/definitions/DataConnectorTenantId" } ], - "description": "Dynamics365 requirements check properties.", - "type": "object" - }, - "EnrichmentDomainWhois": { - "description": "Whois information for a given domain and associated metadata", - "properties": { - "domain": { - "description": "The domain for this whois record", - "type": "string" - }, - "server": { - "description": "The hostname of this registrar's whois server", - "type": "string" - }, - "created": { - "description": "The timestamp at which this record was created", - "format": "date-time", - "type": "string" - }, - "updated": { - "description": "The timestamp at which this record was last updated", - "format": "date-time", - "type": "string" - }, - "expires": { - "description": "The timestamp at which this record will expire", - "format": "date-time", - "type": "string" - }, - "parsedWhois": { - "description": "The whois record for a given domain", - "$ref": "#/definitions/EnrichmentDomainWhoisDetails" - } - } - }, - "EnrichmentDomainWhoisDetails": { - "description": "The whois record for a given domain", - "properties": { - "registrar": { - "description": "The registrar associated with this domain", - "$ref": "#/definitions/EnrichmentDomainWhoisRegistrarDetails" - }, - "contacts": { - "description": "The set of contacts associated with this domain", - "$ref": "#/definitions/EnrichmentDomainWhoisContacts" - }, - "nameServers": { - "description": "A list of name servers associated with this domain", - "type": "array", - "items": { - "type": "string" - } - }, - "statuses": { - "description": "The set of status flags for this whois record", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "EnrichmentDomainWhoisRegistrarDetails": { - "description": "The registrar associated with this domain", - "properties": { - "name": { - "description": "The name of this registrar", - "type": "string" - }, - "abuseContactEmail": { - "description": "This registrar's abuse contact email", - "type": "string" - }, - "abuseContactPhone": { - "description": "This registrar's abuse contact phone number", - "type": "string" - }, - "ianaId": { - "description": "This registrar's Internet Assigned Numbers Authority id", - "type": "string" - }, - "url": { - "description": "This registrar's URL", - "type": "string" - }, - "whoisServer": { - "description": "The hostname of this registrar's whois server", - "type": "string" - } - } - }, - "EnrichmentDomainWhoisContacts": { - "description": "The set of contacts associated with this domain", - "properties": { - "admin": { - "description": "The admin contact for this whois record", - "$ref": "#/definitions/EnrichmentDomainWhoisContact" - }, - "billing": { - "description": "The billing contact for this whois record", - "$ref": "#/definitions/EnrichmentDomainWhoisContact" - }, - "registrant": { - "description": "The registrant contact for this whois record", - "$ref": "#/definitions/EnrichmentDomainWhoisContact" - }, - "tech": { - "description": "The technical contact for this whois record", - "$ref": "#/definitions/EnrichmentDomainWhoisContact" - } - } - }, - "EnrichmentDomainWhoisContact": { - "description": "An individual contact associated with this domain", - "properties": { - "name": { - "description": "The name of this contact", - "type": "string" - }, - "org": { - "description": "The organization for this contact", - "type": "string" - }, - "street": { - "description": "A list describing the street address for this contact", - "type": "array", - "items": { - "type": "string" - } - }, - "city": { - "description": "The city for this contact", - "type": "string" - }, - "state": { - "description": "The state for this contact", - "type": "string" - }, - "postal": { - "description": "The postal code for this contact", - "type": "string" - }, - "country": { - "description": "The country for this contact", - "type": "string" - }, - "phone": { - "description": "The phone number for this contact", - "type": "string" - }, - "fax": { - "description": "The fax number for this contact", - "type": "string" - }, - "email": { - "description": "The email address for this contact", - "type": "string" - } - } - }, - "EnrichmentIpGeodata": { - "description": "Geodata information for a given IP address", - "properties": { - "asn": { - "description": "The autonomous system number associated with this IP address", - "type": "string" - }, - "carrier": { - "description": "The name of the carrier for this IP address", - "type": "string" - }, - "city": { - "description": "The city this IP address is located in", - "type": "string" - }, - "cityCf": { - "description": "A numeric rating of confidence that the value in the 'city' field is correct, on a scale of 0-100", - "type": "integer", - "format": "int32" - }, - "continent": { - "description": "The continent this IP address is located on", - "type": "string" - }, - "country": { - "description": "The county this IP address is located in", - "type": "string" - }, - "countryCf": { - "description": "A numeric rating of confidence that the value in the 'country' field is correct on a scale of 0-100", - "type": "integer", - "format": "int32" - }, - "ipAddr": { - "description": "The dotted-decimal or colon-separated string representation of the IP address", - "type": "string" - }, - "ipRoutingType": { - "description": "A description of the connection type of this IP address", - "type": "string" - }, - "latitude": { - "description": "The latitude of this IP address", - "type": "string" - }, - "longitude": { - "description": "The longitude of this IP address", - "type": "string" - }, - "organization": { - "description": "The name of the organization for this IP address", - "type": "string" - }, - "organizationType": { - "description": "The type of the organization for this IP address", - "type": "string" - }, - "region": { - "description": "The geographic region this IP address is located in", - "type": "string" - }, - "state": { - "description": "The state this IP address is located in", - "type": "string" - }, - "stateCf": { - "description": "A numeric rating of confidence that the value in the 'state' field is correct on a scale of 0-100", - "type": "integer", - "format": "int32" - }, - "stateCode": { - "description": "The abbreviated name for the state this IP address is located in", - "type": "string" - } - } - }, - "Entity": { - "allOf": [ - { - "$ref": "#/definitions/Resource" - }, - { - "$ref": "#/definitions/EntityKind" - } - ], - "description": "Specific entity.", - "discriminator": "kind", - "type": "object", - "required": [ - "kind" - ] - }, - "EntityEdges": { - "description": "The edge that connects the entity to the other entity.", - "properties": { - "targetEntityId": { - "description": "The target entity Id.", - "type": "string" - }, - "additionalData": { - "additionalProperties": { - "type": "object" - }, - "description": "A bag of custom fields that should be part of the entity and will be presented to the user.", - "type": "object" - } - }, - "type": "object" - }, - "EntityCommonProperties": { - "description": "Entity common property bag.", - "properties": { - "additionalData": { - "additionalProperties": { - "type": "object" - }, - "description": "A bag of custom fields that should be part of the entity and will be presented to the user.", - "readOnly": true, - "type": "object" - }, - "friendlyName": { - "description": "The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated.", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "EntityExpandParameters": { - "description": "The parameters required to execute an expand operation on the given entity.", - "properties": { - "endTime": { - "description": "The end date filter, so the only expansion results returned are before this date.", - "format": "date-time", - "type": "string" - }, - "expansionId": { - "description": "The Id of the expansion to perform.", - "format": "uuid", - "type": "string" - }, - "startTime": { - "description": "The start date filter, so the only expansion results returned are after this date.", - "format": "date-time", - "type": "string" - } - } - }, - "EntityTimelineParameters": { - "description": "The parameters required to execute s timeline operation on the given entity.", - "properties": { - "kinds": { - "description": "Array of timeline Item kinds.", - "items": { - "$ref": "#/definitions/EntityTimelineKind" - }, - "type": "array" - }, - "startTime": { - "description": "The start timeline date, so the results returned are after this date.", - "format": "date-time", - "type": "string" - }, - "endTime": { - "description": "The end timeline date, so the results returned are before this date.", - "format": "date-time", - "type": "string" - }, - "numberOfBucket": { - "description": "The number of bucket for timeline queries aggregation.", - "type": "integer", - "format": "int32" - } - }, - "required": [ - "startTime", - "endTime" - ] - }, - "EntityExpandResponse": { - "description": "The entity expansion result operation response.", - "properties": { - "metaData": { - "$ref": "#/definitions/ExpansionResultsMetadata", - "description": "The metadata from the expansion operation results." - }, - "value": { - "description": "The expansion result values.", - "properties": { - "entities": { - "description": "Array of the expansion result entities.", - "items": { - "$ref": "#/definitions/Entity" - }, - "type": "array" - }, - "edges": { - "description": "Array of edges that connects the entity to the list of entities.", - "items": { - "$ref": "#/definitions/EntityEdges" - }, - "type": "array" - } - }, - "type": "object" - } - } - }, - "EntityTimelineResponse": { - "description": "The entity timeline result operation response.", - "properties": { - "metaData": { - "$ref": "#/definitions/TimelineResultsMetadata", - "description": "The metadata from the timeline operation results." - }, - "value": { - "description": "The timeline result values.", - "items": { - "$ref": "#/definitions/EntityTimelineItem" - }, - "type": "array" - } - } - }, - "GetQueriesResponse": { - "description": "Retrieve queries for entity result operation response.", + "description": "Microsoft Threat Intelligence data connector properties.", "properties": { - "value": { - "description": "The query result values.", - "items": { - "$ref": "#/definitions/EntityQueryItem" - }, - "type": "array" + "dataTypes": { + "$ref": "#/definitions/MSTIDataConnectorDataTypes", + "description": "The available data types for the connector." } - } - }, - "EntityInnerKind": { - "description": "The kind of the entity", - "enum": [ - "Account", - "Host", - "File", - "AzureResource", - "CloudApplication", - "DnsResolution", - "FileHash", - "Ip", - "Malware", - "Process", - "RegistryKey", - "RegistryValue", - "SecurityGroup", - "Url", - "IoTDevice", - "SecurityAlert", - "Bookmark", - "Mailbox", - "MailCluster", - "MailMessage", - "SubmissionMail" + }, + "required": [ + "dataTypes" ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "EntityKind", - "values": [ - { - "description": "Entity represents account in the system.", - "value": "Account" - }, - { - "description": "Entity represents host in the system.", - "value": "Host" - }, - { - "description": "Entity represents file in the system.", - "value": "File" - }, - { - "description": "Entity represents azure resource in the system.", - "value": "AzureResource" - }, - { - "description": "Entity represents cloud application in the system.", - "value": "CloudApplication" - }, - { - "description": "Entity represents dns resolution in the system.", - "value": "DnsResolution" - }, - { - "description": "Entity represents file hash in the system.", - "value": "FileHash" - }, - { - "description": "Entity represents ip in the system.", - "value": "Ip" - }, - { - "description": "Entity represents malware in the system.", - "value": "Malware" - }, - { - "description": "Entity represents process in the system.", - "value": "Process" - }, - { - "description": "Entity represents registry key in the system.", - "value": "RegistryKey" - }, - { - "description": "Entity represents registry value in the system.", - "value": "RegistryValue" - }, - { - "description": "Entity represents security group in the system.", - "value": "SecurityGroup" - }, - { - "description": "Entity represents url in the system.", - "value": "Url" - }, - { - "description": "Entity represents IoT device in the system.", - "value": "IoTDevice" - }, - { - "description": "Entity represents security alert in the system.", - "value": "SecurityAlert" - }, - { - "description": "Entity represents bookmark in the system.", - "value": "Bookmark" - }, - { - "description": "Entity represents mail cluster in the system.", - "value": "MailCluster" - }, - { - "description": "Entity represents mail message in the system.", - "value": "MailMessage" - }, - { - "description": "Entity represents mailbox in the system.", - "value": "Mailbox" - }, - { - "description": "Entity represents submission mail in the system.", - "value": "SubmissionMail" - } - ] - } + "type": "object" }, - "EntityInnerType": { - "description": "The type of the entity", - "enum": [ - "Account", - "Host", - "File", - "AzureResource", - "CloudApplication", - "DNS", - "FileHash", - "IP", - "Malware", - "Process", - "RegistryKey", - "RegistryValue", - "SecurityGroup", - "URL", - "IoTDevice", - "SecurityAlert", - "HuntingBookmark", - "MailCluster", - "MailMessage", - "Mailbox", - "SubmissionMail" + "MTPDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "EntityType", - "values": [ - { - "description": "Entity represents account in the system.", - "value": "Account" - }, - { - "description": "Entity represents host in the system.", - "value": "Host" - }, - { - "description": "Entity represents file in the system.", - "value": "File" - }, - { - "description": "Entity represents azure resource in the system.", - "value": "AzureResource" - }, - { - "description": "Entity represents cloud application in the system.", - "value": "CloudApplication" - }, - { - "description": "Entity represents dns in the system.", - "value": "DNS" - }, - { - "description": "Entity represents file hash in the system.", - "value": "FileHash" - }, - { - "description": "Entity represents ip in the system.", - "value": "IP" - }, - { - "description": "Entity represents malware in the system.", - "value": "Malware" - }, - { - "description": "Entity represents process in the system.", - "value": "Process" - }, - { - "description": "Entity represents registry key in the system.", - "value": "RegistryKey" - }, - { - "description": "Entity represents registry value in the system.", - "value": "RegistryValue" - }, - { - "description": "Entity represents security group in the system.", - "value": "SecurityGroup" - }, - { - "description": "Entity represents url in the system.", - "value": "URL" - }, - { - "description": "Entity represents IoT device in the system.", - "value": "IoTDevice" - }, - { - "description": "Entity represents security alert in the system.", - "value": "SecurityAlert" - }, - { - "description": "Entity represents HuntingBookmark in the system.", - "value": "HuntingBookmark" - }, - { - "description": "Entity represents mail cluster in the system.", - "value": "MailCluster" - }, - { - "description": "Entity represents mail message in the system.", - "value": "MailMessage" - }, - { - "description": "Entity represents mailbox in the system.", - "value": "Mailbox" - }, - { - "description": "Entity represents submission mail in the system.", - "value": "SubmissionMail" - } - ] - } - }, - "EntityKind": { - "description": "Describes an entity with kind.", - "properties": { - "kind": { - "$ref": "#/definitions/EntityInnerKind", - "description": "The kind of the entity." + "description": "Represents MTP (Microsoft Threat Protection) data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/MTPDataConnectorProperties", + "description": "MTP (Microsoft Threat Protection) data connector properties.", + "x-ms-client-flatten": true } }, - "required": [ - "kind" - ], - "type": "object" + "type": "object", + "x-ms-discriminator-value": "MicrosoftThreatProtection" }, - "EntityList": { - "description": "List of all the entities.", + "MTPDataConnectorDataTypes": { + "description": "The available data types for Microsoft Threat Protection Platforms data connector.", "properties": { - "nextLink": { - "description": "URL to fetch the next set of entities.", - "readOnly": true, - "type": "string" - }, - "value": { - "description": "Array of entities.", - "items": { - "$ref": "#/definitions/Entity" - }, - "type": "array" + "incidents": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Data type for Microsoft Threat Protection Platforms data connector.", + "type": "object" } }, + "type": "object", "required": [ - "value" + "incidents" ] }, - "EntityQueryKind": { - "description": "Describes an Entity query resource with kind.", + "MTPDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "MTP (Microsoft Threat Protection) data connector properties.", "properties": { - "kind": { - "description": "The kind of the entity query", - "enum": [ - "Expansion", - "Insight" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "EntityQueryKind", - "values": [ - { - "value": "Expansion" - }, - { - "value": "Insight" - } - ] - } + "dataTypes": { + "$ref": "#/definitions/MTPDataConnectorDataTypes", + "description": "The available data types for the connector." } }, "required": [ - "kind" + "dataTypes" ], "type": "object" }, - "EntityQuery": { + "ASCDataConnector": { "allOf": [ { - "$ref": "#/definitions/ResourceWithEtag" - }, - { - "$ref": "#/definitions/EntityQueryKind" + "$ref": "#/definitions/DataConnector" } ], - "description": "Specific entity query.", - "discriminator": "kind", + "description": "Represents ASC (Azure Security Center) data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/ASCDataConnectorProperties", + "description": "ASC (Azure Security Center) data connector properties.", + "x-ms-client-flatten": true + } + }, "type": "object", - "required": [ - "kind" - ] + "x-ms-discriminator-value": "AzureSecurityCenter" }, - "ExpansionEntityQuery": { - "description": "Represents Expansion entity query.", + "ASCDataConnectorProperties": { "allOf": [ { - "$ref": "#/definitions/EntityQuery" + "$ref": "#/definitions/DataConnectorWithAlertsProperties" + } + ], + "description": "ASC (Azure Security Center) data connector properties.", + "properties": { + "subscriptionId": { + "description": "The subscription id to connect to, and get the data from.", + "type": "string" + } + }, + "type": "object" + }, + "AccountEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" } ], + "description": "Represents an account entity.", "properties": { "properties": { - "$ref": "#/definitions/ExpansionEntityQueriesProperties", - "description": "Expansion entity query properties", + "$ref": "#/definitions/AccountEntityProperties", + "description": "Account entity properties", "x-ms-client-flatten": true } }, "type": "object", - "x-ms-discriminator-value": "Expansion" + "x-ms-discriminator-value": "Account" }, - "EntityTimelineKind": { - "description": "The entity query kind", - "enum": [ - "Activity", - "Bookmark", - "SecurityAlert" + "AccountEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "EntityTimelineKind", - "values": [ - { - "description": "activity", - "value": "Activity" - }, - { - "description": "bookmarks", - "value": "Bookmark" - }, - { - "description": "security alerts", - "value": "SecurityAlert" - } - ] - } - }, - "EntityQueryList": { - "description": "List of all the entity queries.", + "description": "Account entity property bag.", "properties": { - "nextLink": { - "description": "URL to fetch the next set of entity queries.", + "aadTenantId": { + "description": "The Azure Active Directory tenant id.", "readOnly": true, "type": "string" }, - "value": { - "description": "Array of entity queries.", - "items": { - "$ref": "#/definitions/EntityQuery" - }, - "type": "array" - } - }, - "required": [ - "value" - ] - }, - "ExpansionEntityQueriesProperties": { - "description": "Describes expansion entity query properties", - "properties": { - "dataSources": { - "description": "List of the data sources that are required to run the query", - "items": { - "description": "data source", - "type": "string" - }, - "type": "array" - }, - "displayName": { - "description": "The query display name", + "aadUserId": { + "description": "The Azure Active Directory user id.", + "readOnly": true, "type": "string" }, - "inputEntityType": { - "$ref": "#/definitions/EntityInnerType", - "description": "The type of the query's source entity" - }, - "inputFields": { - "description": "List of the fields of the source entity that are required to run the query", - "items": { - "description": "input field", - "type": "string" - }, - "type": "array" - }, - "outputEntityTypes": { - "description": "List of the desired output types to be constructed from the result", - "items": { - "$ref": "#/definitions/EntityInnerType", - "description": "output entity type" - }, - "type": "array" + "accountName": { + "description": "The name of the account. This field should hold only the name without any domain added to it, i.e. administrator.", + "readOnly": true, + "type": "string" }, - "queryTemplate": { - "description": "The template query string to be parsed and formatted", + "displayName": { + "description": "The display name of the account.", + "readOnly": true, "type": "string" - } - }, - "type": "object" - }, - "ExpansionResultAggregation": { - "description": "Information of a specific aggregation in the expansion result.", - "properties": { - "aggregationType": { - "description": "The common type of the aggregation. (for e.g. entity field name)", + }, + "hostEntityId": { + "description": "The Host entity id that contains the account in case it is a local account (not domain joined)", + "readOnly": true, "type": "string" }, - "count": { - "description": "Total number of aggregations of the given kind (and aggregationType if given) in the expansion result.", - "type": "integer" + "isDomainJoined": { + "description": "Determines whether this is a domain account.", + "readOnly": true, + "type": "boolean" }, - "displayName": { - "description": "The display name of the aggregation by type.", + "ntDomain": { + "description": "The NetBIOS domain name as it appears in the alert format – domain\\username. Examples: NT AUTHORITY.", + "readOnly": true, "type": "string" }, - "entityKind": { - "$ref": "#/definitions/EntityInnerKind", - "description": "The kind of the aggregated entity." - } - }, - "required": [ - "entityKind", - "count" - ], - "type": "object" - }, - "ExpansionResultsMetadata": { - "description": "Expansion result metadata.", - "properties": { - "aggregations": { - "description": "Information of the aggregated nodes in the expansion result.", - "items": { - "$ref": "#/definitions/ExpansionResultAggregation" - }, - "type": "array" - } - }, - "type": "object" - }, - "ConnectedEntity": { - "description": "Expansion result connected entities", - "properties": { - "targetEntityId": { - "description": "Entity Id of the connected entity", + "objectGuid": { + "description": "The objectGUID attribute is a single-value attribute that is the unique identifier for the object, assigned by active directory.", + "format": "uuid", + "readOnly": true, "type": "string" }, - "additionalData": { - "description": "key-value pairs for a connected entity mapping", - "type": "object" - } - } - }, - "TimelineResultsMetadata": { - "description": "Expansion result metadata.", - "properties": { - "totalCount": { - "description": "the total items found for the timeline request", - "type": "integer", - "format": "int32" + "puid": { + "description": "The Azure Active Directory Passport User ID.", + "readOnly": true, + "type": "string" }, - "aggregations": { - "description": "timeline aggregation per kind", - "items": { - "$ref": "#/definitions/TimelineAggregation" - }, - "type": "array" + "sid": { + "description": "The account security identifier, e.g. S-1-5-18.", + "readOnly": true, + "type": "string" }, - "errors": { - "description": "information about the failure queries", - "items": { - "$ref": "#/definitions/TimelineError" - }, - "type": "array" + "upnSuffix": { + "description": "The user principal name suffix for the account, in some cases it is also the domain name. Examples: contoso.com.", + "readOnly": true, + "type": "string" + }, + "dnsDomain": { + "description": "The fully qualified domain DNS name.", + "readOnly": true, + "type": "string" } }, - "required": [ - "totalCount", - "aggregations" - ], "type": "object" }, - "TimelineError": { - "description": "Timeline Query Errors.", + "ActionRequest": { + "allOf": [ + { + "$ref": "../../../common/1.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Action for alert rule.", "properties": { - "kind": { - "description": "the query kind", - "$ref": "#/definitions/EntityTimelineKind" - }, - "queryId": { - "description": "the query id", - "type": "string" - }, - "errorMessage": { - "description": "the error message", - "type": "string" + "properties": { + "$ref": "#/definitions/ActionRequestProperties", + "description": "Action properties for put request", + "x-ms-client-flatten": true } }, - "required": [ - "kind", - "errorMessage" - ], "type": "object" }, - "TimelineAggregation": { - "description": "timeline aggregation information per kind", + "ActionPropertiesBase": { + "description": "Action property bag base.", "properties": { - "count": { - "description": "the total items found for a kind", - "type": "integer", - "format": "int32" - }, - "kind": { - "description": "the query kind", - "$ref": "#/definitions/EntityTimelineKind" + "logicAppResourceId": { + "description": "Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}.", + "type": "string" } }, "required": [ - "kind", - "count" + "logicAppResourceId" ], "type": "object" }, - "EntityTimelineItem": { - "description": "Entity timeline Item.", - "discriminator": "kind", - "type": "object", + "ActionRequestProperties": { + "allOf": [ + { + "$ref": "#/definitions/ActionPropertiesBase" + } + ], + "description": "Action property bag.", "properties": { - "kind": { - "$ref": "#/definitions/EntityTimelineKind", - "description": "The entity query kind type." + "triggerUri": { + "description": "Logic App Callback URL for this specific workflow.", + "type": "string" } }, "required": [ - "kind" - ] + "triggerUri" + ], + "type": "object" }, - "FileEntity": { + "ActionResponse": { "allOf": [ { - "$ref": "#/definitions/Entity" + "$ref": "#/definitions/Resource" } ], - "description": "Represents a file entity.", + "description": "Action for alert rule.", "properties": { + "etag": { + "description": "Etag of the action.", + "type": "string" + }, "properties": { - "$ref": "#/definitions/FileEntityProperties", - "description": "File entity properties", + "$ref": "#/definitions/ActionResponseProperties", + "description": "Action properties for get request", "x-ms-client-flatten": true } }, - "type": "object", - "x-ms-discriminator-value": "File" + "type": "object" }, - "FileEntityProperties": { + "ActionResponseProperties": { "allOf": [ { - "$ref": "#/definitions/EntityCommonProperties" + "$ref": "#/definitions/ActionPropertiesBase" } ], - "description": "File entity property bag.", + "description": "Action property bag.", "properties": { - "directory": { - "description": "The full path to the file.", + "workflowId": { + "description": "The name of the logic app's workflow.", + "type": "string" + } + }, + "type": "object" + }, + "ActionsList": { + "description": "List all the actions.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of actions.", "readOnly": true, "type": "string" }, - "fileHashEntityIds": { - "description": "The file hash entity identifiers associated with this file", + "value": { + "description": "Array of actions.", "items": { - "description": "file hash id", - "type": "string" + "$ref": "#/definitions/ActionResponse" }, - "readOnly": true, "type": "array" - }, - "fileName": { - "description": "The file name without path (some alerts might not include path).", - "readOnly": true, - "type": "string" - }, - "hostEntityId": { - "description": "The Host entity id which the file belongs to", - "readOnly": true, - "type": "string" } }, - "type": "object" + "type": "object", + "required": [ + "value" + ] }, - "FileHashEntity": { + "AlertRule": { "allOf": [ { - "$ref": "#/definitions/Entity" + "$ref": "#/definitions/ResourceWithEtag" + }, + { + "$ref": "#/definitions/AlertRuleKind" } ], - "description": "Represents a file hash entity.", + "description": "Alert rule.", + "discriminator": "kind", + "type": "object", + "required": [ + "kind" + ] + }, + "AlertRuleKind": { + "description": "Describes an Azure resource with kind.", "properties": { - "properties": { - "$ref": "#/definitions/FileHashEntityProperties", - "description": "FileHash entity properties", - "x-ms-client-flatten": true + "kind": { + "description": "The kind of the alert rule", + "enum": [ + "Scheduled", + "MicrosoftSecurityIncidentCreation", + "Fusion", + "MLBehaviorAnalytics", + "ThreatIntelligence" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AlertRuleKind", + "values": [ + { + "value": "Scheduled" + }, + { + "value": "MicrosoftSecurityIncidentCreation" + }, + { + "value": "Fusion" + }, + { + "value": "MLBehaviorAnalytics" + }, + { + "value": "ThreatIntelligence" + } + ] + } } }, - "type": "object", - "x-ms-discriminator-value": "FileHash" + "required": [ + "kind" + ], + "type": "object" }, - "FileHashEntityProperties": { + "AlertRuleTemplate": { "allOf": [ { - "$ref": "#/definitions/EntityCommonProperties" + "$ref": "#/definitions/Resource" + }, + { + "$ref": "#/definitions/AlertRuleKind" } ], - "description": "FileHash entity property bag.", + "description": "Alert rule template.", + "discriminator": "kind", + "type": "object", + "required": [ + "kind" + ] + }, + "AlertRuleTemplateDataSource": { + "description": "alert rule template data sources", "properties": { - "algorithm": { - "description": "The hash algorithm type.", + "connectorId": { + "description": "The connector id that provides the following data types", + "type": "string" + }, + "dataTypes": { + "description": "The data types used by the alert rule template", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AlertRuleTemplatePropertiesBase": { + "description": "Base alert rule template property bag.", + "properties": { + "alertRulesCreatedByTemplateCount": { + "description": "the number of alert rules that were created by this template", + "type": "integer" + }, + "lastUpdatedDateUTC": { + "description": "The last time that this alert rule template has been updated.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdDateUTC": { + "description": "The time that this alert rule template has been added.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "The description of the alert rule template.", + "type": "string" + }, + "displayName": { + "description": "The display name for alert rule template.", + "type": "string" + }, + "requiredDataConnectors": { + "description": "The required data sources for this template", + "items": { + "$ref": "#/definitions/AlertRuleTemplateDataSource" + }, + "type": "array" + }, + "status": { + "description": "The alert rule template status.", "enum": [ - "Unknown", - "MD5", - "SHA1", - "SHA256", - "SHA256AC" + "Installed", + "Available", + "NotAvailable" ], - "readOnly": true, "type": "string", "x-ms-enum": { "modelAsString": true, - "name": "FileHashAlgorithm", + "name": "TemplateStatus", "values": [ { - "description": "Unknown hash algorithm", - "value": "Unknown" - }, - { - "description": "MD5 hash type", - "value": "MD5" - }, - { - "description": "SHA1 hash type", - "value": "SHA1" + "description": "Alert rule template installed. and can not use more then once", + "value": "Installed" }, { - "description": "SHA256 hash type", - "value": "SHA256" + "description": "Alert rule template is available.", + "value": "Available" }, { - "description": "SHA256 Authenticode hash type", - "value": "SHA256AC" + "description": "Alert rule template is not available", + "value": "NotAvailable" } ] } - }, - "hashValue": { - "description": "The file hash value.", - "readOnly": true, - "type": "string" } }, "type": "object" }, - "InsightQueryItem": { - "allOf": [ - { - "$ref": "#/definitions/EntityQueryItem" - } - ], - "description": "Represents Insight Query.", - "properties": { - "properties": { - "description": "Properties bag for InsightQueryItem", - "$ref": "#/definitions/InsightQueryItemProperties" - } - }, - "type": "object", - "x-ms-discriminator-value": "Insight" - }, - "InsightQueryItemProperties": { - "allOf": [ - { - "$ref": "#/definitions/EntityQueryItemProperties" - } - ], - "description": "Represents Insight Query.", + "AlertRuleTemplatesList": { + "description": "List all the alert rule templates.", "properties": { - "displayName": { - "type": "string", - "description": "The insight display name." - }, - "description": { - "type": "string", - "description": "The insight description." - }, - "baseQuery": { - "type": "string", - "description": "The base query of the insight." - }, - "tableQuery": { - "type": "object", - "description": "The insight table query.", - "properties": { - "columnsDefinitions": { - "type": "array", - "description": "List of insight column definitions.", - "items": { - "properties": { - "header": { - "type": "string", - "description": "Insight column header." - }, - "outputType": { - "type": "string", - "description": "Insights Column type.", - "enum": [ - "Number", - "String", - "Date", - "Entity" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "outputType" - } - }, - "supportDeepLink": { - "type": "boolean", - "description": "Is query supports deep-link." - } - } - } - }, - "queriesDefinitions": { - "type": "array", - "description": "List of insight queries definitions.", - "items": { - "properties": { - "filter": { - "type": "string", - "description": "Insight column header." - }, - "summarize": { - "type": "string", - "description": "Insight column header." - }, - "project": { - "type": "string", - "description": "Insight column header." - }, - "linkColumnsDefinitions": { - "type": "array", - "description": "Insight column header.", - "items": { - "properties": { - "projectedName": { - "type": "string", - "description": "Insight Link Definition Projected Name." - }, - "Query": { - "type": "string", - "description": "Insight Link Definition Query." - } - } - } - } - } - } - } - } - }, - "chartQuery": { - "type": "object", - "description": "The insight chart query." - }, - "additionalQuery": { - "type": "object", - "description": "The activity query definitions.", - "properties": { - "query": { - "type": "string", - "description": "The insight query." - }, - "text": { - "type": "string", - "description": "The insight text." - } - } - }, - "defaultTimeRange": { - "type": "object", - "description": "The insight chart query.", - "properties": { - "beforeRange": { - "type": "string", - "description": "The padding for the start time of the query." - }, - "afterRange": { - "type": "string", - "description": "The padding for the end time of the query." - } - } + "nextLink": { + "description": "URL to fetch the next set of alert rule templates.", + "readOnly": true, + "type": "string" }, - "referenceTimeRange": { - "type": "object", - "description": "The insight chart query.", - "properties": { - "beforeRange": { - "type": "string", - "description": "Additional query time for looking back." - } - } + "value": { + "description": "Array of alert rule templates.", + "items": { + "$ref": "#/definitions/AlertRuleTemplate" + }, + "type": "array" } }, "type": "object", - "x-ms-discriminator-value": "Insight" - }, - "ActivityTimelineItem": { - "allOf": [ - { - "$ref": "#/definitions/EntityTimelineItem" - } - ], - "description": "Represents Activity timeline item.", - "properties": { - "queryId": { - "type": "string", - "description": "The activity query id." - }, - "bucketStartTimeUTC": { - "format": "date-time", - "type": "string", - "description": "The grouping bucket start time." - }, - "bucketEndTimeUTC": { - "format": "date-time", - "type": "string", - "description": "The grouping bucket end time." - }, - "firstActivityTimeUTC": { - "format": "date-time", - "type": "string", - "description": "The time of the first activity in the grouping bucket." - }, - "lastActivityTimeUTC": { - "format": "date-time", - "type": "string", - "description": "The time of the last activity in the grouping bucket." - }, - "content": { - "type": "string", - "description": "The activity timeline content." - }, - "title": { - "type": "string", - "description": "The activity timeline title." - } - }, "required": [ - "queryId", - "bucketStartTimeUTC", - "bucketEndTimeUTC", - "firstActivityTimeUTC", - "lastActivityTimeUTC", - "content", - "title" - ], - "type": "object", - "x-ms-discriminator-value": "Activity" + "value" + ] }, - "SecurityAlertTimelineItem": { - "allOf": [ - { - "$ref": "#/definitions/EntityTimelineItem" - } + "AlertRuleTriggerOperator": { + "description": "The operation against the threshold that triggers alert rule.", + "enum": [ + "GreaterThan", + "LessThan", + "Equal", + "NotEqual" ], - "description": "Represents security alert timeline item.", + "type": "string", + "x-ms-enum": { + "modelAsString": false, + "name": "TriggerOperator" + } + }, + "AlertRulesList": { + "description": "List all the alert rules.", "properties": { - "azureResourceId": { - "type": "string", - "description": "The alert azure resource id." - }, - "productName": { - "type": "string", - "description": "The alert product name." - }, - "description": { - "type": "string", - "description": "The alert description." - }, - "displayName": { - "type": "string", - "description": "The alert name." - }, - "severity": { - "$ref": "#/definitions/AlertSeverity", - "description": "The alert severity." - }, - "endTimeUtc": { - "format": "date-time", - "type": "string", - "description": "The alert end time." - }, - "startTimeUtc": { - "format": "date-time", - "type": "string", - "description": "The alert start time." - }, - "timeGenerated": { - "format": "date-time", - "type": "string", - "description": "The alert generated time." + "nextLink": { + "description": "URL to fetch the next set of alert rules.", + "readOnly": true, + "type": "string" }, - "alertType": { - "type": "string", - "description": "The name of the alert type." + "value": { + "description": "Array of alert rules.", + "items": { + "$ref": "#/definitions/AlertRule" + }, + "type": "array" } }, - "required": [ - "azureResourceId", - "displayName", - "severity", - "endTimeUtc", - "startTimeUtc", - "timeGenerated", - "alertType" - ], "type": "object", - "x-ms-discriminator-value": "SecurityAlert" + "required": [ + "value" + ] }, - "BookmarkTimelineItem": { - "allOf": [ - { - "$ref": "#/definitions/EntityTimelineItem" - } + "AlertSeverity": { + "description": "The severity of the alert", + "enum": [ + "High", + "Medium", + "Low", + "Informational" ], - "description": "Represents bookmark timeline item.", - "properties": { - "azureResourceId": { - "type": "string", - "description": "The bookmark azure resource id." - }, - "displayName": { - "type": "string", - "description": "The bookmark display name." - }, - "notes": { - "type": "string", - "description": "The notes of the bookmark" - }, - "endTimeUtc": { - "format": "date-time", - "type": "string", - "description": "The bookmark end time." - }, - "startTimeUtc": { - "format": "date-time", - "type": "string", - "description": "TThe bookmark start time." - }, - "eventTime": { - "format": "date-time", - "type": "string", - "description": "The bookmark event time." - }, - "createdBy": { - "$ref": "#/definitions/UserInfo", - "description": "Describes a user that created the bookmark", - "type": "object" - }, - "labels": { - "description": "List of labels relevant to this bookmark", - "items": { - "$ref": "#/definitions/Label" + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AlertSeverity", + "values": [ + { + "description": "High severity", + "value": "High" }, - "type": "array" + { + "description": "Medium severity", + "value": "Medium" + }, + { + "description": "Low severity", + "value": "Low" + }, + { + "description": "Informational severity", + "value": "Informational" + } + ] + } + }, + "AlertsDataTypeOfDataConnector": { + "description": "Alerts data type for data connectors.", + "properties": { + "alerts": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Alerts data type connection.", + "type": "object" } }, + "type": "object", "required": [ - "azureResourceId" + "alerts" + ] + }, + "AttackTactic": { + "description": "The severity for alerts created by this alert rule.", + "enum": [ + "InitialAccess", + "Execution", + "Persistence", + "PrivilegeEscalation", + "DefenseEvasion", + "CredentialAccess", + "Discovery", + "LateralMovement", + "Collection", + "Exfiltration", + "CommandAndControl", + "Impact", + "PreAttack" ], - "type": "object", - "x-ms-discriminator-value": "Bookmark" + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AttackTactic" + } }, - "FusionAlertRule": { + "AwsCloudTrailDataConnector": { "allOf": [ { - "$ref": "#/definitions/AlertRule" + "$ref": "#/definitions/DataConnector" } ], - "description": "Represents Fusion alert rule.", + "description": "Represents Amazon Web Services CloudTrail data connector.", "properties": { "properties": { - "$ref": "#/definitions/FusionAlertRuleProperties", - "description": "Fusion alert rule properties", + "$ref": "#/definitions/AwsCloudTrailDataConnectorProperties", + "description": "Amazon Web Services CloudTrail data connector properties.", "x-ms-client-flatten": true } }, "type": "object", - "x-ms-discriminator-value": "Fusion" + "x-ms-discriminator-value": "AmazonWebServicesCloudTrail" }, - "FusionAlertRuleProperties": { - "description": "Fusion alert rule base property bag.", + "AwsCloudTrailDataConnectorDataTypes": { + "description": "The available data types for Amazon Web Services CloudTrail data connector.", "properties": { - "alertRuleTemplateName": { - "description": "The Name of the alert rule template used to create this rule.", - "type": "string" - }, - "description": { - "description": "The description of the alert rule.", - "readOnly": true, - "type": "string" - }, - "displayName": { - "description": "The display name for alerts created by this alert rule.", - "readOnly": true, - "type": "string" - }, - "enabled": { - "description": "Determines whether this alert rule is enabled or disabled.", - "type": "boolean" - }, - "lastModifiedUtc": { - "description": "The last time that this alert has been modified.", - "format": "date-time", - "readOnly": true, + "logs": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Logs data type.", + "type": "object" + } + }, + "type": "object", + "required": [ + "logs" + ] + }, + "AwsCloudTrailDataConnectorProperties": { + "description": "Amazon Web Services CloudTrail data connector properties.", + "properties": { + "awsRoleArn": { + "description": "The Aws Role Arn (with CloudTrailReadOnly policy) that is used to access the Aws account.", "type": "string" }, - "severity": { - "$ref": "#/definitions/AlertSeverity", - "description": "The severity for alerts created by this alert rule.", - "readOnly": true - }, - "tactics": { - "description": "The tactics of the alert rule", - "items": { - "$ref": "#/definitions/AttackTactic" - }, - "readOnly": true, - "type": "array" + "dataTypes": { + "$ref": "#/definitions/AwsCloudTrailDataConnectorDataTypes", + "description": "The available data types for the connector." } }, "required": [ - "alertRuleTemplateName", - "enabled" + "dataTypes" ], "type": "object" }, - "FusionAlertRuleTemplate": { + "AzureResourceEntity": { "allOf": [ { - "$ref": "#/definitions/AlertRuleTemplate" + "$ref": "#/definitions/Entity" } ], - "description": "Represents Fusion alert rule template.", + "description": "Represents an azure resource entity.", "properties": { "properties": { - "allOf": [ - { - "$ref": "#/definitions/AlertRuleTemplatePropertiesBase" - } - ], - "description": "Fusion alert rule template properties", - "properties": { - "severity": { - "$ref": "#/definitions/AlertSeverity", - "description": "The severity for alerts created by this alert rule." - }, - "tactics": { - "description": "The tactics of the alert rule template", - "items": { - "$ref": "#/definitions/AttackTactic" - }, - "type": "array" - } - }, - "required": [ - "displayName", - "description", - "status", - "severity", - "alertRulesCreatedByTemplateCount" - ], + "$ref": "#/definitions/AzureResourceEntityProperties", + "description": "AzureResource entity properties", "x-ms-client-flatten": true } }, "type": "object", - "x-ms-discriminator-value": "Fusion" + "x-ms-discriminator-value": "AzureResource" }, - "ThreatIntelligenceAlertRule": { + "AzureResourceEntityProperties": { "allOf": [ { - "$ref": "#/definitions/AlertRule" + "$ref": "#/definitions/EntityCommonProperties" } ], - "description": "Represents Threat Intelligence alert rule.", - "properties": { - "properties": { - "$ref": "#/definitions/ThreatIntelligenceAlertRuleProperties", - "description": "Threat Intelligence alert rule properties", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "ThreatIntelligence" - }, - "ThreatIntelligenceAlertRuleProperties": { - "description": "Threat Intelligence alert rule base property bag.", + "description": "AzureResource entity property bag.", "properties": { - "alertRuleTemplateName": { - "description": "The Name of the alert rule template used to create this rule.", - "type": "string" - }, - "description": { - "description": "The description of the alert rule.", - "readOnly": true, - "type": "string" - }, - "displayName": { - "description": "The display name for alerts created by this alert rule.", + "resourceId": { + "description": "The azure resource id of the resource", "readOnly": true, "type": "string" }, - "enabled": { - "description": "Determines whether this alert rule is enabled or disabled.", - "type": "boolean" - }, - "lastModifiedUtc": { - "description": "The last time that this alert has been modified.", - "format": "date-time", + "subscriptionId": { + "description": "The subscription id of the resource", "readOnly": true, "type": "string" - }, - "severity": { - "$ref": "#/definitions/AlertSeverity", - "description": "The severity for alerts created by this alert rule.", - "readOnly": true - }, - "tactics": { - "description": "The tactics of the alert rule", - "items": { - "$ref": "#/definitions/AttackTactic" - }, - "readOnly": true, - "type": "array" } }, - "required": [ - "alertRuleTemplateName", - "enabled" - ], "type": "object" }, - "ThreatIntelligenceAlertRuleTemplate": { + "CasesAggregation": { "allOf": [ { - "$ref": "#/definitions/AlertRuleTemplate" + "$ref": "#/definitions/Aggregations" } ], - "description": "Represents Threat Intelligence alert rule template.", + "description": "Represents aggregations results for cases.", "properties": { "properties": { - "allOf": [ - { - "$ref": "#/definitions/AlertRuleTemplatePropertiesBase" - } - ], - "description": "Threat Intelligence alert rule template properties", - "properties": { - "severity": { - "$ref": "#/definitions/AlertSeverity", - "description": "The severity for alerts created by this alert rule." - }, - "tactics": { - "description": "The tactics of the alert rule template", - "items": { - "$ref": "#/definitions/AttackTactic" - }, - "type": "array" - } - }, - "required": [ - "displayName", - "description", - "status", - "severity", - "alertRulesCreatedByTemplateCount" - ], + "$ref": "#/definitions/CasesAggregationProperties", + "description": "Properties of aggregations results of cases.", "x-ms-client-flatten": true } }, "type": "object", - "x-ms-discriminator-value": "ThreatIntelligence" + "x-ms-discriminator-value": "CasesAggregation" }, - "GeoLocation": { - "description": "The geo-location context attached to the ip entity", + "CasesAggregationBySeverityProperties": { + "description": "Aggregative results of cases by severity property bag.", "properties": { - "asn": { - "description": "Autonomous System Number", + "totalCriticalSeverity": { + "description": "Total amount of open cases with severity Critical", "readOnly": true, "type": "integer" }, - "city": { - "description": "City name", + "totalHighSeverity": { + "description": "Total amount of open cases with severity High", "readOnly": true, - "type": "string" + "type": "integer" }, - "countryCode": { - "description": "The country code according to ISO 3166 format", + "totalInformationalSeverity": { + "description": "Total amount of open cases with severity Informational", "readOnly": true, - "type": "string" + "type": "integer" }, - "countryName": { - "description": "Country name according to ISO 3166 Alpha 2: the lowercase of the English Short Name", + "totalLowSeverity": { + "description": "Total amount of open cases with severity Low", "readOnly": true, - "type": "string" + "type": "integer" }, - "latitude": { - "description": "The longitude of the identified location, expressed as a floating point number with range of -180 to 180, with positive numbers representing East and negative numbers representing West. Latitude and longitude are derived from the city or postal code.", - "format": "double", + "totalMediumSeverity": { + "description": "Total amount of open cases with severity medium", "readOnly": true, - "type": "number" + "type": "integer" + } + }, + "type": "object" + }, + "CasesAggregationByStatusProperties": { + "description": "Aggregative results of cases by status property bag.", + "properties": { + "totalDismissedStatus": { + "description": "Total amount of closed cases with status Dismissed", + "readOnly": true, + "type": "integer" }, - "longitude": { - "description": "The latitude of the identified location, expressed as a floating point number with range of - 90 to 90, with positive numbers representing North and negative numbers representing South. Latitude and longitude are derived from the city or postal code.", - "format": "double", + "totalInProgressStatus": { + "description": "Total amount of open cases with status InProgress", "readOnly": true, - "type": "number" + "type": "integer" }, - "state": { - "description": "State name", + "totalNewStatus": { + "description": "Total amount of open cases with status New", + "readOnly": true, + "type": "integer" + }, + "totalResolvedStatus": { + "description": "Total amount of closed cases with status Resolved", + "readOnly": true, + "type": "integer" + }, + "totalFalsePositiveStatus": { + "description": "Total amount of closed cases with status Closed and Close reason of False positive", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "totalTruePositiveStatus": { + "description": "Total amount of closed cases with status Closed and Close reason of True positive", "readOnly": true, + "type": "integer", + "format": "int32" + } + }, + "type": "object" + }, + "CasesAggregationProperties": { + "description": "Aggregative results of cases property bag.", + "properties": { + "aggregationBySeverity": { + "$ref": "#/definitions/CasesAggregationBySeverityProperties", + "description": "Aggregations results by case severity." + }, + "aggregationByStatus": { + "$ref": "#/definitions/CasesAggregationByStatusProperties", + "description": "Aggregations results by case status." + } + }, + "type": "object" + }, + "ClientInfo": { + "description": "Information on the client (user or application) that made some action", + "properties": { + "email": { + "description": "The email of the client.", + "type": "string" + }, + "name": { + "description": "The name of the client.", + "type": "string" + }, + "objectId": { + "description": "The object id of the client.", + "format": "uuid", + "type": "string" + }, + "userPrincipalName": { + "description": "The user principal name of the client.", "type": "string" } }, - "readOnly": true, "type": "object" }, - "HostEntity": { + "CloudApplicationEntity": { "allOf": [ { "$ref": "#/definitions/Entity" } ], - "description": "Represents a host entity.", + "description": "Represents a cloud application entity.", "properties": { "properties": { - "$ref": "#/definitions/HostEntityProperties", - "description": "Host entity properties", + "$ref": "#/definitions/CloudApplicationEntityProperties", + "description": "CloudApplication entity properties", "x-ms-client-flatten": true } }, "type": "object", - "x-ms-discriminator-value": "Host" + "x-ms-discriminator-value": "CloudApplication" }, - "HostEntityProperties": { + "CloudApplicationEntityProperties": { "allOf": [ { "$ref": "#/definitions/EntityCommonProperties" } ], - "description": "Host entity property bag.", + "description": "CloudApplication entity property bag.", "properties": { - "azureID": { - "description": "The azure resource id of the VM.", - "readOnly": true, - "type": "string" - }, - "dnsDomain": { - "description": "The DNS domain that this host belongs to. Should contain the compete DNS suffix for the domain", + "appId": { + "description": "The technical identifier of the application.", "readOnly": true, - "type": "string" + "type": "integer" }, - "hostName": { - "description": "The hostname without the domain suffix.", + "appName": { + "description": "The name of the related cloud application.", "readOnly": true, "type": "string" }, - "isDomainJoined": { - "description": "Determines whether this host belongs to a domain.", - "readOnly": true, - "type": "boolean" - }, - "netBiosName": { - "description": "The host name (pre-windows2000).", + "instanceName": { + "description": "The user defined instance name of the cloud application. It is often used to distinguish between several applications of the same type that a customer has.", "readOnly": true, "type": "string" - }, - "ntDomain": { - "description": "The NT domain that this host belongs to.", + } + }, + "type": "object" + }, + "CloudError": { + "description": "Error response structure.", + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "Error data", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-external": true + }, + "CloudErrorBody": { + "description": "Error details.", + "properties": { + "code": { + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically.", "readOnly": true, "type": "string" }, - "omsAgentID": { - "description": "The OMS agent id, if the host has OMS agent installed.", + "message": { + "description": "A message describing the error, intended to be suitable for display in a user interface.", "readOnly": true, "type": "string" + } + }, + "type": "object", + "x-ms-external": true + }, + "DataConnector": { + "allOf": [ + { + "$ref": "#/definitions/ResourceWithEtag" }, - "osFamily": { - "description": "The operating system type.", + { + "$ref": "#/definitions/DataConnectorKind" + } + ], + "description": "Data connector.", + "discriminator": "kind", + "type": "object", + "required": [ + "kind" + ] + }, + "DataConnectorDataTypeCommon": { + "description": "Common field for data type in data connectors.", + "properties": { + "state": { + "description": "Describe whether this data type connection is enabled or not.", "enum": [ - "Linux", - "Windows", - "Android", - "IOS", - "Unknown" + "Enabled", + "Disabled" ], "type": "string", "x-ms-enum": { - "modelAsString": false, - "name": "OSFamily", + "modelAsString": true, + "name": "DataTypeState" + } + } + }, + "type": "object", + "required": [ + "state" + ] + }, + "DataConnectorKind": { + "description": "Describes an Azure resource with kind.", + "properties": { + "kind": { + "description": "The kind of the data connector", + "enum": [ + "AzureActiveDirectory", + "AzureSecurityCenter", + "MicrosoftCloudAppSecurity", + "ThreatIntelligence", + "ThreatIntelligenceTaxii", + "Office365", + "OfficeATP", + "AmazonWebServicesCloudTrail", + "AzureAdvancedThreatProtection", + "MicrosoftDefenderAdvancedThreatProtection", + "Dynamics365", + "MicrosoftThreatProtection", + "MicrosoftThreatIntelligence" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DataConnectorKind", "values": [ { - "description": "Host with Linux operating system.", - "value": "Linux" + "value": "AzureActiveDirectory" + }, + { + "value": "AzureSecurityCenter" + }, + { + "value": "MicrosoftCloudAppSecurity" + }, + { + "value": "ThreatIntelligence" }, { - "description": "Host with Windows operating system.", - "value": "Windows" + "value": "ThreatIntelligenceTaxii" }, { - "description": "Host with Android operating system.", - "value": "Android" + "value": "Office365" }, { - "description": "Host with IOS operating system.", - "value": "IOS" + "value": "OfficeATP" }, { - "description": "Host with Unknown operating system.", - "value": "Unknown" + "value": "AmazonWebServicesCloudTrail" + }, + { + "value": "AzureAdvancedThreatProtection" + }, + { + "value": "MicrosoftDefenderAdvancedThreatProtection" + }, + { + "value": "Dynamics365" + }, + { + "value": "MicrosoftThreatProtection" + }, + { + "value": "MicrosoftThreatIntelligence" } ] } - }, - "osVersion": { - "description": "A free text representation of the operating system. This field is meant to hold specific versions the are more fine grained than OSFamily or future values not supported by OSFamily enumeration", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "Incident": { - "allOf": [ - { - "$ref": "#/definitions/ResourceWithEtag" - } - ], - "description": "Represents an incident in Azure Security Insights.", - "properties": { - "properties": { - "$ref": "#/definitions/IncidentProperties", - "description": "Incident properties", - "x-ms-client-flatten": true - } - }, - "type": "object" - }, - "HuntingBookmark": { - "allOf": [ - { - "$ref": "#/definitions/Entity" - } - ], - "description": "Represents a Hunting bookmark entity.", - "properties": { - "properties": { - "$ref": "#/definitions/HuntingBookmarkProperties", - "description": "HuntingBookmark entity properties", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "Bookmark" - }, - "HuntingBookmarkProperties": { - "allOf": [ - { - "$ref": "#/definitions/EntityCommonProperties" - } - ], - "description": "Describes bookmark properties", - "properties": { - "created": { - "description": "The time the bookmark was created", - "format": "date-time", - "type": "string" - }, - "createdBy": { - "$ref": "#/definitions/UserInfo", - "description": "Describes a user that created the bookmark", - "type": "object" - }, - "displayName": { - "description": "The display name of the bookmark", - "type": "string" - }, - "eventTime": { - "description": "The time of the event", - "format": "date-time", - "type": "string" - }, - "labels": { - "description": "List of labels relevant to this bookmark", - "items": { - "$ref": "#/definitions/Label" - }, - "type": "array" - }, - "notes": { - "description": "The notes of the bookmark", - "type": "string" - }, - "query": { - "description": "The query of the bookmark.", - "type": "string" - }, - "queryResult": { - "description": "The query result of the bookmark.", - "type": "string" - }, - "updated": { - "description": "The last time the bookmark was updated", - "format": "date-time", - "type": "string" - }, - "updatedBy": { - "$ref": "#/definitions/UserInfo", - "description": "Describes a user that updated the bookmark", - "type": "object" - }, - "incidentInfo": { - "$ref": "#/definitions/IncidentInfo", - "description": "Describes an incident that relates to bookmark", - "type": "object" } }, "required": [ - "displayName", - "query" + "kind" ], "type": "object" }, - "IncidentAdditionalData": { - "description": "Incident additional data property bag.", + "DataConnectorList": { + "description": "List all the data connectors.", "properties": { - "alertsCount": { - "description": "The number of alerts in the incident", - "readOnly": true, - "type": "integer" - }, - "bookmarksCount": { - "description": "The number of bookmarks in the incident", - "readOnly": true, - "type": "integer" - }, - "commentsCount": { - "description": "The number of comments in the incident", - "readOnly": true, - "type": "integer" - }, - "alertProductNames": { - "description": "List of product names of alerts in the incident", - "items": { - "description": "Alert product name", - "type": "string" - }, + "nextLink": { + "description": "URL to fetch the next set of data connectors.", "readOnly": true, - "type": "array" + "type": "string" }, - "tactics": { - "description": "The tactics associated with incident", + "value": { + "description": "Array of data connectors.", "items": { - "$ref": "#/definitions/AttackTactic" + "$ref": "#/definitions/DataConnector" }, - "readOnly": true, "type": "array" } }, - "type": "object" + "type": "object", + "required": [ + "value" + ] }, - "IncidentAlertList": { - "description": "List of incident alerts.", + "DataConnectorTenantId": { + "description": "Properties data connector on tenant level.", "properties": { - "value": { - "description": "Array of incident alerts.", - "type": "array", - "items": { - "$ref": "#/definitions/SecurityAlert" - } + "tenantId": { + "description": "The tenant id to connect to, and get the data from.", + "type": "string" } }, "required": [ - "value" - ] + "tenantId" + ], + "type": "object" }, - "IncidentBookmarkList": { - "description": "List of incident bookmarks.", + "DataConnectorWithAlertsProperties": { + "description": "Data connector properties.", "properties": { - "value": { - "description": "Array of incident bookmarks.", - "type": "array", - "items": { - "$ref": "#/definitions/HuntingBookmark" - } + "dataTypes": { + "$ref": "#/definitions/AlertsDataTypeOfDataConnector", + "description": "The available data types for the connector." } }, - "required": [ - "value" - ] + "type": "object" }, - "IncidentComment": { + "DnsEntity": { "allOf": [ { - "$ref": "#/definitions/ResourceWithEtag" + "$ref": "#/definitions/Entity" } ], - "description": "Represents an incident comment", + "description": "Represents a dns entity.", "properties": { "properties": { - "$ref": "#/definitions/IncidentCommentProperties", - "description": "Incident comment properties", + "$ref": "#/definitions/DnsEntityProperties", + "description": "Dns entity properties", "x-ms-client-flatten": true } }, - "type": "object" + "type": "object", + "x-ms-discriminator-value": "DnsResolution" }, - "IncidentCommentList": { - "description": "List of incident comments.", - "properties": { - "nextLink": { - "description": "URL to fetch the next set of comments.", - "readOnly": true, - "type": "string" - }, - "value": { - "description": "Array of comments.", - "items": { - "$ref": "#/definitions/IncidentComment" - }, - "type": "array" + "DnsEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" } - }, - "required": [ - "value" - ] - }, - "IncidentCommentProperties": { - "description": "Incident comment property bag.", + ], + "description": "Dns entity property bag.", "properties": { - "createdTimeUtc": { - "description": "The time the comment was created", - "format": "date-time", + "dnsServerIpEntityId": { + "description": "An ip entity id for the dns server resolving the request", "readOnly": true, "type": "string" }, - "lastModifiedTimeUtc": { - "description": "The time the comment was updated", - "format": "date-time", + "domainName": { + "description": "The name of the dns record associated with the alert", "readOnly": true, "type": "string" }, - "message": { - "description": "The comment message", + "hostIpAddressEntityId": { + "description": "An ip entity id for the dns request client", + "readOnly": true, "type": "string" }, - "author": { - "$ref": "#/definitions/ClientInfo", - "description": "Describes the client that created the comment", + "ipAddressEntityIds": { + "description": "Ip entity identifiers for the resolved ip address.", + "items": { + "description": "Ip entity id", + "type": "string" + }, "readOnly": true, - "type": "object" + "type": "array" } }, - "required": [ - "message" - ], "type": "object" }, - "IncidentEntitiesResponse": { - "description": "The incident related entities response.", + "Dynamics365DataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents Dynamics365 data connector.", "properties": { - "entities": { - "description": "Array of the incident related entities.", - "type": "array", - "items": { - "$ref": "#/definitions/Entity" - } - }, - "metaData": { - "description": "The metadata from the incident related entities results.", - "type": "array", - "items": { - "$ref": "#/definitions/IncidentEntitiesResultsMetadata" - } + "properties": { + "$ref": "#/definitions/Dynamics365DataConnectorProperties", + "description": "Dynamics365 data connector properties.", + "x-ms-client-flatten": true } - } + }, + "type": "object", + "x-ms-discriminator-value": "Dynamics365" }, - "IncidentEntitiesResultsMetadata": { - "description": "Information of a specific aggregation in the incident related entities result.", + "Dynamics365DataConnectorDataTypes": { + "description": "The available data types for Dynamics365 data connector.", "properties": { - "count": { - "description": "Total number of aggregations of the given kind in the incident related entities result.", - "type": "integer", - "format": "int32" - }, - "entityKind": { - "$ref": "#/definitions/EntityInnerKind", - "description": "The kind of the aggregated entity." + "dynamics365CdsActivities": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Common Data Service data type connection.", + "type": "object" } }, + "type": "object", "required": [ - "entityKind", - "count" - ], - "type": "object" + "dynamics365CdsActivities" + ] }, - "IncidentLabel": { - "description": "Represents an incident label", + "Dynamics365DataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "Dynamics365 data connector properties.", "properties": { - "labelName": { - "description": "The name of the label", - "type": "string" - }, - "labelType": { - "description": "The type of the label", - "enum": [ - "User", - "System" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "modelAsString": true, - "name": "IncidentLabelType", - "values": [ - { - "description": "Label manually created by a user", - "value": "User" - }, - { - "description": "Label automatically created by the system", - "value": "System" - } - ] - } + "dataTypes": { + "$ref": "#/definitions/Dynamics365DataConnectorDataTypes", + "description": "The available data types for the connector." } }, "required": [ - "labelName" + "dataTypes" ], "type": "object" }, - "IncidentList": { - "description": "List all the incidents.", - "properties": { - "nextLink": { - "description": "URL to fetch the next set of incidents.", - "readOnly": true, - "type": "string" + "Entity": { + "allOf": [ + { + "$ref": "#/definitions/Resource" }, - "value": { - "description": "Array of incidents.", - "items": { - "$ref": "#/definitions/Incident" - }, - "type": "array" + { + "$ref": "#/definitions/EntityKind" } - }, + ], + "description": "Specific entity.", + "discriminator": "kind", + "type": "object", "required": [ - "value" + "kind" ] }, - "IncidentOwnerInfo": { - "description": "Information on the user an incident is assigned to", + "EntityCommonProperties": { + "description": "Entity common property bag.", "properties": { - "email": { - "description": "The email of the user the incident is assigned to.", - "type": "string" - }, - "assignedTo": { - "description": "The name of the user the incident is assigned to.", - "type": "string" - }, - "objectId": { - "description": "The object id of the user the incident is assigned to.", - "format": "uuid", - "type": "string" + "additionalData": { + "additionalProperties": { + "type": "object" + }, + "description": "A bag of custom fields that should be part of the entity and will be presented to the user.", + "readOnly": true, + "type": "object" }, - "userPrincipalName": { - "description": "The user principal name of the user the incident is assigned to.", + "friendlyName": { + "description": "The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated.", + "readOnly": true, "type": "string" } }, "type": "object" }, - "IncidentClassification": { - "description": "The reason the incident was closed", + "EntityInnerKind": { + "description": "The kind of the entity", "enum": [ - "Undetermined", - "TruePositive", - "BenignPositive", - "FalsePositive" + "Account", + "Host", + "File", + "AzureResource", + "CloudApplication", + "DnsResolution", + "FileHash", + "Ip", + "Malware", + "Process", + "RegistryKey", + "RegistryValue", + "SecurityGroup", + "Url", + "IoTDevice", + "SecurityAlert", + "Bookmark", + "Mailbox", + "MailCluster", + "MailMessage", + "SubmissionMail" ], "type": "string", "x-ms-enum": { "modelAsString": true, - "name": "IncidentClassification", + "name": "EntityKind", "values": [ { - "description": "Incident classification was undetermined", - "value": "Undetermined" + "description": "Entity represents account in the system.", + "value": "Account" + }, + { + "description": "Entity represents host in the system.", + "value": "Host" + }, + { + "description": "Entity represents file in the system.", + "value": "File" + }, + { + "description": "Entity represents azure resource in the system.", + "value": "AzureResource" + }, + { + "description": "Entity represents cloud application in the system.", + "value": "CloudApplication" + }, + { + "description": "Entity represents dns resolution in the system.", + "value": "DnsResolution" + }, + { + "description": "Entity represents file hash in the system.", + "value": "FileHash" + }, + { + "description": "Entity represents ip in the system.", + "value": "Ip" + }, + { + "description": "Entity represents malware in the system.", + "value": "Malware" + }, + { + "description": "Entity represents process in the system.", + "value": "Process" + }, + { + "description": "Entity represents registry key in the system.", + "value": "RegistryKey" + }, + { + "description": "Entity represents registry value in the system.", + "value": "RegistryValue" + }, + { + "description": "Entity represents security group in the system.", + "value": "SecurityGroup" }, { - "description": "Incident was true positive", - "value": "TruePositive" + "description": "Entity represents url in the system.", + "value": "Url" }, { - "description": "Incident was benign positive", - "value": "BenignPositive" + "description": "Entity represents IoT device in the system.", + "value": "IoTDevice" }, { - "description": "Incident was false positive", - "value": "FalsePositive" - } - ] - } - }, - "IncidentClassificationReason": { - "description": "The classification reason the incident was closed with", - "enum": [ - "SuspiciousActivity", - "SuspiciousButExpected", - "IncorrectAlertLogic", - "InaccurateData" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "IncidentClassificationReason", - "values": [ + "description": "Entity represents security alert in the system.", + "value": "SecurityAlert" + }, { - "description": "Classification reason was suspicious activity", - "value": "SuspiciousActivity" + "description": "Entity represents bookmark in the system.", + "value": "Bookmark" }, { - "description": "Classification reason was suspicious but expected", - "value": "SuspiciousButExpected" + "description": "Entity represents mail cluster in the system.", + "value": "MailCluster" }, { - "description": "Classification reason was incorrect alert logic", - "value": "IncorrectAlertLogic" + "description": "Entity represents mail message in the system.", + "value": "MailMessage" }, { - "description": "Classification reason was inaccurate data", - "value": "InaccurateData" + "description": "Entity represents mailbox in the system.", + "value": "Mailbox" + }, + { + "description": "Entity represents submission mail in the system.", + "value": "SubmissionMail" } ] } }, - "IncidentSeverity": { - "description": "The severity of the incident", + "EntityInnerType": { + "description": "The type of the entity", "enum": [ - "High", - "Medium", - "Low", - "Informational" + "Account", + "Host", + "File", + "AzureResource", + "CloudApplication", + "DNS", + "FileHash", + "IP", + "Malware", + "Process", + "RegistryKey", + "RegistryValue", + "SecurityGroup", + "URL", + "IoTDevice", + "SecurityAlert", + "HuntingBookmark", + "MailCluster", + "MailMessage", + "Mailbox", + "SubmissionMail" ], "type": "string", "x-ms-enum": { "modelAsString": true, - "name": "IncidentSeverity", + "name": "EntityType", "values": [ { - "description": "High severity", - "value": "High" + "description": "Entity represents account in the system.", + "value": "Account" }, { - "description": "Medium severity", - "value": "Medium" + "description": "Entity represents host in the system.", + "value": "Host" }, { - "description": "Low severity", - "value": "Low" + "description": "Entity represents file in the system.", + "value": "File" }, { - "description": "Informational severity", - "value": "Informational" - } - ] - } - }, - "IncidentStatus": { - "description": "The status of the incident", - "enum": [ - "New", - "Active", - "Closed" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "IncidentStatus", - "values": [ + "description": "Entity represents azure resource in the system.", + "value": "AzureResource" + }, { - "description": "An active incident which isn't being handled currently", - "value": "New" + "description": "Entity represents cloud application in the system.", + "value": "CloudApplication" }, { - "description": "An active incident which is being handled", - "value": "Active" + "description": "Entity represents dns in the system.", + "value": "DNS" }, { - "description": "A non-active incident", - "value": "Closed" - } - ] - } - }, - "IncidentProperties": { - "description": "Describes incident properties", - "properties": { - "additionalData": { - "$ref": "#/definitions/IncidentAdditionalData", - "description": "Additional data on the incident", - "readOnly": true, - "type": "object" - }, - "classification": { - "$ref": "#/definitions/IncidentClassification", - "description": "The reason the incident was closed" - }, - "classificationComment": { - "description": "Describes the reason the incident was closed", - "type": "string" - }, - "classificationReason": { - "$ref": "#/definitions/IncidentClassificationReason", - "description": "The classification reason the incident was closed with" - }, - "createdTimeUtc": { - "description": "The time the incident was created", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "The description of the incident", - "type": "string" - }, - "firstActivityTimeUtc": { - "description": "The time of the first activity in the incident", - "format": "date-time", - "type": "string" - }, - "incidentUrl": { - "description": "The deep-link url to the incident in Azure portal", - "readOnly": true, - "type": "string" - }, - "incidentNumber": { - "description": "A sequential number", - "readOnly": true, - "type": "integer" - }, - "labels": { - "description": "List of labels relevant to this incident", - "items": { - "$ref": "#/definitions/IncidentLabel" + "description": "Entity represents file hash in the system.", + "value": "FileHash" }, - "type": "array" - }, - "providerName": { - "description": "The name of the source provider that generated the incident", - "type": "string" - }, - "providerIncidentId": { - "description": "The incident ID assigned by the incident provider", - "type": "string" - }, - "lastActivityTimeUtc": { - "description": "The time of the last activity in the incident", - "format": "date-time", - "type": "string" - }, - "lastModifiedTimeUtc": { - "description": "The last time the incident was updated", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "owner": { - "$ref": "#/definitions/IncidentOwnerInfo", - "description": "Describes a user that the incident is assigned to", - "type": "object" - }, - "relatedAnalyticRuleIds": { - "description": "List of resource ids of Analytic rules related to the incident", - "items": { - "description": "Related Analytic rule resource id", - "type": "string" + { + "description": "Entity represents ip in the system.", + "value": "IP" + }, + { + "description": "Entity represents malware in the system.", + "value": "Malware" + }, + { + "description": "Entity represents process in the system.", + "value": "Process" + }, + { + "description": "Entity represents registry key in the system.", + "value": "RegistryKey" + }, + { + "description": "Entity represents registry value in the system.", + "value": "RegistryValue" + }, + { + "description": "Entity represents security group in the system.", + "value": "SecurityGroup" + }, + { + "description": "Entity represents url in the system.", + "value": "URL" + }, + { + "description": "Entity represents IoT device in the system.", + "value": "IoTDevice" + }, + { + "description": "Entity represents security alert in the system.", + "value": "SecurityAlert" + }, + { + "description": "Entity represents HuntingBookmark in the system.", + "value": "HuntingBookmark" + }, + { + "description": "Entity represents mail cluster in the system.", + "value": "MailCluster" }, - "readOnly": true, - "type": "array" - }, - "severity": { - "$ref": "#/definitions/IncidentSeverity", - "description": "The severity of the incident" - }, - "status": { - "$ref": "#/definitions/IncidentStatus", - "description": "The status of the incident" - }, - "title": { - "description": "The title of the incident", - "type": "string" + { + "description": "Entity represents mail message in the system.", + "value": "MailMessage" + }, + { + "description": "Entity represents mailbox in the system.", + "value": "Mailbox" + }, + { + "description": "Entity represents submission mail in the system.", + "value": "SubmissionMail" + } + ] + } + }, + "EntityKind": { + "description": "Describes an entity with kind.", + "properties": { + "kind": { + "$ref": "#/definitions/EntityInnerKind", + "description": "The kind of the entity." } }, "required": [ - "title", - "severity", - "status" + "kind" ], "type": "object" }, - "IpEntity": { - "allOf": [ - { - "$ref": "#/definitions/Entity" - } - ], - "description": "Represents an ip entity.", + "EntityQueryKind": { + "description": "Describes an Entity query resource with kind.", "properties": { - "properties": { - "$ref": "#/definitions/IpEntityProperties", - "description": "Ip entity properties", - "x-ms-client-flatten": true + "kind": { + "description": "The kind of the entity query", + "enum": [ + "Expansion", + "Insight" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "EntityQueryKind", + "values": [ + { + "value": "Expansion" + }, + { + "value": "Insight" + } + ] + } } }, - "type": "object", - "x-ms-discriminator-value": "Ip" - }, - "IpEntityProperties": { - "allOf": [ - { - "$ref": "#/definitions/EntityCommonProperties" - } + "required": [ + "kind" ], - "description": "Ip entity property bag.", - "properties": { - "address": { - "description": "The IP address as string, e.g. 127.0.0.1 (either in Ipv4 or Ipv6)", - "readOnly": true, - "type": "string" - }, - "location": { - "$ref": "#/definitions/GeoLocation", - "description": "The geo-location context attached to the ip entity" - }, - "threatIntelligence": { - "description": "A list of TI contexts attached to the ip entity.", - "items": { - "$ref": "#/definitions/ThreatIntelligence" - }, - "readOnly": true, - "type": "array" - } - }, "type": "object" }, - "Label": { - "description": "Label that will be used to tag and filter on.", - "type": "string" - }, - "MailboxEntity": { + "EntityQuery": { "allOf": [ { - "$ref": "#/definitions/Entity" - } - ], - "description": "Represents a mailbox entity.", - "properties": { - "properties": { - "$ref": "#/definitions/MailboxEntityProperties", - "description": "Mailbox entity properties", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "Mailbox" - }, - "MailboxEntityProperties": { - "allOf": [ + "$ref": "#/definitions/ResourceWithEtag" + }, { - "$ref": "#/definitions/EntityCommonProperties" + "$ref": "#/definitions/EntityQueryKind" } ], - "description": "Mailbox entity property bag.", - "properties": { - "mailboxPrimaryAddress": { - "description": "The mailbox's primary address", - "readOnly": true, - "type": "string" - }, - "displayName": { - "description": "The mailbox's display name", - "readOnly": true, - "type": "string" - }, - "upn": { - "description": "The mailbox's UPN", - "readOnly": true, - "type": "string" - }, - "externalDirectoryObjectId": { - "description": "The AzureAD identifier of mailbox. Similar to AadUserId in account entity but this property is specific to mailbox object on office side", - "format": "uuid", - "readOnly": true, - "type": "string" - } - }, - "type": "object" + "description": "Specific entity query.", + "discriminator": "kind", + "type": "object", + "required": [ + "kind" + ] }, - "MailClusterEntity": { + "ExpansionEntityQuery": { + "description": "Represents Expansion entity query.", "allOf": [ { - "$ref": "#/definitions/Entity" + "$ref": "#/definitions/EntityQuery" } ], - "description": "Represents a mail cluster entity.", "properties": { "properties": { - "$ref": "#/definitions/MailClusterEntityProperties", - "description": "Mail cluster entity properties", + "$ref": "#/definitions/ExpansionEntityQueriesProperties", + "description": "Expansion entity query properties", "x-ms-client-flatten": true } }, "type": "object", - "x-ms-discriminator-value": "MailCluster" + "x-ms-discriminator-value": "Expansion" }, - "MailClusterEntityProperties": { - "allOf": [ - { - "$ref": "#/definitions/EntityCommonProperties" - } - ], - "description": "Mail cluster entity property bag.", + "EntityQueryList": { + "description": "List of all the entity queries.", "properties": { - "networkMessageIds": { - "description": "The mail message IDs that are part of the mail cluster", - "items": { - "description": "A mail message ID", - "type": "string" - }, - "readOnly": true, - "type": "array" - }, - "countByDeliveryStatus": { - "description": "Count of mail messages by DeliveryStatus string representation", - "readOnly": true, - "type": "object" - }, - "countByThreatType": { - "description": "Count of mail messages by ThreatType string representation", - "readOnly": true, - "type": "object" - }, - "countByProtectionStatus": { - "description": "Count of mail messages by ProtectionStatus string representation", + "nextLink": { + "description": "URL to fetch the next set of entity queries.", "readOnly": true, - "type": "object" + "type": "string" }, - "threats": { - "description": "The threats of mail messages that are part of the mail cluster", + "value": { + "description": "Array of entity queries.", "items": { - "description": "A threat", - "type": "string" + "$ref": "#/definitions/EntityQuery" }, - "readOnly": true, "type": "array" - }, - "query": { - "description": "The query that was used to identify the messages of the mail cluster", - "readOnly": true, - "type": "string" - }, - "queryTime": { - "description": "The query time", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "mailCount": { - "description": "The number of mail messages that are part of the mail cluster", - "readOnly": true, - "type": "integer", - "format": "int32" - }, - "isVolumeAnomaly": { - "description": "Is this a volume anomaly mail cluster", - "readOnly": true, - "type": "boolean" - }, - "source": { - "description": "The source of the mail cluster (default is 'O365 ATP')", - "readOnly": true, - "type": "string" - }, - "clusterSourceIdentifier": { - "description": "The id of the cluster source", - "readOnly": true, - "type": "string" - }, - "clusterSourceType": { - "description": "The type of the cluster source", - "readOnly": true, + } + }, + "required": [ + "value" + ] + }, + "ExpansionResultAggregation": { + "description": "Information of a specific aggregation in the expansion result.", + "properties": { + "aggregationType": { + "description": "The common type of the aggregation. (for e.g. entity field name)", "type": "string" }, - "clusterQueryStartTime": { - "description": "The cluster query start time", - "format": "date-time", - "readOnly": true, - "type": "string" + "count": { + "description": "Total number of aggregations of the given kind (and aggregationType if given) in the expansion result.", + "type": "integer" }, - "clusterQueryEndTime": { - "description": "The cluster query end time", - "format": "date-time", - "readOnly": true, + "displayName": { + "description": "The display name of the aggregation by type.", "type": "string" }, - "clusterGroup": { - "description": "The cluster group", - "readOnly": true, - "type": "string" + "entityKind": { + "$ref": "#/definitions/EntityInnerKind", + "description": "The kind of the aggregated entity." } }, + "required": [ + "entityKind", + "count" + ], "type": "object" }, - "MailMessageEntity": { - "allOf": [ - { - "$ref": "#/definitions/Entity" - } - ], - "description": "Represents a mail message entity.", + "ExpansionResultsMetadata": { + "description": "Expansion result metadata.", "properties": { - "properties": { - "$ref": "#/definitions/MailMessageEntityProperties", - "description": "Mail message entity properties", - "x-ms-client-flatten": true + "aggregations": { + "description": "Information of the aggregated nodes in the expansion result.", + "items": { + "$ref": "#/definitions/ExpansionResultAggregation" + }, + "type": "array" } }, - "type": "object", - "x-ms-discriminator-value": "MailMessage" + "type": "object" }, - "MailMessageEntityProperties": { - "allOf": [ - { - "$ref": "#/definitions/EntityCommonProperties" - } - ], - "description": "Mail message entity property bag.", + "ExpansionEntityQueriesProperties": { + "description": "Describes expansion entity query properties", "properties": { - "fileEntityIds": { - "description": "The File entity ids of this mail message's attachments", + "dataSources": { + "description": "List of the data sources that are required to run the query", "items": { + "description": "data source", "type": "string" }, - "readOnly": true, "type": "array" }, - "recipient": { - "description": "The recipient of this mail message. Note that in case of multiple recipients the mail message is forked and each copy has one recipient", - "readOnly": true, + "displayName": { + "description": "The query display name", "type": "string" }, - "urls": { - "description": "The Urls contained in this mail message", + "inputEntityType": { + "$ref": "#/definitions/EntityInnerType", + "description": "The type of the query's source entity" + }, + "inputFields": { + "description": "List of the fields of the source entity that are required to run the query", "items": { - "description": "A Url contained in this mail message", + "description": "input field", "type": "string" }, - "readOnly": true, "type": "array" }, - "threats": { - "description": "The threats of this mail message", + "outputEntityTypes": { + "description": "List of the desired output types to be constructed from the result", "items": { - "description": "A threat of the mail message", - "type": "string" + "$ref": "#/definitions/EntityInnerType", + "description": "output entity type" }, - "readOnly": true, "type": "array" }, - "p1Sender": { - "description": "The p1 sender's email address", - "readOnly": true, - "type": "string" - }, - "p1SenderDisplayName": { - "description": "The p1 sender's display name", - "readOnly": true, - "type": "string" - }, - "p1SenderDomain": { - "description": "The p1 sender's domain", - "readOnly": true, - "type": "string" - }, - "senderIP": { - "description": "The sender's IP address", - "readOnly": true, - "type": "string" - }, - "p2Sender": { - "description": "The p2 sender's email address", - "readOnly": true, - "type": "string" - }, - "p2SenderDisplayName": { - "description": "The p2 sender's display name", - "readOnly": true, - "type": "string" - }, - "p2SenderDomain": { - "description": "The p2 sender's domain", - "readOnly": true, - "type": "string" - }, - "receiveDate": { - "description": "The receive date of this message", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "networkMessageId": { - "description": "The network message id of this mail message", - "format": "uuid", - "readOnly": true, - "type": "string" - }, - "internetMessageId": { - "description": "The internet message id of this mail message", - "readOnly": true, + "queryTemplate": { + "description": "The template query string to be parsed and formatted", "type": "string" - }, - "subject": { - "description": "The subject of this mail message", - "readOnly": true, + } + }, + "type": "object" + }, + "ConnectedEntity": { + "description": "Expansion result connected entities", + "properties": { + "targetEntityId": { + "description": "Entity Id of the connected entity", "type": "string" }, - "language": { - "description": "The language of this mail message", + "additionalData": { + "description": "key-value pairs for a connected entity mapping", + "type": "object" + } + } + }, + "FileEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a file entity.", + "properties": { + "properties": { + "$ref": "#/definitions/FileEntityProperties", + "description": "File entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "File" + }, + "FileEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "File entity property bag.", + "properties": { + "directory": { + "description": "The full path to the file.", "readOnly": true, "type": "string" }, - "threatDetectionMethods": { - "description": "The threat detection methods", + "fileHashEntityIds": { + "description": "The file hash entity identifiers associated with this file", "items": { - "description": "A threat detection method", + "description": "file hash id", "type": "string" }, "readOnly": true, - "type": "array" - }, - "bodyFingerprintBin1": { - "description": "The bodyFingerprintBin1", - "type": "integer", - "format": "int32" - }, - "bodyFingerprintBin2": { - "description": "The bodyFingerprintBin2", - "type": "integer", - "format": "int32" - }, - "bodyFingerprintBin3": { - "description": "The bodyFingerprintBin3", - "type": "integer", - "format": "int32" - }, - "bodyFingerprintBin4": { - "description": "The bodyFingerprintBin4", - "type": "integer", - "format": "int32" - }, - "bodyFingerprintBin5": { - "description": "The bodyFingerprintBin5", - "type": "integer", - "format": "int32" - }, - "antispamDirection": { - "description": "The directionality of this mail message", - "enum": [ - "Unknown", - "Inbound", - "Outbound", - "Intraorg" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "AntispamMailDirection", - "values": [ - { - "description": "Unknown", - "value": "Unknown" - }, - { - "description": "Inbound", - "value": "Inbound" - }, - { - "description": "Outbound", - "value": "Outbound" - }, - { - "description": "Intraorg", - "value": "Intraorg" - } - ] - } + "type": "array" }, - "deliveryAction": { - "description": "The delivery action of this mail message like Delivered, Blocked, Replaced etc", - "enum": [ - "Unknown", - "DeliveredAsSpam", - "Delivered", - "Blocked", - "Replaced" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": false, - "name": "DeliveryAction", - "values": [ - { - "description": "Unknown", - "value": "Unknown" - }, - { - "description": "DeliveredAsSpam", - "value": "DeliveredAsSpam" - }, - { - "description": "Delivered", - "value": "Delivered" - }, - { - "description": "Blocked", - "value": "Blocked" - }, - { - "description": "Replaced", - "value": "Replaced" - } - ] - } + "fileName": { + "description": "The file name without path (some alerts might not include path).", + "readOnly": true, + "type": "string" }, - "deliveryLocation": { - "description": "The delivery location of this mail message like Inbox, JunkFolder etc", + "hostEntityId": { + "description": "The Host entity id which the file belongs to", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "FileHashEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a file hash entity.", + "properties": { + "properties": { + "$ref": "#/definitions/FileHashEntityProperties", + "description": "FileHash entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "FileHash" + }, + "FileHashEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "FileHash entity property bag.", + "properties": { + "algorithm": { + "description": "The hash algorithm type.", "enum": [ "Unknown", - "Inbox", - "JunkFolder", - "DeletedFolder", - "Quarantine", - "External", - "Failed", - "Dropped", - "Forwarded" + "MD5", + "SHA1", + "SHA256", + "SHA256AC" ], + "readOnly": true, "type": "string", "x-ms-enum": { - "modelAsString": false, - "name": "DeliveryLocation", + "modelAsString": true, + "name": "FileHashAlgorithm", "values": [ { - "description": "Unknown", + "description": "Unknown hash algorithm", "value": "Unknown" }, { - "description": "Inbox", - "value": "Inbox" - }, - { - "description": "JunkFolder", - "value": "JunkFolder" - }, - { - "description": "DeletedFolder", - "value": "DeletedFolder" - }, - { - "description": "Quarantine", - "value": "Quarantine" - }, - { - "description": "External", - "value": "External" + "description": "MD5 hash type", + "value": "MD5" }, { - "description": "Failed", - "value": "Failed" + "description": "SHA1 hash type", + "value": "SHA1" }, { - "description": "Dropped", - "value": "Dropped" + "description": "SHA256 hash type", + "value": "SHA256" }, { - "description": "Forwarded", - "value": "Forwarded" + "description": "SHA256 Authenticode hash type", + "value": "SHA256AC" } ] } + }, + "hashValue": { + "description": "The file hash value.", + "readOnly": true, + "type": "string" } }, "type": "object" }, - "SubmissionMailEntity": { + "FusionAlertRule": { "allOf": [ { - "$ref": "#/definitions/Entity" + "$ref": "#/definitions/AlertRule" } ], - "description": "Represents a submission mail entity.", + "description": "Represents Fusion alert rule.", "properties": { "properties": { - "$ref": "#/definitions/SubmissionMailEntityProperties", - "description": "Submission mail entity properties", + "$ref": "#/definitions/FusionAlertRuleProperties", + "description": "Fusion alert rule properties", "x-ms-client-flatten": true } }, "type": "object", - "x-ms-discriminator-value": "SubmissionMail" + "x-ms-discriminator-value": "Fusion" }, - "SubmissionMailEntityProperties": { - "allOf": [ - { - "$ref": "#/definitions/EntityCommonProperties" - } - ], - "description": "Submission mail entity property bag.", + "FusionAlertRuleProperties": { + "description": "Fusion alert rule base property bag.", "properties": { - "networkMessageId": { - "description": "The network message id of email to which submission belongs", - "format": "uuid", - "readOnly": true, + "alertRuleTemplateName": { + "description": "The Name of the alert rule template used to create this rule.", "type": "string" }, - "submissionId": { - "description": "The submission id", - "format": "uuid", + "description": { + "description": "The description of the alert rule.", "readOnly": true, "type": "string" }, - "submitter": { - "description": "The submitter", + "displayName": { + "description": "The display name for alerts created by this alert rule.", "readOnly": true, "type": "string" }, - "submissionDate": { - "description": "The submission date", + "enabled": { + "description": "Determines whether this alert rule is enabled or disabled.", + "type": "boolean" + }, + "lastModifiedUtc": { + "description": "The last time that this alert has been modified.", "format": "date-time", "readOnly": true, "type": "string" }, - "timestamp": { - "description": "The Time stamp when the message is received (Mail)", - "format": "date-time", + "severity": { + "$ref": "#/definitions/AlertSeverity", + "description": "The severity for alerts created by this alert rule.", + "readOnly": true + }, + "tactics": { + "description": "The tactics of the alert rule", + "items": { + "$ref": "#/definitions/AttackTactic" + }, + "readOnly": true, + "type": "array" + } + }, + "required": [ + "alertRuleTemplateName", + "enabled" + ], + "type": "object" + }, + "FusionAlertRuleTemplate": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplate" + } + ], + "description": "Represents Fusion alert rule template.", + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplatePropertiesBase" + } + ], + "description": "Fusion alert rule template properties", + "properties": { + "severity": { + "$ref": "#/definitions/AlertSeverity", + "description": "The severity for alerts created by this alert rule." + }, + "tactics": { + "description": "The tactics of the alert rule template", + "items": { + "$ref": "#/definitions/AttackTactic" + }, + "type": "array" + } + }, + "required": [ + "displayName", + "description", + "status", + "severity", + "alertRulesCreatedByTemplateCount" + ], + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Fusion" + }, + "ThreatIntelligenceAlertRule": { + "allOf": [ + { + "$ref": "#/definitions/AlertRule" + } + ], + "description": "Represents Threat Intelligence alert rule.", + "properties": { + "properties": { + "$ref": "#/definitions/ThreatIntelligenceAlertRuleProperties", + "description": "Threat Intelligence alert rule properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "ThreatIntelligence" + }, + "ThreatIntelligenceAlertRuleProperties": { + "description": "Threat Intelligence alert rule base property bag.", + "properties": { + "alertRuleTemplateName": { + "description": "The Name of the alert rule template used to create this rule.", + "type": "string" + }, + "description": { + "description": "The description of the alert rule.", "readOnly": true, "type": "string" }, - "recipient": { - "description": "The recipient of the mail", + "displayName": { + "description": "The display name for alerts created by this alert rule.", "readOnly": true, "type": "string" }, - "sender": { - "description": "The sender of the mail", - "readOnly": true, - "type": "string" + "enabled": { + "description": "Determines whether this alert rule is enabled or disabled.", + "type": "boolean" }, - "senderIp": { - "description": "The sender's IP", + "lastModifiedUtc": { + "description": "The last time that this alert has been modified.", + "format": "date-time", "readOnly": true, "type": "string" }, - "subject": { - "description": "The subject of submission mail", - "readOnly": true, - "type": "string" + "severity": { + "$ref": "#/definitions/AlertSeverity", + "description": "The severity for alerts created by this alert rule.", + "readOnly": true }, - "reportType": { - "description": "The submission type for the given instance. This maps to Junk, Phish, Malware or NotJunk.", + "tactics": { + "description": "The tactics of the alert rule", + "items": { + "$ref": "#/definitions/AttackTactic" + }, "readOnly": true, - "type": "string" + "type": "array" } }, + "required": [ + "alertRuleTemplateName", + "enabled" + ], "type": "object" }, - "MCASDataConnector": { + "ThreatIntelligenceAlertRuleTemplate": { "allOf": [ { - "$ref": "#/definitions/DataConnector" + "$ref": "#/definitions/AlertRuleTemplate" } ], - "description": "Represents MCAS (Microsoft Cloud App Security) data connector.", + "description": "Represents Threat Intelligence alert rule template.", "properties": { "properties": { - "$ref": "#/definitions/MCASDataConnectorProperties", - "description": "MCAS (Microsoft Cloud App Security) data connector properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "MicrosoftCloudAppSecurity" - }, - "MCASDataConnectorDataTypes": { - "allOf": [ - { - "$ref": "#/definitions/AlertsDataTypeOfDataConnector" - } - ], - "description": "The available data types for MCAS (Microsoft Cloud App Security) data connector.", - "properties": { - "discoveryLogs": { "allOf": [ { - "$ref": "#/definitions/DataConnectorDataTypeCommon" + "$ref": "#/definitions/AlertRuleTemplatePropertiesBase" } ], - "description": "Discovery log data type connection.", - "type": "object" + "description": "Threat Intelligence alert rule template properties", + "properties": { + "severity": { + "$ref": "#/definitions/AlertSeverity", + "description": "The severity for alerts created by this alert rule." + }, + "tactics": { + "description": "The tactics of the alert rule template", + "items": { + "$ref": "#/definitions/AttackTactic" + }, + "type": "array" + } + }, + "required": [ + "displayName", + "description", + "status", + "severity", + "alertRulesCreatedByTemplateCount" + ], + "x-ms-client-flatten": true } }, - "type": "object" + "type": "object", + "x-ms-discriminator-value": "ThreatIntelligence" }, - "MCASDataConnectorProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" - } - ], - "description": "MCAS (Microsoft Cloud App Security) data connector properties.", + "GeoLocation": { + "description": "The geo-location context attached to the ip entity", "properties": { - "dataTypes": { - "$ref": "#/definitions/MCASDataConnectorDataTypes", - "description": "The available data types for the connector." + "asn": { + "description": "Autonomous System Number", + "readOnly": true, + "type": "integer" + }, + "city": { + "description": "City name", + "readOnly": true, + "type": "string" + }, + "countryCode": { + "description": "The country code according to ISO 3166 format", + "readOnly": true, + "type": "string" + }, + "countryName": { + "description": "Country name according to ISO 3166 Alpha 2: the lowercase of the English Short Name", + "readOnly": true, + "type": "string" + }, + "latitude": { + "description": "The longitude of the identified location, expressed as a floating point number with range of -180 to 180, with positive numbers representing East and negative numbers representing West. Latitude and longitude are derived from the city or postal code.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "longitude": { + "description": "The latitude of the identified location, expressed as a floating point number with range of - 90 to 90, with positive numbers representing North and negative numbers representing South. Latitude and longitude are derived from the city or postal code.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "state": { + "description": "State name", + "readOnly": true, + "type": "string" } }, - "required": [ - "dataTypes" - ], + "readOnly": true, "type": "object" }, - "MCASCheckRequirements": { + "HostEntity": { "allOf": [ { - "$ref": "#/definitions/DataConnectorsCheckRequirements" + "$ref": "#/definitions/Entity" } ], - "description": "Represents MCAS (Microsoft Cloud App Security) requirements check request.", + "description": "Represents a host entity.", "properties": { "properties": { - "$ref": "#/definitions/MCASCheckRequirementsProperties", - "description": "MCAS (Microsoft Cloud App Security) requirements check properties.", + "$ref": "#/definitions/HostEntityProperties", + "description": "Host entity properties", "x-ms-client-flatten": true } }, "type": "object", - "x-ms-discriminator-value": "MicrosoftCloudAppSecurity" - }, - "MCASCheckRequirementsProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" - } - ], - "description": "MCAS (Microsoft Cloud App Security) requirements check properties.", - "type": "object" + "x-ms-discriminator-value": "Host" }, - "MDATPDataConnector": { + "HostEntityProperties": { "allOf": [ { - "$ref": "#/definitions/DataConnector" + "$ref": "#/definitions/EntityCommonProperties" } ], - "description": "Represents MDATP (Microsoft Defender Advanced Threat Protection) data connector.", + "description": "Host entity property bag.", "properties": { - "properties": { - "$ref": "#/definitions/MDATPDataConnectorProperties", - "description": "MDATP (Microsoft Defender Advanced Threat Protection) data connector properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "MicrosoftDefenderAdvancedThreatProtection" - }, - "MDATPDataConnectorProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" + "azureID": { + "description": "The azure resource id of the VM.", + "readOnly": true, + "type": "string" + }, + "dnsDomain": { + "description": "The DNS domain that this host belongs to. Should contain the compete DNS suffix for the domain", + "readOnly": true, + "type": "string" + }, + "hostName": { + "description": "The hostname without the domain suffix.", + "readOnly": true, + "type": "string" + }, + "isDomainJoined": { + "description": "Determines whether this host belongs to a domain.", + "readOnly": true, + "type": "boolean" + }, + "netBiosName": { + "description": "The host name (pre-windows2000).", + "readOnly": true, + "type": "string" + }, + "ntDomain": { + "description": "The NT domain that this host belongs to.", + "readOnly": true, + "type": "string" + }, + "omsAgentID": { + "description": "The OMS agent id, if the host has OMS agent installed.", + "readOnly": true, + "type": "string" + }, + "osFamily": { + "description": "The operating system type.", + "enum": [ + "Linux", + "Windows", + "Android", + "IOS", + "Unknown" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": false, + "name": "OSFamily", + "values": [ + { + "description": "Host with Linux operating system.", + "value": "Linux" + }, + { + "description": "Host with Windows operating system.", + "value": "Windows" + }, + { + "description": "Host with Android operating system.", + "value": "Android" + }, + { + "description": "Host with IOS operating system.", + "value": "IOS" + }, + { + "description": "Host with Unknown operating system.", + "value": "Unknown" + } + ] + } }, - { - "$ref": "#/definitions/DataConnectorWithAlertsProperties" + "osVersion": { + "description": "A free text representation of the operating system. This field is meant to hold specific versions the are more fine grained than OSFamily or future values not supported by OSFamily enumeration", + "readOnly": true, + "type": "string" } - ], - "description": "MDATP (Microsoft Defender Advanced Threat Protection) data connector properties.", + }, "type": "object" }, - "MDATPCheckRequirements": { + "Incident": { "allOf": [ { - "$ref": "#/definitions/DataConnectorsCheckRequirements" + "$ref": "#/definitions/ResourceWithEtag" } ], - "description": "Represents MDATP (Microsoft Defender Advanced Threat Protection) requirements check request.", + "description": "Represents an incident in Azure Security Insights.", "properties": { "properties": { - "$ref": "#/definitions/MDATPCheckRequirementsProperties", - "description": "MDATP (Microsoft Defender Advanced Threat Protection) requirements check properties.", + "$ref": "#/definitions/IncidentProperties", + "description": "Incident properties", "x-ms-client-flatten": true } }, - "type": "object", - "x-ms-discriminator-value": "MicrosoftDefenderAdvancedThreatProtection" - }, - "MDATPCheckRequirementsProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" - } - ], - "description": "MDATP (Microsoft Defender Advanced Threat Protection) requirements check properties.", "type": "object" }, - "MalwareEntity": { + "HuntingBookmark": { "allOf": [ { "$ref": "#/definitions/Entity" } ], - "description": "Represents a malware entity.", + "description": "Represents a Hunting bookmark entity.", "properties": { "properties": { - "$ref": "#/definitions/MalwareEntityProperties", - "description": "File entity properties", + "$ref": "#/definitions/HuntingBookmarkProperties", + "description": "HuntingBookmark entity properties", "x-ms-client-flatten": true } }, "type": "object", - "x-ms-discriminator-value": "Malware" + "x-ms-discriminator-value": "Bookmark" }, - "MalwareEntityProperties": { + "HuntingBookmarkProperties": { "allOf": [ { "$ref": "#/definitions/EntityCommonProperties" } ], - "description": "Malware entity property bag.", + "description": "Describes bookmark properties", "properties": { - "category": { - "description": "The malware category by the vendor, e.g. Trojan", - "readOnly": true, + "created": { + "description": "The time the bookmark was created", + "format": "date-time", "type": "string" }, - "fileEntityIds": { - "description": "List of linked file entity identifiers on which the malware was found", - "items": { - "description": "file entity id", - "type": "string" - }, - "readOnly": true, - "type": "array" + "createdBy": { + "$ref": "#/definitions/UserInfo", + "description": "Describes a user that created the bookmark", + "type": "object" }, - "malwareName": { - "description": "The malware name by the vendor, e.g. Win32/Toga!rfn", - "readOnly": true, + "displayName": { + "description": "The display name of the bookmark", "type": "string" }, - "processEntityIds": { - "description": "List of linked process entity identifiers on which the malware was found.", - "items": { - "description": "process entity id", - "type": "string" - }, - "readOnly": true, - "type": "array" - } - }, - "type": "object" - }, - "MicrosoftSecurityIncidentCreationAlertRule": { - "allOf": [ - { - "$ref": "#/definitions/AlertRule" - } - ], - "description": "Represents MicrosoftSecurityIncidentCreation rule.", - "properties": { - "properties": { - "$ref": "#/definitions/MicrosoftSecurityIncidentCreationAlertRuleProperties", - "description": "MicrosoftSecurityIncidentCreation rule properties", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "MicrosoftSecurityIncidentCreation" - }, - "MicrosoftSecurityIncidentCreationAlertRuleCommonProperties": { - "description": "MicrosoftSecurityIncidentCreation rule common property bag.", - "properties": { - "displayNamesFilter": { - "description": "the alerts' displayNames on which the cases will be generated", - "items": { - "type": "string" - }, - "type": "array" + "eventTime": { + "description": "The time of the event", + "format": "date-time", + "type": "string" }, - "displayNamesExcludeFilter": { - "description": "the alerts' displayNames on which the cases will not be generated", + "labels": { + "description": "List of labels relevant to this bookmark", "items": { - "type": "string" + "$ref": "#/definitions/Label" }, "type": "array" }, - "productFilter": { - "description": "The alerts' productName on which the cases will be generated", - "enum": [ - "Microsoft Cloud App Security", - "Azure Security Center", - "Azure Advanced Threat Protection", - "Azure Active Directory Identity Protection", - "Azure Security Center for IoT", - "Office 365 Advanced Threat Protection", - "Microsoft Defender Advanced Threat Protection" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "MicrosoftSecurityProductName" - } - }, - "severitiesFilter": { - "description": "the alerts' severities on which the cases will be generated", - "items": { - "$ref": "#/definitions/AlertSeverity" - }, - "type": "array" - } - }, - "required": [ - "productFilter" - ], - "type": "object" - }, - "MicrosoftSecurityIncidentCreationAlertRuleProperties": { - "allOf": [ - { - "$ref": "#/definitions/MicrosoftSecurityIncidentCreationAlertRuleCommonProperties" - } - ], - "description": "MicrosoftSecurityIncidentCreation rule property bag.", - "properties": { - "alertRuleTemplateName": { - "description": "The Name of the alert rule template used to create this rule.", + "notes": { + "description": "The notes of the bookmark", "type": "string" }, - "description": { - "description": "The description of the alert rule.", + "query": { + "description": "The query of the bookmark.", "type": "string" }, - "displayName": { - "description": "The display name for alerts created by this alert rule.", + "queryResult": { + "description": "The query result of the bookmark.", "type": "string" }, - "enabled": { - "description": "Determines whether this alert rule is enabled or disabled.", - "type": "boolean" - }, - "lastModifiedUtc": { - "description": "The last time that this alert has been modified.", + "updated": { + "description": "The last time the bookmark was updated", "format": "date-time", - "readOnly": true, "type": "string" + }, + "updatedBy": { + "$ref": "#/definitions/UserInfo", + "description": "Describes a user that updated the bookmark", + "type": "object" + }, + "incidentInfo": { + "$ref": "#/definitions/IncidentInfo", + "description": "Describes an incident that relates to bookmark", + "type": "object" } }, "required": [ "displayName", - "enabled", - "productFilter" + "query" ], "type": "object" }, - "MicrosoftSecurityIncidentCreationAlertRuleTemplate": { - "allOf": [ - { - "$ref": "#/definitions/AlertRuleTemplate" - } - ], - "description": "Represents MicrosoftSecurityIncidentCreation rule template.", - "properties": { - "properties": { - "allOf": [ - { - "$ref": "#/definitions/AlertRuleTemplatePropertiesBase" - }, - { - "$ref": "#/definitions/MicrosoftSecurityIncidentCreationAlertRuleCommonProperties" - } - ], - "description": "MicrosoftSecurityIncidentCreation rule template properties", - "required": [ - "displayName", - "description", - "createdDateUTC", - "status", - "alertRulesCreatedByTemplateCount", - "productFilter" - ], - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "MicrosoftSecurityIncidentCreation" - }, - "OfficeATPDataConnector": { - "allOf": [ - { - "$ref": "#/definitions/DataConnector" - } - ], - "description": "Represents OfficeATP (Office 365 Advanced Threat Protection) data connector.", + "IncidentAdditionalData": { + "description": "Incident additional data property bag.", "properties": { - "properties": { - "$ref": "#/definitions/OfficeATPDataConnectorProperties", - "description": "OfficeATP (Office 365 Advanced Threat Protection) data connector properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "OfficeATP" - }, - "OfficeATPDataConnectorProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" + "alertsCount": { + "description": "The number of alerts in the incident", + "readOnly": true, + "type": "integer" + }, + "bookmarksCount": { + "description": "The number of bookmarks in the incident", + "readOnly": true, + "type": "integer" + }, + "commentsCount": { + "description": "The number of comments in the incident", + "readOnly": true, + "type": "integer" + }, + "alertProductNames": { + "description": "List of product names of alerts in the incident", + "items": { + "description": "Alert product name", + "type": "string" + }, + "readOnly": true, + "type": "array" }, - { - "$ref": "#/definitions/DataConnectorWithAlertsProperties" + "tactics": { + "description": "The tactics associated with incident", + "items": { + "$ref": "#/definitions/AttackTactic" + }, + "readOnly": true, + "type": "array" } - ], - "description": "OfficeATP (Office 365 Advanced Threat Protection) data connector properties.", + }, "type": "object" }, - "OfficeATPCheckRequirements": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorsCheckRequirements" - } - ], - "description": "Represents OfficeATP (Office 365 Advanced Threat Protection) requirements check request.", + "IncidentAlertList": { + "description": "List of incident alerts.", "properties": { - "properties": { - "$ref": "#/definitions/OfficeATPCheckRequirementsProperties", - "description": "OfficeATP (Office 365 Advanced Threat Protection) requirements check properties.", - "x-ms-client-flatten": true + "value": { + "description": "Array of incident alerts.", + "type": "array", + "items": { + "$ref": "#/definitions/SecurityAlert" + } } }, "type": "object", - "x-ms-discriminator-value": "OfficeATP" + "required": [ + "value" + ] }, - "OfficeATPCheckRequirementsProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" + "IncidentBookmarkList": { + "description": "List of incident bookmarks.", + "properties": { + "value": { + "description": "Array of incident bookmarks.", + "type": "array", + "items": { + "$ref": "#/definitions/HuntingBookmark" + } } - ], - "description": "OfficeATP (Office 365 Advanced Threat Protection) requirements check properties.", - "type": "object" + }, + "type": "object", + "required": [ + "value" + ] }, - "OfficeConsent": { + "IncidentComment": { "allOf": [ { - "$ref": "#/definitions/Resource" + "$ref": "#/definitions/ResourceWithEtag" } ], - "description": "Consent for Office365 tenant that already made.", + "description": "Represents an incident comment", "properties": { "properties": { - "$ref": "#/definitions/OfficeConsentProperties", - "description": "Office consent properties", + "$ref": "#/definitions/IncidentCommentProperties", + "description": "Incident comment properties", "x-ms-client-flatten": true } }, "type": "object" }, - "OfficeConsentList": { - "description": "List of all the office365 consents.", + "IncidentCommentList": { + "description": "List of incident comments.", "properties": { "nextLink": { - "description": "URL to fetch the next set of office consents.", + "description": "URL to fetch the next set of comments.", "readOnly": true, "type": "string" }, "value": { - "description": "Array of the consents.", + "description": "Array of comments.", "items": { - "$ref": "#/definitions/OfficeConsent" + "$ref": "#/definitions/IncidentComment" }, "type": "array" } }, + "type": "object", "required": [ "value" ] }, - "OfficeConsentProperties": { - "description": "Consent property bag.", + "IncidentCommentProperties": { + "description": "Incident comment property bag.", "properties": { - "tenantId": { - "description": "The tenantId of the Office365 with the consent.", + "createdTimeUtc": { + "description": "The time the comment was created", + "format": "date-time", + "readOnly": true, "type": "string" }, - "consentId": { - "description": "Help to easily cascade among the data layers.", + "lastModifiedTimeUtc": { + "description": "The time the comment was updated", + "format": "date-time", + "readOnly": true, "type": "string" - } - }, - "type": "object" - }, - "OfficeDataConnector": { - "allOf": [ - { - "$ref": "#/definitions/DataConnector" - } - ], - "description": "Represents office data connector.", - "properties": { - "properties": { - "$ref": "#/definitions/OfficeDataConnectorProperties", - "description": "Office data connector properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "Office365" - }, - "OfficeDataConnectorDataTypes": { - "description": "The available data types for office data connector.", - "properties": { - "exchange": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorDataTypeCommon" - } - ], - "description": "Exchange data type connection.", - "type": "object" }, - "sharePoint": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorDataTypeCommon" - } - ], - "description": "SharePoint data type connection.", - "type": "object" + "message": { + "description": "The comment message", + "type": "string" }, - "teams": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorDataTypeCommon" - } - ], - "description": "Teams data type connection.", + "author": { + "$ref": "#/definitions/ClientInfo", + "description": "Describes the client that created the comment", + "readOnly": true, "type": "object" } }, - "type": "object", - "required": [ - "exchange", - "sharePoint", - "teams" - ] - }, - "OfficeDataConnectorProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" - } - ], - "description": "Office data connector properties.", - "properties": { - "dataTypes": { - "$ref": "#/definitions/OfficeDataConnectorDataTypes", - "description": "The available data types for the connector." - } - }, "required": [ - "dataTypes" + "message" ], "type": "object" }, - "Operation": { - "description": "Operation provided by provider", + "IncidentEntitiesResponse": { + "description": "The incident related entities response.", + "type": "object", "properties": { - "display": { - "description": "Properties of the operation", - "properties": { - "description": { - "description": "Description of the operation", - "type": "string" - }, - "operation": { - "description": "Operation name", - "type": "string" - }, - "provider": { - "description": "Provider name", - "type": "string" - }, - "resource": { - "description": "Resource name", - "type": "string" - } - }, - "type": "object" - }, - "name": { - "description": "Name of the operation", - "type": "string" + "entities": { + "description": "Array of the incident related entities.", + "type": "array", + "items": { + "$ref": "#/definitions/Entity" + } }, - "origin": { - "description": "The origin of the operation", - "type": "string" + "metaData": { + "description": "The metadata from the incident related entities results.", + "type": "array", + "items": { + "$ref": "#/definitions/IncidentEntitiesResultsMetadata" + } } } }, - "OperationsList": { - "description": "Lists the operations available in the SecurityInsights RP.", + "IncidentEntitiesResultsMetadata": { + "description": "Information of a specific aggregation in the incident related entities result.", "properties": { - "nextLink": { - "description": "URL to fetch the next set of operations.", - "type": "string" + "count": { + "description": "Total number of aggregations of the given kind in the incident related entities result.", + "type": "integer", + "format": "int32" }, - "value": { - "description": "Array of operations", - "items": { - "$ref": "#/definitions/Operation" - }, - "type": "array" + "entityKind": { + "$ref": "#/definitions/EntityInnerKind", + "description": "The kind of the aggregated entity." } }, "required": [ - "value" - ] - }, - "ProcessEntity": { - "allOf": [ - { - "$ref": "#/definitions/Entity" - } - ], - "description": "Represents a process entity.", - "properties": { - "properties": { - "$ref": "#/definitions/ProcessEntityProperties", - "description": "Process entity properties", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "Process" - }, - "ProcessEntityProperties": { - "allOf": [ - { - "$ref": "#/definitions/EntityCommonProperties" - } - ], - "description": "Process entity property bag.", - "properties": { - "accountEntityId": { - "description": "The account entity id running the processes.", - "readOnly": true, - "type": "string" - }, - "commandLine": { - "description": "The command line used to create the process", - "readOnly": true, - "type": "string" - }, - "creationTimeUtc": { - "description": "The time when the process started to run", - "format": "date-time", - "readOnly": true, + "entityKind", + "count" + ], + "type": "object" + }, + "IncidentLabel": { + "description": "Represents an incident label", + "properties": { + "labelName": { + "description": "The name of the label", "type": "string" }, - "elevationToken": { - "description": "The elevation token associated with the process.", + "labelType": { + "description": "The type of the label", "enum": [ - "Default", - "Full", - "Limited" + "User", + "System" ], "type": "string", + "readOnly": true, "x-ms-enum": { - "modelAsString": false, - "name": "ElevationToken", + "modelAsString": true, + "name": "IncidentLabelType", "values": [ { - "description": "Default elevation token", - "value": "Default" - }, - { - "description": "Full elevation token", - "value": "Full" + "description": "Label manually created by a user", + "value": "User" }, { - "description": "Limited elevation token", - "value": "Limited" + "description": "Label automatically created by the system", + "value": "System" } ] } - }, - "hostEntityId": { - "description": "The host entity id on which the process was running", + } + }, + "required": [ + "labelName" + ], + "type": "object" + }, + "IncidentList": { + "description": "List all the incidents.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of incidents.", "readOnly": true, "type": "string" }, - "hostLogonSessionEntityId": { - "description": "The session entity id in which the process was running", - "readOnly": true, + "value": { + "description": "Array of incidents.", + "items": { + "$ref": "#/definitions/Incident" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "IncidentOwnerInfo": { + "description": "Information on the user an incident is assigned to", + "properties": { + "email": { + "description": "The email of the user the incident is assigned to.", "type": "string" }, - "imageFileEntityId": { - "description": "Image file entity id", - "readOnly": true, + "assignedTo": { + "description": "The name of the user the incident is assigned to.", "type": "string" }, - "parentProcessEntityId": { - "description": "The parent process entity id.", - "readOnly": true, + "objectId": { + "description": "The object id of the user the incident is assigned to.", + "format": "uuid", "type": "string" }, - "processId": { - "description": "The process ID", - "readOnly": true, + "userPrincipalName": { + "description": "The user principal name of the user the incident is assigned to.", "type": "string" } }, "type": "object" }, - "RegistryKeyEntity": { - "allOf": [ - { - "$ref": "#/definitions/Entity" - } + "IncidentClassification": { + "description": "The reason the incident was closed", + "enum": [ + "Undetermined", + "TruePositive", + "BenignPositive", + "FalsePositive" ], - "description": "Represents a registry key entity.", - "properties": { - "properties": { - "$ref": "#/definitions/RegistryKeyEntityProperties", - "description": "RegistryKey entity properties", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "RegistryKey" + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "IncidentClassification", + "values": [ + { + "description": "Incident classification was undetermined", + "value": "Undetermined" + }, + { + "description": "Incident was true positive", + "value": "TruePositive" + }, + { + "description": "Incident was benign positive", + "value": "BenignPositive" + }, + { + "description": "Incident was false positive", + "value": "FalsePositive" + } + ] + } }, - "RegistryKeyEntityProperties": { - "allOf": [ - { - "$ref": "#/definitions/EntityCommonProperties" - } + "IncidentClassificationReason": { + "description": "The classification reason the incident was closed with", + "enum": [ + "SuspiciousActivity", + "SuspiciousButExpected", + "IncorrectAlertLogic", + "InaccurateData" ], - "description": "RegistryKey entity property bag.", - "properties": { - "hive": { - "description": "the hive that holds the registry key.", - "enum": [ - "HKEY_LOCAL_MACHINE", - "HKEY_CLASSES_ROOT", - "HKEY_CURRENT_CONFIG", - "HKEY_USERS", - "HKEY_CURRENT_USER_LOCAL_SETTINGS", - "HKEY_PERFORMANCE_DATA", - "HKEY_PERFORMANCE_NLSTEXT", - "HKEY_PERFORMANCE_TEXT", - "HKEY_A", - "HKEY_CURRENT_USER" - ], - "readOnly": true, - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "RegistryHive", - "values": [ - { - "description": "HKEY_LOCAL_MACHINE", - "value": "HKEY_LOCAL_MACHINE" - }, - { - "description": "HKEY_CLASSES_ROOT", - "value": "HKEY_CLASSES_ROOT" - }, - { - "description": "HKEY_CURRENT_CONFIG", - "value": "HKEY_CURRENT_CONFIG" - }, - { - "description": "HKEY_USERS", - "value": "HKEY_USERS" - }, - { - "description": "HKEY_CURRENT_USER_LOCAL_SETTINGS", - "value": "HKEY_CURRENT_USER_LOCAL_SETTINGS" - }, - { - "description": "HKEY_PERFORMANCE_DATA", - "value": "HKEY_PERFORMANCE_DATA" - }, - { - "description": "HKEY_PERFORMANCE_NLSTEXT", - "value": "HKEY_PERFORMANCE_NLSTEXT" - }, - { - "description": "HKEY_PERFORMANCE_TEXT", - "value": "HKEY_PERFORMANCE_TEXT" - }, - { - "description": "HKEY_A", - "value": "HKEY_A" - }, - { - "description": "HKEY_CURRENT_USER", - "value": "HKEY_CURRENT_USER" - } - ] + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "IncidentClassificationReason", + "values": [ + { + "description": "Classification reason was suspicious activity", + "value": "SuspiciousActivity" + }, + { + "description": "Classification reason was suspicious but expected", + "value": "SuspiciousButExpected" + }, + { + "description": "Classification reason was incorrect alert logic", + "value": "IncorrectAlertLogic" + }, + { + "description": "Classification reason was inaccurate data", + "value": "InaccurateData" + } + ] + } + }, + "IncidentSeverity": { + "description": "The severity of the incident", + "enum": [ + "High", + "Medium", + "Low", + "Informational" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "IncidentSeverity", + "values": [ + { + "description": "High severity", + "value": "High" + }, + { + "description": "Medium severity", + "value": "Medium" + }, + { + "description": "Low severity", + "value": "Low" + }, + { + "description": "Informational severity", + "value": "Informational" } - }, - "key": { - "description": "The registry key path.", - "readOnly": true, - "type": "string" - } - }, - "type": "object" + ] + } }, - "RegistryValueEntity": { - "allOf": [ - { - "$ref": "#/definitions/Entity" - } + "IncidentStatus": { + "description": "The status of the incident", + "enum": [ + "New", + "Active", + "Closed" ], - "description": "Represents a registry value entity.", - "properties": { - "properties": { - "$ref": "#/definitions/RegistryValueEntityProperties", - "description": "RegistryKey entity properties", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "RegistryValue" + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "IncidentStatus", + "values": [ + { + "description": "An active incident which isn't being handled currently", + "value": "New" + }, + { + "description": "An active incident which is being handled", + "value": "Active" + }, + { + "description": "A non-active incident", + "value": "Closed" + } + ] + } }, - "RegistryValueEntityProperties": { - "allOf": [ - { - "$ref": "#/definitions/EntityCommonProperties" - } - ], - "description": "RegistryValue entity property bag.", + "IncidentProperties": { + "description": "Describes incident properties", "properties": { - "keyEntityId": { - "description": "The registry key entity id.", + "additionalData": { + "$ref": "#/definitions/IncidentAdditionalData", + "description": "Additional data on the incident", "readOnly": true, - "type": "string" + "type": "object" }, - "valueData": { - "description": "String formatted representation of the value data.", - "readOnly": true, - "type": "string" + "classification": { + "$ref": "#/definitions/IncidentClassification", + "description": "The reason the incident was closed" }, - "valueName": { - "description": "The registry value name.", - "readOnly": true, + "classificationComment": { + "description": "Describes the reason the incident was closed", "type": "string" }, - "valueType": { - "description": "Specifies the data types to use when storing values in the registry, or identifies the data type of a value in the registry.", - "enum": [ - "None", - "Unknown", - "String", - "ExpandString", - "Binary", - "DWord", - "MultiString", - "QWord" - ], - "readOnly": true, - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "RegistryValueKind", - "values": [ - { - "description": "None", - "value": "None" - }, - { - "description": "Unknown value type", - "value": "Unknown" - }, - { - "description": "String value type", - "value": "String" - }, - { - "description": "ExpandString value type", - "value": "ExpandString" - }, - { - "description": "Binary value type", - "value": "Binary" - }, - { - "description": "DWord value type", - "value": "DWord" - }, - { - "description": "MultiString value type", - "value": "MultiString" - }, - { - "description": "QWord value type", - "value": "QWord" - } - ] - } - } - }, - "type": "object" - }, - "RelationList": { - "description": "List of relations.", - "properties": { - "nextLink": { + "classificationReason": { + "$ref": "#/definitions/IncidentClassificationReason", + "description": "The classification reason the incident was closed with" + }, + "createdTimeUtc": { + "description": "The time the incident was created", + "format": "date-time", "readOnly": true, - "description": "URL to fetch the next set of relations.", "type": "string" }, - "value": { - "description": "Array of relations.", - "type": "array", - "items": { - "$ref": "#/definitions/Relation" - } - } - }, - "required": [ - "value" - ] - }, - "Relation": { - "type": "object", - "description": "Represents a relation between two resources", - "allOf": [ - { - "$ref": "#/definitions/ResourceWithEtag" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/RelationProperties", - "description": "Relation properties", - "x-ms-client-flatten": true - } - } - }, - "RelationProperties": { - "description": "Relation property bag.", - "properties": { - "relatedResourceId": { - "description": "The resource ID of the related resource", + "description": { + "description": "The description of the incident", "type": "string" }, - "relatedResourceName": { - "description": "The name of the related resource", - "readOnly": true, + "firstActivityTimeUtc": { + "description": "The time of the first activity in the incident", + "format": "date-time", "type": "string" }, - "relatedResourceType": { - "description": "The resource type of the related resource", + "incidentUrl": { + "description": "The deep-link url to the incident in Azure portal", "readOnly": true, "type": "string" }, - "relatedResourceKind": { - "description": "The resource kind of the related resource", + "incidentNumber": { + "description": "A sequential number", "readOnly": true, + "type": "integer" + }, + "labels": { + "description": "List of labels relevant to this incident", + "items": { + "$ref": "#/definitions/IncidentLabel" + }, + "type": "array" + }, + "providerName": { + "description": "The name of the source provider that generated the incident", "type": "string" - } - }, - "required": [ - "relatedResourceId" - ], - "type": "object" - }, - "Resource": { - "description": "An azure resource object", - "properties": { - "id": { - "description": "Azure resource Id", - "readOnly": true, + }, + "providerIncidentId": { + "description": "The incident ID assigned by the incident provider", "type": "string" }, - "name": { - "description": "Azure resource name", - "readOnly": true, + "lastActivityTimeUtc": { + "description": "The time of the last activity in the incident", + "format": "date-time", "type": "string" }, - "type": { - "description": "Azure resource type", + "lastModifiedTimeUtc": { + "description": "The last time the incident was updated", + "format": "date-time", "readOnly": true, "type": "string" - } - }, - "x-ms-azure-resource": true - }, - "ResourceWithEtag": { - "description": "An azure resource object with an Etag property", - "properties": { - "id": { - "description": "Azure resource Id", + }, + "owner": { + "$ref": "#/definitions/IncidentOwnerInfo", + "description": "Describes a user that the incident is assigned to", + "type": "object" + }, + "relatedAnalyticRuleIds": { + "description": "List of resource ids of Analytic rules related to the incident", + "items": { + "description": "Related Analytic rule resource id", + "type": "string" + }, "readOnly": true, - "type": "string" + "type": "array" }, - "name": { - "description": "Azure resource name", - "readOnly": true, - "type": "string" + "severity": { + "$ref": "#/definitions/IncidentSeverity", + "description": "The severity of the incident" }, - "type": { - "description": "Azure resource type", - "readOnly": true, - "type": "string" + "status": { + "$ref": "#/definitions/IncidentStatus", + "description": "The status of the incident" }, - "etag": { - "description": "Etag of the azure resource", + "title": { + "description": "The title of the incident", "type": "string" } }, - "x-ms-azure-resource": true + "required": [ + "title", + "severity", + "status" + ], + "type": "object" }, - "ScheduledAlertRule": { + "IpEntity": { "allOf": [ { - "$ref": "#/definitions/AlertRule" + "$ref": "#/definitions/Entity" } ], - "description": "Represents scheduled alert rule.", + "description": "Represents an ip entity.", "properties": { "properties": { - "$ref": "#/definitions/ScheduledAlertRuleProperties", - "description": "Scheduled alert rule properties", + "$ref": "#/definitions/IpEntityProperties", + "description": "Ip entity properties", "x-ms-client-flatten": true } }, "type": "object", - "x-ms-discriminator-value": "Scheduled" + "x-ms-discriminator-value": "Ip" }, - "ScheduledAlertRuleCommonProperties": { - "description": "Scheduled alert rule template property bag.", + "IpEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Ip entity property bag.", "properties": { - "query": { - "description": "The query that creates alerts for this rule.", - "type": "string" - }, - "queryFrequency": { - "description": "The frequency (in ISO 8601 duration format) for this alert rule to run.", - "format": "duration", - "type": "string" - }, - "queryPeriod": { - "description": "The period (in ISO 8601 duration format) that this alert rule looks at.", - "format": "duration", + "address": { + "description": "The IP address as string, e.g. 127.0.0.1 (either in Ipv4 or Ipv6)", + "readOnly": true, "type": "string" }, - "severity": { - "$ref": "#/definitions/AlertSeverity", - "description": "The severity for alerts created by this alert rule." - }, - "triggerOperator": { - "$ref": "#/definitions/AlertRuleTriggerOperator", - "description": "The operation against the threshold that triggers alert rule." - }, - "triggerThreshold": { - "description": "The threshold triggers this alert rule.", - "type": "integer" + "location": { + "$ref": "#/definitions/GeoLocation", + "description": "The geo-location context attached to the ip entity" }, - "eventGroupingSettings": { - "$ref": "#/definitions/EventGroupingSettings", - "description": "The event grouping settings." + "threatIntelligence": { + "description": "A list of TI contexts attached to the ip entity.", + "items": { + "$ref": "#/definitions/ThreatIntelligence" + }, + "readOnly": true, + "type": "array" } }, "type": "object" }, - "EventGroupingSettings": { - "description": "Event grouping settings property bag.", + "Label": { + "description": "Label that will be used to tag and filter on.", + "type": "string" + }, + "MailboxEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a mailbox entity.", "properties": { - "aggregationKind": { - "$ref": "#/definitions/EventGroupingAggregationKind" + "properties": { + "$ref": "#/definitions/MailboxEntityProperties", + "description": "Mailbox entity properties", + "x-ms-client-flatten": true } }, - "type": "object" - }, - "EventGroupingAggregationKind": { - "description": "The event grouping aggregation kinds", - "enum": [ - "SingleAlert", - "AlertPerResult" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "EventGroupingAggregationKind" - } + "type": "object", + "x-ms-discriminator-value": "Mailbox" }, - "ScheduledAlertRuleProperties": { + "MailboxEntityProperties": { "allOf": [ { - "$ref": "#/definitions/ScheduledAlertRuleCommonProperties" + "$ref": "#/definitions/EntityCommonProperties" } ], - "description": "Scheduled alert rule base property bag.", + "description": "Mailbox entity property bag.", "properties": { - "alertRuleTemplateName": { - "description": "The Name of the alert rule template used to create this rule.", - "type": "string" - }, - "description": { - "description": "The description of the alert rule.", + "mailboxPrimaryAddress": { + "description": "The mailbox's primary address", + "readOnly": true, "type": "string" }, "displayName": { - "description": "The display name for alerts created by this alert rule.", + "description": "The mailbox's display name", + "readOnly": true, "type": "string" }, - "enabled": { - "description": "Determines whether this alert rule is enabled or disabled.", - "type": "boolean" - }, - "lastModifiedUtc": { - "description": "The last time that this alert rule has been modified.", - "format": "date-time", + "upn": { + "description": "The mailbox's UPN", "readOnly": true, "type": "string" }, - "suppressionDuration": { - "description": "The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered.", - "format": "duration", + "externalDirectoryObjectId": { + "description": "The AzureAD identifier of mailbox. Similar to AadUserId in account entity but this property is specific to mailbox object on office side", + "format": "uuid", + "readOnly": true, "type": "string" - }, - "suppressionEnabled": { - "description": "Determines whether the suppression for this alert rule is enabled or disabled.", - "type": "boolean" - }, - "tactics": { - "description": "The tactics of the alert rule", - "items": { - "$ref": "#/definitions/AttackTactic" - }, - "type": "array" - }, - "incidentConfiguration": { - "$ref": "#/definitions/IncidentConfiguration", - "description": "The settings of the incidents that created from alerts triggered by this analytics rule" } }, - "required": [ - "displayName", - "enabled", - "severity", - "query", - "queryFrequency", - "queryPeriod", - "triggerOperator", - "triggerThreshold", - "suppressionEnabled", - "suppressionDuration" - ], "type": "object" }, - "ScheduledAlertRuleTemplate": { + "MailClusterEntity": { "allOf": [ { - "$ref": "#/definitions/AlertRuleTemplate" + "$ref": "#/definitions/Entity" } ], - "description": "Represents scheduled alert rule template.", + "description": "Represents a mail cluster entity.", "properties": { "properties": { - "allOf": [ - { - "$ref": "#/definitions/AlertRuleTemplatePropertiesBase" - }, - { - "$ref": "#/definitions/ScheduledAlertRuleCommonProperties" - } - ], - "description": "Scheduled alert rule template properties", - "properties": { - "tactics": { - "description": "The tactics of the alert rule template", - "items": { - "$ref": "#/definitions/AttackTactic" - }, - "type": "array" - } - }, - "required": [ - "displayName", - "description", - "status", - "alertRulesCreatedByTemplateCount", - "severity", - "query", - "queryFrequency", - "queryPeriod", - "triggerOperator", - "triggerThreshold" - ], + "$ref": "#/definitions/MailClusterEntityProperties", + "description": "Mail cluster entity properties", "x-ms-client-flatten": true } }, "type": "object", - "x-ms-discriminator-value": "Scheduled" + "x-ms-discriminator-value": "MailCluster" }, - "IncidentConfiguration": { - "description": "Incident Configuration property bag.", - "properties": { - "createIncident": { - "description": "Create incidents from alerts triggered by this analytics rule", - "type": "boolean" - }, - "groupingConfiguration": { - "$ref": "#/definitions/GroupingConfiguration", - "description": "Set how the alerts that are triggered by this analytics rule, are grouped into incidents" + "MailClusterEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" } - }, - "type": "object", - "required": [ - "createIncident" - ] - }, - "GroupingConfiguration": { - "description": "Grouping configuration property bag.", + ], + "description": "Mail cluster entity property bag.", "properties": { - "enabled": { - "description": "Grouping enabled", - "type": "boolean" + "networkMessageIds": { + "description": "The mail message IDs that are part of the mail cluster", + "items": { + "description": "A mail message ID", + "type": "string" + }, + "readOnly": true, + "type": "array" }, - "reopenClosedIncident": { - "description": "Re-open closed matching incidents", - "type": "boolean" + "countByDeliveryStatus": { + "description": "Count of mail messages by DeliveryStatus string representation", + "readOnly": true, + "type": "object" }, - "lookbackDuration": { - "description": "Limit the group to alerts created within the lookback duration (in ISO 8601 duration format)", - "format": "duration", - "type": "string" + "countByThreatType": { + "description": "Count of mail messages by ThreatType string representation", + "readOnly": true, + "type": "object" }, - "entitiesMatchingMethod": { - "description": "Grouping matching method", - "enum": [ - "All", - "None", - "Custom" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "EntitiesMatchingMethod", - "values": [ - { - "description": "Grouping alerts into a single incident if all the entities match", - "value": "All" - }, - { - "description": "Grouping all alerts triggered by this rule into a single incident", - "value": "None" - }, - { - "description": "Grouping alerts into a single incident if the selected entities match", - "value": "Custom" - } - ] - } + "countByProtectionStatus": { + "description": "Count of mail messages by ProtectionStatus string representation", + "readOnly": true, + "type": "object" }, - "groupByEntities": { - "description": "A list of entity types to group by (when entitiesMatchingMethod is Custom)", + "threats": { + "description": "The threats of mail messages that are part of the mail cluster", "items": { - "description": "Grouping entity type", - "enum": [ - "Account", - "Host", - "Ip", - "Url", - "FileHash" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "GroupingEntityType", - "values": [ - { - "description": "Account entity", - "value": "Account" - }, - { - "description": "Host entity", - "value": "Host" - }, - { - "description": "Ip entity", - "value": "Ip" - }, - { - "description": "Url entity", - "value": "Url" - }, - { - "description": "FileHash entity", - "value": "FileHash" - } - ] - } + "description": "A threat", + "type": "string" }, + "readOnly": true, "type": "array" + }, + "query": { + "description": "The query that was used to identify the messages of the mail cluster", + "readOnly": true, + "type": "string" + }, + "queryTime": { + "description": "The query time", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "mailCount": { + "description": "The number of mail messages that are part of the mail cluster", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "isVolumeAnomaly": { + "description": "Is this a volume anomaly mail cluster", + "readOnly": true, + "type": "boolean" + }, + "source": { + "description": "The source of the mail cluster (default is 'O365 ATP')", + "readOnly": true, + "type": "string" + }, + "clusterSourceIdentifier": { + "description": "The id of the cluster source", + "readOnly": true, + "type": "string" + }, + "clusterSourceType": { + "description": "The type of the cluster source", + "readOnly": true, + "type": "string" + }, + "clusterQueryStartTime": { + "description": "The cluster query start time", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "clusterQueryEndTime": { + "description": "The cluster query end time", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "clusterGroup": { + "description": "The cluster group", + "readOnly": true, + "type": "string" } }, - "type": "object", - "required": [ - "enabled", - "reopenClosedIncident", - "lookbackDuration", - "entitiesMatchingMethod" - ] + "type": "object" }, - "SecurityAlert": { + "MailMessageEntity": { "allOf": [ { "$ref": "#/definitions/Entity" } ], - "description": "Represents a security alert entity.", + "description": "Represents a mail message entity.", "properties": { "properties": { - "$ref": "#/definitions/SecurityAlertProperties", - "description": "SecurityAlert entity properties", + "$ref": "#/definitions/MailMessageEntityProperties", + "description": "Mail message entity properties", "x-ms-client-flatten": true } }, "type": "object", - "x-ms-discriminator-value": "SecurityAlert" + "x-ms-discriminator-value": "MailMessage" }, - "SecurityAlertProperties": { + "MailMessageEntityProperties": { "allOf": [ { "$ref": "#/definitions/EntityCommonProperties" } ], - "description": "SecurityAlert entity property bag.", + "description": "Mail message entity property bag.", "properties": { - "alertDisplayName": { - "description": "The display name of the alert.", + "fileEntityIds": { + "description": "The File entity ids of this mail message's attachments", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "recipient": { + "description": "The recipient of this mail message. Note that in case of multiple recipients the mail message is forked and each copy has one recipient", "readOnly": true, "type": "string" }, - "alertType": { - "description": "The type name of the alert.", + "urls": { + "description": "The Urls contained in this mail message", + "items": { + "description": "A Url contained in this mail message", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "threats": { + "description": "The threats of this mail message", + "items": { + "description": "A threat of the mail message", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "p1Sender": { + "description": "The p1 sender's email address", + "readOnly": true, + "type": "string" + }, + "p1SenderDisplayName": { + "description": "The p1 sender's display name", + "readOnly": true, + "type": "string" + }, + "p1SenderDomain": { + "description": "The p1 sender's domain", + "readOnly": true, + "type": "string" + }, + "senderIP": { + "description": "The sender's IP address", + "readOnly": true, + "type": "string" + }, + "p2Sender": { + "description": "The p2 sender's email address", + "readOnly": true, + "type": "string" + }, + "p2SenderDisplayName": { + "description": "The p2 sender's display name", + "readOnly": true, + "type": "string" + }, + "p2SenderDomain": { + "description": "The p2 sender's domain", + "readOnly": true, + "type": "string" + }, + "receiveDate": { + "description": "The receive date of this message", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "networkMessageId": { + "description": "The network message id of this mail message", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "internetMessageId": { + "description": "The internet message id of this mail message", + "readOnly": true, + "type": "string" + }, + "subject": { + "description": "The subject of this mail message", + "readOnly": true, + "type": "string" + }, + "language": { + "description": "The language of this mail message", "readOnly": true, "type": "string" }, - "compromisedEntity": { - "description": "Display name of the main entity being reported on.", + "threatDetectionMethods": { + "description": "The threat detection methods", + "items": { + "description": "A threat detection method", + "type": "string" + }, "readOnly": true, - "type": "string" + "type": "array" }, - "confidenceLevel": { - "description": "The confidence level of this alert.", + "bodyFingerprintBin1": { + "description": "The bodyFingerprintBin1", + "type": "integer", + "format": "int32" + }, + "bodyFingerprintBin2": { + "description": "The bodyFingerprintBin2", + "type": "integer", + "format": "int32" + }, + "bodyFingerprintBin3": { + "description": "The bodyFingerprintBin3", + "type": "integer", + "format": "int32" + }, + "bodyFingerprintBin4": { + "description": "The bodyFingerprintBin4", + "type": "integer", + "format": "int32" + }, + "bodyFingerprintBin5": { + "description": "The bodyFingerprintBin5", + "type": "integer", + "format": "int32" + }, + "antispamDirection": { + "description": "The directionality of this mail message", "enum": [ "Unknown", - "Low", - "High" + "Inbound", + "Outbound", + "Intraorg" ], - "readOnly": true, "type": "string", "x-ms-enum": { "modelAsString": true, - "name": "ConfidenceLevel", + "name": "AntispamMailDirection", "values": [ { - "description": "Unknown confidence, the is the default value", + "description": "Unknown", "value": "Unknown" }, { - "description": "Low confidence, meaning we have some doubts this is indeed malicious or part of an attack", - "value": "Low" + "description": "Inbound", + "value": "Inbound" }, { - "description": "High confidence that the alert is true positive malicious", - "value": "High" + "description": "Outbound", + "value": "Outbound" + }, + { + "description": "Intraorg", + "value": "Intraorg" } ] } }, - "confidenceReasons": { - "description": "The confidence reasons", - "items": { - "description": "confidence reason item", - "properties": { - "reason": { - "description": "The reason's description", - "readOnly": true, - "type": "string" - }, - "reasonType": { - "description": "The type (category) of the reason", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "readOnly": true, - "type": "array" - }, - "confidenceScore": { - "description": "The confidence score of the alert.", - "format": "double", - "readOnly": true, - "type": "number" - }, - "confidenceScoreStatus": { - "description": "The confidence score calculation status, i.e. indicating if score calculation is pending for this alert, not applicable or final.", + "deliveryAction": { + "description": "The delivery action of this mail message like Delivered, Blocked, Replaced etc", "enum": [ - "NotApplicable", - "InProcess", - "NotFinal", - "Final" + "Unknown", + "DeliveredAsSpam", + "Delivered", + "Blocked", + "Replaced" ], - "readOnly": true, "type": "string", "x-ms-enum": { - "modelAsString": true, - "name": "ConfidenceScoreStatus", + "modelAsString": false, + "name": "DeliveryAction", "values": [ { - "description": "Score will not be calculated for this alert as it is not supported by virtual analyst", - "value": "NotApplicable" + "description": "Unknown", + "value": "Unknown" }, { - "description": "No score was set yet and calculation is in progress", - "value": "InProcess" + "description": "DeliveredAsSpam", + "value": "DeliveredAsSpam" }, { - "description": "Score is calculated and shown as part of the alert, but may be updated again at a later time following the processing of additional data", - "value": "NotFinal" + "description": "Delivered", + "value": "Delivered" }, { - "description": "Final score was calculated and available", - "value": "Final" + "description": "Blocked", + "value": "Blocked" + }, + { + "description": "Replaced", + "value": "Replaced" } ] } }, - "description": { - "description": "Alert description.", - "readOnly": true, - "type": "string" - }, - "endTimeUtc": { - "description": "The impact end time of the alert (the time of the last event contributing to the alert).", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "intent": { - "description": "Holds the alert intent stage(s) mapping for this alert.", + "deliveryLocation": { + "description": "The delivery location of this mail message like Inbox, JunkFolder etc", "enum": [ "Unknown", - "Probing", - "Exploitation", - "Persistence", - "PrivilegeEscalation", - "DefenseEvasion", - "CredentialAccess", - "Discovery", - "LateralMovement", - "Execution", - "Collection", - "Exfiltration", - "CommandAndControl", - "Impact" + "Inbox", + "JunkFolder", + "DeletedFolder", + "Quarantine", + "External", + "Failed", + "Dropped", + "Forwarded" ], - "readOnly": true, "type": "string", "x-ms-enum": { - "modelAsString": true, - "name": "KillChainIntent", + "modelAsString": false, + "name": "DeliveryLocation", "values": [ { - "description": "The default value.", + "description": "Unknown", "value": "Unknown" }, { - "description": "Probing could be an attempt to access a certain resource regardless of a malicious intent or a failed attempt to gain access to a target system to gather information prior to exploitation. This step is usually detected as an attempt originating from outside the network in attempt to scan the target system and find a way in.", - "value": "Probing" - }, - { - "description": "Exploitation is the stage where an attacker manage to get foothold on the attacked resource. This stage is applicable not only for compute hosts, but also for resources such as user accounts, certificates etc. Adversaries will often be able to control the resource after this stage.", - "value": "Exploitation" - }, - { - "description": "Persistence is any access, action, or configuration change to a system that gives an adversary a persistent presence on that system. Adversaries will often need to maintain access to systems through interruptions such as system restarts, loss of credentials, or other failures that would require a remote access tool to restart or alternate backdoor for them to regain access.", - "value": "Persistence" - }, - { - "description": "Privilege escalation is the result of actions that allow an adversary to obtain a higher level of permissions on a system or network. Certain tools or actions require a higher level of privilege to work and are likely necessary at many points throughout an operation. User accounts with permissions to access specific systems or perform specific functions necessary for adversaries to achieve their objective may also be considered an escalation of privilege.", - "value": "PrivilegeEscalation" - }, - { - "description": "Defense evasion consists of techniques an adversary may use to evade detection or avoid other defenses. Sometimes these actions are the same as or variations of techniques in other categories that have the added benefit of subverting a particular defense or mitigation. ", - "value": "DefenseEvasion" - }, - { - "description": "Credential access represents techniques resulting in access to or control over system, domain, or service credentials that are used within an enterprise environment. Adversaries will likely attempt to obtain legitimate credentials from users or administrator accounts (local system administrator or domain users with administrator access) to use within the network. With sufficient access within a network, an adversary can create accounts for later use within the environment.", - "value": "CredentialAccess" + "description": "Inbox", + "value": "Inbox" }, { - "description": "Discovery consists of techniques that allow the adversary to gain knowledge about the system and internal network. When adversaries gain access to a new system, they must orient themselves to what they now have control of and what benefits operating from that system give to their current objective or overall goals during the intrusion. The operating system provides many native tools that aid in this post-compromise information-gathering phase.", - "value": "Discovery" + "description": "JunkFolder", + "value": "JunkFolder" }, { - "description": "Lateral movement consists of techniques that enable an adversary to access and control remote systems on a network and could, but does not necessarily, include execution of tools on remote systems. The lateral movement techniques could allow an adversary to gather information from a system without needing additional tools, such as a remote access tool. An adversary can use lateral movement for many purposes, including remote Execution of tools, pivoting to additional systems, access to specific information or files, access to additional credentials, or to cause an effect.", - "value": "LateralMovement" + "description": "DeletedFolder", + "value": "DeletedFolder" }, { - "description": "The execution tactic represents techniques that result in execution of adversary-controlled code on a local or remote system. This tactic is often used in conjunction with lateral movement to expand access to remote systems on a network.", - "value": "Execution" + "description": "Quarantine", + "value": "Quarantine" }, { - "description": "Collection consists of techniques used to identify and gather information, such as sensitive files, from a target network prior to exfiltration. This category also covers locations on a system or network where the adversary may look for information to exfiltrate.", - "value": "Collection" + "description": "External", + "value": "External" }, { - "description": "Exfiltration refers to techniques and attributes that result or aid in the adversary removing files and information from a target network. This category also covers locations on a system or network where the adversary may look for information to exfiltrate.", - "value": "Exfiltration" + "description": "Failed", + "value": "Failed" }, { - "description": "The command and control tactic represents how adversaries communicate with systems under their control within a target network.", - "value": "CommandAndControl" + "description": "Dropped", + "value": "Dropped" }, { - "description": "The impact intent primary objective is to directly reduce the availability or integrity of a system, service, or network; including manipulation of data to impact a business or operational process. This would often refer to techniques such as ransom-ware, defacement, data manipulation and others.", - "value": "Impact" + "description": "Forwarded", + "value": "Forwarded" } ] } + } + }, + "type": "object" + }, + "SubmissionMailEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a submission mail entity.", + "properties": { + "properties": { + "$ref": "#/definitions/SubmissionMailEntityProperties", + "description": "Submission mail entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "SubmissionMail" + }, + "SubmissionMailEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Submission mail entity property bag.", + "properties": { + "networkMessageId": { + "description": "The network message id of email to which submission belongs", + "format": "uuid", + "readOnly": true, + "type": "string" }, - "providerAlertId": { - "description": "The identifier of the alert inside the product which generated the alert.", + "submissionId": { + "description": "The submission id", + "format": "uuid", "readOnly": true, "type": "string" }, - "processingEndTime": { - "description": "The time the alert was made available for consumption.", + "submitter": { + "description": "The submitter", + "readOnly": true, + "type": "string" + }, + "submissionDate": { + "description": "The submission date", "format": "date-time", "readOnly": true, "type": "string" }, - "productComponentName": { - "description": "The name of a component inside the product which generated the alert.", + "timestamp": { + "description": "The Time stamp when the message is received (Mail)", + "format": "date-time", "readOnly": true, "type": "string" }, - "productName": { - "description": "The name of the product which published this alert.", + "recipient": { + "description": "The recipient of the mail", "readOnly": true, "type": "string" }, - "productVersion": { - "description": "The version of the product generating the alert.", + "sender": { + "description": "The sender of the mail", "readOnly": true, "type": "string" }, - "remediationSteps": { - "description": "Manual action items to take to remediate the alert.", + "senderIp": { + "description": "The sender's IP", + "readOnly": true, + "type": "string" + }, + "subject": { + "description": "The subject of submission mail", + "readOnly": true, + "type": "string" + }, + "reportType": { + "description": "The submission type for the given instance. This maps to Junk, Phish, Malware or NotJunk.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "MCASDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents MCAS (Microsoft Cloud App Security) data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/MCASDataConnectorProperties", + "description": "MCAS (Microsoft Cloud App Security) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftCloudAppSecurity" + }, + "MCASDataConnectorDataTypes": { + "allOf": [ + { + "$ref": "#/definitions/AlertsDataTypeOfDataConnector" + } + ], + "description": "The available data types for MCAS (Microsoft Cloud App Security) data connector.", + "properties": { + "discoveryLogs": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Discovery log data type connection.", + "type": "object" + } + }, + "type": "object" + }, + "MCASDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "MCAS (Microsoft Cloud App Security) data connector properties.", + "properties": { + "dataTypes": { + "$ref": "#/definitions/MCASDataConnectorDataTypes", + "description": "The available data types for the connector." + } + }, + "required": [ + "dataTypes" + ], + "type": "object" + }, + "MDATPDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents MDATP (Microsoft Defender Advanced Threat Protection) data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/MDATPDataConnectorProperties", + "description": "MDATP (Microsoft Defender Advanced Threat Protection) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftDefenderAdvancedThreatProtection" + }, + "MDATPDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + }, + { + "$ref": "#/definitions/DataConnectorWithAlertsProperties" + } + ], + "description": "MDATP (Microsoft Defender Advanced Threat Protection) data connector properties.", + "type": "object" + }, + "MalwareEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a malware entity.", + "properties": { + "properties": { + "$ref": "#/definitions/MalwareEntityProperties", + "description": "File entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Malware" + }, + "MalwareEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Malware entity property bag.", + "properties": { + "category": { + "description": "The malware category by the vendor, e.g. Trojan", + "readOnly": true, + "type": "string" + }, + "fileEntityIds": { + "description": "List of linked file entity identifiers on which the malware was found", "items": { + "description": "file entity id", "type": "string" }, "readOnly": true, "type": "array" }, - "severity": { - "$ref": "#/definitions/AlertSeverity", - "description": "The severity of the alert" - }, - "startTimeUtc": { - "description": "The impact start time of the alert (the time of the first event contributing to the alert).", - "format": "date-time", + "malwareName": { + "description": "The malware name by the vendor, e.g. Win32/Toga!rfn", "readOnly": true, "type": "string" }, - "status": { - "description": "The lifecycle status of the alert.", - "enum": [ - "Unknown", - "New", - "Resolved", - "Dismissed", - "InProgress" - ], + "processEntityIds": { + "description": "List of linked process entity identifiers on which the malware was found.", + "items": { + "description": "process entity id", + "type": "string" + }, "readOnly": true, - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "AlertStatus", - "values": [ - { - "description": "Unknown value", - "value": "Unknown" - }, - { - "description": "New alert", - "value": "New" - }, - { - "description": "Alert closed after handling", - "value": "Resolved" - }, - { - "description": "Alert dismissed as false positive", - "value": "Dismissed" - }, - { - "description": "Alert is being handled", - "value": "InProgress" - } - ] + "type": "array" + } + }, + "type": "object" + }, + "MicrosoftSecurityIncidentCreationAlertRule": { + "allOf": [ + { + "$ref": "#/definitions/AlertRule" + } + ], + "description": "Represents MicrosoftSecurityIncidentCreation rule.", + "properties": { + "properties": { + "$ref": "#/definitions/MicrosoftSecurityIncidentCreationAlertRuleProperties", + "description": "MicrosoftSecurityIncidentCreation rule properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftSecurityIncidentCreation" + }, + "MicrosoftSecurityIncidentCreationAlertRuleCommonProperties": { + "description": "MicrosoftSecurityIncidentCreation rule common property bag.", + "properties": { + "displayNamesFilter": { + "description": "the alerts' displayNames on which the cases will be generated", + "items": { + "type": "string" + }, + "type": "array" + }, + "displayNamesExcludeFilter": { + "description": "the alerts' displayNames on which the cases will not be generated", + "items": { + "type": "string" + }, + "type": "array" + }, + "productFilter": { + "description": "The alerts' productName on which the cases will be generated", + "enum": [ + "Microsoft Cloud App Security", + "Azure Security Center", + "Azure Advanced Threat Protection", + "Azure Active Directory Identity Protection", + "Azure Security Center for IoT", + "Office 365 Advanced Threat Protection", + "Microsoft Defender Advanced Threat Protection" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "MicrosoftSecurityProductName" } }, - "systemAlertId": { - "description": "Holds the product identifier of the alert for the product.", - "readOnly": true, - "type": "string" - }, - "tactics": { - "description": "The tactics of the alert", + "severitiesFilter": { + "description": "the alerts' severities on which the cases will be generated", "items": { - "$ref": "#/definitions/AttackTactic" + "$ref": "#/definitions/AlertSeverity" }, - "readOnly": true, "type": "array" - }, - "timeGenerated": { - "description": "The time the alert was generated.", - "format": "date-time", - "readOnly": true, + } + }, + "required": [ + "productFilter" + ], + "type": "object" + }, + "MicrosoftSecurityIncidentCreationAlertRuleProperties": { + "allOf": [ + { + "$ref": "#/definitions/MicrosoftSecurityIncidentCreationAlertRuleCommonProperties" + } + ], + "description": "MicrosoftSecurityIncidentCreation rule property bag.", + "properties": { + "alertRuleTemplateName": { + "description": "The Name of the alert rule template used to create this rule.", "type": "string" }, - "vendorName": { - "description": "The name of the vendor that raise the alert.", - "readOnly": true, + "description": { + "description": "The description of the alert rule.", "type": "string" }, - "alertLink": { - "description": "The uri link of the alert.", - "readOnly": true, + "displayName": { + "description": "The display name for alerts created by this alert rule.", "type": "string" }, - "resourceIdentifiers": { - "description": "The list of resource identifiers of the alert.", - "items": { - "type": "object" - }, + "enabled": { + "description": "Determines whether this alert rule is enabled or disabled.", + "type": "boolean" + }, + "lastModifiedUtc": { + "description": "The last time that this alert has been modified.", + "format": "date-time", "readOnly": true, - "type": "array" + "type": "string" } }, + "required": [ + "displayName", + "enabled", + "productFilter" + ], "type": "object" }, - "SecurityGroupEntity": { + "MicrosoftSecurityIncidentCreationAlertRuleTemplate": { "allOf": [ { - "$ref": "#/definitions/Entity" + "$ref": "#/definitions/AlertRuleTemplate" } ], - "description": "Represents a security group entity.", + "description": "Represents MicrosoftSecurityIncidentCreation rule template.", "properties": { "properties": { - "$ref": "#/definitions/SecurityGroupEntityProperties", - "description": "SecurityGroup entity properties", + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplatePropertiesBase" + }, + { + "$ref": "#/definitions/MicrosoftSecurityIncidentCreationAlertRuleCommonProperties" + } + ], + "description": "MicrosoftSecurityIncidentCreation rule template properties", + "required": [ + "displayName", + "description", + "createdDateUTC", + "status", + "alertRulesCreatedByTemplateCount", + "productFilter" + ], "x-ms-client-flatten": true } }, "type": "object", - "x-ms-discriminator-value": "SecurityGroup" + "x-ms-discriminator-value": "MicrosoftSecurityIncidentCreation" }, - "SecurityGroupEntityProperties": { + "OfficeATPDataConnector": { "allOf": [ { - "$ref": "#/definitions/EntityCommonProperties" + "$ref": "#/definitions/DataConnector" } ], - "description": "SecurityGroup entity property bag.", + "description": "Represents OfficeATP (Office 365 Advanced Threat Protection) data connector.", "properties": { - "distinguishedName": { - "description": "The group distinguished name", - "readOnly": true, - "type": "string" + "properties": { + "$ref": "#/definitions/OfficeATPDataConnectorProperties", + "description": "OfficeATP (Office 365 Advanced Threat Protection) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "OfficeATP" + }, + "OfficeATPDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" }, - "objectGuid": { - "description": "A single-value attribute that is the unique identifier for the object, assigned by active directory.", - "format": "uuid", - "readOnly": true, - "type": "string" + { + "$ref": "#/definitions/DataConnectorWithAlertsProperties" + } + ], + "description": "OfficeATP (Office 365 Advanced Threat Protection) data connector properties.", + "type": "object" + }, + "OfficeDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents office data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/OfficeDataConnectorProperties", + "description": "Office data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Office365" + }, + "OfficeDataConnectorDataTypes": { + "description": "The available data types for office data connector.", + "properties": { + "exchange": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Exchange data type connection.", + "type": "object" }, - "sid": { - "description": "The SID attribute is a single-value attribute that specifies the security identifier (SID) of the group", - "readOnly": true, - "type": "string" + "sharePoint": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "SharePoint data type connection.", + "type": "object" + }, + "teams": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Teams data type connection.", + "type": "object" + } + }, + "type": "object", + "required": [ + "exchange", + "sharePoint", + "teams" + ] + }, + "OfficeDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "Office data connector properties.", + "properties": { + "dataTypes": { + "$ref": "#/definitions/OfficeDataConnectorDataTypes", + "description": "The available data types for the connector." } }, + "required": [ + "dataTypes" + ], "type": "object" }, - "SettingList": { - "description": "List of all the settings.", + "Operation": { + "description": "Operation provided by provider", + "properties": { + "display": { + "description": "Properties of the operation", + "properties": { + "description": { + "description": "Description of the operation", + "type": "string" + }, + "operation": { + "description": "Operation name", + "type": "string" + }, + "provider": { + "description": "Provider name", + "type": "string" + }, + "resource": { + "description": "Resource name", + "type": "string" + } + }, + "type": "object" + }, + "name": { + "description": "Name of the operation", + "type": "string" + }, + "origin": { + "description": "The origin of the operation", + "type": "string" + } + } + }, + "OperationsList": { + "description": "Lists the operations available in the SecurityInsights RP.", "properties": { + "nextLink": { + "description": "URL to fetch the next set of operations.", + "type": "string" + }, "value": { - "description": "Array of settings.", + "description": "Array of operations", "items": { - "$ref": "#/definitions/Settings" + "$ref": "#/definitions/Operation" }, "type": "array" } }, + "type": "object", "required": [ "value" ] }, - "Settings": { - "allOf": [ - { - "$ref": "#/definitions/ResourceWithEtag" - }, - { - "$ref": "#/definitions/SettingsKind" - } - ], - "description": "The Setting.", - "discriminator": "kind", - "type": "object" - }, - "SettingsKind": { - "description": "Describes an Azure resource with kind.", - "properties": { - "kind": { - "description": "The kind of the setting", - "enum": [ - "EyesOn", - "EntityAnalytics", - "Ueba" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "SettingKind" - } - } - }, - "required": [ - "kind" - ], - "type": "object" - }, - "TIDataConnector": { + "ProcessEntity": { "allOf": [ { - "$ref": "#/definitions/DataConnector" + "$ref": "#/definitions/Entity" } ], - "description": "Data connector to pull threat intelligence data from TIP products.", + "description": "Represents a process entity.", "properties": { "properties": { - "$ref": "#/definitions/TIDataConnectorProperties", - "description": "Threat Intelligence Platforms data connector properties.", + "$ref": "#/definitions/ProcessEntityProperties", + "description": "Process entity properties", "x-ms-client-flatten": true } }, "type": "object", - "x-ms-discriminator-value": "ThreatIntelligence" + "x-ms-discriminator-value": "Process" }, - "TIDataConnectorDataTypes": { - "description": "The available data types for Threat Intelligence Platforms data connector.", - "properties": { - "indicators": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorDataTypeCommon" - } - ], - "description": "Data type for Threat Intelligence Platforms data connector.", - "type": "object" + "ProcessEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" } - }, - "type": "object", - "required": [ - "indicators" - ] - }, - "TIDataConnectorProperties": { - "description": "TI (Threat Intelligence) data connector properties.", + ], + "description": "Process entity property bag.", "properties": { - "tenantId": { - "description": "The tenant id to connect to, and get the data from.", + "accountEntityId": { + "description": "The account entity id running the processes.", + "readOnly": true, "type": "string" }, - "tipLookbackPeriod": { - "description": "The lookback period for the feed to be imported.", + "commandLine": { + "description": "The command line used to create the process", + "readOnly": true, + "type": "string" + }, + "creationTimeUtc": { + "description": "The time when the process started to run", "format": "date-time", + "readOnly": true, + "type": "string" + }, + "elevationToken": { + "description": "The elevation token associated with the process.", + "enum": [ + "Default", + "Full", + "Limited" + ], "type": "string", - "x-nullable": true + "x-ms-enum": { + "modelAsString": false, + "name": "ElevationToken", + "values": [ + { + "description": "Default elevation token", + "value": "Default" + }, + { + "description": "Full elevation token", + "value": "Full" + }, + { + "description": "Limited elevation token", + "value": "Limited" + } + ] + } }, - "dataTypes": { - "$ref": "#/definitions/TIDataConnectorDataTypes", - "description": "The available data types for the connector." + "hostEntityId": { + "description": "The host entity id on which the process was running", + "readOnly": true, + "type": "string" + }, + "hostLogonSessionEntityId": { + "description": "The session entity id in which the process was running", + "readOnly": true, + "type": "string" + }, + "imageFileEntityId": { + "description": "Image file entity id", + "readOnly": true, + "type": "string" + }, + "parentProcessEntityId": { + "description": "The parent process entity id.", + "readOnly": true, + "type": "string" + }, + "processId": { + "description": "The process ID", + "readOnly": true, + "type": "string" } }, - "type": "object", - "required": [ - "tenantId", - "dataTypes" - ] + "type": "object" }, - "TICheckRequirements": { + "RegistryKeyEntity": { "allOf": [ { - "$ref": "#/definitions/DataConnectorsCheckRequirements" + "$ref": "#/definitions/Entity" } ], - "description": "Threat Intelligence Platforms data connector check requirements", + "description": "Represents a registry key entity.", "properties": { "properties": { - "$ref": "#/definitions/TICheckRequirementsProperties", - "description": "Threat Intelligence Platforms data connector check required properties", + "$ref": "#/definitions/RegistryKeyEntityProperties", + "description": "RegistryKey entity properties", "x-ms-client-flatten": true } }, "type": "object", - "x-ms-discriminator-value": "ThreatIntelligence" + "x-ms-discriminator-value": "RegistryKey" }, - "TICheckRequirementsProperties": { + "RegistryKeyEntityProperties": { "allOf": [ { - "$ref": "#/definitions/DataConnectorTenantId" + "$ref": "#/definitions/EntityCommonProperties" } ], - "description": "Threat Intelligence Platforms data connector required properties.", - "properties": {}, + "description": "RegistryKey entity property bag.", + "properties": { + "hive": { + "description": "the hive that holds the registry key.", + "enum": [ + "HKEY_LOCAL_MACHINE", + "HKEY_CLASSES_ROOT", + "HKEY_CURRENT_CONFIG", + "HKEY_USERS", + "HKEY_CURRENT_USER_LOCAL_SETTINGS", + "HKEY_PERFORMANCE_DATA", + "HKEY_PERFORMANCE_NLSTEXT", + "HKEY_PERFORMANCE_TEXT", + "HKEY_A", + "HKEY_CURRENT_USER" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "RegistryHive", + "values": [ + { + "description": "HKEY_LOCAL_MACHINE", + "value": "HKEY_LOCAL_MACHINE" + }, + { + "description": "HKEY_CLASSES_ROOT", + "value": "HKEY_CLASSES_ROOT" + }, + { + "description": "HKEY_CURRENT_CONFIG", + "value": "HKEY_CURRENT_CONFIG" + }, + { + "description": "HKEY_USERS", + "value": "HKEY_USERS" + }, + { + "description": "HKEY_CURRENT_USER_LOCAL_SETTINGS", + "value": "HKEY_CURRENT_USER_LOCAL_SETTINGS" + }, + { + "description": "HKEY_PERFORMANCE_DATA", + "value": "HKEY_PERFORMANCE_DATA" + }, + { + "description": "HKEY_PERFORMANCE_NLSTEXT", + "value": "HKEY_PERFORMANCE_NLSTEXT" + }, + { + "description": "HKEY_PERFORMANCE_TEXT", + "value": "HKEY_PERFORMANCE_TEXT" + }, + { + "description": "HKEY_A", + "value": "HKEY_A" + }, + { + "description": "HKEY_CURRENT_USER", + "value": "HKEY_CURRENT_USER" + } + ] + } + }, + "key": { + "description": "The registry key path.", + "readOnly": true, + "type": "string" + } + }, "type": "object" }, - "TiTaxiiDataConnector": { + "RegistryValueEntity": { "allOf": [ { - "$ref": "#/definitions/DataConnector" + "$ref": "#/definitions/Entity" } ], - "description": "Data connector to pull Threat intelligence data from TAXII 2.0/2.1 server", - "properties": { - "properties": { - "$ref": "#/definitions/TiTaxiiDataConnectorProperties", - "description": "Threat intelligence TAXII data connector properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "ThreatIntelligenceTaxii" - }, - "TiTaxiiDataConnectorDataTypes": { - "description": "The available data types for Threat Intelligence TAXII data connector.", - "properties": { - "taxiiClient": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorDataTypeCommon" - } - ], - "description": "Data type for TAXII connector.", - "type": "object" + "description": "Represents a registry value entity.", + "properties": { + "properties": { + "$ref": "#/definitions/RegistryValueEntityProperties", + "description": "RegistryKey entity properties", + "x-ms-client-flatten": true } }, "type": "object", - "required": [ - "taxiiClient" - ] + "x-ms-discriminator-value": "RegistryValue" }, - "TiTaxiiDataConnectorProperties": { + "RegistryValueEntityProperties": { "allOf": [ { - "$ref": "#/definitions/DataConnectorTenantId" + "$ref": "#/definitions/EntityCommonProperties" } ], - "description": "Threat Intelligence TAXII data connector properties.", + "description": "RegistryValue entity property bag.", "properties": { - "workspaceId": { - "description": "The workspace id.", - "type": "string" - }, - "friendlyName": { - "description": "The friendly name for the TAXII server.", - "type": "string" - }, - "taxiiServer": { - "description": "The API root for the TAXII server.", - "type": "string" - }, - "collectionId": { - "description": "The collection id of the TAXII server.", + "keyEntityId": { + "description": "The registry key entity id.", + "readOnly": true, "type": "string" }, - "userName": { - "description": "The userName for the TAXII server.", + "valueData": { + "description": "String formatted representation of the value data.", + "readOnly": true, "type": "string" }, - "password": { - "description": "The password for the TAXII server.", + "valueName": { + "description": "The registry value name.", + "readOnly": true, "type": "string" }, - "taxiiLookbackPeriod": { - "description": "The lookback period for the TAXII server.", - "format": "date-time", - "type": "string", - "x-nullable": true - }, - "pollingFrequency": { - "description": "The polling frequency for the TAXII server.", - "type": "string", - "x-nullable": true, + "valueType": { + "description": "Specifies the data types to use when storing values in the registry, or identifies the data type of a value in the registry.", "enum": [ - "OnceAMinute", - "OnceAnHour", - "OnceADay" + "None", + "Unknown", + "String", + "ExpandString", + "Binary", + "DWord", + "MultiString", + "QWord" ], + "readOnly": true, + "type": "string", "x-ms-enum": { "modelAsString": true, - "name": "PollingFrequency", + "name": "RegistryValueKind", "values": [ { - "description": "Once a minute", - "value": "OnceAMinute" + "description": "None", + "value": "None" }, { - "description": "Once an hour", - "value": "OnceAnHour" + "description": "Unknown value type", + "value": "Unknown" }, { - "description": "Once a day", - "value": "OnceADay" + "description": "String value type", + "value": "String" + }, + { + "description": "ExpandString value type", + "value": "ExpandString" + }, + { + "description": "Binary value type", + "value": "Binary" + }, + { + "description": "DWord value type", + "value": "DWord" + }, + { + "description": "MultiString value type", + "value": "MultiString" + }, + { + "description": "QWord value type", + "value": "QWord" } ] } + } + }, + "type": "object" + }, + "RelationList": { + "description": "List of relations.", + "properties": { + "nextLink": { + "readOnly": true, + "description": "URL to fetch the next set of relations.", + "type": "string" }, - "dataTypes": { - "$ref": "#/definitions/TiTaxiiDataConnectorDataTypes", - "description": "The available data types for Threat Intelligence TAXII data connector." + "value": { + "description": "Array of relations.", + "type": "array", + "items": { + "$ref": "#/definitions/Relation" + } } }, + "type": "object", "required": [ - "dataTypes", - "pollingFrequency" - ], - "type": "object" + "value" + ] }, - "TiTaxiiCheckRequirements": { + "Relation": { + "type": "object", + "description": "Represents a relation between two resources", "allOf": [ { - "$ref": "#/definitions/DataConnectorsCheckRequirements" + "$ref": "#/definitions/ResourceWithEtag" } ], - "description": "Threat Intelligence TAXII data connector check requirements", "properties": { "properties": { - "$ref": "#/definitions/TiTaxiiCheckRequirementsProperties", - "description": "Threat Intelligence TAXII check required properties.", + "$ref": "#/definitions/RelationProperties", + "description": "Relation properties", "x-ms-client-flatten": true } - }, - "type": "object", - "x-ms-discriminator-value": "ThreatIntelligenceTaxii" + } }, - "TiTaxiiCheckRequirementsProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" + "RelationProperties": { + "description": "Relation property bag.", + "properties": { + "relatedResourceId": { + "description": "The resource ID of the related resource", + "type": "string" + }, + "relatedResourceName": { + "description": "The name of the related resource", + "readOnly": true, + "type": "string" + }, + "relatedResourceType": { + "description": "The resource type of the related resource", + "readOnly": true, + "type": "string" + }, + "relatedResourceKind": { + "description": "The resource kind of the related resource", + "readOnly": true, + "type": "string" } + }, + "required": [ + "relatedResourceId" ], - "description": "Threat Intelligence TAXII data connector required properties.", "type": "object" }, - "ThreatIntelligence": { - "description": "ThreatIntelligence property bag.", + "Resource": { + "description": "An azure resource object", "properties": { - "confidence": { - "description": "Confidence (must be between 0 and 1)", - "format": "double", + "id": { + "description": "Azure resource Id", "readOnly": true, - "type": "number" + "type": "string" }, - "providerName": { - "description": "Name of the provider from whom this Threat Intelligence information was received", + "name": { + "description": "Azure resource name", "readOnly": true, "type": "string" }, - "reportLink": { - "description": "Report link", + "type": { + "description": "Azure resource type", "readOnly": true, "type": "string" - }, - "threatDescription": { - "description": "Threat description (free text)", + } + }, + "x-ms-azure-resource": true + }, + "ResourceWithEtag": { + "description": "An azure resource object with an Etag property", + "properties": { + "id": { + "description": "Azure resource Id", "readOnly": true, "type": "string" }, - "threatName": { - "description": "Threat name (e.g. \"Jedobot malware\")", + "name": { + "description": "Azure resource name", "readOnly": true, "type": "string" }, - "threatType": { - "description": "Threat type (e.g. \"Botnet\")", + "type": { + "description": "Azure resource type", "readOnly": true, "type": "string" + }, + "etag": { + "description": "Etag of the azure resource", + "type": "string" + } + }, + "x-ms-azure-resource": true + }, + "ScheduledAlertRule": { + "allOf": [ + { + "$ref": "#/definitions/AlertRule" + } + ], + "description": "Represents scheduled alert rule.", + "properties": { + "properties": { + "$ref": "#/definitions/ScheduledAlertRuleProperties", + "description": "Scheduled alert rule properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Scheduled" + }, + "ScheduledAlertRuleCommonProperties": { + "description": "Scheduled alert rule template property bag.", + "properties": { + "query": { + "description": "The query that creates alerts for this rule.", + "type": "string" + }, + "queryFrequency": { + "description": "The frequency (in ISO 8601 duration format) for this alert rule to run.", + "format": "duration", + "type": "string" + }, + "queryPeriod": { + "description": "The period (in ISO 8601 duration format) that this alert rule looks at.", + "format": "duration", + "type": "string" + }, + "severity": { + "$ref": "#/definitions/AlertSeverity", + "description": "The severity for alerts created by this alert rule." + }, + "triggerOperator": { + "$ref": "#/definitions/AlertRuleTriggerOperator", + "description": "The operation against the threshold that triggers alert rule." + }, + "triggerThreshold": { + "description": "The threshold triggers this alert rule.", + "type": "integer" + }, + "eventGroupingSettings": { + "$ref": "#/definitions/EventGroupingSettings", + "description": "The event grouping settings." } }, "type": "object" }, - "IPSyncer": { - "allOf": [ - { - "$ref": "#/definitions/Settings" - } - ], - "description": "Settings with single toggle.", - "properties": { - "properties": { - "$ref": "#/definitions/IPSyncerSettingsProperties", - "description": "IPSyncer properties", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "IPSyncer" - }, - "IPSyncerSettingsProperties": { - "description": "IPSyncer property bag.", + "EventGroupingSettings": { + "description": "Event grouping settings property bag.", "properties": { - "isEnabled": { - "description": "Determines whether the setting is enable or disabled.", - "readOnly": true, - "type": "boolean" + "aggregationKind": { + "$ref": "#/definitions/EventGroupingAggregationKind" } }, "type": "object" }, - "EyesOn": { + "EventGroupingAggregationKind": { + "description": "The event grouping aggregation kinds", + "enum": [ + "SingleAlert", + "AlertPerResult" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "EventGroupingAggregationKind" + } + }, + "ScheduledAlertRuleProperties": { "allOf": [ { - "$ref": "#/definitions/Settings" + "$ref": "#/definitions/ScheduledAlertRuleCommonProperties" } ], - "description": "Settings with single toggle.", - "properties": { - "properties": { - "$ref": "#/definitions/EyesOnSettingsProperties", - "description": "EyesOn properties", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "EyesOn" - }, - "EyesOnSettingsProperties": { - "description": "EyesOn property bag.", + "description": "Scheduled alert rule base property bag.", "properties": { - "isEnabled": { - "description": "Determines whether the setting is enable or disabled.", + "alertRuleTemplateName": { + "description": "The Name of the alert rule template used to create this rule.", + "type": "string" + }, + "description": { + "description": "The description of the alert rule.", + "type": "string" + }, + "displayName": { + "description": "The display name for alerts created by this alert rule.", + "type": "string" + }, + "enabled": { + "description": "Determines whether this alert rule is enabled or disabled.", + "type": "boolean" + }, + "lastModifiedUtc": { + "description": "The last time that this alert rule has been modified.", + "format": "date-time", "readOnly": true, + "type": "string" + }, + "suppressionDuration": { + "description": "The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered.", + "format": "duration", + "type": "string" + }, + "suppressionEnabled": { + "description": "Determines whether the suppression for this alert rule is enabled or disabled.", "type": "boolean" + }, + "tactics": { + "description": "The tactics of the alert rule", + "items": { + "$ref": "#/definitions/AttackTactic" + }, + "type": "array" + }, + "incidentConfiguration": { + "$ref": "#/definitions/IncidentConfiguration", + "description": "The settings of the incidents that created from alerts triggered by this analytics rule" } }, + "required": [ + "displayName", + "enabled", + "severity", + "query", + "queryFrequency", + "queryPeriod", + "triggerOperator", + "triggerThreshold", + "suppressionEnabled", + "suppressionDuration" + ], "type": "object" }, - "EntityAnalytics": { + "ScheduledAlertRuleTemplate": { "allOf": [ { - "$ref": "#/definitions/Settings" + "$ref": "#/definitions/AlertRuleTemplate" } ], - "description": "Settings with single toggle.", + "description": "Represents scheduled alert rule template.", "properties": { "properties": { - "$ref": "#/definitions/EntityAnalyticsProperties", - "description": "EntityAnalytics properties", + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplatePropertiesBase" + }, + { + "$ref": "#/definitions/ScheduledAlertRuleCommonProperties" + } + ], + "description": "Scheduled alert rule template properties", + "properties": { + "tactics": { + "description": "The tactics of the alert rule template", + "items": { + "$ref": "#/definitions/AttackTactic" + }, + "type": "array" + } + }, + "required": [ + "displayName", + "description", + "status", + "alertRulesCreatedByTemplateCount", + "severity", + "query", + "queryFrequency", + "queryPeriod", + "triggerOperator", + "triggerThreshold" + ], "x-ms-client-flatten": true } }, "type": "object", - "x-ms-discriminator-value": "EntityAnalytics" + "x-ms-discriminator-value": "Scheduled" }, - "EntityAnalyticsProperties": { - "description": "EntityAnalytics property bag.", + "IncidentConfiguration": { + "description": "Incident Configuration property bag.", "properties": { - "isEnabled": { - "description": "Determines whether the setting is enable or disabled.", - "readOnly": true, + "createIncident": { + "description": "Create incidents from alerts triggered by this analytics rule", "type": "boolean" - } - }, - "type": "object" - }, - "Ueba": { - "allOf": [ - { - "$ref": "#/definitions/Settings" - } - ], - "description": "Settings with single toggle.", - "properties": { - "properties": { - "$ref": "#/definitions/UebaProperties", - "description": "Ueba properties", - "x-ms-client-flatten": true + }, + "groupingConfiguration": { + "$ref": "#/definitions/GroupingConfiguration", + "description": "Set how the alerts that are triggered by this analytics rule, are grouped into incidents" } }, "type": "object", - "x-ms-discriminator-value": "Ueba" + "required": [ + "createIncident" + ] }, - "UebaProperties": { - "description": "Ueba property bag.", + "GroupingConfiguration": { + "description": "Grouping configuration property bag.", "properties": { - "dataSources": { - "description": "The relevant data sources that enriched by ueba", + "enabled": { + "description": "Grouping enabled", + "type": "boolean" + }, + "reopenClosedIncident": { + "description": "Re-open closed matching incidents", + "type": "boolean" + }, + "lookbackDuration": { + "description": "Limit the group to alerts created within the lookback duration (in ISO 8601 duration format)", + "format": "duration", + "type": "string" + }, + "entitiesMatchingMethod": { + "description": "Grouping matching method", + "enum": [ + "All", + "None", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "EntitiesMatchingMethod", + "values": [ + { + "description": "Grouping alerts into a single incident if all the entities match", + "value": "All" + }, + { + "description": "Grouping all alerts triggered by this rule into a single incident", + "value": "None" + }, + { + "description": "Grouping alerts into a single incident if the selected entities match", + "value": "Custom" + } + ] + } + }, + "groupByEntities": { + "description": "A list of entity types to group by (when entitiesMatchingMethod is Custom)", "items": { - "$ref": "#/definitions/UebaDataSources" + "description": "Grouping entity type", + "enum": [ + "Account", + "Host", + "Ip", + "Url", + "FileHash" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "GroupingEntityType", + "values": [ + { + "description": "Account entity", + "value": "Account" + }, + { + "description": "Host entity", + "value": "Host" + }, + { + "description": "Ip entity", + "value": "Ip" + }, + { + "description": "Url entity", + "value": "Url" + }, + { + "description": "FileHash entity", + "value": "FileHash" + } + ] + } }, "type": "array" } }, - "type": "object" - }, - "UebaDataSources": { - "description": "The data source that enriched by ueba.", - "enum": [ - "AuditLogs", - "AzureActivity", - "SecurityEvent", - "SigninLogs" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "UebaDataSources" - } + "type": "object", + "required": [ + "enabled", + "reopenClosedIncident", + "lookbackDuration", + "entitiesMatchingMethod" + ] }, - "UrlEntity": { + "SecurityAlert": { "allOf": [ { "$ref": "#/definitions/Entity" } ], - "description": "Represents a url entity.", + "description": "Represents a security alert entity.", "properties": { "properties": { - "$ref": "#/definitions/UrlEntityProperties", - "description": "Url entity properties", + "$ref": "#/definitions/SecurityAlertProperties", + "description": "SecurityAlert entity properties", "x-ms-client-flatten": true } }, "type": "object", - "x-ms-discriminator-value": "Url" + "x-ms-discriminator-value": "SecurityAlert" }, - "UrlEntityProperties": { + "SecurityAlertProperties": { "allOf": [ { "$ref": "#/definitions/EntityCommonProperties" } ], - "description": "Url entity property bag.", + "description": "SecurityAlert entity property bag.", "properties": { - "url": { - "description": "A full URL the entity points to", + "alertDisplayName": { + "description": "The display name of the alert.", "readOnly": true, "type": "string" - } - }, - "type": "object" - }, - "IoTDeviceEntity": { - "allOf": [ - { - "$ref": "#/definitions/Entity" - } - ], - "description": "Represents an IoT device entity.", - "properties": { - "properties": { - "$ref": "#/definitions/IoTDeviceEntityProperties", - "description": "IoTDevice entity properties", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "IoTDevice" - }, - "IoTDeviceEntityProperties": { - "allOf": [ - { - "$ref": "#/definitions/EntityCommonProperties" - } - ], - "description": "IoTDevice entity property bag.", - "properties": { - "deviceId": { - "description": "The ID of the IoT Device in the IoT Hub", + }, + "alertType": { + "description": "The type name of the alert.", + "readOnly": true, + "type": "string" + }, + "compromisedEntity": { + "description": "Display name of the main entity being reported on.", + "readOnly": true, + "type": "string" + }, + "confidenceLevel": { + "description": "The confidence level of this alert.", + "enum": [ + "Unknown", + "Low", + "High" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ConfidenceLevel", + "values": [ + { + "description": "Unknown confidence, the is the default value", + "value": "Unknown" + }, + { + "description": "Low confidence, meaning we have some doubts this is indeed malicious or part of an attack", + "value": "Low" + }, + { + "description": "High confidence that the alert is true positive malicious", + "value": "High" + } + ] + } + }, + "confidenceReasons": { + "description": "The confidence reasons", + "items": { + "description": "confidence reason item", + "properties": { + "reason": { + "description": "The reason's description", + "readOnly": true, + "type": "string" + }, + "reasonType": { + "description": "The type (category) of the reason", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "readOnly": true, + "type": "array" + }, + "confidenceScore": { + "description": "The confidence score of the alert.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "confidenceScoreStatus": { + "description": "The confidence score calculation status, i.e. indicating if score calculation is pending for this alert, not applicable or final.", + "enum": [ + "NotApplicable", + "InProcess", + "NotFinal", + "Final" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ConfidenceScoreStatus", + "values": [ + { + "description": "Score will not be calculated for this alert as it is not supported by virtual analyst", + "value": "NotApplicable" + }, + { + "description": "No score was set yet and calculation is in progress", + "value": "InProcess" + }, + { + "description": "Score is calculated and shown as part of the alert, but may be updated again at a later time following the processing of additional data", + "value": "NotFinal" + }, + { + "description": "Final score was calculated and available", + "value": "Final" + } + ] + } + }, + "description": { + "description": "Alert description.", + "readOnly": true, + "type": "string" + }, + "endTimeUtc": { + "description": "The impact end time of the alert (the time of the last event contributing to the alert).", + "format": "date-time", "readOnly": true, "type": "string" }, - "deviceName": { - "description": "The friendly name of the device", + "intent": { + "description": "Holds the alert intent stage(s) mapping for this alert.", + "enum": [ + "Unknown", + "Probing", + "Exploitation", + "Persistence", + "PrivilegeEscalation", + "DefenseEvasion", + "CredentialAccess", + "Discovery", + "LateralMovement", + "Execution", + "Collection", + "Exfiltration", + "CommandAndControl", + "Impact" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "KillChainIntent", + "values": [ + { + "description": "The default value.", + "value": "Unknown" + }, + { + "description": "Probing could be an attempt to access a certain resource regardless of a malicious intent or a failed attempt to gain access to a target system to gather information prior to exploitation. This step is usually detected as an attempt originating from outside the network in attempt to scan the target system and find a way in.", + "value": "Probing" + }, + { + "description": "Exploitation is the stage where an attacker manage to get foothold on the attacked resource. This stage is applicable not only for compute hosts, but also for resources such as user accounts, certificates etc. Adversaries will often be able to control the resource after this stage.", + "value": "Exploitation" + }, + { + "description": "Persistence is any access, action, or configuration change to a system that gives an adversary a persistent presence on that system. Adversaries will often need to maintain access to systems through interruptions such as system restarts, loss of credentials, or other failures that would require a remote access tool to restart or alternate backdoor for them to regain access.", + "value": "Persistence" + }, + { + "description": "Privilege escalation is the result of actions that allow an adversary to obtain a higher level of permissions on a system or network. Certain tools or actions require a higher level of privilege to work and are likely necessary at many points throughout an operation. User accounts with permissions to access specific systems or perform specific functions necessary for adversaries to achieve their objective may also be considered an escalation of privilege.", + "value": "PrivilegeEscalation" + }, + { + "description": "Defense evasion consists of techniques an adversary may use to evade detection or avoid other defenses. Sometimes these actions are the same as or variations of techniques in other categories that have the added benefit of subverting a particular defense or mitigation. ", + "value": "DefenseEvasion" + }, + { + "description": "Credential access represents techniques resulting in access to or control over system, domain, or service credentials that are used within an enterprise environment. Adversaries will likely attempt to obtain legitimate credentials from users or administrator accounts (local system administrator or domain users with administrator access) to use within the network. With sufficient access within a network, an adversary can create accounts for later use within the environment.", + "value": "CredentialAccess" + }, + { + "description": "Discovery consists of techniques that allow the adversary to gain knowledge about the system and internal network. When adversaries gain access to a new system, they must orient themselves to what they now have control of and what benefits operating from that system give to their current objective or overall goals during the intrusion. The operating system provides many native tools that aid in this post-compromise information-gathering phase.", + "value": "Discovery" + }, + { + "description": "Lateral movement consists of techniques that enable an adversary to access and control remote systems on a network and could, but does not necessarily, include execution of tools on remote systems. The lateral movement techniques could allow an adversary to gather information from a system without needing additional tools, such as a remote access tool. An adversary can use lateral movement for many purposes, including remote Execution of tools, pivoting to additional systems, access to specific information or files, access to additional credentials, or to cause an effect.", + "value": "LateralMovement" + }, + { + "description": "The execution tactic represents techniques that result in execution of adversary-controlled code on a local or remote system. This tactic is often used in conjunction with lateral movement to expand access to remote systems on a network.", + "value": "Execution" + }, + { + "description": "Collection consists of techniques used to identify and gather information, such as sensitive files, from a target network prior to exfiltration. This category also covers locations on a system or network where the adversary may look for information to exfiltrate.", + "value": "Collection" + }, + { + "description": "Exfiltration refers to techniques and attributes that result or aid in the adversary removing files and information from a target network. This category also covers locations on a system or network where the adversary may look for information to exfiltrate.", + "value": "Exfiltration" + }, + { + "description": "The command and control tactic represents how adversaries communicate with systems under their control within a target network.", + "value": "CommandAndControl" + }, + { + "description": "The impact intent primary objective is to directly reduce the availability or integrity of a system, service, or network; including manipulation of data to impact a business or operational process. This would often refer to techniques such as ransom-ware, defacement, data manipulation and others.", + "value": "Impact" + } + ] + } + }, + "providerAlertId": { + "description": "The identifier of the alert inside the product which generated the alert.", "readOnly": true, "type": "string" }, - "source": { - "description": "The source of the device", + "processingEndTime": { + "description": "The time the alert was made available for consumption.", + "format": "date-time", "readOnly": true, "type": "string" }, - "iotSecurityAgentId": { - "description": "The ID of the security agent running on the device", - "format": "uuid", + "productComponentName": { + "description": "The name of a component inside the product which generated the alert.", "readOnly": true, "type": "string" }, - "deviceType": { - "description": "The type of the device", + "productName": { + "description": "The name of the product which published this alert.", "readOnly": true, "type": "string" }, - "vendor": { - "description": "The vendor of the device", + "productVersion": { + "description": "The version of the product generating the alert.", "readOnly": true, "type": "string" }, - "edgeId": { - "description": "The ID of the edge device", + "remediationSteps": { + "description": "Manual action items to take to remediate the alert.", + "items": { + "type": "string" + }, "readOnly": true, - "type": "string" + "type": "array" }, - "macAddress": { - "description": "The MAC address of the device", - "readOnly": true, - "type": "string" + "severity": { + "$ref": "#/definitions/AlertSeverity", + "description": "The severity of the alert" }, - "model": { - "description": "The model of the device", + "startTimeUtc": { + "description": "The impact start time of the alert (the time of the first event contributing to the alert).", + "format": "date-time", "readOnly": true, "type": "string" }, - "serialNumber": { - "description": "The serial number of the device", + "status": { + "description": "The lifecycle status of the alert.", + "enum": [ + "Unknown", + "New", + "Resolved", + "Dismissed", + "InProgress" + ], "readOnly": true, - "type": "string" + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AlertStatus", + "values": [ + { + "description": "Unknown value", + "value": "Unknown" + }, + { + "description": "New alert", + "value": "New" + }, + { + "description": "Alert closed after handling", + "value": "Resolved" + }, + { + "description": "Alert dismissed as false positive", + "value": "Dismissed" + }, + { + "description": "Alert is being handled", + "value": "InProgress" + } + ] + } }, - "firmwareVersion": { - "description": "The firmware version of the device", + "systemAlertId": { + "description": "Holds the product identifier of the alert for the product.", "readOnly": true, "type": "string" }, - "operatingSystem": { - "description": "The operating system of the device", + "tactics": { + "description": "The tactics of the alert", + "items": { + "$ref": "#/definitions/AttackTactic" + }, "readOnly": true, - "type": "string" + "type": "array" }, - "iotHubEntityId": { - "description": "The AzureResource entity id of the IoT Hub", + "timeGenerated": { + "description": "The time the alert was generated.", + "format": "date-time", "readOnly": true, "type": "string" }, - "hostEntityId": { - "description": "The Host entity id of this device", + "vendorName": { + "description": "The name of the vendor that raise the alert.", "readOnly": true, "type": "string" }, - "ipAddressEntityId": { - "description": "The IP entity if of this device", + "alertLink": { + "description": "The uri link of the alert.", "readOnly": true, "type": "string" }, - "threatIntelligence": { - "description": "A list of TI contexts attached to the IoTDevice entity.", - "items": { - "$ref": "#/definitions/ThreatIntelligence" - }, - "readOnly": true, - "type": "array" - }, - "protocols": { - "description": "A list of protocols of the IoTDevice entity.", + "resourceIdentifiers": { + "description": "The list of resource identifiers of the alert.", "items": { - "type": "string" + "type": "object" }, "readOnly": true, "type": "array" @@ -12930,824 +7259,707 @@ }, "type": "object" }, - "UserInfo": { - "description": "User information that made some action", + "SecurityGroupEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a security group entity.", "properties": { - "email": { - "description": "The email of the user.", + "properties": { + "$ref": "#/definitions/SecurityGroupEntityProperties", + "description": "SecurityGroup entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "SecurityGroup" + }, + "SecurityGroupEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "SecurityGroup entity property bag.", + "properties": { + "distinguishedName": { + "description": "The group distinguished name", "readOnly": true, "type": "string" }, - "name": { - "description": "The name of the user.", + "objectGuid": { + "description": "A single-value attribute that is the unique identifier for the object, assigned by active directory.", + "format": "uuid", "readOnly": true, "type": "string" }, - "objectId": { - "description": "The object id of the user.", - "format": "uuid", - "type": "string", - "x-nullable": true + "sid": { + "description": "The SID attribute is a single-value attribute that specifies the security identifier (SID) of the group", + "readOnly": true, + "type": "string" } }, "type": "object" }, - "IncidentInfo": { - "description": "Describes related incident information for the bookmark", + "SettingList": { + "description": "List of all the settings.", "properties": { - "incidentId": { - "description": "Incident Id", - "type": "string" + "value": { + "description": "Array of settings.", + "items": { + "$ref": "#/definitions/Settings" + }, + "type": "array" + } + }, + "required": [ + "value" + ] + }, + "Settings": { + "allOf": [ + { + "$ref": "#/definitions/ResourceWithEtag" }, - "severity": { - "description": "The severity of the incident", - "enum": [ - "Critical", - "High", - "Medium", - "Low", - "Informational" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "CaseSeverity", - "values": [ - { - "description": "Critical severity", - "value": "Critical" - }, - { - "description": "High severity", - "value": "High" - }, - { - "description": "Medium severity", - "value": "Medium" - }, - { - "description": "Low severity", - "value": "Low" - }, - { - "description": "Informational severity", - "value": "Informational" - } - ] + { + "$ref": "#/definitions/SettingsKind" + } + ], + "description": "The Setting.", + "discriminator": "kind", + "type": "object" + }, + "SettingsKind": { + "description": "Describes an Azure resource with kind.", + "properties": { + "kind": { + "description": "The kind of the setting", + "enum": [ + "Anomalies", + "EyesOn", + "EntityAnalytics", + "Ueba" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "SettingKind" } - }, - "title": { - "description": "The title of the incident", - "type": "string" - }, - "relationName": { - "description": "Relation Name", - "type": "string" } }, + "required": [ + "kind" + ], "type": "object" }, - "WatchlistList": { - "description": "List all the watchlists.", + "TIDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Data connector to pull threat intelligence data from TIP products.", "properties": { - "nextLink": { - "description": "URL to fetch the next set of watchlists.", - "readOnly": true, + "properties": { + "$ref": "#/definitions/TIDataConnectorProperties", + "description": "Threat Intelligence Platforms data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "ThreatIntelligence" + }, + "TIDataConnectorDataTypes": { + "description": "The available data types for Threat Intelligence Platforms data connector.", + "properties": { + "indicators": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Data type for Threat Intelligence Platforms data connector.", + "type": "object" + } + }, + "type": "object", + "required": [ + "indicators" + ] + }, + "TIDataConnectorProperties": { + "description": "TI (Threat Intelligence) data connector properties.", + "properties": { + "tenantId": { + "description": "The tenant id to connect to, and get the data from.", "type": "string" }, - "value": { - "description": "Array of watchlist.", - "items": { - "$ref": "#/definitions/Watchlist" - }, - "type": "array" + "tipLookbackPeriod": { + "description": "The lookback period for the feed to be imported.", + "format": "date-time", + "type": "string", + "x-nullable": true + }, + "dataTypes": { + "$ref": "#/definitions/TIDataConnectorDataTypes", + "description": "The available data types for the connector." } }, + "type": "object", "required": [ - "value" + "tenantId", + "dataTypes" ] }, - "Watchlist": { + "TiTaxiiDataConnector": { "allOf": [ { - "$ref": "#/definitions/ResourceWithEtag" + "$ref": "#/definitions/DataConnector" } ], - "description": "Represents a Watchlist in Azure Security Insights.", + "description": "Data connector to pull Threat intelligence data from TAXII 2.0/2.1 server", "properties": { "properties": { - "$ref": "#/definitions/WatchlistProperties", - "description": "Watchlist properties", + "$ref": "#/definitions/TiTaxiiDataConnectorProperties", + "description": "Threat intelligence TAXII data connector properties.", "x-ms-client-flatten": true } }, - "type": "object" + "type": "object", + "x-ms-discriminator-value": "ThreatIntelligenceTaxii" }, - "WatchlistProperties": { - "description": "Describes watchlist properties", + "TiTaxiiDataConnectorDataTypes": { + "description": "The available data types for Threat Intelligence TAXII data connector.", "properties": { - "watchlistId": { - "description": "The id (a Guid) of the watchlist", - "type": "string" - }, - "displayName": { - "description": "The display name of the watchlist", - "type": "string" - }, - "provider": { - "description": "The provider of the watchlist", - "type": "string" - }, - "source": { - "description": "The source of the watchlist", - "enum": [ - "Local file", - "Remote storage" + "taxiiClient": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "source" - } - }, - "created": { - "description": "The time the watchlist was created", - "format": "date-time", + "description": "Data type for TAXII connector.", + "type": "object" + } + }, + "type": "object", + "required": [ + "taxiiClient" + ] + }, + "TiTaxiiDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "Threat Intelligence TAXII data connector properties.", + "properties": { + "workspaceId": { + "description": "The workspace id.", "type": "string" }, - "updated": { - "description": "The last time the watchlist was updated", - "format": "date-time", + "friendlyName": { + "description": "The friendly name for the TAXII server.", "type": "string" }, - "createdBy": { - "$ref": "#/definitions/UserInfo", - "description": "Describes a user that created the watchlist", - "type": "object" - }, - "updatedBy": { - "$ref": "#/definitions/UserInfo", - "description": "Describes a user that updated the watchlist", - "type": "object" + "taxiiServer": { + "description": "The API root for the TAXII server.", + "type": "string" }, - "description": { - "description": "A description of the watchlist", + "collectionId": { + "description": "The collection id of the TAXII server.", "type": "string" }, - "watchlistType": { - "description": "The type of the watchlist", + "userName": { + "description": "The userName for the TAXII server.", "type": "string" }, - "watchlistAlias": { - "description": "The alias of the watchlist", + "password": { + "description": "The password for the TAXII server.", "type": "string" }, - "isDeleted": { - "description": "A flag that indicates if the watchlist is deleted or not", - "type": "boolean" + "taxiiLookbackPeriod": { + "description": "The lookback period for the TAXII server.", + "format": "date-time", + "type": "string", + "x-nullable": true }, - "labels": { - "description": "List of labels relevant to this watchlist", - "items": { - "$ref": "#/definitions/Label" - }, - "type": "array" + "pollingFrequency": { + "description": "The polling frequency for the TAXII server.", + "type": "string", + "x-nullable": true, + "enum": [ + "OnceAMinute", + "OnceAnHour", + "OnceADay" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "PollingFrequency", + "values": [ + { + "description": "Once a minute", + "value": "OnceAMinute" + }, + { + "description": "Once an hour", + "value": "OnceAnHour" + }, + { + "description": "Once a day", + "value": "OnceADay" + } + ] + } }, - "defaultDuration": { - "description": "The default duration of a watchlist (in ISO 8601 duration format)", - "format": "duration", - "type": "string" + "dataTypes": { + "$ref": "#/definitions/TiTaxiiDataConnectorDataTypes", + "description": "The available data types for Threat Intelligence TAXII data connector." + } + }, + "required": [ + "dataTypes", + "pollingFrequency" + ], + "type": "object" + }, + "ThreatIntelligence": { + "description": "ThreatIntelligence property bag.", + "properties": { + "confidence": { + "description": "Confidence (must be between 0 and 1)", + "format": "double", + "readOnly": true, + "type": "number" }, - "tenantId": { - "description": "The tenantId where the watchlist belongs to", + "providerName": { + "description": "Name of the provider from whom this Threat Intelligence information was received", + "readOnly": true, "type": "string" }, - "numberOfLinesToSkip": { - "description": "The number of lines in a csv/tsv content to skip before the header", - "type": "integer", - "format": "int32" - }, - "rawContent": { - "description": "The raw content that represents to watchlist items to create. In case of csv/tsv content type, it's the content of the file that will parsed by the endpoint", + "reportLink": { + "description": "Report link", + "readOnly": true, "type": "string" }, - "contentType": { - "description": "The content type of the raw content. Example : text/csv or text/tsv ", + "threatDescription": { + "description": "Threat description (free text)", + "readOnly": true, "type": "string" }, - "uploadStatus": { - "description": "The status of the Watchlist upload : New, InProgress or Complete. Pls note : When a Watchlist upload status is equal to InProgress, the Watchlist cannot be deleted", + "threatName": { + "description": "Threat name (e.g. \"Jedobot malware\")", + "readOnly": true, "type": "string" }, - "watchlistItemsCount": { - "description": "The number of Watchlist Items in the Watchlist", - "type": "integer", - "format": "int32" + "threatType": { + "description": "Threat type (e.g. \"Botnet\")", + "readOnly": true, + "type": "string" } }, - "required": [ - "displayName", - "source", - "provider" - ], "type": "object" }, - "WatchlistItemList": { - "description": "List all the watchlist items.", + "UserInfo": { + "description": "User information that made some action", "properties": { - "nextLink": { - "description": "URL to fetch the next set of watchlist item.", + "email": { + "description": "The email of the user.", "readOnly": true, "type": "string" }, - "value": { - "description": "Array of watchlist items.", - "items": { - "$ref": "#/definitions/WatchlistItem" - }, - "type": "array" + "name": { + "description": "The name of the user.", + "readOnly": true, + "type": "string" + }, + "objectId": { + "description": "The object id of the user.", + "format": "uuid", + "type": "string", + "x-nullable": true } }, - "required": [ - "value" - ] + "type": "object" }, - "WatchlistItem": { + "Anomalies": { "allOf": [ { - "$ref": "#/definitions/ResourceWithEtag" + "$ref": "#/definitions/Settings" } ], - "description": "Represents a Watchlist item in Azure Security Insights.", + "description": "Settings with single toggle.", "properties": { "properties": { - "$ref": "#/definitions/WatchlistItemProperties", - "description": "Watchlist Item properties", + "$ref": "#/definitions/AnomaliesProperties", + "description": "Anomalies properties", "x-ms-client-flatten": true } }, + "type": "object", + "x-ms-discriminator-value": "Anomalies" + }, + "AnomaliesProperties": { + "description": "Anomalies property bag.", + "properties": { + "isEnabled": { + "description": "Determines whether the setting is enable or disabled.", + "readOnly": true, + "type": "boolean" + } + }, "type": "object" }, - "WatchlistItemProperties": { - "description": "Describes watchlist item properties", + "IPSyncer": { + "allOf": [ + { + "$ref": "#/definitions/Settings" + } + ], + "description": "Settings with single toggle.", "properties": { - "watchlistItemType": { - "description": "The type of the watchlist item", - "type": "string" - }, - "watchlistItemId": { - "description": "The id (a Guid) of the watchlist item", - "type": "string" - }, - "tenantId": { - "description": "The tenantId to which the watchlist item belongs to", - "type": "string" - }, - "isDeleted": { - "description": "A flag that indicates if the watchlist item is deleted or not", + "properties": { + "$ref": "#/definitions/IPSyncerSettingsProperties", + "description": "IPSyncer properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "IPSyncer" + }, + "IPSyncerSettingsProperties": { + "description": "IPSyncer property bag.", + "properties": { + "isEnabled": { + "description": "Determines whether the setting is enable or disabled.", + "readOnly": true, "type": "boolean" - }, - "created": { - "description": "The time the watchlist item was created", - "format": "date-time", - "type": "string" - }, - "updated": { - "description": "The last time the watchlist item was updated", - "format": "date-time", - "type": "string" - }, - "createdBy": { - "$ref": "#/definitions/UserInfo", - "description": "Describes a user that created the watchlist item", - "type": "object" - }, - "updatedBy": { - "$ref": "#/definitions/UserInfo", - "description": "Describes a user that updated the watchlist item", - "type": "object" - }, - "itemsKeyValue": { - "description": "key-value pairs for a watchlist item", - "type": "object" - }, - "entityMapping": { - "description": "key-value pairs for a watchlist item entity mapping", - "type": "object" } }, - "required": [ - "itemsKeyValue" + "type": "object" + }, + "EyesOn": { + "allOf": [ + { + "$ref": "#/definitions/Settings" + } ], + "description": "Settings with single toggle.", + "properties": { + "properties": { + "$ref": "#/definitions/EyesOnSettingsProperties", + "description": "EyesOn properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "EyesOn" + }, + "EyesOnSettingsProperties": { + "description": "EyesOn property bag.", + "properties": { + "isEnabled": { + "description": "Determines whether the setting is enable or disabled.", + "readOnly": true, + "type": "boolean" + } + }, "type": "object" }, - "ThreatIntelligenceInformationList": { - "description": "List of all the threat intelligence information objects.", + "EntityAnalytics": { + "allOf": [ + { + "$ref": "#/definitions/Settings" + } + ], + "description": "Settings with single toggle.", "properties": { - "nextLink": { - "description": "URL to fetch the next set of information objects.", + "properties": { + "$ref": "#/definitions/EntityAnalyticsProperties", + "description": "EntityAnalytics properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "EntityAnalytics" + }, + "EntityAnalyticsProperties": { + "description": "EntityAnalytics property bag.", + "properties": { + "isEnabled": { + "description": "Determines whether the setting is enable or disabled.", "readOnly": true, - "type": "string" - }, - "value": { - "description": "Array of threat intelligence information objects.", + "type": "boolean" + } + }, + "type": "object" + }, + "Ueba": { + "allOf": [ + { + "$ref": "#/definitions/Settings" + } + ], + "description": "Settings with single toggle.", + "properties": { + "properties": { + "$ref": "#/definitions/UebaProperties", + "description": "Ueba properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Ueba" + }, + "UebaProperties": { + "description": "Ueba property bag.", + "properties": { + "dataSources": { + "description": "The relevant data sources that enriched by ueba", "items": { - "$ref": "#/definitions/ThreatIntelligenceInformation" + "$ref": "#/definitions/UebaDataSources" }, "type": "array" } }, - "required": [ - "value" - ] + "type": "object" }, - "ThreatIntelligenceInformation": { + "UebaDataSources": { + "description": "The data source that enriched by ueba.", + "enum": [ + "AuditLogs", + "AzureActivity", + "SecurityEvent", + "SigninLogs" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "UebaDataSources" + } + }, + "UrlEntity": { "allOf": [ { - "$ref": "#/definitions/ResourceWithEtag" - }, - { - "$ref": "#/definitions/ThreatIntelligenceResourceKind" + "$ref": "#/definitions/Entity" } ], - "description": "Threat intelligence information object.", - "discriminator": "kind", - "type": "object", - "required": [ - "kind" - ] + "description": "Represents a url entity.", + "properties": { + "properties": { + "$ref": "#/definitions/UrlEntityProperties", + "description": "Url entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Url" }, - "ThreatIntelligenceIndicatorModel": { + "UrlEntityProperties": { "allOf": [ { - "$ref": "#/definitions/ThreatIntelligenceInformation" + "$ref": "#/definitions/EntityCommonProperties" } ], - "description": "Threat intelligence indicator entity.", + "description": "Url entity property bag.", "properties": { - "properties": { - "$ref": "#/definitions/ThreatIntelligenceIndicatorProperties", - "description": "Threat Intelligence Entity properties", - "x-ms-client-flatten": true + "url": { + "description": "A full URL the entity points to", + "readOnly": true, + "type": "string" } }, - "type": "object", - "x-ms-discriminator-value": "indicator" + "type": "object" }, - "ThreatIntelligenceIndicatorModelForRequestBody": { + "IoTDeviceEntity": { "allOf": [ { - "$ref": "#/definitions/ThreatIntelligenceResourceKind" + "$ref": "#/definitions/Entity" } ], - "description": "Threat intelligence indicator entity used in request body.", + "description": "Represents an IoT device entity.", "properties": { - "etag": { - "description": "Etag of the azure resource", - "type": "string" - }, "properties": { - "$ref": "#/definitions/ThreatIntelligenceIndicatorProperties", - "description": "Threat Intelligence Entity properties", + "$ref": "#/definitions/IoTDeviceEntityProperties", + "description": "IoTDevice entity properties", "x-ms-client-flatten": true } }, "type": "object", - "x-ms-discriminator-value": "indicator" - }, - "ThreatIntelligenceResourceKind": { - "description": "Describes an entity with kind.", - "properties": { - "kind": { - "$ref": "#/definitions/ThreatIntelligenceResourceInnerKind", - "description": "The kind of the entity." - } - }, - "required": [ - "kind" - ], - "type": "object" - }, - "ThreatIntelligenceResourceInnerKind": { - "description": "The kind of the threat intelligence entity", - "enum": [ - "indicator" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "ThreatIntelligenceResourceKind", - "values": [ - { - "description": "Entity represents threat intelligence indicator in the system.", - "value": "indicator" - } - ] - } + "x-ms-discriminator-value": "IoTDevice" }, - "ThreatIntelligenceIndicatorProperties": { + "IoTDeviceEntityProperties": { "allOf": [ { "$ref": "#/definitions/EntityCommonProperties" } ], - "description": "Describes threat intelligence entity properties", + "description": "IoTDevice entity property bag.", "properties": { - "threatIntelligenceTags": { - "description": "List of tags", - "items": { - "description": "tag", - "type": "string" - }, - "type": "array" - }, - "lastUpdatedTimeUtc": { - "description": "Last updated time in UTC", - "type": "string" - }, - "source": { - "description": "Source of a threat intelligence entity", - "type": "string" - }, - "displayName": { - "description": "Display name of a threat intelligence entity", - "type": "string" - }, - "description": { - "description": "Description of a threat intelligence entity", - "type": "string" - }, - "indicatorTypes": { - "description": "Indicator types of threat intelligence entities", - "items": { - "description": "Indicator type of a threat intelligence entity", - "type": "string" - }, - "type": "array" - }, - "pattern": { - "description": "Pattern of a threat intelligence entity", - "type": "string" - }, - "patternType": { - "description": "Pattern type of a threat intelligence entity", - "type": "string" - }, - "patternVersion": { - "description": "Pattern version of a threat intelligence entity", - "type": "string" - }, - "killChainPhases": { - "description": "Kill chain phases", - "items": { - "description": "Kill chain phase", - "$ref": "#/definitions/ThreatIntelligenceKillChainPhase" - }, - "type": "array" - }, - "parsedPattern": { - "description": "Parsed patterns", - "items": { - "description": "Parsed pattern", - "$ref": "#/definitions/ThreatIntelligenceParsedPattern" - }, - "type": "array" - }, - "externalId": { - "description": "External ID of threat intelligence entity", - "type": "string" - }, - "createdByRef": { - "description": "Created by reference of threat intelligence entity", - "type": "string" - }, - "defanged": { - "description": "Is threat intelligence entity defanged", - "type": "boolean" - }, - "externalLastUpdatedTimeUtc": { - "description": "External last updated time in UTC", - "type": "string" - }, - "externalReferences": { - "description": "External References", - "items": { - "description": "external_reference", - "$ref": "#/definitions/ThreatIntelligenceExternalReference" - }, - "type": "array" - }, - "granularMarkings": { - "description": "Granular Markings", - "items": { - "description": "Granular marking", - "$ref": "#/definitions/ThreatIntelligenceGranularMarkingModel" - }, - "type": "array" - }, - "labels": { - "description": "Labels of threat intelligence entity", - "items": { - "description": "label", - "type": "string" - }, - "type": "array" - }, - "revoked": { - "description": "Is threat intelligence entity revoked", - "type": "boolean" - }, - "confidence": { - "description": "Confidence of threat intelligence entity", - "type": "integer", - "format": "int32" - }, - "objectMarkingRefs": { - "description": "Threat intelligence entity object marking references", - "items": { - "description": "Threat intelligence entity object marking reference", - "type": "string" - }, - "type": "array" - }, - "language": { - "description": "Language of threat intelligence entity", + "deviceId": { + "description": "The ID of the IoT Device in the IoT Hub", + "readOnly": true, "type": "string" }, - "threatTypes": { - "description": "Threat types", - "items": { - "description": "Threat type", - "type": "string" - }, - "type": "array" - }, - "validFrom": { - "description": "Valid from", + "deviceName": { + "description": "The friendly name of the device", + "readOnly": true, "type": "string" }, - "validUntil": { - "description": "Valid until", + "source": { + "description": "The source of the device", + "readOnly": true, "type": "string" }, - "created": { - "description": "Created by", + "iotSecurityAgentId": { + "description": "The ID of the security agent running on the device", + "format": "uuid", + "readOnly": true, "type": "string" }, - "modified": { - "description": "Modified by", + "deviceType": { + "description": "The type of the device", + "readOnly": true, "type": "string" }, - "extensions": { - "description": "Extensions map", - "type": "object", - "additionalProperties": {} - } - }, - "type": "object" - }, - "ThreatIntelligenceKillChainPhase": { - "description": "Describes threat kill chain phase entity", - "properties": { - "killChainName": { - "description": "Kill chainName name", + "vendor": { + "description": "The vendor of the device", + "readOnly": true, "type": "string" }, - "phaseName": { - "description": "Phase name", - "type": "string" - } - }, - "type": "object" - }, - "ThreatIntelligenceParsedPattern": { - "description": "Describes parsed pattern entity", - "properties": { - "patternTypeKey": { - "description": "Pattern type key", + "edgeId": { + "description": "The ID of the edge device", + "readOnly": true, "type": "string" }, - "patternTypeValues": { - "description": "Pattern type keys", - "items": { - "description": "Pattern type key", - "$ref": "#/definitions/ThreatIntelligenceParsedPatternTypeValue" - }, - "type": "array" - } - }, - "type": "object" - }, - "ThreatIntelligenceParsedPatternTypeValue": { - "description": "Describes threat kill chain phase entity", - "properties": { - "valueType": { - "description": "Type of the value", + "macAddress": { + "description": "The MAC address of the device", + "readOnly": true, "type": "string" }, - "value": { - "description": "Value of parsed pattern", - "type": "string" - } - }, - "type": "object" - }, - "ThreatIntelligenceGranularMarkingModel": { - "description": "Describes threat granular marking model entity", - "properties": { - "language": { - "description": "Language granular marking model", + "model": { + "description": "The model of the device", + "readOnly": true, "type": "string" }, - "markingRef": { - "description": "marking reference granular marking model", - "type": "integer", - "format": "int32" - }, - "selectors": { - "description": "granular marking model selectors", - "items": { - "description": "granular marking model selector", - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "ThreatIntelligenceExternalReference": { - "description": "Describes external reference", - "properties": { - "description": { - "description": "External reference description", + "serialNumber": { + "description": "The serial number of the device", + "readOnly": true, "type": "string" }, - "externalId": { - "description": "External reference ID", + "firmwareVersion": { + "description": "The firmware version of the device", + "readOnly": true, "type": "string" }, - "sourceName": { - "description": "External reference source name", + "operatingSystem": { + "description": "The operating system of the device", + "readOnly": true, "type": "string" }, - "url": { - "description": "External reference URL", + "iotHubEntityId": { + "description": "The AzureResource entity id of the IoT Hub", + "readOnly": true, "type": "string" }, - "hashes": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "External reference hashes" - } - }, - "type": "object" - }, - "ThreatIntelligenceFilteringCriteria": { - "description": "Filtering criteria for querying threat intelligence indicators.", - "properties": { - "pageSize": { - "description": "Page size", - "type": "integer", - "format": "int32" - }, - "minConfidence": { - "description": "Minimum confidence.", - "type": "integer", - "format": "int32" - }, - "maxConfidence": { - "description": "Maximum confidence.", - "type": "integer", - "format": "int32" - }, - "minValidUntil": { - "description": "Start time for ValidUntil filter.", + "hostEntityId": { + "description": "The Host entity id of this device", + "readOnly": true, "type": "string" }, - "maxValidUntil": { - "description": "End time for ValidUntil filter.", + "ipAddressEntityId": { + "description": "The IP entity if of this device", + "readOnly": true, "type": "string" }, - "includeDisabled": { - "description": "Parameter to include/exclude disabled indicators.", - "type": "boolean" - }, - "sortBy": { - "description": "Columns to sort by and sorting order", - "items": { - "description": "Sort By", - "$ref": "#/definitions/ThreatIntelligenceSortingCriteria" - }, - "type": "array" - }, - "sources": { - "description": "Sources of threat intelligence indicators", - "items": { - "description": "Source", - "type": "string" - }, - "type": "array" - }, - "patternTypes": { - "description": "Pattern types", - "items": { - "description": "Pattern type", - "type": "string" - }, - "type": "array" - }, - "threatTypes": { - "description": "Threat types of threat intelligence indicators", - "items": { - "description": "Threat type of a threat intelligence indicator", - "type": "string" - }, - "type": "array" - }, - "ids": { - "description": "Ids of threat intelligence indicators", + "threatIntelligence": { + "description": "A list of TI contexts attached to the IoTDevice entity.", "items": { - "description": "Id of a threat intelligence indicator", - "type": "string" + "$ref": "#/definitions/ThreatIntelligence" }, + "readOnly": true, "type": "array" }, - "keywords": { - "description": "Keywords for searching threat intelligence indicators", + "protocols": { + "description": "A list of protocols of the IoTDevice entity.", "items": { - "description": "keyword for searching threat intelligence indicators", "type": "string" }, + "readOnly": true, "type": "array" - }, - "skipToken": { - "description": "Skip token.", - "type": "string" } }, "type": "object" }, - "ThreatIntelligenceSortingCriteria": { - "description": "List of available columns for sorting", + "IncidentInfo": { + "description": "Describes related incident information for the bookmark", "properties": { - "itemKey": { - "description": "Column name", + "incidentId": { + "description": "Incident Id", "type": "string" }, - "sortOrder": { - "$ref": "#/definitions/ThreatIntelligenceSortingOrder", - "description": "Sorting order (ascending/descending/unsorted)." - } - }, - "type": "object" - }, - "ThreatIntelligenceSortingOrder": { - "description": "Sorting order (ascending/descending/unsorted).", - "enum": [ - "unsorted", - "ascending", - "descending" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "ThreatIntelligenceSortingCriteria", - "values": [ - { - "value": "unsorted" - }, - { - "value": "ascending" - }, - { - "value": "descending" + "severity": { + "description": "The severity of the incident", + "enum": [ + "Critical", + "High", + "Medium", + "Low", + "Informational" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "CaseSeverity", + "values": [ + { + "description": "Critical severity", + "value": "Critical" + }, + { + "description": "High severity", + "value": "High" + }, + { + "description": "Medium severity", + "value": "Medium" + }, + { + "description": "Low severity", + "value": "Low" + }, + { + "description": "Informational severity", + "value": "Informational" + } + ] } - ] - } - }, - "ThreatIntelligenceAppendTags": { - "description": "Array of tags to be appended to the threat intelligence indicator.", - "properties": { - "threatIntelligenceTags": { - "description": "List of tags to be appended.", - "items": { - "description": "parameter", - "type": "string" - }, - "type": "array" + }, + "title": { + "description": "The title of the incident", + "type": "string" + }, + "relationName": { + "description": "Relation Name", + "type": "string" } }, "type": "object" }, - "ThreatIntelligenceMetricsList": { - "description": "List of all the threat intelligence metric fields (type/threat type/source).", + "WatchlistList": { + "description": "List all the watchlists.", "properties": { + "nextLink": { + "description": "URL to fetch the next set of watchlists.", + "readOnly": true, + "type": "string" + }, "value": { - "description": "Array of threat intelligence metric fields (type/threat type/source).", + "description": "Array of watchlist.", "items": { - "$ref": "#/definitions/ThreatIntelligenceMetrics" + "$ref": "#/definitions/Watchlist" }, "type": "array" } @@ -13756,294 +7968,219 @@ "value" ] }, - "ThreatIntelligenceMetrics": { - "description": "Threat intelligence metrics.", + "Watchlist": { + "allOf": [ + { + "$ref": "#/definitions/ResourceWithEtag" + } + ], + "description": "Represents a Watchlist in Azure Security Insights.", "properties": { "properties": { - "description": "Threat intelligence metrics.", - "$ref": "#/definitions/ThreatIntelligenceMetric" + "$ref": "#/definitions/WatchlistProperties", + "description": "Watchlist properties", + "x-ms-client-flatten": true } - } + }, + "type": "object" }, - "ThreatIntelligenceMetric": { - "description": "Describes threat intelligence metric", + "WatchlistProperties": { + "description": "Describes watchlist properties", "properties": { - "lastUpdatedTimeUtc": { - "description": "Last updated indicator metric", + "watchlistId": { + "description": "The id (a Guid) of the watchlist", "type": "string" }, - "threatTypeMetrics": { - "description": "Threat type metrics", - "items": { - "description": "parameter", - "$ref": "#/definitions/ThreatIntelligenceMetricEntity" - }, - "type": "array" - }, - "patternTypeMetrics": { - "description": "Pattern type metrics", - "items": { - "description": "parameter", - "$ref": "#/definitions/ThreatIntelligenceMetricEntity" - }, - "type": "array" + "displayName": { + "description": "The display name of the watchlist", + "type": "string" }, - "sourceMetrics": { - "description": "Source metrics", - "items": { - "description": "parameter", - "$ref": "#/definitions/ThreatIntelligenceMetricEntity" - }, - "type": "array" - } - }, - "type": "object" - }, - "ThreatIntelligenceMetricEntity": { - "description": "Describes threat intelligence metric entity", - "properties": { - "metricName": { - "description": "Metric name", + "provider": { + "description": "The provider of the watchlist", "type": "string" }, - "metricValue": { - "description": "Metric value", - "type": "integer", - "format": "int32" - } - }, - "type": "object" - }, - "EntityGetInsightsParameters": { - "description": "The parameters required to execute insights operation on the given entity.", - "type": "object", - "properties": { - "startTime": { - "description": "The start timeline date, so the results returned are after this date.", + "source": { + "description": "The source of the watchlist", + "enum": [ + "Local file", + "Remote storage" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "source" + } + }, + "created": { + "description": "The time the watchlist was created", "format": "date-time", "type": "string" }, - "endTime": { - "description": "The end timeline date, so the results returned are before this date.", + "updated": { + "description": "The last time the watchlist was updated", "format": "date-time", "type": "string" }, - "addDefaultExtendedTimeRange": { - "description": "Indicates if query time range should be extended with default time range of the query. Default value is false", - "type": "boolean" + "createdBy": { + "$ref": "#/definitions/UserInfo", + "description": "Describes a user that created the watchlist", + "type": "object" }, - "insightQueryIds": { - "description": "List of Insights Query Id. If empty, default value is all insights of this entity", - "type": "array", - "items": { - "description": "Insight Query Id (GUID)", - "format": "uuid", - "type": "string" - } - } - }, - "required": [ - "startTime", - "endTime" - ] - }, - "EntityGetInsightsResponse": { - "description": "The Get Insights result operation response.", - "properties": { - "metaData": { - "$ref": "#/definitions/GetInsightsResultsMetadata", - "description": "The metadata from the get insights operation results." + "updatedBy": { + "$ref": "#/definitions/UserInfo", + "description": "Describes a user that updated the watchlist", + "type": "object" }, - "value": { - "description": "The insights result values.", + "description": { + "description": "A description of the watchlist", + "type": "string" + }, + "watchlistType": { + "description": "The type of the watchlist", + "type": "string" + }, + "watchlistAlias": { + "description": "The alias of the watchlist", + "type": "string" + }, + "isDeleted": { + "description": "A flag that indicates if the watchlist is deleted or not", + "type": "boolean" + }, + "labels": { + "description": "List of labels relevant to this watchlist", "items": { - "$ref": "#/definitions/EntityInsightItem" + "$ref": "#/definitions/Label" }, "type": "array" - } - } - }, - "GetInsightsResultsMetadata": { - "description": "Get Insights result metadata.", - "properties": { - "totalCount": { - "description": "the total items found for the insights request", + }, + "defaultDuration": { + "description": "The default duration of a watchlist (in ISO 8601 duration format)", + "format": "duration", + "type": "string" + }, + "tenantId": { + "description": "The tenantId where the watchlist belongs to", + "type": "string" + }, + "numberOfLinesToSkip": { + "description": "The number of lines in a csv/tsv content to skip before the header", "type": "integer", "format": "int32" }, - "errors": { - "description": "information about the failed queries", - "items": { - "$ref": "#/definitions/GetInsightsError" - }, - "type": "array" + "rawContent": { + "description": "The raw content that represents to watchlist items to create. In case of csv/tsv content type, it's the content of the file that will parsed by the endpoint", + "type": "string" + }, + "contentType": { + "description": "The content type of the raw content. Example : text/csv or text/tsv ", + "type": "string" + }, + "uploadStatus": { + "description": "The status of the Watchlist upload : New, InProgress or Complete. Pls note : When a Watchlist upload status is equal to InProgress, the Watchlist cannot be deleted", + "type": "string" + }, + "watchlistItemsCount": { + "description": "The number of Watchlist Items in the Watchlist", + "type": "integer", + "format": "int32" } }, "required": [ - "totalCount" + "displayName", + "source", + "provider" ], "type": "object" }, - "GetInsightsError": { - "description": "GetInsights Query Errors.", + "WatchlistItemList": { + "description": "List all the watchlist items.", "properties": { - "kind": { - "description": "the query kind", - "type": "string", - "enum": [ - "Insight" - ] - }, - "queryId": { - "description": "the query id", + "nextLink": { + "description": "URL to fetch the next set of watchlist item.", + "readOnly": true, "type": "string" }, - "errorMessage": { - "description": "the error message", - "type": "string" + "value": { + "description": "Array of watchlist items.", + "items": { + "$ref": "#/definitions/WatchlistItem" + }, + "type": "array" } }, "required": [ - "kind", - "errorMessage" - ], - "type": "object" + "value" + ] }, - "EntityQueryItem": { - "description": "An abstract Query item for entity", - "type": "object", - "discriminator": "kind", + "WatchlistItem": { "allOf": [ { - "$ref": "#/definitions/EntityQueryKind" + "$ref": "#/definitions/ResourceWithEtag" + } + ], + "description": "Represents a Watchlist item in Azure Security Insights.", + "properties": { + "properties": { + "$ref": "#/definitions/WatchlistItemProperties", + "description": "Watchlist Item properties", + "x-ms-client-flatten": true } - ], + }, + "type": "object" + }, + "WatchlistItemProperties": { + "description": "Describes watchlist item properties", "properties": { - "id": { - "description": "Query Template ARM ID", - "type": "string", - "readOnly": true + "watchlistItemType": { + "description": "The type of the watchlist item", + "type": "string" }, - "name": { - "description": "Query Template ARM Name", + "watchlistItemId": { + "description": "The id (a Guid) of the watchlist item", "type": "string" }, - "type": { - "description": "ARM Type", + "tenantId": { + "description": "The tenantId to which the watchlist item belongs to", "type": "string" - } - }, - "required": [ - "kind" - ] - }, - "EntityQueryItemProperties": { - "description": "An properties abstract Query item for entity", - "type": "object", - "properties": { - "dataTypes": { - "description": "Data types for template", - "type": "array", - "items": { - "properties": { - "dataType": { - "description": "Data type name", - "type": "string" - } - } - } }, - "inputEntityType": { - "description": "The type of the entity", - "$ref": "#/definitions/EntityInnerType" + "isDeleted": { + "description": "A flag that indicates if the watchlist item is deleted or not", + "type": "boolean" }, - "requiredInputFieldsSets": { - "description": "Data types for template", - "type": "array", - "items": { - "type": "array", - "items": { - "type": "string" - } - } + "created": { + "description": "The time the watchlist item was created", + "format": "date-time", + "type": "string" }, - "entitiesFilter": { - "description": "The query applied only to entities matching to all filters", - "type": "object" - } - } - }, - "EntityInsightItem": { - "description": "Entity insight Item.", - "type": "object", - "properties": { - "queryId": { - "type": "string", - "description": "The query id of the insight" + "updated": { + "description": "The last time the watchlist item was updated", + "format": "date-time", + "type": "string" }, - "queryTimeInterval": { - "type": "object", - "description": "The Time interval that the query actually executed on.", - "properties": { - "startTime": { - "format": "date-time", - "type": "string", - "description": "Insight query start time" - }, - "endTime": { - "format": "date-time", - "type": "string", - "description": "Insight query end time" - } - } + "createdBy": { + "$ref": "#/definitions/UserInfo", + "description": "Describes a user that created the watchlist item", + "type": "object" }, - "tableQueryResults": { - "$ref": "#/definitions/InsightsTableResult", - "description": "Query results for table insights query." + "updatedBy": { + "$ref": "#/definitions/UserInfo", + "description": "Describes a user that updated the watchlist item", + "type": "object" }, - "chartQueryResults": { - "type": "array", - "description": "Query results for table insights query.", - "items": { - "$ref": "#/definitions/InsightsTableResult", - "description": "Query results for table insights query." - } - } - } - }, - "InsightsTableResult": { - "type": "object", - "description": "Query results for table insights query.", - "properties": { - "columns": { - "type": "array", - "description": "Columns Metadata of the table", - "items": { - "properties": { - "type": { - "type": "string", - "description": "the type of the colum" - }, - "name": { - "type": "string", - "description": "the name of the colum" - } - } - } + "itemsKeyValue": { + "description": "key-value pairs for a watchlist item", + "type": "object" }, - "rows": { - "type": "array", - "description": "Rows data of the table", - "items": { - "type": "array", - "description": "Single row of data", - "items": { - "type": "string", - "description": "Cell in the table" - } - } + "entityMapping": { + "description": "key-value pairs for a watchlist item entity mapping", + "type": "object" } - } + }, + "required": [ + "itemsKeyValue" + ], + "type": "object" } }, "parameters": { @@ -14065,14 +8202,6 @@ "type": "string", "x-ms-parameter-location": "method" }, - "AggregationsName": { - "description": "The aggregation name. Supports - Cases", - "in": "path", - "name": "aggregationsName", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, "AlertRule": { "description": "The alert rule", "in": "body", @@ -14091,24 +8220,6 @@ "type": "string", "x-ms-parameter-location": "method" }, - "AutomationRule": { - "description": "The automation rule", - "in": "body", - "name": "automationRule", - "required": true, - "schema": { - "$ref": "#/definitions/AutomationRule" - }, - "x-ms-parameter-location": "method" - }, - "AutomationRuleId": { - "description": "Automation rule ID", - "in": "path", - "name": "automationRuleId", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, "ApiVersion": { "description": "API version for the operation", "enum": [ @@ -14119,16 +8230,6 @@ "required": true, "type": "string" }, - "Bookmark": { - "description": "The bookmark", - "in": "body", - "name": "bookmark", - "required": true, - "schema": { - "$ref": "#/definitions/Bookmark" - }, - "x-ms-parameter-location": "method" - }, "RelationName": { "name": "relationName", "in": "path", @@ -14137,68 +8238,6 @@ "description": "Relation Name", "x-ms-parameter-location": "method" }, - "RelationInputModel": { - "name": "relationInputModel", - "in": "body", - "description": "The relation input model", - "required": true, - "schema": { - "$ref": "#/definitions/RelationsModelInput" - }, - "x-ms-parameter-location": "method" - }, - "BookmarkId": { - "description": "Bookmark ID", - "in": "path", - "name": "bookmarkId", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "Case": { - "description": "The case", - "in": "body", - "name": "case", - "required": true, - "schema": { - "$ref": "#/definitions/Case" - }, - "x-ms-parameter-location": "method" - }, - "CaseComment": { - "description": "The case comment", - "in": "body", - "name": "caseComment", - "required": true, - "schema": { - "$ref": "#/definitions/CaseComment" - }, - "x-ms-parameter-location": "method" - }, - "CaseCommentId": { - "description": "Case comment ID", - "in": "path", - "name": "caseCommentId", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "CaseId": { - "description": "Case ID", - "in": "path", - "name": "caseId", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ConsentId": { - "description": "consent ID", - "in": "path", - "name": "consentId", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, "DataConnector": { "description": "The data connector", "in": "body", @@ -14217,80 +8256,6 @@ "type": "string", "x-ms-parameter-location": "method" }, - "DataConnectorsCheckRequirementsBody": { - "description": "The parameters for requirements check message", - "in": "body", - "name": "DataConnectorsCheckRequirements", - "required": true, - "schema": { - "$ref": "#/definitions/DataConnectorsCheckRequirements" - }, - "x-ms-parameter-location": "method" - }, - "EnrichmentDomain": { - "description": "Domain name to be enriched", - "in": "query", - "name": "domain", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "EnrichmentIpAddress": { - "description": "IP address (v4 or v6) to be enriched", - "in": "query", - "name": "ipAddress", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "EntityExpandRequestBody": { - "description": "The parameters required to execute an expand operation on the given entity.", - "in": "body", - "name": "parameters", - "required": true, - "schema": { - "$ref": "#/definitions/EntityExpandParameters" - }, - "x-ms-parameter-location": "method" - }, - "BookmarkExpandRequestBody": { - "description": "The parameters required to execute an expand operation on the given bookmark.", - "in": "body", - "name": "parameters", - "required": true, - "schema": { - "$ref": "#/definitions/BookmarkExpandParameters" - }, - "x-ms-parameter-location": "method" - }, - "EntityTimelineRequestBody": { - "description": "The parameters required to execute an timeline operation on the given entity.", - "in": "body", - "name": "parameters", - "required": true, - "schema": { - "$ref": "#/definitions/EntityTimelineParameters" - }, - "x-ms-parameter-location": "method" - }, - "GetInsightsEntityQueriesRequestBody": { - "description": "The parameters required to execute insights on the given entity.", - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/EntityGetInsightsParameters" - }, - "x-ms-parameter-location": "method" - }, - "EntityId": { - "description": "entity ID", - "in": "path", - "name": "entityId", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, "EntityQueryId": { "description": "entity query ID", "in": "path", @@ -14335,27 +8300,6 @@ "type": "string", "x-ms-parameter-location": "method" }, - "EntityQueryKindParam": { - "description": "The Kind parameter for queries", - "in": "query", - "name": "kind", - "required": true, - "type": "string", - "enum": [ - "Insight" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "EntityItemQueryKind", - "values": [ - { - "description": "insight", - "value": "Insight" - } - ] - }, - "x-ms-parameter-location": "method" - }, "ODataFilter": { "description": "Filters the results, based on a Boolean condition. Optional.", "in": "query", @@ -14437,7 +8381,7 @@ "x-ms-parameter-location": "method" }, "SettingsName": { - "description": "The setting name. Supports - EyesOn, EntityAnalytics, Ueba", + "description": "The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba", "in": "path", "name": "settingsName", "required": true, @@ -14497,62 +8441,6 @@ "required": true, "type": "string", "x-ms-parameter-location": "method" - }, - "ThreatIntelligenceName": { - "description": "Threat intelligence indicator name field.", - "in": "path", - "name": "name", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ThreatIntelligenceProperties": { - "description": "Properties of threat intelligence indicators to create and update.", - "in": "body", - "name": "ThreatIntelligenceProperties", - "required": true, - "schema": { - "$ref": "#/definitions/ThreatIntelligenceIndicatorModelForRequestBody" - }, - "x-ms-parameter-location": "method" - }, - "ThreatIntelligenceReplaceTags": { - "description": "Tags in the threat intelligence indicator to be replaced.", - "in": "body", - "name": "ThreatIntelligenceReplaceTags", - "required": true, - "schema": { - "$ref": "#/definitions/ThreatIntelligenceIndicatorModelForRequestBody" - }, - "x-ms-parameter-location": "method" - }, - "ThreatIntelligenceFilteringCriteria": { - "description": "Filtering criteria for querying threat intelligence indicators.", - "in": "body", - "name": "ThreatIntelligenceFilteringCriteria", - "required": true, - "schema": { - "$ref": "#/definitions/ThreatIntelligenceFilteringCriteria" - }, - "x-ms-parameter-location": "method" - }, - "ThreatIntelligenceIndicatorEntityKind": { - "description": "The threat intelligence entity kind", - "in": "query", - "name": "ctiEntityKind", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ThreatIntelligenceAppendTags": { - "description": "The threat intelligence append tags request body", - "in": "body", - "name": "ThreatIntelligenceAppendTags", - "required": true, - "schema": { - "$ref": "#/definitions/ThreatIntelligenceAppendTags" - }, - "x-ms-parameter-location": "method" } } } diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/ThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/ThreatIntelligence.json new file mode 100644 index 000000000000..a860224c3c83 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/ThreatIntelligence.json @@ -0,0 +1,1129 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2019-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/createIndicator": { + "post": { + "x-ms-examples": { + "Create a new Threat Intelligence": { + "$ref": "./examples/threatintelligence/CreateThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Create a new threat intelligence indicator.", + "operationId": "ThreatIntelligenceIndicator_CreateIndicator", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceProperties" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed to create indicators.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators": { + "get": { + "x-ms-examples": { + "Get all threat intelligence indicators": { + "$ref": "./examples/threatintelligence/GetThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Get all threat intelligence indicators.", + "operationId": "ThreatIntelligenceIndicators_List", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "SecurityInsights.json#/parameters/ODataFilter" + }, + { + "$ref": "SecurityInsights.json#/parameters/ODataOrderBy" + }, + { + "$ref": "SecurityInsights.json#/parameters/ODataTop" + }, + { + "$ref": "SecurityInsights.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformationList" + } + }, + "default": { + "description": "Error response describing why the operation failed to get indicators.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators/{name}": { + "get": { + "x-ms-examples": { + "View a threat intelligence indicator by name": { + "$ref": "./examples/threatintelligence/GetThreatIntelligenceById.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "View a threat intelligence indicator by name.", + "operationId": "ThreatIntelligenceIndicator_Get", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed to view an indicator.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Update a threat Intelligence indicator": { + "$ref": "./examples/threatintelligence/UpdateThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Update a threat Intelligence indicator.", + "operationId": "ThreatIntelligenceIndicator_Create", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceProperties" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed to update an indicator.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a threat intelligence indicator": { + "$ref": "./examples/threatintelligence/DeleteThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Delete a threat intelligence indicator.", + "operationId": "ThreatIntelligenceIndicator_Delete", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed to delete an indicator.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/queryIndicators": { + "post": { + "x-ms-examples": { + "Query threat intelligence indicators as per filtering criteria": { + "$ref": "./examples/threatintelligence/QueryThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Query threat intelligence indicators as per filtering criteria.", + "operationId": "ThreatIntelligenceIndicator_QueryIndicators", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceFilteringCriteria" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/metrics": { + "get": { + "x-ms-examples": { + "Get threat intelligence indicators metrics.": { + "$ref": "./examples/threatintelligence/CollectThreatIntelligenceMetrics.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Get threat intelligence indicators metrics (Indicators counts by Type, Threat Type, Source).", + "operationId": "ThreatIntelligenceIndicatorMetrics_List", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceMetricsList" + } + }, + "default": { + "description": "Error response describing why the operation failed to get metrics.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators/{name}/appendTags": { + "post": { + "x-ms-examples": { + "Append tags to a threat intelligence indicator": { + "$ref": "./examples/threatintelligence/AppendTagsThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Append tags to a threat intelligence indicator.", + "operationId": "ThreatIntelligenceIndicator_AppendTags", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceAppendTags" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed to append tags.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators/{name}/replaceTags": { + "post": { + "x-ms-examples": { + "Replace tags to a Threat Intelligence": { + "$ref": "./examples/threatintelligence/ReplaceTagsThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Replace tags added to a threat intelligence indicator.", + "operationId": "ThreatIntelligenceIndicator_ReplaceTags", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceReplaceTags" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed to replace tags.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + } + } + }, + "parameters": { + "ThreatIntelligenceName": { + "description": "Threat intelligence indicator name field.", + "in": "path", + "name": "name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ThreatIntelligenceProperties": { + "description": "Properties of threat intelligence indicators to create and update.", + "in": "body", + "name": "ThreatIntelligenceProperties", + "required": true, + "schema": { + "$ref": "#/definitions/ThreatIntelligenceIndicatorModelForRequestBody" + }, + "x-ms-parameter-location": "method" + }, + "ThreatIntelligenceReplaceTags": { + "description": "Tags in the threat intelligence indicator to be replaced.", + "in": "body", + "name": "ThreatIntelligenceReplaceTags", + "required": true, + "schema": { + "$ref": "#/definitions/ThreatIntelligenceIndicatorModelForRequestBody" + }, + "x-ms-parameter-location": "method" + }, + "ThreatIntelligenceFilteringCriteria": { + "description": "Filtering criteria for querying threat intelligence indicators.", + "in": "body", + "name": "ThreatIntelligenceFilteringCriteria", + "required": true, + "schema": { + "$ref": "#/definitions/ThreatIntelligenceFilteringCriteria" + }, + "x-ms-parameter-location": "method" + }, + "ThreatIntelligenceIndicatorEntityKind": { + "description": "The threat intelligence entity kind", + "in": "query", + "name": "ctiEntityKind", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ThreatIntelligenceAppendTags": { + "description": "The threat intelligence append tags request body", + "in": "body", + "name": "ThreatIntelligenceAppendTags", + "required": true, + "schema": { + "$ref": "#/definitions/ThreatIntelligenceAppendTags" + }, + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "ThreatIntelligenceInformationList": { + "description": "List of all the threat intelligence information objects.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of information objects.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of threat intelligence information objects.", + "items": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + }, + "type": "array" + } + }, + "required": [ + "value" + ] + }, + "ThreatIntelligenceInformation": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/ResourceWithEtag" + }, + { + "$ref": "#/definitions/ThreatIntelligenceResourceKind" + } + ], + "description": "Threat intelligence information object.", + "discriminator": "kind", + "type": "object", + "required": [ + "kind" + ] + }, + "ThreatIntelligenceIndicatorModel": { + "allOf": [ + { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + ], + "description": "Threat intelligence indicator entity.", + "properties": { + "properties": { + "$ref": "#/definitions/ThreatIntelligenceIndicatorProperties", + "description": "Threat Intelligence Entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "indicator" + }, + "ThreatIntelligenceIndicatorModelForRequestBody": { + "allOf": [ + { + "$ref": "#/definitions/ThreatIntelligenceResourceKind" + } + ], + "description": "Threat intelligence indicator entity used in request body.", + "properties": { + "etag": { + "description": "Etag of the azure resource", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/ThreatIntelligenceIndicatorProperties", + "description": "Threat Intelligence Entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "indicator" + }, + "ThreatIntelligenceResourceKind": { + "description": "Describes an entity with kind.", + "properties": { + "kind": { + "$ref": "#/definitions/ThreatIntelligenceResourceInnerKind", + "description": "The kind of the entity." + } + }, + "required": [ + "kind" + ], + "type": "object" + }, + "ThreatIntelligenceResourceInnerKind": { + "description": "The kind of the threat intelligence entity", + "enum": [ + "indicator" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ThreatIntelligenceResourceKind", + "values": [ + { + "description": "Entity represents threat intelligence indicator in the system.", + "value": "indicator" + } + ] + } + }, + "ThreatIntelligenceIndicatorProperties": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/EntityCommonProperties" + } + ], + "description": "Describes threat intelligence entity properties", + "properties": { + "threatIntelligenceTags": { + "description": "List of tags", + "items": { + "description": "tag", + "type": "string" + }, + "type": "array" + }, + "lastUpdatedTimeUtc": { + "description": "Last updated time in UTC", + "type": "string" + }, + "source": { + "description": "Source of a threat intelligence entity", + "type": "string" + }, + "displayName": { + "description": "Display name of a threat intelligence entity", + "type": "string" + }, + "description": { + "description": "Description of a threat intelligence entity", + "type": "string" + }, + "indicatorTypes": { + "description": "Indicator types of threat intelligence entities", + "items": { + "description": "Indicator type of a threat intelligence entity", + "type": "string" + }, + "type": "array" + }, + "pattern": { + "description": "Pattern of a threat intelligence entity", + "type": "string" + }, + "patternType": { + "description": "Pattern type of a threat intelligence entity", + "type": "string" + }, + "patternVersion": { + "description": "Pattern version of a threat intelligence entity", + "type": "string" + }, + "killChainPhases": { + "description": "Kill chain phases", + "items": { + "description": "Kill chain phase", + "$ref": "#/definitions/ThreatIntelligenceKillChainPhase" + }, + "type": "array" + }, + "parsedPattern": { + "description": "Parsed patterns", + "items": { + "description": "Parsed pattern", + "$ref": "#/definitions/ThreatIntelligenceParsedPattern" + }, + "type": "array" + }, + "externalId": { + "description": "External ID of threat intelligence entity", + "type": "string" + }, + "createdByRef": { + "description": "Created by reference of threat intelligence entity", + "type": "string" + }, + "defanged": { + "description": "Is threat intelligence entity defanged", + "type": "boolean" + }, + "externalLastUpdatedTimeUtc": { + "description": "External last updated time in UTC", + "type": "string" + }, + "externalReferences": { + "description": "External References", + "items": { + "description": "external_reference", + "$ref": "#/definitions/ThreatIntelligenceExternalReference" + }, + "type": "array" + }, + "granularMarkings": { + "description": "Granular Markings", + "items": { + "description": "Granular marking", + "$ref": "#/definitions/ThreatIntelligenceGranularMarkingModel" + }, + "type": "array" + }, + "labels": { + "description": "Labels of threat intelligence entity", + "items": { + "description": "label", + "type": "string" + }, + "type": "array" + }, + "revoked": { + "description": "Is threat intelligence entity revoked", + "type": "boolean" + }, + "confidence": { + "description": "Confidence of threat intelligence entity", + "type": "integer", + "format": "int32" + }, + "objectMarkingRefs": { + "description": "Threat intelligence entity object marking references", + "items": { + "description": "Threat intelligence entity object marking reference", + "type": "string" + }, + "type": "array" + }, + "language": { + "description": "Language of threat intelligence entity", + "type": "string" + }, + "threatTypes": { + "description": "Threat types", + "items": { + "description": "Threat type", + "type": "string" + }, + "type": "array" + }, + "validFrom": { + "description": "Valid from", + "type": "string" + }, + "validUntil": { + "description": "Valid until", + "type": "string" + }, + "created": { + "description": "Created by", + "type": "string" + }, + "modified": { + "description": "Modified by", + "type": "string" + }, + "extensions": { + "description": "Extensions map", + "type": "object", + "additionalProperties": {} + } + }, + "type": "object" + }, + "ThreatIntelligenceKillChainPhase": { + "description": "Describes threat kill chain phase entity", + "properties": { + "killChainName": { + "description": "Kill chainName name", + "type": "string" + }, + "phaseName": { + "description": "Phase name", + "type": "string" + } + }, + "type": "object" + }, + "ThreatIntelligenceParsedPattern": { + "description": "Describes parsed pattern entity", + "properties": { + "patternTypeKey": { + "description": "Pattern type key", + "type": "string" + }, + "patternTypeValues": { + "description": "Pattern type keys", + "items": { + "description": "Pattern type key", + "$ref": "#/definitions/ThreatIntelligenceParsedPatternTypeValue" + }, + "type": "array" + } + }, + "type": "object" + }, + "ThreatIntelligenceParsedPatternTypeValue": { + "description": "Describes threat kill chain phase entity", + "properties": { + "valueType": { + "description": "Type of the value", + "type": "string" + }, + "value": { + "description": "Value of parsed pattern", + "type": "string" + } + }, + "type": "object" + }, + "ThreatIntelligenceGranularMarkingModel": { + "description": "Describes threat granular marking model entity", + "properties": { + "language": { + "description": "Language granular marking model", + "type": "string" + }, + "markingRef": { + "description": "marking reference granular marking model", + "type": "integer", + "format": "int32" + }, + "selectors": { + "description": "granular marking model selectors", + "items": { + "description": "granular marking model selector", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ThreatIntelligenceExternalReference": { + "description": "Describes external reference", + "properties": { + "description": { + "description": "External reference description", + "type": "string" + }, + "externalId": { + "description": "External reference ID", + "type": "string" + }, + "sourceName": { + "description": "External reference source name", + "type": "string" + }, + "url": { + "description": "External reference URL", + "type": "string" + }, + "hashes": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "External reference hashes" + } + }, + "type": "object" + }, + "ThreatIntelligenceFilteringCriteria": { + "description": "Filtering criteria for querying threat intelligence indicators.", + "properties": { + "pageSize": { + "description": "Page size", + "type": "integer", + "format": "int32" + }, + "minConfidence": { + "description": "Minimum confidence.", + "type": "integer", + "format": "int32" + }, + "maxConfidence": { + "description": "Maximum confidence.", + "type": "integer", + "format": "int32" + }, + "minValidUntil": { + "description": "Start time for ValidUntil filter.", + "type": "string" + }, + "maxValidUntil": { + "description": "End time for ValidUntil filter.", + "type": "string" + }, + "includeDisabled": { + "description": "Parameter to include/exclude disabled indicators.", + "type": "boolean" + }, + "sortBy": { + "description": "Columns to sort by and sorting order", + "items": { + "description": "Sort By", + "$ref": "#/definitions/ThreatIntelligenceSortingCriteria" + }, + "type": "array" + }, + "sources": { + "description": "Sources of threat intelligence indicators", + "items": { + "description": "Source", + "type": "string" + }, + "type": "array" + }, + "patternTypes": { + "description": "Pattern types", + "items": { + "description": "Pattern type", + "type": "string" + }, + "type": "array" + }, + "threatTypes": { + "description": "Threat types of threat intelligence indicators", + "items": { + "description": "Threat type of a threat intelligence indicator", + "type": "string" + }, + "type": "array" + }, + "ids": { + "description": "Ids of threat intelligence indicators", + "items": { + "description": "Id of a threat intelligence indicator", + "type": "string" + }, + "type": "array" + }, + "keywords": { + "description": "Keywords for searching threat intelligence indicators", + "items": { + "description": "keyword for searching threat intelligence indicators", + "type": "string" + }, + "type": "array" + }, + "skipToken": { + "description": "Skip token.", + "type": "string" + } + }, + "type": "object" + }, + "ThreatIntelligenceSortingCriteria": { + "description": "List of available columns for sorting", + "properties": { + "itemKey": { + "description": "Column name", + "type": "string" + }, + "sortOrder": { + "$ref": "#/definitions/ThreatIntelligenceSortingOrder", + "description": "Sorting order (ascending/descending/unsorted)." + } + }, + "type": "object" + }, + "ThreatIntelligenceSortingOrder": { + "description": "Sorting order (ascending/descending/unsorted).", + "enum": [ + "unsorted", + "ascending", + "descending" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ThreatIntelligenceSortingCriteria", + "values": [ + { + "value": "unsorted" + }, + { + "value": "ascending" + }, + { + "value": "descending" + } + ] + } + }, + "ThreatIntelligenceAppendTags": { + "description": "Array of tags to be appended to the threat intelligence indicator.", + "properties": { + "threatIntelligenceTags": { + "description": "List of tags to be appended.", + "items": { + "description": "parameter", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ThreatIntelligenceMetricsList": { + "description": "List of all the threat intelligence metric fields (type/threat type/source).", + "properties": { + "value": { + "description": "Array of threat intelligence metric fields (type/threat type/source).", + "items": { + "$ref": "#/definitions/ThreatIntelligenceMetrics" + }, + "type": "array" + } + }, + "required": [ + "value" + ] + }, + "ThreatIntelligenceMetrics": { + "description": "Threat intelligence metrics.", + "properties": { + "properties": { + "description": "Threat intelligence metrics.", + "$ref": "#/definitions/ThreatIntelligenceMetric" + } + } + }, + "ThreatIntelligenceMetric": { + "description": "Describes threat intelligence metric", + "properties": { + "lastUpdatedTimeUtc": { + "description": "Last updated indicator metric", + "type": "string" + }, + "threatTypeMetrics": { + "description": "Threat type metrics", + "items": { + "description": "parameter", + "$ref": "#/definitions/ThreatIntelligenceMetricEntity" + }, + "type": "array" + }, + "patternTypeMetrics": { + "description": "Pattern type metrics", + "items": { + "description": "parameter", + "$ref": "#/definitions/ThreatIntelligenceMetricEntity" + }, + "type": "array" + }, + "sourceMetrics": { + "description": "Source metrics", + "items": { + "description": "parameter", + "$ref": "#/definitions/ThreatIntelligenceMetricEntity" + }, + "type": "array" + } + }, + "type": "object" + }, + "ThreatIntelligenceMetricEntity": { + "description": "Describes threat intelligence metric entity", + "properties": { + "metricName": { + "description": "Metric name", + "type": "string" + }, + "metricValue": { + "description": "Metric value", + "type": "integer", + "format": "int32" + } + }, + "type": "object" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/AlertRules.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/AlertRules.json new file mode 100644 index 000000000000..d4f0b7255cd8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/AlertRules.json @@ -0,0 +1,1887 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2021-03-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/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules": { + "get": { + "x-ms-examples": { + "Get all alert rules.": { + "$ref": "./examples/alertRules/GetAllAlertRules.json" + } + }, + "tags": [ + "Alert Rules" + ], + "description": "Gets all alert rules.", + "operationId": "AlertRules_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertRulesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/1.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}": { + "get": { + "x-ms-examples": { + "Get a Scheduled alert rule.": { + "$ref": "./examples/alertRules/GetScheduledAlertRule.json" + }, + "Get a Fusion alert rule.": { + "$ref": "./examples/alertRules/GetFusionAlertRule.json" + }, + "Get a MicrosoftSecurityIncidentCreation rule.": { + "$ref": "./examples/alertRules/GetMicrosoftSecurityIncidentCreationAlertRule.json" + } + }, + "tags": [ + "Alert Rules" + ], + "description": "Gets the alert rule.", + "operationId": "AlertRules_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/1.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a Scheduled alert rule.": { + "$ref": "./examples/alertRules/CreateScheduledAlertRule.json" + }, + "Creates or updates a Fusion alert rule.": { + "$ref": "./examples/alertRules/CreateFusionAlertRule.json" + }, + "Creates or updates a MicrosoftSecurityIncidentCreation rule.": { + "$ref": "./examples/alertRules/CreateMicrosoftSecurityIncidentCreationAlertRule.json" + } + }, + "tags": [ + "Alert Rules" + ], + "description": "Creates or updates the alert rule.", + "operationId": "AlertRules_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + }, + { + "$ref": "#/parameters/AlertRule" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertRule" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/AlertRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/1.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete an alert rule.": { + "$ref": "./examples/alertRules/DeleteAlertRule.json" + } + }, + "tags": [ + "Alert Rules" + ], + "description": "Delete the alert rule.", + "operationId": "AlertRules_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/1.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}/actions": { + "get": { + "x-ms-examples": { + "Get all actions of alert rule.": { + "$ref": "./examples/actions/GetAllActionsByAlertRule.json" + } + }, + "tags": [ + "Actions" + ], + "description": "Gets all actions of alert rule.", + "operationId": "Actions_ListByAlertRule", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ActionsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/1.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}/actions/{actionId}": { + "get": { + "x-ms-examples": { + "Get an action of alert rule.": { + "$ref": "./examples/actions/GetActionOfAlertRuleById.json" + } + }, + "tags": [ + "Actions" + ], + "description": "Gets the action of alert rule.", + "operationId": "Actions_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + }, + { + "$ref": "#/parameters/ActionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ActionResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/1.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates an action of alert rule.": { + "$ref": "./examples/actions/CreateActionOfAlertRule.json" + } + }, + "tags": [ + "Actions" + ], + "description": "Creates or updates the action of alert rule.", + "operationId": "Actions_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + }, + { + "$ref": "#/parameters/ActionId" + }, + { + "$ref": "#/parameters/Action" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ActionResponse" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ActionResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/1.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete an action of alert rule.": { + "$ref": "./examples/actions/DeleteActionOfAlertRule.json" + } + }, + "tags": [ + "Actions" + ], + "description": "Delete the action of alert rule.", + "operationId": "Actions_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + }, + { + "$ref": "#/parameters/ActionId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/1.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRuleTemplates": { + "get": { + "x-ms-examples": { + "Get all alert rule templates.": { + "$ref": "./examples/alertRuleTemplates/GetAlertRuleTemplates.json" + } + }, + "tags": [ + "Alert Rule Templates" + ], + "description": "Gets all alert rule templates.", + "operationId": "AlertRuleTemplates_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertRuleTemplatesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/1.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRuleTemplates/{alertRuleTemplateId}": { + "get": { + "x-ms-examples": { + "Get alert rule template by Id.": { + "$ref": "./examples/alertRuleTemplates/GetAlertRuleTemplateById.json" + } + }, + "tags": [ + "Alert Rule Templates" + ], + "description": "Gets the alert rule template.", + "operationId": "AlertRuleTemplates_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/AlertRuleTemplateId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertRuleTemplate" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/1.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "parameters": { + "Action": { + "description": "The action", + "in": "body", + "name": "action", + "required": true, + "schema": { + "$ref": "#/definitions/ActionRequest" + }, + "x-ms-parameter-location": "method" + }, + "ActionId": { + "description": "Action ID", + "in": "path", + "name": "actionId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "AlertRule": { + "description": "The alert rule", + "in": "body", + "name": "alertRule", + "required": true, + "schema": { + "$ref": "#/definitions/AlertRule" + }, + "x-ms-parameter-location": "method" + }, + "AlertRuleTemplateId": { + "description": "Alert rule template ID", + "in": "path", + "name": "alertRuleTemplateId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "RuleId": { + "description": "Alert rule ID", + "in": "path", + "name": "ruleId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "AlertRule": { + "allOf": [ + { + "$ref": "../../../common/1.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Alert rule.", + "properties": { + "kind": { + "$ref": "#/definitions/AlertRuleKindEnum", + "description": "The kind of the alert rule" + } + }, + "discriminator": "kind", + "type": "object", + "required": [ + "kind" + ] + }, + "AlertRuleKindEnum": { + "description": "The kind of the alert rule", + "enum": [ + "Scheduled", + "MicrosoftSecurityIncidentCreation", + "Fusion", + "MLBehaviorAnalytics", + "ThreatIntelligence" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AlertRuleKind", + "values": [ + { + "value": "Scheduled" + }, + { + "value": "MicrosoftSecurityIncidentCreation" + }, + { + "value": "Fusion" + }, + { + "value": "MLBehaviorAnalytics" + }, + { + "value": "ThreatIntelligence" + } + ] + } + }, + "AlertRuleTemplate": { + "allOf": [ + { + "$ref": "../../../common/1.0/types.json#/definitions/Resource" + } + ], + "description": "Alert rule template.", + "discriminator": "kind", + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/AlertRuleKindEnum", + "description": "The kind of the alert rule" + } + }, + "required": [ + "kind" + ] + }, + "AlertRuleTemplateDataSource": { + "description": "alert rule template data sources", + "properties": { + "connectorId": { + "description": "The connector id that provides the following data types", + "type": "string" + }, + "dataTypes": { + "description": "The data types used by the alert rule template", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AlertRuleTemplatePropertiesBase": { + "description": "Base alert rule template property bag.", + "properties": { + "alertRulesCreatedByTemplateCount": { + "description": "the number of alert rules that were created by this template", + "type": "integer", + "format": "int32" + }, + "lastUpdatedDateUTC": { + "description": "The last time that this alert rule template has been updated.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdDateUTC": { + "description": "The time that this alert rule template has been added.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "The description of the alert rule template.", + "type": "string" + }, + "displayName": { + "description": "The display name for alert rule template.", + "type": "string" + }, + "requiredDataConnectors": { + "description": "The required data sources for this template", + "items": { + "$ref": "#/definitions/AlertRuleTemplateDataSource" + }, + "type": "array" + }, + "status": { + "description": "The alert rule template status.", + "enum": [ + "Installed", + "Available", + "NotAvailable" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "TemplateStatus", + "values": [ + { + "description": "Alert rule template installed. and can not use more then once", + "value": "Installed" + }, + { + "description": "Alert rule template is available.", + "value": "Available" + }, + { + "description": "Alert rule template is not available", + "value": "NotAvailable" + } + ] + } + } + }, + "type": "object" + }, + "AlertRuleTemplatesList": { + "description": "List all the alert rule templates.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of alert rule templates.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of alert rule templates.", + "items": { + "$ref": "#/definitions/AlertRuleTemplate" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "AlertRuleTriggerOperator": { + "description": "The operation against the threshold that triggers alert rule.", + "enum": [ + "GreaterThan", + "LessThan", + "Equal", + "NotEqual" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": false, + "name": "TriggerOperator" + } + }, + "AlertRulesList": { + "description": "List all the alert rules.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of alert rules.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of alert rules.", + "items": { + "$ref": "#/definitions/AlertRule" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "AlertSeverity": { + "description": "The severity of the alert", + "enum": [ + "High", + "Medium", + "Low", + "Informational" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AlertSeverity", + "values": [ + { + "description": "High severity", + "value": "High" + }, + { + "description": "Medium severity", + "value": "Medium" + }, + { + "description": "Low severity", + "value": "Low" + }, + { + "description": "Informational severity", + "value": "Informational" + } + ] + } + }, + "AttackTactic": { + "description": "The severity for alerts created by this alert rule.", + "enum": [ + "InitialAccess", + "Execution", + "Persistence", + "PrivilegeEscalation", + "DefenseEvasion", + "CredentialAccess", + "Discovery", + "LateralMovement", + "Collection", + "Exfiltration", + "CommandAndControl", + "Impact", + "PreAttack" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AttackTactic" + } + }, + "MLBehaviorAnalyticsAlertRule": { + "allOf": [ + { + "$ref": "#/definitions/AlertRule" + } + ], + "description": "Represents MLBehaviorAnalytics alert rule.", + "properties": { + "properties": { + "$ref": "#/definitions/MLBehaviorAnalyticsAlertRuleProperties", + "description": "MLBehaviorAnalytics alert rule properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MLBehaviorAnalytics" + }, + "MLBehaviorAnalyticsAlertRuleProperties": { + "description": "MLBehaviorAnalytics alert rule base property bag.", + "properties": { + "alertRuleTemplateName": { + "description": "The Name of the alert rule template used to create this rule.", + "type": "string" + }, + "description": { + "description": "The description of the alert rule.", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "The display name for alerts created by this alert rule.", + "readOnly": true, + "type": "string" + }, + "enabled": { + "description": "Determines whether this alert rule is enabled or disabled.", + "type": "boolean" + }, + "lastModifiedUtc": { + "description": "The last time that this alert rule has been modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "severity": { + "$ref": "#/definitions/AlertSeverity", + "description": "The severity for alerts created by this alert rule.", + "readOnly": true + }, + "tactics": { + "description": "The tactics of the alert rule", + "items": { + "$ref": "#/definitions/AttackTactic" + }, + "readOnly": true, + "type": "array" + } + }, + "required": [ + "alertRuleTemplateName", + "enabled" + ], + "type": "object" + }, + "MLBehaviorAnalyticsAlertRuleTemplate": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplate" + } + ], + "description": "Represents MLBehaviorAnalytics alert rule template.", + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplatePropertiesBase" + } + ], + "description": "MLBehaviorAnalytics alert rule template properties.", + "properties": { + "severity": { + "$ref": "#/definitions/AlertSeverity", + "description": "The severity for alerts created by this alert rule." + }, + "tactics": { + "description": "The tactics of the alert rule template.", + "items": { + "$ref": "#/definitions/AttackTactic" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "displayName", + "description", + "status", + "severity", + "alertRulesCreatedByTemplateCount" + ], + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MLBehaviorAnalytics" + }, + "FusionAlertRule": { + "allOf": [ + { + "$ref": "#/definitions/AlertRule" + } + ], + "description": "Represents Fusion alert rule.", + "properties": { + "properties": { + "$ref": "#/definitions/FusionAlertRuleProperties", + "description": "Fusion alert rule properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Fusion" + }, + "FusionAlertRuleProperties": { + "description": "Fusion alert rule base property bag.", + "properties": { + "alertRuleTemplateName": { + "description": "The Name of the alert rule template used to create this rule.", + "type": "string" + }, + "description": { + "description": "The description of the alert rule.", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "The display name for alerts created by this alert rule.", + "readOnly": true, + "type": "string" + }, + "enabled": { + "description": "Determines whether this alert rule is enabled or disabled.", + "type": "boolean" + }, + "lastModifiedUtc": { + "description": "The last time that this alert has been modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "severity": { + "$ref": "#/definitions/AlertSeverity", + "description": "The severity for alerts created by this alert rule.", + "readOnly": true + }, + "tactics": { + "description": "The tactics of the alert rule", + "items": { + "$ref": "#/definitions/AttackTactic" + }, + "readOnly": true, + "type": "array" + } + }, + "required": [ + "alertRuleTemplateName", + "enabled" + ], + "type": "object" + }, + "FusionAlertRuleTemplate": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplate" + } + ], + "description": "Represents Fusion alert rule template.", + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplatePropertiesBase" + } + ], + "description": "Fusion alert rule template properties", + "properties": { + "severity": { + "$ref": "#/definitions/AlertSeverity", + "description": "The severity for alerts created by this alert rule." + }, + "tactics": { + "description": "The tactics of the alert rule template", + "items": { + "$ref": "#/definitions/AttackTactic" + }, + "type": "array" + } + }, + "required": [ + "displayName", + "description", + "status", + "severity", + "alertRulesCreatedByTemplateCount" + ], + "type": "object", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Fusion" + }, + "ThreatIntelligenceAlertRule": { + "allOf": [ + { + "$ref": "#/definitions/AlertRule" + } + ], + "description": "Represents Threat Intelligence alert rule.", + "properties": { + "properties": { + "$ref": "#/definitions/ThreatIntelligenceAlertRuleProperties", + "description": "Threat Intelligence alert rule properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "ThreatIntelligence" + }, + "ThreatIntelligenceAlertRuleProperties": { + "description": "Threat Intelligence alert rule base property bag.", + "properties": { + "alertRuleTemplateName": { + "description": "The Name of the alert rule template used to create this rule.", + "type": "string" + }, + "description": { + "description": "The description of the alert rule.", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "The display name for alerts created by this alert rule.", + "readOnly": true, + "type": "string" + }, + "enabled": { + "description": "Determines whether this alert rule is enabled or disabled.", + "type": "boolean" + }, + "lastModifiedUtc": { + "description": "The last time that this alert has been modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "severity": { + "$ref": "#/definitions/AlertSeverity", + "description": "The severity for alerts created by this alert rule.", + "readOnly": true + }, + "tactics": { + "description": "The tactics of the alert rule", + "items": { + "$ref": "#/definitions/AttackTactic" + }, + "readOnly": true, + "type": "array" + } + }, + "required": [ + "alertRuleTemplateName", + "enabled" + ], + "type": "object" + }, + "ThreatIntelligenceAlertRuleTemplate": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplate" + } + ], + "description": "Represents Threat Intelligence alert rule template.", + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplatePropertiesBase" + } + ], + "description": "Threat Intelligence alert rule template properties", + "properties": { + "severity": { + "$ref": "#/definitions/AlertSeverity", + "description": "The severity for alerts created by this alert rule." + }, + "tactics": { + "description": "The tactics of the alert rule template", + "items": { + "$ref": "#/definitions/AttackTactic" + }, + "type": "array" + } + }, + "required": [ + "displayName", + "description", + "status", + "severity", + "alertRulesCreatedByTemplateCount" + ], + "type": "object", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "ThreatIntelligence" + }, + "MicrosoftSecurityIncidentCreationAlertRule": { + "allOf": [ + { + "$ref": "#/definitions/AlertRule" + } + ], + "description": "Represents MicrosoftSecurityIncidentCreation rule.", + "properties": { + "properties": { + "$ref": "#/definitions/MicrosoftSecurityIncidentCreationAlertRuleProperties", + "description": "MicrosoftSecurityIncidentCreation rule properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftSecurityIncidentCreation" + }, + "MicrosoftSecurityIncidentCreationAlertRuleCommonProperties": { + "description": "MicrosoftSecurityIncidentCreation rule common property bag.", + "properties": { + "displayNamesFilter": { + "description": "the alerts' displayNames on which the cases will be generated", + "items": { + "type": "string" + }, + "type": "array" + }, + "displayNamesExcludeFilter": { + "description": "the alerts' displayNames on which the cases will not be generated", + "items": { + "type": "string" + }, + "type": "array" + }, + "productFilter": { + "description": "The alerts' productName on which the cases will be generated", + "enum": [ + "Microsoft Cloud App Security", + "Azure Security Center", + "Azure Advanced Threat Protection", + "Azure Active Directory Identity Protection", + "Azure Security Center for IoT", + "Office 365 Advanced Threat Protection", + "Microsoft Defender Advanced Threat Protection" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "MicrosoftSecurityProductName" + } + }, + "severitiesFilter": { + "description": "the alerts' severities on which the cases will be generated", + "items": { + "$ref": "#/definitions/AlertSeverity" + }, + "type": "array" + } + }, + "required": [ + "productFilter" + ], + "type": "object" + }, + "MicrosoftSecurityIncidentCreationAlertRuleProperties": { + "allOf": [ + { + "$ref": "#/definitions/MicrosoftSecurityIncidentCreationAlertRuleCommonProperties" + } + ], + "description": "MicrosoftSecurityIncidentCreation rule property bag.", + "properties": { + "alertRuleTemplateName": { + "description": "The Name of the alert rule template used to create this rule.", + "type": "string" + }, + "description": { + "description": "The description of the alert rule.", + "type": "string" + }, + "displayName": { + "description": "The display name for alerts created by this alert rule.", + "type": "string" + }, + "enabled": { + "description": "Determines whether this alert rule is enabled or disabled.", + "type": "boolean" + }, + "lastModifiedUtc": { + "description": "The last time that this alert has been modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "displayName", + "enabled", + "productFilter" + ], + "type": "object" + }, + "MicrosoftSecurityIncidentCreationAlertRuleTemplate": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplate" + } + ], + "description": "Represents MicrosoftSecurityIncidentCreation rule template.", + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplatePropertiesBase" + }, + { + "$ref": "#/definitions/MicrosoftSecurityIncidentCreationAlertRuleCommonProperties" + } + ], + "description": "MicrosoftSecurityIncidentCreation rule template properties", + "required": [ + "displayName", + "description", + "createdDateUTC", + "status", + "alertRulesCreatedByTemplateCount", + "productFilter" + ], + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftSecurityIncidentCreation" + }, + "ScheduledAlertRuleProperties": { + "allOf": [ + { + "$ref": "#/definitions/ScheduledAlertRuleCommonProperties" + } + ], + "description": "Scheduled alert rule base property bag.", + "properties": { + "alertRuleTemplateName": { + "description": "The Name of the alert rule template used to create this rule.", + "type": "string" + }, + "description": { + "description": "The description of the alert rule.", + "type": "string" + }, + "displayName": { + "description": "The display name for alerts created by this alert rule.", + "type": "string" + }, + "enabled": { + "description": "Determines whether this alert rule is enabled or disabled.", + "type": "boolean" + }, + "lastModifiedUtc": { + "description": "The last time that this alert rule has been modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "suppressionDuration": { + "description": "The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered.", + "format": "duration", + "type": "string" + }, + "suppressionEnabled": { + "description": "Determines whether the suppression for this alert rule is enabled or disabled.", + "type": "boolean" + }, + "tactics": { + "description": "The tactics of the alert rule", + "items": { + "$ref": "#/definitions/AttackTactic" + }, + "type": "array" + }, + "incidentConfiguration": { + "$ref": "#/definitions/IncidentConfiguration", + "description": "The settings of the incidents that created from alerts triggered by this analytics rule" + } + }, + "required": [ + "displayName", + "enabled", + "severity", + "query", + "queryFrequency", + "queryPeriod", + "triggerOperator", + "triggerThreshold", + "suppressionEnabled", + "suppressionDuration" + ], + "type": "object" + }, + "ScheduledAlertRuleTemplate": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplate" + } + ], + "description": "Represents scheduled alert rule template.", + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplatePropertiesBase" + }, + { + "$ref": "#/definitions/ScheduledAlertRuleCommonProperties" + } + ], + "description": "Scheduled alert rule template properties", + "properties": { + "tactics": { + "description": "The tactics of the alert rule template", + "items": { + "$ref": "#/definitions/AttackTactic" + }, + "type": "array" + } + }, + "required": [ + "displayName", + "description", + "status", + "alertRulesCreatedByTemplateCount", + "severity", + "query", + "queryFrequency", + "queryPeriod", + "triggerOperator", + "triggerThreshold" + ], + "type": "object", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Scheduled" + }, + "EventGroupingSettings": { + "description": "Event grouping settings property bag.", + "properties": { + "aggregationKind": { + "$ref": "#/definitions/EventGroupingAggregationKind" + } + }, + "type": "object" + }, + "EventGroupingAggregationKind": { + "description": "The event grouping aggregation kinds", + "enum": [ + "SingleAlert", + "AlertPerResult" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "EventGroupingAggregationKind" + } + }, + "ScheduledAlertRule": { + "allOf": [ + { + "$ref": "#/definitions/AlertRule" + } + ], + "description": "Represents scheduled alert rule.", + "properties": { + "properties": { + "$ref": "#/definitions/ScheduledAlertRuleProperties", + "description": "Scheduled alert rule properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Scheduled" + }, + "ScheduledAlertRuleCommonProperties": { + "description": "Scheduled alert rule template property bag.", + "properties": { + "query": { + "description": "The query that creates alerts for this rule.", + "type": "string" + }, + "queryFrequency": { + "description": "The frequency (in ISO 8601 duration format) for this alert rule to run.", + "format": "duration", + "type": "string" + }, + "queryPeriod": { + "description": "The period (in ISO 8601 duration format) that this alert rule looks at.", + "format": "duration", + "type": "string" + }, + "severity": { + "$ref": "#/definitions/AlertSeverity", + "description": "The severity for alerts created by this alert rule." + }, + "triggerOperator": { + "$ref": "#/definitions/AlertRuleTriggerOperator", + "description": "The operation against the threshold that triggers alert rule." + }, + "triggerThreshold": { + "description": "The threshold triggers this alert rule.", + "type": "integer", + "format": "int32" + }, + "eventGroupingSettings": { + "$ref": "#/definitions/EventGroupingSettings", + "description": "The event grouping settings." + }, + "customDetails": { + "description": "Dictionary of string key-value pairs of columns to be attached to the alert", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "entityMappings": { + "$ref": "#/definitions/EntityMappings", + "description": "Array of the entity mappings of the alert rule" + }, + "alertDetailsOverride": { + "type": "object", + "$ref": "#/definitions/AlertDetailsOverride", + "description": "The alert details override settings" + } + }, + "type": "object" + }, + "EntityMappings": { + "description": "List of entity mappings of the alert rule", + "type": "array", + "items": { + "$ref": "#/definitions/EntityMapping" + } + }, + "EntityMapping": { + "description": "Single entity mapping for the alert rule", + "properties": { + "entityType": { + "$ref": "#/definitions/EntityMappingType" + }, + "fieldMappings": { + "description": "array of field mappings for the given entity mapping", + "type": "array", + "items": { + "$ref": "#/definitions/FieldMapping" + } + } + }, + "type": "object" + }, + "FieldMapping": { + "description": "A single field mapping of the mapped entity", + "properties": { + "identifier": { + "description": "the V3 identifier of the entity", + "type": "string" + }, + "columnName": { + "description": "the column name to be mapped to the identifier", + "type": "string" + } + }, + "type": "object" + }, + "AlertDetailsOverride": { + "description": "Settings for how to dynamically override alert static details", + "properties": { + "alertDisplayNameFormat": { + "description": "the format containing columns name(s) to override the alert name", + "type": "string" + }, + "alertDescriptionFormat": { + "description": "the format containing columns name(s) to override the alert description", + "type": "string" + }, + "alertTacticsColumnName": { + "description": "the column name to take the alert tactics from", + "type": "string" + }, + "alertSeverityColumnName": { + "description": "the column name to take the alert severity from", + "type": "string" + } + }, + "type": "object" + }, + "IncidentConfiguration": { + "description": "Incident Configuration property bag.", + "properties": { + "createIncident": { + "description": "Create incidents from alerts triggered by this analytics rule", + "type": "boolean" + }, + "groupingConfiguration": { + "$ref": "#/definitions/GroupingConfiguration", + "description": "Set how the alerts that are triggered by this analytics rule, are grouped into incidents" + } + }, + "type": "object", + "required": [ + "createIncident" + ] + }, + "GroupingConfiguration": { + "description": "Grouping configuration property bag.", + "properties": { + "enabled": { + "description": "Grouping enabled", + "type": "boolean" + }, + "reopenClosedIncident": { + "description": "Re-open closed matching incidents", + "type": "boolean" + }, + "lookbackDuration": { + "description": "Limit the group to alerts created within the lookback duration (in ISO 8601 duration format)", + "format": "duration", + "type": "string" + }, + "matchingMethod": { + "description": "Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty.", + "enum": [ + "AllEntities", + "AnyAlert", + "Selected" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "MatchingMethod", + "values": [ + { + "description": "Grouping alerts into a single incident if all the entities match", + "value": "AllEntities" + }, + { + "description": "Grouping any alerts triggered by this rule into a single incident", + "value": "AnyAlert" + }, + { + "description": "Grouping alerts into a single incident if the selected entities, custom details and alert details match", + "value": "Selected" + } + ] + } + }, + "groupByEntities": { + "description": "A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used.", + "items": { + "$ref": "#/definitions/EntityMappingType" + }, + "type": "array" + }, + "groupByAlertDetails": { + "description": "A list of alert details to group by (when matchingMethod is Selected)", + "items": { + "description": "Alert detail", + "enum": [ + "DisplayName", + "Severity" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AlertDetail", + "values": [ + { + "description": "Alert display name", + "value": "DisplayName" + }, + { + "description": "Alert severity", + "value": "Severity" + } + ] + } + }, + "type": "array" + }, + "groupByCustomDetails": { + "description": "A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "enabled", + "reopenClosedIncident", + "lookbackDuration", + "matchingMethod" + ] + }, + "ActionRequest": { + "allOf": [ + { + "$ref": "../../../common/1.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Action for alert rule.", + "properties": { + "properties": { + "$ref": "#/definitions/ActionRequestProperties", + "description": "Action properties for put request", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "ActionPropertiesBase": { + "description": "Action property bag base.", + "properties": { + "logicAppResourceId": { + "description": "Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}.", + "type": "string" + } + }, + "required": [ + "logicAppResourceId" + ], + "type": "object" + }, + "ActionRequestProperties": { + "allOf": [ + { + "$ref": "#/definitions/ActionPropertiesBase" + } + ], + "description": "Action property bag.", + "properties": { + "triggerUri": { + "description": "Logic App Callback URL for this specific workflow.", + "type": "string", + "x-ms-secret": true + } + }, + "required": [ + "triggerUri" + ], + "type": "object" + }, + "ActionResponse": { + "allOf": [ + { + "$ref": "../../../common/1.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Action for alert rule.", + "properties": { + "properties": { + "$ref": "#/definitions/ActionResponseProperties", + "description": "Action properties for get request", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "ActionResponseProperties": { + "allOf": [ + { + "$ref": "#/definitions/ActionPropertiesBase" + } + ], + "description": "Action property bag.", + "properties": { + "workflowId": { + "description": "The name of the logic app's workflow.", + "type": "string" + } + }, + "type": "object" + }, + "ActionsList": { + "description": "List all the actions.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of actions.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of actions.", + "items": { + "$ref": "#/definitions/ActionResponse" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "EntityMappingType": { + "description": "The V3 type of the mapped entity", + "enum": [ + "Account", + "Host", + "IP", + "Malware", + "File", + "Process", + "CloudApplication", + "DNS", + "AzureResource", + "FileHash", + "RegistryKey", + "RegistryValue", + "SecurityGroup", + "URL", + "Mailbox", + "MailCluster", + "MailMessage", + "SubmissionMail" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "EntityMappingType", + "values": [ + { + "description": "User account entity type", + "value": "Account" + }, + { + "description": "Host entity type", + "value": "Host" + }, + { + "description": "IP address entity type", + "value": "IP" + }, + { + "description": "Malware entity type", + "value": "Malware" + }, + { + "description": "System file entity type", + "value": "File" + }, + { + "description": "Process entity type", + "value": "Process" + }, + { + "description": "Cloud app entity type", + "value": "CloudApplication" + }, + { + "description": "DNS entity type", + "value": "DNS" + }, + { + "description": "Azure resource entity type", + "value": "AzureResource" + }, + { + "description": "File-hash entity type", + "value": "FileHash" + }, + { + "description": "Registry key entity type", + "value": "RegistryKey" + }, + { + "description": "Registry value entity type", + "value": "RegistryValue" + }, + { + "description": "Security group entity type", + "value": "SecurityGroup" + }, + { + "description": "URL entity type", + "value": "URL" + }, + { + "description": "Mailbox entity type", + "value": "Mailbox" + }, + { + "description": "Mail cluster entity type", + "value": "MailCluster" + }, + { + "description": "Mail message entity type", + "value": "MailMessage" + }, + { + "description": "Submission mail entity type", + "value": "SubmissionMail" + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/EntityDefinitions.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/EntityDefinitions.json new file mode 100644 index 000000000000..6eb99cabfc65 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/EntityDefinitions.json @@ -0,0 +1,181 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2021-03-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": {}, + "definitions": { + "EntityInnerType": { + "description": "The type of the entity", + "enum": [ + "Account", + "Host", + "File", + "AzureResource", + "CloudApplication", + "DNS", + "FileHash", + "IP", + "Malware", + "Process", + "RegistryKey", + "RegistryValue", + "SecurityGroup", + "URL", + "IoTDevice", + "SecurityAlert", + "HuntingBookmark", + "MailCluster", + "MailMessage", + "Mailbox", + "SubmissionMail" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "EntityType", + "values": [ + { + "description": "Entity represents account in the system.", + "value": "Account" + }, + { + "description": "Entity represents host in the system.", + "value": "Host" + }, + { + "description": "Entity represents file in the system.", + "value": "File" + }, + { + "description": "Entity represents azure resource in the system.", + "value": "AzureResource" + }, + { + "description": "Entity represents cloud application in the system.", + "value": "CloudApplication" + }, + { + "description": "Entity represents dns in the system.", + "value": "DNS" + }, + { + "description": "Entity represents file hash in the system.", + "value": "FileHash" + }, + { + "description": "Entity represents ip in the system.", + "value": "IP" + }, + { + "description": "Entity represents malware in the system.", + "value": "Malware" + }, + { + "description": "Entity represents process in the system.", + "value": "Process" + }, + { + "description": "Entity represents registry key in the system.", + "value": "RegistryKey" + }, + { + "description": "Entity represents registry value in the system.", + "value": "RegistryValue" + }, + { + "description": "Entity represents security group in the system.", + "value": "SecurityGroup" + }, + { + "description": "Entity represents url in the system.", + "value": "URL" + }, + { + "description": "Entity represents IoT device in the system.", + "value": "IoTDevice" + }, + { + "description": "Entity represents security alert in the system.", + "value": "SecurityAlert" + }, + { + "description": "Entity represents HuntingBookmark in the system.", + "value": "HuntingBookmark" + }, + { + "description": "Entity represents mail cluster in the system.", + "value": "MailCluster" + }, + { + "description": "Entity represents mail message in the system.", + "value": "MailMessage" + }, + { + "description": "Entity represents mailbox in the system.", + "value": "Mailbox" + }, + { + "description": "Entity represents submission mail in the system.", + "value": "SubmissionMail" + } + ] + } + }, + "EntityQueryKind": { + "description": "The kind of the entity query", + "enum": [ + "Expansion", + "Insight", + "Activity" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "EntityQueryKind", + "values": [ + { + "value": "Expansion" + }, + { + "value": "Insight" + }, + { + "value": "Activity" + } + ] + } + } + }, + "parameters": {} +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/EntityQueries.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/EntityQueries.json new file mode 100644 index 000000000000..80cd31cc4fc2 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/EntityQueries.json @@ -0,0 +1,518 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2021-03-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/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entityQueries": { + "get": { + "x-ms-examples": { + "Get all entity queries.": { + "$ref": "./examples/entityQueries/GetEntityQueries.json" + } + }, + "tags": [ + "EntityQueries" + ], + "description": "Gets all entity queries.", + "operationId": "EntityQueries_List", + "parameters": [ + { + "$ref": "#/parameters/EntityQueryKind" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EntityQueryList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/1.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entityQueries/{entityQueryId}": { + "get": { + "x-ms-examples": { + "Get an Expansion entity query.": { + "$ref": "./examples/entityQueries/GetExpansionEntityQueryById.json" + }, + "Get an Activity entity query.": { + "$ref": "./examples/entityQueries/GetActivityEntityQueryById.json" + } + }, + "tags": [ + "EntityQueries" + ], + "description": "Gets an entity query.", + "operationId": "EntityQueries_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityQueryId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EntityQuery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/1.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates an Activity entity query.": { + "$ref": "./examples/entityQueries/CreateEntityQueryActivity.json" + } + }, + "tags": [ + "EntityQueries" + ], + "description": "Creates or updates the entity query.", + "operationId": "EntityQueries_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityQueryId" + }, + { + "$ref": "#/parameters/CustomEntityQuery" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EntityQuery" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/EntityQuery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/1.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete an entity query.": { + "$ref": "./examples/entityQueries/DeleteEntityQuery.json" + } + }, + "tags": [ + "EntityQueries" + ], + "description": "Delete the entity query.", + "operationId": "EntityQueries_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityQueryId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/1.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "CustomEntityQueryKind": { + "description": "The kind of the entity query that supports put request.", + "enum": [ + "Activity" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "CustomEntityQueryKind", + "values": [ + { + "value": "Activity" + } + ] + } + }, + "EntityQueryList": { + "description": "List of all the entity queries.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of entity queries.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of entity queries.", + "items": { + "$ref": "#/definitions/EntityQuery" + }, + "type": "array" + } + }, + "required": [ + "value" + ] + }, + "EntityQuery": { + "allOf": [ + { + "$ref": "../../../common/1.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Specific entity query.", + "discriminator": "kind", + "properties": { + "kind": { + "$ref": "EntityDefinitions.json#/definitions/EntityQueryKind", + "description": "the entity query kind" + } + }, + "type": "object", + "required": [ + "kind" + ] + }, + "CustomEntityQuery": { + "allOf": [ + { + "$ref": "../../../common/1.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Specific entity query that supports put requests.", + "discriminator": "kind", + "properties": { + "kind": { + "$ref": "#/definitions/CustomEntityQueryKind", + "description": "the entity query kind" + } + }, + "type": "object", + "required": [ + "kind" + ] + }, + "ExpansionEntityQuery": { + "description": "Represents Expansion entity query.", + "allOf": [ + { + "$ref": "#/definitions/EntityQuery" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ExpansionEntityQueriesProperties", + "description": "Expansion entity query properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Expansion" + }, + "ExpansionEntityQueriesProperties": { + "description": "Describes expansion entity query properties", + "properties": { + "dataSources": { + "description": "List of the data sources that are required to run the query", + "items": { + "description": "data source", + "type": "string" + }, + "type": "array" + }, + "displayName": { + "description": "The query display name", + "type": "string" + }, + "inputEntityType": { + "$ref": "EntityDefinitions.json#/definitions/EntityInnerType", + "description": "The type of the query's source entity" + }, + "inputFields": { + "description": "List of the fields of the source entity that are required to run the query", + "items": { + "description": "input field", + "type": "string" + }, + "type": "array" + }, + "outputEntityTypes": { + "description": "List of the desired output types to be constructed from the result", + "items": { + "$ref": "EntityDefinitions.json#/definitions/EntityInnerType", + "description": "output entity type" + }, + "type": "array" + }, + "queryTemplate": { + "description": "The template query string to be parsed and formatted", + "type": "string" + } + }, + "type": "object" + }, + "ActivityEntityQuery": { + "description": "Represents Activity entity query.", + "allOf": [ + { + "$ref": "#/definitions/EntityQuery" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ActivityEntityQueriesProperties", + "description": "Activity entity query properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Activity" + }, + "ActivityCustomEntityQuery": { + "description": "Represents Activity entity query.", + "allOf": [ + { + "$ref": "#/definitions/CustomEntityQuery" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ActivityEntityQueriesProperties", + "description": "Activity entity query properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Activity" + }, + "ActivityEntityQueriesProperties": { + "description": "Describes activity entity query properties", + "properties": { + "title": { + "description": "The entity query title", + "type": "string" + }, + "content": { + "description": "The entity query content to display in timeline", + "type": "string" + }, + "description": { + "description": "The entity query description", + "type": "string" + }, + "queryDefinitions": { + "description": "The Activity query definitions", + "properties": { + "query": { + "description": "The Activity query to run on a given entity", + "type": "string" + } + }, + "type": "object" + }, + "inputEntityType": { + "$ref": "EntityDefinitions.json#/definitions/EntityInnerType", + "description": "The type of the query's source entity" + }, + "requiredInputFieldsSets": { + "description": "List of the fields of the source entity that are required to run the query", + "items": { + "description": "Sub sets of the field of the source entity that are required to run the query", + "items": { + "description": "Required input field name", + "type": "string" + }, + "type": "array" + }, + "type": "array" + }, + "entitiesFilter": { + "description": "The query applied only to entities matching to all filters", + "type": "object", + "additionalProperties": { + "description": "Filter field name", + "items": { + "description": "Filter field values", + "type": "string" + }, + "type": "array" + } + }, + "templateName": { + "description": "The template id this activity was created from", + "type": "string" + }, + "enabled": { + "description": "Determines whether this activity is enabled or disabled.", + "type": "boolean" + }, + "createdTimeUtc": { + "description": "The time the activity was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "lastModifiedTimeUtc": { + "description": "The last time the activity was updated", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + } + }, + "parameters": { + "EntityQueryId": { + "description": "entity query ID", + "in": "path", + "name": "entityQueryId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "EntityQueryKind": { + "description": "The entity query kind we want to fetch", + "in": "query", + "name": "kind", + "required": false, + "enum": [ + "Expansion", + "Activity" + ], + "type": "string", + "x-ms-parameter-location": "method" + }, + "CustomEntityQuery": { + "description": "The entity query we want to create or update", + "in": "body", + "name": "entityQuery", + "required": true, + "schema": { + "$ref": "#/definitions/CustomEntityQuery" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/Incidents.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/Incidents.json new file mode 100644 index 000000000000..0098a0ab8407 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/Incidents.json @@ -0,0 +1,4206 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2021-03-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/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents": { + "get": { + "x-ms-examples": { + "Get all incidents.": { + "$ref": "./examples/incidents/GetIncidents.json" + } + }, + "tags": [ + "Incidents" + ], + "description": "Gets all incidents.", + "operationId": "Incidents_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/1.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}": { + "get": { + "x-ms-examples": { + "Get an incident.": { + "$ref": "./examples/incidents/GetIncidentById.json" + } + }, + "tags": [ + "Incidents" + ], + "description": "Gets an incident.", + "operationId": "Incidents_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Incident" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/1.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates an incident.": { + "$ref": "./examples/incidents/CreateIncident.json" + } + }, + "tags": [ + "Incidents" + ], + "description": "Creates or updates the incident.", + "operationId": "Incidents_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/Incident" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Incident" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Incident" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/1.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete an incident.": { + "$ref": "./examples/incidents/DeleteIncident.json" + } + }, + "tags": [ + "Incidents" + ], + "description": "Delete the incident.", + "operationId": "Incidents_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/1.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/createTeam": { + "post": { + "x-ms-examples": { + "Creates incident teams group.": { + "$ref": "./examples/incidents/CreateTeam.json" + } + }, + "tags": [ + "IncidentTeam" + ], + "description": "Creates a Microsoft team to investigate the incident by sharing information and insights between participants.", + "operationId": "Incidents_CreateTeam", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/TeamProperties" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TeamInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/1.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/alerts": { + "post": { + "x-ms-examples": { + "Get all incident alerts.": { + "$ref": "./examples/incidents/GetAllIncidentAlerts.json" + } + }, + "tags": [ + "IncidentAlerts" + ], + "description": "Gets all incident alerts.", + "operationId": "Incidents_ListAlerts", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentAlertList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/1.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/bookmarks": { + "post": { + "x-ms-examples": { + "Get all incident bookmarks.": { + "$ref": "./examples/incidents/GetAllIncidentBookmarks.json" + } + }, + "tags": [ + "IncidentBookmarks" + ], + "description": "Gets all incident bookmarks.", + "operationId": "Incidents_ListBookmarks", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentBookmarkList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/1.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/comments": { + "get": { + "x-ms-examples": { + "Get all incident comments.": { + "$ref": "./examples/incidents/comments/GetAllIncidentComments.json" + } + }, + "tags": [ + "IncidentComments" + ], + "description": "Gets all incident comments.", + "operationId": "IncidentComments_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentCommentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/1.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/IncidentComment", + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/comments/{incidentCommentId}": { + "get": { + "x-ms-examples": { + "Get an incident comment.": { + "$ref": "./examples/incidents/comments/GetIncidentCommentById.json" + } + }, + "tags": [ + "IncidentComments" + ], + "description": "Gets an incident comment.", + "operationId": "IncidentComments_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/IncidentCommentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentComment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/1.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates an incident comment.": { + "$ref": "./examples/incidents/comments/CreateIncidentComment.json" + } + }, + "tags": [ + "IncidentComments" + ], + "description": "Creates or updates the incident comment.", + "operationId": "IncidentComments_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/IncidentCommentId" + }, + { + "$ref": "#/parameters/IncidentComment" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentComment" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/IncidentComment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/1.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete the incident comment.": { + "$ref": "./examples/incidents/comments/DeleteIncidentComment.json" + } + }, + "tags": [ + "IncidentComments" + ], + "description": "Delete the incident comment.", + "operationId": "IncidentComments_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/IncidentCommentId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/1.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/entities": { + "post": { + "x-ms-examples": { + "Gets all incident related entities": { + "$ref": "./examples/incidents/entities/GetAllIncidentEntities.json" + } + }, + "tags": [ + "IncidentEntities" + ], + "description": "Gets all incident related entities.", + "operationId": "Incidents_ListEntities", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentEntitiesResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/1.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/relations": { + "get": { + "x-ms-examples": { + "Get all incident relations.": { + "$ref": "./examples/incidents/relations/GetAllIncidentRelations.json" + } + }, + "tags": [ + "IncidentRelations" + ], + "description": "Gets all incident relations.", + "operationId": "IncidentRelations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RelationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/1.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/Relation", + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/relations/{relationName}": { + "get": { + "x-ms-examples": { + "Get an incident relation.": { + "$ref": "./examples/incidents/relations/GetIncidentRelationByName.json" + } + }, + "tags": [ + "IncidentRelations" + ], + "description": "Gets an incident relation.", + "operationId": "IncidentRelations_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/RelationName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Relation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/1.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates an incident relation.": { + "$ref": "./examples/incidents/relations/CreateIncidentRelation.json" + } + }, + "tags": [ + "IncidentRelations" + ], + "description": "Creates or updates the incident relation.", + "operationId": "IncidentRelations_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/RelationName" + }, + { + "$ref": "#/parameters/Relation" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Relation" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Relation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/1.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete the incident relation.": { + "$ref": "./examples/incidents/relations/DeleteIncidentRelation.json" + } + }, + "tags": [ + "IncidentRelations" + ], + "description": "Delete the incident relation.", + "operationId": "IncidentRelations_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/RelationName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/1.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "AccountEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents an account entity.", + "properties": { + "properties": { + "$ref": "#/definitions/AccountEntityProperties", + "description": "Account entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Account" + }, + "AccountEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Account entity property bag.", + "properties": { + "aadTenantId": { + "description": "The Azure Active Directory tenant id.", + "readOnly": true, + "type": "string" + }, + "aadUserId": { + "description": "The Azure Active Directory user id.", + "readOnly": true, + "type": "string" + }, + "accountName": { + "description": "The name of the account. This field should hold only the name without any domain added to it, i.e. administrator.", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "The display name of the account.", + "readOnly": true, + "type": "string" + }, + "hostEntityId": { + "description": "The Host entity id that contains the account in case it is a local account (not domain joined)", + "readOnly": true, + "type": "string" + }, + "isDomainJoined": { + "description": "Determines whether this is a domain account.", + "readOnly": true, + "type": "boolean" + }, + "ntDomain": { + "description": "The NetBIOS domain name as it appears in the alert format domain\\username. Examples: NT AUTHORITY.", + "readOnly": true, + "type": "string" + }, + "objectGuid": { + "description": "The objectGUID attribute is a single-value attribute that is the unique identifier for the object, assigned by active directory.", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "puid": { + "description": "The Azure Active Directory Passport User ID.", + "readOnly": true, + "type": "string" + }, + "sid": { + "description": "The account security identifier, e.g. S-1-5-18.", + "readOnly": true, + "type": "string" + }, + "upnSuffix": { + "description": "The user principal name suffix for the account, in some cases it is also the domain name. Examples: contoso.com.", + "readOnly": true, + "type": "string" + }, + "dnsDomain": { + "description": "The fully qualified domain DNS name.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ActivityTimelineItem": { + "allOf": [ + { + "$ref": "#/definitions/EntityTimelineItem" + } + ], + "description": "Represents Activity timeline item.", + "properties": { + "queryId": { + "type": "string", + "description": "The activity query id." + }, + "bucketStartTimeUTC": { + "format": "date-time", + "type": "string", + "description": "The grouping bucket start time." + }, + "bucketEndTimeUTC": { + "format": "date-time", + "type": "string", + "description": "The grouping bucket end time." + }, + "firstActivityTimeUTC": { + "format": "date-time", + "type": "string", + "description": "The time of the first activity in the grouping bucket." + }, + "lastActivityTimeUTC": { + "format": "date-time", + "type": "string", + "description": "The time of the last activity in the grouping bucket." + }, + "content": { + "type": "string", + "description": "The activity timeline content." + }, + "title": { + "type": "string", + "description": "The activity timeline title." + } + }, + "required": [ + "queryId", + "bucketStartTimeUTC", + "bucketEndTimeUTC", + "firstActivityTimeUTC", + "lastActivityTimeUTC", + "content", + "title" + ], + "type": "object", + "x-ms-discriminator-value": "Activity" + }, + "AlertSeverity": { + "description": "The severity of the alert", + "enum": [ + "High", + "Medium", + "Low", + "Informational" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AlertSeverity", + "values": [ + { + "description": "High severity", + "value": "High" + }, + { + "description": "Medium severity", + "value": "Medium" + }, + { + "description": "Low severity", + "value": "Low" + }, + { + "description": "Informational severity", + "value": "Informational" + } + ] + } + }, + "AttackTactic": { + "description": "The severity for alerts created by this alert rule.", + "enum": [ + "InitialAccess", + "Execution", + "Persistence", + "PrivilegeEscalation", + "DefenseEvasion", + "CredentialAccess", + "Discovery", + "LateralMovement", + "Collection", + "Exfiltration", + "CommandAndControl", + "Impact", + "PreAttack" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AttackTactic" + } + }, + "AzureResourceEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents an azure resource entity.", + "properties": { + "properties": { + "$ref": "#/definitions/AzureResourceEntityProperties", + "description": "AzureResource entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AzureResource" + }, + "AzureResourceEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "AzureResource entity property bag.", + "properties": { + "resourceId": { + "description": "The azure resource id of the resource", + "readOnly": true, + "type": "string" + }, + "subscriptionId": { + "description": "The subscription id of the resource", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "BookmarkTimelineItem": { + "allOf": [ + { + "$ref": "#/definitions/EntityTimelineItem" + } + ], + "description": "Represents bookmark timeline item.", + "properties": { + "azureResourceId": { + "type": "string", + "description": "The bookmark azure resource id." + }, + "displayName": { + "type": "string", + "description": "The bookmark display name." + }, + "notes": { + "type": "string", + "description": "The notes of the bookmark" + }, + "endTimeUtc": { + "format": "date-time", + "type": "string", + "description": "The bookmark end time." + }, + "startTimeUtc": { + "format": "date-time", + "type": "string", + "description": "TThe bookmark start time." + }, + "eventTime": { + "format": "date-time", + "type": "string", + "description": "The bookmark event time." + }, + "createdBy": { + "$ref": "#/definitions/UserInfo", + "description": "Describes a user that created the bookmark", + "type": "object" + }, + "labels": { + "description": "List of labels relevant to this bookmark", + "items": { + "$ref": "#/definitions/Label" + }, + "type": "array" + } + }, + "required": [ + "azureResourceId" + ], + "type": "object", + "x-ms-discriminator-value": "Bookmark" + }, + "ClientInfo": { + "description": "Information on the client (user or application) that made some action", + "properties": { + "email": { + "description": "The email of the client.", + "type": "string" + }, + "name": { + "description": "The name of the client.", + "type": "string" + }, + "objectId": { + "description": "The object id of the client.", + "format": "uuid", + "type": "string" + }, + "userPrincipalName": { + "description": "The user principal name of the client.", + "type": "string" + } + }, + "type": "object" + }, + "CloudApplicationEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a cloud application entity.", + "properties": { + "properties": { + "$ref": "#/definitions/CloudApplicationEntityProperties", + "description": "CloudApplication entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "CloudApplication" + }, + "CloudApplicationEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "CloudApplication entity property bag.", + "properties": { + "appId": { + "description": "The technical identifier of the application.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "appName": { + "description": "The name of the related cloud application.", + "readOnly": true, + "type": "string" + }, + "instanceName": { + "description": "The user defined instance name of the cloud application. It is often used to distinguish between several applications of the same type that a customer has.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DnsEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a dns entity.", + "properties": { + "properties": { + "$ref": "#/definitions/DnsEntityProperties", + "description": "Dns entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "DnsResolution" + }, + "DnsEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Dns entity property bag.", + "properties": { + "dnsServerIpEntityId": { + "description": "An ip entity id for the dns server resolving the request", + "readOnly": true, + "type": "string" + }, + "domainName": { + "description": "The name of the dns record associated with the alert", + "readOnly": true, + "type": "string" + }, + "hostIpAddressEntityId": { + "description": "An ip entity id for the dns request client", + "readOnly": true, + "type": "string" + }, + "ipAddressEntityIds": { + "description": "Ip entity identifiers for the resolved ip address.", + "items": { + "description": "Ip entity id", + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "Entity": { + "allOf": [ + { + "$ref": "../../../common/1.0/types.json#/definitions/Resource" + } + ], + "properties": { + "kind": { + "$ref": "#/definitions/EntityInnerKind", + "description": "The kind of the entity." + } + }, + "description": "Specific entity.", + "discriminator": "kind", + "type": "object", + "required": [ + "kind" + ] + }, + "EntityCommonProperties": { + "description": "Entity common property bag.", + "properties": { + "additionalData": { + "additionalProperties": { + "type": "object" + }, + "description": "A bag of custom fields that should be part of the entity and will be presented to the user.", + "readOnly": true, + "type": "object" + }, + "friendlyName": { + "description": "The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "EntityInnerKind": { + "description": "The kind of the entity", + "enum": [ + "Account", + "Host", + "File", + "AzureResource", + "CloudApplication", + "DnsResolution", + "FileHash", + "Ip", + "Malware", + "Process", + "RegistryKey", + "RegistryValue", + "SecurityGroup", + "Url", + "IoTDevice", + "SecurityAlert", + "Bookmark", + "Mailbox", + "MailCluster", + "MailMessage", + "SubmissionMail" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "EntityKind", + "values": [ + { + "description": "Entity represents account in the system.", + "value": "Account" + }, + { + "description": "Entity represents host in the system.", + "value": "Host" + }, + { + "description": "Entity represents file in the system.", + "value": "File" + }, + { + "description": "Entity represents azure resource in the system.", + "value": "AzureResource" + }, + { + "description": "Entity represents cloud application in the system.", + "value": "CloudApplication" + }, + { + "description": "Entity represents dns resolution in the system.", + "value": "DnsResolution" + }, + { + "description": "Entity represents file hash in the system.", + "value": "FileHash" + }, + { + "description": "Entity represents ip in the system.", + "value": "Ip" + }, + { + "description": "Entity represents malware in the system.", + "value": "Malware" + }, + { + "description": "Entity represents process in the system.", + "value": "Process" + }, + { + "description": "Entity represents registry key in the system.", + "value": "RegistryKey" + }, + { + "description": "Entity represents registry value in the system.", + "value": "RegistryValue" + }, + { + "description": "Entity represents security group in the system.", + "value": "SecurityGroup" + }, + { + "description": "Entity represents url in the system.", + "value": "Url" + }, + { + "description": "Entity represents IoT device in the system.", + "value": "IoTDevice" + }, + { + "description": "Entity represents security alert in the system.", + "value": "SecurityAlert" + }, + { + "description": "Entity represents bookmark in the system.", + "value": "Bookmark" + }, + { + "description": "Entity represents mail cluster in the system.", + "value": "MailCluster" + }, + { + "description": "Entity represents mail message in the system.", + "value": "MailMessage" + }, + { + "description": "Entity represents mailbox in the system.", + "value": "Mailbox" + }, + { + "description": "Entity represents submission mail in the system.", + "value": "SubmissionMail" + } + ] + } + }, + "EntityTimelineItem": { + "description": "Entity timeline Item.", + "discriminator": "kind", + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/EntityTimelineKind", + "description": "The entity query kind type." + } + }, + "required": [ + "kind" + ] + }, + "EntityTimelineKind": { + "description": "The entity query kind", + "enum": [ + "Activity", + "Bookmark", + "SecurityAlert" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "EntityTimelineKind", + "values": [ + { + "description": "activity", + "value": "Activity" + }, + { + "description": "bookmarks", + "value": "Bookmark" + }, + { + "description": "security alerts", + "value": "SecurityAlert" + } + ] + } + }, + "FileEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a file entity.", + "properties": { + "properties": { + "$ref": "#/definitions/FileEntityProperties", + "description": "File entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "File" + }, + "FileEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "File entity property bag.", + "properties": { + "directory": { + "description": "The full path to the file.", + "readOnly": true, + "type": "string" + }, + "fileHashEntityIds": { + "description": "The file hash entity identifiers associated with this file", + "items": { + "description": "file hash id", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "fileName": { + "description": "The file name without path (some alerts might not include path).", + "readOnly": true, + "type": "string" + }, + "hostEntityId": { + "description": "The Host entity id which the file belongs to", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "FileHashEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a file hash entity.", + "properties": { + "properties": { + "$ref": "#/definitions/FileHashEntityProperties", + "description": "FileHash entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "FileHash" + }, + "FileHashEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "FileHash entity property bag.", + "properties": { + "algorithm": { + "description": "The hash algorithm type.", + "enum": [ + "Unknown", + "MD5", + "SHA1", + "SHA256", + "SHA256AC" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "FileHashAlgorithm", + "values": [ + { + "description": "Unknown hash algorithm", + "value": "Unknown" + }, + { + "description": "MD5 hash type", + "value": "MD5" + }, + { + "description": "SHA1 hash type", + "value": "SHA1" + }, + { + "description": "SHA256 hash type", + "value": "SHA256" + }, + { + "description": "SHA256 Authenticode hash type", + "value": "SHA256AC" + } + ] + } + }, + "hashValue": { + "description": "The file hash value.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GeoLocation": { + "description": "The geo-location context attached to the ip entity", + "properties": { + "asn": { + "description": "Autonomous System Number", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "city": { + "description": "City name", + "readOnly": true, + "type": "string" + }, + "countryCode": { + "description": "The country code according to ISO 3166 format", + "readOnly": true, + "type": "string" + }, + "countryName": { + "description": "Country name according to ISO 3166 Alpha 2: the lowercase of the English Short Name", + "readOnly": true, + "type": "string" + }, + "latitude": { + "description": "The longitude of the identified location, expressed as a floating point number with range of -180 to 180, with positive numbers representing East and negative numbers representing West. Latitude and longitude are derived from the city or postal code.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "longitude": { + "description": "The latitude of the identified location, expressed as a floating point number with range of - 90 to 90, with positive numbers representing North and negative numbers representing South. Latitude and longitude are derived from the city or postal code.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "state": { + "description": "State name", + "readOnly": true, + "type": "string" + } + }, + "readOnly": true, + "type": "object" + }, + "HostEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a host entity.", + "properties": { + "properties": { + "$ref": "#/definitions/HostEntityProperties", + "description": "Host entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Host" + }, + "HostEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Host entity property bag.", + "properties": { + "azureID": { + "description": "The azure resource id of the VM.", + "readOnly": true, + "type": "string" + }, + "dnsDomain": { + "description": "The DNS domain that this host belongs to. Should contain the compete DNS suffix for the domain", + "readOnly": true, + "type": "string" + }, + "hostName": { + "description": "The hostname without the domain suffix.", + "readOnly": true, + "type": "string" + }, + "isDomainJoined": { + "description": "Determines whether this host belongs to a domain.", + "readOnly": true, + "type": "boolean" + }, + "netBiosName": { + "description": "The host name (pre-windows2000).", + "readOnly": true, + "type": "string" + }, + "ntDomain": { + "description": "The NT domain that this host belongs to.", + "readOnly": true, + "type": "string" + }, + "omsAgentID": { + "description": "The OMS agent id, if the host has OMS agent installed.", + "readOnly": true, + "type": "string" + }, + "osFamily": { + "description": "The operating system type.", + "enum": [ + "Linux", + "Windows", + "Android", + "IOS", + "Unknown" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": false, + "name": "OSFamily", + "values": [ + { + "description": "Host with Linux operating system.", + "value": "Linux" + }, + { + "description": "Host with Windows operating system.", + "value": "Windows" + }, + { + "description": "Host with Android operating system.", + "value": "Android" + }, + { + "description": "Host with IOS operating system.", + "value": "IOS" + }, + { + "description": "Host with Unknown operating system.", + "value": "Unknown" + } + ] + } + }, + "osVersion": { + "description": "A free text representation of the operating system. This field is meant to hold specific versions the are more fine grained than OSFamily or future values not supported by OSFamily enumeration", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "HuntingBookmark": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a Hunting bookmark entity.", + "properties": { + "properties": { + "$ref": "#/definitions/HuntingBookmarkProperties", + "description": "HuntingBookmark entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Bookmark" + }, + "HuntingBookmarkProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Describes bookmark properties", + "properties": { + "created": { + "description": "The time the bookmark was created", + "format": "date-time", + "type": "string" + }, + "createdBy": { + "$ref": "#/definitions/UserInfo", + "description": "Describes a user that created the bookmark", + "type": "object" + }, + "displayName": { + "description": "The display name of the bookmark", + "type": "string" + }, + "eventTime": { + "description": "The time of the event", + "format": "date-time", + "type": "string" + }, + "labels": { + "description": "List of labels relevant to this bookmark", + "items": { + "$ref": "#/definitions/Label" + }, + "type": "array" + }, + "notes": { + "description": "The notes of the bookmark", + "type": "string" + }, + "query": { + "description": "The query of the bookmark.", + "type": "string" + }, + "queryResult": { + "description": "The query result of the bookmark.", + "type": "string" + }, + "updated": { + "description": "The last time the bookmark was updated", + "format": "date-time", + "type": "string" + }, + "updatedBy": { + "$ref": "#/definitions/UserInfo", + "description": "Describes a user that updated the bookmark", + "type": "object" + }, + "incidentInfo": { + "$ref": "#/definitions/IncidentInfo", + "description": "Describes an incident that relates to bookmark", + "type": "object" + } + }, + "required": [ + "displayName", + "query" + ], + "type": "object" + }, + "Incident": { + "allOf": [ + { + "$ref": "../../../common/1.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents an incident in Azure Security Insights.", + "properties": { + "properties": { + "$ref": "#/definitions/IncidentProperties", + "description": "Incident properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "IncidentAdditionalData": { + "description": "Incident additional data property bag.", + "properties": { + "alertsCount": { + "description": "The number of alerts in the incident", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "bookmarksCount": { + "description": "The number of bookmarks in the incident", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "commentsCount": { + "description": "The number of comments in the incident", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "alertProductNames": { + "description": "List of product names of alerts in the incident", + "items": { + "description": "Alert product name", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "tactics": { + "description": "The tactics associated with incident", + "items": { + "$ref": "#/definitions/AttackTactic" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "IncidentAlertList": { + "description": "List of incident alerts.", + "properties": { + "value": { + "description": "Array of incident alerts.", + "type": "array", + "items": { + "$ref": "#/definitions/SecurityAlert" + } + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "IncidentBookmarkList": { + "description": "List of incident bookmarks.", + "properties": { + "value": { + "description": "Array of incident bookmarks.", + "type": "array", + "items": { + "$ref": "#/definitions/HuntingBookmark" + } + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "IncidentComment": { + "allOf": [ + { + "$ref": "../../../common/1.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents an incident comment", + "properties": { + "properties": { + "$ref": "#/definitions/IncidentCommentProperties", + "description": "Incident comment properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "IncidentCommentList": { + "description": "List of incident comments.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of comments.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of comments.", + "items": { + "$ref": "#/definitions/IncidentComment" + }, + "type": "array" + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "IncidentCommentProperties": { + "description": "Incident comment property bag.", + "properties": { + "createdTimeUtc": { + "description": "The time the comment was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "lastModifiedTimeUtc": { + "description": "The time the comment was updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "The comment message", + "type": "string" + }, + "author": { + "$ref": "#/definitions/ClientInfo", + "description": "Describes the client that created the comment", + "readOnly": true, + "type": "object" + } + }, + "required": [ + "message" + ], + "type": "object" + }, + "IncidentEntitiesResponse": { + "description": "The incident related entities response.", + "properties": { + "entities": { + "description": "Array of the incident related entities.", + "type": "array", + "items": { + "$ref": "#/definitions/Entity" + } + }, + "metaData": { + "description": "The metadata from the incident related entities results.", + "type": "array", + "items": { + "$ref": "#/definitions/IncidentEntitiesResultsMetadata" + } + } + }, + "type": "object" + }, + "IncidentEntitiesResultsMetadata": { + "description": "Information of a specific aggregation in the incident related entities result.", + "properties": { + "count": { + "description": "Total number of aggregations of the given kind in the incident related entities result.", + "type": "integer", + "format": "int32" + }, + "entityKind": { + "$ref": "#/definitions/EntityInnerKind", + "description": "The kind of the aggregated entity." + } + }, + "required": [ + "entityKind", + "count" + ], + "type": "object" + }, + "IncidentInfo": { + "description": "Describes related incident information for the bookmark", + "properties": { + "incidentId": { + "description": "Incident Id", + "type": "string" + }, + "severity": { + "description": "The severity of the incident", + "enum": [ + "Critical", + "High", + "Medium", + "Low", + "Informational" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "CaseSeverity", + "values": [ + { + "description": "Critical severity", + "value": "Critical" + }, + { + "description": "High severity", + "value": "High" + }, + { + "description": "Medium severity", + "value": "Medium" + }, + { + "description": "Low severity", + "value": "Low" + }, + { + "description": "Informational severity", + "value": "Informational" + } + ] + } + }, + "teamInformation": { + "$ref": "#/definitions/TeamInformation", + "description": "Describes a team for the incident", + "type": "object" + }, + "title": { + "description": "The title of the incident", + "type": "string" + }, + "relationName": { + "description": "Relation Name", + "type": "string" + } + }, + "type": "object" + }, + "IncidentLabel": { + "description": "Represents an incident label", + "properties": { + "labelName": { + "description": "The name of the label", + "type": "string" + }, + "labelType": { + "description": "The type of the label", + "enum": [ + "User", + "System" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "modelAsString": true, + "name": "IncidentLabelType", + "values": [ + { + "description": "Label manually created by a user", + "value": "User" + }, + { + "description": "Label automatically created by the system", + "value": "System" + } + ] + } + } + }, + "required": [ + "labelName" + ], + "type": "object" + }, + "IncidentList": { + "description": "List all the incidents.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of incidents.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of incidents.", + "items": { + "$ref": "#/definitions/Incident" + }, + "type": "array" + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "IncidentOwnerInfo": { + "description": "Information on the user an incident is assigned to", + "properties": { + "email": { + "description": "The email of the user the incident is assigned to.", + "type": "string" + }, + "assignedTo": { + "description": "The name of the user the incident is assigned to.", + "type": "string" + }, + "objectId": { + "description": "The object id of the user the incident is assigned to.", + "format": "uuid", + "type": "string" + }, + "userPrincipalName": { + "description": "The user principal name of the user the incident is assigned to.", + "type": "string" + }, + "ownerType": { + "readOnly": true, + "description": "The type of the owner the incident is assigned to.", + "type": "string", + "enum": [ + "Unknown", + "User", + "Group" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "OwnerType", + "values": [ + { + "description": "The incident owner type is unknown", + "value": "Unknown" + }, + { + "description": "The incident owner type is an AAD user", + "value": "User" + }, + { + "description": "The incident owner type is an AAD group", + "value": "Group" + } + ] + } + } + }, + "type": "object" + }, + "IncidentProperties": { + "description": "Describes incident properties", + "properties": { + "additionalData": { + "$ref": "#/definitions/IncidentAdditionalData", + "description": "Additional data on the incident", + "readOnly": true, + "type": "object" + }, + "classification": { + "description": "The reason the incident was closed", + "enum": [ + "Undetermined", + "TruePositive", + "BenignPositive", + "FalsePositive" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "IncidentClassification", + "values": [ + { + "description": "Incident classification was undetermined", + "value": "Undetermined" + }, + { + "description": "Incident was true positive", + "value": "TruePositive" + }, + { + "description": "Incident was benign positive", + "value": "BenignPositive" + }, + { + "description": "Incident was false positive", + "value": "FalsePositive" + } + ] + } + }, + "classificationComment": { + "description": "Describes the reason the incident was closed", + "type": "string" + }, + "classificationReason": { + "description": "The classification reason the incident was closed with", + "enum": [ + "SuspiciousActivity", + "SuspiciousButExpected", + "IncorrectAlertLogic", + "InaccurateData" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "IncidentClassificationReason", + "values": [ + { + "description": "Classification reason was suspicious activity", + "value": "SuspiciousActivity" + }, + { + "description": "Classification reason was suspicious but expected", + "value": "SuspiciousButExpected" + }, + { + "description": "Classification reason was incorrect alert logic", + "value": "IncorrectAlertLogic" + }, + { + "description": "Classification reason was inaccurate data", + "value": "InaccurateData" + } + ] + } + }, + "createdTimeUtc": { + "description": "The time the incident was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "The description of the incident", + "type": "string" + }, + "firstActivityTimeUtc": { + "description": "The time of the first activity in the incident", + "format": "date-time", + "type": "string" + }, + "incidentUrl": { + "description": "The deep-link url to the incident in Azure portal", + "readOnly": true, + "type": "string" + }, + "incidentNumber": { + "description": "A sequential number", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "labels": { + "description": "List of labels relevant to this incident", + "items": { + "$ref": "#/definitions/IncidentLabel" + }, + "type": "array" + }, + "providerName": { + "description": "The name of the source provider that generated the incident", + "type": "string" + }, + "providerIncidentId": { + "description": "The incident ID assigned by the incident provider", + "type": "string" + }, + "lastActivityTimeUtc": { + "description": "The time of the last activity in the incident", + "format": "date-time", + "type": "string" + }, + "lastModifiedTimeUtc": { + "description": "The last time the incident was updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "owner": { + "$ref": "#/definitions/IncidentOwnerInfo", + "description": "Describes a user that the incident is assigned to", + "type": "object" + }, + "relatedAnalyticRuleIds": { + "description": "List of resource ids of Analytic rules related to the incident", + "items": { + "description": "Related Analytic rule resource id", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "severity": { + "description": "The severity of the incident", + "enum": [ + "High", + "Medium", + "Low", + "Informational" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "IncidentSeverity", + "values": [ + { + "description": "High severity", + "value": "High" + }, + { + "description": "Medium severity", + "value": "Medium" + }, + { + "description": "Low severity", + "value": "Low" + }, + { + "description": "Informational severity", + "value": "Informational" + } + ] + } + }, + "status": { + "description": "The status of the incident", + "enum": [ + "New", + "Active", + "Closed" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "IncidentStatus", + "values": [ + { + "description": "An active incident which isn't being handled currently", + "value": "New" + }, + { + "description": "An active incident which is being handled", + "value": "Active" + }, + { + "description": "A non-active incident", + "value": "Closed" + } + ] + } + }, + "title": { + "description": "The title of the incident", + "type": "string" + } + }, + "required": [ + "title", + "severity", + "status" + ], + "type": "object" + }, + "IoTDeviceEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents an IoT device entity.", + "properties": { + "properties": { + "$ref": "#/definitions/IoTDeviceEntityProperties", + "description": "IoTDevice entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "IoTDevice" + }, + "IoTDeviceEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "IoTDevice entity property bag.", + "properties": { + "deviceId": { + "description": "The ID of the IoT Device in the IoT Hub", + "readOnly": true, + "type": "string" + }, + "deviceName": { + "description": "The friendly name of the device", + "readOnly": true, + "type": "string" + }, + "source": { + "description": "The source of the device", + "readOnly": true, + "type": "string" + }, + "iotSecurityAgentId": { + "description": "The ID of the security agent running on the device", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "deviceType": { + "description": "The type of the device", + "readOnly": true, + "type": "string" + }, + "vendor": { + "description": "The vendor of the device", + "readOnly": true, + "type": "string" + }, + "edgeId": { + "description": "The ID of the edge device", + "readOnly": true, + "type": "string" + }, + "macAddress": { + "description": "The MAC address of the device", + "readOnly": true, + "type": "string" + }, + "model": { + "description": "The model of the device", + "readOnly": true, + "type": "string" + }, + "serialNumber": { + "description": "The serial number of the device", + "readOnly": true, + "type": "string" + }, + "firmwareVersion": { + "description": "The firmware version of the device", + "readOnly": true, + "type": "string" + }, + "operatingSystem": { + "description": "The operating system of the device", + "readOnly": true, + "type": "string" + }, + "iotHubEntityId": { + "description": "The AzureResource entity id of the IoT Hub", + "readOnly": true, + "type": "string" + }, + "hostEntityId": { + "description": "The Host entity id of this device", + "readOnly": true, + "type": "string" + }, + "ipAddressEntityId": { + "description": "The IP entity if of this device", + "readOnly": true, + "type": "string" + }, + "threatIntelligence": { + "description": "A list of TI contexts attached to the IoTDevice entity.", + "items": { + "$ref": "#/definitions/ThreatIntelligence" + }, + "readOnly": true, + "type": "array" + }, + "protocols": { + "description": "A list of protocols of the IoTDevice entity.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "IpEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents an ip entity.", + "properties": { + "properties": { + "$ref": "#/definitions/IpEntityProperties", + "description": "Ip entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Ip" + }, + "IpEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Ip entity property bag.", + "properties": { + "address": { + "description": "The IP address as string, e.g. 127.0.0.1 (either in Ipv4 or Ipv6)", + "readOnly": true, + "type": "string" + }, + "location": { + "$ref": "#/definitions/GeoLocation", + "description": "The geo-location context attached to the ip entity" + }, + "threatIntelligence": { + "description": "A list of TI contexts attached to the ip entity.", + "items": { + "$ref": "#/definitions/ThreatIntelligence" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "Label": { + "description": "Label that will be used to tag and filter on.", + "type": "string" + }, + "MailboxEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a mailbox entity.", + "properties": { + "properties": { + "$ref": "#/definitions/MailboxEntityProperties", + "description": "Mailbox entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Mailbox" + }, + "MailboxEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Mailbox entity property bag.", + "properties": { + "mailboxPrimaryAddress": { + "description": "The mailbox's primary address", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "The mailbox's display name", + "readOnly": true, + "type": "string" + }, + "upn": { + "description": "The mailbox's UPN", + "readOnly": true, + "type": "string" + }, + "externalDirectoryObjectId": { + "description": "The AzureAD identifier of mailbox. Similar to AadUserId in account entity but this property is specific to mailbox object on office side", + "format": "uuid", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "MailClusterEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a mail cluster entity.", + "properties": { + "properties": { + "$ref": "#/definitions/MailClusterEntityProperties", + "description": "Mail cluster entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MailCluster" + }, + "MailClusterEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Mail cluster entity property bag.", + "properties": { + "networkMessageIds": { + "description": "The mail message IDs that are part of the mail cluster", + "items": { + "description": "A mail message ID", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "countByDeliveryStatus": { + "description": "Count of mail messages by DeliveryStatus string representation", + "readOnly": true, + "type": "object" + }, + "countByThreatType": { + "description": "Count of mail messages by ThreatType string representation", + "readOnly": true, + "type": "object" + }, + "countByProtectionStatus": { + "description": "Count of mail messages by ProtectionStatus string representation", + "readOnly": true, + "type": "object" + }, + "threats": { + "description": "The threats of mail messages that are part of the mail cluster", + "items": { + "description": "A threat", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "query": { + "description": "The query that was used to identify the messages of the mail cluster", + "readOnly": true, + "type": "string" + }, + "queryTime": { + "description": "The query time", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "mailCount": { + "description": "The number of mail messages that are part of the mail cluster", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "isVolumeAnomaly": { + "description": "Is this a volume anomaly mail cluster", + "readOnly": true, + "type": "boolean" + }, + "source": { + "description": "The source of the mail cluster (default is 'O365 ATP')", + "readOnly": true, + "type": "string" + }, + "clusterSourceIdentifier": { + "description": "The id of the cluster source", + "readOnly": true, + "type": "string" + }, + "clusterSourceType": { + "description": "The type of the cluster source", + "readOnly": true, + "type": "string" + }, + "clusterQueryStartTime": { + "description": "The cluster query start time", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "clusterQueryEndTime": { + "description": "The cluster query end time", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "clusterGroup": { + "description": "The cluster group", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "MailMessageEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a mail message entity.", + "properties": { + "properties": { + "$ref": "#/definitions/MailMessageEntityProperties", + "description": "Mail message entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MailMessage" + }, + "MailMessageEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Mail message entity property bag.", + "properties": { + "fileEntityIds": { + "description": "The File entity ids of this mail message's attachments", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "recipient": { + "description": "The recipient of this mail message. Note that in case of multiple recipients the mail message is forked and each copy has one recipient", + "readOnly": true, + "type": "string" + }, + "urls": { + "description": "The Urls contained in this mail message", + "items": { + "description": "A Url contained in this mail message", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "threats": { + "description": "The threats of this mail message", + "items": { + "description": "A threat of the mail message", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "p1Sender": { + "description": "The p1 sender's email address", + "readOnly": true, + "type": "string" + }, + "p1SenderDisplayName": { + "description": "The p1 sender's display name", + "readOnly": true, + "type": "string" + }, + "p1SenderDomain": { + "description": "The p1 sender's domain", + "readOnly": true, + "type": "string" + }, + "senderIP": { + "description": "The sender's IP address", + "readOnly": true, + "type": "string" + }, + "p2Sender": { + "description": "The p2 sender's email address", + "readOnly": true, + "type": "string" + }, + "p2SenderDisplayName": { + "description": "The p2 sender's display name", + "readOnly": true, + "type": "string" + }, + "p2SenderDomain": { + "description": "The p2 sender's domain", + "readOnly": true, + "type": "string" + }, + "receiveDate": { + "description": "The receive date of this message", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "networkMessageId": { + "description": "The network message id of this mail message", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "internetMessageId": { + "description": "The internet message id of this mail message", + "readOnly": true, + "type": "string" + }, + "subject": { + "description": "The subject of this mail message", + "readOnly": true, + "type": "string" + }, + "language": { + "description": "The language of this mail message", + "readOnly": true, + "type": "string" + }, + "threatDetectionMethods": { + "description": "The threat detection methods", + "items": { + "description": "A threat detection method", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "bodyFingerprintBin1": { + "description": "The bodyFingerprintBin1", + "type": "integer", + "format": "int32" + }, + "bodyFingerprintBin2": { + "description": "The bodyFingerprintBin2", + "type": "integer", + "format": "int32" + }, + "bodyFingerprintBin3": { + "description": "The bodyFingerprintBin3", + "type": "integer", + "format": "int32" + }, + "bodyFingerprintBin4": { + "description": "The bodyFingerprintBin4", + "type": "integer", + "format": "int32" + }, + "bodyFingerprintBin5": { + "description": "The bodyFingerprintBin5", + "type": "integer", + "format": "int32" + }, + "antispamDirection": { + "description": "The directionality of this mail message", + "enum": [ + "Unknown", + "Inbound", + "Outbound", + "Intraorg" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AntispamMailDirection", + "values": [ + { + "description": "Unknown", + "value": "Unknown" + }, + { + "description": "Inbound", + "value": "Inbound" + }, + { + "description": "Outbound", + "value": "Outbound" + }, + { + "description": "Intraorg", + "value": "Intraorg" + } + ] + } + }, + "deliveryAction": { + "description": "The delivery action of this mail message like Delivered, Blocked, Replaced etc", + "enum": [ + "Unknown", + "DeliveredAsSpam", + "Delivered", + "Blocked", + "Replaced" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": false, + "name": "DeliveryAction", + "values": [ + { + "description": "Unknown", + "value": "Unknown" + }, + { + "description": "DeliveredAsSpam", + "value": "DeliveredAsSpam" + }, + { + "description": "Delivered", + "value": "Delivered" + }, + { + "description": "Blocked", + "value": "Blocked" + }, + { + "description": "Replaced", + "value": "Replaced" + } + ] + } + }, + "deliveryLocation": { + "description": "The delivery location of this mail message like Inbox, JunkFolder etc", + "enum": [ + "Unknown", + "Inbox", + "JunkFolder", + "DeletedFolder", + "Quarantine", + "External", + "Failed", + "Dropped", + "Forwarded" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": false, + "name": "DeliveryLocation", + "values": [ + { + "description": "Unknown", + "value": "Unknown" + }, + { + "description": "Inbox", + "value": "Inbox" + }, + { + "description": "JunkFolder", + "value": "JunkFolder" + }, + { + "description": "DeletedFolder", + "value": "DeletedFolder" + }, + { + "description": "Quarantine", + "value": "Quarantine" + }, + { + "description": "External", + "value": "External" + }, + { + "description": "Failed", + "value": "Failed" + }, + { + "description": "Dropped", + "value": "Dropped" + }, + { + "description": "Forwarded", + "value": "Forwarded" + } + ] + } + } + }, + "type": "object" + }, + "MalwareEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a malware entity.", + "properties": { + "properties": { + "$ref": "#/definitions/MalwareEntityProperties", + "description": "File entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Malware" + }, + "MalwareEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Malware entity property bag.", + "properties": { + "category": { + "description": "The malware category by the vendor, e.g. Trojan", + "readOnly": true, + "type": "string" + }, + "fileEntityIds": { + "description": "List of linked file entity identifiers on which the malware was found", + "items": { + "description": "file entity id", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "malwareName": { + "description": "The malware name by the vendor, e.g. Win32/Toga!rfn", + "readOnly": true, + "type": "string" + }, + "processEntityIds": { + "description": "List of linked process entity identifiers on which the malware was found.", + "items": { + "description": "process entity id", + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "ProcessEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a process entity.", + "properties": { + "properties": { + "$ref": "#/definitions/ProcessEntityProperties", + "description": "Process entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Process" + }, + "ProcessEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Process entity property bag.", + "properties": { + "accountEntityId": { + "description": "The account entity id running the processes.", + "readOnly": true, + "type": "string" + }, + "commandLine": { + "description": "The command line used to create the process", + "readOnly": true, + "type": "string" + }, + "creationTimeUtc": { + "description": "The time when the process started to run", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "elevationToken": { + "description": "The elevation token associated with the process.", + "enum": [ + "Default", + "Full", + "Limited" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": false, + "name": "ElevationToken", + "values": [ + { + "description": "Default elevation token", + "value": "Default" + }, + { + "description": "Full elevation token", + "value": "Full" + }, + { + "description": "Limited elevation token", + "value": "Limited" + } + ] + } + }, + "hostEntityId": { + "description": "The host entity id on which the process was running", + "readOnly": true, + "type": "string" + }, + "hostLogonSessionEntityId": { + "description": "The session entity id in which the process was running", + "readOnly": true, + "type": "string" + }, + "imageFileEntityId": { + "description": "Image file entity id", + "readOnly": true, + "type": "string" + }, + "parentProcessEntityId": { + "description": "The parent process entity id.", + "readOnly": true, + "type": "string" + }, + "processId": { + "description": "The process ID", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "RegistryKeyEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a registry key entity.", + "properties": { + "properties": { + "$ref": "#/definitions/RegistryKeyEntityProperties", + "description": "RegistryKey entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "RegistryKey" + }, + "RegistryKeyEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "RegistryKey entity property bag.", + "properties": { + "hive": { + "description": "the hive that holds the registry key.", + "enum": [ + "HKEY_LOCAL_MACHINE", + "HKEY_CLASSES_ROOT", + "HKEY_CURRENT_CONFIG", + "HKEY_USERS", + "HKEY_CURRENT_USER_LOCAL_SETTINGS", + "HKEY_PERFORMANCE_DATA", + "HKEY_PERFORMANCE_NLSTEXT", + "HKEY_PERFORMANCE_TEXT", + "HKEY_A", + "HKEY_CURRENT_USER" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "RegistryHive", + "values": [ + { + "description": "HKEY_LOCAL_MACHINE", + "value": "HKEY_LOCAL_MACHINE" + }, + { + "description": "HKEY_CLASSES_ROOT", + "value": "HKEY_CLASSES_ROOT" + }, + { + "description": "HKEY_CURRENT_CONFIG", + "value": "HKEY_CURRENT_CONFIG" + }, + { + "description": "HKEY_USERS", + "value": "HKEY_USERS" + }, + { + "description": "HKEY_CURRENT_USER_LOCAL_SETTINGS", + "value": "HKEY_CURRENT_USER_LOCAL_SETTINGS" + }, + { + "description": "HKEY_PERFORMANCE_DATA", + "value": "HKEY_PERFORMANCE_DATA" + }, + { + "description": "HKEY_PERFORMANCE_NLSTEXT", + "value": "HKEY_PERFORMANCE_NLSTEXT" + }, + { + "description": "HKEY_PERFORMANCE_TEXT", + "value": "HKEY_PERFORMANCE_TEXT" + }, + { + "description": "HKEY_A", + "value": "HKEY_A" + }, + { + "description": "HKEY_CURRENT_USER", + "value": "HKEY_CURRENT_USER" + } + ] + } + }, + "key": { + "description": "The registry key path.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "RegistryValueEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a registry value entity.", + "properties": { + "properties": { + "$ref": "#/definitions/RegistryValueEntityProperties", + "description": "RegistryKey entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "RegistryValue" + }, + "RegistryValueEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "RegistryValue entity property bag.", + "properties": { + "keyEntityId": { + "description": "The registry key entity id.", + "readOnly": true, + "type": "string" + }, + "valueData": { + "description": "String formatted representation of the value data.", + "readOnly": true, + "type": "string" + }, + "valueName": { + "description": "The registry value name.", + "readOnly": true, + "type": "string" + }, + "valueType": { + "description": "Specifies the data types to use when storing values in the registry, or identifies the data type of a value in the registry.", + "enum": [ + "None", + "Unknown", + "String", + "ExpandString", + "Binary", + "DWord", + "MultiString", + "QWord" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "RegistryValueKind", + "values": [ + { + "description": "None", + "value": "None" + }, + { + "description": "Unknown value type", + "value": "Unknown" + }, + { + "description": "String value type", + "value": "String" + }, + { + "description": "ExpandString value type", + "value": "ExpandString" + }, + { + "description": "Binary value type", + "value": "Binary" + }, + { + "description": "DWord value type", + "value": "DWord" + }, + { + "description": "MultiString value type", + "value": "MultiString" + }, + { + "description": "QWord value type", + "value": "QWord" + } + ] + } + } + }, + "type": "object" + }, + "Relation": { + "type": "object", + "description": "Represents a relation between two resources", + "allOf": [ + { + "$ref": "../../../common/1.0/types.json#/definitions/ResourceWithEtag" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RelationProperties", + "description": "Relation properties", + "x-ms-client-flatten": true + } + } + }, + "RelationList": { + "description": "List of relations.", + "properties": { + "nextLink": { + "readOnly": true, + "description": "URL to fetch the next set of relations.", + "type": "string" + }, + "value": { + "description": "Array of relations.", + "type": "array", + "items": { + "$ref": "#/definitions/Relation" + } + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "RelationProperties": { + "description": "Relation property bag.", + "properties": { + "relatedResourceId": { + "description": "The resource ID of the related resource", + "type": "string" + }, + "relatedResourceName": { + "description": "The name of the related resource", + "readOnly": true, + "type": "string" + }, + "relatedResourceType": { + "description": "The resource type of the related resource", + "readOnly": true, + "type": "string" + }, + "relatedResourceKind": { + "description": "The resource kind of the related resource", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "relatedResourceId" + ], + "type": "object" + }, + "SecurityAlert": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a security alert entity.", + "properties": { + "properties": { + "$ref": "#/definitions/SecurityAlertProperties", + "description": "SecurityAlert entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "SecurityAlert" + }, + "SecurityAlertProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "SecurityAlert entity property bag.", + "properties": { + "alertDisplayName": { + "description": "The display name of the alert.", + "readOnly": true, + "type": "string" + }, + "alertType": { + "description": "The type name of the alert.", + "readOnly": true, + "type": "string" + }, + "compromisedEntity": { + "description": "Display name of the main entity being reported on.", + "readOnly": true, + "type": "string" + }, + "confidenceLevel": { + "description": "The confidence level of this alert.", + "enum": [ + "Unknown", + "Low", + "High" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ConfidenceLevel", + "values": [ + { + "description": "Unknown confidence, the is the default value", + "value": "Unknown" + }, + { + "description": "Low confidence, meaning we have some doubts this is indeed malicious or part of an attack", + "value": "Low" + }, + { + "description": "High confidence that the alert is true positive malicious", + "value": "High" + } + ] + } + }, + "confidenceReasons": { + "description": "The confidence reasons", + "items": { + "description": "confidence reason item", + "properties": { + "reason": { + "description": "The reason's description", + "readOnly": true, + "type": "string" + }, + "reasonType": { + "description": "The type (category) of the reason", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "readOnly": true, + "type": "array" + }, + "confidenceScore": { + "description": "The confidence score of the alert.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "confidenceScoreStatus": { + "description": "The confidence score calculation status, i.e. indicating if score calculation is pending for this alert, not applicable or final.", + "enum": [ + "NotApplicable", + "InProcess", + "NotFinal", + "Final" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ConfidenceScoreStatus", + "values": [ + { + "description": "Score will not be calculated for this alert as it is not supported by virtual analyst", + "value": "NotApplicable" + }, + { + "description": "No score was set yet and calculation is in progress", + "value": "InProcess" + }, + { + "description": "Score is calculated and shown as part of the alert, but may be updated again at a later time following the processing of additional data", + "value": "NotFinal" + }, + { + "description": "Final score was calculated and available", + "value": "Final" + } + ] + } + }, + "description": { + "description": "Alert description.", + "readOnly": true, + "type": "string" + }, + "endTimeUtc": { + "description": "The impact end time of the alert (the time of the last event contributing to the alert).", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "intent": { + "description": "Holds the alert intent stage(s) mapping for this alert.", + "enum": [ + "Unknown", + "Probing", + "Exploitation", + "Persistence", + "PrivilegeEscalation", + "DefenseEvasion", + "CredentialAccess", + "Discovery", + "LateralMovement", + "Execution", + "Collection", + "Exfiltration", + "CommandAndControl", + "Impact" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "KillChainIntent", + "values": [ + { + "description": "The default value.", + "value": "Unknown" + }, + { + "description": "Probing could be an attempt to access a certain resource regardless of a malicious intent or a failed attempt to gain access to a target system to gather information prior to exploitation. This step is usually detected as an attempt originating from outside the network in attempt to scan the target system and find a way in.", + "value": "Probing" + }, + { + "description": "Exploitation is the stage where an attacker manage to get foothold on the attacked resource. This stage is applicable not only for compute hosts, but also for resources such as user accounts, certificates etc. Adversaries will often be able to control the resource after this stage.", + "value": "Exploitation" + }, + { + "description": "Persistence is any access, action, or configuration change to a system that gives an adversary a persistent presence on that system. Adversaries will often need to maintain access to systems through interruptions such as system restarts, loss of credentials, or other failures that would require a remote access tool to restart or alternate backdoor for them to regain access.", + "value": "Persistence" + }, + { + "description": "Privilege escalation is the result of actions that allow an adversary to obtain a higher level of permissions on a system or network. Certain tools or actions require a higher level of privilege to work and are likely necessary at many points throughout an operation. User accounts with permissions to access specific systems or perform specific functions necessary for adversaries to achieve their objective may also be considered an escalation of privilege.", + "value": "PrivilegeEscalation" + }, + { + "description": "Defense evasion consists of techniques an adversary may use to evade detection or avoid other defenses. Sometimes these actions are the same as or variations of techniques in other categories that have the added benefit of subverting a particular defense or mitigation. ", + "value": "DefenseEvasion" + }, + { + "description": "Credential access represents techniques resulting in access to or control over system, domain, or service credentials that are used within an enterprise environment. Adversaries will likely attempt to obtain legitimate credentials from users or administrator accounts (local system administrator or domain users with administrator access) to use within the network. With sufficient access within a network, an adversary can create accounts for later use within the environment.", + "value": "CredentialAccess" + }, + { + "description": "Discovery consists of techniques that allow the adversary to gain knowledge about the system and internal network. When adversaries gain access to a new system, they must orient themselves to what they now have control of and what benefits operating from that system give to their current objective or overall goals during the intrusion. The operating system provides many native tools that aid in this post-compromise information-gathering phase.", + "value": "Discovery" + }, + { + "description": "Lateral movement consists of techniques that enable an adversary to access and control remote systems on a network and could, but does not necessarily, include execution of tools on remote systems. The lateral movement techniques could allow an adversary to gather information from a system without needing additional tools, such as a remote access tool. An adversary can use lateral movement for many purposes, including remote Execution of tools, pivoting to additional systems, access to specific information or files, access to additional credentials, or to cause an effect.", + "value": "LateralMovement" + }, + { + "description": "The execution tactic represents techniques that result in execution of adversary-controlled code on a local or remote system. This tactic is often used in conjunction with lateral movement to expand access to remote systems on a network.", + "value": "Execution" + }, + { + "description": "Collection consists of techniques used to identify and gather information, such as sensitive files, from a target network prior to exfiltration. This category also covers locations on a system or network where the adversary may look for information to exfiltrate.", + "value": "Collection" + }, + { + "description": "Exfiltration refers to techniques and attributes that result or aid in the adversary removing files and information from a target network. This category also covers locations on a system or network where the adversary may look for information to exfiltrate.", + "value": "Exfiltration" + }, + { + "description": "The command and control tactic represents how adversaries communicate with systems under their control within a target network.", + "value": "CommandAndControl" + }, + { + "description": "The impact intent primary objective is to directly reduce the availability or integrity of a system, service, or network; including manipulation of data to impact a business or operational process. This would often refer to techniques such as ransom-ware, defacement, data manipulation and others.", + "value": "Impact" + } + ] + } + }, + "providerAlertId": { + "description": "The identifier of the alert inside the product which generated the alert.", + "readOnly": true, + "type": "string" + }, + "processingEndTime": { + "description": "The time the alert was made available for consumption.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "productComponentName": { + "description": "The name of a component inside the product which generated the alert.", + "readOnly": true, + "type": "string" + }, + "productName": { + "description": "The name of the product which published this alert.", + "readOnly": true, + "type": "string" + }, + "productVersion": { + "description": "The version of the product generating the alert.", + "readOnly": true, + "type": "string" + }, + "remediationSteps": { + "description": "Manual action items to take to remediate the alert.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "severity": { + "$ref": "#/definitions/AlertSeverity", + "description": "The severity of the alert" + }, + "startTimeUtc": { + "description": "The impact start time of the alert (the time of the first event contributing to the alert).", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "The lifecycle status of the alert.", + "enum": [ + "Unknown", + "New", + "Resolved", + "Dismissed", + "InProgress" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AlertStatus", + "values": [ + { + "description": "Unknown value", + "value": "Unknown" + }, + { + "description": "New alert", + "value": "New" + }, + { + "description": "Alert closed after handling", + "value": "Resolved" + }, + { + "description": "Alert dismissed as false positive", + "value": "Dismissed" + }, + { + "description": "Alert is being handled", + "value": "InProgress" + } + ] + } + }, + "systemAlertId": { + "description": "Holds the product identifier of the alert for the product.", + "readOnly": true, + "type": "string" + }, + "tactics": { + "description": "The tactics of the alert", + "items": { + "$ref": "#/definitions/AttackTactic" + }, + "readOnly": true, + "type": "array" + }, + "timeGenerated": { + "description": "The time the alert was generated.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "vendorName": { + "description": "The name of the vendor that raise the alert.", + "readOnly": true, + "type": "string" + }, + "alertLink": { + "description": "The uri link of the alert.", + "readOnly": true, + "type": "string" + }, + "resourceIdentifiers": { + "description": "The list of resource identifiers of the alert.", + "items": { + "type": "object" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "SecurityAlertTimelineItem": { + "allOf": [ + { + "$ref": "#/definitions/EntityTimelineItem" + } + ], + "description": "Represents security alert timeline item.", + "properties": { + "azureResourceId": { + "type": "string", + "description": "The alert azure resource id." + }, + "productName": { + "type": "string", + "description": "The alert product name." + }, + "description": { + "type": "string", + "description": "The alert description." + }, + "displayName": { + "type": "string", + "description": "The alert name." + }, + "severity": { + "$ref": "#/definitions/AlertSeverity", + "description": "The alert severity." + }, + "endTimeUtc": { + "format": "date-time", + "type": "string", + "description": "The alert end time." + }, + "startTimeUtc": { + "format": "date-time", + "type": "string", + "description": "The alert start time." + }, + "timeGenerated": { + "format": "date-time", + "type": "string", + "description": "The alert generated time." + }, + "alertType": { + "type": "string", + "description": "The name of the alert type." + } + }, + "required": [ + "azureResourceId", + "displayName", + "severity", + "endTimeUtc", + "startTimeUtc", + "timeGenerated", + "alertType" + ], + "type": "object", + "x-ms-discriminator-value": "SecurityAlert" + }, + "SecurityGroupEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a security group entity.", + "properties": { + "properties": { + "$ref": "#/definitions/SecurityGroupEntityProperties", + "description": "SecurityGroup entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "SecurityGroup" + }, + "SecurityGroupEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "SecurityGroup entity property bag.", + "properties": { + "distinguishedName": { + "description": "The group distinguished name", + "readOnly": true, + "type": "string" + }, + "objectGuid": { + "description": "A single-value attribute that is the unique identifier for the object, assigned by active directory.", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "sid": { + "description": "The SID attribute is a single-value attribute that specifies the security identifier (SID) of the group", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "SubmissionMailEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a submission mail entity.", + "properties": { + "properties": { + "$ref": "#/definitions/SubmissionMailEntityProperties", + "description": "Submission mail entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "SubmissionMail" + }, + "SubmissionMailEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Submission mail entity property bag.", + "properties": { + "networkMessageId": { + "description": "The network message id of email to which submission belongs", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "submissionId": { + "description": "The submission id", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "submitter": { + "description": "The submitter", + "readOnly": true, + "type": "string" + }, + "submissionDate": { + "description": "The submission date", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "timestamp": { + "description": "The Time stamp when the message is received (Mail)", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "recipient": { + "description": "The recipient of the mail", + "readOnly": true, + "type": "string" + }, + "sender": { + "description": "The sender of the mail", + "readOnly": true, + "type": "string" + }, + "senderIp": { + "description": "The sender's IP", + "readOnly": true, + "type": "string" + }, + "subject": { + "description": "The subject of submission mail", + "readOnly": true, + "type": "string" + }, + "reportType": { + "description": "The submission type for the given instance. This maps to Junk, Phish, Malware or NotJunk.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "TeamInformation": { + "description": "Describes team information", + "properties": { + "teamId": { + "description": "Team ID", + "readOnly": true, + "type": "string" + }, + "primaryChannelUrl": { + "description": "The primary channel URL of the team", + "readOnly": true, + "type": "string" + }, + "teamCreationTimeUtc": { + "description": "The time the team was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the team", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "The description of the team", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "TeamProperties": { + "description": "Describes team properties", + "properties": { + "teamName": { + "description": "The name of the team", + "type": "string" + }, + "teamDescription": { + "description": "The description of the team", + "type": "string" + }, + "memberIds": { + "description": "List of member IDs to add to the team", + "items": { + "description": "A single-value attribute that is the unique identifier for the user, assigned by active directory.", + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "groupIds": { + "description": "List of group IDs to add their members to the team", + "items": { + "description": "A single-value attribute that is the unique identifier for the group, assigned by active directory.", + "format": "uuid", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "teamName" + ], + "type": "object" + }, + "ThreatIntelligence": { + "description": "ThreatIntelligence property bag.", + "properties": { + "confidence": { + "description": "Confidence (must be between 0 and 1)", + "format": "double", + "readOnly": true, + "type": "number" + }, + "providerName": { + "description": "Name of the provider from whom this Threat Intelligence information was received", + "readOnly": true, + "type": "string" + }, + "reportLink": { + "description": "Report link", + "readOnly": true, + "type": "string" + }, + "threatDescription": { + "description": "Threat description (free text)", + "readOnly": true, + "type": "string" + }, + "threatName": { + "description": "Threat name (e.g. \"Jedobot malware\")", + "readOnly": true, + "type": "string" + }, + "threatType": { + "description": "Threat type (e.g. \"Botnet\")", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "UrlEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a url entity.", + "properties": { + "properties": { + "$ref": "#/definitions/UrlEntityProperties", + "description": "Url entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Url" + }, + "UrlEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Url entity property bag.", + "properties": { + "url": { + "description": "A full URL the entity points to", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "UserInfo": { + "description": "User information that made some action", + "properties": { + "email": { + "description": "The email of the user.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the user.", + "readOnly": true, + "type": "string" + }, + "objectId": { + "description": "The object id of the user.", + "format": "uuid", + "type": "string", + "x-nullable": true + } + }, + "type": "object" + } + }, + "parameters": { + "Incident": { + "description": "The incident", + "in": "body", + "name": "incident", + "required": true, + "schema": { + "$ref": "#/definitions/Incident" + }, + "x-ms-parameter-location": "method" + }, + "IncidentComment": { + "description": "The incident comment", + "in": "body", + "name": "incidentComment", + "required": true, + "schema": { + "$ref": "#/definitions/IncidentComment" + }, + "x-ms-parameter-location": "method" + }, + "IncidentCommentId": { + "description": "Incident comment ID", + "in": "path", + "name": "incidentCommentId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "IncidentId": { + "description": "Incident ID", + "in": "path", + "name": "incidentId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Relation": { + "name": "relation", + "in": "body", + "description": "The relation model", + "required": true, + "schema": { + "$ref": "#/definitions/Relation" + }, + "x-ms-parameter-location": "method" + }, + "RelationName": { + "name": "relationName", + "in": "path", + "required": true, + "type": "string", + "description": "Relation Name", + "x-ms-parameter-location": "method" + }, + "TeamProperties": { + "description": "Team properties", + "in": "body", + "name": "teamProperties", + "required": true, + "schema": { + "$ref": "#/definitions/TeamProperties" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json index 9b735e4bfc08..b9779463df25 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json @@ -66,16 +66,16 @@ "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/ODataFilter" + "$ref": "../../../common/1.0/types.json#/parameters/ODataFilter" }, { - "$ref": "#/parameters/ODataOrderBy" + "$ref": "../../../common/1.0/types.json#/parameters/ODataOrderBy" }, { - "$ref": "#/parameters/ODataTop" + "$ref": "../../../common/1.0/types.json#/parameters/ODataTop" }, { - "$ref": "#/parameters/ODataSkip" + "$ref": "../../../common/1.0/types.json#/parameters/ODataSkip" } ], "responses": { @@ -354,7 +354,7 @@ } }, "metadataContentId": { - "description": "Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Dynamic for user-created. This is the resource name", + "description": "Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a template, both will have the same contentId.", "type": "string" }, "metadataParentId": { @@ -369,66 +369,66 @@ "type": "string", "description": "The kind of content the metadata is for.", "enum": [ - "dataConnector", - "dataType", - "workbook", - "workbookTemplate", - "playbook", - "playbookTemplate", - "analyticRuleTemplate", - "analyticRule", - "huntingQuery", - "investigationQuery", - "parser", - "watchlist", - "watchlistTemplate", - "solution" + "DataConnector", + "DataType", + "Workbook", + "WorkbookTemplate", + "Playbook", + "PlaybookTemplate", + "AnalyticsRuleTemplate", + "AnalyticsRule", + "HuntingQuery", + "InvestigationQuery", + "Parser", + "Watchlist", + "WatchlistTemplate", + "Solution" ], "x-ms-enum": { "modelAsString": true, "name": "kind", "values": [ { - "value": "dataConnector" + "value": "DataConnector" }, { - "value": "dataType" + "value": "DataType" }, { - "value": "workbook" + "value": "Workbook" }, { - "value": "workbookTemplate" + "value": "WorkbookTemplate" }, { - "value": "playbook" + "value": "Playbook" }, { - "value": "playbookTemplate" + "value": "PlaybookTemplate" }, { - "value": "analyticRuleTemplate" + "value": "AnalyticsRuleTemplate" }, { - "value": "analyticRule" + "value": "AnalyticsRule" }, { - "value": "huntingQuery" + "value": "HuntingQuery" }, { - "value": "investigationQuery" + "value": "InvestigationQuery" }, { - "value": "parser" + "value": "Parser" }, { - "value": "watchlist" + "value": "Watchlist" }, { - "value": "watchlistTemplate" + "value": "WatchlistTemplate" }, { - "value": "solution" + "value": "Solution" } ] } @@ -444,26 +444,26 @@ "description": "Source type of the content", "type": "string", "enum": [ - "localWorkspace", - "community", - "solution", - "sourceRepository" + "LocalWorkspace", + "Community", + "Solution", + "SourceRepository" ], "x-ms-enum": { "modelAsString": true, "name": "sourceKind", "values": [ { - "value": "localWorkspace" + "value": "LocalWorkspace" }, { - "value": "community" + "value": "Community" }, { - "value": "solution" + "value": "Solution" }, { - "value": "sourceRepository" + "value": "SourceRepository" } ] } @@ -507,22 +507,22 @@ "description": "Type of support for content item", "type": "string", "enum": [ - "microsoft", - "developer", - "community" + "Microsoft", + "Partner", + "Community" ], "x-ms-enum": { "modelAsString": true, "name": "supportTier", "values": [ { - "value": "microsoft" + "value": "Microsoft" }, { - "value": "developer" + "value": "Partner" }, { - "value": "community" + "value": "Community" } ] } @@ -594,7 +594,6 @@ "metadataProperties": { "description": "Metadata property bag.", "required": [ - "contentId", "parentId", "kind" ], @@ -738,40 +737,6 @@ "required": true, "type": "string", "x-ms-parameter-location": "method" - }, - "ODataFilter": { - "description": "Filters the results, based on a Boolean condition. Optional.", - "in": "query", - "name": "$filter", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ODataOrderBy": { - "description": "Sorts the results. Optional.", - "in": "query", - "name": "$orderby", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ODataSkip": { - "description": "Used to skip n elements in the OData query (offset). Returns a nextLink to the next page of results if there are any left.", - "in": "query", - "name": "$skip", - "required": false, - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" - }, - "ODataTop": { - "description": "Returns only the first n results. Optional.", - "in": "query", - "name": "$top", - "required": false, - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" } } } diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/OnboardingStates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/OnboardingStates.json index 2687fa244506..78bc61a70678 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/OnboardingStates.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/OnboardingStates.json @@ -267,6 +267,7 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json index 426257c55aaa..3e2a7e3eb29b 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json @@ -221,96 +221,6 @@ } } } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/settings/onboard": { - "post": { - "x-ms-examples": { - "Onboard workspace": { - "$ref": "./examples/settings/Onboard.json" - } - }, - "tags": [ - "Settings" - ], - "description": "Onboards workspace to sentinel.", - "operationId": "ProductSettings_OnboardWorkspace", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/OnboardingRequest" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/OnboardingRequest" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/1.0/types.json#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/settings/offboard": { - "post": { - "x-ms-examples": { - "Onboard workspace": { - "$ref": "./examples/settings/Offboard.json" - } - }, - "tags": [ - "Settings" - ], - "description": "Offboards workspace from sentinel.", - "operationId": "ProductSettings_OffboardWorkspace", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" - }, - { - "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/1.0/types.json#/definitions/CloudError" - } - } - } - } } }, "definitions": { @@ -325,6 +235,7 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] @@ -340,6 +251,7 @@ "kind": { "description": "The kind of the setting", "enum": [ + "Anomalies", "EyesOn", "EntityAnalytics", "Ueba" @@ -357,6 +269,34 @@ "discriminator": "kind", "type": "object" }, + "Anomalies": { + "allOf": [ + { + "$ref": "#/definitions/Settings" + } + ], + "description": "Settings with single toggle.", + "properties": { + "properties": { + "$ref": "#/definitions/AnomaliesSettingsProperties", + "description": "Anomalies properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Anomalies" + }, + "AnomaliesSettingsProperties": { + "description": "Anomalies property bag.", + "properties": { + "isEnabled": { + "description": "Determines whether the setting is enable or disabled.", + "readOnly": true, + "type": "boolean" + } + }, + "type": "object" + }, "EyesOn": { "allOf": [ { @@ -432,6 +372,7 @@ }, "UebaProperties": { "description": "Ueba property bag.", + "type": "object", "properties": { "dataSources": { "description": "The relevant data sources that enriched by ueba", @@ -456,29 +397,6 @@ "name": "UebaDataSources" } }, - "OnboardingRequest": { - "description": "Onboarding request properties", - "properties": { - "customerManagedKey": { - "description": "Flag that indicates if the user wants CMK", - "type": "boolean" - }, - "eyesOn": { - "description": "Flag that indicates if the user wants EyesOn", - "type": "boolean" - }, - "sku": { - "description": "The pricing tier of the solution", - "$ref": "#/definitions/Sku" - }, - "entityAnalytics": { - "description": "flag that indicates if the user wants EntityAnalytics", - "$ref": "#/definitions/EntityAnalyticsOnboardingParameters", - "type": "object" - } - }, - "type": "object" - }, "Sku": { "description": "The pricing tier of the solution", "properties": { @@ -499,20 +417,6 @@ "type": "integer", "format": "int32" } - } - }, - "EntityAnalyticsOnboardingParameters": { - "description": "The onboarding request entity analytics parameters", - "properties": { - "enabled": { - "description": "A flag indicates that the user wants entity analytics", - "type": "boolean" - }, - "uebaDataSources": { - "description": "The data source be profiled by ueba engine", - "$ref": "#/definitions/UebaProperties", - "x-ms-client-flatten": true - } }, "type": "object" } @@ -529,7 +433,7 @@ "x-ms-parameter-location": "method" }, "SettingsName": { - "description": "The setting name. Supports - EyesOn, EntityAnalytics, Ueba", + "description": "The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba", "in": "path", "name": "settingsName", "required": true, @@ -572,16 +476,6 @@ "required": true, "type": "string", "x-ms-parameter-location": "method" - }, - "OnboardingRequest": { - "description": "The onboarding request parameters", - "in": "body", - "name": "onboardingRequest", - "required": true, - "schema": { - "$ref": "#/definitions/OnboardingRequest" - }, - "x-ms-parameter-location": "method" } } } diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/dataConnectors.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/dataConnectors.json index ff653f082db9..16e30dd98595 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/dataConnectors.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/dataConnectors.json @@ -711,6 +711,7 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/actions/CreateActionOfAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/actions/CreateActionOfAlertRule.json new file mode 100644 index 000000000000..70983078afb8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/actions/CreateActionOfAlertRule.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2019-01-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "ruleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "actionId": "912bec42-cb66-4c03-ac63-1761b6898c3e", + "action": { + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "triggerUri": "https://prod-31.northcentralus.logic.azure.com:443/workflows/cd3765391efd48549fd7681ded1d48d7/triggers/manual/paths/invoke?api-version=2016-10-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=signature", + "logicAppResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.Logic/workflows/MyAlerts" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5/actions/912bec42-cb66-4c03-ac63-1761b6898c3e", + "name": "912bec42-cb66-4c03-ac63-1761b6898c3e", + "type": "Microsoft.SecurityInsights/alertRules/actions", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "workflowId": "cd3765391efd48549fd7681ded1d48d7", + "logicAppResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.Logic/workflows/MyAlerts" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5/actions/912bec42-cb66-4c03-ac63-1761b6898c3e", + "name": "912bec42-cb66-4c03-ac63-1761b6898c3e", + "type": "Microsoft.SecurityInsights/alertRules/actions", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "workflowId": "cd3765391efd48549fd7681ded1d48d7", + "logicAppResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.Logic/workflows/MyAlerts" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/actions/DeleteActionOfAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/actions/DeleteActionOfAlertRule.json new file mode 100644 index 000000000000..af1bd0d03727 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/actions/DeleteActionOfAlertRule.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2019-01-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "ruleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "actionId": "912bec42-cb66-4c03-ac63-1761b6898c3e" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/actions/GetActionOfAlertRuleById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/actions/GetActionOfAlertRuleById.json new file mode 100644 index 000000000000..4501f69a57cb --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/actions/GetActionOfAlertRuleById.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2019-01-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "ruleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "actionId": "912bec42-cb66-4c03-ac63-1761b6898c3e" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5/actions/912bec42-cb66-4c03-ac63-1761b6898c3e", + "name": "912bec42-cb66-4c03-ac63-1761b6898c3e", + "type": "Microsoft.SecurityInsights/alertRules/actions", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "workflowId": "cd3765391efd48549fd7681ded1d48d7", + "logicAppResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.Logic/workflows/MyAlerts" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/actions/GetAllActionsByAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/actions/GetAllActionsByAlertRule.json new file mode 100644 index 000000000000..f6e415ce6c5d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/actions/GetAllActionsByAlertRule.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2019-01-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "ruleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5/actions/912bec42-cb66-4c03-ac63-1761b6898c3e", + "name": "912bec42-cb66-4c03-ac63-1761b6898c3e", + "type": "Microsoft.SecurityInsights/alertRules/actions", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "workflowId": "cd3765391efd48549fd7681ded1d48d7", + "logicAppResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.Logic/workflows/MyAlerts" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/alertRuleTemplates/GetAlertRuleTemplateById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/alertRuleTemplates/GetAlertRuleTemplateById.json new file mode 100644 index 000000000000..3104c57000c0 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/alertRuleTemplates/GetAlertRuleTemplateById.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "alertRuleTemplateId": "65360bb0-8986-4ade-a89d-af3cf44d28aa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRuleTemplates/65360bb0-8986-4ade-a89d-af3cf44d28aa", + "name": "65360bb0-8986-4ade-a89d-af3cf44d28aa", + "type": "Microsoft.SecurityInsights/AlertRuleTemplates", + "kind": "Scheduled", + "properties": { + "severity": "Low", + "query": "let timeframe = 1d;\nAWSCloudTrail\n| where TimeGenerated >= ago(timeframe)\n| where EventName == \"CreateNetworkAclEntry\"\n or EventName == \"CreateRoute\"\n| project TimeGenerated, EventName, EventTypeName, UserIdentityAccountId, UserIdentityPrincipalid, UserAgent, UserIdentityUserName, SessionMfaAuthenticated, SourceIpAddress, AWSRegion, EventSource, AdditionalEventData, ResponseElements\n| extend AccountCustomEntity = UserIdentityUserName, IPCustomEntity = SourceIpAddress", + "queryFrequency": "P1D", + "queryPeriod": "P1D", + "triggerOperator": "GreaterThan", + "triggerThreshold": 0, + "displayName": "Changes to Amazon VPC settings", + "description": "This alert monitors changes to Amazon VPC (Virtual Private Cloud) settings such as new ACL entries and routes in route tables.\nMore information: https://medium.com/@GorillaStack/the-most-important-aws-cloudtrail-security-events-to-track-a5b9873f8255 \nand https://aws.amazon.com/vpc/", + "eventGroupingSettings": { + "aggregationKind": "AlertPerResult" + }, + "tactics": [ + "PrivilegeEscalation", + "LateralMovement" + ], + "lastUpdatedDateUTC": "2020-02-27T00:00:00Z", + "createdDateUTC": "2019-02-27T00:00:00Z", + "status": "Available", + "requiredDataConnectors": [ + { + "connectorId": "AWS", + "dataTypes": [ + "AWSCloudTrail" + ] + } + ], + "alertRulesCreatedByTemplateCount": 0 + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/alertRuleTemplates/GetAlertRuleTemplates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/alertRuleTemplates/GetAlertRuleTemplates.json new file mode 100644 index 000000000000..f974891b2578 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/alertRuleTemplates/GetAlertRuleTemplates.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/AlertRuleTemplates/65360bb0-8986-4ade-a89d-af3cf44d28aa", + "name": "65360bb0-8986-4ade-a89d-af3cf44d28aa", + "type": "Microsoft.SecurityInsights/AlertRuleTemplates", + "kind": "Scheduled", + "properties": { + "severity": "Low", + "query": "let timeframe = 1d;\nAWSCloudTrail\n| where TimeGenerated >= ago(timeframe)\n| where EventName == \"CreateNetworkAclEntry\"\n or EventName == \"CreateRoute\"\n| project TimeGenerated, EventName, EventTypeName, UserIdentityAccountId, UserIdentityPrincipalid, UserAgent, UserIdentityUserName, SessionMfaAuthenticated, SourceIpAddress, AWSRegion, EventSource, AdditionalEventData, ResponseElements\n| extend AccountCustomEntity = UserIdentityUserName, IPCustomEntity = SourceIpAddress", + "queryFrequency": "P1D", + "queryPeriod": "P1D", + "triggerOperator": "GreaterThan", + "triggerThreshold": 0, + "displayName": "Changes to Amazon VPC settings", + "description": "This alert monitors changes to Amazon VPC (Virtual Private Cloud) settings such as new ACL entries and routes in route tables.\nMore information: https://medium.com/@GorillaStack/the-most-important-aws-cloudtrail-security-events-to-track-a5b9873f8255 \nand https://aws.amazon.com/vpc/", + "tactics": [ + "PrivilegeEscalation", + "LateralMovement" + ], + "lastUpdatedDateUTC": "2020-02-27T00:00:00Z", + "createdDateUTC": "2019-02-27T00:00:00Z", + "status": "Available", + "requiredDataConnectors": [ + { + "connectorId": "AWS", + "dataTypes": [ + "AWSCloudTrail" + ] + } + ], + "alertRulesCreatedByTemplateCount": 0 + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/AlertRuleTemplates/f71aba3d-28fb-450b-b192-4e76a83015c8", + "name": "f71aba3d-28fb-450b-b192-4e76a83015c8", + "type": "Microsoft.SecurityInsights/AlertRuleTemplates", + "kind": "Fusion", + "properties": { + "displayName": "Advanced Multi-Stage Attack Detection", + "description": "Place holder: Fusion uses graph powered machine learning algorithms to correlate between millions of lower fidelity anomalous activities from different products such as Azure AD Identity Protection, and Microsoft Cloud App Security, to combine them into a manageable number of interesting security cases.\n", + "tactics": [ + "Persistence", + "LateralMovement", + "Exfiltration", + "CommandAndControl" + ], + "lastUpdatedDateUTC": "2020-02-27T00:00:00Z", + "createdDateUTC": "2019-07-25T00:00:00Z", + "status": "Available", + "severity": "High", + "alertRulesCreatedByTemplateCount": 0 + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/AlertRuleTemplates/b3cfc7c0-092c-481c-a55b-34a3979758cb", + "name": "b3cfc7c0-092c-481c-a55b-34a3979758cb", + "type": "Microsoft.SecurityInsights/AlertRuleTemplates", + "kind": "MicrosoftSecurityIncidentCreation", + "properties": { + "productFilter": "Microsoft Cloud App Security", + "displayName": "Create incidents based on Microsoft Cloud App Security alerts", + "description": "Create incidents based on all alerts generated in Microsoft Cloud App Security", + "lastUpdatedDateUTC": "2020-02-27T00:00:00Z", + "createdDateUTC": "2019-07-16T00:00:00Z", + "status": "Available", + "alertRulesCreatedByTemplateCount": 0 + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/alertRules/CreateFusionAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/alertRules/CreateFusionAlertRule.json new file mode 100644 index 000000000000..b07ed1bd0f74 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/alertRules/CreateFusionAlertRule.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "ruleId": "myFirstFusionRule", + "alertRule": { + "kind": "Fusion", + "etag": "3d00c3ca-0000-0100-0000-5d42d5010000", + "properties": { + "enabled": true, + "alertRuleTemplateName": "f71aba3d-28fb-450b-b192-4e76a83015c8" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/myFirstFusionRule", + "name": "myFirstFusionRule", + "etag": "\"260090e2-0000-0d00-0000-5d6fb8670000\"", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Fusion", + "properties": { + "displayName": "Advanced Multi-Stage Attack Detection", + "description": "In this mode, Sentinel combines low fidelity alerts, which themselves may not be actionable, and events across multiple products, into high fidelity security interesting incidents. The system looks at multiple products to produce actionable incidents. Custom tailored to each tenant, Fusion not only reduces false positive rates but also can detect attacks with limited or missing information. \nIncidents generated by Fusion system will encase two or more alerts. By design, Fusion incidents are low volume, high fidelity and will be high severity, which is why Fusion is turned ON by default in Azure Sentinel.\n\nFor Fusion to work, please configure the following data sources in Data Connectors tab:\nRequired - Azure Active Directory Identity Protection\nRequired - Microsoft Cloud App Security\nIf Available - Palo Alto Network\n\nFor full list of scenarios covered by Fusion, and detail instructions on how to configure the required data sources, go to aka.ms/SentinelFusion", + "alertRuleTemplateName": "f71aba3d-28fb-450b-b192-4e76a83015c8", + "tactics": [ + "Persistence", + "LateralMovement", + "Exfiltration", + "CommandAndControl" + ], + "severity": "High", + "enabled": true, + "lastModifiedUtc": "2019-09-04T13:13:11.5340061Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/myFirstFusionRule", + "name": "myFirstFusionRule", + "etag": "\"260090e2-0000-0d00-0000-5d6fb8670000\"", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Fusion", + "properties": { + "displayName": "Advanced Multi-Stage Attack Detection", + "description": "In this mode, Sentinel combines low fidelity alerts, which themselves may not be actionable, and events across multiple products, into high fidelity security interesting incidents. The system looks at multiple products to produce actionable incidents. Custom tailored to each tenant, Fusion not only reduces false positive rates but also can detect attacks with limited or missing information. \nIncidents generated by Fusion system will encase two or more alerts. By design, Fusion incidents are low volume, high fidelity and will be high severity, which is why Fusion is turned ON by default in Azure Sentinel.\n\nFor Fusion to work, please configure the following data sources in Data Connectors tab:\nRequired - Azure Active Directory Identity Protection\nRequired - Microsoft Cloud App Security\nIf Available - Palo Alto Network\n\nFor full list of scenarios covered by Fusion, and detail instructions on how to configure the required data sources, go to aka.ms/SentinelFusion", + "alertRuleTemplateName": "f71aba3d-28fb-450b-b192-4e76a83015c8", + "tactics": [ + "Persistence", + "LateralMovement", + "Exfiltration", + "CommandAndControl" + ], + "severity": "High", + "enabled": true, + "lastModifiedUtc": "2019-09-04T13:13:11.5340061Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/alertRules/CreateMicrosoftSecurityIncidentCreationAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/alertRules/CreateMicrosoftSecurityIncidentCreationAlertRule.json new file mode 100644 index 000000000000..2115f91f72dd --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/alertRules/CreateMicrosoftSecurityIncidentCreationAlertRule.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "ruleId": "microsoftSecurityIncidentCreationRuleExample", + "alertRule": { + "etag": "\"260097e0-0000-0d00-0000-5d6fa88f0000\"", + "kind": "MicrosoftSecurityIncidentCreation", + "properties": { + "productFilter": "Microsoft Cloud App Security", + "displayName": "testing displayname", + "enabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExample", + "name": "microsoftSecurityIncidentCreationRuleExample", + "etag": "\"260097e0-0000-0d00-0000-5d6fa88f0000\"", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "MicrosoftSecurityIncidentCreation", + "properties": { + "productFilter": "Microsoft Cloud App Security", + "severitiesFilter": null, + "displayNamesFilter": null, + "displayName": "testing displayname", + "enabled": true, + "description": null, + "alertRuleTemplateName": null, + "lastModifiedUtc": "2019-09-04T12:05:35.7296311Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExample", + "name": "microsoftSecurityIncidentCreationRuleExample", + "etag": "\"260097e0-0000-0d00-0000-5d6fa88f0000\"", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "MicrosoftSecurityIncidentCreation", + "properties": { + "productFilter": "Microsoft Cloud App Security", + "severitiesFilter": null, + "displayNamesFilter": null, + "displayName": "testing displayname", + "enabled": true, + "description": null, + "alertRuleTemplateName": null, + "lastModifiedUtc": "2019-09-04T12:05:35.7296311Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/alertRules/CreateScheduledAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/alertRules/CreateScheduledAlertRule.json new file mode 100644 index 000000000000..1d10486d906e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/alertRules/CreateScheduledAlertRule.json @@ -0,0 +1,240 @@ +{ + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "ruleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "alertRule": { + "kind": "Scheduled", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "displayName": "My scheduled rule", + "description": "An example for a scheduled rule", + "severity": "High", + "enabled": true, + "tactics": [ + "Persistence", + "LateralMovement" + ], + "query": "Heartbeat", + "queryFrequency": "PT1H", + "queryPeriod": "P2DT1H30M", + "triggerOperator": "GreaterThan", + "triggerThreshold": 0, + "suppressionDuration": "PT1H", + "suppressionEnabled": false, + "eventGroupingSettings": { + "aggregationKind": "AlertPerResult" + }, + "customDetails": { + "OperatingSystemName": "OSName", + "OperatingSystemType": "OSType" + }, + "entityMappings": [ + { + "entityType": "Host", + "fieldMappings": [ + { + "identifier": "FullName", + "columnName": "Computer" + } + ] + }, + { + "entityType": "IP", + "fieldMappings": [ + { + "identifier": "Address", + "columnName": "ComputerIP" + } + ] + } + ], + "alertDetailsOverride": { + "alertDisplayNameFormat": "Alert from {{Computer}}", + "alertDescriptionFormat": "Suspicious activity was made by {{ComputerIP}}" + }, + "incidentConfiguration": { + "createIncident": true, + "groupingConfiguration": { + "enabled": true, + "reopenClosedIncident": false, + "lookbackDuration": "PT5H", + "matchingMethod": "Selected", + "groupByEntities": [ + "Host" + ], + "groupByAlertDetails": [ + "DisplayName" + ], + "groupByCustomDetails": [ + "OperatingSystemType", + "OperatingSystemName" + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Scheduled", + "etag": "\"01005144-0000-0d00-0000-6058632c0000\"", + "properties": { + "alertRuleTemplateName": null, + "displayName": "My scheduled rule", + "description": "An example for a scheduled rule", + "severity": "High", + "enabled": true, + "tactics": [ + "Persistence", + "LateralMovement" + ], + "query": "Heartbeat", + "queryFrequency": "PT1H", + "queryPeriod": "P2DT1H30M", + "triggerOperator": "GreaterThan", + "triggerThreshold": 0, + "suppressionDuration": "PT1H", + "suppressionEnabled": false, + "lastModifiedUtc": "2021-03-01T13:17:30Z", + "eventGroupingSettings": { + "aggregationKind": "AlertPerResult" + }, + "customDetails": { + "OperatingSystemName": "OSName", + "OperatingSystemType": "OSType" + }, + "entityMappings": [ + { + "entityType": "Host", + "fieldMappings": [ + { + "identifier": "FullName", + "columnName": "Computer" + } + ] + }, + { + "entityType": "IP", + "fieldMappings": [ + { + "identifier": "Address", + "columnName": "ComputerIP" + } + ] + } + ], + "alertDetailsOverride": { + "alertDisplayNameFormat": "Alert from {{Computer}}", + "alertDescriptionFormat": "Suspicious activity was made by {{ComputerIP}}", + "alertTacticsColumnName": null, + "alertSeverityColumnName": null + }, + "incidentConfiguration": { + "createIncident": true, + "groupingConfiguration": { + "enabled": true, + "reopenClosedIncident": false, + "lookbackDuration": "PT5H", + "matchingMethod": "Selected", + "groupByEntities": [ + "Host" + ], + "groupByAlertDetails": [ + "DisplayName" + ], + "groupByCustomDetails": [ + "OperatingSystemType", + "OperatingSystemName" + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Scheduled", + "etag": "\"01007444-0000-0d00-0000-605863a70000\"", + "properties": { + "alertRuleTemplateName": null, + "displayName": "My scheduled rule", + "description": "An example for a scheduled rule", + "severity": "High", + "enabled": true, + "tactics": [ + "Persistence", + "LateralMovement" + ], + "query": "Heartbeat", + "queryFrequency": "PT1H", + "queryPeriod": "P2DT1H30M", + "triggerOperator": "GreaterThan", + "triggerThreshold": 0, + "suppressionDuration": "PT1H", + "suppressionEnabled": false, + "lastModifiedUtc": "2021-03-01T13:15:30Z", + "customDetails": { + "OperatingSystemName": "OSName", + "OperatingSystemType": "OSType" + }, + "entityMappings": [ + { + "entityType": "Host", + "fieldMappings": [ + { + "identifier": "FullName", + "columnName": "Computer" + } + ] + }, + { + "entityType": "IP", + "fieldMappings": [ + { + "identifier": "Address", + "columnName": "ComputerIP" + } + ] + } + ], + "alertDetailsOverride": { + "alertDisplayNameFormat": "Alert from {{Computer}}", + "alertDescriptionFormat": "Suspicious activity was made by {{ComputerIP}}", + "alertTacticsColumnName": null, + "alertSeverityColumnName": null + }, + "incidentConfiguration": { + "createIncident": true, + "groupingConfiguration": { + "enabled": true, + "reopenClosedIncident": false, + "lookbackDuration": "PT5H", + "matchingMethod": "Selected", + "groupByEntities": [ + "Host" + ], + "groupByAlertDetails": [ + "DisplayName" + ], + "groupByCustomDetails": [ + "OperatingSystemType", + "OperatingSystemName" + ] + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/alertRules/DeleteAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/alertRules/DeleteAlertRule.json new file mode 100644 index 000000000000..f86985a88678 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/alertRules/DeleteAlertRule.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "ruleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/alertRules/GetAllAlertRules.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/alertRules/GetAllAlertRules.json new file mode 100644 index 000000000000..5b60a159e239 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/alertRules/GetAllAlertRules.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Scheduled", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "alertRuleTemplateName": null, + "displayName": "My scheduled rule", + "description": "An example for a scheduled rule", + "severity": "High", + "enabled": true, + "tactics": [ + "Persistence", + "LateralMovement" + ], + "query": "Heartbeat", + "queryFrequency": "PT1H", + "queryPeriod": "P2DT1H30M", + "triggerOperator": "GreaterThan", + "triggerThreshold": 0, + "suppressionDuration": "PT1H", + "suppressionEnabled": false, + "lastModifiedUtc": "2021-03-01T13:17:30Z", + "eventGroupingSettings": { + "aggregationKind": "AlertPerResult" + }, + "customDetails": { + "OperatingSystemName": "OSName", + "OperatingSystemType": "OSType" + }, + "entityMappings": [ + { + "entityType": "Host", + "fieldMappings": [ + { + "identifier": "FullName", + "columnName": "Computer" + } + ] + }, + { + "entityType": "IP", + "fieldMappings": [ + { + "identifier": "Address", + "columnName": "ComputerIP" + } + ] + } + ], + "alertDetailsOverride": { + "alertDisplayNameFormat": "Alert from {{Computer}}", + "alertDescriptionFormat": "Suspicious activity was made by {{ComputerIP}}", + "alertTacticsColumnName": null, + "alertSeverityColumnName": null + }, + "incidentConfiguration": { + "createIncident": true, + "groupingConfiguration": { + "enabled": true, + "reopenClosedIncident": false, + "lookbackDuration": "PT5H", + "matchingMethod": "Selected", + "groupByEntities": [ + "Host" + ], + "groupByAlertDetails": [ + "DisplayName" + ], + "groupByCustomDetails": [ + "OperatingSystemType", + "OperatingSystemName" + ] + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExample", + "name": "microsoftSecurityIncidentCreationRuleExample", + "etag": "\"260097e0-0000-0d00-0000-5d6fa88f0000\"", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "MicrosoftSecurityIncidentCreation", + "properties": { + "productFilter": "Microsoft Cloud App Security", + "severitiesFilter": null, + "displayNamesFilter": null, + "displayName": "testing displayname", + "enabled": true, + "description": null, + "alertRuleTemplateName": null, + "lastModifiedUtc": "2019-09-04T12:05:35.7296311Z" + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/myFirstFusionRule", + "name": "myFirstFusionRule", + "etag": "\"25005c11-0000-0d00-0000-5d6cc0e20000\"", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Fusion", + "properties": { + "displayName": "Advanced Multi-Stage Attack Detection", + "description": "In this mode, Sentinel combines low fidelity alerts, which themselves may not be actionable, and events across multiple products, into high fidelity security interesting incidents. The system looks at multiple products to produce actionable incidents. Custom tailored to each tenant, Fusion not only reduces false positive rates but also can detect attacks with limited or missing information. \nIncidents generated by Fusion system will encase two or more alerts. By design, Fusion incidents are low volume, high fidelity and will be high severity, which is why Fusion is turned ON by default in Azure Sentinel.\n\nFor Fusion to work, please configure the following data sources in Data Connectors tab:\nRequired - Azure Active Directory Identity Protection\nRequired - Microsoft Cloud App Security\nIf Available - Palo Alto Network\n\nFor full list of scenarios covered by Fusion, and detail instructions on how to configure the required data sources, go to aka.ms/SentinelFusion", + "alertRuleTemplateName": "f71aba3d-28fb-450b-b192-4e76a83015c8", + "tactics": [ + "Persistence", + "LateralMovement", + "Exfiltration", + "CommandAndControl" + ], + "severity": "High", + "enabled": false, + "lastModifiedUtc": "2019-09-02T07:12:34.9065092Z" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/alertRules/GetFusionAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/alertRules/GetFusionAlertRule.json new file mode 100644 index 000000000000..b98ea0d72065 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/alertRules/GetFusionAlertRule.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "ruleId": "myFirstFusionRule" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/myFirstFusionRule", + "name": "myFirstFusionRule", + "etag": "\"260090e2-0000-0d00-0000-5d6fb8670000\"", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Fusion", + "properties": { + "displayName": "Advanced Multi-Stage Attack Detection", + "description": "In this mode, Sentinel combines low fidelity alerts, which themselves may not be actionable, and events across multiple products, into high fidelity security interesting incidents. The system looks at multiple products to produce actionable incidents. Custom tailored to each tenant, Fusion not only reduces false positive rates but also can detect attacks with limited or missing information. \nIncidents generated by Fusion system will encase two or more alerts. By design, Fusion incidents are low volume, high fidelity and will be high severity, which is why Fusion is turned ON by default in Azure Sentinel.\n\nFor Fusion to work, please configure the following data sources in Data Connectors tab:\nRequired - Azure Active Directory Identity Protection\nRequired - Microsoft Cloud App Security\nIf Available - Palo Alto Network\n\nFor full list of scenarios covered by Fusion, and detail instructions on how to configure the required data sources, go to aka.ms/SentinelFusion", + "alertRuleTemplateName": "f71aba3d-28fb-450b-b192-4e76a83015c8", + "tactics": [ + "Persistence", + "LateralMovement", + "Exfiltration", + "CommandAndControl" + ], + "severity": "High", + "enabled": true, + "lastModifiedUtc": "2019-09-04T13:13:11.5340061Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/alertRules/GetMicrosoftSecurityIncidentCreationAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/alertRules/GetMicrosoftSecurityIncidentCreationAlertRule.json new file mode 100644 index 000000000000..cadcb47549ec --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/alertRules/GetMicrosoftSecurityIncidentCreationAlertRule.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "ruleId": "microsoftSecurityIncidentCreationRuleExample" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExample", + "name": "microsoftSecurityIncidentCreationRuleExample", + "etag": "\"260097e0-0000-0d00-0000-5d6fa88f0000\"", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "MicrosoftSecurityIncidentCreation", + "properties": { + "productFilter": "Microsoft Cloud App Security", + "severitiesFilter": null, + "displayNamesFilter": null, + "displayName": "testing displayname", + "enabled": true, + "description": null, + "alertRuleTemplateName": null, + "lastModifiedUtc": "2019-09-04T12:05:35.7296311Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/alertRules/GetScheduledAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/alertRules/GetScheduledAlertRule.json new file mode 100644 index 000000000000..f92241e9d95c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/alertRules/GetScheduledAlertRule.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "ruleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Scheduled", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "alertRuleTemplateName": null, + "displayName": "My scheduled rule", + "description": "An example for a scheduled rule", + "severity": "High", + "enabled": true, + "tactics": [ + "Persistence", + "LateralMovement" + ], + "query": "Heartbeat", + "queryFrequency": "PT1H", + "queryPeriod": "P2DT1H30M", + "triggerOperator": "GreaterThan", + "triggerThreshold": 0, + "suppressionDuration": "PT1H", + "suppressionEnabled": false, + "lastModifiedUtc": "2021-03-01T13:17:30Z", + "eventGroupingSettings": { + "aggregationKind": "AlertPerResult" + }, + "customDetails": { + "OperatingSystemName": "OSName", + "OperatingSystemType": "OSType" + }, + "entityMappings": [ + { + "entityType": "Host", + "fieldMappings": [ + { + "identifier": "FullName", + "columnName": "Computer" + } + ] + }, + { + "entityType": "IP", + "fieldMappings": [ + { + "identifier": "Address", + "columnName": "ComputerIP" + } + ] + } + ], + "alertDetailsOverride": { + "alertDisplayNameFormat": "Alert from {{Computer}}", + "alertDescriptionFormat": "Suspicious activity was made by {{ComputerIP}}", + "alertTacticsColumnName": null, + "alertSeverityColumnName": null + }, + "incidentConfiguration": { + "createIncident": true, + "groupingConfiguration": { + "enabled": true, + "reopenClosedIncident": false, + "lookbackDuration": "PT5H", + "matchingMethod": "Selected", + "groupByEntities": [ + "Host" + ], + "groupByAlertDetails": [ + "DisplayName" + ], + "groupByCustomDetails": [ + "OperatingSystemType", + "OperatingSystemName" + ] + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/entityQueries/CreateEntityQueryActivity.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/entityQueries/CreateEntityQueryActivity.json new file mode 100644 index 000000000000..e4cf9a4e72ad --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/entityQueries/CreateEntityQueryActivity.json @@ -0,0 +1,134 @@ +{ + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "entityQueryId": "07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "entityQuery": { + "kind": "Activity", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "title": "An account was deleted on this host", + "content": "On '{{Computer}}' the account '{{TargetAccount}}' was deleted by '{{AddedBy}}'", + "description": "Account deleted on host", + "queryDefinitions": { + "query": "let GetAccountActions = (v_Host_Name:string, v_Host_NTDomain:string, v_Host_DnsDomain:string, v_Host_AzureID:string, v_Host_OMSAgentID:string){\nSecurityEvent\n| where EventID in (4725, 4726, 4767, 4720, 4722, 4723, 4724)\n// parsing for Host to handle variety of conventions coming from data\n| extend Host_HostName = case(\nComputer has '@', tostring(split(Computer, '@')[0]),\nComputer has '\\\\', tostring(split(Computer, '\\\\')[1]),\nComputer has '.', tostring(split(Computer, '.')[0]),\nComputer\n)\n| extend Host_NTDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', tostring(split(Computer, '.')[-2]), \nComputer\n)\n| extend Host_DnsDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', strcat_array(array_slice(split(Computer,'.'),-2,-1),'.'), \nComputer\n)\n| where (Host_HostName =~ v_Host_Name and Host_NTDomain =~ v_Host_NTDomain) \nor (Host_HostName =~ v_Host_Name and Host_DnsDomain =~ v_Host_DnsDomain) \nor v_Host_AzureID =~ _ResourceId \nor v_Host_OMSAgentID == SourceComputerId\n| project TimeGenerated, EventID, Activity, Computer, TargetAccount, TargetUserName, TargetDomainName, TargetSid, SubjectUserName, SubjectUserSid, _ResourceId, SourceComputerId\n| extend AddedBy = SubjectUserName\n// Future support for Activities\n| extend timestamp = TimeGenerated, HostCustomEntity = Computer, AccountCustomEntity = TargetAccount\n};\nGetAccountActions('{{Host_HostName}}', '{{Host_NTDomain}}', '{{Host_DnsDomain}}', '{{Host_AzureID}}', '{{Host_OMSAgentID}}')\n \n| where EventID == 4726 " + }, + "inputEntityType": "Host", + "requiredInputFieldsSets": [ + [ + "Host_HostName", + "Host_NTDomain" + ], + [ + "Host_HostName", + "Host_DnsDomain" + ], + [ + "Host_AzureID" + ], + [ + "Host_OMSAgentID" + ] + ], + "entitiesFilter": { + "Host_OsFamily": [ + "Windows" + ] + }, + "enabled": true, + "templateName": null + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entityQueries/07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "name": "07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "type": "Microsoft.SecurityInsights/entityQueries", + "kind": "Activity", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "title": "An account was deleted on this host", + "content": "On '{{Computer}}' the account '{{TargetAccount}}' was deleted by '{{AddedBy}}'", + "description": "Account deleted on host", + "queryDefinitions": { + "query": "let GetAccountActions = (v_Host_Name:string, v_Host_NTDomain:string, v_Host_DnsDomain:string, v_Host_AzureID:string, v_Host_OMSAgentID:string){\nSecurityEvent\n| where EventID in (4725, 4726, 4767, 4720, 4722, 4723, 4724)\n// parsing for Host to handle variety of conventions coming from data\n| extend Host_HostName = case(\nComputer has '@', tostring(split(Computer, '@')[0]),\nComputer has '\\\\', tostring(split(Computer, '\\\\')[1]),\nComputer has '.', tostring(split(Computer, '.')[0]),\nComputer\n)\n| extend Host_NTDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', tostring(split(Computer, '.')[-2]), \nComputer\n)\n| extend Host_DnsDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', strcat_array(array_slice(split(Computer,'.'),-2,-1),'.'), \nComputer\n)\n| where (Host_HostName =~ v_Host_Name and Host_NTDomain =~ v_Host_NTDomain) \nor (Host_HostName =~ v_Host_Name and Host_DnsDomain =~ v_Host_DnsDomain) \nor v_Host_AzureID =~ _ResourceId \nor v_Host_OMSAgentID == SourceComputerId\n| project TimeGenerated, EventID, Activity, Computer, TargetAccount, TargetUserName, TargetDomainName, TargetSid, SubjectUserName, SubjectUserSid, _ResourceId, SourceComputerId\n| extend AddedBy = SubjectUserName\n// Future support for Activities\n| extend timestamp = TimeGenerated, HostCustomEntity = Computer, AccountCustomEntity = TargetAccount\n};\nGetAccountActions('{{Host_HostName}}', '{{Host_NTDomain}}', '{{Host_DnsDomain}}', '{{Host_AzureID}}', '{{Host_OMSAgentID}}')\n \n| where EventID == 4726 " + }, + "inputEntityType": "Host", + "requiredInputFieldsSets": [ + [ + "Host_HostName", + "Host_NTDomain" + ], + [ + "Host_HostName", + "Host_DnsDomain" + ], + [ + "Host_AzureID" + ], + [ + "Host_OMSAgentID" + ] + ], + "entitiesFilter": { + "Host_OsFamily": [ + "Windows" + ] + }, + "enabled": true, + "templateName": null, + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entityQueries/07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "name": "07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "type": "Microsoft.SecurityInsights/entityQueries", + "kind": "Activity", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "title": "An account was deleted on this host", + "content": "On '{{Computer}}' the account '{{TargetAccount}}' was deleted by '{{AddedBy}}'", + "description": "Account deleted on host", + "queryDefinitions": { + "query": "let GetAccountActions = (v_Host_Name:string, v_Host_NTDomain:string, v_Host_DnsDomain:string, v_Host_AzureID:string, v_Host_OMSAgentID:string){\nSecurityEvent\n| where EventID in (4725, 4726, 4767, 4720, 4722, 4723, 4724)\n// parsing for Host to handle variety of conventions coming from data\n| extend Host_HostName = case(\nComputer has '@', tostring(split(Computer, '@')[0]),\nComputer has '\\\\', tostring(split(Computer, '\\\\')[1]),\nComputer has '.', tostring(split(Computer, '.')[0]),\nComputer\n)\n| extend Host_NTDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', tostring(split(Computer, '.')[-2]), \nComputer\n)\n| extend Host_DnsDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', strcat_array(array_slice(split(Computer,'.'),-2,-1),'.'), \nComputer\n)\n| where (Host_HostName =~ v_Host_Name and Host_NTDomain =~ v_Host_NTDomain) \nor (Host_HostName =~ v_Host_Name and Host_DnsDomain =~ v_Host_DnsDomain) \nor v_Host_AzureID =~ _ResourceId \nor v_Host_OMSAgentID == SourceComputerId\n| project TimeGenerated, EventID, Activity, Computer, TargetAccount, TargetUserName, TargetDomainName, TargetSid, SubjectUserName, SubjectUserSid, _ResourceId, SourceComputerId\n| extend AddedBy = SubjectUserName\n// Future support for Activities\n| extend timestamp = TimeGenerated, HostCustomEntity = Computer, AccountCustomEntity = TargetAccount\n};\nGetAccountActions('{{Host_HostName}}', '{{Host_NTDomain}}', '{{Host_DnsDomain}}', '{{Host_AzureID}}', '{{Host_OMSAgentID}}')\n \n| where EventID == 4726 " + }, + "inputEntityType": "Host", + "requiredInputFieldsSets": [ + [ + "Host_HostName", + "Host_NTDomain" + ], + [ + "Host_HostName", + "Host_DnsDomain" + ], + [ + "Host_AzureID" + ], + [ + "Host_OMSAgentID" + ] + ], + "entitiesFilter": { + "Host_OsFamily": [ + "Windows" + ] + }, + "enabled": true, + "templateName": null, + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/entityQueries/DeleteEntityQuery.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/entityQueries/DeleteEntityQuery.json new file mode 100644 index 000000000000..0a7f73c32995 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/entityQueries/DeleteEntityQuery.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "entityQueryId": "07da3cc8-c8ad-4710-a44e-334cdcb7882b" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/entityQueries/GetActivityEntityQueryById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/entityQueries/GetActivityEntityQueryById.json new file mode 100644 index 000000000000..e1c3cee8fcfb --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/entityQueries/GetActivityEntityQueryById.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "entityQueryId": "07da3cc8-c8ad-4710-a44e-334cdcb7882b" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entityQueries/07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "name": "07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "type": "Microsoft.SecurityInsights/entityQueries", + "etag": null, + "kind": "Activity", + "properties": { + "title": "An account was deleted on this host", + "content": "On '{{Computer}}' the account '{{TargetAccount}}' was deleted by '{{AddedBy}}'", + "description": "Account deleted on host", + "queryDefinitions": { + "query": "let GetAccountActions = (v_Host_Name:string, v_Host_NTDomain:string, v_Host_DnsDomain:string, v_Host_AzureID:string, v_Host_OMSAgentID:string){\nSecurityEvent\n| where EventID in (4725, 4726, 4767, 4720, 4722, 4723, 4724)\n// parsing for Host to handle variety of conventions coming from data\n| extend Host_HostName = case(\nComputer has '@', tostring(split(Computer, '@')[0]),\nComputer has '\\\\', tostring(split(Computer, '\\\\')[1]),\nComputer has '.', tostring(split(Computer, '.')[0]),\nComputer\n)\n| extend Host_NTDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', tostring(split(Computer, '.')[-2]), \nComputer\n)\n| extend Host_DnsDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', strcat_array(array_slice(split(Computer,'.'),-2,-1),'.'), \nComputer\n)\n| where (Host_HostName =~ v_Host_Name and Host_NTDomain =~ v_Host_NTDomain) \nor (Host_HostName =~ v_Host_Name and Host_DnsDomain =~ v_Host_DnsDomain) \nor v_Host_AzureID =~ _ResourceId \nor v_Host_OMSAgentID == SourceComputerId\n| project TimeGenerated, EventID, Activity, Computer, TargetAccount, TargetUserName, TargetDomainName, TargetSid, SubjectUserName, SubjectUserSid, _ResourceId, SourceComputerId\n| extend AddedBy = SubjectUserName\n// Future support for Activities\n| extend timestamp = TimeGenerated, HostCustomEntity = Computer, AccountCustomEntity = TargetAccount\n};\nGetAccountActions('{{Host_HostName}}', '{{Host_NTDomain}}', '{{Host_DnsDomain}}', '{{Host_AzureID}}', '{{Host_OMSAgentID}}')\n \n| where EventID == 4726 " + }, + "inputEntityType": "Host", + "requiredInputFieldsSets": [ + [ + "Host_HostName", + "Host_NTDomain" + ], + [ + "Host_HostName", + "Host_DnsDomain" + ], + [ + "Host_AzureID" + ], + [ + "Host_OMSAgentID" + ] + ], + "entitiesFilter": { + "Host_OsFamily": [ + "Windows" + ] + }, + "enabled": true, + "templateName": null, + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/entityQueries/GetEntityQueries.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/entityQueries/GetEntityQueries.json new file mode 100644 index 000000000000..0a2e23767f81 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/entityQueries/GetEntityQueries.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2021-03-01-preview", + "kind": "Expansion", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entityQueries/37ca3555-c135-4a73-a65e-9c1d00323f5d", + "name": "37ca3555-c135-4a73-a65e-9c1d00323f5d", + "type": "Microsoft.SecurityInsights/entityQueries", + "etag": null, + "kind": "Expansion", + "properties": { + "queryTemplate": "let AccountActivity_byIP = (v_IP_Address:string){\r\n AzureActivity\r\n | where Caller != '' and CallerIpAddress == v_IP_Address\r\n | summarize Account_Aux_StartTime = min(TimeGenerated), Account_Aux_EndTime = max(TimeGenerated), Count = count() by Caller, TenantId\r\n | top 10 by Count asc nulls last \r\n | extend UPN = iff(Caller contains '@', Caller, ''), Account_AadUserId = iff(Caller !contains '@', Caller,'')\r\n | extend Account_Name = split(UPN,'@')[0] , Account_UPNSuffix = split(UPN,'@')[1]\r\n | project Account_Name, Account_UPNSuffix, Account_AadUserId, Account_AadTenantId=TenantId, Account_Aux_StartTime , Account_Aux_EndTime};\r\n AccountActivity_byIP('
    ')", + "inputFields": [ + "address" + ], + "outputEntityTypes": [ + "Account" + ], + "dataSources": [ + "AzureActivity" + ], + "inputEntityType": "IP", + "displayName": "Least active accounts on Azure from this IP" + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entityQueries/97a1d515-abf2-4231-9a35-985f9de0bb91", + "name": "97a1d515-abf2-4231-9a35-985f9de0bb91", + "type": "Microsoft.SecurityInsights/entityQueries", + "etag": null, + "kind": "Expansion", + "properties": { + "queryTemplate": "let AccountActivity_byIP = (v_IP_Address:string){\r\n AzureActivity\r\n | where Caller != '' and CallerIpAddress == v_IP_Address\r\n | summarize Account_Aux_StartTime = min(TimeGenerated), Account_Aux_EndTime = max(TimeGenerated), Count = count() by Caller, TenantId\r\n | top 10 by Count desc nulls last \r\n | extend UPN = iff(Caller contains '@', Caller, ''), Account_AadUserId = iff(Caller !contains '@', Caller,'')\r\n | extend Account_Name = split(UPN,'@')[0] , Account_UPNSuffix = split(UPN,'@')[1]\r\n | project Account_Name, Account_UPNSuffix, Account_AadUserId, Account_AadTenantId=TenantId, Account_Aux_StartTime , Account_Aux_EndTime};\r\n AccountActivity_byIP('
    ')", + "inputFields": [ + "address" + ], + "outputEntityTypes": [ + "Account" + ], + "dataSources": [ + "AzureActivity" + ], + "inputEntityType": "IP", + "displayName": "Most active accounts on Azure from this IP" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/entityQueries/GetExpansionEntityQueryById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/entityQueries/GetExpansionEntityQueryById.json new file mode 100644 index 000000000000..f33d16ea2e1b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/entityQueries/GetExpansionEntityQueryById.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "entityQueryId": "07da3cc8-c8ad-4710-a44e-334cdcb7882b" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entityQueries/07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "name": "07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "type": "Microsoft.SecurityInsights/entityQueries", + "etag": null, + "kind": "Expansion", + "properties": { + "queryTemplate": "let GetParentProcessesOnHost = (v_Host_HostName:string){\r\n SecurityEvent \r\n | where EventID == 4688 \r\n | where isnotempty(ParentProcessName)\r\n | where NewProcessName !contains ':\\\\Windows\\\\System32\\\\conhost.exe' and ParentProcessName !contains ':\\\\Windows\\\\System32\\\\conhost.exe'\r\n and NewProcessName !contains ':\\\\Windows\\\\Microsoft.NET\\\\Framework64\\\\v2.0.50727\\\\csc.exe' and ParentProcessName !contains ':\\\\Windows\\\\Microsoft.NET\\\\Framework64\\\\v2.0.50727\\\\csc.exe'\r\n and NewProcessName !contains ':\\\\Windows\\\\Microsoft.NET\\\\Framework64\\\\v2.0.50727\\\\cvtres.exe' and ParentProcessName !contains ':\\\\Windows\\\\Microsoft.NET\\\\Framework64\\\\v2.0.50727\\\\cvtres.exe'\r\n and NewProcessName!contains ':\\\\Program Files\\\\Microsoft Monitoring Agent\\\\Agent\\\\MonitoringHost.exe' and ParentProcessName !contains ':\\\\Program Files\\\\Microsoft Monitoring Agent\\\\Agent\\\\MonitoringHost.exe'\r\n and ParentProcessName !contains ':\\\\Windows\\\\CCM\\\\CcmExec.exe'\r\n | where(ParentProcessName !contains ':\\\\Windows\\\\System32\\\\svchost.exe' and (NewProcessName !contains ':\\\\Windows\\\\System32\\\\wbem\\\\WmiPrvSE.exe' or NewProcessName !contains ':\\\\Windows\\\\SysWOW64\\\\wbem\\\\WmiPrvSE.exe'))\r\n | where(ParentProcessName !contains ':\\\\Windows\\\\System32\\\\services.exe' and NewProcessName !contains ':\\\\Windows\\\\servicing\\\\TrustedInstaller.exe')\r\n | where toupper(Computer) contains v_Host_HostName or toupper(WorkstationName) contains v_Host_HostName\r\n | summarize min(TimeGenerated), max(TimeGenerated) by Account, Computer, ParentProcessName, NewProcessName, CommandLine, ProcessId\r\n | project min_TimeGenerated, max_TimeGenerated, Account, Computer, ParentProcessName, NewProcessName, CommandLine, ProcessId\r\n | project-rename Process_Host_UnstructuredName=Computer, Process_Account_UnstructuredName=Account, Process_CommandLine=CommandLine, Process_ProcessId=ProcessId, Process_ImageFile_FullPath=NewProcessName, Process_ParentProcess_ImageFile_FullPath=ParentProcessName\r\n | top 10 by min_TimeGenerated asc};\r\n GetParentProcessesOnHost(toupper(''))", + "inputFields": [ + "hostName" + ], + "outputEntityTypes": [ + "Process" + ], + "dataSources": [ + "SecurityEvent" + ], + "inputEntityType": "Host", + "displayName": "Parent processes running on host" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/CreateIncident.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/CreateIncident.json new file mode 100644 index 000000000000..f7af0efcb1e5 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/CreateIncident.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incident": { + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "lastActivityTimeUtc": "2019-01-01T13:05:30Z", + "firstActivityTimeUtc": "2019-01-01T13:00:30Z", + "description": "This is a demo incident", + "title": "My incident", + "owner": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70" + }, + "severity": "High", + "classification": "FalsePositive", + "classificationComment": "Not a malicious activity", + "classificationReason": "IncorrectAlertLogic", + "status": "Closed" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/incidents", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0001\"", + "properties": { + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastActivityTimeUtc": "2019-01-01T13:05:30Z", + "firstActivityTimeUtc": "2019-01-01T13:00:30Z", + "description": "This is a demo incident", + "title": "My incident", + "owner": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "userPrincipalName": "john@contoso.com", + "assignedTo": "john doe", + "ownerType": "User" + }, + "severity": "High", + "classification": "FalsePositive", + "classificationComment": "Not a malicious activity", + "classificationReason": "IncorrectAlertLogic", + "status": "Closed", + "incidentUrl": "https://portal.azure.com/#asset/Microsoft_Azure_Security_Insights/Incident/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incidentNumber": 3177, + "labels": [], + "providerName": "Azure Sentinel", + "providerIncidentId": "3177", + "relatedAnalyticRuleIds": [], + "additionalData": { + "alertsCount": 0, + "bookmarksCount": 0, + "commentsCount": 3, + "alertProductNames": [], + "tactics": [] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/incidents", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0001\"", + "properties": { + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastActivityTimeUtc": "2019-01-01T13:05:30Z", + "firstActivityTimeUtc": "2019-01-01T13:00:30Z", + "description": "This is a demo incident", + "title": "My incident", + "owner": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "userPrincipalName": "john@contoso.com", + "assignedTo": "john doe" + }, + "severity": "High", + "classification": "FalsePositive", + "classificationComment": "Not a malicious activity", + "classificationReason": "IncorrectAlertLogic", + "status": "Closed", + "incidentUrl": "https://portal.azure.com/#asset/Microsoft_Azure_Security_Insights/Incident/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incidentNumber": 3177, + "labels": [], + "providerName": "Azure Sentinel", + "providerIncidentId": "3177", + "relatedAnalyticRuleIds": [], + "additionalData": { + "alertsCount": 0, + "bookmarksCount": 0, + "commentsCount": 3, + "alertProductNames": [], + "tactics": [] + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/CreateTeam.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/CreateTeam.json new file mode 100644 index 000000000000..b3ce2c63ff09 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/CreateTeam.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "9023f5b5-df22-4313-8fbf-b4b75af8a6d9", + "resourceGroupName": "ambawolvese5resourcegroup", + "workspaceName": "AmbaE5WestCentralUS", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "incidentId": "69a30280-6a4c-4aa7-9af0-5d63f335d600", + "teamProperties": { + "teamName": "Team name", + "teamDescription": "Team description" + } + }, + "responses": { + "200": { + "body": { + "teamId": "99978838-9bda-4ad4-8f93-4cf7ebc50ca5", + "primaryChannelUrl": "https://teams.microsoft.com/l/team/19:80bf3b25485b4067b7d2dc4eec9e1578%40thread.tacv2/conversations?groupId=99978838-9bda-4ad4-8f93-4cf7ebc50ca5&tenantId=5b5a146c-eba8-46af-96f8-e31b50d15a3f", + "teamCreationTimeUtc": "2021-03-15T17:08:21.9954238+02:00", + "name": "Team name", + "description": "Team description" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/DeleteIncident.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/DeleteIncident.json new file mode 100644 index 000000000000..cea1f39e02a0 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/DeleteIncident.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/GetAllIncidentAlerts.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/GetAllIncidentAlerts.json new file mode 100644 index 000000000000..e5ee9a398a04 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/GetAllIncidentAlerts.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "incidentId": "afbd324f-6c48-459c-8710-8d1e1cd03812" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRG/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Entities/baa8a239-6fde-4ab7-a093-d09f7b75c58c", + "name": "baa8a239-6fde-4ab7-a093-d09f7b75c58c", + "type": "Microsoft.SecurityInsights/Entities", + "kind": "SecurityAlert", + "properties": { + "systemAlertId": "baa8a239-6fde-4ab7-a093-d09f7b75c58c", + "tactics": [], + "alertDisplayName": "myAlert", + "confidenceLevel": "Unknown", + "severity": "Low", + "vendorName": "Microsoft", + "productName": "Azure Security Center", + "alertType": "myAlert", + "processingEndTime": "2020-07-20T18:21:53.6158361Z", + "status": "New", + "endTimeUtc": "2020-07-20T18:21:53.6158361Z", + "startTimeUtc": "2020-07-20T18:21:53.6158361Z", + "timeGenerated": "2020-07-20T18:21:53.6158361Z", + "resourceIdentifiers": [ + { + "type": "LogAnalytics", + "workspaceId": "c8c99641-985d-4e4e-8e91-fb3466cd0e5b", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroup": "myRG" + } + ], + "additionalData": { + "AlertMessageEnqueueTime": "2020-07-20T18:21:57.304Z" + }, + "friendlyName": "myAlert" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/GetAllIncidentBookmarks.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/GetAllIncidentBookmarks.json new file mode 100644 index 000000000000..25c407371bb4 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/GetAllIncidentBookmarks.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "incidentId": "afbd324f-6c48-459c-8710-8d1e1cd03812" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/afbd324f-6c48-459c-8710-8d1e1cd03812", + "name": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "type": "Microsoft.SecurityInsights/Entities", + "kind": "Bookmark", + "properties": { + "displayName": "SecurityEvent - 868f40f4698d", + "created": "2020-06-17T15:34:01.4265524+00:00", + "updated": "2020-06-17T15:34:01.4265524+00:00", + "createdBy": { + "objectId": "b03ca914-5eb6-45e5-9417-fe0797c372fd", + "email": "user@microsoft.com", + "name": "user" + }, + "updatedBy": { + "objectId": "b03ca914-5eb6-45e5-9417-fe0797c372fd", + "email": "user@microsoft.com", + "name": "user" + }, + "eventTime": "2020-06-17T15:34:01.4265524+00:00", + "labels": [], + "query": "SecurityEvent\r\n| take 1\n", + "queryResult": "{\"TimeGenerated\":\"2020-05-24T01:24:25.67Z\",\"Account\":\"\\\\ADMINISTRATOR\",\"AccountType\":\"User\",\"Computer\":\"SecurityEvents\",\"EventSourceName\":\"Microsoft-Windows-Security-Auditing\",\"Channel\":\"Security\",\"Task\":12544,\"Level\":\"16\",\"EventID\":4625,\"Activity\":\"4625 - An account failed to log on.\",\"AuthenticationPackageName\":\"NTLM\",\"FailureReason\":\"%%2313\",\"IpAddress\":\"176.113.115.73\",\"IpPort\":\"0\",\"LmPackageName\":\"-\",\"LogonProcessName\":\"NtLmSsp \",\"LogonType\":3,\"LogonTypeName\":\"3 - Network\",\"Process\":\"-\",\"ProcessId\":\"0x0\",\"__entityMapping\":{\"\\\\ADMINISTRATOR\":\"Account\",\"SecurityEvents\":\"Host\"}}", + "additionalData": { + "ETag": "\"3b00acab-0000-0d00-0000-5f15e4ed0000\"", + "EntityId": "afbd324f-6c48-459c-8710-8d1e1cd03812" + }, + "friendlyName": "SecurityEvent - 868f40f4698d" + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/bbbd324f-6c48-459c-8710-8d1e1cd03812", + "name": "bbbd324f-6c48-459c-8710-8d1e1cd03812", + "type": "Microsoft.SecurityInsights/Entities", + "kind": "Bookmark", + "properties": { + "displayName": "SecurityEvent - 868f40f4698d", + "created": "2020-06-17T15:34:01.4265524+00:00", + "updated": "2020-06-17T15:34:01.4265524+00:00", + "createdBy": { + "objectId": "303ca914-5eb6-45e5-9417-fe0797c372fd", + "email": "user@microsoft.com", + "name": "user" + }, + "updatedBy": { + "objectId": "b03ca914-5eb6-45e5-9417-fe0797c372fd", + "email": "user@microsoft.com", + "name": "user" + }, + "eventTime": "2020-06-17T15:34:01.4265524+00:00", + "labels": [], + "query": "SecurityEvent\r\n| take 1\n", + "queryResult": "{\"TimeGenerated\":\"2020-05-24T01:24:25.67Z\",\"Account\":\"\\\\ADMINISTRATOR\",\"AccountType\":\"User\",\"Computer\":\"SecurityEvents\",\"EventSourceName\":\"Microsoft-Windows-Security-Auditing\",\"Channel\":\"Security\",\"Task\":12544,\"Level\":\"16\",\"EventID\":4625,\"Activity\":\"4625 - An account failed to log on.\",\"AuthenticationPackageName\":\"NTLM\",\"FailureReason\":\"%%2313\",\"IpAddress\":\"176.113.115.73\",\"IpPort\":\"0\",\"LmPackageName\":\"-\",\"LogonProcessName\":\"NtLmSsp \",\"LogonType\":3,\"LogonTypeName\":\"3 - Network\",\"Process\":\"-\",\"ProcessId\":\"0x0\",\"__entityMapping\":{\"\\\\ADMINISTRATOR\":\"Account\",\"SecurityEvents\":\"Host\"}}", + "additionalData": { + "ETag": "\"3b00acab-0000-0d00-0000-5f15e4ed0000\"", + "EntityId": "afbd324f-6c48-459c-8710-8d1e1cd03812" + }, + "friendlyName": "SecurityEvent - 868f40f4698d" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/GetIncidentById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/GetIncidentById.json new file mode 100644 index 000000000000..8b24a8a6972a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/GetIncidentById.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/incidents", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastActivityTimeUtc": "2019-01-01T13:05:30Z", + "firstActivityTimeUtc": "2019-01-01T13:00:30Z", + "description": "This is a demo incident", + "title": "My incident", + "owner": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "userPrincipalName": "john@contoso.com", + "assignedTo": "john doe", + "ownerType": "User" + }, + "severity": "High", + "classification": "FalsePositive", + "classificationComment": "Not a malicious activity", + "classificationReason": "InaccurateData", + "status": "Closed", + "incidentUrl": "https://portal.azure.com/#asset/Microsoft_Azure_Security_Insights/Incident/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incidentNumber": 3177, + "labels": [], + "providerName": "Azure Sentinel", + "providerIncidentId": "3177", + "relatedAnalyticRuleIds": [ + "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/fab3d2d4-747f-46a7-8ef0-9c0be8112bf7" + ], + "additionalData": { + "alertsCount": 0, + "bookmarksCount": 0, + "commentsCount": 3, + "alertProductNames": [], + "tactics": [ + "InitialAccess", + "Persistence" + ] + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/GetIncidents.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/GetIncidents.json new file mode 100644 index 000000000000..7c10cba065d4 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/GetIncidents.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "$orderby": "properties/createdTimeUtc desc", + "$top": 1 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/incidents", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastActivityTimeUtc": "2019-01-01T13:05:30Z", + "firstActivityTimeUtc": "2019-01-01T13:00:30Z", + "description": "This is a demo incident", + "title": "My incident", + "owner": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "userPrincipalName": "john@contoso.com", + "assignedTo": "john doe", + "ownerType": "User" + }, + "severity": "High", + "classification": "FalsePositive", + "classificationComment": "Not a malicious activity", + "classificationReason": "IncorrectAlertLogic", + "status": "Closed", + "incidentUrl": "https://portal.azure.com/#asset/Microsoft_Azure_Security_Insights/Incident/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incidentNumber": 3177, + "labels": [], + "providerName": "Azure Sentinel", + "providerIncidentId": "3177", + "relatedAnalyticRuleIds": [ + "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/fab3d2d4-747f-46a7-8ef0-9c0be8112bf7", + "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/8deb8303-e94d-46ff-96e0-5fd94b33df1a" + ], + "additionalData": { + "alertsCount": 0, + "bookmarksCount": 0, + "commentsCount": 3, + "alertProductNames": [], + "tactics": [ + "Persistence" + ] + } + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/comments/CreateIncidentComment.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/comments/CreateIncidentComment.json new file mode 100644 index 000000000000..be5b4a51a7dc --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/comments/CreateIncidentComment.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incidentCommentId": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "incidentComment": { + "properties": { + "message": "Some message" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5/comments/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/incidents/comments", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "message": "Some message", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-03T11:10:30Z", + "author": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "userPrincipalName": "john@contoso.com", + "name": "john doe" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5/comments/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/incidents/comments", + "etag": "190057d0-0000-0d00-0000-5c622adb0000", + "properties": { + "message": "Some message", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z", + "author": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "userPrincipalName": "john@contoso.com", + "name": "john doe" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/comments/DeleteIncidentComment.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/comments/DeleteIncidentComment.json new file mode 100644 index 000000000000..77aadc8bf832 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/comments/DeleteIncidentComment.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2023-03-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incidentCommentId": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/comments/GetAllIncidentComments.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/comments/GetAllIncidentComments.json new file mode 100644 index 000000000000..c3c1ab85e9ca --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/comments/GetAllIncidentComments.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5/comments/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/incidents/comments", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "message": "Some message", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-03T11:10:30Z", + "author": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "userPrincipalName": "john@contoso.com", + "name": "john doe" + } + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/comments/GetIncidentCommentById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/comments/GetIncidentCommentById.json new file mode 100644 index 000000000000..f92cba74c57e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/comments/GetIncidentCommentById.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incidentCommentId": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5/comments/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/incidents/comments", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "message": "Some message", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-03T11:10:30Z", + "author": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "userPrincipalName": "john@contoso.com", + "name": "john doe" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/entities/GetAllIncidentEntities.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/entities/GetAllIncidentEntities.json new file mode 100644 index 000000000000..ad0641a20c63 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/entities/GetAllIncidentEntities.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "incidentId": "afbd324f-6c48-459c-8710-8d1e1cd03812" + }, + "responses": { + "200": { + "body": { + "entities": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/Entities", + "kind": "Account", + "properties": { + "friendlyName": "administrator", + "accountName": "administrator", + "ntDomain": "domain" + } + } + ], + "metaData": [ + { + "entityKind": "Account", + "count": 1 + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/relations/CreateIncidentRelation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/relations/CreateIncidentRelation.json new file mode 100644 index 000000000000..434bdf330f2c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/relations/CreateIncidentRelation.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "incidentId": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "relationName": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "relation": { + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/incidents/relations", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceName": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceType": "Microsoft.SecurityInsights/bookmarks" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/incidents/relations", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceName": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceType": "Microsoft.SecurityInsights/bookmarks" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/relations/DeleteIncidentRelation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/relations/DeleteIncidentRelation.json new file mode 100644 index 000000000000..c172e23e69ca --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/relations/DeleteIncidentRelation.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "incidentId": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "relationName": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/relations/GetAllIncidentRelations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/relations/GetAllIncidentRelations.json new file mode 100644 index 000000000000..c6e50f6790d3 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/relations/GetAllIncidentRelations.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "incidentId": "afbd324f-6c48-459c-8710-8d1e1cd03812" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/incidents/relations", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceName": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceType": "Microsoft.SecurityInsights/bookmarks" + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812/relations/9673a17d-8bc7-4ca6-88ee-38a4f3efc032", + "name": "9673a17d-8bc7-4ca6-88ee-38a4f3efc032", + "type": "Microsoft.SecurityInsights/incidents/relations", + "etag": "6f714025-dd7c-46aa-b5d0-b9857488d060", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/1dd267cd-8a1f-4f6f-b92c-da43ac8819af", + "relatedResourceName": "1dd267cd-8a1f-4f6f-b92c-da43ac8819af", + "relatedResourceType": "Microsoft.SecurityInsights/entities", + "relatedResourceKind": "SecurityAlert" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/relations/GetIncidentRelationByName.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/relations/GetIncidentRelationByName.json new file mode 100644 index 000000000000..5f5d3d34d886 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/incidents/relations/GetIncidentRelationByName.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2021-03-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "incidentId": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "relationName": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/incidents/relations", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceName": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceType": "Microsoft.SecurityInsights/bookmarks" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/metadata/GetAllMetadata.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/metadata/GetAllMetadata.json index 6007e6681da4..22cf619d4ce5 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/metadata/GetAllMetadata.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/metadata/GetAllMetadata.json @@ -17,10 +17,10 @@ "properties": { "contentId": "c00ee137-7475-47c8-9cce-ec6f0f1bedd0", "version": "1.0.0.0", - "kind": "analyticRule", + "kind": "AnalyticsRule", "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName", "source": { - "kind": "solution", + "kind": "Solution", "name": "Contoso Solution 1.0", "sourceId": "b688a130-76f4-4a07-bf57-762222a3cadf" } @@ -33,10 +33,10 @@ "properties": { "contentId": "f5160682-0e10-4e23-8fcf-df3df49c5522", "version": "1.0.0.0", - "kind": "analyticRule", + "kind": "AnalyticsRule", "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName2", "source": { - "kind": "solution", + "kind": "Solution", "name": "Contoso Solution 1.0", "sourceId": "b688a130-76f4-4a07-bf57-762222a3cadf" } @@ -49,10 +49,10 @@ "properties": { "contentId": "f593501d-ec01-4057-8146-a1de35c461ef", "version": "1.0.0.0", - "kind": "workbook", + "kind": "Workbook", "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.Insights/workbooks/workbookName", "source": { - "kind": "solution", + "kind": "Solution", "name": "Contoso Solution 1.0", "sourceId": "b688a130-76f4-4a07-bf57-762222a3cadf" } diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/metadata/GetAllMetadataOData.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/metadata/GetAllMetadataOData.json index eead11bcca11..7eb696f2f572 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/metadata/GetAllMetadataOData.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/metadata/GetAllMetadataOData.json @@ -5,7 +5,7 @@ "resourceGroupName": "myRg", "workspaceName": "myWorkspace", "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", - "ODataFilter": "properties/kind eq 'analyticRule'", + "ODataFilter": "properties/kind eq 'AnalyticsRule'", "ODataOrderBy": "properties/parentId desc", "ODataSkip": "2", "ODataTop": "2" @@ -21,10 +21,10 @@ "properties": { "contentId": "c00ee137-7475-47c8-9cce-ec6f0f1bedd0", "version": "1.0.0.0", - "kind": "analyticRule", + "kind": "AnalyticsRule", "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName1", "source": { - "kind": "solution", + "kind": "Solution", "name": "Contoso Solution 1.0", "sourceId": "b688a130-76f4-4a07-bf57-762222a3cadf" } @@ -37,10 +37,10 @@ "properties": { "contentId": "f5160682-0e10-4e23-8fcf-df3df49c5522", "version": "1.0.0.0", - "kind": "analyticRule", + "kind": "AnalyticsRule", "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName2", "source": { - "kind": "solution", + "kind": "Solution", "name": "Contoso Solution 1.0", "sourceId": "b688a130-76f4-4a07-bf57-762222a3cadf" } diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/metadata/GetMetadata.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/metadata/GetMetadata.json index 8d01ae218bca..5753c829a1ed 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/metadata/GetMetadata.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/metadata/GetMetadata.json @@ -16,10 +16,10 @@ "properties": { "contentId": "c00ee137-7475-47c8-9cce-ec6f0f1bedd0", "version": "1.0.0.0", - "kind": "analyticRule", + "kind": "AnalyticsRule", "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName", "source": { - "kind": "solution", + "kind": "Solution", "name": "Contoso Solution 1.0", "sourceId": "b688a130-76f4-4a07-bf57-762222a3cadf" }, @@ -31,7 +31,7 @@ "name": "Microsoft", "email": "support@microsoft.com", "link": "https://support.microsoft.com/", - "tier": "developer" + "tier": "Partner" }, "dependencies": { "operator": "AND", @@ -41,26 +41,26 @@ "criteria": [ { "contentId": "045d06d0-ee72-4794-aba4-cf5646e4c756", - "kind": "dataConnector" + "kind": "DataConnector" }, { "contentId": "dbfcb2cc-d782-40ef-8d94-fe7af58a6f2d", - "kind": "dataConnector" + "kind": "DataConnector" }, { "contentId": "de4dca9b-eb37-47d6-a56f-b8b06b261593", - "kind": "dataConnector", + "kind": "DataConnector", "version": "2.0" } ] }, { - "kind": "playbook", + "kind": "Playbook", "contentId": "31ee11cc-9989-4de8-b176-5e0ef5c4dbab", "version": "1.0" }, { - "kind": "parser", + "kind": "Parser", "contentId": "21ba424a-9438-4444-953a-7059539a7a1b" } ] diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/metadata/PatchMetadata.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/metadata/PatchMetadata.json index 5b41f54be96b..f9efe7228842 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/metadata/PatchMetadata.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/metadata/PatchMetadata.json @@ -23,7 +23,7 @@ "type": "Microsoft.SecurityInsights/metadata", "properties": { "contentId": "c00ee137-7475-47c8-9cce-ec6f0f1bedd0", - "kind": "analyticRule", + "kind": "AnalyticsRule", "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName", "author": { "name": "User Name", diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/metadata/PutMetadata.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/metadata/PutMetadata.json index 1cf87ee0e38e..a6bbd1386106 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/metadata/PutMetadata.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/metadata/PutMetadata.json @@ -10,10 +10,10 @@ "properties": { "contentId": "c00ee137-7475-47c8-9cce-ec6f0f1bedd0", "version": "1.0.0.0", - "kind": "analyticRule", + "kind": "AnalyticsRule", "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName", "source": { - "kind": "solution", + "kind": "Solution", "name": "Contoso Solution 1.0", "sourceId": "b688a130-76f4-4a07-bf57-762222a3cadf" }, @@ -25,7 +25,7 @@ "name": "Microsoft", "email": "support@microsoft.com", "link": "https://support.microsoft.com/", - "tier": "developer" + "tier": "Partner" }, "dependencies": { "operator": "AND", @@ -35,27 +35,27 @@ "criteria": [ { "contentId": "045d06d0-ee72-4794-aba4-cf5646e4c756", - "kind": "dataConnector", + "kind": "DataConnector", "name": "Microsoft Defender for Endpoint" }, { "contentId": "dbfcb2cc-d782-40ef-8d94-fe7af58a6f2d", - "kind": "dataConnector" + "kind": "DataConnector" }, { "contentId": "de4dca9b-eb37-47d6-a56f-b8b06b261593", - "kind": "dataConnector", + "kind": "DataConnector", "version": "2.0" } ] }, { - "kind": "playbook", + "kind": "Playbook", "contentId": "31ee11cc-9989-4de8-b176-5e0ef5c4dbab", "version": "1.0" }, { - "kind": "parser", + "kind": "Parser", "contentId": "21ba424a-9438-4444-953a-7059539a7a1b" } ] @@ -72,10 +72,10 @@ "properties": { "contentId": "c00ee137-7475-47c8-9cce-ec6f0f1bedd0", "version": "1.0.0.0", - "kind": "analyticRule", + "kind": "AnalyticsRule", "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName", "source": { - "kind": "solution", + "kind": "Solution", "name": "Contoso Solution 1.0", "sourceId": "b688a130-76f4-4a07-bf57-762222a3cadf" }, @@ -87,7 +87,7 @@ "name": "Microsoft", "email": "support@microsoft.com", "link": "https://support.microsoft.com/", - "tier": "developer" + "tier": "Partner" }, "dependencies": { "operator": "AND", @@ -97,26 +97,26 @@ "criteria": [ { "contentId": "045d06d0-ee72-4794-aba4-cf5646e4c756", - "kind": "dataConnector" + "kind": "DataConnector" }, { "contentId": "dbfcb2cc-d782-40ef-8d94-fe7af58a6f2d", - "kind": "dataConnector" + "kind": "DataConnector" }, { "contentId": "de4dca9b-eb37-47d6-a56f-b8b06b261593", - "kind": "dataConnector", + "kind": "DataConnector", "version": "2.0" } ] }, { - "kind": "playbook", + "kind": "Playbook", "contentId": "31ee11cc-9989-4de8-b176-5e0ef5c4dbab", "version": "1.0" }, { - "kind": "parser", + "kind": "Parser", "contentId": "21ba424a-9438-4444-953a-7059539a7a1b" } ] @@ -132,10 +132,10 @@ "properties": { "contentId": "c00ee137-7475-47c8-9cce-ec6f0f1bedd0", "version": "1.0.0.0", - "kind": "analyticRule", + "kind": "AnalyticsRule", "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName", "source": { - "kind": "solution", + "kind": "Solution", "name": "Contoso Solution 1.0", "sourceId": "b688a130-76f4-4a07-bf57-762222a3cadf" }, @@ -147,7 +147,7 @@ "name": "Microsoft", "email": "support@microsoft.com", "link": "https://support.microsoft.com/", - "tier": "developer" + "tier": "Partner" }, "dependencies": { "operator": "AND", @@ -157,26 +157,26 @@ "criteria": [ { "contentId": "045d06d0-ee72-4794-aba4-cf5646e4c756", - "kind": "dataConnector" + "kind": "DataConnector" }, { "contentId": "dbfcb2cc-d782-40ef-8d94-fe7af58a6f2d", - "kind": "dataConnector" + "kind": "DataConnector" }, { "contentId": "de4dca9b-eb37-47d6-a56f-b8b06b261593", - "kind": "dataConnector", + "kind": "DataConnector", "version": "2.0" } ] }, { - "kind": "playbook", + "kind": "Playbook", "contentId": "31ee11cc-9989-4de8-b176-5e0ef5c4dbab", "version": "1.0" }, { - "kind": "parser", + "kind": "Parser", "contentId": "21ba424a-9438-4444-953a-7059539a7a1b" } ] diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/metadata/PutMetadataMinimal.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/metadata/PutMetadataMinimal.json index 1d916bf7c02e..ecb3ffd04e59 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/metadata/PutMetadataMinimal.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/metadata/PutMetadataMinimal.json @@ -9,7 +9,7 @@ "metadata": { "properties": { "contentId": "c00ee137-7475-47c8-9cce-ec6f0f1bedd0", - "kind": "analyticRule", + "kind": "AnalyticsRule", "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName" } } @@ -21,8 +21,7 @@ "name": "metadataName", "type": "Microsoft.SecurityInsights/metadata", "properties": { - "contentId": "c00ee137-7475-47c8-9cce-ec6f0f1bedd0", - "kind": "analyticRule", + "kind": "AnalyticsRule", "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName" } } @@ -33,8 +32,7 @@ "name": "metadataName", "type": "Microsoft.SecurityInsights/metadata", "properties": { - "contentId": "c00ee137-7475-47c8-9cce-ec6f0f1bedd0", - "kind": "analyticRule", + "kind": "AnalyticsRule", "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName" } } diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/settings/Offboard.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/settings/Offboard.json deleted file mode 100644 index 68a955f6191e..000000000000 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/settings/Offboard.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "api-version": "2021-03-01-preview", - "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", - "resourceGroupName": "myRg", - "workspaceName": "myWorkspace", - "operationalInsightsResourceProvider": "Microsoft.OperationalInsights" - }, - "responses": { - "200": {} - } -} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/settings/Onboard.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/settings/Onboard.json deleted file mode 100644 index c935c87ae22d..000000000000 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/examples/settings/Onboard.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "parameters": { - "api-version": "2021-03-01-preview", - "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", - "resourceGroupName": "myRg", - "workspaceName": "myWorkspace", - "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", - "onboardingRequest": { - "sku": { - "name": "CapacityReservation", - "capacityReservationLevel": 700 - }, - "customerManagedKey": false, - "eyesOn": true, - "entityAnalytics": { - "enabled": true, - "uebaDataSources": [ - "AuditLogs", - "SecurityEvent" - ] - } - } - }, - "responses": { - "200": { - "body": { - "sku": { - "name": "CapacityReservation", - "capacityReservationLevel": 700 - }, - "customerManagedKey": false, - "eyesOn": true, - "entityAnalytics": { - "enabled": true, - "uebaDataSources": [ - "AuditLogs", - "SecurityEvent" - ] - } - } - } - } -} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/operations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/operations.json index 7a3d8fcd720f..376edf33331c 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/operations.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/operations.json @@ -40,7 +40,7 @@ "description": "Lists all operations available Azure Security Insights Resource Provider.", "parameters": [ { - "$ref": "../../../common/1.0/types.json#/parameters/ApiVersion" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "produces": [ @@ -83,6 +83,7 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] @@ -120,7 +121,8 @@ "description": "The origin of the operation", "type": "string" } - } + }, + "type": "object" } }, "parameters": {} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/AlertRules.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/AlertRules.json new file mode 100644 index 000000000000..ed000a7477c7 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/AlertRules.json @@ -0,0 +1,1431 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2020-01-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.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules": { + "get": { + "x-ms-examples": { + "Get all alert rules.": { + "$ref": "./examples/alertRules/GetAllAlertRules.json" + } + }, + "tags": [ + "Alert Rules" + ], + "description": "Gets all alert rules.", + "operationId": "AlertRules_List", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/AlertRulesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}": { + "get": { + "x-ms-examples": { + "Get a Scheduled alert rule.": { + "$ref": "./examples/alertRules/GetScheduledAlertRule.json" + }, + "Get a Fusion alert rule.": { + "$ref": "./examples/alertRules/GetFusionAlertRule.json" + }, + "Get a MicrosoftSecurityIncidentCreation rule.": { + "$ref": "./examples/alertRules/GetMicrosoftSecurityIncidentCreationAlertRule.json" + } + }, + "tags": [ + "Alert Rules" + ], + "description": "Gets the alert rule.", + "operationId": "AlertRules_Get", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/AlertRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a Scheduled alert rule.": { + "$ref": "./examples/alertRules/CreateScheduledAlertRule.json" + }, + "Creates or updates a Fusion alert rule.": { + "$ref": "./examples/alertRules/CreateFusionAlertRule.json" + }, + "Creates or updates a MicrosoftSecurityIncidentCreation rule.": { + "$ref": "./examples/alertRules/CreateMicrosoftSecurityIncidentCreationAlertRule.json" + } + }, + "tags": [ + "Alert Rules" + ], + "description": "Creates or updates the alert rule.", + "operationId": "AlertRules_CreateOrUpdate", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + }, + { + "$ref": "#/parameters/AlertRule" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/AlertRule" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/AlertRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete an alert rule.": { + "$ref": "./examples/alertRules/DeleteAlertRule.json" + } + }, + "tags": [ + "Alert Rules" + ], + "description": "Delete the alert rule.", + "operationId": "AlertRules_Delete", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}/actions": { + "get": { + "x-ms-examples": { + "Get all actions of alert rule.": { + "$ref": "./examples/actions/GetAllActionsByAlertRule.json" + } + }, + "tags": [ + "Actions" + ], + "description": "Gets all actions of alert rule.", + "operationId": "Actions_ListByAlertRule", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/ActionsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}/actions/{actionId}": { + "get": { + "x-ms-examples": { + "Get an action of alert rule.": { + "$ref": "./examples/actions/GetActionOfAlertRuleById.json" + } + }, + "tags": [ + "Actions" + ], + "description": "Gets the action of alert rule.", + "operationId": "Actions_Get", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + }, + { + "$ref": "#/parameters/ActionId" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/ActionResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates an action of alert rule.": { + "$ref": "./examples/actions/CreateActionOfAlertRule.json" + } + }, + "tags": [ + "Actions" + ], + "description": "Creates or updates the action of alert rule.", + "operationId": "Actions_CreateOrUpdate", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + }, + { + "$ref": "#/parameters/ActionId" + }, + { + "$ref": "#/parameters/Action" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/ActionResponse" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ActionResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete an action of alert rule.": { + "$ref": "./examples/actions/DeleteActionOfAlertRule.json" + } + }, + "tags": [ + "Actions" + ], + "description": "Delete the action of alert rule.", + "operationId": "Actions_Delete", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + }, + { + "$ref": "#/parameters/ActionId" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRuleTemplates": { + "get": { + "x-ms-examples": { + "Get all alert rule templates.": { + "$ref": "./examples/alertRuleTemplates/GetAlertRuleTemplates.json" + } + }, + "tags": [ + "Alert Rule Templates" + ], + "description": "Gets all alert rule templates.", + "operationId": "AlertRuleTemplates_List", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/AlertRuleTemplatesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRuleTemplates/{alertRuleTemplateId}": { + "get": { + "x-ms-examples": { + "Get alert rule template by Id.": { + "$ref": "./examples/alertRuleTemplates/GetAlertRuleTemplateById.json" + } + }, + "tags": [ + "Alert Rule Templates" + ], + "description": "Gets the alert rule template.", + "operationId": "AlertRuleTemplates_Get", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/AlertRuleTemplateId" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/AlertRuleTemplate" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "ActionsList": { + "description": "List all the actions.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of actions.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of actions.", + "items": { + "$ref": "#/definitions/ActionResponse" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "ActionRequest": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/ResourceWithEtag" + } + ], + "description": "Action for alert rule.", + "properties": { + "properties": { + "$ref": "#/definitions/ActionRequestProperties", + "description": "Action properties for put request", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "ActionRequestProperties": { + "allOf": [ + { + "$ref": "#/definitions/ActionPropertiesBase" + } + ], + "description": "Action property bag.", + "properties": { + "triggerUri": { + "description": "Logic App Callback URL for this specific workflow.", + "type": "string" + } + }, + "required": [ + "triggerUri" + ], + "type": "object" + }, + "ActionResponse": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/Resource" + } + ], + "description": "Action for alert rule.", + "properties": { + "etag": { + "description": "Etag of the action.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/ActionResponseProperties", + "description": "Action properties for get request", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "ActionResponseProperties": { + "allOf": [ + { + "$ref": "#/definitions/ActionPropertiesBase" + } + ], + "description": "Action property bag.", + "properties": { + "workflowId": { + "description": "The name of the logic app's workflow.", + "type": "string" + } + }, + "type": "object" + }, + "ActionPropertiesBase": { + "description": "Action property bag base.", + "properties": { + "logicAppResourceId": { + "description": "Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}.", + "type": "string" + } + }, + "required": [ + "logicAppResourceId" + ], + "type": "object" + }, + "AlertRule": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/ResourceWithEtag" + } + ], + "description": "Alert rule.", + "discriminator": "kind", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/AlertRuleKind", + "description": "The alert rule kind" + } + }, + "type": "object" + }, + "AlertRuleKind": { + "description": "The kind of the alert rule", + "enum": [ + "Scheduled", + "MicrosoftSecurityIncidentCreation", + "Fusion" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AlertRuleKind", + "values": [ + { + "value": "Scheduled" + }, + { + "value": "MicrosoftSecurityIncidentCreation" + }, + { + "value": "Fusion" + } + ] + } + }, + "AlertRuleTemplate": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/Resource" + } + ], + "description": "Alert rule template.", + "discriminator": "kind", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/AlertRuleKind", + "description": "The alert rule kind", + "type": "string" + } + }, + "type": "object" + }, + "AlertRuleTemplateDataSource": { + "description": "alert rule template data sources", + "properties": { + "connectorId": { + "description": "The connector id that provides the following data types", + "type": "string" + }, + "dataTypes": { + "description": "The data types used by the alert rule template", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AlertRuleTemplateStatus": { + "description": "The alert rule template status.", + "enum": [ + "Installed", + "Available", + "NotAvailable" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "TemplateStatus", + "values": [ + { + "description": "Alert rule template installed. and can not use more then once", + "value": "Installed" + }, + { + "description": "Alert rule template is available.", + "value": "Available" + }, + { + "description": "Alert rule template is not available", + "value": "NotAvailable" + } + ] + } + }, + "AlertRuleTriggerOperator": { + "description": "The operation against the threshold that triggers alert rule.", + "enum": [ + "GreaterThan", + "LessThan", + "Equal", + "NotEqual" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": false, + "name": "TriggerOperator" + } + }, + "AlertRulesList": { + "description": "List all the alert rules.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of alert rules.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of alert rules.", + "items": { + "$ref": "#/definitions/AlertRule" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "AlertRuleTemplatesList": { + "description": "List all the alert rule templates.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of alert rule templates.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of alert rule templates.", + "items": { + "$ref": "#/definitions/AlertRuleTemplate" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "AlertSeverity": { + "description": "The severity of the alert", + "enum": [ + "High", + "Medium", + "Low", + "Informational" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AlertSeverity", + "values": [ + { + "description": "High severity", + "value": "High" + }, + { + "description": "Medium severity", + "value": "Medium" + }, + { + "description": "Low severity", + "value": "Low" + }, + { + "description": "Informational severity", + "value": "Informational" + } + ] + } + }, + "AttackTactic": { + "description": "The severity for alerts created by this alert rule.", + "enum": [ + "InitialAccess", + "Execution", + "Persistence", + "PrivilegeEscalation", + "DefenseEvasion", + "CredentialAccess", + "Discovery", + "LateralMovement", + "Collection", + "Exfiltration", + "CommandAndControl", + "Impact" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AttackTactic" + } + }, + "FusionAlertRule": { + "allOf": [ + { + "$ref": "#/definitions/AlertRule" + } + ], + "description": "Represents Fusion alert rule.", + "properties": { + "properties": { + "$ref": "#/definitions/FusionAlertRuleProperties", + "description": "Fusion alert rule properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Fusion" + }, + "FusionAlertRuleProperties": { + "description": "Fusion alert rule base property bag.", + "properties": { + "alertRuleTemplateName": { + "description": "The Name of the alert rule template used to create this rule.", + "type": "string" + }, + "description": { + "description": "The description of the alert rule.", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "The display name for alerts created by this alert rule.", + "readOnly": true, + "type": "string" + }, + "enabled": { + "description": "Determines whether this alert rule is enabled or disabled.", + "type": "boolean" + }, + "lastModifiedUtc": { + "description": "The last time that this alert has been modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "severity": { + "$ref": "#/definitions/AlertSeverity", + "description": "The severity for alerts created by this alert rule.", + "readOnly": true + }, + "tactics": { + "description": "The tactics of the alert rule", + "items": { + "$ref": "#/definitions/AttackTactic" + }, + "readOnly": true, + "type": "array" + } + }, + "required": [ + "alertRuleTemplateName", + "enabled" + ], + "type": "object" + }, + "FusionAlertRuleTemplate": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplate" + } + ], + "description": "Represents Fusion alert rule template.", + "properties": { + "properties": { + "$ref": "#/definitions/FusionAlertRuleTemplateProperties", + "description": "Fusion alert rule template properties", + "required": [ + "displayName", + "description", + "status", + "severity", + "alertRulesCreatedByTemplateCount" + ], + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Fusion" + }, + "FusionAlertRuleTemplateProperties": { + "description": "Represents Fusion alert rule template properties", + "properties": { + "alertRulesCreatedByTemplateCount": { + "description": "the number of alert rules that were created by this template", + "format": "int32", + "type": "integer" + }, + "createdDateUTC": { + "description": "The time that this alert rule template has been added.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "The description of the alert rule template.", + "type": "string" + }, + "displayName": { + "description": "The display name for alert rule template.", + "type": "string" + }, + "requiredDataConnectors": { + "description": "The required data connectors for this template", + "items": { + "$ref": "#/definitions/AlertRuleTemplateDataSource" + }, + "type": "array" + }, + "status": { + "$ref": "#/definitions/AlertRuleTemplateStatus", + "description": "The alert rule template status.", + "type": "string" + }, + "severity": { + "$ref": "#/definitions/AlertSeverity", + "description": "The severity for alerts created by this alert rule." + }, + "tactics": { + "description": "The tactics of the alert rule template", + "items": { + "$ref": "#/definitions/AttackTactic" + }, + "type": "array" + } + }, + "type": "object" + }, + "MicrosoftSecurityIncidentCreationAlertRule": { + "allOf": [ + { + "$ref": "#/definitions/AlertRule" + } + ], + "description": "Represents MicrosoftSecurityIncidentCreation rule.", + "properties": { + "properties": { + "$ref": "#/definitions/MicrosoftSecurityIncidentCreationAlertRuleProperties", + "description": "MicrosoftSecurityIncidentCreation rule properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftSecurityIncidentCreation" + }, + "MicrosoftSecurityIncidentCreationAlertRuleCommonProperties": { + "description": "MicrosoftSecurityIncidentCreation rule common property bag.", + "properties": { + "displayNamesFilter": { + "description": "the alerts' displayNames on which the cases will be generated", + "items": { + "type": "string" + }, + "type": "array" + }, + "displayNamesExcludeFilter": { + "description": "the alerts' displayNames on which the cases will not be generated", + "items": { + "type": "string" + }, + "type": "array" + }, + "productFilter": { + "$ref": "#/definitions/MicrosoftSecurityProductName", + "description": "The alerts' productName on which the cases will be generated" + }, + "severitiesFilter": { + "description": "the alerts' severities on which the cases will be generated", + "items": { + "$ref": "#/definitions/AlertSeverity" + }, + "type": "array" + } + }, + "required": [ + "productFilter" + ], + "type": "object" + }, + "MicrosoftSecurityIncidentCreationAlertRuleProperties": { + "allOf": [ + { + "$ref": "#/definitions/MicrosoftSecurityIncidentCreationAlertRuleCommonProperties" + } + ], + "description": "MicrosoftSecurityIncidentCreation rule property bag.", + "properties": { + "alertRuleTemplateName": { + "description": "The Name of the alert rule template used to create this rule.", + "type": "string" + }, + "description": { + "description": "The description of the alert rule.", + "type": "string" + }, + "displayName": { + "description": "The display name for alerts created by this alert rule.", + "type": "string" + }, + "enabled": { + "description": "Determines whether this alert rule is enabled or disabled.", + "type": "boolean" + }, + "lastModifiedUtc": { + "description": "The last time that this alert has been modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "displayName", + "enabled", + "productFilter" + ], + "type": "object" + }, + "MicrosoftSecurityIncidentCreationAlertRuleTemplate": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplate" + } + ], + "description": "Represents MicrosoftSecurityIncidentCreation rule template.", + "properties": { + "properties": { + "$ref": "#/definitions/MicrosoftSecurityIncidentCreationAlertRuleTemplateProperties", + "description": "MicrosoftSecurityIncidentCreation rule template properties", + "required": [ + "displayName", + "description", + "createdDateUTC", + "status", + "alertRulesCreatedByTemplateCount", + "productFilter" + ], + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftSecurityIncidentCreation" + }, + "MicrosoftSecurityIncidentCreationAlertRuleTemplateProperties": { + "description": "MicrosoftSecurityIncidentCreation rule template properties", + "properties": { + "alertRulesCreatedByTemplateCount": { + "description": "the number of alert rules that were created by this template", + "format": "int32", + "type": "integer" + }, + "createdDateUTC": { + "description": "The time that this alert rule template has been added.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "The description of the alert rule template.", + "type": "string" + }, + "displayName": { + "description": "The display name for alert rule template.", + "type": "string" + }, + "requiredDataConnectors": { + "description": "The required data connectors for this template", + "items": { + "$ref": "#/definitions/AlertRuleTemplateDataSource" + }, + "type": "array" + }, + "status": { + "$ref": "#/definitions/AlertRuleTemplateStatus", + "description": "The alert rule template status.", + "type": "string" + }, + "displayNamesFilter": { + "description": "the alerts' displayNames on which the cases will be generated", + "items": { + "type": "string" + }, + "type": "array" + }, + "displayNamesExcludeFilter": { + "description": "the alerts' displayNames on which the cases will not be generated", + "items": { + "type": "string" + }, + "type": "array" + }, + "productFilter": { + "$ref": "#/definitions/MicrosoftSecurityProductName", + "description": "The alerts' productName on which the cases will be generated" + }, + "severitiesFilter": { + "description": "the alerts' severities on which the cases will be generated", + "items": { + "$ref": "#/definitions/AlertSeverity" + }, + "type": "array" + } + }, + "required": [ + "productFilter" + ], + "type": "object" + }, + "MicrosoftSecurityProductName": { + "description": "The alerts' productName on which the cases will be generated", + "enum": [ + "Microsoft Cloud App Security", + "Azure Security Center", + "Azure Advanced Threat Protection", + "Azure Active Directory Identity Protection", + "Azure Security Center for IoT" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "MicrosoftSecurityProductName" + } + }, + "ScheduledAlertRule": { + "allOf": [ + { + "$ref": "#/definitions/AlertRule" + } + ], + "description": "Represents scheduled alert rule.", + "properties": { + "properties": { + "$ref": "#/definitions/ScheduledAlertRuleProperties", + "description": "Scheduled alert rule properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Scheduled" + }, + "ScheduledAlertRuleCommonProperties": { + "description": "Schedule alert rule template property bag.", + "properties": { + "query": { + "description": "The query that creates alerts for this rule.", + "type": "string" + }, + "queryFrequency": { + "description": "The frequency (in ISO 8601 duration format) for this alert rule to run.", + "format": "duration", + "type": "string" + }, + "queryPeriod": { + "description": "The period (in ISO 8601 duration format) that this alert rule looks at.", + "format": "duration", + "type": "string" + }, + "severity": { + "$ref": "#/definitions/AlertSeverity", + "description": "The severity for alerts created by this alert rule." + }, + "triggerOperator": { + "$ref": "#/definitions/AlertRuleTriggerOperator", + "description": "The operation against the threshold that triggers alert rule." + }, + "triggerThreshold": { + "description": "The threshold triggers this alert rule.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ScheduledAlertRuleProperties": { + "allOf": [ + { + "$ref": "#/definitions/ScheduledAlertRuleCommonProperties" + } + ], + "description": "Scheduled alert rule base property bag.", + "properties": { + "alertRuleTemplateName": { + "description": "The Name of the alert rule template used to create this rule.", + "type": "string" + }, + "description": { + "description": "The description of the alert rule.", + "type": "string" + }, + "displayName": { + "description": "The display name for alerts created by this alert rule.", + "type": "string" + }, + "enabled": { + "description": "Determines whether this alert rule is enabled or disabled.", + "type": "boolean" + }, + "lastModifiedUtc": { + "description": "The last time that this alert rule has been modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "suppressionDuration": { + "description": "The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered.", + "format": "duration", + "type": "string" + }, + "suppressionEnabled": { + "description": "Determines whether the suppression for this alert rule is enabled or disabled.", + "type": "boolean" + }, + "tactics": { + "description": "The tactics of the alert rule", + "items": { + "$ref": "#/definitions/AttackTactic" + }, + "type": "array" + } + }, + "required": [ + "displayName", + "enabled", + "severity", + "query", + "queryFrequency", + "queryPeriod", + "triggerOperator", + "triggerThreshold", + "suppressionEnabled", + "suppressionDuration" + ], + "type": "object" + }, + "ScheduledAlertRuleTemplateProperties": { + "description": "Scheduled alert rule template properties", + "properties": { + "alertRulesCreatedByTemplateCount": { + "description": "the number of alert rules that were created by this template", + "format": "int32", + "type": "integer" + }, + "createdDateUTC": { + "description": "The time that this alert rule template has been added.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "The description of the alert rule template.", + "type": "string" + }, + "displayName": { + "description": "The display name for alert rule template.", + "type": "string" + }, + "requiredDataConnectors": { + "description": "The required data connectors for this template", + "items": { + "$ref": "#/definitions/AlertRuleTemplateDataSource" + }, + "type": "array" + }, + "status": { + "$ref": "#/definitions/AlertRuleTemplateStatus", + "description": "The alert rule template status.", + "type": "string" + }, + "query": { + "description": "The query that creates alerts for this rule.", + "type": "string" + }, + "queryFrequency": { + "description": "The frequency (in ISO 8601 duration format) for this alert rule to run.", + "format": "duration", + "type": "string" + }, + "queryPeriod": { + "description": "The period (in ISO 8601 duration format) that this alert rule looks at.", + "format": "duration", + "type": "string" + }, + "severity": { + "$ref": "#/definitions/AlertSeverity", + "description": "The severity for alerts created by this alert rule." + }, + "triggerOperator": { + "$ref": "#/definitions/AlertRuleTriggerOperator", + "description": "The operation against the threshold that triggers alert rule." + }, + "triggerThreshold": { + "description": "The threshold triggers this alert rule.", + "format": "int32", + "type": "integer" + }, + "tactics": { + "description": "The tactics of the alert rule template", + "items": { + "$ref": "#/definitions/AttackTactic" + }, + "type": "array" + } + }, + "type": "object" + }, + "ScheduledAlertRuleTemplate": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplate" + } + ], + "description": "Represents scheduled alert rule template.", + "properties": { + "properties": { + "$ref": "#/definitions/ScheduledAlertRuleTemplateProperties", + "description": "Scheduled alert rule template properties", + "required": [ + "displayName", + "description", + "status", + "alertRulesCreatedByTemplateCount", + "severity", + "query", + "queryFrequency", + "queryPeriod", + "triggerOperator", + "triggerThreshold" + ], + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Scheduled" + } + }, + "parameters": { + "Action": { + "description": "The action", + "in": "body", + "name": "action", + "required": true, + "schema": { + "$ref": "#/definitions/ActionRequest" + }, + "x-ms-parameter-location": "method" + }, + "ActionId": { + "description": "Action ID", + "in": "path", + "name": "actionId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "AlertRule": { + "description": "The alert rule", + "in": "body", + "name": "alertRule", + "required": true, + "schema": { + "$ref": "#/definitions/AlertRule" + }, + "x-ms-parameter-location": "method" + }, + "AlertRuleTemplateId": { + "description": "Alert rule template ID", + "in": "path", + "name": "alertRuleTemplateId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "RuleId": { + "description": "Alert rule ID", + "in": "path", + "name": "ruleId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/Bookmarks.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/Bookmarks.json new file mode 100644 index 000000000000..a3581ff591da --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/Bookmarks.json @@ -0,0 +1,439 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2020-01-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.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks": { + "get": { + "x-ms-examples": { + "Get all bookmarks.": { + "$ref": "./examples/bookmarks/GetBookmarks.json" + } + }, + "tags": [ + "Bookmarks" + ], + "description": "Gets all bookmarks.", + "operationId": "Bookmarks_List", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/BookmarkList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}": { + "get": { + "x-ms-examples": { + "Get a bookmark.": { + "$ref": "./examples/bookmarks/GetBookmarkById.json" + } + }, + "tags": [ + "Bookmarks" + ], + "description": "Gets a bookmark.", + "operationId": "Bookmarks_Get", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BookmarkId" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/Bookmark" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a bookmark.": { + "$ref": "./examples/bookmarks/CreateBookmark.json" + } + }, + "tags": [ + "Bookmarks" + ], + "description": "Creates or updates the bookmark.", + "operationId": "Bookmarks_CreateOrUpdate", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BookmarkId" + }, + { + "$ref": "#/parameters/Bookmark" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/Bookmark" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Bookmark" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a bookmark.": { + "$ref": "./examples/bookmarks/DeleteBookmark.json" + } + }, + "tags": [ + "Bookmarks" + ], + "description": "Delete the bookmark.", + "operationId": "Bookmarks_Delete", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BookmarkId" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "Bookmark": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents a bookmark in Azure Security Insights.", + "properties": { + "properties": { + "$ref": "#/definitions/BookmarkProperties", + "description": "Bookmark properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "BookmarkList": { + "description": "List all the bookmarks.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of cases.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of bookmarks.", + "items": { + "$ref": "#/definitions/Bookmark" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "BookmarkProperties": { + "description": "Describes bookmark properties", + "properties": { + "created": { + "description": "The time the bookmark was created", + "format": "date-time", + "type": "string" + }, + "createdBy": { + "$ref": "#/definitions/UserInfo", + "description": "Describes a user that created the bookmark", + "type": "object" + }, + "displayName": { + "description": "The display name of the bookmark", + "type": "string" + }, + "labels": { + "description": "List of labels relevant to this bookmark", + "items": { + "$ref": "#/definitions/Label" + }, + "type": "array" + }, + "notes": { + "description": "The notes of the bookmark", + "type": "string" + }, + "query": { + "description": "The query of the bookmark.", + "type": "string" + }, + "queryResult": { + "description": "The query result of the bookmark.", + "type": "string" + }, + "updated": { + "description": "The last time the bookmark was updated", + "format": "date-time", + "type": "string" + }, + "updatedBy": { + "$ref": "#/definitions/UserInfo", + "description": "Describes a user that updated the bookmark", + "type": "object" + }, + "eventTime": { + "description": "The bookmark event time", + "format": "date-time", + "type": "string" + }, + "queryStartTime": { + "description": "The start time for the query", + "format": "date-time", + "type": "string" + }, + "queryEndTime": { + "description": "The end time for the query", + "format": "date-time", + "type": "string" + }, + "incidentInfo": { + "$ref": "#/definitions/IncidentInfo", + "description": "Describes an incident that relates to bookmark", + "type": "object" + } + }, + "required": [ + "displayName", + "query" + ], + "type": "object" + }, + "IncidentInfo": { + "description": "Describes related incident information for the bookmark", + "properties": { + "incidentId": { + "description": "Incident Id", + "type": "string" + }, + "severity": { + "description": "The severity of the incident", + "enum": [ + "Critical", + "High", + "Medium", + "Low", + "Informational" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "CaseSeverity", + "values": [ + { + "description": "Critical severity", + "value": "Critical" + }, + { + "description": "High severity", + "value": "High" + }, + { + "description": "Medium severity", + "value": "Medium" + }, + { + "description": "Low severity", + "value": "Low" + }, + { + "description": "Informational severity", + "value": "Informational" + } + ] + } + }, + "title": { + "description": "The title of the incident", + "type": "string" + }, + "relationName": { + "description": "Relation Name", + "type": "string" + } + }, + "type": "object" + }, + "Label": { + "description": "Label that will be used to tag and filter on.", + "type": "string" + }, + "UserInfo": { + "description": "User information that made some action", + "properties": { + "email": { + "description": "The email of the user.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the user.", + "readOnly": true, + "type": "string" + }, + "objectId": { + "description": "The object id of the user.", + "format": "uuid", + "type": "string", + "x-nullable": true + } + }, + "required": [ + "objectId" + ], + "type": "object" + } + }, + "parameters": { + "Bookmark": { + "description": "The bookmark", + "in": "body", + "name": "bookmark", + "required": true, + "schema": { + "$ref": "#/definitions/Bookmark" + }, + "x-ms-parameter-location": "method" + }, + "BookmarkId": { + "description": "Bookmark ID", + "in": "path", + "name": "bookmarkId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/DataConnectors.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/DataConnectors.json new file mode 100644 index 000000000000..4bfbc702611d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/DataConnectors.json @@ -0,0 +1,739 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2020-01-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.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors": { + "get": { + "x-ms-examples": { + "Get all data connectors.": { + "$ref": "./examples/dataConnectors/GetDataConnectors.json" + } + }, + "tags": [ + "Data Connectors" + ], + "description": "Gets all data connectors.", + "operationId": "DataConnectors_List", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/DataConnectorList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors/{dataConnectorId}": { + "get": { + "x-ms-examples": { + "Get an Office365 data connector.": { + "$ref": "./examples/dataConnectors/GetOfficeDataConnetorById.json" + }, + "Get a TI data connector.": { + "$ref": "./examples/dataConnectors/GetThreatIntelligenceById.json" + }, + "Get a MCAS data connector.": { + "$ref": "./examples/dataConnectors/GetMicrosoftCloudAppSecurityById.json" + }, + "Get a ASC data connector.": { + "$ref": "./examples/dataConnectors/GetAzureSecurityCenterById.json" + }, + "Get an AAD data connector.": { + "$ref": "./examples/dataConnectors/GetAzureActiveDirectoryById.json" + }, + "Get an AwsCloudTrail data connector.": { + "$ref": "./examples/dataConnectors/GetAmazonWebServicesCloudTrailById.json" + }, + "Get an AATP data connector.": { + "$ref": "./examples/dataConnectors/GetAzureAdvancedThreatProtectionById.json" + }, + "Get a MDATP data connector": { + "$ref": "./examples/dataConnectors/GetMicrosoftDefenderAdvancedThreatProtectionById.json" + } + }, + "tags": [ + "Data Connectors" + ], + "description": "Gets a data connector.", + "operationId": "DataConnectors_Get", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/DataConnectorId" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/DataConnector" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates an Office365 data connector.": { + "$ref": "./examples/dataConnectors/CreateOfficeDataConnetor.json" + }, + "Creates or updates an Threat Intelligence Platform data connector.": { + "$ref": "./examples/dataConnectors/CreateThreatIntelligenceDataConnector.json" + } + }, + "tags": [ + "Data Connectors" + ], + "description": "Creates or updates the data connector.", + "operationId": "DataConnectors_CreateOrUpdate", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/DataConnectorId" + }, + { + "$ref": "#/parameters/DataConnector" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/DataConnector" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DataConnector" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete an Office365 data connector.": { + "$ref": "./examples/dataConnectors/DeleteOfficeDataConnetor.json" + } + }, + "tags": [ + "Data Connectors" + ], + "description": "Delete the data connector.", + "operationId": "DataConnectors_Delete", + "parameters": [ + { + "$ref": "SecurityInsights.json#/parameters/ApiVersion" + }, + { + "$ref": "SecurityInsights.json#/parameters/SubscriptionId" + }, + { + "$ref": "SecurityInsights.json#/parameters/ResourceGroupName" + }, + { + "$ref": "SecurityInsights.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/DataConnectorId" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "SecurityInsights.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "AADDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents AAD (Azure Active Directory) data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/AADDataConnectorProperties", + "description": "AAD (Azure Active Directory) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AzureActiveDirectory" + }, + "AADDataConnectorProperties": { + "description": "AAD (Azure Active Directory) data connector properties.", + "properties": { + "tenantId": { + "description": "The tenant id to connect to, and get the data from.", + "type": "string" + }, + "dataTypes": { + "$ref": "#/definitions/AlertsDataTypeOfDataConnector", + "description": "The available data types for the connector." + } + }, + "type": "object" + }, + "AATPDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents AATP (Azure Advanced Threat Protection) data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/AATPDataConnectorProperties", + "description": "AATP (Azure Advanced Threat Protection) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AzureAdvancedThreatProtection" + }, + "AATPDataConnectorProperties": { + "description": "AATP (Azure Advanced Threat Protection) data connector properties.", + "properties": { + "tenantId": { + "description": "The tenant id to connect to, and get the data from.", + "type": "string" + }, + "dataTypes": { + "$ref": "#/definitions/AlertsDataTypeOfDataConnector", + "description": "The available data types for the connector." + } + }, + "type": "object" + }, + "ASCDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents ASC (Azure Security Center) data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/ASCDataConnectorProperties", + "description": "ASC (Azure Security Center) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AzureSecurityCenter" + }, + "ASCDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorWithAlertsProperties" + } + ], + "description": "ASC (Azure Security Center) data connector properties.", + "properties": { + "subscriptionId": { + "description": "The subscription id to connect to, and get the data from.", + "type": "string" + } + }, + "type": "object" + }, + "AlertsDataTypeOfDataConnector": { + "description": "Alerts data type for data connectors.", + "properties": { + "alerts": { + "$ref": "#/definitions/DataConnectorDataTypeCommon", + "description": "Alerts data type connection.", + "type": "object" + } + }, + "type": "object" + }, + "AwsCloudTrailDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents Amazon Web Services CloudTrail data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/AwsCloudTrailDataConnectorProperties", + "description": "Amazon Web Services CloudTrail data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AmazonWebServicesCloudTrail" + }, + "AwsCloudTrailDataConnectorDataTypes": { + "description": "The available data types for Amazon Web Services CloudTrail data connector.", + "properties": { + "logs": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Logs data type.", + "type": "object" + } + }, + "type": "object" + }, + "AwsCloudTrailDataConnectorProperties": { + "description": "Amazon Web Services CloudTrail data connector properties.", + "properties": { + "awsRoleArn": { + "description": "The Aws Role Arn (with CloudTrailReadOnly policy) that is used to access the Aws account.", + "type": "string" + }, + "dataTypes": { + "$ref": "#/definitions/AwsCloudTrailDataConnectorDataTypes", + "description": "The available data types for the connector." + } + }, + "type": "object" + }, + "DataConnector": { + "allOf": [ + { + "$ref": "SecurityInsights.json#/definitions/ResourceWithEtag" + } + ], + "description": "Data connector.", + "discriminator": "kind", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/DataConnectorKind", + "description": "The data connector kind" + } + }, + "type": "object" + }, + "DataConnectorKind": { + "description": "The kind of the data connector", + "enum": [ + "AzureActiveDirectory", + "AzureSecurityCenter", + "MicrosoftCloudAppSecurity", + "ThreatIntelligence", + "Office365", + "AmazonWebServicesCloudTrail", + "AzureAdvancedThreatProtection", + "MicrosoftDefenderAdvancedThreatProtection" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DataConnectorKind", + "values": [ + { + "value": "AzureActiveDirectory" + }, + { + "value": "AzureSecurityCenter" + }, + { + "value": "MicrosoftCloudAppSecurity" + }, + { + "value": "ThreatIntelligence" + }, + { + "value": "Office365" + }, + { + "value": "AmazonWebServicesCloudTrail" + }, + { + "value": "AzureAdvancedThreatProtection" + }, + { + "value": "MicrosoftDefenderAdvancedThreatProtection" + } + ] + } + }, + "DataConnectorList": { + "description": "List all the data connectors.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of data connectors.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of data connectors.", + "items": { + "$ref": "#/definitions/DataConnector" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "DataConnectorDataTypeCommon": { + "description": "Common field for data type in data connectors.", + "properties": { + "state": { + "description": "Describe whether this data type connection is enabled or not.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DataTypeState" + } + } + }, + "type": "object" + }, + "DataConnectorTenantId": { + "description": "Properties data connector on tenant level.", + "properties": { + "tenantId": { + "description": "The tenant id to connect to, and get the data from.", + "type": "string" + } + }, + "type": "object" + }, + "DataConnectorWithAlertsProperties": { + "description": "Data connector properties.", + "properties": { + "dataTypes": { + "$ref": "#/definitions/AlertsDataTypeOfDataConnector", + "description": "The available data types for the connector." + } + }, + "type": "object" + }, + "MCASDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents MCAS (Microsoft Cloud App Security) data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/MCASDataConnectorProperties", + "description": "MCAS (Microsoft Cloud App Security) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftCloudAppSecurity" + }, + "MCASDataConnectorDataTypes": { + "allOf": [ + { + "$ref": "#/definitions/AlertsDataTypeOfDataConnector" + } + ], + "description": "The available data types for MCAS (Microsoft Cloud App Security) data connector.", + "properties": { + "alerts": { + "$ref": "#/definitions/DataConnectorDataTypeCommon", + "description": "Alerts data type connection." + }, + "discoveryLogs": { + "$ref": "#/definitions/DataConnectorDataTypeCommon", + "description": "Discovery log data type connection." + } + }, + "type": "object" + }, + "MCASDataConnectorProperties": { + "description": "MCAS (Microsoft Cloud App Security) data connector properties.", + "properties": { + "tenantId": { + "description": "The tenant id to connect to, and get the data from.", + "type": "string" + }, + "dataTypes": { + "$ref": "#/definitions/MCASDataConnectorDataTypes", + "description": "The available data types for the connector." + } + }, + "type": "object" + }, + "MDATPDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents MDATP (Microsoft Defender Advanced Threat Protection) data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/MDATPDataConnectorProperties", + "description": "MDATP (Microsoft Defender Advanced Threat Protection) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftDefenderAdvancedThreatProtection" + }, + "MDATPDataConnectorProperties": { + "description": "MDATP (Microsoft Defender Advanced Threat Protection) data connector properties.", + "properties": { + "tenantId": { + "description": "The tenant id to connect to, and get the data from.", + "type": "string" + }, + "dataTypes": { + "$ref": "#/definitions/AlertsDataTypeOfDataConnector", + "description": "The available data types for the connector." + } + }, + "type": "object" + }, + "TIDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents threat intelligence data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/TIDataConnectorProperties", + "description": "TI (Threat Intelligence) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "ThreatIntelligence" + }, + "TIDataConnectorDataTypes": { + "description": "The available data types for TI (Threat Intelligence) data connector.", + "properties": { + "indicators": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Data type for indicators connection.", + "type": "object" + } + }, + "type": "object" + }, + "TIDataConnectorProperties": { + "description": "TI (Threat Intelligence) data connector properties.", + "properties": { + "tenantId": { + "description": "The tenant id to connect to, and get the data from.", + "type": "string" + }, + "tipLookbackPeriod": { + "description": "The lookback period for the feed to be imported.", + "format": "date-time", + "type": "string", + "x-nullable": true + }, + "dataTypes": { + "$ref": "#/definitions/TIDataConnectorDataTypes", + "description": "The available data types for the connector." + } + }, + "type": "object" + }, + "OfficeDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents office data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/OfficeDataConnectorProperties", + "description": "Office data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Office365" + }, + "OfficeDataConnectorDataTypes": { + "description": "The available data types for office data connector.", + "properties": { + "exchange": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Exchange data type connection.", + "type": "object" + }, + "sharePoint": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "SharePoint data type connection.", + "type": "object" + }, + "teams": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Teams data type connection.", + "type": "object" + } + }, + "type": "object" + }, + "OfficeDataConnectorProperties": { + "description": "Office data connector properties.", + "properties": { + "tenantId": { + "description": "The tenant id to connect to, and get the data from.", + "type": "string" + }, + "dataTypes": { + "$ref": "#/definitions/OfficeDataConnectorDataTypes", + "description": "The available data types for the connector." + } + }, + "type": "object" + } + }, + "parameters": { + "DataConnector": { + "description": "The data connector", + "in": "body", + "name": "dataConnector", + "required": true, + "schema": { + "$ref": "#/definitions/DataConnector" + }, + "x-ms-parameter-location": "method" + }, + "DataConnectorId": { + "description": "Connector ID", + "in": "path", + "name": "dataConnectorId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json index 9285c576a626..1bb0b3dff3b2 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json @@ -65,18 +65,18 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents": { "get": { "x-ms-examples": { - "Get all alert rules.": { - "$ref": "./examples/alertRules/GetAllAlertRules.json" + "Get all incidents.": { + "$ref": "./examples/incidents/GetIncidents.json" } }, "tags": [ - "Alert Rules" + "Incidents" ], - "description": "Gets all alert rules.", - "operationId": "AlertRules_List", + "description": "Gets all incidents.", + "operationId": "Incidents_List", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -89,13 +89,25 @@ }, { "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ODataFilter" + }, + { + "$ref": "#/parameters/ODataOrderBy" + }, + { + "$ref": "#/parameters/ODataTop" + }, + { + "$ref": "#/parameters/ODataSkipToken" } ], "responses": { "200": { "description": "OK, Operation successfully completed", "schema": { - "$ref": "#/definitions/AlertRulesList" + "$ref": "#/definitions/IncidentList" } }, "default": { @@ -110,24 +122,18 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}": { "get": { "x-ms-examples": { - "Get a Scheduled alert rule.": { - "$ref": "./examples/alertRules/GetScheduledAlertRule.json" - }, - "Get a Fusion alert rule.": { - "$ref": "./examples/alertRules/GetFusionAlertRule.json" - }, - "Get a MicrosoftSecurityIncidentCreation rule.": { - "$ref": "./examples/alertRules/GetMicrosoftSecurityIncidentCreationAlertRule.json" + "Get an incident.": { + "$ref": "./examples/incidents/GetIncidentById.json" } }, "tags": [ - "Alert Rules" + "Incidents" ], - "description": "Gets the alert rule.", - "operationId": "AlertRules_Get", + "description": "Gets an incident.", + "operationId": "Incidents_Get", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -142,14 +148,14 @@ "$ref": "#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/RuleId" + "$ref": "#/parameters/IncidentId" } ], "responses": { "200": { "description": "OK, Operation successfully completed", "schema": { - "$ref": "#/definitions/AlertRule" + "$ref": "#/definitions/Incident" } }, "default": { @@ -162,21 +168,15 @@ }, "put": { "x-ms-examples": { - "Creates or updates a Scheduled alert rule.": { - "$ref": "./examples/alertRules/CreateScheduledAlertRule.json" - }, - "Creates or updates a Fusion alert rule.": { - "$ref": "./examples/alertRules/CreateFusionAlertRule.json" - }, - "Creates or updates a MicrosoftSecurityIncidentCreation rule.": { - "$ref": "./examples/alertRules/CreateMicrosoftSecurityIncidentCreationAlertRule.json" + "Creates or updates an incident.": { + "$ref": "./examples/incidents/CreateIncident.json" } }, "tags": [ - "Alert Rules" + "Incidents" ], - "description": "Creates or updates the alert rule.", - "operationId": "AlertRules_CreateOrUpdate", + "description": "Creates or updates the incident.", + "operationId": "Incidents_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -191,23 +191,23 @@ "$ref": "#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/RuleId" + "$ref": "#/parameters/IncidentId" }, { - "$ref": "#/parameters/AlertRule" + "$ref": "#/parameters/Incident" } ], "responses": { "200": { "description": "OK, Operation successfully completed", "schema": { - "$ref": "#/definitions/AlertRule" + "$ref": "#/definitions/Incident" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/AlertRule" + "$ref": "#/definitions/Incident" } }, "default": { @@ -220,15 +220,15 @@ }, "delete": { "x-ms-examples": { - "Delete an alert rule.": { - "$ref": "./examples/alertRules/DeleteAlertRule.json" + "Delete an incident.": { + "$ref": "./examples/incidents/DeleteIncident.json" } }, "tags": [ - "Alert Rules" + "Incidents" ], - "description": "Delete the alert rule.", - "operationId": "AlertRules_Delete", + "description": "Delete the incident.", + "operationId": "Incidents_Delete", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -243,7 +243,7 @@ "$ref": "#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/RuleId" + "$ref": "#/parameters/IncidentId" } ], "responses": { @@ -262,18 +262,18 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}/actions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/comments": { "get": { "x-ms-examples": { - "Get all actions of alert rule.": { - "$ref": "./examples/actions/GetAllActionsByAlertRule.json" + "Get all incident comments.": { + "$ref": "./examples/incidents/comments/GetAllIncidentComments.json" } }, "tags": [ - "Actions" + "IncidentComments" ], - "description": "Gets all actions of alert rule.", - "operationId": "Actions_ListByAlertRule", + "description": "Gets all incident comments.", + "operationId": "IncidentComments_ListByIncident", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -288,14 +288,26 @@ "$ref": "#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/RuleId" + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/ODataFilter" + }, + { + "$ref": "#/parameters/ODataOrderBy" + }, + { + "$ref": "#/parameters/ODataTop" + }, + { + "$ref": "#/parameters/ODataSkipToken" } ], "responses": { "200": { "description": "OK, Operation successfully completed", "schema": { - "$ref": "#/definitions/ActionsList" + "$ref": "#/definitions/IncidentCommentList" } }, "default": { @@ -305,23 +317,24 @@ } } }, + "x-ms-odata": "#/definitions/IncidentComment", "x-ms-pageable": { "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}/actions/{actionId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/comments/{incidentCommentId}": { "get": { "x-ms-examples": { - "Get an action of alert rule.": { - "$ref": "./examples/actions/GetActionOfAlertRuleById.json" + "Get an incident comment.": { + "$ref": "./examples/incidents/comments/GetIncidentCommentById.json" } }, "tags": [ - "Actions" + "IncidentComments" ], - "description": "Gets the action of alert rule.", - "operationId": "Actions_Get", + "description": "Gets an incident comment.", + "operationId": "IncidentComments_Get", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -336,17 +349,17 @@ "$ref": "#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/RuleId" + "$ref": "#/parameters/IncidentId" }, { - "$ref": "#/parameters/ActionId" + "$ref": "#/parameters/IncidentCommentId" } ], "responses": { "200": { "description": "OK, Operation successfully completed", "schema": { - "$ref": "#/definitions/ActionResponse" + "$ref": "#/definitions/IncidentComment" } }, "default": { @@ -359,15 +372,15 @@ }, "put": { "x-ms-examples": { - "Creates or updates an action of alert rule.": { - "$ref": "./examples/actions/CreateActionOfAlertRule.json" + "Creates an incident comment.": { + "$ref": "./examples/incidents/comments/CreateIncidentComment.json" } }, "tags": [ - "Actions" + "IncidentComments" ], - "description": "Creates or updates the action of alert rule.", - "operationId": "Actions_CreateOrUpdate", + "description": "Creates the incident comment.", + "operationId": "IncidentComments_CreateComment", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -382,1805 +395,88 @@ "$ref": "#/parameters/WorkspaceName" }, { - "$ref": "#/parameters/RuleId" + "$ref": "#/parameters/IncidentId" }, { - "$ref": "#/parameters/ActionId" + "$ref": "#/parameters/IncidentCommentId" }, { - "$ref": "#/parameters/Action" + "$ref": "#/parameters/IncidentComment" } ], "responses": { - "200": { - "description": "OK, Operation successfully completed", - "schema": { - "$ref": "#/definitions/ActionResponse" - } - }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/ActionResponse" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "x-ms-examples": { - "Delete an action of alert rule.": { - "$ref": "./examples/actions/DeleteActionOfAlertRule.json" - } - }, - "tags": [ - "Actions" - ], - "description": "Delete the action of alert rule.", - "operationId": "Actions_Delete", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/RuleId" - }, - { - "$ref": "#/parameters/ActionId" - } - ], - "responses": { - "200": { - "description": "OK, Operation successfully completed" - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRuleTemplates": { - "get": { - "x-ms-examples": { - "Get all alert rule templates.": { - "$ref": "./examples/alertRuleTemplates/GetAlertRuleTemplates.json" - } - }, - "tags": [ - "Alert Rule Templates" - ], - "description": "Gets all alert rule templates.", - "operationId": "AlertRuleTemplates_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/WorkspaceName" - } - ], - "responses": { - "200": { - "description": "OK, Operation successfully completed", - "schema": { - "$ref": "#/definitions/AlertRuleTemplatesList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRuleTemplates/{alertRuleTemplateId}": { - "get": { - "x-ms-examples": { - "Get alert rule template by Id.": { - "$ref": "./examples/alertRuleTemplates/GetAlertRuleTemplateById.json" - } - }, - "tags": [ - "Alert Rule Templates" - ], - "description": "Gets the alert rule template.", - "operationId": "AlertRuleTemplates_Get", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/AlertRuleTemplateId" - } - ], - "responses": { - "200": { - "description": "OK, Operation successfully completed", - "schema": { - "$ref": "#/definitions/AlertRuleTemplate" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks": { - "get": { - "x-ms-examples": { - "Get all bookmarks.": { - "$ref": "./examples/bookmarks/GetBookmarks.json" - } - }, - "tags": [ - "Bookmarks" - ], - "description": "Gets all bookmarks.", - "operationId": "Bookmarks_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/WorkspaceName" - } - ], - "responses": { - "200": { - "description": "OK, Operation successfully completed", - "schema": { - "$ref": "#/definitions/BookmarkList" + "$ref": "#/definitions/IncidentComment" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}": { - "get": { - "x-ms-examples": { - "Get a bookmark.": { - "$ref": "./examples/bookmarks/GetBookmarkById.json" - } - }, - "tags": [ - "Bookmarks" - ], - "description": "Gets a bookmark.", - "operationId": "Bookmarks_Get", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/BookmarkId" - } - ], - "responses": { - "200": { - "description": "OK, Operation successfully completed", - "schema": { - "$ref": "#/definitions/Bookmark" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "x-ms-examples": { - "Creates or updates a bookmark.": { - "$ref": "./examples/bookmarks/CreateBookmark.json" - } - }, - "tags": [ - "Bookmarks" - ], - "description": "Creates or updates the bookmark.", - "operationId": "Bookmarks_CreateOrUpdate", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/BookmarkId" - }, - { - "$ref": "#/parameters/Bookmark" - } - ], - "responses": { - "200": { - "description": "OK, Operation successfully completed", - "schema": { - "$ref": "#/definitions/Bookmark" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/Bookmark" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "x-ms-examples": { - "Delete a bookmark.": { - "$ref": "./examples/bookmarks/DeleteBookmark.json" - } - }, - "tags": [ - "Bookmarks" - ], - "description": "Delete the bookmark.", - "operationId": "Bookmarks_Delete", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/BookmarkId" - } - ], - "responses": { - "200": { - "description": "OK, Operation successfully completed" - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors": { - "get": { - "x-ms-examples": { - "Get all data connectors.": { - "$ref": "./examples/dataConnectors/GetDataConnectors.json" - } - }, - "tags": [ - "Data Connectors" - ], - "description": "Gets all data connectors.", - "operationId": "DataConnectors_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/WorkspaceName" - } - ], - "responses": { - "200": { - "description": "OK, Operation successfully completed", - "schema": { - "$ref": "#/definitions/DataConnectorList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors/{dataConnectorId}": { - "get": { - "x-ms-examples": { - "Get an Office365 data connector.": { - "$ref": "./examples/dataConnectors/GetOfficeDataConnetorById.json" - }, - "Get a TI data connector.": { - "$ref": "./examples/dataConnectors/GetThreatIntelligenceById.json" - }, - "Get a MCAS data connector.": { - "$ref": "./examples/dataConnectors/GetMicrosoftCloudAppSecurityById.json" - }, - "Get a ASC data connector.": { - "$ref": "./examples/dataConnectors/GetAzureSecurityCenterById.json" - }, - "Get an AAD data connector.": { - "$ref": "./examples/dataConnectors/GetAzureActiveDirectoryById.json" - }, - "Get an AwsCloudTrail data connector.": { - "$ref": "./examples/dataConnectors/GetAmazonWebServicesCloudTrailById.json" - }, - "Get an AATP data connector.": { - "$ref": "./examples/dataConnectors/GetAzureAdvancedThreatProtectionById.json" - }, - "Get a MDATP data connector": { - "$ref": "./examples/dataConnectors/GetMicrosoftDefenderAdvancedThreatProtectionById.json" - } - }, - "tags": [ - "Data Connectors" - ], - "description": "Gets a data connector.", - "operationId": "DataConnectors_Get", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/DataConnectorId" - } - ], - "responses": { - "200": { - "description": "OK, Operation successfully completed", - "schema": { - "$ref": "#/definitions/DataConnector" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "x-ms-examples": { - "Creates or updates an Office365 data connector.": { - "$ref": "./examples/dataConnectors/CreateOfficeDataConnetor.json" - }, - "Creates or updates an Threat Intelligence Platform data connector.": { - "$ref": "./examples/dataConnectors/CreateThreatIntelligenceDataConnector.json" - } - }, - "tags": [ - "Data Connectors" - ], - "description": "Creates or updates the data connector.", - "operationId": "DataConnectors_CreateOrUpdate", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/DataConnectorId" - }, - { - "$ref": "#/parameters/DataConnector" - } - ], - "responses": { - "200": { - "description": "OK, Operation successfully completed", - "schema": { - "$ref": "#/definitions/DataConnector" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/DataConnector" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "x-ms-examples": { - "Delete an Office365 data connector.": { - "$ref": "./examples/dataConnectors/DeleteOfficeDataConnetor.json" - } - }, - "tags": [ - "Data Connectors" - ], - "description": "Delete the data connector.", - "operationId": "DataConnectors_Delete", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/DataConnectorId" - } - ], - "responses": { - "200": { - "description": "OK, Operation successfully completed" - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents": { - "get": { - "x-ms-examples": { - "Get all incidents.": { - "$ref": "./examples/incidents/GetIncidents.json" - } - }, - "tags": [ - "Incidents" - ], - "description": "Gets all incidents.", - "operationId": "Incidents_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/ODataFilter" - }, - { - "$ref": "#/parameters/ODataOrderBy" - }, - { - "$ref": "#/parameters/ODataTop" - }, - { - "$ref": "#/parameters/ODataSkipToken" - } - ], - "responses": { - "200": { - "description": "OK, Operation successfully completed", - "schema": { - "$ref": "#/definitions/IncidentList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}": { - "get": { - "x-ms-examples": { - "Get an incident.": { - "$ref": "./examples/incidents/GetIncidentById.json" - } - }, - "tags": [ - "Incidents" - ], - "description": "Gets an incident.", - "operationId": "Incidents_Get", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/IncidentId" - } - ], - "responses": { - "200": { - "description": "OK, Operation successfully completed", - "schema": { - "$ref": "#/definitions/Incident" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "x-ms-examples": { - "Creates or updates an incident.": { - "$ref": "./examples/incidents/CreateIncident.json" - } - }, - "tags": [ - "Incidents" - ], - "description": "Creates or updates the incident.", - "operationId": "Incidents_CreateOrUpdate", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/IncidentId" - }, - { - "$ref": "#/parameters/Incident" - } - ], - "responses": { - "200": { - "description": "OK, Operation successfully completed", - "schema": { - "$ref": "#/definitions/Incident" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/Incident" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "x-ms-examples": { - "Delete an incident.": { - "$ref": "./examples/incidents/DeleteIncident.json" - } - }, - "tags": [ - "Incidents" - ], - "description": "Delete the incident.", - "operationId": "Incidents_Delete", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/IncidentId" - } - ], - "responses": { - "200": { - "description": "OK, Operation successfully completed" - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/comments": { - "get": { - "x-ms-examples": { - "Get all incident comments.": { - "$ref": "./examples/incidents/comments/GetAllIncidentComments.json" - } - }, - "tags": [ - "IncidentComments" - ], - "description": "Gets all incident comments.", - "operationId": "IncidentComments_ListByIncident", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/IncidentId" - }, - { - "$ref": "#/parameters/ODataFilter" - }, - { - "$ref": "#/parameters/ODataOrderBy" - }, - { - "$ref": "#/parameters/ODataTop" - }, - { - "$ref": "#/parameters/ODataSkipToken" - } - ], - "responses": { - "200": { - "description": "OK, Operation successfully completed", - "schema": { - "$ref": "#/definitions/IncidentCommentList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-odata": "#/definitions/IncidentComment", - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/comments/{incidentCommentId}": { - "get": { - "x-ms-examples": { - "Get an incident comment.": { - "$ref": "./examples/incidents/comments/GetIncidentCommentById.json" - } - }, - "tags": [ - "IncidentComments" - ], - "description": "Gets an incident comment.", - "operationId": "IncidentComments_Get", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/IncidentId" - }, - { - "$ref": "#/parameters/IncidentCommentId" - } - ], - "responses": { - "200": { - "description": "OK, Operation successfully completed", - "schema": { - "$ref": "#/definitions/IncidentComment" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "x-ms-examples": { - "Creates an incident comment.": { - "$ref": "./examples/incidents/comments/CreateIncidentComment.json" - } - }, - "tags": [ - "IncidentComments" - ], - "description": "Creates the incident comment.", - "operationId": "IncidentComments_CreateComment", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/WorkspaceName" - }, - { - "$ref": "#/parameters/IncidentId" - }, - { - "$ref": "#/parameters/IncidentCommentId" - }, - { - "$ref": "#/parameters/IncidentComment" - } - ], - "responses": { - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/IncidentComment" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "AADDataConnector": { - "allOf": [ - { - "$ref": "#/definitions/DataConnector" - } - ], - "description": "Represents AAD (Azure Active Directory) data connector.", - "properties": { - "properties": { - "$ref": "#/definitions/AADDataConnectorProperties", - "description": "AAD (Azure Active Directory) data connector properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "AzureActiveDirectory" - }, - "AADDataConnectorProperties": { - "description": "AAD (Azure Active Directory) data connector properties.", - "properties": { - "tenantId": { - "description": "The tenant id to connect to, and get the data from.", - "type": "string" - }, - "dataTypes": { - "$ref": "#/definitions/AlertsDataTypeOfDataConnector", - "description": "The available data types for the connector." - } - }, - "type": "object" - }, - "AATPDataConnector": { - "allOf": [ - { - "$ref": "#/definitions/DataConnector" - } - ], - "description": "Represents AATP (Azure Advanced Threat Protection) data connector.", - "properties": { - "properties": { - "$ref": "#/definitions/AATPDataConnectorProperties", - "description": "AATP (Azure Advanced Threat Protection) data connector properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "AzureAdvancedThreatProtection" - }, - "AATPDataConnectorProperties": { - "description": "AATP (Azure Advanced Threat Protection) data connector properties.", - "properties": { - "tenantId": { - "description": "The tenant id to connect to, and get the data from.", - "type": "string" - }, - "dataTypes": { - "$ref": "#/definitions/AlertsDataTypeOfDataConnector", - "description": "The available data types for the connector." - } - }, - "type": "object" - }, - "ASCDataConnector": { - "allOf": [ - { - "$ref": "#/definitions/DataConnector" - } - ], - "description": "Represents ASC (Azure Security Center) data connector.", - "properties": { - "properties": { - "$ref": "#/definitions/ASCDataConnectorProperties", - "description": "ASC (Azure Security Center) data connector properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "AzureSecurityCenter" - }, - "ASCDataConnectorProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorWithAlertsProperties" - } - ], - "description": "ASC (Azure Security Center) data connector properties.", - "properties": { - "subscriptionId": { - "description": "The subscription id to connect to, and get the data from.", - "type": "string" - } - }, - "type": "object" - }, - "ActionRequest": { - "allOf": [ - { - "$ref": "#/definitions/ResourceWithEtag" - } - ], - "description": "Action for alert rule.", - "properties": { - "properties": { - "$ref": "#/definitions/ActionRequestProperties", - "description": "Action properties for put request", - "x-ms-client-flatten": true - } - }, - "type": "object" - }, - "ActionPropertiesBase": { - "description": "Action property bag base.", - "properties": { - "logicAppResourceId": { - "description": "Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}.", - "type": "string" - } - }, - "required": [ - "logicAppResourceId" - ], - "type": "object" - }, - "ActionRequestProperties": { - "allOf": [ - { - "$ref": "#/definitions/ActionPropertiesBase" - } - ], - "description": "Action property bag.", - "properties": { - "triggerUri": { - "description": "Logic App Callback URL for this specific workflow.", - "type": "string" - } - }, - "required": [ - "triggerUri" - ], - "type": "object" - }, - "ActionResponse": { - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Action for alert rule.", - "properties": { - "etag": { - "description": "Etag of the action.", - "type": "string" - }, - "properties": { - "$ref": "#/definitions/ActionResponseProperties", - "description": "Action properties for get request", - "x-ms-client-flatten": true - } - }, - "type": "object" - }, - "ActionResponseProperties": { - "allOf": [ - { - "$ref": "#/definitions/ActionPropertiesBase" - } - ], - "description": "Action property bag.", - "properties": { - "workflowId": { - "description": "The name of the logic app's workflow.", - "type": "string" - } - }, - "type": "object" - }, - "ActionsList": { - "description": "List all the actions.", - "properties": { - "nextLink": { - "description": "URL to fetch the next set of actions.", - "readOnly": true, - "type": "string" - }, - "value": { - "description": "Array of actions.", - "items": { - "$ref": "#/definitions/ActionResponse" - }, - "type": "array" - } - }, - "required": [ - "value" - ] - }, - "AlertRule": { - "allOf": [ - { - "$ref": "#/definitions/ResourceWithEtag" - } - ], - "description": "Alert rule.", - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AlertRuleKind", - "description": "The alert rule kind" - } - }, - "type": "object" - }, - "AlertRuleKind": { - "description": "The kind of the alert rule", - "enum": [ - "Scheduled", - "MicrosoftSecurityIncidentCreation", - "Fusion" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "AlertRuleKind", - "values": [ - { - "value": "Scheduled" - }, - { - "value": "MicrosoftSecurityIncidentCreation" - }, - { - "value": "Fusion" - } - ] - } - }, - "AlertRuleTemplateStatus": { - "description": "The alert rule template status.", - "enum": [ - "Installed", - "Available", - "NotAvailable" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "TemplateStatus", - "values": [ - { - "description": "Alert rule template installed. and can not use more then once", - "value": "Installed" - }, - { - "description": "Alert rule template is available.", - "value": "Available" - }, - { - "description": "Alert rule template is not available", - "value": "NotAvailable" - } - ] - } - }, - "AlertRuleTemplate": { - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Alert rule template.", - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/AlertRuleKind", - "description": "The alert rule kind", - "type": "string" - } - }, - "type": "object" - }, - "AlertRuleTemplateDataSource": { - "description": "alert rule template data sources", - "properties": { - "connectorId": { - "description": "The connector id that provides the following data types", - "type": "string" - }, - "dataTypes": { - "description": "The data types used by the alert rule template", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AlertRuleTemplatesList": { - "description": "List all the alert rule templates.", - "properties": { - "nextLink": { - "description": "URL to fetch the next set of alert rule templates.", - "readOnly": true, - "type": "string" - }, - "value": { - "description": "Array of alert rule templates.", - "items": { - "$ref": "#/definitions/AlertRuleTemplate" - }, - "type": "array" - } - }, - "required": [ - "value" - ] - }, - "AlertRuleTriggerOperator": { - "description": "The operation against the threshold that triggers alert rule.", - "enum": [ - "GreaterThan", - "LessThan", - "Equal", - "NotEqual" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": false, - "name": "TriggerOperator" - } - }, - "AlertRulesList": { - "description": "List all the alert rules.", - "properties": { - "nextLink": { - "description": "URL to fetch the next set of alert rules.", - "readOnly": true, - "type": "string" - }, - "value": { - "description": "Array of alert rules.", - "items": { - "$ref": "#/definitions/AlertRule" - }, - "type": "array" - } - }, - "required": [ - "value" - ] - }, - "AlertSeverity": { - "description": "The severity of the alert", - "enum": [ - "High", - "Medium", - "Low", - "Informational" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "AlertSeverity", - "values": [ - { - "description": "High severity", - "value": "High" - }, - { - "description": "Medium severity", - "value": "Medium" - }, - { - "description": "Low severity", - "value": "Low" - }, - { - "description": "Informational severity", - "value": "Informational" - } - ] - } - }, - "MicrosoftSecurityProductName": { - "description": "The alerts' productName on which the cases will be generated", - "enum": [ - "Microsoft Cloud App Security", - "Azure Security Center", - "Azure Advanced Threat Protection", - "Azure Active Directory Identity Protection", - "Azure Security Center for IoT" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "MicrosoftSecurityProductName" - } - }, - "AlertsDataTypeOfDataConnector": { - "description": "Alerts data type for data connectors.", - "properties": { - "alerts": { - "$ref": "#/definitions/DataConnectorDataTypeCommon", - "description": "Alerts data type connection.", - "type": "object" - } - }, - "type": "object" - }, - "AttackTactic": { - "description": "The severity for alerts created by this alert rule.", - "enum": [ - "InitialAccess", - "Execution", - "Persistence", - "PrivilegeEscalation", - "DefenseEvasion", - "CredentialAccess", - "Discovery", - "LateralMovement", - "Collection", - "Exfiltration", - "CommandAndControl", - "Impact" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "AttackTactic" - } - }, - "AwsCloudTrailDataConnector": { - "allOf": [ - { - "$ref": "#/definitions/DataConnector" - } - ], - "description": "Represents Amazon Web Services CloudTrail data connector.", - "properties": { - "properties": { - "$ref": "#/definitions/AwsCloudTrailDataConnectorProperties", - "description": "Amazon Web Services CloudTrail data connector properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "AmazonWebServicesCloudTrail" - }, - "AwsCloudTrailDataConnectorDataTypes": { - "description": "The available data types for Amazon Web Services CloudTrail data connector.", - "properties": { - "logs": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorDataTypeCommon" - } - ], - "description": "Logs data type.", - "type": "object" - } - }, - "type": "object" - }, - "AwsCloudTrailDataConnectorProperties": { - "description": "Amazon Web Services CloudTrail data connector properties.", - "properties": { - "awsRoleArn": { - "description": "The Aws Role Arn (with CloudTrailReadOnly policy) that is used to access the Aws account.", - "type": "string" - }, - "dataTypes": { - "$ref": "#/definitions/AwsCloudTrailDataConnectorDataTypes", - "description": "The available data types for the connector." - } - }, - "type": "object" - }, - "Bookmark": { - "allOf": [ - { - "$ref": "#/definitions/ResourceWithEtag" - } - ], - "description": "Represents a bookmark in Azure Security Insights.", - "properties": { - "properties": { - "$ref": "#/definitions/BookmarkProperties", - "description": "Bookmark properties", - "x-ms-client-flatten": true - } - }, - "type": "object" - }, - "BookmarkList": { - "description": "List all the bookmarks.", - "properties": { - "nextLink": { - "description": "URL to fetch the next set of cases.", - "readOnly": true, - "type": "string" - }, - "value": { - "description": "Array of bookmarks.", - "items": { - "$ref": "#/definitions/Bookmark" - }, - "type": "array" - } - }, - "required": [ - "value" - ] - }, - "BookmarkProperties": { - "description": "Describes bookmark properties", - "properties": { - "created": { - "description": "The time the bookmark was created", - "format": "date-time", - "type": "string" - }, - "createdBy": { - "$ref": "#/definitions/UserInfo", - "description": "Describes a user that created the bookmark", - "type": "object" - }, - "displayName": { - "description": "The display name of the bookmark", - "type": "string" - }, - "labels": { - "description": "List of labels relevant to this bookmark", - "items": { - "$ref": "#/definitions/Label" - }, - "type": "array" - }, - "notes": { - "description": "The notes of the bookmark", - "type": "string" - }, - "query": { - "description": "The query of the bookmark.", - "type": "string" - }, - "queryResult": { - "description": "The query result of the bookmark.", - "type": "string" - }, - "updated": { - "description": "The last time the bookmark was updated", - "format": "date-time", - "type": "string" - }, - "updatedBy": { - "$ref": "#/definitions/UserInfo", - "description": "Describes a user that updated the bookmark", - "type": "object" - }, - "eventTime": { - "description": "The bookmark event time", - "format": "date-time", - "type": "string" - }, - "queryStartTime": { - "description": "The start time for the query", - "format": "date-time", - "type": "string" - }, - "queryEndTime": { - "description": "The end time for the query", - "format": "date-time", - "type": "string" - }, - "incidentInfo": { - "$ref": "#/definitions/IncidentInfo", - "description": "Describes an incident that relates to bookmark", - "type": "object" - } - }, - "required": [ - "displayName", - "query" - ], - "type": "object" - }, - "ClientInfo": { - "description": "Information on the client (user or application) that made some action", - "properties": { - "email": { - "description": "The email of the client.", - "type": "string" - }, - "name": { - "description": "The name of the client.", - "type": "string" - }, - "objectId": { - "description": "The object id of the client.", - "format": "uuid", - "type": "string" - }, - "userPrincipalName": { - "description": "The user principal name of the client.", - "type": "string" - } - }, - "type": "object" - }, - "CloudError": { - "x-ms-external": true, - "properties": { - "error": { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse", - "description": "The error object of the CloudError response" - } - }, - "description": "An error response for a resource management request." - }, - "DataConnector": { - "allOf": [ - { - "$ref": "#/definitions/ResourceWithEtag" - } - ], - "description": "Data connector.", - "discriminator": "kind", - "required": [ - "kind" - ], - "properties": { - "kind": { - "$ref": "#/definitions/DataConnectorKind", - "description": "The data connector kind" - } - }, - "type": "object" - }, - "DataConnectorDataTypeCommon": { - "description": "Common field for data type in data connectors.", - "properties": { - "state": { - "description": "Describe whether this data type connection is enabled or not.", - "enum": [ - "Enabled", - "Disabled" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "DataTypeState" - } - } - }, - "type": "object" - }, - "DataConnectorKind": { - "description": "The kind of the data connector", - "enum": [ - "AzureActiveDirectory", - "AzureSecurityCenter", - "MicrosoftCloudAppSecurity", - "ThreatIntelligence", - "Office365", - "AmazonWebServicesCloudTrail", - "AzureAdvancedThreatProtection", - "MicrosoftDefenderAdvancedThreatProtection" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "DataConnectorKind", - "values": [ - { - "value": "AzureActiveDirectory" - }, - { - "value": "AzureSecurityCenter" - }, - { - "value": "MicrosoftCloudAppSecurity" - }, - { - "value": "ThreatIntelligence" - }, - { - "value": "Office365" - }, - { - "value": "AmazonWebServicesCloudTrail" - }, - { - "value": "AzureAdvancedThreatProtection" - }, - { - "value": "MicrosoftDefenderAdvancedThreatProtection" - } - ] - } - }, - "DataConnectorList": { - "description": "List all the data connectors.", - "properties": { - "nextLink": { - "description": "URL to fetch the next set of data connectors.", - "readOnly": true, - "type": "string" - }, - "value": { - "description": "Array of data connectors.", - "items": { - "$ref": "#/definitions/DataConnector" - }, - "type": "array" - } - }, - "required": [ - "value" - ] - }, - "DataConnectorTenantId": { - "description": "Properties data connector on tenant level.", - "properties": { - "tenantId": { - "description": "The tenant id to connect to, and get the data from.", - "type": "string" - } - }, - "type": "object" - }, - "DataConnectorWithAlertsProperties": { - "description": "Data connector properties.", - "properties": { - "dataTypes": { - "$ref": "#/definitions/AlertsDataTypeOfDataConnector", - "description": "The available data types for the connector." - } - }, - "type": "object" - }, - "FusionAlertRule": { - "allOf": [ - { - "$ref": "#/definitions/AlertRule" + "$ref": "#/definitions/CloudError" + } + } } + } + } + }, + "definitions": { + "AttackTactic": { + "description": "The severity for alerts created by this alert rule.", + "enum": [ + "InitialAccess", + "Execution", + "Persistence", + "PrivilegeEscalation", + "DefenseEvasion", + "CredentialAccess", + "Discovery", + "LateralMovement", + "Collection", + "Exfiltration", + "CommandAndControl", + "Impact" ], - "description": "Represents Fusion alert rule.", - "properties": { - "properties": { - "$ref": "#/definitions/FusionAlertRuleProperties", - "description": "Fusion alert rule properties", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "Fusion" + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AttackTactic" + } }, - "FusionAlertRuleProperties": { - "description": "Fusion alert rule base property bag.", + "ClientInfo": { + "description": "Information on the client (user or application) that made some action", "properties": { - "alertRuleTemplateName": { - "description": "The Name of the alert rule template used to create this rule.", + "email": { + "description": "The email of the client.", "type": "string" }, - "description": { - "description": "The description of the alert rule.", - "readOnly": true, + "name": { + "description": "The name of the client.", "type": "string" }, - "displayName": { - "description": "The display name for alerts created by this alert rule.", - "readOnly": true, + "objectId": { + "description": "The object id of the client.", + "format": "uuid", "type": "string" }, - "enabled": { - "description": "Determines whether this alert rule is enabled or disabled.", - "type": "boolean" - }, - "lastModifiedUtc": { - "description": "The last time that this alert has been modified.", - "format": "date-time", - "readOnly": true, + "userPrincipalName": { + "description": "The user principal name of the client.", "type": "string" - }, - "severity": { - "$ref": "#/definitions/AlertSeverity", - "description": "The severity for alerts created by this alert rule.", - "readOnly": true - }, - "tactics": { - "description": "The tactics of the alert rule", - "items": { - "$ref": "#/definitions/AttackTactic" - }, - "readOnly": true, - "type": "array" } }, - "required": [ - "alertRuleTemplateName", - "enabled" - ], "type": "object" }, - "FusionAlertRuleTemplate": { - "allOf": [ - { - "$ref": "#/definitions/AlertRuleTemplate" - } - ], - "description": "Represents Fusion alert rule template.", + "CloudError": { + "x-ms-external": true, "properties": { - "properties": { - "$ref": "#/definitions/FusionAlertRuleTemplateProperties", - "description": "Fusion alert rule template properties", - "required": [ - "displayName", - "description", - "status", - "severity", - "alertRulesCreatedByTemplateCount" - ], - "x-ms-client-flatten": true + "error": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse", + "description": "The error object of the CloudError response" } }, "type": "object", - "x-ms-discriminator-value": "Fusion" - }, - "FusionAlertRuleTemplateProperties": { - "description": "Represents Fusion alert rule template properties", - "properties": { - "alertRulesCreatedByTemplateCount": { - "description": "the number of alert rules that were created by this template", - "format": "int32", - "type": "integer" - }, - "createdDateUTC": { - "description": "The time that this alert rule template has been added.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "The description of the alert rule template.", - "type": "string" - }, - "displayName": { - "description": "The display name for alert rule template.", - "type": "string" - }, - "requiredDataConnectors": { - "description": "The required data connectors for this template", - "items": { - "$ref": "#/definitions/AlertRuleTemplateDataSource" - }, - "type": "array" - }, - "status": { - "$ref": "#/definitions/AlertRuleTemplateStatus", - "description": "The alert rule template status.", - "type": "string" - }, - "severity": { - "$ref": "#/definitions/AlertSeverity", - "description": "The severity for alerts created by this alert rule." - }, - "tactics": { - "description": "The tactics of the alert rule template", - "items": { - "$ref": "#/definitions/AttackTactic" - }, - "type": "array" - } - }, - "type": "object" + "description": "An error response for a resource management request." }, "Incident": { "allOf": [ @@ -2271,6 +567,7 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] @@ -2352,6 +649,7 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] @@ -2573,282 +871,18 @@ ] } }, - "title": { - "description": "The title of the incident", - "type": "string" - } - }, - "required": [ - "title", - "severity", - "status" - ], - "type": "object" - }, - "Label": { - "description": "Label that will be used to tag and filter on.", - "type": "string" - }, - "MCASDataConnector": { - "allOf": [ - { - "$ref": "#/definitions/DataConnector" - } - ], - "description": "Represents MCAS (Microsoft Cloud App Security) data connector.", - "properties": { - "properties": { - "$ref": "#/definitions/MCASDataConnectorProperties", - "description": "MCAS (Microsoft Cloud App Security) data connector properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "MicrosoftCloudAppSecurity" - }, - "MCASDataConnectorDataTypes": { - "allOf": [ - { - "$ref": "#/definitions/AlertsDataTypeOfDataConnector" - } - ], - "description": "The available data types for MCAS (Microsoft Cloud App Security) data connector.", - "properties": { - "alerts": { - "$ref": "#/definitions/DataConnectorDataTypeCommon", - "description": "Alerts data type connection." - }, - "discoveryLogs": { - "$ref": "#/definitions/DataConnectorDataTypeCommon", - "description": "Discovery log data type connection." - } - }, - "type": "object" - }, - "MCASDataConnectorProperties": { - "description": "MCAS (Microsoft Cloud App Security) data connector properties.", - "properties": { - "tenantId": { - "description": "The tenant id to connect to, and get the data from.", - "type": "string" - }, - "dataTypes": { - "$ref": "#/definitions/MCASDataConnectorDataTypes", - "description": "The available data types for the connector." - } - }, - "type": "object" - }, - "MDATPDataConnector": { - "allOf": [ - { - "$ref": "#/definitions/DataConnector" - } - ], - "description": "Represents MDATP (Microsoft Defender Advanced Threat Protection) data connector.", - "properties": { - "properties": { - "$ref": "#/definitions/MDATPDataConnectorProperties", - "description": "MDATP (Microsoft Defender Advanced Threat Protection) data connector properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "MicrosoftDefenderAdvancedThreatProtection" - }, - "MDATPDataConnectorProperties": { - "description": "MDATP (Microsoft Defender Advanced Threat Protection) data connector properties.", - "properties": { - "tenantId": { - "description": "The tenant id to connect to, and get the data from.", - "type": "string" - }, - "dataTypes": { - "$ref": "#/definitions/AlertsDataTypeOfDataConnector", - "description": "The available data types for the connector." - } - }, - "type": "object" - }, - "MicrosoftSecurityIncidentCreationAlertRule": { - "allOf": [ - { - "$ref": "#/definitions/AlertRule" - } - ], - "description": "Represents MicrosoftSecurityIncidentCreation rule.", - "properties": { - "properties": { - "$ref": "#/definitions/MicrosoftSecurityIncidentCreationAlertRuleProperties", - "description": "MicrosoftSecurityIncidentCreation rule properties", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "MicrosoftSecurityIncidentCreation" - }, - "MicrosoftSecurityIncidentCreationAlertRuleCommonProperties": { - "description": "MicrosoftSecurityIncidentCreation rule common property bag.", - "properties": { - "displayNamesFilter": { - "description": "the alerts' displayNames on which the cases will be generated", - "items": { - "type": "string" - }, - "type": "array" - }, - "displayNamesExcludeFilter": { - "description": "the alerts' displayNames on which the cases will not be generated", - "items": { - "type": "string" - }, - "type": "array" - }, - "productFilter": { - "$ref": "#/definitions/MicrosoftSecurityProductName", - "description": "The alerts' productName on which the cases will be generated" - }, - "severitiesFilter": { - "description": "the alerts' severities on which the cases will be generated", - "items": { - "$ref": "#/definitions/AlertSeverity" - }, - "type": "array" - } - }, - "required": [ - "productFilter" - ], - "type": "object" - }, - "MicrosoftSecurityIncidentCreationAlertRuleProperties": { - "allOf": [ - { - "$ref": "#/definitions/MicrosoftSecurityIncidentCreationAlertRuleCommonProperties" - } - ], - "description": "MicrosoftSecurityIncidentCreation rule property bag.", - "properties": { - "alertRuleTemplateName": { - "description": "The Name of the alert rule template used to create this rule.", - "type": "string" - }, - "description": { - "description": "The description of the alert rule.", - "type": "string" - }, - "displayName": { - "description": "The display name for alerts created by this alert rule.", - "type": "string" - }, - "enabled": { - "description": "Determines whether this alert rule is enabled or disabled.", - "type": "boolean" - }, - "lastModifiedUtc": { - "description": "The last time that this alert has been modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - } - }, - "required": [ - "displayName", - "enabled", - "productFilter" - ], - "type": "object" - }, - "MicrosoftSecurityIncidentCreationAlertRuleTemplateProperties": { - "description": "MicrosoftSecurityIncidentCreation rule template properties", - "properties": { - "alertRulesCreatedByTemplateCount": { - "description": "the number of alert rules that were created by this template", - "format": "int32", - "type": "integer" - }, - "createdDateUTC": { - "description": "The time that this alert rule template has been added.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "The description of the alert rule template.", - "type": "string" - }, - "displayName": { - "description": "The display name for alert rule template.", - "type": "string" - }, - "requiredDataConnectors": { - "description": "The required data connectors for this template", - "items": { - "$ref": "#/definitions/AlertRuleTemplateDataSource" - }, - "type": "array" - }, - "status": { - "$ref": "#/definitions/AlertRuleTemplateStatus", - "description": "The alert rule template status.", - "type": "string" - }, - "displayNamesFilter": { - "description": "the alerts' displayNames on which the cases will be generated", - "items": { - "type": "string" - }, - "type": "array" - }, - "displayNamesExcludeFilter": { - "description": "the alerts' displayNames on which the cases will not be generated", - "items": { - "type": "string" - }, - "type": "array" - }, - "productFilter": { - "$ref": "#/definitions/MicrosoftSecurityProductName", - "description": "The alerts' productName on which the cases will be generated" - }, - "severitiesFilter": { - "description": "the alerts' severities on which the cases will be generated", - "items": { - "$ref": "#/definitions/AlertSeverity" - }, - "type": "array" + "title": { + "description": "The title of the incident", + "type": "string" } }, "required": [ - "productFilter" + "title", + "severity", + "status" ], "type": "object" }, - "MicrosoftSecurityIncidentCreationAlertRuleTemplate": { - "allOf": [ - { - "$ref": "#/definitions/AlertRuleTemplate" - } - ], - "description": "Represents MicrosoftSecurityIncidentCreation rule template.", - "properties": { - "properties": { - "$ref": "#/definitions/MicrosoftSecurityIncidentCreationAlertRuleTemplateProperties", - "description": "MicrosoftSecurityIncidentCreation rule template properties", - "required": [ - "displayName", - "description", - "createdDateUTC", - "status", - "alertRulesCreatedByTemplateCount", - "productFilter" - ], - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "MicrosoftSecurityIncidentCreation" - }, "OfficeConsent": { "allOf": [ { @@ -2900,70 +934,6 @@ }, "type": "object" }, - "OfficeDataConnector": { - "allOf": [ - { - "$ref": "#/definitions/DataConnector" - } - ], - "description": "Represents office data connector.", - "properties": { - "properties": { - "$ref": "#/definitions/OfficeDataConnectorProperties", - "description": "Office data connector properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "Office365" - }, - "OfficeDataConnectorDataTypes": { - "description": "The available data types for office data connector.", - "properties": { - "exchange": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorDataTypeCommon" - } - ], - "description": "Exchange data type connection.", - "type": "object" - }, - "sharePoint": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorDataTypeCommon" - } - ], - "description": "SharePoint data type connection.", - "type": "object" - }, - "teams": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorDataTypeCommon" - } - ], - "description": "Teams data type connection.", - "type": "object" - } - }, - "type": "object" - }, - "OfficeDataConnectorProperties": { - "description": "Office data connector properties.", - "properties": { - "tenantId": { - "description": "The tenant id to connect to, and get the data from.", - "type": "string" - }, - "dataTypes": { - "$ref": "#/definitions/OfficeDataConnectorDataTypes", - "description": "The available data types for the connector." - } - }, - "type": "object" - }, "Operation": { "description": "Operation provided by provider", "properties": { @@ -2997,7 +967,8 @@ "description": "The origin of the operation", "type": "string" } - } + }, + "type": "object" }, "OperationsList": { "description": "Lists the operations available in the SecurityInsights RP.", @@ -3014,6 +985,7 @@ "type": "array" } }, + "type": "object", "required": [ "value" ] @@ -3037,6 +1009,7 @@ "type": "string" } }, + "type": "object", "x-ms-azure-resource": true }, "ResourceWithEtag": { @@ -3062,218 +1035,8 @@ "type": "string" } }, - "x-ms-azure-resource": true - }, - "ScheduledAlertRule": { - "allOf": [ - { - "$ref": "#/definitions/AlertRule" - } - ], - "description": "Represents scheduled alert rule.", - "properties": { - "properties": { - "$ref": "#/definitions/ScheduledAlertRuleProperties", - "description": "Scheduled alert rule properties", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "Scheduled" - }, - "ScheduledAlertRuleCommonProperties": { - "description": "Schedule alert rule template property bag.", - "properties": { - "query": { - "description": "The query that creates alerts for this rule.", - "type": "string" - }, - "queryFrequency": { - "description": "The frequency (in ISO 8601 duration format) for this alert rule to run.", - "format": "duration", - "type": "string" - }, - "queryPeriod": { - "description": "The period (in ISO 8601 duration format) that this alert rule looks at.", - "format": "duration", - "type": "string" - }, - "severity": { - "$ref": "#/definitions/AlertSeverity", - "description": "The severity for alerts created by this alert rule." - }, - "triggerOperator": { - "$ref": "#/definitions/AlertRuleTriggerOperator", - "description": "The operation against the threshold that triggers alert rule." - }, - "triggerThreshold": { - "description": "The threshold triggers this alert rule.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "ScheduledAlertRuleProperties": { - "allOf": [ - { - "$ref": "#/definitions/ScheduledAlertRuleCommonProperties" - } - ], - "description": "Scheduled alert rule base property bag.", - "properties": { - "alertRuleTemplateName": { - "description": "The Name of the alert rule template used to create this rule.", - "type": "string" - }, - "description": { - "description": "The description of the alert rule.", - "type": "string" - }, - "displayName": { - "description": "The display name for alerts created by this alert rule.", - "type": "string" - }, - "enabled": { - "description": "Determines whether this alert rule is enabled or disabled.", - "type": "boolean" - }, - "lastModifiedUtc": { - "description": "The last time that this alert rule has been modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "suppressionDuration": { - "description": "The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered.", - "format": "duration", - "type": "string" - }, - "suppressionEnabled": { - "description": "Determines whether the suppression for this alert rule is enabled or disabled.", - "type": "boolean" - }, - "tactics": { - "description": "The tactics of the alert rule", - "items": { - "$ref": "#/definitions/AttackTactic" - }, - "type": "array" - } - }, - "required": [ - "displayName", - "enabled", - "severity", - "query", - "queryFrequency", - "queryPeriod", - "triggerOperator", - "triggerThreshold", - "suppressionEnabled", - "suppressionDuration" - ], - "type": "object" - }, - "ScheduledAlertRuleTemplateProperties": { - "description": "Scheduled alert rule template properties", - "properties": { - "alertRulesCreatedByTemplateCount": { - "description": "the number of alert rules that were created by this template", - "format": "int32", - "type": "integer" - }, - "createdDateUTC": { - "description": "The time that this alert rule template has been added.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "The description of the alert rule template.", - "type": "string" - }, - "displayName": { - "description": "The display name for alert rule template.", - "type": "string" - }, - "requiredDataConnectors": { - "description": "The required data connectors for this template", - "items": { - "$ref": "#/definitions/AlertRuleTemplateDataSource" - }, - "type": "array" - }, - "status": { - "$ref": "#/definitions/AlertRuleTemplateStatus", - "description": "The alert rule template status.", - "type": "string" - }, - "query": { - "description": "The query that creates alerts for this rule.", - "type": "string" - }, - "queryFrequency": { - "description": "The frequency (in ISO 8601 duration format) for this alert rule to run.", - "format": "duration", - "type": "string" - }, - "queryPeriod": { - "description": "The period (in ISO 8601 duration format) that this alert rule looks at.", - "format": "duration", - "type": "string" - }, - "severity": { - "$ref": "#/definitions/AlertSeverity", - "description": "The severity for alerts created by this alert rule." - }, - "triggerOperator": { - "$ref": "#/definitions/AlertRuleTriggerOperator", - "description": "The operation against the threshold that triggers alert rule." - }, - "triggerThreshold": { - "description": "The threshold triggers this alert rule.", - "format": "int32", - "type": "integer" - }, - "tactics": { - "description": "The tactics of the alert rule template", - "items": { - "$ref": "#/definitions/AttackTactic" - }, - "type": "array" - } - }, - "type": "object" - }, - "ScheduledAlertRuleTemplate": { - "allOf": [ - { - "$ref": "#/definitions/AlertRuleTemplate" - } - ], - "description": "Represents scheduled alert rule template.", - "properties": { - "properties": { - "$ref": "#/definitions/ScheduledAlertRuleTemplateProperties", - "description": "Scheduled alert rule template properties", - "required": [ - "displayName", - "description", - "status", - "alertRulesCreatedByTemplateCount", - "severity", - "query", - "queryFrequency", - "queryPeriod", - "triggerOperator", - "triggerThreshold" - ], - "x-ms-client-flatten": true - } - }, "type": "object", - "x-ms-discriminator-value": "Scheduled" + "x-ms-azure-resource": true }, "Settings": { "allOf": [ @@ -3306,58 +1069,6 @@ "name": "SettingKind" } }, - "TIDataConnector": { - "allOf": [ - { - "$ref": "#/definitions/DataConnector" - } - ], - "description": "Represents threat intelligence data connector.", - "properties": { - "properties": { - "$ref": "#/definitions/TIDataConnectorProperties", - "description": "TI (Threat Intelligence) data connector properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "ThreatIntelligence" - }, - "TIDataConnectorDataTypes": { - "description": "The available data types for TI (Threat Intelligence) data connector.", - "properties": { - "indicators": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorDataTypeCommon" - } - ], - "description": "Data type for indicators connection.", - "type": "object" - } - }, - "type": "object" - }, - "TIDataConnectorProperties": { - "description": "TI (Threat Intelligence) data connector properties.", - "properties": { - "tenantId": { - "description": "The tenant id to connect to, and get the data from.", - "type": "string" - }, - "tipLookbackPeriod": { - "description": "The lookback period for the feed to be imported.", - "format": "date-time", - "type": "string", - "x-nullable": true - }, - "dataTypes": { - "$ref": "#/definitions/TIDataConnectorDataTypes", - "description": "The available data types for the connector." - } - }, - "type": "object" - }, "ThreatIntelligence": { "description": "ThreatIntelligence property bag.", "properties": { @@ -3557,24 +1268,6 @@ } }, "parameters": { - "Action": { - "description": "The action", - "in": "body", - "name": "action", - "required": true, - "schema": { - "$ref": "#/definitions/ActionRequest" - }, - "x-ms-parameter-location": "method" - }, - "ActionId": { - "description": "Action ID", - "in": "path", - "name": "actionId", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, "AggregationsName": { "description": "The aggregation name. Supports - Cases", "in": "path", @@ -3583,24 +1276,6 @@ "type": "string", "x-ms-parameter-location": "method" }, - "AlertRule": { - "description": "The alert rule", - "in": "body", - "name": "alertRule", - "required": true, - "schema": { - "$ref": "#/definitions/AlertRule" - }, - "x-ms-parameter-location": "method" - }, - "AlertRuleTemplateId": { - "description": "Alert rule template ID", - "in": "path", - "name": "alertRuleTemplateId", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, "ApiVersion": { "description": "API version for the operation", "enum": [ @@ -3611,24 +1286,6 @@ "required": true, "type": "string" }, - "Bookmark": { - "description": "The bookmark", - "in": "body", - "name": "bookmark", - "required": true, - "schema": { - "$ref": "#/definitions/Bookmark" - }, - "x-ms-parameter-location": "method" - }, - "BookmarkId": { - "description": "Bookmark ID", - "in": "path", - "name": "bookmarkId", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, "ConsentId": { "description": "consent ID", "in": "path", @@ -3637,24 +1294,6 @@ "type": "string", "x-ms-parameter-location": "method" }, - "DataConnector": { - "description": "The data connector", - "in": "body", - "name": "dataConnector", - "required": true, - "schema": { - "$ref": "#/definitions/DataConnector" - }, - "x-ms-parameter-location": "method" - }, - "DataConnectorId": { - "description": "Connector ID", - "in": "path", - "name": "dataConnectorId", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, "EntityId": { "description": "entity ID", "in": "path", @@ -3751,14 +1390,6 @@ "type": "string", "x-ms-parameter-location": "method" }, - "RuleId": { - "description": "Alert rule ID", - "in": "path", - "name": "ruleId", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, "Settings": { "description": "The setting", "in": "body", diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/Incidents.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/Incidents.json new file mode 100644 index 000000000000..26908cd90380 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/Incidents.json @@ -0,0 +1,3820 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2021-04-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.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents": { + "get": { + "x-ms-examples": { + "Get all incidents.": { + "$ref": "./examples/incidents/GetIncidents.json" + } + }, + "tags": [ + "Incidents" + ], + "description": "Gets all incidents.", + "operationId": "Incidents_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/IncidentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}": { + "get": { + "x-ms-examples": { + "Get an incident.": { + "$ref": "./examples/incidents/GetIncidentById.json" + } + }, + "tags": [ + "Incidents" + ], + "description": "Gets a given incident.", + "operationId": "Incidents_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/Incident" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates an incident.": { + "$ref": "./examples/incidents/CreateIncident.json" + } + }, + "tags": [ + "Incidents" + ], + "description": "Creates or updates an incident.", + "operationId": "Incidents_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/Incident" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/Incident" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Incident" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete an incident.": { + "$ref": "./examples/incidents/DeleteIncident.json" + } + }, + "tags": [ + "Incidents" + ], + "description": "Deletes a given incident.", + "operationId": "Incidents_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/alerts": { + "post": { + "x-ms-examples": { + "Get all incident alerts.": { + "$ref": "./examples/incidents/GetAllIncidentAlerts.json" + } + }, + "tags": [ + "IncidentAlerts" + ], + "description": "Gets all alerts for an incident.", + "operationId": "Incidents_ListOfAlerts", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentAlertList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/bookmarks": { + "post": { + "x-ms-examples": { + "Get all incident bookmarks.": { + "$ref": "./examples/incidents/GetAllIncidentBookmarks.json" + } + }, + "tags": [ + "IncidentBookmarks" + ], + "description": "Gets all bookmarks for an incident.", + "operationId": "Incidents_ListOfBookmarks", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentBookmarkList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/comments": { + "get": { + "x-ms-examples": { + "Get all incident comments.": { + "$ref": "./examples/incidents/comments/GetAllIncidentComments.json" + } + }, + "tags": [ + "IncidentComments" + ], + "description": "Gets all comments for a given incident.", + "operationId": "IncidentComments_ListByIncident", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/IncidentCommentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/IncidentComment", + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/comments/{incidentCommentId}": { + "get": { + "x-ms-examples": { + "Get an incident comment.": { + "$ref": "./examples/incidents/comments/GetIncidentCommentById.json" + } + }, + "tags": [ + "IncidentComments" + ], + "description": "Gets a comment for a given incident.", + "operationId": "IncidentComments_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/IncidentCommentId" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/IncidentComment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates an incident comment.": { + "$ref": "./examples/incidents/comments/CreateIncidentComment.json" + } + }, + "tags": [ + "IncidentComments" + ], + "description": "Creates or updates a comment for a given incident.", + "operationId": "IncidentComments_CreateComment", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/IncidentCommentId" + }, + { + "$ref": "#/parameters/IncidentComment" + } + ], + "responses": { + "200": { + "description": "Updated", + "schema": { + "$ref": "#/definitions/IncidentComment" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/IncidentComment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete the incident comment.": { + "$ref": "./examples/incidents/comments/DeleteIncidentComment.json" + } + }, + "tags": [ + "IncidentComments" + ], + "description": "Deletes a comment for a given incident.", + "operationId": "IncidentComments_DeleteComment", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/IncidentCommentId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/entities": { + "post": { + "x-ms-examples": { + "Gets all incident related entities": { + "$ref": "./examples/incidents/GetAllIncidentEntities.json" + } + }, + "tags": [ + "IncidentEntities" + ], + "description": "Gets all entities for an incident.", + "operationId": "Incidents_ListOfEntities", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentEntitiesResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/relations": { + "get": { + "x-ms-examples": { + "Get all incident relations.": { + "$ref": "./examples/incidents/relations/GetAllIncidentRelations.json" + } + }, + "tags": [ + "IncidentRelations" + ], + "description": "Gets all relations for a given incident.", + "operationId": "IncidentRelations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RelationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/Relation", + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/relations/{relationName}": { + "get": { + "x-ms-examples": { + "Get an incident relation.": { + "$ref": "./examples/incidents/relations/GetIncidentRelationByName.json" + } + }, + "tags": [ + "IncidentRelations" + ], + "description": "Gets a relation for a given incident.", + "operationId": "IncidentRelations_GetRelation", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/RelationName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Relation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates an incident relation.": { + "$ref": "./examples/incidents/relations/CreateIncidentRelation.json" + } + }, + "tags": [ + "IncidentRelations" + ], + "description": "Creates or updates a relation for a given incident.", + "operationId": "IncidentRelations_CreateOrUpdateRelation", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/RelationName" + }, + { + "$ref": "#/parameters/Relation" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Relation" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Relation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete the incident relation.": { + "$ref": "./examples/incidents/relations/DeleteIncidentRelation.json" + } + }, + "tags": [ + "IncidentRelations" + ], + "description": "Deletes a relation for a given incident.", + "operationId": "IncidentRelations_DeleteRelation", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/RelationName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "AccountEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents an account entity.", + "properties": { + "properties": { + "$ref": "#/definitions/AccountEntityProperties", + "description": "Account entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Account" + }, + "AccountEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Account entity property bag.", + "properties": { + "aadTenantId": { + "description": "The Azure Active Directory tenant id.", + "readOnly": true, + "type": "string" + }, + "aadUserId": { + "description": "The Azure Active Directory user id.", + "readOnly": true, + "type": "string" + }, + "accountName": { + "description": "The name of the account. This field should hold only the name without any domain added to it, i.e. administrator.", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "The display name of the account.", + "readOnly": true, + "type": "string" + }, + "hostEntityId": { + "description": "The Host entity id that contains the account in case it is a local account (not domain joined)", + "readOnly": true, + "type": "string" + }, + "isDomainJoined": { + "description": "Determines whether this is a domain account.", + "readOnly": true, + "type": "boolean" + }, + "ntDomain": { + "description": "The NetBIOS domain name as it appears in the alert format – domain\\username. Examples: NT AUTHORITY.", + "readOnly": true, + "type": "string" + }, + "objectGuid": { + "description": "The objectGUID attribute is a single-value attribute that is the unique identifier for the object, assigned by active directory.", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "puid": { + "description": "The Azure Active Directory Passport User ID.", + "readOnly": true, + "type": "string" + }, + "sid": { + "description": "The account security identifier, e.g. S-1-5-18.", + "readOnly": true, + "type": "string" + }, + "upnSuffix": { + "description": "The user principal name suffix for the account, in some cases it is also the domain name. Examples: contoso.com.", + "readOnly": true, + "type": "string" + }, + "dnsDomain": { + "description": "The fully qualified domain DNS name.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AlertSeverity": { + "description": "The severity of the alert", + "enum": [ + "High", + "Medium", + "Low", + "Informational" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AlertSeverity", + "values": [ + { + "description": "High severity", + "value": "High" + }, + { + "description": "Medium severity", + "value": "Medium" + }, + { + "description": "Low severity", + "value": "Low" + }, + { + "description": "Informational severity", + "value": "Informational" + } + ] + } + }, + "AttackTactic": { + "description": "The severity for alerts created by this alert rule.", + "enum": [ + "InitialAccess", + "Execution", + "Persistence", + "PrivilegeEscalation", + "DefenseEvasion", + "CredentialAccess", + "Discovery", + "LateralMovement", + "Collection", + "Exfiltration", + "CommandAndControl", + "Impact" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AttackTactic" + } + }, + "AzureResourceEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents an azure resource entity.", + "properties": { + "properties": { + "$ref": "#/definitions/AzureResourceEntityProperties", + "description": "AzureResource entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AzureResource" + }, + "AzureResourceEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "AzureResource entity property bag.", + "properties": { + "resourceId": { + "description": "The azure resource id of the resource", + "readOnly": true, + "type": "string" + }, + "subscriptionId": { + "description": "The subscription id of the resource", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ClientInfo": { + "description": "Information on the client (user or application) that made some action", + "properties": { + "email": { + "description": "The email of the client.", + "type": "string" + }, + "name": { + "description": "The name of the client.", + "type": "string" + }, + "objectId": { + "description": "The object id of the client.", + "format": "uuid", + "type": "string" + }, + "userPrincipalName": { + "description": "The user principal name of the client.", + "type": "string" + } + }, + "type": "object" + }, + "CloudApplicationEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a cloud application entity.", + "properties": { + "properties": { + "$ref": "#/definitions/CloudApplicationEntityProperties", + "description": "CloudApplication entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "CloudApplication" + }, + "CloudApplicationEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "CloudApplication entity property bag.", + "properties": { + "appId": { + "description": "The technical identifier of the application.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "appName": { + "description": "The name of the related cloud application.", + "readOnly": true, + "type": "string" + }, + "instanceName": { + "description": "The user defined instance name of the cloud application. It is often used to distinguish between several applications of the same type that a customer has.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse", + "description": "The error object of the CloudError response" + } + }, + "type": "object", + "description": "An error response for a resource management request." + }, + "DnsEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a dns entity.", + "properties": { + "properties": { + "$ref": "#/definitions/DnsEntityProperties", + "description": "Dns entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "DnsResolution" + }, + "DnsEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Dns entity property bag.", + "properties": { + "dnsServerIpEntityId": { + "description": "An ip entity id for the dns server resolving the request", + "readOnly": true, + "type": "string" + }, + "domainName": { + "description": "The name of the dns record associated with the alert", + "readOnly": true, + "type": "string" + }, + "hostIpAddressEntityId": { + "description": "An ip entity id for the dns request client", + "readOnly": true, + "type": "string" + }, + "ipAddressEntityIds": { + "description": "Ip entity identifiers for the resolved ip address.", + "items": { + "description": "Ip entity id", + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "Entity": { + "allOf": [ + { + "$ref": "../../../common/1.0/types.json#/definitions/Resource" + }, + { + "$ref": "#/definitions/EntityKind" + } + ], + "description": "Specific entity.", + "discriminator": "kind", + "type": "object", + "required": [ + "kind" + ] + }, + "EntityCommonProperties": { + "description": "Entity common property bag.", + "properties": { + "additionalData": { + "additionalProperties": { + "type": "object" + }, + "description": "A bag of custom fields that should be part of the entity and will be presented to the user.", + "readOnly": true, + "type": "object" + }, + "friendlyName": { + "description": "The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "EntityEdges": { + "description": "The edge that connects the entity to the other entity.", + "properties": { + "targetEntityId": { + "description": "The target entity Id.", + "type": "string" + }, + "additionalData": { + "additionalProperties": { + "type": "object" + }, + "description": "A bag of custom fields that should be part of the entity and will be presented to the user.", + "type": "object" + } + }, + "type": "object" + }, + "EntityInnerKind": { + "description": "The kind of the entity", + "enum": [ + "Account", + "Host", + "File", + "AzureResource", + "CloudApplication", + "DnsResolution", + "FileHash", + "Ip", + "Malware", + "Process", + "RegistryKey", + "RegistryValue", + "SecurityGroup", + "Url", + "IoTDevice", + "SecurityAlert", + "Bookmark", + "Mailbox", + "MailCluster", + "MailMessage", + "SubmissionMail" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "EntityKindEnum", + "values": [ + { + "description": "Entity represents account in the system.", + "value": "Account" + }, + { + "description": "Entity represents host in the system.", + "value": "Host" + }, + { + "description": "Entity represents file in the system.", + "value": "File" + }, + { + "description": "Entity represents azure resource in the system.", + "value": "AzureResource" + }, + { + "description": "Entity represents cloud application in the system.", + "value": "CloudApplication" + }, + { + "description": "Entity represents dns resolution in the system.", + "value": "DnsResolution" + }, + { + "description": "Entity represents file hash in the system.", + "value": "FileHash" + }, + { + "description": "Entity represents ip in the system.", + "value": "Ip" + }, + { + "description": "Entity represents malware in the system.", + "value": "Malware" + }, + { + "description": "Entity represents process in the system.", + "value": "Process" + }, + { + "description": "Entity represents registry key in the system.", + "value": "RegistryKey" + }, + { + "description": "Entity represents registry value in the system.", + "value": "RegistryValue" + }, + { + "description": "Entity represents security group in the system.", + "value": "SecurityGroup" + }, + { + "description": "Entity represents url in the system.", + "value": "Url" + }, + { + "description": "Entity represents IoT device in the system.", + "value": "IoTDevice" + }, + { + "description": "Entity represents security alert in the system.", + "value": "SecurityAlert" + }, + { + "description": "Entity represents bookmark in the system.", + "value": "Bookmark" + }, + { + "description": "Entity represents mail cluster in the system.", + "value": "MailCluster" + }, + { + "description": "Entity represents mail message in the system.", + "value": "MailMessage" + }, + { + "description": "Entity represents mailbox in the system.", + "value": "Mailbox" + }, + { + "description": "Entity represents submission mail in the system.", + "value": "SubmissionMail" + } + ] + } + }, + "EntityKind": { + "description": "Describes an entity with kind.", + "properties": { + "kind": { + "$ref": "#/definitions/EntityInnerKind", + "description": "The kind of the entity." + } + }, + "required": [ + "kind" + ], + "type": "object" + }, + "FileEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a file entity.", + "properties": { + "properties": { + "$ref": "#/definitions/FileEntityProperties", + "description": "File entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "File" + }, + "FileEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "File entity property bag.", + "properties": { + "directory": { + "description": "The full path to the file.", + "readOnly": true, + "type": "string" + }, + "fileHashEntityIds": { + "description": "The file hash entity identifiers associated with this file", + "items": { + "description": "file hash id", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "fileName": { + "description": "The file name without path (some alerts might not include path).", + "readOnly": true, + "type": "string" + }, + "hostEntityId": { + "description": "The Host entity id which the file belongs to", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "FileHashEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a file hash entity.", + "properties": { + "properties": { + "$ref": "#/definitions/FileHashEntityProperties", + "description": "FileHash entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "FileHash" + }, + "FileHashEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "FileHash entity property bag.", + "properties": { + "algorithm": { + "description": "The hash algorithm type.", + "enum": [ + "Unknown", + "MD5", + "SHA1", + "SHA256", + "SHA256AC" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "FileHashAlgorithm", + "values": [ + { + "description": "Unknown hash algorithm", + "value": "Unknown" + }, + { + "description": "MD5 hash type", + "value": "MD5" + }, + { + "description": "SHA1 hash type", + "value": "SHA1" + }, + { + "description": "SHA256 hash type", + "value": "SHA256" + }, + { + "description": "SHA256 Authenticode hash type", + "value": "SHA256AC" + } + ] + } + }, + "hashValue": { + "description": "The file hash value.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GeoLocation": { + "description": "The geo-location context attached to the ip entity", + "properties": { + "asn": { + "description": "Autonomous System Number", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "city": { + "description": "City name", + "readOnly": true, + "type": "string" + }, + "countryCode": { + "description": "The country code according to ISO 3166 format", + "readOnly": true, + "type": "string" + }, + "countryName": { + "description": "Country name according to ISO 3166 Alpha 2: the lowercase of the English Short Name", + "readOnly": true, + "type": "string" + }, + "latitude": { + "description": "The longitude of the identified location, expressed as a floating point number with range of -180 to 180, with positive numbers representing East and negative numbers representing West. Latitude and longitude are derived from the city or postal code.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "longitude": { + "description": "The latitude of the identified location, expressed as a floating point number with range of - 90 to 90, with positive numbers representing North and negative numbers representing South. Latitude and longitude are derived from the city or postal code.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "state": { + "description": "State name", + "readOnly": true, + "type": "string" + } + }, + "readOnly": true, + "type": "object" + }, + "HostEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a host entity.", + "properties": { + "properties": { + "$ref": "#/definitions/HostEntityProperties", + "description": "Host entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Host" + }, + "HostEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Host entity property bag.", + "properties": { + "azureID": { + "description": "The azure resource id of the VM.", + "readOnly": true, + "type": "string" + }, + "dnsDomain": { + "description": "The DNS domain that this host belongs to. Should contain the compete DNS suffix for the domain", + "readOnly": true, + "type": "string" + }, + "hostName": { + "description": "The hostname without the domain suffix.", + "readOnly": true, + "type": "string" + }, + "isDomainJoined": { + "description": "Determines whether this host belongs to a domain.", + "readOnly": true, + "type": "boolean" + }, + "netBiosName": { + "description": "The host name (pre-windows2000).", + "readOnly": true, + "type": "string" + }, + "ntDomain": { + "description": "The NT domain that this host belongs to.", + "readOnly": true, + "type": "string" + }, + "omsAgentID": { + "description": "The OMS agent id, if the host has OMS agent installed.", + "readOnly": true, + "type": "string" + }, + "osFamily": { + "description": "The operating system type.", + "enum": [ + "Linux", + "Windows", + "Android", + "IOS", + "Unknown" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": false, + "name": "OSFamily", + "values": [ + { + "description": "Host with Linux operating system.", + "value": "Linux" + }, + { + "description": "Host with Windows operating system.", + "value": "Windows" + }, + { + "description": "Host with Android operating system.", + "value": "Android" + }, + { + "description": "Host with IOS operating system.", + "value": "IOS" + }, + { + "description": "Host with Unknown operating system.", + "value": "Unknown" + } + ] + } + }, + "osVersion": { + "description": "A free text representation of the operating system. This field is meant to hold specific versions the are more fine grained than OSFamily or future values not supported by OSFamily enumeration", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "HuntingBookmark": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a Hunting bookmark entity.", + "properties": { + "properties": { + "$ref": "#/definitions/HuntingBookmarkProperties", + "description": "HuntingBookmark entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Bookmark" + }, + "HuntingBookmarkProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Describes bookmark properties", + "properties": { + "created": { + "description": "The time the bookmark was created", + "format": "date-time", + "type": "string" + }, + "createdBy": { + "$ref": "#/definitions/UserInfo", + "description": "Describes a user that created the bookmark", + "type": "object" + }, + "displayName": { + "description": "The display name of the bookmark", + "type": "string" + }, + "eventTime": { + "description": "The time of the event", + "format": "date-time", + "type": "string" + }, + "labels": { + "description": "List of labels relevant to this bookmark", + "items": { + "$ref": "#/definitions/Label" + }, + "type": "array" + }, + "notes": { + "description": "The notes of the bookmark", + "type": "string" + }, + "query": { + "description": "The query of the bookmark.", + "type": "string" + }, + "queryResult": { + "description": "The query result of the bookmark.", + "type": "string" + }, + "updated": { + "description": "The last time the bookmark was updated", + "format": "date-time", + "type": "string" + }, + "updatedBy": { + "$ref": "#/definitions/UserInfo", + "description": "Describes a user that updated the bookmark", + "type": "object" + }, + "incidentInfo": { + "$ref": "#/definitions/IncidentInfo", + "description": "Describes an incident that relates to bookmark", + "type": "object" + } + }, + "required": [ + "displayName", + "query" + ], + "type": "object" + }, + "Incident": { + "allOf": [ + { + "$ref": "../../../common/1.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents an incident in Azure Security Insights.", + "properties": { + "properties": { + "$ref": "#/definitions/IncidentProperties", + "description": "Incident properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "IncidentAdditionalData": { + "description": "Incident additional data property bag.", + "properties": { + "alertsCount": { + "description": "The number of alerts in the incident", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "bookmarksCount": { + "description": "The number of bookmarks in the incident", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "commentsCount": { + "description": "The number of comments in the incident", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "alertProductNames": { + "description": "List of product names of alerts in the incident", + "items": { + "description": "Alert product name", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "tactics": { + "description": "The tactics associated with incident", + "items": { + "$ref": "#/definitions/AttackTactic" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "IncidentAlertList": { + "description": "List of incident alerts.", + "properties": { + "value": { + "description": "Array of incident alerts.", + "type": "array", + "items": { + "$ref": "#/definitions/SecurityAlert" + } + } + }, + "required": [ + "value" + ] + }, + "IncidentBookmarkList": { + "description": "List of incident bookmarks.", + "properties": { + "value": { + "description": "Array of incident bookmarks.", + "type": "array", + "items": { + "$ref": "#/definitions/HuntingBookmark" + } + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "IncidentComment": { + "allOf": [ + { + "$ref": "../../../common/1.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents an incident comment", + "properties": { + "properties": { + "$ref": "#/definitions/IncidentCommentProperties", + "description": "Incident comment properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "IncidentCommentList": { + "description": "List of incident comments.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of comments.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of comments.", + "items": { + "$ref": "#/definitions/IncidentComment" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "IncidentCommentProperties": { + "description": "Incident comment property bag.", + "properties": { + "createdTimeUtc": { + "description": "The time the comment was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "lastModifiedTimeUtc": { + "description": "The time the comment was updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "The comment message", + "type": "string" + }, + "author": { + "$ref": "#/definitions/ClientInfo", + "description": "Describes the client that created the comment", + "readOnly": true, + "type": "object" + } + }, + "required": [ + "message" + ], + "type": "object" + }, + "IncidentEntitiesResponse": { + "description": "The incident related entities response.", + "type": "object", + "properties": { + "entities": { + "description": "Array of the incident related entities.", + "type": "array", + "items": { + "$ref": "#/definitions/Entity" + } + }, + "metaData": { + "description": "The metadata from the incident related entities results.", + "type": "array", + "items": { + "$ref": "#/definitions/IncidentEntitiesResultsMetadata" + } + } + } + }, + "IncidentEntitiesResultsMetadata": { + "description": "Information of a specific aggregation in the incident related entities result.", + "properties": { + "count": { + "description": "Total number of aggregations of the given kind in the incident related entities result.", + "type": "integer", + "format": "int32" + }, + "entityKind": { + "$ref": "#/definitions/EntityInnerKind", + "description": "The kind of the aggregated entity." + } + }, + "required": [ + "entityKind", + "count" + ], + "type": "object" + }, + "IncidentInfo": { + "description": "Describes related incident information for the bookmark", + "properties": { + "incidentId": { + "description": "Incident Id", + "type": "string" + }, + "severity": { + "description": "The severity of the incident", + "enum": [ + "Critical", + "High", + "Medium", + "Low", + "Informational" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "CaseSeverity", + "values": [ + { + "description": "Critical severity", + "value": "Critical" + }, + { + "description": "High severity", + "value": "High" + }, + { + "description": "Medium severity", + "value": "Medium" + }, + { + "description": "Low severity", + "value": "Low" + }, + { + "description": "Informational severity", + "value": "Informational" + } + ] + } + }, + "title": { + "description": "The title of the incident", + "type": "string" + }, + "relationName": { + "description": "Relation Name", + "type": "string" + } + }, + "type": "object" + }, + "IncidentLabel": { + "description": "Represents an incident label", + "properties": { + "labelName": { + "description": "The name of the label", + "type": "string" + }, + "labelType": { + "description": "The type of the label", + "enum": [ + "User", + "System" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "modelAsString": true, + "name": "IncidentLabelType", + "values": [ + { + "description": "Label manually created by a user", + "value": "User" + }, + { + "description": "Label automatically created by the system", + "value": "System" + } + ] + } + } + }, + "required": [ + "labelName" + ], + "type": "object" + }, + "IncidentList": { + "description": "List all the incidents.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of incidents.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of incidents.", + "items": { + "$ref": "#/definitions/Incident" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "IncidentOwnerInfo": { + "description": "Information on the user an incident is assigned to", + "properties": { + "email": { + "description": "The email of the user the incident is assigned to.", + "type": "string" + }, + "assignedTo": { + "description": "The name of the user the incident is assigned to.", + "type": "string" + }, + "objectId": { + "description": "The object id of the user the incident is assigned to.", + "format": "uuid", + "type": "string" + }, + "userPrincipalName": { + "description": "The user principal name of the user the incident is assigned to.", + "type": "string" + } + }, + "type": "object" + }, + "IncidentProperties": { + "description": "Describes incident properties", + "properties": { + "additionalData": { + "$ref": "#/definitions/IncidentAdditionalData", + "description": "Additional data on the incident", + "readOnly": true, + "type": "object" + }, + "classification": { + "description": "The reason the incident was closed", + "enum": [ + "Undetermined", + "TruePositive", + "BenignPositive", + "FalsePositive" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "IncidentClassification", + "values": [ + { + "description": "Incident classification was undetermined", + "value": "Undetermined" + }, + { + "description": "Incident was true positive", + "value": "TruePositive" + }, + { + "description": "Incident was benign positive", + "value": "BenignPositive" + }, + { + "description": "Incident was false positive", + "value": "FalsePositive" + } + ] + } + }, + "classificationComment": { + "description": "Describes the reason the incident was closed", + "type": "string" + }, + "classificationReason": { + "description": "The classification reason the incident was closed with", + "enum": [ + "SuspiciousActivity", + "SuspiciousButExpected", + "IncorrectAlertLogic", + "InaccurateData" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "IncidentClassificationReason", + "values": [ + { + "description": "Classification reason was suspicious activity", + "value": "SuspiciousActivity" + }, + { + "description": "Classification reason was suspicious but expected", + "value": "SuspiciousButExpected" + }, + { + "description": "Classification reason was incorrect alert logic", + "value": "IncorrectAlertLogic" + }, + { + "description": "Classification reason was inaccurate data", + "value": "InaccurateData" + } + ] + } + }, + "createdTimeUtc": { + "description": "The time the incident was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "The description of the incident", + "type": "string" + }, + "firstActivityTimeUtc": { + "description": "The time of the first activity in the incident", + "format": "date-time", + "type": "string" + }, + "incidentUrl": { + "description": "The deep-link url to the incident in Azure portal", + "readOnly": true, + "type": "string" + }, + "incidentNumber": { + "description": "A sequential number", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "labels": { + "description": "List of labels relevant to this incident", + "items": { + "$ref": "#/definitions/IncidentLabel" + }, + "type": "array" + }, + "lastActivityTimeUtc": { + "description": "The time of the last activity in the incident", + "format": "date-time", + "type": "string" + }, + "lastModifiedTimeUtc": { + "description": "The last time the incident was updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "owner": { + "$ref": "#/definitions/IncidentOwnerInfo", + "description": "Describes a user that the incident is assigned to", + "type": "object" + }, + "relatedAnalyticRuleIds": { + "description": "List of resource ids of Analytic rules related to the incident", + "items": { + "description": "Related Analytic rule resource id", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "severity": { + "description": "The severity of the incident", + "enum": [ + "High", + "Medium", + "Low", + "Informational" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "IncidentSeverity", + "values": [ + { + "description": "High severity", + "value": "High" + }, + { + "description": "Medium severity", + "value": "Medium" + }, + { + "description": "Low severity", + "value": "Low" + }, + { + "description": "Informational severity", + "value": "Informational" + } + ] + } + }, + "status": { + "description": "The status of the incident", + "enum": [ + "New", + "Active", + "Closed" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "IncidentStatus", + "values": [ + { + "description": "An active incident which isn't being handled currently", + "value": "New" + }, + { + "description": "An active incident which is being handled", + "value": "Active" + }, + { + "description": "A non-active incident", + "value": "Closed" + } + ] + } + }, + "title": { + "description": "The title of the incident", + "type": "string" + } + }, + "required": [ + "title", + "severity", + "status" + ], + "type": "object" + }, + "IoTDeviceEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents an IoT device entity.", + "properties": { + "properties": { + "$ref": "#/definitions/IoTDeviceEntityProperties", + "description": "IoTDevice entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "IoTDevice" + }, + "IoTDeviceEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "IoTDevice entity property bag.", + "properties": { + "deviceId": { + "description": "The ID of the IoT Device in the IoT Hub", + "readOnly": true, + "type": "string" + }, + "deviceName": { + "description": "The friendly name of the device", + "readOnly": true, + "type": "string" + }, + "source": { + "description": "The source of the device", + "readOnly": true, + "type": "string" + }, + "iotSecurityAgentId": { + "description": "The ID of the security agent running on the device", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "deviceType": { + "description": "The type of the device", + "readOnly": true, + "type": "string" + }, + "vendor": { + "description": "The vendor of the device", + "readOnly": true, + "type": "string" + }, + "edgeId": { + "description": "The ID of the edge device", + "readOnly": true, + "type": "string" + }, + "macAddress": { + "description": "The MAC address of the device", + "readOnly": true, + "type": "string" + }, + "model": { + "description": "The model of the device", + "readOnly": true, + "type": "string" + }, + "serialNumber": { + "description": "The serial number of the device", + "readOnly": true, + "type": "string" + }, + "firmwareVersion": { + "description": "The firmware version of the device", + "readOnly": true, + "type": "string" + }, + "operatingSystem": { + "description": "The operating system of the device", + "readOnly": true, + "type": "string" + }, + "iotHubEntityId": { + "description": "The AzureResource entity id of the IoT Hub", + "readOnly": true, + "type": "string" + }, + "hostEntityId": { + "description": "The Host entity id of this device", + "readOnly": true, + "type": "string" + }, + "ipAddressEntityId": { + "description": "The IP entity if of this device", + "readOnly": true, + "type": "string" + }, + "threatIntelligence": { + "description": "A list of TI contexts attached to the IoTDevice entity.", + "items": { + "$ref": "#/definitions/ThreatIntelligence" + }, + "readOnly": true, + "type": "array" + }, + "protocols": { + "description": "A list of protocols of the IoTDevice entity.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "IpEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents an ip entity.", + "properties": { + "properties": { + "$ref": "#/definitions/IpEntityProperties", + "description": "Ip entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Ip" + }, + "IpEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Ip entity property bag.", + "properties": { + "address": { + "description": "The IP address as string, e.g. 127.0.0.1 (either in Ipv4 or Ipv6)", + "readOnly": true, + "type": "string" + }, + "location": { + "$ref": "#/definitions/GeoLocation", + "description": "The geo-location context attached to the ip entity" + }, + "threatIntelligence": { + "description": "A list of TI contexts attached to the ip entity.", + "items": { + "$ref": "#/definitions/ThreatIntelligence" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "Label": { + "description": "Label that will be used to tag and filter on.", + "type": "string" + }, + "MailboxEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a mailbox entity.", + "properties": { + "properties": { + "$ref": "#/definitions/MailboxEntityProperties", + "description": "Mailbox entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Mailbox" + }, + "MailboxEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Mailbox entity property bag.", + "properties": { + "mailboxPrimaryAddress": { + "description": "The mailbox's primary address", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "The mailbox's display name", + "readOnly": true, + "type": "string" + }, + "upn": { + "description": "The mailbox's UPN", + "readOnly": true, + "type": "string" + }, + "externalDirectoryObjectId": { + "description": "The AzureAD identifier of mailbox. Similar to AadUserId in account entity but this property is specific to mailbox object on office side", + "format": "uuid", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "MailClusterEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a mail cluster entity.", + "properties": { + "properties": { + "$ref": "#/definitions/MailClusterEntityProperties", + "description": "Mail cluster entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MailCluster" + }, + "MailClusterEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Mail cluster entity property bag.", + "properties": { + "networkMessageIds": { + "description": "The mail message IDs that are part of the mail cluster", + "items": { + "description": "A mail message ID", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "countByDeliveryStatus": { + "description": "Count of mail messages by DeliveryStatus string representation", + "readOnly": true, + "type": "object" + }, + "countByThreatType": { + "description": "Count of mail messages by ThreatType string representation", + "readOnly": true, + "type": "object" + }, + "countByProtectionStatus": { + "description": "Count of mail messages by ProtectionStatus string representation", + "readOnly": true, + "type": "object" + }, + "threats": { + "description": "The threats of mail messages that are part of the mail cluster", + "items": { + "description": "A threat", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "query": { + "description": "The query that was used to identify the messages of the mail cluster", + "readOnly": true, + "type": "string" + }, + "queryTime": { + "description": "The query time", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "mailCount": { + "description": "The number of mail messages that are part of the mail cluster", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "isVolumeAnomaly": { + "description": "Is this a volume anomaly mail cluster", + "readOnly": true, + "type": "boolean" + }, + "source": { + "description": "The source of the mail cluster (default is 'O365 ATP')", + "readOnly": true, + "type": "string" + }, + "clusterSourceIdentifier": { + "description": "The id of the cluster source", + "readOnly": true, + "type": "string" + }, + "clusterSourceType": { + "description": "The type of the cluster source", + "readOnly": true, + "type": "string" + }, + "clusterQueryStartTime": { + "description": "The cluster query start time", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "clusterQueryEndTime": { + "description": "The cluster query end time", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "clusterGroup": { + "description": "The cluster group", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "MailMessageEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a mail message entity.", + "properties": { + "properties": { + "$ref": "#/definitions/MailMessageEntityProperties", + "description": "Mail message entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MailMessage" + }, + "MailMessageEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Mail message entity property bag.", + "properties": { + "fileEntityIds": { + "description": "The File entity ids of this mail message's attachments", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "recipient": { + "description": "The recipient of this mail message. Note that in case of multiple recipients the mail message is forked and each copy has one recipient", + "readOnly": true, + "type": "string" + }, + "urls": { + "description": "The Urls contained in this mail message", + "items": { + "description": "A Url contained in this mail message", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "threats": { + "description": "The threats of this mail message", + "items": { + "description": "A threat of the mail message", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "p1Sender": { + "description": "The p1 sender's email address", + "readOnly": true, + "type": "string" + }, + "p1SenderDisplayName": { + "description": "The p1 sender's display name", + "readOnly": true, + "type": "string" + }, + "p1SenderDomain": { + "description": "The p1 sender's domain", + "readOnly": true, + "type": "string" + }, + "senderIP": { + "description": "The sender's IP address", + "readOnly": true, + "type": "string" + }, + "p2Sender": { + "description": "The p2 sender's email address", + "readOnly": true, + "type": "string" + }, + "p2SenderDisplayName": { + "description": "The p2 sender's display name", + "readOnly": true, + "type": "string" + }, + "p2SenderDomain": { + "description": "The p2 sender's domain", + "readOnly": true, + "type": "string" + }, + "receiveDate": { + "description": "The receive date of this message", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "networkMessageId": { + "description": "The network message id of this mail message", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "internetMessageId": { + "description": "The internet message id of this mail message", + "readOnly": true, + "type": "string" + }, + "subject": { + "description": "The subject of this mail message", + "readOnly": true, + "type": "string" + }, + "language": { + "description": "The language of this mail message", + "readOnly": true, + "type": "string" + }, + "threatDetectionMethods": { + "description": "The threat detection methods", + "items": { + "description": "A threat detection method", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "bodyFingerprintBin1": { + "description": "The bodyFingerprintBin1", + "type": "integer", + "format": "int32" + }, + "bodyFingerprintBin2": { + "description": "The bodyFingerprintBin2", + "type": "integer", + "format": "int32" + }, + "bodyFingerprintBin3": { + "description": "The bodyFingerprintBin3", + "type": "integer", + "format": "int32" + }, + "bodyFingerprintBin4": { + "description": "The bodyFingerprintBin4", + "type": "integer", + "format": "int32" + }, + "bodyFingerprintBin5": { + "description": "The bodyFingerprintBin5", + "type": "integer", + "format": "int32" + }, + "antispamDirection": { + "description": "The directionality of this mail message", + "enum": [ + "Unknown", + "Inbound", + "Outbound", + "Intraorg" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AntispamMailDirection", + "values": [ + { + "description": "Unknown", + "value": "Unknown" + }, + { + "description": "Inbound", + "value": "Inbound" + }, + { + "description": "Outbound", + "value": "Outbound" + }, + { + "description": "Intraorg", + "value": "Intraorg" + } + ] + } + }, + "deliveryAction": { + "description": "The delivery action of this mail message like Delivered, Blocked, Replaced etc", + "enum": [ + "Unknown", + "DeliveredAsSpam", + "Delivered", + "Blocked", + "Replaced" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": false, + "name": "DeliveryAction", + "values": [ + { + "description": "Unknown", + "value": "Unknown" + }, + { + "description": "DeliveredAsSpam", + "value": "DeliveredAsSpam" + }, + { + "description": "Delivered", + "value": "Delivered" + }, + { + "description": "Blocked", + "value": "Blocked" + }, + { + "description": "Replaced", + "value": "Replaced" + } + ] + } + }, + "deliveryLocation": { + "description": "The delivery location of this mail message like Inbox, JunkFolder etc", + "enum": [ + "Unknown", + "Inbox", + "JunkFolder", + "DeletedFolder", + "Quarantine", + "External", + "Failed", + "Dropped", + "Forwarded" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": false, + "name": "DeliveryLocation", + "values": [ + { + "description": "Unknown", + "value": "Unknown" + }, + { + "description": "Inbox", + "value": "Inbox" + }, + { + "description": "JunkFolder", + "value": "JunkFolder" + }, + { + "description": "DeletedFolder", + "value": "DeletedFolder" + }, + { + "description": "Quarantine", + "value": "Quarantine" + }, + { + "description": "External", + "value": "External" + }, + { + "description": "Failed", + "value": "Failed" + }, + { + "description": "Dropped", + "value": "Dropped" + }, + { + "description": "Forwarded", + "value": "Forwarded" + } + ] + } + } + }, + "type": "object" + }, + "MalwareEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a malware entity.", + "properties": { + "properties": { + "$ref": "#/definitions/MalwareEntityProperties", + "description": "File entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Malware" + }, + "MalwareEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Malware entity property bag.", + "properties": { + "category": { + "description": "The malware category by the vendor, e.g. Trojan", + "readOnly": true, + "type": "string" + }, + "fileEntityIds": { + "description": "List of linked file entity identifiers on which the malware was found", + "items": { + "description": "file entity id", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "malwareName": { + "description": "The malware name by the vendor, e.g. Win32/Toga!rfn", + "readOnly": true, + "type": "string" + }, + "processEntityIds": { + "description": "List of linked process entity identifiers on which the malware was found.", + "items": { + "description": "process entity id", + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "ProcessEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a process entity.", + "properties": { + "properties": { + "$ref": "#/definitions/ProcessEntityProperties", + "description": "Process entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Process" + }, + "ProcessEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Process entity property bag.", + "properties": { + "accountEntityId": { + "description": "The account entity id running the processes.", + "readOnly": true, + "type": "string" + }, + "commandLine": { + "description": "The command line used to create the process", + "readOnly": true, + "type": "string" + }, + "creationTimeUtc": { + "description": "The time when the process started to run", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "elevationToken": { + "description": "The elevation token associated with the process.", + "enum": [ + "Default", + "Full", + "Limited" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": false, + "name": "ElevationToken", + "values": [ + { + "description": "Default elevation token", + "value": "Default" + }, + { + "description": "Full elevation token", + "value": "Full" + }, + { + "description": "Limited elevation token", + "value": "Limited" + } + ] + } + }, + "hostEntityId": { + "description": "The host entity id on which the process was running", + "readOnly": true, + "type": "string" + }, + "hostLogonSessionEntityId": { + "description": "The session entity id in which the process was running", + "readOnly": true, + "type": "string" + }, + "imageFileEntityId": { + "description": "Image file entity id", + "readOnly": true, + "type": "string" + }, + "parentProcessEntityId": { + "description": "The parent process entity id.", + "readOnly": true, + "type": "string" + }, + "processId": { + "description": "The process ID", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "RegistryKeyEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a registry key entity.", + "properties": { + "properties": { + "$ref": "#/definitions/RegistryKeyEntityProperties", + "description": "RegistryKey entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "RegistryKey" + }, + "RegistryKeyEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "RegistryKey entity property bag.", + "properties": { + "hive": { + "description": "the hive that holds the registry key.", + "enum": [ + "HKEY_LOCAL_MACHINE", + "HKEY_CLASSES_ROOT", + "HKEY_CURRENT_CONFIG", + "HKEY_USERS", + "HKEY_CURRENT_USER_LOCAL_SETTINGS", + "HKEY_PERFORMANCE_DATA", + "HKEY_PERFORMANCE_NLSTEXT", + "HKEY_PERFORMANCE_TEXT", + "HKEY_A", + "HKEY_CURRENT_USER" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "RegistryHive", + "values": [ + { + "description": "HKEY_LOCAL_MACHINE", + "value": "HKEY_LOCAL_MACHINE" + }, + { + "description": "HKEY_CLASSES_ROOT", + "value": "HKEY_CLASSES_ROOT" + }, + { + "description": "HKEY_CURRENT_CONFIG", + "value": "HKEY_CURRENT_CONFIG" + }, + { + "description": "HKEY_USERS", + "value": "HKEY_USERS" + }, + { + "description": "HKEY_CURRENT_USER_LOCAL_SETTINGS", + "value": "HKEY_CURRENT_USER_LOCAL_SETTINGS" + }, + { + "description": "HKEY_PERFORMANCE_DATA", + "value": "HKEY_PERFORMANCE_DATA" + }, + { + "description": "HKEY_PERFORMANCE_NLSTEXT", + "value": "HKEY_PERFORMANCE_NLSTEXT" + }, + { + "description": "HKEY_PERFORMANCE_TEXT", + "value": "HKEY_PERFORMANCE_TEXT" + }, + { + "description": "HKEY_A", + "value": "HKEY_A" + }, + { + "description": "HKEY_CURRENT_USER", + "value": "HKEY_CURRENT_USER" + } + ] + } + }, + "key": { + "description": "The registry key path.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "RegistryValueEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a registry value entity.", + "properties": { + "properties": { + "$ref": "#/definitions/RegistryValueEntityProperties", + "description": "RegistryKey entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "RegistryValue" + }, + "RegistryValueEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "RegistryValue entity property bag.", + "properties": { + "keyEntityId": { + "description": "The registry key entity id.", + "readOnly": true, + "type": "string" + }, + "valueData": { + "description": "String formatted representation of the value data.", + "readOnly": true, + "type": "string" + }, + "valueName": { + "description": "The registry value name.", + "readOnly": true, + "type": "string" + }, + "valueType": { + "description": "Specifies the data types to use when storing values in the registry, or identifies the data type of a value in the registry.", + "enum": [ + "None", + "Unknown", + "String", + "ExpandString", + "Binary", + "DWord", + "MultiString", + "QWord" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "RegistryValueKind", + "values": [ + { + "description": "None", + "value": "None" + }, + { + "description": "Unknown value type", + "value": "Unknown" + }, + { + "description": "String value type", + "value": "String" + }, + { + "description": "ExpandString value type", + "value": "ExpandString" + }, + { + "description": "Binary value type", + "value": "Binary" + }, + { + "description": "DWord value type", + "value": "DWord" + }, + { + "description": "MultiString value type", + "value": "MultiString" + }, + { + "description": "QWord value type", + "value": "QWord" + } + ] + } + } + }, + "type": "object" + }, + "Relation": { + "type": "object", + "description": "Represents a relation between two resources", + "allOf": [ + { + "$ref": "../../../common/1.0/types.json#/definitions/ResourceWithEtag" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RelationProperties", + "description": "Relation properties", + "x-ms-client-flatten": true + } + } + }, + "RelationList": { + "description": "List of relations.", + "properties": { + "nextLink": { + "readOnly": true, + "description": "URL to fetch the next set of relations.", + "type": "string" + }, + "value": { + "description": "Array of relations.", + "type": "array", + "items": { + "$ref": "#/definitions/Relation" + } + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "RelationProperties": { + "description": "Relation property bag.", + "properties": { + "relatedResourceId": { + "description": "The resource ID of the related resource", + "type": "string" + }, + "relatedResourceName": { + "description": "The name of the related resource", + "readOnly": true, + "type": "string" + }, + "relatedResourceType": { + "description": "The resource type of the related resource", + "readOnly": true, + "type": "string" + }, + "relatedResourceKind": { + "description": "The resource kind of the related resource", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "relatedResourceId" + ], + "type": "object" + }, + "SecurityAlert": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a security alert entity.", + "properties": { + "properties": { + "$ref": "#/definitions/SecurityAlertProperties", + "description": "SecurityAlert entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "SecurityAlert" + }, + "SecurityAlertProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "SecurityAlert entity property bag.", + "properties": { + "alertDisplayName": { + "description": "The display name of the alert.", + "readOnly": true, + "type": "string" + }, + "alertType": { + "description": "The type name of the alert.", + "readOnly": true, + "type": "string" + }, + "compromisedEntity": { + "description": "Display name of the main entity being reported on.", + "readOnly": true, + "type": "string" + }, + "confidenceLevel": { + "description": "The confidence level of this alert.", + "enum": [ + "Unknown", + "Low", + "High" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ConfidenceLevel", + "values": [ + { + "description": "Unknown confidence, the is the default value", + "value": "Unknown" + }, + { + "description": "Low confidence, meaning we have some doubts this is indeed malicious or part of an attack", + "value": "Low" + }, + { + "description": "High confidence that the alert is true positive malicious", + "value": "High" + } + ] + } + }, + "confidenceReasons": { + "description": "The confidence reasons", + "items": { + "description": "confidence reason item", + "properties": { + "reason": { + "description": "The reason's description", + "readOnly": true, + "type": "string" + }, + "reasonType": { + "description": "The type (category) of the reason", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "readOnly": true, + "type": "array" + }, + "confidenceScore": { + "description": "The confidence score of the alert.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "confidenceScoreStatus": { + "description": "The confidence score calculation status, i.e. indicating if score calculation is pending for this alert, not applicable or final.", + "enum": [ + "NotApplicable", + "InProcess", + "NotFinal", + "Final" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ConfidenceScoreStatus", + "values": [ + { + "description": "Score will not be calculated for this alert as it is not supported by virtual analyst", + "value": "NotApplicable" + }, + { + "description": "No score was set yet and calculation is in progress", + "value": "InProcess" + }, + { + "description": "Score is calculated and shown as part of the alert, but may be updated again at a later time following the processing of additional data", + "value": "NotFinal" + }, + { + "description": "Final score was calculated and available", + "value": "Final" + } + ] + } + }, + "description": { + "description": "Alert description.", + "readOnly": true, + "type": "string" + }, + "endTimeUtc": { + "description": "The impact end time of the alert (the time of the last event contributing to the alert).", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "intent": { + "description": "Holds the alert intent stage(s) mapping for this alert.", + "enum": [ + "Unknown", + "Probing", + "Exploitation", + "Persistence", + "PrivilegeEscalation", + "DefenseEvasion", + "CredentialAccess", + "Discovery", + "LateralMovement", + "Execution", + "Collection", + "Exfiltration", + "CommandAndControl", + "Impact" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "KillChainIntent", + "values": [ + { + "description": "The default value.", + "value": "Unknown" + }, + { + "description": "Probing could be an attempt to access a certain resource regardless of a malicious intent or a failed attempt to gain access to a target system to gather information prior to exploitation. This step is usually detected as an attempt originating from outside the network in attempt to scan the target system and find a way in.", + "value": "Probing" + }, + { + "description": "Exploitation is the stage where an attacker manage to get foothold on the attacked resource. This stage is applicable not only for compute hosts, but also for resources such as user accounts, certificates etc. Adversaries will often be able to control the resource after this stage.", + "value": "Exploitation" + }, + { + "description": "Persistence is any access, action, or configuration change to a system that gives an adversary a persistent presence on that system. Adversaries will often need to maintain access to systems through interruptions such as system restarts, loss of credentials, or other failures that would require a remote access tool to restart or alternate backdoor for them to regain access.", + "value": "Persistence" + }, + { + "description": "Privilege escalation is the result of actions that allow an adversary to obtain a higher level of permissions on a system or network. Certain tools or actions require a higher level of privilege to work and are likely necessary at many points throughout an operation. User accounts with permissions to access specific systems or perform specific functions necessary for adversaries to achieve their objective may also be considered an escalation of privilege.", + "value": "PrivilegeEscalation" + }, + { + "description": "Defense evasion consists of techniques an adversary may use to evade detection or avoid other defenses. Sometimes these actions are the same as or variations of techniques in other categories that have the added benefit of subverting a particular defense or mitigation. ", + "value": "DefenseEvasion" + }, + { + "description": "Credential access represents techniques resulting in access to or control over system, domain, or service credentials that are used within an enterprise environment. Adversaries will likely attempt to obtain legitimate credentials from users or administrator accounts (local system administrator or domain users with administrator access) to use within the network. With sufficient access within a network, an adversary can create accounts for later use within the environment.", + "value": "CredentialAccess" + }, + { + "description": "Discovery consists of techniques that allow the adversary to gain knowledge about the system and internal network. When adversaries gain access to a new system, they must orient themselves to what they now have control of and what benefits operating from that system give to their current objective or overall goals during the intrusion. The operating system provides many native tools that aid in this post-compromise information-gathering phase.", + "value": "Discovery" + }, + { + "description": "Lateral movement consists of techniques that enable an adversary to access and control remote systems on a network and could, but does not necessarily, include execution of tools on remote systems. The lateral movement techniques could allow an adversary to gather information from a system without needing additional tools, such as a remote access tool. An adversary can use lateral movement for many purposes, including remote Execution of tools, pivoting to additional systems, access to specific information or files, access to additional credentials, or to cause an effect.", + "value": "LateralMovement" + }, + { + "description": "The execution tactic represents techniques that result in execution of adversary-controlled code on a local or remote system. This tactic is often used in conjunction with lateral movement to expand access to remote systems on a network.", + "value": "Execution" + }, + { + "description": "Collection consists of techniques used to identify and gather information, such as sensitive files, from a target network prior to exfiltration. This category also covers locations on a system or network where the adversary may look for information to exfiltrate.", + "value": "Collection" + }, + { + "description": "Exfiltration refers to techniques and attributes that result or aid in the adversary removing files and information from a target network. This category also covers locations on a system or network where the adversary may look for information to exfiltrate.", + "value": "Exfiltration" + }, + { + "description": "The command and control tactic represents how adversaries communicate with systems under their control within a target network.", + "value": "CommandAndControl" + }, + { + "description": "The impact intent primary objective is to directly reduce the availability or integrity of a system, service, or network; including manipulation of data to impact a business or operational process. This would often refer to techniques such as ransom-ware, defacement, data manipulation and others.", + "value": "Impact" + } + ] + } + }, + "providerAlertId": { + "description": "The identifier of the alert inside the product which generated the alert.", + "readOnly": true, + "type": "string" + }, + "processingEndTime": { + "description": "The time the alert was made available for consumption.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "productComponentName": { + "description": "The name of a component inside the product which generated the alert.", + "readOnly": true, + "type": "string" + }, + "productName": { + "description": "The name of the product which published this alert.", + "readOnly": true, + "type": "string" + }, + "productVersion": { + "description": "The version of the product generating the alert.", + "readOnly": true, + "type": "string" + }, + "remediationSteps": { + "description": "Manual action items to take to remediate the alert.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "severity": { + "$ref": "#/definitions/AlertSeverity", + "description": "The severity of the alert" + }, + "startTimeUtc": { + "description": "The impact start time of the alert (the time of the first event contributing to the alert).", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "The lifecycle status of the alert.", + "enum": [ + "Unknown", + "New", + "Resolved", + "Dismissed", + "InProgress" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AlertStatus", + "values": [ + { + "description": "Unknown value", + "value": "Unknown" + }, + { + "description": "New alert", + "value": "New" + }, + { + "description": "Alert closed after handling", + "value": "Resolved" + }, + { + "description": "Alert dismissed as false positive", + "value": "Dismissed" + }, + { + "description": "Alert is being handled", + "value": "InProgress" + } + ] + } + }, + "systemAlertId": { + "description": "Holds the product identifier of the alert for the product.", + "readOnly": true, + "type": "string" + }, + "tactics": { + "description": "The tactics of the alert", + "items": { + "$ref": "#/definitions/AttackTactic" + }, + "readOnly": true, + "type": "array" + }, + "timeGenerated": { + "description": "The time the alert was generated.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "vendorName": { + "description": "The name of the vendor that raise the alert.", + "readOnly": true, + "type": "string" + }, + "alertLink": { + "description": "The uri link of the alert.", + "readOnly": true, + "type": "string" + }, + "resourceIdentifiers": { + "description": "The list of resource identifiers of the alert.", + "items": { + "type": "object" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "SecurityGroupEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a security group entity.", + "properties": { + "properties": { + "$ref": "#/definitions/SecurityGroupEntityProperties", + "description": "SecurityGroup entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "SecurityGroup" + }, + "SecurityGroupEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "SecurityGroup entity property bag.", + "properties": { + "distinguishedName": { + "description": "The group distinguished name", + "readOnly": true, + "type": "string" + }, + "objectGuid": { + "description": "A single-value attribute that is the unique identifier for the object, assigned by active directory.", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "sid": { + "description": "The SID attribute is a single-value attribute that specifies the security identifier (SID) of the group", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "SubmissionMailEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a submission mail entity.", + "properties": { + "properties": { + "$ref": "#/definitions/SubmissionMailEntityProperties", + "description": "Submission mail entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "SubmissionMail" + }, + "SubmissionMailEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Submission mail entity property bag.", + "properties": { + "networkMessageId": { + "description": "The network message id of email to which submission belongs", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "submissionId": { + "description": "The submission id", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "submitter": { + "description": "The submitter", + "readOnly": true, + "type": "string" + }, + "submissionDate": { + "description": "The submission date", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "timestamp": { + "description": "The Time stamp when the message is received (Mail)", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "recipient": { + "description": "The recipient of the mail", + "readOnly": true, + "type": "string" + }, + "sender": { + "description": "The sender of the mail", + "readOnly": true, + "type": "string" + }, + "senderIp": { + "description": "The sender's IP", + "readOnly": true, + "type": "string" + }, + "subject": { + "description": "The subject of submission mail", + "readOnly": true, + "type": "string" + }, + "reportType": { + "description": "The submission type for the given instance. This maps to Junk, Phish, Malware or NotJunk.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ThreatIntelligence": { + "description": "ThreatIntelligence property bag.", + "properties": { + "confidence": { + "description": "Confidence (must be between 0 and 1)", + "format": "double", + "readOnly": true, + "type": "number" + }, + "providerName": { + "description": "Name of the provider from whom this Threat Intelligence information was received", + "readOnly": true, + "type": "string" + }, + "reportLink": { + "description": "Report link", + "readOnly": true, + "type": "string" + }, + "threatDescription": { + "description": "Threat description (free text)", + "readOnly": true, + "type": "string" + }, + "threatName": { + "description": "Threat name (e.g. \"Jedobot malware\")", + "readOnly": true, + "type": "string" + }, + "threatType": { + "description": "Threat type (e.g. \"Botnet\")", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "UrlEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a url entity.", + "properties": { + "properties": { + "$ref": "#/definitions/UrlEntityProperties", + "description": "Url entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Url" + }, + "UrlEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Url entity property bag.", + "properties": { + "url": { + "description": "A full URL the entity points to", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "UserInfo": { + "description": "User information that made some action", + "properties": { + "email": { + "description": "The email of the user.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the user.", + "readOnly": true, + "type": "string" + }, + "objectId": { + "description": "The object id of the user.", + "format": "uuid", + "type": "string", + "x-nullable": true + } + }, + "type": "object" + } + }, + "parameters": { + "Incident": { + "description": "The incident", + "in": "body", + "name": "incident", + "required": true, + "schema": { + "$ref": "#/definitions/Incident" + }, + "x-ms-parameter-location": "method" + }, + "IncidentComment": { + "description": "The incident comment", + "in": "body", + "name": "incidentComment", + "required": true, + "schema": { + "$ref": "#/definitions/IncidentComment" + }, + "x-ms-parameter-location": "method" + }, + "IncidentCommentId": { + "description": "Incident comment ID", + "in": "path", + "name": "incidentCommentId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "IncidentId": { + "description": "Incident ID", + "in": "path", + "name": "incidentId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Relation": { + "name": "relation", + "in": "body", + "description": "The relation model", + "required": true, + "schema": { + "$ref": "#/definitions/Relation" + }, + "x-ms-parameter-location": "method" + }, + "RelationName": { + "name": "relationName", + "in": "path", + "required": true, + "type": "string", + "description": "Relation Name", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/ThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/ThreatIntelligence.json new file mode 100644 index 000000000000..d8da42a17331 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/ThreatIntelligence.json @@ -0,0 +1,1183 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2021-04-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/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/createIndicator": { + "post": { + "x-ms-examples": { + "Create a new Threat Intelligence": { + "$ref": "./examples/threatintelligence/CreateThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Create a new threat intelligence indicator.", + "operationId": "ThreatIntelligenceIndicator_CreateIndicator", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceProperties" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed to create indicators.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators": { + "get": { + "x-ms-examples": { + "Get all threat intelligence indicators": { + "$ref": "./examples/threatintelligence/GetThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Get all threat intelligence indicators.", + "operationId": "ThreatIntelligenceIndicators_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ODataFilter" + }, + { + "$ref": "#/parameters/ODataTop" + }, + { + "$ref": "#/parameters/ODataSkipToken" + }, + { + "$ref": "#/parameters/ODataOrderBy" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformationList" + } + }, + "default": { + "description": "Error response describing why the operation failed to get indicators.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators/{name}": { + "get": { + "x-ms-examples": { + "View a threat intelligence indicator by name": { + "$ref": "./examples/threatintelligence/GetThreatIntelligenceById.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "View a threat intelligence indicator by name.", + "operationId": "ThreatIntelligenceIndicator_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed to view an indicator.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Update a threat Intelligence indicator": { + "$ref": "./examples/threatintelligence/UpdateThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Update a threat Intelligence indicator.", + "operationId": "ThreatIntelligenceIndicator_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceProperties" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed to update an indicator.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a threat intelligence indicator": { + "$ref": "./examples/threatintelligence/DeleteThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Delete a threat intelligence indicator.", + "operationId": "ThreatIntelligenceIndicator_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed to delete an indicator.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/queryIndicators": { + "post": { + "x-ms-examples": { + "Query threat intelligence indicators as per filtering criteria": { + "$ref": "./examples/threatintelligence/QueryThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Query threat intelligence indicators as per filtering criteria.", + "operationId": "ThreatIntelligenceIndicator_QueryIndicators", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceFilteringCriteria" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/metrics": { + "get": { + "x-ms-examples": { + "Get threat intelligence indicators metrics.": { + "$ref": "./examples/threatintelligence/CollectThreatIntelligenceMetrics.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Get threat intelligence indicators metrics (Indicators counts by Type, Threat Type, Source).", + "operationId": "ThreatIntelligenceIndicatorMetrics_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceMetricsList" + } + }, + "default": { + "description": "Error response describing why the operation failed to get metrics.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators/{name}/appendTags": { + "post": { + "x-ms-examples": { + "Append tags to a threat intelligence indicator": { + "$ref": "./examples/threatintelligence/AppendTagsThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Append tags to a threat intelligence indicator.", + "operationId": "ThreatIntelligenceIndicator_AppendTags", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceAppendTags" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed to append tags.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators/{name}/replaceTags": { + "post": { + "x-ms-examples": { + "Replace tags to a Threat Intelligence": { + "$ref": "./examples/threatintelligence/ReplaceTagsThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Replace tags added to a threat intelligence indicator.", + "operationId": "ThreatIntelligenceIndicator_ReplaceTags", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceReplaceTags" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed to replace tags.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse", + "description": "The error object of the CloudError response" + } + }, + "description": "An error response for a resource management request." + }, + "ThreatIntelligenceInformation": { + "allOf": [ + { + "$ref": "../../../common/1.0/types.json#/definitions/ResourceWithEtag" + }, + { + "$ref": "#/definitions/ThreatIntelligenceResourceKind" + } + ], + "description": "Threat intelligence information object.", + "discriminator": "kind", + "type": "object", + "required": [ + "kind" + ] + }, + "ThreatIntelligenceInformationList": { + "description": "List of all the threat intelligence information objects.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of information objects.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of threat intelligence information objects.", + "items": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "ThreatIntelligenceIndicatorModel": { + "allOf": [ + { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + ], + "description": "Threat intelligence indicator entity.", + "properties": { + "properties": { + "$ref": "#/definitions/ThreatIntelligenceIndicatorProperties", + "description": "Threat Intelligence Entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "indicator" + }, + "ThreatIntelligenceIndicatorModelForRequestBody": { + "allOf": [ + { + "$ref": "#/definitions/ThreatIntelligenceResourceKind" + } + ], + "description": "Threat intelligence indicator entity used in request body.", + "properties": { + "etag": { + "description": "Etag of the azure resource", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/ThreatIntelligenceIndicatorProperties", + "description": "Threat Intelligence Entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "indicator" + }, + "ThreatIntelligenceResourceKind": { + "description": "Describes an entity with kind.", + "properties": { + "kind": { + "$ref": "#/definitions/ThreatIntelligenceResourceInnerKind", + "description": "The kind of the entity." + } + }, + "required": [ + "kind" + ], + "type": "object" + }, + "ThreatIntelligenceResourceInnerKind": { + "description": "The kind of the threat intelligence entity", + "enum": [ + "indicator" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ThreatIntelligenceResourceInnerKind", + "values": [ + { + "description": "Entity represents threat intelligence indicator in the system.", + "value": "indicator" + } + ] + } + }, + "ThreatIntelligenceIndicatorProperties": { + "allOf": [ + { + "$ref": "../../../common/1.0/types.json#/definitions/EntityCommonProperties" + } + ], + "description": "Describes threat intelligence entity properties", + "properties": { + "threatIntelligenceTags": { + "description": "List of tags", + "items": { + "description": "tag", + "type": "string" + }, + "type": "array" + }, + "lastUpdatedTimeUtc": { + "description": "Last updated time in UTC", + "type": "string" + }, + "source": { + "description": "Source of a threat intelligence entity", + "type": "string" + }, + "displayName": { + "description": "Display name of a threat intelligence entity", + "type": "string" + }, + "description": { + "description": "Description of a threat intelligence entity", + "type": "string" + }, + "indicatorTypes": { + "description": "Indicator types of threat intelligence entities", + "items": { + "description": "Indicator type of a threat intelligence entity", + "type": "string" + }, + "type": "array" + }, + "pattern": { + "description": "Pattern of a threat intelligence entity", + "type": "string" + }, + "patternType": { + "description": "Pattern type of a threat intelligence entity", + "type": "string" + }, + "patternVersion": { + "description": "Pattern version of a threat intelligence entity", + "type": "string" + }, + "killChainPhases": { + "description": "Kill chain phases", + "items": { + "description": "Kill chain phase", + "$ref": "#/definitions/ThreatIntelligenceKillChainPhase" + }, + "type": "array" + }, + "parsedPattern": { + "description": "Parsed patterns", + "items": { + "description": "Parsed pattern", + "$ref": "#/definitions/ThreatIntelligenceParsedPattern" + }, + "type": "array" + }, + "externalId": { + "description": "External ID of threat intelligence entity", + "type": "string" + }, + "createdByRef": { + "description": "Created by reference of threat intelligence entity", + "type": "string" + }, + "defanged": { + "description": "Is threat intelligence entity defanged", + "type": "boolean" + }, + "externalLastUpdatedTimeUtc": { + "description": "External last updated time in UTC", + "type": "string" + }, + "externalReferences": { + "description": "External References", + "items": { + "description": "external_reference", + "$ref": "#/definitions/ThreatIntelligenceExternalReference" + }, + "type": "array" + }, + "granularMarkings": { + "description": "Granular Markings", + "items": { + "description": "Granular marking", + "$ref": "#/definitions/ThreatIntelligenceGranularMarkingModel" + }, + "type": "array" + }, + "labels": { + "description": "Labels of threat intelligence entity", + "items": { + "description": "label", + "type": "string" + }, + "type": "array" + }, + "revoked": { + "description": "Is threat intelligence entity revoked", + "type": "boolean" + }, + "confidence": { + "description": "Confidence of threat intelligence entity", + "type": "integer", + "format": "int32" + }, + "objectMarkingRefs": { + "description": "Threat intelligence entity object marking references", + "items": { + "description": "Threat intelligence entity object marking reference", + "type": "string" + }, + "type": "array" + }, + "language": { + "description": "Language of threat intelligence entity", + "type": "string" + }, + "threatTypes": { + "description": "Threat types", + "items": { + "description": "Threat type", + "type": "string" + }, + "type": "array" + }, + "validFrom": { + "description": "Valid from", + "type": "string" + }, + "validUntil": { + "description": "Valid until", + "type": "string" + }, + "created": { + "description": "Created by", + "type": "string" + }, + "modified": { + "description": "Modified by", + "type": "string" + }, + "extensions": { + "description": "Extensions map", + "type": "object", + "additionalProperties": {} + } + }, + "type": "object" + }, + "ThreatIntelligenceKillChainPhase": { + "description": "Describes threat kill chain phase entity", + "properties": { + "killChainName": { + "description": "Kill chainName name", + "type": "string" + }, + "phaseName": { + "description": "Phase name", + "type": "string" + } + }, + "type": "object" + }, + "ThreatIntelligenceParsedPattern": { + "description": "Describes parsed pattern entity", + "properties": { + "patternTypeKey": { + "description": "Pattern type key", + "type": "string" + }, + "patternTypeValues": { + "description": "Pattern type keys", + "items": { + "description": "Pattern type key", + "$ref": "#/definitions/ThreatIntelligenceParsedPatternTypeValue" + }, + "type": "array" + } + }, + "type": "object" + }, + "ThreatIntelligenceParsedPatternTypeValue": { + "description": "Describes threat kill chain phase entity", + "properties": { + "valueType": { + "description": "Type of the value", + "type": "string" + }, + "value": { + "description": "Value of parsed pattern", + "type": "string" + } + }, + "type": "object" + }, + "ThreatIntelligenceGranularMarkingModel": { + "description": "Describes threat granular marking model entity", + "properties": { + "language": { + "description": "Language granular marking model", + "type": "string" + }, + "markingRef": { + "description": "marking reference granular marking model", + "type": "integer", + "format": "int32" + }, + "selectors": { + "description": "granular marking model selectors", + "items": { + "description": "granular marking model selector", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ThreatIntelligenceExternalReference": { + "description": "Describes external reference", + "properties": { + "description": { + "description": "External reference description", + "type": "string" + }, + "externalId": { + "description": "External reference ID", + "type": "string" + }, + "sourceName": { + "description": "External reference source name", + "type": "string" + }, + "url": { + "description": "External reference URL", + "type": "string" + }, + "hashes": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "External reference hashes" + } + }, + "type": "object" + }, + "ThreatIntelligenceFilteringCriteria": { + "description": "Filtering criteria for querying threat intelligence indicators.", + "properties": { + "pageSize": { + "description": "Page size", + "type": "integer", + "format": "int32" + }, + "minConfidence": { + "description": "Minimum confidence.", + "type": "integer", + "format": "int32" + }, + "maxConfidence": { + "description": "Maximum confidence.", + "type": "integer", + "format": "int32" + }, + "minValidUntil": { + "description": "Start time for ValidUntil filter.", + "type": "string" + }, + "maxValidUntil": { + "description": "End time for ValidUntil filter.", + "type": "string" + }, + "includeDisabled": { + "description": "Parameter to include/exclude disabled indicators.", + "type": "boolean" + }, + "sortBy": { + "description": "Columns to sort by and sorting order", + "items": { + "description": "Sort By", + "$ref": "#/definitions/ThreatIntelligenceSortingCriteria" + }, + "type": "array" + }, + "sources": { + "description": "Sources of threat intelligence indicators", + "items": { + "description": "Source", + "type": "string" + }, + "type": "array" + }, + "patternTypes": { + "description": "Pattern types", + "items": { + "description": "Pattern type", + "type": "string" + }, + "type": "array" + }, + "threatTypes": { + "description": "Threat types of threat intelligence indicators", + "items": { + "description": "Threat type of a threat intelligence indicator", + "type": "string" + }, + "type": "array" + }, + "ids": { + "description": "Ids of threat intelligence indicators", + "items": { + "description": "Id of a threat intelligence indicator", + "type": "string" + }, + "type": "array" + }, + "keywords": { + "description": "Keywords for searching threat intelligence indicators", + "items": { + "description": "keyword for searching threat intelligence indicators", + "type": "string" + }, + "type": "array" + }, + "skipToken": { + "description": "Skip token.", + "type": "string" + } + }, + "type": "object" + }, + "ThreatIntelligenceSortingCriteria": { + "description": "List of available columns for sorting", + "properties": { + "itemKey": { + "description": "Column name", + "type": "string" + }, + "sortOrder": { + "$ref": "#/definitions/ThreatIntelligenceSortingOrder", + "description": "Sorting order (ascending/descending/unsorted)." + } + }, + "type": "object" + }, + "ThreatIntelligenceSortingOrder": { + "description": "Sorting order (ascending/descending/unsorted).", + "enum": [ + "unsorted", + "ascending", + "descending" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ThreatIntelligenceSortingOrder", + "values": [ + { + "value": "unsorted" + }, + { + "value": "ascending" + }, + { + "value": "descending" + } + ] + } + }, + "ThreatIntelligenceAppendTags": { + "description": "Array of tags to be appended to the threat intelligence indicator.", + "properties": { + "threatIntelligenceTags": { + "description": "List of tags to be appended.", + "items": { + "description": "parameter", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ThreatIntelligenceMetricsList": { + "description": "List of all the threat intelligence metric fields (type/threat type/source).", + "properties": { + "value": { + "description": "Array of threat intelligence metric fields (type/threat type/source).", + "items": { + "$ref": "#/definitions/ThreatIntelligenceMetrics" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "ThreatIntelligenceMetrics": { + "description": "Threat intelligence metrics.", + "properties": { + "properties": { + "description": "Threat intelligence metrics.", + "$ref": "#/definitions/ThreatIntelligenceMetric" + } + }, + "type": "object" + }, + "ThreatIntelligenceMetric": { + "description": "Describes threat intelligence metric", + "properties": { + "lastUpdatedTimeUtc": { + "description": "Last updated indicator metric", + "type": "string" + }, + "threatTypeMetrics": { + "description": "Threat type metrics", + "items": { + "description": "parameter", + "$ref": "#/definitions/ThreatIntelligenceMetricEntity" + }, + "type": "array" + }, + "patternTypeMetrics": { + "description": "Pattern type metrics", + "items": { + "description": "parameter", + "$ref": "#/definitions/ThreatIntelligenceMetricEntity" + }, + "type": "array" + }, + "sourceMetrics": { + "description": "Source metrics", + "items": { + "description": "parameter", + "$ref": "#/definitions/ThreatIntelligenceMetricEntity" + }, + "type": "array" + } + }, + "type": "object" + }, + "ThreatIntelligenceMetricEntity": { + "description": "Describes threat intelligence metric entity", + "properties": { + "metricName": { + "description": "Metric name", + "type": "string" + }, + "metricValue": { + "description": "Metric value", + "type": "integer", + "format": "int32" + } + }, + "type": "object" + } + }, + "parameters": { + "OperationalInsightsResourceProvider": { + "description": "The namespace of workspaces resource provider- Microsoft.OperationalInsights.", + "in": "path", + "name": "operationalInsightsResourceProvider", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ThreatIntelligenceName": { + "description": "Threat intelligence indicator name field.", + "in": "path", + "name": "name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ThreatIntelligenceProperties": { + "description": "Properties of threat intelligence indicators to create and update.", + "in": "body", + "name": "ThreatIntelligenceProperties", + "required": true, + "schema": { + "$ref": "#/definitions/ThreatIntelligenceIndicatorModelForRequestBody" + }, + "x-ms-parameter-location": "method" + }, + "ThreatIntelligenceReplaceTags": { + "description": "Tags in the threat intelligence indicator to be replaced.", + "in": "body", + "name": "ThreatIntelligenceReplaceTags", + "required": true, + "schema": { + "$ref": "#/definitions/ThreatIntelligenceIndicatorModelForRequestBody" + }, + "x-ms-parameter-location": "method" + }, + "ThreatIntelligenceFilteringCriteria": { + "description": "Filtering criteria for querying threat intelligence indicators.", + "in": "body", + "name": "ThreatIntelligenceFilteringCriteria", + "required": true, + "schema": { + "$ref": "#/definitions/ThreatIntelligenceFilteringCriteria" + }, + "x-ms-parameter-location": "method" + }, + "ThreatIntelligenceIndicatorEntityKind": { + "description": "The threat intelligence entity kind", + "in": "query", + "name": "ctiEntityKind", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ThreatIntelligenceAppendTags": { + "description": "The threat intelligence append tags request body", + "in": "body", + "name": "ThreatIntelligenceAppendTags", + "required": true, + "schema": { + "$ref": "#/definitions/ThreatIntelligenceAppendTags" + }, + "x-ms-parameter-location": "method" + }, + "ODataFilter": { + "description": "Filters the results, based on a Boolean condition. Optional.", + "in": "query", + "name": "$filter", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ODataOrderBy": { + "description": "Sorts the results. Optional.", + "in": "query", + "name": "$orderby", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ODataSkipToken": { + "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. Optional.", + "in": "query", + "name": "$skipToken", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ODataTop": { + "description": "Returns only the first n results. Optional.", + "format": "int32", + "in": "query", + "name": "$top", + "required": false, + "type": "integer", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/Watchlists.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/Watchlists.json new file mode 100644 index 000000000000..7a85c96421c6 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/Watchlists.json @@ -0,0 +1,774 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2021-04-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/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists": { + "get": { + "x-ms-examples": { + "Get all watchlists.": { + "$ref": "./examples/watchlists/GetWatchlists.json" + } + }, + "tags": [ + "Watchlists" + ], + "description": "Get all watchlists, without watchlist items.", + "operationId": "Watchlists_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WatchlistList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}": { + "get": { + "x-ms-examples": { + "Get a watchlist.": { + "$ref": "./examples/watchlists/GetWatchlistByAlias.json" + } + }, + "tags": [ + "Watchlists" + ], + "description": "Get a watchlist, without its watchlist items.", + "operationId": "Watchlists_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WatchlistAlias" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Watchlist" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a watchlist.": { + "$ref": "./examples/watchlists/DeleteWatchlist.json" + } + }, + "tags": [ + "Watchlists" + ], + "description": "Delete a watchlist.", + "operationId": "Watchlists_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WatchlistAlias" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create or update a watchlist.": { + "$ref": "./examples/watchlists/CreateWatchlist.json" + }, + "Create or update a watchlist and bulk creates watchlist items.": { + "$ref": "./examples/watchlists/CreateWatchlistAndWatchlistItems.json" + } + }, + "tags": [ + "Watchlists" + ], + "description": "Create or update a Watchlist and its Watchlist Items (bulk creation, e.g. through text/csv content type). To create a Watchlist and its Items, we should call this endpoint with rawContent and contentType properties.", + "operationId": "Watchlists_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WatchlistAlias" + }, + { + "$ref": "#/parameters/Watchlist" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Watchlist" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Watchlist" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}/watchlistItems": { + "get": { + "x-ms-examples": { + "Get all watchlist Items.": { + "$ref": "./examples/watchlists/GetWatchlistItems.json" + } + }, + "tags": [ + "WatchlistItems" + ], + "description": "Get all watchlist Items.", + "operationId": "WatchlistItems_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WatchlistAlias" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WatchlistItemList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}/watchlistItems/{watchlistItemId}": { + "get": { + "x-ms-examples": { + "Get a watchlist item.": { + "$ref": "./examples/watchlists/GetWatchlistItemById.json" + } + }, + "tags": [ + "WatchlistItems" + ], + "description": "Get a watchlist item.", + "operationId": "WatchlistItems_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WatchlistAlias" + }, + { + "$ref": "#/parameters/WatchlistItemId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WatchlistItem" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a watchlist item.": { + "$ref": "./examples/watchlists/DeleteWatchlistItem.json" + } + }, + "tags": [ + "WatchlistItems" + ], + "description": "Delete a watchlist item.", + "operationId": "WatchlistItems_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WatchlistAlias" + }, + { + "$ref": "#/parameters/WatchlistItemId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create or update a watchlist item.": { + "$ref": "./examples/watchlists/CreateWatchlistItem.json" + } + }, + "tags": [ + "WatchlistItems" + ], + "description": "Create or update a watchlist item.", + "operationId": "WatchlistItems_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "../../../common/1.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WatchlistAlias" + }, + { + "$ref": "#/parameters/WatchlistItemId" + }, + { + "$ref": "#/parameters/WatchlistItem" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WatchlistItem" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/WatchlistItem" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "WatchlistList": { + "description": "List all the watchlists.", + "type": "object", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of watchlists.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of watchlist.", + "items": { + "$ref": "#/definitions/Watchlist" + }, + "type": "array" + } + }, + "required": [ + "value" + ] + }, + "Watchlist": { + "allOf": [ + { + "$ref": "../../../common/1.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents a Watchlist in Azure Security Insights.", + "properties": { + "properties": { + "$ref": "#/definitions/WatchlistProperties", + "description": "Watchlist properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "WatchlistProperties": { + "description": "Describes watchlist properties", + "properties": { + "watchlistId": { + "description": "The id (a Guid) of the watchlist", + "type": "string" + }, + "displayName": { + "description": "The display name of the watchlist", + "type": "string" + }, + "provider": { + "description": "The provider of the watchlist", + "type": "string" + }, + "source": { + "description": "The source of the watchlist", + "enum": [ + "Local file", + "Remote storage" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "source" + } + }, + "created": { + "description": "The time the watchlist was created", + "format": "date-time", + "type": "string" + }, + "updated": { + "description": "The last time the watchlist was updated", + "format": "date-time", + "type": "string" + }, + "createdBy": { + "$ref": "#/definitions/UserInfo", + "description": "Describes a user that created the watchlist", + "type": "object" + }, + "updatedBy": { + "$ref": "#/definitions/UserInfo", + "description": "Describes a user that updated the watchlist", + "type": "object" + }, + "description": { + "description": "A description of the watchlist", + "type": "string" + }, + "watchlistType": { + "description": "The type of the watchlist", + "type": "string" + }, + "watchlistAlias": { + "description": "The alias of the watchlist", + "type": "string" + }, + "isDeleted": { + "description": "A flag that indicates if the watchlist is deleted or not", + "type": "boolean" + }, + "labels": { + "description": "List of labels relevant to this watchlist", + "items": { + "$ref": "#/definitions/Label" + }, + "type": "array" + }, + "defaultDuration": { + "description": "The default duration of a watchlist (in ISO 8601 duration format)", + "format": "duration", + "type": "string" + }, + "tenantId": { + "description": "The tenantId where the watchlist belongs to", + "type": "string" + }, + "numberOfLinesToSkip": { + "description": "The number of lines in a csv content to skip before the header", + "type": "integer", + "format": "int32" + }, + "rawContent": { + "description": "The raw content that represents to watchlist items to create. Example : This line will be skipped\nheader1,header2\nvalue1,value2", + "type": "string" + }, + "itemsSearchKey": { + "description": "The search key is used to optimize query performance when using watchlists for joins with other data. For example, enable a column with IP addresses to be the designated SearchKey field, then use this field as the key field when joining to other event data by IP address.", + "type": "string" + }, + "contentType": { + "description": "The content type of the raw content. For now, only text/csv is valid", + "type": "string" + }, + "uploadStatus": { + "description": "The status of the Watchlist upload : New, InProgress or Complete. **Note** : When a Watchlist upload status is InProgress, the Watchlist cannot be deleted", + "type": "string" + } + }, + "required": [ + "displayName", + "source", + "provider", + "itemsSearchKey" + ], + "type": "object" + }, + "WatchlistItemList": { + "description": "List all the watchlist items.", + "type": "object", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of watchlist items.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of watchlist items.", + "items": { + "$ref": "#/definitions/WatchlistItem" + }, + "type": "array" + } + }, + "required": [ + "value" + ] + }, + "WatchlistItem": { + "allOf": [ + { + "$ref": "../../../common/1.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents a Watchlist Item in Azure Security Insights.", + "properties": { + "properties": { + "$ref": "#/definitions/WatchlistItemProperties", + "description": "Watchlist Item properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "WatchlistItemProperties": { + "description": "Describes watchlist item properties", + "properties": { + "watchlistItemType": { + "description": "The type of the watchlist item", + "type": "string" + }, + "watchlistItemId": { + "description": "The id (a Guid) of the watchlist item", + "type": "string" + }, + "tenantId": { + "description": "The tenantId to which the watchlist item belongs to", + "type": "string" + }, + "isDeleted": { + "description": "A flag that indicates if the watchlist item is deleted or not", + "type": "boolean" + }, + "created": { + "description": "The time the watchlist item was created", + "format": "date-time", + "type": "string" + }, + "updated": { + "description": "The last time the watchlist item was updated", + "format": "date-time", + "type": "string" + }, + "createdBy": { + "$ref": "#/definitions/UserInfo", + "description": "Describes a user that created the watchlist item", + "type": "object" + }, + "updatedBy": { + "$ref": "#/definitions/UserInfo", + "description": "Describes a user that updated the watchlist item", + "type": "object" + }, + "itemsKeyValue": { + "description": "key-value pairs for a watchlist item", + "type": "object" + }, + "entityMapping": { + "description": "key-value pairs for a watchlist item entity mapping", + "type": "object" + } + }, + "required": [ + "itemsKeyValue" + ], + "type": "object" + }, + "UserInfo": { + "description": "User information that made some action", + "properties": { + "email": { + "description": "The email of the user.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the user.", + "readOnly": true, + "type": "string" + }, + "objectId": { + "description": "The object id of the user.", + "format": "uuid", + "type": "string", + "x-nullable": true + } + }, + "type": "object" + }, + "Label": { + "description": "Label that will be used to tag and filter on.", + "type": "string" + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse", + "description": "The error object of the CloudError response" + } + }, + "type": "object", + "description": "An error response for a resource management request." + } + }, + "parameters": { + "WatchlistAlias": { + "description": "The watchlist alias", + "in": "path", + "name": "watchlistAlias", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Watchlist": { + "description": "The watchlist", + "in": "body", + "name": "watchlist", + "required": true, + "schema": { + "$ref": "#/definitions/Watchlist" + }, + "x-ms-parameter-location": "method" + }, + "WatchlistItem": { + "description": "The watchlist item", + "in": "body", + "name": "watchlistItem", + "required": true, + "schema": { + "$ref": "#/definitions/WatchlistItem" + }, + "x-ms-parameter-location": "method" + }, + "WatchlistItemId": { + "description": "The watchlist item id (GUID)", + "in": "path", + "name": "watchlistItemId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SubscriptionId": { + "description": "Azure subscription ID", + "in": "path", + "name": "subscriptionId", + "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$", + "required": true, + "type": "string" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/CreateIncident.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/CreateIncident.json new file mode 100644 index 000000000000..6f5924caeb9e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/CreateIncident.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incident": { + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "lastActivityTimeUtc": "2019-01-01T13:05:30Z", + "firstActivityTimeUtc": "2019-01-01T13:00:30Z", + "description": "This is a demo incident", + "title": "My incident", + "owner": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70" + }, + "severity": "High", + "classification": "FalsePositive", + "classificationComment": "Not a malicious activity", + "classificationReason": "IncorrectAlertLogic", + "status": "Closed" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/incidents", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0001\"", + "properties": { + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastActivityTimeUtc": "2019-01-01T13:05:30Z", + "firstActivityTimeUtc": "2019-01-01T13:00:30Z", + "description": "This is a demo incident", + "title": "My incident", + "owner": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "userPrincipalName": "john@contoso.com", + "assignedTo": "john doe" + }, + "severity": "High", + "classification": "FalsePositive", + "classificationComment": "Not a malicious activity", + "classificationReason": "IncorrectAlertLogic", + "status": "Closed", + "incidentUrl": "https://portal.azure.com/#asset/Microsoft_Azure_Security_Insights/Incident/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incidentNumber": 3177, + "labels": [], + "relatedAnalyticRuleIds": [], + "additionalData": { + "alertsCount": 0, + "bookmarksCount": 0, + "commentsCount": 3, + "alertProductNames": [], + "tactics": [] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/incidents", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0001\"", + "properties": { + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastActivityTimeUtc": "2019-01-01T13:05:30Z", + "firstActivityTimeUtc": "2019-01-01T13:00:30Z", + "description": "This is a demo incident", + "title": "My incident", + "owner": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "userPrincipalName": "john@contoso.com", + "assignedTo": "john doe" + }, + "severity": "High", + "classification": "FalsePositive", + "classificationComment": "Not a malicious activity", + "classificationReason": "IncorrectAlertLogic", + "status": "Closed", + "incidentUrl": "https://portal.azure.com/#asset/Microsoft_Azure_Security_Insights/Incident/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incidentNumber": 3177, + "labels": [], + "relatedAnalyticRuleIds": [], + "additionalData": { + "alertsCount": 0, + "bookmarksCount": 0, + "commentsCount": 3, + "alertProductNames": [], + "tactics": [] + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/DeleteIncident.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/DeleteIncident.json new file mode 100644 index 000000000000..566038983d19 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/DeleteIncident.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/GetAllIncidentAlerts.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/GetAllIncidentAlerts.json new file mode 100644 index 000000000000..2a7544a52f22 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/GetAllIncidentAlerts.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "afbd324f-6c48-459c-8710-8d1e1cd03812" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRG/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Entities/baa8a239-6fde-4ab7-a093-d09f7b75c58c", + "name": "baa8a239-6fde-4ab7-a093-d09f7b75c58c", + "type": "Microsoft.SecurityInsights/Entities", + "kind": "SecurityAlert", + "properties": { + "systemAlertId": "baa8a239-6fde-4ab7-a093-d09f7b75c58c", + "tactics": [], + "alertDisplayName": "myAlert", + "confidenceLevel": "Unknown", + "severity": "Low", + "vendorName": "Microsoft", + "productName": "Azure Security Center", + "alertType": "myAlert", + "processingEndTime": "2020-07-20T18:21:53.6158361Z", + "status": "New", + "endTimeUtc": "2020-07-20T18:21:53.6158361Z", + "startTimeUtc": "2020-07-20T18:21:53.6158361Z", + "timeGenerated": "2020-07-20T18:21:53.6158361Z", + "resourceIdentifiers": [ + { + "type": "LogAnalytics", + "workspaceId": "c8c99641-985d-4e4e-8e91-fb3466cd0e5b", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroup": "myRG" + } + ], + "additionalData": { + "AlertMessageEnqueueTime": "2020-07-20T18:21:57.304Z" + }, + "friendlyName": "myAlert" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/GetAllIncidentBookmarks.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/GetAllIncidentBookmarks.json new file mode 100644 index 000000000000..757b79296408 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/GetAllIncidentBookmarks.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "afbd324f-6c48-459c-8710-8d1e1cd03812" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/afbd324f-6c48-459c-8710-8d1e1cd03812", + "name": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "type": "Microsoft.SecurityInsights/Entities", + "kind": "Bookmark", + "properties": { + "displayName": "SecurityEvent - 868f40f4698d", + "created": "2020-06-17T15:34:01.4265524+00:00", + "updated": "2020-06-17T15:34:01.4265524+00:00", + "createdBy": { + "objectId": "b03ca914-5eb6-45e5-9417-fe0797c372fd", + "email": "user@microsoft.com", + "name": "user" + }, + "updatedBy": { + "objectId": "b03ca914-5eb6-45e5-9417-fe0797c372fd", + "email": "user@microsoft.com", + "name": "user" + }, + "eventTime": "2020-06-17T15:34:01.4265524+00:00", + "labels": [], + "query": "SecurityEvent\r\n| take 1\n", + "queryResult": "{\"TimeGenerated\":\"2020-05-24T01:24:25.67Z\",\"Account\":\"\\\\ADMINISTRATOR\",\"AccountType\":\"User\",\"Computer\":\"SecurityEvents\",\"EventSourceName\":\"Microsoft-Windows-Security-Auditing\",\"Channel\":\"Security\",\"Task\":12544,\"Level\":\"16\",\"EventID\":4625,\"Activity\":\"4625 - An account failed to log on.\",\"AuthenticationPackageName\":\"NTLM\",\"FailureReason\":\"%%2313\",\"IpAddress\":\"176.113.115.73\",\"IpPort\":\"0\",\"LmPackageName\":\"-\",\"LogonProcessName\":\"NtLmSsp \",\"LogonType\":3,\"LogonTypeName\":\"3 - Network\",\"Process\":\"-\",\"ProcessId\":\"0x0\",\"__entityMapping\":{\"\\\\ADMINISTRATOR\":\"Account\",\"SecurityEvents\":\"Host\"}}", + "additionalData": { + "ETag": "\"3b00acab-0000-0d00-0000-5f15e4ed0000\"", + "EntityId": "afbd324f-6c48-459c-8710-8d1e1cd03812" + }, + "friendlyName": "SecurityEvent - 868f40f4698d" + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/bbbd324f-6c48-459c-8710-8d1e1cd03812", + "name": "bbbd324f-6c48-459c-8710-8d1e1cd03812", + "type": "Microsoft.SecurityInsights/Entities", + "kind": "Bookmark", + "properties": { + "displayName": "SecurityEvent - 868f40f4698d", + "created": "2020-06-17T15:34:01.4265524+00:00", + "updated": "2020-06-17T15:34:01.4265524+00:00", + "createdBy": { + "objectId": "303ca914-5eb6-45e5-9417-fe0797c372fd", + "email": "user@microsoft.com", + "name": "user" + }, + "updatedBy": { + "objectId": "b03ca914-5eb6-45e5-9417-fe0797c372fd", + "email": "user@microsoft.com", + "name": "user" + }, + "eventTime": "2020-06-17T15:34:01.4265524+00:00", + "labels": [], + "query": "SecurityEvent\r\n| take 1\n", + "queryResult": "{\"TimeGenerated\":\"2020-05-24T01:24:25.67Z\",\"Account\":\"\\\\ADMINISTRATOR\",\"AccountType\":\"User\",\"Computer\":\"SecurityEvents\",\"EventSourceName\":\"Microsoft-Windows-Security-Auditing\",\"Channel\":\"Security\",\"Task\":12544,\"Level\":\"16\",\"EventID\":4625,\"Activity\":\"4625 - An account failed to log on.\",\"AuthenticationPackageName\":\"NTLM\",\"FailureReason\":\"%%2313\",\"IpAddress\":\"176.113.115.73\",\"IpPort\":\"0\",\"LmPackageName\":\"-\",\"LogonProcessName\":\"NtLmSsp \",\"LogonType\":3,\"LogonTypeName\":\"3 - Network\",\"Process\":\"-\",\"ProcessId\":\"0x0\",\"__entityMapping\":{\"\\\\ADMINISTRATOR\":\"Account\",\"SecurityEvents\":\"Host\"}}", + "additionalData": { + "ETag": "\"3b00acab-0000-0d00-0000-5f15e4ed0000\"", + "EntityId": "afbd324f-6c48-459c-8710-8d1e1cd03812" + }, + "friendlyName": "SecurityEvent - 868f40f4698d" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/GetAllIncidentEntities.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/GetAllIncidentEntities.json new file mode 100644 index 000000000000..9fbd40237fa3 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/GetAllIncidentEntities.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "afbd324f-6c48-459c-8710-8d1e1cd03812" + }, + "responses": { + "200": { + "body": { + "entities": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/Entities", + "kind": "Account", + "properties": { + "friendlyName": "administrator", + "accountName": "administrator", + "ntDomain": "domain" + } + } + ], + "metaData": [ + { + "entityKind": "Account", + "count": 1 + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/GetIncidentById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/GetIncidentById.json new file mode 100644 index 000000000000..78ecfba0ec51 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/GetIncidentById.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/incidents", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastActivityTimeUtc": "2019-01-01T13:05:30Z", + "firstActivityTimeUtc": "2019-01-01T13:00:30Z", + "description": "This is a demo incident", + "title": "My incident", + "owner": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "userPrincipalName": "john@contoso.com", + "assignedTo": "john doe" + }, + "severity": "High", + "classification": "FalsePositive", + "classificationComment": "Not a malicious activity", + "classificationReason": "InaccurateData", + "status": "Closed", + "incidentUrl": "https://portal.azure.com/#asset/Microsoft_Azure_Security_Insights/Incident/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incidentNumber": 3177, + "labels": [], + "relatedAnalyticRuleIds": [ + "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/fab3d2d4-747f-46a7-8ef0-9c0be8112bf7" + ], + "additionalData": { + "alertsCount": 0, + "bookmarksCount": 0, + "commentsCount": 3, + "alertProductNames": [], + "tactics": [ + "InitialAccess", + "Persistence" + ] + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/GetIncidents.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/GetIncidents.json new file mode 100644 index 000000000000..927a9671e844 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/GetIncidents.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "$orderby": "properties/createdTimeUtc desc", + "$top": 1 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/incidents", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastActivityTimeUtc": "2019-01-01T13:05:30Z", + "firstActivityTimeUtc": "2019-01-01T13:00:30Z", + "description": "This is a demo incident", + "title": "My incident", + "owner": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "userPrincipalName": "john@contoso.com", + "assignedTo": "john doe" + }, + "severity": "High", + "classification": "FalsePositive", + "classificationComment": "Not a malicious activity", + "classificationReason": "IncorrectAlertLogic", + "status": "Closed", + "incidentUrl": "https://portal.azure.com/#asset/Microsoft_Azure_Security_Insights/Incident/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incidentNumber": 3177, + "labels": [], + "relatedAnalyticRuleIds": [ + "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/fab3d2d4-747f-46a7-8ef0-9c0be8112bf7", + "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/8deb8303-e94d-46ff-96e0-5fd94b33df1a" + ], + "additionalData": { + "alertsCount": 0, + "bookmarksCount": 0, + "commentsCount": 3, + "alertProductNames": [], + "tactics": [ + "Persistence" + ] + } + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/comments/CreateIncidentComment.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/comments/CreateIncidentComment.json new file mode 100644 index 000000000000..e86a3fb7ea9d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/comments/CreateIncidentComment.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incidentCommentId": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "incidentComment": { + "properties": { + "message": "Some message" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5/comments/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/incidents/comments", + "etag": "0300bf09-0000-0000-0000-5c37296e0000", + "properties": { + "message": "Some message", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-04T13:15:30Z", + "author": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "userPrincipalName": "john@contoso.com", + "name": "john doe" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5/comments/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/incidents/comments", + "etag": "0300bf09-0000-0000-0000-5c37296e0000", + "properties": { + "message": "Some message", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z", + "author": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "userPrincipalName": "john@contoso.com", + "name": "john doe" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/comments/DeleteIncidentComment.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/comments/DeleteIncidentComment.json new file mode 100644 index 000000000000..e23ae7f8d527 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/comments/DeleteIncidentComment.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incidentCommentId": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/comments/GetAllIncidentComments.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/comments/GetAllIncidentComments.json new file mode 100644 index 000000000000..bebe3cc39482 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/comments/GetAllIncidentComments.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5/comments/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/incidents/comments", + "etag": "0300bf09-0000-0000-0000-5c37296e0000", + "properties": { + "message": "Some message", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z", + "author": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "userPrincipalName": "john@contoso.com", + "name": "john doe" + } + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/comments/GetIncidentCommentById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/comments/GetIncidentCommentById.json new file mode 100644 index 000000000000..b52d6efd63dc --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/comments/GetIncidentCommentById.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incidentCommentId": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5/comments/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/incidents/comments", + "etag": "0300bf09-0000-0000-0000-5c37296e0000", + "properties": { + "message": "Some message", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z", + "author": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "userPrincipalName": "john@contoso.com", + "name": "john doe" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/relations/CreateIncidentRelation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/relations/CreateIncidentRelation.json new file mode 100644 index 000000000000..82c2500fa570 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/relations/CreateIncidentRelation.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "relationName": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "relation": { + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/incidents/relations", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceName": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceType": "Microsoft.SecurityInsights/bookmarks" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/incidents/relations", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceName": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceType": "Microsoft.SecurityInsights/bookmarks" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/relations/DeleteIncidentRelation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/relations/DeleteIncidentRelation.json new file mode 100644 index 000000000000..7a37ded950d1 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/relations/DeleteIncidentRelation.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "relationName": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/relations/GetAllIncidentRelations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/relations/GetAllIncidentRelations.json new file mode 100644 index 000000000000..b53500d98872 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/relations/GetAllIncidentRelations.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "afbd324f-6c48-459c-8710-8d1e1cd03812" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/incidents/relations", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceName": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceType": "Microsoft.SecurityInsights/bookmarks" + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812/relations/9673a17d-8bc7-4ca6-88ee-38a4f3efc032", + "name": "9673a17d-8bc7-4ca6-88ee-38a4f3efc032", + "type": "Microsoft.SecurityInsights/incidents/relations", + "etag": "6f714025-dd7c-46aa-b5d0-b9857488d060", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/1dd267cd-8a1f-4f6f-b92c-da43ac8819af", + "relatedResourceName": "1dd267cd-8a1f-4f6f-b92c-da43ac8819af", + "relatedResourceType": "Microsoft.SecurityInsights/entities", + "relatedResourceKind": "SecurityAlert" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/relations/GetIncidentRelationByName.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/relations/GetIncidentRelationByName.json new file mode 100644 index 000000000000..a28466790ce3 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/incidents/relations/GetIncidentRelationByName.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "relationName": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/incidents/relations", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceName": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceType": "Microsoft.SecurityInsights/bookmarks" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/AppendTagsThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/AppendTagsThreatIntelligence.json new file mode 100644 index 000000000000..46520a2dee24 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/AppendTagsThreatIntelligence.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "name": "d9cd6f0b-96b9-3984-17cd-a779d1e15a93", + "ThreatIntelligenceAppendTags": { + "threatIntelligenceTags": [ + "tag1", + "tag2" + ] + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/CollectThreatIntelligenceMetrics.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/CollectThreatIntelligenceMetrics.json new file mode 100644 index 000000000000..c882bf917564 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/CollectThreatIntelligenceMetrics.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "lastUpdatedTimeUtc": "2020-09-01T19:44:44.117403Z", + "threatTypeMetrics": [ + { + "metricName": "compromised", + "metricValue": 20 + } + ], + "patternTypeMetrics": [ + { + "metricName": "url", + "metricValue": 20 + } + ], + "sourceMetrics": [ + { + "metricName": "Azure Sentinel", + "metricValue": 10315 + }, + { + "metricName": "zinga", + "metricValue": 2 + } + ] + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/CreateThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/CreateThreatIntelligence.json new file mode 100644 index 000000000000..cc69d35bef66 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/CreateThreatIntelligence.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "ThreatIntelligenceProperties": { + "kind": "indicator", + "properties": { + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema", + "confidence": 78, + "createdByRef": "contoso@contoso.com", + "description": "debugging indicators", + "externalReferences": [], + "granularMarkings": [], + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "labels": [], + "modified": "", + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "revoked": false, + "validFrom": "2020-04-15T17:44:00.114052Z", + "validUntil": "" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "name": "180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "etag": "\"0000322c-0000-0800-0000-5e976c960000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2020-04-15T20:20:38.6160949Z", + "createdByRef": "contoso@contoso.com", + "externalId": "indicator--a2b6a95e-2108-4a38-bd49-ef95811bbcd7", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2020-04-15T20:20:38.6161887Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2020-04-15T17:44:00.114052Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "name": "180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "etag": "\"0000322c-0000-0800-0000-5e976c960000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2020-04-15T20:20:38.6160949Z", + "createdByRef": "aztestConnectors@contoso.com", + "externalId": "indicator--a2b6a95e-2108-4a38-bd49-ef95811bbcd7", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2020-04-15T20:20:38.6161887Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2020-04-15T17:44:00.114052Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/DeleteThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/DeleteThreatIntelligence.json new file mode 100644 index 000000000000..ca06dedb2118 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/DeleteThreatIntelligence.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "name": "d9cd6f0b-96b9-3984-17cd-a779d1e15a93" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/GetThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/GetThreatIntelligence.json new file mode 100644 index 000000000000..0264247c2583 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/GetThreatIntelligence.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/27d963e6-e6e4-e0f9-e9d7-c53985b3bbe8", + "name": "27d963e6-e6e4-e0f9-e9d7-c53985b3bbe8", + "etag": "\"00002f2c-0000-0800-0000-5e976a8e0000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 90, + "created": "2020-04-15T20:11:57.9666134Z", + "createdByRef": "contoso@contoso.com", + "externalId": "indicator--8516d567-0daa-4614-8745-e3591e1b48cf", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2020-04-15T20:15:11.0746926Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema 2", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2020-04-15T17:44:00.114052Z" + } + }, + { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "name": "e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "etag": "\"00002a2c-0000-0800-0000-5e97683b0000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2020-04-15T19:51:17.1050923Z", + "createdByRef": "contoso@contoso.com", + "externalId": "indicator--73be1729-babb-4348-a6c4-94621cae2530", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2020-04-15T20:15:11.074903Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "patching tags" + ], + "displayName": "updated indicator", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2020-04-15T17:44:00.114052Z" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/GetThreatIntelligenceById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/GetThreatIntelligenceById.json new file mode 100644 index 000000000000..7334c9ea292c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/GetThreatIntelligenceById.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "name": "e16ef847-962e-d7b6-9c8b-a33e4bd30e47" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "name": "e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "etag": "\"00002a2c-0000-0800-0000-5e97683b0000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2020-04-15T19:51:17.1050923Z", + "createdByRef": "aztestConnectors@dataconnector.ccsctp.net", + "externalId": "indicator--73be1729-babb-4348-a6c4-94621cae2530", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2020-04-15T20:18:49.2259902Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "patching tags" + ], + "displayName": "updated indicator", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://abc.com']", + "patternType": "url", + "validFrom": "2020-04-15T17:44:00.114052Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/QueryThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/QueryThreatIntelligence.json new file mode 100644 index 000000000000..2ebf72628dfb --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/QueryThreatIntelligence.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "ThreatIntelligenceFilteringCriteria": { + "pageSize": 100, + "minConfidence": 25, + "maxConfidence": 80, + "minValidUntil": "2020-04-05T17:44:00.114052Z", + "maxValidUntil": "2020-04-25T17:44:00.114052Z", + "sources": [ + "Azure Sentinel" + ], + "sortBy": [ + { + "itemKey": "lastUpdatedTimeUtc", + "sortOrder": "descending" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/27d963e6-e6e4-e0f9-e9d7-c53985b3bbe8", + "name": "27d963e6-e6e4-e0f9-e9d7-c53985b3bbe8", + "etag": "\"00002f2c-0000-0800-0000-5e976a8e0000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 90, + "created": "2020-04-15T20:11:57.9666134Z", + "createdByRef": "contoso@contoso.com", + "externalId": "indicator--8516d567-0daa-4614-8745-e3591e1b48cf", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2020-04-15T20:15:11.0746926Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema 2", + "description": "debugging indicators 2", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2020-04-15T17:44:00.114052Z", + "parsedPattern": [ + { + "patternTypeKey": "network-traffic", + "patternTypeValues": [ + { + "valueType": "0", + "value": "SSH-2.0-PuTTY_Release_0.64" + }, + { + "valueType": "1", + "value": "194.88.106.146" + } + ] + } + ] + } + }, + { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "name": "e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "etag": "\"00002a2c-0000-0800-0000-5e97683b0000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2020-04-15T19:51:17.1050923Z", + "createdByRef": "contoso@contoso.com", + "externalId": "indicator--73be1729-babb-4348-a6c4-94621cae2530", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2020-04-15T20:15:11.074903Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "patching tags" + ], + "displayName": "updated indicator", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2020-04-15T17:44:00.114052Z" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/ReplaceTagsThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/ReplaceTagsThreatIntelligence.json new file mode 100644 index 000000000000..4ac662492954 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/ReplaceTagsThreatIntelligence.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "name": "d9cd6f0b-96b9-3984-17cd-a779d1e15a93", + "ThreatIntelligenceReplaceTags": { + "etag": "\"0000262c-0000-0800-0000-5e9767060000\"", + "kind": "indicator", + "properties": { + "threatIntelligenceTags": [ + "patching tags" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "name": "e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "etag": "\"00002a2c-0000-0800-0000-5e97683b0000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2020-04-15T19:51:17.1050923Z", + "createdByRef": "aztestConnectors@dataconnector.ccsctp.net", + "externalId": "indicator--73be1729-babb-4348-a6c4-94621cae2530", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2020-04-15T19:56:08.828946Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "patching tags" + ], + "displayName": "updated indicator", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://abc.com']", + "patternType": "url", + "validFrom": "2020-04-15T17:44:00.114052Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/UpdateThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/UpdateThreatIntelligence.json new file mode 100644 index 000000000000..b020c1b9ae1c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/threatintelligence/UpdateThreatIntelligence.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "name": "d9cd6f0b-96b9-3984-17cd-a779d1e15a93", + "ThreatIntelligenceProperties": { + "kind": "indicator", + "properties": { + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema", + "confidence": 78, + "createdByRef": "contoso@contoso.com", + "description": "debugging indicators", + "externalReferences": [], + "granularMarkings": [], + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "labels": [], + "modified": "", + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "revoked": false, + "validFrom": "2020-04-15T17:44:00.114052Z", + "validUntil": "" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "name": "180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "etag": "\"0000322c-0000-0800-0000-5e976c960000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2020-04-15T20:20:38.6160949Z", + "createdByRef": "contoso@contoso.com", + "externalId": "indicator--a2b6a95e-2108-4a38-bd49-ef95811bbcd7", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2020-04-15T20:20:38.6161887Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2020-04-15T17:44:00.114052Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "name": "180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "etag": "\"0000322c-0000-0800-0000-5e976c960000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2020-04-15T20:20:38.6160949Z", + "createdByRef": "aztestConnectors@contoso.com", + "externalId": "indicator--a2b6a95e-2108-4a38-bd49-ef95811bbcd7", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2020-04-15T20:20:38.6161887Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2020-04-15T17:44:00.114052Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/watchlists/CreateWatchlist.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/watchlists/CreateWatchlist.json new file mode 100644 index 000000000000..bd00602cfce2 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/watchlists/CreateWatchlist.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "watchlistAlias": "highValueAsset", + "watchlist": { + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "displayName": "High Value Assets Watchlist", + "source": "Local file", + "provider": "Microsoft", + "description": "Watchlist from CSV content", + "itemsSearchKey": "header1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/watchlists/highValueAsset", + "name": "highValueAsset", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/Watchlists", + "properties": { + "watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017", + "displayName": "High Value Assets Watchlist", + "provider": "Microsoft", + "source": "Local file", + "created": "2020-09-28T00:26:54.7746089+00:00", + "updated": "2020-09-28T00:26:57+00:00", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updatedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "description": "Watchlist from CSV content", + "watchlistType": "watchlist", + "watchlistAlias": "highValueAsset", + "itemsSearchKey": "header1", + "isDeleted": false, + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/watchlists/highValueAsset", + "name": "highValueAsset", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/Watchlists", + "properties": { + "watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017", + "displayName": "High Value Assets Watchlist", + "provider": "Microsoft", + "source": "Local file", + "created": "2020-09-28T00:26:54.7746089+00:00", + "updated": "2020-09-28T00:26:57+00:00", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updatedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "description": "Watchlist from CSV content", + "watchlistType": "watchlist", + "watchlistAlias": "highValueAsset", + "itemsSearchKey": "header1", + "isDeleted": false, + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/watchlists/CreateWatchlistAndWatchlistItems.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/watchlists/CreateWatchlistAndWatchlistItems.json new file mode 100644 index 000000000000..1c7b3a22bb7f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/watchlists/CreateWatchlistAndWatchlistItems.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "watchlistAlias": "highValueAsset", + "watchlist": { + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "displayName": "High Value Assets Watchlist", + "source": "Local file", + "provider": "Microsoft", + "description": "Watchlist from CSV content", + "numberOfLinesToSkip": 1, + "rawContent": "This line will be skipped\nheader1,header2\nvalue1,value2", + "itemsSearchKey": "header1", + "contentType": "text/csv" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/watchlists/highValueAsset", + "name": "highValueAsset", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/Watchlists", + "properties": { + "watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017", + "displayName": "High Value Assets Watchlist", + "provider": "Microsoft", + "source": "Local file", + "created": "2020-09-28T00:26:54.7746089+00:00", + "updated": "2020-09-28T00:26:57+00:00", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updatedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "description": "Watchlist from CSV content", + "watchlistType": "watchlist", + "watchlistAlias": "highValueAsset", + "itemsSearchKey": "header1", + "isDeleted": false, + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/watchlists/highValueAsset", + "name": "highValueAsset", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/Watchlists", + "properties": { + "watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017", + "displayName": "High Value Assets Watchlist", + "provider": "Microsoft", + "source": "Local file", + "created": "2020-09-28T00:26:54.7746089+00:00", + "updated": "2020-09-28T00:26:57+00:00", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updatedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "description": "Watchlist from CSV content", + "watchlistType": "watchlist", + "watchlistAlias": "highValueAsset", + "itemsSearchKey": "header1", + "isDeleted": false, + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/watchlists/CreateWatchlistItem.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/watchlists/CreateWatchlistItem.json new file mode 100644 index 000000000000..08e7a272577c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/watchlists/CreateWatchlistItem.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "watchlistAlias": "highValueAsset", + "watchlistItemId": "82ba292c-dc97-4dfc-969d-d4dd9e666842", + "watchlistItem": { + "etag": "0300bf09-0000-0000-0000-5c37296e0000", + "properties": { + "itemsKeyValue": { + "Gateway subnet": "10.0.255.224/27", + "Web Tier": "10.0.1.0/24", + "Business tier": "10.0.2.0/24", + "Data tier": "10.0.2.0/24", + "Private DMZ in": "10.0.0.0/27", + "Public DMZ out": "10.0.0.96/27" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Watchlists/highValueAsset/WatchlistItems/82ba292c-dc97-4dfc-969d-d4dd9e666842", + "etag": "0300bf09-0000-0000-0000-5c37296e0000", + "type": "Microsoft.SecurityInsights/Watchlists/WatchlistItems", + "properties": { + "watchlistItemType": "watchlist-item", + "watchlistItemId": "82ba292c-dc97-4dfc-969d-d4dd9e666842", + "tenantId": "4008512e-1d30-48b2-9ee2-d3612ed9d3ea", + "isDeleted": false, + "created": "2020-11-15T04:58:56.0748363+00:00", + "updated": "2020-11-16T16:05:20+00:00", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updatedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "itemsKeyValue": { + "Gateway subnet": "10.0.255.224/27", + "Web Tier": "10.0.1.0/24", + "Business tier": "10.0.2.0/24", + "Data tier": "10.0.2.0/24", + "Private DMZ in": "10.0.0.0/27", + "Public DMZ out": "10.0.0.96/27" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Watchlists/highValueAsset/WatchlistItems/82ba292c-dc97-4dfc-969d-d4dd9e666842", + "etag": "0300bf09-0000-0000-0000-5c37296e0000", + "type": "Microsoft.SecurityInsights/Watchlists/WatchlistItems", + "properties": { + "watchlistItemType": "watchlist-item", + "watchlistItemId": "82ba292c-dc97-4dfc-969d-d4dd9e666842", + "tenantId": "4008512e-1d30-48b2-9ee2-d3612ed9d3ea", + "isDeleted": false, + "created": "2020-11-15T04:58:56.0748363+00:00", + "updated": "2020-11-16T16:05:20+00:00", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updatedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "itemsKeyValue": { + "Gateway subnet": "10.0.255.224/27", + "Web Tier": "10.0.1.0/24", + "Business tier": "10.0.2.0/24", + "Data tier": "10.0.2.0/24", + "Private DMZ in": "10.0.0.0/27", + "Public DMZ out": "10.0.0.96/27" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/watchlists/DeleteWatchlist.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/watchlists/DeleteWatchlist.json new file mode 100644 index 000000000000..cb1c4805bd24 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/watchlists/DeleteWatchlist.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "watchlistAlias": "highValueAsset" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/watchlists/DeleteWatchlistItem.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/watchlists/DeleteWatchlistItem.json new file mode 100644 index 000000000000..942c3c148a00 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/watchlists/DeleteWatchlistItem.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "watchlistAlias": "highValueAsset", + "watchlistItemId": "4008512e-1d30-48b2-9ee2-d3612ed9d3ea" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/watchlists/GetWatchlistByAlias.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/watchlists/GetWatchlistByAlias.json new file mode 100644 index 000000000000..ae9dbcae9d2e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/watchlists/GetWatchlistByAlias.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "watchlistAlias": "highValueAsset" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/watchlists/highValueAsset", + "name": "highValueAsset", + "type": "Microsoft.SecurityInsights/Watchlists", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017", + "displayName": "High Value Assets Watchlist", + "provider": "Microsoft", + "source": "Local file", + "created": "2020-09-28T00:26:54.7746089+00:00", + "updated": "2020-09-28T00:26:57+00:00", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updatedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "description": "Watchlist from CSV content", + "watchlistType": "watchlist", + "watchlistAlias": "highValueAsset", + "itemsSearchKey": "header1", + "isDeleted": false, + "labels": [ + "Tag1", + "Tag2" + ], + "defaultDuration": "P1279DT12H30M5S", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/watchlists/GetWatchlistItemById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/watchlists/GetWatchlistItemById.json new file mode 100644 index 000000000000..4f5422c7b560 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/watchlists/GetWatchlistItemById.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "watchlistAlias": "highValueAsset", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "watchlistItemId": "3f8901fe-63d9-4875-9ad5-9fb3b8105797" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Watchlists/highValueAsset/WatchlistItems/fd37d325-7090-47fe-851a-5b5a00c3f576", + "name": "fd37d325-7090-47fe-851a-5b5a00c3f576", + "etag": "\"f2089bfa-0000-0d00-0000-601c58b42021\"", + "type": "Microsoft.SecurityInsights/Watchlists/WatchlistItems", + "properties": { + "watchlistItemType": "watchlist-item", + "watchlistItemId": "fd37d325-7090-47fe-851a-5b5a00c3f576", + "tenantId": "3f8901fe-63d9-4875-9ad5-9fb3b8105797", + "isDeleted": false, + "created": "2021-02-04T12:27:32.3783333-08:00", + "updated": "2021-02-04T12:27:32.3783333-08:00", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updatedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "itemsKeyValue": { + "Header-1": "v1_1", + "Header-2": "v1_2", + "Header-3": "v1_3", + "Header-4": "v1_4", + "Header-5": "v1_5" + }, + "entityMapping": {} + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/watchlists/GetWatchlistItems.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/watchlists/GetWatchlistItems.json new file mode 100644 index 000000000000..e7e87f1de447 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/watchlists/GetWatchlistItems.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "watchlistAlias": "highValueAsset" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Watchlists/highValueAsset/WatchlistItems/fd37d325-7090-47fe-851a-5b5a00c3f576", + "name": "fd37d325-7090-47fe-851a-5b5a00c3f576", + "etag": "\"f2089bfa-0000-0d00-0000-601c58b42021\"", + "type": "Microsoft.SecurityInsights/Watchlists/WatchlistItems", + "properties": { + "watchlistItemType": "watchlist-item", + "watchlistItemId": "fd37d325-7090-47fe-851a-5b5a00c3f576", + "tenantId": "3f8901fe-63d9-4875-9ad5-9fb3b8105797", + "isDeleted": false, + "created": "2021-02-04T12:27:32.3783333-08:00", + "updated": "2021-02-04T12:27:32.3783333-08:00", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updatedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "itemsKeyValue": { + "Header-1": "v1_1", + "Header-2": "v1_2", + "Header-3": "v1_3", + "Header-4": "v1_4", + "Header-5": "v1_5" + }, + "entityMapping": {} + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/watchlists/GetWatchlists.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/watchlists/GetWatchlists.json new file mode 100644 index 000000000000..ae148175f31d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/examples/watchlists/GetWatchlists.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2021-04-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/watchlists/highValueAsset", + "name": "highValueAsset", + "type": "Microsoft.SecurityInsights/Watchlists", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017", + "displayName": "High Value Assets Watchlist", + "provider": "Microsoft", + "source": "Local file", + "created": "2020-09-28T00:26:54.7746089+00:00", + "updated": "2020-09-28T00:26:57+00:00", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updatedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "description": "Watchlist from CSV content", + "watchlistType": "watchlist", + "watchlistAlias": "highValueAsset", + "itemsSearchKey": "header1", + "isDeleted": false, + "labels": [ + "Tag1", + "Tag2" + ], + "defaultDuration": "P1279DT12H30M5S", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/operations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/operations.json new file mode 100644 index 000000000000..0808512d4977 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2021-04-01/operations.json @@ -0,0 +1,140 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2021-04-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.SecurityInsights/operations": { + "get": { + "operationId": "Operations_List", + "description": "Lists all operations available Azure Security Insights Resource Provider.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK. Successfully retrieved operations list.", + "schema": { + "$ref": "#/definitions/OperationsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse", + "description": "The error object of the CloudError response" + } + }, + "type": "object", + "description": "An error response for a resource management request." + }, + "OperationsList": { + "description": "Lists the operations available in the SecurityInsights RP.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of operations.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "Array of operations", + "items": { + "$ref": "#/definitions/Operation" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "Operation": { + "description": "Operation provided by provider", + "properties": { + "display": { + "description": "Properties of the operation", + "properties": { + "description": { + "description": "Description of the operation", + "type": "string" + }, + "operation": { + "description": "Operation name", + "type": "string" + }, + "provider": { + "description": "Provider name", + "type": "string" + }, + "resource": { + "description": "Resource name", + "type": "string" + } + }, + "type": "object" + }, + "name": { + "description": "Name of the operation", + "type": "string" + }, + "origin": { + "description": "The origin of the operation", + "type": "string" + } + }, + "type": "object" + } + }, + "parameters": {} +} diff --git a/specification/securityinsights/resource-manager/common/1.0/types.json b/specification/securityinsights/resource-manager/common/1.0/types.json index e56d8f28b2b6..c7e07346ddb7 100644 --- a/specification/securityinsights/resource-manager/common/1.0/types.json +++ b/specification/securityinsights/resource-manager/common/1.0/types.json @@ -35,8 +35,42 @@ "type": "object", "x-ms-external": true }, + "EntityCommonProperties": { + "description": "Entity common property bag.", + "properties": { + "additionalData": { + "additionalProperties": { + "type": "object" + }, + "description": "A bag of custom fields that should be part of the entity and will be presented to the user.", + "readOnly": true, + "type": "object" + }, + "friendlyName": { + "description": "The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "ResourceWithEtag": { + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], "description": "An azure resource object with an Etag property", + "properties": { + "etag": { + "description": "Etag of the azure resource", + "type": "string" + } + }, + "type": "object" + }, + "Resource": { + "description": "An azure resource object", "properties": { "id": { "description": "Azure resource Id", @@ -53,10 +87,6 @@ "readOnly": true, "type": "string" }, - "etag": { - "description": "Etag of the azure resource", - "type": "string" - }, "systemData": { "readOnly": true, "type": "object", @@ -64,20 +94,11 @@ "$ref": "../../../../common-types/resource-management/v2/types.json#/definitions/systemData" } }, + "type": "object", "x-ms-azure-resource": true } }, "parameters": { - "ApiVersion": { - "description": "API version for the operation", - "enum": [ - "2021-03-01-preview" - ], - "in": "query", - "name": "api-version", - "required": true, - "type": "string" - }, "WorkspaceName": { "description": "The name of the workspace.", "in": "path", @@ -95,6 +116,67 @@ "required": true, "type": "string", "x-ms-parameter-location": "method" + }, + "ResourceGroupName": { + "description": "The name of the resource group within the user's subscription. The name is case insensitive.", + "in": "path", + "maxLength": 90, + "minLength": 1, + "name": "resourceGroupName", + "pattern": "^[-\\w\\._\\(\\)]+$", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SubscriptionId": { + "description": "Azure subscription ID", + "in": "path", + "name": "subscriptionId", + "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$", + "required": true, + "type": "string" + }, + "ODataFilter": { + "description": "Filters the results, based on a Boolean condition. Optional.", + "in": "query", + "name": "$filter", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ODataOrderBy": { + "description": "Sorts the results. Optional.", + "in": "query", + "name": "$orderby", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ODataSkipToken": { + "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. Optional.", + "in": "query", + "name": "$skipToken", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ODataTop": { + "description": "Returns only the first n results. Optional.", + "format": "int32", + "in": "query", + "name": "$top", + "required": false, + "type": "integer", + "x-ms-parameter-location": "method" + }, + "ODataSkip": { + "description": "Used to skip n elements in the OData query (offset). Returns a nextLink to the next page of results if there are any left.", + "in": "query", + "name": "$skip", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" } } } diff --git a/specification/securityinsights/resource-manager/readme.md b/specification/securityinsights/resource-manager/readme.md index a0e61c8c9e4a..58ac893841d9 100644 --- a/specification/securityinsights/resource-manager/readme.md +++ b/specification/securityinsights/resource-manager/readme.md @@ -29,13 +29,43 @@ openapi-type: arm tag: package-2020-01 ``` + +### Tag: package-2021-04-01-only + +These settings apply only when `--tag=package-2021-04-01-only` is specified on the command line. + +```yaml $(tag) == 'package-2021-04-01-only' +input-file: +- Microsoft.SecurityInsights/stable/2021-04-01/Incidents.json +- Microsoft.SecurityInsights/stable/2021-04-01/operations.json +- Microsoft.SecurityInsights/stable/2021-04-01/Watchlists.json +- Microsoft.SecurityInsights/stable/2021-04-01/ThreatIntelligence.json + +directive: + - suppress: R4017 + from: Microsoft.SecurityInsights/stable/2021-04-01/Incidents.json + where: $.definitions.Incidents + reason: The Incident does not support list by subscription. It's not a top-level resource. To get the Incident, we should have a subscription as well as a resource group and Log Analytics workspace. + - suppress: R4017 + from: Microsoft.SecurityInsights/stable/2021-04-01/Watchlists.json + where: $.definitions.Watchlist + reason: The Watchlist does not support list by subscription. It's not a top-level resource. To get the Watchlist, we should have a subscription as well as a resource group and Log Analytics workspace. +``` + +--- + ### Tag: package-2020-01 These settings apply only when `--tag=package-2020-01` is specified on the command line. + ```yaml $(tag) == 'package-2020-01' input-file: +- Microsoft.SecurityInsights/stable/2020-01-01/AlertRules.json +- Microsoft.SecurityInsights/stable/2020-01-01/Bookmarks.json +- Microsoft.SecurityInsights/stable/2020-01-01/DataConnectors.json - Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json + directive: - suppress: R2059 from: Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json @@ -51,12 +81,15 @@ These settings apply only when `--tag=package-2021-03-preview-only` is specified ```yaml $(tag) == 'package-2021-03-preview-only' input-file: +- Microsoft.SecurityInsights/preview/2021-03-01-preview/Incidents.json - Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json - Microsoft.SecurityInsights/preview/2021-03-01-preview/OnboardingStates.json - Microsoft.SecurityInsights/preview/2021-03-01-preview/operations.json - Microsoft.SecurityInsights/preview/2021-03-01-preview/SourceControls.json - Microsoft.SecurityInsights/preview/2021-03-01-preview/dataConnectors.json - Microsoft.SecurityInsights/preview/2021-03-01-preview/Watchlists.json +- Microsoft.SecurityInsights/preview/2021-03-01-preview/AlertRules.json +- Microsoft.SecurityInsights/preview/2021-03-01-preview/EntityQueries.json - Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json directive: - suppress: R4017 @@ -79,6 +112,26 @@ directive: from: Microsoft.SecurityInsights/preview/2021-03-01-preview/OnboardingStates.json where: $.definitions.SentinelOnboardingState reason: The SentinelOnboardingState does not support list by subscription. It's not a top-level resource. To get the SentinelOnboardingState, we should have a subscription as well as a resource group and Log Analytics workspace. + - suppress: R4017 + from: Microsoft.SecurityInsights/preview/2021-03-01-preview/Incidents.json + where: $.definitions.Incidents + reason: The Incidents does not support list by subscription. It's not a top-level resource. To get the Incidents, we should have a subscription as well as a resource group and Log Analytics workspace. + - suppress: R4017 + from: Microsoft.SecurityInsights/preview/2021-03-01-preview/Incidents.json + where: $.definitions.Incident + reason: The Incident does not support list by subscription. It's not a top-level resource. To get the Incident, we should have a subscription as well as a resource group, Log Analytics workspace and incident ID. + - suppress: R4017 + from: Microsoft.SecurityInsights/preview/2021-03-01-preview/AlertRules.json + where: $.definitions.AlertRule + reason: The AlertRule does not support list by subscription. It's not a top-level resource. To get the AlertRule, we should have a subscription as well as a resource group and Log Analytics workspace. + - suppress: R4017 + from: Microsoft.SecurityInsights/preview/2021-03-01-preview/AlertRules.json + where: $.definitions.AlertRuleTemplate + reason: The AlertRuleTemplate does not support list by subscription. It's not a top-level resource. To get the AlertRuleTemplate, we should have a subscription as well as a resource group and Log Analytics workspace. + - suppress: R4017 + from: Microsoft.SecurityInsights/preview/2021-03-01-preview/EntityQueries.json + where: $.definitions.EntityQuery + reason: The EntityQuery does not support list by subscription. It's not a top-level resource. To get the EntityQuery, we should have a subscription as well as a resource group and Log Analytics workspace. - suppress: R4017 from: Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json where: $.definitions.MetadataModel @@ -93,7 +146,16 @@ These settings apply only when `--tag=package-2019-01-preview` is specified on t ```yaml $(tag) == 'package-2019-01-preview' input-file: +- Microsoft.SecurityInsights/preview/2019-01-01-preview/Aggregations.json +- Microsoft.SecurityInsights/preview/2019-01-01-preview/AutomationRules.json +- Microsoft.SecurityInsights/preview/2019-01-01-preview/Bookmarks.json +- Microsoft.SecurityInsights/preview/2019-01-01-preview/Cases.json +- Microsoft.SecurityInsights/preview/2019-01-01-preview/DataConnectorsCheckRequirements.json +- Microsoft.SecurityInsights/preview/2019-01-01-preview/Enrichment.json +- Microsoft.SecurityInsights/preview/2019-01-01-preview/Entities.json +- Microsoft.SecurityInsights/preview/2019-01-01-preview/OfficeConsents.json - Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json +- Microsoft.SecurityInsights/preview/2019-01-01-preview/ThreatIntelligence.json directive: - suppress: R4017 from: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json @@ -108,6 +170,10 @@ directive: from: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json where: $.definitions.AutomationRule reason: The AutomationRule does not support list by subscription. It's not a top-level resource. To get the AutomationRule, we should have a subscription as well as a resource group and Log Analytics workspace. + - suppress: R4017 + from: Microsoft.SecurityInsights/preview/2019-01-01-preview/AutomationRules.json + where: $.definitions.AutomationRule + reason: The AutomationRule does not support list by subscription. It's not a top-level resource. To get the AutomationRule, we should have a subscription as well as a resource group and Log Analytics workspace. ``` --- diff --git a/specification/securityinsights/resource-manager/readme.python.md b/specification/securityinsights/resource-manager/readme.python.md index e7c2576215ec..32143c68c117 100644 --- a/specification/securityinsights/resource-manager/readme.python.md +++ b/specification/securityinsights/resource-manager/readme.python.md @@ -4,45 +4,21 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.securityinsight - package-name: azure-mgmt-securityinsight - package-version: 0.1.0 - clear-output-folder: true -``` ``` yaml $(python) && $(track2) -python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION -payload-flattening-threshold: 2 namespace: azure.mgmt.securityinsight package-name: azure-mgmt-securityinsight -package-version: 0.1.0 +package-version: 1.0.0b1 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-securityinsight/azure/mgmt/securityinsight -``` - -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-securityinsight -``` ``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true -output-folder: $(python-sdks-folder)/azure-mgmt-securityinsight/azure/mgmt/securityinsight +output-folder: $(python-sdks-folder)/securityinsight/azure-mgmt-securityinsight/azure/mgmt/securityinsight ``` ``` yaml $(python) && $(python-mode) == 'create' && $(track2) basic-setup-py: true -output-folder: $(python-sdks-folder)/azure-mgmt-securityinsight +output-folder: $(python-sdks-folder)/securityinsight/azure-mgmt-securityinsight ``` diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/AuthorizationRules.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/AuthorizationRules.json new file mode 100644 index 000000000000..e26b1166ef18 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/AuthorizationRules.json @@ -0,0 +1,1100 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2021-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules": { + "get": { + "tags": [ + "Namespaces AuthorizationRule" + ], + "operationId": "Namespaces_ListAuthorizationRules", + "x-ms-examples": { + "NameSpaceAuthorizationRuleListAll": { + "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleListAll.json" + } + }, + "description": "Gets the authorization rules for a namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639376.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace authorization rules returned successfully.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRuleListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}": { + "put": { + "tags": [ + "Namespaces AuthorizationRule" + ], + "operationId": "Namespaces_CreateOrUpdateAuthorizationRule", + "x-ms-examples": { + "NameSpaceAuthorizationRuleCreate": { + "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleCreate.json" + } + }, + "description": "Creates or updates an authorization rule for a namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639410.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + }, + "description": "The shared access authorization rule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace authorization rule created.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Namespaces AuthorizationRule" + ], + "operationId": "Namespaces_DeleteAuthorizationRule", + "x-ms-examples": { + "NameSpaceAuthorizationRuleDelete": { + "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleDelete.json" + } + }, + "description": "Deletes a namespace authorization rule.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639417.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace authorization rule successfully deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Namespaces AuthorizationRule" + ], + "operationId": "Namespaces_GetAuthorizationRule", + "x-ms-examples": { + "NameSpaceAuthorizationRuleGet": { + "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleGet.json" + } + }, + "description": "Gets an authorization rule for a namespace by rule name.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639392.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace authorization rule returned successfully.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/listKeys": { + "post": { + "tags": [ + "Namespaces AuthorizationRule" + ], + "operationId": "Namespaces_ListKeys", + "x-ms-examples": { + "NameSpaceAuthorizationRuleListKey": { + "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleListKey.json" + } + }, + "description": "Gets the primary and secondary connection strings for the namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639398.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings successfully returned.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/regenerateKeys": { + "post": { + "tags": [ + "Namespaces AuthorizationRule" + ], + "operationId": "Namespaces_RegenerateKeys", + "x-ms-examples": { + "NameSpaceAuthorizationRuleRegenerateKey": { + "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleRegenerateKey.json" + } + }, + "description": "Regenerates the primary or secondary connection strings for the namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt718977.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateAccessKeyParameters" + }, + "description": "Parameters supplied to regenerate the authorization rule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Authorization rule successfully regenerated.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules": { + "get": { + "tags": [ + "Queues AuthorizationRule" + ], + "operationId": "Queues_ListAuthorizationRules", + "x-ms-examples": { + "QueueAuthorizationRuleListAll": { + "$ref": "./examples/Queues/SBQueueAuthorizationRuleListAll.json" + } + }, + "description": "Gets all authorization rules for a queue.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt705607.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Authorization rules successfully returned.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRuleListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}": { + "put": { + "tags": [ + "Queues AuthorizationRule" + ], + "operationId": "Queues_CreateOrUpdateAuthorizationRule", + "x-ms-examples": { + "QueueAuthorizationRuleCreate": { + "$ref": "./examples/Queues/SBQueueAuthorizationRuleCreate.json" + } + }, + "description": "Creates an authorization rule for a queue.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + }, + "description": "The shared access authorization rule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Authorization rule successfully created.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Queues AuthorizationRule" + ], + "operationId": "Queues_DeleteAuthorizationRule", + "x-ms-examples": { + "QueueAuthorizationRuleDelete": { + "$ref": "./examples/Queues/SBQueueAuthorizationRuleDelete.json" + } + }, + "description": "Deletes a queue authorization rule.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt705609.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Authorization rule successfully deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Queues AuthorizationRule" + ], + "operationId": "Queues_GetAuthorizationRule", + "x-ms-examples": { + "QueueAuthorizationRuleGet": { + "$ref": "./examples/Queues/SBQueueAuthorizationRuleGet.json" + } + }, + "description": "Gets an authorization rule for a queue by rule name.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt705611.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Authorization rule successfully returned.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}/ListKeys": { + "post": { + "tags": [ + "Queues AuthorizationRule" + ], + "operationId": "Queues_ListKeys", + "x-ms-examples": { + "QueueAuthorizationRuleListKey": { + "$ref": "./examples/Queues/SBQueueAuthorizationRuleListKey.json" + } + }, + "description": "Primary and secondary connection strings to the queue.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt705608.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings successfully returned.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}/regenerateKeys": { + "post": { + "tags": [ + "Queues AuthorizationRule" + ], + "operationId": "Queues_RegenerateKeys", + "x-ms-examples": { + "QueueAuthorizationRuleRegenerateKey": { + "$ref": "./examples/Queues/SBQueueAuthorizationRuleRegenerateKey.json" + } + }, + "description": "Regenerates the primary or secondary connection strings to the queue.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt705606.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateAccessKeyParameters" + }, + "description": "Parameters supplied to regenerate the authorization rule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings successfully regenerated.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules": { + "get": { + "tags": [ + "Topics AuthorizationRule" + ], + "operationId": "Topics_ListAuthorizationRules", + "x-ms-examples": { + "TopicAuthorizationRuleListAll": { + "$ref": "./examples/Topics/SBTopicAuthorizationRuleListAll.json" + } + }, + "description": "Gets authorization rules for a topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt720681.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Authorization rules successfully returned.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRuleListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}": { + "put": { + "tags": [ + "Topics AuthorizationRule" + ], + "operationId": "Topics_CreateOrUpdateAuthorizationRule", + "x-ms-examples": { + "TopicAuthorizationRuleCreate": { + "$ref": "./examples/Topics/SBTopicAuthorizationRuleCreate.json" + } + }, + "description": "Creates an authorization rule for the specified topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt720678.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + }, + "description": "The shared access authorization rule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Topic authorization rule successfully created.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Topics AuthorizationRule" + ], + "operationId": "Topics_GetAuthorizationRule", + "x-ms-examples": { + "TopicAuthorizationRuleGet": { + "$ref": "./examples/Topics/SBTopicAuthorizationRuleGet.json" + } + }, + "description": "Returns the specified authorization rule.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt720676.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Topic authorization rule returned successfully.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Topics AuthorizationRule" + ], + "operationId": "Topics_DeleteAuthorizationRule", + "x-ms-examples": { + "TopicAuthorizationRuleDelete": { + "$ref": "./examples/Topics/SBTopicAuthorizationRuleDelete.json" + } + }, + "description": "Deletes a topic authorization rule.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt720681.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Topic authorization rule successfully deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}/ListKeys": { + "post": { + "tags": [ + "Topics AuthorizationRule" + ], + "operationId": "Topics_ListKeys", + "x-ms-examples": { + "TopicAuthorizationRuleListKey": { + "$ref": "./examples/Topics/SBTopicAuthorizationRuleListKey.json" + } + }, + "description": "Gets the primary and secondary connection strings for the topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt720677.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings successfully retrieved.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}/regenerateKeys": { + "post": { + "tags": [ + "Topics AuthorizationRule" + ], + "operationId": "Topics_RegenerateKeys", + "x-ms-examples": { + "TopicAuthorizationRuleRegenerateKey": { + "$ref": "./examples/Topics/SBTopicAuthorizationRuleRegenerateKey.json" + } + }, + "description": "Regenerates primary or secondary connection strings for the topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt720679.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateAccessKeyParameters" + }, + "description": "Parameters supplied to regenerate the authorization rule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings successfully regenerated.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "SBAuthorizationRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SBAuthorizationRule" + }, + "description": "Result of the List Authorization Rules operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of Authorization Rules." + } + }, + "description": "The response to the List Namespace operation." + }, + "SBAuthorizationRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "rights": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Manage", + "Send", + "Listen" + ], + "x-ms-enum": { + "name": "AccessRights", + "modelAsString": false + } + }, + "description": "The rights associated with the rule." + } + }, + "required": [ + "rights" + ], + "description": "AuthorizationRule properties." + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Description of a namespace authorization rule." + }, + "AccessKeys": { + "properties": { + "primaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Primary connection string of the created namespace authorization rule." + }, + "secondaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Secondary connection string of the created namespace authorization rule." + }, + "aliasPrimaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Primary connection string of the alias if GEO DR is enabled" + }, + "aliasSecondaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Secondary connection string of the alias if GEO DR is enabled" + }, + "primaryKey": { + "readOnly": true, + "type": "string", + "description": "A base64-encoded 256-bit primary key for signing and validating the SAS token." + }, + "secondaryKey": { + "readOnly": true, + "type": "string", + "description": "A base64-encoded 256-bit primary key for signing and validating the SAS token." + }, + "keyName": { + "readOnly": true, + "type": "string", + "description": "A string that describes the authorization rule." + } + }, + "description": "Namespace/ServiceBus Connection String" + }, + "RegenerateAccessKeyParameters": { + "properties": { + "keyType": { + "type": "string", + "description": "The access key to regenerate.", + "enum": [ + "PrimaryKey", + "SecondaryKey" + ], + "x-ms-enum": { + "name": "KeyType", + "modelAsString": false + } + }, + "key": { + "type": "string", + "description": "Optional, if the key value provided, is reset for KeyType value or autogenerate Key value set for keyType" + } + }, + "required": [ + "keyType" + ], + "description": "Parameters supplied to the Regenerate Authorization Rule operation, specifies which key needs to be reset." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/CheckNameAvailability.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/CheckNameAvailability.json new file mode 100644 index 000000000000..428a13f87907 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/CheckNameAvailability.json @@ -0,0 +1,132 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2021-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/CheckNameAvailability": { + "post": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_CheckNameAvailability", + "x-ms-examples": { + "NameSpaceCheckNameAvailability": { + "$ref": "./examples/NameSpaces/SBNameSpaceCheckNameAvailability.json" + } + }, + "description": "Check the give namespace name availability.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailability" + }, + "description": "Parameters to check availability of the given namespace name" + } + ], + "responses": { + "200": { + "description": "check availability returned successfully.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "CheckNameAvailability": { + "properties": { + "name": { + "type": "string", + "description": "The Name to check the namespace name availability and The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number." + } + }, + "required": [ + "name" + ], + "description": "Description of a Check Name availability request properties." + }, + "CheckNameAvailabilityResult": { + "properties": { + "message": { + "readOnly": true, + "type": "string", + "description": "The detailed info regarding the reason associated with the namespace." + }, + "nameAvailable": { + "type": "boolean", + "description": "Value indicating namespace is availability, true if the namespace is available; otherwise, false." + }, + "reason": { + "$ref": "#/definitions/UnavailableReason", + "description": "The reason for unavailability of a namespace." + } + }, + "description": "Description of a Check Name availability request properties." + }, + "UnavailableReason": { + "type": "string", + "enum": [ + "None", + "InvalidName", + "SubscriptionIsDisabled", + "NameInUse", + "NameInLockdown", + "TooManyNamespaceInCurrentSubscription" + ], + "x-ms-enum": { + "name": "UnavailableReason", + "modelAsString": false + }, + "description": "Specifies the reason for the unavailability of the service." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/DisasterRecoveryConfig.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/DisasterRecoveryConfig.json new file mode 100644 index 000000000000..16d470f3beed --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/DisasterRecoveryConfig.json @@ -0,0 +1,784 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2021-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/CheckNameAvailability": { + "post": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_CheckNameAvailability", + "x-ms-examples": { + "AliasNameAvailability": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasCheckNameAvailability.json" + } + }, + "description": "Check the give namespace name availability.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailability" + }, + "description": "Parameters to check availability of the given namespace name" + } + ], + "responses": { + "200": { + "description": "check availability returned successfully.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs": { + "get": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_List", + "x-ms-examples": { + "SBAliasList": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasList.json" + } + }, + "description": "Gets all Alias(Disaster Recovery configurations)", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of Alias(Disaster Recovery configurations) for servicebus namespace", + "schema": { + "$ref": "#/definitions/ArmDisasterRecoveryListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}": { + "put": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_CreateOrUpdate", + "x-ms-examples": { + "SBAliasCreate": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasCreate.json" + } + }, + "description": "Creates or updates a new Alias(Disaster Recovery configuration)", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArmDisasterRecovery" + }, + "description": "Parameters required to create an Alias(Disaster Recovery configuration)" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Alias(Disaster Recovery configuration) successfully created", + "schema": { + "$ref": "#/definitions/ArmDisasterRecovery" + } + }, + "201": { + "description": "Alias(Disaster Recovery configuration) creation request received" + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_Delete", + "x-ms-examples": { + "SBAliasDelete": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasDelete.json" + } + }, + "description": "Deletes an Alias(Disaster Recovery configuration)", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete Alias(Disaster Recovery configuration) request accepted" + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_Get", + "x-ms-examples": { + "SBAliasGet": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasGet.json" + } + }, + "description": "Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the Alias(Disaster Recovery configurations)", + "schema": { + "$ref": "#/definitions/ArmDisasterRecovery" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/breakPairing": { + "post": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_BreakPairing", + "x-ms-examples": { + "SBEHAliasBreakPairing": { + "$ref": "./examples/disasterRecoveryConfigs/SBEHAliasBreakPairing.json" + } + }, + "description": "This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Break-Pairing operation is successful." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/failover": { + "post": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_FailOver", + "x-ms-examples": { + "SBAliasFailOver": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasFailOver.json" + } + }, + "description": "Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/FailoverProperties" + }, + "description": "Parameters required to create an Alias(Disaster Recovery configuration)" + } + ], + "responses": { + "200": { + "description": "Failover operation is successful." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules": { + "get": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_ListAuthorizationRules", + "x-ms-examples": { + "NameSpaceAuthorizationRuleListAll": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListAll.json" + } + }, + "description": "Gets the authorization rules for a namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639376.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "DisasterRecoveryConfigs authorization rules returned successfully.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRuleListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules/{authorizationRuleName}": { + "get": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_GetAuthorizationRule", + "x-ms-examples": { + "DisasterRecoveryConfigsAuthorizationRuleGet": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleGet.json" + } + }, + "description": "Gets an authorization rule for a namespace by rule name.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639392.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "DisasterRecoveryConfigs authorization rule returned successfully.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/authorizationRules/{authorizationRuleName}/listKeys": { + "post": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_ListKeys", + "x-ms-examples": { + "DisasterRecoveryConfigsAuthorizationRuleListKey": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListKey.json" + } + }, + "description": "Gets the primary and secondary connection strings for the namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639398.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings successfully returned.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "SBAuthorizationRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SBAuthorizationRule" + }, + "description": "Result of the List Authorization Rules operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of Authorization Rules." + } + }, + "description": "The response to the List Namespace operation." + }, + "SBAuthorizationRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "rights": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Manage", + "Send", + "Listen" + ], + "x-ms-enum": { + "name": "AccessRights", + "modelAsString": false + } + }, + "description": "The rights associated with the rule." + } + }, + "required": [ + "rights" + ], + "description": "AuthorizationRule properties." + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Description of a namespace authorization rule." + }, + "AccessKeys": { + "properties": { + "primaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Primary connection string of the created namespace authorization rule." + }, + "secondaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Secondary connection string of the created namespace authorization rule." + }, + "aliasPrimaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Primary connection string of the alias if GEO DR is enabled" + }, + "aliasSecondaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Secondary connection string of the alias if GEO DR is enabled" + }, + "primaryKey": { + "readOnly": true, + "type": "string", + "description": "A base64-encoded 256-bit primary key for signing and validating the SAS token." + }, + "secondaryKey": { + "readOnly": true, + "type": "string", + "description": "A base64-encoded 256-bit primary key for signing and validating the SAS token." + }, + "keyName": { + "readOnly": true, + "type": "string", + "description": "A string that describes the authorization rule." + } + }, + "description": "Namespace/ServiceBus Connection String" + }, + "RegenerateAccessKeyParameters": { + "properties": { + "keyType": { + "type": "string", + "description": "The access key to regenerate.", + "enum": [ + "PrimaryKey", + "SecondaryKey" + ], + "x-ms-enum": { + "name": "KeyType", + "modelAsString": false + } + }, + "key": { + "type": "string", + "description": "Optional, if the key value provided, is reset for KeyType value or autogenerate Key value set for keyType" + } + }, + "required": [ + "keyType" + ], + "description": "Parameters supplied to the Regenerate Authorization Rule operation, specifies which key needs to be reset." + }, + "UnavailableReason": { + "type": "string", + "enum": [ + "None", + "InvalidName", + "SubscriptionIsDisabled", + "NameInUse", + "NameInLockdown", + "TooManyNamespaceInCurrentSubscription" + ], + "x-ms-enum": { + "name": "UnavailableReason", + "modelAsString": false + }, + "description": "Specifies the reason for the unavailability of the service." + }, + "CheckNameAvailability": { + "properties": { + "name": { + "type": "string", + "description": "The Name to check the namespace name availability and The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number." + } + }, + "required": [ + "name" + ], + "description": "Description of a Check Name availability request properties." + }, + "CheckNameAvailabilityResult": { + "properties": { + "message": { + "readOnly": true, + "type": "string", + "description": "The detailed info regarding the reason associated with the namespace." + }, + "nameAvailable": { + "type": "boolean", + "description": "Value indicating namespace is availability, true if the namespace is available; otherwise, false." + }, + "reason": { + "$ref": "#/definitions/UnavailableReason", + "description": "The reason for unavailability of a namespace." + } + }, + "description": "Description of a Check Name availability request properties." + }, + "ArmDisasterRecovery": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed'", + "enum": [ + "Accepted", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningStateDR", + "modelAsString": false + } + }, + "pendingReplicationOperationsCount": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "Number of entities pending to be replicated." + }, + "partnerNamespace": { + "type": "string", + "description": "ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing" + }, + "alternateName": { + "type": "string", + "description": "Primary/Secondary eventhub namespace name, which is part of GEO DR pairing" + }, + "role": { + "readOnly": true, + "type": "string", + "description": "role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary'", + "enum": [ + "Primary", + "PrimaryNotReplicating", + "Secondary" + ], + "x-ms-enum": { + "name": "RoleDisasterRecovery", + "modelAsString": false + } + } + }, + "description": "Properties required to the Create Or Update Alias(Disaster Recovery configurations)" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Single item in List or Get Alias(Disaster Recovery configuration) operation" + }, + "FailoverProperties": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "IsSafeFailover": { + "type": "boolean", + "description": "Safe failover is to indicate the service should wait for pending replication to finish before switching to the secondary." + } + }, + "description": "Safe failover is to indicate the service should wait for pending replication to finish before switching to the secondary." + } + }, + "description": "Safe failover is to indicate the service should wait for pending replication to finish before switching to the secondary." + }, + "ArmDisasterRecoveryListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ArmDisasterRecovery" + }, + "description": "List of Alias(Disaster Recovery configurations)" + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if Value contains incomplete list of Alias(Disaster Recovery configuration)" + } + }, + "description": "The result of the List Alias(Disaster Recovery configuration) operation." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/Queue.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/Queue.json new file mode 100644 index 000000000000..6b30992ffc75 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/Queue.json @@ -0,0 +1,386 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2021-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues": { + "get": { + "tags": [ + "Queues" + ], + "operationId": "Queues_ListByNamespace", + "x-ms-examples": { + "QueueListByNameSpace": { + "$ref": "./examples/Queues/SBQueueListByNameSpace.json" + } + }, + "description": "Gets the queues within a namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639415.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SkipParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "Queues successfully returned.", + "schema": { + "$ref": "#/definitions/SBQueueListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}": { + "put": { + "tags": [ + "Queues" + ], + "operationId": "Queues_CreateOrUpdate", + "x-ms-examples": { + "QueueCreate": { + "$ref": "./examples/Queues/SBQueueCreate.json" + } + }, + "description": "Creates or updates a Service Bus queue. This operation is idempotent.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639395.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBQueue" + }, + "description": "Parameters supplied to create or update a queue resource." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Queue successfully created.", + "schema": { + "$ref": "#/definitions/SBQueue" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Queues" + ], + "operationId": "Queues_Delete", + "x-ms-examples": { + "QueueDelete": { + "$ref": "./examples/Queues/SBQueueDelete.json" + } + }, + "description": "Deletes a queue from the specified namespace in a resource group.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639411.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Queue successfully deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Queues" + ], + "operationId": "Queues_Get", + "x-ms-examples": { + "QueueGet": { + "$ref": "./examples/Queues/SBQueueGet.json" + } + }, + "description": "Returns a description for the specified queue.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639380.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Queue description successfully returned.", + "schema": { + "$ref": "#/definitions/SBQueue" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "SBQueueListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SBQueue" + }, + "description": "Result of the List Queues operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of queues." + } + }, + "description": "The response to the List Queues operation." + }, + "SBQueue": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SBQueueProperties", + "description": "Queue Properties" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Description of queue Resource." + }, + "SBQueueProperties": { + "properties": { + "countDetails": { + "readOnly": true, + "$ref": "../../../common/v1/definitions.json#/definitions/MessageCountDetails", + "description": "Message Count Details." + }, + "createdAt": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The exact time the message was created." + }, + "updatedAt": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The exact time the message was updated." + }, + "accessedAt": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Last time a message was sent, or the last time there was a receive request to this queue." + }, + "sizeInBytes": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "The size of the queue, in bytes." + }, + "messageCount": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "The number of messages in the queue." + }, + "lockDuration": { + "format": "duration", + "type": "string", + "description": "ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute." + }, + "maxSizeInMegabytes": { + "format": "int32", + "type": "integer", + "description": "The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024." + }, + "requiresDuplicateDetection": { + "type": "boolean", + "description": "A value indicating if this queue requires duplicate detection." + }, + "requiresSession": { + "type": "boolean", + "description": "A value that indicates whether the queue supports the concept of sessions." + }, + "defaultMessageTimeToLive": { + "format": "duration", + "type": "string", + "description": "ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself." + }, + "deadLetteringOnMessageExpiration": { + "type": "boolean", + "description": "A value that indicates whether this queue has dead letter support when a message expires." + }, + "duplicateDetectionHistoryTimeWindow": { + "format": "duration", + "type": "string", + "description": "ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes." + }, + "maxDeliveryCount": { + "format": "int32", + "type": "integer", + "description": "The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10." + }, + "status": { + "$ref": "../../../common/v1/definitions.json#/definitions/EntityStatus", + "description": "Enumerates the possible values for the status of a messaging entity." + }, + "enableBatchedOperations": { + "type": "boolean", + "description": "Value that indicates whether server-side batched operations are enabled." + }, + "autoDeleteOnIdle": { + "format": "duration", + "type": "string", + "description": "ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes." + }, + "enablePartitioning": { + "type": "boolean", + "description": "A value that indicates whether the queue is to be partitioned across multiple message brokers." + }, + "enableExpress": { + "type": "boolean", + "description": "A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage." + }, + "forwardTo": { + "type": "string", + "description": "Queue/Topic name to forward the messages" + }, + "forwardDeadLetteredMessagesTo": { + "type": "string", + "description": "Queue/Topic name to forward the Dead Letter message" + } + }, + "description": "The Queue Properties definition." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/Rules.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/Rules.json new file mode 100644 index 000000000000..b24e1620625f --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/Rules.json @@ -0,0 +1,449 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2021-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}/rules": { + "get": { + "tags": [ + "Rules" + ], + "operationId": "Rules_ListBySubscriptions", + "x-ms-examples": { + "RulesListBySubscriptions": { + "$ref": "./examples/Rules/RuleListBySubscription.json" + } + }, + "description": "List all the rules within given topic-subscription", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SkipParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved list of Rules.", + "schema": { + "$ref": "#/definitions/RuleListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}/rules/{ruleName}": { + "put": { + "tags": [ + "Rules" + ], + "operationId": "Rules_CreateOrUpdate", + "x-ms-examples": { + "RulesCreateOrUpdate": { + "$ref": "./examples/Rules/RuleCreate.json" + }, + "RulesCreateSqlFilter": { + "$ref": "./examples/Rules/RuleCreate_SqlFilter.json" + }, + "RulesCreateCorrelationFilter": { + "$ref": "./examples/Rules/RuleCreate_CorrelationFilter.json" + } + }, + "description": "Creates a new rule and updates an existing rule", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/RuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Rule" + }, + "description": "Parameters supplied to create a rule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Rule created.", + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Rules" + ], + "operationId": "Rules_Delete", + "x-ms-examples": { + "RulesDelete": { + "$ref": "./examples/Rules/RuleDelete.json" + } + }, + "description": "Deletes an existing rule.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/RuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Rule deleted." + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Subscriptions" + ], + "operationId": "Rules_Get", + "x-ms-examples": { + "RulesGet": { + "$ref": "./examples/Rules/RuleGet.json" + } + }, + "description": "Retrieves the description for the specified rule.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/RuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved rule description.", + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "Rule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/Ruleproperties", + "description": "Properties of Rule resource" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Description of Rule Resource." + }, + "Ruleproperties": { + "properties": { + "action": { + "$ref": "#/definitions/Action", + "description": "Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression." + }, + "filterType": { + "$ref": "#/definitions/FilterType", + "description": "Filter type that is evaluated against a BrokeredMessage." + }, + "sqlFilter": { + "$ref": "#/definitions/SqlFilter", + "description": "Properties of sqlFilter" + }, + "correlationFilter": { + "$ref": "#/definitions/CorrelationFilter", + "description": "Properties of correlationFilter" + } + }, + "description": "Description of Rule Resource." + }, + "RuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Rule" + }, + "description": "Result of the List Rules operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of rules" + } + }, + "description": "The response of the List rule operation." + }, + "FilterType": { + "type": "string", + "enum": [ + "SqlFilter", + "CorrelationFilter" + ], + "x-ms-enum": { + "name": "FilterType", + "modelAsString": false + }, + "description": "Rule filter types" + }, + "SqlFilter": { + "type": "object", + "properties": { + "sqlExpression": { + "type": "string", + "description": "The SQL expression. e.g. MyProperty='ABC'" + }, + "compatibilityLevel": { + "format": "int32", + "type": "integer", + "default": 20, + "minimum": 20, + "maximum": 20, + "description": "This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20." + }, + "requiresPreprocessing": { + "type": "boolean", + "default": true, + "description": "Value that indicates whether the rule action requires preprocessing." + } + }, + "description": "Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline." + }, + "CorrelationFilter": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "dictionary object for custom filters" + }, + "correlationId": { + "type": "string", + "description": "Identifier of the correlation." + }, + "messageId": { + "type": "string", + "description": "Identifier of the message." + }, + "to": { + "type": "string", + "description": "Address to send to." + }, + "replyTo": { + "type": "string", + "description": "Address of the queue to reply to." + }, + "label": { + "type": "string", + "description": "Application specific label." + }, + "sessionId": { + "type": "string", + "description": "Session identifier." + }, + "replyToSessionId": { + "type": "string", + "description": "Session identifier to reply to." + }, + "contentType": { + "type": "string", + "description": "Content type of the message." + }, + "requiresPreprocessing": { + "type": "boolean", + "default": true, + "description": "Value that indicates whether the rule action requires preprocessing." + } + }, + "description": "Represents the correlation filter expression." + }, + "Action": { + "type": "object", + "properties": { + "sqlExpression": { + "type": "string", + "description": "SQL expression. e.g. MyProperty='ABC'" + }, + "compatibilityLevel": { + "format": "int32", + "type": "integer", + "description": "This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20." + }, + "requiresPreprocessing": { + "type": "boolean", + "default": true, + "description": "Value that indicates whether the rule action requires preprocessing." + } + }, + "description": "Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression." + }, + "SqlRuleAction": { + "type": "object", + "properties": { + "sqlExpression": { + "type": "string", + "description": "SQL expression. e.g. MyProperty='ABC'" + }, + "compatibilityLevel": { + "format": "int32", + "type": "integer", + "description": "This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20." + }, + "requiresPreprocessing": { + "type": "boolean", + "default": true, + "description": "Value that indicates whether the rule action requires preprocessing." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Action" + } + ], + "description": "Represents set of actions written in SQL language-based syntax that is performed against a ServiceBus.Messaging.BrokeredMessage " + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationCompleteMigration.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationCompleteMigration.json new file mode 100644 index 000000000000..957c406222c8 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationCompleteMigration.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-41", + "resourceGroupName": "ResourceGroup", + "api-version": "2021-06-01-preview", + "configName": "$default", + "subscriptionId": "SubscriptionId" + }, + "responses": { + "200": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationCreateAndStartMigration.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationCreateAndStartMigration.json new file mode 100644 index 000000000000..1d6433c31f95 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationCreateAndStartMigration.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-41", + "resourceGroupName": "ResourceGroup", + "api-version": "2021-06-01-preview", + "subscriptionId": "SubscriptionId", + "configName": "$default", + "parameters": { + "properties": { + "targetNamespace": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-4028", + "postMigrationName": "sdk-PostMigration-5919" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-41/migrationConfigs/$default", + "name": "sdk-Namespace-41", + "type": "Microsoft.ServiceBus/Namespaces/disasterrecoveryconfigs", + "properties": { + "provisioningState": "Accepted", + "targetNamespace": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-4028", + "postMigrationName": "sdk-PostMigration-5919", + "migrationState": "Initiating" + } + } + }, + "201": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationDelete.json new file mode 100644 index 000000000000..9e358c85e0f8 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-41", + "resourceGroupName": "ResourceGroup", + "api-version": "2021-06-01-preview", + "configName": "$default", + "subscriptionId": "SubscriptionId" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationGet.json new file mode 100644 index 000000000000..85f8d3ea25f3 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-41", + "resourceGroupName": "ResourceGroup", + "api-version": "2021-06-01-preview", + "configName": "$default", + "subscriptionId": "SubscriptionId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-41/migrationConfigs/$default", + "name": "sdk-Namespace-41", + "type": "Microsoft.ServiceBus/Namespaces/disasterrecoveryconfigs", + "properties": { + "provisioningState": "Succeeded", + "targetNamespace": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-4028", + "postMigrationName": "sdk-PostMigration-5919", + "pendingReplicationOperationsCount": 0, + "migrationState": "Active" + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationList.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationList.json new file mode 100644 index 000000000000..a32e73d05b74 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-9259", + "resourceGroupName": "ResourceGroup", + "api-version": "2021-06-01-preview", + "configName": "$default", + "subscriptionId": "SubscriptionId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9259/migrationConfigs/sdk-Namespace-9259", + "name": "sdk-Namespace-9259", + "type": "Microsoft.ServiceBus/Namespaces/migrationconfigurations", + "properties": { + "provisioningState": "Succeeded", + "targetNamespace": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-7454", + "postMigrationName": "sdk-PostMigration-9423", + "migrationState": "Active" + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationRevert.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationRevert.json new file mode 100644 index 000000000000..957c406222c8 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Migrationconfigurations/SBMigrationconfigurationRevert.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-41", + "resourceGroupName": "ResourceGroup", + "api-version": "2021-06-01-preview", + "configName": "$default", + "subscriptionId": "SubscriptionId" + }, + "responses": { + "200": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/PrivateEndPointConnectionCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/PrivateEndPointConnectionCreate.json new file mode 100644 index 000000000000..e77a971c3e61 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/PrivateEndPointConnectionCreate.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-2924", + "resourceGroupName": "ArunMonocle", + "api-version": "2021-06-01-preview", + "subscriptionId": "subID", + "privateEndpointConnectionName": "privateEndpointConnectionName", + "parameters": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-8396/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-2847" + }, + "privateLinkServiceConnectionState": { + "status": "Rejected", + "description": "testing" + }, + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/PrivateEndPointConnectionDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/PrivateEndPointConnectionDelete.json new file mode 100644 index 000000000000..4b705e98710b --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/PrivateEndPointConnectionDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-3285", + "resourceGroupName": "ArunMonocle", + "privateEndpointConnectionName": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/PrivateEndPointConnectionGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/PrivateEndPointConnectionGet.json new file mode 100644 index 000000000000..401169b0cbf0 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/PrivateEndPointConnectionGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5828", + "resourceGroupName": "SDK-ServiceBus-4794", + "privateEndpointConnectionName": "privateEndpointConnectionName", + "api-version": "2021-06-01-preview", + "subscriptionId": "subID" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateEndpointConnections/privateEndpointConnectionName", + "name": "privateEndpointConnectionName", + "type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/PrivateEndPointConnectionList.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/PrivateEndPointConnectionList.json new file mode 100644 index 000000000000..11afeb3e33c4 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/PrivateEndPointConnectionList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5828", + "resourceGroupName": "SDK-ServiceBus-4794", + "api-version": "2021-06-01-preview", + "subscriptionId": "subID" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-7182/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5705-new/privateEndpointConnections/5dc668b3-70e4-437f-b61c-a3c1e594be7a", + "name": "5dc668b3-70e4-437f-b61c-a3c1e594be7a", + "type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-7182/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5705-new" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/PrivateLinkResourcesGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/PrivateLinkResourcesGet.json new file mode 100644 index 000000000000..98d5b6c65c93 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/PrivateLinkResourcesGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-2924", + "resourceGroupName": "ArunMonocle", + "api-version": "2021-06-01-preview", + "subscriptionId": "subID" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/subID/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateLinkResources/namespace", + "name": "namespace", + "type": "Microsoft.ServiceBus/namespaces/privateLinkResources", + "properties": { + "groupId": "namespace", + "requiredMembers": [ + "namespace" + ], + "requiredZoneNames": [ + "privatelink.servicebus.windows.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleCreate.json new file mode 100644 index 000000000000..cb1d6c257128 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleCreate.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6914", + "authorizationRuleName": "sdk-AuthRules-1788", + "resourceGroupName": "ArunMonocle", + "api-version": "2021-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-6914/AuthorizationRules/sdk-AuthRules-1788", + "name": "sdk-AuthRules-1788", + "type": "Microsoft.ServiceBus/Namespaces/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleDelete.json new file mode 100644 index 000000000000..1b093cf6f918 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "namespaceName": "sdk-namespace-6914", + "authorizationRuleName": "sdk-AuthRules-1788", + "resourceGroupName": "ArunMonocle", + "api-version": "2021-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleGet.json new file mode 100644 index 000000000000..5d1d48d0022a --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6914", + "authorizationRuleName": "sdk-AuthRules-1788", + "resourceGroupName": "ArunMonocle", + "api-version": "2021-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-6914/AuthorizationRules/sdk-AuthRules-1788/", + "name": "sdk-AuthRules-1788", + "type": "Microsoft.ServiceBus/Namespaces/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleListAll.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleListAll.json new file mode 100644 index 000000000000..4c65c801ebc3 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleListAll.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6914", + "resourceGroupName": "ArunMonocle", + "api-version": "2021-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "https://sbgm.windows-int.net/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-6914/AuthorizationRules?api-version=2017-04-01/RootManageSharedAccessKey", + "name": "RootManageSharedAccessKey", + "type": "Microsoft.ServiceBus/Namespaces/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Manage", + "Send" + ] + } + }, + { + "id": "https://sbgm.windows-int.net/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-6914/AuthorizationRules?api-version=2017-04-01/sdk-AuthRules-1788", + "name": "sdk-AuthRules-1788", + "type": "Microsoft.ServiceBus/Namespaces/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleListKey.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleListKey.json new file mode 100644 index 000000000000..95bef08f70f3 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleListKey.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "namespaceName": "sdk-namespace-6914", + "authorizationRuleName": "sdk-AuthRules-1788", + "resourceGroupName": "ArunMonocle", + "api-version": "2021-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "primaryConnectionString": "Endpoint=sb://sdk-namespace-6914.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-1788;SharedAccessKey=############################################", + "secondaryConnectionString": "Endpoint=sb://sdk-namespace-6914.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-1788;SharedAccessKey=############################################", + "primaryKey": "############################################", + "secondaryKey": "############################################", + "keyName": "sdk-AuthRules-1788" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleRegenerateKey.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleRegenerateKey.json new file mode 100644 index 000000000000..28265e7bfbcf --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceAuthorizationRuleRegenerateKey.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "namespaceName": "sdk-namespace-6914", + "authorizationRuleName": "sdk-AuthRules-1788", + "resourceGroupName": "ArunMonocle", + "api-version": "2021-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "keyType": "PrimaryKey" + } + }, + "responses": { + "200": { + "body": { + "primaryConnectionString": "Endpoint=sb://sdk-namespace-6914.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-1788;SharedAccessKey=#############################################", + "secondaryConnectionString": "Endpoint=sb://sdk-namespace-6914.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-1788;SharedAccessKey=#############################################", + "primaryKey": "#############################################", + "secondaryKey": "#############################################", + "keyName": "sdk-AuthRules-1788" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceCheckNameAvailability.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceCheckNameAvailability.json new file mode 100644 index 000000000000..e071032ba0de --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceCheckNameAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2021-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "name": "sdk-Namespace-2924" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "reason": "None", + "message": "" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceCreate.json new file mode 100644 index 000000000000..4d72b8436433 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceCreate.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace2924", + "resourceGroupName": "ArunMonocle", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924", + "name": "sdk-Namespace-2924", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Created", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-2924", + "createdAt": "2017-05-25T22:26:36.76Z", + "updatedAt": "2017-05-25T22:26:36.76Z", + "serviceBusEndpoint": "https://sdk-Namespace-2924.servicebus.windows-int.net:443/" + } + } + }, + "201": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924", + "name": "sdk-Namespace-2924", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Created", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-2924", + "createdAt": "2017-05-25T22:26:36.76Z", + "updatedAt": "2017-05-25T22:26:36.76Z", + "serviceBusEndpoint": "https://sdk-Namespace-2924.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + } + }, + "202": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceDelete.json new file mode 100644 index 000000000000..eefb514ef5ac --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-3285", + "resourceGroupName": "ArunMonocle", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceGet.json new file mode 100644 index 000000000000..943b19c13059 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceGet.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-2924", + "resourceGroupName": "ArunMonocle", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924", + "name": "sdk-Namespace-2924", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-2924", + "createdAt": "2017-05-25T22:26:36.76Z", + "updatedAt": "2017-05-25T22:26:59.35Z", + "serviceBusEndpoint": "https://sdk-Namespace-2924.servicebus.windows-int.net:443/", + "disableLocalAuth": false, + "privateEndpointConnections": [ + { + "id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample/privateEndpointConnections/privateEndpointConnectionName", + "name": "privateEndpointConnectionName", + "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.Network/privateEndpoints/NamespaceSample" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceList.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceList.json new file mode 100644 index 000000000000..687325f0e54d --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceList.json @@ -0,0 +1,875 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-91f08e47-2b04-4943-b0cd-a5fb02b88f20", + "name": "NS-91f08e47-2b04-4943-b0cd-a5fb02b88f20", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-91f08e47-2b04-4943-b0cd-a5fb02b88f20", + "createdAt": "2016-08-23T02:40:17.27Z", + "updatedAt": "2017-02-11T07:15:30.78Z", + "serviceBusEndpoint": "https://NS-91f08e47-2b04-4943-b0cd-a5fb02b88f20.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-41dc63f4-0b08-4029-b3ef-535a131bfa65", + "name": "NS-41dc63f4-0b08-4029-b3ef-535a131bfa65", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-41dc63f4-0b08-4029-b3ef-535a131bfa65", + "createdAt": "2016-08-23T03:50:38.98Z", + "updatedAt": "2017-02-11T10:42:58.003Z", + "serviceBusEndpoint": "https://NS-41dc63f4-0b08-4029-b3ef-535a131bfa65.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-df52cf51-e831-4bf2-bd92-e9885f68a996", + "name": "NS-df52cf51-e831-4bf2-bd92-e9885f68a996", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-df52cf51-e831-4bf2-bd92-e9885f68a996", + "createdAt": "2016-09-16T01:17:54.997Z", + "updatedAt": "2017-02-11T06:44:39.737Z", + "serviceBusEndpoint": "https://NS-df52cf51-e831-4bf2-bd92-e9885f68a996.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Premium", + "tier": "Premium", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/RapscallionResources/providers/Microsoft.ServiceBus/namespaces/SBPremium", + "name": "SBPremium", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Created", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sbpremium", + "createdAt": "2016-10-10T22:01:00.42Z", + "updatedAt": "2016-10-10T22:01:00.42Z", + "serviceBusEndpoint": "https://SBPremium.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/sadfsadfsadf/providers/Microsoft.ServiceBus/namespaces/rrama-ns2", + "name": "rrama-ns2", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:rrama-ns2", + "createdAt": "2016-08-23T04:14:00.013Z", + "updatedAt": "2017-02-03T22:53:32.927Z", + "serviceBusEndpoint": "https://rrama-ns2.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-20e57600-29d0-4035-ac85-74f4c54dcda1", + "name": "NS-20e57600-29d0-4035-ac85-74f4c54dcda1", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-20e57600-29d0-4035-ac85-74f4c54dcda1", + "createdAt": "2016-08-23T03:30:49.16Z", + "updatedAt": "2017-02-11T04:17:58.483Z", + "serviceBusEndpoint": "https://NS-20e57600-29d0-4035-ac85-74f4c54dcda1.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-3e538a1a-58fb-4315-b2ce-76f5c944114c", + "name": "NS-3e538a1a-58fb-4315-b2ce-76f5c944114c", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-3e538a1a-58fb-4315-b2ce-76f5c944114c", + "createdAt": "2016-09-16T18:07:30.05Z", + "updatedAt": "2017-02-11T10:42:57.747Z", + "serviceBusEndpoint": "https://NS-3e538a1a-58fb-4315-b2ce-76f5c944114c.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Premium", + "tier": "Premium", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/prem-ns123", + "name": "prem-ns123", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Created", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:prem-ns123", + "createdAt": "2016-09-13T00:02:39.997Z", + "updatedAt": "2016-09-13T00:02:39.997Z", + "serviceBusEndpoint": "https://prem-ns123.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-4e1bfdf1-0cff-4e86-ae80-cdcac4873039", + "name": "NS-4e1bfdf1-0cff-4e86-ae80-cdcac4873039", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-4e1bfdf1-0cff-4e86-ae80-cdcac4873039", + "createdAt": "2016-09-16T01:01:58.73Z", + "updatedAt": "2017-02-11T03:02:59.8Z", + "serviceBusEndpoint": "https://NS-4e1bfdf1-0cff-4e86-ae80-cdcac4873039.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-6b90b7f3-7aa0-48c9-bc30-b299dcb66c03", + "name": "NS-6b90b7f3-7aa0-48c9-bc30-b299dcb66c03", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-6b90b7f3-7aa0-48c9-bc30-b299dcb66c03", + "createdAt": "2016-08-23T03:22:45.327Z", + "updatedAt": "2017-02-11T06:08:01.207Z", + "serviceBusEndpoint": "https://NS-6b90b7f3-7aa0-48c9-bc30-b299dcb66c03.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-c05e9df3-7737-44ee-a321-15f6e0545b97", + "name": "NS-c05e9df3-7737-44ee-a321-15f6e0545b97", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-c05e9df3-7737-44ee-a321-15f6e0545b97", + "createdAt": "2016-08-05T03:29:19.75Z", + "updatedAt": "2017-02-11T08:10:35.527Z", + "serviceBusEndpoint": "https://NS-c05e9df3-7737-44ee-a321-15f6e0545b97.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-dcb4152c-231b-4c16-a683-07cc6b38fa46", + "name": "NS-dcb4152c-231b-4c16-a683-07cc6b38fa46", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-dcb4152c-231b-4c16-a683-07cc6b38fa46", + "createdAt": "2016-08-05T03:34:35.363Z", + "updatedAt": "2017-02-11T05:33:00.957Z", + "serviceBusEndpoint": "https://NS-dcb4152c-231b-4c16-a683-07cc6b38fa46.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-f501f5e6-1f24-439b-8982-9af665156d40", + "name": "NS-f501f5e6-1f24-439b-8982-9af665156d40", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-f501f5e6-1f24-439b-8982-9af665156d40", + "createdAt": "2016-09-16T01:25:55.707Z", + "updatedAt": "2017-02-11T07:42:59.687Z", + "serviceBusEndpoint": "https://NS-f501f5e6-1f24-439b-8982-9af665156d40.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-fe2ed660-2cd6-46f2-a9c3-7e11551a1f30", + "name": "NS-fe2ed660-2cd6-46f2-a9c3-7e11551a1f30", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-fe2ed660-2cd6-46f2-a9c3-7e11551a1f30", + "createdAt": "2016-08-23T02:32:08.227Z", + "updatedAt": "2017-02-11T06:32:57.77Z", + "serviceBusEndpoint": "https://NS-fe2ed660-2cd6-46f2-a9c3-7e11551a1f30.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-8a5e3b4e-4e97-4d85-9083-cd33536c9d71", + "name": "NS-8a5e3b4e-4e97-4d85-9083-cd33536c9d71", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-8a5e3b4e-4e97-4d85-9083-cd33536c9d71", + "createdAt": "2016-09-16T00:54:05.103Z", + "updatedAt": "2017-02-11T10:43:50.313Z", + "serviceBusEndpoint": "https://NS-8a5e3b4e-4e97-4d85-9083-cd33536c9d71.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-6520cc09-01ac-40a3-bc09-c5c431116e92", + "name": "NS-6520cc09-01ac-40a3-bc09-c5c431116e92", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-6520cc09-01ac-40a3-bc09-c5c431116e92", + "createdAt": "2016-09-16T01:49:59.243Z", + "updatedAt": "2017-02-11T08:15:36.95Z", + "serviceBusEndpoint": "https://NS-6520cc09-01ac-40a3-bc09-c5c431116e92.servicebus.windows-int.net:443", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-bfba6d5c-a425-42d9-85db-0f4da770e29a", + "name": "NS-bfba6d5c-a425-42d9-85db-0f4da770e29a", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-bfba6d5c-a425-42d9-85db-0f4da770e29a", + "createdAt": "2016-08-05T03:23:32.083Z", + "updatedAt": "2017-02-11T09:02:57.433Z", + "serviceBusEndpoint": "https://NS-bfba6d5c-a425-42d9-85db-0f4da770e29a.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Premium", + "tier": "Premium", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/RapscallionResources/providers/Microsoft.ServiceBus/namespaces/SBPrem", + "name": "SBPrem", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Created", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sbprem", + "createdAt": "2016-10-10T22:16:30.87Z", + "updatedAt": "2016-10-10T22:16:30.87Z", + "serviceBusEndpoint": "https://SBPrem.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-43b136b4-8716-40b2-97c5-0d77cac0062c", + "name": "NS-43b136b4-8716-40b2-97c5-0d77cac0062c", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-43b136b4-8716-40b2-97c5-0d77cac0062c", + "createdAt": "2016-08-23T03:14:50.577Z", + "updatedAt": "2017-02-11T09:23:01.067Z", + "serviceBusEndpoint": "https://NS-43b136b4-8716-40b2-97c5-0d77cac0062c.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-7c0443de-5f88-450c-b574-83f60a097dd1", + "name": "NS-7c0443de-5f88-450c-b574-83f60a097dd1", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-7c0443de-5f88-450c-b574-83f60a097dd1", + "createdAt": "2016-08-23T04:07:15.397Z", + "updatedAt": "2017-02-11T04:03:03.097Z", + "serviceBusEndpoint": "https://NS-7c0443de-5f88-450c-b574-83f60a097dd1.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-62dd7753-a5f9-42fd-a354-ca38a4505d69", + "name": "NS-62dd7753-a5f9-42fd-a354-ca38a4505d69", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-62dd7753-a5f9-42fd-a354-ca38a4505d69", + "createdAt": "2016-09-16T01:33:50.45Z", + "updatedAt": "2017-02-11T05:35:33.053Z", + "serviceBusEndpoint": "https://NS-62dd7753-a5f9-42fd-a354-ca38a4505d69.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-ae18a18c-97ab-4089-965d-8acbf4794091", + "name": "NS-ae18a18c-97ab-4089-965d-8acbf4794091", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-ae18a18c-97ab-4089-965d-8acbf4794091", + "createdAt": "2016-08-23T02:43:36.517Z", + "updatedAt": "2017-02-11T12:40:30.587Z", + "serviceBusEndpoint": "https://NS-ae18a18c-97ab-4089-965d-8acbf4794091.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-8e3b56c1-0ee8-4e13-ae88-5cadf6e2ce11", + "name": "NS-8e3b56c1-0ee8-4e13-ae88-5cadf6e2ce11", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-8e3b56c1-0ee8-4e13-ae88-5cadf6e2ce11", + "createdAt": "2016-09-16T00:46:03.773Z", + "updatedAt": "2017-02-11T04:43:54.56Z", + "serviceBusEndpoint": "https://NS-8e3b56c1-0ee8-4e13-ae88-5cadf6e2ce11.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-7ffca4b4-4728-4fb0-b2d0-1e7c016e3a44", + "name": "NS-7ffca4b4-4728-4fb0-b2d0-1e7c016e3a44", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-7ffca4b4-4728-4fb0-b2d0-1e7c016e3a44", + "createdAt": "2016-08-23T03:59:12.1Z", + "updatedAt": "2017-02-11T06:33:52.23Z", + "serviceBusEndpoint": "https://NS-7ffca4b4-4728-4fb0-b2d0-1e7c016e3a44.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-d9337efd-9b27-454c-b2a5-dcfea56920d9", + "name": "NS-d9337efd-9b27-454c-b2a5-dcfea56920d9", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-d9337efd-9b27-454c-b2a5-dcfea56920d9", + "createdAt": "2016-08-05T03:45:09.27Z", + "updatedAt": "2017-02-11T06:20:31.863Z", + "serviceBusEndpoint": "https://NS-d9337efd-9b27-454c-b2a5-dcfea56920d9.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-ad5ae732-abea-4e62-9de0-c90de0ddec0a", + "name": "NS-ad5ae732-abea-4e62-9de0-c90de0ddec0a", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-ad5ae732-abea-4e62-9de0-c90de0ddec0a", + "createdAt": "2016-08-23T02:34:36.447Z", + "updatedAt": "2017-02-11T06:15:31.607Z", + "serviceBusEndpoint": "https://NS-ad5ae732-abea-4e62-9de0-c90de0ddec0a.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-d447fb03-c7da-40fe-b5eb-14f36888837b", + "name": "NS-d447fb03-c7da-40fe-b5eb-14f36888837b", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-d447fb03-c7da-40fe-b5eb-14f36888837b", + "createdAt": "2016-08-05T00:53:46.697Z", + "updatedAt": "2017-02-11T11:09:41.26Z", + "serviceBusEndpoint": "https://NS-d447fb03-c7da-40fe-b5eb-14f36888837b.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/RapscallionResources/providers/Microsoft.ServiceBus/namespaces/ReproSB", + "name": "ReproSB", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:reprosb", + "createdAt": "2017-02-27T19:29:34.523Z", + "updatedAt": "2017-02-27T19:29:58.64Z", + "serviceBusEndpoint": "https://ReproSB.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-4c90097f-19a8-42e7-bb3c-4ac088994719", + "name": "NS-4c90097f-19a8-42e7-bb3c-4ac088994719", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-4c90097f-19a8-42e7-bb3c-4ac088994719", + "createdAt": "2016-09-16T17:35:32.61Z", + "updatedAt": "2017-02-11T09:13:52.27Z", + "serviceBusEndpoint": "https://NS-4c90097f-19a8-42e7-bb3c-4ac088994719.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/rrama-1-23-17", + "name": "rrama-1-23-17", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:rrama-1-23-17", + "createdAt": "2017-01-23T22:54:40.907Z", + "updatedAt": "2017-02-04T00:53:28.777Z", + "serviceBusEndpoint": "https://rrama-1-23-17.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-5191e541-8e4e-4229-9fdc-b89f6c3e7f12", + "name": "NS-5191e541-8e4e-4229-9fdc-b89f6c3e7f12", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-5191e541-8e4e-4229-9fdc-b89f6c3e7f12", + "createdAt": "2016-09-16T17:43:25.71Z", + "updatedAt": "2017-02-11T11:05:31.89Z", + "serviceBusEndpoint": "https://NS-5191e541-8e4e-4229-9fdc-b89f6c3e7f12.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-be903820-3533-46e8-90e4-72c132411848", + "name": "NS-be903820-3533-46e8-90e4-72c132411848", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-be903820-3533-46e8-90e4-72c132411848", + "createdAt": "2016-08-05T03:24:01.923Z", + "updatedAt": "2017-02-11T10:09:42.513Z", + "serviceBusEndpoint": "https://NS-be903820-3533-46e8-90e4-72c132411848.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/rrama-namespace1", + "name": "rrama-namespace1", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Created", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:rrama-namespace1", + "createdAt": "2016-08-05T00:47:22.963Z", + "updatedAt": "2016-08-05T00:47:27.297Z", + "serviceBusEndpoint": "https://rrama-namespace1.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-a3c38e9b-32a3-4c51-85d7-263150a8dda9", + "name": "NS-a3c38e9b-32a3-4c51-85d7-263150a8dda9", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-a3c38e9b-32a3-4c51-85d7-263150a8dda9", + "createdAt": "2016-09-16T00:38:02.517Z", + "updatedAt": "2017-02-11T05:03:55.96Z", + "serviceBusEndpoint": "https://NS-a3c38e9b-32a3-4c51-85d7-263150a8dda9.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-70d3fa25-6bbe-4a6b-a381-a52cf0d539e6", + "name": "NS-70d3fa25-6bbe-4a6b-a381-a52cf0d539e6", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-70d3fa25-6bbe-4a6b-a381-a52cf0d539e6", + "createdAt": "2016-08-23T03:42:40.01Z", + "updatedAt": "2017-02-11T06:33:02.363Z", + "serviceBusEndpoint": "https://NS-70d3fa25-6bbe-4a6b-a381-a52cf0d539e6.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-e6536f77-0d1b-4a6b-8f42-29cc15b2930a", + "name": "NS-e6536f77-0d1b-4a6b-8f42-29cc15b2930a", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-e6536f77-0d1b-4a6b-8f42-29cc15b2930a", + "createdAt": "2016-08-05T04:28:10.71Z", + "updatedAt": "2017-02-11T08:43:51.587Z", + "serviceBusEndpoint": "https://NS-e6536f77-0d1b-4a6b-8f42-29cc15b2930a.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924", + "name": "sdk-Namespace-2924", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-2924", + "createdAt": "2017-05-25T22:26:36.76Z", + "updatedAt": "2017-05-25T22:26:59.35Z", + "serviceBusEndpoint": "https://sdk-Namespace-2924.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/rrama-sb1", + "name": "rrama-sb1", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:rrama-sb1", + "createdAt": "2017-05-01T21:47:34.903Z", + "updatedAt": "2017-05-02T02:10:03.083Z", + "serviceBusEndpoint": "https://rrama-sb1.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/RapscallionResources/providers/Microsoft.ServiceBus/namespaces/WhackWhack", + "name": "WhackWhack", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:whackwhack", + "createdAt": "2016-10-10T23:39:01.347Z", + "updatedAt": "2017-02-04T00:56:32.687Z", + "serviceBusEndpoint": "https://WhackWhack.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-66ed32d6-611e-4bb0-8e1a-a6d0fc65427c", + "name": "NS-66ed32d6-611e-4bb0-8e1a-a6d0fc65427c", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-66ed32d6-611e-4bb0-8e1a-a6d0fc65427c", + "createdAt": "2016-09-16T17:51:27.73Z", + "updatedAt": "2017-02-11T08:19:43.383Z", + "serviceBusEndpoint": "https://NS-66ed32d6-611e-4bb0-8e1a-a6d0fc65427c.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/NS-e0cab401-6df8-465d-8d4a-da9a9e55cf0e", + "name": "NS-e0cab401-6df8-465d-8d4a-da9a9e55cf0e", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-e0cab401-6df8-465d-8d4a-da9a9e55cf0e", + "createdAt": "2016-08-05T01:14:25.613Z", + "updatedAt": "2017-02-11T12:33:01.727Z", + "serviceBusEndpoint": "https://NS-e0cab401-6df8-465d-8d4a-da9a9e55cf0e.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/bn3-rrama-foo1", + "name": "bn3-rrama-foo1", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "East US 2", + "tags": {}, + "properties": { + "provisioningState": "Created", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:bn3-rrama-foo1", + "createdAt": "2017-04-28T23:54:26.927Z", + "updatedAt": "2017-04-28T23:54:26.927Z", + "serviceBusEndpoint": "https://bn3-rrama-foo1.servicebus.int7.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/bn3-rrama-foo3", + "name": "bn3-rrama-foo3", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "East US 2", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:bn3-rrama-foo3", + "createdAt": "2017-04-29T00:24:09.907Z", + "updatedAt": "2017-04-29T00:24:33.233Z", + "serviceBusEndpoint": "https://bn3-rrama-foo3.servicebus.int7.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/bn3-rrama-foo2", + "name": "bn3-rrama-foo2", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "East US 2", + "tags": {}, + "properties": { + "provisioningState": "Created", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:bn3-rrama-foo2", + "createdAt": "2017-04-28T23:57:40.82Z", + "updatedAt": "2017-04-28T23:57:40.82Z", + "serviceBusEndpoint": "https://bn3-rrama-foo2.servicebus.int7.windows-int.net:443/", + "disableLocalAuth": false + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.ServiceBus/namespaces/db3-rrama-foo2", + "name": "db3-rrama-foo2", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "North Europe", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:db3-rrama-foo2", + "createdAt": "2017-04-29T00:10:43.463Z", + "updatedAt": "2017-04-29T00:11:09.133Z", + "serviceBusEndpoint": "https://db3-rrama-foo2.servicebus.int7.windows-int.net:443/", + "disableLocalAuth": false + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceListByResourceGroup.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceListByResourceGroup.json new file mode 100644 index 000000000000..2999d97d471c --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceListByResourceGroup.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "resourceGroupName": "ArunMonocle" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924", + "name": "sdk-Namespace-2924", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-2924", + "createdAt": "2017-05-25T22:26:36.76Z", + "updatedAt": "2017-05-25T22:26:59.35Z", + "serviceBusEndpoint": "https://sdk-Namespace-2924.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceUpdate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceUpdate.json new file mode 100644 index 000000000000..89aff165c80f --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/SBNameSpaceUpdate.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-3285", + "resourceGroupName": "ArunMonocle", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "location": "South Central US", + "tags": { + "tag3": "value3", + "tag4": "value4" + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-3285", + "name": "sdk-Namespace-3285", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": { + "tag3": "value3", + "tag4": "value4" + }, + "properties": { + "provisioningState": "Updating", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-3285", + "createdAt": "2017-05-25T23:07:58.17Z", + "updatedAt": "2017-05-25T23:08:45.497Z", + "serviceBusEndpoint": "https://sdk-Namespace-3285.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + } + }, + "201": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-3285", + "name": "sdk-Namespace-3285", + "type": "Microsoft.ServiceBus/Namespaces", + "location": "South Central US", + "tags": { + "tag3": "value3", + "tag4": "value4" + }, + "properties": { + "provisioningState": "Updating", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-3285", + "createdAt": "2017-05-25T23:07:58.17Z", + "updatedAt": "2017-05-25T23:08:45.497Z", + "serviceBusEndpoint": "https://sdk-Namespace-3285.servicebus.windows-int.net:443/", + "disableLocalAuth": false + } + } + }, + "202": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetCreate.json new file mode 100644 index 000000000000..bba68aac2492 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetCreate.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6019", + "resourceGroupName": "ResourceGroup", + "api-version": "2021-01-01-preview", + "subscriptionId": "Subscription", + "parameters": { + "properties": { + "defaultAction": "Deny", + "virtualNetworkRules": [ + { + "subnet": { + "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2" + }, + "ignoreMissingVnetServiceEndpoint": true + }, + { + "subnet": { + "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3" + }, + "ignoreMissingVnetServiceEndpoint": false + }, + { + "subnet": { + "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6" + }, + "ignoreMissingVnetServiceEndpoint": false + } + ], + "ipRules": [ + { + "ipMask": "1.1.1.1", + "action": "Allow" + }, + { + "ipMask": "1.1.1.2", + "action": "Allow" + }, + { + "ipMask": "1.1.1.3", + "action": "Allow" + }, + { + "ipMask": "1.1.1.4", + "action": "Allow" + }, + { + "ipMask": "1.1.1.5", + "action": "Allow" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-AustraliaEast/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9659/networkruleset/default", + "name": "default", + "type": "Microsoft.ServiceBus/Namespaces/NetworkRuleSet", + "properties": { + "defaultAction": "Deny", + "virtualNetworkRules": [ + { + "subnet": { + "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2" + }, + "ignoreMissingVnetServiceEndpoint": true + }, + { + "subnet": { + "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3" + }, + "ignoreMissingVnetServiceEndpoint": false + }, + { + "subnet": { + "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6" + }, + "ignoreMissingVnetServiceEndpoint": false + } + ], + "ipRules": [ + { + "ipMask": "1.1.1.1", + "action": "Allow" + }, + { + "ipMask": "1.1.1.2", + "action": "Allow" + }, + { + "ipMask": "1.1.1.3", + "action": "Allow" + }, + { + "ipMask": "1.1.1.4", + "action": "Allow" + }, + { + "ipMask": "1.1.1.5", + "action": "Allow" + } + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetGet.json new file mode 100644 index 000000000000..67ac3ac68b5a --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetGet.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6019", + "resourceGroupName": "ResourceGroup", + "api-version": "2021-01-01-preview", + "subscriptionId": "Subscription" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionid/resourceGroups/Default-ServiceBus-AustraliaEast/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9659/networkruleset/default", + "name": "default", + "type": "Microsoft.ServiceBus/Namespaces/NetworkRuleSet", + "properties": { + "defaultAction": "Deny", + "virtualNetworkRules": [ + { + "subnet": { + "id": "/subscriptions/subscriptionid/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2" + }, + "ignoreMissingVnetServiceEndpoint": true + }, + { + "subnet": { + "id": "/subscriptions/subscriptionid/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3" + }, + "ignoreMissingVnetServiceEndpoint": false + }, + { + "subnet": { + "id": "/subscriptions/subscriptionid/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6" + }, + "ignoreMissingVnetServiceEndpoint": false + } + ], + "ipRules": [ + { + "ipMask": "1.1.1.1", + "action": "Allow" + }, + { + "ipMask": "1.1.1.2", + "action": "Allow" + }, + { + "ipMask": "1.1.1.3", + "action": "Allow" + }, + { + "ipMask": "1.1.1.4", + "action": "Allow" + }, + { + "ipMask": "1.1.1.5", + "action": "Allow" + } + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetList.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetList.json new file mode 100644 index 000000000000..abcdeeb6e302 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetList.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6019", + "resourceGroupName": "ResourceGroup", + "api-version": "2021-01-01-preview", + "subscriptionId": "Subscription" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subscriptionid/resourceGroups/resourcegroupid/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9659/networkrulesets/default", + "name": "default", + "type": "Microsoft.ServiceBus/Namespaces/NetworkRuleSet", + "properties": { + "defaultAction": "Deny", + "virtualNetworkRules": [ + { + "subnet": { + "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2" + }, + "ignoreMissingVnetServiceEndpoint": true + }, + { + "subnet": { + "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3" + }, + "ignoreMissingVnetServiceEndpoint": false + }, + { + "subnet": { + "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6" + }, + "ignoreMissingVnetServiceEndpoint": false + } + ], + "ipRules": [ + { + "ipMask": "1.1.1.1", + "action": "Allow" + }, + { + "ipMask": "1.1.1.2", + "action": "Allow" + }, + { + "ipMask": "1.1.1.3", + "action": "Allow" + }, + { + "ipMask": "1.1.1.4", + "action": "Allow" + }, + { + "ipMask": "1.1.1.5", + "action": "Allow" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Queues/SBQueueAuthorizationRuleCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Queues/SBQueueAuthorizationRuleCreate.json new file mode 100644 index 000000000000..b116c4b41d8b --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Queues/SBQueueAuthorizationRuleCreate.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-Namespace-7982", + "queueName": "sdk-Queues-2317", + "authorizationRuleName": "sdk-AuthRules-5800", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-7982/queues/sdk-Queues-2317/authorizationRules/sdk-AuthRules-5800", + "name": "sdk-AuthRules-5800", + "type": "Microsoft.ServiceBus/Namespaces/Queues/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Queues/SBQueueAuthorizationRuleDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Queues/SBQueueAuthorizationRuleDelete.json new file mode 100644 index 000000000000..de6d35c59adb --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Queues/SBQueueAuthorizationRuleDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-namespace-7982", + "queueName": "sdk-Queues-2317", + "authorizationRuleName": "sdk-AuthRules-5800", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Queues/SBQueueAuthorizationRuleGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Queues/SBQueueAuthorizationRuleGet.json new file mode 100644 index 000000000000..234218134269 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Queues/SBQueueAuthorizationRuleGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-Namespace-7982", + "queueName": "sdk-Queues-2317", + "authorizationRuleName": "sdk-AuthRules-5800", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-7982/queues/sdk-Queues-2317/authorizationRules/sdk-AuthRules-5800", + "name": "sdk-AuthRules-5800", + "type": "Microsoft.ServiceBus/Namespaces/Queues/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Queues/SBQueueAuthorizationRuleListAll.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Queues/SBQueueAuthorizationRuleListAll.json new file mode 100644 index 000000000000..cdb8e526bff3 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Queues/SBQueueAuthorizationRuleListAll.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-Namespace-7982", + "queueName": "sdk-Queues-2317", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-7982/queues/sdk-Queues-2317/authorizationRules/sdk-AuthRules-5800", + "name": "sdk-AuthRules-5800", + "type": "Microsoft.ServiceBus/Namespaces/Queues/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Queues/SBQueueAuthorizationRuleListKey.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Queues/SBQueueAuthorizationRuleListKey.json new file mode 100644 index 000000000000..696075d97915 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Queues/SBQueueAuthorizationRuleListKey.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-namespace-7982", + "queueName": "sdk-Queues-2317", + "authorizationRuleName": "sdk-AuthRules-5800", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "primaryConnectionString": "Endpoint=sb://sdk-namespace-7982.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-5800;SharedAccessKey=############################################;EntityPath=sdk-Queues-2317", + "secondaryConnectionString": "Endpoint=sb://sdk-namespace-7982.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-5800;SharedAccessKey=############################################;EntityPath=sdk-Queues-2317", + "primaryKey": "############################################", + "secondaryKey": "############################################", + "keyName": "sdk-AuthRules-5800" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Queues/SBQueueAuthorizationRuleRegenerateKey.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Queues/SBQueueAuthorizationRuleRegenerateKey.json new file mode 100644 index 000000000000..42cb9835f26c --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Queues/SBQueueAuthorizationRuleRegenerateKey.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-namespace-7982", + "queueName": "sdk-Queues-2317", + "authorizationRuleName": "sdk-AuthRules-5800", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "keyType": "PrimaryKey" + } + }, + "responses": { + "200": { + "body": { + "primaryConnectionString": "Endpoint=sb://sdk-namespace-7982.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-5800;SharedAccessKey=############################################;EntityPath=sdk-Queues-2317", + "secondaryConnectionString": "Endpoint=sb://sdk-namespace-7982.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-5800;SharedAccessKey=############################################;EntityPath=sdk-Queues-2317", + "primaryKey": "############################################", + "secondaryKey": "############################################", + "keyName": "sdk-AuthRules-5800" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Queues/SBQueueCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Queues/SBQueueCreate.json new file mode 100644 index 000000000000..68c5bc5841c5 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Queues/SBQueueCreate.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-3174", + "resourceGroupName": "ArunMonocle", + "queueName": "sdk-Queues-5647", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "properties": { + "enablePartitioning": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-3174/queues/sdk-Queues-5647", + "name": "sdk-Queues-5647", + "type": "Microsoft.ServiceBus/Namespaces/Queues", + "properties": { + "lockDuration": "PT1M", + "maxSizeInMegabytes": 163840, + "requiresDuplicateDetection": false, + "requiresSession": false, + "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S", + "duplicateDetectionHistoryTimeWindow": "PT10M", + "maxDeliveryCount": 10, + "sizeInBytes": 0, + "messageCount": 0, + "status": "Active", + "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S", + "enablePartitioning": true, + "enableExpress": false, + "createdAt": "2017-05-26T18:07:33.68Z", + "updatedAt": "2017-05-26T18:07:34.227Z", + "accessedAt": "2017-05-26T18:07:34.227Z" + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Queues/SBQueueDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Queues/SBQueueDelete.json new file mode 100644 index 000000000000..0c6ec2ccfe31 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Queues/SBQueueDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-183", + "resourceGroupName": "ArunMonocle", + "queueName": "sdk-Queues-8708", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Queues/SBQueueGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Queues/SBQueueGet.json new file mode 100644 index 000000000000..16c9d13131e1 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Queues/SBQueueGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-3174", + "resourceGroupName": "ArunMonocle", + "queueName": "sdk-Queues-5647", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-3174/queues/sdk-Queues-5647", + "name": "sdk-Queues-5647", + "type": "Microsoft.ServiceBus/Namespaces/Queues", + "properties": { + "lockDuration": "PT1M", + "maxSizeInMegabytes": 163840, + "requiresDuplicateDetection": false, + "requiresSession": false, + "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S", + "duplicateDetectionHistoryTimeWindow": "PT10M", + "maxDeliveryCount": 10, + "sizeInBytes": 0, + "messageCount": 0, + "status": "Active", + "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S", + "enablePartitioning": true, + "enableExpress": false, + "createdAt": "2017-05-26T18:07:32.4592931Z", + "updatedAt": "2017-05-26T18:07:34.6243761Z", + "accessedAt": "0001-01-01T00:00:00Z" + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Queues/SBQueueListByNameSpace.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Queues/SBQueueListByNameSpace.json new file mode 100644 index 000000000000..df09623dada9 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Queues/SBQueueListByNameSpace.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-3174", + "resourceGroupName": "ArunMonocle", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-3174/queues/sdk-queues-5647", + "name": "sdk-queues-5647", + "type": "Microsoft.ServiceBus/Namespaces/Queues", + "properties": { + "lockDuration": "PT1M", + "maxSizeInMegabytes": 163840, + "requiresDuplicateDetection": false, + "requiresSession": false, + "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S", + "duplicateDetectionHistoryTimeWindow": "PT10M", + "maxDeliveryCount": 10, + "sizeInBytes": 0, + "messageCount": 0, + "status": "Active", + "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S", + "enablePartitioning": true, + "enableExpress": false, + "createdAt": "2017-05-26T18:07:32.4592931Z", + "updatedAt": "2017-05-26T18:07:34.6243761Z", + "accessedAt": "0001-01-01T00:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Rules/RuleCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Rules/RuleCreate.json new file mode 100644 index 000000000000..55dabdbb6290 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Rules/RuleCreate.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1319", + "resourceGroupName": "resourceGroupName", + "topicName": "sdk-Topics-2081", + "subscriptionName": "sdk-Subscriptions-8691", + "ruleName": "sdk-Rules-6571", + "api-version": "2021-06-01-preview", + "subscriptionId": "subscriptionId", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1319/topics/sdk-Topics-2081/subscriptions/sdk-Subscriptions-8691/rules/sdk-Rules-6571", + "name": "sdk-Rules-6571", + "type": "Microsoft.ServiceBus/Namespaces/Topics/Subscriptions/Rules", + "properties": { + "action": {}, + "filterType": "SqlFilter", + "sqlFilter": { + "sqlExpression": "1=1", + "compatibilityLevel": 20 + } + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Rules/RuleCreate_CorrelationFilter.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Rules/RuleCreate_CorrelationFilter.json new file mode 100644 index 000000000000..08bf974b890a --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Rules/RuleCreate_CorrelationFilter.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1319", + "resourceGroupName": "resourceGroupName", + "topicName": "sdk-Topics-2081", + "subscriptionName": "sdk-Subscriptions-8691", + "ruleName": "sdk-Rules-6571", + "api-version": "2021-06-01-preview", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "filterType": "CorrelationFilter", + "correlationFilter": { + "properties": { + "topicHint": "Crop" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1319/topics/sdk-Topics-2081/subscriptions/sdk-Subscriptions-8691/rules/sdk-Rules-6571", + "name": "sdk-Rules-6571", + "type": "Microsoft.ServiceBus/Namespaces/Topics/Subscriptions/Rules", + "properties": { + "action": {}, + "filterType": "CorrelationFilter", + "correlationFilter": { + "properties": { + "queueHint": "Crop" + } + } + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Rules/RuleCreate_SqlFilter.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Rules/RuleCreate_SqlFilter.json new file mode 100644 index 000000000000..347e042035c7 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Rules/RuleCreate_SqlFilter.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1319", + "resourceGroupName": "resourceGroupName", + "topicName": "sdk-Topics-2081", + "subscriptionName": "sdk-Subscriptions-8691", + "ruleName": "sdk-Rules-6571", + "api-version": "2021-06-01-preview", + "subscriptionId": "subscriptionId", + "parameters": { + "properties": { + "filterType": "SqlFilter", + "sqlFilter": { + "sqlExpression": "myproperty=test" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1319/topics/sdk-Topics-2081/subscriptions/sdk-Subscriptions-8691/rules/sdk-Rules-6571", + "name": "sdk-Rules-6571", + "type": "Microsoft.ServiceBus/Namespaces/Topics/Subscriptions/Rules", + "properties": { + "action": {}, + "filterType": "SqlFilter", + "sqlFilter": { + "sqlExpression": "myproperty=test", + "compatibilityLevel": 20 + } + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Rules/RuleDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Rules/RuleDelete.json new file mode 100644 index 000000000000..4dac36f5f65a --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Rules/RuleDelete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1319", + "resourceGroupName": "ArunMonocle", + "topicName": "sdk-Topics-2081", + "subscriptionName": "sdk-Subscriptions-8691", + "ruleName": "sdk-Rules-6571", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Rules/RuleGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Rules/RuleGet.json new file mode 100644 index 000000000000..c100102cd353 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Rules/RuleGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1319", + "resourceGroupName": "ArunMonocle", + "topicName": "sdk-Topics-2081", + "subscriptionName": "sdk-Subscriptions-8691", + "ruleName": "sdk-Rules-6571", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1319/topics/sdk-Topics-2081/subscriptions/sdk-Subscriptions-8691/rules/sdk-Rules-6571", + "name": "sdk-Rules-6571", + "type": "Microsoft.ServiceBus/Namespaces/Topics/Subscriptions/Rules", + "properties": { + "action": {}, + "filterType": "SqlFilter", + "sqlFilter": { + "sqlExpression": "1=1", + "compatibilityLevel": 20 + } + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Rules/RuleListBySubscription.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Rules/RuleListBySubscription.json new file mode 100644 index 000000000000..c809dee54b71 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Rules/RuleListBySubscription.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1319", + "resourceGroupName": "ArunMonocle", + "topicName": "sdk-Topics-2081", + "subscriptionName": "sdk-Subscriptions-8691", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1319/topics/sdk-Topics-2081/subscriptions/sdk-Subscriptions-8691/rules/sdk-Rules-6571", + "name": "sdk-Rules-6571", + "type": "Microsoft.ServiceBus/Namespaces/Topics/Subscriptions/Rules", + "properties": { + "action": {}, + "filterType": "SqlFilter", + "sqlFilter": { + "sqlExpression": "1=1", + "compatibilityLevel": 20 + } + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/SBOperations_List.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/SBOperations_List.json new file mode 100644 index 000000000000..40c8820d5256 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/SBOperations_List.json @@ -0,0 +1,301 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ServiceBus/checkNameAvailability/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Non Resource Operation", + "operation": "Get namespace availability." + } + }, + { + "name": "Microsoft.ServiceBus/register/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "ServiceBus Resource Provider", + "operation": "Registers the ServiceBus Resource Provider" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Namespace", + "operation": "Create Or Update Namespace " + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Namespace", + "operation": "Get Namespace Resource" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/Delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Namespace", + "operation": "Delete Namespace" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/authorizationRules/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "AuthorizationRules", + "operation": "Create or Update Namespace Authorization Rules" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/authorizationRules/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "AuthorizationRules", + "operation": "Get Namespace Authorization Rules" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/authorizationRules/delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "AuthorizationRules", + "operation": "Delete Namespace Authorization Rule" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/authorizationRules/listkeys/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "AuthorizationRules", + "operation": "Get Namespace Listkeys" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/authorizationRules/regenerateKeys/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "AuthorizationRules", + "operation": "Resource Regeneratekeys" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue", + "operation": "Create or Update Queue" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue", + "operation": "Get Queue" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/Delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue", + "operation": "Delete Queue" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/authorizationRules/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue AuthorizationRules", + "operation": "Create or Update Queue Authorization Rule" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/authorizationRules/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue AuthorizationRules", + "operation": " Get Queue Authorization Rules" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/authorizationRules/delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue AuthorizationRules", + "operation": "Delete Queue Authorization Rules" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/authorizationRules/listkeys/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue AuthorizationRules", + "operation": "List Queue keys" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/authorizationRules/regenerateKeys/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue AuthorizationRules", + "operation": "Resource Regeneratekeys" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic", + "operation": "Create or Update Topic" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic", + "operation": "Get Topic" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/Delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic", + "operation": "Delete Topic" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/authorizationRules/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic AuthorizationRules", + "operation": "Create or Update Topic Authorization Rule" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/authorizationRules/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic AuthorizationRules", + "operation": " Get Topic Authorization Rules" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/authorizationRules/delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic AuthorizationRules", + "operation": "Delete Topic Authorization Rules" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/authorizationRules/listkeys/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic AuthorizationRules", + "operation": "List Topic keys" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/authorizationRules/regenerateKeys/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic AuthorizationRules", + "operation": "Resource Regeneratekeys" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/subscriptions/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "TopicSubscription", + "operation": "Create or Update TopicSubscription" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/subscriptions/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "TopicSubscription", + "operation": "Get TopicSubscription" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/subscriptions/Delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "TopicSubscription", + "operation": "Delete TopicSubscription" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/subscriptions/rules/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Rule", + "operation": "Create or Update Rule" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/subscriptions/rules/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Rule", + "operation": "Get Rule" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/subscriptions/rules/Delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Rule", + "operation": "Delete Rule" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/metricDefinitions/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Namespace metrics", + "operation": "Get Namespace metrics" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/diagnosticSettings/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Namespace diagnostic settings", + "operation": "Get Namespace diagnostic settings" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/diagnosticSettings/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Namespace diagnostic settings", + "operation": "Create or Update Namespace diagnostic settings" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/logDefinitions/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Namespace logs", + "operation": "Get Namespace logs" + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Subscriptions/SBSubscriptionCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Subscriptions/SBSubscriptionCreate.json new file mode 100644 index 000000000000..1736b26b979f --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Subscriptions/SBSubscriptionCreate.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1349", + "resourceGroupName": "ResourceGroup", + "topicName": "sdk-Topics-8740", + "subscriptionName": "sdk-Subscriptions-2178", + "api-version": "2021-06-01-preview", + "subscriptionId": "Subscriptionid", + "parameters": { + "properties": { + "enableBatchedOperations": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/Subscriptionid/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1349/topics/sdk-Topics-8740/subscriptions/sdk-Subscriptions-2178", + "name": "sdk-Subscriptions-2178", + "type": "Microsoft.ServiceBus/Namespaces/Topics/Subscriptions", + "properties": { + "lockDuration": "PT1M", + "requiresSession": false, + "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S", + "deadLetteringOnMessageExpiration": true, + "deadLetteringOnFilterEvaluationExceptions": true, + "messageCount": 0, + "maxDeliveryCount": 10, + "status": "Active", + "enableBatchedOperations": true, + "createdAt": "2021-01-04T18:02:20.5992764Z", + "updatedAt": "2021-01-04T18:02:20.5992764Z", + "accessedAt": "2021-01-04T18:02:20.5992764Z", + "countDetails": { + "activeMessageCount": 0, + "deadLetterMessageCount": 0, + "scheduledMessageCount": 0, + "transferMessageCount": 0, + "transferDeadLetterMessageCount": 0 + }, + "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S", + "forwardTo": "sdk-Topics-3065", + "forwardDeadLetteredMessagesTo": "sdk-Topics-3065" + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Subscriptions/SBSubscriptionDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Subscriptions/SBSubscriptionDelete.json new file mode 100644 index 000000000000..6b866fb87441 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Subscriptions/SBSubscriptionDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5882", + "resourceGroupName": "ResourceGroup", + "topicName": "sdk-Topics-1804", + "subscriptionName": "sdk-Subscriptions-3670", + "api-version": "2021-06-01-preview", + "subscriptionId": "subscriptionId" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Subscriptions/SBSubscriptionGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Subscriptions/SBSubscriptionGet.json new file mode 100644 index 000000000000..d4d849a4160e --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Subscriptions/SBSubscriptionGet.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1349", + "resourceGroupName": "ResourceGroup", + "topicName": "sdk-Topics-8740", + "subscriptionName": "sdk-Subscriptions-2178", + "api-version": "2021-06-01-preview", + "subscriptionId": "Subscriptionid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/Subscriptionid/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1349/topics/sdk-Topics-8740/subscriptions/sdk-Subscriptions-2178", + "name": "sdk-Subscriptions-2178", + "type": "Microsoft.ServiceBus/Namespaces/Topics/Subscriptions", + "properties": { + "lockDuration": "PT1M", + "requiresSession": false, + "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S", + "deadLetteringOnMessageExpiration": true, + "deadLetteringOnFilterEvaluationExceptions": true, + "messageCount": 0, + "maxDeliveryCount": 10, + "status": "Active", + "enableBatchedOperations": true, + "createdAt": "2021-01-04T18:02:20.5992764Z", + "updatedAt": "2021-01-04T18:02:20.5992764Z", + "accessedAt": "2021-01-04T18:02:20.5992764Z", + "countDetails": { + "activeMessageCount": 0, + "deadLetterMessageCount": 0, + "scheduledMessageCount": 0, + "transferMessageCount": 0, + "transferDeadLetterMessageCount": 0 + }, + "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S", + "forwardTo": "sdk-Topics-3065", + "forwardDeadLetteredMessagesTo": "sdk-Topics-3065" + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Subscriptions/SBSubscriptionListByTopic.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Subscriptions/SBSubscriptionListByTopic.json new file mode 100644 index 000000000000..cb7923981fde --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Subscriptions/SBSubscriptionListByTopic.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1349", + "resourceGroupName": "ResourceGroup", + "topicName": "sdk-Topics-8740", + "api-version": "2021-06-01-preview", + "subscriptionId": "5{Subscriptionid}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/Subscriptionid/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1349/topics/sdk-Topics-8740/subscriptions/sdk-Subscriptions-2178", + "name": "sdk-Subscriptions-2178", + "type": "Microsoft.ServiceBus/Namespaces/Topics/Subscriptions", + "properties": { + "lockDuration": "PT1M", + "requiresSession": false, + "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S", + "deadLetteringOnMessageExpiration": true, + "deadLetteringOnFilterEvaluationExceptions": true, + "messageCount": 0, + "maxDeliveryCount": 10, + "status": "Active", + "enableBatchedOperations": true, + "createdAt": "2021-01-04T18:02:20.5992764Z", + "updatedAt": "2021-01-04T18:02:20.5992764Z", + "accessedAt": "2021-01-04T18:02:20.5992764Z", + "countDetails": { + "activeMessageCount": 0, + "deadLetterMessageCount": 0, + "scheduledMessageCount": 0, + "transferMessageCount": 0, + "transferDeadLetterMessageCount": 0 + }, + "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S", + "forwardTo": "sdk-Topics-3065", + "forwardDeadLetteredMessagesTo": "sdk-Topics-3065" + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Topics/SBTopicAuthorizationRuleCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Topics/SBTopicAuthorizationRuleCreate.json new file mode 100644 index 000000000000..728656dcba9e --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Topics/SBTopicAuthorizationRuleCreate.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-Namespace-6261", + "topicName": "sdk-Topics-1984", + "authorizationRuleName": "sdk-AuthRules-4310", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-6261/topics/sdk-Topics-1984/authorizationRules/sdk-AuthRules-4310", + "name": "sdk-AuthRules-4310", + "type": "Microsoft.ServiceBus/Namespaces/Topics/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Topics/SBTopicAuthorizationRuleDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Topics/SBTopicAuthorizationRuleDelete.json new file mode 100644 index 000000000000..8298694dd667 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Topics/SBTopicAuthorizationRuleDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-Namespace-6261", + "topicName": "sdk-Topics-1984", + "authorizationRuleName": "sdk-AuthRules-4310", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Topics/SBTopicAuthorizationRuleGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Topics/SBTopicAuthorizationRuleGet.json new file mode 100644 index 000000000000..5ead271406f7 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Topics/SBTopicAuthorizationRuleGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-Namespace-6261", + "topicName": "sdk-Topics-1984", + "authorizationRuleName": "sdk-AuthRules-4310", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-6261/topics/sdk-Topics-1984/authorizationRules/sdk-AuthRules-4310", + "name": "sdk-AuthRules-4310", + "type": "Microsoft.ServiceBus/Namespaces/Topics/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Topics/SBTopicAuthorizationRuleListAll.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Topics/SBTopicAuthorizationRuleListAll.json new file mode 100644 index 000000000000..2810130ff8cb --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Topics/SBTopicAuthorizationRuleListAll.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "resourceGroupName": "ArunMonocle", + "namespaceName": "sdk-Namespace-6261", + "topicName": "sdk-Topics-1984", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-6261/topics/sdk-Topics-1984/authorizationRules/sdk-AuthRules-4310", + "name": "sdk-AuthRules-4310", + "type": "Microsoft.ServiceBus/Namespaces/Topics/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Topics/SBTopicAuthorizationRuleListKey.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Topics/SBTopicAuthorizationRuleListKey.json new file mode 100644 index 000000000000..974c558bc572 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Topics/SBTopicAuthorizationRuleListKey.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "resourceGroupName": "Default-ServiceBus-WestUS", + "namespaceName": "sdk-Namespace8408", + "topicName": "sdk-Topics2075", + "authorizationRuleName": "sdk-Authrules5067", + "api-version": "2021-06-01-preview", + "subscriptionId": "e2f361f0-3b27-4503-a9cc-21cfba380093" + }, + "responses": { + "200": { + "body": { + "primaryConnectionString": "Endpoint=sb://sdk-namespace-6261.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-4310;SharedAccessKey=#############################################;EntityPath=sdk-Topics-1984", + "secondaryConnectionString": "Endpoint=sb://sdk-namespace-6261.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-4310;SharedAccessKey=#############################################;EntityPath=sdk-Topics-1984", + "primaryKey": "#############################################", + "secondaryKey": "#############################################", + "keyName": "sdk-AuthRules-4310" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Topics/SBTopicAuthorizationRuleRegenerateKey.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Topics/SBTopicAuthorizationRuleRegenerateKey.json new file mode 100644 index 000000000000..699c9470d8aa --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Topics/SBTopicAuthorizationRuleRegenerateKey.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "resourceGroupName": "Default-ServiceBus-WestUS", + "namespaceName": "sdk-Namespace8408", + "topicName": "sdk-Topics2075", + "authorizationRuleName": "sdk-Authrules5067", + "api-version": "2021-06-01-preview", + "subscriptionId": "e2f361f0-3b27-4503-a9cc-21cfba380093", + "parameters": { + "keyType": "PrimaryKey" + } + }, + "responses": { + "200": { + "body": { + "primaryConnectionString": "Endpoint=sb://sdk-namespace-6261.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-4310;SharedAccessKey=#############################################;EntityPath=sdk-Topics-1984", + "secondaryConnectionString": "Endpoint=sb://sdk-namespace-6261.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-4310;SharedAccessKey=#############################################;EntityPath=sdk-Topics-1984", + "primaryKey": "#############################################", + "secondaryKey": "#############################################", + "keyName": "sdk-AuthRules-4310" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Topics/SBTopicCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Topics/SBTopicCreate.json new file mode 100644 index 000000000000..eaf146762b9f --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Topics/SBTopicCreate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1617", + "resourceGroupName": "ArunMonocle", + "topicName": "sdk-Topics-5488", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "properties": { + "enableExpress": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1617/topics/sdk-Topics-5488", + "name": "sdk-Topics-5488", + "type": "Microsoft.ServiceBus/Namespaces/Topics", + "properties": { + "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S", + "maxSizeInMegabytes": 10240, + "requiresDuplicateDetection": false, + "duplicateDetectionHistoryTimeWindow": "PT10M", + "enableBatchedOperations": true, + "sizeInBytes": 0, + "status": "Active", + "supportOrdering": true, + "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S", + "enablePartitioning": false, + "enableExpress": true, + "createdAt": "2017-05-26T20:50:34.1Z", + "updatedAt": "2017-05-26T20:50:34.32Z", + "accessedAt": "2017-05-26T20:50:34.32Z", + "subscriptionCount": 0 + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Topics/SBTopicDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Topics/SBTopicDelete.json new file mode 100644 index 000000000000..bc545022b312 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Topics/SBTopicDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1617", + "resourceGroupName": "ArunMonocle", + "topicName": "sdk-Topics-5488", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Topics/SBTopicGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Topics/SBTopicGet.json new file mode 100644 index 000000000000..89761254c4d0 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Topics/SBTopicGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1617", + "resourceGroupName": "ArunMonocle", + "topicName": "sdk-Topics-5488", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1617/topics/sdk-Topics-5488", + "name": "sdk-Topics-5488", + "type": "Microsoft.ServiceBus/Namespaces/Topics", + "properties": { + "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S", + "maxSizeInMegabytes": 10240, + "requiresDuplicateDetection": false, + "duplicateDetectionHistoryTimeWindow": "PT10M", + "enableBatchedOperations": true, + "sizeInBytes": 0, + "status": "Active", + "supportOrdering": true, + "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S", + "enablePartitioning": false, + "enableExpress": true, + "createdAt": "2017-05-26T20:50:31.4442694Z", + "updatedAt": "2017-05-26T20:52:32.2092264Z", + "accessedAt": "0001-01-01T00:00:00Z", + "subscriptionCount": 0 + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Topics/SBTopicListByNameSpace.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Topics/SBTopicListByNameSpace.json new file mode 100644 index 000000000000..e7f87c8e5b1c --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/Topics/SBTopicListByNameSpace.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-1617", + "resourceGroupName": "Default-ServiceBus-WestUS", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1617/topics/sdk-topics-5488", + "name": "sdk-topics-5488", + "type": "Microsoft.ServiceBus/Namespaces/Topics", + "properties": { + "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S", + "maxSizeInMegabytes": 10240, + "requiresDuplicateDetection": false, + "duplicateDetectionHistoryTimeWindow": "PT10M", + "enableBatchedOperations": true, + "sizeInBytes": 0, + "status": "Active", + "supportOrdering": true, + "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S", + "enablePartitioning": false, + "enableExpress": true, + "createdAt": "2017-05-26T20:50:31.4442694Z", + "updatedAt": "2017-05-26T20:52:32.2092264Z", + "accessedAt": "0001-01-01T00:00:00Z", + "subscriptionCount": 0 + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleGet.json new file mode 100644 index 000000000000..59bc4228f590 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-9080", + "authorizationRuleName": "sdk-Authrules-4879", + "resourceGroupName": "exampleResourceGroup", + "alias": "sdk-DisasterRecovery-4879", + "api-version": "2021-06-01-preview", + "subscriptionId": "exampleSubscriptionId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/exampleSubscriptionId/resourceGroups/exampleResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9080/disasterRecoveryConfigs/sdk-DisasterRecovery-4047/AuthorizationRules/sdk-Authrules-4879", + "name": "sdk-Authrules-4879", + "type": "Microsoft.ServiceBus/Namespaces/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListAll.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListAll.json new file mode 100644 index 000000000000..07f805147c55 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListAll.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-9080", + "resourceGroupName": "exampleResourceGroup", + "alias": "sdk-DisasterRecovery-4047", + "api-version": "2021-06-01-preview", + "subscriptionId": "exampleSubscriptionId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/exampleSubscriptionId/resourceGroups/exampleResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9080/disasterRecoveryConfigs/sdk-DisasterRecovery-4047/AuthorizationRules/RootManageSharedAccessKey", + "name": "RootManageSharedAccessKey", + "type": "Microsoft.ServiceBus/Namespaces/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Manage", + "Send" + ] + } + }, + { + "id": "/subscriptions/exampleSubscriptionId/resourceGroups/exampleResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9080/disasterRecoveryConfigs/sdk-DisasterRecovery-4047/AuthorizationRules/sdk-Authrules-1067", + "name": "sdk-Authrules-1067", + "type": "Microsoft.ServiceBus/Namespaces/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + }, + { + "id": "/subscriptions/exampleSubscriptionId/resourceGroups/exampleResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9080/disasterRecoveryConfigs/sdk-DisasterRecovery-4047/AuthorizationRules/sdk-Authrules-1684", + "name": "sdk-Authrules-1684", + "type": "Microsoft.ServiceBus/Namespaces/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + }, + { + "id": "/subscriptions/exampleSubscriptionId/resourceGroups/exampleResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9080/disasterRecoveryConfigs/sdk-DisasterRecovery-4047/AuthorizationRules/sdk-Authrules-4879", + "name": "sdk-Authrules-4879", + "type": "Microsoft.ServiceBus/Namespaces/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListKey.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListKey.json new file mode 100644 index 000000000000..9aa48545d854 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListKey.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-2702", + "authorizationRuleName": "sdk-Authrules-1746", + "resourceGroupName": "exampleResourceGroup", + "alias": "sdk-DisasterRecovery-4047", + "api-version": "2021-06-01-preview", + "subscriptionId": "exampleSubscriptionId" + }, + "responses": { + "200": { + "body": { + "aliasPrimaryConnectionString": "Endpoint=sb://sdk-disasterrecovery-4047.servicebus.windows-int.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=############################################", + "aliasSecondaryConnectionString": "Endpoint=sb://sdk-disasterrecovery-4047.servicebus.windows-int.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=############################################", + "primaryKey": "############################################", + "secondaryKey": "############################################", + "keyName": "sdk-Authrules-1746" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/SBAliasCheckNameAvailability.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/SBAliasCheckNameAvailability.json new file mode 100644 index 000000000000..854546cc867f --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/SBAliasCheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "exampleSubscriptionId", + "namespaceName": "sdk-Namespace-9080", + "resourceGroupName": "exampleResourceGroup", + "parameters": { + "name": "sdk-DisasterRecovery-9474" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "reason": "None", + "message": "" + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/SBAliasCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/SBAliasCreate.json new file mode 100644 index 000000000000..26027b43eaf4 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/SBAliasCreate.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-8860", + "resourceGroupName": "ardsouzatestRG", + "alias": "sdk-Namespace-8860", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "properties": { + "partnerNamespace": "sdk-Namespace-37", + "alternateName": "alternameforAlias-Namespace-8860" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ardsouzatestRG/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-8860/disasterRecoveryConfig/sdk-Namespace-8860", + "name": "sdk-Namespace-8860", + "type": "Microsoft.ServiceBus/Namespaces/DisasterRecoveryConfig", + "properties": { + "provisioningState": "Accepted", + "partnerNamespace": "sdk-Namespace-37", + "alternateName": "alternameforAlias-Namespace-8860", + "role": "Primary" + } + } + }, + "201": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/SBAliasDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/SBAliasDelete.json new file mode 100644 index 000000000000..c3082c159320 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/SBAliasDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-8860", + "resourceGroupName": "SouthCentralUS", + "alias": "sdk-DisasterRecovery-3814", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/SBAliasFailOver.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/SBAliasFailOver.json new file mode 100644 index 000000000000..1e0605564a2e --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/SBAliasFailOver.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-8860", + "resourceGroupName": "ardsouzatestRG", + "alias": "sdk-DisasterRecovery-3814", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/SBAliasGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/SBAliasGet.json new file mode 100644 index 000000000000..9257eea86ccf --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/SBAliasGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-8860", + "resourceGroupName": "ardsouzatestRG", + "alias": "sdk-DisasterRecovery-3814", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ardsouzatestRG/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-37/disasterRecoveryConfig/sdk-DisasterRecovery-3814", + "name": "sdk-DisasterRecovery-3814", + "type": "Microsoft.ServiceBus/Namespaces/DisasterRecoveryConfig", + "properties": { + "provisioningState": "Accepted", + "partnerNamespace": "sdk-Namespace-8860", + "role": "Secondary", + "pendingReplicationOperationsCount": 0 + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/SBAliasList.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/SBAliasList.json new file mode 100644 index 000000000000..810788555d58 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/SBAliasList.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-8860", + "resourceGroupName": "ardsouzatestRG", + "alias": "sdk-DisasterRecovery-3814", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ardsouzatestRG/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-8860/disasterRecoveryConfig/sdk-DisasterRecovery-3814", + "name": "sdk-DisasterRecovery-3814", + "type": "Microsoft.ServiceBus/Namespaces/DisasterRecoveryConfig", + "properties": { + "provisioningState": "Accepted", + "partnerNamespace": "sdk-Namespace-37", + "role": "Primary" + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/SBEHAliasBreakPairing.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/SBEHAliasBreakPairing.json new file mode 100644 index 000000000000..1e0605564a2e --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/disasterRecoveryConfigs/SBEHAliasBreakPairing.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-8860", + "resourceGroupName": "ardsouzatestRG", + "alias": "sdk-DisasterRecovery-3814", + "api-version": "2021-06-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/migrationconfigs.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/migrationconfigs.json new file mode 100644 index 000000000000..0a004a89be4a --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/migrationconfigs.json @@ -0,0 +1,380 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2021-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations": { + "get": { + "tags": [ + "MigrationConfigs" + ], + "operationId": "MigrationConfigs_List", + "x-ms-examples": { + "MigrationConfigurationsList": { + "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationList.json" + } + }, + "description": "Gets all migrationConfigurations", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of migrationConfigurations for servicebus namespace", + "schema": { + "$ref": "#/definitions/MigrationConfigListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}": { + "put": { + "tags": [ + "MigrationConfigs" + ], + "operationId": "MigrationConfigs_CreateAndStartMigration", + "x-ms-examples": { + "MigrationConfigurationsStartMigration": { + "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationCreateAndStartMigration.json" + } + }, + "description": "Creates Migration configuration and starts migration of entities from Standard to Premium namespace", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ConfigNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MigrationConfigProperties" + }, + "description": "Parameters required to create Migration Configuration" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Migration Config successfully created", + "schema": { + "$ref": "#/definitions/MigrationConfigProperties" + } + }, + "201": { + "description": "Migration Config creation request received" + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "MigrationConfigs" + ], + "operationId": "MigrationConfigs_Delete", + "x-ms-examples": { + "MigrationConfigurationsDelete": { + "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationDelete.json" + } + }, + "description": "Deletes a MigrationConfiguration", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ConfigNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete Migration Config request accepted" + }, + "204": { + "description": "Not Found" + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "MigrationConfigs" + ], + "operationId": "MigrationConfigs_Get", + "x-ms-examples": { + "MigrationConfigurationsGet": { + "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationGet.json" + } + }, + "description": "Retrieves Migration Config", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ConfigNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved Migration Config)", + "schema": { + "$ref": "#/definitions/MigrationConfigProperties" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}/upgrade": { + "post": { + "tags": [ + "MigrationConfigs" + ], + "operationId": "MigrationConfigs_CompleteMigration", + "x-ms-examples": { + "MigrationConfigurationsCompleteMigration": { + "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationCompleteMigration.json" + } + }, + "description": "This operation Completes Migration of entities by pointing the connection strings to Premium namespace and any entities created after the operation will be under Premium Namespace. CompleteMigration operation will fail when entity migration is in-progress.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ConfigNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "upgrade operation of Migration Config is successful." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}/revert": { + "post": { + "tags": [ + "MigrationConfigs" + ], + "operationId": "MigrationConfigs_Revert", + "x-ms-examples": { + "MigrationConfigurationsRevert": { + "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationRevert.json" + } + }, + "description": "This operation reverts Migration", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ConfigNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "MigrationConfig Revert operation is successful." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "MigrationConfigProperties": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of Migration Configuration " + }, + "pendingReplicationOperationsCount": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "Number of entities pending to be replicated." + }, + "targetNamespace": { + "type": "string", + "description": "Existing premium Namespace ARM Id name which has no entities, will be used for migration" + }, + "postMigrationName": { + "type": "string", + "description": "Name to access Standard Namespace after migration" + }, + "migrationState": { + "readOnly": true, + "type": "string", + "description": "State in which Standard to Premium Migration is, possible values : Unknown, Reverting, Completing, Initiating, Syncing, Active" + } + }, + "required": [ + "targetNamespace", + "postMigrationName" + ], + "description": "Properties required to the Create Migration Configuration" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Single item in List or Get Migration Config operation" + }, + "MigrationConfigListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MigrationConfigProperties" + }, + "description": "List of Migration Configs" + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if Value contains incomplete list of migrationConfigurations" + } + }, + "description": "The result of the List migrationConfigurations operation." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/namespace-preview.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/namespace-preview.json new file mode 100644 index 000000000000..f54600816fa2 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/namespace-preview.json @@ -0,0 +1,1052 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client for managing Namespace", + "version": "2021-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/namespaces": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_List", + "x-ms-examples": { + "NameSpaceList": { + "$ref": "./examples/NameSpaces/SBNameSpaceList.json" + } + }, + "description": "Gets all the available namespaces within the subscription, irrespective of the resource groups.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespaces successfully returned.", + "schema": { + "$ref": "#/definitions/SBNamespaceListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_ListByResourceGroup", + "x-ms-examples": { + "NameSpaceListByResourceGroup": { + "$ref": "./examples/NameSpaces/SBNameSpaceListByResourceGroup.json" + } + }, + "description": "Gets the available namespaces within a resource group.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespaces successfully returned.", + "schema": { + "$ref": "#/definitions/SBNamespaceListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}": { + "put": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_CreateOrUpdate", + "x-ms-examples": { + "NameSpaceCreate": { + "$ref": "./examples/NameSpaces/SBNameSpaceCreate.json" + } + }, + "description": "Creates or updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639408.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "namespaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBNamespace" + }, + "description": "Parameters supplied to create a namespace resource." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace created successfully.", + "schema": { + "$ref": "#/definitions/SBNamespace" + } + }, + "201": { + "description": "Namespace create request accepted.", + "schema": { + "$ref": "#/definitions/SBNamespace" + } + }, + "202": { + "description": "Namespace create or update request accepted." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Delete", + "x-ms-examples": { + "NameSpaceDelete": { + "$ref": "./examples/NameSpaces/SBNameSpaceDelete.json" + } + }, + "description": "Deletes an existing namespace. This operation also removes all associated resources under the namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639389.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace successfully deleted." + }, + "202": { + "description": "Namespace delete request accepted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Get", + "x-ms-examples": { + "NameSpaceGet": { + "$ref": "./examples/NameSpaces/SBNameSpaceGet.json" + } + }, + "description": "Gets a description for the specified namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace successfully returned.", + "schema": { + "$ref": "#/definitions/SBNamespace" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Update", + "x-ms-examples": { + "NameSpaceUpdate": { + "$ref": "./examples/NameSpaces/SBNameSpaceUpdate.json" + } + }, + "description": "Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBNamespaceUpdateParameters" + }, + "description": "Parameters supplied to update a namespace resource." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace updated successfully.", + "schema": { + "$ref": "#/definitions/SBNamespace" + } + }, + "201": { + "description": "Namespace update request accepted.", + "schema": { + "$ref": "#/definitions/SBNamespace" + } + }, + "202": { + "description": "Namespace update request accepted." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/privateEndpointConnections": { + "get": { + "tags": [ + "Namespaces PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "x-ms-examples": { + "NameSpaceCreate": { + "$ref": "./examples/NameSpaces/PrivateEndPointConnectionList.json" + } + }, + "description": "Gets the available PrivateEndpointConnections within a namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "PrivateEndpointConnections successfully returned.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "put": { + "tags": [ + "Namespaces PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "x-ms-examples": { + "NameSpacePrivateEndPointConnectionCreate": { + "$ref": "./examples/NameSpaces/PrivateEndPointConnectionCreate.json" + } + }, + "description": "Creates or updates PrivateEndpointConnections of service namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639408.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "Parameters supplied to update Status of PrivateEndPoint Connection to namespace resource." + } + ], + "responses": { + "200": { + "description": "Status of PrivateEndPoint Connection Created successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "Request to update Status of PrivateEndPoint Connection accepted.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Namespaces PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "x-ms-examples": { + "NameSpacePrivateEndPointConnectionDelete": { + "$ref": "./examples/NameSpaces/PrivateEndPointConnectionDelete.json" + } + }, + "description": "Deletes an existing Private Endpoint Connection.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639389.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/PrivateEndpointConnectionNameParameter" + } + ], + "responses": { + "200": { + "description": "Private Endpoint Connection successfully deleted." + }, + "202": { + "description": "Private Endpoint Connection delete request accepted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Namespaces PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "x-ms-examples": { + "NameSpacePrivateEndPointConnectionGet": { + "$ref": "./examples/NameSpaces/PrivateEndPointConnectionGet.json" + } + }, + "description": "Gets a description for the specified Private Endpoint Connection.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Description of Private Endpoint Connection returned successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/privateLinkResources": { + "get": { + "tags": [ + "Namespaces PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_Get", + "x-ms-examples": { + "NameSpacePrivateLinkResourcesGet": { + "$ref": "./examples/NameSpaces/PrivateLinkResourcesGet.json" + } + }, + "description": "Gets lists of resources that supports Privatelinks.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Private Link resource List", + "schema": { + "$ref": "#/definitions/PrivateLinkResourcesListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ResourceNamespacePatch": { + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "The Resource definition." + }, + "SBNamespaceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SBNamespace" + }, + "description": "Result of the List Namespace operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of Namespaces." + } + }, + "description": "The response of the List Namespace operation." + }, + "SBNamespace": { + "properties": { + "sku": { + "$ref": "#/definitions/SBSku", + "description": "Properties of SKU" + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "Properties of BYOK Identity description" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SBNamespaceProperties", + "description": "Properties of the namespace." + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/TrackedResource" + } + ], + "description": "Description of a namespace resource." + }, + "SBNamespaceUpdateParameters": { + "properties": { + "sku": { + "$ref": "#/definitions/SBSku", + "description": "Properties of SKU" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SBNamespaceProperties", + "description": "Properties of the namespace." + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "Properties of BYOK Identity description" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceNamespacePatch" + } + ], + "description": "Description of a namespace resource." + }, + "SBNamespaceProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the namespace." + }, + "status": { + "readOnly": true, + "type": "string", + "description": "Status of the namespace." + }, + "createdAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The time the namespace was created" + }, + "updatedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The time the namespace was updated." + }, + "serviceBusEndpoint": { + "readOnly": true, + "type": "string", + "description": "Endpoint you can use to perform Service Bus operations." + }, + "metricId": { + "readOnly": true, + "type": "string", + "description": "Identifier for Azure Insights metrics" + }, + "zoneRedundant": { + "type": "boolean", + "description": "Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones." + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "Properties of BYOK Encryption description" + }, + "privateEndpointConnections": { + "description": "List of private endpoint connections.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "disableLocalAuth": { + "type": "boolean", + "description": "This property disables SAS authentication for the Service Bus namespace." + } + }, + "description": "Properties of the namespace." + }, + "SBSku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of this SKU.", + "enum": [ + "Basic", + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": false + } + }, + "tier": { + "type": "string", + "description": "The billing tier of this particular SKU.", + "enum": [ + "Basic", + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": false + } + }, + "capacity": { + "format": "int32", + "type": "integer", + "description": "The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4." + } + }, + "required": [ + "name" + ], + "description": "SKU of the namespace." + }, + "Identity": { + "x-ms-client-flatten": true, + "properties": { + "principalId": { + "type": "string", + "description": "ObjectId from the KeyVault", + "readOnly": true + }, + "tenantId": { + "type": "string", + "description": "TenantId from the KeyVault", + "readOnly": true + }, + "type": { + "description": "Type of managed service identity.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedServiceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + }, + "description": "Properties for User Assigned Identities" + } + }, + "description": "Properties to configure User Assigned Identities for Bring your Own Keys" + }, + "UserAssignedIdentity": { + "description": "Recognized Dictionary value.", + "type": "object", + "properties": { + "principalId": { + "description": "Principal Id of user assigned identity", + "type": "string", + "x-ms-client-name": "PrincipalId", + "readOnly": true + }, + "clientId": { + "description": "Client Id of user assigned identity", + "type": "string", + "x-ms-client-name": "ClientId", + "readOnly": true + } + } + }, + "Encryption": { + "x-ms-client-flatten": true, + "properties": { + "keyVaultProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/KeyVaultProperties" + }, + "x-ms-client-name": "KeyVaultProperties", + "description": "Properties of KeyVault" + }, + "keySource": { + "type": "string", + "description": "Enumerates the possible value of keySource for Encryption", + "default": "Microsoft.KeyVault", + "enum": [ + "Microsoft.KeyVault" + ], + "x-ms-enum": { + "name": "keySource", + "modelAsString": false + } + }, + "requireInfrastructureEncryption": { + "type": "boolean", + "description": "Enable Infrastructure Encryption (Double Encryption)" + } + }, + "description": "Properties to configure Encryption" + }, + "KeyVaultProperties": { + "properties": { + "keyName": { + "type": "string", + "description": "Name of the Key from KeyVault" + }, + "keyVaultUri": { + "type": "string", + "description": "Uri of KeyVault" + }, + "keyVersion": { + "type": "string", + "description": "Version of KeyVault" + }, + "identity": { + "$ref": "#/definitions/userAssignedIdentityProperties" + } + }, + "description": "Properties to configure keyVault Properties" + }, + "PrivateEndpointConnection": { + "description": "Properties of the PrivateEndpointConnection.", + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Properties of the PrivateEndpointConnection.", + "x-ms-client-flatten": true + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + } + }, + "PrivateEndpointConnectionProperties": { + "description": "Properties of the private endpoint connection resource.", + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The Private Endpoint resource for this Connection." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/ConnectionState", + "description": "Details about the state of the connection." + }, + "provisioningState": { + "description": "Provisioning state of the Private Endpoint Connection.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Canceled", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "EndPointProvisioningState", + "modelAsString": true + } + } + } + }, + "PrivateEndpoint": { + "description": "PrivateEndpoint information.", + "properties": { + "id": { + "description": "The ARM identifier for Private Endpoint.", + "type": "string" + } + } + }, + "ConnectionState": { + "description": "ConnectionState information.", + "properties": { + "status": { + "description": "Status of the connection.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateLinkConnectionStatus", + "modelAsString": true + } + }, + "description": { + "description": "Description of the connection state.", + "type": "string" + } + } + }, + "PrivateEndpointConnectionListResult": { + "description": "Result of the list of all private endpoint connections operation.", + "properties": { + "value": { + "description": "A collection of private endpoint connection resources.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "description": "A link for the next page of private endpoint connection resources.", + "type": "string" + } + } + }, + "PrivateLinkResource": { + "description": "Information of the private link resource.", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Properties of the private link resource.", + "x-ms-client-flatten": true + }, + "id": { + "description": "Fully qualified identifier of the resource.", + "type": "string" + }, + "name": { + "description": "Name of the resource", + "type": "string" + }, + "type": { + "description": "Type of the resource", + "type": "string" + } + } + }, + "PrivateLinkResourceProperties": { + "description": "Properties of PrivateLinkResource", + "properties": { + "groupId": { + "type": "string" + }, + "requiredMembers": { + "type": "array", + "description": "Required Members", + "items": { + "type": "string" + } + }, + "requiredZoneNames": { + "type": "array", + "description": "Required Zone Names", + "items": { + "type": "string" + } + } + } + }, + "PrivateLinkResourcesListResult": { + "description": "Result of the List private link resources operation.", + "properties": { + "value": { + "description": "A collection of private link resources", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "description": "A link for the next page of private link resources.", + "type": "string" + } + } + }, + "userAssignedIdentityProperties": { + "type": "object", + "x-ms-client-flatten": true, + "properties": { + "userAssignedIdentity": { + "type": "string", + "description": "ARM ID of user Identity selected for encryption" + } + } + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/networksets.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/networksets.json new file mode 100644 index 000000000000..0d6baa1d10de --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/networksets.json @@ -0,0 +1,305 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2021-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/networkRuleSets/default": { + "put": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceNetworkRuleSetCreate": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetCreate.json" + } + }, + "operationId": "Namespaces_CreateOrUpdateNetworkRuleSet", + "description": "Create or update NetworkRuleSet for a Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkRuleSet" + }, + "description": "The Namespace IpFilterRule." + } + ], + "responses": { + "200": { + "description": "Namespace NetworkRuleSet successfully returned.", + "schema": { + "$ref": "#/definitions/NetworkRuleSet" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceNetworkRuleSetGet": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetGet.json" + } + }, + "operationId": "Namespaces_GetNetworkRuleSet", + "description": "Gets NetworkRuleSet for a Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace NetworkRuleSet successfully returned.", + "schema": { + "$ref": "#/definitions/NetworkRuleSet" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/networkRuleSets": { + "get": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceNetworkRuleSetList": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetList.json" + } + }, + "operationId": "Namespaces_ListNetworkRuleSets", + "description": "Gets list of NetworkRuleSet for a Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of NetworkRuleSets for Namespace successfully returned.", + "schema": { + "$ref": "#/definitions/NetworkRuleSetListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "NWRuleSetIpRules": { + "x-ms-client-flatten": true, + "properties": { + "ipMask": { + "type": "string", + "description": "IP Mask" + }, + "action": { + "type": "string", + "description": "The IP Filter Action", + "enum": [ + "Allow" + ], + "x-ms-enum": { + "name": "NetworkRuleIPAction", + "modelAsString": true + }, + "default": "Allow" + } + }, + "description": "Description of NetWorkRuleSet - IpRules resource." + }, + "Subnet": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID of Virtual Network Subnet" + } + }, + "required": [ + "id" + ], + "description": "Properties supplied for Subnet" + }, + "NWRuleSetVirtualNetworkRules": { + "x-ms-client-flatten": true, + "properties": { + "subnet": { + "$ref": "#/definitions/Subnet", + "description": "Subnet properties" + }, + "ignoreMissingVnetServiceEndpoint": { + "type": "boolean", + "description": "Value that indicates whether to ignore missing VNet Service Endpoint" + } + }, + "description": "Description of VirtualNetworkRules - NetworkRules resource." + }, + "NetworkRuleSet": { + "properties": { + "properties": { + "description": "NetworkRuleSet properties", + "x-ms-client-flatten": true, + "properties": { + "trustedServiceAccessEnabled": { + "type": "boolean", + "description": "Value that indicates whether Trusted Service Access is Enabled or not." + }, + "defaultAction": { + "type": "string", + "description": "Default Action for Network Rule Set", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "DefaultAction", + "modelAsString": true + } + }, + "virtualNetworkRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NWRuleSetVirtualNetworkRules" + }, + "description": "List VirtualNetwork Rules" + }, + "ipRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NWRuleSetIpRules" + }, + "description": "List of IpRules" + }, + "publicNetworkAccess": { + "description": "This determines if traffic is allowed over public network. By default it is enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccessFlag", + "modelAsString": true + }, + "default": "Enabled" + } + } + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Description of NetworkRuleSet resource." + }, + "NetworkRuleSetListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkRuleSet" + }, + "description": "Result of the List NetworkRuleSet operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of NetworkRuleSet." + } + }, + "description": "The response of the List NetworkRuleSet operation." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/operations.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/operations.json new file mode 100644 index 000000000000..729e809f9012 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/operations.json @@ -0,0 +1,126 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2021-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.ServiceBus/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/SBOperations_List.json" + } + }, + "description": "Lists all of the available ServiceBus REST API operations.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list ServiceBus operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "description": "List of ServiceBus operations supported by the Microsoft.ServiceBus resource provider.", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "A ServiceBus REST API operation", + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Operation name: {provider}/{resource}/{operation}" + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "readOnly": true, + "type": "string", + "description": "Service provider: Microsoft.ServiceBus" + }, + "resource": { + "readOnly": true, + "type": "string", + "description": "Resource on which the operation is performed: Invoice, etc." + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "Operation type: Read, write, delete, etc." + } + } + } + } + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/subscriptions.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/subscriptions.json new file mode 100644 index 000000000000..c835d1bcd12b --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/subscriptions.json @@ -0,0 +1,405 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2021-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions": { + "get": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_ListByTopic", + "x-ms-examples": { + "SubscriptionListByTopic": { + "$ref": "./examples/Subscriptions/SBSubscriptionListByTopic.json" + } + }, + "description": "List all the subscriptions under a specified topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639400.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SkipParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved list of subscriptions.", + "schema": { + "$ref": "#/definitions/SBSubscriptionListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}": { + "put": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_CreateOrUpdate", + "x-ms-examples": { + "SubscriptionCreate": { + "$ref": "./examples/Subscriptions/SBSubscriptionCreate.json" + } + }, + "description": "Creates a topic subscription.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639385.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBSubscription" + }, + "description": "Parameters supplied to create a subscription resource." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Subscription create request accepted.", + "schema": { + "$ref": "#/definitions/SBSubscription" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_Delete", + "x-ms-examples": { + "SubscriptionDelete": { + "$ref": "./examples/Subscriptions/SBSubscriptionDelete.json" + } + }, + "description": "Deletes a subscription from the specified topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639381.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Subscription successfully deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_Get", + "x-ms-examples": { + "SubscriptionGet": { + "$ref": "./examples/Subscriptions/SBSubscriptionGet.json" + } + }, + "description": "Returns a subscription description for the specified topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639402.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved subscription description.", + "schema": { + "$ref": "#/definitions/SBSubscription" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "SBSubscriptionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SBSubscription" + }, + "description": "Result of the List Subscriptions operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of subscriptions." + } + }, + "description": "The response to the List Subscriptions operation." + }, + "SBSubscription": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SBSubscriptionProperties", + "description": "Properties of subscriptions resource." + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Description of subscription resource." + }, + "SBSubscriptionProperties": { + "properties": { + "messageCount": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "Number of messages." + }, + "createdAt": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Exact time the message was created." + }, + "accessedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "Last time there was a receive request to this subscription." + }, + "updatedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the message was updated." + }, + "countDetails": { + "readOnly": true, + "$ref": "../../../common/v1/definitions.json#/definitions/MessageCountDetails", + "description": "Message count details" + }, + "lockDuration": { + "format": "duration", + "type": "string", + "description": "ISO 8061 lock duration timespan for the subscription. The default value is 1 minute." + }, + "requiresSession": { + "type": "boolean", + "description": "Value indicating if a subscription supports the concept of sessions." + }, + "defaultMessageTimeToLive": { + "format": "duration", + "type": "string", + "description": "ISO 8061 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself." + }, + "deadLetteringOnFilterEvaluationExceptions": { + "type": "boolean", + "description": "Value that indicates whether a subscription has dead letter support on filter evaluation exceptions." + }, + "deadLetteringOnMessageExpiration": { + "type": "boolean", + "description": "Value that indicates whether a subscription has dead letter support when a message expires." + }, + "duplicateDetectionHistoryTimeWindow": { + "format": "duration", + "type": "string", + "description": "ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes." + }, + "maxDeliveryCount": { + "format": "int32", + "type": "integer", + "description": "Number of maximum deliveries." + }, + "status": { + "$ref": "../../../common/v1/definitions.json#/definitions/EntityStatus", + "description": "Enumerates the possible values for the status of a messaging entity." + }, + "enableBatchedOperations": { + "type": "boolean", + "description": "Value that indicates whether server-side batched operations are enabled." + }, + "autoDeleteOnIdle": { + "format": "duration", + "type": "string", + "description": "ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes." + }, + "forwardTo": { + "type": "string", + "description": "Queue/Topic name to forward the messages" + }, + "forwardDeadLetteredMessagesTo": { + "type": "string", + "description": "Queue/Topic name to forward the Dead Letter message" + }, + "isClientAffine": { + "type": "boolean", + "description": "Value that indicates whether the subscription has an affinity to the client id." + }, + "clientAffineProperties": { + "$ref": "#/definitions/SBClientAffineProperties", + "description": "Properties specific to client affine subscriptions." + } + }, + "description": "Description of Subscription Resource." + }, + "SBClientAffineProperties": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "Indicates the Client ID of the application that created the client-affine subscription." + }, + "isDurable": { + "type": "boolean", + "description": "For client-affine subscriptions, this value indicates whether the subscription is durable or not." + }, + "isShared": { + "type": "boolean", + "description": "For client-affine subscriptions, this value indicates whether the subscription is shared or not." + } + }, + "description": "Properties specific to client affine subscriptions." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/topics.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/topics.json new file mode 100644 index 000000000000..a7f02c76975f --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/topics.json @@ -0,0 +1,364 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2021-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics": { + "get": { + "tags": [ + "Topics" + ], + "operationId": "Topics_ListByNamespace", + "x-ms-examples": { + "TopicGet": { + "$ref": "./examples/Topics/SBTopicListByNameSpace.json" + } + }, + "description": "Gets all the topics in a namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639388.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SkipParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved list of topics.", + "schema": { + "$ref": "#/definitions/SBTopicListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}": { + "put": { + "tags": [ + "Topics" + ], + "operationId": "Topics_CreateOrUpdate", + "x-ms-examples": { + "TopicCreate": { + "$ref": "./examples/Topics/SBTopicCreate.json" + } + }, + "description": "Creates a topic in the specified namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639409.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBTopic" + }, + "description": "Parameters supplied to create a topic resource." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Topic successfully created.", + "schema": { + "$ref": "#/definitions/SBTopic" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Topics" + ], + "operationId": "Topics_Delete", + "x-ms-examples": { + "TopicDelete": { + "$ref": "./examples/Topics/SBTopicDelete.json" + } + }, + "description": "Deletes a topic from the specified namespace and resource group.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639404.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Topic successfully deleted." + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Topics" + ], + "operationId": "Topics_Get", + "x-ms-examples": { + "TopicGet": { + "$ref": "./examples/Topics/SBTopicGet.json" + } + }, + "description": "Returns a description for the specified topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639399.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Topic description successfully retrieved.", + "schema": { + "$ref": "#/definitions/SBTopic" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "SBTopicListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SBTopic" + }, + "description": "Result of the List Topics operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of topics." + } + }, + "description": "The response to the List Topics operation." + }, + "SBTopic": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SBTopicProperties", + "description": "Properties of topic resource." + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../common/v1/definitions.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Description of topic resource." + }, + "SBTopicProperties": { + "properties": { + "sizeInBytes": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "Size of the topic, in bytes." + }, + "createdAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "Exact time the message was created." + }, + "updatedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the message was updated." + }, + "accessedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "Last time the message was sent, or a request was received, for this topic." + }, + "subscriptionCount": { + "readOnly": true, + "format": "int32", + "type": "integer", + "description": "Number of subscriptions." + }, + "countDetails": { + "readOnly": true, + "$ref": "../../../common/v1/definitions.json#/definitions/MessageCountDetails", + "description": "Message count details" + }, + "defaultMessageTimeToLive": { + "format": "duration", + "type": "string", + "description": "ISO 8601 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself." + }, + "maxSizeInMegabytes": { + "format": "int32", + "type": "integer", + "description": "Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024." + }, + "requiresDuplicateDetection": { + "type": "boolean", + "description": "Value indicating if this topic requires duplicate detection." + }, + "duplicateDetectionHistoryTimeWindow": { + "format": "duration", + "type": "string", + "description": "ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes." + }, + "enableBatchedOperations": { + "type": "boolean", + "description": "Value that indicates whether server-side batched operations are enabled." + }, + "status": { + "$ref": "../../../common/v1/definitions.json#/definitions/EntityStatus", + "description": "Enumerates the possible values for the status of a messaging entity." + }, + "supportOrdering": { + "type": "boolean", + "description": "Value that indicates whether the topic supports ordering." + }, + "autoDeleteOnIdle": { + "format": "duration", + "type": "string", + "description": "ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes." + }, + "enablePartitioning": { + "type": "boolean", + "description": "Value that indicates whether the topic to be partitioned across multiple message brokers is enabled." + }, + "enableExpress": { + "type": "boolean", + "description": "Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage." + } + }, + "description": "The Topic Properties definition." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/readme.go.md b/specification/servicebus/resource-manager/readme.go.md index 68bd36ff7a14..81cfc33cd8fa 100644 --- a/specification/servicebus/resource-manager/readme.go.md +++ b/specification/servicebus/resource-manager/readme.go.md @@ -2,7 +2,15 @@ These settings apply only when `--go` is specified on the command line. -``` yaml $(go) +``` yaml $(go) && $(track2) +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/servicebus/armservicebus +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) +azure-arm: true +``` + +``` yaml $(go) && !$(track2) go: license-header: MICROSOFT_MIT_NO_VERSION namespace: servicebus diff --git a/specification/servicebus/resource-manager/readme.md b/specification/servicebus/resource-manager/readme.md index bca59addcee2..d86422e1964f 100644 --- a/specification/servicebus/resource-manager/readme.md +++ b/specification/servicebus/resource-manager/readme.md @@ -48,6 +48,24 @@ input-file: - Microsoft.ServiceBus/preview/2021-01-01-preview/CheckNameAvailability.json ``` +### Tag: package-2021-06-preview + +These settings apply only when `--tag=package-2021-06-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2021-06-preview' +input-file: +- Microsoft.ServiceBus/preview/2021-06-01-preview/namespace-preview.json +- Microsoft.ServiceBus/preview/2021-06-01-preview/operations.json +- Microsoft.ServiceBus/preview/2021-06-01-preview/DisasterRecoveryConfig.json +- Microsoft.ServiceBus/preview/2021-06-01-preview/migrationconfigs.json +- Microsoft.ServiceBus/preview/2021-06-01-preview/networksets.json +- Microsoft.ServiceBus/preview/2021-06-01-preview/AuthorizationRules.json +- Microsoft.ServiceBus/preview/2021-06-01-preview/Queue.json +- Microsoft.ServiceBus/preview/2021-06-01-preview/topics.json +- Microsoft.ServiceBus/preview/2021-06-01-preview/Rules.json +- Microsoft.ServiceBus/preview/2021-06-01-preview/subscriptions.json +- Microsoft.ServiceBus/preview/2021-06-01-preview/CheckNameAvailability.json +``` ### Tag: package-2018-01-preview @@ -124,7 +142,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/servicebus/resource-manager/readme.python.md b/specification/servicebus/resource-manager/readme.python.md index 987e326fb8f1..dd22cfac12a1 100644 --- a/specification/servicebus/resource-manager/readme.python.md +++ b/specification/servicebus/resource-manager/readme.python.md @@ -1,16 +1,5 @@ ## Python -These settings apply only when `--python` is specified on the command line. - -``` yaml !$(track2) -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - package-name: azure-mgmt-servicebus - clear-output-folder: true - no-namespace-folders: true -``` These settings apply only when `--track2` is specified on the command line. @@ -27,13 +16,6 @@ modelerfour: Generate all API versions currently shipped for this package -```yaml $(multiapi) && !$(track2) -batch: - - tag: package-2021-01-preview - - tag: package-2018-01-preview - - tag: package-2017-04 - - tag: package-2015-08 -``` ```yaml $(multiapi) && $(track2) clear-output-folder: true @@ -59,9 +41,6 @@ Please also specify `--python-sdks-folder== Bronze and InfrastructureServiceManager = true. If VMInstanceCount = 0, implies the VMs for this nodeType will not be used for the initial cluster size computation.", + "minimum": 0, + "maximum": 2147483647 + }, + "reverseProxyEndpointPort": { + "type": "integer", + "format": "int32", + "description": "The endpoint used by reverse proxy." + }, + "isStateless": { + "type": "boolean", + "description": "Indicates if the node type can only host Stateless workloads." + }, + "multipleAvailabilityZones": { + "type": "boolean", + "description": "Indicates if the node type is enabled to support multiple zones." + } + }, + "description": "Describes a node type in the cluster, each node type represents sub set of nodes in the cluster." + }, + "Notification": { + "type": "object", + "required": [ + "isEnabled", + "notificationCategory", + "notificationLevel", + "notificationTargets" + ], + "properties": { + "isEnabled": { + "type": "boolean", + "description": "Indicates if the notification is enabled." + }, + "notificationCategory": { + "type": "string", + "description": "The category of notification.", + "enum": [ + "WaveProgress" + ], + "x-ms-enum": { + "name": "notificationCategory", + "modelAsString": true, + "values": [ + { + "value": "WaveProgress", + "description": "Notification will be regarding wave progress." + } + ] + } + }, + "notificationLevel": { + "type": "string", + "description": "The level of notification.", + "enum": [ + "Critical", + "All" + ], + "x-ms-enum": { + "name": "notificationLevel", + "modelAsString": true, + "values": [ + { + "value": "Critical", + "description": "Receive only critical notifications." + }, + { + "value": "All", + "description": "Receive all notifications." + } + ] + } + }, + "notificationTargets": { + "type": "array", + "items": { + "$ref": "#/definitions/NotificationTarget" + }, + "description": "List of targets that subscribe to the notification." + } + }, + "description": "Describes the notification channel for cluster events." + }, + "NotificationTarget": { + "type": "object", + "required": [ + "notificationChannel", + "receivers" + ], + "properties": { + "notificationChannel": { + "type": "string", + "description": "The notification channel indicates the type of receivers subscribed to the notification, either user or subscription.", + "enum": [ + "EmailUser", + "EmailSubscription" + ], + "x-ms-enum": { + "name": "notificationChannel", + "modelAsString": true, + "values": [ + { + "value": "EmailUser", + "description": "For email user receivers. In this case, the parameter receivers should be a list of email addresses that will receive the notifications." + }, + { + "value": "EmailSubscription", + "description": "For subscription receivers. In this case, the parameter receivers should be a list of roles of the subscription for the cluster (eg. Owner, AccountAdmin, etc) that will receive the notifications." + } + ] + } + }, + "receivers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of targets that subscribe to the notification." + } + }, + "description": "Describes the notification target properties." + }, + "OperationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "List of operations supported by the Service Fabric resource provider.", + "items": { + "$ref": "#/definitions/OperationResult" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any.", + "readOnly": true + } + }, + "description": "Describes the result of the request to list Service Fabric resource provider operations." + }, + "OperationResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "isDataAction": { + "type": "boolean", + "description": "Indicates whether the operation is a data action" + }, + "display": { + "$ref": "#/definitions/AvailableOperationDisplay", + "description": "The object that represents the operation." + }, + "origin": { + "type": "string", + "description": "Origin result" + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Available operation list result" + }, + "ReliabilityLevel": { + "type": "string", + "description": "The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity).\n\n - None - Run the System services with a target replica set count of 1. This should only be used for test clusters.\n - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters.\n - Silver - Run the System services with a target replica set count of 5.\n - Gold - Run the System services with a target replica set count of 7.\n - Platinum - Run the System services with a target replica set count of 9.\n", + "enum": [ + "None", + "Bronze", + "Silver", + "Gold", + "Platinum" + ] + }, + "Resource": { + "type": "object", + "required": [ + "location" + ], + "properties": { + "id": { + "type": "string", + "description": "Azure resource identifier.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Azure resource name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Azure resource type.", + "readOnly": true + }, + "location": { + "type": "string", + "description": "Azure resource location.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "type": "object", + "description": "Azure resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "etag": { + "type": "string", + "description": "Azure resource etag.", + "readOnly": true + }, + "systemData": { + "$ref": "#/definitions/SystemData" + } + }, + "description": "The resource model definition.", + "x-ms-azure-resource": true + }, + "ServerCertificateCommonName": { + "type": "object", + "description": "Describes the server certificate details using common name.", + "required": [ + "certificateCommonName", + "certificateIssuerThumbprint" + ], + "properties": { + "certificateCommonName": { + "type": "string", + "description": "The common name of the server certificate." + }, + "certificateIssuerThumbprint": { + "type": "string", + "description": "The issuer thumbprint of the server certificate." + } + } + }, + "ServerCertificateCommonNames": { + "type": "object", + "description": "Describes a list of server certificates referenced by common name that are used to secure the cluster.", + "properties": { + "commonNames": { + "type": "array", + "description": "The list of server certificates referenced by common name that are used to secure the cluster.", + "items": { + "$ref": "#/definitions/ServerCertificateCommonName" + } + }, + "x509StoreName": { + "$ref": "#/definitions/StoreName" + } + } + }, + "ServiceTypeDeltaHealthPolicy": { + "type": "object", + "description": "Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster.\n", + "properties": { + "maxPercentDeltaUnhealthyServices": { + "type": "integer", + "format": "int32", + "description": "The maximum allowed percentage of services health degradation allowed during cluster upgrades.\nThe delta is measured between the state of the services at the beginning of upgrade and the state of the services at the time of the health evaluation.\nThe check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits.\n", + "default": 0, + "minimum": 0, + "maximum": 100 + } + } + }, + "ServiceTypeDeltaHealthPolicyMap": { + "type": "object", + "description": "Defines a map that contains specific delta health policies for different service types.\nEach entry specifies as key the service type name and as value a ServiceTypeDeltaHealthPolicy used to evaluate the service health when upgrading the cluster.\nThe map is empty by default.\n", + "additionalProperties": { + "$ref": "#/definitions/ServiceTypeDeltaHealthPolicy" + } + }, + "SettingsParameterDescription": { + "type": "object", + "required": [ + "name", + "value" + ], + "properties": { + "name": { + "type": "string", + "description": "The parameter name of fabric setting." + }, + "value": { + "type": "string", + "description": "The parameter value of fabric setting." + } + }, + "description": "Describes a parameter in fabric settings of the cluster." + }, + "SettingsSectionDescription": { + "type": "object", + "required": [ + "name", + "parameters" + ], + "properties": { + "name": { + "type": "string", + "description": "The section name of the fabric settings." + }, + "parameters": { + "type": "array", + "description": "The collection of parameters in the section.", + "items": { + "$ref": "#/definitions/SettingsParameterDescription" + } + } + }, + "description": "Describes a section in the fabric settings of the cluster." + }, + "StoreName": { + "type": "string", + "description": "The local certificate store location.", + "enum": [ + "AddressBook", + "AuthRoot", + "CertificateAuthority", + "Disallowed", + "My", + "Root", + "TrustedPeople", + "TrustedPublisher" + ] + }, + "UpgradableVersionPathResult": { + "type": "object", + "properties": { + "supportedPath": { + "type": "array", + "items": { + "type": "string", + "description": "The cluster code version." + } + } + }, + "description": "The list of intermediate cluster code versions for an upgrade or downgrade. Or minimum and maximum upgradable version if no target was given" + }, + "UpgradableVersionsDescription": { + "type": "object", + "required": [ + "targetVersion" + ], + "properties": { + "targetVersion": { + "type": "string", + "description": "The target code version." + } + } + }, + "UpgradeMode": { + "type": "string", + "description": "The upgrade mode of the cluster when new Service Fabric runtime version is available.", + "enum": [ + "Automatic", + "Manual" + ], + "default": "Automatic", + "x-ms-enum": { + "name": "UpgradeMode", + "modelAsString": true, + "values": [ + { + "value": "Automatic", + "description": "The cluster will be automatically upgraded to the latest Service Fabric runtime version, **upgradeWave** will determine when the upgrade starts after the new version becomes available." + }, + { + "value": "Manual", + "description": "The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource." + } + ] + } + }, + "SfZonalUpgradeMode": { + "type": "string", + "enum": [ + "Parallel", + "Hierarchical" + ], + "x-ms-enum": { + "name": "sfZonalUpgradeMode", + "modelAsString": true, + "values": [ + { + "value": "Parallel", + "description": "VMs under the node type are grouped into UDs and ignore the zone info in five UDs. This setting causes UDs across all zones to be upgraded at the same time. This deployment mode is faster for upgrades, we don't recommend it because it goes against the SDP guidelines, which state that the updates should be applied to one zone at a time." + }, + { + "value": "Hierarchical", + "description": "If this value is omitted or set to Hierarchical, VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone. This update process is safer for the cluster and the user application." + } + ] + }, + "description": "This property controls the logical grouping of VMs in upgrade domains (UDs). This property can't be modified if a node type with multiple Availability Zones is already present in the cluster." + }, + "VmssZonalUpgradeMode": { + "type": "string", + "enum": [ + "Parallel", + "Hierarchical" + ], + "x-ms-enum": { + "name": "vmssZonalUpgradeMode", + "modelAsString": true, + "values": [ + { + "value": "Parallel", + "description": "Updates will happen in all Availability Zones at once for the virtual machine scale sets." + }, + { + "value": "Hierarchical", + "description": "VMs are grouped to reflect the zonal distribution in up to 15 UDs. Each of the three zones has five UDs. This ensures that the zones are updated one at a time, moving to next zone only after completing five UDs within the first zone." + } + ] + }, + "description": "This property defines the upgrade mode for the virtual machine scale set, it is mandatory if a node type with multiple Availability Zones is added." + }, + "ErrorModel": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorModelError" + } + }, + "description": "The structure of the error." + }, + "ErrorModelError": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "The error details." + }, + "ServiceTypeHealthPolicy": { + "type": "object", + "description": "Represents the health policy used to evaluate the health of services belonging to a service type.\n", + "properties": { + "maxPercentUnhealthyServices": { + "type": "integer", + "format": "int32", + "description": "The maximum percentage of services allowed to be unhealthy before your application is considered in error.\n", + "default": 0, + "minimum": 0, + "maximum": 100 + } + } + }, + "ServiceTypeHealthPolicyMap": { + "type": "object", + "description": "Defines a ServiceTypeHealthPolicy per service type name.\n\nThe entries in the map replace the default service type health policy for each specified service type.\nFor example, in an application that contains both a stateless gateway service type and a stateful engine service type, the health policies for the stateless and stateful services can be configured differently.\nWith policy per service type, there's more granular control of the health of the service.\n\nIf no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation.\n", + "additionalProperties": { + "$ref": "#/definitions/ServiceTypeHealthPolicy" + } + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "type": "string", + "description": "The type of identity that created the resource." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)." + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "type": "string", + "description": "The type of identity that last modified the resource." + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)." + } + } + } + }, + "parameters": { + "api-version": { + "name": "api-version", + "in": "query", + "description": "The version of the Service Fabric resource provider API. This is a required parameter and it's value must be \"2021-06-01\" for this specification.", + "required": true, + "type": "string", + "enum": [ + "2021-06-01" + ], + "default": "2021-06-01", + "x-ms-parameter-location": "client" + }, + "clusterNameParameter": { + "name": "clusterName", + "in": "path", + "description": "The name of the cluster resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "clusterVersion": { + "name": "clusterVersion", + "in": "path", + "description": "The cluster code version.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "environment": { + "name": "environment", + "in": "path", + "description": "The operating system of the cluster. The default means all.", + "required": true, + "type": "string", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-parameter-location": "method" + }, + "locationForClusterCodeVersions": { + "name": "location", + "in": "path", + "description": "The location for the cluster code versions. This is different from cluster location.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The customer subscription identifier.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationDeleteOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationDeleteOperation_example.json new file mode 100644 index 000000000000..3c100c08e386 --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationDeleteOperation_example.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2021-06-01" + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/76053752-a423-4a80-b283-1dad1ba5f314?api-version=2019-03-01" + } + }, + "204": {} + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationGetOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationGetOperation_example.json new file mode 100644 index 000000000000..636cb08bb1e8 --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationGetOperation_example.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502180261859\"", + "properties": { + "provisioningState": "Updating", + "typeName": "myAppType", + "typeVersion": "1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "upgradeMode": "Monitored", + "applicationHealthPolicy": { + "considerWarningAsError": true, + "maxPercentUnhealthyDeployedApplications": 0, + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0, + "maxPercentUnhealthyPartitionsPerService": 0, + "maxPercentUnhealthyReplicasPerPartition": 0 + } + }, + "rollingUpgradeMonitoringPolicy": { + "failureAction": "Rollback", + "healthCheckRetryTimeout": "00:10:00", + "healthCheckWaitDuration": "00:02:00", + "healthCheckStableDuration": "00:05:00", + "upgradeDomainTimeout": "1.06:00:00", + "upgradeTimeout": "01:00:00" + }, + "upgradeReplicaSetCheckTimeout": "01:00:00", + "forceRestart": false + }, + "maximumNodes": 3, + "minimumNodes": 1, + "removeApplicationCapacity": false, + "metrics": [ + { + "name": "metric1", + "reservationCapacity": 1, + "maximumCapacity": 3, + "totalApplicationCapacity": 5 + } + ] + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationListOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationListOperation_example.json new file mode 100644 index 000000000000..c24018c03526 --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationListOperation_example.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502180261858\"", + "properties": { + "provisioningState": "Updating", + "typeName": "myAppType", + "typeVersion": "1.0", + "removeApplicationCapacity": false, + "metrics": [ + { + "name": "metric1", + "reservationCapacity": 1, + "maximumCapacity": 3, + "totalApplicationCapacity": 5 + } + ] + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationPatchOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationPatchOperation_example.json new file mode 100644 index 000000000000..5e41e511b822 --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationPatchOperation_example.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2021-06-01", + "parameters": { + "location": "eastus", + "tags": {}, + "properties": { + "typeVersion": "1.0", + "removeApplicationCapacity": false, + "metrics": [ + { + "name": "metric1", + "reservationCapacity": 1, + "maximumCapacity": 3, + "totalApplicationCapacity": 5 + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/a553eb63-c332-40df-8ace-eb8d34a9b298?api-version=2021-06-01" + }, + "body": { + "type": "applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502180261858\"", + "properties": { + "provisioningState": "Updating", + "typeName": "myAppType", + "typeVersion": "1.0", + "removeApplicationCapacity": false, + "metrics": [ + { + "name": "metric1", + "reservationCapacity": 1, + "maximumCapacity": 3, + "totalApplicationCapacity": 5 + } + ] + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationPutOperation_example_max.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationPutOperation_example_max.json new file mode 100644 index 000000000000..47754ec636e8 --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationPutOperation_example_max.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2021-06-01", + "parameters": { + "tags": {}, + "properties": { + "typeName": "myAppType", + "typeVersion": "1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "upgradeMode": "Monitored", + "applicationHealthPolicy": { + "considerWarningAsError": true, + "maxPercentUnhealthyDeployedApplications": 0, + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0, + "maxPercentUnhealthyPartitionsPerService": 0, + "maxPercentUnhealthyReplicasPerPartition": 0 + } + }, + "rollingUpgradeMonitoringPolicy": { + "failureAction": "Rollback", + "healthCheckRetryTimeout": "00:10:00", + "healthCheckWaitDuration": "00:02:00", + "healthCheckStableDuration": "00:05:00", + "upgradeDomainTimeout": "1.06:00:00", + "upgradeTimeout": "01:00:00" + }, + "upgradeReplicaSetCheckTimeout": "01:00:00", + "forceRestart": false + }, + "maximumNodes": 3, + "minimumNodes": 1, + "removeApplicationCapacity": false, + "metrics": [ + { + "name": "metric1", + "reservationCapacity": 1, + "maximumCapacity": 3, + "totalApplicationCapacity": 5 + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/9c2ce367-47ea-43de-b69e-c5a423da4557?api-version=2021-06-01" + }, + "body": { + "type": "applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502180261859\"", + "properties": { + "provisioningState": "Updating", + "typeName": "myAppType", + "typeVersion": "1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "upgradeMode": "Monitored", + "applicationHealthPolicy": { + "considerWarningAsError": true, + "maxPercentUnhealthyDeployedApplications": 0, + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0, + "maxPercentUnhealthyPartitionsPerService": 0, + "maxPercentUnhealthyReplicasPerPartition": 0 + } + }, + "rollingUpgradeMonitoringPolicy": { + "failureAction": "Rollback", + "healthCheckRetryTimeout": "00:10:00", + "healthCheckWaitDuration": "00:02:00", + "healthCheckStableDuration": "00:05:00", + "upgradeDomainTimeout": "1.06:00:00", + "upgradeTimeout": "01:00:00" + }, + "upgradeReplicaSetCheckTimeout": "01:00:00", + "forceRestart": false + }, + "maximumNodes": 3, + "minimumNodes": 1, + "removeApplicationCapacity": false, + "metrics": [ + { + "name": "metric1", + "reservationCapacity": 1, + "maximumCapacity": 3, + "totalApplicationCapacity": 5 + } + ] + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationPutOperation_example_min.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationPutOperation_example_min.json new file mode 100644 index 000000000000..9189fb62b3ae --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationPutOperation_example_min.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2021-06-01", + "parameters": { + "location": "eastus", + "tags": {}, + "properties": { + "typeName": "myAppType", + "typeVersion": "1.0", + "removeApplicationCapacity": false + } + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/5dce62ce-439b-47af-81d8-99ab14708e91?api-version=2021-06-01" + }, + "body": { + "type": "applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502180261857\"", + "properties": { + "provisioningState": "Updating", + "typeName": "myAppType", + "typeVersion": "1.0", + "removeApplicationCapacity": false + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationPutOperation_recreate_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationPutOperation_recreate_example.json new file mode 100644 index 000000000000..ddd23d7278d1 --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationPutOperation_recreate_example.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2021-06-01", + "parameters": { + "tags": {}, + "properties": { + "typeName": "myAppType", + "typeVersion": "1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "recreateApplication": true + } + } + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/9c2ce367-47ea-43de-b69e-c5a423da4557?api-version=2021-06-01" + }, + "body": { + "type": "applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502180261859\"", + "properties": { + "provisioningState": "Updating", + "typeName": "myAppType", + "typeVersion": "1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "recreateApplication": true + } + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationTypeNameDeleteOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationTypeNameDeleteOperation_example.json new file mode 100644 index 000000000000..dba673412b77 --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationTypeNameDeleteOperation_example.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "api-version": "2021-06-01" + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/6a367b2d-9f60-4941-b886-e348ddcb4127?api-version=2021-06-01" + } + }, + "204": {} + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationTypeNameGetOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationTypeNameGetOperation_example.json new file mode 100644 index 000000000000..6d0b782c92c5 --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationTypeNameGetOperation_example.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "applicationTypes", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applicationTypes/myAppType", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502174844831\"", + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationTypeNameListOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationTypeNameListOperation_example.json new file mode 100644 index 000000000000..7c4312426f8c --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationTypeNameListOperation_example.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "applicationTypes", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applicationTypes/myAppType", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502174844831\"", + "properties": { + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationTypeNamePutOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationTypeNamePutOperation_example.json new file mode 100644 index 000000000000..195d8d6dfffe --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationTypeNamePutOperation_example.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "api-version": "2021-06-01", + "parameters": { + "tags": {} + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "applicationTypes", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applicationTypes/myAppType", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502174844831\"", + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationTypeVersionDeleteOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationTypeVersionDeleteOperation_example.json new file mode 100644 index 000000000000..9f7bb9c285f7 --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationTypeVersionDeleteOperation_example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "version": "1.0", + "api-version": "2021-06-01" + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/28e62369-ed8c-4aba-8c05-ab7d6238cc3d?api-version=2021-06-01" + } + }, + "204": {} + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationTypeVersionGetOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationTypeVersionGetOperation_example.json new file mode 100644 index 000000000000..0ba58e2f405a --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationTypeVersionGetOperation_example.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "version": "1.0", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "versions", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applicationTypes/myAppType/versions/1.0", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502176040417\"", + "properties": { + "provisioningState": "Updating", + "appPackageUrl": "http://fakelink.test.com/MyAppType", + "defaultParameterList": {} + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationTypeVersionListOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationTypeVersionListOperation_example.json new file mode 100644 index 000000000000..52dfe1003f93 --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationTypeVersionListOperation_example.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "versions", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applicationTypes/myAppType/versions/1.0", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502176040417\"", + "properties": { + "provisioningState": "Updating", + "appPackageUrl": "http://fakelink.test.com/MyAppType", + "defaultParameterList": {} + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationTypeVersionPutOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationTypeVersionPutOperation_example.json new file mode 100644 index 000000000000..657ad05956fd --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ApplicationTypeVersionPutOperation_example.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "version": "1.0", + "api-version": "2021-06-01", + "parameters": { + "tags": {}, + "properties": { + "appPackageUrl": "http://fakelink.test.com/MyAppType" + } + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/e2413c7e-d51b-40ac-8155-bc85bf8ae856?api-version=2021-06-01" + }, + "body": { + "type": "versions", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applicationTypes/myAppType/versions/1.0", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502176040417\"", + "properties": { + "provisioningState": "Updating", + "appPackageUrl": "http://fakelink.test.com/MyAppType", + "defaultParameterList": {} + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterDeleteOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterDeleteOperation_example.json new file mode 100644 index 000000000000..ac5161ab885d --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterDeleteOperation_example.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "headers": {} + }, + "204": {} + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterGetOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterGetOperation_example.json new file mode 100644 index 000000000000..fdd57ce7c83a --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterGetOperation_example.json @@ -0,0 +1,159 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "6.1.480.9494", + "clusterState": "WaitingForNodes", + "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "certificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "clientCertificateThumbprints": [ + { + "isAdmin": true, + "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "clientCertificateCommonNames": [ + { + "isAdmin": true, + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "forceRestart": false, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "01:00:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 0, + "maxPercentUnhealthyApplications": 0, + "applicationHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0 + }, + "serviceTypeHealthPolicies": { + "myServiceType1": { + "maxPercentUnhealthyServices": 100 + } + } + } + } + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0, + "applicationDeltaHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeDeltaHealthPolicy": { + "maxPercentDeltaUnhealthyServices": 0 + }, + "serviceTypeDeltaHealthPolicies": { + "myServiceType1": { + "maxPercentDeltaUnhealthyServices": 0 + } + } + } + } + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "vmImage": "Windows", + "azureActiveDirectory": { + "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", + "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", + "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" + }, + "reliabilityLevel": "Silver", + "reverseProxyCertificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "upgradeMode": "Manual", + "availableClusterVersions": [ + { + "codeVersion": "6.1.480.9494", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + ], + "addOnFeatures": [ + "RepairManager", + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ] + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterListByResourceGroupOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterListByResourceGroupOperation_example.json new file mode 100644 index 000000000000..389206b2563b --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterListByResourceGroupOperation_example.json @@ -0,0 +1,248 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "6.1.480.9494", + "clusterState": "WaitingForNodes", + "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "certificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "clientCertificateThumbprints": [ + { + "isAdmin": false, + "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "clientCertificateCommonNames": [ + { + "isAdmin": true, + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "forceRestart": false, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "01:00:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 0, + "maxPercentUnhealthyApplications": 0, + "applicationHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0 + }, + "serviceTypeHealthPolicies": { + "myServiceType1": { + "maxPercentUnhealthyServices": 100 + } + } + } + } + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0, + "applicationDeltaHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeDeltaHealthPolicy": { + "maxPercentDeltaUnhealthyServices": 0 + }, + "serviceTypeDeltaHealthPolicies": { + "myServiceType1": { + "maxPercentDeltaUnhealthyServices": 0 + } + } + } + } + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "vmImage": "Windows", + "azureActiveDirectory": { + "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", + "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", + "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" + }, + "reliabilityLevel": "Silver", + "reverseProxyCertificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "upgradeMode": "Manual", + "availableClusterVersions": [ + { + "codeVersion": "6.1.480.9494", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + ], + "addOnFeatures": [ + "RepairManager", + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ] + } + }, + { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster2", + "name": "myCluster2", + "tags": {}, + "etag": "W/\"636462502164040075\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "2747e469-b24e-4039-8a0a-46151419523f", + "clusterCodeVersion": "6.1.187.1", + "clusterState": "WaitingForNodes", + "managementEndpoint": "http://myCluster2.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "clientCertificateThumbprints": [], + "clientCertificateCommonNames": [], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "forceRestart": false, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "01:00:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 0, + "maxPercentUnhealthyApplications": 0 + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0 + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "vmImage": "Ubuntu", + "reliabilityLevel": "Silver", + "upgradeMode": "Manual", + "availableClusterVersions": [ + { + "codeVersion": "6.1.187.1", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Linux" + } + ], + "addOnFeatures": [ + "RepairManager" + ] + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterListOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterListOperation_example.json new file mode 100644 index 000000000000..b467a93ebbe4 --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterListOperation_example.json @@ -0,0 +1,247 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "6.1.480.9494", + "clusterState": "WaitingForNodes", + "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "certificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "clientCertificateThumbprints": [ + { + "isAdmin": false, + "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "clientCertificateCommonNames": [ + { + "isAdmin": true, + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "forceRestart": false, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "01:00:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 0, + "maxPercentUnhealthyApplications": 0, + "applicationHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0 + }, + "serviceTypeHealthPolicies": { + "myServiceType1": { + "maxPercentUnhealthyServices": 100 + } + } + } + } + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0, + "applicationDeltaHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeDeltaHealthPolicy": { + "maxPercentDeltaUnhealthyServices": 0 + }, + "serviceTypeDeltaHealthPolicies": { + "myServiceType1": { + "maxPercentDeltaUnhealthyServices": 0 + } + } + } + } + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "vmImage": "Windows", + "azureActiveDirectory": { + "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", + "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", + "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" + }, + "reliabilityLevel": "Silver", + "reverseProxyCertificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "upgradeMode": "Manual", + "availableClusterVersions": [ + { + "codeVersion": "6.1.480.9494", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + ], + "addOnFeatures": [ + "RepairManager", + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ] + } + }, + { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster2", + "name": "myCluster2", + "tags": {}, + "etag": "W/\"636462502164040075\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "2747e469-b24e-4039-8a0a-46151419523f", + "clusterCodeVersion": "6.1.187.1", + "clusterState": "WaitingForNodes", + "managementEndpoint": "http://myCluster2.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "clientCertificateThumbprints": [], + "clientCertificateCommonNames": [], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "forceRestart": false, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "01:00:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 0, + "maxPercentUnhealthyApplications": 0 + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0 + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "vmImage": "Ubuntu", + "reliabilityLevel": "Silver", + "upgradeMode": "Manual", + "availableClusterVersions": [ + { + "codeVersion": "6.1.187.1", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Linux" + } + ], + "addOnFeatures": [ + "RepairManager" + ] + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterPatchOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterPatchOperation_example.json new file mode 100644 index 000000000000..7e3de12e3f1d --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterPatchOperation_example.json @@ -0,0 +1,337 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2021-06-01", + "parameters": { + "tags": { + "a": "b" + }, + "properties": { + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + }, + { + "name": "testnt1", + "clientConnectionEndpointPort": 0, + "httpGatewayEndpointPort": 0, + "applicationPorts": { + "startPort": 1000, + "endPort": 2000 + }, + "ephemeralPorts": { + "startPort": 3000, + "endPort": 4000 + }, + "isPrimary": false, + "vmInstanceCount": 3, + "durabilityLevel": "Bronze" + } + ], + "reliabilityLevel": "Bronze", + "upgradeMode": "Automatic", + "eventStoreServiceEnabled": true, + "upgradeWave": "Wave", + "upgradePauseStartTimestampUtc": "2021-06-21T22:00:00Z", + "upgradePauseEndTimestampUtc": "2021-06-25T22:00:00Z" + } + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2019-03-01" + }, + "body": { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": { + "a": "b" + }, + "etag": "W/\"636462502169240744\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "6.1.480.9494", + "clusterState": "WaitingForNodes", + "managementEndpoint": "http://myCluster.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "certificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "clientCertificateThumbprints": [], + "clientCertificateCommonNames": [], + "eventStoreServiceEnabled": true, + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "forceRestart": false, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "01:00:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 0, + "maxPercentUnhealthyApplications": 0 + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0 + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + }, + { + "name": "testnt1", + "clientConnectionEndpointPort": 0, + "httpGatewayEndpointPort": 0, + "applicationPorts": { + "startPort": 1000, + "endPort": 2000 + }, + "ephemeralPorts": { + "startPort": 3000, + "endPort": 4000 + }, + "isPrimary": false, + "vmInstanceCount": 3, + "durabilityLevel": "Bronze" + } + ], + "reliabilityLevel": "Bronze", + "upgradeMode": "Automatic", + "availableClusterVersions": [ + { + "codeVersion": "6.1.480.9494", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + ], + "upgradeWave": "Wave2", + "upgradePauseStartTimestampUtc": "2021-06-21T22:00:00Z", + "upgradePauseEndTimestampUtc": "2021-06-25T22:00:00Z" + } + } + }, + "200": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2019-03-01" + }, + "body": { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": { + "a": "b" + }, + "etag": "W/\"636462502169240744\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "6.1.480.9494", + "clusterState": "WaitingForNodes", + "managementEndpoint": "http://myCluster.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "certificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "clientCertificateThumbprints": [], + "clientCertificateCommonNames": [], + "eventStoreServiceEnabled": true, + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "forceRestart": false, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "01:00:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 0, + "maxPercentUnhealthyApplications": 0 + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0 + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + }, + { + "name": "testnt1", + "clientConnectionEndpointPort": 0, + "httpGatewayEndpointPort": 0, + "applicationPorts": { + "startPort": 1000, + "endPort": 2000 + }, + "ephemeralPorts": { + "startPort": 3000, + "endPort": 4000 + }, + "isPrimary": false, + "vmInstanceCount": 3, + "durabilityLevel": "Bronze" + } + ], + "reliabilityLevel": "Bronze", + "upgradeMode": "Automatic", + "availableClusterVersions": [ + { + "codeVersion": "6.1.480.9494", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + ], + "upgradeWave": "Wave2", + "upgradePauseStartTimestampUtc": "2021-06-21T22:00:00Z", + "upgradePauseEndTimestampUtc": "2021-06-25T22:00:00Z", + "notifications": [ + { + "isEnabled": true, + "notificationCategory": "WaveProgress", + "notificationLevel": "Critical", + "notificationTargets": [ + { + "notificationChannel": "EmailUser", + "receivers": [ + "****@microsoft.com", + "****@microsoft.com" + ] + }, + { + "notificationChannel": "EmailSubscription", + "receivers": [ + "Owner", + "AccountAdmin" + ] + } + ] + }, + { + "isEnabled": true, + "notificationCategory": "WaveProgress", + "notificationLevel": "All", + "notificationTargets": [ + { + "notificationChannel": "EmailUser", + "receivers": [ + "****@microsoft.com", + "****@microsoft.com" + ] + }, + { + "notificationChannel": "EmailSubscription", + "receivers": [ + "Owner", + "AccountAdmin" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterPutOperation_example_max.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterPutOperation_example_max.json new file mode 100644 index 000000000000..71aaef47f1d8 --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterPutOperation_example_max.json @@ -0,0 +1,613 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2021-06-01", + "parameters": { + "location": "eastus", + "tags": {}, + "properties": { + "clusterCodeVersion": "7.0.470.9590", + "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", + "certificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "clientCertificateThumbprints": [ + { + "isAdmin": true, + "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "clientCertificateCommonNames": [ + { + "isAdmin": true, + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "forceRestart": false, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "01:00:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 0, + "maxPercentUnhealthyApplications": 0, + "applicationHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0 + }, + "serviceTypeHealthPolicies": { + "myServiceType1": { + "maxPercentUnhealthyServices": 100 + } + } + } + } + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0, + "applicationDeltaHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeDeltaHealthPolicy": { + "maxPercentDeltaUnhealthyServices": 0 + }, + "serviceTypeDeltaHealthPolicies": { + "myServiceType1": { + "maxPercentDeltaUnhealthyServices": 0 + } + } + } + } + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "sfZonalUpgradeMode": "Hierarchical", + "vmssZonalUpgradeMode": "Parallel", + "infrastructureServiceManager": true, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Silver", + "isStateless": false, + "multipleAvailabilityZones": true + } + ], + "vmImage": "Windows", + "azureActiveDirectory": { + "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", + "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", + "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" + }, + "reliabilityLevel": "Platinum", + "reverseProxyCertificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "upgradeMode": "Manual", + "addOnFeatures": [ + "RepairManager", + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ], + "eventStoreServiceEnabled": true, + "applicationTypeVersionsCleanupPolicy": { + "maxUnusedVersionsToKeep": 2 + }, + "upgradeWave": "Wave1", + "upgradePauseStartTimestampUtc": "2021-06-21T22:00:00Z", + "upgradePauseEndTimestampUtc": "2021-06-25T22:00:00Z", + "notifications": [ + { + "isEnabled": true, + "notificationCategory": "WaveProgress", + "notificationLevel": "Critical", + "notificationTargets": [ + { + "notificationChannel": "EmailUser", + "receivers": [ + "****@microsoft.com", + "****@microsoft.com" + ] + }, + { + "notificationChannel": "EmailSubscription", + "receivers": [ + "Owner", + "AccountAdmin" + ] + } + ] + }, + { + "isEnabled": true, + "notificationCategory": "WaveProgress", + "notificationLevel": "All", + "notificationTargets": [ + { + "notificationChannel": "EmailUser", + "receivers": [ + "****@microsoft.com", + "****@microsoft.com" + ] + }, + { + "notificationChannel": "EmailSubscription", + "receivers": [ + "Owner", + "AccountAdmin" + ] + } + ] + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/4b5f6709-bc12-4365-8df3-894984b2a221?api-version=2021-06-01" + }, + "body": { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "7.0.470.9590", + "clusterState": "WaitingForNodes", + "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "certificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "clientCertificateThumbprints": [ + { + "isAdmin": false, + "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "clientCertificateCommonNames": [ + { + "isAdmin": true, + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "forceRestart": true, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "00:15:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 0, + "maxPercentUnhealthyApplications": 0, + "applicationHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0 + }, + "serviceTypeHealthPolicies": { + "myServiceType1": { + "maxPercentUnhealthyServices": 100 + } + } + } + } + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0, + "applicationDeltaHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeDeltaHealthPolicy": { + "maxPercentDeltaUnhealthyServices": 0 + }, + "serviceTypeDeltaHealthPolicies": { + "myServiceType1": { + "maxPercentDeltaUnhealthyServices": 0 + } + } + } + } + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "sfZonalUpgradeMode": "Hierarchical", + "vmssZonalUpgradeMode": "Parallel", + "infrastructureServiceManager": true, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Silver", + "isStateless": false, + "multipleAvailabilityZones": true + } + ], + "vmImage": "Windows", + "azureActiveDirectory": { + "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", + "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", + "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" + }, + "reliabilityLevel": "Platinum", + "reverseProxyCertificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "upgradeMode": "Manual", + "availableClusterVersions": [ + { + "codeVersion": "7.0.470.9590", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + ], + "addOnFeatures": [ + "RepairManager", + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ], + "eventStoreServiceEnabled": true, + "applicationTypeVersionsCleanupPolicy": { + "maxUnusedVersionsToKeep": 2 + }, + "upgradeWave": "Wave1", + "upgradePauseStartTimestampUtc": "2021-06-21T22:00:00Z", + "upgradePauseEndTimestampUtc": "2021-06-25T22:00:00Z", + "notifications": [ + { + "isEnabled": true, + "notificationCategory": "WaveProgress", + "notificationLevel": "Critical", + "notificationTargets": [ + { + "notificationChannel": "EmailUser", + "receivers": [ + "****@microsoft.com", + "****@microsoft.com" + ] + }, + { + "notificationChannel": "EmailSubscription", + "receivers": [ + "Owner", + "AccountAdmin" + ] + } + ] + }, + { + "isEnabled": true, + "notificationCategory": "WaveProgress", + "notificationLevel": "All", + "notificationTargets": [ + { + "notificationChannel": "EmailUser", + "receivers": [ + "****@microsoft.com", + "****@microsoft.com" + ] + }, + { + "notificationChannel": "EmailSubscription", + "receivers": [ + "Owner", + "AccountAdmin" + ] + } + ] + } + ] + } + } + }, + "200": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/4b5f6709-bc12-4365-8df3-894984b2a221?api-version=2019-03-01" + }, + "body": { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "7.0.470.9590", + "clusterState": "WaitingForNodes", + "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "certificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "clientCertificateThumbprints": [ + { + "isAdmin": false, + "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "clientCertificateCommonNames": [ + { + "isAdmin": true, + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "forceRestart": true, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "00:15:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 0, + "maxPercentUnhealthyApplications": 0, + "applicationHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0 + }, + "serviceTypeHealthPolicies": { + "myServiceType1": { + "maxPercentUnhealthyServices": 100 + } + } + } + } + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0, + "applicationDeltaHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeDeltaHealthPolicy": { + "maxPercentDeltaUnhealthyServices": 0 + }, + "serviceTypeDeltaHealthPolicies": { + "myServiceType1": { + "maxPercentDeltaUnhealthyServices": 0 + } + } + } + } + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "sfZonalUpgradeMode": "Hierarchical", + "vmssZonalUpgradeMode": "Parallel", + "infrastructureServiceManager": true, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Silver", + "isStateless": false, + "multipleAvailabilityZones": true + } + ], + "vmImage": "Windows", + "azureActiveDirectory": { + "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", + "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", + "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" + }, + "reliabilityLevel": "Platinum", + "reverseProxyCertificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "upgradeMode": "Manual", + "availableClusterVersions": [ + { + "codeVersion": "7.0.470.9590", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + ], + "addOnFeatures": [ + "RepairManager", + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ], + "eventStoreServiceEnabled": true, + "applicationTypeVersionsCleanupPolicy": { + "maxUnusedVersionsToKeep": 2 + }, + "upgradeWave": "Wave1", + "upgradePauseStartTimestampUtc": "2021-06-21T22:00:00Z", + "upgradePauseEndTimestampUtc": "2021-06-25T22:00:00Z", + "notifications": [ + { + "isEnabled": true, + "notificationCategory": "WaveProgress", + "notificationLevel": "Critical", + "notificationTargets": [ + { + "notificationChannel": "EmailUser", + "receivers": [ + "****@microsoft.com", + "****@microsoft.com" + ] + }, + { + "notificationChannel": "EmailSubscription", + "receivers": [ + "Owner", + "AccountAdmin" + ] + } + ] + }, + { + "isEnabled": true, + "notificationCategory": "WaveProgress", + "notificationLevel": "All", + "notificationTargets": [ + { + "notificationChannel": "EmailUser", + "receivers": [ + "****@microsoft.com", + "****@microsoft.com" + ] + }, + { + "notificationChannel": "EmailSubscription", + "receivers": [ + "Owner", + "AccountAdmin" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterPutOperation_example_min.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterPutOperation_example_min.json new file mode 100644 index 000000000000..7c94354a95ec --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterPutOperation_example_min.json @@ -0,0 +1,223 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2021-06-01", + "parameters": { + "location": "eastus", + "tags": {}, + "properties": { + "managementEndpoint": "http://myCluster.eastus.cloudapp.azure.com:19080", + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "reliabilityLevel": "Silver", + "upgradeMode": "Automatic" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240743\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "7.0.470.9590", + "clusterState": "WaitingForNodes", + "managementEndpoint": "http://myCluster.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "clientCertificateThumbprints": [], + "clientCertificateCommonNames": [], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "forceRestart": false, + "upgradeReplicaSetCheckTimeout": "10675199.02:48:05.4775807", + "healthCheckWaitDuration": "00:05:00", + "healthCheckStableDuration": "00:05:00", + "healthCheckRetryTimeout": "00:45:00", + "upgradeTimeout": "12:00:00", + "upgradeDomainTimeout": "02:00:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 100, + "maxPercentUnhealthyApplications": 100 + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0 + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "reliabilityLevel": "Silver", + "upgradeMode": "Automatic", + "availableClusterVersions": [ + { + "codeVersion": "7.0.470.9590", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + ] + } + } + }, + "202": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240743\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "7.0.470.9590", + "clusterState": "WaitingForNodes", + "managementEndpoint": "http://myCluster.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "clientCertificateThumbprints": [], + "clientCertificateCommonNames": [], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "forceRestart": false, + "upgradeReplicaSetCheckTimeout": "10675199.02:48:05.4775807", + "healthCheckWaitDuration": "00:05:00", + "healthCheckStableDuration": "00:05:00", + "healthCheckRetryTimeout": "00:45:00", + "upgradeTimeout": "12:00:00", + "upgradeDomainTimeout": "02:00:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 100, + "maxPercentUnhealthyApplications": 100 + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0 + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "reliabilityLevel": "Silver", + "upgradeMode": "Automatic", + "availableClusterVersions": [ + { + "codeVersion": "7.0.470.9590", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + ] + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterVersionsGetByEnvironment_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterVersionsGetByEnvironment_example.json new file mode 100644 index 000000000000..f542cfef700d --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterVersionsGetByEnvironment_example.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "environment": "Windows", + "clusterVersion": "6.1.480.9494", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/clusterVersions/6.1.480.9494", + "name": "6.1.480.9494", + "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions", + "properties": { + "codeVersion": "6.1.480.9494", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterVersionsGet_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterVersionsGet_example.json new file mode 100644 index 000000000000..322c68da1898 --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterVersionsGet_example.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "clusterVersion": "6.1.480.9494", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/clusterVersions/6.1.480.9494", + "name": "6.1.480.9494", + "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions", + "properties": { + "codeVersion": "6.1.480.9494", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterVersionsListByEnvironment.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterVersionsListByEnvironment.json new file mode 100644 index 000000000000..1bca062153ee --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterVersionsListByEnvironment.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "environment": "Windows", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/clusterVersions/6.1.480.9494", + "name": "6.1.480.9494", + "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions", + "properties": { + "codeVersion": "6.1.480.9494", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterVersionsList_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterVersionsList_example.json new file mode 100644 index 000000000000..98eb5793761c --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ClusterVersionsList_example.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/clusterVersions/6.1.480.9494", + "name": "6.1.480.9494", + "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions", + "properties": { + "codeVersion": "6.1.480.9494", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Linux/clusterVersions/6.1.187.1", + "name": "6.1.187.1", + "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions", + "properties": { + "codeVersion": "6.1.187.1", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Linux" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ListUpgradableVersionsMinMax_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ListUpgradableVersionsMinMax_example.json new file mode 100644 index 000000000000..ab626bed1f93 --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ListUpgradableVersionsMinMax_example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "supportedPath": [ + "7.0.0.0", + "7.2.0.0" + ] + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ListUpgradableVersionsPath_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ListUpgradableVersionsPath_example.json new file mode 100644 index 000000000000..b3b7b814fa6b --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ListUpgradableVersionsPath_example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2021-06-01", + "versionsDescription": { + "targetVersion": "7.2.432.9590" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "supportedPath": [ + "6.4.664.9590", + "7.0.466.9590", + "7.0.470.9590", + "7.2.432.9590" + ] + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ServiceDeleteOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ServiceDeleteOperation_example.json new file mode 100644 index 000000000000..26210cfc298e --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ServiceDeleteOperation_example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "serviceName": "myService", + "api-version": "2021-06-01" + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/41fa5ef9-7f34-4c36-a730-93e0bb757d22?api-version=2021-06-01" + } + }, + "204": {} + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ServiceGetOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ServiceGetOperation_example.json new file mode 100644 index 000000000000..4899a5d182ec --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ServiceGetOperation_example.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "serviceName": "myService", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "services", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp/services/myService", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502183671258\"", + "properties": { + "provisioningState": "Updating", + "serviceKind": "Stateless", + "placementConstraints": "NodeType==frontend", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low" + } + ], + "servicePlacementPolicies": [], + "defaultMoveCost": "Medium", + "instanceCount": 5, + "servicePackageActivationMode": "SharedProcess" + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ServiceListOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ServiceListOperation_example.json new file mode 100644 index 000000000000..0099e5e97f62 --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ServiceListOperation_example.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "services", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp/services/myService", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502183671257\"", + "properties": { + "provisioningState": "Updating", + "serviceKind": "Stateless", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low" + } + ], + "instanceCount": 1, + "servicePackageActivationMode": "SharedProcess" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ServicePatchOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ServicePatchOperation_example.json new file mode 100644 index 000000000000..ecca36953f29 --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ServicePatchOperation_example.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "serviceName": "myService", + "api-version": "2021-06-01", + "parameters": { + "tags": {}, + "properties": { + "serviceKind": "Stateless", + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low" + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/4dde8d8b-b6b2-4c56-99c6-9b83932bb09a?api-version=2021-06-01" + }, + "body": { + "type": "services", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp/services/myService", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502183671257\"", + "properties": { + "provisioningState": "Updating", + "serviceKind": "Stateless", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low" + } + ], + "instanceCount": 1, + "servicePackageActivationMode": "SharedProcess" + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ServicePutOperation_example_max.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ServicePutOperation_example_max.json new file mode 100644 index 000000000000..4d5784b48499 --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ServicePutOperation_example_max.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "serviceName": "myService", + "api-version": "2021-06-01", + "parameters": { + "tags": {}, + "properties": { + "serviceKind": "Stateless", + "placementConstraints": "NodeType==frontend", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low" + } + ], + "correlationScheme": [ + { + "serviceName": "fabric:/app1/app1~svc1", + "scheme": "Affinity" + } + ], + "servicePlacementPolicies": [], + "defaultMoveCost": "Medium", + "instanceCount": 5, + "servicePackageActivationMode": "SharedProcess", + "serviceDnsName": "my.service.dns" + } + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/2e633105-aadc-4928-9164-d76b974170a3?api-version=2021-06-01" + }, + "body": { + "type": "services", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp/services/myService", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502183671258\"", + "properties": { + "provisioningState": "Updating", + "serviceKind": "Stateless", + "placementConstraints": "NodeType==frontend", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low" + } + ], + "servicePlacementPolicies": [], + "defaultMoveCost": "Medium", + "instanceCount": 5, + "servicePackageActivationMode": "SharedProcess", + "serviceDnsName": "my.service.dns" + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ServicePutOperation_example_min.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ServicePutOperation_example_min.json new file mode 100644 index 000000000000..298f1cf49c88 --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2021-06-01/examples/ServicePutOperation_example_min.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "serviceName": "myService", + "api-version": "2021-06-01", + "parameters": { + "tags": {}, + "properties": { + "serviceKind": "Stateless", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "instanceCount": 1 + } + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/5bc615c3-6c5b-4593-80e1-008f55376ec7?api-version=2021-06-01" + }, + "body": { + "type": "services", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp/services/myService", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502183671256\"", + "properties": { + "provisioningState": "Updating", + "serviceKind": "Stateless", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "instanceCount": 1 + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/readme.md b/specification/servicefabric/resource-manager/readme.md index a48b994abc2a..d7f8e4e4bafc 100644 --- a/specification/servicefabric/resource-manager/readme.md +++ b/specification/servicefabric/resource-manager/readme.md @@ -28,7 +28,7 @@ These are the global settings for the ServiceFabricManagementClient API. title: ServiceFabricManagementClient description: Service Fabric Management Client openapi-type: arm -tag: package-2020-03 +tag: package-2021-06 directive: - suppress: ListInOperationName @@ -57,7 +57,16 @@ directive: reason: There are open issues (bugs) in the validator affecting some of the examples and since there is no way to selectively disable the validation for a particular example or paths, all of the example validation is being turned off. - suppress: Example Validations reason: There are open issues (bugs) in the validator affecting some of the examples and since there is no way to selectively disable the validation for a particular example or paths, all of the example validation is being turned off. +``` + +### Tag: package-2021-06 +These settings apply only when `--tag=package-2021-06` is specified on the command line. + +``` yaml $(tag) == 'package-2021-06' +input-file: +- Microsoft.ServiceFabric/stable/2021-06-01/cluster.json +- Microsoft.ServiceFabric/stable/2021-06-01/application.json ``` ### Tag: package-2020-03 @@ -68,8 +77,6 @@ These settings apply only when `--tag=package-2020-03` is specified on the comma input-file: - Microsoft.ServiceFabric/stable/2020-03-01/cluster.json - Microsoft.ServiceFabric/stable/2020-03-01/application.json -- Microsoft.ServiceFabric/preview/2020-01-01-preview/managedcluster.json -- Microsoft.ServiceFabric/preview/2020-01-01-preview/nodetype.json ``` ### Tag: package-2020-12-preview @@ -182,6 +189,7 @@ This is not used by Autorest itself. swagger-to-sdk: - repo: azure-sdk-for-net - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node @@ -212,6 +220,10 @@ csharp: See configuration in [readme.go.md](./readme.go.md) +## Python + +See configuration in [readme.python.md](./readme.python.md) + ## Java See configuration in [readme.java.md](./readme.java.md) diff --git a/specification/servicefabric/resource-manager/readme.python.md b/specification/servicefabric/resource-manager/readme.python.md index 17ef5ba76ed8..404c6ec0210b 100644 --- a/specification/servicefabric/resource-manager/readme.python.md +++ b/specification/servicefabric/resource-manager/readme.python.md @@ -4,7 +4,7 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) +``` yaml $(python) && !$(track2) python-mode: create python: azure-arm: true @@ -14,13 +14,47 @@ python: package-name: azure-mgmt-servicefabric clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' +``` yaml $(python) && $(track2) +python-mode: create +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +namespace: azure.mgmt.servicefabric +package-name: azure-mgmt-servicefabric +package-version: 1.0.0b1 +clear-output-folder: true +``` + + +``` yaml $(python) && $(python-mode) == 'update' && !$(track2) python: no-namespace-folders: true output-folder: $(python-sdks-folder)/servicefabric/azure-mgmt-servicefabric/azure/mgmt/servicefabric ``` -``` yaml $(python) && $(python-mode) == 'create' +``` yaml $(python) && $(python-mode) == 'create' && !$(track2) python: basic-setup-py: true output-folder: $(python-sdks-folder)/servicefabric/azure-mgmt-servicefabric ``` +``` yaml $(python) && $(python-mode) == 'update' && $(track2) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/servicefabric/azure-mgmt-servicefabric/azure/mgmt/servicefabric +``` +``` yaml $(python) && $(python-mode) == 'create' && $(track2) +basic-setup-py: true +output-folder: $(python-sdks-folder)/servicefabric/azure-mgmt-servicefabric +``` + +``` yaml $(python) && $(track2) +directive: + - from: application.json + where: $.paths["/providers/Microsoft.ServiceFabric/operations"].get + transform: $['operationId'] = 'Application_List' + + - from: managedcluster.json + where: $.paths["/providers/Microsoft.ServiceFabric/operations"].get + transform: $['operationId'] = 'Managedcluster_List' + + - from: nodetype.json + where: $.paths["/providers/Microsoft.ServiceFabric/operations"].get + transform: $['operationId'] = 'Nodetype_List' +``` \ No newline at end of file diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationDeleteOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationDeleteOperation_example.json new file mode 100644 index 000000000000..1380292f8998 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationDeleteOperation_example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2021-07-01-preview" + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/76053752-a423-4a80-b283-1dad1ba5f314?api-version=2021-07-01-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationGetOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationGetOperation_example.json new file mode 100644 index 000000000000..f54a0f73fea2 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationGetOperation_example.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2021-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp", + "name": "myApp", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "applicationHealthPolicy": { + "considerWarningAsError": true, + "maxPercentUnhealthyDeployedApplications": 0, + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0, + "maxPercentUnhealthyPartitionsPerService": 0, + "maxPercentUnhealthyReplicasPerPartition": 0 + }, + "serviceTypeHealthPolicyMap": { + "service1": { + "maxPercentUnhealthyReplicasPerPartition": 30, + "maxPercentUnhealthyPartitionsPerService": 30, + "maxPercentUnhealthyServices": 30 + } + } + }, + "rollingUpgradeMonitoringPolicy": { + "failureAction": "Rollback", + "healthCheckRetryTimeout": "00:10:00", + "healthCheckWaitDuration": "00:02:00", + "healthCheckStableDuration": "00:05:00", + "upgradeDomainTimeout": "00:15:00", + "upgradeTimeout": "01:00:00" + }, + "upgradeReplicaSetCheckTimeout": 3600, + "forceRestart": false, + "instanceCloseDelayDuration": 600, + "upgradeMode": "UnmonitoredAuto", + "recreateApplication": false + } + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationListOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationListOperation_example.json new file mode 100644 index 000000000000..d6e98bf94b7f --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationListOperation_example.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2021-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/managedClusters/applications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp", + "name": "myApp", + "properties": { + "provisioningState": "Updating", + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationPatchOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationPatchOperation_example.json new file mode 100644 index 000000000000..53d9adf575c3 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationPatchOperation_example.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2021-07-01-preview", + "parameters": { + "tags": { + "a": "b" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp", + "name": "myApp", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Succeeded", + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "applicationHealthPolicy": { + "considerWarningAsError": true, + "maxPercentUnhealthyDeployedApplications": 0, + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0, + "maxPercentUnhealthyPartitionsPerService": 0, + "maxPercentUnhealthyReplicasPerPartition": 0 + }, + "serviceTypeHealthPolicyMap": { + "service1": { + "maxPercentUnhealthyReplicasPerPartition": 30, + "maxPercentUnhealthyPartitionsPerService": 30, + "maxPercentUnhealthyServices": 30 + } + } + }, + "rollingUpgradeMonitoringPolicy": { + "failureAction": "Rollback", + "healthCheckRetryTimeout": "00:10:00", + "healthCheckWaitDuration": "00:02:00", + "healthCheckStableDuration": "00:05:00", + "upgradeDomainTimeout": "00:15:00", + "upgradeTimeout": "01:00:00" + }, + "upgradeReplicaSetCheckTimeout": 3600, + "forceRestart": false, + "instanceCloseDelayDuration": 600, + "upgradeMode": "UnmonitoredAuto", + "recreateApplication": false + } + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationPutOperation_example_max.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationPutOperation_example_max.json new file mode 100644 index 000000000000..29faea8cf081 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationPutOperation_example_max.json @@ -0,0 +1,156 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2021-07-01-preview", + "parameters": { + "location": "eastus", + "tags": { + "a": "b" + }, + "properties": { + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "applicationHealthPolicy": { + "considerWarningAsError": true, + "maxPercentUnhealthyDeployedApplications": 0, + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0, + "maxPercentUnhealthyPartitionsPerService": 0, + "maxPercentUnhealthyReplicasPerPartition": 0 + }, + "serviceTypeHealthPolicyMap": { + "myService": { + "maxPercentUnhealthyReplicasPerPartition": 30, + "maxPercentUnhealthyPartitionsPerService": 30, + "maxPercentUnhealthyServices": 30 + } + } + }, + "rollingUpgradeMonitoringPolicy": { + "failureAction": "Rollback", + "healthCheckRetryTimeout": "00:10:00", + "healthCheckWaitDuration": "00:02:00", + "healthCheckStableDuration": "00:05:00", + "upgradeDomainTimeout": "00:15:00", + "upgradeTimeout": "01:00:00" + }, + "upgradeReplicaSetCheckTimeout": 3600, + "forceRestart": false, + "instanceCloseDelayDuration": 600, + "upgradeMode": "UnmonitoredAuto", + "recreateApplication": false + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp", + "name": "myApp", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Creating", + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "applicationHealthPolicy": { + "considerWarningAsError": true, + "maxPercentUnhealthyDeployedApplications": 0, + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0, + "maxPercentUnhealthyPartitionsPerService": 0, + "maxPercentUnhealthyReplicasPerPartition": 0 + }, + "serviceTypeHealthPolicyMap": { + "service1": { + "maxPercentUnhealthyReplicasPerPartition": 30, + "maxPercentUnhealthyPartitionsPerService": 30, + "maxPercentUnhealthyServices": 30 + } + } + }, + "rollingUpgradeMonitoringPolicy": { + "failureAction": "Rollback", + "healthCheckRetryTimeout": "00:10:00", + "healthCheckWaitDuration": "00:02:00", + "healthCheckStableDuration": "00:05:00", + "upgradeDomainTimeout": "00:15:00", + "upgradeTimeout": "01:00:00" + }, + "upgradeReplicaSetCheckTimeout": 3600, + "forceRestart": false, + "instanceCloseDelayDuration": 600, + "upgradeMode": "UnmonitoredAuto", + "recreateApplication": false + } + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/9c2ce367-47ea-43de-b69e-c5a423da4557?api-version=2021-07-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp", + "name": "myApp", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Updating", + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "applicationHealthPolicy": { + "considerWarningAsError": true, + "maxPercentUnhealthyDeployedApplications": 0, + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0, + "maxPercentUnhealthyPartitionsPerService": 0, + "maxPercentUnhealthyReplicasPerPartition": 0 + }, + "serviceTypeHealthPolicyMap": { + "service1": { + "maxPercentUnhealthyReplicasPerPartition": 30, + "maxPercentUnhealthyPartitionsPerService": 30, + "maxPercentUnhealthyServices": 30 + } + } + }, + "rollingUpgradeMonitoringPolicy": { + "failureAction": "Rollback", + "healthCheckRetryTimeout": "00:10:00", + "healthCheckWaitDuration": "00:02:00", + "healthCheckStableDuration": "00:05:00", + "upgradeDomainTimeout": "00:15:00", + "upgradeTimeout": "01:00:00" + }, + "upgradeReplicaSetCheckTimeout": 3600, + "forceRestart": false, + "instanceCloseDelayDuration": 600, + "upgradeMode": "UnmonitoredAuto", + "recreateApplication": false + } + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationPutOperation_example_min.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationPutOperation_example_min.json new file mode 100644 index 000000000000..c8c4a952a6ee --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationPutOperation_example_min.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2021-07-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp", + "name": "myApp", + "properties": { + "provisioningState": "Updating", + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "applicationHealthPolicy": { + "considerWarningAsError": true, + "maxPercentUnhealthyDeployedApplications": 0, + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0, + "maxPercentUnhealthyPartitionsPerService": 0, + "maxPercentUnhealthyReplicasPerPartition": 0 + }, + "serviceTypeHealthPolicyMap": { + "service1": { + "maxPercentUnhealthyReplicasPerPartition": 30, + "maxPercentUnhealthyPartitionsPerService": 30, + "maxPercentUnhealthyServices": 30 + } + } + }, + "rollingUpgradeMonitoringPolicy": { + "failureAction": "Rollback", + "healthCheckRetryTimeout": "00:10:00", + "healthCheckWaitDuration": "00:02:00", + "healthCheckStableDuration": "00:05:00", + "upgradeDomainTimeout": "00:15:00", + "upgradeTimeout": "01:00:00" + }, + "upgradeReplicaSetCheckTimeout": 3600, + "forceRestart": false, + "instanceCloseDelayDuration": 600, + "upgradeMode": "UnmonitoredAuto", + "recreateApplication": false + } + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/5dce62ce-439b-47af-81d8-99ab14708e91?api-version=2021-07-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp", + "name": "myCluster", + "properties": { + "provisioningState": "Updating", + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationTypeNameDeleteOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationTypeNameDeleteOperation_example.json new file mode 100644 index 000000000000..e40adbc04372 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationTypeNameDeleteOperation_example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "api-version": "2021-07-01-preview" + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/6a367b2d-9f60-4941-b886-e348ddcb4127?api-version=2021-07-01-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationTypeNameGetOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationTypeNameGetOperation_example.json new file mode 100644 index 000000000000..91b8b8d7af41 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationTypeNameGetOperation_example.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "api-version": "2021-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType", + "name": "myAppType", + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationTypeNameListOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationTypeNameListOperation_example.json new file mode 100644 index 000000000000..7fe88bec07a6 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationTypeNameListOperation_example.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2021-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType", + "name": "myAppType", + "properties": { + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationTypeNamePatchOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationTypeNamePatchOperation_example.json new file mode 100644 index 000000000000..98ef8a86ecb6 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationTypeNamePatchOperation_example.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "api-version": "2021-07-01-preview", + "parameters": { + "tags": { + "a": "b" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType", + "name": "myAppType", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationTypeNamePutOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationTypeNamePutOperation_example.json new file mode 100644 index 000000000000..d5be4ac30a4e --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationTypeNamePutOperation_example.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "api-version": "2021-07-01-preview", + "parameters": { + "location": "eastus" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType", + "name": "myAppType", + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationTypeVersionDeleteOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationTypeVersionDeleteOperation_example.json new file mode 100644 index 000000000000..587f55a497d5 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationTypeVersionDeleteOperation_example.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "version": "1.0", + "api-version": "2021-07-01-preview" + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/28e62369-ed8c-4aba-8c05-ab7d6238cc3d?api-version=2021-07-01-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationTypeVersionGetOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationTypeVersionGetOperation_example.json new file mode 100644 index 000000000000..98528fbb4813 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationTypeVersionGetOperation_example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "version": "1.0", + "api-version": "2021-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes/versions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "name": "1.0", + "properties": { + "provisioningState": "Updating", + "appPackageUrl": "http://fakelink.test.com/MyAppType" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationTypeVersionListOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationTypeVersionListOperation_example.json new file mode 100644 index 000000000000..8d7a025e095a --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationTypeVersionListOperation_example.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "api-version": "2021-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes/versions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "name": "1.0", + "properties": { + "provisioningState": "Updating", + "appPackageUrl": "http://fakelink.test.com/MyAppType" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationTypeVersionPatchOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationTypeVersionPatchOperation_example.json new file mode 100644 index 000000000000..c7b289adfb43 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationTypeVersionPatchOperation_example.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "version": "1.0", + "api-version": "2021-07-01-preview", + "parameters": { + "tags": { + "a": "b" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes/versions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "name": "1.0", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Succeeded", + "appPackageUrl": "http://fakelink.test.com/MyAppType" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationTypeVersionPutOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationTypeVersionPutOperation_example.json new file mode 100644 index 000000000000..3676e8a013d5 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ApplicationTypeVersionPutOperation_example.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "version": "1.0", + "api-version": "2021-07-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "appPackageUrl": "http://fakelink.test.com/MyAppType" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes/versions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "name": "1.0", + "properties": { + "provisioningState": "Creating", + "appPackageUrl": "http://fakelink.test.com/MyAppType" + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/e2413c7e-d51b-40ac-8155-bc85bf8ae856?api-version=2021-07-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes/versions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "name": "1.0", + "properties": { + "provisioningState": "Updating", + "appPackageUrl": "http://fakelink.test.com/MyAppType" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/DeleteNodes_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/DeleteNodes_example.json new file mode 100644 index 000000000000..cefeb82a1eb7 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/DeleteNodes_example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2021-07-01-preview", + "parameters": { + "nodes": [ + "BE_0", + "BE_3" + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-07-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-07-01-preview" + } + }, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterDeleteOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterDeleteOperation_example.json new file mode 100644 index 000000000000..a024e96be432 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterDeleteOperation_example.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2021-07-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-07-01-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterGetOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterGetOperation_example.json new file mode 100644 index 000000000000..cb072dc050c9 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterGetOperation_example.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2021-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "7.1.168.9494", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave0", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [ + { + "frontendPort": 80, + "backendPort": 80, + "probePort": 80, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 443, + "backendPort": 443, + "probePort": 443, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 10000, + "backendPort": 10000, + "probePort": 10000, + "protocol": "tcp", + "probeProtocol": "tcp" + } + ], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterListByResourceGroupOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterListByResourceGroupOperation_example.json new file mode 100644 index 000000000000..7b05cf4e9727 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterListByResourceGroupOperation_example.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "api-version": "2021-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "7.1.168.9494", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave0", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + }, + { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster2", + "name": "myCluster2", + "tags": {}, + "etag": "W/\"636462502164040075\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "2747e469-b24e-4039-8a0a-46151419523f", + "clusterCodeVersion": "7.1.168.9494", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave0", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster2", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterListBySubscriptionOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterListBySubscriptionOperation_example.json new file mode 100644 index 000000000000..a0fa1470412d --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterListBySubscriptionOperation_example.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "7.1.168.9494", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave0", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + }, + { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster2", + "name": "myCluster2", + "tags": {}, + "etag": "W/\"636462502164040075\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "2747e469-b24e-4039-8a0a-46151419523f", + "clusterCodeVersion": "7.1.168.9494", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave0", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster2", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterPatchOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterPatchOperation_example.json new file mode 100644 index 000000000000..191ba48f3bc6 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterPatchOperation_example.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2021-07-01-preview", + "parameters": { + "tags": { + "a": "b" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": { + "a": "b" + }, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "7.1.168.9494", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave0", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19001, + "httpGatewayConnectionPort": 19081, + "loadBalancingRules": [ + { + "frontendPort": 80, + "backendPort": 80, + "probePort": 80, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 443, + "backendPort": 443, + "probePort": 443, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 10000, + "backendPort": 10000, + "probePort": 10000, + "protocol": "tcp", + "probeProtocol": "http" + } + ], + "allowRdpAccess": true, + "networkSecurityRules": [ + { + "name": "TestName", + "protocol": "tcp", + "access": "allow", + "priority": 1010, + "direction": "inbound", + "sourcePortRanges": [ + "*" + ], + "destinationPortRanges": [ + "*" + ], + "sourceAddressPrefixes": [ + "*" + ], + "destinationAddressPrefixes": [ + "*" + ], + "description": "Test description" + } + ], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "false" + } + ] + } + ], + "addonFeatures": [ + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ], + "enableAutoOSUpgrade": true + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterPutOperation_example_max.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterPutOperation_example_max.json new file mode 100644 index 000000000000..0dea9e2ae348 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterPutOperation_example_max.json @@ -0,0 +1,312 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2021-07-01-preview", + "parameters": { + "location": "eastus", + "tags": {}, + "sku": { + "name": "Basic" + }, + "properties": { + "clusterUpgradeMode": "Manual", + "clusterCodeVersion": "7.1.168.9494", + "dnsName": "myCluster", + "adminUserName": "vmadmin", + "adminPassword": "{vm-password}", + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [ + { + "frontendPort": 80, + "backendPort": 80, + "probePort": 80, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 443, + "backendPort": 443, + "probePort": 443, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 10000, + "backendPort": 10000, + "probePort": 10000, + "protocol": "tcp", + "probeProtocol": "http" + } + ], + "allowRdpAccess": true, + "networkSecurityRules": [ + { + "name": "TestName", + "protocol": "tcp", + "access": "allow", + "priority": 1010, + "direction": "inbound", + "sourcePortRanges": [ + "*" + ], + "destinationPortRanges": [ + "*" + ], + "sourceAddressPrefixes": [ + "*" + ], + "destinationAddressPrefixes": [ + "*" + ], + "description": "Test description" + } + ], + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ], + "addonFeatures": [ + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ], + "enableAutoOSUpgrade": true, + "applicationTypeVersionsCleanupPolicy": { + "maxUnusedVersionsToKeep": 3 + }, + "zonalResiliency": true, + "enableIpv6": true, + "ipTags": [ + { + "ipTagType": "FirstPartyUsage", + "tag": "SQL" + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-07-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-07-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Updating", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterUpgradeMode": "Manual", + "clusterCodeVersion": "7.1.168.9494", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [ + { + "frontendPort": 80, + "backendPort": 80, + "probePort": 80, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 443, + "backendPort": 443, + "probePort": 443, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 10000, + "backendPort": 10000, + "probePort": 10000, + "protocol": "tcp", + "probeProtocol": "tcp" + } + ], + "allowRdpAccess": true, + "networkSecurityRules": [ + { + "name": "TestName", + "protocol": "tcp", + "access": "allow", + "priority": 1010, + "direction": "inbound", + "sourcePortRanges": [ + "*" + ], + "destinationPortRanges": [ + "*" + ], + "sourceAddressPrefixes": [ + "*" + ], + "destinationAddressPrefixes": [ + "*" + ], + "description": "Test description" + } + ], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ], + "addonFeatures": [ + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ], + "enableAutoOSUpgrade": true, + "applicationTypeVersionsCleanupPolicy": { + "maxUnusedVersionsToKeep": 3 + }, + "zonalResiliency": true, + "enableIpv6": true, + "ipTags": [ + { + "ipTagType": "FirstPartyUsage", + "tag": "SQL" + } + ] + } + } + }, + "200": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-07-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-07-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Creating", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterUpgradeMode": "Manual", + "clusterCodeVersion": "7.1.168.9494", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [ + { + "frontendPort": 80, + "backendPort": 80, + "probePort": 80, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 443, + "backendPort": 443, + "probePort": 443, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 10000, + "backendPort": 10000, + "probePort": 10000, + "protocol": "tcp", + "probeProtocol": "tcp" + } + ], + "allowRdpAccess": true, + "networkSecurityRules": [ + { + "name": "TestName", + "protocol": "tcp", + "access": "allow", + "priority": 1010, + "direction": "inbound", + "sourcePortRanges": [ + "*" + ], + "destinationPortRanges": [ + "*" + ], + "sourceAddressPrefixes": [ + "*" + ], + "destinationAddressPrefixes": [ + "*" + ], + "description": "Test description" + } + ], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ], + "addonFeatures": [ + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ], + "enableAutoOSUpgrade": true, + "applicationTypeVersionsCleanupPolicy": { + "maxUnusedVersionsToKeep": 3 + }, + "zonalResiliency": true, + "enableIpv6": true, + "ipTags": [ + { + "ipTagType": "FirstPartyUsage", + "tag": "SQL" + } + ] + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterPutOperation_example_min.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterPutOperation_example_min.json new file mode 100644 index 000000000000..4c3f6906350b --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterPutOperation_example_min.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2021-07-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave1", + "dnsName": "myCluster", + "adminUserName": "vmadmin", + "adminPassword": "{vm-password}", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-07-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-07-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Updating", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave1", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + } + }, + "200": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-07-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-07-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Creating", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave1", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterVersionGetByEnvironment_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterVersionGetByEnvironment_example.json new file mode 100644 index 000000000000..00fddd28e9c7 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterVersionGetByEnvironment_example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "environment": "Windows", + "clusterVersion": "7.2.477.9590", + "api-version": "2021-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/managedClusterVersions/7.2.477.9590", + "name": "7.2.477.9590", + "type": "Microsoft.ServiceFabric/locations/environments/managedClusterVersions", + "properties": { + "supportExpiryUtc": "2021-11-30T00:00:00", + "osType": "Windows", + "clusterCodeVersion": "7.2.477.9590" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterVersionGet_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterVersionGet_example.json new file mode 100644 index 000000000000..d8362b9f444e --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterVersionGet_example.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "clusterVersion": "7.2.477.9590", + "api-version": "2021-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/managedClusterVersions/7.2.477.9590", + "name": "7.2.477.9590", + "type": "Microsoft.ServiceFabric/locations/environments/managedClusterVersions", + "properties": { + "supportExpiryUtc": "2021-11-30T00:00:00", + "osType": "Windows", + "clusterCodeVersion": "7.2.477.9590" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterVersionListByEnvironment.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterVersionListByEnvironment.json new file mode 100644 index 000000000000..ce6f0c101062 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterVersionListByEnvironment.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "environment": "Windows", + "api-version": "2021-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/managedClusterVersions/7.2.457.9590", + "name": "7.2.457.9590", + "type": "Microsoft.ServiceFabric/locations/environments/managedClusterVersions", + "properties": { + "supportExpiryUtc": "2021-11-30T00:00:00", + "osType": "Windows", + "clusterCodeVersion": "7.2.457.9590" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/managedClusterVersions/7.2.477.9590", + "name": "7.2.477.9590", + "type": "Microsoft.ServiceFabric/locations/environments/managedClusterVersions", + "properties": { + "supportExpiryUtc": "2021-11-30T00:00:00", + "osType": "Windows", + "clusterCodeVersion": "7.2.477.9590" + } + } + ] + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterVersionList_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterVersionList_example.json new file mode 100644 index 000000000000..f57971207520 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ManagedClusterVersionList_example.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2021-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/managedClusterVersions/7.2.457.9590", + "name": "7.2.457.9590", + "type": "Microsoft.ServiceFabric/locations/environments/managedClusterVersions", + "properties": { + "supportExpiryUtc": "2021-11-30T00:00:00", + "osType": "Windows", + "clusterCodeVersion": "7.2.457.9590" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/managedClusterVersions/7.2.477.9590", + "name": "7.2.477.9590", + "type": "Microsoft.ServiceFabric/locations/environments/managedClusterVersions", + "properties": { + "supportExpiryUtc": "2021-11-30T00:00:00", + "osType": "Windows", + "clusterCodeVersion": "7.2.477.9590" + } + } + ] + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/NodeTypeDeleteOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/NodeTypeDeleteOperation_example.json new file mode 100644 index 000000000000..479a0834cc87 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/NodeTypeDeleteOperation_example.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2021-07-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-07-01-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/NodeTypeGetOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/NodeTypeGetOperation_example.json new file mode 100644 index 000000000000..0dafc2a19c9c --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/NodeTypeGetOperation_example.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "FE", + "api-version": "2021-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/FE", + "name": "FE", + "tags": {}, + "properties": { + "isPrimary": true, + "dataDiskSizeGB": 100, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D2", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter", + "vmImageVersion": "latest", + "vmInstanceCount": 5, + "isStateless": false, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/NodeTypeListOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/NodeTypeListOperation_example.json new file mode 100644 index 000000000000..80d8e62e6294 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/NodeTypeListOperation_example.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2021-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/FE", + "name": "FE", + "tags": {}, + "sku": { + "name": "Standard_P0", + "tier": "Standard", + "capacity": 5 + }, + "properties": { + "isPrimary": true, + "dataDiskSizeGB": 100, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D2", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter", + "vmImageVersion": "latest", + "vmInstanceCount": 5, + "isStateless": false + } + }, + { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "sku": { + "name": "Standard_S0", + "tier": "Standard", + "capacity": 10 + }, + "properties": { + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "Premium_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": false, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ] + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/NodeTypePatchOperationAutoScale_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/NodeTypePatchOperationAutoScale_example.json new file mode 100644 index 000000000000..149e7697df37 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/NodeTypePatchOperationAutoScale_example.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2021-07-01-preview", + "parameters": { + "tags": { + "a": "b" + }, + "sku": { + "name": "Standard_S0", + "tier": "Standard", + "capacity": 10 + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": { + "a": "b" + }, + "sku": { + "name": "Standard_S0", + "tier": "Standard", + "capacity": 10 + }, + "properties": { + "provisioningState": "Succeeded", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_D3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": false, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ], + "vmManagedIdentity": { + "userAssignedIdentities": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity" + ] + } + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/NodeTypePatchOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/NodeTypePatchOperation_example.json new file mode 100644 index 000000000000..424c83e333ef --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/NodeTypePatchOperation_example.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2021-07-01-preview", + "parameters": { + "tags": { + "a": "b" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Succeeded", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_D3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": false, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ], + "vmManagedIdentity": { + "userAssignedIdentities": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity" + ] + } + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/NodeTypePutOperationAutoScale_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/NodeTypePutOperationAutoScale_example.json new file mode 100644 index 000000000000..5217ab7d3646 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/NodeTypePutOperationAutoScale_example.json @@ -0,0 +1,201 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2021-07-01-preview", + "parameters": { + "properties": { + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "Premium_LRS", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": -1, + "isStateless": true, + "multiplePlacementGroups": true, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ], + "vmManagedIdentity": { + "userAssignedIdentities": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity2" + ] + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-07-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-07-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "sku": { + "name": "Standard_S2", + "tier": "Standard", + "capacity": 10 + }, + "properties": { + "provisioningState": "Updating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "Premium_LRS", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": true, + "multiplePlacementGroups": true, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "forceUpdateTag": "v.1.0", + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ] + } + } + }, + "200": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-07-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-07-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "sku": { + "name": "Standard_S2", + "tier": "Standard", + "capacity": 10 + }, + "properties": { + "provisioningState": "Creating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "Premium_LRS", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": true, + "multiplePlacementGroups": true, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "forceUpdateTag": "v.1.0", + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ], + "vmManagedIdentity": { + "userAssignedIdentities": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity2" + ] + } + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/NodeTypePutOperation_example_max.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/NodeTypePutOperation_example_max.json new file mode 100644 index 000000000000..122e6ae936d3 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/NodeTypePutOperation_example_max.json @@ -0,0 +1,191 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2021-07-01-preview", + "parameters": { + "properties": { + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "Premium_LRS", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": true, + "multiplePlacementGroups": true, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ], + "vmManagedIdentity": { + "userAssignedIdentities": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity2" + ] + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-07-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-07-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "Premium_LRS", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": true, + "multiplePlacementGroups": true, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "forceUpdateTag": "v.1.0", + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ] + } + } + }, + "200": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-07-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-07-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "Premium_LRS", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": true, + "multiplePlacementGroups": true, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "forceUpdateTag": "v.1.0", + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ], + "vmManagedIdentity": { + "userAssignedIdentities": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity2" + ] + } + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/NodeTypePutOperation_example_min.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/NodeTypePutOperation_example_min.json new file mode 100644 index 000000000000..0f2933e595c0 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/NodeTypePutOperation_example_min.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2021-07-01-preview", + "parameters": { + "properties": { + "isPrimary": false, + "dataDiskSizeGB": 200, + "vmSize": "Standard_D3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10 + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-07-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-07-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": false + } + } + }, + "200": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-07-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-07-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": false + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/NodeTypeSkusListOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/NodeTypeSkusListOperation_example.json new file mode 100644 index 000000000000..5bffdb064bdf --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/NodeTypeSkusListOperation_example.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2021-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "resourceType": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "sku": { + "name": "Standard_S0", + "tier": "Standard" + }, + "capacity": { + "minimum": 1, + "maximum": 100, + "default": 1, + "scaleType": "Automatic" + } + }, + { + "resourceType": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "sku": { + "name": "Standard_S1", + "tier": "Standard" + }, + "capacity": { + "minimum": 3, + "maximum": 300, + "default": 3, + "scaleType": "Automatic" + } + }, + { + "resourceType": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "sku": { + "name": "Standard_S2", + "tier": "Standard" + }, + "capacity": { + "minimum": 1, + "maximum": 1000, + "default": 1, + "scaleType": "Automatic" + } + }, + { + "resourceType": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "sku": { + "name": "Standard_S3", + "tier": "Standard" + }, + "capacity": { + "minimum": 3, + "maximum": 1000, + "default": 3, + "scaleType": "Automatic" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/Operations_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/Operations_example.json new file mode 100644 index 000000000000..85f9e3a63317 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/Operations_example.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ServiceFabric/managedClusters/read", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "managedClusters", + "operation": "Read Cluster", + "description": "Read any Cluster" + } + }, + { + "name": "Microsoft.ServiceFabric/managedClusters/write", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "managedClusters", + "operation": "Create or Update Cluster", + "description": "Create or Update any Cluster" + } + }, + { + "name": "Microsoft.ServiceFabric/managedClusters/delete", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "managedClusters", + "operation": "Delete Cluster", + "description": "Delete any Cluster" + } + }, + { + "name": "Microsoft.ServiceFabric/nodeTypes/read", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "nodeTypes", + "operation": "Read Node type", + "description": "Read any Node type" + } + }, + { + "name": "Microsoft.ServiceFabric/nodeTypes/write", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "nodeTypes", + "operation": "Create or Update Node type", + "description": "Create or Update any Node type" + } + }, + { + "name": "Microsoft.ServiceFabric/nodeTypes/delete", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "nodeTypes", + "operation": "Delete Node type", + "description": "Delete any Node type" + } + }, + { + "name": "Microsoft.ServiceFabric/nodeTypes/restart/action", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "nodeTypes", + "operation": "Restart nodes from Node type", + "description": "Restart nodes from Node type" + } + }, + { + "name": "Microsoft.ServiceFabric/nodeTypes/reimage/action", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "nodeTypes", + "operation": "Reimage nodes from Node type", + "description": "Reimage nodes from Node type" + } + }, + { + "name": "Microsoft.ServiceFabric/nodeTypes/deleteNode/action", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "nodeTypes", + "operation": "Delete nodes from Node type", + "description": "Delete nodes from Node type" + } + } + ] + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ReimageNodes_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ReimageNodes_example.json new file mode 100644 index 000000000000..cefeb82a1eb7 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ReimageNodes_example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2021-07-01-preview", + "parameters": { + "nodes": [ + "BE_0", + "BE_3" + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-07-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-07-01-preview" + } + }, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/RestartNodes_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/RestartNodes_example.json new file mode 100644 index 000000000000..cefeb82a1eb7 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/RestartNodes_example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2021-07-01-preview", + "parameters": { + "nodes": [ + "BE_0", + "BE_3" + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-07-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2021-07-01-preview" + } + }, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ServiceDeleteOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ServiceDeleteOperation_example.json new file mode 100644 index 000000000000..aaabe910f099 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ServiceDeleteOperation_example.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "serviceName": "myService", + "api-version": "2021-07-01-preview" + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/41fa5ef9-7f34-4c36-a730-93e0bb757d22?api-version=2021-07-01-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ServiceGetOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ServiceGetOperation_example.json new file mode 100644 index 000000000000..41f3d21a09e5 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ServiceGetOperation_example.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "serviceName": "myService", + "api-version": "2021-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService", + "name": "myService", + "properties": { + "provisioningState": "Updating", + "serviceKind": "Stateless", + "placementConstraints": "NodeType==frontend", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low" + } + ], + "servicePlacementPolicies": [], + "defaultMoveCost": "Medium", + "instanceCount": 5, + "servicePackageActivationMode": "SharedProcess" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ServiceListOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ServiceListOperation_example.json new file mode 100644 index 000000000000..30bfbb641ce9 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ServiceListOperation_example.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2021-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/managedClusters/applications/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService", + "name": "myService", + "properties": { + "provisioningState": "Updating", + "serviceKind": "Stateless", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low" + } + ], + "instanceCount": 1, + "servicePackageActivationMode": "SharedProcess" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ServicePatchOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ServicePatchOperation_example.json new file mode 100644 index 000000000000..ee679ee4443d --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ServicePatchOperation_example.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "serviceName": "myService", + "api-version": "2021-07-01-preview", + "parameters": { + "tags": { + "a": "b" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService", + "name": "myService", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Succeeded", + "serviceKind": "Stateless", + "placementConstraints": "NodeType==frontend", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low", + "defaultLoad": 3 + } + ], + "correlationScheme": [ + { + "serviceName": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService1", + "scheme": "AlignedAffinity" + } + ], + "servicePlacementPolicies": [ + { + "type": "NonPartiallyPlaceService" + } + ], + "scalingPolicies": [ + { + "scalingMechanism": { + "kind": "ScalePartitionInstanceCount", + "maxInstanceCount": 9, + "minInstanceCount": 3, + "scaleIncrement": 2 + }, + "scalingTrigger": { + "kind": "AveragePartitionLoadTrigger", + "lowerLoadThreshold": 2.0, + "metricName": "metricName", + "scaleInterval": "00:01:00", + "upperLoadThreshold": 8.0 + } + } + ], + "defaultMoveCost": "Medium", + "instanceCount": 5, + "minInstanceCount": 3, + "minInstancePercentage": 30, + "servicePackageActivationMode": "SharedProcess" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ServicePutOperation_example_max.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ServicePutOperation_example_max.json new file mode 100644 index 000000000000..d1c049758352 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ServicePutOperation_example_max.json @@ -0,0 +1,189 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "serviceName": "myService", + "api-version": "2021-07-01-preview", + "parameters": { + "location": "eastus", + "tags": { + "a": "b" + }, + "properties": { + "serviceKind": "Stateless", + "placementConstraints": "NodeType==frontend", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low", + "defaultLoad": 3 + } + ], + "correlationScheme": [ + { + "serviceName": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService1", + "scheme": "AlignedAffinity" + } + ], + "servicePlacementPolicies": [ + { + "type": "NonPartiallyPlaceService" + } + ], + "scalingPolicies": [ + { + "scalingMechanism": { + "kind": "ScalePartitionInstanceCount", + "maxInstanceCount": 9, + "minInstanceCount": 3, + "scaleIncrement": 2 + }, + "scalingTrigger": { + "kind": "AveragePartitionLoadTrigger", + "lowerLoadThreshold": 2.0, + "metricName": "metricName", + "scaleInterval": "00:01:00", + "upperLoadThreshold": 8.0 + } + } + ], + "defaultMoveCost": "Medium", + "instanceCount": 5, + "minInstanceCount": 3, + "minInstancePercentage": 30, + "servicePackageActivationMode": "SharedProcess" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService", + "name": "myService", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Creating", + "serviceKind": "Stateless", + "placementConstraints": "NodeType==frontend", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low", + "defaultLoad": 3 + } + ], + "correlationScheme": [ + { + "serviceName": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService1", + "scheme": "AlignedAffinity" + } + ], + "servicePlacementPolicies": [ + { + "type": "NonPartiallyPlaceService" + } + ], + "scalingPolicies": [ + { + "scalingMechanism": { + "kind": "ScalePartitionInstanceCount", + "maxInstanceCount": 9, + "minInstanceCount": 3, + "scaleIncrement": 2 + }, + "scalingTrigger": { + "kind": "AveragePartitionLoadTrigger", + "lowerLoadThreshold": 2.0, + "metricName": "metricName", + "scaleInterval": "00:01:00", + "upperLoadThreshold": 8.0 + } + } + ], + "defaultMoveCost": "Medium", + "instanceCount": 5, + "minInstanceCount": 3, + "minInstancePercentage": 30, + "servicePackageActivationMode": "SharedProcess" + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/2e633105-aadc-4928-9164-d76b974170a3?api-version=2021-07-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService", + "name": "myService", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Updating", + "serviceKind": "Stateless", + "placementConstraints": "NodeType==frontend", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low", + "defaultLoad": 3 + } + ], + "correlationScheme": [ + { + "serviceName": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService1", + "scheme": "AlignedAffinity" + } + ], + "servicePlacementPolicies": [ + { + "type": "NonPartiallyPlaceService" + } + ], + "scalingPolicies": [ + { + "scalingMechanism": { + "kind": "ScalePartitionInstanceCount", + "maxInstanceCount": 9, + "minInstanceCount": 3, + "scaleIncrement": 2 + }, + "scalingTrigger": { + "kind": "AveragePartitionLoadTrigger", + "lowerLoadThreshold": 2.0, + "metricName": "metricName", + "scaleInterval": "00:01:00", + "upperLoadThreshold": 8.0 + } + } + ], + "defaultMoveCost": "Medium", + "instanceCount": 5, + "minInstanceCount": 3, + "minInstancePercentage": 30, + "servicePackageActivationMode": "SharedProcess" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ServicePutOperation_example_min.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ServicePutOperation_example_min.json new file mode 100644 index 000000000000..3807e7266f05 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/examples/ServicePutOperation_example_min.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "serviceName": "myService", + "api-version": "2021-07-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "serviceKind": "Stateless", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "instanceCount": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService", + "name": "myService", + "properties": { + "provisioningState": "Creating", + "serviceKind": "Stateless", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "instanceCount": 1 + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/5bc615c3-6c5b-4593-80e1-008f55376ec7?api-version=2021-07-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService", + "name": "myService", + "properties": { + "provisioningState": "Updating", + "serviceKind": "Stateless", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "instanceCount": 1 + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/managedapplication.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/managedapplication.json new file mode 100644 index 000000000000..f2164c227e13 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/managedapplication.json @@ -0,0 +1,2729 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceFabricManagementClient", + "description": "Azure Service Fabric Resource Provider API Client", + "version": "2021-07-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}": { + "get": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationTypes_Get", + "summary": "Gets a Service Fabric managed application type name resource.", + "description": "Get a Service Fabric application type name resource created or in the process of being created in the Service Fabric managed cluster resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get an application type": { + "$ref": "./examples/ApplicationTypeNameGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationTypes_CreateOrUpdate", + "summary": "Creates or updates a Service Fabric managed application type name resource.", + "description": "Create or update a Service Fabric managed application type name resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application type name resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationTypeResource" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put an application type": { + "$ref": "./examples/ApplicationTypeNamePutOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationTypes_Update", + "summary": "Updates the tags of an application type resource of a given managed cluster.", + "description": "Updates the tags of an application type resource of a given managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application type resource updated tags.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationTypeUpdateParameters" + } + } + ], + "x-ms-examples": { + "Patch an application type": { + "$ref": "./examples/ApplicationTypeNamePatchOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationTypes_Delete", + "summary": "Deletes a Service Fabric managed application type name resource.", + "description": "Delete a Service Fabric managed application type name resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete an application type": { + "$ref": "./examples/ApplicationTypeNameDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes": { + "get": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationTypes_List", + "summary": "Gets the list of application type name resources created in the specified Service Fabric managed cluster resource.", + "description": "Gets all application type name resources created or in the process of being created in the Service Fabric managed cluster resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a list of application type name resources": { + "$ref": "./examples/ApplicationTypeNameListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeResourceList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}/versions/{version}": { + "get": { + "tags": [ + "ApplicationTypeVersion" + ], + "operationId": "ApplicationTypeVersions_Get", + "summary": "Gets a Service Fabric managed application type version resource.", + "description": "Get a Service Fabric managed application type version resource created or in the process of being created in the Service Fabric managed application type name resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/version" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get an application type version": { + "$ref": "./examples/ApplicationTypeVersionGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "ApplicationTypeVersion" + ], + "operationId": "ApplicationTypeVersions_CreateOrUpdate", + "summary": "Creates or updates a Service Fabric managed application type version resource.", + "description": "Create or update a Service Fabric managed application type version resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/version" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application type version resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put an application type version": { + "$ref": "./examples/ApplicationTypeVersionPutOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + } + }, + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "ApplicationTypeVersion" + ], + "operationId": "ApplicationTypeVersions_Update", + "summary": "Updates the tags of an application type version resource of a given managed cluster.", + "description": "Updates the tags of an application type version resource of a given managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/version" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application type version resource updated tags.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionUpdateParameters" + } + } + ], + "x-ms-examples": { + "Patch an application type version": { + "$ref": "./examples/ApplicationTypeVersionPatchOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "ApplicationTypeVersion" + ], + "operationId": "ApplicationTypeVersions_Delete", + "summary": "Deletes a Service Fabric managed application type version resource.", + "description": "Delete a Service Fabric managed application type version resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/version" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete an application type version": { + "$ref": "./examples/ApplicationTypeVersionDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}/versions": { + "get": { + "tags": [ + "ApplicationTypeVersion" + ], + "operationId": "ApplicationTypeVersions_ListByApplicationTypes", + "summary": "Gets the list of application type version resources created in the specified Service Fabric managed application type name resource.", + "description": "Gets all application type version resources created or in the process of being created in the Service Fabric managed application type name resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a list of application type version resources": { + "$ref": "./examples/ApplicationTypeVersionListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResourceList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}": { + "get": { + "tags": [ + "Application" + ], + "operationId": "Applications_Get", + "summary": "Gets a Service Fabric managed application resource.", + "description": "Get a Service Fabric managed application resource created or in the process of being created in the Service Fabric cluster resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get an application": { + "$ref": "./examples/ApplicationGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "Application" + ], + "operationId": "Applications_CreateOrUpdate", + "summary": "Creates or updates a Service Fabric managed application resource.", + "description": "Create or update a Service Fabric managed application resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationResource" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put an application with minimum parameters": { + "$ref": "./examples/ApplicationPutOperation_example_min.json" + }, + "Put an application with maximum parameters": { + "$ref": "./examples/ApplicationPutOperation_example_max.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationResource" + } + }, + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ApplicationResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "Application" + ], + "operationId": "Applications_Update", + "summary": "Updates the tags of an application resource of a given managed cluster.", + "description": "Updates the tags of an application resource of a given managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application resource updated tags.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationUpdateParameters" + } + } + ], + "x-ms-examples": { + "Patch an application": { + "$ref": "./examples/ApplicationPatchOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "Application" + ], + "operationId": "Applications_Delete", + "summary": "Deletes a Service Fabric managed application resource.", + "description": "Delete a Service Fabric managed application resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete an application": { + "$ref": "./examples/ApplicationDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications": { + "get": { + "tags": [ + "Application" + ], + "operationId": "Applications_List", + "summary": "Gets the list of managed application resources created in the specified Service Fabric cluster resource.", + "description": "Gets all managed application resources created or in the process of being created in the Service Fabric cluster resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a list of application resources": { + "$ref": "./examples/ApplicationListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationResourceList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}/services/{serviceName}": { + "get": { + "tags": [ + "Service" + ], + "operationId": "Services_Get", + "summary": "Gets a Service Fabric managed service resource.", + "description": "Get a Service Fabric service resource created or in the process of being created in the Service Fabric managed application resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get a service": { + "$ref": "./examples/ServiceGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "Service" + ], + "operationId": "Services_CreateOrUpdate", + "summary": "Creates or updates a Service Fabric managed service resource.", + "description": "Create or update a Service Fabric managed service resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The service resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceResource" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put a service with minimum parameters": { + "$ref": "./examples/ServicePutOperation_example_min.json" + }, + "Put a service with maximum parameters": { + "$ref": "./examples/ServicePutOperation_example_max.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "Services" + ], + "operationId": "Services_Update", + "summary": "Updates the tags of a service resource of a given managed cluster.", + "description": "Updates the tags of a service resource of a given managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The service resource updated tags.", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceUpdateParameters" + } + } + ], + "x-ms-examples": { + "Patch a service": { + "$ref": "./examples/ServicePatchOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "Service" + ], + "operationId": "Services_Delete", + "summary": "Deletes a Service Fabric managed service resource.", + "description": "Delete a Service Fabric managed service resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete a service": { + "$ref": "./examples/ServiceDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}/services": { + "get": { + "tags": [ + "Service" + ], + "operationId": "Services_ListByApplications", + "summary": "Gets the list of service resources created in the specified Service Fabric managed application resource.", + "description": "Gets all service resources created or in the process of being created in the Service Fabric managed application resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get a list of service resources": { + "$ref": "./examples/ServiceListOperation_example.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServiceResourceList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + } + }, + "definitions": { + "AddRemoveIncrementalNamedPartitionScalingMechanism": { + "type": "object", + "description": "Represents a scaling mechanism for adding or removing named partitions of a stateless service. Partition names are in the format '0','1'...'N-1'.", + "allOf": [ + { + "$ref": "#/definitions/ScalingMechanism" + }, + { + "type": "object", + "description": "AddRemoveIncrementalNamedPartitionScalingMechanism" + } + ], + "x-ms-discriminator-value": "AddRemoveIncrementalNamedPartition", + "required": [ + "minPartitionCount", + "maxPartitionCount", + "scaleIncrement" + ], + "properties": { + "minPartitionCount": { + "type": "integer", + "format": "int32", + "description": "Minimum number of named partitions of the service." + }, + "maxPartitionCount": { + "type": "integer", + "format": "int32", + "description": "Maximum number of named partitions of the service." + }, + "scaleIncrement": { + "type": "integer", + "format": "int32", + "description": "The number of instances to add or remove during a scaling operation." + } + } + }, + "ApplicationHealthPolicy": { + "type": "object", + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.\n", + "required": [ + "considerWarningAsError", + "maxPercentUnhealthyDeployedApplications" + ], + "properties": { + "considerWarningAsError": { + "type": "boolean", + "description": "Indicates whether warnings are treated with the same severity as errors." + }, + "maxPercentUnhealthyDeployedApplications": { + "type": "integer", + "format": "int32", + "description": "The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100.\nThe percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error.\nThis is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.\n" + }, + "defaultServiceTypeHealthPolicy": { + "$ref": "#/definitions/ServiceTypeHealthPolicy", + "description": "The health policy used by default to evaluate the health of a service type." + }, + "serviceTypeHealthPolicyMap": { + "$ref": "#/definitions/ServiceTypeHealthPolicyMap", + "description": "The map with service type health policy per service type name. The map is empty by default." + } + } + }, + "ApplicationParameterList": { + "type": "object", + "description": "List of application parameters with overridden values from their default values specified in the application manifest.", + "additionalProperties": { + "type": "string" + } + }, + "ApplicationResource": { + "type": "object", + "description": "The application resource.", + "properties": { + "identity": { + "$ref": "#/definitions/ManagedIdentity" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationResourceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ApplicationResourceList": { + "type": "object", + "description": "The list of application resources.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationResource" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of application list results if there are any.", + "readOnly": true + } + } + }, + "ApplicationResourceProperties": { + "type": "object", + "description": "The application resource properties.", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response" + }, + "version": { + "$ref": "#/definitions/ApplicationTypeVersion" + }, + "parameters": { + "$ref": "#/definitions/ApplicationParameterList" + }, + "upgradePolicy": { + "$ref": "#/definitions/ApplicationUpgradePolicy" + }, + "managedIdentities": { + "description": "List of user assigned identities for the application, each mapped to a friendly name.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationUserAssignedIdentity" + } + } + } + }, + "ApplicationTypeResource": { + "type": "object", + "description": "The application type name resource", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationTypeResourceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ApplicationTypeResourceList": { + "type": "object", + "description": "The list of application type names.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationTypeResource" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of application type list results if there are any.", + "readOnly": true + } + } + }, + "ApplicationTypeResourceProperties": { + "type": "object", + "description": "The application type name properties", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response." + } + } + }, + "ApplicationTypeUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "description": "Application type update parameters", + "additionalProperties": { + "type": "string" + } + } + }, + "description": "Application type update request" + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "The version of the application type as defined in the application manifest.\nThis name must be the full Arm Resource ID for the referenced application type version.\n" + }, + "ApplicationTypeVersionResource": { + "type": "object", + "description": "An application type version resource for the specified application type name resource.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationTypeVersionResourceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ApplicationTypeVersionResourceList": { + "type": "object", + "description": "The list of application type version resources for the specified application type name resource.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of application type version list results if there are any.", + "readOnly": true + } + } + }, + "ApplicationTypeVersionResourceProperties": { + "type": "object", + "description": "The properties of the application type version resource.", + "required": [ + "appPackageUrl" + ], + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response" + }, + "appPackageUrl": { + "type": "string", + "description": "The URL to the application package" + } + } + }, + "ApplicationTypeVersionUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "description": "Application type version update parameters", + "additionalProperties": { + "type": "string" + } + } + }, + "description": "Application type version update request" + }, + "ApplicationUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "description": "Application update parameters", + "additionalProperties": { + "type": "string" + } + } + }, + "description": "Application update request" + }, + "ApplicationUpgradePolicy": { + "type": "object", + "description": "Describes the policy for a monitored application upgrade.", + "properties": { + "applicationHealthPolicy": { + "$ref": "#/definitions/ApplicationHealthPolicy" + }, + "forceRestart": { + "$ref": "#/definitions/ForceRestart" + }, + "rollingUpgradeMonitoringPolicy": { + "$ref": "#/definitions/RollingUpgradeMonitoringPolicy" + }, + "instanceCloseDelayDuration": { + "type": "integer", + "format": "int64", + "description": "Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description." + }, + "upgradeMode": { + "$ref": "#/definitions/RollingUpgradeMode" + }, + "upgradeReplicaSetCheckTimeout": { + "type": "integer", + "format": "int64", + "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." + }, + "recreateApplication": { + "type": "boolean", + "description": "Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed." + } + } + }, + "ApplicationUserAssignedIdentity": { + "type": "object", + "required": [ + "name", + "principalId" + ], + "properties": { + "name": { + "type": "string", + "description": "The friendly name of user assigned identity." + }, + "principalId": { + "type": "string", + "description": "The principal id of user assigned identity." + } + } + }, + "AveragePartitionLoadScalingTrigger": { + "type": "object", + "description": "Represents a scaling trigger related to an average load of a metric/resource of a partition.", + "allOf": [ + { + "$ref": "#/definitions/ScalingTrigger" + }, + { + "type": "object", + "description": "AveragePartitionLoadScalingTrigger" + } + ], + "x-ms-discriminator-value": "AveragePartitionLoadTrigger", + "required": [ + "metricName", + "lowerLoadThreshold", + "upperLoadThreshold", + "scaleInterval" + ], + "properties": { + "metricName": { + "type": "string", + "description": "The name of the metric for which usage should be tracked." + }, + "lowerLoadThreshold": { + "type": "number", + "format": "double", + "description": "The lower limit of the load below which a scale in operation should be performed." + }, + "upperLoadThreshold": { + "type": "number", + "format": "double", + "description": "The upper limit of the load beyond which a scale out operation should be performed." + }, + "scaleInterval": { + "type": "string", + "description": "The period in seconds on which a decision is made whether to scale or not. This property should come in ISO 8601 format \"hh:mm:ss\"." + } + } + }, + "AverageServiceLoadScalingTrigger": { + "type": "object", + "description": "Represents a scaling policy related to an average load of a metric/resource of a service.", + "allOf": [ + { + "$ref": "#/definitions/ScalingTrigger" + }, + { + "type": "object", + "description": "AverageServiceLoadScalingTrigger" + } + ], + "x-ms-discriminator-value": "AverageServiceLoadTrigger", + "required": [ + "metricName", + "lowerLoadThreshold", + "upperLoadThreshold", + "scaleInterval", + "useOnlyPrimaryLoad" + ], + "properties": { + "metricName": { + "type": "string", + "description": "The name of the metric for which usage should be tracked." + }, + "lowerLoadThreshold": { + "type": "number", + "format": "double", + "description": "The lower limit of the load below which a scale in operation should be performed." + }, + "upperLoadThreshold": { + "type": "number", + "format": "double", + "description": "The upper limit of the load beyond which a scale out operation should be performed." + }, + "scaleInterval": { + "type": "string", + "description": "The period in seconds on which a decision is made whether to scale or not. This property should come in ISO 8601 format \"hh:mm:ss\"." + }, + "useOnlyPrimaryLoad": { + "type": "boolean", + "description": "Flag determines whether only the load of primary replica should be considered for scaling. If set to true, then trigger will only consider the load of primary replicas of stateful service. If set to false, trigger will consider load of all replicas. This parameter cannot be set to true for stateless service." + } + } + }, + "CorrelationSchemeList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceCorrelation" + }, + "description": "A list that describes the correlation of the service with other services." + }, + "ForceRestart": { + "type": "boolean", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).", + "default": false + }, + "HealthCheckRetryTimeout": { + "type": "string", + "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is interpreted as a string representing an ISO 8601 duration with following format \"hh:mm:ss.fff\"." + }, + "HealthCheckStableDuration": { + "type": "string", + "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is interpreted as a string representing an ISO 8601 duration with following format \"hh:mm:ss.fff\"." + }, + "HealthCheckWaitDuration": { + "type": "string", + "description": "The amount of time to wait after completing an upgrade domain before applying health policies. It is interpreted as a string representing an ISO 8601 duration with following format \"hh:mm:ss.fff\"." + }, + "ManagedIdentity": { + "type": "object", + "description": "Describes the managed identities for an Azure resource.", + "properties": { + "principalId": { + "type": "string", + "readOnly": true, + "description": "The principal id of the managed identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "type": "string", + "readOnly": true, + "description": "The tenant id of the managed identity. This property will only be provided for a system assigned identity." + }, + "type": { + "$ref": "#/definitions/ManagedIdentityType" + }, + "userAssignedIdentities": { + "$ref": "#/definitions/UserAssignedIdentityMap" + } + } + }, + "ManagedIdentityType": { + "type": "string", + "description": "The type of managed identity for the resource.", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned" + ], + "x-ms-enum": { + "name": "ManagedIdentityType", + "modelAsString": false, + "values": [ + { + "value": "None", + "description": "Indicates that no identity is associated with the resource." + }, + { + "value": "SystemAssigned", + "description": "Indicates that system assigned identity is associated with the resource." + }, + { + "value": "UserAssigned", + "description": "Indicates that user assigned identity is associated with the resource." + }, + { + "value": "SystemAssigned, UserAssigned", + "description": "Indicates that both system assigned and user assigned identity are associated with the resource." + } + ] + } + }, + "MoveCost": { + "type": "string", + "description": "Specifies the move cost for the service.", + "enum": [ + "Zero", + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "MoveCost", + "modelAsString": true, + "values": [ + { + "value": "Zero", + "description": "Zero move cost. This value is zero." + }, + { + "value": "Low", + "description": "Specifies the move cost of the service as Low. The value is 1." + }, + { + "value": "Medium", + "description": "Specifies the move cost of the service as Medium. The value is 2." + }, + { + "value": "High", + "description": "Specifies the move cost of the service as High. The value is 3." + } + ] + } + }, + "NamedPartitionScheme": { + "type": "object", + "description": "Describes the named partition scheme of the service.", + "allOf": [ + { + "$ref": "#/definitions/Partition" + }, + { + "type": "object", + "description": "NamedPartitionScheme" + } + ], + "x-ms-discriminator-value": "Named", + "required": [ + "names" + ], + "properties": { + "names": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array for the names of the partitions." + } + } + }, + "Partition": { + "type": "object", + "discriminator": "partitionScheme", + "description": "Describes how the service is partitioned.", + "required": [ + "partitionScheme" + ], + "properties": { + "partitionScheme": { + "$ref": "#/definitions/PartitionScheme", + "description": "Specifies how the service is partitioned." + } + } + }, + "PartitionInstanceCountScaleMechanism": { + "type": "object", + "description": "Represents a scaling mechanism for adding or removing instances of stateless service partition.", + "allOf": [ + { + "$ref": "#/definitions/ScalingMechanism" + }, + { + "type": "object", + "description": "PartitionInstanceCountScaleMechanism" + } + ], + "x-ms-discriminator-value": "ScalePartitionInstanceCount", + "required": [ + "minInstanceCount", + "maxInstanceCount", + "scaleIncrement" + ], + "properties": { + "minInstanceCount": { + "type": "integer", + "format": "int32", + "description": "Minimum number of instances of the partition." + }, + "maxInstanceCount": { + "type": "integer", + "format": "int32", + "description": "Maximum number of instances of the partition." + }, + "scaleIncrement": { + "type": "integer", + "format": "int32", + "description": "The number of instances to add or remove during a scaling operation." + } + } + }, + "PartitionScheme": { + "type": "string", + "description": "Enumerates the ways that a service can be partitioned.", + "enum": [ + "Singleton", + "UniformInt64Range", + "Named" + ], + "x-ms-enum": { + "name": "PartitionScheme", + "modelAsString": true, + "values": [ + { + "value": "Singleton", + "description": "Indicates that the partition is based on string names, and is a SingletonPartitionScheme object, The value is 0." + }, + { + "value": "UniformInt64Range", + "description": "Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionScheme object. The value is 1." + }, + { + "value": "Named", + "description": "Indicates that the partition is based on string names, and is a NamedPartitionScheme object. The value is 2." + } + ] + } + }, + "ProxyResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Azure resource identifier.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Azure resource name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Azure resource type.", + "readOnly": true + }, + "location": { + "type": "string", + "description": "Resource location depends on the parent resource.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Azure resource tags.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "systemData": { + "$ref": "#/definitions/SystemData" + } + }, + "description": "The resource model definition for proxy-only resource.", + "x-ms-azure-resource": true + }, + "RollingUpgradeMode": { + "type": "string", + "description": "The mode used to monitor health during a rolling upgrade. The values are Monitored, and UnmonitoredAuto.", + "enum": [ + "Monitored", + "UnmonitoredAuto" + ], + "x-ms-enum": { + "name": "RollingUpgradeMode", + "modelAsString": true, + "values": [ + { + "value": "Monitored", + "description": "The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 0." + }, + { + "value": "UnmonitoredAuto", + "description": "The upgrade will proceed automatically without performing any health monitoring. The value is 1." + } + ] + } + }, + "RollingUpgradeMonitoringPolicy": { + "type": "object", + "description": "The policy used for monitoring the application upgrade", + "required": [ + "failureAction", + "healthCheckWaitDuration", + "healthCheckStableDuration", + "healthCheckRetryTimeout", + "upgradeTimeout", + "upgradeDomainTimeout" + ], + "properties": { + "failureAction": { + "type": "string", + "description": "The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode.", + "enum": [ + "Rollback", + "Manual" + ], + "x-ms-enum": { + "name": "FailureAction", + "modelAsString": true, + "values": [ + { + "value": "Rollback", + "description": "Indicates that a rollback of the upgrade will be performed by Service Fabric if the upgrade fails." + }, + { + "value": "Manual", + "description": "Indicates that a manual repair will need to be performed by the administrator if the upgrade fails. Service Fabric will not proceed to the next upgrade domain automatically." + } + ] + } + }, + "healthCheckWaitDuration": { + "$ref": "#/definitions/HealthCheckWaitDuration" + }, + "healthCheckStableDuration": { + "$ref": "#/definitions/HealthCheckStableDuration" + }, + "healthCheckRetryTimeout": { + "$ref": "#/definitions/HealthCheckRetryTimeout" + }, + "upgradeTimeout": { + "$ref": "#/definitions/UpgradeTimeout" + }, + "upgradeDomainTimeout": { + "$ref": "#/definitions/UpgradeDomainTimeout" + } + } + }, + "ScalingMechanism": { + "type": "object", + "discriminator": "kind", + "description": "Describes the mechanism for performing a scaling operation.", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/ServiceScalingMechanismKind", + "description": "Specifies the mechanism associated with this scaling policy." + } + } + }, + "ScalingPolicy": { + "type": "object", + "description": "Specifies a metric to load balance a service during runtime.", + "required": [ + "scalingMechanism", + "scalingTrigger" + ], + "properties": { + "scalingMechanism": { + "$ref": "#/definitions/ScalingMechanism", + "description": "Specifies the mechanism associated with this scaling policy" + }, + "scalingTrigger": { + "$ref": "#/definitions/ScalingTrigger", + "description": "Specifies the trigger associated with this scaling policy." + } + } + }, + "ScalingPolicyList": { + "type": "array", + "items": { + "$ref": "#/definitions/ScalingPolicy" + }, + "description": "Scaling policies for this service." + }, + "ScalingTrigger": { + "type": "object", + "discriminator": "kind", + "description": "Describes the trigger for performing a scaling operation.", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/ServiceScalingTriggerKind", + "description": "Specifies the trigger associated with this scaling policy." + } + } + }, + "ServiceCorrelation": { + "type": "object", + "description": "Creates a particular correlation between services.", + "required": [ + "scheme", + "serviceName" + ], + "properties": { + "scheme": { + "$ref": "#/definitions/ServiceCorrelationScheme", + "description": "The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName." + }, + "serviceName": { + "$ref": "#/definitions/ServiceName", + "description": "The Arm Resource ID of the service that the correlation relationship is established with." + } + } + }, + "ServiceCorrelationScheme": { + "type": "string", + "description": "The service correlation scheme.", + "enum": [ + "AlignedAffinity", + "NonAlignedAffinity" + ], + "x-ms-enum": { + "name": "ServiceCorrelationScheme", + "modelAsString": true, + "values": [ + { + "value": "AlignedAffinity", + "description": "Aligned affinity ensures that the primaries of the partitions of the affinitized services are collocated on the same nodes. This is the default and is the same as selecting the Affinity scheme. The value is 0." + }, + { + "value": "NonAlignedAffinity", + "description": "Non-Aligned affinity guarantees that all replicas of each service will be placed on the same nodes. Unlike Aligned Affinity, this does not guarantee that replicas of particular role will be collocated. The value is 1." + } + ] + } + }, + "ServiceKind": { + "type": "string", + "description": "The kind of service (Stateless or Stateful).", + "enum": [ + "Stateless", + "Stateful" + ], + "x-ms-enum": { + "name": "ServiceKind", + "modelAsString": true, + "values": [ + { + "value": "Stateless", + "description": "Does not use Service Fabric to make its state highly available or reliable. The value is 0." + }, + { + "value": "Stateful", + "description": "Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 1." + } + ] + } + }, + "ServiceLoadMetric": { + "type": "object", + "description": "Specifies a metric to load balance a service during runtime.", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case sensitive." + }, + "weight": { + "$ref": "#/definitions/ServiceLoadMetricWeight", + "description": "The service load metric relative weight, compared to other metrics configured for this service, as a number." + }, + "primaryDefaultLoad": { + "type": "integer", + "format": "int32", + "description": "Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica." + }, + "secondaryDefaultLoad": { + "type": "integer", + "format": "int32", + "description": "Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica." + }, + "defaultLoad": { + "type": "integer", + "format": "int32", + "description": "Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric." + } + } + }, + "ServiceLoadMetricsList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceLoadMetric" + }, + "description": "The service load metrics is given as an array of ServiceLoadMetric objects." + }, + "ServiceLoadMetricWeight": { + "type": "string", + "description": "Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight.", + "enum": [ + "Zero", + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "ServiceLoadMetricWeight", + "modelAsString": true, + "values": [ + { + "value": "Zero", + "description": "Disables resource balancing for this metric. This value is zero." + }, + { + "value": "Low", + "description": "Specifies the metric weight of the service load as Low. The value is 1." + }, + { + "value": "Medium", + "description": "Specifies the metric weight of the service load as Medium. The value is 2." + }, + { + "value": "High", + "description": "Specifies the metric weight of the service load as High. The value is 3." + } + ] + } + }, + "ServiceName": { + "type": "string", + "description": "The full ARM Resource ID describing the service resource", + "x-sf-clientlib": { + "typeName": "ServiceName" + } + }, + "ServicePlacementInvalidDomainPolicy": { + "type": "object", + "description": "Describes the policy to be used for placement of a Service Fabric service where a particular fault or upgrade domain should not be used for placement of the instances or replicas of that service.", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicy" + }, + { + "type": "object", + "description": "ServicePlacementInvalidDomainPolicy" + } + ], + "x-ms-discriminator-value": "InvalidDomain", + "required": [ + "domainName" + ], + "properties": { + "domainName": { + "type": "string", + "description": "The name of the domain that should not be used for placement." + } + } + }, + "ServicePlacementNonPartiallyPlaceServicePolicy": { + "type": "object", + "description": "The name of the domain that should used for placement as per this policy.", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicy" + }, + { + "type": "object", + "description": "ServicePlacementNonPartiallyPlaceServicePolicy" + } + ], + "x-ms-discriminator-value": "NonPartiallyPlaceService" + }, + "ServicePlacementPoliciesList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServicePlacementPolicy" + }, + "description": "A list that describes the correlation of the service with other services." + }, + "ServicePlacementPolicy": { + "type": "object", + "discriminator": "type", + "description": "Describes the policy to be used for placement of a Service Fabric service.", + "required": [ + "type" + ], + "properties": { + "type": { + "$ref": "#/definitions/ServicePlacementPolicyType" + } + } + }, + "ServicePlacementPolicyType": { + "type": "string", + "description": "The type of placement policy for a service fabric service. Following are the possible values.", + "enum": [ + "InvalidDomain", + "RequiredDomain", + "PreferredPrimaryDomain", + "RequiredDomainDistribution", + "NonPartiallyPlaceService" + ], + "x-ms-enum": { + "name": "ServicePlacementPolicyType", + "modelAsString": true, + "values": [ + { + "value": "InvalidDomain", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementInvalidDomainPolicyDescription, which indicates that a particular fault or upgrade domain cannot be used for placement of this service. The value is 0." + }, + { + "value": "RequiredDomain", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription indicating that the replicas of the service must be placed in a specific domain. The value is 1." + }, + { + "value": "PreferredPrimaryDomain", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementPreferPrimaryDomainPolicyDescription, which indicates that if possible the Primary replica for the partitions of the service should be located in a particular domain as an optimization. The value is 2." + }, + { + "value": "RequiredDomainDistribution", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription, indicating that the system will disallow placement of any two replicas from the same partition in the same domain at any time. The value is 3." + }, + { + "value": "NonPartiallyPlaceService", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementNonPartiallyPlaceServicePolicyDescription, which indicates that if possible all replicas of a particular partition of the service should be placed atomically. The value is 4." + } + ] + } + }, + "ServicePlacementPreferPrimaryDomainPolicy": { + "type": "object", + "description": "Describes the policy to be used for placement of a Service Fabric service where the service's \nPrimary replicas should optimally be placed in a particular domain.\n\nThis placement policy is usually used with fault domains in scenarios where the Service Fabric\ncluster is geographically distributed in order to indicate that a service's primary replica should\nbe located in a particular fault domain, which in geo-distributed scenarios usually aligns with regional\nor datacenter boundaries. Note that since this is an optimization it is possible that the Primary replica\nmay not end up located in this domain due to failures, capacity limits, or other constraints.\n", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicy" + }, + { + "type": "object", + "description": "ServicePlacementPreferPrimaryDomainPolicy" + } + ], + "x-ms-discriminator-value": "PreferredPrimaryDomain", + "required": [ + "domainName" + ], + "properties": { + "domainName": { + "type": "string", + "description": "The name of the domain that should used for placement as per this policy." + } + } + }, + "ServicePlacementRequiredDomainPolicy": { + "type": "object", + "description": "Describes the policy to be used for placement of a Service Fabric service where the instances or replicas of that service must be placed in a particular domain.", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicy" + }, + { + "type": "object", + "description": "ServicePlacementRequiredDomainPolicy" + } + ], + "x-ms-discriminator-value": "RequiredDomain", + "required": [ + "domainName" + ], + "properties": { + "domainName": { + "type": "string", + "description": "The name of the domain that should used for placement as per this policy." + } + } + }, + "ServicePlacementRequireDomainDistributionPolicy": { + "type": "object", + "description": "Describes the policy to be used for placement of a Service Fabric service where two replicas\nfrom the same partition should never be placed in the same fault or upgrade domain.\n\nWhile this is not common it can expose the service to an increased risk of concurrent failures\ndue to unplanned outages or other cases of subsequent/concurrent failures. As an example, consider\na case where replicas are deployed across different data center, with one replica per location.\nIn the event that one of the datacenters goes offline, normally the replica that was placed in that\ndatacenter will be packed into one of the remaining datacenters. If this is not desirable then this\npolicy should be set.\n", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicy" + }, + { + "type": "object", + "description": "ServicePlacementRequireDomainDistributionPolicy" + } + ], + "x-ms-discriminator-value": "RequiredDomainDistribution", + "required": [ + "domainName" + ], + "properties": { + "domainName": { + "type": "string", + "description": "The name of the domain that should used for placement as per this policy." + } + } + }, + "ServiceResource": { + "type": "object", + "description": "The service resource.", + "properties": { + "properties": { + "$ref": "#/definitions/ServiceResourceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ServiceResourceList": { + "type": "object", + "description": "The list of service resources.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceResource" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of service list results if there are any.", + "readOnly": true + } + } + }, + "ServiceResourceProperties": { + "type": "object", + "description": "The service resource properties.", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourcePropertiesBase" + } + ], + "required": [ + "serviceKind", + "serviceTypeName", + "partitionDescription" + ], + "discriminator": "serviceKind", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response" + }, + "serviceKind": { + "$ref": "#/definitions/ServiceKind" + }, + "serviceTypeName": { + "type": "string", + "description": "The name of the service type" + }, + "partitionDescription": { + "$ref": "#/definitions/Partition" + }, + "servicePackageActivationMode": { + "type": "string", + "description": "The activation Mode of the service package", + "enum": [ + "SharedProcess", + "ExclusiveProcess" + ], + "x-ms-enum": { + "name": "ServicePackageActivationMode", + "modelAsString": true, + "values": [ + { + "value": "SharedProcess", + "description": "Indicates the application package activation mode will use shared process." + }, + { + "value": "ExclusiveProcess", + "description": "Indicates the application package activation mode will use exclusive process." + } + ] + } + } + } + }, + "ServiceResourcePropertiesBase": { + "type": "object", + "description": "The common service resource properties.", + "properties": { + "placementConstraints": { + "type": "string", + "description": "The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: \"NodeColor == blue)\"." + }, + "correlationScheme": { + "$ref": "#/definitions/CorrelationSchemeList" + }, + "serviceLoadMetrics": { + "$ref": "#/definitions/ServiceLoadMetricsList" + }, + "servicePlacementPolicies": { + "$ref": "#/definitions/ServicePlacementPoliciesList" + }, + "defaultMoveCost": { + "$ref": "#/definitions/MoveCost" + }, + "scalingPolicies": { + "$ref": "#/definitions/ScalingPolicyList" + } + } + }, + "ServiceScalingMechanismKind": { + "type": "string", + "description": "Enumerates the ways that a service can be partitioned.", + "enum": [ + "ScalePartitionInstanceCount", + "AddRemoveIncrementalNamedPartition" + ], + "x-ms-enum": { + "name": "ServiceScalingMechanismKind", + "modelAsString": true, + "values": [ + { + "value": "ScalePartitionInstanceCount", + "description": "Represents a scaling mechanism for adding or removing instances of stateless service partition. The value is 0." + }, + { + "value": "AddRemoveIncrementalNamedPartition", + "description": "Represents a scaling mechanism for adding or removing named partitions of a stateless service. The value is 1." + } + ] + } + }, + "ServiceScalingTriggerKind": { + "type": "string", + "description": "Enumerates the ways that a service can be partitioned.", + "enum": [ + "AveragePartitionLoad", + "AverageServiceLoad" + ], + "x-ms-enum": { + "name": "ServiceScalingTriggerKind", + "modelAsString": true, + "values": [ + { + "value": "AveragePartitionLoad", + "description": "Represents a scaling trigger related to an average load of a metric/resource of a partition. The value is 0." + }, + { + "value": "AverageServiceLoad", + "description": "Represents a scaling policy related to an average load of a metric/resource of a service. The value is 1." + } + ] + } + }, + "ServiceTypeHealthPolicy": { + "type": "object", + "description": "Represents the health policy used to evaluate the health of services belonging to a service type.\n", + "required": [ + "maxPercentUnhealthyServices", + "maxPercentUnhealthyPartitionsPerService", + "maxPercentUnhealthyReplicasPerPartition" + ], + "properties": { + "maxPercentUnhealthyServices": { + "type": "integer", + "format": "int32", + "description": "The maximum allowed percentage of unhealthy services.\n\nThe percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error.\nIf the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning.\nThis is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type.\nThe computation rounds up to tolerate one failure on small numbers of services.\n", + "minimum": 0, + "maximum": 100 + }, + "maxPercentUnhealthyPartitionsPerService": { + "type": "integer", + "format": "int32", + "description": "The maximum allowed percentage of unhealthy partitions per service.\n\nThe percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error.\nIf the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service.\nThe computation rounds up to tolerate one failure on small numbers of partitions.\n", + "minimum": 0, + "maximum": 100 + }, + "maxPercentUnhealthyReplicasPerPartition": { + "type": "integer", + "format": "int32", + "description": "The maximum allowed percentage of unhealthy replicas per partition.\n\nThe percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error.\nIf the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition.\nThe computation rounds up to tolerate one failure on small numbers of replicas.\n", + "minimum": 0, + "maximum": 100 + } + } + }, + "ServiceTypeHealthPolicyMap": { + "type": "object", + "description": "Defines a ServiceTypeHealthPolicy per service type name.\n\nThe entries in the map replace the default service type health policy for each specified service type.\nFor example, in an application that contains both a stateless gateway service type and a stateful engine service type, the health policies for the stateless and stateful services can be configured differently.\nWith policy per service type, there's more granular control of the health of the service.\n\nIf no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation.\n", + "additionalProperties": { + "$ref": "#/definitions/ServiceTypeHealthPolicy" + } + }, + "ServiceUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "description": "Service update parameters", + "additionalProperties": { + "type": "string" + } + } + }, + "description": "Service update request" + }, + "SingletonPartitionScheme": { + "type": "object", + "description": "Describes the partition scheme of a singleton-partitioned, or non-partitioned service.", + "allOf": [ + { + "$ref": "#/definitions/Partition" + }, + { + "type": "object", + "description": "SingletonPartitionScheme" + } + ], + "x-ms-discriminator-value": "Singleton" + }, + "StatefulServiceProperties": { + "type": "object", + "description": "The properties of a stateful service resource.", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourceProperties" + } + ], + "x-ms-discriminator-value": "Stateful", + "properties": { + "hasPersistedState": { + "type": "boolean", + "description": "A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false." + }, + "targetReplicaSetSize": { + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "The target replica set size as a number." + }, + "minReplicaSetSize": { + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "The minimum replica set size as a number." + }, + "replicaRestartWaitDuration": { + "type": "string", + "description": "The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format \"hh:mm:ss\"." + }, + "quorumLossWaitDuration": { + "type": "string", + "description": "The maximum duration for which a partition is allowed to be in a state of quorum loss, represented in ISO 8601 format \"hh:mm:ss\"." + }, + "standByReplicaKeepDuration": { + "type": "string", + "description": "The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format \"hh:mm:ss\"." + }, + "servicePlacementTimeLimit": { + "type": "string", + "description": "The duration for which replicas can stay InBuild before reporting that build is stuck, represented in ISO 8601 format \"hh:mm:ss\"." + } + } + }, + "StatelessServiceProperties": { + "type": "object", + "description": "The properties of a stateless service resource.", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourceProperties" + } + ], + "x-ms-discriminator-value": "Stateless", + "required": [ + "instanceCount" + ], + "properties": { + "instanceCount": { + "type": "integer", + "format": "int32", + "minimum": -1, + "description": "The instance count." + }, + "minInstanceCount": { + "type": "integer", + "format": "int32", + "description": "MinInstanceCount is the minimum number of instances that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstanceCount computation -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service." + }, + "minInstancePercentage": { + "type": "integer", + "format": "int32", + "description": "MinInstancePercentage is the minimum percentage of InstanceCount that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstancePercentage computation, -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service." + } + } + }, + "UniformInt64RangePartitionScheme": { + "type": "object", + "description": "Describes a partitioning scheme where an integer range is allocated evenly across a number of partitions.", + "allOf": [ + { + "$ref": "#/definitions/Partition" + }, + { + "type": "object", + "description": "UniformInt64RangePartitionScheme" + } + ], + "x-ms-discriminator-value": "UniformInt64Range", + "required": [ + "count", + "lowKey", + "highKey" + ], + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The number of partitions." + }, + "lowKey": { + "type": "integer", + "format": "int64", + "description": "The lower bound of the partition key range that\nshould be split between the partition ‘Count’\n" + }, + "highKey": { + "type": "integer", + "format": "int64", + "description": "The upper bound of the partition key range that\nshould be split between the partition ‘Count’\n" + } + } + }, + "UpgradeDomainTimeout": { + "type": "string", + "description": "The amount of time each upgrade domain has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format \"hh:mm:ss.fff\"." + }, + "UpgradeTimeout": { + "type": "string", + "description": "The amount of time the overall upgrade has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format \"hh:mm:ss.fff\"." + }, + "UserAssignedIdentity": { + "type": "object", + "properties": { + "principalId": { + "type": "string", + "readOnly": true, + "description": "The principal id of user assigned identity." + }, + "clientId": { + "type": "string", + "readOnly": true, + "description": "The client id of user assigned identity." + } + } + }, + "UserAssignedIdentityMap": { + "type": "object", + "description": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.\n", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + } + }, + "AvailableOperationDisplay": { + "type": "object", + "properties": { + "provider": { + "type": "string", + "description": "The name of the provider." + }, + "resource": { + "type": "string", + "description": "The resource on which the operation is performed" + }, + "operation": { + "type": "string", + "description": "The operation that can be performed." + }, + "description": { + "type": "string", + "description": "Operation description" + } + }, + "description": "Operation supported by the Service Fabric resource provider" + }, + "ErrorModel": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorModelError", + "description": "The error details." + } + }, + "description": "The structure of the error." + }, + "ErrorModelError": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "The error details." + }, + "OperationResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "isDataAction": { + "type": "boolean", + "description": "Indicates whether the operation is a data action" + }, + "display": { + "$ref": "#/definitions/AvailableOperationDisplay", + "description": "The object that represents the operation." + }, + "origin": { + "type": "string", + "description": "Origin result" + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Available operation list result" + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "type": "string", + "description": "The type of identity that created the resource." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)." + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "type": "string", + "description": "The type of identity that last modified the resource." + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)." + } + } + } + }, + "parameters": { + "api-version": { + "name": "api-version", + "in": "query", + "description": "The version of the Service Fabric resource provider API. This is a required parameter and it's value must be \"2021-07-01-preview\" for this specification.", + "required": true, + "type": "string", + "enum": [ + "2021-07-01-preview" + ], + "x-ms-parameter-location": "client" + }, + "applicationName": { + "name": "applicationName", + "in": "path", + "description": "The name of the application resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "applicationTypeName": { + "name": "applicationTypeName", + "in": "path", + "description": "The name of the application type name resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "clusterNameParameter": { + "name": "clusterName", + "in": "path", + "description": "The name of the cluster resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "serviceName": { + "name": "serviceName", + "in": "path", + "description": "The name of the service resource in the format of {applicationName}~{serviceName}.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The customer subscription identifier.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "version": { + "name": "version", + "in": "path", + "description": "The application type version.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/managedcluster.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/managedcluster.json new file mode 100644 index 000000000000..b4d8f10e8b4e --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/managedcluster.json @@ -0,0 +1,1463 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceFabricManagementClient", + "description": "Azure Service Fabric Resource Provider API Client", + "version": "2021-07-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters": { + "get": { + "operationId": "ManagedClusters_ListByResourceGroup", + "summary": "Gets the list of Service Fabric cluster resources created in the specified resource group.", + "description": "Gets all Service Fabric cluster resources created or in the process of being created in the resource group.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "tags": [ + "ManagedCluster" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List cluster by resource group": { + "$ref": "./examples/ManagedClusterListByResourceGroupOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/managedClusters": { + "get": { + "operationId": "ManagedClusters_ListBySubscription", + "summary": "Gets the list of Service Fabric cluster resources created in the specified subscription.", + "description": "Gets all Service Fabric cluster resources created or in the process of being created in the subscription.", + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "tags": [ + "ManagedCluster" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List managed clusters": { + "$ref": "./examples/ManagedClusterListBySubscriptionOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}": { + "get": { + "tags": [ + "ManagedCluster" + ], + "operationId": "ManagedClusters_Get", + "summary": "Gets a Service Fabric managed cluster resource.", + "description": "Get a Service Fabric managed cluster resource created or in the process of being created in the specified resource group.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "Get a cluster": { + "$ref": "./examples/ManagedClusterGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "ManagedCluster" + ], + "operationId": "ManagedClusters_CreateOrUpdate", + "summary": "Creates or updates a Service Fabric managed cluster resource.", + "description": "Create or update a Service Fabric managed cluster resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "The cluster resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedCluster" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put a cluster with minimum parameters": { + "$ref": "./examples/ManagedClusterPutOperation_example_min.json" + }, + "Put a cluster with maximum parameters": { + "$ref": "./examples/ManagedClusterPutOperation_example_max.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "ManagedCluster" + ], + "operationId": "ManagedClusters_Update", + "summary": "Updates the tags of of a Service Fabric managed cluster resource.", + "description": "Update the tags of of a Service Fabric managed cluster resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "The managed cluster resource updated tags.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterUpdateParameters" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Patch a managed cluster": { + "$ref": "./examples/ManagedClusterPatchOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "ManagedCluster" + ], + "operationId": "ManagedClusters_Delete", + "summary": "Deletes a Service Fabric managed cluster resource.", + "description": "Delete a Service Fabric managed cluster resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "Delete a cluster": { + "$ref": "./examples/ManagedClusterDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/managedClusterVersions/{clusterVersion}": { + "get": { + "operationId": "ManagedClusterVersion_Get", + "summary": "Gets information about a Service Fabric managed cluster code version available in the specified location.", + "description": "Gets information about an available Service Fabric managed cluster code version.", + "parameters": [ + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/clusterVersion" + } + ], + "x-ms-examples": { + "Get cluster version": { + "$ref": "./examples/ManagedClusterVersionGet_example.json" + } + }, + "tags": [ + "ManagedClusterVersion" + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedClusterCodeVersionResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/managedClusterVersions/{clusterVersion}": { + "get": { + "operationId": "ManagedClusterVersion_GetByEnvironment", + "summary": "Gets information about a Service Fabric cluster code version available for the specified environment.", + "description": "Gets information about an available Service Fabric cluster code version by environment.", + "parameters": [ + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/environment" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/clusterVersion" + } + ], + "x-ms-examples": { + "Get cluster version by environment": { + "$ref": "./examples/ManagedClusterVersionGetByEnvironment_example.json" + } + }, + "tags": [ + "ManagedClusterVersion" + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedClusterCodeVersionResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/managedClusterVersions": { + "get": { + "operationId": "ManagedClusterVersion_List", + "summary": "Gets the list of Service Fabric cluster code versions available for the specified location.", + "description": "Gets all available code versions for Service Fabric cluster resources by location.", + "parameters": [ + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "List cluster versions": { + "$ref": "./examples/ManagedClusterVersionList_example.json" + } + }, + "tags": [ + "ManagedClusterVersion" + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedClusterCodeVersionListResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/managedClusterVersions": { + "get": { + "operationId": "ManagedClusterVersion_ListByEnvironment", + "summary": "Gets the list of Service Fabric cluster code versions available for the specified environment.", + "description": "Gets all available code versions for Service Fabric cluster resources by environment.", + "parameters": [ + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/environment" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "List cluster versions by environment": { + "$ref": "./examples/ManagedClusterVersionListByEnvironment.json" + } + }, + "tags": [ + "ManagedClusterVersion" + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedClusterCodeVersionListResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/providers/Microsoft.ServiceFabric/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Lists all of the available Service Fabric resource provider API operations.", + "description": "Get the list of available Service Fabric resource provider API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "name": "api-version", + "in": "query", + "description": "The version of the Service Fabric resource provider API", + "required": true, + "type": "string" + } + ], + "x-ms-examples": { + "List available operations": { + "$ref": "./examples/Operations_example.json" + } + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ManagedClusterAddOnFeature": { + "type": "string", + "description": "Available cluster add-on features", + "enum": [ + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ] + }, + "ApplicationTypeVersionsCleanupPolicy": { + "type": "object", + "required": [ + "maxUnusedVersionsToKeep" + ], + "properties": { + "maxUnusedVersionsToKeep": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "Number of unused versions per application type to keep." + } + }, + "description": "The policy used to clean up unused versions. When the policy is not specified explicitly, the default unused application versions to keep will be 3." + }, + "AzureActiveDirectory": { + "type": "object", + "properties": { + "tenantId": { + "type": "string", + "description": "Azure active directory tenant id." + }, + "clusterApplication": { + "type": "string", + "description": "Azure active directory cluster application id." + }, + "clientApplication": { + "type": "string", + "description": "Azure active directory client application id." + } + }, + "description": "The settings to enable AAD authentication on the cluster." + }, + "ClientCertificate": { + "type": "object", + "required": [ + "isAdmin" + ], + "properties": { + "isAdmin": { + "type": "boolean", + "description": "Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster." + }, + "thumbprint": { + "type": "string", + "description": "Certificate thumbprint." + }, + "commonName": { + "type": "string", + "description": "Certificate common name." + }, + "issuerThumbprint": { + "type": "string", + "description": "Issuer thumbprint for the certificate. Only used together with CommonName." + } + }, + "description": "Client certificate definition." + }, + "ClusterState": { + "type": "string", + "description": "The current state of the cluster.\n", + "enum": [ + "WaitingForNodes", + "Deploying", + "BaselineUpgrade", + "Upgrading", + "UpgradeFailed", + "Ready" + ], + "x-ms-enum": { + "name": "ClusterState", + "modelAsString": true, + "values": [ + { + "value": "WaitingForNodes", + "description": "Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it." + }, + { + "value": "Deploying", + "description": "Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up." + }, + { + "value": "BaselineUpgrade", + "description": "Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time." + }, + { + "value": "Upgrading", + "description": "Indicates that the cluster is being upgraded with the user provided configuration." + }, + { + "value": "UpgradeFailed", + "description": "Indicates that the last upgrade for the cluster has failed." + }, + { + "value": "Ready", + "description": "Indicates that the cluster is in a stable state." + } + ] + } + }, + "ClusterUpgradeCadence": { + "type": "string", + "enum": [ + "Wave0", + "Wave1", + "Wave2" + ], + "x-ms-enum": { + "name": "clusterUpgradeCadence", + "modelAsString": true, + "values": [ + { + "value": "Wave0", + "description": "Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters." + }, + { + "value": "Wave1", + "description": "Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters." + }, + { + "value": "Wave2", + "description": "Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters." + } + ] + }, + "description": "Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0." + }, + "ClusterUpgradeMode": { + "type": "string", + "description": "The upgrade mode of the cluster when new Service Fabric runtime version is available.\n", + "enum": [ + "Automatic", + "Manual" + ], + "default": "Automatic", + "x-ms-enum": { + "name": "ClusterUpgradeMode", + "modelAsString": true, + "values": [ + { + "value": "Automatic", + "description": "The cluster will be automatically upgraded to the latest Service Fabric runtime version, **clusterUpgradeCadence** will determine when the upgrade starts after the new version becomes available." + }, + { + "value": "Manual", + "description": "The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource." + } + ] + } + }, + "IPTag": { + "type": "object", + "required": [ + "ipTagType", + "tag" + ], + "properties": { + "ipTagType": { + "type": "string", + "description": "The IP tag type." + }, + "tag": { + "type": "string", + "description": "The value of the IP tag." + } + }, + "description": "IPTag associated with the object." + }, + "LoadBalancingRule": { + "type": "object", + "required": [ + "frontendPort", + "backendPort", + "protocol", + "probeProtocol" + ], + "properties": { + "frontendPort": { + "type": "integer", + "format": "int32", + "description": "The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534.", + "minimum": 1, + "maximum": 65534 + }, + "backendPort": { + "type": "integer", + "format": "int32", + "description": "The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.", + "minimum": 1, + "maximum": 65534 + }, + "protocol": { + "type": "string", + "description": "The reference to the transport protocol used by the load balancing rule.", + "enum": [ + "tcp", + "udp" + ], + "x-ms-enum": { + "name": "protocol", + "modelAsString": true + } + }, + "probePort": { + "type": "integer", + "format": "int32", + "description": "The prob port used by the load balancing rule. Acceptable values are between 1 and 65535.", + "minimum": 1, + "maximum": 65534 + }, + "probeProtocol": { + "type": "string", + "description": "the reference to the load balancer probe used by the load balancing rule.", + "enum": [ + "tcp", + "http", + "https" + ], + "x-ms-enum": { + "name": "probeProtocol", + "modelAsString": true + } + }, + "probeRequestPath": { + "type": "string", + "description": "The probe request path. Only supported for HTTP/HTTPS probes." + } + }, + "description": "Describes a load balancing rule." + }, + "ManagedCluster": { + "type": "object", + "description": "The manged cluster resource\n", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "type": "object" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ManagedClusterProperties", + "description": "The managed cluster resource properties" + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku of the managed cluster" + } + } + }, + "ManagedClusterCodeVersionListResult": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterCodeVersionResult" + }, + "description": "The list results of the Service Fabric runtime versions." + }, + "ManagedClusterCodeVersionResult": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identification of the result" + }, + "name": { + "type": "string", + "description": "The name of the result" + }, + "type": { + "type": "string", + "description": "The result resource type" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ManagedClusterVersionDetails" + } + }, + "description": "The result of the Service Fabric runtime versions" + }, + "ManagedClusterListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Managed Cluster list results" + }, + "ManagedClusterProperties": { + "type": "object", + "required": [ + "dnsName", + "adminUserName" + ], + "properties": { + "dnsName": { + "type": "string", + "description": "The cluster dns name." + }, + "fqdn": { + "type": "string", + "description": "The fully qualified domain name associated with the public load balancer of the cluster.", + "readOnly": true + }, + "ipv4Address": { + "type": "string", + "description": "The IPv4 address associated with the public load balancer of the cluster.", + "readOnly": true + }, + "clusterId": { + "type": "string", + "description": "A service generated unique identifier for the cluster resource.", + "readOnly": true + }, + "clusterState": { + "readOnly": true, + "$ref": "#/definitions/ClusterState", + "description": "The current state of the cluster." + }, + "clusterCertificateThumbprints": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of thumbprints of the cluster certificates.", + "readOnly": true + }, + "clientConnectionPort": { + "type": "integer", + "format": "int32", + "description": "The port used for client connections to the cluster.", + "default": 19000 + }, + "httpGatewayConnectionPort": { + "type": "integer", + "format": "int32", + "description": "The port used for HTTP connections to the cluster.", + "default": 19080 + }, + "adminUserName": { + "type": "string", + "description": "VM admin user name." + }, + "adminPassword": { + "type": "string", + "x-ms-secret": true, + "format": "password", + "description": "VM admin user password." + }, + "loadBalancingRules": { + "type": "array", + "items": { + "$ref": "#/definitions/LoadBalancingRule" + }, + "description": "Load balancing rules that are applied to the public load balancer of the cluster." + }, + "allowRdpAccess": { + "type": "boolean", + "description": "Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false." + }, + "networkSecurityRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityRule" + }, + "description": "Custom Network Security Rules that are applied to the Virtual Network of the cluster." + }, + "clients": { + "type": "array", + "items": { + "$ref": "#/definitions/ClientCertificate" + }, + "description": "Client certificates that are allowed to manage the cluster." + }, + "azureActiveDirectory": { + "$ref": "#/definitions/AzureActiveDirectory", + "description": "The AAD authentication settings of the cluster." + }, + "fabricSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/SettingsSectionDescription" + }, + "description": "The list of custom fabric settings to configure the cluster." + }, + "provisioningState": { + "$ref": "#/definitions/ManagedResourceProvisioningState", + "readOnly": true, + "description": "The provisioning state of the managed cluster resource." + }, + "clusterCodeVersion": { + "type": "string", + "description": "The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**." + }, + "clusterUpgradeMode": { + "$ref": "#/definitions/ClusterUpgradeMode" + }, + "clusterUpgradeCadence": { + "$ref": "#/definitions/ClusterUpgradeCadence", + "description": "Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **clusterUpgradeMode** is set to 'Automatic'." + }, + "addonFeatures": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterAddOnFeature" + }, + "description": "List of add-on features to enable on the cluster." + }, + "enableAutoOSUpgrade": { + "type": "boolean", + "description": "Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false." + }, + "zonalResiliency": { + "type": "boolean", + "description": "Indicates if the cluster has zone resiliency.", + "default": false + }, + "applicationTypeVersionsCleanupPolicy": { + "$ref": "#/definitions/ApplicationTypeVersionsCleanupPolicy", + "description": "The policy used to clean up unused versions." + }, + "enableIpv6": { + "type": "boolean", + "description": "Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false." + }, + "subnetId": { + "type": "string", + "description": "If specified, the node types for the cluster are created in this subnet instead of the default VNet. The **networkSecurityRules** specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created." + }, + "ipTags": { + "type": "array", + "items": { + "$ref": "#/definitions/IPTag" + }, + "description": "The list of IP tags associated with the default public IP address of the cluster." + } + }, + "description": "Describes the managed cluster resource properties." + }, + "ManagedClusterUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "description": "Managed cluster update parameters", + "additionalProperties": { + "type": "string" + } + } + }, + "description": "Managed cluster update request" + }, + "ManagedClusterVersionDetails": { + "type": "object", + "properties": { + "clusterCodeVersion": { + "type": "string", + "description": "The Service Fabric runtime version of the cluster." + }, + "supportExpiryUtc": { + "type": "string", + "description": "The date of expiry of support of the version." + }, + "osType": { + "$ref": "#/definitions/OsType" + } + }, + "description": "The detail of the Service Fabric runtime version result" + }, + "OsType": { + "type": "string", + "description": "Cluster operating system, the default will be Windows", + "enum": [ + "Windows" + ] + }, + "Sku": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "$ref": "#/definitions/SkuName", + "description": "Sku Name." + } + }, + "description": "Service Fabric managed cluster Sku definition" + }, + "SkuName": { + "type": "string", + "description": "Sku Name.", + "enum": [ + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true, + "values": [ + { + "value": "Basic", + "description": "Basic requires a minimum of 3 nodes and allows only 1 node type." + }, + { + "value": "Standard", + "description": "Requires a minimum of 5 nodes and allows 1 or more node type." + } + ] + } + }, + "AvailableOperationDisplay": { + "type": "object", + "properties": { + "provider": { + "type": "string", + "description": "The name of the provider." + }, + "resource": { + "type": "string", + "description": "The resource on which the operation is performed" + }, + "operation": { + "type": "string", + "description": "The operation that can be performed." + }, + "description": { + "type": "string", + "description": "Operation description" + } + }, + "description": "Operation supported by the Service Fabric resource provider" + }, + "ErrorModel": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorModelError", + "description": "The error details." + } + }, + "description": "The structure of the error." + }, + "ErrorModelError": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "The error details." + }, + "ManagedResourceProvisioningState": { + "type": "string", + "description": "The provisioning state of the managed resource.", + "enum": [ + "None", + "Creating", + "Created", + "Updating", + "Succeeded", + "Failed", + "Canceled", + "Deleting", + "Deleted", + "Other" + ], + "x-ms-enum": { + "name": "ManagedResourceProvisioningState", + "modelAsString": true + } + }, + "NetworkSecurityRule": { + "type": "object", + "required": [ + "name", + "protocol", + "access", + "priority", + "direction" + ], + "properties": { + "name": { + "type": "string", + "description": "Network security rule name." + }, + "description": { + "type": "string", + "description": "Network security rule description." + }, + "protocol": { + "type": "string", + "description": "Network protocol this rule applies to.", + "enum": [ + "http", + "https", + "tcp", + "udp", + "icmp", + "ah", + "esp" + ], + "x-ms-enum": { + "name": "nsgProtocol", + "modelAsString": true + } + }, + "sourceAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The CIDR or source IP ranges." + }, + "destinationAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination address prefixes. CIDR or destination IP ranges." + }, + "sourcePortRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The source port ranges." + }, + "destinationPortRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination port ranges." + }, + "access": { + "type": "string", + "description": "The network traffic is allowed or denied.", + "enum": [ + "allow", + "deny" + ], + "x-ms-enum": { + "name": "access", + "modelAsString": true + } + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.", + "minimum": 1000, + "maximum": 3000 + }, + "direction": { + "type": "string", + "description": "Network security rule direction.", + "enum": [ + "inbound", + "outbound" + ], + "x-ms-enum": { + "name": "direction", + "modelAsString": true + } + } + }, + "description": "Describes a network security rule." + }, + "OperationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "List of operations supported by the Service Fabric resource provider.", + "items": { + "$ref": "#/definitions/OperationResult" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any.", + "readOnly": true + } + }, + "description": "Describes the result of the request to list Service Fabric resource provider operations." + }, + "OperationResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "isDataAction": { + "type": "boolean", + "description": "Indicates whether the operation is a data action" + }, + "display": { + "$ref": "#/definitions/AvailableOperationDisplay", + "description": "The object that represents the operation." + }, + "origin": { + "type": "string", + "description": "Origin result" + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Available operation list result" + }, + "Resource": { + "type": "object", + "required": [ + "location" + ], + "properties": { + "id": { + "type": "string", + "description": "Azure resource identifier.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Azure resource name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Azure resource type.", + "readOnly": true + }, + "location": { + "type": "string", + "description": "Azure resource location.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "type": "object", + "description": "Azure resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "etag": { + "type": "string", + "description": "Azure resource etag.", + "readOnly": true + }, + "systemData": { + "$ref": "#/definitions/SystemData" + } + }, + "description": "The resource model definition.", + "x-ms-azure-resource": true + }, + "SettingsParameterDescription": { + "type": "object", + "required": [ + "name", + "value" + ], + "properties": { + "name": { + "type": "string", + "description": "The parameter name of fabric setting." + }, + "value": { + "type": "string", + "description": "The parameter value of fabric setting." + } + }, + "description": "Describes a parameter in fabric settings of the cluster." + }, + "SettingsSectionDescription": { + "type": "object", + "required": [ + "name", + "parameters" + ], + "properties": { + "name": { + "type": "string", + "description": "The section name of the fabric settings." + }, + "parameters": { + "type": "array", + "description": "The collection of parameters in the section.", + "items": { + "$ref": "#/definitions/SettingsParameterDescription" + } + } + }, + "description": "Describes a section in the fabric settings of the cluster." + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "type": "string", + "description": "The type of identity that created the resource." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)." + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "type": "string", + "description": "The type of identity that last modified the resource." + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)." + } + } + } + }, + "parameters": { + "api-version": { + "name": "api-version", + "in": "query", + "description": "The version of the Service Fabric resource provider API. This is a required parameter and it's value must be \"2021-07-01-preview\" for this specification.", + "required": true, + "type": "string", + "enum": [ + "2021-07-01-preview" + ], + "x-ms-parameter-location": "client" + }, + "clusterNameParameter": { + "name": "clusterName", + "in": "path", + "description": "The name of the cluster resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "clusterVersion": { + "name": "clusterVersion", + "in": "path", + "description": "The cluster code version.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "environment": { + "name": "environment", + "in": "path", + "description": "The operating system of the cluster. The default means all.", + "required": true, + "type": "string", + "enum": [ + "Windows" + ], + "x-ms-parameter-location": "method" + }, + "locationForClusterCodeVersions": { + "name": "location", + "in": "path", + "description": "The location for the cluster code versions. This is different from cluster location.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The customer subscription identifier.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/nodetype.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/nodetype.json new file mode 100644 index 000000000000..1d7d11f0225a --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/nodetype.json @@ -0,0 +1,1399 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceFabricManagementClient", + "description": "Azure Service Fabric Resource Provider API Client", + "version": "2021-07-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes": { + "get": { + "operationId": "NodeTypes_ListByManagedClusters", + "summary": "Gets the list of Node types of the specified managed cluster.", + "description": "Gets all Node types of the specified managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "tags": [ + "NodeType" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List node type of the specified managed cluster": { + "$ref": "./examples/NodeTypeListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/NodeTypeListResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/restart": { + "post": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypes_Restart", + "summary": "Restarts one or more nodes on the node type.", + "description": "Restarts one or more nodes on the node type. It will disable the fabric nodes, trigger a restart on the VMs and activate the nodes back again.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "parameters for restart action.", + "required": true, + "schema": { + "$ref": "#/definitions/NodeTypeActionParameters" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Restart nodes": { + "$ref": "./examples/RestartNodes_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/reimage": { + "post": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypes_Reimage", + "summary": "Reimages one or more nodes on the node type.", + "description": "Reimages one or more nodes on the node type. It will disable the fabric nodes, trigger a reimage on the VMs and activate the nodes back again.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "parameters for reimage action.", + "required": true, + "schema": { + "$ref": "#/definitions/NodeTypeActionParameters" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Reimage nodes": { + "$ref": "./examples/ReimageNodes_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/deleteNode": { + "post": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypes_DeleteNode", + "summary": "Deletes one or more nodes on the node type.", + "description": "Deletes one or more nodes on the node type. It will disable the fabric nodes, trigger a delete on the VMs and removes the state from the cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "parameters for delete action.", + "required": true, + "schema": { + "$ref": "#/definitions/NodeTypeActionParameters" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Delete nodes": { + "$ref": "./examples/DeleteNodes_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/skus": { + "get": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypeSkus_List", + "summary": "Gets a Service Fabric node type SKUs.", + "description": "Get a Service Fabric node type supported SKUs.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List a node type SKUs": { + "$ref": "./examples/NodeTypeSkusListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/NodeTypeListSkuResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}": { + "get": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypes_Get", + "summary": "Gets a Service Fabric node type.", + "description": "Get a Service Fabric node type of a given managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get a node type": { + "$ref": "./examples/NodeTypeGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/NodeType" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypes_CreateOrUpdate", + "summary": "Creates or updates a Service Fabric node type.", + "description": "Create or update a Service Fabric node type of a given managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The node type resource.", + "required": true, + "schema": { + "$ref": "#/definitions/NodeType" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put a node type with minimum parameters": { + "$ref": "./examples/NodeTypePutOperation_example_min.json" + }, + "Put a node type with maximum parameters": { + "$ref": "./examples/NodeTypePutOperation_example_max.json" + }, + "Put a node type with auto-scale parameters": { + "$ref": "./examples/NodeTypePutOperationAutoScale_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/NodeType" + } + }, + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/NodeType" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypes_Update", + "summary": "Update the tags of a node type resource of a given managed cluster.", + "description": "Update the configuration of a node type of a given managed cluster, only updating tags.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The parameters to update the node type configuration.", + "required": true, + "schema": { + "$ref": "#/definitions/NodeTypeUpdateParameters" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Patch a node type": { + "$ref": "./examples/NodeTypePatchOperation_example.json" + }, + "Patch a node type while auto-scaling": { + "$ref": "./examples/NodeTypePatchOperationAutoScale_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/NodeType" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypes_Delete", + "summary": "Deletes a Service Fabric node type.", + "description": "Delete a Service Fabric node type of a given managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete a node type": { + "$ref": "./examples/NodeTypeDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + } + }, + "definitions": { + "DiskType": { + "type": "string", + "description": "Managed data disk type. IOPS and throughput are given by the disk size, to see more information go to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types.\n", + "enum": [ + "Standard_LRS", + "StandardSSD_LRS", + "Premium_LRS" + ], + "default": "StandardSSD_LRS", + "x-ms-enum": { + "name": "DiskType", + "modelAsString": true, + "values": [ + { + "value": "Standard_LRS", + "description": "Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access." + }, + { + "value": "StandardSSD_LRS", + "description": "Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test." + }, + { + "value": "Premium_LRS", + "description": "Premium SSD locally redundant storage. Best for production and performance sensitive workloads." + } + ] + } + }, + "FrontendConfiguration": { + "type": "object", + "properties": { + "ipAddressType": { + "$ref": "#/definitions/IPAddressType", + "description": "The IP address type of this frontend configuration. If omitted the default value is IPv4." + }, + "loadBalancerBackendAddressPoolId": { + "type": "string", + "description": "The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//backendAddressPools/'." + }, + "loadBalancerInboundNatPoolId": { + "type": "string", + "description": "The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//inboundNatPools/'." + } + }, + "description": "Describes the frontend configurations for the node type." + }, + "IPAddressType": { + "type": "string", + "description": "The IP address type.\n", + "enum": [ + "IPv4", + "IPv6" + ], + "default": "IPv4", + "x-ms-enum": { + "name": "IPAddressType", + "modelAsString": true, + "values": [ + { + "value": "IPv4", + "description": "IPv4 address type." + }, + { + "value": "IPv6", + "description": "IPv6 address type." + } + ] + } + }, + "ManagedProxyResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Azure resource identifier.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Azure resource name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Azure resource type.", + "readOnly": true + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Azure resource tags.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "systemData": { + "$ref": "#/definitions/SystemData" + } + }, + "description": "The resource model definition for proxy-only resource.", + "x-ms-azure-resource": true + }, + "NodeType": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ManagedProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NodeTypeProperties", + "description": "The node type properties" + }, + "sku": { + "$ref": "#/definitions/NodeTypeSku", + "description": "The node type sku." + } + }, + "description": "Describes a node type in the cluster, each node type represents sub set of nodes in the cluster." + }, + "NodeTypeActionParameters": { + "type": "object", + "required": [ + "nodes" + ], + "properties": { + "nodes": { + "description": "List of node names from the node type.", + "type": "array", + "items": { + "type": "string" + } + }, + "force": { + "description": "Force the action to go through.", + "type": "boolean" + } + }, + "description": "Parameters for Node type action." + }, + "NodeTypeProperties": { + "type": "object", + "required": [ + "isPrimary", + "vmInstanceCount", + "dataDiskSizeGB" + ], + "properties": { + "isPrimary": { + "type": "boolean", + "description": "Indicates the Service Fabric system services for the cluster will run on this node type. This setting cannot be changed once the node type is created." + }, + "vmInstanceCount": { + "type": "integer", + "format": "int32", + "description": "The number of nodes in the node type.

    **Values:**
    -1 - Use when auto scale rules are configured or sku.capacity is defined
    0 - Not supported
    >0 - Use for manual scale.", + "minimum": -1, + "maximum": 2147483647 + }, + "dataDiskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Disk size for each vm in the node type in GBs." + }, + "dataDiskType": { + "$ref": "#/definitions/DiskType", + "description": "Managed data disk type." + }, + "placementProperties": { + "type": "object", + "description": "The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run.", + "additionalProperties": { + "type": "string", + "description": "Placement tag value" + } + }, + "capacities": { + "type": "object", + "description": "The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has.", + "additionalProperties": { + "type": "string", + "description": "Capacity tag value" + } + }, + "applicationPorts": { + "$ref": "#/definitions/EndpointRangeDescription", + "description": "The range of ports from which cluster assigned port to Service Fabric applications." + }, + "ephemeralPorts": { + "$ref": "#/definitions/EndpointRangeDescription", + "description": "The range of ephemeral ports that nodes in this node type should be configured with." + }, + "vmSize": { + "type": "string", + "description": "The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3." + }, + "vmImagePublisher": { + "type": "string", + "description": "The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer." + }, + "vmImageOffer": { + "type": "string", + "description": "The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer." + }, + "vmImageSku": { + "type": "string", + "description": "The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter." + }, + "vmImageVersion": { + "type": "string", + "description": "The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'." + }, + "vmSecrets": { + "type": "array", + "title": "virtual machine secretes.", + "description": "The secrets to install in the virtual machines.", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + } + }, + "vmExtensions": { + "type": "array", + "title": "virtual machine extensions.", + "description": "Set of extensions that should be installed onto the virtual machines.", + "items": { + "$ref": "#/definitions/VMSSExtension" + } + }, + "vmManagedIdentity": { + "$ref": "#/definitions/VmManagedIdentity", + "description": "Identities to assign to the virtual machine scale set under the node type." + }, + "isStateless": { + "type": "boolean", + "description": "Indicates if the node type can only host Stateless workloads.", + "default": false + }, + "multiplePlacementGroups": { + "type": "boolean", + "description": "Indicates if scale set associated with the node type can be composed of multiple placement groups.", + "default": false + }, + "frontendConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/FrontendConfiguration" + }, + "description": "Indicates the node type uses its own frontend configurations instead of the default one for the cluster. This setting can only be specified for non-primary node types and can not be added or removed after the node type is created." + }, + "networkSecurityRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityRule" + }, + "description": "The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations." + }, + "provisioningState": { + "$ref": "#/definitions/ManagedResourceProvisioningState", + "readOnly": true, + "description": "The provisioning state of the node type resource." + } + }, + "description": "Describes a node type in the cluster, each node type represents sub set of nodes in the cluster." + }, + "NodeTypeListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "title": "node type list value.", + "description": "The list of node types.", + "items": { + "$ref": "#/definitions/NodeType" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Node type list results" + }, + "NodeTypeUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "description": "Node type update parameters" + }, + "sku": { + "$ref": "#/definitions/NodeTypeSku", + "description": "The node type sku." + }, + "additionalProperties": { + "type": "string" + } + }, + "description": "Node type update request" + }, + "NodeTypeSku": { + "type": "object", + "required": [ + "capacity" + ], + "properties": { + "name": { + "type": "string", + "description": "The sku name.

    Name is internally generated and is used in auto-scale scenarios.
    Property does not allow to be changed to other values than generated.
    To avoid deployment errors please omit the property." + }, + "tier": { + "type": "string", + "description": "Specifies the tier of the node type.

    Possible Values:
    **Standard**" + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "The number of nodes in the node type.

    If present in request it will override properties.vmInstanceCount.", + "minimum": 1, + "maximum": 2147483647 + } + }, + "description": "Describes a node type sku." + }, + "NodeTypeSkuCapacity": { + "type": "object", + "properties": { + "minimum": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "Lowest permitted node count in a node type." + }, + "maximum": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "Highest permitted node count in a node type." + }, + "default": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "Default node count in a node type." + }, + "scaleType": { + "$ref": "#/definitions/NodeTypeSkuScaleType", + "readOnly": true, + "description": "Node type capacity scale type." + } + }, + "description": "Provides information about how node type can be scaled." + }, + "NodeTypeSkuScaleType": { + "type": "string", + "description": "Node type capacity scale type.\n", + "enum": [ + "None", + "Manual", + "Automatic" + ], + "default": "None", + "x-ms-enum": { + "name": "NodeTypeSkuScaleType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Node count is not adjustable in any way (e.g. it is fixed)." + }, + { + "value": "Manual", + "description": "The user must manually scale out/in." + }, + { + "value": "Automatic", + "description": "Automatic scale is allowed." + } + ] + } + }, + "NodeTypeAvailableSku": { + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "readOnly": true, + "description": "The type of resource the sku applies to.

    Value: Microsoft.ServiceFabric/managedClusters/nodeTypes." + }, + "sku": { + "$ref": "#/definitions/NodeTypeSupportedSku", + "description": "The supported SKU for a for node type.", + "readOnly": true + }, + "capacity": { + "$ref": "#/definitions/NodeTypeSkuCapacity", + "description": "Provides information about how the node count can be scaled.", + "readOnly": true + } + }, + "description": "Defines the type of sku available for a node type" + }, + "NodeTypeSupportedSku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The sku name.", + "readOnly": true + }, + "tier": { + "type": "string", + "description": "Specifies the tier of the node type.

    Possible Values:
    **Standard**", + "readOnly": true + } + }, + "description": "Describes a node type supported sku." + }, + "NodeTypeListSkuResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "title": "Node type sku list value.", + "description": "The list of available node type SKUs.", + "items": { + "$ref": "#/definitions/NodeTypeAvailableSku" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Node type available sku list results" + }, + "SubResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Azure resource identifier." + } + }, + "description": "Azure resource identifier.", + "x-ms-azure-resource": true + }, + "VaultCertificate": { + "type": "object", + "required": [ + "certificateUrl", + "certificateStore" + ], + "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\":\"\"
    }" + }, + "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 .crt for the X509 certificate file and .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": { + "type": "object", + "required": [ + "sourceVault", + "vaultCertificates" + ], + "properties": { + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing all of the certificates in VaultCertificates." + }, + "vaultCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultCertificate" + }, + "description": "The list of key vault references in SourceVault which contain certificates." + } + }, + "description": "Specifies set of certificates that should be installed onto the virtual machines." + }, + "VmManagedIdentity": { + "type": "object", + "properties": { + "userAssignedIdentities": { + "type": "array", + "description": "The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "items": { + "type": "string" + } + } + }, + "description": "Identities for the virtual machine scale set under the node type." + }, + "VMSSExtension": { + "type": "object", + "required": [ + "name", + "properties" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the extension." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VMSSExtensionProperties", + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + } + }, + "description": "Specifies set of extensions that should be installed onto the virtual machines." + }, + "VMSSExtensionProperties": { + "type": "object", + "required": [ + "publisher", + "type", + "typeHandlerVersion" + ], + "properties": { + "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." + }, + "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." + }, + "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." + }, + "provisionAfterExtensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Collection of extension names after which this extension needs to be provisioned." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "AvailableOperationDisplay": { + "type": "object", + "properties": { + "provider": { + "type": "string", + "description": "The name of the provider." + }, + "resource": { + "type": "string", + "description": "The resource on which the operation is performed" + }, + "operation": { + "type": "string", + "description": "The operation that can be performed." + }, + "description": { + "type": "string", + "description": "Operation description" + } + }, + "description": "Operation supported by the Service Fabric resource provider" + }, + "EndpointRangeDescription": { + "type": "object", + "required": [ + "endPort", + "startPort" + ], + "properties": { + "startPort": { + "type": "integer", + "format": "int32", + "description": "Starting port of a range of ports" + }, + "endPort": { + "type": "integer", + "format": "int32", + "description": "End port of a range of ports" + } + }, + "description": "Port range details" + }, + "ErrorModel": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorModelError", + "description": "The error details." + } + }, + "description": "The structure of the error." + }, + "ErrorModelError": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "The error details." + }, + "ManagedResourceProvisioningState": { + "type": "string", + "description": "The provisioning state of the managed resource.", + "enum": [ + "None", + "Creating", + "Created", + "Updating", + "Succeeded", + "Failed", + "Canceled", + "Deleting", + "Deleted", + "Other" + ], + "x-ms-enum": { + "name": "ManagedResourceProvisioningState", + "modelAsString": true + } + }, + "NetworkSecurityRule": { + "type": "object", + "required": [ + "name", + "protocol", + "access", + "priority", + "direction" + ], + "properties": { + "name": { + "type": "string", + "description": "Network security rule name." + }, + "description": { + "type": "string", + "description": "Network security rule description." + }, + "protocol": { + "type": "string", + "description": "Network protocol this rule applies to.", + "enum": [ + "http", + "https", + "tcp", + "udp", + "icmp", + "ah", + "esp" + ], + "x-ms-enum": { + "name": "nsgProtocol", + "modelAsString": true + } + }, + "sourceAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The CIDR or source IP ranges." + }, + "destinationAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination address prefixes. CIDR or destination IP ranges." + }, + "sourcePortRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The source port ranges." + }, + "destinationPortRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination port ranges." + }, + "access": { + "type": "string", + "description": "The network traffic is allowed or denied.", + "enum": [ + "allow", + "deny" + ], + "x-ms-enum": { + "name": "access", + "modelAsString": true + } + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.", + "minimum": 1000, + "maximum": 3000 + }, + "direction": { + "type": "string", + "description": "Network security rule direction.", + "enum": [ + "inbound", + "outbound" + ], + "x-ms-enum": { + "name": "direction", + "modelAsString": true + } + } + }, + "description": "Describes a network security rule." + }, + "OperationResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "isDataAction": { + "type": "boolean", + "description": "Indicates whether the operation is a data action" + }, + "display": { + "$ref": "#/definitions/AvailableOperationDisplay", + "description": "The object that represents the operation." + }, + "origin": { + "type": "string", + "description": "Origin result" + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Available operation list result" + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "type": "string", + "description": "The type of identity that created the resource." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)." + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "type": "string", + "description": "The type of identity that last modified the resource." + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)." + } + } + } + }, + "parameters": { + "api-version": { + "name": "api-version", + "in": "query", + "description": "The version of the Service Fabric resource provider API. This is a required parameter and it's value must be \"2021-07-01-preview\" for this specification.", + "required": true, + "type": "string", + "enum": [ + "2021-07-01-preview" + ], + "x-ms-parameter-location": "client" + }, + "clusterNameParameter": { + "name": "clusterName", + "in": "path", + "description": "The name of the cluster resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "nodeTypeNameParameter": { + "name": "nodeTypeName", + "in": "path", + "description": "The name of the node type.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The customer subscription identifier.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/readme.md b/specification/servicefabricmanagedclusters/resource-manager/readme.md index 6fd3361617e7..3ef93cda3d5b 100644 --- a/specification/servicefabricmanagedclusters/resource-manager/readme.md +++ b/specification/servicefabricmanagedclusters/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for the ServiceFabricManagedClustersManagementClie title: ServiceFabricManagedClustersManagementClient description: Service Fabric Managed Clusters Management Client openapi-type: arm -tag: package-2021-05 +tag: package-2021-07-preview directive: - suppress: ListInOperationName @@ -68,6 +68,18 @@ directive: - Currently systemData is not allowed. ``` + +### Tag: package-2021-07-preview + +These settings apply only when `--tag=package-2021-07-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2021-07-preview' +input-file: +- Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/managedapplication.json +- Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/managedcluster.json +- Microsoft.ServiceFabricManagedClusters/preview/2021-07-01-preview/nodetype.json +``` + ### Tag: package-2021-05 These settings apply only when `--tag=package-2021-05` is specified on the command line. diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-04-01-preview/signalr.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-04-01-preview/signalr.json index f0a04bb52784..67f19f4df654 100644 --- a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-04-01-preview/signalr.json +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-04-01-preview/signalr.json @@ -2013,6 +2013,7 @@ "type": "object", "properties": { "clientCertEnabled": { + "default": true, "description": "Request client certificate during TLS handshake if enabled", "type": "boolean" } diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/Operations_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..cf8e44294bcf --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/Operations_List.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.SignalRService/SignalR/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.SignalRService", + "resource": "SignalR", + "operation": "Manage SignalR (read-only)", + "description": "View the resource settings and configurations in the management portal or through API" + }, + "properties": {} + } + ], + "nextLink": "providers/Microsoft.SignalRService?$skipToken={opaqueString}" + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalRPrivateEndpointConnections_Delete.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalRPrivateEndpointConnections_Delete.json new file mode 100644 index 000000000000..e2ab0b876c3d --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalRPrivateEndpointConnections_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "privateEndpointConnectionName": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "204": {} + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalRPrivateEndpointConnections_Get.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalRPrivateEndpointConnections_Get.json new file mode 100644 index 000000000000..138f7e826b85 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalRPrivateEndpointConnections_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "privateEndpointConnectionName": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e" + }, + "responses": { + "200": { + "body": { + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalRPrivateEndpointConnections_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalRPrivateEndpointConnections_List.json new file mode 100644 index 000000000000..6840109221b4 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalRPrivateEndpointConnections_List.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + ] + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalRPrivateEndpointConnections_Update.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalRPrivateEndpointConnections_Update.json new file mode 100644 index 000000000000..eedf21bb54fa --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalRPrivateEndpointConnections_Update.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "parameters": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + } + }, + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "privateEndpointConnectionName": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e" + }, + "responses": { + "200": { + "body": { + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalRPrivateLinkResources_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalRPrivateLinkResources_List.json new file mode 100644 index 000000000000..9334db0fff23 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalRPrivateLinkResources_List.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "signalr", + "requiredMembers": [ + "signalr" + ], + "requiredZoneNames": [ + "privatelink.service.signalr.net" + ], + "shareablePrivateLinkResourceTypes": [ + { + "name": "site", + "properties": { + "description": "Azure App Service can be used as an upstream", + "groupId": "sites", + "type": "Microsoft.Web/sites" + } + } + ] + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateLinkResources/myPrivateLink", + "name": "myPrivateLink", + "type": "privateLinkResources" + } + ], + "nextLink": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToMoreResults..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalRSharedPrivateLinkResources_CreateOrUpdate.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalRSharedPrivateLinkResources_CreateOrUpdate.json new file mode 100644 index 000000000000..511b74c65bcc --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalRSharedPrivateLinkResources_CreateOrUpdate.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "parameters": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "requestMessage": "Please approve" + } + }, + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "sharedPrivateLinkResourceName": "upstream" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + }, + "201": { + "body": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalRSharedPrivateLinkResources_Delete.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalRSharedPrivateLinkResources_Delete.json new file mode 100644 index 000000000000..ae00589bb9cb --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalRSharedPrivateLinkResources_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "sharedPrivateLinkResourceName": "upstream" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "204": {} + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalRSharedPrivateLinkResources_Get.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalRSharedPrivateLinkResources_Get.json new file mode 100644 index 000000000000..6b74303d1d93 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalRSharedPrivateLinkResources_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "sharedPrivateLinkResourceName": "upstream" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalRSharedPrivateLinkResources_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalRSharedPrivateLinkResources_List.json new file mode 100644 index 000000000000..9cc9f65ecb02 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalRSharedPrivateLinkResources_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + ] + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalR_CheckNameAvailability.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalR_CheckNameAvailability.json new file mode 100644 index 000000000000..c9ce595bc81f --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalR_CheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "location": "eastus", + "parameters": { + "type": "Microsoft.SignalRService/SignalR", + "name": "mySignalRService" + }, + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "The name is already taken. Please try a different name." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalR_CreateOrUpdate.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalR_CreateOrUpdate.json new file mode 100644 index 000000000000..322f1c5b55a1 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalR_CreateOrUpdate.json @@ -0,0 +1,345 @@ +{ + "parameters": { + "parameters": { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "capacity": 1 + }, + "properties": { + "tls": { + "clientCertEnabled": false + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + }, + { + "flag": "EnableLiveTrace", + "value": "False", + "properties": {} + } + ], + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "upstream": { + "templates": [ + { + "hubPattern": "*", + "eventPattern": "connect,disconnect", + "categoryPattern": "*", + "urlTemplate": "https://example.com/chat/api/connect", + "auth": { + "type": "ManagedIdentity", + "managedIdentity": { + "resource": "api://example" + } + } + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned" + }, + "location": "eastus", + "tags": { + "key1": "value1" + } + }, + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "size": "S1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mysignalrservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + ], + "tls": { + "clientCertEnabled": true + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + }, + { + "flag": "EnableLiveTrace", + "value": "False", + "properties": {} + } + ], + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "upstream": { + "templates": [ + { + "urlTemplate": "http://foo.com" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR" + } + }, + "201": { + "body": { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "size": "S1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mysignalrservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + ], + "tls": { + "clientCertEnabled": true + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + }, + { + "flag": "EnableLiveTrace", + "value": "False", + "properties": {} + } + ], + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "upstream": { + "templates": [ + { + "urlTemplate": "http://foo.com" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR" + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalR_Delete.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalR_Delete.json new file mode 100644 index 000000000000..d27680b95c42 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalR_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "204": {} + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalR_Get.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalR_Get.json new file mode 100644 index 000000000000..6846e74fa8fc --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalR_Get.json @@ -0,0 +1,131 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "size": "S1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mysignalrservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + ], + "tls": { + "clientCertEnabled": true + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + }, + { + "flag": "EnableLiveTrace", + "value": "False", + "properties": {} + } + ], + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "upstream": { + "templates": [ + { + "urlTemplate": "http://foo.com" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR" + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalR_ListByResourceGroup.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalR_ListByResourceGroup.json new file mode 100644 index 000000000000..9c717b7c8962 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalR_ListByResourceGroup.json @@ -0,0 +1,134 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "size": "S1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mysignalrservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + ], + "tls": { + "clientCertEnabled": true + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + }, + { + "flag": "EnableLiveTrace", + "value": "False", + "properties": {} + } + ], + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "upstream": { + "templates": [ + { + "urlTemplate": "http://foo.com" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR" + } + ] + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalR_ListBySubscription.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalR_ListBySubscription.json new file mode 100644 index 000000000000..1865550ba9e8 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalR_ListBySubscription.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "size": "S1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mysignalrservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + ], + "tls": { + "clientCertEnabled": true + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + }, + { + "flag": "EnableLiveTrace", + "value": "False", + "properties": {} + } + ], + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "upstream": { + "templates": [ + { + "urlTemplate": "http://foo.com" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR" + } + ] + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalR_ListKeys.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalR_ListKeys.json new file mode 100644 index 000000000000..d72d39ad616b --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalR_ListKeys.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalR_RegenerateKey.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalR_RegenerateKey.json new file mode 100644 index 000000000000..587d61c0883b --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalR_RegenerateKey.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "parameters": { + "keyType": "Primary" + }, + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "202": { + "body": {}, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalR_Restart.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalR_Restart.json new file mode 100644 index 000000000000..befb073a5385 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalR_Restart.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "204": {} + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalR_Update.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalR_Update.json new file mode 100644 index 000000000000..5cea9c00c0c6 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/SignalR_Update.json @@ -0,0 +1,220 @@ +{ + "parameters": { + "parameters": { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "capacity": 1 + }, + "properties": { + "tls": { + "clientCertEnabled": false + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + }, + { + "flag": "EnableLiveTrace", + "value": "False", + "properties": {} + } + ], + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "upstream": { + "templates": [ + { + "hubPattern": "*", + "eventPattern": "connect,disconnect", + "categoryPattern": "*", + "urlTemplate": "https://example.com/chat/api/connect", + "auth": { + "type": "ManagedIdentity", + "managedIdentity": { + "resource": "api://example" + } + } + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned" + }, + "location": "eastus", + "tags": { + "key1": "value1" + } + }, + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "size": "S1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mysignalrservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + ], + "tls": { + "clientCertEnabled": true + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + }, + { + "flag": "EnableLiveTrace", + "value": "False", + "properties": {} + } + ], + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "upstream": { + "templates": [ + { + "urlTemplate": "http://foo.com" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/Usages_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/Usages_List.json new file mode 100644 index 000000000000..25d212ccf52b --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/Usages_List.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "location": "eastus", + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SignalRService/locations/eastus/usages/Usage1", + "currentValue": 0, + "limit": 100, + "name": { + "value": "Usage1", + "localizedValue": "Usage1" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SignalRService/locations/eastus/usages/Usage2", + "currentValue": 0, + "limit": 100, + "name": { + "value": "Usage2", + "localizedValue": "Usage2" + }, + "unit": "Count" + } + ], + "nextLink": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToMoreResults..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/signalr.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/signalr.json new file mode 100644 index 000000000000..52912cfbf72e --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/signalr.json @@ -0,0 +1,2260 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01-preview", + "title": "SignalRManagementClient", + "description": "REST API for Azure SignalR Service" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.SignalRService/operations": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Lists all of the available REST API operations of the Microsoft.SignalRService provider.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of operations.", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/checkNameAvailability": { + "post": { + "tags": [ + "SignalR" + ], + "description": "Checks that the resource name is valid and is not already in use.", + "operationId": "SignalR_CheckNameAvailability", + "parameters": [ + { + "name": "location", + "in": "path", + "description": "the region", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Parameters supplied to the operation.", + "required": true, + "schema": { + "$ref": "#/definitions/NameAvailabilityParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the name availability.", + "schema": { + "$ref": "#/definitions/NameAvailability" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalR_CheckNameAvailability": { + "$ref": "./examples/SignalR_CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/usages": { + "get": { + "tags": [ + "SignalR" + ], + "description": "List resource usage quotas by location.", + "operationId": "Usages_List", + "parameters": [ + { + "name": "location", + "in": "path", + "description": "the location like \"eastus\"", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the usage quotas of a subscription in specified region.", + "schema": { + "$ref": "#/definitions/SignalRUsageList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Usages_List": { + "$ref": "./examples/Usages_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/signalR": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Handles requests to list all resources in a subscription.", + "operationId": "SignalR_ListBySubscription", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of resources in the subscription.", + "schema": { + "$ref": "#/definitions/SignalRResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SignalR_ListBySubscription": { + "$ref": "./examples/SignalR_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Handles requests to list all resources in a resource group.", + "operationId": "SignalR_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of resources in a resourceGroup.", + "schema": { + "$ref": "#/definitions/SignalRResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SignalR_ListByResourceGroup": { + "$ref": "./examples/SignalR_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Get the resource and its properties.", + "operationId": "SignalR_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding resource.", + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalR_Get": { + "$ref": "./examples/SignalR_Get.json" + } + } + }, + "put": { + "tags": [ + "SignalR" + ], + "description": "Create or update a resource.", + "operationId": "SignalR_CreateOrUpdate", + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a resource.", + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + "201": { + "description": "Created. The response describes the new resource and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting resource is now updating and contains a Location header to query the operation result.." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SignalR_CreateOrUpdate": { + "$ref": "./examples/SignalR_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "SignalR" + ], + "description": "Operation to delete a resource.", + "operationId": "SignalR_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the resource is already deleted." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the resource is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SignalR_Delete": { + "$ref": "./examples/SignalR_Delete.json" + } + } + }, + "patch": { + "tags": [ + "SignalR" + ], + "description": "Operation to update an exiting resource.", + "operationId": "SignalR_Update", + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a resource.", + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting resource is now updating and contains a Location header to query the operation result.." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SignalR_Update": { + "$ref": "./examples/SignalR_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/listKeys": { + "post": { + "tags": [ + "SignalR" + ], + "description": "Get the access keys of the resource.", + "operationId": "SignalR_ListKeys", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes access keys of the resource.", + "schema": { + "$ref": "#/definitions/SignalRKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalR_ListKeys": { + "$ref": "./examples/SignalR_ListKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "SignalR" + ], + "description": "List private endpoint connections", + "operationId": "SignalRPrivateEndpointConnections_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a list of private endpoint connections.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SignalRPrivateEndpointConnections_List": { + "$ref": "./examples/SignalRPrivateEndpointConnections_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Get the specified private endpoint connection", + "operationId": "SignalRPrivateEndpointConnections_Get", + "parameters": [ + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a private endpoint connection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalRPrivateEndpointConnections_Get": { + "$ref": "./examples/SignalRPrivateEndpointConnections_Get.json" + } + } + }, + "put": { + "tags": [ + "SignalR" + ], + "description": "Update the state of specified private endpoint connection", + "operationId": "SignalRPrivateEndpointConnections_Update", + "parameters": [ + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The resource of private endpoint and its properties", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "OK. The response indicates the private endpoint connection is updated successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalRPrivateEndpointConnections_Update": { + "$ref": "./examples/SignalRPrivateEndpointConnections_Update.json" + } + } + }, + "delete": { + "tags": [ + "SignalR" + ], + "description": "Delete the specified private endpoint connection", + "operationId": "SignalRPrivateEndpointConnections_Delete", + "parameters": [ + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the resource is already deleted." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the private endpoint connection is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SignalRPrivateEndpointConnections_Delete": { + "$ref": "./examples/SignalRPrivateEndpointConnections_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Get the private link resources that need to be created for a resource.", + "operationId": "SignalRPrivateLinkResources_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a list of private link resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SignalRPrivateLinkResources_List": { + "$ref": "./examples/SignalRPrivateLinkResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/regenerateKey": { + "post": { + "tags": [ + "SignalR" + ], + "description": "Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.", + "operationId": "SignalR_RegenerateKey", + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "Parameter that describes the Regenerate Key Operation.", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateKeyParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "202": { + "description": "Accepted and an async operation is executing in background to make the new key to take effect. The response contains new access keys and a Location header to query the async operation result.", + "schema": { + "$ref": "#/definitions/SignalRKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "SignalR_RegenerateKey": { + "$ref": "./examples/SignalR_RegenerateKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/restart": { + "post": { + "tags": [ + "SignalR" + ], + "description": "Operation to restart a resource.", + "operationId": "SignalR_Restart", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the restart operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the operation is successful and no content will be returned." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "SignalR_Restart": { + "$ref": "./examples/SignalR_Restart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/sharedPrivateLinkResources": { + "get": { + "tags": [ + "SignalR" + ], + "description": "List shared private link resources", + "operationId": "SignalRSharedPrivateLinkResources_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a list of shared private link resources.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SignalRSharedPrivateLinkResources_List": { + "$ref": "./examples/SignalRSharedPrivateLinkResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Get the specified shared private link resource", + "operationId": "SignalRSharedPrivateLinkResources_Get", + "parameters": [ + { + "name": "sharedPrivateLinkResourceName", + "in": "path", + "description": "The name of the shared private link resource", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a shared private link resource.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalRSharedPrivateLinkResources_Get": { + "$ref": "./examples/SignalRSharedPrivateLinkResources_Get.json" + } + } + }, + "put": { + "tags": [ + "SignalR" + ], + "description": "Create or update a shared private link resource", + "operationId": "SignalRSharedPrivateLinkResources_CreateOrUpdate", + "parameters": [ + { + "name": "sharedPrivateLinkResourceName", + "in": "path", + "description": "The name of the shared private link resource", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The shared private link resource", + "required": true, + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "OK. The response indicates the shared private link resource is updated.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "201": { + "description": "Created. The response indicates the shared private link resource is created.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SignalRSharedPrivateLinkResources_CreateOrUpdate": { + "$ref": "./examples/SignalRSharedPrivateLinkResources_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "SignalR" + ], + "description": "Delete the specified shared private link resource", + "operationId": "SignalRSharedPrivateLinkResources_Delete", + "parameters": [ + { + "name": "sharedPrivateLinkResourceName", + "in": "path", + "description": "The name of the shared private link resource", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the resource is already deleted." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the private endpoint connection is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SignalRSharedPrivateLinkResources_Delete": { + "$ref": "./examples/SignalRSharedPrivateLinkResources_Delete.json" + } + } + } + } + }, + "definitions": { + "ACLAction": { + "description": "Default action when no other rule matches", + "enum": [ + "Allow", + "Deny" + ], + "type": "string", + "x-ms-enum": { + "name": "ACLAction", + "modelAsString": true + } + }, + "Dimension": { + "description": "Specifications of the Dimension of metrics.", + "type": "object", + "properties": { + "name": { + "description": "The public facing name of the dimension.", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the dimension.", + "type": "string" + }, + "internalName": { + "description": "Name of the dimension as it appears in MDM.", + "type": "string" + }, + "toBeExportedForShoebox": { + "description": "A Boolean flag indicating whether this dimension should be included for the shoebox export scenario.", + "type": "boolean" + } + } + }, + "FeatureFlags": { + "description": "FeatureFlags is the supported features of Azure SignalR service.\r\n- ServiceMode: Flag for backend server for SignalR service. Values allowed: \"Default\": have your own backend server; \"Serverless\": your application doesn't have a backend server; \"Classic\": for backward compatibility. Support both Default and Serverless mode but not recommended; \"PredefinedOnly\": for future use.\r\n- EnableConnectivityLogs: \"true\"/\"false\", to enable/disable the connectivity log category respectively.\r\n- EnableMessagingLogs: \"true\"/\"false\", to enable/disable the connectivity log category respectively.\r\n- EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: \"true\"/\"false\", to enable/disable live trace feature.", + "enum": [ + "ServiceMode", + "EnableConnectivityLogs", + "EnableMessagingLogs", + "EnableLiveTrace" + ], + "type": "string", + "x-ms-enum": { + "name": "FeatureFlags", + "modelAsString": true + } + }, + "KeyType": { + "description": "The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive).", + "enum": [ + "Primary", + "Secondary" + ], + "type": "string", + "x-ms-enum": { + "name": "KeyType", + "modelAsString": true + } + }, + "LogSpecification": { + "description": "Specifications of the Logs 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" + } + } + }, + "ManagedIdentity": { + "description": "A class represent managed identities used for request and response", + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/ManagedIdentityType", + "description": "Represent the identity type: systemAssigned, userAssigned, None" + }, + "userAssignedIdentities": { + "description": "Get or set the user assigned identities", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentityProperty" + } + }, + "principalId": { + "description": "Get the principal id for the system assigned identity.\r\nOnly be used in response.", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "Get the tenant id for the system assigned identity.\r\nOnly be used in response", + "type": "string", + "readOnly": true + } + } + }, + "ManagedIdentitySettings": { + "description": "Managed identity settings for upstream.", + "type": "object", + "properties": { + "resource": { + "description": "The Resource indicating the App ID URI of the target resource.\r\nIt also appears in the aud (audience) claim of the issued token.", + "type": "string" + } + } + }, + "ManagedIdentityType": { + "description": "Represent the identity type: systemAssigned, userAssigned, None", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedIdentityType", + "modelAsString": true + } + }, + "MetricSpecification": { + "description": "Specifications of the Metrics for Azure Monitoring.", + "type": "object", + "properties": { + "name": { + "description": "Name of the metric.", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the metric.", + "type": "string" + }, + "displayDescription": { + "description": "Localized friendly description of the metric.", + "type": "string" + }, + "unit": { + "description": "The unit that makes sense for the metric.", + "type": "string" + }, + "aggregationType": { + "description": "Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.", + "type": "string" + }, + "fillGapWithZero": { + "description": "Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published. \r\nEx. a metric that returns the number of times a particular error code was emitted. The error code may not appear \r\noften, instead of the RP publishing 0, Shoebox can auto fill in 0s for time periods where nothing was emitted.", + "type": "string" + }, + "category": { + "description": "The name of the metric category that the metric belongs to. A metric can only belong to a single category.", + "type": "string" + }, + "dimensions": { + "description": "The dimensions of the metrics.", + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + } + } + } + }, + "NameAvailability": { + "description": "Result of the request to check name availability. It contains a flag and possible reason of failure.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "Indicates whether the name is available or not.", + "type": "boolean" + }, + "reason": { + "description": "The reason of the availability. Required if name is not available.", + "type": "string" + }, + "message": { + "description": "The message of the operation.", + "type": "string" + } + } + }, + "NameAvailabilityParameters": { + "description": "Data POST-ed to the nameAvailability action", + "required": [ + "type", + "name" + ], + "type": "object", + "properties": { + "type": { + "description": "The resource type. Can be \"Microsoft.SignalRService/SignalR\" or \"Microsoft.SignalRService/webPubSub\"", + "type": "string" + }, + "name": { + "description": "The resource name to validate. e.g.\"my-resource-name\"", + "type": "string" + } + } + }, + "NetworkACL": { + "description": "Network ACL", + "type": "object", + "properties": { + "allow": { + "description": "Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRRequestType" + } + }, + "deny": { + "description": "Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRRequestType" + } + } + } + }, + "Operation": { + "description": "REST API operation supported by resource provider.", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation with format: {provider}/{resource}/{operation}", + "type": "string" + }, + "isDataAction": { + "description": "If the operation is a data action. (for data plane rbac)", + "type": "boolean" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "The object that describes the operation." + }, + "origin": { + "description": "Optional. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Extra properties for the operation.", + "x-ms-client-flatten": false + } + } + }, + "OperationDisplay": { + "description": "The object that describes a operation.", + "type": "object", + "properties": { + "provider": { + "description": "Friendly name of the resource provider", + "type": "string" + }, + "resource": { + "description": "Resource type on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "The localized friendly name for the operation.", + "type": "string" + }, + "description": { + "description": "The localized friendly description for the operation", + "type": "string" + } + } + }, + "OperationList": { + "description": "Result of the request to list REST API operations. It contains a list of operations.", + "type": "object", + "properties": { + "value": { + "description": "List of operations supported by the resource provider.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "OperationProperties": { + "description": "Extra Operation properties.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "The service specifications." + } + } + }, + "PrivateEndpoint": { + "description": "Private endpoint", + "type": "object", + "properties": { + "id": { + "description": "Full qualified Id of the private endpoint", + "type": "string" + } + } + }, + "PrivateEndpointACL": { + "description": "ACL for a private endpoint", + "required": [ + "name" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkACL" + } + ], + "properties": { + "name": { + "description": "Name of the private endpoint connection", + "type": "string" + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection to an azure resource", + "type": "object", + "allOf": [ + { + "$ref": "#/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.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Properties of the private endpoint connection", + "x-ms-client-flatten": true + } + } + }, + "PrivateEndpointConnectionList": { + "description": "A list of private endpoint connections", + "type": "object", + "properties": { + "value": { + "description": "The list of the private endpoint connections", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "description": "Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size.", + "type": "string" + } + } + }, + "PrivateEndpointConnectionProperties": { + "description": "Private endpoint connection properties", + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the private endpoint connection", + "readOnly": true + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "Private endpoint associated with the private endpoint connection" + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "Connection state" + } + } + }, + "PrivateLinkResource": { + "description": "Private link resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Properties of a private link resource", + "x-ms-client-flatten": true + } + } + }, + "PrivateLinkResourceList": { + "description": "Contains a list of PrivateLinkResource and a possible link to query more results", + "type": "object", + "properties": { + "value": { + "description": "List of PrivateLinkResource", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "PrivateLinkResourceProperties": { + "description": "Private link resource properties", + "type": "object", + "properties": { + "groupId": { + "description": "Group Id of the private link resource", + "type": "string" + }, + "requiredMembers": { + "description": "Required members of the private link resource", + "type": "array", + "items": { + "type": "string" + } + }, + "requiredZoneNames": { + "description": "Required private DNS zone names", + "type": "array", + "items": { + "type": "string" + } + }, + "shareablePrivateLinkResourceTypes": { + "description": "The list of resources that are onboarded to private link service", + "type": "array", + "items": { + "$ref": "#/definitions/ShareablePrivateLinkResourceType" + } + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "Connection state of the private endpoint connection", + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/PrivateLinkServiceConnectionStatus", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + }, + "description": { + "description": "The reason for approval/rejection of the connection.", + "type": "string" + }, + "actionsRequired": { + "description": "A message indicating if changes on the service provider require any updates on the consumer.", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionStatus": { + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateLinkServiceConnectionStatus", + "modelAsString": true + } + }, + "ProvisioningState": { + "description": "Provisioning state of the resource.", + "enum": [ + "Unknown", + "Succeeded", + "Failed", + "Canceled", + "Running", + "Creating", + "Updating", + "Deleting", + "Moving" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "ProxyResource": { + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": {} + }, + "RegenerateKeyParameters": { + "description": "Parameters describes the request to regenerate access keys", + "type": "object", + "properties": { + "keyType": { + "$ref": "#/definitions/KeyType", + "description": "The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive)." + } + } + }, + "Resource": { + "description": "The core properties of ARM resources.", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified resource Id for the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource - e.g. \"Microsoft.SignalRService/SignalR\"", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "ResourceSku": { + "description": "The billing information of the resource.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1", + "type": "string" + }, + "tier": { + "$ref": "#/definitions/SignalRSkuTier", + "description": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead." + }, + "size": { + "description": "Not used. Retained for future use.", + "type": "string", + "readOnly": true + }, + "family": { + "description": "Not used. Retained for future use.", + "type": "string", + "readOnly": true + }, + "capacity": { + "format": "int32", + "description": "Optional, integer. The unit count of the resource. 1 by default.\r\n\r\nIf present, following values are allowed:\r\n Free: 1\r\n Standard: 1,2,5,10,20,50,100", + "type": "integer" + } + } + }, + "ServerlessUpstreamSettings": { + "description": "The settings for the Upstream when the service is in server-less mode.", + "type": "object", + "properties": { + "templates": { + "description": "Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects.", + "type": "array", + "items": { + "$ref": "#/definitions/UpstreamTemplate" + } + } + } + }, + "ServiceKind": { + "description": "The kind of the service - e.g. \"SignalR\" for \"Microsoft.SignalRService/SignalR\"", + "enum": [ + "SignalR", + "RawWebSockets" + ], + "type": "string", + "x-ms-enum": { + "name": "ServiceKind", + "modelAsString": true + } + }, + "ServiceSpecification": { + "description": "An object that describes a specification.", + "type": "object", + "properties": { + "metricSpecifications": { + "description": "Specifications of the Metrics for Azure Monitoring.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + } + }, + "logSpecifications": { + "description": "Specifications of the Logs for Azure Monitoring.", + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + } + } + } + }, + "ShareablePrivateLinkResourceProperties": { + "description": "Describes the properties of a resource type that has been onboarded to private link service", + "type": "object", + "properties": { + "description": { + "description": "The description of the resource type that has been onboarded to private link service", + "type": "string" + }, + "groupId": { + "description": "The resource provider group id for the resource that has been onboarded to private link service", + "type": "string" + }, + "type": { + "description": "The resource provider type for the resource that has been onboarded to private link service", + "type": "string" + } + } + }, + "ShareablePrivateLinkResourceType": { + "description": "Describes a resource type that has been onboarded to private link service", + "type": "object", + "properties": { + "name": { + "description": "The name of the resource type that has been onboarded to private link service", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/ShareablePrivateLinkResourceProperties", + "description": "Describes the properties of a resource type that has been onboarded to private link service" + } + } + }, + "SharedPrivateLinkResource": { + "description": "Describes a Shared Private Link Resource", + "type": "object", + "allOf": [ + { + "$ref": "#/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.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/SharedPrivateLinkResourceProperties", + "description": "Describes the properties of a Shared Private Link Resource", + "x-ms-client-flatten": true + } + } + }, + "SharedPrivateLinkResourceList": { + "description": "A list of shared private link resources", + "type": "object", + "properties": { + "value": { + "description": "The list of the shared private link resources", + "type": "array", + "items": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "nextLink": { + "description": "Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size.", + "type": "string" + } + } + }, + "SharedPrivateLinkResourceProperties": { + "description": "Describes the properties of an existing Shared Private Link Resource", + "required": [ + "groupId", + "privateLinkResourceId" + ], + "type": "object", + "properties": { + "groupId": { + "description": "The group id from the provider of resource the shared private link resource is for", + "type": "string" + }, + "privateLinkResourceId": { + "description": "The resource id of the resource the shared private link resource is for", + "type": "string" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the shared private link resource", + "readOnly": true + }, + "requestMessage": { + "description": "The request message for requesting approval of the shared private link resource", + "type": "string" + }, + "status": { + "$ref": "#/definitions/SharedPrivateLinkResourceStatus", + "description": "Status of the shared private link resource", + "readOnly": true + } + } + }, + "SharedPrivateLinkResourceStatus": { + "description": "Status of the shared private link resource", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected", + "Timeout" + ], + "type": "string", + "x-ms-enum": { + "name": "SharedPrivateLinkResourceStatus", + "modelAsString": true + } + }, + "SignalRCorsSettings": { + "description": "Cross-Origin Resource Sharing (CORS) settings.", + "type": "object", + "properties": { + "allowedOrigins": { + "description": "Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use \"*\" to allow all. If omitted, allow all by default.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SignalRFeature": { + "description": "Feature of a resource, which controls the runtime behavior.", + "required": [ + "flag", + "value" + ], + "type": "object", + "properties": { + "flag": { + "$ref": "#/definitions/FeatureFlags", + "description": "FeatureFlags is the supported features of Azure SignalR service.\r\n- ServiceMode: Flag for backend server for SignalR service. Values allowed: \"Default\": have your own backend server; \"Serverless\": your application doesn't have a backend server; \"Classic\": for backward compatibility. Support both Default and Serverless mode but not recommended; \"PredefinedOnly\": for future use.\r\n- EnableConnectivityLogs: \"true\"/\"false\", to enable/disable the connectivity log category respectively.\r\n- EnableMessagingLogs: \"true\"/\"false\", to enable/disable the connectivity log category respectively.\r\n- EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: \"true\"/\"false\", to enable/disable live trace feature." + }, + "value": { + "description": "Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "properties": { + "description": "Optional properties related to this feature.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SignalRKeys": { + "description": "A class represents the access keys of the resource.", + "type": "object", + "properties": { + "primaryKey": { + "description": "The primary access key.", + "type": "string", + "x-ms-secret": true, + "x-ms-mutability": [ + "create", + "update" + ] + }, + "secondaryKey": { + "description": "The secondary access key.", + "type": "string", + "x-ms-secret": true, + "x-ms-mutability": [ + "create", + "update" + ] + }, + "primaryConnectionString": { + "description": "Connection string constructed via the primaryKey", + "type": "string", + "x-ms-secret": true, + "x-ms-mutability": [ + "create", + "update" + ] + }, + "secondaryConnectionString": { + "description": "Connection string constructed via the secondaryKey", + "type": "string", + "x-ms-secret": true, + "x-ms-mutability": [ + "create", + "update" + ] + } + } + }, + "SignalRNetworkACLs": { + "description": "Network ACLs for the resource", + "type": "object", + "properties": { + "defaultAction": { + "$ref": "#/definitions/ACLAction", + "description": "Default action when no other rule matches", + "default": "Deny" + }, + "publicNetwork": { + "$ref": "#/definitions/NetworkACL", + "description": "ACL for requests from public network" + }, + "privateEndpoints": { + "description": "ACLs for requests from private endpoints", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointACL" + } + } + } + }, + "SignalRProperties": { + "description": "A class that describes the properties of the resource", + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "externalIP": { + "description": "The publicly accessible IP of the resource.", + "type": "string", + "readOnly": true + }, + "hostName": { + "description": "FQDN of the service instance.", + "type": "string", + "readOnly": true + }, + "publicPort": { + "format": "int32", + "description": "The publicly accessible port of the resource which is designed for browser/client side usage.", + "type": "integer", + "readOnly": true + }, + "serverPort": { + "format": "int32", + "description": "The publicly accessible port of the resource which is designed for customer server side usage.", + "type": "integer", + "readOnly": true + }, + "version": { + "description": "Version of the resource. Probably you need the same or higher version of client SDKs.", + "type": "string", + "readOnly": true + }, + "privateEndpointConnections": { + "description": "Private endpoint connections to the resource.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "sharedPrivateLinkResources": { + "description": "The list of shared private link resources.", + "type": "array", + "items": { + "$ref": "#/definitions/SharedPrivateLinkResource" + }, + "readOnly": true + }, + "tls": { + "$ref": "#/definitions/SignalRTlsSettings", + "description": "TLS settings." + }, + "features": { + "description": "List of the featureFlags.\r\n\r\nFeatureFlags that are not included in the parameters for the update operation will not be modified.\r\nAnd the response will only include featureFlags that are explicitly set. \r\nWhen a featureFlag is not explicitly set, its globally default value will be used\r\nBut keep in mind, the default value doesn't mean \"false\". It varies in terms of different FeatureFlags.", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRFeature" + } + }, + "cors": { + "$ref": "#/definitions/SignalRCorsSettings", + "description": "Cross-Origin Resource Sharing (CORS) settings." + }, + "upstream": { + "$ref": "#/definitions/ServerlessUpstreamSettings", + "description": "Upstream settings when the service is in server-less mode." + }, + "networkACLs": { + "$ref": "#/definitions/SignalRNetworkACLs", + "description": "Network ACLs" + }, + "publicNetworkAccess": { + "description": "Enable or disable public network access. Default to \"Enabled\".\r\nWhen it's Enabled, network ACLs still apply.\r\nWhen it's Disabled, public network access is always disabled no matter what you set in network ACLs.", + "default": "Enabled", + "type": "string" + }, + "disableLocalAuth": { + "description": "DisableLocalAuth\r\nEnable or disable local auth with AccessKey\r\nWhen set as true, connection with AccessKey=xxx won't work.", + "default": false, + "type": "boolean" + }, + "disableAadAuth": { + "description": "DisableLocalAuth\r\nEnable or disable aad auth\r\nWhen set as true, connection with AuthType=aad won't work.", + "default": false, + "type": "boolean" + } + } + }, + "SignalRRequestType": { + "description": "Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.", + "enum": [ + "ClientConnection", + "ServerConnection", + "RESTAPI", + "Trace" + ], + "type": "string", + "x-ms-enum": { + "name": "SignalRRequestType", + "modelAsString": true + } + }, + "SignalRResource": { + "description": "A class represent a resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "sku": { + "$ref": "#/definitions/ResourceSku", + "description": "The billing information of the resource.(e.g. Free, Standard)" + }, + "properties": { + "$ref": "#/definitions/SignalRProperties", + "description": "Settings used to provision or configure the resource", + "x-ms-client-flatten": true + }, + "kind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of the service - e.g. \"SignalR\" for \"Microsoft.SignalRService/SignalR\"", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "identity": { + "$ref": "#/definitions/ManagedIdentity", + "description": "The managed identity response" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + } + }, + "SignalRResourceList": { + "description": "Object that includes an array of resources and a possible link for next set.", + "type": "object", + "properties": { + "value": { + "description": "List of the resources", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRResource" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "SignalRSkuTier": { + "description": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead.", + "enum": [ + "Free", + "Basic", + "Standard", + "Premium" + ], + "type": "string", + "x-ms-enum": { + "name": "SignalRSkuTier", + "modelAsString": true + } + }, + "SignalRTlsSettings": { + "description": "TLS settings for the resource", + "type": "object", + "properties": { + "clientCertEnabled": { + "description": "Request client certificate during TLS handshake if enabled", + "default": true, + "type": "boolean" + } + } + }, + "SignalRUsage": { + "description": "Object that describes a specific usage of the resources.", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified ARM resource id", + "type": "string" + }, + "currentValue": { + "format": "int64", + "description": "Current value for the usage quota.", + "type": "integer" + }, + "limit": { + "format": "int64", + "description": "The maximum permitted value for the usage quota. If there is no limit, this value will be -1.", + "type": "integer" + }, + "name": { + "$ref": "#/definitions/SignalRUsageName", + "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" + } + } + }, + "SignalRUsageList": { + "description": "Object that includes an array of the resource usages and a possible link for next set.", + "type": "object", + "properties": { + "value": { + "description": "List of the resource usages", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRUsage" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "SignalRUsageName": { + "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" + } + } + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "description": "The GEO location of the resource. e.g. West US | East US | North Central US | South Central US.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "description": "Tags of the service which is a list of key value pairs that describe the resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "UpstreamAuthSettings": { + "description": "Upstream auth settings.", + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/UpstreamAuthType", + "description": "Gets or sets the type of auth. None or ManagedIdentity is supported now." + }, + "managedIdentity": { + "$ref": "#/definitions/ManagedIdentitySettings", + "description": "Gets or sets the managed identity settings. It's required if the auth type is set to ManagedIdentity." + } + } + }, + "UpstreamAuthType": { + "description": "Gets or sets the type of auth. None or ManagedIdentity is supported now.", + "enum": [ + "None", + "ManagedIdentity" + ], + "type": "string", + "x-ms-enum": { + "name": "UpstreamAuthType", + "modelAsString": true + } + }, + "UpstreamTemplate": { + "description": "Upstream template item settings. It defines the Upstream URL of the incoming requests.\r\nThe template defines the pattern of the event, the hub or the category of the incoming request that matches current URL template.", + "required": [ + "urlTemplate" + ], + "type": "object", + "properties": { + "hubPattern": { + "description": "Gets or sets the matching pattern for hub names. If not set, it matches any hub.\r\nThere are 3 kind of patterns supported:\r\n 1. \"*\", it to matches any hub name\r\n 2. Combine multiple hubs with \",\", for example \"hub1,hub2\", it matches \"hub1\" and \"hub2\"\r\n 3. The single hub name, for example, \"hub1\", it matches \"hub1\"", + "type": "string" + }, + "eventPattern": { + "description": "Gets or sets the matching pattern for event names. If not set, it matches any event.\r\nThere are 3 kind of patterns supported:\r\n 1. \"*\", it to matches any event name\r\n 2. Combine multiple events with \",\", for example \"connect,disconnect\", it matches event \"connect\" and \"disconnect\"\r\n 3. The single event name, for example, \"connect\", it matches \"connect\"", + "type": "string" + }, + "categoryPattern": { + "description": "Gets or sets the matching pattern for category names. If not set, it matches any category.\r\nThere are 3 kind of patterns supported:\r\n 1. \"*\", it to matches any category name\r\n 2. Combine multiple categories with \",\", for example \"connections,messages\", it matches category \"connections\" and \"messages\"\r\n 3. The single category name, for example, \"connections\", it matches the category \"connections\"", + "type": "string" + }, + "urlTemplate": { + "description": "Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in.\r\nFor example, if the urlTemplate is `http://example.com/{hub}/api/{event}`, with a client request from hub `chat` connects, it will first POST to this URL: `http://example.com/chat/api/connect`.", + "type": "string" + }, + "auth": { + "$ref": "#/definitions/UpstreamAuthSettings", + "description": "Gets or sets the auth settings for an upstream. If not set, no auth is used for upstream messages." + } + } + }, + "UserAssignedIdentityProperty": { + "description": "Properties of user assigned identity.", + "type": "object", + "properties": { + "principalId": { + "description": "Get the principal id for the user assigned identity", + "type": "string", + "readOnly": true + }, + "clientId": { + "description": "Get the client id for the user assigned identity", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string" + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "required": true, + "type": "string" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ResourceName": { + "name": "resourceName", + "in": "path", + "description": "The name of the resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/signalr.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/signalr.json index 0083c536e227..8d70306668fe 100644 --- a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/signalr.json +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/signalr.json @@ -1418,7 +1418,8 @@ "enum": [ "ClientConnection", "ServerConnection", - "RESTAPI" + "RESTAPI", + "Trace" ], "type": "string", "x-ms-enum": { diff --git a/specification/signalr/resource-manager/readme.go.md b/specification/signalr/resource-manager/readme.go.md index fa617e1179e2..4451d33bb57e 100644 --- a/specification/signalr/resource-manager/readme.go.md +++ b/specification/signalr/resource-manager/readme.go.md @@ -18,6 +18,7 @@ batch: - tag: package-2020-05-01 - tag: package-2020-07-01-preview - tag: package-2021-04-01-preview + - tag: package-2021-06-01-preview ``` ### Tag: package-2018-03-01-preview and go @@ -64,3 +65,12 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2021-06-01-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2021-06-01-preview/$(namespace) +``` diff --git a/specification/signalr/resource-manager/readme.java.md b/specification/signalr/resource-manager/readme.java.md index 7416fe504997..563d9c27c1a7 100644 --- a/specification/signalr/resource-manager/readme.java.md +++ b/specification/signalr/resource-manager/readme.java.md @@ -21,8 +21,23 @@ batch: - tag: package-2020-05-01 - tag: package-2020-07-01-preview - tag: package-2021-04-01-preview + - tag: package-2021-06-01-preview ``` +### Tag: package-2021-06-01-preview and java + +These settings apply only when `--tag=package-2021-06-01-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2021-04-01-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.signalr.v2021_06_01_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/signalr/mgmt-v2021_06_01_preview +regenerate-manager: true +generate-interface: true +``` + + ### Tag: package-2021-04-01-preview and java These settings apply only when `--tag=package-2021-04-01-preview --java` is specified on the command line. diff --git a/specification/signalr/resource-manager/readme.md b/specification/signalr/resource-manager/readme.md index 3767b22ed260..1fa27c8aedfa 100644 --- a/specification/signalr/resource-manager/readme.md +++ b/specification/signalr/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the SignalR API. ``` yaml openapi-type: arm -tag: package-2021-04-01-preview +tag: package-2021-06-01-preview ``` ### Suppression @@ -56,6 +56,16 @@ directive: reason: It's indeed an UPDATE operation, but PUT is required per NRP requirement. ``` + +### Tag: package-2021-06-01-preview + +These settings apply only when `--tag=package-2021-06-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2021-06-01-preview' +input-file: +- Microsoft.SignalRService/preview/2021-06-01-preview/signalr.json +``` + ### Tag: package-2021-04-01-preview These settings apply only when `--tag=package-2021-04-01-preview` is specified on the command line. @@ -113,7 +123,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-node diff --git a/specification/signalr/resource-manager/readme.python.md b/specification/signalr/resource-manager/readme.python.md index 710f800cb849..993cebf285ce 100644 --- a/specification/signalr/resource-manager/readme.python.md +++ b/specification/signalr/resource-manager/readme.python.md @@ -4,36 +4,16 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.signalr - package-name: azure-mgmt-signalr - package-version: 0.2.0 - clear-output-folder: true -``` ``` yaml $(python) && $(track2) python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.signalr package-name: azure-mgmt-signalr -package-version: 0.2.0 +package-version: 1.0.0b1 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/signalr/azure-mgmt-signalr/azure/mgmt/signalr -``` -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/signalr/azure-mgmt-signalr -``` + ``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/signalr/azure-mgmt-signalr/azure/mgmt/signalr diff --git a/specification/signalr/resource-manager/readme.ruby.md b/specification/signalr/resource-manager/readme.ruby.md index 7cd18969089b..c776fa84004e 100644 --- a/specification/signalr/resource-manager/readme.ruby.md +++ b/specification/signalr/resource-manager/readme.ruby.md @@ -17,8 +17,20 @@ batch: - tag: package-2020-05-01 - tag: package-2020-07-01-preview - tag: package-2021-04-01-preview + - tag: package-2021-06-01-preview ``` +### Tag: package-2021-06-01-preview and ruby + +These settings apply only when `--tag=package-2021-06-01-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2021-06-01-preview' && $(ruby) +namespace: "Azure::Signalr::Mgmt::V2021_06_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_signalr/lib +``` + + ### Tag: package-2021-04-01-preview and ruby These settings apply only when `--tag=package-2021-04-01-preview --ruby` is specified on the command line. diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-11-01-preview/ManagedInstances.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-11-01-preview/ManagedInstances.json index 84c7e9cb35ab..0f5cf17099fb 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-11-01-preview/ManagedInstances.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-11-01-preview/ManagedInstances.json @@ -580,44 +580,6 @@ } } }, - "ResourceIdentityWithUserAssignedIdentities": { - "description": "Azure Active Directory identity configuration for a resource.", - "type": "object", - "properties": { - "userAssignedIdentities": { - "description": "The resource ids of the user assigned identities to use", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/UserIdentity" - } - }, - "principalId": { - "format": "uuid", - "description": "The Azure Active Directory principal id.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.", - "enum": [ - "None", - "SystemAssigned", - "UserAssigned" - ], - "type": "string", - "x-ms-enum": { - "name": "IdentityType", - "modelAsString": true - } - }, - "tenantId": { - "format": "uuid", - "description": "The Azure Active Directory tenant id.", - "type": "string", - "readOnly": true - } - } - }, "ManagedInstanceProperties": { "description": "The properties of a managed instance.", "type": "object", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-11-01-preview/Servers.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-11-01-preview/Servers.json index b99f6785495b..6d3b4a863bb8 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-11-01-preview/Servers.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-11-01-preview/Servers.json @@ -431,44 +431,6 @@ } } }, - "ResourceIdentityWithUserAssignedIdentities": { - "description": "Azure Active Directory identity configuration for a resource.", - "type": "object", - "properties": { - "userAssignedIdentities": { - "description": "The resource ids of the user assigned identities to use", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/UserIdentity" - } - }, - "principalId": { - "format": "uuid", - "description": "The Azure Active Directory principal id.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.", - "enum": [ - "None", - "SystemAssigned", - "UserAssigned" - ], - "type": "string", - "x-ms-enum": { - "name": "IdentityType", - "modelAsString": true - } - }, - "tenantId": { - "format": "uuid", - "description": "The Azure Active Directory tenant id.", - "type": "string", - "readOnly": true - } - } - }, "ServerProperties": { "description": "The properties of a server.", "type": "object", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/BackupShortTermRetentionPolicies.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/BackupShortTermRetentionPolicies.json index 5e6a3238e7a2..36879630a33e 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/BackupShortTermRetentionPolicies.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/BackupShortTermRetentionPolicies.json @@ -125,7 +125,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 InvalidDiffBackupIntervalHours - The differential backup interval hours of {0} is not a valid configuration. Valid differential backup interval must be {1} hours.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." }, "202": { "description": "Accepted" @@ -192,7 +192,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 InvalidDiffBackupIntervalHours - The differential backup interval hours of {0} is not a valid configuration. Valid differential backup interval must be {1} hours.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." }, "202": { "description": "Accepted" @@ -261,6 +261,19 @@ "format": "int32", "description": "The backup retention period in days. This is how many days Point-in-Time Restore will be supported.", "type": "integer" + }, + "diffBackupIntervalInHours": { + "format": "int32", + "description": "The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases.", + "enum": [ + "12", + "24" + ], + "type": "integer", + "x-ms-enum": { + "name": "DiffBackupIntervalInHours", + "modelAsString": true + } } } }, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/LedgerDigestUploads.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/LedgerDigestUploads.json index 5a1e1d03fe00..270fdce755ac 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/LedgerDigestUploads.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/LedgerDigestUploads.json @@ -61,7 +61,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 LedgerInvalidDigestStorageTargetUpdateRequest - The database ledger digest storage upload request does not exist or has no properties object.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage endpoint.\n\n * 400 MalformedDigestStorageEndpoint - The specified digest storage endpoint is a malformed URI.\n\n * 400 InvalidLedgerDigestUploadsName - The ledger digest upload name is not supported. Please use the key name “current”.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription." + "description": "*** Error Responses: ***\n\n * 400 LedgerInvalidDigestStorageTargetUpdateRequest - The database ledger digest storage upload request does not exist or has no properties object.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage endpoint.\n\n * 400 MalformedDigestStorageEndpoint - The specified digest storage endpoint is a malformed URI.\n\n * 400 InvalidLedgerDigestUploadsName - The ledger digest upload name is not supported. Please use the key name “current”.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" } }, "x-ms-examples": { @@ -122,12 +122,13 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 LedgerInvalidDigestStorageTargetUpdateRequest - The database ledger digest storage upload request does not exist or has no properties object.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage endpoint.\n\n * 400 MalformedDigestStorageEndpoint - The specified digest storage endpoint is a malformed URI.\n\n * 400 InvalidLedgerDigestUploadsName - The ledger digest upload name is not supported. Please use the key name “current”.\n\n * 400 InvalidStorageAccountName - The specified storage account is not valid or does not exist.\n\n * 400 NoServerIdentity - No identity is configured for specified server. For information on how to configure an identity for the server see https://go.microsoft.com/fwlink/?linkid=2156804\n\n * 400 SubscriptionDoesNotHaveServer - Subscription {0} does not contain server {1}.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered. The error message from Active Directory Authentication library (ADAL) is {0}.\n\n * 400 InsufficientStorageAccountPermissions - Read or write operations are not allowed on the storage account {0}.\n\n * 400 StorageAccountIsDisabled - The storage account {0} is disabled.\n\n * 404 SourceDatabaseNotFound - Specified database does not exist.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription." + "description": "*** Error Responses: ***\n\n * 400 LedgerInvalidDigestStorageTargetUpdateRequest - The database ledger digest storage upload request does not exist or has no properties object.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage endpoint.\n\n * 400 MalformedDigestStorageEndpoint - The specified digest storage endpoint is a malformed URI.\n\n * 400 InvalidLedgerDigestUploadsName - The ledger digest upload name is not supported. Please use the key name “current”.\n\n * 400 NoServerIdentity - No identity is configured for specified server. For information on how to configure an identity for the server see https://go.microsoft.com/fwlink/?linkid=2156804\n\n * 400 InsufficientStorageAccountPermissions - Read or write operations are not allowed on the storage account {0}.\n\n * 400 StorageAccountIsDisabled - The storage account {0} is disabled.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered. The error message from Active Directory Authentication library (ADAL) is {0}.\n\n * 400 SubscriptionDoesNotHaveServer - Subscription {0} does not contain server {1}.\n\n * 400 InvalidStorageAccountName - The specified storage account is not valid or does not exist.\n\n * 404 SourceDatabaseNotFound - Specified database does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" }, "202": { "description": "Updating the ledger digest upload configuration is in progress." } }, + "x-ms-long-running-operation": true, "x-ms-examples": { "Enables ledger digest upload configuration for a database": { "$ref": "./examples/LedgerDigestUploadsEnable.json" @@ -225,12 +226,13 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 LedgerInvalidDigestStorageTargetUpdateRequest - The database ledger digest storage upload request does not exist or has no properties object.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage endpoint.\n\n * 400 MalformedDigestStorageEndpoint - The specified digest storage endpoint is a malformed URI.\n\n * 400 InvalidLedgerDigestUploadsName - The ledger digest upload name is not supported. Please use the key name “current”.\n\n * 400 InvalidStorageAccountName - The specified storage account is not valid or does not exist.\n\n * 400 NoServerIdentity - No identity is configured for specified server. For information on how to configure an identity for the server see https://go.microsoft.com/fwlink/?linkid=2156804\n\n * 400 SubscriptionDoesNotHaveServer - Subscription {0} does not contain server {1}.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered. The error message from Active Directory Authentication library (ADAL) is {0}.\n\n * 400 InsufficientStorageAccountPermissions - Read or write operations are not allowed on the storage account {0}.\n\n * 400 StorageAccountIsDisabled - The storage account {0} is disabled.\n\n * 404 SourceDatabaseNotFound - Specified database does not exist.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription." + "description": "*** Error Responses: ***\n\n * 400 LedgerInvalidDigestStorageTargetUpdateRequest - The database ledger digest storage upload request does not exist or has no properties object.\n\n * 400 InvalidDigestStorageEndpoint - The specified digestStorageEndpoint is invalid. It must be an Azure blob storage endpoint.\n\n * 400 MalformedDigestStorageEndpoint - The specified digest storage endpoint is a malformed URI.\n\n * 400 InvalidLedgerDigestUploadsName - The ledger digest upload name is not supported. Please use the key name “current”.\n\n * 400 NoServerIdentity - No identity is configured for specified server. For information on how to configure an identity for the server see https://go.microsoft.com/fwlink/?linkid=2156804\n\n * 400 InsufficientStorageAccountPermissions - Read or write operations are not allowed on the storage account {0}.\n\n * 400 StorageAccountIsDisabled - The storage account {0} is disabled.\n\n * 400 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered. The error message from Active Directory Authentication library (ADAL) is {0}.\n\n * 400 SubscriptionDoesNotHaveServer - Subscription {0} does not contain server {1}.\n\n * 400 InvalidStorageAccountName - The specified storage account is not valid or does not exist.\n\n * 404 SourceDatabaseNotFound - Specified database does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" }, "202": { "description": "Disabling the ledger digest upload is in progress." } }, + "x-ms-long-running-operation": true, "x-ms-examples": { "Disables uploading ledger digests for a database": { "$ref": "./examples/LedgerDigestUploadsDisable.json" diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/ManagedInstances.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/ManagedInstances.json index 1321783eb9dc..eb1b69cbfd24 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/ManagedInstances.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/ManagedInstances.json @@ -580,44 +580,6 @@ } } }, - "ResourceIdentityWithUserAssignedIdentities": { - "description": "Azure Active Directory identity configuration for a resource.", - "type": "object", - "properties": { - "userAssignedIdentities": { - "description": "The resource ids of the user assigned identities to use", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/UserIdentity" - } - }, - "principalId": { - "format": "uuid", - "description": "The Azure Active Directory principal id.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.", - "enum": [ - "None", - "SystemAssigned", - "UserAssigned" - ], - "type": "string", - "x-ms-enum": { - "name": "IdentityType", - "modelAsString": true - } - }, - "tenantId": { - "format": "uuid", - "description": "The Azure Active Directory tenant id.", - "type": "string", - "readOnly": true - } - } - }, "ManagedInstanceProperties": { "description": "The properties of a managed instance.", "type": "object", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/ReplicationLinks.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/ReplicationLinks.json index fb5d96911be7..c31d094836da 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/ReplicationLinks.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/ReplicationLinks.json @@ -28,18 +28,10 @@ "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { - "name": "serverName", - "in": "path", - "description": "The name of the server containing the replication link.", - "required": true, - "type": "string" + "$ref": "#/parameters/ServerNameParameter" }, { - "name": "databaseName", - "in": "path", - "description": "The name of the database containing the replication link.", - "required": true, - "type": "string" + "$ref": "#/parameters/DatabaseNameParameter" }, { "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" @@ -52,7 +44,7 @@ "200": { "description": "Successfully retrieved the list of replication links.", "schema": { - "$ref": "#/definitions/ReplicationLinksListResult" + "$ref": "#/definitions/ReplicationLinkListResult" } }, "default": { @@ -69,7 +61,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks/{replicationLinkName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks/{linkId}": { "get": { "tags": [ "ReplicationLinks" @@ -81,21 +73,13 @@ "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { - "name": "serverName", - "in": "path", - "description": "The name of the server containing the replication link.", - "required": true, - "type": "string" + "$ref": "#/parameters/ServerNameParameter" }, { - "name": "databaseName", - "in": "path", - "description": "The name of the database containing the replication link.", - "required": true, - "type": "string" + "$ref": "#/parameters/DatabaseNameParameter" }, { - "name": "replicationLinkName", + "name": "linkId", "in": "path", "description": "The name of the replication link.", "required": true, @@ -138,11 +122,7 @@ "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { - "name": "serverName", - "in": "path", - "description": "The name of the server containing the replication link.", - "required": true, - "type": "string" + "$ref": "#/parameters/ServerNameParameter" }, { "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" @@ -155,7 +135,7 @@ "200": { "description": "Successfully retrieved the list of replication links.", "schema": { - "$ref": "#/definitions/ReplicationLinksListResult" + "$ref": "#/definitions/ReplicationLinkListResult" } }, "default": { @@ -174,7 +154,7 @@ } }, "definitions": { - "ReplicationLinksListResult": { + "ReplicationLinkListResult": { "description": "A list of replication links.", "type": "object", "properties": { @@ -214,13 +194,35 @@ }, "role": { "description": "Local replication role.", + "enum": [ + "Primary", + "Secondary", + "NonReadableSecondary", + "Source", + "Copy" + ], "type": "string", - "readOnly": true + "readOnly": true, + "x-ms-enum": { + "name": "ReplicationRole", + "modelAsString": false + } }, "partnerRole": { "description": "Partner replication role.", + "enum": [ + "Primary", + "Secondary", + "NonReadableSecondary", + "Source", + "Copy" + ], "type": "string", - "readOnly": true + "readOnly": true, + "x-ms-enum": { + "name": "ReplicationRole", + "modelAsString": false + } }, "replicationMode": { "description": "Replication mode.", @@ -241,8 +243,18 @@ }, "replicationState": { "description": "Replication state (PENDING, SEEDING, CATCHUP, SUSPENDED).", + "enum": [ + "PENDING", + "SEEDING", + "CATCH_UP", + "SUSPENDED" + ], "type": "string", - "readOnly": true + "readOnly": true, + "x-ms-enum": { + "name": "ReplicationState", + "modelAsString": true + } }, "isTerminationAllowed": { "description": "Whether the user is currently allowed to terminate the link.", @@ -251,8 +263,16 @@ }, "linkType": { "description": "Link type (GEO, NAMED).", + "enum": [ + "GEO", + "NAMED" + ], "type": "string", - "readOnly": true + "readOnly": true, + "x-ms-enum": { + "name": "ReplicationLinkType", + "modelAsString": true + } } } }, @@ -273,7 +293,24 @@ } } }, - "parameters": {}, + "parameters": { + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "description": "The name of the server.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DatabaseNameParameter": { + "name": "databaseName", + "in": "path", + "description": "The name of the database.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, "securityDefinitions": { "azure_auth": { "type": "oauth2", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/Servers.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/Servers.json index 4e8657f0cdc8..00043bcd5cfe 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/Servers.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/Servers.json @@ -431,44 +431,6 @@ } } }, - "ResourceIdentityWithUserAssignedIdentities": { - "description": "Azure Active Directory identity configuration for a resource.", - "type": "object", - "properties": { - "userAssignedIdentities": { - "description": "The resource ids of the user assigned identities to use", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/UserIdentity" - } - }, - "principalId": { - "format": "uuid", - "description": "The Azure Active Directory principal id.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.", - "enum": [ - "None", - "SystemAssigned", - "UserAssigned" - ], - "type": "string", - "x-ms-enum": { - "name": "IdentityType", - "modelAsString": true - } - }, - "tenantId": { - "format": "uuid", - "description": "The Azure Active Directory tenant id.", - "type": "string", - "readOnly": true - } - } - }, "ServerProperties": { "description": "The properties of a server.", "type": "object", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/examples/GetShortTermRetentionPolicy.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/examples/GetShortTermRetentionPolicy.json index 8941ad3194e1..28775671551a 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/examples/GetShortTermRetentionPolicy.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/examples/GetShortTermRetentionPolicy.json @@ -14,7 +14,8 @@ "name": "default", "type": "Microsoft.Sql/servers/databases/backupShortTermRetentionPolicies", "properties": { - "retentionDays": 14 + "retentionDays": 7, + "diffBackupIntervalInHours": 24 } } } diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/examples/ListShortTermRetentionPoliciesByDatabase.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/examples/ListShortTermRetentionPoliciesByDatabase.json index 258eff2aef48..a87045048ef4 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/examples/ListShortTermRetentionPoliciesByDatabase.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/examples/ListShortTermRetentionPoliciesByDatabase.json @@ -16,7 +16,8 @@ "name": "default", "type": "Microsoft.Sql/servers/databases/backupShortTermRetentionPolicies", "properties": { - "retentionDays": 14 + "retentionDays": 7, + "diffBackupIntervalInHours": 24 } } ] diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/examples/ReplicationLinkGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/examples/ReplicationLinkGet.json index dd33bc425033..02f0485b4438 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/examples/ReplicationLinkGet.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/examples/ReplicationLinkGet.json @@ -4,7 +4,7 @@ "resourceGroupName": "Default", "serverName": "sourcesvr", "databaseName": "gamma-db", - "replicationLinkName": "4891ca10-ebd0-47d7-9182-c722651780fb", + "linkId": "4891ca10-ebd0-47d7-9182-c722651780fb", "api-version": "2021-02-01-preview" }, "responses": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/examples/UpdateShortTermRetentionPolicy.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/examples/UpdateShortTermRetentionPolicy.json index af12547f3bd0..3df40ec5107c 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/examples/UpdateShortTermRetentionPolicy.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2021-02-01-preview/examples/UpdateShortTermRetentionPolicy.json @@ -8,7 +8,8 @@ "api-version": "2021-02-01-preview", "parameters": { "properties": { - "retentionDays": 14 + "retentionDays": 7, + "diffBackupIntervalInHours": 24 } } }, @@ -19,7 +20,8 @@ "name": "default", "type": "Microsoft.Sql/servers/databases/backupShortTermRetentionPolicies", "properties": { - "retentionDays": 14 + "retentionDays": 7, + "diffBackupIntervalInHours": 24 } } }, diff --git a/specification/sql/resource-manager/common/v1/types.json b/specification/sql/resource-manager/common/v1/types.json index e6dd454ebd39..53499340e882 100644 --- a/specification/sql/resource-manager/common/v1/types.json +++ b/specification/sql/resource-manager/common/v1/types.json @@ -165,7 +165,8 @@ "enum": [ "None", "SystemAssigned", - "UserAssigned" + "UserAssigned", + "SystemAssigned,UserAssigned" ], "type": "string", "x-ms-enum": { diff --git a/specification/sql/resource-manager/common/v2/types.json b/specification/sql/resource-manager/common/v2/types.json index 9cd1182902d7..ed376ed6fca2 100644 --- a/specification/sql/resource-manager/common/v2/types.json +++ b/specification/sql/resource-manager/common/v2/types.json @@ -46,7 +46,8 @@ "enum": [ "None", "SystemAssigned", - "UserAssigned" + "UserAssigned", + "SystemAssigned,UserAssigned" ], "type": "string", "x-ms-enum": { diff --git a/specification/sql/resource-manager/readme.go.md b/specification/sql/resource-manager/readme.go.md index ccb2f1970385..5ebf743b691f 100644 --- a/specification/sql/resource-manager/readme.go.md +++ b/specification/sql/resource-manager/readme.go.md @@ -2,7 +2,15 @@ These settings apply only when `--go` is specified on the command line. -``` yaml $(go) +``` yaml $(go) && $(track2) +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/sql/armsql +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) +azure-arm: true +``` + +``` yaml $(go) && !$(track2) go: license-header: MICROSOFT_MIT_NO_VERSION namespace: sql @@ -15,6 +23,7 @@ From api-version 2017-10 and onwards, only pure package versions should be used. ``` yaml $(go) && $(multiapi) batch: + - tag: package-composite-v5 - tag: package-composite-v4 - tag: package-composite-v3 - tag: package-pure-2018-06-preview @@ -24,6 +33,15 @@ batch: - tag: package-pure-2014-04 ``` +#### Tag: package-composite-v5 and go + +These settings apply only when `--tag=package-composite-v5 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-composite-v5' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/v5.0/$(namespace) +``` + #### Tag: package-composite-v4 and go These settings apply only when `--tag=package-composite-v4 --go` is specified on the command line. diff --git a/specification/sql/resource-manager/readme.md b/specification/sql/resource-manager/readme.md index e98d72fc8cef..f2a7af807835 100644 --- a/specification/sql/resource-manager/readme.md +++ b/specification/sql/resource-manager/readme.md @@ -52,7 +52,6 @@ input-file: - Microsoft.Sql/stable/2014-04-01/serviceObjectives.json - Microsoft.Sql/stable/2014-04-01/sql.core_legacy.json - Microsoft.Sql/stable/2014-04-01/usages_legacy.json -- ./Microsoft.Sql/preview/2020-11-01-preview/BackupShortTermRetentionPolicies.json - ./Microsoft.Sql/preview/2020-11-01-preview/BlobAuditing.json - ./Microsoft.Sql/preview/2020-11-01-preview/DatabaseAdvisors.json - ./Microsoft.Sql/preview/2020-11-01-preview/DatabaseAutomaticTuning.json @@ -120,7 +119,6 @@ input-file: - ./Microsoft.Sql/preview/2020-11-01-preview/PrivateEndpointConnections.json - ./Microsoft.Sql/preview/2020-11-01-preview/PrivateLinkResources.json - ./Microsoft.Sql/preview/2020-11-01-preview/RecoverableManagedDatabases.json -- ./Microsoft.Sql/preview/2020-11-01-preview/ReplicationLinks.json - ./Microsoft.Sql/preview/2020-11-01-preview/RestorePoints.json - ./Microsoft.Sql/preview/2020-11-01-preview/SensitivityLabels.json - ./Microsoft.Sql/preview/2020-11-01-preview/ServerAdvisors.json @@ -131,7 +129,6 @@ input-file: - ./Microsoft.Sql/preview/2020-11-01-preview/ServerDnsAliases.json - ./Microsoft.Sql/preview/2020-11-01-preview/ServerKeys.json - ./Microsoft.Sql/preview/2020-11-01-preview/ServerOperations.json -- ./Microsoft.Sql/preview/2020-11-01-preview/Servers.json - ./Microsoft.Sql/preview/2020-11-01-preview/ServerSecurityAlertPolicies.json - ./Microsoft.Sql/preview/2020-11-01-preview/ServerTrustGroups.json - ./Microsoft.Sql/preview/2020-11-01-preview/ServerVulnerabilityAssessments.json @@ -146,14 +143,17 @@ input-file: - ./Microsoft.Sql/preview/2020-11-01-preview/VirtualNetworkRules.json - ./Microsoft.Sql/preview/2020-11-01-preview/WorkloadClassifiers.json - ./Microsoft.Sql/preview/2020-11-01-preview/WorkloadGroups.json +- ./Microsoft.Sql/preview/2021-02-01-preview/BackupShortTermRetentionPolicies.json - ./Microsoft.Sql/preview/2021-02-01-preview/Databases.json - ./Microsoft.Sql/preview/2021-02-01-preview/DatabaseExtensions.json - ./Microsoft.Sql/preview/2021-02-01-preview/DatabaseOperations.json - ./Microsoft.Sql/preview/2021-02-01-preview/DatabaseUsages.json - ./Microsoft.Sql/preview/2021-02-01-preview/LedgerDigestUploads.json - ./Microsoft.Sql/preview/2021-02-01-preview/OutboundFirewallRules.json +- ./Microsoft.Sql/preview/2021-02-01-preview/ReplicationLinks.json - ./Microsoft.Sql/preview/2021-02-01-preview/RestorableDroppedDatabases.json - ./Microsoft.Sql/preview/2021-02-01-preview/RestorableDroppedManagedDatabases.json +- ./Microsoft.Sql/preview/2021-02-01-preview/Servers.json - ./Microsoft.Sql/preview/2021-02-01-preview/Usages.json @@ -1425,7 +1425,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/sql/resource-manager/readme.python.md b/specification/sql/resource-manager/readme.python.md index ec2988c8da73..adf8abfbdd1e 100644 --- a/specification/sql/resource-manager/readme.python.md +++ b/specification/sql/resource-manager/readme.python.md @@ -4,17 +4,6 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.sql - package-name: azure-mgmt-sql - package-version: 0.9.0 - clear-output-folder: true -``` ``` yaml $(python) && $(track2) python-mode: create @@ -28,18 +17,6 @@ modelerfour: lenient-model-deduplication: true ``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/sql/azure-mgmt-sql/azure/mgmt/sql -``` - -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/sql/azure-mgmt-sql -``` - ``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/sql/azure-mgmt-sql/azure/mgmt/sql diff --git a/specification/storage/resource-manager/readme.typescript.md b/specification/storage/resource-manager/readme.typescript.md index 00eb3aad2f58..2683886a709f 100644 --- a/specification/storage/resource-manager/readme.typescript.md +++ b/specification/storage/resource-manager/readme.typescript.md @@ -13,7 +13,7 @@ typescript: override-client-name: StorageManagementClient ``` -``` yaml $(typescript) && !$(profile) +``` yaml $(typescript) && !$(profile-content) typescript: package-name: "@azure/arm-storage" output-folder: "$(typescript-sdks-folder)/sdk/storage/arm-storage" @@ -22,9 +22,9 @@ typescript: ### Profile: profile-hybrid-2019-03-01 -These settings apply only when `--profile=profile-hybrid-2019-03-01` is specified on the command line. +These settings apply only when `--profile-content=profile-hybrid-2019-03-01` is specified on the command line. -``` yaml $(profile)=='profile-hybrid-2019-03-01' +``` yaml $(profile-content)=='profile-hybrid-2019-03-01' typescript: package-name: "@azure/arm-storage-profile-2019-03-01-hybrid" output-folder: "$(typescript-sdks-folder)/sdk/storage/arm-storage-profile-2019-03-01-hybrid" @@ -35,9 +35,9 @@ typescript: ### Profile: profile-hybrid-2020-09-01 -These settings apply only when `--profile=profile-hybrid-2020-09-01` is specified on the command line. +These settings apply only when `--profile-content=profile-hybrid-2020-09-01` is specified on the command line. -``` yaml $(profile)=='profile-hybrid-2020-09-01' +``` yaml $(profile-content)=='profile-hybrid-2020-09-01' typescript: package-name: "@azure/arm-storage-profile-2020-09-01-hybrid" output-folder: "$(typescript-sdks-folder)/sdk/storage/arm-storage-profile-2020-09-01-hybrid" diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-03-01/storagecache.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-03-01/storagecache.json index 5ff9d02c22d9..7cb1074a7e22 100644 --- a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-03-01/storagecache.json +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-03-01/storagecache.json @@ -1401,7 +1401,8 @@ }, "ntpServer": { "description": "NTP server IP Address or FQDN for the cache to use. The default is time.windows.com.", - "type": "string" + "type": "string", + "default": "time.windows.com" } } }, @@ -2125,7 +2126,8 @@ }, "nfsAccessPolicy": { "description": "Name of the access policy applied to this junction.", - "type": "string" + "type": "string", + "default": "default" } } }, diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/AscOperations_Get.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/AscOperations_Get.json new file mode 100644 index 000000000000..8e2e4a700a5a --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/AscOperations_Get.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "westus", + "operationId": "testoperationid", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/id/locations/westus/ascOperations/testoperationid", + "name": "testoperationid", + "startTime": "2021-05-01T13:13:13.933Z", + "endTime": "2021-05-01T16:13:13.933Z", + "status": "Succeeded" + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_CreateOrUpdate.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_CreateOrUpdate.json new file mode 100644 index 000000000000..279a21514e8a --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_CreateOrUpdate.json @@ -0,0 +1,285 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-05-01", + "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 + } + ] + } + ] + } + }, + "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 + } + ] + } + ] + }, + "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": "", + "userFileURI": "", + "ldapServer": "192.0.2.12", + "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "", + "usernameDownloaded": "No" + } + } + }, + "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": "V5.1.12", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "V5.1.15" + }, + "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 + } + ] + } + ] + }, + "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": "", + "userFileURI": "", + "ldapServer": "192.0.2.12", + "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "", + "usernameDownloaded": "Yes" + } + } + }, + "sku": { + "name": "Standard_2G" + } + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_CreateOrUpdate_ldap_only.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_CreateOrUpdate_ldap_only.json new file mode 100644 index 000000000000..f1b33e9ac92c --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_CreateOrUpdate_ldap_only.json @@ -0,0 +1,252 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-05-01", + "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 + } + ] + } + ] + } + }, + "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 + } + ] + } + ] + }, + "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": "", + "userFileURI": "", + "ldapServer": "192.0.2.12", + "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "", + "usernameDownloaded": "No" + } + } + }, + "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": "V5.1.12", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "V5.1.15" + }, + "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 + } + ] + } + ] + }, + "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": "", + "userFileURI": "", + "ldapServer": "192.0.2.12", + "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "", + "usernameDownloaded": "Yes" + } + } + }, + "sku": { + "name": "Standard_2G" + } + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_DebugInfo.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_DebugInfo.json new file mode 100644 index 000000000000..32bce80409c8 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_DebugInfo.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-05-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_Delete.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_Delete.json new file mode 100644 index 000000000000..32bce80409c8 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-05-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_Flush.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_Flush.json new file mode 100644 index 000000000000..32bce80409c8 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_Flush.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-05-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_Get.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_Get.json new file mode 100644 index 000000000000..1a2f10fb2d56 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_Get.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-05-01" + }, + "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": "V5.1.12", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "V5.1.15" + }, + "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 + } + ] + } + ] + }, + "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": "", + "userFileURI": "", + "ldapServer": "192.0.2.12", + "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "", + "usernameDownloaded": "Yes" + } + } + }, + "sku": { + "name": "Standard_2G" + } + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_List.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_List.json new file mode 100644 index 000000000000..96ac24879f6d --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_List.json @@ -0,0 +1,218 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-05-01" + }, + "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": "V5.1.12", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "V5.1.15" + }, + "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 + } + ] + } + ] + }, + "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": "", + "userFileURI": "", + "ldapServer": "192.0.2.12", + "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "", + "usernameDownloaded": "Yes" + } + } + }, + "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": "V5.1.12", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "V5.1.15" + }, + "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 + } + ] + } + ] + }, + "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": "", + "userFileURI": "", + "ldapServer": "", + "ldapBaseDN": "", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "", + "usernameDownloaded": "Yes" + } + } + }, + "sku": { + "name": "Standard_2G" + } + } + ] + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_ListByResourceGroup.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_ListByResourceGroup.json new file mode 100644 index 000000000000..bcc80acb4a78 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_ListByResourceGroup.json @@ -0,0 +1,219 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-05-01" + }, + "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": "V5.1.12", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "V5.1.15" + }, + "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 + } + ] + } + ] + }, + "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": "", + "userFileURI": "", + "ldapServer": "192.0.2.12", + "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "", + "usernameDownloaded": "Yes" + } + } + }, + "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": "V5.1.12", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "V5.1.15" + }, + "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 + } + ] + } + ] + }, + "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": "", + "userFileURI": "", + "ldapServer": "", + "ldapBaseDN": "", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "", + "usernameDownloaded": "Yes" + } + } + }, + "sku": { + "name": "Standard_2G" + } + } + ] + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_Start.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_Start.json new file mode 100644 index 000000000000..32bce80409c8 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_Start.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-05-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_Stop.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_Stop.json new file mode 100644 index 000000000000..32bce80409c8 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_Stop.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-05-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_Update.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_Update.json new file mode 100644 index 000000000000..1231e8d23f91 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_Update.json @@ -0,0 +1,217 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-05-01", + "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" + } + ] + } + ] + }, + "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": { + "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": "V5.1.12", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "V5.1.15" + }, + "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" + } + ] + } + ] + }, + "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": "", + "userFileURI": "", + "ldapServer": "", + "ldapBaseDN": "", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "", + "usernameDownloaded": "Yes" + } + } + }, + "sku": { + "name": "Standard_2G" + } + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_Update_ldap_only.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_Update_ldap_only.json new file mode 100644 index 000000000000..de7cfa1bbf3e --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_Update_ldap_only.json @@ -0,0 +1,208 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-05-01", + "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" + } + ] + } + ] + }, + "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": { + "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": "V5.1.12", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "V5.1.15" + }, + "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" + } + ] + } + ] + }, + "directoryServicesSettings": { + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "LDAP", + "groupFileURI": "", + "userFileURI": "", + "ldapServer": "192.0.2.12", + "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "", + "usernameDownloaded": "No" + } + } + }, + "sku": { + "name": "Standard_2G" + } + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_UpgradeFirmware.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_UpgradeFirmware.json new file mode 100644 index 000000000000..19f51e1d38a0 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Caches_UpgradeFirmware.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-05-01" + }, + "responses": { + "201": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Operations_List.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Operations_List.json new file mode 100644 index 000000000000..d3baa3f1dfe7 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Operations_List.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2021-05-01", + "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/stable/2021-05-01/examples/Skus_List.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Skus_List.json new file mode 100644 index 000000000000..f2af77e12be4 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/Skus_List.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-05-01" + }, + "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/stable/2021-05-01/examples/StorageTargets_CreateOrUpdate.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/StorageTargets_CreateOrUpdate.json new file mode 100644 index 000000000000..ddf5884d1861 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/StorageTargets_CreateOrUpdate.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-05-01", + "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_HEAVY_INFREQ" + } + } + } + }, + "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" + } + ], + "targetType": "nfs3", + "nfs3": { + "target": "10.0.44.44", + "usageModel": "READ_HEAVY_INFREQ" + } + } + } + }, + "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" + } + ], + "targetType": "nfs3", + "nfs3": { + "target": "10.0.44.44", + "usageModel": "READ_HEAVY_INFREQ" + } + } + } + }, + "202": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/StorageTargets_CreateOrUpdate_BlobNfs.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/StorageTargets_CreateOrUpdate_BlobNfs.json new file mode 100644 index 000000000000..94954a521868 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/StorageTargets_CreateOrUpdate_BlobNfs.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-05-01", + "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": "WRITE_WORKLOAD_15" + } + } + } + }, + "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" + } + ], + "blobNfs": { + "target": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/blofnfs/blobServices/default/containers/blobnfs", + "usageModel": "WRITE_WORKLOAD_15" + } + } + } + }, + "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" + } + ], + "blobNfs": { + "target": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/blofnfs/blobServices/default/containers/blobnfs", + "usageModel": "WRITE_WORKLOAD_15" + } + } + } + }, + "202": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/StorageTargets_CreateOrUpdate_NoJunctions.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/StorageTargets_CreateOrUpdate_NoJunctions.json new file mode 100644 index 000000000000..9f83699ab60a --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/StorageTargets_CreateOrUpdate_NoJunctions.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-05-01", + "cacheName": "sc1", + "storageTargetName": "st1", + "storagetarget": { + "properties": { + "targetType": "nfs3", + "nfs3": { + "target": "10.0.44.44", + "usageModel": "READ_HEAVY_INFREQ" + } + } + } + }, + "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", + "nfs3": { + "target": "10.0.44.44", + "usageModel": "READ_HEAVY_INFREQ" + } + } + } + }, + "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", + "nfs3": { + "target": "10.0.44.44", + "usageModel": "READ_HEAVY_INFREQ" + } + } + } + }, + "202": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/StorageTargets_Delete.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/StorageTargets_Delete.json new file mode 100644 index 000000000000..ae15744b9eb7 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/StorageTargets_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-05-01", + "cacheName": "sc1", + "storageTargetName": "st1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/StorageTargets_DnsRefresh.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/StorageTargets_DnsRefresh.json new file mode 100644 index 000000000000..52f349251cf1 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/StorageTargets_DnsRefresh.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-05-01", + "storageTargetName": "st1" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/StorageTargets_Flush.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/StorageTargets_Flush.json new file mode 100644 index 000000000000..1b9730638ddc --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/StorageTargets_Flush.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-05-01", + "storageTargetName": "st1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/StorageTargets_Get.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/StorageTargets_Get.json new file mode 100644 index 000000000000..a1a19536da2b --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/StorageTargets_Get.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-05-01", + "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" + } + ], + "targetType": "nfs3", + "nfs3": { + "target": "10.0.44.44", + "usageModel": "READ_HEAVY_FREQ" + } + } + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/StorageTargets_ListByCache.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/StorageTargets_ListByCache.json new file mode 100644 index 000000000000..e72736362194 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/StorageTargets_ListByCache.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-05-01", + "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" + } + ], + "targetType": "nfs3", + "nfs3": { + "target": "10.0.44.44", + "usageModel": "READ_HEAVY_FREQ" + } + } + }, + { + "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/crazy/place/on/cache", + "targetPath": "/", + "nfsAccessPolicy": "default" + } + ], + "targetType": "clfs", + "clfs": { + "target": "https://contoso123.blob.core.windows.net/contoso123" + } + } + }, + { + "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" + } + ], + "targetType": "unknown", + "unknown": { + "attributes": { + "foo": "bar", + "foo2": "test" + } + } + } + } + ] + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/StorageTargets_Resume.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/StorageTargets_Resume.json new file mode 100644 index 000000000000..1b9730638ddc --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/StorageTargets_Resume.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-05-01", + "storageTargetName": "st1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/StorageTargets_Suspend.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/StorageTargets_Suspend.json new file mode 100644 index 000000000000..1b9730638ddc --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/StorageTargets_Suspend.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-05-01", + "storageTargetName": "st1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/UsageModels_List.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/UsageModels_List.json new file mode 100644 index 000000000000..6449a98cdef9 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/examples/UsageModels_List.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "modelName": "READ_HEAVY_INFREQ", + "targetType": "nfs3", + "display": { + "description": "Read heavy, infrequent changes" + } + }, + { + "modelName": "WRITE_AROUND", + "targetType": "nfs3", + "display": { + "description": "Clients write directly to storage" + } + }, + { + "modelName": "WRITE_WORKLOAD_15", + "targetType": "nfs3", + "display": { + "description": "Write workload > 15%" + } + } + ] + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/storagecache.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/storagecache.json new file mode 100644 index 000000000000..2b86b29dc63a --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2021-05-01/storagecache.json @@ -0,0 +1,2555 @@ +{ + "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": "2021-05-01" + }, + "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": "#/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": { + "StorageTargets_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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the region used to look up the operation." + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The operation id which uniquely identifies the asynchronous operation." + } + ], + "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/caches": { + "get": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Cache deleted." + }, + "202": { + "description": "Started the Cache's transition to Deleted state. Poll the Cache to monitor." + }, + "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": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns the Cache object corresponding to cacheName.", + "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": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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", + "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": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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" + } + }, + "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" + } + }, + "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": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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." + }, + "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": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + } + ], + "responses": { + "200": { + "description": "Cache has started generating debug info." + }, + "202": { + "description": "Cache has started generating debug info." + }, + "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": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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." + }, + "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": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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." + }, + "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": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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." + }, + "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": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + } + ], + "responses": { + "200": { + "description": "Returns the list of Storage Targets defined by cacheName.", + "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": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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." + }, + "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": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "#/parameters/StorageTargetParameter" + }, + { + "description": "Object containing the definition of a Storage Target.", + "in": "body", + "name": "storagetarget", + "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": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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." + }, + "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": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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." + }, + "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": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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." + }, + "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}/upgrade": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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." + }, + "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" + } + } + }, + "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" + } + } + } + } + } + } + }, + "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" + } + }, + "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" + }, + "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 IP 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", + "Cancelled", + "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 + }, + "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." + } + }, + "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" + } + } + }, + "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" + } + }, + "required": [ + "username", + "password" + ] + } + }, + "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." + }, + "requireValidCertificate": { + "type": "boolean", + "description": "Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided." + }, + "autoDownloadCertificate": { + "type": "boolean", + "description": "Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true." + }, + "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." + }, + "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" + } + } + }, + "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.", + "enum": [ + "Unknown", + "Healthy", + "Degraded", + "Down", + "Transitioning", + "Stopping", + "Stopped", + "Upgrading", + "Flushing" + ], + "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" + } + } + } + }, + "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" + }, + "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" + } + }, + "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", + "Cancelled", + "Creating", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "ProvisioningStateType", + "modelAsString": true + }, + "type": "string", + "readOnly": true + }, + "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" + } + } + }, + "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" + } + } + }, + "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" + } + } + }, + "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 URL 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" + }, + "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" + }, + "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." + } + }, + "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" + } + } + }, + "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" + } + }, + "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" + } + } + } + }, + "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" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + }, + "ResourceGroupParameter": { + "description": "Target resource group.", + "in": "path", + "name": "resourceGroupName", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "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.go.md b/specification/storagecache/resource-manager/readme.go.md index faba5772a66c..b6af11796955 100644 --- a/specification/storagecache/resource-manager/readme.go.md +++ b/specification/storagecache/resource-manager/readme.go.md @@ -13,6 +13,7 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2021-05 - tag: package-2021-03 - tag: package-2020-10-01 - tag: package-2020-03-01 @@ -20,6 +21,15 @@ batch: - tag: package-2019-08 ``` +### Tag: package-2021-05 and go + +These settings apply only when `--tag=package-2021-05 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2021-05' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2021-05-01/$(namespace) +``` + ### Tag: package-2021-03 and go These settings apply only when `--tag=package-2021-03 --go` is specified on the command line. diff --git a/specification/storagecache/resource-manager/readme.md b/specification/storagecache/resource-manager/readme.md index 5f5c3efa60c4..427eee637853 100644 --- a/specification/storagecache/resource-manager/readme.md +++ b/specification/storagecache/resource-manager/readme.md @@ -26,20 +26,29 @@ These are the global settings for the StorageCache API. ``` yaml openapi-type: arm -tag: package-2021-03 +tag: package-2021-05 add-credentials: true title: StorageCacheManagementClient ``` +### Tag: package-2021-05 + +These settings apply only when `--tag=package-2021-05` is specified on the command line. + +```yaml $(tag) == 'package-2021-05' +input-file: + - Microsoft.StorageCache/stable/2021-05-01/storagecache.json +``` ### Tag: package-2021-03 These settings apply only when `--tag=package-2021-03` is specified on the command line. -```yaml $(tag) == 'package-2021-03' +``` yaml $(tag) == 'package-2021-03' input-file: - Microsoft.StorageCache/stable/2021-03-01/storagecache.json ``` + ### Tag: package-2020-10-01 These settings apply only when `--tag=package-2020-10` is specified on the command line. @@ -118,5 +127,3 @@ See configuration in [readme.typescript.md](./readme.typescript.md) ## Ruby See configuration in [readme.ruby.md](./readme.ruby.md) - - diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/preview/2021-01-01/storageimportexport.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/preview/2021-01-01/storageimportexport.json index 2eacf5aaf275..bc26383f5be9 100644 --- a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/preview/2021-01-01/storageimportexport.json +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/preview/2021-01-01/storageimportexport.json @@ -654,15 +654,18 @@ }, "backupDriveManifest": { "type": "boolean", - "description": "Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs." + "description": "Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs.", + "default": false }, "state": { "type": "string", - "description": "Current state of the job." + "description": "Current state of the job.", + "default": "Creating" }, "cancelRequested": { "type": "boolean", - "description": "Indicates whether a request has been submitted to cancel the job." + "description": "Indicates whether a request has been submitted to cancel the job.", + "default": false }, "percentComplete": { "type": "integer", @@ -761,7 +764,8 @@ "properties": { "cancelRequested": { "type": "boolean", - "description": "If specified, the value must be true. The service will attempt to cancel the job. " + "description": "If specified, the value must be true. The service will attempt to cancel the job. ", + "default": false }, "state": { "type": "string", @@ -785,7 +789,8 @@ }, "backupDriveManifest": { "type": "boolean", - "description": "Indicates whether the manifest files on the drives should be copied to block blobs." + "description": "Indicates whether the manifest files on the drives should be copied to block blobs.", + "default": false }, "driveList": { "description": "List of drives that comprise the job.", @@ -1163,6 +1168,7 @@ "CompletedMoreInfo", "ShippedBack" ], + "default": "Specified", "x-ms-enum": { "name": "DriveState", "modelAsString": true diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/storageimportexport.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/storageimportexport.json index 7e72860e59ae..da06b26d0012 100644 --- a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/storageimportexport.json +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/storageimportexport.json @@ -684,15 +684,18 @@ }, "backupDriveManifest": { "type": "boolean", - "description": "Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs." + "description": "Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs.", + "default": false }, "state": { "type": "string", - "description": "Current state of the job." + "description": "Current state of the job.", + "default": "Creating" }, "cancelRequested": { "type": "boolean", - "description": "Indicates whether a request has been submitted to cancel the job." + "description": "Indicates whether a request has been submitted to cancel the job.", + "default": false }, "percentComplete": { "type": "integer", @@ -791,7 +794,8 @@ "properties": { "cancelRequested": { "type": "boolean", - "description": "If specified, the value must be true. The service will attempt to cancel the job. " + "description": "If specified, the value must be true. The service will attempt to cancel the job. ", + "default": false }, "state": { "type": "string", @@ -815,7 +819,8 @@ }, "backupDriveManifest": { "type": "boolean", - "description": "Indicates whether the manifest files on the drives should be copied to block blobs." + "description": "Indicates whether the manifest files on the drives should be copied to block blobs.", + "default": false }, "driveList": { "description": "List of drives that comprise the job.", @@ -1193,6 +1198,7 @@ "CompletedMoreInfo", "ShippedBack" ], + "default": "Specified", "x-ms-enum": { "name": "DriveState", "modelAsString": true diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/storageimportexport.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/storageimportexport.json index f50737dbef1b..61fa46306e78 100644 --- a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/storageimportexport.json +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/storageimportexport.json @@ -684,15 +684,18 @@ }, "backupDriveManifest": { "type": "boolean", - "description": "Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs." + "description": "Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs.", + "default": false }, "state": { "type": "string", - "description": "Current state of the job." + "description": "Current state of the job.", + "default": "Creating" }, "cancelRequested": { "type": "boolean", - "description": "Indicates whether a request has been submitted to cancel the job." + "description": "Indicates whether a request has been submitted to cancel the job.", + "default": false }, "percentComplete": { "type": "integer", @@ -791,7 +794,8 @@ "properties": { "cancelRequested": { "type": "boolean", - "description": "If specified, the value must be true. The service will attempt to cancel the job. " + "description": "If specified, the value must be true. The service will attempt to cancel the job. ", + "default": false }, "state": { "type": "string", @@ -815,7 +819,8 @@ }, "backupDriveManifest": { "type": "boolean", - "description": "Indicates whether the manifest files on the drives should be copied to block blobs." + "description": "Indicates whether the manifest files on the drives should be copied to block blobs.", + "default": false }, "driveList": { "description": "List of drives that comprise the job.", @@ -1193,6 +1198,7 @@ "CompletedMoreInfo", "ShippedBack" ], + "default": "Specified", "x-ms-enum": { "name": "DriveState", "modelAsString": true diff --git a/specification/storageimportexport/resource-manager/readme.go.md b/specification/storageimportexport/resource-manager/readme.go.md index c0260f48339b..013855e81f58 100644 --- a/specification/storageimportexport/resource-manager/readme.go.md +++ b/specification/storageimportexport/resource-manager/readme.go.md @@ -14,11 +14,6 @@ go: ``` yaml $(go) && $(multiapi) batch: - tag: package-2016-11 -``` -or - -``` yaml $(go) && $(multiapi) -batch: - tag: package-2020-08 ``` diff --git a/specification/storagepool/resource-manager/readme.az.md b/specification/storagepool/resource-manager/readme.az.md index d0f6bac0405f..66253be65f8c 100644 --- a/specification/storagepool/resource-manager/readme.az.md +++ b/specification/storagepool/resource-manager/readme.az.md @@ -24,10 +24,6 @@ cli: positional: true positionalKeys: - id - - where: - group: DiskPools - op: ListOutboundNetworkDependenciesEndpoints - hidden: true - where: group: DiskPools parameter: additionalCapabilities diff --git a/specification/storagepool/resource-manager/readme.cli.md b/specification/storagepool/resource-manager/readme.cli.md index 813847914ab1..c433220dbf74 100644 --- a/specification/storagepool/resource-manager/readme.cli.md +++ b/specification/storagepool/resource-manager/readme.cli.md @@ -15,7 +15,7 @@ directive: set: command: disk-pool stop - where: - command: diskpool disk-pool-zone list + command: disk-pool-zone list set: command: disk-pool list-skus ``` \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_Get.json deleted file mode 100644 index aa12f906e412..000000000000 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_Get.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "syncGroupName": "SampleSyncGroup_1", - "cloudEndpointName": "SampleCloudEndpoint_1", - "api-version": "2020-09-01" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - }, - "body": { - "name": "SampleCloudEndpoint_1", - "properties": { - "provisioningState": "Succeeded", - "storageAccountResourceId": "", - "azureFileShareName": "", - "storageAccountTenantId": "\"a4d1b191-c1af-4cef-a14b-f670e0beea52\"", - "lastWorkflowId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/a377fdd5-949a-40ab-9629-06cd0e9852f9", - "friendlyName": "SampleAzureFileShareName_1", - "partnershipId": "1|U0VSVkVSQVNTWU5DQ0xJRU5USEZTVjJ8MTkxNjYwQ0QtNkExQS00RjhDLTk3ODctQTZCRUQyMDZBMUREfEdFTkVSSUN8M0EwNDgyODMtMzM4Ri00MDAyLUE5REQtQTUwRkRBRENCMzky", - "lastOperationName": "ICreateCloudEndpointWorkflow" - }, - "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SyncGroup_Restore_08-08_Test112/cloudEndpoints/CEP_Restore_08-08_Test112", - "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" - } - } - } -} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_ListBySyncGroup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_ListBySyncGroup.json deleted file mode 100644 index d7ea0c467cb8..000000000000 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_ListBySyncGroup.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "syncGroupName": "SampleSyncGroup_1", - "api-version": "2020-09-01" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - }, - "body": { - "value": [ - { - "name": "CEP_Restore_08-08_Test112", - "properties": { - "provisioningState": "Succeeded", - "storageAccountResourceId": "", - "azureFileShareName": "", - "storageAccountTenantId": "\"a4d1b191-c1af-4cef-a14b-f670e0beea52\"", - "lastWorkflowId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/a377fdd5-949a-40ab-9629-06cd0e9852f9", - "friendlyName": "SampleAzureFileShareName_1", - "partnershipId": "1|U0VSVkVSQVNTWU5DQ0xJRU5Udfsdfdsfs8MTkxNjYwQ0QtNkExQS00RjhDLTk3ODctQTZCRUQyMDZBMUREfEdFTkVSSUN8M0EwNDgyODMtMzM4Ri00MDAyLUE5REQtQTUwRkRBRENCMzky", - "lastOperationName": "ICreateCloudEndpointWorkflow" - }, - "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SyncGroup_Restore_08-08_Test112/cloudEndpoints/CEP_Restore_08-08_Test112", - "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" - } - ] - } - } - } -} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_Create.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_Create.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_Create.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_Delete.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_Delete.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_Delete.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_Get.json new file mode 100644 index 000000000000..59e089aac143 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_Get.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "name": "SampleCloudEndpoint_1", + "properties": { + "provisioningState": "Succeeded", + "storageAccountResourceId": "", + "azureFileShareName": "", + "storageAccountTenantId": "\"a4d1b191-c1af-4cef-a14b-f670e0beea52\"", + "lastWorkflowId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/a377fdd5-949a-40ab-9629-06cd0e9852f9", + "friendlyName": "SampleAzureFileShareName_1", + "partnershipId": "1|U0VSVkVSQVNTWU5DQ0xJRU5USEZTVjJ8MTkxNjYwQ0QtNkExQS00RjhDLTk3ODctQTZCRUQyMDZBMUREfEdFTkVSSUN8M0EwNDgyODMtMzM4Ri00MDAyLUE5REQtQTUwRkRBRENCMzky", + "lastOperationName": "ICreateCloudEndpointWorkflow", + "changeEnumerationStatus": { + "lastUpdatedTimestamp": "2019-04-17T19:14:59.0961891Z", + "lastEnumerationStatus": { + "startedTimestamp": "2019-04-17T19:14:59.0961891Z", + "completedTimestamp": "2019-04-17T19:14:59.0961891Z", + "namespaceFilesCount": 3489, + "namespaceDirectoriesCount": 28, + "namespaceSizeBytes": 3248804, + "nextRunTimestamp": "2019-04-17T19:14:59.0961891Z" + }, + "activity": { + "lastUpdatedTimestamp": "2019-04-17T19:14:59.0961891Z", + "operationState": "EnumerationInProgress", + "statusCode": 0, + "startedTimestamp": "2019-04-17T19:14:59.0961891Z", + "processedFilesCount": 6948, + "processedDirectoriesCount": 364, + "totalFilesCount": 12834, + "totalDirectoriesCount": 694, + "totalSizeBytes": 5782301239408, + "progressPercent": 67, + "minutesRemaining": 589, + "totalCountsState": "Final", + "deletesProgressPercent": 12 + } + } + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SyncGroup_Restore_08-08_Test112/cloudEndpoints/CEP_Restore_08-08_Test112", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_ListBySyncGroup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_ListBySyncGroup.json new file mode 100644 index 000000000000..5090a349091a --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_ListBySyncGroup.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "value": [ + { + "name": "CEP_Restore_08-08_Test112", + "properties": { + "provisioningState": "Succeeded", + "storageAccountResourceId": "", + "azureFileShareName": "", + "storageAccountTenantId": "\"a4d1b191-c1af-4cef-a14b-f670e0beea52\"", + "lastWorkflowId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/a377fdd5-949a-40ab-9629-06cd0e9852f9", + "friendlyName": "SampleAzureFileShareName_1", + "partnershipId": "1|U0VSVkVSQVNTWU5DQ0xJRU5Udfsdfdsfs8MTkxNjYwQ0QtNkExQS00RjhDLTk3ODctQTZCRUQyMDZBMUREfEdFTkVSSUN8M0EwNDgyODMtMzM4Ri00MDAyLUE5REQtQTUwRkRBRENCMzky", + "lastOperationName": "ICreateCloudEndpointWorkflow", + "changeEnumerationStatus": { + "lastUpdatedTimestamp": "2019-04-17T19:14:59.0961891Z", + "lastEnumerationStatus": { + "startedTimestamp": "2019-04-17T19:14:59.0961891Z", + "completedTimestamp": "2019-04-17T19:14:59.0961891Z", + "namespaceFilesCount": 3489, + "namespaceDirectoriesCount": 28, + "namespaceSizeBytes": 3248804, + "nextRunTimestamp": "2019-04-17T19:14:59.0961891Z" + }, + "activity": { + "lastUpdatedTimestamp": "2019-04-17T19:14:59.0961891Z", + "operationState": "Delayed", + "statusCode": -1, + "startedTimestamp": "2019-04-17T19:14:59.0961891Z", + "processedFilesCount": 6948, + "processedDirectoriesCount": 364, + "totalFilesCount": 12834, + "totalDirectoriesCount": 694, + "totalSizeBytes": 5782301239408, + "progressPercent": 67, + "minutesRemaining": 589, + "totalCountsState": "Calculating", + "deletesProgressPercent": null + } + } + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SyncGroup_Restore_08-08_Test112/cloudEndpoints/CEP_Restore_08-08_Test112", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" + } + ] + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PostBackup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_PostBackup.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PostBackup.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_PostBackup.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PostRestore.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_PostRestore.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PostRestore.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_PostRestore.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PreBackup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_PreBackup.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PreBackup.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_PreBackup.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PreRestore.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_PreRestore.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PreRestore.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_PreRestore.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_RestoreHeatbeat.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_RestoreHeatbeat.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_RestoreHeatbeat.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_RestoreHeatbeat.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_TriggerChangeDetection.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_TriggerChangeDetection.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_TriggerChangeDetection.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_TriggerChangeDetection.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/OperationStatus_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/OperationStatus_Get.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/OperationStatus_Get.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/OperationStatus_Get.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Operations_List.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/Operations_List.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Operations_List.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/Operations_List.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/PrivateEndpointConnections_Create.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_Create.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/PrivateEndpointConnections_Create.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/PrivateEndpointConnections_Delete.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_Delete.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/PrivateEndpointConnections_Delete.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/PrivateEndpointConnections_Get.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_Get.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/PrivateEndpointConnections_Get.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_ListByStorageSyncService.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/PrivateEndpointConnections_ListByStorageSyncService.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_ListByStorageSyncService.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/PrivateEndpointConnections_ListByStorageSyncService.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateLinkResources_List.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/PrivateLinkResources_List.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateLinkResources_List.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/PrivateLinkResources_List.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/RegisteredServers_Create.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_Create.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/RegisteredServers_Create.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/RegisteredServers_Delete.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_Delete.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/RegisteredServers_Delete.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/RegisteredServers_Get.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_Get.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/RegisteredServers_Get.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_ListByStorageSyncService.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/RegisteredServers_ListByStorageSyncService.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_ListByStorageSyncService.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/RegisteredServers_ListByStorageSyncService.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_TriggerRollover.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/RegisteredServers_TriggerRollover.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_TriggerRollover.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/RegisteredServers_TriggerRollover.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/ServerEndpoints_Create.json similarity index 94% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Create.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/ServerEndpoints_Create.json index 25a3b2868d2c..788706e294e5 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Create.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/ServerEndpoints_Create.json @@ -15,7 +15,8 @@ "offlineDataTransfer": "on", "offlineDataTransferShareName": "myfileshare", "initialDownloadPolicy": "NamespaceThenModifiedFiles", - "localCacheMode": "UpdateLocallyCachedFiles" + "localCacheMode": "UpdateLocallyCachedFiles", + "initialUploadPolicy": "ServerAuthoritative" } }, "api-version": "2020-09-01" @@ -47,7 +48,8 @@ "cloudTieringStatus": null, "recallStatus": null, "initialDownloadPolicy": "NamespaceThenModifiedFiles", - "localCacheMode": "UpdateLocallyCachedFiles" + "localCacheMode": "UpdateLocallyCachedFiles", + "initialUploadPolicy": "ServerAuthoritative" }, "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/serverEndpoints/SampleServerEndpoint_1", "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/ServerEndpoints_Delete.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Delete.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/ServerEndpoints_Delete.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/ServerEndpoints_Get.json similarity index 99% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Get.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/ServerEndpoints_Get.json index 67a99648af47..a99cfe0b568a 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Get.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/ServerEndpoints_Get.json @@ -75,6 +75,7 @@ "offlineDataTransferShareName": "myfileshare", "initialDownloadPolicy": "NamespaceThenModifiedFiles", "localCacheMode": "UpdateLocallyCachedFiles", + "initialUploadPolicy": "Merge", "cloudTieringStatus": { "lastUpdatedTimestamp": "2018-06-11T23:32:51.1057915Z", "health": "Error", diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_ListBySyncGroup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/ServerEndpoints_ListBySyncGroup.json similarity index 98% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_ListBySyncGroup.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/ServerEndpoints_ListBySyncGroup.json index 7b1f1e3acb73..eaff18580bb0 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_ListBySyncGroup.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/ServerEndpoints_ListBySyncGroup.json @@ -61,7 +61,8 @@ "offlineDataTransferStorageAccountTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", "offlineDataTransferShareName": "myfileshare", "initialDownloadPolicy": "NamespaceThenModifiedFiles", - "localCacheMode": "UpdateLocallyCachedFiles" + "localCacheMode": "UpdateLocallyCachedFiles", + "initialUploadPolicy": "Merge" }, "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/serverEndpoints/SampleServerEndpoint_1", "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" @@ -81,6 +82,7 @@ "tierFilesOlderThanDays": 5, "initialDownloadPolicy": "NamespaceThenModifiedFiles", "localCacheMode": "UpdateLocallyCachedFiles", + "initialUploadPolicy": "Merge", "syncStatus": { "downloadHealth": "Healthy", "uploadHealth": "Healthy", diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Recall.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/ServerEndpoints_Recall.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Recall.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/ServerEndpoints_Recall.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Update.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/ServerEndpoints_Update.json similarity index 97% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Update.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/ServerEndpoints_Update.json index 9f1970e01f07..bb93e80863d1 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Update.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/ServerEndpoints_Update.json @@ -70,7 +70,8 @@ "offlineDataTransferStorageAccountTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", "offlineDataTransferShareName": "myfileshare", "initialDownloadPolicy": "NamespaceThenModifiedFiles", - "localCacheMode": "UpdateLocallyCachedFiles" + "localCacheMode": "UpdateLocallyCachedFiles", + "initialUploadPolicy": "Merge" }, "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/serverEndpoints/SampleServerEndpoint_1", "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServiceCheckNameAvailability_AlreadyExists.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/StorageSyncServiceCheckNameAvailability_AlreadyExists.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServiceCheckNameAvailability_AlreadyExists.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/StorageSyncServiceCheckNameAvailability_AlreadyExists.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServiceCheckNameAvailability_Available.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/StorageSyncServiceCheckNameAvailability_Available.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServiceCheckNameAvailability_Available.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/StorageSyncServiceCheckNameAvailability_Available.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/StorageSyncServices_Create.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Create.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/StorageSyncServices_Create.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/StorageSyncServices_Delete.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Delete.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/StorageSyncServices_Delete.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/StorageSyncServices_Get.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Get.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/StorageSyncServices_Get.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_ListByResourceGroup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/StorageSyncServices_ListByResourceGroup.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_ListByResourceGroup.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/StorageSyncServices_ListByResourceGroup.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_ListBySubscription.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/StorageSyncServices_ListBySubscription.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_ListBySubscription.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/StorageSyncServices_ListBySubscription.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Update.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/StorageSyncServices_Update.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Update.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/StorageSyncServices_Update.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/SyncGroups_Create.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_Create.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/SyncGroups_Create.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/SyncGroups_Delete.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_Delete.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/SyncGroups_Delete.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/SyncGroups_Get.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_Get.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/SyncGroups_Get.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_ListByStorageSyncService.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/SyncGroups_ListByStorageSyncService.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_ListByStorageSyncService.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/SyncGroups_ListByStorageSyncService.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Workflows_Abort.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/Workflows_Abort.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Workflows_Abort.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/Workflows_Abort.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Workflows_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/Workflows_Get.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Workflows_Get.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/Workflows_Get.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Workflows_ListByStorageSyncService.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/Workflows_ListByStorageSyncService.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Workflows_ListByStorageSyncService.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/Workflows_ListByStorageSyncService.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/storagesync.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/storagesync.json similarity index 95% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/storagesync.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/storagesync.json index 14a65f0b4501..6ca36b30eac1 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/storagesync.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/storagesync.json @@ -3416,7 +3416,8 @@ "type": "integer", "minimum": 0, "maximum": 100, - "description": "Level of free space to be maintained by Cloud Tiering if it is enabled." + "description": "Level of free space to be maintained by Cloud Tiering if it is enabled.", + "default": 20 }, "tierFilesOlderThanDays": { "type": "integer", @@ -3442,11 +3443,18 @@ }, "initialDownloadPolicy": { "$ref": "#/definitions/InitialDownloadPolicy", - "description": "Policy for how namespace and files are recalled during FastDr." + "description": "Policy for how namespace and files are recalled during FastDr.", + "default": "NamespaceThenModifiedFiles" }, "localCacheMode": { "$ref": "#/definitions/LocalCacheMode", - "description": "Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access." + "description": "Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access.", + "default": "UpdateLocallyCachedFiles" + }, + "initialUploadPolicy": { + "$ref": "#/definitions/InitialUploadPolicy", + "description": "Policy for how the initial upload sync session is performed.", + "default": "Merge" } } }, @@ -4097,28 +4105,23 @@ "properties": { "lastStepName": { "type": "string", - "description": "last step name", - "readOnly": true + "description": "last step name" }, "status": { "$ref": "#/definitions/WorkflowStatus", - "description": "workflow status.", - "readOnly": true + "description": "workflow status." }, "operation": { "$ref": "#/definitions/OperationDirection", - "description": "operation direction.", - "readOnly": true + "description": "operation direction." }, "steps": { "type": "string", - "description": "workflow steps", - "readOnly": true + "description": "workflow steps" }, "lastOperationId": { "type": "string", - "description": "workflow last operation identifier.", - "readOnly": true + "description": "workflow last operation identifier." }, "commandName": { "type": "string", @@ -4184,19 +4187,15 @@ }, "serverManagementErrorCode": { "type": "integer", - "description": "Registered Server Management Error Code", - "readOnly": true + "description": "Registered Server Management Error Code" }, "lastHeartBeat": { "type": "string", - "format": "date-time", - "description": "Registered Server last heart beat", - "readOnly": true + "description": "Registered Server last heart beat" }, "provisioningState": { "type": "string", - "description": "Registered Server Provisioning State", - "readOnly": true + "description": "Registered Server Provisioning State" }, "serverRole": { "type": "string", @@ -4216,33 +4215,27 @@ }, "storageSyncServiceUid": { "type": "string", - "description": "Registered Server storageSyncServiceUid", - "readOnly": true + "description": "Registered Server storageSyncServiceUid" }, "lastWorkflowId": { "type": "string", - "description": "Registered Server lastWorkflowId", - "readOnly": true + "description": "Registered Server lastWorkflowId" }, "lastOperationName": { "type": "string", - "description": "Resource Last Operation Name", - "readOnly": true + "description": "Resource Last Operation Name" }, "discoveryEndpointUri": { "type": "string", - "description": "Resource discoveryEndpointUri", - "readOnly": true + "description": "Resource discoveryEndpointUri" }, "resourceLocation": { "type": "string", - "description": "Resource Location", - "readOnly": true + "description": "Resource Location" }, "serviceLocation": { "type": "string", - "description": "Service Location", - "readOnly": true + "description": "Service Location" }, "friendlyName": { "type": "string", @@ -4250,18 +4243,15 @@ }, "managementEndpointUri": { "type": "string", - "description": "Management Endpoint Uri", - "readOnly": true + "description": "Management Endpoint Uri" }, "monitoringEndpointUri": { "type": "string", - "description": "Telemetry Endpoint Uri", - "readOnly": true + "description": "Telemetry Endpoint Uri" }, "monitoringConfiguration": { "type": "string", - "description": "Monitoring Configuration", - "readOnly": true + "description": "Monitoring Configuration" }, "serverName": { "type": "string", @@ -4310,6 +4300,12 @@ "lastOperationName": { "type": "string", "description": "Resource Last Operation Name" + }, + "changeEnumerationStatus": { + "type": "object", + "$ref": "#/definitions/CloudEndpointChangeEnumerationStatus", + "description": "Cloud endpoint change enumeration status", + "readOnly": true } } }, @@ -4438,6 +4434,10 @@ "$ref": "#/definitions/LocalCacheMode", "description": "Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access." }, + "initialUploadPolicy": { + "$ref": "#/definitions/InitialUploadPolicy", + "description": "Policy for how the initial upload sync session is performed." + }, "serverName": { "type": "string", "description": "Server name", @@ -4621,6 +4621,13 @@ "$ref": "#/definitions/ServerEndpointSyncMode", "description": "Sync mode", "readOnly": true + }, + "sessionMinutesRemaining": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "Session minutes remaining (if available)", + "readOnly": true } } }, @@ -4660,6 +4667,12 @@ "description": "Timestamp when properties were updated", "readOnly": true }, + "startedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the operation started", + "readOnly": true + }, "percentProgress": { "type": "integer", "format": "int32", @@ -4753,6 +4766,18 @@ "modelAsString": true } }, + "InitialUploadPolicy": { + "type": "string", + "description": "Policy for how the initial upload sync session is performed.", + "enum": [ + "ServerAuthoritative", + "Merge" + ], + "x-ms-enum": { + "name": "InitialUploadPolicy", + "modelAsString": true + } + }, "ServerEndpointHealthState": { "type": "string", "description": "Type of the server endpoint health state", @@ -5162,6 +5187,189 @@ "name": "RegisteredServerAgentVersionStatus", "modelAsString": true } + }, + "CloudEndpointChangeEnumerationStatus": { + "type": "object", + "description": "Cloud endpoint change enumeration status object", + "properties": { + "lastUpdatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Last updated timestamp", + "readOnly": true + }, + "lastEnumerationStatus": { + "$ref": "#/definitions/CloudEndpointLastChangeEnumerationStatus", + "description": "Status of last completed change enumeration", + "readOnly": true + }, + "activity": { + "$ref": "#/definitions/CloudEndpointChangeEnumerationActivity", + "description": "Change enumeration activity", + "readOnly": true + } + } + }, + "CloudEndpointLastChangeEnumerationStatus": { + "type": "object", + "description": "Cloud endpoint change enumeration status object", + "properties": { + "startedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Timestamp when change enumeration started", + "readOnly": true + }, + "completedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Timestamp when change enumeration completed", + "readOnly": true + }, + "namespaceFilesCount": { + "type": "integer", + "format": "int64", + "minimum": 0, + "description": "Count of files in the namespace", + "readOnly": true + }, + "namespaceDirectoriesCount": { + "type": "integer", + "format": "int64", + "minimum": 0, + "description": "Count of directories in the namespace", + "readOnly": true + }, + "namespaceSizeBytes": { + "type": "integer", + "format": "int64", + "minimum": 0, + "description": "Namespace size in bytes", + "readOnly": true + }, + "nextRunTimestamp": { + "type": "string", + "format": "date-time", + "description": "Timestamp of when change enumeration is expected to run again", + "readOnly": true + } + } + }, + "CloudEndpointChangeEnumerationActivity": { + "type": "object", + "description": "Cloud endpoint change enumeration activity object", + "properties": { + "lastUpdatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Last updated timestamp", + "readOnly": true + }, + "operationState": { + "$ref": "#/definitions/CloudEndpointChangeEnumerationActivityState", + "description": "Change enumeration operation state", + "readOnly": true + }, + "statusCode": { + "type": "integer", + "format": "int32", + "description": "When non-zero, indicates an issue that is delaying change enumeration", + "readOnly": true + }, + "startedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Timestamp when change enumeration started", + "readOnly": true + }, + "processedFilesCount": { + "type": "integer", + "format": "int64", + "minimum": 0, + "description": "Count of files processed", + "readOnly": true + }, + "processedDirectoriesCount": { + "type": "integer", + "format": "int64", + "minimum": 0, + "description": "Count of directories processed", + "readOnly": true + }, + "totalFilesCount": { + "type": "integer", + "format": "int64", + "minimum": 0, + "description": "Total count of files enumerated", + "readOnly": true + }, + "totalDirectoriesCount": { + "type": "integer", + "format": "int64", + "minimum": 0, + "description": "Total count of directories enumerated", + "readOnly": true + }, + "totalSizeBytes": { + "type": "integer", + "format": "int64", + "minimum": 0, + "description": "Total enumerated size in bytes", + "readOnly": true + }, + "progressPercent": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100, + "description": "Progress percentage for change enumeration run, excluding processing of deletes", + "readOnly": true + }, + "minutesRemaining": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "Estimate of time remaining for the enumeration run", + "readOnly": true + }, + "totalCountsState": { + "$ref": "#/definitions/CloudEndpointChangeEnumerationTotalCountsState", + "description": "Change enumeration total counts state", + "readOnly": true + }, + "deletesProgressPercent": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100, + "description": "Progress percentage for processing deletes. This is done separately from the rest of the enumeration run", + "readOnly": true + } + } + }, + "CloudEndpointChangeEnumerationActivityState": { + "type": "string", + "description": "State of change enumeration activity", + "enum": [ + "InitialEnumerationInProgress", + "EnumerationInProgress" + ], + "x-ms-enum": { + "name": "CloudEndpointChangeEnumerationActivityState", + "modelAsString": true + } + }, + "CloudEndpointChangeEnumerationTotalCountsState": { + "type": "string", + "description": "State of the total counts of change enumeration activity", + "enum": [ + "Calculating", + "Final" + ], + "x-ms-enum": { + "name": "CloudEndpointChangeEnumerationTotalCountsState", + "modelAsString": true + } } }, "parameters": { diff --git a/specification/storagesync/resource-manager/readme.go.md b/specification/storagesync/resource-manager/readme.go.md index b3fdfce2d55b..2141845ca154 100644 --- a/specification/storagesync/resource-manager/readme.go.md +++ b/specification/storagesync/resource-manager/readme.go.md @@ -13,6 +13,7 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2020-09-01 - tag: package-2020-03-01 - tag: package-2019-10-01 - tag: package-2019-06-01 @@ -22,6 +23,15 @@ batch: - tag: package-2018-04-02 ``` +### Tag: package-2020-09-01 and go + +These settings apply only when `--tag=package-2020-09-01 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2020-09-01' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-09-01/$(namespace) +``` + ### Tag: package-2020-03-01 and go These settings apply only when `--tag=package-2020-03-01 --go` is specified on the command line. diff --git a/specification/storagesync/resource-manager/readme.md b/specification/storagesync/resource-manager/readme.md index abfbbe513a00..4d9182db74c3 100644 --- a/specification/storagesync/resource-manager/readme.md +++ b/specification/storagesync/resource-manager/readme.md @@ -26,17 +26,17 @@ These are the global settings for the Storage Sync API. ``` yaml openapi-type: arm -tag: package-preview-2020-09-01 +tag: package-2020-09-01 ``` -### Tag: package-preview-2020-09-01 +### Tag: package-2020-09-01 -These settings apply only when `--tag=package-preview-2020-09-01` is specified on the command line. +These settings apply only when `--tag=package-2020-09-01` is specified on the command line. -```yaml $(tag) == 'package-preview-2020-09-01' +```yaml $(tag) == 'package-2020-09-01' input-file: - - Microsoft.StorageSync/preview/2020-09-01/storagesync.json + - Microsoft.StorageSync/stable/2020-09-01/storagesync.json ``` ### Tag: package-2020-03-01 @@ -131,7 +131,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/storagesync/resource-manager/readme.python.md b/specification/storagesync/resource-manager/readme.python.md index 345560f54a6d..481ceabadd7c 100644 --- a/specification/storagesync/resource-manager/readme.python.md +++ b/specification/storagesync/resource-manager/readme.python.md @@ -4,38 +4,15 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -```yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.storagesync - package-name: azure-mgmt-storagesync - package-version: 1.0.0 - clear-output-folder: true -``` ```yaml $(python) && $(track2) -python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.storagesync package-name: azure-mgmt-storagesync -package-version: 1.0.0 +package-version: 1.0.0b1 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/storage/azure-mgmt-storagesync/azure/mgmt/storagesync -``` - -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/storage/azure-mgmt-storagesync -``` ``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/storage/azure-mgmt-storagesync/azure/mgmt/storagesync diff --git a/specification/storagesync/resource-manager/readme.ruby.md b/specification/storagesync/resource-manager/readme.ruby.md index fc40a959dbd7..50b3a6cdd110 100644 --- a/specification/storagesync/resource-manager/readme.ruby.md +++ b/specification/storagesync/resource-manager/readme.ruby.md @@ -12,6 +12,7 @@ azure-arm: true ``` yaml $(ruby) && $(multiapi) batch: + - tag: package-2020-09-01 - tag: package-2020-03-01 - tag: package-2019-02-01 - tag: package-2018-10-01 @@ -19,6 +20,16 @@ batch: - tag: package-2018-04-02 ``` +### Tag: package-2020-09-01 and ruby + +These settings apply only when `--tag=package-2020-09-01 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2020-09-01' && $(ruby) +namespace: "Azure::StorageSync::Mgmt::V2020_09_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_storagesync_management/lib +``` + ### Tag: package-2020-03-01 and ruby These settings apply only when `--tag=package-2020-03-01 --ruby` is specified on the command line. diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/common/v1/definitions.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/common/v1/definitions.json index cdc06f254b09..21e6eaf74a24 100644 --- a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/common/v1/definitions.json +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/common/v1/definitions.json @@ -38,6 +38,8 @@ } }, "Resource": { + "type": "object", + "description": "The base resource definition", "properties": { "id": { "readOnly": true, @@ -58,6 +60,7 @@ "x-ms-azure-resource": true }, "TrackedResource": { + "type": "object", "description": "The resource model definition for a ARM tracked top level resource", "properties": { "tags": { @@ -88,6 +91,7 @@ ] }, "ProxyResource": { + "type": "object", "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", "allOf": [ { @@ -96,8 +100,10 @@ ] }, "Error": { + "type": "object", "properties": { "error": { + "type": "object", "properties": { "code": { "type": "string", @@ -125,6 +131,7 @@ "description": "Common error representation." }, "ErrorDetails": { + "type": "object", "properties": { "code": { "type": "string", @@ -193,6 +200,14 @@ "minLength": 1, "maxLength": 90, "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The region to which the request is sent. You can find out which regions Azure Stream Analytics is supported in here: https://azure.microsoft.com/en-us/regions/", + "x-ms-parameter-location": "method" } } } diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_CompileQuery.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_CompileQuery.json new file mode 100644 index 000000000000..6a389438a862 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_CompileQuery.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "location": "West US", + "compileQuery": { + "query": "SELECT\r\n *\r\nINTO\r\n [output1]\r\nFROM\r\n [input1]", + "inputs": [ + { + "name": "input1", + "type": "Stream" + } + ], + "functions": [ + { + "name": "function1", + "type": "Scalar", + "bindingType": "Microsoft.StreamAnalytics/JavascriptUdf", + "inputs": [ + { + "dataType": "any", + "isConfigurationParameter": null + } + ], + "output": { + "dataType": "bigint" + } + } + ], + "jobType": "Cloud", + "compatibilityLevel": "1.2" + } + }, + "responses": { + "200": { + "body": { + "errors": [ + { + "message": "Query failed to compile.", + "isGlobal": true + } + ], + "inputs": [ + "inputtest" + ], + "outputs": [ + "outputtest" + ], + "functions": [ + "transformationtest" + ] + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_SampleInput.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_SampleInput.json new file mode 100644 index 000000000000..c5015cc6c2c5 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_SampleInput.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "location": "West US", + "sampleInput": { + "input": { + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName", + "accountKey": "someAccountKey==" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH", + "sourcePartitionCount": 16 + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + }, + "compatibilityLevel": "1.2", + "eventsUri": "http://myoutput.com", + "dataLocale": "en-US" + } + }, + "responses": { + "202": { + "body": { + "status": "ReadAllEventsInRange", + "diagnostics": [ + "" + ], + "eventsDownloadUrl": "http://myoutput.com", + "lastArrivalTime": "2020-12-05T14:35:00Z" + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_TestInput.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_TestInput.json new file mode 100644 index 000000000000..24bc6ca20419 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_TestInput.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "location": "West US", + "testInput": { + "input": { + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName", + "accountKey": "someAccountKey==" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH", + "sourcePartitionCount": 16 + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + } + }, + "responses": { + "202": { + "body": { + "status": "TestSuceeded" + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_TestOutput.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_TestOutput.json new file mode 100644 index 000000000000..d016882c7994 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_TestOutput.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "location": "West US", + "testOutput": { + "output": { + "properties": { + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName", + "accountKey": "accountKey==" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + } + }, + "responses": { + "202": { + "body": { + "status": "TestSuceeded" + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_TestQuery.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_TestQuery.json new file mode 100644 index 000000000000..f4bce8a44f88 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_TestQuery.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "location": "West US", + "testQuery": { + "diagnostics": { + "writeUri": "http://myoutput.com", + "path": "/pathto/subdirectory" + }, + "streamingJob": { + "properties": { + "sku": { + "name": "Standard" + }, + "eventsOutOfOrderPolicy": "Drop", + "outputErrorPolicy": "Drop", + "eventsOutOfOrderMaxDelayInSeconds": 0, + "eventsLateArrivalMaxDelayInSeconds": 5, + "dataLocale": "en-US", + "compatibilityLevel": "1.0", + "inputs": [ + { + "properties": { + "type": "Stream", + "datasource": { + "type": "Raw", + "properties": { + "payloadUri": "http://myinput.com" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + } + }, + "name": "inputtest" + } + ], + "transformation": { + "properties": { + "streamingUnits": 1, + "query": "Select Id, Name from inputtest" + }, + "name": "transformationtest" + }, + "outputs": [ + { + "properties": { + "datasource": { + "type": "Raw", + "properties": { + "payloadUri": "http://myoutput.com" + } + }, + "serialization": { + "type": "Json" + } + }, + "name": "outputtest" + } + ], + "functions": [] + }, + "location": "West US", + "tags": { + "key1": "value1", + "randomKey": "randomValue", + "key3": "value3" + } + } + } + }, + "responses": { + "200": { + "body": { + "status": "Success", + "outputUri": "http://myoutput.com" + } + }, + "202": {} + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/functions.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/functions.json index b33a07742e00..403d9ab28c89 100644 --- a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/functions.json +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/functions.json @@ -120,6 +120,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -183,6 +189,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -220,6 +232,12 @@ }, "204": { "description": "The function does not exist." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -266,6 +284,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } } @@ -309,6 +333,12 @@ "schema": { "$ref": "#/definitions/FunctionListResult" } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-pageable": { @@ -366,12 +396,18 @@ }, "202": { "description": "The test request was successfully initiated." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/functions/{functionName}/RetrieveDefaultDefinition": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/functions/{functionName}/retrieveDefaultDefinition": { "post": { "tags": [ "Functions" @@ -415,6 +451,12 @@ "schema": { "$ref": "#/definitions/Function" } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } } @@ -423,6 +465,7 @@ "definitions": { "Function": { "description": "A function object, containing all information associated with the named function. All functions are contained under a streaming job.", + "type": "object", "allOf": [ { "$ref": "#/definitions/SubResource" @@ -437,6 +480,7 @@ }, "FunctionProperties": { "description": "The properties that are associated with a function.", + "type": "object", "discriminator": "type", "properties": { "type": { @@ -458,6 +502,7 @@ ] }, "FunctionConfiguration": { + "type": "object", "properties": { "inputs": { "type": "array", @@ -475,6 +520,7 @@ }, "ScalarFunctionProperties": { "description": "The properties that are associated with a scalar function.", + "type": "object", "x-ms-discriminator-value": "Scalar", "allOf": [ { @@ -484,6 +530,7 @@ }, "FunctionInput": { "description": "Describes one input parameter of a function.", + "type": "object", "properties": { "dataType": { "type": "string", @@ -497,6 +544,7 @@ }, "FunctionOutput": { "description": "Describes the output of a function.", + "type": "object", "properties": { "dataType": { "type": "string", @@ -506,6 +554,7 @@ }, "FunctionBinding": { "description": "The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint.", + "type": "object", "discriminator": "type", "properties": { "type": { @@ -519,6 +568,7 @@ }, "AzureMachineLearningStudioFunctionBinding": { "description": "The binding to an Azure Machine Learning Studio.", + "type": "object", "x-ms-discriminator-value": "Microsoft.MachineLearning/WebService", "allOf": [ { @@ -535,6 +585,7 @@ }, "AzureMachineLearningStudioFunctionBindingProperties": { "description": "The binding properties associated with an Azure Machine learning Studio.", + "type": "object", "properties": { "endpoint": { "type": "string", @@ -564,6 +615,7 @@ }, "AzureMachineLearningStudioInputs": { "description": "The inputs for the Azure Machine Learning Studio endpoint.", + "type": "object", "properties": { "name": { "type": "string", @@ -580,6 +632,7 @@ }, "AzureMachineLearningStudioInputColumn": { "description": "Describes an input column for the Azure Machine Learning Studio endpoint.", + "type": "object", "properties": { "name": { "type": "string", @@ -598,6 +651,7 @@ }, "AzureMachineLearningStudioOutputColumn": { "description": "Describes an output column for the Azure Machine Learning Studio endpoint.", + "type": "object", "properties": { "name": { "type": "string", @@ -611,6 +665,7 @@ }, "JavaScriptFunctionBinding": { "description": "The binding to a JavaScript function.", + "type": "object", "x-ms-discriminator-value": "Microsoft.StreamAnalytics/JavascriptUdf", "allOf": [ { @@ -627,6 +682,7 @@ }, "JavaScriptFunctionBindingProperties": { "description": "The binding properties associated with a JavaScript function.", + "type": "object", "properties": { "script": { "type": "string", @@ -636,6 +692,7 @@ }, "CSharpFunctionBinding": { "description": "The binding to a CSharp function.", + "type": "object", "x-ms-discriminator-value": "Microsoft.StreamAnalytics/CLRUdf", "allOf": [ { @@ -652,6 +709,7 @@ }, "CSharpFunctionBindingProperties": { "description": "The binding properties associated with a CSharp function.", + "type": "object", "properties": { "script": { "type": "string", @@ -673,6 +731,7 @@ }, "FunctionRetrieveDefaultDefinitionParameters": { "description": "Parameters used to specify the type of function to retrieve the default definition for.", + "type": "object", "discriminator": "bindingType", "properties": { "bindingType": { @@ -686,6 +745,7 @@ }, "AzureMachineLearningStudioFunctionRetrieveDefaultDefinitionParameters": { "description": "The parameters needed to retrieve the default function definition for an Azure Machine Learning Studio function.", + "type": "object", "x-ms-discriminator-value": "Microsoft.MachineLearning/WebService", "allOf": [ { @@ -702,6 +762,7 @@ }, "AzureMachineLearningStudioFunctionBindingRetrievalProperties": { "description": "The binding retrieval properties associated with an Azure Machine learning Studio.", + "type": "object", "properties": { "executeEndpoint": { "type": "string", @@ -715,6 +776,7 @@ }, "AzureMachineLearningServiceFunctionRetrieveDefaultDefinitionParameters": { "description": "The parameters needed to retrieve the default function definition for an Azure Machine Learning web service function.", + "type": "object", "x-ms-discriminator-value": "Microsoft.MachineLearningServices", "allOf": [ { @@ -731,6 +793,7 @@ }, "AzureMachineLearningServiceFunctionBindingRetrievalProperties": { "description": "The binding retrieval properties associated with an Azure Machine learning web service.", + "type": "object", "properties": { "executeEndpoint": { "type": "string", @@ -744,6 +807,7 @@ }, "JavaScriptFunctionRetrieveDefaultDefinitionParameters": { "description": "The parameters needed to retrieve the default function definition for a JavaScript function.", + "type": "object", "x-ms-discriminator-value": "Microsoft.StreamAnalytics/JavascriptUdf", "allOf": [ { @@ -760,6 +824,7 @@ }, "JavaScriptFunctionBindingRetrievalProperties": { "description": "The binding retrieval properties associated with a JavaScript function.", + "type": "object", "properties": { "script": { "type": "string", @@ -773,6 +838,7 @@ }, "CSharpFunctionRetrieveDefaultDefinitionParameters": { "description": "The parameters needed to retrieve the default function definition for a CSharp function.", + "type": "object", "x-ms-discriminator-value": "Microsoft.StreamAnalytics/CLRUdf", "allOf": [ { @@ -789,6 +855,7 @@ }, "CSharpFunctionBindingRetrievalProperties": { "description": "The binding retrieval properties associated with a CSharp function.", + "type": "object", "properties": { "script": { "type": "string", @@ -802,6 +869,7 @@ }, "AzureMachineLearningServiceFunctionBinding": { "description": "The binding to an Azure Machine Learning web service.", + "type": "object", "x-ms-discriminator-value": "Microsoft.MachineLearningServices", "allOf": [ { @@ -818,6 +886,7 @@ }, "AzureMachineLearningServiceFunctionBindingProperties": { "description": "The binding properties associated with an Azure Machine learning web service.", + "type": "object", "properties": { "endpoint": { "type": "string", @@ -855,6 +924,7 @@ }, "AzureMachineLearningServiceInputs": { "description": "The inputs for the Azure Machine Learning web service endpoint.", + "type": "object", "properties": { "name": { "type": "string", @@ -871,6 +941,7 @@ }, "AzureMachineLearningServiceInputColumn": { "description": "Describes an input column for the Azure Machine Learning web service endpoint.", + "type": "object", "properties": { "name": { "type": "string", @@ -889,6 +960,7 @@ }, "AzureMachineLearningServiceOutputColumn": { "description": "Describes an output column for the Azure Machine Learning web service endpoint.", + "type": "object", "properties": { "name": { "type": "string", @@ -906,6 +978,7 @@ } }, "FunctionListResult": { + "description": "Object containing a list of functions under a streaming job.", "properties": { "value": { "type": "array", @@ -920,8 +993,7 @@ "readOnly": true, "description": "The link (url) to the next page of results." } - }, - "description": "Object containing a list of functions under a streaming job." + } }, "UdfType": { "type": "string", @@ -936,6 +1008,7 @@ }, "SubResource": { "description": "The base sub-resource model definition.", + "type": "object", "properties": { "id": { "readOnly": true, @@ -956,6 +1029,7 @@ }, "AggregateFunctionProperties": { "description": "The properties that are associated with an aggregate function.", + "type": "object", "x-ms-discriminator-value": "Aggregate", "allOf": [ { diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/inputs.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/inputs.json index 51178cc6130c..c9cae92eed52 100644 --- a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/inputs.json +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/inputs.json @@ -120,6 +120,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -189,6 +195,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -226,6 +238,12 @@ }, "204": { "description": "The input does not exist." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -278,6 +296,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } } @@ -324,6 +348,12 @@ "schema": { "$ref": "#/definitions/InputListResult" } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-pageable": { @@ -378,6 +408,12 @@ }, "202": { "description": "The test request was successfully initiated." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-long-running-operation": true @@ -387,6 +423,7 @@ "definitions": { "Input": { "description": "An input object, containing all information associated with the named input. All inputs are contained under a streaming job.", + "type": "object", "allOf": [ { "$ref": "#/definitions/SubResource" @@ -401,6 +438,7 @@ }, "InputProperties": { "description": "The properties that are associated with an input.", + "type": "object", "discriminator": "type", "properties": { "type": { @@ -435,6 +473,7 @@ }, "StreamInputProperties": { "description": "The properties that are associated with an input containing stream data.", + "type": "object", "x-ms-discriminator-value": "Stream", "allOf": [ { @@ -450,6 +489,7 @@ }, "ReferenceInputProperties": { "description": "The properties that are associated with an input containing reference data.", + "type": "object", "x-ms-discriminator-value": "Reference", "allOf": [ { @@ -465,6 +505,7 @@ }, "StreamInputDataSource": { "description": "Describes an input data source that contains stream data.", + "type": "object", "discriminator": "type", "properties": { "type": { @@ -478,6 +519,7 @@ }, "BlobStreamInputDataSource": { "description": "Describes a blob input data source that contains stream data.", + "type": "object", "x-ms-discriminator-value": "Microsoft.Storage/Blob", "allOf": [ { @@ -494,6 +536,7 @@ }, "BlobStreamInputDataSourceProperties": { "description": "The properties that are associated with a blob input containing stream data.", + "type": "object", "allOf": [ { "$ref": "#/definitions/BlobDataSourceProperties" @@ -509,6 +552,7 @@ }, "EventHubStreamInputDataSource": { "description": "Describes an Event Hub input data source that contains stream data.", + "type": "object", "x-ms-discriminator-value": "Microsoft.ServiceBus/EventHub", "allOf": [ { @@ -525,6 +569,7 @@ }, "EventHubV2StreamInputDataSource": { "description": "Describes an Event Hub input data source that contains stream data.", + "type": "object", "x-ms-discriminator-value": "Microsoft.EventHub/EventHub", "allOf": [ { @@ -541,6 +586,7 @@ }, "EventHubStreamInputDataSourceProperties": { "description": "The properties that are associated with a Event Hub input containing stream data.", + "type": "object", "allOf": [ { "$ref": "#/definitions/EventHubDataSourceProperties" @@ -555,6 +601,7 @@ }, "IoTHubStreamInputDataSource": { "description": "Describes an IoT Hub input data source that contains stream data.", + "type": "object", "x-ms-discriminator-value": "Microsoft.Devices/IotHubs", "allOf": [ { @@ -571,6 +618,7 @@ }, "IoTHubStreamInputDataSourceProperties": { "description": "The properties that are associated with a IoT Hub input containing stream data.", + "type": "object", "properties": { "iotHubNamespace": { "type": "string", @@ -594,8 +642,26 @@ } } }, + "RawStreamInputDataSource": { + "description": "Describes a raw input data source that contains stream data. This data source type is only applicable/usable when using the query testing API. You cannot create a job with this data source type or add an input of this data source type to an existing job.", + "type": "object", + "x-ms-discriminator-value": "Raw", + "allOf": [ + { + "$ref": "#/definitions/StreamInputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RawInputDatasourceProperties", + "description": "The properties that are associated with a raw input. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, "ReferenceInputDataSource": { "description": "Describes an input data source that contains reference data.", + "type": "object", "discriminator": "type", "properties": { "type": { @@ -609,6 +675,7 @@ }, "BlobReferenceInputDataSource": { "description": "Describes a blob input data source that contains reference data.", + "type": "object", "x-ms-discriminator-value": "Microsoft.Storage/Blob", "allOf": [ { @@ -625,6 +692,7 @@ }, "BlobReferenceInputDataSourceProperties": { "description": "The properties that are associated with a blob input containing reference data.", + "type": "object", "allOf": [ { "$ref": "#/definitions/BlobDataSourceProperties" @@ -632,8 +700,26 @@ ], "properties": {} }, + "RawReferenceInputDataSource": { + "description": "Describes a raw input data source that contains reference data. This data source type is only applicable/usable when using the query testing API. You cannot create a job with this data source type or add an input of this data source type to an existing job.", + "type": "object", + "x-ms-discriminator-value": "Raw", + "allOf": [ + { + "$ref": "#/definitions/ReferenceInputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RawInputDatasourceProperties", + "description": "The properties that are associated with a raw input containing reference data. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, "BlobDataSourceProperties": { "description": "The properties that are associated with a blob data source.", + "type": "object", "properties": { "storageAccounts": { "type": "array", @@ -660,8 +746,23 @@ } } }, + "RawInputDatasourceProperties": { + "description": "The properties that are associated with a raw input.", + "type": "object", + "properties": { + "payload": { + "description": "The JSON serialized content of the input data. Either payload or payloadUri must be set, but not both. ", + "type": "string" + }, + "payloadUri": { + "description": "The SAS URL to a blob containing the JSON serialized content of the input data. Either payload or payloadUri must be set, but not both.", + "type": "string" + } + } + }, "StorageAccount": { "description": "The properties that are associated with an Azure Storage account", + "type": "object", "properties": { "accountName": { "type": "string", @@ -675,6 +776,7 @@ }, "ServiceBusDataSourceProperties": { "description": "The common properties that are associated with Service Bus data sources (Queues, Topics, Event Hubs, etc.).", + "type": "object", "properties": { "serviceBusNamespace": { "type": "string", @@ -696,6 +798,7 @@ }, "EventHubDataSourceProperties": { "description": "The common properties that are associated with Event Hub data sources.", + "type": "object", "allOf": [ { "$ref": "#/definitions/ServiceBusDataSourceProperties" @@ -710,6 +813,7 @@ }, "Diagnostics": { "description": "Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention.", + "type": "object", "properties": { "conditions": { "readOnly": true, @@ -723,6 +827,7 @@ }, "DiagnosticCondition": { "description": "Condition applicable to the resource, or to the job overall, that warrant customer attention.", + "type": "object", "properties": { "since": { "readOnly": true, @@ -742,6 +847,8 @@ } }, "InputListResult": { + "description": "Object containing a list of inputs under a streaming job.", + "type": "object", "properties": { "value": { "type": "array", @@ -756,11 +863,11 @@ "readOnly": true, "description": "The link (url) to the next page of results." } - }, - "description": "Object containing a list of inputs under a streaming job." + } }, "Serialization": { "description": "Describes how data from an input is serialized or how data is serialized when written to an output.", + "type": "object", "discriminator": "type", "properties": { "type": { @@ -773,6 +880,7 @@ }, "ParquetSerialization": { "description": "Describes how data from an input is serialized or how data is serialized when written to an output in Parquet format.", + "type": "object", "x-ms-discriminator-value": "Parquet", "allOf": [ { @@ -789,10 +897,12 @@ }, "ParquetSerializationProperties": { "description": "The properties that are associated with the Parquet serialization type.", + "type": "object", "properties": {} }, "CustomClrSerialization": { "description": "Describes how data from an input is serialized or how data is serialized when written to an output in custom format.", + "type": "object", "x-ms-discriminator-value": "CustomClr", "allOf": [ { @@ -809,6 +919,7 @@ }, "CustomClrSerializationProperties": { "description": "The properties that are associated with the CustomClr serialization type.", + "type": "object", "properties": { "serializationDllPath": { "type": "string", @@ -822,6 +933,7 @@ }, "CsvSerialization": { "description": "Describes how data from an input is serialized or how data is serialized when written to an output in CSV format.", + "type": "object", "x-ms-discriminator-value": "Csv", "allOf": [ { @@ -838,6 +950,7 @@ }, "CsvSerializationProperties": { "description": "The properties that are associated with the CSV serialization type.", + "type": "object", "properties": { "fieldDelimiter": { "type": "string", @@ -851,6 +964,7 @@ }, "JsonSerialization": { "description": "Describes how data from an input is serialized or how data is serialized when written to an output in JSON format.", + "type": "object", "x-ms-discriminator-value": "Json", "allOf": [ { @@ -867,6 +981,7 @@ }, "JsonSerializationProperties": { "description": "The properties that are associated with the JSON serialization type.", + "type": "object", "properties": { "encoding": { "$ref": "#/definitions/Encoding", @@ -880,6 +995,7 @@ }, "AvroSerialization": { "description": "Describes how data from an input is serialized or how data is serialized when written to an output in Avro format.", + "type": "object", "x-ms-discriminator-value": "Avro", "allOf": [ { @@ -896,6 +1012,7 @@ }, "AvroSerializationProperties": { "description": "The properties that are associated with the Avro serialization type.", + "type": "object", "properties": {} }, "Encoding": { @@ -923,6 +1040,7 @@ }, "ResourceTestStatus": { "description": "Describes the status of the test operation along with error information, if applicable.", + "type": "object", "properties": { "status": { "readOnly": true, @@ -938,6 +1056,7 @@ }, "ErrorResponse": { "description": "Describes the error that occurred.", + "type": "object", "properties": { "code": { "readOnly": true, @@ -953,6 +1072,7 @@ }, "SubResource": { "description": "The base sub-resource model definition.", + "type": "object", "properties": { "id": { "readOnly": true, @@ -973,6 +1093,7 @@ }, "Compression": { "description": "Describes how input data is compressed", + "type": "object", "properties": { "type": { "type": "string" @@ -984,6 +1105,7 @@ }, "Identity": { "description": "Describes how identity is verified", + "type": "object", "properties": { "tenantId": { "type": "string" @@ -998,6 +1120,7 @@ }, "AzureSqlReferenceInputDataSource": { "description": "Describes an Azure SQL database reference input data source.", + "type": "object", "x-ms-discriminator-value": "Microsoft.Sql/Server/Database", "allOf": [ { @@ -1011,6 +1134,8 @@ } }, "AzureSqlReferenceInputDataSourceProperties": { + "description": "Describes Azure SQL database reference input data source properties.", + "type": "object", "properties": { "server": { "description": "This element is associated with the datasource element. This is the name of the server that contains the database that will be written to.", diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/operations.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/operations.json index 1272302df934..75b1b2f27efa 100644 --- a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/operations.json +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/operations.json @@ -56,6 +56,12 @@ "schema": { "$ref": "#/definitions/OperationListResult" } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-pageable": { @@ -67,6 +73,7 @@ "definitions": { "OperationListResult": { "description": "Result of the request to list Stream Analytics 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 Stream Analytics operations supported by the Microsoft.StreamAnalytics resource provider.", @@ -94,6 +101,7 @@ }, "display": { "description": "Contains the localized display information for this particular operation / action.", + "type": "object", "readOnly": true, "properties": { "provider": { diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/outputs.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/outputs.json index 0e2134ff78df..bc4f331876d0 100644 --- a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/outputs.json +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/outputs.json @@ -135,6 +135,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -219,6 +225,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -256,6 +268,12 @@ }, "204": { "description": "The output does not exist." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -329,6 +347,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } } @@ -372,6 +396,12 @@ "schema": { "$ref": "#/definitions/OutputListResult" } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-pageable": { @@ -426,6 +456,12 @@ }, "202": { "description": "The test request was successfully initiated." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-long-running-operation": true @@ -435,6 +471,7 @@ "definitions": { "Output": { "description": "An output object, containing all information associated with the named output. All outputs are contained under a streaming job.", + "type": "object", "allOf": [ { "$ref": "#/definitions/SubResource" @@ -450,6 +487,7 @@ }, "OutputProperties": { "description": "The properties that are associated with an output.", + "type": "object", "properties": { "datasource": { "$ref": "#/definitions/OutputDataSource", @@ -479,6 +517,7 @@ }, "OutputDataSource": { "description": "Describes the data source that output will be written to.", + "type": "object", "discriminator": "type", "properties": { "type": { @@ -490,8 +529,36 @@ "type" ] }, + "RawOutputDatasource": { + "description": "Describes a raw output data source. This data source type is only applicable/usable when using the query testing API. You cannot create a job with this data source type or add an output of this data source type to an existing job.", + "type": "object", + "x-ms-discriminator-value": "Raw", + "allOf": [ + { + "$ref": "#/definitions/OutputDataSource" + } + ], + "properties": { + "properties": { + "description": "The properties that are associated with a raw output. Required on PUT (CreateOrReplace) requests.", + "$ref": "#/definitions/RawOutputDatasourceProperties", + "x-ms-client-flatten": true + } + } + }, + "RawOutputDatasourceProperties": { + "description": "The properties that are associated with a raw output.", + "type": "object", + "properties": { + "payloadUri": { + "description": "The SAS URL to a blob where the output should be written. If this property is not set, output data will be written into a temporary storage, and a SAS URL to that temporary storage will be included in the result.", + "type": "string" + } + } + }, "BlobOutputDataSource": { "description": "Describes a blob output data source.", + "type": "object", "x-ms-discriminator-value": "Microsoft.Storage/Blob", "allOf": [ { @@ -508,6 +575,7 @@ }, "BlobOutputDataSourceProperties": { "description": "The properties that are associated with a blob output.", + "type": "object", "allOf": [ { "$ref": "./inputs.json#/definitions/BlobDataSourceProperties" @@ -522,6 +590,7 @@ }, "AzureTableOutputDataSource": { "description": "Describes an Azure Table output data source.", + "type": "object", "x-ms-discriminator-value": "Microsoft.Storage/Table", "allOf": [ { @@ -538,6 +607,7 @@ }, "AzureTableOutputDataSourceProperties": { "description": "The properties that are associated with an Azure Table output.", + "type": "object", "properties": { "accountName": { "type": "string", @@ -575,6 +645,7 @@ }, "EventHubOutputDataSource": { "description": "Describes an Event Hub output data source.", + "type": "object", "x-ms-discriminator-value": "Microsoft.ServiceBus/EventHub", "allOf": [ { @@ -591,6 +662,7 @@ }, "EventHubV2OutputDataSource": { "description": "Describes an Event Hub output data source.", + "type": "object", "x-ms-discriminator-value": "Microsoft.EventHub/EventHub", "allOf": [ { @@ -607,6 +679,7 @@ }, "EventHubOutputDataSourceProperties": { "description": "The properties that are associated with an Event Hub output.", + "type": "object", "allOf": [ { "$ref": "./inputs.json#/definitions/EventHubDataSourceProperties" @@ -627,6 +700,7 @@ }, "AzureSqlDatabaseOutputDataSource": { "description": "Describes an Azure SQL database output data source.", + "type": "object", "x-ms-discriminator-value": "Microsoft.Sql/Server/Database", "allOf": [ { @@ -643,6 +717,7 @@ }, "AzureSqlDatabaseOutputDataSourceProperties": { "description": "The properties that are associated with an Azure SQL database output.", + "type": "object", "allOf": [ { "$ref": "#/definitions/AzureSqlDatabaseDataSourceProperties" @@ -652,6 +727,7 @@ }, "AzureSynapseOutputDataSource": { "description": "Describes an Azure Synapse output data source.", + "type": "object", "x-ms-discriminator-value": "Microsoft.Sql/Server/DataWarehouse", "allOf": [ { @@ -668,6 +744,7 @@ }, "AzureSynapseOutputDataSourceProperties": { "description": "The properties that are associated with an Azure Synapse output.", + "type": "object", "allOf": [ { "$ref": "#/definitions/AzureSynapseDataSourceProperties" @@ -677,6 +754,7 @@ }, "AzureSynapseDataSourceProperties": { "description": "The properties that are associated with an Azure SQL database data source.", + "type": "object", "properties": { "server": { "type": "string", @@ -702,6 +780,7 @@ }, "DocumentDbOutputDataSource": { "description": "Describes a DocumentDB output data source.", + "type": "object", "x-ms-discriminator-value": "Microsoft.Storage/DocumentDB", "allOf": [ { @@ -718,6 +797,7 @@ }, "DocumentDbOutputDataSourceProperties": { "description": "The properties that are associated with a DocumentDB output.", + "type": "object", "properties": { "accountId": { "type": "string", @@ -747,6 +827,7 @@ }, "AzureFunctionOutputDataSource": { "description": "Defines the metadata of AzureFunctionOutputDataSource", + "type": "object", "x-ms-discriminator-value": "Microsoft.AzureFunction", "allOf": [ { @@ -763,6 +844,7 @@ }, "AzureFunctionOutputDataSourceProperties": { "description": "The properties that are associated with a DocumentDB output.", + "type": "object", "properties": { "functionAppName": { "description": "The name of your Azure Functions app.", @@ -788,6 +870,7 @@ }, "ServiceBusQueueOutputDataSource": { "description": "Describes a Service Bus Queue output data source.", + "type": "object", "x-ms-discriminator-value": "Microsoft.ServiceBus/Queue", "allOf": [ { @@ -804,6 +887,7 @@ }, "ServiceBusQueueOutputDataSourceProperties": { "description": "The properties that are associated with a Service Bus Queue output.", + "type": "object", "allOf": [ { "$ref": "./inputs.json#/definitions/ServiceBusDataSourceProperties" @@ -831,6 +915,7 @@ }, "ServiceBusTopicOutputDataSource": { "description": "Describes a Service Bus Topic output data source.", + "type": "object", "x-ms-discriminator-value": "Microsoft.ServiceBus/Topic", "allOf": [ { @@ -847,6 +932,7 @@ }, "ServiceBusTopicOutputDataSourceProperties": { "description": "The properties that are associated with a Service Bus Topic output.", + "type": "object", "allOf": [ { "$ref": "./inputs.json#/definitions/ServiceBusDataSourceProperties" @@ -874,6 +960,7 @@ }, "PowerBIOutputDataSource": { "description": "Describes a Power BI output data source.", + "type": "object", "x-ms-discriminator-value": "PowerBI", "allOf": [ { @@ -890,6 +977,7 @@ }, "PowerBIOutputDataSourceProperties": { "description": "The properties that are associated with a Power BI output.", + "type": "object", "allOf": [ { "$ref": "#/definitions/OAuthBasedDataSourceProperties" @@ -920,6 +1008,7 @@ }, "AzureDataLakeStoreOutputDataSource": { "description": "Describes an Azure Data Lake Store output data source.", + "type": "object", "x-ms-discriminator-value": "Microsoft.DataLake/Accounts", "allOf": [ { @@ -936,6 +1025,7 @@ }, "AzureDataLakeStoreOutputDataSourceProperties": { "description": "The properties that are associated with an Azure Data Lake Store.", + "type": "object", "allOf": [ { "$ref": "#/definitions/OAuthBasedDataSourceProperties" @@ -969,6 +1059,8 @@ } }, "OutputListResult": { + "description": "Object containing a list of outputs under a streaming job.", + "type": "object", "properties": { "value": { "type": "array", @@ -983,11 +1075,11 @@ "readOnly": true, "description": "The link (url) to the next page of results." } - }, - "description": "Object containing a list of outputs under a streaming job." + } }, "AzureSqlDatabaseDataSourceProperties": { "description": "The properties that are associated with an Azure SQL database data source.", + "type": "object", "properties": { "server": { "type": "string", @@ -1025,6 +1117,7 @@ }, "OAuthBasedDataSourceProperties": { "description": "The properties that are associated with data sources that use OAuth as their authentication model.", + "type": "object", "properties": { "refreshToken": { "type": "string", @@ -1042,6 +1135,7 @@ }, "SubResource": { "description": "The base sub-resource model definition.", + "type": "object", "properties": { "id": { "readOnly": true, diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/streamingjobs.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/streamingjobs.json index d2fc8f4ffeef..8d64e173e3f2 100644 --- a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/streamingjobs.json +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/streamingjobs.json @@ -111,6 +111,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-long-running-operation": true @@ -169,6 +175,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -206,6 +218,12 @@ }, "204": { "description": "The streaming job does not exist." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-long-running-operation": true @@ -257,6 +275,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } } @@ -300,6 +324,12 @@ "schema": { "$ref": "#/definitions/StreamingJobListResult" } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-pageable": { @@ -343,6 +373,12 @@ "schema": { "$ref": "#/definitions/StreamingJobListResult" } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-pageable": { @@ -397,6 +433,12 @@ }, "202": { "description": "The start streaming job request was successfully initiated." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-long-running-operation": true @@ -434,6 +476,12 @@ }, "202": { "description": "The stop streaming job request was successfully initiated." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-long-running-operation": true @@ -443,6 +491,7 @@ "definitions": { "External": { "description": "The storage account where the custom code artifacts are located.", + "type": "object", "properties": { "storageAccount": { "$ref": "./inputs.json#/definitions/StorageAccount" @@ -455,63 +504,9 @@ } } }, - "OperationListResult": { - "description": "Result of the request to list Stream Analytics operations. It contains a list of operations and a URL link to get the next set of results.", - "properties": { - "value": { - "description": "List of Stream Analytics operations supported by the Microsoft.StreamAnalytics resource provider.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Operation" - } - }, - "nextLink": { - "description": "URL to get the next set of operation list results if there are any.", - "type": "string", - "readOnly": true - } - } - }, - "Operation": { - "description": "A Stream Analytics REST API operation", - "type": "object", - "properties": { - "name": { - "description": "The name of the operation being performed on this particular object.", - "type": "string", - "readOnly": true - }, - "display": { - "description": "Contains the localized display information for this particular operation / action.", - "readOnly": true, - "properties": { - "provider": { - "description": "The localized friendly form of the resource provider name.", - "type": "string", - "readOnly": true - }, - "resource": { - "description": "The localized friendly form of the resource type related to this action/operation.", - "type": "string", - "readOnly": true - }, - "operation": { - "description": "The localized friendly name for the operation.", - "type": "string", - "readOnly": true - }, - "description": { - "description": "The localized friendly description for the operation.", - "type": "string", - "readOnly": true - } - } - } - } - }, "StreamingJob": { "description": "A streaming job object, containing all information associated with the named streaming job.", + "type": "object", "allOf": [ { "$ref": "../../common/v1/definitions.json#/definitions/TrackedResource" @@ -531,6 +526,7 @@ }, "StreamingJobProperties": { "description": "The properties that are associated with a streaming job.", + "type": "object", "properties": { "sku": { "description": "Describes the SKU of the streaming job. Required on PUT (CreateOrReplace) requests.", @@ -668,6 +664,7 @@ }, "ClusterInfo": { "description": "The properties associated with a Stream Analytics cluster.", + "type": "object", "properties": { "id": { "description": "The resource id of cluster.", @@ -677,6 +674,7 @@ }, "StreamingJobSku": { "description": "The properties that are associated with a SKU.", + "type": "object", "properties": { "name": { "type": "string", @@ -692,6 +690,7 @@ } }, "StreamingJobListResult": { + "description": "Object containing a list of streaming jobs.", "properties": { "value": { "type": "array", @@ -706,11 +705,11 @@ "readOnly": true, "description": "The link (url) to the next page of results." } - }, - "description": "Object containing a list of streaming jobs." + } }, "StartStreamingJobParameters": { "description": "Parameters supplied to the Start Streaming Job operation.", + "type": "object", "properties": { "outputStartMode": { "$ref": "#/definitions/OutputStartMode", @@ -773,6 +772,7 @@ }, "JobStorageAccount": { "description": "The properties that are associated with an Azure Storage account with MSI", + "type": "object", "allOf": [ { "$ref": "./inputs.json#/definitions/StorageAccount" diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/subscriptions.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/subscriptions.json index e20939d8ed25..b72a491c50c8 100644 --- a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/subscriptions.json +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/subscriptions.json @@ -47,11 +47,7 @@ }, "parameters": [ { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The region in which to retrieve the subscription's quota information. You can find out which regions Azure Stream Analytics is supported in here: https://azure.microsoft.com/en-us/regions/" + "$ref": "../../common/v1/definitions.json#/parameters/LocationParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" @@ -66,6 +62,271 @@ "schema": { "$ref": "#/definitions/SubscriptionQuotasListResult" } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StreamAnalytics/locations/{location}/testQuery": { + "post": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_TestQuery", + "description": "Test the Stream Analytics query on a sample input.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Test the Stream Analytics query": { + "$ref": "./examples/Subscription_TestQuery.json" + } + }, + "parameters": [ + { + "name": "testQuery", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TestQuery" + }, + "description": "The query testing object that defines the input, output, and transformation for the query testing." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/LocationParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The request to test the Stream Analytics query was successful.", + "schema": { + "$ref": "#/definitions/QueryTestingResult" + } + }, + "202": { + "description": "The request to test the Stream Analytics query was successfully initiated." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StreamAnalytics/locations/{location}/compileQuery": { + "post": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_CompileQuery", + "description": "Compile the Stream Analytics query.", + "x-ms-examples": { + "Compile the Stream Analytics query": { + "$ref": "./examples/Subscription_CompileQuery.json" + } + }, + "parameters": [ + { + "name": "compileQuery", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CompileQuery" + }, + "description": "The query compilation object which defines the input, output, and transformation for the query compilation." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/LocationParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Stream Analytics query was compiled successfully.", + "schema": { + "$ref": "#/definitions/QueryCompilationResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StreamAnalytics/locations/{location}/sampleInput": { + "post": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_SampleInput", + "description": "Sample the Stream Analytics input data.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Sample the Stream Analytics input data": { + "$ref": "./examples/Subscription_SampleInput.json" + } + }, + "parameters": [ + { + "name": "sampleInput", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SampleInput" + }, + "description": "Defines the necessary parameters for sampling the Stream Analytics input data." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/LocationParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "The request to sample the Stream Analytics input was successfully initiated.", + "schema": { + "$ref": "#/definitions/SampleInputResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StreamAnalytics/locations/{location}/testInput": { + "post": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_TestInput", + "description": "Test the Stream Analytics input.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Test the Stream Analytics input": { + "$ref": "./examples/Subscription_TestInput.json" + } + }, + "parameters": [ + { + "name": "testInput", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TestInput" + }, + "description": "Defines the necessary parameters for testing the Stream Analytics input." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/LocationParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "The request to test the Stream Analytics input was successfully initiated.", + "schema": { + "$ref": "#/definitions/TestDatasourceResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StreamAnalytics/locations/{location}/testOutput": { + "post": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_TestOutput", + "description": "Test the Stream Analytics output.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Test the Stream Analytics output": { + "$ref": "./examples/Subscription_TestOutput.json" + } + }, + "parameters": [ + { + "name": "testOutput", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TestOutput" + }, + "description": "Defines the necessary parameters for testing the Stream Analytics output." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/LocationParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "The request to test the Stream Analytics output was successfully initiated.", + "schema": { + "$ref": "#/definitions/TestDatasourceResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } } @@ -74,6 +335,7 @@ "definitions": { "SubscriptionQuotasListResult": { "description": "Result of the GetQuotas operation. It contains a list of quotas for the subscription in a particular region.", + "type": "object", "properties": { "value": { "description": "List of quotas for the subscription in a particular region.", @@ -115,8 +377,447 @@ } } }, + "TestQuery": { + "description": "The request object for query testing.", + "type": "object", + "properties": { + "diagnostics": { + "description": "Diagnostics information related to query testing.", + "type": "object", + "properties": { + "writeUri": { + "description": "The SAS URI to the container or directory.", + "type": "string" + }, + "path": { + "description": "The path to the subdirectory.", + "type": "string" + } + }, + "required": [ + "writeUri" + ] + }, + "streamingJob": { + "description": "Stream analytics job object which defines the input, output, and transformation for the query testing.", + "$ref": "./streamingjobs.json#/definitions/StreamingJob" + } + }, + "required": [ + "streamingJob" + ] + }, + "QueryTestingResult": { + "description": "The result of the query testing request.", + "type": "object", + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + ], + "properties": { + "status": { + "description": "The status of the query testing request.", + "$ref": "#/definitions/QueryTestingResultStatus" + }, + "outputUri": { + "description": "The SAS URL to the outputs payload.", + "type": "string", + "readOnly": true + } + } + }, + "QueryTestingResultStatus": { + "description": "The status of the query testing request.", + "readOnly": true, + "type": "string", + "enum": [ + "Started", + "Success", + "CompilerError", + "RuntimeError", + "Timeout", + "UnknownError" + ], + "x-ms-enum": { + "name": "QueryTestingResultStatus", + "modelAsString": true, + "values": [ + { + "value": "Started", + "description": "The query testing operation was initiated." + }, + { + "value": "Success", + "description": "The query testing operation succeeded." + }, + { + "value": "CompilerError", + "description": "The query testing operation failed due to a compiler error." + }, + { + "value": "RuntimeError", + "description": "The query testing operation failed due to a runtime error." + }, + { + "value": "Timeout", + "description": "The query testing operation failed due to a timeout." + }, + { + "value": "UnknownError", + "description": "The query testing operation failed due to an unknown error ." + } + ] + } + }, + "CompileQuery": { + "description": "The query compilation object which defines the input, output, and transformation for the query compilation.", + "type": "object", + "properties": { + "query": { + "description": "The query to compile.", + "type": "string" + }, + "inputs": { + "description": "The inputs for the query compilation.", + "type": "array", + "items": { + "description": "An input for the query compilation.", + "$ref": "#/definitions/QueryInput" + } + }, + "functions": { + "description": "The functions for the query compilation.", + "type": "array", + "items": { + "description": "A function for the query compilation.", + "$ref": "#/definitions/QueryFunction" + } + }, + "jobType": { + "type": "string", + "description": "Describes the type of the job. Valid values are `Cloud` and 'Edge'.", + "enum": [ + "Cloud", + "Edge" + ], + "x-ms-enum": { + "name": "JobType", + "modelAsString": true + } + }, + "compatibilityLevel": { + "description": "The query to compile.", + "$ref": "./streamingjobs.json#/definitions/CompatibilityLevel" + } + }, + "required": [ + "query", + "jobType" + ] + }, + "QueryInput": { + "description": "An input for the query compilation.", + "type": "object", + "properties": { + "name": { + "description": "The name of the input.", + "type": "string" + }, + "type": { + "description": "The type of the input, can be Stream or Reference.", + "type": "string" + } + }, + "required": [ + "name", + "type" + ] + }, + "QueryFunction": { + "description": "A function for the query compilation.", + "type": "object", + "properties": { + "name": { + "description": "The name of the function.", + "type": "string" + }, + "type": { + "description": "The type of the function.", + "type": "string" + }, + "bindingType": { + "description": "The type of the function binding.", + "type": "string" + }, + "inputs": { + "description": "The inputs for the function.", + "type": "array", + "items": { + "description": "An input for the function.", + "$ref": "./functions.json#/definitions/FunctionInput" + } + }, + "output": { + "description": "An output for the function.", + "$ref": "./functions.json#/definitions/FunctionOutput" + } + }, + "required": [ + "name", + "type", + "bindingType", + "inputs", + "output" + ] + }, + "QueryCompilationResult": { + "description": "The result of the query compilation request.", + "type": "object", + "properties": { + "errors": { + "description": "Error messages produced by the compiler.", + "type": "array", + "readOnly": true, + "items": { + "description": "An error produced by the compiler.", + "$ref": "#/definitions/QueryCompilationError" + } + }, + "warnings": { + "description": "Warning messages produced by the compiler.", + "type": "array", + "readOnly": true, + "items": { + "description": "A warning produced by the compiler.", + "type": "string", + "readOnly": true + } + }, + "inputs": { + "description": "All input names used by the query.", + "type": "array", + "readOnly": true, + "items": { + "description": "An input used by the query.", + "type": "string", + "readOnly": true + } + }, + "outputs": { + "description": "All output names used by the query.", + "type": "array", + "readOnly": true, + "items": { + "description": "An output used by the query.", + "type": "string", + "readOnly": true + } + }, + "functions": { + "description": "All function names used by the query.", + "type": "array", + "readOnly": true, + "items": { + "description": "A function used by the query.", + "type": "string", + "readOnly": true + } + } + } + }, + "QueryCompilationError": { + "description": "An error produced by the compiler.", + "type": "object", + "properties": { + "message": { + "description": "The content of the error message.", + "type": "string", + "readOnly": true + }, + "startLine": { + "description": "Describes the error location in the original query. Not set if isGlobal is true.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "startColumn": { + "description": "Describes the error location in the original query. Not set if isGlobal is true.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "endLine": { + "description": "Describes the error location in the original query. Not set if isGlobal is true.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "endColumn": { + "description": "Describes the error location in the original query. Not set if isGlobal is true.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "isGlobal": { + "description": "Whether the error is not for a specific part but for the entire query.", + "type": "boolean", + "readOnly": true + } + } + }, + "SampleInput": { + "description": "The stream analytics input to sample.", + "type": "object", + "properties": { + "input": { + "description": "The stream analytics input to sample.", + "$ref": "./inputs.json#/definitions/Input" + }, + "compatibilityLevel": { + "description": "Defaults to the default ASA job compatibility level. Today it is 1.2", + "type": "string" + }, + "eventsUri": { + "description": "The SAS URI of the storage blob for service to write the sampled events to. If this parameter is not provided, service will write events to he system account and share a temporary SAS URI to it.", + "type": "string" + }, + "dataLocale": { + "description": "Defaults to en-US.", + "type": "string" + } + } + }, + "SampleInputResult": { + "description": "The result of the sample input request.", + "type": "object", + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + ], + "properties": { + "status": { + "description": "The status of the sample input request.", + "$ref": "#/definitions/SampleInputResultStatus" + }, + "diagnostics": { + "description": "Diagnostics messages. E.g. message indicating some partitions from the input have no data.", + "type": "array", + "readOnly": true, + "items": { + "description": "A diagnostics message.", + "type": "string", + "readOnly": true + } + }, + "eventsDownloadUrl": { + "description": "A SAS URL to download the sampled input data.", + "type": "string", + "readOnly": true + }, + "lastArrivalTime": { + "description": "The timestamp for the last event in the data. It is in DateTime format.", + "type": "string", + "readOnly": true + } + } + }, + "SampleInputResultStatus": { + "description": "The status of the sample input request.", + "readOnly": true, + "type": "string", + "enum": [ + "ReadAllEventsInRange", + "NoEventsFoundInRange", + "ErrorConnectingToInput" + ], + "x-ms-enum": { + "name": "SampleInputResultStatus", + "modelAsString": true, + "values": [ + { + "value": "ReadAllEventsInRange", + "description": "The sample input operation successfully read all the events in the range." + }, + { + "value": "NoEventsFoundInRange", + "description": "The sample input operation found no events in the range." + }, + { + "value": "ErrorConnectingToInput", + "description": "The sample input operation failed to connect to the input." + } + ] + } + }, + "TestInput": { + "description": "A stream analytics input.", + "type": "object", + "properties": { + "input": { + "description": "The stream analytics input to test.", + "$ref": "./inputs.json#/definitions/Input" + } + }, + "required": [ + "input" + ] + }, + "TestOutput": { + "description": "A stream analytics output.", + "type": "object", + "properties": { + "output": { + "description": "The stream analytics output to test.", + "$ref": "./outputs.json#/definitions/Output" + } + }, + "required": [ + "output" + ] + }, + "TestDatasourceResult": { + "description": "The result of the test input or output request.", + "type": "object", + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + ], + "properties": { + "status": { + "description": "The status of the sample output request.", + "$ref": "#/definitions/TestDatasourceResultStatus" + } + } + }, + "TestDatasourceResultStatus": { + "description": "The status of the test input or output request.", + "readOnly": true, + "type": "string", + "enum": [ + "TestSucceeded", + "TestFailed" + ], + "x-ms-enum": { + "name": "TestDatasourceResultStatus", + "modelAsString": true, + "values": [ + { + "value": "TestSucceeded", + "description": "The test datasource operation succeeded." + }, + { + "value": "TestFailed", + "description": "The test datasource operation failed." + } + ] + } + }, "SubResource": { "description": "The base sub-resource model definition.", + "type": "object", "properties": { "id": { "readOnly": true, diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/transformations.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/transformations.json index 9543efbc90a1..614825dc874a 100644 --- a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/transformations.json +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/transformations.json @@ -111,6 +111,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -171,6 +177,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -214,6 +226,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } } @@ -222,6 +240,7 @@ "definitions": { "Transformation": { "description": "A transformation object, containing all information associated with the named transformation. All transformations are contained under a streaming job.", + "type": "object", "allOf": [ { "$ref": "#/definitions/SubResource" @@ -237,6 +256,7 @@ }, "TransformationProperties": { "description": "The properties that are associated with a transformation.", + "type": "object", "properties": { "streamingUnits": { "type": "integer", @@ -256,6 +276,7 @@ }, "SubResource": { "description": "The base sub-resource model definition.", + "type": "object", "properties": { "id": { "readOnly": true, diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/functions.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/functions.json index e5aa2b14299a..04616ef11d7e 100644 --- a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/functions.json +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/functions.json @@ -114,6 +114,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -177,6 +183,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -214,6 +226,12 @@ }, "204": { "description": "The function does not exist." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -260,6 +278,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } } @@ -303,6 +327,12 @@ "schema": { "$ref": "#/definitions/FunctionListResult" } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-pageable": { @@ -360,12 +390,18 @@ }, "202": { "description": "The test request was successfully initiated." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/functions/{functionName}/RetrieveDefaultDefinition": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/functions/{functionName}/retrieveDefaultDefinition": { "post": { "tags": [ "Functions" @@ -409,6 +445,12 @@ "schema": { "$ref": "#/definitions/Function" } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } } @@ -442,7 +484,10 @@ "type": "string", "description": "The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency." } - } + }, + "required": [ + "type" + ] }, "ScalarFunctionProperties": { "description": "The properties that are associated with a scalar function.", @@ -510,7 +555,10 @@ "type": "string", "description": "Indicates the function binding type." } - } + }, + "required": [ + "type" + ] }, "AzureMachineLearningWebServiceFunctionBinding": { "description": "The binding to an Azure Machine Learning web service.", @@ -637,7 +685,10 @@ "type": "string", "description": "Indicates the function binding type." } - } + }, + "required": [ + "bindingType" + ] }, "AzureMachineLearningWebServiceFunctionRetrieveDefaultDefinitionParameters": { "description": "The parameters needed to retrieve the default function definition for an Azure Machine Learning web service function.", diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/inputs.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/inputs.json index 9f2f288b961b..37e57bafa6b5 100644 --- a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/inputs.json +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/inputs.json @@ -120,6 +120,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -189,6 +195,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -226,6 +238,12 @@ }, "204": { "description": "The input does not exist." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -278,6 +296,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } } @@ -324,6 +348,12 @@ "schema": { "$ref": "#/definitions/InputListResult" } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-pageable": { @@ -378,6 +408,12 @@ }, "202": { "description": "The test request was successfully initiated." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-long-running-operation": true @@ -421,7 +457,10 @@ "type": "string", "description": "The current entity tag for the input. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency." } - } + }, + "required": [ + "type" + ] }, "StreamInputProperties": { "description": "The properties that are associated with an input containing stream data.", @@ -461,7 +500,10 @@ "type": "string", "description": "Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests." } - } + }, + "required": [ + "type" + ] }, "BlobStreamInputDataSource": { "description": "Describes a blob input data source that contains stream data.", @@ -573,7 +615,10 @@ "type": "string", "description": "Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests." } - } + }, + "required": [ + "type" + ] }, "BlobReferenceInputDataSource": { "description": "Describes a blob input data source that contains reference data.", @@ -728,9 +773,25 @@ "discriminator": "type", "properties": { "type": { - "type": "string", - "description": "Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests." + "description": "Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests.", + "$ref": "#/definitions/EventSerializationType" } + }, + "required": [ + "type" + ] + }, + "EventSerializationType": { + "type": "string", + "description": "Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests.", + "enum": [ + "Csv", + "Avro", + "Json" + ], + "x-ms-enum": { + "name": "EventSerializationType", + "modelAsString": true } }, "CsvSerialization": { diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/outputs.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/outputs.json index 89c617f33ffe..7a662002c11e 100644 --- a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/outputs.json +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/outputs.json @@ -135,6 +135,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -219,6 +225,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -256,6 +268,12 @@ }, "204": { "description": "The output does not exist." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -323,6 +341,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } } @@ -366,6 +390,12 @@ "schema": { "$ref": "#/definitions/OutputListResult" } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-pageable": { @@ -420,6 +450,12 @@ }, "202": { "description": "The test request was successfully initiated." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-long-running-operation": true @@ -473,7 +509,10 @@ "type": "string", "description": "Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests." } - } + }, + "required": [ + "type" + ] }, "BlobOutputDataSource": { "description": "Describes a blob output data source.", diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/streamingjobs.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/streamingjobs.json index fa38cd05f5ae..534512d5c204 100644 --- a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/streamingjobs.json +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/streamingjobs.json @@ -56,6 +56,12 @@ "schema": { "$ref": "#/definitions/OperationListResult" } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-pageable": { @@ -141,6 +147,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-long-running-operation": true @@ -199,6 +211,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -236,6 +254,12 @@ }, "204": { "description": "The streaming job does not exist." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-long-running-operation": true @@ -287,6 +311,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } } @@ -330,6 +360,12 @@ "schema": { "$ref": "#/definitions/StreamingJobListResult" } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-pageable": { @@ -373,6 +409,12 @@ "schema": { "$ref": "#/definitions/StreamingJobListResult" } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-pageable": { @@ -427,6 +469,12 @@ }, "202": { "description": "The start streaming job request was successfully initiated." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-long-running-operation": true @@ -464,6 +512,12 @@ }, "202": { "description": "The stop streaming job request was successfully initiated." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } }, "x-ms-long-running-operation": true @@ -530,7 +584,7 @@ "description": "A streaming job object, containing all information associated with the named streaming job.", "allOf": [ { - "$ref": "#/definitions/Resource" + "$ref": "#/definitions/TrackedResource" } ], "properties": { @@ -739,36 +793,65 @@ } }, "Resource": { - "description": "The base resource model definition.", + "type": "object", + "description": "The base resource definition", "properties": { "id": { "readOnly": true, "type": "string", - "description": "Resource Id" + "description": "Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" }, "name": { "readOnly": true, "type": "string", - "description": "Resource name" + "description": "The name of the resource" }, "type": { "readOnly": true, "type": "string", - "description": "Resource type" - }, - "location": { - "type": "string", - "description": "Resource location. Required on PUT (CreateOrReplace) requests." - }, + "description": "The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts." + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "type": "object", + "description": "The resource model definition for a ARM tracked top level resource", + "properties": { "tags": { "type": "object", "additionalProperties": { "type": "string" }, - "description": "Resource tags" + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" } }, - "x-ms-azure-resource": true + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ProxyResource": { + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] } }, "parameters": { diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/subscriptions.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/subscriptions.json index 7a733fb1fb1e..6a18dc05436b 100644 --- a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/subscriptions.json +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/subscriptions.json @@ -66,6 +66,12 @@ "schema": { "$ref": "#/definitions/SubscriptionQuotasListResult" } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } } diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/transformations.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/transformations.json index 2f630597f66d..2ff86af37bbd 100644 --- a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/transformations.json +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/transformations.json @@ -111,6 +111,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -171,6 +177,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } }, @@ -214,6 +226,12 @@ "type": "string" } } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } } } } diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_Create_AzureML.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_Create_AzureML.json new file mode 100644 index 000000000000..69ed2e331e3b --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_Create_AzureML.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg7", + "jobName": "sj9093", + "functionName": "function588", + "function": { + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "nvarchar(max)" + } + ], + "output": { + "dataType": "nvarchar(max)" + }, + "binding": { + "type": "Microsoft.MachineLearning/WebService", + "properties": { + "endpoint": "someAzureMLEndpointURL", + "apiKey": "someApiKey==", + "inputs": { + "name": "input1", + "columnNames": [ + { + "name": "tweet", + "dataType": "string", + "mapTo": 0 + } + ] + }, + "outputs": [ + { + "name": "Sentiment", + "dataType": "string" + } + ], + "batchSize": 1000 + } + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "dac52a15-66be-4aa7-8a18-20c5409983df" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg7/providers/Microsoft.StreamAnalytics/streamingjobs/sj9093/functions/function588", + "name": "function588", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "nvarchar(max)" + } + ], + "output": { + "dataType": "nvarchar(max)" + }, + "binding": { + "type": "Microsoft.MachineLearning/WebService", + "properties": { + "endpoint": "someAzureMLEndpointURL", + "inputs": { + "name": "input1", + "columnNames": [ + { + "name": "tweet", + "dataType": "string", + "mapTo": 0 + } + ] + }, + "outputs": [ + { + "name": "Sentiment", + "dataType": "string" + } + ], + "batchSize": 1000 + } + } + } + } + } + }, + "200": { + "headers": { + "ETag": "dac52a15-66be-4aa7-8a18-20c5409983df" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg7/providers/Microsoft.StreamAnalytics/streamingjobs/sj9093/functions/function588", + "name": "function588", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "nvarchar(max)" + } + ], + "output": { + "dataType": "nvarchar(max)" + }, + "binding": { + "type": "Microsoft.MachineLearning/WebService", + "properties": { + "endpoint": "someAzureMLEndpointURL", + "inputs": { + "name": "input1", + "columnNames": [ + { + "name": "tweet", + "dataType": "string", + "mapTo": 0 + } + ] + }, + "outputs": [ + { + "name": "Sentiment", + "dataType": "string" + } + ], + "batchSize": 1000 + } + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_Create_JavaScript.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_Create_JavaScript.json new file mode 100644 index 000000000000..7cd4127718ef --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_Create_JavaScript.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg1637", + "jobName": "sj8653", + "functionName": "function8197", + "function": { + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "Any" + } + ], + "output": { + "dataType": "Any" + }, + "binding": { + "type": "Microsoft.StreamAnalytics/JavascriptUdf", + "properties": { + "script": "function (x, y) { return x + y; }" + } + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "07495b35-da28-4c28-a3ed-e0d75d0b6eff" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg1637/providers/Microsoft.StreamAnalytics/streamingjobs/sj8653/functions/function8197", + "name": "function8197", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "Any" + } + ], + "output": { + "dataType": "Any" + }, + "binding": { + "type": "Microsoft.StreamAnalytics/JavascriptUdf", + "properties": { + "script": "function (x, y) { return x + y; }" + } + } + } + } + } + }, + "200": { + "headers": { + "ETag": "07495b35-da28-4c28-a3ed-e0d75d0b6eff" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg1637/providers/Microsoft.StreamAnalytics/streamingjobs/sj8653/functions/function8197", + "name": "function8197", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "Any" + } + ], + "output": { + "dataType": "Any" + }, + "binding": { + "type": "Microsoft.StreamAnalytics/JavascriptUdf", + "properties": { + "script": "function (x, y) { return x + y; }" + } + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_Delete.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_Delete.json new file mode 100644 index 000000000000..1074d7e85228 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg1637", + "jobName": "sj8653", + "functionName": "function8197" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_Get_AzureML.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_Get_AzureML.json new file mode 100644 index 000000000000..157e3ba1ff56 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_Get_AzureML.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg7", + "jobName": "sj9093", + "functionName": "function588" + }, + "responses": { + "200": { + "headers": { + "ETag": "dac52a15-66be-4aa7-8a18-20c5409983df" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg7/providers/Microsoft.StreamAnalytics/streamingjobs/sj9093/functions/function588", + "name": "function588", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "nvarchar(max)" + } + ], + "output": { + "dataType": "nvarchar(max)" + }, + "binding": { + "type": "Microsoft.MachineLearning/WebService", + "properties": { + "endpoint": "someAzureMLEndpointURL", + "inputs": { + "name": "input1", + "columnNames": [ + { + "name": "tweet", + "dataType": "string", + "mapTo": 0 + } + ] + }, + "outputs": [ + { + "name": "Sentiment", + "dataType": "string" + } + ], + "batchSize": 1000 + } + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_Get_JavaScript.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_Get_JavaScript.json new file mode 100644 index 000000000000..3527ff821ff8 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_Get_JavaScript.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg1637", + "jobName": "sj8653", + "functionName": "function8197" + }, + "responses": { + "200": { + "headers": { + "ETag": "07495b35-da28-4c28-a3ed-e0d75d0b6eff" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg1637/providers/Microsoft.StreamAnalytics/streamingjobs/sj8653/functions/function8197", + "name": "function8197", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "Any" + } + ], + "output": { + "dataType": "Any" + }, + "binding": { + "type": "Microsoft.StreamAnalytics/JavascriptUdf", + "properties": { + "script": "function (x, y) { return x + y; }" + } + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_ListByStreamingJob.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_ListByStreamingJob.json new file mode 100644 index 000000000000..6167da2fdbf6 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_ListByStreamingJob.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg1637", + "jobName": "sj8653" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg1637/providers/Microsoft.StreamAnalytics/streamingjobs/sj8653/functions/function588", + "name": "function588", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "nvarchar(max)" + } + ], + "output": { + "dataType": "nvarchar(max)" + }, + "binding": { + "type": "Microsoft.MachineLearning/WebService", + "properties": { + "endpoint": "someAzureMLEndpointURL", + "inputs": { + "name": "input1", + "columnNames": [ + { + "name": "tweet", + "dataType": "string", + "mapTo": 0 + } + ] + }, + "outputs": [ + { + "name": "Sentiment", + "dataType": "string" + } + ], + "batchSize": 5000 + } + } + }, + "etag": "281cbf11-cd50-4a44-b833-cf170ce74748" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg1637/providers/Microsoft.StreamAnalytics/streamingjobs/sj8653/functions/function8197", + "name": "function8197", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "Any" + } + ], + "output": { + "dataType": "Any" + }, + "binding": { + "type": "Microsoft.StreamAnalytics/JavascriptUdf", + "properties": { + "script": "function (a, b) { return a * b; }" + } + } + }, + "etag": "94a512d5-2f59-4e39-b9c8-bca4abd74b7e" + } + } + ] + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_RetrieveDefaultDefinition_AzureML.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_RetrieveDefaultDefinition_AzureML.json new file mode 100644 index 000000000000..dbba2cfb93fc --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_RetrieveDefaultDefinition_AzureML.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg7", + "jobName": "sj9093", + "functionName": "function588", + "functionRetrieveDefaultDefinitionParameters": { + "bindingType": "Microsoft.MachineLearning/WebService", + "bindingRetrievalProperties": { + "executeEndpoint": "someAzureMLExecuteEndpointUrl", + "udfType": "Scalar" + } + } + }, + "responses": { + "200": { + "body": { + "name": "function588", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "nvarchar(max)" + } + ], + "output": { + "dataType": "nvarchar(max)" + }, + "binding": { + "type": "Microsoft.MachineLearning/WebService", + "properties": { + "endpoint": "someAzureMLExecuteEndpointUrl", + "inputs": { + "name": "input1", + "columnNames": [ + { + "name": "tweet", + "dataType": "string", + "mapTo": 0 + } + ] + }, + "outputs": [ + { + "name": "Sentiment", + "dataType": "string" + } + ], + "batchSize": 1000 + } + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_Test_AzureML.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_Test_AzureML.json new file mode 100644 index 000000000000..320af08e57fa --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_Test_AzureML.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg7", + "jobName": "sj9093", + "functionName": "function588" + }, + "responses": { + "200": { + "body": { + "status": "TestSucceeded" + } + }, + "202": {} + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_Test_JavaScript.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_Test_JavaScript.json new file mode 100644 index 000000000000..81012ea0a0c3 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_Test_JavaScript.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg1637", + "jobName": "sj8653", + "functionName": "function8197" + }, + "responses": { + "200": { + "body": { + "status": "TestFailed", + "error": { + "code": "BadRequest", + "message": "Test operation is not supported for function type: Microsoft.StreamAnalytics/JavascriptUdf" + } + } + }, + "202": {} + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_Update_AzureML.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_Update_AzureML.json new file mode 100644 index 000000000000..8d854a17b55d --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_Update_AzureML.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg7", + "jobName": "sj9093", + "functionName": "function588", + "function": { + "properties": { + "type": "Scalar", + "properties": { + "binding": { + "type": "Microsoft.MachineLearning/WebService", + "properties": { + "batchSize": 5000 + } + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "281cbf11-cd50-4a44-b833-cf170ce74748" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg7/providers/Microsoft.StreamAnalytics/streamingjobs/sj9093/functions/function588", + "name": "function588", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "nvarchar(max)" + } + ], + "output": { + "dataType": "nvarchar(max)" + }, + "binding": { + "type": "Microsoft.MachineLearning/WebService", + "properties": { + "endpoint": "someAzureMLEndpointURL", + "inputs": { + "name": "input1", + "columnNames": [ + { + "name": "tweet", + "dataType": "string", + "mapTo": 0 + } + ] + }, + "outputs": [ + { + "name": "Sentiment", + "dataType": "string" + } + ], + "batchSize": 5000 + } + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_Update_JavaScript.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_Update_JavaScript.json new file mode 100644 index 000000000000..447600ee5d2f --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Function_Update_JavaScript.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg1637", + "jobName": "sj8653", + "functionName": "function8197", + "function": { + "properties": { + "type": "Scalar", + "properties": { + "binding": { + "type": "Microsoft.StreamAnalytics/JavascriptUdf", + "properties": { + "script": "function (a, b) { return a * b; }" + } + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "94a512d5-2f59-4e39-b9c8-bca4abd74b7e" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg1637/providers/Microsoft.StreamAnalytics/streamingjobs/sj8653/functions/function8197", + "name": "function8197", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "Any" + } + ], + "output": { + "dataType": "Any" + }, + "binding": { + "type": "Microsoft.StreamAnalytics/JavascriptUdf", + "properties": { + "script": "function (a, b) { return a * b; }" + } + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Create_Reference_Blob_CSV.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Create_Reference_Blob_CSV.json new file mode 100644 index 000000000000..246d26615fd8 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Create_Reference_Blob_CSV.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg8440", + "jobName": "sj9597", + "inputName": "input7225", + "input": { + "properties": { + "type": "Reference", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName", + "accountKey": "someAccountKey==" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "c987701d-4039-47aa-a115-ad84f67d07c5" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg8440/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input7225", + "name": "input7225", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Reference", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + }, + "200": { + "headers": { + "ETag": "c987701d-4039-47aa-a115-ad84f67d07c5" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg8440/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input7225", + "name": "input7225", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Reference", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Create_Stream_Blob_CSV.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Create_Stream_Blob_CSV.json new file mode 100644 index 000000000000..5363e8b20c03 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Create_Stream_Blob_CSV.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg8161", + "jobName": "sj6695", + "inputName": "input8899", + "input": { + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName", + "accountKey": "someAccountKey==" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH", + "sourcePartitionCount": 16 + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "475074b8-c957-4b1f-a219-12b8399c3d4c" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg8161/providers/Microsoft.StreamAnalytics/streamingjobs/sj6695/inputs/input8899", + "name": "input8899", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "sourcePartitionCount": 16, + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + }, + "200": { + "headers": { + "ETag": "475074b8-c957-4b1f-a219-12b8399c3d4c" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg8161/providers/Microsoft.StreamAnalytics/streamingjobs/sj6695/inputs/input8899", + "name": "input8899", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "sourcePartitionCount": 16, + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Create_Stream_EventHub_JSON.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Create_Stream_EventHub_JSON.json new file mode 100644 index 000000000000..e5e0e01b3157 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Create_Stream_EventHub_JSON.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg3139", + "jobName": "sj197", + "inputName": "input7425", + "input": { + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey", + "sharedAccessPolicyKey": "someSharedAccessPolicyKey==", + "eventHubName": "sdkeventhub", + "consumerGroupName": "sdkconsumergroup" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "afd0d184-37e9-4370-9e55-32501bc4de3a" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3139/providers/Microsoft.StreamAnalytics/streamingjobs/sj197/inputs/input7425", + "name": "input7425", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "eventHubName": "sdkeventhub", + "consumerGroupName": "sdkconsumergroup", + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + } + } + } + }, + "200": { + "headers": { + "ETag": "afd0d184-37e9-4370-9e55-32501bc4de3a" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3139/providers/Microsoft.StreamAnalytics/streamingjobs/sj197/inputs/input7425", + "name": "input7425", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "eventHubName": "sdkeventhub", + "consumerGroupName": "sdkconsumergroup", + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Create_Stream_IoTHub_Avro.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Create_Stream_IoTHub_Avro.json new file mode 100644 index 000000000000..b25c3fa07941 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Create_Stream_IoTHub_Avro.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg3467", + "jobName": "sj9742", + "inputName": "input7970", + "input": { + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Devices/IotHubs", + "properties": { + "iotHubNamespace": "iothub", + "sharedAccessPolicyName": "owner", + "sharedAccessPolicyKey": "sharedAccessPolicyKey=", + "consumerGroupName": "sdkconsumergroup", + "endpoint": "messages/events" + } + }, + "serialization": { + "type": "Avro" + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "bd8009b3-8165-4bd3-aad2-29a2b378dd14" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3467/providers/Microsoft.StreamAnalytics/streamingjobs/sj9742/inputs/input7970", + "name": "input7970", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Devices/IotHubs", + "properties": { + "iotHubNamespace": "iothub", + "sharedAccessPolicyName": "owner", + "endpoint": "messages/events", + "consumerGroupName": "sdkconsumergroup" + } + }, + "serialization": { + "type": "Avro", + "properties": {} + } + } + } + }, + "200": { + "headers": { + "ETag": "bd8009b3-8165-4bd3-aad2-29a2b378dd14" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3467/providers/Microsoft.StreamAnalytics/streamingjobs/sj9742/inputs/input7970", + "name": "input7970", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Devices/IotHubs", + "properties": { + "iotHubNamespace": "iothub", + "sharedAccessPolicyName": "owner", + "endpoint": "messages/events", + "consumerGroupName": "sdkconsumergroup" + } + }, + "serialization": { + "type": "Avro", + "properties": {} + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Delete.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Delete.json new file mode 100644 index 000000000000..1b77c3612e93 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg8440", + "jobName": "sj9597", + "inputName": "input7225" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Get_Reference_Blob_CSV.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Get_Reference_Blob_CSV.json new file mode 100644 index 000000000000..3e4c0ea9def1 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Get_Reference_Blob_CSV.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg8440", + "jobName": "sj9597", + "inputName": "input7225" + }, + "responses": { + "200": { + "headers": { + "ETag": "c987701d-4039-47aa-a115-ad84f67d07c5" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg8440/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input7225", + "name": "input7225", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Reference", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Get_Stream_Blob_CSV.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Get_Stream_Blob_CSV.json new file mode 100644 index 000000000000..4423ed4ea48c --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Get_Stream_Blob_CSV.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg8161", + "jobName": "sj6695", + "inputName": "input8899" + }, + "responses": { + "200": { + "headers": { + "ETag": "475074b8-c957-4b1f-a219-12b8399c3d4c" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg8161/providers/Microsoft.StreamAnalytics/streamingjobs/sj6695/inputs/input8899", + "name": "input8899", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "sourcePartitionCount": 16, + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Get_Stream_EventHub_JSON.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Get_Stream_EventHub_JSON.json new file mode 100644 index 000000000000..bca28f2db653 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Get_Stream_EventHub_JSON.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg3139", + "jobName": "sj197", + "inputName": "input7425" + }, + "responses": { + "200": { + "headers": { + "ETag": "afd0d184-37e9-4370-9e55-32501bc4de3a" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3139/providers/Microsoft.StreamAnalytics/streamingjobs/sj197/inputs/input7425", + "name": "input7425", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "eventHubName": "sdkeventhub", + "consumerGroupName": "sdkconsumergroup", + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Get_Stream_IoTHub_Avro.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Get_Stream_IoTHub_Avro.json new file mode 100644 index 000000000000..c430732e55ec --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Get_Stream_IoTHub_Avro.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg3467", + "jobName": "sj9742", + "inputName": "input7970" + }, + "responses": { + "200": { + "headers": { + "ETag": "bd8009b3-8165-4bd3-aad2-29a2b378dd14" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3467/providers/Microsoft.StreamAnalytics/streamingjobs/sj9742/inputs/input7970", + "name": "input7970", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Devices/IotHubs", + "properties": { + "iotHubNamespace": "iothub", + "sharedAccessPolicyName": "owner", + "endpoint": "messages/events", + "consumerGroupName": "sdkconsumergroup" + } + }, + "serialization": { + "type": "Avro", + "properties": {} + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_ListByStreamingJob.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_ListByStreamingJob.json new file mode 100644 index 000000000000..ecaffe1516e1 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_ListByStreamingJob.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg8440", + "jobName": "sj9597" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg8440/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input7225", + "name": "input7225", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Reference", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "differentContainer", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": "|", + "encoding": "UTF8" + } + }, + "etag": "a4ceb697-1c8f-40c8-b951-fb5ee4757437" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg8440/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input8899", + "name": "input8899", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "sourcePartitionCount": 32, + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": "|", + "encoding": "UTF8" + } + }, + "etag": "3b35d57c-02f4-4b41-8e1d-af02a86c2fa1" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg8440/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input7425", + "name": "input7425", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "eventHubName": "sdkeventhub", + "consumerGroupName": "differentConsumerGroupName", + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Avro", + "properties": {} + }, + "etag": "7548f259-81b5-4ea7-b896-25c6717d98ba" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg8440/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input7970", + "name": "input7970", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Devices/IotHubs", + "properties": { + "iotHubNamespace": "iothub", + "sharedAccessPolicyName": "owner", + "endpoint": "messages/operationsMonitoringEvents", + "consumerGroupName": "sdkconsumergroup" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": "|", + "encoding": "UTF8" + } + }, + "etag": "e2d847e0-c95b-48ef-9e14-1afc1f2270cb" + } + } + ] + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_ListByStreamingJob_Diagnostics.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_ListByStreamingJob_Diagnostics.json new file mode 100644 index 000000000000..f123e7255f65 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_ListByStreamingJob_Diagnostics.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg3276", + "jobName": "sj7804", + "$select": "*" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/inputs/inputtest", + "name": "inputtest", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "state", + "pathPattern": "" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + }, + "diagnostics": { + "conditions": [ + { + "since": "2017-05-11T04:38:42.4938687Z", + "code": "INP-3", + "message": "Could not deserialize the input event as Json. Some possible reasons: 1) Malformed events 2) Input source configured with incorrect serialization format" + } + ] + }, + "etag": "ca88f8fa-605b-4c7f-8695-46f5faa60cd0" + } + } + ] + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Test.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Test.json new file mode 100644 index 000000000000..68f33e88613e --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Test.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg8440", + "jobName": "sj9597", + "inputName": "input7225" + }, + "responses": { + "200": { + "body": { + "status": "TestSucceeded" + } + }, + "202": {} + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Update_Reference_Blob.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Update_Reference_Blob.json new file mode 100644 index 000000000000..7210a8588c06 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Update_Reference_Blob.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg8440", + "jobName": "sj9597", + "inputName": "input7225", + "input": { + "properties": { + "type": "Reference", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "container": "differentContainer" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": "|", + "encoding": "UTF8" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "a4ceb697-1c8f-40c8-b951-fb5ee4757437" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg8440/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input7225", + "name": "input7225", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Reference", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "differentContainer", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": "|", + "encoding": "UTF8" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Update_Stream_Blob.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Update_Stream_Blob.json new file mode 100644 index 000000000000..3c1ef0fac9f6 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Update_Stream_Blob.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg8161", + "jobName": "sj6695", + "inputName": "input8899", + "input": { + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "sourcePartitionCount": 32 + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": "|", + "encoding": "UTF8" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "3b35d57c-02f4-4b41-8e1d-af02a86c2fa1" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg8161/providers/Microsoft.StreamAnalytics/streamingjobs/sj6695/inputs/input8899", + "name": "input8899", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "sourcePartitionCount": 32, + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": "|", + "encoding": "UTF8" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Update_Stream_EventHub.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Update_Stream_EventHub.json new file mode 100644 index 000000000000..a26bc6ebb359 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Update_Stream_EventHub.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg3139", + "jobName": "sj197", + "inputName": "input7425", + "input": { + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "consumerGroupName": "differentConsumerGroupName" + } + }, + "serialization": { + "type": "Avro" + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "7548f259-81b5-4ea7-b896-25c6717d98ba" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3139/providers/Microsoft.StreamAnalytics/streamingjobs/sj197/inputs/input7425", + "name": "input7425", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "eventHubName": "sdkeventhub", + "consumerGroupName": "differentConsumerGroupName", + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Avro", + "properties": {} + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Update_Stream_IoTHub.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Update_Stream_IoTHub.json new file mode 100644 index 000000000000..6fb30abb2a25 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Input_Update_Stream_IoTHub.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg3467", + "jobName": "sj9742", + "inputName": "input7970", + "input": { + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Devices/IotHubs", + "properties": { + "endpoint": "messages/operationsMonitoringEvents" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": "|", + "encoding": "UTF8" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "e2d847e0-c95b-48ef-9e14-1afc1f2270cb" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3467/providers/Microsoft.StreamAnalytics/streamingjobs/sj9742/inputs/input7970", + "name": "input7970", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Devices/IotHubs", + "properties": { + "iotHubNamespace": "iothub", + "sharedAccessPolicyName": "owner", + "endpoint": "messages/operationsMonitoringEvents", + "consumerGroupName": "sdkconsumergroup" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": "|", + "encoding": "UTF8" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Operation_List.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Operation_List.json new file mode 100644 index 000000000000..442cff126fb4 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Operation_List.json @@ -0,0 +1,319 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.StreamAnalytics/locations/quotas/Read", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Subscription Quota", + "operation": "Read Stream Analytics Subscription Quota", + "description": "Read Stream Analytics Subscription Quota" + } + }, + { + "name": "Microsoft.StreamAnalytics/operations/Read", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Operations", + "operation": "Read Stream Analytics Operations", + "description": "Read Stream Analytics Operations" + } + }, + { + "name": "Microsoft.StreamAnalytics/Register/action", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Resource Provider", + "operation": "Register subscription with Stream Analytics Resource Provider", + "description": "Register subscription with Stream Analytics Resource Provider" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/Delete", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job", + "operation": "Delete Stream Analytics Job", + "description": "Delete Stream Analytics Job" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/functions/Delete", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Function", + "operation": "Delete Stream Analytics Job Function", + "description": "Delete Stream Analytics Job Function" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/functions/operationresults/Read", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Function", + "operation": "Read operation results for Stream Analytics Job Function", + "description": "Read operation results for Stream Analytics Job Function" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/functions/Read", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Function", + "operation": "Read Stream Analytics Job Function", + "description": "Read Stream Analytics Job Function" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/functions/RetrieveDefaultDefinition/action", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Function", + "operation": "Retrieve Default Definition of a Stream Analytics Job Function", + "description": "Retrieve Default Definition of a Stream Analytics Job Function" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/functions/Test/action", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Function", + "operation": "Test Stream Analytics Job Function", + "description": "Test Stream Analytics Job Function" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/functions/Write", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Function", + "operation": "Write Stream Analytics Job Function", + "description": "Write Stream Analytics Job Function" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/inputs/Delete", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Input", + "operation": "Delete Stream Analytics Job Input", + "description": "Delete Stream Analytics Job Input" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/inputs/operationresults/Read", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Input", + "operation": "Read operation results for Stream Analytics Job Input", + "description": "Read operation results for Stream Analytics Job Input" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/inputs/Read", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Input", + "operation": "Read Stream Analytics Job Input", + "description": "Read Stream Analytics Job Input" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/inputs/Sample/action", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Input", + "operation": "Sample Stream Analytics Job Input", + "description": "Sample Stream Analytics Job Input" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/inputs/Test/action", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Input", + "operation": "Test Stream Analytics Job Input", + "description": "Test Stream Analytics Job Input" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/inputs/Write", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Input", + "operation": "Write Stream Analytics Job Input", + "description": "Write Stream Analytics Job Input" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/metricdefinitions/Read", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Metric Definitions", + "operation": "Read Metric Definitions", + "description": "Read Metric Definitions" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/operationresults/Read", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job", + "operation": "Read operation results for Stream Analytics Job", + "description": "Read operation results for Stream Analytics Job" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/outputs/Delete", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Output", + "operation": "Delete Stream Analytics Job Output", + "description": "Delete Stream Analytics Job Output" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/outputs/operationresults/Read", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Output", + "operation": "Read operation results for Stream Analytics Job Output", + "description": "Read operation results for Stream Analytics Job Output" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/outputs/Read", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Output", + "operation": "Read Stream Analytics Job Output", + "description": "Read Stream Analytics Job Output" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/outputs/Test/action", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Output", + "operation": "Test Stream Analytics Job Output", + "description": "Test Stream Analytics Job Output" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/outputs/Write", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Output", + "operation": "Write Stream Analytics Job Output", + "description": "Write Stream Analytics Job Output" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "streamingjobs", + "operation": "Read diagnostic setting.", + "description": "Read diagnostic setting." + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "streamingjobs", + "operation": "Write diagnostic setting.", + "description": "Write diagnostic setting." + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/PublishEdgePackage/action", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job", + "operation": "Publish edge package for Stream Analytics Job", + "description": "Publish edge package for Stream Analytics Job" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/Read", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job", + "operation": "Read Stream Analytics Job", + "description": "Read Stream Analytics Job" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/Scale/action", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job", + "operation": "Scale Stream Analytics Job", + "description": "Scale Stream Analytics Job" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/Start/action", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job", + "operation": "Start Stream Analytics Job", + "description": "Start Stream Analytics Job" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/Stop/action", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job", + "operation": "Stop Stream Analytics Job", + "description": "Stop Stream Analytics Job" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/transformations/Delete", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Transformation", + "operation": "Delete Stream Analytics Job Transformation", + "description": "Delete Stream Analytics Job Transformation" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/transformations/Read", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Transformation", + "operation": "Read Stream Analytics Job Transformation", + "description": "Read Stream Analytics Job Transformation" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/transformations/Write", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Transformation", + "operation": "Write Stream Analytics Job Transformation", + "description": "Write Stream Analytics Job Transformation" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/Write", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job", + "operation": "Write Stream Analytics Job", + "description": "Write Stream Analytics Job" + } + } + ] + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Create_AzureDataLakeStore_JSON.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Create_AzureDataLakeStore_JSON.json new file mode 100644 index 000000000000..bfa5993ebd5c --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Create_AzureDataLakeStore_JSON.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg6912", + "jobName": "sj3310", + "outputName": "output5195", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.DataLake/Accounts", + "properties": { + "accountName": "someaccount", + "tenantId": "cea4e98b-c798-49e7-8c40-4a2b3beb47dd", + "refreshToken": "someRefreshToken==", + "tokenUserPrincipalName": "bobsmith@contoso.com", + "tokenUserDisplayName": "Bob Smith", + "filePathPrefix": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "Array" + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "5472168f-7317-4241-8b75-0c8d9d0ea804" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6912/providers/Microsoft.StreamAnalytics/streamingjobs/sj3310/outputs/output5195", + "name": "output5195", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.DataLake/Accounts", + "properties": { + "accountName": "someaccount", + "tenantId": "cea4e98b-c798-49e7-8c40-4a2b3beb47dd", + "tokenUserPrincipalName": "bobsmith@contoso.com", + "tokenUserDisplayName": "Bob Smith", + "filePathPrefix": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "Array" + } + } + } + } + }, + "200": { + "headers": { + "ETag": "5472168f-7317-4241-8b75-0c8d9d0ea804" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6912/providers/Microsoft.StreamAnalytics/streamingjobs/sj3310/outputs/output5195", + "name": "output5195", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.DataLake/Accounts", + "properties": { + "accountName": "someaccount", + "tenantId": "cea4e98b-c798-49e7-8c40-4a2b3beb47dd", + "tokenUserPrincipalName": "bobsmith@contoso.com", + "tokenUserDisplayName": "Bob Smith", + "filePathPrefix": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "Array" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Create_AzureSQL.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Create_AzureSQL.json new file mode 100644 index 000000000000..7aeb177e7067 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Create_AzureSQL.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg2157", + "jobName": "sj6458", + "outputName": "output1755", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.Sql/Server/Database", + "properties": { + "server": "someServer", + "database": "someDatabase", + "user": "", + "password": "somePassword", + "table": "someTable" + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "731a47c6-ff67-4439-bde6-a2a3da4c1ecf" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output1755", + "name": "output1755", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Sql/Server/Database", + "properties": { + "server": "someServer", + "database": "someDatabase", + "table": "someTable", + "user": "someUser" + } + } + } + } + }, + "200": { + "headers": { + "ETag": "731a47c6-ff67-4439-bde6-a2a3da4c1ecf" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output1755", + "name": "output1755", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Sql/Server/Database", + "properties": { + "server": "someServer", + "database": "someDatabase", + "table": "someTable", + "user": "someUser" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Create_AzureTable.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Create_AzureTable.json new file mode 100644 index 000000000000..ef5207bfee6a --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Create_AzureTable.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg5176", + "jobName": "sj2790", + "outputName": "output958", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.Storage/Table", + "properties": { + "accountName": "someAccountName", + "accountKey": "accountKey==", + "table": "samples", + "partitionKey": "partitionKey", + "rowKey": "rowKey", + "columnsToRemove": [ + "column1", + "column2" + ], + "batchSize": 25 + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "2409b6d1-c99c-405b-9a14-ea7833637038" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg5176/providers/Microsoft.StreamAnalytics/streamingjobs/sj2790/outputs/output958", + "name": "output958", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/Table", + "properties": { + "accountName": "someAccountName", + "table": "samples", + "partitionKey": "partitionKey", + "rowKey": "rowKey", + "columnsToRemove": [ + "column1", + "column2" + ], + "batchSize": 25 + } + } + } + } + }, + "200": { + "headers": { + "ETag": "2409b6d1-c99c-405b-9a14-ea7833637038" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg5176/providers/Microsoft.StreamAnalytics/streamingjobs/sj2790/outputs/output958", + "name": "output958", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/Table", + "properties": { + "accountName": "someAccountName", + "table": "samples", + "partitionKey": "partitionKey", + "rowKey": "rowKey", + "columnsToRemove": [ + "column1", + "column2" + ], + "batchSize": 25 + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Create_Blob_CSV.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Create_Blob_CSV.json new file mode 100644 index 000000000000..c9a16c7b12b6 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Create_Blob_CSV.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg5023", + "jobName": "sj900", + "outputName": "output1623", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName", + "accountKey": "accountKey==" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "5433fd97-d133-46e3-8588-5fe1f1599ee0" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg5023/providers/Microsoft.StreamAnalytics/streamingjobs/sj900/outputs/output1623", + "name": "output1623", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + }, + "200": { + "headers": { + "ETag": "5433fd97-d133-46e3-8588-5fe1f1599ee0" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg5023/providers/Microsoft.StreamAnalytics/streamingjobs/sj900/outputs/output1623", + "name": "output1623", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Create_DocumentDB.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Create_DocumentDB.json new file mode 100644 index 000000000000..f9aac728127f --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Create_DocumentDB.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg7983", + "jobName": "sj2331", + "outputName": "output3022", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.Storage/DocumentDB", + "properties": { + "accountId": "someAccountId", + "accountKey": "accountKey==", + "database": "db01", + "collectionNamePattern": "collection", + "partitionKey": "key", + "documentId": "documentId" + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "ccf8b864-259e-43c5-a628-ba10858b2c07" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg7983/providers/Microsoft.StreamAnalytics/streamingjobs/sj2331/outputs/output3022", + "name": "output3022", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/DocumentDB", + "properties": { + "accountId": "someAccountId", + "database": "db01", + "collectionNamePattern": "collection", + "partitionKey": "key", + "documentId": "documentId" + } + } + } + } + }, + "200": { + "headers": { + "ETag": "ccf8b864-259e-43c5-a628-ba10858b2c07" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg7983/providers/Microsoft.StreamAnalytics/streamingjobs/sj2331/outputs/output3022", + "name": "output3022", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/DocumentDB", + "properties": { + "accountId": "someAccountId", + "database": "db01", + "collectionNamePattern": "collection", + "partitionKey": "key", + "documentId": "documentId" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Create_EventHub_JSON.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Create_EventHub_JSON.json new file mode 100644 index 000000000000..049f7b280cfa --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Create_EventHub_JSON.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg6912", + "jobName": "sj3310", + "outputName": "output5195", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey", + "sharedAccessPolicyKey": "sharedAccessPolicyKey=", + "eventHubName": "sdkeventhub", + "partitionKey": "partitionKey" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "Array" + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "5472168f-7317-4241-8b75-0c8d9d0ea804" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6912/providers/Microsoft.StreamAnalytics/streamingjobs/sj3310/outputs/output5195", + "name": "output5195", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "eventHubName": "sdkeventhub", + "partitionKey": "partitionKey", + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "Array" + } + } + } + } + }, + "200": { + "headers": { + "ETag": "5472168f-7317-4241-8b75-0c8d9d0ea804" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6912/providers/Microsoft.StreamAnalytics/streamingjobs/sj3310/outputs/output5195", + "name": "output5195", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "eventHubName": "sdkeventhub", + "partitionKey": "partitionKey", + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "Array" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Create_PowerBI.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Create_PowerBI.json new file mode 100644 index 000000000000..8d308b9b6f92 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Create_PowerBI.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg7983", + "jobName": "sj2331", + "outputName": "output3022", + "output": { + "properties": { + "datasource": { + "type": "PowerBI", + "properties": { + "dataset": "someDataset", + "table": "someTable", + "refreshToken": "someRefreshToken==", + "tokenUserPrincipalName": "bobsmith@contoso.com", + "tokenUserDisplayName": "Bob Smith", + "groupId": "ac40305e-3e8d-43ac-8161-c33799f43e95", + "groupName": "MyPowerBIGroup" + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "ccf8b864-259e-43c5-a628-ba10858b2c07" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg7983/providers/Microsoft.StreamAnalytics/streamingjobs/sj2331/outputs/output3022", + "name": "output3022", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "PowerBI", + "properties": { + "dataset": "someDataset", + "table": "someTable", + "tokenUserPrincipalName": "bobsmith@contoso.com", + "tokenUserDisplayName": "Bob Smith", + "groupId": "ac40305e-3e8d-43ac-8161-c33799f43e95", + "groupName": "MyPowerBIGroup" + } + } + } + } + }, + "200": { + "headers": { + "ETag": "ccf8b864-259e-43c5-a628-ba10858b2c07" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg7983/providers/Microsoft.StreamAnalytics/streamingjobs/sj2331/outputs/output3022", + "name": "output3022", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "PowerBI", + "properties": { + "dataset": "someDataset", + "table": "someTable", + "tokenUserPrincipalName": "bobsmith@contoso.com", + "tokenUserDisplayName": "Bob Smith", + "groupId": "ac40305e-3e8d-43ac-8161-c33799f43e95", + "groupName": "MyPowerBIGroup" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Create_ServiceBusQueue_Avro.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Create_ServiceBusQueue_Avro.json new file mode 100644 index 000000000000..c8ae9754f367 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Create_ServiceBusQueue_Avro.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg3410", + "jobName": "sj5095", + "outputName": "output3456", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/Queue", + "properties": { + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey", + "sharedAccessPolicyKey": "sharedAccessPolicyKey=", + "queueName": "sdkqueue", + "propertyColumns": [ + "column1", + "column2" + ], + "systemPropertyColumns": { + "MessageId": "col3", + "PartitionKey": "col4" + } + } + }, + "serialization": { + "type": "Avro" + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "2f68c1ec-2080-43cb-93ec-4bcd3b7f9dbe" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3410/providers/Microsoft.StreamAnalytics/streamingjobs/sj5095/outputs/output3456", + "name": "output3456", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/Queue", + "properties": { + "queueName": "sdkqueue", + "propertyColumns": [ + "column1", + "column2" + ], + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Avro", + "properties": {} + } + } + } + }, + "200": { + "headers": { + "ETag": "2f68c1ec-2080-43cb-93ec-4bcd3b7f9dbe" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3410/providers/Microsoft.StreamAnalytics/streamingjobs/sj5095/outputs/output3456", + "name": "output3456", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/Queue", + "properties": { + "queueName": "sdkqueue", + "propertyColumns": [ + "column1", + "column2" + ], + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Avro", + "properties": {} + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Create_ServiceBusTopic_CSV.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Create_ServiceBusTopic_CSV.json new file mode 100644 index 000000000000..f24f697282ec --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Create_ServiceBusTopic_CSV.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg6450", + "jobName": "sj7094", + "outputName": "output7886", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/Topic", + "properties": { + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey", + "sharedAccessPolicyKey": "sharedAccessPolicyKey=", + "topicName": "sdktopic", + "propertyColumns": [ + "column1", + "column2" + ] + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "39259839-e581-4af4-bf68-302e6820e3a0" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6450/providers/Microsoft.StreamAnalytics/streamingjobs/sj7094/outputs/output7886", + "name": "output7886", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/Topic", + "properties": { + "topicName": "sdktopic", + "propertyColumns": [ + "column1", + "column2" + ], + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + }, + "200": { + "headers": { + "ETag": "39259839-e581-4af4-bf68-302e6820e3a0" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6450/providers/Microsoft.StreamAnalytics/streamingjobs/sj7094/outputs/output7886", + "name": "output7886", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/Topic", + "properties": { + "topicName": "sdktopic", + "propertyColumns": [ + "column1", + "column2" + ], + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Delete.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Delete.json new file mode 100644 index 000000000000..6dd5dcf09699 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg2157", + "jobName": "sj6458", + "outputName": "output1755" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Get_AzureDataLakeStore_JSON.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Get_AzureDataLakeStore_JSON.json new file mode 100644 index 000000000000..98609fa92fc1 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Get_AzureDataLakeStore_JSON.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg6912", + "jobName": "sj3310", + "outputName": "output5195" + }, + "responses": { + "200": { + "headers": { + "ETag": "5472168f-7317-4241-8b75-0c8d9d0ea804" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6912/providers/Microsoft.StreamAnalytics/streamingjobs/sj3310/outputs/output5195", + "name": "output5195", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.DataLake/Accounts", + "properties": { + "accountName": "someaccount", + "tenantId": "cea4e98b-c798-49e7-8c40-4a2b3beb47dd", + "tokenUserPrincipalName": "bobsmith@contoso.com", + "tokenUserDisplayName": "Bob Smith", + "filePathPrefix": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "Array" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Get_AzureSQL.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Get_AzureSQL.json new file mode 100644 index 000000000000..015c30665301 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Get_AzureSQL.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg2157", + "jobName": "sj6458", + "outputName": "output1755" + }, + "responses": { + "200": { + "headers": { + "ETag": "731a47c6-ff67-4439-bde6-a2a3da4c1ecf" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output1755", + "name": "output1755", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Sql/Server/Database", + "properties": { + "server": "someServer", + "database": "someDatabase", + "table": "someTable", + "user": "someUser" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Get_AzureTable.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Get_AzureTable.json new file mode 100644 index 000000000000..418e85bd01e6 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Get_AzureTable.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg5176", + "jobName": "sj2790", + "outputName": "output958" + }, + "responses": { + "200": { + "headers": { + "ETag": "2409b6d1-c99c-405b-9a14-ea7833637038" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg5176/providers/Microsoft.StreamAnalytics/streamingjobs/sj2790/outputs/output958", + "name": "output958", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/Table", + "properties": { + "accountName": "someAccountName", + "table": "samples", + "partitionKey": "partitionKey", + "rowKey": "rowKey", + "columnsToRemove": [ + "column1", + "column2" + ], + "batchSize": 25 + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Get_Blob_CSV.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Get_Blob_CSV.json new file mode 100644 index 000000000000..15b71828f0d9 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Get_Blob_CSV.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg5023", + "jobName": "sj900", + "outputName": "output1623" + }, + "responses": { + "200": { + "headers": { + "ETag": "5433fd97-d133-46e3-8588-5fe1f1599ee0" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg5023/providers/Microsoft.StreamAnalytics/streamingjobs/sj900/outputs/output1623", + "name": "output1623", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Get_DataWarehouse.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Get_DataWarehouse.json new file mode 100644 index 000000000000..e18b30233b6b --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Get_DataWarehouse.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sjName", + "outputName": "output958" + }, + "responses": { + "200": { + "headers": { + "ETag": "2409b6d1-c99c-405b-9a14-ea7833637038" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/kunAll0908npm2/outputs/SynapseformerlySQLDW1", + "name": "SynapseformerlySQLDW1", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Sql/Server/DataWarehouse", + "properties": { + "table": "test2", + "server": "asatestserver", + "database": "zhayaSQLpool", + "user": "tolladmin" + } + }, + "etag": "ce3fb956-0487-4168-af20-1133a59bdc6e" + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Get_DocumentDB.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Get_DocumentDB.json new file mode 100644 index 000000000000..794cd4e6e194 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Get_DocumentDB.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg7983", + "jobName": "sj2331", + "outputName": "output3022" + }, + "responses": { + "200": { + "headers": { + "ETag": "ccf8b864-259e-43c5-a628-ba10858b2c07" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg7983/providers/Microsoft.StreamAnalytics/streamingjobs/sj2331/outputs/output3022", + "name": "output3022", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/DocumentDB", + "properties": { + "accountId": "someAccountId", + "database": "db01", + "collectionNamePattern": "collection", + "partitionKey": "key", + "documentId": "documentId" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Get_EventHub_JSON.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Get_EventHub_JSON.json new file mode 100644 index 000000000000..574aff9f170c --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Get_EventHub_JSON.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg6912", + "jobName": "sj3310", + "outputName": "output5195" + }, + "responses": { + "200": { + "headers": { + "ETag": "5472168f-7317-4241-8b75-0c8d9d0ea804" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6912/providers/Microsoft.StreamAnalytics/streamingjobs/sj3310/outputs/output5195", + "name": "output5195", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "eventHubName": "sdkeventhub", + "partitionKey": "partitionKey", + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "Array" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Get_PowerBI.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Get_PowerBI.json new file mode 100644 index 000000000000..86d089b9da1a --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Get_PowerBI.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg7983", + "jobName": "sj2331", + "outputName": "output3022" + }, + "responses": { + "200": { + "headers": { + "ETag": "ccf8b864-259e-43c5-a628-ba10858b2c07" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg7983/providers/Microsoft.StreamAnalytics/streamingjobs/sj2331/outputs/output3022", + "name": "output3022", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "PowerBI", + "properties": { + "dataset": "someDataset", + "table": "someTable", + "tokenUserPrincipalName": "bobsmith@contoso.com", + "tokenUserDisplayName": "Bob Smith", + "groupId": "ac40305e-3e8d-43ac-8161-c33799f43e95", + "groupName": "MyPowerBIGroup" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Get_ServiceBusQueue_Avro.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Get_ServiceBusQueue_Avro.json new file mode 100644 index 000000000000..ab29340adc98 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Get_ServiceBusQueue_Avro.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg3410", + "jobName": "sj5095", + "outputName": "output3456" + }, + "responses": { + "200": { + "headers": { + "ETag": "2f68c1ec-2080-43cb-93ec-4bcd3b7f9dbe" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3410/providers/Microsoft.StreamAnalytics/streamingjobs/sj5095/outputs/output3456", + "name": "output3456", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/Queue", + "properties": { + "queueName": "sdkqueue", + "propertyColumns": [ + "column1", + "column2" + ], + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Avro", + "properties": {} + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Get_ServiceBusTopic_CSV.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Get_ServiceBusTopic_CSV.json new file mode 100644 index 000000000000..91f5fca3ddcb --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Get_ServiceBusTopic_CSV.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg6450", + "jobName": "sj7094", + "outputName": "output7886" + }, + "responses": { + "200": { + "headers": { + "ETag": "39259839-e581-4af4-bf68-302e6820e3a0" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6450/providers/Microsoft.StreamAnalytics/streamingjobs/sj7094/outputs/output7886", + "name": "output7886", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/Topic", + "properties": { + "topicName": "sdktopic", + "propertyColumns": [ + "column1", + "column2" + ], + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_ListByStreamingJob.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_ListByStreamingJob.json new file mode 100644 index 000000000000..48b9ff01f9d8 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_ListByStreamingJob.json @@ -0,0 +1,226 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg2157", + "jobName": "sj6458" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output1755", + "name": "output1755", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Sql/Server/Database", + "properties": { + "server": "someServer", + "database": "someDatabase", + "table": "differentTable", + "user": "someUser" + } + }, + "etag": "f489d6f3-fcd5-4bcb-b642-81e987ee16d6" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output958", + "name": "output958", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/Table", + "properties": { + "accountName": "someAccountName", + "table": "samples", + "partitionKey": "differentPartitionKey", + "rowKey": "rowKey", + "columnsToRemove": [ + "column1", + "column2" + ], + "batchSize": 25 + } + }, + "etag": "ea1d20bf-6cb3-40bc-bc7b-ec3a7fd5977e" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output1623", + "name": "output1623", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "differentContainer", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": "|", + "encoding": "UTF8" + } + }, + "etag": "3a1b2023-79a9-4b33-93e8-f49fc3e573fe" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output3022", + "name": "output3022", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/DocumentDB", + "properties": { + "accountId": "someAccountId", + "database": "db01", + "collectionNamePattern": "collection", + "partitionKey": "differentPartitionKey", + "documentId": "documentId" + } + }, + "etag": "7849c132-e995-4631-91c3-931606eec432" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output5195", + "name": "output5195", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "eventHubName": "sdkeventhub", + "partitionKey": "differentPartitionKey", + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "LineSeparated" + } + }, + "etag": "5020de6b-5bb3-4b88-8606-f11fb3c46185" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output3456", + "name": "output3456", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/Queue", + "properties": { + "queueName": "differentQueueName", + "propertyColumns": [ + "column1", + "column2" + ], + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "LineSeparated" + } + }, + "etag": "429adaec-a777-4750-8a39-8d0c931d801c" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output7886", + "name": "output7886", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/Topic", + "properties": { + "topicName": "differentTopicName", + "propertyColumns": [ + "column1", + "column2" + ], + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": "|", + "encoding": "UTF8" + } + }, + "etag": "c1c2007f-45b2-419a-ae7d-4d2148998460" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output3021", + "name": "output3021", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "PowerBI", + "properties": { + "dataset": "differentDataset", + "table": "someTable", + "tokenUserPrincipalName": "bobsmith@contoso.com", + "tokenUserDisplayName": "Bob Smith", + "groupId": "ac40305e-3e8d-43ac-8161-c33799f43e95", + "groupName": "MyPowerBIGroup" + } + }, + "etag": "4a492191-9672-4178-be10-043b9dbd4b9f" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output5196", + "name": "output5196", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.DataLake/Accounts", + "properties": { + "accountName": "differentaccount", + "tenantId": "cea4e98b-c798-49e7-8c40-4a2b3beb47dd", + "tokenUserPrincipalName": "bobsmith@contoso.com", + "tokenUserDisplayName": "Bob Smith", + "filePathPrefix": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "LineSeparated" + } + }, + "etag": "39ab7642-8c1e-48ed-85eb-949068d68002" + } + } + ] + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Test.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Test.json new file mode 100644 index 000000000000..9c332793b2d8 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Test.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg2157", + "jobName": "sj6458", + "outputName": "output1755" + }, + "responses": { + "200": { + "body": { + "status": "TestSucceeded" + } + }, + "202": {} + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Update_AzureDataLakeStore.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Update_AzureDataLakeStore.json new file mode 100644 index 000000000000..41dfff5bf958 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Update_AzureDataLakeStore.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg6912", + "jobName": "sj3310", + "outputName": "output5195", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.DataLake/Accounts", + "properties": { + "accountName": "differentaccount" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "LineSeparated" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "5020de6b-5bb3-4b88-8606-f11fb3c46185" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6912/providers/Microsoft.StreamAnalytics/streamingjobs/sj3310/outputs/output5195", + "name": "output5195", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.DataLake/Accounts", + "properties": { + "accountName": "differentaccount", + "tenantId": "cea4e98b-c798-49e7-8c40-4a2b3beb47dd", + "tokenUserPrincipalName": "bobsmith@contoso.com", + "tokenUserDisplayName": "Bob Smith", + "filePathPrefix": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "LineSeparated" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Update_AzureSQL.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Update_AzureSQL.json new file mode 100644 index 000000000000..5206cf1c27f4 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Update_AzureSQL.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg2157", + "jobName": "sj6458", + "outputName": "output1755", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.Sql/Server/Database", + "properties": { + "table": "differentTable" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "f489d6f3-fcd5-4bcb-b642-81e987ee16d6" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output1755", + "name": "output1755", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Sql/Server/Database", + "properties": { + "server": "someServer", + "database": "someDatabase", + "table": "differentTable", + "user": "someUser" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Update_AzureTable.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Update_AzureTable.json new file mode 100644 index 000000000000..d694e566de4d --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Update_AzureTable.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg5176", + "jobName": "sj2790", + "outputName": "output958", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.Storage/Table", + "properties": { + "partitionKey": "differentPartitionKey" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "ea1d20bf-6cb3-40bc-bc7b-ec3a7fd5977e" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg5176/providers/Microsoft.StreamAnalytics/streamingjobs/sj2790/outputs/output958", + "name": "output958", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/Table", + "properties": { + "accountName": "someAccountName", + "table": "samples", + "partitionKey": "differentPartitionKey", + "rowKey": "rowKey", + "columnsToRemove": [ + "column1", + "column2" + ], + "batchSize": 25 + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Update_Blob.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Update_Blob.json new file mode 100644 index 000000000000..e3fc42b0c87c --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Update_Blob.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg5023", + "jobName": "sj900", + "outputName": "output1623", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "container": "differentContainer" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": "|", + "encoding": "UTF8" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "3a1b2023-79a9-4b33-93e8-f49fc3e573fe" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg5023/providers/Microsoft.StreamAnalytics/streamingjobs/sj900/outputs/output1623", + "name": "output1623", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "differentContainer", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": "|", + "encoding": "UTF8" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Update_DocumentDB.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Update_DocumentDB.json new file mode 100644 index 000000000000..98b8de350c4a --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Update_DocumentDB.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg7983", + "jobName": "sj2331", + "outputName": "output3022", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.Storage/DocumentDB", + "properties": { + "partitionKey": "differentPartitionKey" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "7849c132-e995-4631-91c3-931606eec432" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg7983/providers/Microsoft.StreamAnalytics/streamingjobs/sj2331/outputs/output3022", + "name": "output3022", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/DocumentDB", + "properties": { + "accountId": "someAccountId", + "database": "db01", + "collectionNamePattern": "collection", + "partitionKey": "differentPartitionKey", + "documentId": "documentId" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Update_EventHub.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Update_EventHub.json new file mode 100644 index 000000000000..78b423266cd1 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Update_EventHub.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg6912", + "jobName": "sj3310", + "outputName": "output5195", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "partitionKey": "differentPartitionKey" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "LineSeparated" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "5020de6b-5bb3-4b88-8606-f11fb3c46185" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6912/providers/Microsoft.StreamAnalytics/streamingjobs/sj3310/outputs/output5195", + "name": "output5195", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "eventHubName": "sdkeventhub", + "partitionKey": "differentPartitionKey", + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "LineSeparated" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Update_PowerBI.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Update_PowerBI.json new file mode 100644 index 000000000000..05987cc9c4f1 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Update_PowerBI.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg7983", + "jobName": "sj2331", + "outputName": "output3022", + "output": { + "properties": { + "datasource": { + "type": "PowerBI", + "properties": { + "dataset": "differentDataset" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "7849c132-e995-4631-91c3-931606eec432" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg7983/providers/Microsoft.StreamAnalytics/streamingjobs/sj2331/outputs/output3022", + "name": "output3022", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "PowerBI", + "properties": { + "dataset": "differentDataset", + "table": "someTable", + "tokenUserPrincipalName": "bobsmith@contoso.com", + "tokenUserDisplayName": "Bob Smith", + "groupId": "ac40305e-3e8d-43ac-8161-c33799f43e95", + "groupName": "MyPowerBIGroup" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Update_ServiceBusQueue.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Update_ServiceBusQueue.json new file mode 100644 index 000000000000..ea54a3839c3e --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Update_ServiceBusQueue.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg3410", + "jobName": "sj5095", + "outputName": "output3456", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/Queue", + "properties": { + "queueName": "differentQueueName" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "LineSeparated" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "429adaec-a777-4750-8a39-8d0c931d801c" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3410/providers/Microsoft.StreamAnalytics/streamingjobs/sj5095/outputs/output3456", + "name": "output3456", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/Queue", + "properties": { + "queueName": "differentQueueName", + "propertyColumns": [ + "column1", + "column2" + ], + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "LineSeparated" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Update_ServiceBusTopic.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Update_ServiceBusTopic.json new file mode 100644 index 000000000000..86240021a89b --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Output_Update_ServiceBusTopic.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg6450", + "jobName": "sj7094", + "outputName": "output7886", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/Topic", + "properties": { + "topicName": "differentTopicName" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": "|", + "encoding": "UTF8" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "c1c2007f-45b2-419a-ae7d-4d2148998460" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6450/providers/Microsoft.StreamAnalytics/streamingjobs/sj7094/outputs/output7886", + "name": "output7886", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/Topic", + "properties": { + "topicName": "differentTopicName", + "propertyColumns": [ + "column1", + "column2" + ], + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": "|", + "encoding": "UTF8" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Create_CompleteJob.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Create_CompleteJob.json new file mode 100644 index 000000000000..d9d63322ae59 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Create_CompleteJob.json @@ -0,0 +1,261 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg3276", + "jobName": "sj7804", + "streamingJob": { + "properties": { + "sku": { + "name": "Standard" + }, + "eventsOutOfOrderPolicy": "Drop", + "outputErrorPolicy": "Drop", + "eventsOutOfOrderMaxDelayInSeconds": 0, + "eventsLateArrivalMaxDelayInSeconds": 5, + "dataLocale": "en-US", + "compatibilityLevel": "1.0", + "inputs": [ + { + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "yourAccountName", + "accountKey": "yourAccountKey==" + } + ], + "container": "containerName", + "pathPattern": "" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + } + }, + "name": "inputtest" + } + ], + "transformation": { + "properties": { + "streamingUnits": 1, + "query": "Select Id, Name from inputtest" + }, + "name": "transformationtest" + }, + "outputs": [ + { + "properties": { + "datasource": { + "type": "Microsoft.Sql/Server/Database", + "properties": { + "server": "serverName", + "database": "databaseName", + "user": "", + "password": "userPassword", + "table": "tableName" + } + } + }, + "name": "outputtest" + } + ], + "functions": [] + }, + "location": "West US", + "tags": { + "key1": "value1", + "randomKey": "randomValue", + "key3": "value3" + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "87551cc5-1290-4d08-afcd-cdaa92e5ade0" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804", + "name": "sj7804", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "tags": { + "key1": "value1", + "randomKey": "randomValue", + "key3": "value3" + }, + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "732e4b1d-94a7-43ae-8297-3ad04f1540b9", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Drop", + "outputErrorPolicy": "Drop", + "eventsOutOfOrderMaxDelayInSeconds": 0, + "eventsLateArrivalMaxDelayInSeconds": 5, + "dataLocale": "en-US", + "createdDate": "2017-05-11T04:37:11.54Z", + "compatibilityLevel": "1.0", + "inputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/inputs/inputtest", + "name": "inputtest", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "accountName" + } + ], + "container": "containerName", + "pathPattern": "" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + }, + "etag": "ca88f8fa-605b-4c7f-8695-46f5faa60cd0" + } + } + ], + "transformation": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/transformations/transformationtest", + "name": "transformationtest", + "type": "Microsoft.StreamAnalytics/streamingjobs/transformations", + "properties": { + "streamingUnits": 1, + "query": "Select Id, Name from inputtest", + "etag": "91d8fcbe-60b3-49c3-9f21-9942b95602b8" + } + }, + "functions": [], + "outputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/outputs/outputtest", + "name": "outputtest", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Sql/Server/Database", + "properties": { + "server": "serverName", + "database": "databaseName", + "table": "tableName", + "user": "userName" + } + }, + "etag": "62097c3c-b503-41ff-a56f-196a9598ab90" + } + } + ] + } + } + }, + "200": { + "headers": { + "ETag": "87551cc5-1290-4d08-afcd-cdaa92e5ade0" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804", + "name": "sj7804", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "tags": { + "key1": "value1", + "randomKey": "randomValue", + "key3": "value3" + }, + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "732e4b1d-94a7-43ae-8297-3ad04f1540b9", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Drop", + "outputErrorPolicy": "Drop", + "eventsOutOfOrderMaxDelayInSeconds": 0, + "eventsLateArrivalMaxDelayInSeconds": 5, + "dataLocale": "en-US", + "createdDate": "2017-05-11T04:37:11.54Z", + "compatibilityLevel": "1.0", + "inputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/inputs/inputtest", + "name": "inputtest", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "accountName" + } + ], + "container": "containerName", + "pathPattern": "" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + }, + "etag": "ca88f8fa-605b-4c7f-8695-46f5faa60cd0" + } + } + ], + "transformation": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/transformations/transformationtest", + "name": "transformationtest", + "type": "Microsoft.StreamAnalytics/streamingjobs/transformations", + "properties": { + "streamingUnits": 1, + "query": "Select Id, Name from inputtest", + "etag": "91d8fcbe-60b3-49c3-9f21-9942b95602b8" + } + }, + "functions": [], + "outputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/outputs/outputtest", + "name": "outputtest", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Sql/Server/Database", + "properties": { + "server": "serverName", + "database": "databaseName", + "table": "tableName", + "user": "userName" + } + }, + "etag": "62097c3c-b503-41ff-a56f-196a9598ab90" + } + } + ] + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Create_JobShell.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Create_JobShell.json new file mode 100644 index 000000000000..a511bb9cb1db --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Create_JobShell.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg6936", + "jobName": "sj59", + "streamingJob": { + "properties": { + "sku": { + "name": "Standard" + }, + "eventsOutOfOrderPolicy": "Drop", + "outputErrorPolicy": "Drop", + "eventsOutOfOrderMaxDelayInSeconds": 5, + "eventsLateArrivalMaxDelayInSeconds": 16, + "dataLocale": "en-US", + "compatibilityLevel": "1.0", + "inputs": [], + "outputs": [], + "functions": [] + }, + "location": "West US", + "tags": { + "key1": "value1", + "randomKey": "randomValue", + "key3": "value3" + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "3e6872bc-c9d0-45b6-91b6-da66f1773056" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6936/providers/Microsoft.StreamAnalytics/streamingjobs/sj59", + "name": "sj59", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "tags": { + "key1": "value1", + "randomKey": "randomValue", + "key3": "value3" + }, + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "d53ecc3c-fcb0-485d-9caf-25e20fcb2061", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Drop", + "outputErrorPolicy": "Drop", + "eventsOutOfOrderMaxDelayInSeconds": 5, + "eventsLateArrivalMaxDelayInSeconds": 16, + "dataLocale": "en-US", + "createdDate": "2017-05-11T04:37:04.697Z", + "compatibilityLevel": "1.0", + "inputs": [], + "functions": [], + "outputs": [] + } + } + }, + "200": { + "headers": { + "ETag": "3e6872bc-c9d0-45b6-91b6-da66f1773056" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6936/providers/Microsoft.StreamAnalytics/streamingjobs/sj59", + "name": "sj59", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "tags": { + "key1": "value1", + "randomKey": "randomValue", + "key3": "value3" + }, + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "d53ecc3c-fcb0-485d-9caf-25e20fcb2061", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Drop", + "outputErrorPolicy": "Drop", + "eventsOutOfOrderMaxDelayInSeconds": 5, + "eventsLateArrivalMaxDelayInSeconds": 16, + "dataLocale": "en-US", + "createdDate": "2017-05-11T04:37:04.697Z", + "compatibilityLevel": "1.0", + "inputs": [], + "functions": [], + "outputs": [] + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Delete.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Delete.json new file mode 100644 index 000000000000..dce6f8093aaa --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg6936", + "jobName": "sj59" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Get_Expand.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Get_Expand.json new file mode 100644 index 000000000000..6c053b6bf361 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Get_Expand.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg3276", + "jobName": "sj7804", + "$expand": "inputs,outputs,transformation,functions" + }, + "responses": { + "200": { + "headers": { + "ETag": "87551cc5-1290-4d08-afcd-cdaa92e5ade0" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804", + "name": "sj7804", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "tags": { + "key1": "value1", + "randomKey": "randomValue", + "key3": "value3" + }, + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "732e4b1d-94a7-43ae-8297-3ad04f1540b9", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Drop", + "outputErrorPolicy": "Drop", + "eventsOutOfOrderMaxDelayInSeconds": 0, + "eventsLateArrivalMaxDelayInSeconds": 5, + "dataLocale": "en-US", + "createdDate": "2017-05-11T04:37:11.54Z", + "compatibilityLevel": "1.0", + "inputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/inputs/inputtest", + "name": "inputtest", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "accountName" + } + ], + "container": "containerName", + "pathPattern": "" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + }, + "etag": "ca88f8fa-605b-4c7f-8695-46f5faa60cd0" + } + } + ], + "transformation": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/transformations/transformationtest", + "name": "transformationtest", + "type": "Microsoft.StreamAnalytics/streamingjobs/transformations", + "properties": { + "streamingUnits": 1, + "query": "Select Id, Name from inputtest", + "etag": "91d8fcbe-60b3-49c3-9f21-9942b95602b8" + } + }, + "functions": [], + "outputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/outputs/outputtest", + "name": "outputtest", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Sql/Server/Database", + "properties": { + "server": "serverName", + "database": "databaseName", + "table": "tableName", + "user": "userName" + } + }, + "etag": "62097c3c-b503-41ff-a56f-196a9598ab90" + } + } + ] + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Get_NoExpand.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Get_NoExpand.json new file mode 100644 index 000000000000..d1dd3c8eef79 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Get_NoExpand.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg6936", + "jobName": "sj59" + }, + "responses": { + "200": { + "headers": { + "ETag": "3e6872bc-c9d0-45b6-91b6-da66f1773056" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6936/providers/Microsoft.StreamAnalytics/streamingjobs/sj59", + "name": "sj59", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "tags": { + "key1": "value1", + "randomKey": "randomValue", + "key3": "value3" + }, + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "d53ecc3c-fcb0-485d-9caf-25e20fcb2061", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Drop", + "outputErrorPolicy": "Drop", + "eventsOutOfOrderMaxDelayInSeconds": 5, + "eventsLateArrivalMaxDelayInSeconds": 16, + "dataLocale": "en-US", + "createdDate": "2017-05-11T04:37:04.697Z", + "compatibilityLevel": "1.0" + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_List_ByResourceGroup_Expand.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_List_ByResourceGroup_Expand.json new file mode 100644 index 000000000000..e0c4616535b0 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_List_ByResourceGroup_Expand.json @@ -0,0 +1,188 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg3276", + "$expand": "inputs,outputs,transformation,functions" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804", + "name": "sj7804", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "tags": { + "key1": "value1", + "randomKey": "randomValue", + "key3": "value3" + }, + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "732e4b1d-94a7-43ae-8297-3ad04f1540b9", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Adjust", + "outputErrorPolicy": "Stop", + "eventsOutOfOrderMaxDelayInSeconds": 0, + "eventsLateArrivalMaxDelayInSeconds": 5, + "dataLocale": "en-US", + "createdDate": "2017-05-11T04:37:11.54Z", + "compatibilityLevel": "1.0", + "inputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/inputs/inputtest", + "name": "inputtest", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "accountName" + } + ], + "container": "containerName", + "pathPattern": "" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + }, + "etag": "ca88f8fa-605b-4c7f-8695-46f5faa60cd0" + } + } + ], + "transformation": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/transformations/transformationtest", + "name": "transformationtest", + "type": "Microsoft.StreamAnalytics/streamingjobs/transformations", + "properties": { + "streamingUnits": 1, + "query": "Select Id, Name from inputtest", + "etag": "91d8fcbe-60b3-49c3-9f21-9942b95602b8" + } + }, + "functions": [], + "outputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/outputs/outputtest", + "name": "outputtest", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Sql/Server/Database", + "properties": { + "server": "serverName", + "database": "databaseName", + "table": "tableName", + "user": "userName" + } + }, + "etag": "62097c3c-b503-41ff-a56f-196a9598ab90" + } + } + ], + "etag": "8081b2a3-dfe6-457f-8740-1a22d209bf8a" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7805", + "name": "sj7805", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "tags": { + "key1": "value1", + "randomKey": "randomValue", + "key3": "value3" + }, + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "d8f4041a-0793-433e-a38d-5499d5332113", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Adjust", + "outputErrorPolicy": "Stop", + "eventsOutOfOrderMaxDelayInSeconds": 0, + "eventsLateArrivalMaxDelayInSeconds": 5, + "dataLocale": "en-US", + "createdDate": "2017-05-11T04:38:11.54Z", + "compatibilityLevel": "1.0", + "inputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/inputs/inputtest", + "name": "inputtest", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "accountName" + } + ], + "container": "containerName", + "pathPattern": "" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + }, + "etag": "45dcf40f-88bb-4776-b5ca-7b10a607cb59" + } + } + ], + "transformation": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/transformations/transformationtest", + "name": "transformationtest", + "type": "Microsoft.StreamAnalytics/streamingjobs/transformations", + "properties": { + "streamingUnits": 1, + "query": "Select Id, Name from inputtest", + "etag": "288d95c0-204b-4c54-828f-f57aa6896b2a" + } + }, + "functions": [], + "outputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/outputs/outputtest", + "name": "outputtest", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Sql/Server/Database", + "properties": { + "server": "serverName", + "database": "databaseName", + "table": "tableName", + "user": "userName" + } + }, + "etag": "b09606c8-1b0d-43c9-affb-fac0e18b9481" + } + } + ], + "etag": "5420059f-e5d7-47d4-be44-40816a4dca7e" + } + } + ] + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_List_ByResourceGroup_NoExpand.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_List_ByResourceGroup_NoExpand.json new file mode 100644 index 000000000000..6d20fab383d5 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_List_ByResourceGroup_NoExpand.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg6936" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6936/providers/Microsoft.StreamAnalytics/streamingjobs/sj59", + "name": "sj59", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "tags": { + "key1": "value1", + "randomKey": "randomValue", + "key3": "value3" + }, + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "d53ecc3c-fcb0-485d-9caf-25e20fcb2061", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Drop", + "outputErrorPolicy": "Drop", + "eventsOutOfOrderMaxDelayInSeconds": 21, + "eventsLateArrivalMaxDelayInSeconds": 13, + "dataLocale": "en-US", + "createdDate": "2017-05-11T04:37:04.697Z", + "compatibilityLevel": "1.0", + "etag": "3e6872bc-c9d0-45b6-91b6-da66f1773056" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6936/providers/Microsoft.StreamAnalytics/streamingjobs/sj69", + "name": "sj69", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "tags": { + "key1": "value1", + "randomKey": "randomValue", + "key3": "value3" + }, + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "817b36cf-a161-4a9e-86f2-eb00b3566d88", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Drop", + "outputErrorPolicy": "Drop", + "eventsOutOfOrderMaxDelayInSeconds": 5, + "eventsLateArrivalMaxDelayInSeconds": 6, + "dataLocale": "en-US", + "createdDate": "2017-05-11T04:38:04.697Z", + "compatibilityLevel": "1.0", + "etag": "99538949-a164-4e2f-a991-40303e86024f" + } + } + ] + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_List_BySubscription_Expand.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_List_BySubscription_Expand.json new file mode 100644 index 000000000000..61848d645b6c --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_List_BySubscription_Expand.json @@ -0,0 +1,187 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "$expand": "inputs,outputs,transformation,functions" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804", + "name": "sj7804", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "tags": { + "key1": "value1", + "randomKey": "randomValue", + "key3": "value3" + }, + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "732e4b1d-94a7-43ae-8297-3ad04f1540b9", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Adjust", + "outputErrorPolicy": "Stop", + "eventsOutOfOrderMaxDelayInSeconds": 0, + "eventsLateArrivalMaxDelayInSeconds": 5, + "dataLocale": "en-US", + "createdDate": "2017-05-11T04:37:11.54Z", + "compatibilityLevel": "1.0", + "inputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/inputs/inputtest", + "name": "inputtest", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "accountName" + } + ], + "container": "containerName", + "pathPattern": "" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + }, + "etag": "ca88f8fa-605b-4c7f-8695-46f5faa60cd0" + } + } + ], + "transformation": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/transformations/transformationtest", + "name": "transformationtest", + "type": "Microsoft.StreamAnalytics/streamingjobs/transformations", + "properties": { + "streamingUnits": 1, + "query": "Select Id, Name from inputtest", + "etag": "91d8fcbe-60b3-49c3-9f21-9942b95602b8" + } + }, + "functions": [], + "outputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/outputs/outputtest", + "name": "outputtest", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Sql/Server/Database", + "properties": { + "server": "serverName", + "database": "databaseName", + "table": "tableName", + "user": "userName" + } + }, + "etag": "62097c3c-b503-41ff-a56f-196a9598ab90" + } + } + ], + "etag": "8081b2a3-dfe6-457f-8740-1a22d209bf8a" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7805", + "name": "sj7805", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "tags": { + "key1": "value1", + "randomKey": "randomValue", + "key3": "value3" + }, + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "d8f4041a-0793-433e-a38d-5499d5332113", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Adjust", + "outputErrorPolicy": "Stop", + "eventsOutOfOrderMaxDelayInSeconds": 0, + "eventsLateArrivalMaxDelayInSeconds": 5, + "dataLocale": "en-US", + "createdDate": "2017-05-11T04:38:11.54Z", + "compatibilityLevel": "1.0", + "inputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7805/inputs/inputtest", + "name": "inputtest", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "accountName" + } + ], + "container": "containerName", + "pathPattern": "" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + }, + "etag": "45dcf40f-88bb-4776-b5ca-7b10a607cb59" + } + } + ], + "transformation": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7805/transformations/transformationtest", + "name": "transformationtest", + "type": "Microsoft.StreamAnalytics/streamingjobs/transformations", + "properties": { + "streamingUnits": 1, + "query": "Select Id, Name from inputtest", + "etag": "288d95c0-204b-4c54-828f-f57aa6896b2a" + } + }, + "functions": [], + "outputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7805/outputs/outputtest", + "name": "outputtest", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Sql/Server/Database", + "properties": { + "server": "serverName", + "database": "databaseName", + "table": "tableName", + "user": "userName" + } + }, + "etag": "b09606c8-1b0d-43c9-affb-fac0e18b9481" + } + } + ], + "etag": "5420059f-e5d7-47d4-be44-40816a4dca7e" + } + } + ] + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_List_BySubscription_NoExpand.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_List_BySubscription_NoExpand.json new file mode 100644 index 000000000000..105953203391 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_List_BySubscription_NoExpand.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6936/providers/Microsoft.StreamAnalytics/streamingjobs/sj59", + "name": "sj59", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "tags": { + "key1": "value1", + "randomKey": "randomValue", + "key3": "value3" + }, + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "d53ecc3c-fcb0-485d-9caf-25e20fcb2061", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Drop", + "outputErrorPolicy": "Drop", + "eventsOutOfOrderMaxDelayInSeconds": 21, + "eventsLateArrivalMaxDelayInSeconds": 13, + "dataLocale": "en-US", + "createdDate": "2017-05-11T04:37:04.697Z", + "compatibilityLevel": "1.0", + "etag": "3e6872bc-c9d0-45b6-91b6-da66f1773056" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6936/providers/Microsoft.StreamAnalytics/streamingjobs/sj69", + "name": "sj69", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "tags": { + "key1": "value1", + "randomKey": "randomValue", + "key3": "value3" + }, + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "817b36cf-a161-4a9e-86f2-eb00b3566d88", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Drop", + "outputErrorPolicy": "Drop", + "eventsOutOfOrderMaxDelayInSeconds": 5, + "eventsLateArrivalMaxDelayInSeconds": 6, + "dataLocale": "en-US", + "createdDate": "2017-05-11T04:38:04.697Z", + "compatibilityLevel": "1.0", + "etag": "99538949-a164-4e2f-a991-40303e86024f" + } + } + ] + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Scale.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Scale.json new file mode 100644 index 000000000000..d8a9f92437c4 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Scale.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg6936", + "jobName": "sj59", + "scaleJobParameters": { + "streamingUnits": 36 + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Start_CustomTime.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Start_CustomTime.json new file mode 100644 index 000000000000..99d6cc724b4b --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Start_CustomTime.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg6936", + "jobName": "sj59", + "startJobParameters": { + "outputStartMode": "CustomTime", + "outputStartTime": "2012-12-12T12:12:12Z" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Start_JobStartTime.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Start_JobStartTime.json new file mode 100644 index 000000000000..ee6b99edbdb8 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Start_JobStartTime.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg6936", + "jobName": "sj59", + "startJobParameters": { + "outputStartMode": "JobStartTime" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Start_LastOutputEventTime.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Start_LastOutputEventTime.json new file mode 100644 index 000000000000..7f140640b826 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Start_LastOutputEventTime.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg6936", + "jobName": "sj59", + "startJobParameters": { + "outputStartMode": "LastOutputEventTime" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Stop.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Stop.json new file mode 100644 index 000000000000..bc02eeacea95 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Stop.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg6936", + "jobName": "sj59" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Update.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Update.json new file mode 100644 index 000000000000..23773a5449c3 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Update.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg6936", + "jobName": "sj59", + "streamingJob": { + "properties": { + "eventsOutOfOrderMaxDelayInSeconds": 21, + "eventsLateArrivalMaxDelayInSeconds": 13 + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "3e6872bc-c9d0-45b6-91b6-da66f1773056" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6936/providers/Microsoft.StreamAnalytics/streamingjobs/sj59", + "name": "sj59", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "tags": { + "key1": "value1", + "randomKey": "randomValue", + "key3": "value3" + }, + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "d53ecc3c-fcb0-485d-9caf-25e20fcb2061", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Drop", + "outputErrorPolicy": "Drop", + "eventsOutOfOrderMaxDelayInSeconds": 21, + "eventsLateArrivalMaxDelayInSeconds": 13, + "dataLocale": "en-US", + "createdDate": "2017-05-11T04:37:04.697Z", + "compatibilityLevel": "1.0" + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Subscription_ListQuotas.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Subscription_ListQuotas.json new file mode 100644 index 000000000000..d49fbfbf8e3b --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Subscription_ListQuotas.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "location": "West US" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/providers/Microsoft.StreamAnalytics/locations/West US/quotas/StreamingUnits", + "name": "StreamingUnits", + "type": "Microsoft.StreamAnalytics/quotas", + "properties": { + "maxCount": 200, + "currentCount": 0 + } + } + ] + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Transformation_Create.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Transformation_Create.json new file mode 100644 index 000000000000..fafa8edc580d --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Transformation_Create.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg4423", + "jobName": "sj8374", + "transformationName": "transformation952", + "transformation": { + "properties": { + "streamingUnits": 6, + "query": "Select Id, Name from inputtest" + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg4423/providers/Microsoft.StreamAnalytics/streamingjobs/sj8374/transformations/transformation952", + "name": "transformation952", + "type": "Microsoft.StreamAnalytics/streamingjobs/transformations", + "properties": { + "streamingUnits": 6, + "query": "Select Id, Name from inputtest" + } + } + }, + "200": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg4423/providers/Microsoft.StreamAnalytics/streamingjobs/sj8374/transformations/transformation952", + "name": "transformation952", + "type": "Microsoft.StreamAnalytics/streamingjobs/transformations", + "properties": { + "streamingUnits": 6, + "query": "Select Id, Name from inputtest" + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Transformation_Get.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Transformation_Get.json new file mode 100644 index 000000000000..b7d742b19dad --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Transformation_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg4423", + "jobName": "sj8374", + "transformationName": "transformation952" + }, + "responses": { + "200": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg4423/providers/Microsoft.StreamAnalytics/streamingjobs/sj8374/transformations/transformation952", + "name": "transformation952", + "type": "Microsoft.StreamAnalytics/streamingjobs/transformations", + "properties": { + "streamingUnits": 6, + "query": "Select Id, Name from inputtest" + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Transformation_Update.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Transformation_Update.json new file mode 100644 index 000000000000..34b94c54310e --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Transformation_Update.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg4423", + "jobName": "sj8374", + "transformationName": "transformation952", + "transformation": { + "properties": { + "query": "New query" + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "fc6f7a9b-3eea-4589-8265-cc854ec25f5a" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg4423/providers/Microsoft.StreamAnalytics/streamingjobs/sj8374/transformations/transformation952", + "name": "transformation952", + "type": "Microsoft.StreamAnalytics/streamingjobs/transformations", + "properties": { + "streamingUnits": 6, + "query": "New query" + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/functions.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/functions.json new file mode 100644 index 000000000000..0cc5c09af7d4 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/functions.json @@ -0,0 +1,832 @@ +{ + "swagger": "2.0", + "info": { + "title": "StreamAnalyticsManagementClient", + "version": "2020-03-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.StreamAnalytics/streamingjobs/{jobName}/functions/{functionName}": { + "put": { + "tags": [ + "Functions" + ], + "operationId": "Functions_CreateOrReplace", + "description": "Creates a function or replaces an already existing function under an existing streaming job.", + "x-ms-examples": { + "Create an Azure ML function": { + "$ref": "./examples/Function_Create_AzureML.json" + }, + "Create a JavaScript function": { + "$ref": "./examples/Function_Create_JavaScript.json" + } + }, + "parameters": [ + { + "name": "function", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Function" + }, + "description": "The definition of the function that will be used to create a new function or replace the existing one under the streaming job." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the function. Omit this value to always overwrite the current function. 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 function to be created, but to prevent updating an existing function. Other values will result in a 412 Pre-condition Failed response." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/FunctionNameParameter" + } + ], + "responses": { + "200": { + "description": "The function was successfully created or replaced.", + "schema": { + "$ref": "#/definitions/Function" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + }, + "201": { + "description": "The function was successfully created or replaced.", + "schema": { + "$ref": "#/definitions/Function" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + }, + "patch": { + "tags": [ + "Functions" + ], + "operationId": "Functions_Update", + "description": "Updates an existing function under an existing streaming job. This can be used to partially update (ie. update one or two properties) a function without affecting the rest the job or function definition.", + "x-ms-examples": { + "Update an Azure ML function": { + "$ref": "./examples/Function_Update_AzureML.json" + }, + "Update a JavaScript function": { + "$ref": "./examples/Function_Update_JavaScript.json" + } + }, + "parameters": [ + { + "name": "function", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Function" + }, + "description": "A function object. The properties specified here will overwrite the corresponding properties in the existing function (ie. Those properties will be updated). Any properties that are set to null here will mean that the corresponding property in the existing function will remain the same and not change as a result of this PATCH operation." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the function. Omit this value to always overwrite the current function. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/FunctionNameParameter" + } + ], + "responses": { + "200": { + "description": "The function was successfully updated.", + "schema": { + "$ref": "#/definitions/Function" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + }, + "delete": { + "tags": [ + "Functions" + ], + "operationId": "Functions_Delete", + "description": "Deletes a function from the streaming job.", + "x-ms-examples": { + "Delete a function": { + "$ref": "./examples/Function_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/FunctionNameParameter" + } + ], + "responses": { + "200": { + "description": "The function was successfully deleted." + }, + "204": { + "description": "The function does not exist." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + }, + "get": { + "tags": [ + "Functions" + ], + "operationId": "Functions_Get", + "description": "Gets details about the specified function.", + "x-ms-examples": { + "Get an Azure ML function": { + "$ref": "./examples/Function_Get_AzureML.json" + }, + "Get a JavaScript function": { + "$ref": "./examples/Function_Get_JavaScript.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/FunctionNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified function.", + "schema": { + "$ref": "#/definitions/Function" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/functions": { + "get": { + "tags": [ + "Functions" + ], + "operationId": "Functions_ListByStreamingJob", + "description": "Lists all of the functions under the specified streaming job.", + "x-ms-examples": { + "List all functions in a streaming job": { + "$ref": "./examples/Function_ListByStreamingJob.json" + } + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "The $select OData query parameter. This is a comma-separated list of structural properties to include in the response, or \"*\" to include all properties. By default, all properties are returned except diagnostics. Currently only accepts '*' as a valid value." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully listed the functions under the specified streaming job.", + "schema": { + "$ref": "#/definitions/FunctionListResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/functions/{functionName}/test": { + "post": { + "tags": [ + "Functions" + ], + "operationId": "Functions_Test", + "description": "Tests if the information provided for a function is valid. This can range from testing the connection to the underlying web service behind the function or making sure the function code provided is syntactically correct.", + "x-ms-examples": { + "Test the connection for an Azure ML function": { + "$ref": "./examples/Function_Test_AzureML.json" + }, + "Test the connection for a JavaScript function": { + "$ref": "./examples/Function_Test_JavaScript.json" + } + }, + "parameters": [ + { + "name": "function", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/Function" + }, + "description": "If the function specified does not already exist, this parameter must contain the full function definition intended to be tested. If the function specified already exists, this parameter can be left null to test the existing function as is or if specified, the properties specified will overwrite the corresponding properties in the existing function (exactly like a PATCH operation) and the resulting function will be tested." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/FunctionNameParameter" + } + ], + "responses": { + "200": { + "description": "The test operation completed successfully.", + "schema": { + "$ref": "./inputs.json#/definitions/ResourceTestStatus" + } + }, + "202": { + "description": "The test request was successfully initiated." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/functions/{functionName}/retrieveDefaultDefinition": { + "post": { + "tags": [ + "Functions" + ], + "operationId": "Functions_RetrieveDefaultDefinition", + "description": "Retrieves the default definition of a function based on the parameters specified.", + "x-ms-examples": { + "Retrieve the default definition for an Azure ML function": { + "$ref": "./examples/Function_RetrieveDefaultDefinition_AzureML.json" + } + }, + "parameters": [ + { + "name": "functionRetrieveDefaultDefinitionParameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/FunctionRetrieveDefaultDefinitionParameters" + }, + "description": "Parameters used to specify the type of function to retrieve the default definition for." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/FunctionNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the function's default definition.", + "schema": { + "$ref": "#/definitions/Function" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + } + } + }, + "definitions": { + "Function": { + "type": "object", + "description": "A function object, containing all information associated with the named function. All functions are contained under a streaming job.", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/FunctionProperties", + "description": "The properties that are associated with a function." + } + } + }, + "FunctionProperties": { + "type": "object", + "description": "The properties that are associated with a function.", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Indicates the type of function." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency." + } + }, + "required": [ + "type" + ] + }, + "ScalarFunctionProperties": { + "type": "object", + "description": "The properties that are associated with a scalar function.", + "x-ms-discriminator-value": "Scalar", + "allOf": [ + { + "$ref": "#/definitions/FunctionProperties" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ScalarFunctionConfiguration", + "description": "Describes the configuration of the scalar function.", + "x-ms-client-flatten": true + } + } + }, + "ScalarFunctionConfiguration": { + "type": "object", + "description": "Describes the configuration of the scalar function.", + "properties": { + "inputs": { + "type": "array", + "items": { + "$ref": "#/definitions/FunctionInput" + }, + "description": "A list of inputs describing the parameters of the function." + }, + "output": { + "$ref": "#/definitions/FunctionOutput", + "description": "The output of the function." + }, + "binding": { + "$ref": "#/definitions/FunctionBinding", + "description": "The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint." + } + } + }, + "FunctionInput": { + "type": "object", + "description": "Describes one input parameter of a function.", + "properties": { + "dataType": { + "type": "string", + "description": "The (Azure Stream Analytics supported) data type of the function input parameter. A list of valid Azure Stream Analytics data types are described at https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx" + }, + "isConfigurationParameter": { + "type": "boolean", + "description": "A flag indicating if the parameter is a configuration parameter. True if this input parameter is expected to be a constant. Default is false." + } + } + }, + "FunctionOutput": { + "type": "object", + "description": "Describes the output of a function.", + "properties": { + "dataType": { + "type": "string", + "description": "The (Azure Stream Analytics supported) data type of the function output. A list of valid Azure Stream Analytics data types are described at https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx" + } + } + }, + "FunctionBinding": { + "type": "object", + "description": "The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint.", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Indicates the function binding type." + } + }, + "required": [ + "type" + ] + }, + "AzureMachineLearningWebServiceFunctionBinding": { + "type": "object", + "description": "The binding to an Azure Machine Learning web service.", + "x-ms-discriminator-value": "Microsoft.MachineLearning/WebService", + "allOf": [ + { + "$ref": "#/definitions/FunctionBinding" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AzureMachineLearningWebServiceFunctionBindingProperties", + "description": "The binding properties associated with an Azure Machine learning web service.", + "x-ms-client-flatten": true + } + } + }, + "AzureMachineLearningWebServiceFunctionBindingProperties": { + "type": "object", + "description": "The binding properties associated with an Azure Machine learning web service.", + "properties": { + "endpoint": { + "type": "string", + "description": "The Request-Response execute endpoint of the Azure Machine Learning web service. Find out more here: https://docs.microsoft.com/en-us/azure/machine-learning/machine-learning-consume-web-services#request-response-service-rrs" + }, + "apiKey": { + "type": "string", + "description": "The API key used to authenticate with Request-Response endpoint." + }, + "inputs": { + "$ref": "#/definitions/AzureMachineLearningWebServiceInputs", + "description": "The inputs for the Azure Machine Learning web service endpoint." + }, + "outputs": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureMachineLearningWebServiceOutputColumn" + }, + "description": "A list of outputs from the Azure Machine Learning web service endpoint execution." + }, + "batchSize": { + "type": "integer", + "format": "int32", + "description": "Number between 1 and 10000 describing maximum number of rows for every Azure ML RRS execute request. Default is 1000." + } + } + }, + "AzureMachineLearningWebServiceInputs": { + "type": "object", + "description": "The inputs for the Azure Machine Learning web service endpoint.", + "properties": { + "name": { + "type": "string", + "description": "The name of the input. This is the name provided while authoring the endpoint." + }, + "columnNames": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureMachineLearningWebServiceInputColumn" + }, + "description": "A list of input columns for the Azure Machine Learning web service endpoint." + } + } + }, + "AzureMachineLearningWebServiceInputColumn": { + "type": "object", + "description": "Describes an input column for the Azure Machine Learning web service endpoint.", + "properties": { + "name": { + "type": "string", + "description": "The name of the input column." + }, + "dataType": { + "type": "string", + "description": "The (Azure Machine Learning supported) data type of the input column. A list of valid Azure Machine Learning data types are described at https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx ." + }, + "mapTo": { + "type": "integer", + "format": "int32", + "description": "The zero based index of the function parameter this input maps to." + } + } + }, + "AzureMachineLearningWebServiceOutputColumn": { + "type": "object", + "description": "Describes an output column for the Azure Machine Learning web service endpoint.", + "properties": { + "name": { + "type": "string", + "description": "The name of the output column." + }, + "dataType": { + "type": "string", + "description": "The (Azure Machine Learning supported) data type of the output column. A list of valid Azure Machine Learning data types are described at https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx ." + } + } + }, + "JavaScriptFunctionBinding": { + "type": "object", + "description": "The binding to a JavaScript function.", + "x-ms-discriminator-value": "Microsoft.StreamAnalytics/JavascriptUdf", + "allOf": [ + { + "$ref": "#/definitions/FunctionBinding" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/JavaScriptFunctionBindingProperties", + "description": "The binding properties associated with a JavaScript function.", + "x-ms-client-flatten": true + } + } + }, + "JavaScriptFunctionBindingProperties": { + "type": "object", + "description": "The binding properties associated with a JavaScript function.", + "properties": { + "script": { + "type": "string", + "description": "The JavaScript code containing a single function definition. For example: 'function (x, y) { return x + y; }'" + } + } + }, + "FunctionRetrieveDefaultDefinitionParameters": { + "type": "object", + "description": "Parameters used to specify the type of function to retrieve the default definition for.", + "discriminator": "bindingType", + "properties": { + "bindingType": { + "type": "string", + "description": "Indicates the function binding type." + } + }, + "required": [ + "bindingType" + ] + }, + "AzureMachineLearningWebServiceFunctionRetrieveDefaultDefinitionParameters": { + "type": "object", + "description": "The parameters needed to retrieve the default function definition for an Azure Machine Learning web service function.", + "x-ms-discriminator-value": "Microsoft.MachineLearning/WebService", + "allOf": [ + { + "$ref": "#/definitions/FunctionRetrieveDefaultDefinitionParameters" + } + ], + "properties": { + "bindingRetrievalProperties": { + "$ref": "#/definitions/AzureMachineLearningWebServiceFunctionBindingRetrievalProperties", + "description": "The binding retrieval properties associated with an Azure Machine learning web service.", + "x-ms-client-flatten": true + } + } + }, + "AzureMachineLearningWebServiceFunctionBindingRetrievalProperties": { + "type": "object", + "description": "The binding retrieval properties associated with an Azure Machine learning web service.", + "properties": { + "executeEndpoint": { + "type": "string", + "description": "The Request-Response execute endpoint of the Azure Machine Learning web service. Find out more here: https://docs.microsoft.com/en-us/azure/machine-learning/machine-learning-consume-web-services#request-response-service-rrs" + }, + "udfType": { + "$ref": "#/definitions/UdfType", + "description": "The function type." + } + } + }, + "JavaScriptFunctionRetrieveDefaultDefinitionParameters": { + "type": "object", + "description": "The parameters needed to retrieve the default function definition for a JavaScript function.", + "x-ms-discriminator-value": "Microsoft.StreamAnalytics/JavascriptUdf", + "allOf": [ + { + "$ref": "#/definitions/FunctionRetrieveDefaultDefinitionParameters" + } + ], + "properties": { + "bindingRetrievalProperties": { + "$ref": "#/definitions/JavaScriptFunctionBindingRetrievalProperties", + "description": "The binding retrieval properties associated with a JavaScript function.", + "x-ms-client-flatten": true + } + } + }, + "JavaScriptFunctionBindingRetrievalProperties": { + "type": "object", + "description": "The binding retrieval properties associated with a JavaScript function.", + "properties": { + "script": { + "type": "string", + "description": "The JavaScript code containing a single function definition. For example: 'function (x, y) { return x + y; }'." + }, + "udfType": { + "$ref": "#/definitions/UdfType", + "description": "The function type." + } + } + }, + "FunctionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Function" + }, + "readOnly": true, + "description": "A list of functions under a streaming job. Populated by a 'List' operation." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + }, + "description": "Object containing a list of functions under a streaming job." + }, + "UdfType": { + "type": "string", + "description": "The function type.", + "enum": [ + "Scalar" + ], + "x-ms-enum": { + "name": "UdfType", + "modelAsString": false + } + }, + "SubResource": { + "type": "object", + "description": "The base sub-resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + } + }, + "x-ms-azure-resource": true + } + }, + "parameters": { + "FunctionNameParameter": { + "name": "functionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the function.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/inputs.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/inputs.json new file mode 100644 index 000000000000..7ee84c08d90c --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/inputs.json @@ -0,0 +1,1142 @@ +{ + "swagger": "2.0", + "info": { + "title": "StreamAnalyticsManagementClient", + "version": "2020-03-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.StreamAnalytics/streamingjobs/{jobName}/inputs/{inputName}": { + "put": { + "tags": [ + "Inputs" + ], + "operationId": "Inputs_CreateOrReplace", + "description": "Creates an input or replaces an already existing input under an existing streaming job.", + "x-ms-examples": { + "Create a reference blob input with CSV serialization": { + "$ref": "./examples/Input_Create_Reference_Blob_CSV.json" + }, + "Create a stream blob input with CSV serialization": { + "$ref": "./examples/Input_Create_Stream_Blob_CSV.json" + }, + "Create a stream Event Hub input with JSON serialization": { + "$ref": "./examples/Input_Create_Stream_EventHub_JSON.json" + }, + "Create a stream IoT Hub input with Avro serialization": { + "$ref": "./examples/Input_Create_Stream_IoTHub_Avro.json" + } + }, + "parameters": [ + { + "name": "input", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Input" + }, + "description": "The definition of the input that will be used to create a new input or replace the existing one under the streaming job." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the input. Omit this value to always overwrite the current input. 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 input to be created, but to prevent updating an existing input. Other values will result in a 412 Pre-condition Failed response." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/InputNameParameter" + } + ], + "responses": { + "200": { + "description": "The input was successfully created or replaced.", + "schema": { + "$ref": "#/definitions/Input" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the input. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + }, + "201": { + "description": "The input was successfully created or replaced.", + "schema": { + "$ref": "#/definitions/Input" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the input. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + }, + "patch": { + "tags": [ + "Inputs" + ], + "operationId": "Inputs_Update", + "description": "Updates an existing input under an existing streaming job. This can be used to partially update (ie. update one or two properties) an input without affecting the rest the job or input definition.", + "x-ms-examples": { + "Update a reference blob input": { + "$ref": "./examples/Input_Update_Reference_Blob.json" + }, + "Update a stream blob input": { + "$ref": "./examples/Input_Update_Stream_Blob.json" + }, + "Update a stream Event Hub input": { + "$ref": "./examples/Input_Update_Stream_EventHub.json" + }, + "Update a stream IoT Hub input": { + "$ref": "./examples/Input_Update_Stream_IoTHub.json" + } + }, + "parameters": [ + { + "name": "input", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Input" + }, + "description": "An Input object. The properties specified here will overwrite the corresponding properties in the existing input (ie. Those properties will be updated). Any properties that are set to null here will mean that the corresponding property in the existing input will remain the same and not change as a result of this PATCH operation." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the input. Omit this value to always overwrite the current input. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/InputNameParameter" + } + ], + "responses": { + "200": { + "description": "The input was successfully updated.", + "schema": { + "$ref": "#/definitions/Input" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the input. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + }, + "delete": { + "tags": [ + "Inputs" + ], + "operationId": "Inputs_Delete", + "description": "Deletes an input from the streaming job.", + "x-ms-examples": { + "Delete an input": { + "$ref": "./examples/Input_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/InputNameParameter" + } + ], + "responses": { + "200": { + "description": "The input was successfully deleted." + }, + "204": { + "description": "The input does not exist." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + }, + "get": { + "tags": [ + "Inputs" + ], + "operationId": "Inputs_Get", + "description": "Gets details about the specified input.", + "x-ms-examples": { + "Get a reference blob input with CSV serialization": { + "$ref": "./examples/Input_Get_Reference_Blob_CSV.json" + }, + "Get a stream blob input with CSV serialization": { + "$ref": "./examples/Input_Get_Stream_Blob_CSV.json" + }, + "Get a stream Event Hub input with JSON serialization": { + "$ref": "./examples/Input_Get_Stream_EventHub_JSON.json" + }, + "Get a stream IoT Hub input with Avro serialization": { + "$ref": "./examples/Input_Get_Stream_IoTHub_Avro.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/InputNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified input.", + "schema": { + "$ref": "#/definitions/Input" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the input. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/inputs": { + "get": { + "tags": [ + "Inputs" + ], + "operationId": "Inputs_ListByStreamingJob", + "description": "Lists all of the inputs under the specified streaming job.", + "x-ms-examples": { + "List all inputs in a streaming job": { + "$ref": "./examples/Input_ListByStreamingJob.json" + }, + "List all inputs in a streaming job and include diagnostic information using the $select OData query parameter": { + "$ref": "./examples/Input_ListByStreamingJob_Diagnostics.json" + } + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "The $select OData query parameter. This is a comma-separated list of structural properties to include in the response, or \"*\" to include all properties. By default, all properties are returned except diagnostics. Currently only accepts '*' as a valid value." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully listed the inputs under the specified streaming job.", + "schema": { + "$ref": "#/definitions/InputListResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/inputs/{inputName}/test": { + "post": { + "tags": [ + "Inputs" + ], + "operationId": "Inputs_Test", + "description": "Tests whether an input’s datasource is reachable and usable by the Azure Stream Analytics service.", + "x-ms-examples": { + "Test the connection for an input": { + "$ref": "./examples/Input_Test.json" + } + }, + "parameters": [ + { + "name": "input", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/Input" + }, + "description": "If the input specified does not already exist, this parameter must contain the full input definition intended to be tested. If the input specified already exists, this parameter can be left null to test the existing input as is or if specified, the properties specified will overwrite the corresponding properties in the existing input (exactly like a PATCH operation) and the resulting input will be tested." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/InputNameParameter" + } + ], + "responses": { + "200": { + "description": "The test operation completed successfully.", + "schema": { + "$ref": "#/definitions/ResourceTestStatus" + } + }, + "202": { + "description": "The test request was successfully initiated." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "Input": { + "type": "object", + "description": "An input object, containing all information associated with the named input. All inputs are contained under a streaming job.", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/InputProperties", + "description": "The properties that are associated with an input. Required on PUT (CreateOrReplace) requests." + } + } + }, + "InputProperties": { + "type": "object", + "description": "The properties that are associated with an input.", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Indicates whether the input is a source of reference data or stream data. Required on PUT (CreateOrReplace) requests." + }, + "serialization": { + "$ref": "#/definitions/Serialization", + "description": "Describes how data from an input is serialized or how data is serialized when written to an output. Required on PUT (CreateOrReplace) requests." + }, + "diagnostics": { + "readOnly": true, + "$ref": "#/definitions/Diagnostics", + "description": "Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "The current entity tag for the input. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency." + }, + "compression": { + "$ref": "#/definitions/Compression", + "description": "Describes how input data is compressed" + }, + "partitionKey": { + "type": "string", + "description": "partitionKey Describes a key in the input data which is used for partitioning the input data" + } + }, + "required": [ + "type" + ] + }, + "StreamInputProperties": { + "type": "object", + "description": "The properties that are associated with an input containing stream data.", + "x-ms-discriminator-value": "Stream", + "allOf": [ + { + "$ref": "#/definitions/InputProperties" + } + ], + "properties": { + "datasource": { + "$ref": "#/definitions/StreamInputDataSource", + "description": "Describes an input data source that contains stream data. Required on PUT (CreateOrReplace) requests." + } + } + }, + "ReferenceInputProperties": { + "type": "object", + "description": "The properties that are associated with an input containing reference data.", + "x-ms-discriminator-value": "Reference", + "allOf": [ + { + "$ref": "#/definitions/InputProperties" + } + ], + "properties": { + "datasource": { + "$ref": "#/definitions/ReferenceInputDataSource", + "description": "Describes an input data source that contains reference data. Required on PUT (CreateOrReplace) requests." + } + } + }, + "StreamInputDataSource": { + "type": "object", + "description": "Describes an input data source that contains stream data.", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests." + } + }, + "required": [ + "type" + ] + }, + "BlobStreamInputDataSource": { + "type": "object", + "description": "Describes a blob input data source that contains stream data.", + "x-ms-discriminator-value": "Microsoft.Storage/Blob", + "allOf": [ + { + "$ref": "#/definitions/StreamInputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BlobStreamInputDataSourceProperties", + "description": "The properties that are associated with a blob input containing stream data. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "BlobStreamInputDataSourceProperties": { + "type": "object", + "description": "The properties that are associated with a blob input containing stream data.", + "allOf": [ + { + "$ref": "#/definitions/BlobDataSourceProperties" + } + ], + "properties": { + "sourcePartitionCount": { + "type": "integer", + "format": "int32", + "description": "The partition count of the blob input data source. Range 1 - 256." + } + } + }, + "EventHubStreamInputDataSource": { + "type": "object", + "description": "Describes an Event Hub input data source that contains stream data.", + "x-ms-discriminator-value": "Microsoft.ServiceBus/EventHub", + "allOf": [ + { + "$ref": "#/definitions/StreamInputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EventHubStreamInputDataSourceProperties", + "description": "The properties that are associated with an Event Hub input containing stream data. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "EventHubV2StreamInputDataSource": { + "type": "object", + "description": "Describes an Event Hub input data source that contains stream data.", + "x-ms-discriminator-value": "Microsoft.EventHub/EventHub", + "allOf": [ + { + "$ref": "#/definitions/StreamInputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EventHubStreamInputDataSourceProperties", + "description": "The properties that are associated with an Event Hub input containing stream data. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "EventHubStreamInputDataSourceProperties": { + "type": "object", + "description": "The properties that are associated with a Event Hub input containing stream data.", + "allOf": [ + { + "$ref": "#/definitions/EventHubDataSourceProperties" + } + ], + "properties": { + "consumerGroupName": { + "type": "string", + "description": "The name of an Event Hub Consumer Group that should be used to read events from the Event Hub. Specifying distinct consumer group names for multiple inputs allows each of those inputs to receive the same events from the Event Hub. If not specified, the input uses the Event Hub’s default consumer group." + } + } + }, + "IoTHubStreamInputDataSource": { + "type": "object", + "description": "Describes an IoT Hub input data source that contains stream data.", + "x-ms-discriminator-value": "Microsoft.Devices/IotHubs", + "allOf": [ + { + "$ref": "#/definitions/StreamInputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/IoTHubStreamInputDataSourceProperties", + "description": "The properties that are associated with an IoT Hub input containing stream data. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "IoTHubStreamInputDataSourceProperties": { + "type": "object", + "description": "The properties that are associated with a IoT Hub input containing stream data.", + "properties": { + "iotHubNamespace": { + "type": "string", + "description": "The name or the URI of the IoT Hub. Required on PUT (CreateOrReplace) requests." + }, + "sharedAccessPolicyName": { + "type": "string", + "description": "The shared access policy name for the IoT Hub. This policy must contain at least the Service connect permission. Required on PUT (CreateOrReplace) requests." + }, + "sharedAccessPolicyKey": { + "type": "string", + "description": "The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests." + }, + "consumerGroupName": { + "type": "string", + "description": "The name of an IoT Hub Consumer Group that should be used to read events from the IoT Hub. If not specified, the input uses the Iot Hub’s default consumer group." + }, + "endpoint": { + "type": "string", + "description": "The IoT Hub endpoint to connect to (ie. messages/events, messages/operationsMonitoringEvents, etc.)." + } + } + }, + "ReferenceInputDataSource": { + "type": "object", + "description": "Describes an input data source that contains reference data.", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests." + } + }, + "required": [ + "type" + ] + }, + "BlobReferenceInputDataSource": { + "type": "object", + "description": "Describes a blob input data source that contains reference data.", + "x-ms-discriminator-value": "Microsoft.Storage/Blob", + "allOf": [ + { + "$ref": "#/definitions/ReferenceInputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BlobReferenceInputDataSourceProperties", + "description": "The properties that are associated with a blob input containing reference data. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "BlobReferenceInputDataSourceProperties": { + "type": "object", + "description": "The properties that are associated with a blob input containing reference data.", + "allOf": [ + { + "$ref": "#/definitions/BlobDataSourceProperties" + } + ], + "properties": {} + }, + "BlobDataSourceProperties": { + "type": "object", + "description": "The properties that are associated with a blob data source.", + "properties": { + "storageAccounts": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccount" + }, + "description": "A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests." + }, + "container": { + "type": "string", + "description": "The name of a container within the associated Storage account. This container contains either the blob(s) to be read from or written to. Required on PUT (CreateOrReplace) requests." + }, + "pathPattern": { + "type": "string", + "description": "The blob path pattern. Not a regular expression. It represents a pattern against which blob names will be matched to determine whether or not they should be included as input or output to the job. See https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input or https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for a more detailed explanation and example." + }, + "dateFormat": { + "type": "string", + "description": "The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead." + }, + "timeFormat": { + "type": "string", + "description": "The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead." + } + } + }, + "StorageAccount": { + "type": "object", + "description": "The properties that are associated with an Azure Storage account", + "properties": { + "accountName": { + "type": "string", + "description": "The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests." + }, + "accountKey": { + "type": "string", + "description": "The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests." + } + } + }, + "ServiceBusDataSourceProperties": { + "type": "object", + "description": "The common properties that are associated with Service Bus data sources (Queues, Topics, Event Hubs, etc.).", + "properties": { + "serviceBusNamespace": { + "type": "string", + "description": "The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests." + }, + "sharedAccessPolicyName": { + "type": "string", + "description": "The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests." + }, + "sharedAccessPolicyKey": { + "type": "string", + "description": "The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests." + }, + "authenticationMode": { + "$ref": "../../common/v1/definitions.json#/definitions/AuthenticationMode", + "description": "Authentication Mode." + } + } + }, + "EventHubDataSourceProperties": { + "type": "object", + "description": "The common properties that are associated with Event Hub data sources.", + "allOf": [ + { + "$ref": "#/definitions/ServiceBusDataSourceProperties" + } + ], + "properties": { + "eventHubName": { + "type": "string", + "description": "The name of the Event Hub. Required on PUT (CreateOrReplace) requests." + } + } + }, + "Diagnostics": { + "type": "object", + "description": "Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention.", + "properties": { + "conditions": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/DiagnosticCondition" + }, + "description": "A collection of zero or more conditions applicable to the resource, or to the job overall, that warrant customer attention." + } + } + }, + "DiagnosticCondition": { + "type": "object", + "description": "Condition applicable to the resource, or to the job overall, that warrant customer attention.", + "properties": { + "since": { + "readOnly": true, + "type": "string", + "description": "The UTC timestamp of when the condition started. Customers should be able to find a corresponding event in the ops log around this time." + }, + "code": { + "readOnly": true, + "type": "string", + "description": "The opaque diagnostic code." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "The human-readable message describing the condition in detail. Localized in the Accept-Language of the client request." + } + } + }, + "InputListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Input" + }, + "readOnly": true, + "description": "A list of inputs under a streaming job. Populated by a 'List' operation." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + }, + "description": "Object containing a list of inputs under a streaming job." + }, + "Serialization": { + "type": "object", + "description": "Describes how data from an input is serialized or how data is serialized when written to an output.", + "discriminator": "type", + "properties": { + "type": { + "description": "Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests.", + "$ref": "#/definitions/EventSerializationType" + } + }, + "required": [ + "type" + ] + }, + "EventSerializationType": { + "type": "string", + "description": "Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests.", + "enum": [ + "Csv", + "Avro", + "Json", + "Parquet" + ], + "x-ms-enum": { + "name": "EventSerializationType", + "modelAsString": true + } + }, + "ParquetSerialization": { + "type": "object", + "description": "Describes how data from an input is serialized or how data is serialized when written to an output in Parquet format.", + "x-ms-discriminator-value": "Parquet", + "allOf": [ + { + "$ref": "#/definitions/Serialization" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ParquetSerializationProperties", + "description": "The properties that are associated with the Parquet serialization type. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "ParquetSerializationProperties": { + "type": "object", + "description": "The properties that are associated with the Parquet serialization type.", + "properties": {} + }, + "CsvSerialization": { + "type": "object", + "description": "Describes how data from an input is serialized or how data is serialized when written to an output in CSV format.", + "x-ms-discriminator-value": "Csv", + "allOf": [ + { + "$ref": "#/definitions/Serialization" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/CsvSerializationProperties", + "description": "The properties that are associated with the CSV serialization type. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "CsvSerializationProperties": { + "type": "object", + "description": "The properties that are associated with the CSV serialization type.", + "properties": { + "fieldDelimiter": { + "type": "string", + "description": "Specifies the delimiter that will be used to separate comma-separated value (CSV) records. See https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input or https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for a list of supported values. Required on PUT (CreateOrReplace) requests." + }, + "encoding": { + "$ref": "#/definitions/Encoding", + "description": "Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. Required on PUT (CreateOrReplace) requests." + } + } + }, + "JsonSerialization": { + "type": "object", + "description": "Describes how data from an input is serialized or how data is serialized when written to an output in JSON format.", + "x-ms-discriminator-value": "Json", + "allOf": [ + { + "$ref": "#/definitions/Serialization" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/JsonSerializationProperties", + "description": "The properties that are associated with the JSON serialization type. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "JsonSerializationProperties": { + "type": "object", + "description": "The properties that are associated with the JSON serialization type.", + "properties": { + "encoding": { + "$ref": "#/definitions/Encoding", + "description": "Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. Required on PUT (CreateOrReplace) requests." + }, + "format": { + "$ref": "#/definitions/JsonOutputSerializationFormat", + "description": "This property only applies to JSON serialization of outputs only. It is not applicable to inputs. This property specifies the format of the JSON the output will be written in. The currently supported values are 'lineSeparated' indicating the output will be formatted by having each JSON object separated by a new line and 'array' indicating the output will be formatted as an array of JSON objects. Default value is 'lineSeparated' if left null." + } + } + }, + "AvroSerialization": { + "type": "object", + "description": "Describes how data from an input is serialized or how data is serialized when written to an output in Avro format.", + "x-ms-discriminator-value": "Avro", + "allOf": [ + { + "$ref": "#/definitions/Serialization" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AvroSerializationProperties", + "description": "The properties that are associated with the Avro serialization type. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "AvroSerializationProperties": { + "type": "object", + "description": "The properties that are associated with the Avro serialization type.", + "properties": {} + }, + "Encoding": { + "type": "string", + "description": "Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output.", + "enum": [ + "UTF8" + ], + "x-ms-enum": { + "name": "Encoding", + "modelAsString": true + } + }, + "JsonOutputSerializationFormat": { + "type": "string", + "description": "Specifies the format of the JSON the output will be written in. The currently supported values are 'lineSeparated' indicating the output will be formatted by having each JSON object separated by a new line and 'array' indicating the output will be formatted as an array of JSON objects.", + "enum": [ + "LineSeparated", + "Array" + ], + "x-ms-enum": { + "name": "JsonOutputSerializationFormat", + "modelAsString": true + } + }, + "ResourceTestStatus": { + "type": "object", + "description": "Describes the status of the test operation along with error information, if applicable.", + "properties": { + "status": { + "readOnly": true, + "type": "string", + "description": "The status of the test operation." + }, + "error": { + "readOnly": true, + "$ref": "#/definitions/ErrorResponse", + "description": "Describes the error that occurred." + } + } + }, + "ErrorResponse": { + "type": "object", + "description": "Describes the error that occurred.", + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "Error code associated with the error that occurred." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "Describes the error in detail." + } + } + }, + "SubResource": { + "type": "object", + "description": "The base sub-resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + } + }, + "x-ms-azure-resource": true + }, + "Compression": { + "type": "object", + "description": "Describes how input data is compressed", + "properties": { + "type": { + "description": "Indicates the type of compression that the input uses. Required on PUT (CreateOrReplace) requests.", + "$ref": "#/definitions/CompressionType" + } + }, + "required": [ + "type" + ] + }, + "CompressionType": { + "type": "string", + "description": "Indicates the type of compression that the input uses. Required on PUT (CreateOrReplace) requests.", + "enum": [ + "None", + "GZip", + "Deflate" + ], + "x-ms-enum": { + "name": "CompressionType", + "modelAsString": true + } + }, + "AzureSqlReferenceInputDataSource": { + "type": "object", + "description": "Describes an Azure SQL database reference input data source.", + "x-ms-discriminator-value": "Microsoft.Sql/Server/Database", + "allOf": [ + { + "$ref": "#/definitions/ReferenceInputDataSource" + } + ], + "properties": { + "properties": { + "description": "The properties that are associated with SQL DB input containing reference data. Required on PUT (CreateOrReplace) requests.", + "$ref": "#/definitions/AzureSqlReferenceInputDataSourceProperties", + "x-ms-client-flatten": true + } + } + }, + "AzureSqlReferenceInputDataSourceProperties": { + "description": "The properties that are associated with SQL DB input containing reference data. Required on PUT (CreateOrReplace) requests.", + "type": "object", + "properties": { + "server": { + "description": "This element is associated with the datasource element. This is the name of the server that contains the database that will be written to.", + "type": "string" + }, + "database": { + "description": "This element is associated with the datasource element. This is the name of the database that output will be written to.", + "type": "string" + }, + "user": { + "description": "This element is associated with the datasource element. This is the user name that will be used to connect to the SQL Database instance.", + "type": "string" + }, + "password": { + "description": "This element is associated with the datasource element. This is the password that will be used to connect to the SQL Database instance.", + "type": "string", + "x-ms-secret": true + }, + "table": { + "description": "This element is associated with the datasource element. The name of the table in the Azure SQL database..", + "type": "string" + }, + "refreshType": { + "type": "object", + "description": "Indicates the type of data refresh option.", + "$ref": "#/definitions/RefreshType" + }, + "refreshRate": { + "description": "This element is associated with the datasource element. This indicates how frequently the data will be fetched from the database. It is of DateTime format.", + "type": "string" + }, + "fullSnapshotQuery": { + "description": "This element is associated with the datasource element. This query is used to fetch data from the sql database.", + "type": "string" + }, + "deltaSnapshotQuery": { + "description": "This element is associated with the datasource element. This query is used to fetch incremental changes from the SQL database. To use this option, we recommend using temporal tables in Azure SQL Database.", + "type": "string" + } + } + }, + "RefreshType": { + "type": "string", + "description": "Indicates the type of data refresh option.", + "enum": [ + "Static", + "RefreshPeriodicallyWithFull", + "RefreshPeriodicallyWithDelta" + ], + "x-ms-enum": { + "name": "RefreshType", + "modelAsString": true + } + } + }, + "parameters": { + "InputNameParameter": { + "name": "inputName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the input.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/outputs.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/outputs.json new file mode 100644 index 000000000000..d4041f3510f0 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/outputs.json @@ -0,0 +1,1099 @@ +{ + "swagger": "2.0", + "info": { + "title": "StreamAnalyticsManagementClient", + "version": "2020-03-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.StreamAnalytics/streamingjobs/{jobName}/outputs/{outputName}": { + "put": { + "tags": [ + "Outputs" + ], + "operationId": "Outputs_CreateOrReplace", + "description": "Creates an output or replaces an already existing output under an existing streaming job.", + "x-ms-examples": { + "Create an Azure SQL database output": { + "$ref": "./examples/Output_Create_AzureSQL.json" + }, + "Create an Azure Table output": { + "$ref": "./examples/Output_Create_AzureTable.json" + }, + "Create a blob output with CSV serialization": { + "$ref": "./examples/Output_Create_Blob_CSV.json" + }, + "Create a DocumentDB output": { + "$ref": "./examples/Output_Create_DocumentDB.json" + }, + "Create an Event Hub output with JSON serialization": { + "$ref": "./examples/Output_Create_EventHub_JSON.json" + }, + "Create a Service Bus Queue output with Avro serialization": { + "$ref": "./examples/Output_Create_ServiceBusQueue_Avro.json" + }, + "Create a Service Bus Topic output with CSV serialization": { + "$ref": "./examples/Output_Create_ServiceBusTopic_CSV.json" + }, + "Create a Power BI output": { + "$ref": "./examples/Output_Create_PowerBI.json" + }, + "Create an Azure Data Lake Store output with JSON serialization": { + "$ref": "./examples/Output_Create_AzureDataLakeStore_JSON.json" + } + }, + "parameters": [ + { + "name": "output", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Output" + }, + "description": "The definition of the output that will be used to create a new output or replace the existing one under the streaming job." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the output. Omit this value to always overwrite the current output. 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 output to be created, but to prevent updating an existing output. Other values will result in a 412 Pre-condition Failed response." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/OutputNameParameter" + } + ], + "responses": { + "200": { + "description": "The output was successfully created or replaced.", + "schema": { + "$ref": "#/definitions/Output" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the output. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + }, + "201": { + "description": "The output was successfully created or replaced.", + "schema": { + "$ref": "#/definitions/Output" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the output. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + }, + "patch": { + "tags": [ + "Outputs" + ], + "operationId": "Outputs_Update", + "description": "Updates an existing output under an existing streaming job. This can be used to partially update (ie. update one or two properties) an output without affecting the rest the job or output definition.", + "x-ms-examples": { + "Update an Azure SQL database output": { + "$ref": "./examples/Output_Update_AzureSQL.json" + }, + "Update an Azure Table output": { + "$ref": "./examples/Output_Update_AzureTable.json" + }, + "Update a blob output with CSV serialization": { + "$ref": "./examples/Output_Update_Blob.json" + }, + "Update a DocumentDB output": { + "$ref": "./examples/Output_Update_DocumentDB.json" + }, + "Update an Event Hub output with JSON serialization": { + "$ref": "./examples/Output_Update_EventHub.json" + }, + "Update a Service Bus Queue output with Avro serialization": { + "$ref": "./examples/Output_Update_ServiceBusQueue.json" + }, + "Update a Service Bus Topic output with CSV serialization": { + "$ref": "./examples/Output_Update_ServiceBusTopic.json" + }, + "Update a Power BI output": { + "$ref": "./examples/Output_Update_PowerBI.json" + }, + "Update an Azure Data Lake Store output with JSON serialization": { + "$ref": "./examples/Output_Update_AzureDataLakeStore.json" + } + }, + "parameters": [ + { + "name": "output", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Output" + }, + "description": "An Output object. The properties specified here will overwrite the corresponding properties in the existing output (ie. Those properties will be updated). Any properties that are set to null here will mean that the corresponding property in the existing output will remain the same and not change as a result of this PATCH operation." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the output. Omit this value to always overwrite the current output. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/OutputNameParameter" + } + ], + "responses": { + "200": { + "description": "The output was successfully updated.", + "schema": { + "$ref": "#/definitions/Output" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the output. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + }, + "delete": { + "tags": [ + "Outputs" + ], + "operationId": "Outputs_Delete", + "description": "Deletes an output from the streaming job.", + "x-ms-examples": { + "Delete an output": { + "$ref": "./examples/Output_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/OutputNameParameter" + } + ], + "responses": { + "200": { + "description": "The output was successfully deleted." + }, + "204": { + "description": "The output does not exist." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + }, + "get": { + "tags": [ + "Outputs" + ], + "operationId": "Outputs_Get", + "description": "Gets details about the specified output.", + "x-ms-examples": { + "Get an Azure SQL database output": { + "$ref": "./examples/Output_Get_AzureSQL.json" + }, + "Get an Azure Table output": { + "$ref": "./examples/Output_Get_AzureTable.json" + }, + "Get a blob output with CSV serialization": { + "$ref": "./examples/Output_Get_Blob_CSV.json" + }, + "Get a DocumentDB output": { + "$ref": "./examples/Output_Get_DocumentDB.json" + }, + "Get an Azure Data Warehouse output": { + "$ref": "./examples/Output_Get_DataWarehouse.json" + }, + "Get an Event Hub output with JSON serialization": { + "$ref": "./examples/Output_Get_EventHub_JSON.json" + }, + "Get a Service Bus Queue output with Avro serialization": { + "$ref": "./examples/Output_Get_ServiceBusQueue_Avro.json" + }, + "Get a Service Bus Topic output with CSV serialization": { + "$ref": "./examples/Output_Get_ServiceBusTopic_CSV.json" + }, + "Get a Power BI output": { + "$ref": "./examples/Output_Get_PowerBI.json" + }, + "Get an Azure Data Lake Store output with JSON serialization": { + "$ref": "./examples/Output_Get_AzureDataLakeStore_JSON.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/OutputNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified output.", + "schema": { + "$ref": "#/definitions/Output" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the output. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/outputs": { + "get": { + "tags": [ + "Outputs" + ], + "operationId": "Outputs_ListByStreamingJob", + "description": "Lists all of the outputs under the specified streaming job.", + "x-ms-examples": { + "List all outputs in a streaming job": { + "$ref": "./examples/Output_ListByStreamingJob.json" + } + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "The $select OData query parameter. This is a comma-separated list of structural properties to include in the response, or \"*\" to include all properties. By default, all properties are returned except diagnostics. Currently only accepts '*' as a valid value." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully listed the outputs under the specified streaming job.", + "schema": { + "$ref": "#/definitions/OutputListResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/outputs/{outputName}/test": { + "post": { + "tags": [ + "Outputs" + ], + "operationId": "Outputs_Test", + "description": "Tests whether an output’s datasource is reachable and usable by the Azure Stream Analytics service.", + "x-ms-examples": { + "Test the connection for an output": { + "$ref": "./examples/Output_Test.json" + } + }, + "parameters": [ + { + "name": "output", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/Output" + }, + "description": "If the output specified does not already exist, this parameter must contain the full output definition intended to be tested. If the output specified already exists, this parameter can be left null to test the existing output as is or if specified, the properties specified will overwrite the corresponding properties in the existing output (exactly like a PATCH operation) and the resulting output will be tested." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/OutputNameParameter" + } + ], + "responses": { + "200": { + "description": "The test operation completed successfully.", + "schema": { + "$ref": "./inputs.json#/definitions/ResourceTestStatus" + } + }, + "202": { + "description": "The test request was successfully initiated." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "Output": { + "type": "object", + "description": "An output object, containing all information associated with the named output. All outputs are contained under a streaming job.", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/OutputProperties", + "description": "The properties that are associated with an output. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "OutputProperties": { + "type": "object", + "description": "The properties that are associated with an output.", + "properties": { + "datasource": { + "$ref": "#/definitions/OutputDataSource", + "description": "Describes the data source that output will be written to. Required on PUT (CreateOrReplace) requests." + }, + "timeWindow": { + "type": "string", + "description": "The time frame for filtering Stream Analytics job outputs." + }, + "sizeWindow": { + "type": "number", + "description": "The size window to constrain a Stream Analytics output to." + }, + "serialization": { + "$ref": "./inputs.json#/definitions/Serialization", + "description": "Describes how data from an input is serialized or how data is serialized when written to an output. Required on PUT (CreateOrReplace) requests." + }, + "diagnostics": { + "readOnly": true, + "$ref": "./inputs.json#/definitions/Diagnostics", + "description": "Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "The current entity tag for the output. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency." + } + } + }, + "OutputDataSource": { + "type": "object", + "description": "Describes the data source that output will be written to.", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests." + } + }, + "required": [ + "type" + ] + }, + "BlobOutputDataSource": { + "type": "object", + "description": "Describes a blob output data source.", + "x-ms-discriminator-value": "Microsoft.Storage/Blob", + "allOf": [ + { + "$ref": "#/definitions/OutputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BlobOutputDataSourceProperties", + "description": "The properties that are associated with a blob output. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "BlobOutputDataSourceProperties": { + "type": "object", + "description": "The properties that are associated with a blob output.", + "allOf": [ + { + "$ref": "./inputs.json#/definitions/BlobDataSourceProperties" + } + ], + "properties": { + "authenticationMode": { + "$ref": "../../common/v1/definitions.json#/definitions/AuthenticationMode", + "description": "Authentication Mode." + } + } + }, + "AzureTableOutputDataSource": { + "type": "object", + "description": "Describes an Azure Table output data source.", + "x-ms-discriminator-value": "Microsoft.Storage/Table", + "allOf": [ + { + "$ref": "#/definitions/OutputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AzureTableOutputDataSourceProperties", + "description": "The properties that are associated with an Azure Table output. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "AzureTableOutputDataSourceProperties": { + "type": "object", + "description": "The properties that are associated with an Azure Table output.", + "properties": { + "accountName": { + "type": "string", + "description": "The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests." + }, + "accountKey": { + "type": "string", + "description": "The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests.", + "x-ms-secret": true + }, + "table": { + "type": "string", + "description": "The name of the Azure Table. Required on PUT (CreateOrReplace) requests." + }, + "partitionKey": { + "type": "string", + "description": "This element indicates the name of a column from the SELECT statement in the query that will be used as the partition key for the Azure Table. Required on PUT (CreateOrReplace) requests." + }, + "rowKey": { + "type": "string", + "description": "This element indicates the name of a column from the SELECT statement in the query that will be used as the row key for the Azure Table. Required on PUT (CreateOrReplace) requests." + }, + "columnsToRemove": { + "type": "array", + "items": { + "type": "string" + }, + "description": "If specified, each item in the array is the name of a column to remove (if present) from output event entities." + }, + "batchSize": { + "type": "integer", + "format": "int32", + "description": "The number of rows to write to the Azure Table at a time." + } + } + }, + "EventHubOutputDataSource": { + "type": "object", + "description": "Describes an Event Hub output data source.", + "x-ms-discriminator-value": "Microsoft.ServiceBus/EventHub", + "allOf": [ + { + "$ref": "#/definitions/OutputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EventHubOutputDataSourceProperties", + "description": "The properties that are associated with an Event Hub output. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "EventHubV2OutputDataSource": { + "type": "object", + "description": "Describes an Event Hub output data source.", + "x-ms-discriminator-value": "Microsoft.EventHub/EventHub", + "allOf": [ + { + "$ref": "#/definitions/OutputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EventHubOutputDataSourceProperties", + "description": "The properties that are associated with an Event Hub output. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "EventHubOutputDataSourceProperties": { + "type": "object", + "description": "The properties that are associated with an Event Hub output.", + "allOf": [ + { + "$ref": "./inputs.json#/definitions/EventHubDataSourceProperties" + } + ], + "properties": { + "partitionKey": { + "type": "string", + "description": "The key/column that is used to determine to which partition to send event data." + }, + "propertyColumns": { + "type": "array", + "description": "The properties associated with this Event Hub output.", + "items": { + "type": "string" + } + } + } + }, + "AzureSqlDatabaseOutputDataSource": { + "type": "object", + "description": "Describes an Azure SQL database output data source.", + "x-ms-discriminator-value": "Microsoft.Sql/Server/Database", + "allOf": [ + { + "$ref": "#/definitions/OutputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AzureSqlDatabaseOutputDataSourceProperties", + "description": "The properties that are associated with an Azure SQL database output. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "AzureSqlDatabaseOutputDataSourceProperties": { + "type": "object", + "description": "The properties that are associated with an Azure SQL database output.", + "allOf": [ + { + "$ref": "#/definitions/AzureSqlDatabaseDataSourceProperties" + } + ], + "properties": {} + }, + "AzureSynapseOutputDataSource": { + "type": "object", + "description": "Describes an Azure Synapse output data source.", + "x-ms-discriminator-value": "Microsoft.Sql/Server/DataWarehouse", + "allOf": [ + { + "$ref": "#/definitions/OutputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AzureSynapseOutputDataSourceProperties", + "description": "The properties that are associated with an Azure Synapse output. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "AzureSynapseOutputDataSourceProperties": { + "type": "object", + "description": "The properties that are associated with an Azure Synapse output.", + "allOf": [ + { + "$ref": "#/definitions/AzureSynapseDataSourceProperties" + } + ], + "properties": {} + }, + "AzureSynapseDataSourceProperties": { + "type": "object", + "description": "The properties that are associated with an Azure SQL database data source.", + "properties": { + "server": { + "type": "string", + "description": "The name of the SQL server containing the Azure SQL database. Required on PUT (CreateOrReplace) requests." + }, + "database": { + "type": "string", + "description": "The name of the Azure SQL database. Required on PUT (CreateOrReplace) requests." + }, + "table": { + "type": "string", + "description": "The name of the table in the Azure SQL database. Required on PUT (CreateOrReplace) requests." + }, + "user": { + "type": "string", + "description": "The user name that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests." + }, + "password": { + "type": "string", + "description": "The password that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests.", + "x-ms-secret": true + } + } + }, + "DocumentDbOutputDataSource": { + "type": "object", + "description": "Describes a DocumentDB output data source.", + "x-ms-discriminator-value": "Microsoft.Storage/DocumentDB", + "allOf": [ + { + "$ref": "#/definitions/OutputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DocumentDbOutputDataSourceProperties", + "description": "The properties that are associated with a DocumentDB output. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "DocumentDbOutputDataSourceProperties": { + "type": "object", + "description": "The properties that are associated with a DocumentDB output.", + "properties": { + "accountId": { + "type": "string", + "description": "The DocumentDB account name or ID. Required on PUT (CreateOrReplace) requests." + }, + "accountKey": { + "type": "string", + "description": "The account key for the DocumentDB account. Required on PUT (CreateOrReplace) requests." + }, + "database": { + "type": "string", + "description": "The name of the DocumentDB database. Required on PUT (CreateOrReplace) requests." + }, + "collectionNamePattern": { + "type": "string", + "description": "The collection name pattern for the collections to be used. The collection name format can be constructed using the optional {partition} token, where partitions start from 0. See the DocumentDB section of https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for more information. Required on PUT (CreateOrReplace) requests." + }, + "partitionKey": { + "type": "string", + "description": "The name of the field in output events used to specify the key for partitioning output across collections. If 'collectionNamePattern' contains the {partition} token, this property is required to be specified." + }, + "documentId": { + "type": "string", + "description": "The name of the field in output events used to specify the primary key which insert or update operations are based on." + } + } + }, + "ServiceBusQueueOutputDataSource": { + "type": "object", + "description": "Describes a Service Bus Queue output data source.", + "x-ms-discriminator-value": "Microsoft.ServiceBus/Queue", + "allOf": [ + { + "$ref": "#/definitions/OutputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ServiceBusQueueOutputDataSourceProperties", + "description": "The properties that are associated with a Service Bus Queue output. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "ServiceBusQueueOutputDataSourceProperties": { + "type": "object", + "description": "The properties that are associated with a Service Bus Queue output.", + "allOf": [ + { + "$ref": "./inputs.json#/definitions/ServiceBusDataSourceProperties" + } + ], + "properties": { + "queueName": { + "type": "string", + "description": "The name of the Service Bus Queue. Required on PUT (CreateOrReplace) requests." + }, + "propertyColumns": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A string array of the names of output columns to be attached to Service Bus messages as custom properties." + }, + "systemPropertyColumns": { + "type": "object", + "description": "The system properties associated with the Service Bus Queue. The following system properties are supported: ReplyToSessionId, ContentType, To, Subject, CorrelationId, TimeToLive, PartitionKey, SessionId, ScheduledEnqueueTime, MessageId, ReplyTo, Label, ScheduledEnqueueTimeUtc." + } + } + }, + "ServiceBusTopicOutputDataSource": { + "type": "object", + "description": "Describes a Service Bus Topic output data source.", + "x-ms-discriminator-value": "Microsoft.ServiceBus/Topic", + "allOf": [ + { + "$ref": "#/definitions/OutputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ServiceBusTopicOutputDataSourceProperties", + "description": "The properties that are associated with a Service Bus Topic output. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "ServiceBusTopicOutputDataSourceProperties": { + "type": "object", + "description": "The properties that are associated with a Service Bus Topic output.", + "allOf": [ + { + "$ref": "./inputs.json#/definitions/ServiceBusDataSourceProperties" + } + ], + "properties": { + "topicName": { + "type": "string", + "description": "The name of the Service Bus Topic. Required on PUT (CreateOrReplace) requests." + }, + "propertyColumns": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A string array of the names of output columns to be attached to Service Bus messages as custom properties." + }, + "systemPropertyColumns": { + "type": "object", + "description": "The system properties associated with the Service Bus Topic Output. The following system properties are supported: ReplyToSessionId, ContentType, To, Subject, CorrelationId, TimeToLive, PartitionKey, SessionId, ScheduledEnqueueTime, MessageId, ReplyTo, Label, ScheduledEnqueueTimeUtc.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "PowerBIOutputDataSource": { + "type": "object", + "description": "Describes a Power BI output data source.", + "x-ms-discriminator-value": "PowerBI", + "allOf": [ + { + "$ref": "#/definitions/OutputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PowerBIOutputDataSourceProperties", + "description": "The properties that are associated with a Power BI output. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "PowerBIOutputDataSourceProperties": { + "type": "object", + "description": "The properties that are associated with a Power BI output.", + "allOf": [ + { + "$ref": "#/definitions/OAuthBasedDataSourceProperties" + } + ], + "properties": { + "dataset": { + "type": "string", + "description": "The name of the Power BI dataset. Required on PUT (CreateOrReplace) requests." + }, + "table": { + "type": "string", + "description": "The name of the Power BI table under the specified dataset. Required on PUT (CreateOrReplace) requests." + }, + "groupId": { + "type": "string", + "description": "The ID of the Power BI group." + }, + "groupName": { + "type": "string", + "description": "The name of the Power BI group. Use this property to help remember which specific Power BI group id was used." + }, + "authenticationMode": { + "$ref": "../../common/v1/definitions.json#/definitions/AuthenticationMode", + "description": "Authentication Mode." + } + } + }, + "AzureDataLakeStoreOutputDataSource": { + "type": "object", + "description": "Describes an Azure Data Lake Store output data source.", + "x-ms-discriminator-value": "Microsoft.DataLake/Accounts", + "allOf": [ + { + "$ref": "#/definitions/OutputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AzureDataLakeStoreOutputDataSourceProperties", + "description": "The properties that are associated with an Azure Data Lake Store output. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "AzureDataLakeStoreOutputDataSourceProperties": { + "type": "object", + "description": "The properties that are associated with an Azure Data Lake Store.", + "allOf": [ + { + "$ref": "#/definitions/OAuthBasedDataSourceProperties" + } + ], + "properties": { + "accountName": { + "type": "string", + "description": "The name of the Azure Data Lake Store account. Required on PUT (CreateOrReplace) requests." + }, + "tenantId": { + "type": "string", + "description": "The tenant id of the user used to obtain the refresh token. Required on PUT (CreateOrReplace) requests." + }, + "filePathPrefix": { + "type": "string", + "description": "The location of the file to which the output should be written to. Required on PUT (CreateOrReplace) requests." + }, + "dateFormat": { + "type": "string", + "description": "The date format. Wherever {date} appears in filePathPrefix, the value of this property is used as the date format instead." + }, + "timeFormat": { + "type": "string", + "description": "The time format. Wherever {time} appears in filePathPrefix, the value of this property is used as the time format instead." + }, + "authenticationMode": { + "$ref": "../../common/v1/definitions.json#/definitions/AuthenticationMode", + "description": "Authentication Mode." + } + } + }, + "OutputListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Output" + }, + "readOnly": true, + "description": "A list of outputs under a streaming job. Populated by a 'List' operation." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + }, + "description": "Object containing a list of outputs under a streaming job." + }, + "AzureSqlDatabaseDataSourceProperties": { + "type": "object", + "description": "The properties that are associated with an Azure SQL database data source.", + "properties": { + "server": { + "type": "string", + "description": "The name of the SQL server containing the Azure SQL database. Required on PUT (CreateOrReplace) requests." + }, + "database": { + "type": "string", + "description": "The name of the Azure SQL database. Required on PUT (CreateOrReplace) requests." + }, + "user": { + "type": "string", + "description": "The user name that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests." + }, + "password": { + "type": "string", + "description": "The password that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests." + }, + "table": { + "type": "string", + "description": "The name of the table in the Azure SQL database. Required on PUT (CreateOrReplace) requests." + }, + "maxBatchCount": { + "type": "number", + "description": "Max Batch count for write to Sql database, the default value is 10,000. Optional on PUT requests." + }, + "maxWriterCount": { + "type": "number", + "description": "Max Writer count, currently only 1(single writer) and 0(based on query partition) are available. Optional on PUT requests." + }, + "authenticationMode": { + "$ref": "../../common/v1/definitions.json#/definitions/AuthenticationMode", + "description": "Authentication Mode." + } + } + }, + "OAuthBasedDataSourceProperties": { + "type": "object", + "description": "The properties that are associated with data sources that use OAuth as their authentication model.", + "properties": { + "refreshToken": { + "type": "string", + "description": "A refresh token that can be used to obtain a valid access token that can then be used to authenticate with the data source. A valid refresh token is currently only obtainable via the Azure Portal. It is recommended to put a dummy string value here when creating the data source and then going to the Azure Portal to authenticate the data source which will update this property with a valid refresh token. Required on PUT (CreateOrReplace) requests." + }, + "tokenUserPrincipalName": { + "type": "string", + "description": "The user principal name (UPN) of the user that was used to obtain the refresh token. Use this property to help remember which user was used to obtain the refresh token." + }, + "tokenUserDisplayName": { + "type": "string", + "description": "The user display name of the user that was used to obtain the refresh token. Use this property to help remember which user was used to obtain the refresh token." + } + } + }, + "SubResource": { + "type": "object", + "description": "The base sub-resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + } + }, + "x-ms-azure-resource": true + } + }, + "parameters": { + "OutputNameParameter": { + "name": "outputName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the output.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/streamingjobs.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/streamingjobs.json new file mode 100644 index 000000000000..ba3f27b32f2c --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/streamingjobs.json @@ -0,0 +1,948 @@ +{ + "swagger": "2.0", + "info": { + "title": "StreamAnalyticsManagementClient", + "version": "2020-03-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.StreamAnalytics/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists all of the available Stream Analytics related operations.", + "x-ms-examples": { + "List available operations for the Stream Analytics resource provider": { + "$ref": "./examples/Operation_List.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully listed the available operations.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}": { + "put": { + "tags": [ + "StreamingJobs" + ], + "operationId": "StreamingJobs_CreateOrReplace", + "description": "Creates a streaming job or replaces an already existing streaming job.", + "x-ms-examples": { + "Create a streaming job shell (a streaming job with no inputs, outputs, transformation, or functions)": { + "$ref": "./examples/StreamingJob_Create_JobShell.json" + }, + "Create a complete streaming job (a streaming job with a transformation, at least 1 input and at least 1 output)": { + "$ref": "./examples/StreamingJob_Create_CompleteJob.json" + } + }, + "parameters": [ + { + "name": "streamingJob", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StreamingJob" + }, + "description": "The definition of the streaming job that will be used to create a new streaming job or replace the existing one." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the streaming job. Omit this value to always overwrite the current record set. 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 streaming job to be created, but to prevent updating an existing record set. Other values will result in a 412 Pre-condition Failed response." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + } + ], + "responses": { + "200": { + "description": "The streaming job was successfully created or replaced.", + "schema": { + "$ref": "#/definitions/StreamingJob" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the streaming job. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + }, + "201": { + "description": "The streaming job was successfully created or replaced.", + "schema": { + "$ref": "#/definitions/StreamingJob" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the streaming job. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "StreamingJobs" + ], + "operationId": "StreamingJobs_Update", + "description": "Updates an existing streaming job. This can be used to partially update (ie. update one or two properties) a streaming job without affecting the rest the job definition.", + "x-ms-examples": { + "Update a streaming job": { + "$ref": "./examples/StreamingJob_Update.json" + } + }, + "parameters": [ + { + "name": "streamingJob", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StreamingJob" + }, + "description": "A streaming job object. The properties specified here will overwrite the corresponding properties in the existing streaming job (ie. Those properties will be updated). Any properties that are set to null here will mean that the corresponding property in the existing input will remain the same and not change as a result of this PATCH operation." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the streaming job. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + } + ], + "responses": { + "200": { + "description": "The streaming job was successfully updated.", + "schema": { + "$ref": "#/definitions/StreamingJob" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the streaming job. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + }, + "delete": { + "tags": [ + "StreamingJobs" + ], + "operationId": "StreamingJobs_Delete", + "description": "Deletes a streaming job.", + "x-ms-examples": { + "Delete a streaming job": { + "$ref": "./examples/StreamingJob_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + } + ], + "responses": { + "200": { + "description": "The streaming job was successfully deleted." + }, + "202": { + "description": "The delete request was successfully initiated." + }, + "204": { + "description": "The streaming job does not exist." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "StreamingJobs" + ], + "operationId": "StreamingJobs_Get", + "description": "Gets details about the specified streaming job.", + "x-ms-examples": { + "Get a streaming job and do not use the $expand OData query parameter": { + "$ref": "./examples/StreamingJob_Get_NoExpand.json" + }, + "Get a streaming job and use the $expand OData query parameter to expand inputs, outputs, transformation, and functions": { + "$ref": "./examples/StreamingJob_Get_Expand.json" + } + }, + "parameters": [ + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The $expand OData query parameter. This is a comma-separated list of additional streaming job properties to include in the response, beyond the default set returned when this parameter is absent. The default set is all streaming job properties other than 'inputs', 'transformation', 'outputs', and 'functions'." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified streaming job.", + "schema": { + "$ref": "#/definitions/StreamingJob" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the streaming job. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs": { + "get": { + "tags": [ + "StreamingJobs" + ], + "operationId": "StreamingJobs_ListByResourceGroup", + "description": "Lists all of the streaming jobs in the specified resource group.", + "x-ms-examples": { + "List all streaming jobs in a resource group and do not use the $expand OData query parameter": { + "$ref": "./examples/StreamingJob_List_ByResourceGroup_NoExpand.json" + }, + "List all streaming jobs in a resource group and use the $expand OData query parameter to expand inputs, outputs, transformation, and functions": { + "$ref": "./examples/StreamingJob_List_ByResourceGroup_Expand.json" + } + }, + "parameters": [ + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The $expand OData query parameter. This is a comma-separated list of additional streaming job properties to include in the response, beyond the default set returned when this parameter is absent. The default set is all streaming job properties other than 'inputs', 'transformation', 'outputs', and 'functions'." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully listed the streaming jobs under the specified resource group.", + "schema": { + "$ref": "#/definitions/StreamingJobListResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StreamAnalytics/streamingjobs": { + "get": { + "tags": [ + "StreamingJobs" + ], + "operationId": "StreamingJobs_List", + "description": "Lists all of the streaming jobs in the given subscription.", + "x-ms-examples": { + "List all streaming jobs in a subscription and do not use the $expand OData query parameter": { + "$ref": "./examples/StreamingJob_List_BySubscription_NoExpand.json" + }, + "List all streaming jobs in a subscription and use the $expand OData query parameter to expand inputs, outputs, transformation, and functions": { + "$ref": "./examples/StreamingJob_List_BySubscription_Expand.json" + } + }, + "parameters": [ + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The $expand OData query parameter. This is a comma-separated list of additional streaming job properties to include in the response, beyond the default set returned when this parameter is absent. The default set is all streaming job properties other than 'inputs', 'transformation', 'outputs', and 'functions'." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully listed the streaming jobs under the given subscription.", + "schema": { + "$ref": "#/definitions/StreamingJobListResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/start": { + "post": { + "tags": [ + "StreamingJobs" + ], + "operationId": "StreamingJobs_Start", + "description": "Starts a streaming job. Once a job is started it will start processing input events and produce output.", + "x-ms-examples": { + "Start a streaming job with CustomTime output start mode": { + "$ref": "./examples/StreamingJob_Start_CustomTime.json" + }, + "Start a streaming job with JobStartTime output start mode": { + "$ref": "./examples/StreamingJob_Start_JobStartTime.json" + }, + "Start a streaming job with LastOutputEventTime output start mode": { + "$ref": "./examples/StreamingJob_Start_LastOutputEventTime.json" + } + }, + "parameters": [ + { + "name": "startJobParameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/StartStreamingJobParameters" + }, + "description": "Parameters applicable to a start streaming job operation." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + } + ], + "responses": { + "200": { + "description": "The streaming job was successfully started." + }, + "202": { + "description": "The start streaming job request was successfully initiated." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/stop": { + "post": { + "tags": [ + "StreamingJobs" + ], + "operationId": "StreamingJobs_Stop", + "description": "Stops a running streaming job. This will cause a running streaming job to stop processing input events and producing output.", + "x-ms-examples": { + "Stop a streaming job": { + "$ref": "./examples/StreamingJob_Stop.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + } + ], + "responses": { + "200": { + "description": "The streaming job was successfully stopped." + }, + "202": { + "description": "The stop streaming job request was successfully initiated." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/scale": { + "post": { + "tags": [ + "StreamingJobs" + ], + "operationId": "StreamingJobs_Scale", + "description": "Scales a streaming job when the job is running.", + "x-ms-examples": { + "Scale a streaming job": { + "$ref": "./examples/StreamingJob_Scale.json" + } + }, + "parameters": [ + { + "name": "scaleJobParameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ScaleStreamingJobParameters" + }, + "description": "Parameters applicable to a scale streaming job operation." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + } + ], + "responses": { + "202": { + "description": "The scale streaming job request was successfully initiated." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "OperationListResult": { + "type": "object", + "description": "Result of the request to list Stream Analytics operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "List of Stream Analytics operations supported by the Microsoft.StreamAnalytics resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "Operation": { + "description": "A Stream Analytics REST API operation", + "type": "object", + "properties": { + "name": { + "description": "The name of the operation being performed on this particular object.", + "type": "string", + "readOnly": true + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "display": { + "type": "object", + "description": "Contains the localized display information for this particular operation / action.", + "readOnly": true, + "properties": { + "provider": { + "description": "The localized friendly form of the resource provider name.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "The localized friendly form of the resource type related to this action/operation.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "The localized friendly name for the operation.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The localized friendly description for the operation.", + "type": "string", + "readOnly": true + } + } + } + } + }, + "StreamingJob": { + "type": "object", + "description": "A streaming job object, containing all information associated with the named streaming job.", + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StreamingJobProperties", + "description": "The properties that are associated with a streaming job. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "Describes the system-assigned managed identity assigned to this job that can be used to authenticate with inputs and outputs." + } + } + }, + "StreamingJobProperties": { + "type": "object", + "description": "The properties that are associated with a streaming job.", + "properties": { + "sku": { + "description": "Describes the SKU of the streaming job. Required on PUT (CreateOrReplace) requests.", + "$ref": "#/definitions/Sku" + }, + "jobId": { + "readOnly": true, + "type": "string", + "description": "A GUID uniquely identifying the streaming job. This GUID is generated upon creation of the streaming job." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Describes the provisioning status of the streaming job." + }, + "jobState": { + "readOnly": true, + "type": "string", + "description": "Describes the state of the streaming job." + }, + "jobType": { + "type": "string", + "description": "Describes the type of the job. Valid modes are `Cloud` and 'Edge'.", + "enum": [ + "Cloud", + "Edge" + ], + "x-ms-enum": { + "name": "JobType", + "modelAsString": true + } + }, + "outputStartMode": { + "$ref": "#/definitions/OutputStartMode", + "description": "This property should only be utilized when it is desired that the job be started immediately upon creation. Value may be JobStartTime, CustomTime, or LastOutputEventTime to indicate whether the starting point of the output event stream should start whenever the job is started, start at a custom user time stamp specified via the outputStartTime property, or start from the last event output time." + }, + "outputStartTime": { + "type": "string", + "format": "date-time", + "description": "Value is either an ISO-8601 formatted time stamp that indicates the starting point of the output event stream, or null to indicate that the output event stream will start whenever the streaming job is started. This property must have a value if outputStartMode is set to CustomTime." + }, + "lastOutputEventTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Value is either an ISO-8601 formatted timestamp indicating the last output event time of the streaming job or null indicating that output has not yet been produced. In case of multiple outputs or multiple streams, this shows the latest value in that set." + }, + "eventsOutOfOrderPolicy": { + "$ref": "#/definitions/EventsOutOfOrderPolicy", + "description": "Indicates the policy to apply to events that arrive out of order in the input event stream." + }, + "outputErrorPolicy": { + "$ref": "#/definitions/OutputErrorPolicy", + "description": "Indicates the policy to apply to events that arrive at the output and cannot be written to the external storage due to being malformed (missing column values, column values of wrong type or size)." + }, + "eventsOutOfOrderMaxDelayInSeconds": { + "type": "integer", + "format": "int32", + "description": "The maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order." + }, + "eventsLateArrivalMaxDelayInSeconds": { + "type": "integer", + "format": "int32", + "description": "The maximum tolerable delay in seconds where events arriving late could be included. Supported range is -1 to 1814399 (20.23:59:59 days) and -1 is used to specify wait indefinitely. If the property is absent, it is interpreted to have a value of -1." + }, + "dataLocale": { + "type": "string", + "description": "The data locale of the stream analytics job. Value should be the name of a supported .NET Culture from the set https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx. Defaults to 'en-US' if none specified." + }, + "compatibilityLevel": { + "$ref": "#/definitions/CompatibilityLevel", + "description": "Controls certain runtime behaviors of the streaming job." + }, + "createdDate": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Value is an ISO-8601 formatted UTC timestamp indicating when the streaming job was created." + }, + "inputs": { + "type": "array", + "items": { + "$ref": "./inputs.json#/definitions/Input" + }, + "description": "A list of one or more inputs to the streaming job. The name property for each input is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual input." + }, + "transformation": { + "$ref": "./transformations.json#/definitions/Transformation", + "description": "Indicates the query and the number of streaming units to use for the streaming job. The name property of the transformation is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual transformation." + }, + "outputs": { + "type": "array", + "items": { + "$ref": "./outputs.json#/definitions/Output" + }, + "description": "A list of one or more outputs for the streaming job. The name property for each output is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual output." + }, + "functions": { + "type": "array", + "items": { + "$ref": "./functions.json#/definitions/Function" + }, + "description": "A list of one or more functions for the streaming job. The name property for each function is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual transformation." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "The current entity tag for the streaming job. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency." + }, + "jobStorageAccount": { + "description": "The properties that are associated with an Azure Storage account with MSI", + "$ref": "#/definitions/JobStorageAccount" + }, + "contentStoragePolicy": { + "readOnly": false, + "type": "string", + "description": "Valid values are JobStorageAccount and SystemAccount. If set to JobStorageAccount, this requires the user to also specify jobStorageAccount property. .", + "enum": [ + "SystemAccount", + "JobStorageAccount" + ], + "x-ms-enum": { + "name": "ContentStoragePolicy", + "modelAsString": true + } + }, + "cluster": { + "$ref": "#/definitions/ClusterInfo", + "description": "The cluster which streaming jobs will run on." + } + } + }, + "ClusterInfo": { + "type": "object", + "description": "The properties associated with a Stream Analytics cluster.", + "properties": { + "id": { + "description": "The resource id of cluster.", + "type": "string" + } + } + }, + "Sku": { + "type": "object", + "description": "The properties that are associated with a SKU.", + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU. Required on PUT (CreateOrReplace) requests.", + "enum": [ + "Standard" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + } + } + }, + "StreamingJobListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/StreamingJob" + }, + "readOnly": true, + "description": "A list of streaming jobs. Populated by a 'List' operation." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + }, + "description": "Object containing a list of streaming jobs." + }, + "StartStreamingJobParameters": { + "type": "object", + "description": "Parameters supplied to the Start Streaming Job operation.", + "properties": { + "outputStartMode": { + "$ref": "#/definitions/OutputStartMode", + "description": "Value may be JobStartTime, CustomTime, or LastOutputEventTime to indicate whether the starting point of the output event stream should start whenever the job is started, start at a custom user time stamp specified via the outputStartTime property, or start from the last event output time." + }, + "outputStartTime": { + "type": "string", + "format": "date-time", + "description": "Value is either an ISO-8601 formatted time stamp that indicates the starting point of the output event stream, or null to indicate that the output event stream will start whenever the streaming job is started. This property must have a value if outputStartMode is set to CustomTime." + } + } + }, + "OutputStartMode": { + "type": "string", + "description": "Value may be JobStartTime, CustomTime, or LastOutputEventTime to indicate whether the starting point of the output event stream should start whenever the job is started, start at a custom user time stamp specified via the outputStartTime property, or start from the last event output time.", + "enum": [ + "JobStartTime", + "CustomTime", + "LastOutputEventTime" + ], + "x-ms-enum": { + "name": "OutputStartMode", + "modelAsString": true + } + }, + "ScaleStreamingJobParameters": { + "type": "object", + "description": "Parameters supplied to the Scale Streaming Job operation.", + "properties": { + "streamingUnits": { + "type": "integer", + "format": "int32", + "description": "Specifies the number of streaming units that the streaming job will scale to." + } + } + }, + "EventsOutOfOrderPolicy": { + "type": "string", + "description": "Indicates the policy to apply to events that arrive out of order in the input event stream.", + "enum": [ + "Adjust", + "Drop" + ], + "x-ms-enum": { + "name": "EventsOutOfOrderPolicy", + "modelAsString": true + } + }, + "OutputErrorPolicy": { + "type": "string", + "description": "Indicates the policy to apply to events that arrive at the output and cannot be written to the external storage due to being malformed (missing column values, column values of wrong type or size).", + "enum": [ + "Stop", + "Drop" + ], + "x-ms-enum": { + "name": "OutputErrorPolicy", + "modelAsString": true + } + }, + "CompatibilityLevel": { + "type": "string", + "description": "Controls certain runtime behaviors of the streaming job.", + "enum": [ + "1.0", + "1.2" + ], + "x-ms-enum": { + "name": "CompatibilityLevel", + "modelAsString": true + } + }, + "JobStorageAccount": { + "type": "object", + "description": "The properties that are associated with an Azure Storage account with MSI", + "allOf": [ + { + "$ref": "./inputs.json#/definitions/StorageAccount" + } + ], + "properties": { + "authenticationMode": { + "$ref": "../../common/v1/definitions.json#/definitions/AuthenticationMode", + "description": "Authentication Mode." + } + } + }, + "Identity": { + "type": "object", + "description": "Describes how identity is verified", + "properties": { + "tenantId": { + "type": "string", + "description": "The identity tenantId" + }, + "principalId": { + "type": "string", + "description": "The identity principal ID" + }, + "type": { + "type": "string", + "description": "The identity type" + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/subscriptions.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/subscriptions.json new file mode 100644 index 000000000000..8a6e1865d7b7 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/subscriptions.json @@ -0,0 +1,147 @@ +{ + "swagger": "2.0", + "info": { + "title": "StreamAnalyticsManagementClient", + "version": "2020-03-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.StreamAnalytics/locations/{location}/quotas": { + "get": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_ListQuotas", + "description": "Retrieves the subscription's current quota information in a particular region.", + "x-ms-examples": { + "List subscription quota information in West US": { + "$ref": "./examples/Subscription_ListQuotas.json" + } + }, + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The region in which to retrieve the subscription's quota information. You can find out which regions Azure Stream Analytics is supported in here: https://azure.microsoft.com/en-us/regions/" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the subscription's quota information in the specified region.", + "schema": { + "$ref": "#/definitions/SubscriptionQuotasListResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + } + } + }, + "definitions": { + "SubscriptionQuotasListResult": { + "type": "object", + "description": "Result of the GetQuotas operation. It contains a list of quotas for the subscription in a particular region.", + "properties": { + "value": { + "description": "List of quotas for the subscription in a particular region.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SubscriptionQuota" + } + } + } + }, + "SubscriptionQuota": { + "description": "Describes the current quota for the subscription.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "description": "Describes the properties of the quota.", + "readOnly": true, + "properties": { + "maxCount": { + "description": "The max permitted usage of this resource.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "currentCount": { + "description": "The current usage of this resource.", + "type": "integer", + "format": "int32", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "SubResource": { + "type": "object", + "description": "The base sub-resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + } + }, + "x-ms-azure-resource": true + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/transformations.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/transformations.json new file mode 100644 index 000000000000..5e04f4b0786d --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/transformations.json @@ -0,0 +1,314 @@ +{ + "swagger": "2.0", + "info": { + "title": "StreamAnalyticsManagementClient", + "version": "2020-03-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.StreamAnalytics/streamingjobs/{jobName}/transformations/{transformationName}": { + "put": { + "tags": [ + "Transformations" + ], + "operationId": "Transformations_CreateOrReplace", + "description": "Creates a transformation or replaces an already existing transformation under an existing streaming job.", + "x-ms-examples": { + "Create a transformation": { + "$ref": "./examples/Transformation_Create.json" + } + }, + "parameters": [ + { + "name": "transformation", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Transformation" + }, + "description": "The definition of the transformation that will be used to create a new transformation or replace the existing one under the streaming job." + }, + { + "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 transformation. 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 transformation to be created, but to prevent updating an existing transformation. Other values will result in a 412 Pre-condition Failed response." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/TransformationNameParameter" + } + ], + "responses": { + "200": { + "description": "The transformation was successfully created or replaced.", + "schema": { + "$ref": "#/definitions/Transformation" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the transformation. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + }, + "201": { + "description": "The transformation was successfully created or replaced.", + "schema": { + "$ref": "#/definitions/Transformation" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the transformation. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + }, + "patch": { + "tags": [ + "Transformations" + ], + "operationId": "Transformations_Update", + "description": "Updates an existing transformation under an existing streaming job. This can be used to partially update (ie. update one or two properties) a transformation without affecting the rest the job or transformation definition.", + "x-ms-examples": { + "Update a transformation": { + "$ref": "./examples/Transformation_Update.json" + } + }, + "parameters": [ + { + "name": "transformation", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Transformation" + }, + "description": "A Transformation object. The properties specified here will overwrite the corresponding properties in the existing transformation (ie. Those properties will be updated). Any properties that are set to null here will mean that the corresponding property in the existing transformation will remain the same and not change as a result of this PATCH operation." + }, + { + "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 transformation. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/TransformationNameParameter" + } + ], + "responses": { + "200": { + "description": "The transformation was successfully updated.", + "schema": { + "$ref": "#/definitions/Transformation" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the transformation. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + }, + "get": { + "tags": [ + "Transformations" + ], + "operationId": "Transformations_Get", + "description": "Gets details about the specified transformation.", + "x-ms-examples": { + "Get a transformation": { + "$ref": "./examples/Transformation_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/TransformationNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified transformation.", + "schema": { + "$ref": "#/definitions/Transformation" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the transformation. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + } + } + }, + "definitions": { + "Transformation": { + "type": "object", + "description": "A transformation object, containing all information associated with the named transformation. All transformations are contained under a streaming job.", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TransformationProperties", + "description": "The properties that are associated with a transformation. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "TransformationProperties": { + "type": "object", + "description": "The properties that are associated with a transformation.", + "properties": { + "streamingUnits": { + "type": "integer", + "format": "int32", + "description": "Specifies the number of streaming units that the streaming job uses." + }, + "validStreamingUnits": { + "type": "integer", + "format": "int32", + "description": "Specifies the valid streaming units a streaming job can scale to." + }, + "query": { + "type": "string", + "description": "Specifies the query that will be run in the streaming job. You can learn more about the Stream Analytics Query Language (SAQL) here: https://msdn.microsoft.com/library/azure/dn834998 . Required on PUT (CreateOrReplace) requests." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "The current entity tag for the transformation. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency." + } + } + }, + "SubResource": { + "type": "object", + "description": "The base sub-resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + } + }, + "x-ms-azure-resource": true + } + }, + "parameters": { + "TransformationNameParameter": { + "name": "transformationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the transformation.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/streamanalytics/resource-manager/readme.md b/specification/streamanalytics/resource-manager/readme.md index 27cc64486393..cdf5bcb37684 100644 --- a/specification/streamanalytics/resource-manager/readme.md +++ b/specification/streamanalytics/resource-manager/readme.md @@ -50,6 +50,20 @@ input-file: - Microsoft.StreamAnalytics/preview/2020-03-01-preview/privateEndpoints.json ``` +### Tag: package-pure-2020-03 + +These settings apply only when `--tag=package-pure-2020-03` is specified on the command line. + +``` yaml $(tag) == 'package-pure-2020-03' +input-file: +- Microsoft.StreamAnalytics/stable/2020-03-01/streamingjobs.json +- Microsoft.StreamAnalytics/stable/2020-03-01/inputs.json +- Microsoft.StreamAnalytics/stable/2020-03-01/outputs.json +- Microsoft.StreamAnalytics/stable/2020-03-01/transformations.json +- Microsoft.StreamAnalytics/stable/2020-03-01/functions.json +- Microsoft.StreamAnalytics/stable/2020-03-01/subscriptions.json +``` + ### Tag: package-pure-2020-03-preview These settings apply only when `--tag=package-pure-2020-03-preview` is specified on the command line. @@ -105,7 +119,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-go - repo: azure-sdk-for-node @@ -134,6 +147,10 @@ csharp: See configuration in [readme.go.md](./readme.go.md) +## Python + +See configuration in [readme.python.md](./readme.python.md) + ## Java These settings apply only when `--java` is specified on the command line. diff --git a/specification/streamanalytics/resource-manager/readme.python.md b/specification/streamanalytics/resource-manager/readme.python.md index a74b0b5aaff2..c2e54d4eb99c 100644 --- a/specification/streamanalytics/resource-manager/readme.python.md +++ b/specification/streamanalytics/resource-manager/readme.python.md @@ -5,18 +5,6 @@ Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.subscription - package-name: azure-mgmt-subscription - clear-output-folder: true -``` -``` yaml $(python) && $(track2) + +``` yaml $(python) python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.subscription package-name: azure-mgmt-subscription +package-version: 1.0.0b1 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/subscription/azure-mgmt-subscription/azure/mgmt/subscription -``` -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/subscription/azure-mgmt-subscription -``` -``` yaml $(python) && $(python-mode) == 'update' && $(track2) + +``` yaml $(python) && $(python-mode) == 'update' no-namespace-folders: true output-folder: $(python-sdks-folder)/subscription/azure-mgmt-subscription/azure/mgmt/subscription ``` -``` yaml $(python) && $(python-mode) == 'create' && $(track2) +``` yaml $(python) && $(python-mode) == 'create' basic-setup-py: true output-folder: $(python-sdks-folder)/subscription/azure-mgmt-subscription ``` diff --git a/specification/support/resource-manager/Microsoft.Support/preview/2021-06-01-preview/examples/ListOperations.json b/specification/support/resource-manager/Microsoft.Support/preview/2021-06-01-preview/examples/ListOperations.json new file mode 100644 index 000000000000..62329b889684 --- /dev/null +++ b/specification/support/resource-manager/Microsoft.Support/preview/2021-06-01-preview/examples/ListOperations.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Support/register/action", + "display": { + "description": "Registers Support Resource Provider", + "operation": "Registers Support Resource Provider", + "provider": "Registers Support Resource Provider", + "resource": "Support Registration" + } + } + ] + } + } + } +} diff --git a/specification/support/resource-manager/Microsoft.Support/preview/2021-06-01-preview/examples/LookUpResourceId.json b/specification/support/resource-manager/Microsoft.Support/preview/2021-06-01-preview/examples/LookUpResourceId.json new file mode 100644 index 000000000000..98f733ad69f9 --- /dev/null +++ b/specification/support/resource-manager/Microsoft.Support/preview/2021-06-01-preview/examples/LookUpResourceId.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview", + "lookUpResourceIdRequest": { + "type": "Microsoft.Support/supportTickets", + "identifier": "1234668596" + } + }, + "responses": { + "200": { + "body": { + "resourceId": "/subscriptions/subId/providers/Microsoft.Support/supportTickets/SupportTicketName" + } + } + } +} diff --git a/specification/support/resource-manager/Microsoft.Support/preview/2021-06-01-preview/supportResourceIdDetails.json b/specification/support/resource-manager/Microsoft.Support/preview/2021-06-01-preview/supportResourceIdDetails.json new file mode 100644 index 000000000000..22a96fe03888 --- /dev/null +++ b/specification/support/resource-manager/Microsoft.Support/preview/2021-06-01-preview/supportResourceIdDetails.json @@ -0,0 +1,270 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01-preview", + "title": "Microsoft.Support", + "description": "Microsoft Azure Support Resource Provider." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "paths": { + "/providers/Microsoft.Support/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "This lists all the available Microsoft Support REST API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved list of operations.", + "schema": { + "$ref": "#/definitions/OperationsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ExceptionResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Get all operations": { + "$ref": "./examples/ListOperations.json" + } + } + } + }, + "/providers/Microsoft.Support/lookUpResourceId": { + "post": { + "tags": [ + "SupportTickets" + ], + "summary": "This operation fetches ARM resource id of support resource type.", + "operationId": "LookUpResourceId_Post", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "lookUpResourceIdRequest", + "in": "body", + "description": "Look up resource id request body", + "required": true, + "schema": { + "$ref": "#/definitions/LookUpResourceIdRequest" + } + } + ], + "responses": { + "200": { + "description": "OK. Successfully obtained resource id of support resource type.", + "schema": { + "$ref": "#/definitions/LookUpResourceIdResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ExceptionResponse" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Look up resource id of support resource type": { + "$ref": "./examples/LookUpResourceId.json" + } + } + } + } + }, + "definitions": { + "OperationsListResult": { + "description": "The list of operations supported by Microsoft Support resource provider.", + "properties": { + "value": { + "description": "The list of operations supported by Microsoft Support resource provider.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + } + } + }, + "Operation": { + "description": "The operation supported by Microsoft Support resource provider.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string", + "readOnly": true + }, + "display": { + "description": "The object that describes the operation.", + "properties": { + "description": { + "description": "The description of the operation.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "The action that users can perform, based on their permission level.", + "type": "string", + "readOnly": true + }, + "provider": { + "description": "Service provider: Microsoft Support.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string", + "readOnly": true + } + } + } + } + }, + "LookUpResourceIdRequest": { + "description": "The look up resource Id request body", + "type": "object", + "properties": { + "identifier": { + "description": "The System generated Id that is unique. Use supportTicketId property for Microsoft.Support/supportTickets resource type.", + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Support/supportTickets" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": false + }, + "description": "The type of resource." + } + } + }, + "LookUpResourceIdResponse": { + "description": "The look up resource id response", + "type": "object", + "properties": { + "resourceId": { + "description": "The resource Id of support resource type.", + "type": "string" + } + } + }, + "ExceptionResponse": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ServiceError", + "description": "The API error details." + } + }, + "description": "The API error." + }, + "ServiceError": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceErrorDetail" + }, + "description": "The list of error details.", + "readOnly": true + } + }, + "description": "The API error details." + }, + "ServiceErrorDetail": { + "type": "object", + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "The error code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The error message." + }, + "target": { + "type": "string", + "description": "The target of the error." + } + }, + "description": "The error details." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Azure subscription Id." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "API version." + } + } +} diff --git a/specification/support/resource-manager/readme.md b/specification/support/resource-manager/readme.md index f77e357adc7f..371b24a74999 100644 --- a/specification/support/resource-manager/readme.md +++ b/specification/support/resource-manager/readme.md @@ -1,12 +1,13 @@ # Support - + > see https://aka.ms/autorest This is the AutoRest configuration file for Support. - --- -## Getting Started + +## Getting Started + To build the SDK for Support, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: > `autorest` @@ -14,12 +15,13 @@ To build the SDK for Support, simply [Install AutoRest](https://aka.ms/autorest/ To see additional help and options, run: > `autorest --help` + --- ## Configuration +### Basic Information -### Basic Information These are the global settings for the Support API. ``` yaml @@ -27,11 +29,20 @@ openapi-type: arm tag: package-2020-04 ``` + +### Tag: package-preview-2021-06 + +These settings apply only when `--tag=package-preview-2021-06` is specified on the command line. + +```yaml $(tag) == 'package-preview-2021-06' +input-file: + - Microsoft.Support/preview/2021-06-01-preview/supportResourceIdDetails.json +``` ### Tag: package-2020-04 These settings apply only when `--tag=package-2020-04` is specified on the command line. -```yaml $(tag) == 'package-2020-04' +``` yaml $(tag) == 'package-2020-04' input-file: - Microsoft.Support/stable/2020-04-01/support.json ``` @@ -46,8 +57,8 @@ input-file: ``` --- -# Code Generation +# Code Generation ## Swagger to SDK @@ -56,7 +67,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-js @@ -68,7 +78,7 @@ swagger-to-sdk: - repo: azure-resource-manager-schemas ``` -## C# +## C# See configuration in [readme.csharp.md](./readme.csharp.md) @@ -91,6 +101,3 @@ See configuration in [readme.typescript.md](./readme.typescript.md) ## Ruby See configuration in [readme.ruby.md](./readme.ruby.md) - - - diff --git a/specification/support/resource-manager/readme.python.md b/specification/support/resource-manager/readme.python.md index 1dfaa6930a39..1974be4e363c 100644 --- a/specification/support/resource-manager/readme.python.md +++ b/specification/support/resource-manager/readme.python.md @@ -4,36 +4,15 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.support - package-name: azure-mgmt-support - package-version: 2.0.0 - clear-output-folder: true -``` ``` yaml $(python) && $(track2) -python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.support package-name: azure-mgmt-support -package-version: 2.0.0 +package-version: 1.0.0b1 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/support/azure-mgmt-support/azure/mgmt/support -``` -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/support/azure-mgmt-support -``` + ``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/support/azure-mgmt-support/azure/mgmt/support diff --git a/specification/synapse/common/v1/types.json b/specification/synapse/common/v1/types.json index fd2acd86d045..7dc6ee3062dd 100644 --- a/specification/synapse/common/v1/types.json +++ b/specification/synapse/common/v1/types.json @@ -57,23 +57,6 @@ } ] }, - "Sku": { - "description": "An ARM Resource SKU.", - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "description": "The name of the SKU, typically, a letter + Number code, e.g. P3.", - "type": "string" - }, - "tier": { - "description": "The tier or edition of the particular SKU, e.g. Basic, Premium.", - "type": "string" - } - } - }, "SystemData": { "description": "ARM System Data.", "type": "object", diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Dataset.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Dataset.json index 20d608963f69..b5c0b351bead 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Dataset.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Dataset.json @@ -716,16 +716,16 @@ }, "ParquetCompressionCodecEnum": { "type": "string", - "enum": [ - "none", - "gzip", - "snappy", - "lzo" - ], - "x-ms-enum": { - "name": "ParquetCompressionCodecEnum", - "modelAsString": true - } + "enum": [ + "none", + "gzip", + "snappy", + "lzo" + ], + "x-ms-enum": { + "name": "ParquetCompressionCodecEnum", + "modelAsString": true + } }, "DelimitedTextDataset": { "x-ms-discriminator-value": "DelimitedText", diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Pipeline.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Pipeline.json index 683024f3a8f6..e781ade499da 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Pipeline.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Pipeline.json @@ -7173,6 +7173,14 @@ "sparkJob": { "description": "Synapse spark job reference.", "$ref": "../artifacts.json#/definitions/SynapseSparkJobReference" + }, + "args": { + "x-ms-client-name": "arguments", + "description": "User specified arguments to SynapseSparkJobDefinitionActivity.", + "type": "array", + "items": { + "description": "Type: string (or Expression with resultType string)." + } } }, "required": [ diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/gitintegration.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/gitintegration.json index 010f6e11d9f2..1cdfab165519 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/gitintegration.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/gitintegration.json @@ -71,6 +71,20 @@ } }, "definitions": { + "GitHubClientSecret": { + "description": "Client secret information for factory's bring your own app repository configuration", + "type": "object", + "properties": { + "byoaSecretAkvUrl": { + "description": "Bring your own app client secret AKV URL", + "type": "string" + }, + "byoaSecretName": { + "description": "Bring your own app client secret name in AKV", + "type": "string" + } + } + }, "GitHubAccessTokenRequest": { "type": "object", "properties": { @@ -78,6 +92,10 @@ "description": "The GitHub Client Id.", "type": "string" }, + "gitHubClientSecret": { + "$ref": "#/definitions/GitHubClientSecret", + "description": "GitHub bring your own app client secret information." + }, "gitHubAccessCode": { "description": "The GitHub Access code.", "type": "string" diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/artifacts.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/artifacts.json new file mode 100644 index 000000000000..9ed4fe5f65b0 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/artifacts.json @@ -0,0 +1,5064 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01-preview", + "title": "ArtifactsClient", + "x-ms-code-generation-settings": { + "useDateTimeOffset": true + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/linkedservices": { + "get": { + "tags": [ + "linkedServices" + ], + "operationId": "LinkedService_GetLinkedServicesByWorkspace", + "x-ms-examples": { + "LinkedServices_ListByWorkspace": { + "$ref": "./examples/LinkedServices_ListByWorkspace.json" + } + }, + "description": "Lists linked services.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/LinkedServiceListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/linkedservices/{linkedServiceName}": { + "put": { + "tags": [ + "linkedServices" + ], + "operationId": "LinkedService_CreateOrUpdateLinkedService", + "x-ms-examples": { + "LinkedServices_Create": { + "$ref": "./examples/LinkedServices_Create.json" + }, + "LinkedServices_Update": { + "$ref": "./examples/LinkedServices_Update.json" + } + }, + "description": "Creates or updates a linked service.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/linkedServiceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the linkedService entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." + }, + { + "name": "linkedService", + "description": "Linked service resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LinkedServiceResource" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/LinkedServiceResource" + } + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "linkedServices" + ], + "operationId": "LinkedService_GetLinkedService", + "x-ms-examples": { + "LinkedServices_Get": { + "$ref": "./examples/LinkedServices_Get.json" + } + }, + "description": "Gets a linked service.", + "parameters": [ + { + "$ref": "#/parameters/linkedServiceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the linked service entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/LinkedServiceResource" + } + }, + "304": { + "description": "Not modified." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "linkedServices" + ], + "operationId": "LinkedService_DeleteLinkedService", + "x-ms-examples": { + "LinkedServices_Delete": { + "$ref": "./examples/LinkedServices_Delete.json" + } + }, + "description": "Deletes a linked service.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/linkedServiceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/linkedservices/{linkedServiceName}/rename": { + "post": { + "tags": [ + "linkedServices" + ], + "operationId": "LinkedService_RenameLinkedService", + "x-ms-examples": { + "LinkedServices_Rename": { + "$ref": "./examples/LinkedServices_Rename.json" + } + }, + "description": "Renames a linked service.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/linkedServiceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "request", + "description": "proposed new name.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArtifactRenameRequest" + } + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/datasets": { + "get": { + "tags": [ + "datasets" + ], + "operationId": "Dataset_GetDatasetsByWorkspace", + "x-ms-examples": { + "Datasets_ListByWorkspace": { + "$ref": "./examples/Datasets_ListByWorkspace.json" + } + }, + "description": "Lists datasets.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/DatasetListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/datasets/{datasetName}": { + "put": { + "tags": [ + "datasets" + ], + "operationId": "Dataset_CreateOrUpdateDataset", + "x-ms-examples": { + "Datasets_Create": { + "$ref": "./examples/Datasets_Create.json" + }, + "Datasets_Update": { + "$ref": "./examples/Datasets_Update.json" + } + }, + "description": "Creates or updates a dataset.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/datasetName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the dataset entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." + }, + { + "name": "dataset", + "description": "Dataset resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DatasetResource" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/DatasetResource" + } + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "datasets" + ], + "operationId": "Dataset_GetDataset", + "x-ms-examples": { + "Datasets_Get": { + "$ref": "./examples/Datasets_Get.json" + } + }, + "description": "Gets a dataset.", + "parameters": [ + { + "$ref": "#/parameters/datasetName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the dataset entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/DatasetResource" + } + }, + "304": { + "description": "Not modified." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "datasets" + ], + "operationId": "Dataset_DeleteDataset", + "x-ms-examples": { + "Datasets_Delete": { + "$ref": "./examples/Datasets_Delete.json" + } + }, + "description": "Deletes a dataset.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/datasetName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/datasets/{datasetName}/rename": { + "post": { + "tags": [ + "datasets" + ], + "operationId": "Dataset_RenameDataset", + "x-ms-examples": { + "Datasets_Rename": { + "$ref": "./examples/Datasets_Rename.json" + } + }, + "description": "Renames a dataset.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/datasetName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "request", + "description": "proposed new name.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArtifactRenameRequest" + } + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/pipelines": { + "get": { + "tags": [ + "pipelines" + ], + "operationId": "Pipeline_GetPipelinesByWorkspace", + "x-ms-examples": { + "Pipelines_ListByWorkspace": { + "$ref": "./examples/Pipelines_ListByWorkspace.json" + } + }, + "description": "Lists pipelines.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/PipelineListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/pipelines/{pipelineName}": { + "put": { + "tags": [ + "pipelines" + ], + "operationId": "Pipeline_CreateOrUpdatePipeline", + "x-ms-examples": { + "Pipelines_Create": { + "$ref": "./examples/Pipelines_Create.json" + }, + "Pipelines_Update": { + "$ref": "./examples/Pipelines_Update.json" + } + }, + "description": "Creates or updates a pipeline.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/pipelineName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the pipeline entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." + }, + { + "name": "pipeline", + "description": "Pipeline resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PipelineResource" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/PipelineResource" + } + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "pipelines" + ], + "operationId": "Pipeline_GetPipeline", + "x-ms-examples": { + "Pipelines_Get": { + "$ref": "./examples/Pipelines_Get.json" + } + }, + "description": "Gets a pipeline.", + "parameters": [ + { + "$ref": "#/parameters/pipelineName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the pipeline entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/PipelineResource" + } + }, + "304": { + "description": "Not modified." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "pipelines" + ], + "operationId": "Pipeline_DeletePipeline", + "x-ms-examples": { + "Pipelines_Delete": { + "$ref": "./examples/Pipelines_Delete.json" + } + }, + "description": "Deletes a pipeline.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/pipelineName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/pipelines/{pipelineName}/rename": { + "post": { + "tags": [ + "pipelines" + ], + "operationId": "Pipeline_RenamePipeline", + "x-ms-examples": { + "Pipelines_Rename": { + "$ref": "./examples/Pipelines_Rename.json" + } + }, + "description": "Renames a pipeline.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/pipelineName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "request", + "description": "proposed new name.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArtifactRenameRequest" + } + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/pipelines/{pipelineName}/createRun": { + "post": { + "tags": [ + "pipelines" + ], + "operationId": "Pipeline_CreatePipelineRun", + "x-ms-examples": { + "Pipelines_CreateRun": { + "$ref": "./examples/Pipelines_CreateRun.json" + } + }, + "description": "Creates a run of a pipeline.", + "parameters": [ + { + "$ref": "#/parameters/pipelineName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "referencePipelineRunId", + "description": "The pipeline run identifier. If run ID is specified the parameters of the specified run will be used to create a new run.", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "isRecovery", + "description": "Recovery mode flag. If recovery mode is set to true, the specified referenced pipeline run and the new run will be grouped under the same groupId.", + "in": "query", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method" + }, + { + "name": "startActivityName", + "description": "In recovery mode, the rerun will start from this activity. If not specified, all activities will run.", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "parameters", + "description": "Parameters of the pipeline run. These parameters will be used only if the runId is not specified.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ParameterValueSpecification" + } + } + ], + "responses": { + "202": { + "description": "Accepted.", + "schema": { + "$ref": "#/definitions/CreateRunResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/queryPipelineRuns": { + "post": { + "operationId": "PipelineRun_QueryPipelineRunsByWorkspace", + "x-ms-examples": { + "PipelineRuns_QueryByWorkspace": { + "$ref": "./examples/PipelineRuns_QueryByWorkspace.json" + } + }, + "description": "Query pipeline runs in the workspace based on input filter conditions.", + "tags": [ + "pipelineruns" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "filterParameters", + "description": "Parameters to filter the pipeline run.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunFilterParameters" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/PipelineRunsQueryResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/pipelineruns/{runId}": { + "get": { + "operationId": "PipelineRun_GetPipelineRun", + "x-ms-examples": { + "PipelineRuns_Get": { + "$ref": "./examples/PipelineRuns_Get.json" + } + }, + "description": "Get a pipeline run by its run ID.", + "tags": [ + "pipelineruns" + ], + "parameters": [ + { + "$ref": "#/parameters/runId" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/PipelineRun" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/pipelines/{pipelineName}/pipelineruns/{runId}/queryActivityruns": { + "post": { + "operationId": "PipelineRun_QueryActivityRuns", + "x-ms-examples": { + "ActivityRuns_QueryByPipelineRun": { + "$ref": "./examples/ActivityRuns_QueryByPipelineRun.json" + } + }, + "description": "Query activity runs based on input filter conditions.", + "tags": [ + "activityruns" + ], + "parameters": [ + { + "$ref": "#/parameters/pipelineName" + }, + { + "$ref": "#/parameters/runId" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "filterParameters", + "description": "Parameters to filter the activity runs.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunFilterParameters" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/ActivityRunsQueryResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/pipelineruns/{runId}/cancel": { + "post": { + "operationId": "PipelineRun_CancelPipelineRun", + "x-ms-examples": { + "PipelineRuns_Cancel": { + "$ref": "./examples/PipelineRuns_Cancel.json" + } + }, + "description": "Cancel a pipeline run by its run ID.", + "tags": [ + "pipelineruns" + ], + "parameters": [ + { + "$ref": "#/parameters/runId" + }, + { + "name": "isRecursive", + "description": "If true, cancel all the Child pipelines that are triggered by the current pipeline.", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Pipeline run has been canceled successfully. " + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/triggers": { + "get": { + "tags": [ + "triggers" + ], + "operationId": "Trigger_GetTriggersByWorkspace", + "x-ms-examples": { + "Triggers_ListByWorkspace": { + "$ref": "./examples/Triggers_ListByWorkspace.json" + } + }, + "description": "Lists triggers.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/TriggerListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/triggers/{triggerName}": { + "put": { + "tags": [ + "triggers" + ], + "operationId": "Trigger_CreateOrUpdateTrigger", + "x-ms-examples": { + "Triggers_Create": { + "$ref": "./examples/Triggers_Create.json" + }, + "Triggers_Update": { + "$ref": "./examples/Triggers_Update.json" + } + }, + "description": "Creates or updates a trigger.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the trigger entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." + }, + { + "name": "trigger", + "description": "Trigger resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TriggerResource" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/TriggerResource" + } + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "trigger" + ], + "operationId": "Trigger_GetTrigger", + "x-ms-examples": { + "Triggers_Get": { + "$ref": "./examples/Triggers_Get.json" + } + }, + "description": "Gets a trigger.", + "parameters": [ + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the trigger entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/TriggerResource" + } + }, + "304": { + "description": "Not modified." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "triggers" + ], + "operationId": "Trigger_DeleteTrigger", + "x-ms-examples": { + "Triggers_Delete": { + "$ref": "./examples/Triggers_Delete.json" + } + }, + "description": "Deletes a trigger.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/triggers/{triggerName}/subscribeToEvents": { + "post": { + "tags": [ + "triggers" + ], + "operationId": "Trigger_SubscribeTriggerToEvents", + "x-ms-examples": { + "Triggers_SubscribeToEvents": { + "$ref": "./examples/Triggers_SubscribeToEvents.json" + } + }, + "description": "Subscribe event trigger to events.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Trigger is subscribed to events.", + "schema": { + "$ref": "#/definitions/TriggerSubscriptionOperationStatus" + } + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/triggers/{triggerName}/getEventSubscriptionStatus": { + "post": { + "tags": [ + "triggers" + ], + "operationId": "Trigger_GetEventSubscriptionStatus", + "x-ms-examples": { + "Triggers_GetEventSubscriptionStatus": { + "$ref": "./examples/Triggers_GetEventSubscriptionStatus.json" + } + }, + "description": "Get a trigger's event subscription status.", + "parameters": [ + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Trigger event subscription state.", + "schema": { + "$ref": "#/definitions/TriggerSubscriptionOperationStatus" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/triggers/{triggerName}/unsubscribeFromEvents": { + "post": { + "tags": [ + "triggers" + ], + "operationId": "Trigger_UnsubscribeTriggerFromEvents", + "x-ms-examples": { + "Triggers_UnsubscribeFromEvents": { + "$ref": "./examples/Triggers_UnsubscribeFromEvents.json" + } + }, + "description": "Unsubscribe event trigger from events.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Trigger is unsubscribed from events.", + "schema": { + "$ref": "#/definitions/TriggerSubscriptionOperationStatus" + } + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/triggers/{triggerName}/start": { + "post": { + "tags": [ + "triggers" + ], + "operationId": "Trigger_StartTrigger", + "x-ms-examples": { + "Triggers_Start": { + "$ref": "./examples/Triggers_Start.json" + } + }, + "description": "Starts a trigger.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Trigger has been started successfully." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/triggers/{triggerName}/stop": { + "post": { + "tags": [ + "triggers" + ], + "operationId": "Trigger_StopTrigger", + "x-ms-examples": { + "Triggers_Stop": { + "$ref": "./examples/Triggers_Stop.json" + } + }, + "description": "Stops a trigger.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Trigger has been stopped successfully." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/triggers/{triggerName}/triggerRuns/{runId}/rerun": { + "post": { + "tags": [ + "triggerruns" + ], + "operationId": "TriggerRun_RerunTriggerInstance", + "x-ms-examples": { + "Triggers_Rerun": { + "$ref": "./examples/TriggerRuns_Rerun.json" + } + }, + "description": "Rerun single trigger instance by runId.", + "parameters": [ + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/runId" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "TriggerRun has been restarted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/triggers/{triggerName}/triggerRuns/{runId}/cancel": { + "post": { + "tags": [ + "triggerruns" + ], + "operationId": "TriggerRun_CancelTriggerInstance", + "x-ms-examples": { + "Triggers_Rerun": { + "$ref": "./examples/TriggerRuns_Cancel.json" + } + }, + "description": "Cancel single trigger instance by runId.", + "parameters": [ + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/runId" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "TriggerRun has been cancelled." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/queryTriggerRuns": { + "post": { + "tags": [ + "triggerruns" + ], + "operationId": "TriggerRun_QueryTriggerRunsByWorkspace", + "x-ms-examples": { + "TriggerRuns_QueryByWorkspace": { + "$ref": "./examples/TriggerRuns_QueryByWorkspace.json" + } + }, + "description": "Query trigger runs.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "filterParameters", + "description": "Parameters to filter the pipeline run.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunFilterParameters" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/TriggerRunsQueryResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/dataflows/{dataFlowName}": { + "put": { + "tags": [ + "dataFlows" + ], + "operationId": "DataFlow_CreateOrUpdateDataFlow", + "x-ms-examples": { + "DataFlows_Create": { + "$ref": "./examples/DataFlows_Create.json" + }, + "DataFlows_Update": { + "$ref": "./examples/DataFlows_Update.json" + } + }, + "description": "Creates or updates a data flow.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/dataFlowName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the data flow entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." + }, + { + "name": "dataFlow", + "description": "Data flow resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataFlowResource" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/DataFlowResource" + } + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "dataFlows" + ], + "operationId": "DataFlow_GetDataFlow", + "x-ms-examples": { + "DataFlows_Get": { + "$ref": "./examples/DataFlows_Get.json" + } + }, + "description": "Gets a data flow.", + "parameters": [ + { + "$ref": "#/parameters/dataFlowName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the data flow entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/DataFlowResource" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "dataFlows" + ], + "operationId": "DataFlow_DeleteDataFlow", + "x-ms-examples": { + "DataFlows_Delete": { + "$ref": "./examples/DataFlows_Delete.json" + } + }, + "description": "Deletes a data flow.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/dataFlowName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/dataflows/{dataFlowName}/rename": { + "post": { + "tags": [ + "dataflows" + ], + "operationId": "DataFlow_RenameDataFlow", + "x-ms-examples": { + "DataFlows_Rename": { + "$ref": "./examples/DataFlows_Rename.json" + } + }, + "description": "Renames a dataflow.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/dataFlowName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "request", + "description": "proposed new name.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArtifactRenameRequest" + } + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/dataflows": { + "get": { + "tags": [ + "dataFlows" + ], + "operationId": "DataFlow_GetDataFlowsByWorkspace", + "x-ms-examples": { + "DataFlows_ListByWorkspace": { + "$ref": "./examples/DataFlows_ListByWorkspace.json" + } + }, + "description": "Lists data flows.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/DataFlowListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/createDataFlowDebugSession": { + "post": { + "tags": [ + "dataFlowDebugSession" + ], + "operationId": "DataFlowDebugSession_CreateDataFlowDebugSession", + "x-ms-examples": { + "DataFlowDebugSession_Create": { + "$ref": "./examples/DataFlowDebugSession_Create.json" + } + }, + "description": "Creates a data flow debug session.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "request", + "description": "Data flow debug session definition", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CreateDataFlowDebugSessionRequest" + } + } + ], + "responses": { + "202": { + "description": "Accepted.", + "headers": { + "location": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/CreateDataFlowDebugSessionResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/queryDataFlowDebugSessions": { + "post": { + "tags": [ + "dataFlowDebugSession" + ], + "operationId": "DataFlowDebugSession_QueryDataFlowDebugSessionsByWorkspace", + "x-ms-examples": { + "DataFlowDebugSession_QueryByWorkspace": { + "$ref": "./examples/DataFlowDebugSession_QueryByWorkspace.json" + } + }, + "description": "Query all active data flow debug sessions.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/QueryDataFlowDebugSessionsResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/addDataFlowToDebugSession": { + "post": { + "tags": [ + "dataFlowDebugSession" + ], + "operationId": "DataFlowDebugSession_AddDataFlow", + "x-ms-examples": { + "DataFlowDebugSession_AddDataFlow": { + "$ref": "./examples/DataFlowDebugSession_AddDataFlow.json" + } + }, + "description": "Add a data flow into debug session.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "request", + "description": "Data flow debug session definition with debug content.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataFlowDebugPackage" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/AddDataFlowToDebugSessionResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/deleteDataFlowDebugSession": { + "post": { + "tags": [ + "dataFlowDebugSession" + ], + "operationId": "DataFlowDebugSession_DeleteDataFlowDebugSession", + "x-ms-examples": { + "DataFlowDebugSession_Delete": { + "$ref": "./examples/DataFlowDebugSession_Delete.json" + } + }, + "description": "Deletes a data flow debug session.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "request", + "description": "Data flow debug session definition for deletion", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DeleteDataFlowDebugSessionRequest" + } + } + ], + "responses": { + "200": { + "description": "OK." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/executeDataFlowDebugCommand": { + "post": { + "tags": [ + "dataFlowDebugSession" + ], + "operationId": "DataFlowDebugSession_ExecuteCommand", + "x-ms-examples": { + "DataFlowDebugSession_ExecuteCommand": { + "$ref": "./examples/DataFlowDebugSession_ExecuteCommand.json" + } + }, + "description": "Execute a data flow debug command.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "request", + "description": "Data flow debug command definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataFlowDebugCommandRequest" + } + } + ], + "responses": { + "202": { + "description": "Accepted.", + "headers": { + "location": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/DataFlowDebugCommandResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/sqlScripts": { + "get": { + "tags": [ + "sqlScripts" + ], + "operationId": "SqlScript_GetSqlScriptsByWorkspace", + "x-ms-examples": { + "SqlScripts_ListByWorkspace": { + "$ref": "./examples/SqlScripts_ListByWorkspace.json" + } + }, + "description": "Lists sql scripts.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SqlScriptsListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/sqlScripts/{sqlScriptName}": { + "put": { + "tags": [ + "sqlScripts" + ], + "operationId": "SqlScript_CreateOrUpdateSqlScript", + "x-ms-examples": { + "SqlScripts_Create": { + "$ref": "./examples/SqlScripts_Create.json" + }, + "SqlScripts_Update": { + "$ref": "./examples/SqlScripts_Update.json" + } + }, + "description": "Creates or updates a Sql Script.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/sqlScriptName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the SQL script entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." + }, + { + "name": "sqlScript", + "description": "Sql Script resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SqlScriptResource" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SqlScriptResource" + } + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "sqlScripts" + ], + "operationId": "SqlScript_GetSqlScript", + "x-ms-examples": { + "SqlScripts_Get": { + "$ref": "./examples/SqlScripts_Get.json" + } + }, + "description": "Gets a sql script.", + "parameters": [ + { + "$ref": "#/parameters/sqlScriptName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the sql compute entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SqlScriptResource" + } + }, + "304": { + "description": "Not modified." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "sqlScripts" + ], + "operationId": "SqlScript_DeleteSqlScript", + "x-ms-examples": { + "SqlScripts_Delete": { + "$ref": "./examples/SqlScripts_Delete.json" + } + }, + "description": "Deletes a Sql Script.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/sqlScriptName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/sqlScripts/{sqlScriptName}/rename": { + "post": { + "tags": [ + "sqlScripts" + ], + "operationId": "SqlScript_RenameSqlScript", + "x-ms-examples": { + "SqlScripts_Rename": { + "$ref": "./examples/SqlScripts_Rename.json" + } + }, + "description": "Renames a sqlScript.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/sqlScriptName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "request", + "description": "proposed new name.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArtifactRenameRequest" + } + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/sparkJobDefinitions": { + "get": { + "tags": [ + "sparkJobDefinitions" + ], + "operationId": "SparkJobDefinition_GetSparkJobDefinitionsByWorkspace", + "x-ms-examples": { + "SparkJobDefinitions_ListByWorkspace": { + "$ref": "./examples/SparkJobDefinitions_ListByWorkspace.json" + } + }, + "description": "Lists spark job definitions.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SparkJobDefinitionsListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/sparkJobDefinitions/{sparkJobDefinitionName}": { + "put": { + "tags": [ + "sparkJobDefinitions" + ], + "operationId": "SparkJobDefinition_CreateOrUpdateSparkJobDefinition", + "x-ms-examples": { + "SparkJobDefinitions_Create": { + "$ref": "./examples/SparkJobDefinitions_Create.json" + }, + "SparkJobDefinitions_Update": { + "$ref": "./examples/SparkJobDefinitions_Update.json" + } + }, + "description": "Creates or updates a Spark Job Definition.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/sparkJobDefinitionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the Spark Job Definition entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." + }, + { + "name": "sparkJobDefinition", + "description": "Spark Job Definition resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SparkJobDefinitionResource" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SparkJobDefinitionResource" + } + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "sparkJobDefinitions" + ], + "operationId": "SparkJobDefinition_GetSparkJobDefinition", + "x-ms-examples": { + "SparkJobDefinitions_Get": { + "$ref": "./examples/SparkJobDefinitions_Get.json" + } + }, + "description": "Gets a Spark Job Definition.", + "parameters": [ + { + "$ref": "#/parameters/sparkJobDefinitionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the Spark Job Definition entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SparkJobDefinitionResource" + } + }, + "304": { + "description": "Not modified." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "sparkJobDefinitions" + ], + "operationId": "SparkJobDefinition_DeleteSparkJobDefinition", + "x-ms-examples": { + "SparkJobDefinitions_Delete": { + "$ref": "./examples/SparkJobDefinitions_Delete.json" + } + }, + "description": "Deletes a Spark Job Definition.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/sparkJobDefinitionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/sparkJobDefinitions/{sparkJobDefinitionName}/execute": { + "post": { + "tags": [ + "sparkJobDefinitions" + ], + "operationId": "SparkJobDefinition_ExecuteSparkJobDefinition", + "x-ms-examples": { + "SparkJobDefinitions_Execute": { + "$ref": "./examples/SparkJobDefinitions_Execute.json" + } + }, + "description": "Executes the spark job definition.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "#/parameters/sparkJobDefinitionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted.", + "schema": { + "$ref": "../2019-11-01-preview/sparkJob.json#/definitions/SparkBatchJob" + } + }, + "200": { + "description": "OK.", + "schema": { + "$ref": "../2019-11-01-preview/sparkJob.json#/definitions/SparkBatchJob" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/sparkJobDefinitions/{sparkJobDefinitionName}/rename": { + "post": { + "tags": [ + "sparkJobDefinitions" + ], + "operationId": "SparkJobDefinition_RenameSparkJobDefinition", + "x-ms-examples": { + "SparkJobDefinitions_Rename": { + "$ref": "./examples/SparkJobDefinitions_Rename.json" + } + }, + "description": "Renames a sparkJobDefinition.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/sparkJobDefinitionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "request", + "description": "proposed new name.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArtifactRenameRequest" + } + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/debugSparkJobDefinition": { + "post": { + "tags": [ + "sparkJobDefinitions" + ], + "operationId": "SparkJobDefinition_DebugSparkJobDefinition", + "x-ms-examples": { + "SparkJobDefinitions_Debug": { + "$ref": "./examples/SparkJobDefinitions_Debug.json" + } + }, + "description": "Debug the spark job definition.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "sparkJobDefinitionAzureResource", + "description": "Spark Job Definition resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SparkJobDefinitionResource" + } + } + ], + "responses": { + "202": { + "description": "Accepted.", + "schema": { + "$ref": "../2019-11-01-preview/sparkJob.json#/definitions/SparkBatchJob" + } + }, + "200": { + "description": "OK.", + "schema": { + "$ref": "../2019-11-01-preview/sparkJob.json#/definitions/SparkBatchJob" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/notebooks": { + "get": { + "tags": [ + "notebooks" + ], + "operationId": "Notebook_GetNotebooksByWorkspace", + "x-ms-examples": { + "Notebooks_ListByWorkspace": { + "$ref": "./examples/Notebooks_ListByWorkspace.json" + } + }, + "description": "Lists Notebooks.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/NotebookListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/notebooksSummary": { + "get": { + "tags": [ + "notebooks" + ], + "operationId": "Notebook_GetNotebookSummaryByWorkSpace", + "x-ms-examples": { + "Notebooks_ListSummaryByWorkSpace": { + "$ref": "./examples/Notebooks_ListSummaryByWorkSpace.json" + } + }, + "description": "Lists a summary of Notebooks.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/NotebookListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/notebooks/{notebookName}": { + "put": { + "tags": [ + "notebooks" + ], + "operationId": "Notebook_CreateOrUpdateNotebook", + "x-ms-examples": { + "Notebooks_Create": { + "$ref": "./examples/Notebooks_Create.json" + }, + "Notebooks_Update": { + "$ref": "./examples/Notebooks_Update.json" + } + }, + "description": "Creates or updates a Note Book.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/NotebookName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the Note book entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." + }, + { + "name": "Notebook", + "description": "Note book resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NotebookResource" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/NotebookResource" + } + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "notebooks" + ], + "operationId": "Notebook_GetNotebook", + "x-ms-examples": { + "Notebooks_Get": { + "$ref": "./examples/Notebooks_Get.json" + } + }, + "description": "Gets a Note Book.", + "parameters": [ + { + "$ref": "#/parameters/NotebookName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the Notebook entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/NotebookResource" + } + }, + "304": { + "description": "Not modified." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "notebooks" + ], + "operationId": "Notebook_DeleteNotebook", + "x-ms-examples": { + "Notebooks_Delete": { + "$ref": "./examples/Notebooks_Delete.json" + } + }, + "description": "Deletes a Note book.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/NotebookName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/notebooks/{notebookName}/rename": { + "post": { + "tags": [ + "notebooks" + ], + "operationId": "Notebook_RenameNotebook", + "x-ms-examples": { + "Notebooks_Rename": { + "$ref": "./examples/Notebooks_Rename.json" + } + }, + "description": "Renames a notebook.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/NotebookName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "request", + "description": "proposed new name.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArtifactRenameRequest" + } + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/notebookOperationResults/{operationId}": { + "get": { + "tags": [ + "OperationResult" + ], + "operationId": "NotebookOperationResult_Get", + "description": "Get notebook operation result", + "x-ms-examples": { + "List Sql Pools": { + "$ref": "./examples/NotebookOperationResult_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "Operation ID." + } + ], + "responses": { + "200": { + "description": "" + }, + "201": { + "description": "" + }, + "202": { + "description": "" + }, + "204": { + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + }, + "description": "" + } + } + } + }, + "/sparkconfigurations": { + "get": { + "tags": [ + "sparkconfigurations" + ], + "operationId": "SparkConfiguration_GetSparkConfigurationsByWorkspace", + "x-ms-examples": { + "SparkConfigurations_ListByWorkspace": { + "$ref": "./examples/SparkConfigurations_ListByWorkspace.json" + } + }, + "description": "Lists sparkconfigurations.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SparkConfigurationListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/sparkconfigurations/{sparkConfigurationName}": { + "put": { + "tags": [ + "sparkconfigurations" + ], + "operationId": "SparkConfiguration_CreateOrUpdateSparkConfiguration", + "x-ms-examples": { + "SparkConfigurations_Create": { + "$ref": "./examples/SparkConfigurations_Create.json" + }, + "SparkConfigurations_Update": { + "$ref": "./examples/SparkConfigurations_Update.json" + } + }, + "description": "Creates or updates a sparkconfiguration.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/sparkConfigurationName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "ETag of the sparkConfiguration entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." + }, + { + "name": "sparkConfiguration", + "description": "SparkConfiguration resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SparkConfigurationResource" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SparkConfigurationResource" + } + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "sparkconfigurations" + ], + "operationId": "SparkConfiguration_GetSparkConfiguration", + "x-ms-examples": { + "SparkConfigurations_Get": { + "$ref": "./examples/SparkConfigurations_Get.json" + } + }, + "description": "Gets a sparkConfiguration.", + "parameters": [ + { + "$ref": "#/parameters/sparkConfigurationName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfNoneMatch", + "description": "ETag of the sparkConfiguration entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SparkConfigurationResource" + } + }, + "304": { + "description": "Not modified." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "sparkconfigurations" + ], + "operationId": "SparkConfiguration_DeleteSparkConfiguration", + "x-ms-examples": { + "SparkConfigurations_Delete": { + "$ref": "./examples/SparkConfigurations_Delete.json" + } + }, + "description": "Deletes a sparkConfiguration.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/sparkConfigurationName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/sparkconfigurations/{sparkConfigurationName}/rename": { + "post": { + "tags": [ + "sparkconfigurations" + ], + "operationId": "SparkConfiguration_RenameSparkConfiguration", + "x-ms-examples": { + "SparkConfigurations_Rename": { + "$ref": "./examples/SparkConfigurations_Rename.json" + } + }, + "description": "Renames a sparkConfiguration.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/sparkConfigurationName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "request", + "description": "proposed new name.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArtifactRenameRequest" + } + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "SubResource": { + "description": "Azure Synapse nested resource, which belongs to a workspace.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/AzureEntityResource" + } + ] + }, + "SubResourceDebugResource": { + "description": "Azure Synapse nested debug resource.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The resource name." + } + } + }, + "Expression": { + "description": "Azure Synapse expression definition.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Expression type.", + "enum": [ + "Expression" + ], + "x-ms-enum": { + "name": "ExpressionType", + "modelAsString": true + } + }, + "value": { + "type": "string", + "description": "Expression value." + } + }, + "required": [ + "type", + "value" + ] + }, + "SecureString": { + "x-ms-discriminator-value": "SecureString", + "description": "Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecretBase" + } + ], + "properties": { + "value": { + "type": "string", + "description": "Value of secure string." + } + }, + "required": [ + "value" + ] + }, + "AzureKeyVaultSecretReference": { + "x-ms-discriminator-value": "AzureKeyVaultSecret", + "description": "Azure Key Vault secret reference.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecretBase" + } + ], + "properties": { + "store": { + "description": "The Azure Key Vault linked service reference.", + "$ref": "#/definitions/LinkedServiceReference" + }, + "secretName": { + "type": "object", + "description": "The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string)." + }, + "secretVersion": { + "type": "object", + "description": "The version of the secret in Azure Key Vault. The default value is the latest version of the secret. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "store", + "secretName" + ] + }, + "SecretBase": { + "description": "The base definition of a secret type.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of the secret." + } + }, + "required": [ + "type" + ] + }, + "IntegrationRuntimeReference": { + "description": "Integration runtime reference type.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of integration runtime.", + "enum": [ + "IntegrationRuntimeReference" + ], + "x-ms-enum": { + "name": "IntegrationRuntimeReferenceType", + "modelAsString": true + } + }, + "referenceName": { + "type": "string", + "description": "Reference integration runtime name." + }, + "parameters": { + "$ref": "#/definitions/ParameterValueSpecification", + "description": "Arguments for integration runtime." + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "LinkedServiceListResponse": { + "description": "A list of linked service resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of linked services.", + "items": { + "$ref": "#/definitions/LinkedServiceResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "DatasetListResponse": { + "description": "A list of dataset resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of datasets.", + "items": { + "$ref": "#/definitions/DatasetResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "PipelineListResponse": { + "description": "A list of pipeline resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of pipelines.", + "items": { + "$ref": "#/definitions/PipelineResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "TriggerListResponse": { + "description": "A list of trigger resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of triggers.", + "items": { + "$ref": "#/definitions/TriggerResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "DataFlowListResponse": { + "description": "A list of data flow resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of data flows.", + "items": { + "$ref": "#/definitions/DataFlowResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "SparkConfigurationListResponse": { + "description": "A list of sparkconfiguration resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of sparkconfigurations.", + "items": { + "$ref": "#/definitions/SparkConfigurationResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "SparkConfigurationResource": { + "description": "Spark Configuration resource type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "./entityTypes/SparkConfiguration.json#/definitions/SparkConfiguration", + "description": "Properties of Spark Configuration." + } + }, + "required": [ + "properties" + ] + }, + "CreateDataFlowDebugSessionRequest": { + "description": "Request body structure for creating data flow debug session.", + "type": "object", + "properties": { + "dataFlowName": { + "description": "The name of the data flow.", + "type": "string" + }, + "existingClusterId": { + "description": "The ID of existing Databricks cluster.", + "type": "string" + }, + "clusterTimeout": { + "description": "Timeout setting for Databricks cluster.", + "type": "integer" + }, + "newClusterName": { + "description": "The name of new Databricks cluster.", + "type": "string" + }, + "newClusterNodeType": { + "description": "The type of new Databricks cluster.", + "type": "string" + }, + "dataBricksLinkedService": { + "description": "Data bricks linked service.", + "$ref": "#/definitions/LinkedServiceResource" + } + } + }, + "CreateDataFlowDebugSessionResponse": { + "description": "Response body structure for creating data flow debug session.", + "type": "object", + "properties": { + "sessionId": { + "description": "The ID of data flow debug session.", + "type": "string" + } + } + }, + "StartDataFlowDebugSessionRequest": { + "description": "Request body structure for starting data flow debug session.", + "type": "object", + "properties": { + "sessionId": { + "description": "The ID of data flow debug session.", + "type": "string" + }, + "dataFlow": { + "description": "Data flow instance.", + "$ref": "#/definitions/DataFlowResource" + }, + "datasets": { + "type": "array", + "description": "List of datasets.", + "items": { + "$ref": "#/definitions/DatasetResource" + } + }, + "linkedServices": { + "type": "array", + "description": "List of linked services.", + "items": { + "$ref": "#/definitions/LinkedServiceResource" + } + }, + "staging": { + "description": "Staging info for debug session.", + "type": "object" + }, + "debugSettings": { + "description": "Data flow debug settings.", + "type": "object" + }, + "incrementalDebug": { + "description": "The type of new Databricks cluster.", + "type": "boolean" + } + } + }, + "StartDataFlowDebugSessionResponse": { + "description": "Response body structure for starting data flow debug session.", + "type": "object", + "properties": { + "jobVersion": { + "description": "The ID of data flow debug job version.", + "type": "string" + } + } + }, + "DeleteDataFlowDebugSessionRequest": { + "description": "Request body structure for deleting data flow debug session.", + "type": "object", + "properties": { + "sessionId": { + "description": "The ID of data flow debug session.", + "type": "string" + }, + "dataFlowName": { + "description": "The data flow which contains the debug session.", + "type": "string" + } + } + }, + "DataFlowDebugPreviewDataRequest": { + "description": "Request body structure for data flow preview data.", + "type": "object", + "properties": { + "sessionId": { + "description": "The ID of data flow debug session.", + "type": "string" + }, + "dataFlowName": { + "description": "The data flow which contains the debug session.", + "type": "string" + }, + "streamName": { + "description": "The output stream name.", + "type": "string" + }, + "rowLimits": { + "description": "The row limit for preview request.", + "type": "integer" + } + } + }, + "DataFlowDebugStatisticsRequest": { + "description": "Request body structure for data flow statistics.", + "type": "object", + "properties": { + "sessionId": { + "description": "The ID of data flow debug session.", + "type": "string" + }, + "dataFlowName": { + "description": "The data flow which contains the debug session.", + "type": "string" + }, + "streamName": { + "description": "The output stream name.", + "type": "string" + }, + "columns": { + "type": "array", + "description": "List of column names.", + "items": { + "type": "string" + } + } + } + }, + "EvaluateDataFlowExpressionRequest": { + "description": "Request body structure for data flow expression preview.", + "type": "object", + "properties": { + "sessionId": { + "description": "The ID of data flow debug session.", + "type": "string" + }, + "dataFlowName": { + "description": "The data flow which contains the debug session.", + "type": "string" + }, + "streamName": { + "description": "The output stream name.", + "type": "string" + }, + "rowLimits": { + "description": "The row limit for preview request.", + "type": "integer" + }, + "expression": { + "description": "The expression for preview.", + "type": "string" + } + } + }, + "DataFlowDebugCommandRequest": { + "description": "Request body structure for data flow expression preview.", + "type": "object", + "properties": { + "sessionId": { + "description": "The ID of data flow debug session.", + "type": "string" + }, + "dataFlowName": { + "description": "The data flow which contains the debug session.", + "type": "string" + }, + "commandName": { + "description": "The command name.", + "type": "string" + }, + "commandPayload": { + "description": "The command payload object.", + "type": "object" + } + }, + "required": [ + "sessionId", + "commandPayload" + ] + }, + "DataFlowDebugQueryResponse": { + "description": "Response body structure of data flow query for data preview, statistics or expression preview.", + "type": "object", + "properties": { + "runId": { + "description": "The run ID of data flow debug session.", + "type": "string" + } + } + }, + "DataFlowDebugResultResponse": { + "description": "Response body structure of data flow result for data preview, statistics or expression preview.", + "type": "object", + "properties": { + "status": { + "description": "The run status of data preview, statistics or expression preview.", + "type": "string" + }, + "data": { + "description": "The result data of data preview, statistics or expression preview.", + "type": "string" + } + } + }, + "QueryDataFlowDebugSessionsResponse": { + "description": "A list of active debug sessions.", + "type": "object", + "properties": { + "value": { + "description": "Array with all active debug sessions.", + "type": "array", + "items": { + "$ref": "#/definitions/DataFlowDebugSessionInfo" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "DataFlowDebugSessionInfo": { + "description": "Data flow debug session info.", + "type": "object", + "properties": { + "dataFlowName": { + "description": "The name of the data flow.", + "type": "string" + }, + "computeType": { + "description": "Compute type of the cluster.", + "type": "string" + }, + "coreCount": { + "description": "Core count of the cluster.", + "type": "integer" + }, + "nodeCount": { + "description": "Node count of the cluster. (deprecated property)", + "type": "integer" + }, + "integrationRuntimeName": { + "description": "Attached integration runtime name of data flow debug session.", + "type": "string" + }, + "sessionId": { + "description": "The ID of data flow debug session.", + "type": "string" + }, + "startTime": { + "description": "Start time of data flow debug session.", + "type": "string" + }, + "timeToLiveInMinutes": { + "description": "Compute type of the cluster.", + "type": "integer" + }, + "lastActivityTime": { + "description": "Last activity time of data flow debug session.", + "type": "string" + } + }, + "additionalProperties": { + "type": "object" + } + }, + "CreateRunResponse": { + "description": "Response body with a run identifier.", + "type": "object", + "properties": { + "runId": { + "description": "Identifier of a run.", + "type": "string" + } + }, + "required": [ + "runId" + ] + }, + "CloudError": { + "x-ms-external": true, + "description": "The object that defines the structure of an Azure Synapse error response.", + "type": "object", + "properties": { + "error": { + "x-ms-client-flatten": true, + "description": "Error data", + "$ref": "#/definitions/CloudErrorBody" + } + }, + "required": [ + "error" + ] + }, + "CloudErrorBody": { + "x-ms-external": true, + "description": "The object that defines the structure of an Azure Synapse error.", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Error message.", + "type": "string" + }, + "target": { + "description": "Property name/path in request associated with error.", + "type": "string" + }, + "details": { + "description": "Array with additional error details.", + "type": "array", + "items": { + "$ref": "#/definitions/CloudError" + } + } + }, + "required": [ + "code", + "message" + ] + }, + "TriggerDependencyProvisioningStatus": { + "description": "Defines the response of a provision trigger dependency operation.", + "type": "object", + "properties": { + "triggerName": { + "description": "Trigger name.", + "type": "string" + }, + "provisioningStatus": { + "description": "Provisioning status.", + "type": "string" + } + }, + "required": [ + "triggerName", + "provisioningStatus" + ] + }, + "VariableDefinitionSpecification": { + "description": "Definition of variable for a Pipeline.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/VariableSpecification" + } + }, + "VariableSpecification": { + "description": "Definition of a single variable for a Pipeline.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Variable type.", + "enum": [ + "String", + "Bool", + "Boolean", + "Array" + ], + "x-ms-enum": { + "name": "VariableType", + "modelAsString": true + } + }, + "defaultValue": { + "type": "object", + "description": "Default value of variable." + } + }, + "required": [ + "type" + ] + }, + "ParameterDefinitionSpecification": { + "description": "Definition of all parameters for an entity.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ParameterSpecification" + } + }, + "ParameterSpecification": { + "description": "Definition of a single parameter for an entity.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Parameter type.", + "enum": [ + "Object", + "String", + "Int", + "Float", + "Bool", + "Array", + "SecureString" + ], + "x-ms-enum": { + "name": "ParameterType", + "modelAsString": true + } + }, + "defaultValue": { + "type": "object", + "description": "Default value of parameter." + } + }, + "required": [ + "type" + ] + }, + "ParameterValueSpecification": { + "description": "An object mapping parameter names to argument values.", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "PipelineResource": { + "description": "Pipeline resource type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "./entityTypes/Pipeline.json#/definitions/Pipeline", + "description": "Properties of the pipeline." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "properties" + ] + }, + "PipelineReference": { + "description": "Pipeline reference type.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Pipeline reference type.", + "enum": [ + "PipelineReference" + ], + "x-ms-enum": { + "name": "PipelineReferenceType", + "modelAsString": true + } + }, + "referenceName": { + "type": "string", + "description": "Reference pipeline name." + }, + "name": { + "type": "string", + "description": "Reference name." + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "TriggerPipelineReference": { + "description": "Pipeline that needs to be triggered with the given parameters.", + "type": "object", + "properties": { + "pipelineReference": { + "description": "Pipeline reference.", + "$ref": "#/definitions/PipelineReference" + }, + "parameters": { + "description": "Pipeline parameters.", + "$ref": "#/definitions/ParameterValueSpecification" + } + } + }, + "TriggerResource": { + "description": "Trigger resource type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "./entityTypes/Trigger.json#/definitions/Trigger", + "description": "Properties of the trigger." + } + }, + "required": [ + "properties" + ] + }, + "TriggerSubscriptionOperationStatus": { + "description": "Defines the response of a trigger subscription operation.", + "type": "object", + "properties": { + "triggerName": { + "description": "Trigger name.", + "type": "string", + "readOnly": true + }, + "status": { + "type": "string", + "enum": [ + "Enabled", + "Provisioning", + "Deprovisioning", + "Disabled", + "Unknown" + ], + "x-ms-enum": { + "name": "EventSubscriptionStatus", + "modelAsString": true + }, + "description": "Event Subscription Status.", + "readOnly": true + } + } + }, + "WorkspaceUpdateParameters": { + "description": "Parameters for updating a workspace resource.", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + }, + "identity": { + "$ref": "#/definitions/WorkspaceIdentity", + "description": "Managed service identity of the workspace." + } + } + }, + "WorkspaceIdentity": { + "description": "Identity properties of the workspace resource.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The identity type. Currently the only supported type is 'SystemAssigned'.", + "enum": [ + "SystemAssigned" + ], + "x-ms-enum": { + "name": "WorkspaceIdentityType", + "modelAsString": false + } + }, + "principalId": { + "type": "string", + "readOnly": true, + "description": "The principal id of the identity." + }, + "tenantId": { + "type": "string", + "readOnly": true, + "description": "The client tenant id of the identity." + } + }, + "required": [ + "type" + ] + }, + "DatasetReference": { + "description": "Dataset reference type.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Dataset reference type.", + "enum": [ + "DatasetReference" + ], + "x-ms-enum": { + "name": "DatasetReferenceType", + "modelAsString": true + } + }, + "referenceName": { + "type": "string", + "description": "Reference dataset name." + }, + "parameters": { + "$ref": "#/definitions/ParameterValueSpecification", + "description": "Arguments for dataset." + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "DatasetResource": { + "description": "Dataset resource type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "./entityTypes/Dataset.json#/definitions/Dataset", + "description": "Dataset properties." + } + }, + "required": [ + "properties" + ] + }, + "DatasetDebugResource": { + "description": "Dataset debug resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResourceDebugResource" + } + ], + "properties": { + "properties": { + "$ref": "./entityTypes/Dataset.json#/definitions/Dataset", + "description": "Dataset properties." + } + }, + "required": [ + "properties" + ] + }, + "LinkedServiceReference": { + "description": "Linked service reference type.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Linked service reference type.", + "enum": [ + "LinkedServiceReference" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": true + } + }, + "referenceName": { + "type": "string", + "description": "Reference LinkedService name." + }, + "parameters": { + "$ref": "#/definitions/ParameterValueSpecification", + "description": "Arguments for LinkedService." + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "LinkedServiceResource": { + "description": "Linked service resource type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "./entityTypes/LinkedService.json#/definitions/LinkedService", + "description": "Properties of linked service." + } + }, + "required": [ + "properties" + ] + }, + "LinkedServiceDebugResource": { + "description": "Linked service debug resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResourceDebugResource" + } + ], + "properties": { + "properties": { + "$ref": "./entityTypes/LinkedService.json#/definitions/LinkedService", + "description": "Properties of linked service." + } + }, + "required": [ + "properties" + ] + }, + "SqlScriptsListResponse": { + "description": "A list of sql scripts resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of sql scripts.", + "items": { + "$ref": "#/definitions/SqlScriptResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "SqlScriptResource": { + "description": "Sql Script resource type.", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" + }, + "name": { + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + }, + "properties": { + "$ref": "./entityTypes/SqlScript.json#/definitions/SqlScript", + "description": "Properties of sql script." + } + }, + "required": [ + "name", + "properties" + ] + }, + "SparkJobDefinitionsListResponse": { + "description": "A list of spark job definitions resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of spark job definitions.", + "items": { + "$ref": "#/definitions/SparkJobDefinitionResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "SparkJobDefinitionResource": { + "description": "Spark job definition resource type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "./entityTypes/SparkJobDefinition.json#/definitions/SparkJobDefinition", + "description": "Properties of spark job definition." + } + }, + "required": [ + "properties" + ] + }, + "NotebookListResponse": { + "description": "A list of Notebook resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of Notebooks.", + "items": { + "$ref": "#/definitions/NotebookResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "NotebookResource": { + "description": "Notebook resource type.", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" + }, + "name": { + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + }, + "properties": { + "$ref": "./entityTypes/Notebook.json#/definitions/Notebook", + "description": "Properties of Notebook." + } + }, + "required": [ + "name", + "properties" + ] + }, + "DataFlowResource": { + "description": "Data flow resource type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "./entityTypes/DataFlow.json#/definitions/DataFlow", + "description": "Data flow properties." + } + }, + "required": [ + "properties" + ] + }, + "DataFlowReference": { + "description": "Data flow reference type.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Data flow reference type.", + "enum": [ + "DataFlowReference" + ], + "x-ms-enum": { + "name": "DataFlowReferenceType", + "modelAsString": true + } + }, + "referenceName": { + "type": "string", + "description": "Reference data flow name." + }, + "datasetParameters": { + "type": "object", + "description": "Reference data flow parameters from dataset." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type", + "referenceName" + ] + }, + "DataFlowStagingInfo": { + "description": "Staging info for execute data flow activity.", + "type": "object", + "properties": { + "linkedService": { + "description": "Staging linked service reference.", + "$ref": "#/definitions/LinkedServiceReference" + }, + "folderPath": { + "description": "Folder path for staging blob.", + "type": "string" + } + } + }, + "DataFlowDebugPackage": { + "description": "Request body structure for starting data flow debug session.", + "type": "object", + "properties": { + "sessionId": { + "description": "The ID of data flow debug session.", + "type": "string" + }, + "dataFlow": { + "description": "Data flow instance.", + "$ref": "#/definitions/DataFlowDebugResource" + }, + "datasets": { + "type": "array", + "description": "List of datasets.", + "items": { + "$ref": "#/definitions/DatasetDebugResource" + } + }, + "linkedServices": { + "type": "array", + "description": "List of linked services.", + "items": { + "$ref": "#/definitions/LinkedServiceDebugResource" + } + }, + "staging": { + "description": "Staging info for debug session.", + "$ref": "#/definitions/DataFlowStagingInfo" + }, + "debugSettings": { + "description": "Data flow debug settings.", + "type": "object", + "properties": { + "sourceSettings": { + "type": "array", + "description": "Source setting for data flow debug.", + "items": { + "$ref": "#/definitions/DataFlowSourceSetting" + } + }, + "parameters": { + "description": "Data flow parameters.", + "$ref": "#/definitions/ParameterValueSpecification" + }, + "datasetParameters": { + "description": "Parameters for dataset.", + "type": "object" + } + } + } + }, + "additionalProperties": { + "type": "object" + } + }, + "DataFlowSourceSetting": { + "description": "Definition of data flow source setting for debug.", + "type": "object", + "properties": { + "sourceName": { + "description": "The data flow source name.", + "type": "string" + }, + "rowLimit": { + "description": "Defines the row limit of data flow source in debug.", + "type": "integer" + } + }, + "additionalProperties": { + "type": "object" + } + }, + "DataFlowDebugResource": { + "description": "Data flow debug resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResourceDebugResource" + } + ], + "properties": { + "properties": { + "$ref": "./entityTypes/DataFlow.json#/definitions/DataFlow", + "description": "Data flow properties." + } + }, + "required": [ + "properties" + ] + }, + "AddDataFlowToDebugSessionResponse": { + "description": "Response body structure for starting data flow debug session.", + "type": "object", + "properties": { + "jobVersion": { + "description": "The ID of data flow debug job version.", + "type": "string" + } + } + }, + "DataFlowDebugCommandResponse": { + "description": "Response body structure of data flow result for data preview, statistics or expression preview.", + "type": "object", + "properties": { + "status": { + "description": "The run status of data preview, statistics or expression preview.", + "type": "string" + }, + "data": { + "description": "The result data of data preview, statistics or expression preview.", + "type": "string" + } + } + }, + "RunFilterParameters": { + "description": "Query parameters for listing runs.", + "type": "object", + "properties": { + "continuationToken": { + "description": "The continuation token for getting the next page of results. Null for first page.", + "type": "string" + }, + "lastUpdatedAfter": { + "description": "The time at or after which the run event was updated in 'ISO 8601' format.", + "type": "string", + "format": "date-time" + }, + "lastUpdatedBefore": { + "description": "The time at or before which the run event was updated in 'ISO 8601' format.", + "type": "string", + "format": "date-time" + }, + "filters": { + "type": "array", + "description": "List of filters.", + "items": { + "$ref": "#/definitions/RunQueryFilter" + } + }, + "orderBy": { + "type": "array", + "description": "List of OrderBy option.", + "items": { + "$ref": "#/definitions/RunQueryOrderBy" + } + } + }, + "required": [ + "lastUpdatedAfter", + "lastUpdatedBefore" + ] + }, + "RunQueryFilter": { + "description": "Query filter option for listing runs.", + "type": "object", + "properties": { + "operand": { + "description": "Parameter name to be used for filter. The allowed operands to query pipeline runs are PipelineName, RunStart, RunEnd and Status; to query activity runs are ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType and Status, and to query trigger runs are TriggerName, TriggerRunTimestamp and Status.", + "type": "string", + "enum": [ + "PipelineName", + "Status", + "RunStart", + "RunEnd", + "ActivityName", + "ActivityRunStart", + "ActivityRunEnd", + "ActivityType", + "TriggerName", + "TriggerRunTimestamp", + "RunGroupId", + "LatestOnly" + ], + "x-ms-enum": { + "name": "RunQueryFilterOperand", + "modelAsString": true + } + }, + "operator": { + "description": "Operator to be used for filter.", + "type": "string", + "enum": [ + "Equals", + "NotEquals", + "In", + "NotIn" + ], + "x-ms-enum": { + "name": "RunQueryFilterOperator", + "modelAsString": true + } + }, + "values": { + "type": "array", + "description": "List of filter values.", + "items": { + "type": "string" + } + } + }, + "required": [ + "operand", + "operator", + "values" + ] + }, + "RunQueryOrderBy": { + "description": "An object to provide order by options for listing runs.", + "type": "object", + "properties": { + "orderBy": { + "description": "Parameter name to be used for order by. The allowed parameters to order by for pipeline runs are PipelineName, RunStart, RunEnd and Status; for activity runs are ActivityName, ActivityRunStart, ActivityRunEnd and Status; for trigger runs are TriggerName, TriggerRunTimestamp and Status.", + "type": "string", + "enum": [ + "RunStart", + "RunEnd", + "PipelineName", + "Status", + "ActivityName", + "ActivityRunStart", + "ActivityRunEnd", + "TriggerName", + "TriggerRunTimestamp" + ], + "x-ms-enum": { + "name": "RunQueryOrderByField", + "modelAsString": true + } + }, + "order": { + "description": "Sorting order of the parameter.", + "type": "string", + "enum": [ + "ASC", + "DESC" + ], + "x-ms-enum": { + "name": "RunQueryOrder", + "modelAsString": true + } + } + }, + "required": [ + "orderBy", + "order" + ] + }, + "PipelineRunsQueryResponse": { + "description": "A list pipeline runs.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of pipeline runs.", + "items": { + "$ref": "#/definitions/PipelineRun" + } + }, + "continuationToken": { + "description": "The continuation token for getting the next page of results, if any remaining results exist, null otherwise.", + "type": "string" + } + } + }, + "PipelineRun": { + "description": "Information about a pipeline run.", + "type": "object", + "properties": { + "runId": { + "description": "Identifier of a run.", + "type": "string", + "readOnly": true + }, + "runGroupId": { + "description": "Identifier that correlates all the recovery runs of a pipeline run.", + "type": "string", + "readOnly": true + }, + "isLatest": { + "description": "Indicates if the recovered pipeline run is the latest in its group.", + "type": "boolean", + "readOnly": true + }, + "pipelineName": { + "description": "The pipeline name.", + "type": "string", + "readOnly": true + }, + "parameters": { + "description": "The full or partial list of parameter name, value pair used in the pipeline run.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "invokedBy": { + "description": "Entity that started the pipeline run.", + "$ref": "#/definitions/PipelineRunInvokedBy", + "readOnly": true + }, + "lastUpdated": { + "description": "The last updated timestamp for the pipeline run event in ISO8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "runStart": { + "description": "The start time of a pipeline run in ISO8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "runEnd": { + "description": "The end time of a pipeline run in ISO8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "durationInMs": { + "description": "The duration of a pipeline run.", + "type": "integer", + "readOnly": true + }, + "status": { + "description": "The status of a pipeline run.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The message from a pipeline run.", + "type": "string", + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "PipelineRunInvokedBy": { + "description": "Provides entity name and id that started the pipeline run.", + "type": "object", + "properties": { + "name": { + "description": "Name of the entity that started the pipeline run.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "The ID of the entity that started the run.", + "type": "string", + "readOnly": true + }, + "invokedByType": { + "description": "The type of the entity that started the run.", + "type": "string", + "readOnly": true + } + } + }, + "ActivityRunsQueryResponse": { + "description": "A list activity runs.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of activity runs.", + "items": { + "$ref": "#/definitions/ActivityRun" + } + }, + "continuationToken": { + "description": "The continuation token for getting the next page of results, if any remaining results exist, null otherwise.", + "type": "string" + } + } + }, + "ActivityRun": { + "description": "Information about an activity run in a pipeline.", + "type": "object", + "properties": { + "pipelineName": { + "description": "The name of the pipeline.", + "type": "string", + "readOnly": true + }, + "pipelineRunId": { + "description": "The id of the pipeline run.", + "type": "string", + "readOnly": true + }, + "activityName": { + "description": "The name of the activity.", + "type": "string", + "readOnly": true + }, + "activityType": { + "description": "The type of the activity.", + "type": "string", + "readOnly": true + }, + "activityRunId": { + "description": "The id of the activity run.", + "type": "string", + "readOnly": true + }, + "linkedServiceName": { + "description": "The name of the compute linked service.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The status of the activity run.", + "type": "string", + "readOnly": true + }, + "activityRunStart": { + "description": "The start time of the activity run in 'ISO 8601' format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "activityRunEnd": { + "description": "The end time of the activity run in 'ISO 8601' format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "durationInMs": { + "description": "The duration of the activity run.", + "type": "integer", + "readOnly": true + }, + "input": { + "description": "The input for the activity.", + "type": "object", + "readOnly": true + }, + "output": { + "description": "The output for the activity.", + "type": "object", + "readOnly": true + }, + "error": { + "description": "The error if any from the activity run.", + "type": "object", + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "TriggerRunsQueryResponse": { + "description": "A list of trigger runs.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of trigger runs.", + "items": { + "$ref": "#/definitions/TriggerRun" + } + }, + "continuationToken": { + "description": "The continuation token for getting the next page of results, if any remaining results exist, null otherwise.", + "type": "string" + } + } + }, + "TriggerRun": { + "description": "Trigger runs.", + "type": "object", + "properties": { + "triggerRunId": { + "type": "string", + "description": "Trigger run id.", + "readOnly": true + }, + "triggerName": { + "type": "string", + "description": "Trigger name.", + "readOnly": true + }, + "triggerType": { + "type": "string", + "description": "Trigger type.", + "readOnly": true + }, + "triggerRunTimestamp": { + "type": "string", + "format": "date-time", + "description": "Trigger run start time.", + "readOnly": true + }, + "status": { + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Inprogress" + ], + "x-ms-enum": { + "name": "TriggerRunStatus", + "modelAsString": true + }, + "description": "Trigger run status.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Trigger error message.", + "readOnly": true + }, + "properties": { + "description": "List of property name and value related to trigger run. Name, value pair depends on type of trigger.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "triggeredPipelines": { + "description": "List of pipeline name and run Id triggered by the trigger run.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "RerunTumblingWindowTriggerActionParameters": { + "description": "Rerun tumbling window trigger Parameters.", + "type": "object", + "properties": { + "startTime": { + "description": "The start time for the time period for which restatement is initiated. Only UTC time is currently supported.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The end time for the time period for which restatement is initiated. Only UTC time is currently supported.", + "type": "string", + "format": "date-time" + }, + "maxConcurrency": { + "description": "The max number of parallel time windows (ready for execution) for which a rerun is triggered.", + "type": "integer", + "minimum": 1, + "maximum": 50 + } + }, + "required": [ + "startTime", + "endTime", + "maxConcurrency" + ] + }, + "RerunTriggerListResponse": { + "description": "A list of rerun triggers.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of rerun triggers.", + "items": { + "$ref": "#/definitions/RerunTriggerResource" + } + }, + "nextLink": { + "description": "The continuation token for getting the next page of results, if any remaining results exist, null otherwise.", + "type": "string", + "readOnly": true + } + } + }, + "RerunTriggerResource": { + "description": "RerunTrigger resource type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "./entityTypes/Trigger.json#/definitions/RerunTumblingWindowTrigger", + "description": "Properties of the rerun trigger." + } + }, + "required": [ + "properties" + ] + }, + "GetSsisObjectMetadataRequest": { + "type": "object", + "description": "The request payload of get SSIS object metadata.", + "properties": { + "metadataPath": { + "type": "string", + "description": "Metadata path." + } + } + }, + "SsisObjectMetadataStatusResponse": { + "type": "object", + "description": "The status of the operation.", + "properties": { + "status": { + "type": "string", + "description": "The status of the operation." + }, + "name": { + "type": "string", + "description": "The operation name." + }, + "properties": { + "type": "string", + "description": "The operation properties." + }, + "error": { + "type": "string", + "description": "The operation error message." + } + } + }, + "ExposureControlRequest": { + "type": "object", + "description": "The exposure control request.", + "properties": { + "featureName": { + "type": "string", + "description": "The feature name." + }, + "featureType": { + "type": "string", + "description": "The feature type." + } + } + }, + "ExposureControlResponse": { + "type": "object", + "description": "The exposure control response.", + "properties": { + "featureName": { + "type": "string", + "description": "The feature name.", + "readOnly": true + }, + "value": { + "type": "string", + "description": "The feature value.", + "readOnly": true + } + } + }, + "SynapseNotebookReference": { + "description": "Synapse notebook reference type.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Synapse notebook reference type.", + "enum": [ + "NotebookReference" + ], + "x-ms-enum": { + "name": "NotebookReferenceType", + "modelAsString": true + } + }, + "referenceName": { + "type": "string", + "description": "Reference notebook name." + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "SynapseSparkJobReference": { + "description": "Synapse spark job reference type.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Synapse spark job reference type.", + "enum": [ + "SparkJobDefinitionReference" + ], + "x-ms-enum": { + "name": "SparkJobReferenceType", + "modelAsString": true + } + }, + "referenceName": { + "type": "string", + "description": "Reference spark job name." + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "SqlPoolReference": { + "description": "SQL pool reference type.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "SQL pool reference type.", + "enum": [ + "SqlPoolReference" + ], + "x-ms-enum": { + "name": "SqlPoolReferenceType", + "modelAsString": true + } + }, + "referenceName": { + "type": "string", + "description": "Reference SQL pool name." + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "ArtifactRenameRequest": { + "description": "Request body structure for rename artifact.", + "type": "object", + "properties": { + "newName": { + "description": "New name of the artifact.", + "type": "string", + "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", + "minLength": 1, + "maxLength": 260 + } + } + } + }, + "parameters": { + "workspaceName": { + "name": "workspaceName", + "description": "The workspace name.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "sqlScriptName": { + "name": "sqlScriptName", + "description": "The sql script name.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "sparkJobDefinitionName": { + "name": "sparkJobDefinitionName", + "description": "The spark job definition name.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "sparkConfigurationName": { + "name": "sparkConfigurationName", + "description": "The spark Configuration name.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "NotebookName": { + "name": "notebookName", + "description": "The notebook name.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "locationId": { + "name": "locationId", + "description": "The location identifier.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "linkedServiceName": { + "name": "linkedServiceName", + "description": "The linked service name.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", + "minLength": 1, + "maxLength": 260, + "x-ms-parameter-location": "method" + }, + "datasetName": { + "name": "datasetName", + "description": "The dataset name.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", + "minLength": 1, + "maxLength": 260, + "x-ms-parameter-location": "method" + }, + "pipelineName": { + "name": "pipelineName", + "description": "The pipeline name.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", + "minLength": 1, + "maxLength": 260, + "x-ms-parameter-location": "method" + }, + "dataFlowName": { + "name": "dataFlowName", + "description": "The data flow name.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", + "minLength": 1, + "maxLength": 260, + "x-ms-parameter-location": "method" + }, + "triggerName": { + "name": "triggerName", + "description": "The trigger name.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", + "minLength": 1, + "maxLength": 260, + "x-ms-parameter-location": "method" + }, + "rerunTriggerName": { + "name": "rerunTriggerName", + "description": "The rerun trigger name.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", + "minLength": 1, + "maxLength": 260, + "x-ms-parameter-location": "method" + }, + "runId": { + "name": "runId", + "description": "The pipeline run identifier.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "sessionId": { + "name": "sessionId", + "description": "The data flow session identifier.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "jobVersion": { + "name": "jobVersion", + "description": "The data flow job version identifier.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "nodeName": { + "name": "nodeName", + "description": "The integration runtime node name.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z0-9A-Z][a-z0-9A-Z_-]{0,149}$", + "minLength": 1, + "maxLength": 150, + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Synapse client API Version." + }, + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/bigDataPools.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/bigDataPools.json new file mode 100644 index 000000000000..bb9102d71cfe --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/bigDataPools.json @@ -0,0 +1,123 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01-preview", + "title": "ArtifactsClient" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/bigDataPools": { + "get": { + "tags": [ + "BigDataPools" + ], + "operationId": "BigDataPools_List", + "description": "List Big Data Pools", + "x-ms-examples": { + "List Big Data Pools": { + "$ref": "./examples/BigDataPools_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success response.", + "schema": { + "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/bigDataPool.json#/definitions/BigDataPoolResourceInfoListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json#/definitions/ErrorContract" + } + } + } + } + }, + "/bigDataPools/{bigDataPoolName}": { + "get": { + "tags": [ + "BigDataPools" + ], + "operationId": "BigDataPools_Get", + "description": "Get Big Data Pool", + "x-ms-examples": { + "Get Big Data Pool": { + "$ref": "./examples/BigDataPools_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/BigDataPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Success response.", + "schema": { + "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/bigDataPool.json#/definitions/BigDataPoolResourceInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json#/definitions/ErrorContract" + } + } + } + } + } + }, + "definitions": {}, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Synapse client API Version." + }, + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "BigDataPoolNameParameter": { + "name": "bigDataPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The Big Data Pool name", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/DataFlow.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/DataFlow.json new file mode 100644 index 000000000000..6af5bdd24312 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/DataFlow.json @@ -0,0 +1,156 @@ +{ + "swagger": "2.0", + "info": { + "title": "ArtifactsClient", + "version": "2021-06-01-preview" + }, + "paths": {}, + "definitions": { + "DataFlow": { + "description": "Azure Synapse nested object which contains a flow with data movements and transformations.", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Type of data flow." + }, + "description": { + "description": "The description of the data flow.", + "type": "string" + }, + "annotations": { + "description": "List of tags that can be used for describing the data flow.", + "type": "array", + "items": { + "type": "object" + } + }, + "folder": { + "description": "The folder that this data flow is in. If not specified, Data flow will appear at the root level.", + "type": "object", + "properties": { + "name": { + "description": "The name of the folder that this data flow is in.", + "type": "string" + } + } + } + }, + "required": [ + "type" + ] + }, + "MappingDataFlow": { + "x-ms-discriminator-value": "MappingDataFlow", + "description": "Mapping data flow.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataFlow" + } + ], + "properties": { + "typeProperties": { + "description": "Mapping data flow type properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MappingDataFlowTypeProperties" + } + } + }, + "MappingDataFlowTypeProperties": { + "description": "Mapping data flow type properties.", + "type": "object", + "properties": { + "sources": { + "type": "array", + "description": "List of sources in data flow.", + "items": { + "$ref": "#/definitions/DataFlowSource" + } + }, + "sinks": { + "type": "array", + "description": "List of sinks in data flow.", + "items": { + "$ref": "#/definitions/DataFlowSink" + } + }, + "transformations": { + "type": "array", + "description": "List of transformations in data flow.", + "items": { + "$ref": "#/definitions/Transformation" + } + }, + "script": { + "type": "string", + "description": "DataFlow script." + } + } + }, + "Transformation": { + "description": "A data flow transformation.", + "type": "object", + "properties": { + "name": { + "description": "Transformation name.", + "type": "string" + }, + "description": { + "description": "Transformation description.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "DataFlowSource": { + "description": "Transformation for data flow source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Transformation" + } + ], + "properties": { + "dataset": { + "description": "Dataset reference.", + "$ref": "../artifacts.json#/definitions/DatasetReference" + }, + "linkedService": { + "description": "Linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "schemaLinkedService": { + "description": "Schema linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + } + } + }, + "DataFlowSink": { + "description": "Transformation for data flow sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Transformation" + } + ], + "properties": { + "dataset": { + "description": "Dataset reference.", + "$ref": "../artifacts.json#/definitions/DatasetReference" + }, + "linkedService": { + "description": "Linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "schemaLinkedService": { + "description": "Schema linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/Dataset.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/Dataset.json new file mode 100644 index 000000000000..3db6a0198094 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/Dataset.json @@ -0,0 +1,3397 @@ +{ + "swagger": "2.0", + "info": { + "title": "ArtifactsClient", + "version": "2021-06-01-preview" + }, + "paths": {}, + "definitions": { + "Dataset": { + "description": "The Azure Data Factory nested object which identifies data within different data stores, such as tables, files, folders, and documents.", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Type of dataset." + }, + "description": { + "description": "Dataset description.", + "type": "string" + }, + "structure": { + "type": "object", + "description": "Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement." + }, + "schema": { + "type": "object", + "description": "Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement." + }, + "linkedServiceName": { + "description": "Linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "parameters": { + "$ref": "../artifacts.json#/definitions/ParameterDefinitionSpecification", + "description": "Parameters for dataset." + }, + "annotations": { + "description": "List of tags that can be used for describing the Dataset.", + "type": "array", + "items": { + "type": "object" + } + }, + "folder": { + "description": "The folder that this Dataset is in. If not specified, Dataset will appear at the root level.", + "type": "object", + "properties": { + "name": { + "description": "The name of the folder that this Dataset is in.", + "type": "string" + } + } + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type", + "linkedServiceName" + ] + }, + "DatasetLocation": { + "description": "Dataset location.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of dataset storage location." + }, + "folderPath": { + "type": "object", + "description": "Specify the folder path of dataset. Type: string (or Expression with resultType string)" + }, + "fileName": { + "type": "object", + "description": "Specify the file name of dataset. Type: string (or Expression with resultType string)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "AzureBlobStorageLocation": { + "description": "The location of azure blob dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetLocation" + } + ], + "properties": { + "container": { + "type": "object", + "description": "Specify the container of azure blob. Type: string (or Expression with resultType string)." + } + } + }, + "AzureBlobFSLocation": { + "description": "The location of azure blobFS dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetLocation" + } + ], + "properties": { + "fileSystem": { + "type": "object", + "description": "Specify the fileSystem of azure blobFS. Type: string (or Expression with resultType string)." + } + } + }, + "AzureDataLakeStoreLocation": { + "description": "The location of azure data lake store dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetLocation" + } + ] + }, + "AmazonS3Location": { + "description": "The location of amazon S3 dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetLocation" + } + ], + "properties": { + "bucketName": { + "type": "object", + "description": "Specify the bucketName of amazon S3. Type: string (or Expression with resultType string)" + }, + "version": { + "type": "object", + "description": "Specify the version of amazon S3. Type: string (or Expression with resultType string)." + } + } + }, + "FileServerLocation": { + "description": "The location of file server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetLocation" + } + ] + }, + "AzureFileStorageLocation": { + "description": "The location of file server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetLocation" + } + ] + }, + "GoogleCloudStorageLocation": { + "description": "The location of Google Cloud Storage dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetLocation" + } + ], + "properties": { + "bucketName": { + "type": "object", + "description": "Specify the bucketName of Google Cloud Storage. Type: string (or Expression with resultType string)" + }, + "version": { + "type": "object", + "description": "Specify the version of Google Cloud Storage. Type: string (or Expression with resultType string)." + } + } + }, + "FtpServerLocation": { + "description": "The location of ftp server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetLocation" + } + ] + }, + "SftpLocation": { + "description": "The location of SFTP dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetLocation" + } + ] + }, + "HttpServerLocation": { + "description": "The location of http server.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetLocation" + } + ], + "properties": { + "relativeUrl": { + "type": "object", + "description": "Specify the relativeUrl of http server. Type: string (or Expression with resultType string)" + } + } + }, + "HdfsLocation": { + "description": "The location of HDFS.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetLocation" + } + ] + }, + "DatasetDataElement": { + "description": "Columns that define the structure of the dataset.", + "type": "object", + "properties": { + "name": { + "type": "object", + "description": "Name of the column. Type: string (or Expression with resultType string)." + }, + "type": { + "type": "object", + "description": "Type of the column. Type: string (or Expression with resultType string)." + } + } + }, + "DatasetSchemaDataElement": { + "description": "Columns that define the physical type schema of the dataset.", + "type": "object", + "properties": { + "name": { + "type": "object", + "description": "Name of the schema column. Type: string (or Expression with resultType string)." + }, + "type": { + "type": "object", + "description": "Type of the schema column. Type: string (or Expression with resultType string)." + } + }, + "additionalProperties": { + "type": "object" + } + }, + "DatasetStorageFormat": { + "discriminator": "type", + "description": "The format definition of a storage.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of dataset storage format." + }, + "serializer": { + "type": "object", + "description": "Serializer. Type: string (or Expression with resultType string)." + }, + "deserializer": { + "type": "object", + "description": "Deserializer. Type: string (or Expression with resultType string)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "TextFormat": { + "description": "The data stored in text format.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetStorageFormat" + } + ], + "properties": { + "columnDelimiter": { + "type": "object", + "description": "The column delimiter. Type: string (or Expression with resultType string)." + }, + "rowDelimiter": { + "type": "object", + "description": "The row delimiter. Type: string (or Expression with resultType string)." + }, + "escapeChar": { + "type": "object", + "description": "The escape character. Type: string (or Expression with resultType string)." + }, + "quoteChar": { + "type": "object", + "description": "The quote character. Type: string (or Expression with resultType string)." + }, + "nullValue": { + "type": "object", + "description": "The null value string. Type: string (or Expression with resultType string)." + }, + "encodingName": { + "type": "object", + "description": "The code page name of the preferred encoding. If miss, the default value is ΓÇ£utf-8ΓÇ¥, unless BOM denotes another Unicode encoding. Refer to the ΓÇ£NameΓÇ¥ column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string)." + }, + "treatEmptyAsNull": { + "type": "object", + "description": "Treat empty column values in the text file as null. The default value is true. Type: boolean (or Expression with resultType boolean)." + }, + "skipLineCount": { + "type": "object", + "description": "The number of lines/rows to be skipped when parsing text files. The default value is 0. Type: integer (or Expression with resultType integer)." + }, + "firstRowAsHeader": { + "type": "object", + "description": "When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "JsonFormat": { + "description": "The data stored in JSON format.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetStorageFormat" + } + ], + "properties": { + "filePattern": { + "description": "File pattern of JSON. To be more specific, the way of separating a collection of JSON objects. The default value is 'setOfObjects'. It is case-sensitive.", + "$ref": "#/definitions/JsonFormatFilePattern" + }, + "nestingSeparator": { + "type": "object", + "description": "The character used to separate nesting levels. Default value is '.' (dot). Type: string (or Expression with resultType string)." + }, + "encodingName": { + "type": "object", + "description": "The code page name of the preferred encoding. If not provided, the default value is 'utf-8', unless the byte order mark (BOM) denotes another Unicode encoding. The full list of supported values can be found in the 'Name' column of the table of encodings in the following reference: https://go.microsoft.com/fwlink/?linkid=861078. Type: string (or Expression with resultType string)." + }, + "jsonNodeReference": { + "type": "object", + "description": "The JSONPath of the JSON array element to be flattened. Example: \"$.ArrayPath\". Type: string (or Expression with resultType string)." + }, + "jsonPathDefinition": { + "type": "object", + "description": "The JSONPath definition for each column mapping with a customized column name to extract data from JSON file. For fields under root object, start with \"$\"; for fields inside the array chosen by jsonNodeReference property, start from the array element. Example: {\"Column1\": \"$.Column1Path\", \"Column2\": \"Column2PathInArray\"}. Type: object (or Expression with resultType object)." + } + } + }, + "JsonFormatFilePattern": { + "description": "JSON format file pattern. A property of JsonFormat.", + "type": "string", + "enum": [ + "setOfObjects", + "arrayOfObjects" + ], + "x-ms-enum": { + "name": "JsonFormatFilePattern", + "modelAsString": true + } + }, + "AvroFormat": { + "description": "The data stored in Avro format.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetStorageFormat" + } + ] + }, + "OrcFormat": { + "description": "The data stored in Optimized Row Columnar (ORC) format.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetStorageFormat" + } + ] + }, + "ParquetFormat": { + "description": "The data stored in Parquet format.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetStorageFormat" + } + ] + }, + "DatasetCompression": { + "discriminator": "type", + "description": "The compression method used on a dataset.", + "type": "object", + "properties": { + "type": { + "type": "object", + "description": "Type of dataset compression. Type: string (or Expression with resultType string)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "DatasetBZip2Compression": { + "x-ms-discriminator-value": "BZip2", + "description": "The BZip2 compression method used on a dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetCompression" + } + ], + "properties": {} + }, + "DatasetGZipCompression": { + "x-ms-discriminator-value": "GZip", + "description": "The GZip compression method used on a dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetCompression" + } + ], + "properties": { + "level": { + "description": "The GZip compression level.", + "$ref": "#/definitions/CompressionLevel" + } + } + }, + "DatasetDeflateCompression": { + "x-ms-discriminator-value": "Deflate", + "description": "The Deflate compression method used on a dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetCompression" + } + ], + "properties": { + "level": { + "description": "The Deflate compression level.", + "$ref": "#/definitions/CompressionLevel" + } + } + }, + "DatasetZipDeflateCompression": { + "x-ms-discriminator-value": "ZipDeflate", + "description": "The ZipDeflate compression method used on a dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetCompression" + } + ], + "properties": { + "level": { + "description": "The ZipDeflate compression level.", + "$ref": "#/definitions/CompressionLevel" + } + } + }, + "DatasetTarCompression": { + "x-ms-discriminator-value": "Tar", + "description": "The Tar archive method used on a dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetCompression" + } + ], + "properties": {} + }, + "DatasetTarGZipCompression": { + "x-ms-discriminator-value": "TarGZip", + "description": "The TarGZip compression method used on a dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetCompression" + } + ], + "properties": { + "level": { + "description": "The TarGZip compression level.", + "$ref": "#/definitions/CompressionLevel" + } + } + }, + "CompressionLevel": { + "title": "Microsoft.Azure.Management.DataFactories.Models.CompressionLevel", + "description": "All available compression levels.", + "type": "object" + }, + "DatasetCompressionLevelEnum": { + "type": "string", + "enum": [ + "Optimal", + "Fastest" + ], + "x-ms-enum": { + "name": "DatasetCompressionLevel", + "modelAsString": true + } + }, + "AmazonS3Dataset": { + "x-ms-discriminator-value": "AmazonS3Object", + "description": "A single Amazon Simple Storage Service (S3) object or a set of S3 objects.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Amazon S3 dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AmazonS3DatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AmazonS3DatasetTypeProperties": { + "description": "Amazon S3 dataset properties.", + "type": "object", + "properties": { + "bucketName": { + "type": "object", + "description": "The name of the Amazon S3 bucket. Type: string (or Expression with resultType string)." + }, + "key": { + "type": "object", + "description": "The key of the Amazon S3 object. Type: string (or Expression with resultType string)." + }, + "prefix": { + "type": "object", + "description": "The prefix filter for the S3 object name. Type: string (or Expression with resultType string)." + }, + "version": { + "type": "object", + "description": "The version for the S3 object. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of S3 object's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of S3 object's modified datetime. Type: string (or Expression with resultType string)." + }, + "format": { + "description": "The format of files.", + "$ref": "#/definitions/DatasetStorageFormat" + }, + "compression": { + "description": "The data compression method used for the Amazon S3 object.", + "$ref": "#/definitions/DatasetCompression" + } + }, + "required": [ + "bucketName" + ] + }, + "AvroDataset": { + "x-ms-discriminator-value": "Avro", + "description": "Avro dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Avro dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AvroDatasetTypeProperties" + } + } + }, + "AvroDatasetTypeProperties": { + "description": "Avro dataset properties.", + "type": "object", + "properties": { + "location": { + "$ref": "#/definitions/DatasetLocation", + "description": "The location of the avro storage." + }, + "avroCompressionCodec": { + "type": "object", + "description": "A string from AvroCompressionCodecEnum or an expression" + }, + "avroCompressionLevel": { + "type": "integer", + "minimum": 1, + "maximum": 9 + } + }, + "required": [ + "location" + ] + }, + "AvroCompressionCodecEnum": { + "type": "string", + "enum": [ + "none", + "deflate", + "snappy", + "xz", + "bzip2" + ], + "x-ms-enum": { + "name": "AvroCompressionCodec", + "modelAsString": true + } + }, + "ExcelDataset": { + "x-ms-discriminator-value": "Excel", + "description": "Excel dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Excel dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExcelDatasetTypeProperties" + } + } + }, + "ExcelDatasetTypeProperties": { + "description": "Excel dataset properties.", + "type": "object", + "properties": { + "location": { + "$ref": "#/definitions/DatasetLocation", + "description": "The location of the excel storage." + }, + "sheetName": { + "type": "object", + "description": "The sheet of excel file. Type: string (or Expression with resultType string)." + }, + "range": { + "type": "object", + "description": "The partial data of one sheet. Type: string (or Expression with resultType string)." + }, + "firstRowAsHeader": { + "type": "object", + "description": "When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean)." + }, + "compression": { + "description": "The data compression method used for the json dataset.", + "$ref": "#/definitions/DatasetCompression" + }, + "nullValue": { + "type": "object", + "description": "The null value string. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "location", + "sheetName" + ] + }, + "ParquetDataset": { + "x-ms-discriminator-value": "Parquet", + "description": "Parquet dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Parquet dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ParquetDatasetTypeProperties" + } + } + }, + "ParquetDatasetTypeProperties": { + "description": "Parquet dataset properties.", + "type": "object", + "properties": { + "location": { + "$ref": "#/definitions/DatasetLocation", + "description": "The location of the parquet storage." + }, + "compressionCodec": { + "type": "object", + "description": "A string from ParquetCompressionCodecEnum or an expression" + } + }, + "required": [ + "location" + ] + }, + "ParquetCompressionCodecEnum": { + "type": "string", + "enum": [ + "none", + "gzip", + "snappy", + "lzo" + ], + "x-ms-enum": { + "name": "ParquetCompressionCodecEnum", + "modelAsString": true + } + }, + "DelimitedTextDataset": { + "x-ms-discriminator-value": "DelimitedText", + "description": "Delimited text dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Delimited text dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DelimitedTextDatasetTypeProperties" + } + } + }, + "DelimitedTextDatasetTypeProperties": { + "description": "DelimitedText dataset properties.", + "type": "object", + "properties": { + "location": { + "$ref": "#/definitions/DatasetLocation", + "description": "The location of the delimited text storage." + }, + "columnDelimiter": { + "type": "object", + "description": "The column delimiter. Type: string (or Expression with resultType string)." + }, + "rowDelimiter": { + "type": "object", + "description": "The row delimiter. Type: string (or Expression with resultType string)." + }, + "encodingName": { + "type": "object", + "description": "The code page name of the preferred encoding. If miss, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string)." + }, + "compressionCodec": { + "type": "string", + "enum": [ + "bzip2", + "gzip", + "deflate", + "zipDeflate", + "snappy", + "lz4", + "tar", + "tarGZip" + ], + "x-ms-enum": { + "name": "compressionCodec", + "modelAsString": true + } + }, + "compressionLevel": { + "description": "The data compression method used for DelimitedText.", + "$ref": "#/definitions/CompressionLevel" + }, + "quoteChar": { + "type": "object", + "description": "The quote character. Type: string (or Expression with resultType string)." + }, + "escapeChar": { + "type": "object", + "description": "The escape character. Type: string (or Expression with resultType string)." + }, + "firstRowAsHeader": { + "type": "object", + "description": "When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean)." + }, + "nullValue": { + "type": "object", + "description": "The null value string. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "location" + ] + }, + "JsonDataset": { + "x-ms-discriminator-value": "Json", + "description": "Json dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Json dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/JsonDatasetTypeProperties" + } + } + }, + "JsonDatasetTypeProperties": { + "description": "Json dataset properties.", + "type": "object", + "properties": { + "location": { + "$ref": "#/definitions/DatasetLocation", + "description": "The location of the json data storage." + }, + "encodingName": { + "type": "object", + "description": "The code page name of the preferred encoding. If not specified, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string)." + }, + "compression": { + "description": "The data compression method used for the json dataset.", + "$ref": "#/definitions/DatasetCompression" + } + }, + "required": [ + "location" + ] + }, + "XmlDataset": { + "x-ms-discriminator-value": "Xml", + "description": "Xml dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Xml dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/XmlDatasetTypeProperties" + } + } + }, + "XmlDatasetTypeProperties": { + "description": "Xml dataset properties.", + "type": "object", + "properties": { + "location": { + "$ref": "#/definitions/DatasetLocation", + "description": "The location of the json data storage." + }, + "encodingName": { + "type": "object", + "description": "The code page name of the preferred encoding. If not specified, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string)." + }, + "nullValue": { + "type": "object", + "description": "The null value string. Type: string (or Expression with resultType string)." + }, + "compression": { + "description": "The data compression method used for the json dataset.", + "$ref": "#/definitions/DatasetCompression" + } + }, + "required": [ + "location" + ] + }, + "OrcDataset": { + "x-ms-discriminator-value": "Orc", + "description": "ORC dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "ORC dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/OrcDatasetTypeProperties" + } + } + }, + "OrcDatasetTypeProperties": { + "description": "ORC dataset properties.", + "type": "object", + "properties": { + "location": { + "$ref": "#/definitions/DatasetLocation", + "description": "The location of the ORC data storage." + }, + "orcCompressionCodec": { + "type": "string", + "enum": [ + "none", + "zlib", + "snappy", + "lzo" + ], + "x-ms-enum": { + "name": "orcCompressionCodec", + "modelAsString": true + } + } + }, + "required": [ + "location" + ] + }, + "BinaryDataset": { + "x-ms-discriminator-value": "Binary", + "description": "Binary dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Binary dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/BinaryDatasetTypeProperties" + } + } + }, + "BinaryDatasetTypeProperties": { + "description": "Binary dataset properties.", + "type": "object", + "properties": { + "location": { + "$ref": "#/definitions/DatasetLocation", + "description": "The location of the Binary storage." + }, + "compression": { + "description": "The data compression method used for the binary dataset.", + "$ref": "#/definitions/DatasetCompression" + } + }, + "required": [ + "location" + ] + }, + "AzureBlobDataset": { + "x-ms-discriminator-value": "AzureBlob", + "description": "The Azure Blob storage.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Blob dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureBlobDatasetTypeProperties" + } + } + }, + "AzureBlobDatasetTypeProperties": { + "description": "Azure Blob dataset properties.", + "type": "object", + "properties": { + "folderPath": { + "type": "object", + "description": "The path of the Azure Blob storage. Type: string (or Expression with resultType string)." + }, + "tableRootLocation": { + "type": "object", + "description": "The root of blob path. Type: string (or Expression with resultType string)." + }, + "fileName": { + "type": "object", + "description": "The name of the Azure Blob. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of Azure Blob's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of Azure Blob's modified datetime. Type: string (or Expression with resultType string)." + }, + "format": { + "description": "The format of the Azure Blob storage.", + "$ref": "#/definitions/DatasetStorageFormat" + }, + "compression": { + "description": "The data compression method used for the blob storage.", + "$ref": "#/definitions/DatasetCompression" + } + } + }, + "AzureTableDataset": { + "x-ms-discriminator-value": "AzureTable", + "description": "The Azure Table storage dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Table dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureTableDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureTableDatasetTypeProperties": { + "description": "Azure Table dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "The table name of the Azure Table storage. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "tableName" + ] + }, + "AzureSqlTableDataset": { + "x-ms-discriminator-value": "AzureSqlTable", + "description": "The Azure SQL Server database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Azure SQL dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureSqlTableDatasetTypeProperties" + } + } + }, + "AzureSqlTableDatasetTypeProperties": { + "description": "Azure SQL dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "schema": { + "type": "object", + "description": "The schema name of the Azure SQL database. Type: string (or Expression with resultType string)." + }, + "table": { + "type": "object", + "description": "The table name of the Azure SQL database. Type: string (or Expression with resultType string)." + } + } + }, + "AzureSqlMITableDataset": { + "x-ms-discriminator-value": "AzureSqlMITable", + "description": "The Azure SQL Managed Instance dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Azure SQL Managed Instance dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureSqlMITableDatasetTypeProperties" + } + } + }, + "AzureSqlMITableDatasetTypeProperties": { + "description": "Azure SQL Managed Instance dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "schema": { + "type": "object", + "description": "The schema name of the Azure SQL Managed Instance. Type: string (or Expression with resultType string)." + }, + "table": { + "type": "object", + "description": "The table name of the Azure SQL Managed Instance dataset. Type: string (or Expression with resultType string)." + } + } + }, + "AzureSqlDWTableDataset": { + "x-ms-discriminator-value": "AzureSqlDWTable", + "description": "The Azure SQL Data Warehouse dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Azure SQL Data Warehouse dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureSqlDWTableDatasetTypeProperties" + } + } + }, + "AzureSqlDWTableDatasetTypeProperties": { + "description": "Azure SQL Data Warehouse dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "schema": { + "type": "object", + "description": "The schema name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string)." + }, + "table": { + "type": "object", + "description": "The table name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string)." + } + } + }, + "CassandraTableDataset": { + "x-ms-discriminator-value": "CassandraTable", + "description": "The Cassandra database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Cassandra dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CassandraTableDatasetTypeProperties" + } + } + }, + "CassandraTableDatasetTypeProperties": { + "description": "Cassandra dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "The table name of the Cassandra database. Type: string (or Expression with resultType string)." + }, + "keyspace": { + "type": "object", + "description": "The keyspace of the Cassandra database. Type: string (or Expression with resultType string)." + } + } + }, + "CustomDataset": { + "description": "The custom dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Custom dataset properties.", + "x-ms-client-flatten": true, + "type": "object" + } + } + }, + "CosmosDbSqlApiCollectionDataset": { + "x-ms-discriminator-value": "CosmosDbSqlApiCollection", + "description": "Microsoft Azure CosmosDB (SQL API) Collection dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "CosmosDB (SQL API) Collection dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CosmosDbSqlApiCollectionDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "CosmosDbSqlApiCollectionDatasetTypeProperties": { + "description": "CosmosDB (SQL API) Collection dataset properties.", + "type": "object", + "properties": { + "collectionName": { + "type": "object", + "description": "CosmosDB (SQL API) collection name. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "collectionName" + ] + }, + "DocumentDbCollectionDataset": { + "x-ms-discriminator-value": "DocumentDbCollection", + "description": "Microsoft Azure Document Database Collection dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "DocumentDB Collection dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DocumentDbCollectionDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DocumentDbCollectionDatasetTypeProperties": { + "description": "DocumentDB Collection dataset properties.", + "type": "object", + "properties": { + "collectionName": { + "type": "object", + "description": "Document Database collection name. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "collectionName" + ] + }, + "DynamicsEntityDataset": { + "x-ms-discriminator-value": "DynamicsEntity", + "description": "The Dynamics entity dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Dynamics entity dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DynamicsEntityDatasetTypeProperties" + } + } + }, + "DynamicsEntityDatasetTypeProperties": { + "description": "Dynamics entity dataset properties.", + "type": "object", + "properties": { + "entityName": { + "type": "object", + "description": "The logical name of the entity. Type: string (or Expression with resultType string)." + } + } + }, + "DynamicsCrmEntityDataset": { + "x-ms-discriminator-value": "DynamicsCrmEntity", + "description": "The Dynamics CRM entity dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Dynamics CRM entity dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DynamicsCrmEntityDatasetTypeProperties" + } + } + }, + "DynamicsCrmEntityDatasetTypeProperties": { + "description": "Dynamics CRM entity dataset properties.", + "type": "object", + "properties": { + "entityName": { + "type": "object", + "description": "The logical name of the entity. Type: string (or Expression with resultType string)." + } + } + }, + "CommonDataServiceForAppsEntityDataset": { + "x-ms-discriminator-value": "CommonDataServiceForAppsEntity", + "description": "The Common Data Service for Apps entity dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Common Data Service for Apps entity dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CommonDataServiceForAppsEntityDatasetTypeProperties" + } + } + }, + "CommonDataServiceForAppsEntityDatasetTypeProperties": { + "description": "Common Data Service for Apps entity dataset properties.", + "type": "object", + "properties": { + "entityName": { + "type": "object", + "description": "The logical name of the entity. Type: string (or Expression with resultType string)." + } + } + }, + "AzureDataLakeStoreDataset": { + "x-ms-discriminator-value": "AzureDataLakeStoreFile", + "description": "Azure Data Lake Store dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Data Lake Store dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureDataLakeStoreDatasetTypeProperties" + } + } + }, + "AzureDataLakeStoreDatasetTypeProperties": { + "description": "Azure Data Lake Store dataset properties.", + "type": "object", + "properties": { + "folderPath": { + "type": "object", + "description": "Path to the folder in the Azure Data Lake Store. Type: string (or Expression with resultType string)." + }, + "fileName": { + "type": "object", + "description": "The name of the file in the Azure Data Lake Store. Type: string (or Expression with resultType string)." + }, + "format": { + "description": "The format of the Data Lake Store.", + "$ref": "#/definitions/DatasetStorageFormat" + }, + "compression": { + "description": "The data compression method used for the item(s) in the Azure Data Lake Store.", + "$ref": "#/definitions/DatasetCompression" + } + } + }, + "AzureBlobFSDataset": { + "x-ms-discriminator-value": "AzureBlobFSFile", + "description": "The Azure Data Lake Storage Gen2 storage.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Data Lake Storage Gen2 dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureBlobFSDatasetTypeProperties" + } + } + }, + "AzureBlobFSDatasetTypeProperties": { + "description": "Azure Data Lake Storage Gen2 dataset properties.", + "type": "object", + "properties": { + "folderPath": { + "type": "object", + "description": "The path of the Azure Data Lake Storage Gen2 storage. Type: string (or Expression with resultType string)." + }, + "fileName": { + "type": "object", + "description": "The name of the Azure Data Lake Storage Gen2. Type: string (or Expression with resultType string)." + }, + "format": { + "description": "The format of the Azure Data Lake Storage Gen2 storage.", + "$ref": "#/definitions/DatasetStorageFormat" + }, + "compression": { + "description": "The data compression method used for the blob storage.", + "$ref": "#/definitions/DatasetCompression" + } + } + }, + "Office365Dataset": { + "x-ms-discriminator-value": "Office365Table", + "description": "The Office365 account.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Office365 dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/Office365DatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "Office365DatasetTypeProperties": { + "description": "Office365 dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "Name of the dataset to extract from Office 365. Type: string (or Expression with resultType string)." + }, + "predicate": { + "type": "object", + "description": "A predicate expression that can be used to filter the specific rows to extract from Office 365. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "tableName" + ] + }, + "FileShareDataset": { + "x-ms-discriminator-value": "FileShare", + "description": "An on-premises file system dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "On-premises file system dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/FileShareDatasetTypeProperties" + } + } + }, + "FileShareDatasetTypeProperties": { + "description": "On-premises file system dataset properties.", + "type": "object", + "properties": { + "folderPath": { + "type": "object", + "description": "The path of the on-premises file system. Type: string (or Expression with resultType string)." + }, + "fileName": { + "type": "object", + "description": "The name of the on-premises file system. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "format": { + "description": "The format of the files.", + "$ref": "#/definitions/DatasetStorageFormat" + }, + "fileFilter": { + "type": "object", + "description": "Specify a filter to be used to select a subset of files in the folderPath rather than all files. Type: string (or Expression with resultType string)." + }, + "compression": { + "description": "The data compression method used for the file system.", + "$ref": "#/definitions/DatasetCompression" + } + } + }, + "MongoDbCollectionDataset": { + "x-ms-discriminator-value": "MongoDbCollection", + "description": "The MongoDB database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "MongoDB database dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MongoDbCollectionDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MongoDbCollectionDatasetTypeProperties": { + "description": "MongoDB database dataset properties.", + "type": "object", + "properties": { + "collectionName": { + "type": "object", + "description": "The table name of the MongoDB database. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "collectionName" + ] + }, + "MongoDbAtlasCollectionDataset": { + "x-ms-discriminator-value": "MongoDbAtlasCollection", + "description": "The MongoDB Atlas database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "MongoDB Atlas database dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MongoDbAtlasCollectionDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MongoDbAtlasCollectionDatasetTypeProperties": { + "description": "MongoDB Atlas database dataset properties.", + "type": "object", + "properties": { + "collection": { + "type": "object", + "description": "The collection name of the MongoDB Atlas database. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "collection" + ] + }, + "MongoDbV2CollectionDataset": { + "x-ms-discriminator-value": "MongoDbV2Collection", + "description": "The MongoDB database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "MongoDB database dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MongoDbV2CollectionDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MongoDbV2CollectionDatasetTypeProperties": { + "description": "MongoDB database dataset properties.", + "type": "object", + "properties": { + "collection": { + "type": "object", + "description": "The collection name of the MongoDB database. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "collection" + ] + }, + "CosmosDbMongoDbApiCollectionDataset": { + "x-ms-discriminator-value": "CosmosDbMongoDbApiCollection", + "description": "The CosmosDB (MongoDB API) database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "CosmosDB (MongoDB API) database dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CosmosDbMongoDbApiCollectionDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "CosmosDbMongoDbApiCollectionDatasetTypeProperties": { + "description": "CosmosDB (MongoDB API) database dataset properties.", + "type": "object", + "properties": { + "collection": { + "type": "object", + "description": "The collection name of the CosmosDB (MongoDB API) database. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "collection" + ] + }, + "ODataResourceDataset": { + "x-ms-discriminator-value": "ODataResource", + "description": "The Open Data Protocol (OData) resource dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "OData dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ODataResourceDatasetTypeProperties" + } + } + }, + "ODataResourceDatasetTypeProperties": { + "description": "OData dataset properties.", + "type": "object", + "properties": { + "path": { + "type": "object", + "description": "The OData resource path. Type: string (or Expression with resultType string)." + } + } + }, + "OracleTableDataset": { + "x-ms-discriminator-value": "OracleTable", + "description": "The on-premises Oracle database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "On-premises Oracle dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/OracleTableDatasetTypeProperties" + } + } + }, + "OracleTableDatasetTypeProperties": { + "description": "On-premises Oracle dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "schema": { + "type": "object", + "description": "The schema name of the on-premises Oracle database. Type: string (or Expression with resultType string)." + }, + "table": { + "type": "object", + "description": "The table name of the on-premises Oracle database. Type: string (or Expression with resultType string)." + } + } + }, + "TeradataTableDataset": { + "x-ms-discriminator-value": "TeradataTable", + "description": "The Teradata database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Teradata dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/TeradataTableDatasetTypeProperties" + } + } + }, + "TeradataTableDatasetTypeProperties": { + "description": "Teradata dataset properties.", + "type": "object", + "properties": { + "database": { + "type": "object", + "description": "The database name of Teradata. Type: string (or Expression with resultType string)." + }, + "table": { + "type": "object", + "description": "The table name of Teradata. Type: string (or Expression with resultType string)." + } + } + }, + "AzureMySqlTableDataset": { + "x-ms-discriminator-value": "AzureMySqlTable", + "description": "The Azure MySQL database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Azure MySQL database dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureMySqlTableDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureMySqlTableDatasetTypeProperties": { + "description": "Azure MySQL database dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "The Azure MySQL database table name. Type: string (or Expression with resultType string)." + }, + "table": { + "type": "object", + "description": "The name of Azure MySQL database table. Type: string (or Expression with resultType string)." + } + } + }, + "AmazonRedshiftTableDataset": { + "x-ms-discriminator-value": "AmazonRedshiftTable", + "description": "The Amazon Redshift table dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Amazon Redshift table dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AmazonRedshiftTableDatasetTypeProperties" + } + } + }, + "AmazonRedshiftTableDatasetTypeProperties": { + "description": "Amazon Redshift table dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "table": { + "type": "object", + "description": "The Amazon Redshift table name. Type: string (or Expression with resultType string)." + }, + "schema": { + "type": "object", + "description": "The Amazon Redshift schema name. Type: string (or Expression with resultType string)." + } + } + }, + "Db2TableDataset": { + "x-ms-discriminator-value": "Db2Table", + "description": "The Db2 table dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Db2 table dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/Db2TableDatasetTypeProperties" + } + } + }, + "Db2TableDatasetTypeProperties": { + "description": "Db2 table dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "schema": { + "type": "object", + "description": "The Db2 schema name. Type: string (or Expression with resultType string)." + }, + "table": { + "type": "object", + "description": "The Db2 table name. Type: string (or Expression with resultType string)." + } + } + }, + "RelationalTableDataset": { + "x-ms-discriminator-value": "RelationalTable", + "description": "The relational table dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Relational table dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/RelationalTableDatasetTypeProperties" + } + } + }, + "RelationalTableDatasetTypeProperties": { + "description": "Relational table dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "The relational table name. Type: string (or Expression with resultType string)." + } + } + }, + "InformixTableDataset": { + "x-ms-discriminator-value": "InformixTable", + "description": "The Informix table dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Informix table dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/InformixTableDatasetTypeProperties" + } + } + }, + "InformixTableDatasetTypeProperties": { + "description": "Informix table dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "The Informix table name. Type: string (or Expression with resultType string)." + } + } + }, + "OdbcTableDataset": { + "x-ms-discriminator-value": "OdbcTable", + "description": "The ODBC table dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "ODBC table dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/OdbcTableDatasetTypeProperties" + } + } + }, + "OdbcTableDatasetTypeProperties": { + "description": "ODBC table dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "The ODBC table name. Type: string (or Expression with resultType string)." + } + } + }, + "MySqlTableDataset": { + "x-ms-discriminator-value": "MySqlTable", + "description": "The MySQL table dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "MySQL table dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MySqlTableDatasetTypeProperties" + } + } + }, + "MySqlTableDatasetTypeProperties": { + "description": "MySql table dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "The MySQL table name. Type: string (or Expression with resultType string)." + } + } + }, + "PostgreSqlTableDataset": { + "x-ms-discriminator-value": "PostgreSqlTable", + "description": "The PostgreSQL table dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "PostgreSQL table dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PostgreSqlTableDatasetTypeProperties" + } + } + }, + "PostgreSqlTableDatasetTypeProperties": { + "description": "PostgreSQL table dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "table": { + "type": "object", + "description": "The PostgreSQL table name. Type: string (or Expression with resultType string)." + }, + "schema": { + "type": "object", + "description": "The PostgreSQL schema name. Type: string (or Expression with resultType string)." + } + } + }, + "MicrosoftAccessTableDataset": { + "x-ms-discriminator-value": "MicrosoftAccessTable", + "description": "The Microsoft Access table dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Microsoft Access table dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MicrosoftAccessTableDatasetTypeProperties" + } + } + }, + "MicrosoftAccessTableDatasetTypeProperties": { + "description": "Microsoft Access table dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "The Microsoft Access table name. Type: string (or Expression with resultType string)." + } + } + }, + "SalesforceObjectDataset": { + "x-ms-discriminator-value": "SalesforceObject", + "description": "The Salesforce object dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Salesforce object dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SalesforceObjectDatasetTypeProperties" + } + } + }, + "SalesforceObjectDatasetTypeProperties": { + "description": "Salesforce object dataset properties.", + "type": "object", + "properties": { + "objectApiName": { + "type": "object", + "description": "The Salesforce object API name. Type: string (or Expression with resultType string)." + } + } + }, + "SalesforceServiceCloudObjectDataset": { + "x-ms-discriminator-value": "SalesforceServiceCloudObject", + "description": "The Salesforce Service Cloud object dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Salesforce Service Cloud object dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SalesforceServiceCloudObjectDatasetTypeProperties" + } + } + }, + "SalesforceServiceCloudObjectDatasetTypeProperties": { + "description": "Salesforce Service Cloud object dataset properties.", + "type": "object", + "properties": { + "objectApiName": { + "type": "object", + "description": "The Salesforce Service Cloud object API name. Type: string (or Expression with resultType string)." + } + } + }, + "SybaseTableDataset": { + "x-ms-discriminator-value": "SybaseTable", + "description": "The Sybase table dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Sybase table dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SybaseTableDatasetTypeProperties" + } + } + }, + "SybaseTableDatasetTypeProperties": { + "description": "Sybase table dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "The Sybase table name. Type: string (or Expression with resultType string)." + } + } + }, + "SapBwCubeDataset": { + "x-ms-discriminator-value": "SapBwCube", + "description": "The SAP BW cube dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": {} + }, + "SapCloudForCustomerResourceDataset": { + "x-ms-discriminator-value": "SapCloudForCustomerResource", + "description": "The path of the SAP Cloud for Customer OData entity.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "SAP Cloud For Customer OData resource dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SapCloudForCustomerResourceDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SapCloudForCustomerResourceDatasetTypeProperties": { + "description": "Sap Cloud For Customer OData resource dataset properties.", + "type": "object", + "properties": { + "path": { + "type": "object", + "description": "The path of the SAP Cloud for Customer OData entity. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "path" + ] + }, + "SapEccResourceDataset": { + "x-ms-discriminator-value": "SapEccResource", + "description": "The path of the SAP ECC OData entity.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "SAP ECC OData resource dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SapEccResourceDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SapEccResourceDatasetTypeProperties": { + "description": "Sap ECC OData resource dataset properties.", + "type": "object", + "properties": { + "path": { + "type": "object", + "description": "The path of the SAP ECC OData entity. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "path" + ] + }, + "SapHanaTableDataset": { + "x-ms-discriminator-value": "SapHanaTable", + "description": "SAP HANA Table properties.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "SAP HANA Table properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SapHanaTableDatasetTypeProperties" + } + } + }, + "SapHanaTableDatasetTypeProperties": { + "description": "SAP HANA Table properties.", + "type": "object", + "properties": { + "schema": { + "type": "object", + "description": "The schema name of SAP HANA. Type: string (or Expression with resultType string)." + }, + "table": { + "type": "object", + "description": "The table name of SAP HANA. Type: string (or Expression with resultType string)." + } + } + }, + "SapOpenHubTableDataset": { + "x-ms-discriminator-value": "SapOpenHubTable", + "description": "Sap Business Warehouse Open Hub Destination Table properties.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Sap Business Warehouse Open Hub Destination Table properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SapOpenHubTableDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SapOpenHubTableDatasetTypeProperties": { + "description": "Sap Business Warehouse Open Hub Destination Table properties.", + "type": "object", + "properties": { + "openHubDestinationName": { + "type": "object", + "description": "The name of the Open Hub Destination with destination type as Database Table. Type: string (or Expression with resultType string)." + }, + "excludeLastRequest": { + "type": "object", + "description": "Whether to exclude the records of the last request. The default value is true. Type: boolean (or Expression with resultType boolean)." + }, + "baseRequestId": { + "type": "object", + "description": "The ID of request for delta loading. Once it is set, only data with requestId larger than the value of this property will be retrieved. The default value is 0. Type: integer (or Expression with resultType integer )." + } + }, + "required": [ + "openHubDestinationName" + ] + }, + "SqlServerTableDataset": { + "x-ms-discriminator-value": "SqlServerTable", + "description": "The on-premises SQL Server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "On-premises SQL Server dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SqlServerTableDatasetTypeProperties" + } + } + }, + "SqlServerTableDatasetTypeProperties": { + "description": "On-premises SQL Server dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "schema": { + "type": "object", + "description": "The schema name of the SQL Server dataset. Type: string (or Expression with resultType string)." + }, + "table": { + "type": "object", + "description": "The table name of the SQL Server dataset. Type: string (or Expression with resultType string)." + } + } + }, + "RestResourceDataset": { + "x-ms-discriminator-value": "RestResource", + "description": "A Rest service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/RestResourceDatasetTypeProperties" + } + } + }, + "RestResourceDatasetTypeProperties": { + "description": "Properties specific to this dataset type.", + "type": "object", + "properties": { + "relativeUrl": { + "type": "object", + "description": "The relative URL to the resource that the RESTful API provides. Type: string (or Expression with resultType string)." + }, + "requestMethod": { + "type": "object", + "description": "The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string)." + }, + "requestBody": { + "type": "object", + "description": "The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string)." + }, + "additionalHeaders": { + "type": "object", + "description": "The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string)." + }, + "paginationRules": { + "type": "object", + "description": "The pagination rules to compose next page requests. Type: string (or Expression with resultType string)." + } + } + }, + "SapTableResourceDataset": { + "x-ms-discriminator-value": "SapTableResource", + "description": "SAP Table Resource properties.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "SAP Table Resource properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SapTableResourceDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SapTableResourceDatasetTypeProperties": { + "description": "SAP Table Resource properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "The name of the SAP Table. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "tableName" + ] + }, + "WebTableDataset": { + "x-ms-discriminator-value": "WebTable", + "description": "The dataset points to a HTML table in the web page.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Web table dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WebTableDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "WebTableDatasetTypeProperties": { + "description": "Web table dataset properties.", + "type": "object", + "properties": { + "index": { + "type": "object", + "description": "The zero-based index of the table in the web page. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "path": { + "type": "object", + "description": "The relative URL to the web page from the linked service URL. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "index" + ] + }, + "AzureSearchIndexDataset": { + "x-ms-discriminator-value": "AzureSearchIndex", + "description": "The Azure Search Index.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureSearchIndexDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureSearchIndexDatasetTypeProperties": { + "description": "Properties specific to this dataset type.", + "type": "object", + "properties": { + "indexName": { + "type": "object", + "description": "The name of the Azure Search Index. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "indexName" + ] + }, + "HttpDataset": { + "x-ms-discriminator-value": "HttpFile", + "description": "A file in an HTTP web server.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HttpDatasetTypeProperties" + } + } + }, + "HttpDatasetTypeProperties": { + "description": "Properties specific to this dataset type.", + "type": "object", + "properties": { + "relativeUrl": { + "type": "object", + "description": "The relative URL based on the URL in the HttpLinkedService refers to an HTTP file Type: string (or Expression with resultType string)." + }, + "requestMethod": { + "type": "object", + "description": "The HTTP method for the HTTP request. Type: string (or Expression with resultType string)." + }, + "requestBody": { + "type": "object", + "description": "The body for the HTTP request. Type: string (or Expression with resultType string)." + }, + "additionalHeaders": { + "type": "object", + "description": "The headers for the HTTP Request. e.g. request-header-name-1:request-header-value-1\r\n...\r\nrequest-header-name-n:request-header-value-n Type: string (or Expression with resultType string)." + }, + "format": { + "description": "The format of files.", + "$ref": "#/definitions/DatasetStorageFormat" + }, + "compression": { + "description": "The data compression method used on files.", + "$ref": "#/definitions/DatasetCompression" + } + } + }, + "GenericDatasetTypeProperties": { + "description": "Properties specific to this dataset type.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "The table name. Type: string (or Expression with resultType string)." + } + } + }, + "AmazonMWSObjectDataset": { + "x-ms-discriminator-value": "AmazonMWSObject", + "description": "Amazon Marketplace Web Service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "AzurePostgreSqlTableDataset": { + "x-ms-discriminator-value": "AzurePostgreSqlTable", + "description": "Azure PostgreSQL dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzurePostgreSqlTableDatasetTypeProperties" + } + } + }, + "AzurePostgreSqlTableDatasetTypeProperties": { + "description": "Azure PostgreSQL dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "The table name of the Azure PostgreSQL database which includes both schema and table. Type: string (or Expression with resultType string)." + }, + "table": { + "type": "object", + "description": "The table name of the Azure PostgreSQL database. Type: string (or Expression with resultType string)." + }, + "schema": { + "type": "object", + "description": "The schema name of the Azure PostgreSQL database. Type: string (or Expression with resultType string)." + } + } + }, + "ConcurObjectDataset": { + "x-ms-discriminator-value": "ConcurObject", + "description": "Concur Service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "CouchbaseTableDataset": { + "x-ms-discriminator-value": "CouchbaseTable", + "description": "Couchbase server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "DrillTableDataset": { + "x-ms-discriminator-value": "DrillTable", + "description": "Drill server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DrillDatasetTypeProperties" + } + } + }, + "DrillDatasetTypeProperties": { + "description": "Drill Dataset Properties", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "table": { + "type": "object", + "description": "The table name of the Drill. Type: string (or Expression with resultType string)." + }, + "schema": { + "type": "object", + "description": "The schema name of the Drill. Type: string (or Expression with resultType string)." + } + } + }, + "EloquaObjectDataset": { + "x-ms-discriminator-value": "EloquaObject", + "description": "Eloqua server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "GoogleBigQueryObjectDataset": { + "x-ms-discriminator-value": "GoogleBigQueryObject", + "description": "Google BigQuery service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GoogleBigQueryDatasetTypeProperties" + } + } + }, + "GoogleBigQueryDatasetTypeProperties": { + "description": "Google BigQuery Dataset Properties", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using database + table properties instead." + }, + "table": { + "type": "object", + "description": "The table name of the Google BigQuery. Type: string (or Expression with resultType string)." + }, + "dataset": { + "type": "object", + "description": "The database name of the Google BigQuery. Type: string (or Expression with resultType string)." + } + } + }, + "GreenplumTableDataset": { + "x-ms-discriminator-value": "GreenplumTable", + "description": "Greenplum Database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GreenplumDatasetTypeProperties" + } + } + }, + "GreenplumDatasetTypeProperties": { + "description": "Greenplum Dataset Properties", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "table": { + "type": "object", + "description": "The table name of Greenplum. Type: string (or Expression with resultType string)." + }, + "schema": { + "type": "object", + "description": "The schema name of Greenplum. Type: string (or Expression with resultType string)." + } + } + }, + "HBaseObjectDataset": { + "x-ms-discriminator-value": "HBaseObject", + "description": "HBase server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "HiveObjectDataset": { + "x-ms-discriminator-value": "HiveObject", + "description": "Hive Server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HiveDatasetTypeProperties" + } + } + }, + "HiveDatasetTypeProperties": { + "description": "Hive Properties", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "table": { + "type": "object", + "description": "The table name of the Hive. Type: string (or Expression with resultType string)." + }, + "schema": { + "type": "object", + "description": "The schema name of the Hive. Type: string (or Expression with resultType string)." + } + } + }, + "HubspotObjectDataset": { + "x-ms-discriminator-value": "HubspotObject", + "description": "Hubspot Service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "ImpalaObjectDataset": { + "x-ms-discriminator-value": "ImpalaObject", + "description": "Impala server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImpalaDatasetTypeProperties" + } + } + }, + "ImpalaDatasetTypeProperties": { + "description": "Impala Dataset Properties", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "table": { + "type": "object", + "description": "The table name of the Impala. Type: string (or Expression with resultType string)." + }, + "schema": { + "type": "object", + "description": "The schema name of the Impala. Type: string (or Expression with resultType string)." + } + } + }, + "JiraObjectDataset": { + "x-ms-discriminator-value": "JiraObject", + "description": "Jira Service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "MagentoObjectDataset": { + "x-ms-discriminator-value": "MagentoObject", + "description": "Magento server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "MariaDBTableDataset": { + "x-ms-discriminator-value": "MariaDBTable", + "description": "MariaDB server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "AzureMariaDBTableDataset": { + "x-ms-discriminator-value": "AzureMariaDBTable", + "description": "Azure Database for MariaDB dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "MarketoObjectDataset": { + "x-ms-discriminator-value": "MarketoObject", + "description": "Marketo server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "PaypalObjectDataset": { + "x-ms-discriminator-value": "PaypalObject", + "description": "Paypal Service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "PhoenixObjectDataset": { + "x-ms-discriminator-value": "PhoenixObject", + "description": "Phoenix server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PhoenixDatasetTypeProperties" + } + } + }, + "PhoenixDatasetTypeProperties": { + "description": "Phoenix Dataset Properties", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "table": { + "type": "object", + "description": "The table name of the Phoenix. Type: string (or Expression with resultType string)." + }, + "schema": { + "type": "object", + "description": "The schema name of the Phoenix. Type: string (or Expression with resultType string)." + } + } + }, + "PrestoObjectDataset": { + "x-ms-discriminator-value": "PrestoObject", + "description": "Presto server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrestoDatasetTypeProperties" + } + } + }, + "PrestoDatasetTypeProperties": { + "description": "Presto Dataset Properties", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "table": { + "type": "object", + "description": "The table name of the Presto. Type: string (or Expression with resultType string)." + }, + "schema": { + "type": "object", + "description": "The schema name of the Presto. Type: string (or Expression with resultType string)." + } + } + }, + "QuickBooksObjectDataset": { + "x-ms-discriminator-value": "QuickBooksObject", + "description": "QuickBooks server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "ServiceNowObjectDataset": { + "x-ms-discriminator-value": "ServiceNowObject", + "description": "ServiceNow server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "ShopifyObjectDataset": { + "x-ms-discriminator-value": "ShopifyObject", + "description": "Shopify Service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "SparkObjectDataset": { + "x-ms-discriminator-value": "SparkObject", + "description": "Spark Server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SparkDatasetTypeProperties" + } + } + }, + "SparkDatasetTypeProperties": { + "description": "Spark Properties", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "table": { + "type": "object", + "description": "The table name of the Spark. Type: string (or Expression with resultType string)." + }, + "schema": { + "type": "object", + "description": "The schema name of the Spark. Type: string (or Expression with resultType string)." + } + } + }, + "SquareObjectDataset": { + "x-ms-discriminator-value": "SquareObject", + "description": "Square Service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "XeroObjectDataset": { + "x-ms-discriminator-value": "XeroObject", + "description": "Xero Service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "ZohoObjectDataset": { + "x-ms-discriminator-value": "ZohoObject", + "description": "Zoho server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "NetezzaTableDataset": { + "x-ms-discriminator-value": "NetezzaTable", + "description": "Netezza dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetezzaTableDatasetTypeProperties" + } + } + }, + "NetezzaTableDatasetTypeProperties": { + "description": "Netezza dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "table": { + "type": "object", + "description": "The table name of the Netezza. Type: string (or Expression with resultType string)." + }, + "schema": { + "type": "object", + "description": "The schema name of the Netezza. Type: string (or Expression with resultType string)." + } + } + }, + "VerticaTableDataset": { + "x-ms-discriminator-value": "VerticaTable", + "description": "Vertica dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/VerticaDatasetTypeProperties" + } + } + }, + "VerticaDatasetTypeProperties": { + "description": "Vertica Properties", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "table": { + "type": "object", + "description": "The table name of the Vertica. Type: string (or Expression with resultType string)." + }, + "schema": { + "type": "object", + "description": "The schema name of the Vertica. Type: string (or Expression with resultType string)." + } + } + }, + "SalesforceMarketingCloudObjectDataset": { + "x-ms-discriminator-value": "SalesforceMarketingCloudObject", + "description": "Salesforce Marketing Cloud dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "ResponsysObjectDataset": { + "x-ms-discriminator-value": "ResponsysObject", + "description": "Responsys dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "DynamicsAXResourceDataset": { + "x-ms-discriminator-value": "DynamicsAXResource", + "description": "The path of the Dynamics AX OData entity.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Dynamics AX OData resource dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DynamicsAXResourceDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DynamicsAXResourceDatasetTypeProperties": { + "description": "Dynamics AX OData resource dataset properties.", + "type": "object", + "properties": { + "path": { + "type": "object", + "description": "The path of the Dynamics AX OData entity. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "path" + ] + }, + "OracleServiceCloudObjectDataset": { + "x-ms-discriminator-value": "OracleServiceCloudObject", + "description": "Oracle Service Cloud dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "AzureDataExplorerTableDataset": { + "x-ms-discriminator-value": "AzureDataExplorerTable", + "description": "The Azure Data Explorer (Kusto) dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Data Explorer (Kusto) dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureDataExplorerDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureDataExplorerDatasetTypeProperties": { + "description": "Azure Data Explorer (Kusto) dataset properties.", + "type": "object", + "properties": { + "table": { + "type": "object", + "description": "The table name of the Azure Data Explorer database. Type: string (or Expression with resultType string)." + } + } + }, + "GoogleAdWordsObjectDataset": { + "x-ms-discriminator-value": "GoogleAdWordsObject", + "description": "Google AdWords service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "SnowflakeDataset": { + "x-ms-discriminator-value": "SnowflakeTable", + "description": "The snowflake dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Snowflake dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SnowflakeDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SnowflakeDatasetTypeProperties": { + "description": "Snowflake dataset properties.", + "type": "object", + "properties": { + "schema": { + "type": "object", + "description": "The schema name of the Snowflake database. Type: string (or Expression with resultType string)." + }, + "table": { + "type": "object", + "description": "The table name of the Snowflake database. Type: string (or Expression with resultType string)." + } + } + }, + "SharePointOnlineListResourceDataset": { + "x-ms-discriminator-value": "SharePointOnlineListResource", + "description": "The sharepoint online list resource dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Sharepoint online list dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SharePointOnlineListDatasetTypeProperties" + } + } + }, + "SharePointOnlineListDatasetTypeProperties": { + "description": "Sharepoint online list dataset properties.", + "type": "object", + "properties": { + "listName": { + "type": "object", + "description": "The name of the SharePoint Online list. Type: string (or Expression with resultType string)." + } + } + }, + "AzureDatabricksDeltaLakeDataset": { + "x-ms-discriminator-value": "AzureDatabricksDeltaLakeDataset", + "description": "Azure Databricks Delta Lake dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureDatabricksDeltaLakeDatasetTypeProperties" + } + } + }, + "AzureDatabricksDeltaLakeDatasetTypeProperties": { + "description": "Azure Databricks Delta Lake Dataset Properties", + "type": "object", + "properties": { + "table": { + "type": "object", + "description": "The name of delta table. Type: string (or Expression with resultType string)." + }, + "database": { + "type": "object", + "description": "The database name of delta table. Type: string (or Expression with resultType string)." + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/LinkedService.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/LinkedService.json new file mode 100644 index 000000000000..dc98fc02f422 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/LinkedService.json @@ -0,0 +1,6087 @@ +{ + "swagger": "2.0", + "info": { + "title": "ArtifactsClient", + "version": "2021-06-01-preview" + }, + "paths": {}, + "definitions": { + "LinkedService": { + "description": "The Azure Synapse nested object which contains the information and credential which can be used to connect with related store or compute resource.", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Type of linked service." + }, + "connectVia": { + "description": "The integration runtime reference.", + "$ref": "../artifacts.json#/definitions/IntegrationRuntimeReference" + }, + "description": { + "description": "Linked service description.", + "type": "string" + }, + "parameters": { + "$ref": "../artifacts.json#/definitions/ParameterDefinitionSpecification", + "description": "Parameters for linked service." + }, + "annotations": { + "description": "List of tags that can be used for describing the linked service.", + "type": "array", + "items": { + "type": "object" + } + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "AzureStorageLinkedService": { + "x-ms-discriminator-value": "AzureStorage", + "description": "The storage account linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Storage linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureStorageLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureBlobStorageLinkedService": { + "x-ms-discriminator-value": "AzureBlobStorage", + "description": "The azure blob storage linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Blob Storage linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureBlobStorageLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureTableStorageLinkedService": { + "x-ms-discriminator-value": "AzureTableStorage", + "description": "The azure table storage linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Table Storage linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureStorageLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureStorageLinkedServiceTypeProperties": { + "description": "Azure Storage linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "accountKey": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of accountKey in connection string." + }, + "sasUri": { + "description": "SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "sasToken": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of sasToken in sas uri." + }, + "encryptedCredential": { + "type": "string", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + } + }, + "AzureBlobStorageLinkedServiceTypeProperties": { + "description": "Azure Blob Storage linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "type": "object", + "description": "The connection string. It is mutually exclusive with sasUri, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference." + }, + "accountKey": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of accountKey in connection string." + }, + "sasUri": { + "description": "SAS URI of the Azure Blob Storage resource. It is mutually exclusive with connectionString, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "sasToken": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of sasToken in sas uri." + }, + "serviceEndpoint": { + "type": "string", + "description": "Blob service endpoint of the Azure Blob Storage resource. It is mutually exclusive with connectionString, sasUri property." + }, + "servicePrincipalId": { + "type": "object", + "description": "The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The key of the service principal used to authenticate against Azure SQL Data Warehouse." + }, + "tenant": { + "type": "object", + "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." + }, + "azureCloudType": { + "type": "object", + "description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "string", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + } + }, + "AzureSqlDWLinkedService": { + "x-ms-discriminator-value": "AzureSqlDW", + "description": "Azure SQL Data Warehouse linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure SQL Data Warehouse linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureSqlDWLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureSqlDWLinkedServiceTypeProperties": { + "description": "Azure SQL Data Warehouse linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "password": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, + "servicePrincipalId": { + "type": "object", + "description": "The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The key of the service principal used to authenticate against Azure SQL Data Warehouse." + }, + "tenant": { + "type": "object", + "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." + }, + "azureCloudType": { + "type": "object", + "description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "SqlServerLinkedService": { + "x-ms-discriminator-value": "SqlServer", + "description": "SQL Server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "SQL Server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SqlServerLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SqlServerLinkedServiceTypeProperties": { + "description": "SQL Server linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "userName": { + "type": "object", + "description": "The on-premises Windows authentication user name. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "The on-premises Windows authentication password.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "AzureSqlDatabaseLinkedService": { + "x-ms-discriminator-value": "AzureSqlDatabase", + "description": "Microsoft Azure SQL Database linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure SQL Database linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureSqlDatabaseLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureSqlDatabaseLinkedServiceTypeProperties": { + "description": "Azure SQL Database linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "password": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, + "servicePrincipalId": { + "type": "object", + "description": "The ID of the service principal used to authenticate against Azure SQL Database. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The key of the service principal used to authenticate against Azure SQL Database." + }, + "tenant": { + "type": "object", + "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." + }, + "azureCloudType": { + "type": "object", + "description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "AzureSqlMILinkedService": { + "x-ms-discriminator-value": "AzureSqlMI", + "description": "Azure SQL Managed Instance linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure SQL Managed Instance linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureSqlMILinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureSqlMILinkedServiceTypeProperties": { + "description": "Azure SQL Managed Instance linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "password": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, + "servicePrincipalId": { + "type": "object", + "description": "The ID of the service principal used to authenticate against Azure SQL Managed Instance. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The key of the service principal used to authenticate against Azure SQL Managed Instance." + }, + "tenant": { + "type": "object", + "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." + }, + "azureCloudType": { + "type": "object", + "description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "AzureBatchLinkedService": { + "x-ms-discriminator-value": "AzureBatch", + "description": "Azure Batch linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Batch linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureBatchLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureBatchLinkedServiceTypeProperties": { + "description": "Azure Batch linked service properties.", + "type": "object", + "properties": { + "accountName": { + "type": "object", + "description": "The Azure Batch account name. Type: string (or Expression with resultType string)." + }, + "accessKey": { + "description": "The Azure Batch account access key.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "batchUri": { + "type": "object", + "description": "The Azure Batch URI. Type: string (or Expression with resultType string)." + }, + "poolName": { + "type": "object", + "description": "The Azure Batch pool name. Type: string (or Expression with resultType string)." + }, + "linkedServiceName": { + "description": "The Azure Storage linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "accountName", + "batchUri", + "poolName", + "linkedServiceName" + ] + }, + "AzureKeyVaultLinkedService": { + "x-ms-discriminator-value": "AzureKeyVault", + "description": "Azure Key Vault linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Key Vault linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureKeyVaultLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureKeyVaultLinkedServiceTypeProperties": { + "description": "Azure Key Vault linked service properties.", + "type": "object", + "properties": { + "baseUrl": { + "type": "object", + "description": "The base URL of the Azure Key Vault. e.g. https://myakv.vault.azure.net Type: string (or Expression with resultType string)." + } + }, + "required": [ + "baseUrl" + ] + }, + "CosmosDbLinkedService": { + "x-ms-discriminator-value": "CosmosDb", + "description": "Microsoft Azure Cosmos Database (CosmosDB) linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "CosmosDB linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CosmosDbLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "CosmosDbLinkedServiceTypeProperties": { + "description": "CosmosDB linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "accountEndpoint": { + "description": "The endpoint of the Azure CosmosDB account. Type: string (or Expression with resultType string)", + "type": "object" + }, + "database": { + "description": "The name of the database. Type: string (or Expression with resultType string)", + "type": "object" + }, + "accountKey": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The account key of the Azure CosmosDB account. Type: SecureString or AzureKeyVaultSecretReference." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + } + }, + "DynamicsLinkedService": { + "x-ms-discriminator-value": "Dynamics", + "description": "Dynamics linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Dynamics linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DynamicsLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DynamicsLinkedServiceTypeProperties": { + "description": "Dynamics linked service properties.", + "type": "object", + "properties": { + "deploymentType": { + "x-ms-enum": { + "name": "DynamicsDeploymentType", + "modelAsString": true + }, + "enum": [ + "Online", + "OnPremisesWithIfd" + ], + "type": "string", + "description": "The deployment type of the Dynamics instance. 'Online' for Dynamics Online and 'OnPremisesWithIfd' for Dynamics on-premises with Ifd. Type: string (or Expression with resultType string)." + }, + "hostName": { + "type": "object", + "description": "The host name of the on-premises Dynamics server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string)." + }, + "port": { + "type": "object", + "description": "The port of on-premises Dynamics server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "serviceUri": { + "type": "object", + "description": "The URL to the Microsoft Dynamics server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string)." + }, + "organizationName": { + "type": "object", + "description": "The organization name of the Dynamics instance. The property is required for on-prem and required for online when there are more than one Dynamics instances associated with the user. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "x-ms-enum": { + "name": "DynamicsAuthenticationType", + "modelAsString": true + }, + "enum": [ + "Office365", + "Ifd", + "AADServicePrincipal" + ], + "type": "string", + "description": "The authentication type to connect to Dynamics server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string)." + }, + "username": { + "type": "object", + "description": "User name to access the Dynamics instance. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password to access the Dynamics instance.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "servicePrincipalId": { + "type": "object", + "description": "The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string)." + }, + "servicePrincipalCredentialType": { + "x-ms-enum": { + "name": "DynamicsServicePrincipalCredentialType", + "modelAsString": true + }, + "enum": [ + "ServicePrincipalKey", + "ServicePrincipalCert" + ], + "type": "object", + "description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)." + }, + "servicePrincipalCredential": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "deploymentType", + "authenticationType" + ] + }, + "DynamicsCrmLinkedService": { + "x-ms-discriminator-value": "DynamicsCrm", + "description": "Dynamics CRM linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Dynamics CRM linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DynamicsCrmLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DynamicsCrmLinkedServiceTypeProperties": { + "description": "Dynamics CRM linked service properties.", + "type": "object", + "properties": { + "deploymentType": { + "x-ms-enum": { + "name": "DynamicsDeploymentType", + "modelAsString": true + }, + "enum": [ + "Online", + "OnPremisesWithIfd" + ], + "type": "string", + "description": "The deployment type of the Dynamics CRM instance. 'Online' for Dynamics CRM Online and 'OnPremisesWithIfd' for Dynamics CRM on-premises with Ifd. Type: string (or Expression with resultType string)." + }, + "hostName": { + "type": "object", + "description": "The host name of the on-premises Dynamics CRM server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string)." + }, + "port": { + "type": "object", + "description": "The port of on-premises Dynamics CRM server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "serviceUri": { + "type": "object", + "description": "The URL to the Microsoft Dynamics CRM server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string)." + }, + "organizationName": { + "type": "object", + "description": "The organization name of the Dynamics CRM instance. The property is required for on-prem and required for online when there are more than one Dynamics CRM instances associated with the user. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "x-ms-enum": { + "name": "DynamicsAuthenticationType", + "modelAsString": true + }, + "enum": [ + "Office365", + "Ifd", + "AADServicePrincipal" + ], + "type": "string", + "description": "The authentication type to connect to Dynamics CRM server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string)." + }, + "username": { + "type": "object", + "description": "User name to access the Dynamics CRM instance. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password to access the Dynamics CRM instance.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "servicePrincipalId": { + "type": "object", + "description": "The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string)." + }, + "servicePrincipalCredentialType": { + "type": "object", + "description": "A string from ServicePrincipalCredentialEnum or an expression" + }, + "servicePrincipalCredential": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "deploymentType", + "authenticationType" + ] + }, + "ServicePrincipalCredentialEnum": { + "x-ms-enum": { + "name": "DynamicsServicePrincipalCredentialType", + "modelAsString": true + }, + "enum": [ + "ServicePrincipalKey", + "ServicePrincipalCert" + ], + "type": "object", + "description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)." + }, + "CommonDataServiceForAppsLinkedService": { + "x-ms-discriminator-value": "CommonDataServiceForApps", + "description": "Common Data Service for Apps linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Common Data Service for Apps linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CommonDataServiceForAppsLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "CommonDataServiceForAppsLinkedServiceTypeProperties": { + "description": "Common Data Service for Apps linked service properties.", + "type": "object", + "properties": { + "deploymentType": { + "x-ms-enum": { + "name": "DynamicsDeploymentType", + "modelAsString": true + }, + "enum": [ + "Online", + "OnPremisesWithIfd" + ], + "type": "string", + "description": "The deployment type of the Common Data Service for Apps instance. 'Online' for Common Data Service for Apps Online and 'OnPremisesWithIfd' for Common Data Service for Apps on-premises with Ifd. Type: string (or Expression with resultType string)." + }, + "hostName": { + "type": "object", + "description": "The host name of the on-premises Common Data Service for Apps server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string)." + }, + "port": { + "type": "object", + "description": "The port of on-premises Common Data Service for Apps server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "serviceUri": { + "type": "object", + "description": "The URL to the Microsoft Common Data Service for Apps server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string)." + }, + "organizationName": { + "type": "object", + "description": "The organization name of the Common Data Service for Apps instance. The property is required for on-prem and required for online when there are more than one Common Data Service for Apps instances associated with the user. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "x-ms-enum": { + "name": "DynamicsAuthenticationType", + "modelAsString": true + }, + "enum": [ + "Office365", + "Ifd", + "AADServicePrincipal" + ], + "type": "string", + "description": "The authentication type to connect to Common Data Service for Apps server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario. 'AADServicePrincipal' for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string)." + }, + "username": { + "type": "object", + "description": "User name to access the Common Data Service for Apps instance. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password to access the Common Data Service for Apps instance.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "servicePrincipalId": { + "type": "object", + "description": "The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string)." + }, + "servicePrincipalCredentialType": { + "type": "object", + "description": "A string from ServicePrincipalCredentialEnum or an expression" + }, + "servicePrincipalCredential": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "deploymentType", + "authenticationType" + ] + }, + "HDInsightLinkedService": { + "x-ms-discriminator-value": "HDInsight", + "description": "HDInsight linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "HDInsight linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HDInsightLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightLinkedServiceTypeProperties": { + "description": "HDInsight linked service properties.", + "type": "object", + "properties": { + "clusterUri": { + "type": "object", + "description": "HDInsight cluster URI. Type: string (or Expression with resultType string)." + }, + "userName": { + "type": "object", + "description": "HDInsight cluster user name. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "HDInsight cluster password.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "linkedServiceName": { + "description": "The Azure Storage linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "hcatalogLinkedServiceName": { + "description": "A reference to the Azure SQL linked service that points to the HCatalog database.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + }, + "isEspEnabled": { + "type": "object", + "description": "Specify if the HDInsight is created with ESP (Enterprise Security Package). Type: Boolean." + }, + "fileSystem": { + "type": "object", + "description": "Specify the FileSystem if the main storage for the HDInsight is ADLS Gen2. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "clusterUri" + ] + }, + "FileServerLinkedService": { + "x-ms-discriminator-value": "FileServer", + "description": "File system linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "File system linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/FileServerLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "FileServerLinkedServiceTypeProperties": { + "description": "File system linked service properties.", + "type": "object", + "properties": { + "host": { + "type": "object", + "description": "Host name of the server. Type: string (or Expression with resultType string)." + }, + "userId": { + "type": "object", + "description": "User ID to logon the server. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password to logon the server.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "host" + ] + }, + "AzureFileStorageLinkedService": { + "x-ms-discriminator-value": "AzureFileStorage", + "description": "Azure File Storage linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure File Storage linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFileStorageLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureFileStorageLinkedServiceTypeProperties": { + "description": "Azure File Storage linked service properties.", + "type": "object", + "properties": { + "host": { + "type": "object", + "description": "Host name of the server. Type: string (or Expression with resultType string)." + }, + "userId": { + "type": "object", + "description": "User ID to logon the server. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password to logon the server.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "connectionString": { + "type": "object", + "description": "The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference." + }, + "accountKey": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of accountKey in connection string." + }, + "sasUri": { + "description": "SAS URI of the Azure File resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "sasToken": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of sasToken in sas uri." + }, + "fileShare": { + "description": "The azure file share name. It is required when auth with accountKey/sasToken. Type: string (or Expression with resultType string).", + "type": "object" + }, + "snapshot": { + "description": "The azure file share snapshot version. Type: string (or Expression with resultType string).", + "type": "object" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "host" + ] + }, + "GoogleCloudStorageLinkedService": { + "x-ms-discriminator-value": "GoogleCloudStorage", + "description": "Linked service for Google Cloud Storage.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Google Cloud Storage linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GoogleCloudStorageLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "GoogleCloudStorageLinkedServiceTypeProperties": { + "description": "Google Cloud Storage linked service properties.", + "type": "object", + "properties": { + "accessKeyId": { + "type": "object", + "description": "The access key identifier of the Google Cloud Storage Identity and Access Management (IAM) user. Type: string (or Expression with resultType string)." + }, + "secretAccessKey": { + "description": "The secret access key of the Google Cloud Storage Identity and Access Management (IAM) user.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "serviceUrl": { + "type": "object", + "description": "This value specifies the endpoint to access with the Google Cloud Storage Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + } + }, + "OracleLinkedService": { + "x-ms-discriminator-value": "Oracle", + "description": "Oracle database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Oracle database linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/OracleLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "OracleLinkedServiceTypeProperties": { + "description": "Oracle database linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "password": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "AzureMySqlLinkedService": { + "x-ms-discriminator-value": "AzureMySql", + "description": "Azure MySQL database linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure MySQL database linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureMySqlLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureMySqlLinkedServiceTypeProperties": { + "description": "Azure MySQL database linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "password": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "MySqlLinkedService": { + "x-ms-discriminator-value": "MySql", + "description": "Linked service for MySQL data source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "MySQL linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MySqlLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MySqlLinkedServiceTypeProperties": { + "description": "MySQL linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The connection string.", + "type": "object" + }, + "password": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "PostgreSqlLinkedService": { + "x-ms-discriminator-value": "PostgreSql", + "description": "Linked service for PostgreSQL data source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "PostgreSQL linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PostgreSqlLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "PostgreSqlLinkedServiceTypeProperties": { + "description": "PostgreSQL linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The connection string.", + "type": "object" + }, + "password": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "SybaseLinkedService": { + "x-ms-discriminator-value": "Sybase", + "description": "Linked service for Sybase data source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Sybase linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SybaseLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SybaseLinkedServiceTypeProperties": { + "description": "Sybase linked service properties.", + "type": "object", + "properties": { + "server": { + "type": "object", + "description": "Server name for connection. Type: string (or Expression with resultType string)." + }, + "database": { + "type": "object", + "description": "Database name for connection. Type: string (or Expression with resultType string)." + }, + "schema": { + "type": "object", + "description": "Schema name for connection. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "description": "AuthenticationType to be used for connection.", + "type": "string", + "enum": [ + "Basic", + "Windows" + ], + "x-ms-enum": { + "name": "SybaseAuthenticationType", + "modelAsString": true + } + }, + "username": { + "type": "object", + "description": "Username for authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password for authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "server", + "database" + ] + }, + "Db2LinkedService": { + "x-ms-discriminator-value": "Db2", + "description": "Linked service for DB2 data source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "DB2 linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/Db2LinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "Db2LinkedServiceTypeProperties": { + "description": "DB2 linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "type": "object", + "description": "The connection string. It is mutually exclusive with server, database, authenticationType, userName, packageCollection and certificateCommonName property. Type: string, SecureString or AzureKeyVaultSecretReference." + }, + "server": { + "type": "object", + "description": "Server name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string)." + }, + "database": { + "type": "object", + "description": "Database name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "description": "AuthenticationType to be used for connection. It is mutually exclusive with connectionString property.", + "type": "string", + "enum": [ + "Basic" + ], + "x-ms-enum": { + "name": "Db2AuthenticationType", + "modelAsString": true + } + }, + "username": { + "type": "object", + "description": "Username for authentication. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password for authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "packageCollection": { + "type": "object", + "description": "Under where packages are created when querying database. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string)." + }, + "certificateCommonName": { + "type": "object", + "description": "Certificate Common Name when TLS is enabled. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "server", + "database" + ] + }, + "TeradataLinkedService": { + "x-ms-discriminator-value": "Teradata", + "description": "Linked service for Teradata data source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Teradata linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/TeradataLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "TeradataLinkedServiceTypeProperties": { + "description": "Teradata linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "Teradata ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "server": { + "type": "object", + "description": "Server name for connection. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "description": "AuthenticationType to be used for connection.", + "type": "string", + "enum": [ + "Basic", + "Windows" + ], + "x-ms-enum": { + "name": "TeradataAuthenticationType", + "modelAsString": true + } + }, + "username": { + "type": "object", + "description": "Username for authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password for authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + } + }, + "AzureMLLinkedService": { + "x-ms-discriminator-value": "AzureML", + "description": "Azure ML Studio Web Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure ML Studio Web Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureMLLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureMLLinkedServiceTypeProperties": { + "description": "Azure ML Studio Web Service linked service properties.", + "type": "object", + "properties": { + "mlEndpoint": { + "type": "object", + "description": "The Batch Execution REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string)." + }, + "apiKey": { + "description": "The API key for accessing the Azure ML model endpoint.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "updateResourceEndpoint": { + "type": "object", + "description": "The Update Resource REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string)." + }, + "servicePrincipalId": { + "type": "object", + "description": "The ID of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The key of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service." + }, + "tenant": { + "type": "object", + "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "mlEndpoint", + "apiKey" + ] + }, + "AzureMLServiceLinkedService": { + "x-ms-discriminator-value": "AzureMLService", + "description": "Azure ML Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure ML Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureMLServiceLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureMLServiceLinkedServiceTypeProperties": { + "description": "Azure ML Service linked service properties.", + "type": "object", + "properties": { + "subscriptionId": { + "type": "object", + "description": "Azure ML Service workspace subscription ID. Type: string (or Expression with resultType string)." + }, + "resourceGroupName": { + "type": "object", + "description": "Azure ML Service workspace resource group name. Type: string (or Expression with resultType string)." + }, + "mlWorkspaceName": { + "type": "object", + "description": "Azure ML Service workspace name. Type: string (or Expression with resultType string)." + }, + "servicePrincipalId": { + "type": "object", + "description": "The ID of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The key of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline." + }, + "tenant": { + "type": "object", + "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "subscriptionId", + "resourceGroupName", + "mlWorkspaceName" + ] + }, + "OdbcLinkedService": { + "x-ms-discriminator-value": "Odbc", + "description": "Open Database Connectivity (ODBC) linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "ODBC linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/OdbcLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "OdbcLinkedServiceTypeProperties": { + "description": "ODBC linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "authenticationType": { + "type": "object", + "description": "Type of authentication used to connect to the ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string)." + }, + "credential": { + "description": "The access credential portion of the connection string specified in driver-specific property-value format.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "userName": { + "type": "object", + "description": "User name for Basic authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password for Basic authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "InformixLinkedService": { + "x-ms-discriminator-value": "Informix", + "description": "Informix linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Informix linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/InformixLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "InformixLinkedServiceTypeProperties": { + "description": "Informix linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "authenticationType": { + "type": "object", + "description": "Type of authentication used to connect to the Informix as ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string)." + }, + "credential": { + "description": "The access credential portion of the connection string specified in driver-specific property-value format.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "userName": { + "type": "object", + "description": "User name for Basic authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password for Basic authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "MicrosoftAccessLinkedService": { + "x-ms-discriminator-value": "MicrosoftAccess", + "description": "Microsoft Access linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Microsoft Access linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MicrosoftAccessLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MicrosoftAccessLinkedServiceTypeProperties": { + "description": "Microsoft Access linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "authenticationType": { + "type": "object", + "description": "Type of authentication used to connect to the Microsoft Access as ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string)." + }, + "credential": { + "description": "The access credential portion of the connection string specified in driver-specific property-value format.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "userName": { + "type": "object", + "description": "User name for Basic authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password for Basic authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "HdfsLinkedService": { + "x-ms-discriminator-value": "Hdfs", + "description": "Hadoop Distributed File System (HDFS) linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "HDFS linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HdfsLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HdfsLinkedServiceTypeProperties": { + "description": "HDFS linked service properties.", + "type": "object", + "properties": { + "url": { + "type": "object", + "description": "The URL of the HDFS service endpoint, e.g. http://myhostname:50070/webhdfs/v1 . Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "type": "object", + "description": "Type of authentication used to connect to the HDFS. Possible values are: Anonymous and Windows. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + }, + "userName": { + "type": "object", + "description": "User name for Windows authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password for Windows authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + } + }, + "required": [ + "url" + ] + }, + "ODataLinkedService": { + "x-ms-discriminator-value": "OData", + "description": "Open Data Protocol (OData) linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "OData linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ODataLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ODataLinkedServiceTypeProperties": { + "description": "OData linked service properties.", + "type": "object", + "properties": { + "url": { + "type": "object", + "description": "The URL of the OData service endpoint. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "description": "Type of authentication used to connect to the OData service.", + "type": "string", + "enum": [ + "Basic", + "Anonymous", + "Windows", + "AadServicePrincipal", + "ManagedServiceIdentity" + ], + "x-ms-enum": { + "name": "ODataAuthenticationType", + "modelAsString": true + } + }, + "userName": { + "type": "object", + "description": "User name of the OData service. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password of the OData service.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "tenant": { + "type": "object", + "description": "Specify the tenant information (domain name or tenant ID) under which your application resides. Type: string (or Expression with resultType string)." + }, + "servicePrincipalId": { + "type": "object", + "description": "Specify the application id of your application registered in Azure Active Directory. Type: string (or Expression with resultType string)." + }, + "azureCloudType": { + "type": "object", + "description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)." + }, + "aadResourceId": { + "type": "object", + "description": "Specify the resource you are requesting authorization to use Directory. Type: string (or Expression with resultType string)." + }, + "aadServicePrincipalCredentialType": { + "description": "Specify the credential type (key or cert) is used for service principal.", + "type": "string", + "enum": [ + "ServicePrincipalKey", + "ServicePrincipalCert" + ], + "x-ms-enum": { + "name": "ODataAadServicePrincipalCredentialType", + "modelAsString": true + } + }, + "servicePrincipalKey": { + "description": "Specify the secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "servicePrincipalEmbeddedCert": { + "description": "Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "servicePrincipalEmbeddedCertPassword": { + "description": "Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string).", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "url" + ] + }, + "WebLinkedService": { + "x-ms-discriminator-value": "Web", + "description": "Web linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Web linked service properties.", + "$ref": "#/definitions/WebLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "WebLinkedServiceTypeProperties": { + "description": "Base definition of WebLinkedServiceTypeProperties, this typeProperties is polymorphic based on authenticationType, so not flattened in SDK models.", + "discriminator": "authenticationType", + "type": "object", + "properties": { + "url": { + "type": "object", + "description": "The URL of the web service endpoint, e.g. http://www.microsoft.com . Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "description": "Type of authentication used to connect to the web table source.", + "type": "string", + "enum": [ + "Basic", + "Anonymous", + "ClientCertificate" + ], + "x-ms-enum": { + "name": "WebAuthenticationType", + "modelAsString": true + } + } + }, + "required": [ + "authenticationType", + "url" + ] + }, + "WebAnonymousAuthentication": { + "description": "A WebLinkedService that uses anonymous authentication to communicate with an HTTP endpoint.", + "type": "object", + "x-ms-discriminator-value": "Anonymous", + "allOf": [ + { + "$ref": "#/definitions/WebLinkedServiceTypeProperties" + } + ] + }, + "WebBasicAuthentication": { + "description": "A WebLinkedService that uses basic authentication to communicate with an HTTP endpoint.", + "type": "object", + "x-ms-discriminator-value": "Basic", + "allOf": [ + { + "$ref": "#/definitions/WebLinkedServiceTypeProperties" + } + ], + "properties": { + "username": { + "type": "object", + "description": "User name for Basic authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "The password for Basic authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + } + }, + "required": [ + "username", + "password" + ] + }, + "WebClientCertificateAuthentication": { + "description": "A WebLinkedService that uses client certificate based authentication to communicate with an HTTP endpoint. This scheme follows mutual authentication; the server must also provide valid credentials to the client.", + "type": "object", + "x-ms-discriminator-value": "ClientCertificate", + "allOf": [ + { + "$ref": "#/definitions/WebLinkedServiceTypeProperties" + } + ], + "properties": { + "pfx": { + "description": "Base64-encoded contents of a PFX file.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "password": { + "description": "Password for the PFX file.", + "$ref": "../artifacts.json#/definitions/SecretBase" + } + }, + "required": [ + "pfx", + "password" + ] + }, + "CassandraLinkedService": { + "x-ms-discriminator-value": "Cassandra", + "description": "Linked service for Cassandra data source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Cassandra linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CassandraLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "CassandraLinkedServiceTypeProperties": { + "description": "Cassandra linked service properties.", + "type": "object", + "properties": { + "host": { + "type": "object", + "description": "Host name for connection. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "type": "object", + "description": "AuthenticationType to be used for connection. Type: string (or Expression with resultType string)." + }, + "port": { + "type": "object", + "description": "The port for the connection. Type: integer (or Expression with resultType integer)." + }, + "username": { + "type": "object", + "description": "Username for authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password for authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "host" + ] + }, + "MongoDbLinkedService": { + "x-ms-discriminator-value": "MongoDb", + "description": "Linked service for MongoDb data source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "MongoDB linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MongoDbLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MongoDbLinkedServiceTypeProperties": { + "description": "MongoDB linked service properties.", + "type": "object", + "properties": { + "server": { + "type": "object", + "description": "The IP address or server name of the MongoDB server. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "description": "The authentication type to be used to connect to the MongoDB database.", + "type": "string", + "enum": [ + "Basic", + "Anonymous" + ], + "x-ms-enum": { + "name": "MongoDbAuthenticationType", + "modelAsString": true + } + }, + "databaseName": { + "type": "object", + "description": "The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string)." + }, + "username": { + "type": "object", + "description": "Username for authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password for authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "authSource": { + "type": "object", + "description": "Database to verify the username and password. Type: string (or Expression with resultType string)." + }, + "port": { + "type": "object", + "description": "The TCP port number that the MongoDB server uses to listen for client connections. The default value is 27017. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "enableSsl": { + "type": "object", + "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false. Type: boolean (or Expression with resultType boolean)." + }, + "allowSelfSignedServerCert": { + "type": "object", + "description": "Specifies whether to allow self-signed certificates from the server. The default value is false. Type: boolean (or Expression with resultType boolean)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "server", + "databaseName" + ] + }, + "MongoDbAtlasLinkedService": { + "x-ms-discriminator-value": "MongoDbAtlas", + "description": "Linked service for MongoDB Atlas data source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "MongoDB Atlas linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MongoDbAtlasLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MongoDbAtlasLinkedServiceTypeProperties": { + "description": "MongoDB Atlas linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The MongoDB Atlas connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "database": { + "type": "object", + "description": "The name of the MongoDB Atlas database that you want to access. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString", + "database" + ] + }, + "MongoDbV2LinkedService": { + "x-ms-discriminator-value": "MongoDbV2", + "description": "Linked service for MongoDB data source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "MongoDB linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MongoDbV2LinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MongoDbV2LinkedServiceTypeProperties": { + "description": "MongoDB linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The MongoDB connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "database": { + "type": "object", + "description": "The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString", + "database" + ] + }, + "CosmosDbMongoDbApiLinkedService": { + "x-ms-discriminator-value": "CosmosDbMongoDbApi", + "description": "Linked service for CosmosDB (MongoDB API) data source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "CosmosDB (MongoDB API) linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CosmosDbMongoDbApiLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "CosmosDbMongoDbApiLinkedServiceTypeProperties": { + "description": "CosmosDB (MongoDB API) linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The CosmosDB (MongoDB API) connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "database": { + "type": "object", + "description": "The name of the CosmosDB (MongoDB API) database that you want to access. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString", + "database" + ] + }, + "AzureDataLakeStoreLinkedService": { + "x-ms-discriminator-value": "AzureDataLakeStore", + "description": "Azure Data Lake Store linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Data Lake Store linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureDataLakeStoreLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureDataLakeStoreLinkedServiceTypeProperties": { + "description": "Azure Data Lake Store linked service properties.", + "type": "object", + "properties": { + "dataLakeStoreUri": { + "type": "object", + "description": "Data Lake Store service URI. Type: string (or Expression with resultType string)." + }, + "servicePrincipalId": { + "type": "object", + "description": "The ID of the application used to authenticate against the Azure Data Lake Store account. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "description": "The Key of the application used to authenticate against the Azure Data Lake Store account.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "tenant": { + "type": "object", + "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." + }, + "azureCloudType": { + "type": "object", + "description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)." + }, + "accountName": { + "type": "object", + "description": "Data Lake Store account name. Type: string (or Expression with resultType string)." + }, + "subscriptionId": { + "type": "object", + "description": "Data Lake Store account subscription ID (if different from Data Factory account). Type: string (or Expression with resultType string)." + }, + "resourceGroupName": { + "type": "object", + "description": "Data Lake Store account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "dataLakeStoreUri" + ] + }, + "AzureBlobFSLinkedService": { + "x-ms-discriminator-value": "AzureBlobFS", + "description": "Azure Data Lake Storage Gen2 linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Data Lake Storage Gen2 linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureBlobFSLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureBlobFSLinkedServiceTypeProperties": { + "description": "Azure Data Lake Storage Gen2 linked service properties.", + "type": "object", + "properties": { + "url": { + "type": "object", + "description": "Endpoint for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string)." + }, + "accountKey": { + "type": "object", + "description": "Account key for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string)." + }, + "servicePrincipalId": { + "type": "object", + "description": "The ID of the application used to authenticate against the Azure Data Lake Storage Gen2 account. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "description": "The Key of the application used to authenticate against the Azure Data Lake Storage Gen2 account.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "tenant": { + "type": "object", + "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." + }, + "azureCloudType": { + "type": "object", + "description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "url" + ] + }, + "Office365LinkedService": { + "x-ms-discriminator-value": "Office365", + "description": "Office365 linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Office365 linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/Office365LinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "Office365LinkedServiceTypeProperties": { + "description": "Office365 linked service properties.", + "type": "object", + "properties": { + "office365TenantId": { + "type": "object", + "description": "Azure tenant ID to which the Office 365 account belongs. Type: string (or Expression with resultType string)." + }, + "servicePrincipalTenantId": { + "type": "object", + "description": "Specify the tenant information under which your Azure AD web application resides. Type: string (or Expression with resultType string)." + }, + "servicePrincipalId": { + "type": "object", + "description": "Specify the application's client ID. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "description": "Specify the application's key.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "office365TenantId", + "servicePrincipalTenantId", + "servicePrincipalId", + "servicePrincipalKey" + ] + }, + "SalesforceLinkedService": { + "x-ms-discriminator-value": "Salesforce", + "description": "Linked service for Salesforce.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Salesforce linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SalesforceLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SalesforceLinkedServiceTypeProperties": { + "description": "Salesforce linked service properties.", + "type": "object", + "properties": { + "environmentUrl": { + "type": "object", + "description": "The URL of Salesforce instance. Default is 'https://login.salesforce.com'. To copy data from sandbox, specify 'https://test.salesforce.com'. To copy data from custom domain, specify, for example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string)." + }, + "username": { + "type": "object", + "description": "The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "The password for Basic authentication of the Salesforce instance.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "securityToken": { + "description": "The security token is optional to remotely access Salesforce instance.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "apiVersion": { + "type": "object", + "description": "The Salesforce API version used in ADF. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + } + }, + "SalesforceServiceCloudLinkedService": { + "x-ms-discriminator-value": "SalesforceServiceCloud", + "description": "Linked service for Salesforce Service Cloud.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Salesforce Service Cloud linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SalesforceServiceCloudLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SalesforceServiceCloudLinkedServiceTypeProperties": { + "description": "Salesforce Service Cloud linked service properties.", + "type": "object", + "properties": { + "environmentUrl": { + "type": "object", + "description": "The URL of Salesforce Service Cloud instance. Default is 'https://login.salesforce.com'. To copy data from sandbox, specify 'https://test.salesforce.com'. To copy data from custom domain, specify, for example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string)." + }, + "username": { + "type": "object", + "description": "The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "The password for Basic authentication of the Salesforce instance.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "securityToken": { + "description": "The security token is optional to remotely access Salesforce instance.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "apiVersion": { + "type": "object", + "description": "The Salesforce API version used in ADF. Type: string (or Expression with resultType string)." + }, + "extendedProperties": { + "type": "object", + "description": "Extended properties appended to the connection string. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + } + }, + "SapCloudForCustomerLinkedService": { + "x-ms-discriminator-value": "SapCloudForCustomer", + "description": "Linked service for SAP Cloud for Customer.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "SAP Cloud for Customer linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SapCloudForCustomerLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SapCloudForCustomerLinkedServiceTypeProperties": { + "description": "SAP Cloud for Customer linked service properties.", + "type": "object", + "properties": { + "url": { + "type": "object", + "description": "The URL of SAP Cloud for Customer OData API. For example, '[https://[tenantname].crm.ondemand.com/sap/c4c/odata/v1]'. Type: string (or Expression with resultType string)." + }, + "username": { + "type": "object", + "description": "The username for Basic authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "The password for Basic authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "url" + ] + }, + "SapEccLinkedService": { + "x-ms-discriminator-value": "SapEcc", + "description": "Linked service for SAP ERP Central Component(SAP ECC).", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "SAP ECC linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SapEccLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SapEccLinkedServiceTypeProperties": { + "description": "SAP ECC linked service properties.", + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "The URL of SAP ECC OData API. For example, '[https://hostname:port/sap/opu/odata/sap/servicename/]'. Type: string (or Expression with resultType string)." + }, + "username": { + "type": "string", + "description": "The username for Basic authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "The password for Basic authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "string", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "url" + ] + }, + "SapOpenHubLinkedService": { + "x-ms-discriminator-value": "SapOpenHub", + "description": "SAP Business Warehouse Open Hub Destination Linked Service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to SAP Business Warehouse Open Hub Destination linked service type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SapOpenHubLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SapOpenHubLinkedServiceTypeProperties": { + "description": "Properties specific to SAP Business Warehouse Open Hub Destination linked service type.", + "type": "object", + "properties": { + "server": { + "type": "object", + "description": "Host name of the SAP BW instance where the open hub destination is located. Type: string (or Expression with resultType string)." + }, + "systemNumber": { + "type": "object", + "description": "System number of the BW system where the open hub destination is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string)." + }, + "clientId": { + "type": "object", + "description": "Client ID of the client on the BW system where the open hub destination is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string)." + }, + "language": { + "type": "object", + "description": "Language of the BW system where the open hub destination is located. The default value is EN. Type: string (or Expression with resultType string)." + }, + "systemId": { + "type": "object", + "description": "SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string)." + }, + "userName": { + "type": "object", + "description": "Username to access the SAP BW server where the open hub destination is located. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password to access the SAP BW server where the open hub destination is located.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "messageServer": { + "type": "object", + "description": "The hostname of the SAP Message Server. Type: string (or Expression with resultType string)." + }, + "messageServerService": { + "type": "object", + "description": "The service name or port number of the Message Server. Type: string (or Expression with resultType string)." + }, + "logonGroup": { + "type": "object", + "description": "The Logon Group for the SAP System. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "server", + "systemNumber", + "clientId" + ] + }, + "RestServiceLinkedService": { + "x-ms-discriminator-value": "RestService", + "description": "Rest Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Rest Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/RestServiceLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "RestServiceLinkedServiceTypeProperties": { + "description": "Rest Service linked service properties.", + "type": "object", + "properties": { + "url": { + "description": "The base URL of the REST service.", + "type": "object" + }, + "enableServerCertificateValidation": { + "type": "object", + "description": "Whether to validate server side SSL certificate when connecting to the endpoint.The default value is true. Type: boolean (or Expression with resultType boolean)." + }, + "authenticationType": { + "description": "Type of authentication used to connect to the REST service.", + "type": "string", + "enum": [ + "Anonymous", + "Basic", + "AadServicePrincipal", + "ManagedServiceIdentity" + ], + "x-ms-enum": { + "name": "RestServiceAuthenticationType", + "modelAsString": true + } + }, + "userName": { + "description": "The user name used in Basic authentication type.", + "type": "object" + }, + "password": { + "description": "The password used in Basic authentication type.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "servicePrincipalId": { + "description": "The application's client ID used in AadServicePrincipal authentication type.", + "type": "object" + }, + "servicePrincipalKey": { + "description": "The application's key used in AadServicePrincipal authentication type.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "tenant": { + "description": "The tenant information (domain name or tenant ID) used in AadServicePrincipal authentication type under which your application resides.", + "type": "object" + }, + "azureCloudType": { + "type": "object", + "description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)." + }, + "aadResourceId": { + "description": "The resource you are requesting authorization to use.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "url", + "authenticationType" + ] + }, + "AmazonS3LinkedService": { + "x-ms-discriminator-value": "AmazonS3", + "description": "Linked service for Amazon S3.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Amazon S3 linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AmazonS3LinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AmazonS3LinkedServiceTypeProperties": { + "description": "Amazon S3 linked service properties.", + "type": "object", + "properties": { + "authenticationType": { + "type": "object", + "description": "The authentication type of S3. Allowed value: AccessKey (default) or TemporarySecurityCredentials. Type: string (or Expression with resultType string)." + }, + "accessKeyId": { + "type": "object", + "description": "The access key identifier of the Amazon S3 Identity and Access Management (IAM) user. Type: string (or Expression with resultType string)." + }, + "secretAccessKey": { + "description": "The secret access key of the Amazon S3 Identity and Access Management (IAM) user.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "serviceUrl": { + "type": "object", + "description": "This value specifies the endpoint to access with the S3 Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string)." + }, + "sessionToken": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The session token for the S3 temporary security credential." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + } + }, + "AmazonRedshiftLinkedService": { + "x-ms-discriminator-value": "AmazonRedshift", + "description": "Linked service for Amazon Redshift.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Amazon Redshift linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AmazonRedshiftLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AmazonRedshiftLinkedServiceTypeProperties": { + "description": "Amazon Redshift linked service properties.", + "type": "object", + "properties": { + "server": { + "type": "object", + "description": "The name of the Amazon Redshift server. Type: string (or Expression with resultType string)." + }, + "username": { + "type": "object", + "description": "The username of the Amazon Redshift source. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "The password of the Amazon Redshift source.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "database": { + "type": "object", + "description": "The database name of the Amazon Redshift source. Type: string (or Expression with resultType string)." + }, + "port": { + "type": "object", + "description": "The TCP port number that the Amazon Redshift server uses to listen for client connections. The default value is 5439. Type: integer (or Expression with resultType integer)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "server", + "database" + ] + }, + "CustomDataSourceLinkedService": { + "x-ms-discriminator-value": "CustomDataSource", + "description": "Custom linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Custom linked service properties.", + "x-ms-client-flatten": true, + "type": "object" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureSearchLinkedService": { + "x-ms-discriminator-value": "AzureSearch", + "description": "Linked service for Windows Azure Search Service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Windows Azure Search Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureSearchLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureSearchLinkedServiceTypeProperties": { + "description": "Windows Azure Search Service linked service properties.", + "type": "object", + "properties": { + "url": { + "type": "object", + "description": "URL for Azure Search service. Type: string (or Expression with resultType string)." + }, + "key": { + "description": "Admin Key for Azure Search service", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "url" + ] + }, + "HttpLinkedService": { + "x-ms-discriminator-value": "HttpServer", + "description": "Linked service for an HTTP source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this linked service type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HttpLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HttpLinkedServiceTypeProperties": { + "description": "Properties specific to this linked service type.", + "type": "object", + "properties": { + "url": { + "type": "object", + "description": "The base URL of the HTTP endpoint, e.g. http://www.microsoft.com. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "description": "The authentication type to be used to connect to the HTTP server.", + "type": "string", + "enum": [ + "Basic", + "Anonymous", + "Digest", + "Windows", + "ClientCertificate" + ], + "x-ms-enum": { + "name": "HttpAuthenticationType", + "modelAsString": true + } + }, + "userName": { + "type": "object", + "description": "User name for Basic, Digest, or Windows authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password for Basic, Digest, Windows, or ClientCertificate with EmbeddedCertData authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "embeddedCertData": { + "type": "object", + "description": "Base64 encoded certificate data for ClientCertificate authentication. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string)." + }, + "certThumbprint": { + "type": "object", + "description": "Thumbprint of certificate for ClientCertificate authentication. Only valid for on-premises copy. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + }, + "enableServerCertificateValidation": { + "type": "object", + "description": "If true, validate the HTTPS server SSL certificate. Default value is true. Type: boolean (or Expression with resultType boolean)." + } + }, + "required": [ + "url" + ] + }, + "FtpServerLinkedService": { + "x-ms-discriminator-value": "FtpServer", + "description": "A FTP server Linked Service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this linked service type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/FtpServerLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "FtpServerLinkedServiceTypeProperties": { + "description": "Properties specific to this linked service type.", + "type": "object", + "properties": { + "host": { + "type": "object", + "description": "Host name of the FTP server. Type: string (or Expression with resultType string)." + }, + "port": { + "type": "object", + "description": "The TCP port number that the FTP server uses to listen for client connections. Default value is 21. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "authenticationType": { + "description": "The authentication type to be used to connect to the FTP server.", + "type": "string", + "enum": [ + "Basic", + "Anonymous" + ], + "x-ms-enum": { + "name": "FtpAuthenticationType", + "modelAsString": true + } + }, + "userName": { + "type": "object", + "description": "Username to logon the FTP server. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password to logon the FTP server.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + }, + "enableSsl": { + "type": "object", + "description": "If true, connect to the FTP server over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean)." + }, + "enableServerCertificateValidation": { + "type": "object", + "description": "If true, validate the FTP server SSL certificate when connect over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean)." + } + }, + "required": [ + "host" + ] + }, + "SftpServerLinkedService": { + "x-ms-discriminator-value": "Sftp", + "description": "A linked service for an SSH File Transfer Protocol (SFTP) server. ", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this linked service type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SftpServerLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SftpServerLinkedServiceTypeProperties": { + "description": "Properties specific to this linked service type.", + "type": "object", + "properties": { + "host": { + "type": "object", + "description": "The SFTP server host name. Type: string (or Expression with resultType string)." + }, + "port": { + "type": "object", + "description": "The TCP port number that the SFTP server uses to listen for client connections. Default value is 22. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "authenticationType": { + "description": "The authentication type to be used to connect to the FTP server.", + "type": "string", + "enum": [ + "Basic", + "SshPublicKey" + ], + "x-ms-enum": { + "name": "SftpAuthenticationType", + "modelAsString": true + } + }, + "userName": { + "type": "object", + "description": "The username used to log on to the SFTP server. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password to logon the SFTP server for Basic authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + }, + "privateKeyPath": { + "type": "object", + "description": "The SSH private key file path for SshPublicKey authentication. Only valid for on-premises copy. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format. Type: string (or Expression with resultType string)." + }, + "privateKeyContent": { + "description": "Base64 encoded SSH private key content for SshPublicKey authentication. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "passPhrase": { + "description": "The password to decrypt the SSH private key if the SSH private key is encrypted.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "skipHostKeyValidation": { + "type": "object", + "description": "If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean)." + }, + "hostKeyFingerprint": { + "type": "object", + "description": "The host key finger-print of the SFTP server. When SkipHostKeyValidation is false, HostKeyFingerprint should be specified. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "host" + ] + }, + "SapBWLinkedService": { + "x-ms-discriminator-value": "SapBW", + "description": "SAP Business Warehouse Linked Service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this linked service type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SapBWLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SapBWLinkedServiceTypeProperties": { + "description": "Properties specific to this linked service type.", + "type": "object", + "properties": { + "server": { + "type": "object", + "description": "Host name of the SAP BW instance. Type: string (or Expression with resultType string)." + }, + "systemNumber": { + "type": "object", + "description": "System number of the BW system. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string)." + }, + "clientId": { + "type": "object", + "description": "Client ID of the client on the BW system. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string)." + }, + "userName": { + "type": "object", + "description": "Username to access the SAP BW server. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password to access the SAP BW server.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "server", + "systemNumber", + "clientId" + ] + }, + "SapHanaLinkedService": { + "x-ms-discriminator-value": "SapHana", + "description": "SAP HANA Linked Service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this linked service type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SapHanaLinkedServiceProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SapHanaLinkedServiceProperties": { + "description": "Properties specific to this linked service type.", + "type": "object", + "properties": { + "connectionString": { + "type": "object", + "description": "SAP HANA ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference." + }, + "server": { + "type": "object", + "description": "Host name of the SAP HANA server. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "description": "The authentication type to be used to connect to the SAP HANA server.", + "type": "string", + "enum": [ + "Basic", + "Windows" + ], + "x-ms-enum": { + "name": "SapHanaAuthenticationType", + "modelAsString": true + } + }, + "userName": { + "type": "object", + "description": "Username to access the SAP HANA server. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password to access the SAP HANA server.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "server" + ] + }, + "AmazonMWSLinkedService": { + "x-ms-discriminator-value": "AmazonMWS", + "description": "Amazon Marketplace Web Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Amazon Marketplace Web Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AmazonMWSLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AmazonMWSLinkedServiceTypeProperties": { + "description": "Amazon Marketplace Web Service linked service properties.", + "type": "object", + "properties": { + "endpoint": { + "description": "The endpoint of the Amazon MWS server, (i.e. mws.amazonservices.com)", + "type": "object" + }, + "marketplaceID": { + "description": "The Amazon Marketplace ID you want to retrieve data from. To retrieve data from multiple Marketplace IDs, separate them with a comma (,). (i.e. A2EUQ1WTGCTBG2)", + "type": "object" + }, + "sellerID": { + "description": "The Amazon seller ID.", + "type": "object" + }, + "mwsAuthToken": { + "description": "The Amazon MWS authentication token.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "accessKeyId": { + "description": "The access key id used to access data.", + "type": "object" + }, + "secretKey": { + "description": "The secret key used to access data.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "endpoint", + "marketplaceID", + "sellerID", + "accessKeyId" + ] + }, + "AzurePostgreSqlLinkedService": { + "x-ms-discriminator-value": "AzurePostgreSql", + "description": "Azure PostgreSQL linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure PostgreSQL linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzurePostgreSqlLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzurePostgreSqlLinkedServiceTypeProperties": { + "description": "Azure PostgreSQL linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "password": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + } + }, + "ConcurLinkedService": { + "x-ms-discriminator-value": "Concur", + "description": "Concur Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Concur Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConcurLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ConcurLinkedServiceTypeProperties": { + "description": "Concur Service linked service properties.", + "type": "object", + "properties": { + "connectionProperties": { + "description": "Properties used to connect to Concur. It is mutually exclusive with any other properties in the linked service. Type: object.", + "type": "object" + }, + "clientId": { + "description": "Application client_id supplied by Concur App Management.", + "type": "object" + }, + "username": { + "description": "The user name that you use to access Concur Service.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name that you provided in the username field.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "clientId", + "username" + ] + }, + "CouchbaseLinkedService": { + "x-ms-discriminator-value": "Couchbase", + "description": "Couchbase server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Couchbase server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CouchbaseLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "CouchbaseLinkedServiceTypeProperties": { + "description": "Couchbase server linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "credString": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of credString in connection string." + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + } + }, + "DrillLinkedService": { + "x-ms-discriminator-value": "Drill", + "description": "Drill server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Drill server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DrillLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DrillLinkedServiceTypeProperties": { + "description": "Drill server linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "pwd": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + } + }, + "EloquaLinkedService": { + "x-ms-discriminator-value": "Eloqua", + "description": "Eloqua server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Eloqua server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/EloquaLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "EloquaLinkedServiceTypeProperties": { + "description": "Eloqua server linked service properties.", + "type": "object", + "properties": { + "endpoint": { + "description": "The endpoint of the Eloqua server. (i.e. eloqua.example.com)", + "type": "object" + }, + "username": { + "description": "The site name and user name of your Eloqua account in the form: sitename/username. (i.e. Eloqua/Alice)", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "endpoint", + "username" + ] + }, + "GoogleBigQueryLinkedService": { + "x-ms-discriminator-value": "GoogleBigQuery", + "description": "Google BigQuery service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Google BigQuery service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GoogleBigQueryLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "GoogleBigQueryLinkedServiceTypeProperties": { + "description": "Google BigQuery service linked service properties.", + "type": "object", + "properties": { + "project": { + "description": "The default BigQuery project to query against.", + "type": "object" + }, + "additionalProjects": { + "description": "A comma-separated list of public BigQuery projects to access.", + "type": "object" + }, + "requestGoogleDriveScope": { + "description": "Whether to request access to Google Drive. Allowing Google Drive access enables support for federated tables that combine BigQuery data with data from Google Drive. The default value is false.", + "type": "object" + }, + "authenticationType": { + "description": "The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR.", + "type": "string", + "enum": [ + "ServiceAuthentication", + "UserAuthentication" + ], + "x-ms-enum": { + "name": "GoogleBigQueryAuthenticationType", + "modelAsString": true + } + }, + "refreshToken": { + "description": "The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "clientId": { + "description": "The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).", + "type": "object" + }, + "clientSecret": { + "description": "The client secret of the google application used to acquire the refresh token.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "email": { + "description": "The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.", + "type": "object" + }, + "keyFilePath": { + "description": "The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "useSystemTrustStore": { + "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "project", + "authenticationType" + ] + }, + "GreenplumLinkedService": { + "x-ms-discriminator-value": "Greenplum", + "description": "Greenplum Database linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Greenplum Database linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GreenplumLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "GreenplumLinkedServiceTypeProperties": { + "description": "Greenplum Database linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "pwd": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + } + }, + "HBaseLinkedService": { + "x-ms-discriminator-value": "HBase", + "description": "HBase server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "HBase server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HBaseLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HBaseLinkedServiceTypeProperties": { + "description": "HBase server linked service properties.", + "type": "object", + "properties": { + "host": { + "description": "The IP address or host name of the HBase server. (i.e. 192.168.222.160)", + "type": "object" + }, + "port": { + "description": "The TCP port that the HBase instance uses to listen for client connections. The default value is 9090.", + "type": "object" + }, + "httpPath": { + "description": "The partial URL corresponding to the HBase server. (i.e. /gateway/sandbox/hbase/version)", + "type": "object" + }, + "authenticationType": { + "description": "The authentication mechanism to use to connect to the HBase server.", + "type": "string", + "enum": [ + "Anonymous", + "Basic" + ], + "x-ms-enum": { + "name": "HBaseAuthenticationType", + "modelAsString": true + } + }, + "username": { + "description": "The user name used to connect to the HBase instance.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "enableSsl": { + "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "allowHostNameCNMismatch": { + "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.", + "type": "object" + }, + "allowSelfSignedServerCert": { + "description": "Specifies whether to allow self-signed certificates from the server. The default value is false.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "authenticationType" + ] + }, + "HiveLinkedService": { + "x-ms-discriminator-value": "Hive", + "description": "Hive Server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Hive Server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HiveLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HiveLinkedServiceTypeProperties": { + "description": "Hive Server linked service properties.", + "type": "object", + "properties": { + "host": { + "description": "IP address or host name of the Hive server, separated by ';' for multiple hosts (only when serviceDiscoveryMode is enable).", + "type": "object" + }, + "port": { + "description": "The TCP port that the Hive server uses to listen for client connections.", + "type": "object" + }, + "serverType": { + "description": "The type of Hive server.", + "type": "string", + "enum": [ + "HiveServer1", + "HiveServer2", + "HiveThriftServer" + ], + "x-ms-enum": { + "name": "HiveServerType", + "modelAsString": true + } + }, + "thriftTransportProtocol": { + "description": "The transport protocol to use in the Thrift layer.", + "type": "string", + "enum": [ + "Binary", + "SASL", + "HTTP " + ], + "x-ms-enum": { + "name": "HiveThriftTransportProtocol", + "modelAsString": true + } + }, + "authenticationType": { + "description": "The authentication method used to access the Hive server.", + "type": "string", + "enum": [ + "Anonymous", + "Username", + "UsernameAndPassword", + "WindowsAzureHDInsightService" + ], + "x-ms-enum": { + "name": "HiveAuthenticationType", + "modelAsString": true + } + }, + "serviceDiscoveryMode": { + "description": "true to indicate using the ZooKeeper service, false not.", + "type": "object" + }, + "zooKeeperNameSpace": { + "description": "The namespace on ZooKeeper under which Hive Server 2 nodes are added.", + "type": "object" + }, + "useNativeQuery": { + "description": "Specifies whether the driver uses native HiveQL queries,or converts them into an equivalent form in HiveQL.", + "type": "object" + }, + "username": { + "description": "The user name that you use to access Hive Server.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name that you provided in the Username field", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "httpPath": { + "description": "The partial URL corresponding to the Hive server.", + "type": "object" + }, + "enableSsl": { + "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "useSystemTrustStore": { + "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.", + "type": "object" + }, + "allowHostNameCNMismatch": { + "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.", + "type": "object" + }, + "allowSelfSignedServerCert": { + "description": "Specifies whether to allow self-signed certificates from the server. The default value is false.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "authenticationType" + ] + }, + "HubspotLinkedService": { + "x-ms-discriminator-value": "Hubspot", + "description": "Hubspot Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Hubspot Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HubspotLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HubspotLinkedServiceTypeProperties": { + "description": "Hubspot Service linked service properties.", + "type": "object", + "properties": { + "clientId": { + "description": "The client ID associated with your Hubspot application.", + "type": "object" + }, + "clientSecret": { + "description": "The client secret associated with your Hubspot application.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "accessToken": { + "description": "The access token obtained when initially authenticating your OAuth integration.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "refreshToken": { + "description": "The refresh token obtained when initially authenticating your OAuth integration.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "clientId" + ] + }, + "ImpalaLinkedService": { + "x-ms-discriminator-value": "Impala", + "description": "Impala server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Impala server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImpalaLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ImpalaLinkedServiceTypeProperties": { + "description": "Impala server linked service properties.", + "type": "object", + "properties": { + "host": { + "description": "The IP address or host name of the Impala server. (i.e. 192.168.222.160)", + "type": "object" + }, + "port": { + "description": "The TCP port that the Impala server uses to listen for client connections. The default value is 21050.", + "type": "object" + }, + "authenticationType": { + "description": "The authentication type to use.", + "type": "string", + "enum": [ + "Anonymous", + "SASLUsername", + "UsernameAndPassword" + ], + "x-ms-enum": { + "name": "ImpalaAuthenticationType", + "modelAsString": true + } + }, + "username": { + "description": "The user name used to access the Impala server. The default value is anonymous when using SASLUsername.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name when using UsernameAndPassword.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "enableSsl": { + "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "useSystemTrustStore": { + "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.", + "type": "object" + }, + "allowHostNameCNMismatch": { + "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.", + "type": "object" + }, + "allowSelfSignedServerCert": { + "description": "Specifies whether to allow self-signed certificates from the server. The default value is false.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "authenticationType" + ] + }, + "JiraLinkedService": { + "x-ms-discriminator-value": "Jira", + "description": "Jira Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Jira Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/JiraLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "JiraLinkedServiceTypeProperties": { + "description": "Jira Service linked service properties.", + "type": "object", + "properties": { + "host": { + "description": "The IP address or host name of the Jira service. (e.g. jira.example.com)", + "type": "object" + }, + "port": { + "description": "The TCP port that the Jira server uses to listen for client connections. The default value is 443 if connecting through HTTPS, or 8080 if connecting through HTTP.", + "type": "object" + }, + "username": { + "description": "The user name that you use to access Jira Service.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name that you provided in the username field.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "username" + ] + }, + "MagentoLinkedService": { + "x-ms-discriminator-value": "Magento", + "description": "Magento server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Magento server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MagentoLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MagentoLinkedServiceTypeProperties": { + "description": "Magento server linked service properties.", + "type": "object", + "properties": { + "host": { + "description": "The URL of the Magento instance. (i.e. 192.168.222.110/magento3)", + "type": "object" + }, + "accessToken": { + "description": "The access token from Magento.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host" + ] + }, + "MariaDBLinkedService": { + "x-ms-discriminator-value": "MariaDB", + "description": "MariaDB server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "MariaDB server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MariaDBLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MariaDBLinkedServiceTypeProperties": { + "description": "MariaDB server linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "pwd": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + } + }, + "AzureMariaDBLinkedService": { + "x-ms-discriminator-value": "AzureMariaDB", + "description": "Azure Database for MariaDB linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Database for MariaDB linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureMariaDBLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureMariaDBLinkedServiceTypeProperties": { + "description": "Azure Database for MariaDB linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "pwd": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + } + }, + "MarketoLinkedService": { + "x-ms-discriminator-value": "Marketo", + "description": "Marketo server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Marketo server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MarketoLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MarketoLinkedServiceTypeProperties": { + "description": "Marketo server linked service properties.", + "type": "object", + "properties": { + "endpoint": { + "description": "The endpoint of the Marketo server. (i.e. 123-ABC-321.mktorest.com)", + "type": "object" + }, + "clientId": { + "description": "The client Id of your Marketo service.", + "type": "object" + }, + "clientSecret": { + "description": "The client secret of your Marketo service.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "endpoint", + "clientId" + ] + }, + "PaypalLinkedService": { + "x-ms-discriminator-value": "Paypal", + "description": "Paypal Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Paypal Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PaypalLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "PaypalLinkedServiceTypeProperties": { + "description": "Paypal Service linked service properties.", + "type": "object", + "properties": { + "host": { + "description": "The URL of the PayPal instance. (i.e. api.sandbox.paypal.com)", + "type": "object" + }, + "clientId": { + "description": "The client ID associated with your PayPal application.", + "type": "object" + }, + "clientSecret": { + "description": "The client secret associated with your PayPal application.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "clientId" + ] + }, + "PhoenixLinkedService": { + "x-ms-discriminator-value": "Phoenix", + "description": "Phoenix server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Phoenix server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PhoenixLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "PhoenixLinkedServiceTypeProperties": { + "description": "Phoenix server linked service properties.", + "type": "object", + "properties": { + "host": { + "description": "The IP address or host name of the Phoenix server. (i.e. 192.168.222.160)", + "type": "object" + }, + "port": { + "description": "The TCP port that the Phoenix server uses to listen for client connections. The default value is 8765.", + "type": "object" + }, + "httpPath": { + "description": "The partial URL corresponding to the Phoenix server. (i.e. /gateway/sandbox/phoenix/version). The default value is hbasephoenix if using WindowsAzureHDInsightService.", + "type": "object" + }, + "authenticationType": { + "description": "The authentication mechanism used to connect to the Phoenix server.", + "type": "string", + "enum": [ + "Anonymous", + "UsernameAndPassword", + "WindowsAzureHDInsightService" + ], + "x-ms-enum": { + "name": "PhoenixAuthenticationType", + "modelAsString": true + } + }, + "username": { + "description": "The user name used to connect to the Phoenix server.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "enableSsl": { + "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "useSystemTrustStore": { + "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.", + "type": "object" + }, + "allowHostNameCNMismatch": { + "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.", + "type": "object" + }, + "allowSelfSignedServerCert": { + "description": "Specifies whether to allow self-signed certificates from the server. The default value is false.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "authenticationType" + ] + }, + "PrestoLinkedService": { + "x-ms-discriminator-value": "Presto", + "description": "Presto server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Presto server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrestoLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "PrestoLinkedServiceTypeProperties": { + "description": "Presto server linked service properties.", + "type": "object", + "properties": { + "host": { + "description": "The IP address or host name of the Presto server. (i.e. 192.168.222.160)", + "type": "object" + }, + "serverVersion": { + "description": "The version of the Presto server. (i.e. 0.148-t)", + "type": "object" + }, + "catalog": { + "description": "The catalog context for all request against the server.", + "type": "object" + }, + "port": { + "description": "The TCP port that the Presto server uses to listen for client connections. The default value is 8080.", + "type": "object" + }, + "authenticationType": { + "description": "The authentication mechanism used to connect to the Presto server.", + "type": "string", + "enum": [ + "Anonymous", + "LDAP" + ], + "x-ms-enum": { + "name": "PrestoAuthenticationType", + "modelAsString": true + } + }, + "username": { + "description": "The user name used to connect to the Presto server.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "enableSsl": { + "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "useSystemTrustStore": { + "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.", + "type": "object" + }, + "allowHostNameCNMismatch": { + "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.", + "type": "object" + }, + "allowSelfSignedServerCert": { + "description": "Specifies whether to allow self-signed certificates from the server. The default value is false.", + "type": "object" + }, + "timeZoneID": { + "description": "The local time zone used by the connection. Valid values for this option are specified in the IANA Time Zone Database. The default value is the system time zone.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "serverVersion", + "catalog", + "authenticationType" + ] + }, + "QuickBooksLinkedService": { + "x-ms-discriminator-value": "QuickBooks", + "description": "QuickBooks server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "QuickBooks server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/QuickBooksLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "QuickBooksLinkedServiceTypeProperties": { + "description": "QuickBooks server linked service properties.", + "type": "object", + "properties": { + "connectionProperties": { + "description": "Properties used to connect to QuickBooks. It is mutually exclusive with any other properties in the linked service. Type: object.", + "type": "object" + }, + "endpoint": { + "description": "The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com)", + "type": "object" + }, + "companyId": { + "description": "The company ID of the QuickBooks company to authorize.", + "type": "object" + }, + "consumerKey": { + "description": "The consumer key for OAuth 1.0 authentication.", + "type": "object" + }, + "consumerSecret": { + "description": "The consumer secret for OAuth 1.0 authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "accessToken": { + "description": "The access token for OAuth 1.0 authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "accessTokenSecret": { + "description": "The access token secret for OAuth 1.0 authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "endpoint", + "companyId", + "consumerKey", + "consumerSecret", + "accessToken", + "accessTokenSecret" + ] + }, + "ServiceNowLinkedService": { + "x-ms-discriminator-value": "ServiceNow", + "description": "ServiceNow server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "ServiceNow server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceNowLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ServiceNowLinkedServiceTypeProperties": { + "description": "ServiceNow server linked service properties.", + "type": "object", + "properties": { + "endpoint": { + "description": "The endpoint of the ServiceNow server. (i.e. .service-now.com)", + "type": "object" + }, + "authenticationType": { + "description": "The authentication type to use.", + "type": "string", + "enum": [ + "Basic", + "OAuth2" + ], + "x-ms-enum": { + "name": "ServiceNowAuthenticationType", + "modelAsString": true + } + }, + "username": { + "description": "The user name used to connect to the ServiceNow server for Basic and OAuth2 authentication.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name for Basic and OAuth2 authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "clientId": { + "description": "The client id for OAuth2 authentication.", + "type": "object" + }, + "clientSecret": { + "description": "The client secret for OAuth2 authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "endpoint", + "authenticationType" + ] + }, + "ShopifyLinkedService": { + "x-ms-discriminator-value": "Shopify", + "description": "Shopify Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Shopify Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ShopifyLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ShopifyLinkedServiceTypeProperties": { + "description": "Shopify Service linked service properties.", + "type": "object", + "properties": { + "host": { + "description": "The endpoint of the Shopify server. (i.e. mystore.myshopify.com)", + "type": "object" + }, + "accessToken": { + "description": "The API access token that can be used to access Shopify’s data. The token won't expire if it is offline mode.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host" + ] + }, + "SparkLinkedService": { + "x-ms-discriminator-value": "Spark", + "description": "Spark Server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Spark Server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SparkLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SparkLinkedServiceTypeProperties": { + "description": "Spark Server linked service properties.", + "type": "object", + "properties": { + "host": { + "description": "IP address or host name of the Spark server", + "type": "object" + }, + "port": { + "description": "The TCP port that the Spark server uses to listen for client connections.", + "type": "object" + }, + "serverType": { + "description": "The type of Spark server.", + "type": "string", + "enum": [ + "SharkServer", + "SharkServer2", + "SparkThriftServer" + ], + "x-ms-enum": { + "name": "SparkServerType", + "modelAsString": true + } + }, + "thriftTransportProtocol": { + "description": "The transport protocol to use in the Thrift layer.", + "type": "string", + "enum": [ + "Binary", + "SASL", + "HTTP " + ], + "x-ms-enum": { + "name": "SparkThriftTransportProtocol", + "modelAsString": true + } + }, + "authenticationType": { + "description": "The authentication method used to access the Spark server.", + "type": "string", + "enum": [ + "Anonymous", + "Username", + "UsernameAndPassword", + "WindowsAzureHDInsightService" + ], + "x-ms-enum": { + "name": "SparkAuthenticationType", + "modelAsString": true + } + }, + "username": { + "description": "The user name that you use to access Spark Server.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name that you provided in the Username field", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "httpPath": { + "description": "The partial URL corresponding to the Spark server.", + "type": "object" + }, + "enableSsl": { + "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "useSystemTrustStore": { + "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.", + "type": "object" + }, + "allowHostNameCNMismatch": { + "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.", + "type": "object" + }, + "allowSelfSignedServerCert": { + "description": "Specifies whether to allow self-signed certificates from the server. The default value is false.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "port", + "authenticationType" + ] + }, + "SquareLinkedService": { + "x-ms-discriminator-value": "Square", + "description": "Square Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Square Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SquareLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SquareLinkedServiceTypeProperties": { + "description": "Square Service linked service properties.", + "type": "object", + "properties": { + "connectionProperties": { + "description": "Properties used to connect to Square. It is mutually exclusive with any other properties in the linked service. Type: object.", + "type": "object" + }, + "host": { + "description": "The URL of the Square instance. (i.e. mystore.mysquare.com)", + "type": "object" + }, + "clientId": { + "description": "The client ID associated with your Square application.", + "type": "object" + }, + "clientSecret": { + "description": "The client secret associated with your Square application.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "redirectUri": { + "description": "The redirect URL assigned in the Square application dashboard. (i.e. http://localhost:2500)", + "type": "object" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "clientId", + "redirectUri" + ] + }, + "XeroLinkedService": { + "x-ms-discriminator-value": "Xero", + "description": "Xero Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Xero Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/XeroLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "XeroLinkedServiceTypeProperties": { + "description": "Xero Service linked service properties.", + "type": "object", + "properties": { + "connectionProperties": { + "description": "Properties used to connect to Xero. It is mutually exclusive with any other properties in the linked service. Type: object.", + "type": "object" + }, + "host": { + "description": "The endpoint of the Xero server. (i.e. api.xero.com)", + "type": "object" + }, + "consumerKey": { + "description": "The consumer key associated with the Xero application.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "privateKey": { + "description": "The private key from the .pem file that was generated for your Xero private application. You must include all the text from the .pem file, including the Unix line endings(\n).", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host" + ] + }, + "ZohoLinkedService": { + "x-ms-discriminator-value": "Zoho", + "description": "Zoho server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Zoho server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ZohoLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ZohoLinkedServiceTypeProperties": { + "description": "Zoho server linked service properties.", + "type": "object", + "properties": { + "connectionProperties": { + "description": "Properties used to connect to Zoho. It is mutually exclusive with any other properties in the linked service. Type: object.", + "type": "object" + }, + "endpoint": { + "description": "The endpoint of the Zoho server. (i.e. crm.zoho.com/crm/private)", + "type": "object" + }, + "accessToken": { + "description": "The access token for Zoho authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "endpoint" + ] + }, + "VerticaLinkedService": { + "x-ms-discriminator-value": "Vertica", + "description": "Vertica linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Vertica linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/VerticaLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "VerticaLinkedServiceTypeProperties": { + "description": "Vertica linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "pwd": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + } + }, + "NetezzaLinkedService": { + "x-ms-discriminator-value": "Netezza", + "description": "Netezza linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Netezza linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetezzaLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "NetezzaLinkedServiceTypeProperties": { + "description": "Netezza linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "pwd": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + } + }, + "SalesforceMarketingCloudLinkedService": { + "x-ms-discriminator-value": "SalesforceMarketingCloud", + "description": "Salesforce Marketing Cloud linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Salesforce Marketing Cloud linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SalesforceMarketingCloudLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SalesforceMarketingCloudLinkedServiceTypeProperties": { + "description": "Salesforce Marketing Cloud linked service properties.", + "type": "object", + "properties": { + "connectionProperties": { + "description": "Properties used to connect to Salesforce Marketing Cloud. It is mutually exclusive with any other properties in the linked service. Type: object.", + "type": "object" + }, + "clientId": { + "description": "The client ID associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string).", + "type": "object" + }, + "clientSecret": { + "description": "The client secret associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string).", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "clientId" + ] + }, + "HDInsightOnDemandLinkedService": { + "x-ms-discriminator-value": "HDInsightOnDemand", + "description": "HDInsight ondemand linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "HDInsight ondemand linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HDInsightOnDemandLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightOnDemandLinkedServiceTypeProperties": { + "description": "HDInsight ondemand linked service properties.", + "type": "object", + "properties": { + "clusterSize": { + "type": "object", + "description": "Number of worker/data nodes in the cluster. Suggestion value: 4. Type: string (or Expression with resultType string)." + }, + "timeToLive": { + "type": "object", + "description": "The allowed idle time for the on-demand HDInsight cluster. Specifies how long the on-demand HDInsight cluster stays alive after completion of an activity run if there are no other active jobs in the cluster. The minimum value is 5 mins. Type: string (or Expression with resultType string)." + }, + "version": { + "type": "object", + "description": "Version of the HDInsight cluster.  Type: string (or Expression with resultType string)." + }, + "linkedServiceName": { + "description": "Azure Storage linked service to be used by the on-demand cluster for storing and processing data.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "hostSubscriptionId": { + "type": "object", + "description": "The customer’s subscription to host the cluster. Type: string (or Expression with resultType string)." + }, + "servicePrincipalId": { + "type": "object", + "description": "The service principal id for the hostSubscriptionId. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "description": "The key for the service principal id.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "tenant": { + "type": "object", + "description": "The Tenant id/name to which the service principal belongs. Type: string (or Expression with resultType string)." + }, + "clusterResourceGroup": { + "type": "object", + "description": "The resource group where the cluster belongs. Type: string (or Expression with resultType string)." + }, + "clusterNamePrefix": { + "type": "object", + "description": "The prefix of cluster name, postfix will be distinct with timestamp. Type: string (or Expression with resultType string)." + }, + "clusterUserName": { + "type": "object", + "description": "The username to access the cluster. Type: string (or Expression with resultType string)." + }, + "clusterPassword": { + "description": "The password to access the cluster.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "clusterSshUserName": { + "type": "object", + "description": "The username to SSH remotely connect to cluster’s node (for Linux). Type: string (or Expression with resultType string)." + }, + "clusterSshPassword": { + "description": "The password to SSH remotely connect cluster’s node (for Linux).", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "additionalLinkedServiceNames": { + "description": "Specifies additional storage accounts for the HDInsight linked service so that the Data Factory service can register them on your behalf.", + "type": "array", + "items": { + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + } + }, + "hcatalogLinkedServiceName": { + "description": "The name of Azure SQL linked service that point to the HCatalog database. The on-demand HDInsight cluster is created by using the Azure SQL database as the metastore.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "clusterType": { + "type": "object", + "description": "The cluster type. Type: string (or Expression with resultType string)." + }, + "sparkVersion": { + "type": "object", + "description": "The version of spark if the cluster type is 'spark'. Type: string (or Expression with resultType string)." + }, + "coreConfiguration": { + "description": "Specifies the core configuration parameters (as in core-site.xml) for the HDInsight cluster to be created.", + "type": "object" + }, + "hBaseConfiguration": { + "description": "Specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster.", + "type": "object" + }, + "hdfsConfiguration": { + "description": "Specifies the HDFS configuration parameters (hdfs-site.xml) for the HDInsight cluster.", + "type": "object" + }, + "hiveConfiguration": { + "description": "Specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster.", + "type": "object" + }, + "mapReduceConfiguration": { + "description": "Specifies the MapReduce configuration parameters (mapred-site.xml) for the HDInsight cluster.", + "type": "object" + }, + "oozieConfiguration": { + "description": "Specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster.", + "type": "object" + }, + "stormConfiguration": { + "description": "Specifies the Storm configuration parameters (storm-site.xml) for the HDInsight cluster.", + "type": "object" + }, + "yarnConfiguration": { + "description": "Specifies the Yarn configuration parameters (yarn-site.xml) for the HDInsight cluster.", + "type": "object" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + }, + "headNodeSize": { + "type": "object", + "description": "Specifies the size of the head node for the HDInsight cluster." + }, + "dataNodeSize": { + "type": "object", + "description": "Specifies the size of the data node for the HDInsight cluster." + }, + "zookeeperNodeSize": { + "type": "object", + "description": "Specifies the size of the Zoo Keeper node for the HDInsight cluster." + }, + "scriptActions": { + "description": "Custom script actions to run on HDI ondemand cluster once it's up. Please refer to https://docs.microsoft.com/en-us/azure/hdinsight/hdinsight-hadoop-customize-cluster-linux?toc=%2Fen-us%2Fazure%2Fhdinsight%2Fr-server%2FTOC.json&bc=%2Fen-us%2Fazure%2Fbread%2Ftoc.json#understanding-script-actions.", + "type": "array", + "items": { + "$ref": "#/definitions/ScriptAction" + } + }, + "virtualNetworkId": { + "type": "object", + "description": "The ARM resource ID for the vNet to which the cluster should be joined after creation. Type: string (or Expression with resultType string)." + }, + "subnetName": { + "type": "object", + "description": "The ARM resource ID for the subnet in the vNet. If virtualNetworkId was specified, then this property is required. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "clusterSize", + "timeToLive", + "version", + "linkedServiceName", + "hostSubscriptionId", + "tenant", + "clusterResourceGroup" + ] + }, + "ScriptAction": { + "description": "Custom script action to run on HDI ondemand cluster once it's up.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The user provided name of the script action." + }, + "uri": { + "type": "string", + "description": "The URI for the script action." + }, + "roles": { + "x-ms-enum": { + "name": "HdiNodeTypes", + "modelAsString": true + }, + "enum": [ + "Headnode", + "Workernode", + "Zookeeper" + ], + "type": "string", + "description": "The node types on which the script action should be executed." + }, + "parameters": { + "type": "string", + "description": "The parameters for the script action." + } + }, + "required": [ + "name", + "uri", + "roles" + ] + }, + "AzureDataLakeAnalyticsLinkedService": { + "x-ms-discriminator-value": "AzureDataLakeAnalytics", + "description": "Azure Data Lake Analytics linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Data Lake Analytics linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureDataLakeAnalyticsLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureDataLakeAnalyticsLinkedServiceTypeProperties": { + "description": "Azure Data Lake Analytics linked service properties.", + "type": "object", + "properties": { + "accountName": { + "type": "object", + "description": "The Azure Data Lake Analytics account name. Type: string (or Expression with resultType string)." + }, + "servicePrincipalId": { + "type": "object", + "description": "The ID of the application used to authenticate against the Azure Data Lake Analytics account. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "description": "The Key of the application used to authenticate against the Azure Data Lake Analytics account.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "tenant": { + "type": "object", + "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." + }, + "subscriptionId": { + "type": "object", + "description": "Data Lake Analytics account subscription ID (if different from Data Factory account). Type: string (or Expression with resultType string)." + }, + "resourceGroupName": { + "type": "object", + "description": "Data Lake Analytics account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string)." + }, + "dataLakeAnalyticsUri": { + "type": "object", + "description": "Azure Data Lake Analytics URI Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "accountName", + "tenant" + ] + }, + "AzureDatabricksLinkedService": { + "x-ms-discriminator-value": "AzureDatabricks", + "description": "Azure Databricks linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Databricks linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureDatabricksLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureDatabricksLinkedServiceTypeProperties": { + "description": "Azure Databricks linked service properties.", + "type": "object", + "properties": { + "domain": { + "type": "object", + "description": ".azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string)." + }, + "accessToken": { + "description": "Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string (or Expression with resultType string).", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "authentication": { + "type": "object", + "description": "Required to specify MSI, if using Workspace resource id for databricks REST API. Type: string (or Expression with resultType string)." + }, + "workspaceResourceId": { + "type": "object", + "description": "Workspace resource id for databricks REST API. Type: string (or Expression with resultType string)." + }, + "existingClusterId": { + "type": "object", + "description": "The id of an existing interactive cluster that will be used for all runs of this activity. Type: string (or Expression with resultType string)." + }, + "instancePoolId": { + "type": "object", + "description": "The id of an existing instance pool that will be used for all runs of this activity. Type: string (or Expression with resultType string)." + }, + "newClusterVersion": { + "type": "object", + "description": "If not using an existing interactive cluster, this specifies the Spark version of a new job cluster or instance pool nodes created for each run of this activity. Required if instancePoolId is specified. Type: string (or Expression with resultType string)." + }, + "newClusterNumOfWorker": { + "type": "object", + "description": "If not using an existing interactive cluster, this specifies the number of worker nodes to use for the new job cluster or instance pool. For new job clusters, this a string-formatted Int32, like '1' means numOfWorker is 1 or '1:10' means auto-scale from 1 (min) to 10 (max). For instance pools, this is a string-formatted Int32, and can only specify a fixed number of worker nodes, such as '2'. Required if newClusterVersion is specified. Type: string (or Expression with resultType string)." + }, + "newClusterNodeType": { + "type": "object", + "description": "The node type of the new job cluster. This property is required if newClusterVersion is specified and instancePoolId is not specified. If instancePoolId is specified, this property is ignored. Type: string (or Expression with resultType string)." + }, + "newClusterSparkConf": { + "description": "A set of optional, user-specified Spark configuration key-value pairs.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "newClusterSparkEnvVars": { + "description": "A set of optional, user-specified Spark environment variables key-value pairs.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "newClusterCustomTags": { + "description": "Additional tags for cluster resources. This property is ignored in instance pool configurations.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "newClusterLogDestination": { + "type": "object", + "description": "Specify a location to deliver Spark driver, worker, and event logs. Type: string (or Expression with resultType string)." + }, + "newClusterDriverNodeType": { + "type": "object", + "description": "The driver node type for the new job cluster. This property is ignored in instance pool configurations. Type: string (or Expression with resultType string)." + }, + "newClusterInitScripts": { + "type": "object", + "description": "User-defined initialization scripts for the new cluster. Type: array of strings (or Expression with resultType array of strings)." + }, + "newClusterEnableElasticDisk": { + "type": "object", + "description": "Enable the elastic disk on the new cluster. This property is now ignored, and takes the default elastic disk behavior in Databricks (elastic disks are always enabled). Type: boolean (or Expression with resultType boolean)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + }, + "policyId": { + "type": "object", + "description": "The policy id for limiting the ability to configure clusters based on a user defined set of rules. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "domain" + ] + }, + "AzureDatabricksDeltaLakeLinkedService": { + "x-ms-discriminator-value": "AzureDatabricksDeltaLake", + "description": "Azure Databricks Delta Lake linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Databricks Delta Lake linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureDatabricksDetltaLakeLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureDatabricksDetltaLakeLinkedServiceTypeProperties": { + "description": "Azure Databricks Delta Lake linked service properties.", + "type": "object", + "properties": { + "domain": { + "type": "object", + "description": ".azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string)." + }, + "accessToken": { + "description": "Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string, SecureString or AzureKeyVaultSecretReference.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "clusterId": { + "type": "object", + "description": "The id of an existing interactive cluster that will be used for all runs of this job. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "domain", + "accessToken" + ] + }, + "ResponsysLinkedService": { + "x-ms-discriminator-value": "Responsys", + "description": "Responsys linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Responsys linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ResponsysLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ResponsysLinkedServiceTypeProperties": { + "description": "Responsys linked service properties.", + "type": "object", + "properties": { + "endpoint": { + "description": "The endpoint of the Responsys server.", + "type": "object" + }, + "clientId": { + "description": "The client ID associated with the Responsys application. Type: string (or Expression with resultType string).", + "type": "object" + }, + "clientSecret": { + "description": "The client secret associated with the Responsys application. Type: string (or Expression with resultType string).", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "endpoint", + "clientId" + ] + }, + "DynamicsAXLinkedService": { + "x-ms-discriminator-value": "DynamicsAX", + "description": "Dynamics AX linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Dynamics AX linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DynamicsAXLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DynamicsAXLinkedServiceTypeProperties": { + "description": "Dynamics AX linked service properties.", + "type": "object", + "properties": { + "url": { + "description": "The Dynamics AX (or Dynamics 365 Finance and Operations) instance OData endpoint.", + "type": "object" + }, + "servicePrincipalId": { + "description": "Specify the application's client ID. Type: string (or Expression with resultType string).", + "type": "object" + }, + "servicePrincipalKey": { + "description": "Specify the application's key. Mark this field as a SecureString to store it securely in Data Factory, or reference a secret stored in Azure Key Vault. Type: string (or Expression with resultType string).", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "tenant": { + "description": "Specify the tenant information (domain name or tenant ID) under which your application resides. Retrieve it by hovering the mouse in the top-right corner of the Azure portal. Type: string (or Expression with resultType string).", + "type": "object" + }, + "aadResourceId": { + "description": "Specify the resource you are requesting authorization. Type: string (or Expression with resultType string).", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "url", + "servicePrincipalId", + "servicePrincipalKey", + "tenant", + "aadResourceId" + ] + }, + "OracleServiceCloudLinkedService": { + "x-ms-discriminator-value": "OracleServiceCloud", + "description": "Oracle Service Cloud linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Oracle Service Cloud linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/OracleServiceCloudLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "OracleServiceCloudLinkedServiceTypeProperties": { + "description": "Oracle Service Cloud linked service properties.", + "type": "object", + "properties": { + "host": { + "description": "The URL of the Oracle Service Cloud instance.", + "type": "object" + }, + "username": { + "description": "The user name that you use to access Oracle Service Cloud server.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name that you provided in the username key.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "username", + "password" + ] + }, + "GoogleAdWordsLinkedService": { + "x-ms-discriminator-value": "GoogleAdWords", + "description": "Google AdWords service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Google AdWords service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GoogleAdWordsLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "GoogleAdWordsLinkedServiceTypeProperties": { + "description": "Google AdWords service linked service properties.", + "type": "object", + "properties": { + "clientCustomerID": { + "description": "The Client customer ID of the AdWords account that you want to fetch report data for.", + "type": "object" + }, + "developerToken": { + "description": "The developer token associated with the manager account that you use to grant access to the AdWords API.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "authenticationType": { + "description": "The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR.", + "type": "string", + "enum": [ + "ServiceAuthentication", + "UserAuthentication" + ], + "x-ms-enum": { + "name": "GoogleAdWordsAuthenticationType", + "modelAsString": true + } + }, + "refreshToken": { + "description": "The refresh token obtained from Google for authorizing access to AdWords for UserAuthentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "clientId": { + "description": "The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).", + "type": "object" + }, + "clientSecret": { + "description": "The client secret of the google application used to acquire the refresh token.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "email": { + "description": "The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.", + "type": "object" + }, + "keyFilePath": { + "description": "The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "useSystemTrustStore": { + "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "clientCustomerID", + "developerToken", + "authenticationType" + ] + }, + "SapTableLinkedService": { + "x-ms-discriminator-value": "SapTable", + "description": "SAP Table Linked Service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this linked service type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SapTableLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SapTableLinkedServiceTypeProperties": { + "description": "Properties specific to this linked service type.", + "type": "object", + "properties": { + "server": { + "type": "object", + "description": "Host name of the SAP instance where the table is located. Type: string (or Expression with resultType string)." + }, + "systemNumber": { + "type": "object", + "description": "System number of the SAP system where the table is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string)." + }, + "clientId": { + "type": "object", + "description": "Client ID of the client on the SAP system where the table is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string)." + }, + "language": { + "type": "object", + "description": "Language of the SAP system where the table is located. The default value is EN. Type: string (or Expression with resultType string)." + }, + "systemId": { + "type": "object", + "description": "SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string)." + }, + "userName": { + "type": "object", + "description": "Username to access the SAP server where the table is located. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password to access the SAP server where the table is located.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "messageServer": { + "type": "object", + "description": "The hostname of the SAP Message Server. Type: string (or Expression with resultType string)." + }, + "messageServerService": { + "type": "object", + "description": "The service name or port number of the Message Server. Type: string (or Expression with resultType string)." + }, + "sncMode": { + "type": "object", + "description": "SNC activation indicator to access the SAP server where the table is located. Must be either 0 (off) or 1 (on). Type: string (or Expression with resultType string)." + }, + "sncMyName": { + "type": "object", + "description": "Initiator's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string)." + }, + "sncPartnerName": { + "type": "object", + "description": "Communication partner's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string)." + }, + "sncLibraryPath": { + "type": "object", + "description": "External security product's library to access the SAP server where the table is located. Type: string (or Expression with resultType string)." + }, + "sncQop": { + "type": "object", + "description": "SNC Quality of Protection. Allowed value include: 1, 2, 3, 8, 9. Type: string (or Expression with resultType string)." + }, + "logonGroup": { + "type": "object", + "description": "The Logon Group for the SAP System. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + } + }, + "AzureDataExplorerLinkedService": { + "x-ms-discriminator-value": "AzureDataExplorer", + "description": "Azure Data Explorer (Kusto) linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Data Explorer (Kusto) linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureDataExplorerLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureDataExplorerLinkedServiceTypeProperties": { + "description": "Azure Data Explorer (Kusto) linked service properties.", + "type": "object", + "properties": { + "endpoint": { + "description": "The endpoint of Azure Data Explorer (the engine's endpoint). URL will be in the format https://..kusto.windows.net. Type: string (or Expression with resultType string)", + "type": "object" + }, + "servicePrincipalId": { + "type": "object", + "description": "The ID of the service principal used to authenticate against Azure Data Explorer. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The key of the service principal used to authenticate against Kusto." + }, + "database": { + "type": "object", + "description": "Database name for connection. Type: string (or Expression with resultType string)." + }, + "tenant": { + "type": "object", + "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "endpoint", + "servicePrincipalId", + "servicePrincipalKey", + "database", + "tenant" + ] + }, + "AzureFunctionLinkedService": { + "x-ms-discriminator-value": "AzureFunction", + "description": "Azure Function linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Function linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFunctionLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureFunctionLinkedServiceTypeProperties": { + "description": "Azure Function linked service properties.", + "type": "object", + "properties": { + "functionAppUrl": { + "description": "The endpoint of the Azure Function App. URL will be in the format https://.azurewebsites.net.", + "type": "object" + }, + "functionKey": { + "description": "Function or Host key for Azure Function App.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "functionAppUrl" + ] + }, + "SnowflakeLinkedService": { + "x-ms-discriminator-value": "Snowflake", + "description": "Snowflake linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Snowflake linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SnowflakeLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SnowflakeLinkedServiceTypeProperties": { + "description": "Snowflake linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The connection string of snowflake. Type: string, SecureString.", + "type": "object" + }, + "password": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "SharePointOnlineListLinkedService": { + "x-ms-discriminator-value": "SharePointOnlineList", + "description": "SharePoint Online List linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "SharePoint Online List linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SharePointOnlineListLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SharePointOnlineListLinkedServiceTypeProperties": { + "description": "SharePoint Online List linked service properties.", + "type": "object", + "properties": { + "siteUrl": { + "type": "object", + "description": "The URL of the SharePoint Online site. For example, https://contoso.sharepoint.com/sites/siteName. Type: string (or Expression with resultType string)." + }, + "tenantId": { + "type": "object", + "description": "The tenant ID under which your application resides. You can find it from Azure portal Active Directory overview page. Type: string (or Expression with resultType string)." + }, + "servicePrincipalId": { + "type": "object", + "description": "The application (client) ID of your application registered in Azure Active Directory. Make sure to grant SharePoint site permission to this application. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "description": "The client secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "siteUrl", + "tenantId", + "servicePrincipalId", + "servicePrincipalKey" + ] + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/Notebook.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/Notebook.json new file mode 100644 index 000000000000..fe38b3840978 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/Notebook.json @@ -0,0 +1,258 @@ +{ + "swagger": "2.0", + "info": { + "title": "ArtifactsClient", + "version": "2021-06-01-preview" + }, + "paths": {}, + "definitions": { + "Notebook": { + "description": "Notebook.", + "type": "object", + "properties": { + "description": { + "description": "The description of the notebook.", + "type": "string" + }, + "bigDataPool": { + "description": "Big data pool reference.", + "$ref": "#/definitions/BigDataPoolReference", + "x-nullable": true + }, + "sessionProperties": { + "description": "Session properties.", + "$ref": "#/definitions/NotebookSessionProperties", + "x-nullable": true + }, + "metadata": { + "description": "Notebook root-level metadata.", + "$ref": "#/definitions/NotebookMetadata" + }, + "nbformat": { + "description": "Notebook format (major number). Incremented between backwards incompatible changes to the notebook format.", + "type": "integer" + }, + "nbformat_minor": { + "description": "Notebook format (minor number). Incremented for backward compatible changes to the notebook format.", + "type": "integer" + }, + "cells": { + "description": "Array of cells of the current notebook.", + "type": "array", + "items": { + "$ref": "#/definitions/NotebookCell" + } + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "metadata", + "nbformat_minor", + "nbformat", + "cells" + ] + }, + "BigDataPoolReference": { + "description": "Big data pool reference.", + "type": "object", + "properties": { + "type": { + "description": "Big data pool reference type.", + "type": "string", + "enum": [ + "BigDataPoolReference" + ], + "x-ms-enum": { + "name": "BigDataPoolReferenceType", + "modelAsString": true + } + }, + "referenceName": { + "description": "Reference big data pool name.", + "type": "string" + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "NotebookMetadata": { + "description": "Notebook root-level metadata.", + "type": "object", + "properties": { + "kernelspec": { + "description": "Kernel information.", + "$ref": "#/definitions/NotebookKernelSpec" + }, + "language_info": { + "description": "Language info.", + "$ref": "#/definitions/NotebookLanguageInfo", + "x-nullable": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "NotebookKernelSpec": { + "description": "Kernel information.", + "type": "object", + "properties": { + "name": { + "description": "Name of the kernel specification.", + "type": "string" + }, + "display_name": { + "description": "Name to display in UI.", + "type": "string" + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "name", + "display_name" + ] + }, + "NotebookLanguageInfo": { + "description": "Language info.", + "type": "object", + "properties": { + "name": { + "description": "The programming language which this kernel runs.", + "type": "string" + }, + "codemirror_mode": { + "description": "The codemirror mode to use for code in this language.", + "type": "string" + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "name" + ] + }, + "NotebookCell": { + "description": "Notebook cell.", + "type": "object", + "properties": { + "cell_type": { + "description": "String identifying the type of cell.", + "type": "string" + }, + "metadata": { + "description": "Cell-level metadata.", + "type": "object" + }, + "source": { + "description": "Contents of the cell, represented as an array of lines.", + "type": "array", + "items": { + "type": "string" + } + }, + "attachments": { + "description": "Attachments associated with the cell.", + "type": "object", + "x-nullable": true + }, + "outputs": { + "description": "Cell-level output items.", + "type": "array", + "items": { + "$ref": "#/definitions/NotebookCellOutputItem" + } + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "cell_type", + "metadata", + "source" + ] + }, + "NotebookSessionProperties": { + "description": "Session properties.", + "type": "object", + "properties": { + "driverMemory": { + "description": "Amount of memory to use for the driver process.", + "type": "string" + }, + "driverCores": { + "description": "Number of cores to use for the driver.", + "type": "integer" + }, + "executorMemory": { + "description": "Amount of memory to use per executor process.", + "type": "string" + }, + "executorCores": { + "description": "Number of cores to use for each executor.", + "type": "integer" + }, + "numExecutors": { + "description": "Number of executors to launch for this session.", + "type": "integer" + } + }, + "required": [ + "driverMemory", + "driverCores", + "executorMemory", + "executorCores", + "numExecutors" + ] + }, + "NotebookCellOutputItem": { + "description": "An item of the notebook cell execution output.", + "type": "object", + "properties": { + "name": { + "description": "For output_type=stream, determines the name of stream (stdout / stderr).", + "type": "string" + }, + "execution_count": { + "description": "Execution sequence number.", + "type": "integer" + }, + "output_type": { + "description": "Execution, display, or stream outputs.", + "type": "string", + "enum": [ + "execute_result", + "display_data", + "stream", + "error" + ], + "x-ms-enum": { + "name": "CellOutputType", + "modelAsString": true + } + }, + "text": { + "description": "For output_type=stream, the stream's text output, represented as a string or an array of strings." + }, + "data": { + "description": "Output data. Use MIME type as key, and content as value.", + "type": "object" + }, + "metadata": { + "description": "Metadata for the output item.", + "type": "object" + } + }, + "required": [ + "output_type" + ] + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/Pipeline.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/Pipeline.json new file mode 100644 index 000000000000..4abc9efc59a9 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/Pipeline.json @@ -0,0 +1,7158 @@ +{ + "swagger": "2.0", + "info": { + "title": "ArtifactsClient", + "version": "2021-06-01-preview" + }, + "paths": {}, + "definitions": { + "Pipeline": { + "description": "A workspace pipeline.", + "type": "object", + "properties": { + "description": { + "description": "The description of the pipeline.", + "type": "string" + }, + "activities": { + "type": "array", + "description": "List of activities in pipeline.", + "items": { + "$ref": "#/definitions/Activity" + } + }, + "parameters": { + "$ref": "../artifacts.json#/definitions/ParameterDefinitionSpecification", + "description": "List of parameters for pipeline." + }, + "variables": { + "$ref": "../artifacts.json#/definitions/VariableDefinitionSpecification", + "description": "List of variables for pipeline." + }, + "concurrency": { + "type": "integer", + "minimum": 1, + "description": "The max number of concurrent runs for the pipeline." + }, + "annotations": { + "description": "List of tags that can be used for describing the Pipeline.", + "type": "array", + "items": { + "type": "object" + } + }, + "runDimensions": { + "description": "Dimensions emitted by Pipeline.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "folder": { + "description": "The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level.", + "type": "object", + "properties": { + "name": { + "description": "The name of the folder that this Pipeline is in.", + "type": "string" + } + } + } + } + }, + "Activity": { + "discriminator": "type", + "description": "A pipeline activity.", + "type": "object", + "properties": { + "name": { + "description": "Activity name.", + "type": "string" + }, + "type": { + "type": "string", + "description": "Type of activity." + }, + "description": { + "description": "Activity description.", + "type": "string" + }, + "dependsOn": { + "type": "array", + "description": "Activity depends on condition.", + "items": { + "$ref": "#/definitions/ActivityDependency" + } + }, + "userProperties": { + "type": "array", + "description": "Activity user properties.", + "items": { + "$ref": "#/definitions/UserProperty" + } + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "name", + "type" + ] + }, + "UserProperty": { + "description": "User property.", + "type": "object", + "properties": { + "name": { + "description": "User property name.", + "type": "string" + }, + "value": { + "description": "User property value. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "name", + "value" + ] + }, + "ActivityDependency": { + "description": "Activity dependency information.", + "type": "object", + "properties": { + "activity": { + "description": "Activity name.", + "type": "string" + }, + "dependencyConditions": { + "type": "array", + "description": "Match-Condition for the dependency.", + "items": { + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Skipped", + "Completed" + ], + "x-ms-enum": { + "name": "DependencyCondition", + "modelAsString": true + } + } + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "activity", + "dependencyConditions" + ] + }, + "ControlActivity": { + "x-ms-discriminator-value": "Container", + "type": "object", + "description": "Base class for all control activities like IfCondition, ForEach , Until.", + "allOf": [ + { + "$ref": "#/definitions/Activity" + } + ], + "properties": {} + }, + "ExecutionActivity": { + "x-ms-discriminator-value": "Execution", + "description": "Base class for all execution activities.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Activity" + } + ], + "properties": { + "linkedServiceName": { + "description": "Linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "policy": { + "$ref": "#/definitions/ActivityPolicy", + "description": "Activity policy." + } + } + }, + "ActivityPolicy": { + "description": "Execution policy for an activity.", + "type": "object", + "properties": { + "timeout": { + "type": "object", + "description": "Specifies the timeout for the activity to run. The default timeout is 7 days. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "retry": { + "type": "object", + "description": "Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "retryIntervalInSeconds": { + "type": "integer", + "description": "Interval between each retry attempt (in seconds). The default is 30 sec.", + "minimum": 30, + "maximum": 86400 + }, + "secureInput": { + "type": "boolean", + "description": "When set to true, Input from activity is considered as secure and will not be logged to monitoring." + }, + "secureOutput": { + "type": "boolean", + "description": "When set to true, Output from activity is considered as secure and will not be logged to monitoring." + } + }, + "additionalProperties": { + "type": "object" + } + }, + "StoreReadSettings": { + "description": "Connector read setting.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The read setting type." + }, + "maxConcurrentConnections": { + "type": "object", + "description": "The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "AzureBlobStorageReadSettings": { + "description": "Azure blob read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "Azure blob wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "Azure blob wildcardFileName. Type: string (or Expression with resultType string)." + }, + "prefix": { + "type": "object", + "description": "The prefix filter for the Azure Blob name. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "deleteFilesAfterCompletion": { + "type": "object", + "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + } + } + }, + "AzureBlobFSReadSettings": { + "description": "Azure blobFS read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "Azure blobFS wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "Azure blobFS wildcardFileName. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "deleteFilesAfterCompletion": { + "type": "object", + "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + } + } + }, + "AzureDataLakeStoreReadSettings": { + "description": "Azure data lake store read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "ADLS wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "ADLS wildcardFileName. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "listAfter": { + "type": "object", + "description": "Lists files after the value (exclusive) based on file/folder names’ lexicographical order. Applies under the folderPath in data set, and filter files/sub-folders under the folderPath. Type: string (or Expression with resultType string)." + }, + "listBefore": { + "type": "object", + "description": "Lists files before the value (inclusive) based on file/folder names’ lexicographical order. Applies under the folderPath in data set, and filter files/sub-folders under the folderPath. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "deleteFilesAfterCompletion": { + "type": "object", + "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + } + } + }, + "AmazonS3ReadSettings": { + "description": "Azure data lake store read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "AmazonS3 wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "AmazonS3 wildcardFileName. Type: string (or Expression with resultType string)." + }, + "prefix": { + "type": "object", + "description": "The prefix filter for the S3 object name. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "deleteFilesAfterCompletion": { + "type": "object", + "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + } + } + }, + "FileServerReadSettings": { + "description": "File server read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "FileServer wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "FileServer wildcardFileName. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "deleteFilesAfterCompletion": { + "type": "object", + "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "fileFilter": { + "type": "object", + "description": "Specify a filter to be used to select a subset of files in the folderPath rather than all files. Type: string (or Expression with resultType string)." + } + } + }, + "AzureFileStorageReadSettings": { + "description": "Azure File Storage read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "Azure File Storage wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "Azure File Storage wildcardFileName. Type: string (or Expression with resultType string)." + }, + "prefix": { + "type": "object", + "description": "The prefix filter for the Azure File name starting from root path. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "deleteFilesAfterCompletion": { + "type": "object", + "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + } + } + }, + "SftpWriteSettings": { + "description": "Sftp write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreWriteSettings" + } + ], + "properties": { + "operationTimeout": { + "description": "Specifies the timeout for writing each chunk to SFTP server. Default value: 01:00:00 (one hour). Type: string (or Expression with resultType string).", + "type": "object" + }, + "useTempFileRename": { + "description": "Upload to temporary file(s) and rename. Disable this option if your SFTP server doesn't support rename operation. Type: boolean (or Expression with resultType boolean).", + "type": "object" + } + } + }, + "GoogleCloudStorageReadSettings": { + "description": "Google Cloud Storage read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "Google Cloud Storage wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "Google Cloud Storage wildcardFileName. Type: string (or Expression with resultType string)." + }, + "prefix": { + "type": "object", + "description": "The prefix filter for the Google Cloud Storage object name. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "deleteFilesAfterCompletion": { + "type": "object", + "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + } + } + }, + "FtpReadSettings": { + "description": "Ftp read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "Ftp wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "Ftp wildcardFileName. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "deleteFilesAfterCompletion": { + "type": "object", + "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "useBinaryTransfer": { + "type": "boolean", + "description": "Specify whether to use binary transfer mode for FTP stores." + } + } + }, + "SftpReadSettings": { + "description": "Sftp read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "Sftp wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "Sftp wildcardFileName. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "deleteFilesAfterCompletion": { + "type": "object", + "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + } + } + }, + "HttpReadSettings": { + "description": "Sftp read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "requestMethod": { + "type": "object", + "description": "The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string)." + }, + "requestBody": { + "type": "object", + "description": "The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string)." + }, + "additionalHeaders": { + "type": "object", + "description": "The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string)." + }, + "requestTimeout": { + "type": "object", + "description": "Specifies the timeout for a HTTP client to get HTTP response from HTTP server." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + } + } + }, + "HdfsReadSettings": { + "description": "HDFS read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "HDFS wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "HDFS wildcardFileName. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "distcpSettings": { + "description": "Specifies Distcp-related settings.", + "$ref": "#/definitions/DistcpSettings" + }, + "deleteFilesAfterCompletion": { + "type": "object", + "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "StoreWriteSettings": { + "description": "Connector write settings.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The write setting type." + }, + "maxConcurrentConnections": { + "type": "object", + "description": "The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer)." + }, + "copyBehavior": { + "description": "The type of copy behavior for copy sink.", + "type": "object" + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "AzureBlobStorageWriteSettings": { + "description": "Azure blob write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreWriteSettings" + } + ], + "properties": { + "blockSizeInMB": { + "description": "Indicates the block size(MB) when writing data to blob. Type: integer (or Expression with resultType integer).", + "type": "object" + } + } + }, + "AzureBlobFSWriteSettings": { + "description": "Azure blobFS write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreWriteSettings" + } + ], + "properties": { + "blockSizeInMB": { + "description": "Indicates the block size(MB) when writing data to blob. Type: integer (or Expression with resultType integer).", + "type": "object" + } + } + }, + "AzureDataLakeStoreWriteSettings": { + "description": "Azure data lake store write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreWriteSettings" + } + ], + "properties": { + "expiryDateTime": { + "description": "Specifies the expiry time of the written files. The time is applied to the UTC time zone in the format of \"2018-12-01T05:00:00Z\". Default value is NULL. Type: integer (or Expression with resultType integer).", + "type": "object" + } + } + }, + "FileServerWriteSettings": { + "description": "File server write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreWriteSettings" + } + ] + }, + "AzureFileStorageWriteSettings": { + "description": "Azure File Storage write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreWriteSettings" + } + ] + }, + "FormatReadSettings": { + "description": "Format read settings.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The read setting type." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "CompressionReadSettings": { + "description": "Compression read settings.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The Compression setting type." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "ZipDeflateReadSettings": { + "description": "The ZipDeflate compression read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CompressionReadSettings" + } + ], + "properties": { + "preserveZipFileNameAsFolder": { + "description": "Preserve the zip file name as folder path. Type: boolean (or Expression with resultType boolean).", + "type": "object" + } + } + }, + "TarReadSettings": { + "description": "The Tar compression read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CompressionReadSettings" + } + ], + "properties": { + "preserveCompressionFileNameAsFolder": { + "description": "Preserve the compression file name as folder path. Type: boolean (or Expression with resultType boolean).", + "type": "object" + } + } + }, + "TarGZipReadSettings": { + "description": "The TarGZip compression read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CompressionReadSettings" + } + ], + "properties": { + "preserveCompressionFileNameAsFolder": { + "description": "Preserve the compression file name as folder path. Type: boolean (or Expression with resultType boolean).", + "type": "object" + } + } + }, + "DelimitedTextReadSettings": { + "description": "Delimited text read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatReadSettings" + } + ], + "properties": { + "skipLineCount": { + "type": "object", + "description": "Indicates the number of non-empty rows to skip when reading data from input files. Type: integer (or Expression with resultType integer)." + }, + "compressionProperties": { + "$ref": "#/definitions/CompressionReadSettings", + "description": "Compression settings." + } + } + }, + "JsonReadSettings": { + "description": "Json read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatReadSettings" + } + ], + "properties": { + "compressionProperties": { + "$ref": "#/definitions/CompressionReadSettings", + "description": "Compression settings." + } + } + }, + "XmlReadSettings": { + "description": "Xml read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatReadSettings" + } + ], + "properties": { + "compressionProperties": { + "$ref": "#/definitions/CompressionReadSettings", + "description": "Compression settings." + }, + "validationMode": { + "type": "object", + "description": "Indicates what validation method is used when reading the xml files. Allowed values: 'none', 'xsd', or 'dtd'. Type: string (or Expression with resultType string)." + }, + "detectDataType": { + "type": "object", + "description": "Indicates whether type detection is enabled when reading the xml files. Type: boolean (or Expression with resultType boolean)." + }, + "namespaces": { + "type": "object", + "description": "Indicates whether namespace is enabled when reading the xml files. Type: boolean (or Expression with resultType boolean)." + }, + "namespacePrefixes": { + "type": "object", + "description": "Namespace uri to prefix mappings to override the prefixes in column names when namespace is enabled, if no prefix is defined for a namespace uri, the prefix of xml element/attribute name in the xml data file will be used. Example: \"{\"http://www.example.com/xml\":\"prefix\"}\" Type: object (or Expression with resultType object)." + } + } + }, + "BinaryReadSettings": { + "description": "Binary read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatReadSettings" + } + ], + "properties": { + "compressionProperties": { + "$ref": "#/definitions/CompressionReadSettings", + "description": "Compression settings." + } + } + }, + "FormatWriteSettings": { + "description": "Format write settings.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The write setting type." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "AvroWriteSettings": { + "description": "Avro write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatWriteSettings" + } + ], + "properties": { + "recordName": { + "type": "string", + "description": "Top level record name in write result, which is required in AVRO spec." + }, + "recordNamespace": { + "type": "string", + "description": "Record namespace in the write result." + }, + "maxRowsPerFile": { + "type": "object", + "description": "Limit the written file's row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer)." + }, + "fileNamePrefix": { + "type": "object", + "description": "Specifies the file name pattern _. when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string)." + } + } + }, + "OrcWriteSettings": { + "description": "Orc write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatWriteSettings" + } + ], + "properties": { + "maxRowsPerFile": { + "type": "object", + "description": "Limit the written file's row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer)." + }, + "fileNamePrefix": { + "type": "object", + "description": "Specifies the file name pattern _. when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string)." + } + } + }, + "ParquetWriteSettings": { + "description": "Parquet write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatWriteSettings" + } + ], + "properties": { + "maxRowsPerFile": { + "type": "object", + "description": "Limit the written file's row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer)." + }, + "fileNamePrefix": { + "type": "object", + "description": "Specifies the file name pattern _. when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string)." + } + } + }, + "DelimitedTextWriteSettings": { + "description": "Delimited text write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatWriteSettings" + } + ], + "properties": { + "quoteAllText": { + "type": "object", + "description": "Indicates whether string values should always be enclosed with quotes. Type: boolean (or Expression with resultType boolean)." + }, + "fileExtension": { + "type": "object", + "description": "The file extension used to create the files. Type: string (or Expression with resultType string)." + }, + "maxRowsPerFile": { + "type": "object", + "description": "Limit the written file's row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer)." + }, + "fileNamePrefix": { + "type": "object", + "description": "Specifies the file name pattern _. when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "fileExtension" + ] + }, + "JsonWriteSettings": { + "description": "Json write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatWriteSettings" + } + ], + "properties": { + "filePattern": { + "description": "File pattern of JSON. This setting controls the way a collection of JSON objects will be treated. The default value is 'setOfObjects'. It is case-sensitive.", + "type": "string", + "enum": [ + "setOfObjects", + "arrayOfObjects" + ], + "x-ms-enum": { + "name": "JsonWriteFilePattern", + "modelAsString": true + } + } + } + }, + "AvroSource": { + "description": "A copy activity Avro source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "Avro store settings." + }, + "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)." + } + } + }, + "ExcelSource": { + "description": "A copy activity excel source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "Excel store settings." + }, + "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)." + } + } + }, + "ParquetSource": { + "description": "A copy activity Parquet source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "Parquet store settings." + }, + "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)." + } + } + }, + "DelimitedTextSource": { + "description": "A copy activity DelimitedText source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "DelimitedText store settings." + }, + "formatSettings": { + "$ref": "#/definitions/DelimitedTextReadSettings", + "description": "DelimitedText format settings." + }, + "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)." + } + } + }, + "JsonSource": { + "description": "A copy activity Json source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "Json store settings." + }, + "formatSettings": { + "$ref": "#/definitions/JsonReadSettings", + "description": "Json format settings." + }, + "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)." + } + } + }, + "XmlSource": { + "description": "A copy activity Xml source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "Xml store settings." + }, + "formatSettings": { + "$ref": "#/definitions/XmlReadSettings", + "description": "Xml format settings." + }, + "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)." + } + } + }, + "OrcSource": { + "description": "A copy activity ORC source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "ORC store settings." + }, + "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)." + } + } + }, + "DelimitedTextSink": { + "description": "A copy activity DelimitedText sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreWriteSettings", + "description": "DelimitedText store settings." + }, + "formatSettings": { + "$ref": "#/definitions/DelimitedTextWriteSettings", + "description": "DelimitedText format settings." + } + } + }, + "JsonSink": { + "description": "A copy activity Json sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreWriteSettings", + "description": "Json store settings." + }, + "formatSettings": { + "$ref": "#/definitions/JsonWriteSettings", + "description": "Json format settings." + } + } + }, + "OrcSink": { + "description": "A copy activity ORC sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreWriteSettings", + "description": "ORC store settings." + }, + "formatSettings": { + "$ref": "#/definitions/OrcWriteSettings", + "description": "ORC format settings." + } + } + }, + "CopyActivity": { + "x-ms-discriminator-value": "Copy", + "description": "Copy activity.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Copy activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CopyActivityTypeProperties" + }, + "inputs": { + "type": "array", + "description": "List of inputs for the activity.", + "items": { + "$ref": "../artifacts.json#/definitions/DatasetReference" + } + }, + "outputs": { + "type": "array", + "description": "List of outputs for the activity.", + "items": { + "$ref": "../artifacts.json#/definitions/DatasetReference" + } + } + }, + "required": [ + "typeProperties" + ] + }, + "CopyActivityTypeProperties": { + "description": "Copy activity properties.", + "type": "object", + "properties": { + "source": { + "description": "Copy activity source.", + "$ref": "#/definitions/CopySource" + }, + "sink": { + "description": "Copy activity sink.", + "$ref": "#/definitions/CopySink" + }, + "translator": { + "description": "Copy activity translator. If not specified, tabular translator is used.", + "type": "object" + }, + "enableStaging": { + "type": "object", + "description": "Specifies whether to copy data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean)." + }, + "stagingSettings": { + "description": "Specifies interim staging settings when EnableStaging is true.", + "$ref": "#/definitions/StagingSettings" + }, + "parallelCopies": { + "type": "object", + "description": "Maximum number of concurrent sessions opened on the source or sink to avoid overloading the data store. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "dataIntegrationUnits": { + "type": "object", + "description": "Maximum number of data integration units that can be used to perform this data movement. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "enableSkipIncompatibleRow": { + "type": "object", + "description": "Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with resultType boolean)." + }, + "redirectIncompatibleRowSettings": { + "description": "Redirect incompatible row settings when EnableSkipIncompatibleRow is true.", + "$ref": "#/definitions/RedirectIncompatibleRowSettings" + }, + "logStorageSettings": { + "description": "(Deprecated. Please use LogSettings) Log storage settings customer need to provide when enabling session log.", + "$ref": "#/definitions/LogStorageSettings" + }, + "logSettings": { + "description": "Log settings customer needs provide when enabling log.", + "$ref": "#/definitions/LogSettings" + }, + "preserveRules": { + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + }, + "description": "Preserve Rules." + }, + "preserve": { + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + }, + "description": "Preserve rules." + }, + "validateDataConsistency": { + "type": "object", + "description": "Whether to enable Data Consistency validation. Type: boolean (or Expression with resultType boolean)." + }, + "skipErrorFile": { + "description": "Specify the fault tolerance for data consistency.", + "$ref": "#/definitions/SkipErrorFile" + } + }, + "required": [ + "source", + "sink" + ] + }, + "CopySource": { + "discriminator": "type", + "description": "A copy activity source.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Copy source type." + }, + "sourceRetryCount": { + "type": "object", + "description": "Source retry count. Type: integer (or Expression with resultType integer)." + }, + "sourceRetryWait": { + "type": "object", + "description": "Source retry wait. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "maxConcurrentConnections": { + "type": "object", + "description": "The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "BinarySource": { + "description": "A copy activity Binary source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "Binary store settings." + }, + "formatSettings": { + "$ref": "#/definitions/BinaryReadSettings", + "description": "Binary format settings." + } + } + }, + "TabularSource": { + "description": "Copy activity sources of tabular type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "queryTimeout": { + "type": "object", + "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "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)." + } + } + }, + "AzureTableSource": { + "description": "A copy activity Azure Table source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "azureTableSourceQuery": { + "type": "object", + "description": "Azure Table source query. Type: string (or Expression with resultType string)." + }, + "azureTableSourceIgnoreTableNotFound": { + "type": "object", + "description": "Azure Table source ignore table not found. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "BlobSource": { + "description": "A copy activity Azure Blob source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "treatEmptyAsNull": { + "type": "object", + "description": "Treat empty as null. Type: boolean (or Expression with resultType boolean)." + }, + "skipHeaderLineCount": { + "type": "object", + "description": "Number of header lines to skip from each blob. Type: integer (or Expression with resultType integer)." + }, + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "DocumentDbCollectionSource": { + "description": "A copy activity Document Database Collection source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Documents query. Type: string (or Expression with resultType string)." + }, + "nestingSeparator": { + "type": "object", + "description": "Nested properties separator. Type: string (or Expression with resultType string)." + }, + "queryTimeout": { + "type": "object", + "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "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)." + } + } + }, + "CosmosDbSqlApiSource": { + "description": "A copy activity Azure CosmosDB (SQL API) Collection source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "SQL API query. Type: string (or Expression with resultType string)." + }, + "pageSize": { + "type": "object", + "description": "Page size of the result. Type: integer (or Expression with resultType integer)." + }, + "preferredRegions": { + "type": "object", + "description": "Preferred regions. Type: array of strings (or Expression with resultType array of strings)." + }, + "detectDatetime": { + "type": "object", + "description": "Whether detect primitive values as datetime values. Type: boolean (or Expression with resultType boolean)." + }, + "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)." + } + } + }, + "DynamicsSource": { + "description": "A copy activity Dynamics source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "FetchXML is a proprietary query language that is used in Microsoft Dynamics (online & on-premises). Type: string (or Expression with resultType string)." + }, + "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)." + } + } + }, + "DynamicsCrmSource": { + "description": "A copy activity Dynamics CRM source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "FetchXML is a proprietary query language that is used in Microsoft Dynamics CRM (online & on-premises). Type: string (or Expression with resultType string)." + }, + "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)." + } + } + }, + "CommonDataServiceForAppsSource": { + "description": "A copy activity Common Data Service for Apps source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "FetchXML is a proprietary query language that is used in Microsoft Common Data Service for Apps (online & on-premises). Type: string (or Expression with resultType string)." + }, + "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)." + } + } + }, + "RelationalSource": { + "description": "A copy activity source for various relational databases.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + }, + "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)." + } + } + }, + "InformixSource": { + "description": "A copy activity source for Informix.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "MicrosoftAccessSource": { + "description": "A copy activity source for Microsoft Access.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + }, + "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)." + } + } + }, + "Db2Source": { + "description": "A copy activity source for Db2 databases.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "OdbcSource": { + "description": "A copy activity source for ODBC databases.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "MySqlSource": { + "description": "A copy activity source for MySQL databases.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "PostgreSqlSource": { + "description": "A copy activity source for PostgreSQL databases.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "SybaseSource": { + "description": "A copy activity source for Sybase databases.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "SapBwSource": { + "description": "A copy activity source for SapBW server via MDX.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "MDX query. Type: string (or Expression with resultType string)." + } + } + }, + "ODataSource": { + "description": "A copy activity source for OData source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "OData query. For example, \"$top=1\". Type: string (or Expression with resultType string)." + }, + "httpRequestTimeout": { + "type": "object", + "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "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)." + } + } + }, + "SalesforceSource": { + "description": "A copy activity Salesforce source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + }, + "readBehavior": { + "description": "The read behavior for the operation. Default is Query.", + "type": "string", + "enum": [ + "Query", + "QueryAll" + ], + "x-ms-enum": { + "name": "SalesforceSourceReadBehavior", + "modelAsString": true + } + } + } + }, + "SalesforceServiceCloudSource": { + "description": "A copy activity Salesforce Service Cloud source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + }, + "readBehavior": { + "description": "The read behavior for the operation. Default is Query.", + "type": "string", + "enum": [ + "Query", + "QueryAll" + ], + "x-ms-enum": { + "name": "SalesforceSourceReadBehavior", + "modelAsString": true + } + }, + "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)." + } + } + }, + "SapCloudForCustomerSource": { + "description": "A copy activity source for SAP Cloud for Customer source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "SAP Cloud for Customer OData query. For example, \"$top=1\". Type: string (or Expression with resultType string)." + }, + "httpRequestTimeout": { + "type": "object", + "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, + "SapEccSource": { + "description": "A copy activity source for SAP ECC source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "SAP ECC OData query. For example, \"$top=1\". Type: string (or Expression with resultType string)." + }, + "httpRequestTimeout": { + "type": "object", + "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, + "SapHanaSource": { + "description": "A copy activity source for SAP HANA source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "SAP HANA Sql query. Type: string (or Expression with resultType string)." + }, + "packetSize": { + "type": "object", + "description": "The packet size of data read from SAP HANA. Type: integer(or Expression with resultType integer)." + }, + "partitionOption": { + "description": "The partition mechanism that will be used for SAP HANA read in parallel.", + "type": "string", + "enum": [ + "None", + "PhysicalPartitionsOfTable", + "SapHanaDynamicRange" + ], + "x-ms-enum": { + "name": "SapHanaPartitionOption", + "modelAsString": true + } + }, + "partitionSettings": { + "description": "The settings that will be leveraged for SAP HANA source partitioning.", + "$ref": "#/definitions/SapHanaPartitionSettings" + } + } + }, + "SapHanaPartitionSettings": { + "description": "The settings that will be leveraged for SAP HANA source partitioning.", + "type": "object", + "properties": { + "partitionColumnName": { + "type": "object", + "description": "The name of the column that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + } + } + }, + "SapOpenHubSource": { + "description": "A copy activity source for SAP Business Warehouse Open Hub Destination source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "excludeLastRequest": { + "type": "object", + "description": "Whether to exclude the records of the last request. The default value is true. Type: boolean (or Expression with resultType boolean)." + }, + "baseRequestId": { + "type": "object", + "description": "The ID of request for delta loading. Once it is set, only data with requestId larger than the value of this property will be retrieved. The default value is 0. Type: integer (or Expression with resultType integer )." + }, + "customRfcReadTableFunctionModule": { + "type": "object", + "description": "Specifies the custom RFC function module that will be used to read data from SAP Table. Type: string (or Expression with resultType string)." + }, + "sapDataColumnDelimiter": { + "type": "object", + "description": "The single character that will be used as delimiter passed to SAP RFC as well as splitting the output data retrieved. Type: string (or Expression with resultType string)." + } + } + }, + "SapTableSource": { + "description": "A copy activity source for SAP Table source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "rowCount": { + "type": "object", + "description": "The number of rows to be retrieved. Type: integer(or Expression with resultType integer)." + }, + "rowSkips": { + "type": "object", + "description": "The number of rows that will be skipped. Type: integer (or Expression with resultType integer)." + }, + "rfcTableFields": { + "type": "object", + "description": "The fields of the SAP table that will be retrieved. For example, column0, column1. Type: string (or Expression with resultType string)." + }, + "rfcTableOptions": { + "type": "object", + "description": "The options for the filtering of the SAP Table. For example, COLUMN0 EQ SOME VALUE. Type: string (or Expression with resultType string)." + }, + "batchSize": { + "type": "object", + "description": "Specifies the maximum number of rows that will be retrieved at a time when retrieving data from SAP Table. Type: integer (or Expression with resultType integer)." + }, + "customRfcReadTableFunctionModule": { + "type": "object", + "description": "Specifies the custom RFC function module that will be used to read data from SAP Table. Type: string (or Expression with resultType string)." + }, + "sapDataColumnDelimiter": { + "type": "object", + "description": "The single character that will be used as delimiter passed to SAP RFC as well as splitting the output data retrieved. Type: string (or Expression with resultType string)." + }, + "partitionOption": { + "description": "The partition mechanism that will be used for SAP table read in parallel.", + "type": "string", + "enum": [ + "None", + "PartitionOnInt", + "PartitionOnCalendarYear", + "PartitionOnCalendarMonth", + "PartitionOnCalendarDate", + "PartitionOnTime" + ], + "x-ms-enum": { + "name": "SapTablePartitionOption", + "modelAsString": true + } + }, + "partitionSettings": { + "description": "The settings that will be leveraged for SAP table source partitioning.", + "$ref": "#/definitions/SapTablePartitionSettings" + } + } + }, + "SapTablePartitionSettings": { + "description": "The settings that will be leveraged for SAP table source partitioning.", + "type": "object", + "properties": { + "partitionColumnName": { + "type": "object", + "description": "The name of the column that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "partitionUpperBound": { + "type": "object", + "description": "The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "partitionLowerBound": { + "type": "object", + "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "maxPartitionsNumber": { + "type": "object", + "description": "The maximum value of partitions the table will be split into. Type: integer (or Expression with resultType string)." + } + } + }, + "RestSink": { + "description": "A copy activity Rest service Sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "requestMethod": { + "type": "object", + "description": "The HTTP method used to call the RESTful API. The default is POST. Type: string (or Expression with resultType string)." + }, + "additionalHeaders": { + "type": "object", + "description": "The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string)." + }, + "httpRequestTimeout": { + "type": "object", + "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:01:40. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "requestInterval": { + "type": "object", + "description": "The time to await before sending next request, in milliseconds " + }, + "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. " + } + } + }, + "RestSource": { + "description": "A copy activity Rest service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "requestMethod": { + "type": "object", + "description": "The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string)." + }, + "requestBody": { + "type": "object", + "description": "The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string)." + }, + "additionalHeaders": { + "type": "object", + "description": "The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string)." + }, + "paginationRules": { + "type": "object", + "description": "The pagination rules to compose next page requests. Type: string (or Expression with resultType string)." + }, + "httpRequestTimeout": { + "type": "object", + "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:01:40. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "requestInterval": { + "type": "object", + "description": "The time to await before sending next page request. " + }, + "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)." + } + } + }, + "SqlSource": { + "description": "A copy activity SQL source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "sqlReaderQuery": { + "type": "object", + "description": "SQL reader query. Type: string (or Expression with resultType string)." + }, + "sqlReaderStoredProcedureName": { + "type": "object", + "description": "Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "isolationLevel": { + "description": "Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string).", + "type": "object" + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", + "type": "object" + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "$ref": "#/definitions/SqlPartitionSettings" + } + } + }, + "SqlServerSource": { + "description": "A copy activity SQL server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "sqlReaderQuery": { + "type": "object", + "description": "SQL reader query. Type: string (or Expression with resultType string)." + }, + "sqlReaderStoredProcedureName": { + "type": "object", + "description": "Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "produceAdditionalTypes": { + "description": "Which additional types to produce.", + "type": "object" + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", + "type": "object" + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "$ref": "#/definitions/SqlPartitionSettings" + } + } + }, + "AzureSqlSource": { + "description": "A copy activity Azure SQL source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "sqlReaderQuery": { + "type": "object", + "description": "SQL reader query. Type: string (or Expression with resultType string)." + }, + "sqlReaderStoredProcedureName": { + "type": "object", + "description": "Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "produceAdditionalTypes": { + "description": "Which additional types to produce.", + "type": "object" + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", + "type": "object" + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "$ref": "#/definitions/SqlPartitionSettings" + } + } + }, + "SqlMISource": { + "description": "A copy activity Azure SQL Managed Instance source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "sqlReaderQuery": { + "type": "object", + "description": "SQL reader query. Type: string (or Expression with resultType string)." + }, + "sqlReaderStoredProcedureName": { + "type": "object", + "description": "Name of the stored procedure for a Azure SQL Managed Instance source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "produceAdditionalTypes": { + "description": "Which additional types to produce.", + "type": "object" + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", + "type": "object" + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "$ref": "#/definitions/SqlPartitionSettings" + } + } + }, + "SqlDWSource": { + "description": "A copy activity SQL Data Warehouse source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "sqlReaderQuery": { + "type": "object", + "description": "SQL Data Warehouse reader query. Type: string (or Expression with resultType string)." + }, + "sqlReaderStoredProcedureName": { + "type": "object", + "description": "Name of the stored procedure for a SQL Data Warehouse source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "type": "object", + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\". Type: object (or Expression with resultType object), itemType: StoredProcedureParameter." + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", + "type": "object" + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "$ref": "#/definitions/SqlPartitionSettings" + } + } + }, + "SqlPartitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "type": "object", + "properties": { + "partitionColumnName": { + "type": "object", + "description": "The name of the column in integer or datetime type that will be used for proceeding partitioning. If not specified, the primary key of the table is auto-detected and used as the partition column. Type: string (or Expression with resultType string)." + }, + "partitionUpperBound": { + "type": "object", + "description": "The maximum value of the partition column for partition range splitting. This value is used to decide the partition stride, not for filtering the rows in table. All rows in the table or query result will be partitioned and copied. Type: string (or Expression with resultType string)." + }, + "partitionLowerBound": { + "type": "object", + "description": "The minimum value of the partition column for partition range splitting. This value is used to decide the partition stride, not for filtering the rows in table. All rows in the table or query result will be partitioned and copied. Type: string (or Expression with resultType string)." + } + } + }, + "FileSystemSource": { + "description": "A copy activity file system source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "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)." + } + } + }, + "HdfsSource": { + "description": "A copy activity HDFS source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "distcpSettings": { + "description": "Specifies Distcp-related settings.", + "$ref": "#/definitions/DistcpSettings" + } + } + }, + "DistcpSettings": { + "description": "Distcp settings.", + "type": "object", + "properties": { + "resourceManagerEndpoint": { + "type": "object", + "description": "Specifies the Yarn ResourceManager endpoint. Type: string (or Expression with resultType string)." + }, + "tempScriptPath": { + "type": "object", + "description": "Specifies an existing folder path which will be used to store temp Distcp command script. The script file is generated by ADF and will be removed after Copy job finished. Type: string (or Expression with resultType string)." + }, + "distcpOptions": { + "type": "object", + "description": "Specifies the Distcp options. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "resourceManagerEndpoint", + "tempScriptPath" + ] + }, + "AzureMySqlSource": { + "description": "A copy activity Azure MySQL source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "AzureDataExplorerSource": { + "description": "A copy activity Azure Data Explorer (Kusto) source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Should be a Kusto Query Language (KQL) query. Type: string (or Expression with resultType string)." + }, + "noTruncation": { + "type": "object", + "description": "The name of the Boolean option that controls whether truncation is applied to result-sets that go beyond a certain row-count limit." + }, + "queryTimeout": { + "type": "object", + "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).." + }, + "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)." + } + }, + "required": [ + "query" + ] + }, + "OracleSource": { + "description": "A copy activity Oracle source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "oracleReaderQuery": { + "type": "object", + "description": "Oracle reader query. Type: string (or Expression with resultType string)." + }, + "queryTimeout": { + "type": "object", + "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Oracle read in parallel.", + "type": "string", + "enum": [ + "None", + "PhysicalPartitionsOfTable", + "DynamicRange" + ], + "x-ms-enum": { + "name": "OraclePartitionOption", + "modelAsString": true + } + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Oracle source partitioning.", + "$ref": "#/definitions/OraclePartitionSettings" + }, + "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)." + } + } + }, + "OraclePartitionSettings": { + "description": "The settings that will be leveraged for Oracle source partitioning.", + "type": "object", + "properties": { + "partitionNames": { + "type": "object", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + }, + "description": "Names of the physical partitions of Oracle table. " + }, + "partitionColumnName": { + "type": "object", + "description": "The name of the column in integer type that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "partitionUpperBound": { + "type": "object", + "description": "The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "partitionLowerBound": { + "type": "object", + "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + } + } + }, + "TeradataSource": { + "description": "A copy activity Teradata source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Teradata query. Type: string (or Expression with resultType string)." + }, + "partitionOption": { + "description": "The partition mechanism that will be used for teradata read in parallel.", + "type": "string", + "enum": [ + "None", + "Hash", + "DynamicRange" + ], + "x-ms-enum": { + "name": "TeradataPartitionOption", + "modelAsString": true + } + }, + "partitionSettings": { + "description": "The settings that will be leveraged for teradata source partitioning.", + "$ref": "#/definitions/TeradataPartitionSettings" + } + } + }, + "TeradataPartitionSettings": { + "description": "The settings that will be leveraged for teradata source partitioning.", + "type": "object", + "properties": { + "partitionColumnName": { + "type": "object", + "description": "The name of the column that will be used for proceeding range or hash partitioning. Type: string (or Expression with resultType string)." + }, + "partitionUpperBound": { + "type": "object", + "description": "The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "partitionLowerBound": { + "type": "object", + "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + } + } + }, + "WebSource": { + "description": "A copy activity source for web page table.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "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)." + } + } + }, + "CassandraSource": { + "description": "A copy activity source for a Cassandra database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Should be a SQL-92 query expression or Cassandra Query Language (CQL) command. Type: string (or Expression with resultType string)." + }, + "consistencyLevel": { + "description": "The consistency level specifies how many Cassandra servers must respond to a read request before returning data to the client application. Cassandra checks the specified number of Cassandra servers for data to satisfy the read request. Must be one of cassandraSourceReadConsistencyLevels. The default value is 'ONE'. It is case-insensitive.", + "type": "string", + "enum": [ + "ALL", + "EACH_QUORUM", + "QUORUM", + "LOCAL_QUORUM", + "ONE", + "TWO", + "THREE", + "LOCAL_ONE", + "SERIAL", + "LOCAL_SERIAL" + ], + "x-ms-enum": { + "name": "CassandraSourceReadConsistencyLevels", + "modelAsString": true + } + } + } + }, + "MongoDbSource": { + "description": "A copy activity source for a MongoDB database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Should be a SQL-92 query expression. Type: string (or Expression with resultType string)." + }, + "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)." + } + } + }, + "MongoDbAtlasSource": { + "description": "A copy activity source for a MongoDB Atlas database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "filter": { + "type": "object", + "description": "Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string)." + }, + "cursorMethods": { + "description": "Cursor methods for Mongodb query", + "$ref": "#/definitions/MongoDbCursorMethodsProperties" + }, + "batchSize": { + "type": "object", + "description": "Specifies the number of documents to return in each batch of the response from MongoDB Atlas instance. In most cases, modifying the batch size will not affect the user or the application. This property's main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer)." + }, + "queryTimeout": { + "type": "object", + "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "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)." + } + } + }, + "MongoDbV2Source": { + "description": "A copy activity source for a MongoDB database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "filter": { + "type": "object", + "description": "Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string)." + }, + "cursorMethods": { + "description": "Cursor methods for Mongodb query", + "$ref": "#/definitions/MongoDbCursorMethodsProperties" + }, + "batchSize": { + "type": "object", + "description": "Specifies the number of documents to return in each batch of the response from MongoDB instance. In most cases, modifying the batch size will not affect the user or the application. This property's main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer)." + }, + "queryTimeout": { + "type": "object", + "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "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)." + } + } + }, + "CosmosDbMongoDbApiSource": { + "description": "A copy activity source for a CosmosDB (MongoDB API) database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "filter": { + "type": "object", + "description": "Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string)." + }, + "cursorMethods": { + "description": "Cursor methods for Mongodb query.", + "$ref": "#/definitions/MongoDbCursorMethodsProperties" + }, + "batchSize": { + "type": "object", + "description": "Specifies the number of documents to return in each batch of the response from MongoDB instance. In most cases, modifying the batch size will not affect the user or the application. This property's main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer)." + }, + "queryTimeout": { + "type": "object", + "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "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)." + } + } + }, + "MongoDbCursorMethodsProperties": { + "description": "Cursor methods for Mongodb query", + "type": "object", + "properties": { + "project": { + "type": "object", + "description": "Specifies the fields to return in the documents that match the query filter. To return all fields in the matching documents, omit this parameter. Type: string (or Expression with resultType string)." + }, + "sort": { + "type": "object", + "description": "Specifies the order in which the query returns matching documents. Type: string (or Expression with resultType string). Type: string (or Expression with resultType string)." + }, + "skip": { + "type": "object", + "description": "Specifies the how many documents skipped and where MongoDB begins returning results. This approach may be useful in implementing paginated results. Type: integer (or Expression with resultType integer)." + }, + "limit": { + "type": "object", + "description": "Specifies the maximum number of documents the server returns. limit() is analogous to the LIMIT statement in a SQL database. Type: integer (or Expression with resultType integer)." + } + }, + "additionalProperties": { + "type": "object" + } + }, + "Office365Source": { + "description": "A copy activity source for an Office 365 service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "allowedGroups": { + "type": "object", + "description": "The groups containing all the users. Type: array of strings (or Expression with resultType array of strings)." + }, + "userScopeFilterUri": { + "type": "object", + "description": "The user scope uri. Type: string (or Expression with resultType string)." + }, + "dateFilterColumn": { + "type": "object", + "description": "The Column to apply the and . Type: string (or Expression with resultType string)." + }, + "startTime": { + "type": "object", + "description": "Start time of the requested range for this dataset. Type: string (or Expression with resultType string)." + }, + "endTime": { + "type": "object", + "description": "End time of the requested range for this dataset. Type: string (or Expression with resultType string)." + }, + "outputColumns": { + "type": "object", + "description": "The columns to be read out from the Office 365 table. Type: array of objects (or Expression with resultType array of objects). Example: [ { \"name\": \"Id\" }, { \"name\": \"CreatedDateTime\" } ]" + } + } + }, + "AzureDataLakeStoreSource": { + "description": "A copy activity Azure Data Lake source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "AzureBlobFSSource": { + "description": "A copy activity Azure BlobFS source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "treatEmptyAsNull": { + "type": "object", + "description": "Treat empty as null. Type: boolean (or Expression with resultType boolean)." + }, + "skipHeaderLineCount": { + "type": "object", + "description": "Number of header lines to skip from each blob. Type: integer (or Expression with resultType integer)." + }, + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "HttpSource": { + "description": "A copy activity source for an HTTP file.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "httpRequestTimeout": { + "type": "object", + "description": "Specifies the timeout for a HTTP client to get HTTP response from HTTP server. The default value is equivalent to System.Net.HttpWebRequest.Timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, + "AmazonMWSSource": { + "description": "A copy activity Amazon Marketplace Web Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "AzurePostgreSqlSource": { + "description": "A copy activity Azure PostgreSQL source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "AzurePostgreSqlSink": { + "description": "A copy activity Azure PostgreSQL sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." + } + } + }, + "AzureMySqlSink": { + "description": "A copy activity Azure MySql sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." + } + } + }, + "ConcurSource": { + "description": "A copy activity Concur Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "CouchbaseSource": { + "description": "A copy activity Couchbase server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "DrillSource": { + "description": "A copy activity Drill server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "EloquaSource": { + "description": "A copy activity Eloqua server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "GoogleBigQuerySource": { + "description": "A copy activity Google BigQuery service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "GreenplumSource": { + "description": "A copy activity Greenplum Database source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "HBaseSource": { + "description": "A copy activity HBase server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "HiveSource": { + "description": "A copy activity Hive Server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "HubspotSource": { + "description": "A copy activity Hubspot Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ImpalaSource": { + "description": "A copy activity Impala server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "JiraSource": { + "description": "A copy activity Jira Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "MagentoSource": { + "description": "A copy activity Magento server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "MariaDBSource": { + "description": "A copy activity MariaDB server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "AzureMariaDBSource": { + "description": "A copy activity Azure MariaDB source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "MarketoSource": { + "description": "A copy activity Marketo server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "PaypalSource": { + "description": "A copy activity Paypal Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "PhoenixSource": { + "description": "A copy activity Phoenix server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "PrestoSource": { + "description": "A copy activity Presto server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "QuickBooksSource": { + "description": "A copy activity QuickBooks server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ServiceNowSource": { + "description": "A copy activity ServiceNow server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ShopifySource": { + "description": "A copy activity Shopify Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "SparkSource": { + "description": "A copy activity Spark Server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "SquareSource": { + "description": "A copy activity Square Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "XeroSource": { + "description": "A copy activity Xero Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ZohoSource": { + "description": "A copy activity Zoho server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "NetezzaSource": { + "description": "A copy activity Netezza source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Netezza read in parallel.", + "type": "string", + "enum": [ + "None", + "DataSlice", + "DynamicRange" + ], + "x-ms-enum": { + "name": "NetezzaPartitionOption", + "modelAsString": true + } + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Netezza source partitioning.", + "$ref": "#/definitions/NetezzaPartitionSettings" + } + } + }, + "NetezzaPartitionSettings": { + "description": "The settings that will be leveraged for Netezza source partitioning.", + "type": "object", + "properties": { + "partitionColumnName": { + "type": "object", + "description": "The name of the column in integer type that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "partitionUpperBound": { + "type": "object", + "description": "The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "partitionLowerBound": { + "type": "object", + "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + } + } + }, + "VerticaSource": { + "description": "A copy activity Vertica source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "SalesforceMarketingCloudSource": { + "description": "A copy activity Salesforce Marketing Cloud source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ResponsysSource": { + "description": "A copy activity Responsys source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "DynamicsAXSource": { + "description": "A copy activity Dynamics AX source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + }, + "httpRequestTimeout": { + "type": "object", + "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, + "OracleServiceCloudSource": { + "description": "A copy activity Oracle Service Cloud source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "GoogleAdWordsSource": { + "description": "A copy activity Google AdWords service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "AmazonRedshiftSource": { + "description": "A copy activity source for Amazon Redshift Source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + }, + "redshiftUnloadSettings": { + "description": "The Amazon S3 settings needed for the interim Amazon S3 when copying from Amazon Redshift with unload. With this, data from Amazon Redshift source will be unloaded into S3 first and then copied into the targeted sink from the interim S3.", + "$ref": "#/definitions/RedshiftUnloadSettings" + } + } + }, + "RedshiftUnloadSettings": { + "description": "The Amazon S3 settings needed for the interim Amazon S3 when copying from Amazon Redshift with unload. With this, data from Amazon Redshift source will be unloaded into S3 first and then copied into the targeted sink from the interim S3.", + "type": "object", + "properties": { + "s3LinkedServiceName": { + "description": "The name of the Amazon S3 linked service which will be used for the unload operation when copying from the Amazon Redshift source.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "bucketName": { + "type": "object", + "description": "The bucket of the interim Amazon S3 which will be used to store the unloaded data from Amazon Redshift source. The bucket must be in the same region as the Amazon Redshift source. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "s3LinkedServiceName", + "bucketName" + ] + }, + "SnowflakeSource": { + "description": "A copy activity snowflake source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Snowflake Sql query. Type: string (or Expression with resultType string)." + }, + "exportSettings": { + "$ref": "#/definitions/SnowflakeExportCopyCommand", + "description": "Snowflake export settings." + } + } + }, + "ExportSettings": { + "description": "Export command settings.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The export setting type." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "SnowflakeExportCopyCommand": { + "description": "Snowflake export command settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExportSettings" + } + ], + "properties": { + "additionalCopyOptions": { + "type": "object", + "description": "Additional copy options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalCopyOptions\": { \"DATE_FORMAT\": \"MM/DD/YYYY\", \"TIME_FORMAT\": \"'HH24:MI:SS.FF'\" }", + "additionalProperties": { + "type": "object" + } + }, + "additionalFormatOptions": { + "type": "object", + "description": "Additional format options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalFormatOptions\": { \"OVERWRITE\": \"TRUE\", \"MAX_FILE_SIZE\": \"'FALSE'\" }", + "additionalProperties": { + "type": "object" + } + } + } + }, + "AzureDatabricksDeltaLakeSource": { + "description": "A copy activity Azure Databricks Delta Lake source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Azure Databricks Delta Lake Sql query. Type: string (or Expression with resultType string)." + }, + "exportSettings": { + "$ref": "#/definitions/AzureDatabricksDeltaLakeExportCommand", + "description": "Azure Databricks Delta Lake export settings." + } + } + }, + "AzureDatabricksDeltaLakeExportCommand": { + "description": "Azure Databricks Delta Lake export command settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExportSettings" + } + ], + "properties": { + "dateFormat": { + "type": "object", + "description": "Specify the date format for the csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string)." + }, + "timestampFormat": { + "type": "object", + "description": "Specify the timestamp format for the csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string)." + } + } + }, + "AzureDatabricksDeltaLakeSink": { + "description": "A copy activity Azure Databricks Delta Lake sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "importSettings": { + "$ref": "#/definitions/AzureDatabricksDeltaLakeImportCommand", + "description": "Azure Databricks Delta Lake import settings." + } + } + }, + "AzureDatabricksDeltaLakeImportCommand": { + "description": "Azure Databricks Delta Lake import command settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImportSettings" + } + ], + "properties": { + "dateFormat": { + "type": "object", + "description": "Specify the date format for csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string)." + }, + "timestampFormat": { + "type": "object", + "description": "Specify the timestamp format for csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string)." + } + } + }, + "StoredProcedureParameter": { + "description": "SQL stored procedure parameter.", + "type": "object", + "properties": { + "value": { + "type": "object", + "description": "Stored procedure parameter value. Type: string (or Expression with resultType string)." + }, + "type": { + "description": "Stored procedure parameter type.", + "$ref": "#/definitions/StoredProcedureParameterType" + } + } + }, + "StoredProcedureParameterType": { + "description": "Stored procedure parameter type.", + "type": "string", + "enum": [ + "String", + "Int", + "Int64", + "Decimal", + "Guid", + "Boolean", + "Date" + ], + "x-ms-enum": { + "name": "StoredProcedureParameterType", + "modelAsString": true + } + }, + "CopySink": { + "discriminator": "type", + "description": "A copy activity sink.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Copy sink type." + }, + "writeBatchSize": { + "type": "object", + "description": "Write batch size. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "writeBatchTimeout": { + "type": "object", + "description": "Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "sinkRetryCount": { + "type": "object", + "description": "Sink retry count. Type: integer (or Expression with resultType integer)." + }, + "sinkRetryWait": { + "type": "object", + "description": "Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "maxConcurrentConnections": { + "type": "object", + "description": "The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "SapCloudForCustomerSink": { + "description": "A copy activity SAP Cloud for Customer sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "The write behavior for the operation. Default is 'Insert'.", + "type": "string", + "enum": [ + "Insert", + "Update" + ], + "x-ms-enum": { + "name": "SapCloudForCustomerSinkWriteBehavior", + "modelAsString": true + } + }, + "httpRequestTimeout": { + "type": "object", + "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, + "AzureQueueSink": { + "description": "A copy activity Azure Queue sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": {} + }, + "CopyBehaviorType": { + "description": "All available types of copy behavior.", + "type": "string", + "enum": [ + "PreserveHierarchy", + "FlattenHierarchy", + "MergeFiles" + ], + "x-ms-enum": { + "name": "CopyBehaviorType", + "modelAsString": true + } + }, + "AzureTableSink": { + "description": "A copy activity Azure Table sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "azureTableDefaultPartitionKeyValue": { + "type": "object", + "description": "Azure Table default partition key value. Type: string (or Expression with resultType string)." + }, + "azureTablePartitionKeyName": { + "type": "object", + "description": "Azure Table partition key name. Type: string (or Expression with resultType string)." + }, + "azureTableRowKeyName": { + "type": "object", + "description": "Azure Table row key name. Type: string (or Expression with resultType string)." + }, + "azureTableInsertType": { + "type": "object", + "description": "Azure Table insert type. Type: string (or Expression with resultType string)." + } + } + }, + "AvroSink": { + "description": "A copy activity Avro sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreWriteSettings", + "description": "Avro store settings." + }, + "formatSettings": { + "$ref": "#/definitions/AvroWriteSettings", + "description": "Avro format settings." + } + } + }, + "ParquetSink": { + "description": "A copy activity Parquet sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreWriteSettings", + "description": "Parquet store settings." + }, + "formatSettings": { + "$ref": "#/definitions/ParquetWriteSettings", + "description": "Parquet format settings." + } + } + }, + "BinarySink": { + "description": "A copy activity Binary sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreWriteSettings", + "description": "Binary store settings." + } + } + }, + "BlobSink": { + "description": "A copy activity Azure Blob sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "blobWriterOverwriteFiles": { + "type": "object", + "description": "Blob writer overwrite files. Type: boolean (or Expression with resultType boolean)." + }, + "blobWriterDateTimeFormat": { + "type": "object", + "description": "Blob writer date time format. Type: string (or Expression with resultType string)." + }, + "blobWriterAddHeader": { + "type": "object", + "description": "Blob writer add header. Type: boolean (or Expression with resultType boolean)." + }, + "copyBehavior": { + "description": "The type of copy behavior for copy sink.", + "type": "object" + } + } + }, + "FileSystemSink": { + "description": "A copy activity file system sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "copyBehavior": { + "description": "The type of copy behavior for copy sink.", + "type": "object" + } + } + }, + "DocumentDbCollectionSink": { + "description": "A copy activity Document Database Collection sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "nestingSeparator": { + "type": "object", + "description": "Nested properties separator. Default is . (dot). Type: string (or Expression with resultType string)." + }, + "writeBehavior": { + "type": "object", + "description": "Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert." + } + } + }, + "CosmosDbSqlApiSink": { + "description": "A copy activity Azure CosmosDB (SQL API) Collection sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "type": "object", + "description": "Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert." + } + } + }, + "SqlSink": { + "description": "A copy activity SQL sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "sqlWriterStoredProcedureName": { + "type": "object", + "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." + }, + "sqlWriterTableType": { + "type": "object", + "description": "SQL writer table type. Type: string (or Expression with resultType string)." + }, + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "SQL stored procedure parameters.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "storedProcedureTableTypeParameterName": { + "type": "object", + "description": "The stored procedure parameter name of the table type. Type: string (or Expression with resultType string)." + }, + "tableOption": { + "type": "object", + "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." + } + } + }, + "SqlServerSink": { + "description": "A copy activity SQL server sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "sqlWriterStoredProcedureName": { + "type": "object", + "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." + }, + "sqlWriterTableType": { + "type": "object", + "description": "SQL writer table type. Type: string (or Expression with resultType string)." + }, + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "SQL stored procedure parameters.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "storedProcedureTableTypeParameterName": { + "type": "object", + "description": "The stored procedure parameter name of the table type. Type: string (or Expression with resultType string)." + }, + "tableOption": { + "type": "object", + "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." + } + } + }, + "AzureSqlSink": { + "description": "A copy activity Azure SQL sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "sqlWriterStoredProcedureName": { + "type": "object", + "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." + }, + "sqlWriterTableType": { + "type": "object", + "description": "SQL writer table type. Type: string (or Expression with resultType string)." + }, + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "SQL stored procedure parameters.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "storedProcedureTableTypeParameterName": { + "type": "object", + "description": "The stored procedure parameter name of the table type. Type: string (or Expression with resultType string)." + }, + "tableOption": { + "type": "object", + "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." + } + } + }, + "SqlMISink": { + "description": "A copy activity Azure SQL Managed Instance sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "sqlWriterStoredProcedureName": { + "type": "object", + "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." + }, + "sqlWriterTableType": { + "type": "object", + "description": "SQL writer table type. Type: string (or Expression with resultType string)." + }, + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "SQL stored procedure parameters.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "storedProcedureTableTypeParameterName": { + "type": "object", + "description": "The stored procedure parameter name of the table type. Type: string (or Expression with resultType string)." + }, + "tableOption": { + "type": "object", + "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." + } + } + }, + "SqlDWSink": { + "description": "A copy activity SQL Data Warehouse sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "allowPolyBase": { + "type": "object", + "description": "Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable. Type: boolean (or Expression with resultType boolean)." + }, + "polyBaseSettings": { + "description": "Specifies PolyBase-related settings when allowPolyBase is true.", + "$ref": "#/definitions/PolybaseSettings" + }, + "allowCopyCommand": { + "type": "object", + "description": "Indicates to use Copy Command to copy data into SQL Data Warehouse. Type: boolean (or Expression with resultType boolean)." + }, + "copyCommandSettings": { + "description": "Specifies Copy Command related settings when allowCopyCommand is true.", + "$ref": "#/definitions/DWCopyCommandSettings" + }, + "tableOption": { + "type": "object", + "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." + } + } + }, + "PolybaseSettings": { + "description": "PolyBase settings.", + "type": "object", + "properties": { + "rejectType": { + "$ref": "#/definitions/PolybaseSettingsRejectType", + "description": "Reject type." + }, + "rejectValue": { + "type": "object", + "description": "Specifies the value or the percentage of rows that can be rejected before the query fails. Type: number (or Expression with resultType number), minimum: 0." + }, + "rejectSampleValue": { + "type": "object", + "description": "Determines the number of rows to attempt to retrieve before the PolyBase recalculates the percentage of rejected rows. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "useTypeDefault": { + "type": "object", + "description": "Specifies how to handle missing values in delimited text files when PolyBase retrieves data from the text file. Type: boolean (or Expression with resultType boolean)." + } + }, + "additionalProperties": { + "type": "object" + } + }, + "PolybaseSettingsRejectType": { + "description": "Indicates whether the RejectValue property is specified as a literal value or a percentage.", + "type": "string", + "enum": [ + "value", + "percentage" + ], + "x-ms-enum": { + "name": "PolybaseSettingsRejectType", + "modelAsString": true + } + }, + "DWCopyCommandSettings": { + "description": "DW Copy Command settings.", + "type": "object", + "properties": { + "defaultValues": { + "type": "array", + "description": "Specifies the default values for each target column in SQL DW. The default values in the property overwrite the DEFAULT constraint set in the DB, and identity column cannot have a default value. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/DWCopyCommandDefaultValue" + } + }, + "additionalOptions": { + "type": "object", + "description": "Additional options directly passed to SQL DW in Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalOptions\": { \"MAXERRORS\": \"1000\", \"DATEFORMAT\": \"'ymd'\" }", + "additionalProperties": { + "type": "string" + } + } + } + }, + "DWCopyCommandDefaultValue": { + "description": "Default value.", + "type": "object", + "properties": { + "columnName": { + "type": "object", + "description": "Column name. Type: object (or Expression with resultType string)." + }, + "defaultValue": { + "type": "object", + "description": "The default value of the column. Type: object (or Expression with resultType string)." + } + } + }, + "SnowflakeSink": { + "description": "A copy activity snowflake sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "importSettings": { + "$ref": "#/definitions/SnowflakeImportCopyCommand", + "description": "Snowflake import settings." + } + } + }, + "ImportSettings": { + "description": "Import command settings.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The import setting type." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "SnowflakeImportCopyCommand": { + "description": "Snowflake import command settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImportSettings" + } + ], + "properties": { + "additionalCopyOptions": { + "type": "object", + "description": "Additional copy options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalCopyOptions\": { \"DATE_FORMAT\": \"MM/DD/YYYY\", \"TIME_FORMAT\": \"'HH24:MI:SS.FF'\" }", + "additionalProperties": { + "type": "object" + } + }, + "additionalFormatOptions": { + "type": "object", + "description": "Additional format options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalFormatOptions\": { \"FORCE\": \"TRUE\", \"LOAD_UNCERTAIN_FILES\": \"'FALSE'\" }", + "additionalProperties": { + "type": "object" + } + } + } + }, + "LogStorageSettings": { + "description": "(Deprecated. Please use LogSettings) Log storage settings.", + "type": "object", + "properties": { + "linkedServiceName": { + "description": "Log storage linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "path": { + "type": "object", + "description": "The path to storage for storing detailed logs of activity execution. Type: string (or Expression with resultType string)." + }, + "logLevel": { + "type": "object", + "description": "Gets or sets the log level, support: Info, Warning. Type: string (or Expression with resultType string)." + }, + "enableReliableLogging": { + "type": "object", + "description": "Specifies whether to enable reliable logging. Type: boolean (or Expression with resultType boolean)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "linkedServiceName" + ] + }, + "LogSettings": { + "description": "Log settings.", + "type": "object", + "properties": { + "enableCopyActivityLog": { + "type": "object", + "description": "Specifies whether to enable copy activity log. Type: boolean (or Expression with resultType boolean)." + }, + "copyActivityLogSettings": { + "description": "Specifies settings for copy activity log.", + "$ref": "#/definitions/CopyActivityLogSettings" + }, + "logLocationSettings": { + "description": "Log location settings customer needs to provide when enabling log.", + "$ref": "#/definitions/LogLocationSettings" + } + }, + "required": [ + "logLocationSettings" + ] + }, + "LogLocationSettings": { + "description": "Log location settings.", + "type": "object", + "properties": { + "linkedServiceName": { + "description": "Log storage linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "path": { + "type": "object", + "description": "The path to storage for storing detailed logs of activity execution. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "linkedServiceName" + ] + }, + "CopyActivityLogSettings": { + "description": "Settings for copy activity log.", + "type": "object", + "properties": { + "logLevel": { + "type": "object", + "description": "Gets or sets the log level, support: Info, Warning. Type: string (or Expression with resultType string)." + }, + "enableReliableLogging": { + "type": "object", + "description": "Specifies whether to enable reliable logging. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "StagingSettings": { + "description": "Staging settings.", + "type": "object", + "properties": { + "linkedServiceName": { + "description": "Staging linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "path": { + "type": "object", + "description": "The path to storage for storing the interim data. Type: string (or Expression with resultType string)." + }, + "enableCompression": { + "type": "object", + "description": "Specifies whether to use compression when copying data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "linkedServiceName" + ] + }, + "RedirectIncompatibleRowSettings": { + "description": "Redirect incompatible row settings", + "type": "object", + "properties": { + "linkedServiceName": { + "type": "object", + "description": "Name of the Azure Storage, Storage SAS, or Azure Data Lake Store linked service used for redirecting incompatible row. Must be specified if redirectIncompatibleRowSettings is specified. Type: string (or Expression with resultType string)." + }, + "path": { + "type": "object", + "description": "The path for storing the redirect incompatible row data. Type: string (or Expression with resultType string)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "linkedServiceName" + ] + }, + "SkipErrorFile": { + "description": "Skip error file.", + "type": "object", + "properties": { + "fileMissing": { + "type": "object", + "description": "Skip if file is deleted by other client during copy. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "dataInconsistency": { + "type": "object", + "description": "Skip if source/sink file changed by other concurrent write. Default is false. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "AdditionalColumns": { + "description": "Specify the column name and value of additional columns.", + "type": "object", + "properties": { + "name": { + "type": "object", + "description": "Additional column name. Type: string (or Expression with resultType string)." + }, + "value": { + "type": "object", + "description": "Additional column value. Type: string (or Expression with resultType string)." + } + } + }, + "OracleSink": { + "description": "A copy activity Oracle sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + } + } + }, + "AzureDataLakeStoreSink": { + "description": "A copy activity Azure Data Lake Store sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "copyBehavior": { + "description": "The type of copy behavior for copy sink.", + "type": "object" + }, + "enableAdlsSingleFileParallel": { + "description": "Single File Parallel.", + "type": "object" + } + } + }, + "AzureBlobFSSink": { + "description": "A copy activity Azure Data Lake Storage Gen2 sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "copyBehavior": { + "description": "The type of copy behavior for copy sink.", + "type": "object" + } + } + }, + "AzureSearchIndexSink": { + "description": "A copy activity Azure Search Index sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "Specify the write behavior when upserting documents into Azure Search Index.", + "type": "string", + "enum": [ + "Merge", + "Upload" + ], + "x-ms-enum": { + "name": "AzureSearchIndexWriteBehaviorType", + "modelAsString": true + } + } + } + }, + "OdbcSink": { + "description": "A copy activity ODBC sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." + } + } + }, + "InformixSink": { + "description": "A copy activity Informix sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." + } + } + }, + "MicrosoftAccessSink": { + "description": "A copy activity Microsoft Access sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." + } + } + }, + "DynamicsSinkWriteBehavior": { + "description": "Defines values for DynamicsSinkWriteBehavior.", + "type": "string", + "enum": [ + "Upsert" + ], + "x-ms-enum": { + "name": "DynamicsSinkWriteBehavior", + "modelAsString": true + } + }, + "DynamicsSink": { + "description": "A copy activity Dynamics sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "The write behavior for the operation.", + "$ref": "#/definitions/DynamicsSinkWriteBehavior" + }, + "ignoreNullValues": { + "type": "object", + "description": "The flag indicating whether ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "alternateKeyName": { + "type": "object", + "description": "The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "writeBehavior" + ] + }, + "DynamicsCrmSink": { + "description": "A copy activity Dynamics CRM sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "The write behavior for the operation.", + "$ref": "#/definitions/DynamicsSinkWriteBehavior" + }, + "ignoreNullValues": { + "type": "object", + "description": "The flag indicating whether to ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "alternateKeyName": { + "type": "object", + "description": "The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "writeBehavior" + ] + }, + "CommonDataServiceForAppsSink": { + "description": "A copy activity Common Data Service for Apps sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "The write behavior for the operation.", + "$ref": "#/definitions/DynamicsSinkWriteBehavior" + }, + "ignoreNullValues": { + "type": "object", + "description": "The flag indicating whether to ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "alternateKeyName": { + "type": "object", + "description": "The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "writeBehavior" + ] + }, + "AzureDataExplorerSink": { + "description": "A copy activity Azure Data Explorer sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "ingestionMappingName": { + "type": "object", + "description": "A name of a pre-created csv mapping that was defined on the target Kusto table. Type: string." + }, + "ingestionMappingAsJson": { + "type": "object", + "description": "An explicit column mapping description provided in a json format. Type: string." + }, + "flushImmediately": { + "type": "object", + "description": "If set to true, any aggregation will be skipped. Default is false. Type: boolean." + } + } + }, + "SalesforceSink": { + "description": "A copy activity Salesforce sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "The write behavior for the operation. Default is Insert.", + "type": "string", + "enum": [ + "Insert", + "Upsert" + ], + "x-ms-enum": { + "name": "SalesforceSinkWriteBehavior", + "modelAsString": true + } + }, + "externalIdFieldName": { + "type": "object", + "description": "The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string)." + }, + "ignoreNullValues": { + "type": "object", + "description": "The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation. Default value is false. If set it to true, it means ADF will leave the data in the destination object unchanged when doing upsert/update operation and insert defined default value when doing insert operation, versus ADF will update the data in the destination object to NULL when doing upsert/update operation and insert NULL value when doing insert operation. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "SalesforceServiceCloudSink": { + "description": "A copy activity Salesforce Service Cloud sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "The write behavior for the operation. Default is Insert.", + "type": "string", + "enum": [ + "Insert", + "Upsert" + ], + "x-ms-enum": { + "name": "SalesforceSinkWriteBehavior", + "modelAsString": true + } + }, + "externalIdFieldName": { + "type": "object", + "description": "The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string)." + }, + "ignoreNullValues": { + "type": "object", + "description": "The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation. Default value is false. If set it to true, it means ADF will leave the data in the destination object unchanged when doing upsert/update operation and insert defined default value when doing insert operation, versus ADF will update the data in the destination object to NULL when doing upsert/update operation and insert NULL value when doing insert operation. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "CosmosDbMongoDbApiSink": { + "description": "A copy activity sink for a CosmosDB (MongoDB API) database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "type": "object", + "description": "Specifies whether the document with same key to be overwritten (upsert) rather than throw exception (insert). The default value is \"insert\". Type: string (or Expression with resultType string). Type: string (or Expression with resultType string)." + } + } + }, + "CopyTranslator": { + "discriminator": "type", + "description": "A copy activity translator.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Copy translator type." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "TabularTranslator": { + "description": "A copy activity tabular translator.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopyTranslator" + } + ], + "properties": { + "columnMappings": { + "type": "object", + "description": "Column mappings. Example: \"UserId: MyUserId, Group: MyGroup, Name: MyName\" Type: string (or Expression with resultType string). This property will be retired. Please use mappings property." + }, + "schemaMapping": { + "type": "object", + "description": "The schema mapping to map between tabular data and hierarchical data. Example: {\"Column1\": \"$.Column1\", \"Column2\": \"$.Column2.Property1\", \"Column3\": \"$.Column2.Property2\"}. Type: object (or Expression with resultType object). This property will be retired. Please use mappings property." + }, + "collectionReference": { + "type": "object", + "description": "The JSON Path of the Nested Array that is going to do cross-apply. Type: object (or Expression with resultType object)." + }, + "mapComplexValuesToString": { + "type": "object", + "description": "Whether to map complex (array and object) values to simple strings in json format. Type: boolean (or Expression with resultType boolean)." + }, + "mappings": { + "type": "object", + "description": "Column mappings with logical types. Tabular->tabular example: [{\"source\":{\"name\":\"CustomerName\",\"type\":\"String\"},\"sink\":{\"name\":\"ClientName\",\"type\":\"String\"}},{\"source\":{\"name\":\"CustomerAddress\",\"type\":\"String\"},\"sink\":{\"name\":\"ClientAddress\",\"type\":\"String\"}}]. Hierarchical->tabular example: [{\"source\":{\"path\":\"$.CustomerName\",\"type\":\"String\"},\"sink\":{\"name\":\"ClientName\",\"type\":\"String\"}},{\"source\":{\"path\":\"$.CustomerAddress\",\"type\":\"String\"},\"sink\":{\"name\":\"ClientAddress\",\"type\":\"String\"}}]. Type: object (or Expression with resultType object)." + }, + "typeConversion": { + "type": "object", + "description": "Whether to enable the advanced type conversion feature in the Copy activity. Type: boolean (or Expression with resultType boolean)." + }, + "typeConversionSettings": { + "description": "Type conversion settings", + "$ref": "#/definitions/TypeConversionSettings" + } + } + }, + "TypeConversionSettings": { + "description": "Type conversion settings", + "type": "object", + "properties": { + "allowDataTruncation": { + "type": "object", + "description": "Whether to allow data truncation when converting the data. Type: boolean (or Expression with resultType boolean)." + }, + "treatBooleanAsNumber": { + "type": "object", + "description": "Whether to treat boolean values as numbers. Type: boolean (or Expression with resultType boolean)." + }, + "dateTimeFormat": { + "type": "object", + "description": "The format for DateTime values. Type: string (or Expression with resultType string)." + }, + "dateTimeOffsetFormat": { + "type": "object", + "description": "The format for DateTimeOffset values. Type: string (or Expression with resultType string)." + }, + "timeSpanFormat": { + "type": "object", + "description": "The format for TimeSpan values. Type: string (or Expression with resultType string)." + }, + "culture": { + "type": "object", + "description": "The culture used to convert data from/to string. Type: string (or Expression with resultType string)." + } + } + }, + "HDInsightHiveActivity": { + "description": "HDInsight Hive activity type.", + "type": "object", + "x-ms-discriminator-value": "HDInsightHive", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "HDInsight Hive activity properties.", + "$ref": "#/definitions/HDInsightHiveActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightHiveActivityTypeProperties": { + "description": "HDInsight Hive activity properties.", + "type": "object", + "properties": { + "storageLinkedServices": { + "description": "Storage linked service references.", + "type": "array", + "items": { + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + } + }, + "arguments": { + "description": "User specified arguments to HDInsightActivity.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "getDebugInfo": { + "$ref": "#/definitions/HDInsightActivityDebugInfoOption", + "description": "Debug info option." + }, + "scriptPath": { + "type": "object", + "description": "Script path. Type: string (or Expression with resultType string)." + }, + "scriptLinkedService": { + "description": "Script linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "defines": { + "description": "Allows user to specify defines for Hive job request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "variables": { + "description": "User specified arguments under hivevar namespace.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "queryTimeout": { + "type": "integer", + "description": "Query timeout value (in minutes). Effective when the HDInsight cluster is with ESP (Enterprise Security Package)" + } + } + }, + "HDInsightActivityDebugInfoOption": { + "description": "The HDInsightActivityDebugInfoOption settings to use.", + "type": "string", + "enum": [ + "None", + "Always", + "Failure" + ], + "x-ms-enum": { + "name": "HDInsightActivityDebugInfoOption", + "modelAsString": true + } + }, + "HDInsightPigActivity": { + "description": "HDInsight Pig activity type.", + "type": "object", + "x-ms-discriminator-value": "HDInsightPig", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "HDInsight Pig activity properties.", + "$ref": "#/definitions/HDInsightPigActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightPigActivityTypeProperties": { + "description": "HDInsight Pig activity properties.", + "type": "object", + "properties": { + "storageLinkedServices": { + "description": "Storage linked service references.", + "type": "array", + "items": { + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + } + }, + "arguments": { + "type": "object", + "description": "User specified arguments to HDInsightActivity. Type: array (or Expression with resultType array)." + }, + "getDebugInfo": { + "$ref": "#/definitions/HDInsightActivityDebugInfoOption", + "description": "Debug info option." + }, + "scriptPath": { + "type": "object", + "description": "Script path. Type: string (or Expression with resultType string)." + }, + "scriptLinkedService": { + "description": "Script linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "defines": { + "description": "Allows user to specify defines for Pig job request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + } + }, + "HDInsightMapReduceActivity": { + "description": "HDInsight MapReduce activity type.", + "type": "object", + "x-ms-discriminator-value": "HDInsightMapReduce", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "HDInsight MapReduce activity properties.", + "$ref": "#/definitions/HDInsightMapReduceActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightMapReduceActivityTypeProperties": { + "description": "HDInsight MapReduce activity properties.", + "type": "object", + "properties": { + "storageLinkedServices": { + "description": "Storage linked service references.", + "type": "array", + "items": { + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + } + }, + "arguments": { + "description": "User specified arguments to HDInsightActivity.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "getDebugInfo": { + "$ref": "#/definitions/HDInsightActivityDebugInfoOption", + "description": "Debug info option." + }, + "className": { + "type": "object", + "description": "Class name. Type: string (or Expression with resultType string)." + }, + "jarFilePath": { + "type": "object", + "description": "Jar path. Type: string (or Expression with resultType string)." + }, + "jarLinkedService": { + "description": "Jar linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "jarLibs": { + "description": "Jar libs.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "defines": { + "description": "Allows user to specify defines for the MapReduce job request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + }, + "required": [ + "className", + "jarFilePath" + ] + }, + "HDInsightStreamingActivity": { + "description": "HDInsight streaming activity type.", + "type": "object", + "x-ms-discriminator-value": "HDInsightStreaming", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "HDInsight streaming activity properties.", + "$ref": "#/definitions/HDInsightStreamingActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightStreamingActivityTypeProperties": { + "description": "HDInsight streaming activity properties.", + "type": "object", + "properties": { + "storageLinkedServices": { + "description": "Storage linked service references.", + "type": "array", + "items": { + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + } + }, + "arguments": { + "description": "User specified arguments to HDInsightActivity.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "getDebugInfo": { + "$ref": "#/definitions/HDInsightActivityDebugInfoOption", + "description": "Debug info option." + }, + "mapper": { + "type": "object", + "description": "Mapper executable name. Type: string (or Expression with resultType string)." + }, + "reducer": { + "type": "object", + "description": "Reducer executable name. Type: string (or Expression with resultType string)." + }, + "input": { + "type": "object", + "description": "Input blob path. Type: string (or Expression with resultType string)." + }, + "output": { + "type": "object", + "description": "Output blob path. Type: string (or Expression with resultType string)." + }, + "filePaths": { + "description": "Paths to streaming job files. Can be directories.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "fileLinkedService": { + "description": "Linked service reference where the files are located.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "combiner": { + "type": "object", + "description": "Combiner executable name. Type: string (or Expression with resultType string)." + }, + "commandEnvironment": { + "description": "Command line environment values.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "defines": { + "description": "Allows user to specify defines for streaming job request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + }, + "required": [ + "mapper", + "reducer", + "input", + "output", + "filePaths" + ] + }, + "HDInsightSparkActivity": { + "description": "HDInsight Spark activity.", + "type": "object", + "x-ms-discriminator-value": "HDInsightSpark", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "HDInsight spark activity properties.", + "$ref": "#/definitions/HDInsightSparkActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightSparkActivityTypeProperties": { + "description": "HDInsight spark activity properties.", + "type": "object", + "properties": { + "rootPath": { + "type": "object", + "description": "The root path in 'sparkJobLinkedService' for all the job’s files. Type: string (or Expression with resultType string)." + }, + "entryFilePath": { + "type": "object", + "description": "The relative path to the root folder of the code/package to be executed. Type: string (or Expression with resultType string)." + }, + "arguments": { + "description": "The user-specified arguments to HDInsightSparkActivity.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "getDebugInfo": { + "$ref": "#/definitions/HDInsightActivityDebugInfoOption", + "description": "Debug info option." + }, + "sparkJobLinkedService": { + "description": "The storage linked service for uploading the entry file and dependencies, and for receiving logs.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "className": { + "description": "The application's Java/Spark main class.", + "type": "string" + }, + "proxyUser": { + "type": "object", + "description": "The user to impersonate that will execute the job. Type: string (or Expression with resultType string)." + }, + "sparkConfig": { + "description": "Spark configuration property.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + }, + "required": [ + "rootPath", + "entryFilePath" + ] + }, + "ExecuteSSISPackageActivity": { + "description": "Execute SSIS package activity.", + "type": "object", + "x-ms-discriminator-value": "ExecuteSSISPackage", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Execute SSIS package activity properties.", + "$ref": "#/definitions/ExecuteSSISPackageActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ExecuteSSISPackageActivityTypeProperties": { + "description": "Execute SSIS package activity properties.", + "type": "object", + "properties": { + "packageLocation": { + "description": "SSIS package location.", + "$ref": "#/definitions/SSISPackageLocation" + }, + "runtime": { + "description": "Specifies the runtime to execute SSIS package. The value should be \"x86\" or \"x64\". Type: string (or Expression with resultType string).", + "type": "object" + }, + "loggingLevel": { + "description": "The logging level of SSIS package execution. Type: string (or Expression with resultType string).", + "type": "object" + }, + "environmentPath": { + "description": "The environment path to execute the SSIS package. Type: string (or Expression with resultType string).", + "type": "object" + }, + "executionCredential": { + "description": "The package execution credential.", + "$ref": "#/definitions/SSISExecutionCredential" + }, + "connectVia": { + "description": "The integration runtime reference.", + "$ref": "../artifacts.json#/definitions/IntegrationRuntimeReference" + }, + "projectParameters": { + "description": "The project level parameters to execute the SSIS package.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISExecutionParameter" + } + }, + "packageParameters": { + "description": "The package level parameters to execute the SSIS package.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISExecutionParameter" + } + }, + "projectConnectionManagers": { + "description": "The project level connection managers to execute the SSIS package.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISConnectionManager" + } + }, + "packageConnectionManagers": { + "description": "The package level connection managers to execute the SSIS package.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISConnectionManager" + } + }, + "propertyOverrides": { + "description": "The property overrides to execute the SSIS package.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISPropertyOverride" + } + }, + "logLocation": { + "description": "SSIS package execution log location.", + "$ref": "#/definitions/SSISLogLocation" + } + }, + "required": [ + "packageLocation", + "connectVia" + ] + }, + "SSISPackageLocation": { + "description": "SSIS package location.", + "type": "object", + "properties": { + "packagePath": { + "description": "The SSIS package path. Type: string (or Expression with resultType string).", + "type": "object" + }, + "type": { + "description": "The type of SSIS package location.", + "type": "string", + "enum": [ + "SSISDB", + "File", + "InlinePackage", + "PackageStore" + ], + "x-ms-enum": { + "name": "SsisPackageLocationType", + "modelAsString": true + } + }, + "typeProperties": { + "x-ms-client-flatten": true, + "description": "SSIS package location properties.", + "$ref": "#/definitions/SSISPackageLocationTypeProperties" + } + } + }, + "SSISPackageLocationTypeProperties": { + "description": "SSIS package location properties.", + "type": "object", + "properties": { + "packagePassword": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "Password of the package." + }, + "accessCredential": { + "description": "The package access credential.", + "$ref": "#/definitions/SSISAccessCredential" + }, + "configurationPath": { + "description": "The configuration file of the package execution. Type: string (or Expression with resultType string).", + "type": "object" + }, + "configurationAccessCredential": { + "description": "The configuration file access credential.", + "$ref": "#/definitions/SSISAccessCredential" + }, + "packageName": { + "description": "The package name.", + "type": "string" + }, + "packageContent": { + "description": "The embedded package content. Type: string (or Expression with resultType string).", + "type": "object" + }, + "packageLastModifiedDate": { + "description": "The embedded package last modified date.", + "type": "string" + }, + "childPackages": { + "description": "The embedded child package list.", + "type": "array", + "items": { + "$ref": "#/definitions/SSISChildPackage" + } + } + } + }, + "SSISConnectionManager": { + "description": "SSIS Connection Manager.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISExecutionParameter" + } + }, + "SSISExecutionParameter": { + "description": "SSIS execution parameter.", + "type": "object", + "properties": { + "value": { + "type": "object", + "description": "SSIS package execution parameter value. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "value" + ] + }, + "SSISPropertyOverride": { + "description": "SSIS property override.", + "type": "object", + "properties": { + "value": { + "type": "object", + "description": "SSIS package property override value. Type: string (or Expression with resultType string)." + }, + "isSensitive": { + "type": "boolean", + "description": "Whether SSIS package property override value is sensitive data. Value will be encrypted in SSISDB if it is true" + } + }, + "required": [ + "value" + ] + }, + "SSISExecutionCredential": { + "description": "SSIS package execution credential.", + "type": "object", + "properties": { + "domain": { + "type": "object", + "description": "Domain for windows authentication." + }, + "userName": { + "type": "object", + "description": "UseName for windows authentication." + }, + "password": { + "$ref": "../artifacts.json#/definitions/SecureString", + "description": "Password for windows authentication." + } + }, + "required": [ + "domain", + "userName", + "password" + ] + }, + "SSISAccessCredential": { + "description": "SSIS access credential.", + "type": "object", + "properties": { + "domain": { + "type": "object", + "description": "Domain for windows authentication." + }, + "userName": { + "type": "object", + "description": "UseName for windows authentication." + }, + "password": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "Password for windows authentication." + } + }, + "required": [ + "domain", + "userName", + "password" + ] + }, + "SSISChildPackage": { + "description": "SSIS embedded child package.", + "type": "object", + "properties": { + "packagePath": { + "type": "object", + "description": "Path for embedded child package. Type: string (or Expression with resultType string)." + }, + "packageName": { + "type": "string", + "description": "Name for embedded child package." + }, + "packageContent": { + "type": "object", + "description": "Content for embedded child package. Type: string (or Expression with resultType string)." + }, + "packageLastModifiedDate": { + "type": "string", + "description": "Last modified date for embedded child package." + } + }, + "required": [ + "packagePath", + "packageContent" + ] + }, + "SSISLogLocation": { + "description": "SSIS package execution log location", + "type": "object", + "properties": { + "logPath": { + "description": "The SSIS package execution log path. Type: string (or Expression with resultType string).", + "type": "object" + }, + "type": { + "description": "The type of SSIS log location.", + "type": "string", + "enum": [ + "File" + ], + "x-ms-enum": { + "name": "SsisLogLocationType", + "modelAsString": true + } + }, + "typeProperties": { + "x-ms-client-flatten": true, + "description": "SSIS package execution log location properties.", + "$ref": "#/definitions/SSISLogLocationTypeProperties" + } + }, + "required": [ + "logPath", + "type", + "typeProperties" + ] + }, + "SSISLogLocationTypeProperties": { + "description": "SSIS package execution log location properties.", + "type": "object", + "properties": { + "accessCredential": { + "description": "The package execution log access credential.", + "$ref": "#/definitions/SSISAccessCredential" + }, + "logRefreshInterval": { + "type": "object", + "description": "Specifies the interval to refresh log. The default interval is 5 minutes. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, + "CustomActivity": { + "description": "Custom activity type.", + "type": "object", + "x-ms-discriminator-value": "Custom", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Custom activity properties.", + "$ref": "#/definitions/CustomActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "CustomActivityTypeProperties": { + "description": "Custom activity properties.", + "type": "object", + "properties": { + "command": { + "type": "object", + "description": "Command for custom activity Type: string (or Expression with resultType string)." + }, + "resourceLinkedService": { + "description": "Resource linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "folderPath": { + "type": "object", + "description": "Folder path for resource files Type: string (or Expression with resultType string)." + }, + "referenceObjects": { + "description": "Reference objects", + "$ref": "#/definitions/CustomActivityReferenceObject" + }, + "extendedProperties": { + "description": "User defined property bag. There is no restriction on the keys or values that can be used. The user specified custom activity has the full responsibility to consume and interpret the content defined.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "retentionTimeInDays": { + "type": "object", + "description": "The retention time for the files submitted for custom activity. Type: double (or Expression with resultType double)." + }, + "autoUserSpecification": { + "type": "object", + "description": "Elevation level and scope for the user, default is nonadmin task. Type: string (or Expression with resultType double)." + } + }, + "required": [ + "command" + ] + }, + "CustomActivityReferenceObject": { + "description": "Reference objects for custom activity", + "type": "object", + "properties": { + "linkedServices": { + "description": "Linked service references.", + "type": "array", + "items": { + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + } + }, + "datasets": { + "description": "Dataset references.", + "type": "array", + "items": { + "$ref": "../artifacts.json#/definitions/DatasetReference" + } + } + } + }, + "SqlServerStoredProcedureActivity": { + "description": "SQL stored procedure activity type.", + "type": "object", + "x-ms-discriminator-value": "SqlServerStoredProcedure", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "SQL stored procedure activity properties.", + "$ref": "#/definitions/SqlServerStoredProcedureActivityTypeProperties" + } + }, + "required": [ + "typeProperties", + "linkedServiceName" + ] + }, + "SqlServerStoredProcedureActivityTypeProperties": { + "description": "SQL stored procedure activity properties.", + "type": "object", + "properties": { + "storedProcedureName": { + "type": "object", + "description": "Stored procedure name. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + } + }, + "required": [ + "storedProcedureName" + ] + }, + "ExecutePipelineActivity": { + "x-ms-discriminator-value": "ExecutePipeline", + "type": "object", + "description": "Execute pipeline activity.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Execute pipeline activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExecutePipelineActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ExecutePipelineActivityTypeProperties": { + "description": "Execute pipeline activity properties.", + "type": "object", + "properties": { + "pipeline": { + "description": "Pipeline reference.", + "$ref": "../artifacts.json#/definitions/PipelineReference" + }, + "parameters": { + "description": "Pipeline parameters.", + "$ref": "../artifacts.json#/definitions/ParameterValueSpecification" + }, + "waitOnCompletion": { + "description": "Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false.", + "type": "boolean" + } + }, + "required": [ + "pipeline" + ] + }, + "DeleteActivity": { + "x-ms-discriminator-value": "Delete", + "description": "Delete activity.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Delete activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DeleteActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DeleteActivityTypeProperties": { + "description": "Delete activity properties.", + "type": "object", + "properties": { + "recursive": { + "type": "object", + "description": "If true, files or sub-folders under current folder path will be deleted recursively. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "maxConcurrentConnections": { + "type": "integer", + "minimum": 1, + "description": "The max concurrent connections to connect data source at the same time." + }, + "enableLogging": { + "type": "object", + "description": "Whether to record detailed logs of delete-activity execution. Default value is false. Type: boolean (or Expression with resultType boolean)." + }, + "logStorageSettings": { + "description": "Log storage settings customer need to provide when enableLogging is true.", + "$ref": "#/definitions/LogStorageSettings" + }, + "dataset": { + "description": "Delete activity dataset reference.", + "$ref": "../artifacts.json#/definitions/DatasetReference" + }, + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "Delete activity store settings." + } + }, + "required": [ + "dataset" + ] + }, + "AzureDataExplorerCommandActivity": { + "x-ms-discriminator-value": "AzureDataExplorerCommand", + "description": "Azure Data Explorer command activity.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Data Explorer command activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureDataExplorerCommandActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureDataExplorerCommandActivityTypeProperties": { + "description": "Azure Data Explorer command activity properties.", + "type": "object", + "properties": { + "command": { + "type": "object", + "description": "A control command, according to the Azure Data Explorer command syntax. Type: string (or Expression with resultType string)." + }, + "commandTimeout": { + "type": "object", + "description": "Control command timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))..)" + } + }, + "required": [ + "command" + ] + }, + "LookupActivity": { + "x-ms-discriminator-value": "Lookup", + "description": "Lookup activity.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Lookup activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/LookupActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "LookupActivityTypeProperties": { + "description": "Lookup activity properties.", + "type": "object", + "properties": { + "source": { + "description": "Dataset-specific source properties, same as copy activity source.", + "$ref": "#/definitions/CopySource" + }, + "dataset": { + "description": "Lookup activity dataset reference.", + "$ref": "../artifacts.json#/definitions/DatasetReference" + }, + "firstRowOnly": { + "type": "object", + "description": "Whether to return first row or all rows. Default value is true. Type: boolean (or Expression with resultType boolean)." + } + }, + "required": [ + "source", + "dataset" + ] + }, + "WebActivityMethod": { + "description": "The list of HTTP methods supported by a WebActivity.", + "type": "string", + "enum": [ + "GET", + "POST", + "PUT", + "DELETE" + ], + "x-ms-enum": { + "name": "WebActivityMethod", + "modelAsString": true + } + }, + "WebActivity": { + "x-ms-discriminator-value": "WebActivity", + "description": "Web activity.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Web activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WebActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "WebActivityAuthentication": { + "description": "Web activity authentication properties.", + "type": "object", + "properties": { + "type": { + "description": "Web activity authentication (Basic/ClientCertificate/MSI)", + "type": "string" + }, + "pfx": { + "description": "Base64-encoded contents of a PFX file.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "username": { + "description": "Web activity authentication user name for basic authentication.", + "type": "string" + }, + "password": { + "description": "Password for the PFX file or basic authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "resource": { + "description": "Resource for which Azure Auth token will be requested when using MSI Authentication.", + "type": "string" + } + }, + "required": [ + "type" + ] + }, + "WebActivityTypeProperties": { + "description": "Web activity type properties.", + "type": "object", + "properties": { + "method": { + "description": "Rest API method for target endpoint.", + "$ref": "#/definitions/WebActivityMethod" + }, + "url": { + "type": "object", + "description": "Web activity target endpoint and path. Type: string (or Expression with resultType string)." + }, + "headers": { + "type": "object", + "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)." + }, + "body": { + "type": "object", + "description": "Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string)." + }, + "authentication": { + "description": "Authentication method used for calling the endpoint.", + "$ref": "#/definitions/WebActivityAuthentication" + }, + "datasets": { + "type": "array", + "description": "List of datasets passed to web endpoint.", + "items": { + "$ref": "../artifacts.json#/definitions/DatasetReference" + } + }, + "linkedServices": { + "type": "array", + "description": "List of linked services passed to web endpoint.", + "items": { + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + } + }, + "connectVia": { + "description": "The integration runtime reference.", + "$ref": "../artifacts.json#/definitions/IntegrationRuntimeReference" + } + }, + "required": [ + "method", + "url" + ] + }, + "GetMetadataActivity": { + "x-ms-discriminator-value": "GetMetadata", + "description": "Activity to get metadata of dataset", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "GetMetadata activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GetMetadataActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "GetMetadataActivityTypeProperties": { + "description": "GetMetadata activity properties.", + "type": "object", + "properties": { + "dataset": { + "description": "GetMetadata activity dataset reference.", + "$ref": "../artifacts.json#/definitions/DatasetReference" + }, + "fieldList": { + "description": "Fields of metadata to get from dataset.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "GetMetadata activity store settings." + }, + "formatSettings": { + "$ref": "#/definitions/FormatReadSettings", + "description": "GetMetadata activity format settings." + } + }, + "required": [ + "dataset" + ] + }, + "IfConditionActivity": { + "x-ms-discriminator-value": "IfCondition", + "description": "This activity evaluates a boolean expression and executes either the activities under the ifTrueActivities property or the ifFalseActivities property depending on the result of the expression.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "IfCondition activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/IfConditionActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "IfConditionActivityTypeProperties": { + "description": "IfCondition activity properties.", + "type": "object", + "properties": { + "expression": { + "description": "An expression that would evaluate to Boolean. This is used to determine the block of activities (ifTrueActivities or ifFalseActivities) that will be executed.", + "$ref": "../artifacts.json#/definitions/Expression" + }, + "ifTrueActivities": { + "type": "array", + "description": "List of activities to execute if expression is evaluated to true. This is an optional property and if not provided, the activity will exit without any action.", + "items": { + "$ref": "#/definitions/Activity" + } + }, + "ifFalseActivities": { + "type": "array", + "description": "List of activities to execute if expression is evaluated to false. This is an optional property and if not provided, the activity will exit without any action.", + "items": { + "$ref": "#/definitions/Activity" + } + } + }, + "required": [ + "expression" + ] + }, + "SwitchActivity": { + "x-ms-discriminator-value": "Switch", + "description": "This activity evaluates an expression and executes activities under the cases property that correspond to the expression evaluation expected in the equals property.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Switch activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SwitchActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SwitchActivityTypeProperties": { + "description": "Switch activity properties.", + "type": "object", + "properties": { + "on": { + "description": "An expression that would evaluate to a string or integer. This is used to determine the block of activities in cases that will be executed.", + "$ref": "../artifacts.json#/definitions/Expression" + }, + "cases": { + "type": "array", + "description": "List of cases that correspond to expected values of the 'on' property. This is an optional property and if not provided, the activity will execute activities provided in defaultActivities.", + "items": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SwitchCase" + } + }, + "defaultActivities": { + "type": "array", + "description": "List of activities to execute if no case condition is satisfied. This is an optional property and if not provided, the activity will exit without any action.", + "items": { + "$ref": "#/definitions/Activity" + } + } + }, + "required": [ + "on" + ] + }, + "SwitchCase": { + "description": "Switch cases with have a value and corresponding activities.", + "type": "object", + "properties": { + "value": { + "description": "Expected value that satisfies the expression result of the 'on' property.", + "type": "string" + }, + "activities": { + "type": "array", + "description": "List of activities to execute for satisfied case condition.", + "items": { + "$ref": "#/definitions/Activity" + } + } + } + }, + "ForEachActivity": { + "x-ms-discriminator-value": "ForEach", + "description": "This activity is used for iterating over a collection and execute given activities.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "ForEach activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ForEachActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ForEachActivityTypeProperties": { + "description": "ForEach activity properties.", + "type": "object", + "properties": { + "isSequential": { + "description": "Should the loop be executed in sequence or in parallel (max 50)", + "type": "boolean" + }, + "batchCount": { + "description": "Batch count to be used for controlling the number of parallel execution (when isSequential is set to false).", + "type": "integer", + "maximum": 50 + }, + "items": { + "description": "Collection to iterate.", + "$ref": "../artifacts.json#/definitions/Expression" + }, + "activities": { + "type": "array", + "description": "List of activities to execute .", + "items": { + "$ref": "#/definitions/Activity" + } + } + }, + "required": [ + "items", + "activities" + ] + }, + "AzureMLBatchExecutionActivity": { + "description": "Azure ML Batch Execution activity.", + "type": "object", + "x-ms-discriminator-value": "AzureMLBatchExecution", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Azure ML Batch Execution activity properties.", + "$ref": "#/definitions/AzureMLBatchExecutionActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureMLBatchExecutionActivityTypeProperties": { + "description": "Azure ML Batch Execution activity properties.", + "type": "object", + "properties": { + "globalParameters": { + "description": "Key,Value pairs to be passed to the Azure ML Batch Execution Service endpoint. Keys must match the names of web service parameters defined in the published Azure ML web service. Values will be passed in the GlobalParameters property of the Azure ML batch execution request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "webServiceOutputs": { + "description": "Key,Value pairs, mapping the names of Azure ML endpoint's Web Service Outputs to AzureMLWebServiceFile objects specifying the output Blob locations. This information will be passed in the WebServiceOutputs property of the Azure ML batch execution request.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AzureMLWebServiceFile" + } + }, + "webServiceInputs": { + "description": "Key,Value pairs, mapping the names of Azure ML endpoint's Web Service Inputs to AzureMLWebServiceFile objects specifying the input Blob locations.. This information will be passed in the WebServiceInputs property of the Azure ML batch execution request.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AzureMLWebServiceFile" + } + } + } + }, + "AzureMLWebServiceFile": { + "description": "Azure ML WebService Input/Output file", + "type": "object", + "properties": { + "filePath": { + "type": "object", + "description": "The relative file path, including container name, in the Azure Blob Storage specified by the LinkedService. Type: string (or Expression with resultType string)." + }, + "linkedServiceName": { + "description": "Reference to an Azure Storage LinkedService, where Azure ML WebService Input/Output file located.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + } + }, + "required": [ + "linkedServiceName", + "filePath" + ] + }, + "AzureMLUpdateResourceActivity": { + "description": "Azure ML Update Resource management activity.", + "type": "object", + "x-ms-discriminator-value": "AzureMLUpdateResource", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Azure ML Update Resource management activity properties.", + "$ref": "#/definitions/AzureMLUpdateResourceActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureMLUpdateResourceActivityTypeProperties": { + "description": "Azure ML Update Resource activity properties.", + "type": "object", + "properties": { + "trainedModelName": { + "type": "object", + "description": "Name of the Trained Model module in the Web Service experiment to be updated. Type: string (or Expression with resultType string)." + }, + "trainedModelLinkedServiceName": { + "description": "Name of Azure Storage linked service holding the .ilearner file that will be uploaded by the update operation.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "trainedModelFilePath": { + "type": "object", + "description": "The relative file path in trainedModelLinkedService to represent the .ilearner file that will be uploaded by the update operation. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "trainedModelName", + "trainedModelLinkedServiceName", + "trainedModelFilePath" + ] + }, + "AzureMLExecutePipelineActivity": { + "description": "Azure ML Execute Pipeline activity.", + "type": "object", + "x-ms-discriminator-value": "AzureMLExecutePipeline", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Azure ML Execute Pipeline activity properties.", + "$ref": "#/definitions/AzureMLExecutePipelineActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureMLExecutePipelineActivityTypeProperties": { + "description": "Azure ML Execute Pipeline activity properties.", + "type": "object", + "properties": { + "mlPipelineId": { + "description": "ID of the published Azure ML pipeline. Type: string (or Expression with resultType string).", + "type": "object" + }, + "experimentName": { + "description": "Run history experiment name of the pipeline run. This information will be passed in the ExperimentName property of the published pipeline execution request. Type: string (or Expression with resultType string).", + "type": "object" + }, + "mlPipelineParameters": { + "description": "Key,Value pairs to be passed to the published Azure ML pipeline endpoint. Keys must match the names of pipeline parameters defined in the published pipeline. Values will be passed in the ParameterAssignments property of the published pipeline execution request. Type: object with key value pairs (or Expression with resultType object).", + "type": "object" + }, + "mlParentRunId": { + "description": "The parent Azure ML Service pipeline run id. This information will be passed in the ParentRunId property of the published pipeline execution request. Type: string (or Expression with resultType string).", + "type": "object" + }, + "continueOnStepFailure": { + "description": "Whether to continue execution of other steps in the PipelineRun if a step fails. This information will be passed in the continueOnStepFailure property of the published pipeline execution request. Type: boolean (or Expression with resultType boolean).", + "type": "object" + } + }, + "required": [ + "mlPipelineId" + ] + }, + "AzureMLPipelineParameters": { + "description": "Key,Value pairs to be passed to the published Azure ML pipeline endpoint. Keys must match the names of pipeline parameters defined in the published pipeline. Values will be passed in the ParameterAssignments property of the published pipeline execution request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "DataLakeAnalyticsUSQLActivity": { + "description": "Data Lake Analytics U-SQL activity.", + "type": "object", + "x-ms-discriminator-value": "DataLakeAnalyticsU-SQL", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Data Lake Analytics U-SQL activity properties.", + "$ref": "#/definitions/DataLakeAnalyticsUSQLActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DataLakeAnalyticsUSQLActivityTypeProperties": { + "description": "DataLakeAnalyticsU-SQL activity properties.", + "type": "object", + "properties": { + "scriptPath": { + "type": "object", + "description": "Case-sensitive path to folder that contains the U-SQL script. Type: string (or Expression with resultType string)." + }, + "scriptLinkedService": { + "description": "Script linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "degreeOfParallelism": { + "type": "object", + "description": "The maximum number of nodes simultaneously used to run the job. Default value is 1. Type: integer (or Expression with resultType integer), minimum: 1." + }, + "priority": { + "type": "object", + "description": "Determines which jobs out of all that are queued should be selected to run first. The lower the number, the higher the priority. Default value is 1000. Type: integer (or Expression with resultType integer), minimum: 1." + }, + "parameters": { + "description": "Parameters for U-SQL job request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "runtimeVersion": { + "type": "object", + "description": "Runtime version of the U-SQL engine to use. Type: string (or Expression with resultType string)." + }, + "compilationMode": { + "type": "object", + "description": "Compilation mode of U-SQL. Must be one of these values : Semantic, Full and SingleBox. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "scriptPath", + "scriptLinkedService" + ] + }, + "WaitActivity": { + "x-ms-discriminator-value": "Wait", + "description": "This activity suspends pipeline execution for the specified interval.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Wait activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WaitActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "WaitActivityTypeProperties": { + "description": "Wait activity properties.", + "type": "object", + "properties": { + "waitTimeInSeconds": { + "description": "Duration in seconds.", + "type": "object" + } + }, + "required": [ + "waitTimeInSeconds" + ] + }, + "UntilActivity": { + "x-ms-discriminator-value": "Until", + "description": "This activity executes inner activities until the specified boolean expression results to true or timeout is reached, whichever is earlier.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Until activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/UntilActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "UntilActivityTypeProperties": { + "description": "Until activity properties.", + "type": "object", + "properties": { + "expression": { + "description": "An expression that would evaluate to Boolean. The loop will continue until this expression evaluates to true", + "$ref": "../artifacts.json#/definitions/Expression" + }, + "timeout": { + "type": "object", + "description": "Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])). Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "activities": { + "type": "array", + "description": "List of activities to execute.", + "items": { + "$ref": "#/definitions/Activity" + } + } + }, + "required": [ + "expression", + "activities" + ] + }, + "ValidationActivity": { + "x-ms-discriminator-value": "Validation", + "description": "This activity verifies that an external resource exists.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Validation activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ValidationActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ValidationActivityTypeProperties": { + "description": "Validation activity properties.", + "type": "object", + "properties": { + "timeout": { + "type": "object", + "description": "Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "sleep": { + "type": "object", + "description": "A delay in seconds between validation attempts. If no value is specified, 10 seconds will be used as the default. Type: integer (or Expression with resultType integer)." + }, + "minimumSize": { + "type": "object", + "description": "Can be used if dataset points to a file. The file must be greater than or equal in size to the value specified. Type: integer (or Expression with resultType integer)." + }, + "childItems": { + "type": "object", + "description": "Can be used if dataset points to a folder. If set to true, the folder must have at least one file. If set to false, the folder must be empty. Type: boolean (or Expression with resultType boolean)." + }, + "dataset": { + "description": "Validation activity dataset reference.", + "$ref": "../artifacts.json#/definitions/DatasetReference" + } + }, + "required": [ + "dataset" + ] + }, + "FilterActivity": { + "x-ms-discriminator-value": "Filter", + "description": "Filter and return results from input array based on the conditions.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Filter activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/FilterActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "FilterActivityTypeProperties": { + "description": "Filter activity properties.", + "type": "object", + "properties": { + "items": { + "description": "Input array on which filter should be applied.", + "$ref": "../artifacts.json#/definitions/Expression" + }, + "condition": { + "description": "Condition to be used for filtering the input.", + "$ref": "../artifacts.json#/definitions/Expression" + } + }, + "required": [ + "condition", + "items" + ] + }, + "DatabricksNotebookActivity": { + "description": "DatabricksNotebook activity.", + "type": "object", + "x-ms-discriminator-value": "DatabricksNotebook", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Databricks Notebook activity properties.", + "$ref": "#/definitions/DatabricksNotebookActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DatabricksNotebookActivityTypeProperties": { + "description": "Databricks Notebook activity properties.", + "type": "object", + "properties": { + "notebookPath": { + "type": "object", + "description": "The absolute path of the notebook to be run in the Databricks Workspace. This path must begin with a slash. Type: string (or Expression with resultType string)." + }, + "baseParameters": { + "description": "Base parameters to be used for each run of this job.If the notebook takes a parameter that is not specified, the default value from the notebook will be used.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "libraries": { + "description": "A list of libraries to be installed on the cluster that will execute the job.", + "type": "array", + "items": { + "type": "object", + "description": "Databricks library definition.", + "additionalProperties": { + "type": "object" + } + } + } + }, + "required": [ + "notebookPath" + ] + }, + "DatabricksSparkJarActivity": { + "description": "DatabricksSparkJar activity.", + "type": "object", + "x-ms-discriminator-value": "DatabricksSparkJar", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Databricks SparkJar activity properties.", + "$ref": "#/definitions/DatabricksSparkJarActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DatabricksSparkJarActivityTypeProperties": { + "description": "Databricks SparkJar activity properties.", + "type": "object", + "properties": { + "mainClassName": { + "type": "object", + "description": "The full name of the class containing the main method to be executed. This class must be contained in a JAR provided as a library. Type: string (or Expression with resultType string)." + }, + "parameters": { + "description": "Parameters that will be passed to the main method.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "libraries": { + "description": "A list of libraries to be installed on the cluster that will execute the job.", + "type": "array", + "items": { + "type": "object", + "description": "Databricks library definition.", + "additionalProperties": { + "type": "object" + } + } + } + }, + "required": [ + "mainClassName" + ] + }, + "DatabricksSparkPythonActivity": { + "description": "DatabricksSparkPython activity.", + "type": "object", + "x-ms-discriminator-value": "DatabricksSparkPython", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Databricks SparkPython activity properties.", + "$ref": "#/definitions/DatabricksSparkPythonActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DatabricksSparkPythonActivityTypeProperties": { + "description": "Databricks SparkPython activity properties.", + "type": "object", + "properties": { + "pythonFile": { + "type": "object", + "description": "The URI of the Python file to be executed. DBFS paths are supported. Type: string (or Expression with resultType string)." + }, + "parameters": { + "description": "Command line parameters that will be passed to the Python file.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "libraries": { + "description": "A list of libraries to be installed on the cluster that will execute the job.", + "type": "array", + "items": { + "type": "object", + "description": "Databricks library definition.", + "additionalProperties": { + "type": "object" + } + } + } + }, + "required": [ + "pythonFile" + ] + }, + "SetVariableActivity": { + "x-ms-discriminator-value": "SetVariable", + "description": "Set value for a Variable.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Set Variable activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SetVariableActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SetVariableActivityTypeProperties": { + "description": "SetVariable activity properties.", + "type": "object", + "properties": { + "variableName": { + "description": "Name of the variable whose value needs to be set.", + "type": "string" + }, + "value": { + "description": "Value to be set. Could be a static value or Expression", + "type": "object" + } + } + }, + "AppendVariableActivity": { + "x-ms-discriminator-value": "AppendVariable", + "description": "Append value for a Variable of type Array.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Append Variable activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AppendVariableActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AppendVariableActivityTypeProperties": { + "description": "AppendVariable activity properties.", + "type": "object", + "properties": { + "variableName": { + "description": "Name of the variable whose value needs to be appended to.", + "type": "string" + }, + "value": { + "description": "Value to be appended. Could be a static value or Expression", + "type": "object" + } + } + }, + "AzureFunctionActivityMethod": { + "description": "The list of HTTP methods supported by a AzureFunctionActivity.", + "type": "string", + "enum": [ + "GET", + "POST", + "PUT", + "DELETE", + "OPTIONS", + "HEAD", + "TRACE" + ], + "x-ms-enum": { + "name": "AzureFunctionActivityMethod", + "modelAsString": true + } + }, + "AzureFunctionActivity": { + "x-ms-discriminator-value": "AzureFunctionActivity", + "description": "Azure Function activity.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Function activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFunctionActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureFunctionActivityTypeProperties": { + "description": "Azure Function activity type properties.", + "type": "object", + "properties": { + "method": { + "description": "Rest API method for target endpoint.", + "$ref": "#/definitions/AzureFunctionActivityMethod" + }, + "functionName": { + "type": "object", + "description": "Name of the Function that the Azure Function Activity will call. Type: string (or Expression with resultType string)" + }, + "headers": { + "type": "object", + "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)." + }, + "body": { + "type": "object", + "description": "Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string)." + } + }, + "required": [ + "method", + "functionName" + ] + }, + "WebHookActivity": { + "x-ms-discriminator-value": "WebHook", + "description": "WebHook activity.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "WebHook activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WebHookActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "WebHookActivityMethod": { + "description": "The list of HTTP methods supported by a WebHook activity.", + "type": "string", + "enum": [ + "POST" + ], + "x-ms-enum": { + "name": "WebHookActivityMethod", + "modelAsString": true + } + }, + "WebHookActivityTypeProperties": { + "description": "WebHook activity type properties.", + "type": "object", + "properties": { + "method": { + "description": "Rest API method for target endpoint.", + "$ref": "#/definitions/WebHookActivityMethod" + }, + "url": { + "type": "object", + "description": "WebHook activity target endpoint and path. Type: string (or Expression with resultType string)." + }, + "timeout": { + "type": "string", + "description": "The timeout within which the webhook should be called back. If there is no value specified, it defaults to 10 minutes. Type: string. Pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "headers": { + "type": "object", + "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)." + }, + "body": { + "type": "object", + "description": "Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string)." + }, + "authentication": { + "description": "Authentication method used for calling the endpoint.", + "$ref": "#/definitions/WebActivityAuthentication" + }, + "reportStatusOnCallBack": { + "type": "object", + "description": "When set to true, statusCode, output and error in callback request body will be consumed by activity. The activity can be marked as failed by setting statusCode >= 400 in callback request. Default is false. Type: boolean (or Expression with resultType boolean)." + } + }, + "required": [ + "method", + "url" + ] + }, + "ExecuteDataFlowActivity": { + "description": "Execute data flow activity.", + "type": "object", + "x-ms-discriminator-value": "ExecuteDataFlow", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Execute data flow activity properties.", + "$ref": "#/definitions/ExecuteDataFlowActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ExecuteDataFlowActivityTypeProperties": { + "description": "Execute data flow activity properties.", + "type": "object", + "properties": { + "dataflow": { + "description": "Data flow reference.", + "$ref": "../artifacts.json#/definitions/DataFlowReference" + }, + "staging": { + "description": "Staging info for execute data flow activity.", + "$ref": "../artifacts.json#/definitions/DataFlowStagingInfo" + }, + "integrationRuntime": { + "description": "The integration runtime reference.", + "$ref": "../artifacts.json#/definitions/IntegrationRuntimeReference" + }, + "compute": { + "description": "Compute properties for data flow activity.", + "type": "object", + "properties": { + "computeType": { + "description": "Compute type of the cluster which will execute data flow job.", + "type": "string", + "enum": [ + "General", + "MemoryOptimized", + "ComputeOptimized" + ], + "x-ms-enum": { + "name": "DataFlowComputeType", + "modelAsString": true + } + }, + "coreCount": { + "description": "Core count of the cluster which will execute data flow job. Supported values are: 8, 16, 32, 48, 80, 144 and 272.", + "type": "integer" + } + } + }, + "traceLevel": { + "description": "Trace level setting used for data flow monitoring output. Supported values are: 'coarse', 'fine', and 'none'. Type: string (or Expression with resultType string)", + "type": "object" + }, + "continueOnError": { + "description": "Continue on error setting used for data flow execution. Enables processing to continue if a sink fails. Type: boolean (or Expression with resultType boolean)", + "type": "object" + }, + "runConcurrently": { + "description": "Concurrent run setting used for data flow execution. Allows sinks with the same save order to be processed concurrently. Type: boolean (or Expression with resultType boolean)", + "type": "object" + } + }, + "required": [ + "dataflow" + ] + }, + "SharePointOnlineListSource": { + "description": "A copy activity source for sharePoint online list source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "The OData query to filter the data in SharePoint Online list. For example, \"$top=1\". Type: string (or Expression with resultType string)." + }, + "httpRequestTimeout": { + "type": "object", + "description": "The wait time to get a response from SharePoint Online. Default value is 5 minutes (00:05:00). Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, + "SqlPartitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel.", + "type": "string", + "enum": [ + "None", + "PhysicalPartitionsOfTable", + "DynamicRange" + ], + "x-ms-enum": { + "name": "SqlPartitionOption", + "modelAsString": true + } + }, + "SapHanaPartitionOption": { + "description": "The partition mechanism that will be used for SAP HANA read in parallel.", + "type": "string", + "enum": [ + "None", + "PhysicalPartitionsOfTable", + "SapHanaDynamicRange" + ], + "x-ms-enum": { + "name": "SapHanaPartitionOption", + "modelAsString": true + } + }, + "SapTablePartitionOption": { + "description": "The partition mechanism that will be used for SAP table read in parallel.", + "type": "string", + "enum": [ + "None", + "PartitionOnInt", + "PartitionOnCalendarYear", + "PartitionOnCalendarMonth", + "PartitionOnCalendarDate", + "PartitionOnTime" + ], + "x-ms-enum": { + "name": "SapTablePartitionOption", + "modelAsString": true + } + }, + "OraclePartitionOption": { + "description": "The partition mechanism that will be used for Oracle read in parallel.", + "type": "string", + "enum": [ + "None", + "PhysicalPartitionsOfTable", + "DynamicRange" + ], + "x-ms-enum": { + "name": "OraclePartitionOption", + "modelAsString": true + } + }, + "TeradataPartitionOption": { + "description": "The partition mechanism that will be used for teradata read in parallel.", + "type": "string", + "enum": [ + "None", + "Hash", + "DynamicRange" + ], + "x-ms-enum": { + "name": "TeradataPartitionOption", + "modelAsString": true + } + }, + "NetezzaPartitionOption": { + "description": "The partition mechanism that will be used for Netezza read in parallel.", + "type": "string", + "enum": [ + "None", + "DataSlice", + "DynamicRange" + ], + "x-ms-enum": { + "name": "NetezzaPartitionOption", + "modelAsString": true + } + }, + "SynapseNotebookActivity": { + "description": "Execute Synapse notebook activity.", + "type": "object", + "x-ms-discriminator-value": "SynapseNotebook", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Execute Synapse notebook activity properties.", + "$ref": "#/definitions/SynapseNotebookActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SynapseNotebookActivityTypeProperties": { + "description": "Execute Synapse notebook activity properties.", + "type": "object", + "properties": { + "notebook": { + "description": "Synapse notebook reference.", + "$ref": "../artifacts.json#/definitions/SynapseNotebookReference" + }, + "parameters": { + "description": "Notebook parameters.", + "$ref": "../artifacts.json#/definitions/ParameterValueSpecification" + } + }, + "required": [ + "notebook" + ] + }, + "SynapseSparkJobDefinitionActivity": { + "description": "Execute spark job activity.", + "type": "object", + "x-ms-discriminator-value": "SparkJob", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Execute spark job activity properties.", + "$ref": "#/definitions/SynapseSparkJobActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SynapseSparkJobActivityTypeProperties": { + "description": "Execute spark job activity properties.", + "type": "object", + "properties": { + "sparkJob": { + "description": "Synapse spark job reference.", + "$ref": "../artifacts.json#/definitions/SynapseSparkJobReference" + }, + "args": { + "x-ms-client-name": "arguments", + "description": "User specified arguments to SynapseSparkJobDefinitionActivity.", + "type": "array", + "items": { + "description": "Type: string (or Expression with resultType string)." + } + } + }, + "required": [ + "sparkJob" + ] + }, + "SqlPoolStoredProcedureActivity": { + "description": "Execute SQL pool stored procedure activity.", + "type": "object", + "x-ms-discriminator-value": "SqlPoolStoredProcedure", + "allOf": [ + { + "$ref": "#/definitions/Activity" + } + ], + "properties": { + "sqlPool": { + "description": "SQL pool stored procedure reference.", + "$ref": "../artifacts.json#/definitions/SqlPoolReference" + }, + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Execute SQL pool stored procedure activity properties.", + "$ref": "#/definitions/SqlPoolStoredProcedureActivityTypeProperties" + } + }, + "required": [ + "sqlPool", + "typeProperties" + ] + }, + "SqlPoolStoredProcedureActivityTypeProperties": { + "description": "SQL stored procedure activity properties.", + "type": "object", + "properties": { + "storedProcedureName": { + "type": "object", + "description": "Stored procedure name. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + } + }, + "required": [ + "storedProcedureName" + ] + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/SparkConfiguration.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/SparkConfiguration.json new file mode 100644 index 000000000000..390efdb64c8f --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/SparkConfiguration.json @@ -0,0 +1,51 @@ +{ + "swagger": "2.0", + "info": { + "title": "ArtifactsClient", + "version": "2021-06-01-preview" + }, + "paths": {}, + "definitions": { + "SparkConfiguration": { + "type": "object", + "description": "SparkConfiguration Artifact information", + "title": "Information about a SparkConfiguration created at the workspace level.", + "properties": { + "description": { + "type": "string", + "description": "Description about the SparkConfiguration." + }, + "configs": { + "type": "object", + "description": "SparkConfiguration configs.", + "additionalProperties": { + "type": "string" + } + }, + "annotations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Annotations for SparkConfiguration." + }, + "notes": { + "type": "string", + "description": "additional Notes." + }, + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation." + } + }, + "required": [ + "configs" + ] + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/SparkJobDefinition.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/SparkJobDefinition.json new file mode 100644 index 000000000000..b6d5cf7cb67a --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/SparkJobDefinition.json @@ -0,0 +1,124 @@ +{ + "swagger": "2.0", + "info": { + "title": "ArtifactsClient", + "version": "2021-06-01-preview" + }, + "paths": {}, + "definitions": { + "SparkJobDefinition": { + "description": "Spark job definition.", + "type": "object", + "properties": { + "description": { + "description": "The description of the Spark job definition.", + "type": "string" + }, + "targetBigDataPool": { + "description": "Big data pool reference.", + "$ref": "./Notebook.json#/definitions/BigDataPoolReference" + }, + "requiredSparkVersion": { + "description": "The required Spark version of the application.", + "type": "string" + }, + "language": { + "description": "The language of the Spark application.", + "type": "string" + }, + "jobProperties": { + "description": "The properties of the Spark job.", + "$ref": "#/definitions/SparkJobProperties" + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "targetBigDataPool", + "jobProperties" + ] + }, + "SparkJobProperties": { + "description": "The properties of the Spark job.", + "type": "object", + "properties": { + "name": { + "description": "The name of the job.", + "type": "string" + }, + "file": { + "description": "File containing the application to execute.", + "type": "string" + }, + "className": { + "description": "Main class for Java/Scala application.", + "type": "string" + }, + "conf": { + "description": "Spark configuration properties.", + "type": "object" + }, + "args": { + "description": "Command line arguments for the application.", + "type": "array", + "items": { + "type": "string" + } + }, + "jars": { + "description": "Jars to be used in this job.", + "type": "array", + "items": { + "type": "string" + } + }, + "files": { + "description": "files to be used in this job.", + "type": "array", + "items": { + "type": "string" + } + }, + "archives": { + "description": "Archives to be used in this job.", + "type": "array", + "items": { + "type": "string" + } + }, + "driverMemory": { + "description": "Amount of memory to use for the driver process.", + "type": "string" + }, + "driverCores": { + "description": "Number of cores to use for the driver.", + "type": "integer" + }, + "executorMemory": { + "description": "Amount of memory to use per executor process.", + "type": "string" + }, + "executorCores": { + "description": "Number of cores to use for each executor.", + "type": "integer" + }, + "numExecutors": { + "description": "Number of executors to launch for this job.", + "type": "integer" + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "file", + "driverMemory", + "driverCores", + "executorMemory", + "executorCores", + "numExecutors" + ] + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/SqlScript.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/SqlScript.json new file mode 100644 index 000000000000..caf3d817de18 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/SqlScript.json @@ -0,0 +1,108 @@ +{ + "swagger": "2.0", + "info": { + "title": "ArtifactsClient", + "version": "2021-06-01-preview" + }, + "paths": {}, + "definitions": { + "SqlScript": { + "description": "SQL script.", + "type": "object", + "properties": { + "description": { + "description": "The description of the SQL script.", + "type": "string" + }, + "type": { + "description": "The type of the SQL script.", + "type": "string", + "enum": [ + "SqlQuery" + ], + "x-ms-enum": { + "name": "SqlScriptType", + "modelAsString": true + } + }, + "content": { + "description": "The content of the SQL script.", + "$ref": "#/definitions/SqlScriptContent" + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "content" + ] + }, + "SqlScriptContent": { + "description": "The content of the SQL script.", + "type": "object", + "properties": { + "query": { + "description": "SQL query to execute.", + "type": "string" + }, + "currentConnection": { + "description": "The connection used to execute the SQL script.", + "$ref": "#/definitions/SqlConnection" + }, + "metadata": { + "description": "The metadata of the SQL script.", + "$ref": "#/definitions/SqlScriptMetadata" + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "query", + "currentConnection" + ] + }, + "SqlScriptMetadata": { + "description": "The metadata of the SQL script.", + "type": "object", + "properties": { + "language": { + "description": "The language of the SQL script.", + "type": "string" + } + }, + "additionalProperties": { + "type": "object" + } + }, + "SqlConnection": { + "description": "The connection used to execute the SQL script.", + "type": "object", + "properties": { + "type": { + "description": "The type of the connection.", + "type": "string", + "enum": [ + "SqlOnDemand", + "SqlPool" + ], + "x-ms-enum": { + "name": "SqlConnectionType", + "modelAsString": true + } + }, + "name": { + "description": "The identifier of the connection.", + "type": "string" + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type", + "name" + ] + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/Trigger.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/Trigger.json new file mode 100644 index 000000000000..fbed24cc6eb8 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/Trigger.json @@ -0,0 +1,681 @@ +{ + "swagger": "2.0", + "info": { + "title": "ArtifactsClient", + "version": "2021-06-01-preview" + }, + "paths": {}, + "definitions": { + "Trigger": { + "description": "Azure Synapse nested object which contains information about creating pipeline run", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Trigger type." + }, + "description": { + "description": "Trigger description.", + "type": "string" + }, + "runtimeState": { + "$ref": "#/definitions/TriggerRuntimeState", + "description": "Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger.", + "readOnly": true + }, + "annotations": { + "description": "List of tags that can be used for describing the trigger.", + "type": "array", + "items": { + "type": "object" + } + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "TriggerRuntimeState": { + "type": "string", + "description": "Enumerates possible state of Triggers.", + "enum": [ + "Started", + "Stopped", + "Disabled" + ], + "x-ms-enum": { + "name": "TriggerRuntimeState", + "modelAsString": true + } + }, + "MultiplePipelineTrigger": { + "x-ms-discriminator-value": "MultiplePipelineTrigger", + "description": "Base class for all triggers that support one to many model for trigger to pipeline.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Trigger" + } + ], + "properties": { + "pipelines": { + "type": "array", + "items": { + "$ref": "../artifacts.json#/definitions/TriggerPipelineReference" + }, + "description": "Pipelines that need to be started." + } + } + }, + "ScheduleTrigger": { + "description": "Trigger that creates pipeline runs periodically, on schedule.", + "allOf": [ + { + "$ref": "#/definitions/MultiplePipelineTrigger" + } + ], + "properties": { + "typeProperties": { + "description": "Schedule Trigger properties.", + "x-ms-client-flatten": true, + "properties": { + "recurrence": { + "$ref": "#/definitions/ScheduleTriggerRecurrence", + "description": "Recurrence schedule configuration." + } + }, + "required": [ + "recurrence" + ] + } + }, + "required": [ + "typeProperties" + ] + }, + "ScheduleTriggerRecurrence": { + "type": "object", + "properties": { + "frequency": { + "$ref": "#/definitions/RecurrenceFrequency", + "description": "The frequency." + }, + "interval": { + "type": "integer", + "format": "int32", + "description": "The interval." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time." + }, + "timeZone": { + "type": "string", + "description": "The time zone." + }, + "schedule": { + "$ref": "#/definitions/RecurrenceSchedule", + "description": "The recurrence schedule." + } + }, + "additionalProperties": { + "type": "object" + }, + "description": "The workflow trigger recurrence." + }, + "RecurrenceFrequency": { + "description": "Enumerates possible frequency option for the schedule trigger.", + "type": "string", + "enum": [ + "NotSpecified", + "Minute", + "Hour", + "Day", + "Week", + "Month", + "Year" + ], + "x-ms-enum": { + "name": "RecurrenceFrequency", + "modelAsString": true + } + }, + "RecurrenceSchedule": { + "type": "object", + "properties": { + "minutes": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "The minutes." + }, + "hours": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "The hours." + }, + "weekDays": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + } + }, + "description": "The days of the week." + }, + "monthDays": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "The month days." + }, + "monthlyOccurrences": { + "type": "array", + "items": { + "$ref": "#/definitions/RecurrenceScheduleOccurrence" + }, + "description": "The monthly occurrences." + } + }, + "additionalProperties": { + "type": "object" + }, + "description": "The recurrence schedule." + }, + "RecurrenceScheduleOccurrence": { + "type": "object", + "properties": { + "day": { + "$ref": "#/definitions/DayOfWeek", + "description": "The day of the week." + }, + "occurrence": { + "type": "integer", + "format": "int32", + "description": "The occurrence." + } + }, + "additionalProperties": { + "type": "object" + }, + "description": "The recurrence schedule occurrence." + }, + "DayOfWeek": { + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + }, + "description": "The days of the week." + }, + "BlobTrigger": { + "description": "Trigger that runs every time the selected Blob container changes.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MultiplePipelineTrigger" + } + ], + "properties": { + "typeProperties": { + "description": "Blob Trigger properties.", + "x-ms-client-flatten": true, + "properties": { + "folderPath": { + "description": "The path of the container/folder that will trigger the pipeline.", + "type": "string" + }, + "maxConcurrency": { + "description": "The max number of parallel files to handle when it is triggered.", + "type": "integer" + }, + "linkedService": { + "description": "The Azure Storage linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + } + }, + "required": [ + "folderPath", + "maxConcurrency", + "linkedService" + ] + } + }, + "required": [ + "typeProperties" + ] + }, + "BlobEventsTrigger": { + "description": "Trigger that runs every time a Blob event occurs.", + "allOf": [ + { + "$ref": "#/definitions/MultiplePipelineTrigger" + } + ], + "properties": { + "typeProperties": { + "description": "Blob Events Trigger properties.", + "x-ms-client-flatten": true, + "properties": { + "blobPathBeginsWith": { + "description": "The blob path must begin with the pattern provided for trigger to fire. For example, '/records/blobs/december/' will only fire the trigger for blobs in the december folder under the records container. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith.", + "type": "string" + }, + "blobPathEndsWith": { + "description": "The blob path must end with the pattern provided for trigger to fire. For example, 'december/boxes.csv' will only fire the trigger for blobs named boxes in a december folder. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith.", + "type": "string" + }, + "ignoreEmptyBlobs": { + "description": "If set to true, blobs with zero bytes will be ignored.", + "type": "boolean" + }, + "events": { + "description": "The type of events that cause this trigger to fire.", + "$ref": "#/definitions/BlobEventTypes" + }, + "scope": { + "description": "The ARM resource ID of the Storage Account.", + "type": "string" + } + }, + "required": [ + "events", + "scope" + ] + } + }, + "required": [ + "typeProperties" + ] + }, + "BlobEventTypes": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Microsoft.Storage.BlobCreated", + "Microsoft.Storage.BlobDeleted" + ], + "x-ms-enum": { + "name": "BlobEventType", + "modelAsString": true + } + }, + "description": "Blob event types." + }, + "CustomEventsTrigger": { + "description": "Trigger that runs every time a custom event is received.", + "allOf": [ + { + "$ref": "#/definitions/MultiplePipelineTrigger" + } + ], + "properties": { + "typeProperties": { + "description": "Custom Events Trigger properties.", + "x-ms-client-flatten": true, + "properties": { + "subjectBeginsWith": { + "description": "The event subject must begin with the pattern provided for trigger to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith.", + "type": "string" + }, + "subjectEndsWith": { + "description": "The event subject must end with the pattern provided for trigger to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith.", + "type": "string" + }, + "events": { + "description": "The list of event types that cause this trigger to fire.", + "type": "array", + "items": { + "type": "object" + } + }, + "scope": { + "description": "The ARM resource ID of the Azure Event Grid Topic.", + "type": "string" + } + }, + "required": [ + "events", + "scope" + ] + } + }, + "required": [ + "typeProperties" + ] + }, + "TumblingWindowTrigger": { + "description": "Trigger that schedules pipeline runs for all fixed time interval windows from a start time without gaps and also supports backfill scenarios (when start time is in the past).", + "allOf": [ + { + "$ref": "#/definitions/Trigger" + } + ], + "properties": { + "pipeline": { + "$ref": "../artifacts.json#/definitions/TriggerPipelineReference", + "description": "Pipeline for which runs are created when an event is fired for trigger window that is ready." + }, + "typeProperties": { + "description": "Tumbling Window Trigger properties.", + "x-ms-client-flatten": true, + "properties": { + "frequency": { + "$ref": "#/definitions/TumblingWindowFrequency", + "description": "The frequency of the time windows." + }, + "interval": { + "type": "integer", + "format": "int32", + "description": "The interval of the time windows. The minimum interval allowed is 15 Minutes." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported." + }, + "delay": { + "type": "object", + "description": "Specifies how long the trigger waits past due time before triggering new run. It doesn't alter window start and end time. The default is 0. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "maxConcurrency": { + "description": "The max number of parallel time windows (ready for execution) for which a new run is triggered.", + "type": "integer", + "minimum": 1, + "maximum": 50 + }, + "retryPolicy": { + "$ref": "#/definitions/RetryPolicy", + "description": "Retry policy that will be applied for failed pipeline runs." + }, + "dependsOn": { + "type": "array", + "description": "Triggers that this trigger depends on. Only tumbling window triggers are supported.", + "items": { + "$ref": "#/definitions/DependencyReference" + } + } + }, + "required": [ + "frequency", + "interval", + "startTime", + "maxConcurrency" + ] + } + }, + "required": [ + "pipeline", + "typeProperties" + ] + }, + "TumblingWindowFrequency": { + "description": "Enumerates possible frequency option for the tumbling window trigger.", + "type": "string", + "enum": [ + "Minute", + "Hour", + "Month" + ], + "x-ms-enum": { + "name": "TumblingWindowFrequency", + "modelAsString": true + } + }, + "RetryPolicy": { + "description": "Execution policy for an activity.", + "type": "object", + "properties": { + "count": { + "type": "object", + "description": "Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "intervalInSeconds": { + "description": "Interval between retries in seconds. Default is 30.", + "type": "integer", + "minimum": 30, + "maximum": 86400 + } + } + }, + "TriggerReference": { + "description": "Trigger reference type.", + "type": "object", + "properties": { + "type": { + "description": "Trigger reference type.", + "type": "string", + "enum": [ + "TriggerReference" + ], + "x-ms-enum": { + "name": "TriggerReferenceType", + "modelAsString": true + } + }, + "referenceName": { + "description": "Reference trigger name.", + "type": "string" + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "DependencyReference": { + "description": "Referenced dependency.", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "description": "The type of dependency reference.", + "type": "string" + } + }, + "required": [ + "type" + ] + }, + "TriggerDependencyReference": { + "description": "Trigger referenced dependency.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DependencyReference" + } + ], + "properties": { + "referenceTrigger": { + "description": "Referenced trigger.", + "$ref": "#/definitions/TriggerReference" + } + }, + "required": [ + "referenceTrigger" + ] + }, + "TumblingWindowTriggerDependencyReference": { + "description": "Referenced tumbling window trigger dependency.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TriggerDependencyReference" + } + ], + "properties": { + "offset": { + "description": "Timespan applied to the start time of a tumbling window when evaluating dependency.", + "type": "string", + "pattern": "-?((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + }, + "size": { + "description": "The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + } + } + }, + "SelfDependencyTumblingWindowTriggerReference": { + "description": "Self referenced tumbling window trigger dependency.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DependencyReference" + } + ], + "properties": { + "offset": { + "description": "Timespan applied to the start time of a tumbling window when evaluating dependency.", + "type": "string", + "pattern": "-((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + }, + "size": { + "description": "The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + } + }, + "required": [ + "offset" + ] + }, + "RerunTumblingWindowTrigger": { + "description": "Trigger that schedules pipeline reruns for all fixed time interval windows from a requested start time to requested end time.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Trigger" + } + ], + "properties": { + "typeProperties": { + "description": "Rerun Trigger properties.", + "x-ms-client-flatten": true, + "properties": { + "parentTrigger": { + "type": "object", + "description": "The parent trigger reference." + }, + "requestedStartTime": { + "type": "string", + "format": "date-time", + "description": "The start time for the time period for which restatement is initiated. Only UTC time is currently supported." + }, + "requestedEndTime": { + "type": "string", + "format": "date-time", + "description": "The end time for the time period for which restatement is initiated. Only UTC time is currently supported." + }, + "rerunConcurrency": { + "description": "The max number of parallel time windows (ready for execution) for which a rerun is triggered.", + "type": "integer", + "minimum": 1, + "maximum": 50 + } + }, + "required": [ + "parentTrigger", + "requestedStartTime", + "requestedEndTime", + "rerunConcurrency" + ] + } + }, + "required": [ + "typeProperties" + ] + }, + "ChainingTrigger": { + "description": "Trigger that allows the referenced pipeline to depend on other pipeline runs based on runDimension Name/Value pairs. Upstream pipelines should declare the same runDimension Name and their runs should have the values for those runDimensions. The referenced pipeline run would be triggered if the values for the runDimension match for all upstream pipeline runs.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Trigger" + } + ], + "properties": { + "pipeline": { + "$ref": "../artifacts.json#/definitions/TriggerPipelineReference", + "description": "Pipeline for which runs are created when all upstream pipelines complete successfully." + }, + "typeProperties": { + "description": "Chaining Trigger properties.", + "x-ms-client-flatten": true, + "properties": { + "dependsOn": { + "type": "array", + "items": { + "$ref": "../artifacts.json#/definitions/PipelineReference" + }, + "description": "Upstream Pipelines." + }, + "runDimension": { + "description": "Run Dimension property that needs to be emitted by upstream pipelines.", + "type": "string" + } + }, + "required": [ + "runDimension", + "dependsOn" + ] + } + }, + "required": [ + "pipeline", + "typeProperties" + ] + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/ActivityRuns_QueryByPipelineRun.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/ActivityRuns_QueryByPipelineRun.json new file mode 100644 index 000000000000..f13f33b20aa6 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/ActivityRuns_QueryByPipelineRun.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "pipelineName": "examplePipeline", + "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b", + "filterParameters": { + "lastUpdatedAfter": "2018-06-16T00:36:44.3345758Z", + "lastUpdatedBefore": "2018-06-16T00:49:48.3686473Z" + }, + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:13 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1187", + "x-ms-request-id": "5465cf41-2e71-4ce6-8db4-9de1b92ffda9", + "x-ms-correlation-request-id": "5465cf41-2e71-4ce6-8db4-9de1b92ffda9" + }, + "body": { + "value": [ + { + "activityRunEnd": "2018-06-16T00:38:11.5445431Z", + "activityName": "ExampleForeachActivity", + "activityRunStart": "2018-06-16T00:37:49.4804925Z", + "activityType": "ForEach", + "durationInMs": 22064, + "retryAttempt": null, + "error": { + "errorCode": "", + "message": "", + "failureType": "", + "target": "ExampleForeachActivity" + }, + "activityRunId": "f30c5514-fb85-43ed-9fa4-768d42e58680", + "input": {}, + "linkedServiceName": "", + "output": {}, + "userProperties": {}, + "pipelineName": "examplePipeline", + "pipelineRunId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b", + "status": "Succeeded" + }, + { + "activityRunEnd": "2018-06-16T00:38:07.4188923Z", + "activityName": "ExampleCopyActivity", + "activityRunStart": "2018-06-16T00:37:50.2460952Z", + "activityType": "Copy", + "durationInMs": 17172, + "retryAttempt": null, + "error": { + "errorCode": "", + "message": "", + "failureType": "", + "target": "ExampleCopyActivity" + }, + "activityRunId": "a96678c8-7167-4f00-b629-afccfbad4e51", + "input": { + "source": { + "type": "BlobSource" + }, + "sink": { + "type": "BlobSink" + }, + "dataIntegrationUnits": 32 + }, + "linkedServiceName": "", + "output": { + "dataRead": 142000, + "dataWritten": 142000, + "filesRead": 1, + "filesWritten": 1, + "copyDuration": 6, + "throughput": 23.112, + "errors": [], + "effectiveIntegrationRuntime": "DefaultIntegrationRuntime (East US)", + "usedCloudDataMovementUnits": 4, + "usedParallelCopies": 1, + "executionDetails": [ + { + "source": { + "type": "AzureBlob" + }, + "sink": { + "type": "AzureBlob" + }, + "status": "Succeeded", + "start": "2018-06-16T00:37:50.68834Z", + "duration": 6, + "usedCloudDataMovementUnits": 4, + "usedParallelCopies": 1, + "detailedDurations": { + "queuingDuration": 4, + "transferDuration": 2 + } + } + ] + }, + "userProperties": {}, + "pipelineName": "examplePipeline", + "pipelineRunId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b", + "status": "Succeeded" + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/BigDataPools_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/BigDataPools_Get.json new file mode 100644 index 000000000000..293eb88177e1 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/BigDataPools_Get.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "bigDataPoolName": "pool1", + "api-version": "2020-01-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "creationDate": "2020-07-14T10:09:52.5133333Z", + "sparkVersion": "2.4", + "nodeCount": 3, + "nodeSize": "Small", + "nodeSizeFamily": "MemoryOptimized", + "autoScale": { + "enabled": true, + "minNodeCount": 3, + "maxNodeCount": 20 + }, + "autoPause": { + "enabled": true, + "delayInMinutes": 15 + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Synapse/workspaces/exampleWorkspace/sparkComputes/pool1", + "name": "pool1", + "type": "Microsoft.Synapse/workspaces/sparkComputes", + "location": "southeastasia", + "tags": {} + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/BigDataPools_List.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/BigDataPools_List.json new file mode 100644 index 000000000000..9d7eb2a4b3d1 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/BigDataPools_List.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "creationDate": "2020-07-14T10:09:52.5133333Z", + "sparkVersion": "2.4", + "nodeCount": 3, + "nodeSize": "Small", + "nodeSizeFamily": "MemoryOptimized", + "autoScale": { + "enabled": true, + "minNodeCount": 3, + "maxNodeCount": 20 + }, + "autoPause": { + "enabled": true, + "delayInMinutes": 15 + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Synapse/workspaces/exampleWorkspace/sparkComputes/pool1", + "name": "pool1", + "type": "Microsoft.Synapse/workspaces/sparkComputes", + "location": "southeastasia", + "tags": {} + } + ] + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/CreateManagedPrivateEndpoint.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/CreateManagedPrivateEndpoint.json new file mode 100644 index 000000000000..a78dde020bb1 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/CreateManagedPrivateEndpoint.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01", + "managedVirtualNetworkName": "default", + "managedPrivateEndpointName": "myPrivateEndpoint", + "managedPrivateEndpoint": { + "properties": { + "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Storage/accounts/myStorageAccount", + "groupId": "blob" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.Synapse/workspaces/managedVirtualNetworks/managedPrivateEndpoints", + "name": "myPrivateEndpoint", + "properties": { + "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Storage/accounts/myStorageAccount", + "groupId": "blob", + "provisioningState": "Provisioning", + "connectionState": { + "status": "Pending", + "description": "", + "actionsRequired": "" + } + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlowDebugSession_AddDataFlow.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlowDebugSession_AddDataFlow.json new file mode 100644 index 000000000000..092a09a8294c --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlowDebugSession_AddDataFlow.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "request": { + "dataFlow": { + "name": "dataflow1", + "properties": { + "type": "MappingDataFlow", + "typeProperties": { + "sources": [ + { + "dataset": { + "referenceName": "DelimitedText2", + "type": "DatasetReference" + }, + "name": "source1" + } + ], + "sinks": [], + "transformations": [], + "script": "\n\nsource(output(\n\t\tColumn_1 as string\n\t),\n\tallowSchemaDrift: true,\n\tvalidateSchema: false) ~> source1" + } + } + }, + "datasets": [ + { + "name": "dataset1", + "properties": { + "linkedServiceName": { + "referenceName": "linkedService5", + "type": "LinkedServiceReference" + }, + "annotations": [], + "type": "DelimitedText", + "typeProperties": { + "location": { + "type": "AzureBlobStorageLocation", + "fileName": "Ansiencoding.csv", + "container": "dataflow-sample-data" + }, + "columnDelimiter": ",", + "escapeChar": "\\", + "firstRowAsHeader": true, + "quoteChar": "\"" + }, + "schema": [ + { + "type": "String" + } + ] + } + } + ], + "linkedServices": [ + { + "name": "linkedService1", + "properties": { + "type": "AzureBlobStorage", + "typeProperties": { + "connectionString": "DefaultEndpointsProtocol=https;AccountName=;EndpointSuffix=core.windows.net;", + "encryptedCredential": "" + }, + "annotations": [] + } + } + ], + "debugSettings": { + "sourceSettings": [ + { + "sourceName": "source1", + "rowLimit": 1000 + }, + { + "sourceName": "source2", + "rowLimit": 222 + } + ], + "parameters": { + "sourcePath": "Toy" + }, + "datasetParameters": { + "Movies": { + "path": "abc" + }, + "Output": { + "time": "def" + } + } + }, + "sessionId": "f06ed247-9d07-49b2-b05e-2cb4a2fc871e" + }, + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:01 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14989", + "x-ms-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd", + "x-ms-correlation-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd" + }, + "body": { + "jobVersion": "e5328ee7-c524-4207-8ba4-b709010db33d" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlowDebugSession_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlowDebugSession_Create.json new file mode 100644 index 000000000000..357f7f941d7a --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlowDebugSession_Create.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "request": { + "dataFlowName": "dataflow", + "existingClusterId": "1221221", + "clusterTimeout": 50, + "newClusterName": "newClusterName", + "newClusterNodeType": "newClusterNodeType", + "dataBricksLinkedService": { + "properties": { + "type": "AzureStorage", + "typeProperties": { + "connectionString": { + "type": "SecureString", + "value": "DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=" + } + }, + "description": "Example description" + } + } + }, + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:01 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14989", + "x-ms-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd", + "x-ms-correlation-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd", + "location": "https://exampleWorkspaceName.dev.azuresynapse.net/operationStatuses/dfCreateSession$$229c688c-944c-44ac-b31a-82d50f347154?api-version=2021-06-01-preview" + } + }, + "200": { + "body": { + "sessionId": "229c688c-944c-44ac-b31a-82d50f347154" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlowDebugSession_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlowDebugSession_Delete.json new file mode 100644 index 000000000000..f9aad81477a1 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlowDebugSession_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "request": { + "sessionId": "91fb57e0-8292-47be-89ff-c8f2d2bb2a7e" + }, + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:01 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14989", + "x-ms-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd", + "x-ms-correlation-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlowDebugSession_ExecuteCommand.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlowDebugSession_ExecuteCommand.json new file mode 100644 index 000000000000..d5ce58ed0bb0 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlowDebugSession_ExecuteCommand.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "request": { + "dataFlowName": "dataFlowName", + "commandPayload": { + "streamName": "source1", + "rowLimits": 100 + }, + "commandName": "executePreviewQuery", + "sessionId": "f06ed247-9d07-49b2-b05e-2cb4a2fc871e" + }, + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:01 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14989", + "x-ms-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd", + "x-ms-correlation-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd", + "location": "https://exampleWorkspaceName.dev.azuresynapse.net/operationResults/dfCommandOutput$$f06ed247-9d07-49b2-b05e-2cb4a2fc871e$$e5328ee7-c524-4207-8ba4-b709010db33d$$ace5eaf0-3e93-45ba-ada3-bf77da321a7b?api-version=2021-06-01-preview" + } + }, + "200": { + "body": { + "status": "Succeeded", + "data": "some output" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlowDebugSession_QueryByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlowDebugSession_QueryByWorkspace.json new file mode 100644 index 000000000000..2d8c1db1178f --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlowDebugSession_QueryByWorkspace.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:01 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14989", + "x-ms-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd", + "x-ms-correlation-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd" + }, + "body": { + "value": [ + { + "userObjectId": "0a7e0d6e-f2b7-48cc-8cd8-618326f5662f", + "startTime": "2019-09-05T18:23:20.3257799+00:00", + "lastActivityTime": "2019-09-05T18:28:00.9459674+00:00", + "dataflowName": "DebugSession-0a7e0d6e-f2b7-48cc-8cd8-618326f5662f", + "sessionId": "229c688c-944c-44ac-b31a-82d50f347154", + "coreCount": 48, + "computeType": "General", + "timeToLiveInMinutes": 60 + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlows_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlows_Create.json new file mode 100644 index 000000000000..6b020c82e396 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlows_Create.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "dataFlowName": "exampleDataFlow", + "ifMatch": null, + "dataFlow": { + "properties": { + "description": "Sample demo data flow to convert currencies showing usage of union, derive and conditional split transformation.", + "type": "MappingDataFlow", + "typeProperties": { + "sources": [ + { + "dataset": { + "referenceName": "CurrencyDatasetUSD", + "type": "DatasetReference" + }, + "name": "USDCurrency" + }, + { + "dataset": { + "referenceName": "CurrencyDatasetCAD", + "type": "DatasetReference" + }, + "name": "CADSource" + } + ], + "sinks": [ + { + "dataset": { + "referenceName": "USDOutput", + "type": "DatasetReference" + }, + "name": "USDSink" + }, + { + "dataset": { + "referenceName": "CADOutput", + "type": "DatasetReference" + }, + "name": "CADSink" + } + ], + "script": "source(output(PreviousConversionRate as double,Country as string,DateTime1 as string,CurrentConversionRate as double),allowSchemaDrift: false,validateSchema: false) ~> USDCurrency\nsource(output(PreviousConversionRate as double,Country as string,DateTime1 as string,CurrentConversionRate as double),allowSchemaDrift: true,validateSchema: false) ~> CADSource\nUSDCurrency, CADSource union(byName: true)~> Union\nUnion derive(NewCurrencyRate = round(CurrentConversionRate*1.25)) ~> NewCurrencyColumn\nNewCurrencyColumn split(Country == 'USD',Country == 'CAD',disjoint: false) ~> ConditionalSplit1@(USD, CAD)\nConditionalSplit1@USD sink(saveMode:'overwrite' ) ~> USDSink\nConditionalSplit1@CAD sink(saveMode:'overwrite' ) ~> CADSink" + } + } + }, + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2019 00:37:38 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1194", + "x-ms-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0", + "x-ms-correlation-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0" + } + }, + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/datasets/exampleDataset", + "name": "exampleDataFlow", + "type": "Microsoft.Synapse/workspaces/dataflows", + "properties": { + "description": "Sample demo data flow to convert currencies showing usage of union, derive and conditional split transformation.", + "type": "MappingDataFlow", + "typeProperties": { + "sources": [ + { + "dataset": { + "referenceName": "CurrencyDatasetUSD", + "type": "DatasetReference" + }, + "name": "USDCurrency" + }, + { + "dataset": { + "referenceName": "CurrencyDatasetCAD", + "type": "DatasetReference" + }, + "name": "CADSource" + } + ], + "sinks": [ + { + "dataset": { + "referenceName": "USDOutput", + "type": "DatasetReference" + }, + "name": "USDSink" + }, + { + "dataset": { + "referenceName": "CADOutput", + "type": "DatasetReference" + }, + "name": "CADSink" + } + ], + "script": "source(output(PreviousConversionRate as double,Country as string,DateTime1 as string,CurrentConversionRate as double),allowSchemaDrift: false,validateSchema: false) ~> USDCurrency\nsource(output(PreviousConversionRate as double,Country as string,DateTime1 as string,CurrentConversionRate as double),allowSchemaDrift: true,validateSchema: false) ~> CADSource\nUSDCurrency, CADSource union(byName: true)~> Union\nUnion derive(NewCurrencyRate = round(CurrentConversionRate*1.25)) ~> NewCurrencyColumn\nNewCurrencyColumn split(Country == 'USD',Country == 'CAD',disjoint: false) ~> ConditionalSplit1@(USD, CAD)\nConditionalSplit1@USD sink(saveMode:'overwrite' ) ~> USDSink\nConditionalSplit1@CAD sink(saveMode:'overwrite' ) ~> CADSink" + } + }, + "etag": "0a0066d4-0000-0000-0000-5b245bd20000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlows_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlows_Delete.json new file mode 100644 index 000000000000..105a1bf5869e --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlows_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "dataFlowName": "exampleDataFlow", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlows_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlows_Get.json new file mode 100644 index 000000000000..956f0a44d448 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlows_Get.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "dataFlowName": "exampleDataFlow", + "ifNoneMatch": "15004c4f-0000-0200-0000-5cbe090e0000", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Mon, 22 Apr 2019 18:33:50 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "11993", + "x-ms-request-id": "48983fb5-612a-44c6-8158-add7ffebb32b", + "x-ms-correlation-request-id": "48983fb5-612a-44c6-8158-add7ffebb32b" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/dataflows/exampleDataFlow", + "name": "exampleDataFlow", + "type": "Microsoft.Synapse/workspaces/dataflows", + "properties": { + "description": "Sample demo data flow to convert currencies showing usage of union, derive and conditional split transformation.", + "type": "MappingDataFlow", + "typeProperties": { + "sources": [ + { + "dataset": { + "referenceName": "CurrencyDatasetUSD", + "type": "DatasetReference" + }, + "name": "USDCurrency" + }, + { + "dataset": { + "referenceName": "CurrencyDatasetCAD", + "type": "DatasetReference" + }, + "name": "CADSource" + } + ], + "sinks": [ + { + "dataset": { + "referenceName": "USDOutput", + "type": "DatasetReference" + }, + "name": "USDSink" + }, + { + "dataset": { + "referenceName": "CADOutput", + "type": "DatasetReference" + }, + "name": "CADSink" + } + ], + "script": "source(output(PreviousConversionRate as double,Country as string,DateTime1 as string,CurrentConversionRate as double),allowSchemaDrift: false,validateSchema: false) ~> USDCurrency\nsource(output(PreviousConversionRate as double,Country as string,DateTime1 as string,CurrentConversionRate as double),allowSchemaDrift: true,validateSchema: false) ~> CADSource\nUSDCurrency, CADSource union(byName: true)~> Union\nUnion derive(NewCurrencyRate = round(CurrentConversionRate*1.25)) ~> NewCurrencyColumn\nNewCurrencyColumn split(Country == 'USD',Country == 'CAD',disjoint: false) ~> ConditionalSplit1@(USD, CAD)\nConditionalSplit1@USD sink(saveMode:'overwrite' ) ~> USDSink\nConditionalSplit1@CAD sink(saveMode:'overwrite' ) ~> CADSink" + } + }, + "etag": "15004c4f-0000-0200-0000-5cbe090e0000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlows_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlows_ListByWorkspace.json new file mode 100644 index 000000000000..bd0d46fa4f81 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlows_ListByWorkspace.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:40 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14992", + "x-ms-request-id": "341c9ece-5062-448b-be98-3ccbf476ed5d", + "x-ms-correlation-request-id": "341c9ece-5062-448b-be98-3ccbf476ed5d" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/dataflows/exampleDataFlow", + "name": "exampleDataFlow", + "type": "Microsoft.Synapse/workspaces/dataflows", + "properties": { + "description": "Sample demo data flow to convert currencies showing usage of union, derive and conditional split transformation.", + "type": "MappingDataFlow", + "typeProperties": { + "sources": [ + { + "dataset": { + "referenceName": "CurrencyDatasetUSD", + "type": "DatasetReference" + }, + "name": "USDCurrency" + }, + { + "dataset": { + "referenceName": "CurrencyDatasetCAD", + "type": "DatasetReference" + }, + "name": "CADSource" + } + ], + "sinks": [ + { + "dataset": { + "referenceName": "USDOutput", + "type": "DatasetReference" + }, + "name": "USDSink" + }, + { + "dataset": { + "referenceName": "CADOutput", + "type": "DatasetReference" + }, + "name": "CADSink" + } + ], + "script": "source(output(PreviousConversionRate as double,Country as string,DateTime1 as string,CurrentConversionRate as double),allowSchemaDrift: false,validateSchema: false) ~> USDCurrency\nsource(output(PreviousConversionRate as double,Country as string,DateTime1 as string,CurrentConversionRate as double),allowSchemaDrift: true,validateSchema: false) ~> CADSource\nUSDCurrency, CADSource union(byName: true)~> Union\nUnion derive(NewCurrencyRate = round(CurrentConversionRate*1.25)) ~> NewCurrencyColumn\nNewCurrencyColumn split(Country == 'USD',Country == 'CAD',disjoint: false) ~> ConditionalSplit1@(USD, CAD)\nConditionalSplit1@USD sink(saveMode:'overwrite' ) ~> USDSink\nConditionalSplit1@CAD sink(saveMode:'overwrite' ) ~> CADSink" + } + }, + "etag": "0a0068d4-0000-0000-0000-5b245bd30000" + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlows_Rename.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlows_Rename.json new file mode 100644 index 000000000000..e1db0a9d14be --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlows_Rename.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "dataFlowName": "exampleDataFlow", + "api-version": "2021-06-01-preview", + "request": { + "newName": "newdataflow" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlows_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlows_Update.json new file mode 100644 index 000000000000..dd98082fbeae --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlows_Update.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "dataFlowName": "exampleDataFlow", + "ifMatch": null, + "dataFlow": { + "properties": { + "description": "Sample demo data flow to convert currencies showing usage of union, derive and conditional split transformation.", + "type": "MappingDataFlow", + "typeProperties": { + "sources": [ + { + "dataset": { + "referenceName": "CurrencyDatasetUSD", + "type": "DatasetReference" + }, + "name": "USDCurrency" + }, + { + "dataset": { + "referenceName": "CurrencyDatasetCAD", + "type": "DatasetReference" + }, + "name": "CADSource" + } + ], + "sinks": [ + { + "dataset": { + "referenceName": "USDOutput", + "type": "DatasetReference" + }, + "name": "USDSink" + }, + { + "dataset": { + "referenceName": "CADOutput", + "type": "DatasetReference" + }, + "name": "CADSink" + } + ], + "script": "source(output(PreviousConversionRate as double,Country as string,DateTime1 as string,CurrentConversionRate as double),allowSchemaDrift: false,validateSchema: false) ~> USDCurrency\nsource(output(PreviousConversionRate as double,Country as string,DateTime1 as string,CurrentConversionRate as double),allowSchemaDrift: true,validateSchema: false) ~> CADSource\nUSDCurrency, CADSource union(byName: true)~> Union\nUnion derive(NewCurrencyRate = round(CurrentConversionRate*1.25)) ~> NewCurrencyColumn\nNewCurrencyColumn split(Country == 'USD',Country == 'CAD',disjoint: false) ~> ConditionalSplit1@(USD, CAD)\nConditionalSplit1@USD sink(saveMode:'overwrite' ) ~> USDSink\nConditionalSplit1@CAD sink(saveMode:'overwrite' ) ~> CADSink" + } + } + }, + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2019 00:37:38 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1193", + "x-ms-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0", + "x-ms-correlation-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0" + } + }, + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/datasets/exampleDataset", + "name": "exampleDataFlow", + "type": "Microsoft.Synapse/workspaces/dataflows", + "properties": { + "description": "Sample demo data flow to convert currencies showing usage of union, derive and conditional split transformation.", + "type": "MappingDataFlow", + "typeProperties": { + "sources": [ + { + "dataset": { + "referenceName": "CurrencyDatasetUSD", + "type": "DatasetReference" + }, + "name": "USDCurrency" + }, + { + "dataset": { + "referenceName": "CurrencyDatasetCAD", + "type": "DatasetReference" + }, + "name": "CADSource" + } + ], + "sinks": [ + { + "dataset": { + "referenceName": "USDOutput", + "type": "DatasetReference" + }, + "name": "USDSink" + }, + { + "dataset": { + "referenceName": "CADOutput", + "type": "DatasetReference" + }, + "name": "CADSink" + } + ], + "script": "source(output(PreviousConversionRate as double,Country as string,DateTime1 as string,CurrentConversionRate as double),allowSchemaDrift: false,validateSchema: false) ~> USDCurrency\nsource(output(PreviousConversionRate as double,Country as string,DateTime1 as string,CurrentConversionRate as double),allowSchemaDrift: true,validateSchema: false) ~> CADSource\nUSDCurrency, CADSource union(byName: true)~> Union\nUnion derive(NewCurrencyRate = round(CurrentConversionRate*1.25)) ~> NewCurrencyColumn\nNewCurrencyColumn split(Country == 'USD',Country == 'CAD',disjoint: false) ~> ConditionalSplit1@(USD, CAD)\nConditionalSplit1@USD sink(saveMode:'overwrite' ) ~> USDSink\nConditionalSplit1@CAD sink(saveMode:'overwrite' ) ~> CADSink" + } + }, + "etag": "0a0068d4-0000-0000-0000-5b245bd30002" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Datasets_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Datasets_Create.json new file mode 100644 index 000000000000..963338684e5e --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Datasets_Create.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "datasetName": "exampleDataset", + "ifMatch": null, + "dataset": { + "properties": { + "type": "AzureBlob", + "typeProperties": { + "folderPath": { + "value": "@dataset().MyFolderPath", + "type": "Expression" + }, + "fileName": { + "value": "@dataset().MyFileName", + "type": "Expression" + }, + "format": { + "type": "TextFormat" + } + }, + "linkedServiceName": { + "referenceName": "exampleLinkedService", + "type": "LinkedServiceReference" + }, + "parameters": { + "MyFolderPath": { + "type": "String" + }, + "MyFileName": { + "type": "String" + } + } + } + }, + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:38 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1194", + "x-ms-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0", + "x-ms-correlation-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0" + } + }, + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/datasets/exampleDataset", + "name": "exampleDataset", + "type": "Microsoft.Synapse/workspaces/datasets", + "properties": { + "type": "AzureBlob", + "schema": [ + { + "name": "col1", + "type": "INT_32" + }, + { + "name": "col2", + "type": "Decimal", + "precision": "38", + "scale": "2" + } + ], + "typeProperties": { + "folderPath": { + "value": "@dataset().MyFolderPath", + "type": "Expression" + }, + "fileName": { + "value": "@dataset().MyFileName", + "type": "Expression" + }, + "format": { + "type": "TextFormat" + } + }, + "linkedServiceName": { + "referenceName": "exampleLinkedService", + "type": "LinkedServiceReference" + }, + "parameters": { + "MyFolderPath": { + "type": "String" + }, + "MyFileName": { + "type": "String" + } + } + }, + "etag": "0a0066d4-0000-0000-0000-5b245bd20000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Datasets_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Datasets_Delete.json new file mode 100644 index 000000000000..66dbeca113e9 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Datasets_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "datasetName": "exampleDataset", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Datasets_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Datasets_Get.json new file mode 100644 index 000000000000..6f50857c7074 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Datasets_Get.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "datasetName": "exampleDataset", + "ifNoneMatch": "15004c4f-0000-0200-0000-5cbe090e0000", + "api-version": "2021-06-01-preview" + }, + "responses": { + "304": {}, + "200": { + "headers": { + "Date": "Mon, 22 Apr 2019 18:33:50 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "11993", + "x-ms-request-id": "48983fb5-612a-44c6-8158-add7ffebb32b", + "x-ms-correlation-request-id": "48983fb5-612a-44c6-8158-add7ffebb32b" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/datasets/exampleDataset", + "name": "exampleDataset", + "type": "Microsoft.Synapse/workspaces/datasets", + "properties": { + "type": "AzureBlob", + "typeProperties": { + "folderPath": { + "value": "@dataset().MyFolderPath", + "type": "Expression" + }, + "fileName": { + "value": "@dataset().MyFileName", + "type": "Expression" + }, + "format": { + "type": "TextFormat" + } + }, + "description": "Example description", + "linkedServiceName": { + "referenceName": "exampleLinkedService", + "type": "LinkedServiceReference" + }, + "parameters": { + "MyFolderPath": { + "type": "String" + }, + "MyFileName": { + "type": "String" + } + } + }, + "etag": "15004c4f-0000-0200-0000-5cbe090e0000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Datasets_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Datasets_ListByWorkspace.json new file mode 100644 index 000000000000..97786f5e2097 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Datasets_ListByWorkspace.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:40 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14992", + "x-ms-request-id": "341c9ece-5062-448b-be98-3ccbf476ed5d", + "x-ms-correlation-request-id": "341c9ece-5062-448b-be98-3ccbf476ed5d" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/datasets/exampleDataset", + "name": "exampleDataset", + "type": "Microsoft.Synapse/workspaces/datasets", + "properties": { + "type": "AzureBlob", + "typeProperties": { + "folderPath": { + "value": "@dataset().MyFolderPath", + "type": "Expression" + }, + "fileName": { + "value": "@dataset().MyFileName", + "type": "Expression" + }, + "format": { + "type": "TextFormat" + } + }, + "description": "Example description", + "linkedServiceName": { + "referenceName": "exampleLinkedService", + "type": "LinkedServiceReference" + }, + "parameters": { + "MyFolderPath": { + "type": "String" + }, + "MyFileName": { + "type": "String" + } + } + }, + "etag": "0a0068d4-0000-0000-0000-5b245bd30000" + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Datasets_Rename.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Datasets_Rename.json new file mode 100644 index 000000000000..69f2796533c1 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Datasets_Rename.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "datasetName": "exampleDataset", + "api-version": "2021-06-01-preview", + "request": { + "newName": "newdataset" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Datasets_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Datasets_Update.json new file mode 100644 index 000000000000..3319e50ed3cc --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Datasets_Update.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "datasetName": "exampleDataset", + "ifMatch": null, + "dataset": { + "properties": { + "type": "AzureBlob", + "typeProperties": { + "folderPath": { + "value": "@dataset().MyFolderPath", + "type": "Expression" + }, + "fileName": { + "value": "@dataset().MyFileName", + "type": "Expression" + }, + "format": { + "type": "TextFormat" + } + }, + "description": "Example description", + "linkedServiceName": { + "referenceName": "exampleLinkedService", + "type": "LinkedServiceReference" + }, + "parameters": { + "MyFolderPath": { + "type": "String" + }, + "MyFileName": { + "type": "String" + } + } + } + }, + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:39 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1193", + "x-ms-request-id": "e2e7f6be-e7ee-4aae-943f-6ff799e034f2", + "x-ms-correlation-request-id": "e2e7f6be-e7ee-4aae-943f-6ff799e034f2" + } + }, + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/datasets/exampleDataset", + "name": "exampleDataset", + "type": "Microsoft.Synapse/workspaces/datasets", + "properties": { + "type": "AzureBlob", + "typeProperties": { + "folderPath": { + "value": "@dataset().MyFolderPath", + "type": "Expression" + }, + "fileName": { + "value": "@dataset().MyFileName", + "type": "Expression" + }, + "format": { + "type": "TextFormat" + } + }, + "description": "Example description", + "linkedServiceName": { + "referenceName": "exampleLinkedService", + "type": "LinkedServiceReference" + }, + "parameters": { + "MyFolderPath": { + "type": "String" + }, + "MyFileName": { + "type": "String" + } + } + }, + "etag": "0a0068d4-0000-0000-0000-5b245bd30000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DeleteManagedPrivateEndpoint.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DeleteManagedPrivateEndpoint.json new file mode 100644 index 000000000000..9e4657b074de --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DeleteManagedPrivateEndpoint.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01", + "managedVirtualNetworkName": "default", + "managedPrivateEndpointName": "myPrivateEndpoint" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/GetManagedPrivateEndpoint.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/GetManagedPrivateEndpoint.json new file mode 100644 index 000000000000..53bd938a42ad --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/GetManagedPrivateEndpoint.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01", + "managedVirtualNetworkName": "default", + "managedPrivateEndpointName": "myPrivateEndpoint" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.Synapse/workspaces/managedVirtualNetworks/managedPrivateEndpoints", + "name": "myPrivateEndpoint", + "properties": { + "name": "myPrivateEndpoint", + "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Storage/accounts/myStorageAccount", + "groupId": "blob", + "provisioningState": "Succeeded", + "connectionState": { + "status": "Approved", + "description": "", + "actionsRequired": "" + }, + "fqdns": [ + "[hostname1].[domain].[tld]", + "[hostname2].[domain].[tld]" + ], + "isCompliant": true + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_Get.json new file mode 100644 index 000000000000..7c29982919bb --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "integrationRuntimeName": "IntegrationRuntime1", + "api-version": "2020-01-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Synapse/workspaces/exampleWorkspace/integrationruntimes/IntegrationRuntime1", + "name": "IntegrationRuntime1", + "type": "Microsoft.Synapse/workspaces/integrationruntimes", + "properties": { + "type": "Managed", + "typeProperties": { + "computeProperties": { + "location": "Australia Southeast", + "dataFlowProperties": { + "computeType": "General", + "coreCount": 8, + "timeToLive": 0 + } + } + } + }, + "etag": "00000000-0000-0000-0000-000000000000" + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_List.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_List.json new file mode 100644 index 000000000000..fa5eba85b2b2 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspace/integrationruntimes/exampleIntegrationRuntime", + "name": "exampleIntegrationRuntime", + "type": "Microsoft.Synapse/workspaces/integrationruntimes", + "properties": { + "type": "SelfHosted", + "description": "A selfhosted integration runtime" + }, + "etag": "0400f1a1-0000-0000-0000-5b2188640000" + } + ] + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/KqlScript_CreateOrUpdate.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/KqlScript_CreateOrUpdate.json new file mode 100644 index 000000000000..9e03ed896811 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/KqlScript_CreateOrUpdate.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "endpoint": "testWs.dev.azuresynapse.net", + "kqlScriptName": "testScript", + "api-version": "2021-06-01-preview", + "kqlScript": { + "id": "/subscriptions/99c6ec47-aacb-485c-863c-018be33b9000/resourceGroups/testResourceGroup/providers/Microsoft.Synapse/workspaces/testWs/kqlScripts/testScript", + "type": "Microsoft.Synapse/workspaces/kqlScripts", + "properties": { + "content": { + "query": "Logs | where TimeStamp > ago(1h) | take 10" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/99c6ec47-aacb-485c-863c-018be33b9000/resourceGroups/testResourceGroup/providers/Microsoft.Synapse/workspaces/testWs/kqlScripts/testScript", + "name": "testScript", + "type": "Microsoft.Synapse/workspaces/kqlScripts", + "properties": { + "content": { + "query": "Logs | where TimeStamp > ago(1h) | take 10" + } + } + } + }, + "202": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/KqlScript_DeleteByName.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/KqlScript_DeleteByName.json new file mode 100644 index 000000000000..6b7fd6b951ec --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/KqlScript_DeleteByName.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "endpoint": "testWs.dev.azuresynapse.net", + "kqlScriptName": "testScript", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/KqlScript_GetByName.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/KqlScript_GetByName.json new file mode 100644 index 000000000000..b61fa93ddd8e --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/KqlScript_GetByName.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "endpoint": "testWs.dev.azuresynapse.net", + "kqlScriptName": "testScript", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/99c6ec47-aacb-485c-863c-018be33b9000/resourceGroups/testResourceGroup/providers/Microsoft.Synapse/workspaces/testWs/kqlScripts/testScript", + "name": "testScript", + "type": "Microsoft.Synapse/workspaces/kqlScripts", + "properties": { + "content": { + "query": "Logs | where TimeStamp > ago(1h) | take 10" + } + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/KqlScript_Rename.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/KqlScript_Rename.json new file mode 100644 index 000000000000..8116a90ed7a0 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/KqlScript_Rename.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "endpoint": "testWs.dev.azuresynapse.net", + "kqlScriptName": "testScript", + "api-version": "2021-06-01-preview", + "renameRequest": { + "newName": "testScript2" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/KqlScripts_GetAll.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/KqlScripts_GetAll.json new file mode 100644 index 000000000000..875b03792c5c --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/KqlScripts_GetAll.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "endpoint": "testWs.dev.azuresynapse.net", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/99c6ec47-aacb-485c-863c-018be33b9000/resourceGroups/testResourceGroup/providers/Microsoft.Synapse/workspaces/testWs/kqlScripts/testScript", + "name": "testScript", + "type": "Microsoft.Synapse/workspaces/kqlScripts", + "properties": { + "content": { + "query": "Logs | where TimeStamp > ago(1h) | take 10" + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Library_Append.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Library_Append.json new file mode 100644 index 000000000000..f1c1de8c23e3 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Library_Append.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "libraryName": "exampleLibraryName.jar", + "comp": "appendblock", + "api-version": "2021-06-01-preview", + "content": "file binary chunk", + "x-ms-blob-condition-appendpos": 12324 + }, + "responses": { + "201": { + "headers": { + "Date": "Fri, 23 Oct 2020 08:28:16 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Library_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Library_Create.json new file mode 100644 index 000000000000..4f669e0dc664 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Library_Create.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "libraryName": "exampleLibraryName.jar", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Date": "Fri, 23 Oct 2020 08:28:16 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/libraries/exampleLibraryName.jar", + "recordId": 1234, + "state": "Creating", + "created": "2020-10-23T07:59:29.1573546+00:00", + "changed": "2020-10-23T07:59:29.1573546+00:00", + "type": "LibraryArtifact", + "name": "exampleLibraryName.jar", + "operationId": "1500474f-0000-0200-0000-5cbe090d0000", + "artifactId": "2222222e-222d-222f-2222-22a2f222d2f2" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Library_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Library_Delete.json new file mode 100644 index 000000000000..b7506dba2138 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Library_Delete.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "libraryName": "exampleLibraryName.jar", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Date": "Fri, 23 Oct 2020 08:28:16 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/libraries/exampleLibraryName.jar", + "recordId": 1234, + "state": "Creating", + "created": "2020-10-23T07:59:29.1573546+00:00", + "changed": "2020-10-23T07:59:29.1573546+00:00", + "type": "LibraryArtifact", + "name": "exampleLibraryName.jar", + "operationId": "1500474f-0000-0200-0000-5cbe090d0000", + "artifactId": "2222222e-222d-222f-2222-22a2f222d2f2" + } + }, + "409": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Library_Flush.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Library_Flush.json new file mode 100644 index 000000000000..4f669e0dc664 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Library_Flush.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "libraryName": "exampleLibraryName.jar", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Date": "Fri, 23 Oct 2020 08:28:16 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/libraries/exampleLibraryName.jar", + "recordId": 1234, + "state": "Creating", + "created": "2020-10-23T07:59:29.1573546+00:00", + "changed": "2020-10-23T07:59:29.1573546+00:00", + "type": "LibraryArtifact", + "name": "exampleLibraryName.jar", + "operationId": "1500474f-0000-0200-0000-5cbe090d0000", + "artifactId": "2222222e-222d-222f-2222-22a2f222d2f2" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Library_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Library_Get.json new file mode 100644 index 000000000000..1f4830b68af7 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Library_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "libraryName": "exampleLibraryName.jar", + "ifNoneMatch": "1500474f-0000-0200-0000-5cbe090d0000", + "api-version": "2021-06-01-preview" + }, + "responses": { + "304": {}, + "200": { + "headers": { + "Date": "Fri, 23 Oct 2020 08:28:16 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "11995", + "x-ms-request-id": "99e5d0d9-55e6-45a0-8bd2-cf39210f317c", + "x-ms-correlation-request-id": "99e5d0d9-55e6-45a0-8bd2-cf39210f317c" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/libraries/exampleLibraryName.jar", + "name": "exampleLibraryName.jar", + "type": "Microsoft.Synapse/workspaces/libraries", + "properties": { + "name": "exampleLibraryName.jar", + "path": "exampleWorkspace/libraries/exampleLibraryName.jar", + "containerName": "exampleContainer", + "type": "jar", + "uploadedTimestamp": "2020-10-23T07:59:29.1573546+00:00", + "provisioningStatus": "Succeeded", + "creatorId": "2222222e-222d-222f-2222-22a2f222d2f2" + }, + "etag": "1500474f-0000-0200-0000-5cbe090d0000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Library_GetOperationResult.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Library_GetOperationResult.json new file mode 100644 index 000000000000..36b2875254eb --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Library_GetOperationResult.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "operationId": "exampleOperationId", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Fri, 23 Oct 2020 08:28:16 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/libraries/exampleLibraryName.jar", + "name": "exampleLibraryName.jar", + "type": "Microsoft.Synapse/workspaces/libraries", + "properties": { + "name": "exampleLibraryName.jar", + "path": "exampleWorkspace/libraries/exampleLibraryName.jar", + "containerName": "exampleContainer", + "type": "jar", + "uploadedTimestamp": "2020-10-23T07:59:29.1573546+00:00", + "provisioningStatus": "Succeeded", + "creatorId": "2222222e-222d-222f-2222-22a2f222d2f2" + }, + "etag": "1500474f-0000-0200-0000-5cbe090d0000" + } + }, + "202": { + "headers": { + "Date": "Fri, 23 Oct 2020 08:28:16 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "status": "InProgress" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Library_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Library_ListByWorkspace.json new file mode 100644 index 000000000000..849cf46d67ee --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Library_ListByWorkspace.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:36 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14994", + "x-ms-request-id": "558d0fd8-dc1f-44b6-9ca9-59fcca8af9a5", + "x-ms-correlation-request-id": "558d0fd8-dc1f-44b6-9ca9-59fcca8af9a5" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/libraries/exampleLibraryName.jar", + "name": "exampleLibraryName.jar", + "type": "Microsoft.Synapse/workspaces/libraries", + "properties": { + "name": "exampleLibraryName.jar", + "path": "exampleWorkspace/libraries/exampleLibraryName.jar", + "containerName": "exampleContainer", + "type": "jar", + "uploadedTimestamp": "2020-10-23T07:59:29.1573546+00:00", + "provisioningStatus": "Succeeded", + "creatorId": "2222222e-222d-222f-2222-22a2f222d2f2" + }, + "etag": "1500474f-0000-0200-0000-5cbe090d0000" + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/LinkedServices_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/LinkedServices_Create.json new file mode 100644 index 000000000000..341b715cf885 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/LinkedServices_Create.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "linkedServiceName": "exampleLinkedService", + "ifMatch": null, + "linkedService": { + "properties": { + "type": "AzureStorage", + "typeProperties": { + "connectionString": { + "type": "SecureString", + "value": "DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=" + } + } + } + }, + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:34 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1196", + "x-ms-request-id": "b3b336b3-b203-4654-9cb6-a3a8d3a4b5de", + "x-ms-correlation-request-id": "b3b336b3-b203-4654-9cb6-a3a8d3a4b5de" + } + }, + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/linkedservices/exampleLinkedService", + "name": "exampleLinkedService", + "type": "Microsoft.Synapse/workspaces/linkedservices", + "properties": { + "type": "AzureStorage", + "typeProperties": { + "connectionString": { + "type": "SecureString", + "value": "**********" + }, + "encryptedCredential": "ew0KICAiVmVyc2lvbiI6ICIyMDE3LTExLTMwIiwNCiAgIlByb3RlY3Rpb25Nb2RlIjogIktleSIsDQogICJTZWNyZXRDb250ZW50VHlwZSI6ICJQbGFpbnRleHQiLA0KICAiQ3JlZGVudGlhbElkIjogIkRGLURPR0ZPT0QtWUFOWkhBTkctV1VfM2FiMTk0NjYtNWUxNi00NzU1LWJlNzktMjI2ZTVmZWU3YzY0Ig0KfQ==" + } + }, + "etag": "0a0062d4-0000-0000-0000-5b245bcf0000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/LinkedServices_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/LinkedServices_Delete.json new file mode 100644 index 000000000000..7a60b107cc8a --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/LinkedServices_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "linkedServiceName": "exampleLinkedService", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/LinkedServices_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/LinkedServices_Get.json new file mode 100644 index 000000000000..9e52d2eab6b4 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/LinkedServices_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "linkedServiceName": "exampleLinkedService", + "ifNoneMatch": "1500474f-0000-0200-0000-5cbe090d0000", + "api-version": "2021-06-01-preview" + }, + "responses": { + "304": {}, + "200": { + "headers": { + "Date": "Mon, 22 Apr 2019 18:33:48 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "11995", + "x-ms-request-id": "99e5d0d9-55e6-45a0-8bd2-cf39210f317c", + "x-ms-correlation-request-id": "99e5d0d9-55e6-45a0-8bd2-cf39210f317c" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/linkedservices/exampleLinkedService", + "name": "exampleLinkedService", + "type": "Microsoft.Synapse/workspaces/linkedservices", + "properties": { + "type": "AzureStorage", + "typeProperties": { + "connectionString": { + "type": "SecureString", + "value": "**********" + }, + "encryptedCredential": "ew0KICAiVmVyc2lvbiI6ICIyMDE3LTExLTMwIiwNCiAgIlByb3RlY3Rpb25Nb2RlIjogIktleSIsDQogICJTZWNyZXRDb250ZW50VHlwZSI6ICJQbGFpbnRleHQiLA0KICAiQ3JlZGVudGlhbElkIjogIkhWVEVTVEVYQU1QTEVTXzg5MjU1NGY0LTViNGItNDFhOS1hYWYxLTg4ZWI5ZDBjOWIzMyINCn0=" + }, + "description": "Example description" + }, + "etag": "1500474f-0000-0200-0000-5cbe090d0000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/LinkedServices_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/LinkedServices_ListByWorkspace.json new file mode 100644 index 000000000000..1ac5b0eb0a59 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/LinkedServices_ListByWorkspace.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:36 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14994", + "x-ms-request-id": "558d0fd8-dc1f-44b6-9ca9-59fcca8af9a5", + "x-ms-correlation-request-id": "558d0fd8-dc1f-44b6-9ca9-59fcca8af9a5" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/linkedservices/exampleLinkedService", + "name": "exampleLinkedService", + "type": "Microsoft.Synapse/workspaces/linkedservices", + "properties": { + "type": "AzureStorage", + "typeProperties": { + "connectionString": { + "type": "SecureString", + "value": "**********" + }, + "encryptedCredential": "ew0KICAiVmVyc2lvbiI6ICIyMDE3LTExLTMwIiwNCiAgIlByb3RlY3Rpb25Nb2RlIjogIktleSIsDQogICJTZWNyZXRDb250ZW50VHlwZSI6ICJQbGFpbnRleHQiLA0KICAiQ3JlZGVudGlhbElkIjogIkRGLURPR0ZPT0QtWUFOWkhBTkctV1VfMGI2M2EyMmYtMGEzNC00NDg2LWIzMDktNzM0NTlkODUyY2Q1Ig0KfQ==" + }, + "description": "Example description" + }, + "etag": "0a0064d4-0000-0000-0000-5b245bd00000" + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/LinkedServices_Rename.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/LinkedServices_Rename.json new file mode 100644 index 000000000000..a60162c13f03 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/LinkedServices_Rename.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "linkedServiceName": "exampleLinkedService", + "api-version": "2021-06-01-preview", + "request": { + "newName": "newLinkedService" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/LinkedServices_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/LinkedServices_Update.json new file mode 100644 index 000000000000..1c28d1ea154b --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/LinkedServices_Update.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "linkedServiceName": "exampleLinkedService", + "ifMatch": null, + "linkedService": { + "properties": { + "type": "AzureStorage", + "typeProperties": { + "connectionString": { + "type": "SecureString", + "value": "DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=" + } + }, + "description": "Example description" + } + }, + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:36 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1195", + "x-ms-request-id": "53ad9761-ecdf-43ed-916f-878a5fb92cb0", + "x-ms-correlation-request-id": "53ad9761-ecdf-43ed-916f-878a5fb92cb0" + } + }, + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/linkedservices/exampleLinkedService", + "name": "exampleLinkedService", + "type": "Microsoft.Synapse/workspaces/linkedservices", + "properties": { + "type": "AzureStorage", + "typeProperties": { + "connectionString": { + "type": "SecureString", + "value": "**********" + }, + "encryptedCredential": "ew0KICAiVmVyc2lvbiI6ICIyMDE3LTExLTMwIiwNCiAgIlByb3RlY3Rpb25Nb2RlIjogIktleSIsDQogICJTZWNyZXRDb250ZW50VHlwZSI6ICJQbGFpbnRleHQiLA0KICAiQ3JlZGVudGlhbElkIjogIkRGLURPR0ZPT0QtWUFOWkhBTkctV1VfMGI2M2EyMmYtMGEzNC00NDg2LWIzMDktNzM0NTlkODUyY2Q1Ig0KfQ==" + }, + "description": "Example description" + }, + "etag": "0a0064d4-0000-0000-0000-5b245bd00000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/ListManagedPrivateEndpoints.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/ListManagedPrivateEndpoints.json new file mode 100644 index 000000000000..c33c6bd8a4b0 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/ListManagedPrivateEndpoints.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01", + "managedVirtualNetworkName": "default" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.Synapse/workspaces/managedVirtualNetworks/managedPrivateEndpoints", + "name": "myPrivateEndpoint1", + "properties": { + "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Storage/accounts/myStorageAccount1", + "groupId": "blob", + "provisioningState": "Succeeded", + "connectionState": { + "status": "Approved", + "description": "", + "actionsRequired": "" + } + } + }, + { + "type": "Microsoft.Synapse/workspaces/managedVirtualNetworks/managedPrivateEndpoints", + "name": "myPrivateEndpoint2", + "properties": { + "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Storage/accounts/myStorageAccount2", + "groupId": "blob", + "provisioningState": "Succeeded", + "connectionState": { + "status": "Pending", + "description": "", + "actionsRequired": "" + } + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/NotebookOperationResult_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/NotebookOperationResult_Get.json new file mode 100644 index 000000000000..0002d5652a26 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/NotebookOperationResult_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "operationId": "01234567-89ab-4def-0123-456789abcdef", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "201": {}, + "202": {}, + "204": {}, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Notebooks_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Notebooks_Create.json new file mode 100644 index 000000000000..ce29f013f422 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Notebooks_Create.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "notebookName": "exampleNotebook", + "ifMatch": null, + "Notebook": { + "name": "exampleNotebook", + "properties": { + "description": "A sample Notebook", + "nbformat": 4, + "nbformat_minor": 2, + "bigDataPool": { + "referenceName": "exampleBigDataPoolName", + "type": "BigDataPoolReference" + }, + "sessionProperties": { + "driverMemory": "28g", + "driverCores": 4, + "executorMemory": "28g", + "executorCores": 4, + "numExecutors": 1 + }, + "metadata": { + "language_info": { + "name": "python" + }, + "kernelspec": { + "name": "exampleName", + "display_name": "exampleDisplayName" + } + }, + "cells": [ + { + "cell_type": "code", + "metadata": {}, + "source": [ + "def my_function():\n", + " print(\"Hello from a function\")\n", + "\n", + "my_function()" + ], + "attachments": {}, + "outputs": [ + { + "execution_count": 3, + "output_type": "execute_result", + "data": { + "text/plain": "Hello from a function" + }, + "metadata": {} + } + ] + } + ] + } + }, + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:41 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + } + }, + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/Notebooks/exampleNotebook", + "name": "exampleNotebook", + "type": "Microsoft.Synapse/workspaces/Notebooks", + "properties": { + "description": "A sample Notebook", + "nbformat": 4, + "nbformat_minor": 2, + "bigDataPool": { + "referenceName": "exampleBigDataPoolName", + "type": "BigDataPoolReference" + }, + "sessionProperties": { + "driverMemory": "28g", + "driverCores": 4, + "executorMemory": "28g", + "executorCores": 4, + "numExecutors": 1 + }, + "metadata": { + "language_info": { + "name": "python" + }, + "kernelspec": { + "name": "exampleName", + "display_name": "exampleDisplayName" + } + }, + "cells": [ + { + "cell_type": "code", + "metadata": {}, + "source": [ + "def my_function():\n", + " print(\"Hello from a function\")\n", + "\n", + "my_function()" + ], + "attachments": {}, + "outputs": [ + { + "execution_count": 3, + "output_type": "execute_result", + "data": { + "text/plain": "Hello from a function" + }, + "metadata": {} + } + ] + } + ] + }, + "etag": "0a0069d4-0000-0000-0000-5b245bd50000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Notebooks_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Notebooks_Delete.json new file mode 100644 index 000000000000..ff9fb3d1f36d --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Notebooks_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "notebookName": "exampleNotebook", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Notebooks_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Notebooks_Get.json new file mode 100644 index 000000000000..030446e26746 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Notebooks_Get.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "notebookName": "exampleNotebook", + "ifNoneMatch": "1500504f-0000-0200-0000-5cbe090f0000", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:41 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/notebooks/exampleNotebook", + "name": "exampleNotebook", + "type": "Microsoft.Synapse/workspaces/Notebooks", + "properties": { + "description": "A sample Notebook", + "nbformat": 4, + "nbformat_minor": 2, + "bigDataPool": { + "referenceName": "exampleBigDataPoolName", + "type": "BigDataPoolReference" + }, + "sessionProperties": { + "driverMemory": "28g", + "driverCores": 4, + "executorMemory": "28g", + "executorCores": 4, + "numExecutors": 1 + }, + "metadata": { + "language_info": { + "name": "python" + }, + "kernelspec": { + "name": "exampleName", + "display_name": "exampleDisplayName" + } + }, + "cells": [ + { + "cell_type": "code", + "metadata": {}, + "source": [ + "def my_function():\n", + " print(\"Hello from a function\")\n", + "\n", + "my_function()" + ], + "attachments": {}, + "outputs": [ + { + "execution_count": 3, + "output_type": "execute_result", + "data": { + "text/plain": "Hello from a function" + }, + "metadata": {} + } + ] + } + ] + }, + "etag": "1500504f-0000-0200-0000-5cbe090f0000" + } + }, + "304": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Notebooks_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Notebooks_ListByWorkspace.json new file mode 100644 index 000000000000..2b08422011a4 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Notebooks_ListByWorkspace.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:41 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/notebooks/exampleNotebook", + "name": "exampleNotebook", + "type": "Microsoft.Synapse/workspaces/Notebooks", + "properties": { + "description": "A sample Notebook", + "nbformat": 4, + "nbformat_minor": 2, + "bigDataPool": { + "referenceName": "exampleBigDataPoolName", + "type": "BigDataPoolReference" + }, + "sessionProperties": { + "driverMemory": "28g", + "driverCores": 4, + "executorMemory": "28g", + "executorCores": 4, + "numExecutors": 1 + }, + "metadata": { + "language_info": { + "name": "python" + }, + "kernelspec": { + "name": "exampleName", + "display_name": "exampleDisplayName" + } + }, + "cells": [ + { + "cell_type": "code", + "metadata": {}, + "source": [ + "def my_function():\n", + " print(\"Hello from a function\")\n", + "\n", + "my_function()" + ], + "attachments": {}, + "outputs": [ + { + "execution_count": 3, + "output_type": "execute_result", + "data": { + "text/plain": "Hello from a function" + }, + "metadata": {} + } + ] + } + ] + }, + "etag": "1500504f-0000-0200-0000-5cbe090f0000" + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Notebooks_ListSummaryByWorkSpace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Notebooks_ListSummaryByWorkSpace.json new file mode 100644 index 000000000000..2b08422011a4 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Notebooks_ListSummaryByWorkSpace.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:41 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/notebooks/exampleNotebook", + "name": "exampleNotebook", + "type": "Microsoft.Synapse/workspaces/Notebooks", + "properties": { + "description": "A sample Notebook", + "nbformat": 4, + "nbformat_minor": 2, + "bigDataPool": { + "referenceName": "exampleBigDataPoolName", + "type": "BigDataPoolReference" + }, + "sessionProperties": { + "driverMemory": "28g", + "driverCores": 4, + "executorMemory": "28g", + "executorCores": 4, + "numExecutors": 1 + }, + "metadata": { + "language_info": { + "name": "python" + }, + "kernelspec": { + "name": "exampleName", + "display_name": "exampleDisplayName" + } + }, + "cells": [ + { + "cell_type": "code", + "metadata": {}, + "source": [ + "def my_function():\n", + " print(\"Hello from a function\")\n", + "\n", + "my_function()" + ], + "attachments": {}, + "outputs": [ + { + "execution_count": 3, + "output_type": "execute_result", + "data": { + "text/plain": "Hello from a function" + }, + "metadata": {} + } + ] + } + ] + }, + "etag": "1500504f-0000-0200-0000-5cbe090f0000" + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Notebooks_Rename.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Notebooks_Rename.json new file mode 100644 index 000000000000..bc873f4c7094 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Notebooks_Rename.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "notebookName": "exampleNotebook", + "api-version": "2021-06-01-preview", + "request": { + "newName": "newNotebook" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Notebooks_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Notebooks_Update.json new file mode 100644 index 000000000000..e8f945caa2d8 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Notebooks_Update.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "notebookName": "exampleNotebook", + "ifMatch": null, + "Notebook": { + "name": "exampleNotebook", + "properties": { + "description": "Modified description", + "nbformat": 4, + "nbformat_minor": 2, + "bigDataPool": { + "referenceName": "exampleBigDataPoolName", + "type": "BigDataPoolReference" + }, + "sessionProperties": { + "driverMemory": "28g", + "driverCores": 4, + "executorMemory": "28g", + "executorCores": 4, + "numExecutors": 1 + }, + "metadata": { + "language_info": { + "name": "python" + }, + "kernelspec": { + "name": "exampleName", + "display_name": "exampleDisplayName" + } + }, + "cells": [ + { + "cell_type": "code", + "metadata": {}, + "source": [ + "def my_function():\n", + " print(\"Hello from a function\")\n", + "\n", + "my_function()" + ], + "attachments": {}, + "outputs": [ + { + "execution_count": 3, + "output_type": "execute_result", + "data": { + "text/plain": "Hello from a function" + }, + "metadata": {} + } + ] + } + ] + } + }, + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:41 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + } + }, + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/notebooks/exampleNotebook", + "name": "exampleNotebook", + "type": "Microsoft.Synapse/workspaces/Notebooks", + "properties": { + "description": "Modified description", + "nbformat": 4, + "nbformat_minor": 2, + "bigDataPool": { + "referenceName": "exampleBigDataPoolName", + "type": "BigDataPoolReference" + }, + "sessionProperties": { + "driverMemory": "28g", + "driverCores": 4, + "executorMemory": "28g", + "executorCores": 4, + "numExecutors": 1 + }, + "metadata": { + "language_info": { + "name": "python" + }, + "kernelspec": { + "name": "exampleName", + "display_name": "exampleDisplayName" + } + }, + "cells": [ + { + "cell_type": "code", + "metadata": {}, + "source": [ + "def my_function():\n", + " print(\"Hello from a function\")\n", + "\n", + "my_function()" + ], + "attachments": {}, + "outputs": [ + { + "execution_count": 3, + "output_type": "execute_result", + "data": { + "text/plain": "Hello from a function" + }, + "metadata": {} + } + ] + } + ] + }, + "etag": "0a006cd4-0000-0000-0000-5b245bd60000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/OperationResult_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/OperationResult_Get.json new file mode 100644 index 000000000000..0002d5652a26 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/OperationResult_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "operationId": "01234567-89ab-4def-0123-456789abcdef", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "201": {}, + "202": {}, + "204": {}, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/OperationStatus_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/OperationStatus_Get.json new file mode 100644 index 000000000000..0002d5652a26 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/OperationStatus_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "operationId": "01234567-89ab-4def-0123-456789abcdef", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "201": {}, + "202": {}, + "204": {}, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/PipelineRuns_Cancel.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/PipelineRuns_Cancel.json new file mode 100644 index 000000000000..e1172fe38b15 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/PipelineRuns_Cancel.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "runId": "16ac5348-ff82-4f95-a80d-638c1d47b721", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/PipelineRuns_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/PipelineRuns_Get.json new file mode 100644 index 000000000000..59b9b12dfa8e --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/PipelineRuns_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:02 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14988", + "x-ms-request-id": "6d9de9bd-a412-4a6f-8b9e-37d369323646", + "x-ms-correlation-request-id": "6d9de9bd-a412-4a6f-8b9e-37d369323646" + }, + "body": { + "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b", + "pipelineName": "examplePipeline", + "parameters": { + "OutputBlobNameList": "[\"exampleoutput.csv\"]" + }, + "invokedBy": { + "id": "80a01654a9d34ad18b3fcac5d5d76b67", + "name": "Manual" + }, + "runStart": "2018-06-16T00:37:44.6257014Z", + "runEnd": "2018-06-16T00:38:12.7314495Z", + "durationInMs": 28105, + "status": "Succeeded", + "message": "", + "lastUpdated": "2018-06-16T00:38:12.7314495Z", + "annotations": [] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/PipelineRuns_QueryByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/PipelineRuns_QueryByWorkspace.json new file mode 100644 index 000000000000..9a1fb10b2adc --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/PipelineRuns_QueryByWorkspace.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "filterParameters": { + "lastUpdatedAfter": "2018-06-16T00:36:44.3345758Z", + "lastUpdatedBefore": "2018-06-16T00:49:48.3686473Z", + "filters": [ + { + "operand": "PipelineName", + "operator": "Equals", + "values": [ + "examplePipeline" + ] + } + ] + }, + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:01 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14989", + "x-ms-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd", + "x-ms-correlation-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd" + }, + "body": { + "value": [ + { + "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b", + "pipelineName": "examplePipeline", + "parameters": { + "OutputBlobNameList": "[\"exampleoutput.csv\"]" + }, + "invokedBy": { + "id": "80a01654a9d34ad18b3fcac5d5d76b67", + "name": "Manual" + }, + "runStart": "2018-06-16T00:37:44.6257014Z", + "runEnd": "2018-06-16T00:38:12.7314495Z", + "durationInMs": 28105, + "status": "Succeeded", + "message": "", + "lastUpdated": "2018-06-16T00:38:12.7314495Z", + "annotations": [], + "runDimension": { + "JobId": "79c1cc52-265f-41a5-9553-be65e736fbd3" + } + }, + { + "runId": "16ac5348-ff82-4f95-a80d-638c1d47b721", + "pipelineName": "examplePipeline", + "parameters": { + "OutputBlobNameList": "[\"exampleoutput.csv\"]" + }, + "invokedBy": { + "id": "7c5fd7ef7e8a464b98b931cf15fcac66", + "name": "Manual" + }, + "runStart": "2018-06-16T00:39:49.2745128Z", + "runEnd": null, + "durationInMs": null, + "status": "Cancelled", + "message": "", + "lastUpdated": "2018-06-16T00:39:51.216097Z", + "annotations": [], + "runDimension": { + "JobId": "84a3c493-0628-4b44-852f-ef5b3a11bdab" + } + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Pipelines_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Pipelines_Create.json new file mode 100644 index 000000000000..3ffd19672f25 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Pipelines_Create.json @@ -0,0 +1,173 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "pipelineName": "examplePipeline", + "ifMatch": null, + "pipeline": { + "properties": { + "activities": [ + { + "type": "ForEach", + "typeProperties": { + "isSequential": true, + "items": { + "value": "@pipeline().parameters.OutputBlobNameList", + "type": "Expression" + }, + "activities": [ + { + "type": "Copy", + "typeProperties": { + "source": { + "type": "BlobSource" + }, + "sink": { + "type": "BlobSink" + }, + "dataIntegrationUnits": 32 + }, + "inputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": "examplecontainer.csv" + }, + "type": "DatasetReference" + } + ], + "outputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": { + "value": "@item()", + "type": "Expression" + } + }, + "type": "DatasetReference" + } + ], + "name": "ExampleCopyActivity" + } + ] + }, + "name": "ExampleForeachActivity" + } + ], + "parameters": { + "OutputBlobNameList": { + "type": "Array" + }, + "JobId": { + "type": "String" + } + }, + "variables": { + "TestVariableArray": { + "type": "Array" + } + }, + "runDimensions": { + "JobId": { + "value": "@pipeline().parameters.JobId", + "type": "Expression" + } + } + } + }, + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:41 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + } + }, + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/pipelines/examplePipeline", + "name": "examplePipeline", + "type": "Microsoft.Synapse/workspaces/pipelines", + "properties": { + "activities": [ + { + "type": "ForEach", + "typeProperties": { + "isSequential": true, + "items": { + "value": "@pipeline().parameters.OutputBlobNameList", + "type": "Expression" + }, + "activities": [ + { + "type": "Copy", + "typeProperties": { + "source": { + "type": "BlobSource" + }, + "sink": { + "type": "BlobSink" + }, + "dataIntegrationUnits": 32 + }, + "inputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": "examplecontainer.csv" + }, + "type": "DatasetReference" + } + ], + "outputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": { + "value": "@item()", + "type": "Expression" + } + }, + "type": "DatasetReference" + } + ], + "name": "ExampleCopyActivity" + } + ] + }, + "name": "ExampleForeachActivity" + } + ], + "parameters": { + "OutputBlobNameList": { + "type": "Array" + }, + "JobId": { + "type": "String" + } + }, + "variables": { + "TestVariableArray": { + "type": "Array" + } + }, + "runDimensions": { + "JobId": { + "value": "@pipeline().parameters.JobId", + "type": "Expression" + } + } + }, + "etag": "0a0069d4-0000-0000-0000-5b245bd50000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Pipelines_CreateRun.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Pipelines_CreateRun.json new file mode 100644 index 000000000000..1cc5643e83eb --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Pipelines_CreateRun.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "pipelineName": "examplePipeline", + "referencePipelineRunId": null, + "parameters": { + "OutputBlobNameList": [ + "exampleoutput.csv" + ] + }, + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:48 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1190", + "x-ms-request-id": "5c2b442b-d360-43ec-9268-f923f88f31fd", + "x-ms-correlation-request-id": "5c2b442b-d360-43ec-9268-f923f88f31fd" + }, + "body": { + "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Pipelines_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Pipelines_Delete.json new file mode 100644 index 000000000000..139c17f665b5 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Pipelines_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "pipelineName": "examplePipeline", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Pipelines_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Pipelines_Get.json new file mode 100644 index 000000000000..62f2a48b19ee --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Pipelines_Get.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "pipelineName": "examplePipeline", + "ifNoneMatch": "1500504f-0000-0200-0000-5cbe090f0000", + "api-version": "2021-06-01-preview" + }, + "responses": { + "304": {}, + "200": { + "headers": { + "Date": "Mon, 22 Apr 2019 18:33:51 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "11991", + "x-ms-request-id": "f3865c61-4888-4b91-a617-9a985d9dd0fd", + "x-ms-correlation-request-id": "f3865c61-4888-4b91-a617-9a985d9dd0fd" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/pipelines/examplePipeline", + "name": "examplePipeline", + "type": "Microsoft.Synapse/workspaces/pipelines", + "properties": { + "description": "Example description", + "activities": [ + { + "type": "ForEach", + "typeProperties": { + "isSequential": true, + "items": { + "value": "@pipeline().parameters.OutputBlobNameList", + "type": "Expression" + }, + "activities": [ + { + "type": "Copy", + "typeProperties": { + "source": { + "type": "BlobSource" + }, + "sink": { + "type": "BlobSink" + }, + "dataIntegrationUnits": 32 + }, + "inputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": "examplecontainer.csv" + }, + "type": "DatasetReference" + } + ], + "outputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": { + "value": "@item()", + "type": "Expression" + } + }, + "type": "DatasetReference" + } + ], + "name": "ExampleCopyActivity" + } + ] + }, + "name": "ExampleForeachActivity" + } + ], + "parameters": { + "OutputBlobNameList": { + "type": "Array" + } + }, + "variables": { + "TestVariableArray": { + "type": "Array" + } + } + }, + "etag": "1500504f-0000-0200-0000-5cbe090f0000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Pipelines_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Pipelines_ListByWorkspace.json new file mode 100644 index 000000000000..9fdf46198bad --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Pipelines_ListByWorkspace.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:43 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14990", + "x-ms-request-id": "92292250-c10f-4c47-8eb6-b886b361add7", + "x-ms-correlation-request-id": "92292250-c10f-4c47-8eb6-b886b361add7" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/pipelines/examplePipeline", + "name": "examplePipeline", + "type": "Microsoft.Synapse/workspaces/pipelines", + "properties": { + "description": "Example description", + "activities": [ + { + "type": "ForEach", + "typeProperties": { + "isSequential": true, + "items": { + "value": "@pipeline().parameters.OutputBlobNameList", + "type": "Expression" + }, + "activities": [ + { + "type": "Copy", + "typeProperties": { + "source": { + "type": "BlobSource" + }, + "sink": { + "type": "BlobSink" + }, + "dataIntegrationUnits": 32 + }, + "inputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": "examplecontainer.csv" + }, + "type": "DatasetReference" + } + ], + "outputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": { + "value": "@item()", + "type": "Expression" + } + }, + "type": "DatasetReference" + } + ], + "name": "ExampleCopyActivity" + } + ] + }, + "name": "ExampleForeachActivity" + } + ], + "parameters": { + "OutputBlobNameList": { + "type": "Array" + } + } + }, + "etag": "0a006cd4-0000-0000-0000-5b245bd60000" + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Pipelines_Rename.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Pipelines_Rename.json new file mode 100644 index 000000000000..27afefc9408f --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Pipelines_Rename.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "pipelineName": "examplePipeline", + "api-version": "2021-06-01-preview", + "request": { + "newName": "newPipeline" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Pipelines_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Pipelines_Update.json new file mode 100644 index 000000000000..b66c3bbea8f5 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Pipelines_Update.json @@ -0,0 +1,147 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "pipelineName": "examplePipeline", + "ifMatch": null, + "pipeline": { + "properties": { + "description": "Example description", + "activities": [ + { + "type": "ForEach", + "typeProperties": { + "isSequential": true, + "items": { + "value": "@pipeline().parameters.OutputBlobNameList", + "type": "Expression" + }, + "activities": [ + { + "type": "Copy", + "typeProperties": { + "source": { + "type": "BlobSource" + }, + "sink": { + "type": "BlobSink" + }, + "dataIntegrationUnits": 32 + }, + "inputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": "examplecontainer.csv" + }, + "type": "DatasetReference" + } + ], + "outputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": { + "value": "@item()", + "type": "Expression" + } + }, + "type": "DatasetReference" + } + ], + "name": "ExampleCopyActivity" + } + ] + }, + "name": "ExampleForeachActivity" + } + ], + "parameters": { + "OutputBlobNameList": { + "type": "Array" + } + } + } + }, + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:43 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1191", + "x-ms-request-id": "91a763b0-d944-493f-83fc-e989c8b6e122", + "x-ms-correlation-request-id": "91a763b0-d944-493f-83fc-e989c8b6e122" + } + }, + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/pipelines/examplePipeline", + "name": "examplePipeline", + "type": "Microsoft.Synapse/workspaces/pipelines", + "properties": { + "description": "Example description", + "activities": [ + { + "type": "ForEach", + "typeProperties": { + "isSequential": true, + "items": { + "value": "@pipeline().parameters.OutputBlobNameList", + "type": "Expression" + }, + "activities": [ + { + "type": "Copy", + "typeProperties": { + "source": { + "type": "BlobSource" + }, + "sink": { + "type": "BlobSink" + }, + "dataIntegrationUnits": 32 + }, + "inputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": "examplecontainer.csv" + }, + "type": "DatasetReference" + } + ], + "outputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": { + "value": "@item()", + "type": "Expression" + } + }, + "type": "DatasetReference" + } + ], + "name": "ExampleCopyActivity" + } + ] + }, + "name": "ExampleForeachActivity" + } + ], + "parameters": { + "OutputBlobNameList": { + "type": "Array" + } + } + }, + "etag": "0a006cd4-0000-0000-0000-5b245bd60000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkConfigurations_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkConfigurations_Create.json new file mode 100644 index 000000000000..c3441bcfdfc2 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkConfigurations_Create.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sparkConfigurationName": "exampleSparkConfiguration", + "ifMatch": null, + "sparkConfiguration": { + "properties": { + "description": "A sample spark Configuration", + "configs": { + "test1": "test1value", + "test2": "test2value" + }, + "annotations": [ + "testAnnotation1", + "testAnnotation2" + ], + "notes": "testNotes" + } + }, + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2019 00:37:38 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1194", + "x-ms-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0", + "x-ms-correlation-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0" + } + }, + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:41 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/sparkconfigurations/exampleSparkConfiguration", + "name": "exampleSparkConfiguration", + "type": "Microsoft.Synapse/workspaces/sparkconfigurations", + "properties": { + "description": "A sample spark configuration", + "configs": { + "test1": "test1value", + "test2": "test2value" + }, + "annotations": [ + "testAnnotation1", + "testAnnotation2" + ], + "notes": "testNotes", + "createdBy": "test@microsoft.com", + "created": "1970-01-01T00:00:00Z" + }, + "etag": "0a0069d4-0000-0000-0000-5b245bd50000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkConfigurations_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkConfigurations_Delete.json new file mode 100644 index 000000000000..f79874cc31fb --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkConfigurations_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sparkConfigurationName": "exampleSparkConfiguration", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkConfigurations_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkConfigurations_Get.json new file mode 100644 index 000000000000..cb90157686dd --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkConfigurations_Get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sparkConfigurationName": "exampleSparkConfiguration", + "ifNoneMatch": "1500504f-0000-0200-0000-5cbe090f0000", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:41 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/sparkconfigurations/exampleSparkConfiguration", + "name": "exampleSparkConfiguration", + "type": "Microsoft.Synapse/workspaces/sparkconfigurations", + "properties": { + "description": "A sample spark configuration", + "configs": { + "test1": "test1value", + "test2": "test2value" + }, + "annotations": [ + "testAnnotation1", + "testAnnotation2" + ], + "notes": "testNotes", + "createdBy": "test@microsoft.com", + "created": "1970-01-01T00:00:00Z" + }, + "etag": "1500504f-0000-0200-0000-5cbe090f0000" + } + }, + "304": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkConfigurations_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkConfigurations_ListByWorkspace.json new file mode 100644 index 000000000000..4bfacd5078b1 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkConfigurations_ListByWorkspace.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:43 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14990", + "x-ms-request-id": "92292250-c10f-4c47-8eb6-b886b361add7", + "x-ms-correlation-request-id": "92292250-c10f-4c47-8eb6-b886b361add7" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/sparkconfigurations/exampleSparkConfiguration", + "name": "exampleSparkConfiguration", + "type": "Microsoft.Synapse/workspaces/sparkconfigurations", + "properties": { + "description": "A sample spark configuration", + "configs": { + "test1": "test1value", + "test2": "test2value" + }, + "annotations": [ + "testAnnotation1", + "testAnnotation2" + ], + "notes": "testNotes", + "createdBy": "test@microsoft.com", + "created": "1970-01-01T00:00:00Z" + }, + "etag": "1500504f-0000-0200-0000-5cbe090f0000" + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkConfigurations_Rename.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkConfigurations_Rename.json new file mode 100644 index 000000000000..e8b6fbc1a157 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkConfigurations_Rename.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sparkConfigurationName": "exampleSparkConfiguration", + "api-version": "2021-06-01-preview", + "request": { + "newName": "newSparkConfiguration" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkConfigurations_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkConfigurations_Update.json new file mode 100644 index 000000000000..27608fea49da --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkConfigurations_Update.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sparkConfigurationName": "exampleSparkConfiguration", + "ifMatch": null, + "sparkConfiguration": { + "properties": { + "description": "modified description", + "configs": { + "test1": "test1value", + "test2": "test2value" + }, + "annotations": [ + "testAnnotation1", + "testAnnotation2" + ], + "notes": "testNotes" + } + }, + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2019 00:37:38 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1194", + "x-ms-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0", + "x-ms-correlation-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0" + } + }, + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:41 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/sparkconfigurations/exampleSparkConfiguration", + "name": "exampleSparkConfiguration", + "type": "Microsoft.Synapse/workspaces/sparkconfigurations", + "properties": { + "description": "modified description", + "configs": { + "test1": "test1value", + "test2": "test2value" + }, + "annotations": [ + "testAnnotation1", + "testAnnotation2" + ], + "notes": "testNotes", + "createdBy": "test@microsoft.com", + "created": "1970-01-01T00:00:00Z" + }, + "etag": "0a006cd4-0000-0000-0000-5b245bd60000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkJobDefinitions_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkJobDefinitions_Create.json new file mode 100644 index 000000000000..a3d7034e05d7 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkJobDefinitions_Create.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sparkJobDefinitionName": "exampleSparkJobDefinition", + "ifMatch": null, + "sparkJobDefinition": { + "properties": { + "description": "A sample spark job definition", + "targetBigDataPool": { + "referenceName": "exampleBigDataPool", + "type": "BigDataPoolReference" + }, + "requiredSparkVersion": "2.4", + "jobProperties": { + "name": "exampleSparkJobDefinition", + "file": "abfss://test@test.dfs.core.windows.net/artefacts/sample.jar", + "className": "dev.test.tools.sample.Main", + "conf": {}, + "args": [ + "exampleArg" + ], + "jars": [], + "pyFiles": [], + "files": [], + "archives": [], + "driverMemory": "28g", + "driverCores": 4, + "executorMemory": "28g", + "executorCores": 4, + "numExecutors": 2 + } + } + }, + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2019 00:37:38 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1194", + "x-ms-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0", + "x-ms-correlation-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0" + } + }, + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:41 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/sparkjobdefinitions/exampleSparkJobDefinition", + "name": "exampleSparkJobDefinition", + "type": "Microsoft.Synapse/workspaces/sparkjobdefinitions", + "properties": { + "description": "A sample spark job definition", + "targetBigDataPool": { + "referenceName": "exampleBigDataPool", + "type": "BigDataPoolReference" + }, + "requiredSparkVersion": "2.4", + "jobProperties": { + "name": "exampleSparkJobDefinition", + "file": "abfss://test@test.dfs.core.windows.net/artefacts/sample.jar", + "className": "dev.test.tools.sample.Main", + "conf": {}, + "args": [ + "exampleArg" + ], + "jars": [], + "pyFiles": [], + "files": [], + "archives": [], + "driverMemory": "28g", + "driverCores": 4, + "executorMemory": "28g", + "executorCores": 4, + "numExecutors": 2 + } + }, + "etag": "0a0069d4-0000-0000-0000-5b245bd50000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkJobDefinitions_Debug.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkJobDefinitions_Debug.json new file mode 100644 index 000000000000..6d752b2475be --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkJobDefinitions_Debug.json @@ -0,0 +1,166 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sparkJobDefinitionAzureResource": { + "properties": { + "description": "A sample spark job definition", + "targetBigDataPool": { + "referenceName": "exampleBigDataPool", + "type": "BigDataPoolReference" + }, + "requiredSparkVersion": "2.4", + "jobProperties": { + "name": "exampleSparkJobDefinition", + "file": "https://somestorage.blob.core.windows.net/main.jar", + "className": "SampleApp.SampleApp", + "conf": {}, + "driverMemory": "2g", + "driverCores": 2, + "executorMemory": "2g", + "executorCores": 2, + "numExecutors": 2 + } + } + }, + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 13 Sep 2019 23:38:58 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "location": "https://exampleWorkspaceName.dev.azuresynapse.net/operationResults/arcadiaSpark$$exampleBigDataPool$$batch$$1?api-version=2021-06-01-preview" + }, + "body": { + "livyInfo": { + "startingAt": "2019-09-13T23:38:08.9498718+00:00", + "runningAt": "2019-09-13T23:38:33.1197083+00:00", + "currentState": "running", + "jobCreationRequest": { + "name": "SampleBatchJob", + "file": "https://somestorage.blob.core.windows.net/main.jar", + "className": "SampleApp.SampleApp", + "conf": {}, + "driverMemory": "2g", + "driverCores": 2, + "executorMemory": "2g", + "executorCores": 2, + "numExecutors": 2 + } + }, + "name": "SampleBatchJob", + "workspaceName": "exampleWorkspace", + "sparkPoolName": "c0", + "submitterName": "user@domain.com", + "submitterId": "12345678-1234-1234-1234-12345678abc", + "artifactId": "Livy", + "jobType": "SparkBatch", + "result": "Succeeded", + "schedulerInfo": { + "submittedAt": "2019-09-13T23:38:01.3002495+00:00", + "scheduledAt": "2019-09-13T23:38:03.6535682+00:00", + "currentState": "running" + }, + "pluginInfo": { + "preparationStartedAt": "2019-09-13T23:38:03.7178558+00:00", + "resourceAcquisitionStartedAt": "2019-09-13T23:38:04.5467298+00:00", + "submissionStartedAt": "2019-09-13T23:38:05.4808501+00:00", + "currentState": "running" + }, + "tags": {}, + "id": 0, + "appId": "application_1568416412157_0002", + "appInfo": { + "driverLogUrl": "http://aa5a93c513fa426980a44e8124b9797b000eb919817:8042/node/containerlogs/container_1568416412157_0002_02_000001/trusted-service-user", + "sparkUiUrl": "http://aa5a93c513fa426980a44e8124b9797b004f5397319:8088/proxy/application_1568416412157_0002/" + }, + "state": "running", + "log": [ + "\tat org.apache.spark.sql.DataFrameReader.load(DataFrameReader.scala:211)", + "\tat org.apache.spark.sql.DataFrameReader.json(DataFrameReader.scala:391)", + "\tat org.apache.spark.sql.DataFrameReader.json(DataFrameReader.scala:325)", + "\tat SampleApp.SampleApp$.main(SampleApp.scala:39)", + "\tat SampleApp.SampleApp.main(SampleApp.scala)", + "\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)", + "\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)", + "\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)", + "\tat java.lang.reflect.Method.invoke(Method.java:498)", + "\tat org.apache.spark.deploy.yarn.ApplicationMaster$$anon$2.run(ApplicationMaster.scala:684)" + ] + } + }, + "200": { + "headers": { + "Date": "Sat, 13 Sep 2019 23:38:58 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "livyInfo": { + "startingAt": "2019-09-13T23:38:08.9498718+00:00", + "runningAt": "2019-09-13T23:38:33.1197083+00:00", + "successAt": "2019-09-13T23:38:57.2737498+00:00", + "currentState": "success", + "jobCreationRequest": { + "name": "SampleBatchJob", + "file": "https://somestorage.blob.core.windows.net/main.jar", + "className": "SampleApp.SampleApp", + "conf": {}, + "driverMemory": "2g", + "driverCores": 2, + "executorMemory": "2g", + "executorCores": 2, + "numExecutors": 2 + } + }, + "name": "SampleBatchJob", + "workspaceName": "exampleWorkspace", + "sparkPoolName": "c0", + "submitterName": "user@domain.com", + "submitterId": "12345678-1234-1234-1234-12345678abc", + "artifactId": "Livy", + "jobType": "SparkBatch", + "result": "Succeeded", + "schedulerInfo": { + "submittedAt": "2019-09-13T23:38:01.3002495+00:00", + "scheduledAt": "2019-09-13T23:38:03.6535682+00:00", + "endedAt": "2019-09-13T23:38:57.5375224+00:00", + "currentState": "Ended" + }, + "pluginInfo": { + "preparationStartedAt": "2019-09-13T23:38:03.7178558+00:00", + "resourceAcquisitionStartedAt": "2019-09-13T23:38:04.5467298+00:00", + "submissionStartedAt": "2019-09-13T23:38:05.4808501+00:00", + "monitoringStartedAt": "2019-09-13T23:38:09.0304334+00:00", + "cleanupStartedAt": "2019-09-13T23:38:57.3472897+00:00", + "currentState": "Ended" + }, + "tags": {}, + "id": 0, + "appId": "application_1568416412157_0002", + "appInfo": { + "driverLogUrl": "http://aa5a93c513fa426980a44e8124b9797b000eb919817:8042/node/containerlogs/container_1568416412157_0002_02_000001/trusted-service-user", + "sparkUiUrl": "http://aa5a93c513fa426980a44e8124b9797b004f5397319:8088/proxy/application_1568416412157_0002/" + }, + "state": "success", + "log": [ + "\tat org.apache.spark.sql.DataFrameReader.load(DataFrameReader.scala:211)", + "\tat org.apache.spark.sql.DataFrameReader.json(DataFrameReader.scala:391)", + "\tat org.apache.spark.sql.DataFrameReader.json(DataFrameReader.scala:325)", + "\tat SampleApp.SampleApp$.main(SampleApp.scala:39)", + "\tat SampleApp.SampleApp.main(SampleApp.scala)", + "\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)", + "\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)", + "\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)", + "\tat java.lang.reflect.Method.invoke(Method.java:498)", + "\tat org.apache.spark.deploy.yarn.ApplicationMaster$$anon$2.run(ApplicationMaster.scala:684)" + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkJobDefinitions_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkJobDefinitions_Delete.json new file mode 100644 index 000000000000..6ed33de6a68f --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkJobDefinitions_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sparkJobDefinitionName": "exampleSparkJobDefinition", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkJobDefinitions_Execute.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkJobDefinitions_Execute.json new file mode 100644 index 000000000000..8b75035edbac --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkJobDefinitions_Execute.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sparkJobDefinitionName": "exampleSparkJobDefinition", + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 13 Sep 2019 23:38:58 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "location": "https://exampleWorkspaceName.dev.azuresynapse.net/operationResults/arcadiaSpark$$exampleBigDataPool$$batch$$1?api-version=2021-06-01-preview" + }, + "body": { + "livyInfo": { + "startingAt": "2019-09-13T23:38:08.9498718+00:00", + "runningAt": "2019-09-13T23:38:33.1197083+00:00", + "currentState": "running", + "jobCreationRequest": { + "name": "SampleBatchJob", + "file": "https://somestorage.blob.core.windows.net/main.jar", + "className": "SampleApp.SampleApp", + "conf": {}, + "driverMemory": "2g", + "driverCores": 2, + "executorMemory": "2g", + "executorCores": 2, + "numExecutors": 2 + } + }, + "name": "SampleBatchJob", + "workspaceName": "exampleWorkspace", + "sparkPoolName": "c0", + "submitterName": "user@domain.com", + "submitterId": "12345678-1234-1234-1234-12345678abc", + "artifactId": "Livy", + "jobType": "SparkBatch", + "result": "Succeeded", + "schedulerInfo": { + "submittedAt": "2019-09-13T23:38:01.3002495+00:00", + "scheduledAt": "2019-09-13T23:38:03.6535682+00:00", + "currentState": "running" + }, + "pluginInfo": { + "preparationStartedAt": "2019-09-13T23:38:03.7178558+00:00", + "resourceAcquisitionStartedAt": "2019-09-13T23:38:04.5467298+00:00", + "submissionStartedAt": "2019-09-13T23:38:05.4808501+00:00", + "currentState": "running" + }, + "tags": {}, + "id": 0, + "appId": "application_1568416412157_0002", + "appInfo": { + "driverLogUrl": "http://aa5a93c513fa426980a44e8124b9797b000eb919817:8042/node/containerlogs/container_1568416412157_0002_02_000001/trusted-service-user", + "sparkUiUrl": "http://aa5a93c513fa426980a44e8124b9797b004f5397319:8088/proxy/application_1568416412157_0002/" + }, + "state": "running", + "log": [ + "\tat org.apache.spark.sql.DataFrameReader.load(DataFrameReader.scala:211)", + "\tat org.apache.spark.sql.DataFrameReader.json(DataFrameReader.scala:391)", + "\tat org.apache.spark.sql.DataFrameReader.json(DataFrameReader.scala:325)", + "\tat SampleApp.SampleApp$.main(SampleApp.scala:39)", + "\tat SampleApp.SampleApp.main(SampleApp.scala)", + "\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)", + "\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)", + "\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)", + "\tat java.lang.reflect.Method.invoke(Method.java:498)", + "\tat org.apache.spark.deploy.yarn.ApplicationMaster$$anon$2.run(ApplicationMaster.scala:684)" + ] + } + }, + "200": { + "headers": { + "Date": "Sat, 13 Sep 2019 23:38:58 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "livyInfo": { + "startingAt": "2019-09-13T23:38:08.9498718+00:00", + "runningAt": "2019-09-13T23:38:33.1197083+00:00", + "successAt": "2019-09-13T23:38:57.2737498+00:00", + "currentState": "success", + "jobCreationRequest": { + "name": "SampleBatchJob", + "file": "https://somestorage.blob.core.windows.net/main.jar", + "className": "SampleApp.SampleApp", + "conf": {}, + "driverMemory": "2g", + "driverCores": 2, + "executorMemory": "2g", + "executorCores": 2, + "numExecutors": 2 + } + }, + "name": "SampleBatchJob", + "workspaceName": "exampleWorkspace", + "sparkPoolName": "c0", + "submitterName": "user@domain.com", + "submitterId": "12345678-1234-1234-1234-12345678abc", + "artifactId": "Livy", + "jobType": "SparkBatch", + "result": "Succeeded", + "schedulerInfo": { + "submittedAt": "2019-09-13T23:38:01.3002495+00:00", + "scheduledAt": "2019-09-13T23:38:03.6535682+00:00", + "endedAt": "2019-09-13T23:38:57.5375224+00:00", + "currentState": "Ended" + }, + "pluginInfo": { + "preparationStartedAt": "2019-09-13T23:38:03.7178558+00:00", + "resourceAcquisitionStartedAt": "2019-09-13T23:38:04.5467298+00:00", + "submissionStartedAt": "2019-09-13T23:38:05.4808501+00:00", + "monitoringStartedAt": "2019-09-13T23:38:09.0304334+00:00", + "cleanupStartedAt": "2019-09-13T23:38:57.3472897+00:00", + "currentState": "Ended" + }, + "tags": {}, + "id": 0, + "appId": "application_1568416412157_0002", + "appInfo": { + "driverLogUrl": "http://aa5a93c513fa426980a44e8124b9797b000eb919817:8042/node/containerlogs/container_1568416412157_0002_02_000001/trusted-service-user", + "sparkUiUrl": "http://aa5a93c513fa426980a44e8124b9797b004f5397319:8088/proxy/application_1568416412157_0002/" + }, + "state": "success", + "log": [ + "\tat org.apache.spark.sql.DataFrameReader.load(DataFrameReader.scala:211)", + "\tat org.apache.spark.sql.DataFrameReader.json(DataFrameReader.scala:391)", + "\tat org.apache.spark.sql.DataFrameReader.json(DataFrameReader.scala:325)", + "\tat SampleApp.SampleApp$.main(SampleApp.scala:39)", + "\tat SampleApp.SampleApp.main(SampleApp.scala)", + "\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)", + "\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)", + "\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)", + "\tat java.lang.reflect.Method.invoke(Method.java:498)", + "\tat org.apache.spark.deploy.yarn.ApplicationMaster$$anon$2.run(ApplicationMaster.scala:684)" + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkJobDefinitions_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkJobDefinitions_Get.json new file mode 100644 index 000000000000..131ca5d05f69 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkJobDefinitions_Get.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sparkJobDefinitionName": "exampleSparkJobDefinition", + "ifNoneMatch": "1500504f-0000-0200-0000-5cbe090f0000", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:41 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/sparkjobdefinitions/exampleSparkJobDefinition", + "name": "exampleSparkJobDefinition", + "type": "Microsoft.Synapse/workspaces/sparkjobdefinitions", + "properties": { + "description": "A sample spark job definition", + "targetBigDataPool": { + "referenceName": "exampleBigDataPool", + "type": "BigDataPoolReference" + }, + "requiredSparkVersion": "2.4", + "jobProperties": { + "name": "exampleSparkJobDefinition", + "file": "abfss://test@test.dfs.core.windows.net/artefacts/sample.jar", + "className": "dev.test.tools.sample.Main", + "conf": {}, + "args": [ + "exampleArg" + ], + "jars": [], + "pyFiles": [], + "files": [], + "archives": [], + "driverMemory": "28g", + "driverCores": 4, + "executorMemory": "28g", + "executorCores": 4, + "numExecutors": 2 + } + }, + "etag": "1500504f-0000-0200-0000-5cbe090f0000" + } + }, + "304": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkJobDefinitions_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkJobDefinitions_ListByWorkspace.json new file mode 100644 index 000000000000..021eddf80fb8 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkJobDefinitions_ListByWorkspace.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:43 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14990", + "x-ms-request-id": "92292250-c10f-4c47-8eb6-b886b361add7", + "x-ms-correlation-request-id": "92292250-c10f-4c47-8eb6-b886b361add7" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/sparkjobdefinitions/exampleSparkJobDefinition", + "name": "exampleSparkJobDefinition", + "type": "Microsoft.Synapse/workspaces/sparkjobdefinitions", + "properties": { + "description": "A sample spark job definition", + "targetBigDataPool": { + "referenceName": "exampleBigDataPool", + "type": "BigDataPoolReference" + }, + "requiredSparkVersion": "2.4", + "jobProperties": { + "name": "exampleSparkJobDefinition", + "file": "abfss://test@test.dfs.core.windows.net/artefacts/sample.jar", + "className": "dev.test.tools.sample.Main", + "conf": {}, + "args": [ + "exampleArg" + ], + "jars": [], + "pyFiles": [], + "files": [], + "archives": [], + "driverMemory": "28g", + "driverCores": 4, + "executorMemory": "28g", + "executorCores": 4, + "numExecutors": 2 + } + }, + "etag": "1500504f-0000-0200-0000-5cbe090f0000" + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkJobDefinitions_Rename.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkJobDefinitions_Rename.json new file mode 100644 index 000000000000..5afef757a6af --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkJobDefinitions_Rename.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sparkJobDefinitionName": "examplesparkJobDefinition", + "api-version": "2021-06-01-preview", + "request": { + "newName": "newSparkJobDefinition" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkJobDefinitions_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkJobDefinitions_Update.json new file mode 100644 index 000000000000..a91bfd45e17b --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SparkJobDefinitions_Update.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sparkJobDefinitionName": "exampleSparkJobDefinition", + "ifMatch": null, + "sparkJobDefinition": { + "properties": { + "description": "modified description", + "targetBigDataPool": { + "referenceName": "exampleBigDataPool", + "type": "BigDataPoolReference" + }, + "requiredSparkVersion": "2.4", + "jobProperties": { + "name": "exampleSparkJobDefinition", + "file": "abfss://test@test.dfs.core.windows.net/artefacts/sample.jar", + "className": "dev.test.tools.sample.Main", + "conf": {}, + "args": [ + "exampleArg" + ], + "jars": [], + "pyFiles": [], + "files": [], + "archives": [], + "driverMemory": "28g", + "driverCores": 4, + "executorMemory": "28g", + "executorCores": 4, + "numExecutors": 2 + } + } + }, + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2019 00:37:38 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1194", + "x-ms-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0", + "x-ms-correlation-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0" + } + }, + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:41 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/sparkjobdefinitions/exampleSparkJobDefinition", + "name": "exampleSparkJobDefinition", + "type": "Microsoft.Synapse/workspaces/sparkjobdefinitions", + "properties": { + "description": "modified description", + "targetBigDataPool": { + "referenceName": "exampleBigDataPool", + "type": "BigDataPoolReference" + }, + "requiredSparkVersion": "2.4", + "jobProperties": { + "name": "exampleSparkJobDefinition", + "file": "abfss://test@test.dfs.core.windows.net/artefacts/sample.jar", + "className": "dev.test.tools.sample.Main", + "conf": {}, + "args": [ + "exampleArg" + ], + "jars": [], + "pyFiles": [], + "files": [], + "archives": [], + "driverMemory": "28g", + "driverCores": 4, + "executorMemory": "28g", + "executorCores": 4, + "numExecutors": 2 + } + }, + "etag": "0a006cd4-0000-0000-0000-5b245bd60000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SqlPools_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SqlPools_Get.json new file mode 100644 index 000000000000..6e3c7131bfd7 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SqlPools_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sqlPoolName": "SqlPool1", + "api-version": "2020-01-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "status": "Online", + "maxSizeBytes": 263882790666240, + "collation": "SQL_Latin1_General_CP1_CI_AS", + "restorePointInTime": "2019-06-23T10:47:12.837Z", + "creationDate": "2020-06-23T10:47:12.837Z", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "DW100c", + "capacity": 0 + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Synapse/workspaces/exampleWorkspace/sqlPools/SqlPool1", + "name": "SqlPool1", + "type": "Microsoft.Synapse/workspaces/sqlPools", + "location": "southeastasia", + "tags": {} + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SqlPools_List.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SqlPools_List.json new file mode 100644 index 000000000000..b4fa21cd8385 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SqlPools_List.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "status": "Online", + "maxSizeBytes": 263882790666240, + "collation": "SQL_Latin1_General_CP1_CI_AS", + "restorePointInTime": "2020-06-23T10:47:12.837Z", + "creationDate": "2020-06-23T10:47:12.837Z", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "DW100c", + "capacity": 0 + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Synapse/workspaces/exampleWorkspace/sqlPools/SqlPool1", + "name": "SqlPool1", + "type": "Microsoft.Synapse/workspaces/sqlPools", + "location": "southeastasia", + "tags": {} + }, + { + "properties": { + "status": "Online", + "maxSizeBytes": 263882790666240, + "collation": "SQL_Latin1_General_CP1_CI_AS", + "restorePointInTime": "2020-06-23T10:47:12.837Z", + "creationDate": "2020-06-23T11:10:59.05Z", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "DW100c", + "capacity": 0 + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Synapse/workspaces/exampleWorkspace/sqlPools/SqlPool2Backup", + "name": "SqlPool2Backup", + "type": "Microsoft.Synapse/workspaces/sqlPools", + "location": "southeastasia", + "tags": {} + } + ] + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SqlScripts_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SqlScripts_Create.json new file mode 100644 index 000000000000..09276e92bd8b --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SqlScripts_Create.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sqlScriptName": "exampleSqlScript", + "ifMatch": null, + "sqlScript": { + "name": "exampleSqlScript", + "properties": { + "description": "Covers the data transformation and LDW scenarios in one brief e2e story", + "content": { + "query": "SELECT TOP 100 * FROM example_table_name;", + "currentConnection": { + "name": "master", + "type": "SqlOnDemand" + }, + "metadata": { + "language": "sql" + } + }, + "type": "SqlQuery" + } + }, + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2019 00:37:38 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1194", + "x-ms-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0", + "x-ms-correlation-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0" + } + }, + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:41 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/sqlscripts/exampleSqlScript", + "name": "exampleSqlScript", + "type": "Microsoft.Synapse/workspaces/sqlscripts", + "properties": { + "description": "Covers the data transformation and LDW scenarios in one brief e2e story", + "content": { + "query": "SELECT TOP 100 * FROM example_table_name;", + "currentConnection": { + "name": "master", + "type": "SqlOnDemand" + }, + "metadata": { + "language": "sql" + } + }, + "type": "SqlQuery" + }, + "etag": "0a0069d4-0000-0000-0000-5b245bd50000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SqlScripts_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SqlScripts_Delete.json new file mode 100644 index 000000000000..eb4353b46e36 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SqlScripts_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sqlScriptName": "exampleSqlScript", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SqlScripts_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SqlScripts_Get.json new file mode 100644 index 000000000000..40dfff164e68 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SqlScripts_Get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sqlScriptName": "exampleSqlScript", + "ifNoneMatch": "1500504f-0000-0200-0000-5cbe090f0000", + "api-version": "2021-06-01-preview" + }, + "responses": { + "304": {}, + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:41 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/sqlscripts/exampleSqlScript", + "name": "exampleSqlScript", + "type": "Microsoft.Synapse/workspaces/sqlscripts", + "properties": { + "description": "Covers the data transformation and LDW scenarios in one brief e2e story", + "content": { + "query": "SELECT TOP 100 * FROM example_table_name;", + "currentConnection": { + "name": "master", + "type": "SqlOnDemand" + }, + "metadata": { + "language": "sql" + } + }, + "type": "SqlQuery" + }, + "etag": "1500504f-0000-0200-0000-5cbe090f0000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SqlScripts_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SqlScripts_ListByWorkspace.json new file mode 100644 index 000000000000..c0661c67939e --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SqlScripts_ListByWorkspace.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:43 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14990", + "x-ms-request-id": "92292250-c10f-4c47-8eb6-b886b361add7", + "x-ms-correlation-request-id": "92292250-c10f-4c47-8eb6-b886b361add7" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/sqlscripts/exampleSqlScript", + "name": "exampleSqlScript", + "type": "Microsoft.Synapse/workspaces/sqlscripts", + "properties": { + "description": "Covers the data transformation and LDW scenarios in one brief e2e story", + "content": { + "query": "SELECT TOP 100 * FROM example_table_name;", + "currentConnection": { + "name": "master", + "type": "SqlOnDemand" + }, + "metadata": { + "language": "sql" + } + }, + "type": "SqlQuery" + }, + "etag": "1500504f-0000-0200-0000-5cbe090f0000" + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SqlScripts_Rename.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SqlScripts_Rename.json new file mode 100644 index 000000000000..d61cefb6a33e --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SqlScripts_Rename.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sqlScriptName": "exampleSqlScript", + "api-version": "2021-06-01-preview", + "request": { + "newName": "newSqlScript" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SqlScripts_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SqlScripts_Update.json new file mode 100644 index 000000000000..0dc3588b91b3 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/SqlScripts_Update.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sqlScriptName": "exampleSqlScript", + "ifMatch": null, + "sqlScript": { + "name": "exampleSqlScript", + "properties": { + "description": "modified description", + "content": { + "query": "SELECT TOP 100 * FROM example_table_name;", + "currentConnection": { + "name": "master", + "type": "SqlOnDemand" + }, + "metadata": { + "language": "sql" + } + }, + "type": "SqlQuery" + } + }, + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2019 00:37:38 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1194", + "x-ms-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0", + "x-ms-correlation-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0" + } + }, + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:41 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/sqlscripts/exampleSqlScript", + "name": "exampleSqlScript", + "type": "Microsoft.Synapse/workspaces/sqlscripts", + "properties": { + "description": "modified description", + "content": { + "query": "SELECT TOP 100 * FROM example_table_name;", + "currentConnection": { + "name": "master", + "type": "SqlOnDemand" + }, + "metadata": { + "language": "sql" + } + }, + "type": "SqlQuery" + }, + "etag": "0a006cd4-0000-0000-0000-5b245bd60000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/TriggerRuns_Cancel.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/TriggerRuns_Cancel.json new file mode 100644 index 000000000000..bac4f7f1b5fb --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/TriggerRuns_Cancel.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "triggerName": "exampleTrigger", + "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:46:24 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1198", + "x-ms-request-id": "5aa854a5-7ac0-4c7e-9356-79c657f4e231", + "x-ms-correlation-request-id": "5aa854a5-7ac0-4c7e-9356-79c657f4e231" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/TriggerRuns_QueryByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/TriggerRuns_QueryByWorkspace.json new file mode 100644 index 000000000000..a316c3dbf186 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/TriggerRuns_QueryByWorkspace.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "filterParameters": { + "lastUpdatedAfter": "2018-06-16T00:36:44.3345758Z", + "lastUpdatedBefore": "2018-06-16T00:49:48.3686473Z", + "filters": [ + { + "operand": "TriggerName", + "operator": "Equals", + "values": [ + "exampleTrigger" + ] + } + ] + }, + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:46:22 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1199", + "x-ms-request-id": "fb328f3e-d21e-44f7-80d7-dad60c955b4d", + "x-ms-correlation-request-id": "fb328f3e-d21e-44f7-80d7-dad60c955b4d" + }, + "body": { + "value": [ + { + "triggerName": "exampleTrigger", + "triggerRunId": "08586724970898148904457116912CU27", + "triggerType": "ScheduleTrigger", + "triggerRunTimestamp": "2018-06-16T00:43:15.660141Z", + "status": "Succeeded", + "message": "", + "properties": { + "TriggerTime": "6/16/2018 12:43:15 AM", + "ScheduleTime": "6/16/2018 12:43:14 AM" + }, + "triggeredPipelines": { + "examplePipeline": "9f3ce8b3-37d7-43eb-96ac-a656c0476283" + } + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/TriggerRuns_Rerun.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/TriggerRuns_Rerun.json new file mode 100644 index 000000000000..bac4f7f1b5fb --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/TriggerRuns_Rerun.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "triggerName": "exampleTrigger", + "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:46:24 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1198", + "x-ms-request-id": "5aa854a5-7ac0-4c7e-9356-79c657f4e231", + "x-ms-correlation-request-id": "5aa854a5-7ac0-4c7e-9356-79c657f4e231" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Triggers_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Triggers_Create.json new file mode 100644 index 000000000000..bb785af2d590 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Triggers_Create.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "triggerName": "exampleTrigger", + "ifMatch": null, + "trigger": { + "properties": { + "type": "ScheduleTrigger", + "typeProperties": { + "recurrence": { + "frequency": "Minute", + "interval": 4, + "startTime": "2018-06-16T00:39:13.8441801Z", + "endTime": "2018-06-16T00:55:13.8441801Z", + "timeZone": "UTC" + } + }, + "pipelines": [ + { + "pipelineReference": { + "referenceName": "examplePipeline", + "type": "PipelineReference" + }, + "parameters": { + "OutputBlobNameList": [ + "exampleoutput.csv" + ] + } + } + ] + } + }, + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:14 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1186", + "x-ms-request-id": "373f1a49-685d-4c07-8857-0fcf1bcaffcb", + "x-ms-correlation-request-id": "373f1a49-685d-4c07-8857-0fcf1bcaffcb" + } + }, + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/triggers/exampleTrigger", + "name": "exampleTrigger", + "type": "Microsoft.Synapse/workspaces/triggers", + "properties": { + "type": "ScheduleTrigger", + "typeProperties": { + "recurrence": { + "frequency": "Minute", + "interval": 4, + "startTime": "2018-06-16T00:39:13.8441801Z", + "endTime": "2018-06-16T00:55:13.8441801Z", + "timeZone": "UTC" + } + }, + "pipelines": [ + { + "pipelineReference": { + "referenceName": "examplePipeline", + "type": "PipelineReference" + }, + "parameters": { + "OutputBlobNameList": [ + "exampleoutput.csv" + ] + } + } + ], + "runtimeState": "Stopped" + }, + "etag": "0a008ad4-0000-0000-0000-5b245c6e0000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Triggers_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Triggers_Delete.json new file mode 100644 index 000000000000..d5ed30aa5638 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Triggers_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "triggerName": "exampleTrigger", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Triggers_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Triggers_Get.json new file mode 100644 index 000000000000..9eca8b6ec089 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Triggers_Get.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "triggerName": "exampleTrigger", + "ifNoneMatch": "1500544f-0000-0200-0000-5cbe09100000", + "api-version": "2021-06-01-preview" + }, + "responses": { + "304": {}, + "200": { + "headers": { + "Date": "Mon, 22 Apr 2019 18:33:52 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "11989", + "x-ms-request-id": "8ad1759f-24c1-46a5-aef5-edd267e18870", + "x-ms-correlation-request-id": "8ad1759f-24c1-46a5-aef5-edd267e18870" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/triggers/exampleTrigger", + "name": "exampleTrigger", + "type": "Microsoft.Synapse/workspaces/triggers", + "properties": { + "type": "ScheduleTrigger", + "typeProperties": { + "recurrence": { + "frequency": "Minute", + "interval": 4, + "startTime": "2019-04-22T18:32:52.527912Z", + "endTime": "2019-04-22T18:48:52.5281747Z", + "timeZone": "UTC" + } + }, + "pipelines": [ + { + "pipelineReference": { + "referenceName": "examplePipeline", + "type": "PipelineReference" + }, + "parameters": { + "OutputBlobNameList": [ + "exampleoutput.csv" + ] + } + } + ], + "runtimeState": "Stopped" + }, + "etag": "1500544f-0000-0200-0000-5cbe09100000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Triggers_GetEventSubscriptionStatus.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Triggers_GetEventSubscriptionStatus.json new file mode 100644 index 000000000000..add441658e8f --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Triggers_GetEventSubscriptionStatus.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "triggerName": "exampleTrigger", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "triggerName": "exampleTrigger", + "status": "Enabled" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Triggers_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Triggers_ListByWorkspace.json new file mode 100644 index 000000000000..b48f704142fc --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Triggers_ListByWorkspace.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:20 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14986", + "x-ms-request-id": "e474f8f8-b34f-4536-b059-ca740e6b44c3", + "x-ms-correlation-request-id": "e474f8f8-b34f-4536-b059-ca740e6b44c3" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/triggers/exampleTrigger", + "name": "exampleTrigger", + "type": "Microsoft.Synapse/workspaces/triggers", + "properties": { + "type": "ScheduleTrigger", + "typeProperties": { + "recurrence": { + "frequency": "Minute", + "interval": 4, + "startTime": "2018-06-16T00:39:14.905167Z", + "endTime": "2018-06-16T00:55:14.905167Z", + "timeZone": "UTC" + } + }, + "pipelines": [ + { + "pipelineReference": { + "referenceName": "examplePipeline", + "type": "PipelineReference" + }, + "parameters": { + "OutputBlobNameList": [ + "exampleoutput.csv" + ] + } + } + ], + "description": "Example description", + "runtimeState": "Started" + }, + "etag": "0a008ed4-0000-0000-0000-5b245c740000" + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Triggers_Start.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Triggers_Start.json new file mode 100644 index 000000000000..6a34d2b7d862 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Triggers_Start.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "triggerName": "exampleTrigger", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Triggers_Stop.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Triggers_Stop.json new file mode 100644 index 000000000000..6a34d2b7d862 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Triggers_Stop.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "triggerName": "exampleTrigger", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Triggers_SubscribeToEvents.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Triggers_SubscribeToEvents.json new file mode 100644 index 000000000000..d1acd5a879e4 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Triggers_SubscribeToEvents.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "triggerName": "exampleTrigger", + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/triggers/exampleTrigger/getEventSubscriptionStatus?api-version=2021-06-01-preview" + } + }, + "200": { + "body": { + "triggerName": "exampleTrigger", + "status": "Enabled" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Triggers_UnsubscribeFromEvents.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Triggers_UnsubscribeFromEvents.json new file mode 100644 index 000000000000..cd53de26a444 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Triggers_UnsubscribeFromEvents.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "triggerName": "exampleTrigger", + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/triggers/exampleTrigger/getEventSubscriptionStatus?api-version=2021-06-01-preview" + } + }, + "200": { + "body": { + "triggerName": "exampleTrigger", + "status": "Disabled" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Triggers_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Triggers_Update.json new file mode 100644 index 000000000000..d3bf9a5d1715 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Triggers_Update.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "triggerName": "exampleTrigger", + "ifMatch": null, + "trigger": { + "properties": { + "type": "ScheduleTrigger", + "typeProperties": { + "recurrence": { + "frequency": "Minute", + "interval": 4, + "startTime": "2018-06-16T00:39:14.905167Z", + "endTime": "2018-06-16T00:55:14.905167Z", + "timeZone": "UTC" + } + }, + "pipelines": [ + { + "pipelineReference": { + "referenceName": "examplePipeline", + "type": "PipelineReference" + }, + "parameters": { + "OutputBlobNameList": [ + "exampleoutput.csv" + ] + } + } + ], + "description": "Example description" + } + }, + "api-version": "2021-06-01-preview" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:15 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1185", + "x-ms-request-id": "d5ccf096-0618-4b26-9829-db77e4c391c7", + "x-ms-correlation-request-id": "d5ccf096-0618-4b26-9829-db77e4c391c7" + } + }, + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/triggers/exampleTrigger", + "name": "exampleTrigger", + "type": "Microsoft.Synapse/workspaces/triggers", + "properties": { + "type": "ScheduleTrigger", + "typeProperties": { + "recurrence": { + "frequency": "Minute", + "interval": 4, + "startTime": "2018-06-16T00:39:14.905167Z", + "endTime": "2018-06-16T00:55:14.905167Z", + "timeZone": "UTC" + } + }, + "pipelines": [ + { + "pipelineReference": { + "referenceName": "examplePipeline", + "type": "PipelineReference" + }, + "parameters": { + "OutputBlobNameList": [ + "exampleoutput.csv" + ] + } + } + ], + "description": "Example description", + "runtimeState": "Stopped" + }, + "etag": "0a008dd4-0000-0000-0000-5b245c6f0000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/WorkspaceGitRepoManagement_getGitHubAccessToken.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/WorkspaceGitRepoManagement_getGitHubAccessToken.json new file mode 100644 index 000000000000..10f82e2be805 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/WorkspaceGitRepoManagement_getGitHubAccessToken.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "workspaceName": "workspace1", + "api-version": "2021-06-01-preview", + "x-ms-client-request-id": "c8b9a072-76f6-4383-8350-db4431deb921", + "gitHubAccessTokenRequest": { + "gitHubClientId": "wvwvwvwvwv", + "gitHubAccessCode": "cwvcwvwev", + "gitHubAccessTokenBaseUrl": "https://github.com/login/oauth/access_token" + }, + "endpoint": "https://azure.com" + }, + "responses": { + "200": { + "body": { + "gitHubAccessToken": "zycdwcsdc" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Workspace_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Workspace_Get.json new file mode 100644 index 000000000000..7a64f90fa8b3 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/Workspace_Get.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-01-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Synapse/workspaces/exampleWorkspace", + "location": "southeastasia", + "name": "exampleWorkspace", + "type": "Microsoft.Synapse/workspaces", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "tags": {}, + "properties": { + "connectivityEndpoints": { + "web": "https://web.azuresynapse.net?workspace=%2fsubscriptions%2f00000000-0000-0000-0000-000000000000%2fresourceGroups%2frg%2fproviders%2fMicrosoft.Synapse%2fworkspaces%2fexampleWorkspace", + "sql": "exampleWorkspace.sql.azuresynapse.net", + "dev": "https://exampleWorkspace.dev.azuresynapse.net", + "sqlOnDemand": "exampleWorkspace-ondemand.sql.azuresynapse.net" + }, + "managedResourceGroupName": "workspacemanagedrg-1a992746-f580-4fce-a696-b0373bc6959a", + "defaultDataLakeStorage": { + "accountUrl": "https://exampleWorkspacedfs.dfs.core.windows.net", + "filesystem": "synapse" + }, + "sqlAdministratorLogin": "sqladminuser", + "privateEndpointConnections": [], + "workspaceRepositoryConfiguration": { + "type": "FactoryGitHubConfiguration", + "hostName": "", + "accountName": "myGithubAccount", + "projectName": "myProject", + "repositoryName": "myRepository", + "collaborationBranch": "master", + "rootFolder": "/" + }, + "provisioningState": "Succeeded" + } + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/gitintegration.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/gitintegration.json new file mode 100644 index 000000000000..d3bdaf4705fa --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/gitintegration.json @@ -0,0 +1,123 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01-preview", + "title": "ArtifactsClient" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/getGitHubAccessToken": { + "post": { + "tags": [ + "WorkspaceGitRepoManagement" + ], + "operationId": "WorkspaceGitRepoManagement_getGitHubAccessToken", + "description": "Get the GitHub access token.", + "x-ms-examples": { + "Get SOL job query string": { + "$ref": "./examples/WorkspaceGitRepoManagement_getGitHubAccessToken.json" + } + }, + "parameters": [ + { + "name": "x-ms-client-request-id", + "x-ms-client-name": "ClientRequestId", + "in": "header", + "required": false, + "type": "string", + "description": "Can provide a guid, which is helpful for debugging and to provide better customer support" + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "gitHubAccessTokenRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GitHubAccessTokenRequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/GitHubAccessTokenResponse" + } + } + } + } + } + }, + "definitions": { + "GitHubAccessTokenRequest": { + "type": "object", + "properties": { + "gitHubClientId": { + "description": "The GitHub Client Id.", + "type": "string" + }, + "gitHubAccessCode": { + "description": "The GitHub Access code.", + "type": "string" + }, + "gitHubAccessTokenBaseUrl": { + "description": "The GitHub access token base URL.", + "type": "string" + } + }, + "required": [ + "gitHubClientId", + "gitHubAccessCode", + "gitHubAccessTokenBaseUrl" + ] + }, + "GitHubAccessTokenResponse": { + "type": "object", + "properties": { + "gitHubAccessToken": { + "type": "string" + } + } + } + }, + "parameters": { + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Synapse client API Version." + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/integrationRuntimes.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/integrationRuntimes.json new file mode 100644 index 000000000000..aa4916bb95c4 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/integrationRuntimes.json @@ -0,0 +1,123 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01-preview", + "title": "ArtifactsClient" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/integrationRuntimes": { + "get": { + "tags": [ + "IntegrationRuntimes" + ], + "operationId": "IntegrationRuntimes_List", + "description": "List Integration Runtimes", + "x-ms-examples": { + "List Integration Runtimes": { + "$ref": "./examples/IntegrationRuntimes_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success response.", + "schema": { + "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/integrationRuntime.json#/definitions/IntegrationRuntimeListResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json#/definitions/ErrorContract" + } + } + } + } + }, + "/integrationRuntimes/{integrationRuntimeName}": { + "get": { + "tags": [ + "IntegrationRuntimes" + ], + "operationId": "IntegrationRuntimes_Get", + "description": "Get Integration Runtime", + "x-ms-examples": { + "Get Integration Runtime": { + "$ref": "./examples/IntegrationRuntimes_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IntegrationRuntimeNameParameter" + } + ], + "responses": { + "200": { + "description": "Success response.", + "schema": { + "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/integrationRuntime.json#/definitions/IntegrationRuntimeResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json#/definitions/ErrorContract" + } + } + } + } + } + }, + "definitions": {}, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Synapse client API Version." + }, + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "IntegrationRuntimeNameParameter": { + "name": "integrationRuntimeName", + "in": "path", + "required": true, + "type": "string", + "description": "The Integration Runtime name", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/kqlScripts.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/kqlScripts.json new file mode 100644 index 000000000000..51e3fb510f19 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/kqlScripts.json @@ -0,0 +1,329 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01-preview", + "title": "ArtifactsClient", + "x-ms-code-generation-settings": { + "useDateTimeOffset": true + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/kqlScripts": { + "get": { + "tags": [ + "kqlScripts" + ], + "operationId": "KqlScripts_GetAll", + "description": "Get all KQL scripts", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/KqlScripts_ResourceCollectionResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json#/definitions/ErrorContract" + } + } + }, + "x-ms-examples": { + "KqlScripts_GetAll": { + "$ref": "./examples/KqlScripts_GetAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/kqlScripts/{kqlScriptName}": { + "put": { + "tags": [ + "kqlScripts" + ], + "operationId": "KqlScript_CreateOrUpdate", + "description": "Creates or updates a KQL Script", + "parameters": [ + { + "$ref": "#/parameters/KqlScriptName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "kqlScript", + "description": "KQL script", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/KqlScriptResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/KqlScriptResource" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json#/definitions/ErrorContract" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "KqlScript_CreateOrUpdate": { + "$ref": "./examples/KqlScript_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "kqlScripts" + ], + "operationId": "KqlScript_GetByName", + "description": "Get KQL script by name", + "parameters": [ + { + "$ref": "#/parameters/KqlScriptName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/KqlScriptResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + } + } + }, + "x-ms-examples": { + "KqlScript_GetByName": { + "$ref": "./examples/KqlScript_GetByName.json" + } + } + }, + "delete": { + "tags": [ + "kqlScripts" + ], + "operationId": "KqlScript_DeleteByName", + "description": "Delete KQL script by name", + "parameters": [ + { + "$ref": "#/parameters/KqlScriptName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/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/v1/types.json#/definitions/ErrorContract" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "KqlScript_DeleteByName": { + "$ref": "./examples/KqlScript_DeleteByName.json" + } + } + } + }, + "/kqlScripts/{kqlScriptName}/rename": { + "post": { + "tags": [ + "kqlScripts" + ], + "operationId": "KqlScript_Rename", + "description": "Rename KQL script", + "parameters": [ + { + "$ref": "#/parameters/KqlScriptName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "renameRequest", + "description": "Rename request", + "required": true, + "schema": { + "$ref": "./artifacts.json#/definitions/ArtifactRenameRequest" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "KqlScript_Rename": { + "$ref": "./examples/KqlScript_Rename.json" + } + } + } + } + }, + "definitions": { + "KqlScripts_ResourceCollectionResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/KqlScriptResource" + } + }, + "nextLink": { + "type": "string" + } + } + }, + "KqlScriptResource": { + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "properties": { + "$ref": "#/definitions/KqlScript", + "description": "Properties of sql script." + } + } + }, + "KqlScript": { + "properties": { + "content": { + "properties": { + "query": { + "type": "string" + }, + "metadata": { + "type": "object", + "properties": { + "language": { + "type": "string" + } + } + }, + "currentConnection": { + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string" + } + } + } + } + } + } + } + }, + "parameters": { + "workspaceName": { + "name": "workspaceName", + "description": "The workspace name.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Synapse client API Version." + }, + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "KqlScriptName": { + "name": "kqlScriptName", + "in": "path", + "required": true, + "type": "string", + "description": "KQL script name", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/library.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/library.json new file mode 100644 index 000000000000..2c8c255b6afe --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/library.json @@ -0,0 +1,514 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01-preview", + "title": "ArtifactsClient" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/libraries": { + "get": { + "tags": [ + "Library" + ], + "operationId": "Library_List", + "x-ms-examples": { + "List Libraries": { + "$ref": "./examples/Library_ListByWorkspace.json" + } + }, + "description": "Lists Library.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/LibraryListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "./artifacts.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/libraries/{libraryName}/flush": { + "post": { + "tags": [ + "Library" + ], + "operationId": "Library_Flush", + "x-ms-examples": { + "Flush Library": { + "$ref": "./examples/Library_Flush.json" + } + }, + "description": "Flush Library", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LibraryNameParameter" + } + ], + "responses": { + "200": { + "description": "Ok." + }, + "202": { + "description": "Accepted.", + "schema": { + "$ref": "#/definitions/LibraryResourceInfo" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "./artifacts.json#/definitions/CloudError" + } + } + } + } + }, + "/libraryOperationResults/{operationId}": { + "get": { + "tags": [ + "Library" + ], + "operationId": "Library_GetOperationResult", + "x-ms-examples": { + "Get Operation Result for Library": { + "$ref": "./examples/Library_GetOperationResult.json" + } + }, + "description": "Get Operation result for Library", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/OperationId" + } + ], + "responses": { + "200": { + "description": "Ok.", + "schema": { + "$ref": "#/definitions/LibraryResource" + } + }, + "202": { + "description": "Accepted.", + "schema": { + "$ref": "#/definitions/OperationResult" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "./artifacts.json#/definitions/CloudError" + } + } + } + } + }, + "/libraries/{libraryName}": { + "delete": { + "tags": [ + "Library" + ], + "operationId": "Library_Delete", + "x-ms-examples": { + "Delete Library": { + "$ref": "./examples/Library_Delete.json" + } + }, + "description": "Delete Library", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LibraryNameParameter" + } + ], + "responses": { + "200": { + "description": "Ok." + }, + "202": { + "description": "Accepted.", + "schema": { + "$ref": "#/definitions/LibraryResourceInfo" + } + }, + "409": { + "description": "Conflict." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "./artifacts.json#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "Library" + ], + "operationId": "Library_Get", + "description": "Get Library", + "x-ms-examples": { + "Get Library": { + "$ref": "./examples/Library_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LibraryNameParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/LibraryResource" + } + }, + "304": { + "description": "Not modified." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "./artifacts.json#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "Library" + ], + "operationId": "Library_Create", + "x-ms-examples": { + "Create Library": { + "$ref": "./examples/Library_Create.json" + } + }, + "description": "Creates a library with the library name.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LibraryNameParameter" + } + ], + "responses": { + "200": { + "description": "Ok." + }, + "202": { + "description": "In case of create operation, library resource information will be returned.", + "schema": { + "$ref": "#/definitions/LibraryResourceInfo" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "./artifacts.json#/definitions/CloudError" + } + } + } + } + } + }, + "x-ms-paths": { + "/libraries/{libraryName}?comp=appendblock": { + "put": { + "tags": [ + "Library" + ], + "operationId": "Library_Append", + "x-ms-examples": { + "Append Library": { + "$ref": "./examples/Library_Append.json" + } + }, + "description": "Append the content to the library resource created using the create operation. The maximum content size is 4MiB. Content larger than 4MiB must be appended in 4MiB chunks", + "consumes": [ + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LibraryNameParameter" + }, + { + "name": "content", + "in": "body", + "description": "Library file chunk.", + "required": true, + "schema": { + "format": "binary", + "type": "string" + } + }, + { + "name": "x-ms-blob-condition-appendpos", + "x-ms-client-name": "blobConditionAppendPosition", + "in": "header", + "description": "Set this header to a byte offset at which the block is expected to be appended. The request succeeds only if the current offset matches this value. Otherwise, the request fails with the AppendPositionConditionNotMet error (HTTP status code 412 – Precondition Failed)", + "required": false, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "201": { + "description": "Created." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "./artifacts.json#/definitions/CloudError" + } + } + } + }, + "parameters": [ + { + "name": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "appendblock" + ] + } + ] + } + }, + "definitions": { + "OperationResult": { + "description": "Operation status for the operation", + "type": "object", + "properties": { + "status": { + "readOnly": true, + "type": "string", + "description": "Operation status" + }, + "error": { + "x-ms-client-flatten": true, + "description": "Error data", + "$ref": "./artifacts.json#/definitions/CloudErrorBody" + } + } + }, + "LibraryListResponse": { + "description": "A list of Library resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of Library.", + "items": { + "$ref": "#/definitions/LibraryResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "LibraryResourceInfo": { + "description": "Library resource info ", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" + }, + "recordId": { + "readOnly": true, + "type": "integer", + "description": "record Id of the library/package." + }, + "state": { + "readOnly": true, + "type": "string", + "description": "Provisioning status of the library/package." + }, + "created": { + "readOnly": true, + "type": "string", + "description": "The creation time of the library/package." + }, + "changed": { + "readOnly": true, + "type": "string", + "description": "The last updated time of the library/package." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. E.g. LibraryArtifact" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the library/package." + }, + "operationId": { + "readOnly": true, + "type": "string", + "description": "Operation Id of the operation performed on library/package." + }, + "artifactId": { + "readOnly": true, + "type": "string", + "description": "artifact Id of the library/package." + } + } + }, + "LibraryResource": { + "description": "Library response details", + "type": "object", + "allOf": [ + { + "$ref": "./artifacts.json#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/LibraryResourceProperties", + "description": "Library/package properties." + } + }, + "required": [ + "properties" + ] + }, + "LibraryResourceProperties": { + "description": "Library/package properties", + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the library/package." + }, + "path": { + "readOnly": true, + "type": "string", + "description": "Location of library/package in storage account." + }, + "containerName": { + "readOnly": true, + "type": "string", + "description": "Container name of the library/package." + }, + "uploadedTimestamp": { + "readOnly": true, + "type": "string", + "description": "The last update time of the library/package." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the library/package." + }, + "provisioningStatus": { + "readOnly": true, + "type": "string", + "description": "Provisioning status of the library/package." + }, + "creatorId": { + "readOnly": true, + "type": "string", + "description": "Creator Id of the library/package." + } + } + } + }, + "parameters": { + "LibraryNameParameter": { + "name": "libraryName", + "in": "path", + "maxLength": 100, + "required": true, + "type": "string", + "description": "file name to upload. Minimum length of the filename should be 1 excluding the extension length.", + "x-ms-parameter-location": "method" + }, + "OperationId": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "operation id for which status is requested", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Synapse client API Version." + }, + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/managedPrivateEndpoints.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/managedPrivateEndpoints.json new file mode 100644 index 000000000000..a6225b23686e --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/managedPrivateEndpoints.json @@ -0,0 +1,316 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01-preview", + "title": "VnetClient" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "paths": { + "/managedVirtualNetworks/{managedVirtualNetworkName}/managedPrivateEndpoints/{managedPrivateEndpointName}": { + "get": { + "tags": [ + "ManagedPrivateEndpoints" + ], + "operationId": "ManagedPrivateEndpoints_Get", + "description": "Get Managed Private Endpoints", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ManagedVirtualNetworkNameParameter" + }, + { + "$ref": "#/parameters/ManagedPrivateEndpointNameParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/ManagedPrivateEndpoint" + }, + "description": "" + } + }, + "x-ms-examples": { + "Get a managed private endpoint": { + "$ref": "./examples/GetManagedPrivateEndpoint.json" + } + } + }, + "put": { + "tags": [ + "ManagedPrivateEndpoints" + ], + "operationId": "ManagedPrivateEndpoints_Create", + "description": "Create Managed Private Endpoints", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ManagedVirtualNetworkNameParameter" + }, + { + "$ref": "#/parameters/ManagedPrivateEndpointNameParameter" + }, + { + "name": "managedPrivateEndpoint", + "in": "body", + "required": true, + "description": "Managed private endpoint properties.", + "schema": { + "$ref": "#/definitions/ManagedPrivateEndpoint" + } + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/ManagedPrivateEndpoint" + }, + "description": "" + } + }, + "x-ms-examples": { + "Create a managed private endpoint": { + "$ref": "./examples/CreateManagedPrivateEndpoint.json" + } + } + }, + "delete": { + "tags": [ + "ManagedPrivateEndpoints" + ], + "operationId": "ManagedPrivateEndpoints_Delete", + "description": "Delete Managed Private Endpoints", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ManagedVirtualNetworkNameParameter" + }, + { + "$ref": "#/parameters/ManagedPrivateEndpointNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "Already deleted" + } + }, + "x-ms-examples": { + "Delete a managed private endpoint": { + "$ref": "./examples/DeleteManagedPrivateEndpoint.json" + } + } + } + }, + "/managedVirtualNetworks/{managedVirtualNetworkName}/managedPrivateEndpoints": { + "get": { + "tags": [ + "ManagedPrivateEndpoints" + ], + "operationId": "ManagedPrivateEndpoints_List", + "description": "List Managed Private Endpoints", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ManagedVirtualNetworkNameParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/ManagedPrivateEndpointListResponse" + }, + "description": "" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List managed private endpoints": { + "$ref": "./examples/ListManagedPrivateEndpoints.json" + } + } + } + } + }, + "definitions": { + "ManagedPrivateEndpointListResponse": { + "description": "A list of managed private endpoints", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "List of managed private endpoints", + "items": { + "$ref": "#/definitions/ManagedPrivateEndpoint" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedPrivateEndpoint": { + "description": "Managed private endpoint", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts." + }, + "properties": { + "$ref": "#/definitions/ManagedPrivateEndpointProperties", + "description": "Managed private endpoint properties" + } + } + }, + "ManagedPrivateEndpointProperties": { + "description": "Properties of a managed private endpoint", + "type": "object", + "properties": { + "name": { + "description": "The name of managed private endpoint", + "type": "string" + }, + "privateLinkResourceId": { + "description": "The ARM resource ID of the resource to which the managed private endpoint is created", + "type": "string" + }, + "groupId": { + "description": "The groupId to which the managed private endpoint is created", + "type": "string" + }, + "provisioningState": { + "description": "The managed private endpoint provisioning state", + "type": "string", + "readOnly": true + }, + "connectionState": { + "description": "The managed private endpoint connection state", + "$ref": "#/definitions/ManagedPrivateEndpointConnectionState" + }, + "isReserved": { + "description": "Denotes whether the managed private endpoint is reserved", + "type": "boolean", + "readOnly": true + }, + "fqdns": { + "description": "List of fully qualified domain names", + "type": "array", + "items": { + "type": "string" + } + }, + "isCompliant": { + "description": "Denotes whether the managed private endpoint is compliant", + "type": "boolean" + } + } + }, + "ManagedPrivateEndpointConnectionState": { + "description": "The connection state of a managed private endpoint", + "type": "object", + "properties": { + "status": { + "description": "The approval status", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The managed private endpoint description", + "type": "string" + }, + "actionsRequired": { + "description": "The actions required on the managed private endpoint", + "type": "string" + } + } + } + }, + "parameters": { + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Synapse client API Version." + }, + "ManagedVirtualNetworkNameParameter": { + "name": "managedVirtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "x-ms-client-default": "default", + "description": "Managed virtual network name", + "x-ms-parameter-location": "method" + }, + "ManagedPrivateEndpointNameParameter": { + "name": "managedPrivateEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "Managed private endpoint name", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/operations.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/operations.json new file mode 100644 index 000000000000..dc2abc91a407 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/operations.json @@ -0,0 +1,138 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01-preview", + "title": "ArtifactsClient" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/operationResults/{operationId}": { + "get": { + "tags": [ + "OperationResult" + ], + "operationId": "OperationResult_Get", + "description": "Get operation result", + "x-ms-examples": { + "List Sql Pools": { + "$ref": "./examples/OperationResult_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "Operation ID." + } + ], + "responses": { + "200": { + "description": "" + }, + "201": { + "description": "" + }, + "202": { + "description": "" + }, + "204": { + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + }, + "description": "" + } + } + } + }, + "/operationStatuses/{operationId}": { + "get": { + "tags": [ + "OperationResult" + ], + "operationId": "OperationStatus_Get", + "description": "Get operation status", + "x-ms-examples": { + "List Sql Pools": { + "$ref": "./examples/OperationStatus_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "Operation ID." + } + ], + "responses": { + "200": { + "description": "" + }, + "201": { + "description": "" + }, + "202": { + "description": "" + }, + "204": { + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + }, + "description": "" + } + } + } + } + }, + "definitions": {}, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Synapse client API Version." + }, + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/sqlPools.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/sqlPools.json new file mode 100644 index 000000000000..f9e5818276a0 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/sqlPools.json @@ -0,0 +1,123 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01-preview", + "title": "ArtifactsClient" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/sqlPools": { + "get": { + "tags": [ + "SqlPools" + ], + "operationId": "SqlPools_List", + "description": "List Sql Pools", + "x-ms-examples": { + "List Sql Pools": { + "$ref": "./examples/SqlPools_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success response.", + "schema": { + "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/sqlPool.json#/definitions/SqlPoolInfoListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json#/definitions/ErrorContract" + } + } + } + } + }, + "/sqlPools/{sqlPoolName}": { + "get": { + "tags": [ + "SqlPools" + ], + "operationId": "SqlPools_Get", + "description": "Get Sql Pool", + "x-ms-examples": { + "List Sql Pools": { + "$ref": "./examples/SqlPools_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SqlPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Success response.", + "schema": { + "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/sqlPool.json#/definitions/SqlPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json#/definitions/ErrorContract" + } + } + } + } + } + }, + "definitions": {}, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Synapse client API Version." + }, + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "SqlPoolNameParameter": { + "name": "sqlPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The Sql Pool name", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/workspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/workspace.json new file mode 100644 index 000000000000..8a5d5d51f357 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/workspace.json @@ -0,0 +1,79 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01-preview", + "title": "ArtifactsClient" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/workspace": { + "get": { + "tags": [ + "Workspace" + ], + "operationId": "Workspace_Get", + "description": "Get Workspace", + "x-ms-examples": { + "Get Workspace Information": { + "$ref": "./examples/Workspace_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success response.", + "schema": { + "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json#/definitions/ErrorContract" + } + } + } + } + } + }, + "definitions": {}, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Synapse client API Version." + }, + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/artifacts.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/artifacts.json new file mode 100644 index 000000000000..5fff3fdbdcac --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/artifacts.json @@ -0,0 +1,4793 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-12-01", + "title": "ArtifactsClient", + "x-ms-code-generation-settings": { + "useDateTimeOffset": true + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/linkedservices": { + "get": { + "tags": [ + "linkedServices" + ], + "operationId": "LinkedService_GetLinkedServicesByWorkspace", + "x-ms-examples": { + "LinkedServices_ListByWorkspace": { + "$ref": "./examples/LinkedServices_ListByWorkspace.json" + } + }, + "description": "Lists linked services.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/LinkedServiceListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/linkedservices/{linkedServiceName}": { + "put": { + "tags": [ + "linkedServices" + ], + "operationId": "LinkedService_CreateOrUpdateLinkedService", + "x-ms-examples": { + "LinkedServices_Create": { + "$ref": "./examples/LinkedServices_Create.json" + }, + "LinkedServices_Update": { + "$ref": "./examples/LinkedServices_Update.json" + } + }, + "description": "Creates or updates a linked service.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/linkedServiceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the linkedService entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." + }, + { + "name": "linkedService", + "description": "Linked service resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LinkedServiceResource" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/LinkedServiceResource" + } + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "linkedServices" + ], + "operationId": "LinkedService_GetLinkedService", + "x-ms-examples": { + "LinkedServices_Get": { + "$ref": "./examples/LinkedServices_Get.json" + } + }, + "description": "Gets a linked service.", + "parameters": [ + { + "$ref": "#/parameters/linkedServiceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the linked service entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/LinkedServiceResource" + } + }, + "304": { + "description": "Not modified." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "linkedServices" + ], + "operationId": "LinkedService_DeleteLinkedService", + "x-ms-examples": { + "LinkedServices_Delete": { + "$ref": "./examples/LinkedServices_Delete.json" + } + }, + "description": "Deletes a linked service.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/linkedServiceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/linkedservices/{linkedServiceName}/rename": { + "post": { + "tags": [ + "linkedServices" + ], + "operationId": "LinkedService_RenameLinkedService", + "x-ms-examples": { + "LinkedServices_Rename": { + "$ref": "./examples/LinkedServices_Rename.json" + } + }, + "description": "Renames a linked service.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/linkedServiceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "request", + "description": "proposed new name.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArtifactRenameRequest" + } + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/datasets": { + "get": { + "tags": [ + "datasets" + ], + "operationId": "Dataset_GetDatasetsByWorkspace", + "x-ms-examples": { + "Datasets_ListByWorkspace": { + "$ref": "./examples/Datasets_ListByWorkspace.json" + } + }, + "description": "Lists datasets.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/DatasetListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/datasets/{datasetName}": { + "put": { + "tags": [ + "datasets" + ], + "operationId": "Dataset_CreateOrUpdateDataset", + "x-ms-examples": { + "Datasets_Create": { + "$ref": "./examples/Datasets_Create.json" + }, + "Datasets_Update": { + "$ref": "./examples/Datasets_Update.json" + } + }, + "description": "Creates or updates a dataset.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/datasetName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the dataset entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." + }, + { + "name": "dataset", + "description": "Dataset resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DatasetResource" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/DatasetResource" + } + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "datasets" + ], + "operationId": "Dataset_GetDataset", + "x-ms-examples": { + "Datasets_Get": { + "$ref": "./examples/Datasets_Get.json" + } + }, + "description": "Gets a dataset.", + "parameters": [ + { + "$ref": "#/parameters/datasetName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the dataset entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/DatasetResource" + } + }, + "304": { + "description": "Not modified." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "datasets" + ], + "operationId": "Dataset_DeleteDataset", + "x-ms-examples": { + "Datasets_Delete": { + "$ref": "./examples/Datasets_Delete.json" + } + }, + "description": "Deletes a dataset.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/datasetName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/datasets/{datasetName}/rename": { + "post": { + "tags": [ + "datasets" + ], + "operationId": "Dataset_RenameDataset", + "x-ms-examples": { + "Datasets_Rename": { + "$ref": "./examples/Datasets_Rename.json" + } + }, + "description": "Renames a dataset.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/datasetName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "request", + "description": "proposed new name.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArtifactRenameRequest" + } + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/pipelines": { + "get": { + "tags": [ + "pipelines" + ], + "operationId": "Pipeline_GetPipelinesByWorkspace", + "x-ms-examples": { + "Pipelines_ListByWorkspace": { + "$ref": "./examples/Pipelines_ListByWorkspace.json" + } + }, + "description": "Lists pipelines.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/PipelineListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/pipelines/{pipelineName}": { + "put": { + "tags": [ + "pipelines" + ], + "operationId": "Pipeline_CreateOrUpdatePipeline", + "x-ms-examples": { + "Pipelines_Create": { + "$ref": "./examples/Pipelines_Create.json" + }, + "Pipelines_Update": { + "$ref": "./examples/Pipelines_Update.json" + } + }, + "description": "Creates or updates a pipeline.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/pipelineName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the pipeline entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." + }, + { + "name": "pipeline", + "description": "Pipeline resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PipelineResource" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/PipelineResource" + } + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "pipelines" + ], + "operationId": "Pipeline_GetPipeline", + "x-ms-examples": { + "Pipelines_Get": { + "$ref": "./examples/Pipelines_Get.json" + } + }, + "description": "Gets a pipeline.", + "parameters": [ + { + "$ref": "#/parameters/pipelineName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the pipeline entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/PipelineResource" + } + }, + "304": { + "description": "Not modified." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "pipelines" + ], + "operationId": "Pipeline_DeletePipeline", + "x-ms-examples": { + "Pipelines_Delete": { + "$ref": "./examples/Pipelines_Delete.json" + } + }, + "description": "Deletes a pipeline.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/pipelineName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/pipelines/{pipelineName}/rename": { + "post": { + "tags": [ + "pipelines" + ], + "operationId": "Pipeline_RenamePipeline", + "x-ms-examples": { + "Pipelines_Rename": { + "$ref": "./examples/Pipelines_Rename.json" + } + }, + "description": "Renames a pipeline.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/pipelineName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "request", + "description": "proposed new name.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArtifactRenameRequest" + } + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/pipelines/{pipelineName}/createRun": { + "post": { + "tags": [ + "pipelines" + ], + "operationId": "Pipeline_CreatePipelineRun", + "x-ms-examples": { + "Pipelines_CreateRun": { + "$ref": "./examples/Pipelines_CreateRun.json" + } + }, + "description": "Creates a run of a pipeline.", + "parameters": [ + { + "$ref": "#/parameters/pipelineName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "referencePipelineRunId", + "description": "The pipeline run identifier. If run ID is specified the parameters of the specified run will be used to create a new run.", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "isRecovery", + "description": "Recovery mode flag. If recovery mode is set to true, the specified referenced pipeline run and the new run will be grouped under the same groupId.", + "in": "query", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method" + }, + { + "name": "startActivityName", + "description": "In recovery mode, the rerun will start from this activity. If not specified, all activities will run.", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "parameters", + "description": "Parameters of the pipeline run. These parameters will be used only if the runId is not specified.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ParameterValueSpecification" + } + } + ], + "responses": { + "202": { + "description": "Accepted.", + "schema": { + "$ref": "#/definitions/CreateRunResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/queryPipelineRuns": { + "post": { + "operationId": "PipelineRun_QueryPipelineRunsByWorkspace", + "x-ms-examples": { + "PipelineRuns_QueryByWorkspace": { + "$ref": "./examples/PipelineRuns_QueryByWorkspace.json" + } + }, + "description": "Query pipeline runs in the workspace based on input filter conditions.", + "tags": [ + "pipelineruns" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "filterParameters", + "description": "Parameters to filter the pipeline run.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunFilterParameters" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/PipelineRunsQueryResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/pipelineruns/{runId}": { + "get": { + "operationId": "PipelineRun_GetPipelineRun", + "x-ms-examples": { + "PipelineRuns_Get": { + "$ref": "./examples/PipelineRuns_Get.json" + } + }, + "description": "Get a pipeline run by its run ID.", + "tags": [ + "pipelineruns" + ], + "parameters": [ + { + "$ref": "#/parameters/runId" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/PipelineRun" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/pipelines/{pipelineName}/pipelineruns/{runId}/queryActivityruns": { + "post": { + "operationId": "PipelineRun_QueryActivityRuns", + "x-ms-examples": { + "ActivityRuns_QueryByPipelineRun": { + "$ref": "./examples/ActivityRuns_QueryByPipelineRun.json" + } + }, + "description": "Query activity runs based on input filter conditions.", + "tags": [ + "activityruns" + ], + "parameters": [ + { + "$ref": "#/parameters/pipelineName" + }, + { + "$ref": "#/parameters/runId" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "filterParameters", + "description": "Parameters to filter the activity runs.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunFilterParameters" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/ActivityRunsQueryResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/pipelineruns/{runId}/cancel": { + "post": { + "operationId": "PipelineRun_CancelPipelineRun", + "x-ms-examples": { + "PipelineRuns_Cancel": { + "$ref": "./examples/PipelineRuns_Cancel.json" + } + }, + "description": "Cancel a pipeline run by its run ID.", + "tags": [ + "pipelineruns" + ], + "parameters": [ + { + "$ref": "#/parameters/runId" + }, + { + "name": "isRecursive", + "description": "If true, cancel all the Child pipelines that are triggered by the current pipeline.", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Pipeline run has been canceled successfully. " + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/triggers": { + "get": { + "tags": [ + "triggers" + ], + "operationId": "Trigger_GetTriggersByWorkspace", + "x-ms-examples": { + "Triggers_ListByWorkspace": { + "$ref": "./examples/Triggers_ListByWorkspace.json" + } + }, + "description": "Lists triggers.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/TriggerListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/triggers/{triggerName}": { + "put": { + "tags": [ + "triggers" + ], + "operationId": "Trigger_CreateOrUpdateTrigger", + "x-ms-examples": { + "Triggers_Create": { + "$ref": "./examples/Triggers_Create.json" + }, + "Triggers_Update": { + "$ref": "./examples/Triggers_Update.json" + } + }, + "description": "Creates or updates a trigger.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the trigger entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." + }, + { + "name": "trigger", + "description": "Trigger resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TriggerResource" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/TriggerResource" + } + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "trigger" + ], + "operationId": "Trigger_GetTrigger", + "x-ms-examples": { + "Triggers_Get": { + "$ref": "./examples/Triggers_Get.json" + } + }, + "description": "Gets a trigger.", + "parameters": [ + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the trigger entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/TriggerResource" + } + }, + "304": { + "description": "Not modified." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "triggers" + ], + "operationId": "Trigger_DeleteTrigger", + "x-ms-examples": { + "Triggers_Delete": { + "$ref": "./examples/Triggers_Delete.json" + } + }, + "description": "Deletes a trigger.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/triggers/{triggerName}/subscribeToEvents": { + "post": { + "tags": [ + "triggers" + ], + "operationId": "Trigger_SubscribeTriggerToEvents", + "x-ms-examples": { + "Triggers_SubscribeToEvents": { + "$ref": "./examples/Triggers_SubscribeToEvents.json" + } + }, + "description": "Subscribe event trigger to events.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Trigger is subscribed to events.", + "schema": { + "$ref": "#/definitions/TriggerSubscriptionOperationStatus" + } + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/triggers/{triggerName}/getEventSubscriptionStatus": { + "post": { + "tags": [ + "triggers" + ], + "operationId": "Trigger_GetEventSubscriptionStatus", + "x-ms-examples": { + "Triggers_GetEventSubscriptionStatus": { + "$ref": "./examples/Triggers_GetEventSubscriptionStatus.json" + } + }, + "description": "Get a trigger's event subscription status.", + "parameters": [ + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Trigger event subscription state.", + "schema": { + "$ref": "#/definitions/TriggerSubscriptionOperationStatus" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/triggers/{triggerName}/unsubscribeFromEvents": { + "post": { + "tags": [ + "triggers" + ], + "operationId": "Trigger_UnsubscribeTriggerFromEvents", + "x-ms-examples": { + "Triggers_UnsubscribeFromEvents": { + "$ref": "./examples/Triggers_UnsubscribeFromEvents.json" + } + }, + "description": "Unsubscribe event trigger from events.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Trigger is unsubscribed from events.", + "schema": { + "$ref": "#/definitions/TriggerSubscriptionOperationStatus" + } + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/triggers/{triggerName}/start": { + "post": { + "tags": [ + "triggers" + ], + "operationId": "Trigger_StartTrigger", + "x-ms-examples": { + "Triggers_Start": { + "$ref": "./examples/Triggers_Start.json" + } + }, + "description": "Starts a trigger.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Trigger has been started successfully." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/triggers/{triggerName}/stop": { + "post": { + "tags": [ + "triggers" + ], + "operationId": "Trigger_StopTrigger", + "x-ms-examples": { + "Triggers_Stop": { + "$ref": "./examples/Triggers_Stop.json" + } + }, + "description": "Stops a trigger.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Trigger has been stopped successfully." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/triggers/{triggerName}/triggerRuns/{runId}/rerun": { + "post": { + "tags": [ + "triggerruns" + ], + "operationId": "TriggerRun_RerunTriggerInstance", + "x-ms-examples": { + "Triggers_Rerun": { + "$ref": "./examples/TriggerRuns_Rerun.json" + } + }, + "description": "Rerun single trigger instance by runId.", + "parameters": [ + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/runId" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "TriggerRun has been restarted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/triggers/{triggerName}/triggerRuns/{runId}/cancel": { + "post": { + "tags": [ + "triggerruns" + ], + "operationId": "TriggerRun_CancelTriggerInstance", + "x-ms-examples": { + "Triggers_Rerun": { + "$ref": "./examples/TriggerRuns_Cancel.json" + } + }, + "description": "Cancel single trigger instance by runId.", + "parameters": [ + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/runId" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "TriggerRun has been cancelled." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/queryTriggerRuns": { + "post": { + "tags": [ + "triggerruns" + ], + "operationId": "TriggerRun_QueryTriggerRunsByWorkspace", + "x-ms-examples": { + "TriggerRuns_QueryByWorkspace": { + "$ref": "./examples/TriggerRuns_QueryByWorkspace.json" + } + }, + "description": "Query trigger runs.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "filterParameters", + "description": "Parameters to filter the pipeline run.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunFilterParameters" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/TriggerRunsQueryResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/dataflows/{dataFlowName}": { + "put": { + "tags": [ + "dataFlows" + ], + "operationId": "DataFlow_CreateOrUpdateDataFlow", + "x-ms-examples": { + "DataFlows_Create": { + "$ref": "./examples/DataFlows_Create.json" + }, + "DataFlows_Update": { + "$ref": "./examples/DataFlows_Update.json" + } + }, + "description": "Creates or updates a data flow.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/dataFlowName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the data flow entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." + }, + { + "name": "dataFlow", + "description": "Data flow resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataFlowResource" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/DataFlowResource" + } + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "dataFlows" + ], + "operationId": "DataFlow_GetDataFlow", + "x-ms-examples": { + "DataFlows_Get": { + "$ref": "./examples/DataFlows_Get.json" + } + }, + "description": "Gets a data flow.", + "parameters": [ + { + "$ref": "#/parameters/dataFlowName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the data flow entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/DataFlowResource" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "dataFlows" + ], + "operationId": "DataFlow_DeleteDataFlow", + "x-ms-examples": { + "DataFlows_Delete": { + "$ref": "./examples/DataFlows_Delete.json" + } + }, + "description": "Deletes a data flow.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/dataFlowName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/dataflows/{dataFlowName}/rename": { + "post": { + "tags": [ + "dataflows" + ], + "operationId": "DataFlow_RenameDataFlow", + "x-ms-examples": { + "DataFlows_Rename": { + "$ref": "./examples/DataFlows_Rename.json" + } + }, + "description": "Renames a dataflow.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/dataFlowName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "request", + "description": "proposed new name.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArtifactRenameRequest" + } + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/dataflows": { + "get": { + "tags": [ + "dataFlows" + ], + "operationId": "DataFlow_GetDataFlowsByWorkspace", + "x-ms-examples": { + "DataFlows_ListByWorkspace": { + "$ref": "./examples/DataFlows_ListByWorkspace.json" + } + }, + "description": "Lists data flows.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/DataFlowListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/createDataFlowDebugSession": { + "post": { + "tags": [ + "dataFlowDebugSession" + ], + "operationId": "DataFlowDebugSession_CreateDataFlowDebugSession", + "x-ms-examples": { + "DataFlowDebugSession_Create": { + "$ref": "./examples/DataFlowDebugSession_Create.json" + } + }, + "description": "Creates a data flow debug session.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "request", + "description": "Data flow debug session definition", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CreateDataFlowDebugSessionRequest" + } + } + ], + "responses": { + "202": { + "description": "Accepted.", + "headers": { + "location": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/CreateDataFlowDebugSessionResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/queryDataFlowDebugSessions": { + "post": { + "tags": [ + "dataFlowDebugSession" + ], + "operationId": "DataFlowDebugSession_QueryDataFlowDebugSessionsByWorkspace", + "x-ms-examples": { + "DataFlowDebugSession_QueryByWorkspace": { + "$ref": "./examples/DataFlowDebugSession_QueryByWorkspace.json" + } + }, + "description": "Query all active data flow debug sessions.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/QueryDataFlowDebugSessionsResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/addDataFlowToDebugSession": { + "post": { + "tags": [ + "dataFlowDebugSession" + ], + "operationId": "DataFlowDebugSession_AddDataFlow", + "x-ms-examples": { + "DataFlowDebugSession_AddDataFlow": { + "$ref": "./examples/DataFlowDebugSession_AddDataFlow.json" + } + }, + "description": "Add a data flow into debug session.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "request", + "description": "Data flow debug session definition with debug content.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataFlowDebugPackage" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/AddDataFlowToDebugSessionResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/deleteDataFlowDebugSession": { + "post": { + "tags": [ + "dataFlowDebugSession" + ], + "operationId": "DataFlowDebugSession_DeleteDataFlowDebugSession", + "x-ms-examples": { + "DataFlowDebugSession_Delete": { + "$ref": "./examples/DataFlowDebugSession_Delete.json" + } + }, + "description": "Deletes a data flow debug session.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "request", + "description": "Data flow debug session definition for deletion", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DeleteDataFlowDebugSessionRequest" + } + } + ], + "responses": { + "200": { + "description": "OK." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/executeDataFlowDebugCommand": { + "post": { + "tags": [ + "dataFlowDebugSession" + ], + "operationId": "DataFlowDebugSession_ExecuteCommand", + "x-ms-examples": { + "DataFlowDebugSession_ExecuteCommand": { + "$ref": "./examples/DataFlowDebugSession_ExecuteCommand.json" + } + }, + "description": "Execute a data flow debug command.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "request", + "description": "Data flow debug command definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataFlowDebugCommandRequest" + } + } + ], + "responses": { + "202": { + "description": "Accepted.", + "headers": { + "location": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/DataFlowDebugCommandResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/sqlScripts": { + "get": { + "tags": [ + "sqlScripts" + ], + "operationId": "SqlScript_GetSqlScriptsByWorkspace", + "x-ms-examples": { + "SqlScripts_ListByWorkspace": { + "$ref": "./examples/SqlScripts_ListByWorkspace.json" + } + }, + "description": "Lists sql scripts.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SqlScriptsListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/sqlScripts/{sqlScriptName}": { + "put": { + "tags": [ + "sqlScripts" + ], + "operationId": "SqlScript_CreateOrUpdateSqlScript", + "x-ms-examples": { + "SqlScripts_Create": { + "$ref": "./examples/SqlScripts_Create.json" + }, + "SqlScripts_Update": { + "$ref": "./examples/SqlScripts_Update.json" + } + }, + "description": "Creates or updates a Sql Script.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/sqlScriptName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the SQL script entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." + }, + { + "name": "sqlScript", + "description": "Sql Script resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SqlScriptResource" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SqlScriptResource" + } + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "sqlScripts" + ], + "operationId": "SqlScript_GetSqlScript", + "x-ms-examples": { + "SqlScripts_Get": { + "$ref": "./examples/SqlScripts_Get.json" + } + }, + "description": "Gets a sql script.", + "parameters": [ + { + "$ref": "#/parameters/sqlScriptName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the sql compute entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SqlScriptResource" + } + }, + "304": { + "description": "Not modified." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "sqlScripts" + ], + "operationId": "SqlScript_DeleteSqlScript", + "x-ms-examples": { + "SqlScripts_Delete": { + "$ref": "./examples/SqlScripts_Delete.json" + } + }, + "description": "Deletes a Sql Script.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/sqlScriptName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/sqlScripts/{sqlScriptName}/rename": { + "post": { + "tags": [ + "sqlScripts" + ], + "operationId": "SqlScript_RenameSqlScript", + "x-ms-examples": { + "SqlScripts_Rename": { + "$ref": "./examples/SqlScripts_Rename.json" + } + }, + "description": "Renames a sqlScript.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/sqlScriptName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "request", + "description": "proposed new name.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArtifactRenameRequest" + } + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/sparkJobDefinitions": { + "get": { + "tags": [ + "sparkJobDefinitions" + ], + "operationId": "SparkJobDefinition_GetSparkJobDefinitionsByWorkspace", + "x-ms-examples": { + "SparkJobDefinitions_ListByWorkspace": { + "$ref": "./examples/SparkJobDefinitions_ListByWorkspace.json" + } + }, + "description": "Lists spark job definitions.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SparkJobDefinitionsListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/sparkJobDefinitions/{sparkJobDefinitionName}": { + "put": { + "tags": [ + "sparkJobDefinitions" + ], + "operationId": "SparkJobDefinition_CreateOrUpdateSparkJobDefinition", + "x-ms-examples": { + "SparkJobDefinitions_Create": { + "$ref": "./examples/SparkJobDefinitions_Create.json" + }, + "SparkJobDefinitions_Update": { + "$ref": "./examples/SparkJobDefinitions_Update.json" + } + }, + "description": "Creates or updates a Spark Job Definition.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/sparkJobDefinitionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the Spark Job Definition entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." + }, + { + "name": "sparkJobDefinition", + "description": "Spark Job Definition resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SparkJobDefinitionResource" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SparkJobDefinitionResource" + } + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "sparkJobDefinitions" + ], + "operationId": "SparkJobDefinition_GetSparkJobDefinition", + "x-ms-examples": { + "SparkJobDefinitions_Get": { + "$ref": "./examples/SparkJobDefinitions_Get.json" + } + }, + "description": "Gets a Spark Job Definition.", + "parameters": [ + { + "$ref": "#/parameters/sparkJobDefinitionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the Spark Job Definition entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SparkJobDefinitionResource" + } + }, + "304": { + "description": "Not modified." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "sparkJobDefinitions" + ], + "operationId": "SparkJobDefinition_DeleteSparkJobDefinition", + "x-ms-examples": { + "SparkJobDefinitions_Delete": { + "$ref": "./examples/SparkJobDefinitions_Delete.json" + } + }, + "description": "Deletes a Spark Job Definition.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/sparkJobDefinitionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/sparkJobDefinitions/{sparkJobDefinitionName}/execute": { + "post": { + "tags": [ + "sparkJobDefinitions" + ], + "operationId": "SparkJobDefinition_ExecuteSparkJobDefinition", + "x-ms-examples": { + "SparkJobDefinitions_Execute": { + "$ref": "./examples/SparkJobDefinitions_Execute.json" + } + }, + "description": "Executes the spark job definition.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "#/parameters/sparkJobDefinitionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted.", + "schema": { + "$ref": "./sparkJob.json#/definitions/SparkBatchJob" + } + }, + "200": { + "description": "OK.", + "schema": { + "$ref": "./sparkJob.json#/definitions/SparkBatchJob" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/sparkJobDefinitions/{sparkJobDefinitionName}/rename": { + "post": { + "tags": [ + "sparkJobDefinitions" + ], + "operationId": "SparkJobDefinition_RenameSparkJobDefinition", + "x-ms-examples": { + "SparkJobDefinitions_Rename": { + "$ref": "./examples/SparkJobDefinitions_Rename.json" + } + }, + "description": "Renames a sparkJobDefinition.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/sparkJobDefinitionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "request", + "description": "proposed new name.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArtifactRenameRequest" + } + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/debugSparkJobDefinition": { + "post": { + "tags": [ + "sparkJobDefinitions" + ], + "operationId": "SparkJobDefinition_DebugSparkJobDefinition", + "x-ms-examples": { + "SparkJobDefinitions_Debug": { + "$ref": "./examples/SparkJobDefinitions_Debug.json" + } + }, + "description": "Debug the spark job definition.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "sparkJobDefinitionAzureResource", + "description": "Spark Job Definition resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SparkJobDefinitionResource" + } + } + ], + "responses": { + "202": { + "description": "Accepted.", + "schema": { + "$ref": "./sparkJob.json#/definitions/SparkBatchJob" + } + }, + "200": { + "description": "OK.", + "schema": { + "$ref": "./sparkJob.json#/definitions/SparkBatchJob" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/notebooks": { + "get": { + "tags": [ + "notebooks" + ], + "operationId": "Notebook_GetNotebooksByWorkspace", + "x-ms-examples": { + "Notebooks_ListByWorkspace": { + "$ref": "./examples/Notebooks_ListByWorkspace.json" + } + }, + "description": "Lists Notebooks.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/NotebookListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/notebooksSummary": { + "get": { + "tags": [ + "notebooks" + ], + "operationId": "Notebook_GetNotebookSummaryByWorkSpace", + "x-ms-examples": { + "Notebooks_ListSummaryByWorkSpace": { + "$ref": "./examples/Notebooks_ListSummaryByWorkSpace.json" + } + }, + "description": "Lists a summary of Notebooks.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/NotebookListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/notebooks/{notebookName}": { + "put": { + "tags": [ + "notebooks" + ], + "operationId": "Notebook_CreateOrUpdateNotebook", + "x-ms-examples": { + "Notebooks_Create": { + "$ref": "./examples/Notebooks_Create.json" + }, + "Notebooks_Update": { + "$ref": "./examples/Notebooks_Update.json" + } + }, + "description": "Creates or updates a Note Book.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/NotebookName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the Note book entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." + }, + { + "name": "Notebook", + "description": "Note book resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NotebookResource" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/NotebookResource" + } + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "notebooks" + ], + "operationId": "Notebook_GetNotebook", + "x-ms-examples": { + "Notebooks_Get": { + "$ref": "./examples/Notebooks_Get.json" + } + }, + "description": "Gets a Note Book.", + "parameters": [ + { + "$ref": "#/parameters/NotebookName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the Notebook entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/NotebookResource" + } + }, + "304": { + "description": "Not modified." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "notebooks" + ], + "operationId": "Notebook_DeleteNotebook", + "x-ms-examples": { + "Notebooks_Delete": { + "$ref": "./examples/Notebooks_Delete.json" + } + }, + "description": "Deletes a Note book.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/NotebookName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/notebooks/{notebookName}/rename": { + "post": { + "tags": [ + "notebooks" + ], + "operationId": "Notebook_RenameNotebook", + "x-ms-examples": { + "Notebooks_Rename": { + "$ref": "./examples/Notebooks_Rename.json" + } + }, + "description": "Renames a notebook.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/NotebookName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "request", + "description": "proposed new name.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArtifactRenameRequest" + } + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/notebookOperationResults/{operationId}": { + "get": { + "tags": [ + "OperationResult" + ], + "operationId": "NotebookOperationResult_Get", + "description": "Get notebook operation result", + "x-ms-examples": { + "List Sql Pools": { + "$ref": "./examples/NotebookOperationResult_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "Operation ID." + } + ], + "responses": { + "200": { + "description": "" + }, + "201": { + "description": "" + }, + "202": { + "description": "" + }, + "204": { + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + }, + "description": "" + } + } + } + } + }, + "definitions": { + "SubResource": { + "description": "Azure Synapse nested resource, which belongs to a workspace.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/AzureEntityResource" + } + ] + }, + "SubResourceDebugResource": { + "description": "Azure Synapse nested debug resource.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The resource name." + } + } + }, + "Expression": { + "description": "Azure Synapse expression definition.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Expression type.", + "enum": [ + "Expression" + ], + "x-ms-enum": { + "name": "ExpressionType", + "modelAsString": true + } + }, + "value": { + "type": "string", + "description": "Expression value." + } + }, + "required": [ + "type", + "value" + ] + }, + "SecureString": { + "x-ms-discriminator-value": "SecureString", + "description": "Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecretBase" + } + ], + "properties": { + "value": { + "type": "string", + "description": "Value of secure string." + } + }, + "required": [ + "value" + ] + }, + "AzureKeyVaultSecretReference": { + "x-ms-discriminator-value": "AzureKeyVaultSecret", + "description": "Azure Key Vault secret reference.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecretBase" + } + ], + "properties": { + "store": { + "description": "The Azure Key Vault linked service reference.", + "$ref": "#/definitions/LinkedServiceReference" + }, + "secretName": { + "type": "object", + "description": "The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string)." + }, + "secretVersion": { + "type": "object", + "description": "The version of the secret in Azure Key Vault. The default value is the latest version of the secret. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "store", + "secretName" + ] + }, + "SecretBase": { + "description": "The base definition of a secret type.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of the secret." + } + }, + "required": [ + "type" + ] + }, + "IntegrationRuntimeReference": { + "description": "Integration runtime reference type.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of integration runtime.", + "enum": [ + "IntegrationRuntimeReference" + ], + "x-ms-enum": { + "name": "IntegrationRuntimeReferenceType", + "modelAsString": true + } + }, + "referenceName": { + "type": "string", + "description": "Reference integration runtime name." + }, + "parameters": { + "$ref": "#/definitions/ParameterValueSpecification", + "description": "Arguments for integration runtime." + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "LinkedServiceListResponse": { + "description": "A list of linked service resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of linked services.", + "items": { + "$ref": "#/definitions/LinkedServiceResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "DatasetListResponse": { + "description": "A list of dataset resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of datasets.", + "items": { + "$ref": "#/definitions/DatasetResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "PipelineListResponse": { + "description": "A list of pipeline resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of pipelines.", + "items": { + "$ref": "#/definitions/PipelineResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "TriggerListResponse": { + "description": "A list of trigger resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of triggers.", + "items": { + "$ref": "#/definitions/TriggerResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "DataFlowListResponse": { + "description": "A list of data flow resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of data flows.", + "items": { + "$ref": "#/definitions/DataFlowResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "CreateDataFlowDebugSessionRequest": { + "description": "Request body structure for creating data flow debug session.", + "type": "object", + "properties": { + "dataFlowName": { + "description": "The name of the data flow.", + "type": "string" + }, + "existingClusterId": { + "description": "The ID of existing Databricks cluster.", + "type": "string" + }, + "clusterTimeout": { + "description": "Timeout setting for Databricks cluster.", + "type": "integer" + }, + "newClusterName": { + "description": "The name of new Databricks cluster.", + "type": "string" + }, + "newClusterNodeType": { + "description": "The type of new Databricks cluster.", + "type": "string" + }, + "dataBricksLinkedService": { + "description": "Data bricks linked service.", + "$ref": "#/definitions/LinkedServiceResource" + } + } + }, + "CreateDataFlowDebugSessionResponse": { + "description": "Response body structure for creating data flow debug session.", + "type": "object", + "properties": { + "sessionId": { + "description": "The ID of data flow debug session.", + "type": "string" + } + } + }, + "StartDataFlowDebugSessionRequest": { + "description": "Request body structure for starting data flow debug session.", + "type": "object", + "properties": { + "sessionId": { + "description": "The ID of data flow debug session.", + "type": "string" + }, + "dataFlow": { + "description": "Data flow instance.", + "$ref": "#/definitions/DataFlowResource" + }, + "datasets": { + "type": "array", + "description": "List of datasets.", + "items": { + "$ref": "#/definitions/DatasetResource" + } + }, + "linkedServices": { + "type": "array", + "description": "List of linked services.", + "items": { + "$ref": "#/definitions/LinkedServiceResource" + } + }, + "staging": { + "description": "Staging info for debug session.", + "type": "object" + }, + "debugSettings": { + "description": "Data flow debug settings.", + "type": "object" + }, + "incrementalDebug": { + "description": "The type of new Databricks cluster.", + "type": "boolean" + } + } + }, + "StartDataFlowDebugSessionResponse": { + "description": "Response body structure for starting data flow debug session.", + "type": "object", + "properties": { + "jobVersion": { + "description": "The ID of data flow debug job version.", + "type": "string" + } + } + }, + "DeleteDataFlowDebugSessionRequest": { + "description": "Request body structure for deleting data flow debug session.", + "type": "object", + "properties": { + "sessionId": { + "description": "The ID of data flow debug session.", + "type": "string" + }, + "dataFlowName": { + "description": "The data flow which contains the debug session.", + "type": "string" + } + } + }, + "DataFlowDebugPreviewDataRequest": { + "description": "Request body structure for data flow preview data.", + "type": "object", + "properties": { + "sessionId": { + "description": "The ID of data flow debug session.", + "type": "string" + }, + "dataFlowName": { + "description": "The data flow which contains the debug session.", + "type": "string" + }, + "streamName": { + "description": "The output stream name.", + "type": "string" + }, + "rowLimits": { + "description": "The row limit for preview request.", + "type": "integer" + } + } + }, + "DataFlowDebugStatisticsRequest": { + "description": "Request body structure for data flow statistics.", + "type": "object", + "properties": { + "sessionId": { + "description": "The ID of data flow debug session.", + "type": "string" + }, + "dataFlowName": { + "description": "The data flow which contains the debug session.", + "type": "string" + }, + "streamName": { + "description": "The output stream name.", + "type": "string" + }, + "columns": { + "type": "array", + "description": "List of column names.", + "items": { + "type": "string" + } + } + } + }, + "EvaluateDataFlowExpressionRequest": { + "description": "Request body structure for data flow expression preview.", + "type": "object", + "properties": { + "sessionId": { + "description": "The ID of data flow debug session.", + "type": "string" + }, + "dataFlowName": { + "description": "The data flow which contains the debug session.", + "type": "string" + }, + "streamName": { + "description": "The output stream name.", + "type": "string" + }, + "rowLimits": { + "description": "The row limit for preview request.", + "type": "integer" + }, + "expression": { + "description": "The expression for preview.", + "type": "string" + } + } + }, + "DataFlowDebugCommandRequest": { + "description": "Request body structure for data flow expression preview.", + "type": "object", + "properties": { + "sessionId": { + "description": "The ID of data flow debug session.", + "type": "string" + }, + "dataFlowName": { + "description": "The data flow which contains the debug session.", + "type": "string" + }, + "commandName": { + "description": "The command name.", + "type": "string" + }, + "commandPayload": { + "description": "The command payload object.", + "type": "object" + } + }, + "required": [ + "sessionId", + "commandPayload" + ] + }, + "DataFlowDebugQueryResponse": { + "description": "Response body structure of data flow query for data preview, statistics or expression preview.", + "type": "object", + "properties": { + "runId": { + "description": "The run ID of data flow debug session.", + "type": "string" + } + } + }, + "DataFlowDebugResultResponse": { + "description": "Response body structure of data flow result for data preview, statistics or expression preview.", + "type": "object", + "properties": { + "status": { + "description": "The run status of data preview, statistics or expression preview.", + "type": "string" + }, + "data": { + "description": "The result data of data preview, statistics or expression preview.", + "type": "string" + } + } + }, + "QueryDataFlowDebugSessionsResponse": { + "description": "A list of active debug sessions.", + "type": "object", + "properties": { + "value": { + "description": "Array with all active debug sessions.", + "type": "array", + "items": { + "$ref": "#/definitions/DataFlowDebugSessionInfo" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "DataFlowDebugSessionInfo": { + "description": "Data flow debug session info.", + "type": "object", + "properties": { + "dataFlowName": { + "description": "The name of the data flow.", + "type": "string" + }, + "computeType": { + "description": "Compute type of the cluster.", + "type": "string" + }, + "coreCount": { + "description": "Core count of the cluster.", + "type": "integer" + }, + "nodeCount": { + "description": "Node count of the cluster. (deprecated property)", + "type": "integer" + }, + "integrationRuntimeName": { + "description": "Attached integration runtime name of data flow debug session.", + "type": "string" + }, + "sessionId": { + "description": "The ID of data flow debug session.", + "type": "string" + }, + "startTime": { + "description": "Start time of data flow debug session.", + "type": "string" + }, + "timeToLiveInMinutes": { + "description": "Compute type of the cluster.", + "type": "integer" + }, + "lastActivityTime": { + "description": "Last activity time of data flow debug session.", + "type": "string" + } + }, + "additionalProperties": { + "type": "object" + } + }, + "CreateRunResponse": { + "description": "Response body with a run identifier.", + "type": "object", + "properties": { + "runId": { + "description": "Identifier of a run.", + "type": "string" + } + }, + "required": [ + "runId" + ] + }, + "CloudError": { + "x-ms-external": true, + "description": "The object that defines the structure of an Azure Synapse error response.", + "type": "object", + "properties": { + "error": { + "x-ms-client-flatten": true, + "description": "Error data", + "$ref": "#/definitions/CloudErrorBody" + } + }, + "required": [ + "error" + ] + }, + "CloudErrorBody": { + "x-ms-external": true, + "description": "The object that defines the structure of an Azure Synapse error.", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Error message.", + "type": "string" + }, + "target": { + "description": "Property name/path in request associated with error.", + "type": "string" + }, + "details": { + "description": "Array with additional error details.", + "type": "array", + "items": { + "$ref": "#/definitions/CloudError" + } + } + }, + "required": [ + "code", + "message" + ] + }, + "TriggerDependencyProvisioningStatus": { + "description": "Defines the response of a provision trigger dependency operation.", + "type": "object", + "properties": { + "triggerName": { + "description": "Trigger name.", + "type": "string" + }, + "provisioningStatus": { + "description": "Provisioning status.", + "type": "string" + } + }, + "required": [ + "triggerName", + "provisioningStatus" + ] + }, + "VariableDefinitionSpecification": { + "description": "Definition of variable for a Pipeline.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/VariableSpecification" + } + }, + "VariableSpecification": { + "description": "Definition of a single variable for a Pipeline.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Variable type.", + "enum": [ + "String", + "Bool", + "Boolean", + "Array" + ], + "x-ms-enum": { + "name": "VariableType", + "modelAsString": true + } + }, + "defaultValue": { + "type": "object", + "description": "Default value of variable." + } + }, + "required": [ + "type" + ] + }, + "ParameterDefinitionSpecification": { + "description": "Definition of all parameters for an entity.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ParameterSpecification" + } + }, + "ParameterSpecification": { + "description": "Definition of a single parameter for an entity.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Parameter type.", + "enum": [ + "Object", + "String", + "Int", + "Float", + "Bool", + "Array", + "SecureString" + ], + "x-ms-enum": { + "name": "ParameterType", + "modelAsString": true + } + }, + "defaultValue": { + "type": "object", + "description": "Default value of parameter." + } + }, + "required": [ + "type" + ] + }, + "ParameterValueSpecification": { + "description": "An object mapping parameter names to argument values.", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "PipelineResource": { + "description": "Pipeline resource type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "./entityTypes/Pipeline.json#/definitions/Pipeline", + "description": "Properties of the pipeline." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "properties" + ] + }, + "PipelineReference": { + "description": "Pipeline reference type.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Pipeline reference type.", + "enum": [ + "PipelineReference" + ], + "x-ms-enum": { + "name": "PipelineReferenceType", + "modelAsString": true + } + }, + "referenceName": { + "type": "string", + "description": "Reference pipeline name." + }, + "name": { + "type": "string", + "description": "Reference name." + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "TriggerPipelineReference": { + "description": "Pipeline that needs to be triggered with the given parameters.", + "type": "object", + "properties": { + "pipelineReference": { + "description": "Pipeline reference.", + "$ref": "#/definitions/PipelineReference" + }, + "parameters": { + "description": "Pipeline parameters.", + "$ref": "#/definitions/ParameterValueSpecification" + } + } + }, + "TriggerResource": { + "description": "Trigger resource type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "./entityTypes/Trigger.json#/definitions/Trigger", + "description": "Properties of the trigger." + } + }, + "required": [ + "properties" + ] + }, + "TriggerSubscriptionOperationStatus": { + "description": "Defines the response of a trigger subscription operation.", + "type": "object", + "properties": { + "triggerName": { + "description": "Trigger name.", + "type": "string", + "readOnly": true + }, + "status": { + "type": "string", + "enum": [ + "Enabled", + "Provisioning", + "Deprovisioning", + "Disabled", + "Unknown" + ], + "x-ms-enum": { + "name": "EventSubscriptionStatus", + "modelAsString": true + }, + "description": "Event Subscription Status.", + "readOnly": true + } + } + }, + "WorkspaceUpdateParameters": { + "description": "Parameters for updating a workspace resource.", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + }, + "identity": { + "$ref": "#/definitions/WorkspaceIdentity", + "description": "Managed service identity of the workspace." + } + } + }, + "WorkspaceIdentity": { + "description": "Identity properties of the workspace resource.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The identity type. Currently the only supported type is 'SystemAssigned'.", + "enum": [ + "SystemAssigned" + ], + "x-ms-enum": { + "name": "WorkspaceIdentityType", + "modelAsString": false + } + }, + "principalId": { + "type": "string", + "readOnly": true, + "description": "The principal id of the identity." + }, + "tenantId": { + "type": "string", + "readOnly": true, + "description": "The client tenant id of the identity." + } + }, + "required": [ + "type" + ] + }, + "DatasetReference": { + "description": "Dataset reference type.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Dataset reference type.", + "enum": [ + "DatasetReference" + ], + "x-ms-enum": { + "name": "DatasetReferenceType", + "modelAsString": true + } + }, + "referenceName": { + "type": "string", + "description": "Reference dataset name." + }, + "parameters": { + "$ref": "#/definitions/ParameterValueSpecification", + "description": "Arguments for dataset." + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "DatasetResource": { + "description": "Dataset resource type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "./entityTypes/Dataset.json#/definitions/Dataset", + "description": "Dataset properties." + } + }, + "required": [ + "properties" + ] + }, + "DatasetDebugResource": { + "description": "Dataset debug resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResourceDebugResource" + } + ], + "properties": { + "properties": { + "$ref": "./entityTypes/Dataset.json#/definitions/Dataset", + "description": "Dataset properties." + } + }, + "required": [ + "properties" + ] + }, + "LinkedServiceReference": { + "description": "Linked service reference type.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Linked service reference type.", + "enum": [ + "LinkedServiceReference" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": true + } + }, + "referenceName": { + "type": "string", + "description": "Reference LinkedService name." + }, + "parameters": { + "$ref": "#/definitions/ParameterValueSpecification", + "description": "Arguments for LinkedService." + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "LinkedServiceResource": { + "description": "Linked service resource type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "./entityTypes/LinkedService.json#/definitions/LinkedService", + "description": "Properties of linked service." + } + }, + "required": [ + "properties" + ] + }, + "LinkedServiceDebugResource": { + "description": "Linked service debug resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResourceDebugResource" + } + ], + "properties": { + "properties": { + "$ref": "./entityTypes/LinkedService.json#/definitions/LinkedService", + "description": "Properties of linked service." + } + }, + "required": [ + "properties" + ] + }, + "SqlScriptsListResponse": { + "description": "A list of sql scripts resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of sql scripts.", + "items": { + "$ref": "#/definitions/SqlScriptResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "SqlScriptResource": { + "description": "Sql Script resource type.", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" + }, + "name": { + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + }, + "properties": { + "$ref": "./entityTypes/SqlScript.json#/definitions/SqlScript", + "description": "Properties of sql script." + } + }, + "required": [ + "name", + "properties" + ] + }, + "SparkJobDefinitionsListResponse": { + "description": "A list of spark job definitions resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of spark job definitions.", + "items": { + "$ref": "#/definitions/SparkJobDefinitionResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "SparkJobDefinitionResource": { + "description": "Spark job definition resource type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "./entityTypes/SparkJobDefinition.json#/definitions/SparkJobDefinition", + "description": "Properties of spark job definition." + } + }, + "required": [ + "properties" + ] + }, + "NotebookListResponse": { + "description": "A list of Notebook resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of Notebooks.", + "items": { + "$ref": "#/definitions/NotebookResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "NotebookResource": { + "description": "Notebook resource type.", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" + }, + "name": { + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + }, + "properties": { + "$ref": "./entityTypes/Notebook.json#/definitions/Notebook", + "description": "Properties of Notebook." + } + }, + "required": [ + "name", + "properties" + ] + }, + "DataFlowResource": { + "description": "Data flow resource type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "./entityTypes/DataFlow.json#/definitions/DataFlow", + "description": "Data flow properties." + } + }, + "required": [ + "properties" + ] + }, + "DataFlowReference": { + "description": "Data flow reference type.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Data flow reference type.", + "enum": [ + "DataFlowReference" + ], + "x-ms-enum": { + "name": "DataFlowReferenceType", + "modelAsString": true + } + }, + "referenceName": { + "type": "string", + "description": "Reference data flow name." + }, + "datasetParameters": { + "type": "object", + "description": "Reference data flow parameters from dataset." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type", + "referenceName" + ] + }, + "DataFlowStagingInfo": { + "description": "Staging info for execute data flow activity.", + "type": "object", + "properties": { + "linkedService": { + "description": "Staging linked service reference.", + "$ref": "#/definitions/LinkedServiceReference" + }, + "folderPath": { + "description": "Folder path for staging blob.", + "type": "string" + } + } + }, + "DataFlowDebugPackage": { + "description": "Request body structure for starting data flow debug session.", + "type": "object", + "properties": { + "sessionId": { + "description": "The ID of data flow debug session.", + "type": "string" + }, + "dataFlow": { + "description": "Data flow instance.", + "$ref": "#/definitions/DataFlowDebugResource" + }, + "datasets": { + "type": "array", + "description": "List of datasets.", + "items": { + "$ref": "#/definitions/DatasetDebugResource" + } + }, + "linkedServices": { + "type": "array", + "description": "List of linked services.", + "items": { + "$ref": "#/definitions/LinkedServiceDebugResource" + } + }, + "staging": { + "description": "Staging info for debug session.", + "$ref": "#/definitions/DataFlowStagingInfo" + }, + "debugSettings": { + "description": "Data flow debug settings.", + "type": "object", + "properties": { + "sourceSettings": { + "type": "array", + "description": "Source setting for data flow debug.", + "items": { + "$ref": "#/definitions/DataFlowSourceSetting" + } + }, + "parameters": { + "description": "Data flow parameters.", + "$ref": "#/definitions/ParameterValueSpecification" + }, + "datasetParameters": { + "description": "Parameters for dataset.", + "type": "object" + } + } + } + }, + "additionalProperties": { + "type": "object" + } + }, + "DataFlowSourceSetting": { + "description": "Definition of data flow source setting for debug.", + "type": "object", + "properties": { + "sourceName": { + "description": "The data flow source name.", + "type": "string" + }, + "rowLimit": { + "description": "Defines the row limit of data flow source in debug.", + "type": "integer" + } + }, + "additionalProperties": { + "type": "object" + } + }, + "DataFlowDebugResource": { + "description": "Data flow debug resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResourceDebugResource" + } + ], + "properties": { + "properties": { + "$ref": "./entityTypes/DataFlow.json#/definitions/DataFlow", + "description": "Data flow properties." + } + }, + "required": [ + "properties" + ] + }, + "AddDataFlowToDebugSessionResponse": { + "description": "Response body structure for starting data flow debug session.", + "type": "object", + "properties": { + "jobVersion": { + "description": "The ID of data flow debug job version.", + "type": "string" + } + } + }, + "DataFlowDebugCommandResponse": { + "description": "Response body structure of data flow result for data preview, statistics or expression preview.", + "type": "object", + "properties": { + "status": { + "description": "The run status of data preview, statistics or expression preview.", + "type": "string" + }, + "data": { + "description": "The result data of data preview, statistics or expression preview.", + "type": "string" + } + } + }, + "RunFilterParameters": { + "description": "Query parameters for listing runs.", + "type": "object", + "properties": { + "continuationToken": { + "description": "The continuation token for getting the next page of results. Null for first page.", + "type": "string" + }, + "lastUpdatedAfter": { + "description": "The time at or after which the run event was updated in 'ISO 8601' format.", + "type": "string", + "format": "date-time" + }, + "lastUpdatedBefore": { + "description": "The time at or before which the run event was updated in 'ISO 8601' format.", + "type": "string", + "format": "date-time" + }, + "filters": { + "type": "array", + "description": "List of filters.", + "items": { + "$ref": "#/definitions/RunQueryFilter" + } + }, + "orderBy": { + "type": "array", + "description": "List of OrderBy option.", + "items": { + "$ref": "#/definitions/RunQueryOrderBy" + } + } + }, + "required": [ + "lastUpdatedAfter", + "lastUpdatedBefore" + ] + }, + "RunQueryFilter": { + "description": "Query filter option for listing runs.", + "type": "object", + "properties": { + "operand": { + "description": "Parameter name to be used for filter. The allowed operands to query pipeline runs are PipelineName, RunStart, RunEnd and Status; to query activity runs are ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType and Status, and to query trigger runs are TriggerName, TriggerRunTimestamp and Status.", + "type": "string", + "enum": [ + "PipelineName", + "Status", + "RunStart", + "RunEnd", + "ActivityName", + "ActivityRunStart", + "ActivityRunEnd", + "ActivityType", + "TriggerName", + "TriggerRunTimestamp", + "RunGroupId", + "LatestOnly" + ], + "x-ms-enum": { + "name": "RunQueryFilterOperand", + "modelAsString": true + } + }, + "operator": { + "description": "Operator to be used for filter.", + "type": "string", + "enum": [ + "Equals", + "NotEquals", + "In", + "NotIn" + ], + "x-ms-enum": { + "name": "RunQueryFilterOperator", + "modelAsString": true + } + }, + "values": { + "type": "array", + "description": "List of filter values.", + "items": { + "type": "string" + } + } + }, + "required": [ + "operand", + "operator", + "values" + ] + }, + "RunQueryOrderBy": { + "description": "An object to provide order by options for listing runs.", + "type": "object", + "properties": { + "orderBy": { + "description": "Parameter name to be used for order by. The allowed parameters to order by for pipeline runs are PipelineName, RunStart, RunEnd and Status; for activity runs are ActivityName, ActivityRunStart, ActivityRunEnd and Status; for trigger runs are TriggerName, TriggerRunTimestamp and Status.", + "type": "string", + "enum": [ + "RunStart", + "RunEnd", + "PipelineName", + "Status", + "ActivityName", + "ActivityRunStart", + "ActivityRunEnd", + "TriggerName", + "TriggerRunTimestamp" + ], + "x-ms-enum": { + "name": "RunQueryOrderByField", + "modelAsString": true + } + }, + "order": { + "description": "Sorting order of the parameter.", + "type": "string", + "enum": [ + "ASC", + "DESC" + ], + "x-ms-enum": { + "name": "RunQueryOrder", + "modelAsString": true + } + } + }, + "required": [ + "orderBy", + "order" + ] + }, + "PipelineRunsQueryResponse": { + "description": "A list pipeline runs.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of pipeline runs.", + "items": { + "$ref": "#/definitions/PipelineRun" + } + }, + "continuationToken": { + "description": "The continuation token for getting the next page of results, if any remaining results exist, null otherwise.", + "type": "string" + } + } + }, + "PipelineRun": { + "description": "Information about a pipeline run.", + "type": "object", + "properties": { + "runId": { + "description": "Identifier of a run.", + "type": "string", + "readOnly": true + }, + "runGroupId": { + "description": "Identifier that correlates all the recovery runs of a pipeline run.", + "type": "string", + "readOnly": true + }, + "isLatest": { + "description": "Indicates if the recovered pipeline run is the latest in its group.", + "type": "boolean", + "readOnly": true + }, + "pipelineName": { + "description": "The pipeline name.", + "type": "string", + "readOnly": true + }, + "parameters": { + "description": "The full or partial list of parameter name, value pair used in the pipeline run.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "invokedBy": { + "description": "Entity that started the pipeline run.", + "$ref": "#/definitions/PipelineRunInvokedBy", + "readOnly": true + }, + "lastUpdated": { + "description": "The last updated timestamp for the pipeline run event in ISO8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "runStart": { + "description": "The start time of a pipeline run in ISO8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "runEnd": { + "description": "The end time of a pipeline run in ISO8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true + }, + "durationInMs": { + "description": "The duration of a pipeline run.", + "type": "integer", + "readOnly": true + }, + "status": { + "description": "The status of a pipeline run.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The message from a pipeline run.", + "type": "string", + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "PipelineRunInvokedBy": { + "description": "Provides entity name and id that started the pipeline run.", + "type": "object", + "properties": { + "name": { + "description": "Name of the entity that started the pipeline run.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "The ID of the entity that started the run.", + "type": "string", + "readOnly": true + }, + "invokedByType": { + "description": "The type of the entity that started the run.", + "type": "string", + "readOnly": true + } + } + }, + "ActivityRunsQueryResponse": { + "description": "A list activity runs.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of activity runs.", + "items": { + "$ref": "#/definitions/ActivityRun" + } + }, + "continuationToken": { + "description": "The continuation token for getting the next page of results, if any remaining results exist, null otherwise.", + "type": "string" + } + } + }, + "ActivityRun": { + "description": "Information about an activity run in a pipeline.", + "type": "object", + "properties": { + "pipelineName": { + "description": "The name of the pipeline.", + "type": "string", + "readOnly": true + }, + "pipelineRunId": { + "description": "The id of the pipeline run.", + "type": "string", + "readOnly": true + }, + "activityName": { + "description": "The name of the activity.", + "type": "string", + "readOnly": true + }, + "activityType": { + "description": "The type of the activity.", + "type": "string", + "readOnly": true + }, + "activityRunId": { + "description": "The id of the activity run.", + "type": "string", + "readOnly": true + }, + "linkedServiceName": { + "description": "The name of the compute linked service.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The status of the activity run.", + "type": "string", + "readOnly": true + }, + "activityRunStart": { + "description": "The start time of the activity run in 'ISO 8601' format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "activityRunEnd": { + "description": "The end time of the activity run in 'ISO 8601' format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "durationInMs": { + "description": "The duration of the activity run.", + "type": "integer", + "readOnly": true + }, + "input": { + "description": "The input for the activity.", + "type": "object", + "readOnly": true + }, + "output": { + "description": "The output for the activity.", + "type": "object", + "readOnly": true + }, + "error": { + "description": "The error if any from the activity run.", + "type": "object", + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "TriggerRunsQueryResponse": { + "description": "A list of trigger runs.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of trigger runs.", + "items": { + "$ref": "#/definitions/TriggerRun" + } + }, + "continuationToken": { + "description": "The continuation token for getting the next page of results, if any remaining results exist, null otherwise.", + "type": "string" + } + } + }, + "TriggerRun": { + "description": "Trigger runs.", + "type": "object", + "properties": { + "triggerRunId": { + "type": "string", + "description": "Trigger run id.", + "readOnly": true + }, + "triggerName": { + "type": "string", + "description": "Trigger name.", + "readOnly": true + }, + "triggerType": { + "type": "string", + "description": "Trigger type.", + "readOnly": true + }, + "triggerRunTimestamp": { + "type": "string", + "format": "date-time", + "description": "Trigger run start time.", + "readOnly": true + }, + "status": { + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Inprogress" + ], + "x-ms-enum": { + "name": "TriggerRunStatus", + "modelAsString": true + }, + "description": "Trigger run status.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Trigger error message.", + "readOnly": true + }, + "properties": { + "description": "List of property name and value related to trigger run. Name, value pair depends on type of trigger.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "triggeredPipelines": { + "description": "List of pipeline name and run Id triggered by the trigger run.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "RerunTumblingWindowTriggerActionParameters": { + "description": "Rerun tumbling window trigger Parameters.", + "type": "object", + "properties": { + "startTime": { + "description": "The start time for the time period for which restatement is initiated. Only UTC time is currently supported.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The end time for the time period for which restatement is initiated. Only UTC time is currently supported.", + "type": "string", + "format": "date-time" + }, + "maxConcurrency": { + "description": "The max number of parallel time windows (ready for execution) for which a rerun is triggered.", + "type": "integer", + "minimum": 1, + "maximum": 50 + } + }, + "required": [ + "startTime", + "endTime", + "maxConcurrency" + ] + }, + "RerunTriggerListResponse": { + "description": "A list of rerun triggers.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of rerun triggers.", + "items": { + "$ref": "#/definitions/RerunTriggerResource" + } + }, + "nextLink": { + "description": "The continuation token for getting the next page of results, if any remaining results exist, null otherwise.", + "type": "string", + "readOnly": true + } + } + }, + "RerunTriggerResource": { + "description": "RerunTrigger resource type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "./entityTypes/Trigger.json#/definitions/RerunTumblingWindowTrigger", + "description": "Properties of the rerun trigger." + } + }, + "required": [ + "properties" + ] + }, + "GetSsisObjectMetadataRequest": { + "type": "object", + "description": "The request payload of get SSIS object metadata.", + "properties": { + "metadataPath": { + "type": "string", + "description": "Metadata path." + } + } + }, + "SsisObjectMetadataStatusResponse": { + "type": "object", + "description": "The status of the operation.", + "properties": { + "status": { + "type": "string", + "description": "The status of the operation." + }, + "name": { + "type": "string", + "description": "The operation name." + }, + "properties": { + "type": "string", + "description": "The operation properties." + }, + "error": { + "type": "string", + "description": "The operation error message." + } + } + }, + "ExposureControlRequest": { + "type": "object", + "description": "The exposure control request.", + "properties": { + "featureName": { + "type": "string", + "description": "The feature name." + }, + "featureType": { + "type": "string", + "description": "The feature type." + } + } + }, + "ExposureControlResponse": { + "type": "object", + "description": "The exposure control response.", + "properties": { + "featureName": { + "type": "string", + "description": "The feature name.", + "readOnly": true + }, + "value": { + "type": "string", + "description": "The feature value.", + "readOnly": true + } + } + }, + "SynapseNotebookReference": { + "description": "Synapse notebook reference type.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Synapse notebook reference type.", + "enum": [ + "NotebookReference" + ], + "x-ms-enum": { + "name": "NotebookReferenceType", + "modelAsString": true + } + }, + "referenceName": { + "type": "string", + "description": "Reference notebook name." + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "SynapseSparkJobReference": { + "description": "Synapse spark job reference type.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Synapse spark job reference type.", + "enum": [ + "SparkJobDefinitionReference" + ], + "x-ms-enum": { + "name": "SparkJobReferenceType", + "modelAsString": true + } + }, + "referenceName": { + "type": "string", + "description": "Reference spark job name." + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "SqlPoolReference": { + "description": "SQL pool reference type.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "SQL pool reference type.", + "enum": [ + "SqlPoolReference" + ], + "x-ms-enum": { + "name": "SqlPoolReferenceType", + "modelAsString": true + } + }, + "referenceName": { + "type": "string", + "description": "Reference SQL pool name." + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "ArtifactRenameRequest": { + "description": "Request body structure for rename artifact.", + "type": "object", + "properties": { + "newName": { + "description": "New name of the artifact.", + "type": "string", + "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", + "minLength": 1, + "maxLength": 260 + } + } + } + }, + "parameters": { + "workspaceName": { + "name": "workspaceName", + "description": "The workspace name.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "sqlScriptName": { + "name": "sqlScriptName", + "description": "The sql script name.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "sparkJobDefinitionName": { + "name": "sparkJobDefinitionName", + "description": "The spark job definition name.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "NotebookName": { + "name": "notebookName", + "description": "The notebook name.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "locationId": { + "name": "locationId", + "description": "The location identifier.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "linkedServiceName": { + "name": "linkedServiceName", + "description": "The linked service name.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", + "minLength": 1, + "maxLength": 260, + "x-ms-parameter-location": "method" + }, + "datasetName": { + "name": "datasetName", + "description": "The dataset name.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", + "minLength": 1, + "maxLength": 260, + "x-ms-parameter-location": "method" + }, + "pipelineName": { + "name": "pipelineName", + "description": "The pipeline name.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", + "minLength": 1, + "maxLength": 260, + "x-ms-parameter-location": "method" + }, + "dataFlowName": { + "name": "dataFlowName", + "description": "The data flow name.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", + "minLength": 1, + "maxLength": 260, + "x-ms-parameter-location": "method" + }, + "triggerName": { + "name": "triggerName", + "description": "The trigger name.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", + "minLength": 1, + "maxLength": 260, + "x-ms-parameter-location": "method" + }, + "rerunTriggerName": { + "name": "rerunTriggerName", + "description": "The rerun trigger name.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", + "minLength": 1, + "maxLength": 260, + "x-ms-parameter-location": "method" + }, + "runId": { + "name": "runId", + "description": "The pipeline run identifier.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "sessionId": { + "name": "sessionId", + "description": "The data flow session identifier.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "jobVersion": { + "name": "jobVersion", + "description": "The data flow job version identifier.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "nodeName": { + "name": "nodeName", + "description": "The integration runtime node name.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z0-9A-Z][a-z0-9A-Z_-]{0,149}$", + "minLength": 1, + "maxLength": 150, + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Synapse client API Version." + }, + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/bigDataPools.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/bigDataPools.json new file mode 100644 index 000000000000..edfc339c3ac3 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/bigDataPools.json @@ -0,0 +1,123 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-12-01", + "title": "ArtifactsClient" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/bigDataPools": { + "get": { + "tags": [ + "BigDataPools" + ], + "operationId": "BigDataPools_List", + "description": "List Big Data Pools", + "x-ms-examples": { + "List Big Data Pools": { + "$ref": "./examples/BigDataPools_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success response.", + "schema": { + "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/bigDataPool.json#/definitions/BigDataPoolResourceInfoListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + } + } + } + } + }, + "/bigDataPools/{bigDataPoolName}": { + "get": { + "tags": [ + "BigDataPools" + ], + "operationId": "BigDataPools_Get", + "description": "Get Big Data Pool", + "x-ms-examples": { + "Get Big Data Pool": { + "$ref": "./examples/BigDataPools_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/BigDataPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Success response.", + "schema": { + "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/bigDataPool.json#/definitions/BigDataPoolResourceInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + } + } + } + } + } + }, + "definitions": {}, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Synapse client API Version." + }, + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "BigDataPoolNameParameter": { + "name": "bigDataPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The Big Data Pool name", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/checkAccessSynapseRbac.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/checkAccessSynapseRbac.json new file mode 100644 index 000000000000..14974cf286f8 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/checkAccessSynapseRbac.json @@ -0,0 +1,217 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-12-01", + "title": "AccessControlClient" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "paths": { + "/checkAccessSynapseRbac": { + "post": { + "tags": [ + "CheckPrincipalAccess" + ], + "operationId": "RoleAssignments_CheckPrincipalAccess", + "description": "Check if the given principalId has access to perform list of actions at a given scope.", + "x-ms-examples": { + "Check access": { + "$ref": "./examples/CheckAccessSynapseRbac.json" + } + }, + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "request", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "description": "Details of scope, list of actions and principal.", + "schema": { + "$ref": "#/definitions/CheckPrincipalAccessRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success response.", + "schema": { + "$ref": "#/definitions/CheckPrincipalAccessResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + } + } + } + } + } + }, + "definitions": { + "CheckPrincipalAccessRequest": { + "description": "Check access request details", + "type": "object", + "required": [ + "scope", + "actions", + "subject" + ], + "properties": { + "subject": { + "description": "Subject details", + "type": "object", + "$ref": "#/definitions/SubjectInfo" + }, + "actions": { + "description": "List of actions.", + "type": "array", + "items": { + "$ref": "#/definitions/RequiredAction" + } + }, + "scope": { + "description": "Scope at which the check access is done.", + "type": "string" + } + } + }, + "RequiredAction": { + "description": "Action Info", + "type": "object", + "required": [ + "id", + "isDataAction" + ], + "properties": { + "id": { + "description": "Action Id.", + "type": "string" + }, + "isDataAction": { + "description": "Is a data action or not.", + "type": "boolean" + } + } + }, + "CheckPrincipalAccessResponse": { + "description": "Check access response details", + "type": "object", + "properties": { + "accessDecisions": { + "description": "To check if the current user, group, or service principal has permission to read artifacts in the specified workspace.", + "type": "array", + "items": { + "$ref": "#/definitions/CheckAccessDecision" + } + } + } + }, + "SubjectInfo": { + "description": "Subject details", + "type": "object", + "required": [ + "principalId" + ], + "properties": { + "principalId": { + "description": "Principal Id", + "format": "uuid", + "type": "string" + }, + "groupIds": { + "description": "List of group Ids that the principalId is part of.", + "type": "array", + "items": { + "format": "uuid", + "type": "string" + } + } + } + }, + "CheckAccessDecision": { + "description": "Check access response details", + "type": "object", + "properties": { + "accessDecision": { + "description": "Access Decision.", + "type": "string" + }, + "actionId": { + "description": "Action Id.", + "type": "string" + }, + "roleAssignment": { + "$ref": "#/definitions/RoleAssignmentDetails" + } + } + }, + "RoleAssignmentDetails": { + "description": "Role Assignment response details", + "type": "object", + "properties": { + "id": { + "description": "Role Assignment ID", + "type": "string" + }, + "roleDefinitionId": { + "description": "Role ID of the Synapse Built-In Role", + "format": "uuid", + "type": "string" + }, + "principalId": { + "description": "Object ID of the AAD principal or security-group", + "format": "uuid", + "type": "string" + }, + "scope": { + "description": "Scope at the role assignment is created", + "type": "string" + }, + "principalType": { + "description": "Type of the principal Id: User, Group or ServicePrincipal", + "type": "string" + } + } + } + }, + "parameters": { + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Synapse client API Version." + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/DataFlow.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/DataFlow.json new file mode 100644 index 000000000000..81ac8486dd71 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/DataFlow.json @@ -0,0 +1,156 @@ +{ + "swagger": "2.0", + "info": { + "title": "ArtifactsClient", + "version": "2020-12-01" + }, + "paths": {}, + "definitions": { + "DataFlow": { + "description": "Azure Synapse nested object which contains a flow with data movements and transformations.", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Type of data flow." + }, + "description": { + "description": "The description of the data flow.", + "type": "string" + }, + "annotations": { + "description": "List of tags that can be used for describing the data flow.", + "type": "array", + "items": { + "type": "object" + } + }, + "folder": { + "description": "The folder that this data flow is in. If not specified, Data flow will appear at the root level.", + "type": "object", + "properties": { + "name": { + "description": "The name of the folder that this data flow is in.", + "type": "string" + } + } + } + }, + "required": [ + "type" + ] + }, + "MappingDataFlow": { + "x-ms-discriminator-value": "MappingDataFlow", + "description": "Mapping data flow.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataFlow" + } + ], + "properties": { + "typeProperties": { + "description": "Mapping data flow type properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MappingDataFlowTypeProperties" + } + } + }, + "MappingDataFlowTypeProperties": { + "description": "Mapping data flow type properties.", + "type": "object", + "properties": { + "sources": { + "type": "array", + "description": "List of sources in data flow.", + "items": { + "$ref": "#/definitions/DataFlowSource" + } + }, + "sinks": { + "type": "array", + "description": "List of sinks in data flow.", + "items": { + "$ref": "#/definitions/DataFlowSink" + } + }, + "transformations": { + "type": "array", + "description": "List of transformations in data flow.", + "items": { + "$ref": "#/definitions/Transformation" + } + }, + "script": { + "type": "string", + "description": "DataFlow script." + } + } + }, + "Transformation": { + "description": "A data flow transformation.", + "type": "object", + "properties": { + "name": { + "description": "Transformation name.", + "type": "string" + }, + "description": { + "description": "Transformation description.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "DataFlowSource": { + "description": "Transformation for data flow source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Transformation" + } + ], + "properties": { + "dataset": { + "description": "Dataset reference.", + "$ref": "../artifacts.json#/definitions/DatasetReference" + }, + "linkedService": { + "description": "Linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "schemaLinkedService": { + "description": "Schema linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + } + } + }, + "DataFlowSink": { + "description": "Transformation for data flow sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Transformation" + } + ], + "properties": { + "dataset": { + "description": "Dataset reference.", + "$ref": "../artifacts.json#/definitions/DatasetReference" + }, + "linkedService": { + "description": "Linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "schemaLinkedService": { + "description": "Schema linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json new file mode 100644 index 000000000000..1d6fa89f4f35 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json @@ -0,0 +1,3397 @@ +{ + "swagger": "2.0", + "info": { + "title": "ArtifactsClient", + "version": "2020-12-01" + }, + "paths": {}, + "definitions": { + "Dataset": { + "description": "The Azure Data Factory nested object which identifies data within different data stores, such as tables, files, folders, and documents.", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Type of dataset." + }, + "description": { + "description": "Dataset description.", + "type": "string" + }, + "structure": { + "type": "object", + "description": "Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement." + }, + "schema": { + "type": "object", + "description": "Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement." + }, + "linkedServiceName": { + "description": "Linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "parameters": { + "$ref": "../artifacts.json#/definitions/ParameterDefinitionSpecification", + "description": "Parameters for dataset." + }, + "annotations": { + "description": "List of tags that can be used for describing the Dataset.", + "type": "array", + "items": { + "type": "object" + } + }, + "folder": { + "description": "The folder that this Dataset is in. If not specified, Dataset will appear at the root level.", + "type": "object", + "properties": { + "name": { + "description": "The name of the folder that this Dataset is in.", + "type": "string" + } + } + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type", + "linkedServiceName" + ] + }, + "DatasetLocation": { + "description": "Dataset location.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of dataset storage location." + }, + "folderPath": { + "type": "object", + "description": "Specify the folder path of dataset. Type: string (or Expression with resultType string)" + }, + "fileName": { + "type": "object", + "description": "Specify the file name of dataset. Type: string (or Expression with resultType string)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "AzureBlobStorageLocation": { + "description": "The location of azure blob dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetLocation" + } + ], + "properties": { + "container": { + "type": "object", + "description": "Specify the container of azure blob. Type: string (or Expression with resultType string)." + } + } + }, + "AzureBlobFSLocation": { + "description": "The location of azure blobFS dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetLocation" + } + ], + "properties": { + "fileSystem": { + "type": "object", + "description": "Specify the fileSystem of azure blobFS. Type: string (or Expression with resultType string)." + } + } + }, + "AzureDataLakeStoreLocation": { + "description": "The location of azure data lake store dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetLocation" + } + ] + }, + "AmazonS3Location": { + "description": "The location of amazon S3 dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetLocation" + } + ], + "properties": { + "bucketName": { + "type": "object", + "description": "Specify the bucketName of amazon S3. Type: string (or Expression with resultType string)" + }, + "version": { + "type": "object", + "description": "Specify the version of amazon S3. Type: string (or Expression with resultType string)." + } + } + }, + "FileServerLocation": { + "description": "The location of file server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetLocation" + } + ] + }, + "AzureFileStorageLocation": { + "description": "The location of file server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetLocation" + } + ] + }, + "GoogleCloudStorageLocation": { + "description": "The location of Google Cloud Storage dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetLocation" + } + ], + "properties": { + "bucketName": { + "type": "object", + "description": "Specify the bucketName of Google Cloud Storage. Type: string (or Expression with resultType string)" + }, + "version": { + "type": "object", + "description": "Specify the version of Google Cloud Storage. Type: string (or Expression with resultType string)." + } + } + }, + "FtpServerLocation": { + "description": "The location of ftp server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetLocation" + } + ] + }, + "SftpLocation": { + "description": "The location of SFTP dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetLocation" + } + ] + }, + "HttpServerLocation": { + "description": "The location of http server.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetLocation" + } + ], + "properties": { + "relativeUrl": { + "type": "object", + "description": "Specify the relativeUrl of http server. Type: string (or Expression with resultType string)" + } + } + }, + "HdfsLocation": { + "description": "The location of HDFS.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetLocation" + } + ] + }, + "DatasetDataElement": { + "description": "Columns that define the structure of the dataset.", + "type": "object", + "properties": { + "name": { + "type": "object", + "description": "Name of the column. Type: string (or Expression with resultType string)." + }, + "type": { + "type": "object", + "description": "Type of the column. Type: string (or Expression with resultType string)." + } + } + }, + "DatasetSchemaDataElement": { + "description": "Columns that define the physical type schema of the dataset.", + "type": "object", + "properties": { + "name": { + "type": "object", + "description": "Name of the schema column. Type: string (or Expression with resultType string)." + }, + "type": { + "type": "object", + "description": "Type of the schema column. Type: string (or Expression with resultType string)." + } + }, + "additionalProperties": { + "type": "object" + } + }, + "DatasetStorageFormat": { + "discriminator": "type", + "description": "The format definition of a storage.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of dataset storage format." + }, + "serializer": { + "type": "object", + "description": "Serializer. Type: string (or Expression with resultType string)." + }, + "deserializer": { + "type": "object", + "description": "Deserializer. Type: string (or Expression with resultType string)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "TextFormat": { + "description": "The data stored in text format.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetStorageFormat" + } + ], + "properties": { + "columnDelimiter": { + "type": "object", + "description": "The column delimiter. Type: string (or Expression with resultType string)." + }, + "rowDelimiter": { + "type": "object", + "description": "The row delimiter. Type: string (or Expression with resultType string)." + }, + "escapeChar": { + "type": "object", + "description": "The escape character. Type: string (or Expression with resultType string)." + }, + "quoteChar": { + "type": "object", + "description": "The quote character. Type: string (or Expression with resultType string)." + }, + "nullValue": { + "type": "object", + "description": "The null value string. Type: string (or Expression with resultType string)." + }, + "encodingName": { + "type": "object", + "description": "The code page name of the preferred encoding. If miss, the default value is ΓÇ£utf-8ΓÇ¥, unless BOM denotes another Unicode encoding. Refer to the ΓÇ£NameΓÇ¥ column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string)." + }, + "treatEmptyAsNull": { + "type": "object", + "description": "Treat empty column values in the text file as null. The default value is true. Type: boolean (or Expression with resultType boolean)." + }, + "skipLineCount": { + "type": "object", + "description": "The number of lines/rows to be skipped when parsing text files. The default value is 0. Type: integer (or Expression with resultType integer)." + }, + "firstRowAsHeader": { + "type": "object", + "description": "When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "JsonFormat": { + "description": "The data stored in JSON format.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetStorageFormat" + } + ], + "properties": { + "filePattern": { + "description": "File pattern of JSON. To be more specific, the way of separating a collection of JSON objects. The default value is 'setOfObjects'. It is case-sensitive.", + "$ref": "#/definitions/JsonFormatFilePattern" + }, + "nestingSeparator": { + "type": "object", + "description": "The character used to separate nesting levels. Default value is '.' (dot). Type: string (or Expression with resultType string)." + }, + "encodingName": { + "type": "object", + "description": "The code page name of the preferred encoding. If not provided, the default value is 'utf-8', unless the byte order mark (BOM) denotes another Unicode encoding. The full list of supported values can be found in the 'Name' column of the table of encodings in the following reference: https://go.microsoft.com/fwlink/?linkid=861078. Type: string (or Expression with resultType string)." + }, + "jsonNodeReference": { + "type": "object", + "description": "The JSONPath of the JSON array element to be flattened. Example: \"$.ArrayPath\". Type: string (or Expression with resultType string)." + }, + "jsonPathDefinition": { + "type": "object", + "description": "The JSONPath definition for each column mapping with a customized column name to extract data from JSON file. For fields under root object, start with \"$\"; for fields inside the array chosen by jsonNodeReference property, start from the array element. Example: {\"Column1\": \"$.Column1Path\", \"Column2\": \"Column2PathInArray\"}. Type: object (or Expression with resultType object)." + } + } + }, + "JsonFormatFilePattern": { + "description": "JSON format file pattern. A property of JsonFormat.", + "type": "string", + "enum": [ + "setOfObjects", + "arrayOfObjects" + ], + "x-ms-enum": { + "name": "JsonFormatFilePattern", + "modelAsString": true + } + }, + "AvroFormat": { + "description": "The data stored in Avro format.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetStorageFormat" + } + ] + }, + "OrcFormat": { + "description": "The data stored in Optimized Row Columnar (ORC) format.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetStorageFormat" + } + ] + }, + "ParquetFormat": { + "description": "The data stored in Parquet format.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetStorageFormat" + } + ] + }, + "DatasetCompression": { + "discriminator": "type", + "description": "The compression method used on a dataset.", + "type": "object", + "properties": { + "type": { + "type": "object", + "description": "Type of dataset compression. Type: string (or Expression with resultType string)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "DatasetBZip2Compression": { + "x-ms-discriminator-value": "BZip2", + "description": "The BZip2 compression method used on a dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetCompression" + } + ], + "properties": {} + }, + "DatasetGZipCompression": { + "x-ms-discriminator-value": "GZip", + "description": "The GZip compression method used on a dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetCompression" + } + ], + "properties": { + "level": { + "description": "The GZip compression level.", + "$ref": "#/definitions/CompressionLevel" + } + } + }, + "DatasetDeflateCompression": { + "x-ms-discriminator-value": "Deflate", + "description": "The Deflate compression method used on a dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetCompression" + } + ], + "properties": { + "level": { + "description": "The Deflate compression level.", + "$ref": "#/definitions/CompressionLevel" + } + } + }, + "DatasetZipDeflateCompression": { + "x-ms-discriminator-value": "ZipDeflate", + "description": "The ZipDeflate compression method used on a dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetCompression" + } + ], + "properties": { + "level": { + "description": "The ZipDeflate compression level.", + "$ref": "#/definitions/CompressionLevel" + } + } + }, + "DatasetTarCompression": { + "x-ms-discriminator-value": "Tar", + "description": "The Tar archive method used on a dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetCompression" + } + ], + "properties": {} + }, + "DatasetTarGZipCompression": { + "x-ms-discriminator-value": "TarGZip", + "description": "The TarGZip compression method used on a dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetCompression" + } + ], + "properties": { + "level": { + "description": "The TarGZip compression level.", + "$ref": "#/definitions/CompressionLevel" + } + } + }, + "CompressionLevel": { + "title": "Microsoft.Azure.Management.DataFactories.Models.CompressionLevel", + "description": "All available compression levels.", + "type": "object" + }, + "DatasetCompressionLevelEnum": { + "type": "string", + "enum": [ + "Optimal", + "Fastest" + ], + "x-ms-enum": { + "name": "DatasetCompressionLevel", + "modelAsString": true + } + }, + "AmazonS3Dataset": { + "x-ms-discriminator-value": "AmazonS3Object", + "description": "A single Amazon Simple Storage Service (S3) object or a set of S3 objects.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Amazon S3 dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AmazonS3DatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AmazonS3DatasetTypeProperties": { + "description": "Amazon S3 dataset properties.", + "type": "object", + "properties": { + "bucketName": { + "type": "object", + "description": "The name of the Amazon S3 bucket. Type: string (or Expression with resultType string)." + }, + "key": { + "type": "object", + "description": "The key of the Amazon S3 object. Type: string (or Expression with resultType string)." + }, + "prefix": { + "type": "object", + "description": "The prefix filter for the S3 object name. Type: string (or Expression with resultType string)." + }, + "version": { + "type": "object", + "description": "The version for the S3 object. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of S3 object's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of S3 object's modified datetime. Type: string (or Expression with resultType string)." + }, + "format": { + "description": "The format of files.", + "$ref": "#/definitions/DatasetStorageFormat" + }, + "compression": { + "description": "The data compression method used for the Amazon S3 object.", + "$ref": "#/definitions/DatasetCompression" + } + }, + "required": [ + "bucketName" + ] + }, + "AvroDataset": { + "x-ms-discriminator-value": "Avro", + "description": "Avro dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Avro dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AvroDatasetTypeProperties" + } + } + }, + "AvroDatasetTypeProperties": { + "description": "Avro dataset properties.", + "type": "object", + "properties": { + "location": { + "$ref": "#/definitions/DatasetLocation", + "description": "The location of the avro storage." + }, + "avroCompressionCodec": { + "type": "object", + "description": "A string from AvroCompressionCodecEnum or an expression" + }, + "avroCompressionLevel": { + "type": "integer", + "minimum": 1, + "maximum": 9 + } + }, + "required": [ + "location" + ] + }, + "AvroCompressionCodecEnum": { + "type": "string", + "enum": [ + "none", + "deflate", + "snappy", + "xz", + "bzip2" + ], + "x-ms-enum": { + "name": "AvroCompressionCodec", + "modelAsString": true + } + }, + "ExcelDataset": { + "x-ms-discriminator-value": "Excel", + "description": "Excel dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Excel dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExcelDatasetTypeProperties" + } + } + }, + "ExcelDatasetTypeProperties": { + "description": "Excel dataset properties.", + "type": "object", + "properties": { + "location": { + "$ref": "#/definitions/DatasetLocation", + "description": "The location of the excel storage." + }, + "sheetName": { + "type": "object", + "description": "The sheet of excel file. Type: string (or Expression with resultType string)." + }, + "range": { + "type": "object", + "description": "The partial data of one sheet. Type: string (or Expression with resultType string)." + }, + "firstRowAsHeader": { + "type": "object", + "description": "When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean)." + }, + "compression": { + "description": "The data compression method used for the json dataset.", + "$ref": "#/definitions/DatasetCompression" + }, + "nullValue": { + "type": "object", + "description": "The null value string. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "location", + "sheetName" + ] + }, + "ParquetDataset": { + "x-ms-discriminator-value": "Parquet", + "description": "Parquet dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Parquet dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ParquetDatasetTypeProperties" + } + } + }, + "ParquetDatasetTypeProperties": { + "description": "Parquet dataset properties.", + "type": "object", + "properties": { + "location": { + "$ref": "#/definitions/DatasetLocation", + "description": "The location of the parquet storage." + }, + "compressionCodec": { + "type": "object", + "description": "A string from ParquetCompressionCodecEnum or an expression" + } + }, + "required": [ + "location" + ] + }, + "ParquetCompressionCodecEnum": { + "type": "string", + "enum": [ + "none", + "gzip", + "snappy", + "lzo" + ], + "x-ms-enum": { + "name": "ParquetCompressionCodecEnum", + "modelAsString": true + } + }, + "DelimitedTextDataset": { + "x-ms-discriminator-value": "DelimitedText", + "description": "Delimited text dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Delimited text dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DelimitedTextDatasetTypeProperties" + } + } + }, + "DelimitedTextDatasetTypeProperties": { + "description": "DelimitedText dataset properties.", + "type": "object", + "properties": { + "location": { + "$ref": "#/definitions/DatasetLocation", + "description": "The location of the delimited text storage." + }, + "columnDelimiter": { + "type": "object", + "description": "The column delimiter. Type: string (or Expression with resultType string)." + }, + "rowDelimiter": { + "type": "object", + "description": "The row delimiter. Type: string (or Expression with resultType string)." + }, + "encodingName": { + "type": "object", + "description": "The code page name of the preferred encoding. If miss, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string)." + }, + "compressionCodec": { + "type": "string", + "enum": [ + "bzip2", + "gzip", + "deflate", + "zipDeflate", + "snappy", + "lz4", + "tar", + "tarGZip" + ], + "x-ms-enum": { + "name": "compressionCodec", + "modelAsString": true + } + }, + "compressionLevel": { + "description": "The data compression method used for DelimitedText.", + "$ref": "#/definitions/CompressionLevel" + }, + "quoteChar": { + "type": "object", + "description": "The quote character. Type: string (or Expression with resultType string)." + }, + "escapeChar": { + "type": "object", + "description": "The escape character. Type: string (or Expression with resultType string)." + }, + "firstRowAsHeader": { + "type": "object", + "description": "When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean)." + }, + "nullValue": { + "type": "object", + "description": "The null value string. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "location" + ] + }, + "JsonDataset": { + "x-ms-discriminator-value": "Json", + "description": "Json dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Json dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/JsonDatasetTypeProperties" + } + } + }, + "JsonDatasetTypeProperties": { + "description": "Json dataset properties.", + "type": "object", + "properties": { + "location": { + "$ref": "#/definitions/DatasetLocation", + "description": "The location of the json data storage." + }, + "encodingName": { + "type": "object", + "description": "The code page name of the preferred encoding. If not specified, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string)." + }, + "compression": { + "description": "The data compression method used for the json dataset.", + "$ref": "#/definitions/DatasetCompression" + } + }, + "required": [ + "location" + ] + }, + "XmlDataset": { + "x-ms-discriminator-value": "Xml", + "description": "Xml dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Xml dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/XmlDatasetTypeProperties" + } + } + }, + "XmlDatasetTypeProperties": { + "description": "Xml dataset properties.", + "type": "object", + "properties": { + "location": { + "$ref": "#/definitions/DatasetLocation", + "description": "The location of the json data storage." + }, + "encodingName": { + "type": "object", + "description": "The code page name of the preferred encoding. If not specified, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string)." + }, + "nullValue": { + "type": "object", + "description": "The null value string. Type: string (or Expression with resultType string)." + }, + "compression": { + "description": "The data compression method used for the json dataset.", + "$ref": "#/definitions/DatasetCompression" + } + }, + "required": [ + "location" + ] + }, + "OrcDataset": { + "x-ms-discriminator-value": "Orc", + "description": "ORC dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "ORC dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/OrcDatasetTypeProperties" + } + } + }, + "OrcDatasetTypeProperties": { + "description": "ORC dataset properties.", + "type": "object", + "properties": { + "location": { + "$ref": "#/definitions/DatasetLocation", + "description": "The location of the ORC data storage." + }, + "orcCompressionCodec": { + "type": "string", + "enum": [ + "none", + "zlib", + "snappy", + "lzo" + ], + "x-ms-enum": { + "name": "orcCompressionCodec", + "modelAsString": true + } + } + }, + "required": [ + "location" + ] + }, + "BinaryDataset": { + "x-ms-discriminator-value": "Binary", + "description": "Binary dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Binary dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/BinaryDatasetTypeProperties" + } + } + }, + "BinaryDatasetTypeProperties": { + "description": "Binary dataset properties.", + "type": "object", + "properties": { + "location": { + "$ref": "#/definitions/DatasetLocation", + "description": "The location of the Binary storage." + }, + "compression": { + "description": "The data compression method used for the binary dataset.", + "$ref": "#/definitions/DatasetCompression" + } + }, + "required": [ + "location" + ] + }, + "AzureBlobDataset": { + "x-ms-discriminator-value": "AzureBlob", + "description": "The Azure Blob storage.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Blob dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureBlobDatasetTypeProperties" + } + } + }, + "AzureBlobDatasetTypeProperties": { + "description": "Azure Blob dataset properties.", + "type": "object", + "properties": { + "folderPath": { + "type": "object", + "description": "The path of the Azure Blob storage. Type: string (or Expression with resultType string)." + }, + "tableRootLocation": { + "type": "object", + "description": "The root of blob path. Type: string (or Expression with resultType string)." + }, + "fileName": { + "type": "object", + "description": "The name of the Azure Blob. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of Azure Blob's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of Azure Blob's modified datetime. Type: string (or Expression with resultType string)." + }, + "format": { + "description": "The format of the Azure Blob storage.", + "$ref": "#/definitions/DatasetStorageFormat" + }, + "compression": { + "description": "The data compression method used for the blob storage.", + "$ref": "#/definitions/DatasetCompression" + } + } + }, + "AzureTableDataset": { + "x-ms-discriminator-value": "AzureTable", + "description": "The Azure Table storage dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Table dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureTableDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureTableDatasetTypeProperties": { + "description": "Azure Table dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "The table name of the Azure Table storage. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "tableName" + ] + }, + "AzureSqlTableDataset": { + "x-ms-discriminator-value": "AzureSqlTable", + "description": "The Azure SQL Server database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Azure SQL dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureSqlTableDatasetTypeProperties" + } + } + }, + "AzureSqlTableDatasetTypeProperties": { + "description": "Azure SQL dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "schema": { + "type": "object", + "description": "The schema name of the Azure SQL database. Type: string (or Expression with resultType string)." + }, + "table": { + "type": "object", + "description": "The table name of the Azure SQL database. Type: string (or Expression with resultType string)." + } + } + }, + "AzureSqlMITableDataset": { + "x-ms-discriminator-value": "AzureSqlMITable", + "description": "The Azure SQL Managed Instance dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Azure SQL Managed Instance dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureSqlMITableDatasetTypeProperties" + } + } + }, + "AzureSqlMITableDatasetTypeProperties": { + "description": "Azure SQL Managed Instance dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "schema": { + "type": "object", + "description": "The schema name of the Azure SQL Managed Instance. Type: string (or Expression with resultType string)." + }, + "table": { + "type": "object", + "description": "The table name of the Azure SQL Managed Instance dataset. Type: string (or Expression with resultType string)." + } + } + }, + "AzureSqlDWTableDataset": { + "x-ms-discriminator-value": "AzureSqlDWTable", + "description": "The Azure SQL Data Warehouse dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Azure SQL Data Warehouse dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureSqlDWTableDatasetTypeProperties" + } + } + }, + "AzureSqlDWTableDatasetTypeProperties": { + "description": "Azure SQL Data Warehouse dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "schema": { + "type": "object", + "description": "The schema name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string)." + }, + "table": { + "type": "object", + "description": "The table name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string)." + } + } + }, + "CassandraTableDataset": { + "x-ms-discriminator-value": "CassandraTable", + "description": "The Cassandra database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Cassandra dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CassandraTableDatasetTypeProperties" + } + } + }, + "CassandraTableDatasetTypeProperties": { + "description": "Cassandra dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "The table name of the Cassandra database. Type: string (or Expression with resultType string)." + }, + "keyspace": { + "type": "object", + "description": "The keyspace of the Cassandra database. Type: string (or Expression with resultType string)." + } + } + }, + "CustomDataset": { + "description": "The custom dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Custom dataset properties.", + "x-ms-client-flatten": true, + "type": "object" + } + } + }, + "CosmosDbSqlApiCollectionDataset": { + "x-ms-discriminator-value": "CosmosDbSqlApiCollection", + "description": "Microsoft Azure CosmosDB (SQL API) Collection dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "CosmosDB (SQL API) Collection dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CosmosDbSqlApiCollectionDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "CosmosDbSqlApiCollectionDatasetTypeProperties": { + "description": "CosmosDB (SQL API) Collection dataset properties.", + "type": "object", + "properties": { + "collectionName": { + "type": "object", + "description": "CosmosDB (SQL API) collection name. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "collectionName" + ] + }, + "DocumentDbCollectionDataset": { + "x-ms-discriminator-value": "DocumentDbCollection", + "description": "Microsoft Azure Document Database Collection dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "DocumentDB Collection dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DocumentDbCollectionDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DocumentDbCollectionDatasetTypeProperties": { + "description": "DocumentDB Collection dataset properties.", + "type": "object", + "properties": { + "collectionName": { + "type": "object", + "description": "Document Database collection name. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "collectionName" + ] + }, + "DynamicsEntityDataset": { + "x-ms-discriminator-value": "DynamicsEntity", + "description": "The Dynamics entity dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Dynamics entity dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DynamicsEntityDatasetTypeProperties" + } + } + }, + "DynamicsEntityDatasetTypeProperties": { + "description": "Dynamics entity dataset properties.", + "type": "object", + "properties": { + "entityName": { + "type": "object", + "description": "The logical name of the entity. Type: string (or Expression with resultType string)." + } + } + }, + "DynamicsCrmEntityDataset": { + "x-ms-discriminator-value": "DynamicsCrmEntity", + "description": "The Dynamics CRM entity dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Dynamics CRM entity dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DynamicsCrmEntityDatasetTypeProperties" + } + } + }, + "DynamicsCrmEntityDatasetTypeProperties": { + "description": "Dynamics CRM entity dataset properties.", + "type": "object", + "properties": { + "entityName": { + "type": "object", + "description": "The logical name of the entity. Type: string (or Expression with resultType string)." + } + } + }, + "CommonDataServiceForAppsEntityDataset": { + "x-ms-discriminator-value": "CommonDataServiceForAppsEntity", + "description": "The Common Data Service for Apps entity dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Common Data Service for Apps entity dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CommonDataServiceForAppsEntityDatasetTypeProperties" + } + } + }, + "CommonDataServiceForAppsEntityDatasetTypeProperties": { + "description": "Common Data Service for Apps entity dataset properties.", + "type": "object", + "properties": { + "entityName": { + "type": "object", + "description": "The logical name of the entity. Type: string (or Expression with resultType string)." + } + } + }, + "AzureDataLakeStoreDataset": { + "x-ms-discriminator-value": "AzureDataLakeStoreFile", + "description": "Azure Data Lake Store dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Data Lake Store dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureDataLakeStoreDatasetTypeProperties" + } + } + }, + "AzureDataLakeStoreDatasetTypeProperties": { + "description": "Azure Data Lake Store dataset properties.", + "type": "object", + "properties": { + "folderPath": { + "type": "object", + "description": "Path to the folder in the Azure Data Lake Store. Type: string (or Expression with resultType string)." + }, + "fileName": { + "type": "object", + "description": "The name of the file in the Azure Data Lake Store. Type: string (or Expression with resultType string)." + }, + "format": { + "description": "The format of the Data Lake Store.", + "$ref": "#/definitions/DatasetStorageFormat" + }, + "compression": { + "description": "The data compression method used for the item(s) in the Azure Data Lake Store.", + "$ref": "#/definitions/DatasetCompression" + } + } + }, + "AzureBlobFSDataset": { + "x-ms-discriminator-value": "AzureBlobFSFile", + "description": "The Azure Data Lake Storage Gen2 storage.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Data Lake Storage Gen2 dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureBlobFSDatasetTypeProperties" + } + } + }, + "AzureBlobFSDatasetTypeProperties": { + "description": "Azure Data Lake Storage Gen2 dataset properties.", + "type": "object", + "properties": { + "folderPath": { + "type": "object", + "description": "The path of the Azure Data Lake Storage Gen2 storage. Type: string (or Expression with resultType string)." + }, + "fileName": { + "type": "object", + "description": "The name of the Azure Data Lake Storage Gen2. Type: string (or Expression with resultType string)." + }, + "format": { + "description": "The format of the Azure Data Lake Storage Gen2 storage.", + "$ref": "#/definitions/DatasetStorageFormat" + }, + "compression": { + "description": "The data compression method used for the blob storage.", + "$ref": "#/definitions/DatasetCompression" + } + } + }, + "Office365Dataset": { + "x-ms-discriminator-value": "Office365Table", + "description": "The Office365 account.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Office365 dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/Office365DatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "Office365DatasetTypeProperties": { + "description": "Office365 dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "Name of the dataset to extract from Office 365. Type: string (or Expression with resultType string)." + }, + "predicate": { + "type": "object", + "description": "A predicate expression that can be used to filter the specific rows to extract from Office 365. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "tableName" + ] + }, + "FileShareDataset": { + "x-ms-discriminator-value": "FileShare", + "description": "An on-premises file system dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "On-premises file system dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/FileShareDatasetTypeProperties" + } + } + }, + "FileShareDatasetTypeProperties": { + "description": "On-premises file system dataset properties.", + "type": "object", + "properties": { + "folderPath": { + "type": "object", + "description": "The path of the on-premises file system. Type: string (or Expression with resultType string)." + }, + "fileName": { + "type": "object", + "description": "The name of the on-premises file system. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "format": { + "description": "The format of the files.", + "$ref": "#/definitions/DatasetStorageFormat" + }, + "fileFilter": { + "type": "object", + "description": "Specify a filter to be used to select a subset of files in the folderPath rather than all files. Type: string (or Expression with resultType string)." + }, + "compression": { + "description": "The data compression method used for the file system.", + "$ref": "#/definitions/DatasetCompression" + } + } + }, + "MongoDbCollectionDataset": { + "x-ms-discriminator-value": "MongoDbCollection", + "description": "The MongoDB database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "MongoDB database dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MongoDbCollectionDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MongoDbCollectionDatasetTypeProperties": { + "description": "MongoDB database dataset properties.", + "type": "object", + "properties": { + "collectionName": { + "type": "object", + "description": "The table name of the MongoDB database. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "collectionName" + ] + }, + "MongoDbAtlasCollectionDataset": { + "x-ms-discriminator-value": "MongoDbAtlasCollection", + "description": "The MongoDB Atlas database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "MongoDB Atlas database dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MongoDbAtlasCollectionDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MongoDbAtlasCollectionDatasetTypeProperties": { + "description": "MongoDB Atlas database dataset properties.", + "type": "object", + "properties": { + "collection": { + "type": "object", + "description": "The collection name of the MongoDB Atlas database. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "collection" + ] + }, + "MongoDbV2CollectionDataset": { + "x-ms-discriminator-value": "MongoDbV2Collection", + "description": "The MongoDB database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "MongoDB database dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MongoDbV2CollectionDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MongoDbV2CollectionDatasetTypeProperties": { + "description": "MongoDB database dataset properties.", + "type": "object", + "properties": { + "collection": { + "type": "object", + "description": "The collection name of the MongoDB database. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "collection" + ] + }, + "CosmosDbMongoDbApiCollectionDataset": { + "x-ms-discriminator-value": "CosmosDbMongoDbApiCollection", + "description": "The CosmosDB (MongoDB API) database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "CosmosDB (MongoDB API) database dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CosmosDbMongoDbApiCollectionDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "CosmosDbMongoDbApiCollectionDatasetTypeProperties": { + "description": "CosmosDB (MongoDB API) database dataset properties.", + "type": "object", + "properties": { + "collection": { + "type": "object", + "description": "The collection name of the CosmosDB (MongoDB API) database. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "collection" + ] + }, + "ODataResourceDataset": { + "x-ms-discriminator-value": "ODataResource", + "description": "The Open Data Protocol (OData) resource dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "OData dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ODataResourceDatasetTypeProperties" + } + } + }, + "ODataResourceDatasetTypeProperties": { + "description": "OData dataset properties.", + "type": "object", + "properties": { + "path": { + "type": "object", + "description": "The OData resource path. Type: string (or Expression with resultType string)." + } + } + }, + "OracleTableDataset": { + "x-ms-discriminator-value": "OracleTable", + "description": "The on-premises Oracle database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "On-premises Oracle dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/OracleTableDatasetTypeProperties" + } + } + }, + "OracleTableDatasetTypeProperties": { + "description": "On-premises Oracle dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "schema": { + "type": "object", + "description": "The schema name of the on-premises Oracle database. Type: string (or Expression with resultType string)." + }, + "table": { + "type": "object", + "description": "The table name of the on-premises Oracle database. Type: string (or Expression with resultType string)." + } + } + }, + "TeradataTableDataset": { + "x-ms-discriminator-value": "TeradataTable", + "description": "The Teradata database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Teradata dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/TeradataTableDatasetTypeProperties" + } + } + }, + "TeradataTableDatasetTypeProperties": { + "description": "Teradata dataset properties.", + "type": "object", + "properties": { + "database": { + "type": "object", + "description": "The database name of Teradata. Type: string (or Expression with resultType string)." + }, + "table": { + "type": "object", + "description": "The table name of Teradata. Type: string (or Expression with resultType string)." + } + } + }, + "AzureMySqlTableDataset": { + "x-ms-discriminator-value": "AzureMySqlTable", + "description": "The Azure MySQL database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Azure MySQL database dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureMySqlTableDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureMySqlTableDatasetTypeProperties": { + "description": "Azure MySQL database dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "The Azure MySQL database table name. Type: string (or Expression with resultType string)." + }, + "table": { + "type": "object", + "description": "The name of Azure MySQL database table. Type: string (or Expression with resultType string)." + } + } + }, + "AmazonRedshiftTableDataset": { + "x-ms-discriminator-value": "AmazonRedshiftTable", + "description": "The Amazon Redshift table dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Amazon Redshift table dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AmazonRedshiftTableDatasetTypeProperties" + } + } + }, + "AmazonRedshiftTableDatasetTypeProperties": { + "description": "Amazon Redshift table dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "table": { + "type": "object", + "description": "The Amazon Redshift table name. Type: string (or Expression with resultType string)." + }, + "schema": { + "type": "object", + "description": "The Amazon Redshift schema name. Type: string (or Expression with resultType string)." + } + } + }, + "Db2TableDataset": { + "x-ms-discriminator-value": "Db2Table", + "description": "The Db2 table dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Db2 table dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/Db2TableDatasetTypeProperties" + } + } + }, + "Db2TableDatasetTypeProperties": { + "description": "Db2 table dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "schema": { + "type": "object", + "description": "The Db2 schema name. Type: string (or Expression with resultType string)." + }, + "table": { + "type": "object", + "description": "The Db2 table name. Type: string (or Expression with resultType string)." + } + } + }, + "RelationalTableDataset": { + "x-ms-discriminator-value": "RelationalTable", + "description": "The relational table dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Relational table dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/RelationalTableDatasetTypeProperties" + } + } + }, + "RelationalTableDatasetTypeProperties": { + "description": "Relational table dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "The relational table name. Type: string (or Expression with resultType string)." + } + } + }, + "InformixTableDataset": { + "x-ms-discriminator-value": "InformixTable", + "description": "The Informix table dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Informix table dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/InformixTableDatasetTypeProperties" + } + } + }, + "InformixTableDatasetTypeProperties": { + "description": "Informix table dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "The Informix table name. Type: string (or Expression with resultType string)." + } + } + }, + "OdbcTableDataset": { + "x-ms-discriminator-value": "OdbcTable", + "description": "The ODBC table dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "ODBC table dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/OdbcTableDatasetTypeProperties" + } + } + }, + "OdbcTableDatasetTypeProperties": { + "description": "ODBC table dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "The ODBC table name. Type: string (or Expression with resultType string)." + } + } + }, + "MySqlTableDataset": { + "x-ms-discriminator-value": "MySqlTable", + "description": "The MySQL table dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "MySQL table dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MySqlTableDatasetTypeProperties" + } + } + }, + "MySqlTableDatasetTypeProperties": { + "description": "MySql table dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "The MySQL table name. Type: string (or Expression with resultType string)." + } + } + }, + "PostgreSqlTableDataset": { + "x-ms-discriminator-value": "PostgreSqlTable", + "description": "The PostgreSQL table dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "PostgreSQL table dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PostgreSqlTableDatasetTypeProperties" + } + } + }, + "PostgreSqlTableDatasetTypeProperties": { + "description": "PostgreSQL table dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "table": { + "type": "object", + "description": "The PostgreSQL table name. Type: string (or Expression with resultType string)." + }, + "schema": { + "type": "object", + "description": "The PostgreSQL schema name. Type: string (or Expression with resultType string)." + } + } + }, + "MicrosoftAccessTableDataset": { + "x-ms-discriminator-value": "MicrosoftAccessTable", + "description": "The Microsoft Access table dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Microsoft Access table dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MicrosoftAccessTableDatasetTypeProperties" + } + } + }, + "MicrosoftAccessTableDatasetTypeProperties": { + "description": "Microsoft Access table dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "The Microsoft Access table name. Type: string (or Expression with resultType string)." + } + } + }, + "SalesforceObjectDataset": { + "x-ms-discriminator-value": "SalesforceObject", + "description": "The Salesforce object dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Salesforce object dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SalesforceObjectDatasetTypeProperties" + } + } + }, + "SalesforceObjectDatasetTypeProperties": { + "description": "Salesforce object dataset properties.", + "type": "object", + "properties": { + "objectApiName": { + "type": "object", + "description": "The Salesforce object API name. Type: string (or Expression with resultType string)." + } + } + }, + "SalesforceServiceCloudObjectDataset": { + "x-ms-discriminator-value": "SalesforceServiceCloudObject", + "description": "The Salesforce Service Cloud object dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Salesforce Service Cloud object dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SalesforceServiceCloudObjectDatasetTypeProperties" + } + } + }, + "SalesforceServiceCloudObjectDatasetTypeProperties": { + "description": "Salesforce Service Cloud object dataset properties.", + "type": "object", + "properties": { + "objectApiName": { + "type": "object", + "description": "The Salesforce Service Cloud object API name. Type: string (or Expression with resultType string)." + } + } + }, + "SybaseTableDataset": { + "x-ms-discriminator-value": "SybaseTable", + "description": "The Sybase table dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Sybase table dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SybaseTableDatasetTypeProperties" + } + } + }, + "SybaseTableDatasetTypeProperties": { + "description": "Sybase table dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "The Sybase table name. Type: string (or Expression with resultType string)." + } + } + }, + "SapBwCubeDataset": { + "x-ms-discriminator-value": "SapBwCube", + "description": "The SAP BW cube dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": {} + }, + "SapCloudForCustomerResourceDataset": { + "x-ms-discriminator-value": "SapCloudForCustomerResource", + "description": "The path of the SAP Cloud for Customer OData entity.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "SAP Cloud For Customer OData resource dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SapCloudForCustomerResourceDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SapCloudForCustomerResourceDatasetTypeProperties": { + "description": "Sap Cloud For Customer OData resource dataset properties.", + "type": "object", + "properties": { + "path": { + "type": "object", + "description": "The path of the SAP Cloud for Customer OData entity. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "path" + ] + }, + "SapEccResourceDataset": { + "x-ms-discriminator-value": "SapEccResource", + "description": "The path of the SAP ECC OData entity.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "SAP ECC OData resource dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SapEccResourceDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SapEccResourceDatasetTypeProperties": { + "description": "Sap ECC OData resource dataset properties.", + "type": "object", + "properties": { + "path": { + "type": "object", + "description": "The path of the SAP ECC OData entity. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "path" + ] + }, + "SapHanaTableDataset": { + "x-ms-discriminator-value": "SapHanaTable", + "description": "SAP HANA Table properties.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "SAP HANA Table properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SapHanaTableDatasetTypeProperties" + } + } + }, + "SapHanaTableDatasetTypeProperties": { + "description": "SAP HANA Table properties.", + "type": "object", + "properties": { + "schema": { + "type": "object", + "description": "The schema name of SAP HANA. Type: string (or Expression with resultType string)." + }, + "table": { + "type": "object", + "description": "The table name of SAP HANA. Type: string (or Expression with resultType string)." + } + } + }, + "SapOpenHubTableDataset": { + "x-ms-discriminator-value": "SapOpenHubTable", + "description": "Sap Business Warehouse Open Hub Destination Table properties.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Sap Business Warehouse Open Hub Destination Table properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SapOpenHubTableDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SapOpenHubTableDatasetTypeProperties": { + "description": "Sap Business Warehouse Open Hub Destination Table properties.", + "type": "object", + "properties": { + "openHubDestinationName": { + "type": "object", + "description": "The name of the Open Hub Destination with destination type as Database Table. Type: string (or Expression with resultType string)." + }, + "excludeLastRequest": { + "type": "object", + "description": "Whether to exclude the records of the last request. The default value is true. Type: boolean (or Expression with resultType boolean)." + }, + "baseRequestId": { + "type": "object", + "description": "The ID of request for delta loading. Once it is set, only data with requestId larger than the value of this property will be retrieved. The default value is 0. Type: integer (or Expression with resultType integer )." + } + }, + "required": [ + "openHubDestinationName" + ] + }, + "SqlServerTableDataset": { + "x-ms-discriminator-value": "SqlServerTable", + "description": "The on-premises SQL Server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "On-premises SQL Server dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SqlServerTableDatasetTypeProperties" + } + } + }, + "SqlServerTableDatasetTypeProperties": { + "description": "On-premises SQL Server dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "schema": { + "type": "object", + "description": "The schema name of the SQL Server dataset. Type: string (or Expression with resultType string)." + }, + "table": { + "type": "object", + "description": "The table name of the SQL Server dataset. Type: string (or Expression with resultType string)." + } + } + }, + "RestResourceDataset": { + "x-ms-discriminator-value": "RestResource", + "description": "A Rest service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/RestResourceDatasetTypeProperties" + } + } + }, + "RestResourceDatasetTypeProperties": { + "description": "Properties specific to this dataset type.", + "type": "object", + "properties": { + "relativeUrl": { + "type": "object", + "description": "The relative URL to the resource that the RESTful API provides. Type: string (or Expression with resultType string)." + }, + "requestMethod": { + "type": "object", + "description": "The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string)." + }, + "requestBody": { + "type": "object", + "description": "The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string)." + }, + "additionalHeaders": { + "type": "object", + "description": "The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string)." + }, + "paginationRules": { + "type": "object", + "description": "The pagination rules to compose next page requests. Type: string (or Expression with resultType string)." + } + } + }, + "SapTableResourceDataset": { + "x-ms-discriminator-value": "SapTableResource", + "description": "SAP Table Resource properties.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "SAP Table Resource properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SapTableResourceDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SapTableResourceDatasetTypeProperties": { + "description": "SAP Table Resource properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "The name of the SAP Table. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "tableName" + ] + }, + "WebTableDataset": { + "x-ms-discriminator-value": "WebTable", + "description": "The dataset points to a HTML table in the web page.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Web table dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WebTableDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "WebTableDatasetTypeProperties": { + "description": "Web table dataset properties.", + "type": "object", + "properties": { + "index": { + "type": "object", + "description": "The zero-based index of the table in the web page. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "path": { + "type": "object", + "description": "The relative URL to the web page from the linked service URL. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "index" + ] + }, + "AzureSearchIndexDataset": { + "x-ms-discriminator-value": "AzureSearchIndex", + "description": "The Azure Search Index.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureSearchIndexDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureSearchIndexDatasetTypeProperties": { + "description": "Properties specific to this dataset type.", + "type": "object", + "properties": { + "indexName": { + "type": "object", + "description": "The name of the Azure Search Index. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "indexName" + ] + }, + "HttpDataset": { + "x-ms-discriminator-value": "HttpFile", + "description": "A file in an HTTP web server.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HttpDatasetTypeProperties" + } + } + }, + "HttpDatasetTypeProperties": { + "description": "Properties specific to this dataset type.", + "type": "object", + "properties": { + "relativeUrl": { + "type": "object", + "description": "The relative URL based on the URL in the HttpLinkedService refers to an HTTP file Type: string (or Expression with resultType string)." + }, + "requestMethod": { + "type": "object", + "description": "The HTTP method for the HTTP request. Type: string (or Expression with resultType string)." + }, + "requestBody": { + "type": "object", + "description": "The body for the HTTP request. Type: string (or Expression with resultType string)." + }, + "additionalHeaders": { + "type": "object", + "description": "The headers for the HTTP Request. e.g. request-header-name-1:request-header-value-1\r\n...\r\nrequest-header-name-n:request-header-value-n Type: string (or Expression with resultType string)." + }, + "format": { + "description": "The format of files.", + "$ref": "#/definitions/DatasetStorageFormat" + }, + "compression": { + "description": "The data compression method used on files.", + "$ref": "#/definitions/DatasetCompression" + } + } + }, + "GenericDatasetTypeProperties": { + "description": "Properties specific to this dataset type.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "The table name. Type: string (or Expression with resultType string)." + } + } + }, + "AmazonMWSObjectDataset": { + "x-ms-discriminator-value": "AmazonMWSObject", + "description": "Amazon Marketplace Web Service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "AzurePostgreSqlTableDataset": { + "x-ms-discriminator-value": "AzurePostgreSqlTable", + "description": "Azure PostgreSQL dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzurePostgreSqlTableDatasetTypeProperties" + } + } + }, + "AzurePostgreSqlTableDatasetTypeProperties": { + "description": "Azure PostgreSQL dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "The table name of the Azure PostgreSQL database which includes both schema and table. Type: string (or Expression with resultType string)." + }, + "table": { + "type": "object", + "description": "The table name of the Azure PostgreSQL database. Type: string (or Expression with resultType string)." + }, + "schema": { + "type": "object", + "description": "The schema name of the Azure PostgreSQL database. Type: string (or Expression with resultType string)." + } + } + }, + "ConcurObjectDataset": { + "x-ms-discriminator-value": "ConcurObject", + "description": "Concur Service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "CouchbaseTableDataset": { + "x-ms-discriminator-value": "CouchbaseTable", + "description": "Couchbase server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "DrillTableDataset": { + "x-ms-discriminator-value": "DrillTable", + "description": "Drill server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DrillDatasetTypeProperties" + } + } + }, + "DrillDatasetTypeProperties": { + "description": "Drill Dataset Properties", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "table": { + "type": "object", + "description": "The table name of the Drill. Type: string (or Expression with resultType string)." + }, + "schema": { + "type": "object", + "description": "The schema name of the Drill. Type: string (or Expression with resultType string)." + } + } + }, + "EloquaObjectDataset": { + "x-ms-discriminator-value": "EloquaObject", + "description": "Eloqua server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "GoogleBigQueryObjectDataset": { + "x-ms-discriminator-value": "GoogleBigQueryObject", + "description": "Google BigQuery service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GoogleBigQueryDatasetTypeProperties" + } + } + }, + "GoogleBigQueryDatasetTypeProperties": { + "description": "Google BigQuery Dataset Properties", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using database + table properties instead." + }, + "table": { + "type": "object", + "description": "The table name of the Google BigQuery. Type: string (or Expression with resultType string)." + }, + "dataset": { + "type": "object", + "description": "The database name of the Google BigQuery. Type: string (or Expression with resultType string)." + } + } + }, + "GreenplumTableDataset": { + "x-ms-discriminator-value": "GreenplumTable", + "description": "Greenplum Database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GreenplumDatasetTypeProperties" + } + } + }, + "GreenplumDatasetTypeProperties": { + "description": "Greenplum Dataset Properties", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "table": { + "type": "object", + "description": "The table name of Greenplum. Type: string (or Expression with resultType string)." + }, + "schema": { + "type": "object", + "description": "The schema name of Greenplum. Type: string (or Expression with resultType string)." + } + } + }, + "HBaseObjectDataset": { + "x-ms-discriminator-value": "HBaseObject", + "description": "HBase server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "HiveObjectDataset": { + "x-ms-discriminator-value": "HiveObject", + "description": "Hive Server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HiveDatasetTypeProperties" + } + } + }, + "HiveDatasetTypeProperties": { + "description": "Hive Properties", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "table": { + "type": "object", + "description": "The table name of the Hive. Type: string (or Expression with resultType string)." + }, + "schema": { + "type": "object", + "description": "The schema name of the Hive. Type: string (or Expression with resultType string)." + } + } + }, + "HubspotObjectDataset": { + "x-ms-discriminator-value": "HubspotObject", + "description": "Hubspot Service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "ImpalaObjectDataset": { + "x-ms-discriminator-value": "ImpalaObject", + "description": "Impala server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImpalaDatasetTypeProperties" + } + } + }, + "ImpalaDatasetTypeProperties": { + "description": "Impala Dataset Properties", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "table": { + "type": "object", + "description": "The table name of the Impala. Type: string (or Expression with resultType string)." + }, + "schema": { + "type": "object", + "description": "The schema name of the Impala. Type: string (or Expression with resultType string)." + } + } + }, + "JiraObjectDataset": { + "x-ms-discriminator-value": "JiraObject", + "description": "Jira Service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "MagentoObjectDataset": { + "x-ms-discriminator-value": "MagentoObject", + "description": "Magento server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "MariaDBTableDataset": { + "x-ms-discriminator-value": "MariaDBTable", + "description": "MariaDB server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "AzureMariaDBTableDataset": { + "x-ms-discriminator-value": "AzureMariaDBTable", + "description": "Azure Database for MariaDB dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "MarketoObjectDataset": { + "x-ms-discriminator-value": "MarketoObject", + "description": "Marketo server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "PaypalObjectDataset": { + "x-ms-discriminator-value": "PaypalObject", + "description": "Paypal Service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "PhoenixObjectDataset": { + "x-ms-discriminator-value": "PhoenixObject", + "description": "Phoenix server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PhoenixDatasetTypeProperties" + } + } + }, + "PhoenixDatasetTypeProperties": { + "description": "Phoenix Dataset Properties", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "table": { + "type": "object", + "description": "The table name of the Phoenix. Type: string (or Expression with resultType string)." + }, + "schema": { + "type": "object", + "description": "The schema name of the Phoenix. Type: string (or Expression with resultType string)." + } + } + }, + "PrestoObjectDataset": { + "x-ms-discriminator-value": "PrestoObject", + "description": "Presto server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrestoDatasetTypeProperties" + } + } + }, + "PrestoDatasetTypeProperties": { + "description": "Presto Dataset Properties", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "table": { + "type": "object", + "description": "The table name of the Presto. Type: string (or Expression with resultType string)." + }, + "schema": { + "type": "object", + "description": "The schema name of the Presto. Type: string (or Expression with resultType string)." + } + } + }, + "QuickBooksObjectDataset": { + "x-ms-discriminator-value": "QuickBooksObject", + "description": "QuickBooks server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "ServiceNowObjectDataset": { + "x-ms-discriminator-value": "ServiceNowObject", + "description": "ServiceNow server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "ShopifyObjectDataset": { + "x-ms-discriminator-value": "ShopifyObject", + "description": "Shopify Service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "SparkObjectDataset": { + "x-ms-discriminator-value": "SparkObject", + "description": "Spark Server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SparkDatasetTypeProperties" + } + } + }, + "SparkDatasetTypeProperties": { + "description": "Spark Properties", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "table": { + "type": "object", + "description": "The table name of the Spark. Type: string (or Expression with resultType string)." + }, + "schema": { + "type": "object", + "description": "The schema name of the Spark. Type: string (or Expression with resultType string)." + } + } + }, + "SquareObjectDataset": { + "x-ms-discriminator-value": "SquareObject", + "description": "Square Service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "XeroObjectDataset": { + "x-ms-discriminator-value": "XeroObject", + "description": "Xero Service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "ZohoObjectDataset": { + "x-ms-discriminator-value": "ZohoObject", + "description": "Zoho server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "NetezzaTableDataset": { + "x-ms-discriminator-value": "NetezzaTable", + "description": "Netezza dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetezzaTableDatasetTypeProperties" + } + } + }, + "NetezzaTableDatasetTypeProperties": { + "description": "Netezza dataset properties.", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "table": { + "type": "object", + "description": "The table name of the Netezza. Type: string (or Expression with resultType string)." + }, + "schema": { + "type": "object", + "description": "The schema name of the Netezza. Type: string (or Expression with resultType string)." + } + } + }, + "VerticaTableDataset": { + "x-ms-discriminator-value": "VerticaTable", + "description": "Vertica dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/VerticaDatasetTypeProperties" + } + } + }, + "VerticaDatasetTypeProperties": { + "description": "Vertica Properties", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property will be retired. Please consider using schema + table properties instead." + }, + "table": { + "type": "object", + "description": "The table name of the Vertica. Type: string (or Expression with resultType string)." + }, + "schema": { + "type": "object", + "description": "The schema name of the Vertica. Type: string (or Expression with resultType string)." + } + } + }, + "SalesforceMarketingCloudObjectDataset": { + "x-ms-discriminator-value": "SalesforceMarketingCloudObject", + "description": "Salesforce Marketing Cloud dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "ResponsysObjectDataset": { + "x-ms-discriminator-value": "ResponsysObject", + "description": "Responsys dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "DynamicsAXResourceDataset": { + "x-ms-discriminator-value": "DynamicsAXResource", + "description": "The path of the Dynamics AX OData entity.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Dynamics AX OData resource dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DynamicsAXResourceDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DynamicsAXResourceDatasetTypeProperties": { + "description": "Dynamics AX OData resource dataset properties.", + "type": "object", + "properties": { + "path": { + "type": "object", + "description": "The path of the Dynamics AX OData entity. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "path" + ] + }, + "OracleServiceCloudObjectDataset": { + "x-ms-discriminator-value": "OracleServiceCloudObject", + "description": "Oracle Service Cloud dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "AzureDataExplorerTableDataset": { + "x-ms-discriminator-value": "AzureDataExplorerTable", + "description": "The Azure Data Explorer (Kusto) dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Data Explorer (Kusto) dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureDataExplorerDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureDataExplorerDatasetTypeProperties": { + "description": "Azure Data Explorer (Kusto) dataset properties.", + "type": "object", + "properties": { + "table": { + "type": "object", + "description": "The table name of the Azure Data Explorer database. Type: string (or Expression with resultType string)." + } + } + }, + "GoogleAdWordsObjectDataset": { + "x-ms-discriminator-value": "GoogleAdWordsObject", + "description": "Google AdWords service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } + } + }, + "SnowflakeDataset": { + "x-ms-discriminator-value": "SnowflakeTable", + "description": "The snowflake dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Snowflake dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SnowflakeDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SnowflakeDatasetTypeProperties": { + "description": "Snowflake dataset properties.", + "type": "object", + "properties": { + "schema": { + "type": "object", + "description": "The schema name of the Snowflake database. Type: string (or Expression with resultType string)." + }, + "table": { + "type": "object", + "description": "The table name of the Snowflake database. Type: string (or Expression with resultType string)." + } + } + }, + "SharePointOnlineListResourceDataset": { + "x-ms-discriminator-value": "SharePointOnlineListResource", + "description": "The sharepoint online list resource dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Sharepoint online list dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SharePointOnlineListDatasetTypeProperties" + } + } + }, + "SharePointOnlineListDatasetTypeProperties": { + "description": "Sharepoint online list dataset properties.", + "type": "object", + "properties": { + "listName": { + "type": "object", + "description": "The name of the SharePoint Online list. Type: string (or Expression with resultType string)." + } + } + }, + "AzureDatabricksDeltaLakeDataset": { + "x-ms-discriminator-value": "AzureDatabricksDeltaLakeDataset", + "description": "Azure Databricks Delta Lake dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureDatabricksDeltaLakeDatasetTypeProperties" + } + } + }, + "AzureDatabricksDeltaLakeDatasetTypeProperties": { + "description": "Azure Databricks Delta Lake Dataset Properties", + "type": "object", + "properties": { + "table": { + "type": "object", + "description": "The name of delta table. Type: string (or Expression with resultType string)." + }, + "database": { + "type": "object", + "description": "The database name of delta table. Type: string (or Expression with resultType string)." + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json new file mode 100644 index 000000000000..f6badba9bb87 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json @@ -0,0 +1,6087 @@ +{ + "swagger": "2.0", + "info": { + "title": "ArtifactsClient", + "version": "2020-12-01" + }, + "paths": {}, + "definitions": { + "LinkedService": { + "description": "The Azure Synapse nested object which contains the information and credential which can be used to connect with related store or compute resource.", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Type of linked service." + }, + "connectVia": { + "description": "The integration runtime reference.", + "$ref": "../artifacts.json#/definitions/IntegrationRuntimeReference" + }, + "description": { + "description": "Linked service description.", + "type": "string" + }, + "parameters": { + "$ref": "../artifacts.json#/definitions/ParameterDefinitionSpecification", + "description": "Parameters for linked service." + }, + "annotations": { + "description": "List of tags that can be used for describing the linked service.", + "type": "array", + "items": { + "type": "object" + } + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "AzureStorageLinkedService": { + "x-ms-discriminator-value": "AzureStorage", + "description": "The storage account linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Storage linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureStorageLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureBlobStorageLinkedService": { + "x-ms-discriminator-value": "AzureBlobStorage", + "description": "The azure blob storage linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Blob Storage linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureBlobStorageLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureTableStorageLinkedService": { + "x-ms-discriminator-value": "AzureTableStorage", + "description": "The azure table storage linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Table Storage linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureStorageLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureStorageLinkedServiceTypeProperties": { + "description": "Azure Storage linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "accountKey": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of accountKey in connection string." + }, + "sasUri": { + "description": "SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "sasToken": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of sasToken in sas uri." + }, + "encryptedCredential": { + "type": "string", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + } + }, + "AzureBlobStorageLinkedServiceTypeProperties": { + "description": "Azure Blob Storage linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "type": "object", + "description": "The connection string. It is mutually exclusive with sasUri, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference." + }, + "accountKey": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of accountKey in connection string." + }, + "sasUri": { + "description": "SAS URI of the Azure Blob Storage resource. It is mutually exclusive with connectionString, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "sasToken": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of sasToken in sas uri." + }, + "serviceEndpoint": { + "type": "string", + "description": "Blob service endpoint of the Azure Blob Storage resource. It is mutually exclusive with connectionString, sasUri property." + }, + "servicePrincipalId": { + "type": "object", + "description": "The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The key of the service principal used to authenticate against Azure SQL Data Warehouse." + }, + "tenant": { + "type": "object", + "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." + }, + "azureCloudType": { + "type": "object", + "description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "string", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + } + }, + "AzureSqlDWLinkedService": { + "x-ms-discriminator-value": "AzureSqlDW", + "description": "Azure SQL Data Warehouse linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure SQL Data Warehouse linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureSqlDWLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureSqlDWLinkedServiceTypeProperties": { + "description": "Azure SQL Data Warehouse linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "password": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, + "servicePrincipalId": { + "type": "object", + "description": "The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The key of the service principal used to authenticate against Azure SQL Data Warehouse." + }, + "tenant": { + "type": "object", + "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." + }, + "azureCloudType": { + "type": "object", + "description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "SqlServerLinkedService": { + "x-ms-discriminator-value": "SqlServer", + "description": "SQL Server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "SQL Server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SqlServerLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SqlServerLinkedServiceTypeProperties": { + "description": "SQL Server linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "userName": { + "type": "object", + "description": "The on-premises Windows authentication user name. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "The on-premises Windows authentication password.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "AzureSqlDatabaseLinkedService": { + "x-ms-discriminator-value": "AzureSqlDatabase", + "description": "Microsoft Azure SQL Database linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure SQL Database linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureSqlDatabaseLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureSqlDatabaseLinkedServiceTypeProperties": { + "description": "Azure SQL Database linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "password": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, + "servicePrincipalId": { + "type": "object", + "description": "The ID of the service principal used to authenticate against Azure SQL Database. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The key of the service principal used to authenticate against Azure SQL Database." + }, + "tenant": { + "type": "object", + "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." + }, + "azureCloudType": { + "type": "object", + "description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "AzureSqlMILinkedService": { + "x-ms-discriminator-value": "AzureSqlMI", + "description": "Azure SQL Managed Instance linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure SQL Managed Instance linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureSqlMILinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureSqlMILinkedServiceTypeProperties": { + "description": "Azure SQL Managed Instance linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "password": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, + "servicePrincipalId": { + "type": "object", + "description": "The ID of the service principal used to authenticate against Azure SQL Managed Instance. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The key of the service principal used to authenticate against Azure SQL Managed Instance." + }, + "tenant": { + "type": "object", + "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." + }, + "azureCloudType": { + "type": "object", + "description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "AzureBatchLinkedService": { + "x-ms-discriminator-value": "AzureBatch", + "description": "Azure Batch linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Batch linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureBatchLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureBatchLinkedServiceTypeProperties": { + "description": "Azure Batch linked service properties.", + "type": "object", + "properties": { + "accountName": { + "type": "object", + "description": "The Azure Batch account name. Type: string (or Expression with resultType string)." + }, + "accessKey": { + "description": "The Azure Batch account access key.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "batchUri": { + "type": "object", + "description": "The Azure Batch URI. Type: string (or Expression with resultType string)." + }, + "poolName": { + "type": "object", + "description": "The Azure Batch pool name. Type: string (or Expression with resultType string)." + }, + "linkedServiceName": { + "description": "The Azure Storage linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "accountName", + "batchUri", + "poolName", + "linkedServiceName" + ] + }, + "AzureKeyVaultLinkedService": { + "x-ms-discriminator-value": "AzureKeyVault", + "description": "Azure Key Vault linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Key Vault linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureKeyVaultLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureKeyVaultLinkedServiceTypeProperties": { + "description": "Azure Key Vault linked service properties.", + "type": "object", + "properties": { + "baseUrl": { + "type": "object", + "description": "The base URL of the Azure Key Vault. e.g. https://myakv.vault.azure.net Type: string (or Expression with resultType string)." + } + }, + "required": [ + "baseUrl" + ] + }, + "CosmosDbLinkedService": { + "x-ms-discriminator-value": "CosmosDb", + "description": "Microsoft Azure Cosmos Database (CosmosDB) linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "CosmosDB linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CosmosDbLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "CosmosDbLinkedServiceTypeProperties": { + "description": "CosmosDB linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "accountEndpoint": { + "description": "The endpoint of the Azure CosmosDB account. Type: string (or Expression with resultType string)", + "type": "object" + }, + "database": { + "description": "The name of the database. Type: string (or Expression with resultType string)", + "type": "object" + }, + "accountKey": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The account key of the Azure CosmosDB account. Type: SecureString or AzureKeyVaultSecretReference." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + } + }, + "DynamicsLinkedService": { + "x-ms-discriminator-value": "Dynamics", + "description": "Dynamics linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Dynamics linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DynamicsLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DynamicsLinkedServiceTypeProperties": { + "description": "Dynamics linked service properties.", + "type": "object", + "properties": { + "deploymentType": { + "x-ms-enum": { + "name": "DynamicsDeploymentType", + "modelAsString": true + }, + "enum": [ + "Online", + "OnPremisesWithIfd" + ], + "type": "string", + "description": "The deployment type of the Dynamics instance. 'Online' for Dynamics Online and 'OnPremisesWithIfd' for Dynamics on-premises with Ifd. Type: string (or Expression with resultType string)." + }, + "hostName": { + "type": "object", + "description": "The host name of the on-premises Dynamics server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string)." + }, + "port": { + "type": "object", + "description": "The port of on-premises Dynamics server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "serviceUri": { + "type": "object", + "description": "The URL to the Microsoft Dynamics server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string)." + }, + "organizationName": { + "type": "object", + "description": "The organization name of the Dynamics instance. The property is required for on-prem and required for online when there are more than one Dynamics instances associated with the user. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "x-ms-enum": { + "name": "DynamicsAuthenticationType", + "modelAsString": true + }, + "enum": [ + "Office365", + "Ifd", + "AADServicePrincipal" + ], + "type": "string", + "description": "The authentication type to connect to Dynamics server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string)." + }, + "username": { + "type": "object", + "description": "User name to access the Dynamics instance. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password to access the Dynamics instance.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "servicePrincipalId": { + "type": "object", + "description": "The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string)." + }, + "servicePrincipalCredentialType": { + "x-ms-enum": { + "name": "DynamicsServicePrincipalCredentialType", + "modelAsString": true + }, + "enum": [ + "ServicePrincipalKey", + "ServicePrincipalCert" + ], + "type": "object", + "description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)." + }, + "servicePrincipalCredential": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "deploymentType", + "authenticationType" + ] + }, + "DynamicsCrmLinkedService": { + "x-ms-discriminator-value": "DynamicsCrm", + "description": "Dynamics CRM linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Dynamics CRM linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DynamicsCrmLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DynamicsCrmLinkedServiceTypeProperties": { + "description": "Dynamics CRM linked service properties.", + "type": "object", + "properties": { + "deploymentType": { + "x-ms-enum": { + "name": "DynamicsDeploymentType", + "modelAsString": true + }, + "enum": [ + "Online", + "OnPremisesWithIfd" + ], + "type": "string", + "description": "The deployment type of the Dynamics CRM instance. 'Online' for Dynamics CRM Online and 'OnPremisesWithIfd' for Dynamics CRM on-premises with Ifd. Type: string (or Expression with resultType string)." + }, + "hostName": { + "type": "object", + "description": "The host name of the on-premises Dynamics CRM server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string)." + }, + "port": { + "type": "object", + "description": "The port of on-premises Dynamics CRM server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "serviceUri": { + "type": "object", + "description": "The URL to the Microsoft Dynamics CRM server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string)." + }, + "organizationName": { + "type": "object", + "description": "The organization name of the Dynamics CRM instance. The property is required for on-prem and required for online when there are more than one Dynamics CRM instances associated with the user. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "x-ms-enum": { + "name": "DynamicsAuthenticationType", + "modelAsString": true + }, + "enum": [ + "Office365", + "Ifd", + "AADServicePrincipal" + ], + "type": "string", + "description": "The authentication type to connect to Dynamics CRM server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string)." + }, + "username": { + "type": "object", + "description": "User name to access the Dynamics CRM instance. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password to access the Dynamics CRM instance.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "servicePrincipalId": { + "type": "object", + "description": "The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string)." + }, + "servicePrincipalCredentialType": { + "type": "object", + "description": "A string from ServicePrincipalCredentialEnum or an expression" + }, + "servicePrincipalCredential": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "deploymentType", + "authenticationType" + ] + }, + "ServicePrincipalCredentialEnum": { + "x-ms-enum": { + "name": "DynamicsServicePrincipalCredentialType", + "modelAsString": true + }, + "enum": [ + "ServicePrincipalKey", + "ServicePrincipalCert" + ], + "type": "object", + "description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)." + }, + "CommonDataServiceForAppsLinkedService": { + "x-ms-discriminator-value": "CommonDataServiceForApps", + "description": "Common Data Service for Apps linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Common Data Service for Apps linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CommonDataServiceForAppsLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "CommonDataServiceForAppsLinkedServiceTypeProperties": { + "description": "Common Data Service for Apps linked service properties.", + "type": "object", + "properties": { + "deploymentType": { + "x-ms-enum": { + "name": "DynamicsDeploymentType", + "modelAsString": true + }, + "enum": [ + "Online", + "OnPremisesWithIfd" + ], + "type": "string", + "description": "The deployment type of the Common Data Service for Apps instance. 'Online' for Common Data Service for Apps Online and 'OnPremisesWithIfd' for Common Data Service for Apps on-premises with Ifd. Type: string (or Expression with resultType string)." + }, + "hostName": { + "type": "object", + "description": "The host name of the on-premises Common Data Service for Apps server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string)." + }, + "port": { + "type": "object", + "description": "The port of on-premises Common Data Service for Apps server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "serviceUri": { + "type": "object", + "description": "The URL to the Microsoft Common Data Service for Apps server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string)." + }, + "organizationName": { + "type": "object", + "description": "The organization name of the Common Data Service for Apps instance. The property is required for on-prem and required for online when there are more than one Common Data Service for Apps instances associated with the user. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "x-ms-enum": { + "name": "DynamicsAuthenticationType", + "modelAsString": true + }, + "enum": [ + "Office365", + "Ifd", + "AADServicePrincipal" + ], + "type": "string", + "description": "The authentication type to connect to Common Data Service for Apps server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario. 'AADServicePrincipal' for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string)." + }, + "username": { + "type": "object", + "description": "User name to access the Common Data Service for Apps instance. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password to access the Common Data Service for Apps instance.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "servicePrincipalId": { + "type": "object", + "description": "The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string)." + }, + "servicePrincipalCredentialType": { + "type": "object", + "description": "A string from ServicePrincipalCredentialEnum or an expression" + }, + "servicePrincipalCredential": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "deploymentType", + "authenticationType" + ] + }, + "HDInsightLinkedService": { + "x-ms-discriminator-value": "HDInsight", + "description": "HDInsight linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "HDInsight linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HDInsightLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightLinkedServiceTypeProperties": { + "description": "HDInsight linked service properties.", + "type": "object", + "properties": { + "clusterUri": { + "type": "object", + "description": "HDInsight cluster URI. Type: string (or Expression with resultType string)." + }, + "userName": { + "type": "object", + "description": "HDInsight cluster user name. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "HDInsight cluster password.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "linkedServiceName": { + "description": "The Azure Storage linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "hcatalogLinkedServiceName": { + "description": "A reference to the Azure SQL linked service that points to the HCatalog database.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + }, + "isEspEnabled": { + "type": "object", + "description": "Specify if the HDInsight is created with ESP (Enterprise Security Package). Type: Boolean." + }, + "fileSystem": { + "type": "object", + "description": "Specify the FileSystem if the main storage for the HDInsight is ADLS Gen2. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "clusterUri" + ] + }, + "FileServerLinkedService": { + "x-ms-discriminator-value": "FileServer", + "description": "File system linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "File system linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/FileServerLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "FileServerLinkedServiceTypeProperties": { + "description": "File system linked service properties.", + "type": "object", + "properties": { + "host": { + "type": "object", + "description": "Host name of the server. Type: string (or Expression with resultType string)." + }, + "userId": { + "type": "object", + "description": "User ID to logon the server. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password to logon the server.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "host" + ] + }, + "AzureFileStorageLinkedService": { + "x-ms-discriminator-value": "AzureFileStorage", + "description": "Azure File Storage linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure File Storage linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFileStorageLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureFileStorageLinkedServiceTypeProperties": { + "description": "Azure File Storage linked service properties.", + "type": "object", + "properties": { + "host": { + "type": "object", + "description": "Host name of the server. Type: string (or Expression with resultType string)." + }, + "userId": { + "type": "object", + "description": "User ID to logon the server. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password to logon the server.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "connectionString": { + "type": "object", + "description": "The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference." + }, + "accountKey": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of accountKey in connection string." + }, + "sasUri": { + "description": "SAS URI of the Azure File resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "sasToken": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of sasToken in sas uri." + }, + "fileShare": { + "description": "The azure file share name. It is required when auth with accountKey/sasToken. Type: string (or Expression with resultType string).", + "type": "object" + }, + "snapshot": { + "description": "The azure file share snapshot version. Type: string (or Expression with resultType string).", + "type": "object" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "host" + ] + }, + "GoogleCloudStorageLinkedService": { + "x-ms-discriminator-value": "GoogleCloudStorage", + "description": "Linked service for Google Cloud Storage.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Google Cloud Storage linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GoogleCloudStorageLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "GoogleCloudStorageLinkedServiceTypeProperties": { + "description": "Google Cloud Storage linked service properties.", + "type": "object", + "properties": { + "accessKeyId": { + "type": "object", + "description": "The access key identifier of the Google Cloud Storage Identity and Access Management (IAM) user. Type: string (or Expression with resultType string)." + }, + "secretAccessKey": { + "description": "The secret access key of the Google Cloud Storage Identity and Access Management (IAM) user.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "serviceUrl": { + "type": "object", + "description": "This value specifies the endpoint to access with the Google Cloud Storage Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + } + }, + "OracleLinkedService": { + "x-ms-discriminator-value": "Oracle", + "description": "Oracle database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Oracle database linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/OracleLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "OracleLinkedServiceTypeProperties": { + "description": "Oracle database linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "password": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "AzureMySqlLinkedService": { + "x-ms-discriminator-value": "AzureMySql", + "description": "Azure MySQL database linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure MySQL database linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureMySqlLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureMySqlLinkedServiceTypeProperties": { + "description": "Azure MySQL database linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "password": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "MySqlLinkedService": { + "x-ms-discriminator-value": "MySql", + "description": "Linked service for MySQL data source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "MySQL linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MySqlLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MySqlLinkedServiceTypeProperties": { + "description": "MySQL linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The connection string.", + "type": "object" + }, + "password": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "PostgreSqlLinkedService": { + "x-ms-discriminator-value": "PostgreSql", + "description": "Linked service for PostgreSQL data source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "PostgreSQL linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PostgreSqlLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "PostgreSqlLinkedServiceTypeProperties": { + "description": "PostgreSQL linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The connection string.", + "type": "object" + }, + "password": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "SybaseLinkedService": { + "x-ms-discriminator-value": "Sybase", + "description": "Linked service for Sybase data source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Sybase linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SybaseLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SybaseLinkedServiceTypeProperties": { + "description": "Sybase linked service properties.", + "type": "object", + "properties": { + "server": { + "type": "object", + "description": "Server name for connection. Type: string (or Expression with resultType string)." + }, + "database": { + "type": "object", + "description": "Database name for connection. Type: string (or Expression with resultType string)." + }, + "schema": { + "type": "object", + "description": "Schema name for connection. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "description": "AuthenticationType to be used for connection.", + "type": "string", + "enum": [ + "Basic", + "Windows" + ], + "x-ms-enum": { + "name": "SybaseAuthenticationType", + "modelAsString": true + } + }, + "username": { + "type": "object", + "description": "Username for authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password for authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "server", + "database" + ] + }, + "Db2LinkedService": { + "x-ms-discriminator-value": "Db2", + "description": "Linked service for DB2 data source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "DB2 linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/Db2LinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "Db2LinkedServiceTypeProperties": { + "description": "DB2 linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "type": "object", + "description": "The connection string. It is mutually exclusive with server, database, authenticationType, userName, packageCollection and certificateCommonName property. Type: string, SecureString or AzureKeyVaultSecretReference." + }, + "server": { + "type": "object", + "description": "Server name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string)." + }, + "database": { + "type": "object", + "description": "Database name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "description": "AuthenticationType to be used for connection. It is mutually exclusive with connectionString property.", + "type": "string", + "enum": [ + "Basic" + ], + "x-ms-enum": { + "name": "Db2AuthenticationType", + "modelAsString": true + } + }, + "username": { + "type": "object", + "description": "Username for authentication. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password for authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "packageCollection": { + "type": "object", + "description": "Under where packages are created when querying database. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string)." + }, + "certificateCommonName": { + "type": "object", + "description": "Certificate Common Name when TLS is enabled. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "server", + "database" + ] + }, + "TeradataLinkedService": { + "x-ms-discriminator-value": "Teradata", + "description": "Linked service for Teradata data source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Teradata linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/TeradataLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "TeradataLinkedServiceTypeProperties": { + "description": "Teradata linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "Teradata ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "server": { + "type": "object", + "description": "Server name for connection. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "description": "AuthenticationType to be used for connection.", + "type": "string", + "enum": [ + "Basic", + "Windows" + ], + "x-ms-enum": { + "name": "TeradataAuthenticationType", + "modelAsString": true + } + }, + "username": { + "type": "object", + "description": "Username for authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password for authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + } + }, + "AzureMLLinkedService": { + "x-ms-discriminator-value": "AzureML", + "description": "Azure ML Studio Web Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure ML Studio Web Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureMLLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureMLLinkedServiceTypeProperties": { + "description": "Azure ML Studio Web Service linked service properties.", + "type": "object", + "properties": { + "mlEndpoint": { + "type": "object", + "description": "The Batch Execution REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string)." + }, + "apiKey": { + "description": "The API key for accessing the Azure ML model endpoint.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "updateResourceEndpoint": { + "type": "object", + "description": "The Update Resource REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string)." + }, + "servicePrincipalId": { + "type": "object", + "description": "The ID of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The key of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service." + }, + "tenant": { + "type": "object", + "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "mlEndpoint", + "apiKey" + ] + }, + "AzureMLServiceLinkedService": { + "x-ms-discriminator-value": "AzureMLService", + "description": "Azure ML Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure ML Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureMLServiceLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureMLServiceLinkedServiceTypeProperties": { + "description": "Azure ML Service linked service properties.", + "type": "object", + "properties": { + "subscriptionId": { + "type": "object", + "description": "Azure ML Service workspace subscription ID. Type: string (or Expression with resultType string)." + }, + "resourceGroupName": { + "type": "object", + "description": "Azure ML Service workspace resource group name. Type: string (or Expression with resultType string)." + }, + "mlWorkspaceName": { + "type": "object", + "description": "Azure ML Service workspace name. Type: string (or Expression with resultType string)." + }, + "servicePrincipalId": { + "type": "object", + "description": "The ID of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The key of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline." + }, + "tenant": { + "type": "object", + "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "subscriptionId", + "resourceGroupName", + "mlWorkspaceName" + ] + }, + "OdbcLinkedService": { + "x-ms-discriminator-value": "Odbc", + "description": "Open Database Connectivity (ODBC) linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "ODBC linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/OdbcLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "OdbcLinkedServiceTypeProperties": { + "description": "ODBC linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "authenticationType": { + "type": "object", + "description": "Type of authentication used to connect to the ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string)." + }, + "credential": { + "description": "The access credential portion of the connection string specified in driver-specific property-value format.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "userName": { + "type": "object", + "description": "User name for Basic authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password for Basic authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "InformixLinkedService": { + "x-ms-discriminator-value": "Informix", + "description": "Informix linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Informix linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/InformixLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "InformixLinkedServiceTypeProperties": { + "description": "Informix linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "authenticationType": { + "type": "object", + "description": "Type of authentication used to connect to the Informix as ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string)." + }, + "credential": { + "description": "The access credential portion of the connection string specified in driver-specific property-value format.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "userName": { + "type": "object", + "description": "User name for Basic authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password for Basic authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "MicrosoftAccessLinkedService": { + "x-ms-discriminator-value": "MicrosoftAccess", + "description": "Microsoft Access linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Microsoft Access linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MicrosoftAccessLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MicrosoftAccessLinkedServiceTypeProperties": { + "description": "Microsoft Access linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "authenticationType": { + "type": "object", + "description": "Type of authentication used to connect to the Microsoft Access as ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string)." + }, + "credential": { + "description": "The access credential portion of the connection string specified in driver-specific property-value format.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "userName": { + "type": "object", + "description": "User name for Basic authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password for Basic authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "HdfsLinkedService": { + "x-ms-discriminator-value": "Hdfs", + "description": "Hadoop Distributed File System (HDFS) linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "HDFS linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HdfsLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HdfsLinkedServiceTypeProperties": { + "description": "HDFS linked service properties.", + "type": "object", + "properties": { + "url": { + "type": "object", + "description": "The URL of the HDFS service endpoint, e.g. http://myhostname:50070/webhdfs/v1 . Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "type": "object", + "description": "Type of authentication used to connect to the HDFS. Possible values are: Anonymous and Windows. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + }, + "userName": { + "type": "object", + "description": "User name for Windows authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password for Windows authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + } + }, + "required": [ + "url" + ] + }, + "ODataLinkedService": { + "x-ms-discriminator-value": "OData", + "description": "Open Data Protocol (OData) linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "OData linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ODataLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ODataLinkedServiceTypeProperties": { + "description": "OData linked service properties.", + "type": "object", + "properties": { + "url": { + "type": "object", + "description": "The URL of the OData service endpoint. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "description": "Type of authentication used to connect to the OData service.", + "type": "string", + "enum": [ + "Basic", + "Anonymous", + "Windows", + "AadServicePrincipal", + "ManagedServiceIdentity" + ], + "x-ms-enum": { + "name": "ODataAuthenticationType", + "modelAsString": true + } + }, + "userName": { + "type": "object", + "description": "User name of the OData service. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password of the OData service.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "tenant": { + "type": "object", + "description": "Specify the tenant information (domain name or tenant ID) under which your application resides. Type: string (or Expression with resultType string)." + }, + "servicePrincipalId": { + "type": "object", + "description": "Specify the application id of your application registered in Azure Active Directory. Type: string (or Expression with resultType string)." + }, + "azureCloudType": { + "type": "object", + "description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)." + }, + "aadResourceId": { + "type": "object", + "description": "Specify the resource you are requesting authorization to use Directory. Type: string (or Expression with resultType string)." + }, + "aadServicePrincipalCredentialType": { + "description": "Specify the credential type (key or cert) is used for service principal.", + "type": "string", + "enum": [ + "ServicePrincipalKey", + "ServicePrincipalCert" + ], + "x-ms-enum": { + "name": "ODataAadServicePrincipalCredentialType", + "modelAsString": true + } + }, + "servicePrincipalKey": { + "description": "Specify the secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "servicePrincipalEmbeddedCert": { + "description": "Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "servicePrincipalEmbeddedCertPassword": { + "description": "Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string).", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "url" + ] + }, + "WebLinkedService": { + "x-ms-discriminator-value": "Web", + "description": "Web linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Web linked service properties.", + "$ref": "#/definitions/WebLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "WebLinkedServiceTypeProperties": { + "description": "Base definition of WebLinkedServiceTypeProperties, this typeProperties is polymorphic based on authenticationType, so not flattened in SDK models.", + "discriminator": "authenticationType", + "type": "object", + "properties": { + "url": { + "type": "object", + "description": "The URL of the web service endpoint, e.g. http://www.microsoft.com . Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "description": "Type of authentication used to connect to the web table source.", + "type": "string", + "enum": [ + "Basic", + "Anonymous", + "ClientCertificate" + ], + "x-ms-enum": { + "name": "WebAuthenticationType", + "modelAsString": true + } + } + }, + "required": [ + "authenticationType", + "url" + ] + }, + "WebAnonymousAuthentication": { + "description": "A WebLinkedService that uses anonymous authentication to communicate with an HTTP endpoint.", + "type": "object", + "x-ms-discriminator-value": "Anonymous", + "allOf": [ + { + "$ref": "#/definitions/WebLinkedServiceTypeProperties" + } + ] + }, + "WebBasicAuthentication": { + "description": "A WebLinkedService that uses basic authentication to communicate with an HTTP endpoint.", + "type": "object", + "x-ms-discriminator-value": "Basic", + "allOf": [ + { + "$ref": "#/definitions/WebLinkedServiceTypeProperties" + } + ], + "properties": { + "username": { + "type": "object", + "description": "User name for Basic authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "The password for Basic authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + } + }, + "required": [ + "username", + "password" + ] + }, + "WebClientCertificateAuthentication": { + "description": "A WebLinkedService that uses client certificate based authentication to communicate with an HTTP endpoint. This scheme follows mutual authentication; the server must also provide valid credentials to the client.", + "type": "object", + "x-ms-discriminator-value": "ClientCertificate", + "allOf": [ + { + "$ref": "#/definitions/WebLinkedServiceTypeProperties" + } + ], + "properties": { + "pfx": { + "description": "Base64-encoded contents of a PFX file.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "password": { + "description": "Password for the PFX file.", + "$ref": "../artifacts.json#/definitions/SecretBase" + } + }, + "required": [ + "pfx", + "password" + ] + }, + "CassandraLinkedService": { + "x-ms-discriminator-value": "Cassandra", + "description": "Linked service for Cassandra data source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Cassandra linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CassandraLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "CassandraLinkedServiceTypeProperties": { + "description": "Cassandra linked service properties.", + "type": "object", + "properties": { + "host": { + "type": "object", + "description": "Host name for connection. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "type": "object", + "description": "AuthenticationType to be used for connection. Type: string (or Expression with resultType string)." + }, + "port": { + "type": "object", + "description": "The port for the connection. Type: integer (or Expression with resultType integer)." + }, + "username": { + "type": "object", + "description": "Username for authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password for authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "host" + ] + }, + "MongoDbLinkedService": { + "x-ms-discriminator-value": "MongoDb", + "description": "Linked service for MongoDb data source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "MongoDB linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MongoDbLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MongoDbLinkedServiceTypeProperties": { + "description": "MongoDB linked service properties.", + "type": "object", + "properties": { + "server": { + "type": "object", + "description": "The IP address or server name of the MongoDB server. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "description": "The authentication type to be used to connect to the MongoDB database.", + "type": "string", + "enum": [ + "Basic", + "Anonymous" + ], + "x-ms-enum": { + "name": "MongoDbAuthenticationType", + "modelAsString": true + } + }, + "databaseName": { + "type": "object", + "description": "The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string)." + }, + "username": { + "type": "object", + "description": "Username for authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password for authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "authSource": { + "type": "object", + "description": "Database to verify the username and password. Type: string (or Expression with resultType string)." + }, + "port": { + "type": "object", + "description": "The TCP port number that the MongoDB server uses to listen for client connections. The default value is 27017. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "enableSsl": { + "type": "object", + "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false. Type: boolean (or Expression with resultType boolean)." + }, + "allowSelfSignedServerCert": { + "type": "object", + "description": "Specifies whether to allow self-signed certificates from the server. The default value is false. Type: boolean (or Expression with resultType boolean)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "server", + "databaseName" + ] + }, + "MongoDbAtlasLinkedService": { + "x-ms-discriminator-value": "MongoDbAtlas", + "description": "Linked service for MongoDB Atlas data source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "MongoDB Atlas linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MongoDbAtlasLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MongoDbAtlasLinkedServiceTypeProperties": { + "description": "MongoDB Atlas linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The MongoDB Atlas connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "database": { + "type": "object", + "description": "The name of the MongoDB Atlas database that you want to access. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString", + "database" + ] + }, + "MongoDbV2LinkedService": { + "x-ms-discriminator-value": "MongoDbV2", + "description": "Linked service for MongoDB data source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "MongoDB linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MongoDbV2LinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MongoDbV2LinkedServiceTypeProperties": { + "description": "MongoDB linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The MongoDB connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "database": { + "type": "object", + "description": "The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString", + "database" + ] + }, + "CosmosDbMongoDbApiLinkedService": { + "x-ms-discriminator-value": "CosmosDbMongoDbApi", + "description": "Linked service for CosmosDB (MongoDB API) data source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "CosmosDB (MongoDB API) linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CosmosDbMongoDbApiLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "CosmosDbMongoDbApiLinkedServiceTypeProperties": { + "description": "CosmosDB (MongoDB API) linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The CosmosDB (MongoDB API) connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "database": { + "type": "object", + "description": "The name of the CosmosDB (MongoDB API) database that you want to access. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString", + "database" + ] + }, + "AzureDataLakeStoreLinkedService": { + "x-ms-discriminator-value": "AzureDataLakeStore", + "description": "Azure Data Lake Store linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Data Lake Store linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureDataLakeStoreLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureDataLakeStoreLinkedServiceTypeProperties": { + "description": "Azure Data Lake Store linked service properties.", + "type": "object", + "properties": { + "dataLakeStoreUri": { + "type": "object", + "description": "Data Lake Store service URI. Type: string (or Expression with resultType string)." + }, + "servicePrincipalId": { + "type": "object", + "description": "The ID of the application used to authenticate against the Azure Data Lake Store account. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "description": "The Key of the application used to authenticate against the Azure Data Lake Store account.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "tenant": { + "type": "object", + "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." + }, + "azureCloudType": { + "type": "object", + "description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)." + }, + "accountName": { + "type": "object", + "description": "Data Lake Store account name. Type: string (or Expression with resultType string)." + }, + "subscriptionId": { + "type": "object", + "description": "Data Lake Store account subscription ID (if different from Data Factory account). Type: string (or Expression with resultType string)." + }, + "resourceGroupName": { + "type": "object", + "description": "Data Lake Store account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "dataLakeStoreUri" + ] + }, + "AzureBlobFSLinkedService": { + "x-ms-discriminator-value": "AzureBlobFS", + "description": "Azure Data Lake Storage Gen2 linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Data Lake Storage Gen2 linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureBlobFSLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureBlobFSLinkedServiceTypeProperties": { + "description": "Azure Data Lake Storage Gen2 linked service properties.", + "type": "object", + "properties": { + "url": { + "type": "object", + "description": "Endpoint for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string)." + }, + "accountKey": { + "type": "object", + "description": "Account key for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string)." + }, + "servicePrincipalId": { + "type": "object", + "description": "The ID of the application used to authenticate against the Azure Data Lake Storage Gen2 account. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "description": "The Key of the application used to authenticate against the Azure Data Lake Storage Gen2 account.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "tenant": { + "type": "object", + "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." + }, + "azureCloudType": { + "type": "object", + "description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "url" + ] + }, + "Office365LinkedService": { + "x-ms-discriminator-value": "Office365", + "description": "Office365 linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Office365 linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/Office365LinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "Office365LinkedServiceTypeProperties": { + "description": "Office365 linked service properties.", + "type": "object", + "properties": { + "office365TenantId": { + "type": "object", + "description": "Azure tenant ID to which the Office 365 account belongs. Type: string (or Expression with resultType string)." + }, + "servicePrincipalTenantId": { + "type": "object", + "description": "Specify the tenant information under which your Azure AD web application resides. Type: string (or Expression with resultType string)." + }, + "servicePrincipalId": { + "type": "object", + "description": "Specify the application's client ID. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "description": "Specify the application's key.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "office365TenantId", + "servicePrincipalTenantId", + "servicePrincipalId", + "servicePrincipalKey" + ] + }, + "SalesforceLinkedService": { + "x-ms-discriminator-value": "Salesforce", + "description": "Linked service for Salesforce.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Salesforce linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SalesforceLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SalesforceLinkedServiceTypeProperties": { + "description": "Salesforce linked service properties.", + "type": "object", + "properties": { + "environmentUrl": { + "type": "object", + "description": "The URL of Salesforce instance. Default is 'https://login.salesforce.com'. To copy data from sandbox, specify 'https://test.salesforce.com'. To copy data from custom domain, specify, for example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string)." + }, + "username": { + "type": "object", + "description": "The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "The password for Basic authentication of the Salesforce instance.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "securityToken": { + "description": "The security token is optional to remotely access Salesforce instance.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "apiVersion": { + "type": "object", + "description": "The Salesforce API version used in ADF. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + } + }, + "SalesforceServiceCloudLinkedService": { + "x-ms-discriminator-value": "SalesforceServiceCloud", + "description": "Linked service for Salesforce Service Cloud.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Salesforce Service Cloud linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SalesforceServiceCloudLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SalesforceServiceCloudLinkedServiceTypeProperties": { + "description": "Salesforce Service Cloud linked service properties.", + "type": "object", + "properties": { + "environmentUrl": { + "type": "object", + "description": "The URL of Salesforce Service Cloud instance. Default is 'https://login.salesforce.com'. To copy data from sandbox, specify 'https://test.salesforce.com'. To copy data from custom domain, specify, for example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string)." + }, + "username": { + "type": "object", + "description": "The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "The password for Basic authentication of the Salesforce instance.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "securityToken": { + "description": "The security token is optional to remotely access Salesforce instance.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "apiVersion": { + "type": "object", + "description": "The Salesforce API version used in ADF. Type: string (or Expression with resultType string)." + }, + "extendedProperties": { + "type": "object", + "description": "Extended properties appended to the connection string. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + } + }, + "SapCloudForCustomerLinkedService": { + "x-ms-discriminator-value": "SapCloudForCustomer", + "description": "Linked service for SAP Cloud for Customer.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "SAP Cloud for Customer linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SapCloudForCustomerLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SapCloudForCustomerLinkedServiceTypeProperties": { + "description": "SAP Cloud for Customer linked service properties.", + "type": "object", + "properties": { + "url": { + "type": "object", + "description": "The URL of SAP Cloud for Customer OData API. For example, '[https://[tenantname].crm.ondemand.com/sap/c4c/odata/v1]'. Type: string (or Expression with resultType string)." + }, + "username": { + "type": "object", + "description": "The username for Basic authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "The password for Basic authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "url" + ] + }, + "SapEccLinkedService": { + "x-ms-discriminator-value": "SapEcc", + "description": "Linked service for SAP ERP Central Component(SAP ECC).", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "SAP ECC linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SapEccLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SapEccLinkedServiceTypeProperties": { + "description": "SAP ECC linked service properties.", + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "The URL of SAP ECC OData API. For example, '[https://hostname:port/sap/opu/odata/sap/servicename/]'. Type: string (or Expression with resultType string)." + }, + "username": { + "type": "string", + "description": "The username for Basic authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "The password for Basic authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "string", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "url" + ] + }, + "SapOpenHubLinkedService": { + "x-ms-discriminator-value": "SapOpenHub", + "description": "SAP Business Warehouse Open Hub Destination Linked Service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to SAP Business Warehouse Open Hub Destination linked service type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SapOpenHubLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SapOpenHubLinkedServiceTypeProperties": { + "description": "Properties specific to SAP Business Warehouse Open Hub Destination linked service type.", + "type": "object", + "properties": { + "server": { + "type": "object", + "description": "Host name of the SAP BW instance where the open hub destination is located. Type: string (or Expression with resultType string)." + }, + "systemNumber": { + "type": "object", + "description": "System number of the BW system where the open hub destination is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string)." + }, + "clientId": { + "type": "object", + "description": "Client ID of the client on the BW system where the open hub destination is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string)." + }, + "language": { + "type": "object", + "description": "Language of the BW system where the open hub destination is located. The default value is EN. Type: string (or Expression with resultType string)." + }, + "systemId": { + "type": "object", + "description": "SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string)." + }, + "userName": { + "type": "object", + "description": "Username to access the SAP BW server where the open hub destination is located. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password to access the SAP BW server where the open hub destination is located.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "messageServer": { + "type": "object", + "description": "The hostname of the SAP Message Server. Type: string (or Expression with resultType string)." + }, + "messageServerService": { + "type": "object", + "description": "The service name or port number of the Message Server. Type: string (or Expression with resultType string)." + }, + "logonGroup": { + "type": "object", + "description": "The Logon Group for the SAP System. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "server", + "systemNumber", + "clientId" + ] + }, + "RestServiceLinkedService": { + "x-ms-discriminator-value": "RestService", + "description": "Rest Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Rest Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/RestServiceLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "RestServiceLinkedServiceTypeProperties": { + "description": "Rest Service linked service properties.", + "type": "object", + "properties": { + "url": { + "description": "The base URL of the REST service.", + "type": "object" + }, + "enableServerCertificateValidation": { + "type": "object", + "description": "Whether to validate server side SSL certificate when connecting to the endpoint.The default value is true. Type: boolean (or Expression with resultType boolean)." + }, + "authenticationType": { + "description": "Type of authentication used to connect to the REST service.", + "type": "string", + "enum": [ + "Anonymous", + "Basic", + "AadServicePrincipal", + "ManagedServiceIdentity" + ], + "x-ms-enum": { + "name": "RestServiceAuthenticationType", + "modelAsString": true + } + }, + "userName": { + "description": "The user name used in Basic authentication type.", + "type": "object" + }, + "password": { + "description": "The password used in Basic authentication type.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "servicePrincipalId": { + "description": "The application's client ID used in AadServicePrincipal authentication type.", + "type": "object" + }, + "servicePrincipalKey": { + "description": "The application's key used in AadServicePrincipal authentication type.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "tenant": { + "description": "The tenant information (domain name or tenant ID) used in AadServicePrincipal authentication type under which your application resides.", + "type": "object" + }, + "azureCloudType": { + "type": "object", + "description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)." + }, + "aadResourceId": { + "description": "The resource you are requesting authorization to use.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "url", + "authenticationType" + ] + }, + "AmazonS3LinkedService": { + "x-ms-discriminator-value": "AmazonS3", + "description": "Linked service for Amazon S3.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Amazon S3 linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AmazonS3LinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AmazonS3LinkedServiceTypeProperties": { + "description": "Amazon S3 linked service properties.", + "type": "object", + "properties": { + "authenticationType": { + "type": "object", + "description": "The authentication type of S3. Allowed value: AccessKey (default) or TemporarySecurityCredentials. Type: string (or Expression with resultType string)." + }, + "accessKeyId": { + "type": "object", + "description": "The access key identifier of the Amazon S3 Identity and Access Management (IAM) user. Type: string (or Expression with resultType string)." + }, + "secretAccessKey": { + "description": "The secret access key of the Amazon S3 Identity and Access Management (IAM) user.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "serviceUrl": { + "type": "object", + "description": "This value specifies the endpoint to access with the S3 Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string)." + }, + "sessionToken": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The session token for the S3 temporary security credential." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + } + }, + "AmazonRedshiftLinkedService": { + "x-ms-discriminator-value": "AmazonRedshift", + "description": "Linked service for Amazon Redshift.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Amazon Redshift linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AmazonRedshiftLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AmazonRedshiftLinkedServiceTypeProperties": { + "description": "Amazon Redshift linked service properties.", + "type": "object", + "properties": { + "server": { + "type": "object", + "description": "The name of the Amazon Redshift server. Type: string (or Expression with resultType string)." + }, + "username": { + "type": "object", + "description": "The username of the Amazon Redshift source. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "The password of the Amazon Redshift source.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "database": { + "type": "object", + "description": "The database name of the Amazon Redshift source. Type: string (or Expression with resultType string)." + }, + "port": { + "type": "object", + "description": "The TCP port number that the Amazon Redshift server uses to listen for client connections. The default value is 5439. Type: integer (or Expression with resultType integer)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "server", + "database" + ] + }, + "CustomDataSourceLinkedService": { + "x-ms-discriminator-value": "CustomDataSource", + "description": "Custom linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Custom linked service properties.", + "x-ms-client-flatten": true, + "type": "object" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureSearchLinkedService": { + "x-ms-discriminator-value": "AzureSearch", + "description": "Linked service for Windows Azure Search Service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Windows Azure Search Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureSearchLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureSearchLinkedServiceTypeProperties": { + "description": "Windows Azure Search Service linked service properties.", + "type": "object", + "properties": { + "url": { + "type": "object", + "description": "URL for Azure Search service. Type: string (or Expression with resultType string)." + }, + "key": { + "description": "Admin Key for Azure Search service", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "url" + ] + }, + "HttpLinkedService": { + "x-ms-discriminator-value": "HttpServer", + "description": "Linked service for an HTTP source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this linked service type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HttpLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HttpLinkedServiceTypeProperties": { + "description": "Properties specific to this linked service type.", + "type": "object", + "properties": { + "url": { + "type": "object", + "description": "The base URL of the HTTP endpoint, e.g. http://www.microsoft.com. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "description": "The authentication type to be used to connect to the HTTP server.", + "type": "string", + "enum": [ + "Basic", + "Anonymous", + "Digest", + "Windows", + "ClientCertificate" + ], + "x-ms-enum": { + "name": "HttpAuthenticationType", + "modelAsString": true + } + }, + "userName": { + "type": "object", + "description": "User name for Basic, Digest, or Windows authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password for Basic, Digest, Windows, or ClientCertificate with EmbeddedCertData authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "embeddedCertData": { + "type": "object", + "description": "Base64 encoded certificate data for ClientCertificate authentication. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string)." + }, + "certThumbprint": { + "type": "object", + "description": "Thumbprint of certificate for ClientCertificate authentication. Only valid for on-premises copy. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + }, + "enableServerCertificateValidation": { + "type": "object", + "description": "If true, validate the HTTPS server SSL certificate. Default value is true. Type: boolean (or Expression with resultType boolean)." + } + }, + "required": [ + "url" + ] + }, + "FtpServerLinkedService": { + "x-ms-discriminator-value": "FtpServer", + "description": "A FTP server Linked Service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this linked service type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/FtpServerLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "FtpServerLinkedServiceTypeProperties": { + "description": "Properties specific to this linked service type.", + "type": "object", + "properties": { + "host": { + "type": "object", + "description": "Host name of the FTP server. Type: string (or Expression with resultType string)." + }, + "port": { + "type": "object", + "description": "The TCP port number that the FTP server uses to listen for client connections. Default value is 21. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "authenticationType": { + "description": "The authentication type to be used to connect to the FTP server.", + "type": "string", + "enum": [ + "Basic", + "Anonymous" + ], + "x-ms-enum": { + "name": "FtpAuthenticationType", + "modelAsString": true + } + }, + "userName": { + "type": "object", + "description": "Username to logon the FTP server. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password to logon the FTP server.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + }, + "enableSsl": { + "type": "object", + "description": "If true, connect to the FTP server over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean)." + }, + "enableServerCertificateValidation": { + "type": "object", + "description": "If true, validate the FTP server SSL certificate when connect over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean)." + } + }, + "required": [ + "host" + ] + }, + "SftpServerLinkedService": { + "x-ms-discriminator-value": "Sftp", + "description": "A linked service for an SSH File Transfer Protocol (SFTP) server. ", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this linked service type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SftpServerLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SftpServerLinkedServiceTypeProperties": { + "description": "Properties specific to this linked service type.", + "type": "object", + "properties": { + "host": { + "type": "object", + "description": "The SFTP server host name. Type: string (or Expression with resultType string)." + }, + "port": { + "type": "object", + "description": "The TCP port number that the SFTP server uses to listen for client connections. Default value is 22. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "authenticationType": { + "description": "The authentication type to be used to connect to the FTP server.", + "type": "string", + "enum": [ + "Basic", + "SshPublicKey" + ], + "x-ms-enum": { + "name": "SftpAuthenticationType", + "modelAsString": true + } + }, + "userName": { + "type": "object", + "description": "The username used to log on to the SFTP server. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password to logon the SFTP server for Basic authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + }, + "privateKeyPath": { + "type": "object", + "description": "The SSH private key file path for SshPublicKey authentication. Only valid for on-premises copy. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format. Type: string (or Expression with resultType string)." + }, + "privateKeyContent": { + "description": "Base64 encoded SSH private key content for SshPublicKey authentication. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "passPhrase": { + "description": "The password to decrypt the SSH private key if the SSH private key is encrypted.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "skipHostKeyValidation": { + "type": "object", + "description": "If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean)." + }, + "hostKeyFingerprint": { + "type": "object", + "description": "The host key finger-print of the SFTP server. When SkipHostKeyValidation is false, HostKeyFingerprint should be specified. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "host" + ] + }, + "SapBWLinkedService": { + "x-ms-discriminator-value": "SapBW", + "description": "SAP Business Warehouse Linked Service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this linked service type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SapBWLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SapBWLinkedServiceTypeProperties": { + "description": "Properties specific to this linked service type.", + "type": "object", + "properties": { + "server": { + "type": "object", + "description": "Host name of the SAP BW instance. Type: string (or Expression with resultType string)." + }, + "systemNumber": { + "type": "object", + "description": "System number of the BW system. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string)." + }, + "clientId": { + "type": "object", + "description": "Client ID of the client on the BW system. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string)." + }, + "userName": { + "type": "object", + "description": "Username to access the SAP BW server. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password to access the SAP BW server.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "server", + "systemNumber", + "clientId" + ] + }, + "SapHanaLinkedService": { + "x-ms-discriminator-value": "SapHana", + "description": "SAP HANA Linked Service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this linked service type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SapHanaLinkedServiceProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SapHanaLinkedServiceProperties": { + "description": "Properties specific to this linked service type.", + "type": "object", + "properties": { + "connectionString": { + "type": "object", + "description": "SAP HANA ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference." + }, + "server": { + "type": "object", + "description": "Host name of the SAP HANA server. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "description": "The authentication type to be used to connect to the SAP HANA server.", + "type": "string", + "enum": [ + "Basic", + "Windows" + ], + "x-ms-enum": { + "name": "SapHanaAuthenticationType", + "modelAsString": true + } + }, + "userName": { + "type": "object", + "description": "Username to access the SAP HANA server. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password to access the SAP HANA server.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "server" + ] + }, + "AmazonMWSLinkedService": { + "x-ms-discriminator-value": "AmazonMWS", + "description": "Amazon Marketplace Web Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Amazon Marketplace Web Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AmazonMWSLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AmazonMWSLinkedServiceTypeProperties": { + "description": "Amazon Marketplace Web Service linked service properties.", + "type": "object", + "properties": { + "endpoint": { + "description": "The endpoint of the Amazon MWS server, (i.e. mws.amazonservices.com)", + "type": "object" + }, + "marketplaceID": { + "description": "The Amazon Marketplace ID you want to retrieve data from. To retrieve data from multiple Marketplace IDs, separate them with a comma (,). (i.e. A2EUQ1WTGCTBG2)", + "type": "object" + }, + "sellerID": { + "description": "The Amazon seller ID.", + "type": "object" + }, + "mwsAuthToken": { + "description": "The Amazon MWS authentication token.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "accessKeyId": { + "description": "The access key id used to access data.", + "type": "object" + }, + "secretKey": { + "description": "The secret key used to access data.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "endpoint", + "marketplaceID", + "sellerID", + "accessKeyId" + ] + }, + "AzurePostgreSqlLinkedService": { + "x-ms-discriminator-value": "AzurePostgreSql", + "description": "Azure PostgreSQL linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure PostgreSQL linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzurePostgreSqlLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzurePostgreSqlLinkedServiceTypeProperties": { + "description": "Azure PostgreSQL linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "password": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + } + }, + "ConcurLinkedService": { + "x-ms-discriminator-value": "Concur", + "description": "Concur Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Concur Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConcurLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ConcurLinkedServiceTypeProperties": { + "description": "Concur Service linked service properties.", + "type": "object", + "properties": { + "connectionProperties": { + "description": "Properties used to connect to Concur. It is mutually exclusive with any other properties in the linked service. Type: object.", + "type": "object" + }, + "clientId": { + "description": "Application client_id supplied by Concur App Management.", + "type": "object" + }, + "username": { + "description": "The user name that you use to access Concur Service.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name that you provided in the username field.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "clientId", + "username" + ] + }, + "CouchbaseLinkedService": { + "x-ms-discriminator-value": "Couchbase", + "description": "Couchbase server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Couchbase server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CouchbaseLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "CouchbaseLinkedServiceTypeProperties": { + "description": "Couchbase server linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "credString": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of credString in connection string." + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + } + }, + "DrillLinkedService": { + "x-ms-discriminator-value": "Drill", + "description": "Drill server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Drill server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DrillLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DrillLinkedServiceTypeProperties": { + "description": "Drill server linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "pwd": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + } + }, + "EloquaLinkedService": { + "x-ms-discriminator-value": "Eloqua", + "description": "Eloqua server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Eloqua server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/EloquaLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "EloquaLinkedServiceTypeProperties": { + "description": "Eloqua server linked service properties.", + "type": "object", + "properties": { + "endpoint": { + "description": "The endpoint of the Eloqua server. (i.e. eloqua.example.com)", + "type": "object" + }, + "username": { + "description": "The site name and user name of your Eloqua account in the form: sitename/username. (i.e. Eloqua/Alice)", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "endpoint", + "username" + ] + }, + "GoogleBigQueryLinkedService": { + "x-ms-discriminator-value": "GoogleBigQuery", + "description": "Google BigQuery service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Google BigQuery service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GoogleBigQueryLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "GoogleBigQueryLinkedServiceTypeProperties": { + "description": "Google BigQuery service linked service properties.", + "type": "object", + "properties": { + "project": { + "description": "The default BigQuery project to query against.", + "type": "object" + }, + "additionalProjects": { + "description": "A comma-separated list of public BigQuery projects to access.", + "type": "object" + }, + "requestGoogleDriveScope": { + "description": "Whether to request access to Google Drive. Allowing Google Drive access enables support for federated tables that combine BigQuery data with data from Google Drive. The default value is false.", + "type": "object" + }, + "authenticationType": { + "description": "The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR.", + "type": "string", + "enum": [ + "ServiceAuthentication", + "UserAuthentication" + ], + "x-ms-enum": { + "name": "GoogleBigQueryAuthenticationType", + "modelAsString": true + } + }, + "refreshToken": { + "description": "The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "clientId": { + "description": "The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).", + "type": "object" + }, + "clientSecret": { + "description": "The client secret of the google application used to acquire the refresh token.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "email": { + "description": "The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.", + "type": "object" + }, + "keyFilePath": { + "description": "The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "useSystemTrustStore": { + "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "project", + "authenticationType" + ] + }, + "GreenplumLinkedService": { + "x-ms-discriminator-value": "Greenplum", + "description": "Greenplum Database linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Greenplum Database linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GreenplumLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "GreenplumLinkedServiceTypeProperties": { + "description": "Greenplum Database linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "pwd": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + } + }, + "HBaseLinkedService": { + "x-ms-discriminator-value": "HBase", + "description": "HBase server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "HBase server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HBaseLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HBaseLinkedServiceTypeProperties": { + "description": "HBase server linked service properties.", + "type": "object", + "properties": { + "host": { + "description": "The IP address or host name of the HBase server. (i.e. 192.168.222.160)", + "type": "object" + }, + "port": { + "description": "The TCP port that the HBase instance uses to listen for client connections. The default value is 9090.", + "type": "object" + }, + "httpPath": { + "description": "The partial URL corresponding to the HBase server. (i.e. /gateway/sandbox/hbase/version)", + "type": "object" + }, + "authenticationType": { + "description": "The authentication mechanism to use to connect to the HBase server.", + "type": "string", + "enum": [ + "Anonymous", + "Basic" + ], + "x-ms-enum": { + "name": "HBaseAuthenticationType", + "modelAsString": true + } + }, + "username": { + "description": "The user name used to connect to the HBase instance.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "enableSsl": { + "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "allowHostNameCNMismatch": { + "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.", + "type": "object" + }, + "allowSelfSignedServerCert": { + "description": "Specifies whether to allow self-signed certificates from the server. The default value is false.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "authenticationType" + ] + }, + "HiveLinkedService": { + "x-ms-discriminator-value": "Hive", + "description": "Hive Server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Hive Server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HiveLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HiveLinkedServiceTypeProperties": { + "description": "Hive Server linked service properties.", + "type": "object", + "properties": { + "host": { + "description": "IP address or host name of the Hive server, separated by ';' for multiple hosts (only when serviceDiscoveryMode is enable).", + "type": "object" + }, + "port": { + "description": "The TCP port that the Hive server uses to listen for client connections.", + "type": "object" + }, + "serverType": { + "description": "The type of Hive server.", + "type": "string", + "enum": [ + "HiveServer1", + "HiveServer2", + "HiveThriftServer" + ], + "x-ms-enum": { + "name": "HiveServerType", + "modelAsString": true + } + }, + "thriftTransportProtocol": { + "description": "The transport protocol to use in the Thrift layer.", + "type": "string", + "enum": [ + "Binary", + "SASL", + "HTTP " + ], + "x-ms-enum": { + "name": "HiveThriftTransportProtocol", + "modelAsString": true + } + }, + "authenticationType": { + "description": "The authentication method used to access the Hive server.", + "type": "string", + "enum": [ + "Anonymous", + "Username", + "UsernameAndPassword", + "WindowsAzureHDInsightService" + ], + "x-ms-enum": { + "name": "HiveAuthenticationType", + "modelAsString": true + } + }, + "serviceDiscoveryMode": { + "description": "true to indicate using the ZooKeeper service, false not.", + "type": "object" + }, + "zooKeeperNameSpace": { + "description": "The namespace on ZooKeeper under which Hive Server 2 nodes are added.", + "type": "object" + }, + "useNativeQuery": { + "description": "Specifies whether the driver uses native HiveQL queries,or converts them into an equivalent form in HiveQL.", + "type": "object" + }, + "username": { + "description": "The user name that you use to access Hive Server.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name that you provided in the Username field", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "httpPath": { + "description": "The partial URL corresponding to the Hive server.", + "type": "object" + }, + "enableSsl": { + "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "useSystemTrustStore": { + "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.", + "type": "object" + }, + "allowHostNameCNMismatch": { + "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.", + "type": "object" + }, + "allowSelfSignedServerCert": { + "description": "Specifies whether to allow self-signed certificates from the server. The default value is false.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "authenticationType" + ] + }, + "HubspotLinkedService": { + "x-ms-discriminator-value": "Hubspot", + "description": "Hubspot Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Hubspot Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HubspotLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HubspotLinkedServiceTypeProperties": { + "description": "Hubspot Service linked service properties.", + "type": "object", + "properties": { + "clientId": { + "description": "The client ID associated with your Hubspot application.", + "type": "object" + }, + "clientSecret": { + "description": "The client secret associated with your Hubspot application.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "accessToken": { + "description": "The access token obtained when initially authenticating your OAuth integration.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "refreshToken": { + "description": "The refresh token obtained when initially authenticating your OAuth integration.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "clientId" + ] + }, + "ImpalaLinkedService": { + "x-ms-discriminator-value": "Impala", + "description": "Impala server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Impala server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImpalaLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ImpalaLinkedServiceTypeProperties": { + "description": "Impala server linked service properties.", + "type": "object", + "properties": { + "host": { + "description": "The IP address or host name of the Impala server. (i.e. 192.168.222.160)", + "type": "object" + }, + "port": { + "description": "The TCP port that the Impala server uses to listen for client connections. The default value is 21050.", + "type": "object" + }, + "authenticationType": { + "description": "The authentication type to use.", + "type": "string", + "enum": [ + "Anonymous", + "SASLUsername", + "UsernameAndPassword" + ], + "x-ms-enum": { + "name": "ImpalaAuthenticationType", + "modelAsString": true + } + }, + "username": { + "description": "The user name used to access the Impala server. The default value is anonymous when using SASLUsername.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name when using UsernameAndPassword.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "enableSsl": { + "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "useSystemTrustStore": { + "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.", + "type": "object" + }, + "allowHostNameCNMismatch": { + "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.", + "type": "object" + }, + "allowSelfSignedServerCert": { + "description": "Specifies whether to allow self-signed certificates from the server. The default value is false.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "authenticationType" + ] + }, + "JiraLinkedService": { + "x-ms-discriminator-value": "Jira", + "description": "Jira Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Jira Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/JiraLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "JiraLinkedServiceTypeProperties": { + "description": "Jira Service linked service properties.", + "type": "object", + "properties": { + "host": { + "description": "The IP address or host name of the Jira service. (e.g. jira.example.com)", + "type": "object" + }, + "port": { + "description": "The TCP port that the Jira server uses to listen for client connections. The default value is 443 if connecting through HTTPS, or 8080 if connecting through HTTP.", + "type": "object" + }, + "username": { + "description": "The user name that you use to access Jira Service.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name that you provided in the username field.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "username" + ] + }, + "MagentoLinkedService": { + "x-ms-discriminator-value": "Magento", + "description": "Magento server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Magento server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MagentoLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MagentoLinkedServiceTypeProperties": { + "description": "Magento server linked service properties.", + "type": "object", + "properties": { + "host": { + "description": "The URL of the Magento instance. (i.e. 192.168.222.110/magento3)", + "type": "object" + }, + "accessToken": { + "description": "The access token from Magento.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host" + ] + }, + "MariaDBLinkedService": { + "x-ms-discriminator-value": "MariaDB", + "description": "MariaDB server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "MariaDB server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MariaDBLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MariaDBLinkedServiceTypeProperties": { + "description": "MariaDB server linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "pwd": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + } + }, + "AzureMariaDBLinkedService": { + "x-ms-discriminator-value": "AzureMariaDB", + "description": "Azure Database for MariaDB linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Database for MariaDB linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureMariaDBLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureMariaDBLinkedServiceTypeProperties": { + "description": "Azure Database for MariaDB linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "pwd": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + } + }, + "MarketoLinkedService": { + "x-ms-discriminator-value": "Marketo", + "description": "Marketo server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Marketo server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MarketoLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MarketoLinkedServiceTypeProperties": { + "description": "Marketo server linked service properties.", + "type": "object", + "properties": { + "endpoint": { + "description": "The endpoint of the Marketo server. (i.e. 123-ABC-321.mktorest.com)", + "type": "object" + }, + "clientId": { + "description": "The client Id of your Marketo service.", + "type": "object" + }, + "clientSecret": { + "description": "The client secret of your Marketo service.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "endpoint", + "clientId" + ] + }, + "PaypalLinkedService": { + "x-ms-discriminator-value": "Paypal", + "description": "Paypal Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Paypal Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PaypalLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "PaypalLinkedServiceTypeProperties": { + "description": "Paypal Service linked service properties.", + "type": "object", + "properties": { + "host": { + "description": "The URL of the PayPal instance. (i.e. api.sandbox.paypal.com)", + "type": "object" + }, + "clientId": { + "description": "The client ID associated with your PayPal application.", + "type": "object" + }, + "clientSecret": { + "description": "The client secret associated with your PayPal application.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "clientId" + ] + }, + "PhoenixLinkedService": { + "x-ms-discriminator-value": "Phoenix", + "description": "Phoenix server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Phoenix server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PhoenixLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "PhoenixLinkedServiceTypeProperties": { + "description": "Phoenix server linked service properties.", + "type": "object", + "properties": { + "host": { + "description": "The IP address or host name of the Phoenix server. (i.e. 192.168.222.160)", + "type": "object" + }, + "port": { + "description": "The TCP port that the Phoenix server uses to listen for client connections. The default value is 8765.", + "type": "object" + }, + "httpPath": { + "description": "The partial URL corresponding to the Phoenix server. (i.e. /gateway/sandbox/phoenix/version). The default value is hbasephoenix if using WindowsAzureHDInsightService.", + "type": "object" + }, + "authenticationType": { + "description": "The authentication mechanism used to connect to the Phoenix server.", + "type": "string", + "enum": [ + "Anonymous", + "UsernameAndPassword", + "WindowsAzureHDInsightService" + ], + "x-ms-enum": { + "name": "PhoenixAuthenticationType", + "modelAsString": true + } + }, + "username": { + "description": "The user name used to connect to the Phoenix server.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "enableSsl": { + "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "useSystemTrustStore": { + "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.", + "type": "object" + }, + "allowHostNameCNMismatch": { + "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.", + "type": "object" + }, + "allowSelfSignedServerCert": { + "description": "Specifies whether to allow self-signed certificates from the server. The default value is false.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "authenticationType" + ] + }, + "PrestoLinkedService": { + "x-ms-discriminator-value": "Presto", + "description": "Presto server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Presto server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrestoLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "PrestoLinkedServiceTypeProperties": { + "description": "Presto server linked service properties.", + "type": "object", + "properties": { + "host": { + "description": "The IP address or host name of the Presto server. (i.e. 192.168.222.160)", + "type": "object" + }, + "serverVersion": { + "description": "The version of the Presto server. (i.e. 0.148-t)", + "type": "object" + }, + "catalog": { + "description": "The catalog context for all request against the server.", + "type": "object" + }, + "port": { + "description": "The TCP port that the Presto server uses to listen for client connections. The default value is 8080.", + "type": "object" + }, + "authenticationType": { + "description": "The authentication mechanism used to connect to the Presto server.", + "type": "string", + "enum": [ + "Anonymous", + "LDAP" + ], + "x-ms-enum": { + "name": "PrestoAuthenticationType", + "modelAsString": true + } + }, + "username": { + "description": "The user name used to connect to the Presto server.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "enableSsl": { + "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "useSystemTrustStore": { + "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.", + "type": "object" + }, + "allowHostNameCNMismatch": { + "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.", + "type": "object" + }, + "allowSelfSignedServerCert": { + "description": "Specifies whether to allow self-signed certificates from the server. The default value is false.", + "type": "object" + }, + "timeZoneID": { + "description": "The local time zone used by the connection. Valid values for this option are specified in the IANA Time Zone Database. The default value is the system time zone.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "serverVersion", + "catalog", + "authenticationType" + ] + }, + "QuickBooksLinkedService": { + "x-ms-discriminator-value": "QuickBooks", + "description": "QuickBooks server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "QuickBooks server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/QuickBooksLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "QuickBooksLinkedServiceTypeProperties": { + "description": "QuickBooks server linked service properties.", + "type": "object", + "properties": { + "connectionProperties": { + "description": "Properties used to connect to QuickBooks. It is mutually exclusive with any other properties in the linked service. Type: object.", + "type": "object" + }, + "endpoint": { + "description": "The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com)", + "type": "object" + }, + "companyId": { + "description": "The company ID of the QuickBooks company to authorize.", + "type": "object" + }, + "consumerKey": { + "description": "The consumer key for OAuth 1.0 authentication.", + "type": "object" + }, + "consumerSecret": { + "description": "The consumer secret for OAuth 1.0 authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "accessToken": { + "description": "The access token for OAuth 1.0 authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "accessTokenSecret": { + "description": "The access token secret for OAuth 1.0 authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "endpoint", + "companyId", + "consumerKey", + "consumerSecret", + "accessToken", + "accessTokenSecret" + ] + }, + "ServiceNowLinkedService": { + "x-ms-discriminator-value": "ServiceNow", + "description": "ServiceNow server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "ServiceNow server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceNowLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ServiceNowLinkedServiceTypeProperties": { + "description": "ServiceNow server linked service properties.", + "type": "object", + "properties": { + "endpoint": { + "description": "The endpoint of the ServiceNow server. (i.e. .service-now.com)", + "type": "object" + }, + "authenticationType": { + "description": "The authentication type to use.", + "type": "string", + "enum": [ + "Basic", + "OAuth2" + ], + "x-ms-enum": { + "name": "ServiceNowAuthenticationType", + "modelAsString": true + } + }, + "username": { + "description": "The user name used to connect to the ServiceNow server for Basic and OAuth2 authentication.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name for Basic and OAuth2 authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "clientId": { + "description": "The client id for OAuth2 authentication.", + "type": "object" + }, + "clientSecret": { + "description": "The client secret for OAuth2 authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "endpoint", + "authenticationType" + ] + }, + "ShopifyLinkedService": { + "x-ms-discriminator-value": "Shopify", + "description": "Shopify Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Shopify Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ShopifyLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ShopifyLinkedServiceTypeProperties": { + "description": "Shopify Service linked service properties.", + "type": "object", + "properties": { + "host": { + "description": "The endpoint of the Shopify server. (i.e. mystore.myshopify.com)", + "type": "object" + }, + "accessToken": { + "description": "The API access token that can be used to access Shopify’s data. The token won't expire if it is offline mode.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host" + ] + }, + "SparkLinkedService": { + "x-ms-discriminator-value": "Spark", + "description": "Spark Server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Spark Server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SparkLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SparkLinkedServiceTypeProperties": { + "description": "Spark Server linked service properties.", + "type": "object", + "properties": { + "host": { + "description": "IP address or host name of the Spark server", + "type": "object" + }, + "port": { + "description": "The TCP port that the Spark server uses to listen for client connections.", + "type": "object" + }, + "serverType": { + "description": "The type of Spark server.", + "type": "string", + "enum": [ + "SharkServer", + "SharkServer2", + "SparkThriftServer" + ], + "x-ms-enum": { + "name": "SparkServerType", + "modelAsString": true + } + }, + "thriftTransportProtocol": { + "description": "The transport protocol to use in the Thrift layer.", + "type": "string", + "enum": [ + "Binary", + "SASL", + "HTTP " + ], + "x-ms-enum": { + "name": "SparkThriftTransportProtocol", + "modelAsString": true + } + }, + "authenticationType": { + "description": "The authentication method used to access the Spark server.", + "type": "string", + "enum": [ + "Anonymous", + "Username", + "UsernameAndPassword", + "WindowsAzureHDInsightService" + ], + "x-ms-enum": { + "name": "SparkAuthenticationType", + "modelAsString": true + } + }, + "username": { + "description": "The user name that you use to access Spark Server.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name that you provided in the Username field", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "httpPath": { + "description": "The partial URL corresponding to the Spark server.", + "type": "object" + }, + "enableSsl": { + "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "useSystemTrustStore": { + "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.", + "type": "object" + }, + "allowHostNameCNMismatch": { + "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.", + "type": "object" + }, + "allowSelfSignedServerCert": { + "description": "Specifies whether to allow self-signed certificates from the server. The default value is false.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "port", + "authenticationType" + ] + }, + "SquareLinkedService": { + "x-ms-discriminator-value": "Square", + "description": "Square Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Square Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SquareLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SquareLinkedServiceTypeProperties": { + "description": "Square Service linked service properties.", + "type": "object", + "properties": { + "connectionProperties": { + "description": "Properties used to connect to Square. It is mutually exclusive with any other properties in the linked service. Type: object.", + "type": "object" + }, + "host": { + "description": "The URL of the Square instance. (i.e. mystore.mysquare.com)", + "type": "object" + }, + "clientId": { + "description": "The client ID associated with your Square application.", + "type": "object" + }, + "clientSecret": { + "description": "The client secret associated with your Square application.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "redirectUri": { + "description": "The redirect URL assigned in the Square application dashboard. (i.e. http://localhost:2500)", + "type": "object" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "clientId", + "redirectUri" + ] + }, + "XeroLinkedService": { + "x-ms-discriminator-value": "Xero", + "description": "Xero Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Xero Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/XeroLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "XeroLinkedServiceTypeProperties": { + "description": "Xero Service linked service properties.", + "type": "object", + "properties": { + "connectionProperties": { + "description": "Properties used to connect to Xero. It is mutually exclusive with any other properties in the linked service. Type: object.", + "type": "object" + }, + "host": { + "description": "The endpoint of the Xero server. (i.e. api.xero.com)", + "type": "object" + }, + "consumerKey": { + "description": "The consumer key associated with the Xero application.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "privateKey": { + "description": "The private key from the .pem file that was generated for your Xero private application. You must include all the text from the .pem file, including the Unix line endings(\n).", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host" + ] + }, + "ZohoLinkedService": { + "x-ms-discriminator-value": "Zoho", + "description": "Zoho server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Zoho server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ZohoLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ZohoLinkedServiceTypeProperties": { + "description": "Zoho server linked service properties.", + "type": "object", + "properties": { + "connectionProperties": { + "description": "Properties used to connect to Zoho. It is mutually exclusive with any other properties in the linked service. Type: object.", + "type": "object" + }, + "endpoint": { + "description": "The endpoint of the Zoho server. (i.e. crm.zoho.com/crm/private)", + "type": "object" + }, + "accessToken": { + "description": "The access token for Zoho authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "endpoint" + ] + }, + "VerticaLinkedService": { + "x-ms-discriminator-value": "Vertica", + "description": "Vertica linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Vertica linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/VerticaLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "VerticaLinkedServiceTypeProperties": { + "description": "Vertica linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "pwd": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + } + }, + "NetezzaLinkedService": { + "x-ms-discriminator-value": "Netezza", + "description": "Netezza linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Netezza linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetezzaLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "NetezzaLinkedServiceTypeProperties": { + "description": "Netezza linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "pwd": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + } + }, + "SalesforceMarketingCloudLinkedService": { + "x-ms-discriminator-value": "SalesforceMarketingCloud", + "description": "Salesforce Marketing Cloud linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Salesforce Marketing Cloud linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SalesforceMarketingCloudLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SalesforceMarketingCloudLinkedServiceTypeProperties": { + "description": "Salesforce Marketing Cloud linked service properties.", + "type": "object", + "properties": { + "connectionProperties": { + "description": "Properties used to connect to Salesforce Marketing Cloud. It is mutually exclusive with any other properties in the linked service. Type: object.", + "type": "object" + }, + "clientId": { + "description": "The client ID associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string).", + "type": "object" + }, + "clientSecret": { + "description": "The client secret associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string).", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "clientId" + ] + }, + "HDInsightOnDemandLinkedService": { + "x-ms-discriminator-value": "HDInsightOnDemand", + "description": "HDInsight ondemand linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "HDInsight ondemand linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HDInsightOnDemandLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightOnDemandLinkedServiceTypeProperties": { + "description": "HDInsight ondemand linked service properties.", + "type": "object", + "properties": { + "clusterSize": { + "type": "object", + "description": "Number of worker/data nodes in the cluster. Suggestion value: 4. Type: string (or Expression with resultType string)." + }, + "timeToLive": { + "type": "object", + "description": "The allowed idle time for the on-demand HDInsight cluster. Specifies how long the on-demand HDInsight cluster stays alive after completion of an activity run if there are no other active jobs in the cluster. The minimum value is 5 mins. Type: string (or Expression with resultType string)." + }, + "version": { + "type": "object", + "description": "Version of the HDInsight cluster.  Type: string (or Expression with resultType string)." + }, + "linkedServiceName": { + "description": "Azure Storage linked service to be used by the on-demand cluster for storing and processing data.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "hostSubscriptionId": { + "type": "object", + "description": "The customer’s subscription to host the cluster. Type: string (or Expression with resultType string)." + }, + "servicePrincipalId": { + "type": "object", + "description": "The service principal id for the hostSubscriptionId. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "description": "The key for the service principal id.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "tenant": { + "type": "object", + "description": "The Tenant id/name to which the service principal belongs. Type: string (or Expression with resultType string)." + }, + "clusterResourceGroup": { + "type": "object", + "description": "The resource group where the cluster belongs. Type: string (or Expression with resultType string)." + }, + "clusterNamePrefix": { + "type": "object", + "description": "The prefix of cluster name, postfix will be distinct with timestamp. Type: string (or Expression with resultType string)." + }, + "clusterUserName": { + "type": "object", + "description": "The username to access the cluster. Type: string (or Expression with resultType string)." + }, + "clusterPassword": { + "description": "The password to access the cluster.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "clusterSshUserName": { + "type": "object", + "description": "The username to SSH remotely connect to cluster’s node (for Linux). Type: string (or Expression with resultType string)." + }, + "clusterSshPassword": { + "description": "The password to SSH remotely connect cluster’s node (for Linux).", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "additionalLinkedServiceNames": { + "description": "Specifies additional storage accounts for the HDInsight linked service so that the Data Factory service can register them on your behalf.", + "type": "array", + "items": { + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + } + }, + "hcatalogLinkedServiceName": { + "description": "The name of Azure SQL linked service that point to the HCatalog database. The on-demand HDInsight cluster is created by using the Azure SQL database as the metastore.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "clusterType": { + "type": "object", + "description": "The cluster type. Type: string (or Expression with resultType string)." + }, + "sparkVersion": { + "type": "object", + "description": "The version of spark if the cluster type is 'spark'. Type: string (or Expression with resultType string)." + }, + "coreConfiguration": { + "description": "Specifies the core configuration parameters (as in core-site.xml) for the HDInsight cluster to be created.", + "type": "object" + }, + "hBaseConfiguration": { + "description": "Specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster.", + "type": "object" + }, + "hdfsConfiguration": { + "description": "Specifies the HDFS configuration parameters (hdfs-site.xml) for the HDInsight cluster.", + "type": "object" + }, + "hiveConfiguration": { + "description": "Specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster.", + "type": "object" + }, + "mapReduceConfiguration": { + "description": "Specifies the MapReduce configuration parameters (mapred-site.xml) for the HDInsight cluster.", + "type": "object" + }, + "oozieConfiguration": { + "description": "Specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster.", + "type": "object" + }, + "stormConfiguration": { + "description": "Specifies the Storm configuration parameters (storm-site.xml) for the HDInsight cluster.", + "type": "object" + }, + "yarnConfiguration": { + "description": "Specifies the Yarn configuration parameters (yarn-site.xml) for the HDInsight cluster.", + "type": "object" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + }, + "headNodeSize": { + "type": "object", + "description": "Specifies the size of the head node for the HDInsight cluster." + }, + "dataNodeSize": { + "type": "object", + "description": "Specifies the size of the data node for the HDInsight cluster." + }, + "zookeeperNodeSize": { + "type": "object", + "description": "Specifies the size of the Zoo Keeper node for the HDInsight cluster." + }, + "scriptActions": { + "description": "Custom script actions to run on HDI ondemand cluster once it's up. Please refer to https://docs.microsoft.com/en-us/azure/hdinsight/hdinsight-hadoop-customize-cluster-linux?toc=%2Fen-us%2Fazure%2Fhdinsight%2Fr-server%2FTOC.json&bc=%2Fen-us%2Fazure%2Fbread%2Ftoc.json#understanding-script-actions.", + "type": "array", + "items": { + "$ref": "#/definitions/ScriptAction" + } + }, + "virtualNetworkId": { + "type": "object", + "description": "The ARM resource ID for the vNet to which the cluster should be joined after creation. Type: string (or Expression with resultType string)." + }, + "subnetName": { + "type": "object", + "description": "The ARM resource ID for the subnet in the vNet. If virtualNetworkId was specified, then this property is required. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "clusterSize", + "timeToLive", + "version", + "linkedServiceName", + "hostSubscriptionId", + "tenant", + "clusterResourceGroup" + ] + }, + "ScriptAction": { + "description": "Custom script action to run on HDI ondemand cluster once it's up.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The user provided name of the script action." + }, + "uri": { + "type": "string", + "description": "The URI for the script action." + }, + "roles": { + "x-ms-enum": { + "name": "HdiNodeTypes", + "modelAsString": true + }, + "enum": [ + "Headnode", + "Workernode", + "Zookeeper" + ], + "type": "string", + "description": "The node types on which the script action should be executed." + }, + "parameters": { + "type": "string", + "description": "The parameters for the script action." + } + }, + "required": [ + "name", + "uri", + "roles" + ] + }, + "AzureDataLakeAnalyticsLinkedService": { + "x-ms-discriminator-value": "AzureDataLakeAnalytics", + "description": "Azure Data Lake Analytics linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Data Lake Analytics linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureDataLakeAnalyticsLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureDataLakeAnalyticsLinkedServiceTypeProperties": { + "description": "Azure Data Lake Analytics linked service properties.", + "type": "object", + "properties": { + "accountName": { + "type": "object", + "description": "The Azure Data Lake Analytics account name. Type: string (or Expression with resultType string)." + }, + "servicePrincipalId": { + "type": "object", + "description": "The ID of the application used to authenticate against the Azure Data Lake Analytics account. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "description": "The Key of the application used to authenticate against the Azure Data Lake Analytics account.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "tenant": { + "type": "object", + "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." + }, + "subscriptionId": { + "type": "object", + "description": "Data Lake Analytics account subscription ID (if different from Data Factory account). Type: string (or Expression with resultType string)." + }, + "resourceGroupName": { + "type": "object", + "description": "Data Lake Analytics account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string)." + }, + "dataLakeAnalyticsUri": { + "type": "object", + "description": "Azure Data Lake Analytics URI Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "accountName", + "tenant" + ] + }, + "AzureDatabricksLinkedService": { + "x-ms-discriminator-value": "AzureDatabricks", + "description": "Azure Databricks linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Databricks linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureDatabricksLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureDatabricksLinkedServiceTypeProperties": { + "description": "Azure Databricks linked service properties.", + "type": "object", + "properties": { + "domain": { + "type": "object", + "description": ".azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string)." + }, + "accessToken": { + "description": "Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string (or Expression with resultType string).", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "authentication": { + "type": "object", + "description": "Required to specify MSI, if using Workspace resource id for databricks REST API. Type: string (or Expression with resultType string)." + }, + "workspaceResourceId": { + "type": "object", + "description": "Workspace resource id for databricks REST API. Type: string (or Expression with resultType string)." + }, + "existingClusterId": { + "type": "object", + "description": "The id of an existing interactive cluster that will be used for all runs of this activity. Type: string (or Expression with resultType string)." + }, + "instancePoolId": { + "type": "object", + "description": "The id of an existing instance pool that will be used for all runs of this activity. Type: string (or Expression with resultType string)." + }, + "newClusterVersion": { + "type": "object", + "description": "If not using an existing interactive cluster, this specifies the Spark version of a new job cluster or instance pool nodes created for each run of this activity. Required if instancePoolId is specified. Type: string (or Expression with resultType string)." + }, + "newClusterNumOfWorker": { + "type": "object", + "description": "If not using an existing interactive cluster, this specifies the number of worker nodes to use for the new job cluster or instance pool. For new job clusters, this a string-formatted Int32, like '1' means numOfWorker is 1 or '1:10' means auto-scale from 1 (min) to 10 (max). For instance pools, this is a string-formatted Int32, and can only specify a fixed number of worker nodes, such as '2'. Required if newClusterVersion is specified. Type: string (or Expression with resultType string)." + }, + "newClusterNodeType": { + "type": "object", + "description": "The node type of the new job cluster. This property is required if newClusterVersion is specified and instancePoolId is not specified. If instancePoolId is specified, this property is ignored. Type: string (or Expression with resultType string)." + }, + "newClusterSparkConf": { + "description": "A set of optional, user-specified Spark configuration key-value pairs.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "newClusterSparkEnvVars": { + "description": "A set of optional, user-specified Spark environment variables key-value pairs.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "newClusterCustomTags": { + "description": "Additional tags for cluster resources. This property is ignored in instance pool configurations.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "newClusterLogDestination": { + "type": "object", + "description": "Specify a location to deliver Spark driver, worker, and event logs. Type: string (or Expression with resultType string)." + }, + "newClusterDriverNodeType": { + "type": "object", + "description": "The driver node type for the new job cluster. This property is ignored in instance pool configurations. Type: string (or Expression with resultType string)." + }, + "newClusterInitScripts": { + "type": "object", + "description": "User-defined initialization scripts for the new cluster. Type: array of strings (or Expression with resultType array of strings)." + }, + "newClusterEnableElasticDisk": { + "type": "object", + "description": "Enable the elastic disk on the new cluster. This property is now ignored, and takes the default elastic disk behavior in Databricks (elastic disks are always enabled). Type: boolean (or Expression with resultType boolean)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + }, + "policyId": { + "type": "object", + "description": "The policy id for limiting the ability to configure clusters based on a user defined set of rules. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "domain" + ] + }, + "AzureDatabricksDeltaLakeLinkedService": { + "x-ms-discriminator-value": "AzureDatabricksDeltaLake", + "description": "Azure Databricks Delta Lake linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Databricks Delta Lake linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureDatabricksDetltaLakeLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureDatabricksDetltaLakeLinkedServiceTypeProperties": { + "description": "Azure Databricks Delta Lake linked service properties.", + "type": "object", + "properties": { + "domain": { + "type": "object", + "description": ".azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string)." + }, + "accessToken": { + "description": "Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string, SecureString or AzureKeyVaultSecretReference.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "clusterId": { + "type": "object", + "description": "The id of an existing interactive cluster that will be used for all runs of this job. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "domain", + "accessToken" + ] + }, + "ResponsysLinkedService": { + "x-ms-discriminator-value": "Responsys", + "description": "Responsys linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Responsys linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ResponsysLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ResponsysLinkedServiceTypeProperties": { + "description": "Responsys linked service properties.", + "type": "object", + "properties": { + "endpoint": { + "description": "The endpoint of the Responsys server.", + "type": "object" + }, + "clientId": { + "description": "The client ID associated with the Responsys application. Type: string (or Expression with resultType string).", + "type": "object" + }, + "clientSecret": { + "description": "The client secret associated with the Responsys application. Type: string (or Expression with resultType string).", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "endpoint", + "clientId" + ] + }, + "DynamicsAXLinkedService": { + "x-ms-discriminator-value": "DynamicsAX", + "description": "Dynamics AX linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Dynamics AX linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DynamicsAXLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DynamicsAXLinkedServiceTypeProperties": { + "description": "Dynamics AX linked service properties.", + "type": "object", + "properties": { + "url": { + "description": "The Dynamics AX (or Dynamics 365 Finance and Operations) instance OData endpoint.", + "type": "object" + }, + "servicePrincipalId": { + "description": "Specify the application's client ID. Type: string (or Expression with resultType string).", + "type": "object" + }, + "servicePrincipalKey": { + "description": "Specify the application's key. Mark this field as a SecureString to store it securely in Data Factory, or reference a secret stored in Azure Key Vault. Type: string (or Expression with resultType string).", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "tenant": { + "description": "Specify the tenant information (domain name or tenant ID) under which your application resides. Retrieve it by hovering the mouse in the top-right corner of the Azure portal. Type: string (or Expression with resultType string).", + "type": "object" + }, + "aadResourceId": { + "description": "Specify the resource you are requesting authorization. Type: string (or Expression with resultType string).", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "url", + "servicePrincipalId", + "servicePrincipalKey", + "tenant", + "aadResourceId" + ] + }, + "OracleServiceCloudLinkedService": { + "x-ms-discriminator-value": "OracleServiceCloud", + "description": "Oracle Service Cloud linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Oracle Service Cloud linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/OracleServiceCloudLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "OracleServiceCloudLinkedServiceTypeProperties": { + "description": "Oracle Service Cloud linked service properties.", + "type": "object", + "properties": { + "host": { + "description": "The URL of the Oracle Service Cloud instance.", + "type": "object" + }, + "username": { + "description": "The user name that you use to access Oracle Service Cloud server.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name that you provided in the username key.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "username", + "password" + ] + }, + "GoogleAdWordsLinkedService": { + "x-ms-discriminator-value": "GoogleAdWords", + "description": "Google AdWords service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Google AdWords service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GoogleAdWordsLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "GoogleAdWordsLinkedServiceTypeProperties": { + "description": "Google AdWords service linked service properties.", + "type": "object", + "properties": { + "clientCustomerID": { + "description": "The Client customer ID of the AdWords account that you want to fetch report data for.", + "type": "object" + }, + "developerToken": { + "description": "The developer token associated with the manager account that you use to grant access to the AdWords API.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "authenticationType": { + "description": "The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR.", + "type": "string", + "enum": [ + "ServiceAuthentication", + "UserAuthentication" + ], + "x-ms-enum": { + "name": "GoogleAdWordsAuthenticationType", + "modelAsString": true + } + }, + "refreshToken": { + "description": "The refresh token obtained from Google for authorizing access to AdWords for UserAuthentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "clientId": { + "description": "The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).", + "type": "object" + }, + "clientSecret": { + "description": "The client secret of the google application used to acquire the refresh token.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "email": { + "description": "The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.", + "type": "object" + }, + "keyFilePath": { + "description": "The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "useSystemTrustStore": { + "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "clientCustomerID", + "developerToken", + "authenticationType" + ] + }, + "SapTableLinkedService": { + "x-ms-discriminator-value": "SapTable", + "description": "SAP Table Linked Service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this linked service type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SapTableLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SapTableLinkedServiceTypeProperties": { + "description": "Properties specific to this linked service type.", + "type": "object", + "properties": { + "server": { + "type": "object", + "description": "Host name of the SAP instance where the table is located. Type: string (or Expression with resultType string)." + }, + "systemNumber": { + "type": "object", + "description": "System number of the SAP system where the table is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string)." + }, + "clientId": { + "type": "object", + "description": "Client ID of the client on the SAP system where the table is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string)." + }, + "language": { + "type": "object", + "description": "Language of the SAP system where the table is located. The default value is EN. Type: string (or Expression with resultType string)." + }, + "systemId": { + "type": "object", + "description": "SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string)." + }, + "userName": { + "type": "object", + "description": "Username to access the SAP server where the table is located. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password to access the SAP server where the table is located.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "messageServer": { + "type": "object", + "description": "The hostname of the SAP Message Server. Type: string (or Expression with resultType string)." + }, + "messageServerService": { + "type": "object", + "description": "The service name or port number of the Message Server. Type: string (or Expression with resultType string)." + }, + "sncMode": { + "type": "object", + "description": "SNC activation indicator to access the SAP server where the table is located. Must be either 0 (off) or 1 (on). Type: string (or Expression with resultType string)." + }, + "sncMyName": { + "type": "object", + "description": "Initiator's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string)." + }, + "sncPartnerName": { + "type": "object", + "description": "Communication partner's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string)." + }, + "sncLibraryPath": { + "type": "object", + "description": "External security product's library to access the SAP server where the table is located. Type: string (or Expression with resultType string)." + }, + "sncQop": { + "type": "object", + "description": "SNC Quality of Protection. Allowed value include: 1, 2, 3, 8, 9. Type: string (or Expression with resultType string)." + }, + "logonGroup": { + "type": "object", + "description": "The Logon Group for the SAP System. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + } + }, + "AzureDataExplorerLinkedService": { + "x-ms-discriminator-value": "AzureDataExplorer", + "description": "Azure Data Explorer (Kusto) linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Data Explorer (Kusto) linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureDataExplorerLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureDataExplorerLinkedServiceTypeProperties": { + "description": "Azure Data Explorer (Kusto) linked service properties.", + "type": "object", + "properties": { + "endpoint": { + "description": "The endpoint of Azure Data Explorer (the engine's endpoint). URL will be in the format https://..kusto.windows.net. Type: string (or Expression with resultType string)", + "type": "object" + }, + "servicePrincipalId": { + "type": "object", + "description": "The ID of the service principal used to authenticate against Azure Data Explorer. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The key of the service principal used to authenticate against Kusto." + }, + "database": { + "type": "object", + "description": "Database name for connection. Type: string (or Expression with resultType string)." + }, + "tenant": { + "type": "object", + "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "endpoint", + "servicePrincipalId", + "servicePrincipalKey", + "database", + "tenant" + ] + }, + "AzureFunctionLinkedService": { + "x-ms-discriminator-value": "AzureFunction", + "description": "Azure Function linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Function linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFunctionLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureFunctionLinkedServiceTypeProperties": { + "description": "Azure Function linked service properties.", + "type": "object", + "properties": { + "functionAppUrl": { + "description": "The endpoint of the Azure Function App. URL will be in the format https://.azurewebsites.net.", + "type": "object" + }, + "functionKey": { + "description": "Function or Host key for Azure Function App.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "functionAppUrl" + ] + }, + "SnowflakeLinkedService": { + "x-ms-discriminator-value": "Snowflake", + "description": "Snowflake linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Snowflake linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SnowflakeLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SnowflakeLinkedServiceTypeProperties": { + "description": "Snowflake linked service properties.", + "type": "object", + "properties": { + "connectionString": { + "description": "The connection string of snowflake. Type: string, SecureString.", + "type": "object" + }, + "password": { + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "SharePointOnlineListLinkedService": { + "x-ms-discriminator-value": "SharePointOnlineList", + "description": "SharePoint Online List linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "SharePoint Online List linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SharePointOnlineListLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SharePointOnlineListLinkedServiceTypeProperties": { + "description": "SharePoint Online List linked service properties.", + "type": "object", + "properties": { + "siteUrl": { + "type": "object", + "description": "The URL of the SharePoint Online site. For example, https://contoso.sharepoint.com/sites/siteName. Type: string (or Expression with resultType string)." + }, + "tenantId": { + "type": "object", + "description": "The tenant ID under which your application resides. You can find it from Azure portal Active Directory overview page. Type: string (or Expression with resultType string)." + }, + "servicePrincipalId": { + "type": "object", + "description": "The application (client) ID of your application registered in Azure Active Directory. Make sure to grant SharePoint site permission to this application. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "description": "The client secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "siteUrl", + "tenantId", + "servicePrincipalId", + "servicePrincipalKey" + ] + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Notebook.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Notebook.json new file mode 100644 index 000000000000..388129d21e24 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Notebook.json @@ -0,0 +1,258 @@ +{ + "swagger": "2.0", + "info": { + "title": "ArtifactsClient", + "version": "2020-12-01" + }, + "paths": {}, + "definitions": { + "Notebook": { + "description": "Notebook.", + "type": "object", + "properties": { + "description": { + "description": "The description of the notebook.", + "type": "string" + }, + "bigDataPool": { + "description": "Big data pool reference.", + "$ref": "#/definitions/BigDataPoolReference", + "x-nullable": true + }, + "sessionProperties": { + "description": "Session properties.", + "$ref": "#/definitions/NotebookSessionProperties", + "x-nullable": true + }, + "metadata": { + "description": "Notebook root-level metadata.", + "$ref": "#/definitions/NotebookMetadata" + }, + "nbformat": { + "description": "Notebook format (major number). Incremented between backwards incompatible changes to the notebook format.", + "type": "integer" + }, + "nbformat_minor": { + "description": "Notebook format (minor number). Incremented for backward compatible changes to the notebook format.", + "type": "integer" + }, + "cells": { + "description": "Array of cells of the current notebook.", + "type": "array", + "items": { + "$ref": "#/definitions/NotebookCell" + } + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "metadata", + "nbformat_minor", + "nbformat", + "cells" + ] + }, + "BigDataPoolReference": { + "description": "Big data pool reference.", + "type": "object", + "properties": { + "type": { + "description": "Big data pool reference type.", + "type": "string", + "enum": [ + "BigDataPoolReference" + ], + "x-ms-enum": { + "name": "BigDataPoolReferenceType", + "modelAsString": true + } + }, + "referenceName": { + "description": "Reference big data pool name.", + "type": "string" + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "NotebookMetadata": { + "description": "Notebook root-level metadata.", + "type": "object", + "properties": { + "kernelspec": { + "description": "Kernel information.", + "$ref": "#/definitions/NotebookKernelSpec" + }, + "language_info": { + "description": "Language info.", + "$ref": "#/definitions/NotebookLanguageInfo", + "x-nullable": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "NotebookKernelSpec": { + "description": "Kernel information.", + "type": "object", + "properties": { + "name": { + "description": "Name of the kernel specification.", + "type": "string" + }, + "display_name": { + "description": "Name to display in UI.", + "type": "string" + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "name", + "display_name" + ] + }, + "NotebookLanguageInfo": { + "description": "Language info.", + "type": "object", + "properties": { + "name": { + "description": "The programming language which this kernel runs.", + "type": "string" + }, + "codemirror_mode": { + "description": "The codemirror mode to use for code in this language.", + "type": "string" + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "name" + ] + }, + "NotebookCell": { + "description": "Notebook cell.", + "type": "object", + "properties": { + "cell_type": { + "description": "String identifying the type of cell.", + "type": "string" + }, + "metadata": { + "description": "Cell-level metadata.", + "type": "object" + }, + "source": { + "description": "Contents of the cell, represented as an array of lines.", + "type": "array", + "items": { + "type": "string" + } + }, + "attachments": { + "description": "Attachments associated with the cell.", + "type": "object", + "x-nullable": true + }, + "outputs": { + "description": "Cell-level output items.", + "type": "array", + "items": { + "$ref": "#/definitions/NotebookCellOutputItem" + } + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "cell_type", + "metadata", + "source" + ] + }, + "NotebookSessionProperties": { + "description": "Session properties.", + "type": "object", + "properties": { + "driverMemory": { + "description": "Amount of memory to use for the driver process.", + "type": "string" + }, + "driverCores": { + "description": "Number of cores to use for the driver.", + "type": "integer" + }, + "executorMemory": { + "description": "Amount of memory to use per executor process.", + "type": "string" + }, + "executorCores": { + "description": "Number of cores to use for each executor.", + "type": "integer" + }, + "numExecutors": { + "description": "Number of executors to launch for this session.", + "type": "integer" + } + }, + "required": [ + "driverMemory", + "driverCores", + "executorMemory", + "executorCores", + "numExecutors" + ] + }, + "NotebookCellOutputItem": { + "description": "An item of the notebook cell execution output.", + "type": "object", + "properties": { + "name": { + "description": "For output_type=stream, determines the name of stream (stdout / stderr).", + "type": "string" + }, + "execution_count": { + "description": "Execution sequence number.", + "type": "integer" + }, + "output_type": { + "description": "Execution, display, or stream outputs.", + "type": "string", + "enum": [ + "execute_result", + "display_data", + "stream", + "error" + ], + "x-ms-enum": { + "name": "CellOutputType", + "modelAsString": true + } + }, + "text": { + "description": "For output_type=stream, the stream's text output, represented as a string or an array of strings." + }, + "data": { + "description": "Output data. Use MIME type as key, and content as value.", + "type": "object" + }, + "metadata": { + "description": "Metadata for the output item.", + "type": "object" + } + }, + "required": [ + "output_type" + ] + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json new file mode 100644 index 000000000000..7072ad4d02b6 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json @@ -0,0 +1,7150 @@ +{ + "swagger": "2.0", + "info": { + "title": "ArtifactsClient", + "version": "2020-12-01" + }, + "paths": {}, + "definitions": { + "Pipeline": { + "description": "A workspace pipeline.", + "type": "object", + "properties": { + "description": { + "description": "The description of the pipeline.", + "type": "string" + }, + "activities": { + "type": "array", + "description": "List of activities in pipeline.", + "items": { + "$ref": "#/definitions/Activity" + } + }, + "parameters": { + "$ref": "../artifacts.json#/definitions/ParameterDefinitionSpecification", + "description": "List of parameters for pipeline." + }, + "variables": { + "$ref": "../artifacts.json#/definitions/VariableDefinitionSpecification", + "description": "List of variables for pipeline." + }, + "concurrency": { + "type": "integer", + "minimum": 1, + "description": "The max number of concurrent runs for the pipeline." + }, + "annotations": { + "description": "List of tags that can be used for describing the Pipeline.", + "type": "array", + "items": { + "type": "object" + } + }, + "runDimensions": { + "description": "Dimensions emitted by Pipeline.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "folder": { + "description": "The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level.", + "type": "object", + "properties": { + "name": { + "description": "The name of the folder that this Pipeline is in.", + "type": "string" + } + } + } + } + }, + "Activity": { + "discriminator": "type", + "description": "A pipeline activity.", + "type": "object", + "properties": { + "name": { + "description": "Activity name.", + "type": "string" + }, + "type": { + "type": "string", + "description": "Type of activity." + }, + "description": { + "description": "Activity description.", + "type": "string" + }, + "dependsOn": { + "type": "array", + "description": "Activity depends on condition.", + "items": { + "$ref": "#/definitions/ActivityDependency" + } + }, + "userProperties": { + "type": "array", + "description": "Activity user properties.", + "items": { + "$ref": "#/definitions/UserProperty" + } + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "name", + "type" + ] + }, + "UserProperty": { + "description": "User property.", + "type": "object", + "properties": { + "name": { + "description": "User property name.", + "type": "string" + }, + "value": { + "description": "User property value. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "name", + "value" + ] + }, + "ActivityDependency": { + "description": "Activity dependency information.", + "type": "object", + "properties": { + "activity": { + "description": "Activity name.", + "type": "string" + }, + "dependencyConditions": { + "type": "array", + "description": "Match-Condition for the dependency.", + "items": { + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Skipped", + "Completed" + ], + "x-ms-enum": { + "name": "DependencyCondition", + "modelAsString": true + } + } + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "activity", + "dependencyConditions" + ] + }, + "ControlActivity": { + "x-ms-discriminator-value": "Container", + "type": "object", + "description": "Base class for all control activities like IfCondition, ForEach , Until.", + "allOf": [ + { + "$ref": "#/definitions/Activity" + } + ], + "properties": {} + }, + "ExecutionActivity": { + "x-ms-discriminator-value": "Execution", + "description": "Base class for all execution activities.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Activity" + } + ], + "properties": { + "linkedServiceName": { + "description": "Linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "policy": { + "$ref": "#/definitions/ActivityPolicy", + "description": "Activity policy." + } + } + }, + "ActivityPolicy": { + "description": "Execution policy for an activity.", + "type": "object", + "properties": { + "timeout": { + "type": "object", + "description": "Specifies the timeout for the activity to run. The default timeout is 7 days. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "retry": { + "type": "object", + "description": "Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "retryIntervalInSeconds": { + "type": "integer", + "description": "Interval between each retry attempt (in seconds). The default is 30 sec.", + "minimum": 30, + "maximum": 86400 + }, + "secureInput": { + "type": "boolean", + "description": "When set to true, Input from activity is considered as secure and will not be logged to monitoring." + }, + "secureOutput": { + "type": "boolean", + "description": "When set to true, Output from activity is considered as secure and will not be logged to monitoring." + } + }, + "additionalProperties": { + "type": "object" + } + }, + "StoreReadSettings": { + "description": "Connector read setting.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The read setting type." + }, + "maxConcurrentConnections": { + "type": "object", + "description": "The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "AzureBlobStorageReadSettings": { + "description": "Azure blob read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "Azure blob wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "Azure blob wildcardFileName. Type: string (or Expression with resultType string)." + }, + "prefix": { + "type": "object", + "description": "The prefix filter for the Azure Blob name. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "deleteFilesAfterCompletion": { + "type": "object", + "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + } + } + }, + "AzureBlobFSReadSettings": { + "description": "Azure blobFS read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "Azure blobFS wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "Azure blobFS wildcardFileName. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "deleteFilesAfterCompletion": { + "type": "object", + "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + } + } + }, + "AzureDataLakeStoreReadSettings": { + "description": "Azure data lake store read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "ADLS wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "ADLS wildcardFileName. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "listAfter": { + "type": "object", + "description": "Lists files after the value (exclusive) based on file/folder names’ lexicographical order. Applies under the folderPath in data set, and filter files/sub-folders under the folderPath. Type: string (or Expression with resultType string)." + }, + "listBefore": { + "type": "object", + "description": "Lists files before the value (inclusive) based on file/folder names’ lexicographical order. Applies under the folderPath in data set, and filter files/sub-folders under the folderPath. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "deleteFilesAfterCompletion": { + "type": "object", + "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + } + } + }, + "AmazonS3ReadSettings": { + "description": "Azure data lake store read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "AmazonS3 wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "AmazonS3 wildcardFileName. Type: string (or Expression with resultType string)." + }, + "prefix": { + "type": "object", + "description": "The prefix filter for the S3 object name. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "deleteFilesAfterCompletion": { + "type": "object", + "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + } + } + }, + "FileServerReadSettings": { + "description": "File server read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "FileServer wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "FileServer wildcardFileName. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "deleteFilesAfterCompletion": { + "type": "object", + "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "fileFilter": { + "type": "object", + "description": "Specify a filter to be used to select a subset of files in the folderPath rather than all files. Type: string (or Expression with resultType string)." + } + } + }, + "AzureFileStorageReadSettings": { + "description": "Azure File Storage read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "Azure File Storage wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "Azure File Storage wildcardFileName. Type: string (or Expression with resultType string)." + }, + "prefix": { + "type": "object", + "description": "The prefix filter for the Azure File name starting from root path. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "deleteFilesAfterCompletion": { + "type": "object", + "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + } + } + }, + "SftpWriteSettings": { + "description": "Sftp write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreWriteSettings" + } + ], + "properties": { + "operationTimeout": { + "description": "Specifies the timeout for writing each chunk to SFTP server. Default value: 01:00:00 (one hour). Type: string (or Expression with resultType string).", + "type": "object" + }, + "useTempFileRename": { + "description": "Upload to temporary file(s) and rename. Disable this option if your SFTP server doesn't support rename operation. Type: boolean (or Expression with resultType boolean).", + "type": "object" + } + } + }, + "GoogleCloudStorageReadSettings": { + "description": "Google Cloud Storage read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "Google Cloud Storage wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "Google Cloud Storage wildcardFileName. Type: string (or Expression with resultType string)." + }, + "prefix": { + "type": "object", + "description": "The prefix filter for the Google Cloud Storage object name. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "deleteFilesAfterCompletion": { + "type": "object", + "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + } + } + }, + "FtpReadSettings": { + "description": "Ftp read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "Ftp wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "Ftp wildcardFileName. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "deleteFilesAfterCompletion": { + "type": "object", + "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "useBinaryTransfer": { + "type": "boolean", + "description": "Specify whether to use binary transfer mode for FTP stores." + } + } + }, + "SftpReadSettings": { + "description": "Sftp read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "Sftp wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "Sftp wildcardFileName. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "deleteFilesAfterCompletion": { + "type": "object", + "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + } + } + }, + "HttpReadSettings": { + "description": "Sftp read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "requestMethod": { + "type": "object", + "description": "The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string)." + }, + "requestBody": { + "type": "object", + "description": "The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string)." + }, + "additionalHeaders": { + "type": "object", + "description": "The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string)." + }, + "requestTimeout": { + "type": "object", + "description": "Specifies the timeout for a HTTP client to get HTTP response from HTTP server." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + } + } + }, + "HdfsReadSettings": { + "description": "HDFS read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreReadSettings" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "wildcardFolderPath": { + "type": "object", + "description": "HDFS wildcardFolderPath. Type: string (or Expression with resultType string)." + }, + "wildcardFileName": { + "type": "object", + "description": "HDFS wildcardFileName. Type: string (or Expression with resultType string)." + }, + "fileListPath": { + "type": "object", + "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." + }, + "enablePartitionDiscovery": { + "type": "boolean", + "description": "Indicates whether to enable partition discovery." + }, + "partitionRootPath": { + "type": "object", + "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeStart": { + "type": "object", + "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "modifiedDatetimeEnd": { + "type": "object", + "description": "The end of file's modified datetime. Type: string (or Expression with resultType string)." + }, + "distcpSettings": { + "description": "Specifies Distcp-related settings.", + "$ref": "#/definitions/DistcpSettings" + }, + "deleteFilesAfterCompletion": { + "type": "object", + "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "StoreWriteSettings": { + "description": "Connector write settings.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The write setting type." + }, + "maxConcurrentConnections": { + "type": "object", + "description": "The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer)." + }, + "copyBehavior": { + "description": "The type of copy behavior for copy sink.", + "type": "object" + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "AzureBlobStorageWriteSettings": { + "description": "Azure blob write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreWriteSettings" + } + ], + "properties": { + "blockSizeInMB": { + "description": "Indicates the block size(MB) when writing data to blob. Type: integer (or Expression with resultType integer).", + "type": "object" + } + } + }, + "AzureBlobFSWriteSettings": { + "description": "Azure blobFS write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreWriteSettings" + } + ], + "properties": { + "blockSizeInMB": { + "description": "Indicates the block size(MB) when writing data to blob. Type: integer (or Expression with resultType integer).", + "type": "object" + } + } + }, + "AzureDataLakeStoreWriteSettings": { + "description": "Azure data lake store write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreWriteSettings" + } + ], + "properties": { + "expiryDateTime": { + "description": "Specifies the expiry time of the written files. The time is applied to the UTC time zone in the format of \"2018-12-01T05:00:00Z\". Default value is NULL. Type: integer (or Expression with resultType integer).", + "type": "object" + } + } + }, + "FileServerWriteSettings": { + "description": "File server write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreWriteSettings" + } + ] + }, + "AzureFileStorageWriteSettings": { + "description": "Azure File Storage write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StoreWriteSettings" + } + ] + }, + "FormatReadSettings": { + "description": "Format read settings.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The read setting type." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "CompressionReadSettings": { + "description": "Compression read settings.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The Compression setting type." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "ZipDeflateReadSettings": { + "description": "The ZipDeflate compression read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CompressionReadSettings" + } + ], + "properties": { + "preserveZipFileNameAsFolder": { + "description": "Preserve the zip file name as folder path. Type: boolean (or Expression with resultType boolean).", + "type": "object" + } + } + }, + "TarReadSettings": { + "description": "The Tar compression read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CompressionReadSettings" + } + ], + "properties": { + "preserveCompressionFileNameAsFolder": { + "description": "Preserve the compression file name as folder path. Type: boolean (or Expression with resultType boolean).", + "type": "object" + } + } + }, + "TarGZipReadSettings": { + "description": "The TarGZip compression read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CompressionReadSettings" + } + ], + "properties": { + "preserveCompressionFileNameAsFolder": { + "description": "Preserve the compression file name as folder path. Type: boolean (or Expression with resultType boolean).", + "type": "object" + } + } + }, + "DelimitedTextReadSettings": { + "description": "Delimited text read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatReadSettings" + } + ], + "properties": { + "skipLineCount": { + "type": "object", + "description": "Indicates the number of non-empty rows to skip when reading data from input files. Type: integer (or Expression with resultType integer)." + }, + "compressionProperties": { + "$ref": "#/definitions/CompressionReadSettings", + "description": "Compression settings." + } + } + }, + "JsonReadSettings": { + "description": "Json read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatReadSettings" + } + ], + "properties": { + "compressionProperties": { + "$ref": "#/definitions/CompressionReadSettings", + "description": "Compression settings." + } + } + }, + "XmlReadSettings": { + "description": "Xml read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatReadSettings" + } + ], + "properties": { + "compressionProperties": { + "$ref": "#/definitions/CompressionReadSettings", + "description": "Compression settings." + }, + "validationMode": { + "type": "object", + "description": "Indicates what validation method is used when reading the xml files. Allowed values: 'none', 'xsd', or 'dtd'. Type: string (or Expression with resultType string)." + }, + "detectDataType": { + "type": "object", + "description": "Indicates whether type detection is enabled when reading the xml files. Type: boolean (or Expression with resultType boolean)." + }, + "namespaces": { + "type": "object", + "description": "Indicates whether namespace is enabled when reading the xml files. Type: boolean (or Expression with resultType boolean)." + }, + "namespacePrefixes": { + "type": "object", + "description": "Namespace uri to prefix mappings to override the prefixes in column names when namespace is enabled, if no prefix is defined for a namespace uri, the prefix of xml element/attribute name in the xml data file will be used. Example: \"{\"http://www.example.com/xml\":\"prefix\"}\" Type: object (or Expression with resultType object)." + } + } + }, + "BinaryReadSettings": { + "description": "Binary read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatReadSettings" + } + ], + "properties": { + "compressionProperties": { + "$ref": "#/definitions/CompressionReadSettings", + "description": "Compression settings." + } + } + }, + "FormatWriteSettings": { + "description": "Format write settings.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The write setting type." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "AvroWriteSettings": { + "description": "Avro write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatWriteSettings" + } + ], + "properties": { + "recordName": { + "type": "string", + "description": "Top level record name in write result, which is required in AVRO spec." + }, + "recordNamespace": { + "type": "string", + "description": "Record namespace in the write result." + }, + "maxRowsPerFile": { + "type": "object", + "description": "Limit the written file's row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer)." + }, + "fileNamePrefix": { + "type": "object", + "description": "Specifies the file name pattern _. when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string)." + } + } + }, + "OrcWriteSettings": { + "description": "Orc write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatWriteSettings" + } + ], + "properties": { + "maxRowsPerFile": { + "type": "object", + "description": "Limit the written file's row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer)." + }, + "fileNamePrefix": { + "type": "object", + "description": "Specifies the file name pattern _. when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string)." + } + } + }, + "ParquetWriteSettings": { + "description": "Parquet write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatWriteSettings" + } + ], + "properties": { + "maxRowsPerFile": { + "type": "object", + "description": "Limit the written file's row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer)." + }, + "fileNamePrefix": { + "type": "object", + "description": "Specifies the file name pattern _. when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string)." + } + } + }, + "DelimitedTextWriteSettings": { + "description": "Delimited text write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatWriteSettings" + } + ], + "properties": { + "quoteAllText": { + "type": "object", + "description": "Indicates whether string values should always be enclosed with quotes. Type: boolean (or Expression with resultType boolean)." + }, + "fileExtension": { + "type": "object", + "description": "The file extension used to create the files. Type: string (or Expression with resultType string)." + }, + "maxRowsPerFile": { + "type": "object", + "description": "Limit the written file's row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer)." + }, + "fileNamePrefix": { + "type": "object", + "description": "Specifies the file name pattern _. when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "fileExtension" + ] + }, + "JsonWriteSettings": { + "description": "Json write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatWriteSettings" + } + ], + "properties": { + "filePattern": { + "description": "File pattern of JSON. This setting controls the way a collection of JSON objects will be treated. The default value is 'setOfObjects'. It is case-sensitive.", + "type": "string", + "enum": [ + "setOfObjects", + "arrayOfObjects" + ], + "x-ms-enum": { + "name": "JsonWriteFilePattern", + "modelAsString": true + } + } + } + }, + "AvroSource": { + "description": "A copy activity Avro source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "Avro store settings." + }, + "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)." + } + } + }, + "ExcelSource": { + "description": "A copy activity excel source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "Excel store settings." + }, + "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)." + } + } + }, + "ParquetSource": { + "description": "A copy activity Parquet source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "Parquet store settings." + }, + "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)." + } + } + }, + "DelimitedTextSource": { + "description": "A copy activity DelimitedText source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "DelimitedText store settings." + }, + "formatSettings": { + "$ref": "#/definitions/DelimitedTextReadSettings", + "description": "DelimitedText format settings." + }, + "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)." + } + } + }, + "JsonSource": { + "description": "A copy activity Json source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "Json store settings." + }, + "formatSettings": { + "$ref": "#/definitions/JsonReadSettings", + "description": "Json format settings." + }, + "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)." + } + } + }, + "XmlSource": { + "description": "A copy activity Xml source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "Xml store settings." + }, + "formatSettings": { + "$ref": "#/definitions/XmlReadSettings", + "description": "Xml format settings." + }, + "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)." + } + } + }, + "OrcSource": { + "description": "A copy activity ORC source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "ORC store settings." + }, + "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)." + } + } + }, + "DelimitedTextSink": { + "description": "A copy activity DelimitedText sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreWriteSettings", + "description": "DelimitedText store settings." + }, + "formatSettings": { + "$ref": "#/definitions/DelimitedTextWriteSettings", + "description": "DelimitedText format settings." + } + } + }, + "JsonSink": { + "description": "A copy activity Json sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreWriteSettings", + "description": "Json store settings." + }, + "formatSettings": { + "$ref": "#/definitions/JsonWriteSettings", + "description": "Json format settings." + } + } + }, + "OrcSink": { + "description": "A copy activity ORC sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreWriteSettings", + "description": "ORC store settings." + }, + "formatSettings": { + "$ref": "#/definitions/OrcWriteSettings", + "description": "ORC format settings." + } + } + }, + "CopyActivity": { + "x-ms-discriminator-value": "Copy", + "description": "Copy activity.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Copy activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CopyActivityTypeProperties" + }, + "inputs": { + "type": "array", + "description": "List of inputs for the activity.", + "items": { + "$ref": "../artifacts.json#/definitions/DatasetReference" + } + }, + "outputs": { + "type": "array", + "description": "List of outputs for the activity.", + "items": { + "$ref": "../artifacts.json#/definitions/DatasetReference" + } + } + }, + "required": [ + "typeProperties" + ] + }, + "CopyActivityTypeProperties": { + "description": "Copy activity properties.", + "type": "object", + "properties": { + "source": { + "description": "Copy activity source.", + "$ref": "#/definitions/CopySource" + }, + "sink": { + "description": "Copy activity sink.", + "$ref": "#/definitions/CopySink" + }, + "translator": { + "description": "Copy activity translator. If not specified, tabular translator is used.", + "type": "object" + }, + "enableStaging": { + "type": "object", + "description": "Specifies whether to copy data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean)." + }, + "stagingSettings": { + "description": "Specifies interim staging settings when EnableStaging is true.", + "$ref": "#/definitions/StagingSettings" + }, + "parallelCopies": { + "type": "object", + "description": "Maximum number of concurrent sessions opened on the source or sink to avoid overloading the data store. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "dataIntegrationUnits": { + "type": "object", + "description": "Maximum number of data integration units that can be used to perform this data movement. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "enableSkipIncompatibleRow": { + "type": "object", + "description": "Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with resultType boolean)." + }, + "redirectIncompatibleRowSettings": { + "description": "Redirect incompatible row settings when EnableSkipIncompatibleRow is true.", + "$ref": "#/definitions/RedirectIncompatibleRowSettings" + }, + "logStorageSettings": { + "description": "(Deprecated. Please use LogSettings) Log storage settings customer need to provide when enabling session log.", + "$ref": "#/definitions/LogStorageSettings" + }, + "logSettings": { + "description": "Log settings customer needs provide when enabling log.", + "$ref": "#/definitions/LogSettings" + }, + "preserveRules": { + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + }, + "description": "Preserve Rules." + }, + "preserve": { + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + }, + "description": "Preserve rules." + }, + "validateDataConsistency": { + "type": "object", + "description": "Whether to enable Data Consistency validation. Type: boolean (or Expression with resultType boolean)." + }, + "skipErrorFile": { + "description": "Specify the fault tolerance for data consistency.", + "$ref": "#/definitions/SkipErrorFile" + } + }, + "required": [ + "source", + "sink" + ] + }, + "CopySource": { + "discriminator": "type", + "description": "A copy activity source.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Copy source type." + }, + "sourceRetryCount": { + "type": "object", + "description": "Source retry count. Type: integer (or Expression with resultType integer)." + }, + "sourceRetryWait": { + "type": "object", + "description": "Source retry wait. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "maxConcurrentConnections": { + "type": "object", + "description": "The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "BinarySource": { + "description": "A copy activity Binary source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "Binary store settings." + }, + "formatSettings": { + "$ref": "#/definitions/BinaryReadSettings", + "description": "Binary format settings." + } + } + }, + "TabularSource": { + "description": "Copy activity sources of tabular type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "queryTimeout": { + "type": "object", + "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "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)." + } + } + }, + "AzureTableSource": { + "description": "A copy activity Azure Table source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "azureTableSourceQuery": { + "type": "object", + "description": "Azure Table source query. Type: string (or Expression with resultType string)." + }, + "azureTableSourceIgnoreTableNotFound": { + "type": "object", + "description": "Azure Table source ignore table not found. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "BlobSource": { + "description": "A copy activity Azure Blob source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "treatEmptyAsNull": { + "type": "object", + "description": "Treat empty as null. Type: boolean (or Expression with resultType boolean)." + }, + "skipHeaderLineCount": { + "type": "object", + "description": "Number of header lines to skip from each blob. Type: integer (or Expression with resultType integer)." + }, + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "DocumentDbCollectionSource": { + "description": "A copy activity Document Database Collection source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Documents query. Type: string (or Expression with resultType string)." + }, + "nestingSeparator": { + "type": "object", + "description": "Nested properties separator. Type: string (or Expression with resultType string)." + }, + "queryTimeout": { + "type": "object", + "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "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)." + } + } + }, + "CosmosDbSqlApiSource": { + "description": "A copy activity Azure CosmosDB (SQL API) Collection source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "SQL API query. Type: string (or Expression with resultType string)." + }, + "pageSize": { + "type": "object", + "description": "Page size of the result. Type: integer (or Expression with resultType integer)." + }, + "preferredRegions": { + "type": "object", + "description": "Preferred regions. Type: array of strings (or Expression with resultType array of strings)." + }, + "detectDatetime": { + "type": "object", + "description": "Whether detect primitive values as datetime values. Type: boolean (or Expression with resultType boolean)." + }, + "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)." + } + } + }, + "DynamicsSource": { + "description": "A copy activity Dynamics source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "FetchXML is a proprietary query language that is used in Microsoft Dynamics (online & on-premises). Type: string (or Expression with resultType string)." + }, + "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)." + } + } + }, + "DynamicsCrmSource": { + "description": "A copy activity Dynamics CRM source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "FetchXML is a proprietary query language that is used in Microsoft Dynamics CRM (online & on-premises). Type: string (or Expression with resultType string)." + }, + "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)." + } + } + }, + "CommonDataServiceForAppsSource": { + "description": "A copy activity Common Data Service for Apps source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "FetchXML is a proprietary query language that is used in Microsoft Common Data Service for Apps (online & on-premises). Type: string (or Expression with resultType string)." + }, + "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)." + } + } + }, + "RelationalSource": { + "description": "A copy activity source for various relational databases.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + }, + "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)." + } + } + }, + "InformixSource": { + "description": "A copy activity source for Informix.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "MicrosoftAccessSource": { + "description": "A copy activity source for Microsoft Access.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + }, + "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)." + } + } + }, + "Db2Source": { + "description": "A copy activity source for Db2 databases.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "OdbcSource": { + "description": "A copy activity source for ODBC databases.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "MySqlSource": { + "description": "A copy activity source for MySQL databases.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "PostgreSqlSource": { + "description": "A copy activity source for PostgreSQL databases.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "SybaseSource": { + "description": "A copy activity source for Sybase databases.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "SapBwSource": { + "description": "A copy activity source for SapBW server via MDX.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "MDX query. Type: string (or Expression with resultType string)." + } + } + }, + "ODataSource": { + "description": "A copy activity source for OData source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "OData query. For example, \"$top=1\". Type: string (or Expression with resultType string)." + }, + "httpRequestTimeout": { + "type": "object", + "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "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)." + } + } + }, + "SalesforceSource": { + "description": "A copy activity Salesforce source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + }, + "readBehavior": { + "description": "The read behavior for the operation. Default is Query.", + "type": "string", + "enum": [ + "Query", + "QueryAll" + ], + "x-ms-enum": { + "name": "SalesforceSourceReadBehavior", + "modelAsString": true + } + } + } + }, + "SalesforceServiceCloudSource": { + "description": "A copy activity Salesforce Service Cloud source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + }, + "readBehavior": { + "description": "The read behavior for the operation. Default is Query.", + "type": "string", + "enum": [ + "Query", + "QueryAll" + ], + "x-ms-enum": { + "name": "SalesforceSourceReadBehavior", + "modelAsString": true + } + }, + "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)." + } + } + }, + "SapCloudForCustomerSource": { + "description": "A copy activity source for SAP Cloud for Customer source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "SAP Cloud for Customer OData query. For example, \"$top=1\". Type: string (or Expression with resultType string)." + }, + "httpRequestTimeout": { + "type": "object", + "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, + "SapEccSource": { + "description": "A copy activity source for SAP ECC source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "SAP ECC OData query. For example, \"$top=1\". Type: string (or Expression with resultType string)." + }, + "httpRequestTimeout": { + "type": "object", + "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, + "SapHanaSource": { + "description": "A copy activity source for SAP HANA source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "SAP HANA Sql query. Type: string (or Expression with resultType string)." + }, + "packetSize": { + "type": "object", + "description": "The packet size of data read from SAP HANA. Type: integer(or Expression with resultType integer)." + }, + "partitionOption": { + "description": "The partition mechanism that will be used for SAP HANA read in parallel.", + "type": "string", + "enum": [ + "None", + "PhysicalPartitionsOfTable", + "SapHanaDynamicRange" + ], + "x-ms-enum": { + "name": "SapHanaPartitionOption", + "modelAsString": true + } + }, + "partitionSettings": { + "description": "The settings that will be leveraged for SAP HANA source partitioning.", + "$ref": "#/definitions/SapHanaPartitionSettings" + } + } + }, + "SapHanaPartitionSettings": { + "description": "The settings that will be leveraged for SAP HANA source partitioning.", + "type": "object", + "properties": { + "partitionColumnName": { + "type": "object", + "description": "The name of the column that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + } + } + }, + "SapOpenHubSource": { + "description": "A copy activity source for SAP Business Warehouse Open Hub Destination source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "excludeLastRequest": { + "type": "object", + "description": "Whether to exclude the records of the last request. The default value is true. Type: boolean (or Expression with resultType boolean)." + }, + "baseRequestId": { + "type": "object", + "description": "The ID of request for delta loading. Once it is set, only data with requestId larger than the value of this property will be retrieved. The default value is 0. Type: integer (or Expression with resultType integer )." + }, + "customRfcReadTableFunctionModule": { + "type": "object", + "description": "Specifies the custom RFC function module that will be used to read data from SAP Table. Type: string (or Expression with resultType string)." + }, + "sapDataColumnDelimiter": { + "type": "object", + "description": "The single character that will be used as delimiter passed to SAP RFC as well as splitting the output data retrieved. Type: string (or Expression with resultType string)." + } + } + }, + "SapTableSource": { + "description": "A copy activity source for SAP Table source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "rowCount": { + "type": "object", + "description": "The number of rows to be retrieved. Type: integer(or Expression with resultType integer)." + }, + "rowSkips": { + "type": "object", + "description": "The number of rows that will be skipped. Type: integer (or Expression with resultType integer)." + }, + "rfcTableFields": { + "type": "object", + "description": "The fields of the SAP table that will be retrieved. For example, column0, column1. Type: string (or Expression with resultType string)." + }, + "rfcTableOptions": { + "type": "object", + "description": "The options for the filtering of the SAP Table. For example, COLUMN0 EQ SOME VALUE. Type: string (or Expression with resultType string)." + }, + "batchSize": { + "type": "object", + "description": "Specifies the maximum number of rows that will be retrieved at a time when retrieving data from SAP Table. Type: integer (or Expression with resultType integer)." + }, + "customRfcReadTableFunctionModule": { + "type": "object", + "description": "Specifies the custom RFC function module that will be used to read data from SAP Table. Type: string (or Expression with resultType string)." + }, + "sapDataColumnDelimiter": { + "type": "object", + "description": "The single character that will be used as delimiter passed to SAP RFC as well as splitting the output data retrieved. Type: string (or Expression with resultType string)." + }, + "partitionOption": { + "description": "The partition mechanism that will be used for SAP table read in parallel.", + "type": "string", + "enum": [ + "None", + "PartitionOnInt", + "PartitionOnCalendarYear", + "PartitionOnCalendarMonth", + "PartitionOnCalendarDate", + "PartitionOnTime" + ], + "x-ms-enum": { + "name": "SapTablePartitionOption", + "modelAsString": true + } + }, + "partitionSettings": { + "description": "The settings that will be leveraged for SAP table source partitioning.", + "$ref": "#/definitions/SapTablePartitionSettings" + } + } + }, + "SapTablePartitionSettings": { + "description": "The settings that will be leveraged for SAP table source partitioning.", + "type": "object", + "properties": { + "partitionColumnName": { + "type": "object", + "description": "The name of the column that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "partitionUpperBound": { + "type": "object", + "description": "The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "partitionLowerBound": { + "type": "object", + "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "maxPartitionsNumber": { + "type": "object", + "description": "The maximum value of partitions the table will be split into. Type: integer (or Expression with resultType string)." + } + } + }, + "RestSink": { + "description": "A copy activity Rest service Sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "requestMethod": { + "type": "object", + "description": "The HTTP method used to call the RESTful API. The default is POST. Type: string (or Expression with resultType string)." + }, + "additionalHeaders": { + "type": "object", + "description": "The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string)." + }, + "httpRequestTimeout": { + "type": "object", + "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:01:40. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "requestInterval": { + "type": "object", + "description": "The time to await before sending next request, in milliseconds " + }, + "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. " + } + } + }, + "RestSource": { + "description": "A copy activity Rest service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "requestMethod": { + "type": "object", + "description": "The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string)." + }, + "requestBody": { + "type": "object", + "description": "The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string)." + }, + "additionalHeaders": { + "type": "object", + "description": "The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string)." + }, + "paginationRules": { + "type": "object", + "description": "The pagination rules to compose next page requests. Type: string (or Expression with resultType string)." + }, + "httpRequestTimeout": { + "type": "object", + "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:01:40. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "requestInterval": { + "type": "object", + "description": "The time to await before sending next page request. " + }, + "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)." + } + } + }, + "SqlSource": { + "description": "A copy activity SQL source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "sqlReaderQuery": { + "type": "object", + "description": "SQL reader query. Type: string (or Expression with resultType string)." + }, + "sqlReaderStoredProcedureName": { + "type": "object", + "description": "Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "isolationLevel": { + "description": "Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string).", + "type": "object" + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", + "type": "object" + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "$ref": "#/definitions/SqlPartitionSettings" + } + } + }, + "SqlServerSource": { + "description": "A copy activity SQL server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "sqlReaderQuery": { + "type": "object", + "description": "SQL reader query. Type: string (or Expression with resultType string)." + }, + "sqlReaderStoredProcedureName": { + "type": "object", + "description": "Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "produceAdditionalTypes": { + "description": "Which additional types to produce.", + "type": "object" + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", + "type": "object" + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "$ref": "#/definitions/SqlPartitionSettings" + } + } + }, + "AzureSqlSource": { + "description": "A copy activity Azure SQL source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "sqlReaderQuery": { + "type": "object", + "description": "SQL reader query. Type: string (or Expression with resultType string)." + }, + "sqlReaderStoredProcedureName": { + "type": "object", + "description": "Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "produceAdditionalTypes": { + "description": "Which additional types to produce.", + "type": "object" + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", + "type": "object" + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "$ref": "#/definitions/SqlPartitionSettings" + } + } + }, + "SqlMISource": { + "description": "A copy activity Azure SQL Managed Instance source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "sqlReaderQuery": { + "type": "object", + "description": "SQL reader query. Type: string (or Expression with resultType string)." + }, + "sqlReaderStoredProcedureName": { + "type": "object", + "description": "Name of the stored procedure for a Azure SQL Managed Instance source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "produceAdditionalTypes": { + "description": "Which additional types to produce.", + "type": "object" + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", + "type": "object" + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "$ref": "#/definitions/SqlPartitionSettings" + } + } + }, + "SqlDWSource": { + "description": "A copy activity SQL Data Warehouse source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "sqlReaderQuery": { + "type": "object", + "description": "SQL Data Warehouse reader query. Type: string (or Expression with resultType string)." + }, + "sqlReaderStoredProcedureName": { + "type": "object", + "description": "Name of the stored procedure for a SQL Data Warehouse source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "type": "object", + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\". Type: object (or Expression with resultType object), itemType: StoredProcedureParameter." + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", + "type": "object" + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "$ref": "#/definitions/SqlPartitionSettings" + } + } + }, + "SqlPartitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "type": "object", + "properties": { + "partitionColumnName": { + "type": "object", + "description": "The name of the column in integer or datetime type that will be used for proceeding partitioning. If not specified, the primary key of the table is auto-detected and used as the partition column. Type: string (or Expression with resultType string)." + }, + "partitionUpperBound": { + "type": "object", + "description": "The maximum value of the partition column for partition range splitting. This value is used to decide the partition stride, not for filtering the rows in table. All rows in the table or query result will be partitioned and copied. Type: string (or Expression with resultType string)." + }, + "partitionLowerBound": { + "type": "object", + "description": "The minimum value of the partition column for partition range splitting. This value is used to decide the partition stride, not for filtering the rows in table. All rows in the table or query result will be partitioned and copied. Type: string (or Expression with resultType string)." + } + } + }, + "FileSystemSource": { + "description": "A copy activity file system source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "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)." + } + } + }, + "HdfsSource": { + "description": "A copy activity HDFS source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "distcpSettings": { + "description": "Specifies Distcp-related settings.", + "$ref": "#/definitions/DistcpSettings" + } + } + }, + "DistcpSettings": { + "description": "Distcp settings.", + "type": "object", + "properties": { + "resourceManagerEndpoint": { + "type": "object", + "description": "Specifies the Yarn ResourceManager endpoint. Type: string (or Expression with resultType string)." + }, + "tempScriptPath": { + "type": "object", + "description": "Specifies an existing folder path which will be used to store temp Distcp command script. The script file is generated by ADF and will be removed after Copy job finished. Type: string (or Expression with resultType string)." + }, + "distcpOptions": { + "type": "object", + "description": "Specifies the Distcp options. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "resourceManagerEndpoint", + "tempScriptPath" + ] + }, + "AzureMySqlSource": { + "description": "A copy activity Azure MySQL source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "AzureDataExplorerSource": { + "description": "A copy activity Azure Data Explorer (Kusto) source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Should be a Kusto Query Language (KQL) query. Type: string (or Expression with resultType string)." + }, + "noTruncation": { + "type": "object", + "description": "The name of the Boolean option that controls whether truncation is applied to result-sets that go beyond a certain row-count limit." + }, + "queryTimeout": { + "type": "object", + "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).." + }, + "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)." + } + }, + "required": [ + "query" + ] + }, + "OracleSource": { + "description": "A copy activity Oracle source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "oracleReaderQuery": { + "type": "object", + "description": "Oracle reader query. Type: string (or Expression with resultType string)." + }, + "queryTimeout": { + "type": "object", + "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Oracle read in parallel.", + "type": "string", + "enum": [ + "None", + "PhysicalPartitionsOfTable", + "DynamicRange" + ], + "x-ms-enum": { + "name": "OraclePartitionOption", + "modelAsString": true + } + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Oracle source partitioning.", + "$ref": "#/definitions/OraclePartitionSettings" + }, + "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)." + } + } + }, + "OraclePartitionSettings": { + "description": "The settings that will be leveraged for Oracle source partitioning.", + "type": "object", + "properties": { + "partitionNames": { + "type": "object", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + }, + "description": "Names of the physical partitions of Oracle table. " + }, + "partitionColumnName": { + "type": "object", + "description": "The name of the column in integer type that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "partitionUpperBound": { + "type": "object", + "description": "The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "partitionLowerBound": { + "type": "object", + "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + } + } + }, + "TeradataSource": { + "description": "A copy activity Teradata source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Teradata query. Type: string (or Expression with resultType string)." + }, + "partitionOption": { + "description": "The partition mechanism that will be used for teradata read in parallel.", + "type": "string", + "enum": [ + "None", + "Hash", + "DynamicRange" + ], + "x-ms-enum": { + "name": "TeradataPartitionOption", + "modelAsString": true + } + }, + "partitionSettings": { + "description": "The settings that will be leveraged for teradata source partitioning.", + "$ref": "#/definitions/TeradataPartitionSettings" + } + } + }, + "TeradataPartitionSettings": { + "description": "The settings that will be leveraged for teradata source partitioning.", + "type": "object", + "properties": { + "partitionColumnName": { + "type": "object", + "description": "The name of the column that will be used for proceeding range or hash partitioning. Type: string (or Expression with resultType string)." + }, + "partitionUpperBound": { + "type": "object", + "description": "The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "partitionLowerBound": { + "type": "object", + "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + } + } + }, + "WebSource": { + "description": "A copy activity source for web page table.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "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)." + } + } + }, + "CassandraSource": { + "description": "A copy activity source for a Cassandra database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Should be a SQL-92 query expression or Cassandra Query Language (CQL) command. Type: string (or Expression with resultType string)." + }, + "consistencyLevel": { + "description": "The consistency level specifies how many Cassandra servers must respond to a read request before returning data to the client application. Cassandra checks the specified number of Cassandra servers for data to satisfy the read request. Must be one of cassandraSourceReadConsistencyLevels. The default value is 'ONE'. It is case-insensitive.", + "type": "string", + "enum": [ + "ALL", + "EACH_QUORUM", + "QUORUM", + "LOCAL_QUORUM", + "ONE", + "TWO", + "THREE", + "LOCAL_ONE", + "SERIAL", + "LOCAL_SERIAL" + ], + "x-ms-enum": { + "name": "CassandraSourceReadConsistencyLevels", + "modelAsString": true + } + } + } + }, + "MongoDbSource": { + "description": "A copy activity source for a MongoDB database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Should be a SQL-92 query expression. Type: string (or Expression with resultType string)." + }, + "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)." + } + } + }, + "MongoDbAtlasSource": { + "description": "A copy activity source for a MongoDB Atlas database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "filter": { + "type": "object", + "description": "Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string)." + }, + "cursorMethods": { + "description": "Cursor methods for Mongodb query", + "$ref": "#/definitions/MongoDbCursorMethodsProperties" + }, + "batchSize": { + "type": "object", + "description": "Specifies the number of documents to return in each batch of the response from MongoDB Atlas instance. In most cases, modifying the batch size will not affect the user or the application. This property's main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer)." + }, + "queryTimeout": { + "type": "object", + "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "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)." + } + } + }, + "MongoDbV2Source": { + "description": "A copy activity source for a MongoDB database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "filter": { + "type": "object", + "description": "Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string)." + }, + "cursorMethods": { + "description": "Cursor methods for Mongodb query", + "$ref": "#/definitions/MongoDbCursorMethodsProperties" + }, + "batchSize": { + "type": "object", + "description": "Specifies the number of documents to return in each batch of the response from MongoDB instance. In most cases, modifying the batch size will not affect the user or the application. This property's main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer)." + }, + "queryTimeout": { + "type": "object", + "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "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)." + } + } + }, + "CosmosDbMongoDbApiSource": { + "description": "A copy activity source for a CosmosDB (MongoDB API) database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "filter": { + "type": "object", + "description": "Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string)." + }, + "cursorMethods": { + "description": "Cursor methods for Mongodb query.", + "$ref": "#/definitions/MongoDbCursorMethodsProperties" + }, + "batchSize": { + "type": "object", + "description": "Specifies the number of documents to return in each batch of the response from MongoDB instance. In most cases, modifying the batch size will not affect the user or the application. This property's main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer)." + }, + "queryTimeout": { + "type": "object", + "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "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)." + } + } + }, + "MongoDbCursorMethodsProperties": { + "description": "Cursor methods for Mongodb query", + "type": "object", + "properties": { + "project": { + "type": "object", + "description": "Specifies the fields to return in the documents that match the query filter. To return all fields in the matching documents, omit this parameter. Type: string (or Expression with resultType string)." + }, + "sort": { + "type": "object", + "description": "Specifies the order in which the query returns matching documents. Type: string (or Expression with resultType string). Type: string (or Expression with resultType string)." + }, + "skip": { + "type": "object", + "description": "Specifies the how many documents skipped and where MongoDB begins returning results. This approach may be useful in implementing paginated results. Type: integer (or Expression with resultType integer)." + }, + "limit": { + "type": "object", + "description": "Specifies the maximum number of documents the server returns. limit() is analogous to the LIMIT statement in a SQL database. Type: integer (or Expression with resultType integer)." + } + }, + "additionalProperties": { + "type": "object" + } + }, + "Office365Source": { + "description": "A copy activity source for an Office 365 service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "allowedGroups": { + "type": "object", + "description": "The groups containing all the users. Type: array of strings (or Expression with resultType array of strings)." + }, + "userScopeFilterUri": { + "type": "object", + "description": "The user scope uri. Type: string (or Expression with resultType string)." + }, + "dateFilterColumn": { + "type": "object", + "description": "The Column to apply the and . Type: string (or Expression with resultType string)." + }, + "startTime": { + "type": "object", + "description": "Start time of the requested range for this dataset. Type: string (or Expression with resultType string)." + }, + "endTime": { + "type": "object", + "description": "End time of the requested range for this dataset. Type: string (or Expression with resultType string)." + }, + "outputColumns": { + "type": "object", + "description": "The columns to be read out from the Office 365 table. Type: array of objects (or Expression with resultType array of objects). Example: [ { \"name\": \"Id\" }, { \"name\": \"CreatedDateTime\" } ]" + } + } + }, + "AzureDataLakeStoreSource": { + "description": "A copy activity Azure Data Lake source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "AzureBlobFSSource": { + "description": "A copy activity Azure BlobFS source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "treatEmptyAsNull": { + "type": "object", + "description": "Treat empty as null. Type: boolean (or Expression with resultType boolean)." + }, + "skipHeaderLineCount": { + "type": "object", + "description": "Number of header lines to skip from each blob. Type: integer (or Expression with resultType integer)." + }, + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "HttpSource": { + "description": "A copy activity source for an HTTP file.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "httpRequestTimeout": { + "type": "object", + "description": "Specifies the timeout for a HTTP client to get HTTP response from HTTP server. The default value is equivalent to System.Net.HttpWebRequest.Timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, + "AmazonMWSSource": { + "description": "A copy activity Amazon Marketplace Web Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "AzurePostgreSqlSource": { + "description": "A copy activity Azure PostgreSQL source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "AzurePostgreSqlSink": { + "description": "A copy activity Azure PostgreSQL sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." + } + } + }, + "AzureMySqlSink": { + "description": "A copy activity Azure MySql sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." + } + } + }, + "ConcurSource": { + "description": "A copy activity Concur Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "CouchbaseSource": { + "description": "A copy activity Couchbase server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "DrillSource": { + "description": "A copy activity Drill server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "EloquaSource": { + "description": "A copy activity Eloqua server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "GoogleBigQuerySource": { + "description": "A copy activity Google BigQuery service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "GreenplumSource": { + "description": "A copy activity Greenplum Database source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "HBaseSource": { + "description": "A copy activity HBase server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "HiveSource": { + "description": "A copy activity Hive Server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "HubspotSource": { + "description": "A copy activity Hubspot Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ImpalaSource": { + "description": "A copy activity Impala server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "JiraSource": { + "description": "A copy activity Jira Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "MagentoSource": { + "description": "A copy activity Magento server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "MariaDBSource": { + "description": "A copy activity MariaDB server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "AzureMariaDBSource": { + "description": "A copy activity Azure MariaDB source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "MarketoSource": { + "description": "A copy activity Marketo server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "PaypalSource": { + "description": "A copy activity Paypal Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "PhoenixSource": { + "description": "A copy activity Phoenix server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "PrestoSource": { + "description": "A copy activity Presto server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "QuickBooksSource": { + "description": "A copy activity QuickBooks server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ServiceNowSource": { + "description": "A copy activity ServiceNow server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ShopifySource": { + "description": "A copy activity Shopify Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "SparkSource": { + "description": "A copy activity Spark Server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "SquareSource": { + "description": "A copy activity Square Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "XeroSource": { + "description": "A copy activity Xero Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ZohoSource": { + "description": "A copy activity Zoho server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "NetezzaSource": { + "description": "A copy activity Netezza source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Netezza read in parallel.", + "type": "string", + "enum": [ + "None", + "DataSlice", + "DynamicRange" + ], + "x-ms-enum": { + "name": "NetezzaPartitionOption", + "modelAsString": true + } + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Netezza source partitioning.", + "$ref": "#/definitions/NetezzaPartitionSettings" + } + } + }, + "NetezzaPartitionSettings": { + "description": "The settings that will be leveraged for Netezza source partitioning.", + "type": "object", + "properties": { + "partitionColumnName": { + "type": "object", + "description": "The name of the column in integer type that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "partitionUpperBound": { + "type": "object", + "description": "The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + }, + "partitionLowerBound": { + "type": "object", + "description": "The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string)." + } + } + }, + "VerticaSource": { + "description": "A copy activity Vertica source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "SalesforceMarketingCloudSource": { + "description": "A copy activity Salesforce Marketing Cloud source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ResponsysSource": { + "description": "A copy activity Responsys source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "DynamicsAXSource": { + "description": "A copy activity Dynamics AX source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + }, + "httpRequestTimeout": { + "type": "object", + "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, + "OracleServiceCloudSource": { + "description": "A copy activity Oracle Service Cloud source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "GoogleAdWordsSource": { + "description": "A copy activity Google AdWords service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "AmazonRedshiftSource": { + "description": "A copy activity source for Amazon Redshift Source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TabularSource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + }, + "redshiftUnloadSettings": { + "description": "The Amazon S3 settings needed for the interim Amazon S3 when copying from Amazon Redshift with unload. With this, data from Amazon Redshift source will be unloaded into S3 first and then copied into the targeted sink from the interim S3.", + "$ref": "#/definitions/RedshiftUnloadSettings" + } + } + }, + "RedshiftUnloadSettings": { + "description": "The Amazon S3 settings needed for the interim Amazon S3 when copying from Amazon Redshift with unload. With this, data from Amazon Redshift source will be unloaded into S3 first and then copied into the targeted sink from the interim S3.", + "type": "object", + "properties": { + "s3LinkedServiceName": { + "description": "The name of the Amazon S3 linked service which will be used for the unload operation when copying from the Amazon Redshift source.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "bucketName": { + "type": "object", + "description": "The bucket of the interim Amazon S3 which will be used to store the unloaded data from Amazon Redshift source. The bucket must be in the same region as the Amazon Redshift source. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "s3LinkedServiceName", + "bucketName" + ] + }, + "SnowflakeSource": { + "description": "A copy activity snowflake source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Snowflake Sql query. Type: string (or Expression with resultType string)." + }, + "exportSettings": { + "$ref": "#/definitions/SnowflakeExportCopyCommand", + "description": "Snowflake export settings." + } + } + }, + "ExportSettings": { + "description": "Export command settings.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The export setting type." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "SnowflakeExportCopyCommand": { + "description": "Snowflake export command settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExportSettings" + } + ], + "properties": { + "additionalCopyOptions": { + "type": "object", + "description": "Additional copy options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalCopyOptions\": { \"DATE_FORMAT\": \"MM/DD/YYYY\", \"TIME_FORMAT\": \"'HH24:MI:SS.FF'\" }", + "additionalProperties": { + "type": "object" + } + }, + "additionalFormatOptions": { + "type": "object", + "description": "Additional format options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalFormatOptions\": { \"OVERWRITE\": \"TRUE\", \"MAX_FILE_SIZE\": \"'FALSE'\" }", + "additionalProperties": { + "type": "object" + } + } + } + }, + "AzureDatabricksDeltaLakeSource": { + "description": "A copy activity Azure Databricks Delta Lake source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Azure Databricks Delta Lake Sql query. Type: string (or Expression with resultType string)." + }, + "exportSettings": { + "$ref": "#/definitions/AzureDatabricksDeltaLakeExportCommand", + "description": "Azure Databricks Delta Lake export settings." + } + } + }, + "AzureDatabricksDeltaLakeExportCommand": { + "description": "Azure Databricks Delta Lake export command settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExportSettings" + } + ], + "properties": { + "dateFormat": { + "type": "object", + "description": "Specify the date format for the csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string)." + }, + "timestampFormat": { + "type": "object", + "description": "Specify the timestamp format for the csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string)." + } + } + }, + "AzureDatabricksDeltaLakeSink": { + "description": "A copy activity Azure Databricks Delta Lake sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "importSettings": { + "$ref": "#/definitions/AzureDatabricksDeltaLakeImportCommand", + "description": "Azure Databricks Delta Lake import settings." + } + } + }, + "AzureDatabricksDeltaLakeImportCommand": { + "description": "Azure Databricks Delta Lake import command settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImportSettings" + } + ], + "properties": { + "dateFormat": { + "type": "object", + "description": "Specify the date format for csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string)." + }, + "timestampFormat": { + "type": "object", + "description": "Specify the timestamp format for csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string)." + } + } + }, + "StoredProcedureParameter": { + "description": "SQL stored procedure parameter.", + "type": "object", + "properties": { + "value": { + "type": "object", + "description": "Stored procedure parameter value. Type: string (or Expression with resultType string)." + }, + "type": { + "description": "Stored procedure parameter type.", + "$ref": "#/definitions/StoredProcedureParameterType" + } + } + }, + "StoredProcedureParameterType": { + "description": "Stored procedure parameter type.", + "type": "string", + "enum": [ + "String", + "Int", + "Int64", + "Decimal", + "Guid", + "Boolean", + "Date" + ], + "x-ms-enum": { + "name": "StoredProcedureParameterType", + "modelAsString": true + } + }, + "CopySink": { + "discriminator": "type", + "description": "A copy activity sink.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Copy sink type." + }, + "writeBatchSize": { + "type": "object", + "description": "Write batch size. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "writeBatchTimeout": { + "type": "object", + "description": "Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "sinkRetryCount": { + "type": "object", + "description": "Sink retry count. Type: integer (or Expression with resultType integer)." + }, + "sinkRetryWait": { + "type": "object", + "description": "Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "maxConcurrentConnections": { + "type": "object", + "description": "The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "SapCloudForCustomerSink": { + "description": "A copy activity SAP Cloud for Customer sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "The write behavior for the operation. Default is 'Insert'.", + "type": "string", + "enum": [ + "Insert", + "Update" + ], + "x-ms-enum": { + "name": "SapCloudForCustomerSinkWriteBehavior", + "modelAsString": true + } + }, + "httpRequestTimeout": { + "type": "object", + "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, + "AzureQueueSink": { + "description": "A copy activity Azure Queue sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": {} + }, + "CopyBehaviorType": { + "description": "All available types of copy behavior.", + "type": "string", + "enum": [ + "PreserveHierarchy", + "FlattenHierarchy", + "MergeFiles" + ], + "x-ms-enum": { + "name": "CopyBehaviorType", + "modelAsString": true + } + }, + "AzureTableSink": { + "description": "A copy activity Azure Table sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "azureTableDefaultPartitionKeyValue": { + "type": "object", + "description": "Azure Table default partition key value. Type: string (or Expression with resultType string)." + }, + "azureTablePartitionKeyName": { + "type": "object", + "description": "Azure Table partition key name. Type: string (or Expression with resultType string)." + }, + "azureTableRowKeyName": { + "type": "object", + "description": "Azure Table row key name. Type: string (or Expression with resultType string)." + }, + "azureTableInsertType": { + "type": "object", + "description": "Azure Table insert type. Type: string (or Expression with resultType string)." + } + } + }, + "AvroSink": { + "description": "A copy activity Avro sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreWriteSettings", + "description": "Avro store settings." + }, + "formatSettings": { + "$ref": "#/definitions/AvroWriteSettings", + "description": "Avro format settings." + } + } + }, + "ParquetSink": { + "description": "A copy activity Parquet sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreWriteSettings", + "description": "Parquet store settings." + }, + "formatSettings": { + "$ref": "#/definitions/ParquetWriteSettings", + "description": "Parquet format settings." + } + } + }, + "BinarySink": { + "description": "A copy activity Binary sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreWriteSettings", + "description": "Binary store settings." + } + } + }, + "BlobSink": { + "description": "A copy activity Azure Blob sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "blobWriterOverwriteFiles": { + "type": "object", + "description": "Blob writer overwrite files. Type: boolean (or Expression with resultType boolean)." + }, + "blobWriterDateTimeFormat": { + "type": "object", + "description": "Blob writer date time format. Type: string (or Expression with resultType string)." + }, + "blobWriterAddHeader": { + "type": "object", + "description": "Blob writer add header. Type: boolean (or Expression with resultType boolean)." + }, + "copyBehavior": { + "description": "The type of copy behavior for copy sink.", + "type": "object" + } + } + }, + "FileSystemSink": { + "description": "A copy activity file system sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "copyBehavior": { + "description": "The type of copy behavior for copy sink.", + "type": "object" + } + } + }, + "DocumentDbCollectionSink": { + "description": "A copy activity Document Database Collection sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "nestingSeparator": { + "type": "object", + "description": "Nested properties separator. Default is . (dot). Type: string (or Expression with resultType string)." + }, + "writeBehavior": { + "type": "object", + "description": "Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert." + } + } + }, + "CosmosDbSqlApiSink": { + "description": "A copy activity Azure CosmosDB (SQL API) Collection sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "type": "object", + "description": "Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert." + } + } + }, + "SqlSink": { + "description": "A copy activity SQL sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "sqlWriterStoredProcedureName": { + "type": "object", + "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." + }, + "sqlWriterTableType": { + "type": "object", + "description": "SQL writer table type. Type: string (or Expression with resultType string)." + }, + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "SQL stored procedure parameters.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "storedProcedureTableTypeParameterName": { + "type": "object", + "description": "The stored procedure parameter name of the table type. Type: string (or Expression with resultType string)." + }, + "tableOption": { + "type": "object", + "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." + } + } + }, + "SqlServerSink": { + "description": "A copy activity SQL server sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "sqlWriterStoredProcedureName": { + "type": "object", + "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." + }, + "sqlWriterTableType": { + "type": "object", + "description": "SQL writer table type. Type: string (or Expression with resultType string)." + }, + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "SQL stored procedure parameters.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "storedProcedureTableTypeParameterName": { + "type": "object", + "description": "The stored procedure parameter name of the table type. Type: string (or Expression with resultType string)." + }, + "tableOption": { + "type": "object", + "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." + } + } + }, + "AzureSqlSink": { + "description": "A copy activity Azure SQL sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "sqlWriterStoredProcedureName": { + "type": "object", + "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." + }, + "sqlWriterTableType": { + "type": "object", + "description": "SQL writer table type. Type: string (or Expression with resultType string)." + }, + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "SQL stored procedure parameters.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "storedProcedureTableTypeParameterName": { + "type": "object", + "description": "The stored procedure parameter name of the table type. Type: string (or Expression with resultType string)." + }, + "tableOption": { + "type": "object", + "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." + } + } + }, + "SqlMISink": { + "description": "A copy activity Azure SQL Managed Instance sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "sqlWriterStoredProcedureName": { + "type": "object", + "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." + }, + "sqlWriterTableType": { + "type": "object", + "description": "SQL writer table type. Type: string (or Expression with resultType string)." + }, + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "SQL stored procedure parameters.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + }, + "storedProcedureTableTypeParameterName": { + "type": "object", + "description": "The stored procedure parameter name of the table type. Type: string (or Expression with resultType string)." + }, + "tableOption": { + "type": "object", + "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." + } + } + }, + "SqlDWSink": { + "description": "A copy activity SQL Data Warehouse sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "allowPolyBase": { + "type": "object", + "description": "Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable. Type: boolean (or Expression with resultType boolean)." + }, + "polyBaseSettings": { + "description": "Specifies PolyBase-related settings when allowPolyBase is true.", + "$ref": "#/definitions/PolybaseSettings" + }, + "allowCopyCommand": { + "type": "object", + "description": "Indicates to use Copy Command to copy data into SQL Data Warehouse. Type: boolean (or Expression with resultType boolean)." + }, + "copyCommandSettings": { + "description": "Specifies Copy Command related settings when allowCopyCommand is true.", + "$ref": "#/definitions/DWCopyCommandSettings" + }, + "tableOption": { + "type": "object", + "description": "The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string)." + } + } + }, + "PolybaseSettings": { + "description": "PolyBase settings.", + "type": "object", + "properties": { + "rejectType": { + "$ref": "#/definitions/PolybaseSettingsRejectType", + "description": "Reject type." + }, + "rejectValue": { + "type": "object", + "description": "Specifies the value or the percentage of rows that can be rejected before the query fails. Type: number (or Expression with resultType number), minimum: 0." + }, + "rejectSampleValue": { + "type": "object", + "description": "Determines the number of rows to attempt to retrieve before the PolyBase recalculates the percentage of rejected rows. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "useTypeDefault": { + "type": "object", + "description": "Specifies how to handle missing values in delimited text files when PolyBase retrieves data from the text file. Type: boolean (or Expression with resultType boolean)." + } + }, + "additionalProperties": { + "type": "object" + } + }, + "PolybaseSettingsRejectType": { + "description": "Indicates whether the RejectValue property is specified as a literal value or a percentage.", + "type": "string", + "enum": [ + "value", + "percentage" + ], + "x-ms-enum": { + "name": "PolybaseSettingsRejectType", + "modelAsString": true + } + }, + "DWCopyCommandSettings": { + "description": "DW Copy Command settings.", + "type": "object", + "properties": { + "defaultValues": { + "type": "array", + "description": "Specifies the default values for each target column in SQL DW. The default values in the property overwrite the DEFAULT constraint set in the DB, and identity column cannot have a default value. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/DWCopyCommandDefaultValue" + } + }, + "additionalOptions": { + "type": "object", + "description": "Additional options directly passed to SQL DW in Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalOptions\": { \"MAXERRORS\": \"1000\", \"DATEFORMAT\": \"'ymd'\" }", + "additionalProperties": { + "type": "string" + } + } + } + }, + "DWCopyCommandDefaultValue": { + "description": "Default value.", + "type": "object", + "properties": { + "columnName": { + "type": "object", + "description": "Column name. Type: object (or Expression with resultType string)." + }, + "defaultValue": { + "type": "object", + "description": "The default value of the column. Type: object (or Expression with resultType string)." + } + } + }, + "SnowflakeSink": { + "description": "A copy activity snowflake sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "importSettings": { + "$ref": "#/definitions/SnowflakeImportCopyCommand", + "description": "Snowflake import settings." + } + } + }, + "ImportSettings": { + "description": "Import command settings.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The import setting type." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "SnowflakeImportCopyCommand": { + "description": "Snowflake import command settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImportSettings" + } + ], + "properties": { + "additionalCopyOptions": { + "type": "object", + "description": "Additional copy options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalCopyOptions\": { \"DATE_FORMAT\": \"MM/DD/YYYY\", \"TIME_FORMAT\": \"'HH24:MI:SS.FF'\" }", + "additionalProperties": { + "type": "object" + } + }, + "additionalFormatOptions": { + "type": "object", + "description": "Additional format options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalFormatOptions\": { \"FORCE\": \"TRUE\", \"LOAD_UNCERTAIN_FILES\": \"'FALSE'\" }", + "additionalProperties": { + "type": "object" + } + } + } + }, + "LogStorageSettings": { + "description": "(Deprecated. Please use LogSettings) Log storage settings.", + "type": "object", + "properties": { + "linkedServiceName": { + "description": "Log storage linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "path": { + "type": "object", + "description": "The path to storage for storing detailed logs of activity execution. Type: string (or Expression with resultType string)." + }, + "logLevel": { + "type": "object", + "description": "Gets or sets the log level, support: Info, Warning. Type: string (or Expression with resultType string)." + }, + "enableReliableLogging": { + "type": "object", + "description": "Specifies whether to enable reliable logging. Type: boolean (or Expression with resultType boolean)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "linkedServiceName" + ] + }, + "LogSettings": { + "description": "Log settings.", + "type": "object", + "properties": { + "enableCopyActivityLog": { + "type": "object", + "description": "Specifies whether to enable copy activity log. Type: boolean (or Expression with resultType boolean)." + }, + "copyActivityLogSettings": { + "description": "Specifies settings for copy activity log.", + "$ref": "#/definitions/CopyActivityLogSettings" + }, + "logLocationSettings": { + "description": "Log location settings customer needs to provide when enabling log.", + "$ref": "#/definitions/LogLocationSettings" + } + }, + "required": [ + "logLocationSettings" + ] + }, + "LogLocationSettings": { + "description": "Log location settings.", + "type": "object", + "properties": { + "linkedServiceName": { + "description": "Log storage linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "path": { + "type": "object", + "description": "The path to storage for storing detailed logs of activity execution. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "linkedServiceName" + ] + }, + "CopyActivityLogSettings": { + "description": "Settings for copy activity log.", + "type": "object", + "properties": { + "logLevel": { + "type": "object", + "description": "Gets or sets the log level, support: Info, Warning. Type: string (or Expression with resultType string)." + }, + "enableReliableLogging": { + "type": "object", + "description": "Specifies whether to enable reliable logging. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "StagingSettings": { + "description": "Staging settings.", + "type": "object", + "properties": { + "linkedServiceName": { + "description": "Staging linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "path": { + "type": "object", + "description": "The path to storage for storing the interim data. Type: string (or Expression with resultType string)." + }, + "enableCompression": { + "type": "object", + "description": "Specifies whether to use compression when copying data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "linkedServiceName" + ] + }, + "RedirectIncompatibleRowSettings": { + "description": "Redirect incompatible row settings", + "type": "object", + "properties": { + "linkedServiceName": { + "type": "object", + "description": "Name of the Azure Storage, Storage SAS, or Azure Data Lake Store linked service used for redirecting incompatible row. Must be specified if redirectIncompatibleRowSettings is specified. Type: string (or Expression with resultType string)." + }, + "path": { + "type": "object", + "description": "The path for storing the redirect incompatible row data. Type: string (or Expression with resultType string)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "linkedServiceName" + ] + }, + "SkipErrorFile": { + "description": "Skip error file.", + "type": "object", + "properties": { + "fileMissing": { + "type": "object", + "description": "Skip if file is deleted by other client during copy. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "dataInconsistency": { + "type": "object", + "description": "Skip if source/sink file changed by other concurrent write. Default is false. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "AdditionalColumns": { + "description": "Specify the column name and value of additional columns.", + "type": "object", + "properties": { + "name": { + "type": "object", + "description": "Additional column name. Type: string (or Expression with resultType string)." + }, + "value": { + "type": "object", + "description": "Additional column value. Type: string (or Expression with resultType string)." + } + } + }, + "OracleSink": { + "description": "A copy activity Oracle sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + } + } + }, + "AzureDataLakeStoreSink": { + "description": "A copy activity Azure Data Lake Store sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "copyBehavior": { + "description": "The type of copy behavior for copy sink.", + "type": "object" + }, + "enableAdlsSingleFileParallel": { + "description": "Single File Parallel.", + "type": "object" + } + } + }, + "AzureBlobFSSink": { + "description": "A copy activity Azure Data Lake Storage Gen2 sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "copyBehavior": { + "description": "The type of copy behavior for copy sink.", + "type": "object" + } + } + }, + "AzureSearchIndexSink": { + "description": "A copy activity Azure Search Index sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "Specify the write behavior when upserting documents into Azure Search Index.", + "type": "string", + "enum": [ + "Merge", + "Upload" + ], + "x-ms-enum": { + "name": "AzureSearchIndexWriteBehaviorType", + "modelAsString": true + } + } + } + }, + "OdbcSink": { + "description": "A copy activity ODBC sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." + } + } + }, + "InformixSink": { + "description": "A copy activity Informix sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." + } + } + }, + "MicrosoftAccessSink": { + "description": "A copy activity Microsoft Access sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." + } + } + }, + "DynamicsSinkWriteBehavior": { + "description": "Defines values for DynamicsSinkWriteBehavior.", + "type": "string", + "enum": [ + "Upsert" + ], + "x-ms-enum": { + "name": "DynamicsSinkWriteBehavior", + "modelAsString": true + } + }, + "DynamicsSink": { + "description": "A copy activity Dynamics sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "The write behavior for the operation.", + "$ref": "#/definitions/DynamicsSinkWriteBehavior" + }, + "ignoreNullValues": { + "type": "object", + "description": "The flag indicating whether ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "alternateKeyName": { + "type": "object", + "description": "The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "writeBehavior" + ] + }, + "DynamicsCrmSink": { + "description": "A copy activity Dynamics CRM sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "The write behavior for the operation.", + "$ref": "#/definitions/DynamicsSinkWriteBehavior" + }, + "ignoreNullValues": { + "type": "object", + "description": "The flag indicating whether to ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "alternateKeyName": { + "type": "object", + "description": "The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "writeBehavior" + ] + }, + "CommonDataServiceForAppsSink": { + "description": "A copy activity Common Data Service for Apps sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "The write behavior for the operation.", + "$ref": "#/definitions/DynamicsSinkWriteBehavior" + }, + "ignoreNullValues": { + "type": "object", + "description": "The flag indicating whether to ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "alternateKeyName": { + "type": "object", + "description": "The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "writeBehavior" + ] + }, + "AzureDataExplorerSink": { + "description": "A copy activity Azure Data Explorer sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "ingestionMappingName": { + "type": "object", + "description": "A name of a pre-created csv mapping that was defined on the target Kusto table. Type: string." + }, + "ingestionMappingAsJson": { + "type": "object", + "description": "An explicit column mapping description provided in a json format. Type: string." + }, + "flushImmediately": { + "type": "object", + "description": "If set to true, any aggregation will be skipped. Default is false. Type: boolean." + } + } + }, + "SalesforceSink": { + "description": "A copy activity Salesforce sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "The write behavior for the operation. Default is Insert.", + "type": "string", + "enum": [ + "Insert", + "Upsert" + ], + "x-ms-enum": { + "name": "SalesforceSinkWriteBehavior", + "modelAsString": true + } + }, + "externalIdFieldName": { + "type": "object", + "description": "The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string)." + }, + "ignoreNullValues": { + "type": "object", + "description": "The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation. Default value is false. If set it to true, it means ADF will leave the data in the destination object unchanged when doing upsert/update operation and insert defined default value when doing insert operation, versus ADF will update the data in the destination object to NULL when doing upsert/update operation and insert NULL value when doing insert operation. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "SalesforceServiceCloudSink": { + "description": "A copy activity Salesforce Service Cloud sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "The write behavior for the operation. Default is Insert.", + "type": "string", + "enum": [ + "Insert", + "Upsert" + ], + "x-ms-enum": { + "name": "SalesforceSinkWriteBehavior", + "modelAsString": true + } + }, + "externalIdFieldName": { + "type": "object", + "description": "The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string)." + }, + "ignoreNullValues": { + "type": "object", + "description": "The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation. Default value is false. If set it to true, it means ADF will leave the data in the destination object unchanged when doing upsert/update operation and insert defined default value when doing insert operation, versus ADF will update the data in the destination object to NULL when doing upsert/update operation and insert NULL value when doing insert operation. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "CosmosDbMongoDbApiSink": { + "description": "A copy activity sink for a CosmosDB (MongoDB API) database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "type": "object", + "description": "Specifies whether the document with same key to be overwritten (upsert) rather than throw exception (insert). The default value is \"insert\". Type: string (or Expression with resultType string). Type: string (or Expression with resultType string)." + } + } + }, + "CopyTranslator": { + "discriminator": "type", + "description": "A copy activity translator.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Copy translator type." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "TabularTranslator": { + "description": "A copy activity tabular translator.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopyTranslator" + } + ], + "properties": { + "columnMappings": { + "type": "object", + "description": "Column mappings. Example: \"UserId: MyUserId, Group: MyGroup, Name: MyName\" Type: string (or Expression with resultType string). This property will be retired. Please use mappings property." + }, + "schemaMapping": { + "type": "object", + "description": "The schema mapping to map between tabular data and hierarchical data. Example: {\"Column1\": \"$.Column1\", \"Column2\": \"$.Column2.Property1\", \"Column3\": \"$.Column2.Property2\"}. Type: object (or Expression with resultType object). This property will be retired. Please use mappings property." + }, + "collectionReference": { + "type": "object", + "description": "The JSON Path of the Nested Array that is going to do cross-apply. Type: object (or Expression with resultType object)." + }, + "mapComplexValuesToString": { + "type": "object", + "description": "Whether to map complex (array and object) values to simple strings in json format. Type: boolean (or Expression with resultType boolean)." + }, + "mappings": { + "type": "object", + "description": "Column mappings with logical types. Tabular->tabular example: [{\"source\":{\"name\":\"CustomerName\",\"type\":\"String\"},\"sink\":{\"name\":\"ClientName\",\"type\":\"String\"}},{\"source\":{\"name\":\"CustomerAddress\",\"type\":\"String\"},\"sink\":{\"name\":\"ClientAddress\",\"type\":\"String\"}}]. Hierarchical->tabular example: [{\"source\":{\"path\":\"$.CustomerName\",\"type\":\"String\"},\"sink\":{\"name\":\"ClientName\",\"type\":\"String\"}},{\"source\":{\"path\":\"$.CustomerAddress\",\"type\":\"String\"},\"sink\":{\"name\":\"ClientAddress\",\"type\":\"String\"}}]. Type: object (or Expression with resultType object)." + }, + "typeConversion": { + "type": "object", + "description": "Whether to enable the advanced type conversion feature in the Copy activity. Type: boolean (or Expression with resultType boolean)." + }, + "typeConversionSettings": { + "description": "Type conversion settings", + "$ref": "#/definitions/TypeConversionSettings" + } + } + }, + "TypeConversionSettings": { + "description": "Type conversion settings", + "type": "object", + "properties": { + "allowDataTruncation": { + "type": "object", + "description": "Whether to allow data truncation when converting the data. Type: boolean (or Expression with resultType boolean)." + }, + "treatBooleanAsNumber": { + "type": "object", + "description": "Whether to treat boolean values as numbers. Type: boolean (or Expression with resultType boolean)." + }, + "dateTimeFormat": { + "type": "object", + "description": "The format for DateTime values. Type: string (or Expression with resultType string)." + }, + "dateTimeOffsetFormat": { + "type": "object", + "description": "The format for DateTimeOffset values. Type: string (or Expression with resultType string)." + }, + "timeSpanFormat": { + "type": "object", + "description": "The format for TimeSpan values. Type: string (or Expression with resultType string)." + }, + "culture": { + "type": "object", + "description": "The culture used to convert data from/to string. Type: string (or Expression with resultType string)." + } + } + }, + "HDInsightHiveActivity": { + "description": "HDInsight Hive activity type.", + "type": "object", + "x-ms-discriminator-value": "HDInsightHive", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "HDInsight Hive activity properties.", + "$ref": "#/definitions/HDInsightHiveActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightHiveActivityTypeProperties": { + "description": "HDInsight Hive activity properties.", + "type": "object", + "properties": { + "storageLinkedServices": { + "description": "Storage linked service references.", + "type": "array", + "items": { + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + } + }, + "arguments": { + "description": "User specified arguments to HDInsightActivity.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "getDebugInfo": { + "$ref": "#/definitions/HDInsightActivityDebugInfoOption", + "description": "Debug info option." + }, + "scriptPath": { + "type": "object", + "description": "Script path. Type: string (or Expression with resultType string)." + }, + "scriptLinkedService": { + "description": "Script linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "defines": { + "description": "Allows user to specify defines for Hive job request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "variables": { + "description": "User specified arguments under hivevar namespace.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "queryTimeout": { + "type": "integer", + "description": "Query timeout value (in minutes). Effective when the HDInsight cluster is with ESP (Enterprise Security Package)" + } + } + }, + "HDInsightActivityDebugInfoOption": { + "description": "The HDInsightActivityDebugInfoOption settings to use.", + "type": "string", + "enum": [ + "None", + "Always", + "Failure" + ], + "x-ms-enum": { + "name": "HDInsightActivityDebugInfoOption", + "modelAsString": true + } + }, + "HDInsightPigActivity": { + "description": "HDInsight Pig activity type.", + "type": "object", + "x-ms-discriminator-value": "HDInsightPig", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "HDInsight Pig activity properties.", + "$ref": "#/definitions/HDInsightPigActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightPigActivityTypeProperties": { + "description": "HDInsight Pig activity properties.", + "type": "object", + "properties": { + "storageLinkedServices": { + "description": "Storage linked service references.", + "type": "array", + "items": { + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + } + }, + "arguments": { + "type": "object", + "description": "User specified arguments to HDInsightActivity. Type: array (or Expression with resultType array)." + }, + "getDebugInfo": { + "$ref": "#/definitions/HDInsightActivityDebugInfoOption", + "description": "Debug info option." + }, + "scriptPath": { + "type": "object", + "description": "Script path. Type: string (or Expression with resultType string)." + }, + "scriptLinkedService": { + "description": "Script linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "defines": { + "description": "Allows user to specify defines for Pig job request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + } + }, + "HDInsightMapReduceActivity": { + "description": "HDInsight MapReduce activity type.", + "type": "object", + "x-ms-discriminator-value": "HDInsightMapReduce", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "HDInsight MapReduce activity properties.", + "$ref": "#/definitions/HDInsightMapReduceActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightMapReduceActivityTypeProperties": { + "description": "HDInsight MapReduce activity properties.", + "type": "object", + "properties": { + "storageLinkedServices": { + "description": "Storage linked service references.", + "type": "array", + "items": { + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + } + }, + "arguments": { + "description": "User specified arguments to HDInsightActivity.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "getDebugInfo": { + "$ref": "#/definitions/HDInsightActivityDebugInfoOption", + "description": "Debug info option." + }, + "className": { + "type": "object", + "description": "Class name. Type: string (or Expression with resultType string)." + }, + "jarFilePath": { + "type": "object", + "description": "Jar path. Type: string (or Expression with resultType string)." + }, + "jarLinkedService": { + "description": "Jar linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "jarLibs": { + "description": "Jar libs.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "defines": { + "description": "Allows user to specify defines for the MapReduce job request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + }, + "required": [ + "className", + "jarFilePath" + ] + }, + "HDInsightStreamingActivity": { + "description": "HDInsight streaming activity type.", + "type": "object", + "x-ms-discriminator-value": "HDInsightStreaming", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "HDInsight streaming activity properties.", + "$ref": "#/definitions/HDInsightStreamingActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightStreamingActivityTypeProperties": { + "description": "HDInsight streaming activity properties.", + "type": "object", + "properties": { + "storageLinkedServices": { + "description": "Storage linked service references.", + "type": "array", + "items": { + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + } + }, + "arguments": { + "description": "User specified arguments to HDInsightActivity.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "getDebugInfo": { + "$ref": "#/definitions/HDInsightActivityDebugInfoOption", + "description": "Debug info option." + }, + "mapper": { + "type": "object", + "description": "Mapper executable name. Type: string (or Expression with resultType string)." + }, + "reducer": { + "type": "object", + "description": "Reducer executable name. Type: string (or Expression with resultType string)." + }, + "input": { + "type": "object", + "description": "Input blob path. Type: string (or Expression with resultType string)." + }, + "output": { + "type": "object", + "description": "Output blob path. Type: string (or Expression with resultType string)." + }, + "filePaths": { + "description": "Paths to streaming job files. Can be directories.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "fileLinkedService": { + "description": "Linked service reference where the files are located.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "combiner": { + "type": "object", + "description": "Combiner executable name. Type: string (or Expression with resultType string)." + }, + "commandEnvironment": { + "description": "Command line environment values.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "defines": { + "description": "Allows user to specify defines for streaming job request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + }, + "required": [ + "mapper", + "reducer", + "input", + "output", + "filePaths" + ] + }, + "HDInsightSparkActivity": { + "description": "HDInsight Spark activity.", + "type": "object", + "x-ms-discriminator-value": "HDInsightSpark", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "HDInsight spark activity properties.", + "$ref": "#/definitions/HDInsightSparkActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightSparkActivityTypeProperties": { + "description": "HDInsight spark activity properties.", + "type": "object", + "properties": { + "rootPath": { + "type": "object", + "description": "The root path in 'sparkJobLinkedService' for all the job’s files. Type: string (or Expression with resultType string)." + }, + "entryFilePath": { + "type": "object", + "description": "The relative path to the root folder of the code/package to be executed. Type: string (or Expression with resultType string)." + }, + "arguments": { + "description": "The user-specified arguments to HDInsightSparkActivity.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "getDebugInfo": { + "$ref": "#/definitions/HDInsightActivityDebugInfoOption", + "description": "Debug info option." + }, + "sparkJobLinkedService": { + "description": "The storage linked service for uploading the entry file and dependencies, and for receiving logs.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "className": { + "description": "The application's Java/Spark main class.", + "type": "string" + }, + "proxyUser": { + "type": "object", + "description": "The user to impersonate that will execute the job. Type: string (or Expression with resultType string)." + }, + "sparkConfig": { + "description": "Spark configuration property.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + }, + "required": [ + "rootPath", + "entryFilePath" + ] + }, + "ExecuteSSISPackageActivity": { + "description": "Execute SSIS package activity.", + "type": "object", + "x-ms-discriminator-value": "ExecuteSSISPackage", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Execute SSIS package activity properties.", + "$ref": "#/definitions/ExecuteSSISPackageActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ExecuteSSISPackageActivityTypeProperties": { + "description": "Execute SSIS package activity properties.", + "type": "object", + "properties": { + "packageLocation": { + "description": "SSIS package location.", + "$ref": "#/definitions/SSISPackageLocation" + }, + "runtime": { + "description": "Specifies the runtime to execute SSIS package. The value should be \"x86\" or \"x64\". Type: string (or Expression with resultType string).", + "type": "object" + }, + "loggingLevel": { + "description": "The logging level of SSIS package execution. Type: string (or Expression with resultType string).", + "type": "object" + }, + "environmentPath": { + "description": "The environment path to execute the SSIS package. Type: string (or Expression with resultType string).", + "type": "object" + }, + "executionCredential": { + "description": "The package execution credential.", + "$ref": "#/definitions/SSISExecutionCredential" + }, + "connectVia": { + "description": "The integration runtime reference.", + "$ref": "../artifacts.json#/definitions/IntegrationRuntimeReference" + }, + "projectParameters": { + "description": "The project level parameters to execute the SSIS package.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISExecutionParameter" + } + }, + "packageParameters": { + "description": "The package level parameters to execute the SSIS package.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISExecutionParameter" + } + }, + "projectConnectionManagers": { + "description": "The project level connection managers to execute the SSIS package.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISConnectionManager" + } + }, + "packageConnectionManagers": { + "description": "The package level connection managers to execute the SSIS package.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISConnectionManager" + } + }, + "propertyOverrides": { + "description": "The property overrides to execute the SSIS package.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISPropertyOverride" + } + }, + "logLocation": { + "description": "SSIS package execution log location.", + "$ref": "#/definitions/SSISLogLocation" + } + }, + "required": [ + "packageLocation", + "connectVia" + ] + }, + "SSISPackageLocation": { + "description": "SSIS package location.", + "type": "object", + "properties": { + "packagePath": { + "description": "The SSIS package path. Type: string (or Expression with resultType string).", + "type": "object" + }, + "type": { + "description": "The type of SSIS package location.", + "type": "string", + "enum": [ + "SSISDB", + "File", + "InlinePackage", + "PackageStore" + ], + "x-ms-enum": { + "name": "SsisPackageLocationType", + "modelAsString": true + } + }, + "typeProperties": { + "x-ms-client-flatten": true, + "description": "SSIS package location properties.", + "$ref": "#/definitions/SSISPackageLocationTypeProperties" + } + } + }, + "SSISPackageLocationTypeProperties": { + "description": "SSIS package location properties.", + "type": "object", + "properties": { + "packagePassword": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "Password of the package." + }, + "accessCredential": { + "description": "The package access credential.", + "$ref": "#/definitions/SSISAccessCredential" + }, + "configurationPath": { + "description": "The configuration file of the package execution. Type: string (or Expression with resultType string).", + "type": "object" + }, + "configurationAccessCredential": { + "description": "The configuration file access credential.", + "$ref": "#/definitions/SSISAccessCredential" + }, + "packageName": { + "description": "The package name.", + "type": "string" + }, + "packageContent": { + "description": "The embedded package content. Type: string (or Expression with resultType string).", + "type": "object" + }, + "packageLastModifiedDate": { + "description": "The embedded package last modified date.", + "type": "string" + }, + "childPackages": { + "description": "The embedded child package list.", + "type": "array", + "items": { + "$ref": "#/definitions/SSISChildPackage" + } + } + } + }, + "SSISConnectionManager": { + "description": "SSIS Connection Manager.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISExecutionParameter" + } + }, + "SSISExecutionParameter": { + "description": "SSIS execution parameter.", + "type": "object", + "properties": { + "value": { + "type": "object", + "description": "SSIS package execution parameter value. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "value" + ] + }, + "SSISPropertyOverride": { + "description": "SSIS property override.", + "type": "object", + "properties": { + "value": { + "type": "object", + "description": "SSIS package property override value. Type: string (or Expression with resultType string)." + }, + "isSensitive": { + "type": "boolean", + "description": "Whether SSIS package property override value is sensitive data. Value will be encrypted in SSISDB if it is true" + } + }, + "required": [ + "value" + ] + }, + "SSISExecutionCredential": { + "description": "SSIS package execution credential.", + "type": "object", + "properties": { + "domain": { + "type": "object", + "description": "Domain for windows authentication." + }, + "userName": { + "type": "object", + "description": "UseName for windows authentication." + }, + "password": { + "$ref": "../artifacts.json#/definitions/SecureString", + "description": "Password for windows authentication." + } + }, + "required": [ + "domain", + "userName", + "password" + ] + }, + "SSISAccessCredential": { + "description": "SSIS access credential.", + "type": "object", + "properties": { + "domain": { + "type": "object", + "description": "Domain for windows authentication." + }, + "userName": { + "type": "object", + "description": "UseName for windows authentication." + }, + "password": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "Password for windows authentication." + } + }, + "required": [ + "domain", + "userName", + "password" + ] + }, + "SSISChildPackage": { + "description": "SSIS embedded child package.", + "type": "object", + "properties": { + "packagePath": { + "type": "object", + "description": "Path for embedded child package. Type: string (or Expression with resultType string)." + }, + "packageName": { + "type": "string", + "description": "Name for embedded child package." + }, + "packageContent": { + "type": "object", + "description": "Content for embedded child package. Type: string (or Expression with resultType string)." + }, + "packageLastModifiedDate": { + "type": "string", + "description": "Last modified date for embedded child package." + } + }, + "required": [ + "packagePath", + "packageContent" + ] + }, + "SSISLogLocation": { + "description": "SSIS package execution log location", + "type": "object", + "properties": { + "logPath": { + "description": "The SSIS package execution log path. Type: string (or Expression with resultType string).", + "type": "object" + }, + "type": { + "description": "The type of SSIS log location.", + "type": "string", + "enum": [ + "File" + ], + "x-ms-enum": { + "name": "SsisLogLocationType", + "modelAsString": true + } + }, + "typeProperties": { + "x-ms-client-flatten": true, + "description": "SSIS package execution log location properties.", + "$ref": "#/definitions/SSISLogLocationTypeProperties" + } + }, + "required": [ + "logPath", + "type", + "typeProperties" + ] + }, + "SSISLogLocationTypeProperties": { + "description": "SSIS package execution log location properties.", + "type": "object", + "properties": { + "accessCredential": { + "description": "The package execution log access credential.", + "$ref": "#/definitions/SSISAccessCredential" + }, + "logRefreshInterval": { + "type": "object", + "description": "Specifies the interval to refresh log. The default interval is 5 minutes. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, + "CustomActivity": { + "description": "Custom activity type.", + "type": "object", + "x-ms-discriminator-value": "Custom", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Custom activity properties.", + "$ref": "#/definitions/CustomActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "CustomActivityTypeProperties": { + "description": "Custom activity properties.", + "type": "object", + "properties": { + "command": { + "type": "object", + "description": "Command for custom activity Type: string (or Expression with resultType string)." + }, + "resourceLinkedService": { + "description": "Resource linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "folderPath": { + "type": "object", + "description": "Folder path for resource files Type: string (or Expression with resultType string)." + }, + "referenceObjects": { + "description": "Reference objects", + "$ref": "#/definitions/CustomActivityReferenceObject" + }, + "extendedProperties": { + "description": "User defined property bag. There is no restriction on the keys or values that can be used. The user specified custom activity has the full responsibility to consume and interpret the content defined.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "retentionTimeInDays": { + "type": "object", + "description": "The retention time for the files submitted for custom activity. Type: double (or Expression with resultType double)." + }, + "autoUserSpecification": { + "type": "object", + "description": "Elevation level and scope for the user, default is nonadmin task. Type: string (or Expression with resultType double)." + } + }, + "required": [ + "command" + ] + }, + "CustomActivityReferenceObject": { + "description": "Reference objects for custom activity", + "type": "object", + "properties": { + "linkedServices": { + "description": "Linked service references.", + "type": "array", + "items": { + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + } + }, + "datasets": { + "description": "Dataset references.", + "type": "array", + "items": { + "$ref": "../artifacts.json#/definitions/DatasetReference" + } + } + } + }, + "SqlServerStoredProcedureActivity": { + "description": "SQL stored procedure activity type.", + "type": "object", + "x-ms-discriminator-value": "SqlServerStoredProcedure", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "SQL stored procedure activity properties.", + "$ref": "#/definitions/SqlServerStoredProcedureActivityTypeProperties" + } + }, + "required": [ + "typeProperties", + "linkedServiceName" + ] + }, + "SqlServerStoredProcedureActivityTypeProperties": { + "description": "SQL stored procedure activity properties.", + "type": "object", + "properties": { + "storedProcedureName": { + "type": "object", + "description": "Stored procedure name. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + } + }, + "required": [ + "storedProcedureName" + ] + }, + "ExecutePipelineActivity": { + "x-ms-discriminator-value": "ExecutePipeline", + "type": "object", + "description": "Execute pipeline activity.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Execute pipeline activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExecutePipelineActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ExecutePipelineActivityTypeProperties": { + "description": "Execute pipeline activity properties.", + "type": "object", + "properties": { + "pipeline": { + "description": "Pipeline reference.", + "$ref": "../artifacts.json#/definitions/PipelineReference" + }, + "parameters": { + "description": "Pipeline parameters.", + "$ref": "../artifacts.json#/definitions/ParameterValueSpecification" + }, + "waitOnCompletion": { + "description": "Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false.", + "type": "boolean" + } + }, + "required": [ + "pipeline" + ] + }, + "DeleteActivity": { + "x-ms-discriminator-value": "Delete", + "description": "Delete activity.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Delete activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DeleteActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DeleteActivityTypeProperties": { + "description": "Delete activity properties.", + "type": "object", + "properties": { + "recursive": { + "type": "object", + "description": "If true, files or sub-folders under current folder path will be deleted recursively. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "maxConcurrentConnections": { + "type": "integer", + "minimum": 1, + "description": "The max concurrent connections to connect data source at the same time." + }, + "enableLogging": { + "type": "object", + "description": "Whether to record detailed logs of delete-activity execution. Default value is false. Type: boolean (or Expression with resultType boolean)." + }, + "logStorageSettings": { + "description": "Log storage settings customer need to provide when enableLogging is true.", + "$ref": "#/definitions/LogStorageSettings" + }, + "dataset": { + "description": "Delete activity dataset reference.", + "$ref": "../artifacts.json#/definitions/DatasetReference" + }, + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "Delete activity store settings." + } + }, + "required": [ + "dataset" + ] + }, + "AzureDataExplorerCommandActivity": { + "x-ms-discriminator-value": "AzureDataExplorerCommand", + "description": "Azure Data Explorer command activity.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Data Explorer command activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureDataExplorerCommandActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureDataExplorerCommandActivityTypeProperties": { + "description": "Azure Data Explorer command activity properties.", + "type": "object", + "properties": { + "command": { + "type": "object", + "description": "A control command, according to the Azure Data Explorer command syntax. Type: string (or Expression with resultType string)." + }, + "commandTimeout": { + "type": "object", + "description": "Control command timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))..)" + } + }, + "required": [ + "command" + ] + }, + "LookupActivity": { + "x-ms-discriminator-value": "Lookup", + "description": "Lookup activity.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Lookup activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/LookupActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "LookupActivityTypeProperties": { + "description": "Lookup activity properties.", + "type": "object", + "properties": { + "source": { + "description": "Dataset-specific source properties, same as copy activity source.", + "$ref": "#/definitions/CopySource" + }, + "dataset": { + "description": "Lookup activity dataset reference.", + "$ref": "../artifacts.json#/definitions/DatasetReference" + }, + "firstRowOnly": { + "type": "object", + "description": "Whether to return first row or all rows. Default value is true. Type: boolean (or Expression with resultType boolean)." + } + }, + "required": [ + "source", + "dataset" + ] + }, + "WebActivityMethod": { + "description": "The list of HTTP methods supported by a WebActivity.", + "type": "string", + "enum": [ + "GET", + "POST", + "PUT", + "DELETE" + ], + "x-ms-enum": { + "name": "WebActivityMethod", + "modelAsString": true + } + }, + "WebActivity": { + "x-ms-discriminator-value": "WebActivity", + "description": "Web activity.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Web activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WebActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "WebActivityAuthentication": { + "description": "Web activity authentication properties.", + "type": "object", + "properties": { + "type": { + "description": "Web activity authentication (Basic/ClientCertificate/MSI)", + "type": "string" + }, + "pfx": { + "description": "Base64-encoded contents of a PFX file.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "username": { + "description": "Web activity authentication user name for basic authentication.", + "type": "string" + }, + "password": { + "description": "Password for the PFX file or basic authentication.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "resource": { + "description": "Resource for which Azure Auth token will be requested when using MSI Authentication.", + "type": "string" + } + }, + "required": [ + "type" + ] + }, + "WebActivityTypeProperties": { + "description": "Web activity type properties.", + "type": "object", + "properties": { + "method": { + "description": "Rest API method for target endpoint.", + "$ref": "#/definitions/WebActivityMethod" + }, + "url": { + "type": "object", + "description": "Web activity target endpoint and path. Type: string (or Expression with resultType string)." + }, + "headers": { + "type": "object", + "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)." + }, + "body": { + "type": "object", + "description": "Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string)." + }, + "authentication": { + "description": "Authentication method used for calling the endpoint.", + "$ref": "#/definitions/WebActivityAuthentication" + }, + "datasets": { + "type": "array", + "description": "List of datasets passed to web endpoint.", + "items": { + "$ref": "../artifacts.json#/definitions/DatasetReference" + } + }, + "linkedServices": { + "type": "array", + "description": "List of linked services passed to web endpoint.", + "items": { + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + } + }, + "connectVia": { + "description": "The integration runtime reference.", + "$ref": "../artifacts.json#/definitions/IntegrationRuntimeReference" + } + }, + "required": [ + "method", + "url" + ] + }, + "GetMetadataActivity": { + "x-ms-discriminator-value": "GetMetadata", + "description": "Activity to get metadata of dataset", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "GetMetadata activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GetMetadataActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "GetMetadataActivityTypeProperties": { + "description": "GetMetadata activity properties.", + "type": "object", + "properties": { + "dataset": { + "description": "GetMetadata activity dataset reference.", + "$ref": "../artifacts.json#/definitions/DatasetReference" + }, + "fieldList": { + "description": "Fields of metadata to get from dataset.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "GetMetadata activity store settings." + }, + "formatSettings": { + "$ref": "#/definitions/FormatReadSettings", + "description": "GetMetadata activity format settings." + } + }, + "required": [ + "dataset" + ] + }, + "IfConditionActivity": { + "x-ms-discriminator-value": "IfCondition", + "description": "This activity evaluates a boolean expression and executes either the activities under the ifTrueActivities property or the ifFalseActivities property depending on the result of the expression.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "IfCondition activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/IfConditionActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "IfConditionActivityTypeProperties": { + "description": "IfCondition activity properties.", + "type": "object", + "properties": { + "expression": { + "description": "An expression that would evaluate to Boolean. This is used to determine the block of activities (ifTrueActivities or ifFalseActivities) that will be executed.", + "$ref": "../artifacts.json#/definitions/Expression" + }, + "ifTrueActivities": { + "type": "array", + "description": "List of activities to execute if expression is evaluated to true. This is an optional property and if not provided, the activity will exit without any action.", + "items": { + "$ref": "#/definitions/Activity" + } + }, + "ifFalseActivities": { + "type": "array", + "description": "List of activities to execute if expression is evaluated to false. This is an optional property and if not provided, the activity will exit without any action.", + "items": { + "$ref": "#/definitions/Activity" + } + } + }, + "required": [ + "expression" + ] + }, + "SwitchActivity": { + "x-ms-discriminator-value": "Switch", + "description": "This activity evaluates an expression and executes activities under the cases property that correspond to the expression evaluation expected in the equals property.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Switch activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SwitchActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SwitchActivityTypeProperties": { + "description": "Switch activity properties.", + "type": "object", + "properties": { + "on": { + "description": "An expression that would evaluate to a string or integer. This is used to determine the block of activities in cases that will be executed.", + "$ref": "../artifacts.json#/definitions/Expression" + }, + "cases": { + "type": "array", + "description": "List of cases that correspond to expected values of the 'on' property. This is an optional property and if not provided, the activity will execute activities provided in defaultActivities.", + "items": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SwitchCase" + } + }, + "defaultActivities": { + "type": "array", + "description": "List of activities to execute if no case condition is satisfied. This is an optional property and if not provided, the activity will exit without any action.", + "items": { + "$ref": "#/definitions/Activity" + } + } + }, + "required": [ + "on" + ] + }, + "SwitchCase": { + "description": "Switch cases with have a value and corresponding activities.", + "type": "object", + "properties": { + "value": { + "description": "Expected value that satisfies the expression result of the 'on' property.", + "type": "string" + }, + "activities": { + "type": "array", + "description": "List of activities to execute for satisfied case condition.", + "items": { + "$ref": "#/definitions/Activity" + } + } + } + }, + "ForEachActivity": { + "x-ms-discriminator-value": "ForEach", + "description": "This activity is used for iterating over a collection and execute given activities.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "ForEach activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ForEachActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ForEachActivityTypeProperties": { + "description": "ForEach activity properties.", + "type": "object", + "properties": { + "isSequential": { + "description": "Should the loop be executed in sequence or in parallel (max 50)", + "type": "boolean" + }, + "batchCount": { + "description": "Batch count to be used for controlling the number of parallel execution (when isSequential is set to false).", + "type": "integer", + "maximum": 50 + }, + "items": { + "description": "Collection to iterate.", + "$ref": "../artifacts.json#/definitions/Expression" + }, + "activities": { + "type": "array", + "description": "List of activities to execute .", + "items": { + "$ref": "#/definitions/Activity" + } + } + }, + "required": [ + "items", + "activities" + ] + }, + "AzureMLBatchExecutionActivity": { + "description": "Azure ML Batch Execution activity.", + "type": "object", + "x-ms-discriminator-value": "AzureMLBatchExecution", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Azure ML Batch Execution activity properties.", + "$ref": "#/definitions/AzureMLBatchExecutionActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureMLBatchExecutionActivityTypeProperties": { + "description": "Azure ML Batch Execution activity properties.", + "type": "object", + "properties": { + "globalParameters": { + "description": "Key,Value pairs to be passed to the Azure ML Batch Execution Service endpoint. Keys must match the names of web service parameters defined in the published Azure ML web service. Values will be passed in the GlobalParameters property of the Azure ML batch execution request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "webServiceOutputs": { + "description": "Key,Value pairs, mapping the names of Azure ML endpoint's Web Service Outputs to AzureMLWebServiceFile objects specifying the output Blob locations. This information will be passed in the WebServiceOutputs property of the Azure ML batch execution request.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AzureMLWebServiceFile" + } + }, + "webServiceInputs": { + "description": "Key,Value pairs, mapping the names of Azure ML endpoint's Web Service Inputs to AzureMLWebServiceFile objects specifying the input Blob locations.. This information will be passed in the WebServiceInputs property of the Azure ML batch execution request.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AzureMLWebServiceFile" + } + } + } + }, + "AzureMLWebServiceFile": { + "description": "Azure ML WebService Input/Output file", + "type": "object", + "properties": { + "filePath": { + "type": "object", + "description": "The relative file path, including container name, in the Azure Blob Storage specified by the LinkedService. Type: string (or Expression with resultType string)." + }, + "linkedServiceName": { + "description": "Reference to an Azure Storage LinkedService, where Azure ML WebService Input/Output file located.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + } + }, + "required": [ + "linkedServiceName", + "filePath" + ] + }, + "AzureMLUpdateResourceActivity": { + "description": "Azure ML Update Resource management activity.", + "type": "object", + "x-ms-discriminator-value": "AzureMLUpdateResource", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Azure ML Update Resource management activity properties.", + "$ref": "#/definitions/AzureMLUpdateResourceActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureMLUpdateResourceActivityTypeProperties": { + "description": "Azure ML Update Resource activity properties.", + "type": "object", + "properties": { + "trainedModelName": { + "type": "object", + "description": "Name of the Trained Model module in the Web Service experiment to be updated. Type: string (or Expression with resultType string)." + }, + "trainedModelLinkedServiceName": { + "description": "Name of Azure Storage linked service holding the .ilearner file that will be uploaded by the update operation.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "trainedModelFilePath": { + "type": "object", + "description": "The relative file path in trainedModelLinkedService to represent the .ilearner file that will be uploaded by the update operation. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "trainedModelName", + "trainedModelLinkedServiceName", + "trainedModelFilePath" + ] + }, + "AzureMLExecutePipelineActivity": { + "description": "Azure ML Execute Pipeline activity.", + "type": "object", + "x-ms-discriminator-value": "AzureMLExecutePipeline", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Azure ML Execute Pipeline activity properties.", + "$ref": "#/definitions/AzureMLExecutePipelineActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureMLExecutePipelineActivityTypeProperties": { + "description": "Azure ML Execute Pipeline activity properties.", + "type": "object", + "properties": { + "mlPipelineId": { + "description": "ID of the published Azure ML pipeline. Type: string (or Expression with resultType string).", + "type": "object" + }, + "experimentName": { + "description": "Run history experiment name of the pipeline run. This information will be passed in the ExperimentName property of the published pipeline execution request. Type: string (or Expression with resultType string).", + "type": "object" + }, + "mlPipelineParameters": { + "description": "Key,Value pairs to be passed to the published Azure ML pipeline endpoint. Keys must match the names of pipeline parameters defined in the published pipeline. Values will be passed in the ParameterAssignments property of the published pipeline execution request. Type: object with key value pairs (or Expression with resultType object).", + "type": "object" + }, + "mlParentRunId": { + "description": "The parent Azure ML Service pipeline run id. This information will be passed in the ParentRunId property of the published pipeline execution request. Type: string (or Expression with resultType string).", + "type": "object" + }, + "continueOnStepFailure": { + "description": "Whether to continue execution of other steps in the PipelineRun if a step fails. This information will be passed in the continueOnStepFailure property of the published pipeline execution request. Type: boolean (or Expression with resultType boolean).", + "type": "object" + } + }, + "required": [ + "mlPipelineId" + ] + }, + "AzureMLPipelineParameters": { + "description": "Key,Value pairs to be passed to the published Azure ML pipeline endpoint. Keys must match the names of pipeline parameters defined in the published pipeline. Values will be passed in the ParameterAssignments property of the published pipeline execution request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "DataLakeAnalyticsUSQLActivity": { + "description": "Data Lake Analytics U-SQL activity.", + "type": "object", + "x-ms-discriminator-value": "DataLakeAnalyticsU-SQL", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Data Lake Analytics U-SQL activity properties.", + "$ref": "#/definitions/DataLakeAnalyticsUSQLActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DataLakeAnalyticsUSQLActivityTypeProperties": { + "description": "DataLakeAnalyticsU-SQL activity properties.", + "type": "object", + "properties": { + "scriptPath": { + "type": "object", + "description": "Case-sensitive path to folder that contains the U-SQL script. Type: string (or Expression with resultType string)." + }, + "scriptLinkedService": { + "description": "Script linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + }, + "degreeOfParallelism": { + "type": "object", + "description": "The maximum number of nodes simultaneously used to run the job. Default value is 1. Type: integer (or Expression with resultType integer), minimum: 1." + }, + "priority": { + "type": "object", + "description": "Determines which jobs out of all that are queued should be selected to run first. The lower the number, the higher the priority. Default value is 1000. Type: integer (or Expression with resultType integer), minimum: 1." + }, + "parameters": { + "description": "Parameters for U-SQL job request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "runtimeVersion": { + "type": "object", + "description": "Runtime version of the U-SQL engine to use. Type: string (or Expression with resultType string)." + }, + "compilationMode": { + "type": "object", + "description": "Compilation mode of U-SQL. Must be one of these values : Semantic, Full and SingleBox. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "scriptPath", + "scriptLinkedService" + ] + }, + "WaitActivity": { + "x-ms-discriminator-value": "Wait", + "description": "This activity suspends pipeline execution for the specified interval.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Wait activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WaitActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "WaitActivityTypeProperties": { + "description": "Wait activity properties.", + "type": "object", + "properties": { + "waitTimeInSeconds": { + "description": "Duration in seconds.", + "type": "object" + } + }, + "required": [ + "waitTimeInSeconds" + ] + }, + "UntilActivity": { + "x-ms-discriminator-value": "Until", + "description": "This activity executes inner activities until the specified boolean expression results to true or timeout is reached, whichever is earlier.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Until activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/UntilActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "UntilActivityTypeProperties": { + "description": "Until activity properties.", + "type": "object", + "properties": { + "expression": { + "description": "An expression that would evaluate to Boolean. The loop will continue until this expression evaluates to true", + "$ref": "../artifacts.json#/definitions/Expression" + }, + "timeout": { + "type": "object", + "description": "Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])). Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "activities": { + "type": "array", + "description": "List of activities to execute.", + "items": { + "$ref": "#/definitions/Activity" + } + } + }, + "required": [ + "expression", + "activities" + ] + }, + "ValidationActivity": { + "x-ms-discriminator-value": "Validation", + "description": "This activity verifies that an external resource exists.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Validation activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ValidationActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ValidationActivityTypeProperties": { + "description": "Validation activity properties.", + "type": "object", + "properties": { + "timeout": { + "type": "object", + "description": "Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "sleep": { + "type": "object", + "description": "A delay in seconds between validation attempts. If no value is specified, 10 seconds will be used as the default. Type: integer (or Expression with resultType integer)." + }, + "minimumSize": { + "type": "object", + "description": "Can be used if dataset points to a file. The file must be greater than or equal in size to the value specified. Type: integer (or Expression with resultType integer)." + }, + "childItems": { + "type": "object", + "description": "Can be used if dataset points to a folder. If set to true, the folder must have at least one file. If set to false, the folder must be empty. Type: boolean (or Expression with resultType boolean)." + }, + "dataset": { + "description": "Validation activity dataset reference.", + "$ref": "../artifacts.json#/definitions/DatasetReference" + } + }, + "required": [ + "dataset" + ] + }, + "FilterActivity": { + "x-ms-discriminator-value": "Filter", + "description": "Filter and return results from input array based on the conditions.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Filter activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/FilterActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "FilterActivityTypeProperties": { + "description": "Filter activity properties.", + "type": "object", + "properties": { + "items": { + "description": "Input array on which filter should be applied.", + "$ref": "../artifacts.json#/definitions/Expression" + }, + "condition": { + "description": "Condition to be used for filtering the input.", + "$ref": "../artifacts.json#/definitions/Expression" + } + }, + "required": [ + "condition", + "items" + ] + }, + "DatabricksNotebookActivity": { + "description": "DatabricksNotebook activity.", + "type": "object", + "x-ms-discriminator-value": "DatabricksNotebook", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Databricks Notebook activity properties.", + "$ref": "#/definitions/DatabricksNotebookActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DatabricksNotebookActivityTypeProperties": { + "description": "Databricks Notebook activity properties.", + "type": "object", + "properties": { + "notebookPath": { + "type": "object", + "description": "The absolute path of the notebook to be run in the Databricks Workspace. This path must begin with a slash. Type: string (or Expression with resultType string)." + }, + "baseParameters": { + "description": "Base parameters to be used for each run of this job.If the notebook takes a parameter that is not specified, the default value from the notebook will be used.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "libraries": { + "description": "A list of libraries to be installed on the cluster that will execute the job.", + "type": "array", + "items": { + "type": "object", + "description": "Databricks library definition.", + "additionalProperties": { + "type": "object" + } + } + } + }, + "required": [ + "notebookPath" + ] + }, + "DatabricksSparkJarActivity": { + "description": "DatabricksSparkJar activity.", + "type": "object", + "x-ms-discriminator-value": "DatabricksSparkJar", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Databricks SparkJar activity properties.", + "$ref": "#/definitions/DatabricksSparkJarActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DatabricksSparkJarActivityTypeProperties": { + "description": "Databricks SparkJar activity properties.", + "type": "object", + "properties": { + "mainClassName": { + "type": "object", + "description": "The full name of the class containing the main method to be executed. This class must be contained in a JAR provided as a library. Type: string (or Expression with resultType string)." + }, + "parameters": { + "description": "Parameters that will be passed to the main method.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "libraries": { + "description": "A list of libraries to be installed on the cluster that will execute the job.", + "type": "array", + "items": { + "type": "object", + "description": "Databricks library definition.", + "additionalProperties": { + "type": "object" + } + } + } + }, + "required": [ + "mainClassName" + ] + }, + "DatabricksSparkPythonActivity": { + "description": "DatabricksSparkPython activity.", + "type": "object", + "x-ms-discriminator-value": "DatabricksSparkPython", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Databricks SparkPython activity properties.", + "$ref": "#/definitions/DatabricksSparkPythonActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DatabricksSparkPythonActivityTypeProperties": { + "description": "Databricks SparkPython activity properties.", + "type": "object", + "properties": { + "pythonFile": { + "type": "object", + "description": "The URI of the Python file to be executed. DBFS paths are supported. Type: string (or Expression with resultType string)." + }, + "parameters": { + "description": "Command line parameters that will be passed to the Python file.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "libraries": { + "description": "A list of libraries to be installed on the cluster that will execute the job.", + "type": "array", + "items": { + "type": "object", + "description": "Databricks library definition.", + "additionalProperties": { + "type": "object" + } + } + } + }, + "required": [ + "pythonFile" + ] + }, + "SetVariableActivity": { + "x-ms-discriminator-value": "SetVariable", + "description": "Set value for a Variable.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Set Variable activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SetVariableActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SetVariableActivityTypeProperties": { + "description": "SetVariable activity properties.", + "type": "object", + "properties": { + "variableName": { + "description": "Name of the variable whose value needs to be set.", + "type": "string" + }, + "value": { + "description": "Value to be set. Could be a static value or Expression", + "type": "object" + } + } + }, + "AppendVariableActivity": { + "x-ms-discriminator-value": "AppendVariable", + "description": "Append value for a Variable of type Array.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Append Variable activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AppendVariableActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AppendVariableActivityTypeProperties": { + "description": "AppendVariable activity properties.", + "type": "object", + "properties": { + "variableName": { + "description": "Name of the variable whose value needs to be appended to.", + "type": "string" + }, + "value": { + "description": "Value to be appended. Could be a static value or Expression", + "type": "object" + } + } + }, + "AzureFunctionActivityMethod": { + "description": "The list of HTTP methods supported by a AzureFunctionActivity.", + "type": "string", + "enum": [ + "GET", + "POST", + "PUT", + "DELETE", + "OPTIONS", + "HEAD", + "TRACE" + ], + "x-ms-enum": { + "name": "AzureFunctionActivityMethod", + "modelAsString": true + } + }, + "AzureFunctionActivity": { + "x-ms-discriminator-value": "AzureFunctionActivity", + "description": "Azure Function activity.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Function activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFunctionActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureFunctionActivityTypeProperties": { + "description": "Azure Function activity type properties.", + "type": "object", + "properties": { + "method": { + "description": "Rest API method for target endpoint.", + "$ref": "#/definitions/AzureFunctionActivityMethod" + }, + "functionName": { + "type": "object", + "description": "Name of the Function that the Azure Function Activity will call. Type: string (or Expression with resultType string)" + }, + "headers": { + "type": "object", + "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)." + }, + "body": { + "type": "object", + "description": "Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string)." + } + }, + "required": [ + "method", + "functionName" + ] + }, + "WebHookActivity": { + "x-ms-discriminator-value": "WebHook", + "description": "WebHook activity.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "WebHook activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WebHookActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "WebHookActivityMethod": { + "description": "The list of HTTP methods supported by a WebHook activity.", + "type": "string", + "enum": [ + "POST" + ], + "x-ms-enum": { + "name": "WebHookActivityMethod", + "modelAsString": true + } + }, + "WebHookActivityTypeProperties": { + "description": "WebHook activity type properties.", + "type": "object", + "properties": { + "method": { + "description": "Rest API method for target endpoint.", + "$ref": "#/definitions/WebHookActivityMethod" + }, + "url": { + "type": "object", + "description": "WebHook activity target endpoint and path. Type: string (or Expression with resultType string)." + }, + "timeout": { + "type": "string", + "description": "The timeout within which the webhook should be called back. If there is no value specified, it defaults to 10 minutes. Type: string. Pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "headers": { + "type": "object", + "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)." + }, + "body": { + "type": "object", + "description": "Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string)." + }, + "authentication": { + "description": "Authentication method used for calling the endpoint.", + "$ref": "#/definitions/WebActivityAuthentication" + }, + "reportStatusOnCallBack": { + "type": "object", + "description": "When set to true, statusCode, output and error in callback request body will be consumed by activity. The activity can be marked as failed by setting statusCode >= 400 in callback request. Default is false. Type: boolean (or Expression with resultType boolean)." + } + }, + "required": [ + "method", + "url" + ] + }, + "ExecuteDataFlowActivity": { + "description": "Execute data flow activity.", + "type": "object", + "x-ms-discriminator-value": "ExecuteDataFlow", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Execute data flow activity properties.", + "$ref": "#/definitions/ExecuteDataFlowActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ExecuteDataFlowActivityTypeProperties": { + "description": "Execute data flow activity properties.", + "type": "object", + "properties": { + "dataflow": { + "description": "Data flow reference.", + "$ref": "../artifacts.json#/definitions/DataFlowReference" + }, + "staging": { + "description": "Staging info for execute data flow activity.", + "$ref": "../artifacts.json#/definitions/DataFlowStagingInfo" + }, + "integrationRuntime": { + "description": "The integration runtime reference.", + "$ref": "../artifacts.json#/definitions/IntegrationRuntimeReference" + }, + "compute": { + "description": "Compute properties for data flow activity.", + "type": "object", + "properties": { + "computeType": { + "description": "Compute type of the cluster which will execute data flow job.", + "type": "string", + "enum": [ + "General", + "MemoryOptimized", + "ComputeOptimized" + ], + "x-ms-enum": { + "name": "DataFlowComputeType", + "modelAsString": true + } + }, + "coreCount": { + "description": "Core count of the cluster which will execute data flow job. Supported values are: 8, 16, 32, 48, 80, 144 and 272.", + "type": "integer" + } + } + }, + "traceLevel": { + "description": "Trace level setting used for data flow monitoring output. Supported values are: 'coarse', 'fine', and 'none'. Type: string (or Expression with resultType string)", + "type": "object" + }, + "continueOnError": { + "description": "Continue on error setting used for data flow execution. Enables processing to continue if a sink fails. Type: boolean (or Expression with resultType boolean)", + "type": "object" + }, + "runConcurrently": { + "description": "Concurrent run setting used for data flow execution. Allows sinks with the same save order to be processed concurrently. Type: boolean (or Expression with resultType boolean)", + "type": "object" + } + }, + "required": [ + "dataflow" + ] + }, + "SharePointOnlineListSource": { + "description": "A copy activity source for sharePoint online list source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "The OData query to filter the data in SharePoint Online list. For example, \"$top=1\". Type: string (or Expression with resultType string)." + }, + "httpRequestTimeout": { + "type": "object", + "description": "The wait time to get a response from SharePoint Online. Default value is 5 minutes (00:05:00). Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, + "SqlPartitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel.", + "type": "string", + "enum": [ + "None", + "PhysicalPartitionsOfTable", + "DynamicRange" + ], + "x-ms-enum": { + "name": "SqlPartitionOption", + "modelAsString": true + } + }, + "SapHanaPartitionOption": { + "description": "The partition mechanism that will be used for SAP HANA read in parallel.", + "type": "string", + "enum": [ + "None", + "PhysicalPartitionsOfTable", + "SapHanaDynamicRange" + ], + "x-ms-enum": { + "name": "SapHanaPartitionOption", + "modelAsString": true + } + }, + "SapTablePartitionOption": { + "description": "The partition mechanism that will be used for SAP table read in parallel.", + "type": "string", + "enum": [ + "None", + "PartitionOnInt", + "PartitionOnCalendarYear", + "PartitionOnCalendarMonth", + "PartitionOnCalendarDate", + "PartitionOnTime" + ], + "x-ms-enum": { + "name": "SapTablePartitionOption", + "modelAsString": true + } + }, + "OraclePartitionOption": { + "description": "The partition mechanism that will be used for Oracle read in parallel.", + "type": "string", + "enum": [ + "None", + "PhysicalPartitionsOfTable", + "DynamicRange" + ], + "x-ms-enum": { + "name": "OraclePartitionOption", + "modelAsString": true + } + }, + "TeradataPartitionOption": { + "description": "The partition mechanism that will be used for teradata read in parallel.", + "type": "string", + "enum": [ + "None", + "Hash", + "DynamicRange" + ], + "x-ms-enum": { + "name": "TeradataPartitionOption", + "modelAsString": true + } + }, + "NetezzaPartitionOption": { + "description": "The partition mechanism that will be used for Netezza read in parallel.", + "type": "string", + "enum": [ + "None", + "DataSlice", + "DynamicRange" + ], + "x-ms-enum": { + "name": "NetezzaPartitionOption", + "modelAsString": true + } + }, + "SynapseNotebookActivity": { + "description": "Execute Synapse notebook activity.", + "type": "object", + "x-ms-discriminator-value": "SynapseNotebook", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Execute Synapse notebook activity properties.", + "$ref": "#/definitions/SynapseNotebookActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SynapseNotebookActivityTypeProperties": { + "description": "Execute Synapse notebook activity properties.", + "type": "object", + "properties": { + "notebook": { + "description": "Synapse notebook reference.", + "$ref": "../artifacts.json#/definitions/SynapseNotebookReference" + }, + "parameters": { + "description": "Notebook parameters.", + "$ref": "../artifacts.json#/definitions/ParameterValueSpecification" + } + }, + "required": [ + "notebook" + ] + }, + "SynapseSparkJobDefinitionActivity": { + "description": "Execute spark job activity.", + "type": "object", + "x-ms-discriminator-value": "SparkJob", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Execute spark job activity properties.", + "$ref": "#/definitions/SynapseSparkJobActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SynapseSparkJobActivityTypeProperties": { + "description": "Execute spark job activity properties.", + "type": "object", + "properties": { + "sparkJob": { + "description": "Synapse spark job reference.", + "$ref": "../artifacts.json#/definitions/SynapseSparkJobReference" + } + }, + "required": [ + "sparkJob" + ] + }, + "SqlPoolStoredProcedureActivity": { + "description": "Execute SQL pool stored procedure activity.", + "type": "object", + "x-ms-discriminator-value": "SqlPoolStoredProcedure", + "allOf": [ + { + "$ref": "#/definitions/Activity" + } + ], + "properties": { + "sqlPool": { + "description": "SQL pool stored procedure reference.", + "$ref": "../artifacts.json#/definitions/SqlPoolReference" + }, + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Execute SQL pool stored procedure activity properties.", + "$ref": "#/definitions/SqlPoolStoredProcedureActivityTypeProperties" + } + }, + "required": [ + "sqlPool", + "typeProperties" + ] + }, + "SqlPoolStoredProcedureActivityTypeProperties": { + "description": "SQL stored procedure activity properties.", + "type": "object", + "properties": { + "storedProcedureName": { + "type": "object", + "description": "Stored procedure name. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + } + }, + "required": [ + "storedProcedureName" + ] + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/SparkJobDefinition.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/SparkJobDefinition.json new file mode 100644 index 000000000000..7394a41606b8 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/SparkJobDefinition.json @@ -0,0 +1,124 @@ +{ + "swagger": "2.0", + "info": { + "title": "ArtifactsClient", + "version": "2020-12-01" + }, + "paths": {}, + "definitions": { + "SparkJobDefinition": { + "description": "Spark job definition.", + "type": "object", + "properties": { + "description": { + "description": "The description of the Spark job definition.", + "type": "string" + }, + "targetBigDataPool": { + "description": "Big data pool reference.", + "$ref": "./Notebook.json#/definitions/BigDataPoolReference" + }, + "requiredSparkVersion": { + "description": "The required Spark version of the application.", + "type": "string" + }, + "language": { + "description": "The language of the Spark application.", + "type": "string" + }, + "jobProperties": { + "description": "The properties of the Spark job.", + "$ref": "#/definitions/SparkJobProperties" + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "targetBigDataPool", + "jobProperties" + ] + }, + "SparkJobProperties": { + "description": "The properties of the Spark job.", + "type": "object", + "properties": { + "name": { + "description": "The name of the job.", + "type": "string" + }, + "file": { + "description": "File containing the application to execute.", + "type": "string" + }, + "className": { + "description": "Main class for Java/Scala application.", + "type": "string" + }, + "conf": { + "description": "Spark configuration properties.", + "type": "object" + }, + "args": { + "description": "Command line arguments for the application.", + "type": "array", + "items": { + "type": "string" + } + }, + "jars": { + "description": "Jars to be used in this job.", + "type": "array", + "items": { + "type": "string" + } + }, + "files": { + "description": "files to be used in this job.", + "type": "array", + "items": { + "type": "string" + } + }, + "archives": { + "description": "Archives to be used in this job.", + "type": "array", + "items": { + "type": "string" + } + }, + "driverMemory": { + "description": "Amount of memory to use for the driver process.", + "type": "string" + }, + "driverCores": { + "description": "Number of cores to use for the driver.", + "type": "integer" + }, + "executorMemory": { + "description": "Amount of memory to use per executor process.", + "type": "string" + }, + "executorCores": { + "description": "Number of cores to use for each executor.", + "type": "integer" + }, + "numExecutors": { + "description": "Number of executors to launch for this job.", + "type": "integer" + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "file", + "driverMemory", + "driverCores", + "executorMemory", + "executorCores", + "numExecutors" + ] + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/SqlScript.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/SqlScript.json new file mode 100644 index 000000000000..5e2696afafb0 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/SqlScript.json @@ -0,0 +1,108 @@ +{ + "swagger": "2.0", + "info": { + "title": "ArtifactsClient", + "version": "2020-12-01" + }, + "paths": {}, + "definitions": { + "SqlScript": { + "description": "SQL script.", + "type": "object", + "properties": { + "description": { + "description": "The description of the SQL script.", + "type": "string" + }, + "type": { + "description": "The type of the SQL script.", + "type": "string", + "enum": [ + "SqlQuery" + ], + "x-ms-enum": { + "name": "SqlScriptType", + "modelAsString": true + } + }, + "content": { + "description": "The content of the SQL script.", + "$ref": "#/definitions/SqlScriptContent" + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "content" + ] + }, + "SqlScriptContent": { + "description": "The content of the SQL script.", + "type": "object", + "properties": { + "query": { + "description": "SQL query to execute.", + "type": "string" + }, + "currentConnection": { + "description": "The connection used to execute the SQL script.", + "$ref": "#/definitions/SqlConnection" + }, + "metadata": { + "description": "The metadata of the SQL script.", + "$ref": "#/definitions/SqlScriptMetadata" + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "query", + "currentConnection" + ] + }, + "SqlScriptMetadata": { + "description": "The metadata of the SQL script.", + "type": "object", + "properties": { + "language": { + "description": "The language of the SQL script.", + "type": "string" + } + }, + "additionalProperties": { + "type": "object" + } + }, + "SqlConnection": { + "description": "The connection used to execute the SQL script.", + "type": "object", + "properties": { + "type": { + "description": "The type of the connection.", + "type": "string", + "enum": [ + "SqlOnDemand", + "SqlPool" + ], + "x-ms-enum": { + "name": "SqlConnectionType", + "modelAsString": true + } + }, + "name": { + "description": "The identifier of the connection.", + "type": "string" + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type", + "name" + ] + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Trigger.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Trigger.json new file mode 100644 index 000000000000..37146c43887d --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Trigger.json @@ -0,0 +1,681 @@ +{ + "swagger": "2.0", + "info": { + "title": "ArtifactsClient", + "version": "2020-12-01" + }, + "paths": {}, + "definitions": { + "Trigger": { + "description": "Azure Synapse nested object which contains information about creating pipeline run", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Trigger type." + }, + "description": { + "description": "Trigger description.", + "type": "string" + }, + "runtimeState": { + "$ref": "#/definitions/TriggerRuntimeState", + "description": "Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger.", + "readOnly": true + }, + "annotations": { + "description": "List of tags that can be used for describing the trigger.", + "type": "array", + "items": { + "type": "object" + } + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "TriggerRuntimeState": { + "type": "string", + "description": "Enumerates possible state of Triggers.", + "enum": [ + "Started", + "Stopped", + "Disabled" + ], + "x-ms-enum": { + "name": "TriggerRuntimeState", + "modelAsString": true + } + }, + "MultiplePipelineTrigger": { + "x-ms-discriminator-value": "MultiplePipelineTrigger", + "description": "Base class for all triggers that support one to many model for trigger to pipeline.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Trigger" + } + ], + "properties": { + "pipelines": { + "type": "array", + "items": { + "$ref": "../artifacts.json#/definitions/TriggerPipelineReference" + }, + "description": "Pipelines that need to be started." + } + } + }, + "ScheduleTrigger": { + "description": "Trigger that creates pipeline runs periodically, on schedule.", + "allOf": [ + { + "$ref": "#/definitions/MultiplePipelineTrigger" + } + ], + "properties": { + "typeProperties": { + "description": "Schedule Trigger properties.", + "x-ms-client-flatten": true, + "properties": { + "recurrence": { + "$ref": "#/definitions/ScheduleTriggerRecurrence", + "description": "Recurrence schedule configuration." + } + }, + "required": [ + "recurrence" + ] + } + }, + "required": [ + "typeProperties" + ] + }, + "ScheduleTriggerRecurrence": { + "type": "object", + "properties": { + "frequency": { + "$ref": "#/definitions/RecurrenceFrequency", + "description": "The frequency." + }, + "interval": { + "type": "integer", + "format": "int32", + "description": "The interval." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time." + }, + "timeZone": { + "type": "string", + "description": "The time zone." + }, + "schedule": { + "$ref": "#/definitions/RecurrenceSchedule", + "description": "The recurrence schedule." + } + }, + "additionalProperties": { + "type": "object" + }, + "description": "The workflow trigger recurrence." + }, + "RecurrenceFrequency": { + "description": "Enumerates possible frequency option for the schedule trigger.", + "type": "string", + "enum": [ + "NotSpecified", + "Minute", + "Hour", + "Day", + "Week", + "Month", + "Year" + ], + "x-ms-enum": { + "name": "RecurrenceFrequency", + "modelAsString": true + } + }, + "RecurrenceSchedule": { + "type": "object", + "properties": { + "minutes": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "The minutes." + }, + "hours": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "The hours." + }, + "weekDays": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + } + }, + "description": "The days of the week." + }, + "monthDays": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "The month days." + }, + "monthlyOccurrences": { + "type": "array", + "items": { + "$ref": "#/definitions/RecurrenceScheduleOccurrence" + }, + "description": "The monthly occurrences." + } + }, + "additionalProperties": { + "type": "object" + }, + "description": "The recurrence schedule." + }, + "RecurrenceScheduleOccurrence": { + "type": "object", + "properties": { + "day": { + "$ref": "#/definitions/DayOfWeek", + "description": "The day of the week." + }, + "occurrence": { + "type": "integer", + "format": "int32", + "description": "The occurrence." + } + }, + "additionalProperties": { + "type": "object" + }, + "description": "The recurrence schedule occurrence." + }, + "DayOfWeek": { + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + }, + "description": "The days of the week." + }, + "BlobTrigger": { + "description": "Trigger that runs every time the selected Blob container changes.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MultiplePipelineTrigger" + } + ], + "properties": { + "typeProperties": { + "description": "Blob Trigger properties.", + "x-ms-client-flatten": true, + "properties": { + "folderPath": { + "description": "The path of the container/folder that will trigger the pipeline.", + "type": "string" + }, + "maxConcurrency": { + "description": "The max number of parallel files to handle when it is triggered.", + "type": "integer" + }, + "linkedService": { + "description": "The Azure Storage linked service reference.", + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" + } + }, + "required": [ + "folderPath", + "maxConcurrency", + "linkedService" + ] + } + }, + "required": [ + "typeProperties" + ] + }, + "BlobEventsTrigger": { + "description": "Trigger that runs every time a Blob event occurs.", + "allOf": [ + { + "$ref": "#/definitions/MultiplePipelineTrigger" + } + ], + "properties": { + "typeProperties": { + "description": "Blob Events Trigger properties.", + "x-ms-client-flatten": true, + "properties": { + "blobPathBeginsWith": { + "description": "The blob path must begin with the pattern provided for trigger to fire. For example, '/records/blobs/december/' will only fire the trigger for blobs in the december folder under the records container. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith.", + "type": "string" + }, + "blobPathEndsWith": { + "description": "The blob path must end with the pattern provided for trigger to fire. For example, 'december/boxes.csv' will only fire the trigger for blobs named boxes in a december folder. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith.", + "type": "string" + }, + "ignoreEmptyBlobs": { + "description": "If set to true, blobs with zero bytes will be ignored.", + "type": "boolean" + }, + "events": { + "description": "The type of events that cause this trigger to fire.", + "$ref": "#/definitions/BlobEventTypes" + }, + "scope": { + "description": "The ARM resource ID of the Storage Account.", + "type": "string" + } + }, + "required": [ + "events", + "scope" + ] + } + }, + "required": [ + "typeProperties" + ] + }, + "BlobEventTypes": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Microsoft.Storage.BlobCreated", + "Microsoft.Storage.BlobDeleted" + ], + "x-ms-enum": { + "name": "BlobEventType", + "modelAsString": true + } + }, + "description": "Blob event types." + }, + "CustomEventsTrigger": { + "description": "Trigger that runs every time a custom event is received.", + "allOf": [ + { + "$ref": "#/definitions/MultiplePipelineTrigger" + } + ], + "properties": { + "typeProperties": { + "description": "Custom Events Trigger properties.", + "x-ms-client-flatten": true, + "properties": { + "subjectBeginsWith": { + "description": "The event subject must begin with the pattern provided for trigger to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith.", + "type": "string" + }, + "subjectEndsWith": { + "description": "The event subject must end with the pattern provided for trigger to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith.", + "type": "string" + }, + "events": { + "description": "The list of event types that cause this trigger to fire.", + "type": "array", + "items": { + "type": "object" + } + }, + "scope": { + "description": "The ARM resource ID of the Azure Event Grid Topic.", + "type": "string" + } + }, + "required": [ + "events", + "scope" + ] + } + }, + "required": [ + "typeProperties" + ] + }, + "TumblingWindowTrigger": { + "description": "Trigger that schedules pipeline runs for all fixed time interval windows from a start time without gaps and also supports backfill scenarios (when start time is in the past).", + "allOf": [ + { + "$ref": "#/definitions/Trigger" + } + ], + "properties": { + "pipeline": { + "$ref": "../artifacts.json#/definitions/TriggerPipelineReference", + "description": "Pipeline for which runs are created when an event is fired for trigger window that is ready." + }, + "typeProperties": { + "description": "Tumbling Window Trigger properties.", + "x-ms-client-flatten": true, + "properties": { + "frequency": { + "$ref": "#/definitions/TumblingWindowFrequency", + "description": "The frequency of the time windows." + }, + "interval": { + "type": "integer", + "format": "int32", + "description": "The interval of the time windows. The minimum interval allowed is 15 Minutes." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported." + }, + "delay": { + "type": "object", + "description": "Specifies how long the trigger waits past due time before triggering new run. It doesn't alter window start and end time. The default is 0. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "maxConcurrency": { + "description": "The max number of parallel time windows (ready for execution) for which a new run is triggered.", + "type": "integer", + "minimum": 1, + "maximum": 50 + }, + "retryPolicy": { + "$ref": "#/definitions/RetryPolicy", + "description": "Retry policy that will be applied for failed pipeline runs." + }, + "dependsOn": { + "type": "array", + "description": "Triggers that this trigger depends on. Only tumbling window triggers are supported.", + "items": { + "$ref": "#/definitions/DependencyReference" + } + } + }, + "required": [ + "frequency", + "interval", + "startTime", + "maxConcurrency" + ] + } + }, + "required": [ + "pipeline", + "typeProperties" + ] + }, + "TumblingWindowFrequency": { + "description": "Enumerates possible frequency option for the tumbling window trigger.", + "type": "string", + "enum": [ + "Minute", + "Hour", + "Month" + ], + "x-ms-enum": { + "name": "TumblingWindowFrequency", + "modelAsString": true + } + }, + "RetryPolicy": { + "description": "Execution policy for an activity.", + "type": "object", + "properties": { + "count": { + "type": "object", + "description": "Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "intervalInSeconds": { + "description": "Interval between retries in seconds. Default is 30.", + "type": "integer", + "minimum": 30, + "maximum": 86400 + } + } + }, + "TriggerReference": { + "description": "Trigger reference type.", + "type": "object", + "properties": { + "type": { + "description": "Trigger reference type.", + "type": "string", + "enum": [ + "TriggerReference" + ], + "x-ms-enum": { + "name": "TriggerReferenceType", + "modelAsString": true + } + }, + "referenceName": { + "description": "Reference trigger name.", + "type": "string" + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "DependencyReference": { + "description": "Referenced dependency.", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "description": "The type of dependency reference.", + "type": "string" + } + }, + "required": [ + "type" + ] + }, + "TriggerDependencyReference": { + "description": "Trigger referenced dependency.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DependencyReference" + } + ], + "properties": { + "referenceTrigger": { + "description": "Referenced trigger.", + "$ref": "#/definitions/TriggerReference" + } + }, + "required": [ + "referenceTrigger" + ] + }, + "TumblingWindowTriggerDependencyReference": { + "description": "Referenced tumbling window trigger dependency.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TriggerDependencyReference" + } + ], + "properties": { + "offset": { + "description": "Timespan applied to the start time of a tumbling window when evaluating dependency.", + "type": "string", + "pattern": "-?((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + }, + "size": { + "description": "The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + } + } + }, + "SelfDependencyTumblingWindowTriggerReference": { + "description": "Self referenced tumbling window trigger dependency.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DependencyReference" + } + ], + "properties": { + "offset": { + "description": "Timespan applied to the start time of a tumbling window when evaluating dependency.", + "type": "string", + "pattern": "-((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + }, + "size": { + "description": "The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used.", + "type": "string", + "pattern": "((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))", + "minLength": 8, + "maxLength": 15 + } + }, + "required": [ + "offset" + ] + }, + "RerunTumblingWindowTrigger": { + "description": "Trigger that schedules pipeline reruns for all fixed time interval windows from a requested start time to requested end time.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Trigger" + } + ], + "properties": { + "typeProperties": { + "description": "Rerun Trigger properties.", + "x-ms-client-flatten": true, + "properties": { + "parentTrigger": { + "type": "object", + "description": "The parent trigger reference." + }, + "requestedStartTime": { + "type": "string", + "format": "date-time", + "description": "The start time for the time period for which restatement is initiated. Only UTC time is currently supported." + }, + "requestedEndTime": { + "type": "string", + "format": "date-time", + "description": "The end time for the time period for which restatement is initiated. Only UTC time is currently supported." + }, + "rerunConcurrency": { + "description": "The max number of parallel time windows (ready for execution) for which a rerun is triggered.", + "type": "integer", + "minimum": 1, + "maximum": 50 + } + }, + "required": [ + "parentTrigger", + "requestedStartTime", + "requestedEndTime", + "rerunConcurrency" + ] + } + }, + "required": [ + "typeProperties" + ] + }, + "ChainingTrigger": { + "description": "Trigger that allows the referenced pipeline to depend on other pipeline runs based on runDimension Name/Value pairs. Upstream pipelines should declare the same runDimension Name and their runs should have the values for those runDimensions. The referenced pipeline run would be triggered if the values for the runDimension match for all upstream pipeline runs.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Trigger" + } + ], + "properties": { + "pipeline": { + "$ref": "../artifacts.json#/definitions/TriggerPipelineReference", + "description": "Pipeline for which runs are created when all upstream pipelines complete successfully." + }, + "typeProperties": { + "description": "Chaining Trigger properties.", + "x-ms-client-flatten": true, + "properties": { + "dependsOn": { + "type": "array", + "items": { + "$ref": "../artifacts.json#/definitions/PipelineReference" + }, + "description": "Upstream Pipelines." + }, + "runDimension": { + "description": "Run Dimension property that needs to be emitted by upstream pipelines.", + "type": "string" + } + }, + "required": [ + "runDimension", + "dependsOn" + ] + } + }, + "required": [ + "pipeline", + "typeProperties" + ] + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/ActivityRuns_QueryByPipelineRun.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/ActivityRuns_QueryByPipelineRun.json new file mode 100644 index 000000000000..c83ce0fe1ac6 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/ActivityRuns_QueryByPipelineRun.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "pipelineName": "examplePipeline", + "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b", + "filterParameters": { + "lastUpdatedAfter": "2018-06-16T00:36:44.3345758Z", + "lastUpdatedBefore": "2018-06-16T00:49:48.3686473Z" + }, + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:13 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1187", + "x-ms-request-id": "5465cf41-2e71-4ce6-8db4-9de1b92ffda9", + "x-ms-correlation-request-id": "5465cf41-2e71-4ce6-8db4-9de1b92ffda9" + }, + "body": { + "value": [ + { + "activityRunEnd": "2018-06-16T00:38:11.5445431Z", + "activityName": "ExampleForeachActivity", + "activityRunStart": "2018-06-16T00:37:49.4804925Z", + "activityType": "ForEach", + "durationInMs": 22064, + "retryAttempt": null, + "error": { + "errorCode": "", + "message": "", + "failureType": "", + "target": "ExampleForeachActivity" + }, + "activityRunId": "f30c5514-fb85-43ed-9fa4-768d42e58680", + "input": {}, + "linkedServiceName": "", + "output": {}, + "userProperties": {}, + "pipelineName": "examplePipeline", + "pipelineRunId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b", + "status": "Succeeded" + }, + { + "activityRunEnd": "2018-06-16T00:38:07.4188923Z", + "activityName": "ExampleCopyActivity", + "activityRunStart": "2018-06-16T00:37:50.2460952Z", + "activityType": "Copy", + "durationInMs": 17172, + "retryAttempt": null, + "error": { + "errorCode": "", + "message": "", + "failureType": "", + "target": "ExampleCopyActivity" + }, + "activityRunId": "a96678c8-7167-4f00-b629-afccfbad4e51", + "input": { + "source": { + "type": "BlobSource" + }, + "sink": { + "type": "BlobSink" + }, + "dataIntegrationUnits": 32 + }, + "linkedServiceName": "", + "output": { + "dataRead": 142000, + "dataWritten": 142000, + "filesRead": 1, + "filesWritten": 1, + "copyDuration": 6, + "throughput": 23.112, + "errors": [], + "effectiveIntegrationRuntime": "DefaultIntegrationRuntime (East US)", + "usedCloudDataMovementUnits": 4, + "usedParallelCopies": 1, + "executionDetails": [ + { + "source": { + "type": "AzureBlob" + }, + "sink": { + "type": "AzureBlob" + }, + "status": "Succeeded", + "start": "2018-06-16T00:37:50.68834Z", + "duration": 6, + "usedCloudDataMovementUnits": 4, + "usedParallelCopies": 1, + "detailedDurations": { + "queuingDuration": 4, + "transferDuration": 2 + } + } + ] + }, + "userProperties": {}, + "pipelineName": "examplePipeline", + "pipelineRunId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b", + "status": "Succeeded" + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/BigDataPools_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/BigDataPools_Get.json new file mode 100644 index 000000000000..0d0ec7a8db76 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/BigDataPools_Get.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "bigDataPoolName": "pool1", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "creationDate": "2020-07-14T10:09:52.5133333Z", + "sparkVersion": "2.4", + "nodeCount": 3, + "nodeSize": "Small", + "nodeSizeFamily": "MemoryOptimized", + "autoScale": { + "enabled": true, + "minNodeCount": 3, + "maxNodeCount": 20 + }, + "autoPause": { + "enabled": true, + "delayInMinutes": 15 + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Synapse/workspaces/exampleWorkspace/sparkComputes/pool1", + "name": "pool1", + "type": "Microsoft.Synapse/workspaces/sparkComputes", + "location": "southeastasia", + "tags": {} + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/BigDataPools_List.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/BigDataPools_List.json new file mode 100644 index 000000000000..6c7f5e83d937 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/BigDataPools_List.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "creationDate": "2020-07-14T10:09:52.5133333Z", + "sparkVersion": "2.4", + "nodeCount": 3, + "nodeSize": "Small", + "nodeSizeFamily": "MemoryOptimized", + "autoScale": { + "enabled": true, + "minNodeCount": 3, + "maxNodeCount": 20 + }, + "autoPause": { + "enabled": true, + "delayInMinutes": 15 + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Synapse/workspaces/exampleWorkspace/sparkComputes/pool1", + "name": "pool1", + "type": "Microsoft.Synapse/workspaces/sparkComputes", + "location": "southeastasia", + "tags": {} + } + ] + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/CheckAccessSynapseRbac.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/CheckAccessSynapseRbac.json new file mode 100644 index 000000000000..89c0ff5c46ff --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/CheckAccessSynapseRbac.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01", + "request": { + "subject": { + "principalId": "00000000-0000-0000-0000-000000000000", + "groupIds": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000000" + ] + }, + "scope": "workspaces/exampleWorkspace", + "actions": [ + { + "id": "Action 1", + "isDataAction": true + }, + { + "id": "Action 2", + "isDataAction": true + } + ] + } + }, + "responses": { + "200": { + "body": { + "accessDecisions": [ + { + "accessDecision": "Allowed || NotAllowed", + "actionId": "Action 1", + "roleAssignment": { + "id": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000", + "scope": "workspaces/exampleWorkspace", + "principalType": "User || Group || ServicePrincipal" + } + }, + { + "accessDecision": "Allowed || NotAllowed", + "actionId": "Action 1", + "roleAssignment": { + "id": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000", + "scope": "workspaces/exampleWorkspace", + "principalType": "User || Group || ServicePrincipal" + } + } + ] + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/CreateManagedPrivateEndpoint.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/CreateManagedPrivateEndpoint.json new file mode 100644 index 000000000000..a78dde020bb1 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/CreateManagedPrivateEndpoint.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01", + "managedVirtualNetworkName": "default", + "managedPrivateEndpointName": "myPrivateEndpoint", + "managedPrivateEndpoint": { + "properties": { + "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Storage/accounts/myStorageAccount", + "groupId": "blob" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.Synapse/workspaces/managedVirtualNetworks/managedPrivateEndpoints", + "name": "myPrivateEndpoint", + "properties": { + "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Storage/accounts/myStorageAccount", + "groupId": "blob", + "provisioningState": "Provisioning", + "connectionState": { + "status": "Pending", + "description": "", + "actionsRequired": "" + } + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlowDebugSession_AddDataFlow.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlowDebugSession_AddDataFlow.json new file mode 100644 index 000000000000..8c5d913cd2b2 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlowDebugSession_AddDataFlow.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "request": { + "dataFlow": { + "name": "dataflow1", + "properties": { + "type": "MappingDataFlow", + "typeProperties": { + "sources": [ + { + "dataset": { + "referenceName": "DelimitedText2", + "type": "DatasetReference" + }, + "name": "source1" + } + ], + "sinks": [], + "transformations": [], + "script": "\n\nsource(output(\n\t\tColumn_1 as string\n\t),\n\tallowSchemaDrift: true,\n\tvalidateSchema: false) ~> source1" + } + } + }, + "datasets": [ + { + "name": "dataset1", + "properties": { + "linkedServiceName": { + "referenceName": "linkedService5", + "type": "LinkedServiceReference" + }, + "annotations": [], + "type": "DelimitedText", + "typeProperties": { + "location": { + "type": "AzureBlobStorageLocation", + "fileName": "Ansiencoding.csv", + "container": "dataflow-sample-data" + }, + "columnDelimiter": ",", + "escapeChar": "\\", + "firstRowAsHeader": true, + "quoteChar": "\"" + }, + "schema": [ + { + "type": "String" + } + ] + } + } + ], + "linkedServices": [ + { + "name": "linkedService1", + "properties": { + "type": "AzureBlobStorage", + "typeProperties": { + "connectionString": "DefaultEndpointsProtocol=https;AccountName=;EndpointSuffix=core.windows.net;", + "encryptedCredential": "" + }, + "annotations": [] + } + } + ], + "debugSettings": { + "sourceSettings": [ + { + "sourceName": "source1", + "rowLimit": 1000 + }, + { + "sourceName": "source2", + "rowLimit": 222 + } + ], + "parameters": { + "sourcePath": "Toy" + }, + "datasetParameters": { + "Movies": { + "path": "abc" + }, + "Output": { + "time": "def" + } + } + }, + "sessionId": "f06ed247-9d07-49b2-b05e-2cb4a2fc871e" + }, + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:01 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14989", + "x-ms-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd", + "x-ms-correlation-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd" + }, + "body": { + "jobVersion": "e5328ee7-c524-4207-8ba4-b709010db33d" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlowDebugSession_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlowDebugSession_Create.json new file mode 100644 index 000000000000..8945f99f3520 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlowDebugSession_Create.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "request": { + "dataFlowName": "dataflow", + "existingClusterId": "1221221", + "clusterTimeout": 50, + "newClusterName": "newClusterName", + "newClusterNodeType": "newClusterNodeType", + "dataBricksLinkedService": { + "properties": { + "type": "AzureStorage", + "typeProperties": { + "connectionString": { + "type": "SecureString", + "value": "DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=" + } + }, + "description": "Example description" + } + } + }, + "api-version": "2020-12-01" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:01 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14989", + "x-ms-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd", + "x-ms-correlation-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd", + "location": "https://exampleWorkspaceName.dev.azuresynapse.net/operationStatuses/dfCreateSession$$229c688c-944c-44ac-b31a-82d50f347154?api-version=2019-06-01-preview" + } + }, + "200": { + "body": { + "sessionId": "229c688c-944c-44ac-b31a-82d50f347154" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlowDebugSession_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlowDebugSession_Delete.json new file mode 100644 index 000000000000..a4a92732db06 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlowDebugSession_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "request": { + "sessionId": "91fb57e0-8292-47be-89ff-c8f2d2bb2a7e" + }, + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:01 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14989", + "x-ms-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd", + "x-ms-correlation-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlowDebugSession_ExecuteCommand.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlowDebugSession_ExecuteCommand.json new file mode 100644 index 000000000000..870e2fecca8f --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlowDebugSession_ExecuteCommand.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "request": { + "dataFlowName": "dataFlowName", + "commandPayload": { + "streamName": "source1", + "rowLimits": 100 + }, + "commandName": "executePreviewQuery", + "sessionId": "f06ed247-9d07-49b2-b05e-2cb4a2fc871e" + }, + "api-version": "2020-12-01" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:01 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14989", + "x-ms-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd", + "x-ms-correlation-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd", + "location": "https://exampleWorkspaceName.dev.azuresynapse.net/operationResults/dfCommandOutput$$f06ed247-9d07-49b2-b05e-2cb4a2fc871e$$e5328ee7-c524-4207-8ba4-b709010db33d$$ace5eaf0-3e93-45ba-ada3-bf77da321a7b?api-version=2019-06-01-preview" + } + }, + "200": { + "body": { + "status": "Succeeded", + "data": "some output" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlowDebugSession_QueryByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlowDebugSession_QueryByWorkspace.json new file mode 100644 index 000000000000..52035165e2e6 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlowDebugSession_QueryByWorkspace.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:01 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14989", + "x-ms-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd", + "x-ms-correlation-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd" + }, + "body": { + "value": [ + { + "userObjectId": "0a7e0d6e-f2b7-48cc-8cd8-618326f5662f", + "startTime": "2019-09-05T18:23:20.3257799+00:00", + "lastActivityTime": "2019-09-05T18:28:00.9459674+00:00", + "dataflowName": "DebugSession-0a7e0d6e-f2b7-48cc-8cd8-618326f5662f", + "sessionId": "229c688c-944c-44ac-b31a-82d50f347154", + "coreCount": 48, + "computeType": "General", + "timeToLiveInMinutes": 60 + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlows_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlows_Create.json new file mode 100644 index 000000000000..e8cc5bc62f0e --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlows_Create.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "dataFlowName": "exampleDataFlow", + "ifMatch": null, + "dataFlow": { + "properties": { + "description": "Sample demo data flow to convert currencies showing usage of union, derive and conditional split transformation.", + "type": "MappingDataFlow", + "typeProperties": { + "sources": [ + { + "dataset": { + "referenceName": "CurrencyDatasetUSD", + "type": "DatasetReference" + }, + "name": "USDCurrency" + }, + { + "dataset": { + "referenceName": "CurrencyDatasetCAD", + "type": "DatasetReference" + }, + "name": "CADSource" + } + ], + "sinks": [ + { + "dataset": { + "referenceName": "USDOutput", + "type": "DatasetReference" + }, + "name": "USDSink" + }, + { + "dataset": { + "referenceName": "CADOutput", + "type": "DatasetReference" + }, + "name": "CADSink" + } + ], + "script": "source(output(PreviousConversionRate as double,Country as string,DateTime1 as string,CurrentConversionRate as double),allowSchemaDrift: false,validateSchema: false) ~> USDCurrency\nsource(output(PreviousConversionRate as double,Country as string,DateTime1 as string,CurrentConversionRate as double),allowSchemaDrift: true,validateSchema: false) ~> CADSource\nUSDCurrency, CADSource union(byName: true)~> Union\nUnion derive(NewCurrencyRate = round(CurrentConversionRate*1.25)) ~> NewCurrencyColumn\nNewCurrencyColumn split(Country == 'USD',Country == 'CAD',disjoint: false) ~> ConditionalSplit1@(USD, CAD)\nConditionalSplit1@USD sink(saveMode:'overwrite' ) ~> USDSink\nConditionalSplit1@CAD sink(saveMode:'overwrite' ) ~> CADSink" + } + } + }, + "api-version": "2020-12-01" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2019 00:37:38 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1194", + "x-ms-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0", + "x-ms-correlation-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0" + } + }, + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/datasets/exampleDataset", + "name": "exampleDataFlow", + "type": "Microsoft.Synapse/workspaces/dataflows", + "properties": { + "description": "Sample demo data flow to convert currencies showing usage of union, derive and conditional split transformation.", + "type": "MappingDataFlow", + "typeProperties": { + "sources": [ + { + "dataset": { + "referenceName": "CurrencyDatasetUSD", + "type": "DatasetReference" + }, + "name": "USDCurrency" + }, + { + "dataset": { + "referenceName": "CurrencyDatasetCAD", + "type": "DatasetReference" + }, + "name": "CADSource" + } + ], + "sinks": [ + { + "dataset": { + "referenceName": "USDOutput", + "type": "DatasetReference" + }, + "name": "USDSink" + }, + { + "dataset": { + "referenceName": "CADOutput", + "type": "DatasetReference" + }, + "name": "CADSink" + } + ], + "script": "source(output(PreviousConversionRate as double,Country as string,DateTime1 as string,CurrentConversionRate as double),allowSchemaDrift: false,validateSchema: false) ~> USDCurrency\nsource(output(PreviousConversionRate as double,Country as string,DateTime1 as string,CurrentConversionRate as double),allowSchemaDrift: true,validateSchema: false) ~> CADSource\nUSDCurrency, CADSource union(byName: true)~> Union\nUnion derive(NewCurrencyRate = round(CurrentConversionRate*1.25)) ~> NewCurrencyColumn\nNewCurrencyColumn split(Country == 'USD',Country == 'CAD',disjoint: false) ~> ConditionalSplit1@(USD, CAD)\nConditionalSplit1@USD sink(saveMode:'overwrite' ) ~> USDSink\nConditionalSplit1@CAD sink(saveMode:'overwrite' ) ~> CADSink" + } + }, + "etag": "0a0066d4-0000-0000-0000-5b245bd20000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlows_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlows_Delete.json new file mode 100644 index 000000000000..cec1d0f1ac8a --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlows_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "dataFlowName": "exampleDataFlow", + "api-version": "2020-12-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlows_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlows_Get.json new file mode 100644 index 000000000000..c2bd9d6e9818 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlows_Get.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "dataFlowName": "exampleDataFlow", + "ifNoneMatch": "15004c4f-0000-0200-0000-5cbe090e0000", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Mon, 22 Apr 2019 18:33:50 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "11993", + "x-ms-request-id": "48983fb5-612a-44c6-8158-add7ffebb32b", + "x-ms-correlation-request-id": "48983fb5-612a-44c6-8158-add7ffebb32b" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/dataflows/exampleDataFlow", + "name": "exampleDataFlow", + "type": "Microsoft.Synapse/workspaces/dataflows", + "properties": { + "description": "Sample demo data flow to convert currencies showing usage of union, derive and conditional split transformation.", + "type": "MappingDataFlow", + "typeProperties": { + "sources": [ + { + "dataset": { + "referenceName": "CurrencyDatasetUSD", + "type": "DatasetReference" + }, + "name": "USDCurrency" + }, + { + "dataset": { + "referenceName": "CurrencyDatasetCAD", + "type": "DatasetReference" + }, + "name": "CADSource" + } + ], + "sinks": [ + { + "dataset": { + "referenceName": "USDOutput", + "type": "DatasetReference" + }, + "name": "USDSink" + }, + { + "dataset": { + "referenceName": "CADOutput", + "type": "DatasetReference" + }, + "name": "CADSink" + } + ], + "script": "source(output(PreviousConversionRate as double,Country as string,DateTime1 as string,CurrentConversionRate as double),allowSchemaDrift: false,validateSchema: false) ~> USDCurrency\nsource(output(PreviousConversionRate as double,Country as string,DateTime1 as string,CurrentConversionRate as double),allowSchemaDrift: true,validateSchema: false) ~> CADSource\nUSDCurrency, CADSource union(byName: true)~> Union\nUnion derive(NewCurrencyRate = round(CurrentConversionRate*1.25)) ~> NewCurrencyColumn\nNewCurrencyColumn split(Country == 'USD',Country == 'CAD',disjoint: false) ~> ConditionalSplit1@(USD, CAD)\nConditionalSplit1@USD sink(saveMode:'overwrite' ) ~> USDSink\nConditionalSplit1@CAD sink(saveMode:'overwrite' ) ~> CADSink" + } + }, + "etag": "15004c4f-0000-0200-0000-5cbe090e0000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlows_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlows_ListByWorkspace.json new file mode 100644 index 000000000000..2cb93718f130 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlows_ListByWorkspace.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:40 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14992", + "x-ms-request-id": "341c9ece-5062-448b-be98-3ccbf476ed5d", + "x-ms-correlation-request-id": "341c9ece-5062-448b-be98-3ccbf476ed5d" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/dataflows/exampleDataFlow", + "name": "exampleDataFlow", + "type": "Microsoft.Synapse/workspaces/dataflows", + "properties": { + "description": "Sample demo data flow to convert currencies showing usage of union, derive and conditional split transformation.", + "type": "MappingDataFlow", + "typeProperties": { + "sources": [ + { + "dataset": { + "referenceName": "CurrencyDatasetUSD", + "type": "DatasetReference" + }, + "name": "USDCurrency" + }, + { + "dataset": { + "referenceName": "CurrencyDatasetCAD", + "type": "DatasetReference" + }, + "name": "CADSource" + } + ], + "sinks": [ + { + "dataset": { + "referenceName": "USDOutput", + "type": "DatasetReference" + }, + "name": "USDSink" + }, + { + "dataset": { + "referenceName": "CADOutput", + "type": "DatasetReference" + }, + "name": "CADSink" + } + ], + "script": "source(output(PreviousConversionRate as double,Country as string,DateTime1 as string,CurrentConversionRate as double),allowSchemaDrift: false,validateSchema: false) ~> USDCurrency\nsource(output(PreviousConversionRate as double,Country as string,DateTime1 as string,CurrentConversionRate as double),allowSchemaDrift: true,validateSchema: false) ~> CADSource\nUSDCurrency, CADSource union(byName: true)~> Union\nUnion derive(NewCurrencyRate = round(CurrentConversionRate*1.25)) ~> NewCurrencyColumn\nNewCurrencyColumn split(Country == 'USD',Country == 'CAD',disjoint: false) ~> ConditionalSplit1@(USD, CAD)\nConditionalSplit1@USD sink(saveMode:'overwrite' ) ~> USDSink\nConditionalSplit1@CAD sink(saveMode:'overwrite' ) ~> CADSink" + } + }, + "etag": "0a0068d4-0000-0000-0000-5b245bd30000" + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlows_Rename.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlows_Rename.json new file mode 100644 index 000000000000..41f113fc7b6c --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlows_Rename.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "dataFlowName": "exampleDataFlow", + "api-version": "2020-12-01", + "request": { + "newName": "newdataflow" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlows_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlows_Update.json new file mode 100644 index 000000000000..558b13ad4d1c --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlows_Update.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "dataFlowName": "exampleDataFlow", + "ifMatch": null, + "dataFlow": { + "properties": { + "description": "Sample demo data flow to convert currencies showing usage of union, derive and conditional split transformation.", + "type": "MappingDataFlow", + "typeProperties": { + "sources": [ + { + "dataset": { + "referenceName": "CurrencyDatasetUSD", + "type": "DatasetReference" + }, + "name": "USDCurrency" + }, + { + "dataset": { + "referenceName": "CurrencyDatasetCAD", + "type": "DatasetReference" + }, + "name": "CADSource" + } + ], + "sinks": [ + { + "dataset": { + "referenceName": "USDOutput", + "type": "DatasetReference" + }, + "name": "USDSink" + }, + { + "dataset": { + "referenceName": "CADOutput", + "type": "DatasetReference" + }, + "name": "CADSink" + } + ], + "script": "source(output(PreviousConversionRate as double,Country as string,DateTime1 as string,CurrentConversionRate as double),allowSchemaDrift: false,validateSchema: false) ~> USDCurrency\nsource(output(PreviousConversionRate as double,Country as string,DateTime1 as string,CurrentConversionRate as double),allowSchemaDrift: true,validateSchema: false) ~> CADSource\nUSDCurrency, CADSource union(byName: true)~> Union\nUnion derive(NewCurrencyRate = round(CurrentConversionRate*1.25)) ~> NewCurrencyColumn\nNewCurrencyColumn split(Country == 'USD',Country == 'CAD',disjoint: false) ~> ConditionalSplit1@(USD, CAD)\nConditionalSplit1@USD sink(saveMode:'overwrite' ) ~> USDSink\nConditionalSplit1@CAD sink(saveMode:'overwrite' ) ~> CADSink" + } + } + }, + "api-version": "2020-12-01" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2019 00:37:38 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1193", + "x-ms-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0", + "x-ms-correlation-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0" + } + }, + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/datasets/exampleDataset", + "name": "exampleDataFlow", + "type": "Microsoft.Synapse/workspaces/dataflows", + "properties": { + "description": "Sample demo data flow to convert currencies showing usage of union, derive and conditional split transformation.", + "type": "MappingDataFlow", + "typeProperties": { + "sources": [ + { + "dataset": { + "referenceName": "CurrencyDatasetUSD", + "type": "DatasetReference" + }, + "name": "USDCurrency" + }, + { + "dataset": { + "referenceName": "CurrencyDatasetCAD", + "type": "DatasetReference" + }, + "name": "CADSource" + } + ], + "sinks": [ + { + "dataset": { + "referenceName": "USDOutput", + "type": "DatasetReference" + }, + "name": "USDSink" + }, + { + "dataset": { + "referenceName": "CADOutput", + "type": "DatasetReference" + }, + "name": "CADSink" + } + ], + "script": "source(output(PreviousConversionRate as double,Country as string,DateTime1 as string,CurrentConversionRate as double),allowSchemaDrift: false,validateSchema: false) ~> USDCurrency\nsource(output(PreviousConversionRate as double,Country as string,DateTime1 as string,CurrentConversionRate as double),allowSchemaDrift: true,validateSchema: false) ~> CADSource\nUSDCurrency, CADSource union(byName: true)~> Union\nUnion derive(NewCurrencyRate = round(CurrentConversionRate*1.25)) ~> NewCurrencyColumn\nNewCurrencyColumn split(Country == 'USD',Country == 'CAD',disjoint: false) ~> ConditionalSplit1@(USD, CAD)\nConditionalSplit1@USD sink(saveMode:'overwrite' ) ~> USDSink\nConditionalSplit1@CAD sink(saveMode:'overwrite' ) ~> CADSink" + } + }, + "etag": "0a0068d4-0000-0000-0000-5b245bd30002" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Datasets_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Datasets_Create.json new file mode 100644 index 000000000000..becff8cd561c --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Datasets_Create.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "datasetName": "exampleDataset", + "ifMatch": null, + "dataset": { + "properties": { + "type": "AzureBlob", + "typeProperties": { + "folderPath": { + "value": "@dataset().MyFolderPath", + "type": "Expression" + }, + "fileName": { + "value": "@dataset().MyFileName", + "type": "Expression" + }, + "format": { + "type": "TextFormat" + } + }, + "linkedServiceName": { + "referenceName": "exampleLinkedService", + "type": "LinkedServiceReference" + }, + "parameters": { + "MyFolderPath": { + "type": "String" + }, + "MyFileName": { + "type": "String" + } + } + } + }, + "api-version": "2020-12-01" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:38 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1194", + "x-ms-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0", + "x-ms-correlation-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0" + } + }, + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/datasets/exampleDataset", + "name": "exampleDataset", + "type": "Microsoft.Synapse/workspaces/datasets", + "properties": { + "type": "AzureBlob", + "schema": [ + { + "name": "col1", + "type": "INT_32" + }, + { + "name": "col2", + "type": "Decimal", + "precision": "38", + "scale": "2" + } + ], + "typeProperties": { + "folderPath": { + "value": "@dataset().MyFolderPath", + "type": "Expression" + }, + "fileName": { + "value": "@dataset().MyFileName", + "type": "Expression" + }, + "format": { + "type": "TextFormat" + } + }, + "linkedServiceName": { + "referenceName": "exampleLinkedService", + "type": "LinkedServiceReference" + }, + "parameters": { + "MyFolderPath": { + "type": "String" + }, + "MyFileName": { + "type": "String" + } + } + }, + "etag": "0a0066d4-0000-0000-0000-5b245bd20000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Datasets_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Datasets_Delete.json new file mode 100644 index 000000000000..f84ce4baf9df --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Datasets_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "datasetName": "exampleDataset", + "api-version": "2020-12-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Datasets_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Datasets_Get.json new file mode 100644 index 000000000000..5bf2024779a2 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Datasets_Get.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "datasetName": "exampleDataset", + "ifNoneMatch": "15004c4f-0000-0200-0000-5cbe090e0000", + "api-version": "2020-12-01" + }, + "responses": { + "304": {}, + "200": { + "headers": { + "Date": "Mon, 22 Apr 2019 18:33:50 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "11993", + "x-ms-request-id": "48983fb5-612a-44c6-8158-add7ffebb32b", + "x-ms-correlation-request-id": "48983fb5-612a-44c6-8158-add7ffebb32b" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/datasets/exampleDataset", + "name": "exampleDataset", + "type": "Microsoft.Synapse/workspaces/datasets", + "properties": { + "type": "AzureBlob", + "typeProperties": { + "folderPath": { + "value": "@dataset().MyFolderPath", + "type": "Expression" + }, + "fileName": { + "value": "@dataset().MyFileName", + "type": "Expression" + }, + "format": { + "type": "TextFormat" + } + }, + "description": "Example description", + "linkedServiceName": { + "referenceName": "exampleLinkedService", + "type": "LinkedServiceReference" + }, + "parameters": { + "MyFolderPath": { + "type": "String" + }, + "MyFileName": { + "type": "String" + } + } + }, + "etag": "15004c4f-0000-0200-0000-5cbe090e0000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Datasets_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Datasets_ListByWorkspace.json new file mode 100644 index 000000000000..53e35ff9777b --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Datasets_ListByWorkspace.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:40 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14992", + "x-ms-request-id": "341c9ece-5062-448b-be98-3ccbf476ed5d", + "x-ms-correlation-request-id": "341c9ece-5062-448b-be98-3ccbf476ed5d" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/datasets/exampleDataset", + "name": "exampleDataset", + "type": "Microsoft.Synapse/workspaces/datasets", + "properties": { + "type": "AzureBlob", + "typeProperties": { + "folderPath": { + "value": "@dataset().MyFolderPath", + "type": "Expression" + }, + "fileName": { + "value": "@dataset().MyFileName", + "type": "Expression" + }, + "format": { + "type": "TextFormat" + } + }, + "description": "Example description", + "linkedServiceName": { + "referenceName": "exampleLinkedService", + "type": "LinkedServiceReference" + }, + "parameters": { + "MyFolderPath": { + "type": "String" + }, + "MyFileName": { + "type": "String" + } + } + }, + "etag": "0a0068d4-0000-0000-0000-5b245bd30000" + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Datasets_Rename.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Datasets_Rename.json new file mode 100644 index 000000000000..35fa87d6b96a --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Datasets_Rename.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "datasetName": "exampleDataset", + "api-version": "2020-12-01", + "request": { + "newName": "newdataset" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Datasets_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Datasets_Update.json new file mode 100644 index 000000000000..6999f6b5e784 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Datasets_Update.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "datasetName": "exampleDataset", + "ifMatch": null, + "dataset": { + "properties": { + "type": "AzureBlob", + "typeProperties": { + "folderPath": { + "value": "@dataset().MyFolderPath", + "type": "Expression" + }, + "fileName": { + "value": "@dataset().MyFileName", + "type": "Expression" + }, + "format": { + "type": "TextFormat" + } + }, + "description": "Example description", + "linkedServiceName": { + "referenceName": "exampleLinkedService", + "type": "LinkedServiceReference" + }, + "parameters": { + "MyFolderPath": { + "type": "String" + }, + "MyFileName": { + "type": "String" + } + } + } + }, + "api-version": "2020-12-01" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:39 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1193", + "x-ms-request-id": "e2e7f6be-e7ee-4aae-943f-6ff799e034f2", + "x-ms-correlation-request-id": "e2e7f6be-e7ee-4aae-943f-6ff799e034f2" + } + }, + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/datasets/exampleDataset", + "name": "exampleDataset", + "type": "Microsoft.Synapse/workspaces/datasets", + "properties": { + "type": "AzureBlob", + "typeProperties": { + "folderPath": { + "value": "@dataset().MyFolderPath", + "type": "Expression" + }, + "fileName": { + "value": "@dataset().MyFileName", + "type": "Expression" + }, + "format": { + "type": "TextFormat" + } + }, + "description": "Example description", + "linkedServiceName": { + "referenceName": "exampleLinkedService", + "type": "LinkedServiceReference" + }, + "parameters": { + "MyFolderPath": { + "type": "String" + }, + "MyFileName": { + "type": "String" + } + } + }, + "etag": "0a0068d4-0000-0000-0000-5b245bd30000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DeleteManagedPrivateEndpoint.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DeleteManagedPrivateEndpoint.json new file mode 100644 index 000000000000..9e4657b074de --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DeleteManagedPrivateEndpoint.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01", + "managedVirtualNetworkName": "default", + "managedPrivateEndpointName": "myPrivateEndpoint" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/GetManagedPrivateEndpoint.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/GetManagedPrivateEndpoint.json new file mode 100644 index 000000000000..53bd938a42ad --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/GetManagedPrivateEndpoint.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01", + "managedVirtualNetworkName": "default", + "managedPrivateEndpointName": "myPrivateEndpoint" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.Synapse/workspaces/managedVirtualNetworks/managedPrivateEndpoints", + "name": "myPrivateEndpoint", + "properties": { + "name": "myPrivateEndpoint", + "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Storage/accounts/myStorageAccount", + "groupId": "blob", + "provisioningState": "Succeeded", + "connectionState": { + "status": "Approved", + "description": "", + "actionsRequired": "" + }, + "fqdns": [ + "[hostname1].[domain].[tld]", + "[hostname2].[domain].[tld]" + ], + "isCompliant": true + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/IntegrationRuntimes_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/IntegrationRuntimes_Get.json new file mode 100644 index 000000000000..e7d3756573dd --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/IntegrationRuntimes_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "integrationRuntimeName": "IntegrationRuntime1", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Synapse/workspaces/exampleWorkspace/integrationruntimes/IntegrationRuntime1", + "name": "IntegrationRuntime1", + "type": "Microsoft.Synapse/workspaces/integrationruntimes", + "properties": { + "type": "Managed", + "typeProperties": { + "computeProperties": { + "location": "Australia Southeast", + "dataFlowProperties": { + "computeType": "General", + "coreCount": 8, + "timeToLive": 0 + } + } + } + }, + "etag": "00000000-0000-0000-0000-000000000000" + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/IntegrationRuntimes_List.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/IntegrationRuntimes_List.json new file mode 100644 index 000000000000..3637e9702d99 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/IntegrationRuntimes_List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspace/integrationruntimes/exampleIntegrationRuntime", + "name": "exampleIntegrationRuntime", + "type": "Microsoft.Synapse/workspaces/integrationruntimes", + "properties": { + "type": "SelfHosted", + "description": "A selfhosted integration runtime" + }, + "etag": "0400f1a1-0000-0000-0000-5b2188640000" + } + ] + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Library_Append.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Library_Append.json new file mode 100644 index 000000000000..75ebd395ed51 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Library_Append.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "libraryName": "exampleLibraryName.jar", + "comp": "appendblock", + "api-version": "2020-12-01", + "content": "file binary chunk", + "x-ms-blob-condition-appendpos": 12324 + }, + "responses": { + "201": { + "headers": { + "Date": "Fri, 23 Oct 2020 08:28:16 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Library_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Library_Create.json new file mode 100644 index 000000000000..e16318ba2a95 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Library_Create.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "libraryName": "exampleLibraryName.jar", + "api-version": "2020-12-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Date": "Fri, 23 Oct 2020 08:28:16 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/libraries/exampleLibraryName.jar", + "recordId": 1234, + "state": "Creating", + "created": "2020-10-23T07:59:29.1573546+00:00", + "changed": "2020-10-23T07:59:29.1573546+00:00", + "type": "LibraryArtifact", + "name": "exampleLibraryName.jar", + "operationId": "1500474f-0000-0200-0000-5cbe090d0000", + "artifactId": "2222222e-222d-222f-2222-22a2f222d2f2" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Library_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Library_Delete.json new file mode 100644 index 000000000000..00b3e4ed2227 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Library_Delete.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "libraryName": "exampleLibraryName.jar", + "api-version": "2020-12-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Date": "Fri, 23 Oct 2020 08:28:16 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/libraries/exampleLibraryName.jar", + "recordId": 1234, + "state": "Creating", + "created": "2020-10-23T07:59:29.1573546+00:00", + "changed": "2020-10-23T07:59:29.1573546+00:00", + "type": "LibraryArtifact", + "name": "exampleLibraryName.jar", + "operationId": "1500474f-0000-0200-0000-5cbe090d0000", + "artifactId": "2222222e-222d-222f-2222-22a2f222d2f2" + } + }, + "409": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Library_Flush.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Library_Flush.json new file mode 100644 index 000000000000..e16318ba2a95 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Library_Flush.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "libraryName": "exampleLibraryName.jar", + "api-version": "2020-12-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Date": "Fri, 23 Oct 2020 08:28:16 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/libraries/exampleLibraryName.jar", + "recordId": 1234, + "state": "Creating", + "created": "2020-10-23T07:59:29.1573546+00:00", + "changed": "2020-10-23T07:59:29.1573546+00:00", + "type": "LibraryArtifact", + "name": "exampleLibraryName.jar", + "operationId": "1500474f-0000-0200-0000-5cbe090d0000", + "artifactId": "2222222e-222d-222f-2222-22a2f222d2f2" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Library_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Library_Get.json new file mode 100644 index 000000000000..da18b39b79c7 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Library_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "libraryName": "exampleLibraryName.jar", + "ifNoneMatch": "1500474f-0000-0200-0000-5cbe090d0000", + "api-version": "2020-12-01" + }, + "responses": { + "304": {}, + "200": { + "headers": { + "Date": "Fri, 23 Oct 2020 08:28:16 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "11995", + "x-ms-request-id": "99e5d0d9-55e6-45a0-8bd2-cf39210f317c", + "x-ms-correlation-request-id": "99e5d0d9-55e6-45a0-8bd2-cf39210f317c" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/libraries/exampleLibraryName.jar", + "name": "exampleLibraryName.jar", + "type": "Microsoft.Synapse/workspaces/libraries", + "properties": { + "name": "exampleLibraryName.jar", + "path": "exampleWorkspace/libraries/exampleLibraryName.jar", + "containerName": "exampleContainer", + "type": "jar", + "uploadedTimestamp": "2020-10-23T07:59:29.1573546+00:00", + "provisioningStatus": "Succeeded", + "creatorId": "2222222e-222d-222f-2222-22a2f222d2f2" + }, + "etag": "1500474f-0000-0200-0000-5cbe090d0000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Library_GetOperationResult.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Library_GetOperationResult.json new file mode 100644 index 000000000000..183e17bcdc2f --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Library_GetOperationResult.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "operationId": "exampleOperationId", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Fri, 23 Oct 2020 08:28:16 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/libraries/exampleLibraryName.jar", + "name": "exampleLibraryName.jar", + "type": "Microsoft.Synapse/workspaces/libraries", + "properties": { + "name": "exampleLibraryName.jar", + "path": "exampleWorkspace/libraries/exampleLibraryName.jar", + "containerName": "exampleContainer", + "type": "jar", + "uploadedTimestamp": "2020-10-23T07:59:29.1573546+00:00", + "provisioningStatus": "Succeeded", + "creatorId": "2222222e-222d-222f-2222-22a2f222d2f2" + }, + "etag": "1500474f-0000-0200-0000-5cbe090d0000" + } + }, + "202": { + "headers": { + "Date": "Fri, 23 Oct 2020 08:28:16 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "status": "InProgress" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Library_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Library_ListByWorkspace.json new file mode 100644 index 000000000000..e4a6e0ecc31a --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Library_ListByWorkspace.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:36 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14994", + "x-ms-request-id": "558d0fd8-dc1f-44b6-9ca9-59fcca8af9a5", + "x-ms-correlation-request-id": "558d0fd8-dc1f-44b6-9ca9-59fcca8af9a5" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/libraries/exampleLibraryName.jar", + "name": "exampleLibraryName.jar", + "type": "Microsoft.Synapse/workspaces/libraries", + "properties": { + "name": "exampleLibraryName.jar", + "path": "exampleWorkspace/libraries/exampleLibraryName.jar", + "containerName": "exampleContainer", + "type": "jar", + "uploadedTimestamp": "2020-10-23T07:59:29.1573546+00:00", + "provisioningStatus": "Succeeded", + "creatorId": "2222222e-222d-222f-2222-22a2f222d2f2" + }, + "etag": "1500474f-0000-0200-0000-5cbe090d0000" + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/LinkedServices_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/LinkedServices_Create.json new file mode 100644 index 000000000000..cb484e2a0056 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/LinkedServices_Create.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "linkedServiceName": "exampleLinkedService", + "ifMatch": null, + "linkedService": { + "properties": { + "type": "AzureStorage", + "typeProperties": { + "connectionString": { + "type": "SecureString", + "value": "DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=" + } + } + } + }, + "api-version": "2020-12-01" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:34 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1196", + "x-ms-request-id": "b3b336b3-b203-4654-9cb6-a3a8d3a4b5de", + "x-ms-correlation-request-id": "b3b336b3-b203-4654-9cb6-a3a8d3a4b5de" + } + }, + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/linkedservices/exampleLinkedService", + "name": "exampleLinkedService", + "type": "Microsoft.Synapse/workspaces/linkedservices", + "properties": { + "type": "AzureStorage", + "typeProperties": { + "connectionString": { + "type": "SecureString", + "value": "**********" + }, + "encryptedCredential": "ew0KICAiVmVyc2lvbiI6ICIyMDE3LTExLTMwIiwNCiAgIlByb3RlY3Rpb25Nb2RlIjogIktleSIsDQogICJTZWNyZXRDb250ZW50VHlwZSI6ICJQbGFpbnRleHQiLA0KICAiQ3JlZGVudGlhbElkIjogIkRGLURPR0ZPT0QtWUFOWkhBTkctV1VfM2FiMTk0NjYtNWUxNi00NzU1LWJlNzktMjI2ZTVmZWU3YzY0Ig0KfQ==" + } + }, + "etag": "0a0062d4-0000-0000-0000-5b245bcf0000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/LinkedServices_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/LinkedServices_Delete.json new file mode 100644 index 000000000000..45ce1068c78c --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/LinkedServices_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "linkedServiceName": "exampleLinkedService", + "api-version": "2020-12-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/LinkedServices_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/LinkedServices_Get.json new file mode 100644 index 000000000000..f433b26b2acc --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/LinkedServices_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "linkedServiceName": "exampleLinkedService", + "ifNoneMatch": "1500474f-0000-0200-0000-5cbe090d0000", + "api-version": "2020-12-01" + }, + "responses": { + "304": {}, + "200": { + "headers": { + "Date": "Mon, 22 Apr 2019 18:33:48 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "11995", + "x-ms-request-id": "99e5d0d9-55e6-45a0-8bd2-cf39210f317c", + "x-ms-correlation-request-id": "99e5d0d9-55e6-45a0-8bd2-cf39210f317c" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/linkedservices/exampleLinkedService", + "name": "exampleLinkedService", + "type": "Microsoft.Synapse/workspaces/linkedservices", + "properties": { + "type": "AzureStorage", + "typeProperties": { + "connectionString": { + "type": "SecureString", + "value": "**********" + }, + "encryptedCredential": "ew0KICAiVmVyc2lvbiI6ICIyMDE3LTExLTMwIiwNCiAgIlByb3RlY3Rpb25Nb2RlIjogIktleSIsDQogICJTZWNyZXRDb250ZW50VHlwZSI6ICJQbGFpbnRleHQiLA0KICAiQ3JlZGVudGlhbElkIjogIkhWVEVTVEVYQU1QTEVTXzg5MjU1NGY0LTViNGItNDFhOS1hYWYxLTg4ZWI5ZDBjOWIzMyINCn0=" + }, + "description": "Example description" + }, + "etag": "1500474f-0000-0200-0000-5cbe090d0000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/LinkedServices_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/LinkedServices_ListByWorkspace.json new file mode 100644 index 000000000000..f46126667871 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/LinkedServices_ListByWorkspace.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:36 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14994", + "x-ms-request-id": "558d0fd8-dc1f-44b6-9ca9-59fcca8af9a5", + "x-ms-correlation-request-id": "558d0fd8-dc1f-44b6-9ca9-59fcca8af9a5" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/linkedservices/exampleLinkedService", + "name": "exampleLinkedService", + "type": "Microsoft.Synapse/workspaces/linkedservices", + "properties": { + "type": "AzureStorage", + "typeProperties": { + "connectionString": { + "type": "SecureString", + "value": "**********" + }, + "encryptedCredential": "ew0KICAiVmVyc2lvbiI6ICIyMDE3LTExLTMwIiwNCiAgIlByb3RlY3Rpb25Nb2RlIjogIktleSIsDQogICJTZWNyZXRDb250ZW50VHlwZSI6ICJQbGFpbnRleHQiLA0KICAiQ3JlZGVudGlhbElkIjogIkRGLURPR0ZPT0QtWUFOWkhBTkctV1VfMGI2M2EyMmYtMGEzNC00NDg2LWIzMDktNzM0NTlkODUyY2Q1Ig0KfQ==" + }, + "description": "Example description" + }, + "etag": "0a0064d4-0000-0000-0000-5b245bd00000" + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/LinkedServices_Rename.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/LinkedServices_Rename.json new file mode 100644 index 000000000000..68e34c65cb09 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/LinkedServices_Rename.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "linkedServiceName": "exampleLinkedService", + "api-version": "2020-12-01", + "request": { + "newName": "newLinkedService" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/LinkedServices_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/LinkedServices_Update.json new file mode 100644 index 000000000000..c24c8c1556ac --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/LinkedServices_Update.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "linkedServiceName": "exampleLinkedService", + "ifMatch": null, + "linkedService": { + "properties": { + "type": "AzureStorage", + "typeProperties": { + "connectionString": { + "type": "SecureString", + "value": "DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=" + } + }, + "description": "Example description" + } + }, + "api-version": "2020-12-01" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:36 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1195", + "x-ms-request-id": "53ad9761-ecdf-43ed-916f-878a5fb92cb0", + "x-ms-correlation-request-id": "53ad9761-ecdf-43ed-916f-878a5fb92cb0" + } + }, + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/linkedservices/exampleLinkedService", + "name": "exampleLinkedService", + "type": "Microsoft.Synapse/workspaces/linkedservices", + "properties": { + "type": "AzureStorage", + "typeProperties": { + "connectionString": { + "type": "SecureString", + "value": "**********" + }, + "encryptedCredential": "ew0KICAiVmVyc2lvbiI6ICIyMDE3LTExLTMwIiwNCiAgIlByb3RlY3Rpb25Nb2RlIjogIktleSIsDQogICJTZWNyZXRDb250ZW50VHlwZSI6ICJQbGFpbnRleHQiLA0KICAiQ3JlZGVudGlhbElkIjogIkRGLURPR0ZPT0QtWUFOWkhBTkctV1VfMGI2M2EyMmYtMGEzNC00NDg2LWIzMDktNzM0NTlkODUyY2Q1Ig0KfQ==" + }, + "description": "Example description" + }, + "etag": "0a0064d4-0000-0000-0000-5b245bd00000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/ListManagedPrivateEndpoints.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/ListManagedPrivateEndpoints.json new file mode 100644 index 000000000000..c33c6bd8a4b0 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/ListManagedPrivateEndpoints.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01", + "managedVirtualNetworkName": "default" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.Synapse/workspaces/managedVirtualNetworks/managedPrivateEndpoints", + "name": "myPrivateEndpoint1", + "properties": { + "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Storage/accounts/myStorageAccount1", + "groupId": "blob", + "provisioningState": "Succeeded", + "connectionState": { + "status": "Approved", + "description": "", + "actionsRequired": "" + } + } + }, + { + "type": "Microsoft.Synapse/workspaces/managedVirtualNetworks/managedPrivateEndpoints", + "name": "myPrivateEndpoint2", + "properties": { + "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Storage/accounts/myStorageAccount2", + "groupId": "blob", + "provisioningState": "Succeeded", + "connectionState": { + "status": "Pending", + "description": "", + "actionsRequired": "" + } + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Monitoring_GetSparkJobList.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Monitoring_GetSparkJobList.json new file mode 100644 index 000000000000..03a2a2e05f3f --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Monitoring_GetSparkJobList.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "endpoint": "myWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "body": { + "nJobs": 1, + "sparkJobs": [ + { + "state": "Failure", + "name": "sparkjobname", + "submitter": "submittername", + "compute": "ComputeName", + "sparkApplicationId": "sparkApplicationId", + "livyId": "LivyIdValue", + "timing": [ + "Ended || Submitting || In Progress", + "553h 11m" + ], + "sparkJobDefinition": null, + "pipeline": [], + "jobType": "Spark session || Batch Job", + "submitTime": "2019-11-11T15:08:52.9554438-08:00", + "endTime": "2019-11-11T15:08:56.2314317-08:00", + "queuedDuration": "1s", + "runningDuration": "2s", + "totalDuration": "3s" + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Monitoring_GetSqlJobQueryString.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Monitoring_GetSqlJobQueryString.json new file mode 100644 index 000000000000..1d5c8f3a22d4 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Monitoring_GetSqlJobQueryString.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "endpoint": "myWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "body": { + "query": "select * from ( SELECT COUNT(*) OVER() AS total_count,'Running' as [status],'0' as [request_id],'SQL On-demand' as [SQL Resource],s.login_name as [login_name],s.Session_Id as [session_id],r.start_time as [submit_time],r.start_time as [start_time],'N/A' as [end_time],r.command as [commandClause],sqltext.TEXT as [command],r.total_elapsed_time as [Duration],'N/A' as [Queued Duration],r.total_elapsed_time as [Running Duration],'N/A' as [Data processed in bytes],'N/A' as [group_name],'N/A' as [Source],'N/A' as [Pipeline],'N/A' as [importance],'N/A' as [classifier_name],Row_number() over ( ORDER BY r.start_time desc) as rownum FROM sys.dm_exec_requests r CROSS APPLY sys.dm_exec_sql_text(sql_handle) sqltext JOIN sys.dm_exec_sessions s ON r.session_id = s.session_id where (r.start_time between CONVERT(datetime,'2020-06-04T17:14:17Z') and CONVERT(datetime,'2020-06-05T17:14:22Z')) and s.session_id not in (select distinct Session_Id from sys.dm_exec_requests where command like'%@@Azure.Synapse.Monitoring.SQLQuerylist%')) tbl where rownum between 0 and 100-- @@Azure.Synapse.Monitoring.SQLQuerylist" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/NotebookOperationResult_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/NotebookOperationResult_Get.json new file mode 100644 index 000000000000..23981053c23a --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/NotebookOperationResult_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "operationId": "01234567-89ab-4def-0123-456789abcdef", + "api-version": "2020-12-01" + }, + "responses": { + "200": {}, + "201": {}, + "202": {}, + "204": {}, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Notebooks_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Notebooks_Create.json new file mode 100644 index 000000000000..cf9d36b20eb8 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Notebooks_Create.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "notebookName": "exampleNotebook", + "ifMatch": null, + "Notebook": { + "name": "exampleNotebook", + "properties": { + "description": "A sample Notebook", + "nbformat": 4, + "nbformat_minor": 2, + "bigDataPool": { + "referenceName": "exampleBigDataPoolName", + "type": "BigDataPoolReference" + }, + "sessionProperties": { + "driverMemory": "28g", + "driverCores": 4, + "executorMemory": "28g", + "executorCores": 4, + "numExecutors": 1 + }, + "metadata": { + "language_info": { + "name": "python" + }, + "kernelspec": { + "name": "exampleName", + "display_name": "exampleDisplayName" + } + }, + "cells": [ + { + "cell_type": "code", + "metadata": {}, + "source": [ + "def my_function():\n", + " print(\"Hello from a function\")\n", + "\n", + "my_function()" + ], + "attachments": {}, + "outputs": [ + { + "execution_count": 3, + "output_type": "execute_result", + "data": { + "text/plain": "Hello from a function" + }, + "metadata": {} + } + ] + } + ] + } + }, + "api-version": "2020-12-01" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:41 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + } + }, + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/Notebooks/exampleNotebook", + "name": "exampleNotebook", + "type": "Microsoft.Synapse/workspaces/Notebooks", + "properties": { + "description": "A sample Notebook", + "nbformat": 4, + "nbformat_minor": 2, + "bigDataPool": { + "referenceName": "exampleBigDataPoolName", + "type": "BigDataPoolReference" + }, + "sessionProperties": { + "driverMemory": "28g", + "driverCores": 4, + "executorMemory": "28g", + "executorCores": 4, + "numExecutors": 1 + }, + "metadata": { + "language_info": { + "name": "python" + }, + "kernelspec": { + "name": "exampleName", + "display_name": "exampleDisplayName" + } + }, + "cells": [ + { + "cell_type": "code", + "metadata": {}, + "source": [ + "def my_function():\n", + " print(\"Hello from a function\")\n", + "\n", + "my_function()" + ], + "attachments": {}, + "outputs": [ + { + "execution_count": 3, + "output_type": "execute_result", + "data": { + "text/plain": "Hello from a function" + }, + "metadata": {} + } + ] + } + ] + }, + "etag": "0a0069d4-0000-0000-0000-5b245bd50000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Notebooks_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Notebooks_Delete.json new file mode 100644 index 000000000000..3485607fcee5 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Notebooks_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "notebookName": "exampleNotebook", + "api-version": "2020-12-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Notebooks_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Notebooks_Get.json new file mode 100644 index 000000000000..347af13b2503 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Notebooks_Get.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "notebookName": "exampleNotebook", + "ifNoneMatch": "1500504f-0000-0200-0000-5cbe090f0000", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:41 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/notebooks/exampleNotebook", + "name": "exampleNotebook", + "type": "Microsoft.Synapse/workspaces/Notebooks", + "properties": { + "description": "A sample Notebook", + "nbformat": 4, + "nbformat_minor": 2, + "bigDataPool": { + "referenceName": "exampleBigDataPoolName", + "type": "BigDataPoolReference" + }, + "sessionProperties": { + "driverMemory": "28g", + "driverCores": 4, + "executorMemory": "28g", + "executorCores": 4, + "numExecutors": 1 + }, + "metadata": { + "language_info": { + "name": "python" + }, + "kernelspec": { + "name": "exampleName", + "display_name": "exampleDisplayName" + } + }, + "cells": [ + { + "cell_type": "code", + "metadata": {}, + "source": [ + "def my_function():\n", + " print(\"Hello from a function\")\n", + "\n", + "my_function()" + ], + "attachments": {}, + "outputs": [ + { + "execution_count": 3, + "output_type": "execute_result", + "data": { + "text/plain": "Hello from a function" + }, + "metadata": {} + } + ] + } + ] + }, + "etag": "1500504f-0000-0200-0000-5cbe090f0000" + } + }, + "304": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Notebooks_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Notebooks_ListByWorkspace.json new file mode 100644 index 000000000000..eb69e78c6b44 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Notebooks_ListByWorkspace.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:41 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/notebooks/exampleNotebook", + "name": "exampleNotebook", + "type": "Microsoft.Synapse/workspaces/Notebooks", + "properties": { + "description": "A sample Notebook", + "nbformat": 4, + "nbformat_minor": 2, + "bigDataPool": { + "referenceName": "exampleBigDataPoolName", + "type": "BigDataPoolReference" + }, + "sessionProperties": { + "driverMemory": "28g", + "driverCores": 4, + "executorMemory": "28g", + "executorCores": 4, + "numExecutors": 1 + }, + "metadata": { + "language_info": { + "name": "python" + }, + "kernelspec": { + "name": "exampleName", + "display_name": "exampleDisplayName" + } + }, + "cells": [ + { + "cell_type": "code", + "metadata": {}, + "source": [ + "def my_function():\n", + " print(\"Hello from a function\")\n", + "\n", + "my_function()" + ], + "attachments": {}, + "outputs": [ + { + "execution_count": 3, + "output_type": "execute_result", + "data": { + "text/plain": "Hello from a function" + }, + "metadata": {} + } + ] + } + ] + }, + "etag": "1500504f-0000-0200-0000-5cbe090f0000" + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Notebooks_ListSummaryByWorkSpace.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Notebooks_ListSummaryByWorkSpace.json new file mode 100644 index 000000000000..eb69e78c6b44 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Notebooks_ListSummaryByWorkSpace.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:41 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/notebooks/exampleNotebook", + "name": "exampleNotebook", + "type": "Microsoft.Synapse/workspaces/Notebooks", + "properties": { + "description": "A sample Notebook", + "nbformat": 4, + "nbformat_minor": 2, + "bigDataPool": { + "referenceName": "exampleBigDataPoolName", + "type": "BigDataPoolReference" + }, + "sessionProperties": { + "driverMemory": "28g", + "driverCores": 4, + "executorMemory": "28g", + "executorCores": 4, + "numExecutors": 1 + }, + "metadata": { + "language_info": { + "name": "python" + }, + "kernelspec": { + "name": "exampleName", + "display_name": "exampleDisplayName" + } + }, + "cells": [ + { + "cell_type": "code", + "metadata": {}, + "source": [ + "def my_function():\n", + " print(\"Hello from a function\")\n", + "\n", + "my_function()" + ], + "attachments": {}, + "outputs": [ + { + "execution_count": 3, + "output_type": "execute_result", + "data": { + "text/plain": "Hello from a function" + }, + "metadata": {} + } + ] + } + ] + }, + "etag": "1500504f-0000-0200-0000-5cbe090f0000" + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Notebooks_Rename.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Notebooks_Rename.json new file mode 100644 index 000000000000..941abf0d4674 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Notebooks_Rename.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "notebookName": "exampleNotebook", + "api-version": "2020-12-01", + "request": { + "newName": "newNotebook" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Notebooks_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Notebooks_Update.json new file mode 100644 index 000000000000..6559b7d79d61 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Notebooks_Update.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "notebookName": "exampleNotebook", + "ifMatch": null, + "Notebook": { + "name": "exampleNotebook", + "properties": { + "description": "Modified description", + "nbformat": 4, + "nbformat_minor": 2, + "bigDataPool": { + "referenceName": "exampleBigDataPoolName", + "type": "BigDataPoolReference" + }, + "sessionProperties": { + "driverMemory": "28g", + "driverCores": 4, + "executorMemory": "28g", + "executorCores": 4, + "numExecutors": 1 + }, + "metadata": { + "language_info": { + "name": "python" + }, + "kernelspec": { + "name": "exampleName", + "display_name": "exampleDisplayName" + } + }, + "cells": [ + { + "cell_type": "code", + "metadata": {}, + "source": [ + "def my_function():\n", + " print(\"Hello from a function\")\n", + "\n", + "my_function()" + ], + "attachments": {}, + "outputs": [ + { + "execution_count": 3, + "output_type": "execute_result", + "data": { + "text/plain": "Hello from a function" + }, + "metadata": {} + } + ] + } + ] + } + }, + "api-version": "2020-12-01" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:41 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + } + }, + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/notebooks/exampleNotebook", + "name": "exampleNotebook", + "type": "Microsoft.Synapse/workspaces/Notebooks", + "properties": { + "description": "Modified description", + "nbformat": 4, + "nbformat_minor": 2, + "bigDataPool": { + "referenceName": "exampleBigDataPoolName", + "type": "BigDataPoolReference" + }, + "sessionProperties": { + "driverMemory": "28g", + "driverCores": 4, + "executorMemory": "28g", + "executorCores": 4, + "numExecutors": 1 + }, + "metadata": { + "language_info": { + "name": "python" + }, + "kernelspec": { + "name": "exampleName", + "display_name": "exampleDisplayName" + } + }, + "cells": [ + { + "cell_type": "code", + "metadata": {}, + "source": [ + "def my_function():\n", + " print(\"Hello from a function\")\n", + "\n", + "my_function()" + ], + "attachments": {}, + "outputs": [ + { + "execution_count": 3, + "output_type": "execute_result", + "data": { + "text/plain": "Hello from a function" + }, + "metadata": {} + } + ] + } + ] + }, + "etag": "0a006cd4-0000-0000-0000-5b245bd60000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/OperationResult_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/OperationResult_Get.json new file mode 100644 index 000000000000..23981053c23a --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/OperationResult_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "operationId": "01234567-89ab-4def-0123-456789abcdef", + "api-version": "2020-12-01" + }, + "responses": { + "200": {}, + "201": {}, + "202": {}, + "204": {}, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/OperationStatus_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/OperationStatus_Get.json new file mode 100644 index 000000000000..23981053c23a --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/OperationStatus_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "operationId": "01234567-89ab-4def-0123-456789abcdef", + "api-version": "2020-12-01" + }, + "responses": { + "200": {}, + "201": {}, + "202": {}, + "204": {}, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/PipelineRuns_Cancel.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/PipelineRuns_Cancel.json new file mode 100644 index 000000000000..44310069e637 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/PipelineRuns_Cancel.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "runId": "16ac5348-ff82-4f95-a80d-638c1d47b721", + "api-version": "2020-12-01" + }, + "responses": { + "200": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/PipelineRuns_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/PipelineRuns_Get.json new file mode 100644 index 000000000000..40b68cc4867f --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/PipelineRuns_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:02 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14988", + "x-ms-request-id": "6d9de9bd-a412-4a6f-8b9e-37d369323646", + "x-ms-correlation-request-id": "6d9de9bd-a412-4a6f-8b9e-37d369323646" + }, + "body": { + "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b", + "pipelineName": "examplePipeline", + "parameters": { + "OutputBlobNameList": "[\"exampleoutput.csv\"]" + }, + "invokedBy": { + "id": "80a01654a9d34ad18b3fcac5d5d76b67", + "name": "Manual" + }, + "runStart": "2018-06-16T00:37:44.6257014Z", + "runEnd": "2018-06-16T00:38:12.7314495Z", + "durationInMs": 28105, + "status": "Succeeded", + "message": "", + "lastUpdated": "2018-06-16T00:38:12.7314495Z", + "annotations": [] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/PipelineRuns_QueryByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/PipelineRuns_QueryByWorkspace.json new file mode 100644 index 000000000000..5839a7f3538f --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/PipelineRuns_QueryByWorkspace.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "filterParameters": { + "lastUpdatedAfter": "2018-06-16T00:36:44.3345758Z", + "lastUpdatedBefore": "2018-06-16T00:49:48.3686473Z", + "filters": [ + { + "operand": "PipelineName", + "operator": "Equals", + "values": [ + "examplePipeline" + ] + } + ] + }, + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:01 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14989", + "x-ms-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd", + "x-ms-correlation-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd" + }, + "body": { + "value": [ + { + "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b", + "pipelineName": "examplePipeline", + "parameters": { + "OutputBlobNameList": "[\"exampleoutput.csv\"]" + }, + "invokedBy": { + "id": "80a01654a9d34ad18b3fcac5d5d76b67", + "name": "Manual" + }, + "runStart": "2018-06-16T00:37:44.6257014Z", + "runEnd": "2018-06-16T00:38:12.7314495Z", + "durationInMs": 28105, + "status": "Succeeded", + "message": "", + "lastUpdated": "2018-06-16T00:38:12.7314495Z", + "annotations": [], + "runDimension": { + "JobId": "79c1cc52-265f-41a5-9553-be65e736fbd3" + } + }, + { + "runId": "16ac5348-ff82-4f95-a80d-638c1d47b721", + "pipelineName": "examplePipeline", + "parameters": { + "OutputBlobNameList": "[\"exampleoutput.csv\"]" + }, + "invokedBy": { + "id": "7c5fd7ef7e8a464b98b931cf15fcac66", + "name": "Manual" + }, + "runStart": "2018-06-16T00:39:49.2745128Z", + "runEnd": null, + "durationInMs": null, + "status": "Cancelled", + "message": "", + "lastUpdated": "2018-06-16T00:39:51.216097Z", + "annotations": [], + "runDimension": { + "JobId": "84a3c493-0628-4b44-852f-ef5b3a11bdab" + } + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Pipelines_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Pipelines_Create.json new file mode 100644 index 000000000000..feacf3636c04 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Pipelines_Create.json @@ -0,0 +1,173 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "pipelineName": "examplePipeline", + "ifMatch": null, + "pipeline": { + "properties": { + "activities": [ + { + "type": "ForEach", + "typeProperties": { + "isSequential": true, + "items": { + "value": "@pipeline().parameters.OutputBlobNameList", + "type": "Expression" + }, + "activities": [ + { + "type": "Copy", + "typeProperties": { + "source": { + "type": "BlobSource" + }, + "sink": { + "type": "BlobSink" + }, + "dataIntegrationUnits": 32 + }, + "inputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": "examplecontainer.csv" + }, + "type": "DatasetReference" + } + ], + "outputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": { + "value": "@item()", + "type": "Expression" + } + }, + "type": "DatasetReference" + } + ], + "name": "ExampleCopyActivity" + } + ] + }, + "name": "ExampleForeachActivity" + } + ], + "parameters": { + "OutputBlobNameList": { + "type": "Array" + }, + "JobId": { + "type": "String" + } + }, + "variables": { + "TestVariableArray": { + "type": "Array" + } + }, + "runDimensions": { + "JobId": { + "value": "@pipeline().parameters.JobId", + "type": "Expression" + } + } + } + }, + "api-version": "2020-12-01" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:41 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + } + }, + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/pipelines/examplePipeline", + "name": "examplePipeline", + "type": "Microsoft.Synapse/workspaces/pipelines", + "properties": { + "activities": [ + { + "type": "ForEach", + "typeProperties": { + "isSequential": true, + "items": { + "value": "@pipeline().parameters.OutputBlobNameList", + "type": "Expression" + }, + "activities": [ + { + "type": "Copy", + "typeProperties": { + "source": { + "type": "BlobSource" + }, + "sink": { + "type": "BlobSink" + }, + "dataIntegrationUnits": 32 + }, + "inputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": "examplecontainer.csv" + }, + "type": "DatasetReference" + } + ], + "outputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": { + "value": "@item()", + "type": "Expression" + } + }, + "type": "DatasetReference" + } + ], + "name": "ExampleCopyActivity" + } + ] + }, + "name": "ExampleForeachActivity" + } + ], + "parameters": { + "OutputBlobNameList": { + "type": "Array" + }, + "JobId": { + "type": "String" + } + }, + "variables": { + "TestVariableArray": { + "type": "Array" + } + }, + "runDimensions": { + "JobId": { + "value": "@pipeline().parameters.JobId", + "type": "Expression" + } + } + }, + "etag": "0a0069d4-0000-0000-0000-5b245bd50000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Pipelines_CreateRun.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Pipelines_CreateRun.json new file mode 100644 index 000000000000..29da74dbbf51 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Pipelines_CreateRun.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "pipelineName": "examplePipeline", + "referencePipelineRunId": null, + "parameters": { + "OutputBlobNameList": [ + "exampleoutput.csv" + ] + }, + "api-version": "2020-12-01" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:48 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1190", + "x-ms-request-id": "5c2b442b-d360-43ec-9268-f923f88f31fd", + "x-ms-correlation-request-id": "5c2b442b-d360-43ec-9268-f923f88f31fd" + }, + "body": { + "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Pipelines_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Pipelines_Delete.json new file mode 100644 index 000000000000..b69da3105334 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Pipelines_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "pipelineName": "examplePipeline", + "api-version": "2020-12-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Pipelines_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Pipelines_Get.json new file mode 100644 index 000000000000..2fa4816b51d5 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Pipelines_Get.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "pipelineName": "examplePipeline", + "ifNoneMatch": "1500504f-0000-0200-0000-5cbe090f0000", + "api-version": "2020-12-01" + }, + "responses": { + "304": {}, + "200": { + "headers": { + "Date": "Mon, 22 Apr 2019 18:33:51 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "11991", + "x-ms-request-id": "f3865c61-4888-4b91-a617-9a985d9dd0fd", + "x-ms-correlation-request-id": "f3865c61-4888-4b91-a617-9a985d9dd0fd" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/pipelines/examplePipeline", + "name": "examplePipeline", + "type": "Microsoft.Synapse/workspaces/pipelines", + "properties": { + "description": "Example description", + "activities": [ + { + "type": "ForEach", + "typeProperties": { + "isSequential": true, + "items": { + "value": "@pipeline().parameters.OutputBlobNameList", + "type": "Expression" + }, + "activities": [ + { + "type": "Copy", + "typeProperties": { + "source": { + "type": "BlobSource" + }, + "sink": { + "type": "BlobSink" + }, + "dataIntegrationUnits": 32 + }, + "inputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": "examplecontainer.csv" + }, + "type": "DatasetReference" + } + ], + "outputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": { + "value": "@item()", + "type": "Expression" + } + }, + "type": "DatasetReference" + } + ], + "name": "ExampleCopyActivity" + } + ] + }, + "name": "ExampleForeachActivity" + } + ], + "parameters": { + "OutputBlobNameList": { + "type": "Array" + } + }, + "variables": { + "TestVariableArray": { + "type": "Array" + } + } + }, + "etag": "1500504f-0000-0200-0000-5cbe090f0000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Pipelines_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Pipelines_ListByWorkspace.json new file mode 100644 index 000000000000..530a2cfd6c15 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Pipelines_ListByWorkspace.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:43 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14990", + "x-ms-request-id": "92292250-c10f-4c47-8eb6-b886b361add7", + "x-ms-correlation-request-id": "92292250-c10f-4c47-8eb6-b886b361add7" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/pipelines/examplePipeline", + "name": "examplePipeline", + "type": "Microsoft.Synapse/workspaces/pipelines", + "properties": { + "description": "Example description", + "activities": [ + { + "type": "ForEach", + "typeProperties": { + "isSequential": true, + "items": { + "value": "@pipeline().parameters.OutputBlobNameList", + "type": "Expression" + }, + "activities": [ + { + "type": "Copy", + "typeProperties": { + "source": { + "type": "BlobSource" + }, + "sink": { + "type": "BlobSink" + }, + "dataIntegrationUnits": 32 + }, + "inputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": "examplecontainer.csv" + }, + "type": "DatasetReference" + } + ], + "outputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": { + "value": "@item()", + "type": "Expression" + } + }, + "type": "DatasetReference" + } + ], + "name": "ExampleCopyActivity" + } + ] + }, + "name": "ExampleForeachActivity" + } + ], + "parameters": { + "OutputBlobNameList": { + "type": "Array" + } + } + }, + "etag": "0a006cd4-0000-0000-0000-5b245bd60000" + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Pipelines_Rename.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Pipelines_Rename.json new file mode 100644 index 000000000000..b522ddb2a69b --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Pipelines_Rename.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "pipelineName": "examplePipeline", + "api-version": "2020-12-01", + "request": { + "newName": "newPipeline" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Pipelines_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Pipelines_Update.json new file mode 100644 index 000000000000..ccf9fde00551 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Pipelines_Update.json @@ -0,0 +1,147 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "pipelineName": "examplePipeline", + "ifMatch": null, + "pipeline": { + "properties": { + "description": "Example description", + "activities": [ + { + "type": "ForEach", + "typeProperties": { + "isSequential": true, + "items": { + "value": "@pipeline().parameters.OutputBlobNameList", + "type": "Expression" + }, + "activities": [ + { + "type": "Copy", + "typeProperties": { + "source": { + "type": "BlobSource" + }, + "sink": { + "type": "BlobSink" + }, + "dataIntegrationUnits": 32 + }, + "inputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": "examplecontainer.csv" + }, + "type": "DatasetReference" + } + ], + "outputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": { + "value": "@item()", + "type": "Expression" + } + }, + "type": "DatasetReference" + } + ], + "name": "ExampleCopyActivity" + } + ] + }, + "name": "ExampleForeachActivity" + } + ], + "parameters": { + "OutputBlobNameList": { + "type": "Array" + } + } + } + }, + "api-version": "2020-12-01" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:43 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1191", + "x-ms-request-id": "91a763b0-d944-493f-83fc-e989c8b6e122", + "x-ms-correlation-request-id": "91a763b0-d944-493f-83fc-e989c8b6e122" + } + }, + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/pipelines/examplePipeline", + "name": "examplePipeline", + "type": "Microsoft.Synapse/workspaces/pipelines", + "properties": { + "description": "Example description", + "activities": [ + { + "type": "ForEach", + "typeProperties": { + "isSequential": true, + "items": { + "value": "@pipeline().parameters.OutputBlobNameList", + "type": "Expression" + }, + "activities": [ + { + "type": "Copy", + "typeProperties": { + "source": { + "type": "BlobSource" + }, + "sink": { + "type": "BlobSink" + }, + "dataIntegrationUnits": 32 + }, + "inputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": "examplecontainer.csv" + }, + "type": "DatasetReference" + } + ], + "outputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": { + "value": "@item()", + "type": "Expression" + } + }, + "type": "DatasetReference" + } + ], + "name": "ExampleCopyActivity" + } + ] + }, + "name": "ExampleForeachActivity" + } + ], + "parameters": { + "OutputBlobNameList": { + "type": "Array" + } + } + }, + "etag": "0a006cd4-0000-0000-0000-5b245bd60000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/RoleAssignments_CreateRoleAssignment.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/RoleAssignments_CreateRoleAssignment.json new file mode 100644 index 000000000000..474230d62d42 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/RoleAssignments_CreateRoleAssignment.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "roleAssignmentId": "00000000-0000-0000-0000-000000000000", + "api-version": "2020-12-01", + "request": { + "roleId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000", + "scope": "workspaces/exampleWorkspace", + "principalType": "User || Group || ServicePrincipal" + } + }, + "responses": { + "200": { + "body": { + "id": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000", + "scope": "workspaces/exampleWorkspace", + "principalType": "User || Group || ServicePrincipal" + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/RoleAssignments_DeleteRoleAssignmentById.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/RoleAssignments_DeleteRoleAssignmentById.json new file mode 100644 index 000000000000..f8dc486f361c --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/RoleAssignments_DeleteRoleAssignmentById.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "roleAssignmentId": "00000000-0000-0000-0000-000000000000", + "api-version": "2020-12-01" + }, + "responses": { + "200": {}, + "204": {}, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/RoleAssignments_GetRoleAssignmentById.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/RoleAssignments_GetRoleAssignmentById.json new file mode 100644 index 000000000000..064bf49ab872 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/RoleAssignments_GetRoleAssignmentById.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "roleAssignmentId": "00000000-0000-0000-0000-000000000000", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "body": { + "id": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000", + "scope": "workspaces/exampleWorkspace", + "principalType": "User || Group || ServicePrincipal" + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/RoleAssignments_ListRoleAssignments.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/RoleAssignments_ListRoleAssignments.json new file mode 100644 index 000000000000..3c7add017f76 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/RoleAssignments_ListRoleAssignments.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01", + "roleId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000", + "scope": "workspaces/exampleWorkspace" + }, + "responses": { + "200": { + "headers": { + "x-ms-continuation": null + }, + "body": { + "count": 2, + "value": [ + { + "id": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000", + "scope": "workspaces/exampleWorkspace", + "principalType": "User || Group || ServicePrincipal" + }, + { + "id": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000", + "scope": "workspaces/exampleWorkspace", + "principalType": "User || Group || ServicePrincipal" + } + ] + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/RoleDefinitions_GetRoleDefinitionById.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/RoleDefinitions_GetRoleDefinitionById.json new file mode 100644 index 000000000000..3d3a20ed7aff --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/RoleDefinitions_GetRoleDefinitionById.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "roleDefinitionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "body": { + "id": "00000000-0000-0000-0000-000000000000", + "name": "Synapse role name", + "isBuiltIn": true, + "description": "Role description", + "permissions": [ + { + "actions": [ + "Action 1", + "Action 2" + ], + "dataActions": [ + "Data Action 1", + "Data Action 2" + ], + "notActions": [ + "Not Action 1", + "Not Action 2" + ], + "notDataActions": [ + "Data Action 1", + "Data Action 2" + ] + } + ], + "scopes": [ + "scope 1", + "scope 2" + ], + "availabilityStatus": "AvailabilityStatusValue" + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/RoleDefinitions_ListRoleDefinitions.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/RoleDefinitions_ListRoleDefinitions.json new file mode 100644 index 000000000000..3218cbd4a385 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/RoleDefinitions_ListRoleDefinitions.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "body": [ + { + "id": "00000000-0000-0000-0000-000000000000", + "name": "Synapse role name 1", + "isBuiltIn": true, + "description": "Role description 1", + "permissions": [ + { + "actions": [ + "Action 1", + "Action 2" + ], + "dataActions": [ + "Data Action 1", + "Data Action 2" + ], + "notActions": [ + "Not Action 1", + "Not Action 2" + ], + "notDataActions": [ + "Data Action 1", + "Data Action 2" + ] + } + ], + "scopes": [ + "scope 1", + "scope 2" + ], + "availabilityStatus": "AvailabilityStatusValue" + }, + { + "id": "00000000-0000-0000-0000-000000000000", + "name": "Synapse role name 2", + "isBuiltIn": true, + "description": "Role description 2", + "permissions": [ + { + "actions": [ + "Action 1", + "Action 2" + ], + "dataActions": [ + "Data Action 1", + "Data Action 2" + ], + "notActions": [ + "Not Action 1", + "Not Action 2" + ], + "notDataActions": [ + "Data Action 1", + "Data Action 2" + ] + } + ], + "scopes": [ + "scope 1", + "scope 2" + ], + "availabilityStatus": "AvailabilityStatusValue" + } + ] + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/RoleDefinitions_ListScopes.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/RoleDefinitions_ListScopes.json new file mode 100644 index 000000000000..17d78518cb50 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/RoleDefinitions_ListScopes.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "body": [ + "scope 1", + "scope 2", + "scope 3" + ] + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkBatch_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkBatch_Create.json new file mode 100644 index 000000000000..55db4134cc83 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkBatch_Create.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "endpoint": "myWorkspace.dev.azuresynapse.net", + "livyApiVersion": "2019-11-01-preview", + "sparkPoolName": "mySparkPool", + "detailed": true, + "sparkBatchJobOptions": { + "tags": null, + "artifactId": "fill in here", + "name": "jobname", + "file": "abfss://", + "className": "classname", + "args": [], + "jars": [], + "files": [], + "archives": [], + "conf": null, + "driverMemory": "4g", + "driverCores": 4, + "executorMemory": "2g", + "executorCores": 2, + "numExecutors": 2 + } + }, + "responses": { + "200": { + "body": { + "livyInfo": null, + "name": "jobname", + "workspaceName": "myWorkspace", + "sparkPoolName": "mySparkPool", + "submitterName": "thetime", + "submitterId": "thesubmitterid", + "artifactId": "fill in here", + "jobType": "SparkBatch", + "result": "Failed", + "schedulerInfo": null, + "pluginInfo": null, + "errorInfo": [], + "tags": null, + "id": 1, + "appId": "fill in here", + "appInfo": null, + "state": "the state", + "log": [] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkBatch_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkBatch_Delete.json new file mode 100644 index 000000000000..4065e60cf5ca --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkBatch_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "endpoint": "myWorkspace.dev.azuresynapse.net", + "livyApiVersion": "2019-11-01-preview", + "sparkPoolName": "mySparkPool", + "batchId": 123, + "detailed": true + }, + "responses": { + "200": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkBatch_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkBatch_Get.json new file mode 100644 index 000000000000..616f9498d037 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkBatch_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "endpoint": "myWorkspace.dev.azuresynapse.net", + "livyApiVersion": "2020-12-01", + "sparkPoolName": "mySparkPool", + "batchId": 123, + "detailed": true + }, + "responses": { + "200": { + "body": { + "livyInfo": null, + "name": "jobname", + "workspaceName": "myWorkspace", + "sparkPoolName": "mySparkPool", + "submitterName": "thetime", + "submitterId": "thesubmitterid", + "artifactId": "fill in here", + "jobType": "SparkBatch", + "result": "Failed", + "schedulerInfo": null, + "pluginInfo": null, + "errorInfo": [], + "tags": null, + "id": 1, + "appId": "fill in here", + "appInfo": null, + "state": "the state", + "log": [] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkBatch_List.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkBatch_List.json new file mode 100644 index 000000000000..65328a87c496 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkBatch_List.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "endpoint": "myWorkspace.dev.azuresynapse.net", + "livyApiVersion": "2020-12-01", + "sparkPoolName": "mySparkPool", + "from": 0, + "size": 2, + "detailed": true + }, + "responses": { + "200": { + "body": { + "from": 0, + "total": 2, + "sessions": [] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkSession_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkSession_Create.json new file mode 100644 index 000000000000..392544470614 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkSession_Create.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "endpoint": "myWorkspace.dev.azuresynapse.net", + "livyApiVersion": "2019-11-01-preview", + "sparkPoolName": "mySparkPool", + "detailed": true, + "SparkSessionOptions": { + "tags": null, + "artifactId": "fill in here", + "name": "jobname", + "file": "abfss://", + "className": "classname", + "args": [], + "jars": [], + "files": [], + "archives": [], + "conf": null, + "driverMemory": "4g", + "driverCores": 4, + "executorMemory": "2g", + "executorCores": 2, + "numExecutors": 2 + } + }, + "responses": { + "200": { + "body": { + "livyInfo": null, + "name": "jobname", + "workspaceName": "myWorkspace", + "sparkPoolName": "mySparkPool", + "submitterName": "thetime", + "submitterId": "thesubmitterid", + "artifactId": "fill in here", + "jobType": "SparkSession", + "result": "Failed", + "schedulerInfo": null, + "pluginInfo": null, + "errorInfo": [], + "tags": null, + "id": 1, + "appId": "fill in here", + "appInfo": null, + "state": "the state", + "log": [] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkSession_CreateStatement.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkSession_CreateStatement.json new file mode 100644 index 000000000000..b7a24abf63ad --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkSession_CreateStatement.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "endpoint": "myWorkspace.dev.azuresynapse.net", + "livyApiVersion": "2020-12-01", + "sparkPoolName": "mySparkPool", + "sessionId": 123, + "SparkStatementOptions": { + "code": "fill in here", + "kind": "fill in here" + } + }, + "responses": { + "200": { + "body": { + "id": 123, + "code": "fill in here", + "state": "fill in here", + "output": null + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkSession_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkSession_Delete.json new file mode 100644 index 000000000000..50dcbafe48eb --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkSession_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "endpoint": "myWorkspace.dev.azuresynapse.net", + "livyApiVersion": "2019-11-01-preview", + "sparkPoolName": "mySparkPool", + "sessionId": 123, + "detailed": true + }, + "responses": { + "200": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkSession_DeleteStatement.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkSession_DeleteStatement.json new file mode 100644 index 000000000000..96a7632ed484 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkSession_DeleteStatement.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "endpoint": "myWorkspace.dev.azuresynapse.net", + "livyApiVersion": "2020-12-01", + "sparkPoolName": "mySparkPool", + "sessionId": 123, + "statementId": 123 + }, + "responses": { + "200": { + "body": { + "msg": "fill in here" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkSession_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkSession_Get.json new file mode 100644 index 000000000000..2616ff531d6b --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkSession_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "endpoint": "myWorkspace.dev.azuresynapse.net", + "livyApiVersion": "2020-12-01", + "sparkPoolName": "mySparkPool", + "sessionId": 123, + "detailed": true + }, + "responses": { + "200": { + "body": { + "livyInfo": null, + "name": "jobname", + "workspaceName": "myWorkspace", + "sparkPoolName": "mySparkPool", + "submitterName": "thetime", + "submitterId": "thesubmitterid", + "artifactId": "fill in here", + "jobType": "SparkSession", + "result": "Failed", + "schedulerInfo": null, + "pluginInfo": null, + "errorInfo": [], + "tags": null, + "id": 1, + "appId": "fill in here", + "appInfo": null, + "state": "the state", + "log": [] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkSession_GetStatement.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkSession_GetStatement.json new file mode 100644 index 000000000000..6a9867f5bd41 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkSession_GetStatement.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "endpoint": "myWorkspace.dev.azuresynapse.net", + "livyApiVersion": "2020-12-01", + "sparkPoolName": "mySparkPool", + "sessionId": 123, + "statementId": 123 + }, + "responses": { + "200": { + "body": { + "id": 123, + "code": "fill in here", + "state": "fill in here", + "output": null + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkSession_List.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkSession_List.json new file mode 100644 index 000000000000..65328a87c496 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkSession_List.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "endpoint": "myWorkspace.dev.azuresynapse.net", + "livyApiVersion": "2020-12-01", + "sparkPoolName": "mySparkPool", + "from": 0, + "size": 2, + "detailed": true + }, + "responses": { + "200": { + "body": { + "from": 0, + "total": 2, + "sessions": [] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkSession_ListStatements.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkSession_ListStatements.json new file mode 100644 index 000000000000..10772de010d0 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkSession_ListStatements.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "endpoint": "myWorkspace.dev.azuresynapse.net", + "livyApiVersion": "2020-12-01", + "sparkPoolName": "mySparkPool", + "sessionId": 123 + }, + "responses": { + "200": { + "body": { + "total_statements": 2, + "statements": [] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkSession_ResetTimeout.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkSession_ResetTimeout.json new file mode 100644 index 000000000000..c248bb5bdce9 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkFrontend_SparkSession_ResetTimeout.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "myWorkspace.dev.azuresynapse.net", + "livyApiVersion": "2020-12-01", + "sparkPoolName": "mySparkPool", + "sessionId": 123 + }, + "responses": { + "200": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkJobDefinitions_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkJobDefinitions_Create.json new file mode 100644 index 000000000000..35e936e124dc --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkJobDefinitions_Create.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sparkJobDefinitionName": "exampleSparkJobDefinition", + "ifMatch": null, + "sparkJobDefinition": { + "properties": { + "description": "A sample spark job definition", + "targetBigDataPool": { + "referenceName": "exampleBigDataPool", + "type": "BigDataPoolReference" + }, + "requiredSparkVersion": "2.4", + "jobProperties": { + "name": "exampleSparkJobDefinition", + "file": "abfss://test@test.dfs.core.windows.net/artefacts/sample.jar", + "className": "dev.test.tools.sample.Main", + "conf": {}, + "args": [ + "exampleArg" + ], + "jars": [], + "pyFiles": [], + "files": [], + "archives": [], + "driverMemory": "28g", + "driverCores": 4, + "executorMemory": "28g", + "executorCores": 4, + "numExecutors": 2 + } + } + }, + "api-version": "2020-12-01" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2019 00:37:38 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1194", + "x-ms-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0", + "x-ms-correlation-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0" + } + }, + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:41 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/sparkjobdefinitions/exampleSparkJobDefinition", + "name": "exampleSparkJobDefinition", + "type": "Microsoft.Synapse/workspaces/sparkjobdefinitions", + "properties": { + "description": "A sample spark job definition", + "targetBigDataPool": { + "referenceName": "exampleBigDataPool", + "type": "BigDataPoolReference" + }, + "requiredSparkVersion": "2.4", + "jobProperties": { + "name": "exampleSparkJobDefinition", + "file": "abfss://test@test.dfs.core.windows.net/artefacts/sample.jar", + "className": "dev.test.tools.sample.Main", + "conf": {}, + "args": [ + "exampleArg" + ], + "jars": [], + "pyFiles": [], + "files": [], + "archives": [], + "driverMemory": "28g", + "driverCores": 4, + "executorMemory": "28g", + "executorCores": 4, + "numExecutors": 2 + } + }, + "etag": "0a0069d4-0000-0000-0000-5b245bd50000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkJobDefinitions_Debug.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkJobDefinitions_Debug.json new file mode 100644 index 000000000000..15b164c03263 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkJobDefinitions_Debug.json @@ -0,0 +1,166 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sparkJobDefinitionAzureResource": { + "properties": { + "description": "A sample spark job definition", + "targetBigDataPool": { + "referenceName": "exampleBigDataPool", + "type": "BigDataPoolReference" + }, + "requiredSparkVersion": "2.4", + "jobProperties": { + "name": "exampleSparkJobDefinition", + "file": "https://somestorage.blob.core.windows.net/main.jar", + "className": "SampleApp.SampleApp", + "conf": {}, + "driverMemory": "2g", + "driverCores": 2, + "executorMemory": "2g", + "executorCores": 2, + "numExecutors": 2 + } + } + }, + "api-version": "2020-12-01" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 13 Sep 2019 23:38:58 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "location": "https://exampleWorkspaceName.dev.azuresynapse.net/operationResults/arcadiaSpark$$exampleBigDataPool$$batch$$1?api-version=2019-06-01-preview" + }, + "body": { + "livyInfo": { + "startingAt": "2019-09-13T23:38:08.9498718+00:00", + "runningAt": "2019-09-13T23:38:33.1197083+00:00", + "currentState": "running", + "jobCreationRequest": { + "name": "SampleBatchJob", + "file": "https://somestorage.blob.core.windows.net/main.jar", + "className": "SampleApp.SampleApp", + "conf": {}, + "driverMemory": "2g", + "driverCores": 2, + "executorMemory": "2g", + "executorCores": 2, + "numExecutors": 2 + } + }, + "name": "SampleBatchJob", + "workspaceName": "exampleWorkspace", + "sparkPoolName": "c0", + "submitterName": "user@domain.com", + "submitterId": "12345678-1234-1234-1234-12345678abc", + "artifactId": "Livy", + "jobType": "SparkBatch", + "result": "Succeeded", + "schedulerInfo": { + "submittedAt": "2019-09-13T23:38:01.3002495+00:00", + "scheduledAt": "2019-09-13T23:38:03.6535682+00:00", + "currentState": "running" + }, + "pluginInfo": { + "preparationStartedAt": "2019-09-13T23:38:03.7178558+00:00", + "resourceAcquisitionStartedAt": "2019-09-13T23:38:04.5467298+00:00", + "submissionStartedAt": "2019-09-13T23:38:05.4808501+00:00", + "currentState": "running" + }, + "tags": {}, + "id": 0, + "appId": "application_1568416412157_0002", + "appInfo": { + "driverLogUrl": "http://aa5a93c513fa426980a44e8124b9797b000eb919817:8042/node/containerlogs/container_1568416412157_0002_02_000001/trusted-service-user", + "sparkUiUrl": "http://aa5a93c513fa426980a44e8124b9797b004f5397319:8088/proxy/application_1568416412157_0002/" + }, + "state": "running", + "log": [ + "\tat org.apache.spark.sql.DataFrameReader.load(DataFrameReader.scala:211)", + "\tat org.apache.spark.sql.DataFrameReader.json(DataFrameReader.scala:391)", + "\tat org.apache.spark.sql.DataFrameReader.json(DataFrameReader.scala:325)", + "\tat SampleApp.SampleApp$.main(SampleApp.scala:39)", + "\tat SampleApp.SampleApp.main(SampleApp.scala)", + "\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)", + "\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)", + "\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)", + "\tat java.lang.reflect.Method.invoke(Method.java:498)", + "\tat org.apache.spark.deploy.yarn.ApplicationMaster$$anon$2.run(ApplicationMaster.scala:684)" + ] + } + }, + "200": { + "headers": { + "Date": "Sat, 13 Sep 2019 23:38:58 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "livyInfo": { + "startingAt": "2019-09-13T23:38:08.9498718+00:00", + "runningAt": "2019-09-13T23:38:33.1197083+00:00", + "successAt": "2019-09-13T23:38:57.2737498+00:00", + "currentState": "success", + "jobCreationRequest": { + "name": "SampleBatchJob", + "file": "https://somestorage.blob.core.windows.net/main.jar", + "className": "SampleApp.SampleApp", + "conf": {}, + "driverMemory": "2g", + "driverCores": 2, + "executorMemory": "2g", + "executorCores": 2, + "numExecutors": 2 + } + }, + "name": "SampleBatchJob", + "workspaceName": "exampleWorkspace", + "sparkPoolName": "c0", + "submitterName": "user@domain.com", + "submitterId": "12345678-1234-1234-1234-12345678abc", + "artifactId": "Livy", + "jobType": "SparkBatch", + "result": "Succeeded", + "schedulerInfo": { + "submittedAt": "2019-09-13T23:38:01.3002495+00:00", + "scheduledAt": "2019-09-13T23:38:03.6535682+00:00", + "endedAt": "2019-09-13T23:38:57.5375224+00:00", + "currentState": "Ended" + }, + "pluginInfo": { + "preparationStartedAt": "2019-09-13T23:38:03.7178558+00:00", + "resourceAcquisitionStartedAt": "2019-09-13T23:38:04.5467298+00:00", + "submissionStartedAt": "2019-09-13T23:38:05.4808501+00:00", + "monitoringStartedAt": "2019-09-13T23:38:09.0304334+00:00", + "cleanupStartedAt": "2019-09-13T23:38:57.3472897+00:00", + "currentState": "Ended" + }, + "tags": {}, + "id": 0, + "appId": "application_1568416412157_0002", + "appInfo": { + "driverLogUrl": "http://aa5a93c513fa426980a44e8124b9797b000eb919817:8042/node/containerlogs/container_1568416412157_0002_02_000001/trusted-service-user", + "sparkUiUrl": "http://aa5a93c513fa426980a44e8124b9797b004f5397319:8088/proxy/application_1568416412157_0002/" + }, + "state": "success", + "log": [ + "\tat org.apache.spark.sql.DataFrameReader.load(DataFrameReader.scala:211)", + "\tat org.apache.spark.sql.DataFrameReader.json(DataFrameReader.scala:391)", + "\tat org.apache.spark.sql.DataFrameReader.json(DataFrameReader.scala:325)", + "\tat SampleApp.SampleApp$.main(SampleApp.scala:39)", + "\tat SampleApp.SampleApp.main(SampleApp.scala)", + "\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)", + "\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)", + "\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)", + "\tat java.lang.reflect.Method.invoke(Method.java:498)", + "\tat org.apache.spark.deploy.yarn.ApplicationMaster$$anon$2.run(ApplicationMaster.scala:684)" + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkJobDefinitions_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkJobDefinitions_Delete.json new file mode 100644 index 000000000000..71b347f921e7 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkJobDefinitions_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sparkJobDefinitionName": "exampleSparkJobDefinition", + "api-version": "2020-12-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkJobDefinitions_Execute.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkJobDefinitions_Execute.json new file mode 100644 index 000000000000..c99eb4581da2 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkJobDefinitions_Execute.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sparkJobDefinitionName": "exampleSparkJobDefinition", + "api-version": "2020-12-01" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 13 Sep 2019 23:38:58 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "location": "https://exampleWorkspaceName.dev.azuresynapse.net/operationResults/arcadiaSpark$$exampleBigDataPool$$batch$$1?api-version=2019-06-01-preview" + }, + "body": { + "livyInfo": { + "startingAt": "2019-09-13T23:38:08.9498718+00:00", + "runningAt": "2019-09-13T23:38:33.1197083+00:00", + "currentState": "running", + "jobCreationRequest": { + "name": "SampleBatchJob", + "file": "https://somestorage.blob.core.windows.net/main.jar", + "className": "SampleApp.SampleApp", + "conf": {}, + "driverMemory": "2g", + "driverCores": 2, + "executorMemory": "2g", + "executorCores": 2, + "numExecutors": 2 + } + }, + "name": "SampleBatchJob", + "workspaceName": "exampleWorkspace", + "sparkPoolName": "c0", + "submitterName": "user@domain.com", + "submitterId": "12345678-1234-1234-1234-12345678abc", + "artifactId": "Livy", + "jobType": "SparkBatch", + "result": "Succeeded", + "schedulerInfo": { + "submittedAt": "2019-09-13T23:38:01.3002495+00:00", + "scheduledAt": "2019-09-13T23:38:03.6535682+00:00", + "currentState": "running" + }, + "pluginInfo": { + "preparationStartedAt": "2019-09-13T23:38:03.7178558+00:00", + "resourceAcquisitionStartedAt": "2019-09-13T23:38:04.5467298+00:00", + "submissionStartedAt": "2019-09-13T23:38:05.4808501+00:00", + "currentState": "running" + }, + "tags": {}, + "id": 0, + "appId": "application_1568416412157_0002", + "appInfo": { + "driverLogUrl": "http://aa5a93c513fa426980a44e8124b9797b000eb919817:8042/node/containerlogs/container_1568416412157_0002_02_000001/trusted-service-user", + "sparkUiUrl": "http://aa5a93c513fa426980a44e8124b9797b004f5397319:8088/proxy/application_1568416412157_0002/" + }, + "state": "running", + "log": [ + "\tat org.apache.spark.sql.DataFrameReader.load(DataFrameReader.scala:211)", + "\tat org.apache.spark.sql.DataFrameReader.json(DataFrameReader.scala:391)", + "\tat org.apache.spark.sql.DataFrameReader.json(DataFrameReader.scala:325)", + "\tat SampleApp.SampleApp$.main(SampleApp.scala:39)", + "\tat SampleApp.SampleApp.main(SampleApp.scala)", + "\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)", + "\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)", + "\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)", + "\tat java.lang.reflect.Method.invoke(Method.java:498)", + "\tat org.apache.spark.deploy.yarn.ApplicationMaster$$anon$2.run(ApplicationMaster.scala:684)" + ] + } + }, + "200": { + "headers": { + "Date": "Sat, 13 Sep 2019 23:38:58 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "livyInfo": { + "startingAt": "2019-09-13T23:38:08.9498718+00:00", + "runningAt": "2019-09-13T23:38:33.1197083+00:00", + "successAt": "2019-09-13T23:38:57.2737498+00:00", + "currentState": "success", + "jobCreationRequest": { + "name": "SampleBatchJob", + "file": "https://somestorage.blob.core.windows.net/main.jar", + "className": "SampleApp.SampleApp", + "conf": {}, + "driverMemory": "2g", + "driverCores": 2, + "executorMemory": "2g", + "executorCores": 2, + "numExecutors": 2 + } + }, + "name": "SampleBatchJob", + "workspaceName": "exampleWorkspace", + "sparkPoolName": "c0", + "submitterName": "user@domain.com", + "submitterId": "12345678-1234-1234-1234-12345678abc", + "artifactId": "Livy", + "jobType": "SparkBatch", + "result": "Succeeded", + "schedulerInfo": { + "submittedAt": "2019-09-13T23:38:01.3002495+00:00", + "scheduledAt": "2019-09-13T23:38:03.6535682+00:00", + "endedAt": "2019-09-13T23:38:57.5375224+00:00", + "currentState": "Ended" + }, + "pluginInfo": { + "preparationStartedAt": "2019-09-13T23:38:03.7178558+00:00", + "resourceAcquisitionStartedAt": "2019-09-13T23:38:04.5467298+00:00", + "submissionStartedAt": "2019-09-13T23:38:05.4808501+00:00", + "monitoringStartedAt": "2019-09-13T23:38:09.0304334+00:00", + "cleanupStartedAt": "2019-09-13T23:38:57.3472897+00:00", + "currentState": "Ended" + }, + "tags": {}, + "id": 0, + "appId": "application_1568416412157_0002", + "appInfo": { + "driverLogUrl": "http://aa5a93c513fa426980a44e8124b9797b000eb919817:8042/node/containerlogs/container_1568416412157_0002_02_000001/trusted-service-user", + "sparkUiUrl": "http://aa5a93c513fa426980a44e8124b9797b004f5397319:8088/proxy/application_1568416412157_0002/" + }, + "state": "success", + "log": [ + "\tat org.apache.spark.sql.DataFrameReader.load(DataFrameReader.scala:211)", + "\tat org.apache.spark.sql.DataFrameReader.json(DataFrameReader.scala:391)", + "\tat org.apache.spark.sql.DataFrameReader.json(DataFrameReader.scala:325)", + "\tat SampleApp.SampleApp$.main(SampleApp.scala:39)", + "\tat SampleApp.SampleApp.main(SampleApp.scala)", + "\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)", + "\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)", + "\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)", + "\tat java.lang.reflect.Method.invoke(Method.java:498)", + "\tat org.apache.spark.deploy.yarn.ApplicationMaster$$anon$2.run(ApplicationMaster.scala:684)" + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkJobDefinitions_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkJobDefinitions_Get.json new file mode 100644 index 000000000000..33d41f3e4403 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkJobDefinitions_Get.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sparkJobDefinitionName": "exampleSparkJobDefinition", + "ifNoneMatch": "1500504f-0000-0200-0000-5cbe090f0000", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:41 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/sparkjobdefinitions/exampleSparkJobDefinition", + "name": "exampleSparkJobDefinition", + "type": "Microsoft.Synapse/workspaces/sparkjobdefinitions", + "properties": { + "description": "A sample spark job definition", + "targetBigDataPool": { + "referenceName": "exampleBigDataPool", + "type": "BigDataPoolReference" + }, + "requiredSparkVersion": "2.4", + "jobProperties": { + "name": "exampleSparkJobDefinition", + "file": "abfss://test@test.dfs.core.windows.net/artefacts/sample.jar", + "className": "dev.test.tools.sample.Main", + "conf": {}, + "args": [ + "exampleArg" + ], + "jars": [], + "pyFiles": [], + "files": [], + "archives": [], + "driverMemory": "28g", + "driverCores": 4, + "executorMemory": "28g", + "executorCores": 4, + "numExecutors": 2 + } + }, + "etag": "1500504f-0000-0200-0000-5cbe090f0000" + } + }, + "304": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkJobDefinitions_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkJobDefinitions_ListByWorkspace.json new file mode 100644 index 000000000000..df963084a76a --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkJobDefinitions_ListByWorkspace.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:43 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14990", + "x-ms-request-id": "92292250-c10f-4c47-8eb6-b886b361add7", + "x-ms-correlation-request-id": "92292250-c10f-4c47-8eb6-b886b361add7" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/sparkjobdefinitions/exampleSparkJobDefinition", + "name": "exampleSparkJobDefinition", + "type": "Microsoft.Synapse/workspaces/sparkjobdefinitions", + "properties": { + "description": "A sample spark job definition", + "targetBigDataPool": { + "referenceName": "exampleBigDataPool", + "type": "BigDataPoolReference" + }, + "requiredSparkVersion": "2.4", + "jobProperties": { + "name": "exampleSparkJobDefinition", + "file": "abfss://test@test.dfs.core.windows.net/artefacts/sample.jar", + "className": "dev.test.tools.sample.Main", + "conf": {}, + "args": [ + "exampleArg" + ], + "jars": [], + "pyFiles": [], + "files": [], + "archives": [], + "driverMemory": "28g", + "driverCores": 4, + "executorMemory": "28g", + "executorCores": 4, + "numExecutors": 2 + } + }, + "etag": "1500504f-0000-0200-0000-5cbe090f0000" + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkJobDefinitions_Rename.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkJobDefinitions_Rename.json new file mode 100644 index 000000000000..74e8a510b173 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkJobDefinitions_Rename.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sparkJobDefinitionName": "examplesparkJobDefinition", + "api-version": "2020-12-01", + "request": { + "newName": "newSparkJobDefinition" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkJobDefinitions_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkJobDefinitions_Update.json new file mode 100644 index 000000000000..910f485c4dc6 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SparkJobDefinitions_Update.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sparkJobDefinitionName": "exampleSparkJobDefinition", + "ifMatch": null, + "sparkJobDefinition": { + "properties": { + "description": "modified description", + "targetBigDataPool": { + "referenceName": "exampleBigDataPool", + "type": "BigDataPoolReference" + }, + "requiredSparkVersion": "2.4", + "jobProperties": { + "name": "exampleSparkJobDefinition", + "file": "abfss://test@test.dfs.core.windows.net/artefacts/sample.jar", + "className": "dev.test.tools.sample.Main", + "conf": {}, + "args": [ + "exampleArg" + ], + "jars": [], + "pyFiles": [], + "files": [], + "archives": [], + "driverMemory": "28g", + "driverCores": 4, + "executorMemory": "28g", + "executorCores": 4, + "numExecutors": 2 + } + } + }, + "api-version": "2020-12-01" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2019 00:37:38 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1194", + "x-ms-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0", + "x-ms-correlation-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0" + } + }, + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:41 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/sparkjobdefinitions/exampleSparkJobDefinition", + "name": "exampleSparkJobDefinition", + "type": "Microsoft.Synapse/workspaces/sparkjobdefinitions", + "properties": { + "description": "modified description", + "targetBigDataPool": { + "referenceName": "exampleBigDataPool", + "type": "BigDataPoolReference" + }, + "requiredSparkVersion": "2.4", + "jobProperties": { + "name": "exampleSparkJobDefinition", + "file": "abfss://test@test.dfs.core.windows.net/artefacts/sample.jar", + "className": "dev.test.tools.sample.Main", + "conf": {}, + "args": [ + "exampleArg" + ], + "jars": [], + "pyFiles": [], + "files": [], + "archives": [], + "driverMemory": "28g", + "driverCores": 4, + "executorMemory": "28g", + "executorCores": 4, + "numExecutors": 2 + } + }, + "etag": "0a006cd4-0000-0000-0000-5b245bd60000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SqlPools_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SqlPools_Get.json new file mode 100644 index 000000000000..0ca829f18a51 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SqlPools_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sqlPoolName": "SqlPool1", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "status": "Online", + "maxSizeBytes": 263882790666240, + "collation": "SQL_Latin1_General_CP1_CI_AS", + "restorePointInTime": "2019-06-23T10:47:12.837Z", + "creationDate": "2020-06-23T10:47:12.837Z", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "DW100c", + "capacity": 0 + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Synapse/workspaces/exampleWorkspace/sqlPools/SqlPool1", + "name": "SqlPool1", + "type": "Microsoft.Synapse/workspaces/sqlPools", + "location": "southeastasia", + "tags": {} + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SqlPools_List.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SqlPools_List.json new file mode 100644 index 000000000000..2c52fee9b343 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SqlPools_List.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "status": "Online", + "maxSizeBytes": 263882790666240, + "collation": "SQL_Latin1_General_CP1_CI_AS", + "restorePointInTime": "2020-06-23T10:47:12.837Z", + "creationDate": "2020-06-23T10:47:12.837Z", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "DW100c", + "capacity": 0 + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Synapse/workspaces/exampleWorkspace/sqlPools/SqlPool1", + "name": "SqlPool1", + "type": "Microsoft.Synapse/workspaces/sqlPools", + "location": "southeastasia", + "tags": {} + }, + { + "properties": { + "status": "Online", + "maxSizeBytes": 263882790666240, + "collation": "SQL_Latin1_General_CP1_CI_AS", + "restorePointInTime": "2020-06-23T10:47:12.837Z", + "creationDate": "2020-06-23T11:10:59.05Z", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "DW100c", + "capacity": 0 + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Synapse/workspaces/exampleWorkspace/sqlPools/SqlPool2Backup", + "name": "SqlPool2Backup", + "type": "Microsoft.Synapse/workspaces/sqlPools", + "location": "southeastasia", + "tags": {} + } + ] + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SqlScripts_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SqlScripts_Create.json new file mode 100644 index 000000000000..4bb2145644ca --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SqlScripts_Create.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sqlScriptName": "exampleSqlScript", + "ifMatch": null, + "sqlScript": { + "name": "exampleSqlScript", + "properties": { + "description": "Covers the data transformation and LDW scenarios in one brief e2e story", + "content": { + "query": "SELECT TOP 100 * FROM example_table_name;", + "currentConnection": { + "name": "master", + "type": "SqlOnDemand" + }, + "metadata": { + "language": "sql" + } + }, + "type": "SqlQuery" + } + }, + "api-version": "2020-12-01" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2019 00:37:38 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1194", + "x-ms-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0", + "x-ms-correlation-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0" + } + }, + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:41 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/sqlscripts/exampleSqlScript", + "name": "exampleSqlScript", + "type": "Microsoft.Synapse/workspaces/sqlscripts", + "properties": { + "description": "Covers the data transformation and LDW scenarios in one brief e2e story", + "content": { + "query": "SELECT TOP 100 * FROM example_table_name;", + "currentConnection": { + "name": "master", + "type": "SqlOnDemand" + }, + "metadata": { + "language": "sql" + } + }, + "type": "SqlQuery" + }, + "etag": "0a0069d4-0000-0000-0000-5b245bd50000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SqlScripts_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SqlScripts_Delete.json new file mode 100644 index 000000000000..faf4ae6cf40a --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SqlScripts_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sqlScriptName": "exampleSqlScript", + "api-version": "2020-12-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SqlScripts_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SqlScripts_Get.json new file mode 100644 index 000000000000..1a1b2fb189de --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SqlScripts_Get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sqlScriptName": "exampleSqlScript", + "ifNoneMatch": "1500504f-0000-0200-0000-5cbe090f0000", + "api-version": "2020-12-01" + }, + "responses": { + "304": {}, + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:41 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/sqlscripts/exampleSqlScript", + "name": "exampleSqlScript", + "type": "Microsoft.Synapse/workspaces/sqlscripts", + "properties": { + "description": "Covers the data transformation and LDW scenarios in one brief e2e story", + "content": { + "query": "SELECT TOP 100 * FROM example_table_name;", + "currentConnection": { + "name": "master", + "type": "SqlOnDemand" + }, + "metadata": { + "language": "sql" + } + }, + "type": "SqlQuery" + }, + "etag": "1500504f-0000-0200-0000-5cbe090f0000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SqlScripts_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SqlScripts_ListByWorkspace.json new file mode 100644 index 000000000000..884558c65348 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SqlScripts_ListByWorkspace.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:43 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14990", + "x-ms-request-id": "92292250-c10f-4c47-8eb6-b886b361add7", + "x-ms-correlation-request-id": "92292250-c10f-4c47-8eb6-b886b361add7" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/sqlscripts/exampleSqlScript", + "name": "exampleSqlScript", + "type": "Microsoft.Synapse/workspaces/sqlscripts", + "properties": { + "description": "Covers the data transformation and LDW scenarios in one brief e2e story", + "content": { + "query": "SELECT TOP 100 * FROM example_table_name;", + "currentConnection": { + "name": "master", + "type": "SqlOnDemand" + }, + "metadata": { + "language": "sql" + } + }, + "type": "SqlQuery" + }, + "etag": "1500504f-0000-0200-0000-5cbe090f0000" + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SqlScripts_Rename.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SqlScripts_Rename.json new file mode 100644 index 000000000000..ef86e739709e --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SqlScripts_Rename.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sqlScriptName": "exampleSqlScript", + "api-version": "2020-12-01", + "request": { + "newName": "newSqlScript" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SqlScripts_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SqlScripts_Update.json new file mode 100644 index 000000000000..834bae874e67 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/SqlScripts_Update.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sqlScriptName": "exampleSqlScript", + "ifMatch": null, + "sqlScript": { + "name": "exampleSqlScript", + "properties": { + "description": "modified description", + "content": { + "query": "SELECT TOP 100 * FROM example_table_name;", + "currentConnection": { + "name": "master", + "type": "SqlOnDemand" + }, + "metadata": { + "language": "sql" + } + }, + "type": "SqlQuery" + } + }, + "api-version": "2020-12-01" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2019 00:37:38 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1194", + "x-ms-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0", + "x-ms-correlation-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0" + } + }, + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:41 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/sqlscripts/exampleSqlScript", + "name": "exampleSqlScript", + "type": "Microsoft.Synapse/workspaces/sqlscripts", + "properties": { + "description": "modified description", + "content": { + "query": "SELECT TOP 100 * FROM example_table_name;", + "currentConnection": { + "name": "master", + "type": "SqlOnDemand" + }, + "metadata": { + "language": "sql" + } + }, + "type": "SqlQuery" + }, + "etag": "0a006cd4-0000-0000-0000-5b245bd60000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/TriggerRuns_Cancel.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/TriggerRuns_Cancel.json new file mode 100644 index 000000000000..bf9c6d507754 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/TriggerRuns_Cancel.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "triggerName": "exampleTrigger", + "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:46:24 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1198", + "x-ms-request-id": "5aa854a5-7ac0-4c7e-9356-79c657f4e231", + "x-ms-correlation-request-id": "5aa854a5-7ac0-4c7e-9356-79c657f4e231" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/TriggerRuns_QueryByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/TriggerRuns_QueryByWorkspace.json new file mode 100644 index 000000000000..9a85d5ee268d --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/TriggerRuns_QueryByWorkspace.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "filterParameters": { + "lastUpdatedAfter": "2018-06-16T00:36:44.3345758Z", + "lastUpdatedBefore": "2018-06-16T00:49:48.3686473Z", + "filters": [ + { + "operand": "TriggerName", + "operator": "Equals", + "values": [ + "exampleTrigger" + ] + } + ] + }, + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:46:22 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1199", + "x-ms-request-id": "fb328f3e-d21e-44f7-80d7-dad60c955b4d", + "x-ms-correlation-request-id": "fb328f3e-d21e-44f7-80d7-dad60c955b4d" + }, + "body": { + "value": [ + { + "triggerName": "exampleTrigger", + "triggerRunId": "08586724970898148904457116912CU27", + "triggerType": "ScheduleTrigger", + "triggerRunTimestamp": "2018-06-16T00:43:15.660141Z", + "status": "Succeeded", + "message": "", + "properties": { + "TriggerTime": "6/16/2018 12:43:15 AM", + "ScheduleTime": "6/16/2018 12:43:14 AM" + }, + "triggeredPipelines": { + "examplePipeline": "9f3ce8b3-37d7-43eb-96ac-a656c0476283" + } + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/TriggerRuns_Rerun.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/TriggerRuns_Rerun.json new file mode 100644 index 000000000000..bf9c6d507754 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/TriggerRuns_Rerun.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "triggerName": "exampleTrigger", + "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:46:24 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1198", + "x-ms-request-id": "5aa854a5-7ac0-4c7e-9356-79c657f4e231", + "x-ms-correlation-request-id": "5aa854a5-7ac0-4c7e-9356-79c657f4e231" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Triggers_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Triggers_Create.json new file mode 100644 index 000000000000..86f51517b085 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Triggers_Create.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "triggerName": "exampleTrigger", + "ifMatch": null, + "trigger": { + "properties": { + "type": "ScheduleTrigger", + "typeProperties": { + "recurrence": { + "frequency": "Minute", + "interval": 4, + "startTime": "2018-06-16T00:39:13.8441801Z", + "endTime": "2018-06-16T00:55:13.8441801Z", + "timeZone": "UTC" + } + }, + "pipelines": [ + { + "pipelineReference": { + "referenceName": "examplePipeline", + "type": "PipelineReference" + }, + "parameters": { + "OutputBlobNameList": [ + "exampleoutput.csv" + ] + } + } + ] + } + }, + "api-version": "2020-12-01" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:14 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1186", + "x-ms-request-id": "373f1a49-685d-4c07-8857-0fcf1bcaffcb", + "x-ms-correlation-request-id": "373f1a49-685d-4c07-8857-0fcf1bcaffcb" + } + }, + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/triggers/exampleTrigger", + "name": "exampleTrigger", + "type": "Microsoft.Synapse/workspaces/triggers", + "properties": { + "type": "ScheduleTrigger", + "typeProperties": { + "recurrence": { + "frequency": "Minute", + "interval": 4, + "startTime": "2018-06-16T00:39:13.8441801Z", + "endTime": "2018-06-16T00:55:13.8441801Z", + "timeZone": "UTC" + } + }, + "pipelines": [ + { + "pipelineReference": { + "referenceName": "examplePipeline", + "type": "PipelineReference" + }, + "parameters": { + "OutputBlobNameList": [ + "exampleoutput.csv" + ] + } + } + ], + "runtimeState": "Stopped" + }, + "etag": "0a008ad4-0000-0000-0000-5b245c6e0000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Triggers_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Triggers_Delete.json new file mode 100644 index 000000000000..2bff7d0017a8 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Triggers_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "triggerName": "exampleTrigger", + "api-version": "2020-12-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Triggers_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Triggers_Get.json new file mode 100644 index 000000000000..ce921331ac22 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Triggers_Get.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "triggerName": "exampleTrigger", + "ifNoneMatch": "1500544f-0000-0200-0000-5cbe09100000", + "api-version": "2020-12-01" + }, + "responses": { + "304": {}, + "200": { + "headers": { + "Date": "Mon, 22 Apr 2019 18:33:52 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "11989", + "x-ms-request-id": "8ad1759f-24c1-46a5-aef5-edd267e18870", + "x-ms-correlation-request-id": "8ad1759f-24c1-46a5-aef5-edd267e18870" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/triggers/exampleTrigger", + "name": "exampleTrigger", + "type": "Microsoft.Synapse/workspaces/triggers", + "properties": { + "type": "ScheduleTrigger", + "typeProperties": { + "recurrence": { + "frequency": "Minute", + "interval": 4, + "startTime": "2019-04-22T18:32:52.527912Z", + "endTime": "2019-04-22T18:48:52.5281747Z", + "timeZone": "UTC" + } + }, + "pipelines": [ + { + "pipelineReference": { + "referenceName": "examplePipeline", + "type": "PipelineReference" + }, + "parameters": { + "OutputBlobNameList": [ + "exampleoutput.csv" + ] + } + } + ], + "runtimeState": "Stopped" + }, + "etag": "1500544f-0000-0200-0000-5cbe09100000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Triggers_GetEventSubscriptionStatus.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Triggers_GetEventSubscriptionStatus.json new file mode 100644 index 000000000000..8c191c77ab5c --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Triggers_GetEventSubscriptionStatus.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "triggerName": "exampleTrigger", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "body": { + "triggerName": "exampleTrigger", + "status": "Enabled" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Triggers_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Triggers_ListByWorkspace.json new file mode 100644 index 000000000000..7e7d84669e5c --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Triggers_ListByWorkspace.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:20 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14986", + "x-ms-request-id": "e474f8f8-b34f-4536-b059-ca740e6b44c3", + "x-ms-correlation-request-id": "e474f8f8-b34f-4536-b059-ca740e6b44c3" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/triggers/exampleTrigger", + "name": "exampleTrigger", + "type": "Microsoft.Synapse/workspaces/triggers", + "properties": { + "type": "ScheduleTrigger", + "typeProperties": { + "recurrence": { + "frequency": "Minute", + "interval": 4, + "startTime": "2018-06-16T00:39:14.905167Z", + "endTime": "2018-06-16T00:55:14.905167Z", + "timeZone": "UTC" + } + }, + "pipelines": [ + { + "pipelineReference": { + "referenceName": "examplePipeline", + "type": "PipelineReference" + }, + "parameters": { + "OutputBlobNameList": [ + "exampleoutput.csv" + ] + } + } + ], + "description": "Example description", + "runtimeState": "Started" + }, + "etag": "0a008ed4-0000-0000-0000-5b245c740000" + } + ] + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Triggers_Start.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Triggers_Start.json new file mode 100644 index 000000000000..355a7a46dd88 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Triggers_Start.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "triggerName": "exampleTrigger", + "api-version": "2020-12-01" + }, + "responses": { + "200": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Triggers_Stop.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Triggers_Stop.json new file mode 100644 index 000000000000..355a7a46dd88 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Triggers_Stop.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "triggerName": "exampleTrigger", + "api-version": "2020-12-01" + }, + "responses": { + "200": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Triggers_SubscribeToEvents.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Triggers_SubscribeToEvents.json new file mode 100644 index 000000000000..6fd72391995d --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Triggers_SubscribeToEvents.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "triggerName": "exampleTrigger", + "api-version": "2020-12-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/triggers/exampleTrigger/getEventSubscriptionStatus?api-version=2019-06-01-preview" + } + }, + "200": { + "body": { + "triggerName": "exampleTrigger", + "status": "Enabled" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Triggers_UnsubscribeFromEvents.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Triggers_UnsubscribeFromEvents.json new file mode 100644 index 000000000000..cf07ecfbde3c --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Triggers_UnsubscribeFromEvents.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "triggerName": "exampleTrigger", + "api-version": "2020-12-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/triggers/exampleTrigger/getEventSubscriptionStatus?api-version=2019-06-01-preview" + } + }, + "200": { + "body": { + "triggerName": "exampleTrigger", + "status": "Disabled" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Triggers_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Triggers_Update.json new file mode 100644 index 000000000000..2eb712d03ba7 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Triggers_Update.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "triggerName": "exampleTrigger", + "ifMatch": null, + "trigger": { + "properties": { + "type": "ScheduleTrigger", + "typeProperties": { + "recurrence": { + "frequency": "Minute", + "interval": 4, + "startTime": "2018-06-16T00:39:14.905167Z", + "endTime": "2018-06-16T00:55:14.905167Z", + "timeZone": "UTC" + } + }, + "pipelines": [ + { + "pipelineReference": { + "referenceName": "examplePipeline", + "type": "PipelineReference" + }, + "parameters": { + "OutputBlobNameList": [ + "exampleoutput.csv" + ] + } + } + ], + "description": "Example description" + } + }, + "api-version": "2020-12-01" + }, + "responses": { + "202": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:15 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1185", + "x-ms-request-id": "d5ccf096-0618-4b26-9829-db77e4c391c7", + "x-ms-correlation-request-id": "d5ccf096-0618-4b26-9829-db77e4c391c7" + } + }, + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/triggers/exampleTrigger", + "name": "exampleTrigger", + "type": "Microsoft.Synapse/workspaces/triggers", + "properties": { + "type": "ScheduleTrigger", + "typeProperties": { + "recurrence": { + "frequency": "Minute", + "interval": 4, + "startTime": "2018-06-16T00:39:14.905167Z", + "endTime": "2018-06-16T00:55:14.905167Z", + "timeZone": "UTC" + } + }, + "pipelines": [ + { + "pipelineReference": { + "referenceName": "examplePipeline", + "type": "PipelineReference" + }, + "parameters": { + "OutputBlobNameList": [ + "exampleoutput.csv" + ] + } + } + ], + "description": "Example description", + "runtimeState": "Stopped" + }, + "etag": "0a008dd4-0000-0000-0000-5b245c6f0000" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/WorkspaceGitRepoManagement_getGitHubAccessToken.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/WorkspaceGitRepoManagement_getGitHubAccessToken.json new file mode 100644 index 000000000000..2e822208b493 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/WorkspaceGitRepoManagement_getGitHubAccessToken.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "workspaceName": "workspace1", + "api-version": "2020-12-01", + "x-ms-client-request-id": "c8b9a072-76f6-4383-8350-db4431deb921", + "gitHubAccessTokenRequest": { + "gitHubClientId": "wvwvwvwvwv", + "gitHubAccessCode": "cwvcwvwev", + "gitHubAccessTokenBaseUrl": "https://github.com/login/oauth/access_token" + }, + "endpoint": "https://azure.com" + }, + "responses": { + "200": { + "body": { + "gitHubAccessToken": "zycdwcsdc" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Workspace_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Workspace_Get.json new file mode 100644 index 000000000000..bab677c42568 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/Workspace_Get.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Synapse/workspaces/exampleWorkspace", + "location": "southeastasia", + "name": "exampleWorkspace", + "type": "Microsoft.Synapse/workspaces", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "tags": {}, + "properties": { + "connectivityEndpoints": { + "web": "https://web.azuresynapse.net?workspace=%2fsubscriptions%2f00000000-0000-0000-0000-000000000000%2fresourceGroups%2frg%2fproviders%2fMicrosoft.Synapse%2fworkspaces%2fexampleWorkspace", + "sql": "exampleWorkspace.sql.azuresynapse.net", + "dev": "https://exampleWorkspace.dev.azuresynapse.net", + "sqlOnDemand": "exampleWorkspace-ondemand.sql.azuresynapse.net" + }, + "managedResourceGroupName": "workspacemanagedrg-1a992746-f580-4fce-a696-b0373bc6959a", + "defaultDataLakeStorage": { + "accountUrl": "https://exampleWorkspacedfs.dfs.core.windows.net", + "filesystem": "synapse" + }, + "sqlAdministratorLogin": "sqladminuser", + "privateEndpointConnections": [], + "workspaceRepositoryConfiguration": { + "type": "FactoryGitHubConfiguration", + "hostName": "", + "accountName": "myGithubAccount", + "projectName": "myProject", + "repositoryName": "myRepository", + "collaborationBranch": "master", + "rootFolder": "/" + }, + "provisioningState": "Succeeded" + } + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/gitintegration.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/gitintegration.json new file mode 100644 index 000000000000..cfeaef2f7c39 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/gitintegration.json @@ -0,0 +1,123 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-12-01", + "title": "ArtifactsClient" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/getGitHubAccessToken": { + "post": { + "tags": [ + "WorkspaceGitRepoManagement" + ], + "operationId": "WorkspaceGitRepoManagement_getGitHubAccessToken", + "description": "Get the GitHub access token.", + "x-ms-examples": { + "Get SOL job query string": { + "$ref": "./examples/WorkspaceGitRepoManagement_getGitHubAccessToken.json" + } + }, + "parameters": [ + { + "name": "x-ms-client-request-id", + "x-ms-client-name": "ClientRequestId", + "in": "header", + "required": false, + "type": "string", + "description": "Can provide a guid, which is helpful for debugging and to provide better customer support" + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "gitHubAccessTokenRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GitHubAccessTokenRequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/GitHubAccessTokenResponse" + } + } + } + } + } + }, + "definitions": { + "GitHubAccessTokenRequest": { + "type": "object", + "properties": { + "gitHubClientId": { + "description": "The GitHub Client Id.", + "type": "string" + }, + "gitHubAccessCode": { + "description": "The GitHub Access code.", + "type": "string" + }, + "gitHubAccessTokenBaseUrl": { + "description": "The GitHub access token base URL.", + "type": "string" + } + }, + "required": [ + "gitHubClientId", + "gitHubAccessCode", + "gitHubAccessTokenBaseUrl" + ] + }, + "GitHubAccessTokenResponse": { + "type": "object", + "properties": { + "gitHubAccessToken": { + "type": "string" + } + } + } + }, + "parameters": { + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Synapse client API Version." + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/integrationRuntimes.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/integrationRuntimes.json new file mode 100644 index 000000000000..65228652f7f3 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/integrationRuntimes.json @@ -0,0 +1,123 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-12-01", + "title": "ArtifactsClient" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/integrationRuntimes": { + "get": { + "tags": [ + "IntegrationRuntimes" + ], + "operationId": "IntegrationRuntimes_List", + "description": "List Integration Runtimes", + "x-ms-examples": { + "List Integration Runtimes": { + "$ref": "./examples/IntegrationRuntimes_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success response.", + "schema": { + "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/integrationRuntime.json#/definitions/IntegrationRuntimeListResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + } + } + } + } + }, + "/integrationRuntimes/{integrationRuntimeName}": { + "get": { + "tags": [ + "IntegrationRuntimes" + ], + "operationId": "IntegrationRuntimes_Get", + "description": "Get Integration Runtime", + "x-ms-examples": { + "Get Integration Runtime": { + "$ref": "./examples/IntegrationRuntimes_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IntegrationRuntimeNameParameter" + } + ], + "responses": { + "200": { + "description": "Success response.", + "schema": { + "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/integrationRuntime.json#/definitions/IntegrationRuntimeResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + } + } + } + } + } + }, + "definitions": {}, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Synapse client API Version." + }, + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "IntegrationRuntimeNameParameter": { + "name": "integrationRuntimeName", + "in": "path", + "required": true, + "type": "string", + "description": "The Integration Runtime name", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/library.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/library.json new file mode 100644 index 000000000000..79d79f13b94c --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/library.json @@ -0,0 +1,514 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-12-01", + "title": "ArtifactsClient" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/libraries": { + "get": { + "tags": [ + "Library" + ], + "operationId": "Library_List", + "x-ms-examples": { + "List Libraries": { + "$ref": "./examples/Library_ListByWorkspace.json" + } + }, + "description": "Lists Library.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/LibraryListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "./artifacts.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/libraries/{libraryName}/flush": { + "post": { + "tags": [ + "Library" + ], + "operationId": "Library_Flush", + "x-ms-examples": { + "Flush Library": { + "$ref": "./examples/Library_Flush.json" + } + }, + "description": "Flush Library", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LibraryNameParameter" + } + ], + "responses": { + "200": { + "description": "Ok." + }, + "202": { + "description": "Accepted.", + "schema": { + "$ref": "#/definitions/LibraryResourceInfo" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "./artifacts.json#/definitions/CloudError" + } + } + } + } + }, + "/libraryOperationResults/{operationId}": { + "get": { + "tags": [ + "Library" + ], + "operationId": "Library_GetOperationResult", + "x-ms-examples": { + "Get Operation Result for Library": { + "$ref": "./examples/Library_GetOperationResult.json" + } + }, + "description": "Get Operation result for Library", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/OperationId" + } + ], + "responses": { + "200": { + "description": "Ok.", + "schema": { + "$ref": "#/definitions/LibraryResource" + } + }, + "202": { + "description": "Accepted.", + "schema": { + "$ref": "#/definitions/OperationResult" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "./artifacts.json#/definitions/CloudError" + } + } + } + } + }, + "/libraries/{libraryName}": { + "delete": { + "tags": [ + "Library" + ], + "operationId": "Library_Delete", + "x-ms-examples": { + "Delete Library": { + "$ref": "./examples/Library_Delete.json" + } + }, + "description": "Delete Library", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LibraryNameParameter" + } + ], + "responses": { + "200": { + "description": "Ok." + }, + "202": { + "description": "Accepted.", + "schema": { + "$ref": "#/definitions/LibraryResourceInfo" + } + }, + "409": { + "description": "Conflict." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "./artifacts.json#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "Library" + ], + "operationId": "Library_Get", + "description": "Get Library", + "x-ms-examples": { + "Get Library": { + "$ref": "./examples/Library_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LibraryNameParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/LibraryResource" + } + }, + "304": { + "description": "Not modified." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "./artifacts.json#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "Library" + ], + "operationId": "Library_Create", + "x-ms-examples": { + "Create Library": { + "$ref": "./examples/Library_Create.json" + } + }, + "description": "Creates a library with the library name.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LibraryNameParameter" + } + ], + "responses": { + "200": { + "description": "Ok." + }, + "202": { + "description": "In case of create operation, library resource information will be returned.", + "schema": { + "$ref": "#/definitions/LibraryResourceInfo" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "./artifacts.json#/definitions/CloudError" + } + } + } + } + } + }, + "x-ms-paths": { + "/libraries/{libraryName}?comp=appendblock": { + "put": { + "tags": [ + "Library" + ], + "operationId": "Library_Append", + "x-ms-examples": { + "Append Library": { + "$ref": "./examples/Library_Append.json" + } + }, + "description": "Append the content to the library resource created using the create operation. The maximum content size is 4MiB. Content larger than 4MiB must be appended in 4MiB chunks", + "consumes": [ + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LibraryNameParameter" + }, + { + "name": "content", + "in": "body", + "description": "Library file chunk.", + "required": true, + "schema": { + "format": "binary", + "type": "string" + } + }, + { + "name": "x-ms-blob-condition-appendpos", + "x-ms-client-name": "blobConditionAppendPosition", + "in": "header", + "description": "Set this header to a byte offset at which the block is expected to be appended. The request succeeds only if the current offset matches this value. Otherwise, the request fails with the AppendPositionConditionNotMet error (HTTP status code 412 – Precondition Failed)", + "required": false, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "201": { + "description": "Created." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "./artifacts.json#/definitions/CloudError" + } + } + } + }, + "parameters": [ + { + "name": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "appendblock" + ] + } + ] + } + }, + "definitions": { + "OperationResult": { + "description": "Operation status for the operation", + "type": "object", + "properties": { + "status": { + "readOnly": true, + "type": "string", + "description": "Operation status" + }, + "error": { + "x-ms-client-flatten": true, + "description": "Error data", + "$ref": "./artifacts.json#/definitions/CloudErrorBody" + } + } + }, + "LibraryListResponse": { + "description": "A list of Library resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of Library.", + "items": { + "$ref": "#/definitions/LibraryResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "LibraryResourceInfo": { + "description": "Library resource info ", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" + }, + "recordId": { + "readOnly": true, + "type": "integer", + "description": "record Id of the library/package." + }, + "state": { + "readOnly": true, + "type": "string", + "description": "Provisioning status of the library/package." + }, + "created": { + "readOnly": true, + "type": "string", + "description": "The creation time of the library/package." + }, + "changed": { + "readOnly": true, + "type": "string", + "description": "The last updated time of the library/package." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. E.g. LibraryArtifact" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the library/package." + }, + "operationId": { + "readOnly": true, + "type": "string", + "description": "Operation Id of the operation performed on library/package." + }, + "artifactId": { + "readOnly": true, + "type": "string", + "description": "artifact Id of the library/package." + } + } + }, + "LibraryResource": { + "description": "Library response details", + "type": "object", + "allOf": [ + { + "$ref": "./artifacts.json#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/LibraryResourceProperties", + "description": "Library/package properties." + } + }, + "required": [ + "properties" + ] + }, + "LibraryResourceProperties": { + "description": "Library/package properties", + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the library/package." + }, + "path": { + "readOnly": true, + "type": "string", + "description": "Location of library/package in storage account." + }, + "containerName": { + "readOnly": true, + "type": "string", + "description": "Container name of the library/package." + }, + "uploadedTimestamp": { + "readOnly": true, + "type": "string", + "description": "The last update time of the library/package." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the library/package." + }, + "provisioningStatus": { + "readOnly": true, + "type": "string", + "description": "Provisioning status of the library/package." + }, + "creatorId": { + "readOnly": true, + "type": "string", + "description": "Creator Id of the library/package." + } + } + } + }, + "parameters": { + "LibraryNameParameter": { + "name": "libraryName", + "in": "path", + "maxLength": 100, + "required": true, + "type": "string", + "description": "file name to upload. Minimum length of the filename should be 1 excluding the extension length.", + "x-ms-parameter-location": "method" + }, + "OperationId": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "operation id for which status is requested", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Synapse client API Version." + }, + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/managedPrivateEndpoints.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/managedPrivateEndpoints.json new file mode 100644 index 000000000000..0a0008d34505 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/managedPrivateEndpoints.json @@ -0,0 +1,316 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-12-01", + "title": "VnetClient" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "paths": { + "/managedVirtualNetworks/{managedVirtualNetworkName}/managedPrivateEndpoints/{managedPrivateEndpointName}": { + "get": { + "tags": [ + "ManagedPrivateEndpoints" + ], + "operationId": "ManagedPrivateEndpoints_Get", + "description": "Get Managed Private Endpoints", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ManagedVirtualNetworkNameParameter" + }, + { + "$ref": "#/parameters/ManagedPrivateEndpointNameParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/ManagedPrivateEndpoint" + }, + "description": "" + } + }, + "x-ms-examples": { + "Get a managed private endpoint": { + "$ref": "./examples/GetManagedPrivateEndpoint.json" + } + } + }, + "put": { + "tags": [ + "ManagedPrivateEndpoints" + ], + "operationId": "ManagedPrivateEndpoints_Create", + "description": "Create Managed Private Endpoints", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ManagedVirtualNetworkNameParameter" + }, + { + "$ref": "#/parameters/ManagedPrivateEndpointNameParameter" + }, + { + "name": "managedPrivateEndpoint", + "in": "body", + "required": true, + "description": "Managed private endpoint properties.", + "schema": { + "$ref": "#/definitions/ManagedPrivateEndpoint" + } + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/ManagedPrivateEndpoint" + }, + "description": "" + } + }, + "x-ms-examples": { + "Create a managed private endpoint": { + "$ref": "./examples/CreateManagedPrivateEndpoint.json" + } + } + }, + "delete": { + "tags": [ + "ManagedPrivateEndpoints" + ], + "operationId": "ManagedPrivateEndpoints_Delete", + "description": "Delete Managed Private Endpoints", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ManagedVirtualNetworkNameParameter" + }, + { + "$ref": "#/parameters/ManagedPrivateEndpointNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "Already deleted" + } + }, + "x-ms-examples": { + "Delete a managed private endpoint": { + "$ref": "./examples/DeleteManagedPrivateEndpoint.json" + } + } + } + }, + "/managedVirtualNetworks/{managedVirtualNetworkName}/managedPrivateEndpoints": { + "get": { + "tags": [ + "ManagedPrivateEndpoints" + ], + "operationId": "ManagedPrivateEndpoints_List", + "description": "List Managed Private Endpoints", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ManagedVirtualNetworkNameParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/ManagedPrivateEndpointListResponse" + }, + "description": "" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List managed private endpoints": { + "$ref": "./examples/ListManagedPrivateEndpoints.json" + } + } + } + } + }, + "definitions": { + "ManagedPrivateEndpointListResponse": { + "description": "A list of managed private endpoints", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "List of managed private endpoints", + "items": { + "$ref": "#/definitions/ManagedPrivateEndpoint" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedPrivateEndpoint": { + "description": "Managed private endpoint", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts." + }, + "properties": { + "$ref": "#/definitions/ManagedPrivateEndpointProperties", + "description": "Managed private endpoint properties" + } + } + }, + "ManagedPrivateEndpointProperties": { + "description": "Properties of a managed private endpoint", + "type": "object", + "properties": { + "name": { + "description": "The name of managed private endpoint", + "type": "string" + }, + "privateLinkResourceId": { + "description": "The ARM resource ID of the resource to which the managed private endpoint is created", + "type": "string" + }, + "groupId": { + "description": "The groupId to which the managed private endpoint is created", + "type": "string" + }, + "provisioningState": { + "description": "The managed private endpoint provisioning state", + "type": "string", + "readOnly": true + }, + "connectionState": { + "description": "The managed private endpoint connection state", + "$ref": "#/definitions/ManagedPrivateEndpointConnectionState" + }, + "isReserved": { + "description": "Denotes whether the managed private endpoint is reserved", + "type": "boolean", + "readOnly": true + }, + "fqdns": { + "description": "List of fully qualified domain names", + "type": "array", + "items": { + "type": "string" + } + }, + "isCompliant": { + "description": "Denotes whether the managed private endpoint is compliant", + "type": "boolean" + } + } + }, + "ManagedPrivateEndpointConnectionState": { + "description": "The connection state of a managed private endpoint", + "type": "object", + "properties": { + "status": { + "description": "The approval status", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The managed private endpoint description", + "type": "string" + }, + "actionsRequired": { + "description": "The actions required on the managed private endpoint", + "type": "string" + } + } + } + }, + "parameters": { + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Synapse client API Version." + }, + "ManagedVirtualNetworkNameParameter": { + "name": "managedVirtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "x-ms-client-default": "default", + "description": "Managed virtual network name", + "x-ms-parameter-location": "method" + }, + "ManagedPrivateEndpointNameParameter": { + "name": "managedPrivateEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "Managed private endpoint name", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/monitoring.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/monitoring.json new file mode 100644 index 000000000000..893fe35fdd75 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/monitoring.json @@ -0,0 +1,228 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-12-01", + "title": "MonitoringClient" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/monitoring/workloadTypes/spark/Applications": { + "get": { + "tags": [ + "Monitoring" + ], + "operationId": "Monitoring_GetSparkJobList", + "description": "Get list of spark applications for the workspace.", + "x-ms-examples": { + "Get list of spark application": { + "$ref": "./examples/Monitoring_GetSparkJobList.json" + } + }, + "parameters": [ + { + "name": "x-ms-client-request-id", + "in": "header", + "required": false, + "type": "string", + "description": "Can provide a guid, which is helpful for debugging and to provide better customer support" + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SparkJobListViewResponse" + } + } + } + } + }, + "/monitoring/workloadTypes/sql/querystring": { + "get": { + "tags": [ + "Monitoring" + ], + "operationId": "Monitoring_GetSqlJobQueryString", + "description": "Get SQL OD/DW Query for the workspace.", + "x-ms-examples": { + "Get SOL job query string": { + "$ref": "./examples/Monitoring_GetSqlJobQueryString.json" + } + }, + "parameters": [ + { + "name": "x-ms-client-request-id", + "in": "header", + "required": false, + "type": "string", + "description": "Can provide a guid, which is helpful for debugging and to provide better customer support" + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "filter", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "skip", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SqlQueryStringDataModel" + } + } + } + } + } + }, + "definitions": { + "SparkJobListViewResponse": { + "type": "object", + "properties": { + "nJobs": { + "format": "int32", + "type": "integer" + }, + "sparkJobs": { + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SparkJob" + }, + "x-nullable": true + } + } + }, + "SparkJob": { + "type": "object", + "properties": { + "state": { + "type": "string" + }, + "name": { + "type": "string" + }, + "submitter": { + "type": "string" + }, + "compute": { + "type": "string" + }, + "sparkApplicationId": { + "type": "string" + }, + "livyId": { + "type": "string" + }, + "timing": { + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "sparkJobDefinition": { + "type": "string", + "x-nullable": true + }, + "pipeline": { + "uniqueItems": false, + "x-nullable": true, + "type": "array", + "items": { + "$ref": "#/definitions/SparkJob" + } + }, + "jobType": { + "type": "string" + }, + "submitTime": { + "format": "date-time", + "type": "string", + "x-nullable": true + }, + "endTime": { + "format": "date-time", + "type": "string", + "x-nullable": true + }, + "queuedDuration": { + "type": "string" + }, + "runningDuration": { + "type": "string" + }, + "totalDuration": { + "type": "string" + } + } + }, + "SqlQueryStringDataModel": { + "type": "object", + "properties": { + "query": { + "type": "string" + } + } + } + }, + "parameters": { + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Synapse client API Version." + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/operations.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/operations.json new file mode 100644 index 000000000000..0f7865aed76a --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/operations.json @@ -0,0 +1,138 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-12-01", + "title": "ArtifactsClient" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/operationResults/{operationId}": { + "get": { + "tags": [ + "OperationResult" + ], + "operationId": "OperationResult_Get", + "description": "Get operation result", + "x-ms-examples": { + "List Sql Pools": { + "$ref": "./examples/OperationResult_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "Operation ID." + } + ], + "responses": { + "200": { + "description": "" + }, + "201": { + "description": "" + }, + "202": { + "description": "" + }, + "204": { + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + }, + "description": "" + } + } + } + }, + "/operationStatuses/{operationId}": { + "get": { + "tags": [ + "OperationResult" + ], + "operationId": "OperationStatus_Get", + "description": "Get operation status", + "x-ms-examples": { + "List Sql Pools": { + "$ref": "./examples/OperationStatus_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "Operation ID." + } + ], + "responses": { + "200": { + "description": "" + }, + "201": { + "description": "" + }, + "202": { + "description": "" + }, + "204": { + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + }, + "description": "" + } + } + } + } + }, + "definitions": {}, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Synapse client API Version." + }, + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/roleAssignments.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/roleAssignments.json new file mode 100644 index 000000000000..1af934dd94a8 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/roleAssignments.json @@ -0,0 +1,348 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-12-01", + "title": "AccessControlClient" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "paths": { + "/roleAssignments": { + "get": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_ListRoleAssignments", + "description": "List role assignments.", + "x-ms-examples": { + "List role assignments": { + "$ref": "./examples/RoleAssignments_ListRoleAssignments.json" + } + }, + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/RoleIdQueryParameter" + }, + { + "$ref": "#/parameters/PrincipalIdParameter" + }, + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/XMsContinuationToken" + } + ], + "responses": { + "200": { + "description": "Success response.", + "headers": { + "x-ms-continuation": { + "description": "If the number of role assignments to be listed exceeds the maxResults limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the role assignments.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/RoleAssignmentDetailsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + } + } + } + } + }, + "/roleAssignments/{roleAssignmentId}": { + "put": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_CreateRoleAssignment", + "description": "Create role assignment.", + "x-ms-examples": { + "Create role assignment": { + "$ref": "./examples/RoleAssignments_CreateRoleAssignment.json" + } + }, + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "request", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "description": "Details of role id, scope and object id.", + "schema": { + "$ref": "#/definitions/RoleAssignmentRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/RoleAssignmentIdParameter" + } + ], + "responses": { + "200": { + "description": "Success response.", + "schema": { + "$ref": "#/definitions/RoleAssignmentDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + } + } + } + }, + "get": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_GetRoleAssignmentById", + "description": "Get role assignment by role assignment Id.", + "x-ms-examples": { + "Get role assignment information": { + "$ref": "./examples/RoleAssignments_GetRoleAssignmentById.json" + } + }, + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/RoleAssignmentIdParameter" + } + ], + "responses": { + "200": { + "description": "Success response.", + "schema": { + "$ref": "#/definitions/RoleAssignmentDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + } + } + } + }, + "delete": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_DeleteRoleAssignmentById", + "description": "Delete role assignment by role assignment Id.", + "x-ms-examples": { + "Delete role assignment": { + "$ref": "./examples/RoleAssignments_DeleteRoleAssignmentById.json" + } + }, + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/RoleAssignmentIdParameter" + }, + { + "$ref": "#/parameters/ScopeParameter" + } + ], + "responses": { + "200": { + "description": "Success response." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + } + } + } + } + } + }, + "definitions": { + "RoleAssignmentRequest": { + "description": "Role Assignment request details", + "type": "object", + "required": [ + "roleId", + "principalId", + "scope" + ], + "properties": { + "roleId": { + "description": "Role ID of the Synapse Built-In Role", + "format": "uuid", + "type": "string" + }, + "principalId": { + "description": "Object ID of the AAD principal or security-group", + "format": "uuid", + "type": "string" + }, + "scope": { + "description": "Scope at which the role assignment is created", + "type": "string" + }, + "principalType": { + "description": "Type of the principal Id: User, Group or ServicePrincipal", + "type": "string" + } + } + }, + "RoleAssignmentDetailsList": { + "description": "Role Assignment response details", + "type": "object", + "properties": { + "count": { + "description": "Number of role assignments", + "type": "integer" + }, + "value": { + "description": "A list of role assignments", + "type": "array", + "items": { + "$ref": "#/definitions/RoleAssignmentDetails" + } + } + } + }, + "RoleAssignmentDetails": { + "description": "Role Assignment response details", + "type": "object", + "properties": { + "id": { + "description": "Role Assignment ID", + "type": "string" + }, + "roleDefinitionId": { + "description": "Role ID of the Synapse Built-In Role", + "format": "uuid", + "type": "string" + }, + "principalId": { + "description": "Object ID of the AAD principal or security-group", + "format": "uuid", + "type": "string" + }, + "scope": { + "description": "Scope at the role assignment is created", + "type": "string" + }, + "principalType": { + "description": "Type of the principal Id: User, Group or ServicePrincipal", + "type": "string" + } + } + } + }, + "parameters": { + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Synapse client API Version." + }, + "RoleIdQueryParameter": { + "name": "roleId", + "in": "query", + "required": false, + "type": "string", + "description": "Synapse Built-In Role Id.", + "x-ms-parameter-location": "method" + }, + "PrincipalIdParameter": { + "name": "principalId", + "in": "query", + "required": false, + "type": "string", + "description": "Object ID of the AAD principal or security-group.", + "x-ms-parameter-location": "method" + }, + "RoleAssignmentIdParameter": { + "name": "roleAssignmentId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the role assignment.", + "minLength": 1, + "x-ms-parameter-location": "method" + }, + "ScopeParameter": { + "name": "scope", + "in": "query", + "required": false, + "type": "string", + "description": "Scope of the Synapse Built-in Role.", + "x-ms-parameter-location": "method" + }, + "XMsContinuationToken": { + "name": "x-ms-continuation", + "x-ms-client-name": "continuationToken", + "in": "header", + "required": false, + "type": "string", + "description": "Continuation token.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/roleDefinitions.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/roleDefinitions.json new file mode 100644 index 000000000000..4fb3ee0b1ee0 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/roleDefinitions.json @@ -0,0 +1,275 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-12-01", + "title": "AccessControlClient" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "paths": { + "/roleDefinitions": { + "get": { + "tags": [ + "SynapseRoleDefinitions" + ], + "operationId": "RoleDefinitions_ListRoleDefinitions", + "description": "List role definitions.", + "x-ms-examples": { + "List role definitions": { + "$ref": "./examples/RoleDefinitions_ListRoleDefinitions.json" + } + }, + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IsBuiltInParameter" + }, + { + "$ref": "#/parameters/ScopeParameter" + } + ], + "responses": { + "200": { + "description": "Success response.", + "schema": { + "$ref": "#/definitions/RoleDefinitionsListResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + } + } + } + } + }, + "/roleDefinitions/{roleDefinitionId}": { + "get": { + "tags": [ + "SynapseRoleDefinitions" + ], + "operationId": "RoleDefinitions_GetRoleDefinitionById", + "description": "Get role definition by role definition Id.", + "x-ms-examples": { + "Get role definition information": { + "$ref": "./examples/RoleDefinitions_GetRoleDefinitionById.json" + } + }, + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/RoleDefinitionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success response.", + "schema": { + "$ref": "#/definitions/SynapseRoleDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + } + } + } + } + }, + "/rbacScopes": { + "get": { + "tags": [ + "SynapseRbacScopes" + ], + "operationId": "RoleDefinitions_ListScopes", + "description": "List rbac scopes.", + "x-ms-examples": { + "List rbac scopes": { + "$ref": "./examples/RoleDefinitions_ListScopes.json" + } + }, + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success response.", + "schema": { + "description": "A list of Synapse rbac scopes available.", + "type": "array", + "items": { + "description": "Synapse rbac scope.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + } + } + } + } + } + }, + "definitions": { + "RoleDefinitionsListResponse": { + "description": "A list of Synapse roles available.", + "type": "array", + "items": { + "$ref": "#/definitions/SynapseRoleDefinition" + } + }, + "SynapseRoleDefinition": { + "description": "Synapse role definition details", + "type": "object", + "properties": { + "id": { + "description": "Role Definition ID", + "format": "uuid", + "type": "string" + }, + "name": { + "description": "Name of the Synapse role", + "type": "string" + }, + "isBuiltIn": { + "description": "Is a built-in role or not", + "type": "boolean" + }, + "description": { + "description": "Description for the Synapse role", + "type": "string" + }, + "permissions": { + "description": "Permissions for the Synapse role", + "type": "array", + "items": { + "$ref": "#/definitions/SynapseRbacPermission" + } + }, + "scopes": { + "description": "Allowed scopes for the Synapse role", + "type": "array", + "items": { + "type": "string" + } + }, + "availabilityStatus": { + "description": "Availability of the Synapse role", + "type": "string" + } + } + }, + "SynapseRbacPermission": { + "description": "Synapse role definition details", + "type": "object", + "properties": { + "actions": { + "description": "List of actions", + "type": "array", + "items": { + "type": "string" + } + }, + "notActions": { + "description": "List of Not actions", + "type": "array", + "items": { + "type": "string" + } + }, + "dataActions": { + "description": "List of data actions", + "type": "array", + "items": { + "type": "string" + } + }, + "notDataActions": { + "description": "List of Not data actions", + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "parameters": { + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Synapse client API Version." + }, + "RoleDefinitionIdParameter": { + "name": "roleDefinitionId", + "in": "path", + "required": true, + "type": "string", + "description": "Synapse Built-In Role Definition Id.", + "x-ms-parameter-location": "method" + }, + "IsBuiltInParameter": { + "name": "isBuiltIn", + "in": "query", + "required": false, + "type": "boolean", + "description": "Is a Synapse Built-In Role or not.", + "x-ms-parameter-location": "method" + }, + "ScopeParameter": { + "name": "scope", + "in": "query", + "required": false, + "type": "string", + "description": "Scope of the Synapse Built-in Role.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/sparkJob.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/sparkJob.json new file mode 100644 index 000000000000..ec76548d115e --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/sparkJob.json @@ -0,0 +1,1575 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-12-01", + "title": "SparkClient", + "x-ms-code-generation-settings": { + "useDateTimeOffset": true + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/batches": { + "get": { + "tags": [ + "SparkBatch" + ], + "description": "List all spark batch jobs which are running under a particular spark pool.", + "operationId": "SparkBatch_GetSparkBatchJobs", + "x-ms-examples": { + "List all spark batch jobs": { + "$ref": "./examples/SparkFrontend_SparkBatch_List.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/LivyApiVersion" + }, + { + "$ref": "#/parameters/SparkPoolName" + }, + { + "name": "from", + "in": "query", + "description": "Optional param specifying which index the list should begin from.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "size", + "in": "query", + "description": "Optional param specifying the size of the returned list.\r\n By default it is 20 and that is the maximum.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "detailed", + "in": "query", + "description": "Optional query param specifying whether detailed response is returned beyond plain livy.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SparkBatchJobCollection" + } + } + } + }, + "post": { + "tags": [ + "SparkBatch" + ], + "description": "Create new spark batch job.", + "operationId": "SparkBatch_CreateSparkBatchJob", + "x-ms-examples": { + "Create new spark batch job.": { + "$ref": "./examples/SparkFrontend_SparkBatch_Create.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/LivyApiVersion" + }, + { + "$ref": "#/parameters/SparkPoolName" + }, + { + "name": "detailed", + "in": "query", + "description": "Optional query param specifying whether detailed response is returned beyond plain livy.", + "required": false, + "type": "boolean" + }, + { + "name": "sparkBatchJobOptions", + "in": "body", + "description": "Livy compatible batch job request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/SparkBatchJobOptions" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SparkBatchJob" + } + } + } + } + }, + "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/batches/{batchId}": { + "get": { + "tags": [ + "SparkBatch" + ], + "description": "Gets a single spark batch job.", + "operationId": "SparkBatch_GetSparkBatchJob", + "x-ms-examples": { + "Gets a single spark batch job.": { + "$ref": "./examples/SparkFrontend_SparkBatch_Get.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/LivyApiVersion" + }, + { + "$ref": "#/parameters/SparkPoolName" + }, + { + "name": "batchId", + "in": "path", + "description": "Identifier for the batch job.", + "required": true, + "type": "integer", + "format": "int32" + }, + { + "name": "detailed", + "in": "query", + "description": "Optional query param specifying whether detailed response is returned beyond plain livy.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SparkBatchJob" + } + } + } + }, + "delete": { + "tags": [ + "SparkBatch" + ], + "description": "Cancels a running spark batch job.", + "operationId": "SparkBatch_CancelSparkBatchJob", + "x-ms-examples": { + "Cancels a running spark batch job.": { + "$ref": "./examples/SparkFrontend_SparkBatch_Delete.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/LivyApiVersion" + }, + { + "$ref": "#/parameters/SparkPoolName" + }, + { + "name": "batchId", + "in": "path", + "description": "Identifier for the batch job.", + "required": true, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions": { + "get": { + "tags": [ + "SparkSession" + ], + "description": "List all spark sessions which are running under a particular spark pool.", + "operationId": "SparkSession_GetSparkSessions", + "x-ms-examples": { + "List all spark session jobs": { + "$ref": "./examples/SparkFrontend_SparkSession_List.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/LivyApiVersion" + }, + { + "$ref": "#/parameters/SparkPoolName" + }, + { + "name": "from", + "in": "query", + "description": "Optional param specifying which index the list should begin from.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "size", + "in": "query", + "description": "Optional param specifying the size of the returned list.\r\n By default it is 20 and that is the maximum.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "detailed", + "in": "query", + "description": "Optional query param specifying whether detailed response is returned beyond plain livy.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SparkSessionCollection" + } + } + } + }, + "post": { + "tags": [ + "SparkSession" + ], + "description": "Create new spark session.", + "operationId": "SparkSession_CreateSparkSession", + "x-ms-examples": { + "Create new spark session.": { + "$ref": "./examples/SparkFrontend_SparkSession_Create.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/LivyApiVersion" + }, + { + "$ref": "#/parameters/SparkPoolName" + }, + { + "name": "detailed", + "in": "query", + "description": "Optional query param specifying whether detailed response is returned beyond plain livy.", + "required": false, + "type": "boolean" + }, + { + "name": "SparkSessionOptions", + "in": "body", + "description": "Livy compatible batch job request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/SparkSessionOptions" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SparkSession" + } + } + } + } + }, + "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions/{sessionId}": { + "get": { + "tags": [ + "SparkSession" + ], + "description": "Gets a single spark session.", + "operationId": "SparkSession_GetSparkSession", + "x-ms-examples": { + "Gets a single spark session.": { + "$ref": "./examples/SparkFrontend_SparkSession_Get.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/LivyApiVersion" + }, + { + "$ref": "#/parameters/SparkPoolName" + }, + { + "name": "sessionId", + "in": "path", + "description": "Identifier for the session.", + "required": true, + "type": "integer", + "format": "int32" + }, + { + "name": "detailed", + "in": "query", + "description": "Optional query param specifying whether detailed response is returned beyond plain livy.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SparkSession" + } + } + } + }, + "delete": { + "tags": [ + "SparkSession" + ], + "description": "Cancels a running spark session.", + "operationId": "SparkSession_CancelSparkSession", + "x-ms-examples": { + "Cancels a running spark session.": { + "$ref": "./examples/SparkFrontend_SparkSession_Delete.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/LivyApiVersion" + }, + { + "$ref": "#/parameters/SparkPoolName" + }, + { + "name": "sessionId", + "in": "path", + "description": "Identifier for the session.", + "required": true, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions/{sessionId}/reset-timeout": { + "put": { + "tags": [ + "SparkSession" + ], + "description": "Sends a keep alive call to the current session to reset the session timeout.", + "operationId": "SparkSession_ResetSparkSessionTimeout", + "x-ms-examples": { + "Reset the session timeout.": { + "$ref": "./examples/SparkFrontend_SparkSession_ResetTimeout.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/LivyApiVersion" + }, + { + "$ref": "#/parameters/SparkPoolName" + }, + { + "name": "sessionId", + "in": "path", + "description": "Identifier for the session.", + "required": true, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Success" + } + } + } + }, + "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions/{sessionId}/statements": { + "get": { + "tags": [ + "SparkSession" + ], + "description": "Gets a list of statements within a spark session.", + "operationId": "SparkSession_GetSparkStatements", + "x-ms-examples": { + "Gets a list of statements within a spark session.": { + "$ref": "./examples/SparkFrontend_SparkSession_ListStatements.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/LivyApiVersion" + }, + { + "$ref": "#/parameters/SparkPoolName" + }, + { + "name": "sessionId", + "in": "path", + "description": "Identifier for the session.", + "required": true, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SparkStatementCollection" + } + } + } + }, + "post": { + "tags": [ + "SparkSession" + ], + "description": "Create statement within a spark session.", + "operationId": "SparkSession_CreateSparkStatement", + "x-ms-examples": { + "Create statement within a spark session.": { + "$ref": "./examples/SparkFrontend_SparkSession_CreateStatement.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/LivyApiVersion" + }, + { + "$ref": "#/parameters/SparkPoolName" + }, + { + "name": "sessionId", + "in": "path", + "description": "Identifier for the session.", + "required": true, + "type": "integer", + "format": "int32" + }, + { + "name": "SparkStatementOptions", + "in": "body", + "description": "Livy compatible batch job request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/SparkStatementOptions" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SparkStatement" + } + } + } + } + }, + "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions/{sessionId}/statements/{statementId}": { + "get": { + "tags": [ + "SparkSession" + ], + "description": "Gets a single statement within a spark session.", + "operationId": "SparkSession_GetSparkStatement", + "x-ms-examples": { + "Gets a single statement within a spark session.": { + "$ref": "./examples/SparkFrontend_SparkSession_GetStatement.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/LivyApiVersion" + }, + { + "$ref": "#/parameters/SparkPoolName" + }, + { + "name": "sessionId", + "in": "path", + "description": "Identifier for the session.", + "required": true, + "type": "integer", + "format": "int32" + }, + { + "name": "statementId", + "in": "path", + "description": "Identifier for the statement.", + "required": true, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SparkStatement" + } + } + } + } + }, + "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions/{sessionId}/statements/{statementId}/cancel": { + "post": { + "tags": [ + "SparkSession" + ], + "description": "Kill a statement within a session.", + "operationId": "SparkSession_CancelSparkStatement", + "x-ms-examples": { + "Kill a statement within a session.": { + "$ref": "./examples/SparkFrontend_SparkSession_DeleteStatement.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/LivyApiVersion" + }, + { + "$ref": "#/parameters/SparkPoolName" + }, + { + "name": "sessionId", + "in": "path", + "description": "Identifier for the session.", + "required": true, + "type": "integer", + "format": "int32" + }, + { + "name": "statementId", + "in": "path", + "description": "Identifier for the statement.", + "required": true, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SparkStatementCancellationResult" + } + } + } + } + } + }, + "definitions": { + "SparkBatchJobCollection": { + "type": "object", + "properties": { + "from": { + "format": "int32", + "type": "integer", + "description": "The start index of fetched sessions." + }, + "total": { + "format": "int32", + "type": "integer", + "description": "Number of sessions fetched." + }, + "sessions": { + "uniqueItems": false, + "type": "array", + "description": "Batch list", + "items": { + "$ref": "#/definitions/SparkBatchJob" + } + } + }, + "required": [ + "from", + "total" + ], + "description": "Response for batch list operation." + }, + "SparkBatchJob": { + "type": "object", + "properties": { + "livyInfo": { + "$ref": "#/definitions/SparkBatchJobState" + }, + "name": { + "type": "string", + "description": "The batch name." + }, + "workspaceName": { + "type": "string", + "description": "The workspace name." + }, + "sparkPoolName": { + "type": "string", + "description": "The Spark pool name." + }, + "submitterName": { + "type": "string", + "description": "The submitter name." + }, + "submitterId": { + "type": "string", + "description": "The submitter identifier." + }, + "artifactId": { + "type": "string", + "description": "The artifact identifier." + }, + "jobType": { + "enum": [ + "SparkBatch", + "SparkSession" + ], + "x-ms-enum": { + "name": "SparkJobType", + "modelAsString": true + }, + "type": "string", + "description": "The job type." + }, + "result": { + "enum": [ + "Uncertain", + "Succeeded", + "Failed", + "Cancelled" + ], + "x-ms-enum": { + "name": "SparkBatchJobResultType", + "modelAsString": true + }, + "type": "string", + "description": "The Spark batch job result." + }, + "schedulerInfo": { + "x-ms-client-name": "scheduler", + "$ref": "#/definitions/SparkScheduler", + "description": "The scheduler information." + }, + "pluginInfo": { + "x-ms-client-name": "plugin", + "$ref": "#/definitions/SparkServicePlugin", + "description": "The plugin information." + }, + "errorInfo": { + "x-ms-client-name": "errors", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SparkServiceError" + }, + "description": "The error information." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags." + }, + "id": { + "format": "int32", + "type": "integer", + "description": "The session Id." + }, + "appId": { + "type": "string", + "description": "The application id of this session", + "x-nullable": true + }, + "appInfo": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The detailed application info.", + "x-nullable": true + }, + "state": { + "type": "string", + "description": "The batch state" + }, + "log": { + "x-ms-client-name": "logLines", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "description": "The log lines.", + "x-nullable": true + } + }, + "required": [ + "id" + ] + }, + "SparkBatchJobState": { + "type": "object", + "properties": { + "notStartedAt": { + "format": "date-time", + "type": "string", + "description": "the time that at which \"not_started\" livy state was first seen.", + "x-nullable": true + }, + "startingAt": { + "format": "date-time", + "type": "string", + "description": "the time that at which \"starting\" livy state was first seen.", + "x-nullable": true + }, + "runningAt": { + "format": "date-time", + "type": "string", + "description": "the time that at which \"running\" livy state was first seen.", + "x-nullable": true + }, + "deadAt": { + "format": "date-time", + "type": "string", + "description": "time that at which \"dead\" livy state was first seen.", + "x-nullable": true + }, + "successAt": { + "format": "date-time", + "type": "string", + "description": "the time that at which \"success\" livy state was first seen.", + "x-nullable": true + }, + "killedAt": { + "x-ms-client-name": "terminatedAt", + "format": "date-time", + "type": "string", + "description": "the time that at which \"killed\" livy state was first seen.", + "x-nullable": true + }, + "recoveringAt": { + "format": "date-time", + "type": "string", + "description": "the time that at which \"recovering\" livy state was first seen.", + "x-nullable": true + }, + "currentState": { + "type": "string", + "description": "the Spark job state." + }, + "jobCreationRequest": { + "$ref": "#/definitions/SparkRequest" + } + } + }, + "SparkScheduler": { + "type": "object", + "properties": { + "submittedAt": { + "format": "date-time", + "type": "string", + "x-nullable": true + }, + "scheduledAt": { + "format": "date-time", + "type": "string", + "x-nullable": true + }, + "endedAt": { + "format": "date-time", + "type": "string", + "x-nullable": true + }, + "cancellationRequestedAt": { + "format": "date-time", + "type": "string", + "x-nullable": true + }, + "currentState": { + "enum": [ + "Queued", + "Scheduled", + "Ended" + ], + "x-ms-enum": { + "name": "SchedulerCurrentState", + "modelAsString": true + }, + "type": "string" + } + } + }, + "SparkServicePlugin": { + "type": "object", + "properties": { + "preparationStartedAt": { + "format": "date-time", + "type": "string", + "x-nullable": true + }, + "resourceAcquisitionStartedAt": { + "format": "date-time", + "type": "string", + "x-nullable": true + }, + "submissionStartedAt": { + "format": "date-time", + "type": "string", + "x-nullable": true + }, + "monitoringStartedAt": { + "format": "date-time", + "type": "string", + "x-nullable": true + }, + "cleanupStartedAt": { + "format": "date-time", + "type": "string", + "x-nullable": true + }, + "currentState": { + "enum": [ + "Preparation", + "ResourceAcquisition", + "Queued", + "Submission", + "Monitoring", + "Cleanup", + "Ended" + ], + "x-ms-enum": { + "name": "PluginCurrentState", + "modelAsString": true + }, + "type": "string" + } + } + }, + "SparkServiceError": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "errorCode": { + "type": "string" + }, + "source": { + "enum": [ + "System", + "User", + "Unknown", + "Dependency" + ], + "x-ms-enum": { + "name": "SparkErrorSource", + "modelAsString": true + }, + "type": "string" + } + } + }, + "SparkRequest": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "file": { + "type": "string" + }, + "className": { + "type": "string" + }, + "args": { + "x-ms-client-name": "arguments", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "jars": { + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "pyFiles": { + "x-ms-client-name": "pythonFiles", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "files": { + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "archives": { + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "conf": { + "x-ms-client-name": "configuration", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "driverMemory": { + "type": "string" + }, + "driverCores": { + "format": "int32", + "type": "integer" + }, + "executorMemory": { + "type": "string" + }, + "executorCores": { + "format": "int32", + "type": "integer" + }, + "numExecutors": { + "x-ms-client-name": "executorCount", + "format": "int32", + "type": "integer" + } + } + }, + "SparkBatchJobOptions": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "artifactId": { + "type": "string" + }, + "name": { + "type": "string" + }, + "file": { + "type": "string" + }, + "className": { + "type": "string" + }, + "args": { + "x-ms-client-name": "arguments", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "jars": { + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "pyFiles": { + "x-ms-client-name": "pythonFiles", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "files": { + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "archives": { + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "conf": { + "x-ms-client-name": "configuration", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "driverMemory": { + "type": "string" + }, + "driverCores": { + "format": "int32", + "type": "integer" + }, + "executorMemory": { + "type": "string" + }, + "executorCores": { + "format": "int32", + "type": "integer" + }, + "numExecutors": { + "x-ms-client-name": "executorCount", + "format": "int32", + "type": "integer" + } + }, + "required": [ + "name", + "file" + ] + }, + "SparkSessionCollection": { + "type": "object", + "properties": { + "from": { + "format": "int32", + "type": "integer" + }, + "total": { + "format": "int32", + "type": "integer" + }, + "sessions": { + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SparkSession" + } + } + }, + "required": [ + "from", + "total" + ] + }, + "SparkSession": { + "type": "object", + "properties": { + "livyInfo": { + "$ref": "#/definitions/SparkSessionState" + }, + "name": { + "type": "string" + }, + "workspaceName": { + "type": "string" + }, + "sparkPoolName": { + "type": "string" + }, + "submitterName": { + "type": "string" + }, + "submitterId": { + "type": "string" + }, + "artifactId": { + "type": "string" + }, + "jobType": { + "enum": [ + "SparkBatch", + "SparkSession" + ], + "x-ms-enum": { + "name": "SparkJobType", + "modelAsString": true + }, + "type": "string" + }, + "result": { + "enum": [ + "Uncertain", + "Succeeded", + "Failed", + "Cancelled" + ], + "x-ms-enum": { + "name": "SparkSessionResultType", + "modelAsString": true + }, + "type": "string" + }, + "schedulerInfo": { + "x-ms-client-name": "scheduler", + "$ref": "#/definitions/SparkScheduler" + }, + "pluginInfo": { + "x-ms-client-name": "plugin", + "$ref": "#/definitions/SparkServicePlugin" + }, + "errorInfo": { + "x-ms-client-name": "errors", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SparkServiceError" + } + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "id": { + "format": "int32", + "type": "integer" + }, + "appId": { + "type": "string", + "x-nullable": true + }, + "appInfo": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-nullable": true + }, + "state": { + "type": "string" + }, + "log": { + "x-ms-client-name": "logLines", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + }, + "x-nullable": true + } + }, + "required": [ + "id" + ] + }, + "SparkSessionState": { + "type": "object", + "properties": { + "notStartedAt": { + "format": "date-time", + "type": "string", + "x-nullable": true + }, + "startingAt": { + "format": "date-time", + "type": "string", + "x-nullable": true + }, + "idleAt": { + "format": "date-time", + "type": "string", + "x-nullable": true + }, + "deadAt": { + "format": "date-time", + "type": "string", + "x-nullable": true + }, + "shuttingDownAt": { + "format": "date-time", + "type": "string", + "x-nullable": true + }, + "killedAt": { + "x-ms-client-name": "terminatedAt", + "format": "date-time", + "type": "string", + "x-nullable": true + }, + "recoveringAt": { + "format": "date-time", + "type": "string", + "x-nullable": true + }, + "busyAt": { + "format": "date-time", + "type": "string", + "x-nullable": true + }, + "errorAt": { + "format": "date-time", + "type": "string", + "x-nullable": true + }, + "currentState": { + "type": "string" + }, + "jobCreationRequest": { + "$ref": "#/definitions/SparkRequest" + } + } + }, + "SparkSessionOptions": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "artifactId": { + "type": "string" + }, + "name": { + "type": "string" + }, + "file": { + "type": "string" + }, + "className": { + "type": "string" + }, + "args": { + "x-ms-client-name": "arguments", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "jars": { + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "pyFiles": { + "x-ms-client-name": "pythonFiles", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "files": { + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "archives": { + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "conf": { + "x-ms-client-name": "configuration", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "driverMemory": { + "type": "string" + }, + "driverCores": { + "format": "int32", + "type": "integer" + }, + "executorMemory": { + "type": "string" + }, + "executorCores": { + "format": "int32", + "type": "integer" + }, + "numExecutors": { + "x-ms-client-name": "executorCount", + "format": "int32", + "type": "integer" + } + }, + "required": [ + "name" + ] + }, + "SparkStatementCollection": { + "type": "object", + "properties": { + "total_statements": { + "x-ms-client-name": "total", + "format": "int32", + "type": "integer" + }, + "statements": { + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SparkStatement" + } + } + }, + "required": [ + "total_statements" + ] + }, + "SparkStatement": { + "type": "object", + "properties": { + "id": { + "format": "int32", + "type": "integer" + }, + "code": { + "type": "string" + }, + "state": { + "type": "string" + }, + "output": { + "$ref": "#/definitions/SparkStatementOutput", + "x-nullable": true + } + }, + "required": [ + "id" + ] + }, + "SparkStatementOutput": { + "type": "object", + "properties": { + "status": { + "type": "string" + }, + "execution_count": { + "format": "int32", + "type": "integer" + }, + "data": { + "type": "object" + }, + "ename": { + "x-ms-client-name": "errorName", + "type": "string", + "x-nullable": true + }, + "evalue": { + "x-ms-client-name": "errorValue", + "type": "string", + "x-nullable": true + }, + "traceback": { + "uniqueItems": false, + "type": "array", + "x-nullable": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "execution_count" + ] + }, + "SparkStatementOptions": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "kind": { + "enum": [ + "spark", + "pyspark", + "dotnetspark", + "sql" + ], + "x-ms-enum": { + "name": "SparkStatementLanguageType", + "modelAsString": true, + "values": [ + { + "name": "Spark", + "value": "spark" + }, + { + "name": "PySpark", + "value": "pyspark" + }, + { + "name": "DotNetSpark", + "value": "dotnetspark" + }, + { + "name": "Sql", + "value": "sql" + } + ] + }, + "type": "string" + } + } + }, + "SparkStatementCancellationResult": { + "type": "object", + "properties": { + "msg": { + "type": "string", + "x-ms-client-name": "message", + "description": "The msg property from the Livy API. The value is always \"canceled\"." + } + } + } + }, + "parameters": { + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "LivyApiVersion": { + "name": "livyApiVersion", + "in": "path", + "description": "Valid api-version for the request.", + "required": true, + "type": "string", + "default": "2019-11-01-preview", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "SparkPoolName": { + "name": "sparkPoolName", + "in": "path", + "description": "Name of the spark pool.", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/sqlPools.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/sqlPools.json new file mode 100644 index 000000000000..b34274dd0350 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/sqlPools.json @@ -0,0 +1,123 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-12-01", + "title": "ArtifactsClient" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/sqlPools": { + "get": { + "tags": [ + "SqlPools" + ], + "operationId": "SqlPools_List", + "description": "List Sql Pools", + "x-ms-examples": { + "List Sql Pools": { + "$ref": "./examples/SqlPools_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success response.", + "schema": { + "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/sqlPool.json#/definitions/SqlPoolInfoListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + } + } + } + } + }, + "/sqlPools/{sqlPoolName}": { + "get": { + "tags": [ + "SqlPools" + ], + "operationId": "SqlPools_Get", + "description": "Get Sql Pool", + "x-ms-examples": { + "List Sql Pools": { + "$ref": "./examples/SqlPools_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SqlPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Success response.", + "schema": { + "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/sqlPool.json#/definitions/SqlPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + } + } + } + } + } + }, + "definitions": {}, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Synapse client API Version." + }, + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "SqlPoolNameParameter": { + "name": "sqlPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The Sql Pool name", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/workspace.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/workspace.json new file mode 100644 index 000000000000..018b2aff2c43 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/workspace.json @@ -0,0 +1,79 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-12-01", + "title": "ArtifactsClient" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/workspace": { + "get": { + "tags": [ + "Workspace" + ], + "operationId": "Workspace_Get", + "description": "Get Workspace", + "x-ms-examples": { + "Get Workspace Information": { + "$ref": "./examples/Workspace_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success response.", + "schema": { + "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + } + } + } + } + } + }, + "definitions": {}, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Synapse client API Version." + }, + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/synapse/data-plane/readme.go.md b/specification/synapse/data-plane/readme.go.md index 0e4fc0b59ddb..e59e46a56129 100644 --- a/specification/synapse/data-plane/readme.go.md +++ b/specification/synapse/data-plane/readme.go.md @@ -40,6 +40,16 @@ namespace: artifacts output-folder: $(go-sdk-folder)/services/preview/synapse/2019-06-01-preview/$(namespace) ``` +### Tag: package-artifacts-2021-06-01-preview and go + +These settings apply only when `--tag=package-artifacts-2021-06-01-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-artifacts-2021-06-01-preview' && $(go) +namespace: artifacts +output-folder: $(go-sdk-folder)/services/preview/synapse/2021-06-01-preview/$(namespace) +``` + ### Tag: package-access-control-2020-02-01-preview and go These settings apply only when `--tag=package-access-control-2020-02-01-preview --go` is specified on the command line. @@ -78,4 +88,4 @@ Please also specify `--go-sdk-folder= in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.\r\n\r\nFor example:\r\nSELECT on dbo.myTable by public\r\nSELECT on DATABASE::myDatabase by public\r\nSELECT on SCHEMA::mySchema by public\r\n\r\nFor more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)", + "type": "array", + "items": { + "type": "string" + } + }, + "storageAccountSubscriptionId": { + "format": "uuid", + "description": "Specifies the blob storage subscription Id.", + "type": "string" + }, + "isStorageSecondaryKeyInUse": { + "description": "Specifies whether storageAccountAccessKey value is the storage's secondary key.", + "type": "boolean" + }, + "isAzureMonitorTargetEnabled": { + "description": "Specifies whether audit events are sent to Azure Monitor. \r\nIn order to send the events to Azure Monitor, specify 'state' as 'Enabled' and 'isAzureMonitorTargetEnabled' as true.\r\n\r\nWhen using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.\r\nNote that for server level audit you should use the 'master' database as {databaseName}.\r\n\r\nDiagnostic Settings URI format:\r\nPUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview\r\n\r\nFor more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)\r\nor [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)\r\n", + "type": "boolean" + } + } + }, + "SqlPoolBlobAuditingPolicy": { + "description": "A Sql pool blob auditing policy.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "kind": { + "description": "Resource kind.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/SqlPoolBlobAuditingPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "SqlPoolBlobAuditingPolicySqlPoolOperationListResult": { + "description": "The response to a list Sql pool operations request", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlPoolOperation" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "SqlPoolOperationProperties": { + "description": "The properties of a Sql pool operation.", + "type": "object", + "properties": { + "databaseName": { + "description": "The name of the Sql pool the operation is being performed on.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "The name of operation.", + "type": "string", + "readOnly": true + }, + "operationFriendlyName": { + "description": "The friendly name of operation.", + "type": "string", + "readOnly": true + }, + "percentComplete": { + "format": "int32", + "description": "The percentage of the operation completed.", + "type": "integer", + "readOnly": true + }, + "serverName": { + "description": "The name of the server.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "The operation start time.", + "type": "string", + "readOnly": true + }, + "state": { + "description": "The operation state.", + "enum": [ + "Pending", + "InProgress", + "Succeeded", + "Failed", + "CancelInProgress", + "Cancelled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ManagementOperationState", + "modelAsString": true + } + }, + "errorCode": { + "format": "int32", + "description": "The operation error code.", + "type": "integer", + "readOnly": true + }, + "errorDescription": { + "description": "The operation error description.", + "type": "string", + "readOnly": true + }, + "errorSeverity": { + "format": "int32", + "description": "The operation error severity.", + "type": "integer", + "readOnly": true + }, + "isUserError": { + "description": "Whether or not the error is a user error.", + "type": "boolean", + "readOnly": true + }, + "estimatedCompletionTime": { + "format": "date-time", + "description": "The estimated completion time of the operation.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The operation description.", + "type": "string", + "readOnly": true + }, + "isCancellable": { + "description": "Whether the operation can be cancelled.", + "type": "boolean", + "readOnly": true + } + } + }, + "SqlPoolOperation": { + "description": "A Sql pool operation.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlPoolOperationProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "SqlPoolUsage": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the usage metric." + }, + "resourceName": { + "readOnly": true, + "type": "string", + "description": "The name of the resource." + }, + "displayName": { + "readOnly": true, + "type": "string", + "description": "The usage metric display name." + }, + "currentValue": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The current value of the usage metric." + }, + "limit": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The current limit of the usage metric." + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "The units of the usage metric." + }, + "nextResetTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The next reset time for the usage metric (ISO8601 format)." + } + }, + "description": "The Sql pool usages." + }, + "SqlPoolUsageListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SqlPoolUsage" + }, + "description": "The list of usages for the Sql pool." + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + }, + "required": [ + "value" + ], + "description": "The response to a list Sql pool usages request." + }, + "SensitivityLabelProperties": { + "description": "Properties of a sensitivity label.", + "type": "object", + "properties": { + "schemaName": { + "description": "The schema name.", + "type": "string", + "readOnly": true + }, + "tableName": { + "description": "The table name.", + "type": "string", + "readOnly": true + }, + "columnName": { + "description": "The column name.", + "type": "string", + "readOnly": true + }, + "labelName": { + "description": "The label name.", + "type": "string" + }, + "labelId": { + "description": "The label ID.", + "type": "string" + }, + "informationType": { + "description": "The information type.", + "type": "string" + }, + "informationTypeId": { + "description": "The information type ID.", + "type": "string" + }, + "isDisabled": { + "description": "Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not.", + "type": "boolean", + "readOnly": true + }, + "rank": { + "enum": [ + "None", + "Low", + "Medium", + "High", + "Critical" + ], + "type": "string", + "x-ms-enum": { + "name": "SensitivityLabelRank", + "modelAsString": false + } + } + } + }, + "SensitivityLabel": { + "description": "A sensitivity label.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SensitivityLabelProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + }, + "managedBy": { + "type": "string", + "readOnly": true, + "description": "managed by" + } + } + }, + "SensitivityLabelListResult": { + "description": "A list of sensitivity labels.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SensitivityLabel" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "SqlPoolSchema": { + "description": "A Sql pool schema resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlPoolSchemaListResult": { + "description": "A list of Sql pool schemas.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlPoolSchema" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "SqlPoolTable": { + "description": "A Sql pool table resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlPoolTableListResult": { + "description": "A list of Sql pool tables.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlPoolTable" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "SqlPoolColumnProperties": { + "description": "Sql pool column properties.", + "type": "object", + "properties": { + "columnType": { + "description": "The column data type.", + "enum": [ + "image", + "text", + "uniqueidentifier", + "date", + "time", + "datetime2", + "datetimeoffset", + "tinyint", + "smallint", + "int", + "smalldatetime", + "real", + "money", + "datetime", + "float", + "sql_variant", + "ntext", + "bit", + "decimal", + "numeric", + "smallmoney", + "bigint", + "hierarchyid", + "geometry", + "geography", + "varbinary", + "varchar", + "binary", + "char", + "timestamp", + "nvarchar", + "nchar", + "xml", + "sysname" + ], + "type": "string", + "x-ms-enum": { + "name": "ColumnDataType", + "modelAsString": true + } + }, + "isComputed": { + "type": "boolean", + "description": "Indicates whether column value is computed or not", + "readOnly": true + } + } + }, + "SqlPoolColumn": { + "description": "A Sql pool column resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlPoolColumnProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "SqlPoolColumnListResult": { + "description": "A list of Sql pool columns.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlPoolColumn" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "SqlPoolConnectionPolicyProperties": { + "description": "Properties of a Sql pool connection policy.", + "type": "object", + "properties": { + "securityEnabledAccess": { + "description": "The state of security access.", + "type": "string" + }, + "proxyDnsName": { + "description": "The fully qualified host name of the auditing proxy.", + "type": "string" + }, + "proxyPort": { + "description": "The port number of the auditing proxy.", + "type": "string" + }, + "visibility": { + "description": "The visibility of the auditing proxy.", + "type": "string" + }, + "useServerDefault": { + "description": "Whether server default is enabled or disabled.", + "type": "string" + }, + "redirectionState": { + "description": "The state of proxy redirection.", + "type": "string" + }, + "state": { + "description": "The connection policy state.", + "type": "string" + } + } + }, + "SqlPoolConnectionPolicy": { + "description": "A Sql pool connection policy.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "kind": { + "description": "Resource kind.", + "type": "string", + "readOnly": true + }, + "location": { + "type": "string", + "readOnly": true, + "description": "Resource location." + }, + "properties": { + "$ref": "#/definitions/SqlPoolConnectionPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "SqlPoolVulnerabilityAssessmentProperties": { + "description": "Properties of a Sql pool Vulnerability Assessment.", + "type": "object", + "properties": { + "storageContainerPath": { + "description": "A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). It is required if server level vulnerability assessment policy doesn't set", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "storageContainerSasKey": { + "description": "A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "storageAccountAccessKey": { + "description": "Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "recurringScans": { + "$ref": "#/definitions/VulnerabilityAssessmentRecurringScansProperties", + "description": "The recurring scans settings" + } + } + }, + "VulnerabilityAssessmentRecurringScansProperties": { + "description": "Properties of a Vulnerability Assessment recurring scans.", + "type": "object", + "properties": { + "isEnabled": { + "description": "Recurring scans state.", + "type": "boolean" + }, + "emailSubscriptionAdmins": { + "description": "Specifies that the schedule scan notification will be is sent to the subscription administrators.", + "default": true, + "type": "boolean" + }, + "emails": { + "description": "Specifies an array of e-mail addresses to which the scan notification is sent.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SqlPoolVulnerabilityAssessment": { + "description": "A Sql pool vulnerability assessment.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlPoolVulnerabilityAssessmentProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "SqlPoolVulnerabilityAssessmentListResult": { + "description": "A list of the Sql pool's vulnerability assessments.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlPoolVulnerabilityAssessment" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "VulnerabilityAssessmentScanRecordListResult": { + "description": "A list of vulnerability assessment scan records.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/VulnerabilityAssessmentScanRecord" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "VulnerabilityAssessmentScanRecord": { + "description": "A vulnerability assessment scan record.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/VulnerabilityAssessmentScanRecordProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "VulnerabilityAssessmentScanRecordProperties": { + "description": "Properties of a vulnerability assessment scan record.", + "type": "object", + "properties": { + "scanId": { + "description": "The scan ID.", + "type": "string", + "readOnly": true + }, + "triggerType": { + "description": "The scan trigger type.", + "enum": [ + "OnDemand", + "Recurring" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VulnerabilityAssessmentScanTriggerType", + "modelAsString": true + } + }, + "state": { + "description": "The scan status.", + "enum": [ + "Passed", + "Failed", + "FailedToRun", + "InProgress" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VulnerabilityAssessmentScanState", + "modelAsString": true + } + }, + "startTime": { + "format": "date-time", + "description": "The scan start time (UTC).", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "The scan end time (UTC).", + "type": "string", + "readOnly": true + }, + "errors": { + "description": "The scan errors.", + "type": "array", + "items": { + "$ref": "#/definitions/VulnerabilityAssessmentScanError" + }, + "readOnly": true + }, + "storageContainerPath": { + "description": "The scan results storage container path.", + "type": "string", + "readOnly": true + }, + "numberOfFailedSecurityChecks": { + "format": "int32", + "description": "The number of failed security checks.", + "type": "integer", + "readOnly": true + } + } + }, + "VulnerabilityAssessmentScanError": { + "description": "Properties of a vulnerability assessment scan error.", + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The error message.", + "type": "string", + "readOnly": true + } + } + }, + "SecurityAlertPolicyProperties": { + "description": "Properties of a security alert policy.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "state": { + "description": "Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific Sql pool.", + "enum": [ + "New", + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "SecurityAlertPolicyState", + "modelAsString": false + } + }, + "disabledAlerts": { + "description": "Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action", + "type": "array", + "items": { + "type": "string" + } + }, + "emailAddresses": { + "description": "Specifies an array of e-mail addresses to which the alert is sent.", + "type": "array", + "items": { + "type": "string" + } + }, + "emailAccountAdmins": { + "description": "Specifies that the alert is sent to the account administrators.", + "type": "boolean" + }, + "storageEndpoint": { + "description": "Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.", + "type": "string" + }, + "storageAccountAccessKey": { + "description": "Specifies the identifier key of the Threat Detection audit storage account.", + "type": "string" + }, + "retentionDays": { + "format": "int32", + "description": "Specifies the number of days to keep in the Threat Detection audit logs.", + "type": "integer" + }, + "creationTime": { + "format": "date-time", + "description": "Specifies the UTC creation time of the policy.", + "type": "string", + "readOnly": true + } + } + }, + "SqlPoolSecurityAlertPolicy": { + "description": "A Sql pool security alert policy.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SecurityAlertPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "ListSqlPoolSecurityAlertPolicies": { + "description": "A list of SQL pool security alert policies.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlPoolSecurityAlertPolicy" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "SqlPoolVulnerabilityAssessmentRuleBaselineProperties": { + "description": "Properties of a Sql pool vulnerability assessment rule baseline.", + "required": [ + "baselineResults" + ], + "type": "object", + "properties": { + "baselineResults": { + "description": "The rule baseline result", + "type": "array", + "items": { + "$ref": "#/definitions/SqlPoolVulnerabilityAssessmentRuleBaselineItem" + } + } + } + }, + "SqlPoolVulnerabilityAssessmentRuleBaselineItem": { + "description": "Properties for an Sql pool vulnerability assessment rule baseline's result.", + "required": [ + "result" + ], + "type": "object", + "properties": { + "result": { + "description": "The rule baseline result", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SqlPoolVulnerabilityAssessmentRuleBaseline": { + "description": "A Sql pool vulnerability assessment rule baseline.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlPoolVulnerabilityAssessmentRuleBaselineProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "SqlPoolVulnerabilityAssessmentScanExportProperties": { + "description": "Properties of the export operation's result.", + "type": "object", + "properties": { + "exportedReportLocation": { + "description": "Location of the exported report (e.g. https://myStorage.blob.core.windows.net/VaScans/scans/serverName/databaseName/scan_scanId.xlsx).", + "type": "string", + "readOnly": true + } + } + }, + "SqlPoolVulnerabilityAssessmentScansExport": { + "description": "A Sql pool Vulnerability Assessment scan export resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlPoolVulnerabilityAssessmentScanExportProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "ResourceMoveDefinition": { + "description": "Contains the information necessary to perform a resource move (rename).", + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "description": "The target ID for the resource", + "type": "string" + } + } + }, + "CreateSqlPoolRestorePointDefinition": { + "description": "Contains the information necessary to perform a create Sql pool restore point operation.", + "required": [ + "restorePointLabel" + ], + "type": "object", + "properties": { + "restorePointLabel": { + "description": "The restore point label to apply", + "type": "string" + } + } + }, + "WorkloadGroupProperties": { + "description": "Workload group definition. For more information look at sys.workload_management_workload_groups (DMV).", + "required": [ + "minResourcePercent", + "maxResourcePercent", + "minResourcePercentPerRequest" + ], + "type": "object", + "properties": { + "minResourcePercent": { + "format": "int32", + "description": "The workload group minimum percentage resource.", + "type": "integer" + }, + "maxResourcePercent": { + "format": "int32", + "description": "The workload group cap percentage resource.", + "type": "integer" + }, + "minResourcePercentPerRequest": { + "format": "double", + "description": "The workload group request minimum grant percentage.", + "type": "number" + }, + "maxResourcePercentPerRequest": { + "format": "double", + "description": "The workload group request maximum grant percentage.", + "type": "number" + }, + "importance": { + "description": "The workload group importance level.", + "type": "string" + }, + "queryExecutionTimeout": { + "format": "int32", + "description": "The workload group query execution timeout.", + "type": "integer" + } + } + }, + "WorkloadGroup": { + "description": "Workload group operations for a sql pool", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/WorkloadGroupProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "WorkloadGroupListResult": { + "description": "A list of workload groups.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/WorkloadGroup" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "WorkloadClassifierProperties": { + "description": "Workload classifier definition. For more information look at sys.workload_management_workload_classifiers (DMV).", + "required": [ + "memberName" + ], + "type": "object", + "properties": { + "memberName": { + "description": "The workload classifier member name.", + "type": "string" + }, + "label": { + "description": "The workload classifier label.", + "type": "string" + }, + "context": { + "description": "The workload classifier context.", + "type": "string" + }, + "startTime": { + "description": "The workload classifier start time for classification.", + "type": "string" + }, + "endTime": { + "description": "The workload classifier end time for classification.", + "type": "string" + }, + "importance": { + "description": "The workload classifier importance.", + "type": "string" + } + } + }, + "WorkloadClassifier": { + "description": "Workload classifier operations for a data warehouse", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/WorkloadClassifierProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "WorkloadClassifierListResult": { + "description": "A list of workload classifiers for a workload group.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/WorkloadClassifier" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "DataMaskingPolicyProperties": { + "properties": { + "dataMaskingState": { + "type": "string", + "description": "The state of the data masking policy.", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "modelAsString": false, + "name": "DataMaskingState" + } + }, + "exemptPrincipals": { + "type": "string", + "description": "The list of the exempt principals. Specifies the semicolon-separated list of database users for which the data masking policy does not apply. The specified users receive data results without masking for all of the database queries." + }, + "applicationPrincipals": { + "type": "string", + "description": "The list of the application principals. This is a legacy parameter and is no longer used.", + "readOnly": true + }, + "maskingLevel": { + "type": "string", + "description": "The masking level. This is a legacy parameter and is no longer used.", + "readOnly": true + } + }, + "required": [ + "dataMaskingState" + ], + "description": "The properties of a database data masking policy." + }, + "DataMaskingPolicy": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DataMaskingPolicyProperties", + "description": "The properties of the data masking policy." + }, + "location": { + "type": "string", + "readOnly": true, + "description": "The location of the data masking policy." + }, + "kind": { + "type": "string", + "readOnly": true, + "description": "The kind of data masking policy. Metadata, used for Azure portal." + }, + "managedBy": { + "type": "string", + "readOnly": true, + "description": "Fully qualified resource ID of the sql pool" + } + } + }, + "ExtendedSqlPoolBlobAuditingPolicy": { + "description": "An extended Sql pool blob auditing policy.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ExtendedSqlPoolBlobAuditingPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "ExtendedSqlPoolBlobAuditingPolicyProperties": { + "description": "Properties of an extended Sql pool blob auditing policy.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "predicateExpression": { + "description": "Specifies condition of where clause when creating an audit.", + "type": "string" + }, + "state": { + "description": "Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "BlobAuditingPolicyState", + "modelAsString": false + } + }, + "storageEndpoint": { + "description": "Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.", + "type": "string" + }, + "storageAccountAccessKey": { + "description": "Specifies the identifier key of the auditing storage account. \r\nIf state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage.\r\nPrerequisites for using managed identity authentication:\r\n1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD).\r\n2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity.\r\nFor more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355)", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "retentionDays": { + "format": "int32", + "description": "Specifies the number of days to keep in the audit logs in the storage account.", + "type": "integer" + }, + "auditActionsAndGroups": { + "description": "Specifies the Actions-Groups and Actions to audit.\r\n\r\nThe recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:\r\n\r\nBATCH_COMPLETED_GROUP,\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,\r\nFAILED_DATABASE_AUTHENTICATION_GROUP.\r\n\r\nThis above combination is also the set that is configured by default when enabling auditing from the Azure portal.\r\n\r\nThe supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):\r\n\r\nAPPLICATION_ROLE_CHANGE_PASSWORD_GROUP\r\nBACKUP_RESTORE_GROUP\r\nDATABASE_LOGOUT_GROUP\r\nDATABASE_OBJECT_CHANGE_GROUP\r\nDATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nDATABASE_OBJECT_PERMISSION_CHANGE_GROUP\r\nDATABASE_OPERATION_GROUP\r\nDATABASE_PERMISSION_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_IMPERSONATION_GROUP\r\nDATABASE_ROLE_MEMBER_CHANGE_GROUP\r\nFAILED_DATABASE_AUTHENTICATION_GROUP\r\nSCHEMA_OBJECT_ACCESS_GROUP\r\nSCHEMA_OBJECT_CHANGE_GROUP\r\nSCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nSCHEMA_OBJECT_PERMISSION_CHANGE_GROUP\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP\r\nUSER_CHANGE_PASSWORD_GROUP\r\nBATCH_STARTED_GROUP\r\nBATCH_COMPLETED_GROUP\r\n\r\nThese are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.\r\n\r\nFor more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).\r\n\r\nFor Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:\r\nSELECT\r\nUPDATE\r\nINSERT\r\nDELETE\r\nEXECUTE\r\nRECEIVE\r\nREFERENCES\r\n\r\nThe general form for defining an action to be audited is:\r\n{action} ON {object} BY {principal}\r\n\r\nNote that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.\r\n\r\nFor example:\r\nSELECT on dbo.myTable by public\r\nSELECT on DATABASE::myDatabase by public\r\nSELECT on SCHEMA::mySchema by public\r\n\r\nFor more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)", + "type": "array", + "items": { + "type": "string" + } + }, + "storageAccountSubscriptionId": { + "format": "uuid", + "description": "Specifies the blob storage subscription Id.", + "type": "string" + }, + "isStorageSecondaryKeyInUse": { + "description": "Specifies whether storageAccountAccessKey value is the storage's secondary key.", + "type": "boolean" + }, + "isAzureMonitorTargetEnabled": { + "description": "Specifies whether audit events are sent to Azure Monitor. \r\nIn order to send the events to Azure Monitor, specify 'state' as 'Enabled' and 'isAzureMonitorTargetEnabled' as true.\r\n\r\nWhen using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.\r\nNote that for server level audit you should use the 'master' database as {databaseName}.\r\n\r\nDiagnostic Settings URI format:\r\nPUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview\r\n\r\nFor more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)\r\nor [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)\r\n", + "type": "boolean" + }, + "queueDelayMs": { + "format": "int32", + "description": "Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed.\r\nThe default minimum value is 1000 (1 second). The maximum is 2,147,483,647.", + "type": "integer" + } + } + }, + "ExtendedSqlPoolBlobAuditingPolicyListResult": { + "description": "A list of sql pool extended auditing settings.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ExtendedSqlPoolBlobAuditingPolicy" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "DataMaskingRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DataMaskingRuleProperties", + "description": "The properties of the resource." + }, + "location": { + "type": "string", + "readOnly": true, + "description": "The location of the data masking rule." + }, + "kind": { + "type": "string", + "readOnly": true, + "description": "The kind of Data Masking Rule. Metadata, used for Azure portal." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Represents a Sql pool data masking rule." + }, + "DataMaskingRuleProperties": { + "properties": { + "id": { + "type": "string", + "description": "The rule Id.", + "readOnly": true + }, + "aliasName": { + "type": "string", + "description": "The alias name. This is a legacy parameter and is no longer used." + }, + "ruleState": { + "type": "string", + "description": "The rule state. Used to delete a rule. To delete an existing rule, specify the schemaName, tableName, columnName, maskingFunction, and specify ruleState as disabled. However, if the rule doesn't already exist, the rule will be created with ruleState set to enabled, regardless of the provided value of ruleState.", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "modelAsString": false, + "name": "DataMaskingRuleState" + } + }, + "schemaName": { + "type": "string", + "description": "The schema name on which the data masking rule is applied." + }, + "tableName": { + "type": "string", + "description": "The table name on which the data masking rule is applied." + }, + "columnName": { + "type": "string", + "description": "The column name on which the data masking rule is applied." + }, + "maskingFunction": { + "type": "string", + "description": "The masking function that is used for the data masking rule.", + "enum": [ + "Default", + "CCN", + "Email", + "Number", + "SSN", + "Text" + ], + "x-ms-enum": { + "modelAsString": false, + "name": "DataMaskingFunction" + } + }, + "numberFrom": { + "type": "string", + "description": "The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored." + }, + "numberTo": { + "type": "string", + "description": "The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored." + }, + "prefixSize": { + "type": "string", + "description": "If maskingFunction is set to Text, the number of characters to show unmasked in the beginning of the string. Otherwise, this parameter will be ignored." + }, + "suffixSize": { + "type": "string", + "description": "If maskingFunction is set to Text, the number of characters to show unmasked at the end of the string. Otherwise, this parameter will be ignored." + }, + "replacementString": { + "type": "string", + "description": "If maskingFunction is set to Text, the character to use for masking the unexposed part of the string. Otherwise, this parameter will be ignored." + } + }, + "required": [ + "maskingFunction", + "schemaName", + "tableName", + "columnName" + ], + "description": "The properties of a Sql pool data masking rule." + }, + "DataMaskingRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DataMaskingRule" + }, + "description": "The list of Sql pool data masking rules." + } + }, + "description": "The response to a list data masking rules request." + }, + "SqlPoolBlobAuditingPolicyListResult": { + "description": "A list of Sql pool auditing settings.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlPoolBlobAuditingPolicy" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "SensitivityLabelUpdateProperties": { + "description": "Properties of an operation executed on a sensitivity label.", + "required": [ + "op", + "schema", + "table", + "column" + ], + "type": "object", + "properties": { + "op": { + "enum": [ + "set", + "remove" + ], + "type": "string", + "x-ms-enum": { + "name": "SensitivityLabelUpdateKind", + "modelAsString": false + } + }, + "schema": { + "description": "Schema name of the column to update.", + "type": "string" + }, + "table": { + "description": "Table name of the column to update.", + "type": "string" + }, + "column": { + "description": "Column name to update.", + "type": "string" + }, + "sensitivityLabel": { + "$ref": "#/definitions/SensitivityLabel", + "description": "The sensitivity label information to apply on a column." + } + } + }, + "SensitivityLabelUpdate": { + "description": "A sensitivity label update operation.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SensitivityLabelUpdateProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "SensitivityLabelUpdateList": { + "description": "A list of sensitivity label update operations.", + "type": "object", + "properties": { + "operations": { + "type": "array", + "items": { + "$ref": "#/definitions/SensitivityLabelUpdate" + } + } + } + }, + "RecommendedSensitivityLabelUpdateProperties": { + "description": "Properties of an operation executed on a recommended sensitivity label.", + "required": [ + "op", + "schema", + "table", + "column" + ], + "type": "object", + "properties": { + "op": { + "enum": [ + "enable", + "disable" + ], + "type": "string", + "x-ms-enum": { + "name": "RecommendedSensitivityLabelUpdateKind", + "modelAsString": false + } + }, + "schema": { + "description": "Schema name of the column to update.", + "type": "string" + }, + "table": { + "description": "Table name of the column to update.", + "type": "string" + }, + "column": { + "description": "Column name to update.", + "type": "string" + } + } + }, + "RecommendedSensitivityLabelUpdate": { + "description": "A recommended sensitivity label update operation.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RecommendedSensitivityLabelUpdateProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "RecommendedSensitivityLabelUpdateList": { + "description": "A list of recommended sensitivity label update operations.", + "type": "object", + "properties": { + "operations": { + "type": "array", + "items": { + "$ref": "#/definitions/RecommendedSensitivityLabelUpdate" + } + } + } + } + }, + "parameters": { + "DataMaskingPolicyNameParameter": { + "name": "dataMaskingPolicyName", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "x-ms-enum": { + "modelAsString": false, + "name": "DataMaskingPolicyName" + }, + "description": "The name of the data masking policy for which the masking rule applies.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/sqlServer.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/sqlServer.json new file mode 100644 index 000000000000..a77fe1bbe45c --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/sqlServer.json @@ -0,0 +1,1789 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01-preview", + "title": "SynapseManagementClient", + "description": "The Azure Synapse SQL management API provides a RESTful set of web APIs that interact with Azure Synapse SQL services to manage your resources. The API enables users to create, retrieve, update, and delete SqlServers sub resources." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "type": "oauth2", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/auditingSettings/{blobAuditingPolicyName}": { + "get": { + "operationId": "WorkspaceManagedSqlServerBlobAuditingPolicies_Get", + "summary": "Get server's blob auditing policy.", + "description": "Get a workspace managed sql server's blob auditing policy.", + "tags": [ + "WorkspaceManagedSqlServer, BlobAuditing" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "BlobAuditingPolicyName", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "Successfully retrieved workspace managed sql server's blob auditing policy.", + "schema": { + "$ref": "#/definitions/ServerBlobAuditingPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get blob auditing setting of workspace managed sql Server": { + "$ref": "./examples/GetWorkspaceManagedSqlServerBlobAuditingSettings.json" + } + } + }, + "put": { + "operationId": "WorkspaceManagedSqlServerBlobAuditingPolicies_CreateOrUpdate", + "summary": "Create or Update server's blob auditing policy.", + "description": "Create or Update a workspace managed sql server's blob auditing policy.", + "tags": [ + "WorkspaceManagedSqlServer, BlobAuditing" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "BlobAuditingPolicyName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "Properties of extended blob auditing policy.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerBlobAuditingPolicy" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the auditing settings.", + "schema": { + "$ref": "#/definitions/ServerBlobAuditingPolicy" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidServerBlobAuditingPolicyCreateRequest - The create server blob auditing policy request does not exist or has no properties object.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 BlobAuditingInvalidStorageAccountCredentials - The provided storage account or access key is not valid.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 InsufficientDiskSpaceForAuditing - Insufficient disk space to save auditing metadata in the database\n\n 400 InvalidBlobAuditActions - Invalid audit action.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update blob auditing policy of workspace managed Sql Server with minimal parameters": { + "$ref": "./examples/CreateWorkspaceManagedSqlServerBlobAuditingSettingsWithMinParameters.json" + }, + "Create or update blob auditing policy of workspace SQL Server with all parameters": { + "$ref": "./examples/CreateWorkspaceManagedSqlServerBlobAuditingSettingsWithAllParameters.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/auditingSettings": { + "get": { + "operationId": "WorkspaceManagedSqlServerBlobAuditingPolicies_ListByWorkspace", + "summary": "List workspace server's blob auditing policies.", + "description": "List workspace managed sql server's blob auditing policies.", + "tags": [ + "WorkspaceManagedSqlServer, BlobAuditing" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved auditing settings.", + "schema": { + "$ref": "#/definitions/ServerBlobAuditingPolicyListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get blob auditing policy of workspace manged sql Server": { + "$ref": "./examples/ListWorkspaceManagedSqlServerBlobAuditingSettings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/extendedAuditingSettings/{blobAuditingPolicyName}": { + "get": { + "operationId": "WorkspaceManagedSqlServerExtendedBlobAuditingPolicies_Get", + "summary": "Get server's extended blob auditing policy.", + "description": "Get a workspace SQL server's extended blob auditing policy.", + "tags": [ + "WorkspaceManagedSqlServer, BlobAuditing" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "BlobAuditingPolicyName", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "Successfully retrieved extended auditing settings.", + "schema": { + "$ref": "#/definitions/ExtendedServerBlobAuditingPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get workspace managed sql servers' extended blob auditing settings": { + "$ref": "./examples/GetWorkspaceManagedSqlExtendedServerBlobAuditingSettings.json" + } + } + }, + "put": { + "operationId": "WorkspaceManagedSqlServerExtendedBlobAuditingPolicies_CreateOrUpdate", + "summary": "Create or Update server's extended blob auditing policy.", + "description": "Create or Update a workspace managed sql server's extended blob auditing policy.", + "tags": [ + "WorkspaceManagedSqlServer, BlobAuditing" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "BlobAuditingPolicyName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "Properties of extended blob auditing policy.", + "required": true, + "schema": { + "$ref": "#/definitions/ExtendedServerBlobAuditingPolicy" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the extended auditing settings.", + "schema": { + "$ref": "#/definitions/ExtendedServerBlobAuditingPolicy" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidServerBlobAuditingPolicyCreateRequest - The create server blob auditing policy request does not exist or has no properties object.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 BlobAuditingPredicateExpressionEmpty - Invalid parameter 'predicateExpression', value can not be empty.\n\n * 400 BlobAuditingInvalidStorageAccountCredentials - The provided storage account or access key is not valid.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 InsufficientDiskSpaceForAuditing - Insufficient disk space to save auditing metadata in the database\n\n * 400 InvalidBlobAuditActions - Invalid audit action\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 409 ServerBlobAuditingPolicyInProgress - Set server blob auditing is already in progress.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update workspace managed sql server's extended blob auditing policy of with minimal parameters": { + "$ref": "./examples/CreateWorkspaceManagedSqlServerExetendedBlobAuditingSettingsWithMinParameters.json" + }, + "Create or update workspace managed sql server's extended blob auditing policy of with all parameters": { + "$ref": "./examples/CreateWorkspaceManagedSqlServerExtendedBlobAuditingSettingsWithAllParameters.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/extendedAuditingSettings": { + "get": { + "operationId": "WorkspaceManagedSqlServerExtendedBlobAuditingPolicies_ListByWorkspace", + "summary": "List server's extended blob auditing policies.", + "description": "List workspace managed sql server's extended blob auditing policies.", + "tags": [ + "WorkspaceManagedSqlServer, BlobAuditing" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved extended auditing settings.", + "schema": { + "$ref": "#/definitions/ExtendedServerBlobAuditingPolicyListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get workspace managed sql server's extended blob auditing settings": { + "$ref": "./examples/ListWorkspaceManagedSqlServerExtendedBlobAuditingSettings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/securityAlertPolicies/{securityAlertPolicyName}": { + "get": { + "operationId": "WorkspaceManagedSqlServerSecurityAlertPolicy_Get", + "summary": "Get server's security alert policy.", + "description": "Get a workspace managed sql server's security alert policy.", + "tags": [ + "WorkspaceManagedSqlServer, SecurityAlertPolicies" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the security alert policy.", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "x-ms-enum": { + "name": "SecurityAlertPolicyName", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "Successfully retrieved security alert policy.", + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountCredentials - The provided storage account access key is not valid.\n\n * 400 InvalidServerSecurityAlertPolicyCreateRequest - The create server Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 ServerSecurityAlertPolicyInProgress - Set server security alert policy is already in progress\n\n * 409 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 GetServerSecurityAlertPolicyFailed - Failed to get Threat Detection settings\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get workspace managed sql Server's security alert policy": { + "$ref": "./examples/GetWorkspaceManagedSqlServerSecurityAlertPolicy.json" + } + } + }, + "put": { + "operationId": "WorkspaceManagedSqlServerSecurityAlertPolicy_CreateOrUpdate", + "summary": "Create or Update server's threat detection policy.", + "description": "Create or Update a workspace managed sql server's threat detection policy.", + "tags": [ + "WorkspaceManagedSqlServer, SecurityAlertPolicies" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the security alert policy.", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "x-ms-enum": { + "name": "SecurityAlertPolicyName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "The workspace managed sql server security alert policy.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated threat detection policy.", + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountCredentials - The provided storage account access key is not valid.\n\n * 400 InvalidServerSecurityAlertPolicyCreateRequest - The create server Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 ServerSecurityAlertPolicyInProgress - Set server security alert policy is already in progress\n\n * 409 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a workspace managed sql server's threat detection policy with minimal parameters": { + "$ref": "./examples/WorkspaceManagedSqlServerSecurityAlertCreateWithMinParameters.json" + }, + "Update a workspace managed sql server's threat detection policy with all parameters": { + "$ref": "./examples/WorkspaceManagedSqlServerSecurityAlertWithAllParameters.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/securityAlertPolicies": { + "get": { + "operationId": "WorkspaceManagedSqlServerSecurityAlertPolicy_List", + "summary": "Get server's threat detection policies.", + "description": "Get workspace managed sql server's threat detection policies.", + "tags": [ + "WorkspaceManagedSqlServer, SecurityAlertPolicies" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved threat detection policies.", + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicyListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountCredentials - The provided storage account access key is not valid.\n\n * 400 InvalidServerSecurityAlertPolicyCreateRequest - The create server Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 ServerSecurityAlertPolicyInProgress - Set server security alert policy is already in progress\n\n * 409 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 GetServerSecurityAlertPolicyFailed - Failed to get Threat Detection settings\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get workspace managed sql server's security alert policy": { + "$ref": "./examples/ListWorkspaceManagedSqlServerSecurityAlertPolicies.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}": { + "get": { + "operationId": "WorkspaceManagedSqlServerVulnerabilityAssessments_Get", + "summary": "Get server's vulnerability assessment.", + "description": "Get workspace managed sql server's vulnerability assessment.", + "tags": [ + "WorkspaceManagedSqlServer, ServerVulnerabilityAssessments" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "name": "vulnerabilityAssessmentName", + "in": "path", + "description": "The name of the vulnerability assessment.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentName", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "Successfully retrieved vulnerability assessment.", + "schema": { + "$ref": "#/definitions/ServerVulnerabilityAssessment" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get workspace managed sql Server's vulnerability assessment": { + "$ref": "./examples/GetWorkspaceManagedSqlServerVulnerabilityAssessment.json" + } + } + }, + "put": { + "operationId": "WorkspaceManagedSqlServerVulnerabilityAssessments_CreateOrUpdate", + "summary": "Create or Update server's vulnerability assessment.", + "description": "Create or Update workspace managed sql server's vulnerability assessment.", + "tags": [ + "WorkspaceManagedSqlServer, ServerVulnerabilityAssessments" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "name": "vulnerabilityAssessmentName", + "in": "path", + "description": "The name of the vulnerability assessment.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "Properties for vulnerability assessment.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerVulnerabilityAssessment" + } + } + ], + "responses": { + "200": { + "description": "Successfully created vulnerability assessment.", + "schema": { + "$ref": "#/definitions/ServerVulnerabilityAssessment" + } + }, + "201": { + "description": "Successfully created the vulnerability assessment.", + "schema": { + "$ref": "#/definitions/ServerVulnerabilityAssessment" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 InvalidVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Create or Update a workspace managed sql server's vulnerability assessment with minimal parameters, when storageContainerSasKey is specified": { + "$ref": "./examples/PutWorkspaceMangedSqlServerVulnerabilityAssessmentCreateContainerSasKeyMin.json" + }, + "Create or Update a workspace managed sql server's vulnerability assessment with minimal parameters, when storageAccountAccessKey is specified": { + "$ref": "./examples/PutWorkspaceMangedSqlServerVulnerabilityAssessmentCreateStorageAccessKeyMin.json" + }, + "Create or Update a workspace managed sql server's vulnerability assessment with all parameters": { + "$ref": "./examples/PutWorkspaceManagedSqlServerVulnerabilityAssessmentWithAllParameters.json" + } + } + }, + "delete": { + "operationId": "WorkspaceManagedSqlServerVulnerabilityAssessments_Delete", + "summary": "Remove server's vulnerability assessment.", + "description": "Remove workspace managed sql server's vulnerability assessment.", + "tags": [ + "WorkspaceManagedSqlServer, ServerVulnerabilityAssessments" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "name": "vulnerabilityAssessmentName", + "in": "path", + "description": "The name of the vulnerability assessment.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentName", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "Successfully removed vulnerability assessment." + }, + "204": { + "description": "Specified vulnerability assessment policy does not exists." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Remove workspace managed sql Server's vulnerability assessment": { + "$ref": "./examples/DeleteWorkspaceManagedSqlServerVulnerabilityAssessment.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/vulnerabilityAssessments": { + "get": { + "operationId": "WorkspaceManagedSqlServerVulnerabilityAssessments_List", + "summary": "Lists the vulnerability assessment policies associated with a server.", + "description": "Lists the vulnerability assessment policies associated with a workspace managed sql server.", + "tags": [ + "WorkspaceManagedSqlServer, ServerVulnerabilityAssessments" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved vulnerability assessment policies.", + "schema": { + "$ref": "#/definitions/ServerVulnerabilityAssessmentListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get workspace managed sql Server's vulnerability assessment policies": { + "$ref": "./examples/ListWorkspaceManagedSqlServerVulnerabilityAssessmentPolicies.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/encryptionProtector/{encryptionProtectorName}": { + "get": { + "operationId": "WorkspaceManagedSqlServerEncryptionProtector_Get", + "summary": "Get workspace server's encryption protector.", + "description": "Get workspace managed sql server's encryption protector.", + "tags": [ + "WorkspaceManagedSqlServer, ServerEncryptionProtector" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "name": "encryptionProtectorName", + "in": "path", + "description": "The name of the encryption protector.", + "required": true, + "type": "string", + "enum": [ + "current" + ], + "x-ms-enum": { + "name": "EncryptionProtectorName", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "Successfully retrieved encryption protector.", + "schema": { + "$ref": "#/definitions/EncryptionProtector" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidUpsertKeyType - Service Managed type keys are managed by Azure SQL. This key type does not support create or update by the user.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 InvalidEncryptionProtectorName - The encryption protector key name is not supported.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get workspace managed sql Server's encryption protector": { + "$ref": "./examples/GetWorkspaceManagedSqlServerEncryptionProtector.json" + } + } + }, + "put": { + "operationId": "WorkspaceManagedSqlServerEncryptionProtector_CreateOrUpdate", + "summary": "Updates workspace server's encryption protector.", + "description": "Updates workspace managed sql server's encryption protector.", + "tags": [ + "WorkspaceManagedSqlServer, ServerEncryptionProtector" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "name": "encryptionProtectorName", + "in": "path", + "description": "The name of the encryption protector.", + "required": true, + "type": "string", + "enum": [ + "current" + ], + "x-ms-enum": { + "name": "EncryptionProtectorName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "The requested encryption protector resource state.", + "required": true, + "schema": { + "$ref": "#/definitions/EncryptionProtector" + } + } + ], + "responses": { + "200": { + "description": "Successfully retrieved encryption protector.", + "schema": { + "$ref": "#/definitions/EncryptionProtector" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidUpsertKeyType - Service Managed type keys are managed by Azure SQL. This key type does not support create or update by the user.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 InvalidEncryptionProtectorName - The encryption protector key name is not supported.\n\n * 400 SecurityAzureKeyVaultGeoChainError - Creating secondary of secondary (a process known as chaining) is not supported when enabling Transparent Data Encryption using Azure Key Vault (BYOK).\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultMismatchError - Unexpected Key Vault region found in the http response.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 and Key Type is RSA.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 401 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ServerKeyNotFound - The requested server key was not found on the current subscription.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update the encryption protector to key vault": { + "$ref": "./examples/WorkspaceManagedSqlServerEncryptionProtectorCreateOrUpdateKeyVault.json" + }, + "Update the encryption protector to service managed": { + "$ref": "./examples/WorkspaceManagedSqlServerEncryptionProtectorCreateOrUpdateServiceManaged.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/encryptionProtector": { + "get": { + "operationId": "WorkspaceManagedSqlServerEncryptionProtector_List", + "summary": "Get list of encryption protectors for the server.", + "description": "Get list of encryption protectors for workspace managed sql server.", + "tags": [ + "WorkspaceManagedSqlServer, ServerEncryptionProtector" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved encryption protectors.", + "schema": { + "$ref": "#/definitions/EncryptionProtectorListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidUpsertKeyType - Service Managed type keys are managed by Azure SQL. This key type does not support create or update by the user.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 InvalidEncryptionProtectorName - The encryption protector key name is not supported.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get workspace managed sql Server's encryption protectors": { + "$ref": "./examples/GetWorkspaceManagedSqlServerEncryptionProtectorList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/encryptionProtector/{encryptionProtectorName}/revalidate": { + "post": { + "operationId": "WorkspaceManagedSqlServerEncryptionProtector_Revalidate", + "summary": "Revalidates server's existing encryption protector.", + "description": "Revalidates workspace managed sql server's existing encryption protector.", + "tags": [ + "WorkspaceManagedSqlServer, ServerEncryptionProtector" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "name": "encryptionProtectorName", + "in": "path", + "description": "The name of the encryption protector.", + "required": true, + "type": "string", + "enum": [ + "current" + ], + "x-ms-enum": { + "name": "EncryptionProtectorName", + "modelAsString": true + } + } + ], + "consumes": [], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully revalidated the encryption protector." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidUpsertKeyType - Service Managed type keys are managed by Azure SQL. This key type does not support create or update by the user.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 InvalidEncryptionProtectorName - The encryption protector key name is not supported.\n\n * 400 SecurityAzureKeyVaultGeoChainError - Creating secondary of secondary (a process known as chaining) is not supported when enabling Transparent Data Encryption using Azure Key Vault (BYOK).\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultMismatchError - Unexpected Key Vault region found in the http response.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 and Key Type is RSA.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 401 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ServerKeyNotFound - The requested server key was not found on the current subscription.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information ." + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Revalidates the encryption protector": { + "$ref": "./examples/WorkspaceManagedSqlServerEncryptionProtectorRevalidate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlUsages": { + "get": { + "tags": [ + "WorkspaceManagedSqlServer, sqlUsages" + ], + "operationId": "WorkspaceManagedSqlServerUsages_List", + "summary": "Get list of usages metric for the server.", + "description": "Get list of server usages metric for workspace managed sql server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerUsageListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List usages metric for the workspace managed sql server": { + "$ref": "./examples/ListWorkspaceManagedSqlServerUsages.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/recoverableSqlPools": { + "get": { + "tags": [ + "WorkspaceManagedSqlServer", + "recoverableSqlPools" + ], + "operationId": "WorkspaceManagedSqlServerRecoverableSqlPools_List", + "summary": "Get list of recoverable sql pools for the server.", + "description": "Get list of recoverable sql pools for workspace managed sql server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoverableSqlPoolListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List recoverable sql pools for the server": { + "$ref": "./examples/ListWorkspaceManagedSqlServerRecoverableSqlPool.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/recoverableSqlPools/{sqlPoolName}": { + "get": { + "tags": [ + "WorkspaceManagedSqlServer", + "recoverableSqlPools" + ], + "operationId": "WorkspaceManagedSqlServerRecoverableSqlPools_Get", + "summary": "Get recoverable sql pools for the server.", + "description": "Get recoverable sql pools for workspace managed sql server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "name": "sqlPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the sql pool" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoverableSqlPool" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get recoverable sql pools for the server": { + "$ref": "./examples/GetWorkspaceManagedSqlServerRecoverableSqlPool.json" + } + } + } + } + }, + "definitions": { + "ServerBlobAuditingPolicyProperties": { + "description": "Properties of a server blob auditing policy.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "state": { + "description": "Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "BlobAuditingPolicyState", + "modelAsString": false + } + }, + "storageEndpoint": { + "description": "Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.", + "type": "string" + }, + "storageAccountAccessKey": { + "description": "Specifies the identifier key of the auditing storage account. \r\nIf state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage.\r\nPrerequisites for using managed identity authentication:\r\n1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD).\r\n2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity.\r\nFor more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355)", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "retentionDays": { + "format": "int32", + "description": "Specifies the number of days to keep in the audit logs in the storage account.", + "type": "integer" + }, + "auditActionsAndGroups": { + "description": "Specifies the Actions-Groups and Actions to audit.\r\n\r\nThe recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:\r\n\r\nBATCH_COMPLETED_GROUP,\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,\r\nFAILED_DATABASE_AUTHENTICATION_GROUP.\r\n\r\nThis above combination is also the set that is configured by default when enabling auditing from the Azure portal.\r\n\r\nThe supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):\r\n\r\nAPPLICATION_ROLE_CHANGE_PASSWORD_GROUP\r\nBACKUP_RESTORE_GROUP\r\nDATABASE_LOGOUT_GROUP\r\nDATABASE_OBJECT_CHANGE_GROUP\r\nDATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nDATABASE_OBJECT_PERMISSION_CHANGE_GROUP\r\nDATABASE_OPERATION_GROUP\r\nDATABASE_PERMISSION_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_IMPERSONATION_GROUP\r\nDATABASE_ROLE_MEMBER_CHANGE_GROUP\r\nFAILED_DATABASE_AUTHENTICATION_GROUP\r\nSCHEMA_OBJECT_ACCESS_GROUP\r\nSCHEMA_OBJECT_CHANGE_GROUP\r\nSCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nSCHEMA_OBJECT_PERMISSION_CHANGE_GROUP\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP\r\nUSER_CHANGE_PASSWORD_GROUP\r\nBATCH_STARTED_GROUP\r\nBATCH_COMPLETED_GROUP\r\n\r\nThese are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.\r\n\r\nFor more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).\r\n\r\nFor Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:\r\nSELECT\r\nUPDATE\r\nINSERT\r\nDELETE\r\nEXECUTE\r\nRECEIVE\r\nREFERENCES\r\n\r\nThe general form for defining an action to be audited is:\r\n{action} ON {object} BY {principal}\r\n\r\nNote that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.\r\n\r\nFor example:\r\nSELECT on dbo.myTable by public\r\nSELECT on DATABASE::myDatabase by public\r\nSELECT on SCHEMA::mySchema by public\r\n\r\nFor more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)", + "type": "array", + "items": { + "type": "string" + } + }, + "storageAccountSubscriptionId": { + "format": "uuid", + "description": "Specifies the blob storage subscription Id.", + "type": "string" + }, + "isStorageSecondaryKeyInUse": { + "description": "Specifies whether storageAccountAccessKey value is the storage's secondary key.", + "type": "boolean" + }, + "isAzureMonitorTargetEnabled": { + "description": "Specifies whether audit events are sent to Azure Monitor. \r\nIn order to send the events to Azure Monitor, specify 'state' as 'Enabled' and 'isAzureMonitorTargetEnabled' as true.\r\n\r\nWhen using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.\r\nNote that for server level audit you should use the 'master' database as {databaseName}.\r\n\r\nDiagnostic Settings URI format:\r\nPUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview\r\n\r\nFor more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)\r\nor [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)\r\n", + "type": "boolean" + }, + "queueDelayMs": { + "format": "int32", + "description": "Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed.\r\nThe default minimum value is 1000 (1 second). The maximum is 2,147,483,647.", + "type": "integer" + } + } + }, + "ServerBlobAuditingPolicy": { + "description": "A server blob auditing policy.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ServerBlobAuditingPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "ServerBlobAuditingPolicyListResult": { + "description": "A list of server auditing settings.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ServerBlobAuditingPolicy" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ExtendedServerBlobAuditingPolicyProperties": { + "description": "Properties of an extended server blob auditing policy.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "predicateExpression": { + "description": "Specifies condition of where clause when creating an audit.", + "type": "string" + }, + "state": { + "description": "Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "BlobAuditingPolicyState", + "modelAsString": false + } + }, + "storageEndpoint": { + "description": "Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.", + "type": "string" + }, + "storageAccountAccessKey": { + "description": "Specifies the identifier key of the auditing storage account. \r\nIf state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage.\r\nPrerequisites for using managed identity authentication:\r\n1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD).\r\n2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity.\r\nFor more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355)", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "retentionDays": { + "format": "int32", + "description": "Specifies the number of days to keep in the audit logs in the storage account.", + "type": "integer" + }, + "auditActionsAndGroups": { + "description": "Specifies the Actions-Groups and Actions to audit.\r\n\r\nThe recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:\r\n\r\nBATCH_COMPLETED_GROUP,\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,\r\nFAILED_DATABASE_AUTHENTICATION_GROUP.\r\n\r\nThis above combination is also the set that is configured by default when enabling auditing from the Azure portal.\r\n\r\nThe supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):\r\n\r\nAPPLICATION_ROLE_CHANGE_PASSWORD_GROUP\r\nBACKUP_RESTORE_GROUP\r\nDATABASE_LOGOUT_GROUP\r\nDATABASE_OBJECT_CHANGE_GROUP\r\nDATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nDATABASE_OBJECT_PERMISSION_CHANGE_GROUP\r\nDATABASE_OPERATION_GROUP\r\nDATABASE_PERMISSION_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_IMPERSONATION_GROUP\r\nDATABASE_ROLE_MEMBER_CHANGE_GROUP\r\nFAILED_DATABASE_AUTHENTICATION_GROUP\r\nSCHEMA_OBJECT_ACCESS_GROUP\r\nSCHEMA_OBJECT_CHANGE_GROUP\r\nSCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nSCHEMA_OBJECT_PERMISSION_CHANGE_GROUP\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP\r\nUSER_CHANGE_PASSWORD_GROUP\r\nBATCH_STARTED_GROUP\r\nBATCH_COMPLETED_GROUP\r\n\r\nThese are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.\r\n\r\nFor more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).\r\n\r\nFor Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:\r\nSELECT\r\nUPDATE\r\nINSERT\r\nDELETE\r\nEXECUTE\r\nRECEIVE\r\nREFERENCES\r\n\r\nThe general form for defining an action to be audited is:\r\n{action} ON {object} BY {principal}\r\n\r\nNote that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.\r\n\r\nFor example:\r\nSELECT on dbo.myTable by public\r\nSELECT on DATABASE::myDatabase by public\r\nSELECT on SCHEMA::mySchema by public\r\n\r\nFor more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)", + "type": "array", + "items": { + "type": "string" + } + }, + "storageAccountSubscriptionId": { + "format": "uuid", + "description": "Specifies the blob storage subscription Id.", + "type": "string" + }, + "isStorageSecondaryKeyInUse": { + "description": "Specifies whether storageAccountAccessKey value is the storage's secondary key.", + "type": "boolean" + }, + "isAzureMonitorTargetEnabled": { + "description": "Specifies whether audit events are sent to Azure Monitor. \r\nIn order to send the events to Azure Monitor, specify 'state' as 'Enabled' and 'isAzureMonitorTargetEnabled' as true.\r\n\r\nWhen using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.\r\nNote that for server level audit you should use the 'master' database as {databaseName}.\r\n\r\nDiagnostic Settings URI format:\r\nPUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview\r\n\r\nFor more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)\r\nor [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)\r\n", + "type": "boolean" + }, + "queueDelayMs": { + "format": "int32", + "description": "Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed.\r\nThe default minimum value is 1000 (1 second). The maximum is 2,147,483,647.", + "type": "integer" + } + } + }, + "ExtendedServerBlobAuditingPolicy": { + "description": "An extended server blob auditing policy.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ExtendedServerBlobAuditingPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "ExtendedServerBlobAuditingPolicyListResult": { + "description": "A list of server extended auditing settings.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ExtendedServerBlobAuditingPolicy" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ServerSecurityAlertPolicyProperties": { + "description": "Properties of a security alert policy.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "state": { + "description": "Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific server", + "enum": [ + "New", + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "SecurityAlertPolicyState", + "modelAsString": false + } + }, + "disabledAlerts": { + "description": "Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action", + "type": "array", + "items": { + "type": "string" + } + }, + "emailAddresses": { + "description": "Specifies an array of e-mail addresses to which the alert is sent.", + "type": "array", + "items": { + "type": "string" + } + }, + "emailAccountAdmins": { + "description": "Specifies that the alert is sent to the account administrators.", + "type": "boolean" + }, + "storageEndpoint": { + "description": "Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.", + "type": "string" + }, + "storageAccountAccessKey": { + "description": "Specifies the identifier key of the Threat Detection audit storage account.", + "type": "string" + }, + "retentionDays": { + "format": "int32", + "description": "Specifies the number of days to keep in the Threat Detection audit logs.", + "type": "integer" + }, + "creationTime": { + "format": "date-time", + "description": "Specifies the UTC creation time of the policy.", + "type": "string", + "readOnly": true + } + } + }, + "ServerSecurityAlertPolicy": { + "description": "Workspace managed Sql server security alert policy.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ServerSecurityAlertPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "ServerSecurityAlertPolicyListResult": { + "description": "A list of the workspace managed sql server's security alert policies.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ServerVulnerabilityAssessmentProperties": { + "description": "Properties of a server Vulnerability Assessment.", + "required": [ + "storageContainerPath" + ], + "type": "object", + "properties": { + "storageContainerPath": { + "description": "A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/).", + "type": "string" + }, + "storageContainerSasKey": { + "description": "A shared access signature (SAS Key) that has read and write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "storageAccountAccessKey": { + "description": "Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "recurringScans": { + "$ref": "#/definitions/VulnerabilityAssessmentRecurringScansProperties", + "description": "The recurring scans settings" + } + } + }, + "VulnerabilityAssessmentRecurringScansProperties": { + "description": "Properties of a Vulnerability Assessment recurring scans.", + "type": "object", + "properties": { + "isEnabled": { + "description": "Recurring scans state.", + "type": "boolean" + }, + "emailSubscriptionAdmins": { + "description": "Specifies that the schedule scan notification will be is sent to the subscription administrators.", + "default": true, + "type": "boolean" + }, + "emails": { + "description": "Specifies an array of e-mail addresses to which the scan notification is sent.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ServerVulnerabilityAssessment": { + "description": "A server vulnerability assessment.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ServerVulnerabilityAssessmentProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "ServerVulnerabilityAssessmentListResult": { + "description": "A list of the server's vulnerability assessments.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ServerVulnerabilityAssessment" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "EncryptionProtectorListResult": { + "description": "A list of server encryption protectors.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/EncryptionProtector" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "EncryptionProtectorProperties": { + "description": "Properties for an encryption protector execution.", + "required": [ + "serverKeyType" + ], + "type": "object", + "properties": { + "subregion": { + "description": "Subregion of the encryption protector.", + "type": "string", + "readOnly": true + }, + "serverKeyName": { + "description": "The name of the server key.", + "type": "string" + }, + "serverKeyType": { + "description": "The encryption protector type like 'ServiceManaged', 'AzureKeyVault'.", + "enum": [ + "ServiceManaged", + "AzureKeyVault" + ], + "type": "string", + "x-ms-enum": { + "name": "ServerKeyType", + "modelAsString": true + } + }, + "uri": { + "description": "The URI of the server key.", + "type": "string", + "readOnly": true + }, + "thumbprint": { + "description": "Thumbprint of the server key.", + "type": "string", + "readOnly": true + } + } + }, + "EncryptionProtector": { + "description": "The server encryption protector.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "kind": { + "description": "Kind of encryption protector. This is metadata used for the Azure portal experience.", + "type": "string", + "readOnly": true + }, + "location": { + "description": "Resource location.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/EncryptionProtectorProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "ServerUsage": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the server usage metric." + }, + "resourceName": { + "readOnly": true, + "type": "string", + "description": "The name of the resource." + }, + "displayName": { + "readOnly": true, + "type": "string", + "description": "The metric display name." + }, + "currentValue": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The current value of the metric." + }, + "limit": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The current limit of the metric." + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "The units of the metric." + }, + "nextResetTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The next reset time for the metric (ISO8601 format)." + } + }, + "description": "Represents server metrics." + }, + "ServerUsageListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServerUsage" + }, + "description": "The list of server metrics for the server." + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + }, + "required": [ + "value" + ], + "description": "Represents the response to a list server metrics request." + }, + "RecoverableSqlPoolProperties": { + "type": "object", + "properties": { + "edition": { + "readOnly": true, + "type": "string", + "description": "The edition of the database" + }, + "serviceLevelObjective": { + "readOnly": true, + "type": "string", + "description": "The service level objective name of the database" + }, + "elasticPoolName": { + "readOnly": true, + "type": "string", + "description": "The elastic pool name of the database" + }, + "lastAvailableBackupDate": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The last available backup date of the database (ISO8601 format)" + } + }, + "description": "The properties of a recoverable sql pool" + }, + "RecoverableSqlPool": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RecoverableSqlPoolProperties", + "description": "The properties of a recoverable sql pool", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "A recoverable sql pool" + }, + "RecoverableSqlPoolListResult": { + "description": "The response to a list recoverable sql pools request", + "type": "object", + "properties": { + "value": { + "description": "A list of recoverable sql pool", + "type": "array", + "items": { + "$ref": "#/definitions/RecoverableSqlPool" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/workspace.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/workspace.json new file mode 100644 index 000000000000..b324b026c98a --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/workspace.json @@ -0,0 +1,1493 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01-preview", + "title": "SynapseManagementClient", + "description": "Azure Synapse Analytics APIs" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "type": "oauth2", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces": { + "get": { + "operationId": "Workspaces_ListByResourceGroup", + "description": "Returns a list of workspaces in a resource group", + "tags": [ + "Workspaces" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/WorkspaceInfoListResult" + }, + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List workspaces in resource group": { + "$ref": "./examples/ListWorkspacesInResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}": { + "get": { + "operationId": "Workspaces_Get", + "description": "Gets a workspace", + "tags": [ + "Workspaces" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/Workspace" + }, + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get a workspace": { + "$ref": "./examples/GetWorkspace.json" + } + } + }, + "patch": { + "operationId": "Workspaces_Update", + "description": "Updates a workspace", + "tags": [ + "Workspaces" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + }, + { + "schema": { + "$ref": "#/definitions/WorkspacePatchInfo" + }, + "in": "body", + "name": "workspacePatchInfo", + "required": true, + "description": "Workspace patch request properties" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/Workspace" + }, + "description": "" + }, + "201": { + "schema": { + "$ref": "#/definitions/Workspace" + }, + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Update a workspace": { + "$ref": "./examples/UpdateWorkspace.json" + } + } + }, + "put": { + "operationId": "Workspaces_CreateOrUpdate", + "description": "Creates or updates a workspace", + "tags": [ + "Workspaces" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + }, + { + "description": "Workspace create or update request properties", + "schema": { + "$ref": "#/definitions/Workspace" + }, + "in": "body", + "name": "workspaceInfo", + "required": true + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/Workspace" + }, + "description": "" + }, + "201": { + "schema": { + "$ref": "#/definitions/Workspace" + }, + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Create or update a workspace": { + "$ref": "./examples/CreateOrUpdateWorkspace.json" + } + } + }, + "delete": { + "operationId": "Workspaces_Delete", + "description": "Deletes a workspace", + "tags": [ + "Workspaces" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "schema": { + "type": "object" + }, + "description": "OK" + }, + "202": { + "schema": { + "type": "object" + }, + "description": "" + }, + "204": { + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete a workspace": { + "$ref": "./examples/DeleteWorkspace.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Synapse/workspaces": { + "get": { + "operationId": "Workspaces_List", + "description": "Returns a list of workspaces in a subscription", + "tags": [ + "Workspaces" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/WorkspaceInfoListResult" + }, + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List workspaces in subscription": { + "$ref": "./examples/ListWorkspacesInSubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/administrators/activeDirectory": { + "get": { + "operationId": "WorkspaceAadAdmins_Get", + "description": "Gets a workspace active directory admin", + "tags": [ + "Workspaces" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/WorkspaceAadAdminInfo" + }, + "description": "OK" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get workspace active directory admin": { + "$ref": "./examples/GetWorkspaceAadAdmin.json" + } + } + }, + "put": { + "operationId": "WorkspaceAadAdmins_CreateOrUpdate", + "description": "Creates or updates a workspace active directory admin", + "tags": [ + "Workspaces" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + }, + { + "description": "Workspace active directory administrator properties", + "schema": { + "$ref": "#/definitions/WorkspaceAadAdminInfo" + }, + "in": "body", + "name": "aadAdminInfo", + "required": true + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/WorkspaceAadAdminInfo" + } + }, + "202": { + "description": "", + "schema": { + "$ref": "#/definitions/WorkspaceAadAdminInfo" + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Create or update workspace active directory admin": { + "$ref": "./examples/CreateOrUpdateWorkspaceAadAdmin.json" + } + } + }, + "delete": { + "operationId": "WorkspaceAadAdmins_Delete", + "description": "Deletes a workspace active directory admin", + "tags": [ + "Workspaces" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "" + }, + "204": { + "description": "Accepted" + }, + "202": { + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete workspace active directory admin": { + "$ref": "./examples/DeleteWorkspaceAadAdmin.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlAdministrators/activeDirectory": { + "get": { + "operationId": "WorkspaceSqlAadAdmins_Get", + "description": "Gets a workspace SQL active directory admin", + "tags": [ + "Workspaces" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/WorkspaceAadAdminInfo" + }, + "description": "OK" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get workspace active directory admin": { + "$ref": "./examples/GetWorkspaceAadAdmin.json" + } + } + }, + "put": { + "operationId": "WorkspaceSqlAadAdmins_CreateOrUpdate", + "description": "Creates or updates a workspace SQL active directory admin", + "tags": [ + "Workspaces" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + }, + { + "description": "Workspace active directory administrator properties", + "schema": { + "$ref": "#/definitions/WorkspaceAadAdminInfo" + }, + "in": "body", + "name": "aadAdminInfo", + "required": true + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/WorkspaceAadAdminInfo" + } + }, + "202": { + "description": "", + "schema": { + "$ref": "#/definitions/WorkspaceAadAdminInfo" + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Create or update workspace active directory admin": { + "$ref": "./examples/CreateOrUpdateWorkspaceAadAdmin.json" + } + } + }, + "delete": { + "operationId": "WorkspaceSqlAadAdmins_Delete", + "description": "Deletes a workspace SQL active directory admin", + "tags": [ + "Workspaces" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "" + }, + "204": { + "description": "Accepted" + }, + "202": { + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete workspace active directory admin": { + "$ref": "./examples/DeleteWorkspaceAadAdmin.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/managedIdentitySqlControlSettings/default": { + "get": { + "operationId": "WorkspaceManagedIdentitySqlControlSettings_Get", + "summary": "Get Managed Identity Sql Control Settings", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/ManagedIdentitySqlControlSettingsModel" + }, + "description": "OK" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "Error" + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get managed identity sql control settings": { + "$ref": "./examples/GetManagedIdentitySqlControlSettings.json" + } + } + }, + "put": { + "operationId": "WorkspaceManagedIdentitySqlControlSettings_CreateOrUpdate", + "summary": "Create or update Managed Identity Sql Control Settings", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "description": "Managed Identity Sql Control Settings", + "schema": { + "$ref": "#/definitions/ManagedIdentitySqlControlSettingsModel" + }, + "in": "body", + "name": "managedIdentitySqlControlSettings", + "required": true + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/ManagedIdentitySqlControlSettingsModel" + }, + "description": "OK" + }, + "201": { + "description": "Created" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "Error" + } + }, + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create or update managed identity sql control settings": { + "$ref": "./examples/CreateOrUpdateManagedIdentitySqlControlSettings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/restorableDroppedSqlPools/{restorableDroppedSqlPoolId}": { + "get": { + "tags": [ + "RestorableDroppedSqlPools" + ], + "operationId": "RestorableDroppedSqlPools_Get", + "description": "Gets a deleted sql pool that can be restored", + "x-ms-examples": { + "Get a restorable dropped Sql pool": { + "$ref": "./examples/RestorableDroppedSqlPoolGet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + }, + { + "name": "restorableDroppedSqlPoolId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the deleted Sql Pool in the form of sqlPoolName,deletionTimeInFileTimeFormat" + } + ], + "consumes": [], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RestorableDroppedSqlPool" + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "Error" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/restorableDroppedSqlPools": { + "get": { + "tags": [ + "RestorableDroppedSqlPools" + ], + "operationId": "RestorableDroppedSqlPools_ListByWorkspace", + "description": "Gets a list of deleted Sql pools that can be restored", + "x-ms-examples": { + "Get list of restorable dropped Sql pools": { + "$ref": "./examples/RestorableDroppedSqlpoolList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + } + ], + "consumes": [], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RestorableDroppedSqlPoolListResult" + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "Error" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + } + }, + "definitions": { + "AadAdminProperties": { + "description": "Workspace active directory administrator properties", + "type": "object", + "properties": { + "tenantId": { + "description": "Tenant ID of the workspace active directory administrator", + "type": "string" + }, + "login": { + "description": "Login of the workspace active directory administrator", + "type": "string" + }, + "administratorType": { + "description": "Workspace active directory administrator type", + "type": "string" + }, + "sid": { + "description": "Object ID of the workspace active directory administrator", + "type": "string" + } + } + }, + "WorkspaceInfoListResult": { + "description": "List of workspaces", + "type": "object", + "properties": { + "nextLink": { + "description": "Link to the next page of results", + "type": "string" + }, + "value": { + "description": "List of workspaces", + "type": "array", + "items": { + "$ref": "#/definitions/Workspace" + } + } + } + }, + "DataLakeStorageAccountDetails": { + "description": "Details of the data lake storage account associated with the workspace", + "type": "object", + "properties": { + "accountUrl": { + "description": "Account URL", + "type": "string" + }, + "filesystem": { + "description": "Filesystem name", + "type": "string" + } + } + }, + "EncryptionDetails": { + "description": "Details of the encryption associated with the workspace", + "type": "object", + "properties": { + "doubleEncryptionEnabled": { + "description": "Double Encryption enabled", + "type": "boolean", + "readOnly": true + }, + "cmk": { + "description": "Customer Managed Key Details", + "$ref": "#/definitions/CustomerManagedKeyDetails" + } + } + }, + "CustomerManagedKeyDetails": { + "description": "Details of the customer managed key associated with the workspace", + "type": "object", + "properties": { + "status": { + "description": "The customer managed key status on the workspace", + "type": "string", + "readOnly": true + }, + "key": { + "description": "The key object of the workspace", + "$ref": "#/definitions/WorkspaceKeyDetails" + }, + "kekIdentity": { + "description": "Key encryption key", + "$ref": "#/definitions/KekIdentityProperties" + } + } + }, + "KekIdentityProperties": { + "description": "Key encryption key properties", + "type": "object", + "properties": { + "userAssignedIdentity": { + "description": "User assigned identity resource Id", + "type": "string" + }, + "useSystemAssignedIdentity": { + "description": "Boolean specifying whether to use system assigned identity or not" + } + } + }, + "WorkspaceKeyDetails": { + "description": "Details of the customer managed key associated with the workspace", + "type": "object", + "properties": { + "name": { + "description": "Workspace Key sub-resource name", + "type": "string" + }, + "keyVaultUrl": { + "description": "Workspace Key sub-resource key vault url", + "type": "string" + } + } + }, + "ManagedIdentity": { + "description": "The workspace managed identity", + "type": "object", + "properties": { + "principalId": { + "description": "The principal ID of the workspace managed identity", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "The tenant ID of the workspace managed identity", + "type": "string", + "format": "uuid", + "readOnly": true + }, + "type": { + "description": "The type of managed identity for the workspace", + "enum": [ + "None", + "SystemAssigned", + "SystemAssigned,UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "description": "The user assigned managed identities.", + "$ref": "#/definitions/UserAssignedManagedIdentities" + } + } + }, + "UserAssignedManagedIdentities": { + "type": "object", + "description": "The User Assigned Managed Identities.", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedManagedIdentity" + } + }, + "UserAssignedManagedIdentity": { + "description": "User Assigned Managed Identity", + "properties": { + "clientId": { + "type": "string", + "format": "uuid", + "description": "The client ID.", + "readOnly": true, + "x-nullable": true + }, + "principalId": { + "type": "string", + "format": "uuid", + "description": "The principal ID.", + "readOnly": true, + "x-nullable": true + } + }, + "type": "object" + }, + "VirtualNetworkProfile": { + "description": "Virtual Network Profile", + "type": "object", + "properties": { + "computeSubnetId": { + "description": "Subnet ID used for computes in workspace", + "type": "string" + } + } + }, + "ManagedVirtualNetworkSettings": { + "description": "Managed Virtual Network Settings", + "type": "object", + "properties": { + "preventDataExfiltration": { + "description": "Prevent Data Exfiltration", + "type": "boolean" + }, + "linkedAccessCheckOnTargetResource": { + "description": "Linked Access Check On Target Resource", + "type": "boolean" + }, + "allowedAadTenantIdsForLinking": { + "description": "Allowed Aad Tenant Ids For Linking", + "type": "array", + "items": { + "type": "string", + "description": "Tenant Id" + } + } + } + }, + "WorkspaceRepositoryConfiguration": { + "description": "Git integration settings", + "type": "object", + "properties": { + "type": { + "description": "Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration", + "type": "string" + }, + "hostName": { + "description": "GitHub Enterprise host name. For example: https://github.mydomain.com", + "type": "string" + }, + "accountName": { + "description": "Account name", + "type": "string" + }, + "projectName": { + "description": "VSTS project name", + "type": "string" + }, + "repositoryName": { + "description": "Repository name", + "type": "string" + }, + "collaborationBranch": { + "description": "Collaboration branch", + "type": "string" + }, + "rootFolder": { + "description": "Root folder to use in the repository", + "type": "string" + }, + "lastCommitId": { + "description": "The last commit ID", + "type": "string" + }, + "tenantId": { + "description": "The VSTS tenant ID", + "type": "string", + "format": "uuid" + } + } + }, + "PurviewConfiguration": { + "description": "Purview Configuration", + "type": "object", + "properties": { + "purviewResourceId": { + "description": "Purview Resource ID", + "type": "string" + } + } + }, + "WorkspaceAadAdminInfo": { + "description": "Workspace active directory administrator", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Workspace active directory administrator properties", + "$ref": "#/definitions/AadAdminProperties", + "x-ms-client-flatten": true + } + } + }, + "CspWorkspaceAdminProperties": { + "description": "Initial workspace AAD admin properties for a CSP subscription", + "properties": { + "initialWorkspaceAdminObjectId": { + "description": "AAD object ID of initial workspace admin", + "type": "string" + } + } + }, + "Workspace": { + "description": "A workspace", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Workspace resource properties", + "$ref": "#/definitions/WorkspaceProperties", + "x-ms-client-flatten": true + }, + "identity": { + "description": "Identity of the workspace", + "$ref": "#/definitions/ManagedIdentity" + } + } + }, + "WorkspaceProperties": { + "description": "Workspace properties", + "type": "object", + "properties": { + "defaultDataLakeStorage": { + "description": "Workspace default data lake storage account details", + "$ref": "#/definitions/DataLakeStorageAccountDetails" + }, + "sqlAdministratorLoginPassword": { + "description": "SQL administrator login password", + "type": "string" + }, + "managedResourceGroupName": { + "description": "Workspace managed resource group. The resource group name uniquely identifies the resource group within the user subscriptionId. The resource group name must be no longer than 90 characters long, and must be alphanumeric characters (Char.IsLetterOrDigit()) and '-', '_', '(', ')' and'.'. Note that the name cannot end with '.'", + "type": "string" + }, + "provisioningState": { + "description": "Resource provisioning state", + "type": "string", + "readOnly": true + }, + "sqlAdministratorLogin": { + "description": "Login for workspace SQL active directory administrator", + "type": "string" + }, + "virtualNetworkProfile": { + "description": "Virtual Network profile", + "$ref": "#/definitions/VirtualNetworkProfile" + }, + "connectivityEndpoints": { + "description": "Connectivity endpoints", + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "managedVirtualNetwork": { + "description": "Setting this to 'default' will ensure that all compute for this workspace is in a virtual network managed on behalf of the user.", + "type": "string" + }, + "privateEndpointConnections": { + "description": "Private endpoint connections to the workspace", + "type": "array", + "items": { + "$ref": "../../../../common/v1/privateEndpointConnection.json#/definitions/PrivateEndpointConnection" + } + }, + "encryption": { + "description": "The encryption details of the workspace", + "$ref": "#/definitions/EncryptionDetails" + }, + "workspaceUID": { + "description": "The workspace unique identifier", + "type": "string", + "readOnly": true, + "format": "uuid" + }, + "extraProperties": { + "description": "Workspace level configs and feature flags", + "additionalProperties": { + "type": "object" + }, + "type": "object", + "readOnly": true + }, + "managedVirtualNetworkSettings": { + "description": "Managed Virtual Network Settings", + "$ref": "#/definitions/ManagedVirtualNetworkSettings" + }, + "workspaceRepositoryConfiguration": { + "description": "Git integration settings", + "$ref": "#/definitions/WorkspaceRepositoryConfiguration" + }, + "purviewConfiguration": { + "description": "Purview Configuration", + "$ref": "#/definitions/PurviewConfiguration" + }, + "adlaResourceId": { + "description": "The ADLA resource ID.", + "type": "string", + "readOnly": true + }, + "publicNetworkAccess": { + "enum": [ + "Enabled", + "Disabled" + ], + "description": "Enable or Disable public network access to workspace", + "type": "string", + "x-ms-enum": { + "name": "WorkspacePublicNetworkAccess", + "modelAsString": true + } + }, + "cspWorkspaceAdminProperties": { + "description": "Initial workspace AAD admin properties for a CSP subscription", + "$ref": "#/definitions/CspWorkspaceAdminProperties" + } + } + }, + "WorkspacePatchInfo": { + "description": "Workspace patch details", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags", + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "identity": { + "description": "The identity of the workspace", + "$ref": "#/definitions/ManagedIdentity" + }, + "properties": { + "description": "Workspace patch properties", + "$ref": "#/definitions/WorkspacePatchProperties", + "x-ms-client-flatten": true + } + } + }, + "WorkspacePatchProperties": { + "description": "Workspace patch properties", + "type": "object", + "properties": { + "sqlAdministratorLoginPassword": { + "description": "SQL administrator login password", + "type": "string" + }, + "managedVirtualNetworkSettings": { + "description": "Managed Virtual Network Settings", + "$ref": "#/definitions/ManagedVirtualNetworkSettings" + }, + "workspaceRepositoryConfiguration": { + "description": "Git integration settings", + "$ref": "#/definitions/WorkspaceRepositoryConfiguration" + }, + "purviewConfiguration": { + "description": "Purview Configuration", + "$ref": "#/definitions/PurviewConfiguration" + }, + "provisioningState": { + "description": "Resource provisioning state", + "type": "string", + "readOnly": true + }, + "encryption": { + "description": "The encryption details of the workspace", + "$ref": "#/definitions/EncryptionDetails" + }, + "publicNetworkAccess": { + "enum": [ + "Enabled", + "Disabled" + ], + "description": "Enable or Disable public network access to workspace", + "type": "string", + "x-ms-enum": { + "name": "WorkspacePublicNetworkAccess", + "modelAsString": true + } + } + } + }, + "ManagedIdentitySqlControlSettingsModel": { + "type": "object", + "title": "Managed Identity Sql Control Settings", + "description": "Sql Control Settings for workspace managed identity", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "title": "Managed Identity Sql Control Settings", + "description": "Sql Control Settings for workspace managed identity", + "properties": { + "grantSqlControlToManagedIdentity": { + "type": "object", + "description": "Grant sql control to managed identity", + "properties": { + "desiredState": { + "description": "Desired state", + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ] + }, + "actualState": { + "description": "Actual state", + "type": "string", + "enum": [ + "Enabling", + "Enabled", + "Disabling", + "Disabled", + "Unknown" + ], + "readOnly": true + } + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "RestorableDroppedSqlPoolProperties": { + "properties": { + "databaseName": { + "readOnly": true, + "type": "string", + "description": "The name of the database" + }, + "edition": { + "readOnly": true, + "type": "string", + "description": "The edition of the database" + }, + "maxSizeBytes": { + "readOnly": true, + "type": "string", + "description": "The max size in bytes of the database" + }, + "serviceLevelObjective": { + "readOnly": true, + "type": "string", + "description": "The service level objective name of the database" + }, + "elasticPoolName": { + "readOnly": true, + "type": "string", + "description": "The elastic pool name of the database" + }, + "creationDate": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The creation date of the database (ISO8601 format)" + }, + "deletionDate": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The deletion date of the database (ISO8601 format)" + }, + "earliestRestoreDate": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The earliest restore date of the database (ISO8601 format)" + } + }, + "description": "The properties of a restorable dropped Sql pool" + }, + "RestorableDroppedSqlPool": { + "properties": { + "location": { + "type": "string", + "readOnly": true, + "description": "The geo-location where the resource lives" + }, + "properties": { + "$ref": "#/definitions/RestorableDroppedSqlPoolProperties", + "description": "The properties of a restorable dropped Sql pool", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "A restorable dropped Sql pool" + }, + "RestorableDroppedSqlPoolListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RestorableDroppedSqlPool" + }, + "description": "A list of restorable dropped Sql pools" + } + }, + "required": [ + "value" + ], + "description": "The response to a list restorable dropped Sql pools request" + } + }, + "parameters": { + "workspaceNameParameter": { + "name": "workspaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the workspace", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/bigDataPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/bigDataPool.json index fd2bf8e56cac..c62036c7ed34 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/bigDataPool.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/bigDataPool.json @@ -481,7 +481,9 @@ "nodeSizeFamily": { "enum": [ "None", - "MemoryOptimized" + "MemoryOptimized", + "HardwareAcceleratedFPGA", + "HardwareAcceleratedGPU" ], "type": "string", "description": "The kind of nodes that the Big Data pool provides.", diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/examples/IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/examples/IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints.json new file mode 100644 index 000000000000..67a008848aaf --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/examples/IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "ebc1447e-fd9e-4c62-924f-24f9e075a240", + "resourceGroupName": "exampleResourceGroup", + "workspaceName": "exampleWorkspace", + "integrationRuntimeName": "exampleIntegrationRuntime", + "api-version": "2020-12-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Tue, 06 Jul 2021 04:28:10 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-request-id": "8782a232-2913-4c9c-8a9f-4e26e5946991", + "x-ms-correlation-request-id": "caf41f8e-591b-48c1-8902-628b9c564d00" + }, + "body": { + "value": [ + { + "category": "Azure Data Factory (Management)", + "endpoints": [ + { + "domainName": "wu.frontend.int.clouddatahub-int.net", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Azure Storage (Management)", + "endpoints": [ + { + "domainName": "*.blob.core.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "domainName": "*.table.core.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Event Hub (Logging)", + "endpoints": [ + { + "domainName": "*.servicebus.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Microsoft Logging service (Internal Use)", + "endpoints": [ + { + "domainName": "gcs.prod.monitoring.core.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "domainName": "prod.warmpath.msftcloudes.com", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "domainName": "azurewatsonanalysis-prod.core.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/integrationRuntime.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/integrationRuntime.json index 3aecc6e4925f..43144d0b49c3 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/integrationRuntime.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/integrationRuntime.json @@ -1166,6 +1166,58 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/outboundNetworkDependenciesEndpoints": { + "get": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints", + "description": "Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime.", + "summary": "Gets list of outbound network dependencies for a given Azure-SSIS integration runtime.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/IntegrationRuntimeNameParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get outbound network dependency endpoints": { + "$ref": "./examples/IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/enableInteractiveQuery": { "post": { "operationId": "IntegrationRuntimes_EnableInteractiveQuery", @@ -1443,6 +1495,10 @@ "type": "string", "description": "The ID of the public IP address." } + }, + "subnetId": { + "description": "The ID of subnet, to which this Azure-SSIS integration runtime will be joined.", + "type": "string" } }, "additionalProperties": { @@ -2894,6 +2950,64 @@ "description": "The operation error message." } } + }, + "IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse": { + "description": "Azure-SSIS integration runtime outbound network dependency endpoints.", + "type": "object", + "properties": { + "value": { + "description": "The list of outbound network dependency endpoints.", + "type": "array", + "items": { + "$ref": "#/definitions/IntegrationRuntimeOutboundNetworkDependenciesCategoryEndpoint" + } + } + } + }, + "IntegrationRuntimeOutboundNetworkDependenciesCategoryEndpoint": { + "description": "Azure-SSIS integration runtime outbound network dependency endpoints for one category.", + "type": "object", + "properties": { + "category": { + "description": "The category of outbound network dependency.", + "type": "string" + }, + "endpoints": { + "description": "The endpoints for outbound network dependency.", + "type": "array", + "items": { + "$ref": "#/definitions/IntegrationRuntimeOutboundNetworkDependenciesEndpoint" + } + } + } + }, + "IntegrationRuntimeOutboundNetworkDependenciesEndpoint": { + "description": "The endpoint for Azure-SSIS integration runtime outbound network dependency.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name of endpoint.", + "type": "string" + }, + "endpointDetails": { + "description": "The details of endpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails" + } + } + } + }, + "IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails": { + "description": "The details of Azure-SSIS integration runtime outbound network dependency endpoint.", + "type": "object", + "properties": { + "port": { + "description": "The port of endpoint.", + "type": "integer", + "format": "int32" + } + } } }, "parameters": { diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-03-01/bigDataPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-03-01/bigDataPool.json index 3016a1927fe4..c68c04f9f049 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-03-01/bigDataPool.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-03-01/bigDataPool.json @@ -481,7 +481,9 @@ "nodeSizeFamily": { "enum": [ "None", - "MemoryOptimized" + "MemoryOptimized", + "HardwareAcceleratedFPGA", + "HardwareAcceleratedGPU" ], "type": "string", "description": "The kind of nodes that the Big Data pool provides.", diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-03-01/examples/IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-03-01/examples/IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints.json new file mode 100644 index 000000000000..8df846670535 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-03-01/examples/IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "ade9c2b6-c160-4305-9bb9-80342f6c1ae2", + "resourceGroupName": "exampleResourceGroup", + "workspaceName": "exampleWorkspace", + "integrationRuntimeName": "exampleIntegrationRuntime", + "api-version": "2021-03-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Tue, 06 Jul 2021 04:28:10 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-request-id": "fd8e4223-7e9c-4f32-893f-06c14a8081be", + "x-ms-correlation-request-id": "1dabf122-e061-4703-ae9e-9edeeef40ee6" + }, + "body": { + "value": [ + { + "category": "Azure Data Factory (Management)", + "endpoints": [ + { + "domainName": "wu.frontend.int.clouddatahub-int.net", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Azure Storage (Management)", + "endpoints": [ + { + "domainName": "*.blob.core.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "domainName": "*.table.core.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Event Hub (Logging)", + "endpoints": [ + { + "domainName": "*.servicebus.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Microsoft Logging service (Internal Use)", + "endpoints": [ + { + "domainName": "gcs.prod.monitoring.core.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "domainName": "prod.warmpath.msftcloudes.com", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "domainName": "azurewatsonanalysis-prod.core.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-03-01/integrationRuntime.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-03-01/integrationRuntime.json index 92aeb60e0812..f0e8e7d7b0dc 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-03-01/integrationRuntime.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-03-01/integrationRuntime.json @@ -1166,6 +1166,58 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/outboundNetworkDependenciesEndpoints": { + "get": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints", + "description": "Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime.", + "summary": "Gets list of outbound network dependencies for a given Azure-SSIS integration runtime.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/IntegrationRuntimeNameParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get outbound network dependency endpoints": { + "$ref": "./examples/IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/enableInteractiveQuery": { "post": { "operationId": "IntegrationRuntimes_EnableInteractiveQuery", @@ -1443,6 +1495,10 @@ "type": "string", "description": "The ID of the public IP address." } + }, + "subnetId": { + "description": "The ID of subnet, to which this Azure-SSIS integration runtime will be joined.", + "type": "string" } }, "additionalProperties": { @@ -2894,6 +2950,64 @@ "description": "The operation error message." } } + }, + "IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse": { + "description": "Azure-SSIS integration runtime outbound network dependency endpoints.", + "type": "object", + "properties": { + "value": { + "description": "The list of outbound network dependency endpoints.", + "type": "array", + "items": { + "$ref": "#/definitions/IntegrationRuntimeOutboundNetworkDependenciesCategoryEndpoint" + } + } + } + }, + "IntegrationRuntimeOutboundNetworkDependenciesCategoryEndpoint": { + "description": "Azure-SSIS integration runtime outbound network dependency endpoints for one category.", + "type": "object", + "properties": { + "category": { + "description": "The category of outbound network dependency.", + "type": "string" + }, + "endpoints": { + "description": "The endpoints for outbound network dependency.", + "type": "array", + "items": { + "$ref": "#/definitions/IntegrationRuntimeOutboundNetworkDependenciesEndpoint" + } + } + } + }, + "IntegrationRuntimeOutboundNetworkDependenciesEndpoint": { + "description": "The endpoint for Azure-SSIS integration runtime outbound network dependency.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name of endpoint.", + "type": "string" + }, + "endpointDetails": { + "description": "The details of endpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails" + } + } + } + }, + "IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails": { + "description": "The details of Azure-SSIS integration runtime outbound network dependency endpoint.", + "type": "object", + "properties": { + "port": { + "description": "The port of endpoint.", + "type": "integer", + "format": "int32" + } + } } }, "parameters": { diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/bigDataPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/bigDataPool.json new file mode 100644 index 000000000000..ba6efc5c6a9e --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/bigDataPool.json @@ -0,0 +1,611 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-05-01", + "title": "SynapseManagementClient", + "description": "Azure Synapse Analytics APIs" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "type": "oauth2", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/bigDataPools/{bigDataPoolName}": { + "get": { + "operationId": "BigDataPools_Get", + "summary": "Get Big Data pool", + "description": "Get a Big Data pool.", + "tags": [ + "BigDataPools" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "bigDataPoolName", + "description": "Big Data pool name", + "required": true + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/BigDataPoolResourceInfo" + }, + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get a Big Data pool": { + "$ref": "./examples/GetBigDataPool.json" + } + } + }, + "patch": { + "operationId": "BigDataPools_Update", + "summary": "Update a Big Data pool.", + "description": "Patch a Big Data pool.", + "tags": [ + "BigDataPools" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "bigDataPoolName", + "description": "Big Data pool name", + "required": true + }, + { + "schema": { + "$ref": "#/definitions/BigDataPoolPatchInfo" + }, + "in": "body", + "name": "bigDataPoolPatchInfo", + "description": "The updated Big Data pool properties", + "required": true + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/BigDataPoolResourceInfo" + }, + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Update a Big Data pool": { + "$ref": "./examples/UpdateBigDataPool.json" + } + } + }, + "put": { + "operationId": "BigDataPools_CreateOrUpdate", + "summary": "Create a Big Data pool.", + "description": "Create a new Big Data pool.", + "tags": [ + "BigDataPools" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "bigDataPoolName", + "description": "Big Data pool name", + "required": true + }, + { + "name": "force", + "type": "boolean", + "in": "query", + "description": "Whether to stop any running jobs in the Big Data pool", + "required": false, + "default": false + }, + { + "schema": { + "$ref": "#/definitions/BigDataPoolResourceInfo" + }, + "in": "body", + "name": "bigDataPoolInfo", + "description": "The Big Data pool to create.", + "required": true + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/BigDataPoolResourceInfo" + }, + "description": "OK" + }, + "202": { + "schema": { + "$ref": "#/definitions/BigDataPoolResourceInfo" + }, + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Create or update a Big Data pool": { + "$ref": "./examples/CreateOrUpdateBigDataPool.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "BigDataPools_Delete", + "summary": "Delete a Big Data pool.", + "description": "Delete a Big Data pool from the workspace.", + "tags": [ + "BigDataPools" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "bigDataPoolName", + "description": "Big Data pool name", + "required": true + } + ], + "responses": { + "200": { + "schema": { + "type": "object" + }, + "description": "OK" + }, + "202": { + "schema": { + "type": "object" + }, + "description": "" + }, + "204": { + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Delete a Big Data pool": { + "$ref": "./examples/DeleteBigDataPool.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.Synapse/workspaces/{workspaceName}/bigDataPools": { + "get": { + "operationId": "BigDataPools_ListByWorkspace", + "summary": "List the Big Data pools in a workspace.", + "description": "List Big Data pools in a workspace.", + "tags": [ + "BigDataPools" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/BigDataPoolResourceInfoListResult" + }, + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "List Big Data pools in a workspace": { + "$ref": "./examples/ListBigDataPoolsInWorkspace.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "BigDataPoolResourceInfoListResult": { + "type": "object", + "description": "Collection of Big Data pool information", + "title": "Collection of Big Data pools", + "properties": { + "nextLink": { + "type": "string", + "description": "Link to the next page of results" + }, + "value": { + "type": "array", + "description": "List of Big Data pools", + "items": { + "$ref": "#/definitions/BigDataPoolResourceInfo" + } + } + } + }, + "BigDataPoolPatchInfo": { + "type": "object", + "description": "Properties patch for a Big Data pool", + "title": "Patch for a Big Data pool", + "properties": { + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Updated tags for the Big Data pool", + "type": "object" + } + } + }, + "BigDataPoolResourceInfo": { + "type": "object", + "description": "A Big Data pool", + "title": "Big Data pool", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BigDataPoolResourceProperties", + "description": "Big Data pool properties", + "x-ms-client-flatten": true + } + } + }, + "BigDataPoolResourceProperties": { + "type": "object", + "description": "Properties of a Big Data pool powered by Apache Spark", + "title": "Spark pool properties", + "properties": { + "provisioningState": { + "type": "string", + "description": "The state of the Big Data pool." + }, + "autoScale": { + "$ref": "#/definitions/AutoScaleProperties", + "description": "Auto-scaling properties" + }, + "creationDate": { + "type": "string", + "format": "date-time", + "description": "The time when the Big Data pool was created." + }, + "autoPause": { + "$ref": "#/definitions/AutoPauseProperties", + "description": "Auto-pausing properties" + }, + "isComputeIsolationEnabled": { + "type": "boolean", + "description": "Whether compute isolation is required or not." + }, + "sessionLevelPackagesEnabled": { + "type": "boolean", + "description": "Whether session level packages enabled." + }, + "cacheSize": { + "type": "integer", + "format": "int32", + "description": "The cache size" + }, + "dynamicExecutorAllocation": { + "$ref": "#/definitions/DynamicExecutorAllocation", + "description": "Dynamic Executor Allocation" + }, + "sparkEventsFolder": { + "type": "string", + "description": "The Spark events folder" + }, + "nodeCount": { + "type": "integer", + "format": "int32", + "description": "The number of nodes in the Big Data pool." + }, + "libraryRequirements": { + "$ref": "#/definitions/LibraryRequirements", + "description": "Library version requirements" + }, + "customLibraries": { + "description": "List of custom libraries/packages associated with the spark pool.", + "type": "array", + "items": { + "$ref": "#/definitions/LibraryInfo" + } + }, + "sparkConfigProperties": { + "$ref": "#/definitions/LibraryRequirements", + "description": "Spark configuration file to specify additional properties" + }, + "sparkVersion": { + "type": "string", + "description": "The Apache Spark version." + }, + "defaultSparkLogFolder": { + "type": "string", + "description": "The default folder where Spark logs will be written." + }, + "nodeSize": { + "enum": [ + "None", + "Small", + "Medium", + "Large", + "XLarge", + "XXLarge", + "XXXLarge" + ], + "type": "string", + "description": "The level of compute power that each node in the Big Data pool has.", + "x-ms-enum": { + "name": "NodeSize", + "modelAsString": true + } + }, + "nodeSizeFamily": { + "enum": [ + "None", + "MemoryOptimized", + "HardwareAcceleratedFPGA", + "HardwareAcceleratedGPU" + ], + "type": "string", + "description": "The kind of nodes that the Big Data pool provides.", + "x-ms-enum": { + "name": "NodeSizeFamily", + "modelAsString": true + } + }, + "lastSucceededTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the Big Data pool was updated successfully.", + "readOnly": true + } + } + }, + "AutoScaleProperties": { + "type": "object", + "description": "Auto-scaling properties of a Big Data pool powered by Apache Spark", + "title": "Spark pool auto-scaling properties", + "properties": { + "minNodeCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of nodes the Big Data pool can support." + }, + "enabled": { + "type": "boolean", + "description": "Whether automatic scaling is enabled for the Big Data pool." + }, + "maxNodeCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of nodes the Big Data pool can support." + } + } + }, + "AutoPauseProperties": { + "type": "object", + "description": "Auto-pausing properties of a Big Data pool powered by Apache Spark", + "title": "Spark pool auto-pausing properties", + "properties": { + "delayInMinutes": { + "type": "integer", + "format": "int32", + "description": "Number of minutes of idle time before the Big Data pool is automatically paused." + }, + "enabled": { + "type": "boolean", + "description": "Whether auto-pausing is enabled for the Big Data pool." + } + } + }, + "DynamicExecutorAllocation": { + "type": "object", + "description": "Dynamic Executor Allocation Properties", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates whether Dynamic Executor Allocation is enabled or not." + } + } + }, + "LibraryInfo": { + "type": "object", + "description": "Library/package information of a Big Data pool powered by Apache Spark", + "title": "Information about a library/package created at the workspace level.", + "properties": { + "name": { + "type": "string", + "description": "Name of the library." + }, + "path": { + "type": "string", + "description": "Storage blob path of library." + }, + "containerName": { + "type": "string", + "description": "Storage blob container name." + }, + "uploadedTimestamp": { + "type": "string", + "format": "date-time", + "description": "The last update time of the library.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Type of the library." + }, + "provisioningStatus": { + "readOnly": true, + "type": "string", + "description": "Provisioning status of the library/package." + }, + "creatorId": { + "readOnly": true, + "type": "string", + "description": "Creator Id of the library/package." + } + } + }, + "LibraryRequirements": { + "type": "object", + "description": "Library requirements for a Big Data pool powered by Apache Spark", + "title": "Spark pool library version requirements", + "properties": { + "time": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The last update time of the library requirements file." + }, + "content": { + "type": "string", + "description": "The library requirements." + }, + "filename": { + "type": "string", + "description": "The filename of the library requirements file." + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/checkNameAvailability.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/checkNameAvailability.json new file mode 100644 index 000000000000..f660f4e5391e --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/checkNameAvailability.json @@ -0,0 +1,121 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-05-01", + "title": "SynapseManagementClient", + "description": "Azure Synapse Analytics APIs" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "type": "oauth2", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Synapse/checkNameAvailability": { + "post": { + "operationId": "Operations_CheckNameAvailability", + "summary": "Check name availability", + "description": "Check whether a workspace name is available", + "tags": [ + "Operations" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityRequest" + }, + "in": "body", + "name": "request", + "required": true, + "description": "The check request" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResponse" + }, + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Check for a workspace name that is available": { + "$ref": "./examples/CheckNameAvailabilityWorkspaceAvailable.json" + }, + "Check for a workspace name that already exists": { + "$ref": "./examples/CheckNameAvailabilityWorkspaceAlreadyExists.json" + } + } + } + } + }, + "definitions": { + "CheckNameAvailabilityRequest": { + "type": "object", + "title": "Check name availability request", + "description": "A request about whether a workspace name is available", + "properties": { + "name": { + "type": "string", + "description": "Workspace name" + }, + "type": { + "type": "string", + "description": "Type: workspace" + } + } + }, + "CheckNameAvailabilityResponse": { + "type": "object", + "title": "Check name availability response", + "description": "A response saying whether the workspace name is available", + "properties": { + "message": { + "type": "string", + "description": "Validation message" + }, + "available": { + "type": "boolean", + "description": "Whether the workspace name is available" + }, + "reason": { + "type": "string", + "description": "Reason the workspace name is or is not available" + }, + "name": { + "type": "string", + "description": "Workspace name" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ApprovePrivateEndpointConnection.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ApprovePrivateEndpointConnection.json new file mode 100644 index 000000000000..990e91788712 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ApprovePrivateEndpointConnection.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "privateEndpointConnectionName": "ExamplePrivateEndpointConnection", + "api-version": "2021-05-01", + "request": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by abc@example.com" + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/privateEndpointConnections/ExamplePrivateEndpointConnection", + "name": "sql", + "type": "Microsoft.Synapse/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Provisioning", + "privateEndpoint": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Network/privateEndpoints/ExamplePrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/privateEndpointConnections/ExamplePrivateEndpointConnection", + "name": "sql", + "type": "Microsoft.Synapse/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Network/privateEndpoints/ExamplePrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CheckNameAvailabilityWorkspaceAlreadyExists.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CheckNameAvailabilityWorkspaceAlreadyExists.json new file mode 100644 index 000000000000..ebd4966a36e4 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CheckNameAvailabilityWorkspaceAlreadyExists.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2021-05-01", + "request": { + "name": "workspace1", + "type": "Microsoft.Synapse/workspaces" + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "available": false, + "reason": "AlreadyExists", + "message": "Specified workspace name is already used" + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CheckNameAvailabilityWorkspaceAvailable.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CheckNameAvailabilityWorkspaceAvailable.json new file mode 100644 index 000000000000..1330e50f0661 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CheckNameAvailabilityWorkspaceAvailable.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2021-05-01", + "request": { + "name": "workspace1", + "type": "Microsoft.ProjectArcadia/workspaces" + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "available": true, + "reason": null, + "message": null + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateIpFirewallRule.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateIpFirewallRule.json new file mode 100644 index 000000000000..2c9a3240b74d --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateIpFirewallRule.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "ruleName": "ExampleIpFirewallRule", + "api-version": "2021-05-01", + "ipFirewallRuleInfo": { + "properties": { + "startIpAddress": "10.0.0.0", + "endIpAddress": "10.0.0.254" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/firewallRules/ExampleIpFirewallRule", + "type": "Microsoft.Synapse/workspaces/firewallRules", + "name": "ExampleIpFirewallRule", + "properties": { + "startIpAddress": "10.0.0.0", + "endIpAddress": "10.0.0.254", + "provisioningState": "Provisioning" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/firewallRules/ExampleIpFirewallRule", + "type": "Microsoft.Synapse/workspaces/firewallRules", + "name": "ExampleIpFirewallRule", + "properties": { + "startIpAddress": "10.0.0.0", + "endIpAddress": "10.0.0.254", + "provisioningState": "Provisioning" + } + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateBigDataPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateBigDataPool.json new file mode 100644 index 000000000000..11f50710fec2 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateBigDataPool.json @@ -0,0 +1,117 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "bigDataPoolName": "ExamplePool", + "api-version": "2021-05-01", + "bigDataPoolInfo": { + "tags": { + "key": "value" + }, + "location": "West US 2", + "properties": { + "sparkVersion": "2.4", + "nodeCount": 4, + "nodeSize": "Medium", + "nodeSizeFamily": "MemoryOptimized", + "autoScale": { + "enabled": true, + "minNodeCount": 3, + "maxNodeCount": 50 + }, + "autoPause": { + "enabled": true, + "delayInMinutes": 15 + }, + "sparkEventsFolder": "/events", + "libraryRequirements": { + "content": "", + "filename": "requirements.txt" + }, + "defaultSparkLogFolder": "/logs" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/bigDataPools/ExamplePool", + "type": "Microsoft.Synapse/workspaces/bigDataPools", + "location": "West US 2", + "name": "ExamplePool", + "tags": { + "key": "value" + }, + "properties": { + "provisioningState": "Provisioning", + "sparkVersion": "2.4", + "nodeCount": 4, + "nodeSize": "Medium", + "nodeSizeFamily": "MemoryOptimized", + "autoScale": { + "enabled": true, + "minNodeCount": 3, + "maxNodeCount": 50 + }, + "autoPause": { + "enabled": true, + "delayInMinutes": 15 + }, + "creationDate": "1970-01-01T00:00:00Z", + "sparkEventsFolder": "/events", + "libraryRequirements": { + "time": "1970-01-01T00:00:00Z", + "content": "", + "filename": "requirements.txt" + }, + "defaultSparkLogFolder": "/logs", + "lastSucceededTimestamp": "1970-01-01T10:00:00Z" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/bigDataPools/ExamplePool", + "type": "Microsoft.Synapse/workspaces/bigDataPools", + "location": "West US 2", + "name": "ExamplePool", + "tags": { + "key": "value" + }, + "properties": { + "provisioningState": "Provisioning", + "sparkVersion": "2.4", + "nodeCount": 4, + "nodeSize": "Medium", + "nodeSizeFamily": "MemoryOptimized", + "autoScale": { + "enabled": true, + "minNodeCount": 3, + "maxNodeCount": 50 + }, + "autoPause": { + "enabled": true, + "delayInMinutes": 15 + }, + "creationDate": "1970-01-01T00:00:00Z", + "sparkEventsFolder": "/events", + "libraryRequirements": { + "time": "1970-01-01T00:00:00Z", + "content": "", + "filename": "requirements.txt" + }, + "defaultSparkLogFolder": "/logs" + } + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateGeoBackupPolicies.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateGeoBackupPolicies.json new file mode 100644 index 000000000000..cd224e7dafd3 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateGeoBackupPolicies.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "workspaceName": "testws", + "sqlPoolName": "testdw", + "geoBackupPolicyName": "Default", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "state": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Synapse/workspaces/testws/databases/testdw/geoBackupPolicies/Default", + "name": "Default", + "type": "Microsoft.Synapse/workspaces/sqlpools/geoBackupPolicies", + "location": null, + "kind": null, + "properties": { + "state": "Enabled", + "storageType": null + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Synapse/workspaces/testws/databases/testdw/geoBackupPolicies/Default", + "name": "Default", + "type": "Microsoft.Synapse/workspaces/sqlpools/geoBackupPolicies", + "location": null, + "kind": null, + "properties": { + "state": "Enabled", + "storageType": null + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateKey.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateKey.json new file mode 100644 index 000000000000..ccc8f28d41e7 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateKey.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "keyName": "somekey", + "api-version": "2021-05-01", + "keyProperties": { + "properties": { + "isActiveCMK": true, + "keyVaultUrl": "https://vault.azure.net/keys/somesecret" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/somekey", + "type": "Microsoft.Synapse/workspaces/keys", + "name": "somekey", + "properties": { + "isActiveCMK": true, + "keyVaultUrl": "https://vault.azure.net/keys/somesecret" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateMaintenanceWindows.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateMaintenanceWindows.json new file mode 100644 index 000000000000..d761c976d1c6 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateMaintenanceWindows.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "samplerg", + "workspaceName": "testworkspace", + "sqlPoolName": "testsp", + "maintenanceWindowName": "current", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "timeRanges": [ + { + "dayOfWeek": "Saturday", + "startTime": "00:00:00", + "duration": "PT60M" + } + ] + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateManagedIdentitySqlControlSettings.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateManagedIdentitySqlControlSettings.json new file mode 100644 index 000000000000..874176c24010 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateManagedIdentitySqlControlSettings.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2021-05-01", + "managedIdentitySqlControlSettings": { + "properties": { + "grantSqlControlToManagedIdentity": { + "desiredState": "Enabled" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1/managedIdentitySqlControlSettings/default", + "name": "default", + "properties": { + "grantSqlControlToManagedIdentity": { + "desiredState": "Enabled", + "actualState": "Enabling" + } + } + } + }, + "201": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdatePrivateLinkHub.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdatePrivateLinkHub.json new file mode 100644 index 000000000000..d0db6c625c9e --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdatePrivateLinkHub.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup1", + "privateLinkHubName": "privateLinkHub1", + "api-version": "2021-05-01", + "privateLinkHubInfo": { + "properties": {}, + "location": "East US", + "tags": { + "key": "value" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/privateLinkHubs/privateLinkHub1", + "name": "privateLinkHub1", + "type": "Microsoft.Synapse/privateLinkHubs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": { + "key": "value" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/privateLinkHubs/privateLinkHub1", + "name": "privateLinkHub1", + "type": "Microsoft.Synapse/privateLinkHubs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": { + "key": "value" + } + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolBlobAuditingWithAllParameters.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolBlobAuditingWithAllParameters.json new file mode 100644 index 000000000000..d75a9a761bab --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolBlobAuditingWithAllParameters.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "blobauditingtest-4799", + "workspaceName": "blobauditingtest-6440", + "sqlPoolName": "testdb", + "blobAuditingPolicyName": "default", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "state": "Enabled", + "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "retentionDays": 6, + "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups": [ + "DATABASE_LOGOUT_GROUP", + "DATABASE_ROLE_MEMBER_CHANGE_GROUP", + "UPDATE on database::TestDatabaseName by public" + ], + "isAzureMonitorTargetEnabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Synapse/workspaces/blobauditingtest-6440/sqlPools/testdb", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/auditingSettings", + "kind": "V12", + "properties": { + "state": "Enabled", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "retentionDays": 0, + "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups": [ + "DATABASE_LOGOUT_GROUP", + "DATABASE_ROLE_MEMBER_CHANGE_GROUP", + "UPDATE on database::TestDatabaseName by public" + ], + "isAzureMonitorTargetEnabled": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Synapse/workspaces/blobauditingtest-6440/sqlPools/testdb", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/auditingSettings", + "kind": "V12", + "properties": { + "state": "Enabled", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "retentionDays": 0, + "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups": [ + "DATABASE_LOGOUT_GROUP", + "DATABASE_ROLE_MEMBER_CHANGE_GROUP", + "UPDATE on database::TestDatabaseName by public" + ], + "isAzureMonitorTargetEnabled": true + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolBlobAuditingWithMinParameters.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolBlobAuditingWithMinParameters.json new file mode 100644 index 000000000000..0a3d4390ed94 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolBlobAuditingWithMinParameters.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "blobauditingtest-4799", + "workspaceName": "blobauditingtest-6440", + "sqlPoolName": "testdb", + "blobAuditingPolicyName": "default", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "state": "Enabled", + "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==", + "storageEndpoint": "https://mystorage.blob.core.windows.net" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Synapse/workspaces/blobauditingtest-6440/sqlPools/testdb", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/auditingSettings", + "kind": "V12", + "properties": { + "state": "Enabled", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "retentionDays": 0, + "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups": [ + "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", + "FAILED_DATABASE_AUTHENTICATION_GROUP", + "BATCH_COMPLETED_GROUP" + ], + "isAzureMonitorTargetEnabled": false + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Synapse/workspaces/blobauditingtest-6440/sqlPools/testdb", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/auditingSettings", + "kind": "V12", + "properties": { + "state": "Enabled", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "retentionDays": 0, + "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups": [ + "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", + "FAILED_DATABASE_AUTHENTICATION_GROUP", + "BATCH_COMPLETED_GROUP" + ], + "isAzureMonitorTargetEnabled": false + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolColumnSensitivityLabelWithAllParameters.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolColumnSensitivityLabelWithAllParameters.json new file mode 100644 index 000000000000..43f7b3f43085 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolColumnSensitivityLabelWithAllParameters.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myRG", + "workspaceName": "myServer", + "sqlPoolName": "myDatabase", + "schemaName": "dbo", + "tableName": "myTable", + "columnName": "myColumn", + "sensitivityLabelSource": "current", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "informationType": "PhoneNumber", + "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646", + "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff", + "labelName": "PII" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/myServer/sqlPools/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current", + "name": "current", + "type": "Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels", + "properties": { + "informationType": "PhoneNumber", + "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646", + "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff", + "labelName": "PII" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/myServer/sqlPools/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current", + "name": "current", + "type": "Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels", + "properties": { + "informationType": "PhoneNumber", + "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646", + "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff", + "labelName": "PII" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolSecurityAlertWithAllParameters.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolSecurityAlertWithAllParameters.json new file mode 100644 index 000000000000..baf78d5a9881 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolSecurityAlertWithAllParameters.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-4799", + "workspaceName": "securityalert-6440", + "sqlPoolName": "testdb", + "securityAlertPolicyName": "default", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "state": "Enabled", + "emailAccountAdmins": true, + "emailAddresses": [ + "test@microsoft.com", + "user@microsoft.com" + ], + "disabledAlerts": [ + "Sql_Injection", + "Usage_Anomaly" + ], + "retentionDays": 6, + "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==", + "storageEndpoint": "https://mystorage.blob.core.windows.net" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Synapse/workspaces/securityalert-6440/sqlPools/testdb", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies", + "properties": { + "state": "Enabled", + "emailAccountAdmins": true, + "emailAddresses": [ + "test@microsoft.com", + "user@microsoft.com" + ], + "disabledAlerts": [ + "Sql_Injection", + "Usage_Anomaly" + ], + "retentionDays": 6, + "storageAccountAccessKey": "", + "storageEndpoint": "https://mystorage.blob.core.windows.net" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Synapse/workspaces/securityalert-6440/sqlPools/testdb", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies", + "properties": { + "state": "Enabled", + "emailAccountAdmins": true, + "emailAddresses": [ + "test@microsoft.com", + "user@microsoft.com" + ], + "disabledAlerts": [ + "Access_Anomaly", + "Usage_Anomaly" + ], + "retentionDays": 6, + "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==", + "storageEndpoint": "https://mystorage.blob.core.windows.net" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolSecurityAlertWithMinParameters.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolSecurityAlertWithMinParameters.json new file mode 100644 index 000000000000..f81a4346ef28 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolSecurityAlertWithMinParameters.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-4799", + "workspaceName": "securityalert-6440", + "sqlPoolName": "testdb", + "securityAlertPolicyName": "default", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "state": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Synapse/workspaces/securityalert-6440/sqlPools/testdb", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies", + "properties": { + "state": "Enabled", + "emailAccountAdmins": true, + "emailAddresses": [], + "disabledAlerts": [], + "retentionDays": 0, + "storageAccountAccessKey": "", + "storageEndpoint": "" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Synapse/workspaces/securityalert-6440/sqlPools/testdb", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies", + "properties": { + "state": "Enabled", + "emailAccountAdmins": true, + "emailAddresses": [], + "disabledAlerts": [], + "retentionDays": 0, + "storageAccountAccessKey": "", + "storageEndpoint": "" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolTransparentDataEncryption.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolTransparentDataEncryption.json new file mode 100644 index 000000000000..eca03d044655 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolTransparentDataEncryption.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-6852", + "workspaceName": "sqlcrudtest-2080", + "sqlPoolName": "sqlcrudtest-9187", + "transparentDataEncryptionName": "current", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "status": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "name": "current", + "location": "North Europe", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/transparentDataEncryption/current", + "type": "Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption", + "properties": { + "status": "Enabled" + } + } + }, + "201": { + "body": { + "name": "current", + "location": "North Europe", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/transparentDataEncryption/current", + "type": "Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption", + "properties": { + "status": "Enabled" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolVulnerabilityAssessmentRuleBaseline.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolVulnerabilityAssessmentRuleBaseline.json new file mode 100644 index 000000000000..3f2ecc7ecc01 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolVulnerabilityAssessmentRuleBaseline.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "vulnerabilityaseessmenttest-4799", + "workspaceName": "vulnerabilityaseessmenttest-6440", + "sqlPoolName": "testdb", + "vulnerabilityAssessmentName": "default", + "ruleId": "VA1001", + "baselineName": "default", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "baselineResults": [ + { + "result": [ + "userA", + "SELECT" + ] + }, + { + "result": [ + "userB", + "SELECT" + ] + }, + { + "result": [ + "userC", + "SELECT", + "tableId_4" + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityaseessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default/rules/VA1001/baselines/default", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/rules/baselines", + "properties": { + "baselineResults": [ + { + "result": [ + "userA", + "SELECT" + ] + }, + { + "result": [ + "userB", + "SELECT" + ] + }, + { + "result": [ + "userC", + "SELECT", + "tableId_4" + ] + } + ] + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolVulnerabilityAssessmentWithAllParameters.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolVulnerabilityAssessmentWithAllParameters.json new file mode 100644 index 000000000000..69c4f9bbdb56 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolVulnerabilityAssessmentWithAllParameters.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "vulnerabilityaseessmenttest-4799", + "workspaceName": "vulnerabilityaseessmenttest-6440", + "sqlPoolName": "testdb", + "vulnerabilityAssessmentName": "default", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", + "storageContainerSasKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", + "storageAccountAccessKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", + "recurringScans": { + "isEnabled": true, + "emailSubscriptionAdmins": true, + "emails": [ + "email1@mail.com", + "email2@mail.com" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityaseessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments", + "properties": { + "recurringScans": { + "isEnabled": true, + "emailSubscriptionAdmins": true, + "emails": [ + "email1@mail.com", + "email2@mail.com" + ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityaseessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments", + "properties": { + "recurringScans": { + "isEnabled": true, + "emailSubscriptionAdmins": true, + "emails": [ + "email1@mail.com", + "email2@mail.com" + ] + } + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolVulnerabilityAssessmentWithContainerSasKeyAndMinParameters.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolVulnerabilityAssessmentWithContainerSasKeyAndMinParameters.json new file mode 100644 index 000000000000..29b53011d5dc --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolVulnerabilityAssessmentWithContainerSasKeyAndMinParameters.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "vulnerabilityaseessmenttest-4799", + "workspaceName": "vulnerabilityaseessmenttest-6440", + "sqlPoolName": "testdb", + "vulnerabilityAssessmentName": "default", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", + "storageContainerSasKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityaseessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments", + "properties": { + "recurringScans": { + "isEnabled": true, + "emailSubscriptionAdmins": false, + "emails": [] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityaseessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments", + "properties": { + "recurringScans": { + "isEnabled": true, + "emailSubscriptionAdmins": false, + "emails": [] + } + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolWorkloadClassifierMax.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolWorkloadClassifierMax.json new file mode 100644 index 000000000000..3b590115a66f --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolWorkloadClassifierMax.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-6852", + "workspaceName": "sqlcrudtest-2080", + "sqlPoolName": "sqlcrudtest-9187", + "workloadGroupName": "wlm_workloadgroup", + "workloadClassifierName": "wlm_workloadclassifier", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "memberName": "dbo", + "label": "test_label", + "context": "test_context", + "startTime": "12:00", + "endTime": "14:00", + "importance": "high" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "memberName": "dbo", + "label": "test_label", + "context": "test_context", + "startTime": "12:00", + "endTime": "14:00", + "importance": "high" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/workloadGroups/wlm_workloadgroup/workloadClassifiers/wlm_workloadclassifier", + "name": "wlm_workloadclassifier", + "type": "Microsoft.Synapse/workspaces/sqlPools/workloadGroups/workloadClassifiers" + } + }, + "201": { + "body": { + "properties": { + "memberName": "dbo", + "label": "test_label", + "context": "test_context", + "startTime": "12:00", + "endTime": "14:00", + "importance": "high" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/workloadGroups/wlm_workloadgroup/workloadClassifiers/wlm_workloadclassifier", + "name": "wlm_workloadclassifier", + "type": "Microsoft.Synapse/workspaces/sqlPools/workloadGroups/workloadClassifiers" + } + }, + "202": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolWorkloadClassifierMin.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolWorkloadClassifierMin.json new file mode 100644 index 000000000000..0aa3d0dba7ce --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolWorkloadClassifierMin.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-6852", + "workspaceName": "sqlcrudtest-2080", + "sqlPoolName": "sqlcrudtest-9187", + "workloadGroupName": "wlm_workloadgroup", + "workloadClassifierName": "wlm_workloadclassifier", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "memberName": "dbo" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "memberName": "dbo", + "label": "", + "context": "", + "startTime": "", + "endTime": "", + "importance": "" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/workloadGroups/wlm_workloadgroup/workloadClassifiers/wlm_workloadclassifier", + "name": "wlm_workloadclassifier", + "type": "Microsoft.Synapse/workspaces/sqlPools/workloadGroups/workloadClassifiers" + } + }, + "201": { + "body": { + "properties": { + "memberName": "dbo", + "label": "", + "context": "", + "startTime": "", + "endTime": "", + "importance": "" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/workloadGroups/wlm_workloadgroup/workloadClassifiers/wlm_workloadclassifier", + "name": "wlm_workloadclassifier", + "type": "Microsoft.Synapse/workspaces/sqlPools/workloadGroups/workloadClassifiers" + } + }, + "202": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolWorkloadGroupMax.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolWorkloadGroupMax.json new file mode 100644 index 000000000000..99896e98317b --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolWorkloadGroupMax.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-6852", + "workspaceName": "sqlcrudtest-2080", + "sqlPoolName": "sqlcrudtest-9187", + "workloadGroupName": "smallrc", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "minResourcePercent": 0, + "maxResourcePercent": 100, + "minResourcePercentPerRequest": 3.0, + "maxResourcePercentPerRequest": 3.0, + "importance": "normal", + "queryExecutionTimeout": 0 + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "minResourcePercent": 0, + "maxResourcePercent": 100, + "minResourcePercentPerRequest": 3.0, + "maxResourcePercentPerRequest": 3.0, + "importance": "normal", + "queryExecutionTimeout": 0 + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/workloadGroups/smallrc", + "name": "smallrc", + "type": "Microsoft.Synapse/workspaces/sqlPools/workloadGroups" + } + }, + "201": { + "body": { + "properties": { + "minResourcePercent": 0, + "maxResourcePercent": 100, + "minResourcePercentPerRequest": 3.0, + "maxResourcePercentPerRequest": 3.0, + "importance": "normal", + "queryExecutionTimeout": 0 + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/workloadGroups/smallrc", + "name": "smallrc", + "type": "Microsoft.Synapse/workspaces/sqlPools/workloadGroups" + } + }, + "202": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolWorkloadGroupMin.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolWorkloadGroupMin.json new file mode 100644 index 000000000000..bd3353cc9d9d --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateSqlPoolWorkloadGroupMin.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-6852", + "workspaceName": "sqlcrudtest-2080", + "sqlPoolName": "sqlcrudtest-9187", + "workloadGroupName": "smallrc", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "minResourcePercent": 0, + "maxResourcePercent": 100, + "minResourcePercentPerRequest": 3.0 + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "minResourcePercent": 0, + "maxResourcePercent": 100, + "minResourcePercentPerRequest": 3.0, + "maxResourcePercentPerRequest": 3.0, + "importance": "normal", + "queryExecutionTimeout": 0 + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/workloadGroups/smallrc", + "name": "smallrc", + "type": "Microsoft.Synapse/workspaces/sqlPools/workloadGroups" + } + }, + "201": { + "body": { + "properties": { + "minResourcePercent": 0, + "maxResourcePercent": 100, + "minResourcePercentPerRequest": 3.0, + "maxResourcePercentPerRequest": 3.0, + "importance": "normal", + "queryExecutionTimeout": 0 + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/workloadGroups/smallrc", + "name": "smallrc", + "type": "Microsoft.Synapse/workspaces/sqlPools/workloadGroups" + } + }, + "202": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateVulnerabilityAssessmentWithStorageAccessKeyAndMinParameters.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateVulnerabilityAssessmentWithStorageAccessKeyAndMinParameters.json new file mode 100644 index 000000000000..68fa89650c16 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateVulnerabilityAssessmentWithStorageAccessKeyAndMinParameters.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "vulnerabilityaseessmenttest-4799", + "workspaceName": "vulnerabilityaseessmenttest-6440", + "sqlPoolName": "testdb", + "vulnerabilityAssessmentName": "default", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", + "storageAccountAccessKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/Microsoft.Synapse/workspaces/vulnerabilityaseessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments", + "properties": { + "recurringScans": { + "isEnabled": true, + "emailSubscriptionAdmins": false, + "emails": [] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityaseessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments", + "properties": { + "recurringScans": { + "isEnabled": true, + "emailSubscriptionAdmins": false, + "emails": [] + } + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateWorkspace.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateWorkspace.json new file mode 100644 index 000000000000..79473c212d43 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateWorkspace.json @@ -0,0 +1,217 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2021-05-01", + "workspaceInfo": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1": {} + } + }, + "properties": { + "defaultDataLakeStorage": { + "accountUrl": "https://accountname.dfs.core.windows.net", + "filesystem": "default" + }, + "managedVirtualNetworkSettings": { + "preventDataExfiltration": false, + "linkedAccessCheckOnTargetResource": false, + "allowedAadTenantIdsForLinking": [ + "740239CE-A25B-485B-86A0-262F29F6EBDB" + ] + }, + "purviewConfiguration": { + "purviewResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.ProjectPurview/accounts/accountname1" + }, + "sqlAdministratorLogin": "login", + "sqlAdministratorLoginPassword": "password", + "managedVirtualNetwork": "default", + "managedResourceGroupName": "workspaceManagedResourceGroupUnique", + "workspaceRepositoryConfiguration": { + "type": "FactoryGitHubConfiguration", + "hostName": "", + "accountName": "mygithubaccount", + "projectName": "myproject", + "repositoryName": "myrepository", + "collaborationBranch": "master", + "rootFolder": "/" + }, + "encryption": { + "cmk": { + "kekIdentity": { + "userAssignedIdentity": "/subscriptions/b64d7b94-73e7-4d36-94b2-7764ea3fd74a/resourcegroups/SynapseCI/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1", + "useSystemAssignedIdentity": false + }, + "key": { + "name": "default", + "keyVaultUrl": "https://vault.azure.net/keys/key1" + } + } + }, + "publicNetworkAccess": "Enabled", + "cspWorkspaceAdminProperties": { + "initialWorkspaceAdminObjectId": "6c20646f-8050-49ec-b3b1-80a0e58e454d" + } + }, + "location": "East US", + "tags": { + "key": "value" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1", + "name": "workspace1", + "type": "Microsoft.Synapse/workspaces", + "location": "East US", + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1": { + "clientId": "ffffffff-8888-4444-8888-333333333333", + "principalId": "eeeeeeee-9999-4444-8888-333333333333" + } + }, + "principalId": "f4b0f1c2-xxxx-43db-xxxx-ccd99e1afd22", + "tenantId": "72f988bf-xxxx-41af-xxxx-2d7cd011db47" + }, + "properties": { + "defaultDataLakeStorage": { + "accountUrl": "https://accountname.dfs.core.windows.net", + "filesystem": "default" + }, + "connectivityEndpoints": { + "dev": "workspace1.dev.projectarcadia.net", + "sql": "workspace1.sql.projectarcadia.net" + }, + "managedVirtualNetworkSettings": { + "preventDataExfiltration": false, + "linkedAccessCheckOnTargetResource": false, + "allowedAadTenantIdsForLinking": [ + "740239CE-A25B-485B-86A0-262F29F6EBDB" + ] + }, + "purviewConfiguration": { + "purviewResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.ProjectPurview/accounts/accountname1" + }, + "sqlAdministratorLogin": "login", + "managedResourceGroupName": "workspaceManagedResourceGroupUnique", + "managedVirtualNetwork": "default", + "provisioningState": "Succeeded", + "privateEndpointConnections": [ + { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/privateEndpointConnections/ExamplePrivateEndpointConnection", + "name": "sql", + "type": "Microsoft.Synapse/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Network/privateEndpoints/ExamplePrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ], + "workspaceUID": "999b999q-b888-4b44-bacd-2c222cc2222d", + "encryption": { + "doubleEncryptionEnabled": true, + "cmk": { + "kekIdentity": { + "userAssignedIdentity": "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1", + "useSystemAssignedIdentity": false + }, + "status": "Consistent", + "key": { + "name": "default", + "keyVaultUrl": "https://vault.azure.net/keys/key1" + } + } + }, + "publicNetworkAccess": "Enabled" + }, + "tags": { + "key": "value" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1", + "name": "workspace1", + "type": "Microsoft.Synapse/workspaces", + "location": "East US", + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1": { + "clientId": "ffffffff-8888-4444-8888-333333333333", + "principalId": "eeeeeeee-9999-4444-8888-333333333333" + } + }, + "principalId": "f4b0f1c2-xxxx-43db-xxxx-ccd99e1afd22", + "tenantId": "72f988bf-xxxx-41af-xxxx-2d7cd011db47" + }, + "properties": { + "defaultDataLakeStorage": { + "accountUrl": "https://accountname.dfs.core.windows.net", + "filesystem": "default" + }, + "managedVirtualNetworkSettings": { + "preventDataExfiltration": false, + "linkedAccessCheckOnTargetResource": false, + "allowedAadTenantIdsForLinking": [ + "740239CE-A25B-485B-86A0-262F29F6EBDB" + ] + }, + "purviewConfiguration": { + "purviewResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.ProjectPurview/accounts/accountname1" + }, + "connectivityEndpoints": { + "dev": "workspace1.dev.projectarcadia.net", + "sql": "workspace1.sql.projectarcadia.net" + }, + "sqlAdministratorLogin": "login", + "managedResourceGroupName": "workspaceManagedResourceGroupUnique", + "managedVirtualNetwork": "default", + "provisioningState": "Provisioning", + "workspaceUID": "86984b43-b873-4b91-bacd-2ca083a104c7", + "encryption": { + "doubleEncryptionEnabled": true, + "cmk": { + "kekIdentity": { + "userAssignedIdentity": "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1", + "useSystemAssignedIdentity": false + }, + "status": "Consistent", + "key": { + "name": "default", + "keyVaultUrl": "https://vault.azure.net/keys/key1" + } + } + }, + "publicNetworkAccess": "Enabled" + }, + "tags": { + "key": "value" + } + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateWorkspaceAadAdmin.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateWorkspaceAadAdmin.json new file mode 100644 index 000000000000..ebc644e8c3fc --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateOrUpdateWorkspaceAadAdmin.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2021-05-01", + "aadAdminInfo": { + "properties": { + "administratorType": "ActiveDirectory", + "login": "bob@contoso.com", + "sid": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c", + "tenantId": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1/administrators/activeDirectory", + "name": "activeDirectory", + "properties": { + "administratorType": "ActiveDirectory", + "login": "bob@contoso.com", + "sid": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c", + "tenantId": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1/administrators/activeDirectory", + "name": "activeDirectory", + "properties": { + "administratorType": "ActiveDirectory", + "login": "bob@contoso.com", + "sid": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c", + "tenantId": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c" + } + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateSqlPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateSqlPool.json new file mode 100644 index 000000000000..d7084db73ee1 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateSqlPool.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "sqlPoolName": "ExampleSqlPool", + "api-version": "2021-05-01", + "sqlPoolInfo": { + "tags": {}, + "sku": { + "tier": "", + "name": "" + }, + "location": "Southeast Asia", + "properties": { + "maxSizeBytes": 0, + "collation": "", + "sourceDatabaseId": "", + "recoverableDatabaseId": "", + "createMode": "", + "storageAccountType": "LRS" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspaces/sqlPools/ExampleSqlPool", + "type": "Microsoft.Synapse/workspaces/sqlPools", + "name": "ExampleSqlPool", + "location": "Southeast Asia", + "tags": {}, + "sku": { + "tier": "", + "name": "" + }, + "properties": { + "maxSizeBytes": 0, + "collation": "", + "sourceDatabaseId": "", + "recoverableDatabaseId": "", + "provisioningState": "Provisioning", + "status": "Paused", + "restorePointInTime": "1970-01-01T00:00:00.000Z", + "createMode": "", + "creationDate": "1970-01-01T00:00:00.000Z", + "storageAccountType": "LRS" + } + } + }, + "202": {}, + "404": {}, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateSqlPoolMetadataSyncConfig.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateSqlPoolMetadataSyncConfig.json new file mode 100644 index 000000000000..96d2ea080f61 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateSqlPoolMetadataSyncConfig.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "sqlPoolName": "ExampleSqlPool", + "api-version": "2021-05-01", + "metadataSyncConfiguration": { + "properties": { + "enabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/bigDataPools/ExamplePool/metadataSync/config", + "type": "Microsoft.Synapse/workspaces/bigDataPools/metadataSync/config", + "name": "config", + "properties": { + "enabled": true + } + } + }, + "404": {}, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateSqlPoolRestorePoints.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateSqlPoolRestorePoints.json new file mode 100644 index 000000000000..82613dcac207 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateSqlPoolRestorePoints.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "location": "japaneast", + "workspaceName": "testserver", + "sqlPoolName": "testDatabase", + "api-version": "2021-05-01", + "parameters": { + "restorePointLabel": "mylabel" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Synapse/workspaces/testserver/sqlPools/testDatabase/restorePoints/131546477590000000", + "name": "131546477590000000", + "type": "Microsoft.Synapse/workspaces/sqlPools/restorePoints", + "location": "japaneast", + "properties": { + "restorePointType": "DISCRETE", + "restorePointCreationDate": "2017-03-10T08:00:00.000Z", + "restorePointLabel": "mylabel" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Synapse/workspaces/testserver/sqlPools/testDatabase/restorePoints/131546477590000000", + "name": "131546477590000000", + "type": "Microsoft.Synapse/workspaces/sqlPools/restorePoints", + "location": "japaneast", + "properties": { + "restorePointType": "DISCRETE", + "restorePointCreationDate": "2017-03-10T08:00:00.000Z", + "restorePointLabel": "mylabel" + } + } + }, + "202": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateWorkspaceManagedSqlServerBlobAuditingSettingsWithAllParameters.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateWorkspaceManagedSqlServerBlobAuditingSettingsWithAllParameters.json new file mode 100644 index 000000000000..d13a794b679a --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateWorkspaceManagedSqlServerBlobAuditingSettingsWithAllParameters.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "wsg-7398", + "workspaceName": "testWorkspace", + "blobAuditingPolicyName": "default", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "state": "Enabled", + "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "retentionDays": 6, + "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", + "isStorageSecondaryKeyInUse": false, + "queueDelayMs": 4000, + "auditActionsAndGroups": [ + "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", + "FAILED_DATABASE_AUTHENTICATION_GROUP", + "BATCH_COMPLETED_GROUP" + ], + "isAzureMonitorTargetEnabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/auditingSettings/default", + "name": "default", + "type": "Microsoft.Synapse/workspaces/auditingSettings", + "properties": { + "state": "Enabled", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "retentionDays": 6, + "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", + "isStorageSecondaryKeyInUse": false, + "queueDelayMs": 4000, + "auditActionsAndGroups": [ + "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", + "FAILED_DATABASE_AUTHENTICATION_GROUP", + "BATCH_COMPLETED_GROUP" + ], + "isAzureMonitorTargetEnabled": true + } + } + }, + "202": { + "startTime": "2017-11-22T09:34:54.72Z", + "operation": "UpsertServerEngineAuditingPolicy" + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateWorkspaceManagedSqlServerBlobAuditingSettingsWithMinParameters.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateWorkspaceManagedSqlServerBlobAuditingSettingsWithMinParameters.json new file mode 100644 index 000000000000..2d823fdafaca --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateWorkspaceManagedSqlServerBlobAuditingSettingsWithMinParameters.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "wsg-7398", + "workspaceName": "testWorkspace", + "blobAuditingPolicyName": "default", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "state": "Enabled", + "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==", + "storageEndpoint": "https://mystorage.blob.core.windows.net" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/auditingSettings/default", + "name": "default", + "type": "Microsoft.Synapse/workspaces/auditingSettings", + "properties": { + "state": "Enabled", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "retentionDays": 6, + "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups": [ + "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", + "FAILED_DATABASE_AUTHENTICATION_GROUP", + "BATCH_COMPLETED_GROUP" + ] + } + } + }, + "202": { + "startTime": "2017-11-22T09:34:54.72Z", + "operation": "UpsertServerEngineAuditingPolicy" + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateWorkspaceManagedSqlServerExetendedBlobAuditingSettingsWithMinParameters.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateWorkspaceManagedSqlServerExetendedBlobAuditingSettingsWithMinParameters.json new file mode 100644 index 000000000000..a3b4dd23a2c2 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateWorkspaceManagedSqlServerExetendedBlobAuditingSettingsWithMinParameters.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "wsg-7398", + "workspaceName": "testWorkspace", + "blobAuditingPolicyName": "default", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "state": "Enabled", + "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==", + "storageEndpoint": "https://mystorage.blob.core.windows.net" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/extendedAuditingSettings/default", + "name": "default", + "type": "Microsoft.Synapse/workspaces/extendedAuditingSettings", + "properties": { + "state": "Enabled", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "retentionDays": 6, + "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups": [ + "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", + "FAILED_DATABASE_AUTHENTICATION_GROUP", + "BATCH_COMPLETED_GROUP" + ], + "isAzureMonitorTargetEnabled": false + } + } + }, + "202": { + "startTime": "2017-11-22T09:34:54.72Z", + "operation": "UpsertServerEngineAuditingPolicy" + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateWorkspaceManagedSqlServerExtendedBlobAuditingSettingsWithAllParameters.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateWorkspaceManagedSqlServerExtendedBlobAuditingSettingsWithAllParameters.json new file mode 100644 index 000000000000..8db0a68e737f --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/CreateWorkspaceManagedSqlServerExtendedBlobAuditingSettingsWithAllParameters.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "wsg-7398", + "workspaceName": "testWorkspace", + "blobAuditingPolicyName": "default", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "state": "Enabled", + "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "retentionDays": 6, + "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups": [ + "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", + "FAILED_DATABASE_AUTHENTICATION_GROUP", + "BATCH_COMPLETED_GROUP" + ], + "predicateExpression": "object_name = 'SensitiveData'", + "isAzureMonitorTargetEnabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/extendedAuditingSettings/default", + "name": "default", + "type": "Microsoft.Synapse/workspaces/extendedAuditingSettings", + "properties": { + "state": "Enabled", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "retentionDays": 6, + "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups": [ + "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", + "FAILED_DATABASE_AUTHENTICATION_GROUP", + "BATCH_COMPLETED_GROUP" + ], + "predicateExpression": "object_name = 'SensitiveData'", + "isAzureMonitorTargetEnabled": true + } + } + }, + "202": { + "startTime": "2017-11-22T09:34:54.72Z", + "operation": "UpsertServerEngineAuditingPolicy" + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DataMaskingPolicyCreateOrUpdateMax.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DataMaskingPolicyCreateOrUpdateMax.json new file mode 100644 index 000000000000..19f25042aa41 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DataMaskingPolicyCreateOrUpdateMax.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-6852", + "workspaceName": "sqlcrudtest-2080", + "sqlPoolName": "sqlcrudtest-331", + "dataMaskingPolicyName": "Default", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "dataMaskingState": "Enabled", + "exemptPrincipals": "testuser;" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-331/dataMaskingPolicies/Default", + "name": "Default", + "type": "Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies", + "location": "Central US", + "kind": null, + "properties": { + "dataMaskingState": "Enabled", + "applicationPrincipals": "", + "exemptPrincipals": "testuser;", + "maskingLevel": "" + }, + "managedBy": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-331" + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DataMaskingPolicyCreateOrUpdateMin.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DataMaskingPolicyCreateOrUpdateMin.json new file mode 100644 index 000000000000..fe4c15259220 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DataMaskingPolicyCreateOrUpdateMin.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-6852", + "workspaceName": "sqlcrudtest-2080", + "sqlPoolName": "sqlcrudtest-331", + "dataMaskingPolicyName": "Default", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "dataMaskingState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-331/dataMaskingPolicies/Default", + "name": "Default", + "type": "Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies", + "location": "Central US", + "kind": null, + "properties": { + "dataMaskingState": "Enabled", + "applicationPrincipals": "", + "exemptPrincipals": "", + "maskingLevel": "" + }, + "managedBy": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-331" + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DataMaskingPolicyGet.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DataMaskingPolicyGet.json new file mode 100644 index 000000000000..5766333575ab --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DataMaskingPolicyGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-6852", + "workspaceName": "sqlcrudtest-2080", + "sqlPoolName": "sqlcrudtest-331", + "dataMaskingPolicyName": "Default", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-331/dataMaskingPolicies/Default", + "name": "Default", + "type": "Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies", + "location": "Central US", + "kind": null, + "properties": { + "dataMaskingState": "Enabled", + "applicationPrincipals": "", + "exemptPrincipals": "", + "maskingLevel": "" + }, + "managedBy": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-331" + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DataMaskingRuleCreateOrUpdateDefaultMax.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DataMaskingRuleCreateOrUpdateDefaultMax.json new file mode 100644 index 000000000000..70fcda2b225d --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DataMaskingRuleCreateOrUpdateDefaultMax.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-6852", + "workspaceName": "sqlcrudtest-2080", + "sqlPoolName": "sqlcrudtest-331", + "dataMaskingPolicyName": "Default", + "api-version": "2021-05-01", + "dataMaskingRuleName": "rule1", + "parameters": { + "properties": { + "aliasName": "nickname", + "schemaName": "dbo", + "tableName": "Table_1", + "columnName": "test1", + "maskingFunction": "Default", + "ruleState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-6852/sqlPools/sqlcrudtest-331/dataMaskingPolicies/Default/rules/", + "name": null, + "type": "Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules", + "location": "Central US", + "kind": null, + "properties": { + "id": "dbo_Table_1_test1", + "ruleState": "Enabled", + "schemaName": "dbo", + "tableName": "Table_1", + "columnName": "test1", + "aliasName": "nickname", + "maskingFunction": "Default", + "numberFrom": null, + "numberTo": null, + "prefixSize": null, + "suffixSize": null, + "replacementString": null + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-6852/sqlPools/sqlcrudtest-331/dataMaskingPolicies/Default/rules/", + "name": null, + "type": "Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules", + "location": "Central US", + "kind": null, + "properties": { + "id": "dbo_Table_1_test1", + "ruleState": "Enabled", + "schemaName": "dbo", + "tableName": "Table_1", + "columnName": "test1", + "aliasName": "nickname", + "maskingFunction": "Default", + "numberFrom": null, + "numberTo": null, + "prefixSize": null, + "suffixSize": null, + "replacementString": null + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DataMaskingRuleCreateOrUpdateDefaultMin.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DataMaskingRuleCreateOrUpdateDefaultMin.json new file mode 100644 index 000000000000..fdc70bcb6492 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DataMaskingRuleCreateOrUpdateDefaultMin.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-6852", + "workspaceName": "sqlcrudtest-2080", + "sqlPoolName": "sqlcrudtest-331", + "dataMaskingPolicyName": "Default", + "api-version": "2021-05-01", + "dataMaskingRuleName": "rule1", + "parameters": { + "properties": { + "schemaName": "dbo", + "tableName": "Table_1", + "columnName": "test1", + "maskingFunction": "Default" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-6852/sqlPools/sqlcrudtest-331/dataMaskingPolicies/Default/rules/", + "name": null, + "type": "Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules", + "location": "Central US", + "kind": null, + "properties": { + "id": "dbo_Table_1_test1", + "ruleState": "Enabled", + "schemaName": "dbo", + "tableName": "Table_1", + "columnName": "test1", + "aliasName": null, + "maskingFunction": "Default", + "numberFrom": null, + "numberTo": null, + "prefixSize": null, + "suffixSize": null, + "replacementString": null + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-6852/sqlPools/sqlcrudtest-331/dataMaskingPolicies/Default/rules/", + "name": null, + "type": "Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules", + "location": "Central US", + "kind": null, + "properties": { + "id": "dbo_Table_1_test1", + "ruleState": "Enabled", + "schemaName": "dbo", + "tableName": "Table_1", + "columnName": "test1", + "aliasName": null, + "maskingFunction": "Default", + "numberFrom": null, + "numberTo": null, + "prefixSize": null, + "suffixSize": null, + "replacementString": null + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DataMaskingRuleCreateOrUpdateNumber.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DataMaskingRuleCreateOrUpdateNumber.json new file mode 100644 index 000000000000..495e576661f9 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DataMaskingRuleCreateOrUpdateNumber.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-6852", + "workspaceName": "sqlcrudtest-2080", + "sqlPoolName": "sqlcrudtest-331", + "dataMaskingPolicyName": "Default", + "api-version": "2021-05-01", + "dataMaskingRuleName": "rule1", + "parameters": { + "properties": { + "schemaName": "dbo", + "tableName": "Table_1", + "columnName": "test1", + "maskingFunction": "Number", + "numberFrom": "0", + "numberTo": "2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-6852/sqlPools/sqlcrudtest-331/dataMaskingPolicies/Default/rules/", + "name": null, + "type": "Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules", + "location": "Central US", + "kind": null, + "properties": { + "id": "dbo_Table_1_test1", + "ruleState": "Enabled", + "schemaName": "dbo", + "tableName": "Table_1", + "columnName": "test1", + "aliasName": null, + "maskingFunction": "Number", + "numberFrom": "0", + "numberTo": "2", + "prefixSize": null, + "suffixSize": null, + "replacementString": null + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-6852/sqlPools/sqlcrudtest-331/dataMaskingPolicies/Default/rules/", + "name": null, + "type": "Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules", + "location": "Central US", + "kind": null, + "properties": { + "id": "dbo_Table_1_test1", + "ruleState": "Enabled", + "schemaName": "dbo", + "tableName": "Table_1", + "columnName": "test1", + "aliasName": null, + "maskingFunction": "Number", + "numberFrom": "0", + "numberTo": "2", + "prefixSize": null, + "suffixSize": null, + "replacementString": null + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DataMaskingRuleCreateOrUpdateText.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DataMaskingRuleCreateOrUpdateText.json new file mode 100644 index 000000000000..13a47914d2cc --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DataMaskingRuleCreateOrUpdateText.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-6852", + "workspaceName": "sqlcrudtest-2080", + "sqlPoolName": "sqlcrudtest-331", + "dataMaskingPolicyName": "Default", + "api-version": "2021-05-01", + "dataMaskingRuleName": "rule1", + "parameters": { + "properties": { + "schemaName": "dbo", + "tableName": "Table_1", + "columnName": "test1", + "maskingFunction": "Text", + "prefixSize": "1", + "suffixSize": "0", + "replacementString": "asdf" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-6852/sqlPools/sqlcrudtest-331/dataMaskingPolicies/Default/rules/", + "name": null, + "type": "Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules", + "location": "Central US", + "kind": null, + "properties": { + "id": "dbo_Table_1_test1", + "ruleState": "Enabled", + "schemaName": "dbo", + "tableName": "Table_1", + "columnName": "test1", + "aliasName": null, + "maskingFunction": "Text", + "numberFrom": null, + "numberTo": null, + "prefixSize": "1", + "suffixSize": "0", + "replacementString": "asdf" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-6852/sqlPools/sqlcrudtest-331/dataMaskingPolicies/Default/rules/", + "name": null, + "type": "Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules", + "location": "Central US", + "kind": null, + "properties": { + "id": "dbo_Table_1_test1", + "ruleState": "Enabled", + "schemaName": "dbo", + "tableName": "Table_1", + "columnName": "test1", + "aliasName": null, + "maskingFunction": "Text", + "numberFrom": null, + "numberTo": null, + "prefixSize": "1", + "suffixSize": "0", + "replacementString": "asdf" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DataMaskingRuleGet.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DataMaskingRuleGet.json new file mode 100644 index 000000000000..77d649e8dd5a --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DataMaskingRuleGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-6852", + "workspaceName": "sqlcrudtest-2080", + "sqlPoolName": "sqlcrudtest-331", + "dataMaskingPolicyName": "Default", + "dataMaskingRuleName": "rule1", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-6852/sqlPools/sqlcrudtest-331/dataMaskingPolicies/Default/rules/", + "name": "rule1", + "type": "Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules", + "location": "Central US", + "kind": null, + "properties": { + "id": "dbo_Table_1_test1", + "ruleState": "Enabled", + "schemaName": "dbo", + "tableName": "Table_1", + "columnName": "test1", + "aliasName": null, + "maskingFunction": "Text", + "numberFrom": null, + "numberTo": null, + "prefixSize": "1", + "suffixSize": "0", + "replacementString": "asdf" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DataMaskingRuleList.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DataMaskingRuleList.json new file mode 100644 index 000000000000..cfde5e3fe716 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DataMaskingRuleList.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-6852", + "workspaceName": "sqlcrudtest-2080", + "sqlPoolName": "sqlcrudtest-331", + "dataMaskingPolicyName": "Default", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-6852/sqlPools/sqlcrudtest-331/dataMaskingPolicies/Default/rules/", + "name": null, + "type": "Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules", + "location": "Central US", + "kind": null, + "properties": { + "id": "dbo_Table_1_test1", + "ruleState": "Enabled", + "schemaName": "dbo", + "tableName": "Table_1", + "columnName": "test1", + "aliasName": null, + "maskingFunction": "Text", + "numberFrom": null, + "numberTo": null, + "prefixSize": "1", + "suffixSize": "0", + "replacementString": "asdf" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-6852/sqlPools/sqlcrudtest-331/dataMaskingPolicies/Default/rules/", + "name": null, + "type": "Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies/rules", + "location": "Central US", + "kind": null, + "properties": { + "id": "dbo_Table_1_test1", + "ruleState": "Enabled", + "schemaName": "dbo", + "tableName": "Table_1", + "columnName": "test1", + "aliasName": null, + "maskingFunction": "Number", + "numberFrom": "0", + "numberTo": "2", + "prefixSize": null, + "suffixSize": null, + "replacementString": null + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteBigDataPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteBigDataPool.json new file mode 100644 index 000000000000..8e5770333a74 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteBigDataPool.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "bigDataPoolName": "ExamplePool", + "api-version": "2021-05-01" + }, + "responses": { + "204": {}, + "200": { + "body": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/bigDataPools/ExamplePool", + "type": "Microsoft.Synapse/workspaces/bigDataPools", + "location": "West US 2", + "name": "ExamplePool", + "tags": {}, + "properties": { + "provisioningState": "Deleting", + "sparkVersion": "2.4", + "nodeCount": 4, + "nodeSize": "Medium", + "nodeSizeFamily": "MemoryOptimized", + "autoScale": { + "enabled": true, + "minNodeCount": 3, + "maxNodeCount": 50 + }, + "autoPause": { + "enabled": true, + "delayInMinutes": 15 + }, + "creationDate": "1970-01-01T00:00:00Z", + "sparkEventsFolder": "/events", + "libraryRequirements": { + "time": "1970-01-01T00:00:00Z", + "content": "", + "filename": "requirements.txt" + }, + "defaultSparkLogFolder": "/logs" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/bigDataPools/ExamplePool", + "type": "Microsoft.Synapse/workspaces/bigDataPools", + "location": "West US 2", + "name": "ExamplePool", + "tags": {}, + "properties": { + "provisioningState": "Deleting", + "sparkVersion": "2.4", + "nodeCount": 4, + "nodeSize": "Medium", + "nodeSizeFamily": "MemoryOptimized", + "autoScale": { + "enabled": true, + "minNodeCount": 3, + "maxNodeCount": 50 + }, + "autoPause": { + "enabled": true, + "delayInMinutes": 15 + }, + "creationDate": "1970-01-01T00:00:00Z", + "sparkEventsFolder": "/events", + "libraryRequirements": { + "time": "1970-01-01T00:00:00Z", + "content": "", + "filename": "requirements.txt" + }, + "defaultSparkLogFolder": "/logs" + } + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteIpFirewallRule.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteIpFirewallRule.json new file mode 100644 index 000000000000..415d6be3a7be --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteIpFirewallRule.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "ruleName": "ExampleIpFirewallRule", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/firewallRules/ExampleIpFirewallRule", + "type": "Microsoft.Synapse/workspaces/firewallRules", + "name": "ExampleIpFirewallRule", + "location": "West US 2", + "tags": {}, + "properties": { + "startIpAddress": "10.0.0.0", + "endIpAddress": "10.0.0.254", + "provisioningState": "Deleting" + } + } + }, + "202": {}, + "204": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteKey.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteKey.json new file mode 100644 index 000000000000..f03707015dda --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteKey.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "keyName": "somekey", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/somekey", + "type": "Microsoft.Synapse/workspaces/keys", + "name": "somekey", + "properties": { + "isActiveCMK": true, + "keyVaultUrl": "https://vault.azure.net/keys/key1" + } + } + }, + "204": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeletePrivateEndpointConnection.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..f6d51951c25a --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeletePrivateEndpointConnection.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "privateEndpointConnectionName": "ExamplePrivateEndpointConnection", + "api-version": "2021-05-01" + }, + "responses": { + "200": {}, + "202": { + "body": { + "status": "InProgress" + } + }, + "204": {}, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeletePrivateLinkHub.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeletePrivateLinkHub.json new file mode 100644 index 000000000000..0792d483797d --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeletePrivateLinkHub.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup1", + "privateLinkHubName": "privateLinkHub1", + "api-version": "2021-05-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {}, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteSqlPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteSqlPool.json new file mode 100644 index 000000000000..8fbcd8e9c99b --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteSqlPool.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "sqlPoolName": "ExampleSqlPool", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/sqlPools/ExampleSqlPool", + "name": "ExampleSqlPool", + "type": "Microsoft.Synapse/workspaces/sqlPools", + "location": "West US 2", + "properties": { + "provisioningState": "Deleting", + "status": "Paused" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/sqlPools/ExampleSqlPool", + "name": "ExampleSqlPool", + "type": "Microsoft.Synapse/workspaces/sqlPools", + "location": "West US 2", + "properties": { + "provisioningState": "Deleting", + "status": "Paused" + } + } + }, + "204": {}, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteSqlPoolColumnSensitivityLabel.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteSqlPoolColumnSensitivityLabel.json new file mode 100644 index 000000000000..283c183ae2d2 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteSqlPoolColumnSensitivityLabel.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myRG", + "workspaceName": "myServer", + "sqlPoolName": "myDatabase", + "schemaName": "dbo", + "tableName": "myTable", + "columnName": "myColumn", + "sensitivityLabelSource": "current", + "api-version": "2021-05-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteSqlPoolVulnerabilityAssessment.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteSqlPoolVulnerabilityAssessment.json new file mode 100644 index 000000000000..102ddaaa250a --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteSqlPoolVulnerabilityAssessment.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "vulnerabilityaseessmenttest-4799", + "workspaceName": "vulnerabilityaseessmenttest-6440", + "sqlPoolName": "testdb", + "vulnerabilityAssessmentName": "default", + "api-version": "2021-05-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteSqlPoolVulnerabilityAssessmentRuleBaseline.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteSqlPoolVulnerabilityAssessmentRuleBaseline.json new file mode 100644 index 000000000000..564dcf184218 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteSqlPoolVulnerabilityAssessmentRuleBaseline.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "vulnerabilityaseessmenttest-4799", + "workspaceName": "vulnerabilityaseessmenttest-6440", + "sqlPoolName": "testdb", + "baselineName": "default", + "ruleId": "VA1001", + "vulnerabilityAssessmentName": "default", + "api-version": "2021-05-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteSqlPoolWorkloadGroup.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteSqlPoolWorkloadGroup.json new file mode 100644 index 000000000000..a24a3710dfa6 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteSqlPoolWorkloadGroup.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-6852", + "workspaceName": "sqlcrudtest-2080", + "sqlPoolName": "sqlcrudtest-9187", + "workloadGroupName": "wlm_workloadgroup", + "api-version": "2021-05-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteSqlPoolWorkloadGroupWorkloadClassifer.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteSqlPoolWorkloadGroupWorkloadClassifer.json new file mode 100644 index 000000000000..4e124ff06c83 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteSqlPoolWorkloadGroupWorkloadClassifer.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-6852", + "workspaceName": "sqlcrudtest-2080", + "sqlPoolName": "sqlcrudtest-9187", + "workloadGroupName": "wlm_workloadgroup", + "workloadClassifierName": "wlm_workloadclassifier", + "api-version": "2021-05-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteWorkspace.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteWorkspace.json new file mode 100644 index 000000000000..96a2dcdd8259 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteWorkspace.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2021-05-01" + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1", + "name": "workspace1", + "type": "Microsoft.Synapse/workspaces", + "location": "East US", + "properties": { + "defaultDataLakeStorage": { + "accountUrl": "https://accountname.dfs.core.windows.net", + "filesystem": "default" + }, + "connectivityEndpoints": { + "dev": "workspace1.dev.projectarcadia.net", + "sql": "workspace1.sql.projectarcadia.net" + }, + "sqlAdministratorLogin": "login", + "managedResourceGroupName": "resourceGroup2", + "provisioningState": "Deleting" + }, + "tags": { + "key": "value" + } + } + }, + "204": {}, + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1", + "name": "workspace1", + "type": "Microsoft.Synapse/workspaces", + "location": "East US", + "properties": { + "defaultDataLakeStorage": { + "accountUrl": "https://accountname.dfs.core.windows.net", + "filesystem": "default" + }, + "connectivityEndpoints": { + "dev": "workspace1.dev.projectarcadia.net", + "sql": "workspace1.sql.projectarcadia.net" + }, + "sqlAdministratorLogin": "login", + "managedResourceGroupName": "resourceGroup2", + "provisioningState": "Deleting" + }, + "tags": { + "key": "value" + } + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteWorkspaceAadAdmin.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteWorkspaceAadAdmin.json new file mode 100644 index 000000000000..9a67520c5c50 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteWorkspaceAadAdmin.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2021-05-01" + }, + "responses": { + "200": {}, + "204": {}, + "202": {}, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteWorkspaceManagedSqlServerVulnerabilityAssessment.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteWorkspaceManagedSqlServerVulnerabilityAssessment.json new file mode 100644 index 000000000000..4857f73d9ae0 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/DeleteWorkspaceManagedSqlServerVulnerabilityAssessment.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "wsg-7398", + "workspaceName": "testWorkspace", + "vulnerabilityAssessmentName": "default", + "api-version": "2021-05-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ExecuteSqlPoolVulnerabilityAssessmentScans.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ExecuteSqlPoolVulnerabilityAssessmentScans.json new file mode 100644 index 000000000000..c9a25a9cd791 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ExecuteSqlPoolVulnerabilityAssessmentScans.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "vulnerabilityassessmenttest-4711", + "workspaceName": "vulnerabilityassessmenttest-6411", + "sqlPoolName": "testdb", + "vulnerabilityAssessmentName": "default", + "scanId": "scan01", + "api-version": "2021-05-01" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ExportSqlPoolVulnerabilityAssessmentScan.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ExportSqlPoolVulnerabilityAssessmentScan.json new file mode 100644 index 000000000000..0257fb466e64 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ExportSqlPoolVulnerabilityAssessmentScan.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "vulnerabilityassessmenttest-4799", + "workspaceName": "vulnerabilityassessmenttest-6440", + "sqlPoolName": "testdb", + "vulnerabilityAssessmentName": "default", + "scanId": "scan001", + "api-version": "2021-05-01", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityassessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityassessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default/scans/scan001/export", + "name": "scan001", + "type": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/scans/export", + "properties": { + "exportedReportLocation": "https://myaccount.blob.core.windows.net/vulnerabilityAssessment/vulnerabilityassessmenttest-6440/testdb/scan001.xlsx" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityassessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityassessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default/scans/scan001/export", + "name": "scan001", + "type": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/scans/export", + "properties": { + "exportedReportLocation": "https://myaccount.blob.core.windows.net/vulnerabilityAssessment/vulnerabilityassessmenttest-6440/testdb/scan001.xlsx" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ExtendedSqlPoolAzureMonitorAuditingCreateMin.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ExtendedSqlPoolAzureMonitorAuditingCreateMin.json new file mode 100644 index 000000000000..b0d71be11f25 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ExtendedSqlPoolAzureMonitorAuditingCreateMin.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "blobauditingtest-4799", + "workspaceName": "blobauditingtest-6440", + "sqlPoolName": "testdb", + "blobAuditingPolicyName": "default", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "state": "Enabled", + "isAzureMonitorTargetEnabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Synapse/workspaces/blobauditingtest-6440/sqlPools/testdb", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/extendedAuditingSettings", + "properties": { + "state": "Enabled", + "isAzureMonitorTargetEnabled": true, + "retentionDays": 0, + "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups": [ + "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", + "FAILED_DATABASE_AUTHENTICATION_GROUP", + "BATCH_COMPLETED_GROUP" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Synapse/workspaces/blobauditingtest-6440/sqlPools/testdb", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/extendedAuditingSettings", + "properties": { + "state": "Enabled", + "isAzureMonitorTargetEnabled": true, + "retentionDays": 0, + "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups": [ + "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", + "FAILED_DATABASE_AUTHENTICATION_GROUP", + "BATCH_COMPLETED_GROUP" + ] + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ExtendedSqlPoolBlobAuditingCreateMax.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ExtendedSqlPoolBlobAuditingCreateMax.json new file mode 100644 index 000000000000..67a41deb25dd --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ExtendedSqlPoolBlobAuditingCreateMax.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "blobauditingtest-4799", + "workspaceName": "blobauditingtest-6440", + "sqlPoolName": "testdb", + "blobAuditingPolicyName": "default", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "state": "Enabled", + "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "retentionDays": 6, + "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups": [ + "DATABASE_LOGOUT_GROUP", + "DATABASE_ROLE_MEMBER_CHANGE_GROUP", + "UPDATE on database::TestDatabaseName by public" + ], + "predicateExpression": "statement = 'select 1'", + "isAzureMonitorTargetEnabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Synapse/workspaces/blobauditingtest-6440/sqlPools/testdb", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/extendedAuditingSettings", + "properties": { + "state": "Enabled", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "retentionDays": 0, + "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups": [ + "DATABASE_LOGOUT_GROUP", + "DATABASE_ROLE_MEMBER_CHANGE_GROUP", + "UPDATE on database::TestDatabaseName by public" + ], + "predicateExpression": "statement = 'select 1'", + "isAzureMonitorTargetEnabled": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Synapse/workspaces/blobauditingtest-6440/sqlPools/testdb", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/extendedAuditingSettings", + "properties": { + "state": "Enabled", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "retentionDays": 0, + "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups": [ + "DATABASE_LOGOUT_GROUP", + "DATABASE_ROLE_MEMBER_CHANGE_GROUP", + "UPDATE on database::TestDatabaseName by public" + ], + "predicateExpression": "statement = 'select 1'", + "isAzureMonitorTargetEnabled": true + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ExtendedSqlPoolBlobAuditingCreateMin.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ExtendedSqlPoolBlobAuditingCreateMin.json new file mode 100644 index 000000000000..6931d6d302b7 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ExtendedSqlPoolBlobAuditingCreateMin.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "blobauditingtest-4799", + "workspaceName": "blobauditingtest-6440", + "sqlPoolName": "testdb", + "blobAuditingPolicyName": "default", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "state": "Enabled", + "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==", + "storageEndpoint": "https://mystorage.blob.core.windows.net" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Synapse/workspaces/blobauditingtest-6440/sqlPools/testdb", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/extendedAuditingSettings", + "properties": { + "state": "Enabled", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "retentionDays": 0, + "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups": [ + "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", + "FAILED_DATABASE_AUTHENTICATION_GROUP", + "BATCH_COMPLETED_GROUP" + ], + "isAzureMonitorTargetEnabled": false + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Synapse/workspaces/blobauditingtest-6440/sqlPools/testdb", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/extendedAuditingSettings", + "properties": { + "state": "Enabled", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "retentionDays": 0, + "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups": [ + "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", + "FAILED_DATABASE_AUTHENTICATION_GROUP", + "BATCH_COMPLETED_GROUP" + ], + "isAzureMonitorTargetEnabled": false + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ExtendedSqlPoolBlobAuditingGet.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ExtendedSqlPoolBlobAuditingGet.json new file mode 100644 index 000000000000..f91e830de3a0 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ExtendedSqlPoolBlobAuditingGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "blobauditingtest-6852", + "workspaceName": "blobauditingtest-2080", + "sqlPoolName": "testdb", + "blobAuditingPolicyName": "default", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-6852/providers/Microsoft.Synapse/workspaces/blobauditingtest-2080/sqlPools/testdb", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/extendedAuditingSettings", + "properties": { + "state": "Disabled", + "storageEndpoint": "", + "retentionDays": 0, + "auditActionsAndGroups": [], + "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", + "isStorageSecondaryKeyInUse": false, + "predicateExpression": "statement = 'select 1'", + "isAzureMonitorTargetEnabled": false + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetAvailableOperations.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetAvailableOperations.json new file mode 100644 index 000000000000..bd2cb3fd48ed --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetAvailableOperations.json @@ -0,0 +1,1480 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup1", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": [ + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Get Integration Runtime Operation result.", + "description": "Get any Integration Runtime." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings/write", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Managed Identity SQL Control Settings", + "operation": "Update Managed Identity SQL Control Settings", + "description": "Update Managed Identity SQL Control Settings on the workspace" + }, + "origin": "user" + }, + { + "name": "Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Managed Identity SQL Control Settings", + "operation": "Get Managed Identity SQL Control Settings", + "description": "Get Managed Identity SQL Control Settings" + }, + "origin": "user" + }, + { + "name": "Microsoft.Synapse/operations/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Available Operations", + "operation": "Read Available Operations.", + "description": "Read Available Operations from the Analytics 365 Resource Provider." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/nodes/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Get Integration Runtime Node.", + "description": "Get any Integration Runtime Node." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/nodes/delete", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Delete Integration Runtime Node.", + "description": "Delete any Integration Runtime Node." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/nodes/write", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Patch Integration Runtime Node.", + "description": "Patch any Integration Runtime Node." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/nodes/ipAddress/action", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Get Integration Runtime Ip Address", + "description": "Get Integration Runtime Ip Address" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationruntimes/write", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Create or Update Integration Runtimes.", + "description": "Create or Update any Integration Runtimes." + }, + "origin": "user" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/delete", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Delete Integration Runtimes", + "description": "Delete any Integration Runtime" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/getStatus/action", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Get an Integration Runtime Status", + "description": "Get any Integration Runtime's Status" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/start/action", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Start an Integration Runtime", + "description": "Start any Integration Runtime" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/stop/action", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Stop an Integration Runtime", + "description": "Stop any Integration Runtime" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/getConnectionInfo/action", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Get Connection Info of an Integration Runtime", + "description": "Get Connection Info of any Integration Runtime" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/regenerateAuthKey/action", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Regenerate auth key of an Integration Runtime", + "description": "Regenerate auth key of any Integration Runtime" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/listAuthKeys/action", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "List Auth Keys of an Integration Runtime", + "description": "List Auth Keys of any Integration Runtime" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/removeNode/action", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Remove an Integration Runtime node", + "description": "Remove any Integration Runtime node" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/monitoringData/action", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Get an Integration Runtime's monitoring data", + "description": "Get any Integration Runtime's monitoring data" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/syncCredentials/action", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Sync credential on an Integration Runtime", + "description": "Sync credential on any Integration Runtime" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/upgrade/action", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Upgrade an Integration Runtime", + "description": "Upgrade any Integration Runtime" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/removeLinks/action", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Remove an Integration Runtime link", + "description": "Remove any Integration Runtime link" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/enableInteractiveQuery/action", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Enable Interactive query on an Integration Runtime", + "description": "Enable Interactive query on any Integration Runtime" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/disableInteractiveQuery/action", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Disable Interactive query on an Integration Runtime", + "description": "Disable Interactive query on any Integration Runtime" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/refreshObjectMetadata/action", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Refresh Object metadata on an Intergration Runtime", + "description": "Refresh Object metadata on any Intergration Runtime" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/getObjectMetadata/action", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Get Object metadata on an Intergration Runtime", + "description": "Get Object metadata on any Intergration Runtime" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/firewallRules/write", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "IP Firewall Rule.", + "operation": "Create or update IP Firewall Rule.", + "description": "Create or update any IP Firewall Rule." + }, + "origin": "user" + }, + { + "name": "Microsoft.Synapse/workspaces/firewallRules/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "IP Firewall Rule.", + "operation": "Read IP Firewall Rule", + "description": "Read IP Firewall Rule" + }, + "origin": "user" + }, + { + "name": "Microsoft.Synapse/workspaces/firewallRules/delete", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "IP Firewall Rule.", + "operation": "Delete IP Firewall Rule", + "description": "Delete any IP Firewall Rule." + }, + "origin": "user" + }, + { + "name": "Microsoft.Synapse/workspaces/replaceAllIpFirewallRules/action", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Workspaces", + "operation": "Replace all Ip Firewall Rules for the Workspace.", + "description": "Replaces all Ip Firewall Rules for the Workspace." + }, + "origin": "user" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/write", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pools", + "operation": "Create or Update SQL Analytics pools.", + "description": "Create or Update any SQL Analytics pools." + }, + "origin": "user" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pools", + "operation": "Read SQL Analytics pools.", + "description": "Read any SQL Analytics pools." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/dataWarehouseQueries/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Queries", + "operation": "Read SQL Analytics pool Queries.", + "description": "Read any SQL Analytics pool Queries." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/geoBackupPolicies/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Geo Backup Policies", + "operation": "Read SQL Analytics pool Geo Backup Policies.", + "description": "Read any SQL Analytics pool Geo Backup Policies." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/dataWarehouseUserActivities/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool User Activities", + "operation": "Read SQL Analytics pool User Activities.", + "description": "Read any SQL Analytics pool User Activities." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/restorePoints/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Restore Points", + "operation": "Read SQL Analytics pool Restore Points.", + "description": "Read any SQL Analytics pool Restore Points." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/dataWarehouseQueries/dataWarehouseQuerySteps/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Query Steps", + "operation": "Read SQL Analytics pool Query Steps.", + "description": "Read any SQL Analytics pool Query Steps." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/maintenanceWindows/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Maintenance Windows", + "operation": "Read SQL Analytics pool Maintenance Windows.", + "description": "Read any SQL Analytics pool Maintenance Windows." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/maintenanceWindowOptions/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Maintenance Window Options", + "operation": "Read SQL Analytics pool Maintenance Window Options.", + "description": "Read any SQL Analytics pool Maintenance Window Options." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/replicationLinks/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Replication Links", + "operation": "Read SQL Analytics pool Replication Links.", + "description": "Read any SQL Analytics pool Replication Links." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Transparent Data Encryption Configuration", + "operation": "Read SQL Analytics pool Transparent Data Encryption Configuration.", + "description": "Read any SQL Analytics pool Transparent Data Encryption Configuration." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption/operationResults/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Transparent Data Encryption Configuration Operation Results", + "operation": "Read SQL Analytics pool Transparent Data Encryption Configuration Operation Results.", + "description": "Read any SQL Analytics pool Transparent Data Encryption Configuration Operation Results." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/auditingSettings/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Auditing Settings", + "operation": "Read SQL Analytics pool Auditing Settings.", + "description": "Read any SQL Analytics pool Auditing Settings." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/operations/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Operations", + "operation": "Read SQL Analytics pool Operations.", + "description": "Read any SQL Analytics pool Operations." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/usages/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Usages", + "operation": "Read SQL Analytics pool Usages.", + "description": "Read any SQL Analytics pool Usages." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/currentSensitivityLabels/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Current Sensitivity Labels", + "operation": "Read SQL Analytics pool Current Sensitivity Labels.", + "description": "Read any SQL Analytics pool Current Sensitivity Labels." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/recommendedSensitivityLabels/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Recommended Sensitivity Labels", + "operation": "Read SQL Analytics pool Recommended Sensitivity Labels.", + "description": "Read any SQL Analytics pool Recommended Sensitivity Labels." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/schemas/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Schemas", + "operation": "Read SQL Analytics pool Schemas.", + "description": "Read any SQL Analytics pool Schemas." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/schemas/tables/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Schema Tables", + "operation": "Read SQL Analytics pool Schema Tables.", + "description": "Read any SQL Analytics pool Schema Tables." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Schema Table Columns", + "operation": "Read SQL Analytics pool Schema Table Columns.", + "description": "Read any SQL Analytics pool Schema Table Columns." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/connectionPolicies/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Connection Policies", + "operation": "Read SQL Analytics pool Connection Policies.", + "description": "Read any SQL Analytics pool Connection Policies." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Vulnerability Assessment", + "operation": "Read SQL Analytics pool Vulnerability Assessment.", + "description": "Read any SQL Analytics pool Vulnerability Assessment." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/scans/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Vulnerability Assessment Scan Records", + "operation": "Read SQL Analytics pool Vulnerability Assessment Scan Records.", + "description": "Read any SQL Analytics pool Vulnerability Assessment Scan Records." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Security Alert Policies", + "operation": "Read Sql Analytics pool Threat Detection Policies.", + "description": "Read any Sql Analytics pool Threat Detection Policies." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/delete", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pools", + "operation": "Delete SQL Analytics pools.", + "description": "Delete any SQL Analytics pools." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/pause/action", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pools", + "operation": "Pause SQL Analytics pools.", + "description": "Pause any SQL Analytics pools." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/resume/action", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pools", + "operation": "Resume SQL Analytics pools.", + "description": "Resume any SQL Analytics pools." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/restorePoints/action", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Restore Points", + "operation": "Create SQL Analytics pool Restore Point.", + "description": "Create a SQL Analytics pool Restore Point." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/move/action", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pools", + "operation": "Rename SQL Analytics pools.", + "description": "Rename any SQL Analytics pools." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels/enable/action", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Sensitivity Labels", + "operation": "Enable SQL Analytics pool Sensitivity Labels.", + "description": "Enable any SQL Analytics pool Sensitivity Labels." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels/disable/action", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Sensitivity Labels", + "operation": "Disable SQL Analytics pool Sensitivity Labels.", + "description": "Disable any SQL Analytics pool Sensitivity Labels." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/scans/initiateScan/action", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Vulnerability Assessment Scan Records", + "operation": "Initiate SQL Analytics pool Vulnerability Assessment Scan Records.", + "description": "Initiate any SQL Analytics pool Vulnerability Assessment Scan Records." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/scans/export/action", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Vulnerability Assessment Scan Records", + "operation": "Export SQL Analytics pool Vulnerability Assessment Scan Records.", + "description": "Export any SQL Analytics pool Vulnerability Assessment Scan Records." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/maintenanceWindows/write", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Maintenance Windows", + "operation": "Create or Update SQL Analytics pool Maintenance Windows.", + "description": "Read any SQL Analytics pool Maintenance Windows." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/auditingSettings/write", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Auditing Settings", + "operation": "Create or Update SQL Analytics pool Auditing Settings.", + "description": "Create or Update any SQL Analytics pool Auditing Settings." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels/write", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Sensitivity Labels", + "operation": "Create or update SQL Analytics pool Sensitivity Labels.", + "description": "Create or Update any SQL Analytics pool Sensitivity Labels." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption/write", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Transparent Data Encryption Configuration", + "operation": "Create or Update SQL Analytics pool Transparent Data Encryption Configuration.", + "description": "Create or Update any SQL Analytics pool Transparent Data Encryption Configuration." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies/write", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Security Alert Policies", + "operation": "Create or Update SQL Analytics pool Threat Detection Policies.", + "description": "Create or Update any SQL Analytics pool Threat Detection Policies." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/rules/baselines/write", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Vulnerability Assessment Rule Baseline", + "operation": "Create or Update SQL Analytics pool Vulnerability Assessment Rule Baseline.", + "description": "Create or Update any SQL Analytics pool Vulnerability Assessment Rule Baseline." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels/delete", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Sensitivity Labels", + "operation": "Delete SQL Analytics pool Sensitivity Labels.2", + "description": "Delete any SQL Analytics pool Sensitivity Labels." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/delete", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Vulnerability Assessment", + "operation": "Delete SQL Analytics pool Vulnerability Assessment.", + "description": "Delete any SQL Analytics pool Vulnerability Assessment." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/rules/baselines/delete", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Vulnerability Assessment Rule Baseline", + "operation": "Delete SQL Analytics pool Vulnerability Assessment Rule Baseline.", + "description": "Delete any SQL Analytics pool Vulnerability Assessment Rule Baseline." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/operationStatus/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Async Operation Status.", + "operation": "Read Async Operation Status.", + "description": "Read any Async Operation Status." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/operationResults/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Async Operation Result", + "operation": "Read Async Operation Result.", + "description": "Read any Async Operation Result." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/operationResults/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Async Operation Result", + "operation": "Read Async Operation Result.", + "description": "Read any Async Operation Result." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/checkNameAvailability/action", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Check Name Availability", + "operation": "Checks Workspace name availability.", + "description": "Checks Workspace name availability." + }, + "origin": "user" + }, + { + "name": "Microsoft.Synapse/workspaces/bigDataPools/write", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Spark pools", + "operation": "Create or Update Spark pools.", + "description": "Create or Update any Spark pools." + }, + "origin": "user" + }, + { + "name": "Microsoft.Synapse/workspaces/bigDataPools/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Spark pools", + "operation": "Read Spark pools.", + "description": "Read any Spark pools." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/bigDataPools/delete", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Spark pools", + "operation": "Delete Spark pools.", + "description": "Delete any Spark pools." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/metadataSync/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Metadata Sync Config", + "operation": "Read SQL Analytics pool Metadata Sync Config", + "description": "Read SQL Analytics pool Metadata Sync Config" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/metadataSync/write", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Metadata Sync Config", + "operation": "Create or Update SQL Analytics pool Metadata Sync Config", + "description": "Create or Update SQL Analytics pool Metadata Sync Config" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/register/action", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Analytics 365 Resource Provider.", + "operation": "Registers the Analytics 365 Resource Provider.", + "description": "Registers the Analytics 365 Resource Provider and enables the creation of Workspaces." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/administrators/write", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Administrators", + "operation": "Set Active Directory Administrator", + "description": "Set Active Directory Administrator on the Workspace" + }, + "origin": "user" + }, + { + "name": "Microsoft.Synapse/workspaces/administrators/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Administrators", + "operation": "Get Workspace Active Directory Administrator", + "description": "Get Workspace Active Directory Administrator" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/administrators/delete", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Administrators", + "operation": "Delete Workspace Active Directory Administrator", + "description": "Delete Workspace Active Directory Administrator" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/write", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Workspaces", + "operation": "Create or Update Workspaces.", + "description": "Create or Update any Workspaces." + }, + "origin": "user" + }, + { + "name": "Microsoft.Synapse/workspaces/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Workspaces", + "operation": "Read Workspaces.", + "description": "Read any Workspaces." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/delete", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Workspaces", + "operation": "Delete Workspaces.", + "description": "Delete any Workspaces." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/privateEndpointConnectionProxies/validate/action", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Validate Private Endpoint Connection Proxy", + "operation": "Validates Private Endpoint Connection Proxy", + "description": "Validates Private Endpoint Connection Proxy" + }, + "origin": "system" + }, + { + "name": "Microsoft.Synapse/workspaces/privateEndpointConnectionProxies/write", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Private Endpoint Connection Proxy", + "operation": "Create or Update Private Endpoint Connection Proxy", + "description": "Create or Update Private Endpoint Connection Proxy" + }, + "origin": "system" + }, + { + "name": "Microsoft.Synapse/workspaces/privateEndpointConnectionProxies/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Private Endpoint Connection Proxy", + "operation": "Read Private Endpoint Connection Proxies", + "description": "Read any Private Endpoint Connection Proxy" + }, + "origin": "system" + }, + { + "name": "Microsoft.Synapse/workspaces/privateLinkResources/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Private Link Resources", + "operation": "Get Private Link Resources", + "description": "Get a list of Private Link Resources" + }, + "origin": "user" + }, + { + "name": "Microsoft.Synapse/workspaces/serverKeys/write", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Server Key", + "operation": "Creates or updates a server key", + "description": "Creates or updates a server key" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/serverKeys/delete", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Server Key", + "operation": "Deletes the server key with the given name.", + "description": "Deletes the server key with the given name." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/extendedAuditingSettings/write", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Server Extended Auditing Settings", + "operation": "Create or Update SQL server extended auditing settings.", + "description": "Create or Update SQL server extended auditing settings." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/extendedAuditingSettings/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Server Extended Auditing Settings", + "operation": "Read SQL server extended auditing settings.", + "description": "Read SQL server extended auditing settings." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/auditingSettings/write", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Server Auditing Settings", + "operation": "Create or Update SQL server auditing settings.", + "description": "Create or Update SQL server auditing settings." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/auditingSettings/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Server Auditing Settings", + "operation": "Read SQL server auditing settings.", + "description": "Read SQL server auditing settings." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/securityAlertPolicies/write", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Server Security Alert Policy", + "operation": "Create or Update SQL server security alert policies.", + "description": "Create or Update SQL server security alert policies." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/securityAlertPolicies/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Server Security Alert Policy", + "operation": "Read SQL server security alert policies.", + "description": "Read SQL server security alert policies." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/vulnerabilityAssessments/write", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Server Vulnerability Assesment", + "operation": "Create or Update SQL server vulnerability assement report.", + "description": "Create or Update SQL server vulnerability assement report." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/vulnerabilityAssessments/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Server Vulnerability Assesment", + "operation": "Read SQL server vulnerability assement report.", + "description": "Read SQL server vulnerability assement report." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/vulnerabilityAssessments/delete", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Server Vulnerability Assesment", + "operation": "Delete SQL server vulnerability assement report.", + "description": "Delete SQL server vulnerability assement report." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/encryptionProtector/write", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Server Encryption Protector", + "operation": "Update the properties for the specified Server Encryption Protector.", + "description": "Update the properties for the specified Server Encryption Protector." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/encryptionProtector/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Server Encryption Protector", + "operation": "Returns a list of server encryption protectors or gets the properties for the specified server encryption protector.", + "description": "Returns a list of server encryption protectors or gets the properties for the specified server encryption protector." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/encryptionProtector/revalidate/action", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Server Encryption Protector", + "operation": "Revalidates an existing encryption protector.", + "description": "Revalidates an existing encryption protector." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/providers/Microsoft.Insights/metricDefinitions/read", + "isDataAction": null, + "display": { + "provider": "Microsoft Azure Synapse Analytics", + "resource": "Workspace", + "operation": "Read workspace metric definitions", + "description": "Gets the available metrics for workspace" + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "PipelineFailedRuns", + "displayName": "Failed pipeline runs", + "displayDescription": null, + "unit": "Count", + "aggregationType": "Total", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics", + "dimensions": [ + { + "name": "FailureType", + "displayName": "Failure Type", + "toBeExportedForShoebox": true + }, + { + "name": "Name", + "displayName": "Pipeline", + "toBeExportedForShoebox": true + } + ] + }, + { + "name": "PipelineSucceededRuns", + "displayName": "Succeeded pipeline runs", + "displayDescription": null, + "unit": "Count", + "aggregationType": "Total", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics", + "dimensions": [ + { + "name": "FailureType", + "displayName": "Failure Type", + "toBeExportedForShoebox": true + }, + { + "name": "Name", + "displayName": "Pipeline", + "toBeExportedForShoebox": true + } + ] + }, + { + "name": "PipelineCancelledRuns", + "displayName": "Cancelled pipeline runs", + "displayDescription": null, + "unit": "Count", + "aggregationType": "Total", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics", + "dimensions": [ + { + "name": "FailureType", + "displayName": "Failure Type", + "toBeExportedForShoebox": true + }, + { + "name": "Name", + "displayName": "Pipeline", + "toBeExportedForShoebox": true + } + ] + }, + { + "name": "ActivityFailedRuns", + "displayName": "Failed activity runs", + "displayDescription": null, + "unit": "Count", + "aggregationType": "Total", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics", + "dimensions": [ + { + "name": "ActivityType", + "displayName": "Activity Type", + "toBeExportedForShoebox": true + }, + { + "name": "PipelineName", + "displayName": "Pipeline", + "toBeExportedForShoebox": true + }, + { + "name": "FailureType", + "displayName": "Failure Type", + "toBeExportedForShoebox": true + }, + { + "name": "Name", + "displayName": "Activity", + "toBeExportedForShoebox": true + } + ] + }, + { + "name": "ActivitySucceededRuns", + "displayName": "Succeeded activity runs", + "displayDescription": null, + "unit": "Count", + "aggregationType": "Total", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics", + "dimensions": [ + { + "name": "ActivityType", + "displayName": "Activity Type", + "toBeExportedForShoebox": true + }, + { + "name": "PipelineName", + "displayName": "Pipeline", + "toBeExportedForShoebox": true + }, + { + "name": "FailureType", + "displayName": "Failure Type", + "toBeExportedForShoebox": true + }, + { + "name": "Name", + "displayName": "Activity", + "toBeExportedForShoebox": true + } + ] + }, + { + "name": "ActivityCancelledRuns", + "displayName": "Cancelled activity runs", + "displayDescription": null, + "unit": "Count", + "aggregationType": "Total", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics", + "dimensions": [ + { + "name": "ActivityType", + "displayName": "Activity Type", + "toBeExportedForShoebox": true + }, + { + "name": "PipelineName", + "displayName": "Pipeline", + "toBeExportedForShoebox": true + }, + { + "name": "FailureType", + "displayName": "Failure Type", + "toBeExportedForShoebox": true + }, + { + "name": "Name", + "displayName": "Activity", + "toBeExportedForShoebox": true + } + ] + }, + { + "name": "TriggerFailedRuns", + "displayName": "Failed trigger runs", + "displayDescription": null, + "unit": "Count", + "aggregationType": "Total", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics", + "dimensions": [ + { + "name": "Name", + "displayName": "Trigger", + "toBeExportedForShoebox": true + }, + { + "name": "FailureType", + "displayName": "Failure Type", + "toBeExportedForShoebox": true + } + ] + }, + { + "name": "TriggerSucceededRuns", + "displayName": "Succeeded trigger runs", + "displayDescription": null, + "unit": "Count", + "aggregationType": "Total", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics", + "dimensions": [ + { + "name": "Name", + "displayName": "Trigger", + "toBeExportedForShoebox": true + }, + { + "name": "FailureType", + "displayName": "Failure Type", + "toBeExportedForShoebox": true + } + ] + }, + { + "name": "TriggerCancelledRuns", + "displayName": "Cancelled trigger runs", + "displayDescription": null, + "unit": "Count", + "aggregationType": "Total", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics", + "dimensions": [ + { + "name": "Name", + "displayName": "Trigger", + "toBeExportedForShoebox": true + }, + { + "name": "FailureType", + "displayName": "Failure Type", + "toBeExportedForShoebox": true + } + ] + } + ] + } + } + }, + { + "name": "Microsoft.Synapse/workspaces/providers/Microsoft.Insights/diagnosticSettings/read", + "isDataAction": null, + "display": { + "provider": "Microsoft Azure Synapse Analytics", + "resource": "Workspace", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource" + }, + "origin": "system" + }, + { + "name": "Microsoft.Synapse/workspaces/providers/Microsoft.Insights/diagnosticSettings/write", + "isDataAction": null, + "display": { + "provider": "Microsoft Azure Synapse Analytics", + "resource": "Workspace", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource" + }, + "origin": "system" + }, + { + "name": "Microsoft.Synapse/workspaces/providers/Microsoft.Insights/logDefinitions/read", + "isDataAction": null, + "display": { + "provider": "Microsoft Azure Synapse Analytics", + "resource": "The log definition of workspace", + "operation": "Read workspace log definitions", + "description": "Gets the available logs for workspace" + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "ActivityRuns", + "displayName": "Activity runs", + "blobDuration": "PT1H" + }, + { + "name": "PipelineRuns", + "displayName": "Pipeline runs", + "blobDuration": "PT1H" + }, + { + "name": "TriggerRuns", + "displayName": "Trigger runs", + "blobDuration": "PT1H" + } + ] + } + } + }, + { + "name": "Microsoft.Synapse/workspaces/recoverableSqlPools/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "Recoverable Sql Analytics Pools", + "operation": "Gets recoverable SQL Analytics Pools.", + "description": "Gets recoverable SQL Analytics Pools, which are the resources representing geo backups of SQL Analytics Pools." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlUsages/read", + "isDataAction": "false", + "display": { + "provider": "Analytics 365 Resource Provider.", + "resource": "SQL Analytics pool Usages", + "operation": "Gets usage limits available for SQL Analytics Pools.", + "description": "Gets usage limits available for SQL Analytics Pools." + }, + "origin": "user, system" + } + ] + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetAzureAsyncOperationHeader.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetAzureAsyncOperationHeader.json new file mode 100644 index 000000000000..52d3f2af3d67 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetAzureAsyncOperationHeader.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "operationId": "01234567-89ab-4def-0123-456789abcdef", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "status": "InProgress" + } + }, + "404": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetBigDataPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetBigDataPool.json new file mode 100644 index 000000000000..8a441b3d41bd --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetBigDataPool.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "bigDataPoolName": "ExamplePool", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/bigDataPools/ExamplePool", + "type": "Microsoft.Synapse/workspaces/bigDataPools", + "location": "West US 2", + "name": "ExamplePool", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "sparkVersion": "2.4", + "nodeCount": 4, + "nodeSize": "Medium", + "nodeSizeFamily": "MemoryOptimized", + "autoScale": { + "enabled": true, + "minNodeCount": 3, + "maxNodeCount": 50 + }, + "autoPause": { + "enabled": true, + "delayInMinutes": 15 + }, + "creationDate": "1970-01-01T00:00:00Z", + "sparkEventsFolder": "/events", + "libraryRequirements": { + "time": "1970-01-01T00:00:00Z", + "content": "", + "filename": "requirements.txt" + }, + "defaultSparkLogFolder": "/logs" + } + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetIpFirewallRule.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetIpFirewallRule.json new file mode 100644 index 000000000000..4dd2ac0a515a --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetIpFirewallRule.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "ruleName": "ExampleIpFirewallRule", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/firewallRules/ExampleIpFirewallRule", + "type": "Microsoft.Synapse/workspaces/firewallRules", + "name": "ExampleIpFirewallRule", + "properties": { + "startIpAddress": "10.0.0.0", + "endIpAddress": "10.0.0.254", + "provisioningState": "Succeeded" + } + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetKey.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetKey.json new file mode 100644 index 000000000000..eddbc6ff5f44 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetKey.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "keyName": "somekey", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/somekey", + "name": "somekey", + "type": "Microsoft.Synapse/workspaces/keys", + "properties": { + "isActiveCMK": true, + "keyVaultUrl": "https://vault.azure.net/keys/key1" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetLocationHeader.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetLocationHeader.json new file mode 100644 index 000000000000..cc7acc5ecc95 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetLocationHeader.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "operationId": "01234567-89ab-4def-0123-456789abcdef", + "api-version": "2021-05-01" + }, + "responses": { + "200": {}, + "201": {}, + "202": {}, + "204": {}, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetLocationHeaderResultWithSqlPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetLocationHeaderResultWithSqlPool.json new file mode 100644 index 000000000000..d265e1a25813 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetLocationHeaderResultWithSqlPool.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "sqlPoolName": "ExampleSqlPool", + "operationId": "fedcba98-7654-4210-fedc-ba9876543210", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "body": {} + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetMaintenanceWindowOptions.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetMaintenanceWindowOptions.json new file mode 100644 index 000000000000..d3780511256f --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetMaintenanceWindowOptions.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "samplerg", + "workspaceName": "testworkspace", + "sqlPoolName": "testsp", + "maintenanceWindowOptionsName": "current", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "isEnabled": true, + "maintenanceWindowCycles": [ + { + "dayOfWeek": "Saturday", + "startTime": "00:00:00", + "duration": "PT60M" + } + ], + "minDurationInMinutes": 60, + "defaultDurationInMinutes": 120, + "minCycles": 2, + "timeGranularityInMinutes": 5, + "allowMultipleMaintenanceWindowsPerCycle": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/samplerg/providers/Microsoft.Synapse/workspaces/testworkspace/sqlPools/testsp/maintenanceWindowOptions/current", + "name": "current", + "type": "Microsoft.Synapse/workspaces/sqlPools/maintenanceWindowOptions" + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetMaintenanceWindows.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetMaintenanceWindows.json new file mode 100644 index 000000000000..1cd9f58682ac --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetMaintenanceWindows.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "samplerg", + "workspaceName": "testworkspace", + "sqlPoolName": "testsp", + "maintenanceWindowName": "current", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "timeRanges": [ + { + "dayOfWeek": "Saturday", + "startTime": "00:00:00", + "duration": "PT60M" + } + ] + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/samplerg/providers/Microsoft.Synapse/workspaces/testworkspace/sqlPools/testsp/maintenancewindows/current", + "name": "current", + "type": "Microsoft.Synapse/workspaces/sqlPools/maintenancewindows" + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetManagedIdentitySqlControlSettings.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetManagedIdentitySqlControlSettings.json new file mode 100644 index 000000000000..b8c6ce47943e --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetManagedIdentitySqlControlSettings.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1/managedIdentitySqlControlSettings/default", + "name": "default", + "properties": { + "grantSqlControlToManagedIdentity": { + "desiredState": "Enabled", + "actualState": "Enabled" + } + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetPrivateEndpointConnection.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetPrivateEndpointConnection.json new file mode 100644 index 000000000000..5db049bdd9ca --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetPrivateEndpointConnection.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "privateEndpointConnectionName": "ExamplePrivateEndpointConnection", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/privateEndpointConnections/ExamplePrivateEndpointConnection", + "name": "sql", + "type": "Microsoft.Synapse/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Network/privateEndpoints/ExamplePrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetPrivateLinkHub.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetPrivateLinkHub.json new file mode 100644 index 000000000000..697cf7713e17 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetPrivateLinkHub.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup1", + "privateLinkHubName": "privateLinkHub1", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/privateLinkHubs/privateLinkHub1", + "name": "privateLinkHub1", + "type": "Microsoft.Synapse/privateLinkHubs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": { + "key": "value" + } + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetPrivateLinkHubPrivateLinkResource.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetPrivateLinkHubPrivateLinkResource.json new file mode 100644 index 000000000000..cb175d60771c --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetPrivateLinkHubPrivateLinkResource.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "privateLinkHubName": "ExamplePrivateLinkHub", + "privateLinkResourceName": "sql", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/privateLinkHubs/ExamplePrivateLinkHub/privateLinkResources/sql", + "name": "sql", + "type": "Microsoft.Synapse/privateLinkHubs/privateLinkResources", + "properties": { + "groupId": "sql", + "requiredMembers": [ + "sql" + ], + "requiredZoneNames": [ + "privatelink.sql.azuresynapse.net" + ] + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetPrivateLinkResource.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetPrivateLinkResource.json new file mode 100644 index 000000000000..9b01b6a3fee3 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetPrivateLinkResource.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "privateLinkResourceName": "sql", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/privateLinkResources/sql", + "name": "sql", + "type": "Microsoft.Synapse/workspaces/privateLinkResources", + "properties": { + "groupId": "sql", + "requiredMembers": [ + "sql" + ], + "requiredZoneNames": [ + "privatelink.sql.azuresynapse.net" + ] + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPool.json new file mode 100644 index 000000000000..6ae171542a72 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPool.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-6852", + "workspaceName": "sqlcrudtest-2080", + "sqlPoolName": "sqlcrudtest-9187", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "tags": { + "tagKey1": "TagValue1" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187", + "name": "sqlcrudtest-9187", + "type": "Microsoft.Synapse/workspaces/sqlPools", + "location": "Japan East", + "properties": { + "status": "Online", + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 268435456000, + "creationDate": "2017-02-10T00:56:19.2Z", + "provisioningState": "Succeeded", + "restorePointInTime": "0001-01-01T00:00:00Z", + "storageAccountType": "GRS" + }, + "sku": { + "name": "DW100c" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolBlobAuditing.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolBlobAuditing.json new file mode 100644 index 000000000000..5853fa0ef349 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolBlobAuditing.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "blobauditingtest-6852", + "workspaceName": "blobauditingtest-2080", + "sqlPoolName": "testdb", + "blobAuditingPolicyName": "default", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-6852/providers/Microsoft.Synapse/workspaces/blobauditingtest-2080/sqlPools/testdb", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/auditingSettings", + "kind": "V12", + "properties": { + "state": "Disabled", + "storageEndpoint": "", + "retentionDays": 0, + "auditActionsAndGroups": [], + "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", + "isStorageSecondaryKeyInUse": false, + "isAzureMonitorTargetEnabled": false + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolColumnSensitivityLabelGet.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolColumnSensitivityLabelGet.json new file mode 100644 index 000000000000..c3d9c16e378c --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolColumnSensitivityLabelGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myRG", + "workspaceName": "myServer", + "sqlPoolName": "myDatabase", + "schemaName": "dbo", + "tableName": "myTable", + "columnName": "myColumn", + "sensitivityLabelSource": "current", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/myServer/sqlPools/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current", + "name": "current", + "type": "Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels", + "properties": { + "informationType": "PhoneNumber", + "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646", + "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff", + "labelName": "PII" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolConnectionPolicy.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolConnectionPolicy.json new file mode 100644 index 000000000000..0ff380944bc1 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolConnectionPolicy.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "blobauditingtest-6852", + "workspaceName": "blobauditingtest-2080", + "sqlPoolName": "testdb", + "connectionPolicyName": "default", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-6852/providers/Microsoft.Synapse/workspaces/blobauditingtest-2080/sqlPools/testdb/connectionPolicies/default", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/connectionPolicies", + "location": "West US", + "kind": null, + "properties": { + "securityEnabledAccess": "Optional", + "proxyDnsName": "blobauditingtest-2080.database.secure.windows.net", + "proxyPort": "1433", + "visibility": "Visible", + "useServerDefault": "Enabled", + "redirectionState": "Disabled", + "state": "New" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolGeoBackupPolicy.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolGeoBackupPolicy.json new file mode 100644 index 000000000000..906f237104e5 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolGeoBackupPolicy.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-4799", + "workspaceName": "sqlcrudtest-5961", + "sqlPoolName": "testdw", + "geoBackupPolicyName": "Default", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Synapse/workspaces/sqlcrudtest-5961/sqlPools/testdw/geoBackupPolicies/Default", + "name": "Default", + "type": "Microsoft.Synapse/workspaces/sqlPools/geoBackupPolicies", + "location": "Central US", + "kind": null, + "properties": { + "state": "Enabled", + "storageType": "Premium" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolMetadataSyncConfig.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolMetadataSyncConfig.json new file mode 100644 index 000000000000..a9e66f0ab6e9 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolMetadataSyncConfig.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "sqlPoolName": "ExampleSqlPool", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/bigDataPools/ExamplePool/metadataSync/config", + "type": "Microsoft.Synapse/workspaces/bigDataPools/metadataSync/config", + "name": "config", + "properties": { + "enabled": true + } + } + }, + "404": {}, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolSecurityAlert.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolSecurityAlert.json new file mode 100644 index 000000000000..857336de328f --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolSecurityAlert.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-6852", + "workspaceName": "securityalert-2080", + "sqlPoolName": "testdb", + "securityAlertPolicyName": "default", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-6852/providers/Microsoft.Synapse/workspaces/securityalert-2080/sqlPools/testdb", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies", + "properties": { + "state": "Enabled", + "emailAccountAdmins": true, + "emailAddresses": [ + "test@microsoft.com", + "user@microsoft.com" + ], + "disabledAlerts": [ + "Usage_Anomaly" + ], + "retentionDays": 0, + "storageAccountAccessKey": "", + "creationTime": "2018-10-08T00:00:00Z" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolTransparentDataEncryption.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolTransparentDataEncryption.json new file mode 100644 index 000000000000..5336944a68da --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolTransparentDataEncryption.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-6852", + "workspaceName": "sqlcrudtest-2080", + "sqlPoolName": "sqlcrudtest-9187", + "transparentDataEncryptionName": "current", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "name": "current", + "location": "North Europe", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/transparentDataEncryption/current", + "type": "Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption", + "properties": { + "status": "Enabled" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolTransparentDataEncryptionList.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolTransparentDataEncryptionList.json new file mode 100644 index 000000000000..aa60c62e42af --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolTransparentDataEncryptionList.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-6852", + "workspaceName": "sqlcrudtest-2080", + "sqlPoolName": "sqlcrudtest-9187", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "current", + "location": "North Europe", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/transparentDataEncryption/current", + "type": "Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption", + "properties": { + "status": "Enabled" + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolUserActivity.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolUserActivity.json new file mode 100644 index 000000000000..83a2645c5d75 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolUserActivity.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "workspaceName": "testsvr", + "sqlPoolName": "testdb", + "api-version": "2021-05-01", + "dataWarehouseUserActivityName": "current" + }, + "responses": { + "200": { + "body": { + "properties": { + "activeQueriesCount": 0 + }, + "id": "subscriptions/326affc3-21f4-4471-a545-e37430b70113/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Synapse/workspaces/testsvr/sqlPools/dwdb01/dataWarehouseUserActivities/current", + "name": "current", + "type": "Microsoft.Synapse/workspaces/sqlPools/dataWarehouseUserActivities" + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolVulnerabilityAssessment.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolVulnerabilityAssessment.json new file mode 100644 index 000000000000..e30f4acef82c --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolVulnerabilityAssessment.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "vulnerabilityaseessmenttest-4799", + "workspaceName": "vulnerabilityaseessmenttest-6440", + "sqlPoolName": "testdb", + "vulnerabilityAssessmentName": "default", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityaseessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments", + "properties": { + "recurringScans": { + "isEnabled": true, + "emailSubscriptionAdmins": true, + "emails": [ + "email1@mail.com", + "email2@mail.com" + ] + } + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolWorkloadGroup.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolWorkloadGroup.json new file mode 100644 index 000000000000..e6007eb5ab82 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolWorkloadGroup.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-6852", + "workspaceName": "sqlcrudtest-2080", + "sqlPoolName": "sqlcrudtest-9187", + "workloadGroupName": "smallrc", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "minResourcePercent": 0, + "maxResourcePercent": 100, + "minResourcePercentPerRequest": 3.0, + "maxResourcePercentPerRequest": 3.0, + "importance": "normal", + "queryExecutionTimeout": 0 + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/workloadGroups/smallrc", + "name": "smallrc", + "type": "Microsoft.Synapse/workspaces/sqlPools/workloadGroups" + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolWorkloadGroupList.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolWorkloadGroupList.json new file mode 100644 index 000000000000..eafb4d5e33c7 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolWorkloadGroupList.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-6852", + "workspaceName": "sqlcrudtest-2080", + "sqlPoolName": "sqlcrudtest-9187", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "minResourcePercent": 0, + "maxResourcePercent": 100, + "minResourcePercentPerRequest": 5, + "maxResourcePercentPerRequest": 5, + "importance": "normal", + "queryExecutionTimeout": 0 + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/workloadGroups/smallrc", + "name": "smallrc", + "type": "Microsoft.Synapse/workspaces/sqlPools/workloadGroups" + }, + { + "properties": { + "minResourcePercent": 0, + "maxResourcePercent": 100, + "minResourcePercentPerRequest": 10, + "maxResourcePercentPerRequest": 10, + "importance": "normal", + "queryExecutionTimeout": 0 + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/workloadGroups/mediumrc", + "name": "mediumrc", + "type": "Microsoft.Synapse/workspaces/sqlPools/workloadGroups" + }, + { + "properties": { + "minResourcePercent": 0, + "maxResourcePercent": 100, + "minResourcePercentPerRequest": 20, + "maxResourcePercentPerRequest": 20, + "importance": "high", + "queryExecutionTimeout": 0 + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/workloadGroups/largerc", + "name": "largerc", + "type": "Microsoft.Synapse/workspaces/sqlPools/workloadGroups" + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolWorkloadGroupWorkloadClassifier.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolWorkloadGroupWorkloadClassifier.json new file mode 100644 index 000000000000..e58d7902df5b --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolWorkloadGroupWorkloadClassifier.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-6852", + "workspaceName": "sqlcrudtest-2080", + "sqlPoolName": "sqlcrudtest-9187", + "workloadGroupName": "wlm_workloadgroup", + "workloadClassifierName": "wlm_classifier", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "memberName": "dbo", + "label": "test_label", + "context": "test_context", + "startTime": "12:00", + "endTime": "14:00", + "importance": "high" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/workloadGroups/wlm_workloadgroup/workloadClassifiers/wlm_classifier", + "name": "wlm_classifier", + "type": "Microsoft.Synapse/workspaces/sqlPools/workloadGroups/workloadClassifiers" + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolWorkloadGroupWorkloadClassifierList.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolWorkloadGroupWorkloadClassifierList.json new file mode 100644 index 000000000000..37bad1c7fbb1 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetSqlPoolWorkloadGroupWorkloadClassifierList.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-6852", + "workspaceName": "sqlcrudtest-2080", + "sqlPoolName": "sqlcrudtest-9187", + "workloadGroupName": "wlm_workloadgroup", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "memberName": "dbo", + "label": "", + "context": "", + "startTime": "", + "endTime": "", + "importance": "high" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/workloadGroups/wlm_workloadgroup/workloadClassifiers/classifier3", + "name": "classifier3", + "type": "Microsoft.Synapse/workspaces/sqlPools/workloadGroups/workloadClassifiers" + }, + { + "properties": { + "memberName": "dbo", + "label": "test_label", + "context": "test_context", + "startTime": "12:00", + "endTime": "14:00", + "importance": "high" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/workloadGroups/wlm_workloadgroup/workloadClassifiers/classifier1", + "name": "classifier1", + "type": "Microsoft.Synapse/workspaces/sqlPools/workloadGroups/workloadClassifiers" + }, + { + "properties": { + "memberName": "dbo", + "label": "", + "context": "", + "startTime": "11:00", + "endTime": "17:00", + "importance": "high" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187/workloadGroups/wlm_workloadgroup/workloadClassifiers/classifier2", + "name": "classifier2", + "type": "Microsoft.Synapse/workspaces/sqlPools/workloadGroups/workloadClassifiers" + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetWorkspace.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetWorkspace.json new file mode 100644 index 000000000000..6438b0e86425 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetWorkspace.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1", + "name": "workspace1", + "type": "Microsoft.Synapse/workspaces", + "location": "East US", + "properties": { + "defaultDataLakeStorage": { + "accountUrl": "https://accountname.dfs.core.windows.net", + "filesystem": "default" + }, + "connectivityEndpoints": { + "dev": "workspace1.dev.projectarcadia.net", + "sql": "workspace1.sql.projectarcadia.net" + }, + "managedVirtualNetworkSettings": { + "preventDataExfiltration": false, + "linkedAccessCheckOnTargetResource": false, + "allowedAadTenantIdsForLinking": [ + "740239CE-A25B-485B-86A0-262F29F6EBDB" + ] + }, + "purviewConfiguration": { + "purviewResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.ProjectPurview/accounts/accountname1" + }, + "sqlAdministratorLogin": "login", + "managedResourceGroupName": "resourceGroup2", + "workspaceRepositoryConfiguration": { + "type": "FactoryGitHubConfiguration", + "hostName": "", + "accountName": "myGithubAccount", + "projectName": "myProject", + "repositoryName": "myRepository", + "collaborationBranch": "master", + "rootFolder": "/" + }, + "provisioningState": "Succeeded", + "privateEndpointConnections": [ + { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/privateEndpointConnections/ExamplePrivateEndpointConnection", + "name": "sql", + "type": "Microsoft.Synapse/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Network/privateEndpoints/ExamplePrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ], + "workspaceUID": "999b999q-b888-4b44-bacd-2c222cc2222d", + "cspWorkspaceAdminProperties": { + "initialWorkspaceAdminObjectId": "6c20646f-8050-49ec-b3b1-80a0e58e454d" + }, + "extraProperties": { + "IsScopeEnabled": "false", + "WorkspaceType": "Normal" + } + }, + "tags": { + "key": "value" + } + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetWorkspaceAadAdmin.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetWorkspaceAadAdmin.json new file mode 100644 index 000000000000..6144fde7100f --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetWorkspaceAadAdmin.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1/administrators/activeDirectory", + "name": "activeDirectory", + "properties": { + "administratorType": "ActiveDirectory", + "login": "bob@contoso.com", + "sid": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c", + "tenantId": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetWorkspaceManagedSqlExtendedServerBlobAuditingSettings.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetWorkspaceManagedSqlExtendedServerBlobAuditingSettings.json new file mode 100644 index 000000000000..8b060fa6adc8 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetWorkspaceManagedSqlExtendedServerBlobAuditingSettings.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "wsg-7398", + "workspaceName": "testWorkspace", + "blobAuditingPolicyName": "default", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/extendedAuditingSettings/default", + "name": "default", + "type": "Microsoft.Synapse/workspaces/extendedAuditingSettings", + "properties": { + "state": "Disabled", + "storageEndpoint": "", + "retentionDays": 0, + "auditActionsAndGroups": [], + "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", + "isStorageSecondaryKeyInUse": false, + "predicateExpression": "object_name = 'SensitiveData'", + "isAzureMonitorTargetEnabled": false + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetWorkspaceManagedSqlServerBlobAuditingSettings.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetWorkspaceManagedSqlServerBlobAuditingSettings.json new file mode 100644 index 000000000000..f5cf265acb6d --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetWorkspaceManagedSqlServerBlobAuditingSettings.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "wsg-7398", + "workspaceName": "testWorkspace", + "blobAuditingPolicyName": "default", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/auditingSettings/default", + "name": "default", + "type": "Microsoft.Synapse/workspaces/auditingSettings", + "properties": { + "state": "Disabled", + "storageEndpoint": "", + "retentionDays": 0, + "auditActionsAndGroups": [], + "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", + "isStorageSecondaryKeyInUse": false, + "isAzureMonitorTargetEnabled": false + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetWorkspaceManagedSqlServerEncryptionProtector.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetWorkspaceManagedSqlServerEncryptionProtector.json new file mode 100644 index 000000000000..ff1e2cae25e8 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetWorkspaceManagedSqlServerEncryptionProtector.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "wsg-7398", + "workspaceName": "testWorkspace", + "encryptionProtectorName": "current", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/encryptionProtector/current", + "name": "current", + "type": "Microsoft.Synapse/workspaces/encryptionProtector", + "location": "Japan East", + "kind": "azurekeyvault", + "properties": { + "serverKeyName": "someVault_someKey_01234567890123456789012345678901", + "serverKeyType": "AzureKeyVault", + "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetWorkspaceManagedSqlServerEncryptionProtectorList.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetWorkspaceManagedSqlServerEncryptionProtectorList.json new file mode 100644 index 000000000000..2e9d491bd416 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetWorkspaceManagedSqlServerEncryptionProtectorList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "wsg-7398", + "workspaceName": "testWorkspace", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/encryptionProtector/current", + "name": "current", + "type": "Microsoft.Synapse/workspaces/encryptionProtector", + "location": "Japan East", + "kind": "azurekeyvault", + "properties": { + "serverKeyName": "someVault_someKey_01234567890123456789012345678901", + "serverKeyType": "AzureKeyVault", + "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901" + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetWorkspaceManagedSqlServerRecoverableSqlPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetWorkspaceManagedSqlServerRecoverableSqlPool.json new file mode 100644 index 000000000000..93754a43ce5a --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetWorkspaceManagedSqlServerRecoverableSqlPool.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "wsg-7398", + "workspaceName": "testWorkspace", + "sqlPoolName": "recoverableSqlpools-1235", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/recoverableSqlpools/recoverableSqlpools-1235", + "name": "recoverableSqlpools-1235", + "type": "Microsoft.Synapse/workspaces/recoverableSqlpools", + "properties": { + "edition": "Standard", + "serviceLevelObjective": "S0", + "lastAvailableBackupDate": "2017-05-26T01:06:29.78Z", + "elasticPoolName": null + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetWorkspaceManagedSqlServerSecurityAlertPolicy.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetWorkspaceManagedSqlServerSecurityAlertPolicy.json new file mode 100644 index 000000000000..577b3d648ebc --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetWorkspaceManagedSqlServerSecurityAlertPolicy.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "wsg-7398", + "workspaceName": "testWorkspace", + "securityAlertPolicyName": "Default", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/securityAlertPolicies/Default", + "name": "Default", + "type": "Microsoft.Synapse/workspaces/securityAlertPolicies", + "properties": { + "state": "Disabled", + "emailAccountAdmins": true, + "emailAddresses": [ + "test@microsoft.com;user@microsoft.com" + ], + "disabledAlerts": [ + "Access_Anomaly" + ], + "creationTime": "2020-10-23T04:52:49.52Z", + "retentionDays": 0, + "storageAccountAccessKey": "", + "storageEndpoint": "https://mystorage.blob.core.windows.net" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetWorkspaceManagedSqlServerVulnerabilityAssessment.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetWorkspaceManagedSqlServerVulnerabilityAssessment.json new file mode 100644 index 000000000000..d24f20bc8f77 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/GetWorkspaceManagedSqlServerVulnerabilityAssessment.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "wsg-7398", + "workspaceName": "testWorkspace", + "vulnerabilityAssessmentName": "default", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/vulnerabilityAssessments/default", + "name": "default", + "type": "Microsoft.Synapse/workspaces/vulnerabilityAssessments", + "properties": { + "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", + "recurringScans": { + "isEnabled": true, + "emailSubscriptionAdmins": true, + "emails": [ + "email1@mail.com", + "email2@mail.com" + ] + } + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimeMonitoringData_List.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimeMonitoringData_List.json new file mode 100644 index 000000000000..d2fc2bf0c1ac --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimeMonitoringData_List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "workspaceName": "exampleWorkspace", + "integrationRuntimeName": "exampleIntegrationRuntime", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Thu, 14 Jun 2018 15:27:44 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14999", + "x-ms-request-id": "39277952-edbe-4336-ae94-f6f42b50b5f7", + "x-ms-correlation-request-id": "39277952-edbe-4336-ae94-f6f42b50b5f7" + }, + "body": { + "name": "exampleIntegrationRuntime", + "nodes": [ + { + "nodeName": "Node_1", + "availableMemoryInMB": 16740, + "cpuUtilization": 15, + "concurrentJobsLimit": 28, + "concurrentJobsRunning": 0, + "sentBytes": 2.6474916934967041, + "receivedBytes": 6.7314233779907227 + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimeNodes_Delete.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimeNodes_Delete.json new file mode 100644 index 000000000000..39965d5ca525 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimeNodes_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "workspaceName": "exampleWorkspace", + "integrationRuntimeName": "exampleIntegrationRuntime", + "nodeName": "Node_1", + "api-version": "2021-05-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimeNodes_Get.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimeNodes_Get.json new file mode 100644 index 000000000000..32e6a27c474f --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimeNodes_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "workspaceName": "exampleWorkspace", + "integrationRuntimeName": "exampleIntegrationRuntime", + "nodeName": "Node_1", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Fri, 17 Aug 2018 06:31:04 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14999", + "x-ms-request-id": "1c8b259a-c6e6-48aa-8121-05b3b3b782aa", + "x-ms-correlation-request-id": "1c8b259a-c6e6-48aa-8121-05b3b3b782aa" + }, + "body": { + "nodeName": "Node_1", + "machineName": "YANZHANG-DT", + "hostServiceUri": "https://yanzhang-dt.fareast.corp.microsoft.com:8050/HostServiceRemote.svc/", + "status": "Online", + "capabilities": { + "serviceBusConnected": "True", + "httpsPortEnabled": "True", + "credentialInSync": "True", + "connectedToResourceManager": "True", + "nodeEnabled": "True" + }, + "versionStatus": "UpToDate", + "version": "3.8.6743.6", + "registerTime": "2018-08-17T03:44:55.8012825Z", + "lastConnectTime": "2018-08-17T06:30:46.6262976Z", + "lastStartTime": "2018-08-17T03:45:30.8499851Z", + "lastUpdateResult": "None", + "isActiveDispatcher": true, + "maxConcurrentJobs": 20 + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimeNodes_GetIpAddress.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimeNodes_GetIpAddress.json new file mode 100644 index 000000000000..4f3690722ff4 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimeNodes_GetIpAddress.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "workspaceName": "exampleWorkspace", + "integrationRuntimeName": "exampleIntegrationRuntime", + "nodeName": "Node_1", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Thu, 14 Jun 2018 15:36:39 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1199", + "x-ms-request-id": "f01265af-9f38-44b8-81a1-b67f567ea728", + "x-ms-correlation-request-id": "f01265af-9f38-44b8-81a1-b67f567ea728" + }, + "body": { + "ipAddress": "**********" + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimeNodes_Update.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimeNodes_Update.json new file mode 100644 index 000000000000..542dd70bb73b --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimeNodes_Update.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "workspaceName": "exampleWorkspace", + "integrationRuntimeName": "exampleIntegrationRuntime", + "nodeName": "Node_1", + "updateIntegrationRuntimeNodeRequest": { + "concurrentJobsLimit": 2 + }, + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Thu, 14 Jun 2018 15:01:00 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1199", + "x-ms-request-id": "cf0d05fa-afbe-4fac-aa10-227885658c83", + "x-ms-correlation-request-id": "cf0d05fa-afbe-4fac-aa10-227885658c83" + }, + "body": { + "nodeName": "Node_1", + "machineName": "YANZHANG-DT", + "hostServiceUri": "https://yanzhang-dt.fareast.corp.microsoft.com:8050/HostServiceRemote.svc/", + "status": "Online", + "capabilities": { + "serviceBusConnected": "True", + "httpsPortEnabled": "True", + "credentialInSync": "True", + "connectedToResourceManager": "True", + "nodeEnabled": "True" + }, + "versionStatus": "UpToDate", + "version": "3.8.6730.2", + "registerTime": "2018-06-14T14:51:44.9237069Z", + "lastConnectTime": "2018-06-14T15:00:35.7544322Z", + "lastStartTime": "2018-06-14T14:52:59.8933313Z", + "lastUpdateResult": "None", + "isActiveDispatcher": true, + "concurrentJobsLimit": 2, + "maxConcurrentJobs": 56 + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimeObjectMetadata_List.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimeObjectMetadata_List.json new file mode 100644 index 000000000000..66d253dc303e --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimeObjectMetadata_List.json @@ -0,0 +1,432 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "workspaceName": "exampleWorkspace", + "integrationRuntimeName": "testactivityv2", + "getMetadataRequest": { + "metadataPath": "ssisFolders" + }, + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Mon, 03 Dec 2018 06:24:54 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1198", + "x-ms-request-id": "0cbc67c4-60e7-4d49-97d9-e4bc4f9851cd", + "x-ms-correlation-request-id": "0cbc67c4-60e7-4d49-97d9-e4bc4f9851cd" + }, + "body": { + "value": [ + { + "id": 1, + "name": "TestFolder", + "description": "" + }, + { + "id": 2, + "name": "EnvironmentFolder", + "description": "" + }, + { + "id": 3, + "name": "ActivityTest", + "description": "" + }, + { + "id": 4, + "name": "这是文件夹", + "description": "" + }, + { + "id": 5, + "name": "1" + }, + { + "id": 6, + "name": "2" + }, + { + "id": 7, + "name": "3" + }, + { + "id": 8, + "name": "4" + }, + { + "id": 9, + "name": "5" + }, + { + "id": 10, + "name": "6" + }, + { + "id": 11, + "name": "7" + }, + { + "id": 12, + "name": "8" + }, + { + "id": 13, + "name": "9" + }, + { + "id": 14, + "name": "10" + }, + { + "id": 15, + "name": "11" + }, + { + "id": 16, + "name": "12" + }, + { + "id": 17, + "name": "13" + }, + { + "id": 18, + "name": "14" + }, + { + "id": 19, + "name": "15" + }, + { + "id": 20, + "name": "16" + }, + { + "id": 21, + "name": "17" + }, + { + "id": 22, + "name": "18" + }, + { + "id": 23, + "name": "19" + }, + { + "id": 24, + "name": "20" + }, + { + "id": 25, + "name": "21" + }, + { + "id": 26, + "name": "22" + }, + { + "id": 27, + "name": "23" + }, + { + "id": 28, + "name": "24" + }, + { + "id": 29, + "name": "25" + }, + { + "id": 30, + "name": "26" + }, + { + "id": 31, + "name": "27" + }, + { + "id": 32, + "name": "28" + }, + { + "id": 33, + "name": "29" + }, + { + "id": 34, + "name": "30" + }, + { + "id": 35, + "name": "31" + }, + { + "id": 36, + "name": "32" + }, + { + "id": 37, + "name": "33" + }, + { + "id": 38, + "name": "34" + }, + { + "id": 39, + "name": "35" + }, + { + "id": 40, + "name": "36" + }, + { + "id": 41, + "name": "37" + }, + { + "id": 42, + "name": "38" + }, + { + "id": 43, + "name": "39" + }, + { + "id": 44, + "name": "40" + }, + { + "id": 45, + "name": "41" + }, + { + "id": 46, + "name": "42" + }, + { + "id": 47, + "name": "43" + }, + { + "id": 48, + "name": "44" + }, + { + "id": 49, + "name": "45" + }, + { + "id": 50, + "name": "46" + }, + { + "id": 51, + "name": "47" + }, + { + "id": 52, + "name": "48" + }, + { + "id": 53, + "name": "49" + }, + { + "id": 54, + "name": "50" + }, + { + "id": 55, + "name": "51" + }, + { + "id": 56, + "name": "52" + }, + { + "id": 57, + "name": "53" + }, + { + "id": 58, + "name": "54" + }, + { + "id": 59, + "name": "55" + }, + { + "id": 60, + "name": "56" + }, + { + "id": 61, + "name": "57" + }, + { + "id": 62, + "name": "58" + }, + { + "id": 63, + "name": "59" + }, + { + "id": 64, + "name": "60" + }, + { + "id": 65, + "name": "61" + }, + { + "id": 66, + "name": "62" + }, + { + "id": 67, + "name": "63" + }, + { + "id": 68, + "name": "64" + }, + { + "id": 69, + "name": "65" + }, + { + "id": 70, + "name": "66" + }, + { + "id": 71, + "name": "67" + }, + { + "id": 72, + "name": "68" + }, + { + "id": 73, + "name": "69" + }, + { + "id": 74, + "name": "70" + }, + { + "id": 75, + "name": "71" + }, + { + "id": 76, + "name": "72" + }, + { + "id": 77, + "name": "73" + }, + { + "id": 78, + "name": "74" + }, + { + "id": 79, + "name": "75" + }, + { + "id": 80, + "name": "76" + }, + { + "id": 81, + "name": "77" + }, + { + "id": 82, + "name": "78" + }, + { + "id": 83, + "name": "79" + }, + { + "id": 84, + "name": "80" + }, + { + "id": 85, + "name": "81" + }, + { + "id": 86, + "name": "82" + }, + { + "id": 87, + "name": "83" + }, + { + "id": 88, + "name": "84" + }, + { + "id": 89, + "name": "85" + }, + { + "id": 90, + "name": "86" + }, + { + "id": 91, + "name": "87" + }, + { + "id": 92, + "name": "88" + }, + { + "id": 93, + "name": "89" + }, + { + "id": 94, + "name": "90" + }, + { + "id": 95, + "name": "91" + }, + { + "id": 96, + "name": "92" + }, + { + "id": 97, + "name": "93" + }, + { + "id": 98, + "name": "94" + }, + { + "id": 99, + "name": "95" + }, + { + "id": 100, + "name": "96" + } + ], + "nextLink": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/integrationRuntimes/testactivityv2/getObjectMetadata?api-version=2021-05-01&%24skipToken=https%3a%2f%2fwcu.frontend.clouddatahub.net%2fsubscriptions%2f12345678-1234-1234-1234-12345678abc%2fdatafactories%2f6C8E7C90-FD45-4010-8B7C-B5227D0F0CB7%2fintegrationruntimes%2fTESTACTIVITYV2%2fgetSsisObjectMetadata%3f%24skipToken%3dc3Npc0ZvbGRlcnNAQDIwMTgtMTEtMjlUMDM6NTk6MzIuMDQ1Mzc1MiswMDowMEBAZm9sZGVyQEAwMDAwMDAwMDAwMDAwMDAwMTAx0%26api-version%3d1.0" + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimeObjectMetadata_Refresh.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimeObjectMetadata_Refresh.json new file mode 100644 index 000000000000..d1da3443f14d --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimeObjectMetadata_Refresh.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "workspaceName": "exampleWorkspace", + "integrationRuntimeName": "testactivityv2", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Mon, 03 Dec 2018 06:24:53 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "11999", + "x-ms-request-id": "20708242-215c-4101-9437-44590b27cdbf", + "x-ms-correlation-request-id": "20708242-215c-4101-9437-44590b27cdbf" + }, + "body": { + "status": "Succeeded", + "name": "ca63c855b72d44959653ffcc6eb0b96c", + "properties": null, + "error": null + } + }, + "202": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_Create.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_Create.json new file mode 100644 index 000000000000..b3b6c367ead5 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_Create.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "workspaceName": "exampleWorkspace", + "integrationRuntimeName": "exampleIntegrationRuntime", + "ifMatch": null, + "integrationRuntime": { + "properties": { + "type": "SelfHosted", + "description": "A selfhosted integration runtime" + } + }, + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Jun 2018 22:20:47 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1197", + "x-ms-request-id": "125c07fa-e39a-4541-885f-5019631a5ecd", + "x-ms-correlation-request-id": "125c07fa-e39a-4541-885f-5019631a5ecd" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/integrationruntimes/exampleIntegrationRuntime", + "name": "exampleIntegrationRuntime", + "type": "Microsoft.Synapse/workspaces/integrationruntimes", + "properties": { + "type": "SelfHosted", + "description": "A selfhosted integration runtime" + }, + "etag": "000046c4-0000-0000-0000-5b2198bf0000" + } + }, + "202": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_Delete.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_Delete.json new file mode 100644 index 000000000000..cef9cd67a217 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "workspaceName": "exampleWorkspace", + "integrationRuntimeName": "exampleIntegrationRuntime", + "api-version": "2021-05-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {}, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_DisableInteractiveQuery.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_DisableInteractiveQuery.json new file mode 100644 index 000000000000..d784bfc51bc2 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_DisableInteractiveQuery.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "workspaceName": "exampleWorkspace", + "integrationRuntimeName": "exampleManagedIntegrationRuntime", + "api-version": "2021-05-01" + }, + "responses": { + "200": {}, + "202": {}, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_EnableInteractiveQuery.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_EnableInteractiveQuery.json new file mode 100644 index 000000000000..d784bfc51bc2 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_EnableInteractiveQuery.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "workspaceName": "exampleWorkspace", + "integrationRuntimeName": "exampleManagedIntegrationRuntime", + "api-version": "2021-05-01" + }, + "responses": { + "200": {}, + "202": {}, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_Get.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_Get.json new file mode 100644 index 000000000000..9cdeafffbd3e --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_Get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "workspaceName": "exampleWorkspace", + "integrationRuntimeName": "exampleIntegrationRuntime", + "ifNoneMatch": "15003c4f-0000-0200-0000-5cbe090b0000", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Mon, 22 Apr 2019 18:33:47 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "11997", + "x-ms-request-id": "ad824326-e577-4a47-a092-2e621c4d59d9", + "x-ms-correlation-request-id": "ad824326-e577-4a47-a092-2e621c4d59d9" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/integrationruntimes/exampleIntegrationRuntime", + "name": "exampleIntegrationRuntime", + "type": "Microsoft.Synapse/workspaces/integrationruntimes", + "properties": { + "type": "SelfHosted", + "description": "A selfhosted integration runtime" + }, + "etag": "15003c4f-0000-0200-0000-5cbe090b0000" + } + }, + "304": {}, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_GetConnectionInfo.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_GetConnectionInfo.json new file mode 100644 index 000000000000..1fbef60a3217 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_GetConnectionInfo.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "workspaceName": "exampleWorkspace", + "integrationRuntimeName": "exampleIntegrationRuntime", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Thu, 14 Jun 2018 14:53:21 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14998", + "x-ms-request-id": "05774db5-e79b-4224-9097-46714b92fbd8", + "x-ms-correlation-request-id": "05774db5-e79b-4224-9097-46714b92fbd8" + }, + "body": { + "version": "3.8.6730.2", + "publicKey": "**********", + "serviceToken": "**********", + "identityCertThumbprint": "**********", + "hostServiceUri": "https://yanzhang-dt.fareast.corp.microsoft.com:8050/HostServiceRemote.svc/", + "isIdentityCertExprired": false + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_GetStatus.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_GetStatus.json new file mode 100644 index 000000000000..cfdcab313885 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_GetStatus.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "workspaceName": "exampleWorkspace", + "integrationRuntimeName": "exampleIntegrationRuntime", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Thu, 14 Jun 2018 14:53:22 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14997", + "x-ms-request-id": "19efe790-074f-4241-ae94-0422935d0f46", + "x-ms-correlation-request-id": "19efe790-074f-4241-ae94-0422935d0f46" + }, + "body": { + "name": "exampleIntegrationRuntime", + "properties": { + "state": "Online", + "type": "SelfHosted", + "typeProperties": { + "autoUpdate": "Off", + "taskQueueId": "1a6296ab-423c-4346-9bcc-85a78c2c0582", + "version": "3.8.6730.2", + "nodes": [ + { + "nodeName": "Node_1", + "machineName": "YANZHANG-DT", + "hostServiceUri": "https://yanzhang-dt.fareast.corp.microsoft.com:8050/HostServiceRemote.svc/", + "status": "Online", + "capabilities": { + "serviceBusConnected": "True", + "httpsPortEnabled": "True", + "credentialInSync": "True", + "connectedToResourceManager": "True", + "nodeEnabled": "True" + }, + "versionStatus": "UpToDate", + "version": "3.8.6730.2", + "registerTime": "2018-06-14T14:51:44.9237069Z", + "lastConnectTime": "2018-06-14T14:52:59.8933313Z", + "lastStartTime": "2018-06-14T14:52:59.8933313Z", + "lastUpdateResult": "None", + "isActiveDispatcher": true, + "maxConcurrentJobs": 56 + } + ], + "updateDelayOffset": "PT3H", + "localTimeZoneOffset": "PT8H", + "serviceUrls": [ + "wu.frontend.int.clouddatahub-int.net", + "*.servicebus.windows.net" + ], + "versionStatus": "UpToDate", + "capabilities": { + "serviceBusConnected": "True", + "httpsPortEnabled": "True", + "credentialInSync": "True", + "connectedToResourceManager": "True", + "nodeEnabled": "True" + }, + "latestVersion": "3.7.6711.1", + "createTime": "2018-06-14T09:17:45.1839685Z" + } + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_ListAuthKeys.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_ListAuthKeys.json new file mode 100644 index 000000000000..2bdc92a85b35 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_ListAuthKeys.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "workspaceName": "exampleWorkspace", + "integrationRuntimeName": "exampleIntegrationRuntime", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Thu, 14 Jun 2018 14:51:00 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14999", + "x-ms-request-id": "2ea25426-9d1d-49f3-88b6-fb853eb02cb9", + "x-ms-correlation-request-id": "2ea25426-9d1d-49f3-88b6-fb853eb02cb9" + }, + "body": { + "authKey1": "**********", + "authKey2": "**********" + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_ListByWorkspace.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_ListByWorkspace.json new file mode 100644 index 000000000000..dc7aa31f7459 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_ListByWorkspace.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "workspaceName": "exampleWorkspace", + "ifNoneMatch": null, + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Jun 2018 21:33:05 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14909", + "x-ms-request-id": "f632df92-1140-4e19-9e19-0b1c8cbe393b", + "x-ms-correlation-request-id": "f632df92-1140-4e19-9e19-0b1c8cbe393b" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/integrationruntimes/exampleIntegrationRuntime", + "name": "exampleIntegrationRuntime", + "type": "Microsoft.Synapse/workspaces/integrationruntimes", + "properties": { + "type": "SelfHosted", + "description": "A selfhosted integration runtime" + }, + "etag": "0400f1a1-0000-0000-0000-5b2188640000" + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints.json new file mode 100644 index 000000000000..2a923c2872b7 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "5f4ab77d-a0c2-4fa5-8abf-fe350680e074", + "resourceGroupName": "exampleResourceGroup", + "workspaceName": "exampleWorkspace", + "integrationRuntimeName": "exampleIntegrationRuntime", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Tue, 06 Jul 2021 04:28:10 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-request-id": "fd8e4223-7e9c-4f32-893f-06c14a8081be", + "x-ms-correlation-request-id": "1dabf122-e061-4703-ae9e-9edeeef40ee6" + }, + "body": { + "value": [ + { + "category": "Azure Data Factory (Management)", + "endpoints": [ + { + "domainName": "wu.frontend.int.clouddatahub-int.net", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Azure Storage (Management)", + "endpoints": [ + { + "domainName": "*.blob.core.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "domainName": "*.table.core.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Event Hub (Logging)", + "endpoints": [ + { + "domainName": "*.servicebus.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Microsoft Logging service (Internal Use)", + "endpoints": [ + { + "domainName": "gcs.prod.monitoring.core.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "domainName": "prod.warmpath.msftcloudes.com", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "domainName": "azurewatsonanalysis-prod.core.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_RegenerateAuthKey.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_RegenerateAuthKey.json new file mode 100644 index 000000000000..cbb6d7cdc9ef --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_RegenerateAuthKey.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "workspaceName": "exampleWorkspace", + "integrationRuntimeName": "exampleIntegrationRuntime", + "regenerateKeyParameters": { + "keyName": "authKey2" + }, + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Thu, 14 Jun 2018 14:50:41 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1198", + "x-ms-request-id": "25af6d34-52c6-40a4-a882-16052af85c99", + "x-ms-correlation-request-id": "25af6d34-52c6-40a4-a882-16052af85c99" + }, + "body": { + "authKey2": "**********" + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_Start.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_Start.json new file mode 100644 index 000000000000..9ea0437e4a41 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_Start.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "workspaceName": "exampleWorkspace", + "integrationRuntimeName": "exampleManagedIntegrationRuntime", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Jun 2018 21:33:00 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14912", + "x-ms-request-id": "2af47f9f-5625-4b01-a3a5-bccb576a4677", + "x-ms-correlation-request-id": "2af47f9f-5625-4b01-a3a5-bccb576a4677" + }, + "body": { + "name": "exampleManagedIntegrationRuntime", + "properties": { + "dataFactoryName": "exampleWorkspaceName", + "type": "Managed", + "state": "Started", + "typeProperties": { + "nodes": [], + "otherErrors": [], + "createTime": "2018-06-13T21:11:01.8695494Z" + } + } + } + }, + "202": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_Stop.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_Stop.json new file mode 100644 index 000000000000..d784bfc51bc2 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_Stop.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "workspaceName": "exampleWorkspace", + "integrationRuntimeName": "exampleManagedIntegrationRuntime", + "api-version": "2021-05-01" + }, + "responses": { + "200": {}, + "202": {}, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_SyncCredentials.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_SyncCredentials.json new file mode 100644 index 000000000000..a2c8389315fc --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_SyncCredentials.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "workspaceName": "exampleWorkspace", + "integrationRuntimeName": "exampleIntegrationRuntime", + "api-version": "2021-05-01" + }, + "responses": { + "200": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_Update.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_Update.json new file mode 100644 index 000000000000..adff38873552 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_Update.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "workspaceName": "exampleWorkspace", + "integrationRuntimeName": "exampleIntegrationRuntime", + "updateIntegrationRuntimeRequest": { + "autoUpdate": "Off", + "updateDelayOffset": "\"PT3H\"" + }, + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Jun 2018 21:33:04 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "eb1c35f8-4b37-4d08-b5dd-d6a0ad8b182d", + "x-ms-correlation-request-id": "eb1c35f8-4b37-4d08-b5dd-d6a0ad8b182d" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/integrationruntimes/exampleIntegrationRuntime", + "name": "exampleIntegrationRuntime", + "type": "Microsoft.Synapse/workspaces/integrationruntimes", + "properties": { + "type": "SelfHosted", + "description": "A selfhosted integration runtime" + }, + "etag": "0400f1a1-0000-0000-0000-5b2188640000" + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_Upgrade.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_Upgrade.json new file mode 100644 index 000000000000..a2c8389315fc --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/IntegrationRuntimes_Upgrade.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "workspaceName": "exampleWorkspace", + "integrationRuntimeName": "exampleIntegrationRuntime", + "api-version": "2021-05-01" + }, + "responses": { + "200": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/Libraries_ListByWorkspace.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/Libraries_ListByWorkspace.json new file mode 100644 index 000000000000..a2be06a41e01 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/Libraries_ListByWorkspace.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "workspaceName": "exampleWorkspace", + "ifNoneMatch": null, + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 23 Oct 2020 21:33:05 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14909", + "x-ms-request-id": "f632df92-1140-4e19-9e19-0b1c8cbe393b", + "x-ms-correlation-request-id": "f632df92-1140-4e19-9e19-0b1c8cbe393b" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspace/libraries/exampleLibraryName1.jar", + "name": "exampleLibraryName1.jar", + "type": "Microsoft.Synapse/workspaces/libraries", + "properties": { + "name": "exampleLibraryName1.jar", + "path": "exampleWorkspace/libraries/exampleLibraryName1.jar", + "containerName": "exampleContainer", + "type": "jar", + "uploadedTimestamp": "2020-10-23T07:59:29.1573546+00:00", + "provisioningStatus": "Succeeded", + "creatorId": "2222222e-222d-222f-2222-22a2f222d2f2" + }, + "etag": "1500474f-0000-0200-0000-5cbe090d0000" + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspace/libraries/exampleLibraryName2.jar", + "name": "exampleLibraryName2.jar", + "type": "Microsoft.Synapse/workspaces/libraries", + "properties": { + "name": "exampleLibraryName2.jar", + "path": "exampleWorkspace/libraries/exampleLibraryName2.jar", + "containerName": "exampleContainer", + "type": "jar", + "uploadedTimestamp": "2020-10-23T07:59:29.1573546+00:00", + "provisioningStatus": "Succeeded", + "creatorId": "2222222e-222d-222f-2222-22a2f222d2f2" + }, + "etag": "1500474f-0000-0200-0000-5cbe090d0000" + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/Library_Get.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/Library_Get.json new file mode 100644 index 000000000000..10364e8b7a3f --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/Library_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "workspaceName": "exampleWorkspace", + "ifNoneMatch": null, + "libraryName": "exampleLibraryName.jar", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 23 Oct 2020 21:33:05 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14909", + "x-ms-request-id": "f632df92-1140-4e19-9e19-0b1c8cbe393b", + "x-ms-correlation-request-id": "f632df92-1140-4e19-9e19-0b1c8cbe393b" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspace/libraries/exampleLibraryName.jar", + "name": "exampleLibraryName.jar", + "type": "Microsoft.Synapse/workspaces/libraries", + "properties": { + "name": "exampleLibraryName.jar", + "path": "exampleWorkspace/libraries/exampleLibraryName.jar", + "containerName": "exampleContainer", + "type": "jar", + "uploadedTimestamp": "2020-10-23T07:59:29.1573546+00:00", + "provisioningStatus": "Succeeded", + "creatorId": "2222222e-222d-222f-2222-22a2f222d2f2" + }, + "etag": "1500474f-0000-0200-0000-5cbe090d0000" + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListBigDataPoolsInWorkspace.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListBigDataPoolsInWorkspace.json new file mode 100644 index 000000000000..0872fe3e488e --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListBigDataPoolsInWorkspace.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/bigDataPools/ExamplePool", + "type": "Microsoft.Synapse/workspaces/bigDataPools", + "location": "West US 2", + "name": "ExamplePool", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "sparkVersion": "2.4", + "nodeCount": 4, + "nodeSize": "Medium", + "nodeSizeFamily": "MemoryOptimized", + "autoScale": { + "enabled": true, + "minNodeCount": 3, + "maxNodeCount": 50 + }, + "autoPause": { + "enabled": true, + "delayInMinutes": 15 + }, + "creationDate": "1970-01-01T00:00:00Z", + "sparkEventsFolder": "/events", + "libraryRequirements": { + "time": "1970-01-01T00:00:00Z", + "content": "", + "filename": "requirements.txt" + }, + "defaultSparkLogFolder": "/logs" + } + }, + { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/bigDataPools/ExamplePool2", + "type": "Microsoft.Synapse/workspaces/bigDataPools", + "location": "West US 2", + "name": "ExamplePool2", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "sparkVersion": "2.4", + "nodeCount": 4, + "nodeSize": "Medium", + "nodeSizeFamily": "MemoryOptimized", + "autoScale": { + "enabled": true, + "minNodeCount": 3, + "maxNodeCount": 50 + }, + "autoPause": { + "enabled": true, + "delayInMinutes": 15 + }, + "creationDate": "1970-01-01T00:00:00Z", + "sparkEventsFolder": "/events", + "libraryRequirements": { + "time": "1970-01-01T00:00:00Z", + "content": "", + "filename": "requirements.txt" + }, + "defaultSparkLogFolder": "/logs" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListIpFirewallRules.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListIpFirewallRules.json new file mode 100644 index 000000000000..2fab94a2ecb7 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListIpFirewallRules.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [], + "nextLink": "" + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListKeysInWorkspace.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListKeysInWorkspace.json new file mode 100644 index 000000000000..efc4f564b18f --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListKeysInWorkspace.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/key1", + "name": "key1", + "type": "Microsoft.Synapse/workspaces/keys", + "properties": { + "keyVaultUrl": "https://vault.azure.net/keys/somesecret1", + "isActiveCMK": false + } + }, + { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/key2", + "name": "key2", + "type": "Microsoft.Synapse/workspaces/keys", + "properties": { + "keyVaultUrl": "https://vault.azure.net/keys/somesecret2", + "isActiveCMK": true + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListPrivateEndpointConnections.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListPrivateEndpointConnections.json new file mode 100644 index 000000000000..6e5d1b32f166 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListPrivateEndpointConnections.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/privateEndpointConnections/ExamplePrivateEndpointConnection", + "name": "sql", + "type": "Microsoft.Synapse/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Network/privateEndpoints/ExamplePrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListPrivateLinkHubPrivateLinkResources.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListPrivateLinkHubPrivateLinkResources.json new file mode 100644 index 000000000000..8c07438f1a80 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListPrivateLinkHubPrivateLinkResources.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "privateLinkHubName": "ExamplePrivateLinkHub", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/privateLinkHubs/ExamplePrivateLinkHub/privateLinkResources/sql", + "name": "sql", + "type": "Microsoft.Synapse/privateLinkHubs/privateLinkResources", + "properties": { + "groupId": "sql", + "requiredMembers": [ + "sql" + ], + "requiredZoneNames": [ + "privatelink.sql.azuresynapse.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListPrivateLinkHubsInResourceGroup.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListPrivateLinkHubsInResourceGroup.json new file mode 100644 index 000000000000..107834ae7d9d --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListPrivateLinkHubsInResourceGroup.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup1", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/privateLinkHubs/privateLinkHub1", + "name": "privateLinkHub1", + "type": "Microsoft.Synapse/privateLinkHubs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": { + "key": "value" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/privateLinkHubs/privateLinkHub2", + "name": "privateLinkHub2", + "type": "Microsoft.Synapse/privateLinkHubs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": { + "key": "value" + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListPrivateLinkHubsInSubscription.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListPrivateLinkHubsInSubscription.json new file mode 100644 index 000000000000..78eb3a0fff5f --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListPrivateLinkHubsInSubscription.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/privateLinkHubs/privateLinkHub1", + "name": "privateLinkHub1", + "type": "Microsoft.Synapse/privateLinkHubs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": { + "key": "value" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/privateLinkHubs/privateLinkHub2", + "name": "privateLinkHub2", + "type": "Microsoft.Synapse/privateLinkHubs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": { + "key": "value" + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListPrivateLinkResources.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListPrivateLinkResources.json new file mode 100644 index 000000000000..5e12832488bc --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListPrivateLinkResources.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/privateLinkResources/sql", + "name": "sql", + "type": "Microsoft.Synapse/workspaces/privateLinkResources", + "properties": { + "groupId": "sql", + "requiredMembers": [ + "sql" + ], + "requiredZoneNames": [ + "privatelink.sql.azuresynapse.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolColumns.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolColumns.json new file mode 100644 index 000000000000..e302f884c4a5 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolColumns.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myRG", + "workspaceName": "serverName", + "sqlPoolName": "myDatabase", + "schemaName": "dbo", + "tableName": "table1", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/serverName/sqlPools/myDatabase/schemas/dbo/tables/table1/columns/col1", + "name": "col1", + "type": "Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns", + "properties": { + "columnType": "nvarchar" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/serverName/sqlPools/myDatabase/schemas/dbo/tables/table1/columns/col2", + "name": "col2", + "type": "Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns", + "properties": { + "columnType": "bit" + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolOperations.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolOperations.json new file mode 100644 index 000000000000..5347db4c4573 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolOperations.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-7398", + "workspaceName": "sqlcrudtest-4645", + "sqlPoolName": "testdb", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Synapse/workspaces/sqlcrudtest-4645/sqlPools/testdb/operations/11111111-1111-1111-1111-111111111111", + "name": "11111111-1111-1111-1111-111111111111", + "type": "Microsoft.Synapse/workspaces/sqlPools/operations", + "properties": { + "databaseName": "testdb", + "operation": "UpdateLogicalDatabase", + "operationFriendlyName": "ALTER DATABASE", + "percentComplete": 100, + "serverName": "sqlcrudtest-4645", + "startTime": "2017-06-01T09:10:08.10Z", + "state": "Succeeded", + "estimatedCompletionTime": "2017-06-01T13:10:10Z", + "description": "UpdateLogicalDatabase on 'testdb', target ServiceLevelObjective S3", + "isCancellable": false + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Synapse/workspaces/sqlcrudtest-4645/sqlPools/testdb/operations/55555555-5555-5555-5555-555555555555", + "name": "55555555-5555-5555-5555-555555555555", + "type": "Microsoft.Synapse/workspaces/sqlPools/operations", + "properties": { + "databaseName": "testdb", + "operation": "UpdateLogicalDatabase", + "operationFriendlyName": "ALTER DATABASE", + "percentComplete": 19, + "serverName": "sqlcrudtest-4645", + "startTime": "2017-06-01T10:10:08.10Z", + "state": "InProgress", + "estimatedCompletionTime": "2017-06-01T13:10:10Z", + "description": "UpdateLogicalDatabase on 'testdb', target ServiceLevelObjective S3", + "isCancellable": true + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolReplicationLinks.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolReplicationLinks.json new file mode 100644 index 000000000000..91b802225b32 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolReplicationLinks.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-4799", + "workspaceName": "sqlcrudtest-6440", + "sqlPoolName": "testdb", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Synapse/workspaces/sqlcrudtest-6440/sqlPools/testdb/replicationLinks/5b301b68-03f6-4b26-b0f4-73ebb8634238", + "name": "5b301b68-03f6-4b26-b0f4-73ebb8634238", + "type": "Microsoft.Synapse/workspaces/sqlPools/replicationLinks", + "location": "Japan East", + "properties": { + "partnerServer": "sqlcrudtest-5961", + "partnerDatabase": "testdb", + "partnerLocation": "Japan East", + "role": "Secondary", + "partnerRole": "Primary", + "replicationMode": "ASYNC", + "startTime": "2017-02-10T01:44:27.117Z", + "percentComplete": 100, + "replicationState": "CATCH_UP", + "isTerminationAllowed": true + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolRestorePoints.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolRestorePoints.json new file mode 100644 index 000000000000..cad43c3f62ad --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolRestorePoints.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "location": "japaneast", + "workspaceName": "testserver", + "sqlPoolName": "testDatabase", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Synapse/workspaces/testserver/sqlPools/testDatabase/restorePoints/131546477590000000", + "name": "131546477590000000", + "type": "Microsoft.Synapse/workspaces/sqlPools/restorePoints", + "location": "japaneast", + "properties": { + "restorePointType": "DISCRETE", + "restorePointCreationDate": "2017-03-10T08:00:00.000Z", + "restorePointLabel": "mylabel1" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Synapse/workspaces/testserver/sqlPools/testDatabase/restorePoints/131553636140000000", + "name": "131553636140000000", + "type": "Microsoft.Synapse/workspaces/sqlPools/restorePoints", + "location": "japaneast", + "properties": { + "restorePointType": "DISCRETE", + "restorePointCreationDate": "2017-11-17T03:40:14Z", + "restorePointLabel": "mylabel2" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Synapse/workspaces/testserver/sqlPools/testDatabase/restorePoints/131553619750000000", + "name": "131553619750000000", + "type": "Microsoft.Synapse/workspaces/sqlPools/restorePoints", + "location": "japaneast", + "properties": { + "restorePointType": "DISCRETE", + "restorePointCreationDate": "2017-11-17T03:12:55Z" + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolSchema.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolSchema.json new file mode 100644 index 000000000000..64ece4bbd661 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolSchema.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myRG", + "workspaceName": "serverName", + "sqlPoolName": "myDatabase", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/serverName/sqlPools/myDatabase/schemas/dbo", + "name": "dbo", + "type": "Microsoft.Synapse/workspaces/sqlPools/schemas" + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/serverName/sqlPools/myDatabase/schemas/schema2", + "name": "schema2", + "type": "Microsoft.Synapse/workspaces/sqlPools/schemas" + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolSensitivityLabelsWithSourceRecommended.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolSensitivityLabelsWithSourceRecommended.json new file mode 100644 index 000000000000..83c899e33a5c --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolSensitivityLabelsWithSourceRecommended.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myRG", + "workspaceName": "myServer", + "sqlPoolName": "myDatabase", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/myServer/sqlPools/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/recommended", + "name": "recommended", + "type": "Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels", + "properties": { + "informationType": "Financial", + "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646", + "labelId": "05e6eaa1-075a-4fb4-a732-a92215a2444a", + "labelName": "Sensitive" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/myServer/sqlPools/myDatabase/schemas/dbo/tables/myTable/columns/myColumn2/sensitivityLabels/recommended", + "name": "recommended", + "type": "Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels", + "properties": { + "informationType": "Email", + "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646", + "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff", + "labelName": "PII" + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolTables.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolTables.json new file mode 100644 index 000000000000..8284e229ea2e --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolTables.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myRG", + "workspaceName": "serverName", + "sqlPoolName": "myDatabase", + "schemaName": "dbo", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/serverName/sqlPools/myDatabase/schemas/dbo/tables/table1", + "name": "table1", + "type": "Microsoft.Synapse/workspaces/sqlPools/schemas/tables" + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/serverName/sqlPools/myDatabase/schemas/dbo/tables/table2", + "name": "table2", + "type": "Microsoft.Synapse/workspaces/sqlPools/schemas/tables" + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolVulnerabilityAssessmentScanRecords.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolVulnerabilityAssessmentScanRecords.json new file mode 100644 index 000000000000..65ebe768345e --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolVulnerabilityAssessmentScanRecords.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "vulnerabilityassessmenttest-4711", + "workspaceName": "vulnerabilityassessmenttest-6411", + "sqlPoolName": "testdb", + "vulnerabilityAssessmentName": "default", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityassessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityassessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default/scans/scan001", + "name": "scan001", + "type": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/scans", + "properties": { + "scanId": "scan001", + "triggerType": "OnDemand", + "state": "Passed", + "startTime": "2017-12-12T17:45:06Z", + "endTime": "2017-12-12T17:47:06Z", + "errors": [], + "numberOfFailedSecurityChecks": 9 + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityassessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityassessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default/scans/scan002", + "name": "scan002", + "type": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/scans", + "properties": { + "scanId": "scan002", + "triggerType": "Recurring", + "state": "Failed", + "startTime": "2017-12-12T17:45:06Z", + "endTime": "2017-12-12T17:47:06Z", + "errors": [], + "numberOfFailedSecurityChecks": 9 + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityassessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityassessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default/scans/scan003", + "name": "scan003", + "type": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/scans", + "properties": { + "scanId": "scan003", + "triggerType": "Recurring", + "state": "FailedToRun", + "startTime": "2017-12-12T17:45:06Z", + "endTime": "2017-12-12T17:47:06Z", + "errors": [ + { + "code": "StorageNotFound", + "message": "Storage not found" + } + ], + "numberOfFailedSecurityChecks": 0 + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolVulnerabilityAssessments.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolVulnerabilityAssessments.json new file mode 100644 index 000000000000..006492913be1 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolVulnerabilityAssessments.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "vulnerabilityaseessmenttest-4799", + "workspaceName": "vulnerabilityaseessmenttest-6440", + "sqlPoolName": "testdb", + "vulnerabilityAssessmentName": "default", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityaseessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments", + "properties": { + "recurringScans": { + "isEnabled": true, + "emailSubscriptionAdmins": true, + "emails": [ + "email1@mail.com", + "email2@mail.com" + ] + } + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolsInWorkspace.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolsInWorkspace.json new file mode 100644 index 000000000000..5e2372ec9376 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolsInWorkspace.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-6845", + "workspaceName": "sqlcrudtest-7177", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Synapse/workspaces/sqlcrudtest-7177/sqlPools/master", + "name": "master", + "type": "Microsoft.Synapse/workspaces/sqlPools", + "location": "Japan East", + "properties": { + "status": "Online", + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 32212254720, + "creationDate": "2017-02-10T00:59:33.483Z", + "provisioningState": "Succeeded", + "restorePointInTime": "0001-01-01T00:00:00Z", + "storageAccountType": "GRS" + }, + "sku": { + "name": "GP_Gen5_2" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Synapse/workspaces/sqlcrudtest-7177/sqlPools/sqlcrudtest-1142", + "name": "sqlcrudtest-1142", + "type": "Microsoft.Synapse/workspaces/sqlPools", + "location": "Japan East", + "properties": { + "status": "Online", + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 268435456000, + "creationDate": "2017-02-10T01:03:34.04Z", + "provisioningState": "Succeeded", + "restorePointInTime": "0001-01-01T00:00:00Z", + "storageAccountType": "GRS" + }, + "sku": { + "name": "DW100c" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Synapse/workspaces/sqlcrudtest-7177/sqlPools/sqlcrudtest-2788", + "name": "sqlcrudtest-2788", + "type": "Microsoft.Synapse/workspaces/sqlPools", + "location": "Japan East", + "properties": { + "status": "Online", + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 268435456000, + "creationDate": "2017-02-10T01:00:21.067Z", + "provisioningState": "Succeeded", + "restorePointInTime": "0001-01-01T00:00:00Z", + "storageAccountType": "GRS" + }, + "sku": { + "name": "DW100c" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Synapse/workspaces/sqlcrudtest-7177/sqlPools/sqlcrudtest-6877", + "name": "sqlcrudtest-6877", + "type": "Microsoft.Synapse/workspaces/sqlPools", + "location": "Southeast Asia", + "properties": { + "status": "Online", + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 268435456000, + "creationDate": "2017-02-10T01:02:28.853Z", + "provisioningState": "Succeeded", + "restorePointInTime": "0001-01-01T00:00:00Z", + "storageAccountType": "LRS" + }, + "sku": { + "name": "DW100c" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Synapse/workspaces/sqlcrudtest-7177/sqlPools/sqlcrudtest-9888", + "name": "sqlcrudtest-9888", + "type": "Microsoft.Synapse/workspaces/sqlPools", + "location": "Japan East", + "properties": { + "status": "Online", + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 268435456000, + "creationDate": "2017-02-10T01:01:25.347Z", + "provisioningState": "Succeeded", + "restorePointInTime": "0001-01-01T00:00:00Z", + "storageAccountType": "GRS" + }, + "sku": { + "name": "DW100c" + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolsInWorkspaceWithFilter.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolsInWorkspaceWithFilter.json new file mode 100644 index 000000000000..87cb1abafceb --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolsInWorkspaceWithFilter.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-6845", + "workspaceName": "sqlcrudtest-7177", + "api-version": "2021-05-01", + "$filter": "properties/edition eq 'System'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6845/providers/Microsoft.Synapse/workspaces/sqlcrudtest-7177/sqlPools/master", + "name": "master", + "type": "Microsoft.Synapse/workspaces/sqlPools", + "location": "Japan East", + "properties": { + "status": "Online", + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 32212254720, + "creationDate": "2017-02-10T00:59:33.483Z", + "provisioningState": "Succeeded", + "restorePointInTime": "0001-01-01T00:00:00Z", + "storageAccountType": "GRS" + }, + "sku": { + "name": "GP_Gen5_2" + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolsSensitivityLabelsWithSourceCurrent.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolsSensitivityLabelsWithSourceCurrent.json new file mode 100644 index 000000000000..72e0b08be69d --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListSqlPoolsSensitivityLabelsWithSourceCurrent.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myRG", + "workspaceName": "myServer", + "sqlPoolName": "myDatabase", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/myServer/sqlPools/myDatabase/schemas/dbo/tables/myTable/columns/myColumn3/sensitivityLabels/current", + "name": "current", + "type": "Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels", + "properties": { + "informationType": "Financial", + "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646", + "labelId": "05e6eaa1-075a-4fb4-a732-a92215a2444a", + "labelName": "Sensitive" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/myServer/sqlPools/myDatabase/schemas/dbo/tables/myTable/columns/myColumn4/sensitivityLabels/current", + "name": "current", + "type": "Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels", + "properties": { + "informationType": "Email", + "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646", + "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff", + "labelName": "PII" + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListWorkspaceManagedSqlServerBlobAuditingSettings.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListWorkspaceManagedSqlServerBlobAuditingSettings.json new file mode 100644 index 000000000000..70f62321eb9c --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListWorkspaceManagedSqlServerBlobAuditingSettings.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "wsg-7398", + "workspaceName": "testWorkspace", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/auditingSettings/default", + "name": "default", + "type": "Microsoft.Synapse/workspaces/auditingSettings", + "properties": { + "state": "Disabled", + "storageEndpoint": "", + "retentionDays": 0, + "auditActionsAndGroups": [], + "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", + "isStorageSecondaryKeyInUse": false, + "isAzureMonitorTargetEnabled": false + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListWorkspaceManagedSqlServerExtendedBlobAuditingSettings.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListWorkspaceManagedSqlServerExtendedBlobAuditingSettings.json new file mode 100644 index 000000000000..9b1977a9f051 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListWorkspaceManagedSqlServerExtendedBlobAuditingSettings.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "wsg-7398", + "workspaceName": "testWorkspace", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/extendedAuditingSettings/default", + "name": "default", + "type": "Microsoft.Synapse/workspaces/extendedAuditingSettings", + "properties": { + "state": "Disabled", + "storageEndpoint": "", + "retentionDays": 0, + "auditActionsAndGroups": [], + "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", + "isStorageSecondaryKeyInUse": false, + "predicateExpression": "object_name = 'SensitiveData'", + "isAzureMonitorTargetEnabled": false + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListWorkspaceManagedSqlServerRecoverableSqlPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListWorkspaceManagedSqlServerRecoverableSqlPool.json new file mode 100644 index 000000000000..c91f01bd6e09 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListWorkspaceManagedSqlServerRecoverableSqlPool.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "wsg-7398", + "workspaceName": "testWorkspace", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/recoverableSqlpools/recoverableSqlpools-1235", + "name": "recoverableSqlpools-1235", + "type": "Microsoft.Synapse/workspaces/recoverableSqlpools", + "properties": { + "edition": "Standard", + "serviceLevelObjective": "S0", + "lastAvailableBackupDate": "2017-05-26T01:06:29.78Z", + "elasticPoolName": null + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/recoverableSqlpools/recoverableSqlpools-9231", + "name": "recoverableSqlpools-9231", + "type": "Microsoft.Synapse/workspaces/recoverableSqlpools", + "properties": { + "edition": "Premium", + "serviceLevelObjective": "P1", + "lastAvailableBackupDate": "2017-05-26T03:20:31.78Z", + "elasticPoolName": null + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/recoverableSqlpools/recoverableSqlpools-0342", + "name": "recoverableSqlpools-0342", + "type": "Microsoft.Synapse/workspaces/recoverableSqlpools", + "properties": { + "edition": "Basic", + "serviceLevelObjective": "Basic", + "lastAvailableBackupDate": "2017-05-24T02:06:18.78Z", + "elasticPoolName": null + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListWorkspaceManagedSqlServerSecurityAlertPolicies.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListWorkspaceManagedSqlServerSecurityAlertPolicies.json new file mode 100644 index 000000000000..acfa5477c2b9 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListWorkspaceManagedSqlServerSecurityAlertPolicies.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "wsg-7398", + "workspaceName": "testWorkspace", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/securityAlertPolicies", + "name": "Default", + "type": "Microsoft.Synapse/workspaces/securityAlertPolicies", + "properties": { + "state": "Disabled", + "emailAccountAdmins": true, + "emailAddresses": [ + "test@microsoft.com;user@microsoft.com" + ], + "disabledAlerts": [ + "Access_Anomaly" + ], + "creationTime": "2020-10-23T04:52:49.52Z", + "retentionDays": 0, + "storageAccountAccessKey": "", + "storageEndpoint": "https://mystorage.blob.core.windows.net" + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListWorkspaceManagedSqlServerUsages.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListWorkspaceManagedSqlServerUsages.json new file mode 100644 index 000000000000..8c45f0e790c6 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListWorkspaceManagedSqlServerUsages.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "wsg-7398", + "workspaceName": "testWorkspace", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "server_dtu_quota", + "resourceName": "testWorkspace", + "displayName": "Database Throughput Unit Quota", + "currentValue": 0, + "limit": 45000, + "unit": "DTUs", + "nextResetTime": null + }, + { + "name": "server_dtu_quota_current", + "resourceName": "testWorkspace", + "displayName": "Database Throughput Unit Quota", + "currentValue": 0, + "limit": 45000, + "unit": "DTUs", + "nextResetTime": null + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListWorkspaceManagedSqlServerVulnerabilityAssessmentPolicies.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListWorkspaceManagedSqlServerVulnerabilityAssessmentPolicies.json new file mode 100644 index 000000000000..b66ad83fd063 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListWorkspaceManagedSqlServerVulnerabilityAssessmentPolicies.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "wsg-7398", + "workspaceName": "testWorkspace", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/vulnerabilityAssessments/default", + "name": "default", + "type": "Microsoft.Synapse/workspaces/vulnerabilityAssessments", + "properties": { + "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", + "recurringScans": { + "isEnabled": true, + "emailSubscriptionAdmins": true, + "emails": [ + "email1@mail.com", + "email2@mail.com" + ] + } + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListWorkspacesInResourceGroup.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListWorkspacesInResourceGroup.json new file mode 100644 index 000000000000..c3dc27daf4d9 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListWorkspacesInResourceGroup.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup1", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1", + "name": "workspace1", + "type": "Microsoft.Synapse/workspaces", + "location": "East US", + "properties": { + "defaultDataLakeStorage": { + "accountUrl": "https://accountname.dfs.core.windows.net", + "filesystem": "default" + }, + "connectivityEndpoints": { + "dev": "workspace1.dev.projectarcadia.net", + "sql": "workspace1.sql.projectarcadia.net" + }, + "sqlAdministratorLogin": "login", + "sqlAdministratorLoginPassword": "password", + "managedResourceGroupName": "resourceGroup2", + "provisioningState": "Succeeded" + }, + "tags": { + "key": "value" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace2", + "name": "workspace2", + "type": "Microsoft.Synapse/workspaces", + "location": "East US", + "properties": { + "defaultDataLakeStorage": { + "accountUrl": "https://accountname.dfs.core.windows.net", + "filesystem": "default" + }, + "connectivityEndpoints": { + "dev": "workspace2.dev.projectarcadia.net", + "sql": "workspace2.sql.projectarcadia.net" + }, + "sqlAdministratorLogin": "login", + "sqlAdministratorLoginPassword": "password", + "managedResourceGroupName": "resourceGroup2", + "provisioningState": "Succeeded" + }, + "tags": { + "key": "value" + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListWorkspacesInSubscription.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListWorkspacesInSubscription.json new file mode 100644 index 000000000000..3292a3ca37a7 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ListWorkspacesInSubscription.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1", + "name": "workspace1", + "type": "Microsoft.Synapse/workspaces", + "location": "East US", + "properties": { + "defaultDataLakeStorage": { + "accountUrl": "https://accountname.dfs.core.windows.net", + "filesystem": "default" + }, + "connectivityEndpoints": { + "dev": "workspace1.dev.projectarcadia.net", + "sql": "workspace1.sql.projectarcadia.net" + }, + "sqlAdministratorLogin": "login", + "managedResourceGroupName": "resourceGroup2", + "provisioningState": "Succeeded", + "workspaceUID": "999b999q-b888-4b44-bacd-2c222cc2222d" + }, + "tags": { + "key": "value" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace2", + "name": "workspace2", + "type": "Microsoft.Synapse/workspaces", + "location": "East US", + "properties": { + "defaultDataLakeStorage": { + "accountUrl": "https://accountname.dfs.core.windows.net", + "filesystem": "default" + }, + "connectivityEndpoints": { + "dev": "workspace2.dev.projectarcadia.net", + "sql": "workspace2.sql.projectarcadia.net" + }, + "sqlAdministratorLogin": "login", + "managedResourceGroupName": "resourceGroup2", + "provisioningState": "Succeeded", + "workspaceUID": "999b999q-b888-4b44-bacd-2c222cc2222d" + }, + "tags": { + "key": "value" + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/PauseSqlPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/PauseSqlPool.json new file mode 100644 index 000000000000..74957fde9029 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/PauseSqlPool.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "workspaceName": "testsvr", + "sqlPoolName": "testdwdb", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "tags": { + "tagKey1": "TagValue1" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Synapse/workspaces/testsvr/sqlPools/testdwdb", + "name": "testdwdb", + "type": "Microsoft.Synapse/workspaces/sqlPools", + "location": "Japan East", + "properties": { + "status": "Online", + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 268435456000, + "creationDate": "2017-02-10T00:56:19.2Z", + "provisioningState": "Succeeded", + "restorePointInTime": "0001-01-01T00:00:00Z" + }, + "sku": { + "name": "DW100c" + } + } + }, + "202": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/PrivateEndpointConnectionsPrivateLinkHub_Get.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/PrivateEndpointConnectionsPrivateLinkHub_Get.json new file mode 100644 index 000000000000..06fa8e6a2b6a --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/PrivateEndpointConnectionsPrivateLinkHub_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "48b08652-d7a1-4d52-b13f-5a2471dce57b", + "resourceGroupName": "gh-res-grp", + "privateLinkHubName": "pe0", + "privateEndpointConnectionName": "pe0-f3ed30f5-338c-4855-a542-24a403694ad2", + "api-version": "2021-04-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "pe0-f3ed30f5-338c-4855-a542-24a403694ad2", + "type": "Microsoft.Synapse/privateLinkHubs/privateEndpointConnections", + "id": "/subscriptions/48b08652-d7a1-4d52-b13f-5a2471dce57b/resourceGroups/gh-res-grp/providers/Microsoft.Synapse/privateLinkHubs/plh900/privateEndpointConnections/pe0-f3ed30f5-338c-4855-a542-24a403694ad2", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/48b08652-d7a1-4d52-b13f-5a2471dce57b/resourceGroups/gh-res-grp/providers/Microsoft.Network/privateEndpoints/pe0" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + } + } + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/PrivateEndpointConnectionsPrivateLinkHub_List.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/PrivateEndpointConnectionsPrivateLinkHub_List.json new file mode 100644 index 000000000000..23c34893b700 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/PrivateEndpointConnectionsPrivateLinkHub_List.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "48b08652-d7a1-4d52-b13f-5a2471dce57b", + "resourceGroupName": "gh-res-grp", + "privateLinkHubName": "pe0", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "pe0-f3ed30f5-338c-4855-a542-24a403694ad2", + "type": "Microsoft.Synapse/privateLinkHubs/privateEndpointConnections", + "id": "/subscriptions/48b08652-d7a1-4d52-b13f-5a2471dce57b/resourceGroups/gh-res-grp/providers/Microsoft.Synapse/privateLinkHubs/plh900/privateEndpointConnections/pe0-f3ed30f5-338c-4855-a542-24a403694ad2", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/48b08652-d7a1-4d52-b13f-5a2471dce57b/resourceGroups/gh-res-grp/providers/Microsoft.Network/privateEndpoints/pe0" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + } + } + }, + { + "name": "pe-xbox-3e425dc3-edd9-434c-9bca-3ac6cecbc7e4", + "type": "Microsoft.Synapse/privateLinkHubs/privateEndpointConnections", + "id": "/subscriptions/48b08652-d7a1-4d52-b13f-5a2471dce57b/resourceGroups/gh-res-grp/providers/Microsoft.Synapse/privateLinkHubs/plh900/privateEndpointConnections/pe-xbox-3e425dc3-edd9-434c-9bca-3ac6cecbc7e4", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/48b08652-d7a1-4d52-b13f-5a2471dce57b/resourceGroups/gh-res-grp/providers/Microsoft.Network/privateEndpoints/pe-xbox" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + } + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/PutWorkspaceManagedSqlServerVulnerabilityAssessmentWithAllParameters.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/PutWorkspaceManagedSqlServerVulnerabilityAssessmentWithAllParameters.json new file mode 100644 index 000000000000..6b2fe911c424 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/PutWorkspaceManagedSqlServerVulnerabilityAssessmentWithAllParameters.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "wsg-7398", + "workspaceName": "testWorkspace", + "vulnerabilityAssessmentName": "default", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", + "storageContainerSasKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", + "storageAccountAccessKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", + "recurringScans": { + "isEnabled": true, + "emailSubscriptionAdmins": true, + "emails": [ + "email1@mail.com", + "email2@mail.com" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/vulnerabilityAssessments/default", + "name": "default", + "type": "Microsoft.Synapse/workspaces/vulnerabilityAssessments", + "properties": { + "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", + "recurringScans": { + "isEnabled": true, + "emailSubscriptionAdmins": true, + "emails": [ + "email1@mail.com", + "email2@mail.com" + ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/vulnerabilityAssessments/default", + "name": "default", + "type": "Microsoft.Synapse/workspaces/vulnerabilityAssessments", + "properties": { + "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", + "recurringScans": { + "isEnabled": true, + "emailSubscriptionAdmins": true, + "emails": [ + "email1@mail.com", + "email2@mail.com" + ] + } + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/PutWorkspaceMangedSqlServerVulnerabilityAssessmentCreateContainerSasKeyMin.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/PutWorkspaceMangedSqlServerVulnerabilityAssessmentCreateContainerSasKeyMin.json new file mode 100644 index 000000000000..6af27757b684 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/PutWorkspaceMangedSqlServerVulnerabilityAssessmentCreateContainerSasKeyMin.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "wsg-7398", + "workspaceName": "testWorkspace", + "vulnerabilityAssessmentName": "default", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", + "storageContainerSasKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/vulnerabilityAssessments/default", + "name": "default", + "type": "Microsoft.Synapse/workspaces/vulnerabilityAssessments", + "properties": { + "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", + "recurringScans": { + "isEnabled": true, + "emailSubscriptionAdmins": false, + "emails": [] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/vulnerabilityAssessments/default", + "name": "default", + "type": "Microsoft.Synapse/workspaces/vulnerabilityAssessments", + "properties": { + "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", + "recurringScans": { + "isEnabled": true, + "emailSubscriptionAdmins": false, + "emails": [] + } + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/PutWorkspaceMangedSqlServerVulnerabilityAssessmentCreateStorageAccessKeyMin.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/PutWorkspaceMangedSqlServerVulnerabilityAssessmentCreateStorageAccessKeyMin.json new file mode 100644 index 000000000000..aa9a84138370 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/PutWorkspaceMangedSqlServerVulnerabilityAssessmentCreateStorageAccessKeyMin.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "wsg-7398", + "workspaceName": "testWorkspace", + "vulnerabilityAssessmentName": "default", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", + "storageAccountAccessKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/vulnerabilityAssessments/default", + "name": "default", + "type": "Microsoft.Synapse/workspaces/vulnerabilityAssessments", + "properties": { + "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", + "recurringScans": { + "isEnabled": true, + "emailSubscriptionAdmins": false, + "emails": [] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/vulnerabilityAssessments/default", + "name": "default", + "type": "Microsoft.Synapse/workspaces/vulnerabilityAssessments", + "properties": { + "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", + "recurringScans": { + "isEnabled": true, + "emailSubscriptionAdmins": false, + "emails": [] + } + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/RecommendedColumnSensitivityLabelDisable.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/RecommendedColumnSensitivityLabelDisable.json new file mode 100644 index 000000000000..e54743c11f94 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/RecommendedColumnSensitivityLabelDisable.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myRG", + "workspaceName": "myServer", + "sqlPoolName": "myDatabase", + "schemaName": "dbo", + "tableName": "myTable", + "columnName": "myColumn", + "sensitivityLabelSource": "recommended", + "api-version": "2021-05-01" + }, + "responses": { + "200": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/RecommendedColumnSensitivityLabelEnable.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/RecommendedColumnSensitivityLabelEnable.json new file mode 100644 index 000000000000..e54743c11f94 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/RecommendedColumnSensitivityLabelEnable.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myRG", + "workspaceName": "myServer", + "sqlPoolName": "myDatabase", + "schemaName": "dbo", + "tableName": "myTable", + "columnName": "myColumn", + "sensitivityLabelSource": "recommended", + "api-version": "2021-05-01" + }, + "responses": { + "200": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/RenameSqlPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/RenameSqlPool.json new file mode 100644 index 000000000000..5e5bd131cd20 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/RenameSqlPool.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "workspaceName": "testsvr", + "sqlPoolName": "testdb", + "api-version": "2021-05-01", + "parameters": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Synapse/workspaces/testsvr/sqlPools/newtestdb" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ReplaceAllIpFirewallRules.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ReplaceAllIpFirewallRules.json new file mode 100644 index 000000000000..faf8d30b4c42 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ReplaceAllIpFirewallRules.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "api-version": "2021-05-01", + "request": { + "ipFirewallRules": { + "ExampleFirewallRule": { + "startIpAddress": "10.0.0.0", + "endIpAddress": "10.0.0.254" + }, + "AnotherExampleFirewallRule": { + "startIpAddress": "10.0.1.0", + "endIpAddress": "10.0.1.254" + } + } + } + }, + "responses": { + "200": { + "body": { + "operationId": "00000000-1111-4444-2222-333333333333" + } + }, + "202": {}, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/RestorableDroppedSqlPoolGet.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/RestorableDroppedSqlPoolGet.json new file mode 100644 index 000000000000..6e2ea5b9f2e2 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/RestorableDroppedSqlPoolGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "restorabledroppeddatabasetest-1257", + "workspaceName": "restorabledroppeddatabasetest-2389", + "restorableDroppedSqlPoolId": "restorabledroppeddatabasetest-7654,131403269876900000", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/restorabledroppeddatabasetest-1257/providers/Microsoft.Synapse/workspaces/restorabledroppeddatabasetest-2389/restorableDroppedSqlPools/restorabledroppeddatabasetest-7654,131403269876900000", + "name": "restorabledroppeddatabasetest-7654,131403269876900000", + "type": "Microsoft.Synapse/workspaces/restorableDroppedSqlPools", + "location": "Japan East", + "properties": { + "databaseName": "restorabledroppeddatabasetest-7654", + "edition": "Datawarehouse", + "maxSizeBytes": "2147483648", + "serviceLevelObjective": "DW100c", + "elasticPoolName": null, + "creationDate": "2017-02-10T00:56:19.2Z", + "deletionDate": "2017-05-27T02:49:47.69Z", + "earliestRestoreDate": "2017-05-20T02:49:47.69Z" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/RestorableDroppedSqlpoolList.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/RestorableDroppedSqlpoolList.json new file mode 100644 index 000000000000..e7642379d229 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/RestorableDroppedSqlpoolList.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "restorabledroppeddatabasetest-1349", + "workspaceName": "restorabledroppeddatabasetest-1840", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/restorabledroppeddatabasetest-1349/providers/Microsoft.Synapse/workspaces/restorabledroppeddatabasetest-1840/restorableDroppedSqlPools/restorabledroppeddatabasetest-1345,131403269876900000", + "name": "restorabledroppeddatabasetest-1345,131403269876900000", + "type": "Microsoft.Synapse/workspaces/restorableDroppedSqlPools", + "location": "Japan East", + "properties": { + "databaseName": "restorabledroppeddatabasetest-1345", + "edition": "Basic", + "maxSizeBytes": "2147483648", + "serviceLevelObjective": "Basic", + "elasticPoolName": null, + "creationDate": "2017-02-10T00:56:19.2Z", + "deletionDate": "2017-05-27T02:49:47.69Z", + "earliestRestoreDate": "2017-05-20T02:49:47.69Z" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/restorabledroppeddatabasetest-1349/providers/Microsoft.Synapse/workspaces/restorabledroppeddatabasetest-1840/restorableDroppedSqlPools/restorabledroppeddatabasetest-2764,131403249684030000", + "name": "restorabledroppeddatabasetest-2764,131403249684030000", + "type": "Microsoft.Synapse/workspaces/restorableDroppedSqlPools", + "location": "Japan East", + "properties": { + "databaseName": "restorabledroppeddatabasetest-2764", + "edition": "Standard", + "maxSizeBytes": "268435456000", + "serviceLevelObjective": "S0", + "elasticPoolName": null, + "creationDate": "2016-05-10T00:56:19.2Z", + "deletionDate": "2017-05-27T02:16:08.403Z", + "earliestRestoreDate": "2017-04-21T02:49:47.69Z" + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ResumeSqlPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ResumeSqlPool.json new file mode 100644 index 000000000000..8f9e9707157a --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/ResumeSqlPool.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "sqlcrudtest-6852", + "workspaceName": "sqlcrudtest-2080", + "sqlPoolName": "sqlcrudtest-9187", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "tags": { + "tagKey1": "TagValue1" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Synapse/workspaces/sqlcrudtest-2080/sqlPools/sqlcrudtest-9187", + "name": "sqlcrudtest-9187", + "type": "Microsoft.Synapse/workspaces/sqlPools", + "location": "Japan East", + "properties": { + "status": "Online", + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 268435456000, + "creationDate": "2017-02-10T00:56:19.2Z", + "provisioningState": "Succeeded", + "restorePointInTime": "0001-01-01T00:00:00Z" + }, + "sku": { + "name": "DW100c" + } + } + }, + "202": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SensitivityLabelsCurrentUpdate.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SensitivityLabelsCurrentUpdate.json new file mode 100644 index 000000000000..5dbfa9616ae7 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SensitivityLabelsCurrentUpdate.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myRG", + "workspaceName": "myWorkspace", + "sqlPoolName": "mySqlPool", + "api-version": "2021-05-01", + "parameters": { + "operations": [ + { + "properties": { + "op": "set", + "schema": "dbo", + "table": "table1", + "column": "column1", + "sensitivityLabel": { + "properties": { + "labelName": "Highly Confidential", + "labelId": "3A477B16-9423-432B-AA97-6069B481CEC3", + "informationType": "Financial", + "informationTypeId": "1D3652D6-422C-4115-82F1-65DAEBC665C8", + "rank": "Low" + } + } + } + }, + { + "properties": { + "op": "set", + "schema": "dbo", + "table": "table2", + "column": "column2", + "sensitivityLabel": { + "properties": { + "informationType": "PhoneNumber", + "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646", + "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff", + "labelName": "PII", + "rank": "Critical" + } + } + } + }, + { + "properties": { + "op": "remove", + "schema": "dbo", + "table": "Table1", + "column": "Column3" + } + } + ] + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SensitivityLabelsRecommendedUpdate.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SensitivityLabelsRecommendedUpdate.json new file mode 100644 index 000000000000..9e40ba0d8d3e --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SensitivityLabelsRecommendedUpdate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myRG", + "workspaceName": "myWorkspace", + "sqlPoolName": "mySqlPool", + "api-version": "2021-05-01", + "parameters": { + "operations": [ + { + "properties": { + "op": "enable", + "schema": "dbo", + "table": "table1", + "column": "column1" + } + }, + { + "properties": { + "op": "enable", + "schema": "dbo", + "table": "table2", + "column": "column2" + } + }, + { + "properties": { + "op": "disable", + "schema": "dbo", + "table": "table1", + "column": "column3" + } + } + ] + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolAuditingSettingsList.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolAuditingSettingsList.json new file mode 100644 index 000000000000..a64e3e19f4f5 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolAuditingSettingsList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "blobauditingtest-6852", + "workspaceName": "blobauditingtest-2080", + "sqlPoolName": "testdb", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-6852/providers/Microsoft.Synapse/workspaces/blobauditingtest-2080/sqlPools/testdb", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/auditingSettings", + "kind": "V12", + "properties": { + "state": "Disabled", + "storageEndpoint": "", + "retentionDays": 0, + "auditActionsAndGroups": [], + "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", + "isStorageSecondaryKeyInUse": false, + "isAzureMonitorTargetEnabled": false + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolColumnGet.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolColumnGet.json new file mode 100644 index 000000000000..7f8a065edb12 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolColumnGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myRG", + "workspaceName": "serverName", + "sqlPoolName": "myDatabase", + "schemaName": "dbo", + "tableName": "table1", + "columnName": "column1", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/serverName/sqlPools/myDatabase/schemas/dbo/tables/table1/columns/column1", + "name": "column1", + "type": "Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns", + "properties": { + "columnType": "bit" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolExtendedAuditingSettingsList.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolExtendedAuditingSettingsList.json new file mode 100644 index 000000000000..a8191fa49f13 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolExtendedAuditingSettingsList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "blobauditingtest-6852", + "workspaceName": "blobauditingtest-2080", + "sqlPoolName": "testdb", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-6852/providers/Microsoft.Synapse/workspaces/blobauditingtest-2080/sqlPools/testdb/extendedAuditingSettings/default", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/extendedAuditingSettings", + "properties": { + "state": "Disabled", + "storageEndpoint": "", + "retentionDays": 0, + "auditActionsAndGroups": [], + "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", + "isStorageSecondaryKeyInUse": false, + "predicateExpression": "statement = 'select 1'", + "isAzureMonitorTargetEnabled": false + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolGeoBackupPolicies_List.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolGeoBackupPolicies_List.json new file mode 100644 index 000000000000..5c8909302c14 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolGeoBackupPolicies_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-4799", + "workspaceName": "sqlcrudtest-5961", + "sqlPoolName": "testdw", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Synapse/workspaces/sqlcrudtest-5961/sqlPools/testdw/geoBackupPolicies/Default", + "name": "Default", + "type": "Microsoft.Synapse/workspaces/sqlPools/geoBackupPolicies", + "location": "Central US", + "kind": null, + "properties": { + "state": "Enabled", + "storageType": "Premium" + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolReplicationLinks_GetByName.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolReplicationLinks_GetByName.json new file mode 100644 index 000000000000..fe5d1444946c --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolReplicationLinks_GetByName.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-4799", + "workspaceName": "sqlcrudtest-6440", + "sqlPoolName": "testdb", + "linkId": "5b301b68-03f6-4b26-b0f4-73ebb8634238", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Synapse/workspaces/sqlcrudtest-6440/sqlPools/testdb/replicationLinks/5b301b68-03f6-4b26-b0f4-73ebb8634238", + "name": "5b301b68-03f6-4b26-b0f4-73ebb8634238", + "type": "Microsoft.Synapse/workspaces/sqlPools/replicationLinks", + "location": "Japan East", + "properties": { + "partnerServer": "sqlcrudtest-5961", + "partnerDatabase": "testdb", + "partnerLocation": "Japan East", + "role": "Secondary", + "partnerRole": "Primary", + "replicationMode": "ASYNC", + "startTime": "2017-02-10T01:44:27.117Z", + "percentComplete": 100, + "replicationState": "CATCH_UP", + "isTerminationAllowed": true + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolRestorePointsDelete.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolRestorePointsDelete.json new file mode 100644 index 000000000000..94ed8cfdd6ae --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolRestorePointsDelete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "restorePointName": "131546477590000000", + "location": "japaneast", + "workspaceName": "testws", + "sqlPoolName": "testpool", + "api-version": "2021-05-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolRestorePointsGet.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolRestorePointsGet.json new file mode 100644 index 000000000000..1e4c90556126 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolRestorePointsGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "restorePointName": "131546477590000000", + "location": "japaneast", + "workspaceName": "testws", + "sqlPoolName": "testpool", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Synapse/workspaces/testws/sqlPools/testpool/restorePoints/131546477590000000", + "name": "131546477590000000", + "type": "Microsoft.Synapse/workspaces/sqlPools/restorePoints", + "location": "japaneast", + "properties": { + "restorePointType": "DISCRETE", + "restorePointCreationDate": "2017-03-10T08:00:00.000Z", + "restorePointLabel": "mylabel" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolSchemaGet.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolSchemaGet.json new file mode 100644 index 000000000000..22745af58565 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolSchemaGet.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myRG", + "workspaceName": "serverName", + "sqlPoolName": "myDatabase", + "schemaName": "dbo", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/serverName/sqlPools/myDatabase/schemas/dbo", + "name": "dbo", + "type": "Microsoft.Synapse/workspaces/sqlPools/schemas" + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolSecurityAlertPolicies_List.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolSecurityAlertPolicies_List.json new file mode 100644 index 000000000000..b8851ffc91cb --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolSecurityAlertPolicies_List.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-6852", + "workspaceName": "securityalert-2080", + "sqlPoolName": "testdb", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-6852/providers/Microsoft.Synapse/workspaces/securityalert-2080/sqlPools/testdb", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies", + "properties": { + "state": "Enabled", + "emailAccountAdmins": true, + "emailAddresses": [ + "test@microsoft.com", + "user@microsoft.com" + ], + "disabledAlerts": [ + "Usage_Anomaly" + ], + "retentionDays": 0, + "storageAccountAccessKey": "", + "creationTime": "2018-10-08T00:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolTableGet.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolTableGet.json new file mode 100644 index 000000000000..3e17fb17b819 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolTableGet.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myRG", + "workspaceName": "serverName", + "sqlPoolName": "myDatabase", + "schemaName": "dbo", + "tableName": "table1", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Synapse/workspaces/serverName/sqlPools/myDatabase/schemas/dbo/tables/table1", + "name": "table1", + "type": "Microsoft.Synapse/workspaces/sqlPools/schemas/tables" + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolUsageMetricsList.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolUsageMetricsList.json new file mode 100644 index 000000000000..9bc57837550a --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolUsageMetricsList.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-6730", + "workspaceName": "sqlcrudtest-9007", + "sqlPoolName": "3481", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "database_size", + "resourceName": "3481", + "displayName": "Database Size", + "currentValue": 4194304, + "limit": 268435456000, + "unit": "Bytes", + "nextResetTime": null + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolVulnerabilityAssessmentRuleBaselineGet.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolVulnerabilityAssessmentRuleBaselineGet.json new file mode 100644 index 000000000000..a4eaad10f6c4 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolVulnerabilityAssessmentRuleBaselineGet.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "vulnerabilityaseessmenttest-4711", + "workspaceName": "vulnerabilityaseessmenttest-6411", + "sqlPoolName": "testdb", + "vulnerabilityAssessmentName": "default", + "ruleId": "VA1001", + "baselineName": "master", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityaseessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default/rules/VA1001/baselines/default", + "name": "default", + "type": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/rules/baselines", + "properties": { + "baselineResults": [ + { + "result": [ + "userA", + "SELECT" + ] + }, + { + "result": [ + "userB", + "SELECT" + ] + }, + { + "result": [ + "userC", + "SELECT", + "tableId_4" + ] + } + ] + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolVulnerabilityAssessmentScanRecordsGet.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolVulnerabilityAssessmentScanRecordsGet.json new file mode 100644 index 000000000000..70ec77f7cf67 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/SqlPoolVulnerabilityAssessmentScanRecordsGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "vulnerabilityassessmenttest-4711", + "workspaceName": "vulnerabilityassessmenttest-6411", + "sqlPoolName": "testdb", + "vulnerabilityAssessmentName": "default", + "scanId": "scan001", + "api-version": "2021-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityassessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityassessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default/scans/scan001", + "name": "scan001", + "type": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/scans", + "properties": { + "scanId": "scan001", + "triggerType": "OnDemand", + "state": "Passed", + "startTime": "2017-12-12T17:45:06Z", + "endTime": "2017-12-12T17:47:06Z", + "errors": [], + "storageContainerPath": "https://myaccount.blob.core.windows.net/vulnerability-assessment", + "numberOfFailedSecurityChecks": 9 + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/UpdateBigDataPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/UpdateBigDataPool.json new file mode 100644 index 000000000000..40837c350f7a --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/UpdateBigDataPool.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "bigDataPoolName": "ExamplePool", + "api-version": "2021-05-01", + "bigDataPoolPatchInfo": { + "tags": { + "key": "value" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/bigDataPools/ExamplePool", + "type": "Microsoft.Synapse/workspaces/bigDataPools", + "location": "West US 2", + "name": "ExamplePool", + "tags": { + "key": "value" + }, + "properties": { + "provisioningState": "Succeeded", + "sparkVersion": "2.4", + "nodeCount": 4, + "nodeSize": "Medium", + "nodeSizeFamily": "MemoryOptimized", + "autoScale": { + "enabled": true, + "minNodeCount": 3, + "maxNodeCount": 50 + }, + "autoPause": { + "enabled": true, + "delayInMinutes": 15 + }, + "creationDate": "1970-01-01T00:00:00Z", + "sparkEventsFolder": "/events", + "libraryRequirements": { + "time": "1970-01-01T00:00:00Z", + "content": "", + "filename": "requirements.txt" + }, + "defaultSparkLogFolder": "/logs" + } + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/UpdatePrivateLinkHub.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/UpdatePrivateLinkHub.json new file mode 100644 index 000000000000..f66b90e9b059 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/UpdatePrivateLinkHub.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup1", + "privateLinkHubName": "privateLinkHub1", + "api-version": "2021-05-01", + "privateLinkHubPatchInfo": { + "tags": { + "key": "value" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/privateLinkHubs/privateLinkHub1", + "name": "privateLinkHub1", + "type": "Microsoft.Synapse/privateLinkHubs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": { + "key": "value" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/privateLinkHubs/privateLinkHub1", + "name": "privateLinkHub1", + "type": "Microsoft.Synapse/privateLinkHubs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": { + "key": "value" + } + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/UpdateSqlPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/UpdateSqlPool.json new file mode 100644 index 000000000000..d10dd9bb2337 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/UpdateSqlPool.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "sqlPoolName": "ExampleSqlPool", + "path": "example", + "api-version": "2021-05-01", + "sqlPoolInfo": { + "location": "West US 2", + "tags": {}, + "sku": { + "tier": "", + "name": "" + }, + "properties": { + "maxSizeBytes": 0, + "collation": "", + "sourceDatabaseId": "", + "recoverableDatabaseId": "", + "restorePointInTime": "1970-01-01T00:00:00.000Z", + "createMode": "", + "creationDate": "1970-01-01T00:00:00.000Z" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspaces/sqlPools/ExampleSqlPool", + "type": "Microsoft.Synapse/workspaces/sqlPools", + "name": "ExampleSqlPool", + "location": "West US 2", + "tags": {}, + "sku": { + "tier": "", + "name": "" + }, + "properties": { + "maxSizeBytes": 0, + "collation": "", + "sourceDatabaseId": "", + "recoverableDatabaseId": "", + "provisioningState": "Provisioning", + "status": "Paused", + "restorePointInTime": "1970-01-01T00:00:00.000Z", + "createMode": "", + "creationDate": "1970-01-01T00:00:00.000Z", + "storageAccountType": "GRS" + } + } + }, + "202": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/UpdateWorkspace.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/UpdateWorkspace.json new file mode 100644 index 000000000000..5ff1c48fd046 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/UpdateWorkspace.json @@ -0,0 +1,149 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2021-05-01", + "workspacePatchInfo": { + "tags": { + "key": "value" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "sqlAdministratorLoginPassword": "password", + "managedVirtualNetworkSettings": { + "preventDataExfiltration": false, + "linkedAccessCheckOnTargetResource": false, + "allowedAadTenantIdsForLinking": [ + "740239CE-A25B-485B-86A0-262F29F6EBDB" + ] + }, + "workspaceRepositoryConfiguration": { + "type": "FactoryGitHubConfiguration", + "hostName": "", + "accountName": "adifferentacount", + "projectName": "myproject", + "repositoryName": "myrepository", + "collaborationBranch": "master", + "rootFolder": "/" + }, + "purviewConfiguration": { + "purviewResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.ProjectPurview/accounts/accountname1" + }, + "encryption": { + "cmk": { + "key": { + "name": "default", + "keyVaultUrl": "https://vault.azure.net/keys/key1" + } + } + }, + "publicNetworkAccess": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1", + "name": "workspace1", + "type": "Microsoft.Synapse/workspaces", + "location": "East US", + "properties": { + "defaultDataLakeStorage": { + "accountUrl": "https://accountname.dfs.core.windows.net", + "filesystem": "default" + }, + "managedVirtualNetworkSettings": { + "preventDataExfiltration": false, + "linkedAccessCheckOnTargetResource": false, + "allowedAadTenantIdsForLinking": [ + "740239CE-A25B-485B-86A0-262F29F6EBDB" + ] + }, + "purviewConfiguration": { + "purviewResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.ProjectPurview/accounts/accountname1" + }, + "connectivityEndpoints": { + "dev": "workspace1.dev.projectarcadia.net", + "sql": "workspace1.sql.projectarcadia.net" + }, + "sqlAdministratorLogin": "login", + "managedResourceGroupName": "resourceGroup2", + "provisioningState": "Succeeded", + "workspaceUID": "999b999q-b888-4b44-bacd-2c222cc2222d", + "encryption": { + "doubleEncryptionEnabled": true, + "cmk": { + "status": "Consistent", + "key": { + "name": "default", + "keyVaultUrl": "https://vault.azure.net/keys/key1" + } + } + }, + "publicNetworkAccess": "Enabled" + }, + "tags": { + "key": "value" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1", + "name": "workspace1", + "type": "Microsoft.Synapse/workspaces", + "location": "East US", + "properties": { + "defaultDataLakeStorage": { + "accountUrl": "https://accountname.dfs.core.windows.net", + "filesystem": "default" + }, + "managedVirtualNetworkSettings": { + "preventDataExfiltration": false, + "linkedAccessCheckOnTargetResource": false, + "allowedAadTenantIdsForLinking": [ + "740239CE-A25B-485B-86A0-262F29F6EBDB" + ] + }, + "purviewConfiguration": { + "purviewResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.ProjectPurview/accounts/accountname1" + }, + "connectivityEndpoints": { + "dev": "workspace1.dev.projectarcadia.net", + "sql": "workspace1.sql.projectarcadia.net" + }, + "sqlAdministratorLogin": "login", + "managedResourceGroupName": "resourceGroup2", + "provisioningState": "Provisioning", + "workspaceUID": "999b999q-b888-4b44-bacd-2c222cc2222d", + "encryption": { + "doubleEncryptionEnabled": true, + "cmk": { + "status": "Updating", + "key": { + "name": "default", + "keyVaultUrl": "https://vault.azure.net/keys/key1" + } + } + }, + "publicNetworkAccess": "Enabled" + }, + "tags": { + "key": "value" + } + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/WorkspaceManagedSqlServerEncryptionProtectorCreateOrUpdateKeyVault.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/WorkspaceManagedSqlServerEncryptionProtectorCreateOrUpdateKeyVault.json new file mode 100644 index 000000000000..e534d616a313 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/WorkspaceManagedSqlServerEncryptionProtectorCreateOrUpdateKeyVault.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "wsg-7398", + "workspaceName": "testWorkspace", + "encryptionProtectorName": "current", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "serverKeyType": "AzureKeyVault", + "serverKeyName": "someVault_someKey_01234567890123456789012345678901" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/encryptionProtector/current", + "name": "current", + "type": "Microsoft.Synapse/workspaces/encryptionProtector", + "location": "West US", + "kind": "azurekeyvault", + "properties": { + "serverKeyName": "someVault_someKey_01234567890123456789012345678901", + "serverKeyType": "AzureKeyVault" + } + } + }, + "202": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/WorkspaceManagedSqlServerEncryptionProtectorCreateOrUpdateServiceManaged.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/WorkspaceManagedSqlServerEncryptionProtectorCreateOrUpdateServiceManaged.json new file mode 100644 index 000000000000..cab84dc396bd --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/WorkspaceManagedSqlServerEncryptionProtectorCreateOrUpdateServiceManaged.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "wsg-7398", + "workspaceName": "testWorkspace", + "encryptionProtectorName": "current", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "serverKeyType": "ServiceManaged", + "serverKeyName": "ServiceManaged" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/encryptionProtector/current", + "name": "current", + "type": "Microsoft.Synapse/workspaces/encryptionProtector", + "location": "West US", + "kind": "servicemanaged", + "properties": { + "serverKeyName": "ServiceManaged", + "serverKeyType": "ServiceManaged" + } + } + }, + "202": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/WorkspaceManagedSqlServerEncryptionProtectorRevalidate.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/WorkspaceManagedSqlServerEncryptionProtectorRevalidate.json new file mode 100644 index 000000000000..cbc900eba1c7 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/WorkspaceManagedSqlServerEncryptionProtectorRevalidate.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "wsg-7398", + "workspaceName": "testWorkspace", + "encryptionProtectorName": "current", + "api-version": "2021-05-01" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/WorkspaceManagedSqlServerSecurityAlertCreateWithMinParameters.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/WorkspaceManagedSqlServerSecurityAlertCreateWithMinParameters.json new file mode 100644 index 000000000000..f5b10e8f9d19 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/WorkspaceManagedSqlServerSecurityAlertCreateWithMinParameters.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "wsg-7398", + "workspaceName": "testWorkspace", + "securityAlertPolicyName": "Default", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "state": "Disabled", + "emailAccountAdmins": true, + "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==", + "storageEndpoint": "https://mystorage.blob.core.windows.net" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/securityAlertPolicies/Default", + "name": "Default", + "type": "Microsoft.Synapse/workspaces/securityAlertPolicies", + "properties": { + "state": "Enabled", + "emailAccountAdmins": true, + "emailAddresses": [ + "" + ], + "disabledAlerts": [ + "" + ], + "creationTime": "2020-10-23T04:52:49.52Z", + "retentionDays": 0, + "storageAccountAccessKey": "", + "storageEndpoint": "https://mystorage.blob.core.windows.net" + } + } + }, + "202": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/WorkspaceManagedSqlServerSecurityAlertWithAllParameters.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/WorkspaceManagedSqlServerSecurityAlertWithAllParameters.json new file mode 100644 index 000000000000..1a55eaa18ebe --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/WorkspaceManagedSqlServerSecurityAlertWithAllParameters.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "wsg-7398", + "workspaceName": "testWorkspace", + "securityAlertPolicyName": "Default", + "api-version": "2021-05-01", + "parameters": { + "properties": { + "state": "Enabled", + "emailAccountAdmins": true, + "emailAddresses": [ + "testSecurityAlert@microsoft.com" + ], + "disabledAlerts": [ + "Access_Anomaly", + "Usage_Anomaly" + ], + "retentionDays": 5, + "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==", + "storageEndpoint": "https://mystorage.blob.core.windows.net" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/securityAlertPolicies/Default", + "name": "Default", + "type": "Microsoft.Synapse/workspaces/securityAlertPolicies", + "properties": { + "state": "Enabled", + "emailAccountAdmins": true, + "emailAddresses": [ + "testSecurityAlert@microsoft.com" + ], + "disabledAlerts": [ + "Access_Anomaly", + "Usage_Anomaly" + ], + "creationTime": "2020-10-23T04:52:49.52Z", + "retentionDays": 5, + "storageAccountAccessKey": "", + "storageEndpoint": "https://mystorage.blob.core.windows.net" + } + } + }, + "202": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/firewallRule.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/firewallRule.json new file mode 100644 index 000000000000..577942295958 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/firewallRule.json @@ -0,0 +1,424 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-05-01", + "title": "SynapseManagementClient", + "description": "Azure Synapse Analytics APIs" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "type": "oauth2", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/firewallRules": { + "get": { + "operationId": "IpFirewallRules_ListByWorkspace", + "description": "Returns a list of firewall rules", + "tags": [ + "IpFirewallRules" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/IpFirewallRuleInfoListResult" + }, + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "List IP firewall rules in a workspace": { + "$ref": "./examples/ListIpFirewallRules.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/firewallRules/{ruleName}": { + "put": { + "operationId": "IpFirewallRules_CreateOrUpdate", + "description": "Creates or updates a firewall rule", + "tags": [ + "IpFirewallRules" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + }, + { + "$ref": "#/parameters/ruleNameParameter" + }, + { + "description": "IP firewall rule properties", + "schema": { + "$ref": "#/definitions/IpFirewallRuleInfo", + "description": "IP firewall rule properties" + }, + "in": "body", + "name": "ipFirewallRuleInfo", + "required": true + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/IpFirewallRuleInfo" + }, + "description": "" + }, + "201": { + "schema": { + "$ref": "#/definitions/IpFirewallRuleInfo" + }, + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Create an IP firewall rule": { + "$ref": "./examples/CreateIpFirewallRule.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "delete": { + "operationId": "IpFirewallRules_Delete", + "description": "Deletes a firewall rule", + "tags": [ + "IpFirewallRules" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + }, + { + "$ref": "#/parameters/ruleNameParameter" + } + ], + "responses": { + "200": { + "schema": { + "type": "object" + }, + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "202": { + "description": "Accepted" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Delete an IP firewall rule from a workspace": { + "$ref": "./examples/DeleteIpFirewallRule.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "operationId": "IpFirewallRules_Get", + "description": "Get a firewall rule", + "tags": [ + "IpFirewallRules" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + }, + { + "$ref": "#/parameters/ruleNameParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/IpFirewallRuleInfo" + }, + "description": "Ip Firewall Rule details" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Create an IP firewall rule": { + "$ref": "./examples/GetIpFirewallRule.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/replaceAllIpFirewallRules": { + "post": { + "operationId": "IpFirewallRules_ReplaceAll", + "description": "Replaces firewall rules", + "tags": [ + "IpFirewallRules" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + }, + { + "description": "Replace all IP firewall rules request", + "schema": { + "$ref": "#/definitions/ReplaceAllIpFirewallRulesRequest", + "description": "Replace all IP firewall rules request" + }, + "in": "body", + "name": "request", + "required": true + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/ReplaceAllFirewallRulesOperationResponse" + }, + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Replace all IP firewall rules in a workspace": { + "$ref": "./examples/ReplaceAllIpFirewallRules.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "IpFirewallRuleInfo": { + "description": "IP firewall rule", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/IpFirewallRuleProperties", + "description": "IP firewall rule properties", + "x-ms-client-flatten": true + } + } + }, + "ReplaceAllIpFirewallRulesRequest": { + "description": "Replace all IP firewall rules request", + "type": "object", + "properties": { + "ipFirewallRules": { + "description": "IP firewall rule properties", + "additionalProperties": { + "description": "IP firewall rule properties", + "$ref": "#/definitions/IpFirewallRuleProperties" + }, + "type": "object" + } + } + }, + "IpFirewallRuleProperties": { + "description": "IP firewall rule properties", + "type": "object", + "properties": { + "endIpAddress": { + "description": "The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress", + "type": "string" + }, + "provisioningState": { + "description": "Resource provisioning state", + "enum": [ + "Provisioning", + "Succeeded", + "Deleting", + "Failed", + "DeleteError" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "startIpAddress": { + "description": "The start IP address of the firewall rule. Must be IPv4 format", + "type": "string" + } + } + }, + "IpFirewallRuleInfoListResult": { + "type": "object", + "description": "List of IP firewall rules", + "properties": { + "nextLink": { + "description": "Link to next page of results", + "type": "string" + }, + "value": { + "description": "List of IP firewall rules", + "type": "array", + "items": { + "$ref": "#/definitions/IpFirewallRuleInfo" + } + } + } + }, + "ReplaceAllFirewallRulesOperationResponse": { + "type": "object", + "description": "An existing operation for replacing the firewall rules", + "properties": { + "operationId": { + "type": "string", + "description": "The operation ID" + } + } + } + }, + "parameters": { + "workspaceNameParameter": { + "name": "workspaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the workspace", + "x-ms-parameter-location": "method" + }, + "ruleNameParameter": { + "type": "string", + "in": "path", + "name": "ruleName", + "description": "The IP firewall rule name", + "required": true, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/integrationRuntime.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/integrationRuntime.json new file mode 100644 index 000000000000..cdd927a52df0 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/integrationRuntime.json @@ -0,0 +1,3023 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-05-01", + "title": "SynapseManagementClient", + "description": "Azure Synapse Analytics APIs" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "type": "oauth2", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}": { + "patch": { + "operationId": "IntegrationRuntimes_Update", + "summary": "Update integration runtime", + "description": "Update an integration runtime", + "tags": [ + "IntegrationRuntime" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/IntegrationRuntimeNameParameter" + }, + { + "name": "updateIntegrationRuntimeRequest", + "description": "The parameters for updating an integration runtime.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateIntegrationRuntimeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/IntegrationRuntimeResource" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Update integration runtime": { + "$ref": "./examples/IntegrationRuntimes_Update.json" + } + } + }, + "get": { + "operationId": "IntegrationRuntimes_Get", + "summary": "Get integration runtime", + "description": "Get an integration runtime", + "tags": [ + "IntegrationRuntime" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/IntegrationRuntimeNameParameter" + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the integration runtime entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/IntegrationRuntimeResource" + } + }, + "304": { + "description": "Not modified." + }, + "default": { + "description": "An error response received from GET integration runtime operation.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get integration runtime": { + "$ref": "./examples/IntegrationRuntimes_Get.json" + } + } + }, + "put": { + "operationId": "IntegrationRuntimes_Create", + "x-ms-long-running-operation": true, + "summary": "Create integration runtime", + "description": "Create an integration runtime", + "tags": [ + "IntegrationRuntime" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/IntegrationRuntimeNameParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the integration runtime entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." + }, + { + "name": "integrationRuntime", + "description": "Integration runtime resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IntegrationRuntimeResource" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/IntegrationRuntimeResource" + } + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from PUT integration runtime operation.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Create integration runtime": { + "$ref": "./examples/IntegrationRuntimes_Create.json" + } + } + }, + "delete": { + "operationId": "IntegrationRuntimes_Delete", + "x-ms-long-running-operation": true, + "summary": "Delete integration runtime", + "description": "Delete an integration runtime", + "tags": [ + "IntegrationRuntime" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/IntegrationRuntimeNameParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from DELETE integration runtime operation.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Delete integration runtime": { + "$ref": "./examples/IntegrationRuntimes_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}/ipAddress": { + "post": { + "operationId": "IntegrationRuntimeNodeIpAddress_Get", + "summary": "Get integration runtime node IP address", + "description": "Get the IP address of an integration runtime node", + "tags": [ + "IntegrationRuntime" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/IntegrationRuntimeNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "nodeName", + "description": "Integration runtime node name", + "required": true + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/IntegrationRuntimeNodeIpAddress" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get integration runtime node IP address": { + "$ref": "./examples/IntegrationRuntimeNodes_GetIpAddress.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/upgrade": { + "post": { + "operationId": "IntegrationRuntimes_Upgrade", + "summary": "Upgrade integration runtime", + "description": "Upgrade an integration runtime", + "tags": [ + "IntegrationRuntime" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/IntegrationRuntimeNameParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Upgrade integration runtime": { + "$ref": "./examples/IntegrationRuntimes_Upgrade.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/getObjectMetadata": { + "post": { + "operationId": "IntegrationRuntimeObjectMetadata_List", + "summary": "Get integration runtime object metadata", + "description": "Get object metadata from an integration runtime", + "tags": [ + "IntegrationRuntime" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/IntegrationRuntimeNameParameter" + }, + { + "name": "getMetadataRequest", + "description": "The parameters for getting a SSIS object metadata.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/GetSsisObjectMetadataRequest" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SsisObjectMetadataListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get integration runtime object metadata": { + "$ref": "./examples/IntegrationRuntimeObjectMetadata_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}": { + "get": { + "operationId": "IntegrationRuntimeNodes_Get", + "summary": "Get integration runtime node", + "description": "Get an integration runtime node", + "tags": [ + "IntegrationRuntime" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/IntegrationRuntimeNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "nodeName", + "description": "Integration runtime node name", + "required": true + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SelfHostedIntegrationRuntimeNode" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get integration runtime node": { + "$ref": "./examples/IntegrationRuntimeNodes_Get.json" + } + } + }, + "patch": { + "operationId": "IntegrationRuntimeNodes_Update", + "summary": "Create integration runtime node", + "description": "Create an integration runtime node", + "tags": [ + "IntegrationRuntime" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/IntegrationRuntimeNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "nodeName", + "description": "Integration runtime node name", + "required": true + }, + { + "name": "updateIntegrationRuntimeNodeRequest", + "description": "The parameters for updating an integration runtime node.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateIntegrationRuntimeNodeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SelfHostedIntegrationRuntimeNode" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Update integration runtime node": { + "$ref": "./examples/IntegrationRuntimeNodes_Update.json" + } + } + }, + "delete": { + "operationId": "IntegrationRuntimeNodes_Delete", + "summary": "Delete integration runtime node", + "description": "Delete an integration runtime node", + "tags": [ + "IntegrationRuntime" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/IntegrationRuntimeNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "nodeName", + "description": "Integration runtime node name", + "required": true + } + ], + "responses": { + "200": { + "description": "OK." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Delete integration runtime node": { + "$ref": "./examples/IntegrationRuntimeNodes_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/syncCredentials": { + "post": { + "operationId": "IntegrationRuntimeCredentials_Sync", + "summary": "Sync integration runtime credentials", + "description": "Force the integration runtime to synchronize credentials across integration runtime nodes, and this will override the credentials across all worker nodes with those available on the dispatcher node. If you already have the latest credential backup file, you should manually import it (preferred) on any self-hosted integration runtime node than using this API directly.", + "tags": [ + "IntegrationRuntime" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/IntegrationRuntimeNameParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Sync credentials": { + "$ref": "./examples/IntegrationRuntimes_SyncCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes": { + "get": { + "operationId": "IntegrationRuntimes_ListByWorkspace", + "summary": "List integration runtimes", + "description": "List all integration runtimes", + "tags": [ + "IntegrationRuntime" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/IntegrationRuntimeListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "List integration runtimes": { + "$ref": "./examples/IntegrationRuntimes_ListByWorkspace.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/getConnectionInfo": { + "post": { + "operationId": "IntegrationRuntimeConnectionInfos_Get", + "summary": "Get integration runtime connection info", + "description": "Get connection info for an integration runtime", + "tags": [ + "IntegrationRuntime" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/IntegrationRuntimeNameParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/IntegrationRuntimeConnectionInfo" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get connection info": { + "$ref": "./examples/IntegrationRuntimes_GetConnectionInfo.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/start": { + "post": { + "operationId": "IntegrationRuntimes_Start", + "summary": "Start integration runtime", + "description": "Start an integration runtime", + "tags": [ + "IntegrationRuntime" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/IntegrationRuntimeNameParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/IntegrationRuntimeStatusResponse" + } + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Start integration runtime": { + "$ref": "./examples/IntegrationRuntimes_Start.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/regenerateAuthKey": { + "post": { + "operationId": "IntegrationRuntimeAuthKeys_Regenerate", + "summary": "Regenerate integration runtime authentication key", + "description": "Regenerate the authentication key for an integration runtime", + "tags": [ + "IntegrationRuntime" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/IntegrationRuntimeNameParameter" + }, + { + "name": "regenerateKeyParameters", + "description": "The parameters for regenerating integration runtime authentication key.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IntegrationRuntimeRegenerateKeyParameters" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/IntegrationRuntimeAuthKeys" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Regenerate auth key": { + "$ref": "./examples/IntegrationRuntimes_RegenerateAuthKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/listAuthKeys": { + "post": { + "operationId": "IntegrationRuntimeAuthKeys_List", + "summary": "List integration runtime authentication keys", + "description": "List authentication keys in an integration runtime", + "tags": [ + "IntegrationRuntime" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/IntegrationRuntimeNameParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/IntegrationRuntimeAuthKeys" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "List auth keys": { + "$ref": "./examples/IntegrationRuntimes_ListAuthKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/monitoringData": { + "post": { + "operationId": "IntegrationRuntimeMonitoringData_List", + "summary": "Get integration runtime monitoring data", + "description": "Get monitoring data for an integration runtime", + "tags": [ + "IntegrationRuntime" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/IntegrationRuntimeNameParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/IntegrationRuntimeMonitoringData" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get monitoring data": { + "$ref": "./examples/IntegrationRuntimeMonitoringData_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/stop": { + "post": { + "operationId": "IntegrationRuntimes_Stop", + "summary": "Stop integration runtime", + "description": "Stop an integration runtime", + "tags": [ + "IntegrationRuntime" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/IntegrationRuntimeNameParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Stop integration runtime": { + "$ref": "./examples/IntegrationRuntimes_Stop.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/refreshObjectMetadata": { + "post": { + "operationId": "IntegrationRuntimeObjectMetadata_Refresh", + "summary": "Refresh integration runtime object metadata", + "description": "Refresh the object metadata in an integration runtime", + "tags": [ + "IntegrationRuntime" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/IntegrationRuntimeNameParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SsisObjectMetadataStatusResponse" + } + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Refresh object metadata": { + "$ref": "./examples/IntegrationRuntimeObjectMetadata_Refresh.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/getStatus": { + "post": { + "operationId": "IntegrationRuntimeStatus_Get", + "summary": "Get integration runtime status", + "description": "Get the integration runtime status", + "tags": [ + "IntegrationRuntime" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/IntegrationRuntimeNameParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/IntegrationRuntimeStatusResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get status": { + "$ref": "./examples/IntegrationRuntimes_GetStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/outboundNetworkDependenciesEndpoints": { + "get": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints", + "description": "Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime.", + "summary": "Gets list of outbound network dependencies for a given Azure-SSIS integration runtime.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/IntegrationRuntimeNameParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get outbound network dependency endpoints": { + "$ref": "./examples/IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/enableInteractiveQuery": { + "post": { + "operationId": "IntegrationRuntimes_EnableInteractiveQuery", + "description": "Enable interactive query in integration runtime", + "tags": [ + "IntegrationRuntime" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/IntegrationRuntimeNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Stop integration runtime": { + "$ref": "./examples/IntegrationRuntimes_EnableInteractiveQuery.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/disableInteractiveQuery": { + "post": { + "operationId": "IntegrationRuntimes_DisableInteractiveQuery", + "description": "Disable interactive query in integration runtime", + "tags": [ + "IntegrationRuntime" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/IntegrationRuntimeNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Stop integration runtime": { + "$ref": "./examples/IntegrationRuntimes_DisableInteractiveQuery.json" + } + } + } + } + }, + "definitions": { + "SubResource": { + "description": "Azure Synapse nested resource, which belongs to a workspace.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/AzureEntityResource" + } + ] + }, + "IntegrationRuntime": { + "description": "Azure Synapse nested object which serves as a compute resource for activities.", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "description": "Type of integration runtime.", + "$ref": "#/definitions/IntegrationRuntimeType" + }, + "description": { + "description": "Integration runtime description.", + "type": "string" + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "IntegrationRuntimeType": { + "description": "The type of integration runtime.", + "type": "string", + "enum": [ + "Managed", + "SelfHosted" + ], + "x-ms-enum": { + "name": "IntegrationRuntimeType", + "modelAsString": true + } + }, + "ManagedIntegrationRuntime": { + "x-ms-discriminator-value": "Managed", + "description": "Managed integration runtime, including managed elastic and managed dedicated integration runtimes.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IntegrationRuntime" + } + ], + "properties": { + "state": { + "description": "Integration runtime state, only valid for managed dedicated integration runtime.", + "$ref": "#/definitions/IntegrationRuntimeState", + "readOnly": true + }, + "typeProperties": { + "description": "Managed integration runtime properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ManagedIntegrationRuntimeTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ManagedIntegrationRuntimeTypeProperties": { + "description": "Managed integration runtime type properties.", + "type": "object", + "properties": { + "computeProperties": { + "description": "The compute resource for managed integration runtime.", + "$ref": "#/definitions/IntegrationRuntimeComputeProperties" + }, + "ssisProperties": { + "description": "SSIS properties for managed integration runtime.", + "$ref": "#/definitions/IntegrationRuntimeSsisProperties" + } + } + }, + "IntegrationRuntimeComputeProperties": { + "description": "The compute resource properties for managed integration runtime.", + "type": "object", + "properties": { + "location": { + "description": "The location for managed integration runtime. The supported regions could be found on https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities", + "type": "string" + }, + "nodeSize": { + "description": "The node size requirement to managed integration runtime.", + "type": "string" + }, + "numberOfNodes": { + "description": "The required number of nodes for managed integration runtime.", + "type": "integer", + "format": "int32", + "minimum": 1 + }, + "maxParallelExecutionsPerNode": { + "description": "Maximum parallel executions count per node for managed integration runtime.", + "type": "integer", + "format": "int32", + "minimum": 1 + }, + "dataFlowProperties": { + "description": "Data flow properties for managed integration runtime.", + "$ref": "#/definitions/IntegrationRuntimeDataFlowProperties" + }, + "vNetProperties": { + "description": "VNet properties for managed integration runtime.", + "$ref": "#/definitions/IntegrationRuntimeVNetProperties" + } + }, + "additionalProperties": { + "type": "object" + } + }, + "IntegrationRuntimeDataFlowProperties": { + "description": "Data flow properties for managed integration runtime.", + "type": "object", + "properties": { + "computeType": { + "description": "Compute type of the cluster which will execute data flow job.", + "type": "string", + "enum": [ + "General", + "MemoryOptimized", + "ComputeOptimized" + ], + "x-ms-enum": { + "name": "DataFlowComputeType", + "modelAsString": true + } + }, + "coreCount": { + "description": "Core count of the cluster which will execute data flow job. Supported values are: 8, 16, 32, 48, 80, 144 and 272.", + "type": "integer", + "format": "int32" + }, + "timeToLive": { + "description": "Time to live (in minutes) setting of the cluster which will execute data flow job.", + "type": "integer", + "format": "int32", + "minimum": 0 + } + }, + "additionalProperties": { + "type": "object" + } + }, + "IntegrationRuntimeVNetProperties": { + "description": "VNet properties for managed integration runtime.", + "type": "object", + "properties": { + "vNetId": { + "description": "The ID of the VNet that this integration runtime will join.", + "type": "string" + }, + "subnet": { + "description": "The name of the subnet this integration runtime will join.", + "type": "string" + }, + "publicIPs": { + "description": "Resource IDs of the public IP addresses that this integration runtime will use.", + "type": "array", + "items": { + "type": "string", + "description": "The ID of the public IP address." + } + }, + "subnetId": { + "description": "The ID of subnet, to which this Azure-SSIS integration runtime will be joined.", + "type": "string" + } + }, + "additionalProperties": { + "type": "object" + } + }, + "IntegrationRuntimeSsisProperties": { + "description": "SSIS properties for managed integration runtime.", + "type": "object", + "properties": { + "catalogInfo": { + "description": "Catalog information for managed dedicated integration runtime.", + "$ref": "#/definitions/IntegrationRuntimeSsisCatalogInfo" + }, + "licenseType": { + "description": "License type for bringing your own license scenario.", + "type": "string", + "enum": [ + "BasePrice", + "LicenseIncluded" + ], + "x-ms-enum": { + "name": "IntegrationRuntimeLicenseType", + "modelAsString": true + } + }, + "customSetupScriptProperties": { + "description": "Custom setup script properties for a managed dedicated integration runtime.", + "$ref": "#/definitions/IntegrationRuntimeCustomSetupScriptProperties" + }, + "dataProxyProperties": { + "description": "Data proxy properties for a managed dedicated integration runtime.", + "$ref": "#/definitions/IntegrationRuntimeDataProxyProperties" + }, + "edition": { + "description": "The edition for the SSIS Integration Runtime", + "type": "string", + "enum": [ + "Standard", + "Enterprise" + ], + "x-ms-enum": { + "name": "IntegrationRuntimeEdition", + "modelAsString": true + } + }, + "expressCustomSetupProperties": { + "description": "Custom setup without script properties for a SSIS integration runtime.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomSetupBase" + } + } + }, + "additionalProperties": { + "type": "object" + } + }, + "SecretBase": { + "description": "The base definition of a secret type.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of the secret." + } + }, + "required": [ + "type" + ] + }, + "SecureString": { + "x-ms-discriminator-value": "SecureString", + "description": "Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecretBase" + } + ], + "properties": { + "value": { + "type": "string", + "description": "Value of secure string." + } + }, + "required": [ + "value" + ] + }, + "IntegrationRuntimeSsisCatalogInfo": { + "description": "Catalog information for managed dedicated integration runtime.", + "type": "object", + "properties": { + "catalogServerEndpoint": { + "description": "The catalog database server URL.", + "type": "string" + }, + "catalogAdminUserName": { + "description": "The administrator user name of catalog database.", + "type": "string", + "minLength": 1, + "maxLength": 128 + }, + "catalogAdminPassword": { + "description": "The password of the administrator user account of the catalog database.", + "$ref": "#/definitions/SecureString" + }, + "catalogPricingTier": { + "description": "The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/en-us/pricing/details/sql-database/", + "type": "string", + "enum": [ + "Basic", + "Standard", + "Premium", + "PremiumRS" + ], + "x-ms-enum": { + "name": "IntegrationRuntimeSsisCatalogPricingTier", + "modelAsString": true + } + } + }, + "additionalProperties": { + "type": "object" + } + }, + "IntegrationRuntimeCustomSetupScriptProperties": { + "description": "Custom setup script properties for a managed dedicated integration runtime.", + "type": "object", + "properties": { + "blobContainerUri": { + "description": "The URI of the Azure blob container that contains the custom setup script.", + "type": "string" + }, + "sasToken": { + "description": "The SAS token of the Azure blob container.", + "$ref": "#/definitions/SecureString" + } + } + }, + "IntegrationRuntimeDataProxyProperties": { + "description": "Data proxy properties for a managed dedicated integration runtime.", + "type": "object", + "properties": { + "connectVia": { + "description": "The self-hosted integration runtime reference.", + "$ref": "#/definitions/EntityReference" + }, + "stagingLinkedService": { + "description": "The staging linked service reference.", + "$ref": "#/definitions/EntityReference" + }, + "path": { + "description": "The path to contain the staged data in the Blob storage.", + "type": "string" + } + } + }, + "CustomSetupBase": { + "description": "The base definition of the custom setup.", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "description": "The type of custom setup.", + "type": "string" + } + }, + "required": [ + "type" + ] + }, + "CmdkeySetup": { + "description": "The custom setup of running cmdkey commands.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CustomSetupBase" + } + ], + "properties": { + "typeProperties": { + "description": "Cmdkey command custom setup type properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CmdkeySetupTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "CmdkeySetupTypeProperties": { + "description": "Cmdkey command custom setup type properties.", + "type": "object", + "properties": { + "targetName": { + "description": "The server name of data source access.", + "type": "object" + }, + "userName": { + "description": "The user name of data source access.", + "type": "object" + }, + "password": { + "description": "The password of data source access.", + "$ref": "#/definitions/SecretBase" + } + }, + "required": [ + "targetName", + "userName", + "password" + ] + }, + "EnvironmentVariableSetup": { + "description": "The custom setup of setting environment variable.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CustomSetupBase" + } + ], + "properties": { + "typeProperties": { + "description": "Add environment variable type properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/EnvironmentVariableSetupTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "EnvironmentVariableSetupTypeProperties": { + "description": "Environment variable custom setup type properties.", + "type": "object", + "properties": { + "variableName": { + "description": "The name of the environment variable.", + "type": "string" + }, + "variableValue": { + "description": "The value of the environment variable.", + "type": "string" + } + }, + "required": [ + "variableName", + "variableValue" + ] + }, + "ComponentSetup": { + "description": "The custom setup of installing 3rd party components.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CustomSetupBase" + } + ], + "properties": { + "typeProperties": { + "description": "Install 3rd party component type properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/LicensedComponentSetupTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "LicensedComponentSetupTypeProperties": { + "description": "Installation of licensed component setup type properties.", + "type": "object", + "properties": { + "componentName": { + "description": "The name of the 3rd party component.", + "type": "string" + }, + "licenseKey": { + "description": "The license key to activate the component.", + "$ref": "#/definitions/SecretBase" + } + }, + "required": [ + "componentName" + ] + }, + "EntityReference": { + "description": "The entity reference.", + "type": "object", + "properties": { + "type": { + "description": "The type of this referenced entity.", + "type": "string", + "enum": [ + "IntegrationRuntimeReference", + "LinkedServiceReference" + ], + "x-ms-enum": { + "name": "IntegrationRuntimeEntityReferenceType", + "modelAsString": true + } + }, + "referenceName": { + "description": "The name of this referenced entity.", + "type": "string" + } + } + }, + "SelfHostedIntegrationRuntime": { + "x-ms-discriminator-value": "SelfHosted", + "description": "Self-hosted integration runtime.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IntegrationRuntime" + } + ], + "properties": { + "typeProperties": { + "description": "When this property is not null, means this is a linked integration runtime. The property is used to access original integration runtime.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SelfHostedIntegrationRuntimeTypeProperties" + } + } + }, + "SelfHostedIntegrationRuntimeTypeProperties": { + "description": "The self-hosted integration runtime properties.", + "type": "object", + "properties": { + "linkedInfo": { + "$ref": "#/definitions/LinkedIntegrationRuntimeType", + "description": "Linked integration runtime type from data factory" + } + } + }, + "LinkedIntegrationRuntimeType": { + "description": "The base definition of a linked integration runtime.", + "discriminator": "authorizationType", + "type": "object", + "properties": { + "authorizationType": { + "type": "string", + "description": "The authorization type for integration runtime sharing." + } + }, + "required": [ + "authorizationType" + ] + }, + "LinkedIntegrationRuntimeKeyAuthorization": { + "x-ms-discriminator-value": "Key", + "description": "The key authorization type integration runtime.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedIntegrationRuntimeType" + } + ], + "properties": { + "key": { + "description": "The key used for authorization.", + "$ref": "#/definitions/SecureString" + } + }, + "required": [ + "key" + ] + }, + "LinkedIntegrationRuntimeRbacAuthorization": { + "x-ms-discriminator-value": "RBAC", + "description": "The role based access control (RBAC) authorization type integration runtime.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedIntegrationRuntimeType" + } + ], + "properties": { + "resourceId": { + "description": "The resource identifier of the integration runtime to be shared.", + "type": "string" + } + }, + "required": [ + "resourceId" + ] + }, + "IntegrationRuntimeStatus": { + "description": "Integration runtime status.", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "description": "Type of integration runtime.", + "$ref": "#/definitions/IntegrationRuntimeType" + }, + "dataFactoryName": { + "description": "The workspace name which the integration runtime belong to.", + "type": "string", + "readOnly": true + }, + "state": { + "description": "The state of integration runtime.", + "$ref": "#/definitions/IntegrationRuntimeState", + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "IntegrationRuntimeState": { + "description": "The state of integration runtime.", + "type": "string", + "readOnly": true, + "enum": [ + "Initial", + "Stopped", + "Started", + "Starting", + "Stopping", + "NeedRegistration", + "Online", + "Limited", + "Offline", + "AccessDenied" + ], + "x-ms-enum": { + "name": "IntegrationRuntimeState", + "modelAsString": true + } + }, + "ManagedIntegrationRuntimeStatus": { + "x-ms-discriminator-value": "Managed", + "description": "Managed integration runtime status.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IntegrationRuntimeStatus" + } + ], + "properties": { + "typeProperties": { + "description": "Managed integration runtime status type properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ManagedIntegrationRuntimeStatusTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ManagedIntegrationRuntimeStatusTypeProperties": { + "description": "Managed integration runtime status type properties.", + "type": "object", + "properties": { + "createTime": { + "description": "The time at which the integration runtime was created, in ISO8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "nodes": { + "description": "The list of nodes for managed integration runtime.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedIntegrationRuntimeNode" + }, + "readOnly": true + }, + "otherErrors": { + "description": "The errors that occurred on this integration runtime.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedIntegrationRuntimeError" + }, + "readOnly": true + }, + "lastOperation": { + "description": "The last operation result that occurred on this integration runtime.", + "$ref": "#/definitions/ManagedIntegrationRuntimeOperationResult", + "readOnly": true + } + } + }, + "ManagedIntegrationRuntimeOperationResult": { + "description": "Properties of managed integration runtime operation result.", + "properties": { + "type": { + "description": "The operation type. Could be start or stop.", + "type": "string", + "readOnly": true + }, + "startTime": { + "description": "The start time of the operation.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "result": { + "description": "The operation result.", + "type": "string", + "readOnly": true + }, + "errorCode": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "parameters": { + "description": "Managed integration runtime error parameters.", + "type": "array", + "items": { + "type": "string", + "description": "Error message parameters." + }, + "readOnly": true + }, + "activityId": { + "description": "The activity id for the operation request.", + "type": "string", + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "ManagedIntegrationRuntimeNode": { + "description": "Properties of integration runtime node.", + "properties": { + "nodeId": { + "description": "The managed integration runtime node id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The managed integration runtime node status.", + "type": "string", + "readOnly": true, + "enum": [ + "Starting", + "Available", + "Recycling", + "Unavailable" + ], + "x-ms-enum": { + "name": "ManagedIntegrationRuntimeNodeStatus", + "modelAsString": true + } + }, + "errors": { + "description": "The errors that occurred on this integration runtime node.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedIntegrationRuntimeError" + } + } + }, + "additionalProperties": { + "type": "object" + } + }, + "ManagedIntegrationRuntimeError": { + "description": "Error definition for managed integration runtime.", + "properties": { + "time": { + "description": "The time when the error occurred.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "code": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "parameters": { + "description": "Managed integration runtime error parameters.", + "type": "array", + "items": { + "type": "string", + "description": "Error message parameters." + }, + "readOnly": true + }, + "message": { + "description": "Error message.", + "type": "string", + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "SelfHostedIntegrationRuntimeStatus": { + "x-ms-discriminator-value": "SelfHosted", + "description": "Self-hosted integration runtime status.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IntegrationRuntimeStatus" + } + ], + "properties": { + "typeProperties": { + "description": "Self-hosted integration runtime status type properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SelfHostedIntegrationRuntimeStatusTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SelfHostedIntegrationRuntimeStatusTypeProperties": { + "description": "Self-hosted integration runtime status type properties.", + "type": "object", + "properties": { + "createTime": { + "description": "The time at which the integration runtime was created, in ISO8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "taskQueueId": { + "description": "The task queue id of the integration runtime.", + "type": "string", + "readOnly": true + }, + "nodeCommunicationChannelEncryptionMode": { + "description": "The node communication Channel encryption mode", + "type": "string", + "readOnly": true + }, + "internalChannelEncryption": { + "description": "It is used to set the encryption mode for node-node communication channel (when more than 2 self-hosted integration runtime nodes exist).", + "type": "string", + "readOnly": true, + "enum": [ + "NotSet", + "SslEncrypted", + "NotEncrypted" + ], + "x-ms-enum": { + "name": "IntegrationRuntimeInternalChannelEncryptionMode", + "modelAsString": true + } + }, + "version": { + "description": "Version of the integration runtime.", + "type": "string", + "readOnly": true + }, + "nodes": { + "description": "The list of nodes for this integration runtime.", + "type": "array", + "items": { + "$ref": "#/definitions/SelfHostedIntegrationRuntimeNode" + } + }, + "scheduledUpdateDate": { + "description": "The date at which the integration runtime will be scheduled to update, in ISO8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updateDelayOffset": { + "description": "The time in the date scheduled by service to update the integration runtime, e.g., PT03H is 3 hours", + "type": "string", + "readOnly": true + }, + "localTimeZoneOffset": { + "description": "The local time zone offset in hours.", + "type": "string", + "readOnly": true + }, + "capabilities": { + "description": "Object with additional information about integration runtime capabilities.", + "type": "object", + "readOnly": true, + "additionalProperties": { + "type": "string" + } + }, + "serviceUrls": { + "description": "The URLs for the services used in integration runtime backend service.", + "type": "array", + "items": { + "description": "The service URL", + "type": "string" + }, + "readOnly": true + }, + "autoUpdate": { + "description": "Whether Self-hosted integration runtime auto update has been turned on.", + "$ref": "#/definitions/IntegrationRuntimeAutoUpdate", + "readOnly": true + }, + "versionStatus": { + "description": "Status of the integration runtime version.", + "type": "string", + "readOnly": true + }, + "links": { + "description": "The list of linked integration runtimes that are created to share with this integration runtime.", + "type": "array", + "items": { + "$ref": "#/definitions/LinkedIntegrationRuntime" + } + }, + "pushedVersion": { + "description": "The version that the integration runtime is going to update to.", + "type": "string", + "readOnly": true + }, + "latestVersion": { + "description": "The latest version on download center.", + "type": "string", + "readOnly": true + }, + "autoUpdateETA": { + "description": "The estimated time when the self-hosted integration runtime will be updated.", + "type": "string", + "format": "date-time", + "readOnly": true + } + } + }, + "IntegrationRuntimeAutoUpdate": { + "description": "The state of integration runtime auto update.", + "type": "string", + "enum": [ + "On", + "Off" + ], + "x-ms-enum": { + "name": "IntegrationRuntimeAutoUpdate", + "modelAsString": true + } + }, + "LinkedIntegrationRuntime": { + "description": "The linked integration runtime information.", + "type": "object", + "properties": { + "name": { + "description": "The name of the linked integration runtime.", + "type": "string", + "readOnly": true + }, + "subscriptionId": { + "description": "The subscription ID for which the linked integration runtime belong to.", + "type": "string", + "readOnly": true + }, + "dataFactoryName": { + "description": "The name of the workspace for which the linked integration runtime belong to.", + "type": "string", + "readOnly": true + }, + "dataFactoryLocation": { + "description": "The location of the workspace for which the linked integration runtime belong to.", + "type": "string", + "readOnly": true + }, + "createTime": { + "description": "The creating time of the linked integration runtime.", + "type": "string", + "format": "date-time", + "readOnly": true + } + } + }, + "SelfHostedIntegrationRuntimeNode": { + "description": "Properties of Self-hosted integration runtime node.", + "properties": { + "nodeName": { + "description": "Name of the integration runtime node.", + "type": "string", + "readOnly": true + }, + "machineName": { + "description": "Machine name of the integration runtime node.", + "type": "string", + "readOnly": true + }, + "hostServiceUri": { + "description": "URI for the host machine of the integration runtime.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the integration runtime node.", + "type": "string", + "readOnly": true, + "enum": [ + "NeedRegistration", + "Online", + "Limited", + "Offline", + "Upgrading", + "Initializing", + "InitializeFailed" + ], + "x-ms-enum": { + "name": "SelfHostedIntegrationRuntimeNodeStatus", + "modelAsString": true + } + }, + "capabilities": { + "description": "The integration runtime capabilities dictionary", + "type": "object", + "readOnly": true, + "additionalProperties": { + "type": "string" + } + }, + "versionStatus": { + "description": "Status of the integration runtime node version.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "Version of the integration runtime node.", + "type": "string", + "readOnly": true + }, + "registerTime": { + "description": "The time at which the integration runtime node was registered in ISO8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "lastConnectTime": { + "description": "The most recent time at which the integration runtime was connected in ISO8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "expiryTime": { + "description": "The time at which the integration runtime will expire in ISO8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "lastStartTime": { + "description": "The time the node last started up.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "lastStopTime": { + "description": "The integration runtime node last stop time.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "lastUpdateResult": { + "description": "The result of the last integration runtime node update.", + "type": "string", + "enum": [ + "None", + "Succeed", + "Fail" + ], + "x-ms-enum": { + "name": "IntegrationRuntimeUpdateResult", + "modelAsString": true + }, + "readOnly": true + }, + "lastStartUpdateTime": { + "description": "The last time for the integration runtime node update start.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "lastEndUpdateTime": { + "description": "The last time for the integration runtime node update end.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "isActiveDispatcher": { + "description": "Indicates whether this node is the active dispatcher for integration runtime requests.", + "type": "boolean", + "readOnly": true + }, + "concurrentJobsLimit": { + "description": "Maximum concurrent jobs on the integration runtime node.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "maxConcurrentJobs": { + "description": "The maximum concurrent jobs in this integration runtime.", + "type": "integer", + "format": "int32", + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "IntegrationRuntimeConnectionInfo": { + "description": "Connection information for encrypting the on-premises data source credentials.", + "type": "object", + "properties": { + "serviceToken": { + "description": "The token generated in service. Callers use this token to authenticate to integration runtime.", + "type": "string", + "readOnly": true + }, + "identityCertThumbprint": { + "description": "The integration runtime SSL certificate thumbprint. Click-Once application uses it to do server validation.", + "type": "string", + "readOnly": true + }, + "hostServiceUri": { + "description": "The on-premises integration runtime host URL.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The integration runtime version.", + "type": "string", + "readOnly": true + }, + "publicKey": { + "description": "The public key for encrypting a credential when transferring the credential to the integration runtime.", + "type": "string", + "readOnly": true + }, + "isIdentityCertExprired": { + "description": "Whether the identity certificate is expired.", + "type": "boolean", + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "IntegrationRuntimeRegenerateKeyParameters": { + "description": "Parameters to regenerate the authentication key.", + "type": "object", + "properties": { + "keyName": { + "description": "The name of the authentication key to regenerate.", + "type": "string", + "enum": [ + "authKey1", + "authKey2" + ], + "x-ms-enum": { + "name": "IntegrationRuntimeAuthKeyName", + "modelAsString": true + } + } + } + }, + "IntegrationRuntimeAuthKeys": { + "description": "The integration runtime authentication keys.", + "type": "object", + "properties": { + "authKey1": { + "type": "string", + "description": "The primary integration runtime authentication key." + }, + "authKey2": { + "type": "string", + "description": "The secondary integration runtime authentication key." + } + } + }, + "IntegrationRuntimeMonitoringData": { + "description": "Get monitoring data response.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Integration runtime name." + }, + "nodes": { + "type": "array", + "description": "Integration runtime node monitoring data.", + "items": { + "$ref": "#/definitions/IntegrationRuntimeNodeMonitoringData" + } + } + } + }, + "IntegrationRuntimeNodeMonitoringData": { + "description": "Monitoring data for integration runtime node.", + "type": "object", + "properties": { + "nodeName": { + "description": "Name of the integration runtime node.", + "type": "string", + "readOnly": true + }, + "availableMemoryInMB": { + "description": "Available memory (MB) on the integration runtime node.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "cpuUtilization": { + "description": "CPU percentage on the integration runtime node.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "concurrentJobsLimit": { + "description": "Maximum concurrent jobs on the integration runtime node.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "concurrentJobsRunning": { + "description": "The number of jobs currently running on the integration runtime node.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "maxConcurrentJobs": { + "description": "The maximum concurrent jobs in this integration runtime.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "sentBytes": { + "description": "Sent bytes on the integration runtime node.", + "type": "number", + "readOnly": true + }, + "receivedBytes": { + "description": "Received bytes on the integration runtime node.", + "type": "number", + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "IntegrationRuntimeNodeIpAddress": { + "type": "object", + "description": "The IP address of self-hosted integration runtime node.", + "properties": { + "ipAddress": { + "description": "The IP address of self-hosted integration runtime node.", + "type": "string", + "readOnly": true + } + } + }, + "SsisObjectMetadataListResponse": { + "type": "object", + "description": "A list of SSIS object metadata.", + "properties": { + "value": { + "type": "array", + "description": "List of SSIS object metadata.", + "items": { + "$ref": "#/definitions/SsisObjectMetadata" + } + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of results, if any remaining results exist." + } + } + }, + "SsisObjectMetadata": { + "type": "object", + "description": "SSIS object metadata.", + "discriminator": "type", + "properties": { + "type": { + "description": "Type of metadata.", + "$ref": "#/definitions/SsisObjectMetadataType" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "Metadata id." + }, + "name": { + "type": "string", + "description": "Metadata name." + }, + "description": { + "type": "string", + "description": "Metadata description." + } + }, + "required": [ + "type" + ] + }, + "SsisObjectMetadataType": { + "description": "The type of SSIS object metadata.", + "type": "string", + "enum": [ + "Folder", + "Project", + "Package", + "Environment" + ], + "x-ms-enum": { + "name": "SsisObjectMetadataType", + "modelAsString": true + } + }, + "SsisFolder": { + "x-ms-discriminator-value": "Folder", + "type": "object", + "description": "Ssis folder.", + "allOf": [ + { + "$ref": "#/definitions/SsisObjectMetadata" + } + ] + }, + "SsisProject": { + "x-ms-discriminator-value": "Project", + "type": "object", + "description": "Ssis project.", + "allOf": [ + { + "$ref": "#/definitions/SsisObjectMetadata" + } + ], + "properties": { + "folderId": { + "type": "integer", + "format": "int64", + "description": "Folder id which contains project." + }, + "version": { + "type": "integer", + "format": "int64", + "description": "Project version." + }, + "environmentRefs": { + "type": "array", + "description": "Environment reference in project", + "items": { + "$ref": "#/definitions/SsisEnvironmentReference" + } + }, + "parameters": { + "type": "array", + "description": "Parameters in project", + "items": { + "$ref": "#/definitions/SsisParameter" + } + } + } + }, + "SsisPackage": { + "x-ms-discriminator-value": "Package", + "type": "object", + "description": "Ssis Package.", + "allOf": [ + { + "$ref": "#/definitions/SsisObjectMetadata" + } + ], + "properties": { + "folderId": { + "type": "integer", + "format": "int64", + "description": "Folder id which contains package." + }, + "projectVersion": { + "type": "integer", + "format": "int64", + "description": "Project version which contains package." + }, + "projectId": { + "type": "integer", + "format": "int64", + "description": "Project id which contains package." + }, + "parameters": { + "type": "array", + "description": "Parameters in package", + "items": { + "$ref": "#/definitions/SsisParameter" + } + } + } + }, + "SsisEnvironment": { + "x-ms-discriminator-value": "Environment", + "type": "object", + "description": "Ssis environment.", + "allOf": [ + { + "$ref": "#/definitions/SsisObjectMetadata" + } + ], + "properties": { + "folderId": { + "type": "integer", + "format": "int64", + "description": "Folder id which contains environment." + }, + "variables": { + "type": "array", + "description": "Variable in environment", + "items": { + "$ref": "#/definitions/SsisVariable" + } + } + } + }, + "SsisParameter": { + "type": "object", + "description": "Ssis parameter.", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "Parameter id." + }, + "name": { + "type": "string", + "description": "Parameter name." + }, + "description": { + "type": "string", + "description": "Parameter description." + }, + "dataType": { + "type": "string", + "description": "Parameter type." + }, + "required": { + "type": "boolean", + "description": "Whether parameter is required." + }, + "sensitive": { + "type": "boolean", + "description": "Whether parameter is sensitive." + }, + "designDefaultValue": { + "type": "string", + "description": "Design default value of parameter." + }, + "defaultValue": { + "type": "string", + "description": "Default value of parameter." + }, + "sensitiveDefaultValue": { + "type": "string", + "description": "Default sensitive value of parameter." + }, + "valueType": { + "type": "string", + "description": "Parameter value type." + }, + "valueSet": { + "type": "boolean", + "description": "Parameter value set." + }, + "variable": { + "type": "string", + "description": "Parameter reference variable." + } + } + }, + "SsisVariable": { + "type": "object", + "description": "Ssis variable.", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "Variable id." + }, + "name": { + "type": "string", + "description": "Variable name." + }, + "description": { + "type": "string", + "description": "Variable description." + }, + "dataType": { + "type": "string", + "description": "Variable type." + }, + "sensitive": { + "type": "boolean", + "description": "Whether variable is sensitive." + }, + "value": { + "type": "string", + "description": "Variable value." + }, + "sensitiveValue": { + "type": "string", + "description": "Variable sensitive value." + } + } + }, + "SsisEnvironmentReference": { + "type": "object", + "description": "Ssis environment reference.", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "Environment reference id." + }, + "environmentFolderName": { + "type": "string", + "description": "Environment folder name." + }, + "environmentName": { + "type": "string", + "description": "Environment name." + }, + "referenceType": { + "type": "string", + "description": "Reference type" + } + } + }, + "UpdateIntegrationRuntimeRequest": { + "description": "Update integration runtime request.", + "type": "object", + "properties": { + "autoUpdate": { + "description": "Enables or disables the auto-update feature of the self-hosted integration runtime. See https://go.microsoft.com/fwlink/?linkid=854189.", + "$ref": "#/definitions/IntegrationRuntimeAutoUpdate" + }, + "updateDelayOffset": { + "description": "The time offset (in hours) in the day, e.g., PT03H is 3 hours. The integration runtime auto update will happen on that time.", + "type": "string" + } + } + }, + "IntegrationRuntimeResource": { + "description": "Integration runtime resource type.", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/IntegrationRuntime", + "description": "Integration runtime properties." + } + }, + "required": [ + "properties" + ] + }, + "GetSsisObjectMetadataRequest": { + "type": "object", + "description": "The request payload of get SSIS object metadata.", + "properties": { + "metadataPath": { + "type": "string", + "description": "Metadata path." + } + } + }, + "UpdateIntegrationRuntimeNodeRequest": { + "description": "Update integration runtime node request.", + "type": "object", + "properties": { + "concurrentJobsLimit": { + "description": "The number of concurrent jobs permitted to run on the integration runtime node. Values between 1 and maxConcurrentJobs(inclusive) are allowed.", + "type": "integer", + "format": "int32", + "minimum": 1 + } + } + }, + "IntegrationRuntimeListResponse": { + "description": "A list of integration runtime resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of integration runtimes.", + "items": { + "$ref": "#/definitions/IntegrationRuntimeResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "IntegrationRuntimeStatusResponse": { + "description": "Integration runtime status response.", + "properties": { + "name": { + "type": "string", + "description": "The integration runtime name.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/IntegrationRuntimeStatus", + "description": "Integration runtime properties." + } + }, + "required": [ + "properties" + ] + }, + "SsisObjectMetadataStatusResponse": { + "type": "object", + "description": "The status of the operation.", + "properties": { + "status": { + "type": "string", + "description": "The status of the operation." + }, + "name": { + "type": "string", + "description": "The operation name." + }, + "properties": { + "type": "string", + "description": "The operation properties." + }, + "error": { + "type": "string", + "description": "The operation error message." + } + } + }, + "IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse": { + "description": "Azure-SSIS integration runtime outbound network dependency endpoints.", + "type": "object", + "properties": { + "value": { + "description": "The list of outbound network dependency endpoints.", + "type": "array", + "items": { + "$ref": "#/definitions/IntegrationRuntimeOutboundNetworkDependenciesCategoryEndpoint" + } + } + } + }, + "IntegrationRuntimeOutboundNetworkDependenciesCategoryEndpoint": { + "description": "Azure-SSIS integration runtime outbound network dependency endpoints for one category.", + "type": "object", + "properties": { + "category": { + "description": "The category of outbound network dependency.", + "type": "string" + }, + "endpoints": { + "description": "The endpoints for outbound network dependency.", + "type": "array", + "items": { + "$ref": "#/definitions/IntegrationRuntimeOutboundNetworkDependenciesEndpoint" + } + } + } + }, + "IntegrationRuntimeOutboundNetworkDependenciesEndpoint": { + "description": "The endpoint for Azure-SSIS integration runtime outbound network dependency.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name of endpoint.", + "type": "string" + }, + "endpointDetails": { + "description": "The details of endpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails" + } + } + } + }, + "IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails": { + "description": "The details of Azure-SSIS integration runtime outbound network dependency endpoint.", + "type": "object", + "properties": { + "port": { + "description": "The port of endpoint.", + "type": "integer", + "format": "int32" + } + } + } + }, + "parameters": { + "IntegrationRuntimeNameParameter": { + "name": "integrationRuntimeName", + "type": "string", + "required": true, + "in": "path", + "description": "Integration runtime name", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/keys.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/keys.json new file mode 100644 index 000000000000..d0882ebc5cbf --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/keys.json @@ -0,0 +1,294 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-05-01", + "title": "SynapseManagementClient", + "description": "Azure Synapse Analytics APIs" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "type": "oauth2", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys": { + "get": { + "operationId": "Keys_ListByWorkspace", + "description": "Returns a list of keys in a workspace", + "tags": [ + "Keys" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/KeyInfoListResult" + }, + "description": "The list of workspace keys." + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "*** Error Responses: ***\n\n * 400 BadRequest - Invalid request to create a Workspace Key.\n\n * 500 InternalServerError- Some error occurred while creating Workspace Key." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List keys in workspace": { + "$ref": "./examples/ListKeysInWorkspace.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys/{keyName}": { + "get": { + "operationId": "Keys_Get", + "description": "Gets a workspace key", + "tags": [ + "Keys" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "$ref": "#/parameters/keyNameParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/Key" + }, + "description": "Workspace Key details" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "*** Error Responses: ***\n\n * 500 InternalServerError- Some error occurred while trying to get details for Workspace Keys." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get a workspace key": { + "$ref": "./examples/GetKey.json" + } + } + }, + "put": { + "operationId": "Keys_CreateOrUpdate", + "description": "Creates or updates a workspace key", + "tags": [ + "Keys" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "$ref": "#/parameters/keyNameParameter" + }, + { + "schema": { + "$ref": "#/definitions/Key" + }, + "in": "body", + "name": "keyProperties", + "required": true, + "description": "Key put request properties" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/Key" + }, + "description": "Workspace Key resource details" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "*** Error Responses: ***\n\n * 400 BadRequest - Invalid request to create a Workspace Key.\n\n * 500 InternalServerError- Some error occurred while creating Workspace Key." + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Create or update a workspace key": { + "$ref": "./examples/CreateOrUpdateKey.json" + } + } + }, + "delete": { + "operationId": "Keys_Delete", + "description": "Deletes a workspace key", + "tags": [ + "Keys" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "$ref": "#/parameters/keyNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Key" + } + }, + "204": { + "description": "Keys resource not found." + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "*** Error Responses: ***\n\n * 500 InternalServerError- Some error occurred while deleting Workspace Key." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Delete a workspace key": { + "$ref": "./examples/DeleteKey.json" + } + } + } + } + }, + "definitions": { + "KeyInfoListResult": { + "description": "List of keys", + "type": "object", + "properties": { + "nextLink": { + "description": "Link to the next page of results", + "type": "string" + }, + "value": { + "description": "List of keys", + "type": "array", + "items": { + "$ref": "#/definitions/Key" + } + } + } + }, + "Key": { + "description": "A workspace key", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Keys resource properties", + "$ref": "#/definitions/KeyProperties", + "x-ms-client-flatten": true + } + } + }, + "KeyProperties": { + "description": "Key properties", + "type": "object", + "properties": { + "isActiveCMK": { + "type": "boolean", + "description": "Used to activate the workspace after a customer managed key is provided." + }, + "keyVaultUrl": { + "type": "string", + "description": "The Key Vault Url of the workspace key." + } + } + } + }, + "parameters": { + "keyNameParameter": { + "name": "keyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the workspace key", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/library.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/library.json new file mode 100644 index 000000000000..b80a751b7e7e --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/library.json @@ -0,0 +1,185 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-05-01", + "title": "SynapseManagementClient", + "description": "Azure Synapse Analytics APIs" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "type": "oauth2", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/libraries/{libraryName}": { + "get": { + "operationId": "Library_Get", + "summary": "Get library by name.", + "description": "Get library by name in a workspace.", + "tags": [ + "Libraries" + ], + "deprecated": false, + "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/LibraryNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/LibraryResource" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get Library by name": { + "$ref": "./examples/Library_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/libraries": { + "get": { + "operationId": "Libraries_ListByWorkspace", + "summary": "List the libraries in a workspace.", + "description": "List libraries in a workspace.", + "tags": [ + "Libraries" + ], + "deprecated": false, + "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": "./workspace.json#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/LibraryListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "List libraries in a workspace": { + "$ref": "./examples/Libraries_ListByWorkspace.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "parameters": { + "LibraryNameParameter": { + "name": "libraryName", + "in": "path", + "required": true, + "type": "string", + "description": "Library name", + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "LibraryListResponse": { + "description": "A list of Library resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of Library.", + "items": { + "$ref": "#/definitions/LibraryResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "LibraryResource": { + "description": "Library response details", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "./bigDataPool.json#/definitions/LibraryInfo", + "description": "Library/package properties.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ] + }, + "SubResource": { + "description": "Azure Synapse nested resource, which belongs to a workspace.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/AzureEntityResource" + } + ] + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/operations.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/operations.json new file mode 100644 index 000000000000..7d27c7f69642 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/operations.json @@ -0,0 +1,402 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-05-01", + "title": "SynapseManagementClient", + "description": "Azure Synapse Analytics APIs" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "type": "oauth2", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "paths": { + "/providers/Microsoft.Synapse/operations": { + "get": { + "operationId": "Operations_List", + "summary": "All operations", + "description": "Get all available operations", + "tags": [ + "Operations" + ], + "deprecated": false, + "consumes": [], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailableRpOperation" + } + }, + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "x-ms-examples": { + "Get available operations": { + "$ref": "./examples/GetAvailableOperations.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/operationResults/{operationId}": { + "get": { + "operationId": "Operations_GetLocationHeaderResult", + "summary": "Get operation result", + "description": "Get the result of an operation", + "tags": [ + "Operations" + ], + "deprecated": false, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "operationId", + "description": "Operation ID", + "required": true + } + ], + "responses": { + "200": { + "description": "" + }, + "201": { + "description": "" + }, + "202": { + "description": "" + }, + "204": { + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "x-ms-examples": { + "Get location header result": { + "$ref": "./examples/GetLocationHeader.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/operationStatuses/{operationId}": { + "get": { + "operationId": "Operations_GetAzureAsyncHeaderResult", + "summary": "Get operation status", + "description": "Get the status of an operation", + "tags": [ + "Operations" + ], + "deprecated": false, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "operationId", + "description": "Operation ID", + "required": true + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/OperationResource" + }, + "description": "" + }, + "404": { + "description": "Not found" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "x-ms-examples": { + "Get azure async operation header result": { + "$ref": "./examples/GetAzureAsyncOperationHeader.json" + } + } + } + } + }, + "definitions": { + "AvailableRpOperation": { + "type": "object", + "description": "An operation that is available in this resource provider", + "properties": { + "display": { + "$ref": "#/definitions/AvailableRpOperationDisplayInfo", + "description": "Display properties of the operation" + }, + "isDataAction": { + "type": "string", + "description": "Whether this operation is a data action" + }, + "name": { + "type": "string", + "description": "Operation name" + }, + "properties": { + "$ref": "#/definitions/OperationMetaPropertyInfo", + "description": "Operation properties", + "x-ms-client-flatten": true + }, + "origin": { + "type": "string", + "description": "Operation origin" + } + } + }, + "OperationResource": { + "type": "object", + "description": "An operation", + "properties": { + "id": { + "type": "string", + "description": "Operation ID" + }, + "name": { + "type": "string", + "description": "Operation name" + }, + "status": { + "enum": [ + "InProgress", + "Succeeded", + "Failed", + "Canceled" + ], + "description": "Operation status", + "type": "string", + "x-ms-enum": { + "name": "OperationStatus", + "modelAsString": true + } + }, + "properties": { + "type": "object", + "description": "Operation properties", + "x-ms-client-flatten": true + }, + "error": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorDetail", + "description": "Errors from the operation" + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Operation start time" + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "Operation start time" + }, + "percentComplete": { + "type": "number", + "description": "Completion percentage of the operation" + } + } + }, + "AvailableRpOperationDisplayInfo": { + "type": "object", + "description": "Description of an available operation", + "properties": { + "description": { + "type": "string", + "description": "Operation description" + }, + "resource": { + "type": "string", + "description": "Resource type" + }, + "provider": { + "type": "string", + "description": "Resource provider name" + }, + "operation": { + "type": "string", + "description": "Operation name" + } + } + }, + "OperationMetaPropertyInfo": { + "type": "object", + "description": "What is this?", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/OperationMetaServiceSpecification", + "description": "Operation service specification" + } + } + }, + "OperationMetaServiceSpecification": { + "type": "object", + "description": "What is this?", + "properties": { + "metricSpecifications": { + "type": "array", + "description": "Service metric specifications", + "items": { + "$ref": "#/definitions/OperationMetaMetricSpecification" + } + }, + "logSpecifications": { + "type": "array", + "description": "Service log specifications", + "items": { + "$ref": "#/definitions/OperationMetaLogSpecification" + } + } + } + }, + "OperationMetaMetricSpecification": { + "type": "object", + "description": "What is this?", + "properties": { + "sourceMdmNamespace": { + "type": "string", + "description": "The source MDM namespace" + }, + "displayName": { + "type": "string", + "description": "Metric display name" + }, + "name": { + "type": "string", + "description": "Metric unique name" + }, + "aggregationType": { + "type": "string", + "description": "Metric aggregation type" + }, + "displayDescription": { + "type": "string", + "description": "Metric description" + }, + "sourceMdmAccount": { + "type": "string", + "description": "The source MDM account" + }, + "enableRegionalMdmAccount": { + "type": "boolean", + "description": "Whether the regional MDM account is enabled" + }, + "unit": { + "type": "string", + "description": "Metric units" + }, + "dimensions": { + "type": "array", + "description": "Metric dimensions", + "items": { + "$ref": "#/definitions/OperationMetaMetricDimensionSpecification" + } + }, + "supportsInstanceLevelAggregation": { + "type": "boolean", + "description": "Whether the metric supports instance-level aggregation" + }, + "metricFilterPattern": { + "type": "string", + "description": "Metric filter" + } + } + }, + "OperationMetaLogSpecification": { + "type": "object", + "description": "What is this?", + "properties": { + "displayName": { + "type": "string", + "description": "Log display name" + }, + "blobDuration": { + "type": "string", + "description": "Time range the log covers" + }, + "name": { + "type": "string", + "description": "Log unique name" + } + } + }, + "OperationMetaMetricDimensionSpecification": { + "type": "object", + "description": "What is this?", + "properties": { + "displayName": { + "type": "string", + "description": "Dimension display name" + }, + "name": { + "type": "string", + "description": "Dimension unique name" + }, + "toBeExportedForShoebox": { + "type": "boolean", + "description": "Whether this metric should be exported for Shoebox" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/privateEndpointConnections.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/privateEndpointConnections.json new file mode 100644 index 000000000000..ec0146d59784 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/privateEndpointConnections.json @@ -0,0 +1,219 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-05-01", + "title": "SynapseManagementClient", + "description": "Azure Synapse Analytics APIs" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "type": "oauth2", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection.", + "required": true, + "type": "string" + } + ], + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Gets a private endpoint connection.", + "operationId": "PrivateEndpointConnections_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "schema": { + "$ref": "../../../../common/v1/privateEndpointConnection.json#/definitions/PrivateEndpointConnection" + }, + "description": "Private endpoint connection" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "x-ms-examples": { + "Get private endpoint connection": { + "$ref": "./examples/GetPrivateEndpointConnection.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Approve or reject a private endpoint connection.", + "operationId": "PrivateEndpointConnections_Create", + "parameters": [ + { + "name": "request", + "in": "body", + "description": "Request body of private endpoint connection to create.", + "required": true, + "schema": { + "$ref": "../../../../common/v1/privateEndpointConnection.json#/definitions/PrivateEndpointConnection" + } + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "schema": { + "$ref": "../../../../common/v1/privateEndpointConnection.json#/definitions/PrivateEndpointConnection" + }, + "description": "Private endpoint connection" + }, + "201": { + "schema": { + "$ref": "../../../../common/v1/privateEndpointConnection.json#/definitions/PrivateEndpointConnection" + }, + "description": "Private endpoint connection" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Approve private endpoint connection": { + "$ref": "./examples/ApprovePrivateEndpointConnection.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Delete a private endpoint connection.", + "operationId": "PrivateEndpointConnections_Delete", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "responses": { + "200": { + "description": "" + }, + "202": { + "schema": { + "$ref": "./operations.json#/definitions/OperationResource" + }, + "description": "Operation details" + }, + "204": { + "description": "Deletion completed" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "x-ms-examples": { + "Delete private endpoint connection": { + "$ref": "./examples/DeletePrivateEndpointConnection.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Lists private endpoint connection in workspace.", + "operationId": "PrivateEndpointConnections_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + } + ], + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "schema": { + "$ref": "../../../../common/v1/privateEndpointConnection.json#/definitions/PrivateEndpointConnectionList" + }, + "description": "Private endpoint connection" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "x-ms-examples": { + "List private endpoint connections in workspace": { + "$ref": "./examples/ListPrivateEndpointConnections.json" + } + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/privateLinkResources.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/privateLinkResources.json new file mode 100644 index 000000000000..6a7e6256618a --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/privateLinkResources.json @@ -0,0 +1,307 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-05-01", + "title": "SynapseManagementClient", + "description": "Azure Synapse Analytics APIs" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "type": "oauth2", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/privateLinkResources": { + "get": { + "operationId": "PrivateLinkResources_List", + "summary": "Private Link Resources", + "description": "Get all private link resources for a workspaces", + "tags": [ + "PrivateLinkResources" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + } + ], + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + }, + "description": "List of private link resources" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "x-ms-examples": { + "Get private link resources for workspace": { + "$ref": "./examples/ListPrivateLinkResources.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/privateLinkResources/{privateLinkResourceName}": { + "get": { + "operationId": "PrivateLinkResources_Get", + "summary": "Get Private Link Resource", + "description": "Get private link resource in workspace", + "tags": [ + "PrivateLinkResources" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "$ref": "#/parameters/privateLinkResourceNameParameter" + } + ], + "consumes": [], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "Private link resource details" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "x-ms-examples": { + "Get private link resources for workspace": { + "$ref": "./examples/GetPrivateLinkResource.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/privateLinkHubs/{privateLinkHubName}/privateLinkResources": { + "get": { + "operationId": "PrivateLinkHubPrivateLinkResources_List", + "summary": "Private Link Resources", + "description": "Get all private link resources for a private link hub", + "tags": [ + "PrivateLinkHubPrivateLinkResources" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/privateLinkHubNameParameter" + } + ], + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + }, + "description": "List of private link resources" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "x-ms-examples": { + "Get private link resources for private link hub": { + "$ref": "./examples/ListPrivateLinkHubPrivateLinkResources.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/privateLinkHubs/{privateLinkHubName}/privateLinkResources/{privateLinkResourceName}": { + "get": { + "operationId": "PrivateLinkHubPrivateLinkResources_Get", + "summary": "Get Private Link Hub Private Link Resource", + "description": "Get private link resource in private link hub", + "tags": [ + "PrivateLinkHubPrivateLinkResources" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/privateLinkHubNameParameter" + }, + { + "$ref": "#/parameters/privateLinkResourceNameParameter" + } + ], + "consumes": [], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "Private link resource details" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "x-ms-examples": { + "Get private link resources for private link hub": { + "$ref": "./examples/GetPrivateLinkHubPrivateLinkResource.json" + } + } + } + } + }, + "definitions": { + "PrivateLinkResourceListResult": { + "description": "A list of private link resources", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "PrivateLinkResource": { + "description": "A private link resource", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "The private link resource properties.", + "readOnly": true + } + } + }, + "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": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "Required DNS zone names of the the private link resource." + } + } + } + }, + "parameters": { + "privateLinkResourceNameParameter": { + "name": "privateLinkResourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private link resource", + "x-ms-parameter-location": "method" + }, + "privateLinkHubNameParameter": { + "name": "privateLinkHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private link hub", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/privatelinkhub.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/privatelinkhub.json new file mode 100644 index 000000000000..77497315c337 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/privatelinkhub.json @@ -0,0 +1,488 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-05-01", + "title": "SynapseManagementClient", + "description": "Azure Synapse Analytics APIs" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "type": "oauth2", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/privateLinkHubs": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "get": { + "operationId": "PrivateLinkHubs_ListByResourceGroup", + "description": "Returns a list of privateLinkHubs in a resource group", + "tags": [ + "PrivateLinkHubs" + ], + "deprecated": false, + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/PrivateLinkHubInfoListResult" + }, + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List privateLinkHubs in resource group": { + "$ref": "./examples/ListPrivateLinkHubsInResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/privateLinkHubs/{privateLinkHubName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/PrivateLinkHubNameParameter" + } + ], + "get": { + "operationId": "PrivateLinkHubs_Get", + "description": "Gets a privateLinkHub", + "tags": [ + "PrivateLinkHubs" + ], + "deprecated": false, + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/PrivateLinkHub" + }, + "description": "PrivateLinkHub resource details" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "*** Error Responses: ***\n\n * 500 InternalServerError- Some error occurred while trying to get details for PrivateLinkHub." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get a privateLinkHub": { + "$ref": "./examples/GetPrivateLinkHub.json" + } + } + }, + "patch": { + "operationId": "PrivateLinkHubs_Update", + "description": "Updates a privateLinkHub", + "tags": [ + "PrivateLinkHubs" + ], + "deprecated": false, + "parameters": [ + { + "schema": { + "$ref": "#/definitions/PrivateLinkHubPatchInfo" + }, + "in": "body", + "name": "privateLinkHubPatchInfo", + "required": true, + "description": "PrivateLinkHub patch request properties" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/PrivateLinkHub" + }, + "description": "PrivateLinkHub resource details" + }, + "201": { + "schema": { + "$ref": "#/definitions/PrivateLinkHub" + }, + "description": "PrivateLinkHub resource details" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "*** Error Responses: ***\n\n * 400 BadRequest - Invalid request to create a PrivateLinkHub.\n\n * 500 InternalServerError- Some error occurred while creating PrivateLinkHub." + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Update a privateLinkHub": { + "$ref": "./examples/UpdatePrivateLinkHub.json" + } + } + }, + "put": { + "operationId": "PrivateLinkHubs_CreateOrUpdate", + "description": "Creates or updates a privateLinkHub", + "tags": [ + "PrivateLinkHubs" + ], + "deprecated": false, + "parameters": [ + { + "description": "PrivateLinkHub create or update request properties", + "schema": { + "$ref": "#/definitions/PrivateLinkHub" + }, + "in": "body", + "name": "privateLinkHubInfo", + "required": true + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/PrivateLinkHub" + }, + "description": "PrivateLinkHub resource details" + }, + "201": { + "schema": { + "$ref": "#/definitions/PrivateLinkHub" + }, + "description": "PrivateLinkHub resource details" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "*** Error Responses: ***\n\n * 400 BadRequest - Invalid request to create a PrivateLinkHub.\n\n * 500 InternalServerError- Some error occurred while creating PrivateLinkHub." + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Create or update a privateLinkHub": { + "$ref": "./examples/CreateOrUpdatePrivateLinkHub.json" + } + } + }, + "delete": { + "operationId": "PrivateLinkHubs_Delete", + "description": "Deletes a privateLinkHub", + "tags": [ + "PrivateLinkHubs" + ], + "deprecated": false, + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "PrivateLinkHub resource not found." + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "*** Error Responses: ***\n\n * 500 InternalServerError- Some error occurred while deleting PrivateLinkHub." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a privateLinkHub": { + "$ref": "./examples/DeletePrivateLinkHub.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Synapse/privateLinkHubs": { + "get": { + "operationId": "PrivateLinkHubs_List", + "description": "Returns a list of privateLinkHubs in a subscription", + "tags": [ + "PrivateLinkHubs" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/PrivateLinkHubInfoListResult" + }, + "description": "PrivateLinkHub resource details" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List privateLinkHubs in subscription": { + "$ref": "./examples/ListPrivateLinkHubsInSubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/privateLinkHubs/{privateLinkHubName}/privateEndpointConnections": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/PrivateLinkHubNameParameter" + } + ], + "get": { + "operationId": "PrivateEndpointConnectionsPrivateLinkHub_List", + "description": "Get all PrivateEndpointConnections in the PrivateLinkHub", + "tags": [ + "PrivateLinkHubs", + "PrivateEndpointConnections" + ], + "deprecated": false, + "responses": { + "200": { + "schema": { + "$ref": "../../../../common/v1/privateEndpointConnection.json#/definitions/PrivateEndpointConnectionForPrivateLinkHub_ResourceCollectionResponse" + }, + "description": "List of PrivateEndpointConnections in PrivateLinkHub" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a privateLinkHub": { + "$ref": "./examples/PrivateEndpointConnectionsPrivateLinkHub_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/privateLinkHubs/{privateLinkHubName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/PrivateLinkHubNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the privateEndpointConnection", + "x-ms-parameter-location": "method" + } + ], + "get": { + "operationId": "PrivateEndpointConnectionsPrivateLinkHub_Get", + "description": "Get all PrivateEndpointConnection in the PrivateLinkHub by name", + "tags": [ + "PrivateLinkHubs", + "PrivateEndpointConnections" + ], + "deprecated": false, + "responses": { + "200": { + "schema": { + "$ref": "../../../../common/v1/privateEndpointConnection.json#/definitions/PrivateEndpointConnectionForPrivateLinkHub" + }, + "description": "PrivateEndpointConnection in PrivateLinkHub" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get a privateLinkHub": { + "$ref": "./examples/PrivateEndpointConnectionsPrivateLinkHub_Get.json" + } + } + } + } + }, + "definitions": { + "PrivateLinkHubInfoListResult": { + "description": "List of privateLinkHubs", + "type": "object", + "properties": { + "nextLink": { + "description": "Link to the next page of results", + "type": "string" + }, + "value": { + "description": "List of privateLinkHubs", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkHub" + } + } + } + }, + "PrivateLinkHub": { + "description": "A privateLinkHub", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "PrivateLinkHub resource properties", + "$ref": "#/definitions/PrivateLinkHubProperties", + "x-ms-client-flatten": true + } + } + }, + "PrivateLinkHubPatchInfo": { + "description": "PrivateLinkHub patch details", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags", + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + } + }, + "PrivateLinkHubProperties": { + "description": "PrivateLinkHub properties", + "type": "object", + "properties": { + "provisioningState": { + "description": "PrivateLinkHub provisioning state", + "type": "string" + }, + "privateEndpointConnections": { + "description": "List of private endpoint connections", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnectionForPrivateLinkHubBasic" + } + } + } + }, + "PrivateEndpointConnectionForPrivateLinkHubBasic": { + "description": "Private Endpoint Connection For Private Link Hub - Basic", + "type": "object", + "properties": { + "id": { + "description": "identifier", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of private endpoint connection for private link hub", + "type": "object", + "$ref": "../../../../common/v1/privateEndpointConnection.json#/definitions/PrivateEndpointConnectionProperties", + "x-ms-client-flatten": true + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/sqlPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/sqlPool.json new file mode 100644 index 000000000000..c621add9b4e7 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/sqlPool.json @@ -0,0 +1,7620 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-05-01", + "title": "SynapseManagementClient", + "description": "Azure Synapse Analytics APIs" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "type": "oauth2", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}": { + "get": { + "operationId": "SqlPools_Get", + "summary": "Get SQL pool", + "description": "Get SQL pool properties", + "tags": [ + "SqlPools" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/SqlPool" + }, + "description": "OK" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get a SQL Analytics pool": { + "$ref": "./examples/GetSqlPool.json" + } + } + }, + "patch": { + "operationId": "SqlPools_Update", + "summary": "Update SQL pool", + "description": "Apply a partial update to a SQL pool", + "tags": [ + "SqlPools" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "schema": { + "$ref": "#/definitions/SqlPoolPatchInfo" + }, + "in": "body", + "name": "sqlPoolInfo", + "description": "The updated SQL pool properties", + "required": true + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/SqlPool" + }, + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Update a SQL Analytics pool": { + "$ref": "./examples/UpdateSqlPool.json" + } + } + }, + "put": { + "operationId": "SqlPools_Create", + "summary": "Create SQL pool", + "description": "Create a SQL pool", + "tags": [ + "SqlPools" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "schema": { + "$ref": "#/definitions/SqlPool" + }, + "in": "body", + "name": "sqlPoolInfo", + "description": "The SQL pool to create", + "required": true + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/SqlPool" + }, + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "404": { + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Create a SQL Analytics pool": { + "$ref": "./examples/CreateSqlPool.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "delete": { + "operationId": "SqlPools_Delete", + "summary": "Delete SQL pool", + "description": "Delete a SQL pool", + "tags": [ + "SqlPools" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + } + ], + "responses": { + "200": { + "schema": { + "type": "object" + }, + "description": "OK" + }, + "202": { + "schema": { + "type": "object" + }, + "description": "Accepted" + }, + "204": { + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Delete a SQL Analytics pool": { + "$ref": "./examples/DeleteSqlPool.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools": { + "get": { + "operationId": "SqlPools_ListByWorkspace", + "summary": "List SQL pools", + "description": "List all SQL pools", + "tags": [ + "SqlPools" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/SqlPoolInfoListResult" + }, + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "List SQL Analytics pools in a workspace": { + "$ref": "./examples/ListSqlPoolsInWorkspace.json" + }, + "List SQL Analytics pools in a workspace with filter": { + "$ref": "./examples/ListSqlPoolsInWorkspaceWithFilter.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/pause": { + "post": { + "operationId": "SqlPools_Pause", + "summary": "Pause SQL pool", + "description": "Pause a SQL pool", + "tags": [ + "SqlPools" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + } + ], + "responses": { + "200": { + "schema": { + "type": "object" + }, + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Pause a SQL Analytics pool": { + "$ref": "./examples/PauseSqlPool.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/resume": { + "post": { + "operationId": "SqlPools_Resume", + "summary": "Resume SQL pool", + "description": "Resume a SQL pool", + "tags": [ + "SqlPools" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + } + ], + "responses": { + "200": { + "schema": { + "type": "object" + }, + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Resume a SQL Analytics pool": { + "$ref": "./examples/ResumeSqlPool.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/move": { + "post": { + "operationId": "SqlPools_Rename", + "summary": "Rename a SQL pool", + "description": "Rename a SQL pool.", + "tags": [ + "SqlPools" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "parameters", + "in": "body", + "description": "The resource move definition for renaming this Sql pool.", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceMoveDefinition" + } + } + ], + "responses": { + "200": { + "description": "Successfully renamed the Sql pool" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidResourceMoveRequest - The resource move request is invalid.\n\n * 400 InvalidMoveTargetResourceId - The target resource identifier in move request is invalid.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 DatabaseNameInUse - Database already exists. Choose a different database name.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Rename a SQL Analytics pool": { + "$ref": "./examples/RenameSqlPool.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/metadataSync/config": { + "get": { + "operationId": "SqlPoolMetadataSyncConfigs_Get", + "summary": "Get SQL pool metadata sync config", + "description": "Get the metadata sync configuration for a SQL pool", + "tags": [ + "SqlPools" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + } + ], + "responses": { + "404": { + "description": "" + }, + "200": { + "schema": { + "$ref": "#/definitions/MetadataSyncConfig" + }, + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get metadata sync config for a SQL Analytics pool": { + "$ref": "./examples/GetSqlPoolMetadataSyncConfig.json" + } + } + }, + "put": { + "operationId": "SqlPoolMetadataSyncConfigs_Create", + "summary": "Set SQL pool metadata sync config", + "description": "Set the metadata sync configuration for a SQL pool", + "tags": [ + "SqlPools" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "description": "Metadata sync configuration", + "schema": { + "$ref": "#/definitions/MetadataSyncConfig" + }, + "in": "body", + "name": "metadataSyncConfiguration", + "required": true + } + ], + "responses": { + "404": { + "description": "" + }, + "200": { + "schema": { + "$ref": "#/definitions/MetadataSyncConfig" + }, + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Set metadata sync config for a SQL Analytics pool": { + "$ref": "./examples/CreateSqlPoolMetadataSyncConfig.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/operationResults/{operationId}": { + "get": { + "operationId": "SqlPoolOperationResults_GetLocationHeaderResult", + "summary": "Get SQL pool operation status", + "description": "Get the status of a SQL pool operation", + "tags": [ + "Operations" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "type": "string", + "in": "path", + "name": "operationId", + "description": "Operation ID", + "required": true + } + ], + "responses": { + "200": { + "schema": { + "type": "object" + }, + "description": "OK" + }, + "202": { + "schema": { + "type": "object" + }, + "description": "Accepted" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get the result of an operation on a SQL Analytics pool": { + "$ref": "./examples/GetLocationHeaderResultWithSqlPool.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/geoBackupPolicies": { + "get": { + "operationId": "SqlPoolGeoBackupPolicies_List", + "summary": "List SQL pool geo backup policies", + "description": "Get list of SQL pool geo backup policies", + "tags": [ + "SqlPools, GeoBackupPolicies" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/GeoBackupPolicyListResult" + }, + "description": "OK" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get Sql pool geo backup policy": { + "$ref": "./examples/SqlPoolGeoBackupPolicies_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/geoBackupPolicies/{geoBackupPolicyName}": { + "put": { + "tags": [ + "SqlPools, GeoBackupPolicies" + ], + "deprecated": false, + "operationId": "SqlPoolGeoBackupPolicies_CreateOrUpdate", + "description": "Updates a SQL Pool geo backup policy.", + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Create geo backup policy": { + "$ref": "./examples/CreateOrUpdateGeoBackupPolicies.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "geoBackupPolicyName", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "description": "The name of the geo backup policy.", + "x-ms-enum": { + "modelAsString": true, + "name": "GeoBackupPolicyName" + }, + "x-ms-parameter-location": "method" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GeoBackupPolicy" + }, + "description": "The required parameters for creating or updating the geo backup policy." + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/GeoBackupPolicy" + } + }, + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GeoBackupPolicy" + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + } + }, + "get": { + "operationId": "SqlPoolGeoBackupPolicies_Get", + "summary": "Get a SQL pool geo backup policy", + "description": "Get the specified SQL pool geo backup policy", + "tags": [ + "SqlPools, GeoBackupPolicies" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "geoBackupPolicyName", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "description": "The name of the geo backup policy.", + "x-ms-enum": { + "modelAsString": true, + "name": "GeoBackupPolicyName" + }, + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/GeoBackupPolicy" + }, + "description": "OK" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get Sql pool geo backup policy": { + "$ref": "./examples/GetSqlPoolGeoBackupPolicy.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/dataWarehouseUserActivities/{dataWarehouseUserActivityName}": { + "get": { + "operationId": "SqlPoolDataWarehouseUserActivities_Get", + "summary": "Get SQL pool user activities", + "description": "Gets the user activities of a SQL pool which includes running and suspended queries", + "tags": [ + "SqlPools, SqlPoolUserActivities" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "dataWarehouseUserActivityName", + "in": "path", + "description": "The activity name of the Sql pool. ", + "required": true, + "type": "string", + "enum": [ + "current" + ], + "x-ms-enum": { + "name": "DataWarehouseUserActivityName", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/DataWarehouseUserActivities" + }, + "description": "OK" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 ResourceNotFound - The specified resource was not found." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get a SQL Analytics pool user activity": { + "$ref": "./examples/GetSqlPoolUserActivity.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/restorePoints": { + "get": { + "operationId": "SqlPoolRestorePoints_List", + "summary": "Get SQL pool backup", + "description": "Get SQL pool backup information", + "tags": [ + "SqlPools, Backup" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/RestorePointListResult" + }, + "description": "OK" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get a list of restore points of a SQL Analytics pool": { + "$ref": "./examples/ListSqlPoolRestorePoints.json" + } + } + }, + "post": { + "tags": [ + "SqlPools, RestorePoints" + ], + "description": "Creates a restore point for a data warehouse.", + "operationId": "SqlPoolRestorePoints_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "parameters", + "in": "body", + "description": "The definition for creating the restore point of this Sql pool.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateSqlPoolRestorePointDefinition" + } + } + ], + "responses": { + "200": { + "description": "Successfully created the restore point request.", + "schema": { + "$ref": "#/definitions/RestorePoint" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 BackupNotAllowedOnDeactivatedDatabase - Cannot create restore point on a deactivated database.\n\n * 400 RestorePointLimitReached - A restore point cannot be created because database would exceed the allowed quota of restore points.\n\n * 400 RestorePointAttemptToDeleteSystemBackup - Cannot delete system restore point.\n\n * 404 DatabaseRestorePointNotFound - Can not find database restore point.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 408 DatabaseRestorePointTimedOut - Create database restore point failed." + }, + "202": { + "description": "Accepted" + }, + "201": { + "description": "Successfully created the restore point request.", + "schema": { + "$ref": "#/definitions/RestorePoint" + } + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Creates Sql pool restore point.": { + "$ref": "./examples/CreateSqlPoolRestorePoints.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/replicationLinks": { + "get": { + "operationId": "SqlPoolReplicationLinks_List", + "summary": "Get SQL pool replication links", + "description": "Lists a Sql pool's replication links.", + "tags": [ + "SqlPools, ReplicationLinks" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationLinkListResult" + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Lists a Sql Analytic pool's replication links": { + "$ref": "./examples/ListSqlPoolReplicationLinks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/replicationLinks/{linkId}": { + "get": { + "operationId": "SqlPoolReplicationLinks_GetByName", + "summary": "Get SQL pool replication link by name", + "description": "Get SQL pool replication link by name.", + "tags": [ + "SqlPools, ReplicationLinks" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "linkId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the replication link." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationLink" + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Lists a Sql Analytic pool's replication links": { + "$ref": "./examples/SqlPoolReplicationLinks_GetByName.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/maintenancewindows/current": { + "get": { + "operationId": "SqlPoolMaintenanceWindows_Get", + "summary": "Get a SQL pool's Maintenance Windows.", + "description": "Get a SQL pool's Maintenance Windows.", + "tags": [ + "SqlPools, MaintenanceWindows" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "maintenanceWindowName", + "in": "query", + "description": "Maintenance window name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceWindows" + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Gets maintenance window settings for a selected SQL Analytics pool.": { + "$ref": "./examples/GetMaintenanceWindows.json" + } + } + }, + "put": { + "operationId": "SqlPoolMaintenanceWindows_CreateOrUpdate", + "summary": "Creates or updates a Sql pool's maintenance windows settings.", + "description": "Creates or updates a Sql pool's maintenance windows settings.", + "tags": [ + "SqlPools, MaintenanceWindows" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "maintenanceWindowName", + "in": "query", + "description": "Maintenance window name.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MaintenanceWindows" + }, + "description": "The required parameters for creating or updating Maintenance Windows settings" + } + ], + "responses": { + "200": { + "description": "Successfully set maintenance windows settings." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidMaintenanceWindowSelection - Invalid maintenance window selection." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Sets maintenance window settings for a selected SQL Analytics Pool.": { + "$ref": "./examples/CreateOrUpdateMaintenanceWindows.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/maintenanceWindowOptions/current": { + "get": { + "operationId": "SqlPoolMaintenanceWindowOptions_Get", + "summary": "SQL pool's available maintenance windows.", + "description": "Get list of SQL pool's available maintenance windows.", + "tags": [ + "SqlPools, MaintenanceWindowOptions" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "maintenanceWindowOptionsName", + "in": "query", + "description": "Maintenance window options name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of maintenance windows options.", + "schema": { + "$ref": "#/definitions/MaintenanceWindowOptions" + } + }, + "default": { + "description": "*** Error Responses: ***" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get list of transparent data encryption configurations of a SQL Analytics pool": { + "$ref": "./examples/GetMaintenanceWindowOptions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/transparentDataEncryption/{transparentDataEncryptionName}": { + "get": { + "operationId": "SqlPoolTransparentDataEncryptions_Get", + "summary": "Get a SQL pool's transparent data encryption configuration", + "description": "Get a SQL pool's transparent data encryption configuration.", + "tags": [ + "SqlPools, TransparentDataEncryption" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "transparentDataEncryptionName", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "current" + ], + "description": "The name of the transparent data encryption configuration.", + "x-ms-enum": { + "modelAsString": true, + "name": "TransparentDataEncryptionName" + }, + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TransparentDataEncryption" + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get transparent data encryption configuration of a SQL Analytics pool": { + "$ref": "./examples/GetSqlPoolTransparentDataEncryption.json" + } + } + }, + "put": { + "operationId": "SqlPoolTransparentDataEncryptions_CreateOrUpdate", + "summary": "Creates or updates a Sql pool's transparent data encryption configuration", + "description": "Creates or updates a Sql pool's transparent data encryption configuration.", + "tags": [ + "SqlPools, TransparentDataEncryption" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "transparentDataEncryptionName", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "current" + ], + "description": "The name of the transparent data encryption configuration.", + "x-ms-enum": { + "modelAsString": true, + "name": "TransparentDataEncryptionName" + }, + "x-ms-parameter-location": "method" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TransparentDataEncryption" + }, + "description": "The required parameters for creating or updating transparent data encryption." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TransparentDataEncryption" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/TransparentDataEncryption" + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Create or update a Sql pool's transparent data encryption configuration": { + "$ref": "./examples/CreateOrUpdateSqlPoolTransparentDataEncryption.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/transparentDataEncryption": { + "get": { + "operationId": "SqlPoolTransparentDataEncryptions_List", + "summary": "SQL pool's transparent data encryption configurations", + "description": "Get list of SQL pool's transparent data encryption configurations.", + "tags": [ + "SqlPools, TransparentDataEncryption" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TransparentDataEncryptionListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get list of transparent data encryption configurations of a SQL Analytics pool": { + "$ref": "./examples/GetSqlPoolTransparentDataEncryptionList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/auditingSettings/{blobAuditingPolicyName}": { + "get": { + "operationId": "SqlPoolBlobAuditingPolicies_Get", + "summary": "Get a SQL pool's blob auditing policy", + "description": "Get a SQL pool's blob auditing policy.", + "tags": [ + "SqlPools, BlobAuditing" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlPoolBlobAuditingPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 BlobAuditingIsNotSupportedOnResourceType - Blob Auditing is currently not supported for this resource type.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get blob auditing policy of a SQL Analytics pool": { + "$ref": "./examples/GetSqlPoolBlobAuditing.json" + } + } + }, + "put": { + "operationId": "SqlPoolBlobAuditingPolicies_CreateOrUpdate", + "summary": "Creates or updates a SQL pool's blob auditing policy", + "description": "Creates or updates a SQL pool's blob auditing policy.", + "tags": [ + "SqlPools, BlobAuditing" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + { + "name": "parameters", + "in": "body", + "description": "The database blob auditing policy.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlPoolBlobAuditingPolicy" + } + } + ], + "responses": { + "200": { + "description": "Successfully set the Sql pool blob auditing policy", + "schema": { + "$ref": "#/definitions/SqlPoolBlobAuditingPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 BlobAuditingIsNotSupportedOnResourceType - Blob Auditing is currently not supported for this resource type.\n\n * 400 InvalidDatabaseBlobAuditingPolicyCreateRequest - The create database blob auditing policy request does not exist or has no properties object.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 BlobAuditingInvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 BlobAuditingInvalidStorageAccountCredentials - The provided storage account or access key is not valid.\n\n * 400 BlobAuditingIsNotSupportedOnGeoDr - Blob auditing can be configured on primary databases only.\n\n * 400 InvalidBlobAuditActionsAndGroupsForDW - Unsupported audit actions or action groups for DW.\n\n * 400 BlobAuditingInsufficientStorageAccountPermissions - Insufficient read or write permissions on the provided storage account.\n\n * 400 BlobAuditingStorageAccountIsDisabled - The provided storage account is disabled.\n\n * 400 InvalidBlobAuditActions - Invalid audit action\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + }, + "201": { + "description": "Successfully created the Sql pool blob auditing policy.", + "schema": { + "$ref": "#/definitions/SqlPoolBlobAuditingPolicy" + } + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Create or update a database's blob auditing policy with minimal parameters": { + "$ref": "./examples/CreateOrUpdateSqlPoolBlobAuditingWithMinParameters.json" + }, + "Create or update a database's blob auditing policy with all parameters": { + "$ref": "./examples/CreateOrUpdateSqlPoolBlobAuditingWithAllParameters.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/operations": { + "get": { + "operationId": "SqlPoolOperations_List", + "summary": "Gets a list of operations performed on the SQL pool", + "description": "Gets a list of operations performed on the SQL pool.", + "tags": [ + "SqlPools, Operations" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlPoolBlobAuditingPolicySqlPoolOperationListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List the Sql Analytics pool management operations": { + "$ref": "./examples/ListSqlPoolOperations.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/usages": { + "get": { + "operationId": "SqlPoolUsages_List", + "summary": "Gets SQL pool usages", + "description": "Gets SQL pool usages.", + "tags": [ + "SqlPools, Usages" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlPoolUsageListResult" + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List the usages of a SQL Analytics pool": { + "$ref": "./examples/SqlPoolUsageMetricsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/currentSensitivityLabels": { + "get": { + "operationId": "SqlPoolSensitivityLabels_ListCurrent", + "summary": "Gets SQL pool sensitivity labels", + "description": "Gets SQL pool sensitivity labels.", + "tags": [ + "SqlPools, SensitivityLabels" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "$filter", + "in": "query", + "description": "An OData filter expression that filters elements in the collection.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SensitivityLabelListResult" + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-odata": "#/definitions/SensitivityLabel", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the current sensitivity labels of a given SQL Analytics pool": { + "$ref": "./examples/ListSqlPoolsSensitivityLabelsWithSourceCurrent.json" + } + } + }, + "patch": { + "tags": [ + "SqlPools, SensitivityLabels" + ], + "description": "Update sensitivity labels of a given SQL Pool using an operations batch.", + "operationId": "SqlPoolSensitivityLabels_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SensitivityLabelUpdateList" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated sensitivity labels." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.\n\n * 400 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.\n\n * 400 SensitivityLabelSourceNameNotSupported - The specified sensitivity label source is not valid\n\n * 400 InvalidSensitivityLabelsBatch - The specified sensitivity labels batch is not valid. Please provide batch operations\n\n * 400 SensitivityLabelsMissingSchema - Operation[{0}]: Missing schema information\n\n * 400 SensitivityLabelsMissingTable - Operation[{0}]: Missing table information\n\n * 400 SensitivityLabelsMissingColumn - Operation[{0}]: Missing column information\n\n * 400 SensitivityLabelsUpdateSameColumnMoreThanOnce - The column {0} can not be updated more than once in a single command\n\n * 400 InvalidSensitivityLabelResource - The specified sensitivity label resource is not valid\n\n * 400 SensitivityLabelLabelNameAndInfoTypeNotProvided - At least one of LabelName and InformationType must be specified\n\n * 400 LabelNameTooLong - Label name cannot exceed {0} characters\n\n * 400 InformationTypeTooLong - Information type cannot exceed {0} characters\n\n * 400 LabelIdMustBeGuid - The provided �labelId� is invalid. Value must be a GUID\n\n * 400 InformationTypeIdMustBeGuid - The provided �informationTypeId� is invalid. Value must be a GUID\n\n * 400 LabelMissing - Label is required. At least one of �labelName� or �labelId� must be provided\n\n * 400 InformationTypeMissing - Information type is required. At least one of �informationType� or �informationTypeId� must be provided\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SensitivityLabelsLabelNotFound - The specified sensitivity label could not be found\n\n * 404 SensitivityLabelsSchemaNotFound - The schema {0} could not be found\n\n * 404 SensitivityLabelsTableNotFound - The table {0} could not be found in schema {1}\n\n * 404 SensitivityLabelsColumnNotFound - The column {0} could not be found in table {2}.{1}\n\n * 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet\n\n * 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable." + } + }, + "x-ms-examples": { + "Update sensitivity labels of a given database using an operations batch.": { + "$ref": "./examples/SensitivityLabelsCurrentUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/recommendedSensitivityLabels": { + "get": { + "operationId": "SqlPoolSensitivityLabels_ListRecommended", + "summary": "Gets sensitivity labels of a given SQL pool", + "description": "Gets sensitivity labels of a given SQL pool.", + "tags": [ + "SqlPools, SensitivityLabels" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "includeDisabledRecommendations", + "in": "query", + "description": "Specifies whether to include disabled recommendations or not.", + "required": false, + "type": "boolean" + }, + { + "name": "$skipToken", + "in": "query", + "description": "An OData query option to indicate how many elements to skip in the collection.", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "An OData filter expression that filters elements in the collection.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SensitivityLabelListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.\n\n * 400 SensitivityLabelsInvalidODataQuery - The specified OData query is either not valid or not supported\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-odata": "#/definitions/SensitivityLabel", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the recommended sensitivity labels of a given SQL Analytics pool": { + "$ref": "./examples/ListSqlPoolSensitivityLabelsWithSourceRecommended.json" + } + } + }, + "patch": { + "tags": [ + "SqlPools, SensitivityLabels" + ], + "description": "Update recommended sensitivity labels states of a given SQL Pool using an operations batch.", + "operationId": "SqlPoolRecommendedSensitivityLabels_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RecommendedSensitivityLabelUpdateList" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated recommended sensitivity labels." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.\n\n * 400 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.\n\n * 400 SensitivityLabelSourceNameNotSupported - The specified sensitivity label source is not valid\n\n * 400 InvalidRecommendedSensitivityLabelsBatch - The specified recommended sensitivity labels operations are not valid\n\n * 400 SensitivityLabelsMissingSchema - Operation[{0}]: Missing schema information\n\n * 400 SensitivityLabelsMissingTable - Operation[{0}]: Missing table information\n\n * 400 SensitivityLabelsMissingColumn - Operation[{0}]: Missing column information\n\n * 400 SensitivityLabelsUpdateSameColumnMoreThanOnce - The column {0} can not be updated more than once in a single command\n\n * 400 InvalidSensitivityLabelResource - The specified sensitivity label resource is not valid\n\n * 400 SensitivityLabelLabelNameAndInfoTypeNotProvided - At least one of LabelName and InformationType must be specified\n\n * 400 LabelNameTooLong - Label name cannot exceed {0} characters\n\n * 400 InformationTypeTooLong - Information type cannot exceed {0} characters\n\n * 400 LabelIdMustBeGuid - The provided �labelId� is invalid. Value must be a GUID\n\n * 400 InformationTypeIdMustBeGuid - The provided �informationTypeId� is invalid. Value must be a GUID\n\n * 400 LabelMissing - Label is required. At least one of �labelName� or �labelId� must be provided\n\n * 400 InformationTypeMissing - Information type is required. At least one of �informationType� or �informationTypeId� must be provided\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SensitivityLabelsLabelNotFound - The specified sensitivity label could not be found\n\n * 404 SensitivityLabelsSchemaNotFound - The schema {0} could not be found\n\n * 404 SensitivityLabelsTableNotFound - The table {0} could not be found in schema {1}\n\n * 404 SensitivityLabelsColumnNotFound - The column {0} could not be found in table {2}.{1}\n\n * 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet\n\n * 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable." + } + }, + "x-ms-examples": { + "Update recommended sensitivity labels of a given SQL Pool using an operations batch.": { + "$ref": "./examples/SensitivityLabelsRecommendedUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}": { + "put": { + "tags": [ + "SqlPools, SensitivityLabels" + ], + "description": "Creates or updates the sensitivity label of a given column in a Sql pool", + "operationId": "SqlPoolSensitivityLabels_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "schemaName", + "in": "path", + "description": "The name of the schema.", + "required": true, + "type": "string" + }, + { + "name": "tableName", + "in": "path", + "description": "The name of the table.", + "required": true, + "type": "string" + }, + { + "name": "columnName", + "in": "path", + "description": "The name of the column.", + "required": true, + "type": "string" + }, + { + "name": "sensitivityLabelSource", + "in": "path", + "description": "The source of the sensitivity label.", + "required": true, + "type": "string", + "enum": [ + "current" + ], + "x-ms-enum": { + "name": "WritableSensitivityLabelSource", + "modelAsString": false + } + }, + { + "name": "parameters", + "in": "body", + "description": "The column sensitivity label resource.", + "required": true, + "schema": { + "$ref": "#/definitions/SensitivityLabel" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the sensitivity label.", + "schema": { + "$ref": "#/definitions/SensitivityLabel" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.\n\n * 400 SensitivityLabelSourceNameNotSupported - The specified sensitivity label source is not valid\n\n * 400 InvalidSensitivityLabelResource - The specified sensitivity label resource is not valid\n\n * 400 SensitivityLabelLabelNameAndInfoTypeNotProvided - At least one of LabelName and InformationType must be specified\n\n * 400 LabelNameTooLong - Label name cannot exceed {0} characters\n\n * 400 InformationTypeTooLong - Information type cannot exceed {0} characters\n\n * 400 LabelIdMustBeGuid - Label ID must be a GUID\n\n * 400 InformationTypeIdMustBeGuid - Information type ID must be a GUID\n\n * 400 LabelMissing - Label is missing\n\n * 400 InformationTypeMissing - Information Type is missing\n\n * 404 SensitivityLabelsColumnNotFound - The specified schema/table/column could not be found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SensitivityLabelsLabelNotFound - The specified sensitivity label could not be found\n\n * 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet" + }, + "201": { + "description": "Successfully created the sensitivity label.", + "schema": { + "$ref": "#/definitions/SensitivityLabel" + } + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Updates the sensitivity label of a given column with all parameters": { + "$ref": "./examples/CreateOrUpdateSqlPoolColumnSensitivityLabelWithAllParameters.json" + } + } + }, + "delete": { + "tags": [ + "SqlPools, SensitivityLabels" + ], + "description": "Deletes the sensitivity label of a given column in a Sql pool", + "operationId": "SqlPoolSensitivityLabels_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "schemaName", + "in": "path", + "description": "The name of the schema.", + "required": true, + "type": "string" + }, + { + "name": "tableName", + "in": "path", + "description": "The name of the table.", + "required": true, + "type": "string" + }, + { + "name": "columnName", + "in": "path", + "description": "The name of the column.", + "required": true, + "type": "string" + }, + { + "name": "sensitivityLabelSource", + "in": "path", + "description": "The source of the sensitivity label.", + "required": true, + "type": "string", + "enum": [ + "current" + ], + "x-ms-enum": { + "name": "WritableSensitivityLabelSource", + "modelAsString": false + } + } + ], + "responses": { + "200": { + "description": "Successfully deleted the sensitivity label." + }, + "204": { + "description": "No content" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.\n\n * 400 SensitivityLabelSourceNameNotSupported - The specified sensitivity label source is not valid\n\n * 404 SensitivityLabelsColumnNotFound - The specified schema/table/column could not be found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SensitivityLabelsLabelNotFound - The specified sensitivity label could not be found\n\n * 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Deletes the sensitivity label of a given column": { + "$ref": "./examples/DeleteSqlPoolColumnSensitivityLabel.json" + } + } + }, + "get": { + "tags": [ + "SqlPools, SensitivityLabels" + ], + "description": "Gets the sensitivity label of a given column", + "operationId": "SqlPoolSensitivityLabels_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "schemaName", + "in": "path", + "description": "The name of the schema.", + "required": true, + "type": "string" + }, + { + "name": "tableName", + "in": "path", + "description": "The name of the table.", + "required": true, + "type": "string" + }, + { + "name": "columnName", + "in": "path", + "description": "The name of the column.", + "required": true, + "type": "string" + }, + { + "name": "sensitivityLabelSource", + "in": "path", + "description": "The source of the sensitivity label.", + "required": true, + "type": "string", + "enum": [ + "current", + "recommended" + ], + "x-ms-enum": { + "name": "SensitivityLabelSource", + "modelAsString": false + } + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the sensitivity label.", + "schema": { + "$ref": "#/definitions/SensitivityLabel" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.\n\n * 400 SensitivityLabelSourceNameNotSupported - The specified sensitivity label source is not valid\n\n * 404 SensitivityLabelsColumnNotFound - The specified schema/table/column could not be found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SensitivityLabelsLabelNotFound - The specified sensitivity label could not be found\n\n * 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Gets the sensitivity label of a given column": { + "$ref": "./examples/GetSqlPoolColumnSensitivityLabelGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}/enable": { + "post": { + "tags": [ + "SensitivityLabels" + ], + "description": "Enables sensitivity recommendations on a given column (recommendations are enabled by default on all columns)", + "operationId": "SqlPoolSensitivityLabels_EnableRecommendation", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "schemaName", + "in": "path", + "description": "The name of the schema.", + "required": true, + "type": "string" + }, + { + "name": "tableName", + "in": "path", + "description": "The name of the table.", + "required": true, + "type": "string" + }, + { + "name": "columnName", + "in": "path", + "description": "The name of the column.", + "required": true, + "type": "string" + }, + { + "name": "sensitivityLabelSource", + "in": "path", + "description": "The source of the sensitivity label.", + "required": true, + "type": "string", + "enum": [ + "recommended" + ], + "x-ms-enum": { + "name": "WritableSensitivityLabelSource", + "modelAsString": false + } + } + ], + "responses": { + "200": { + "description": "Successfully enabled the sensitivity recommendations on the given column." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.\n\n * 404 SensitivityLabelsColumnNotFound - The specified column could not be found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance." + } + }, + "x-ms-examples": { + "Enables sensitivity recommendations on a given column": { + "$ref": "./examples/RecommendedColumnSensitivityLabelEnable.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}/disable": { + "post": { + "tags": [ + "SensitivityLabels" + ], + "description": "Disables sensitivity recommendations on a given column", + "operationId": "SqlPoolSensitivityLabels_DisableRecommendation", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "schemaName", + "in": "path", + "description": "The name of the schema.", + "required": true, + "type": "string" + }, + { + "name": "tableName", + "in": "path", + "description": "The name of the table.", + "required": true, + "type": "string" + }, + { + "name": "columnName", + "in": "path", + "description": "The name of the column.", + "required": true, + "type": "string" + }, + { + "name": "sensitivityLabelSource", + "in": "path", + "description": "The source of the sensitivity label.", + "required": true, + "type": "string", + "enum": [ + "recommended" + ], + "x-ms-enum": { + "name": "WritableSensitivityLabelSource", + "modelAsString": false + } + } + ], + "responses": { + "200": { + "description": "Successfully disabled the sensitivity recommendation on the given column." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.\n\n * 404 SensitivityLabelsColumnNotFound - The specified column could not be found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance." + } + }, + "x-ms-examples": { + "Disables sensitivity recommendations on a given column": { + "$ref": "./examples/RecommendedColumnSensitivityLabelDisable.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/schemas": { + "get": { + "operationId": "SqlPoolSchemas_List", + "summary": "Gets schemas of a given SQL pool", + "description": "Gets schemas of a given SQL pool.", + "tags": [ + "SqlPools, Schemas" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "$filter", + "in": "query", + "description": "An OData filter expression that filters elements in the collection.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlPoolSchemaListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 InvalidDatabaseSchema - Schema is missing in database.\n\n * 404 InvalidDatabaseTable - Table is missing in database.\n\n * 404 InvalidDatabaseColumn - Column is missing in table." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-odata": "#/definitions/SqlPoolSchema", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List the schema in a SQL Analytics pool": { + "$ref": "./examples/ListSqlPoolSchema.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/schemas/{schemaName}/tables": { + "get": { + "operationId": "SqlPoolTables_ListBySchema", + "summary": "Gets tables of a given schema in a SQL pool", + "description": "Gets tables of a given schema in a SQL pool.", + "tags": [ + "SqlPools, Tables" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "schemaName", + "in": "path", + "description": "The name of the schema.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "An OData filter expression that filters elements in the collection.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlPoolTableListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 InvalidDatabaseSchema - Schema is missing in database.\n\n * 404 InvalidDatabaseTable - Table is missing in database.\n\n * 404 InvalidDatabaseColumn - Column is missing in table." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-odata": "#/definitions/SqlPoolTable", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List the tables of a given schema in a SQL Analytics pool": { + "$ref": "./examples/ListSqlPoolTables.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/schemas/{schemaName}/tables/{tableName}/columns": { + "get": { + "operationId": "SqlPoolTableColumns_ListByTableName", + "summary": "Gets columns in a given table in a SQL pool", + "description": "Gets columns in a given table in a SQL pool.", + "tags": [ + "SqlPools, Tables" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "schemaName", + "in": "path", + "description": "The name of the schema.", + "required": true, + "type": "string" + }, + { + "name": "tableName", + "in": "path", + "description": "The name of the table.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "An OData filter expression that filters elements in the collection.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlPoolColumnListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 InvalidDatabaseSchema - Schema is missing in database.\n\n * 404 InvalidDatabaseTable - Table is missing in database.\n\n * 404 InvalidDatabaseColumn - Column is missing in table." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-odata": "#/definitions/SqlPoolColumn", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List the columns in a table of a given schema in a SQL Analytics pool": { + "$ref": "./examples/ListSqlPoolColumns.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/connectionPolicies/{connectionPolicyName}": { + "get": { + "operationId": "SqlPoolConnectionPolicies_Get", + "summary": "Get a Sql pool's connection policy, which is used with table auditing", + "description": "Get a Sql pool's connection policy, which is used with table auditing.", + "tags": [ + "SqlPools, ConnectionPolicies" + ], + "deprecated": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "connectionPolicyName", + "in": "path", + "description": "The name of the connection policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "ConnectionPolicyName", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlPoolConnectionPolicy" + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get a connection policy of a SQL Analytics pool": { + "$ref": "./examples/GetSqlPoolConnectionPolicy.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/vulnerabilityAssessments": { + "get": { + "operationId": "SqlPoolVulnerabilityAssessments_List", + "summary": "Lists the vulnerability assessment policies associated with a SQL pool", + "description": "Lists the vulnerability assessment policies associated with a SQL pool.", + "tags": [ + "SqlPools, Schemas" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlPoolVulnerabilityAssessmentListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 VulnerabilityAssessmentInvalidPolicy - Vulnerability Assessment settings don't exist or invalid storage specified in settings. \n\n * 400 DatabaseVulnerabilityAssessmentMissingStorageContainerPath - Storage container path must be provided if it isn't set in server level policy\n\n * 400 VulnerabilityAssessmentDatawarehouseDatabaseIsDeactivated - Could not execute Vulnerability Assessment operation because the database is paused. Please resume it.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - Vulnerability Assessment scan is already in progress.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a vulnerability assessment of a SQL Analytics pool": { + "$ref": "./examples/ListSqlPoolVulnerabilityAssessments.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}/scans": { + "get": { + "operationId": "SqlPoolVulnerabilityAssessmentScans_List", + "summary": "Lists the vulnerability assessment scans of a SQL pool", + "description": "Lists the vulnerability assessment scans of a SQL pool.", + "tags": [ + "SqlPools, Schemas" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "vulnerabilityAssessmentName", + "in": "path", + "description": "The name of the vulnerability assessment.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentName", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VulnerabilityAssessmentScanRecordListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 VulnerabilityAssessmentInvalidPolicy - Vulnerability Assessment settings don't exist or invalid storage specified in settings. \n\n * 400 DatabaseVulnerabilityAssessmentMissingStorageContainerPath - Storage container path must be provided if it isn't set in server level policy\n\n * 400 VulnerabilityAssessmentDatawarehouseDatabaseIsDeactivated - Could not execute Vulnerability Assessment operation because the database is paused. Please resume it.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - Vulnerability Assessment scan is already in progress.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a vulnerability scan record of a SQL Analytics pool": { + "$ref": "./examples/ListSqlPoolVulnerabilityAssessmentScanRecords.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}/scans/{scanId}/initiateScan": { + "post": { + "tags": [ + "SqlPools, VulnerabilityAssessmentScansExecute" + ], + "description": "Executes a Vulnerability Assessment database scan.", + "operationId": "SqlPoolVulnerabilityAssessmentScans_InitiateScan", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "vulnerabilityAssessmentName", + "in": "path", + "description": "The name of the vulnerability assessment.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentName", + "modelAsString": true + } + }, + { + "name": "scanId", + "in": "path", + "description": "The vulnerability assessment scan Id of the scan to retrieve.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successfully executed a Vulnerability Assessment scan." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 InvalidVulnerabilityAssessmentScanIdLength - The vulnerability assessment scan ID length must be below {0} characters.\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 VulnerabilityAssessmentInvalidPolicy - Vulnerability Assessment settings don't exist or invalid storage specified in settings. \n\n * 400 DatabaseVulnerabilityAssessmentMissingStorageContainerPath - Storage container path must be provided if it isn't set in server level policy\n\n * 400 VulnerabilityAssessmentDatawarehouseDatabaseIsDeactivated - Could not execute Vulnerability Assessment operation because the database is paused. Please resume it.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - Vulnerability Assessment scan is already in progress.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + }, + "202": { + "description": "Successfully started a Vulnerability Assessment scan." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Executes a Sql pool's vulnerability assessment scan.": { + "$ref": "./examples/ExecuteSqlPoolVulnerabilityAssessmentScans.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}/scans/{scanId}/export": { + "post": { + "tags": [ + "SqlPools, VulnerabilityAssessmentScansExport" + ], + "description": "Convert an existing scan result to a human readable format. If already exists nothing happens", + "operationId": "SqlPoolVulnerabilityAssessmentScans_Export", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "vulnerabilityAssessmentName", + "in": "path", + "description": "The name of the vulnerability assessment.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentName", + "modelAsString": true + } + }, + { + "name": "scanId", + "in": "path", + "description": "The vulnerability assessment scan Id of the scan to retrieve.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Scan result was converted successfully.", + "schema": { + "$ref": "#/definitions/SqlPoolVulnerabilityAssessmentScansExport" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 VulnerabilityAssessmentInvalidPolicy - Vulnerability Assessment settings don't exist or invalid storage specified in settings. \n\n * 400 DatabaseVulnerabilityAssessmentMissingStorageContainerPath - Storage container path must be provided if it isn't set in server level policy\n\n * 400 VulnerabilityAssessmentDatawarehouseDatabaseIsDeactivated - Could not execute Vulnerability Assessment operation because the database is paused. Please resume it.\n\n * 400 InvalidVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - Vulnerability Assessment scan is already in progress.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + }, + "201": { + "description": "Scan result was converted successfully.", + "schema": { + "$ref": "#/definitions/SqlPoolVulnerabilityAssessmentScansExport" + } + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Export a database's vulnerability assessment scan results.": { + "$ref": "./examples/ExportSqlPoolVulnerabilityAssessmentScan.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/securityAlertPolicies": { + "get": { + "operationId": "SqlPoolSecurityAlertPolicies_List", + "summary": "List Sql pool's security alert policies", + "description": "Get a list of Sql pool's security alert policies.", + "tags": [ + "SqlPools, SecurityAlertPolicies" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListSqlPoolSecurityAlertPolicies" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountCredentials - The provided storage account access key is not valid.\n\n * 400 InvalidServerSecurityAlertPolicyCreateRequest - The create server Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 ServerSecurityAlertPolicyInProgress - Set server security alert policy is already in progress\n\n * 409 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 GetServerSecurityAlertPolicyFailed - Failed to get Threat Detection settings" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get a security alert of a SQL Analytics pool": { + "$ref": "./examples/SqlPoolSecurityAlertPolicies_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/securityAlertPolicies/{securityAlertPolicyName}": { + "get": { + "operationId": "SqlPoolSecurityAlertPolicies_Get", + "summary": "Get a Sql pool's security alert policy", + "description": "Get a Sql pool's security alert policy.", + "tags": [ + "SqlPools, SecurityAlertPolicies" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the security alert policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "SecurityAlertPolicyName", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlPoolSecurityAlertPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountCredentials - The provided storage account access key is not valid.\n\n * 400 InvalidDatabaseSecurityAlertPolicyCreateRequest - The create database Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 DatabaseSecurityAlertPolicyInProgress - Set database security alert policy is already in progress\n\n * 409 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 GetDatabaseSecurityAlertPolicyFailed - Failed to get Threat Detection settings" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get a security alert of a SQL Analytics pool": { + "$ref": "./examples/GetSqlPoolSecurityAlert.json" + } + } + }, + "put": { + "operationId": "SqlPoolSecurityAlertPolicies_CreateOrUpdate", + "summary": "Create or update a Sql pool's security alert policy", + "description": "Create or update a Sql pool's security alert policy.", + "tags": [ + "SqlPools, SecurityAlertPolicies" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the security alert policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "SecurityAlertPolicyName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "The Sql pool security alert policy.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlPoolSecurityAlertPolicy" + } + } + ], + "responses": { + "200": { + "description": "Successfully set the Sql pool security alert policy", + "schema": { + "$ref": "#/definitions/SqlPoolSecurityAlertPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountCredentials - The provided storage account access key is not valid.\n\n * 400 InvalidDatabaseSecurityAlertPolicyCreateRequest - The create database Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 DatabaseSecurityAlertPolicyInProgress - Set database security alert policy is already in progress\n\n * 409 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 GetDatabaseSecurityAlertPolicyFailed - Failed to get Threat Detection settings" + }, + "201": { + "description": "Successfully created the Sql pool security alert policy.", + "schema": { + "$ref": "#/definitions/SqlPoolSecurityAlertPolicy" + } + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Update a Sql pool's threat detection policy with minimal parameters": { + "$ref": "./examples/CreateOrUpdateSqlPoolSecurityAlertWithMinParameters.json" + }, + "Update a Sql pool's threat detection policy with all parameters": { + "$ref": "./examples/CreateOrUpdateSqlPoolSecurityAlertWithAllParameters.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}/rules/{ruleId}/baselines/{baselineName}": { + "put": { + "tags": [ + "SqlPools, DatabaseVulnerabilityAssesmentRuleBaselines" + ], + "description": "Creates or updates a Sql pool's vulnerability assessment rule baseline.", + "operationId": "SqlPoolVulnerabilityAssessmentRuleBaselines_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "vulnerabilityAssessmentName", + "in": "path", + "description": "The name of the vulnerability assessment.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentName", + "modelAsString": true + } + }, + { + "name": "ruleId", + "in": "path", + "description": "The vulnerability assessment rule ID.", + "required": true, + "type": "string" + }, + { + "name": "baselineName", + "in": "path", + "description": "The name of the vulnerability assessment rule baseline (default implies a baseline on a Sql pool level rule and master for workspace level rule).", + "required": true, + "type": "string", + "enum": [ + "master", + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentPolicyBaselineName", + "modelAsString": false + } + }, + { + "name": "parameters", + "in": "body", + "description": "The requested rule baseline resource.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlPoolVulnerabilityAssessmentRuleBaseline" + } + } + ], + "responses": { + "200": { + "description": "Successfully set the vulnerability assessment rule baseline.", + "schema": { + "$ref": "#/definitions/SqlPoolVulnerabilityAssessmentRuleBaseline" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 VulnerabilityAssessmentStorageAuthenticationFailed - Could not authenticate to storage account '{0}' .\n\n * 400 VulnerabilityAssessmentInvalidPolicy - Vulnerability Assessment settings don't exist or invalid storage specified in settings. \n\n * 400 VulnerabilityAssessmentDatawarehouseDatabaseIsDeactivated - Could not execute Vulnerability Assessment operation because the database is paused. Please resume it.\n\n * 400 InvalidVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 VulnerabilityAssessmentInvalidStorageAccount - The storage account '{0}' that was defined in the policy is invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 VulnerabilityAssessmentRuleDoesNotExists - Rule '{0}' does not exist.\n\n * 404 VulnerabilityAssessmentBaselineDoesNotExists - Baseline does not exist for rule '{0}'\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Creates or updates a database's vulnerability assessment rule baseline.": { + "$ref": "./examples/CreateOrUpdateSqlPoolVulnerabilityAssessmentRuleBaseline.json" + } + } + }, + "delete": { + "tags": [ + "DatabaseVulnerabilityAssesmentRuleBaselines" + ], + "description": "Removes the database's vulnerability assessment rule baseline.", + "operationId": "SqlPoolVulnerabilityAssessmentRuleBaselines_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "vulnerabilityAssessmentName", + "in": "path", + "description": "The name of the vulnerability assessment.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentName", + "modelAsString": true + } + }, + { + "name": "ruleId", + "in": "path", + "description": "The vulnerability assessment rule ID.", + "required": true, + "type": "string" + }, + { + "name": "baselineName", + "in": "path", + "description": "The name of the vulnerability assessment rule baseline (default implies a baseline on a Sql pool level rule and master for workspace level rule).", + "required": true, + "type": "string", + "enum": [ + "master", + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentPolicyBaselineName", + "modelAsString": false + } + } + ], + "responses": { + "200": { + "description": "Successfully removed the database vulnerability assessment rule baseline." + }, + "204": { + "description": "No content" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 VulnerabilityAssessmentStorageAuthenticationFailed - Could not authenticate to storage account '{0}' .\n\n * 400 VulnerabilityAssessmentInvalidPolicy - Vulnerability Assessment settings don't exist or invalid storage specified in settings. \n\n * 400 VulnerabilityAssessmentDatawarehouseDatabaseIsDeactivated - Could not execute Vulnerability Assessment operation because the database is paused. Please resume it.\n\n * 400 InvalidVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 VulnerabilityAssessmentInvalidStorageAccount - The storage account '{0}' that was defined in the policy is invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 VulnerabilityAssessmentRuleDoesNotExists - Rule '{0}' does not exist.\n\n * 404 VulnerabilityAssessmentBaselineDoesNotExists - Baseline does not exist for rule '{0}'\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + } + }, + "x-ms-examples": { + "Removes a database's vulnerability assessment rule baseline.": { + "$ref": "./examples/DeleteSqlPoolVulnerabilityAssessmentRuleBaseline.json" + } + } + }, + "get": { + "tags": [ + "SqlPools, SqlPoolVulnerabilityAssesmentRuleBaselines" + ], + "description": "Gets a SqlPool's vulnerability assessment rule baseline.", + "operationId": "SqlPoolVulnerabilityAssessmentRuleBaselines_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "vulnerabilityAssessmentName", + "in": "path", + "description": "The name of the vulnerability assessment.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentName", + "modelAsString": true + } + }, + { + "name": "ruleId", + "in": "path", + "description": "The vulnerability assessment rule ID.", + "required": true, + "type": "string" + }, + { + "name": "baselineName", + "in": "path", + "description": "The name of the vulnerability assessment rule baseline (default implies a baseline on a Sql pool level rule and master for server level rule).", + "required": true, + "type": "string", + "enum": [ + "master", + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentPolicyBaselineName", + "modelAsString": false + } + } + ], + "consumes": [], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully got the vulnerability assessment rule baseline.", + "schema": { + "$ref": "#/definitions/SqlPoolVulnerabilityAssessmentRuleBaseline" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 VulnerabilityAssessmentStorageAuthenticationFailed - Could not authenticate to storage account '{0}' .\n\n * 400 VulnerabilityAssessmentInvalidPolicy - Vulnerability Assessment settings don't exist or invalid storage specified in settings. \n\n * 400 VulnerabilityAssessmentDatawarehouseDatabaseIsDeactivated - Could not execute Vulnerability Assessment operation because the database is paused. Please resume it.\n\n * 400 InvalidVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 VulnerabilityAssessmentInvalidStorageAccount - The storage account '{0}' that was defined in the policy is invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 VulnerabilityAssessmentRuleDoesNotExists - Rule '{0}' does not exist.\n\n * 404 VulnerabilityAssessmentBaselineDoesNotExists - Baseline does not exist for rule '{0}'\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + } + }, + "x-ms-examples": { + "Gets a Sql pool's vulnerability assessment rule baseline.": { + "$ref": "./examples/SqlPoolVulnerabilityAssessmentRuleBaselineGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}": { + "get": { + "tags": [ + "SqlPools, VulnerabilityAssessments" + ], + "summary": "Gets the Sql pool's vulnerability assessment", + "description": "Gets the Sql pool's vulnerability assessment.", + "operationId": "SqlPoolVulnerabilityAssessments_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "vulnerabilityAssessmentName", + "in": "path", + "description": "The name of the vulnerability assessment.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentName", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the Sql pool vulnerability assessment.", + "schema": { + "$ref": "#/definitions/SqlPoolVulnerabilityAssessment" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 DatabaseVulnerabilityAssessmentMissingStorageContainerPath - Storage container path must be provided if it isn't set in server level policy\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get a Sql pool's vulnerability assessment": { + "$ref": "./examples/GetSqlPoolVulnerabilityAssessment.json" + } + } + }, + "put": { + "tags": [ + "SqlPools, VulnerabilityAssessments" + ], + "summary": "Creates or updates the Sql pool vulnerability assessment", + "description": "Creates or updates the Sql pool vulnerability assessment.", + "operationId": "SqlPoolVulnerabilityAssessments_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "vulnerabilityAssessmentName", + "in": "path", + "description": "The name of the vulnerability assessment.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "The requested resource.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlPoolVulnerabilityAssessment" + } + } + ], + "responses": { + "200": { + "description": "Successfully set the Sql pool vulnerability assessment.", + "schema": { + "$ref": "#/definitions/SqlPoolVulnerabilityAssessment" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 DatabaseVulnerabilityAssessmentMissingStorageContainerPath - Storage container path must be provided if it isn't set in server level policy\n\n * 400 InvalidVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + }, + "201": { + "description": "Successfully created the vulnerability assessment.", + "schema": { + "$ref": "#/definitions/SqlPoolVulnerabilityAssessment" + } + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Create a database's vulnerability assessment with minimal parameters, when storageContainerSasKey is specified": { + "$ref": "./examples/CreateOrUpdateSqlPoolVulnerabilityAssessmentWithContainerSasKeyAndMinParameters.json" + }, + "Create a database's vulnerability assessment with minimal parameters, when storageAccountAccessKey is specified": { + "$ref": "./examples/CreateOrUpdateVulnerabilityAssessmentWithStorageAccessKeyAndMinParameters.json" + }, + "Create a database's vulnerability assessment with all parameters": { + "$ref": "./examples/CreateOrUpdateSqlPoolVulnerabilityAssessmentWithAllParameters.json" + } + } + }, + "delete": { + "tags": [ + "SqlPools, VulnerabilityAssessments" + ], + "summary": "Removes the database's vulnerability assessment", + "description": "Removes the database's vulnerability assessment.", + "operationId": "SqlPoolVulnerabilityAssessments_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "vulnerabilityAssessmentName", + "in": "path", + "description": "The name of the vulnerability assessment.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentName", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "Successfully removed the Sql pool vulnerability assessment." + }, + "204": { + "description": "No content" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 DatabaseVulnerabilityAssessmentMissingStorageContainerPath - Storage container path must be provided if it isn't set in server level policy\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Remove a database's vulnerability assessment": { + "$ref": "./examples/DeleteSqlPoolVulnerabilityAssessment.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/extendedAuditingSettings/{blobAuditingPolicyName}": { + "get": { + "tags": [ + "SqlPools, BlobAuditing" + ], + "description": "Gets an extended Sql pool's blob auditing policy.", + "operationId": "ExtendedSqlPoolBlobAuditingPolicies_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the extended Sql pool blob auditing policy.", + "schema": { + "$ref": "#/definitions/ExtendedSqlPoolBlobAuditingPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 BlobAuditingIsNotSupportedOnResourceType - Blob Auditing is currently not supported for this resource type.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get an extended database's blob auditing policy": { + "$ref": "./examples/ExtendedSqlPoolBlobAuditingGet.json" + } + } + }, + "put": { + "tags": [ + "SqlPools, BlobAuditing" + ], + "description": "Creates or updates an extended Sql pool's blob auditing policy.", + "operationId": "ExtendedSqlPoolBlobAuditingPolicies_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + { + "name": "parameters", + "in": "body", + "description": "The extended Sql pool blob auditing policy.", + "required": true, + "schema": { + "$ref": "#/definitions/ExtendedSqlPoolBlobAuditingPolicy" + } + } + ], + "responses": { + "200": { + "description": "Successfully set the extended Sql pool blob auditing policy.", + "schema": { + "$ref": "#/definitions/ExtendedSqlPoolBlobAuditingPolicy" + } + }, + "201": { + "description": "Successfully created the extended database blob auditing policy.", + "schema": { + "$ref": "#/definitions/ExtendedSqlPoolBlobAuditingPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 BlobAuditingIsNotSupportedOnResourceType - Blob Auditing is currently not supported for this resource type.\n\n * 400 BlobAuditingPredicateExpressionSyntaxError - Invalid value of parameter 'predicateExpression'.\n\n * 400 InvalidDatabaseBlobAuditingPolicyCreateRequest - The create database blob auditing policy request does not exist or has no properties object.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 BlobAuditingPredicateExpressionEmpty - Invalid parameter 'predicateExpression', value can not be empty.\n\n * 400 BlobAuditingInvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 BlobAuditingInvalidStorageAccountCredentials - The provided storage account or access key is not valid.\n\n * 400 BlobAuditingIsNotSupportedOnGeoDr - Blob auditing can be configured on primary databases only.\n\n * 400 BlobAuditingNoServerIdentity - The server identity is not correctly configured.\n\n * 400 InvalidBlobAuditActionsAndGroupsForDW - Unsupported audit actions or action groups for DW.\n\n * 400 BlobAuditingInsufficientStorageAccountPermissions - Insufficient read or write permissions on the provided storage account.\n\n * 400 BlobAuditingStorageAccountIsDisabled - The provided storage account is disabled.\n\n * 400 InsufficientDiskSpaceForAuditing - Insufficient disk space to save auditing metadata in the database\n\n * 400 InvalidBlobAuditActions - Invalid audit action\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Create or update an extended Sql pool's blob auditing policy with minimal parameters": { + "$ref": "./examples/ExtendedSqlPoolBlobAuditingCreateMin.json" + }, + "Create or update an extended Sql pool's blob auditing policy with all parameters": { + "$ref": "./examples/ExtendedSqlPoolBlobAuditingCreateMax.json" + }, + "Create or update an extended SQL pool's azure monitor auditing policy with minimal parameters": { + "$ref": "./examples/ExtendedSqlPoolAzureMonitorAuditingCreateMin.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/extendedAuditingSettings": { + "get": { + "tags": [ + "SqlPools,BlobAuditing" + ], + "description": "Lists extended auditing settings of a Sql pool.", + "operationId": "ExtendedSqlPoolBlobAuditingPolicies_ListBySqlPool", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the database extended auditing settings.", + "schema": { + "$ref": "#/definitions/ExtendedSqlPoolBlobAuditingPolicyListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 BlobAuditingIsNotSupportedOnResourceType - Blob Auditing is currently not supported for this resource type.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List extended auditing settings of a database": { + "$ref": "./examples/SqlPoolExtendedAuditingSettingsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/dataMaskingPolicies/{dataMaskingPolicyName}": { + "put": { + "tags": [ + "SqlPools, DataMaskingPolicies" + ], + "operationId": "DataMaskingPolicies_CreateOrUpdate", + "description": "Creates or updates a Sql pool data masking policy", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "$ref": "#/parameters/DataMaskingPolicyNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataMaskingPolicy" + }, + "description": "Parameters for creating or updating a data masking policy." + } + ], + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Create or update data masking policy max": { + "$ref": "./examples/DataMaskingPolicyCreateOrUpdateMax.json" + }, + "Create or update data masking policy min": { + "$ref": "./examples/DataMaskingPolicyCreateOrUpdateMin.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DataMaskingPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "SqlPools, DataMaskingPolicies" + ], + "operationId": "DataMaskingPolicies_Get", + "description": "Gets a Sql pool data masking policy.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "$ref": "#/parameters/DataMaskingPolicyNameParameter" + } + ], + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get data masking policy": { + "$ref": "./examples/DataMaskingPolicyGet.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DataMaskingPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/dataMaskingPolicies/{dataMaskingPolicyName}/rules/{dataMaskingRuleName}": { + "put": { + "tags": [ + "SqlPools, DataMaskingRules" + ], + "operationId": "DataMaskingRules_CreateOrUpdate", + "description": "Creates or updates a Sql pool data masking rule.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "$ref": "#/parameters/DataMaskingPolicyNameParameter" + }, + { + "name": "dataMaskingRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the data masking rule." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataMaskingRule" + }, + "description": "The required parameters for creating or updating a data masking rule." + } + ], + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Create/Update data masking rule for text": { + "$ref": "./examples/DataMaskingRuleCreateOrUpdateText.json" + }, + "Create/Update data masking rule for numbers": { + "$ref": "./examples/DataMaskingRuleCreateOrUpdateNumber.json" + }, + "Create/Update data masking rule for default min": { + "$ref": "./examples/DataMaskingRuleCreateOrUpdateDefaultMin.json" + }, + "Create/Update data masking rule for default max": { + "$ref": "./examples/DataMaskingRuleCreateOrUpdateDefaultMax.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DataMaskingRule" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DataMaskingRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "SqlPools, DataMaskingRules" + ], + "operationId": "DataMaskingRules_Get", + "description": "Gets the specific Sql pool data masking rule.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "$ref": "#/parameters/DataMaskingPolicyNameParameter" + }, + { + "name": "dataMaskingRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the data masking rule." + } + ], + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get data masking rule": { + "$ref": "./examples/DataMaskingRuleGet.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DataMaskingRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/dataMaskingPolicies/{dataMaskingPolicyName}/rules": { + "get": { + "tags": [ + "SqlPools, DataMaskingRules" + ], + "operationId": "DataMaskingRules_ListBySqlPool", + "description": "Gets a list of Sql pool data masking rules.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "$ref": "#/parameters/DataMaskingPolicyNameParameter" + } + ], + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "List data masking rules": { + "$ref": "./examples/DataMaskingRuleList.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DataMaskingRuleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/auditingSettings": { + "get": { + "tags": [ + "SqlPools, BlobAuditing" + ], + "description": "Lists auditing settings of a Sql pool.", + "operationId": "SqlPoolBlobAuditingPolicies_ListBySqlPool", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + } + ], + "consumes": [], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully retrieved Sql pool auditing settings.", + "schema": { + "$ref": "#/definitions/SqlPoolBlobAuditingPolicyListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 BlobAuditingIsNotSupportedOnResourceType - Blob Auditing is currently not supported for this resource type.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List audit settings of a database": { + "$ref": "./examples/SqlPoolAuditingSettingsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/schemas/{schemaName}": { + "get": { + "tags": [ + "SqlPools, SqlPoolSchemas" + ], + "description": "Get Sql Pool schema", + "operationId": "SqlPoolSchemas_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "schemaName", + "in": "path", + "description": "The name of the schema.", + "required": true, + "type": "string" + } + ], + "consumes": [], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully retrieved Sql Pool schema.", + "schema": { + "$ref": "#/definitions/SqlPoolSchema" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 InvalidDatabaseSchema - Schema is missing in database.\n\n * 404 InvalidDatabaseTable - Table is missing in database.\n\n * 404 InvalidDatabaseColumn - Column is missing in table." + } + }, + "x-ms-examples": { + "Get database schema": { + "$ref": "./examples/SqlPoolSchemaGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/schemas/{schemaName}/tables/{tableName}": { + "get": { + "tags": [ + "SqlPools, SqlPoolTables" + ], + "description": "Get Sql pool table", + "operationId": "SqlPoolTables_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "schemaName", + "in": "path", + "description": "The name of the schema.", + "required": true, + "type": "string" + }, + { + "name": "tableName", + "in": "path", + "description": "The name of the table.", + "required": true, + "type": "string" + } + ], + "consumes": [], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully retrieved Sql pool's table.", + "schema": { + "$ref": "#/definitions/SqlPoolTable" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 InvalidDatabaseSchema - Schema is missing in database.\n\n * 404 InvalidDatabaseTable - Table is missing in database.\n\n * 404 InvalidDatabaseColumn - Column is missing in table." + } + }, + "x-ms-examples": { + "Get database table": { + "$ref": "./examples/SqlPoolTableGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}": { + "get": { + "tags": [ + "SqlPools, SqlPoolColumns" + ], + "description": "Get Sql pool column", + "operationId": "SqlPoolColumns_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "schemaName", + "in": "path", + "description": "The name of the schema.", + "required": true, + "type": "string" + }, + { + "name": "tableName", + "in": "path", + "description": "The name of the table.", + "required": true, + "type": "string" + }, + { + "name": "columnName", + "in": "path", + "description": "The name of the column.", + "required": true, + "type": "string" + } + ], + "consumes": [], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully retrieved Sql pool column.", + "schema": { + "$ref": "#/definitions/SqlPoolColumn" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 InvalidDatabaseSchema - Schema is missing in database.\n\n * 404 InvalidDatabaseTable - Table is missing in database.\n\n * 404 InvalidDatabaseColumn - Column is missing in table." + } + }, + "x-ms-examples": { + "Get database column": { + "$ref": "./examples/SqlPoolColumnGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}/scans/{scanId}": { + "get": { + "tags": [ + "SqlPools,SqlPoolVulnerabilityAssessmentScans" + ], + "description": "Gets a vulnerability assessment scan record of a Sql pool.", + "operationId": "SqlPoolVulnerabilityAssessmentScans_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "vulnerabilityAssessmentName", + "in": "path", + "description": "The name of the vulnerability assessment.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentName", + "modelAsString": true + } + }, + { + "name": "scanId", + "in": "path", + "description": "The vulnerability assessment scan Id of the scan to retrieve.", + "required": true, + "type": "string" + } + ], + "consumes": [], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully retrieved the Sql pool vulnerability assessment scan record.", + "schema": { + "$ref": "#/definitions/VulnerabilityAssessmentScanRecord" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 VulnerabilityAssessmentInvalidPolicy - Vulnerability Assessment settings don't exist or invalid storage specified in settings. \n\n * 400 DatabaseVulnerabilityAssessmentMissingStorageContainerPath - Storage container path must be provided if it isn't set in server level policy\n\n * 400 VulnerabilityAssessmentDatawarehouseDatabaseIsDeactivated - Could not execute Vulnerability Assessment operation because the database is paused. Please resume it.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - Vulnerability Assessment scan is already in progress.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + } + }, + "x-ms-examples": { + "Gets a database vulnerability assessment scan record by scan ID": { + "$ref": "./examples/SqlPoolVulnerabilityAssessmentScanRecordsGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/restorePoints/{restorePointName}": { + "get": { + "tags": [ + "SqlPools, RestorePoints" + ], + "description": "Gets a restore point.", + "operationId": "SqlPoolRestorePoints_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "restorePointName", + "in": "path", + "description": "The name of the restore point.", + "required": true, + "type": "string" + } + ], + "consumes": [], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully returned the restore point.", + "schema": { + "$ref": "#/definitions/RestorePoint" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 BackupNotAllowedOnDeactivatedDatabase - Cannot create restore point on a deactivated database.\n\n * 400 RestorePointLimitReached - A restore point cannot be created because database would exceed the allowed quota of restore points.\n\n * 400 RestorePointAttemptToDeleteSystemBackup - Cannot delete system restore point.\n\n * 404 DatabaseRestorePointNotFound - Can not find database restore point.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 408 DatabaseRestorePointTimedOut - Create database restore point failed." + } + }, + "x-ms-examples": { + "Gets a Sql pool restore point.": { + "$ref": "./examples/SqlPoolRestorePointsGet.json" + } + } + }, + "delete": { + "tags": [ + "SqlPools, RestorePoints" + ], + "description": "Deletes a restore point.", + "operationId": "SqlPoolRestorePoints_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "restorePointName", + "in": "path", + "description": "The name of the restore point.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the restore point." + }, + "204": { + "description": "The specified restore point does not exist." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 BackupNotAllowedOnDeactivatedDatabase - Cannot create restore point on a deactivated database.\n\n * 400 RestorePointLimitReached - A restore point cannot be created because database would exceed the allowed quota of restore points.\n\n * 400 RestorePointAttemptToDeleteSystemBackup - Cannot delete system restore point.\n\n * 404 DatabaseRestorePointNotFound - Can not find database restore point.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 408 DatabaseRestorePointTimedOut - Create database restore point failed." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Deletes a restore point.": { + "$ref": "./examples/SqlPoolRestorePointsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/workloadGroups/{workloadGroupName}": { + "get": { + "operationId": "SqlPoolWorkloadGroup_Get", + "summary": "Sql pool's workload group", + "description": "Get a Sql pool's workload group.", + "tags": [ + "SqlPools, WorkloadGroups" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "workloadGroupName", + "in": "path", + "description": "The name of the workload group.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specifies workload group.", + "schema": { + "$ref": "#/definitions/WorkloadGroup" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OperationNotAllowedOnPausedDatabase - Operation is not allowed on a paused database.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get a a workload group of a SQL Analytics pool": { + "$ref": "./examples/GetSqlPoolWorkloadGroup.json" + } + } + }, + "put": { + "operationId": "SqlPoolWorkloadGroup_CreateOrUpdate", + "summary": "Create Or Update workload group", + "description": "Create Or Update a Sql pool's workload group.", + "tags": [ + "SqlPools, WorkloadGroups" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "workloadGroupName", + "in": "path", + "description": "The name of the workload group.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The requested workload group state.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkloadGroup" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the workload group.", + "schema": { + "$ref": "#/definitions/WorkloadGroup" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OperationNotAllowedOnPausedDatabase - Operation is not allowed on a paused database.\n\n * 400 InvalidWorkloadGroupNameParameter - Invalid workload group name\n\n * 400 InvalidMinResourcePercentParameter - Invalid min resource percent for this workload group.\n\n * 400 InvalidMinResourcePercentPerRequestParameter - Invalid min resource percent per query for this workload group.\n\n * 400 InvalidMaxResourcePercentParameter - Invalid max resource percent to allocate for this workload group.\n\n * 400 InvalidMaxResourcePercentPerRequestParameter - Invalid max resource percent per query for this workload group.\n\n * 400 InvalidImportanceParameter - Importance must be one of the following strings: Low, Below_Normal, Normal, Above_Normal, High.\n\n * 400 InvalidQueryExecutionTimeoutParameter - Invalid query execution timeout value for this workload group.\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + }, + "202": { + "description": "Create or update for the workload group accepted." + }, + "201": { + "description": "Successfully created the workload group.", + "schema": { + "$ref": "#/definitions/WorkloadGroup" + } + } + }, + "x-ms-long-running-operation": true, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Create a workload group with the required properties specified.": { + "$ref": "./examples/CreateOrUpdateSqlPoolWorkloadGroupMin.json" + }, + "Create a workload group with all properties specified.": { + "$ref": "./examples/CreateOrUpdateSqlPoolWorkloadGroupMax.json" + } + } + }, + "delete": { + "operationId": "SqlPoolWorkloadGroup_Delete", + "summary": "Remove workload group", + "description": "Remove Sql pool's workload group.", + "tags": [ + "SqlPools, WorkloadGroups" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "workloadGroupName", + "in": "path", + "description": "The name of the workload group.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the workload group." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OperationNotAllowedOnPausedDatabase - Operation is not allowed on a paused database.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + }, + "202": { + "description": "Deleting the workload group is in progress." + }, + "204": { + "description": "The specified workload group does not exist." + } + }, + "x-ms-long-running-operation": true, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Delete a workload group of a SQL Analytics pool": { + "$ref": "./examples/DeleteSqlPoolWorkloadGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/workloadGroups": { + "get": { + "operationId": "SqlPoolWorkloadGroup_List", + "summary": "Sql pool's workload groups", + "description": "Get list of Sql pool's workload groups.", + "tags": [ + "SqlPools, WorkloadGroups" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of workload groups.", + "schema": { + "$ref": "#/definitions/WorkloadGroupListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OperationNotAllowedOnPausedDatabase - Operation is not allowed on a paused database.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get the list of workload groups of a SQL Analytics pool": { + "$ref": "./examples/GetSqlPoolWorkloadGroupList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/workloadGroups/{workloadGroupName}/workloadClassifiers/{workloadClassifierName}": { + "get": { + "operationId": "SqlPoolWorkloadClassifier_Get", + "summary": "Get workload classifier", + "description": "Get a workload classifier of Sql pool's workload group.", + "tags": [ + "SqlPools, WorkloadClassifiers" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "workloadGroupName", + "in": "path", + "description": "The name of the workload group.", + "required": true, + "type": "string" + }, + { + "name": "workloadClassifierName", + "in": "path", + "description": "The name of the workload classifier.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specifies workload classifier.", + "schema": { + "$ref": "#/definitions/WorkloadClassifier" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OperationNotAllowedOnPausedDatabase - Operation is not allowed on a paused database.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get a workload classifier for SQL Analytics pool's workload group": { + "$ref": "./examples/GetSqlPoolWorkloadGroupWorkloadClassifier.json" + } + } + }, + "put": { + "operationId": "SqlPoolWorkloadClassifier_CreateOrUpdate", + "summary": "Create Or Update workload classifier", + "description": "Create Or Update workload classifier for a Sql pool's workload group.", + "tags": [ + "SqlPools, WorkloadClassifiers" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "workloadGroupName", + "in": "path", + "description": "The name of the workload group.", + "required": true, + "type": "string" + }, + { + "name": "workloadClassifierName", + "in": "path", + "description": "The name of the workload classifier.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The properties of the workload classifier.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkloadClassifier" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the workload classifier.", + "schema": { + "$ref": "#/definitions/WorkloadClassifier" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OperationNotAllowedOnPausedDatabase - Operation is not allowed on a paused database.\n\n * 400 InvalidMemberNameParameter - Invalid member name parameter for this workload classifier.\n\n * 400 InvalidStartTimeAndEndTimeParameters - Invalid start time and end time parameters for the workload classifier.\n\n * 400 InvalidImportanceParameter - Importance must be one of the following strings: Low, Below_Normal, Normal, Above_Normal, High.\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + }, + "202": { + "description": "Create or update for the workload classifier is in progress." + }, + "201": { + "description": "Successfully created the workload classifier.", + "schema": { + "$ref": "#/definitions/WorkloadClassifier" + } + } + }, + "x-ms-long-running-operation": true, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Create a workload classifier with the required properties specified.": { + "$ref": "./examples/CreateOrUpdateSqlPoolWorkloadClassifierMin.json" + }, + "Create a workload classifier with all properties specified.": { + "$ref": "./examples/CreateOrUpdateSqlPoolWorkloadClassifierMax.json" + } + } + }, + "delete": { + "operationId": "SqlPoolWorkloadClassifier_Delete", + "summary": "Remove workload classifier", + "description": "Remove workload classifier of a Sql pool's workload group.", + "tags": [ + "SqlPools, WorkloadClassifiers" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "workloadGroupName", + "in": "path", + "description": "The name of the workload group.", + "required": true, + "type": "string" + }, + { + "name": "workloadClassifierName", + "in": "path", + "description": "The name of the workload classifier.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the workload classifier." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OperationNotAllowedOnPausedDatabase - Operation is not allowed on a paused database.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + }, + "202": { + "description": "Deleting the workload classifier is in progress." + }, + "204": { + "description": "The specified workload classifier does not exist." + } + }, + "x-ms-long-running-operation": true, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Delete a workload classifier of a SQL Analytics pool's workload group": { + "$ref": "./examples/DeleteSqlPoolWorkloadGroupWorkloadClassifer.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/workloadGroups/{workloadGroupName}/workloadClassifiers": { + "get": { + "operationId": "SqlPoolWorkloadClassifier_List", + "summary": "Sql pool's workload classifier", + "description": "Get list of Sql pool's workload classifier for workload groups.", + "tags": [ + "SqlPools, WorkloadClassifiers" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "sqlPoolName", + "description": "SQL pool name", + "required": true + }, + { + "name": "workloadGroupName", + "in": "path", + "description": "The name of the workload group.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of workload groups.", + "schema": { + "$ref": "#/definitions/WorkloadClassifierListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OperationNotAllowedOnPausedDatabase - Operation is not allowed on a paused database.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get the list of workload classifiers of a SQL Analytics pool's workload group": { + "$ref": "./examples/GetSqlPoolWorkloadGroupWorkloadClassifierList.json" + } + } + } + } + }, + "definitions": { + "SqlPoolInfoListResult": { + "type": "object", + "title": "SQL pool collection", + "description": "List of SQL pools", + "properties": { + "nextLink": { + "type": "string", + "description": "Link to the next page of results" + }, + "value": { + "type": "array", + "description": "List of SQL pools", + "items": { + "$ref": "#/definitions/SqlPool" + } + } + } + }, + "SqlPool": { + "type": "object", + "title": "SQL pool", + "description": "A SQL Analytics pool", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "SQL pool SKU" + }, + "properties": { + "$ref": "#/definitions/SqlPoolResourceProperties", + "description": "SQL pool properties", + "x-ms-client-flatten": true + } + } + }, + "SqlPoolPatchInfo": { + "type": "object", + "title": "SQL pool patch info", + "description": "A SQL Analytics pool patch info", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + }, + "location": { + "type": "string", + "description": "The geo-location where the resource lives" + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "SQL pool SKU" + }, + "properties": { + "$ref": "#/definitions/SqlPoolResourceProperties", + "description": "SQL pool properties", + "x-ms-client-flatten": true + } + } + }, + "Sku": { + "type": "object", + "title": "Sku", + "description": "SQL pool SKU", + "properties": { + "tier": { + "type": "string", + "description": "The service tier" + }, + "name": { + "type": "string", + "description": "The SKU name" + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted." + } + } + }, + "SqlPoolResourceProperties": { + "type": "object", + "title": "SQL pool properties", + "description": "Properties of a SQL Analytics pool", + "properties": { + "maxSizeBytes": { + "type": "integer", + "description": "Maximum size in bytes", + "format": "int64" + }, + "collation": { + "type": "string", + "description": "Collation mode" + }, + "sourceDatabaseId": { + "type": "string", + "description": "Source database to create from" + }, + "recoverableDatabaseId": { + "type": "string", + "description": "Backup database to restore from" + }, + "provisioningState": { + "type": "string", + "description": "Resource state" + }, + "status": { + "type": "string", + "description": "Resource status" + }, + "restorePointInTime": { + "type": "string", + "description": "Snapshot time to restore", + "format": "date-time" + }, + "createMode": { + "type": "string", + "description": "What is this?" + }, + "creationDate": { + "type": "string", + "description": "Date the SQL pool was created", + "format": "date-time" + }, + "storageAccountType": { + "description": "The storage account type used to store backups for this sql pool.", + "enum": [ + "GRS", + "LRS", + "ZRS" + ], + "type": "string", + "x-ms-enum": { + "name": "StorageAccountType", + "modelAsString": true + } + } + } + }, + "MetadataSyncConfig": { + "type": "object", + "title": "Metadata sync configuration", + "description": "Configuration for metadata sync", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "title": "Metadata Sync Config properties", + "description": "Metadata Sync Config properties", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates whether the metadata sync is enabled or disabled" + }, + "syncIntervalInMinutes": { + "type": "integer", + "format": "int32", + "description": "The Sync Interval in minutes." + } + }, + "x-ms-client-flatten": true + } + } + }, + "GeoBackupPolicyProperties": { + "properties": { + "state": { + "type": "string", + "description": "The state of the geo backup policy.", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "modelAsString": false, + "name": "GeoBackupPolicyState" + } + }, + "storageType": { + "type": "string", + "description": "The storage type of the geo backup policy.", + "readOnly": true + } + }, + "required": [ + "state" + ], + "description": "The properties of the geo backup policy." + }, + "GeoBackupPolicy": { + "properties": { + "properties": { + "$ref": "#/definitions/GeoBackupPolicyProperties", + "description": "The properties of the geo backup policy.", + "x-ms-client-flatten": true + }, + "kind": { + "readOnly": true, + "type": "string", + "description": "Kind of geo backup policy. This is metadata used for the Azure portal experience." + }, + "location": { + "type": "string", + "readOnly": true, + "description": "Backup policy location." + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "A database geo backup policy." + }, + "GeoBackupPolicyListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GeoBackupPolicy" + }, + "description": "The list of geo backup policies." + } + }, + "description": "The response to a list geo backup policies request." + }, + "TopQueries": { + "properties": { + "aggregationFunction": { + "description": "The function that is used to aggregate each query's metrics.", + "type": "string", + "enum": [ + "min", + "max", + "avg", + "sum" + ], + "x-ms-enum": { + "name": "QueryAggregationFunction", + "modelAsString": false + }, + "readOnly": true + }, + "executionType": { + "description": "The execution type that is used to filter the query instances that are returned.", + "type": "string", + "enum": [ + "any", + "regular", + "irregular", + "aborted", + "exception" + ], + "x-ms-enum": { + "name": "QueryExecutionType", + "modelAsString": false + }, + "readOnly": true + }, + "intervalType": { + "description": "The duration of the interval (ISO8601 duration format).", + "type": "string", + "readOnly": true + }, + "numberOfTopQueries": { + "description": "The number of requested queries.", + "type": "number", + "format": "int32", + "readOnly": true + }, + "observationStartTime": { + "description": "The start time for queries that are returned (ISO8601 format)", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "observationEndTime": { + "description": "The end time for queries that are returned (ISO8601 format)", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "observedMetric": { + "description": "The type of metric to use for ordering the top metrics.", + "type": "string", + "enum": [ + "cpu", + "io", + "logio", + "duration", + "executionCount" + ], + "x-ms-enum": { + "name": "QueryObservedMetricType", + "modelAsString": false + }, + "readOnly": true + }, + "queries": { + "type": "array", + "items": { + "$ref": "#/definitions/QueryStatistic" + }, + "description": "The list of queries.", + "readOnly": true + } + }, + "description": "A database query." + }, + "QueryStatistic": { + "properties": { + "queryId": { + "description": "The id of the query", + "type": "string", + "readOnly": true + }, + "intervals": { + "type": "array", + "items": { + "$ref": "#/definitions/QueryInterval" + }, + "description": "The list of query intervals.", + "readOnly": true + } + }, + "description": "A database query." + }, + "QueryInterval": { + "properties": { + "intervalStartTime": { + "description": "The start time of the measurement interval (ISO8601 format).", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "executionCount": { + "description": "The number of times the query was executed during this interval.", + "type": "number", + "format": "int32", + "readOnly": true + }, + "metrics": { + "type": "array", + "items": { + "$ref": "#/definitions/QueryMetric" + }, + "description": "The list of query metrics during this interval.", + "readOnly": true + } + }, + "description": "A database query." + }, + "QueryMetric": { + "properties": { + "name": { + "description": "The name of the metric", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The name of the metric for display in user interface", + "type": "string", + "readOnly": true + }, + "unit": { + "description": "The unit of measurement", + "type": "string", + "enum": [ + "percentage", + "KB", + "microseconds" + ], + "x-ms-enum": { + "name": "QueryMetricUnit", + "modelAsString": false + }, + "readOnly": true + }, + "value": { + "description": "The measured value", + "type": "number", + "format": "double", + "readOnly": true + } + }, + "description": "A database query." + }, + "TopQueriesListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TopQueries" + }, + "description": "The list of top queries." + } + }, + "required": [ + "value" + ], + "description": "Represents the response to a get top queries request." + }, + "DataWarehouseUserActivitiesProperties": { + "description": "User activities of a data warehouse. This currently includes the count of running or suspended queries. For more information, please view the sys.dm_pdw_exec_requests dynamic management view (DMV).", + "type": "object", + "properties": { + "activeQueriesCount": { + "format": "int32", + "description": "Count of running and suspended queries.", + "type": "integer", + "readOnly": true + } + } + }, + "DataWarehouseUserActivities": { + "description": "User activities of a data warehouse", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DataWarehouseUserActivitiesProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "RestorePointListResult": { + "description": "A list of long term retention backups.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/RestorePoint" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "RestorePointProperties": { + "description": "Properties of a database restore point", + "type": "object", + "properties": { + "restorePointType": { + "description": "The type of restore point", + "enum": [ + "CONTINUOUS", + "DISCRETE" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RestorePointType", + "modelAsString": false + } + }, + "earliestRestoreDate": { + "format": "date-time", + "description": "The earliest time to which this database can be restored", + "type": "string", + "readOnly": true + }, + "restorePointCreationDate": { + "format": "date-time", + "description": "The time the backup was taken", + "type": "string", + "readOnly": true + }, + "restorePointLabel": { + "description": "The label of restore point for backup request by user", + "type": "string", + "readOnly": true + } + } + }, + "RestorePoint": { + "description": "Database restore points.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "location": { + "description": "Resource location.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/RestorePointProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "ReplicationLinkProperties": { + "properties": { + "isTerminationAllowed": { + "readOnly": true, + "type": "boolean", + "description": "Legacy value indicating whether termination is allowed. Currently always returns true." + }, + "replicationMode": { + "readOnly": true, + "type": "string", + "description": "Replication mode of this replication link." + }, + "partnerServer": { + "readOnly": true, + "type": "string", + "description": "The name of the workspace hosting the partner Sql pool." + }, + "partnerDatabase": { + "readOnly": true, + "type": "string", + "description": "The name of the partner Sql pool." + }, + "partnerLocation": { + "readOnly": true, + "type": "string", + "description": "The Azure Region of the partner Sql pool." + }, + "role": { + "readOnly": true, + "type": "string", + "description": "The role of the Sql pool in the replication link.", + "enum": [ + "Primary", + "Secondary", + "NonReadableSecondary", + "Source", + "Copy" + ], + "x-ms-enum": { + "name": "ReplicationRole" + } + }, + "partnerRole": { + "readOnly": true, + "type": "string", + "description": "The role of the partner Sql pool in the replication link.", + "enum": [ + "Primary", + "Secondary", + "NonReadableSecondary", + "Source", + "Copy" + ], + "x-ms-enum": { + "name": "ReplicationRole" + } + }, + "startTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The start time for the replication link." + }, + "percentComplete": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The percentage of seeding complete for the replication link." + }, + "replicationState": { + "readOnly": true, + "type": "string", + "description": "The replication state for the replication link.", + "enum": [ + "PENDING", + "SEEDING", + "CATCH_UP", + "SUSPENDED" + ], + "x-ms-enum": { + "name": "ReplicationState", + "modelAsString": true + } + } + }, + "description": "Represents the properties of a Sql pool replication link." + }, + "ReplicationLink": { + "properties": { + "location": { + "type": "string", + "description": "Location of the workspace that contains this firewall rule.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Type of resource this is.", + "readOnly": true + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ReplicationLinkProperties", + "description": "The properties representing the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Represents a Sql pool replication link." + }, + "ReplicationLinkListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationLink" + }, + "description": "The list of Sql pool replication links housed in the Sql pool." + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + }, + "description": "Represents the response to a List Sql pool replication link request." + }, + "MaintenanceWindowOptionsProperties": { + "description": "Maintenance window options properties.", + "type": "object", + "properties": { + "isEnabled": { + "description": "Whether maintenance windows are enabled for the database.", + "type": "boolean" + }, + "maintenanceWindowCycles": { + "description": "Available maintenance cycles e.g. {Saturday, 0, 48*60}, {Wednesday, 0, 24*60}.", + "type": "array", + "items": { + "$ref": "#/definitions/MaintenanceWindowTimeRange" + } + }, + "minDurationInMinutes": { + "format": "int32", + "description": "Minimum duration of maintenance window.", + "type": "integer" + }, + "defaultDurationInMinutes": { + "format": "int32", + "description": "Default duration for maintenance window.", + "type": "integer" + }, + "minCycles": { + "format": "int32", + "description": "Minimum number of maintenance windows cycles to be set on the database.", + "type": "integer" + }, + "timeGranularityInMinutes": { + "format": "int32", + "description": "Time granularity in minutes for maintenance windows.", + "type": "integer" + }, + "allowMultipleMaintenanceWindowsPerCycle": { + "description": "Whether we allow multiple maintenance windows per cycle.", + "type": "boolean" + } + } + }, + "MaintenanceWindowOptions": { + "description": "Maintenance window options.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MaintenanceWindowOptionsProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "MaintenanceWindowsProperties": { + "description": "Maintenance windows resource properties.", + "type": "object", + "properties": { + "timeRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/MaintenanceWindowTimeRange" + } + } + } + }, + "MaintenanceWindowTimeRange": { + "description": "Maintenance window time range.", + "type": "object", + "properties": { + "dayOfWeek": { + "description": "Day of maintenance window.", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "type": "string", + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": true + } + }, + "startTime": { + "description": "Start time minutes offset from 12am.", + "type": "string" + }, + "duration": { + "description": "Duration of maintenance window in minutes.", + "type": "string" + } + } + }, + "MaintenanceWindows": { + "description": "Maintenance windows.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MaintenanceWindowsProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "TransparentDataEncryptionProperties": { + "properties": { + "status": { + "type": "string", + "description": "The status of the database transparent data encryption.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "TransparentDataEncryptionStatus" + } + } + }, + "description": "Represents the properties of a database transparent data encryption." + }, + "TransparentDataEncryption": { + "properties": { + "location": { + "type": "string", + "readOnly": true, + "description": "Resource location." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TransparentDataEncryptionProperties", + "description": "Represents the properties of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Represents a Sql pool transparent data encryption configuration." + }, + "TransparentDataEncryptionListResult": { + "description": "A list of transparent data encryption configurations.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/TransparentDataEncryption" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "SqlPoolBlobAuditingPolicyProperties": { + "description": "Properties of a Sql pool blob auditing policy.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "state": { + "description": "Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "BlobAuditingPolicyState", + "modelAsString": false + } + }, + "storageEndpoint": { + "description": "Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint is required.", + "type": "string" + }, + "storageAccountAccessKey": { + "description": "Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "retentionDays": { + "format": "int32", + "description": "Specifies the number of days to keep in the audit logs in the storage account.", + "type": "integer" + }, + "auditActionsAndGroups": { + "description": "Specifies the Actions-Groups and Actions to audit.\r\n\r\nThe recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:\r\n\r\nBATCH_COMPLETED_GROUP,\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,\r\nFAILED_DATABASE_AUTHENTICATION_GROUP.\r\n\r\nThis above combination is also the set that is configured by default when enabling auditing from the Azure portal.\r\n\r\nThe supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):\r\n\r\nAPPLICATION_ROLE_CHANGE_PASSWORD_GROUP\r\nBACKUP_RESTORE_GROUP\r\nDATABASE_LOGOUT_GROUP\r\nDATABASE_OBJECT_CHANGE_GROUP\r\nDATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nDATABASE_OBJECT_PERMISSION_CHANGE_GROUP\r\nDATABASE_OPERATION_GROUP\r\nDATABASE_PERMISSION_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_IMPERSONATION_GROUP\r\nDATABASE_ROLE_MEMBER_CHANGE_GROUP\r\nFAILED_DATABASE_AUTHENTICATION_GROUP\r\nSCHEMA_OBJECT_ACCESS_GROUP\r\nSCHEMA_OBJECT_CHANGE_GROUP\r\nSCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nSCHEMA_OBJECT_PERMISSION_CHANGE_GROUP\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP\r\nUSER_CHANGE_PASSWORD_GROUP\r\nBATCH_STARTED_GROUP\r\nBATCH_COMPLETED_GROUP\r\n\r\nThese are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.\r\n\r\nFor more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).\r\n\r\nFor Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:\r\nSELECT\r\nUPDATE\r\nINSERT\r\nDELETE\r\nEXECUTE\r\nRECEIVE\r\nREFERENCES\r\n\r\nThe general form for defining an action to be audited is:\r\n{action} ON {object} BY {principal}\r\n\r\nNote that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.\r\n\r\nFor example:\r\nSELECT on dbo.myTable by public\r\nSELECT on DATABASE::myDatabase by public\r\nSELECT on SCHEMA::mySchema by public\r\n\r\nFor more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)", + "type": "array", + "items": { + "type": "string" + } + }, + "storageAccountSubscriptionId": { + "format": "uuid", + "description": "Specifies the blob storage subscription Id.", + "type": "string" + }, + "isStorageSecondaryKeyInUse": { + "description": "Specifies whether storageAccountAccessKey value is the storage's secondary key.", + "type": "boolean" + }, + "isAzureMonitorTargetEnabled": { + "description": "Specifies whether audit events are sent to Azure Monitor. \r\nIn order to send the events to Azure Monitor, specify 'state' as 'Enabled' and 'isAzureMonitorTargetEnabled' as true.\r\n\r\nWhen using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.\r\nNote that for server level audit you should use the 'master' database as {databaseName}.\r\n\r\nDiagnostic Settings URI format:\r\nPUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview\r\n\r\nFor more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)\r\nor [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)\r\n", + "type": "boolean" + } + } + }, + "SqlPoolBlobAuditingPolicy": { + "description": "A Sql pool blob auditing policy.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "kind": { + "description": "Resource kind.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/SqlPoolBlobAuditingPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "SqlPoolBlobAuditingPolicySqlPoolOperationListResult": { + "description": "The response to a list Sql pool operations request", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlPoolOperation" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "SqlPoolOperationProperties": { + "description": "The properties of a Sql pool operation.", + "type": "object", + "properties": { + "databaseName": { + "description": "The name of the Sql pool the operation is being performed on.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "The name of operation.", + "type": "string", + "readOnly": true + }, + "operationFriendlyName": { + "description": "The friendly name of operation.", + "type": "string", + "readOnly": true + }, + "percentComplete": { + "format": "int32", + "description": "The percentage of the operation completed.", + "type": "integer", + "readOnly": true + }, + "serverName": { + "description": "The name of the server.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "The operation start time.", + "type": "string", + "readOnly": true + }, + "state": { + "description": "The operation state.", + "enum": [ + "Pending", + "InProgress", + "Succeeded", + "Failed", + "CancelInProgress", + "Cancelled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ManagementOperationState", + "modelAsString": true + } + }, + "errorCode": { + "format": "int32", + "description": "The operation error code.", + "type": "integer", + "readOnly": true + }, + "errorDescription": { + "description": "The operation error description.", + "type": "string", + "readOnly": true + }, + "errorSeverity": { + "format": "int32", + "description": "The operation error severity.", + "type": "integer", + "readOnly": true + }, + "isUserError": { + "description": "Whether or not the error is a user error.", + "type": "boolean", + "readOnly": true + }, + "estimatedCompletionTime": { + "format": "date-time", + "description": "The estimated completion time of the operation.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The operation description.", + "type": "string", + "readOnly": true + }, + "isCancellable": { + "description": "Whether the operation can be cancelled.", + "type": "boolean", + "readOnly": true + } + } + }, + "SqlPoolOperation": { + "description": "A Sql pool operation.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlPoolOperationProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "SqlPoolUsage": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the usage metric." + }, + "resourceName": { + "readOnly": true, + "type": "string", + "description": "The name of the resource." + }, + "displayName": { + "readOnly": true, + "type": "string", + "description": "The usage metric display name." + }, + "currentValue": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The current value of the usage metric." + }, + "limit": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The current limit of the usage metric." + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "The units of the usage metric." + }, + "nextResetTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The next reset time for the usage metric (ISO8601 format)." + } + }, + "description": "The Sql pool usages." + }, + "SqlPoolUsageListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SqlPoolUsage" + }, + "description": "The list of usages for the Sql pool." + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + }, + "required": [ + "value" + ], + "description": "The response to a list Sql pool usages request." + }, + "SensitivityLabelProperties": { + "description": "Properties of a sensitivity label.", + "type": "object", + "properties": { + "schemaName": { + "description": "The schema name.", + "type": "string", + "readOnly": true + }, + "tableName": { + "description": "The table name.", + "type": "string", + "readOnly": true + }, + "columnName": { + "description": "The column name.", + "type": "string", + "readOnly": true + }, + "labelName": { + "description": "The label name.", + "type": "string" + }, + "labelId": { + "description": "The label ID.", + "type": "string" + }, + "informationType": { + "description": "The information type.", + "type": "string" + }, + "informationTypeId": { + "description": "The information type ID.", + "type": "string" + }, + "isDisabled": { + "description": "Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not.", + "type": "boolean", + "readOnly": true + }, + "rank": { + "enum": [ + "None", + "Low", + "Medium", + "High", + "Critical" + ], + "type": "string", + "x-ms-enum": { + "name": "SensitivityLabelRank", + "modelAsString": false + } + } + } + }, + "SensitivityLabel": { + "description": "A sensitivity label.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SensitivityLabelProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + }, + "managedBy": { + "type": "string", + "readOnly": true, + "description": "managed by" + } + } + }, + "SensitivityLabelListResult": { + "description": "A list of sensitivity labels.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SensitivityLabel" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "SqlPoolSchema": { + "description": "A Sql pool schema resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlPoolSchemaListResult": { + "description": "A list of Sql pool schemas.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlPoolSchema" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "SqlPoolTable": { + "description": "A Sql pool table resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlPoolTableListResult": { + "description": "A list of Sql pool tables.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlPoolTable" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "SqlPoolColumnProperties": { + "description": "Sql pool column properties.", + "type": "object", + "properties": { + "columnType": { + "description": "The column data type.", + "enum": [ + "image", + "text", + "uniqueidentifier", + "date", + "time", + "datetime2", + "datetimeoffset", + "tinyint", + "smallint", + "int", + "smalldatetime", + "real", + "money", + "datetime", + "float", + "sql_variant", + "ntext", + "bit", + "decimal", + "numeric", + "smallmoney", + "bigint", + "hierarchyid", + "geometry", + "geography", + "varbinary", + "varchar", + "binary", + "char", + "timestamp", + "nvarchar", + "nchar", + "xml", + "sysname" + ], + "type": "string", + "x-ms-enum": { + "name": "ColumnDataType", + "modelAsString": true + } + }, + "isComputed": { + "type": "boolean", + "description": "Indicates whether column value is computed or not", + "readOnly": true + } + } + }, + "SqlPoolColumn": { + "description": "A Sql pool column resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlPoolColumnProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "SqlPoolColumnListResult": { + "description": "A list of Sql pool columns.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlPoolColumn" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "SqlPoolConnectionPolicyProperties": { + "description": "Properties of a Sql pool connection policy.", + "type": "object", + "properties": { + "securityEnabledAccess": { + "description": "The state of security access.", + "type": "string" + }, + "proxyDnsName": { + "description": "The fully qualified host name of the auditing proxy.", + "type": "string" + }, + "proxyPort": { + "description": "The port number of the auditing proxy.", + "type": "string" + }, + "visibility": { + "description": "The visibility of the auditing proxy.", + "type": "string" + }, + "useServerDefault": { + "description": "Whether server default is enabled or disabled.", + "type": "string" + }, + "redirectionState": { + "description": "The state of proxy redirection.", + "type": "string" + }, + "state": { + "description": "The connection policy state.", + "type": "string" + } + } + }, + "SqlPoolConnectionPolicy": { + "description": "A Sql pool connection policy.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "kind": { + "description": "Resource kind.", + "type": "string", + "readOnly": true + }, + "location": { + "type": "string", + "readOnly": true, + "description": "Resource location." + }, + "properties": { + "$ref": "#/definitions/SqlPoolConnectionPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "SqlPoolVulnerabilityAssessmentProperties": { + "description": "Properties of a Sql pool Vulnerability Assessment.", + "type": "object", + "properties": { + "storageContainerPath": { + "description": "A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). It is required if server level vulnerability assessment policy doesn't set", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "storageContainerSasKey": { + "description": "A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "storageAccountAccessKey": { + "description": "Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "recurringScans": { + "$ref": "#/definitions/VulnerabilityAssessmentRecurringScansProperties", + "description": "The recurring scans settings" + } + } + }, + "VulnerabilityAssessmentRecurringScansProperties": { + "description": "Properties of a Vulnerability Assessment recurring scans.", + "type": "object", + "properties": { + "isEnabled": { + "description": "Recurring scans state.", + "type": "boolean" + }, + "emailSubscriptionAdmins": { + "description": "Specifies that the schedule scan notification will be is sent to the subscription administrators.", + "default": true, + "type": "boolean" + }, + "emails": { + "description": "Specifies an array of e-mail addresses to which the scan notification is sent.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SqlPoolVulnerabilityAssessment": { + "description": "A Sql pool vulnerability assessment.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlPoolVulnerabilityAssessmentProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "SqlPoolVulnerabilityAssessmentListResult": { + "description": "A list of the Sql pool's vulnerability assessments.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlPoolVulnerabilityAssessment" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "VulnerabilityAssessmentScanRecordListResult": { + "description": "A list of vulnerability assessment scan records.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/VulnerabilityAssessmentScanRecord" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "VulnerabilityAssessmentScanRecord": { + "description": "A vulnerability assessment scan record.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/VulnerabilityAssessmentScanRecordProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "VulnerabilityAssessmentScanRecordProperties": { + "description": "Properties of a vulnerability assessment scan record.", + "type": "object", + "properties": { + "scanId": { + "description": "The scan ID.", + "type": "string", + "readOnly": true + }, + "triggerType": { + "description": "The scan trigger type.", + "enum": [ + "OnDemand", + "Recurring" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VulnerabilityAssessmentScanTriggerType", + "modelAsString": true + } + }, + "state": { + "description": "The scan status.", + "enum": [ + "Passed", + "Failed", + "FailedToRun", + "InProgress" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VulnerabilityAssessmentScanState", + "modelAsString": true + } + }, + "startTime": { + "format": "date-time", + "description": "The scan start time (UTC).", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "The scan end time (UTC).", + "type": "string", + "readOnly": true + }, + "errors": { + "description": "The scan errors.", + "type": "array", + "items": { + "$ref": "#/definitions/VulnerabilityAssessmentScanError" + }, + "readOnly": true + }, + "storageContainerPath": { + "description": "The scan results storage container path.", + "type": "string", + "readOnly": true + }, + "numberOfFailedSecurityChecks": { + "format": "int32", + "description": "The number of failed security checks.", + "type": "integer", + "readOnly": true + } + } + }, + "VulnerabilityAssessmentScanError": { + "description": "Properties of a vulnerability assessment scan error.", + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The error message.", + "type": "string", + "readOnly": true + } + } + }, + "SecurityAlertPolicyProperties": { + "description": "Properties of a security alert policy.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "state": { + "description": "Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific Sql pool.", + "enum": [ + "New", + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "SecurityAlertPolicyState", + "modelAsString": false + } + }, + "disabledAlerts": { + "description": "Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action", + "type": "array", + "items": { + "type": "string" + } + }, + "emailAddresses": { + "description": "Specifies an array of e-mail addresses to which the alert is sent.", + "type": "array", + "items": { + "type": "string" + } + }, + "emailAccountAdmins": { + "description": "Specifies that the alert is sent to the account administrators.", + "type": "boolean" + }, + "storageEndpoint": { + "description": "Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.", + "type": "string" + }, + "storageAccountAccessKey": { + "description": "Specifies the identifier key of the Threat Detection audit storage account.", + "type": "string" + }, + "retentionDays": { + "format": "int32", + "description": "Specifies the number of days to keep in the Threat Detection audit logs.", + "type": "integer" + }, + "creationTime": { + "format": "date-time", + "description": "Specifies the UTC creation time of the policy.", + "type": "string", + "readOnly": true + } + } + }, + "SqlPoolSecurityAlertPolicy": { + "description": "A Sql pool security alert policy.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SecurityAlertPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "ListSqlPoolSecurityAlertPolicies": { + "description": "A list of SQL pool security alert policies.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlPoolSecurityAlertPolicy" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "SqlPoolVulnerabilityAssessmentRuleBaselineProperties": { + "description": "Properties of a Sql pool vulnerability assessment rule baseline.", + "required": [ + "baselineResults" + ], + "type": "object", + "properties": { + "baselineResults": { + "description": "The rule baseline result", + "type": "array", + "items": { + "$ref": "#/definitions/SqlPoolVulnerabilityAssessmentRuleBaselineItem" + } + } + } + }, + "SqlPoolVulnerabilityAssessmentRuleBaselineItem": { + "description": "Properties for an Sql pool vulnerability assessment rule baseline's result.", + "required": [ + "result" + ], + "type": "object", + "properties": { + "result": { + "description": "The rule baseline result", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SqlPoolVulnerabilityAssessmentRuleBaseline": { + "description": "A Sql pool vulnerability assessment rule baseline.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlPoolVulnerabilityAssessmentRuleBaselineProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "SqlPoolVulnerabilityAssessmentScanExportProperties": { + "description": "Properties of the export operation's result.", + "type": "object", + "properties": { + "exportedReportLocation": { + "description": "Location of the exported report (e.g. https://myStorage.blob.core.windows.net/VaScans/scans/serverName/databaseName/scan_scanId.xlsx).", + "type": "string", + "readOnly": true + } + } + }, + "SqlPoolVulnerabilityAssessmentScansExport": { + "description": "A Sql pool Vulnerability Assessment scan export resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlPoolVulnerabilityAssessmentScanExportProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "ResourceMoveDefinition": { + "description": "Contains the information necessary to perform a resource move (rename).", + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "description": "The target ID for the resource", + "type": "string" + } + } + }, + "CreateSqlPoolRestorePointDefinition": { + "description": "Contains the information necessary to perform a create Sql pool restore point operation.", + "required": [ + "restorePointLabel" + ], + "type": "object", + "properties": { + "restorePointLabel": { + "description": "The restore point label to apply", + "type": "string" + } + } + }, + "WorkloadGroupProperties": { + "description": "Workload group definition. For more information look at sys.workload_management_workload_groups (DMV).", + "required": [ + "minResourcePercent", + "maxResourcePercent", + "minResourcePercentPerRequest" + ], + "type": "object", + "properties": { + "minResourcePercent": { + "format": "int32", + "description": "The workload group minimum percentage resource.", + "type": "integer" + }, + "maxResourcePercent": { + "format": "int32", + "description": "The workload group cap percentage resource.", + "type": "integer" + }, + "minResourcePercentPerRequest": { + "format": "double", + "description": "The workload group request minimum grant percentage.", + "type": "number" + }, + "maxResourcePercentPerRequest": { + "format": "double", + "description": "The workload group request maximum grant percentage.", + "type": "number" + }, + "importance": { + "description": "The workload group importance level.", + "type": "string" + }, + "queryExecutionTimeout": { + "format": "int32", + "description": "The workload group query execution timeout.", + "type": "integer" + } + } + }, + "WorkloadGroup": { + "description": "Workload group operations for a sql pool", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/WorkloadGroupProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "WorkloadGroupListResult": { + "description": "A list of workload groups.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/WorkloadGroup" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "WorkloadClassifierProperties": { + "description": "Workload classifier definition. For more information look at sys.workload_management_workload_classifiers (DMV).", + "required": [ + "memberName" + ], + "type": "object", + "properties": { + "memberName": { + "description": "The workload classifier member name.", + "type": "string" + }, + "label": { + "description": "The workload classifier label.", + "type": "string" + }, + "context": { + "description": "The workload classifier context.", + "type": "string" + }, + "startTime": { + "description": "The workload classifier start time for classification.", + "type": "string" + }, + "endTime": { + "description": "The workload classifier end time for classification.", + "type": "string" + }, + "importance": { + "description": "The workload classifier importance.", + "type": "string" + } + } + }, + "WorkloadClassifier": { + "description": "Workload classifier operations for a data warehouse", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/WorkloadClassifierProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "WorkloadClassifierListResult": { + "description": "A list of workload classifiers for a workload group.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/WorkloadClassifier" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "DataMaskingPolicyProperties": { + "properties": { + "dataMaskingState": { + "type": "string", + "description": "The state of the data masking policy.", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "modelAsString": false, + "name": "DataMaskingState" + } + }, + "exemptPrincipals": { + "type": "string", + "description": "The list of the exempt principals. Specifies the semicolon-separated list of database users for which the data masking policy does not apply. The specified users receive data results without masking for all of the database queries." + }, + "applicationPrincipals": { + "type": "string", + "description": "The list of the application principals. This is a legacy parameter and is no longer used.", + "readOnly": true + }, + "maskingLevel": { + "type": "string", + "description": "The masking level. This is a legacy parameter and is no longer used.", + "readOnly": true + } + }, + "required": [ + "dataMaskingState" + ], + "description": "The properties of a database data masking policy." + }, + "DataMaskingPolicy": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DataMaskingPolicyProperties", + "description": "The properties of the data masking policy." + }, + "location": { + "type": "string", + "readOnly": true, + "description": "The location of the data masking policy." + }, + "kind": { + "type": "string", + "readOnly": true, + "description": "The kind of data masking policy. Metadata, used for Azure portal." + }, + "managedBy": { + "type": "string", + "readOnly": true, + "description": "Fully qualified resource ID of the sql pool" + } + } + }, + "ExtendedSqlPoolBlobAuditingPolicy": { + "description": "An extended Sql pool blob auditing policy.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ExtendedSqlPoolBlobAuditingPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "ExtendedSqlPoolBlobAuditingPolicyProperties": { + "description": "Properties of an extended Sql pool blob auditing policy.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "predicateExpression": { + "description": "Specifies condition of where clause when creating an audit.", + "type": "string" + }, + "state": { + "description": "Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "BlobAuditingPolicyState", + "modelAsString": false + } + }, + "storageEndpoint": { + "description": "Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.", + "type": "string" + }, + "storageAccountAccessKey": { + "description": "Specifies the identifier key of the auditing storage account. \r\nIf state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage.\r\nPrerequisites for using managed identity authentication:\r\n1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD).\r\n2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity.\r\nFor more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355)", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "retentionDays": { + "format": "int32", + "description": "Specifies the number of days to keep in the audit logs in the storage account.", + "type": "integer" + }, + "auditActionsAndGroups": { + "description": "Specifies the Actions-Groups and Actions to audit.\r\n\r\nThe recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:\r\n\r\nBATCH_COMPLETED_GROUP,\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,\r\nFAILED_DATABASE_AUTHENTICATION_GROUP.\r\n\r\nThis above combination is also the set that is configured by default when enabling auditing from the Azure portal.\r\n\r\nThe supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):\r\n\r\nAPPLICATION_ROLE_CHANGE_PASSWORD_GROUP\r\nBACKUP_RESTORE_GROUP\r\nDATABASE_LOGOUT_GROUP\r\nDATABASE_OBJECT_CHANGE_GROUP\r\nDATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nDATABASE_OBJECT_PERMISSION_CHANGE_GROUP\r\nDATABASE_OPERATION_GROUP\r\nDATABASE_PERMISSION_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_IMPERSONATION_GROUP\r\nDATABASE_ROLE_MEMBER_CHANGE_GROUP\r\nFAILED_DATABASE_AUTHENTICATION_GROUP\r\nSCHEMA_OBJECT_ACCESS_GROUP\r\nSCHEMA_OBJECT_CHANGE_GROUP\r\nSCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nSCHEMA_OBJECT_PERMISSION_CHANGE_GROUP\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP\r\nUSER_CHANGE_PASSWORD_GROUP\r\nBATCH_STARTED_GROUP\r\nBATCH_COMPLETED_GROUP\r\n\r\nThese are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.\r\n\r\nFor more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).\r\n\r\nFor Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:\r\nSELECT\r\nUPDATE\r\nINSERT\r\nDELETE\r\nEXECUTE\r\nRECEIVE\r\nREFERENCES\r\n\r\nThe general form for defining an action to be audited is:\r\n{action} ON {object} BY {principal}\r\n\r\nNote that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.\r\n\r\nFor example:\r\nSELECT on dbo.myTable by public\r\nSELECT on DATABASE::myDatabase by public\r\nSELECT on SCHEMA::mySchema by public\r\n\r\nFor more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)", + "type": "array", + "items": { + "type": "string" + } + }, + "storageAccountSubscriptionId": { + "format": "uuid", + "description": "Specifies the blob storage subscription Id.", + "type": "string" + }, + "isStorageSecondaryKeyInUse": { + "description": "Specifies whether storageAccountAccessKey value is the storage's secondary key.", + "type": "boolean" + }, + "isAzureMonitorTargetEnabled": { + "description": "Specifies whether audit events are sent to Azure Monitor. \r\nIn order to send the events to Azure Monitor, specify 'state' as 'Enabled' and 'isAzureMonitorTargetEnabled' as true.\r\n\r\nWhen using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.\r\nNote that for server level audit you should use the 'master' database as {databaseName}.\r\n\r\nDiagnostic Settings URI format:\r\nPUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview\r\n\r\nFor more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)\r\nor [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)\r\n", + "type": "boolean" + }, + "queueDelayMs": { + "format": "int32", + "description": "Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed.\r\nThe default minimum value is 1000 (1 second). The maximum is 2,147,483,647.", + "type": "integer" + } + } + }, + "ExtendedSqlPoolBlobAuditingPolicyListResult": { + "description": "A list of sql pool extended auditing settings.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ExtendedSqlPoolBlobAuditingPolicy" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "DataMaskingRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DataMaskingRuleProperties", + "description": "The properties of the resource." + }, + "location": { + "type": "string", + "readOnly": true, + "description": "The location of the data masking rule." + }, + "kind": { + "type": "string", + "readOnly": true, + "description": "The kind of Data Masking Rule. Metadata, used for Azure portal." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Represents a Sql pool data masking rule." + }, + "DataMaskingRuleProperties": { + "properties": { + "id": { + "type": "string", + "description": "The rule Id.", + "readOnly": true + }, + "aliasName": { + "type": "string", + "description": "The alias name. This is a legacy parameter and is no longer used." + }, + "ruleState": { + "type": "string", + "description": "The rule state. Used to delete a rule. To delete an existing rule, specify the schemaName, tableName, columnName, maskingFunction, and specify ruleState as disabled. However, if the rule doesn't already exist, the rule will be created with ruleState set to enabled, regardless of the provided value of ruleState.", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "modelAsString": false, + "name": "DataMaskingRuleState" + } + }, + "schemaName": { + "type": "string", + "description": "The schema name on which the data masking rule is applied." + }, + "tableName": { + "type": "string", + "description": "The table name on which the data masking rule is applied." + }, + "columnName": { + "type": "string", + "description": "The column name on which the data masking rule is applied." + }, + "maskingFunction": { + "type": "string", + "description": "The masking function that is used for the data masking rule.", + "enum": [ + "Default", + "CCN", + "Email", + "Number", + "SSN", + "Text" + ], + "x-ms-enum": { + "modelAsString": false, + "name": "DataMaskingFunction" + } + }, + "numberFrom": { + "type": "string", + "description": "The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored." + }, + "numberTo": { + "type": "string", + "description": "The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored." + }, + "prefixSize": { + "type": "string", + "description": "If maskingFunction is set to Text, the number of characters to show unmasked in the beginning of the string. Otherwise, this parameter will be ignored." + }, + "suffixSize": { + "type": "string", + "description": "If maskingFunction is set to Text, the number of characters to show unmasked at the end of the string. Otherwise, this parameter will be ignored." + }, + "replacementString": { + "type": "string", + "description": "If maskingFunction is set to Text, the character to use for masking the unexposed part of the string. Otherwise, this parameter will be ignored." + } + }, + "required": [ + "maskingFunction", + "schemaName", + "tableName", + "columnName" + ], + "description": "The properties of a Sql pool data masking rule." + }, + "DataMaskingRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DataMaskingRule" + }, + "description": "The list of Sql pool data masking rules." + } + }, + "description": "The response to a list data masking rules request." + }, + "SqlPoolBlobAuditingPolicyListResult": { + "description": "A list of Sql pool auditing settings.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlPoolBlobAuditingPolicy" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "SensitivityLabelUpdateProperties": { + "description": "Properties of an operation executed on a sensitivity label.", + "required": [ + "op", + "schema", + "table", + "column" + ], + "type": "object", + "properties": { + "op": { + "enum": [ + "set", + "remove" + ], + "type": "string", + "x-ms-enum": { + "name": "SensitivityLabelUpdateKind", + "modelAsString": false + } + }, + "schema": { + "description": "Schema name of the column to update.", + "type": "string" + }, + "table": { + "description": "Table name of the column to update.", + "type": "string" + }, + "column": { + "description": "Column name to update.", + "type": "string" + }, + "sensitivityLabel": { + "$ref": "#/definitions/SensitivityLabel", + "description": "The sensitivity label information to apply on a column." + } + } + }, + "SensitivityLabelUpdate": { + "description": "A sensitivity label update operation.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SensitivityLabelUpdateProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "SensitivityLabelUpdateList": { + "description": "A list of sensitivity label update operations.", + "type": "object", + "properties": { + "operations": { + "type": "array", + "items": { + "$ref": "#/definitions/SensitivityLabelUpdate" + } + } + } + }, + "RecommendedSensitivityLabelUpdateProperties": { + "description": "Properties of an operation executed on a recommended sensitivity label.", + "required": [ + "op", + "schema", + "table", + "column" + ], + "type": "object", + "properties": { + "op": { + "enum": [ + "enable", + "disable" + ], + "type": "string", + "x-ms-enum": { + "name": "RecommendedSensitivityLabelUpdateKind", + "modelAsString": false + } + }, + "schema": { + "description": "Schema name of the column to update.", + "type": "string" + }, + "table": { + "description": "Table name of the column to update.", + "type": "string" + }, + "column": { + "description": "Column name to update.", + "type": "string" + } + } + }, + "RecommendedSensitivityLabelUpdate": { + "description": "A recommended sensitivity label update operation.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RecommendedSensitivityLabelUpdateProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "RecommendedSensitivityLabelUpdateList": { + "description": "A list of recommended sensitivity label update operations.", + "type": "object", + "properties": { + "operations": { + "type": "array", + "items": { + "$ref": "#/definitions/RecommendedSensitivityLabelUpdate" + } + } + } + } + }, + "parameters": { + "DataMaskingPolicyNameParameter": { + "name": "dataMaskingPolicyName", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "x-ms-enum": { + "modelAsString": false, + "name": "DataMaskingPolicyName" + }, + "description": "The name of the data masking policy for which the masking rule applies.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/sqlServer.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/sqlServer.json new file mode 100644 index 000000000000..0c757987e91d --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/sqlServer.json @@ -0,0 +1,1789 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-05-01", + "title": "SynapseManagementClient", + "description": "The Azure Synapse SQL management API provides a RESTful set of web APIs that interact with Azure Synapse SQL services to manage your resources. The API enables users to create, retrieve, update, and delete SqlServers sub resources." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "type": "oauth2", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/auditingSettings/{blobAuditingPolicyName}": { + "get": { + "operationId": "WorkspaceManagedSqlServerBlobAuditingPolicies_Get", + "summary": "Get server's blob auditing policy.", + "description": "Get a workspace managed sql server's blob auditing policy.", + "tags": [ + "WorkspaceManagedSqlServer, BlobAuditing" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "BlobAuditingPolicyName", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "Successfully retrieved workspace managed sql server's blob auditing policy.", + "schema": { + "$ref": "#/definitions/ServerBlobAuditingPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get blob auditing setting of workspace managed sql Server": { + "$ref": "./examples/GetWorkspaceManagedSqlServerBlobAuditingSettings.json" + } + } + }, + "put": { + "operationId": "WorkspaceManagedSqlServerBlobAuditingPolicies_CreateOrUpdate", + "summary": "Create or Update server's blob auditing policy.", + "description": "Create or Update a workspace managed sql server's blob auditing policy.", + "tags": [ + "WorkspaceManagedSqlServer, BlobAuditing" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "BlobAuditingPolicyName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "Properties of extended blob auditing policy.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerBlobAuditingPolicy" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the auditing settings.", + "schema": { + "$ref": "#/definitions/ServerBlobAuditingPolicy" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidServerBlobAuditingPolicyCreateRequest - The create server blob auditing policy request does not exist or has no properties object.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 BlobAuditingInvalidStorageAccountCredentials - The provided storage account or access key is not valid.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 InsufficientDiskSpaceForAuditing - Insufficient disk space to save auditing metadata in the database\n\n 400 InvalidBlobAuditActions - Invalid audit action.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update blob auditing policy of workspace managed Sql Server with minimal parameters": { + "$ref": "./examples/CreateWorkspaceManagedSqlServerBlobAuditingSettingsWithMinParameters.json" + }, + "Create or update blob auditing policy of workspace SQL Server with all parameters": { + "$ref": "./examples/CreateWorkspaceManagedSqlServerBlobAuditingSettingsWithAllParameters.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/auditingSettings": { + "get": { + "operationId": "WorkspaceManagedSqlServerBlobAuditingPolicies_ListByWorkspace", + "summary": "List workspace server's blob auditing policies.", + "description": "List workspace managed sql server's blob auditing policies.", + "tags": [ + "WorkspaceManagedSqlServer, BlobAuditing" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved auditing settings.", + "schema": { + "$ref": "#/definitions/ServerBlobAuditingPolicyListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get blob auditing policy of workspace manged sql Server": { + "$ref": "./examples/ListWorkspaceManagedSqlServerBlobAuditingSettings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/extendedAuditingSettings/{blobAuditingPolicyName}": { + "get": { + "operationId": "WorkspaceManagedSqlServerExtendedBlobAuditingPolicies_Get", + "summary": "Get server's extended blob auditing policy.", + "description": "Get a workspace SQL server's extended blob auditing policy.", + "tags": [ + "WorkspaceManagedSqlServer, BlobAuditing" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "BlobAuditingPolicyName", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "Successfully retrieved extended auditing settings.", + "schema": { + "$ref": "#/definitions/ExtendedServerBlobAuditingPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get workspace managed sql servers' extended blob auditing settings": { + "$ref": "./examples/GetWorkspaceManagedSqlExtendedServerBlobAuditingSettings.json" + } + } + }, + "put": { + "operationId": "WorkspaceManagedSqlServerExtendedBlobAuditingPolicies_CreateOrUpdate", + "summary": "Create or Update server's extended blob auditing policy.", + "description": "Create or Update a workspace managed sql server's extended blob auditing policy.", + "tags": [ + "WorkspaceManagedSqlServer, BlobAuditing" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "BlobAuditingPolicyName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "Properties of extended blob auditing policy.", + "required": true, + "schema": { + "$ref": "#/definitions/ExtendedServerBlobAuditingPolicy" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the extended auditing settings.", + "schema": { + "$ref": "#/definitions/ExtendedServerBlobAuditingPolicy" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidServerBlobAuditingPolicyCreateRequest - The create server blob auditing policy request does not exist or has no properties object.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 BlobAuditingPredicateExpressionEmpty - Invalid parameter 'predicateExpression', value can not be empty.\n\n * 400 BlobAuditingInvalidStorageAccountCredentials - The provided storage account or access key is not valid.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 InsufficientDiskSpaceForAuditing - Insufficient disk space to save auditing metadata in the database\n\n * 400 InvalidBlobAuditActions - Invalid audit action\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 409 ServerBlobAuditingPolicyInProgress - Set server blob auditing is already in progress.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update workspace managed sql server's extended blob auditing policy of with minimal parameters": { + "$ref": "./examples/CreateWorkspaceManagedSqlServerExetendedBlobAuditingSettingsWithMinParameters.json" + }, + "Create or update workspace managed sql server's extended blob auditing policy of with all parameters": { + "$ref": "./examples/CreateWorkspaceManagedSqlServerExtendedBlobAuditingSettingsWithAllParameters.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/extendedAuditingSettings": { + "get": { + "operationId": "WorkspaceManagedSqlServerExtendedBlobAuditingPolicies_ListByWorkspace", + "summary": "List server's extended blob auditing policies.", + "description": "List workspace managed sql server's extended blob auditing policies.", + "tags": [ + "WorkspaceManagedSqlServer, BlobAuditing" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved extended auditing settings.", + "schema": { + "$ref": "#/definitions/ExtendedServerBlobAuditingPolicyListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get workspace managed sql server's extended blob auditing settings": { + "$ref": "./examples/ListWorkspaceManagedSqlServerExtendedBlobAuditingSettings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/securityAlertPolicies/{securityAlertPolicyName}": { + "get": { + "operationId": "WorkspaceManagedSqlServerSecurityAlertPolicy_Get", + "summary": "Get server's security alert policy.", + "description": "Get a workspace managed sql server's security alert policy.", + "tags": [ + "WorkspaceManagedSqlServer, SecurityAlertPolicies" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the security alert policy.", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "x-ms-enum": { + "name": "SecurityAlertPolicyName", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "Successfully retrieved security alert policy.", + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountCredentials - The provided storage account access key is not valid.\n\n * 400 InvalidServerSecurityAlertPolicyCreateRequest - The create server Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 ServerSecurityAlertPolicyInProgress - Set server security alert policy is already in progress\n\n * 409 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 GetServerSecurityAlertPolicyFailed - Failed to get Threat Detection settings\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get workspace managed sql Server's security alert policy": { + "$ref": "./examples/GetWorkspaceManagedSqlServerSecurityAlertPolicy.json" + } + } + }, + "put": { + "operationId": "WorkspaceManagedSqlServerSecurityAlertPolicy_CreateOrUpdate", + "summary": "Create or Update server's threat detection policy.", + "description": "Create or Update a workspace managed sql server's threat detection policy.", + "tags": [ + "WorkspaceManagedSqlServer, SecurityAlertPolicies" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the security alert policy.", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "x-ms-enum": { + "name": "SecurityAlertPolicyName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "The workspace managed sql server security alert policy.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated threat detection policy.", + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountCredentials - The provided storage account access key is not valid.\n\n * 400 InvalidServerSecurityAlertPolicyCreateRequest - The create server Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 ServerSecurityAlertPolicyInProgress - Set server security alert policy is already in progress\n\n * 409 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a workspace managed sql server's threat detection policy with minimal parameters": { + "$ref": "./examples/WorkspaceManagedSqlServerSecurityAlertCreateWithMinParameters.json" + }, + "Update a workspace managed sql server's threat detection policy with all parameters": { + "$ref": "./examples/WorkspaceManagedSqlServerSecurityAlertWithAllParameters.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/securityAlertPolicies": { + "get": { + "operationId": "WorkspaceManagedSqlServerSecurityAlertPolicy_List", + "summary": "Get server's threat detection policies.", + "description": "Get workspace managed sql server's threat detection policies.", + "tags": [ + "WorkspaceManagedSqlServer, SecurityAlertPolicies" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved threat detection policies.", + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicyListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountCredentials - The provided storage account access key is not valid.\n\n * 400 InvalidServerSecurityAlertPolicyCreateRequest - The create server Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 ServerSecurityAlertPolicyInProgress - Set server security alert policy is already in progress\n\n * 409 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 GetServerSecurityAlertPolicyFailed - Failed to get Threat Detection settings\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get workspace managed sql server's security alert policy": { + "$ref": "./examples/ListWorkspaceManagedSqlServerSecurityAlertPolicies.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}": { + "get": { + "operationId": "WorkspaceManagedSqlServerVulnerabilityAssessments_Get", + "summary": "Get server's vulnerability assessment.", + "description": "Get workspace managed sql server's vulnerability assessment.", + "tags": [ + "WorkspaceManagedSqlServer, ServerVulnerabilityAssessments" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "name": "vulnerabilityAssessmentName", + "in": "path", + "description": "The name of the vulnerability assessment.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentName", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "Successfully retrieved vulnerability assessment.", + "schema": { + "$ref": "#/definitions/ServerVulnerabilityAssessment" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get workspace managed sql Server's vulnerability assessment": { + "$ref": "./examples/GetWorkspaceManagedSqlServerVulnerabilityAssessment.json" + } + } + }, + "put": { + "operationId": "WorkspaceManagedSqlServerVulnerabilityAssessments_CreateOrUpdate", + "summary": "Create or Update server's vulnerability assessment.", + "description": "Create or Update workspace managed sql server's vulnerability assessment.", + "tags": [ + "WorkspaceManagedSqlServer, ServerVulnerabilityAssessments" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "name": "vulnerabilityAssessmentName", + "in": "path", + "description": "The name of the vulnerability assessment.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "Properties for vulnerability assessment.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerVulnerabilityAssessment" + } + } + ], + "responses": { + "200": { + "description": "Successfully created vulnerability assessment.", + "schema": { + "$ref": "#/definitions/ServerVulnerabilityAssessment" + } + }, + "201": { + "description": "Successfully created the vulnerability assessment.", + "schema": { + "$ref": "#/definitions/ServerVulnerabilityAssessment" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 InvalidVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Create or Update a workspace managed sql server's vulnerability assessment with minimal parameters, when storageContainerSasKey is specified": { + "$ref": "./examples/PutWorkspaceMangedSqlServerVulnerabilityAssessmentCreateContainerSasKeyMin.json" + }, + "Create or Update a workspace managed sql server's vulnerability assessment with minimal parameters, when storageAccountAccessKey is specified": { + "$ref": "./examples/PutWorkspaceMangedSqlServerVulnerabilityAssessmentCreateStorageAccessKeyMin.json" + }, + "Create or Update a workspace managed sql server's vulnerability assessment with all parameters": { + "$ref": "./examples/PutWorkspaceManagedSqlServerVulnerabilityAssessmentWithAllParameters.json" + } + } + }, + "delete": { + "operationId": "WorkspaceManagedSqlServerVulnerabilityAssessments_Delete", + "summary": "Remove server's vulnerability assessment.", + "description": "Remove workspace managed sql server's vulnerability assessment.", + "tags": [ + "WorkspaceManagedSqlServer, ServerVulnerabilityAssessments" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "name": "vulnerabilityAssessmentName", + "in": "path", + "description": "The name of the vulnerability assessment.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentName", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "Successfully removed vulnerability assessment." + }, + "204": { + "description": "Specified vulnerability assessment policy does not exists." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Remove workspace managed sql Server's vulnerability assessment": { + "$ref": "./examples/DeleteWorkspaceManagedSqlServerVulnerabilityAssessment.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/vulnerabilityAssessments": { + "get": { + "operationId": "WorkspaceManagedSqlServerVulnerabilityAssessments_List", + "summary": "Lists the vulnerability assessment policies associated with a server.", + "description": "Lists the vulnerability assessment policies associated with a workspace managed sql server.", + "tags": [ + "WorkspaceManagedSqlServer, ServerVulnerabilityAssessments" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved vulnerability assessment policies.", + "schema": { + "$ref": "#/definitions/ServerVulnerabilityAssessmentListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get workspace managed sql Server's vulnerability assessment policies": { + "$ref": "./examples/ListWorkspaceManagedSqlServerVulnerabilityAssessmentPolicies.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/encryptionProtector/{encryptionProtectorName}": { + "get": { + "operationId": "WorkspaceManagedSqlServerEncryptionProtector_Get", + "summary": "Get workspace server's encryption protector.", + "description": "Get workspace managed sql server's encryption protector.", + "tags": [ + "WorkspaceManagedSqlServer, ServerEncryptionProtector" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "name": "encryptionProtectorName", + "in": "path", + "description": "The name of the encryption protector.", + "required": true, + "type": "string", + "enum": [ + "current" + ], + "x-ms-enum": { + "name": "EncryptionProtectorName", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "Successfully retrieved encryption protector.", + "schema": { + "$ref": "#/definitions/EncryptionProtector" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidUpsertKeyType - Service Managed type keys are managed by Azure SQL. This key type does not support create or update by the user.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 InvalidEncryptionProtectorName - The encryption protector key name is not supported.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get workspace managed sql Server's encryption protector": { + "$ref": "./examples/GetWorkspaceManagedSqlServerEncryptionProtector.json" + } + } + }, + "put": { + "operationId": "WorkspaceManagedSqlServerEncryptionProtector_CreateOrUpdate", + "summary": "Updates workspace server's encryption protector.", + "description": "Updates workspace managed sql server's encryption protector.", + "tags": [ + "WorkspaceManagedSqlServer, ServerEncryptionProtector" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "name": "encryptionProtectorName", + "in": "path", + "description": "The name of the encryption protector.", + "required": true, + "type": "string", + "enum": [ + "current" + ], + "x-ms-enum": { + "name": "EncryptionProtectorName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "The requested encryption protector resource state.", + "required": true, + "schema": { + "$ref": "#/definitions/EncryptionProtector" + } + } + ], + "responses": { + "200": { + "description": "Successfully retrieved encryption protector.", + "schema": { + "$ref": "#/definitions/EncryptionProtector" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidUpsertKeyType - Service Managed type keys are managed by Azure SQL. This key type does not support create or update by the user.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 InvalidEncryptionProtectorName - The encryption protector key name is not supported.\n\n * 400 SecurityAzureKeyVaultGeoChainError - Creating secondary of secondary (a process known as chaining) is not supported when enabling Transparent Data Encryption using Azure Key Vault (BYOK).\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultMismatchError - Unexpected Key Vault region found in the http response.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 and Key Type is RSA.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 401 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ServerKeyNotFound - The requested server key was not found on the current subscription.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update the encryption protector to key vault": { + "$ref": "./examples/WorkspaceManagedSqlServerEncryptionProtectorCreateOrUpdateKeyVault.json" + }, + "Update the encryption protector to service managed": { + "$ref": "./examples/WorkspaceManagedSqlServerEncryptionProtectorCreateOrUpdateServiceManaged.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/encryptionProtector": { + "get": { + "operationId": "WorkspaceManagedSqlServerEncryptionProtector_List", + "summary": "Get list of encryption protectors for the server.", + "description": "Get list of encryption protectors for workspace managed sql server.", + "tags": [ + "WorkspaceManagedSqlServer, ServerEncryptionProtector" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved encryption protectors.", + "schema": { + "$ref": "#/definitions/EncryptionProtectorListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidUpsertKeyType - Service Managed type keys are managed by Azure SQL. This key type does not support create or update by the user.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 InvalidEncryptionProtectorName - The encryption protector key name is not supported.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get workspace managed sql Server's encryption protectors": { + "$ref": "./examples/GetWorkspaceManagedSqlServerEncryptionProtectorList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/encryptionProtector/{encryptionProtectorName}/revalidate": { + "post": { + "operationId": "WorkspaceManagedSqlServerEncryptionProtector_Revalidate", + "summary": "Revalidates server's existing encryption protector.", + "description": "Revalidates workspace managed sql server's existing encryption protector.", + "tags": [ + "WorkspaceManagedSqlServer, ServerEncryptionProtector" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "name": "encryptionProtectorName", + "in": "path", + "description": "The name of the encryption protector.", + "required": true, + "type": "string", + "enum": [ + "current" + ], + "x-ms-enum": { + "name": "EncryptionProtectorName", + "modelAsString": true + } + } + ], + "consumes": [], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully revalidated the encryption protector." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidUpsertKeyType - Service Managed type keys are managed by Azure SQL. This key type does not support create or update by the user.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 InvalidEncryptionProtectorName - The encryption protector key name is not supported.\n\n * 400 SecurityAzureKeyVaultGeoChainError - Creating secondary of secondary (a process known as chaining) is not supported when enabling Transparent Data Encryption using Azure Key Vault (BYOK).\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultMismatchError - Unexpected Key Vault region found in the http response.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 and Key Type is RSA.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 401 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ServerKeyNotFound - The requested server key was not found on the current subscription.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information ." + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Revalidates the encryption protector": { + "$ref": "./examples/WorkspaceManagedSqlServerEncryptionProtectorRevalidate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlUsages": { + "get": { + "tags": [ + "WorkspaceManagedSqlServer, sqlUsages" + ], + "operationId": "WorkspaceManagedSqlServerUsages_List", + "summary": "Get list of usages metric for the server.", + "description": "Get list of server usages metric for workspace managed sql server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerUsageListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List usages metric for the workspace managed sql server": { + "$ref": "./examples/ListWorkspaceManagedSqlServerUsages.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/recoverableSqlPools": { + "get": { + "tags": [ + "WorkspaceManagedSqlServer", + "recoverableSqlPools" + ], + "operationId": "WorkspaceManagedSqlServerRecoverableSqlPools_List", + "summary": "Get list of recoverable sql pools for the server.", + "description": "Get list of recoverable sql pools for workspace managed sql server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoverableSqlPoolListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List recoverable sql pools for the server": { + "$ref": "./examples/ListWorkspaceManagedSqlServerRecoverableSqlPool.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/recoverableSqlPools/{sqlPoolName}": { + "get": { + "tags": [ + "WorkspaceManagedSqlServer", + "recoverableSqlPools" + ], + "operationId": "WorkspaceManagedSqlServerRecoverableSqlPools_Get", + "summary": "Get recoverable sql pools for the server.", + "description": "Get recoverable sql pools for workspace managed sql server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "name": "sqlPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the sql pool" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoverableSqlPool" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get recoverable sql pools for the server": { + "$ref": "./examples/GetWorkspaceManagedSqlServerRecoverableSqlPool.json" + } + } + } + } + }, + "definitions": { + "ServerBlobAuditingPolicyProperties": { + "description": "Properties of a server blob auditing policy.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "state": { + "description": "Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "BlobAuditingPolicyState", + "modelAsString": false + } + }, + "storageEndpoint": { + "description": "Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.", + "type": "string" + }, + "storageAccountAccessKey": { + "description": "Specifies the identifier key of the auditing storage account. \r\nIf state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage.\r\nPrerequisites for using managed identity authentication:\r\n1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD).\r\n2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity.\r\nFor more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355)", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "retentionDays": { + "format": "int32", + "description": "Specifies the number of days to keep in the audit logs in the storage account.", + "type": "integer" + }, + "auditActionsAndGroups": { + "description": "Specifies the Actions-Groups and Actions to audit.\r\n\r\nThe recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:\r\n\r\nBATCH_COMPLETED_GROUP,\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,\r\nFAILED_DATABASE_AUTHENTICATION_GROUP.\r\n\r\nThis above combination is also the set that is configured by default when enabling auditing from the Azure portal.\r\n\r\nThe supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):\r\n\r\nAPPLICATION_ROLE_CHANGE_PASSWORD_GROUP\r\nBACKUP_RESTORE_GROUP\r\nDATABASE_LOGOUT_GROUP\r\nDATABASE_OBJECT_CHANGE_GROUP\r\nDATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nDATABASE_OBJECT_PERMISSION_CHANGE_GROUP\r\nDATABASE_OPERATION_GROUP\r\nDATABASE_PERMISSION_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_IMPERSONATION_GROUP\r\nDATABASE_ROLE_MEMBER_CHANGE_GROUP\r\nFAILED_DATABASE_AUTHENTICATION_GROUP\r\nSCHEMA_OBJECT_ACCESS_GROUP\r\nSCHEMA_OBJECT_CHANGE_GROUP\r\nSCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nSCHEMA_OBJECT_PERMISSION_CHANGE_GROUP\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP\r\nUSER_CHANGE_PASSWORD_GROUP\r\nBATCH_STARTED_GROUP\r\nBATCH_COMPLETED_GROUP\r\n\r\nThese are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.\r\n\r\nFor more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).\r\n\r\nFor Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:\r\nSELECT\r\nUPDATE\r\nINSERT\r\nDELETE\r\nEXECUTE\r\nRECEIVE\r\nREFERENCES\r\n\r\nThe general form for defining an action to be audited is:\r\n{action} ON {object} BY {principal}\r\n\r\nNote that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.\r\n\r\nFor example:\r\nSELECT on dbo.myTable by public\r\nSELECT on DATABASE::myDatabase by public\r\nSELECT on SCHEMA::mySchema by public\r\n\r\nFor more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)", + "type": "array", + "items": { + "type": "string" + } + }, + "storageAccountSubscriptionId": { + "format": "uuid", + "description": "Specifies the blob storage subscription Id.", + "type": "string" + }, + "isStorageSecondaryKeyInUse": { + "description": "Specifies whether storageAccountAccessKey value is the storage's secondary key.", + "type": "boolean" + }, + "isAzureMonitorTargetEnabled": { + "description": "Specifies whether audit events are sent to Azure Monitor. \r\nIn order to send the events to Azure Monitor, specify 'state' as 'Enabled' and 'isAzureMonitorTargetEnabled' as true.\r\n\r\nWhen using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.\r\nNote that for server level audit you should use the 'master' database as {databaseName}.\r\n\r\nDiagnostic Settings URI format:\r\nPUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview\r\n\r\nFor more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)\r\nor [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)\r\n", + "type": "boolean" + }, + "queueDelayMs": { + "format": "int32", + "description": "Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed.\r\nThe default minimum value is 1000 (1 second). The maximum is 2,147,483,647.", + "type": "integer" + } + } + }, + "ServerBlobAuditingPolicy": { + "description": "A server blob auditing policy.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ServerBlobAuditingPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "ServerBlobAuditingPolicyListResult": { + "description": "A list of server auditing settings.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ServerBlobAuditingPolicy" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ExtendedServerBlobAuditingPolicyProperties": { + "description": "Properties of an extended server blob auditing policy.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "predicateExpression": { + "description": "Specifies condition of where clause when creating an audit.", + "type": "string" + }, + "state": { + "description": "Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "BlobAuditingPolicyState", + "modelAsString": false + } + }, + "storageEndpoint": { + "description": "Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.", + "type": "string" + }, + "storageAccountAccessKey": { + "description": "Specifies the identifier key of the auditing storage account. \r\nIf state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage.\r\nPrerequisites for using managed identity authentication:\r\n1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD).\r\n2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity.\r\nFor more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355)", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "retentionDays": { + "format": "int32", + "description": "Specifies the number of days to keep in the audit logs in the storage account.", + "type": "integer" + }, + "auditActionsAndGroups": { + "description": "Specifies the Actions-Groups and Actions to audit.\r\n\r\nThe recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:\r\n\r\nBATCH_COMPLETED_GROUP,\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,\r\nFAILED_DATABASE_AUTHENTICATION_GROUP.\r\n\r\nThis above combination is also the set that is configured by default when enabling auditing from the Azure portal.\r\n\r\nThe supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):\r\n\r\nAPPLICATION_ROLE_CHANGE_PASSWORD_GROUP\r\nBACKUP_RESTORE_GROUP\r\nDATABASE_LOGOUT_GROUP\r\nDATABASE_OBJECT_CHANGE_GROUP\r\nDATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nDATABASE_OBJECT_PERMISSION_CHANGE_GROUP\r\nDATABASE_OPERATION_GROUP\r\nDATABASE_PERMISSION_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_IMPERSONATION_GROUP\r\nDATABASE_ROLE_MEMBER_CHANGE_GROUP\r\nFAILED_DATABASE_AUTHENTICATION_GROUP\r\nSCHEMA_OBJECT_ACCESS_GROUP\r\nSCHEMA_OBJECT_CHANGE_GROUP\r\nSCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nSCHEMA_OBJECT_PERMISSION_CHANGE_GROUP\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP\r\nUSER_CHANGE_PASSWORD_GROUP\r\nBATCH_STARTED_GROUP\r\nBATCH_COMPLETED_GROUP\r\n\r\nThese are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.\r\n\r\nFor more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).\r\n\r\nFor Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:\r\nSELECT\r\nUPDATE\r\nINSERT\r\nDELETE\r\nEXECUTE\r\nRECEIVE\r\nREFERENCES\r\n\r\nThe general form for defining an action to be audited is:\r\n{action} ON {object} BY {principal}\r\n\r\nNote that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.\r\n\r\nFor example:\r\nSELECT on dbo.myTable by public\r\nSELECT on DATABASE::myDatabase by public\r\nSELECT on SCHEMA::mySchema by public\r\n\r\nFor more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)", + "type": "array", + "items": { + "type": "string" + } + }, + "storageAccountSubscriptionId": { + "format": "uuid", + "description": "Specifies the blob storage subscription Id.", + "type": "string" + }, + "isStorageSecondaryKeyInUse": { + "description": "Specifies whether storageAccountAccessKey value is the storage's secondary key.", + "type": "boolean" + }, + "isAzureMonitorTargetEnabled": { + "description": "Specifies whether audit events are sent to Azure Monitor. \r\nIn order to send the events to Azure Monitor, specify 'state' as 'Enabled' and 'isAzureMonitorTargetEnabled' as true.\r\n\r\nWhen using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.\r\nNote that for server level audit you should use the 'master' database as {databaseName}.\r\n\r\nDiagnostic Settings URI format:\r\nPUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview\r\n\r\nFor more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)\r\nor [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)\r\n", + "type": "boolean" + }, + "queueDelayMs": { + "format": "int32", + "description": "Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed.\r\nThe default minimum value is 1000 (1 second). The maximum is 2,147,483,647.", + "type": "integer" + } + } + }, + "ExtendedServerBlobAuditingPolicy": { + "description": "An extended server blob auditing policy.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ExtendedServerBlobAuditingPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "ExtendedServerBlobAuditingPolicyListResult": { + "description": "A list of server extended auditing settings.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ExtendedServerBlobAuditingPolicy" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ServerSecurityAlertPolicyProperties": { + "description": "Properties of a security alert policy.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "state": { + "description": "Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific server", + "enum": [ + "New", + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "SecurityAlertPolicyState", + "modelAsString": false + } + }, + "disabledAlerts": { + "description": "Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action", + "type": "array", + "items": { + "type": "string" + } + }, + "emailAddresses": { + "description": "Specifies an array of e-mail addresses to which the alert is sent.", + "type": "array", + "items": { + "type": "string" + } + }, + "emailAccountAdmins": { + "description": "Specifies that the alert is sent to the account administrators.", + "type": "boolean" + }, + "storageEndpoint": { + "description": "Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.", + "type": "string" + }, + "storageAccountAccessKey": { + "description": "Specifies the identifier key of the Threat Detection audit storage account.", + "type": "string" + }, + "retentionDays": { + "format": "int32", + "description": "Specifies the number of days to keep in the Threat Detection audit logs.", + "type": "integer" + }, + "creationTime": { + "format": "date-time", + "description": "Specifies the UTC creation time of the policy.", + "type": "string", + "readOnly": true + } + } + }, + "ServerSecurityAlertPolicy": { + "description": "Workspace managed Sql server security alert policy.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ServerSecurityAlertPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "ServerSecurityAlertPolicyListResult": { + "description": "A list of the workspace managed sql server's security alert policies.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ServerVulnerabilityAssessmentProperties": { + "description": "Properties of a server Vulnerability Assessment.", + "required": [ + "storageContainerPath" + ], + "type": "object", + "properties": { + "storageContainerPath": { + "description": "A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/).", + "type": "string" + }, + "storageContainerSasKey": { + "description": "A shared access signature (SAS Key) that has read and write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "storageAccountAccessKey": { + "description": "Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "recurringScans": { + "$ref": "#/definitions/VulnerabilityAssessmentRecurringScansProperties", + "description": "The recurring scans settings" + } + } + }, + "VulnerabilityAssessmentRecurringScansProperties": { + "description": "Properties of a Vulnerability Assessment recurring scans.", + "type": "object", + "properties": { + "isEnabled": { + "description": "Recurring scans state.", + "type": "boolean" + }, + "emailSubscriptionAdmins": { + "description": "Specifies that the schedule scan notification will be is sent to the subscription administrators.", + "default": true, + "type": "boolean" + }, + "emails": { + "description": "Specifies an array of e-mail addresses to which the scan notification is sent.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ServerVulnerabilityAssessment": { + "description": "A server vulnerability assessment.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ServerVulnerabilityAssessmentProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "ServerVulnerabilityAssessmentListResult": { + "description": "A list of the server's vulnerability assessments.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ServerVulnerabilityAssessment" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "EncryptionProtectorListResult": { + "description": "A list of server encryption protectors.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/EncryptionProtector" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "EncryptionProtectorProperties": { + "description": "Properties for an encryption protector execution.", + "required": [ + "serverKeyType" + ], + "type": "object", + "properties": { + "subregion": { + "description": "Subregion of the encryption protector.", + "type": "string", + "readOnly": true + }, + "serverKeyName": { + "description": "The name of the server key.", + "type": "string" + }, + "serverKeyType": { + "description": "The encryption protector type like 'ServiceManaged', 'AzureKeyVault'.", + "enum": [ + "ServiceManaged", + "AzureKeyVault" + ], + "type": "string", + "x-ms-enum": { + "name": "ServerKeyType", + "modelAsString": true + } + }, + "uri": { + "description": "The URI of the server key.", + "type": "string", + "readOnly": true + }, + "thumbprint": { + "description": "Thumbprint of the server key.", + "type": "string", + "readOnly": true + } + } + }, + "EncryptionProtector": { + "description": "The server encryption protector.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "kind": { + "description": "Kind of encryption protector. This is metadata used for the Azure portal experience.", + "type": "string", + "readOnly": true + }, + "location": { + "description": "Resource location.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/EncryptionProtectorProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "ServerUsage": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the server usage metric." + }, + "resourceName": { + "readOnly": true, + "type": "string", + "description": "The name of the resource." + }, + "displayName": { + "readOnly": true, + "type": "string", + "description": "The metric display name." + }, + "currentValue": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The current value of the metric." + }, + "limit": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The current limit of the metric." + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "The units of the metric." + }, + "nextResetTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The next reset time for the metric (ISO8601 format)." + } + }, + "description": "Represents server metrics." + }, + "ServerUsageListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServerUsage" + }, + "description": "The list of server metrics for the server." + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + }, + "required": [ + "value" + ], + "description": "Represents the response to a list server metrics request." + }, + "RecoverableSqlPoolProperties": { + "type": "object", + "properties": { + "edition": { + "readOnly": true, + "type": "string", + "description": "The edition of the database" + }, + "serviceLevelObjective": { + "readOnly": true, + "type": "string", + "description": "The service level objective name of the database" + }, + "elasticPoolName": { + "readOnly": true, + "type": "string", + "description": "The elastic pool name of the database" + }, + "lastAvailableBackupDate": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The last available backup date of the database (ISO8601 format)" + } + }, + "description": "The properties of a recoverable sql pool" + }, + "RecoverableSqlPool": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RecoverableSqlPoolProperties", + "description": "The properties of a recoverable sql pool", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "A recoverable sql pool" + }, + "RecoverableSqlPoolListResult": { + "description": "The response to a list recoverable sql pools request", + "type": "object", + "properties": { + "value": { + "description": "A list of recoverable sql pool", + "type": "array", + "items": { + "$ref": "#/definitions/RecoverableSqlPool" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/workspace.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/workspace.json new file mode 100644 index 000000000000..fb447a0746ee --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/workspace.json @@ -0,0 +1,1493 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-05-01", + "title": "SynapseManagementClient", + "description": "Azure Synapse Analytics APIs" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "type": "oauth2", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces": { + "get": { + "operationId": "Workspaces_ListByResourceGroup", + "description": "Returns a list of workspaces in a resource group", + "tags": [ + "Workspaces" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/WorkspaceInfoListResult" + }, + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List workspaces in resource group": { + "$ref": "./examples/ListWorkspacesInResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}": { + "get": { + "operationId": "Workspaces_Get", + "description": "Gets a workspace", + "tags": [ + "Workspaces" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/Workspace" + }, + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get a workspace": { + "$ref": "./examples/GetWorkspace.json" + } + } + }, + "patch": { + "operationId": "Workspaces_Update", + "description": "Updates a workspace", + "tags": [ + "Workspaces" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + }, + { + "schema": { + "$ref": "#/definitions/WorkspacePatchInfo" + }, + "in": "body", + "name": "workspacePatchInfo", + "required": true, + "description": "Workspace patch request properties" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/Workspace" + }, + "description": "" + }, + "201": { + "schema": { + "$ref": "#/definitions/Workspace" + }, + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Update a workspace": { + "$ref": "./examples/UpdateWorkspace.json" + } + } + }, + "put": { + "operationId": "Workspaces_CreateOrUpdate", + "description": "Creates or updates a workspace", + "tags": [ + "Workspaces" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + }, + { + "description": "Workspace create or update request properties", + "schema": { + "$ref": "#/definitions/Workspace" + }, + "in": "body", + "name": "workspaceInfo", + "required": true + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/Workspace" + }, + "description": "" + }, + "201": { + "schema": { + "$ref": "#/definitions/Workspace" + }, + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Create or update a workspace": { + "$ref": "./examples/CreateOrUpdateWorkspace.json" + } + } + }, + "delete": { + "operationId": "Workspaces_Delete", + "description": "Deletes a workspace", + "tags": [ + "Workspaces" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "schema": { + "type": "object" + }, + "description": "OK" + }, + "202": { + "schema": { + "type": "object" + }, + "description": "" + }, + "204": { + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete a workspace": { + "$ref": "./examples/DeleteWorkspace.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Synapse/workspaces": { + "get": { + "operationId": "Workspaces_List", + "description": "Returns a list of workspaces in a subscription", + "tags": [ + "Workspaces" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/WorkspaceInfoListResult" + }, + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List workspaces in subscription": { + "$ref": "./examples/ListWorkspacesInSubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/administrators/activeDirectory": { + "get": { + "operationId": "WorkspaceAadAdmins_Get", + "description": "Gets a workspace active directory admin", + "tags": [ + "Workspaces" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/WorkspaceAadAdminInfo" + }, + "description": "OK" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get workspace active directory admin": { + "$ref": "./examples/GetWorkspaceAadAdmin.json" + } + } + }, + "put": { + "operationId": "WorkspaceAadAdmins_CreateOrUpdate", + "description": "Creates or updates a workspace active directory admin", + "tags": [ + "Workspaces" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + }, + { + "description": "Workspace active directory administrator properties", + "schema": { + "$ref": "#/definitions/WorkspaceAadAdminInfo" + }, + "in": "body", + "name": "aadAdminInfo", + "required": true + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/WorkspaceAadAdminInfo" + } + }, + "202": { + "description": "", + "schema": { + "$ref": "#/definitions/WorkspaceAadAdminInfo" + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Create or update workspace active directory admin": { + "$ref": "./examples/CreateOrUpdateWorkspaceAadAdmin.json" + } + } + }, + "delete": { + "operationId": "WorkspaceAadAdmins_Delete", + "description": "Deletes a workspace active directory admin", + "tags": [ + "Workspaces" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "" + }, + "204": { + "description": "Accepted" + }, + "202": { + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete workspace active directory admin": { + "$ref": "./examples/DeleteWorkspaceAadAdmin.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlAdministrators/activeDirectory": { + "get": { + "operationId": "WorkspaceSqlAadAdmins_Get", + "description": "Gets a workspace SQL active directory admin", + "tags": [ + "Workspaces" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/WorkspaceAadAdminInfo" + }, + "description": "OK" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get workspace active directory admin": { + "$ref": "./examples/GetWorkspaceAadAdmin.json" + } + } + }, + "put": { + "operationId": "WorkspaceSqlAadAdmins_CreateOrUpdate", + "description": "Creates or updates a workspace SQL active directory admin", + "tags": [ + "Workspaces" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + }, + { + "description": "Workspace active directory administrator properties", + "schema": { + "$ref": "#/definitions/WorkspaceAadAdminInfo" + }, + "in": "body", + "name": "aadAdminInfo", + "required": true + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/WorkspaceAadAdminInfo" + } + }, + "202": { + "description": "", + "schema": { + "$ref": "#/definitions/WorkspaceAadAdminInfo" + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Create or update workspace active directory admin": { + "$ref": "./examples/CreateOrUpdateWorkspaceAadAdmin.json" + } + } + }, + "delete": { + "operationId": "WorkspaceSqlAadAdmins_Delete", + "description": "Deletes a workspace SQL active directory admin", + "tags": [ + "Workspaces" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "" + }, + "204": { + "description": "Accepted" + }, + "202": { + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete workspace active directory admin": { + "$ref": "./examples/DeleteWorkspaceAadAdmin.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/managedIdentitySqlControlSettings/default": { + "get": { + "operationId": "WorkspaceManagedIdentitySqlControlSettings_Get", + "summary": "Get Managed Identity Sql Control Settings", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/ManagedIdentitySqlControlSettingsModel" + }, + "description": "OK" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "Error" + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get managed identity sql control settings": { + "$ref": "./examples/GetManagedIdentitySqlControlSettings.json" + } + } + }, + "put": { + "operationId": "WorkspaceManagedIdentitySqlControlSettings_CreateOrUpdate", + "summary": "Create or update Managed Identity Sql Control Settings", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "description": "Managed Identity Sql Control Settings", + "schema": { + "$ref": "#/definitions/ManagedIdentitySqlControlSettingsModel" + }, + "in": "body", + "name": "managedIdentitySqlControlSettings", + "required": true + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/ManagedIdentitySqlControlSettingsModel" + }, + "description": "OK" + }, + "201": { + "description": "Created" + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "Error" + } + }, + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create or update managed identity sql control settings": { + "$ref": "./examples/CreateOrUpdateManagedIdentitySqlControlSettings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/restorableDroppedSqlPools/{restorableDroppedSqlPoolId}": { + "get": { + "tags": [ + "RestorableDroppedSqlPools" + ], + "operationId": "RestorableDroppedSqlPools_Get", + "description": "Gets a deleted sql pool that can be restored", + "x-ms-examples": { + "Get a restorable dropped Sql pool": { + "$ref": "./examples/RestorableDroppedSqlPoolGet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + }, + { + "name": "restorableDroppedSqlPoolId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the deleted Sql Pool in the form of sqlPoolName,deletionTimeInFileTimeFormat" + } + ], + "consumes": [], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RestorableDroppedSqlPool" + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "Error" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/restorableDroppedSqlPools": { + "get": { + "tags": [ + "RestorableDroppedSqlPools" + ], + "operationId": "RestorableDroppedSqlPools_ListByWorkspace", + "description": "Gets a list of deleted Sql pools that can be restored", + "x-ms-examples": { + "Get list of restorable dropped Sql pools": { + "$ref": "./examples/RestorableDroppedSqlpoolList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/workspaceNameParameter" + } + ], + "consumes": [], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RestorableDroppedSqlPoolListResult" + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "Error" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + } + }, + "definitions": { + "AadAdminProperties": { + "description": "Workspace active directory administrator properties", + "type": "object", + "properties": { + "tenantId": { + "description": "Tenant ID of the workspace active directory administrator", + "type": "string" + }, + "login": { + "description": "Login of the workspace active directory administrator", + "type": "string" + }, + "administratorType": { + "description": "Workspace active directory administrator type", + "type": "string" + }, + "sid": { + "description": "Object ID of the workspace active directory administrator", + "type": "string" + } + } + }, + "WorkspaceInfoListResult": { + "description": "List of workspaces", + "type": "object", + "properties": { + "nextLink": { + "description": "Link to the next page of results", + "type": "string" + }, + "value": { + "description": "List of workspaces", + "type": "array", + "items": { + "$ref": "#/definitions/Workspace" + } + } + } + }, + "DataLakeStorageAccountDetails": { + "description": "Details of the data lake storage account associated with the workspace", + "type": "object", + "properties": { + "accountUrl": { + "description": "Account URL", + "type": "string" + }, + "filesystem": { + "description": "Filesystem name", + "type": "string" + } + } + }, + "EncryptionDetails": { + "description": "Details of the encryption associated with the workspace", + "type": "object", + "properties": { + "doubleEncryptionEnabled": { + "description": "Double Encryption enabled", + "type": "boolean", + "readOnly": true + }, + "cmk": { + "description": "Customer Managed Key Details", + "$ref": "#/definitions/CustomerManagedKeyDetails" + } + } + }, + "CustomerManagedKeyDetails": { + "description": "Details of the customer managed key associated with the workspace", + "type": "object", + "properties": { + "status": { + "description": "The customer managed key status on the workspace", + "type": "string", + "readOnly": true + }, + "key": { + "description": "The key object of the workspace", + "$ref": "#/definitions/WorkspaceKeyDetails" + }, + "kekIdentity": { + "description": "Key encryption key", + "$ref": "#/definitions/KekIdentityProperties" + } + } + }, + "KekIdentityProperties": { + "description": "Key encryption key properties", + "type": "object", + "properties": { + "userAssignedIdentity": { + "description": "User assigned identity resource Id", + "type": "string" + }, + "useSystemAssignedIdentity": { + "description": "Boolean specifying whether to use system assigned identity or not" + } + } + }, + "WorkspaceKeyDetails": { + "description": "Details of the customer managed key associated with the workspace", + "type": "object", + "properties": { + "name": { + "description": "Workspace Key sub-resource name", + "type": "string" + }, + "keyVaultUrl": { + "description": "Workspace Key sub-resource key vault url", + "type": "string" + } + } + }, + "ManagedIdentity": { + "description": "The workspace managed identity", + "type": "object", + "properties": { + "principalId": { + "description": "The principal ID of the workspace managed identity", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "The tenant ID of the workspace managed identity", + "type": "string", + "format": "uuid", + "readOnly": true + }, + "type": { + "description": "The type of managed identity for the workspace", + "enum": [ + "None", + "SystemAssigned", + "SystemAssigned,UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "description": "The user assigned managed identities.", + "$ref": "#/definitions/UserAssignedManagedIdentities" + } + } + }, + "UserAssignedManagedIdentities": { + "type": "object", + "description": "The User Assigned Managed Identities.", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedManagedIdentity" + } + }, + "UserAssignedManagedIdentity": { + "description": "User Assigned Managed Identity", + "properties": { + "clientId": { + "type": "string", + "format": "uuid", + "description": "The client ID.", + "readOnly": true, + "x-nullable": true + }, + "principalId": { + "type": "string", + "format": "uuid", + "description": "The principal ID.", + "readOnly": true, + "x-nullable": true + } + }, + "type": "object" + }, + "VirtualNetworkProfile": { + "description": "Virtual Network Profile", + "type": "object", + "properties": { + "computeSubnetId": { + "description": "Subnet ID used for computes in workspace", + "type": "string" + } + } + }, + "ManagedVirtualNetworkSettings": { + "description": "Managed Virtual Network Settings", + "type": "object", + "properties": { + "preventDataExfiltration": { + "description": "Prevent Data Exfiltration", + "type": "boolean" + }, + "linkedAccessCheckOnTargetResource": { + "description": "Linked Access Check On Target Resource", + "type": "boolean" + }, + "allowedAadTenantIdsForLinking": { + "description": "Allowed Aad Tenant Ids For Linking", + "type": "array", + "items": { + "type": "string", + "description": "Tenant Id" + } + } + } + }, + "WorkspaceRepositoryConfiguration": { + "description": "Git integration settings", + "type": "object", + "properties": { + "type": { + "description": "Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration", + "type": "string" + }, + "hostName": { + "description": "GitHub Enterprise host name. For example: https://github.mydomain.com", + "type": "string" + }, + "accountName": { + "description": "Account name", + "type": "string" + }, + "projectName": { + "description": "VSTS project name", + "type": "string" + }, + "repositoryName": { + "description": "Repository name", + "type": "string" + }, + "collaborationBranch": { + "description": "Collaboration branch", + "type": "string" + }, + "rootFolder": { + "description": "Root folder to use in the repository", + "type": "string" + }, + "lastCommitId": { + "description": "The last commit ID", + "type": "string" + }, + "tenantId": { + "description": "The VSTS tenant ID", + "type": "string", + "format": "uuid" + } + } + }, + "PurviewConfiguration": { + "description": "Purview Configuration", + "type": "object", + "properties": { + "purviewResourceId": { + "description": "Purview Resource ID", + "type": "string" + } + } + }, + "WorkspaceAadAdminInfo": { + "description": "Workspace active directory administrator", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Workspace active directory administrator properties", + "$ref": "#/definitions/AadAdminProperties", + "x-ms-client-flatten": true + } + } + }, + "CspWorkspaceAdminProperties": { + "description": "Initial workspace AAD admin properties for a CSP subscription", + "properties": { + "initialWorkspaceAdminObjectId": { + "description": "AAD object ID of initial workspace admin", + "type": "string" + } + } + }, + "Workspace": { + "description": "A workspace", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Workspace resource properties", + "$ref": "#/definitions/WorkspaceProperties", + "x-ms-client-flatten": true + }, + "identity": { + "description": "Identity of the workspace", + "$ref": "#/definitions/ManagedIdentity" + } + } + }, + "WorkspaceProperties": { + "description": "Workspace properties", + "type": "object", + "properties": { + "defaultDataLakeStorage": { + "description": "Workspace default data lake storage account details", + "$ref": "#/definitions/DataLakeStorageAccountDetails" + }, + "sqlAdministratorLoginPassword": { + "description": "SQL administrator login password", + "type": "string" + }, + "managedResourceGroupName": { + "description": "Workspace managed resource group. The resource group name uniquely identifies the resource group within the user subscriptionId. The resource group name must be no longer than 90 characters long, and must be alphanumeric characters (Char.IsLetterOrDigit()) and '-', '_', '(', ')' and'.'. Note that the name cannot end with '.'", + "type": "string" + }, + "provisioningState": { + "description": "Resource provisioning state", + "type": "string", + "readOnly": true + }, + "sqlAdministratorLogin": { + "description": "Login for workspace SQL active directory administrator", + "type": "string" + }, + "virtualNetworkProfile": { + "description": "Virtual Network profile", + "$ref": "#/definitions/VirtualNetworkProfile" + }, + "connectivityEndpoints": { + "description": "Connectivity endpoints", + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "managedVirtualNetwork": { + "description": "Setting this to 'default' will ensure that all compute for this workspace is in a virtual network managed on behalf of the user.", + "type": "string" + }, + "privateEndpointConnections": { + "description": "Private endpoint connections to the workspace", + "type": "array", + "items": { + "$ref": "../../../../common/v1/privateEndpointConnection.json#/definitions/PrivateEndpointConnection" + } + }, + "encryption": { + "description": "The encryption details of the workspace", + "$ref": "#/definitions/EncryptionDetails" + }, + "workspaceUID": { + "description": "The workspace unique identifier", + "type": "string", + "readOnly": true, + "format": "uuid" + }, + "extraProperties": { + "description": "Workspace level configs and feature flags", + "additionalProperties": { + "type": "object" + }, + "type": "object", + "readOnly": true + }, + "managedVirtualNetworkSettings": { + "description": "Managed Virtual Network Settings", + "$ref": "#/definitions/ManagedVirtualNetworkSettings" + }, + "workspaceRepositoryConfiguration": { + "description": "Git integration settings", + "$ref": "#/definitions/WorkspaceRepositoryConfiguration" + }, + "purviewConfiguration": { + "description": "Purview Configuration", + "$ref": "#/definitions/PurviewConfiguration" + }, + "adlaResourceId": { + "description": "The ADLA resource ID.", + "type": "string", + "readOnly": true + }, + "publicNetworkAccess": { + "enum": [ + "Enabled", + "Disabled" + ], + "description": "Enable or Disable public network access to workspace", + "type": "string", + "x-ms-enum": { + "name": "WorkspacePublicNetworkAccess", + "modelAsString": true + } + }, + "cspWorkspaceAdminProperties": { + "description": "Initial workspace AAD admin properties for a CSP subscription", + "$ref": "#/definitions/CspWorkspaceAdminProperties" + } + } + }, + "WorkspacePatchInfo": { + "description": "Workspace patch details", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags", + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "identity": { + "description": "The identity of the workspace", + "$ref": "#/definitions/ManagedIdentity" + }, + "properties": { + "description": "Workspace patch properties", + "$ref": "#/definitions/WorkspacePatchProperties", + "x-ms-client-flatten": true + } + } + }, + "WorkspacePatchProperties": { + "description": "Workspace patch properties", + "type": "object", + "properties": { + "sqlAdministratorLoginPassword": { + "description": "SQL administrator login password", + "type": "string" + }, + "managedVirtualNetworkSettings": { + "description": "Managed Virtual Network Settings", + "$ref": "#/definitions/ManagedVirtualNetworkSettings" + }, + "workspaceRepositoryConfiguration": { + "description": "Git integration settings", + "$ref": "#/definitions/WorkspaceRepositoryConfiguration" + }, + "purviewConfiguration": { + "description": "Purview Configuration", + "$ref": "#/definitions/PurviewConfiguration" + }, + "provisioningState": { + "description": "Resource provisioning state", + "type": "string", + "readOnly": true + }, + "encryption": { + "description": "The encryption details of the workspace", + "$ref": "#/definitions/EncryptionDetails" + }, + "publicNetworkAccess": { + "enum": [ + "Enabled", + "Disabled" + ], + "description": "Enable or Disable public network access to workspace", + "type": "string", + "x-ms-enum": { + "name": "WorkspacePublicNetworkAccess", + "modelAsString": true + } + } + } + }, + "ManagedIdentitySqlControlSettingsModel": { + "type": "object", + "title": "Managed Identity Sql Control Settings", + "description": "Sql Control Settings for workspace managed identity", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "title": "Managed Identity Sql Control Settings", + "description": "Sql Control Settings for workspace managed identity", + "properties": { + "grantSqlControlToManagedIdentity": { + "type": "object", + "description": "Grant sql control to managed identity", + "properties": { + "desiredState": { + "description": "Desired state", + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ] + }, + "actualState": { + "description": "Actual state", + "type": "string", + "enum": [ + "Enabling", + "Enabled", + "Disabling", + "Disabled", + "Unknown" + ], + "readOnly": true + } + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "RestorableDroppedSqlPoolProperties": { + "properties": { + "databaseName": { + "readOnly": true, + "type": "string", + "description": "The name of the database" + }, + "edition": { + "readOnly": true, + "type": "string", + "description": "The edition of the database" + }, + "maxSizeBytes": { + "readOnly": true, + "type": "string", + "description": "The max size in bytes of the database" + }, + "serviceLevelObjective": { + "readOnly": true, + "type": "string", + "description": "The service level objective name of the database" + }, + "elasticPoolName": { + "readOnly": true, + "type": "string", + "description": "The elastic pool name of the database" + }, + "creationDate": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The creation date of the database (ISO8601 format)" + }, + "deletionDate": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The deletion date of the database (ISO8601 format)" + }, + "earliestRestoreDate": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The earliest restore date of the database (ISO8601 format)" + } + }, + "description": "The properties of a restorable dropped Sql pool" + }, + "RestorableDroppedSqlPool": { + "properties": { + "location": { + "type": "string", + "readOnly": true, + "description": "The geo-location where the resource lives" + }, + "properties": { + "$ref": "#/definitions/RestorableDroppedSqlPoolProperties", + "description": "The properties of a restorable dropped Sql pool", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "A restorable dropped Sql pool" + }, + "RestorableDroppedSqlPoolListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RestorableDroppedSqlPool" + }, + "description": "A list of restorable dropped Sql pools" + } + }, + "required": [ + "value" + ], + "description": "The response to a list restorable dropped Sql pools request" + } + }, + "parameters": { + "workspaceNameParameter": { + "name": "workspaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the workspace", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/synapse/resource-manager/readme.md b/specification/synapse/resource-manager/readme.md index 8083184df830..dfea3e9122af 100644 --- a/specification/synapse/resource-manager/readme.md +++ b/specification/synapse/resource-manager/readme.md @@ -28,12 +28,55 @@ These are the global settings for the Azure Synapse Analytics API. description: Azure Synapse Analytics Management Client openapi-type: arm azure-arm: true -tag: package-2021-04-preview +tag: package-preview-2021-06 generate-empty-classes: true modelerfour: lenient-model-deduplication: true ``` + +### Tag: package-preview-2021-06 + +These settings apply only when `--tag=package-preview-2021-06` is specified on the command line. + +```yaml $(tag) == 'package-preview-2021-06' +input-file: + - Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json + - Microsoft.Synapse/preview/2021-06-01-preview/checkNameAvailability.json + - Microsoft.Synapse/preview/2021-06-01-preview/firewallRule.json + - Microsoft.Synapse/preview/2021-06-01-preview/integrationRuntime.json + - Microsoft.Synapse/preview/2021-06-01-preview/keys.json + - Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json + - Microsoft.Synapse/preview/2021-06-01-preview/library.json + - Microsoft.Synapse/preview/2021-06-01-preview/operations.json + - Microsoft.Synapse/preview/2021-06-01-preview/privateEndpointConnections.json + - Microsoft.Synapse/preview/2021-06-01-preview/privateLinkResources.json + - Microsoft.Synapse/preview/2021-06-01-preview/privatelinkhub.json + - Microsoft.Synapse/preview/2021-06-01-preview/sqlPool.json + - Microsoft.Synapse/preview/2021-06-01-preview/sqlServer.json + - Microsoft.Synapse/preview/2021-06-01-preview/workspace.json +``` +### Tag: package-2021-05 + +These settings apply only when `--tag=package-2021-05` is specified on the command line. + +``` yaml $(tag) == 'package-2021-05' +input-file: + - Microsoft.Synapse/stable/2021-05-01/bigDataPool.json + - Microsoft.Synapse/stable/2021-05-01/checkNameAvailability.json + - Microsoft.Synapse/stable/2021-05-01/firewallRule.json + - Microsoft.Synapse/stable/2021-05-01/integrationRuntime.json + - Microsoft.Synapse/stable/2021-05-01/keys.json + - Microsoft.Synapse/stable/2021-05-01/library.json + - Microsoft.Synapse/stable/2021-05-01/operations.json + - Microsoft.Synapse/stable/2021-05-01/privateEndpointConnections.json + - Microsoft.Synapse/stable/2021-05-01/privateLinkResources.json + - Microsoft.Synapse/stable/2021-05-01/privatelinkhub.json + - Microsoft.Synapse/stable/2021-05-01/sqlPool.json + - Microsoft.Synapse/stable/2021-05-01/sqlServer.json + - Microsoft.Synapse/stable/2021-05-01/workspace.json +``` + ### Tag: package-2021-04-preview These settings apply only when `--tag=package-2021-04-preview` is specified on the command line. @@ -244,7 +287,6 @@ swagger-to-sdk: - repo: azure-sdk-for-net - repo: azure-sdk-for-js - repo: azure-sdk-for-java - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-go - repo: azure-resource-manager-schemas @@ -277,5 +319,3 @@ batch: ## Go See configuration in [readme.go.md](./readme.go.md) - - diff --git a/specification/synapse/resource-manager/readme.python.md b/specification/synapse/resource-manager/readme.python.md index 52ab82b7a6d4..06e05495007f 100644 --- a/specification/synapse/resource-manager/readme.python.md +++ b/specification/synapse/resource-manager/readme.python.md @@ -4,39 +4,16 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.synapse - package-name: azure-mgmt-synapse - package-version: 0.1.0 - clear-output-folder: true -``` ``` yaml $(python) && $(track2) python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.synapse package-name: azure-mgmt-synapse -package-version: 0.1.0 +package-version: 1.0.0b1 clear-output-folder: true -modelerfour: - lenient-model-deduplication: true ``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/synapse/azure-mgmt-synapse/azure/mgmt/synapse -``` -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/synapse/azure-mgmt-synapse -``` ``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/synapse/azure-mgmt-synapse/azure/mgmt/synapse @@ -45,3 +22,8 @@ output-folder: $(python-sdks-folder)/synapse/azure-mgmt-synapse/azure/mgmt/synap basic-setup-py: true output-folder: $(python-sdks-folder)/synapse/azure-mgmt-synapse ``` + +``` yaml $(python) && $(track2) +modelerfour: + lenient-model-deduplication: true +``` diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/CustomerEventCreate.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/CustomerEventCreate.json new file mode 100644 index 000000000000..0fbf5351ff0f --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/CustomerEventCreate.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "subscriptionId": "476f61a4-952c-422a-b4db-568a828f35df", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "customerEventName": "WeeklySummary", + "api-version": "2020-12-16-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/476f61a4-952c-422a-b4db-568a828f35df/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/476f61a4-952c-422a-b4db-568a828f35df/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/customerEvents/WeeklySummary/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2020-12-16-preview" + }, + "body": { + "name": "WeeklySummary", + "id": "/subscriptions/476f61a4-952c-422a-b4db-568a828f35df/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/2020-12-16-preview/examples/CustomerEventDelete.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/CustomerEventDelete.json new file mode 100644 index 000000000000..06b1c71c635c --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/CustomerEventDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "476f61a4-952c-422a-b4db-568a828f35df", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "customerEventName": "WeeklySummary", + "api-version": "2020-12-16-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/476f61a4-952c-422a-b4db-568a828f35df/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/customerEvents/WeeklySummary/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2020-12-16-preview", + "Location": "https://management.azure.com/subscriptions/476f61a4-952c-422a-b4db-568a828f35df/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/customerEvents/WeeklySummary/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2020-12-16-preview" + } + }, + "204": {} + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/CustomerEventGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/CustomerEventGet.json new file mode 100644 index 000000000000..6d41a8237727 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/CustomerEventGet.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "476f61a4-952c-422a-b4db-568a828f35df", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "customerEventName": "WeeklySummary", + "api-version": "2020-12-16-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/476f61a4-952c-422a-b4db-568a828f35df/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-subscription-id", + "subscriptionName": "test-subscription", + "role": "Contributor" + } + } + }, + { + "receiverType": "DistributionGroup", + "receiverValue": { + "distributionGroupListReceiverValue": { + "distributionGroups": [ + "test@microsoft.com" + ] + } + } + } + ] + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/CustomerEventsList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/CustomerEventsList.json new file mode 100644 index 000000000000..bd3e3cd068bf --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/CustomerEventsList.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "476f61a4-952c-422a-b4db-568a828f35df", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "api-version": "2020-12-16-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/476f61a4-952c-422a-b4db-568a828f35df/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-subscription-id", + "subscriptionName": "test-subscription", + "role": "Contributor" + } + } + }, + { + "receiverType": "DistributionGroup", + "receiverValue": { + "distributionGroupListReceiverValue": { + "distributionGroups": [ + "test@microsoft.com" + ] + } + } + } + ] + } + }, + { + "id": "/subscriptions/476f61a4-952c-422a-b4db-568a828f35df/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/2020-12-16-preview/examples/EmailEventGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/EmailEventGet.json new file mode 100644 index 000000000000..9f4e9114b07d --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/EmailEventGet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "476f61a4-952c-422a-b4db-568a828f35df", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "emailEventResourceName": "weekly-summary", + "api-version": "2020-12-16-preview" + }, + "responses": { + "200": { + "body": { + "name": "weekly-summary", + "id": "/subscriptions/476f61a4-952c-422a-b4db-568a828f35df/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/2020-12-16-preview/examples/EmailEventsList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/EmailEventsList.json new file mode 100644 index 000000000000..c01bf7fb80e1 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/EmailEventsList.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "476f61a4-952c-422a-b4db-568a828f35df", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "api-version": "2020-12-16-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "weekly-summary", + "id": "/subscriptions/476f61a4-952c-422a-b4db-568a828f35df/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/476f61a4-952c-422a-b4db-568a828f35df/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/2020-12-16-preview/examples/TestBaseAccountCreate.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestBaseAccountCreate.json index 597968ebebef..3167d4390725 100644 --- a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestBaseAccountCreate.json +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestBaseAccountCreate.json @@ -8,8 +8,8 @@ "location": "westus", "properties": { "sku": { - "name": "B0", - "tier": "Basic" + "name": "S0", + "tier": "Standard" } } } @@ -25,8 +25,8 @@ "properties": { "provisioningState": "Succeeded", "sku": { - "name": "B0", - "tier": "Basic", + "name": "S0", + "tier": "Standard", "capabilities": [ { "name": "SLA", @@ -59,8 +59,8 @@ "properties": { "provisioningState": "Creating", "sku": { - "name": "B0", - "tier": "Basic", + "name": "S0", + "tier": "Standard", "capabilities": [ { "name": "SLA", diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestBaseAccountGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestBaseAccountGet.json index be4c84df7571..412cc2fbbf7d 100644 --- a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestBaseAccountGet.json +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestBaseAccountGet.json @@ -16,8 +16,8 @@ "properties": { "provisioningState": "Succeeded", "sku": { - "name": "B0", - "tier": "Basic", + "name": "S0", + "tier": "Standard", "capabilities": [ { "name": "SLA", diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestBaseAccountSKUsList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestBaseAccountSKUsList.json index 3bded9783410..4040d3d8c0fd 100644 --- a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestBaseAccountSKUsList.json +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestBaseAccountSKUsList.json @@ -10,8 +10,8 @@ "value": [ { "resourceType": "testBaseAccounts", - "name": "B0", - "tier": "Basic", + "name": "S0", + "tier": "Standard", "locations": [ "global" ], diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestBaseAccountUpdate.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestBaseAccountUpdate.json index fd7aed735237..506de38bdb6b 100644 --- a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestBaseAccountUpdate.json +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestBaseAccountUpdate.json @@ -7,8 +7,8 @@ "parameters": { "properties": { "sku": { - "name": "B0", - "tier": "Basic" + "name": "S0", + "tier": "Standard" } } } @@ -24,8 +24,8 @@ "properties": { "provisioningState": "Succeeded", "sku": { - "name": "B0", - "tier": "Basic", + "name": "S0", + "tier": "Standard", "capabilities": [ { "name": "SLA", diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestBaseAccountsList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestBaseAccountsList.json index c2b764d5f20f..6814291bbbe9 100644 --- a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestBaseAccountsList.json +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestBaseAccountsList.json @@ -17,8 +17,8 @@ "properties": { "provisioningState": "Succeeded", "sku": { - "name": "B0", - "tier": "Basic", + "name": "S0", + "tier": "Standard", "capabilities": [ { "name": "SLA", diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestBaseAccountsListBySubscription.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestBaseAccountsListBySubscription.json index b572382fadee..4bf02006f901 100644 --- a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestBaseAccountsListBySubscription.json +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestBaseAccountsListBySubscription.json @@ -16,8 +16,8 @@ "properties": { "provisioningState": "Succeeded", "sku": { - "name": "B0", - "tier": "Basic", + "name": "S0", + "tier": "Standard", "capabilities": [ { "name": "SLA", diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestResultGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestResultGet.json index 88f932c94265..41dd5f55162b 100644 --- a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestResultGet.json +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestResultGet.json @@ -26,6 +26,7 @@ "testRunTime": "00:21:30", "isDownloadDataAvailable": true, "executionStatus": "Succeeded", + "testStatus": "Completed", "grade": "Pass", "kbNumber": "KB1984839", "packageVersion": "3.0.1", diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestResultsList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestResultsList.json index 1956ff18f2b0..f97bcfb20138 100644 --- a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestResultsList.json +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestResultsList.json @@ -29,6 +29,7 @@ "testRunTime": "00:21:30", "isDownloadDataAvailable": true, "executionStatus": "Succeeded", + "testStatus": "Completed", "grade": "Pass", "kbNumber": "KB1984839", "packageVersion": "3.0.1", @@ -73,6 +74,7 @@ "testRunTime": "01:00:00", "isDownloadDataAvailable": false, "executionStatus": "Failed", + "testStatus": "TestFailure", "grade": "Fail", "kbNumber": "KB1784831", "packageVersion": "3.0.1", diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestSummariesList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestSummariesList.json index 7b812af9830e..ff341bbb936d 100644 --- a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestSummariesList.json +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestSummariesList.json @@ -19,10 +19,12 @@ "applicationName": "contoso-package1", "applicationVersion": "1.0.0", "executionStatus": "Succeeded", + "testStatus": "Completed", "grade": "Pass", "testRunTime": "00:43:21", "featureUpdatesTestSummary": { "executionStatus": "Succeeded", + "testStatus": "Completed", "grade": "Pass", "testRunTime": "00:33:21", "osUpdateTestSummaries": [ @@ -31,6 +33,7 @@ "releaseName": "2020.12.B", "buildVersion": "513", "executionStatus": "Succeeded", + "testStatus": "Completed", "grade": "Pass", "testRunTime": "00:43:21", "testType": "OutOfBoxTest" @@ -40,6 +43,7 @@ "releaseName": "2020.11.B", "buildVersion": "765", "executionStatus": "Succeeded", + "testStatus": "Completed", "grade": "Pass", "testRunTime": "00:13:28", "testType": "OutOfBoxTest" @@ -49,6 +53,7 @@ "releaseName": "2020.11.B", "buildVersion": "313", "executionStatus": "Succeeded", + "testStatus": "Completed", "grade": "Pass", "testRunTime": "00:42:08", "testType": "OutOfBoxTest" @@ -57,6 +62,7 @@ }, "securityUpdatesTestSummary": { "executionStatus": "Succeeded", + "testStatus": "Completed", "grade": "Pass", "testRunTime": "00:43:21", "osUpdateTestSummaries": [ @@ -65,6 +71,7 @@ "releaseName": "2020.12.B", "buildVersion": "513", "executionStatus": "Succeeded", + "testStatus": "Completed", "grade": "Pass", "testRunTime": "00:43:21", "testType": "OutOfBoxTest" @@ -74,6 +81,7 @@ "releaseName": "2020.11.B", "buildVersion": "765", "executionStatus": "Succeeded", + "testStatus": "Completed", "grade": "Pass", "testRunTime": "00:13:28", "testType": "OutOfBoxTest" @@ -83,6 +91,7 @@ "releaseName": "2020.11.B", "buildVersion": "313", "executionStatus": "Succeeded", + "testStatus": "Completed", "grade": "Pass", "testRunTime": "00:42:08", "testType": "OutOfBoxTest" @@ -101,10 +110,12 @@ "applicationName": "contoso-package2", "applicationVersion": "1.0.0", "executionStatus": "Succeeded", + "testStatus": "Completed", "grade": "Pass", "testRunTime": "00:43:21", "featureUpdatesTestSummary": { "executionStatus": "Succeeded", + "testStatus": "Completed", "grade": "Pass", "testRunTime": "00:33:21", "osUpdateTestSummaries": [ @@ -113,6 +124,7 @@ "releaseName": "2020.12.B", "buildVersion": "513", "executionStatus": "Succeeded", + "testStatus": "Completed", "grade": "Pass", "testRunTime": "00:43:21", "testType": "FunctionalTest" @@ -122,6 +134,7 @@ "releaseName": "2020.11.B", "buildVersion": "765", "executionStatus": "Succeeded", + "testStatus": "Completed", "grade": "Pass", "testRunTime": "00:13:28", "testType": "FunctionalTest" @@ -131,6 +144,7 @@ "releaseName": "2020.11.B", "buildVersion": "313", "executionStatus": "Succeeded", + "testStatus": "Completed", "grade": "Pass", "testRunTime": "00:42:08", "testType": "FunctionalTest" @@ -139,6 +153,7 @@ }, "securityUpdatesTestSummary": { "executionStatus": "Succeeded", + "testStatus": "Completed", "grade": "Pass", "testRunTime": "00:43:21", "osUpdateTestSummaries": [ @@ -147,6 +162,7 @@ "releaseName": "2020.12.B", "buildVersion": "513", "executionStatus": "Succeeded", + "testStatus": "Completed", "grade": "Pass", "testRunTime": "00:43:21", "testType": "FunctionalTest" @@ -156,6 +172,7 @@ "releaseName": "2020.11.B", "buildVersion": "765", "executionStatus": "Succeeded", + "testStatus": "Completed", "grade": "Pass", "testRunTime": "00:13:28", "testType": "FunctionalTest" @@ -165,6 +182,7 @@ "releaseName": "2020.11.B", "buildVersion": "313", "executionStatus": "Succeeded", + "testStatus": "Completed", "grade": "Pass", "testRunTime": "00:42:08", "testType": "FunctionalTest" diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestSummaryGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestSummaryGet.json index 5da30233e8f3..6f2f100c0561 100644 --- a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestSummaryGet.json +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/examples/TestSummaryGet.json @@ -18,10 +18,12 @@ "applicationName": "contoso-package2", "applicationVersion": "1.0.0", "executionStatus": "Succeeded", + "testStatus": "Completed", "grade": "Pass", "testRunTime": "00:43:21", "featureUpdatesTestSummary": { "executionStatus": "Succeeded", + "testStatus": "Completed", "grade": "Pass", "testRunTime": "00:33:21", "osUpdateTestSummaries": [ @@ -30,6 +32,7 @@ "releaseName": "2020.12.B", "buildVersion": "513", "executionStatus": "Succeeded", + "testStatus": "Completed", "grade": "Pass", "testRunTime": "00:43:21", "testType": "OutOfBoxTest" @@ -39,6 +42,7 @@ "releaseName": "2020.11.B", "buildVersion": "765", "executionStatus": "Succeeded", + "testStatus": "Completed", "grade": "Pass", "testRunTime": "00:13:28", "testType": "OutOfBoxTest" @@ -48,6 +52,7 @@ "releaseName": "2020.11.B", "buildVersion": "313", "executionStatus": "Succeeded", + "testStatus": "Completed", "grade": "Pass", "testRunTime": "00:42:08", "testType": "OutOfBoxTest" @@ -56,6 +61,7 @@ }, "securityUpdatesTestSummary": { "executionStatus": "Succeeded", + "testStatus": "Completed", "grade": "Pass", "testRunTime": "00:43:21", "osUpdateTestSummaries": [ @@ -64,6 +70,7 @@ "releaseName": "2020.12.B", "buildVersion": "513", "executionStatus": "Succeeded", + "testStatus": "Completed", "grade": "Pass", "testRunTime": "00:43:21", "testType": "OutOfBoxTest" @@ -73,6 +80,7 @@ "releaseName": "2020.11.B", "buildVersion": "765", "executionStatus": "Succeeded", + "testStatus": "Completed", "grade": "Pass", "testRunTime": "00:13:28", "testType": "OutOfBoxTest" @@ -82,6 +90,7 @@ "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/2020-12-16-preview/testbase.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/testbase.json index adb9a2370d20..4562da8129cc 100644 --- a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/testbase.json +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2020-12-16-preview/testbase.json @@ -1,8 +1,8 @@ { "swagger": "2.0", "info": { - "title": "REST API for Test Base", - "description": "REST API for Test Base", + "title": "Test Base", + "description": "Test Base", "version": "2020-12-16-preview" }, "host": "management.azure.com", @@ -39,7 +39,7 @@ "tags": [ "Test Base Account" ], - "operationId": "SKUs_List", + "operationId": "Skus_List", "description": "Lists the available SKUs of Test Base Account in a subscription.", "parameters": [ { @@ -165,7 +165,7 @@ "tags": [ "Test Base Account" ], - "operationId": "TestBaseAccount_Create", + "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": { @@ -233,7 +233,7 @@ "tags": [ "Test Base Account" ], - "operationId": "TestBaseAccount_Update", + "operationId": "TestBaseAccounts_Update", "description": "Update an existing Test Base Account.", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -312,7 +312,7 @@ "tags": [ "Test Base Account" ], - "operationId": "TestBaseAccount_Delete", + "operationId": "TestBaseAccounts_Delete", "description": "Deletes a Test Base Account.", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -369,7 +369,7 @@ "tags": [ "Test Base Account" ], - "operationId": "TestBaseAccount_Get", + "operationId": "TestBaseAccounts_Get", "description": "Gets a Test Base Account.", "parameters": [ { @@ -411,7 +411,7 @@ "tags": [ "Test Base Account" ], - "operationId": "TestBaseAccount_Offboard", + "operationId": "TestBaseAccounts_Offboard", "description": "Offboard a Test Base Account.", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -470,7 +470,7 @@ "tags": [ "Test Base Account" ], - "operationId": "TestBaseAccountUsage_List", + "operationId": "Usage_List", "description": "Lists the usage data of a Test Base Account.", "parameters": [ { @@ -518,7 +518,7 @@ "tags": [ "Test Base Package" ], - "operationId": "TestBaseAccountGetFileUploadUrl", + "operationId": "TestBaseAccounts_GetFileUploadUrl", "description": "Gets the file upload URL of a Test Base Account.", "parameters": [ { @@ -568,7 +568,7 @@ "tags": [ "Test Base Package" ], - "operationId": "TestBaseAccountAvailableOSs_List", + "operationId": "AvailableOS_List", "description": "Lists all the available OSs to run a package under a Test Base Account.", "parameters": [ { @@ -616,7 +616,7 @@ "tags": [ "Test Base Package" ], - "operationId": "TestBaseAccountAvailableOS_Get", + "operationId": "AvailableOS_Get", "description": "Gets an available OS to run a package under a Test Base Account.", "parameters": [ { @@ -666,7 +666,7 @@ "tags": [ "Test Base Package" ], - "operationId": "TestBaseAccountFlightingRings_List", + "operationId": "FlightingRings_List", "description": "Lists all the flighting rings of a Test Base Account.", "parameters": [ { @@ -711,7 +711,7 @@ "tags": [ "Test Base Package" ], - "operationId": "TestBaseAccountFlightingRing_Get", + "operationId": "FlightingRings_Get", "description": "Gets a flighting ring of a Test Base Account.", "parameters": [ { @@ -761,7 +761,7 @@ "tags": [ "Test Base Package" ], - "operationId": "TestBaseAccountTestTypes_List", + "operationId": "TestTypes_List", "description": "Lists all the test types of a Test Base Account.", "parameters": [ { @@ -806,7 +806,7 @@ "tags": [ "Test Base Package" ], - "operationId": "TestBaseAccountTestType_Get", + "operationId": "TestTypes_Get", "description": "Gets a test type of a Test Base Account.", "parameters": [ { @@ -856,7 +856,7 @@ "tags": [ "Test Base Package" ], - "operationId": "CheckPackageNameAvailability", + "operationId": "TestBaseAccounts_CheckPackageNameAvailability", "description": "Checks that the Test Base Package name and version is valid and is not already in use.", "parameters": [ { @@ -952,7 +952,7 @@ "tags": [ "Test Base Package" ], - "operationId": "Package_Create", + "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": { @@ -1020,7 +1020,7 @@ "tags": [ "Test Base Package" ], - "operationId": "Package_Update", + "operationId": "Packages_Update", "description": "Update an existing Test Base Package.", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -1102,7 +1102,7 @@ "tags": [ "Test Base Package" ], - "operationId": "Package_Delete", + "operationId": "Packages_Delete", "description": "Deletes a Test Base Package.", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -1162,7 +1162,7 @@ "tags": [ "Test Base Package" ], - "operationId": "Package_Get", + "operationId": "Packages_Get", "description": "Gets a Test Base Package.", "parameters": [ { @@ -1207,7 +1207,7 @@ "tags": [ "Test Base Package" ], - "operationId": "Package_HardDelete", + "operationId": "Packages_HardDelete", "description": "Hard Delete a Test Base Package.", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -1269,7 +1269,7 @@ "tags": [ "Test Base Package" ], - "operationId": "PackageGetDownloadURL", + "operationId": "Packages_GetDownloadURL", "description": "Gets the download URL of a package.", "parameters": [ { @@ -1359,7 +1359,7 @@ "tags": [ "Test Result" ], - "operationId": "TestSummary_Get", + "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": [ { @@ -1463,7 +1463,7 @@ "tags": [ "Test Result" ], - "operationId": "TestResult_Get", + "operationId": "TestResults_Get", "description": "Get the Test Result by Id with specified OS Update type for a Test Base Package.", "parameters": [ { @@ -1562,7 +1562,7 @@ "tags": [ "Test Result" ], - "operationId": "OSUpdate_Get", + "operationId": "OSUpdates_Get", "description": "Gets an OS Update by name in which the package was tested before.", "parameters": [ { @@ -1663,7 +1663,7 @@ "tags": [ "Test Result" ], - "operationId": "FavoriteProcess_Create", + "operationId": "FavoriteProcesses_Create", "description": "Create or replace a favorite process for a Test Base Package.", "parameters": [ { @@ -1718,7 +1718,7 @@ "tags": [ "Test Result" ], - "operationId": "FavoriteProcess_Delete", + "operationId": "FavoriteProcesses_Delete", "description": "Deletes a favorite process for a specific package.", "parameters": [ { @@ -1764,7 +1764,7 @@ "tags": [ "Test Result" ], - "operationId": "FavoriteProcess_Get", + "operationId": "FavoriteProcesses_Get", "description": "Gets a favorite process for a Test Base Package.", "parameters": [ { @@ -1875,7 +1875,7 @@ "tags": [ "Test Result" ], - "operationId": "AnalysisResult_Get", + "operationId": "AnalysisResults_Get", "description": "Gets an Analysis Result of a Test Result by name.", "parameters": [ { @@ -1935,8 +1935,8 @@ "tags": [ "Test Result" ], - "operationId": "TestResultGetDownloadURL", - "description": "Gets the download URL or the test result.", + "operationId": "TestResults_GetDownloadURL", + "description": "Gets the download URL of the test result.", "parameters": [ { "$ref": "#/parameters/SubscriptionIdParameter" @@ -1983,7 +1983,7 @@ "tags": [ "Test Result" ], - "operationId": "TestResultGetVideoDownloadURL", + "operationId": "TestResults_GetVideoDownloadURL", "description": "Gets the download URL of the test execution screen recording.", "parameters": [ { @@ -2026,6 +2026,319 @@ } } }, + "/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/EmailEventListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$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": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/EmailEventResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/CustomerEventListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/CustomerEventNameParameter" + }, + { + "$ref": "#/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": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/CustomerEventNameParameter" + }, + { + "$ref": "#/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": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/CustomerEventNameParameter" + }, + { + "$ref": "#/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": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CustomerEventGet": { + "$ref": "./examples/CustomerEventGet.json" + } + } + } + }, "/providers/Microsoft.TestBase/operations": { "get": { "tags": [ @@ -2199,7 +2512,6 @@ "type": "string", "description": "The tier of this particular SKU.", "enum": [ - "Basic", "Standard" ], "x-ms-enum": { @@ -3103,6 +3415,10 @@ "$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." @@ -3139,6 +3455,24 @@ "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.", @@ -3160,6 +3494,10 @@ "$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." @@ -3209,6 +3547,10 @@ "$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." @@ -3323,6 +3665,10 @@ "$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." @@ -3555,7 +3901,8 @@ "CPUUtilization", "MemoryUtilization", "CPURegression", - "MemoryRegression" + "MemoryRegression", + "TestAnalysis" ], "type": "string", "x-ms-enum": { @@ -3605,9 +3952,9 @@ "format": "int32", "description": "Exit code." }, - "timeOut": { + "timedOut": { "type": "boolean", - "description": "Whether the subscription execution is timeout." + "description": "Whether the script execution is timed out." } } }, @@ -3839,6 +4186,83 @@ } } }, + "TestAnalysisResultSingletonResourceProperties": { + "description": "The properties of Test Analysis Result.", + "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.", + "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" + } + } + } + }, + "IdentifiedFailure": { + "description": "The failure identified.", + "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." + } + } + }, "OperationListResult": { "description": "A list of operations supported by the resource provider.", "properties": { @@ -3911,6 +4335,186 @@ "description": "Operation properties.", "type": "object", "properties": {} + }, + "EmailEventListResult": { + "description": "A list of email events.", + "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.", + "properties": { + "systemData": { + "description": "The system metadata relating to this resource", + "$ref": "#/definitions/SystemData" + }, + "properties": { + "$ref": "#/definitions/EmailEventProperties", + "x-ms-client-flatten": true, + "description": "Email Event properties." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "EmailEventProperties": { + "description": "The Email Event properties.", + "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.", + "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.", + "properties": { + "systemData": { + "description": "The system metadata relating to this resource", + "$ref": "#/definitions/SystemData" + }, + "properties": { + "$ref": "#/definitions/CustomerEventProperties", + "x-ms-client-flatten": true, + "description": "Customer Notification Event properties." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "CustomerEventProperties": { + "description": "A notification events subscribed to be received by customer.", + "properties": { + "eventName": { + "type": "string", + "description": "The name of the event subscribed to." + }, + "receivers": { + "type": "array", + "items": { + "$ref": "#/definitions/NotificationEventReceiver" + }, + "description": "The notification event receivers." + } + }, + "required": [ + "eventName", + "receivers" + ] + }, + "NotificationEventReceiver": { + "description": "A notification event receivers.", + "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.", + "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.", + "properties": { + "userObjectIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "user object ids." + } + } + }, + "SubscriptionReceiverValue": { + "description": "The subscription role receiver value.", + "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.", + "properties": { + "distributionGroups": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of distribution groups." + } + } } }, "parameters": { @@ -3995,7 +4599,8 @@ "MemoryUtilization", "CPUUtilization", "MemoryRegression", - "CPURegression" + "CPURegression", + "TestAnalysis" ], "x-ms-enum": { "name": "analysisResultType", @@ -4015,7 +4620,8 @@ "memoryUtilization", "cpuUtilization", "memoryRegression", - "cpuRegression" + "cpuRegression", + "testAnalysis" ], "x-ms-enum": { "name": "analysisResultName", @@ -4046,6 +4652,14 @@ "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." } } } diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/AvailabilityGet.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/AvailabilityGet.json deleted file mode 100644 index 6d33f53d8138..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/AvailabilityGet.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "clientRequestId": "A72703F6-C0B1-49EF-854A-59F1994F54E7", - "clientSessionId": "AlertCalculation_W7" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "0d59d156-2807-4952-87bb-0e074417dbfb" - }, - "body": { - "availability": { - "intervalSize": "PT1H", - "distribution": { - "2019-03-27T04:00:00Z": 432447, - "2019-03-27T05:00:00Z": 432340, - "2019-03-27T06:00:00Z": 432451, - "2019-03-27T07:00:00Z": 432436, - "2019-03-26T13:00:00Z": 386247, - "2019-03-27T00:00:00Z": 436968, - "2019-03-27T01:00:00Z": 432509, - "2019-03-27T02:00:00Z": 432487 - }, - "range": { - "from": "2019-03-14T06:38:27.153Z", - "to": "2019-03-27T03:57:11.697Z" - } - } - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/AvailabilityGetEmpty.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/AvailabilityGetEmpty.json deleted file mode 100644 index 45512b7c37fa..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/AvailabilityGetEmpty.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com" - }, - "responses": { - "200": { - "body": {} - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreAvailabilityGet.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreAvailabilityGet.json deleted file mode 100644 index 0dc72061e3c7..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreAvailabilityGet.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "coldstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "clientRequestId": "A72703F6-C0B1-49EF-854A-59F1994F54E7", - "clientSessionId": "AlertCalculation_W7" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "0d59d156-2807-4952-87bb-0e074417dbfb" - }, - "body": { - "availability": { - "intervalSize": "PT1H", - "distribution": { - "2019-03-27T04:00:00Z": 432447, - "2019-03-27T05:00:00Z": 432340, - "2019-03-27T06:00:00Z": 432451, - "2019-03-27T07:00:00Z": 432436, - "2019-03-26T13:00:00Z": 386247, - "2019-03-27T00:00:00Z": 436968, - "2019-03-27T01:00:00Z": 432509, - "2019-03-27T02:00:00Z": 432487 - }, - "range": { - "from": "2019-03-14T06:38:27.153Z", - "to": "2019-03-27T03:57:11.697Z" - } - } - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreEventSchemaGet.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreEventSchemaGet.json deleted file mode 100644 index 0d7d9ecef3db..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreEventSchemaGet.json +++ /dev/null @@ -1,45 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "coldstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "searchSpan": { - "from": "2018-08-01T00:00:00.000Z", - "to": "2018-08-31T00:00:00.000Z" - } - } - }, - "responses": { - "200": { - "body": { - "properties": [ - { - "name": "Building", - "type": "String" - }, - { - "name": "Room", - "type": "String" - }, - { - "name": "DeviceId", - "type": "Double" - }, - { - "name": "Temperature", - "type": "Double" - }, - { - "name": "Pressure", - "type": "Double" - }, - { - "name": "Status", - "type": "String" - } - ] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryAggregateSeriesPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryAggregateSeriesPage1.json deleted file mode 100644 index 7359328a8c69..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryAggregateSeriesPage1.json +++ /dev/null @@ -1,62 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "coldstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "aggregateSeries": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "interval": "PT1M", - "inlineVariables": { - "Count": { - "kind": "aggregate", - "filter": null, - "aggregation": { - "tsx": "count()" - } - }, - "MinTemperature": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "min($value)" - } - }, - "MaxTemperature": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "max($value)" - } - } - }, - "projectedVariables": [ - "Count", - "MinTemperature", - "MaxTemperature" - ] - } - } - }, - "responses": { - "200": { - "body": { - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryAggregateSeriesPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryAggregateSeriesPage2.json deleted file mode 100644 index a77512577cf5..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryAggregateSeriesPage2.json +++ /dev/null @@ -1,145 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "coldstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", - "parameters": { - "aggregateSeries": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "interval": "PT1M", - "inlineVariables": { - "Count": { - "kind": "aggregate", - "filter": null, - "aggregation": { - "tsx": "count()" - } - }, - "MinTemperature": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "min($value)" - } - }, - "MaxTemperature": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "max($value)" - } - } - }, - "projectedVariables": [ - "Count", - "MinTemperature", - "MaxTemperature" - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:00Z", - "2016-08-01T00:01:00Z", - "2016-08-01T00:02:00Z", - "2016-08-01T00:03:00Z", - "2016-08-01T00:04:00Z", - "2016-08-01T00:05:00Z", - "2016-08-01T00:06:00Z", - "2016-08-01T00:07:00Z", - "2016-08-01T00:08:00Z", - "2016-08-01T00:09:00Z", - "2016-08-01T00:10:00Z" - ], - "properties": [ - { - "name": "Count", - "type": "Long", - "values": [ - 50, - 60, - 60, - 60, - 60, - 60, - 60, - 60, - 60, - 60, - null - ] - }, - { - "name": "AverageTemperature", - "type": "Double", - "values": [ - 71.25, - 85.0, - 82.5, - 80.0, - 89.166666666666671, - 75.0, - 90.0, - 75.833333333333329, - 85.0, - 82.5, - null - ] - }, - { - "name": "MinTemperature", - "type": "Double", - "values": [ - 65.125, - 77.625, - 65.125, - 72.625, - 65.125, - 67.625, - 82.625, - 65.125, - 77.625, - 65.125, - null - ] - }, - { - "name": "MaxTemperature", - "type": "Double", - "values": [ - 77.375, - 92.375, - 99.875, - 87.375, - 99.875, - 82.375, - 97.375, - 99.875, - 92.375, - 99.875, - null - ] - } - ], - "progress": 100.0 - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryGetEventsPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryGetEventsPage1.json deleted file mode 100644 index 490978a50ebd..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryGetEventsPage1.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "coldstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "getEvents": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": { - "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" - }, - "projectedProperties": [ - { - "name": "Building", - "type": "String" - }, - { - "name": "Temperature", - "type": "Double" - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryGetEventsPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryGetEventsPage2.json deleted file mode 100644 index 5a56e4aba6fd..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryGetEventsPage2.json +++ /dev/null @@ -1,87 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "coldstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", - "parameters": { - "getEvents": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": { - "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" - }, - "projectedProperties": [ - { - "name": "Building", - "type": "String" - }, - { - "name": "Temperature", - "type": "Double" - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:10Z", - "2016-08-01T00:00:11Z", - "2016-08-01T00:00:12Z", - "2016-08-01T00:00:13Z", - "2016-08-01T00:00:14Z", - "2016-08-01T00:00:15Z", - "2016-08-01T00:00:16Z", - "2016-08-01T00:00:17Z", - "2016-08-01T00:00:18Z", - "2016-08-01T00:00:19Z" - ], - "properties": [ - { - "name": "Building", - "type": "String", - "values": [ - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium" - ] - }, - { - "name": "Temperature", - "type": "Double", - "values": [ - 65.125, - 65.375, - 65.625, - 65.875, - 66.125, - 66.375, - 66.625, - 66.875, - 67.125, - 67.375 - ] - } - ], - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryGetEventsPage3.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryGetEventsPage3.json deleted file mode 100644 index 0bc2757452ca..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryGetEventsPage3.json +++ /dev/null @@ -1,60 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "coldstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=", - "parameters": { - "getEvents": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": { - "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" - }, - "projectedProperties": [ - { - "name": "Building", - "type": "String" - }, - { - "name": "Temperature", - "type": "Double" - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:20Z" - ], - "properties": [ - { - "name": "Building", - "type": "String", - "values": [ - "Millenium" - ] - }, - { - "name": "Temperature", - "type": "Double", - "values": [ - 67.575 - ] - } - ], - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAbCDewidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryGetEventsPage4.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryGetEventsPage4.json deleted file mode 100644 index db20c0bc8f59..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryGetEventsPage4.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "coldstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAbCDewidGFrZSI6MTAwMH0=", - "parameters": { - "getEvents": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": { - "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" - }, - "projectedProperties": [ - { - "name": "Building", - "type": "String" - }, - { - "name": "Temperature", - "type": "Double" - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [], - "properties": [], - "progress": 100.0 - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryGetSeriesPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryGetSeriesPage1.json deleted file mode 100644 index c5b75b0e8141..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryGetSeriesPage1.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "coldstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "getSeries": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": null, - "inlineVariables": { - "temperatures": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "avg($value)" - } - } - }, - "projectedVariables": [ - "temperatures" - ] - } - } - }, - "responses": { - "200": { - "body": { - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryGetSeriesPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryGetSeriesPage2.json deleted file mode 100644 index 0f98a240eae6..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryGetSeriesPage2.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "coldstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", - "parameters": { - "getSeries": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": null, - "inlineVariables": { - "temperatures": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "avg($value)" - } - } - }, - "projectedVariables": [ - "temperatures" - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:10Z", - "2016-08-01T00:00:11Z", - "2016-08-01T00:00:12Z", - "2016-08-01T00:00:13Z", - "2016-08-01T00:00:14Z", - "2016-08-01T00:00:15Z", - "2016-08-01T00:00:16Z", - "2016-08-01T00:00:17Z", - "2016-08-01T00:00:18Z", - "2016-08-01T00:00:19Z", - "2016-08-01T00:00:20Z" - ], - "properties": [ - { - "name": "temperatures", - "type": "Double", - "values": [ - 65.125, - 65.375, - 65.625, - 65.875, - 66.125, - 66.375, - 66.625, - 66.875, - 67.125, - 67.375, - 67.625 - ] - } - ], - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryGetSeriesPage3.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryGetSeriesPage3.json deleted file mode 100644 index 6e8e10631475..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ColdStoreQueryGetSeriesPage3.json +++ /dev/null @@ -1,55 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "coldstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=", - "parameters": { - "getSeries": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": null, - "inlineVariables": { - "temperatures": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "avg($value)" - } - } - }, - "projectedVariables": [ - "temperatures" - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:21Z" - ], - "properties": [ - { - "name": "temperatures", - "type": "Double", - "values": [ - 67.825 - ] - } - ], - "progress": 100.0 - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/EventSchemaGet.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/EventSchemaGet.json deleted file mode 100644 index bacda9fd39d6..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/EventSchemaGet.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "searchSpan": { - "from": "2018-08-01T00:00:00.000Z", - "to": "2018-08-31T00:00:00.000Z" - } - } - }, - "responses": { - "200": { - "body": { - "properties": [ - { - "name": "Building", - "type": "String" - }, - { - "name": "Room", - "type": "String" - }, - { - "name": "DeviceId", - "type": "Double" - }, - { - "name": "Temperature", - "type": "Double" - }, - { - "name": "Pressure", - "type": "Double" - }, - { - "name": "Status", - "type": "String" - } - ] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/EventSchemaGetEmpty.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/EventSchemaGetEmpty.json deleted file mode 100644 index 798e8c314e30..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/EventSchemaGetEmpty.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "searchSpan": { - "from": "2016-08-01T00:00:00.000Z", - "to": "2016-08-31T00:00:00.000Z" - } - } - }, - "responses": { - "200": { - "body": { - "properties": [] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesBatchDeleteByIds.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesBatchDeleteByIds.json deleted file mode 100644 index 9d625e269976..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesBatchDeleteByIds.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "delete": { - "hierarchyIds": [ - "a28fd14c-6b98-4ab5-9301-3840f142d30e" - ] - } - } - }, - "responses": { - "200": { - "body": { - "delete": [ - null - ] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesBatchDeleteByNames.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesBatchDeleteByNames.json deleted file mode 100644 index e8f1c1098374..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesBatchDeleteByNames.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "delete": { - "names": [ - "WindFarm" - ] - } - } - }, - "responses": { - "200": { - "body": { - "delete": [ - null - ] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesBatchGetByIds.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesBatchGetByIds.json deleted file mode 100644 index dd235acc4832..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesBatchGetByIds.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "get": { - "hierarchyIds": [ - "6e292e54-9a26-4be1-9034-607d71492707", - "a28fd14c-6b98-4ab5-9301-3840f142d30e" - ] - } - } - }, - "responses": { - "200": { - "body": { - "get": [ - { - "hierarchy": { - "id": "6e292e54-9a26-4be1-9034-607d71492707", - "name": "Location", - "source": { - "instanceFieldNames": [ - "state", - "city" - ] - } - } - }, - { - "hierarchy": { - "id": "a28fd14c-6b98-4ab5-9301-3840f142d30e", - "name": "ManufactureDate", - "source": { - "instanceFieldNames": [ - "year", - "month" - ] - } - } - } - ] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesBatchGetByNames.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesBatchGetByNames.json deleted file mode 100644 index 12f91a55bab6..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesBatchGetByNames.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "get": { - "names": [ - "Location", - "ManufactureDate" - ] - } - } - }, - "responses": { - "200": { - "body": { - "get": [ - { - "hierarchy": { - "id": "6e292e54-9a26-4be1-9034-607d71492707", - "name": "Location", - "source": { - "instanceFieldNames": [ - "state", - "city" - ] - } - } - }, - { - "hierarchy": { - "id": "a28fd14c-6b98-4ab5-9301-3840f142d30e", - "name": "ManufactureDate", - "source": { - "instanceFieldNames": [ - "year", - "month" - ] - } - } - } - ] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesBatchPut.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesBatchPut.json deleted file mode 100644 index f721d4f85627..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesBatchPut.json +++ /dev/null @@ -1,64 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "put": [ - { - "id": "6e292e54-9a26-4be1-9034-607d71492707", - "name": "Location", - "source": { - "instanceFieldNames": [ - "state", - "city" - ] - } - }, - { - "id": "a28fd14c-6b98-4ab5-9301-3840f142d30e", - "name": "ManufactureDate", - "source": { - "instanceFieldNames": [ - "year", - "month" - ] - } - } - ] - } - }, - "responses": { - "200": { - "body": { - "put": [ - { - "hierarchy": { - "id": "6e292e54-9a26-4be1-9034-607d71492707", - "name": "Location", - "source": { - "instanceFieldNames": [ - "state", - "city" - ] - } - }, - "error": null - }, - { - "hierarchy": { - "id": "a28fd14c-6b98-4ab5-9301-3840f142d30e", - "name": "ManufactureDate", - "source": { - "instanceFieldNames": [ - "year", - "month" - ] - } - }, - "error": null - } - ] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesGetPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesGetPage1.json deleted file mode 100644 index 8e9cd4ccc56d..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesGetPage1.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com" - }, - "responses": { - "200": { - "body": { - "hierarchies": [ - { - "id": "6e292e54-9a26-4be1-9034-607d71492707", - "name": "Location", - "source": { - "instanceFieldNames": [ - "state", - "city" - ] - } - } - ], - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesGetPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesGetPage2.json deleted file mode 100644 index ee899eade91f..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesGetPage2.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" - }, - "responses": { - "200": { - "body": { - "hierarchies": [ - { - "id": "6e292e54-9a26-4be1-9034-607d71492707", - "name": "Location", - "source": { - "instanceFieldNames": [ - "state", - "city" - ] - } - } - ], - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrASI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesGetPage3.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesGetPage3.json deleted file mode 100644 index 0efe91089d64..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/HierarchiesGetPage3.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrASI6MTAwMH0=" - }, - "responses": { - "200": { - "body": { - "hierarchies": [] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesBatchDeleteByIds.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesBatchDeleteByIds.json deleted file mode 100644 index d0039bcec6b0..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesBatchDeleteByIds.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "delete": { - "timeSeriesIds": [ - [ - "2da181d7-8346-4cf2-bd94-a17742237429", - "T1" - ], - [ - "18672e3d-2beb-4007-9846-042b09ef3c72", - "T2" - ] - ] - } - } - }, - "responses": { - "200": { - "body": { - "delete": [ - null, - { - "code": "InvalidInput", - "message": "Time series instance with ID '[\"18672e3d-2beb-4007-9846-042b09ef3c72\", \"T2\"]' cannot be deleted. There are already ingested events associated with this time series ID.", - "innerError": { - "code": "CannotDeleteInstance" - } - } - ] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesBatchDeleteByNames.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesBatchDeleteByNames.json deleted file mode 100644 index d8302aa70992..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesBatchDeleteByNames.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "delete": { - "names": [ - "F2W6.GF", - "F1W7.GS1" - ] - } - } - }, - "responses": { - "200": { - "body": { - "delete": [ - null, - { - "code": "InvalidInput", - "message": "Time series instance with ID '[\"18672e3d-2beb-4007-9846-042b09ef3c72\", \"T2\"]' cannot be deleted. There are already ingested events associated with this time series ID.", - "innerError": { - "code": "CannotDeleteInstance" - } - } - ] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesBatchGetByIds.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesBatchGetByIds.json deleted file mode 100644 index f6bab33afcf5..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesBatchGetByIds.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "get": { - "timeSeriesIds": [ - [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ] - ] - } - } - }, - "responses": { - "200": { - "body": { - "get": [ - { - "instance": { - "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff", - "name": "F1W7.GS1", - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "description": "ContosoFarm1W7_GenSpeed1", - "hierarchyIds": [ - "33d72529-dd73-4c31-93d8-ae4e6cb5605d" - ], - "instanceFields": { - "Name": "GeneratorSpeed", - "Plant": "Contoso Plant 1", - "Unit": "W7", - "System": "Generator System", - "Status": false, - "Version": 1.3, - "Code": 28 - } - } - } - ] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesBatchGetByNames.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesBatchGetByNames.json deleted file mode 100644 index d2b214a70f9e..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesBatchGetByNames.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "get": { - "names": [ - "F1W7.GS1" - ] - } - } - }, - "responses": { - "200": { - "body": { - "get": [ - { - "instance": { - "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff", - "name": "F1W7.GS1", - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "description": "ContosoFarm1W7_GenSpeed1", - "hierarchyIds": [ - "33d72529-dd73-4c31-93d8-ae4e6cb5605d" - ], - "instanceFields": { - "Name": "GeneratorSpeed", - "Plant": "Contoso Plant 1", - "Unit": "W7", - "System": "Generator System", - "Status": false, - "Version": 1.3, - "Code": 28 - } - } - } - ] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesBatchPut.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesBatchPut.json deleted file mode 100644 index c5277fe2c7eb..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesBatchPut.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "put": [ - { - "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff", - "name": "F1W7.GS1", - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "description": "ContosoFarm1W7_GenSpeed1", - "hierarchyIds": [ - "33d72529-dd73-4c31-93d8-ae4e6cb5605d" - ], - "instanceFields": { - "Name": "GeneratorSpeed", - "Plant": "Contoso Plant 1", - "Unit": "W7", - "System": "Generator System", - "Status": false, - "Version": 1.3, - "Code": 28 - } - } - ] - } - }, - "responses": { - "200": { - "body": { - "put": [ - { - "error": null - } - ] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesBatchUpdate.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesBatchUpdate.json deleted file mode 100644 index 47a934526e4b..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesBatchUpdate.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "update": [ - { - "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff", - "name": "F1W7.GS1", - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "description": "ContosoFarm1W7_GenSpeed1", - "hierarchyIds": [ - "33d72529-dd73-4c31-93d8-ae4e6cb5605d" - ], - "instanceFields": { - "Name": "GeneratorSpeed", - "Plant": "Contoso Plant 1", - "Unit": "W7", - "System": "Generator System", - "Status": false, - "Version": 1.3, - "Code": 28 - } - } - ] - } - }, - "responses": { - "200": { - "body": { - "update": [ - { - "error": null - } - ] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesGetPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesGetPage1.json deleted file mode 100644 index fdd897abe81e..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesGetPage1.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com" - }, - "responses": { - "200": { - "body": { - "instances": [ - { - "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff", - "name": "F1W7.GS1", - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "description": "ContosoFarm1W7_GenSpeed1", - "hierarchyIds": [ - "33d72529-dd73-4c31-93d8-ae4e6cb5605d" - ], - "instanceFields": { - "Name": "GeneratorSpeed", - "Plant": "Contoso Plant 1", - "Unit": "W7", - "System": "Generator System", - "Status": false, - "Version": 1.3, - "Code": 28 - } - } - ], - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesGetPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesGetPage2.json deleted file mode 100644 index ec513c101c84..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesGetPage2.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" - }, - "responses": { - "200": { - "body": { - "instances": [ - { - "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff", - "timeSeriesId": [ - "fe984fd0-f632-49ab-990e-3ded259e29b8", - "T1" - ], - "description": "ContosoFarm1W6_GridVoltage3", - "hierarchyIds": [ - "33d72529-dd73-4c31-93d8-ae4e6cb5605d" - ], - "instanceFields": { - "Name": "GridVoltagePhase3", - "Plant": "Contoso Plant 1", - "Unit": "W6", - "System": "Generator System", - "Status": false, - "Version": 1.3, - "Code": 28 - } - } - ], - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrASI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesGetPage3.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesGetPage3.json deleted file mode 100644 index 49b39f084b3a..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesGetPage3.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrASI6MTAwMH0=" - }, - "responses": { - "200": { - "body": { - "instances": [] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesSuggest.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesSuggest.json deleted file mode 100644 index 3f6783e48663..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/InstancesSuggest.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "searchString": "flo", - "take": 3 - } - }, - "responses": { - "200": { - "body": { - "suggestions": [ - { - "searchString": "floor 100", - "highlightedSearchString": "floor 100" - }, - { - "searchString": "sensor on floor 0", - "highlightedSearchString": "sensor on floor 0" - }, - { - "searchString": "sensor on floor 1", - "highlightedSearchString": "sensor on floor 1" - } - ] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ModelSettingsGet.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ModelSettingsGet.json deleted file mode 100644 index 33be629b0ae6..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ModelSettingsGet.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com" - }, - "responses": { - "200": { - "body": { - "modelSettings": { - "name": "DefaultModel", - "timeSeriesIdProperties": [ - { - "name": "DeviceId", - "type": "String" - } - ], - "defaultTypeId": "5AB70D71-A8CD-410E-B70D-6F04AB9C132C" - } - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ModelSettingsUpdateName.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ModelSettingsUpdateName.json deleted file mode 100644 index a293f2d67e83..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/ModelSettingsUpdateName.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "name": "Thermostats" - } - }, - "responses": { - "200": { - "body": { - "modelSettings": { - "name": "Thermostats", - "timeSeriesIdProperties": [ - { - "name": "DeviceId", - "type": "String" - } - ], - "defaultTypeId": "5AB70D71-A8CD-410E-B70D-6F04AB9C132C" - } - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesPage1.json deleted file mode 100644 index 927530c2be95..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesPage1.json +++ /dev/null @@ -1,61 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "aggregateSeries": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "interval": "PT1M", - "inlineVariables": { - "Count": { - "kind": "aggregate", - "filter": null, - "aggregation": { - "tsx": "count()" - } - }, - "MinTemperature": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "min($value)" - } - }, - "MaxTemperature": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "max($value)" - } - } - }, - "projectedVariables": [ - "Count", - "MinTemperature", - "MaxTemperature" - ] - } - } - }, - "responses": { - "200": { - "body": { - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesPage2.json deleted file mode 100644 index 9c0424d1ada5..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesPage2.json +++ /dev/null @@ -1,144 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", - "parameters": { - "aggregateSeries": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "interval": "PT1M", - "inlineVariables": { - "Count": { - "kind": "aggregate", - "filter": null, - "aggregation": { - "tsx": "count()" - } - }, - "MinTemperature": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "min($value)" - } - }, - "MaxTemperature": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "max($value)" - } - } - }, - "projectedVariables": [ - "Count", - "MinTemperature", - "MaxTemperature" - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:00Z", - "2016-08-01T00:01:00Z", - "2016-08-01T00:02:00Z", - "2016-08-01T00:03:00Z", - "2016-08-01T00:04:00Z", - "2016-08-01T00:05:00Z", - "2016-08-01T00:06:00Z", - "2016-08-01T00:07:00Z", - "2016-08-01T00:08:00Z", - "2016-08-01T00:09:00Z", - "2016-08-01T00:10:00Z" - ], - "properties": [ - { - "name": "Count", - "type": "Long", - "values": [ - 50, - 60, - 60, - 60, - 60, - 60, - 60, - 60, - 60, - 60, - null - ] - }, - { - "name": "AverageTemperature", - "type": "Double", - "values": [ - 71.25, - 85.0, - 82.5, - 80.0, - 89.166666666666671, - 75.0, - 90.0, - 75.833333333333329, - 85.0, - 82.5, - null - ] - }, - { - "name": "MinTemperature", - "type": "Double", - "values": [ - 65.125, - 77.625, - 65.125, - 72.625, - 65.125, - 67.625, - 82.625, - 65.125, - 77.625, - 65.125, - null - ] - }, - { - "name": "MaxTemperature", - "type": "Double", - "values": [ - 77.375, - 92.375, - 99.875, - 87.375, - 99.875, - 82.375, - 97.375, - 99.875, - 92.375, - 99.875, - null - ] - } - ], - "progress": 100.0 - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesWithCategoricalInterpolatedVariable.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesWithCategoricalInterpolatedVariable.json deleted file mode 100644 index 662161648bff..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesWithCategoricalInterpolatedVariable.json +++ /dev/null @@ -1,250 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", - "parameters": { - "aggregateSeries": { - "searchSpan": { - "from": "2019-10-10T23:41:04.021Z", - "to": "2019-10-10T23:42:22.846Z" - }, - "timeSeriesId": [ - "Sensor_58" - ], - "interval": "PT2S", - "inlineVariables": { - "Status_String": { - "kind": "categorical", - "value": { - "tsx": "$event.[Status].String" - }, - "interpolation": { - "kind": "Step", - "boundary": { - "span": "PT5S" - } - }, - "categories": [ - { - "label": "Good", - "values": [ - "Good", - "Very Good", - "Excellent" - ] - }, - { - "label": "Bad", - "values": [ - "Bad", - "OK" - ] - }, - { - "label": "Other", - "values": [ - "Other" - ] - } - ], - "defaultCategory": { - "label": "Unknown" - } - }, - "Status_Long": { - "kind": "categorical", - "value": { - "tsx": "tolong($event.[Status].Double)" - }, - "interpolation": { - "kind": "Step", - "boundary": { - "span": "PT5S" - } - }, - "categories": [ - { - "label": "Good", - "values": [ - 0, - 1, - 2 - ] - }, - { - "label": "Bad", - "values": [ - 3, - 4 - ] - }, - { - "label": "Other", - "values": [ - 5 - ] - } - ], - "defaultCategory": { - "label": "Unknown" - } - } - }, - "projectedVariables": [ - "Status_String", - "Status_Long" - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2019-10-10T23:41:04Z", - "2019-10-10T23:41:06Z", - "2019-10-10T23:41:08Z", - "2019-10-10T23:41:10Z", - "2019-10-10T23:41:12Z", - "2019-10-10T23:41:14Z", - "2019-10-10T23:41:16Z", - "2019-10-10T23:41:18Z", - "2019-10-10T23:41:20Z", - "2019-10-10T23:41:22Z" - ], - "properties": [ - { - "values": [ - 0.203, - 0.141, - 0.268, - 0.398, - 0.402, - 0.047, - 0.1245, - 0.75, - 0.206, - 0.2635 - ], - "name": "Status_String[Good]", - "type": "Double" - }, - { - "values": [ - 0.266, - 0.1955, - 0.242, - 0.148, - 0.25, - 0.055, - 0.6295, - 0.109, - 0.41, - 0.2125 - ], - "name": "Status_String[Bad]", - "type": "Double" - }, - { - "values": [ - 0.5205, - 0.6635, - 0.49, - 0.454, - 0.348, - 0.898, - 0.246, - 0.141, - 0.384, - 0.524 - ], - "name": "Status_String[Other]", - "type": "Double" - }, - { - "values": [ - 0.0, - 0.0, - 0.0, - 0.0, - 0.0, - 0.0, - 0.0, - 0.0, - 0.0, - 0.0 - ], - "name": "Status_String[Unknown]", - "type": "Double" - }, - { - "values": [ - 0.203, - 0.141, - 0.268, - 0.398, - 0.402, - 0.047, - 0.1245, - 0.75, - 0.206, - 0.2635 - ], - "name": "Status_Long[Good]", - "type": "Double" - }, - { - "values": [ - 0.266, - 0.1955, - 0.242, - 0.148, - 0.25, - 0.055, - 0.6295, - 0.109, - 0.41, - 0.2125 - ], - "name": "Status_Long[Bad]", - "type": "Double" - }, - { - "values": [ - 0.5205, - 0.6635, - 0.49, - 0.454, - 0.348, - 0.898, - 0.246, - 0.141, - 0.384, - 0.524 - ], - "name": "Status_Long[Other]", - "type": "Double" - }, - { - "values": [ - 0.0, - 0.0, - 0.0, - 0.0, - 0.0, - 0.0, - 0.0, - 0.0, - 0.0, - 0.0 - ], - "name": "Status_Long[Unknown]", - "type": "Double" - } - ], - "progress": 100.0 - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesWithCategoricalVariable.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesWithCategoricalVariable.json deleted file mode 100644 index 3da48c7f188f..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesWithCategoricalVariable.json +++ /dev/null @@ -1,238 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", - "parameters": { - "aggregateSeries": { - "searchSpan": { - "from": "2019-10-10T23:42:00.000Z", - "to": "2019-10-10T23:42:20.000Z" - }, - "timeSeriesId": [ - "Sensor_58" - ], - "interval": "PT2S", - "inlineVariables": { - "Status_String": { - "kind": "categorical", - "value": { - "tsx": "$event.[Status].String" - }, - "categories": [ - { - "label": "Good", - "values": [ - "Good", - "Very Good", - "Excellent" - ] - }, - { - "label": "Bad", - "values": [ - "Bad", - "OK" - ] - }, - { - "label": "Other", - "values": [ - "Other" - ] - } - ], - "defaultCategory": { - "label": "Unknown" - } - }, - "Status_Long": { - "kind": "categorical", - "value": { - "tsx": "tolong($event.[Status].Double)" - }, - "categories": [ - { - "label": "Good", - "values": [ - 0, - 1, - 2 - ] - }, - { - "label": "Bad", - "values": [ - 3, - 4 - ] - }, - { - "label": "Other", - "values": [ - 5 - ] - } - ], - "defaultCategory": { - "label": "Unknown" - } - } - }, - "projectedVariables": [ - "Status_String", - "Status_Long" - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2019-10-10T23:42:00Z", - "2019-10-10T23:42:02Z", - "2019-10-10T23:42:04Z", - "2019-10-10T23:42:06Z", - "2019-10-10T23:42:08Z", - "2019-10-10T23:42:10Z", - "2019-10-10T23:42:12Z", - "2019-10-10T23:42:14Z", - "2019-10-10T23:42:16Z", - "2019-10-10T23:42:18Z" - ], - "properties": [ - { - "values": [ - 5, - 8, - 4, - 6, - 9, - 8, - 3, - 6, - 5, - 8 - ], - "name": "Status_String[Good]", - "type": "Long" - }, - { - "values": [ - 4, - 3, - 3, - 5, - 5, - 3, - 9, - 7, - 7, - 7 - ], - "name": "Status_String[Bad]", - "type": "Long" - }, - { - "values": [ - 11, - 9, - 13, - 9, - 6, - 9, - 8, - 7, - 8, - 5 - ], - "name": "Status_String[Other]", - "type": "Long" - }, - { - "values": [ - 0, - 0, - 0, - 0, - 0, - 0, - 0, - 0, - 0, - 0 - ], - "name": "Status_String[Unknown]", - "type": "Long" - }, - { - "values": [ - 5, - 8, - 4, - 6, - 9, - 8, - 3, - 6, - 5, - 8 - ], - "name": "Status_Long[Good]", - "type": "Long" - }, - { - "values": [ - 4, - 3, - 3, - 5, - 5, - 3, - 9, - 7, - 7, - 7 - ], - "name": "Status_Long[Bad]", - "type": "Long" - }, - { - "values": [ - 11, - 9, - 13, - 9, - 6, - 9, - 8, - 7, - 8, - 5 - ], - "name": "Status_Long[Other]", - "type": "Long" - }, - { - "values": [ - 0, - 0, - 0, - 0, - 0, - 0, - 0, - 0, - 0, - 0 - ], - "name": "Status_Long[Unknown]", - "type": "Long" - } - ], - "progress": 100.0 - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesWithSampleInterpolation.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesWithSampleInterpolation.json deleted file mode 100644 index 907d9093d875..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryAggregateSeriesWithSampleInterpolation.json +++ /dev/null @@ -1,114 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", - "parameters": { - "aggregateSeries": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "interval": "PT1M", - "inlineVariables": { - "LinearSampleInterpolation": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "interpolation": { - "kind": "Linear", - "boundary": { - "span": "P1D" - } - }, - "aggregation": { - "tsx": "left($value)" - } - }, - "StepSampleInterpolation": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "interpolation": { - "kind": "Step", - "boundary": { - "span": "P1D" - } - }, - "aggregation": { - "tsx": "left($value)" - } - } - }, - "projectedVariables": [ - "LinearSampleInterpolation", - "StepSampleInterpolation" - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:00Z", - "2016-08-01T00:01:00Z", - "2016-08-01T00:02:00Z", - "2016-08-01T00:03:00Z", - "2016-08-01T00:04:00Z", - "2016-08-01T00:05:00Z", - "2016-08-01T00:06:00Z", - "2016-08-01T00:07:00Z", - "2016-08-01T00:08:00Z", - "2016-08-01T00:09:00Z", - "2016-08-01T00:10:00Z" - ], - "properties": [ - { - "name": "LinearSampleInterpolation", - "type": "Double", - "values": [ - 50.0, - 60.0, - 60.0, - 60.0, - 60.0, - 60.0, - 60.0, - 60.0, - 60.0, - 60.0, - 62.0 - ] - }, - { - "name": "StepSampleInterpolation", - "type": "Double", - "values": [ - 71.25, - 85.0, - 82.5, - 80.0, - 89.166666666666671, - 75.0, - 90.0, - 75.833333333333329, - 85.0, - 82.5, - 84.0 - ] - } - ], - "progress": 100.0 - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsPage1.json deleted file mode 100644 index a67cee0911c6..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsPage1.json +++ /dev/null @@ -1,39 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "getEvents": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": { - "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" - }, - "projectedProperties": [ - { - "name": "Building", - "type": "String" - }, - { - "name": "Temperature", - "type": "Double" - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsPage2.json deleted file mode 100644 index 482e6a171bbf..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsPage2.json +++ /dev/null @@ -1,86 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", - "parameters": { - "getEvents": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": { - "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" - }, - "projectedProperties": [ - { - "name": "Building", - "type": "String" - }, - { - "name": "Temperature", - "type": "Double" - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:10Z", - "2016-08-01T00:00:11Z", - "2016-08-01T00:00:12Z", - "2016-08-01T00:00:13Z", - "2016-08-01T00:00:14Z", - "2016-08-01T00:00:15Z", - "2016-08-01T00:00:16Z", - "2016-08-01T00:00:17Z", - "2016-08-01T00:00:18Z", - "2016-08-01T00:00:19Z" - ], - "properties": [ - { - "name": "Building", - "type": "String", - "values": [ - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium" - ] - }, - { - "name": "Temperature", - "type": "Double", - "values": [ - 65.125, - 65.375, - 65.625, - 65.875, - 66.125, - 66.375, - 66.625, - 66.875, - 67.125, - 67.375 - ] - } - ], - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsPage3.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsPage3.json deleted file mode 100644 index 8a42d4e8087c..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsPage3.json +++ /dev/null @@ -1,59 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=", - "parameters": { - "getEvents": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": { - "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" - }, - "projectedProperties": [ - { - "name": "Building", - "type": "String" - }, - { - "name": "Temperature", - "type": "Double" - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:20Z" - ], - "properties": [ - { - "name": "Building", - "type": "String", - "values": [ - "Millenium" - ] - }, - { - "name": "Temperature", - "type": "Double", - "values": [ - 67.575 - ] - } - ], - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAbCDewidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsPage4.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsPage4.json deleted file mode 100644 index 1dc95e83faf2..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsPage4.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAbCDewidGFrZSI6MTAwMH0=", - "parameters": { - "getEvents": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": { - "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" - }, - "projectedProperties": [ - { - "name": "Building", - "type": "String" - }, - { - "name": "Temperature", - "type": "Double" - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [], - "properties": [], - "progress": 100.0 - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsWithTakePage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsWithTakePage1.json deleted file mode 100644 index 759c1a333a30..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsWithTakePage1.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "getEvents": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": { - "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" - }, - "projectedProperties": [ - { - "name": "Building", - "type": "String" - }, - { - "name": "Temperature", - "type": "Double" - } - ], - "take": 10 - } - } - }, - "responses": { - "200": { - "body": { - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsWithTakePage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsWithTakePage2.json deleted file mode 100644 index 0ffea83b8f92..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetEventsWithTakePage2.json +++ /dev/null @@ -1,86 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", - "parameters": { - "getEvents": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": { - "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" - }, - "projectedProperties": [ - { - "name": "Building", - "type": "String" - }, - { - "name": "Temperature", - "type": "Double" - } - ], - "take": 10 - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:10Z", - "2016-08-01T00:00:11Z", - "2016-08-01T00:00:12Z", - "2016-08-01T00:00:13Z", - "2016-08-01T00:00:14Z", - "2016-08-01T00:00:15Z", - "2016-08-01T00:00:16Z", - "2016-08-01T00:00:17Z", - "2016-08-01T00:00:18Z", - "2016-08-01T00:00:19Z" - ], - "properties": [ - { - "name": "Building", - "type": "String", - "values": [ - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium" - ] - }, - { - "name": "Temperature", - "type": "Double", - "values": [ - 65.125, - 65.375, - 65.625, - 65.875, - 66.125, - 66.375, - 66.625, - 66.875, - 67.125, - 67.375 - ] - } - ], - "progress": 100.0 - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesPage1.json deleted file mode 100644 index 768d28807304..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesPage1.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "getSeries": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": null, - "inlineVariables": { - "temperatures": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "avg($value)" - } - } - }, - "projectedVariables": [ - "temperatures" - ] - } - } - }, - "responses": { - "200": { - "body": { - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesPage2.json deleted file mode 100644 index d795bd8c745a..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesPage2.json +++ /dev/null @@ -1,75 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", - "parameters": { - "getSeries": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": null, - "inlineVariables": { - "temperatures": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "avg($value)" - } - } - }, - "projectedVariables": [ - "temperatures" - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:10Z", - "2016-08-01T00:00:11Z", - "2016-08-01T00:00:12Z", - "2016-08-01T00:00:13Z", - "2016-08-01T00:00:14Z", - "2016-08-01T00:00:15Z", - "2016-08-01T00:00:16Z", - "2016-08-01T00:00:17Z", - "2016-08-01T00:00:18Z", - "2016-08-01T00:00:19Z", - "2016-08-01T00:00:20Z" - ], - "properties": [ - { - "name": "temperatures", - "type": "Double", - "values": [ - 65.125, - 65.375, - 65.625, - 65.875, - 66.125, - 66.375, - 66.625, - 66.875, - 67.125, - 67.375, - 67.625 - ] - } - ], - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesPage3.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesPage3.json deleted file mode 100644 index a138be65021e..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesPage3.json +++ /dev/null @@ -1,54 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=", - "parameters": { - "getSeries": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": null, - "inlineVariables": { - "temperatures": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "avg($value)" - } - } - }, - "projectedVariables": [ - "temperatures" - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:21Z" - ], - "properties": [ - { - "name": "temperatures", - "type": "Double", - "values": [ - 67.825 - ] - } - ], - "progress": 100.0 - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesWithTakePage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesWithTakePage1.json deleted file mode 100644 index 380fd2ad94d3..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesWithTakePage1.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "getSeries": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": null, - "inlineVariables": { - "temperatures": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "avg($value)" - } - } - }, - "projectedVariables": [ - "temperatures" - ], - "take": 10 - } - } - }, - "responses": { - "200": { - "body": { - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesWithTakePage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesWithTakePage2.json deleted file mode 100644 index 881ca18e3ef6..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/QueryGetSeriesWithTakePage2.json +++ /dev/null @@ -1,75 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", - "parameters": { - "getSeries": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": null, - "inlineVariables": { - "temperatures": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "avg($value)" - } - } - }, - "projectedVariables": [ - "temperatures" - ], - "take": 10 - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:10Z", - "2016-08-01T00:00:11Z", - "2016-08-01T00:00:12Z", - "2016-08-01T00:00:13Z", - "2016-08-01T00:00:14Z", - "2016-08-01T00:00:15Z", - "2016-08-01T00:00:16Z", - "2016-08-01T00:00:17Z", - "2016-08-01T00:00:18Z", - "2016-08-01T00:00:19Z", - "2016-08-01T00:00:20Z" - ], - "properties": [ - { - "name": "temperatures", - "type": "Double", - "values": [ - 65.125, - 65.375, - 65.625, - 65.875, - 66.125, - 66.375, - 66.625, - 66.875, - 67.125, - 67.375, - 67.625 - ] - } - ], - "progress": 100.0 - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesDefault.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesDefault.json deleted file mode 100644 index a1e12a720c82..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesDefault.json +++ /dev/null @@ -1,48 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "searchString": "floor 100" - } - }, - "responses": { - "200": { - "body": { - "instances": { - "hits": [ - { - "timeSeriesId": [ - "Id1One", - "Id2One", - "1.0" - ], - "name": "instance1", - "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393", - "hierarchyIds": [ - "1643004c-0a84-48a5-80e5-7688c5ae9295" - ], - "highlights": null - }, - { - "timeSeriesId": [ - "Id1Two", - "Id2Two", - "2.0" - ], - "name": "instance2", - "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393", - "hierarchyIds": [ - "1643004c-0a84-48a5-80e5-7688c5ae9295" - ], - "highlights": null - } - ], - "hitCount": 2, - "continuationToken": null - }, - "hierarchyNodes": null - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesExpandHierarchiesOnly.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesExpandHierarchiesOnly.json deleted file mode 100644 index c2443f272c75..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesExpandHierarchiesOnly.json +++ /dev/null @@ -1,59 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "searchString": "floor 100", - "path": [ - "Location" - ], - "instances": null, - "hierarchies": { - "expand": { - "kind": "UntilChildren" - }, - "sort": { - "by": "Name" - }, - "pageSize": 2 - } - } - }, - "responses": { - "200": { - "body": { - "instances": { - "hits": [], - "hitCount": 0, - "continuationToken": null - }, - "hierarchyNodes": { - "hits": [ - { - "name": "California", - "cumulativeInstanceCount": 2, - "hierarchyNodes": { - "hits": [ - { - "name": "San Diego", - "cumulativeInstanceCount": 1, - "hierarchyNodes": null - }, - { - "name": "San Francisco", - "cumulativeInstanceCount": 1, - "hierarchyNodes": null - } - ], - "hitCount": 2, - "continuationToken": null - } - } - ], - "hitCount": 1, - "continuationToken": null - } - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesHierarchiesDefaultInputPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesHierarchiesDefaultInputPage1.json deleted file mode 100644 index a4053f07d4b6..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesHierarchiesDefaultInputPage1.json +++ /dev/null @@ -1,106 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "searchString": "floor 100", - "path": null, - "instances": { - "recursive": true, - "sort": { - "by": "Rank" - }, - "highlights": true, - "pageSize": 1 - }, - "hierarchies": { - "expand": { - "kind": "UntilChildren" - }, - "sort": { - "by": "CumulativeInstanceCount" - }, - "pageSize": 1 - } - } - }, - "responses": { - "200": { - "body": { - "instances": { - "hits": [ - { - "timeSeriesId": [ - "Id1Two", - "Id2Two", - "2.0" - ], - "name": "instance2", - "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393", - "hierarchyIds": [ - "1643004c-0a84-48a5-80e5-7688c5ae9295" - ], - "highlights": { - "timeSeriesId": [ - "Id1Two", - "Id2Two", - "2.0" - ], - "typeName": "DefaultType", - "name": "instance2", - "description": "floor 100", - "hierarchyIds": [ - "1643004c-0a84-48a5-80e5-7688c5ae9295" - ], - "hierarchyNames": [ - "Location" - ], - "instanceFieldNames": [ - "state", - "city" - ], - "instanceFieldValues": [ - "California", - "San Francisco" - ] - } - } - ], - "hitCount": 2, - "continuationToken": "c3sic2tpcCI6MiwidGFrZSI6MiwicmVxdWVzdEhhc2hDb2RlIjotNTE3MDUxOTg0LCJlbnZpcm9ubWVudElkIjoiYmY0M2YxMzMtM2Y2OC00ZWMwLWJjYjQtZmQ2NDUzMGU0MjU2In0=" - }, - "hierarchyNodes": { - "hits": [ - { - "name": "Location", - "cumulativeInstanceCount": 2, - "hierarchyNodes": { - "hits": [ - { - "name": "California", - "cumulativeInstanceCount": 2, - "hierarchyNodes": { - "hits": [ - { - "name": "San Francisco", - "cumulativeInstanceCount": 1, - "hierarchyNodes": null - } - ], - "hitCount": 2, - "continuationToken": "aHsic2tpcCI6MiwidGFrZSI6MiwicmVxdWVzdEhhc2hDb2RlIjotNzA4NTgyODU0LCJlbnZpcm9ubWVudElkIjoiYmY0M2YxMzMtM2Y2OC00ZWMwLWJjYjQtZmQ2NDUzMGU0MjU2In0=" - } - } - ], - "hitCount": 1, - "continuationToken": null - } - } - ], - "hitCount": 1, - "continuationToken": null - } - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesHierarchiesDefaultInputPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesHierarchiesDefaultInputPage2.json deleted file mode 100644 index 0557d31a3664..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesHierarchiesDefaultInputPage2.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "c3sic2tpcCI6MiwidGFrZSI6MiwicmVxdWVzdEhhc2hDb2RlIjotNTE3MDUxOTg0LCJlbnZpcm9ubWVudElkIjoiYmY0M2YxMzMtM2Y2OC00ZWMwLWJjYjQtZmQ2NDUzMGU0MjU2In0=", - "parameters": { - "searchString": "floor 100", - "path": null, - "instances": { - "recursive": true, - "sort": { - "by": "Rank" - }, - "highlights": true, - "pageSize": 1 - }, - "hierarchies": { - "expand": { - "kind": "UntilChildren" - }, - "sort": { - "by": "CumulativeInstanceCount" - }, - "pageSize": 1 - } - } - }, - "responses": { - "200": { - "body": { - "instances": { - "hits": [ - { - "timeSeriesId": [ - "Id1One", - "Id2One", - "1.0" - ], - "name": "instance1", - "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393", - "hierarchyIds": [ - "1643004c-0a84-48a5-80e5-7688c5ae9295" - ], - "highlights": { - "timeSeriesId": [ - "Id1One", - "Id2One", - "1.0" - ], - "typeName": "DefaultType", - "name": "instance1", - "description": "floor 100", - "hierarchyIds": [ - "1643004c-0a84-48a5-80e5-7688c5ae9295" - ], - "hierarchyNames": [ - "Location" - ], - "instanceFieldNames": [ - "state", - "city" - ], - "instanceFieldValues": [ - "California", - "Los Angeles" - ] - } - } - ], - "hitCount": 2, - "continuationToken": null - }, - "hierarchyNodes": null - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesHierarchiesDefaultInputPage3.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesHierarchiesDefaultInputPage3.json deleted file mode 100644 index f3aa7704c26c..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesHierarchiesDefaultInputPage3.json +++ /dev/null @@ -1,66 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aHsic2tpcCI6MiwidGFrZSI6MiwicmVxdWVzdEhhc2hDb2RlIjotNzA4NTgyODU0LCJlbnZpcm9ubWVudElkIjoiYmY0M2YxMzMtM2Y2OC00ZWMwLWJjYjQtZmQ2NDUzMGU0MjU2In0=", - "parameters": { - "searchString": "floor 100", - "path": null, - "instances": { - "recursive": true, - "sort": { - "by": "Rank" - }, - "highlights": true, - "pageSize": 1 - }, - "hierarchies": { - "expand": { - "kind": "UntilChildren" - }, - "sort": { - "by": "CumulativeInstanceCount" - }, - "pageSize": 1 - } - } - }, - "responses": { - "200": { - "body": { - "instances": null, - "hierarchyNodes": { - "hits": [ - { - "name": "Location", - "cumulativeInstanceCount": 2, - "hierarchyNodes": { - "hits": [ - { - "name": "California", - "cumulativeInstanceCount": 2, - "hierarchyNodes": { - "hits": [ - { - "name": "San Diego", - "cumulativeInstanceCount": 1, - "hierarchyNodes": null - } - ], - "hitCount": 2, - "continuationToken": "aHsic2tpcCI6MiwidGFrZSI6MiwicmVxdWVzdEhhc2hDb2RlIjotNzA4NTgyODU0LCJlbnZpcm9ubWVudElkIjoiYmY0M2YxMzMtM2Y2OC00ZWMwLWJjYjQtZmQ2NDUzMGU0MjU2In0=" - } - } - ], - "hitCount": 1, - "continuationToken": null - } - } - ], - "hitCount": 1, - "continuationToken": null - } - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesOneLevel.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesOneLevel.json deleted file mode 100644 index f59e6e7f858f..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesOneLevel.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "searchString": "floor 100", - "path": null, - "instances": { - "recursive": false, - "sort": { - "by": "DisplayName" - }, - "highlights": false, - "pageSize": 2 - }, - "hierarchies": { - "expand": { - "kind": "OneLevel" - }, - "sort": { - "by": "Name" - }, - "pageSize": 2 - } - } - }, - "responses": { - "200": { - "body": { - "instances": { - "hits": [], - "hitCount": 0, - "continuationToken": null - }, - "hierarchyNodes": { - "hits": [ - { - "name": "Location", - "cumulativeInstanceCount": 2, - "hierarchyNodes": null - } - ], - "hitCount": 1, - "continuationToken": null - } - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesRecursive.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesRecursive.json deleted file mode 100644 index 74732603fcbb..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesRecursive.json +++ /dev/null @@ -1,58 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "searchString": "floor 100", - "path": null, - "instances": { - "recursive": true, - "sort": { - "by": "DisplayName" - }, - "highlights": false, - "pageSize": 2 - }, - "hierarchies": null - } - }, - "responses": { - "200": { - "body": { - "instances": { - "hits": [ - { - "timeSeriesId": [ - "Id1One", - "Id2One", - "1.0" - ], - "name": "instance1", - "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393", - "hierarchyIds": [ - "1643004c-0a84-48a5-80e5-7688c5ae9295" - ], - "highlights": null - }, - { - "timeSeriesId": [ - "Id1Two", - "Id2Two", - "2.0" - ], - "name": "instance2", - "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393", - "hierarchyIds": [ - "1643004c-0a84-48a5-80e5-7688c5ae9295" - ], - "highlights": null - } - ], - "hitCount": 2, - "continuationToken": null - }, - "hierarchyNodes": null - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesUntilChildren.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesUntilChildren.json deleted file mode 100644 index 5f7b15f9c180..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/SearchInstancesUntilChildren.json +++ /dev/null @@ -1,66 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "searchString": "floor 100", - "path": [ - "Location" - ], - "instances": { - "recursive": false, - "sort": { - "by": "DisplayName" - }, - "highlights": false, - "pageSize": 2 - }, - "hierarchies": { - "expand": { - "kind": "UntilChildren" - }, - "sort": { - "by": "Name" - }, - "pageSize": 2 - } - } - }, - "responses": { - "200": { - "body": { - "instances": { - "hits": [], - "hitCount": 0, - "continuationToken": null - }, - "hierarchyNodes": { - "hits": [ - { - "name": "California", - "cumulativeInstanceCount": 2, - "hierarchyNodes": { - "hits": [ - { - "name": "San Diego", - "cumulativeInstanceCount": 1, - "hierarchyNodes": null - }, - { - "name": "San Francisco", - "cumulativeInstanceCount": 1, - "hierarchyNodes": null - } - ], - "hitCount": 2, - "continuationToken": null - } - } - ], - "hitCount": 1, - "continuationToken": null - } - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchDeleteByIds.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchDeleteByIds.json deleted file mode 100644 index 06cffe01e03d..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchDeleteByIds.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "delete": { - "typeIds": [ - "9250f816-faed-44c4-88e6-630e5eefa38b" - ] - } - } - }, - "responses": { - "200": { - "body": { - "delete": [ - null - ] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchDeleteByNames.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchDeleteByNames.json deleted file mode 100644 index 048590e0d8c2..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchDeleteByNames.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "delete": { - "names": [ - "TemperatureSensor" - ] - } - } - }, - "responses": { - "200": { - "body": { - "delete": [ - null - ] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchGetByIds.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchGetByIds.json deleted file mode 100644 index 79708427f893..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchGetByIds.json +++ /dev/null @@ -1,60 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "get": { - "typeIds": [ - "1be09af9-f089-4d6b-9f0b-48018b5f7393", - "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8" - ], - "names": null - } - } - }, - "responses": { - "200": { - "body": { - "get": [ - { - "timeSeriesType": { - "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393", - "name": "DefaultType", - "description": "Default type", - "variables": { - "EventCount": { - "kind": "aggregate", - "filter": null, - "aggregation": { - "tsx": "count()" - } - } - } - }, - "error": null - }, - { - "timeSeriesType": { - "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8", - "name": "TemperatureSensor", - "description": "This is a temperature sensor.", - "variables": { - "AverageTemperature": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature.Double" - }, - "filter": null, - "aggregation": { - "tsx": "avg($value)" - } - } - } - }, - "error": null - } - ] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchGetByNames.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchGetByNames.json deleted file mode 100644 index 09ba068d160b..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchGetByNames.json +++ /dev/null @@ -1,59 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "get": { - "names": [ - "DefaultType", - "TemperatureSensor" - ] - } - } - }, - "responses": { - "200": { - "body": { - "get": [ - { - "timeSeriesType": { - "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393", - "name": "DefaultType", - "description": "Default type", - "variables": { - "EventCount": { - "kind": "aggregate", - "filter": null, - "aggregation": { - "tsx": "count()" - } - } - } - }, - "error": null - }, - { - "timeSeriesType": { - "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8", - "name": "TemperatureSensor", - "description": "This is a temperature sensor.", - "variables": { - "AverageTemperature": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature.Double" - }, - "filter": null, - "aggregation": { - "tsx": "avg($value)" - } - } - } - }, - "error": null - } - ] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchPut.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchPut.json deleted file mode 100644 index cfce86fd80b8..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesBatchPut.json +++ /dev/null @@ -1,90 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "put": [ - { - "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393", - "name": "DefaultType", - "description": "My Default type", - "variables": { - "EventCount": { - "kind": "aggregate", - "filter": null, - "aggregation": { - "tsx": "count()" - } - } - } - }, - { - "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8", - "name": "OutdoorTemperatureSensor", - "description": "This is an outdoor temperature sensor.", - "variables": { - "AverageTemperature": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature.Double" - }, - "filter": { - "tsx": "$event.Mode.String = 'outdoor'" - }, - "aggregation": { - "tsx": "avg($value)" - } - } - } - } - ] - } - }, - "responses": { - "200": { - "body": { - "put": [ - { - "timeSeriesType": { - "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393", - "name": "DefaultType", - "description": "My Default type", - "variables": { - "EventCount": { - "kind": "aggregate", - "filter": null, - "aggregation": { - "tsx": "count()" - } - } - } - }, - "error": null - }, - { - "timeSeriesType": { - "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8", - "name": "OutdoorTemperatureSensor", - "description": "This is an outdoor temperature sensor.", - "variables": { - "AverageTemperature": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature.Double" - }, - "filter": { - "tsx": "$event.Mode.String = 'outdoor'" - }, - "aggregation": { - "tsx": "avg($value)" - } - } - } - }, - "error": null - } - ] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesGetPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesGetPage1.json deleted file mode 100644 index 204a4d9cca64..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesGetPage1.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com" - }, - "responses": { - "200": { - "body": { - "types": [ - { - "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393", - "name": "DefaultType", - "description": "My Default type", - "variables": { - "EventCount": { - "kind": "aggregate", - "filter": null, - "aggregation": { - "tsx": "count()" - } - } - } - } - ], - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesGetPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesGetPage2.json deleted file mode 100644 index dacfd9da4740..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesGetPage2.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" - }, - "responses": { - "200": { - "body": { - "types": [ - { - "id": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff", - "name": "TurbineSensor", - "description": "Wind turbine sensor", - "variables": { - "Value": { - "kind": "numeric", - "value": { - "tsx": "$event.value.Double" - }, - "aggregation": { - "tsx": "avg($value)" - } - } - } - } - ], - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrASI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesGetPage3.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesGetPage3.json deleted file mode 100644 index 65be4bc46f2a..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/TypesGetPage3.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrASI6MTAwMH0=" - }, - "responses": { - "200": { - "body": { - "types": [] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreAvailabilityGet.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreAvailabilityGet.json deleted file mode 100644 index fab7a099df2f..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreAvailabilityGet.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "warmstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "clientRequestId": "A72703F6-C0B1-49EF-854A-59F1994F54E7", - "clientSessionId": "AlertCalculation_W7" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "0d59d156-2807-4952-87bb-0e074417dbfb" - }, - "body": { - "availability": { - "intervalSize": "PT1H", - "distribution": { - "2019-03-27T04:00:00Z": 432447, - "2019-03-27T05:00:00Z": 432340, - "2019-03-27T06:00:00Z": 432451, - "2019-03-27T07:00:00Z": 432436, - "2019-03-26T13:00:00Z": 386247, - "2019-03-27T00:00:00Z": 436968, - "2019-03-27T01:00:00Z": 432509, - "2019-03-27T02:00:00Z": 432487 - }, - "range": { - "from": "2019-03-14T06:38:27.153Z", - "to": "2019-03-27T03:57:11.697Z" - } - } - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreEventSchemaGet.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreEventSchemaGet.json deleted file mode 100644 index 391a7637b12d..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreEventSchemaGet.json +++ /dev/null @@ -1,45 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "warmstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "searchSpan": { - "from": "2018-08-01T00:00:00.000Z", - "to": "2018-08-31T00:00:00.000Z" - } - } - }, - "responses": { - "200": { - "body": { - "properties": [ - { - "name": "Building", - "type": "String" - }, - { - "name": "Room", - "type": "String" - }, - { - "name": "DeviceId", - "type": "Double" - }, - { - "name": "Temperature", - "type": "Double" - }, - { - "name": "Pressure", - "type": "Double" - }, - { - "name": "Status", - "type": "String" - } - ] - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryAggregateSeriesPage.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryAggregateSeriesPage.json deleted file mode 100644 index 88518303ad1d..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryAggregateSeriesPage.json +++ /dev/null @@ -1,144 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "warmstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "aggregateSeries": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "interval": "PT1M", - "inlineVariables": { - "Count": { - "kind": "aggregate", - "filter": null, - "aggregation": { - "tsx": "count()" - } - }, - "MinTemperature": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "min($value)" - } - }, - "MaxTemperature": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "max($value)" - } - } - }, - "projectedVariables": [ - "Count", - "MinTemperature", - "MaxTemperature" - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:00Z", - "2016-08-01T00:01:00Z", - "2016-08-01T00:02:00Z", - "2016-08-01T00:03:00Z", - "2016-08-01T00:04:00Z", - "2016-08-01T00:05:00Z", - "2016-08-01T00:06:00Z", - "2016-08-01T00:07:00Z", - "2016-08-01T00:08:00Z", - "2016-08-01T00:09:00Z", - "2016-08-01T00:10:00Z" - ], - "properties": [ - { - "name": "Count", - "type": "Long", - "values": [ - 50, - 60, - 60, - 60, - 60, - 60, - 60, - 60, - 60, - 60, - null - ] - }, - { - "name": "AverageTemperature", - "type": "Double", - "values": [ - 71.25, - 85.0, - 82.5, - 80.0, - 89.166666666666671, - 75.0, - 90.0, - 75.833333333333329, - 85.0, - 82.5, - null - ] - }, - { - "name": "MinTemperature", - "type": "Double", - "values": [ - 65.125, - 77.625, - 65.125, - 72.625, - 65.125, - 67.625, - 82.625, - 65.125, - 77.625, - 65.125, - null - ] - }, - { - "name": "MaxTemperature", - "type": "Double", - "values": [ - 77.375, - 92.375, - 99.875, - 87.375, - 99.875, - 82.375, - 97.375, - 99.875, - 92.375, - 99.875, - null - ] - } - ], - "progress": 100.0 - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage1.json deleted file mode 100644 index b24cbf93f2a9..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage1.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "warmstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "getEvents": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": { - "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" - }, - "projectedProperties": [ - { - "name": "Building", - "type": "String" - }, - { - "name": "Temperature", - "type": "Double" - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage2.json deleted file mode 100644 index 4059db5e0882..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage2.json +++ /dev/null @@ -1,87 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "warmstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", - "parameters": { - "getEvents": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": { - "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" - }, - "projectedProperties": [ - { - "name": "Building", - "type": "String" - }, - { - "name": "Temperature", - "type": "Double" - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:10Z", - "2016-08-01T00:00:11Z", - "2016-08-01T00:00:12Z", - "2016-08-01T00:00:13Z", - "2016-08-01T00:00:14Z", - "2016-08-01T00:00:15Z", - "2016-08-01T00:00:16Z", - "2016-08-01T00:00:17Z", - "2016-08-01T00:00:18Z", - "2016-08-01T00:00:19Z" - ], - "properties": [ - { - "name": "Building", - "type": "String", - "values": [ - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium", - "Millenium" - ] - }, - { - "name": "Temperature", - "type": "Double", - "values": [ - 65.125, - 65.375, - 65.625, - 65.875, - 66.125, - 66.375, - 66.625, - 66.875, - 67.125, - 67.375 - ] - } - ], - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage3.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage3.json deleted file mode 100644 index 09c3e5be2929..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage3.json +++ /dev/null @@ -1,60 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "warmstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=", - "parameters": { - "getEvents": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": { - "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" - }, - "projectedProperties": [ - { - "name": "Building", - "type": "String" - }, - { - "name": "Temperature", - "type": "Double" - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:20Z" - ], - "properties": [ - { - "name": "Building", - "type": "String", - "values": [ - "Millenium" - ] - }, - { - "name": "Temperature", - "type": "Double", - "values": [ - 67.575 - ] - } - ], - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAbCDewidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage4.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage4.json deleted file mode 100644 index fc3e00c9c999..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage4.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "warmstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAbCDewidGFrZSI6MTAwMH0=", - "parameters": { - "getEvents": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": { - "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" - }, - "projectedProperties": [ - { - "name": "Building", - "type": "String" - }, - { - "name": "Temperature", - "type": "Double" - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [], - "properties": [], - "progress": 100.0 - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetSeriesPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetSeriesPage1.json deleted file mode 100644 index 5c719a880890..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetSeriesPage1.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "warmstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "parameters": { - "getSeries": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": null, - "inlineVariables": { - "temperatures": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "avg($value)" - } - } - }, - "projectedVariables": [ - "temperatures" - ] - } - } - }, - "responses": { - "200": { - "body": { - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetSeriesPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetSeriesPage2.json deleted file mode 100644 index 7f8c824cf022..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetSeriesPage2.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "warmstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", - "parameters": { - "getSeries": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": null, - "inlineVariables": { - "temperatures": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "avg($value)" - } - } - }, - "projectedVariables": [ - "temperatures" - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:10Z", - "2016-08-01T00:00:11Z", - "2016-08-01T00:00:12Z", - "2016-08-01T00:00:13Z", - "2016-08-01T00:00:14Z", - "2016-08-01T00:00:15Z", - "2016-08-01T00:00:16Z", - "2016-08-01T00:00:17Z", - "2016-08-01T00:00:18Z", - "2016-08-01T00:00:19Z", - "2016-08-01T00:00:20Z" - ], - "properties": [ - { - "name": "temperatures", - "type": "Double", - "values": [ - 65.125, - 65.375, - 65.625, - 65.875, - 66.125, - 66.375, - 66.625, - 66.875, - 67.125, - 67.375, - 67.625 - ] - } - ], - "progress": 50.0, - "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=" - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetSeriesPage3.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetSeriesPage3.json deleted file mode 100644 index fb0e7a620456..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/examples/WarmStoreQueryGetSeriesPage3.json +++ /dev/null @@ -1,55 +0,0 @@ -{ - "parameters": { - "api-version": "2018-11-01-preview", - "storeType": "warmstore", - "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", - "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=", - "parameters": { - "getSeries": { - "timeSeriesId": [ - "006dfc2d-0324-4937-998c-d16f3b4f1952", - "T1" - ], - "searchSpan": { - "from": "2016-08-01T00:00:00Z", - "to": "2016-08-01T00:16:50Z" - }, - "filter": null, - "inlineVariables": { - "temperatures": { - "kind": "numeric", - "value": { - "tsx": "$event.Temperature" - }, - "filter": null, - "aggregation": { - "tsx": "avg($value)" - } - } - }, - "projectedVariables": [ - "temperatures" - ] - } - } - }, - "responses": { - "200": { - "body": { - "timestamps": [ - "2016-08-01T00:00:21Z" - ], - "properties": [ - { - "name": "temperatures", - "type": "Double", - "values": [ - 67.825 - ] - } - ], - "progress": 100.0 - } - } - } -} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/timeseriesinsights.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/timeseriesinsights.json deleted file mode 100644 index 20fdbb673801..000000000000 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/timeseriesinsights.json +++ /dev/null @@ -1,2517 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "TimeSeriesInsightsClient", - "description": "Time Series Insights environment data plane client for Gen2 (Preview L1 SKU) environments.", - "version": "2018-11-01-preview" - }, - "x-ms-parameterized-host": { - "hostTemplate": "{environmentFqdn}", - "useSchemePrefix": true, - "positionInOperation": "first", - "parameters": [ - { - "$ref": "#/parameters/EnvironmentFqdn" - } - ] - }, - "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": { - "/availability": { - "get": { - "tags": [ - "Query" - ], - "operationId": "Query_GetAvailability", - "description": "Returns the time range and distribution of event count over the event timestamp ($ts). This API can be used to provide landing experience of navigating to the environment.", - "x-ms-examples": { - "AvailabilityGet": { - "$ref": "./examples/AvailabilityGet.json" - }, - "ColdStoreAvailabilityGet": { - "$ref": "./examples/ColdStoreAvailabilityGet.json" - }, - "WarmStoreAvailabilityGet": { - "$ref": "./examples/WarmStoreAvailabilityGet.json" - }, - "AvailabilityGetEmpty": { - "$ref": "./examples/AvailabilityGetEmpty.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/StoreType" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ClientSessionId" - } - ], - "responses": { - "200": { - "description": "Successful operation.", - "schema": { - "$ref": "#/definitions/AvailabilityResponse" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/TsiError" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - } - } - } - }, - "/eventSchema": { - "post": { - "tags": [ - "Query" - ], - "operationId": "Query_GetEventSchema", - "description": "Returns environment event schema for a given search span. Event schema is a set of property definitions. Event schema may not be contain all persisted properties when there are too many properties.", - "x-ms-examples": { - "EventSchemaGet": { - "$ref": "./examples/EventSchemaGet.json" - }, - "EventSchemaGetEmpty": { - "$ref": "./examples/EventSchemaGetEmpty.json" - }, - "ColdStoreEventSchemaGet": { - "$ref": "./examples/ColdStoreEventSchemaGet.json" - }, - "WarmStoreEventSchemaGet": { - "$ref": "./examples/WarmStoreEventSchemaGet.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/StoreType" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/GetEventSchemaRequest" - }, - "description": "Parameters to get event schema." - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ClientSessionId" - } - ], - "responses": { - "200": { - "description": "Successful operation.", - "schema": { - "$ref": "#/definitions/EventSchema" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/TsiError" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - } - } - } - }, - "/timeseries/modelSettings": { - "get": { - "tags": [ - "ModelSettings" - ], - "operationId": "ModelSettings_Get", - "description": "Returns the model settings which includes model display name, Time Series ID properties and default type ID. Every Gen2 environment has a model that is automatically created.", - "x-ms-examples": { - "ModelSettingsGet": { - "$ref": "./examples/ModelSettingsGet.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ClientSessionId" - } - ], - "responses": { - "200": { - "description": "Successful operation.", - "schema": { - "$ref": "#/definitions/ModelSettingsResponse" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/TsiError" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - } - } - }, - "patch": { - "tags": [ - "ModelSettings" - ], - "operationId": "ModelSettings_Update", - "description": "Updates time series model settings - either the model name or default type ID.", - "x-ms-examples": { - "ModelSettingsUpdateName": { - "$ref": "./examples/ModelSettingsUpdateName.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/UpdateModelSettingsRequest" - }, - "description": "Model settings update request body." - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ClientSessionId" - } - ], - "responses": { - "200": { - "description": "Successful operation returns new full model settings.", - "schema": { - "$ref": "#/definitions/ModelSettingsResponse" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/TsiError" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - } - } - } - }, - "/timeseries/query": { - "post": { - "tags": [ - "Query" - ], - "operationId": "Query_Execute", - "description": "Executes Time Series Query in pages of results - Get Events, Get Series or Aggregate Series.", - "x-ms-examples": { - "QueryAggregateSeriesPage1": { - "$ref": "./examples/QueryAggregateSeriesPage1.json" - }, - "QueryAggregateSeriesPage2": { - "$ref": "./examples/QueryAggregateSeriesPage2.json" - }, - "ColdStoreQueryAggregateSeriesPage1": { - "$ref": "./examples/ColdStoreQueryAggregateSeriesPage1.json" - }, - "ColdStoreQueryAggregateSeriesPage2": { - "$ref": "./examples/ColdStoreQueryAggregateSeriesPage2.json" - }, - "WarmStoreQueryAggregateSeriesPage": { - "$ref": "./examples/WarmStoreQueryAggregateSeriesPage.json" - }, - "QueryAggregateSeriesWithSampleInterpolation": { - "$ref": "./examples/QueryAggregateSeriesWithSampleInterpolation.json" - }, - "QueryAggregateSeriesWithCategoricalVariable": { - "$ref": "./examples/QueryAggregateSeriesWithCategoricalVariable.json" - }, - "QueryAggregateSeriesWithCategoricalInterpolatedVariable": { - "$ref": "./examples/QueryAggregateSeriesWithCategoricalInterpolatedVariable.json" - }, - "QueryGetEventsPage1": { - "$ref": "./examples/QueryGetEventsPage1.json" - }, - "QueryGetEventsPage2": { - "$ref": "./examples/QueryGetEventsPage2.json" - }, - "QueryGetEventsPage3": { - "$ref": "./examples/QueryGetEventsPage3.json" - }, - "QueryGetEventsPage4": { - "$ref": "./examples/QueryGetEventsPage4.json" - }, - "ColdStoreQueryGetEventsPage1": { - "$ref": "./examples/ColdStoreQueryGetEventsPage1.json" - }, - "ColdStoreQueryGetEventsPage2": { - "$ref": "./examples/ColdStoreQueryGetEventsPage2.json" - }, - "ColdStoreQueryGetEventsPage3": { - "$ref": "./examples/ColdStoreQueryGetEventsPage3.json" - }, - "ColdStoreQueryGetEventsPage4": { - "$ref": "./examples/ColdStoreQueryGetEventsPage4.json" - }, - "WarmStoreQueryGetEventsPage1": { - "$ref": "./examples/WarmStoreQueryGetEventsPage1.json" - }, - "WarmStoreQueryGetEventsPage2": { - "$ref": "./examples/WarmStoreQueryGetEventsPage2.json" - }, - "WarmStoreQueryGetEventsPage3": { - "$ref": "./examples/WarmStoreQueryGetEventsPage3.json" - }, - "WarmStoreQueryGetEventsPage4": { - "$ref": "./examples/WarmStoreQueryGetEventsPage4.json" - }, - "QueryGetEventsWithTakePage1": { - "$ref": "./examples/QueryGetEventsWithTakePage1.json" - }, - "QueryGetEventsWithTakePage2": { - "$ref": "./examples/QueryGetEventsWithTakePage2.json" - }, - "QueryGetSeriesPage1": { - "$ref": "./examples/QueryGetSeriesPage1.json" - }, - "QueryGetSeriesPage2": { - "$ref": "./examples/QueryGetSeriesPage2.json" - }, - "QueryGetSeriesPage3": { - "$ref": "./examples/QueryGetSeriesPage3.json" - }, - "QueryGetSeriesWithTakePage1": { - "$ref": "./examples/QueryGetSeriesWithTakePage1.json" - }, - "QueryGetSeriesWithTakePage2": { - "$ref": "./examples/QueryGetSeriesWithTakePage2.json" - }, - "ColdStoreQueryGetSeriesPage1": { - "$ref": "./examples/ColdStoreQueryGetSeriesPage1.json" - }, - "ColdStoreQueryGetSeriesPage2": { - "$ref": "./examples/ColdStoreQueryGetSeriesPage2.json" - }, - "ColdStoreQueryGetSeriesPage3": { - "$ref": "./examples/ColdStoreQueryGetSeriesPage3.json" - }, - "WarmStoreQueryGetSeriesPage1": { - "$ref": "./examples/WarmStoreQueryGetSeriesPage1.json" - }, - "WarmStoreQueryGetSeriesPage2": { - "$ref": "./examples/WarmStoreQueryGetSeriesPage2.json" - }, - "WarmStoreQueryGetSeriesPage3": { - "$ref": "./examples/WarmStoreQueryGetSeriesPage3.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/StoreType" - }, - { - "$ref": "#/parameters/ContinuationToken" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/QueryRequest" - }, - "description": "Time series query request body." - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ClientSessionId" - } - ], - "responses": { - "200": { - "description": "Successful query.", - "schema": { - "$ref": "#/definitions/QueryResultPage" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/TsiError" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - } - } - } - }, - "/timeseries/instances": { - "get": { - "tags": [ - "TimeSeriesInstances" - ], - "operationId": "TimeSeriesInstances_Get", - "description": "Gets time series instances in pages.", - "x-ms-examples": { - "InstancesGetPage1": { - "$ref": "./examples/InstancesGetPage1.json" - }, - "InstancesGetPage2": { - "$ref": "./examples/InstancesGetPage2.json" - }, - "InstancesGetPage3": { - "$ref": "./examples/InstancesGetPage3.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/ContinuationToken" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ClientSessionId" - } - ], - "responses": { - "200": { - "description": "Successful operation.", - "schema": { - "$ref": "#/definitions/GetInstancesPage" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/TsiError" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - } - } - } - }, - "/timeseries/instances/$batch": { - "post": { - "tags": [ - "TimeSeriesInstances" - ], - "operationId": "TimeSeriesInstances_ExecuteBatch", - "description": "Executes a batch get, create, update, delete operation on multiple time series instances.", - "x-ms-examples": { - "InstancesBatchDeleteByIds": { - "$ref": "./examples/InstancesBatchDeleteByIds.json" - }, - "InstancesBatchDeleteByNames": { - "$ref": "./examples/InstancesBatchDeleteByNames.json" - }, - "InstancesBatchGetByIds": { - "$ref": "./examples/InstancesBatchGetByIds.json" - }, - "InstancesBatchGetByNames": { - "$ref": "./examples/InstancesBatchGetByNames.json" - }, - "InstancesBatchUpdate": { - "$ref": "./examples/InstancesBatchUpdate.json" - }, - "InstancesBatchPut": { - "$ref": "./examples/InstancesBatchPut.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/InstancesBatchRequest" - }, - "description": "Time series instances suggest request body." - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ClientSessionId" - } - ], - "responses": { - "200": { - "description": "Successful operation.", - "schema": { - "$ref": "#/definitions/InstancesBatchResponse" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/TsiError" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - } - } - } - }, - "/timeseries/instances/suggest": { - "post": { - "tags": [ - "TimeSeriesInstances" - ], - "operationId": "TimeSeriesInstances_Suggest", - "description": "Suggests keywords based on time series instance attributes to be later used in Search Instances.", - "x-ms-examples": { - "InstancesSuggest": { - "$ref": "./examples/InstancesSuggest.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/InstancesSuggestRequest" - }, - "description": "Time series instances suggest request body." - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ClientSessionId" - } - ], - "responses": { - "200": { - "description": "Successful operation.", - "schema": { - "$ref": "#/definitions/InstancesSuggestResponse" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/TsiError" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - } - } - } - }, - "/timeseries/instances/search": { - "post": { - "tags": [ - "TimeSeriesInstances" - ], - "operationId": "TimeSeriesInstances_Search", - "description": "Partial list of hits on search for time series instances based on instance attributes.", - "x-ms-examples": { - "SearchInstancesHierarchiesDefaultInputPage1": { - "$ref": "./examples/SearchInstancesHierarchiesDefaultInputPage1.json" - }, - "SearchInstancesHierarchiesDefaultInputPage2": { - "$ref": "./examples/SearchInstancesHierarchiesDefaultInputPage2.json" - }, - "SearchInstancesHierarchiesDefaultInputPage3": { - "$ref": "./examples/SearchInstancesHierarchiesDefaultInputPage3.json" - }, - "SearchInstancesUntilChildren": { - "$ref": "./examples/SearchInstancesUntilChildren.json" - }, - "SearchInstancesDefault": { - "$ref": "./examples/SearchInstancesDefault.json" - }, - "SearchInstancesExpandHierarchiesOnly": { - "$ref": "./examples/SearchInstancesExpandHierarchiesOnly.json" - }, - "SearchInstancesRecursive": { - "$ref": "./examples/SearchInstancesRecursive.json" - }, - "SearchInstancesOneLevel": { - "$ref": "./examples/SearchInstancesOneLevel.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/ContinuationToken" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SearchInstancesRequest" - }, - "description": "Time series instances search request body." - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ClientSessionId" - } - ], - "responses": { - "200": { - "description": "Successful search response.", - "schema": { - "$ref": "#/definitions/SearchInstancesResponsePage" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/TsiError" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - } - } - } - }, - "/timeseries/types": { - "get": { - "tags": [ - "TimeSeriesTypes" - ], - "operationId": "TimeSeriesTypes_Get", - "description": "Gets time series types in pages.", - "x-ms-examples": { - "TypesGetPage1": { - "$ref": "./examples/TypesGetPage1.json" - }, - "TypesGetPage2": { - "$ref": "./examples/TypesGetPage2.json" - }, - "TypesGetPage3": { - "$ref": "./examples/TypesGetPage3.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/ContinuationToken" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ClientSessionId" - } - ], - "responses": { - "200": { - "description": "Successful operation.", - "schema": { - "$ref": "#/definitions/GetTypesPage" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/TsiError" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - } - } - } - }, - "/timeseries/types/$batch": { - "post": { - "tags": [ - "TimeSeriesTypes" - ], - "operationId": "TimeSeriesTypes_ExecuteBatch", - "description": "Executes a batch get, create, update, delete operation on multiple time series types.", - "x-ms-examples": { - "TypesBatchGetByIds": { - "$ref": "./examples/TypesBatchGetByIds.json" - }, - "TypesBatchGetByNames": { - "$ref": "./examples/TypesBatchGetByNames.json" - }, - "TypesBatchPut": { - "$ref": "./examples/TypesBatchPut.json" - }, - "TypesBatchDeleteByIds": { - "$ref": "./examples/TypesBatchDeleteByIds.json" - }, - "TypesBatchDeleteByNames": { - "$ref": "./examples/TypesBatchDeleteByNames.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/TypesBatchRequest" - }, - "description": "Time series types batch request body." - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ClientSessionId" - } - ], - "responses": { - "200": { - "description": "Successful operation.", - "schema": { - "$ref": "#/definitions/TypesBatchResponse" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/TsiError" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - } - } - } - }, - "/timeseries/hierarchies": { - "get": { - "tags": [ - "TimeSeriesHierarchies" - ], - "operationId": "TimeSeriesHierarchies_Get", - "description": "Returns time series hierarchies definitions in pages.", - "x-ms-examples": { - "HierarchiesGetPage1": { - "$ref": "./examples/HierarchiesGetPage1.json" - }, - "HierarchiesGetPage2": { - "$ref": "./examples/HierarchiesGetPage2.json" - }, - "HierarchiesGetPage3": { - "$ref": "./examples/HierarchiesGetPage3.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/ContinuationToken" - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ClientSessionId" - } - ], - "responses": { - "200": { - "description": "Successful operation.", - "schema": { - "$ref": "#/definitions/GetHierarchiesPage" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/TsiError" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - } - } - } - }, - "/timeseries/hierarchies/$batch": { - "post": { - "tags": [ - "TimeSeriesHierarchies" - ], - "operationId": "TimeSeriesHierarchies_ExecuteBatch", - "description": "Executes a batch get, create, update, delete operation on multiple time series hierarchy definitions.", - "x-ms-examples": { - "HierarchiesBatchGetByIds": { - "$ref": "./examples/HierarchiesBatchGetByIds.json" - }, - "HierarchiesBatchGetByNames": { - "$ref": "./examples/HierarchiesBatchGetByNames.json" - }, - "HierarchiesBatchPut": { - "$ref": "./examples/HierarchiesBatchPut.json" - }, - "HierarchiesBatchDeleteByIds": { - "$ref": "./examples/HierarchiesBatchDeleteByIds.json" - }, - "HierarchiesBatchDeleteByNames": { - "$ref": "./examples/HierarchiesBatchDeleteByNames.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/HierarchiesBatchRequest" - }, - "description": "Time series hierarchies batch request body." - }, - { - "$ref": "#/parameters/ClientRequestId" - }, - { - "$ref": "#/parameters/ClientSessionId" - } - ], - "responses": { - "200": { - "description": "Successful operation.", - "schema": { - "$ref": "#/definitions/HierarchiesBatchResponse" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/TsiError" - }, - "headers": { - "x-ms-request-id": { - "x-ms-client-name": "serverRequestId", - "type": "string", - "description": "Server-generated request ID. Can be used to contact support to investigate a request." - } - } - } - } - } - } - }, - "definitions": { - "AvailabilityResponse": { - "description": "Response of Get Availability operation. When environment has no data, availability property is null.", - "type": "object", - "properties": { - "availability": { - "description": "Event availability information when environment contains events. When environment has no data yet, this property is null or not present.", - "readOnly": true, - "$ref": "#/definitions/Availability" - } - } - }, - "Availability": { - "description": "Event availability information when environment contains events. Contains time range of events and approximate distribution of events over time.", - "type": "object", - "properties": { - "range": { - "description": "Minimum and maximum values of event timestamp ($ts) property.", - "$ref": "#/definitions/DateTimeRange", - "readOnly": true - }, - "intervalSize": { - "description": "Interval size for the returned distribution of the events. Returned interval is selected to return a reasonable number of points. All intervals are the same size. On the wire interval is specified in ISO-8601 duration format. One month is always converted to 30 days, and one year is always 365 days. Examples: 1 minute is \"PT1M\", 1 millisecond is \"PT0.001S\". For more information, see https://www.w3.org/TR/xmlschema-2/#duration", - "readOnly": true, - "type": "string", - "format": "duration" - }, - "distribution": { - "additionalProperties": { - "description": "Key value pair where key represents the interval denoted by the date time of the start of the interval and the value is the number of events in that interval.", - "readOnly": true, - "type": "integer", - "format": "int32" - } - } - } - }, - "GetEventSchemaRequest": { - "description": "Request to get the event schema of all events within a given search span.", - "type": "object", - "properties": { - "searchSpan": { - "description": "The range of time on which the query is executed. Cannot be null.", - "$ref": "#/definitions/DateTimeRange" - } - }, - "required": [ - "searchSpan" - ] - }, - "EventSchema": { - "description": "Event schema of all events within a given search span. Event schema is a set of property definitions. Properties are identified by both name and type. Different events can have properties with same name, but different type. Event schema may not be contain all persisted properties when there are too many properties.", - "type": "object", - "properties": { - "properties": { - "description": "A set of property definitions. When environment has no data, the returned array is empty.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/EventProperty" - } - } - } - }, - "QueryRequest": { - "type": "object", - "description": "Request to execute a time series query over events. Exactly one of \"getEvents\", \"getSeries\" or \"aggregateSeries\" must be set.", - "properties": { - "getEvents": { - "description": "Get Events query. Allows to retrieve raw events for a given Time Series ID and search span.", - "$ref": "#/definitions/GetEvents" - }, - "getSeries": { - "description": "Get Series query. Allows to retrieve time series of calculated variable values from events for a given Time Series ID and search span.", - "$ref": "#/definitions/GetSeries" - }, - "aggregateSeries": { - "description": "Aggregate Series query. Allows to calculate an aggregated time series from events for a given Time Series ID and search span.", - "$ref": "#/definitions/AggregateSeries" - } - } - }, - "GetEvents": { - "description": "Get Events query. Allows to retrieve raw events for a given Time Series ID and search span.", - "type": "object", - "properties": { - "timeSeriesId": { - "description": "A single Time Series ID value that uniquely identifies a single time series instance (e.g. a device). Note that a single Time Series ID can be composite if multiple properties are specified as Time Series ID at environment creation time. The position and type of values must match Time Series ID properties specified on the environment and returned by Get Model Setting API. Cannot be null.", - "$ref": "#/definitions/TimeSeriesId" - }, - "searchSpan": { - "description": "The range of time on which the query is executed. Cannot be null.", - "$ref": "#/definitions/DateTimeRange" - }, - "filter": { - "description": "Optional top-level filter for the query which will be applied to all the variables in the query. Example: \"$event.Status.String='Good'\". Can be null.", - "$ref": "#/definitions/Tsx" - }, - "projectedProperties": { - "description": "Projected properties is an array of properties which you want to project. These properties must appear in the events; otherwise, they are not returned.", - "type": "array", - "items": { - "$ref": "#/definitions/EventProperty" - } - }, - "take": { - "description": "Maximum number of property values in the whole response set, not the maximum number of property values per page. Defaults to 10,000 when not set. Maximum value of take can be 250,000.", - "type": "integer", - "format": "int32" - } - }, - "required": [ - "timeSeriesId", - "searchSpan" - ] - }, - "GetSeries": { - "description": "Get Series query. Allows to retrieve time series of calculated variable values from events for a given Time Series ID and search span.", - "type": "object", - "properties": { - "timeSeriesId": { - "description": "A single Time Series ID value that uniquely identifies a single time series instance (e.g. a device). Note that a single Time Series ID can be composite if multiple properties are specified as Time Series ID at environment creation time. The position and type of values must match Time Series ID properties specified on the environment and returned by Get Model Setting API. Cannot be null.", - "$ref": "#/definitions/TimeSeriesId" - }, - "searchSpan": { - "description": "The range of time on which the query is executed. Cannot be null.", - "$ref": "#/definitions/DateTimeRange" - }, - "filter": { - "description": "Top-level filter over the events that restricts the number of events being considered for computation. This filter is AND'ed with filter in each variable. Example: \"$event.Status.String='Good'\". Optional.", - "$ref": "#/definitions/Tsx" - }, - "projectedVariables": { - "description": "Selected variables that needs to be projected in the query result. When it is null or not set, all the variables from inlineVariables and time series type in the model are returned. Can be null.", - "type": "array", - "items": { - "type": "string" - } - }, - "inlineVariables": { - "description": "Optional inline variables apart from the ones already defined in the time series type in the model. When the inline variable name is the same name as in the model, the inline variable definition takes precedence. Can be null.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/Variable" - } - }, - "take": { - "description": "Maximum number of property values in the whole response set, not the maximum number of property values per page. Defaults to 10,000 when not set. Maximum value of take can be 250,000.", - "type": "integer", - "format": "int32" - } - }, - "required": [ - "timeSeriesId", - "searchSpan" - ] - }, - "AggregateSeries": { - "description": "Aggregate Series query. Allows to calculate an aggregated time series from events for a given Time Series ID and search span.", - "type": "object", - "properties": { - "timeSeriesId": { - "description": "A single Time Series ID value that uniquely identifies a single time series instance (e.g. a device). Note that a single Time Series ID can be composite if multiple properties are specified as Time Series ID at environment creation time. The position and type of values must match Time Series ID properties specified on the environment and returned by Get Model Setting API. Cannot be null.", - "$ref": "#/definitions/TimeSeriesId" - }, - "searchSpan": { - "description": "The range of time on which the query is executed. Cannot be null.", - "$ref": "#/definitions/DateTimeRange" - }, - "filter": { - "description": "Top-level filter over the events that restricts the number of events being considered for computation. This filter is AND'ed with filter in each variable. Example: \"$event.Status.String='Good'\". Optional.", - "$ref": "#/definitions/Tsx" - }, - "interval": { - "type": "string", - "format": "duration", - "description": "Interval size is specified in ISO-8601 duration format. All intervals are the same size. One month is always converted to 30 days, and one year is always 365 days. Examples: 1 minute is \"PT1M\", 1 millisecond is \"PT0.001S\". For more information, see https://www.w3.org/TR/xmlschema-2/#duration" - }, - "projectedVariables": { - "description": "This allows the user to optionally select the variables that needs to be projected. When it is null or not set, all the variables from inlineVariables and model are returned. Can be null.", - "type": "array", - "items": { - "type": "string" - } - }, - "inlineVariables": { - "description": "This allows the user the optionally define inline-variables apart from the ones already defined in the model. When the inline variable names have the same name as the model, the inline variable definition takes precedence. Can be null.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/Variable" - } - } - }, - "required": [ - "timeSeriesId", - "searchSpan", - "interval" - ] - }, - "TimeSeriesId": { - "description": "A single Time Series ID value that is an array of primitive values that uniquely identifies a time series instance (e.g. a single device). Note that a single Time Series ID can be composite if multiple properties are specified as Time Series ID at environment creation time. The position and type of values must match Time Series ID properties specified on the environment and returned by Get Model Setting API. Cannot be empty.", - "type": "array", - "items": { - "description": "A single Time Series ID value that is an array of primitive values that uniquely identifies a time series instance (e.g. a single device). Note that a single Time Series ID can be composite if multiple properties are specified as Time Series ID at environment creation time. The position and type of values must match Time Series ID properties specified on the environment and returned by Get Model Setting API. Cannot be empty." - }, - "minItems": 1 - }, - "Tsx": { - "description": "Time series expression (TSX) written as a single string. Examples: \"$event.Status.String='Good'\", \"avg($event.Temperature)\". Refer to the documentation on how to write time series expressions.", - "type": "object", - "properties": { - "tsx": { - "description": "Time series expression (TSX) written as a single string. Examples: \"$event.Status.String='Good'\", \"avg($event.Temperature)\". Refer to the documentation on how to write time series expressions.", - "type": "string" - } - }, - "required": [ - "tsx" - ] - }, - "Interpolation": { - "description": "The interpolation operation to be performed on the raw data points. Currently, only sampling of interpolated time series is allowed. Allowed aggregate function - eg: left($value). Can be null if no interpolation needs to be applied.", - "type": "object", - "properties": { - "kind": { - "description": "The type of interpolation technique : \"Linear\" or \"Step\".", - "type": "string", - "enum": [ - "Linear", - "Step" - ], - "x-ms-enum": { - "name": "InterpolationKind", - "modelAsString": true - } - }, - "boundary": { - "description": "The time range to the left and right of the search span to be used for Interpolation. This is helpful in scenarios where the data points are missing close to the start or end of the input search span. Can be null.", - "type": "object", - "properties": { - "span": { - "type": "string", - "format": "duration" - } - } - } - } - }, - "DateTimeRange": { - "description": "The range of time. Cannot be null or negative.", - "type": "object", - "properties": { - "from": { - "description": "Start timestamp of the time range. Start timestamp is inclusive when used in time series query requests. Events that have this timestamp are included.", - "type": "string", - "format": "date-time" - }, - "to": { - "description": "End timestamp of the time range. End timestamp is exclusive when used in time series query requests. Events that match this timestamp are excluded. Note that end timestamp is inclusive when returned by Get Availability (meaning that there is an event with this exact \"to\" timestamp).", - "type": "string", - "format": "date-time" - } - }, - "required": [ - "from", - "to" - ] - }, - "NumericVariable": { - "description": "Numeric variable represents a single continuous numeric signal that can be reconstructed using interpolation.", - "x-ms-discriminator-value": "numeric", - "allOf": [ - { - "$ref": "#/definitions/Variable" - }, - { - "type": "object", - "properties": { - "value": { - "description": "Value time series expression is used to represent the value of the signal that is going to be aggregated or interpolated. For example, temperature values from the event is represented like this: \"$event.Temperature.Double\".", - "$ref": "#/definitions/Tsx" - }, - "interpolation": { - "$ref": "#/definitions/Interpolation" - }, - "aggregation": { - "description": "Aggregation time series expression when kind is \"numeric\" is used to represent the aggregation that needs to be performed on the $value expression. This requires $value to be specified and can only use $value inside the aggregate functions. For example, aggregation for calculating minimum of the $value is written as: \"min($value)\".", - "$ref": "#/definitions/Tsx" - } - } - } - ], - "required": [ - "kind", - "value", - "aggregation" - ] - }, - "AggregateVariable": { - "description": "Aggregate variable represents any aggregation calculation. Aggregate Variables does not support interpolation.", - "x-ms-discriminator-value": "aggregate", - "allOf": [ - { - "$ref": "#/definitions/Variable" - }, - { - "type": "object", - "properties": { - "aggregation": { - "description": "Aggregation time series expression when kind is \"aggregate\" is used to represent the aggregation that needs to be performed directly using event properties like \"$event.Temperature\". For example, aggregation for calculating range of temperature changes can be written as: \"max($event.Temperature)-min($event.Temperature)\".", - "$ref": "#/definitions/Tsx" - } - } - } - ], - "required": [ - "kind", - "aggregation" - ] - }, - "CategoricalVariable": { - "description": "Categorical variable represents signal that needs to be analyzed based on the count or duration of occurrence of limited set of defined values.", - "x-ms-discriminator-value": "categorical", - "allOf": [ - { - "$ref": "#/definitions/Variable" - }, - { - "type": "object", - "properties": { - "value": { - "description": "Value time series expression is used to represent the value of the signal that is going to be categorized. It can evaluate to only 'String' or 'Long' type for categorical variables.", - "$ref": "#/definitions/Tsx" - }, - "interpolation": { - "description": "Categorical variable supports only 'step' interpolation.", - "$ref": "#/definitions/Interpolation" - }, - "categories": { - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesAggregateCategory" - } - }, - "defaultCategory": { - "$ref": "#/definitions/TimeSeriesDefaultCategory" - } - } - } - ], - "required": [ - "kind", - "value", - "defaultCategory" - ] - }, - "TimeSeriesAggregateCategory": { - "description": "Category used in categorical variables. A category is defined by 'label' and the 'values' that are assigned this label.", - "type": "object", - "properties": { - "label": { - "description": "The name of the category which will be used in constructing the output variable names.", - "type": "string" - }, - "values": { - "description": "The list of values that a category maps to. Can be either a unique list of string or list of long.", - "type": "array", - "items": { - "type": "object" - } - } - }, - "required": [ - "label", - "values" - ] - }, - "TimeSeriesDefaultCategory": { - "description": "Represents the default category.", - "type": "object", - "properties": { - "label": { - "description": "The name of the default category which will be assigned to the values that does not match any of those that are defined in the 'categories'.", - "type": "string" - } - }, - "required": [ - "label" - ] - }, - "Variable": { - "description": "Variables are named calculations over values from the events. Time Series Insights variable definitions contain formula and computation rules. Variables are stored in the type definition in Time Series Model and can be provided inline via Query APIs to override the stored definition.", - "type": "object", - "discriminator": "kind", - "properties": { - "kind": { - "description": "Allowed \"kind\" values are - \"numeric\" or \"aggregate\". While \"numeric\" allows you to specify value of the reconstructed signal and the expression to aggregate them, the \"aggregate\" kind lets you directly aggregate on the event properties without specifying value.", - "type": "string" - }, - "filter": { - "description": "Filter over the events that restricts the number of events being considered for computation. Example: \"$event.Status.String='Good'\". Optional.", - "$ref": "#/definitions/Tsx" - } - }, - "required": [ - "kind" - ] - }, - "QueryResultPage": { - "description": "A single page of query results. If query has not finished yet, a page will have continuation token set. In this case, to get the next page of results, send the same request again with continuation token parameter. If query has completed, the continuation token is null. It is also possible to get an empty page with only continuation token set when no query results have been computed yet. If paging has completed (continuation token is null), then timestamps and properties may be empty if there is no data to return.", - "allOf": [ - { - "$ref": "#/definitions/PagedResponse" - }, - { - "type": "object", - "properties": { - "timestamps": { - "description": "The timestamps of the values of the time series. If an aggregation over intervals is used, timestamps represent the start of corresponding intervals. If events are retrieved, timestamps are values of timestamp $ts property of events. Can be null if server was unable to fill the page in this request, or can be empty if there are no more objects when continuation token is null.", - "readOnly": true, - "type": "array", - "items": { - "type": "string", - "format": "date-time" - } - }, - "properties": { - "description": "Collection of time series properties and values for each of the timestamps. Can be null if server was unable to fill the page in this request, or can be empty if there are no more objects when continuation token is null.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/PropertyValues" - } - }, - "progress": { - "description": "Approximate progress of the query in percentage. It can be between 0 and 100. When the continuation token in the response is null, the progress is expected to be 100.", - "readOnly": true, - "type": "number", - "format": "double" - } - } - } - ] - }, - "PropertyValues": { - "description": "Values of a single property corresponding to the timestamps. May contain nulls. Type of values matches the type of property.", - "allOf": [ - { - "$ref": "#/definitions/EventProperty" - }, - { - "type": "object", - "properties": { - "values": { - "description": "Values of a single property corresponding to the timestamps. May contain nulls. Type of values matches the type of property.", - "type": "array", - "items": {} - } - } - } - ] - }, - "GetInstancesPage": { - "description": "Partial list of time series instances returned in a single request.", - "allOf": [ - { - "$ref": "#/definitions/PagedResponse" - }, - { - "type": "object", - "properties": { - "instances": { - "description": "Partial list of time series instances returned in a single request. Can be empty if server was unable to fill the page in this request, or there is no more objects when continuation token is null.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesInstance" - } - } - } - } - ] - }, - "TimeSeriesInstance": { - "description": "Time series instances are the time series themselves. In most cases, the deviceId or assetId is the unique identifier of the asset in the environment. Instances have descriptive information associated with them called instance fields. At a minimum, instance fields include hierarchy information. They can also include useful, descriptive data like the manufacturer, operator, or the last service date.", - "type": "object", - "properties": { - "timeSeriesId": { - "description": "Time Series ID that uniquely identifies the instance. It matches Time Series ID properties in an environment. Immutable, never null.", - "$ref": "#/definitions/TimeSeriesId" - }, - "typeId": { - "description": "This represents the type that this instance belongs to. Never null.", - "type": "string" - }, - "name": { - "description": "Optional name of the instance which is unique in an environment. Names acts as a mutable alias or display name of the time series instance. Mutable, may be null.", - "type": "string" - }, - "description": { - "description": "This optional field contains description about the instance.", - "type": "string" - }, - "hierarchyIds": { - "description": "Set of time series hierarchy IDs that the instance belong to. May be null.", - "type": "array", - "items": { - "type": "string" - } - }, - "instanceFields": { - "description": "Set of key-value pairs that contain user-defined instance properties. It may be null. Supported property value types are: bool, string, long, double and it cannot be nested or null.", - "type": "object", - "additionalProperties": {} - } - }, - "required": [ - "timeSeriesId", - "typeId" - ] - }, - "InstancesBatchRequest": { - "description": "Request to perform a single operation on a batch of instances. Exactly one of \"get\", \"put\", \"update\" or \"delete\" must be set.", - "type": "object", - "properties": { - "get": { - "description": "Time series IDs or names of time series instances to return.", - "$ref": "#/definitions/InstancesRequestBatchGetOrDelete" - }, - "put": { - "description": "Time series instances to be created or updated.", - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesInstance" - } - }, - "update": { - "description": "Time series instance to be updated. If instance does not exist, an error is returned.", - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesInstance" - } - }, - "delete": { - "description": "Time series instances to be deleted. Time series ID or name may be specified.", - "$ref": "#/definitions/InstancesRequestBatchGetOrDelete" - } - } - }, - "InstancesRequestBatchGetOrDelete": { - "description": "Request to get or delete instances by time series IDs or time series names. Exactly one of \"timeSeriesIds\" or \"names\" must be set.", - "type": "object", - "properties": { - "timeSeriesIds": { - "description": "List of time series IDs of the time series instances to return or delete.", - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesId" - } - }, - "names": { - "description": "List of names of the time series instances to return or delete.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "InstancesBatchResponse": { - "description": "Response of a single operation on a batch of instances. Only one of \"get\", \"put\", \"update\" or \"delete\" will be set based on the request.", - "type": "object", - "properties": { - "get": { - "description": "List of instance or error objects corresponding by position to the \"get\" array in the request. Instance object is set when operation is successful and error object is set when operation is unsuccessful.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/InstanceOrError" - } - }, - "put": { - "description": "List of error objects corresponding by position to the \"put\" array in the request. Error object is set when operation is unsuccessful.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/InstanceOrError" - } - }, - "update": { - "description": "List of error objects corresponding by position to the \"update\" array in the request. Instance object is set when operation is successful and error object is set when operation is unsuccessful.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/InstanceOrError" - } - }, - "delete": { - "description": "List of error objects corresponding by position to the \"delete\" array in the request. Null means the instance has been deleted, or did not exist. Error object is set when operation is unsuccessful (e.g. when there are events associated with this time series instance).", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/TsiErrorBody" - } - } - } - }, - "InstanceOrError": { - "description": "Result of a batch operation on a particular time series instance. Instance object is set when operation is successful (except put operation) and error object is set when operation is unsuccessful.", - "type": "object", - "properties": { - "instance": { - "description": "Time series instance object - set when the operation is successful (except put operation).", - "readOnly": true, - "$ref": "#/definitions/TimeSeriesInstance" - }, - "error": { - "description": "Error object - set when the operation is unsuccessful.", - "readOnly": true, - "$ref": "#/definitions/TsiErrorBody" - } - } - }, - "GetTypesPage": { - "description": "Partial list of time series types returned in a single request.", - "allOf": [ - { - "$ref": "#/definitions/PagedResponse" - }, - { - "type": "object", - "properties": { - "types": { - "description": "Partial list of time series types returned in a single request. Can be empty if server was unable to fill the page with more types in this request, or there is no more types when continuation token is null.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesType" - } - } - } - } - ] - }, - "TimeSeriesType": { - "description": "Time series type defines variables or formulas for doing computation on events associated with time series instances. Each time series instance is associated with exactly one type. A type can have one or more variables. For example, a time series instance might be of type Temperature Sensor, which consists of the variables avg temperature, min temperature, and max temperature.", - "type": "object", - "properties": { - "id": { - "description": "Case-sensitive unique type identifier that is immutable. Can be null on create or update requests, and then server generates the ID. Not null on get and delete operations.", - "type": "string" - }, - "name": { - "description": "User-given unique name for the type. Mutable, not null.", - "type": "string" - }, - "description": { - "description": "Description of the type. May be null.", - "type": "string" - }, - "variables": { - "description": "Different variables associated with the type. Not empty, not null.", - "additionalProperties": { - "$ref": "#/definitions/Variable" - } - } - }, - "required": [ - "name", - "variables" - ] - }, - "TypesBatchRequest": { - "description": "Request to perform a single operation on a batch of time series types. Exactly one of \"get\", \"put\" or \"delete\" must be set.", - "type": "object", - "properties": { - "get": { - "description": "Definition of what time series types to return.", - "$ref": "#/definitions/TypesRequestBatchGetOrDelete" - }, - "put": { - "description": "Definition of what time series types to update or create.", - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesType" - } - }, - "delete": { - "description": "Definition of what time series types to delete.", - "$ref": "#/definitions/TypesRequestBatchGetOrDelete" - } - } - }, - "TypesRequestBatchGetOrDelete": { - "description": "Request to get or delete time series types by IDs or type names. Exactly one of \"typeIds\" or \"names\" must be set.", - "type": "object", - "properties": { - "typeIds": { - "description": "List of IDs of time series types to return or delete.", - "type": "array", - "items": { - "type": "string" - } - }, - "names": { - "description": "List of names of time series types to return or delete.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "TypesBatchResponse": { - "description": "Response of a single operation on a batch of time series types. Exactly one of \"get\", \"put\" or \"delete\" will be set.", - "type": "object", - "properties": { - "get": { - "description": "List of types or error objects corresponding by position to the \"get\" array in the request. Type object is set when operation is successful and error object is set when operation is unsuccessful.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesTypeOrError" - } - }, - "put": { - "description": "List of types or error objects corresponding by position to the \"put\" array in the request. Type object is set when operation is successful and error object is set when operation is unsuccessful.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesTypeOrError" - } - }, - "delete": { - "description": "List of error objects corresponding by position to the \"delete\" array in the request - null when the operation is successful.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/TsiErrorBody" - } - } - } - }, - "TimeSeriesTypeOrError": { - "description": "Result of a batch operation on a particular time series type. Type object is set when operation is successful and error object is set when operation is unsuccessful.", - "type": "object", - "properties": { - "timeSeriesType": { - "description": "Time series type object - set when the operation is successful.", - "readOnly": true, - "$ref": "#/definitions/TimeSeriesType" - }, - "error": { - "description": "Error object - set when the operation is unsuccessful.", - "readOnly": true, - "$ref": "#/definitions/TsiErrorBody" - } - } - }, - "GetHierarchiesPage": { - "description": "Partial list of time series hierarchies returned in a single request.", - "allOf": [ - { - "$ref": "#/definitions/PagedResponse" - }, - { - "type": "object", - "properties": { - "hierarchies": { - "description": "Partial list of time series hierarchies returned in a single request. Can be empty if server was unable to fill the page in this request, or there is no more objects when continuation token is null.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesHierarchy" - } - } - } - } - ] - }, - "TimeSeriesHierarchy": { - "description": "Time series hierarchy organizes time series instances into a tree.", - "type": "object", - "properties": { - "id": { - "description": "Case-sensitive unique hierarchy identifier. Can be null while creating hierarchy objects and then server generates the id, not null on get and delete operations.", - "type": "string" - }, - "name": { - "description": "User-given unique name for the type. It is mutable and not null.", - "type": "string" - }, - "source": { - "description": "Definition of how time series hierarchy tree levels are created.", - "type": "object", - "properties": { - "instanceFieldNames": { - "description": "List of instance field names that must be set in all time series instances that belong to this hierarchy. The order of the instance fields defines the levels in the hierarchy.", - "type": "array", - "items": { - "type": "string" - } - } - } - } - }, - "required": [ - "name", - "source" - ] - }, - "HierarchiesBatchRequest": { - "description": "Request to perform a single operation on a batch of hierarchies. Exactly one of \"get\", \"put\" or \"delete\" must be set.", - "type": "object", - "properties": { - "get": { - "description": "\"get\" should be set while fetching specific hierarchies either by IDs or names.", - "$ref": "#/definitions/HierarchiesRequestBatchGetDelete" - }, - "put": { - "description": "\"put\" should be set while creating or updating hierarchies.", - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesHierarchy" - } - }, - "delete": { - "description": "\"delete\" should be set while fetching specific hierarchies either by IDs or names.", - "$ref": "#/definitions/HierarchiesRequestBatchGetDelete" - } - } - }, - "HierarchiesRequestBatchGetDelete": { - "description": "Request to get or delete multiple time series hierarchies. Exactly one of \"hierarchyIds\" or \"names\" must be set.", - "type": "object", - "properties": { - "hierarchyIds": { - "description": "List of hierarchy IDs.", - "type": "array", - "items": { - "type": "string" - } - }, - "names": { - "description": "List of hierarchy names.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "HierarchiesBatchResponse": { - "description": "Response of a single operation on a batch of time series hierarchies. Only one of \"get\", \"put\" or \"delete\" will be set.", - "type": "object", - "properties": { - "get": { - "description": "List of hierarchy or error objects corresponding by position to the \"get\" array in the request. Hierarchy object is set when operation is successful and error object is set when operation is unsuccessful.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesHierarchyOrError" - } - }, - "put": { - "description": "List of hierarchy or error object corresponding by position to the \"put\" array in the request. Hierarchy object is set when operation is successful and error object is set when operation is unsuccessful.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesHierarchyOrError" - } - }, - "delete": { - "description": "List of error objects corresponding by position to the \"delete\" array in the request - null when the operation is successful.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/TsiErrorBody" - } - } - } - }, - "TimeSeriesHierarchyOrError": { - "description": "Result of a batch operation on a particular time series hierarchy. Hierarchy is set when operation is successful and error object is set when operation is unsuccessful.", - "type": "object", - "properties": { - "hierarchy": { - "description": "Time series hierarchy object - set when the operation is successful.", - "readOnly": true, - "$ref": "#/definitions/TimeSeriesHierarchy" - }, - "error": { - "description": "Error object - set when the operation is unsuccessful.", - "readOnly": true, - "$ref": "#/definitions/TsiErrorBody" - } - } - }, - "ModelSettingsResponse": { - "description": "Response containing full time series model settings which include model name, Time Series ID properties and default type ID.", - "type": "object", - "properties": { - "modelSettings": { - "description": "Model settings including model name, Time Series ID properties and default type ID.", - "readOnly": true, - "$ref": "#/definitions/TimeSeriesModelSettings" - } - } - }, - "TimeSeriesModelSettings": { - "description": "Time series model settings including model name, Time Series ID properties and default type ID.", - "type": "object", - "properties": { - "name": { - "description": "Time series model display name which is shown in the UX. Examples: \"Temperature Sensors\", \"MyDevices\".", - "readOnly": true, - "type": "string" - }, - "timeSeriesIdProperties": { - "description": "Time series ID properties defined during environment creation.", - "readOnly": true, - "$ref": "#/definitions/TimeSeriesIdProperties" - }, - "defaultTypeId": { - "description": "Default type ID of the model that new time series instances will automatically belong to.", - "readOnly": true, - "type": "string" - } - } - }, - "TimeSeriesIdProperties": { - "description": "Time series ID properties defined during environment creation.", - "type": "array", - "items": { - "$ref": "#/definitions/TimeSeriesIdProperty" - }, - "minItems": 1 - }, - "TimeSeriesIdProperty": { - "description": "A definition of a single property that can be used in time series ID properties defined during environment creation.", - "type": "object", - "properties": { - "name": { - "description": "The name of the property.", - "readOnly": true, - "type": "string" - }, - "type": { - "description": "The type of the property. Currently, only \"String\" is supported.", - "readOnly": true, - "type": "string", - "enum": [ - "String" - ], - "x-ms-enum": { - "name": "TimeSeriesIdPropertyTypes", - "modelAsString": true - } - } - } - }, - "UpdateModelSettingsRequest": { - "description": "Request to update model settings. One of \"name\" or \"defaultTypeId\" must be set.", - "type": "object", - "properties": { - "name": { - "description": "Model display name which is shown in the UX and mutable by the user. Initial value is \"DefaultModel\".", - "type": "string" - }, - "defaultTypeId": { - "description": "Default type id of the model that new instances will automatically belong to.", - "type": "string" - } - } - }, - "SearchInstancesRequest": { - "description": "Request to execute a search query against time series instances and return matching time series instances.", - "type": "object", - "properties": { - "searchString": { - "description": "Query search string that will be matched to the attributes of time series instances. Example: \"floor 100\". Case-insensitive, must be present, but can be empty string.", - "type": "string" - }, - "path": { - "description": "Filter on hierarchy path of time series instances. Path is represented as array of string path segments. First element should be hierarchy name. Example: [\"Location\", \"California\"]. Optional, case sensitive, never empty and can be null.", - "type": "array", - "items": { - "type": "string" - } - }, - "instances": { - "description": "Parameters of how to return time series instances. Can be null. When both the instances and hierarchies parameters are null, the instances are returned in the results based on the default values of parameters, and hierarchies are not returned.", - "type": "object", - "$ref": "#/definitions/SearchInstancesParameters" - }, - "hierarchies": { - "description": "Parameters of how to return time series instance hierarchies. If null, hierarchies are not returned. If instances parameter is null and hierarchies parameter is not null, only hierarchies with no instances are returned.", - "type": "object", - "$ref": "#/definitions/SearchInstancesHierarchiesParameters" - } - }, - "required": [ - "searchString" - ] - }, - "SearchInstancesParameters": { - "description": "Parameters of how to return time series instances by search instances call.", - "type": "object", - "properties": { - "recursive": { - "description": "Definition of which instances are returned. When recursive is set to 'true', all instances that have the path that starts with path the path parameter are returned. When recursive is set to 'false', only instances that have the path that exactly matches the path parameter are returned. Using recursive search allows to implement search user experience, while using non-recursive search allows to implement navigation experience. Optional, default is 'true'.", - "type": "boolean" - }, - "sort": { - "description": "Definition of how time series instances are sorted before being returned by search instances call - relevance or alphabetical. Optional, default is \"Rank\".", - "type": "object", - "$ref": "#/definitions/InstancesSortParameter" - }, - "highlights": { - "description": "Definition of highlighted search results or not. When it is set to 'true', the highlighted search results are returned. When it is set to 'false', the highlighted search results are not returned. Default is 'true'.", - "type": "boolean" - }, - "pageSize": { - "description": "Maximum number of instances expected in each page of the result. Defaults to 10 when not set. Ranges from 1 to 100. If there are results beyond the page size, the user can use the continuation token to fetch the next page.", - "type": "integer", - "format": "int32" - } - } - }, - "InstancesSortParameter": { - "description": "Definition of how time series instances are sorted before being returned by search instances call.", - "type": "object", - "properties": { - "by": { - "description": "Value to use for sorting of the time series instances before being returned by search instances call. When it is set to 'Rank', the returned instances are sorted based on the relevance. When it is set to 'DisplayName', the returned results are sorted based on the display name. Display name is the name of the instance if it exists, otherwise, display name is the time series ID. Default is 'Rank'.", - "type": "string", - "enum": [ - "Rank", - "DisplayName" - ], - "x-ms-enum": { - "name": "InstancesSortBy", - "modelAsString": true - } - } - } - }, - "SearchInstancesHierarchiesParameters": { - "description": "Parameter of how to return time series instance hierarchies by search instances call.", - "type": "object", - "properties": { - "expand": { - "description": "Definition of whether to expand hierarchy nodes in the same search instances call. Optional, default is 'UntilChildren'.", - "type": "object", - "$ref": "#/definitions/HierarchiesExpandParameter" - }, - "sort": { - "description": "Definition of sorting of hierarchy nodes. Optional, default is 'CumulativeInstanceCount'.", - "type": "object", - "$ref": "#/definitions/HierarchiesSortParameter" - }, - "pageSize": { - "description": "Maximum number of hierarchies in the same level to return in the same page. Optional, default is 10 when not set. Range is from 1 to 100. If there are results beyond the page size, the continuation token can be used to fetch the next page.", - "type": "integer", - "format": "int32" - } - } - }, - "HierarchiesExpandParameter": { - "description": "Definition of whether to expand hierarchy nodes in the same search instances call.", - "type": "object", - "properties": { - "kind": { - "description": "Kind of the expansion of hierarchy nodes. When it is set to 'UntilChildren', the hierarchy nodes are expanded recursively until there is more than one child. When it is set to 'OneLevel', the hierarchies are expanded only at the single level matching path search instances parameter. Optional, default is 'UntilChildren'.", - "type": "string", - "enum": [ - "UntilChildren", - "OneLevel" - ], - "x-ms-enum": { - "name": "HierarchiesExpandKind", - "modelAsString": true - } - } - } - }, - "HierarchiesSortParameter": { - "description": "Definition of sorting of hierarchy nodes.", - "type": "object", - "properties": { - "by": { - "description": "Value to use for hierarchy node sorting. When it is set to 'CumulativeInstanceCount', the returned hierarchies are sorted based on the total instances belonging to the hierarchy node and its child hierarchy nodes. When it is set to 'Name', the returned hierarchies are sorted based on the hierarchy name. Optional, default is 'CumulativeInstanceCount'.", - "type": "string", - "enum": [ - "CumulativeInstanceCount", - "Name" - ], - "x-ms-enum": { - "name": "HierarchiesSortBy", - "modelAsString": true - } - } - } - }, - "SearchInstancesResponsePage": { - "description": "Single page of the search results.", - "type": "object", - "properties": { - "instances": { - "description": "The instances matching the query based on the input. May be empty or null.", - "readOnly": true, - "type": "object", - "$ref": "#/definitions/SearchInstancesResponse" - }, - "hierarchyNodes": { - "description": "The hierarchy nodes which contains the instances matching the query based on the input. May be empty or null.", - "readOnly": true, - "type": "object", - "$ref": "#/definitions/SearchHierarchyNodesResponse" - } - } - }, - "SearchInstancesResponse": { - "description": "The instances matching the query based on the input. May be empty or null.", - "type": "object", - "properties": { - "hits": { - "description": "The list of instances matching the query based on the input. May be empty.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/InstanceHit" - } - }, - "hitCount": { - "description": "Total number of instances matching the query based on the input.", - "readOnly": true, - "type": "integer", - "format": "int32" - }, - "continuationToken": { - "description": "If returned, this means that current results represent a partial result. Continuation token allows to get the next page of results. To get the next page of query results, send the same request with continuation token parameter in \"x-ms-continuation\" HTTP header.", - "readOnly": true, - "type": "string" - } - } - }, - "SearchHierarchyNodesResponse": { - "description": "The hierarchy nodes which contains the instances matching the query based on the input. May be empty or null.", - "type": "object", - "properties": { - "hits": { - "description": "The list of hierarchy nodes which contains the instances matching the query based on the input. May be empty.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/HierarchyHit" - } - }, - "hitCount": { - "description": "Total number of hierarchy nodes which contains the instances matching the query based on the input.", - "readOnly": true, - "type": "integer", - "format": "int32" - }, - "continuationToken": { - "description": "If returned, this means that current results represent a partial result. Continuation token allows to get the next page of results. To get the next page of query results, send the same request with continuation token parameter in \"x-ms-continuation\" HTTP header.", - "readOnly": true, - "type": "string" - } - } - }, - "InstanceHit": { - "description": "Time series instance that is returned by instances search call. Returned instance matched the search request and contains highlighted text to be displayed to the user if it is set to 'true'.", - "type": "object", - "properties": { - "timeSeriesId": { - "description": "Time series ID of the time series instance that matched the search request.", - "readOnly": true, - "type": "array", - "$ref": "#/definitions/TimeSeriesId" - }, - "name": { - "description": "Name of the time series instance that matched the search request. May be null.", - "readOnly": true, - "type": "string" - }, - "typeId": { - "description": "Represents the type that time series instance which matched the search request belongs to. Never null.", - "readOnly": true, - "type": "string" - }, - "hierarchyIds": { - "description": "List of time series hierarchy IDs that time series instance which matched the search request belongs to. Cannot be used to lookup hierarchies. May be null.", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } - }, - "highlights": { - "description": "Highlighted text of time series instance to be displayed to the user. Highlighting inserts and tags in the portions of text that matched the search string. Do not use any of the highlighted properties to do further API calls.", - "readOnly": true, - "type": "object", - "properties": { - "timeSeriesId": { - "description": "List of highlighted string values of Time Series ID for displaying. Cannot be used to lookup instance.", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } - }, - "typeName": { - "description": "Highlighted time series type name that this instance belongs to.", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "Highlighted name of time series instance. May be null.", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "Highlighted description of time series instance. May be null.", - "readOnly": true, - "type": "string" - }, - "hierarchyIds": { - "description": "List of highlighted time series hierarchy IDs that time series instance belongs to. Cannot be used to lookup hierarchies. May be null.", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } - }, - "hierarchyNames": { - "description": "List of highlighted time series hierarchy names that time series instance belongs to. Cannot be used to lookup hierarchies. May be null.", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } - }, - "instanceFieldNames": { - "description": "List of highlighted time series instance field names. May be null.", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } - }, - "instanceFieldValues": { - "description": "List of highlighted time series instance field values. May be null.", - "readOnly": true, - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - }, - "HierarchyHit": { - "description": "The hierarchy node which contains the instances matching the query based on the input. May be empty or null.", - "type": "object", - "properties": { - "name": { - "description": "Name of the hierarchy node. May be empty, cannot be null.", - "readOnly": true, - "type": "string" - }, - "cumulativeInstanceCount": { - "description": "Total number of instances that belong to this node and it's subtrees matching the query.", - "readOnly": true, - "type": "integer", - "format": "int32" - }, - "hierarchyNodes": { - "description": "Child hierarchy nodes of this node. May be empty or null.", - "readOnly": true, - "type": "object", - "$ref": "#/definitions/SearchHierarchyNodesResponse" - } - } - }, - "InstancesSuggestRequest": { - "description": "Request to get search string suggestions for time series instances search based on prefix text.", - "type": "object", - "properties": { - "searchString": { - "description": "Search string for which suggestions are required. Empty is allowed, but not null.", - "type": "string" - }, - "take": { - "description": "Maximum number of suggestions expected in the result. Defaults to 10 when not set.", - "type": "integer", - "format": "int32" - } - }, - "required": [ - "searchString" - ] - }, - "InstancesSuggestResponse": { - "description": "Response of getting suggestions for search for time series instances.", - "type": "object", - "properties": { - "suggestions": { - "description": "List of instance suggestions for searching time series models.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/InstancesSearchStringSuggestion" - } - } - } - }, - "InstancesSearchStringSuggestion": { - "description": "Suggested search string to be used for further search for time series instances.", - "type": "object", - "properties": { - "searchString": { - "description": "Suggested search string. Can be used for further search for time series instances.", - "readOnly": true, - "type": "string" - }, - "highlightedSearchString": { - "description": "Highlighted suggested search string to be displayed to the user. Highlighting inserts and tags in the portions of text that matched the search string. Do not use highlighted search string to do further search calls.", - "readOnly": true, - "type": "string" - } - } - }, - "PagedResponse": { - "description": "Partial result that has continuation token to fetch the next partial result.", - "type": "object", - "properties": { - "continuationToken": { - "description": "If returned, this means that current results represent a partial result. Continuation token allows to get the next page of results. To get the next page of query results, send the same request with continuation token parameter in \"x-ms-continuation\" HTTP header.", - "readOnly": true, - "type": "string" - } - } - }, - "EventProperty": { - "description": "Property of an event that is either stored or computed. Properties are identified by both name and type. Different events can have properties with same name, but different type.", - "type": "object", - "properties": { - "name": { - "description": "The name of the property.", - "type": "string" - }, - "type": { - "description": "The type of the property.", - "$ref": "#/definitions/PropertyType" - } - } - }, - "PropertyType": { - "description": "The type of the property that is either stored in events or computed by a calculation.", - "type": "string", - "enum": [ - "Bool", - "DateTime", - "Double", - "String", - "TimeSpan", - "Long" - ], - "x-ms-enum": { - "name": "PropertyTypes", - "modelAsString": true - } - }, - "TsiError": { - "description": "Information about an API error.", - "type": "object", - "properties": { - "error": { - "$ref": "#/definitions/TsiErrorBody" - } - }, - "x-ms-external": false - }, - "TsiErrorBody": { - "description": "A particular API error with an error code and a message.", - "type": "object", - "properties": { - "code": { - "description": "Language-independent, human-readable string that defines a service-specific error code. This code serves as a more specific indicator for the HTTP error code specified in the response. Can be used to programmatically handle specific error cases.", - "readOnly": true, - "type": "string" - }, - "message": { - "description": "Human-readable, language-independent representation of the error. It is intended as an aid to developers and is not suitable for exposure to end users.", - "readOnly": true, - "type": "string" - }, - "target": { - "description": "Target of the particular error (for example, the name of the property in error). May be null.", - "readOnly": true, - "type": "string" - }, - "innerError": { - "description": "Contains more specific error that narrows down the cause. May be null.", - "readOnly": true, - "$ref": "#/definitions/TsiErrorBody" - }, - "details": { - "description": "Contains additional error information. May be null.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/TsiErrorDetails" - } - } - }, - "additionalProperties": true, - "x-ms-external": false - }, - "TsiErrorDetails": { - "description": "Additional error information.", - "type": "object", - "properties": { - "code": { - "description": "Language-independent, human-readable string that defines a service-specific error code. This code serves as a more specific indicator for the HTTP error code specified in the response. Can be used to programmatically handle specific error cases.", - "readOnly": true, - "type": "string" - }, - "message": { - "description": "Human-readable, language-independent representation of the error. It is intended as an aid to developers and is not suitable for exposure to end users.", - "readOnly": true, - "type": "string" - } - }, - "additionalProperties": true, - "x-ms-external": false - } - }, - "parameters": { - "ApiVersion": { - "name": "api-version", - "in": "query", - "required": true, - "default": "2018-11-01-preview", - "type": "string", - "description": "Version of the API to be used with the client request. Currently supported version is \"2018-11-01-preview\"." - }, - "StoreType": { - "name": "storeType", - "in": "query", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "description": "For the environments with warm store enabled, the query can be executed either on the 'WarmStore' or 'ColdStore'. This parameter in the query defines which store the query should be executed on. If not defined, the query will be executed on the cold store." - }, - "EnvironmentFqdn": { - "name": "environmentFqdn", - "in": "path", - "required": true, - "type": "string", - "x-ms-skip-url-encoding": true, - "x-ms-parameter-location": "client", - "description": "Per environment FQDN, for example 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. You can obtain this domain name from the response of the Get Environments API, Azure portal, or Azure Resource Manager." - }, - "ContinuationToken": { - "name": "x-ms-continuation", - "x-ms-client-name": "continuationToken", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "description": "Continuation token from previous page of results to retrieve the next page of the results in calls that support pagination. To get the first page results, specify null continuation token as parameter value. Returned continuation token is null if all results have been returned, and there is no next page of results." - }, - "ClientRequestId": { - "name": "x-ms-client-request-id", - "x-ms-client-name": "clientRequestId", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "description": "Optional client request ID. Service records this value. Allows the service to trace operation across services, and allows the customer to contact support regarding a particular request." - }, - "ClientSessionId": { - "name": "x-ms-client-session-id", - "x-ms-client-name": "clientSessionId", - "in": "header", - "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "description": "Optional client session ID. Service records this value. Allows the service to trace a group of related operations across services, and allows the customer to contact support regarding a particular group of requests." - } - } -} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/AccessPoliciesCreate.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/AccessPoliciesCreate.json new file mode 100644 index 000000000000..c172c69e2f82 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/AccessPoliciesCreate.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "accessPolicyName": "ap1", + "parameters": { + "properties": { + "principalObjectId": "aGuid", + "roles": [ + "Reader" + ], + "description": "some description" + } + }, + "api-version": "2021-06-30-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/accessPolicies/ap1", + "name": "ap1", + "type": "Microsoft.TimeSeriesInsights/Environments/AccessPolicies", + "properties": { + "principalObjectId": "aGuid", + "roles": [ + "Reader" + ], + "description": "some description" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/accessPolicies/ap1", + "name": "ap1", + "type": "Microsoft.TimeSeriesInsights/Environments/AccessPolicies", + "properties": { + "principalObjectId": "aGuid", + "roles": [ + "Reader" + ], + "description": "some description" + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/AccessPoliciesDelete.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/AccessPoliciesDelete.json new file mode 100644 index 000000000000..7a2e7f51dbae --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/AccessPoliciesDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "accessPolicyName": "ap1", + "api-version": "2021-06-30-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/AccessPoliciesGet.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/AccessPoliciesGet.json new file mode 100644 index 000000000000..6b56ec2e670d --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/AccessPoliciesGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "accessPolicyName": "ap1", + "api-version": "2021-06-30-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/accessPolicies/ap1", + "name": "ap1", + "type": "Microsoft.TimeSeriesInsights/Environments/AccessPolicies", + "properties": { + "principalObjectId": "aGuid", + "roles": [ + "Reader" + ], + "description": "some description" + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/AccessPoliciesListByEnvironment.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/AccessPoliciesListByEnvironment.json new file mode 100644 index 000000000000..a061c70fc8ff --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/AccessPoliciesListByEnvironment.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "api-version": "2021-06-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/accessPolicies/ap1", + "name": "ap1", + "type": "Microsoft.TimeSeriesInsights/Environments/AccessPolicies", + "properties": { + "principalObjectId": "aGuid", + "roles": [ + "Reader" + ], + "description": "some description" + } + } + ] + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/AccessPoliciesPatchRoles.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/AccessPoliciesPatchRoles.json new file mode 100644 index 000000000000..9a8227ceb369 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/AccessPoliciesPatchRoles.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "accessPolicyName": "ap1", + "accessPolicyUpdateParameters": { + "properties": { + "roles": [ + "Reader", + "Contributor" + ] + } + }, + "api-version": "2021-06-30-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/accessPolicies/ap1", + "name": "ap1", + "type": "Microsoft.TimeSeriesInsights/Environments/AccessPolicies", + "properties": { + "principalObjectId": "aGuid", + "roles": [ + "Reader" + ], + "description": "some description" + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EnvironmentsCreate.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EnvironmentsCreate.json new file mode 100644 index 000000000000..64f01c8eefc9 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EnvironmentsCreate.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "parameters": { + "location": "West US", + "kind": "Gen1", + "sku": { + "name": "S1", + "capacity": 1 + }, + "properties": { + "dataRetentionTime": "P31D", + "partitionKeyProperties": [ + { + "name": "DeviceId1", + "type": "String" + } + ] + } + }, + "api-version": "2021-06-30-preview" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1", + "location": "West US", + "name": "env1", + "type": "Microsoft.TimeSeriesInsights/Environments", + "kind": "Gen1", + "tags": {}, + "properties": { + "dataRetentionTime": "P31D", + "provisioningState": "Creating", + "creationTime": "2017-04-18T19:20:33.2288820Z" + }, + "sku": { + "name": "S1", + "capacity": 1 + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1", + "location": "West US", + "name": "env1", + "type": "Microsoft.TimeSeriesInsights/Environments", + "kind": "Gen1", + "tags": {}, + "properties": { + "supportsCustomerManagedKey": true, + "dataRetentionTime": "P31D", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + }, + "sku": { + "name": "S1", + "capacity": 1 + } + } + }, + "404": {} + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EnvironmentsDelete.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EnvironmentsDelete.json new file mode 100644 index 000000000000..18db6cf65fb9 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EnvironmentsDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "api-version": "2021-06-30-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EnvironmentsGet.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EnvironmentsGet.json new file mode 100644 index 000000000000..b1c6b924da7b --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EnvironmentsGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "subid", + "environmentName": "env1", + "resourceGroupName": "rg1", + "api-version": "2021-06-30-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1", + "location": "West US", + "name": "env1", + "type": "Microsoft.TimeSeriesInsights/Environments", + "kind": "Gen1", + "tags": {}, + "properties": { + "dataRetentionTime": "P31D", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z", + "partitionKeyProperties": [ + { + "name": "DeviceId1", + "type": "String" + } + ], + "supportsCustomerManagedKey": true + }, + "sku": { + "name": "S1", + "capacity": 1 + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EnvironmentsListByResourceGroup.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EnvironmentsListByResourceGroup.json new file mode 100644 index 000000000000..d0d992bd5069 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EnvironmentsListByResourceGroup.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "api-version": "2021-06-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1", + "location": "West US", + "name": "env1", + "type": "Microsoft.TimeSeriesInsights/Environments", + "kind": "Gen1", + "tags": {}, + "properties": { + "dataRetentionTime": "P31D", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z", + "supportsCustomerManagedKey": true + }, + "sku": { + "name": "S1", + "capacity": 1 + } + } + ] + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EnvironmentsListBySubscription.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EnvironmentsListBySubscription.json new file mode 100644 index 000000000000..a7f52ac1f5a6 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EnvironmentsListBySubscription.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2021-06-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1", + "location": "West US", + "name": "env1", + "type": "Microsoft.TimeSeriesInsights/Environments", + "kind": "Gen1", + "tags": {}, + "properties": { + "dataRetentionTime": "P31D", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z", + "supportsCustomerManagedKey": true + }, + "sku": { + "name": "S1", + "capacity": 1 + } + } + ] + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EnvironmentsPatchTags.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EnvironmentsPatchTags.json new file mode 100644 index 000000000000..650d0091492c --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EnvironmentsPatchTags.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "environmentUpdateParameters": { + "tags": { + "someTag": "someTagValue" + } + }, + "api-version": "2021-06-30-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1", + "location": "West US", + "name": "env1", + "type": "Microsoft.TimeSeriesInsights/Environments", + "kind": "Gen1", + "tags": { + "someTag": "someTagValue" + }, + "properties": { + "dataRetentionTime": "P31D", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z", + "supportsCustomerManagedKey": true + }, + "sku": { + "name": "S1", + "capacity": 10 + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EventSourcesCreateEventHub.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EventSourcesCreateEventHub.json new file mode 100644 index 000000000000..55b6b1572c30 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EventSourcesCreateEventHub.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "eventSourceName": "es1", + "parameters": { + "location": "West US", + "kind": "Microsoft.EventHub", + "properties": { + "eventSourceResourceId": "somePathInArm", + "serviceBusNamespace": "sbn", + "consumerGroupName": "cgn", + "eventHubName": "ehn", + "keyName": "managementKey", + "sharedAccessKey": "someSecretvalue", + "timestampPropertyName": "someTimestampProperty", + "localTimestamp": { + "format": "TimeSpan", + "timeZoneOffset": { + "propertyName": "someEventPropertyName" + } + }, + "ingressStartAt": { + "type": "EarliestAvailable" + } + } + }, + "api-version": "2021-06-30-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/eventSources/es1", + "location": "West US", + "name": "es1", + "type": "Microsoft.TimeSeriesInsights/Environments/EventSources", + "tags": {}, + "kind": "Microsoft.EventHub", + "properties": { + "eventSourceResourceId": "somePathInArm", + "serviceBusNamespace": "sbn", + "consumerGroupName": "cgn", + "eventHubName": "ehn", + "keyName": "managementKey", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z", + "localTimestamp": { + "format": "TimeSpan", + "timeZoneOffset": { + "propertyName": "someEventPropertyName" + } + }, + "ingressStartAt": { + "type": "EarliestAvailable" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/eventSources/es1", + "location": "West US", + "name": "es1", + "type": "Microsoft.TimeSeriesInsights/Environments/EventSources", + "tags": {}, + "kind": "Microsoft.EventHub", + "properties": { + "eventSourceResourceId": "somePathInArm", + "serviceBusNamespace": "sbn", + "consumerGroupName": "cgn", + "eventHubName": "ehn", + "keyName": "managementKey", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z", + "localTimestamp": { + "format": "TimeSpan", + "timeZoneOffset": { + "propertyName": "someEventPropertyName" + } + }, + "ingressStartAt": { + "type": "EarliestAvailable" + } + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EventSourcesCreateEventHubWithCustomEnquedTime.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EventSourcesCreateEventHubWithCustomEnquedTime.json new file mode 100644 index 000000000000..c1bcf04ee83e --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EventSourcesCreateEventHubWithCustomEnquedTime.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "eventSourceName": "es1", + "parameters": { + "location": "West US", + "kind": "Microsoft.EventHub", + "properties": { + "eventSourceResourceId": "somePathInArm", + "serviceBusNamespace": "sbn", + "consumerGroupName": "cgn", + "eventHubName": "ehn", + "keyName": "managementKey", + "sharedAccessKey": "someSecretvalue", + "timestampPropertyName": "someTimestampProperty", + "ingressStartAt": { + "type": "CustomEnqueuedTime", + "time": "2017-04-01T19:20:33.2288820Z" + } + } + }, + "api-version": "2021-06-30-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/eventSources/es1", + "location": "West US", + "name": "es1", + "type": "Microsoft.TimeSeriesInsights/Environments/EventSources", + "tags": {}, + "kind": "Microsoft.EventHub", + "properties": { + "eventSourceResourceId": "somePathInArm", + "serviceBusNamespace": "sbn", + "consumerGroupName": "cgn", + "eventHubName": "ehn", + "keyName": "managementKey", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z", + "ingressStartAt": { + "type": "CustomEnqueuedTime", + "time": "2017-04-01T19:20:33.2288820Z" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/eventSources/es1", + "location": "West US", + "name": "es1", + "type": "Microsoft.TimeSeriesInsights/Environments/EventSources", + "tags": {}, + "kind": "Microsoft.EventHub", + "properties": { + "eventSourceResourceId": "somePathInArm", + "serviceBusNamespace": "sbn", + "consumerGroupName": "cgn", + "eventHubName": "ehn", + "keyName": "managementKey", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z", + "ingressStartAt": { + "type": "CustomEnqueuedTime", + "time": "2017-04-01T19:20:33.2288820Z" + } + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EventSourcesDelete.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EventSourcesDelete.json new file mode 100644 index 000000000000..cb64903c011f --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EventSourcesDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "eventSourceName": "es1", + "api-version": "2021-06-30-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EventSourcesGetEventHub.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EventSourcesGetEventHub.json new file mode 100644 index 000000000000..3dfb821873a0 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EventSourcesGetEventHub.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "eventSourceName": "es1", + "api-version": "2021-06-30-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/eventSources/es1", + "location": "West US", + "name": "es1", + "type": "Microsoft.TimeSeriesInsights/Environments/EventSources", + "tags": {}, + "kind": "Microsoft.EventHub", + "properties": { + "eventSourceResourceId": "somePathInArm", + "serviceBusNamespace": "sbn", + "consumerGroupName": "cgn", + "eventHubName": "ehn", + "keyName": "managementKey", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z", + "localTimestamp": { + "format": "TimeSpan", + "timeZoneOffset": { + "propertyName": "someEventPropertyName" + } + }, + "ingressStartAt": { + "type": "EarliestAvailable" + } + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EventSourcesListByEnvironment.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EventSourcesListByEnvironment.json new file mode 100644 index 000000000000..9be9e4a9d8f2 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EventSourcesListByEnvironment.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "api-version": "2021-06-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/eventSources/es1", + "location": "West US", + "name": "es1", + "type": "Microsoft.TimeSeriesInsights/Environments/EventSources", + "tags": {}, + "kind": "Microsoft.EventHub", + "properties": { + "eventSourceResourceId": "somePathInArm", + "serviceBusNamespace": "sbn", + "consumerGroupName": "cgn", + "eventHubName": "ehn", + "keyName": "managementKey", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z", + "localTimestamp": { + "format": "TimeSpan", + "timeZoneOffset": { + "propertyName": "someEventPropertyName" + } + }, + "ingressStartAt": { + "type": "EarliestAvailable" + } + } + } + ] + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EventSourcesPatchTags.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EventSourcesPatchTags.json new file mode 100644 index 000000000000..542fe8f751ec --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/EventSourcesPatchTags.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "eventSourceName": "es1", + "eventSourceUpdateParameters": { + "tags": { + "someKey": "someValue" + } + }, + "api-version": "2021-06-30-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/eventSources/es1", + "location": "West US", + "name": "es1", + "type": "Microsoft.TimeSeriesInsights/Environments/EventSources", + "tags": { + "someKey": "someValue" + }, + "kind": "Microsoft.EventHub", + "properties": { + "eventSourceResourceId": "somePathInArm", + "serviceBusNamespace": "sbn", + "consumerGroupName": "cgn", + "eventHubName": "ehn", + "keyName": "managementKey", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z", + "timestampPropertyName": "someOtherTimestampProperty", + "localTimestamp": { + "format": "TimeSpan", + "timeZoneOffset": { + "propertyName": "someEventPropertyName" + } + }, + "ingressStartAt": { + "type": "EarliestAvailable" + } + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/Operation_List.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/Operation_List.json new file mode 100644 index 000000000000..a85d4586904b --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/Operation_List.json @@ -0,0 +1,587 @@ +{ + "parameters": { + "api-version": "2016-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "origin": "user,system", + "name": "Microsoft.TimeSeriesInsights/register/action", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Time Series Insights Resource Provider", + "operation": "Registers the Time Series Insights Resource Provider", + "description": "Registers the subscription for the Time Series Insights resource provider and enables the creation of Time Series Insights environments." + } + }, + { + "origin": "system", + "name": "Microsoft.TimeSeriesInsights/environments/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "The metrics definition of environments", + "operation": "Read environments metric definitions", + "description": "Gets the available metrics for environments" + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "IngressReceivedMessages", + "displayName": "Ingress Received Messages", + "displayDescription": "Count of messages read from all Event hub or IoT hub event sources", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "IngressReceivedInvalidMessages", + "displayName": "Ingress Received Invalid Messages", + "displayDescription": "Count of invalid messages read from all Event hub or IoT hub event sources", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "IngressReceivedBytes", + "displayName": "Ingress Received Bytes", + "displayDescription": "Count of bytes read from all event sources", + "unit": "Bytes", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "IngressStoredBytes", + "displayName": "Ingress Stored Bytes", + "displayDescription": "Total size of events successfully processed and available for query", + "unit": "Bytes", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "IngressStoredEvents", + "displayName": "Ingress Stored Events", + "displayDescription": "Count of flattened events successfully processed and available for query", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "IngressReceivedMessagesTimeLag", + "displayName": "Ingress Received Messages Time Lag", + "displayDescription": "Difference between the time that the message is enqueued in the event source and the time it is processed in Ingress", + "unit": "Seconds", + "aggregationType": "Maximum", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "IngressReceivedMessagesCountLag", + "displayName": "Ingress Received Messages Count Lag", + "displayDescription": "Difference between the sequence number of last enqueued message in the event source partition and sequence number of messages being processed in Ingress", + "unit": "Count", + "aggregationType": "Average", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "WarmStorageMaxProperties", + "displayName": "Warm Storage Max Properties", + "displayDescription": "Maximum number of properties used allowed by the environment for S1/S2 SKU and maximum number of properties allowed by Warm Store for PAYG SKU", + "unit": "Count", + "aggregationType": "Maximum", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "WarmStorageUsedProperties", + "displayName": "Warm Storage Used Properties ", + "displayDescription": "Number of properties used by the environment for S1/S2 SKU and number of properties used by Warm Store for PAYG SKU", + "unit": "Count", + "aggregationType": "Maximum", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + } + ] + } + } + }, + { + "origin": "system", + "name": "Microsoft.TimeSeriesInsights/environments/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "environments", + "operation": "Read diagnostic setting.", + "description": "Gets the diagnostic setting for the resource" + } + }, + { + "origin": "system", + "name": "Microsoft.TimeSeriesInsights/environments/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "environments", + "operation": "Write diagnostic setting.", + "description": "Creates or updates the diagnostic setting for the resource" + } + }, + { + "origin": "system", + "name": "Microsoft.TimeSeriesInsights/environments/providers/Microsoft.Insights/logDefinitions/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "environments", + "operation": "Read environments log definitions", + "description": "Gets the available logs for environments" + }, + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "Ingress", + "displayName": "Ingress" + }, + { + "name": "Management", + "displayName": "Management" + } + ] + } + } + }, + { + "origin": "system", + "name": "Microsoft.TimeSeriesInsights/environments/eventsources/providers/Microsoft.Insights/logDefinitions/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Event Source", + "operation": "Read event source log definitions", + "description": "Gets the available logs for the event source" + }, + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "Ingress", + "displayName": "Ingress" + }, + { + "name": "Management", + "displayName": "Management" + } + ] + } + } + }, + { + "origin": "system", + "name": "Microsoft.TimeSeriesInsights/environments/eventsources/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "The metrics definition of environments/eventsources", + "operation": "Read eventsources metric definitions", + "description": "Gets the available metrics for eventsources" + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "IngressReceivedMessages", + "displayName": "Ingress Received Messages", + "displayDescription": "Count of messages read from the event source", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "IngressReceivedInvalidMessages", + "displayName": "Ingress Received Invalid Messages", + "displayDescription": "Count of invalid messages read from the event source", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "IngressReceivedBytes", + "displayName": "Ingress Received Bytes", + "displayDescription": "Count of bytes read from the event source", + "unit": "Bytes", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "IngressStoredBytes", + "displayName": "Ingress Stored Bytes", + "displayDescription": "Total size of events successfully processed and available for query", + "unit": "Bytes", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "IngressStoredEvents", + "displayName": "Ingress Stored Events", + "displayDescription": "Count of flattened events successfully processed and available for query", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "IngressReceivedMessagesTimeLag", + "displayName": "Ingress Received Messages Time Lag", + "displayDescription": "Difference between the time that the message is enqueued in the event source and the time it is processed in Ingress", + "unit": "Seconds", + "aggregationType": "Maximum", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "IngressReceivedMessagesCountLag", + "displayName": "Ingress Received Messages Count Lag", + "displayDescription": "Difference between the sequence number of last enqueued message in the event source partition and sequence number of messages being processed in Ingress", + "unit": "Count", + "aggregationType": "Average", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "WarmStorageMaxProperties", + "displayName": "Warm Storage Max Properties", + "displayDescription": "Maximum number of properties used allowed by the environment for S1/S2 SKU and maximum number of properties allowed by Warm Store for PAYG SKU", + "unit": "Count", + "aggregationType": "Maximum", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "WarmStorageUsedProperties", + "displayName": "Warm Storage Used Properties ", + "displayDescription": "Number of properties used by the environment for S1/S2 SKU and number of properties used by Warm Store for PAYG SKU", + "unit": "Count", + "aggregationType": "Maximum", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + } + ] + } + } + }, + { + "origin": "system", + "name": "Microsoft.TimeSeriesInsights/environments/eventsources/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "environments/eventsources", + "operation": "Read diagnostic setting.", + "description": "Gets the diagnostic setting for the resource" + } + }, + { + "origin": "system", + "name": "Microsoft.TimeSeriesInsights/environments/eventsources/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "environments/eventsources", + "operation": "Write diagnostic setting.", + "description": "Creates or updates the diagnostic setting for the resource" + } + }, + { + "origin": "user,system", + "name": "Microsoft.TimeSeriesInsights/environments/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Environment", + "operation": "Read Environment", + "description": "Get the properties of an environment." + } + }, + { + "origin": "user,system", + "name": "Microsoft.TimeSeriesInsights/environments/write", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Environment", + "operation": "Create or Update Environment", + "description": "Creates a new environment, or updates an existing environment." + } + }, + { + "origin": "user,system", + "name": "Microsoft.TimeSeriesInsights/environments/delete", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Environment", + "operation": "Delete Environment", + "description": "Deletes the environment." + } + }, + { + "origin": "user,system", + "name": "Microsoft.TimeSeriesInsights/environments/status/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Environment", + "operation": "Read Environment status", + "description": "Get the status of the environment, state of its associated operations like ingress." + } + }, + { + "origin": "user,system", + "name": "Microsoft.TimeSeriesInsights/environments/eventsources/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Event Source", + "operation": "Read Event Source", + "description": "Get the properties of an event source." + } + }, + { + "origin": "user,system", + "name": "Microsoft.TimeSeriesInsights/environments/eventsources/write", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Event Source", + "operation": "Create or Update Event Source", + "description": "Creates a new event source for an environment, or updates an existing event source." + } + }, + { + "origin": "user,system", + "name": "Microsoft.TimeSeriesInsights/environments/eventsources/delete", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Event Source", + "operation": "Delete Event Source", + "description": "Deletes the event source." + } + }, + { + "origin": "user,system", + "name": "Microsoft.TimeSeriesInsights/environments/referencedatasets/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Reference Data Set", + "operation": "Read Reference Data Set", + "description": "Get the properties of a reference data set." + } + }, + { + "origin": "user,system", + "name": "Microsoft.TimeSeriesInsights/environments/referencedatasets/write", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Reference Data Set", + "operation": "Create or Update Reference Data Set", + "description": "Creates a new reference data set for an environment, or updates an existing reference data set." + } + }, + { + "origin": "user,system", + "name": "Microsoft.TimeSeriesInsights/environments/referencedatasets/delete", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Reference Data Set", + "operation": "Delete Reference Data Set", + "description": "Deletes the reference data set." + } + }, + { + "origin": "user,system", + "name": "Microsoft.TimeSeriesInsights/environments/accesspolicies/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Access Policy", + "operation": "Read Access Policy", + "description": "Get the properties of an access policy." + } + }, + { + "origin": "user,system", + "name": "Microsoft.TimeSeriesInsights/environments/accesspolicies/write", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Access Policy", + "operation": "Create or Update Access Policy", + "description": "Creates a new access policy for an environment, or updates an existing access policy." + } + }, + { + "origin": "user,system", + "name": "Microsoft.TimeSeriesInsights/environments/accesspolicies/delete", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Access Policy", + "operation": "Delete Access Policy", + "description": "Deletes the access policy." + } + }, + { + "origin": "system", + "name": "Microsoft.TimeSeriesInsights/environments/privateEndpointConnectionProxies/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Private endpoint connection proxy", + "operation": "Read private endpoint connection proxy", + "description": "Get the properties of a private endpoint connection proxy." + } + }, + { + "origin": "system", + "name": "Microsoft.TimeSeriesInsights/environments/privateEndpointConnectionProxies/write", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Private endpoint connection proxy", + "operation": "Create or Update private endpoint connection proxy", + "description": "Creates a new private endpoint connection proxy for an environment, or updates an existing connection proxy." + } + }, + { + "origin": "system", + "name": "Microsoft.TimeSeriesInsights/environments/privateEndpointConnectionProxies/delete", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Private endpoint connection proxy", + "operation": "Delete the private endpoint connection proxy", + "description": "Deletes the private endpoint connection proxy." + } + }, + { + "origin": "system", + "name": "Microsoft.TimeSeriesInsights/environments/privateEndpointConnectionProxies/validate/action", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Private endpoint connection proxy", + "operation": "Validate the private endpoint connection proxy.", + "description": "Validate the private endpoint connection proxy object before creation." + } + }, + { + "origin": "system", + "name": "Microsoft.TimeSeriesInsights/environments/privateEndpointConnectionProxies/operationresults/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Private endpoint connection proxy", + "operation": "Get private endpoint connection proxy operation status.", + "description": "Validate the private endpoint connection proxy operation status." + } + }, + { + "origin": "user,system", + "name": "Microsoft.TimeSeriesInsights/environments/privateendpointConnections/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Private endpoint connection.", + "operation": "Read private endpoint connection.", + "description": "Get the properties of a private endpoint connection." + } + }, + { + "origin": "user,system", + "name": "Microsoft.TimeSeriesInsights/environments/privateendpointConnections/write", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Private endpoint connection.", + "operation": "Create or Update private endpoint connection.", + "description": "Creates a new private endpoint connection for an environment, or updates an existing connection." + } + }, + { + "origin": "user,system", + "name": "Microsoft.TimeSeriesInsights/environments/privateendpointConnections/delete", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Private endpoint connection", + "operation": "Delete the private endpoint connection", + "description": "Deletes the private endpoint connection." + } + } + ] + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/ReferenceDataSetsCreate.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/ReferenceDataSetsCreate.json new file mode 100644 index 000000000000..1bd49e239701 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/ReferenceDataSetsCreate.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "referenceDataSetName": "rds1", + "parameters": { + "location": "West US", + "properties": { + "keyProperties": [ + { + "name": "DeviceId1", + "type": "String" + }, + { + "name": "DeviceFloor", + "type": "Double" + } + ] + } + }, + "api-version": "2021-06-30-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/referenceDataSets/rds1", + "location": "West US", + "name": "rds1", + "type": "Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets", + "tags": {}, + "properties": { + "keyProperties": [ + { + "name": "DeviceId1", + "type": "String" + }, + { + "name": "DeviceFloor", + "type": "Double" + } + ], + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/referenceDataSets/rds1", + "location": "West US", + "name": "rds1", + "type": "Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets", + "tags": {}, + "properties": { + "keyProperties": [ + { + "name": "DeviceId1", + "type": "String" + }, + { + "name": "DeviceFloor", + "type": "Double" + } + ], + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/ReferenceDataSetsDelete.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/ReferenceDataSetsDelete.json new file mode 100644 index 000000000000..4ee948c2ce17 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/ReferenceDataSetsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "referenceDataSetName": "rds1", + "api-version": "2021-06-30-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/ReferenceDataSetsGet.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/ReferenceDataSetsGet.json new file mode 100644 index 000000000000..efabe00e8565 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/ReferenceDataSetsGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "referenceDataSetName": "rds1", + "api-version": "2021-06-30-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/referenceDataSets/rds1", + "location": "West US", + "name": "rds1", + "type": "Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets", + "tags": {}, + "properties": { + "keyProperties": [ + { + "name": "DeviceId1", + "type": "String" + }, + { + "name": "DeviceFloor", + "type": "Double" + } + ], + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/ReferenceDataSetsListByEnvironment.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/ReferenceDataSetsListByEnvironment.json new file mode 100644 index 000000000000..0712b0daeb21 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/ReferenceDataSetsListByEnvironment.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "api-version": "2021-06-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/referenceDataSets/rds1", + "location": "West US", + "name": "rds1", + "type": "Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets", + "tags": {}, + "properties": { + "keyProperties": [ + { + "name": "DeviceId1", + "type": "String" + }, + { + "name": "DeviceFloor", + "type": "Double" + } + ], + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + } + } + ] + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/ReferenceDataSetsPatchTags.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/ReferenceDataSetsPatchTags.json new file mode 100644 index 000000000000..6a1f3af9545e --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/examples/ReferenceDataSetsPatchTags.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "referenceDataSetName": "rds1", + "referenceDataSetUpdateParameters": { + "tags": { + "someKey": "someValue" + } + }, + "api-version": "2021-06-30-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/referenceDataSets/rds1", + "location": "West US", + "name": "rds1", + "type": "Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets", + "tags": { + "someKey": "someValue" + }, + "properties": { + "keyProperties": [ + { + "name": "DeviceId1", + "type": "String" + }, + { + "name": "DeviceFloor", + "type": "Double" + } + ], + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/timeseriesinsights.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/timeseriesinsights.json new file mode 100644 index 000000000000..5f369e9b1ed6 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/timeseriesinsights.json @@ -0,0 +1,2753 @@ +{ + "swagger": "2.0", + "info": { + "title": "TimeSeriesInsightsClient", + "description": "Time Series Insights client", + "version": "2021-06-30-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.TimeSeriesInsights/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists all of the available Time Series Insights related operations.", + "x-ms-examples": { + "List available operations for the Time Series Insights resource provider": { + "$ref": "./examples/Operation_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully listed the available operations.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The list of operations could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}": { + "put": { + "tags": [ + "Environments" + ], + "operationId": "Environments_CreateOrUpdate", + "x-ms-examples": { + "EnvironmentsCreate": { + "$ref": "./examples/EnvironmentsCreate.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Create or update an environment in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "description": "Name of the environment" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentCreateOrUpdateParameters" + }, + "description": "Parameters for creating an environment resource." + } + ], + "responses": { + "200": { + "description": "The existing environment definition was successfully updated.", + "schema": { + "$ref": "#/definitions/EnvironmentResource" + } + }, + "201": { + "description": "The environment create request was accepted. Environment provisioning is an asynchronous operation. You can periodically get your environment definition and monitor progress via the provisioningState property.", + "schema": { + "$ref": "#/definitions/EnvironmentResource" + } + }, + "404": { + "description": "The subscription or resource group could not be found." + }, + "default": { + "description": "HTTP 400 (Bad Request): The given environment request body is invalid; See the error code and message in the response for details.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "Environments" + ], + "operationId": "Environments_Get", + "x-ms-examples": { + "EnvironmentsGet": { + "$ref": "./examples/EnvironmentsGet.json" + } + }, + "description": "Gets the environment with the specified name in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/ExpandParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The environment definition was successfully retrieved and is in the response. If you are polling for the completion of a provisioning or scale operation, you can check its status via the provisioningState property.", + "schema": { + "$ref": "#/definitions/EnvironmentResource" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, or environment could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Environments" + ], + "operationId": "Environments_Update", + "x-ms-examples": { + "EnvironmentsUpdate": { + "$ref": "./examples/EnvironmentsPatchTags.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Updates the environment with the specified name in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "name": "environmentUpdateParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentUpdateParameters" + }, + "description": "Request object that contains the updated information for the environment." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The environment definition was successfully updated and is in the response. If the environment was updated synchronously, the response will include a provisioningState value of \"Succeeded\". If the environment was updated asynchronously, the response will include a provisioningState value of \"Updating\". You can periodically get your environment definition and monitor progress of the update via the provisioningState property.", + "schema": { + "$ref": "#/definitions/EnvironmentResource" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, or environment could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "Environments" + ], + "operationId": "Environments_Delete", + "x-ms-examples": { + "EnvironmentsDelete": { + "$ref": "./examples/EnvironmentsDelete.json" + } + }, + "description": "Deletes the environment with the specified name in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The environment was successfully deleted." + }, + "204": { + "description": "The environment was successfully deleted." + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, or environment could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments": { + "get": { + "tags": [ + "Environments" + ], + "operationId": "Environments_ListByResourceGroup", + "x-ms-examples": { + "EnvironmentsByResourceGroup": { + "$ref": "./examples/EnvironmentsListByResourceGroup.json" + } + }, + "description": "Lists all the available environments associated with the subscription and within the specified resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Environments returned successfully.", + "schema": { + "$ref": "#/definitions/EnvironmentListResponse" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, or resource group could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.TimeSeriesInsights/environments": { + "get": { + "tags": [ + "Environments" + ], + "operationId": "Environments_ListBySubscription", + "x-ms-examples": { + "EnvironmentsBySubscription": { + "$ref": "./examples/EnvironmentsListBySubscription.json" + } + }, + "description": "Lists all the available environments within a subscription, irrespective of the resource groups.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Environments returned successfully.", + "schema": { + "$ref": "#/definitions/EnvironmentListResponse" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/eventSources/{eventSourceName}": { + "put": { + "tags": [ + "EventSources" + ], + "operationId": "EventSources_CreateOrUpdate", + "x-ms-examples": { + "CreateEventHubEventSource": { + "$ref": "./examples/EventSourcesCreateEventHub.json" + }, + "EventSourcesCreateEventHubWithCustomEnquedTime": { + "$ref": "./examples/EventSourcesCreateEventHubWithCustomEnquedTime.json" + } + }, + "description": "Create or update an event source under the specified environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "name": "eventSourceName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "description": "Name of the event source." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EventSourceCreateOrUpdateParameters" + }, + "description": "Parameters for creating an event source resource." + } + ], + "responses": { + "200": { + "description": "The existing event source definition was successfully updated.", + "schema": { + "$ref": "#/definitions/EventSourceResource" + } + }, + "201": { + "description": "The event source was successfully created.", + "schema": { + "$ref": "#/definitions/EventSourceResource" + } + }, + "default": { + "description": "HTTP 400 (Bad Request): The given event source request body is invalid; See the error code and message in the response for details.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "EventSources" + ], + "operationId": "EventSources_Get", + "x-ms-examples": { + "GetEventHubEventSource": { + "$ref": "./examples/EventSourcesGetEventHub.json" + } + }, + "description": "Gets the event source with the specified name in the specified environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/EventSourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The event source definition was successfully retrieved and is in the response.", + "schema": { + "$ref": "#/definitions/EventSourceResource" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, environment, or event source could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "EventSources" + ], + "operationId": "EventSources_Update", + "x-ms-examples": { + "UpdateEventSource": { + "$ref": "./examples/EventSourcesPatchTags.json" + } + }, + "description": "Updates the event source with the specified name in the specified subscription, resource group, and environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/EventSourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "eventSourceUpdateParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EventSourceUpdateParameters" + }, + "description": "Request object that contains the updated information for the event source." + } + ], + "responses": { + "200": { + "description": "The event source definition was successfully updated and is in the response.", + "schema": { + "$ref": "#/definitions/EventSourceResource" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, environment, or event source could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "EventSources" + ], + "operationId": "EventSources_Delete", + "x-ms-examples": { + "DeleteEventSource": { + "$ref": "./examples/EventSourcesDelete.json" + } + }, + "description": "Deletes the event source with the specified name in the specified subscription, resource group, and environment", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/EventSourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The event source was successfully deleted." + }, + "204": { + "description": "The event source was successfully deleted." + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, environment, or event source could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/eventSources": { + "get": { + "tags": [ + "EventSources" + ], + "operationId": "EventSources_ListByEnvironment", + "x-ms-examples": { + "ListEventSourcesByEnvironment": { + "$ref": "./examples/EventSourcesListByEnvironment.json" + } + }, + "description": "Lists all the available event sources associated with the subscription and within the specified resource group and environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Environments returned successfully.", + "schema": { + "$ref": "#/definitions/EventSourceListResponse" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, or environment could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/referenceDataSets/{referenceDataSetName}": { + "put": { + "tags": [ + "ReferenceDataSets" + ], + "operationId": "ReferenceDataSets_CreateOrUpdate", + "x-ms-examples": { + "ReferenceDataSetsCreate": { + "$ref": "./examples/ReferenceDataSetsCreate.json" + } + }, + "description": "Create or update a reference data set in the specified environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "name": "referenceDataSetName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]", + "minLength": 3, + "maxLength": 63, + "description": "Name of the reference data set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ReferenceDataSetCreateOrUpdateParameters" + }, + "description": "Parameters for creating a reference data set." + } + ], + "responses": { + "200": { + "description": "The existing reference data set definition was successfully updated.", + "schema": { + "$ref": "#/definitions/ReferenceDataSetResource" + } + }, + "201": { + "description": "The reference data set was successfully created.", + "schema": { + "$ref": "#/definitions/ReferenceDataSetResource" + } + }, + "default": { + "description": "HTTP 400 (Bad Request): The given reference data set request body is invalid; See the error code and message in the response for details.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "ReferenceDataSets" + ], + "operationId": "ReferenceDataSets_Get", + "x-ms-examples": { + "ReferenceDataSetsGet": { + "$ref": "./examples/ReferenceDataSetsGet.json" + } + }, + "description": "Gets the reference data set with the specified name in the specified environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/ReferenceDataSetNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The reference data set definition was successfully retrieved and is in the response.", + "schema": { + "$ref": "#/definitions/ReferenceDataSetResource" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, environment, or reference data set could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "ReferenceDataSets" + ], + "operationId": "ReferenceDataSets_Update", + "x-ms-examples": { + "ReferenceDataSetsUpdate": { + "$ref": "./examples/ReferenceDataSetsPatchTags.json" + } + }, + "description": "Updates the reference data set with the specified name in the specified subscription, resource group, and environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/ReferenceDataSetNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "referenceDataSetUpdateParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ReferenceDataSetUpdateParameters" + }, + "description": "Request object that contains the updated information for the reference data set." + } + ], + "responses": { + "200": { + "description": "The reference data set definition was successfully updated and is in the response.", + "schema": { + "$ref": "#/definitions/ReferenceDataSetResource" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, environment, or reference data set could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "ReferenceDataSets" + ], + "operationId": "ReferenceDataSets_Delete", + "x-ms-examples": { + "ReferenceDataSetsDelete": { + "$ref": "./examples/ReferenceDataSetsDelete.json" + } + }, + "description": "Deletes the reference data set with the specified name in the specified subscription, resource group, and environment", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/ReferenceDataSetNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The reference data set was successfully deleted." + }, + "204": { + "description": "The reference data set was successfully deleted." + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, environment, or reference data set could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/referenceDataSets": { + "get": { + "tags": [ + "ReferenceDataSets" + ], + "operationId": "ReferenceDataSets_ListByEnvironment", + "x-ms-examples": { + "ReferenceDataSetsListByEnvironment": { + "$ref": "./examples/ReferenceDataSetsListByEnvironment.json" + } + }, + "description": "Lists all the available reference data sets associated with the subscription and within the specified resource group and environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Reference data sets returned successfully.", + "schema": { + "$ref": "#/definitions/ReferenceDataSetListResponse" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, or environment could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/accessPolicies/{accessPolicyName}": { + "put": { + "tags": [ + "AccessPolicies" + ], + "operationId": "AccessPolicies_CreateOrUpdate", + "x-ms-examples": { + "AccessPoliciesCreate": { + "$ref": "./examples/AccessPoliciesCreate.json" + } + }, + "description": "Create or update an access policy in the specified environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "name": "accessPolicyName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "description": "Name of the access policy." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AccessPolicyCreateOrUpdateParameters" + }, + "description": "Parameters for creating an access policy." + } + ], + "responses": { + "200": { + "description": "The existing access policy definition was successfully updated.", + "schema": { + "$ref": "#/definitions/AccessPolicyResource" + } + }, + "201": { + "description": "The access policy was successfully created.", + "schema": { + "$ref": "#/definitions/AccessPolicyResource" + } + }, + "default": { + "description": "HTTP 400 (Bad Request): The given access policy request body is invalid; See the error code and message in the response for details.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "AccessPolicies" + ], + "operationId": "AccessPolicies_Get", + "x-ms-examples": { + "AccessPoliciesGet": { + "$ref": "./examples/AccessPoliciesGet.json" + } + }, + "description": "Gets the access policy with the specified name in the specified environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/AccessPolicyNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The access policy definition was successfully retrieved and is in the response.", + "schema": { + "$ref": "#/definitions/AccessPolicyResource" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, environment, or access policy could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "AccessPolicies" + ], + "operationId": "AccessPolicies_Update", + "x-ms-examples": { + "AccessPoliciesUpdate": { + "$ref": "./examples/AccessPoliciesPatchRoles.json" + } + }, + "description": "Updates the access policy with the specified name in the specified subscription, resource group, and environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/AccessPolicyNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "accessPolicyUpdateParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AccessPolicyUpdateParameters" + }, + "description": "Request object that contains the updated information for the access policy." + } + ], + "responses": { + "200": { + "description": "The access policy definition was successfully updated and is in the response.", + "schema": { + "$ref": "#/definitions/AccessPolicyResource" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, environment, or access policy could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "AccessPolicies" + ], + "operationId": "AccessPolicies_Delete", + "x-ms-examples": { + "AccessPoliciesDelete": { + "$ref": "./examples/AccessPoliciesDelete.json" + } + }, + "description": "Deletes the access policy with the specified name in the specified subscription, resource group, and environment", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/AccessPolicyNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The access policy was successfully deleted." + }, + "204": { + "description": "The access policy was successfully deleted." + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, environment, or access policy could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/accessPolicies": { + "get": { + "tags": [ + "AccessPolicies" + ], + "operationId": "AccessPolicies_ListByEnvironment", + "x-ms-examples": { + "AccessPoliciesByEnvironment": { + "$ref": "./examples/AccessPoliciesListByEnvironment.json" + } + }, + "description": "Lists all the available access policies associated with the environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "access policies returned successfully.", + "schema": { + "$ref": "#/definitions/AccessPolicyListResponse" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, or environment could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Time Series Insights operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "List of Time Series Insights operations supported by the Microsoft.TimeSeriesInsights resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "Operation": { + "description": "A Time Series Insights REST API operation", + "type": "object", + "properties": { + "name": { + "description": "The name of the operation being performed on this particular object.", + "type": "string", + "readOnly": true + }, + "display": { + "description": "Contains the localized display information for this particular operation / action.", + "readOnly": true, + "properties": { + "provider": { + "description": "The localized friendly form of the resource provider name.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "The localized friendly form of the resource type related to this action/operation.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "The localized friendly name for the operation.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The localized friendly description for the operation.", + "type": "string", + "readOnly": true + } + } + }, + "origin": { + "title": "The intended executor of the operation.", + "type": "string" + }, + "properties": { + "title": "Properties of the operation, including metric specifications.", + "type": "object", + "x-ms-client-flatten": true, + "x-ms-client-name": "OperationProperties", + "$ref": "#/definitions/OperationProperties" + } + } + }, + "OperationProperties": { + "description": "Properties of operation, include metric specifications.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "One property of operation, include metric specifications." + } + } + }, + "ServiceSpecification": { + "description": "One property of operation, include metric specifications.", + "type": "object", + "properties": { + "metricSpecifications": { + "description": "Metric specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + } + }, + "logSpecifications": { + "description": "A list of Azure Monitoring log definitions.", + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + } + } + } + }, + "MetricSpecification": { + "description": "Metric specification of operation.", + "type": "object", + "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." + }, + "dimensions": { + "description": "Dimensions of blobs, including blob type and access tier.", + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + } + }, + "aggregationType": { + "type": "string", + "description": "Aggregation type could be Average." + }, + "availabilities": { + "description": "Retention policies of a resource metric.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricAvailability" + } + }, + "category": { + "type": "string", + "description": "The category this metric specification belong to, could be Capacity." + }, + "resourceIdDimensionNameOverride": { + "type": "string", + "description": "Account Resource Id." + } + } + }, + "LogSpecification": { + "description": "The specification of an Azure Monitoring log.", + "type": "object", + "properties": { + "name": { + "description": "Log name.", + "type": "string" + }, + "displayName": { + "description": "Log display name.", + "type": "string" + } + } + }, + "Dimension": { + "description": "Dimension of blobs, possibly be blob type or access tier.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Display name of dimension." + }, + "displayName": { + "type": "string", + "description": "Display name of dimension." + } + } + }, + "MetricAvailability": { + "description": "Retention policy of a resource metric.", + "type": "object", + "properties": { + "timeGrain": { + "type": "string" + }, + "blobDuration": { + "type": "string" + } + } + }, + "Resource": { + "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": "Time Series Insights resource", + "x-ms-azure-resource": true + }, + "TrackedResource": { + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "location" + ], + "description": "Time Series Insights resource that is tracked by Azure Resource Manager." + }, + "ResourceProperties": { + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource." + }, + "creationTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time the resource was created." + } + }, + "description": "Properties that are common to all tracked resources." + }, + "ProvisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the resource.", + "enum": [ + "Accepted", + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "Sku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of this SKU.", + "enum": [ + "S1", + "S2", + "P1", + "L1" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "capacity": { + "format": "int32", + "type": "integer", + "description": "The capacity of the sku. For Gen1 environments, this value can be changed to support scale out of environments after they have been created.", + "minimum": 1, + "maximum": 10 + } + }, + "required": [ + "name", + "capacity" + ], + "description": "The sku determines the type of environment, either Gen1 (S1 or S2) or Gen2 (L1). For Gen1 environments the sku determines the capacity of the environment, the ingress rate, and the billing rate." + }, + "WarmStoreConfigurationProperties": { + "type": "object", + "properties": { + "dataRetention": { + "type": "string", + "format": "duration", + "description": "ISO8601 timespan specifying the number of days the environment's events will be available for query from the warm store." + } + }, + "required": [ + "dataRetention" + ], + "description": "The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's data available for faster query." + }, + "Gen2StorageConfigurationInput": { + "type": "object", + "properties": { + "accountName": { + "type": "string", + "description": "The name of the storage account that will hold the environment's Gen2 data." + }, + "managementKey": { + "type": "string", + "description": "The value of the management key that grants the Time Series Insights service write access to the storage account. This property is not shown in environment responses." + } + }, + "required": [ + "accountName", + "managementKey" + ], + "description": "The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data." + }, + "Gen2StorageConfigurationOutput": { + "type": "object", + "properties": { + "accountName": { + "type": "string", + "description": "The name of the storage account that will hold the environment's Gen2 data." + } + }, + "required": [ + "accountName" + ], + "description": "The storage configuration provides the non-secret connection details about the customer storage account that is used to store the environment's data." + }, + "Gen2StorageConfigurationMutableProperties": { + "type": "object", + "properties": { + "managementKey": { + "type": "string", + "description": "The value of the management key that grants the Time Series Insights service write access to the storage account. This property is not shown in environment responses." + } + }, + "required": [ + "managementKey" + ], + "description": "The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data." + }, + "CreateOrUpdateTrackedResourceProperties": { + "properties": { + "location": { + "type": "string", + "description": "The location of the resource.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs of additional properties for the resource." + } + }, + "required": [ + "location" + ], + "description": "Properties required to create any resource tracked by Azure Resource Manager." + }, + "EnvironmentCreateOrUpdateParameters": { + "discriminator": "kind", + "properties": { + "kind": { + "type": "string", + "description": "The kind of the environment.", + "enum": [ + "Gen1", + "Gen2" + ], + "x-ms-enum": { + "name": "EnvironmentKind", + "modelAsString": true + }, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku determines the type of environment, either Gen1 (S1 or S2) or Gen2 (L1). For Gen1 environments the sku determines the capacity of the environment, the ingress rate, and the billing rate." + } + }, + "required": [ + "kind", + "sku" + ], + "allOf": [ + { + "$ref": "#/definitions/CreateOrUpdateTrackedResourceProperties" + } + ], + "description": "Parameters supplied to the CreateOrUpdate Environment operation." + }, + "Gen1EnvironmentCreateOrUpdateParameters": { + "x-ms-discriminator-value": "Gen1", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/Gen1EnvironmentCreationProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/EnvironmentCreateOrUpdateParameters" + } + ], + "description": "Parameters supplied to the Create or Update Environment operation for a Gen1 environment." + }, + "Gen2EnvironmentCreateOrUpdateParameters": { + "x-ms-discriminator-value": "Gen2", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/Gen2EnvironmentCreationProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/EnvironmentCreateOrUpdateParameters" + } + ], + "description": "Parameters supplied to the Create or Update Environment operation for a Gen2 environment." + }, + "EnvironmentUpdateParameters": { + "type": "object", + "discriminator": "kind", + "properties": { + "kind": { + "type": "string", + "description": "The kind of the environment.", + "enum": [ + "Gen1", + "Gen2" + ], + "x-ms-enum": { + "name": "EnvironmentKind", + "modelAsString": true + } + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs of additional properties for the environment." + } + }, + "required": [ + "kind" + ], + "description": "Parameters supplied to the Update Environment operation." + }, + "Gen1EnvironmentUpdateParameters": { + "type": "object", + "x-ms-discriminator-value": "Gen1", + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku of the environment." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/Gen1EnvironmentMutableProperties", + "description": "Properties of the Gen1 environment." + } + }, + "allOf": [ + { + "$ref": "#/definitions/EnvironmentUpdateParameters" + } + ], + "description": "Parameters supplied to the Update Environment operation to update a Gen1 environment." + }, + "Gen2EnvironmentUpdateParameters": { + "type": "object", + "x-ms-discriminator-value": "Gen2", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/Gen2EnvironmentMutableProperties", + "description": "Properties of the Gen2 environment." + } + }, + "allOf": [ + { + "$ref": "#/definitions/EnvironmentUpdateParameters" + } + ], + "description": "Parameters supplied to the Update Environment operation to update a Gen2 environment." + }, + "EnvironmentListResponse": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentResource" + }, + "description": "Result of the List Environments operation." + } + }, + "description": "The response of the List Environments operation." + }, + "EnvironmentResource": { + "type": "object", + "discriminator": "kind", + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku determines the type of environment, either Gen1 (S1 or S2) or Gen2 (L1). For Gen1 environments the sku determines the capacity of the environment, the ingress rate, and the billing rate." + }, + "kind": { + "type": "string", + "description": "The kind of the environment.", + "enum": [ + "Gen1", + "Gen2" + ] + } + }, + "required": [ + "kind", + "sku" + ], + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "description": "An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource." + }, + "Gen1EnvironmentResource": { + "x-ms-discriminator-value": "Gen1", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/Gen1EnvironmentResourceProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/EnvironmentResource" + } + ], + "description": "An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource. Gen1 environments have data retention limits." + }, + "Gen2EnvironmentResource": { + "x-ms-discriminator-value": "Gen2", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/Gen2EnvironmentResourceProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/EnvironmentResource" + } + ], + "description": "An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource. Gen2 environments do not have set data retention limits." + }, + "Gen1EnvironmentCreationProperties": { + "properties": { + "dataRetentionTime": { + "type": "string", + "format": "duration", + "description": "ISO8601 timespan specifying the minimum number of days the environment's events will be available for query." + }, + "storageLimitExceededBehavior": { + "type": "string", + "description": "The behavior the Time Series Insights service should take when the environment's capacity has been exceeded. If \"PauseIngress\" is specified, new events will not be read from the event source. If \"PurgeOldData\" is specified, new events will continue to be read and old events will be deleted from the environment. The default behavior is PurgeOldData.", + "enum": [ + "PurgeOldData", + "PauseIngress" + ], + "x-ms-enum": { + "name": "StorageLimitExceededBehavior", + "modelAsString": true + } + }, + "partitionKeyProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeSeriesIdProperty" + }, + "description": "The list of event properties which will be used to partition data in the environment. Currently, only a single partition key property is supported." + } + }, + "required": [ + "dataRetentionTime" + ], + "description": "Properties used to create a Gen1 environment." + }, + "Gen2EnvironmentCreationProperties": { + "properties": { + "timeSeriesIdProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeSeriesIdProperty" + }, + "description": "The list of event properties which will be used to define the environment's time series id." + }, + "storageConfiguration": { + "$ref": "#/definitions/Gen2StorageConfigurationInput", + "description": "The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data." + }, + "warmStoreConfiguration": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/WarmStoreConfigurationProperties", + "description": "The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's data available for faster query." + } + }, + "required": [ + "timeSeriesIdProperties", + "storageConfiguration" + ], + "description": "Properties used to create a Gen2 environment." + }, + "EnvironmentResourceProperties": { + "properties": { + "dataAccessId": { + "readOnly": true, + "type": "string", + "format": "uuid", + "description": "An id used to access the environment data, e.g. to query the environment's events or upload reference data for the environment." + }, + "dataAccessFqdn": { + "readOnly": true, + "type": "string", + "description": "The fully qualified domain name used to access the environment data, e.g. to query the environment's events or upload reference data for the environment." + }, + "supportsCustomerManagedKey": { + "readOnly": true, + "type": "boolean", + "description": "Indicates whether an environment supports Encryption at Rest with Customer Managed Key." + }, + "status": { + "$ref": "#/definitions/EnvironmentStatus", + "description": "An object that represents the status of the environment, and its internal state in the Time Series Insights service." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceProperties" + } + ], + "description": "Properties of the environment." + }, + "Gen1EnvironmentResourceProperties": { + "allOf": [ + { + "$ref": "#/definitions/Gen1EnvironmentCreationProperties" + }, + { + "$ref": "#/definitions/EnvironmentResourceProperties" + } + ], + "required": [ + "dataRetentionTime" + ], + "description": "Properties of the Gen1 environment." + }, + "Gen2EnvironmentResourceProperties": { + "properties": { + "timeSeriesIdProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeSeriesIdProperty" + }, + "description": "The list of event properties which will be used to define the environment's time series id." + }, + "storageConfiguration": { + "$ref": "#/definitions/Gen2StorageConfigurationOutput", + "description": "The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data." + }, + "warmStoreConfiguration": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/WarmStoreConfigurationProperties", + "description": "The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's data available for faster query." + } + }, + "required": [ + "timeSeriesIdProperties", + "storageConfiguration" + ], + "allOf": [ + { + "$ref": "#/definitions/EnvironmentResourceProperties" + } + ], + "description": "Properties of the Gen2 environment." + }, + "Gen1EnvironmentMutableProperties": { + "description": "An object that represents a set of mutable Gen1 environment resource properties.", + "type": "object", + "properties": { + "dataRetentionTime": { + "type": "string", + "format": "duration", + "description": "ISO8601 timespan specifying the minimum number of days the environment's events will be available for query." + }, + "storageLimitExceededBehavior": { + "type": "string", + "description": "The behavior the Time Series Insights service should take when the environment's capacity has been exceeded. If \"PauseIngress\" is specified, new events will not be read from the event source. If \"PurgeOldData\" is specified, new events will continue to be read and old events will be deleted from the environment. The default behavior is PurgeOldData.", + "enum": [ + "PurgeOldData", + "PauseIngress" + ], + "x-ms-enum": { + "name": "StorageLimitExceededBehavior", + "modelAsString": true + } + } + } + }, + "Gen2EnvironmentMutableProperties": { + "description": "An object that represents a set of mutable Gen2 environment resource properties.", + "type": "object", + "properties": { + "storageConfiguration": { + "$ref": "#/definitions/Gen2StorageConfigurationMutableProperties", + "description": "The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data." + }, + "warmStoreConfiguration": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/WarmStoreConfigurationProperties", + "description": "The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's data available for faster query." + } + } + }, + "TimeSeriesIdProperty": { + "properties": { + "name": { + "type": "string", + "description": "The name of the property." + }, + "type": { + "type": "string", + "description": "The type of the property.", + "enum": [ + "String" + ], + "x-ms-enum": { + "name": "PropertyType", + "modelAsString": true + } + } + }, + "description": "The structure of the property that a time series id can have. An environment can have multiple such properties." + }, + "EnvironmentStatus": { + "readOnly": true, + "type": "object", + "description": "An object that represents the status of the environment, and its internal state in the Time Series Insights service.", + "properties": { + "ingress": { + "$ref": "#/definitions/IngressEnvironmentStatus", + "description": "An object that represents the status of ingress on an environment." + }, + "warmStorage": { + "$ref": "#/definitions/WarmStorageEnvironmentStatus", + "description": "An object that represents the status of warm storage on an environment." + } + } + }, + "IngressEnvironmentStatus": { + "readOnly": true, + "type": "object", + "description": "An object that represents the status of ingress on an environment.", + "properties": { + "state": { + "type": "string", + "description": "This string represents the state of ingress operations on an environment. It can be \"Disabled\", \"Ready\", \"Running\", \"Paused\" or \"Unknown\"", + "enum": [ + "Disabled", + "Ready", + "Running", + "Paused", + "Unknown" + ], + "x-ms-enum": { + "name": "IngressState", + "modelAsString": true + } + }, + "stateDetails": { + "$ref": "#/definitions/EnvironmentStateDetails", + "description": "An object that contains the details about an environment's state." + } + } + }, + "EnvironmentStateDetails": { + "readOnly": true, + "type": "object", + "description": "An object that contains the details about an environment's state.", + "properties": { + "code": { + "type": "string", + "description": "Contains the code that represents the reason of an environment being in a particular state. Can be used to programmatically handle specific cases." + }, + "message": { + "type": "string", + "description": "A message that describes the state in detail." + } + } + }, + "WarmStorageEnvironmentStatus": { + "readOnly": true, + "type": "object", + "description": "An object that represents the status of warm storage on an environment.", + "properties": { + "propertiesUsage": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WarmStoragePropertiesUsage", + "description": "An object that contains the status of warm storage properties usage." + } + } + }, + "WarmStoragePropertiesUsage": { + "readOnly": true, + "type": "object", + "description": "An object that contains the status of warm storage properties usage.", + "properties": { + "state": { + "type": "string", + "description": "This string represents the state of warm storage properties usage. It can be \"Ok\", \"Error\", \"Unknown\".", + "enum": [ + "Ok", + "Error", + "Unknown" + ], + "x-ms-enum": { + "name": "WarmStoragePropertiesState", + "modelAsString": true + } + }, + "stateDetails": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WarmStoragePropertiesUsageStateDetails", + "description": "An object that contains the details about warm storage properties usage state." + } + } + }, + "WarmStoragePropertiesUsageStateDetails": { + "readOnly": true, + "type": "object", + "description": "An object that contains the details about warm storage properties usage state.", + "properties": { + "currentCount": { + "format": "int32", + "type": "integer", + "description": "A value that represents the number of properties used by the environment for S1/S2 SKU and number of properties used by Warm Store for PAYG SKU", + "minimum": 1, + "maximum": 10 + }, + "maxCount": { + "format": "int32", + "type": "integer", + "description": "A value that represents the maximum number of properties used allowed by the environment for S1/S2 SKU and maximum number of properties allowed by Warm Store for PAYG SKU.", + "minimum": 1, + "maximum": 10 + } + } + }, + "IngressStartAtProperties": { + "type": "object", + "description": "An object that contains the details about the starting point in time to ingest events.", + "properties": { + "type": { + "type": "string", + "description": "The type of the ingressStartAt, It can be \"EarliestAvailable\", \"EventSourceCreationTime\", \"CustomEnqueuedTime\".", + "enum": [ + "EarliestAvailable", + "EventSourceCreationTime", + "CustomEnqueuedTime" + ], + "x-ms-enum": { + "name": "IngressStartAtType", + "modelAsString": true + } + }, + "time": { + "type": "string", + "description": "ISO8601 UTC datetime with seconds precision (milliseconds are optional), specifying the date and time that will be the starting point for Events to be consumed." + } + } + }, + "EventSourceCreateOrUpdateParameters": { + "discriminator": "kind", + "properties": { + "kind": { + "type": "string", + "description": "The kind of the event source.", + "enum": [ + "Microsoft.EventHub", + "Microsoft.IoTHub" + ], + "x-ms-enum": { + "name": "EventSourceKind", + "modelAsString": true + } + }, + "localTimestamp": { + "$ref": "#/definitions/LocalTimestamp", + "description": "An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events." + } + }, + "required": [ + "kind" + ], + "allOf": [ + { + "$ref": "#/definitions/CreateOrUpdateTrackedResourceProperties" + } + ], + "description": "Parameters supplied to the Create or Update Event Source operation." + }, + "EventHubEventSourceCreateOrUpdateParameters": { + "x-ms-discriminator-value": "Microsoft.EventHub", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EventHubEventSourceCreationProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/EventSourceCreateOrUpdateParameters" + } + ], + "description": "Parameters supplied to the Create or Update Event Source operation for an EventHub event source." + }, + "IoTHubEventSourceCreateOrUpdateParameters": { + "x-ms-discriminator-value": "Microsoft.IoTHub", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IoTHubEventSourceCreationProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/EventSourceCreateOrUpdateParameters" + } + ], + "description": "Parameters supplied to the Create or Update Event Source operation for an IoTHub event source." + }, + "EventSourceUpdateParameters": { + "discriminator": "kind", + "type": "object", + "properties": { + "kind": { + "type": "string", + "description": "The kind of the event source.", + "enum": [ + "Microsoft.EventHub", + "Microsoft.IoTHub" + ], + "x-ms-enum": { + "name": "EventSourceKind", + "modelAsString": true + } + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs of additional properties for the event source." + } + }, + "required": [ + "kind" + ], + "description": "Parameters supplied to the Update Event Source operation." + }, + "EventHubEventSourceUpdateParameters": { + "type": "object", + "x-ms-discriminator-value": "Microsoft.EventHub", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EventHubEventSourceMutableProperties", + "description": "Properties of the EventHub event source." + } + }, + "allOf": [ + { + "$ref": "#/definitions/EventSourceUpdateParameters" + } + ], + "description": "Parameters supplied to the Update Event Source operation to update an EventHub event source." + }, + "IoTHubEventSourceUpdateParameters": { + "x-ms-discriminator-value": "Microsoft.IoTHub", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IoTHubEventSourceMutableProperties", + "description": "Properties of the IoTHub event source." + } + }, + "allOf": [ + { + "$ref": "#/definitions/EventSourceUpdateParameters" + } + ], + "description": "Parameters supplied to the Update Event Source operation to update an IoTHub event source." + }, + "EventSourceListResponse": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EventSourceResource" + }, + "description": "Result of the List EventSources operation." + } + }, + "description": "The response of the List EventSources operation." + }, + "EventSourceResource": { + "type": "object", + "discriminator": "kind", + "properties": { + "kind": { + "type": "string", + "description": "The kind of the event source.", + "enum": [ + "Microsoft.EventHub", + "Microsoft.IoTHub" + ] + } + }, + "required": [ + "kind" + ], + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "description": "An environment receives data from one or more event sources. Each event source has associated connection info that allows the Time Series Insights ingress pipeline to connect to and pull data from the event source" + }, + "EventHubEventSourceResource": { + "x-ms-discriminator-value": "Microsoft.EventHub", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EventHubEventSourceResourceProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/EventSourceResource" + } + ], + "description": "An event source that receives its data from an Azure EventHub." + }, + "IoTHubEventSourceResource": { + "x-ms-discriminator-value": "Microsoft.IoTHub", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IoTHubEventSourceResourceProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/EventSourceResource" + } + ], + "description": "An event source that receives its data from an Azure IoTHub." + }, + "EventSourceCommonProperties": { + "properties": { + "timestampPropertyName": { + "type": "string", + "description": "The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used." + }, + "localTimestamp": { + "$ref": "#/definitions/LocalTimestamp", + "description": "An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events." + }, + "ingressStartAt": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IngressStartAtProperties", + "description": "An object that contains the details about the starting point in time to ingest events." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceProperties" + } + ], + "description": "Properties of the event source." + }, + "AzureEventSourceProperties": { + "properties": { + "eventSourceResourceId": { + "type": "string", + "description": "The resource id of the event source in Azure Resource Manager." + } + }, + "allOf": [ + { + "$ref": "#/definitions/EventSourceCommonProperties" + } + ], + "required": [ + "eventSourceResourceId" + ], + "description": "Properties of an event source that reads events from an event broker in Azure." + }, + "EventHubEventSourceCommonProperties": { + "properties": { + "serviceBusNamespace": { + "type": "string", + "description": "The name of the service bus that contains the event hub." + }, + "eventHubName": { + "type": "string", + "description": "The name of the event hub." + }, + "consumerGroupName": { + "type": "string", + "description": "The name of the event hub's consumer group that holds the partitions from which events will be read." + }, + "keyName": { + "type": "string", + "description": "The name of the SAS key that grants the Time Series Insights service access to the event hub. The shared access policies for this key must grant 'Listen' permissions to the event hub." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureEventSourceProperties" + } + ], + "required": [ + "serviceBusNamespace", + "eventHubName", + "consumerGroupName", + "keyName" + ], + "description": "Properties of the EventHub event source." + }, + "EventHubEventSourceCreationProperties": { + "properties": { + "sharedAccessKey": { + "type": "string", + "description": "The value of the shared access key that grants the Time Series Insights service read access to the event hub. This property is not shown in event source responses." + } + }, + "allOf": [ + { + "$ref": "#/definitions/EventHubEventSourceCommonProperties" + } + ], + "required": [ + "sharedAccessKey" + ], + "description": "Properties of the EventHub event source that are required on create or update requests." + }, + "EventHubEventSourceResourceProperties": { + "allOf": [ + { + "$ref": "#/definitions/EventHubEventSourceCommonProperties" + } + ], + "description": "Properties of the EventHub event source resource." + }, + "IoTHubEventSourceCommonProperties": { + "properties": { + "iotHubName": { + "type": "string", + "description": "The name of the iot hub." + }, + "consumerGroupName": { + "type": "string", + "description": "The name of the iot hub's consumer group that holds the partitions from which events will be read." + }, + "keyName": { + "type": "string", + "description": "The name of the Shared Access Policy key that grants the Time Series Insights service access to the iot hub. This shared access policy key must grant 'service connect' permissions to the iot hub." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureEventSourceProperties" + } + ], + "required": [ + "iotHubName", + "consumerGroupName", + "keyName" + ], + "description": "Properties of the IoTHub event source." + }, + "IoTHubEventSourceCreationProperties": { + "properties": { + "sharedAccessKey": { + "type": "string", + "description": "The value of the Shared Access Policy key that grants the Time Series Insights service read access to the iot hub. This property is not shown in event source responses." + } + }, + "allOf": [ + { + "$ref": "#/definitions/IoTHubEventSourceCommonProperties" + } + ], + "required": [ + "sharedAccessKey" + ], + "description": "Properties of the IoTHub event source that are required on create or update requests." + }, + "IoTHubEventSourceResourceProperties": { + "allOf": [ + { + "$ref": "#/definitions/IoTHubEventSourceCommonProperties" + } + ], + "description": "Properties of the IoTHub event source resource." + }, + "LocalTimestamp": { + "description": "An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.", + "type": "object", + "properties": { + "format": { + "description": "An enum that represents the format of the local timestamp property that needs to be set.", + "type": "string", + "enum": [ + "Embedded" + ], + "x-ms-enum": { + "name": "LocalTimestampFormat", + "modelAsString": true + } + }, + "timeZoneOffset": { + "description": "An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded.", + "type": "object", + "properties": { + "propertyName": { + "type": "string", + "description": "The event property that will be contain the offset information to calculate the local timestamp. When the LocalTimestampFormat is Iana, the property name will contain the name of the column which contains IANA Timezone Name (eg: Americas/Los Angeles). When LocalTimestampFormat is Timespan, it contains the name of property which contains values representing the offset (eg: P1D or 1.00:00:00)" + } + } + } + } + }, + "EventSourceMutableProperties": { + "description": "An object that represents a set of mutable event source resource properties.", + "type": "object", + "properties": { + "timestampPropertyName": { + "type": "string", + "description": "The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used." + } + } + }, + "EventHubEventSourceMutableProperties": { + "description": "An object that represents a set of mutable EventHub event source resource properties.", + "type": "object", + "properties": { + "sharedAccessKey": { + "type": "string", + "description": "The value of the shared access key that grants the Time Series Insights service read access to the event hub. This property is not shown in event source responses." + } + }, + "allOf": [ + { + "$ref": "#/definitions/EventSourceMutableProperties" + } + ] + }, + "IoTHubEventSourceMutableProperties": { + "description": "An object that represents a set of mutable IoTHub event source resource properties.", + "type": "object", + "properties": { + "sharedAccessKey": { + "type": "string", + "description": "The value of the shared access key that grants the Time Series Insights service read access to the iot hub. This property is not shown in event source responses." + } + }, + "allOf": [ + { + "$ref": "#/definitions/EventSourceMutableProperties" + } + ] + }, + "ReferenceDataSetCreateOrUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ReferenceDataSetCreationProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/CreateOrUpdateTrackedResourceProperties" + } + ] + }, + "ReferenceDataSetUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs of additional properties for the reference data set." + } + }, + "description": "Parameters supplied to the Update Reference Data Set operation." + }, + "ReferenceDataSetListResponse": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ReferenceDataSetResource" + }, + "description": "Result of the List Reference Data Sets operation." + } + }, + "description": "The response of the List Reference Data Sets operation." + }, + "ReferenceDataSetResource": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ReferenceDataSetResourceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "description": "A reference data set provides metadata about the events in an environment. Metadata in the reference data set will be joined with events as they are read from event sources. The metadata that makes up the reference data set is uploaded or modified through the Time Series Insights data plane APIs." + }, + "ReferenceDataSetCreationProperties": { + "properties": { + "keyProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/ReferenceDataSetKeyProperty" + }, + "description": "The list of key properties for the reference data set." + }, + "dataStringComparisonBehavior": { + "type": "string", + "description": "The reference data set key comparison behavior can be set using this property. By default, the value is 'Ordinal' - which means case sensitive key comparison will be performed while joining reference data with events or while adding new reference data. When 'OrdinalIgnoreCase' is set, case insensitive comparison will be used.", + "enum": [ + "Ordinal", + "OrdinalIgnoreCase" + ], + "x-ms-enum": { + "name": "DataStringComparisonBehavior", + "modelAsString": true + } + } + }, + "required": [ + "keyProperties" + ], + "description": "Properties used to create a reference data set." + }, + "ReferenceDataSetResourceProperties": { + "allOf": [ + { + "$ref": "#/definitions/ReferenceDataSetCreationProperties" + }, + { + "$ref": "#/definitions/ResourceProperties" + } + ], + "required": [ + "keyProperties" + ], + "description": "Properties of the reference data set." + }, + "ReferenceDataSetKeyProperty": { + "properties": { + "name": { + "type": "string", + "description": "The name of the key property." + }, + "type": { + "type": "string", + "description": "The type of the key property.", + "enum": [ + "String", + "Double", + "Bool", + "DateTime" + ], + "x-ms-enum": { + "name": "ReferenceDataKeyPropertyType", + "modelAsString": true + } + } + }, + "description": "A key property for the reference data set. A reference data set can have multiple key properties." + }, + "AccessPolicyCreateOrUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessPolicyResourceProperties" + } + }, + "required": [ + "properties" + ] + }, + "AccessPolicyUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessPolicyMutableProperties" + } + } + }, + "AccessPolicyListResponse": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AccessPolicyResource" + }, + "description": "Result of the List access policies operation." + } + }, + "description": "The response of the List access policies operation." + }, + "AccessPolicyResource": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessPolicyResourceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "An access policy is used to grant users and applications access to the environment. Roles are assigned to service principals in Azure Active Directory. These roles define the actions the principal can perform through the Time Series Insights data plane APIs." + }, + "AccessPolicyResourceProperties": { + "properties": { + "principalObjectId": { + "type": "string", + "description": "The objectId of the principal in Azure Active Directory.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "description": { + "type": "string", + "description": "An description of the access policy." + }, + "roles": { + "type": "array", + "items": { + "type": "string", + "description": "A role defining the data plane operations that a principal can perform on a Time Series Insights client.", + "enum": [ + "Reader", + "Contributor" + ], + "x-ms-enum": { + "name": "AccessPolicyRole", + "modelAsString": true + } + }, + "description": "The list of roles the principal is assigned on the environment." + } + } + }, + "AccessPolicyMutableProperties": { + "description": "An object that represents a set of mutable access policy resource properties.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "An description of the access policy." + }, + "roles": { + "type": "array", + "items": { + "type": "string", + "description": "A role defining the data plane operations that a principal can perform on a Time Series Insights client.", + "enum": [ + "Reader", + "Contributor" + ], + "x-ms-enum": { + "name": "AccessPolicyRole", + "modelAsString": true + } + }, + "description": "The list of roles the principal is assigned on the environment." + } + } + }, + "CloudError": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "Describes a particular API error with an error code and a message." + } + }, + "description": "Contains information about an API error.", + "x-ms-external": true + }, + "CloudErrorBody": { + "type": "object", + "description": "Describes a particular API error with an error code and a message.", + "properties": { + "code": { + "type": "string", + "description": "An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases." + }, + "message": { + "type": "string", + "description": "A message that describes the error in detail and provides debugging information." + }, + "target": { + "type": "string", + "description": "The target of the particular error (for example, the name of the property in error)." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody", + "description": "Describes a particular API error with an error code and a message." + }, + "description": "Contains nested errors that are related to this error." + } + }, + "x-ms-external": true + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request." + }, + "ExpandParameter": { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Setting $expand=status will include the status of the internal services of the environment in the Time Series Insights service." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Name of an Azure Resource group." + }, + "EnvironmentNameParameter": { + "name": "environmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Time Series Insights environment associated with the specified resource group.", + "x-ms-parameter-location": "method" + }, + "EventSourceNameParameter": { + "name": "eventSourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Time Series Insights event source associated with the specified environment.", + "x-ms-parameter-location": "method" + }, + "ReferenceDataSetNameParameter": { + "name": "referenceDataSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Time Series Insights reference data set associated with the specified environment.", + "x-ms-parameter-location": "method" + }, + "AccessPolicyNameParameter": { + "name": "accessPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Time Series Insights access policy associated with the specified environment.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesCreateEventHub.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesCreateEventHub.json index 70ada05d2e07..f4f975129574 100644 --- a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesCreateEventHub.json +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesCreateEventHub.json @@ -14,7 +14,16 @@ "eventHubName": "ehn", "keyName": "managementKey", "sharedAccessKey": "someSecretvalue", - "timestampPropertyName": "someTimestampProperty" + "timestampPropertyName": "someTimestampProperty", + "localTimestamp": { + "format": "TimeSpan", + "timeZoneOffset": { + "propertyName": "someEventPropertyName" + } + }, + "ingressStartAt": { + "type": "EarliestAvailable" + } } }, "api-version": "2020-05-15" @@ -35,7 +44,16 @@ "eventHubName": "ehn", "keyName": "managementKey", "provisioningState": "Succeeded", - "creationTime": "2017-04-18T19:20:33.2288820Z" + "creationTime": "2017-04-18T19:20:33.2288820Z", + "localTimestamp": { + "format": "TimeSpan", + "timeZoneOffset": { + "propertyName": "someEventPropertyName" + } + }, + "ingressStartAt": { + "type": "EarliestAvailable" + } } } }, @@ -54,7 +72,16 @@ "eventHubName": "ehn", "keyName": "managementKey", "provisioningState": "Succeeded", - "creationTime": "2017-04-18T19:20:33.2288820Z" + "creationTime": "2017-04-18T19:20:33.2288820Z", + "localTimestamp": { + "format": "TimeSpan", + "timeZoneOffset": { + "propertyName": "someEventPropertyName" + } + }, + "ingressStartAt": { + "type": "EarliestAvailable" + } } } } diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesCreateEventHubWithCustomEnquedTime.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesCreateEventHubWithCustomEnquedTime.json new file mode 100644 index 000000000000..67397fde8632 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesCreateEventHubWithCustomEnquedTime.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "eventSourceName": "es1", + "parameters": { + "location": "West US", + "kind": "Microsoft.EventHub", + "properties": { + "eventSourceResourceId": "somePathInArm", + "serviceBusNamespace": "sbn", + "consumerGroupName": "cgn", + "eventHubName": "ehn", + "keyName": "managementKey", + "sharedAccessKey": "someSecretvalue", + "timestampPropertyName": "someTimestampProperty", + "ingressStartAt": { + "type": "CustomEnqueuedTime", + "time": "2017-04-01T19:20:33.2288820Z" + } + } + }, + "api-version": "2020-05-15" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/eventSources/es1", + "location": "West US", + "name": "es1", + "type": "Microsoft.TimeSeriesInsights/Environments/EventSources", + "tags": {}, + "kind": "Microsoft.EventHub", + "properties": { + "eventSourceResourceId": "somePathInArm", + "serviceBusNamespace": "sbn", + "consumerGroupName": "cgn", + "eventHubName": "ehn", + "keyName": "managementKey", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z", + "ingressStartAt": { + "type": "CustomEnqueuedTime", + "time": "2017-04-01T19:20:33.2288820Z" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/eventSources/es1", + "location": "West US", + "name": "es1", + "type": "Microsoft.TimeSeriesInsights/Environments/EventSources", + "tags": {}, + "kind": "Microsoft.EventHub", + "properties": { + "eventSourceResourceId": "somePathInArm", + "serviceBusNamespace": "sbn", + "consumerGroupName": "cgn", + "eventHubName": "ehn", + "keyName": "managementKey", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z", + "ingressStartAt": { + "type": "CustomEnqueuedTime", + "time": "2017-04-01T19:20:33.2288820Z" + } + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesGetEventHub.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesGetEventHub.json index 610270bd8d01..652e5ae11835 100644 --- a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesGetEventHub.json +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesGetEventHub.json @@ -22,7 +22,16 @@ "eventHubName": "ehn", "keyName": "managementKey", "provisioningState": "Succeeded", - "creationTime": "2017-04-18T19:20:33.2288820Z" + "creationTime": "2017-04-18T19:20:33.2288820Z", + "localTimestamp": { + "format": "TimeSpan", + "timeZoneOffset": { + "propertyName": "someEventPropertyName" + } + }, + "ingressStartAt": { + "type": "EarliestAvailable" + } } } } diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesListByEnvironment.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesListByEnvironment.json index 09aae4112733..2a05758b173a 100644 --- a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesListByEnvironment.json +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesListByEnvironment.json @@ -23,7 +23,16 @@ "eventHubName": "ehn", "keyName": "managementKey", "provisioningState": "Succeeded", - "creationTime": "2017-04-18T19:20:33.2288820Z" + "creationTime": "2017-04-18T19:20:33.2288820Z", + "localTimestamp": { + "format": "TimeSpan", + "timeZoneOffset": { + "propertyName": "someEventPropertyName" + } + }, + "ingressStartAt": { + "type": "EarliestAvailable" + } } } ] diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesPatchTags.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesPatchTags.json index 0473904851c2..1e86b5be3c74 100644 --- a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesPatchTags.json +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesPatchTags.json @@ -30,7 +30,16 @@ "keyName": "managementKey", "provisioningState": "Succeeded", "creationTime": "2017-04-18T19:20:33.2288820Z", - "timestampPropertyName": "someOtherTimestampProperty" + "timestampPropertyName": "someOtherTimestampProperty", + "localTimestamp": { + "format": "TimeSpan", + "timeZoneOffset": { + "propertyName": "someEventPropertyName" + } + }, + "ingressStartAt": { + "type": "EarliestAvailable" + } } } } diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/Operation_List.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/Operation_List.json index a418b7799b6d..a85d4586904b 100644 --- a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/Operation_List.json +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/Operation_List.json @@ -7,6 +7,7 @@ "body": { "value": [ { + "origin": "user,system", "name": "Microsoft.TimeSeriesInsights/register/action", "display": { "provider": "Microsoft Time Series Insights", @@ -16,6 +17,361 @@ } }, { + "origin": "system", + "name": "Microsoft.TimeSeriesInsights/environments/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "The metrics definition of environments", + "operation": "Read environments metric definitions", + "description": "Gets the available metrics for environments" + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "IngressReceivedMessages", + "displayName": "Ingress Received Messages", + "displayDescription": "Count of messages read from all Event hub or IoT hub event sources", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "IngressReceivedInvalidMessages", + "displayName": "Ingress Received Invalid Messages", + "displayDescription": "Count of invalid messages read from all Event hub or IoT hub event sources", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "IngressReceivedBytes", + "displayName": "Ingress Received Bytes", + "displayDescription": "Count of bytes read from all event sources", + "unit": "Bytes", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "IngressStoredBytes", + "displayName": "Ingress Stored Bytes", + "displayDescription": "Total size of events successfully processed and available for query", + "unit": "Bytes", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "IngressStoredEvents", + "displayName": "Ingress Stored Events", + "displayDescription": "Count of flattened events successfully processed and available for query", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "IngressReceivedMessagesTimeLag", + "displayName": "Ingress Received Messages Time Lag", + "displayDescription": "Difference between the time that the message is enqueued in the event source and the time it is processed in Ingress", + "unit": "Seconds", + "aggregationType": "Maximum", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "IngressReceivedMessagesCountLag", + "displayName": "Ingress Received Messages Count Lag", + "displayDescription": "Difference between the sequence number of last enqueued message in the event source partition and sequence number of messages being processed in Ingress", + "unit": "Count", + "aggregationType": "Average", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "WarmStorageMaxProperties", + "displayName": "Warm Storage Max Properties", + "displayDescription": "Maximum number of properties used allowed by the environment for S1/S2 SKU and maximum number of properties allowed by Warm Store for PAYG SKU", + "unit": "Count", + "aggregationType": "Maximum", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "WarmStorageUsedProperties", + "displayName": "Warm Storage Used Properties ", + "displayDescription": "Number of properties used by the environment for S1/S2 SKU and number of properties used by Warm Store for PAYG SKU", + "unit": "Count", + "aggregationType": "Maximum", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + } + ] + } + } + }, + { + "origin": "system", + "name": "Microsoft.TimeSeriesInsights/environments/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "environments", + "operation": "Read diagnostic setting.", + "description": "Gets the diagnostic setting for the resource" + } + }, + { + "origin": "system", + "name": "Microsoft.TimeSeriesInsights/environments/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "environments", + "operation": "Write diagnostic setting.", + "description": "Creates or updates the diagnostic setting for the resource" + } + }, + { + "origin": "system", + "name": "Microsoft.TimeSeriesInsights/environments/providers/Microsoft.Insights/logDefinitions/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "environments", + "operation": "Read environments log definitions", + "description": "Gets the available logs for environments" + }, + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "Ingress", + "displayName": "Ingress" + }, + { + "name": "Management", + "displayName": "Management" + } + ] + } + } + }, + { + "origin": "system", + "name": "Microsoft.TimeSeriesInsights/environments/eventsources/providers/Microsoft.Insights/logDefinitions/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Event Source", + "operation": "Read event source log definitions", + "description": "Gets the available logs for the event source" + }, + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "Ingress", + "displayName": "Ingress" + }, + { + "name": "Management", + "displayName": "Management" + } + ] + } + } + }, + { + "origin": "system", + "name": "Microsoft.TimeSeriesInsights/environments/eventsources/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "The metrics definition of environments/eventsources", + "operation": "Read eventsources metric definitions", + "description": "Gets the available metrics for eventsources" + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "IngressReceivedMessages", + "displayName": "Ingress Received Messages", + "displayDescription": "Count of messages read from the event source", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "IngressReceivedInvalidMessages", + "displayName": "Ingress Received Invalid Messages", + "displayDescription": "Count of invalid messages read from the event source", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "IngressReceivedBytes", + "displayName": "Ingress Received Bytes", + "displayDescription": "Count of bytes read from the event source", + "unit": "Bytes", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "IngressStoredBytes", + "displayName": "Ingress Stored Bytes", + "displayDescription": "Total size of events successfully processed and available for query", + "unit": "Bytes", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "IngressStoredEvents", + "displayName": "Ingress Stored Events", + "displayDescription": "Count of flattened events successfully processed and available for query", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "IngressReceivedMessagesTimeLag", + "displayName": "Ingress Received Messages Time Lag", + "displayDescription": "Difference between the time that the message is enqueued in the event source and the time it is processed in Ingress", + "unit": "Seconds", + "aggregationType": "Maximum", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "IngressReceivedMessagesCountLag", + "displayName": "Ingress Received Messages Count Lag", + "displayDescription": "Difference between the sequence number of last enqueued message in the event source partition and sequence number of messages being processed in Ingress", + "unit": "Count", + "aggregationType": "Average", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "WarmStorageMaxProperties", + "displayName": "Warm Storage Max Properties", + "displayDescription": "Maximum number of properties used allowed by the environment for S1/S2 SKU and maximum number of properties allowed by Warm Store for PAYG SKU", + "unit": "Count", + "aggregationType": "Maximum", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + }, + { + "name": "WarmStorageUsedProperties", + "displayName": "Warm Storage Used Properties ", + "displayDescription": "Number of properties used by the environment for S1/S2 SKU and number of properties used by Warm Store for PAYG SKU", + "unit": "Count", + "aggregationType": "Maximum", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ] + } + ] + } + } + }, + { + "origin": "system", + "name": "Microsoft.TimeSeriesInsights/environments/eventsources/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "environments/eventsources", + "operation": "Read diagnostic setting.", + "description": "Gets the diagnostic setting for the resource" + } + }, + { + "origin": "system", + "name": "Microsoft.TimeSeriesInsights/environments/eventsources/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "environments/eventsources", + "operation": "Write diagnostic setting.", + "description": "Creates or updates the diagnostic setting for the resource" + } + }, + { + "origin": "user,system", "name": "Microsoft.TimeSeriesInsights/environments/read", "display": { "provider": "Microsoft Time Series Insights", @@ -25,6 +381,7 @@ } }, { + "origin": "user,system", "name": "Microsoft.TimeSeriesInsights/environments/write", "display": { "provider": "Microsoft Time Series Insights", @@ -34,6 +391,7 @@ } }, { + "origin": "user,system", "name": "Microsoft.TimeSeriesInsights/environments/delete", "display": { "provider": "Microsoft Time Series Insights", @@ -43,6 +401,17 @@ } }, { + "origin": "user,system", + "name": "Microsoft.TimeSeriesInsights/environments/status/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Environment", + "operation": "Read Environment status", + "description": "Get the status of the environment, state of its associated operations like ingress." + } + }, + { + "origin": "user,system", "name": "Microsoft.TimeSeriesInsights/environments/eventsources/read", "display": { "provider": "Microsoft Time Series Insights", @@ -52,6 +421,7 @@ } }, { + "origin": "user,system", "name": "Microsoft.TimeSeriesInsights/environments/eventsources/write", "display": { "provider": "Microsoft Time Series Insights", @@ -61,6 +431,7 @@ } }, { + "origin": "user,system", "name": "Microsoft.TimeSeriesInsights/environments/eventsources/delete", "display": { "provider": "Microsoft Time Series Insights", @@ -70,6 +441,7 @@ } }, { + "origin": "user,system", "name": "Microsoft.TimeSeriesInsights/environments/referencedatasets/read", "display": { "provider": "Microsoft Time Series Insights", @@ -79,6 +451,7 @@ } }, { + "origin": "user,system", "name": "Microsoft.TimeSeriesInsights/environments/referencedatasets/write", "display": { "provider": "Microsoft Time Series Insights", @@ -88,6 +461,7 @@ } }, { + "origin": "user,system", "name": "Microsoft.TimeSeriesInsights/environments/referencedatasets/delete", "display": { "provider": "Microsoft Time Series Insights", @@ -97,6 +471,7 @@ } }, { + "origin": "user,system", "name": "Microsoft.TimeSeriesInsights/environments/accesspolicies/read", "display": { "provider": "Microsoft Time Series Insights", @@ -106,6 +481,7 @@ } }, { + "origin": "user,system", "name": "Microsoft.TimeSeriesInsights/environments/accesspolicies/write", "display": { "provider": "Microsoft Time Series Insights", @@ -115,6 +491,7 @@ } }, { + "origin": "user,system", "name": "Microsoft.TimeSeriesInsights/environments/accesspolicies/delete", "display": { "provider": "Microsoft Time Series Insights", @@ -122,6 +499,86 @@ "operation": "Delete Access Policy", "description": "Deletes the access policy." } + }, + { + "origin": "system", + "name": "Microsoft.TimeSeriesInsights/environments/privateEndpointConnectionProxies/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Private endpoint connection proxy", + "operation": "Read private endpoint connection proxy", + "description": "Get the properties of a private endpoint connection proxy." + } + }, + { + "origin": "system", + "name": "Microsoft.TimeSeriesInsights/environments/privateEndpointConnectionProxies/write", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Private endpoint connection proxy", + "operation": "Create or Update private endpoint connection proxy", + "description": "Creates a new private endpoint connection proxy for an environment, or updates an existing connection proxy." + } + }, + { + "origin": "system", + "name": "Microsoft.TimeSeriesInsights/environments/privateEndpointConnectionProxies/delete", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Private endpoint connection proxy", + "operation": "Delete the private endpoint connection proxy", + "description": "Deletes the private endpoint connection proxy." + } + }, + { + "origin": "system", + "name": "Microsoft.TimeSeriesInsights/environments/privateEndpointConnectionProxies/validate/action", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Private endpoint connection proxy", + "operation": "Validate the private endpoint connection proxy.", + "description": "Validate the private endpoint connection proxy object before creation." + } + }, + { + "origin": "system", + "name": "Microsoft.TimeSeriesInsights/environments/privateEndpointConnectionProxies/operationresults/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Private endpoint connection proxy", + "operation": "Get private endpoint connection proxy operation status.", + "description": "Validate the private endpoint connection proxy operation status." + } + }, + { + "origin": "user,system", + "name": "Microsoft.TimeSeriesInsights/environments/privateendpointConnections/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Private endpoint connection.", + "operation": "Read private endpoint connection.", + "description": "Get the properties of a private endpoint connection." + } + }, + { + "origin": "user,system", + "name": "Microsoft.TimeSeriesInsights/environments/privateendpointConnections/write", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Private endpoint connection.", + "operation": "Create or Update private endpoint connection.", + "description": "Creates a new private endpoint connection for an environment, or updates an existing connection." + } + }, + { + "origin": "user,system", + "name": "Microsoft.TimeSeriesInsights/environments/privateendpointConnections/delete", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Private endpoint connection", + "operation": "Delete the private endpoint connection", + "description": "Deletes the private endpoint connection." + } } ] } diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json index 4bd8ce2a695c..70a83a726550 100644 --- a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json @@ -355,6 +355,9 @@ "x-ms-examples": { "CreateEventHubEventSource": { "$ref": "./examples/EventSourcesCreateEventHub.json" + }, + "EventSourcesCreateEventHubWithCustomEnquedTime": { + "$ref": "./examples/EventSourcesCreateEventHubWithCustomEnquedTime.json" } }, "description": "Create or update an event source under the specified environment.", @@ -1141,6 +1144,135 @@ "readOnly": true } } + }, + "origin": { + "title": "The intended executor of the operation.", + "type": "string" + }, + "properties": { + "title": "Properties of the operation, including metric specifications.", + "type": "object", + "x-ms-client-flatten": true, + "x-ms-client-name": "OperationProperties", + "$ref": "#/definitions/OperationProperties" + } + } + }, + "OperationProperties": { + "description": "Properties of operation, include metric specifications.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "One property of operation, include metric specifications." + } + } + }, + "ServiceSpecification": { + "description": "One property of operation, include metric specifications.", + "type": "object", + "properties": { + "metricSpecifications": { + "description": "Metric specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + } + }, + "logSpecifications": { + "description": "A list of Azure Monitoring log definitions.", + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + } + } + } + }, + "MetricSpecification": { + "description": "Metric specification of operation.", + "type": "object", + "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." + }, + "dimensions": { + "description": "Dimensions of blobs, including blob type and access tier.", + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + } + }, + "aggregationType": { + "type": "string", + "description": "Aggregation type could be Average." + }, + "availabilities": { + "description": "Retention policies of a resource metric.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricAvailability" + } + }, + "category": { + "type": "string", + "description": "The category this metric specification belong to, could be Capacity." + }, + "resourceIdDimensionNameOverride": { + "type": "string", + "description": "Account Resource Id." + } + } + }, + "LogSpecification": { + "description": "The specification of an Azure Monitoring log.", + "type": "object", + "properties": { + "name": { + "description": "Log name.", + "type": "string" + }, + "displayName": { + "description": "Log display name.", + "type": "string" + } + } + }, + "Dimension": { + "description": "Dimension of blobs, possibly be blob type or access tier.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Display name of dimension." + }, + "displayName": { + "type": "string", + "description": "Display name of dimension." + } + } + }, + "MetricAvailability": { + "description": "Retention policy of a resource metric.", + "type": "object", + "properties": { + "timeGrain": { + "type": "string" + }, + "blobDuration": { + "type": "string" } } }, @@ -1350,7 +1482,11 @@ "x-ms-enum": { "name": "EnvironmentKind", "modelAsString": true - } + }, + "x-ms-mutability": [ + "create", + "read" + ] }, "sku": { "$ref": "#/definitions/Sku", @@ -1410,7 +1546,6 @@ "properties": { "kind": { "type": "string", - "readOnly": true, "description": "The kind of the environment.", "enum": [ "Gen1", @@ -1429,6 +1564,9 @@ "description": "Key-value pairs of additional properties for the environment." } }, + "required": [ + "kind" + ], "description": "Parameters supplied to the Update Environment operation." }, "Gen1EnvironmentUpdateParameters": { @@ -1843,6 +1981,29 @@ } } }, + "IngressStartAtProperties": { + "type": "object", + "description": "An object that contains the details about the starting point in time to ingest events.", + "properties": { + "type": { + "type": "string", + "description": "The type of the ingressStartAt, It can be \"EarliestAvailable\", \"EventSourceCreationTime\", \"CustomEnqueuedTime\".", + "enum": [ + "EarliestAvailable", + "EventSourceCreationTime", + "CustomEnqueuedTime" + ], + "x-ms-enum": { + "name": "IngressStartAtType", + "modelAsString": true + } + }, + "time": { + "type": "string", + "description": "ISO8601 UTC datetime with seconds precision (milliseconds are optional), specifying the date and time that will be the starting point for Events to be consumed." + } + } + }, "EventSourceCreateOrUpdateParameters": { "discriminator": "kind", "properties": { @@ -1915,7 +2076,6 @@ "properties": { "kind": { "type": "string", - "readOnly": true, "description": "The kind of the event source.", "enum": [ "Microsoft.EventHub", @@ -1934,6 +2094,9 @@ "description": "Key-value pairs of additional properties for the event source." } }, + "required": [ + "kind" + ], "description": "Parameters supplied to the Update Event Source operation." }, "EventHubEventSourceUpdateParameters": { @@ -2046,6 +2209,15 @@ "timestampPropertyName": { "type": "string", "description": "The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used." + }, + "localTimestamp": { + "$ref": "#/definitions/LocalTimestamp", + "description": "An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events." + }, + "ingressStartAt": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IngressStartAtProperties", + "description": "An object that contains the details about the starting point in time to ingest events." } }, "allOf": [ @@ -2215,10 +2387,6 @@ "timestampPropertyName": { "type": "string", "description": "The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used." - }, - "localTimestamp": { - "$ref": "#/definitions/LocalTimestamp", - "description": "An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events." } } }, @@ -2420,7 +2588,11 @@ "properties": { "principalObjectId": { "type": "string", - "description": "The objectId of the principal in Azure Active Directory." + "description": "The objectId of the principal in Azure Active Directory.", + "x-ms-mutability": [ + "create", + "read" + ] }, "description": { "type": "string", diff --git a/specification/timeseriesinsights/resource-manager/readme.md b/specification/timeseriesinsights/resource-manager/readme.md index 8e2763cc2876..4c16fc7aa972 100644 --- a/specification/timeseriesinsights/resource-manager/readme.md +++ b/specification/timeseriesinsights/resource-manager/readme.md @@ -15,6 +15,7 @@ To build the SDK for TimeSeriesInsights, simply [Install AutoRest](https://aka.m To see additional help and options, run: > `autorest --help` + --- ## Configuration @@ -25,9 +26,18 @@ These are the global settings for the TimeSeriesInsights API. ``` yaml openapi-type: arm -tag: package-2020-05-15 +tag: package-preview-2021-06 ``` + +### Tag: package-preview-2021-06 + +These settings apply only when `--tag=package-preview-2021-06` is specified on the command line. + +```yaml $(tag) == 'package-preview-2021-06' +input-file: + - Microsoft.TimeSeriesInsights/preview/2021-06-30-preview/timeseriesinsights.json +``` ### Tag: package-2020-05-15 These settings apply only when `--tag=package-2020-05-15` is specified on the command line. @@ -101,8 +111,8 @@ directive: ``` --- -# Code Generation +# Code Generation ## Swagger to SDK @@ -115,7 +125,6 @@ swagger-to-sdk: - repo: azure-sdk-for-go - repo: azure-sdk-for-node - repo: azure-sdk-for-js - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-resource-manager-schemas ``` @@ -203,6 +212,3 @@ java: regenerate-manager: true generate-interface: true ``` - - - diff --git a/specification/timeseriesinsights/resource-manager/readme.python.md b/specification/timeseriesinsights/resource-manager/readme.python.md index 2685e1c694ba..35e69169ad92 100644 --- a/specification/timeseriesinsights/resource-manager/readme.python.md +++ b/specification/timeseriesinsights/resource-manager/readme.python.md @@ -4,37 +4,15 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.timeseriesinsights - package-name: azure-mgmt-timeseriesinsights - package-version: 0.1.0 - clear-output-folder: true -``` ``` yaml $(python) && $(track2) -python-mode: create azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.timeseriesinsights package-name: azure-mgmt-timeseriesinsights -package-version: 0.1.0 +package-version: 1.0.0b1 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' && !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/timeseriesinsights/azure-mgmt-timeseriesinsights/azure/mgmt/timeseriesinsights -``` -``` yaml $(python) && $(python-mode) == 'create' && !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/timeseriesinsights/azure-mgmt-timeseriesinsights -``` ``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true diff --git a/specification/trafficmanager/resource-manager/readme.md b/specification/trafficmanager/resource-manager/readme.md index 410aa199e403..e6f3a9a1fdf9 100644 --- a/specification/trafficmanager/resource-manager/readme.md +++ b/specification/trafficmanager/resource-manager/readme.md @@ -182,7 +182,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-libraries-for-java - repo: azure-sdk-for-go diff --git a/specification/trafficmanager/resource-manager/readme.python.md b/specification/trafficmanager/resource-manager/readme.python.md index 9cc7e779c70a..13ca7fc5fb51 100644 --- a/specification/trafficmanager/resource-manager/readme.python.md +++ b/specification/trafficmanager/resource-manager/readme.python.md @@ -2,21 +2,8 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python)&& !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.trafficmanager - package-name: azure-mgmt-trafficmanager - package-version: 1.0.0b1 - clear-output-folder: true -``` -``` yaml $(python) && $(track2) -python-mode: create +``` yaml $(track2) azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.mgmt.trafficmanager @@ -24,21 +11,13 @@ package-name: azure-mgmt-trafficmanager package-version: 1.0.0b1 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update'&& !$(track2) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/trafficmanager/azure-mgmt-trafficmanager/azure/mgmt/trafficmanager -``` -``` yaml $(python) && $(python-mode) == 'create'&& !$(track2) -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/trafficmanager/azure-mgmt-trafficmanager -``` -``` yaml $(python) && $(python-mode) == 'update' && $(track2) + +``` yaml $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/trafficmanager/azure-mgmt-trafficmanager/azure/mgmt/trafficmanager ``` -``` yaml $(python) && $(python-mode) == 'create' && $(track2) + +``` yaml $(python-mode) == 'create' && $(track2) basic-setup-py: true output-folder: $(python-sdks-folder)/trafficmanager/azure-mgmt-trafficmanager ``` diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Authorizations_List.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Authorizations_List.json index 59b726fb2677..869ce2e4e582 100644 --- a/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Authorizations_List.json +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Authorizations_List.json @@ -7,18 +7,20 @@ }, "responses": { "200": { - "body": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/authorizations/authorization1", - "name": "authorization1", - "properties": { - "provisioningState": "Succeeded", - "expressRouteAuthorizationId": "/subscriptions/5206f269-120b-41ef-a95b-0dce7109de61/resourceGroups/tnt34-cust-mockp02-spearj2dev/providers/Microsoft.Network/expressroutecircuits/tnt34-cust-mockp02-spearj2dev-er/authorizations/myauth", - "expressRouteAuthorizationKey": "37b0db3b-3b17-4c7b-bf76-bf13b01bcadc" - }, - "type": "Microsoft.AVS/privateClouds/authorizations" - } - ] + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/authorizations/authorization1", + "name": "authorization1", + "properties": { + "provisioningState": "Succeeded", + "expressRouteAuthorizationId": "/subscriptions/5206f269-120b-41ef-a95b-0dce7109de61/resourceGroups/tnt34-cust-mockp02-spearj2dev/providers/Microsoft.Network/expressroutecircuits/tnt34-cust-mockp02-spearj2dev-er/authorizations/myauth", + "expressRouteAuthorizationKey": "37b0db3b-3b17-4c7b-bf76-bf13b01bcadc" + }, + "type": "Microsoft.AVS/privateClouds/authorizations" + } + ] + } } } } diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/HcxEnterpriseSites_List.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/HcxEnterpriseSites_List.json index 68d80d3e14c4..3bae5067fb9b 100644 --- a/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/HcxEnterpriseSites_List.json +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/HcxEnterpriseSites_List.json @@ -7,17 +7,19 @@ }, "responses": { "200": { - "body": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/hcxEnterpriseSites/site1", - "name": "site1", - "properties": { - "activationKey": "0276EF1A9A1749A5A362BF73EA9F8D0D", - "status": "Available" - }, - "type": "Microsoft.AVS/privateClouds/hcxEnterpriseSites" - } - ] + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/hcxEnterpriseSites/site1", + "name": "site1", + "properties": { + "activationKey": "0276EF1A9A1749A5A362BF73EA9F8D0D", + "status": "Available" + }, + "type": "Microsoft.AVS/privateClouds/hcxEnterpriseSites" + } + ] + } } } } diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_ListInSubscription.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_ListInSubscription.json index 5f5c1555c0a9..7c3645c8d1bd 100644 --- a/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_ListInSubscription.json +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_ListInSubscription.json @@ -5,56 +5,58 @@ }, "responses": { "200": { - "body": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1", - "location": "eastus2", - "name": "cloud1", - "sku": { - "name": "AV36" - }, - "properties": { - "networkBlock": "192.168.48.0/22", - "circuit": { - "expressRouteID": "/subscriptions/{subscription-id}/resourceGroups/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2/providers/Microsoft.Network/expressroutecircuits/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2-xconnect", - "primarySubnet": "192.168.53.0/30", - "secondarySubnet": "192.168.53.4/30", - "expressRoutePrivatePeeringID": "/subscriptions/{subscription-id}/resourceGroups/tnt42-cust-p01-dmo01/providers/Microsoft.Network/expressroutecircuits/tnt42-cust-p01-dmo01-er/peerings/AzurePrivatePeering" + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1", + "location": "eastus2", + "name": "cloud1", + "sku": { + "name": "AV36" }, - "managementCluster": { - "clusterId": 1, - "clusterSize": 4, - "hosts": [ - "fakehost18.nyc1.kubernetes.center", - "fakehost19.nyc1.kubernetes.center", - "fakehost20.nyc1.kubernetes.center", - "fakehost21.nyc1.kubernetes.center" - ] + "properties": { + "networkBlock": "192.168.48.0/22", + "circuit": { + "expressRouteID": "/subscriptions/{subscription-id}/resourceGroups/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2/providers/Microsoft.Network/expressroutecircuits/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2-xconnect", + "primarySubnet": "192.168.53.0/30", + "secondarySubnet": "192.168.53.4/30", + "expressRoutePrivatePeeringID": "/subscriptions/{subscription-id}/resourceGroups/tnt42-cust-p01-dmo01/providers/Microsoft.Network/expressroutecircuits/tnt42-cust-p01-dmo01-er/peerings/AzurePrivatePeering" + }, + "managementCluster": { + "clusterId": 1, + "clusterSize": 4, + "hosts": [ + "fakehost18.nyc1.kubernetes.center", + "fakehost19.nyc1.kubernetes.center", + "fakehost20.nyc1.kubernetes.center", + "fakehost21.nyc1.kubernetes.center" + ] + }, + "endpoints": { + "nsxtManager": "https://192.168.50.3/", + "vcsa": "https://192.168.50.2/", + "hcxCloudManager": "https://192.168.50.4/" + }, + "identitySources": [ + { + "alias": "groupAlias", + "baseGroupDN": "ou=baseGroup", + "baseUserDN": "ou=baseUser", + "domain": "domain1", + "name": "group1", + "primaryServer": "ldaps://1.1.1.1:636/", + "secondaryServer": "ldaps://1.1.1.2:636/", + "ssl": "Enabled" + } + ], + "internet": "Disabled", + "provisioningState": "Succeeded" }, - "endpoints": { - "nsxtManager": "https://192.168.50.3/", - "vcsa": "https://192.168.50.2/", - "hcxCloudManager": "https://192.168.50.4/" - }, - "identitySources": [ - { - "alias": "groupAlias", - "baseGroupDN": "ou=baseGroup", - "baseUserDN": "ou=baseUser", - "domain": "domain1", - "name": "group1", - "primaryServer": "ldaps://1.1.1.1:636/", - "secondaryServer": "ldaps://1.1.1.2:636/", - "ssl": "Enabled" - } - ], - "internet": "Disabled", - "provisioningState": "Succeeded" - }, - "tags": {}, - "type": "Microsoft.AVS/privateClouds" - } - ] + "tags": {}, + "type": "Microsoft.AVS/privateClouds" + } + ] + } } } } diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2021-06-01/examples/Authorizations_List.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2021-06-01/examples/Authorizations_List.json index 4d333b67ed57..6205763451e8 100644 --- a/specification/vmware/resource-manager/Microsoft.AVS/stable/2021-06-01/examples/Authorizations_List.json +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2021-06-01/examples/Authorizations_List.json @@ -7,18 +7,20 @@ }, "responses": { "200": { - "body": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/authorizations/authorization1", - "name": "authorization1", - "properties": { - "provisioningState": "Succeeded", - "expressRouteAuthorizationId": "/subscriptions/5206f269-120b-41ef-a95b-0dce7109de61/resourceGroups/tnt34-cust-mockp02-spearj2dev/providers/Microsoft.Network/expressroutecircuits/tnt34-cust-mockp02-spearj2dev-er/authorizations/myauth", - "expressRouteAuthorizationKey": "37b0db3b-3b17-4c7b-bf76-bf13b01bcadc" - }, - "type": "Microsoft.AVS/privateClouds/authorizations" - } - ] + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/authorizations/authorization1", + "name": "authorization1", + "properties": { + "provisioningState": "Succeeded", + "expressRouteAuthorizationId": "/subscriptions/5206f269-120b-41ef-a95b-0dce7109de61/resourceGroups/tnt34-cust-mockp02-spearj2dev/providers/Microsoft.Network/expressroutecircuits/tnt34-cust-mockp02-spearj2dev-er/authorizations/myauth", + "expressRouteAuthorizationKey": "37b0db3b-3b17-4c7b-bf76-bf13b01bcadc" + }, + "type": "Microsoft.AVS/privateClouds/authorizations" + } + ] + } } } } diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2021-06-01/examples/CloudLinks_List.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2021-06-01/examples/CloudLinks_List.json index 5e8fecdaf708..c75f7d359f8c 100644 --- a/specification/vmware/resource-manager/Microsoft.AVS/stable/2021-06-01/examples/CloudLinks_List.json +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2021-06-01/examples/CloudLinks_List.json @@ -7,17 +7,19 @@ }, "responses": { "200": { - "body": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/cloudLinks/cloudLink1", - "name": "cloudLink1", - "properties": { - "status": "Active", - "linkedCloud": "/subscriptions/12341234-1234-1234-1234-123412341234/resourceGroups/mygroup/providers/Microsoft.AVS/privateClouds/cloud2" - }, - "type": "Microsoft.AVS/privateClouds/cloudLinks" - } - ] + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/cloudLinks/cloudLink1", + "name": "cloudLink1", + "properties": { + "status": "Active", + "linkedCloud": "/subscriptions/12341234-1234-1234-1234-123412341234/resourceGroups/mygroup/providers/Microsoft.AVS/privateClouds/cloud2" + }, + "type": "Microsoft.AVS/privateClouds/cloudLinks" + } + ] + } } } } diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2021-06-01/examples/GlobalReachConnections_List.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2021-06-01/examples/GlobalReachConnections_List.json index 0c48eb725809..20515cc8db53 100644 --- a/specification/vmware/resource-manager/Microsoft.AVS/stable/2021-06-01/examples/GlobalReachConnections_List.json +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2021-06-01/examples/GlobalReachConnections_List.json @@ -7,20 +7,22 @@ }, "responses": { "200": { - "body": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/globalReachConnections/connection1", - "name": "connection1", - "properties": { - "addressPrefix": "10.2.3.16/29", - "authorizationKey": "01010101-0101-0101-0101-010101010101", - "circuitConnectionStatus": "Connected", - "peerExpressRouteCircuit": "/subscriptions/12341234-1234-1234-1234-123412341234/resourceGroups/mygroup/providers/Microsoft.Network/expressRouteCircuits/mypeer", - "provisioningState": "Succeeded" - }, - "type": "Microsoft.AVS/privateClouds/globalReachConnections" - } - ] + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/globalReachConnections/connection1", + "name": "connection1", + "properties": { + "addressPrefix": "10.2.3.16/29", + "authorizationKey": "01010101-0101-0101-0101-010101010101", + "circuitConnectionStatus": "Connected", + "peerExpressRouteCircuit": "/subscriptions/12341234-1234-1234-1234-123412341234/resourceGroups/mygroup/providers/Microsoft.Network/expressRouteCircuits/mypeer", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.AVS/privateClouds/globalReachConnections" + } + ] + } } } } diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2021-06-01/examples/HcxEnterpriseSites_List.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2021-06-01/examples/HcxEnterpriseSites_List.json index a708250bbfef..6ae56e184015 100644 --- a/specification/vmware/resource-manager/Microsoft.AVS/stable/2021-06-01/examples/HcxEnterpriseSites_List.json +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2021-06-01/examples/HcxEnterpriseSites_List.json @@ -7,17 +7,19 @@ }, "responses": { "200": { - "body": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/hcxEnterpriseSites/site1", - "name": "site1", - "properties": { - "activationKey": "0276EF1A9A1749A5A362BF73EA9F8D0D", - "status": "Available" - }, - "type": "Microsoft.AVS/privateClouds/hcxEnterpriseSites" - } - ] + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/hcxEnterpriseSites/site1", + "name": "site1", + "properties": { + "activationKey": "0276EF1A9A1749A5A362BF73EA9F8D0D", + "status": "Available" + }, + "type": "Microsoft.AVS/privateClouds/hcxEnterpriseSites" + } + ] + } } } } diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2021-06-01/examples/PrivateClouds_ListInSubscription.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2021-06-01/examples/PrivateClouds_ListInSubscription.json index bb75ffd19f09..9c74e169c999 100644 --- a/specification/vmware/resource-manager/Microsoft.AVS/stable/2021-06-01/examples/PrivateClouds_ListInSubscription.json +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2021-06-01/examples/PrivateClouds_ListInSubscription.json @@ -5,56 +5,58 @@ }, "responses": { "200": { - "body": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1", - "location": "eastus2", - "name": "cloud1", - "sku": { - "name": "AV36" - }, - "properties": { - "networkBlock": "192.168.48.0/22", - "circuit": { - "expressRouteID": "/subscriptions/{subscription-id}/resourceGroups/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2/providers/Microsoft.Network/expressroutecircuits/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2-xconnect", - "primarySubnet": "192.168.53.0/30", - "secondarySubnet": "192.168.53.4/30", - "expressRoutePrivatePeeringID": "/subscriptions/{subscription-id}/resourceGroups/tnt42-cust-p01-dmo01/providers/Microsoft.Network/expressroutecircuits/tnt42-cust-p01-dmo01-er/peerings/AzurePrivatePeering" + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1", + "location": "eastus2", + "name": "cloud1", + "sku": { + "name": "AV36" }, - "managementCluster": { - "clusterId": 1, - "clusterSize": 4, - "hosts": [ - "fakehost18.nyc1.kubernetes.center", - "fakehost19.nyc1.kubernetes.center", - "fakehost20.nyc1.kubernetes.center", - "fakehost21.nyc1.kubernetes.center" - ] + "properties": { + "networkBlock": "192.168.48.0/22", + "circuit": { + "expressRouteID": "/subscriptions/{subscription-id}/resourceGroups/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2/providers/Microsoft.Network/expressroutecircuits/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2-xconnect", + "primarySubnet": "192.168.53.0/30", + "secondarySubnet": "192.168.53.4/30", + "expressRoutePrivatePeeringID": "/subscriptions/{subscription-id}/resourceGroups/tnt42-cust-p01-dmo01/providers/Microsoft.Network/expressroutecircuits/tnt42-cust-p01-dmo01-er/peerings/AzurePrivatePeering" + }, + "managementCluster": { + "clusterId": 1, + "clusterSize": 4, + "hosts": [ + "fakehost18.nyc1.kubernetes.center", + "fakehost19.nyc1.kubernetes.center", + "fakehost20.nyc1.kubernetes.center", + "fakehost21.nyc1.kubernetes.center" + ] + }, + "endpoints": { + "nsxtManager": "https://192.168.50.3/", + "vcsa": "https://192.168.50.2/", + "hcxCloudManager": "https://192.168.50.4/" + }, + "identitySources": [ + { + "alias": "groupAlias", + "baseGroupDN": "ou=baseGroup", + "baseUserDN": "ou=baseUser", + "domain": "domain1", + "name": "group1", + "primaryServer": "ldaps://1.1.1.1:636/", + "secondaryServer": "ldaps://1.1.1.2:636/", + "ssl": "Enabled" + } + ], + "internet": "Disabled", + "provisioningState": "Succeeded" }, - "endpoints": { - "nsxtManager": "https://192.168.50.3/", - "vcsa": "https://192.168.50.2/", - "hcxCloudManager": "https://192.168.50.4/" - }, - "identitySources": [ - { - "alias": "groupAlias", - "baseGroupDN": "ou=baseGroup", - "baseUserDN": "ou=baseUser", - "domain": "domain1", - "name": "group1", - "primaryServer": "ldaps://1.1.1.1:636/", - "secondaryServer": "ldaps://1.1.1.2:636/", - "ssl": "Enabled" - } - ], - "internet": "Disabled", - "provisioningState": "Succeeded" - }, - "tags": {}, - "type": "Microsoft.AVS/privateClouds" - } - ] + "tags": {}, + "type": "Microsoft.AVS/privateClouds" + } + ] + } } } } diff --git a/specification/vmware/resource-manager/readme.md b/specification/vmware/resource-manager/readme.md index e02df015746f..a95e86be9310 100644 --- a/specification/vmware/resource-manager/readme.md +++ b/specification/vmware/resource-manager/readme.md @@ -186,6 +186,7 @@ swagger-to-sdk: - repo: azure-powershell - repo: azure-sdk-for-js - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-net - repo: azure-sdk-for-go - repo: azure-sdk-for-java diff --git a/specification/vmware/resource-manager/readme.python.md b/specification/vmware/resource-manager/readme.python.md index 820af5da363e..a73f74a4f354 100644 --- a/specification/vmware/resource-manager/readme.python.md +++ b/specification/vmware/resource-manager/readme.python.md @@ -4,7 +4,7 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -```yaml +```yaml $(python) && !$(track2) python-mode: create package-version: 0.1.0 azure-arm: true @@ -15,11 +15,30 @@ namespace: azure.mgmt.avs package-name: azure-mgmt-avs clear-output-folder: true ``` -``` yaml $(python-mode) == 'update' +```yaml $(python) && $(track2) +python-mode: create +package-version: 1.0.0b1 +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +override-client-name: AVSClient +namespace: azure.mgmt.avs +package-name: azure-mgmt-avs +clear-output-folder: true +``` + +``` yaml $(python) && $(python-mode) == 'update' && !$(track2) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/compute/azure-mgmt-avs/azure/mgmt/avs +``` +``` yaml $(python) && $(python-mode) == 'create' && !$(track2) +basic-setup-py: true +output-folder: $(python-sdks-folder)/compute/azure-mgmt-avs +``` +``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/compute/azure-mgmt-avs/azure/mgmt/avs ``` -``` yaml $(python-mode) == 'create' +``` yaml $(python) && $(python-mode) == 'create' && $(track2) basic-setup-py: true output-folder: $(python-sdks-folder)/compute/azure-mgmt-avs ``` diff --git a/specification/web/resource-manager/readme.go.md b/specification/web/resource-manager/readme.go.md index 8f9118b7cdb7..028969df7e3a 100644 --- a/specification/web/resource-manager/readme.go.md +++ b/specification/web/resource-manager/readme.go.md @@ -2,17 +2,26 @@ These settings apply only when `--go` is specified on the command line. -``` yaml $(go) +``` yaml $(go) && !$(track2) go: license-header: MICROSOFT_MIT_NO_VERSION namespace: web clear-output-folder: true ``` +```yaml $(go) && $(track2) +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/web/armweb +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-2021-01-15 - tag: package-2020-12 - tag: package-2020-09 - tag: package-2020-06 @@ -22,6 +31,15 @@ batch: - tag: package-2015-08-preview ``` +### Tag: package-2021-01-15 and go + +These settings apply only when `--tag=package-2021-01-15 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2021-01-15' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2021-01-15/$(namespace) +``` + ### Tag: package-2020-12 and go These settings apply only when `--tag=package-2020-12 --go` is specified on the command line. diff --git a/specification/web/resource-manager/readme.md b/specification/web/resource-manager/readme.md index 1bea98ed477a..c61c1226560e 100644 --- a/specification/web/resource-manager/readme.md +++ b/specification/web/resource-manager/readme.md @@ -219,7 +219,8 @@ directive: These settings apply only when `--tag=package-2021-01-15` is specified on the command line. -```yaml $(tag) == 'package-2021-01-15' +```yaml $(tag) == 'package-2021-01-15' || $(tag) == 'package-2021-01-15-only' + input-file: - Microsoft.CertificateRegistration/stable/2021-01-15/AppServiceCertificateOrders.json - Microsoft.CertificateRegistration/stable/2021-01-15/CertificateOrdersDiagnostics.json @@ -1651,12 +1652,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - autorest_options: - use: "@microsoft.azure/autorest.python@4.0.70" - after_scripts: - - python ./scripts/multiapi_init_gen.py azure-mgmt-web - - python ./scripts/trim_aio.py ./sdk/appservice/azure-mgmt-web - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/web/resource-manager/readme.python.md b/specification/web/resource-manager/readme.python.md index f582b61b6176..76a2702606eb 100644 --- a/specification/web/resource-manager/readme.python.md +++ b/specification/web/resource-manager/readme.python.md @@ -4,19 +4,8 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - package-name: azure-mgmt-web - package-version: 0.42.0 - clear-output-folder: true - no-namespace-folders: true -``` - -``` yaml $(python) && $(track2) + +``` yaml $(python) azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-web @@ -28,25 +17,11 @@ no-namespace-folders: true Generate all API versions currently shipped for this package -```yaml $(python) && $(multiapi) && !$(track2) -batch: - - tag: package-2021-01-only - - tag: package-2020-12-only - - tag: package-2020-09-only - - tag: package-2020-06-only - - tag: package-2019-08-only - - tag: package-2018-11-only - - tag: package-2018-02-only - - tag: package-2016-09-only - - tag: package-2016-08-only - - tag: package-2016-03-only - - tag: package-2015-08-only - - tag: package-2015-04-only -``` -```yaml $(python) && $(multiapi) && $(track2) +```yaml $(python) && $(multiapi) clear-output-folder: true batch: + - tag: package-2021-01-15-only - tag: package-2021-01-only - tag: package-2020-12-only - tag: package-2020-09-only @@ -68,6 +43,16 @@ clear-output-folder: false perform-load: false ``` +### Tag: package-2021-01-15-only and python + +These settings apply only when `--tag=package-2021-01-15-only --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2021-01-15-only' && $(python) +namespace: azure.mgmt.web.v2021_01_15 +output-folder: $(python-sdks-folder)/appservice/azure-mgmt-web/azure/mgmt/web/v2021_01_15 +``` + ### Tag: package-2021-01-only and python These settings apply only when `--tag=package-2021-01-only --python` is specified on the command line. @@ -76,9 +61,6 @@ Please also specify `--python-sdks-folder=`. - -``` yaml $(java) -azure-arm: false -fluent: true -namespace: com.azure.messaging.webpubsub -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/webpubsub/data-plane -``` - -## TypeScript - -These settings apply only when `--typescript` is specified on the command line. -Please also specify `--typescript-sdks-folder=`. - -``` yaml $(typescript) -azure-arm: false -package-name: "@azure/web-pubsub" -license-header: MICROSOFT_MIT_NO_VERSION -output-folder: "$(typescript-sdks-folder)/sdk/web-pubsub/web-pubsub" -clear-output-folder: true -generate-metadata: true -v3: true -use-extension: - "@autorest/typescript": "6.0.0-dev.20201105.2" -``` - ## Python These settings apply only when `--python` is specified on the command line. diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-04-01-preview/webpubsub.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-04-01-preview/webpubsub.json index 5f6fcf108b5f..4cde0049948e 100644 --- a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-04-01-preview/webpubsub.json +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-04-01-preview/webpubsub.json @@ -2135,6 +2135,7 @@ "type": "object", "properties": { "clientCertEnabled": { + "default": true, "description": "Request client certificate during TLS handshake if enabled", "type": "boolean" } diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/Operations_List.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..93fcdcc59176 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/Operations_List.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.SignalRService/WebPubSub/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.SignalRService", + "resource": "WebPubSub", + "operation": "Manage WebPubSub (read-only)", + "description": "View the resource settings and configurations in the management portal or through API" + }, + "properties": {} + } + ], + "nextLink": "providers/Microsoft.SignalRService?$skipToken={opaqueString}" + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/Usages_List.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/Usages_List.json new file mode 100644 index 000000000000..25d212ccf52b --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/Usages_List.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "location": "eastus", + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SignalRService/locations/eastus/usages/Usage1", + "currentValue": 0, + "limit": 100, + "name": { + "value": "Usage1", + "localizedValue": "Usage1" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SignalRService/locations/eastus/usages/Usage2", + "currentValue": 0, + "limit": 100, + "name": { + "value": "Usage2", + "localizedValue": "Usage2" + }, + "unit": "Count" + } + ], + "nextLink": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToMoreResults..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSubPrivateEndpointConnections_Delete.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSubPrivateEndpointConnections_Delete.json new file mode 100644 index 000000000000..2a6ed26da343 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSubPrivateEndpointConnections_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "privateEndpointConnectionName": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "204": {} + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSubPrivateEndpointConnections_Get.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSubPrivateEndpointConnections_Get.json new file mode 100644 index 000000000000..348144d84034 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSubPrivateEndpointConnections_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "privateEndpointConnectionName": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e" + }, + "responses": { + "200": { + "body": { + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSubPrivateEndpointConnections_List.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSubPrivateEndpointConnections_List.json new file mode 100644 index 000000000000..38d3e1259e05 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSubPrivateEndpointConnections_List.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" + } + ] + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSubPrivateEndpointConnections_Update.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSubPrivateEndpointConnections_Update.json new file mode 100644 index 000000000000..51e43103b048 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSubPrivateEndpointConnections_Update.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "parameters": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + } + }, + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "privateEndpointConnectionName": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e" + }, + "responses": { + "200": { + "body": { + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSubPrivateLinkResources_List.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSubPrivateLinkResources_List.json new file mode 100644 index 000000000000..aa109544ffe8 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSubPrivateLinkResources_List.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "webpubsub", + "requiredMembers": [ + "webpubsub" + ], + "requiredZoneNames": [ + "privatelink.webpubsub.azure.com" + ], + "shareablePrivateLinkResourceTypes": [ + { + "name": "site", + "properties": { + "description": "Azure App Service can be used as an upstream", + "groupId": "sites", + "type": "Microsoft.Web/sites" + } + } + ] + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateLinkResources/myPrivateLink", + "name": "myPrivateLink", + "type": "privateLinkResources" + } + ], + "nextLink": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToMoreResults..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSubSharedPrivateLinkResources_CreateOrUpdate.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSubSharedPrivateLinkResources_CreateOrUpdate.json new file mode 100644 index 000000000000..1f399790dff5 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSubSharedPrivateLinkResources_CreateOrUpdate.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "parameters": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "requestMessage": "Please approve" + } + }, + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "sharedPrivateLinkResourceName": "upstream" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" + } + }, + "201": { + "body": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSubSharedPrivateLinkResources_Delete.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSubSharedPrivateLinkResources_Delete.json new file mode 100644 index 000000000000..9b93565e7c0a --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSubSharedPrivateLinkResources_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "sharedPrivateLinkResourceName": "upstream" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "204": {} + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSubSharedPrivateLinkResources_Get.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSubSharedPrivateLinkResources_Get.json new file mode 100644 index 000000000000..01b0a7f365fe --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSubSharedPrivateLinkResources_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService", + "sharedPrivateLinkResourceName": "upstream" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSubSharedPrivateLinkResources_List.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSubSharedPrivateLinkResources_List.json new file mode 100644 index 000000000000..ecd0fbd7819d --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSubSharedPrivateLinkResources_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "sites", + "privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp", + "provisioningState": "Succeeded", + "requestMessage": "Please approve", + "status": "Approved" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/upstream", + "name": "upstream", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" + } + ] + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSub_CheckNameAvailability.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSub_CheckNameAvailability.json new file mode 100644 index 000000000000..35e54aa9fa29 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSub_CheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "location": "eastus", + "parameters": { + "type": "Microsoft.SignalRService/WebPubSub", + "name": "myWebPubSubService" + }, + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "The name is already taken. Please try a different name." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSub_CreateOrUpdate.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSub_CreateOrUpdate.json new file mode 100644 index 000000000000..4e25ed81020a --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSub_CreateOrUpdate.json @@ -0,0 +1,317 @@ +{ + "parameters": { + "parameters": { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "capacity": 1 + }, + "properties": { + "tls": { + "clientCertEnabled": false + }, + "diagnosticConfiguration": { + "enableConnectivityLogs": "Disabled", + "enableMessagingLogs": "Disabled", + "enableLiveTrace": "Disabled" + }, + "eventHandler": { + "items": { + "hub1": [ + { + "urlTemplate": "https://example.com/chat/api/hub1", + "userEventPattern": "*" + } + ], + "hub2": [ + { + "urlTemplate": "https://example.com/chat/api/hub2/example1", + "userEventPattern": "example1" + }, + { + "urlTemplate": "https://example.com/chat/api/hub2/example2", + "userEventPattern": "example2" + } + ] + } + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false + }, + "identity": { + "type": "SystemAssigned" + }, + "location": "eastus", + "tags": { + "key1": "value1" + } + }, + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "size": "S1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mywebpubsubservice.webpubsub.azure.com", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" + } + ], + "tls": { + "clientCertEnabled": true + }, + "diagnosticConfiguration": { + "enableConnectivityLogs": "Disabled", + "enableMessagingLogs": "Disabled", + "enableLiveTrace": "Disabled" + }, + "eventHandler": { + "items": { + "hub1": [ + { + "urlTemplate": "https://example.com/chat/api/hub1", + "userEventPattern": "*", + "systemEventPattern": "connect,connected" + } + ], + "hub2": [ + { + "urlTemplate": "https://example.com/chat/api/hub2/example1", + "userEventPattern": "example1", + "auth": { + "type": "ManagedIdentity", + "managedIdentity": { + "resource": "http://example.com" + } + } + }, + { + "urlTemplate": "https://example.com/chat/api/hub2/example2", + "userEventPattern": "example2" + } + ] + } + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false + }, + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService", + "name": "myWebPubSubService", + "type": "Microsoft.SignalRService/WebPubSub" + } + }, + "201": { + "body": { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "size": "S1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mywebpubsubservice.webpubsub.azure.com", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" + } + ], + "tls": { + "clientCertEnabled": true + }, + "diagnosticConfiguration": { + "enableConnectivityLogs": "Disabled", + "enableMessagingLogs": "Disabled", + "enableLiveTrace": "Disabled" + }, + "eventHandler": { + "items": { + "hub1": [ + { + "urlTemplate": "https://example.com/chat/api/hub1", + "userEventPattern": "*", + "systemEventPattern": "connect,connected" + } + ], + "hub2": [ + { + "urlTemplate": "https://example.com/chat/api/hub2/example1", + "userEventPattern": "example1", + "auth": { + "type": "ManagedIdentity", + "managedIdentity": { + "resource": "http://example.com" + } + } + }, + { + "urlTemplate": "https://example.com/chat/api/hub2/example2", + "userEventPattern": "example2" + } + ] + } + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false + }, + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService", + "name": "myWebPubSubService", + "type": "Microsoft.SignalRService/WebPubSub" + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSub_Delete.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSub_Delete.json new file mode 100644 index 000000000000..1543d8025a93 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSub_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "204": {} + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSub_Get.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSub_Get.json new file mode 100644 index 000000000000..37886b877e82 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSub_Get.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "size": "S1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mywebpubsubservice.webpubsub.azure.com", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" + } + ], + "tls": { + "clientCertEnabled": true + }, + "diagnosticConfiguration": { + "enableConnectivityLogs": "Disabled", + "enableMessagingLogs": "Disabled", + "enableLiveTrace": "Disabled" + }, + "eventHandler": { + "items": { + "hub1": [ + { + "urlTemplate": "https://example.com/chat/api/hub1", + "userEventPattern": "*", + "systemEventPattern": "connect,connected" + } + ], + "hub2": [ + { + "urlTemplate": "https://example.com/chat/api/hub2/example1", + "userEventPattern": "example1", + "auth": { + "type": "ManagedIdentity", + "managedIdentity": { + "resource": "http://example.com" + } + } + }, + { + "urlTemplate": "https://example.com/chat/api/hub2/example2", + "userEventPattern": "example2" + } + ] + } + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false + }, + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService", + "name": "myWebPubSubService", + "type": "Microsoft.SignalRService/WebPubSub" + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSub_ListByResourceGroup.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSub_ListByResourceGroup.json new file mode 100644 index 000000000000..064f94598e41 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSub_ListByResourceGroup.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "size": "S1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mywebpubsubservice.webpubsub.azure.com", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" + } + ], + "tls": { + "clientCertEnabled": true + }, + "diagnosticConfiguration": { + "enableConnectivityLogs": "Disabled", + "enableMessagingLogs": "Disabled", + "enableLiveTrace": "Disabled" + }, + "eventHandler": { + "items": { + "hub1": [ + { + "urlTemplate": "https://example.com/chat/api/hub1", + "userEventPattern": "*", + "systemEventPattern": "connect,connected" + } + ], + "hub2": [ + { + "urlTemplate": "https://example.com/chat/api/hub2/example1", + "userEventPattern": "example1", + "auth": { + "type": "ManagedIdentity", + "managedIdentity": { + "resource": "http://example.com" + } + } + }, + { + "urlTemplate": "https://example.com/chat/api/hub2/example2", + "userEventPattern": "example2" + } + ] + } + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false + }, + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService", + "name": "myWebPubSubService", + "type": "Microsoft.SignalRService/WebPubSub" + } + ] + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSub_ListBySubscription.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSub_ListBySubscription.json new file mode 100644 index 000000000000..f3d588513dc1 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSub_ListBySubscription.json @@ -0,0 +1,129 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "size": "S1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mywebpubsubservice.webpubsub.azure.com", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" + } + ], + "tls": { + "clientCertEnabled": true + }, + "diagnosticConfiguration": { + "enableConnectivityLogs": "Disabled", + "enableMessagingLogs": "Disabled", + "enableLiveTrace": "Disabled" + }, + "eventHandler": { + "items": { + "hub1": [ + { + "urlTemplate": "https://example.com/chat/api/hub1", + "userEventPattern": "*", + "systemEventPattern": "connect,connected" + } + ], + "hub2": [ + { + "urlTemplate": "https://example.com/chat/api/hub2/example1", + "userEventPattern": "example1", + "auth": { + "type": "ManagedIdentity", + "managedIdentity": { + "resource": "http://example.com" + } + } + }, + { + "urlTemplate": "https://example.com/chat/api/hub2/example2", + "userEventPattern": "example2" + } + ] + } + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false + }, + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService", + "name": "myWebPubSubService", + "type": "Microsoft.SignalRService/WebPubSub" + } + ] + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSub_ListKeys.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSub_ListKeys.json new file mode 100644 index 000000000000..a8eaca68f0ae --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSub_ListKeys.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSub_RegenerateKey.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSub_RegenerateKey.json new file mode 100644 index 000000000000..884e0812776f --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSub_RegenerateKey.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "parameters": { + "keyType": "Primary" + }, + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "202": { + "body": {}, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSub_Restart.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSub_Restart.json new file mode 100644 index 000000000000..92dc31dfcf76 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSub_Restart.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "204": {} + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSub_Update.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSub_Update.json new file mode 100644 index 000000000000..ad7a4bf830ba --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/examples/WebPubSub_Update.json @@ -0,0 +1,196 @@ +{ + "parameters": { + "parameters": { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "capacity": 1 + }, + "properties": { + "tls": { + "clientCertEnabled": false + }, + "diagnosticConfiguration": { + "enableConnectivityLogs": "Disabled", + "enableMessagingLogs": "Disabled", + "enableLiveTrace": "Disabled" + }, + "eventHandler": { + "items": { + "hub1": [ + { + "urlTemplate": "https://example.com/chat/api/hub1", + "userEventPattern": "*" + } + ], + "hub2": [ + { + "urlTemplate": "https://example.com/chat/api/hub2/example1", + "userEventPattern": "example1" + }, + { + "urlTemplate": "https://example.com/chat/api/hub2/example2", + "userEventPattern": "example2" + } + ] + } + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false + }, + "identity": { + "type": "SystemAssigned" + }, + "location": "eastus", + "tags": { + "key1": "value1" + } + }, + "api-version": "2021-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "myWebPubSubService" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "size": "S1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mywebpubsubservice.webpubsub.azure.com", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections" + } + ], + "tls": { + "clientCertEnabled": true + }, + "diagnosticConfiguration": { + "enableConnectivityLogs": "Disabled", + "enableMessagingLogs": "Disabled", + "enableLiveTrace": "Disabled" + }, + "eventHandler": { + "items": { + "hub1": [ + { + "urlTemplate": "https://example.com/chat/api/hub1", + "userEventPattern": "*", + "systemEventPattern": "connect,connected" + } + ], + "hub2": [ + { + "urlTemplate": "https://example.com/chat/api/hub2/example1", + "userEventPattern": "example1", + "auth": { + "type": "ManagedIdentity", + "managedIdentity": { + "resource": "http://example.com" + } + } + }, + { + "urlTemplate": "https://example.com/chat/api/hub2/example2", + "userEventPattern": "example2" + } + ] + } + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ] + }, + "privateEndpoints": [ + { + "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ] + } + ] + }, + "publicNetworkAccess": "Enabled", + "disableLocalAuth": false, + "disableAadAuth": false + }, + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService", + "name": "myWebPubSubService", + "type": "Microsoft.SignalRService/WebPubSub" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/webpubsub.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/webpubsub.json new file mode 100644 index 000000000000..9e52b0fdd460 --- /dev/null +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2021-06-01-preview/webpubsub.json @@ -0,0 +1,2196 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01-preview", + "title": "WebPubSubManagementClient", + "description": "REST API for Azure WebPubSub Service" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.SignalRService/operations": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Lists all of the available REST API operations of the Microsoft.SignalRService provider.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of operations.", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/checkNameAvailability": { + "post": { + "tags": [ + "WebPubSub" + ], + "description": "Checks that the resource name is valid and is not already in use.", + "operationId": "WebPubSub_CheckNameAvailability", + "parameters": [ + { + "name": "location", + "in": "path", + "description": "the region", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Parameters supplied to the operation.", + "required": true, + "schema": { + "$ref": "#/definitions/NameAvailabilityParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the name availability.", + "schema": { + "$ref": "#/definitions/NameAvailability" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSub_CheckNameAvailability": { + "$ref": "./examples/WebPubSub_CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/usages": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "List resource usage quotas by location.", + "operationId": "Usages_List", + "parameters": [ + { + "name": "location", + "in": "path", + "description": "the location like \"eastus\"", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the usage quotas of a subscription in specified region.", + "schema": { + "$ref": "#/definitions/SignalRServiceUsageList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Usages_List": { + "$ref": "./examples/Usages_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/webPubSub": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Handles requests to list all resources in a subscription.", + "operationId": "WebPubSub_ListBySubscription", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of resources in the subscription.", + "schema": { + "$ref": "#/definitions/WebPubSubResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebPubSub_ListBySubscription": { + "$ref": "./examples/WebPubSub_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Handles requests to list all resources in a resource group.", + "operationId": "WebPubSub_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of resources in a resourceGroup.", + "schema": { + "$ref": "#/definitions/WebPubSubResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebPubSub_ListByResourceGroup": { + "$ref": "./examples/WebPubSub_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Get the resource and its properties.", + "operationId": "WebPubSub_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding resource.", + "schema": { + "$ref": "#/definitions/WebPubSubResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSub_Get": { + "$ref": "./examples/WebPubSub_Get.json" + } + } + }, + "put": { + "tags": [ + "WebPubSub" + ], + "description": "Create or update a resource.", + "operationId": "WebPubSub_CreateOrUpdate", + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/WebPubSubResource" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a resource.", + "schema": { + "$ref": "#/definitions/WebPubSubResource" + } + }, + "201": { + "description": "Created. The response describes the new resource and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/WebPubSubResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting resource is now updating and contains a Location header to query the operation result.." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "WebPubSub_CreateOrUpdate": { + "$ref": "./examples/WebPubSub_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "WebPubSub" + ], + "description": "Operation to delete a resource.", + "operationId": "WebPubSub_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the resource is already deleted." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the resource is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "WebPubSub_Delete": { + "$ref": "./examples/WebPubSub_Delete.json" + } + } + }, + "patch": { + "tags": [ + "WebPubSub" + ], + "description": "Operation to update an exiting resource.", + "operationId": "WebPubSub_Update", + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/WebPubSubResource" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a resource.", + "schema": { + "$ref": "#/definitions/WebPubSubResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting resource is now updating and contains a Location header to query the operation result.." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "WebPubSub_Update": { + "$ref": "./examples/WebPubSub_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/listKeys": { + "post": { + "tags": [ + "WebPubSub" + ], + "description": "Get the access keys of the resource.", + "operationId": "WebPubSub_ListKeys", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes access keys of the resource.", + "schema": { + "$ref": "#/definitions/WebPubSubKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSub_ListKeys": { + "$ref": "./examples/WebPubSub_ListKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "List private endpoint connections", + "operationId": "WebPubSubPrivateEndpointConnections_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a list of private endpoint connections.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebPubSubPrivateEndpointConnections_List": { + "$ref": "./examples/WebPubSubPrivateEndpointConnections_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Get the specified private endpoint connection", + "operationId": "WebPubSubPrivateEndpointConnections_Get", + "parameters": [ + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a private endpoint connection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSubPrivateEndpointConnections_Get": { + "$ref": "./examples/WebPubSubPrivateEndpointConnections_Get.json" + } + } + }, + "put": { + "tags": [ + "WebPubSub" + ], + "description": "Update the state of specified private endpoint connection", + "operationId": "WebPubSubPrivateEndpointConnections_Update", + "parameters": [ + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The resource of private endpoint and its properties", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "OK. The response indicates the private endpoint connection is updated successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSubPrivateEndpointConnections_Update": { + "$ref": "./examples/WebPubSubPrivateEndpointConnections_Update.json" + } + } + }, + "delete": { + "tags": [ + "WebPubSub" + ], + "description": "Delete the specified private endpoint connection", + "operationId": "WebPubSubPrivateEndpointConnections_Delete", + "parameters": [ + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the resource is already deleted." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the private endpoint connection is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "WebPubSubPrivateEndpointConnections_Delete": { + "$ref": "./examples/WebPubSubPrivateEndpointConnections_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Get the private link resources that need to be created for a resource.", + "operationId": "WebPubSubPrivateLinkResources_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a list of private link resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebPubSubPrivateLinkResources_List": { + "$ref": "./examples/WebPubSubPrivateLinkResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/regenerateKey": { + "post": { + "tags": [ + "WebPubSub" + ], + "description": "Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.", + "operationId": "WebPubSub_RegenerateKey", + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "Parameter that describes the Regenerate Key Operation.", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateKeyParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "202": { + "description": "Accepted and an async operation is executing in background to make the new key to take effect. The response contains new access keys and a Location header to query the async operation result.", + "schema": { + "$ref": "#/definitions/WebPubSubKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "WebPubSub_RegenerateKey": { + "$ref": "./examples/WebPubSub_RegenerateKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/restart": { + "post": { + "tags": [ + "WebPubSub" + ], + "description": "Operation to restart a resource.", + "operationId": "WebPubSub_Restart", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the restart operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the operation is successful and no content will be returned." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "WebPubSub_Restart": { + "$ref": "./examples/WebPubSub_Restart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "List shared private link resources", + "operationId": "WebPubSubSharedPrivateLinkResources_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a list of shared private link resources.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebPubSubSharedPrivateLinkResources_List": { + "$ref": "./examples/WebPubSubSharedPrivateLinkResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}": { + "get": { + "tags": [ + "WebPubSub" + ], + "description": "Get the specified shared private link resource", + "operationId": "WebPubSubSharedPrivateLinkResources_Get", + "parameters": [ + { + "name": "sharedPrivateLinkResourceName", + "in": "path", + "description": "The name of the shared private link resource", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a shared private link resource.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebPubSubSharedPrivateLinkResources_Get": { + "$ref": "./examples/WebPubSubSharedPrivateLinkResources_Get.json" + } + } + }, + "put": { + "tags": [ + "WebPubSub" + ], + "description": "Create or update a shared private link resource", + "operationId": "WebPubSubSharedPrivateLinkResources_CreateOrUpdate", + "parameters": [ + { + "name": "sharedPrivateLinkResourceName", + "in": "path", + "description": "The name of the shared private link resource", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The shared private link resource", + "required": true, + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "OK. The response indicates the shared private link resource is updated.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "201": { + "description": "Created. The response indicates the shared private link resource is created.", + "schema": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "WebPubSubSharedPrivateLinkResources_CreateOrUpdate": { + "$ref": "./examples/WebPubSubSharedPrivateLinkResources_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "WebPubSub" + ], + "description": "Delete the specified shared private link resource", + "operationId": "WebPubSubSharedPrivateLinkResources_Delete", + "parameters": [ + { + "name": "sharedPrivateLinkResourceName", + "in": "path", + "description": "The name of the shared private link resource", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the resource is already deleted." + }, + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the private endpoint connection is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "WebPubSubSharedPrivateLinkResources_Delete": { + "$ref": "./examples/WebPubSubSharedPrivateLinkResources_Delete.json" + } + } + } + } + }, + "definitions": { + "ACLAction": { + "description": "Default action when no other rule matches", + "enum": [ + "Allow", + "Deny" + ], + "type": "string", + "x-ms-enum": { + "name": "ACLAction", + "modelAsString": true + } + }, + "DiagnosticConfiguration": { + "description": "Diagnostic configuration of a Microsoft.SignalRService resource. Used together with Azure monitor DiagnosticSettings.", + "type": "object", + "properties": { + "enableConnectivityLogs": { + "description": "Indicate whether or not enable Connectivity logs.\r\nAvailable values: Enabled, Disabled.\r\nCase insensitive.", + "type": "string" + }, + "enableMessagingLogs": { + "description": "Indicate whether or not enable Messaging logs.\r\nAvailable values: Enabled, Disabled.\r\nCase insensitive.", + "type": "string" + }, + "enableLiveTrace": { + "description": "Indicate whether or not enable Live Trace. \r\nAvailable values: Enabled, Disabled. \r\nCase insensitive. \r\nLive Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues.", + "type": "string" + } + } + }, + "Dimension": { + "description": "Specifications of the Dimension of metrics.", + "type": "object", + "properties": { + "name": { + "description": "The public facing name of the dimension.", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the dimension.", + "type": "string" + }, + "internalName": { + "description": "Name of the dimension as it appears in MDM.", + "type": "string" + }, + "toBeExportedForShoebox": { + "description": "A Boolean flag indicating whether this dimension should be included for the shoebox export scenario.", + "type": "boolean" + } + } + }, + "EventHandlerSettings": { + "description": "The settings for event handler in webpubsub service", + "type": "object", + "properties": { + "items": { + "description": "Get or set the EventHandler items. The key is the hub name and the value is the corresponding EventHandlerTemplate.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/EventHandlerTemplate" + } + } + } + } + }, + "EventHandlerTemplate": { + "description": "EventHandler template item settings.", + "required": [ + "urlTemplate" + ], + "type": "object", + "properties": { + "urlTemplate": { + "description": "Gets or sets the EventHandler URL template. You can use a predefined parameter {hub} and {event} inside the template, the value of the EventHandler URL is dynamically calculated when the client request comes in.\r\nFor example, UrlTemplate can be `http://example.com/api/{hub}/{event}`. The host part can't contains parameters.", + "type": "string" + }, + "userEventPattern": { + "description": "Gets or sets the matching pattern for event names.\r\nThere are 3 kind of patterns supported:\r\n 1. \"*\", it to matches any event name\r\n 2. Combine multiple events with \",\", for example \"event1,event2\", it matches event \"event1\" and \"event2\"\r\n 3. The single event name, for example, \"event1\", it matches \"event1\"", + "type": "string" + }, + "systemEventPattern": { + "description": "Gets ot sets the system event pattern.\r\nThere are 2 kind of patterns supported:\r\n 1. The single event name, for example, \"connect\", it matches \"connect\"\r\n 2. Combine multiple events with \",\", for example \"connect,disconnected\", it matches event \"connect\" and \"disconnected\"", + "type": "string" + }, + "auth": { + "$ref": "#/definitions/UpstreamAuthSettings", + "description": "Gets or sets the auth settings for an event handler. If not set, no auth is used." + } + } + }, + "KeyType": { + "description": "The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive).", + "enum": [ + "Primary", + "Secondary" + ], + "type": "string", + "x-ms-enum": { + "name": "KeyType", + "modelAsString": true + } + }, + "LogSpecification": { + "description": "Specifications of the Logs 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" + } + } + }, + "ManagedIdentity": { + "description": "A class represent managed identities used for request and response", + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/ManagedIdentityType", + "description": "Represent the identity type: systemAssigned, userAssigned, None" + }, + "userAssignedIdentities": { + "description": "Get or set the user assigned identities", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentityProperty" + } + }, + "principalId": { + "description": "Get the principal id for the system assigned identity.\r\nOnly be used in response.", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "Get the tenant id for the system assigned identity.\r\nOnly be used in response", + "type": "string", + "readOnly": true + } + } + }, + "ManagedIdentitySettings": { + "description": "Managed identity settings for upstream.", + "type": "object", + "properties": { + "resource": { + "description": "The Resource indicating the App ID URI of the target resource.\r\nIt also appears in the aud (audience) claim of the issued token.", + "type": "string" + } + } + }, + "ManagedIdentityType": { + "description": "Represent the identity type: systemAssigned, userAssigned, None", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedIdentityType", + "modelAsString": true + } + }, + "MetricSpecification": { + "description": "Specifications of the Metrics for Azure Monitoring.", + "type": "object", + "properties": { + "name": { + "description": "Name of the metric.", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the metric.", + "type": "string" + }, + "displayDescription": { + "description": "Localized friendly description of the metric.", + "type": "string" + }, + "unit": { + "description": "The unit that makes sense for the metric.", + "type": "string" + }, + "aggregationType": { + "description": "Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.", + "type": "string" + }, + "fillGapWithZero": { + "description": "Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published. \r\nEx. a metric that returns the number of times a particular error code was emitted. The error code may not appear \r\noften, instead of the RP publishing 0, Shoebox can auto fill in 0s for time periods where nothing was emitted.", + "type": "string" + }, + "category": { + "description": "The name of the metric category that the metric belongs to. A metric can only belong to a single category.", + "type": "string" + }, + "dimensions": { + "description": "The dimensions of the metrics.", + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + } + } + } + }, + "NameAvailability": { + "description": "Result of the request to check name availability. It contains a flag and possible reason of failure.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "Indicates whether the name is available or not.", + "type": "boolean" + }, + "reason": { + "description": "The reason of the availability. Required if name is not available.", + "type": "string" + }, + "message": { + "description": "The message of the operation.", + "type": "string" + } + } + }, + "NameAvailabilityParameters": { + "description": "Data POST-ed to the nameAvailability action", + "required": [ + "type", + "name" + ], + "type": "object", + "properties": { + "type": { + "description": "The resource type. Can be \"Microsoft.SignalRService/SignalR\" or \"Microsoft.SignalRService/webPubSub\"", + "type": "string" + }, + "name": { + "description": "The resource name to validate. e.g.\"my-resource-name\"", + "type": "string" + } + } + }, + "NetworkACL": { + "description": "Network ACL", + "type": "object", + "properties": { + "allow": { + "description": "Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.", + "type": "array", + "items": { + "$ref": "#/definitions/WebPubSubRequestType" + } + }, + "deny": { + "description": "Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.", + "type": "array", + "items": { + "$ref": "#/definitions/WebPubSubRequestType" + } + } + } + }, + "Operation": { + "description": "REST API operation supported by resource provider.", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation with format: {provider}/{resource}/{operation}", + "type": "string" + }, + "isDataAction": { + "description": "If the operation is a data action. (for data plane rbac)", + "type": "boolean" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "The object that describes the operation." + }, + "origin": { + "description": "Optional. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Extra properties for the operation.", + "x-ms-client-flatten": false + } + } + }, + "OperationDisplay": { + "description": "The object that describes a operation.", + "type": "object", + "properties": { + "provider": { + "description": "Friendly name of the resource provider", + "type": "string" + }, + "resource": { + "description": "Resource type on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "The localized friendly name for the operation.", + "type": "string" + }, + "description": { + "description": "The localized friendly description for the operation", + "type": "string" + } + } + }, + "OperationList": { + "description": "Result of the request to list REST API operations. It contains a list of operations.", + "type": "object", + "properties": { + "value": { + "description": "List of operations supported by the resource provider.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "OperationProperties": { + "description": "Extra Operation properties.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "The service specifications." + } + } + }, + "PrivateEndpoint": { + "description": "Private endpoint", + "type": "object", + "properties": { + "id": { + "description": "Full qualified Id of the private endpoint", + "type": "string" + } + } + }, + "PrivateEndpointACL": { + "description": "ACL for a private endpoint", + "required": [ + "name" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkACL" + } + ], + "properties": { + "name": { + "description": "Name of the private endpoint connection", + "type": "string" + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection to an azure resource", + "type": "object", + "allOf": [ + { + "$ref": "#/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.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Properties of the private endpoint connection", + "x-ms-client-flatten": true + } + } + }, + "PrivateEndpointConnectionList": { + "description": "A list of private endpoint connections", + "type": "object", + "properties": { + "value": { + "description": "The list of the private endpoint connections", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "description": "Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size.", + "type": "string" + } + } + }, + "PrivateEndpointConnectionProperties": { + "description": "Private endpoint connection properties", + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the private endpoint connection", + "readOnly": true + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "Private endpoint associated with the private endpoint connection" + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "Connection state" + } + } + }, + "PrivateLinkResource": { + "description": "Private link resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Properties of a private link resource", + "x-ms-client-flatten": true + } + } + }, + "PrivateLinkResourceList": { + "description": "Contains a list of PrivateLinkResource and a possible link to query more results", + "type": "object", + "properties": { + "value": { + "description": "List of PrivateLinkResource", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "PrivateLinkResourceProperties": { + "description": "Private link resource properties", + "type": "object", + "properties": { + "groupId": { + "description": "Group Id of the private link resource", + "type": "string" + }, + "requiredMembers": { + "description": "Required members of the private link resource", + "type": "array", + "items": { + "type": "string" + } + }, + "requiredZoneNames": { + "description": "Required private DNS zone names", + "type": "array", + "items": { + "type": "string" + } + }, + "shareablePrivateLinkResourceTypes": { + "description": "The list of resources that are onboarded to private link service", + "type": "array", + "items": { + "$ref": "#/definitions/ShareablePrivateLinkResourceType" + } + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "Connection state of the private endpoint connection", + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/PrivateLinkServiceConnectionStatus", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + }, + "description": { + "description": "The reason for approval/rejection of the connection.", + "type": "string" + }, + "actionsRequired": { + "description": "A message indicating if changes on the service provider require any updates on the consumer.", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionStatus": { + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateLinkServiceConnectionStatus", + "modelAsString": true + } + }, + "ProvisioningState": { + "description": "Provisioning state of the resource.", + "enum": [ + "Unknown", + "Succeeded", + "Failed", + "Canceled", + "Running", + "Creating", + "Updating", + "Deleting", + "Moving" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "ProxyResource": { + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": {} + }, + "RegenerateKeyParameters": { + "description": "Parameters describes the request to regenerate access keys", + "type": "object", + "properties": { + "keyType": { + "$ref": "#/definitions/KeyType", + "description": "The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive)." + } + } + }, + "Resource": { + "description": "The core properties of ARM resources.", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified resource Id for the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource - e.g. \"Microsoft.SignalRService/SignalR\"", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "ResourceSku": { + "description": "The billing information of the resource.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1", + "type": "string" + }, + "tier": { + "$ref": "#/definitions/WebPubSubSkuTier", + "description": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead." + }, + "size": { + "description": "Not used. Retained for future use.", + "type": "string", + "readOnly": true + }, + "family": { + "description": "Not used. Retained for future use.", + "type": "string", + "readOnly": true + }, + "capacity": { + "format": "int32", + "description": "Optional, integer. The unit count of the resource. 1 by default.\r\n\r\nIf present, following values are allowed:\r\n Free: 1\r\n Standard: 1,2,5,10,20,50,100", + "type": "integer" + } + } + }, + "ServiceSpecification": { + "description": "An object that describes a specification.", + "type": "object", + "properties": { + "metricSpecifications": { + "description": "Specifications of the Metrics for Azure Monitoring.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + } + }, + "logSpecifications": { + "description": "Specifications of the Logs for Azure Monitoring.", + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + } + } + } + }, + "ShareablePrivateLinkResourceProperties": { + "description": "Describes the properties of a resource type that has been onboarded to private link service", + "type": "object", + "properties": { + "description": { + "description": "The description of the resource type that has been onboarded to private link service", + "type": "string" + }, + "groupId": { + "description": "The resource provider group id for the resource that has been onboarded to private link service", + "type": "string" + }, + "type": { + "description": "The resource provider type for the resource that has been onboarded to private link service", + "type": "string" + } + } + }, + "ShareablePrivateLinkResourceType": { + "description": "Describes a resource type that has been onboarded to private link service", + "type": "object", + "properties": { + "name": { + "description": "The name of the resource type that has been onboarded to private link service", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/ShareablePrivateLinkResourceProperties", + "description": "Describes the properties of a resource type that has been onboarded to private link service" + } + } + }, + "SharedPrivateLinkResource": { + "description": "Describes a Shared Private Link Resource", + "type": "object", + "allOf": [ + { + "$ref": "#/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.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/SharedPrivateLinkResourceProperties", + "description": "Describes the properties of a Shared Private Link Resource", + "x-ms-client-flatten": true + } + } + }, + "SharedPrivateLinkResourceList": { + "description": "A list of shared private link resources", + "type": "object", + "properties": { + "value": { + "description": "The list of the shared private link resources", + "type": "array", + "items": { + "$ref": "#/definitions/SharedPrivateLinkResource" + } + }, + "nextLink": { + "description": "Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size.", + "type": "string" + } + } + }, + "SharedPrivateLinkResourceProperties": { + "description": "Describes the properties of an existing Shared Private Link Resource", + "required": [ + "groupId", + "privateLinkResourceId" + ], + "type": "object", + "properties": { + "groupId": { + "description": "The group id from the provider of resource the shared private link resource is for", + "type": "string" + }, + "privateLinkResourceId": { + "description": "The resource id of the resource the shared private link resource is for", + "type": "string" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the shared private link resource", + "readOnly": true + }, + "requestMessage": { + "description": "The request message for requesting approval of the shared private link resource", + "type": "string" + }, + "status": { + "$ref": "#/definitions/SharedPrivateLinkResourceStatus", + "description": "Status of the shared private link resource", + "readOnly": true + } + } + }, + "SharedPrivateLinkResourceStatus": { + "description": "Status of the shared private link resource", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected", + "Timeout" + ], + "type": "string", + "x-ms-enum": { + "name": "SharedPrivateLinkResourceStatus", + "modelAsString": true + } + }, + "SignalRServiceUsage": { + "description": "Object that describes a specific usage of the resources.", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified ARM resource id", + "type": "string" + }, + "currentValue": { + "format": "int64", + "description": "Current value for the usage quota.", + "type": "integer" + }, + "limit": { + "format": "int64", + "description": "The maximum permitted value for the usage quota. If there is no limit, this value will be -1.", + "type": "integer" + }, + "name": { + "$ref": "#/definitions/SignalRServiceUsageName", + "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" + } + } + }, + "SignalRServiceUsageList": { + "description": "Object that includes an array of the resource usages and a possible link for next set.", + "type": "object", + "properties": { + "value": { + "description": "List of the resource usages", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRServiceUsage" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "SignalRServiceUsageName": { + "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" + } + } + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "description": "The GEO location of the resource. e.g. West US | East US | North Central US | South Central US.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "description": "Tags of the service which is a list of key value pairs that describe the resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "UpstreamAuthSettings": { + "description": "Upstream auth settings.", + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/UpstreamAuthType", + "description": "Gets or sets the type of auth. None or ManagedIdentity is supported now." + }, + "managedIdentity": { + "$ref": "#/definitions/ManagedIdentitySettings", + "description": "Gets or sets the managed identity settings. It's required if the auth type is set to ManagedIdentity." + } + } + }, + "UpstreamAuthType": { + "description": "Gets or sets the type of auth. None or ManagedIdentity is supported now.", + "enum": [ + "None", + "ManagedIdentity" + ], + "type": "string", + "x-ms-enum": { + "name": "UpstreamAuthType", + "modelAsString": true + } + }, + "UserAssignedIdentityProperty": { + "description": "Properties of user assigned identity.", + "type": "object", + "properties": { + "principalId": { + "description": "Get the principal id for the user assigned identity", + "type": "string", + "readOnly": true + }, + "clientId": { + "description": "Get the client id for the user assigned identity", + "type": "string", + "readOnly": true + } + } + }, + "WebPubSubKeys": { + "description": "A class represents the access keys of the resource.", + "type": "object", + "properties": { + "primaryKey": { + "description": "The primary access key.", + "type": "string", + "x-ms-secret": true, + "x-ms-mutability": [ + "create", + "update" + ] + }, + "secondaryKey": { + "description": "The secondary access key.", + "type": "string", + "x-ms-secret": true, + "x-ms-mutability": [ + "create", + "update" + ] + }, + "primaryConnectionString": { + "description": "Connection string constructed via the primaryKey", + "type": "string", + "x-ms-secret": true, + "x-ms-mutability": [ + "create", + "update" + ] + }, + "secondaryConnectionString": { + "description": "Connection string constructed via the secondaryKey", + "type": "string", + "x-ms-secret": true, + "x-ms-mutability": [ + "create", + "update" + ] + } + } + }, + "WebPubSubNetworkACLs": { + "description": "Network ACLs for the resource", + "type": "object", + "properties": { + "defaultAction": { + "$ref": "#/definitions/ACLAction", + "description": "Default action when no other rule matches", + "default": "Deny" + }, + "publicNetwork": { + "$ref": "#/definitions/NetworkACL", + "description": "ACL for requests from public network" + }, + "privateEndpoints": { + "description": "ACLs for requests from private endpoints", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointACL" + } + } + } + }, + "WebPubSubProperties": { + "description": "A class that describes the properties of the resource", + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "externalIP": { + "description": "The publicly accessible IP of the resource.", + "type": "string", + "readOnly": true + }, + "hostName": { + "description": "FQDN of the service instance.", + "type": "string", + "readOnly": true + }, + "publicPort": { + "format": "int32", + "description": "The publicly accessible port of the resource which is designed for browser/client side usage.", + "type": "integer", + "readOnly": true + }, + "serverPort": { + "format": "int32", + "description": "The publicly accessible port of the resource which is designed for customer server side usage.", + "type": "integer", + "readOnly": true + }, + "version": { + "description": "Version of the resource. Probably you need the same or higher version of client SDKs.", + "type": "string", + "readOnly": true + }, + "privateEndpointConnections": { + "description": "Private endpoint connections to the resource.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "sharedPrivateLinkResources": { + "description": "The list of shared private link resources.", + "type": "array", + "items": { + "$ref": "#/definitions/SharedPrivateLinkResource" + }, + "readOnly": true + }, + "tls": { + "$ref": "#/definitions/WebPubSubTlsSettings", + "description": "TLS settings." + }, + "diagnosticConfiguration": { + "$ref": "#/definitions/DiagnosticConfiguration", + "description": "Diagnostic configuration of a Microsoft.SignalRService resource. Used together with Azure monitor DiagnosticSettings." + }, + "eventHandler": { + "$ref": "#/definitions/EventHandlerSettings", + "description": "The settings for event handler in webpubsub service." + }, + "networkACLs": { + "$ref": "#/definitions/WebPubSubNetworkACLs", + "description": "Network ACLs" + }, + "publicNetworkAccess": { + "description": "Enable or disable public network access. Default to \"Enabled\".\r\nWhen it's Enabled, network ACLs still apply.\r\nWhen it's Disabled, public network access is always disabled no matter what you set in network ACLs.", + "default": "Enabled", + "type": "string" + }, + "disableLocalAuth": { + "description": "DisableLocalAuth\r\nEnable or disable local auth with AccessKey\r\nWhen set as true, connection with AccessKey=xxx won't work.", + "default": false, + "type": "boolean" + }, + "disableAadAuth": { + "description": "DisableLocalAuth\r\nEnable or disable aad auth\r\nWhen set as true, connection with AuthType=aad won't work.", + "default": false, + "type": "boolean" + } + } + }, + "WebPubSubRequestType": { + "description": "Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.", + "enum": [ + "ClientConnection", + "ServerConnection", + "RESTAPI", + "Trace" + ], + "type": "string", + "x-ms-enum": { + "name": "WebPubSubRequestType", + "modelAsString": true + } + }, + "WebPubSubResource": { + "description": "A class represent a resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "sku": { + "$ref": "#/definitions/ResourceSku", + "description": "The billing information of the resource.(e.g. Free, Standard)" + }, + "properties": { + "$ref": "#/definitions/WebPubSubProperties", + "description": "Settings used to provision or configure the resource", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "#/definitions/ManagedIdentity", + "description": "The managed identity response" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + } + }, + "WebPubSubResourceList": { + "description": "Object that includes an array of resources and a possible link for next set.", + "type": "object", + "properties": { + "value": { + "description": "List of the resources", + "type": "array", + "items": { + "$ref": "#/definitions/WebPubSubResource" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "WebPubSubSkuTier": { + "description": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead.", + "enum": [ + "Free", + "Basic", + "Standard", + "Premium" + ], + "type": "string", + "x-ms-enum": { + "name": "WebPubSubSkuTier", + "modelAsString": true + } + }, + "WebPubSubTlsSettings": { + "description": "TLS settings for the resource", + "type": "object", + "properties": { + "clientCertEnabled": { + "default": true, + "description": "Request client certificate during TLS handshake if enabled", + "type": "boolean" + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string" + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "required": true, + "type": "string" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ResourceName": { + "name": "resourceName", + "in": "path", + "description": "The name of the resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/webpubsub/resource-manager/readme.go.md b/specification/webpubsub/resource-manager/readme.go.md index 9197222a8e61..7da27fee99dc 100644 --- a/specification/webpubsub/resource-manager/readme.go.md +++ b/specification/webpubsub/resource-manager/readme.go.md @@ -14,6 +14,7 @@ go: ``` yaml $(go) && $(multiapi) batch: - tag: package-2021-04-01-preview + - tag: package-2021-06-01-preview ``` ### Tag: package-2021-04-01-preview and go @@ -24,3 +25,13 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2021-06-01-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2021-06-01-preview/$(namespace) +``` \ No newline at end of file diff --git a/specification/webpubsub/resource-manager/readme.java.md b/specification/webpubsub/resource-manager/readme.java.md index 4604827e7e5a..7058d1df1eaa 100644 --- a/specification/webpubsub/resource-manager/readme.java.md +++ b/specification/webpubsub/resource-manager/readme.java.md @@ -17,6 +17,7 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-webpubsub ``` yaml $(java) && $(multiapi) batch: - tag: package-2021-04-01-preview + - tag: package-2021-06-01-preview ``` ### Tag: package-2021-04-01-preview and java @@ -30,4 +31,15 @@ java: output-folder: $(azure-libraries-for-java-folder)/sdk/webpubsub/mgmt-v2021_04_01_preview regenerate-manager: true generate-interface: true +``` + +These settings apply only when `--tag=package-2021-06-01-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2021-06-01-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.webpubsub.v2021_06_01_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/webpubsub/mgmt-v2021_06_01_preview +regenerate-manager: true +generate-interface: true ``` \ No newline at end of file diff --git a/specification/webpubsub/resource-manager/readme.md b/specification/webpubsub/resource-manager/readme.md index 1ae625b5769b..ba3917b6348f 100644 --- a/specification/webpubsub/resource-manager/readme.md +++ b/specification/webpubsub/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the WebPubSub API. ``` yaml openapi-type: arm -tag: package-2021-04-01-preview +tag: package-2021-06-01-preview ``` ### Suppression @@ -53,6 +53,16 @@ directive: reason: It's indeed an UPDATE operation, but PUT is required per NRP requirement. ``` + +### Tag: package-2021-06-01-preview + +These settings apply only when `--tag=package-2021-06-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2021-06-01-preview' +input-file: +- Microsoft.SignalRService/preview/2021-06-01-preview/webpubsub.json +``` + ### Tag: package-2021-04-01-preview These settings apply only when `--tag=package-2021-04-01-preview` is specified on the command line. diff --git a/specification/webpubsub/resource-manager/readme.ruby.md b/specification/webpubsub/resource-manager/readme.ruby.md index 7448221f1e3d..a7d2cd51a565 100644 --- a/specification/webpubsub/resource-manager/readme.ruby.md +++ b/specification/webpubsub/resource-manager/readme.ruby.md @@ -13,6 +13,7 @@ azure-arm: true ``` yaml $(ruby) && $(multiapi) batch: - tag: package-2021-04-01-preview + - tag: package-2021-06-01-preview ``` ### Tag: package-2021-04-01-preview and ruby @@ -24,3 +25,13 @@ Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2021-06-01-preview' && $(ruby) +namespace: "Azure::WebPubSub::Mgmt::V2021_06_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_webpubsub/lib +``` diff --git a/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/stable/2019-06-01/WindowsIotServices.json b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/stable/2019-06-01/WindowsIotServices.json index 53ed8c365681..e960d47b100f 100644 --- a/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/stable/2019-06-01/WindowsIotServices.json +++ b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/stable/2019-06-01/WindowsIotServices.json @@ -554,6 +554,10 @@ "isDataAction": { "description": "Indicates whether the operation is a data action", "type": "boolean" + }, + "origin": { + "description": "Indicates the executor of the operation.", + "type": "string" } } }, diff --git a/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/stable/2019-06-01/examples/OperationsList.json b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/stable/2019-06-01/examples/OperationsList.json index c556a62abff0..d9de942d0663 100644 --- a/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/stable/2019-06-01/examples/OperationsList.json +++ b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/stable/2019-06-01/examples/OperationsList.json @@ -13,7 +13,8 @@ "resource": "Windows IoT Services", "operation": "Create/Update Windows IoT Subscription", "description": "Creates a Windows IoT Subscription with the specified parameters or update the properties or tags or adds custom domain for the specified Windows IoT Subscription." - } + }, + "origin": "user,system" }, { "name": "Microsoft.WindowsIoT/Services/delete", @@ -22,7 +23,8 @@ "resource": "Windows IoT Services", "operation": "Delete Windows IoT Subscription", "description": "Deletes an existing Windows IoT Subscription." - } + }, + "origin": "user,system" }, { "name": "Microsoft.WindowsIoT/checkNameAvailability/read", @@ -31,7 +33,8 @@ "resource": "Name Availability", "operation": "Check Name Availability", "description": "Checks that account name is valid and is not in use." - } + }, + "origin": "user,system" }, { "name": "Microsoft.WindowsIoT/Services/read", @@ -40,7 +43,8 @@ "resource": "Windows IoT Services", "operation": "List/Get Windows IoT Subscription(s)", "description": "Returns the list of Windows IoT Services or gets the properties for the specified Windows IoT Subscription." - } + }, + "origin": "user,system" }, { "name": "Microsoft.WindowsIoT/operations/read", @@ -49,7 +53,8 @@ "resource": "Operations", "operation": "Poll Asynchronous Operation", "description": "Polls the status of an asynchronous operation." - } + }, + "origin": "user,system" } ] } diff --git a/specification/windowsiot/resource-manager/readme.go.md b/specification/windowsiot/resource-manager/readme.go.md index 6cf59aed7110..54ddfb92ebfe 100644 --- a/specification/windowsiot/resource-manager/readme.go.md +++ b/specification/windowsiot/resource-manager/readme.go.md @@ -12,7 +12,7 @@ go: ### Go multi-api ``` yaml $(go) && $(multiapi) -windowsiot: +batch: - tag: package-2019-06 - tag: package-2018-02-preview ``` diff --git a/specification/workloadmonitor/resource-manager/readme.md b/specification/workloadmonitor/resource-manager/readme.md index a772c3ae6646..c47da59665ed 100644 --- a/specification/workloadmonitor/resource-manager/readme.md +++ b/specification/workloadmonitor/resource-manager/readme.md @@ -80,7 +80,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/workloadmonitor/resource-manager/readme.python.md b/specification/workloadmonitor/resource-manager/readme.python.md index 549e82fe6ac4..d214575e423e 100644 --- a/specification/workloadmonitor/resource-manager/readme.python.md +++ b/specification/workloadmonitor/resource-manager/readme.python.md @@ -4,17 +4,6 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -```yaml !$(track2) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.workloadmonitor - package-name: azure-mgmt-workloadmonitor - package-version: 1.0.0 - clear-output-folder: true -``` These settings apply only when `--track2` is specified on the command line. @@ -23,21 +12,16 @@ azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-workloadmonitor no-namespace-folders: true -package-version: 1.0.0 +package-version: 1.0.0b1 +clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/workloadmonitor/azure-mgmt-workloadmonitor/azure/mgmt/workloadmonitor +``` yaml $(python) && $(python-mode) == 'update' && $(track2) no-namespace-folders: true output-folder: $(python-sdks-folder)/workloadmonitor/azure-mgmt-workloadmonitor/azure/mgmt/workloadmonitor ``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/workloadmonitor/azure-mgmt-workloadmonitor +``` yaml $(python) && $(python-mode) == 'create' && $(track2) basic-setup-py: true output-folder: $(python-sdks-folder)/workloadmonitor/azure-mgmt-workloadmonitor ``` diff --git a/specificationRepositoryConfiguration.json b/specificationRepositoryConfiguration.json index 7a501283b316..74e6b38062d7 100644 --- a/specificationRepositoryConfiguration.json +++ b/specificationRepositoryConfiguration.json @@ -12,6 +12,11 @@ "configFilePath": "eng/mgmt/automation/swagger_to_sdk_config.json" }, "azure-sdk-for-js": { + "integrationRepository": "AzureSDKAutomation/azure-sdk-for-js", + "mainRepository": "Azure/azure-sdk-for-js", + "mainBranch": "feature/v4" + }, + "azure-sdk-for-js-track2": { "integrationRepository": "AzureSDKAutomation/azure-sdk-for-js", "mainRepository": "Azure/azure-sdk-for-js" }, diff --git a/test/syntax.ts b/test/syntax.ts deleted file mode 100644 index bae563bf04da..000000000000 --- a/test/syntax.ts +++ /dev/null @@ -1,84 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT License. See License in the project root for license information. - -var assert = require("assert"), - RefParser = require('json-schema-ref-parser'), - util = require('util'), - utils = require('@azure/rest-api-specs-scripts').utils; - -type Context = { - readonly validator: { - readonly validate: (parsedData: unknown, schema: unknown) => unknown - readonly getLastErrors: () => unknown - } - readonly extensionSwaggerSchema: unknown - readonly exampleSchema: unknown -} - -let syntaxContext: Context - - -// Useful when debugging a test for a particular swagger. -// Just update the regex. That will return an array of filtered items. -// utils.swaggers = utils.swaggers.filter(function(item) { -// return (item.match(/.*Microsoft.Logic.*2016-06-01.*/ig) !== null); -// }); -// utils.examples = utils.examples.filter(function(item) { -// return (item.match(/.*Microsoft.Logic.*2016-06-01.*/ig) !== null); -// }); - - -describe('Azure swagger schema validation:', function () { - before(function (done) { - utils.initializeValidator().then((result: Context) => { - syntaxContext = result; - done(); - }); - - }); - - for (const swagger of utils.getSwaggers()) { - it(swagger + ' should be a valid Swagger document.', function (done) { - utils.parseJsonFromFile(swagger).then((parsedData: unknown)=> { - var valid = syntaxContext.validator.validate(parsedData, syntaxContext.extensionSwaggerSchema); - if (!valid) { - var error = syntaxContext.validator.getLastErrors(); - throw new Error("Schema validation failed: " + util.inspect(error, { depth: null })); - } - assert(valid === true); - done(); - }); - }); - } - - describe('Azure x-ms-example schema validation:', function () { - for (const example of utils.getExamples()) { - it('x-ms-examples: ' + example + ' should be a valid x-ms-example.', function (done) { - utils.parseJsonFromFile(example).then((parsedData: unknown) => { - var valid = syntaxContext.validator.validate(parsedData, syntaxContext.exampleSchema); - if (!valid) { - var error = syntaxContext.validator.getLastErrors(); - throw new Error("Schema validation failed: " + util.inspect(error, { depth: null })); - } - assert(valid === true); - done(); - }); - }); - } - }); -}); - -describe('External file or url references ("$ref") in a swagger spec:', function () { - for (const swagger of utils.getSwaggers()) { - it(swagger + ' should be completely resolvable.', function (done) { - RefParser.bundle(swagger, function (bundleErr: { readonly message: unknown }, _bundleResult: unknown) { - if (bundleErr) { - var msg = swagger + ' has references that cannot be resolved. They are as follows: \n' + util.inspect(bundleErr.message, { depth: null }); - console.log(msg); - throw new Error(msg); - } - done(); - }); - }); - } -}); \ No newline at end of file diff --git a/tsconfig.json b/tsconfig.json index 0556c9a9cc08..b3e7463f7947 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -44,6 +44,7 @@ // "typeRoots": [], /* List of folders to include type definitions from. */ // "types": [], /* Type declaration files to be included in compilation. */ // "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */ + "skipLibCheck": true, "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */ // "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */